src/vol/volume.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  *
   9  * Portions Copyright (c) 2005-2008 Sine Nomine Associates
  10  */
  11
  12 /* 1/1/89: NB:  this stuff is all going to be replaced.  Don't take it too seriously */
  13 /*
  14
  15         System:         VICE-TWO
  16         Module:         volume.c
  17         Institution:    The Information Technology Center, Carnegie-Mellon University
  18
  19  */
  20
  21 #include <afsconfig.h>
  22 #include <afs/param.h>
  23
  24
  25 #include <rx/xdr.h>
  26 #include <afs/afsint.h>
  27 #include <ctype.h>
  28 #include <signal.h>
  29 #ifndef AFS_NT40_ENV
  30 #include <sys/param.h>
  31 #if !defined(AFS_SGI_ENV)
  32 #ifdef  AFS_OSF_ENV
  33 #include <ufs/fs.h>
  34 #else /* AFS_OSF_ENV */
  35 #ifdef AFS_VFSINCL_ENV
  36 #define VFS
  37 #ifdef  AFS_SUN5_ENV
  38 #include <sys/fs/ufs_fs.h>
  39 #else
  40 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
  41 #include <ufs/ufs/dinode.h>
  42 #include <ufs/ffs/fs.h>
  43 #else
  44 #include <ufs/fs.h>
  45 #endif
  46 #endif
  47 #else /* AFS_VFSINCL_ENV */
  48 #if !defined(AFS_AIX_ENV) && !defined(AFS_LINUX20_ENV) && !defined(AFS_XBSD_ENV)
  49 #include <sys/fs.h>
  50 #endif
  51 #endif /* AFS_VFSINCL_ENV */
  52 #endif /* AFS_OSF_ENV */
  53 #endif /* AFS_SGI_ENV */
  54 #endif /* AFS_NT40_ENV */
  55 #include <errno.h>
  56 #include <sys/stat.h>
  57 #include <stdio.h>
  58 #ifdef AFS_NT40_ENV
  59 #include <fcntl.h>
  60 #else
  61 #include <sys/file.h>
  62 #endif
  63 #include <dirent.h>
  64 #ifdef  AFS_AIX_ENV
  65 #include <sys/vfs.h>
  66 #include <fcntl.h>
  67 #else
  68 #ifdef  AFS_HPUX_ENV
  69 #include <fcntl.h>
  70 #include <mntent.h>
  71 #else
  72 #if     defined(AFS_SUN_ENV) || defined(AFS_SUN5_ENV)
  73 #ifdef  AFS_SUN5_ENV
  74 #include <sys/mnttab.h>
  75 #include <sys/mntent.h>
  76 #else
  77 #include <mntent.h>
  78 #endif
  79 #else
  80 #ifndef AFS_NT40_ENV
  81 #if defined(AFS_SGI_ENV)
  82 #include <fcntl.h>
  83 #include <mntent.h>
  84
  85 #else
  86 #ifndef AFS_LINUX20_ENV
  87 #include <fstab.h>              /* Need to find in libc 5, present in libc 6 */
  88 #endif
  89 #endif
  90 #endif /* AFS_SGI_ENV */
  91 #endif
  92 #endif /* AFS_HPUX_ENV */
  93 #endif
  94 #ifndef AFS_NT40_ENV
  95 #include <netdb.h>
  96 #include <netinet/in.h>
  97 #include <sys/wait.h>
  98 #include <setjmp.h>
  99 #ifndef ITIMER_REAL
 100 #include <sys/time.h>
 101 #endif /* ITIMER_REAL */
 102 #endif /* AFS_NT40_ENV */
 103 #if defined(AFS_SUN5_ENV) || defined(AFS_NT40_ENV) || defined(AFS_LINUX20_ENV)
 104 #include <string.h>
 105 #else
 106 #include <strings.h>
 107 #endif
 108
 109 #include "nfs.h"
 110 #include <afs/errors.h>
 111 #include "lock.h"
 112 #include "lwp.h"
 113 #include <afs/afssyscalls.h>
 114 #include "ihandle.h"
 115 #include <afs/afsutil.h>
 116 #ifdef AFS_NT40_ENV
 117 #include <io.h>
 118 #endif
 119 #include "daemon_com.h"
 120 #include "fssync.h"
 121 #include "salvsync.h"
 122 #include "vnode.h"
 123 #include "volume.h"
 124 #include "partition.h"
 125 #include "volume_inline.h"
 126 #ifdef AFS_PTHREAD_ENV
 127 #include <assert.h>
 128 #else /* AFS_PTHREAD_ENV */
 129 #include "afs/assert.h"
 130 #endif /* AFS_PTHREAD_ENV */
 131 #include "vutils.h"
 132 #ifndef AFS_NT40_ENV
 133 #include <afs/dir.h>
 134 #include <unistd.h>
 135 #endif
 136
 137 #if !defined(offsetof)
 138 #include <stddef.h>
 139 #endif
 140
 141 #ifdef O_LARGEFILE
 142 #define afs_stat        stat64
 143 #define afs_fstat       fstat64
 144 #define afs_open        open64
 145 #else /* !O_LARGEFILE */
 146 #define afs_stat        stat
 147 #define afs_fstat       fstat
 148 #define afs_open        open
 149 #endif /* !O_LARGEFILE */
 150
 151 #ifdef AFS_PTHREAD_ENV
 152 pthread_mutex_t vol_glock_mutex;
 153 pthread_mutex_t vol_trans_mutex;
 154 pthread_cond_t vol_put_volume_cond;
 155 pthread_cond_t vol_sleep_cond;
 156 pthread_cond_t vol_init_attach_cond;
 157 int vol_attach_threads = 1;
 158 #endif /* AFS_PTHREAD_ENV */
 159
 160 /* start-time configurable I/O parameters */
 161 ih_init_params vol_io_params;
 162
 163 #ifdef AFS_DEMAND_ATTACH_FS
 164 pthread_mutex_t vol_salvsync_mutex;
 165
 166 /*
 167  * Set this to 1 to disallow SALVSYNC communication in all threads; used
 168  * during shutdown, since the salvageserver may have gone away.
 169  */
 170 static volatile sig_atomic_t vol_disallow_salvsync = 0;
 171 #endif /* AFS_DEMAND_ATTACH_FS */
 172
 173 #ifdef  AFS_OSF_ENV
 174 extern void *calloc(), *realloc();
 175 #endif
 176
 177 /*@printflike@*/ extern void Log(const char *format, ...);
 178
 179 /* Forward declarations */
 180 static Volume *attach2(Error * ec, VolId volumeId, char *path,
 181                        struct DiskPartition64 *partp, Volume * vp,
 182                        int isbusy, int mode);
 183 static void ReallyFreeVolume(Volume * vp);
 184 #ifdef AFS_DEMAND_ATTACH_FS
 185 static void FreeVolume(Volume * vp);
 186 #else /* !AFS_DEMAND_ATTACH_FS */
 187 #define FreeVolume(vp) ReallyFreeVolume(vp)
 188 static void VScanUpdateList(void);
 189 #endif /* !AFS_DEMAND_ATTACH_FS */
 190 static void VInitVolumeHeaderCache(afs_uint32 howMany);
 191 static int GetVolumeHeader(register Volume * vp);
 192 static void ReleaseVolumeHeader(register struct volHeader *hd);
 193 static void FreeVolumeHeader(register Volume * vp);
 194 static void AddVolumeToHashTable(register Volume * vp, int hashid);
 195 static void DeleteVolumeFromHashTable(register Volume * vp);
 196 #if 0
 197 static int VHold(Volume * vp);
 198 #endif
 199 static int VHold_r(Volume * vp);
 200 static void VGetBitmap_r(Error * ec, Volume * vp, VnodeClass class);
 201 static void VReleaseVolumeHandles_r(Volume * vp);
 202 static void VCloseVolumeHandles_r(Volume * vp);
 203 static void LoadVolumeHeader(Error * ec, Volume * vp);
 204 static int VCheckOffline(register Volume * vp);
 205 static int VCheckDetach(register Volume * vp);
 206 static Volume * GetVolume(Error * ec, Error * client_ec, VolId volumeId, Volume * hint, int flags);
 207
 208 int LogLevel;                   /* Vice loglevel--not defined as extern so that it will be
 209                                  * defined when not linked with vice, XXXX */
 210 ProgramType programType;        /* The type of program using the package */
 211 static VolumePackageOptions vol_opts;
 212
 213 /* extended volume package statistics */
 214 VolPkgStats VStats;
 215
 216 #ifdef VOL_LOCK_DEBUG
 217 pthread_t vol_glock_holder = 0;
 218 #endif
 219
 220
 221 #define VOLUME_BITMAP_GROWSIZE  16      /* bytes, => 128vnodes */
 222                                         /* Must be a multiple of 4 (1 word) !! */
 223
 224 /* this parameter needs to be tunable at runtime.
 225  * 128 was really inadequate for largish servers -- at 16384 volumes this
 226  * puts average chain length at 128, thus an average 65 deref's to find a volptr.
 227  * talk about bad spatial locality...
 228  *
 229  * an AVL or splay tree might work a lot better, but we'll just increase
 230  * the default hash table size for now
 231  */
 232 #define DEFAULT_VOLUME_HASH_SIZE 256   /* Must be a power of 2!! */
 233 #define DEFAULT_VOLUME_HASH_MASK (DEFAULT_VOLUME_HASH_SIZE-1)
 234 #define VOLUME_HASH(volumeId) (volumeId&(VolumeHashTable.Mask))
 235
 236 /*
 237  * turn volume hash chains into partially ordered lists.
 238  * when the threshold is exceeded between two adjacent elements,
 239  * perform a chain rebalancing operation.
 240  *
 241  * keep the threshold high in order to keep cache line invalidates
 242  * low "enough" on SMPs
 243  */
 244 #define VOLUME_HASH_REORDER_THRESHOLD 200
 245
 246 /*
 247  * when possible, don't just reorder single elements, but reorder
 248  * entire chains of elements at once.  a chain of elements that
 249  * exceed the element previous to the pivot by at least CHAIN_THRESH
 250  * accesses are moved in front of the chain whose elements have at
 251  * least CHAIN_THRESH less accesses than the pivot element
 252  */
 253 #define VOLUME_HASH_REORDER_CHAIN_THRESH (VOLUME_HASH_REORDER_THRESHOLD / 2)
 254
 255 #include "rx/rx_queue.h"
 256
 257
 258 VolumeHashTable_t VolumeHashTable = {
 259     DEFAULT_VOLUME_HASH_SIZE,
 260     DEFAULT_VOLUME_HASH_MASK,
 261     NULL
 262 };
 263
 264
 265 static void VInitVolumeHash(void);
 266
 267
 268 #ifndef AFS_HAVE_FFS
 269 /* This macro is used where an ffs() call does not exist. Was in util/ffs.c */
 270 ffs(x)
 271 {
 272     afs_int32 ffs_i;
 273     afs_int32 ffs_tmp = x;
 274     if (ffs_tmp == 0)
 275         return (-1);
 276     else
 277         for (ffs_i = 1;; ffs_i++) {
 278             if (ffs_tmp & 1)
 279                 return (ffs_i);
 280             else
 281                 ffs_tmp >>= 1;
 282         }
 283 }
 284 #endif /* !AFS_HAVE_FFS */
 285
 286 #ifdef AFS_PTHREAD_ENV
 287 /**
 288  * disk partition queue element
 289  */
 290 typedef struct diskpartition_queue_t {
 291     struct rx_queue queue;             /**< queue header */
 292     struct DiskPartition64 *diskP;     /**< disk partition table entry */
 293 } diskpartition_queue_t;
 294
 295 #ifndef AFS_DEMAND_ATTACH_FS
 296
 297 typedef struct vinitvolumepackage_thread_t {
 298     struct rx_queue queue;
 299     pthread_cond_t thread_done_cv;
 300     int n_threads_complete;
 301 } vinitvolumepackage_thread_t;
 302 static void * VInitVolumePackageThread(void * args);
 303
 304 #else  /* !AFS_DEMAND_ATTTACH_FS */
 305 #define VINIT_BATCH_MAX_SIZE 512
 306
 307 /**
 308  * disk partition work queue
 309  */
 310 struct partition_queue {
 311     struct rx_queue head;              /**< diskpartition_queue_t queue */
 312     pthread_mutex_t mutex;
 313     pthread_cond_t cv;
 314 };
 315
 316 /**
 317  * volumes parameters for preattach
 318  */
 319 struct volume_init_batch {
 320     struct rx_queue queue;               /**< queue header */
 321     int thread;                          /**< posting worker thread */
 322     int last;                            /**< indicates thread is done */
 323     int size;                            /**< number of volume ids in batch */
 324     Volume *batch[VINIT_BATCH_MAX_SIZE]; /**< volumes ids to preattach */
 325 };
 326
 327 /**
 328  * volume parameters work queue
 329  */
 330 struct volume_init_queue {
 331     struct rx_queue head;                /**< volume_init_batch queue */
 332     pthread_mutex_t mutex;
 333     pthread_cond_t cv;
 334 };
 335
 336 /**
 337  * volume init worker thread parameters
 338  */
 339 struct vinitvolumepackage_thread_param {
 340     int nthreads;                        /**< total number of worker threads */
 341     int thread;                          /**< thread number for this worker thread */
 342     struct partition_queue *pq;          /**< queue partitions to scan */
 343     struct volume_init_queue *vq;        /**< queue of volume to preattach */
 344 };
 345
 346 static void *VInitVolumePackageThread(void *args);
 347 static struct DiskPartition64 *VInitNextPartition(struct partition_queue *pq);
 348 static VolId VInitNextVolumeId(DIR *dirp);
 349 static int VInitPreAttachVolumes(int nthreads, struct volume_init_queue *vq);
 350
 351 #endif /* !AFS_DEMAND_ATTACH_FS */
 352 #endif /* AFS_PTHREAD_ENV */
 353
 354 #ifndef AFS_DEMAND_ATTACH_FS
 355 static int VAttachVolumesByPartition(struct DiskPartition64 *diskP,
 356                                      int * nAttached, int * nUnattached);
 357 #endif /* AFS_DEMAND_ATTACH_FS */
 358
 359
 360 #ifdef AFS_DEMAND_ATTACH_FS
 361 /* demand attach fileserver extensions */
 362
 363 /* XXX
 364  * in the future we will support serialization of VLRU state into the fs_state
 365  * disk dumps
 366  *
 367  * these structures are the beginning of that effort
 368  */
 369 struct VLRU_DiskHeader {
 370     struct versionStamp stamp;            /* magic and structure version number */
 371     afs_uint32 mtime;                     /* time of dump to disk */
 372     afs_uint32 num_records;               /* number of VLRU_DiskEntry records */
 373 };
 374
 375 struct VLRU_DiskEntry {
 376     afs_uint32 vid;                       /* volume ID */
 377     afs_uint32 idx;                       /* generation */
 378     afs_uint32 last_get;                  /* timestamp of last get */
 379 };
 380
 381 struct VLRU_StartupQueue {
 382     struct VLRU_DiskEntry * entry;
 383     int num_entries;
 384     int next_idx;
 385 };
 386
 387 typedef struct vshutdown_thread_t {
 388     struct rx_queue q;
 389     pthread_mutex_t lock;
 390     pthread_cond_t cv;
 391     pthread_cond_t master_cv;
 392     int n_threads;
 393     int n_threads_complete;
 394     int vol_remaining;
 395     int schedule_version;
 396     int pass;
 397     byte n_parts;
 398     byte n_parts_done_pass;
 399     byte part_thread_target[VOLMAXPARTS+1];
 400     byte part_done_pass[VOLMAXPARTS+1];
 401     struct rx_queue * part_pass_head[VOLMAXPARTS+1];
 402     int stats[4][VOLMAXPARTS+1];
 403 } vshutdown_thread_t;
 404 static void * VShutdownThread(void * args);
 405
 406
 407 static Volume * VAttachVolumeByVp_r(Error * ec, Volume * vp, int mode);
 408 static int VCheckFree(Volume * vp);
 409
 410 /* VByP List */
 411 static void AddVolumeToVByPList_r(Volume * vp);
 412 static void DeleteVolumeFromVByPList_r(Volume * vp);
 413 static void VVByPListBeginExclusive_r(struct DiskPartition64 * dp);
 414 static void VVByPListEndExclusive_r(struct DiskPartition64 * dp);
 415 static void VVByPListWait_r(struct DiskPartition64 * dp);
 416
 417 /* online salvager */
 418 static int VCheckSalvage(register Volume * vp);
 419 #if defined(SALVSYNC_BUILD_CLIENT) || defined(FSSYNC_BUILD_CLIENT)
 420 static int VScheduleSalvage_r(Volume * vp);
 421 #endif
 422
 423 /* Volume hash table */
 424 static void VReorderHash_r(VolumeHashChainHead * head, Volume * pp, Volume * vp);
 425 static void VHashBeginExclusive_r(VolumeHashChainHead * head);
 426 static void VHashEndExclusive_r(VolumeHashChainHead * head);
 427 static void VHashWait_r(VolumeHashChainHead * head);
 428
 429 /* shutdown */
 430 static int ShutdownVByPForPass_r(struct DiskPartition64 * dp, int pass);
 431 static int ShutdownVolumeWalk_r(struct DiskPartition64 * dp, int pass,
 432                                 struct rx_queue ** idx);
 433 static void ShutdownController(vshutdown_thread_t * params);
 434 static void ShutdownCreateSchedule(vshutdown_thread_t * params);
 435
 436 /* VLRU */
 437 static void VLRU_ComputeConstants(void);
 438 static void VInitVLRU(void);
 439 static void VLRU_Init_Node_r(Volume * vp);
 440 static void VLRU_Add_r(Volume * vp);
 441 static void VLRU_Delete_r(Volume * vp);
 442 static void VLRU_UpdateAccess_r(Volume * vp);
 443 static void * VLRU_ScannerThread(void * args);
 444 static void VLRU_Scan_r(int idx);
 445 static void VLRU_Promote_r(int idx);
 446 static void VLRU_Demote_r(int idx);
 447 static void VLRU_SwitchQueues(Volume * vp, int new_idx, int append);
 448
 449 /* soft detach */
 450 static int VCheckSoftDetach(Volume * vp, afs_uint32 thresh);
 451 static int VCheckSoftDetachCandidate(Volume * vp, afs_uint32 thresh);
 452 static int VSoftDetachVolume_r(Volume * vp, afs_uint32 thresh);
 453
 454
 455 pthread_key_t VThread_key;
 456 VThreadOptions_t VThread_defaults = {
 457     0                           /**< allow salvsync */
 458 };
 459 #endif /* AFS_DEMAND_ATTACH_FS */
 460
 461
 462 struct Lock vol_listLock;       /* Lock obtained when listing volumes:
 463                                  * prevents a volume from being missed
 464                                  * if the volume is attached during a
 465                                  * list volumes */
 466
 467
 468 /* Common message used when the volume goes off line */
 469 char *VSalvageMessage =
 470     "Files in this volume are currently unavailable; call operations";
 471
 472 int VInit;                      /* 0 - uninitialized,
 473                                  * 1 - initialized but not all volumes have been attached,
 474                                  * 2 - initialized and all volumes have been attached,
 475                                  * 3 - initialized, all volumes have been attached, and
 476                                  * VConnectFS() has completed. */
 477
 478 static int vinit_attach_abort = 0;
 479
 480 bit32 VolumeCacheCheck;         /* Incremented everytime a volume goes on line--
 481                                  * used to stamp volume headers and in-core
 482                                  * vnodes.  When the volume goes on-line the
 483                                  * vnode will be invalidated
 484                                  * access only with VOL_LOCK held */
 485
 486
 487
 488
 489 /***************************************************/
 490 /* Startup routines                                */
 491 /***************************************************/
 492
 493 #if defined(FAST_RESTART) && defined(AFS_DEMAND_ATTACH_FS)
 494 # error FAST_RESTART and DAFS are incompatible. For the DAFS equivalent \
 495         of FAST_RESTART, use the -unsafe-nosalvage fileserver argument
 496 #endif
 497
 498 /**
 499  * assign default values to a VolumePackageOptions struct.
 500  *
 501  * Always call this on a VolumePackageOptions struct first, then set any
 502  * specific options you want, then call VInitVolumePackage2.
 503  *
 504  * @param[in]  pt   caller's program type
 505  * @param[out] opts volume package options
 506  */
 507 void
 508 VOptDefaults(ProgramType pt, VolumePackageOptions *opts)
 509 {
 510     opts->nLargeVnodes = opts->nSmallVnodes = 5;
 511     opts->volcache = 0;
 512
 513     opts->canScheduleSalvage = 0;
 514     opts->canUseFSSYNC = 0;
 515     opts->canUseSALVSYNC = 0;
 516
 517 #ifdef FAST_RESTART
 518     opts->unsafe_attach = 1;
 519 #else /* !FAST_RESTART */
 520     opts->unsafe_attach = 0;
 521 #endif /* !FAST_RESTART */
 522
 523     switch (pt) {
 524     case fileServer:
 525         opts->canScheduleSalvage = 1;
 526         opts->canUseSALVSYNC = 1;
 527         break;
 528
 529     case salvageServer:
 530         opts->canUseFSSYNC = 1;
 531         break;
 532
 533     case volumeServer:
 534         opts->nLargeVnodes = 0;
 535         opts->nSmallVnodes = 0;
 536
 537         opts->canScheduleSalvage = 1;
 538         opts->canUseFSSYNC = 1;
 539         break;
 540
 541     default:
 542         /* noop */
 543         break;
 544     }
 545 }
 546
 547 int
 548 VInitVolumePackage2(ProgramType pt, VolumePackageOptions * opts)
 549 {
 550     int errors = 0;             /* Number of errors while finding vice partitions. */
 551
 552     programType = pt;
 553     vol_opts = *opts;
 554
 555     memset(&VStats, 0, sizeof(VStats));
 556     VStats.hdr_cache_size = 200;
 557
 558     VInitPartitionPackage();
 559     VInitVolumeHash();
 560 #ifdef AFS_DEMAND_ATTACH_FS
 561     if (programType == fileServer) {
 562         VInitVLRU();
 563     } else {
 564         VLRU_SetOptions(VLRU_SET_ENABLED, 0);
 565     }
 566     assert(pthread_key_create(&VThread_key, NULL) == 0);
 567 #endif
 568
 569 #ifdef AFS_PTHREAD_ENV
 570     assert(pthread_mutex_init(&vol_glock_mutex, NULL) == 0);
 571     assert(pthread_mutex_init(&vol_trans_mutex, NULL) == 0);
 572     assert(pthread_cond_init(&vol_put_volume_cond, NULL) == 0);
 573     assert(pthread_cond_init(&vol_sleep_cond, NULL) == 0);
 574     assert(pthread_cond_init(&vol_init_attach_cond, NULL) == 0);
 575 #else /* AFS_PTHREAD_ENV */
 576     IOMGR_Initialize();
 577 #endif /* AFS_PTHREAD_ENV */
 578     Lock_Init(&vol_listLock);
 579
 580     srandom(time(0));           /* For VGetVolumeInfo */
 581
 582 #ifdef AFS_DEMAND_ATTACH_FS
 583     assert(pthread_mutex_init(&vol_salvsync_mutex, NULL) == 0);
 584 #endif /* AFS_DEMAND_ATTACH_FS */
 585
 586     /* Ok, we have done enough initialization that fileserver can
 587      * start accepting calls, even though the volumes may not be
 588      * available just yet.
 589      */
 590     VInit = 1;
 591
 592 #if defined(AFS_DEMAND_ATTACH_FS) && defined(SALVSYNC_BUILD_SERVER)
 593     if (programType == salvageServer) {
 594         SALVSYNC_salvInit();
 595     }
 596 #endif /* AFS_DEMAND_ATTACH_FS */
 597 #ifdef FSSYNC_BUILD_SERVER
 598     if (programType == fileServer) {
 599         FSYNC_fsInit();
 600     }
 601 #endif
 602 #if defined(AFS_DEMAND_ATTACH_FS) && defined(SALVSYNC_BUILD_CLIENT)
 603     if (VCanUseSALVSYNC()) {
 604         /* establish a connection to the salvager at this point */
 605         assert(VConnectSALV() != 0);
 606     }
 607 #endif /* AFS_DEMAND_ATTACH_FS */
 608
 609     if (opts->volcache > VStats.hdr_cache_size)
 610         VStats.hdr_cache_size = opts->volcache;
 611     VInitVolumeHeaderCache(VStats.hdr_cache_size);
 612
 613     VInitVnodes(vLarge, opts->nLargeVnodes);
 614     VInitVnodes(vSmall, opts->nSmallVnodes);
 615
 616
 617     errors = VAttachPartitions();
 618     if (errors)
 619         return -1;
 620
 621     if (programType != fileServer) {
 622         errors = VInitAttachVolumes(programType);
 623         if (errors) {
 624             return -1;
 625         }
 626     }
 627
 628 #ifdef FSSYNC_BUILD_CLIENT
 629     if (VCanUseFSSYNC()) {
 630         if (!VConnectFS()) {
 631 #ifdef AFS_DEMAND_ATTACH_FS
 632             if (programType == salvageServer) {
 633                 Log("Unable to connect to file server; aborted\n");
 634                 exit(1);
 635             }
 636 #endif /* AFS_DEMAND_ATTACH_FS */
 637             Log("Unable to connect to file server; will retry at need\n");
 638         }
 639     }
 640 #endif /* FSSYNC_BUILD_CLIENT */
 641     return 0;
 642 }
 643
 644
 645 #if !defined(AFS_PTHREAD_ENV)
 646 /**
 647  * Attach volumes in vice partitions
 648  *
 649  * @param[in]  pt         calling program type
 650  *
 651  * @return 0
 652  * @note This is the original, non-threaded version of attach parititions.
 653  *
 654  * @post VInit state is 2
 655  */
 656 int
 657 VInitAttachVolumes(ProgramType pt)
 658 {
 659     assert(VInit==1);
 660     if (pt == fileServer) {
 661         struct DiskPartition64 *diskP;
 662         /* Attach all the volumes in this partition */
 663         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
 664             int nAttached = 0, nUnattached = 0;
 665             assert(VAttachVolumesByPartition(diskP, &nAttached, &nUnattached) == 0);
 666         }
 667     }
 668     VOL_LOCK;
 669     VInit = 2;                  /* Initialized, and all volumes have been attached */
 670     LWP_NoYieldSignal(VInitAttachVolumes);
 671     VOL_UNLOCK;
 672     return 0;
 673 }
 674 #endif /* !AFS_PTHREAD_ENV */
 675
 676 #if defined(AFS_PTHREAD_ENV) && !defined(AFS_DEMAND_ATTACH_FS)
 677 /**
 678  * Attach volumes in vice partitions
 679  *
 680  * @param[in]  pt         calling program type
 681  *
 682  * @return 0
 683  * @note Threaded version of attach parititions.
 684  *
 685  * @post VInit state is 2
 686  */
 687 int
 688 VInitAttachVolumes(ProgramType pt)
 689 {
 690     assert(VInit==1);
 691     if (pt == fileServer) {
 692         struct DiskPartition64 *diskP;
 693         struct vinitvolumepackage_thread_t params;
 694         struct diskpartition_queue_t * dpq;
 695         int i, threads, parts;
 696         pthread_t tid;
 697         pthread_attr_t attrs;
 698
 699         assert(pthread_cond_init(&params.thread_done_cv,NULL) == 0);
 700         queue_Init(&params);
 701         params.n_threads_complete = 0;
 702
 703         /* create partition work queue */
 704         for (parts=0, diskP = DiskPartitionList; diskP; diskP = diskP->next, parts++) {
 705             dpq = (diskpartition_queue_t *) malloc(sizeof(struct diskpartition_queue_t));
 706             assert(dpq != NULL);
 707             dpq->diskP = diskP;
 708             queue_Append(&params,dpq);
 709         }
 710
 711         threads = MIN(parts, vol_attach_threads);
 712
 713         if (threads > 1) {
 714             /* spawn off a bunch of initialization threads */
 715             assert(pthread_attr_init(&attrs) == 0);
 716             assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
 717
 718             Log("VInitVolumePackage: beginning parallel fileserver startup\n");
 719             Log("VInitVolumePackage: using %d threads to attach volumes on %d partitions\n",
 720                 threads, parts);
 721
 722             VOL_LOCK;
 723             for (i=0; i < threads; i++) {
 724                 AFS_SIGSET_DECL;
 725                 AFS_SIGSET_CLEAR();
 726                 assert(pthread_create
 727                        (&tid, &attrs, &VInitVolumePackageThread,
 728                         &params) == 0);
 729                 AFS_SIGSET_RESTORE();
 730             }
 731
 732             while(params.n_threads_complete < threads) {
 733                 VOL_CV_WAIT(&params.thread_done_cv);
 734             }
 735             VOL_UNLOCK;
 736
 737             assert(pthread_attr_destroy(&attrs) == 0);
 738         } else {
 739             /* if we're only going to run one init thread, don't bother creating
 740              * another LWP */
 741             Log("VInitVolumePackage: beginning single-threaded fileserver startup\n");
 742             Log("VInitVolumePackage: using 1 thread to attach volumes on %d partition(s)\n",
 743                 parts);
 744
 745             VInitVolumePackageThread(&params);
 746         }
 747
 748         assert(pthread_cond_destroy(&params.thread_done_cv) == 0);
 749     }
 750     VOL_LOCK;
 751     VInit = 2;                  /* Initialized, and all volumes have been attached */
 752     assert(pthread_cond_broadcast(&vol_init_attach_cond) == 0);
 753     VOL_UNLOCK;
 754     return 0;
 755 }
 756
 757 static void *
 758 VInitVolumePackageThread(void * args) {
 759
 760     struct DiskPartition64 *diskP;
 761     struct vinitvolumepackage_thread_t * params;
 762     struct diskpartition_queue_t * dpq;
 763
 764     params = (vinitvolumepackage_thread_t *) args;
 765
 766
 767     VOL_LOCK;
 768     /* Attach all the volumes in this partition */
 769     while (queue_IsNotEmpty(params)) {
 770         int nAttached = 0, nUnattached = 0;
 771
 772         if (vinit_attach_abort) {
 773             Log("Aborting initialization\n");
 774             goto done;
 775         }
 776
 777         dpq = queue_First(params,diskpartition_queue_t);
 778         queue_Remove(dpq);
 779         VOL_UNLOCK;
 780         diskP = dpq->diskP;
 781         free(dpq);
 782
 783         assert(VAttachVolumesByPartition(diskP, &nAttached, &nUnattached) == 0);
 784
 785         VOL_LOCK;
 786     }
 787
 788 done:
 789     params->n_threads_complete++;
 790     pthread_cond_signal(&params->thread_done_cv);
 791     VOL_UNLOCK;
 792     return NULL;
 793 }
 794 #endif /* AFS_PTHREAD_ENV && !AFS_DEMAND_ATTACH_FS */
 795
 796 #if defined(AFS_DEMAND_ATTACH_FS)
 797 /**
 798  * Attach volumes in vice partitions
 799  *
 800  * @param[in]  pt         calling program type
 801  *
 802  * @return 0
 803  * @note Threaded version of attach partitions.
 804  *
 805  * @post VInit state is 2
 806  */
 807 int
 808 VInitAttachVolumes(ProgramType pt)
 809 {
 810     assert(VInit==1);
 811     if (pt == fileServer) {
 812
 813         struct DiskPartition64 *diskP;
 814         struct partition_queue pq;
 815         struct volume_init_queue vq;
 816
 817         int i, threads, parts;
 818         pthread_t tid;
 819         pthread_attr_t attrs;
 820
 821         /* create partition work queue */
 822         queue_Init(&pq);
 823         assert(pthread_cond_init(&(pq.cv), NULL) == 0);
 824         assert(pthread_mutex_init(&(pq.mutex), NULL) == 0);
 825         for (parts = 0, diskP = DiskPartitionList; diskP; diskP = diskP->next, parts++) {
 826             struct diskpartition_queue_t *dp;
 827             dp = (struct diskpartition_queue_t*)malloc(sizeof(struct diskpartition_queue_t));
 828             assert(dp != NULL);
 829             dp->diskP = diskP;
 830             queue_Append(&pq, dp);
 831         }
 832
 833         /* number of worker threads; at least one, not to exceed the number of partitions */
 834         threads = MIN(parts, vol_attach_threads);
 835
 836         /* create volume work queue */
 837         queue_Init(&vq);
 838         assert(pthread_cond_init(&(vq.cv), NULL) == 0);
 839         assert(pthread_mutex_init(&(vq.mutex), NULL) == 0);
 840
 841         assert(pthread_attr_init(&attrs) == 0);
 842         assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
 843
 844         Log("VInitVolumePackage: beginning parallel fileserver startup\n");
 845         Log("VInitVolumePackage: using %d threads to pre-attach volumes on %d partitions\n",
 846                 threads, parts);
 847
 848         /* create threads to scan disk partitions. */
 849         for (i=0; i < threads; i++) {
 850             struct vinitvolumepackage_thread_param *params;
 851             AFS_SIGSET_DECL;
 852
 853             params = (struct vinitvolumepackage_thread_param *)malloc(sizeof(struct vinitvolumepackage_thread_param));
 854             assert(params);
 855             params->pq = &pq;
 856             params->vq = &vq;
 857             params->nthreads = threads;
 858             params->thread = i+1;
 859
 860             AFS_SIGSET_CLEAR();
 861             assert(pthread_create (&tid, &attrs, &VInitVolumePackageThread, (void*)params) == 0);
 862             AFS_SIGSET_RESTORE();
 863         }
 864
 865         VInitPreAttachVolumes(threads, &vq);
 866
 867         assert(pthread_attr_destroy(&attrs) == 0);
 868         assert(pthread_cond_destroy(&pq.cv) == 0);
 869         assert(pthread_mutex_destroy(&pq.mutex) == 0);
 870         assert(pthread_cond_destroy(&vq.cv) == 0);
 871         assert(pthread_mutex_destroy(&vq.mutex) == 0);
 872     }
 873
 874     VOL_LOCK;
 875     VInit = 2;                  /* Initialized, and all volumes have been attached */
 876     assert(pthread_cond_broadcast(&vol_init_attach_cond) == 0);
 877     VOL_UNLOCK;
 878
 879     return 0;
 880 }
 881
 882 /**
 883  * Volume package initialization worker thread. Scan partitions for volume
 884  * header files. Gather batches of volume ids and dispatch them to
 885  * the main thread to be preattached.  The volume preattachement is done
 886  * in the main thread to avoid global volume lock contention.
 887  */
 888 static void *
 889 VInitVolumePackageThread(void *args)
 890 {
 891     struct vinitvolumepackage_thread_param *params;
 892     struct DiskPartition64 *partition;
 893     struct partition_queue *pq;
 894     struct volume_init_queue *vq;
 895     struct volume_init_batch *vb;
 896
 897     assert(args);
 898     params = (struct vinitvolumepackage_thread_param *)args;
 899     pq = params->pq;
 900     vq = params->vq;
 901     assert(pq);
 902     assert(vq);
 903
 904     vb = (struct volume_init_batch*)malloc(sizeof(struct volume_init_batch));
 905     assert(vb);
 906     vb->thread = params->thread;
 907     vb->last = 0;
 908     vb->size = 0;
 909
 910     Log("Scanning partitions on thread %d of %d\n", params->thread, params->nthreads);
 911     while((partition = VInitNextPartition(pq))) {
 912         DIR *dirp;
 913         VolId vid;
 914
 915         Log("Partition %s: pre-attaching volumes\n", partition->name);
 916         dirp = opendir(VPartitionPath(partition));
 917         if (!dirp) {
 918             Log("opendir on Partition %s failed, errno=%d!\n", partition->name, errno);
 919             continue;
 920         }
 921         while ((vid = VInitNextVolumeId(dirp))) {
 922             Volume *vp = (Volume*)malloc(sizeof(Volume));
 923             assert(vp);
 924             memset(vp, 0, sizeof(Volume));
 925             vp->device = partition->device;
 926             vp->partition = partition;
 927             vp->hashid = vid;
 928             queue_Init(&vp->vnode_list);
 929             assert(pthread_cond_init(&V_attachCV(vp), NULL) == 0);
 930
 931             vb->batch[vb->size++] = vp;
 932             if (vb->size == VINIT_BATCH_MAX_SIZE) {
 933                 assert(pthread_mutex_lock(&vq->mutex) == 0);
 934                 queue_Append(vq, vb);
 935                 assert(pthread_cond_broadcast(&vq->cv) == 0);
 936                 assert(pthread_mutex_unlock(&vq->mutex) == 0);
 937
 938                 vb = (struct volume_init_batch*)malloc(sizeof(struct volume_init_batch));
 939                 assert(vb);
 940                 vb->thread = params->thread;
 941                 vb->size = 0;
 942                 vb->last = 0;
 943             }
 944         }
 945         closedir(dirp);
 946     }
 947
 948     vb->last = 1;
 949     assert(pthread_mutex_lock(&vq->mutex) == 0);
 950     queue_Append(vq, vb);
 951     assert(pthread_cond_broadcast(&vq->cv) == 0);
 952     assert(pthread_mutex_unlock(&vq->mutex) == 0);
 953
 954     Log("Partition scan thread %d of %d ended\n", params->thread, params->nthreads);
 955     free(params);
 956     return NULL;
 957 }
 958
 959 /**
 960  * Read next element from the pre-populated partition list.
 961  */
 962 static struct DiskPartition64*
 963 VInitNextPartition(struct partition_queue *pq)
 964 {
 965     struct DiskPartition64 *partition;
 966     struct diskpartition_queue_t *dp; /* queue element */
 967
 968     if (vinit_attach_abort) {
 969         Log("Aborting volume preattach thread.\n");
 970         return NULL;
 971     }
 972
 973     /* get next partition to scan */
 974     assert(pthread_mutex_lock(&pq->mutex) == 0);
 975     if (queue_IsEmpty(pq)) {
 976         assert(pthread_mutex_unlock(&pq->mutex) == 0);
 977         return NULL;
 978     }
 979     dp = queue_First(pq, diskpartition_queue_t);
 980     queue_Remove(dp);
 981     assert(pthread_mutex_unlock(&pq->mutex) == 0);
 982
 983     assert(dp);
 984     assert(dp->diskP);
 985
 986     partition = dp->diskP;
 987     free(dp);
 988     return partition;
 989 }
 990
 991 /**
 992  * Find next volume id on the partition.
 993  */
 994 static VolId
 995 VInitNextVolumeId(DIR *dirp)
 996 {
 997     struct dirent *d;
 998     VolId vid = 0;
 999     char *ext;
1000
1001     while((d = readdir(dirp))) {
1002         if (vinit_attach_abort) {
1003             Log("Aborting volume preattach thread.\n");
1004             break;
1005         }
1006         ext = strrchr(d->d_name, '.');
1007         if (d->d_name[0] == 'V' && ext && strcmp(ext, VHDREXT) == 0) {
1008             vid = VolumeNumber(d->d_name);
1009             if (vid) {
1010                break;
1011             }
1012             Log("Warning: bogus volume header file: %s\n", d->d_name);
1013         }
1014     }
1015     return vid;
1016 }
1017
1018 /**
1019  * Preattach volumes in batches to avoid lock contention.
1020  */
1021 static int
1022 VInitPreAttachVolumes(int nthreads, struct volume_init_queue *vq)
1023 {
1024     struct volume_init_batch *vb;
1025     int i;
1026
1027     while (nthreads) {
1028         /* dequeue next volume */
1029         pthread_mutex_lock(&vq->mutex);
1030         if (queue_IsEmpty(vq)) {
1031             pthread_cond_wait(&vq->cv, &vq->mutex);
1032         }
1033         vb = queue_First(vq, volume_init_batch);
1034         queue_Remove(vb);
1035         pthread_mutex_unlock(&vq->mutex);
1036
1037         if (vb->size) {
1038             VOL_LOCK;
1039             for (i = 0; i<vb->size; i++) {
1040                 Volume *vp;
1041                 Volume *dup;
1042                 Error ec = 0;
1043
1044                 vp = vb->batch[i];
1045                 dup = VLookupVolume_r(&ec, vp->hashid, NULL);
1046                 if (ec) {
1047                     Log("Error looking up volume, code=%d\n", ec);
1048                 }
1049                 else if (dup) {
1050                     Log("Warning: Duplicate volume id %d detected.\n", vp->hashid);
1051                 }
1052                 else {
1053                     /* put pre-attached volume onto the hash table
1054                      * and bring it up to the pre-attached state */
1055                     AddVolumeToHashTable(vp, vp->hashid);
1056                     AddVolumeToVByPList_r(vp);
1057                     VLRU_Init_Node_r(vp);
1058                     VChangeState_r(vp, VOL_STATE_PREATTACHED);
1059                 }
1060             }
1061             VOL_UNLOCK;
1062         }
1063
1064         if (vb->last) {
1065             nthreads--;
1066         }
1067         free(vb);
1068     }
1069     return 0;
1070 }
1071 #endif /* AFS_DEMAND_ATTACH_FS */
1072
1073 #if !defined(AFS_DEMAND_ATTACH_FS)
1074 /*
1075  * attach all volumes on a given disk partition
1076  */
1077 static int
1078 VAttachVolumesByPartition(struct DiskPartition64 *diskP, int * nAttached, int * nUnattached)
1079 {
1080   DIR * dirp;
1081   struct dirent * dp;
1082   int ret = 0;
1083
1084   Log("Partition %s: attaching volumes\n", diskP->name);
1085   dirp = opendir(VPartitionPath(diskP));
1086   if (!dirp) {
1087     Log("opendir on Partition %s failed!\n", diskP->name);
1088     return 1;
1089   }
1090
1091   while ((dp = readdir(dirp))) {
1092     char *p;
1093     p = strrchr(dp->d_name, '.');
1094
1095     if (vinit_attach_abort) {
1096       Log("Partition %s: abort attach volumes\n", diskP->name);
1097       goto done;
1098     }
1099
1100     if (p != NULL && strcmp(p, VHDREXT) == 0) {
1101       Error error;
1102       Volume *vp;
1103       vp = VAttachVolumeByName(&error, diskP->name, dp->d_name,
1104                                V_VOLUPD);
1105       (*(vp ? nAttached : nUnattached))++;
1106       if (error == VOFFLINE)
1107         Log("Volume %d stays offline (/vice/offline/%s exists)\n", VolumeNumber(dp->d_name), dp->d_name);
1108       else if (LogLevel >= 5) {
1109         Log("Partition %s: attached volume %d (%s)\n",
1110             diskP->name, VolumeNumber(dp->d_name),
1111             dp->d_name);
1112       }
1113       if (vp) {
1114         VPutVolume(vp);
1115       }
1116     }
1117   }
1118
1119   Log("Partition %s: attached %d volumes; %d volumes not attached\n", diskP->name, *nAttached, *nUnattached);
1120 done:
1121   closedir(dirp);
1122   return ret;
1123 }
1124 #endif /* !AFS_DEMAND_ATTACH_FS */
1125
1126 /***************************************************/
1127 /* Shutdown routines                               */
1128 /***************************************************/
1129
1130 /*
1131  * demand attach fs
1132  * highly multithreaded volume package shutdown
1133  *
1134  * with the demand attach fileserver extensions,
1135  * VShutdown has been modified to be multithreaded.
1136  * In order to achieve optimal use of many threads,
1137  * the shutdown code involves one control thread and
1138  * n shutdown worker threads.  The control thread
1139  * periodically examines the number of volumes available
1140  * for shutdown on each partition, and produces a worker
1141  * thread allocation schedule.  The idea is to eliminate
1142  * redundant scheduling computation on the workers by
1143  * having a single master scheduler.
1144  *
1145  * The scheduler's objectives are:
1146  * (1) fairness
1147  *   each partition with volumes remaining gets allocated
1148  *   at least 1 thread (assuming sufficient threads)
1149  * (2) performance
1150  *   threads are allocated proportional to the number of
1151  *   volumes remaining to be offlined.  This ensures that
1152  *   the OS I/O scheduler has many requests to elevator
1153  *   seek on partitions that will (presumably) take the
1154  *   longest amount of time (from now) to finish shutdown
1155  * (3) keep threads busy
1156  *   when there are extra threads, they are assigned to
1157  *   partitions using a simple round-robin algorithm
1158  *
1159  * In the future, we may wish to add the ability to adapt
1160  * to the relative performance patterns of each disk
1161  * partition.
1162  *
1163  *
1164  * demand attach fs
1165  * multi-step shutdown process
1166  *
1167  * demand attach shutdown is a four-step process. Each
1168  * shutdown "pass" shuts down increasingly more difficult
1169  * volumes.  The main purpose is to achieve better cache
1170  * utilization during shutdown.
1171  *
1172  * pass 0
1173  *   shutdown volumes in the unattached, pre-attached
1174  *   and error states
1175  * pass 1
1176  *   shutdown attached volumes with cached volume headers
1177  * pass 2
1178  *   shutdown all volumes in non-exclusive states
1179  * pass 3
1180  *   shutdown all remaining volumes
1181  */
1182
1183 #ifdef AFS_DEMAND_ATTACH_FS
1184
1185 void
1186 VShutdown_r(void)
1187 {
1188     int i;
1189     struct DiskPartition64 * diskP;
1190     struct diskpartition_queue_t * dpq;
1191     vshutdown_thread_t params;
1192     pthread_t tid;
1193     pthread_attr_t attrs;
1194
1195     memset(&params, 0, sizeof(vshutdown_thread_t));
1196
1197     if (VInit < 2) {
1198         Log("VShutdown:  aborting attach volumes\n");
1199         vinit_attach_abort = 1;
1200         VOL_CV_WAIT(&vol_init_attach_cond);
1201     }
1202
1203     for (params.n_parts=0, diskP = DiskPartitionList;
1204          diskP; diskP = diskP->next, params.n_parts++);
1205
1206     Log("VShutdown:  shutting down on-line volumes on %d partition%s...\n",
1207         params.n_parts, params.n_parts > 1 ? "s" : "");
1208
1209     if (vol_attach_threads > 1) {
1210         /* prepare for parallel shutdown */
1211         params.n_threads = vol_attach_threads;
1212         assert(pthread_mutex_init(&params.lock, NULL) == 0);
1213         assert(pthread_cond_init(&params.cv, NULL) == 0);
1214         assert(pthread_cond_init(&params.master_cv, NULL) == 0);
1215         assert(pthread_attr_init(&attrs) == 0);
1216         assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
1217         queue_Init(&params);
1218
1219         /* setup the basic partition information structures for
1220          * parallel shutdown */
1221         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1222             /* XXX debug */
1223             struct rx_queue * qp, * nqp;
1224             Volume * vp;
1225             int count = 0;
1226
1227             VVByPListWait_r(diskP);
1228             VVByPListBeginExclusive_r(diskP);
1229
1230             /* XXX debug */
1231             for (queue_Scan(&diskP->vol_list, qp, nqp, rx_queue)) {
1232                 vp = (Volume *)((char *)qp - offsetof(Volume, vol_list));
1233                 if (vp->header)
1234                     count++;
1235             }
1236             Log("VShutdown: partition %s has %d volumes with attached headers\n",
1237                 VPartitionPath(diskP), count);
1238
1239
1240             /* build up the pass 0 shutdown work queue */
1241             dpq = (struct diskpartition_queue_t *) malloc(sizeof(struct diskpartition_queue_t));
1242             assert(dpq != NULL);
1243             dpq->diskP = diskP;
1244             queue_Prepend(&params, dpq);
1245
1246             params.part_pass_head[diskP->index] = queue_First(&diskP->vol_list, rx_queue);
1247         }
1248
1249         Log("VShutdown:  beginning parallel fileserver shutdown\n");
1250         Log("VShutdown:  using %d threads to offline volumes on %d partition%s\n",
1251             vol_attach_threads, params.n_parts, params.n_parts > 1 ? "s" : "" );
1252
1253         /* do pass 0 shutdown */
1254         assert(pthread_mutex_lock(&params.lock) == 0);
1255         for (i=0; i < params.n_threads; i++) {
1256             assert(pthread_create
1257                    (&tid, &attrs, &VShutdownThread,
1258                     &params) == 0);
1259         }
1260
1261         /* wait for all the pass 0 shutdowns to complete */
1262         while (params.n_threads_complete < params.n_threads) {
1263             assert(pthread_cond_wait(&params.master_cv, &params.lock) == 0);
1264         }
1265         params.n_threads_complete = 0;
1266         params.pass = 1;
1267         assert(pthread_cond_broadcast(&params.cv) == 0);
1268         assert(pthread_mutex_unlock(&params.lock) == 0);
1269
1270         Log("VShutdown:  pass 0 completed using the 1 thread per partition algorithm\n");
1271         Log("VShutdown:  starting passes 1 through 3 using finely-granular mp-fast algorithm\n");
1272
1273         /* run the parallel shutdown scheduler. it will drop the glock internally */
1274         ShutdownController(&params);
1275
1276         /* wait for all the workers to finish pass 3 and terminate */
1277         while (params.pass < 4) {
1278             VOL_CV_WAIT(&params.cv);
1279         }
1280
1281         assert(pthread_attr_destroy(&attrs) == 0);
1282         assert(pthread_cond_destroy(&params.cv) == 0);
1283         assert(pthread_cond_destroy(&params.master_cv) == 0);
1284         assert(pthread_mutex_destroy(&params.lock) == 0);
1285
1286         /* drop the VByPList exclusive reservations */
1287         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1288             VVByPListEndExclusive_r(diskP);
1289             Log("VShutdown:  %s stats : (pass[0]=%d, pass[1]=%d, pass[2]=%d, pass[3]=%d)\n",
1290                 VPartitionPath(diskP),
1291                 params.stats[0][diskP->index],
1292                 params.stats[1][diskP->index],
1293                 params.stats[2][diskP->index],
1294                 params.stats[3][diskP->index]);
1295         }
1296
1297         Log("VShutdown:  shutdown finished using %d threads\n", params.n_threads);
1298     } else {
1299         /* if we're only going to run one shutdown thread, don't bother creating
1300          * another LWP */
1301         Log("VShutdown:  beginning single-threaded fileserver shutdown\n");
1302
1303         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1304             VShutdownByPartition_r(diskP);
1305         }
1306     }
1307
1308     Log("VShutdown:  complete.\n");
1309 }
1310
1311 #else /* AFS_DEMAND_ATTACH_FS */
1312
1313 void
1314 VShutdown_r(void)
1315 {
1316     int i;
1317     register Volume *vp, *np;
1318     register afs_int32 code;
1319
1320     if (VInit < 2) {
1321         Log("VShutdown:  aborting attach volumes\n");
1322         vinit_attach_abort = 1;
1323 #ifdef AFS_PTHREAD_ENV
1324         VOL_CV_WAIT(&vol_init_attach_cond);
1325 #else
1326         LWP_WaitProcess(VInitAttachVolumes);
1327 #endif /* AFS_PTHREAD_ENV */
1328     }
1329
1330     Log("VShutdown:  shutting down on-line volumes...\n");
1331     for (i = 0; i < VolumeHashTable.Size; i++) {
1332         /* try to hold first volume in the hash table */
1333         for (queue_Scan(&VolumeHashTable.Table[i],vp,np,Volume)) {
1334             code = VHold_r(vp);
1335             if (code == 0) {
1336                 if (LogLevel >= 5)
1337                     Log("VShutdown:  Attempting to take volume %u offline.\n",
1338                         vp->hashid);
1339
1340                 /* next, take the volume offline (drops reference count) */
1341                 VOffline_r(vp, "File server was shut down");
1342             }
1343         }
1344     }
1345     Log("VShutdown:  complete.\n");
1346 }
1347 #endif /* AFS_DEMAND_ATTACH_FS */
1348
1349
1350 void
1351 VShutdown(void)
1352 {
1353     assert(VInit>0);
1354     VOL_LOCK;
1355     VShutdown_r();
1356     VOL_UNLOCK;
1357 }
1358
1359 /**
1360  * stop new activity (e.g. SALVSYNC) from occurring
1361  *
1362  * Use this to make the volume package less busy; for example, during
1363  * shutdown. This doesn't actually shutdown/detach anything in the
1364  * volume package, but prevents certain processes from ocurring. For
1365  * example, preventing new SALVSYNC communication in DAFS. In theory, we
1366  * could also use this to prevent new volume attachment, or prevent
1367  * other programs from checking out volumes, etc.
1368  */
1369 void
1370 VSetTranquil(void)
1371 {
1372 #ifdef AFS_DEMAND_ATTACH_FS
1373     /* make sure we don't try to contact the salvageserver, since it may
1374      * not be around anymore */
1375     vol_disallow_salvsync = 1;
1376 #endif
1377 }
1378
1379 #ifdef AFS_DEMAND_ATTACH_FS
1380 /*
1381  * demand attach fs
1382  * shutdown control thread
1383  */
1384 static void
1385 ShutdownController(vshutdown_thread_t * params)
1386 {
1387     /* XXX debug */
1388     struct DiskPartition64 * diskP;
1389     Device id;
1390     vshutdown_thread_t shadow;
1391
1392     ShutdownCreateSchedule(params);
1393
1394     while ((params->pass < 4) &&
1395            (params->n_threads_complete < params->n_threads)) {
1396         /* recompute schedule once per second */
1397
1398         memcpy(&shadow, params, sizeof(vshutdown_thread_t));
1399
1400         VOL_UNLOCK;
1401         /* XXX debug */
1402         Log("ShutdownController:  schedule version=%d, vol_remaining=%d, pass=%d\n",
1403             shadow.schedule_version, shadow.vol_remaining, shadow.pass);
1404         Log("ShutdownController:  n_threads_complete=%d, n_parts_done_pass=%d\n",
1405             shadow.n_threads_complete, shadow.n_parts_done_pass);
1406         for (diskP = DiskPartitionList; diskP; diskP=diskP->next) {
1407             id = diskP->index;
1408             Log("ShutdownController:  part[%d] : (len=%d, thread_target=%d, done_pass=%d, pass_head=%p)\n",
1409                 id,
1410                 diskP->vol_list.len,
1411                 shadow.part_thread_target[id],
1412                 shadow.part_done_pass[id],
1413                 shadow.part_pass_head[id]);
1414         }
1415
1416         sleep(1);
1417         VOL_LOCK;
1418
1419         ShutdownCreateSchedule(params);
1420     }
1421 }
1422
1423 /* create the shutdown thread work schedule.
1424  * this scheduler tries to implement fairness
1425  * by allocating at least 1 thread to each
1426  * partition with volumes to be shutdown,
1427  * and then it attempts to allocate remaining
1428  * threads based upon the amount of work left
1429  */
1430 static void
1431 ShutdownCreateSchedule(vshutdown_thread_t * params)
1432 {
1433     struct DiskPartition64 * diskP;
1434     int sum, thr_workload, thr_left;
1435     int part_residue[VOLMAXPARTS+1];
1436     Device id;
1437
1438     /* compute the total number of outstanding volumes */
1439     sum = 0;
1440     for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1441         sum += diskP->vol_list.len;
1442     }
1443
1444     params->schedule_version++;
1445     params->vol_remaining = sum;
1446
1447     if (!sum)
1448         return;
1449
1450     /* compute average per-thread workload */
1451     thr_workload = sum / params->n_threads;
1452     if (sum % params->n_threads)
1453         thr_workload++;
1454
1455     thr_left = params->n_threads;
1456     memset(&part_residue, 0, sizeof(part_residue));
1457
1458     /* for fairness, give every partition with volumes remaining
1459      * at least one thread */
1460     for (diskP = DiskPartitionList; diskP && thr_left; diskP = diskP->next) {
1461         id = diskP->index;
1462         if (diskP->vol_list.len) {
1463             params->part_thread_target[id] = 1;
1464             thr_left--;
1465         } else {
1466             params->part_thread_target[id] = 0;
1467         }
1468     }
1469
1470     if (thr_left && thr_workload) {
1471         /* compute length-weighted workloads */
1472         int delta;
1473
1474         for (diskP = DiskPartitionList; diskP && thr_left; diskP = diskP->next) {
1475             id = diskP->index;
1476             delta = (diskP->vol_list.len / thr_workload) -
1477                 params->part_thread_target[id];
1478             if (delta < 0) {
1479                 continue;
1480             }
1481             if (delta < thr_left) {
1482                 params->part_thread_target[id] += delta;
1483                 thr_left -= delta;
1484             } else {
1485                 params->part_thread_target[id] += thr_left;
1486                 thr_left = 0;
1487                 break;
1488             }
1489         }
1490     }
1491
1492     if (thr_left) {
1493         /* try to assign any leftover threads to partitions that
1494          * had volume lengths closer to needing thread_target+1 */
1495         int max_residue, max_id = 0;
1496
1497         /* compute the residues */
1498         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1499             id = diskP->index;
1500             part_residue[id] = diskP->vol_list.len -
1501                 (params->part_thread_target[id] * thr_workload);
1502         }
1503
1504         /* now try to allocate remaining threads to partitions with the
1505          * highest residues */
1506         while (thr_left) {
1507             max_residue = 0;
1508             for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1509                 id = diskP->index;
1510                 if (part_residue[id] > max_residue) {
1511                     max_residue = part_residue[id];
1512                     max_id = id;
1513                 }
1514             }
1515
1516             if (!max_residue) {
1517                 break;
1518             }
1519
1520             params->part_thread_target[max_id]++;
1521             thr_left--;
1522             part_residue[max_id] = 0;
1523         }
1524     }
1525
1526     if (thr_left) {
1527         /* punt and give any remaining threads equally to each partition */
1528         int alloc;
1529         if (thr_left >= params->n_parts) {
1530             alloc = thr_left / params->n_parts;
1531             for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1532                 id = diskP->index;
1533                 params->part_thread_target[id] += alloc;
1534                 thr_left -= alloc;
1535             }
1536         }
1537
1538         /* finish off the last of the threads */
1539         for (diskP = DiskPartitionList; thr_left && diskP; diskP = diskP->next) {
1540             id = diskP->index;
1541             params->part_thread_target[id]++;
1542             thr_left--;
1543         }
1544     }
1545 }
1546
1547 /* worker thread for parallel shutdown */
1548 static void *
1549 VShutdownThread(void * args)
1550 {
1551     vshutdown_thread_t * params;
1552     int found, pass, schedule_version_save, count;
1553     struct DiskPartition64 *diskP;
1554     struct diskpartition_queue_t * dpq;
1555     Device id;
1556
1557     params = (vshutdown_thread_t *) args;
1558
1559     /* acquire the shutdown pass 0 lock */
1560     assert(pthread_mutex_lock(&params->lock) == 0);
1561
1562     /* if there's still pass 0 work to be done,
1563      * get a work entry, and do a pass 0 shutdown */
1564     if (queue_IsNotEmpty(params)) {
1565         dpq = queue_First(params, diskpartition_queue_t);
1566         queue_Remove(dpq);
1567         assert(pthread_mutex_unlock(&params->lock) == 0);
1568         diskP = dpq->diskP;
1569         free(dpq);
1570         id = diskP->index;
1571
1572         count = 0;
1573         while (ShutdownVolumeWalk_r(diskP, 0, &params->part_pass_head[id]))
1574             count++;
1575         params->stats[0][diskP->index] = count;
1576         assert(pthread_mutex_lock(&params->lock) == 0);
1577     }
1578
1579     params->n_threads_complete++;
1580     if (params->n_threads_complete == params->n_threads) {
1581       /* notify control thread that all workers have completed pass 0 */
1582       assert(pthread_cond_signal(&params->master_cv) == 0);
1583     }
1584     while (params->pass == 0) {
1585       assert(pthread_cond_wait(&params->cv, &params->lock) == 0);
1586     }
1587
1588     /* switch locks */
1589     assert(pthread_mutex_unlock(&params->lock) == 0);
1590     VOL_LOCK;
1591
1592     pass = params->pass;
1593     assert(pass > 0);
1594
1595     /* now escalate through the more complicated shutdowns */
1596     while (pass <= 3) {
1597         schedule_version_save = params->schedule_version;
1598         found = 0;
1599         /* find a disk partition to work on */
1600         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1601             id = diskP->index;
1602             if (params->part_thread_target[id] && !params->part_done_pass[id]) {
1603                 params->part_thread_target[id]--;
1604                 found = 1;
1605                 break;
1606             }
1607         }
1608
1609         if (!found) {
1610             /* hmm. for some reason the controller thread couldn't find anything for
1611              * us to do. let's see if there's anything we can do */
1612             for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1613                 id = diskP->index;
1614                 if (diskP->vol_list.len && !params->part_done_pass[id]) {
1615                     found = 1;
1616                     break;
1617                 } else if (!params->part_done_pass[id]) {
1618                     params->part_done_pass[id] = 1;
1619                     params->n_parts_done_pass++;
1620                     if (pass == 3) {
1621                         Log("VShutdown:  done shutting down volumes on partition %s.\n",
1622                             VPartitionPath(diskP));
1623                     }
1624                 }
1625             }
1626         }
1627
1628         /* do work on this partition until either the controller
1629          * creates a new schedule, or we run out of things to do
1630          * on this partition */
1631         if (found) {
1632             count = 0;
1633             while (!params->part_done_pass[id] &&
1634                    (schedule_version_save == params->schedule_version)) {
1635                 /* ShutdownVolumeWalk_r will drop the glock internally */
1636                 if (!ShutdownVolumeWalk_r(diskP, pass, &params->part_pass_head[id])) {
1637                     if (!params->part_done_pass[id]) {
1638                         params->part_done_pass[id] = 1;
1639                         params->n_parts_done_pass++;
1640                         if (pass == 3) {
1641                             Log("VShutdown:  done shutting down volumes on partition %s.\n",
1642                                 VPartitionPath(diskP));
1643                         }
1644                     }
1645                     break;
1646                 }
1647                 count++;
1648             }
1649
1650             params->stats[pass][id] += count;
1651         } else {
1652             /* ok, everyone is done this pass, proceed */
1653
1654             /* barrier lock */
1655             params->n_threads_complete++;
1656             while (params->pass == pass) {
1657                 if (params->n_threads_complete == params->n_threads) {
1658                     /* we are the last thread to complete, so we will
1659                      * reinitialize worker pool state for the next pass */
1660                     params->n_threads_complete = 0;
1661                     params->n_parts_done_pass = 0;
1662                     params->pass++;
1663                     for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1664                         id = diskP->index;
1665                         params->part_done_pass[id] = 0;
1666                         params->part_pass_head[id] = queue_First(&diskP->vol_list, rx_queue);
1667                     }
1668
1669                     /* compute a new thread schedule before releasing all the workers */
1670                     ShutdownCreateSchedule(params);
1671
1672                     /* wake up all the workers */
1673                     assert(pthread_cond_broadcast(&params->cv) == 0);
1674
1675                     VOL_UNLOCK;
1676                     Log("VShutdown:  pass %d completed using %d threads on %d partitions\n",
1677                         pass, params->n_threads, params->n_parts);
1678                     VOL_LOCK;
1679                 } else {
1680                     VOL_CV_WAIT(&params->cv);
1681                 }
1682             }
1683             pass = params->pass;
1684         }
1685
1686         /* for fairness */
1687         VOL_UNLOCK;
1688         pthread_yield();
1689         VOL_LOCK;
1690     }
1691
1692     VOL_UNLOCK;
1693
1694     return NULL;
1695 }
1696
1697 /* shut down all volumes on a given disk partition
1698  *
1699  * note that this function will not allow mp-fast
1700  * shutdown of a partition */
1701 int
1702 VShutdownByPartition_r(struct DiskPartition64 * dp)
1703 {
1704     int pass;
1705     int pass_stats[4];
1706     int total;
1707
1708     /* wait for other exclusive ops to finish */
1709     VVByPListWait_r(dp);
1710
1711     /* begin exclusive access */
1712     VVByPListBeginExclusive_r(dp);
1713
1714     /* pick the low-hanging fruit first,
1715      * then do the complicated ones last
1716      * (has the advantage of keeping
1717      *  in-use volumes up until the bitter end) */
1718     for (pass = 0, total=0; pass < 4; pass++) {
1719         pass_stats[pass] = ShutdownVByPForPass_r(dp, pass);
1720         total += pass_stats[pass];
1721     }
1722
1723     /* end exclusive access */
1724     VVByPListEndExclusive_r(dp);
1725
1726     Log("VShutdownByPartition:  shut down %d volumes on %s (pass[0]=%d, pass[1]=%d, pass[2]=%d, pass[3]=%d)\n",
1727         total, VPartitionPath(dp), pass_stats[0], pass_stats[1], pass_stats[2], pass_stats[3]);
1728
1729     return 0;
1730 }
1731
1732 /* internal shutdown functionality
1733  *
1734  * for multi-pass shutdown:
1735  * 0 to only "shutdown" {pre,un}attached and error state volumes
1736  * 1 to also shutdown attached volumes w/ volume header loaded
1737  * 2 to also shutdown attached volumes w/o volume header loaded
1738  * 3 to also shutdown exclusive state volumes
1739  *
1740  * caller MUST hold exclusive access on the hash chain
1741  * because we drop vol_glock_mutex internally
1742  *
1743  * this function is reentrant for passes 1--3
1744  * (e.g. multiple threads can cooperate to
1745  *  shutdown a partition mp-fast)
1746  *
1747  * pass 0 is not scaleable because the volume state data is
1748  * synchronized by vol_glock mutex, and the locking overhead
1749  * is too high to drop the lock long enough to do linked list
1750  * traversal
1751  */
1752 static int
1753 ShutdownVByPForPass_r(struct DiskPartition64 * dp, int pass)
1754 {
1755     struct rx_queue * q = queue_First(&dp->vol_list, rx_queue);
1756     register int i = 0;
1757
1758     while (ShutdownVolumeWalk_r(dp, pass, &q))
1759         i++;
1760
1761     return i;
1762 }
1763
1764 /* conditionally shutdown one volume on partition dp
1765  * returns 1 if a volume was shutdown in this pass,
1766  * 0 otherwise */
1767 static int
1768 ShutdownVolumeWalk_r(struct DiskPartition64 * dp, int pass,
1769                      struct rx_queue ** idx)
1770 {
1771     struct rx_queue *qp, *nqp;
1772     Volume * vp;
1773
1774     qp = *idx;
1775
1776     for (queue_ScanFrom(&dp->vol_list, qp, qp, nqp, rx_queue)) {
1777         vp = (Volume *) (((char *)qp) - offsetof(Volume, vol_list));
1778
1779         switch (pass) {
1780         case 0:
1781             if ((V_attachState(vp) != VOL_STATE_UNATTACHED) &&
1782                 (V_attachState(vp) != VOL_STATE_ERROR) &&
1783                 (V_attachState(vp) != VOL_STATE_PREATTACHED)) {
1784                 break;
1785             }
1786         case 1:
1787             if ((V_attachState(vp) == VOL_STATE_ATTACHED) &&
1788                 (vp->header == NULL)) {
1789                 break;
1790             }
1791         case 2:
1792             if (VIsExclusiveState(V_attachState(vp))) {
1793                 break;
1794             }
1795         case 3:
1796             *idx = nqp;
1797             DeleteVolumeFromVByPList_r(vp);
1798             VShutdownVolume_r(vp);
1799             vp = NULL;
1800             return 1;
1801         }
1802     }
1803
1804     return 0;
1805 }
1806
1807 /*
1808  * shutdown a specific volume
1809  */
1810 /* caller MUST NOT hold a heavyweight ref on vp */
1811 int
1812 VShutdownVolume_r(Volume * vp)
1813 {
1814     int code;
1815
1816     VCreateReservation_r(vp);
1817
1818     if (LogLevel >= 5) {
1819         Log("VShutdownVolume_r:  vid=%u, device=%d, state=%hu\n",
1820             vp->hashid, vp->partition->device, V_attachState(vp));
1821     }
1822
1823     /* wait for other blocking ops to finish */
1824     VWaitExclusiveState_r(vp);
1825
1826     assert(VIsValidState(V_attachState(vp)));
1827
1828     switch(V_attachState(vp)) {
1829     case VOL_STATE_SALVAGING:
1830         /* Leave salvaging volumes alone. Any in-progress salvages will
1831          * continue working after viced shuts down. This is intentional.
1832          */
1833
1834     case VOL_STATE_PREATTACHED:
1835     case VOL_STATE_ERROR:
1836         VChangeState_r(vp, VOL_STATE_UNATTACHED);
1837     case VOL_STATE_UNATTACHED:
1838         break;
1839     case VOL_STATE_GOING_OFFLINE:
1840     case VOL_STATE_SHUTTING_DOWN:
1841     case VOL_STATE_ATTACHED:
1842         code = VHold_r(vp);
1843         if (!code) {
1844             if (LogLevel >= 5)
1845                 Log("VShutdown:  Attempting to take volume %u offline.\n",
1846                     vp->hashid);
1847
1848             /* take the volume offline (drops reference count) */
1849             VOffline_r(vp, "File server was shut down");
1850         }
1851         break;
1852     default:
1853         break;
1854     }
1855
1856     VCancelReservation_r(vp);
1857     vp = NULL;
1858     return 0;
1859 }
1860 #endif /* AFS_DEMAND_ATTACH_FS */
1861
1862
1863 /***************************************************/
1864 /* Header I/O routines                             */
1865 /***************************************************/
1866
1867 /* open a descriptor for the inode (h),
1868  * read in an on-disk structure into buffer (to) of size (size),
1869  * verify versionstamp in structure has magic (magic) and
1870  * optionally verify version (version) if (version) is nonzero
1871  */
1872 static void
1873 ReadHeader(Error * ec, IHandle_t * h, char *to, int size, bit32 magic,
1874            bit32 version)
1875 {
1876     struct versionStamp *vsn;
1877     FdHandle_t *fdP;
1878
1879     *ec = 0;
1880     if (h == NULL) {
1881         *ec = VSALVAGE;
1882         return;
1883     }
1884
1885     fdP = IH_OPEN(h);
1886     if (fdP == NULL) {
1887         *ec = VSALVAGE;
1888         return;
1889     }
1890
1891     if (FDH_SEEK(fdP, 0, SEEK_SET) < 0) {
1892         *ec = VSALVAGE;
1893         FDH_REALLYCLOSE(fdP);
1894         return;
1895     }
1896     vsn = (struct versionStamp *)to;
1897     if (FDH_READ(fdP, to, size) != size || vsn->magic != magic) {
1898         *ec = VSALVAGE;
1899         FDH_REALLYCLOSE(fdP);
1900         return;
1901     }
1902     FDH_CLOSE(fdP);
1903
1904     /* Check is conditional, in case caller wants to inspect version himself */
1905     if (version && vsn->version != version) {
1906         *ec = VSALVAGE;
1907     }
1908 }
1909
1910 void
1911 WriteVolumeHeader_r(Error * ec, Volume * vp)
1912 {
1913     IHandle_t *h = V_diskDataHandle(vp);
1914     FdHandle_t *fdP;
1915
1916     *ec = 0;
1917
1918     fdP = IH_OPEN(h);
1919     if (fdP == NULL) {
1920         *ec = VSALVAGE;
1921         return;
1922     }
1923     if (FDH_SEEK(fdP, 0, SEEK_SET) < 0) {
1924         *ec = VSALVAGE;
1925         FDH_REALLYCLOSE(fdP);
1926         return;
1927     }
1928     if (FDH_WRITE(fdP, (char *)&V_disk(vp), sizeof(V_disk(vp)))
1929         != sizeof(V_disk(vp))) {
1930         *ec = VSALVAGE;
1931         FDH_REALLYCLOSE(fdP);
1932         return;
1933     }
1934     FDH_CLOSE(fdP);
1935 }
1936
1937 /* VolumeHeaderToDisk
1938  * Allows for storing 64 bit inode numbers in on-disk volume header
1939  * file.
1940  */
1941 /* convert in-memory representation of a volume header to the
1942  * on-disk representation of a volume header */
1943 void
1944 VolumeHeaderToDisk(VolumeDiskHeader_t * dh, VolumeHeader_t * h)
1945 {
1946
1947     memset(dh, 0, sizeof(VolumeDiskHeader_t));
1948     dh->stamp = h->stamp;
1949     dh->id = h->id;
1950     dh->parent = h->parent;
1951
1952 #ifdef AFS_64BIT_IOPS_ENV
1953     dh->volumeInfo_lo = (afs_int32) h->volumeInfo & 0xffffffff;
1954     dh->volumeInfo_hi = (afs_int32) (h->volumeInfo >> 32) & 0xffffffff;
1955     dh->smallVnodeIndex_lo = (afs_int32) h->smallVnodeIndex & 0xffffffff;
1956     dh->smallVnodeIndex_hi =
1957         (afs_int32) (h->smallVnodeIndex >> 32) & 0xffffffff;
1958     dh->largeVnodeIndex_lo = (afs_int32) h->largeVnodeIndex & 0xffffffff;
1959     dh->largeVnodeIndex_hi =
1960         (afs_int32) (h->largeVnodeIndex >> 32) & 0xffffffff;
1961     dh->linkTable_lo = (afs_int32) h->linkTable & 0xffffffff;
1962     dh->linkTable_hi = (afs_int32) (h->linkTable >> 32) & 0xffffffff;
1963 #else
1964     dh->volumeInfo_lo = h->volumeInfo;
1965     dh->smallVnodeIndex_lo = h->smallVnodeIndex;
1966     dh->largeVnodeIndex_lo = h->largeVnodeIndex;
1967     dh->linkTable_lo = h->linkTable;
1968 #endif
1969 }
1970
1971 /* DiskToVolumeHeader
1972  * Converts an on-disk representation of a volume header to
1973  * the in-memory representation of a volume header.
1974  *
1975  * Makes the assumption that AFS has *always*
1976  * zero'd the volume header file so that high parts of inode
1977  * numbers are 0 in older (SGI EFS) volume header files.
1978  */
1979 void
1980 DiskToVolumeHeader(VolumeHeader_t * h, VolumeDiskHeader_t * dh)
1981 {
1982     memset(h, 0, sizeof(VolumeHeader_t));
1983     h->stamp = dh->stamp;
1984     h->id = dh->id;
1985     h->parent = dh->parent;
1986
1987 #ifdef AFS_64BIT_IOPS_ENV
1988     h->volumeInfo =
1989         (Inode) dh->volumeInfo_lo | ((Inode) dh->volumeInfo_hi << 32);
1990
1991     h->smallVnodeIndex =
1992         (Inode) dh->smallVnodeIndex_lo | ((Inode) dh->
1993                                           smallVnodeIndex_hi << 32);
1994
1995     h->largeVnodeIndex =
1996         (Inode) dh->largeVnodeIndex_lo | ((Inode) dh->
1997                                           largeVnodeIndex_hi << 32);
1998     h->linkTable =
1999         (Inode) dh->linkTable_lo | ((Inode) dh->linkTable_hi << 32);
2000 #else
2001     h->volumeInfo = dh->volumeInfo_lo;
2002     h->smallVnodeIndex = dh->smallVnodeIndex_lo;
2003     h->largeVnodeIndex = dh->largeVnodeIndex_lo;
2004     h->linkTable = dh->linkTable_lo;
2005 #endif
2006 }
2007
2008
2009 /***************************************************/
2010 /* Volume Attachment routines                      */
2011 /***************************************************/
2012
2013 #ifdef AFS_DEMAND_ATTACH_FS
2014 /**
2015  * pre-attach a volume given its path.
2016  *
2017  * @param[out] ec         outbound error code
2018  * @param[in]  partition  partition path string
2019  * @param[in]  name       volume id string
2020  *
2021  * @return volume object pointer
2022  *
2023  * @note A pre-attached volume will only have its partition
2024  *       and hashid fields initialized.  At first call to
2025  *       VGetVolume, the volume will be fully attached.
2026  *
2027  */
2028 Volume *
2029 VPreAttachVolumeByName(Error * ec, char *partition, char *name)
2030 {
2031     Volume * vp;
2032     VOL_LOCK;
2033     vp = VPreAttachVolumeByName_r(ec, partition, name);
2034     VOL_UNLOCK;
2035     return vp;
2036 }
2037
2038 /**
2039  * pre-attach a volume given its path.
2040  *
2041  * @param[out] ec         outbound error code
2042  * @param[in]  partition  path to vice partition
2043  * @param[in]  name       volume id string
2044  *
2045  * @return volume object pointer
2046  *
2047  * @pre VOL_LOCK held
2048  *
2049  * @internal volume package internal use only.
2050  */
2051 Volume *
2052 VPreAttachVolumeByName_r(Error * ec, char *partition, char *name)
2053 {
2054     return VPreAttachVolumeById_r(ec,
2055                                   partition,
2056                                   VolumeNumber(name));
2057 }
2058
2059 /**
2060  * pre-attach a volume given its path and numeric volume id.
2061  *
2062  * @param[out] ec          error code return
2063  * @param[in]  partition   path to vice partition
2064  * @param[in]  volumeId    numeric volume id
2065  *
2066  * @return volume object pointer
2067  *
2068  * @pre VOL_LOCK held
2069  *
2070  * @internal volume package internal use only.
2071  */
2072 Volume *
2073 VPreAttachVolumeById_r(Error * ec,
2074                        char * partition,
2075                        VolId volumeId)
2076 {
2077     Volume *vp;
2078     struct DiskPartition64 *partp;
2079
2080     *ec = 0;
2081
2082     assert(programType == fileServer);
2083
2084     if (!(partp = VGetPartition_r(partition, 0))) {
2085         *ec = VNOVOL;
2086         Log("VPreAttachVolumeById_r:  Error getting partition (%s)\n", partition);
2087         return NULL;
2088     }
2089
2090     vp = VLookupVolume_r(ec, volumeId, NULL);
2091     if (*ec) {
2092         return NULL;
2093     }
2094
2095     return VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2096 }
2097
2098 /**
2099  * preattach a volume.
2100  *
2101  * @param[out] ec     outbound error code
2102  * @param[in]  partp  pointer to partition object
2103  * @param[in]  vp     pointer to volume object
2104  * @param[in]  vid    volume id
2105  *
2106  * @return volume object pointer
2107  *
2108  * @pre VOL_LOCK is held.
2109  *
2110  * @warning Returned volume object pointer does not have to
2111  *          equal the pointer passed in as argument vp.  There
2112  *          are potential race conditions which can result in
2113  *          the pointers having different values.  It is up to
2114  *          the caller to make sure that references are handled
2115  *          properly in this case.
2116  *
2117  * @note If there is already a volume object registered with
2118  *       the same volume id, its pointer MUST be passed as
2119  *       argument vp.  Failure to do so will result in a silent
2120  *       failure to preattach.
2121  *
2122  * @internal volume package internal use only.
2123  */
2124 Volume *
2125 VPreAttachVolumeByVp_r(Error * ec,
2126                        struct DiskPartition64 * partp,
2127                        Volume * vp,
2128                        VolId vid)
2129 {
2130     Volume *nvp = NULL;
2131
2132     *ec = 0;
2133
2134     /* check to see if pre-attach already happened */
2135     if (vp &&
2136         (V_attachState(vp) != VOL_STATE_UNATTACHED) &&
2137         (V_attachState(vp) != VOL_STATE_PREATTACHED) &&
2138         !VIsErrorState(V_attachState(vp))) {
2139         /*
2140          * pre-attach is a no-op in all but the following cases:
2141          *
2142          *   - volume is unattached
2143          *   - volume is in an error state
2144          *   - volume is pre-attached
2145          */
2146         Log("VPreattachVolumeByVp_r: volume %u not in quiescent state\n", vid);
2147         goto done;
2148     } else if (vp) {
2149         /* we're re-attaching a volume; clear out some old state */
2150         memset(&vp->salvage, 0, sizeof(struct VolumeOnlineSalvage));
2151
2152         if (V_partition(vp) != partp) {
2153             /* XXX potential race */
2154             DeleteVolumeFromVByPList_r(vp);
2155         }
2156     } else {
2157         /* if we need to allocate a new Volume struct,
2158          * go ahead and drop the vol glock, otherwise
2159          * do the basic setup synchronised, as it's
2160          * probably not worth dropping the lock */
2161         VOL_UNLOCK;
2162
2163         /* allocate the volume structure */
2164         vp = nvp = (Volume *) malloc(sizeof(Volume));
2165         assert(vp != NULL);
2166         memset(vp, 0, sizeof(Volume));
2167         queue_Init(&vp->vnode_list);
2168         assert(pthread_cond_init(&V_attachCV(vp), NULL) == 0);
2169     }
2170
2171     /* link the volume with its associated vice partition */
2172     vp->device = partp->device;
2173     vp->partition = partp;
2174
2175     vp->hashid = vid;
2176     vp->specialStatus = 0;
2177
2178     /* if we dropped the lock, reacquire the lock,
2179      * check for pre-attach races, and then add
2180      * the volume to the hash table */
2181     if (nvp) {
2182         VOL_LOCK;
2183         nvp = VLookupVolume_r(ec, vid, NULL);
2184         if (*ec) {
2185             free(vp);
2186             vp = NULL;
2187             goto done;
2188         } else if (nvp) { /* race detected */
2189             free(vp);
2190             vp = nvp;
2191             goto done;
2192         } else {
2193           /* hack to make up for VChangeState_r() decrementing
2194            * the old state counter */
2195           VStats.state_levels[0]++;
2196         }
2197     }
2198
2199     /* put pre-attached volume onto the hash table
2200      * and bring it up to the pre-attached state */
2201     AddVolumeToHashTable(vp, vp->hashid);
2202     AddVolumeToVByPList_r(vp);
2203     VLRU_Init_Node_r(vp);
2204     VChangeState_r(vp, VOL_STATE_PREATTACHED);
2205
2206     if (LogLevel >= 5)
2207         Log("VPreAttachVolumeByVp_r:  volume %u pre-attached\n", vp->hashid);
2208
2209   done:
2210     if (*ec)
2211         return NULL;
2212     else
2213         return vp;
2214 }
2215 #endif /* AFS_DEMAND_ATTACH_FS */
2216
2217 /* Attach an existing volume, given its pathname, and return a
2218    pointer to the volume header information.  The volume also
2219    normally goes online at this time.  An offline volume
2220    must be reattached to make it go online */
2221 Volume *
2222 VAttachVolumeByName(Error * ec, char *partition, char *name, int mode)
2223 {
2224     Volume *retVal;
2225     VOL_LOCK;
2226     retVal = VAttachVolumeByName_r(ec, partition, name, mode);
2227     VOL_UNLOCK;
2228     return retVal;
2229 }
2230
2231 Volume *
2232 VAttachVolumeByName_r(Error * ec, char *partition, char *name, int mode)
2233 {
2234     register Volume *vp = NULL;
2235     struct DiskPartition64 *partp;
2236     char path[64];
2237     int isbusy = 0;
2238     VolId volumeId;
2239 #ifdef AFS_DEMAND_ATTACH_FS
2240     VolumeStats stats_save;
2241     Volume *svp = NULL;
2242 #endif /* AFS_DEMAND_ATTACH_FS */
2243
2244     *ec = 0;
2245
2246     volumeId = VolumeNumber(name);
2247
2248     if (!(partp = VGetPartition_r(partition, 0))) {
2249         *ec = VNOVOL;
2250         Log("VAttachVolume: Error getting partition (%s)\n", partition);
2251         goto done;
2252     }
2253
2254     if (VRequiresPartLock()) {
2255         assert(VInit == 3);
2256         VLockPartition_r(partition);
2257     } else if (programType == fileServer) {
2258 #ifdef AFS_DEMAND_ATTACH_FS
2259         /* lookup the volume in the hash table */
2260         vp = VLookupVolume_r(ec, volumeId, NULL);
2261         if (*ec) {
2262             return NULL;
2263         }
2264
2265         if (vp) {
2266             /* save any counters that are supposed to
2267              * be monotonically increasing over the
2268              * lifetime of the fileserver */
2269             memcpy(&stats_save, &vp->stats, sizeof(VolumeStats));
2270         } else {
2271             memset(&stats_save, 0, sizeof(VolumeStats));
2272         }
2273
2274         /* if there's something in the hash table, and it's not
2275          * in the pre-attach state, then we may need to detach
2276          * it before proceeding */
2277         if (vp && (V_attachState(vp) != VOL_STATE_PREATTACHED)) {
2278             VCreateReservation_r(vp);
2279             VWaitExclusiveState_r(vp);
2280
2281             /* at this point state must be one of:
2282              *   - UNATTACHED
2283              *   - ATTACHED
2284              *   - SHUTTING_DOWN
2285              *   - GOING_OFFLINE
2286              *   - SALVAGING
2287              *   - ERROR
2288              */
2289
2290             if (vp->specialStatus == VBUSY)
2291                 isbusy = 1;
2292
2293             /* if it's already attached, see if we can return it */
2294             if (V_attachState(vp) == VOL_STATE_ATTACHED) {
2295                 VGetVolumeByVp_r(ec, vp);
2296                 if (V_inUse(vp) == fileServer) {
2297                     VCancelReservation_r(vp);
2298                     return vp;
2299                 }
2300
2301                 /* otherwise, we need to detach, and attempt to re-attach */
2302                 VDetachVolume_r(ec, vp);
2303                 if (*ec) {
2304                     Log("VAttachVolume: Error detaching old volume instance (%s)\n", name);
2305                 }
2306             } else {
2307                 /* if it isn't fully attached, delete from the hash tables,
2308                    and let the refcounter handle the rest */
2309                 DeleteVolumeFromHashTable(vp);
2310                 DeleteVolumeFromVByPList_r(vp);
2311             }
2312
2313             VCancelReservation_r(vp);
2314             vp = NULL;
2315         }
2316
2317         /* pre-attach volume if it hasn't been done yet */
2318         if (!vp ||
2319             (V_attachState(vp) == VOL_STATE_UNATTACHED) ||
2320             (V_attachState(vp) == VOL_STATE_ERROR)) {
2321             svp = vp;
2322             vp = VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2323             if (*ec) {
2324                 return NULL;
2325             }
2326         }
2327
2328         assert(vp != NULL);
2329
2330         /* handle pre-attach races
2331          *
2332          * multiple threads can race to pre-attach a volume,
2333          * but we can't let them race beyond that
2334          *
2335          * our solution is to let the first thread to bring
2336          * the volume into an exclusive state win; the other
2337          * threads just wait until it finishes bringing the
2338          * volume online, and then they do a vgetvolumebyvp
2339          */
2340         if (svp && (svp != vp)) {
2341             /* wait for other exclusive ops to finish */
2342             VCreateReservation_r(vp);
2343             VWaitExclusiveState_r(vp);
2344
2345             /* get a heavyweight ref, kill the lightweight ref, and return */
2346             VGetVolumeByVp_r(ec, vp);
2347             VCancelReservation_r(vp);
2348             return vp;
2349         }
2350
2351         /* at this point, we are chosen as the thread to do
2352          * demand attachment for this volume. all other threads
2353          * doing a getvolume on vp->hashid will block until we finish */
2354
2355         /* make sure any old header cache entries are invalidated
2356          * before proceeding */
2357         FreeVolumeHeader(vp);
2358
2359         VChangeState_r(vp, VOL_STATE_ATTACHING);
2360
2361         /* restore any saved counters */
2362         memcpy(&vp->stats, &stats_save, sizeof(VolumeStats));
2363 #else /* AFS_DEMAND_ATTACH_FS */
2364         vp = VGetVolume_r(ec, volumeId);
2365         if (vp) {
2366             if (V_inUse(vp) == fileServer)
2367                 return vp;
2368             if (vp->specialStatus == VBUSY)
2369                 isbusy = 1;
2370             VDetachVolume_r(ec, vp);
2371             if (*ec) {
2372                 Log("VAttachVolume: Error detaching volume (%s)\n", name);
2373             }
2374             vp = NULL;
2375         }
2376 #endif /* AFS_DEMAND_ATTACH_FS */
2377     }
2378
2379     *ec = 0;
2380     strcpy(path, VPartitionPath(partp));
2381
2382     VOL_UNLOCK;
2383
2384     strcat(path, "/");
2385     strcat(path, name);
2386
2387     if (!vp) {
2388       vp = (Volume *) calloc(1, sizeof(Volume));
2389       assert(vp != NULL);
2390       vp->hashid = volumeId;
2391       vp->device = partp->device;
2392       vp->partition = partp;
2393       queue_Init(&vp->vnode_list);
2394 #ifdef AFS_DEMAND_ATTACH_FS
2395       assert(pthread_cond_init(&V_attachCV(vp), NULL) == 0);
2396 #endif /* AFS_DEMAND_ATTACH_FS */
2397     }
2398
2399     /* attach2 is entered without any locks, and returns
2400      * with vol_glock_mutex held */
2401     vp = attach2(ec, volumeId, path, partp, vp, isbusy, mode);
2402
2403     if (VCanUseFSSYNC() && vp) {
2404 #ifdef AFS_DEMAND_ATTACH_FS
2405         if ((mode == V_VOLUPD) || (VolumeWriteable(vp) && (mode == V_CLONE))) {
2406             /* mark volume header as in use so that volser crashes lead to a
2407              * salvage attempt */
2408             VUpdateVolume_r(ec, vp, 0);
2409         }
2410         /* for dafs, we should tell the fileserver, except for V_PEEK
2411          * where we know it is not necessary */
2412         if (mode == V_PEEK) {
2413             vp->needsPutBack = 0;
2414         } else {
2415             vp->needsPutBack = 1;
2416         }
2417 #else /* !AFS_DEMAND_ATTACH_FS */
2418         /* duplicate computation in fssync.c about whether the server
2419          * takes the volume offline or not.  If the volume isn't
2420          * offline, we must not return it when we detach the volume,
2421          * or the server will abort */
2422         if (mode == V_READONLY || mode == V_PEEK
2423             || (!VolumeWriteable(vp) && (mode == V_CLONE || mode == V_DUMP)))
2424             vp->needsPutBack = 0;
2425         else
2426             vp->needsPutBack = 1;
2427 #endif /* !AFS_DEMAND_ATTACH_FS */
2428     }
2429     /* OK, there's a problem here, but one that I don't know how to
2430      * fix right now, and that I don't think should arise often.
2431      * Basically, we should only put back this volume to the server if
2432      * it was given to us by the server, but since we don't have a vp,
2433      * we can't run the VolumeWriteable function to find out as we do
2434      * above when computing vp->needsPutBack.  So we send it back, but
2435      * there's a path in VAttachVolume on the server which may abort
2436      * if this volume doesn't have a header.  Should be pretty rare
2437      * for all of that to happen, but if it does, probably the right
2438      * fix is for the server to allow the return of readonly volumes
2439      * that it doesn't think are really checked out. */
2440 #ifdef FSSYNC_BUILD_CLIENT
2441     if (VCanUseFSSYNC() && vp == NULL &&
2442         mode != V_SECRETLY && mode != V_PEEK) {
2443
2444 #ifdef AFS_DEMAND_ATTACH_FS
2445         /* If we couldn't attach but we scheduled a salvage, we already
2446          * notified the fileserver; don't online it now */
2447         if (*ec != VSALVAGING)
2448 #endif /* AFS_DEMAND_ATTACH_FS */
2449         FSYNC_VolOp(volumeId, partition, FSYNC_VOL_ON, 0, NULL);
2450     } else
2451 #endif
2452     if (programType == fileServer && vp) {
2453 #ifdef AFS_DEMAND_ATTACH_FS
2454         /*
2455          * we can get here in cases where we don't "own"
2456          * the volume (e.g. volume owned by a utility).
2457          * short circuit around potential disk header races.
2458          */
2459         if (V_attachState(vp) != VOL_STATE_ATTACHED) {
2460             goto done;
2461         }
2462 #endif
2463         VUpdateVolume_r(ec, vp, 0);
2464         if (*ec) {
2465             Log("VAttachVolume: Error updating volume\n");
2466             if (vp)
2467                 VPutVolume_r(vp);
2468             goto done;
2469         }
2470         if (VolumeWriteable(vp) && V_dontSalvage(vp) == 0) {
2471 #ifndef AFS_DEMAND_ATTACH_FS
2472             /* This is a hack: by temporarily setting the incore
2473              * dontSalvage flag ON, the volume will be put back on the
2474              * Update list (with dontSalvage OFF again).  It will then
2475              * come back in N minutes with DONT_SALVAGE eventually
2476              * set.  This is the way that volumes that have never had
2477              * it set get it set; or that volumes that have been
2478              * offline without DONT SALVAGE having been set also
2479              * eventually get it set */
2480             V_dontSalvage(vp) = DONT_SALVAGE;
2481 #endif /* !AFS_DEMAND_ATTACH_FS */
2482             VAddToVolumeUpdateList_r(ec, vp);
2483             if (*ec) {
2484                 Log("VAttachVolume: Error adding volume to update list\n");
2485                 if (vp)
2486                     VPutVolume_r(vp);
2487                 goto done;
2488             }
2489         }
2490         if (LogLevel)
2491             Log("VOnline:  volume %u (%s) attached and online\n", V_id(vp),
2492                 V_name(vp));
2493     }
2494
2495   done:
2496     if (VRequiresPartLock()) {
2497         VUnlockPartition_r(partition);
2498     }
2499     if (*ec) {
2500 #ifdef AFS_DEMAND_ATTACH_FS
2501         /* attach failed; make sure we're in error state */
2502         if (vp && !VIsErrorState(V_attachState(vp))) {
2503             VChangeState_r(vp, VOL_STATE_ERROR);
2504         }
2505 #endif /* AFS_DEMAND_ATTACH_FS */
2506         return NULL;
2507     } else {
2508         return vp;
2509     }
2510 }
2511
2512 #ifdef AFS_DEMAND_ATTACH_FS
2513 /* VAttachVolumeByVp_r
2514  *
2515  * finish attaching a volume that is
2516  * in a less than fully attached state
2517  */
2518 /* caller MUST hold a ref count on vp */
2519 static Volume *
2520 VAttachVolumeByVp_r(Error * ec, Volume * vp, int mode)
2521 {
2522     char name[VMAXPATHLEN];
2523     int reserve = 0;
2524     struct DiskPartition64 *partp;
2525     char path[64];
2526     int isbusy = 0;
2527     VolId volumeId;
2528     Volume * nvp = NULL;
2529     VolumeStats stats_save;
2530     *ec = 0;
2531
2532     /* volume utility should never call AttachByVp */
2533     assert(programType == fileServer);
2534
2535     volumeId = vp->hashid;
2536     partp = vp->partition;
2537     VolumeExternalName_r(volumeId, name, sizeof(name));
2538
2539
2540     /* if another thread is performing a blocking op, wait */
2541     VWaitExclusiveState_r(vp);
2542
2543     memcpy(&stats_save, &vp->stats, sizeof(VolumeStats));
2544
2545     /* if it's already attached, see if we can return it */
2546     if (V_attachState(vp) == VOL_STATE_ATTACHED) {
2547         VGetVolumeByVp_r(ec, vp);
2548         if (V_inUse(vp) == fileServer) {
2549             return vp;
2550         } else {
2551             if (vp->specialStatus == VBUSY)
2552                 isbusy = 1;
2553             VDetachVolume_r(ec, vp);
2554             if (*ec) {
2555                 Log("VAttachVolume: Error detaching volume (%s)\n", name);
2556             }
2557             vp = NULL;
2558         }
2559     }
2560
2561     /* pre-attach volume if it hasn't been done yet */
2562     if (!vp ||
2563         (V_attachState(vp) == VOL_STATE_UNATTACHED) ||
2564         (V_attachState(vp) == VOL_STATE_ERROR)) {
2565         nvp = VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2566         if (*ec) {
2567             return NULL;
2568         }
2569         if (nvp != vp) {
2570             reserve = 1;
2571             VCreateReservation_r(nvp);
2572             vp = nvp;
2573         }
2574     }
2575
2576     assert(vp != NULL);
2577     VChangeState_r(vp, VOL_STATE_ATTACHING);
2578
2579     /* restore monotonically increasing stats */
2580     memcpy(&vp->stats, &stats_save, sizeof(VolumeStats));
2581
2582     *ec = 0;
2583
2584     /* compute path to disk header */
2585     strcpy(path, VPartitionPath(partp));
2586
2587     VOL_UNLOCK;
2588
2589     strcat(path, "/");
2590     strcat(path, name);
2591
2592     /* do volume attach
2593      *
2594      * NOTE: attach2 is entered without any locks, and returns
2595      * with vol_glock_mutex held */
2596     vp = attach2(ec, volumeId, path, partp, vp, isbusy, mode);
2597
2598     /*
2599      * the event that an error was encountered, or
2600      * the volume was not brought to an attached state
2601      * for any reason, skip to the end.  We cannot
2602      * safely call VUpdateVolume unless we "own" it.
2603      */
2604     if (*ec ||
2605         (vp == NULL) ||
2606         (V_attachState(vp) != VOL_STATE_ATTACHED)) {
2607         goto done;
2608     }
2609
2610     VUpdateVolume_r(ec, vp, 0);
2611     if (*ec) {
2612         Log("VAttachVolume: Error updating volume %u\n", vp->hashid);
2613         VPutVolume_r(vp);
2614         goto done;
2615     }
2616     if (VolumeWriteable(vp) && V_dontSalvage(vp) == 0) {
2617 #ifndef AFS_DEMAND_ATTACH_FS
2618         /* This is a hack: by temporarily setting the incore
2619          * dontSalvage flag ON, the volume will be put back on the
2620          * Update list (with dontSalvage OFF again).  It will then
2621          * come back in N minutes with DONT_SALVAGE eventually
2622          * set.  This is the way that volumes that have never had
2623          * it set get it set; or that volumes that have been
2624          * offline without DONT SALVAGE having been set also
2625          * eventually get it set */
2626         V_dontSalvage(vp) = DONT_SALVAGE;
2627 #endif /* !AFS_DEMAND_ATTACH_FS */
2628         VAddToVolumeUpdateList_r(ec, vp);
2629         if (*ec) {
2630             Log("VAttachVolume: Error adding volume %u to update list\n", vp->hashid);
2631             if (vp)
2632                 VPutVolume_r(vp);
2633             goto done;
2634         }
2635     }
2636     if (LogLevel)
2637         Log("VOnline:  volume %u (%s) attached and online\n", V_id(vp),
2638             V_name(vp));
2639   done:
2640     if (reserve) {
2641         VCancelReservation_r(nvp);
2642         reserve = 0;
2643     }
2644     if (*ec && (*ec != VOFFLINE) && (*ec != VSALVAGE)) {
2645         if (vp && !VIsErrorState(V_attachState(vp))) {
2646             VChangeState_r(vp, VOL_STATE_ERROR);
2647         }
2648         return NULL;
2649     } else {
2650         return vp;
2651     }
2652 }
2653
2654 /**
2655  * lock a volume on disk (non-blocking).
2656  *
2657  * @param[in] vp  The volume to lock
2658  * @param[in] locktype READ_LOCK or WRITE_LOCK
2659  *
2660  * @return operation status
2661  *  @retval 0 success, lock was obtained
2662  *  @retval EBUSY a conflicting lock was held by another process
2663  *  @retval EIO   error acquiring lock
2664  *
2665  * @pre If we're in the fileserver, vp is in an exclusive state
2666  *
2667  * @pre vp is not already locked
2668  */
2669 static int
2670 VLockVolumeNB(Volume *vp, int locktype)
2671 {
2672     int code;
2673
2674     assert(programType != fileServer || VIsExclusiveState(V_attachState(vp)));
2675     assert(!(V_attachFlags(vp) & VOL_LOCKED));
2676
2677     code = VLockVolumeByIdNB(vp->hashid, vp->partition, locktype);
2678     if (code == 0) {
2679         V_attachFlags(vp) |= VOL_LOCKED;
2680     }
2681
2682     return code;
2683 }
2684
2685 /**
2686  * unlock a volume on disk that was locked with VLockVolumeNB.
2687  *
2688  * @param[in] vp  volume to unlock
2689  *
2690  * @pre If we're in the fileserver, vp is in an exclusive state
2691  *
2692  * @pre vp has already been locked
2693  */
2694 static void
2695 VUnlockVolume(Volume *vp)
2696 {
2697     assert(programType != fileServer || VIsExclusiveState(V_attachState(vp)));
2698     assert((V_attachFlags(vp) & VOL_LOCKED));
2699
2700     VUnlockVolumeById(vp->hashid, vp->partition);
2701
2702     V_attachFlags(vp) &= ~VOL_LOCKED;
2703 }
2704 #endif /* AFS_DEMAND_ATTACH_FS */
2705
2706 /**
2707  * read in a vol header, possibly lock the vol header, and possibly check out
2708  * the vol header from the fileserver, as part of volume attachment.
2709  *
2710  * @param[out] ec     error code
2711  * @param[in] vp      volume pointer object
2712  * @param[in] partp   disk partition object of the attaching partition
2713  * @param[in] mode    attachment mode such as V_VOLUPD, V_DUMP, etc (see
2714  *                    volume.h)
2715  * @param[in] peek    1 to just try to read in the volume header and make sure
2716  *                    we don't try to lock the vol, or check it out from
2717  *                    FSSYNC or anything like that; 0 otherwise, for 'normal'
2718  *                    operation
2719  *
2720  * @note As part of DAFS volume attachment, the volume header may be either
2721  *       read- or write-locked to ensure mutual exclusion of certain volume
2722  *       operations. In some cases in order to determine whether we need to
2723  *       read- or write-lock the header, we need to read in the header to see
2724  *       if the volume is RW or not. So, if we read in the header under a
2725  *       read-lock and determine that we actually need a write-lock on the
2726  *       volume header, this function will drop the read lock, acquire a write
2727  *       lock, and read the header in again.
2728  */
2729 static void
2730 attach_volume_header(Error *ec, Volume *vp, struct DiskPartition64 *partp,
2731                      int mode, int peek)
2732 {
2733     struct VolumeDiskHeader diskHeader;
2734     struct VolumeHeader header;
2735     int code;
2736     int first_try = 1;
2737     int lock_tries = 0, checkout_tries = 0;
2738     int retry;
2739     VolumeId volid = vp->hashid;
2740 #ifdef FSSYNC_BUILD_CLIENT
2741     int checkout, done_checkout = 0;
2742 #endif /* FSSYNC_BUILD_CLIENT */
2743 #ifdef AFS_DEMAND_ATTACH_FS
2744     int locktype = 0, use_locktype = -1;
2745 #endif /* AFS_DEMAND_ATTACH_FS */
2746
2747  retry:
2748     retry = 0;
2749     *ec = 0;
2750
2751     if (lock_tries > VOL_MAX_CHECKOUT_RETRIES) {
2752         Log("VAttachVolume: retried too many times trying to lock header for "
2753             "vol %lu part %s; giving up\n", afs_printable_uint32_lu(volid),
2754             VPartitionPath(partp));
2755         *ec = VNOVOL;
2756         goto done;
2757     }
2758     if (checkout_tries > VOL_MAX_CHECKOUT_RETRIES) {
2759         Log("VAttachVolume: retried too many times trying to checkout "
2760             "vol %lu part %s; giving up\n", afs_printable_uint32_lu(volid),
2761             VPartitionPath(partp));
2762         *ec = VNOVOL;
2763         goto done;
2764     }
2765
2766     if (VReadVolumeDiskHeader(volid, partp, NULL)) {
2767         /* short-circuit the 'volume does not exist' case */
2768         *ec = VNOVOL;
2769         goto done;
2770     }
2771
2772 #ifdef FSSYNC_BUILD_CLIENT
2773     checkout = !done_checkout;
2774     done_checkout = 1;
2775     if (!peek && checkout && VMustCheckoutVolume(mode)) {
2776         SYNC_response res;
2777         memset(&res, 0, sizeof(res));
2778
2779         if (FSYNC_VolOp(volid, VPartitionPath(partp), FSYNC_VOL_NEEDVOLUME, mode, &res)
2780             != SYNC_OK) {
2781
2782             if (res.hdr.reason == FSYNC_SALVAGE) {
2783                 Log("VAttachVolume: file server says volume %lu is salvaging\n",
2784                      afs_printable_uint32_lu(volid));
2785                 *ec = VSALVAGING;
2786             } else {
2787                 Log("VAttachVolume: attach of volume %lu apparently denied by file server\n",
2788                      afs_printable_uint32_lu(volid));
2789                 *ec = VNOVOL;   /* XXXX */
2790             }
2791             goto done;
2792         }
2793     }
2794 #endif
2795
2796 #ifdef AFS_DEMAND_ATTACH_FS
2797     if (use_locktype < 0) {
2798         /* don't know whether vol is RO or RW; assume it's RO and we can retry
2799          * if it turns out to be RW */
2800         locktype = VVolLockType(mode, 0);
2801
2802     } else {
2803         /* a previous try says we should use use_locktype to lock the volume,
2804          * so use that */
2805         locktype = use_locktype;
2806     }
2807
2808     if (!peek && locktype) {
2809         code = VLockVolumeNB(vp, locktype);
2810         if (code) {
2811             if (code == EBUSY) {
2812                 Log("VAttachVolume: another program has vol %lu locked\n",
2813                     afs_printable_uint32_lu(volid));
2814             } else {
2815                 Log("VAttachVolume: error %d trying to lock vol %lu\n",
2816                     code, afs_printable_uint32_lu(volid));
2817             }
2818
2819             *ec = VNOVOL;
2820             goto done;
2821         }
2822     }
2823 #endif /* AFS_DEMAND_ATTACH_FS */
2824
2825     code = VReadVolumeDiskHeader(volid, partp, &diskHeader);
2826     if (code) {
2827         if (code == EIO) {
2828             *ec = VSALVAGE;
2829         } else {
2830             *ec = VNOVOL;
2831         }
2832         goto done;
2833     }
2834
2835     DiskToVolumeHeader(&header, &diskHeader);
2836
2837     IH_INIT(vp->vnodeIndex[vLarge].handle, partp->device, header.parent,
2838             header.largeVnodeIndex);
2839     IH_INIT(vp->vnodeIndex[vSmall].handle, partp->device, header.parent,
2840             header.smallVnodeIndex);
2841     IH_INIT(vp->diskDataHandle, partp->device, header.parent,
2842             header.volumeInfo);
2843     IH_INIT(vp->linkHandle, partp->device, header.parent, header.linkTable);
2844
2845     if (first_try) {
2846         /* only need to do this once */
2847         VOL_LOCK;
2848         GetVolumeHeader(vp);
2849         VOL_UNLOCK;
2850     }
2851
2852 #if defined(AFS_DEMAND_ATTACH_FS) && defined(FSSYNC_BUILD_CLIENT)
2853     /* demand attach changes the V_PEEK mechanism
2854      *
2855      * we can now suck the current disk data structure over
2856      * the fssync interface without going to disk
2857      *
2858      * (technically, we don't need to restrict this feature
2859      *  to demand attach fileservers.  However, I'm trying
2860      *  to limit the number of common code changes)
2861      */
2862     if (VCanUseFSSYNC() && (mode == V_PEEK || peek)) {
2863         SYNC_response res;
2864         res.payload.len = sizeof(VolumeDiskData);
2865         res.payload.buf = &vp->header->diskstuff;
2866
2867         if (FSYNC_VolOp(vp->hashid,
2868                         partp->name,
2869                         FSYNC_VOL_QUERY_HDR,
2870                         FSYNC_WHATEVER,
2871                         &res) == SYNC_OK) {
2872             goto disk_header_loaded;
2873         }
2874     }
2875 #endif /* AFS_DEMAND_ATTACH_FS && FSSYNC_BUILD_CLIENT */
2876     (void)ReadHeader(ec, V_diskDataHandle(vp), (char *)&V_disk(vp),
2877                      sizeof(V_disk(vp)), VOLUMEINFOMAGIC, VOLUMEINFOVERSION);
2878
2879 #ifdef AFS_DEMAND_ATTACH_FS
2880     /* update stats */
2881     VOL_LOCK;
2882     IncUInt64(&VStats.hdr_loads);
2883     IncUInt64(&vp->stats.hdr_loads);
2884     VOL_UNLOCK;
2885 #endif /* AFS_DEMAND_ATTACH_FS */
2886
2887     if (*ec) {
2888         Log("VAttachVolume: Error reading diskDataHandle header for vol %lu; "
2889             "error=%u\n", afs_printable_uint32_lu(volid), *ec);
2890         goto done;
2891     }
2892
2893 #ifdef AFS_DEMAND_ATTACH_FS
2894 # ifdef FSSYNC_BUILD_CLIENT
2895  disk_header_loaded:
2896 # endif /* FSSYNC_BUILD_CLIENT */
2897
2898     /* if the lock type we actually used to lock the volume is different than
2899      * the lock type we should have used, retry with the lock type we should
2900      * use */
2901     use_locktype = VVolLockType(mode, VolumeWriteable(vp));
2902     if (locktype != use_locktype) {
2903         retry = 1;
2904         lock_tries++;
2905     }
2906 #endif /* AFS_DEMAND_ATTACH_FS */
2907
2908     *ec = 0;
2909
2910  done:
2911 #if defined(AFS_DEMAND_ATTACH_FS) && defined(FSSYNC_BUILD_CLIENT)
2912     if (!peek && *ec == 0 && retry == 0 && VMustCheckoutVolume(mode)) {
2913
2914         code = FSYNC_VerifyCheckout(volid, VPartitionPath(partp), FSYNC_VOL_NEEDVOLUME, mode);
2915
2916         if (code == SYNC_DENIED) {
2917             /* must retry checkout; fileserver no longer thinks we have
2918              * the volume */
2919             retry = 1;
2920             checkout_tries++;
2921             done_checkout = 0;
2922
2923         } else if (code != SYNC_OK) {
2924             *ec = VNOVOL;
2925         }
2926     }
2927 #endif /* AFS_DEMAND_ATTACH_FS && FSSYNC_BUILD_CLIENT */
2928
2929     if (*ec || retry) {
2930         /* either we are going to be called again for a second pass, or we
2931          * encountered an error; clean up in either case */
2932
2933 #ifdef AFS_DEMAND_ATTACH_FS
2934         if ((V_attachFlags(vp) & VOL_LOCKED)) {
2935             VUnlockVolume(vp);
2936         }
2937 #endif /* AFS_DEMAND_ATTACH_FS */
2938         if (vp->linkHandle) {
2939             IH_RELEASE(vp->vnodeIndex[vLarge].handle);
2940             IH_RELEASE(vp->vnodeIndex[vSmall].handle);
2941             IH_RELEASE(vp->diskDataHandle);
2942             IH_RELEASE(vp->linkHandle);
2943         }
2944     }
2945
2946     if (*ec) {
2947         return;
2948     }
2949     if (retry) {
2950         first_try = 0;
2951         goto retry;
2952     }
2953 }
2954
2955 #ifdef AFS_DEMAND_ATTACH_FS
2956 static void
2957 attach_check_vop(Error *ec, VolumeId volid, struct DiskPartition64 *partp,
2958                  Volume *vp)
2959 {
2960     *ec = 0;
2961
2962     if (vp->pending_vol_op) {
2963
2964         VOL_LOCK;
2965
2966         if (vp->pending_vol_op->vol_op_state == FSSYNC_VolOpRunningUnknown) {
2967             int code;
2968             code = VVolOpLeaveOnlineNoHeader_r(vp, vp->pending_vol_op);
2969             if (code == 1) {
2970                 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
2971             } else if (code == 0) {
2972                 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline;
2973
2974             } else {
2975                 /* we need the vol header to determine if the volume can be
2976                  * left online for the vop, so... get the header */
2977
2978                 VOL_UNLOCK;
2979
2980                 /* attach header with peek=1 to avoid checking out the volume
2981                  * or locking it; we just want the header info, we're not
2982                  * messing with the volume itself at all */
2983                 attach_volume_header(ec, vp, partp, V_PEEK, 1);
2984                 if (*ec) {
2985                     return;
2986                 }
2987
2988                 VOL_LOCK;
2989
2990                 if (VVolOpLeaveOnline_r(vp, vp->pending_vol_op)) {
2991                     vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
2992                 } else {
2993                     vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline;
2994                 }
2995
2996                 /* make sure we grab a new vol header and re-open stuff on
2997                  * actual attachment; we can't keep the data we grabbed, since
2998                  * it was not done under a lock and thus not safe */
2999                 FreeVolumeHeader(vp);
3000                 VReleaseVolumeHandles_r(vp);
3001             }
3002         }
3003         /* see if the pending volume op requires exclusive access */
3004         switch (vp->pending_vol_op->vol_op_state) {
3005         case FSSYNC_VolOpPending:
3006             /* this should never happen */
3007             assert(vp->pending_vol_op->vol_op_state != FSSYNC_VolOpPending);
3008             break;
3009
3010         case FSSYNC_VolOpRunningUnknown:
3011             /* this should never happen; we resolved 'unknown' above */
3012             assert(vp->pending_vol_op->vol_op_state != FSSYNC_VolOpRunningUnknown);
3013             break;
3014
3015         case FSSYNC_VolOpRunningOffline:
3016             /* mark the volume down */
3017             *ec = VOFFLINE;
3018             VChangeState_r(vp, VOL_STATE_UNATTACHED);
3019
3020             /* do not set V_offlineMessage here; we don't have ownership of
3021              * the volume (and probably do not have the header loaded), so we
3022              * can't alter the disk header */
3023
3024             /* check to see if we should set the specialStatus flag */
3025             if (VVolOpSetVBusy_r(vp, vp->pending_vol_op)) {
3026                 vp->specialStatus = VBUSY;
3027             }
3028             break;
3029
3030         default:
3031             break;
3032         }
3033
3034         VOL_UNLOCK;
3035     }
3036 }
3037 #endif /* AFS_DEMAND_ATTACH_FS */
3038
3039 /**
3040  * volume attachment helper function.
3041  *
3042  * @param[out] ec      error code
3043  * @param[in] volumeId volume ID of the attaching volume
3044  * @param[in] path     full path to the volume header .vol file
3045  * @param[in] partp    disk partition object for the attaching partition
3046  * @param[in] vp       volume object; vp->hashid, vp->device, vp->partition,
3047  *                     vp->vnode_list, and V_attachCV (for DAFS) should already
3048  *                     be initialized
3049  * @param[in] isbusy   1 if vp->specialStatus should be set to VBUSY; that is,
3050  *                     if there is a volume operation running for this volume
3051  *                     that should set the volume to VBUSY during its run. 0
3052  *                     otherwise. (see VVolOpSetVBusy_r)
3053  * @param[in] mode     attachment mode such as V_VOLUPD, V_DUMP, etc (see
3054  *                     volume.h)
3055  *
3056  * @return pointer to the semi-attached volume pointer
3057  *  @retval NULL an error occurred (check value of *ec)
3058  *  @retval vp volume successfully attaching
3059  *
3060  * @pre no locks held
3061  *
3062  * @post VOL_LOCK held
3063  */
3064 static Volume *
3065 attach2(Error * ec, VolId volumeId, char *path, struct DiskPartition64 *partp,
3066         Volume * vp, int isbusy, int mode)
3067 {
3068     /* have we read in the header successfully? */
3069     int read_header = 0;
3070
3071     /* should we FreeVolume(vp) instead of VCheckFree(vp) in the error
3072      * cleanup? */
3073     int forcefree = 0;
3074
3075     *ec = 0;
3076
3077     vp->vnodeIndex[vLarge].handle = NULL;
3078     vp->vnodeIndex[vSmall].handle = NULL;
3079     vp->diskDataHandle = NULL;
3080     vp->linkHandle = NULL;
3081
3082 #ifdef AFS_DEMAND_ATTACH_FS
3083     attach_check_vop(ec, volumeId, partp, vp);
3084     if (!*ec) {
3085         attach_volume_header(ec, vp, partp, mode, 0);
3086     }
3087 #else
3088     attach_volume_header(ec, vp, partp, mode, 0);
3089 #endif /* !AFS_DEMAND_ATTACH_FS */
3090
3091     if (*ec == VNOVOL) {
3092         /* if the volume doesn't exist, skip straight to 'error' so we don't
3093          * request a salvage */
3094         goto error;
3095     }
3096
3097     if (!*ec) {
3098         read_header = 1;
3099
3100         vp->specialStatus = (byte) (isbusy ? VBUSY : 0);
3101         vp->shuttingDown = 0;
3102         vp->goingOffline = 0;
3103         vp->nUsers = 1;
3104 #ifdef AFS_DEMAND_ATTACH_FS
3105         vp->stats.last_attach = FT_ApproxTime();
3106         vp->stats.attaches++;
3107 #endif
3108
3109         VOL_LOCK;
3110         IncUInt64(&VStats.attaches);
3111         vp->cacheCheck = ++VolumeCacheCheck;
3112         /* just in case this ever rolls over */
3113         if (!vp->cacheCheck)
3114             vp->cacheCheck = ++VolumeCacheCheck;
3115         VOL_UNLOCK;
3116
3117 #ifdef AFS_DEMAND_ATTACH_FS
3118         V_attachFlags(vp) |= VOL_HDR_LOADED;
3119         vp->stats.last_hdr_load = vp->stats.last_attach;
3120 #endif /* AFS_DEMAND_ATTACH_FS */
3121     }
3122
3123     if (!*ec) {
3124         struct IndexFileHeader iHead;
3125
3126 #if OPENAFS_VOL_STATS
3127         /*
3128          * We just read in the diskstuff part of the header.  If the detailed
3129          * volume stats area has not yet been initialized, we should bzero the
3130          * area and mark it as initialized.
3131          */
3132         if (!(V_stat_initialized(vp))) {
3133             memset((V_stat_area(vp)), 0, VOL_STATS_BYTES);
3134             V_stat_initialized(vp) = 1;
3135         }
3136 #endif /* OPENAFS_VOL_STATS */
3137
3138         (void)ReadHeader(ec, vp->vnodeIndex[vSmall].handle,
3139                          (char *)&iHead, sizeof(iHead),
3140                          SMALLINDEXMAGIC, SMALLINDEXVERSION);
3141
3142         if (*ec) {
3143             Log("VAttachVolume: Error reading smallVnode vol header %s; error=%u\n", path, *ec);
3144         }
3145     }
3146
3147     if (!*ec) {
3148         struct IndexFileHeader iHead;
3149
3150         (void)ReadHeader(ec, vp->vnodeIndex[vLarge].handle,
3151                          (char *)&iHead, sizeof(iHead),
3152                          LARGEINDEXMAGIC, LARGEINDEXVERSION);
3153
3154         if (*ec) {
3155             Log("VAttachVolume: Error reading largeVnode vol header %s; error=%u\n", path, *ec);
3156         }
3157     }
3158
3159 #ifdef AFS_NAMEI_ENV
3160     if (!*ec) {
3161         struct versionStamp stamp;
3162
3163         (void)ReadHeader(ec, V_linkHandle(vp), (char *)&stamp,
3164                          sizeof(stamp), LINKTABLEMAGIC, LINKTABLEVERSION);
3165
3166         if (*ec) {
3167             Log("VAttachVolume: Error reading namei vol header %s; error=%u\n", path, *ec);
3168         }
3169     }
3170 #endif /* AFS_NAMEI_ENV */
3171
3172 #if defined(AFS_DEMAND_ATTACH_FS)
3173     if (*ec && ((*ec != VOFFLINE) || (V_attachState(vp) != VOL_STATE_UNATTACHED))) {
3174         VOL_LOCK;
3175         if (!VCanScheduleSalvage()) {
3176             Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3177         }
3178         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
3179         vp->nUsers = 0;
3180
3181         goto error;
3182     } else if (*ec) {
3183         /* volume operation in progress */
3184         VOL_LOCK;
3185         goto error;
3186     }
3187 #else /* AFS_DEMAND_ATTACH_FS */
3188     if (*ec) {
3189         Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3190         VOL_LOCK;
3191         goto error;
3192     }
3193 #endif /* AFS_DEMAND_ATTACH_FS */
3194
3195     if (V_needsSalvaged(vp)) {
3196         if (vp->specialStatus)
3197             vp->specialStatus = 0;
3198         VOL_LOCK;
3199 #if defined(AFS_DEMAND_ATTACH_FS)
3200         if (!VCanScheduleSalvage()) {
3201             Log("VAttachVolume: volume salvage flag is ON for %s; volume needs salvage\n", path);
3202         }
3203         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER);
3204         vp->nUsers = 0;
3205
3206 #else /* AFS_DEMAND_ATTACH_FS */
3207         *ec = VSALVAGE;
3208 #endif /* AFS_DEMAND_ATTACH_FS */
3209
3210         goto error;
3211     }
3212
3213     VOL_LOCK;
3214     vp->nextVnodeUnique = V_uniquifier(vp);
3215
3216     if (VShouldCheckInUse(mode) && V_inUse(vp) && VolumeWriteable(vp)) {
3217         if (!V_needsSalvaged(vp)) {
3218             V_needsSalvaged(vp) = 1;
3219             VUpdateVolume_r(ec, vp, 0);
3220         }
3221 #if defined(AFS_DEMAND_ATTACH_FS)
3222         if (!VCanScheduleSalvage()) {
3223             Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3224         }
3225         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER);
3226         vp->nUsers = 0;
3227
3228 #else /* AFS_DEMAND_ATTACH_FS */
3229         Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3230         *ec = VSALVAGE;
3231 #endif /* AFS_DEMAND_ATTACH_FS */
3232
3233         goto error;
3234     }
3235
3236     if (programType == fileServer && V_destroyMe(vp) == DESTROY_ME) {
3237         /* Only check destroyMe if we are the fileserver, since the
3238          * volserver et al sometimes need to work with volumes with
3239          * destroyMe set. Examples are 'temporary' volumes the
3240          * volserver creates, and when we create a volume (destroyMe
3241          * is set on creation; sometimes a separate volserver
3242          * transaction is created to clear destroyMe).
3243          */
3244
3245 #if defined(AFS_DEMAND_ATTACH_FS)
3246         /* schedule a salvage so the volume goes away on disk */
3247         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
3248         VChangeState_r(vp, VOL_STATE_ERROR);
3249         vp->nUsers = 0;
3250 #endif /* AFS_DEMAND_ATTACH_FS */
3251         Log("VAttachVolume: volume %s is junk; it should be destroyed at next salvage\n", path);
3252         *ec = VNOVOL;
3253         forcefree = 1;
3254         goto error;
3255     }
3256
3257     vp->vnodeIndex[vSmall].bitmap = vp->vnodeIndex[vLarge].bitmap = NULL;
3258 #ifndef BITMAP_LATER
3259     if (programType == fileServer && VolumeWriteable(vp)) {
3260         int i;
3261         for (i = 0; i < nVNODECLASSES; i++) {
3262             VGetBitmap_r(ec, vp, i);
3263             if (*ec) {
3264 #ifdef AFS_DEMAND_ATTACH_FS
3265                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
3266                 vp->nUsers = 0;
3267 #endif /* AFS_DEMAND_ATTACH_FS */
3268                 Log("VAttachVolume: error getting bitmap for volume (%s)\n",
3269                     path);
3270                 goto error;
3271             }
3272         }
3273     }
3274 #endif /* BITMAP_LATER */
3275
3276     if (VInit >= 2 && V_needsCallback(vp)) {
3277         if (V_BreakVolumeCallbacks) {
3278             Log("VAttachVolume: Volume %lu was changed externally; breaking callbacks\n",
3279                 afs_printable_uint32_lu(V_id(vp)));
3280             V_needsCallback(vp) = 0;
3281             VOL_UNLOCK;
3282             (*V_BreakVolumeCallbacks) (V_id(vp));
3283             VOL_LOCK;
3284
3285             VUpdateVolume_r(ec, vp, 0);
3286         }
3287 #ifdef FSSYNC_BUILD_CLIENT
3288         else if (VCanUseFSSYNC()) {
3289             afs_int32 fsync_code;
3290
3291             V_needsCallback(vp) = 0;
3292             VOL_UNLOCK;
3293             fsync_code = FSYNC_VolOp(V_id(vp), NULL, FSYNC_VOL_BREAKCBKS, FSYNC_WHATEVER, NULL);
3294             VOL_LOCK;
3295
3296             if (fsync_code) {
3297                 V_needsCallback(vp) = 1;
3298                 Log("Error trying to tell the fileserver to break callbacks for "
3299                     "changed volume %lu; error code %ld\n",
3300                     afs_printable_uint32_lu(V_id(vp)),
3301                     afs_printable_int32_ld(fsync_code));
3302             } else {
3303                 VUpdateVolume_r(ec, vp, 0);
3304             }
3305         }
3306 #endif /* FSSYNC_BUILD_CLIENT */
3307
3308         if (*ec) {
3309             Log("VAttachVolume: error %d clearing needsCallback on volume "
3310                 "%lu; needs salvage\n", (int)*ec,
3311                 afs_printable_uint32_lu(V_id(vp)));
3312 #ifdef AFS_DEMAND_ATTACH_FS
3313             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
3314             vp->nUsers = 0;
3315 #else /* !AFS_DEMAND_ATTACH_FS */
3316             *ec = VSALVAGE;
3317 #endif /* !AFS_DEMAND_ATTACh_FS */
3318             goto error;
3319         }
3320     }
3321
3322     if (programType == fileServer) {
3323         if (vp->specialStatus)
3324             vp->specialStatus = 0;
3325         if (V_blessed(vp) && V_inService(vp) && !V_needsSalvaged(vp)) {
3326             V_inUse(vp) = fileServer;
3327             V_offlineMessage(vp)[0] = '\0';
3328         }
3329     } else {
3330 #ifdef AFS_DEMAND_ATTACH_FS
3331         if ((mode != V_PEEK) && (mode != V_SECRETLY))
3332             V_inUse(vp) = programType;
3333 #endif /* AFS_DEMAND_ATTACH_FS */
3334         V_checkoutMode(vp) = mode;
3335     }
3336
3337     AddVolumeToHashTable(vp, V_id(vp));
3338 #ifdef AFS_DEMAND_ATTACH_FS
3339     if (VCanUnlockAttached() && (V_attachFlags(vp) & VOL_LOCKED)) {
3340         VUnlockVolume(vp);
3341     }
3342     if ((programType != fileServer) ||
3343         (V_inUse(vp) == fileServer)) {
3344         AddVolumeToVByPList_r(vp);
3345         VLRU_Add_r(vp);
3346         VChangeState_r(vp, VOL_STATE_ATTACHED);
3347     } else {
3348         VChangeState_r(vp, VOL_STATE_UNATTACHED);
3349     }
3350 #endif
3351
3352     return vp;
3353
3354  error:
3355 #ifdef AFS_DEMAND_ATTACH_FS
3356     if (!VIsErrorState(V_attachState(vp))) {
3357         VChangeState_r(vp, VOL_STATE_ERROR);
3358     }
3359 #endif /* AFS_DEMAND_ATTACH_FS */
3360
3361     if (read_header) {
3362         VReleaseVolumeHandles_r(vp);
3363     }
3364
3365 #ifdef AFS_DEMAND_ATTACH_FS
3366     VCheckSalvage(vp);
3367     if (forcefree) {
3368         FreeVolume(vp);
3369     } else {
3370         VCheckFree(vp);
3371     }
3372 #else /* !AFS_DEMAND_ATTACH_FS */
3373     FreeVolume(vp);
3374 #endif /* !AFS_DEMAND_ATTACH_FS */
3375     return NULL;
3376 }
3377
3378 /* Attach an existing volume.
3379    The volume also normally goes online at this time.
3380    An offline volume must be reattached to make it go online.
3381  */
3382
3383 Volume *
3384 VAttachVolume(Error * ec, VolumeId volumeId, int mode)
3385 {
3386     Volume *retVal;
3387     VOL_LOCK;
3388     retVal = VAttachVolume_r(ec, volumeId, mode);
3389     VOL_UNLOCK;
3390     return retVal;
3391 }
3392
3393 Volume *
3394 VAttachVolume_r(Error * ec, VolumeId volumeId, int mode)
3395 {
3396     char *part, *name;
3397     VGetVolumePath(ec, volumeId, &part, &name);
3398     if (*ec) {
3399         register Volume *vp;
3400         Error error;
3401         vp = VGetVolume_r(&error, volumeId);
3402         if (vp) {
3403             assert(V_inUse(vp) == 0);
3404             VDetachVolume_r(ec, vp);
3405         }
3406         return NULL;
3407     }
3408     return VAttachVolumeByName_r(ec, part, name, mode);
3409 }
3410
3411 /* Increment a reference count to a volume, sans context swaps.  Requires
3412  * possibly reading the volume header in from the disk, since there's
3413  * an invariant in the volume package that nUsers>0 ==> vp->header is valid.
3414  *
3415  * N.B. This call can fail if we can't read in the header!!  In this case
3416  * we still guarantee we won't context swap, but the ref count won't be
3417  * incremented (otherwise we'd violate the invariant).
3418  */
3419 /* NOTE: with the demand attach fileserver extensions, the global lock
3420  * is dropped within VHold */
3421 #ifdef AFS_DEMAND_ATTACH_FS
3422 static int
3423 VHold_r(register Volume * vp)
3424 {
3425     Error error;
3426
3427     VCreateReservation_r(vp);
3428     VWaitExclusiveState_r(vp);
3429
3430     LoadVolumeHeader(&error, vp);
3431     if (error) {
3432         VCancelReservation_r(vp);
3433         return error;
3434     }
3435     vp->nUsers++;
3436     VCancelReservation_r(vp);
3437     return 0;
3438 }
3439 #else /* AFS_DEMAND_ATTACH_FS */
3440 static int
3441 VHold_r(register Volume * vp)
3442 {
3443     Error error;
3444
3445     LoadVolumeHeader(&error, vp);
3446     if (error)
3447         return error;
3448     vp->nUsers++;
3449     return 0;
3450 }
3451 #endif /* AFS_DEMAND_ATTACH_FS */
3452
3453 #if 0
3454 static int
3455 VHold(register Volume * vp)
3456 {
3457     int retVal;
3458     VOL_LOCK;
3459     retVal = VHold_r(vp);
3460     VOL_UNLOCK;
3461     return retVal;
3462 }
3463 #endif
3464
3465
3466 /***************************************************/
3467 /* get and put volume routines                     */
3468 /***************************************************/
3469
3470 /**
3471  * put back a heavyweight reference to a volume object.
3472  *
3473  * @param[in] vp  volume object pointer
3474  *
3475  * @pre VOL_LOCK held
3476  *
3477  * @post heavyweight volume reference put back.
3478  *       depending on state, volume may have been taken offline,
3479  *       detached, salvaged, freed, etc.
3480  *
3481  * @internal volume package internal use only
3482  */
3483 void
3484 VPutVolume_r(register Volume * vp)
3485 {
3486     assert(--vp->nUsers >= 0);
3487     if (vp->nUsers == 0) {
3488         VCheckOffline(vp);
3489         ReleaseVolumeHeader(vp->header);
3490 #ifdef AFS_DEMAND_ATTACH_FS
3491         if (!VCheckDetach(vp)) {
3492             VCheckSalvage(vp);
3493             VCheckFree(vp);
3494         }
3495 #else /* AFS_DEMAND_ATTACH_FS */
3496         VCheckDetach(vp);
3497 #endif /* AFS_DEMAND_ATTACH_FS */
3498     }
3499 }
3500
3501 void
3502 VPutVolume(register Volume * vp)
3503 {
3504     VOL_LOCK;
3505     VPutVolume_r(vp);
3506     VOL_UNLOCK;
3507 }
3508
3509
3510 /* Get a pointer to an attached volume.  The pointer is returned regardless
3511    of whether or not the volume is in service or on/off line.  An error
3512    code, however, is returned with an indication of the volume's status */
3513 Volume *
3514 VGetVolume(Error * ec, Error * client_ec, VolId volumeId)
3515 {
3516     Volume *retVal;
3517     VOL_LOCK;
3518     retVal = GetVolume(ec, client_ec, volumeId, NULL, 0);
3519     VOL_UNLOCK;
3520     return retVal;
3521 }
3522
3523 /* same as VGetVolume, but if a volume is waiting to go offline, we return
3524  * that it is actually offline, instead of waiting for it to go offline */
3525 Volume *
3526 VGetVolumeNoWait(Error * ec, Error * client_ec, VolId volumeId)
3527 {
3528     Volume *retVal;
3529     VOL_LOCK;
3530     retVal = GetVolume(ec, client_ec, volumeId, NULL, 1);
3531     VOL_UNLOCK;
3532     return retVal;
3533 }
3534
3535 Volume *
3536 VGetVolume_r(Error * ec, VolId volumeId)
3537 {
3538     return GetVolume(ec, NULL, volumeId, NULL, 0);
3539 }
3540
3541 /* try to get a volume we've previously looked up */
3542 /* for demand attach fs, caller MUST NOT hold a ref count on vp */
3543 Volume *
3544 VGetVolumeByVp_r(Error * ec, Volume * vp)
3545 {
3546     return GetVolume(ec, NULL, vp->hashid, vp, 0);
3547 }
3548
3549 /**
3550  * private interface for getting a volume handle
3551  *
3552  * @param[out] ec         error code (0 if no error)
3553  * @param[out] client_ec  wire error code to be given to clients
3554  * @param[in]  volumeId   ID of the volume we want
3555  * @param[in]  hint       optional hint for hash lookups, or NULL
3556  * @param[in]  nowait     0 to wait for a 'goingOffline' volume to go offline
3557  *                        before returning, 1 to return immediately
3558  *
3559  * @return a volume handle for the specified volume
3560  *  @retval NULL an error occurred, or the volume is in such a state that
3561  *               we cannot load a header or return any volume struct
3562  *
3563  * @note for DAFS, caller must NOT hold a ref count on 'hint'
3564  */
3565 static Volume *
3566 GetVolume(Error * ec, Error * client_ec, VolId volumeId, Volume * hint, int nowait)
3567 {
3568     Volume *vp = hint;
3569     /* pull this profiling/debugging code out of regular builds */
3570 #ifdef notdef
3571 #define VGET_CTR_INC(x) x++
3572     unsigned short V0 = 0, V1 = 0, V2 = 0, V3 = 0, V5 = 0, V6 =
3573         0, V7 = 0, V8 = 0, V9 = 0;
3574     unsigned short V10 = 0, V11 = 0, V12 = 0, V13 = 0, V14 = 0, V15 = 0;
3575 #else
3576 #define VGET_CTR_INC(x)
3577 #endif
3578 #ifdef AFS_DEMAND_ATTACH_FS
3579     Volume *avp, * rvp = hint;
3580 #endif
3581
3582     /*
3583      * if VInit is zero, the volume package dynamic
3584      * data structures have not been initialized yet,
3585      * and we must immediately return an error
3586      */
3587     if (VInit == 0) {
3588         vp = NULL;
3589         *ec = VOFFLINE;
3590         if (client_ec) {
3591             *client_ec = VOFFLINE;
3592         }
3593         goto not_inited;
3594     }
3595
3596 #ifdef AFS_DEMAND_ATTACH_FS
3597     if (rvp) {
3598         VCreateReservation_r(rvp);
3599     }
3600 #endif /* AFS_DEMAND_ATTACH_FS */
3601
3602     for (;;) {
3603         *ec = 0;
3604         if (client_ec)
3605             *client_ec = 0;
3606         VGET_CTR_INC(V0);
3607
3608         vp = VLookupVolume_r(ec, volumeId, vp);
3609         if (*ec) {
3610             vp = NULL;
3611             break;
3612         }
3613
3614 #ifdef AFS_DEMAND_ATTACH_FS
3615         if (rvp && (rvp != vp)) {
3616             /* break reservation on old vp */
3617             VCancelReservation_r(rvp);
3618             rvp = NULL;
3619         }
3620 #endif /* AFS_DEMAND_ATTACH_FS */
3621
3622         if (!vp) {
3623             VGET_CTR_INC(V1);
3624             if (VInit < 2) {
3625                 VGET_CTR_INC(V2);
3626                 /* Until we have reached an initialization level of 2
3627                  * we don't know whether this volume exists or not.
3628                  * We can't sleep and retry later because before a volume
3629                  * is attached, the caller tries to get it first.  Just
3630                  * return VOFFLINE and the caller can choose whether to
3631                  * retry the command or not. */
3632                 *ec = VOFFLINE;
3633                 break;
3634             }
3635
3636             *ec = VNOVOL;
3637             break;
3638         }
3639
3640         VGET_CTR_INC(V3);
3641         IncUInt64(&VStats.hdr_gets);
3642
3643 #ifdef AFS_DEMAND_ATTACH_FS
3644         /* block if someone else is performing an exclusive op on this volume */
3645         if (rvp != vp) {
3646             rvp = vp;
3647             VCreateReservation_r(rvp);
3648         }
3649         VWaitExclusiveState_r(vp);
3650
3651         /* short circuit with VNOVOL in the following circumstances:
3652          *
3653          *   - VOL_STATE_ERROR
3654          *   - VOL_STATE_SHUTTING_DOWN
3655          */
3656         if ((V_attachState(vp) == VOL_STATE_ERROR) ||
3657             (V_attachState(vp) == VOL_STATE_SHUTTING_DOWN) ||
3658             (V_attachState(vp) == VOL_STATE_GOING_OFFLINE)) {
3659             *ec = VNOVOL;
3660             vp = NULL;
3661             break;
3662         }
3663
3664         /*
3665          * short circuit with VOFFLINE in the following circumstances:
3666          *
3667          *   - VOL_STATE_UNATTACHED
3668          */
3669        if (V_attachState(vp) == VOL_STATE_UNATTACHED) {
3670            if (vp->specialStatus) {
3671                *ec = vp->specialStatus;
3672            } else {
3673                *ec = VOFFLINE;
3674            }
3675            vp = NULL;
3676            break;
3677        }
3678
3679         /* allowable states:
3680          *   - PREATTACHED
3681          *   - ATTACHED
3682          *   - SALVAGING
3683          */
3684
3685         if (vp->salvage.requested) {
3686             VUpdateSalvagePriority_r(vp);
3687         }
3688
3689         if (V_attachState(vp) == VOL_STATE_PREATTACHED) {
3690             avp = VAttachVolumeByVp_r(ec, vp, 0);
3691             if (avp) {
3692                 if (vp != avp) {
3693                     /* VAttachVolumeByVp_r can return a pointer
3694                      * != the vp passed to it under certain
3695                      * conditions; make sure we don't leak
3696                      * reservations if that happens */
3697                     vp = avp;
3698                     VCancelReservation_r(rvp);
3699                     rvp = avp;
3700                     VCreateReservation_r(rvp);
3701                 }
3702                 VPutVolume_r(avp);
3703             }
3704             if (*ec) {
3705                 int endloop = 0;
3706                 switch (*ec) {
3707                 case VSALVAGING:
3708                     break;
3709                 case VOFFLINE:
3710                     if (!vp->pending_vol_op) {
3711                         endloop = 1;
3712                     }
3713                     break;
3714                 default:
3715                     *ec = VNOVOL;
3716                     endloop = 1;
3717                 }
3718                 if (endloop) {
3719                     vp = NULL;
3720                     break;
3721                 }
3722             }
3723         }
3724
3725         if ((V_attachState(vp) == VOL_STATE_SALVAGING) ||
3726             (*ec == VSALVAGING)) {
3727             if (client_ec) {
3728                 /* see CheckVnode() in afsfileprocs.c for an explanation
3729                  * of this error code logic */
3730                 afs_uint32 now = FT_ApproxTime();
3731                 if ((vp->stats.last_salvage + (10 * 60)) >= now) {
3732                     *client_ec = VBUSY;
3733                 } else {
3734                     *client_ec = VRESTARTING;
3735                 }
3736             }
3737             *ec = VSALVAGING;
3738             vp = NULL;
3739             break;
3740         }
3741 #endif
3742
3743 #ifdef AFS_DEMAND_ATTACH_FS
3744         /*
3745          * this test MUST happen after VAttachVolymeByVp, so vol_op_state is
3746          * not VolOpRunningUnknown (attach2 would have converted it to Online
3747          * or Offline)
3748          */
3749
3750          /* only valid before/during demand attachment */
3751          assert(!vp->pending_vol_op || vp->pending_vol_op->vol_op_state != FSSYNC_VolOpRunningUnknown);
3752
3753          /* deny getvolume due to running mutually exclusive vol op */
3754          if (vp->pending_vol_op && vp->pending_vol_op->vol_op_state==FSSYNC_VolOpRunningOffline) {
3755            /*
3756             * volume cannot remain online during this volume operation.
3757             * notify client.
3758             */
3759            if (vp->specialStatus) {
3760                /*
3761                 * special status codes outrank normal VOFFLINE code
3762                 */
3763                *ec = vp->specialStatus;
3764                if (client_ec) {
3765                    *client_ec = vp->specialStatus;
3766                }
3767            } else {
3768                if (client_ec) {
3769                    /* see CheckVnode() in afsfileprocs.c for an explanation
3770                     * of this error code logic */
3771                    afs_uint32 now = FT_ApproxTime();
3772                    if ((vp->stats.last_vol_op + (10 * 60)) >= now) {
3773                        *client_ec = VBUSY;
3774                    } else {
3775                        *client_ec = VRESTARTING;
3776                    }
3777                }
3778                *ec = VOFFLINE;
3779            }
3780            VChangeState_r(vp, VOL_STATE_UNATTACHED);
3781            FreeVolumeHeader(vp);
3782            vp = NULL;
3783            break;
3784         }
3785 #endif /* AFS_DEMAND_ATTACH_FS */
3786
3787         LoadVolumeHeader(ec, vp);
3788         if (*ec) {
3789             VGET_CTR_INC(V6);
3790             /* Only log the error if it was a totally unexpected error.  Simply
3791              * a missing inode is likely to be caused by the volume being deleted */
3792             if (errno != ENXIO || LogLevel)
3793                 Log("Volume %u: couldn't reread volume header\n",
3794                     vp->hashid);
3795 #ifdef AFS_DEMAND_ATTACH_FS
3796             if (VCanScheduleSalvage()) {
3797                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
3798             } else {
3799                 FreeVolume(vp);
3800                 vp = NULL;
3801             }
3802 #else /* AFS_DEMAND_ATTACH_FS */
3803             FreeVolume(vp);
3804             vp = NULL;
3805 #endif /* AFS_DEMAND_ATTACH_FS */
3806             break;
3807         }
3808
3809         VGET_CTR_INC(V7);
3810         if (vp->shuttingDown) {
3811             VGET_CTR_INC(V8);
3812             *ec = VNOVOL;
3813             vp = NULL;
3814             break;
3815         }
3816
3817         if (programType == fileServer) {
3818             VGET_CTR_INC(V9);
3819             if (vp->goingOffline && !nowait) {
3820                 VGET_CTR_INC(V10);
3821 #ifdef AFS_DEMAND_ATTACH_FS
3822                 /* wait for the volume to go offline */
3823                 if (V_attachState(vp) == VOL_STATE_GOING_OFFLINE) {
3824                     VWaitStateChange_r(vp);
3825                 }
3826 #elif defined(AFS_PTHREAD_ENV)
3827                 VOL_CV_WAIT(&vol_put_volume_cond);
3828 #else /* AFS_PTHREAD_ENV */
3829                 LWP_WaitProcess(VPutVolume);
3830 #endif /* AFS_PTHREAD_ENV */
3831                 continue;
3832             }
3833             if (vp->specialStatus) {
3834                 VGET_CTR_INC(V11);
3835                 *ec = vp->specialStatus;
3836             } else if (V_inService(vp) == 0 || V_blessed(vp) == 0) {
3837                 VGET_CTR_INC(V12);
3838                 *ec = VNOVOL;
3839             } else if (V_inUse(vp) == 0 || vp->goingOffline) {
3840                 VGET_CTR_INC(V13);
3841                 *ec = VOFFLINE;
3842             } else {
3843                 VGET_CTR_INC(V14);
3844             }
3845         }
3846         break;
3847     }
3848     VGET_CTR_INC(V15);
3849
3850 #ifdef AFS_DEMAND_ATTACH_FS
3851     /* if no error, bump nUsers */
3852     if (vp) {
3853         vp->nUsers++;
3854         VLRU_UpdateAccess_r(vp);
3855     }
3856     if (rvp) {
3857         VCancelReservation_r(rvp);
3858         rvp = NULL;
3859     }
3860     if (client_ec && !*client_ec) {
3861         *client_ec = *ec;
3862     }
3863 #else /* AFS_DEMAND_ATTACH_FS */
3864     /* if no error, bump nUsers */
3865     if (vp) {
3866         vp->nUsers++;
3867     }
3868     if (client_ec) {
3869         *client_ec = *ec;
3870     }
3871 #endif /* AFS_DEMAND_ATTACH_FS */
3872
3873  not_inited:
3874     assert(vp || *ec);
3875     return vp;
3876 }
3877
3878
3879 /***************************************************/
3880 /* Volume offline/detach routines                  */
3881 /***************************************************/
3882
3883 /* caller MUST hold a heavyweight ref on vp */
3884 #ifdef AFS_DEMAND_ATTACH_FS
3885 void
3886 VTakeOffline_r(register Volume * vp)
3887 {
3888     Error error;
3889
3890     assert(vp->nUsers > 0);
3891     assert(programType == fileServer);
3892
3893     VCreateReservation_r(vp);
3894     VWaitExclusiveState_r(vp);
3895
3896     vp->goingOffline = 1;
3897     V_needsSalvaged(vp) = 1;
3898
3899     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0);
3900     VCancelReservation_r(vp);
3901 }
3902 #else /* AFS_DEMAND_ATTACH_FS */
3903 void
3904 VTakeOffline_r(register Volume * vp)
3905 {
3906     assert(vp->nUsers > 0);
3907     assert(programType == fileServer);
3908
3909     vp->goingOffline = 1;
3910     V_needsSalvaged(vp) = 1;
3911 }
3912 #endif /* AFS_DEMAND_ATTACH_FS */
3913
3914 void
3915 VTakeOffline(register Volume * vp)
3916 {
3917     VOL_LOCK;
3918     VTakeOffline_r(vp);
3919     VOL_UNLOCK;
3920 }
3921
3922 /**
3923  * force a volume offline.
3924  *
3925  * @param[in] vp     volume object pointer
3926  * @param[in] flags  flags (see note below)
3927  *
3928  * @note the flag VOL_FORCEOFF_NOUPDATE is a recursion control flag
3929  *       used when VUpdateVolume_r needs to call VForceOffline_r
3930  *       (which in turn would normally call VUpdateVolume_r)
3931  *
3932  * @see VUpdateVolume_r
3933  *
3934  * @pre VOL_LOCK must be held.
3935  *      for DAFS, caller must hold ref.
3936  *
3937  * @note for DAFS, it _is safe_ to call this function from an
3938  *       exclusive state
3939  *
3940  * @post needsSalvaged flag is set.
3941  *       for DAFS, salvage is requested.
3942  *       no further references to the volume through the volume
3943  *       package will be honored.
3944  *       all file descriptor and vnode caches are invalidated.
3945  *
3946  * @warning this is a heavy-handed interface.  it results in
3947  *          a volume going offline regardless of the current
3948  *          reference count state.
3949  *
3950  * @internal  volume package internal use only
3951  */
3952 void
3953 VForceOffline_r(Volume * vp, int flags)
3954 {
3955     Error error;
3956     if (!V_inUse(vp)) {
3957 #ifdef AFS_DEMAND_ATTACH_FS
3958         VChangeState_r(vp, VOL_STATE_ERROR);
3959 #endif
3960         return;
3961     }
3962
3963     strcpy(V_offlineMessage(vp),
3964            "Forced offline due to internal error: volume needs to be salvaged");
3965     Log("Volume %u forced offline:  it needs salvaging!\n", V_id(vp));
3966
3967     V_inUse(vp) = 0;
3968     vp->goingOffline = 0;
3969     V_needsSalvaged(vp) = 1;
3970     if (!(flags & VOL_FORCEOFF_NOUPDATE)) {
3971         VUpdateVolume_r(&error, vp, VOL_UPDATE_NOFORCEOFF);
3972     }
3973
3974 #ifdef AFS_DEMAND_ATTACH_FS
3975     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
3976 #endif /* AFS_DEMAND_ATTACH_FS */
3977
3978 #ifdef AFS_PTHREAD_ENV
3979     assert(pthread_cond_broadcast(&vol_put_volume_cond) == 0);
3980 #else /* AFS_PTHREAD_ENV */
3981     LWP_NoYieldSignal(VPutVolume);
3982 #endif /* AFS_PTHREAD_ENV */
3983
3984     VReleaseVolumeHandles_r(vp);
3985 }
3986
3987 /**
3988  * force a volume offline.
3989  *
3990  * @param[in] vp  volume object pointer
3991  *
3992  * @see VForceOffline_r
3993  */
3994 void
3995 VForceOffline(Volume * vp)
3996 {
3997     VOL_LOCK;
3998     VForceOffline_r(vp, 0);
3999     VOL_UNLOCK;
4000 }
4001
4002 /* The opposite of VAttachVolume.  The volume header is written to disk, with
4003    the inUse bit turned off.  A copy of the header is maintained in memory,
4004    however (which is why this is VOffline, not VDetach).
4005  */
4006 void
4007 VOffline_r(Volume * vp, char *message)
4008 {
4009 #ifndef AFS_DEMAND_ATTACH_FS
4010     Error error;
4011     VolumeId vid = V_id(vp);
4012 #endif
4013
4014     assert(programType != volumeUtility && programType != volumeServer);
4015     if (!V_inUse(vp)) {
4016         VPutVolume_r(vp);
4017         return;
4018     }
4019     if (V_offlineMessage(vp)[0] == '\0')
4020         strncpy(V_offlineMessage(vp), message, sizeof(V_offlineMessage(vp)));
4021     V_offlineMessage(vp)[sizeof(V_offlineMessage(vp)) - 1] = '\0';
4022
4023     vp->goingOffline = 1;
4024 #ifdef AFS_DEMAND_ATTACH_FS
4025     VChangeState_r(vp, VOL_STATE_GOING_OFFLINE);
4026     VCreateReservation_r(vp);
4027     VPutVolume_r(vp);
4028
4029     /* wait for the volume to go offline */
4030     if (V_attachState(vp) == VOL_STATE_GOING_OFFLINE) {
4031         VWaitStateChange_r(vp);
4032     }
4033     VCancelReservation_r(vp);
4034 #else /* AFS_DEMAND_ATTACH_FS */
4035     VPutVolume_r(vp);
4036     vp = VGetVolume_r(&error, vid);     /* Wait for it to go offline */
4037     if (vp)                     /* In case it was reattached... */
4038         VPutVolume_r(vp);
4039 #endif /* AFS_DEMAND_ATTACH_FS */
4040 }
4041
4042 #ifdef AFS_DEMAND_ATTACH_FS
4043 /**
4044  * Take a volume offline in order to perform a volume operation.
4045  *
4046  * @param[inout] ec       address in which to store error code
4047  * @param[in]    vp       volume object pointer
4048  * @param[in]    message  volume offline status message
4049  *
4050  * @pre
4051  *    - VOL_LOCK is held
4052  *    - caller MUST hold a heavyweight ref on vp
4053  *
4054  * @post
4055  *    - volume is taken offline
4056  *    - if possible, volume operation is promoted to running state
4057  *    - on failure, *ec is set to nonzero
4058  *
4059  * @note Although this function does not return any value, it may
4060  *       still fail to promote our pending volume operation to
4061  *       a running state.  Any caller MUST check the value of *ec,
4062  *       and MUST NOT blindly assume success.
4063  *
4064  * @warning if the caller does not hold a lightweight ref on vp,
4065  *          then it MUST NOT reference vp after this function
4066  *          returns to the caller.
4067  *
4068  * @internal volume package internal use only
4069  */
4070 void
4071 VOfflineForVolOp_r(Error *ec, Volume *vp, char *message)
4072 {
4073     assert(vp->pending_vol_op);
4074     if (!V_inUse(vp)) {
4075         VPutVolume_r(vp);
4076         *ec = 1;
4077         return;
4078     }
4079     if (V_offlineMessage(vp)[0] == '\0')
4080         strncpy(V_offlineMessage(vp), message, sizeof(V_offlineMessage(vp)));
4081     V_offlineMessage(vp)[sizeof(V_offlineMessage(vp)) - 1] = '\0';
4082
4083     vp->goingOffline = 1;
4084     VChangeState_r(vp, VOL_STATE_GOING_OFFLINE);
4085     VCreateReservation_r(vp);
4086     VPutVolume_r(vp);
4087
4088     /* Wait for the volume to go offline */
4089     while (!VIsOfflineState(V_attachState(vp))) {
4090         /* do not give corrupted volumes to the volserver */
4091         if (vp->salvage.requested && vp->pending_vol_op->com.programType != salvageServer) {
4092            *ec = 1;
4093            goto error;
4094         }
4095         VWaitStateChange_r(vp);
4096     }
4097     *ec = 0;
4098  error:
4099     VCancelReservation_r(vp);
4100 }
4101 #endif /* AFS_DEMAND_ATTACH_FS */
4102
4103 void
4104 VOffline(Volume * vp, char *message)
4105 {
4106     VOL_LOCK;
4107     VOffline_r(vp, message);
4108     VOL_UNLOCK;
4109 }
4110
4111 /* This gets used for the most part by utility routines that don't want
4112  * to keep all the volume headers around.  Generally, the file server won't
4113  * call this routine, because then the offline message in the volume header
4114  * (or other information) won't be available to clients. For NAMEI, also
4115  * close the file handles.  However, the fileserver does call this during
4116  * an attach following a volume operation.
4117  */
4118 void
4119 VDetachVolume_r(Error * ec, Volume * vp)
4120 {
4121     VolumeId volume;
4122     struct DiskPartition64 *tpartp;
4123     int notifyServer = 0;
4124     int  useDone = FSYNC_VOL_ON;
4125
4126     *ec = 0;                    /* always "succeeds" */
4127     if (VCanUseFSSYNC()) {
4128         notifyServer = vp->needsPutBack;
4129         if (V_destroyMe(vp) == DESTROY_ME)
4130             useDone = FSYNC_VOL_DONE;
4131 #ifdef AFS_DEMAND_ATTACH_FS
4132         else if (!V_blessed(vp) || !V_inService(vp))
4133             useDone = FSYNC_VOL_LEAVE_OFF;
4134 #endif
4135     }
4136     tpartp = vp->partition;
4137     volume = V_id(vp);
4138     DeleteVolumeFromHashTable(vp);
4139     vp->shuttingDown = 1;
4140 #ifdef AFS_DEMAND_ATTACH_FS
4141     DeleteVolumeFromVByPList_r(vp);
4142     VLRU_Delete_r(vp);
4143     VChangeState_r(vp, VOL_STATE_SHUTTING_DOWN);
4144 #else
4145     if (programType != fileServer)
4146         V_inUse(vp) = 0;
4147 #endif /* AFS_DEMAND_ATTACH_FS */
4148     VPutVolume_r(vp);
4149     /* Will be detached sometime in the future--this is OK since volume is offline */
4150
4151     /* XXX the following code should really be moved to VCheckDetach() since the volume
4152      * is not technically detached until the refcounts reach zero
4153      */
4154 #ifdef FSSYNC_BUILD_CLIENT
4155     if (VCanUseFSSYNC() && notifyServer) {
4156         /*
4157          * Note:  The server is not notified in the case of a bogus volume
4158          * explicitly to make it possible to create a volume, do a partial
4159          * restore, then abort the operation without ever putting the volume
4160          * online.  This is essential in the case of a volume move operation
4161          * between two partitions on the same server.  In that case, there
4162          * would be two instances of the same volume, one of them bogus,
4163          * which the file server would attempt to put on line
4164          */
4165         FSYNC_VolOp(volume, tpartp->name, useDone, 0, NULL);
4166         /* XXX this code path is only hit by volume utilities, thus
4167          * V_BreakVolumeCallbacks will always be NULL.  if we really
4168          * want to break callbacks in this path we need to use FSYNC_VolOp() */
4169 #ifdef notdef
4170         /* Dettaching it so break all callbacks on it */
4171         if (V_BreakVolumeCallbacks) {
4172             Log("volume %u detached; breaking all call backs\n", volume);
4173             (*V_BreakVolumeCallbacks) (volume);
4174         }
4175 #endif
4176     }
4177 #endif /* FSSYNC_BUILD_CLIENT */
4178 }
4179
4180 void
4181 VDetachVolume(Error * ec, Volume * vp)
4182 {
4183     VOL_LOCK;
4184     VDetachVolume_r(ec, vp);
4185     VOL_UNLOCK;
4186 }
4187
4188
4189 /***************************************************/
4190 /* Volume fd/inode handle closing routines         */
4191 /***************************************************/
4192
4193 /* For VDetachVolume, we close all cached file descriptors, but keep
4194  * the Inode handles in case we need to read from a busy volume.
4195  */
4196 /* for demand attach, caller MUST hold ref count on vp */
4197 static void
4198 VCloseVolumeHandles_r(Volume * vp)
4199 {
4200 #ifdef AFS_DEMAND_ATTACH_FS
4201     VolState state_save;
4202
4203     state_save = VChangeState_r(vp, VOL_STATE_OFFLINING);
4204 #endif
4205
4206     /* demand attach fs
4207      *
4208      * XXX need to investigate whether we can perform
4209      * DFlushVolume outside of vol_glock_mutex...
4210      *
4211      * VCloseVnodeFiles_r drops the glock internally */
4212     DFlushVolume(vp->hashid);
4213     VCloseVnodeFiles_r(vp);
4214
4215 #ifdef AFS_DEMAND_ATTACH_FS
4216     VOL_UNLOCK;
4217 #endif
4218
4219     /* Too time consuming and unnecessary for the volserver */
4220     if (programType == fileServer) {
4221         IH_CONDSYNC(vp->vnodeIndex[vLarge].handle);
4222         IH_CONDSYNC(vp->vnodeIndex[vSmall].handle);
4223         IH_CONDSYNC(vp->diskDataHandle);
4224 #ifdef AFS_NT40_ENV
4225         IH_CONDSYNC(vp->linkHandle);
4226 #endif /* AFS_NT40_ENV */
4227     }
4228
4229     IH_REALLYCLOSE(vp->vnodeIndex[vLarge].handle);
4230     IH_REALLYCLOSE(vp->vnodeIndex[vSmall].handle);
4231     IH_REALLYCLOSE(vp->diskDataHandle);
4232     IH_REALLYCLOSE(vp->linkHandle);
4233
4234 #ifdef AFS_DEMAND_ATTACH_FS
4235     if ((V_attachFlags(vp) & VOL_LOCKED)) {
4236         VUnlockVolume(vp);
4237     }
4238
4239     VOL_LOCK;
4240     VChangeState_r(vp, state_save);
4241 #endif
4242 }
4243
4244 /* For both VForceOffline and VOffline, we close all relevant handles.
4245  * For VOffline, if we re-attach the volume, the files may possible be
4246  * different than before.
4247  */
4248 /* for demand attach, caller MUST hold a ref count on vp */
4249 static void
4250 VReleaseVolumeHandles_r(Volume * vp)
4251 {
4252 #ifdef AFS_DEMAND_ATTACH_FS
4253     VolState state_save;
4254
4255     state_save = VChangeState_r(vp, VOL_STATE_DETACHING);
4256 #endif
4257
4258     /* XXX need to investigate whether we can perform
4259      * DFlushVolume outside of vol_glock_mutex... */
4260     DFlushVolume(vp->hashid);
4261
4262     VReleaseVnodeFiles_r(vp); /* releases the glock internally */
4263
4264 #ifdef AFS_DEMAND_ATTACH_FS
4265     VOL_UNLOCK;
4266 #endif
4267
4268     /* Too time consuming and unnecessary for the volserver */
4269     if (programType == fileServer) {
4270         IH_CONDSYNC(vp->vnodeIndex[vLarge].handle);
4271         IH_CONDSYNC(vp->vnodeIndex[vSmall].handle);
4272         IH_CONDSYNC(vp->diskDataHandle);
4273 #ifdef AFS_NT40_ENV
4274         IH_CONDSYNC(vp->linkHandle);
4275 #endif /* AFS_NT40_ENV */
4276     }
4277
4278     IH_RELEASE(vp->vnodeIndex[vLarge].handle);
4279     IH_RELEASE(vp->vnodeIndex[vSmall].handle);
4280     IH_RELEASE(vp->diskDataHandle);
4281     IH_RELEASE(vp->linkHandle);
4282
4283 #ifdef AFS_DEMAND_ATTACH_FS
4284     if ((V_attachFlags(vp) & VOL_LOCKED)) {
4285         VUnlockVolume(vp);
4286     }
4287
4288     VOL_LOCK;
4289     VChangeState_r(vp, state_save);
4290 #endif
4291 }
4292
4293
4294 /***************************************************/
4295 /* Volume write and fsync routines                 */
4296 /***************************************************/
4297
4298 void
4299 VUpdateVolume_r(Error * ec, Volume * vp, int flags)
4300 {
4301 #ifdef AFS_DEMAND_ATTACH_FS
4302     VolState state_save;
4303
4304     if (flags & VOL_UPDATE_WAIT) {
4305         VCreateReservation_r(vp);
4306         VWaitExclusiveState_r(vp);
4307     }
4308 #endif
4309
4310     *ec = 0;
4311     if (programType == fileServer)
4312         V_uniquifier(vp) =
4313             (V_inUse(vp) ? V_nextVnodeUnique(vp) +
4314              200 : V_nextVnodeUnique(vp));
4315
4316 #ifdef AFS_DEMAND_ATTACH_FS
4317     state_save = VChangeState_r(vp, VOL_STATE_UPDATING);
4318     VOL_UNLOCK;
4319 #endif
4320
4321     WriteVolumeHeader_r(ec, vp);
4322
4323 #ifdef AFS_DEMAND_ATTACH_FS
4324     VOL_LOCK;
4325     VChangeState_r(vp, state_save);
4326     if (flags & VOL_UPDATE_WAIT) {
4327         VCancelReservation_r(vp);
4328     }
4329 #endif
4330
4331     if (*ec) {
4332         Log("VUpdateVolume: error updating volume header, volume %u (%s)\n",
4333             V_id(vp), V_name(vp));
4334         /* try to update on-disk header,
4335          * while preventing infinite recursion */
4336         if (!(flags & VOL_UPDATE_NOFORCEOFF)) {
4337             VForceOffline_r(vp, VOL_FORCEOFF_NOUPDATE);
4338         }
4339     }
4340 }
4341
4342 void
4343 VUpdateVolume(Error * ec, Volume * vp)
4344 {
4345     VOL_LOCK;
4346     VUpdateVolume_r(ec, vp, VOL_UPDATE_WAIT);
4347     VOL_UNLOCK;
4348 }
4349
4350 void
4351 VSyncVolume_r(Error * ec, Volume * vp, int flags)
4352 {
4353     FdHandle_t *fdP;
4354     int code;
4355 #ifdef AFS_DEMAND_ATTACH_FS
4356     VolState state_save;
4357 #endif
4358
4359     if (flags & VOL_SYNC_WAIT) {
4360         VUpdateVolume_r(ec, vp, VOL_UPDATE_WAIT);
4361     } else {
4362         VUpdateVolume_r(ec, vp, 0);
4363     }
4364     if (!*ec) {
4365 #ifdef AFS_DEMAND_ATTACH_FS
4366         state_save = VChangeState_r(vp, VOL_STATE_UPDATING);
4367         VOL_UNLOCK;
4368 #endif
4369         fdP = IH_OPEN(V_diskDataHandle(vp));
4370         assert(fdP != NULL);
4371         code = FDH_SYNC(fdP);
4372         assert(code == 0);
4373         FDH_CLOSE(fdP);
4374 #ifdef AFS_DEMAND_ATTACH_FS
4375         VOL_LOCK;
4376         VChangeState_r(vp, state_save);
4377 #endif
4378     }
4379 }
4380
4381 void
4382 VSyncVolume(Error * ec, Volume * vp)
4383 {
4384     VOL_LOCK;
4385     VSyncVolume_r(ec, vp, VOL_SYNC_WAIT);
4386     VOL_UNLOCK;
4387 }
4388
4389
4390 /***************************************************/
4391 /* Volume dealloaction routines                    */
4392 /***************************************************/
4393
4394 #ifdef AFS_DEMAND_ATTACH_FS
4395 static void
4396 FreeVolume(Volume * vp)
4397 {
4398     /* free the heap space, iff it's safe.
4399      * otherwise, pull it out of the hash table, so it
4400      * will get deallocated when all refs to it go away */
4401     if (!VCheckFree(vp)) {
4402         DeleteVolumeFromHashTable(vp);
4403         DeleteVolumeFromVByPList_r(vp);
4404
4405         /* make sure we invalidate the header cache entry */
4406         FreeVolumeHeader(vp);
4407     }
4408 }
4409 #endif /* AFS_DEMAND_ATTACH_FS */
4410
4411 static void
4412 ReallyFreeVolume(Volume * vp)
4413 {
4414     int i;
4415     if (!vp)
4416         return;
4417 #ifdef AFS_DEMAND_ATTACH_FS
4418     /* debug */
4419     VChangeState_r(vp, VOL_STATE_FREED);
4420     if (vp->pending_vol_op)
4421         free(vp->pending_vol_op);
4422 #endif /* AFS_DEMAND_ATTACH_FS */
4423     for (i = 0; i < nVNODECLASSES; i++)
4424         if (vp->vnodeIndex[i].bitmap)
4425             free(vp->vnodeIndex[i].bitmap);
4426     FreeVolumeHeader(vp);
4427 #ifndef AFS_DEMAND_ATTACH_FS
4428     DeleteVolumeFromHashTable(vp);
4429 #endif /* AFS_DEMAND_ATTACH_FS */
4430     free(vp);
4431 }
4432
4433 /* check to see if we should shutdown this volume
4434  * returns 1 if volume was freed, 0 otherwise */
4435 #ifdef AFS_DEMAND_ATTACH_FS
4436 static int
4437 VCheckDetach(register Volume * vp)
4438 {
4439     int ret = 0;
4440     Error ec = 0;
4441
4442     if (vp->nUsers || vp->nWaiters)
4443         return ret;
4444
4445     if (vp->shuttingDown) {
4446         ret = 1;
4447         if ((programType != fileServer) &&
4448             (V_inUse(vp) == programType) &&
4449             ((V_checkoutMode(vp) == V_VOLUPD) ||
4450              (V_checkoutMode(vp) == V_SECRETLY) ||
4451              ((V_checkoutMode(vp) == V_CLONE) &&
4452               (VolumeWriteable(vp))))) {
4453             V_inUse(vp) = 0;
4454             VUpdateVolume_r(&ec, vp, VOL_UPDATE_NOFORCEOFF);
4455             if (ec) {
4456                 Log("VCheckDetach: volume header update for volume %u "
4457                     "failed with errno %d\n", vp->hashid, errno);
4458             }
4459         }
4460         VReleaseVolumeHandles_r(vp);
4461         VCheckSalvage(vp);
4462         ReallyFreeVolume(vp);
4463         if (programType == fileServer) {
4464             assert(pthread_cond_broadcast(&vol_put_volume_cond) == 0);
4465         }
4466     }
4467     return ret;
4468 }
4469 #else /* AFS_DEMAND_ATTACH_FS */
4470 static int
4471 VCheckDetach(register Volume * vp)
4472 {
4473     int ret = 0;
4474     Error ec = 0;
4475
4476     if (vp->nUsers)
4477         return ret;
4478
4479     if (vp->shuttingDown) {
4480         ret = 1;
4481         if ((programType != fileServer) &&
4482             (V_inUse(vp) == programType) &&
4483             ((V_checkoutMode(vp) == V_VOLUPD) ||
4484              (V_checkoutMode(vp) == V_SECRETLY) ||
4485              ((V_checkoutMode(vp) == V_CLONE) &&
4486               (VolumeWriteable(vp))))) {
4487             V_inUse(vp) = 0;
4488             VUpdateVolume_r(&ec, vp, VOL_UPDATE_NOFORCEOFF);
4489             if (ec) {
4490                 Log("VCheckDetach: volume header update for volume %u failed with errno %d\n",
4491                     vp->hashid, errno);
4492             }
4493         }
4494         VReleaseVolumeHandles_r(vp);
4495         ReallyFreeVolume(vp);
4496         if (programType == fileServer) {
4497 #if defined(AFS_PTHREAD_ENV)
4498             assert(pthread_cond_broadcast(&vol_put_volume_cond) == 0);
4499 #else /* AFS_PTHREAD_ENV */
4500             LWP_NoYieldSignal(VPutVolume);
4501 #endif /* AFS_PTHREAD_ENV */
4502         }
4503     }
4504     return ret;
4505 }
4506 #endif /* AFS_DEMAND_ATTACH_FS */
4507
4508 /* check to see if we should offline this volume
4509  * return 1 if volume went offline, 0 otherwise */
4510 #ifdef AFS_DEMAND_ATTACH_FS
4511 static int
4512 VCheckOffline(register Volume * vp)
4513 {
4514     int ret = 0;
4515
4516     if (vp->goingOffline && !vp->nUsers) {
4517         Error error;
4518         assert(programType == fileServer);
4519         assert((V_attachState(vp) != VOL_STATE_ATTACHED) &&
4520                (V_attachState(vp) != VOL_STATE_FREED) &&
4521                (V_attachState(vp) != VOL_STATE_PREATTACHED) &&
4522                (V_attachState(vp) != VOL_STATE_UNATTACHED));
4523
4524         /* valid states:
4525          *
4526          * VOL_STATE_GOING_OFFLINE
4527          * VOL_STATE_SHUTTING_DOWN
4528          * VIsErrorState(V_attachState(vp))
4529          * VIsExclusiveState(V_attachState(vp))
4530          */
4531
4532         VCreateReservation_r(vp);
4533         VChangeState_r(vp, VOL_STATE_OFFLINING);
4534
4535         ret = 1;
4536         /* must clear the goingOffline flag before we drop the glock */
4537         vp->goingOffline = 0;
4538         V_inUse(vp) = 0;
4539
4540         VLRU_Delete_r(vp);
4541
4542         /* perform async operations */
4543         VUpdateVolume_r(&error, vp, 0);
4544         VCloseVolumeHandles_r(vp);
4545
4546         if (LogLevel) {
4547             if (V_offlineMessage(vp)[0]) {
4548                 Log("VOffline: Volume %lu (%s) is now offline (%s)\n",
4549                     afs_printable_uint32_lu(V_id(vp)), V_name(vp),
4550                     V_offlineMessage(vp));
4551             } else {
4552                 Log("VOffline: Volume %lu (%s) is now offline\n",
4553                     afs_printable_uint32_lu(V_id(vp)), V_name(vp));
4554             }
4555         }
4556
4557         /* invalidate the volume header cache entry */
4558         FreeVolumeHeader(vp);
4559
4560         /* if nothing changed state to error or salvaging,
4561          * drop state to unattached */
4562         if (!VIsErrorState(V_attachState(vp))) {
4563             VChangeState_r(vp, VOL_STATE_UNATTACHED);
4564         }
4565         VCancelReservation_r(vp);
4566         /* no usage of vp is safe beyond this point */
4567     }
4568     return ret;
4569 }
4570 #else /* AFS_DEMAND_ATTACH_FS */
4571 static int
4572 VCheckOffline(register Volume * vp)
4573 {
4574     int ret = 0;
4575
4576     if (vp->goingOffline && !vp->nUsers) {
4577         Error error;
4578         assert(programType == fileServer);
4579
4580         ret = 1;
4581         vp->goingOffline = 0;
4582         V_inUse(vp) = 0;
4583         VUpdateVolume_r(&error, vp, 0);
4584         VCloseVolumeHandles_r(vp);
4585         if (LogLevel) {
4586             Log("VOffline: Volume %u (%s) is now offline", V_id(vp),
4587                 V_name(vp));
4588             if (V_offlineMessage(vp)[0])
4589                 Log(" (%s)", V_offlineMessage(vp));
4590             Log("\n");
4591         }
4592         FreeVolumeHeader(vp);
4593 #ifdef AFS_PTHREAD_ENV
4594         assert(pthread_cond_broadcast(&vol_put_volume_cond) == 0);
4595 #else /* AFS_PTHREAD_ENV */
4596         LWP_NoYieldSignal(VPutVolume);
4597 #endif /* AFS_PTHREAD_ENV */
4598     }
4599     return ret;
4600 }
4601 #endif /* AFS_DEMAND_ATTACH_FS */
4602
4603 /***************************************************/
4604 /* demand attach fs ref counting routines          */
4605 /***************************************************/
4606
4607 #ifdef AFS_DEMAND_ATTACH_FS
4608 /* the following two functions handle reference counting for
4609  * asynchronous operations on volume structs.
4610  *
4611  * their purpose is to prevent a VDetachVolume or VShutdown
4612  * from free()ing the Volume struct during an async i/o op */
4613
4614 /* register with the async volume op ref counter */
4615 /* VCreateReservation_r moved into inline code header because it
4616  * is now needed in vnode.c -- tkeiser 11/20/2007
4617  */
4618
4619 /**
4620  * decrement volume-package internal refcount.
4621  *
4622  * @param vp  volume object pointer
4623  *
4624  * @internal volume package internal use only
4625  *
4626  * @pre
4627  *    @arg VOL_LOCK is held
4628  *    @arg lightweight refcount held
4629  *
4630  * @post volume waiters refcount is decremented; volume may
4631  *       have been deallocated/shutdown/offlined/salvaged/
4632  *       whatever during the process
4633  *
4634  * @warning once you have tossed your last reference (you can acquire
4635  *          lightweight refs recursively) it is NOT SAFE to reference
4636  *          a volume object pointer ever again
4637  *
4638  * @see VCreateReservation_r
4639  *
4640  * @note DEMAND_ATTACH_FS only
4641  */
4642 void
4643 VCancelReservation_r(Volume * vp)
4644 {
4645     assert(--vp->nWaiters >= 0);
4646     if (vp->nWaiters == 0) {
4647         VCheckOffline(vp);
4648         if (!VCheckDetach(vp)) {
4649             VCheckSalvage(vp);
4650             VCheckFree(vp);
4651         }
4652     }
4653 }
4654
4655 /* check to see if we should free this volume now
4656  * return 1 if volume was freed, 0 otherwise */
4657 static int
4658 VCheckFree(Volume * vp)
4659 {
4660     int ret = 0;
4661     if ((vp->nUsers == 0) &&
4662         (vp->nWaiters == 0) &&
4663         !(V_attachFlags(vp) & (VOL_IN_HASH |
4664                                VOL_ON_VBYP_LIST |
4665                                VOL_IS_BUSY |
4666                                VOL_ON_VLRU))) {
4667         ReallyFreeVolume(vp);
4668         ret = 1;
4669     }
4670     return ret;
4671 }
4672 #endif /* AFS_DEMAND_ATTACH_FS */
4673
4674
4675 /***************************************************/
4676 /* online volume operations routines               */
4677 /***************************************************/
4678
4679 #ifdef AFS_DEMAND_ATTACH_FS
4680 /**
4681  * register a volume operation on a given volume.
4682  *
4683  * @param[in] vp       volume object
4684  * @param[in] vopinfo  volume operation info object
4685  *
4686  * @pre VOL_LOCK is held
4687  *
4688  * @post volume operation info object attached to volume object.
4689  *       volume operation statistics updated.
4690  *
4691  * @note by "attached" we mean a copy of the passed in object is made
4692  *
4693  * @internal volume package internal use only
4694  */
4695 int
4696 VRegisterVolOp_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
4697 {
4698     FSSYNC_VolOp_info * info;
4699
4700     /* attach a vol op info node to the volume struct */
4701     info = (FSSYNC_VolOp_info *) malloc(sizeof(FSSYNC_VolOp_info));
4702     assert(info != NULL);
4703     memcpy(info, vopinfo, sizeof(FSSYNC_VolOp_info));
4704     vp->pending_vol_op = info;
4705
4706     /* update stats */
4707     vp->stats.last_vol_op = FT_ApproxTime();
4708     vp->stats.vol_ops++;
4709     IncUInt64(&VStats.vol_ops);
4710
4711     return 0;
4712 }
4713
4714 /**
4715  * deregister the volume operation attached to this volume.
4716  *
4717  * @param[in] vp  volume object pointer
4718  *
4719  * @pre VOL_LOCK is held
4720  *
4721  * @post the volume operation info object is detached from the volume object
4722  *
4723  * @internal volume package internal use only
4724  */
4725 int
4726 VDeregisterVolOp_r(Volume * vp)
4727 {
4728     if (vp->pending_vol_op) {
4729         free(vp->pending_vol_op);
4730         vp->pending_vol_op = NULL;
4731     }
4732     return 0;
4733 }
4734 #endif /* AFS_DEMAND_ATTACH_FS */
4735
4736 /**
4737  * determine whether it is safe to leave a volume online during
4738  * the volume operation described by the vopinfo object.
4739  *
4740  * @param[in] vp        volume object
4741  * @param[in] vopinfo   volume operation info object
4742  *
4743  * @return whether it is safe to leave volume online
4744  *    @retval 0  it is NOT SAFE to leave the volume online
4745  *    @retval 1  it is safe to leave the volume online during the operation
4746  *
4747  * @pre
4748  *    @arg VOL_LOCK is held
4749  *    @arg disk header attached to vp (heavyweight ref on vp will guarantee
4750  *         this condition is met)
4751  *
4752  * @internal volume package internal use only
4753  */
4754 int
4755 VVolOpLeaveOnline_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
4756 {
4757     return (vopinfo->vol_op_state == FSSYNC_VolOpRunningOnline ||
4758             (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
4759             (vopinfo->com.reason == V_READONLY ||
4760              (!VolumeWriteable(vp) &&
4761               (vopinfo->com.reason == V_CLONE ||
4762                vopinfo->com.reason == V_DUMP)))));
4763 }
4764
4765 /**
4766  * same as VVolOpLeaveOnline_r, but does not require a volume with an attached
4767  * header.
4768  *
4769  * @param[in] vp        volume object
4770  * @param[in] vopinfo   volume operation info object
4771  *
4772  * @return whether it is safe to leave volume online
4773  *    @retval 0  it is NOT SAFE to leave the volume online
4774  *    @retval 1  it is safe to leave the volume online during the operation
4775  *    @retval -1 unsure; volume header is required in order to know whether or
4776  *               not is is safe to leave the volume online
4777  *
4778  * @pre VOL_LOCK is held
4779  *
4780  * @internal volume package internal use only
4781  */
4782 int
4783 VVolOpLeaveOnlineNoHeader_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
4784 {
4785     /* follow the logic in VVolOpLeaveOnline_r; this is the same, except
4786      * assume that we don't know VolumeWriteable; return -1 if the answer
4787      * depends on VolumeWriteable */
4788
4789     if (vopinfo->vol_op_state == FSSYNC_VolOpRunningOnline) {
4790         return 1;
4791     }
4792     if (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
4793         vopinfo->com.reason == V_READONLY) {
4794
4795         return 1;
4796     }
4797     if (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
4798         (vopinfo->com.reason == V_CLONE ||
4799          vopinfo->com.reason == V_DUMP)) {
4800
4801         /* must know VolumeWriteable */
4802         return -1;
4803     }
4804     return 0;
4805 }
4806
4807 /**
4808  * determine whether VBUSY should be set during this volume operation.
4809  *
4810  * @param[in] vp        volume object
4811  * @param[in] vopinfo   volume operation info object
4812  *
4813  * @return whether VBUSY should be set
4814  *   @retval 0  VBUSY does NOT need to be set
4815  *   @retval 1  VBUSY SHOULD be set
4816  *
4817  * @pre VOL_LOCK is held
4818  *
4819  * @internal volume package internal use only
4820  */
4821 int
4822 VVolOpSetVBusy_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
4823 {
4824     return ((vopinfo->com.command == FSYNC_VOL_OFF &&
4825             vopinfo->com.reason == FSYNC_SALVAGE) ||
4826             (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
4827             (vopinfo->com.reason == V_CLONE ||
4828              vopinfo->com.reason == V_DUMP)));
4829 }
4830
4831
4832 /***************************************************/
4833 /* online salvager routines                        */
4834 /***************************************************/
4835 #if defined(AFS_DEMAND_ATTACH_FS)
4836 /**
4837  * check whether a salvage needs to be performed on this volume.
4838  *
4839  * @param[in] vp   pointer to volume object
4840  *
4841  * @return status code
4842  *    @retval 0 no salvage scheduled
4843  *    @retval 1 a salvage has been scheduled with the salvageserver
4844  *
4845  * @pre VOL_LOCK is held
4846  *
4847  * @post if salvage request flag is set and nUsers and nWaiters are zero,
4848  *       then a salvage will be requested
4849  *
4850  * @note this is one of the event handlers called by VCancelReservation_r
4851  *
4852  * @see VCancelReservation_r
4853  *
4854  * @internal volume package internal use only.
4855  */
4856 static int
4857 VCheckSalvage(register Volume * vp)
4858 {
4859     int ret = 0;
4860 #if defined(SALVSYNC_BUILD_CLIENT) || defined(FSSYNC_BUILD_CLIENT)
4861     if (vp->nUsers || vp->nWaiters)
4862         return ret;
4863     if (vp->salvage.requested) {
4864         VScheduleSalvage_r(vp);
4865         ret = 1;
4866     }
4867 #endif /* SALVSYNC_BUILD_CLIENT || FSSYNC_BUILD_CLIENT */
4868     return ret;
4869 }
4870
4871 /**
4872  * request volume salvage.
4873  *
4874  * @param[out] ec      computed client error code
4875  * @param[in]  vp      volume object pointer
4876  * @param[in]  reason  reason code (passed to salvageserver via SALVSYNC)
4877  * @param[in]  flags   see flags note below
4878  *
4879  * @note flags:
4880  *       VOL_SALVAGE_INVALIDATE_HEADER causes volume header cache entry
4881  *                                     to be invalidated.
4882  *
4883  * @pre VOL_LOCK is held.
4884  *
4885  * @post volume state is changed.
4886  *       for fileserver, salvage will be requested once refcount reaches zero.
4887  *
4888  * @return operation status code
4889  *   @retval 0  volume salvage will occur
4890  *   @retval 1  volume salvage could not be scheduled
4891  *
4892  * @note DAFS only
4893  *
4894  * @note in the fileserver, this call does not synchronously schedule a volume
4895  *       salvage. rather, it sets volume state so that when volume refcounts
4896  *       reach zero, a volume salvage will occur. by "refcounts", we mean both
4897  *       nUsers and nWaiters must be zero.
4898  *
4899  * @internal volume package internal use only.
4900  */
4901 int
4902 VRequestSalvage_r(Error * ec, Volume * vp, int reason, int flags)
4903 {
4904     int code = 0;
4905     /*
4906      * for DAFS volume utilities that are not supposed to schedule salvages,
4907      * just transition to error state instead
4908      */
4909     if (!VCanScheduleSalvage()) {
4910         VChangeState_r(vp, VOL_STATE_ERROR);
4911         *ec = VSALVAGE;
4912         return 1;
4913     }
4914
4915     if (programType != fileServer && !VCanUseFSSYNC()) {
4916         VChangeState_r(vp, VOL_STATE_ERROR);
4917         *ec = VSALVAGE;
4918         return 1;
4919     }
4920
4921     if (!vp->salvage.requested) {
4922         vp->salvage.requested = 1;
4923         vp->salvage.reason = reason;
4924         vp->stats.last_salvage = FT_ApproxTime();
4925
4926         /* Note that it is not possible for us to reach this point if a
4927          * salvage is already running on this volume (even if the fileserver
4928          * was restarted during the salvage). If a salvage were running, the
4929          * salvager would have write-locked the volume header file, so when
4930          * we tried to lock the volume header, the lock would have failed,
4931          * and we would have failed during attachment prior to calling
4932          * VRequestSalvage. So we know that we can schedule salvages without
4933          * fear of a salvage already running for this volume. */
4934
4935         if (vp->stats.salvages < SALVAGE_COUNT_MAX) {
4936             VChangeState_r(vp, VOL_STATE_SALVAGING);
4937             *ec = VSALVAGING;
4938         } else {
4939             Log("VRequestSalvage: volume %u online salvaged too many times; forced offline.\n", vp->hashid);
4940
4941             /* make sure neither VScheduleSalvage_r nor
4942              * VUpdateSalvagePriority_r try to schedule another salvage */
4943             vp->salvage.requested = vp->salvage.scheduled = 0;
4944
4945             VChangeState_r(vp, VOL_STATE_ERROR);
4946             *ec = VSALVAGE;
4947             code = 1;
4948         }
4949         if (flags & VOL_SALVAGE_INVALIDATE_HEADER) {
4950             /* Instead of ReleaseVolumeHeader, we do FreeVolumeHeader()
4951                so that the the next VAttachVolumeByVp_r() invocation
4952                of attach2() will pull in a cached header
4953                entry and fail, then load a fresh one from disk and attach
4954                it to the volume.
4955             */
4956             FreeVolumeHeader(vp);
4957         }
4958     }
4959     return code;
4960 }
4961
4962 /**
4963  * update salvageserver scheduling priority for a volume.
4964  *
4965  * @param[in] vp  pointer to volume object
4966  *
4967  * @return operation status
4968  *   @retval 0  success
4969  *   @retval 1  request denied, or SALVSYNC communications failure
4970  *
4971  * @pre VOL_LOCK is held.
4972  *
4973  * @post in-core salvage priority counter is incremented.  if at least
4974  *       SALVAGE_PRIO_UPDATE_INTERVAL seconds have elapsed since the
4975  *       last SALVSYNC_RAISEPRIO request, we contact the salvageserver
4976  *       to update its priority queue.  if no salvage is scheduled,
4977  *       this function is a no-op.
4978  *
4979  * @note DAFS fileserver only
4980  *
4981  * @note this should be called whenever a VGetVolume fails due to a
4982  *       pending salvage request
4983  *
4984  * @todo should set exclusive state and drop glock around salvsync call
4985  *
4986  * @internal volume package internal use only.
4987  */
4988 int
4989 VUpdateSalvagePriority_r(Volume * vp)
4990 {
4991     int ret=0;
4992
4993 #ifdef SALVSYNC_BUILD_CLIENT
4994     afs_uint32 now;
4995     int code;
4996
4997     vp->salvage.prio++;
4998     now = FT_ApproxTime();
4999
5000     /* update the salvageserver priority queue occasionally so that
5001      * frequently requested volumes get moved to the head of the queue
5002      */
5003     if ((vp->salvage.scheduled) &&
5004         (vp->stats.last_salvage_req < (now-SALVAGE_PRIO_UPDATE_INTERVAL))) {
5005         code = SALVSYNC_SalvageVolume(vp->hashid,
5006                                       VPartitionPath(vp->partition),
5007                                       SALVSYNC_RAISEPRIO,
5008                                       vp->salvage.reason,
5009                                       vp->salvage.prio,
5010                                       NULL);
5011         vp->stats.last_salvage_req = now;
5012         if (code != SYNC_OK) {
5013             ret = 1;
5014         }
5015     }
5016 #endif /* SALVSYNC_BUILD_CLIENT */
5017     return ret;
5018 }
5019
5020
5021 #if defined(SALVSYNC_BUILD_CLIENT) || defined(FSSYNC_BUILD_CLIENT)
5022
5023 /* A couple of little helper functions. These return true if we tried to
5024  * use this mechanism to schedule a salvage, false if we haven't tried.
5025  * If we did try a salvage then the results are contained in code.
5026  */
5027
5028 static_inline int
5029 try_SALVSYNC(Volume *vp, char *partName, int *code) {
5030 #ifdef SALVSYNC_BUILD_CLIENT
5031     if (VCanUseSALVSYNC()) {
5032         Log("Scheduling salvage for volume %lu on part %s over SALVSYNC\n",
5033             afs_printable_uint32_lu(vp->hashid), partName);
5034
5035         /* can't use V_id() since there's no guarantee
5036          * we have the disk data header at this point */
5037         *code = SALVSYNC_SalvageVolume(vp->hashid,
5038                                        partName,
5039                                        SALVSYNC_SALVAGE,
5040                                        vp->salvage.reason,
5041                                        vp->salvage.prio,
5042                                        NULL);
5043         return 1;
5044     }
5045 #endif
5046     return 0;
5047 }
5048
5049 static_inline int
5050 try_FSSYNC(Volume *vp, char *partName, int *code) {
5051 #ifdef FSSYNC_BUILD_CLIENT
5052     if (VCanUseFSSYNC()) {
5053         Log("Scheduling salvage for volume %lu on part %s over FSSYNC\n",
5054             afs_printable_uint32_lu(vp->hashid), partName);
5055
5056         /*
5057          * If we aren't the fileserver, tell the fileserver the volume
5058          * needs to be salvaged. We could directly tell the
5059          * salvageserver, but the fileserver keeps track of some stats
5060          * related to salvages, and handles some other salvage-related
5061          * complications for us.
5062          */
5063         *code = FSYNC_VolOp(vp->hashid, partName,
5064                             FSYNC_VOL_FORCE_ERROR, FSYNC_SALVAGE, NULL);
5065         return 1;
5066     }
5067 #endif /* FSSYNC_BUILD_CLIENT */
5068     return 0;
5069 }
5070
5071 /**
5072  * schedule a salvage with the salvage server or fileserver.
5073  *
5074  * @param[in] vp  pointer to volume object
5075  *
5076  * @return operation status
5077  *    @retval 0 salvage scheduled successfully
5078  *    @retval 1 salvage not scheduled, or SALVSYNC/FSSYNC com error
5079  *
5080  * @pre
5081  *    @arg VOL_LOCK is held.
5082  *    @arg nUsers and nWaiters should be zero.
5083  *
5084  * @post salvageserver or fileserver is sent a salvage request
5085  *
5086  * @note If we are the fileserver, the request will be sent to the salvage
5087  * server over SALVSYNC. If we are not the fileserver, the request will be
5088  * sent to the fileserver over FSSYNC (FSYNC_VOL_FORCE_ERROR/FSYNC_SALVAGE).
5089  *
5090  * @note DAFS only
5091  *
5092  * @internal volume package internal use only.
5093  */
5094 static int
5095 VScheduleSalvage_r(Volume * vp)
5096 {
5097     int ret=0;
5098     int code;
5099     VolState state_save;
5100     VThreadOptions_t * thread_opts;
5101     char partName[16];
5102
5103     assert(VCanUseSALVSYNC() || VCanUseFSSYNC());
5104
5105     if (vp->nWaiters || vp->nUsers) {
5106         return 1;
5107     }
5108
5109     /* prevent endless salvage,attach,salvage,attach,... loops */
5110     if (vp->stats.salvages >= SALVAGE_COUNT_MAX)
5111         return 1;
5112
5113     /*
5114      * don't perform salvsync ops on certain threads
5115      */
5116     thread_opts = pthread_getspecific(VThread_key);
5117     if (thread_opts == NULL) {
5118         thread_opts = &VThread_defaults;
5119     }
5120     if (thread_opts->disallow_salvsync || vol_disallow_salvsync) {
5121         return 1;
5122     }
5123
5124     /*
5125      * XXX the scheduling process should really be done asynchronously
5126      *     to avoid fssync deadlocks
5127      */
5128     if (!vp->salvage.scheduled) {
5129         /* if we haven't previously scheduled a salvage, do so now
5130          *
5131          * set the volume to an exclusive state and drop the lock
5132          * around the SALVSYNC call
5133          *
5134          * note that we do NOT acquire a reservation here -- doing so
5135          * could result in unbounded recursion
5136          */
5137         strlcpy(partName, VPartitionPath(vp->partition), sizeof(partName));
5138         state_save = VChangeState_r(vp, VOL_STATE_SALVSYNC_REQ);
5139         VOL_UNLOCK;
5140
5141         assert(try_SALVSYNC(vp, partName, &code) ||
5142                try_FSSYNC(vp, partName, &code));
5143
5144         VOL_LOCK;
5145         VChangeState_r(vp, state_save);
5146
5147         if (code == SYNC_OK) {
5148             vp->salvage.scheduled = 1;
5149             vp->stats.last_salvage_req = FT_ApproxTime();
5150             if (VCanUseSALVSYNC()) {
5151                 /* don't record these stats for non-fileservers; let the
5152                  * fileserver take care of these */
5153                 vp->stats.salvages++;
5154                 IncUInt64(&VStats.salvages);
5155             }
5156         } else {
5157             ret = 1;
5158             switch(code) {
5159             case SYNC_BAD_COMMAND:
5160             case SYNC_COM_ERROR:
5161                 break;
5162             case SYNC_DENIED:
5163                 Log("VScheduleSalvage_r: Salvage request for volume %lu "
5164                     "denied\n", afs_printable_uint32_lu(vp->hashid));
5165                 break;
5166             default:
5167                 Log("VScheduleSalvage_r: Salvage request for volume %lu "
5168                     "received unknown protocol error %d\n",
5169                     afs_printable_uint32_lu(vp->hashid), code);
5170                 break;
5171             }
5172
5173             if (VCanUseFSSYNC()) {
5174                 VChangeState_r(vp, VOL_STATE_ERROR);
5175             }
5176         }
5177     }
5178     return ret;
5179 }
5180 #endif /* SALVSYNC_BUILD_CLIENT || FSSYNC_BUILD_CLIENT */
5181
5182 #ifdef SALVSYNC_BUILD_CLIENT
5183
5184 /**
5185  * connect to the salvageserver SYNC service.
5186  *
5187  * @return operation status
5188  *    @retval 0 failure
5189  *    @retval 1 success
5190  *
5191  * @post connection to salvageserver SYNC service established
5192  *
5193  * @see VConnectSALV_r
5194  * @see VDisconnectSALV
5195  * @see VReconnectSALV
5196  */
5197 int
5198 VConnectSALV(void)
5199 {
5200     int retVal;
5201     VOL_LOCK;
5202     retVal = VConnectSALV_r();
5203     VOL_UNLOCK;
5204     return retVal;
5205 }
5206
5207 /**
5208  * connect to the salvageserver SYNC service.
5209  *
5210  * @return operation status
5211  *    @retval 0 failure
5212  *    @retval 1 success
5213  *
5214  * @pre VOL_LOCK is held.
5215  *
5216  * @post connection to salvageserver SYNC service established
5217  *
5218  * @see VConnectSALV
5219  * @see VDisconnectSALV_r
5220  * @see VReconnectSALV_r
5221  * @see SALVSYNC_clientInit
5222  *
5223  * @internal volume package internal use only.
5224  */
5225 int
5226 VConnectSALV_r(void)
5227 {
5228     return SALVSYNC_clientInit();
5229 }
5230
5231 /**
5232  * disconnect from the salvageserver SYNC service.
5233  *
5234  * @return operation status
5235  *    @retval 0 success
5236  *
5237  * @pre client should have a live connection to the salvageserver
5238  *
5239  * @post connection to salvageserver SYNC service destroyed
5240  *
5241  * @see VDisconnectSALV_r
5242  * @see VConnectSALV
5243  * @see VReconnectSALV
5244  */
5245 int
5246 VDisconnectSALV(void)
5247 {
5248     VOL_LOCK;
5249     VDisconnectSALV_r();
5250     VOL_UNLOCK;
5251     return 0;
5252 }
5253
5254 /**
5255  * disconnect from the salvageserver SYNC service.
5256  *
5257  * @return operation status
5258  *    @retval 0 success
5259  *
5260  * @pre
5261  *    @arg VOL_LOCK is held.
5262  *    @arg client should have a live connection to the salvageserver.
5263  *
5264  * @post connection to salvageserver SYNC service destroyed
5265  *
5266  * @see VDisconnectSALV
5267  * @see VConnectSALV_r
5268  * @see VReconnectSALV_r
5269  * @see SALVSYNC_clientFinis
5270  *
5271  * @internal volume package internal use only.
5272  */
5273 int
5274 VDisconnectSALV_r(void)
5275 {
5276     return SALVSYNC_clientFinis();
5277 }
5278
5279 /**
5280  * disconnect and then re-connect to the salvageserver SYNC service.
5281  *
5282  * @return operation status
5283  *    @retval 0 failure
5284  *    @retval 1 success
5285  *
5286  * @pre client should have a live connection to the salvageserver
5287  *
5288  * @post old connection is dropped, and a new one is established
5289  *
5290  * @see VConnectSALV
5291  * @see VDisconnectSALV
5292  * @see VReconnectSALV_r
5293  */
5294 int
5295 VReconnectSALV(void)
5296 {
5297     int retVal;
5298     VOL_LOCK;
5299     retVal = VReconnectSALV_r();
5300     VOL_UNLOCK;
5301     return retVal;
5302 }
5303
5304 /**
5305  * disconnect and then re-connect to the salvageserver SYNC service.
5306  *
5307  * @return operation status
5308  *    @retval 0 failure
5309  *    @retval 1 success
5310  *
5311  * @pre
5312  *    @arg VOL_LOCK is held.
5313  *    @arg client should have a live connection to the salvageserver.
5314  *
5315  * @post old connection is dropped, and a new one is established
5316  *
5317  * @see VConnectSALV_r
5318  * @see VDisconnectSALV
5319  * @see VReconnectSALV
5320  * @see SALVSYNC_clientReconnect
5321  *
5322  * @internal volume package internal use only.
5323  */
5324 int
5325 VReconnectSALV_r(void)
5326 {
5327     return SALVSYNC_clientReconnect();
5328 }
5329 #endif /* SALVSYNC_BUILD_CLIENT */
5330 #endif /* AFS_DEMAND_ATTACH_FS */
5331
5332
5333 /***************************************************/
5334 /* FSSYNC routines                                 */
5335 /***************************************************/
5336
5337 /* This must be called by any volume utility which needs to run while the
5338    file server is also running.  This is separated from VInitVolumePackage2 so
5339    that a utility can fork--and each of the children can independently
5340    initialize communication with the file server */
5341 #ifdef FSSYNC_BUILD_CLIENT
5342 /**
5343  * connect to the fileserver SYNC service.
5344  *
5345  * @return operation status
5346  *    @retval 0 failure
5347  *    @retval 1 success
5348  *
5349  * @pre
5350  *    @arg VInit must equal 2.
5351  *    @arg Program Type must not be fileserver or salvager.
5352  *
5353  * @post connection to fileserver SYNC service established
5354  *
5355  * @see VConnectFS_r
5356  * @see VDisconnectFS
5357  * @see VChildProcReconnectFS
5358  */
5359 int
5360 VConnectFS(void)
5361 {
5362     int retVal;
5363     VOL_LOCK;
5364     retVal = VConnectFS_r();
5365     VOL_UNLOCK;
5366     return retVal;
5367 }
5368
5369 /**
5370  * connect to the fileserver SYNC service.
5371  *
5372  * @return operation status
5373  *    @retval 0 failure
5374  *    @retval 1 success
5375  *
5376  * @pre
5377  *    @arg VInit must equal 2.
5378  *    @arg Program Type must not be fileserver or salvager.
5379  *    @arg VOL_LOCK is held.
5380  *
5381  * @post connection to fileserver SYNC service established
5382  *
5383  * @see VConnectFS
5384  * @see VDisconnectFS_r
5385  * @see VChildProcReconnectFS_r
5386  *
5387  * @internal volume package internal use only.
5388  */
5389 int
5390 VConnectFS_r(void)
5391 {
5392     int rc;
5393     assert((VInit == 2) &&
5394            (programType != fileServer) &&
5395            (programType != salvager));
5396     rc = FSYNC_clientInit();
5397     if (rc)
5398         VInit = 3;
5399     return rc;
5400 }
5401
5402 /**
5403  * disconnect from the fileserver SYNC service.
5404  *
5405  * @pre
5406  *    @arg client should have a live connection to the fileserver.
5407  *    @arg VOL_LOCK is held.
5408  *    @arg Program Type must not be fileserver or salvager.
5409  *
5410  * @post connection to fileserver SYNC service destroyed
5411  *
5412  * @see VDisconnectFS
5413  * @see VConnectFS_r
5414  * @see VChildProcReconnectFS_r
5415  *
5416  * @internal volume package internal use only.
5417  */
5418 void
5419 VDisconnectFS_r(void)
5420 {
5421     assert((programType != fileServer) &&
5422            (programType != salvager));
5423     FSYNC_clientFinis();
5424     VInit = 2;
5425 }
5426
5427 /**
5428  * disconnect from the fileserver SYNC service.
5429  *
5430  * @pre
5431  *    @arg client should have a live connection to the fileserver.
5432  *    @arg Program Type must not be fileserver or salvager.
5433  *
5434  * @post connection to fileserver SYNC service destroyed
5435  *
5436  * @see VDisconnectFS_r
5437  * @see VConnectFS
5438  * @see VChildProcReconnectFS
5439  */
5440 void
5441 VDisconnectFS(void)
5442 {
5443     VOL_LOCK;
5444     VDisconnectFS_r();
5445     VOL_UNLOCK;
5446 }
5447
5448 /**
5449  * connect to the fileserver SYNC service from a child process following a fork.
5450  *
5451  * @return operation status
5452  *    @retval 0 failure
5453  *    @retval 1 success
5454  *
5455  * @pre
5456  *    @arg VOL_LOCK is held.
5457  *    @arg current FSYNC handle is shared with a parent process
5458  *
5459  * @post current FSYNC handle is discarded and a new connection to the
5460  *       fileserver SYNC service is established
5461  *
5462  * @see VChildProcReconnectFS
5463  * @see VConnectFS_r
5464  * @see VDisconnectFS_r
5465  *
5466  * @internal volume package internal use only.
5467  */
5468 int
5469 VChildProcReconnectFS_r(void)
5470 {
5471     return FSYNC_clientChildProcReconnect();
5472 }
5473
5474 /**
5475  * connect to the fileserver SYNC service from a child process following a fork.
5476  *
5477  * @return operation status
5478  *    @retval 0 failure
5479  *    @retval 1 success
5480  *
5481  * @pre current FSYNC handle is shared with a parent process
5482  *
5483  * @post current FSYNC handle is discarded and a new connection to the
5484  *       fileserver SYNC service is established
5485  *
5486  * @see VChildProcReconnectFS_r
5487  * @see VConnectFS
5488  * @see VDisconnectFS
5489  */
5490 int
5491 VChildProcReconnectFS(void)
5492 {
5493     int ret;
5494     VOL_LOCK;
5495     ret = VChildProcReconnectFS_r();
5496     VOL_UNLOCK;
5497     return ret;
5498 }
5499 #endif /* FSSYNC_BUILD_CLIENT */
5500
5501
5502 /***************************************************/
5503 /* volume bitmap routines                          */
5504 /***************************************************/
5505
5506 /**
5507  * allocate a vnode bitmap number for the vnode
5508  *
5509  * @param[out] ec  error code
5510  * @param[in] vp   volume object pointer
5511  * @param[in] index vnode index number for the vnode
5512  * @param[in] flags flag values described in note
5513  *
5514  * @note for DAFS, flags parameter controls locking behavior.
5515  * If (flags & VOL_ALLOC_BITMAP_WAIT) is set, then this function
5516  * will create a reservation and block on any other exclusive
5517  * operations.  Otherwise, this function assumes the caller
5518  * already has exclusive access to vp, and we just change the
5519  * volume state.
5520  *
5521  * @pre VOL_LOCK held
5522  *
5523  * @return bit number allocated
5524  */
5525 /*
5526
5527  */
5528 int
5529 VAllocBitmapEntry_r(Error * ec, Volume * vp,
5530                     struct vnodeIndex *index, int flags)
5531 {
5532     int ret = 0;
5533     register byte *bp, *ep;
5534 #ifdef AFS_DEMAND_ATTACH_FS
5535     VolState state_save;
5536 #endif /* AFS_DEMAND_ATTACH_FS */
5537
5538     *ec = 0;
5539
5540     /* This test is probably redundant */
5541     if (!VolumeWriteable(vp)) {
5542         *ec = (bit32) VREADONLY;
5543         return ret;
5544     }
5545
5546 #ifdef AFS_DEMAND_ATTACH_FS
5547     if (flags & VOL_ALLOC_BITMAP_WAIT) {
5548         VCreateReservation_r(vp);
5549         VWaitExclusiveState_r(vp);
5550     }
5551     state_save = VChangeState_r(vp, VOL_STATE_GET_BITMAP);
5552 #endif /* AFS_DEMAND_ATTACH_FS */
5553
5554 #ifdef BITMAP_LATER
5555     if ((programType == fileServer) && !index->bitmap) {
5556         int i;
5557 #ifndef AFS_DEMAND_ATTACH_FS
5558         /* demand attach fs uses the volume state to avoid races.
5559          * specialStatus field is not used at all */
5560         int wasVBUSY = 0;
5561         if (vp->specialStatus == VBUSY) {
5562             if (vp->goingOffline) {     /* vos dump waiting for the volume to
5563                                          * go offline. We probably come here
5564                                          * from AddNewReadableResidency */
5565                 wasVBUSY = 1;
5566             } else {
5567                 while (vp->specialStatus == VBUSY) {
5568 #ifdef AFS_PTHREAD_ENV
5569                     VOL_UNLOCK;
5570                     sleep(2);
5571                     VOL_LOCK;
5572 #else /* !AFS_PTHREAD_ENV */
5573                     IOMGR_Sleep(2);
5574 #endif /* !AFS_PTHREAD_ENV */
5575                 }
5576             }
5577         }
5578 #endif /* !AFS_DEMAND_ATTACH_FS */
5579
5580         if (!index->bitmap) {
5581 #ifndef AFS_DEMAND_ATTACH_FS
5582             vp->specialStatus = VBUSY;  /* Stop anyone else from using it. */
5583 #endif /* AFS_DEMAND_ATTACH_FS */
5584             for (i = 0; i < nVNODECLASSES; i++) {
5585                 VGetBitmap_r(ec, vp, i);
5586                 if (*ec) {
5587 #ifdef AFS_DEMAND_ATTACH_FS
5588                     VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
5589 #else /* AFS_DEMAND_ATTACH_FS */
5590                     DeleteVolumeFromHashTable(vp);
5591                     vp->shuttingDown = 1;       /* Let who has it free it. */
5592                     vp->specialStatus = 0;
5593 #endif /* AFS_DEMAND_ATTACH_FS */
5594                     goto done;
5595                 }
5596             }
5597 #ifndef AFS_DEMAND_ATTACH_FS
5598             if (!wasVBUSY)
5599                 vp->specialStatus = 0;  /* Allow others to have access. */
5600 #endif /* AFS_DEMAND_ATTACH_FS */
5601         }
5602     }
5603 #endif /* BITMAP_LATER */
5604
5605 #ifdef AFS_DEMAND_ATTACH_FS
5606     VOL_UNLOCK;
5607 #endif /* AFS_DEMAND_ATTACH_FS */
5608     bp = index->bitmap + index->bitmapOffset;
5609     ep = index->bitmap + index->bitmapSize;
5610     while (bp < ep) {
5611         if ((*(bit32 *) bp) != (bit32) 0xffffffff) {
5612             int o;
5613             index->bitmapOffset = (afs_uint32) (bp - index->bitmap);
5614             while (*bp == 0xff)
5615                 bp++;
5616             o = ffs(~*bp) - 1;  /* ffs is documented in BSTRING(3) */
5617             *bp |= (1 << o);
5618             ret = ((bp - index->bitmap) * 8 + o);
5619 #ifdef AFS_DEMAND_ATTACH_FS
5620             VOL_LOCK;
5621 #endif /* AFS_DEMAND_ATTACH_FS */
5622             goto done;
5623         }
5624         bp += sizeof(bit32) /* i.e. 4 */ ;
5625     }
5626     /* No bit map entry--must grow bitmap */
5627     bp = (byte *)
5628         realloc(index->bitmap, index->bitmapSize + VOLUME_BITMAP_GROWSIZE);
5629     assert(bp != NULL);
5630     index->bitmap = bp;
5631     bp += index->bitmapSize;
5632     memset(bp, 0, VOLUME_BITMAP_GROWSIZE);
5633     index->bitmapOffset = index->bitmapSize;
5634     index->bitmapSize += VOLUME_BITMAP_GROWSIZE;
5635     *bp = 1;
5636     ret = index->bitmapOffset * 8;
5637 #ifdef AFS_DEMAND_ATTACH_FS
5638     VOL_LOCK;
5639 #endif /* AFS_DEMAND_ATTACH_FS */
5640
5641  done:
5642 #ifdef AFS_DEMAND_ATTACH_FS
5643     VChangeState_r(vp, state_save);
5644     if (flags & VOL_ALLOC_BITMAP_WAIT) {
5645         VCancelReservation_r(vp);
5646     }
5647 #endif /* AFS_DEMAND_ATTACH_FS */
5648     return ret;
5649 }
5650
5651 int
5652 VAllocBitmapEntry(Error * ec, Volume * vp, register struct vnodeIndex * index)
5653 {
5654     int retVal;
5655     VOL_LOCK;
5656     retVal = VAllocBitmapEntry_r(ec, vp, index, VOL_ALLOC_BITMAP_WAIT);
5657     VOL_UNLOCK;
5658     return retVal;
5659 }
5660
5661 void
5662 VFreeBitMapEntry_r(Error * ec, register struct vnodeIndex *index,
5663                    unsigned bitNumber)
5664 {
5665     unsigned int offset;
5666
5667     *ec = 0;
5668 #ifdef BITMAP_LATER
5669     if (!index->bitmap)
5670         return;
5671 #endif /* BITMAP_LATER */
5672     offset = bitNumber >> 3;
5673     if (offset >= index->bitmapSize) {
5674         *ec = VNOVNODE;
5675         return;
5676     }
5677     if (offset < index->bitmapOffset)
5678         index->bitmapOffset = offset & ~3;      /* Truncate to nearest bit32 */
5679     *(index->bitmap + offset) &= ~(1 << (bitNumber & 0x7));
5680 }
5681
5682 void
5683 VFreeBitMapEntry(Error * ec, register struct vnodeIndex *index,
5684                  unsigned bitNumber)
5685 {
5686     VOL_LOCK;
5687     VFreeBitMapEntry_r(ec, index, bitNumber);
5688     VOL_UNLOCK;
5689 }
5690
5691 /* this function will drop the glock internally.
5692  * for old pthread fileservers, this is safe thanks to vbusy.
5693  *
5694  * for demand attach fs, caller must have already called
5695  * VCreateReservation_r and VWaitExclusiveState_r */
5696 static void
5697 VGetBitmap_r(Error * ec, Volume * vp, VnodeClass class)
5698 {
5699     StreamHandle_t *file;
5700     afs_sfsize_t nVnodes, size;
5701     struct VnodeClassInfo *vcp = &VnodeClassInfo[class];
5702     struct vnodeIndex *vip = &vp->vnodeIndex[class];
5703     struct VnodeDiskObject *vnode;
5704     unsigned int unique = 0;
5705     FdHandle_t *fdP;
5706 #ifdef BITMAP_LATER
5707     byte *BitMap = 0;
5708 #endif /* BITMAP_LATER */
5709 #ifdef AFS_DEMAND_ATTACH_FS
5710     VolState state_save;
5711 #endif /* AFS_DEMAND_ATTACH_FS */
5712
5713     *ec = 0;
5714
5715 #ifdef AFS_DEMAND_ATTACH_FS
5716     state_save = VChangeState_r(vp, VOL_STATE_GET_BITMAP);
5717 #endif /* AFS_DEMAND_ATTACH_FS */
5718     VOL_UNLOCK;
5719
5720     fdP = IH_OPEN(vip->handle);
5721     assert(fdP != NULL);
5722     file = FDH_FDOPEN(fdP, "r");
5723     assert(file != NULL);
5724     vnode = (VnodeDiskObject *) malloc(vcp->diskSize);
5725     assert(vnode != NULL);
5726     size = OS_SIZE(fdP->fd_fd);
5727     assert(size != -1);
5728     nVnodes = (size <= vcp->diskSize ? 0 : size - vcp->diskSize)
5729         >> vcp->logSize;
5730     vip->bitmapSize = ((nVnodes / 8) + 10) / 4 * 4;     /* The 10 is a little extra so
5731                                                          * a few files can be created in this volume,
5732                                                          * the whole thing is rounded up to nearest 4
5733                                                          * bytes, because the bit map allocator likes
5734                                                          * it that way */
5735 #ifdef BITMAP_LATER
5736     BitMap = (byte *) calloc(1, vip->bitmapSize);
5737     assert(BitMap != NULL);
5738 #else /* BITMAP_LATER */
5739     vip->bitmap = (byte *) calloc(1, vip->bitmapSize);
5740     assert(vip->bitmap != NULL);
5741     vip->bitmapOffset = 0;
5742 #endif /* BITMAP_LATER */
5743     if (STREAM_SEEK(file, vcp->diskSize, 0) != -1) {
5744         int bitNumber = 0;
5745         for (bitNumber = 0; bitNumber < nVnodes + 100; bitNumber++) {
5746             if (STREAM_READ(vnode, vcp->diskSize, 1, file) != 1)
5747                 break;
5748             if (vnode->type != vNull) {
5749                 if (vnode->vnodeMagic != vcp->magic) {
5750                     Log("GetBitmap: addled vnode index in volume %s; volume needs salvage\n", V_name(vp));
5751                     *ec = VSALVAGE;
5752                     break;
5753                 }
5754 #ifdef BITMAP_LATER
5755                 *(BitMap + (bitNumber >> 3)) |= (1 << (bitNumber & 0x7));
5756 #else /* BITMAP_LATER */
5757                 *(vip->bitmap + (bitNumber >> 3)) |= (1 << (bitNumber & 0x7));
5758 #endif /* BITMAP_LATER */
5759                 if (unique <= vnode->uniquifier)
5760                     unique = vnode->uniquifier + 1;
5761             }
5762 #ifndef AFS_PTHREAD_ENV
5763             if ((bitNumber & 0x00ff) == 0x0ff) {        /* every 256 iterations */
5764                 IOMGR_Poll();
5765             }
5766 #endif /* !AFS_PTHREAD_ENV */
5767         }
5768     }
5769     if (vp->nextVnodeUnique < unique) {
5770         Log("GetBitmap: bad volume uniquifier for volume %s; volume needs salvage\n", V_name(vp));
5771         *ec = VSALVAGE;
5772     }
5773     /* Paranoia, partly justified--I think fclose after fdopen
5774      * doesn't seem to close fd.  In any event, the documentation
5775      * doesn't specify, so it's safer to close it twice.
5776      */
5777     STREAM_CLOSE(file);
5778     FDH_CLOSE(fdP);
5779     free(vnode);
5780
5781     VOL_LOCK;
5782 #ifdef BITMAP_LATER
5783     /* There may have been a racing condition with some other thread, both
5784      * creating the bitmaps for this volume. If the other thread was faster
5785      * the pointer to bitmap should already be filled and we can free ours.
5786      */
5787     if (vip->bitmap == NULL) {
5788         vip->bitmap = BitMap;
5789         vip->bitmapOffset = 0;
5790     } else
5791         free((byte *) BitMap);
5792 #endif /* BITMAP_LATER */
5793 #ifdef AFS_DEMAND_ATTACH_FS
5794     VChangeState_r(vp, state_save);
5795 #endif /* AFS_DEMAND_ATTACH_FS */
5796 }
5797
5798
5799 /***************************************************/
5800 /* Volume Path and Volume Number utility routines  */
5801 /***************************************************/
5802
5803 /**
5804  * find the first occurrence of a volume header file and return the path.
5805  *
5806  * @param[out] ec          outbound error code
5807  * @param[in]  volumeId    volume id to find
5808  * @param[out] partitionp  pointer to disk partition path string
5809  * @param[out] namep       pointer to volume header file name string
5810  *
5811  * @post path to first occurrence of volume header is returned in partitionp
5812  *       and namep, or ec is set accordingly.
5813  *
5814  * @warning this function is NOT re-entrant -- partitionp and namep point to
5815  *          static data segments
5816  *
5817  * @note if a volume utility inadvertently leaves behind a stale volume header
5818  *       on a vice partition, it is possible for callers to get the wrong one,
5819  *       depending on the order of the disk partition linked list.
5820  *
5821  */
5822 void
5823 VGetVolumePath(Error * ec, VolId volumeId, char **partitionp, char **namep)
5824 {
5825     static char partition[VMAXPATHLEN], name[VMAXPATHLEN];
5826     char path[VMAXPATHLEN];
5827     int found = 0;
5828     struct DiskPartition64 *dp;
5829
5830     *ec = 0;
5831     name[0] = '/';
5832     (void)afs_snprintf(&name[1], (sizeof name) - 1, VFORMAT, afs_printable_uint32_lu(volumeId));
5833     for (dp = DiskPartitionList; dp; dp = dp->next) {
5834         struct afs_stat status;
5835         strcpy(path, VPartitionPath(dp));
5836         strcat(path, name);
5837         if (afs_stat(path, &status) == 0) {
5838             strcpy(partition, dp->name);
5839             found = 1;
5840             break;
5841         }
5842     }
5843     if (!found) {
5844         *ec = VNOVOL;
5845         *partitionp = *namep = NULL;
5846     } else {
5847         *partitionp = partition;
5848         *namep = name;
5849     }
5850 }
5851
5852 /**
5853  * extract a volume number from a volume header filename string.
5854  *
5855  * @param[in] name  volume header filename string
5856  *
5857  * @return volume number
5858  *
5859  * @note the string must be of the form VFORMAT.  the only permissible
5860  *       deviation is a leading '/' character.
5861  *
5862  * @see VFORMAT
5863  */
5864 int
5865 VolumeNumber(char *name)
5866 {
5867     if (*name == '/')
5868         name++;
5869     return atoi(name + 1);
5870 }
5871
5872 /**
5873  * compute the volume header filename.
5874  *
5875  * @param[in] volumeId
5876  *
5877  * @return volume header filename
5878  *
5879  * @post volume header filename string is constructed
5880  *
5881  * @warning this function is NOT re-entrant -- the returned string is
5882  *          stored in a static char array.  see VolumeExternalName_r
5883  *          for a re-entrant equivalent.
5884  *
5885  * @see VolumeExternalName_r
5886  *
5887  * @deprecated due to the above re-entrancy warning, this interface should
5888  *             be considered deprecated.  Please use VolumeExternalName_r
5889  *             in its stead.
5890  */
5891 char *
5892 VolumeExternalName(VolumeId volumeId)
5893 {
5894     static char name[VMAXPATHLEN];
5895     (void)afs_snprintf(name, sizeof name, VFORMAT, afs_printable_uint32_lu(volumeId));
5896     return name;
5897 }
5898
5899 /**
5900  * compute the volume header filename.
5901  *
5902  * @param[in]     volumeId
5903  * @param[inout]  name       array in which to store filename
5904  * @param[in]     len        length of name array
5905  *
5906  * @return result code from afs_snprintf
5907  *
5908  * @see VolumeExternalName
5909  * @see afs_snprintf
5910  *
5911  * @note re-entrant equivalent of VolumeExternalName
5912  */
5913 int
5914 VolumeExternalName_r(VolumeId volumeId, char * name, size_t len)
5915 {
5916     return afs_snprintf(name, len, VFORMAT, afs_printable_uint32_lu(volumeId));
5917 }
5918
5919
5920 /***************************************************/
5921 /* Volume Usage Statistics routines                */
5922 /***************************************************/
5923
5924 #if OPENAFS_VOL_STATS
5925 #define OneDay  (86400)         /* 24 hours' worth of seconds */
5926 #else
5927 #define OneDay  (24*60*60)      /* 24 hours */
5928 #endif /* OPENAFS_VOL_STATS */
5929
5930 static time_t
5931 Midnight(time_t t) {
5932     struct tm local, *l;
5933     time_t midnight;
5934
5935 #if defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
5936     l = localtime_r(&t, &local);
5937 #else
5938     l = localtime(&t);
5939 #endif
5940
5941     if (l != NULL) {
5942         /* the following is strictly speaking problematic on the
5943            switching day to daylight saving time, after the switch,
5944            as tm_isdst does not match.  Similarly, on the looong day when
5945            switching back the OneDay check will not do what naively expected!
5946            The effects are minor, though, and more a matter of interpreting
5947            the numbers. */
5948 #ifndef AFS_PTHREAD_ENV
5949         local = *l;
5950 #endif
5951         local.tm_hour = local.tm_min=local.tm_sec = 0;
5952         midnight = mktime(&local);
5953         if (midnight != (time_t) -1) return(midnight);
5954     }
5955     return( (t/OneDay)*OneDay );
5956
5957 }
5958
5959 /*------------------------------------------------------------------------
5960  * [export] VAdjustVolumeStatistics
5961  *
5962  * Description:
5963  *      If we've passed midnight, we need to update all the day use
5964  *      statistics as well as zeroing the detailed volume statistics
5965  *      (if we are implementing them).
5966  *
5967  * Arguments:
5968  *      vp : Pointer to the volume structure describing the lucky
5969  *              volume being considered for update.
5970  *
5971  * Returns:
5972  *      0 (always!)
5973  *
5974  * Environment:
5975  *      Nothing interesting.
5976  *
5977  * Side Effects:
5978  *      As described.
5979  *------------------------------------------------------------------------*/
5980
5981 int
5982 VAdjustVolumeStatistics_r(register Volume * vp)
5983 {
5984     unsigned int now = FT_ApproxTime();
5985
5986     if (now - V_dayUseDate(vp) > OneDay) {
5987         register int ndays, i;
5988
5989         ndays = (now - V_dayUseDate(vp)) / OneDay;
5990         for (i = 6; i > ndays - 1; i--)
5991             V_weekUse(vp)[i] = V_weekUse(vp)[i - ndays];
5992         for (i = 0; i < ndays - 1 && i < 7; i++)
5993             V_weekUse(vp)[i] = 0;
5994         if (ndays <= 7)
5995             V_weekUse(vp)[ndays - 1] = V_dayUse(vp);
5996         V_dayUse(vp) = 0;
5997         V_dayUseDate(vp) = Midnight(now);
5998
5999 #if OPENAFS_VOL_STATS
6000         /*
6001          * All we need to do is bzero the entire VOL_STATS_BYTES of
6002          * the detailed volume statistics area.
6003          */
6004         memset((V_stat_area(vp)), 0, VOL_STATS_BYTES);
6005 #endif /* OPENAFS_VOL_STATS */
6006     }
6007
6008     /*It's been more than a day of collection */
6009     /*
6010      * Always return happily.
6011      */
6012     return (0);
6013 }                               /*VAdjustVolumeStatistics */
6014
6015 int
6016 VAdjustVolumeStatistics(register Volume * vp)
6017 {
6018     int retVal;
6019     VOL_LOCK;
6020     retVal = VAdjustVolumeStatistics_r(vp);
6021     VOL_UNLOCK;
6022     return retVal;
6023 }
6024
6025 void
6026 VBumpVolumeUsage_r(register Volume * vp)
6027 {
6028     unsigned int now = FT_ApproxTime();
6029     V_accessDate(vp) = now;
6030     if (now - V_dayUseDate(vp) > OneDay)
6031         VAdjustVolumeStatistics_r(vp);
6032     /*
6033      * Save the volume header image to disk after every 128 bumps to dayUse.
6034      */
6035     if ((V_dayUse(vp)++ & 127) == 0) {
6036         Error error;
6037         VUpdateVolume_r(&error, vp, VOL_UPDATE_WAIT);
6038     }
6039 }
6040
6041 void
6042 VBumpVolumeUsage(register Volume * vp)
6043 {
6044     VOL_LOCK;
6045     VBumpVolumeUsage_r(vp);
6046     VOL_UNLOCK;
6047 }
6048
6049 void
6050 VSetDiskUsage_r(void)
6051 {
6052 #ifndef AFS_DEMAND_ATTACH_FS
6053     static int FifteenMinuteCounter = 0;
6054 #endif
6055
6056     while (VInit < 2) {
6057         /* NOTE: Don't attempt to access the partitions list until the
6058          * initialization level indicates that all volumes are attached,
6059          * which implies that all partitions are initialized. */
6060 #ifdef AFS_PTHREAD_ENV
6061         sleep(10);
6062 #else /* AFS_PTHREAD_ENV */
6063         IOMGR_Sleep(10);
6064 #endif /* AFS_PTHREAD_ENV */
6065     }
6066
6067     VResetDiskUsage_r();
6068
6069 #ifndef AFS_DEMAND_ATTACH_FS
6070     if (++FifteenMinuteCounter == 3) {
6071         FifteenMinuteCounter = 0;
6072         VScanUpdateList();
6073     }
6074 #endif /* !AFS_DEMAND_ATTACH_FS */
6075 }
6076
6077 void
6078 VSetDiskUsage(void)
6079 {
6080     VOL_LOCK;
6081     VSetDiskUsage_r();
6082     VOL_UNLOCK;
6083 }
6084
6085
6086 /***************************************************/
6087 /* Volume Update List routines                     */
6088 /***************************************************/
6089
6090 /* The number of minutes that a volume hasn't been updated before the
6091  * "Dont salvage" flag in the volume header will be turned on */
6092 #define SALVAGE_INTERVAL        (10*60)
6093
6094 /*
6095  * demand attach fs
6096  *
6097  * volume update list functionality has been moved into the VLRU
6098  * the DONT_SALVAGE flag is now set during VLRU demotion
6099  */
6100
6101 #ifndef AFS_DEMAND_ATTACH_FS
6102 static VolumeId *UpdateList = NULL;     /* Pointer to array of Volume ID's */
6103 static int nUpdatedVolumes = 0;         /* Updated with entry in UpdateList, salvage after crash flag on */
6104 static int updateSize = 0;              /* number of entries possible */
6105 #define UPDATE_LIST_SIZE 128            /* initial size increment (must be a power of 2!) */
6106 #endif /* !AFS_DEMAND_ATTACH_FS */
6107
6108 void
6109 VAddToVolumeUpdateList_r(Error * ec, Volume * vp)
6110 {
6111     *ec = 0;
6112     vp->updateTime = FT_ApproxTime();
6113     if (V_dontSalvage(vp) == 0)
6114         return;
6115     V_dontSalvage(vp) = 0;
6116     VSyncVolume_r(ec, vp, 0);
6117 #ifdef AFS_DEMAND_ATTACH_FS
6118     V_attachFlags(vp) &= ~(VOL_HDR_DONTSALV);
6119 #else /* !AFS_DEMAND_ATTACH_FS */
6120     if (*ec)
6121         return;
6122     if (UpdateList == NULL) {
6123         updateSize = UPDATE_LIST_SIZE;
6124         UpdateList = (VolumeId *) malloc(sizeof(VolumeId) * updateSize);
6125     } else {
6126         if (nUpdatedVolumes == updateSize) {
6127             updateSize <<= 1;
6128             if (updateSize > 524288) {
6129                 Log("warning: there is likely a bug in the volume update scanner\n");
6130                 return;
6131             }
6132             UpdateList =
6133                 (VolumeId *) realloc(UpdateList,
6134                                      sizeof(VolumeId) * updateSize);
6135         }
6136     }
6137     assert(UpdateList != NULL);
6138     UpdateList[nUpdatedVolumes++] = V_id(vp);
6139 #endif /* !AFS_DEMAND_ATTACH_FS */
6140 }
6141
6142 #ifndef AFS_DEMAND_ATTACH_FS
6143 static void
6144 VScanUpdateList(void)
6145 {
6146     register int i, gap;
6147     register Volume *vp;
6148     Error error;
6149     afs_uint32 now = FT_ApproxTime();
6150     /* Be careful with this code, since it works with interleaved calls to AddToVolumeUpdateList */
6151     for (i = gap = 0; i < nUpdatedVolumes; i++) {
6152         if (gap)
6153             UpdateList[i - gap] = UpdateList[i];
6154
6155         /* XXX this routine needlessly messes up the Volume LRU by
6156          * breaking the LRU temporal-locality assumptions.....
6157          * we should use a special volume header allocator here */
6158         vp = VGetVolume_r(&error, UpdateList[i - gap] = UpdateList[i]);
6159         if (error) {
6160             gap++;
6161         } else if (vp->nUsers == 1 && now - vp->updateTime > SALVAGE_INTERVAL) {
6162             V_dontSalvage(vp) = DONT_SALVAGE;
6163             VUpdateVolume_r(&error, vp, 0);     /* No need to fsync--not critical */
6164             gap++;
6165         }
6166
6167         if (vp) {
6168             VPutVolume_r(vp);
6169         }
6170
6171 #ifndef AFS_PTHREAD_ENV
6172         IOMGR_Poll();
6173 #endif /* !AFS_PTHREAD_ENV */
6174     }
6175     nUpdatedVolumes -= gap;
6176 }
6177 #endif /* !AFS_DEMAND_ATTACH_FS */
6178
6179
6180 /***************************************************/
6181 /* Volume LRU routines                             */
6182 /***************************************************/
6183
6184 /* demand attach fs
6185  * volume LRU
6186  *
6187  * with demand attach fs, we attempt to soft detach(1)
6188  * volumes which have not been accessed in a long time
6189  * in order to speed up fileserver shutdown
6190  *
6191  * (1) by soft detach we mean a process very similar
6192  *     to VOffline, except the final state of the
6193  *     Volume will be VOL_STATE_PREATTACHED, instead
6194  *     of the usual VOL_STATE_UNATTACHED
6195  */
6196 #ifdef AFS_DEMAND_ATTACH_FS
6197
6198 /* implementation is reminiscent of a generational GC
6199  *
6200  * queue 0 is newly attached volumes. this queue is
6201  * sorted by attach timestamp
6202  *
6203  * queue 1 is volumes that have been around a bit
6204  * longer than queue 0. this queue is sorted by
6205  * attach timestamp
6206  *
6207  * queue 2 is volumes tha have been around the longest.
6208  * this queue is unsorted
6209  *
6210  * queue 3 is volumes that have been marked as
6211  * candidates for soft detachment. this queue is
6212  * unsorted
6213  */
6214 #define VLRU_GENERATIONS  3   /**< number of generations in VLRU */
6215 #define VLRU_QUEUES       5   /**< total number of VLRU queues */
6216
6217 /**
6218  * definition of a VLRU queue.
6219  */
6220 struct VLRU_q {
6221     volatile struct rx_queue q;
6222     volatile int len;
6223     volatile int busy;
6224     pthread_cond_t cv;
6225 };
6226
6227 /**
6228  * main VLRU data structure.
6229  */
6230 struct VLRU {
6231     struct VLRU_q q[VLRU_QUEUES];   /**< VLRU queues */
6232
6233     /* VLRU config */
6234     /** time interval (in seconds) between promotion passes for
6235      *  each young generation queue. */
6236     afs_uint32 promotion_interval[VLRU_GENERATIONS-1];
6237
6238     /** time interval (in seconds) between soft detach candidate
6239      *  scans for each generation queue.
6240      *
6241      *  scan_interval[VLRU_QUEUE_CANDIDATE] defines how frequently
6242      *  we perform a soft detach pass. */
6243     afs_uint32 scan_interval[VLRU_GENERATIONS+1];
6244
6245     /* scheduler state */
6246     int next_idx;                                       /**< next queue to receive attention */
6247     afs_uint32 last_promotion[VLRU_GENERATIONS-1];      /**< timestamp of last promotion scan */
6248     afs_uint32 last_scan[VLRU_GENERATIONS+1];           /**< timestamp of last detach scan */
6249
6250     int scanner_state;                                  /**< state of scanner thread */
6251     pthread_cond_t cv;                                  /**< state transition CV */
6252 };
6253
6254 /** global VLRU state */
6255 static struct VLRU volume_LRU;
6256
6257 /**
6258  * defined states for VLRU scanner thread.
6259  */
6260 typedef enum {
6261     VLRU_SCANNER_STATE_OFFLINE        = 0,    /**< vlru scanner thread is offline */
6262     VLRU_SCANNER_STATE_ONLINE         = 1,    /**< vlru scanner thread is online */
6263     VLRU_SCANNER_STATE_SHUTTING_DOWN  = 2,    /**< vlru scanner thread is shutting down */
6264     VLRU_SCANNER_STATE_PAUSING        = 3,    /**< vlru scanner thread is getting ready to pause */
6265     VLRU_SCANNER_STATE_PAUSED         = 4     /**< vlru scanner thread is paused */
6266 } vlru_thread_state_t;
6267
6268 /* vlru disk data header stuff */
6269 #define VLRU_DISK_MAGIC      0x7a8b9cad        /**< vlru disk entry magic number */
6270 #define VLRU_DISK_VERSION    1                 /**< vlru disk entry version number */
6271
6272 /** vlru default expiration time (for eventual fs state serialization of vlru data) */
6273 #define VLRU_DUMP_EXPIRATION_TIME   (60*60*24*7)  /* expire vlru data after 1 week */
6274
6275
6276 /** minimum volume inactivity (in seconds) before a volume becomes eligible for
6277  *  soft detachment. */
6278 static afs_uint32 VLRU_offline_thresh = VLRU_DEFAULT_OFFLINE_THRESH;
6279
6280 /** time interval (in seconds) between VLRU scanner thread soft detach passes. */
6281 static afs_uint32 VLRU_offline_interval = VLRU_DEFAULT_OFFLINE_INTERVAL;
6282
6283 /** maximum number of volumes to soft detach in a VLRU soft detach pass. */
6284 static afs_uint32 VLRU_offline_max = VLRU_DEFAULT_OFFLINE_MAX;
6285
6286 /** VLRU control flag.  non-zero value implies VLRU subsystem is activated. */
6287 static afs_uint32 VLRU_enabled = 1;
6288
6289 /* queue synchronization routines */
6290 static void VLRU_BeginExclusive_r(struct VLRU_q * q);
6291 static void VLRU_EndExclusive_r(struct VLRU_q * q);
6292 static void VLRU_Wait_r(struct VLRU_q * q);
6293
6294 /**
6295  * set VLRU subsystem tunable parameters.
6296  *
6297  * @param[in] option  tunable option to modify
6298  * @param[in] val     new value for tunable parameter
6299  *
6300  * @pre @c VInitVolumePackage2 has not yet been called.
6301  *
6302  * @post tunable parameter is modified
6303  *
6304  * @note DAFS only
6305  *
6306  * @note valid option parameters are:
6307  *    @arg @c VLRU_SET_THRESH
6308  *         set the period of inactivity after which
6309  *         volumes are eligible for soft detachment
6310  *    @arg @c VLRU_SET_INTERVAL
6311  *         set the time interval between calls
6312  *         to the volume LRU "garbage collector"
6313  *    @arg @c VLRU_SET_MAX
6314  *         set the max number of volumes to deallocate
6315  *         in one GC pass
6316  */
6317 void
6318 VLRU_SetOptions(int option, afs_uint32 val)
6319 {
6320     if (option == VLRU_SET_THRESH) {
6321         VLRU_offline_thresh = val;
6322     } else if (option == VLRU_SET_INTERVAL) {
6323         VLRU_offline_interval = val;
6324     } else if (option == VLRU_SET_MAX) {
6325         VLRU_offline_max = val;
6326     } else if (option == VLRU_SET_ENABLED) {
6327         VLRU_enabled = val;
6328     }
6329     VLRU_ComputeConstants();
6330 }
6331
6332 /**
6333  * compute VLRU internal timing parameters.
6334  *
6335  * @post VLRU scanner thread internal timing parameters are computed
6336  *
6337  * @note computes internal timing parameters based upon user-modifiable
6338  *       tunable parameters.
6339  *
6340  * @note DAFS only
6341  *
6342  * @internal volume package internal use only.
6343  */
6344 static void
6345 VLRU_ComputeConstants(void)
6346 {
6347     afs_uint32 factor = VLRU_offline_thresh / VLRU_offline_interval;
6348
6349     /* compute the candidate scan interval */
6350     volume_LRU.scan_interval[VLRU_QUEUE_CANDIDATE] = VLRU_offline_interval;
6351
6352     /* compute the promotion intervals */
6353     volume_LRU.promotion_interval[VLRU_QUEUE_NEW] = VLRU_offline_thresh * 2;
6354     volume_LRU.promotion_interval[VLRU_QUEUE_MID] = VLRU_offline_thresh * 4;
6355
6356     if (factor > 16) {
6357         /* compute the gen 0 scan interval */
6358         volume_LRU.scan_interval[VLRU_QUEUE_NEW] = VLRU_offline_thresh / 8;
6359     } else {
6360         /* compute the gen 0 scan interval */
6361         volume_LRU.scan_interval[VLRU_QUEUE_NEW] = VLRU_offline_interval * 2;
6362     }
6363 }
6364
6365 /**
6366  * initialize VLRU subsystem.
6367  *
6368  * @pre this function has not yet been called
6369  *
6370  * @post VLRU subsystem is initialized and VLRU scanner thread is starting
6371  *
6372  * @note DAFS only
6373  *
6374  * @internal volume package internal use only.
6375  */
6376 static void
6377 VInitVLRU(void)
6378 {
6379     pthread_t tid;
6380     pthread_attr_t attrs;
6381     int i;
6382
6383     if (!VLRU_enabled) {
6384         Log("VLRU: disabled\n");
6385         return;
6386     }
6387
6388     /* initialize each of the VLRU queues */
6389     for (i = 0; i < VLRU_QUEUES; i++) {
6390         queue_Init(&volume_LRU.q[i]);
6391         volume_LRU.q[i].len = 0;
6392         volume_LRU.q[i].busy = 0;
6393         assert(pthread_cond_init(&volume_LRU.q[i].cv, NULL) == 0);
6394     }
6395
6396     /* setup the timing constants */
6397     VLRU_ComputeConstants();
6398
6399     /* XXX put inside LogLevel check? */
6400     Log("VLRU: starting scanner with the following configuration parameters:\n");
6401     Log("VLRU:  offlining volumes after minimum of %d seconds of inactivity\n", VLRU_offline_thresh);
6402     Log("VLRU:  running VLRU soft detach pass every %d seconds\n", VLRU_offline_interval);
6403     Log("VLRU:  taking up to %d volumes offline per pass\n", VLRU_offline_max);
6404     Log("VLRU:  scanning generation 0 for inactive volumes every %d seconds\n", volume_LRU.scan_interval[0]);
6405     Log("VLRU:  scanning for promotion/demotion between generations 0 and 1 every %d seconds\n", volume_LRU.promotion_interval[0]);
6406     Log("VLRU:  scanning for promotion/demotion between generations 1 and 2 every %d seconds\n", volume_LRU.promotion_interval[1]);
6407
6408     /* start up the VLRU scanner */
6409     volume_LRU.scanner_state = VLRU_SCANNER_STATE_OFFLINE;
6410     if (programType == fileServer) {
6411         assert(pthread_cond_init(&volume_LRU.cv, NULL) == 0);
6412         assert(pthread_attr_init(&attrs) == 0);
6413         assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
6414         assert(pthread_create(&tid, &attrs, &VLRU_ScannerThread, NULL) == 0);
6415     }
6416 }
6417
6418 /**
6419  * initialize the VLRU-related fields of a newly allocated volume object.
6420  *
6421  * @param[in] vp  pointer to volume object
6422  *
6423  * @pre
6424  *    @arg @c VOL_LOCK is held.
6425  *    @arg volume object is not on a VLRU queue.
6426  *
6427  * @post VLRU fields are initialized to indicate that volume object is not
6428  *       currently registered with the VLRU subsystem
6429  *
6430  * @note DAFS only
6431  *
6432  * @internal volume package interal use only.
6433  */
6434 static void
6435 VLRU_Init_Node_r(Volume * vp)
6436 {
6437     if (!VLRU_enabled)
6438         return;
6439
6440     assert(queue_IsNotOnQueue(&vp->vlru));
6441     vp->vlru.idx = VLRU_QUEUE_INVALID;
6442 }
6443
6444 /**
6445  * add a volume object to a VLRU queue.
6446  *
6447  * @param[in] vp  pointer to volume object
6448  *
6449  * @pre
6450  *    @arg @c VOL_LOCK is held.
6451  *    @arg caller MUST hold a lightweight ref on @p vp.
6452  *    @arg caller MUST NOT hold exclusive ownership of the VLRU queue.
6453  *
6454  * @post the volume object is added to the appropriate VLRU queue
6455  *
6456  * @note if @c vp->vlru.idx contains the index of a valid VLRU queue,
6457  *       then the volume is added to that queue.  Otherwise, the value
6458  *       @c VLRU_QUEUE_NEW is stored into @c vp->vlru.idx and the
6459  *       volume is added to the NEW generation queue.
6460  *
6461  * @note @c VOL_LOCK may be dropped internally
6462  *
6463  * @note Volume state is temporarily set to @c VOL_STATE_VLRU_ADD
6464  *       during the add operation, and is restored to the previous
6465  *       state prior to return.
6466  *
6467  * @note DAFS only
6468  *
6469  * @internal volume package internal use only.
6470  */
6471 static void
6472 VLRU_Add_r(Volume * vp)
6473 {
6474     int idx;
6475     VolState state_save;
6476
6477     if (!VLRU_enabled)
6478         return;
6479
6480     if (queue_IsOnQueue(&vp->vlru))
6481         return;
6482
6483     state_save = VChangeState_r(vp, VOL_STATE_VLRU_ADD);
6484
6485     idx = vp->vlru.idx;
6486     if ((idx < 0) || (idx >= VLRU_QUEUE_INVALID)) {
6487         idx = VLRU_QUEUE_NEW;
6488     }
6489
6490     VLRU_Wait_r(&volume_LRU.q[idx]);
6491
6492     /* repeat check since VLRU_Wait_r may have dropped
6493      * the glock */
6494     if (queue_IsNotOnQueue(&vp->vlru)) {
6495         vp->vlru.idx = idx;
6496         queue_Prepend(&volume_LRU.q[idx], &vp->vlru);
6497         volume_LRU.q[idx].len++;
6498         V_attachFlags(vp) |= VOL_ON_VLRU;
6499         vp->stats.last_promote = FT_ApproxTime();
6500     }
6501
6502     VChangeState_r(vp, state_save);
6503 }
6504
6505 /**
6506  * delete a volume object from a VLRU queue.
6507  *
6508  * @param[in] vp  pointer to volume object
6509  *
6510  * @pre
6511  *    @arg @c VOL_LOCK is held.
6512  *    @arg caller MUST hold a lightweight ref on @p vp.
6513  *    @arg caller MUST NOT hold exclusive ownership of the VLRU queue.
6514  *
6515  * @post volume object is removed from the VLRU queue
6516  *
6517  * @note @c VOL_LOCK may be dropped internally
6518  *
6519  * @note DAFS only
6520  *
6521  * @todo We should probably set volume state to something exlcusive
6522  *       (as @c VLRU_Add_r does) prior to dropping @c VOL_LOCK.
6523  *
6524  * @internal volume package internal use only.
6525  */
6526 static void
6527 VLRU_Delete_r(Volume * vp)
6528 {
6529     int idx;
6530
6531     if (!VLRU_enabled)
6532         return;
6533
6534     if (queue_IsNotOnQueue(&vp->vlru))
6535         return;
6536
6537     /* handle races */
6538     do {
6539       idx = vp->vlru.idx;
6540       if (idx == VLRU_QUEUE_INVALID)
6541           return;
6542       VLRU_Wait_r(&volume_LRU.q[idx]);
6543     } while (idx != vp->vlru.idx);
6544
6545     /* now remove from the VLRU and update
6546      * the appropriate counter */
6547     queue_Remove(&vp->vlru);
6548     volume_LRU.q[idx].len--;
6549     vp->vlru.idx = VLRU_QUEUE_INVALID;
6550     V_attachFlags(vp) &= ~(VOL_ON_VLRU);
6551 }
6552
6553 /**
6554  * tell the VLRU subsystem that a volume was just accessed.
6555  *
6556  * @param[in] vp  pointer to volume object
6557  *
6558  * @pre
6559  *    @arg @c VOL_LOCK is held
6560  *    @arg caller MUST hold a lightweight ref on @p vp
6561  *    @arg caller MUST NOT hold exclusive ownership of any VLRU queue
6562  *
6563  * @post volume VLRU access statistics are updated.  If the volume was on
6564  *       the VLRU soft detach candidate queue, it is moved to the NEW
6565  *       generation queue.
6566  *
6567  * @note @c VOL_LOCK may be dropped internally
6568  *
6569  * @note DAFS only
6570  *
6571  * @internal volume package internal use only.
6572  */
6573 static void
6574 VLRU_UpdateAccess_r(Volume * vp)
6575 {
6576     Volume * rvp = NULL;
6577
6578     if (!VLRU_enabled)
6579         return;
6580
6581     if (queue_IsNotOnQueue(&vp->vlru))
6582         return;
6583
6584     assert(V_attachFlags(vp) & VOL_ON_VLRU);
6585
6586     /* update the access timestamp */
6587     vp->stats.last_get = FT_ApproxTime();
6588
6589     /*
6590      * if the volume is on the soft detach candidate
6591      * list, we need to safely move it back to a
6592      * regular generation.  this has to be done
6593      * carefully so we don't race against the scanner
6594      * thread.
6595      */
6596
6597     /* if this volume is on the soft detach candidate queue,
6598      * then grab exclusive access to the necessary queues */
6599     if (vp->vlru.idx == VLRU_QUEUE_CANDIDATE) {
6600         rvp = vp;
6601         VCreateReservation_r(rvp);
6602
6603         VLRU_Wait_r(&volume_LRU.q[VLRU_QUEUE_NEW]);
6604         VLRU_BeginExclusive_r(&volume_LRU.q[VLRU_QUEUE_NEW]);
6605         VLRU_Wait_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
6606         VLRU_BeginExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
6607     }
6608
6609     /* make sure multiple threads don't race to update */
6610     if (vp->vlru.idx == VLRU_QUEUE_CANDIDATE) {
6611         VLRU_SwitchQueues(vp, VLRU_QUEUE_NEW, 1);
6612     }
6613
6614     if (rvp) {
6615       VLRU_EndExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
6616       VLRU_EndExclusive_r(&volume_LRU.q[VLRU_QUEUE_NEW]);
6617       VCancelReservation_r(rvp);
6618     }
6619 }
6620
6621 /**
6622  * switch a volume between two VLRU queues.
6623  *
6624  * @param[in] vp       pointer to volume object
6625  * @param[in] new_idx  index of VLRU queue onto which the volume will be moved
6626  * @param[in] append   controls whether the volume will be appended or
6627  *                     prepended to the queue.  A nonzero value means it will
6628  *                     be appended; zero means it will be prepended.
6629  *
6630  * @pre The new (and old, if applicable) queue(s) must either be owned
6631  *      exclusively by the calling thread for asynchronous manipulation,
6632  *      or the queue(s) must be quiescent and VOL_LOCK must be held.
6633  *      Please see VLRU_BeginExclusive_r, VLRU_EndExclusive_r and VLRU_Wait_r
6634  *      for further details of the queue asynchronous processing mechanism.
6635  *
6636  * @post If the volume object was already on a VLRU queue, it is
6637  *       removed from the queue.  Depending on the value of the append
6638  *       parameter, the volume object is either appended or prepended
6639  *       to the VLRU queue referenced by the new_idx parameter.
6640  *
6641  * @note DAFS only
6642  *
6643  * @see VLRU_BeginExclusive_r
6644  * @see VLRU_EndExclusive_r
6645  * @see VLRU_Wait_r
6646  *
6647  * @internal volume package internal use only.
6648  */
6649 static void
6650 VLRU_SwitchQueues(Volume * vp, int new_idx, int append)
6651 {
6652     if (queue_IsNotOnQueue(&vp->vlru))
6653         return;
6654
6655     queue_Remove(&vp->vlru);
6656     volume_LRU.q[vp->vlru.idx].len--;
6657
6658     /* put the volume back on the correct generational queue */
6659     if (append) {
6660         queue_Append(&volume_LRU.q[new_idx], &vp->vlru);
6661     } else {
6662         queue_Prepend(&volume_LRU.q[new_idx], &vp->vlru);
6663     }
6664
6665     volume_LRU.q[new_idx].len++;
6666     vp->vlru.idx = new_idx;
6667 }
6668
6669 /**
6670  * VLRU background thread.
6671  *
6672  * The VLRU Scanner Thread is responsible for periodically scanning through
6673  * each VLRU queue looking for volumes which should be moved to another
6674  * queue, or soft detached.
6675  *
6676  * @param[in] args  unused thread arguments parameter
6677  *
6678  * @return unused thread return value
6679  *    @retval NULL always
6680  *
6681  * @internal volume package internal use only.
6682  */
6683 static void *
6684 VLRU_ScannerThread(void * args)
6685 {
6686     afs_uint32 now, min_delay, delay;
6687     int i, min_idx, min_op, overdue, state;
6688
6689     /* set t=0 for promotion cycle to be
6690      * fileserver startup */
6691     now = FT_ApproxTime();
6692     for (i=0; i < VLRU_GENERATIONS-1; i++) {
6693         volume_LRU.last_promotion[i] = now;
6694     }
6695
6696     /* don't start the scanner until VLRU_offline_thresh
6697      * plus a small delay for VInitVolumePackage2 to finish
6698      * has gone by */
6699
6700     sleep(VLRU_offline_thresh + 60);
6701
6702     /* set t=0 for scan cycle to be now */
6703     now = FT_ApproxTime();
6704     for (i=0; i < VLRU_GENERATIONS+1; i++) {
6705         volume_LRU.last_scan[i] = now;
6706     }
6707
6708     VOL_LOCK;
6709     if (volume_LRU.scanner_state == VLRU_SCANNER_STATE_OFFLINE) {
6710         volume_LRU.scanner_state = VLRU_SCANNER_STATE_ONLINE;
6711     }
6712
6713     while ((state = volume_LRU.scanner_state) != VLRU_SCANNER_STATE_SHUTTING_DOWN) {
6714         /* check to see if we've been asked to pause */
6715         if (volume_LRU.scanner_state == VLRU_SCANNER_STATE_PAUSING) {
6716             volume_LRU.scanner_state = VLRU_SCANNER_STATE_PAUSED;
6717             assert(pthread_cond_broadcast(&volume_LRU.cv) == 0);
6718             do {
6719                 VOL_CV_WAIT(&volume_LRU.cv);
6720             } while (volume_LRU.scanner_state == VLRU_SCANNER_STATE_PAUSED);
6721         }
6722
6723         /* scheduling can happen outside the glock */
6724         VOL_UNLOCK;
6725
6726         /* figure out what is next on the schedule */
6727
6728         /* figure out a potential schedule for the new generation first */
6729         overdue = 0;
6730         min_delay = volume_LRU.scan_interval[0] + volume_LRU.last_scan[0] - now;
6731         min_idx = 0;
6732         min_op = 0;
6733         if (min_delay > volume_LRU.scan_interval[0]) {
6734             /* unsigned overflow -- we're overdue to run this scan */
6735             min_delay = 0;
6736             overdue = 1;
6737         }
6738
6739         /* if we're not overdue for gen 0, figure out schedule for candidate gen */
6740         if (!overdue) {
6741             i = VLRU_QUEUE_CANDIDATE;
6742             delay = volume_LRU.scan_interval[i] + volume_LRU.last_scan[i] - now;
6743             if (delay < min_delay) {
6744                 min_delay = delay;
6745                 min_idx = i;
6746             }
6747             if (delay > volume_LRU.scan_interval[i]) {
6748                 /* unsigned overflow -- we're overdue to run this scan */
6749                 min_delay = 0;
6750                 min_idx = i;
6751                 overdue = 1;
6752             }
6753         }
6754
6755         /* if we're still not overdue for something, figure out schedules for promotions */
6756         for (i=0; !overdue && i < VLRU_GENERATIONS-1; i++) {
6757             delay = volume_LRU.promotion_interval[i] + volume_LRU.last_promotion[i] - now;
6758             if (delay < min_delay) {
6759                 min_delay = delay;
6760                 min_idx = i;
6761                 min_op = 1;
6762             }
6763             if (delay > volume_LRU.promotion_interval[i]) {
6764                 /* unsigned overflow -- we're overdue to run this promotion */
6765                 min_delay = 0;
6766                 min_idx = i;
6767                 min_op = 1;
6768                 overdue = 1;
6769                 break;
6770             }
6771         }
6772
6773         /* sleep as needed */
6774         if (min_delay) {
6775             sleep(min_delay);
6776         }
6777
6778         /* do whatever is next */
6779         VOL_LOCK;
6780         if (min_op) {
6781             VLRU_Promote_r(min_idx);
6782             VLRU_Demote_r(min_idx+1);
6783         } else {
6784             VLRU_Scan_r(min_idx);
6785         }
6786         now = FT_ApproxTime();
6787     }
6788
6789     Log("VLRU scanner asked to go offline (scanner_state=%d)\n", state);
6790
6791     /* signal that scanner is down */
6792     volume_LRU.scanner_state = VLRU_SCANNER_STATE_OFFLINE;
6793     assert(pthread_cond_broadcast(&volume_LRU.cv) == 0);
6794     VOL_UNLOCK;
6795     return NULL;
6796 }
6797
6798 /**
6799  * promote volumes from one VLRU generation to the next.
6800  *
6801  * This routine scans a VLRU generation looking for volumes which are
6802  * eligible to be promoted to the next generation.  All volumes which
6803  * meet the eligibility requirement are promoted.
6804  *
6805  * Promotion eligibility is based upon meeting both of the following
6806  * requirements:
6807  *
6808  *    @arg The volume has been accessed since the last promotion:
6809  *         @c (vp->stats.last_get >= vp->stats.last_promote)
6810  *    @arg The last promotion occurred at least
6811  *         @c volume_LRU.promotion_interval[idx] seconds ago
6812  *
6813  * As a performance optimization, promotions are "globbed".  In other
6814  * words, we promote arbitrarily large contiguous sublists of elements
6815  * as one operation.
6816  *
6817  * @param[in] idx  VLRU queue index to scan
6818  *
6819  * @note DAFS only
6820  *
6821  * @internal VLRU internal use only.
6822  */
6823 static void
6824 VLRU_Promote_r(int idx)
6825 {
6826     int len, chaining, promote;
6827     afs_uint32 now, thresh;
6828     struct rx_queue *qp, *nqp;
6829     Volume * vp, *start = NULL, *end = NULL;
6830
6831     /* get exclusive access to two chains, and drop the glock */
6832     VLRU_Wait_r(&volume_LRU.q[idx]);
6833     VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
6834     VLRU_Wait_r(&volume_LRU.q[idx+1]);
6835     VLRU_BeginExclusive_r(&volume_LRU.q[idx+1]);
6836     VOL_UNLOCK;
6837
6838     thresh = volume_LRU.promotion_interval[idx];
6839     now = FT_ApproxTime();
6840
6841     len = chaining = 0;
6842     for (queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
6843         vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
6844         promote = (((vp->stats.last_promote + thresh) <= now) &&
6845                    (vp->stats.last_get >= vp->stats.last_promote));
6846
6847         if (chaining) {
6848             if (promote) {
6849                 vp->vlru.idx++;
6850                 len++;
6851                 start = vp;
6852             } else {
6853                 /* promote and prepend chain */
6854                 queue_MoveChainAfter(&volume_LRU.q[idx+1], &start->vlru, &end->vlru);
6855                 chaining = 0;
6856             }
6857         } else {
6858             if (promote) {
6859                 vp->vlru.idx++;
6860                 len++;
6861                 chaining = 1;
6862                 start = end = vp;
6863             }
6864         }
6865     }
6866
6867     if (chaining) {
6868         /* promote and prepend */
6869         queue_MoveChainAfter(&volume_LRU.q[idx+1], &start->vlru, &end->vlru);
6870     }
6871
6872     if (len) {
6873         volume_LRU.q[idx].len -= len;
6874         volume_LRU.q[idx+1].len += len;
6875     }
6876
6877     /* release exclusive access to the two chains */
6878     VOL_LOCK;
6879     volume_LRU.last_promotion[idx] = now;
6880     VLRU_EndExclusive_r(&volume_LRU.q[idx+1]);
6881     VLRU_EndExclusive_r(&volume_LRU.q[idx]);
6882 }
6883
6884 /* run the demotions */
6885 static void
6886 VLRU_Demote_r(int idx)
6887 {
6888     Error ec;
6889     int len, chaining, demote;
6890     afs_uint32 now, thresh;
6891     struct rx_queue *qp, *nqp;
6892     Volume * vp, *start = NULL, *end = NULL;
6893     Volume ** salv_flag_vec = NULL;
6894     int salv_vec_offset = 0;
6895
6896     assert(idx == VLRU_QUEUE_MID || idx == VLRU_QUEUE_OLD);
6897
6898     /* get exclusive access to two chains, and drop the glock */
6899     VLRU_Wait_r(&volume_LRU.q[idx-1]);
6900     VLRU_BeginExclusive_r(&volume_LRU.q[idx-1]);
6901     VLRU_Wait_r(&volume_LRU.q[idx]);
6902     VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
6903     VOL_UNLOCK;
6904
6905     /* no big deal if this allocation fails */
6906     if (volume_LRU.q[idx].len) {
6907         salv_flag_vec = (Volume **) malloc(volume_LRU.q[idx].len * sizeof(Volume *));
6908     }
6909
6910     now = FT_ApproxTime();
6911     thresh = volume_LRU.promotion_interval[idx-1];
6912
6913     len = chaining = 0;
6914     for (queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
6915         vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
6916         demote = (((vp->stats.last_promote + thresh) <= now) &&
6917                   (vp->stats.last_get < (now - thresh)));
6918
6919         /* we now do volume update list DONT_SALVAGE flag setting during
6920          * demotion passes */
6921         if (salv_flag_vec &&
6922             !(V_attachFlags(vp) & VOL_HDR_DONTSALV) &&
6923             demote &&
6924             (vp->updateTime < (now - SALVAGE_INTERVAL)) &&
6925             (V_attachState(vp) == VOL_STATE_ATTACHED)) {
6926             salv_flag_vec[salv_vec_offset++] = vp;
6927             VCreateReservation_r(vp);
6928         }
6929
6930         if (chaining) {
6931             if (demote) {
6932                 vp->vlru.idx--;
6933                 len++;
6934                 start = vp;
6935             } else {
6936                 /* demote and append chain */
6937                 queue_MoveChainBefore(&volume_LRU.q[idx-1], &start->vlru, &end->vlru);
6938                 chaining = 0;
6939             }
6940         } else {
6941             if (demote) {
6942                 vp->vlru.idx--;
6943                 len++;
6944                 chaining = 1;
6945                 start = end = vp;
6946             }
6947         }
6948     }
6949
6950     if (chaining) {
6951         queue_MoveChainBefore(&volume_LRU.q[idx-1], &start->vlru, &end->vlru);
6952     }
6953
6954     if (len) {
6955         volume_LRU.q[idx].len -= len;
6956         volume_LRU.q[idx-1].len += len;
6957     }
6958
6959     /* release exclusive access to the two chains */
6960     VOL_LOCK;
6961     VLRU_EndExclusive_r(&volume_LRU.q[idx]);
6962     VLRU_EndExclusive_r(&volume_LRU.q[idx-1]);
6963
6964     /* now go back and set the DONT_SALVAGE flags as appropriate */
6965     if (salv_flag_vec) {
6966         int i;
6967         for (i = 0; i < salv_vec_offset; i++) {
6968             vp = salv_flag_vec[i];
6969             if (!(V_attachFlags(vp) & VOL_HDR_DONTSALV) &&
6970                 (vp->updateTime < (now - SALVAGE_INTERVAL)) &&
6971                 (V_attachState(vp) == VOL_STATE_ATTACHED)) {
6972                 ec = VHold_r(vp);
6973                 if (!ec) {
6974                     V_attachFlags(vp) |= VOL_HDR_DONTSALV;
6975                     V_dontSalvage(vp) = DONT_SALVAGE;
6976                     VUpdateVolume_r(&ec, vp, 0);
6977                     VPutVolume_r(vp);
6978                 }
6979             }
6980             VCancelReservation_r(vp);
6981         }
6982         free(salv_flag_vec);
6983     }
6984 }
6985
6986 /* run a pass of the VLRU GC scanner */
6987 static void
6988 VLRU_Scan_r(int idx)
6989 {
6990     afs_uint32 now, thresh;
6991     struct rx_queue *qp, *nqp;
6992     Volume * vp;
6993     int i, locked = 1;
6994
6995     assert(idx == VLRU_QUEUE_NEW || idx == VLRU_QUEUE_CANDIDATE);
6996
6997     /* gain exclusive access to the idx VLRU */
6998     VLRU_Wait_r(&volume_LRU.q[idx]);
6999     VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
7000
7001     if (idx != VLRU_QUEUE_CANDIDATE) {
7002         /* gain exclusive access to the candidate VLRU */
7003         VLRU_Wait_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7004         VLRU_BeginExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7005     }
7006
7007     now = FT_ApproxTime();
7008     thresh = now - VLRU_offline_thresh;
7009
7010     /* perform candidate selection and soft detaching */
7011     if (idx == VLRU_QUEUE_CANDIDATE) {
7012         /* soft detach some volumes from the candidate pool */
7013         VOL_UNLOCK;
7014         locked = 0;
7015
7016         for (i=0,queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
7017             vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
7018             if (i >= VLRU_offline_max) {
7019                 break;
7020             }
7021             /* check timestamp to see if it's a candidate for soft detaching */
7022             if (vp->stats.last_get <= thresh) {
7023                 VOL_LOCK;
7024                 if (VCheckSoftDetach(vp, thresh))
7025                     i++;
7026                 VOL_UNLOCK;
7027             }
7028         }
7029     } else {
7030         /* scan for volumes to become soft detach candidates */
7031         for (i=1,queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue),i++) {
7032             vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
7033
7034             /* check timestamp to see if it's a candidate for soft detaching */
7035             if (vp->stats.last_get <= thresh) {
7036                 VCheckSoftDetachCandidate(vp, thresh);
7037             }
7038
7039             if (!(i&0x7f)) {   /* lock coarsening optimization */
7040                 VOL_UNLOCK;
7041                 pthread_yield();
7042                 VOL_LOCK;
7043             }
7044         }
7045     }
7046
7047     /* relinquish exclusive access to the VLRU chains */
7048     if (!locked) {
7049         VOL_LOCK;
7050     }
7051     volume_LRU.last_scan[idx] = now;
7052     if (idx != VLRU_QUEUE_CANDIDATE) {
7053         VLRU_EndExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7054     }
7055     VLRU_EndExclusive_r(&volume_LRU.q[idx]);
7056 }
7057
7058 /* check whether volume is safe to soft detach
7059  * caller MUST NOT hold a ref count on vp */
7060 static int
7061 VCheckSoftDetach(Volume * vp, afs_uint32 thresh)
7062 {
7063     int ret=0;
7064
7065     if (vp->nUsers || vp->nWaiters)
7066         return 0;
7067
7068     if (vp->stats.last_get <= thresh) {
7069         ret = VSoftDetachVolume_r(vp, thresh);
7070     }
7071
7072     return ret;
7073 }
7074
7075 /* check whether volume should be made a
7076  * soft detach candidate */
7077 static int
7078 VCheckSoftDetachCandidate(Volume * vp, afs_uint32 thresh)
7079 {
7080     int idx, ret = 0;
7081     if (vp->nUsers || vp->nWaiters)
7082         return 0;
7083
7084     idx = vp->vlru.idx;
7085
7086     assert(idx == VLRU_QUEUE_NEW);
7087
7088     if (vp->stats.last_get <= thresh) {
7089         /* move to candidate pool */
7090         queue_Remove(&vp->vlru);
7091         volume_LRU.q[VLRU_QUEUE_NEW].len--;
7092         queue_Prepend(&volume_LRU.q[VLRU_QUEUE_CANDIDATE], &vp->vlru);
7093         vp->vlru.idx = VLRU_QUEUE_CANDIDATE;
7094         volume_LRU.q[VLRU_QUEUE_CANDIDATE].len++;
7095         ret = 1;
7096     }
7097
7098     return ret;
7099 }
7100
7101
7102 /* begin exclusive access on VLRU */
7103 static void
7104 VLRU_BeginExclusive_r(struct VLRU_q * q)
7105 {
7106     assert(q->busy == 0);
7107     q->busy = 1;
7108 }
7109
7110 /* end exclusive access on VLRU */
7111 static void
7112 VLRU_EndExclusive_r(struct VLRU_q * q)
7113 {
7114     assert(q->busy);
7115     q->busy = 0;
7116     assert(pthread_cond_broadcast(&q->cv) == 0);
7117 }
7118
7119 /* wait for another thread to end exclusive access on VLRU */
7120 static void
7121 VLRU_Wait_r(struct VLRU_q * q)
7122 {
7123     while(q->busy) {
7124         VOL_CV_WAIT(&q->cv);
7125     }
7126 }
7127
7128 /* demand attach fs
7129  * volume soft detach
7130  *
7131  * caller MUST NOT hold a ref count on vp */
7132 static int
7133 VSoftDetachVolume_r(Volume * vp, afs_uint32 thresh)
7134 {
7135     afs_uint32 ts_save;
7136     int ret = 0;
7137
7138     assert(vp->vlru.idx == VLRU_QUEUE_CANDIDATE);
7139
7140     ts_save = vp->stats.last_get;
7141     if (ts_save > thresh)
7142         return 0;
7143
7144     if (vp->nUsers || vp->nWaiters)
7145         return 0;
7146
7147     if (VIsExclusiveState(V_attachState(vp))) {
7148         return 0;
7149     }
7150
7151     switch (V_attachState(vp)) {
7152     case VOL_STATE_UNATTACHED:
7153     case VOL_STATE_PREATTACHED:
7154     case VOL_STATE_ERROR:
7155     case VOL_STATE_GOING_OFFLINE:
7156     case VOL_STATE_SHUTTING_DOWN:
7157     case VOL_STATE_SALVAGING:
7158         volume_LRU.q[vp->vlru.idx].len--;
7159
7160         /* create and cancel a reservation to
7161          * give the volume an opportunity to
7162          * be deallocated */
7163         VCreateReservation_r(vp);
7164         queue_Remove(&vp->vlru);
7165         vp->vlru.idx = VLRU_QUEUE_INVALID;
7166         V_attachFlags(vp) &= ~(VOL_ON_VLRU);
7167         VCancelReservation_r(vp);
7168         return 0;
7169     default:
7170         break;
7171     }
7172
7173     /* hold the volume and take it offline.
7174      * no need for reservations, as VHold_r
7175      * takes care of that internally. */
7176     if (VHold_r(vp) == 0) {
7177         /* vhold drops the glock, so now we should
7178          * check to make sure we aren't racing against
7179          * other threads.  if we are racing, offlining vp
7180          * would be wasteful, and block the scanner for a while
7181          */
7182         if (vp->nWaiters ||
7183             (vp->nUsers > 1) ||
7184             (vp->shuttingDown) ||
7185             (vp->goingOffline) ||
7186             (vp->stats.last_get != ts_save)) {
7187             /* looks like we're racing someone else. bail */
7188             VPutVolume_r(vp);
7189             vp = NULL;
7190         } else {
7191             /* pull it off the VLRU */
7192             assert(vp->vlru.idx == VLRU_QUEUE_CANDIDATE);
7193             volume_LRU.q[VLRU_QUEUE_CANDIDATE].len--;
7194             queue_Remove(&vp->vlru);
7195             vp->vlru.idx = VLRU_QUEUE_INVALID;
7196             V_attachFlags(vp) &= ~(VOL_ON_VLRU);
7197
7198             /* take if offline */
7199             VOffline_r(vp, "volume has been soft detached");
7200
7201             /* invalidate the volume header cache */
7202             FreeVolumeHeader(vp);
7203
7204             /* update stats */
7205             IncUInt64(&VStats.soft_detaches);
7206             vp->stats.soft_detaches++;
7207
7208             /* put in pre-attached state so demand
7209              * attacher can work on it */
7210             VChangeState_r(vp, VOL_STATE_PREATTACHED);
7211             ret = 1;
7212         }
7213     }
7214     return ret;
7215 }
7216 #endif /* AFS_DEMAND_ATTACH_FS */
7217
7218
7219 /***************************************************/
7220 /* Volume Header Cache routines                    */
7221 /***************************************************/
7222
7223 /**
7224  * volume header cache.
7225  */
7226 struct volume_hdr_LRU_t volume_hdr_LRU;
7227
7228 /**
7229  * initialize the volume header cache.
7230  *
7231  * @param[in] howMany  number of header cache entries to preallocate
7232  *
7233  * @pre VOL_LOCK held.  Function has never been called before.
7234  *
7235  * @post howMany cache entries are allocated, initialized, and added
7236  *       to the LRU list.  Header cache statistics are initialized.
7237  *
7238  * @note only applicable to fileServer program type.  Should only be
7239  *       called once during volume package initialization.
7240  *
7241  * @internal volume package internal use only.
7242  */
7243 static void
7244 VInitVolumeHeaderCache(afs_uint32 howMany)
7245 {
7246     register struct volHeader *hp;
7247     if (programType != fileServer)
7248         return;
7249     queue_Init(&volume_hdr_LRU);
7250     volume_hdr_LRU.stats.free = 0;
7251     volume_hdr_LRU.stats.used = howMany;
7252     volume_hdr_LRU.stats.attached = 0;
7253     hp = (struct volHeader *)(calloc(howMany, sizeof(struct volHeader)));
7254     assert(hp != NULL);
7255
7256     while (howMany--)
7257         /* We are using ReleaseVolumeHeader to initialize the values on the header list
7258          * to ensure they have the right values
7259          */
7260         ReleaseVolumeHeader(hp++);
7261 }
7262
7263 /**
7264  * get a volume header and attach it to the volume object.
7265  *
7266  * @param[in] vp  pointer to volume object
7267  *
7268  * @return cache entry status
7269  *    @retval 0  volume header was newly attached; cache data is invalid
7270  *    @retval 1  volume header was previously attached; cache data is valid
7271  *
7272  * @pre VOL_LOCK held.  For DAFS, lightweight ref must be held on volume object.
7273  *
7274  * @post volume header attached to volume object.  if necessary, header cache
7275  *       entry on LRU is synchronized to disk.  Header is removed from LRU list.
7276  *
7277  * @note VOL_LOCK may be dropped
7278  *
7279  * @warning this interface does not load header data from disk.  it merely
7280  *          attaches a header object to the volume object, and may sync the old
7281  *          header cache data out to disk in the process.
7282  *
7283  * @internal volume package internal use only.
7284  */
7285 static int
7286 GetVolumeHeader(register Volume * vp)
7287 {
7288     Error error;
7289     register struct volHeader *hd;
7290     int old;
7291     static int everLogged = 0;
7292
7293 #ifdef AFS_DEMAND_ATTACH_FS
7294     VolState vp_save = 0, back_save = 0;
7295
7296     /* XXX debug 9/19/05 we've apparently got
7297      * a ref counting bug somewhere that's
7298      * breaking the nUsers == 0 => header on LRU
7299      * assumption */
7300     if (vp->header && queue_IsNotOnQueue(vp->header)) {
7301         Log("nUsers == 0, but header not on LRU\n");
7302         return 1;
7303     }
7304 #endif
7305
7306     old = (vp->header != NULL); /* old == volume already has a header */
7307
7308     if (programType != fileServer) {
7309         /* for volume utilities, we allocate volHeaders as needed */
7310         if (!vp->header) {
7311             hd = (struct volHeader *)calloc(1, sizeof(*vp->header));
7312             assert(hd != NULL);
7313             vp->header = hd;
7314             hd->back = vp;
7315 #ifdef AFS_DEMAND_ATTACH_FS
7316             V_attachFlags(vp) |= VOL_HDR_ATTACHED;
7317 #endif
7318         }
7319     } else {
7320         /* for the fileserver, we keep a volume header cache */
7321         if (old) {
7322             /* the header we previously dropped in the lru is
7323              * still available. pull it off the lru and return */
7324             hd = vp->header;
7325             queue_Remove(hd);
7326             assert(hd->back == vp);
7327 #ifdef AFS_DEMAND_ATTACH_FS
7328             V_attachFlags(vp) &= ~(VOL_HDR_IN_LRU);
7329 #endif
7330         } else {
7331             /* we need to grab a new element off the LRU */
7332             if (queue_IsNotEmpty(&volume_hdr_LRU)) {
7333                 /* grab an element and pull off of LRU */
7334                 hd = queue_First(&volume_hdr_LRU, volHeader);
7335                 queue_Remove(hd);
7336             } else {
7337                 /* LRU is empty, so allocate a new volHeader
7338                  * this is probably indicative of a leak, so let the user know */
7339                 hd = (struct volHeader *)calloc(1, sizeof(struct volHeader));
7340                 assert(hd != NULL);
7341                 if (!everLogged) {
7342                     Log("****Allocated more volume headers, probably leak****\n");
7343                     everLogged = 1;
7344                 }
7345                 volume_hdr_LRU.stats.free++;
7346             }
7347             if (hd->back) {
7348                 /* this header used to belong to someone else.
7349                  * we'll need to check if the header needs to
7350                  * be sync'd out to disk */
7351
7352 #ifdef AFS_DEMAND_ATTACH_FS
7353                 /* if hd->back were in an exclusive state, then
7354                  * its volHeader would not be on the LRU... */
7355                 assert(!VIsExclusiveState(V_attachState(hd->back)));
7356 #endif
7357
7358                 if (hd->diskstuff.inUse) {
7359                     /* volume was in use, so we'll need to sync
7360                      * its header to disk */
7361
7362 #ifdef AFS_DEMAND_ATTACH_FS
7363                     back_save = VChangeState_r(hd->back, VOL_STATE_UPDATING);
7364                     vp_save = VChangeState_r(vp, VOL_STATE_HDR_ATTACHING);
7365                     VCreateReservation_r(hd->back);
7366                     VOL_UNLOCK;
7367 #endif
7368
7369                     WriteVolumeHeader_r(&error, hd->back);
7370                     /* Ignore errors; catch them later */
7371
7372 #ifdef AFS_DEMAND_ATTACH_FS
7373                     VOL_LOCK;
7374 #endif
7375                 }
7376
7377                 hd->back->header = NULL;
7378 #ifdef AFS_DEMAND_ATTACH_FS
7379                 V_attachFlags(hd->back) &= ~(VOL_HDR_ATTACHED | VOL_HDR_LOADED | VOL_HDR_IN_LRU);
7380
7381                 if (hd->diskstuff.inUse) {
7382                     VChangeState_r(hd->back, back_save);
7383                     VCancelReservation_r(hd->back);
7384                     VChangeState_r(vp, vp_save);
7385                 }
7386 #endif
7387             } else {
7388                 volume_hdr_LRU.stats.attached++;
7389             }
7390             hd->back = vp;
7391             vp->header = hd;
7392 #ifdef AFS_DEMAND_ATTACH_FS
7393             V_attachFlags(vp) |= VOL_HDR_ATTACHED;
7394 #endif
7395         }
7396         volume_hdr_LRU.stats.free--;
7397         volume_hdr_LRU.stats.used++;
7398     }
7399     IncUInt64(&VStats.hdr_gets);
7400 #ifdef AFS_DEMAND_ATTACH_FS
7401     IncUInt64(&vp->stats.hdr_gets);
7402     vp->stats.last_hdr_get = FT_ApproxTime();
7403 #endif
7404     return old;
7405 }
7406
7407
7408 /**
7409  * make sure volume header is attached and contains valid cache data.
7410  *
7411  * @param[out] ec  outbound error code
7412  * @param[in]  vp  pointer to volume object
7413  *
7414  * @pre VOL_LOCK held.  For DAFS, lightweight ref held on vp.
7415  *
7416  * @post header cache entry attached, and loaded with valid data, or
7417  *       *ec is nonzero, and the header is released back into the LRU.
7418  *
7419  * @internal volume package internal use only.
7420  */
7421 static void
7422 LoadVolumeHeader(Error * ec, Volume * vp)
7423 {
7424 #ifdef AFS_DEMAND_ATTACH_FS
7425     VolState state_save;
7426     afs_uint32 now;
7427     *ec = 0;
7428
7429     if (vp->nUsers == 0 && !GetVolumeHeader(vp)) {
7430         IncUInt64(&VStats.hdr_loads);
7431         state_save = VChangeState_r(vp, VOL_STATE_HDR_LOADING);
7432         VOL_UNLOCK;
7433
7434         ReadHeader(ec, V_diskDataHandle(vp), (char *)&V_disk(vp),
7435                    sizeof(V_disk(vp)), VOLUMEINFOMAGIC,
7436                    VOLUMEINFOVERSION);
7437         IncUInt64(&vp->stats.hdr_loads);
7438         now = FT_ApproxTime();
7439
7440         VOL_LOCK;
7441         if (!*ec) {
7442             V_attachFlags(vp) |= VOL_HDR_LOADED;
7443             vp->stats.last_hdr_load = now;
7444         }
7445         VChangeState_r(vp, state_save);
7446     }
7447 #else /* AFS_DEMAND_ATTACH_FS */
7448     *ec = 0;
7449     if (vp->nUsers == 0 && !GetVolumeHeader(vp)) {
7450         IncUInt64(&VStats.hdr_loads);
7451
7452         ReadHeader(ec, V_diskDataHandle(vp), (char *)&V_disk(vp),
7453                    sizeof(V_disk(vp)), VOLUMEINFOMAGIC,
7454                    VOLUMEINFOVERSION);
7455     }
7456 #endif /* AFS_DEMAND_ATTACH_FS */
7457     if (*ec) {
7458         /* maintain (nUsers==0) => header in LRU invariant */
7459         FreeVolumeHeader(vp);
7460     }
7461 }
7462
7463 /**
7464  * release a header cache entry back into the LRU list.
7465  *
7466  * @param[in] hd  pointer to volume header cache object
7467  *
7468  * @pre VOL_LOCK held.
7469  *
7470  * @post header cache object appended onto end of LRU list.
7471  *
7472  * @note only applicable to fileServer program type.
7473  *
7474  * @note used to place a header cache entry back into the
7475  *       LRU pool without invalidating it as a cache entry.
7476  *
7477  * @internal volume package internal use only.
7478  */
7479 static void
7480 ReleaseVolumeHeader(register struct volHeader *hd)
7481 {
7482     if (programType != fileServer)
7483         return;
7484     if (!hd || queue_IsOnQueue(hd))     /* no header, or header already released */
7485         return;
7486     queue_Append(&volume_hdr_LRU, hd);
7487 #ifdef AFS_DEMAND_ATTACH_FS
7488     if (hd->back) {
7489         V_attachFlags(hd->back) |= VOL_HDR_IN_LRU;
7490     }
7491 #endif
7492     volume_hdr_LRU.stats.free++;
7493     volume_hdr_LRU.stats.used--;
7494 }
7495
7496 /**
7497  * free/invalidate a volume header cache entry.
7498  *
7499  * @param[in] vp  pointer to volume object
7500  *
7501  * @pre VOL_LOCK is held.
7502  *
7503  * @post For fileserver, header cache entry is returned to LRU, and it is
7504  *       invalidated as a cache entry.  For volume utilities, the header
7505  *       cache entry is freed.
7506  *
7507  * @note For fileserver, this should be utilized instead of ReleaseVolumeHeader
7508  *       whenever it is necessary to invalidate the header cache entry.
7509  *
7510  * @see ReleaseVolumeHeader
7511  *
7512  * @internal volume package internal use only.
7513  */
7514 static void
7515 FreeVolumeHeader(register Volume * vp)
7516 {
7517     register struct volHeader *hd = vp->header;
7518     if (!hd)
7519         return;
7520     if (programType == fileServer) {
7521         ReleaseVolumeHeader(hd);
7522         hd->back = NULL;
7523     } else {
7524         free(hd);
7525     }
7526 #ifdef AFS_DEMAND_ATTACH_FS
7527     V_attachFlags(vp) &= ~(VOL_HDR_ATTACHED | VOL_HDR_IN_LRU | VOL_HDR_LOADED);
7528 #endif
7529     volume_hdr_LRU.stats.attached--;
7530     vp->header = NULL;
7531 }
7532
7533
7534 /***************************************************/
7535 /* Volume Hash Table routines                      */
7536 /***************************************************/
7537
7538 /**
7539  * set size of volume object hash table.
7540  *
7541  * @param[in] logsize   log(2) of desired hash table size
7542  *
7543  * @return operation status
7544  *    @retval 0 success
7545  *    @retval -1 failure
7546  *
7547  * @pre MUST be called prior to VInitVolumePackage2
7548  *
7549  * @post Volume Hash Table will have 2^logsize buckets
7550  */
7551 int
7552 VSetVolHashSize(int logsize)
7553 {
7554     /* 64 to 16384 hash buckets seems like a reasonable range */
7555     if ((logsize < 6 ) || (logsize > 14)) {
7556         return -1;
7557     }
7558
7559     if (!VInit) {
7560         VolumeHashTable.Size = 1 << logsize;
7561         VolumeHashTable.Mask = VolumeHashTable.Size - 1;
7562     } else {
7563         /* we can't yet support runtime modification of this
7564          * parameter. we'll need a configuration rwlock to
7565          * make runtime modification feasible.... */
7566         return -1;
7567     }
7568     return 0;
7569 }
7570
7571 /**
7572  * initialize dynamic data structures for volume hash table.
7573  *
7574  * @post hash table is allocated, and fields are initialized.
7575  *
7576  * @internal volume package internal use only.
7577  */
7578 static void
7579 VInitVolumeHash(void)
7580 {
7581     register int i;
7582
7583     VolumeHashTable.Table = (VolumeHashChainHead *) calloc(VolumeHashTable.Size,
7584                                                            sizeof(VolumeHashChainHead));
7585     assert(VolumeHashTable.Table != NULL);
7586
7587     for (i=0; i < VolumeHashTable.Size; i++) {
7588         queue_Init(&VolumeHashTable.Table[i]);
7589 #ifdef AFS_DEMAND_ATTACH_FS
7590         assert(pthread_cond_init(&VolumeHashTable.Table[i].chain_busy_cv, NULL) == 0);
7591 #endif /* AFS_DEMAND_ATTACH_FS */
7592     }
7593 }
7594
7595 /**
7596  * add a volume object to the hash table.
7597  *
7598  * @param[in] vp      pointer to volume object
7599  * @param[in] hashid  hash of volume id
7600  *
7601  * @pre VOL_LOCK is held.  For DAFS, caller must hold a lightweight
7602  *      reference on vp.
7603  *
7604  * @post volume is added to hash chain.
7605  *
7606  * @internal volume package internal use only.
7607  *
7608  * @note For DAFS, VOL_LOCK may be dropped in order to wait for an
7609  *       asynchronous hash chain reordering to finish.
7610  */
7611 static void
7612 AddVolumeToHashTable(register Volume * vp, int hashid)
7613 {
7614     VolumeHashChainHead * head;
7615
7616     if (queue_IsOnQueue(vp))
7617         return;
7618
7619     head = &VolumeHashTable.Table[VOLUME_HASH(hashid)];
7620
7621 #ifdef AFS_DEMAND_ATTACH_FS
7622     /* wait for the hash chain to become available */
7623     VHashWait_r(head);
7624
7625     V_attachFlags(vp) |= VOL_IN_HASH;
7626     vp->chainCacheCheck = ++head->cacheCheck;
7627 #endif /* AFS_DEMAND_ATTACH_FS */
7628
7629     head->len++;
7630     vp->hashid = hashid;
7631     queue_Append(head, vp);
7632     vp->vnodeHashOffset = VolumeHashOffset_r();
7633 }
7634
7635 /**
7636  * delete a volume object from the hash table.
7637  *
7638  * @param[in] vp  pointer to volume object
7639  *
7640  * @pre VOL_LOCK is held.  For DAFS, caller must hold a lightweight
7641  *      reference on vp.
7642  *
7643  * @post volume is removed from hash chain.
7644  *
7645  * @internal volume package internal use only.
7646  *
7647  * @note For DAFS, VOL_LOCK may be dropped in order to wait for an
7648  *       asynchronous hash chain reordering to finish.
7649  */
7650 static void
7651 DeleteVolumeFromHashTable(register Volume * vp)
7652 {
7653     VolumeHashChainHead * head;
7654
7655     if (!queue_IsOnQueue(vp))
7656         return;
7657
7658     head = &VolumeHashTable.Table[VOLUME_HASH(vp->hashid)];
7659
7660 #ifdef AFS_DEMAND_ATTACH_FS
7661     /* wait for the hash chain to become available */
7662     VHashWait_r(head);
7663
7664     V_attachFlags(vp) &= ~(VOL_IN_HASH);
7665     head->cacheCheck++;
7666 #endif /* AFS_DEMAND_ATTACH_FS */
7667
7668     head->len--;
7669     queue_Remove(vp);
7670     /* do NOT reset hashid to zero, as the online
7671      * salvager package may need to know the volume id
7672      * after the volume is removed from the hash */
7673 }
7674
7675 /**
7676  * lookup a volume object in the hash table given a volume id.
7677  *
7678  * @param[out] ec        error code return
7679  * @param[in]  volumeId  volume id
7680  * @param[in]  hint      volume object which we believe could be the correct
7681                          mapping
7682  *
7683  * @return volume object pointer
7684  *    @retval NULL  no such volume id is registered with the hash table.
7685  *
7686  * @pre VOL_LOCK is held.  For DAFS, caller must hold a lightweight
7687         ref on hint.
7688  *
7689  * @post volume object with the given id is returned.  volume object and
7690  *       hash chain access statistics are updated.  hash chain may have
7691  *       been reordered.
7692  *
7693  * @note For DAFS, VOL_LOCK may be dropped in order to wait for an
7694  *       asynchronous hash chain reordering operation to finish, or
7695  *       in order for us to perform an asynchronous chain reordering.
7696  *
7697  * @note Hash chain reorderings occur when the access count for the
7698  *       volume object being looked up exceeds the sum of the previous
7699  *       node's (the node ahead of it in the hash chain linked list)
7700  *       access count plus the constant VOLUME_HASH_REORDER_THRESHOLD.
7701  *
7702  * @note For DAFS, the hint parameter allows us to short-circuit if the
7703  *       cacheCheck fields match between the hash chain head and the
7704  *       hint volume object.
7705  */
7706 Volume *
7707 VLookupVolume_r(Error * ec, VolId volumeId, Volume * hint)
7708 {
7709     register int looks = 0;
7710     Volume * vp, *np;
7711 #ifdef AFS_DEMAND_ATTACH_FS
7712     Volume *pp;
7713 #endif
7714     VolumeHashChainHead * head;
7715     *ec = 0;
7716
7717     head = &VolumeHashTable.Table[VOLUME_HASH(volumeId)];
7718
7719 #ifdef AFS_DEMAND_ATTACH_FS
7720     /* wait for the hash chain to become available */
7721     VHashWait_r(head);
7722
7723     /* check to see if we can short circuit without walking the hash chain */
7724     if (hint && (hint->chainCacheCheck == head->cacheCheck)) {
7725         IncUInt64(&hint->stats.hash_short_circuits);
7726         return hint;
7727     }
7728 #endif /* AFS_DEMAND_ATTACH_FS */
7729
7730     /* someday we need to either do per-chain locks, RWlocks,
7731      * or both for volhash access.
7732      * (and move to a data structure with better cache locality) */
7733
7734     /* search the chain for this volume id */
7735     for(queue_Scan(head, vp, np, Volume)) {
7736         looks++;
7737         if ((vp->hashid == volumeId)) {
7738             break;
7739         }
7740     }
7741
7742     if (queue_IsEnd(head, vp)) {
7743         vp = NULL;
7744     }
7745
7746 #ifdef AFS_DEMAND_ATTACH_FS
7747     /* update hash chain statistics */
7748     {
7749         afs_uint64 lks;
7750         FillInt64(lks, 0, looks);
7751         AddUInt64(head->looks, lks, &head->looks);
7752         AddUInt64(VStats.hash_looks, lks, &VStats.hash_looks);
7753         IncUInt64(&head->gets);
7754     }
7755
7756     if (vp) {
7757         afs_uint64 thresh;
7758         IncUInt64(&vp->stats.hash_lookups);
7759
7760         /* for demand attach fileserver, we permit occasional hash chain reordering
7761          * so that frequently looked up volumes move towards the head of the chain */
7762         pp = queue_Prev(vp, Volume);
7763         if (!queue_IsEnd(head, pp)) {
7764             FillInt64(thresh, 0, VOLUME_HASH_REORDER_THRESHOLD);
7765             AddUInt64(thresh, pp->stats.hash_lookups, &thresh);
7766             if (GEInt64(vp->stats.hash_lookups, thresh)) {
7767                 VReorderHash_r(head, pp, vp);
7768             }
7769         }
7770
7771         /* update the short-circuit cache check */
7772         vp->chainCacheCheck = head->cacheCheck;
7773     }
7774 #endif /* AFS_DEMAND_ATTACH_FS */
7775
7776     return vp;
7777 }
7778
7779 #ifdef AFS_DEMAND_ATTACH_FS
7780 /* perform volume hash chain reordering.
7781  *
7782  * advance a subchain beginning at vp ahead of
7783  * the adjacent subchain ending at pp */
7784 static void
7785 VReorderHash_r(VolumeHashChainHead * head, Volume * pp, Volume * vp)
7786 {
7787     Volume *tp, *np, *lp;
7788     afs_uint64 move_thresh;
7789
7790     /* this should never be called if the chain is already busy, so
7791      * no need to wait for other exclusive chain ops to finish */
7792
7793     /* this is a rather heavy set of operations,
7794      * so let's set the chain busy flag and drop
7795      * the vol_glock */
7796     VHashBeginExclusive_r(head);
7797     VOL_UNLOCK;
7798
7799     /* scan forward in the chain from vp looking for the last element
7800      * in the chain we want to advance */
7801     FillInt64(move_thresh, 0, VOLUME_HASH_REORDER_CHAIN_THRESH);
7802     AddUInt64(move_thresh, pp->stats.hash_lookups, &move_thresh);
7803     for(queue_ScanFrom(head, vp, tp, np, Volume)) {
7804         if (LTInt64(tp->stats.hash_lookups, move_thresh)) {
7805             break;
7806         }
7807     }
7808     lp = queue_Prev(tp, Volume);
7809
7810     /* scan backwards from pp to determine where to splice and
7811      * insert the subchain we're advancing */
7812     for(queue_ScanBackwardsFrom(head, pp, tp, np, Volume)) {
7813         if (GTInt64(tp->stats.hash_lookups, move_thresh)) {
7814             break;
7815         }
7816     }
7817     tp = queue_Next(tp, Volume);
7818
7819     /* rebalance chain(vp,...,lp) ahead of chain(tp,...,pp) */
7820     queue_MoveChainBefore(tp,vp,lp);
7821
7822     VOL_LOCK;
7823     IncUInt64(&VStats.hash_reorders);
7824     head->cacheCheck++;
7825     IncUInt64(&head->reorders);
7826
7827     /* wake up any threads waiting for the hash chain */
7828     VHashEndExclusive_r(head);
7829 }
7830
7831
7832 /* demand-attach fs volume hash
7833  * asynchronous exclusive operations */
7834
7835 /**
7836  * begin an asynchronous exclusive operation on a volume hash chain.
7837  *
7838  * @param[in] head   pointer to volume hash chain head object
7839  *
7840  * @pre VOL_LOCK held.  hash chain is quiescent.
7841  *
7842  * @post hash chain marked busy.
7843  *
7844  * @note this interface is used in conjunction with VHashEndExclusive_r and
7845  *       VHashWait_r to perform asynchronous (wrt VOL_LOCK) operations on a
7846  *       volume hash chain.  Its main use case is hash chain reordering, which
7847  *       has the potential to be a highly latent operation.
7848  *
7849  * @see VHashEndExclusive_r
7850  * @see VHashWait_r
7851  *
7852  * @note DAFS only
7853  *
7854  * @internal volume package internal use only.
7855  */
7856 static void
7857 VHashBeginExclusive_r(VolumeHashChainHead * head)
7858 {
7859     assert(head->busy == 0);
7860     head->busy = 1;
7861 }
7862
7863 /**
7864  * relinquish exclusive ownership of a volume hash chain.
7865  *
7866  * @param[in] head   pointer to volume hash chain head object
7867  *
7868  * @pre VOL_LOCK held.  thread owns the hash chain exclusively.
7869  *
7870  * @post hash chain is marked quiescent.  threads awaiting use of
7871  *       chain are awakened.
7872  *
7873  * @see VHashBeginExclusive_r
7874  * @see VHashWait_r
7875  *
7876  * @note DAFS only
7877  *
7878  * @internal volume package internal use only.
7879  */
7880 static void
7881 VHashEndExclusive_r(VolumeHashChainHead * head)
7882 {
7883     assert(head->busy);
7884     head->busy = 0;
7885     assert(pthread_cond_broadcast(&head->chain_busy_cv) == 0);
7886 }
7887
7888 /**
7889  * wait for all asynchronous operations on a hash chain to complete.
7890  *
7891  * @param[in] head   pointer to volume hash chain head object
7892  *
7893  * @pre VOL_LOCK held.
7894  *
7895  * @post hash chain object is quiescent.
7896  *
7897  * @see VHashBeginExclusive_r
7898  * @see VHashEndExclusive_r
7899  *
7900  * @note DAFS only
7901  *
7902  * @note This interface should be called before any attempt to
7903  *       traverse the hash chain.  It is permissible for a thread
7904  *       to gain exclusive access to the chain, and then perform
7905  *       latent operations on the chain asynchronously wrt the
7906  *       VOL_LOCK.
7907  *
7908  * @warning if waiting is necessary, VOL_LOCK is dropped
7909  *
7910  * @internal volume package internal use only.
7911  */
7912 static void
7913 VHashWait_r(VolumeHashChainHead * head)
7914 {
7915     while (head->busy) {
7916         VOL_CV_WAIT(&head->chain_busy_cv);
7917     }
7918 }
7919 #endif /* AFS_DEMAND_ATTACH_FS */
7920
7921
7922 /***************************************************/
7923 /* Volume by Partition List routines               */
7924 /***************************************************/
7925
7926 /*
7927  * demand attach fileserver adds a
7928  * linked list of volumes to each
7929  * partition object, thus allowing
7930  * for quick enumeration of all
7931  * volumes on a partition
7932  */
7933
7934 #ifdef AFS_DEMAND_ATTACH_FS
7935 /**
7936  * add a volume to its disk partition VByPList.
7937  *
7938  * @param[in] vp  pointer to volume object
7939  *
7940  * @pre either the disk partition VByPList is owned exclusively
7941  *      by the calling thread, or the list is quiescent and
7942  *      VOL_LOCK is held.
7943  *
7944  * @post volume is added to disk partition VByPList
7945  *
7946  * @note DAFS only
7947  *
7948  * @warning it is the caller's responsibility to ensure list
7949  *          quiescence.
7950  *
7951  * @see VVByPListWait_r
7952  * @see VVByPListBeginExclusive_r
7953  * @see VVByPListEndExclusive_r
7954  *
7955  * @internal volume package internal use only.
7956  */
7957 static void
7958 AddVolumeToVByPList_r(Volume * vp)
7959 {
7960     if (queue_IsNotOnQueue(&vp->vol_list)) {
7961         queue_Append(&vp->partition->vol_list, &vp->vol_list);
7962         V_attachFlags(vp) |= VOL_ON_VBYP_LIST;
7963         vp->partition->vol_list.len++;
7964     }
7965 }
7966
7967 /**
7968  * delete a volume from its disk partition VByPList.
7969  *
7970  * @param[in] vp  pointer to volume object
7971  *
7972  * @pre either the disk partition VByPList is owned exclusively
7973  *      by the calling thread, or the list is quiescent and
7974  *      VOL_LOCK is held.
7975  *
7976  * @post volume is removed from the disk partition VByPList
7977  *
7978  * @note DAFS only
7979  *
7980  * @warning it is the caller's responsibility to ensure list
7981  *          quiescence.
7982  *
7983  * @see VVByPListWait_r
7984  * @see VVByPListBeginExclusive_r
7985  * @see VVByPListEndExclusive_r
7986  *
7987  * @internal volume package internal use only.
7988  */
7989 static void
7990 DeleteVolumeFromVByPList_r(Volume * vp)
7991 {
7992     if (queue_IsOnQueue(&vp->vol_list)) {
7993         queue_Remove(&vp->vol_list);
7994         V_attachFlags(vp) &= ~(VOL_ON_VBYP_LIST);
7995         vp->partition->vol_list.len--;
7996     }
7997 }
7998
7999 /**
8000  * begin an asynchronous exclusive operation on a VByPList.
8001  *
8002  * @param[in] dp   pointer to disk partition object
8003  *
8004  * @pre VOL_LOCK held.  VByPList is quiescent.
8005  *
8006  * @post VByPList marked busy.
8007  *
8008  * @note this interface is used in conjunction with VVByPListEndExclusive_r and
8009  *       VVByPListWait_r to perform asynchronous (wrt VOL_LOCK) operations on a
8010  *       VByPList.
8011  *
8012  * @see VVByPListEndExclusive_r
8013  * @see VVByPListWait_r
8014  *
8015  * @note DAFS only
8016  *
8017  * @internal volume package internal use only.
8018  */
8019 /* take exclusive control over the list */
8020 static void
8021 VVByPListBeginExclusive_r(struct DiskPartition64 * dp)
8022 {
8023     assert(dp->vol_list.busy == 0);
8024     dp->vol_list.busy = 1;
8025 }
8026
8027 /**
8028  * relinquish exclusive ownership of a VByPList.
8029  *
8030  * @param[in] dp   pointer to disk partition object
8031  *
8032  * @pre VOL_LOCK held.  thread owns the VByPList exclusively.
8033  *
8034  * @post VByPList is marked quiescent.  threads awaiting use of
8035  *       the list are awakened.
8036  *
8037  * @see VVByPListBeginExclusive_r
8038  * @see VVByPListWait_r
8039  *
8040  * @note DAFS only
8041  *
8042  * @internal volume package internal use only.
8043  */
8044 static void
8045 VVByPListEndExclusive_r(struct DiskPartition64 * dp)
8046 {
8047     assert(dp->vol_list.busy);
8048     dp->vol_list.busy = 0;
8049     assert(pthread_cond_broadcast(&dp->vol_list.cv) == 0);
8050 }
8051
8052 /**
8053  * wait for all asynchronous operations on a VByPList to complete.
8054  *
8055  * @param[in] dp  pointer to disk partition object
8056  *
8057  * @pre VOL_LOCK is held.
8058  *
8059  * @post disk partition's VByP list is quiescent
8060  *
8061  * @note DAFS only
8062  *
8063  * @note This interface should be called before any attempt to
8064  *       traverse the VByPList.  It is permissible for a thread
8065  *       to gain exclusive access to the list, and then perform
8066  *       latent operations on the list asynchronously wrt the
8067  *       VOL_LOCK.
8068  *
8069  * @warning if waiting is necessary, VOL_LOCK is dropped
8070  *
8071  * @see VVByPListEndExclusive_r
8072  * @see VVByPListBeginExclusive_r
8073  *
8074  * @internal volume package internal use only.
8075  */
8076 static void
8077 VVByPListWait_r(struct DiskPartition64 * dp)
8078 {
8079     while (dp->vol_list.busy) {
8080         VOL_CV_WAIT(&dp->vol_list.cv);
8081     }
8082 }
8083 #endif /* AFS_DEMAND_ATTACH_FS */
8084
8085 /***************************************************/
8086 /* Volume Cache Statistics routines                */
8087 /***************************************************/
8088
8089 void
8090 VPrintCacheStats_r(void)
8091 {
8092     afs_uint32 get_hi, get_lo, load_hi, load_lo;
8093     register struct VnodeClassInfo *vcp;
8094     vcp = &VnodeClassInfo[vLarge];
8095     Log("Large vnode cache, %d entries, %d allocs, %d gets (%d reads), %d writes\n", vcp->cacheSize, vcp->allocs, vcp->gets, vcp->reads, vcp->writes);
8096     vcp = &VnodeClassInfo[vSmall];
8097     Log("Small vnode cache,%d entries, %d allocs, %d gets (%d reads), %d writes\n", vcp->cacheSize, vcp->allocs, vcp->gets, vcp->reads, vcp->writes);
8098     SplitInt64(VStats.hdr_gets, get_hi, get_lo);
8099     SplitInt64(VStats.hdr_loads, load_hi, load_lo);
8100     Log("Volume header cache, %d entries, %d gets, %d replacements\n",
8101         VStats.hdr_cache_size, get_lo, load_lo);
8102 }
8103
8104 void
8105 VPrintCacheStats(void)
8106 {
8107     VOL_LOCK;
8108     VPrintCacheStats_r();
8109     VOL_UNLOCK;
8110 }
8111
8112 #ifdef AFS_DEMAND_ATTACH_FS
8113 static double
8114 UInt64ToDouble(afs_uint64 * x)
8115 {
8116     static double c32 = 4.0 * 1.073741824 * 1000000000.0;
8117     afs_uint32 h, l;
8118     SplitInt64(*x, h, l);
8119     return (((double)h) * c32) + ((double) l);
8120 }
8121
8122 static char *
8123 DoubleToPrintable(double x, char * buf, int len)
8124 {
8125     static double billion = 1000000000.0;
8126     afs_uint32 y[3];
8127
8128     y[0] = (afs_uint32) (x / (billion * billion));
8129     y[1] = (afs_uint32) ((x - (((double)y[0]) * billion * billion)) / billion);
8130     y[2] = (afs_uint32) (x - ((((double)y[0]) * billion * billion) + (((double)y[1]) * billion)));
8131
8132     if (y[0]) {
8133         snprintf(buf, len, "%d%09d%09d", y[0], y[1], y[2]);
8134     } else if (y[1]) {
8135         snprintf(buf, len, "%d%09d", y[1], y[2]);
8136     } else {
8137         snprintf(buf, len, "%d", y[2]);
8138     }
8139     buf[len-1] = '\0';
8140     return buf;
8141 }
8142
8143 struct VLRUExtStatsEntry {
8144     VolumeId volid;
8145 };
8146
8147 struct VLRUExtStats {
8148     afs_uint32 len;
8149     afs_uint32 used;
8150     struct {
8151         afs_uint32 start;
8152         afs_uint32 len;
8153     } queue_info[VLRU_QUEUE_INVALID];
8154     struct VLRUExtStatsEntry * vec;
8155 };
8156
8157 /**
8158  * add a 256-entry fudge factor onto the vector in case state changes
8159  * out from under us.
8160  */
8161 #define VLRU_EXT_STATS_VEC_LEN_FUDGE   256
8162
8163 /**
8164  * collect extended statistics for the VLRU subsystem.
8165  *
8166  * @param[out] stats  pointer to stats structure to be populated
8167  * @param[in] nvols   number of volumes currently known to exist
8168  *
8169  * @pre VOL_LOCK held
8170  *
8171  * @post stats->vec allocated and populated
8172  *
8173  * @return operation status
8174  *    @retval 0 success
8175  *    @retval 1 failure
8176  */
8177 static int
8178 VVLRUExtStats_r(struct VLRUExtStats * stats, afs_uint32 nvols)
8179 {
8180     afs_uint32 cur, idx, len;
8181     struct rx_queue * qp, * nqp;
8182     Volume * vp;
8183     struct VLRUExtStatsEntry * vec;
8184
8185     len = nvols + VLRU_EXT_STATS_VEC_LEN_FUDGE;
8186     vec = stats->vec = calloc(len,
8187                               sizeof(struct VLRUExtStatsEntry));
8188     if (vec == NULL) {
8189         return 1;
8190     }
8191
8192     cur = 0;
8193     for (idx = VLRU_QUEUE_NEW; idx < VLRU_QUEUE_INVALID; idx++) {
8194         VLRU_Wait_r(&volume_LRU.q[idx]);
8195         VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
8196         VOL_UNLOCK;
8197
8198         stats->queue_info[idx].start = cur;
8199
8200         for (queue_Scan(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
8201             if (cur == len) {
8202                 /* out of space in vec */
8203                 break;
8204             }
8205             vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
8206             vec[cur].volid = vp->hashid;
8207             cur++;
8208         }
8209
8210         stats->queue_info[idx].len = cur - stats->queue_info[idx].start;
8211
8212         VOL_LOCK;
8213         VLRU_EndExclusive_r(&volume_LRU.q[idx]);
8214     }
8215
8216     stats->len = len;
8217     stats->used = cur;
8218     return 0;
8219 }
8220
8221 #define ENUMTOSTRING(en)  #en
8222 #define ENUMCASE(en) \
8223     case en: \
8224         return ENUMTOSTRING(en); \
8225         break
8226
8227 static char *
8228 vlru_idx_to_string(int idx)
8229 {
8230     switch (idx) {
8231         ENUMCASE(VLRU_QUEUE_NEW);
8232         ENUMCASE(VLRU_QUEUE_MID);
8233         ENUMCASE(VLRU_QUEUE_OLD);
8234         ENUMCASE(VLRU_QUEUE_CANDIDATE);
8235         ENUMCASE(VLRU_QUEUE_HELD);
8236         ENUMCASE(VLRU_QUEUE_INVALID);
8237     default:
8238         return "**UNKNOWN**";
8239     }
8240 }
8241
8242 void
8243 VPrintExtendedCacheStats_r(int flags)
8244 {
8245     int i;
8246     afs_uint32 vol_sum = 0;
8247     struct stats {
8248         double min;
8249         double max;
8250         double sum;
8251         double avg;
8252     };
8253     struct stats looks, gets, reorders, len;
8254     struct stats ch_looks, ch_gets, ch_reorders;
8255     char pr_buf[4][32];
8256     VolumeHashChainHead *head;
8257     Volume *vp, *np;
8258     struct VLRUExtStats vlru_stats;
8259
8260     /* zero out stats */
8261     memset(&looks, 0, sizeof(struct stats));
8262     memset(&gets, 0, sizeof(struct stats));
8263     memset(&reorders, 0, sizeof(struct stats));
8264     memset(&len, 0, sizeof(struct stats));
8265     memset(&ch_looks, 0, sizeof(struct stats));
8266     memset(&ch_gets, 0, sizeof(struct stats));
8267     memset(&ch_reorders, 0, sizeof(struct stats));
8268
8269     for (i = 0; i < VolumeHashTable.Size; i++) {
8270         head = &VolumeHashTable.Table[i];
8271
8272         VHashWait_r(head);
8273         VHashBeginExclusive_r(head);
8274         VOL_UNLOCK;
8275
8276         ch_looks.sum    = UInt64ToDouble(&head->looks);
8277         ch_gets.sum     = UInt64ToDouble(&head->gets);
8278         ch_reorders.sum = UInt64ToDouble(&head->reorders);
8279
8280         /* update global statistics */
8281         {
8282             looks.sum    += ch_looks.sum;
8283             gets.sum     += ch_gets.sum;
8284             reorders.sum += ch_reorders.sum;
8285             len.sum      += (double)head->len;
8286             vol_sum      += head->len;
8287
8288             if (i == 0) {
8289                 len.min      = (double) head->len;
8290                 len.max      = (double) head->len;
8291                 looks.min    = ch_looks.sum;
8292                 looks.max    = ch_looks.sum;
8293                 gets.min     = ch_gets.sum;
8294                 gets.max     = ch_gets.sum;
8295                 reorders.min = ch_reorders.sum;
8296                 reorders.max = ch_reorders.sum;
8297             } else {
8298                 if (((double)head->len) < len.min)
8299                     len.min = (double) head->len;
8300                 if (((double)head->len) > len.max)
8301                     len.max = (double) head->len;
8302                 if (ch_looks.sum < looks.min)
8303                     looks.min = ch_looks.sum;
8304                 else if (ch_looks.sum > looks.max)
8305                     looks.max = ch_looks.sum;
8306                 if (ch_gets.sum < gets.min)
8307                     gets.min = ch_gets.sum;
8308                 else if (ch_gets.sum > gets.max)
8309                     gets.max = ch_gets.sum;
8310                 if (ch_reorders.sum < reorders.min)
8311                     reorders.min = ch_reorders.sum;
8312                 else if (ch_reorders.sum > reorders.max)
8313                     reorders.max = ch_reorders.sum;
8314             }
8315         }
8316
8317         if ((flags & VOL_STATS_PER_CHAIN2) && queue_IsNotEmpty(head)) {
8318             /* compute detailed per-chain stats */
8319             struct stats hdr_loads, hdr_gets;
8320             double v_looks, v_loads, v_gets;
8321
8322             /* initialize stats with data from first element in chain */
8323             vp = queue_First(head, Volume);
8324             v_looks = UInt64ToDouble(&vp->stats.hash_lookups);
8325             v_loads = UInt64ToDouble(&vp->stats.hdr_loads);
8326             v_gets  = UInt64ToDouble(&vp->stats.hdr_gets);
8327             ch_gets.min = ch_gets.max = v_looks;
8328             hdr_loads.min = hdr_loads.max = v_loads;
8329             hdr_gets.min = hdr_gets.max = v_gets;
8330             hdr_loads.sum = hdr_gets.sum = 0;
8331
8332             vp = queue_Next(vp, Volume);
8333
8334             /* pull in stats from remaining elements in chain */
8335             for (queue_ScanFrom(head, vp, vp, np, Volume)) {
8336                 v_looks = UInt64ToDouble(&vp->stats.hash_lookups);
8337                 v_loads = UInt64ToDouble(&vp->stats.hdr_loads);
8338                 v_gets  = UInt64ToDouble(&vp->stats.hdr_gets);
8339
8340                 hdr_loads.sum += v_loads;
8341                 hdr_gets.sum += v_gets;
8342
8343                 if (v_looks < ch_gets.min)
8344                     ch_gets.min = v_looks;
8345                 else if (v_looks > ch_gets.max)
8346                     ch_gets.max = v_looks;
8347
8348                 if (v_loads < hdr_loads.min)
8349                     hdr_loads.min = v_loads;
8350                 else if (v_loads > hdr_loads.max)
8351                     hdr_loads.max = v_loads;
8352
8353                 if (v_gets < hdr_gets.min)
8354                     hdr_gets.min = v_gets;
8355                 else if (v_gets > hdr_gets.max)
8356                     hdr_gets.max = v_gets;
8357             }
8358
8359             /* compute per-chain averages */
8360             ch_gets.avg = ch_gets.sum / ((double)head->len);
8361             hdr_loads.avg = hdr_loads.sum / ((double)head->len);
8362             hdr_gets.avg = hdr_gets.sum / ((double)head->len);
8363
8364             /* dump per-chain stats */
8365             Log("Volume hash chain %d : len=%d, looks=%s, reorders=%s\n",
8366                 i, head->len,
8367                 DoubleToPrintable(ch_looks.sum, pr_buf[0], sizeof(pr_buf[0])),
8368                 DoubleToPrintable(ch_reorders.sum, pr_buf[1], sizeof(pr_buf[1])));
8369             Log("\tVolume gets : min=%s, max=%s, avg=%s, total=%s\n",
8370                 DoubleToPrintable(ch_gets.min, pr_buf[0], sizeof(pr_buf[0])),
8371                 DoubleToPrintable(ch_gets.max, pr_buf[1], sizeof(pr_buf[1])),
8372                 DoubleToPrintable(ch_gets.avg, pr_buf[2], sizeof(pr_buf[2])),
8373                 DoubleToPrintable(ch_gets.sum, pr_buf[3], sizeof(pr_buf[3])));
8374             Log("\tHDR gets : min=%s, max=%s, avg=%s, total=%s\n",
8375                 DoubleToPrintable(hdr_gets.min, pr_buf[0], sizeof(pr_buf[0])),
8376                 DoubleToPrintable(hdr_gets.max, pr_buf[1], sizeof(pr_buf[1])),
8377                 DoubleToPrintable(hdr_gets.avg, pr_buf[2], sizeof(pr_buf[2])),
8378                 DoubleToPrintable(hdr_gets.sum, pr_buf[3], sizeof(pr_buf[3])));
8379             Log("\tHDR loads : min=%s, max=%s, avg=%s, total=%s\n",
8380                 DoubleToPrintable(hdr_loads.min, pr_buf[0], sizeof(pr_buf[0])),
8381                 DoubleToPrintable(hdr_loads.max, pr_buf[1], sizeof(pr_buf[1])),
8382                 DoubleToPrintable(hdr_loads.avg, pr_buf[2], sizeof(pr_buf[2])),
8383                 DoubleToPrintable(hdr_loads.sum, pr_buf[3], sizeof(pr_buf[3])));
8384         } else if (flags & VOL_STATS_PER_CHAIN) {
8385             /* dump simple per-chain stats */
8386             Log("Volume hash chain %d : len=%d, looks=%s, gets=%s, reorders=%s\n",
8387                 i, head->len,
8388                 DoubleToPrintable(ch_looks.sum, pr_buf[0], sizeof(pr_buf[0])),
8389                 DoubleToPrintable(ch_gets.sum, pr_buf[1], sizeof(pr_buf[1])),
8390                 DoubleToPrintable(ch_reorders.sum, pr_buf[2], sizeof(pr_buf[2])));
8391         }
8392
8393         VOL_LOCK;
8394         VHashEndExclusive_r(head);
8395     }
8396
8397     VOL_UNLOCK;
8398
8399     /* compute global averages */
8400     len.avg      = len.sum      / ((double)VolumeHashTable.Size);
8401     looks.avg    = looks.sum    / ((double)VolumeHashTable.Size);
8402     gets.avg     = gets.sum     / ((double)VolumeHashTable.Size);
8403     reorders.avg = reorders.sum / ((double)VolumeHashTable.Size);
8404
8405     /* dump global stats */
8406     Log("Volume hash summary: %d buckets\n", VolumeHashTable.Size);
8407     Log(" chain length : min=%s, max=%s, avg=%s, total=%s\n",
8408         DoubleToPrintable(len.min, pr_buf[0], sizeof(pr_buf[0])),
8409         DoubleToPrintable(len.max, pr_buf[1], sizeof(pr_buf[1])),
8410         DoubleToPrintable(len.avg, pr_buf[2], sizeof(pr_buf[2])),
8411         DoubleToPrintable(len.sum, pr_buf[3], sizeof(pr_buf[3])));
8412     Log(" looks : min=%s, max=%s, avg=%s, total=%s\n",
8413         DoubleToPrintable(looks.min, pr_buf[0], sizeof(pr_buf[0])),
8414         DoubleToPrintable(looks.max, pr_buf[1], sizeof(pr_buf[1])),
8415         DoubleToPrintable(looks.avg, pr_buf[2], sizeof(pr_buf[2])),
8416         DoubleToPrintable(looks.sum, pr_buf[3], sizeof(pr_buf[3])));
8417     Log(" gets : min=%s, max=%s, avg=%s, total=%s\n",
8418         DoubleToPrintable(gets.min, pr_buf[0], sizeof(pr_buf[0])),
8419         DoubleToPrintable(gets.max, pr_buf[1], sizeof(pr_buf[1])),
8420         DoubleToPrintable(gets.avg, pr_buf[2], sizeof(pr_buf[2])),
8421         DoubleToPrintable(gets.sum, pr_buf[3], sizeof(pr_buf[3])));
8422     Log(" reorders : min=%s, max=%s, avg=%s, total=%s\n",
8423         DoubleToPrintable(reorders.min, pr_buf[0], sizeof(pr_buf[0])),
8424         DoubleToPrintable(reorders.max, pr_buf[1], sizeof(pr_buf[1])),
8425         DoubleToPrintable(reorders.avg, pr_buf[2], sizeof(pr_buf[2])),
8426         DoubleToPrintable(reorders.sum, pr_buf[3], sizeof(pr_buf[3])));
8427
8428     /* print extended disk related statistics */
8429     {
8430         struct DiskPartition64 * diskP;
8431         afs_uint32 vol_count[VOLMAXPARTS+1];
8432         byte part_exists[VOLMAXPARTS+1];
8433         Device id;
8434         int i;
8435
8436         memset(vol_count, 0, sizeof(vol_count));
8437         memset(part_exists, 0, sizeof(part_exists));
8438
8439         VOL_LOCK;
8440
8441         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
8442             id = diskP->index;
8443             vol_count[id] = diskP->vol_list.len;
8444             part_exists[id] = 1;
8445         }
8446
8447         VOL_UNLOCK;
8448         for (i = 0; i <= VOLMAXPARTS; i++) {
8449             if (part_exists[i]) {
8450                 /* XXX while this is currently safe, it is a violation
8451                  *     of the VGetPartitionById_r interface contract. */
8452                 diskP = VGetPartitionById_r(i, 0);
8453                 if (diskP) {
8454                     Log("Partition %s has %d online volumes\n",
8455                         VPartitionPath(diskP), diskP->vol_list.len);
8456                 }
8457             }
8458         }
8459         VOL_LOCK;
8460     }
8461
8462     /* print extended VLRU statistics */
8463     if (VVLRUExtStats_r(&vlru_stats, vol_sum) == 0) {
8464         afs_uint32 idx, cur, lpos;
8465         VolumeId line[5];
8466
8467         VOL_UNLOCK;
8468
8469         Log("VLRU State Dump:\n\n");
8470
8471         for (idx = VLRU_QUEUE_NEW; idx < VLRU_QUEUE_INVALID; idx++) {
8472             Log("\t%s:\n", vlru_idx_to_string(idx));
8473
8474             lpos = 0;
8475             for (cur = vlru_stats.queue_info[idx].start;
8476                  cur < vlru_stats.queue_info[idx].len;
8477                  cur++) {
8478                 line[lpos++] = vlru_stats.vec[cur].volid;
8479                 if (lpos==5) {
8480                     Log("\t\t%u, %u, %u, %u, %u,\n",
8481                         line[0], line[1], line[2], line[3], line[4]);
8482                     lpos = 0;
8483                 }
8484             }
8485
8486             if (lpos) {
8487                 while (lpos < 5) {
8488                     line[lpos++] = 0;
8489                 }
8490                 Log("\t\t%u, %u, %u, %u, %u\n",
8491                     line[0], line[1], line[2], line[3], line[4]);
8492             }
8493             Log("\n");
8494         }
8495
8496         free(vlru_stats.vec);
8497
8498         VOL_LOCK;
8499     }
8500 }
8501
8502 void
8503 VPrintExtendedCacheStats(int flags)
8504 {
8505     VOL_LOCK;
8506     VPrintExtendedCacheStats_r(flags);
8507     VOL_UNLOCK;
8508 }
8509 #endif /* AFS_DEMAND_ATTACH_FS */
8510
8511 afs_int32
8512 VCanScheduleSalvage(void)
8513 {
8514     return vol_opts.canScheduleSalvage;
8515 }
8516
8517 afs_int32
8518 VCanUseFSSYNC(void)
8519 {
8520     return vol_opts.canUseFSSYNC;
8521 }
8522
8523 afs_int32
8524 VCanUseSALVSYNC(void)
8525 {
8526     return vol_opts.canUseSALVSYNC;
8527 }
8528
8529 afs_int32
8530 VCanUnsafeAttach(void)
8531 {
8532     return vol_opts.unsafe_attach;
8533 }