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