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
  26 #include <ctype.h>
  27 #include <stddef.h>
  28
  29 #ifdef HAVE_SYS_FILE_H
  30 #include <sys/file.h>
  31 #endif
  32
  33 #include <rx/xdr.h>
  34 #include <afs/afsint.h>
  35
  36 #ifndef AFS_NT40_ENV
  37 #if !defined(AFS_SGI_ENV)
  38 #ifdef  AFS_OSF_ENV
  39 #include <ufs/fs.h>
  40 #else /* AFS_OSF_ENV */
  41 #ifdef AFS_VFSINCL_ENV
  42 #define VFS
  43 #ifdef  AFS_SUN5_ENV
  44 #include <sys/fs/ufs_fs.h>
  45 #else
  46 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
  47 #include <ufs/ufs/dinode.h>
  48 #include <ufs/ffs/fs.h>
  49 #else
  50 #include <ufs/fs.h>
  51 #endif
  52 #endif
  53 #else /* AFS_VFSINCL_ENV */
  54 #if !defined(AFS_AIX_ENV) && !defined(AFS_LINUX20_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_ARM_DARWIN_ENV)
  55 #include <sys/fs.h>
  56 #endif
  57 #endif /* AFS_VFSINCL_ENV */
  58 #endif /* AFS_OSF_ENV */
  59 #endif /* AFS_SGI_ENV */
  60 #endif /* !AFS_NT40_ENV */
  61
  62 #ifdef  AFS_AIX_ENV
  63 #include <sys/vfs.h>
  64 #else
  65 #ifdef  AFS_HPUX_ENV
  66 #include <mntent.h>
  67 #else
  68 #if     defined(AFS_SUN_ENV) || defined(AFS_SUN5_ENV)
  69 #ifdef  AFS_SUN5_ENV
  70 #include <sys/mnttab.h>
  71 #include <sys/mntent.h>
  72 #else
  73 #include <mntent.h>
  74 #endif
  75 #else
  76 #ifndef AFS_NT40_ENV
  77 #if defined(AFS_SGI_ENV)
  78 #include <mntent.h>
  79 #else
  80 #ifndef AFS_LINUX20_ENV
  81 #include <fstab.h>              /* Need to find in libc 5, present in libc 6 */
  82 #endif
  83 #endif
  84 #endif /* AFS_SGI_ENV */
  85 #endif
  86 #endif /* AFS_HPUX_ENV */
  87 #endif
  88
  89 #include "nfs.h"
  90 #include <afs/errors.h>
  91 #include "lock.h"
  92 #include "lwp.h"
  93 #include <afs/afssyscalls.h>
  94 #include "ihandle.h"
  95 #include <afs/afsutil.h>
  96 #include "daemon_com.h"
  97 #include "fssync.h"
  98 #include "salvsync.h"
  99 #include "vnode.h"
 100 #include "volume.h"
 101 #include "partition.h"
 102 #include "volume_inline.h"
 103 #include "common.h"
 104 #include "afs/afs_assert.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, VPartitionPath(partp), 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, VPartitionPath(partp), 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                 vp->specialStatus = VBUSY;
3033             }
3034             break;
3035
3036         default:
3037             break;
3038         }
3039
3040         VOL_UNLOCK;
3041     }
3042 }
3043 #endif /* AFS_DEMAND_ATTACH_FS */
3044
3045 /**
3046  * volume attachment helper function.
3047  *
3048  * @param[out] ec      error code
3049  * @param[in] volumeId volume ID of the attaching volume
3050  * @param[in] path     full path to the volume header .vol file
3051  * @param[in] partp    disk partition object for the attaching partition
3052  * @param[in] vp       volume object; vp->hashid, vp->device, vp->partition,
3053  *                     vp->vnode_list, vp->rx_call_list, and V_attachCV (for
3054  *                     DAFS) should already be initialized
3055  * @param[in] isbusy   1 if vp->specialStatus should be set to VBUSY; that is,
3056  *                     if there is a volume operation running for this volume
3057  *                     that should set the volume to VBUSY during its run. 0
3058  *                     otherwise. (see VVolOpSetVBusy_r)
3059  * @param[in] mode     attachment mode such as V_VOLUPD, V_DUMP, etc (see
3060  *                     volume.h)
3061  * @param[out] acheckedOut   If we successfully checked-out the volume from
3062  *                           the fileserver (if we needed to), this is set
3063  *                           to 1, otherwise it is 0.
3064  *
3065  * @return pointer to the semi-attached volume pointer
3066  *  @retval NULL an error occurred (check value of *ec)
3067  *  @retval vp volume successfully attaching
3068  *
3069  * @pre no locks held
3070  *
3071  * @post VOL_LOCK held
3072  */
3073 static Volume *
3074 attach2(Error * ec, VolId volumeId, char *path, struct DiskPartition64 *partp,
3075         Volume * vp, int isbusy, int mode, int *acheckedOut)
3076 {
3077     /* have we read in the header successfully? */
3078     int read_header = 0;
3079
3080 #ifdef AFS_DEMAND_ATTACH_FS
3081     /* should we FreeVolume(vp) instead of VCheckFree(vp) in the error
3082      * cleanup? */
3083     int forcefree = 0;
3084
3085     /* in the case of an error, to what state should the volume be
3086      * transitioned? */
3087     VolState error_state = VOL_STATE_ERROR;
3088 #endif /* AFS_DEMAND_ATTACH_FS */
3089
3090     *ec = 0;
3091
3092     vp->vnodeIndex[vLarge].handle = NULL;
3093     vp->vnodeIndex[vSmall].handle = NULL;
3094     vp->diskDataHandle = NULL;
3095     vp->linkHandle = NULL;
3096
3097     *acheckedOut = 0;
3098
3099 #ifdef AFS_DEMAND_ATTACH_FS
3100     attach_check_vop(ec, volumeId, partp, vp, acheckedOut);
3101     if (!*ec) {
3102         attach_volume_header(ec, vp, partp, mode, 0, acheckedOut);
3103     }
3104 #else
3105     attach_volume_header(ec, vp, partp, mode, 0, acheckedOut);
3106 #endif /* !AFS_DEMAND_ATTACH_FS */
3107
3108     if (*ec == VNOVOL) {
3109         /* if the volume doesn't exist, skip straight to 'error' so we don't
3110          * request a salvage */
3111         goto unlocked_error;
3112     }
3113
3114     if (!*ec) {
3115         read_header = 1;
3116
3117         vp->specialStatus = (byte) (isbusy ? VBUSY : 0);
3118         vp->shuttingDown = 0;
3119         vp->goingOffline = 0;
3120         vp->nUsers = 1;
3121 #ifdef AFS_DEMAND_ATTACH_FS
3122         vp->stats.last_attach = FT_ApproxTime();
3123         vp->stats.attaches++;
3124 #endif
3125
3126         VOL_LOCK;
3127         IncUInt64(&VStats.attaches);
3128         vp->cacheCheck = ++VolumeCacheCheck;
3129         /* just in case this ever rolls over */
3130         if (!vp->cacheCheck)
3131             vp->cacheCheck = ++VolumeCacheCheck;
3132         VOL_UNLOCK;
3133
3134 #ifdef AFS_DEMAND_ATTACH_FS
3135         V_attachFlags(vp) |= VOL_HDR_LOADED;
3136         vp->stats.last_hdr_load = vp->stats.last_attach;
3137 #endif /* AFS_DEMAND_ATTACH_FS */
3138     }
3139
3140     if (!*ec) {
3141         struct IndexFileHeader iHead;
3142
3143 #if OPENAFS_VOL_STATS
3144         /*
3145          * We just read in the diskstuff part of the header.  If the detailed
3146          * volume stats area has not yet been initialized, we should bzero the
3147          * area and mark it as initialized.
3148          */
3149         if (!(V_stat_initialized(vp))) {
3150             memset((V_stat_area(vp)), 0, VOL_STATS_BYTES);
3151             V_stat_initialized(vp) = 1;
3152         }
3153 #endif /* OPENAFS_VOL_STATS */
3154
3155         (void)ReadHeader(ec, vp->vnodeIndex[vSmall].handle,
3156                          (char *)&iHead, sizeof(iHead),
3157                          SMALLINDEXMAGIC, SMALLINDEXVERSION);
3158
3159         if (*ec) {
3160             Log("VAttachVolume: Error reading smallVnode vol header %s; error=%u\n", path, *ec);
3161         }
3162     }
3163
3164     if (!*ec) {
3165         struct IndexFileHeader iHead;
3166
3167         (void)ReadHeader(ec, vp->vnodeIndex[vLarge].handle,
3168                          (char *)&iHead, sizeof(iHead),
3169                          LARGEINDEXMAGIC, LARGEINDEXVERSION);
3170
3171         if (*ec) {
3172             Log("VAttachVolume: Error reading largeVnode vol header %s; error=%u\n", path, *ec);
3173         }
3174     }
3175
3176 #ifdef AFS_NAMEI_ENV
3177     if (!*ec) {
3178         struct versionStamp stamp;
3179
3180         (void)ReadHeader(ec, V_linkHandle(vp), (char *)&stamp,
3181                          sizeof(stamp), LINKTABLEMAGIC, LINKTABLEVERSION);
3182
3183         if (*ec) {
3184             Log("VAttachVolume: Error reading namei vol header %s; error=%u\n", path, *ec);
3185         }
3186     }
3187 #endif /* AFS_NAMEI_ENV */
3188
3189 #if defined(AFS_DEMAND_ATTACH_FS)
3190     if (*ec && ((*ec != VOFFLINE) || (V_attachState(vp) != VOL_STATE_UNATTACHED))) {
3191         VOL_LOCK;
3192         if (!VCanScheduleSalvage()) {
3193             Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3194         }
3195         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3196                                                   VOL_SALVAGE_NO_OFFLINE);
3197         vp->nUsers = 0;
3198
3199         goto locked_error;
3200     } else if (*ec) {
3201         /* volume operation in progress */
3202         goto unlocked_error;
3203     }
3204 #else /* AFS_DEMAND_ATTACH_FS */
3205     if (*ec) {
3206         Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3207         goto unlocked_error;
3208     }
3209 #endif /* AFS_DEMAND_ATTACH_FS */
3210
3211     if (V_needsSalvaged(vp)) {
3212         if (vp->specialStatus)
3213             vp->specialStatus = 0;
3214         VOL_LOCK;
3215 #if defined(AFS_DEMAND_ATTACH_FS)
3216         if (!VCanScheduleSalvage()) {
3217             Log("VAttachVolume: volume salvage flag is ON for %s; volume needs salvage\n", path);
3218         }
3219         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER |
3220                                                    VOL_SALVAGE_NO_OFFLINE);
3221         vp->nUsers = 0;
3222
3223 #else /* AFS_DEMAND_ATTACH_FS */
3224         *ec = VSALVAGE;
3225 #endif /* AFS_DEMAND_ATTACH_FS */
3226
3227         goto locked_error;
3228     }
3229
3230     VOL_LOCK;
3231     vp->nextVnodeUnique = V_uniquifier(vp);
3232
3233     if (VShouldCheckInUse(mode) && V_inUse(vp) && VolumeWriteable(vp)) {
3234         if (!V_needsSalvaged(vp)) {
3235             V_needsSalvaged(vp) = 1;
3236             VUpdateVolume_r(ec, vp, 0);
3237         }
3238 #if defined(AFS_DEMAND_ATTACH_FS)
3239         if (!VCanScheduleSalvage()) {
3240             Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3241         }
3242         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER |
3243                                                    VOL_SALVAGE_NO_OFFLINE);
3244         vp->nUsers = 0;
3245
3246 #else /* AFS_DEMAND_ATTACH_FS */
3247         Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3248         *ec = VSALVAGE;
3249 #endif /* AFS_DEMAND_ATTACH_FS */
3250
3251         goto locked_error;
3252     }
3253
3254     if (programType == fileServer && V_destroyMe(vp) == DESTROY_ME) {
3255         /* Only check destroyMe if we are the fileserver, since the
3256          * volserver et al sometimes need to work with volumes with
3257          * destroyMe set. Examples are 'temporary' volumes the
3258          * volserver creates, and when we create a volume (destroyMe
3259          * is set on creation; sometimes a separate volserver
3260          * transaction is created to clear destroyMe).
3261          */
3262
3263 #if defined(AFS_DEMAND_ATTACH_FS)
3264         /* schedule a salvage so the volume goes away on disk */
3265         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3266                                                   VOL_SALVAGE_NO_OFFLINE);
3267         VChangeState_r(vp, VOL_STATE_ERROR);
3268         vp->nUsers = 0;
3269         forcefree = 1;
3270 #endif /* AFS_DEMAND_ATTACH_FS */
3271         Log("VAttachVolume: volume %s is junk; it should be destroyed at next salvage\n", path);
3272         *ec = VNOVOL;
3273         goto locked_error;
3274     }
3275
3276     vp->vnodeIndex[vSmall].bitmap = vp->vnodeIndex[vLarge].bitmap = NULL;
3277 #ifndef BITMAP_LATER
3278     if (programType == fileServer && VolumeWriteable(vp)) {
3279         int i;
3280         for (i = 0; i < nVNODECLASSES; i++) {
3281             VGetBitmap_r(ec, vp, i);
3282             if (*ec) {
3283 #ifdef AFS_DEMAND_ATTACH_FS
3284                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3285                                                           VOL_SALVAGE_NO_OFFLINE);
3286                 vp->nUsers = 0;
3287 #endif /* AFS_DEMAND_ATTACH_FS */
3288                 Log("VAttachVolume: error getting bitmap for volume (%s)\n",
3289                     path);
3290                 goto locked_error;
3291             }
3292         }
3293     }
3294 #endif /* BITMAP_LATER */
3295
3296     if (VInit >= 2 && V_needsCallback(vp)) {
3297         if (V_BreakVolumeCallbacks) {
3298             Log("VAttachVolume: Volume %lu was changed externally; breaking callbacks\n",
3299                 afs_printable_uint32_lu(V_id(vp)));
3300             V_needsCallback(vp) = 0;
3301             VOL_UNLOCK;
3302             (*V_BreakVolumeCallbacks) (V_id(vp));
3303             VOL_LOCK;
3304
3305             VUpdateVolume_r(ec, vp, 0);
3306         }
3307 #ifdef FSSYNC_BUILD_CLIENT
3308         else if (VCanUseFSSYNC()) {
3309             afs_int32 fsync_code;
3310
3311             V_needsCallback(vp) = 0;
3312             VOL_UNLOCK;
3313             fsync_code = FSYNC_VolOp(V_id(vp), NULL, FSYNC_VOL_BREAKCBKS, FSYNC_WHATEVER, NULL);
3314             VOL_LOCK;
3315
3316             if (fsync_code) {
3317                 V_needsCallback(vp) = 1;
3318                 Log("Error trying to tell the fileserver to break callbacks for "
3319                     "changed volume %lu; error code %ld\n",
3320                     afs_printable_uint32_lu(V_id(vp)),
3321                     afs_printable_int32_ld(fsync_code));
3322             } else {
3323                 VUpdateVolume_r(ec, vp, 0);
3324             }
3325         }
3326 #endif /* FSSYNC_BUILD_CLIENT */
3327
3328         if (*ec) {
3329             Log("VAttachVolume: error %d clearing needsCallback on volume "
3330                 "%lu; needs salvage\n", (int)*ec,
3331                 afs_printable_uint32_lu(V_id(vp)));
3332 #ifdef AFS_DEMAND_ATTACH_FS
3333             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3334                                                       VOL_SALVAGE_NO_OFFLINE);
3335             vp->nUsers = 0;
3336 #else /* !AFS_DEMAND_ATTACH_FS */
3337             *ec = VSALVAGE;
3338 #endif /* !AFS_DEMAND_ATTACh_FS */
3339             goto locked_error;
3340         }
3341     }
3342
3343     if (programType == fileServer) {
3344         if (vp->specialStatus)
3345             vp->specialStatus = 0;
3346         if (V_blessed(vp) && V_inService(vp) && !V_needsSalvaged(vp)) {
3347             V_inUse(vp) = fileServer;
3348             V_offlineMessage(vp)[0] = '\0';
3349         }
3350         if (!V_inUse(vp)) {
3351             *ec = VNOVOL;
3352 #ifdef AFS_DEMAND_ATTACH_FS
3353             /* Put the vol into PREATTACHED state, so if someone tries to
3354              * access it again, we try to attach, see that we're not blessed,
3355              * and give a VNOVOL error again. Putting it into UNATTACHED state
3356              * would result in a VOFFLINE error instead. */
3357             error_state = VOL_STATE_PREATTACHED;
3358 #endif /* AFS_DEMAND_ATTACH_FS */
3359
3360             /* mimic e.g. GetVolume errors */
3361             if (!V_blessed(vp)) {
3362                 Log("Volume %lu offline: not blessed\n", afs_printable_uint32_lu(V_id(vp)));
3363                 FreeVolumeHeader(vp);
3364             } else if (!V_inService(vp)) {
3365                 Log("Volume %lu offline: not in service\n", afs_printable_uint32_lu(V_id(vp)));
3366                 FreeVolumeHeader(vp);
3367             } else {
3368                 Log("Volume %lu offline: needs salvage\n", afs_printable_uint32_lu(V_id(vp)));
3369                 *ec = VSALVAGE;
3370 #ifdef AFS_DEMAND_ATTACH_FS
3371                 error_state = VOL_STATE_ERROR;
3372                 /* see if we can recover */
3373                 VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER);
3374 #endif
3375             }
3376 #ifdef AFS_DEMAND_ATTACH_FS
3377             vp->nUsers = 0;
3378 #endif
3379             goto locked_error;
3380         }
3381     } else {
3382 #ifdef AFS_DEMAND_ATTACH_FS
3383         if ((mode != V_PEEK) && (mode != V_SECRETLY))
3384             V_inUse(vp) = programType;
3385 #endif /* AFS_DEMAND_ATTACH_FS */
3386         V_checkoutMode(vp) = mode;
3387     }
3388
3389     AddVolumeToHashTable(vp, V_id(vp));
3390 #ifdef AFS_DEMAND_ATTACH_FS
3391     if (VCanUnlockAttached() && (V_attachFlags(vp) & VOL_LOCKED)) {
3392         VUnlockVolume(vp);
3393     }
3394     if ((programType != fileServer) ||
3395         (V_inUse(vp) == fileServer)) {
3396         AddVolumeToVByPList_r(vp);
3397         VLRU_Add_r(vp);
3398         VChangeState_r(vp, VOL_STATE_ATTACHED);
3399     } else {
3400         VChangeState_r(vp, VOL_STATE_UNATTACHED);
3401     }
3402 #endif
3403
3404     return vp;
3405
3406 unlocked_error:
3407     VOL_LOCK;
3408 locked_error:
3409 #ifdef AFS_DEMAND_ATTACH_FS
3410     if (!VIsErrorState(V_attachState(vp))) {
3411         VChangeState_r(vp, error_state);
3412     }
3413 #endif /* AFS_DEMAND_ATTACH_FS */
3414
3415     if (read_header) {
3416         VReleaseVolumeHandles_r(vp);
3417     }
3418
3419 #ifdef AFS_DEMAND_ATTACH_FS
3420     VCheckSalvage(vp);
3421     if (forcefree) {
3422         FreeVolume(vp);
3423     } else {
3424         VCheckFree(vp);
3425     }
3426 #else /* !AFS_DEMAND_ATTACH_FS */
3427     FreeVolume(vp);
3428 #endif /* !AFS_DEMAND_ATTACH_FS */
3429     return NULL;
3430 }
3431
3432 /* Attach an existing volume.
3433    The volume also normally goes online at this time.
3434    An offline volume must be reattached to make it go online.
3435  */
3436
3437 Volume *
3438 VAttachVolume(Error * ec, VolumeId volumeId, int mode)
3439 {
3440     Volume *retVal;
3441     VOL_LOCK;
3442     retVal = VAttachVolume_r(ec, volumeId, mode);
3443     VOL_UNLOCK;
3444     return retVal;
3445 }
3446
3447 Volume *
3448 VAttachVolume_r(Error * ec, VolumeId volumeId, int mode)
3449 {
3450     char *part, *name;
3451     VGetVolumePath(ec, volumeId, &part, &name);
3452     if (*ec) {
3453         Volume *vp;
3454         Error error;
3455         vp = VGetVolume_r(&error, volumeId);
3456         if (vp) {
3457             osi_Assert(V_inUse(vp) == 0);
3458             VDetachVolume_r(ec, vp);
3459         }
3460         return NULL;
3461     }
3462     return VAttachVolumeByName_r(ec, part, name, mode);
3463 }
3464
3465 /* Increment a reference count to a volume, sans context swaps.  Requires
3466  * possibly reading the volume header in from the disk, since there's
3467  * an invariant in the volume package that nUsers>0 ==> vp->header is valid.
3468  *
3469  * N.B. This call can fail if we can't read in the header!!  In this case
3470  * we still guarantee we won't context swap, but the ref count won't be
3471  * incremented (otherwise we'd violate the invariant).
3472  */
3473 /* NOTE: with the demand attach fileserver extensions, the global lock
3474  * is dropped within VHold */
3475 #ifdef AFS_DEMAND_ATTACH_FS
3476 static int
3477 VHold_r(Volume * vp)
3478 {
3479     Error error;
3480
3481     VCreateReservation_r(vp);
3482     VWaitExclusiveState_r(vp);
3483
3484     LoadVolumeHeader(&error, vp);
3485     if (error) {
3486         VCancelReservation_r(vp);
3487         return error;
3488     }
3489     vp->nUsers++;
3490     VCancelReservation_r(vp);
3491     return 0;
3492 }
3493 #else /* AFS_DEMAND_ATTACH_FS */
3494 static int
3495 VHold_r(Volume * vp)
3496 {
3497     Error error;
3498
3499     LoadVolumeHeader(&error, vp);
3500     if (error)
3501         return error;
3502     vp->nUsers++;
3503     return 0;
3504 }
3505 #endif /* AFS_DEMAND_ATTACH_FS */
3506
3507 /**** volume timeout-related stuff ****/
3508
3509 #ifdef AFS_PTHREAD_ENV
3510
3511 static struct timespec *shutdown_timeout;
3512 static pthread_once_t shutdown_timeout_once = PTHREAD_ONCE_INIT;
3513
3514 static_inline int
3515 VTimedOut(const struct timespec *ts)
3516 {
3517     struct timeval tv;
3518     int code;
3519
3520     if (ts->tv_sec == 0) {
3521         /* short-circuit; this will have always timed out */
3522         return 1;
3523     }
3524
3525     code = gettimeofday(&tv, NULL);
3526     if (code) {
3527         Log("Error %d from gettimeofday, assuming we have not timed out\n", errno);
3528         /* assume no timeout; failure mode is we just wait longer than normal
3529          * instead of returning errors when we shouldn't */
3530         return 0;
3531     }
3532
3533     if (tv.tv_sec < ts->tv_sec ||
3534         (tv.tv_sec == ts->tv_sec && tv.tv_usec*1000 < ts->tv_nsec)) {
3535
3536         return 0;
3537     }
3538
3539     return 1;
3540 }
3541
3542 /**
3543  * Calculate an absolute timeout.
3544  *
3545  * @param[out] ts  A timeout that is "timeout" seconds from now, if we return
3546  *                 NULL, the memory is not touched
3547  * @param[in]  timeout  How long the timeout should be from now
3548  *
3549  * @return timeout to use
3550  *  @retval NULL      no timeout; wait forever
3551  *  @retval non-NULL  the given value for "ts"
3552  *
3553  * @internal
3554  */
3555 static struct timespec *
3556 VCalcTimeout(struct timespec *ts, afs_int32 timeout)
3557 {
3558     struct timeval now;
3559     int code;
3560
3561     if (timeout < 0) {
3562         return NULL;
3563     }
3564
3565     if (timeout == 0) {
3566         ts->tv_sec = ts->tv_nsec = 0;
3567         return ts;
3568     }
3569
3570     code = gettimeofday(&now, NULL);
3571     if (code) {
3572         Log("Error %d from gettimeofday, falling back to 'forever' timeout\n", errno);
3573         return NULL;
3574     }
3575
3576     ts->tv_sec = now.tv_sec + timeout;
3577     ts->tv_nsec = now.tv_usec * 1000;
3578
3579     return ts;
3580 }
3581
3582 /**
3583  * Initialize the shutdown_timeout global.
3584  */
3585 static void
3586 VShutdownTimeoutInit(void)
3587 {
3588     struct timespec *ts;
3589
3590     ts = malloc(sizeof(*ts));
3591
3592     shutdown_timeout = VCalcTimeout(ts, vol_opts.offline_shutdown_timeout);
3593
3594     if (!shutdown_timeout) {
3595         free(ts);
3596     }
3597 }
3598
3599 /**
3600  * Figure out the timeout that should be used for waiting for offline volumes.
3601  *
3602  * @param[out] ats  Storage space for a local timeout value if needed
3603  *
3604  * @return The timeout value that should be used
3605  *   @retval NULL      No timeout; wait forever for offlining volumes
3606  *   @retval non-NULL  A pointer to the absolute time that should be used as
3607  *                     the deadline for waiting for offlining volumes.
3608  *
3609  * @note If we return non-NULL, the pointer we return may or may not be the
3610  *       same as "ats"
3611  */
3612 static const struct timespec *
3613 VOfflineTimeout(struct timespec *ats)
3614 {
3615     if (vol_shutting_down) {
3616         osi_Assert(pthread_once(&shutdown_timeout_once, VShutdownTimeoutInit) == 0);
3617         return shutdown_timeout;
3618     } else {
3619         return VCalcTimeout(ats, vol_opts.offline_timeout);
3620     }
3621 }
3622
3623 #else /* AFS_PTHREAD_ENV */
3624
3625 /* Waiting a certain amount of time for offlining volumes is not supported
3626  * for LWP due to a lack of primitives. So, we never time out */
3627 # define VTimedOut(x) (0)
3628 # define VOfflineTimeout(x) (NULL)
3629
3630 #endif /* !AFS_PTHREAD_ENV */
3631
3632 #if 0
3633 static int
3634 VHold(Volume * vp)
3635 {
3636     int retVal;
3637     VOL_LOCK;
3638     retVal = VHold_r(vp);
3639     VOL_UNLOCK;
3640     return retVal;
3641 }
3642 #endif
3643
3644 static afs_int32
3645 VIsGoingOffline_r(struct Volume *vp)
3646 {
3647     afs_int32 code = 0;
3648
3649     if (vp->goingOffline) {
3650         if (vp->specialStatus) {
3651             code = vp->specialStatus;
3652         } else if (V_inService(vp) == 0 || V_blessed(vp) == 0) {
3653             code = VNOVOL;
3654         } else {
3655             code = VOFFLINE;
3656         }
3657     }
3658
3659     return code;
3660 }
3661
3662 /**
3663  * Tell the caller if a volume is waiting to go offline.
3664  *
3665  * @param[in] vp  The volume we want to know about
3666  *
3667  * @return volume status
3668  *   @retval 0 volume is not waiting to go offline, go ahead and use it
3669  *   @retval nonzero volume is waiting to offline, and give the returned code
3670  *           as an error to anyone accessing the volume
3671  *
3672  * @pre VOL_LOCK is NOT held
3673  * @pre caller holds a heavyweight reference on vp
3674  */
3675 afs_int32
3676 VIsGoingOffline(struct Volume *vp)
3677 {
3678     afs_int32 code;
3679
3680     VOL_LOCK;
3681     code = VIsGoingOffline_r(vp);
3682     VOL_UNLOCK;
3683
3684     return code;
3685 }
3686
3687 /**
3688  * Register an RX call with a volume.
3689  *
3690  * @param[inout] ec        Error code; if unset when passed in, may be set if
3691  *                         the volume starts going offline
3692  * @param[out]   client_ec @see GetVolume
3693  * @param[in] vp   Volume struct
3694  * @param[in] cbv  VCallByVol struct containing the RX call to register
3695  *
3696  * @pre VOL_LOCK held
3697  * @pre caller holds heavy ref on vp
3698  *
3699  * @internal
3700  */
3701 static void
3702 VRegisterCall_r(Error *ec, Error *client_ec, Volume *vp, struct VCallByVol *cbv)
3703 {
3704     if (vp && cbv) {
3705 #ifdef AFS_DEMAND_ATTACH_FS
3706         if (!*ec) {
3707             /* just in case the volume started going offline after we got the
3708              * reference to it... otherwise, if the volume started going
3709              * offline right at the end of GetVolume(), we might race with the
3710              * RX call scanner, and return success and add our cbv to the
3711              * rx_call_list _after_ the scanner has scanned the list. */
3712             *ec = VIsGoingOffline_r(vp);
3713             if (client_ec) {
3714                 *client_ec = *ec;
3715             }
3716         }
3717
3718         while (V_attachState(vp) == VOL_STATE_SCANNING_RXCALLS) {
3719             VWaitStateChange_r(vp);
3720         }
3721 #endif /* AFS_DEMAND_ATTACH_FS */
3722
3723         queue_Prepend(&vp->rx_call_list, cbv);
3724     }
3725 }
3726
3727 /**
3728  * Deregister an RX call with a volume.
3729  *
3730  * @param[in] vp   Volume struct
3731  * @param[in] cbv  VCallByVol struct containing the RX call to deregister
3732  *
3733  * @pre VOL_LOCK held
3734  * @pre caller holds heavy ref on vp
3735  *
3736  * @internal
3737  */
3738 static void
3739 VDeregisterCall_r(Volume *vp, struct VCallByVol *cbv)
3740 {
3741     if (cbv && queue_IsOnQueue(cbv)) {
3742 #ifdef AFS_DEMAND_ATTACH_FS
3743         while (V_attachState(vp) == VOL_STATE_SCANNING_RXCALLS) {
3744             VWaitStateChange_r(vp);
3745         }
3746 #endif /* AFS_DEMAND_ATTACH_FS */
3747
3748         queue_Remove(cbv);
3749     }
3750 }
3751
3752 /***************************************************/
3753 /* get and put volume routines                     */
3754 /***************************************************/
3755
3756 /**
3757  * put back a heavyweight reference to a volume object.
3758  *
3759  * @param[in] vp  volume object pointer
3760  *
3761  * @pre VOL_LOCK held
3762  *
3763  * @post heavyweight volume reference put back.
3764  *       depending on state, volume may have been taken offline,
3765  *       detached, salvaged, freed, etc.
3766  *
3767  * @internal volume package internal use only
3768  */
3769 void
3770 VPutVolume_r(Volume * vp)
3771 {
3772     osi_Assert(--vp->nUsers >= 0);
3773     if (vp->nUsers == 0) {
3774         VCheckOffline(vp);
3775         ReleaseVolumeHeader(vp->header);
3776 #ifdef AFS_DEMAND_ATTACH_FS
3777         if (!VCheckDetach(vp)) {
3778             VCheckSalvage(vp);
3779             VCheckFree(vp);
3780         }
3781 #else /* AFS_DEMAND_ATTACH_FS */
3782         VCheckDetach(vp);
3783 #endif /* AFS_DEMAND_ATTACH_FS */
3784     }
3785 }
3786
3787 void
3788 VPutVolume(Volume * vp)
3789 {
3790     VOL_LOCK;
3791     VPutVolume_r(vp);
3792     VOL_UNLOCK;
3793 }
3794
3795 /**
3796  * Puts a volume reference obtained with VGetVolumeWithCall.
3797  *
3798  * @param[in] vp  Volume struct
3799  * @param[in] cbv VCallByVol struct given to VGetVolumeWithCall, or NULL if none
3800  *
3801  * @pre VOL_LOCK is NOT held
3802  */
3803 void
3804 VPutVolumeWithCall(Volume *vp, struct VCallByVol *cbv)
3805 {
3806     VOL_LOCK;
3807     VDeregisterCall_r(vp, cbv);
3808     VPutVolume_r(vp);
3809     VOL_UNLOCK;
3810 }
3811
3812 /* Get a pointer to an attached volume.  The pointer is returned regardless
3813    of whether or not the volume is in service or on/off line.  An error
3814    code, however, is returned with an indication of the volume's status */
3815 Volume *
3816 VGetVolume(Error * ec, Error * client_ec, VolId volumeId)
3817 {
3818     Volume *retVal;
3819     VOL_LOCK;
3820     retVal = GetVolume(ec, client_ec, volumeId, NULL, 0);
3821     VOL_UNLOCK;
3822     return retVal;
3823 }
3824
3825 /**
3826  * Get a volume reference associated with an RX call.
3827  *
3828  * @param[out] ec @see GetVolume
3829  * @param[out] client_ec @see GetVolume
3830  * @param[in] volumeId @see GetVolume
3831  * @param[in] ts  How long to wait for going-offline volumes (absolute time).
3832  *                If NULL, wait forever. If ts->tv_sec == 0, return immediately
3833  *                with an error if the volume is going offline.
3834  * @param[in] cbv Contains an RX call to be associated with this volume
3835  *                reference. This call may be interrupted if the volume is
3836  *                requested to go offline while we hold a ref on it. Give NULL
3837  *                to not associate an RX call with this reference.
3838  *
3839  * @return @see GetVolume
3840  *
3841  * @note for LWP builds, ts must be NULL
3842  *
3843  * @note A reference obtained with this function MUST be put back with
3844  *       VPutVolumeWithCall
3845  */
3846 Volume *
3847 VGetVolumeWithCall(Error * ec, Error * client_ec, VolId volumeId,
3848                    const struct timespec *ts, struct VCallByVol *cbv)
3849 {
3850     Volume *retVal;
3851     VOL_LOCK;
3852     retVal = GetVolume(ec, client_ec, volumeId, NULL, ts);
3853     VRegisterCall_r(ec, client_ec, retVal, cbv);
3854     VOL_UNLOCK;
3855     return retVal;
3856 }
3857
3858 Volume *
3859 VGetVolume_r(Error * ec, VolId volumeId)
3860 {
3861     return GetVolume(ec, NULL, volumeId, NULL, NULL);
3862 }
3863
3864 /* try to get a volume we've previously looked up */
3865 /* for demand attach fs, caller MUST NOT hold a ref count on vp */
3866 Volume *
3867 VGetVolumeByVp_r(Error * ec, Volume * vp)
3868 {
3869     return GetVolume(ec, NULL, vp->hashid, vp, NULL);
3870 }
3871
3872 /**
3873  * private interface for getting a volume handle
3874  *
3875  * @param[out] ec         error code (0 if no error)
3876  * @param[out] client_ec  wire error code to be given to clients
3877  * @param[in]  volumeId   ID of the volume we want
3878  * @param[in]  hint       optional hint for hash lookups, or NULL
3879  * @param[in]  timeout    absolute deadline for waiting for the volume to go
3880  *                        offline, if it is going offline. NULL to wait forever.
3881  *
3882  * @return a volume handle for the specified volume
3883  *  @retval NULL an error occurred, or the volume is in such a state that
3884  *               we cannot load a header or return any volume struct
3885  *
3886  * @note for DAFS, caller must NOT hold a ref count on 'hint'
3887  *
3888  * @note 'timeout' is only checked if the volume is actually going offline; so
3889  *       if you pass timeout->tv_sec = 0, this will exhibit typical
3890  *       nonblocking behavior.
3891  *
3892  * @note for LWP builds, 'timeout' must be NULL
3893  */
3894 static Volume *
3895 GetVolume(Error * ec, Error * client_ec, VolId volumeId, Volume * hint,
3896           const struct timespec *timeout)
3897 {
3898     Volume *vp = hint;
3899     /* pull this profiling/debugging code out of regular builds */
3900 #ifdef notdef
3901 #define VGET_CTR_INC(x) x++
3902     unsigned short V0 = 0, V1 = 0, V2 = 0, V3 = 0, V5 = 0, V6 =
3903         0, V7 = 0, V8 = 0, V9 = 0;
3904     unsigned short V10 = 0, V11 = 0, V12 = 0, V13 = 0, V14 = 0, V15 = 0;
3905 #else
3906 #define VGET_CTR_INC(x)
3907 #endif
3908 #ifdef AFS_DEMAND_ATTACH_FS
3909     Volume *avp, * rvp = hint;
3910 #endif
3911
3912     /*
3913      * if VInit is zero, the volume package dynamic
3914      * data structures have not been initialized yet,
3915      * and we must immediately return an error
3916      */
3917     if (VInit == 0) {
3918         vp = NULL;
3919         *ec = VOFFLINE;
3920         if (client_ec) {
3921             *client_ec = VOFFLINE;
3922         }
3923         goto not_inited;
3924     }
3925
3926 #ifdef AFS_DEMAND_ATTACH_FS
3927     if (rvp) {
3928         VCreateReservation_r(rvp);
3929     }
3930 #endif /* AFS_DEMAND_ATTACH_FS */
3931
3932     for (;;) {
3933         *ec = 0;
3934         if (client_ec)
3935             *client_ec = 0;
3936         VGET_CTR_INC(V0);
3937
3938         vp = VLookupVolume_r(ec, volumeId, vp);
3939         if (*ec) {
3940             vp = NULL;
3941             break;
3942         }
3943
3944 #ifdef AFS_DEMAND_ATTACH_FS
3945         if (rvp && (rvp != vp)) {
3946             /* break reservation on old vp */
3947             VCancelReservation_r(rvp);
3948             rvp = NULL;
3949         }
3950 #endif /* AFS_DEMAND_ATTACH_FS */
3951
3952         if (!vp) {
3953             VGET_CTR_INC(V1);
3954             if (VInit < 2) {
3955                 VGET_CTR_INC(V2);
3956                 /* Until we have reached an initialization level of 2
3957                  * we don't know whether this volume exists or not.
3958                  * We can't sleep and retry later because before a volume
3959                  * is attached, the caller tries to get it first.  Just
3960                  * return VOFFLINE and the caller can choose whether to
3961                  * retry the command or not. */
3962                 *ec = VOFFLINE;
3963                 break;
3964             }
3965
3966             *ec = VNOVOL;
3967             break;
3968         }
3969
3970         VGET_CTR_INC(V3);
3971         IncUInt64(&VStats.hdr_gets);
3972
3973 #ifdef AFS_DEMAND_ATTACH_FS
3974         /* block if someone else is performing an exclusive op on this volume */
3975         if (rvp != vp) {
3976             rvp = vp;
3977             VCreateReservation_r(rvp);
3978         }
3979         VWaitExclusiveState_r(vp);
3980
3981         /* short circuit with VNOVOL in the following circumstances:
3982          *
3983          *   - VOL_STATE_ERROR
3984          *   - VOL_STATE_SHUTTING_DOWN
3985          */
3986         if ((V_attachState(vp) == VOL_STATE_ERROR) ||
3987             (V_attachState(vp) == VOL_STATE_SHUTTING_DOWN) ||
3988             (V_attachState(vp) == VOL_STATE_GOING_OFFLINE)) {
3989             *ec = VNOVOL;
3990             vp = NULL;
3991             break;
3992         }
3993
3994         /*
3995          * short circuit with VOFFLINE for VOL_STATE_UNATTACHED and
3996          *                    VNOVOL   for VOL_STATE_DELETED
3997          */
3998        if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
3999            (V_attachState(vp) == VOL_STATE_DELETED)) {
4000            if (vp->specialStatus) {
4001                *ec = vp->specialStatus;
4002            } else if (V_attachState(vp) == VOL_STATE_DELETED) {
4003                *ec = VNOVOL;
4004            } else {
4005                *ec = VOFFLINE;
4006            }
4007            vp = NULL;
4008            break;
4009        }
4010
4011         /* allowable states:
4012          *   - PREATTACHED
4013          *   - ATTACHED
4014          *   - SALVAGING
4015          *   - SALVAGE_REQ
4016          */
4017
4018         if (vp->salvage.requested) {
4019             VUpdateSalvagePriority_r(vp);
4020         }
4021
4022         if (V_attachState(vp) == VOL_STATE_PREATTACHED) {
4023             avp = VAttachVolumeByVp_r(ec, vp, 0);
4024             if (avp) {
4025                 if (vp != avp) {
4026                     /* VAttachVolumeByVp_r can return a pointer
4027                      * != the vp passed to it under certain
4028                      * conditions; make sure we don't leak
4029                      * reservations if that happens */
4030                     vp = avp;
4031                     VCancelReservation_r(rvp);
4032                     rvp = avp;
4033                     VCreateReservation_r(rvp);
4034                 }
4035                 VPutVolume_r(avp);
4036             }
4037             if (*ec) {
4038                 int endloop = 0;
4039                 switch (*ec) {
4040                 case VSALVAGING:
4041                     break;
4042                 case VOFFLINE:
4043                     if (!vp->pending_vol_op) {
4044                         endloop = 1;
4045                     }
4046                     break;
4047                 default:
4048                     *ec = VNOVOL;
4049                     endloop = 1;
4050                 }
4051                 if (endloop) {
4052                     vp = NULL;
4053                     break;
4054                 }
4055             }
4056         }
4057
4058         if (VIsSalvaging(vp) || (*ec == VSALVAGING)) {
4059             if (client_ec) {
4060                 /* see CheckVnode() in afsfileprocs.c for an explanation
4061                  * of this error code logic */
4062                 afs_uint32 now = FT_ApproxTime();
4063                 if ((vp->stats.last_salvage + (10 * 60)) >= now) {
4064                     *client_ec = VBUSY;
4065                 } else {
4066                     *client_ec = VRESTARTING;
4067                 }
4068             }
4069             *ec = VSALVAGING;
4070             vp = NULL;
4071             break;
4072         }
4073 #endif
4074
4075 #ifdef AFS_DEMAND_ATTACH_FS
4076         /*
4077          * this test MUST happen after VAttachVolymeByVp, so vol_op_state is
4078          * not VolOpRunningUnknown (attach2 would have converted it to Online
4079          * or Offline)
4080          */
4081
4082          /* only valid before/during demand attachment */
4083          osi_Assert(!vp->pending_vol_op || vp->pending_vol_op->vol_op_state != FSSYNC_VolOpRunningUnknown);
4084
4085          /* deny getvolume due to running mutually exclusive vol op */
4086          if (vp->pending_vol_op && vp->pending_vol_op->vol_op_state==FSSYNC_VolOpRunningOffline) {
4087            /*
4088             * volume cannot remain online during this volume operation.
4089             * notify client.
4090             */
4091            if (vp->specialStatus) {
4092                /*
4093                 * special status codes outrank normal VOFFLINE code
4094                 */
4095                *ec = vp->specialStatus;
4096                if (client_ec) {
4097                    *client_ec = vp->specialStatus;
4098                }
4099            } else {
4100                if (client_ec) {
4101                    /* see CheckVnode() in afsfileprocs.c for an explanation
4102                     * of this error code logic */
4103                    afs_uint32 now = FT_ApproxTime();
4104                    if ((vp->stats.last_vol_op + (10 * 60)) >= now) {
4105                        *client_ec = VBUSY;
4106                    } else {
4107                        *client_ec = VRESTARTING;
4108                    }
4109                }
4110                *ec = VOFFLINE;
4111            }
4112            VChangeState_r(vp, VOL_STATE_UNATTACHED);
4113            FreeVolumeHeader(vp);
4114            vp = NULL;
4115            break;
4116         }
4117 #endif /* AFS_DEMAND_ATTACH_FS */
4118
4119         LoadVolumeHeader(ec, vp);
4120         if (*ec) {
4121             VGET_CTR_INC(V6);
4122             /* Only log the error if it was a totally unexpected error.  Simply
4123              * a missing inode is likely to be caused by the volume being deleted */
4124             if (errno != ENXIO || LogLevel)
4125                 Log("Volume %u: couldn't reread volume header\n",
4126                     vp->hashid);
4127 #ifdef AFS_DEMAND_ATTACH_FS
4128             if (VCanScheduleSalvage()) {
4129                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
4130             } else {
4131                 FreeVolume(vp);
4132                 vp = NULL;
4133             }
4134 #else /* AFS_DEMAND_ATTACH_FS */
4135             FreeVolume(vp);
4136             vp = NULL;
4137 #endif /* AFS_DEMAND_ATTACH_FS */
4138             break;
4139         }
4140
4141         VGET_CTR_INC(V7);
4142         if (vp->shuttingDown) {
4143             VGET_CTR_INC(V8);
4144             *ec = VNOVOL;
4145             vp = NULL;
4146             break;
4147         }
4148
4149         if (programType == fileServer) {
4150             VGET_CTR_INC(V9);
4151             if (vp->goingOffline) {
4152                 if (timeout && VTimedOut(timeout)) {
4153                     /* we've timed out; don't wait for the vol */
4154                 } else {
4155                     VGET_CTR_INC(V10);
4156 #ifdef AFS_DEMAND_ATTACH_FS
4157                     /* wait for the volume to go offline */
4158                     if (V_attachState(vp) == VOL_STATE_GOING_OFFLINE) {
4159                         VTimedWaitStateChange_r(vp, timeout, NULL);
4160                     }
4161 #elif defined(AFS_PTHREAD_ENV)
4162                     VOL_CV_TIMEDWAIT(&vol_put_volume_cond, timeout, NULL);
4163 #else /* AFS_PTHREAD_ENV */
4164                     /* LWP has no timed wait, so the caller better not be
4165                      * expecting one */
4166                     osi_Assert(!timeout);
4167                     LWP_WaitProcess(VPutVolume);
4168 #endif /* AFS_PTHREAD_ENV */
4169                     continue;
4170                 }
4171             }
4172             if (vp->specialStatus) {
4173                 VGET_CTR_INC(V11);
4174                 *ec = vp->specialStatus;
4175             } else if (V_inService(vp) == 0 || V_blessed(vp) == 0) {
4176                 VGET_CTR_INC(V12);
4177                 *ec = VNOVOL;
4178             } else if (V_inUse(vp) == 0 || vp->goingOffline) {
4179                 VGET_CTR_INC(V13);
4180                 *ec = VOFFLINE;
4181             } else {
4182                 VGET_CTR_INC(V14);
4183             }
4184         }
4185         break;
4186     }
4187     VGET_CTR_INC(V15);
4188
4189 #ifdef AFS_DEMAND_ATTACH_FS
4190     /* if no error, bump nUsers */
4191     if (vp) {
4192         vp->nUsers++;
4193         VLRU_UpdateAccess_r(vp);
4194     }
4195     if (rvp) {
4196         VCancelReservation_r(rvp);
4197         rvp = NULL;
4198     }
4199     if (client_ec && !*client_ec) {
4200         *client_ec = *ec;
4201     }
4202 #else /* AFS_DEMAND_ATTACH_FS */
4203     /* if no error, bump nUsers */
4204     if (vp) {
4205         vp->nUsers++;
4206     }
4207     if (client_ec) {
4208         *client_ec = *ec;
4209     }
4210 #endif /* AFS_DEMAND_ATTACH_FS */
4211
4212  not_inited:
4213     osi_Assert(vp || *ec);
4214     return vp;
4215 }
4216
4217
4218 /***************************************************/
4219 /* Volume offline/detach routines                  */
4220 /***************************************************/
4221
4222 /* caller MUST hold a heavyweight ref on vp */
4223 #ifdef AFS_DEMAND_ATTACH_FS
4224 void
4225 VTakeOffline_r(Volume * vp)
4226 {
4227     Error error;
4228
4229     osi_Assert(vp->nUsers > 0);
4230     osi_Assert(programType == fileServer);
4231
4232     VCreateReservation_r(vp);
4233     VWaitExclusiveState_r(vp);
4234
4235     vp->goingOffline = 1;
4236     V_needsSalvaged(vp) = 1;
4237
4238     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0);
4239     VCancelReservation_r(vp);
4240 }
4241 #else /* AFS_DEMAND_ATTACH_FS */
4242 void
4243 VTakeOffline_r(Volume * vp)
4244 {
4245     osi_Assert(vp->nUsers > 0);
4246     osi_Assert(programType == fileServer);
4247
4248     vp->goingOffline = 1;
4249     V_needsSalvaged(vp) = 1;
4250 }
4251 #endif /* AFS_DEMAND_ATTACH_FS */
4252
4253 void
4254 VTakeOffline(Volume * vp)
4255 {
4256     VOL_LOCK;
4257     VTakeOffline_r(vp);
4258     VOL_UNLOCK;
4259 }
4260
4261 /**
4262  * force a volume offline.
4263  *
4264  * @param[in] vp     volume object pointer
4265  * @param[in] flags  flags (see note below)
4266  *
4267  * @note the flag VOL_FORCEOFF_NOUPDATE is a recursion control flag
4268  *       used when VUpdateVolume_r needs to call VForceOffline_r
4269  *       (which in turn would normally call VUpdateVolume_r)
4270  *
4271  * @see VUpdateVolume_r
4272  *
4273  * @pre VOL_LOCK must be held.
4274  *      for DAFS, caller must hold ref.
4275  *
4276  * @note for DAFS, it _is safe_ to call this function from an
4277  *       exclusive state
4278  *
4279  * @post needsSalvaged flag is set.
4280  *       for DAFS, salvage is requested.
4281  *       no further references to the volume through the volume
4282  *       package will be honored.
4283  *       all file descriptor and vnode caches are invalidated.
4284  *
4285  * @warning this is a heavy-handed interface.  it results in
4286  *          a volume going offline regardless of the current
4287  *          reference count state.
4288  *
4289  * @internal  volume package internal use only
4290  */
4291 void
4292 VForceOffline_r(Volume * vp, int flags)
4293 {
4294     Error error;
4295     if (!V_inUse(vp)) {
4296 #ifdef AFS_DEMAND_ATTACH_FS
4297         VChangeState_r(vp, VOL_STATE_ERROR);
4298 #endif
4299         return;
4300     }
4301
4302     strcpy(V_offlineMessage(vp),
4303            "Forced offline due to internal error: volume needs to be salvaged");
4304     Log("Volume %u forced offline:  it needs salvaging!\n", V_id(vp));
4305
4306     V_inUse(vp) = 0;
4307     vp->goingOffline = 0;
4308     V_needsSalvaged(vp) = 1;
4309     if (!(flags & VOL_FORCEOFF_NOUPDATE)) {
4310         VUpdateVolume_r(&error, vp, VOL_UPDATE_NOFORCEOFF);
4311     }
4312
4313 #ifdef AFS_DEMAND_ATTACH_FS
4314     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
4315 #endif /* AFS_DEMAND_ATTACH_FS */
4316
4317 #ifdef AFS_PTHREAD_ENV
4318     CV_BROADCAST(&vol_put_volume_cond);
4319 #else /* AFS_PTHREAD_ENV */
4320     LWP_NoYieldSignal(VPutVolume);
4321 #endif /* AFS_PTHREAD_ENV */
4322
4323     VReleaseVolumeHandles_r(vp);
4324 }
4325
4326 /**
4327  * force a volume offline.
4328  *
4329  * @param[in] vp  volume object pointer
4330  *
4331  * @see VForceOffline_r
4332  */
4333 void
4334 VForceOffline(Volume * vp)
4335 {
4336     VOL_LOCK;
4337     VForceOffline_r(vp, 0);
4338     VOL_UNLOCK;
4339 }
4340
4341 /**
4342  * Iterate over the RX calls associated with a volume, and interrupt them.
4343  *
4344  * @param[in] vp The volume whose RX calls we want to scan
4345  *
4346  * @pre VOL_LOCK held
4347  */
4348 static void
4349 VScanCalls_r(struct Volume *vp)
4350 {
4351     struct VCallByVol *cbv, *ncbv;
4352     afs_int32 err;
4353 #ifdef AFS_DEMAND_ATTACH_FS
4354     VolState state_save;
4355 #endif
4356
4357     if (queue_IsEmpty(&vp->rx_call_list))
4358         return; /* no calls to interrupt */
4359     if (!vol_opts.interrupt_rxcall)
4360         return; /* we have no function with which to interrupt calls */
4361     err = VIsGoingOffline_r(vp);
4362     if (!err)
4363         return; /* we're not going offline anymore */
4364
4365 #ifdef AFS_DEMAND_ATTACH_FS
4366     VWaitExclusiveState_r(vp);
4367     state_save = VChangeState_r(vp, VOL_STATE_SCANNING_RXCALLS);
4368     VOL_UNLOCK;
4369 #endif /* AFS_DEMAND_ATTACH_FS */
4370
4371     for(queue_Scan(&vp->rx_call_list, cbv, ncbv, VCallByVol)) {
4372         if (LogLevel > 0) {
4373             struct rx_peer *peer;
4374             char hoststr[16];
4375             peer = rx_PeerOf(rx_ConnectionOf(cbv->call));
4376
4377             Log("Offlining volume %lu while client %s:%u is trying to read "
4378                 "from it; kicking client off with error %ld\n",
4379                 (long unsigned) vp->hashid,
4380                 afs_inet_ntoa_r(rx_HostOf(peer), hoststr),
4381                 (unsigned) ntohs(rx_PortOf(peer)),
4382                 (long) err);
4383         }
4384         (*vol_opts.interrupt_rxcall) (cbv->call, err);
4385     }
4386
4387 #ifdef AFS_DEMAND_ATTACH_FS
4388     VOL_LOCK;
4389     VChangeState_r(vp, state_save);
4390 #endif /* AFS_DEMAND_ATTACH_FS */
4391 }
4392
4393 #ifdef AFS_DEMAND_ATTACH_FS
4394 /**
4395  * Wait for a vp to go offline.
4396  *
4397  * @param[out] ec 1 if a salvage on the volume has been requested and
4398  *                salvok == 0, 0 otherwise
4399  * @param[in] vp  The volume to wait for
4400  * @param[in] salvok  If 0, we return immediately with *ec = 1 if the volume
4401  *                    has been requested to salvage. Otherwise we keep waiting
4402  *                    until the volume has gone offline.
4403  *
4404  * @pre VOL_LOCK held
4405  * @pre caller holds a lightweight ref on vp
4406  *
4407  * @note DAFS only
4408  */
4409 static void
4410 VWaitForOfflineByVp_r(Error *ec, struct Volume *vp, int salvok)
4411 {
4412     struct timespec timeout_ts;
4413     const struct timespec *ts;
4414     int timedout = 0;
4415
4416     ts = VOfflineTimeout(&timeout_ts);
4417
4418     *ec = 0;
4419
4420     while (!VIsOfflineState(V_attachState(vp)) && !timedout) {
4421         if (!salvok && vp->salvage.requested) {
4422             *ec = 1;
4423             return;
4424         }
4425         VTimedWaitStateChange_r(vp, ts, &timedout);
4426     }
4427     if (!timedout) {
4428         /* we didn't time out, so the volume must be offline, so we're done */
4429         return;
4430     }
4431
4432     /* If we got here, we timed out waiting for the volume to go offline.
4433      * Kick off the accessing RX calls and wait again */
4434
4435     VScanCalls_r(vp);
4436
4437     while (!VIsOfflineState(V_attachState(vp))) {
4438         if (!salvok && vp->salvage.requested) {
4439             *ec = 1;
4440             return;
4441         }
4442
4443         VWaitStateChange_r(vp);
4444     }
4445 }
4446
4447 #else /* AFS_DEMAND_ATTACH_FS */
4448
4449 /**
4450  * Wait for a volume to go offline.
4451  *
4452  * @pre VOL_LOCK held
4453  *
4454  * @note non-DAFS only (for DAFS, use @see WaitForOfflineByVp_r)
4455  */
4456 static void
4457 VWaitForOffline_r(Error *ec, VolumeId volid)
4458 {
4459     struct Volume *vp;
4460     const struct timespec *ts;
4461 #ifdef AFS_PTHREAD_ENV
4462     struct timespec timeout_ts;
4463 #endif
4464
4465     ts = VOfflineTimeout(&timeout_ts);
4466
4467     vp = GetVolume(ec, NULL, volid, NULL, ts);
4468     if (!vp) {
4469         /* error occurred so bad that we can't even get a vp; we have no
4470          * information on the vol so we don't know whether to wait, so just
4471          * return */
4472         return;
4473     }
4474     if (!VIsGoingOffline_r(vp)) {
4475         /* volume is no longer going offline, so we're done */
4476         VPutVolume_r(vp);
4477         return;
4478     }
4479
4480     /* If we got here, we timed out waiting for the volume to go offline.
4481      * Kick off the accessing RX calls and wait again */
4482
4483     VScanCalls_r(vp);
4484     VPutVolume_r(vp);
4485     vp = NULL;
4486
4487     vp = VGetVolume_r(ec, volid);
4488     if (vp) {
4489         /* In case it was reattached... */
4490         VPutVolume_r(vp);
4491     }
4492 }
4493 #endif /* !AFS_DEMAND_ATTACH_FS */
4494
4495 /* The opposite of VAttachVolume.  The volume header is written to disk, with
4496    the inUse bit turned off.  A copy of the header is maintained in memory,
4497    however (which is why this is VOffline, not VDetach).
4498  */
4499 void
4500 VOffline_r(Volume * vp, char *message)
4501 {
4502     Error error;
4503 #ifndef AFS_DEMAND_ATTACH_FS
4504     VolumeId vid = V_id(vp);
4505 #endif
4506
4507     osi_Assert(programType != volumeUtility && programType != volumeServer);
4508     if (!V_inUse(vp)) {
4509         VPutVolume_r(vp);
4510         return;
4511     }
4512     if (V_offlineMessage(vp)[0] == '\0')
4513         strncpy(V_offlineMessage(vp), message, sizeof(V_offlineMessage(vp)));
4514     V_offlineMessage(vp)[sizeof(V_offlineMessage(vp)) - 1] = '\0';
4515
4516     vp->goingOffline = 1;
4517 #ifdef AFS_DEMAND_ATTACH_FS
4518     VChangeState_r(vp, VOL_STATE_GOING_OFFLINE);
4519     VCreateReservation_r(vp);
4520     VPutVolume_r(vp);
4521     VWaitForOfflineByVp_r(&error, vp, 1);
4522     VCancelReservation_r(vp);
4523 #else /* AFS_DEMAND_ATTACH_FS */
4524     VPutVolume_r(vp);
4525     VWaitForOffline_r(&error, vid);
4526 #endif /* AFS_DEMAND_ATTACH_FS */
4527 }
4528
4529 #ifdef AFS_DEMAND_ATTACH_FS
4530 /**
4531  * Take a volume offline in order to perform a volume operation.
4532  *
4533  * @param[inout] ec       address in which to store error code
4534  * @param[in]    vp       volume object pointer
4535  * @param[in]    message  volume offline status message
4536  *
4537  * @pre
4538  *    - VOL_LOCK is held
4539  *    - caller MUST hold a heavyweight ref on vp
4540  *
4541  * @post
4542  *    - volume is taken offline
4543  *    - if possible, volume operation is promoted to running state
4544  *    - on failure, *ec is set to nonzero
4545  *
4546  * @note Although this function does not return any value, it may
4547  *       still fail to promote our pending volume operation to
4548  *       a running state.  Any caller MUST check the value of *ec,
4549  *       and MUST NOT blindly assume success.
4550  *
4551  * @warning if the caller does not hold a lightweight ref on vp,
4552  *          then it MUST NOT reference vp after this function
4553  *          returns to the caller.
4554  *
4555  * @internal volume package internal use only
4556  */
4557 void
4558 VOfflineForVolOp_r(Error *ec, Volume *vp, char *message)
4559 {
4560     int salvok = 1;
4561     osi_Assert(vp->pending_vol_op);
4562     if (!V_inUse(vp)) {
4563         VPutVolume_r(vp);
4564         *ec = 1;
4565         return;
4566     }
4567     if (V_offlineMessage(vp)[0] == '\0')
4568         strncpy(V_offlineMessage(vp), message, sizeof(V_offlineMessage(vp)));
4569     V_offlineMessage(vp)[sizeof(V_offlineMessage(vp)) - 1] = '\0';
4570
4571     vp->goingOffline = 1;
4572     VChangeState_r(vp, VOL_STATE_GOING_OFFLINE);
4573     VCreateReservation_r(vp);
4574     VPutVolume_r(vp);
4575
4576     if (vp->pending_vol_op->com.programType != salvageServer) {
4577         /* do not give corrupted volumes to the volserver */
4578         salvok = 0;
4579     }
4580
4581     *ec = 0;
4582     VWaitForOfflineByVp_r(ec, vp, salvok);
4583
4584     VCancelReservation_r(vp);
4585 }
4586 #endif /* AFS_DEMAND_ATTACH_FS */
4587
4588 void
4589 VOffline(Volume * vp, char *message)
4590 {
4591     VOL_LOCK;
4592     VOffline_r(vp, message);
4593     VOL_UNLOCK;
4594 }
4595
4596 /* This gets used for the most part by utility routines that don't want
4597  * to keep all the volume headers around.  Generally, the file server won't
4598  * call this routine, because then the offline message in the volume header
4599  * (or other information) won't be available to clients. For NAMEI, also
4600  * close the file handles.  However, the fileserver does call this during
4601  * an attach following a volume operation.
4602  */
4603 void
4604 VDetachVolume_r(Error * ec, Volume * vp)
4605 {
4606 #ifdef FSSYNC_BUILD_CLIENT
4607     VolumeId volume;
4608     struct DiskPartition64 *tpartp;
4609     int notifyServer = 0;
4610     int  useDone = FSYNC_VOL_ON;
4611
4612     if (VCanUseFSSYNC()) {
4613         notifyServer = vp->needsPutBack;
4614         if (V_destroyMe(vp) == DESTROY_ME)
4615             useDone = FSYNC_VOL_LEAVE_OFF;
4616 # ifdef AFS_DEMAND_ATTACH_FS
4617         else if (!V_blessed(vp) || !V_inService(vp))
4618             useDone = FSYNC_VOL_LEAVE_OFF;
4619 # endif
4620     }
4621 # ifdef AFS_DEMAND_ATTACH_FS
4622     if (V_needsSalvaged(vp)) {
4623         notifyServer = 0;
4624         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, 0);
4625     }
4626 # endif
4627     tpartp = vp->partition;
4628     volume = V_id(vp);
4629 #endif /* FSSYNC_BUILD_CLIENT */
4630
4631     *ec = 0;                    /* always "succeeds" */
4632     DeleteVolumeFromHashTable(vp);
4633     vp->shuttingDown = 1;
4634 #ifdef AFS_DEMAND_ATTACH_FS
4635     DeleteVolumeFromVByPList_r(vp);
4636     VLRU_Delete_r(vp);
4637     VChangeState_r(vp, VOL_STATE_SHUTTING_DOWN);
4638 #else
4639     if (programType != fileServer)
4640         V_inUse(vp) = 0;
4641 #endif /* AFS_DEMAND_ATTACH_FS */
4642     VPutVolume_r(vp);
4643     /* Will be detached sometime in the future--this is OK since volume is offline */
4644
4645     /* XXX the following code should really be moved to VCheckDetach() since the volume
4646      * is not technically detached until the refcounts reach zero
4647      */
4648 #ifdef FSSYNC_BUILD_CLIENT
4649     if (VCanUseFSSYNC() && notifyServer) {
4650         if (notifyServer == VOL_PUTBACK_DELETE) {
4651             /* Only send FSYNC_VOL_DONE if the volume was actually deleted.
4652              * volserver code will set needsPutBack to VOL_PUTBACK_DELETE
4653              * to signify a deleted volume. */
4654             useDone = FSYNC_VOL_DONE;
4655         }
4656         /*
4657          * Note:  The server is not notified in the case of a bogus volume
4658          * explicitly to make it possible to create a volume, do a partial
4659          * restore, then abort the operation without ever putting the volume
4660          * online.  This is essential in the case of a volume move operation
4661          * between two partitions on the same server.  In that case, there
4662          * would be two instances of the same volume, one of them bogus,
4663          * which the file server would attempt to put on line
4664          */
4665         FSYNC_VolOp(volume, tpartp->name, useDone, 0, NULL);
4666         /* XXX this code path is only hit by volume utilities, thus
4667          * V_BreakVolumeCallbacks will always be NULL.  if we really
4668          * want to break callbacks in this path we need to use FSYNC_VolOp() */
4669 #ifdef notdef
4670         /* Dettaching it so break all callbacks on it */
4671         if (V_BreakVolumeCallbacks) {
4672             Log("volume %u detached; breaking all call backs\n", volume);
4673             (*V_BreakVolumeCallbacks) (volume);
4674         }
4675 #endif
4676     }
4677 #endif /* FSSYNC_BUILD_CLIENT */
4678 }
4679
4680 void
4681 VDetachVolume(Error * ec, Volume * vp)
4682 {
4683     VOL_LOCK;
4684     VDetachVolume_r(ec, vp);
4685     VOL_UNLOCK;
4686 }
4687
4688
4689 /***************************************************/
4690 /* Volume fd/inode handle closing routines         */
4691 /***************************************************/
4692
4693 /* For VDetachVolume, we close all cached file descriptors, but keep
4694  * the Inode handles in case we need to read from a busy volume.
4695  */
4696 /* for demand attach, caller MUST hold ref count on vp */
4697 static void
4698 VCloseVolumeHandles_r(Volume * vp)
4699 {
4700 #ifdef AFS_DEMAND_ATTACH_FS
4701     VolState state_save;
4702
4703     state_save = VChangeState_r(vp, VOL_STATE_OFFLINING);
4704
4705     VOL_UNLOCK;
4706 #endif
4707
4708     DFlushVolume(vp->hashid);
4709
4710 #ifdef AFS_DEMAND_ATTACH_FS
4711     VOL_LOCK;
4712 #endif
4713
4714     /* DAFS: VCloseVnodeFiles_r drops the glock internally */
4715     VCloseVnodeFiles_r(vp);
4716
4717 #ifdef AFS_DEMAND_ATTACH_FS
4718     VOL_UNLOCK;
4719 #endif
4720
4721     /* Too time consuming and unnecessary for the volserver */
4722     if (programType == fileServer) {
4723         IH_CONDSYNC(vp->vnodeIndex[vLarge].handle);
4724         IH_CONDSYNC(vp->vnodeIndex[vSmall].handle);
4725         IH_CONDSYNC(vp->diskDataHandle);
4726 #ifdef AFS_NT40_ENV
4727         IH_CONDSYNC(vp->linkHandle);
4728 #endif /* AFS_NT40_ENV */
4729     }
4730
4731     IH_REALLYCLOSE(vp->vnodeIndex[vLarge].handle);
4732     IH_REALLYCLOSE(vp->vnodeIndex[vSmall].handle);
4733     IH_REALLYCLOSE(vp->diskDataHandle);
4734     IH_REALLYCLOSE(vp->linkHandle);
4735
4736 #ifdef AFS_DEMAND_ATTACH_FS
4737     if ((V_attachFlags(vp) & VOL_LOCKED)) {
4738         VUnlockVolume(vp);
4739     }
4740
4741     VOL_LOCK;
4742     VChangeState_r(vp, state_save);
4743 #endif
4744 }
4745
4746 /* For both VForceOffline and VOffline, we close all relevant handles.
4747  * For VOffline, if we re-attach the volume, the files may possible be
4748  * different than before.
4749  */
4750 /* for demand attach, caller MUST hold a ref count on vp */
4751 static void
4752 VReleaseVolumeHandles_r(Volume * vp)
4753 {
4754 #ifdef AFS_DEMAND_ATTACH_FS
4755     VolState state_save;
4756
4757     state_save = VChangeState_r(vp, VOL_STATE_DETACHING);
4758
4759     VOL_UNLOCK;
4760 #endif
4761
4762     DFlushVolume(vp->hashid);
4763
4764 #ifdef AFS_DEMAND_ATTACH_FS
4765     VOL_LOCK;
4766 #endif
4767
4768     VReleaseVnodeFiles_r(vp); /* DAFS: releases the glock internally */
4769
4770 #ifdef AFS_DEMAND_ATTACH_FS
4771     VOL_UNLOCK;
4772 #endif
4773
4774     /* Too time consuming and unnecessary for the volserver */
4775     if (programType == fileServer) {
4776         IH_CONDSYNC(vp->vnodeIndex[vLarge].handle);
4777         IH_CONDSYNC(vp->vnodeIndex[vSmall].handle);
4778         IH_CONDSYNC(vp->diskDataHandle);
4779 #ifdef AFS_NT40_ENV
4780         IH_CONDSYNC(vp->linkHandle);
4781 #endif /* AFS_NT40_ENV */
4782     }
4783
4784     IH_RELEASE(vp->vnodeIndex[vLarge].handle);
4785     IH_RELEASE(vp->vnodeIndex[vSmall].handle);
4786     IH_RELEASE(vp->diskDataHandle);
4787     IH_RELEASE(vp->linkHandle);
4788
4789 #ifdef AFS_DEMAND_ATTACH_FS
4790     if ((V_attachFlags(vp) & VOL_LOCKED)) {
4791         VUnlockVolume(vp);
4792     }
4793
4794     VOL_LOCK;
4795     VChangeState_r(vp, state_save);
4796 #endif
4797 }
4798
4799
4800 /***************************************************/
4801 /* Volume write and fsync routines                 */
4802 /***************************************************/
4803
4804 void
4805 VUpdateVolume_r(Error * ec, Volume * vp, int flags)
4806 {
4807 #ifdef AFS_DEMAND_ATTACH_FS
4808     VolState state_save;
4809
4810     if (flags & VOL_UPDATE_WAIT) {
4811         VCreateReservation_r(vp);
4812         VWaitExclusiveState_r(vp);
4813     }
4814 #endif
4815
4816     *ec = 0;
4817     if (programType == fileServer)
4818         V_uniquifier(vp) =
4819             (V_inUse(vp) ? V_nextVnodeUnique(vp) +
4820              200 : V_nextVnodeUnique(vp));
4821
4822 #ifdef AFS_DEMAND_ATTACH_FS
4823     state_save = VChangeState_r(vp, VOL_STATE_UPDATING);
4824     VOL_UNLOCK;
4825 #endif
4826
4827     WriteVolumeHeader_r(ec, vp);
4828
4829 #ifdef AFS_DEMAND_ATTACH_FS
4830     VOL_LOCK;
4831     VChangeState_r(vp, state_save);
4832     if (flags & VOL_UPDATE_WAIT) {
4833         VCancelReservation_r(vp);
4834     }
4835 #endif
4836
4837     if (*ec) {
4838         Log("VUpdateVolume: error updating volume header, volume %u (%s)\n",
4839             V_id(vp), V_name(vp));
4840         /* try to update on-disk header,
4841          * while preventing infinite recursion */
4842         if (!(flags & VOL_UPDATE_NOFORCEOFF)) {
4843             VForceOffline_r(vp, VOL_FORCEOFF_NOUPDATE);
4844         }
4845     }
4846 }
4847
4848 void
4849 VUpdateVolume(Error * ec, Volume * vp)
4850 {
4851     VOL_LOCK;
4852     VUpdateVolume_r(ec, vp, VOL_UPDATE_WAIT);
4853     VOL_UNLOCK;
4854 }
4855
4856 void
4857 VSyncVolume_r(Error * ec, Volume * vp, int flags)
4858 {
4859     FdHandle_t *fdP;
4860     int code;
4861 #ifdef AFS_DEMAND_ATTACH_FS
4862     VolState state_save;
4863 #endif
4864
4865     if (flags & VOL_SYNC_WAIT) {
4866         VUpdateVolume_r(ec, vp, VOL_UPDATE_WAIT);
4867     } else {
4868         VUpdateVolume_r(ec, vp, 0);
4869     }
4870     if (!*ec) {
4871 #ifdef AFS_DEMAND_ATTACH_FS
4872         state_save = VChangeState_r(vp, VOL_STATE_UPDATING);
4873         VOL_UNLOCK;
4874 #endif
4875         fdP = IH_OPEN(V_diskDataHandle(vp));
4876         osi_Assert(fdP != NULL);
4877         code = FDH_SYNC(fdP);
4878         osi_Assert(code == 0);
4879         FDH_CLOSE(fdP);
4880 #ifdef AFS_DEMAND_ATTACH_FS
4881         VOL_LOCK;
4882         VChangeState_r(vp, state_save);
4883 #endif
4884     }
4885 }
4886
4887 void
4888 VSyncVolume(Error * ec, Volume * vp)
4889 {
4890     VOL_LOCK;
4891     VSyncVolume_r(ec, vp, VOL_SYNC_WAIT);
4892     VOL_UNLOCK;
4893 }
4894
4895
4896 /***************************************************/
4897 /* Volume dealloaction routines                    */
4898 /***************************************************/
4899
4900 #ifdef AFS_DEMAND_ATTACH_FS
4901 static void
4902 FreeVolume(Volume * vp)
4903 {
4904     /* free the heap space, iff it's safe.
4905      * otherwise, pull it out of the hash table, so it
4906      * will get deallocated when all refs to it go away */
4907     if (!VCheckFree(vp)) {
4908         DeleteVolumeFromHashTable(vp);
4909         DeleteVolumeFromVByPList_r(vp);
4910
4911         /* make sure we invalidate the header cache entry */
4912         FreeVolumeHeader(vp);
4913     }
4914 }
4915 #endif /* AFS_DEMAND_ATTACH_FS */
4916
4917 static void
4918 ReallyFreeVolume(Volume * vp)
4919 {
4920     int i;
4921     if (!vp)
4922         return;
4923 #ifdef AFS_DEMAND_ATTACH_FS
4924     /* debug */
4925     VChangeState_r(vp, VOL_STATE_FREED);
4926     if (vp->pending_vol_op)
4927         free(vp->pending_vol_op);
4928 #endif /* AFS_DEMAND_ATTACH_FS */
4929     for (i = 0; i < nVNODECLASSES; i++)
4930         if (vp->vnodeIndex[i].bitmap)
4931             free(vp->vnodeIndex[i].bitmap);
4932     FreeVolumeHeader(vp);
4933 #ifndef AFS_DEMAND_ATTACH_FS
4934     DeleteVolumeFromHashTable(vp);
4935 #endif /* AFS_DEMAND_ATTACH_FS */
4936     free(vp);
4937 }
4938
4939 /* check to see if we should shutdown this volume
4940  * returns 1 if volume was freed, 0 otherwise */
4941 #ifdef AFS_DEMAND_ATTACH_FS
4942 static int
4943 VCheckDetach(Volume * vp)
4944 {
4945     int ret = 0;
4946     Error ec = 0;
4947
4948     if (vp->nUsers || vp->nWaiters)
4949         return ret;
4950
4951     if (vp->shuttingDown) {
4952         ret = 1;
4953         if ((programType != fileServer) &&
4954             (V_inUse(vp) == programType) &&
4955             ((V_checkoutMode(vp) == V_VOLUPD) ||
4956              (V_checkoutMode(vp) == V_SECRETLY) ||
4957              ((V_checkoutMode(vp) == V_CLONE) &&
4958               (VolumeWriteable(vp))))) {
4959             V_inUse(vp) = 0;
4960             VUpdateVolume_r(&ec, vp, VOL_UPDATE_NOFORCEOFF);
4961             if (ec) {
4962                 Log("VCheckDetach: volume header update for volume %u "
4963                     "failed with errno %d\n", vp->hashid, errno);
4964             }
4965         }
4966         VReleaseVolumeHandles_r(vp);
4967         VCheckSalvage(vp);
4968         ReallyFreeVolume(vp);
4969         if (programType == fileServer) {
4970             CV_BROADCAST(&vol_put_volume_cond);
4971         }
4972     }
4973     return ret;
4974 }
4975 #else /* AFS_DEMAND_ATTACH_FS */
4976 static int
4977 VCheckDetach(Volume * vp)
4978 {
4979     int ret = 0;
4980     Error ec = 0;
4981
4982     if (vp->nUsers)
4983         return ret;
4984
4985     if (vp->shuttingDown) {
4986         ret = 1;
4987         if ((programType != fileServer) &&
4988             (V_inUse(vp) == programType) &&
4989             ((V_checkoutMode(vp) == V_VOLUPD) ||
4990              (V_checkoutMode(vp) == V_SECRETLY) ||
4991              ((V_checkoutMode(vp) == V_CLONE) &&
4992               (VolumeWriteable(vp))))) {
4993             V_inUse(vp) = 0;
4994             VUpdateVolume_r(&ec, vp, VOL_UPDATE_NOFORCEOFF);
4995             if (ec) {
4996                 Log("VCheckDetach: volume header update for volume %u failed with errno %d\n",
4997                     vp->hashid, errno);
4998             }
4999         }
5000         VReleaseVolumeHandles_r(vp);
5001         ReallyFreeVolume(vp);
5002         if (programType == fileServer) {
5003 #if defined(AFS_PTHREAD_ENV)
5004             CV_BROADCAST(&vol_put_volume_cond);
5005 #else /* AFS_PTHREAD_ENV */
5006             LWP_NoYieldSignal(VPutVolume);
5007 #endif /* AFS_PTHREAD_ENV */
5008         }
5009     }
5010     return ret;
5011 }
5012 #endif /* AFS_DEMAND_ATTACH_FS */
5013
5014 /* check to see if we should offline this volume
5015  * return 1 if volume went offline, 0 otherwise */
5016 #ifdef AFS_DEMAND_ATTACH_FS
5017 static int
5018 VCheckOffline(Volume * vp)
5019 {
5020     int ret = 0;
5021
5022     if (vp->goingOffline && !vp->nUsers) {
5023         Error error;
5024         osi_Assert(programType == fileServer);
5025         osi_Assert((V_attachState(vp) != VOL_STATE_ATTACHED) &&
5026                (V_attachState(vp) != VOL_STATE_FREED) &&
5027                (V_attachState(vp) != VOL_STATE_PREATTACHED) &&
5028                (V_attachState(vp) != VOL_STATE_UNATTACHED) &&
5029                (V_attachState(vp) != VOL_STATE_DELETED));
5030
5031         /* valid states:
5032          *
5033          * VOL_STATE_GOING_OFFLINE
5034          * VOL_STATE_SHUTTING_DOWN
5035          * VIsErrorState(V_attachState(vp))
5036          * VIsExclusiveState(V_attachState(vp))
5037          */
5038
5039         VCreateReservation_r(vp);
5040         VChangeState_r(vp, VOL_STATE_OFFLINING);
5041
5042         ret = 1;
5043         /* must clear the goingOffline flag before we drop the glock */
5044         vp->goingOffline = 0;
5045         V_inUse(vp) = 0;
5046
5047         VLRU_Delete_r(vp);
5048
5049         /* perform async operations */
5050         VUpdateVolume_r(&error, vp, 0);
5051         VCloseVolumeHandles_r(vp);
5052
5053         if (LogLevel) {
5054             if (V_offlineMessage(vp)[0]) {
5055                 Log("VOffline: Volume %lu (%s) is now offline (%s)\n",
5056                     afs_printable_uint32_lu(V_id(vp)), V_name(vp),
5057                     V_offlineMessage(vp));
5058             } else {
5059                 Log("VOffline: Volume %lu (%s) is now offline\n",
5060                     afs_printable_uint32_lu(V_id(vp)), V_name(vp));
5061             }
5062         }
5063
5064         /* invalidate the volume header cache entry */
5065         FreeVolumeHeader(vp);
5066
5067         /* if nothing changed state to error or salvaging,
5068          * drop state to unattached */
5069         if (!VIsErrorState(V_attachState(vp))) {
5070             VChangeState_r(vp, VOL_STATE_UNATTACHED);
5071         }
5072         VCancelReservation_r(vp);
5073         /* no usage of vp is safe beyond this point */
5074     }
5075     return ret;
5076 }
5077 #else /* AFS_DEMAND_ATTACH_FS */
5078 static int
5079 VCheckOffline(Volume * vp)
5080 {
5081     int ret = 0;
5082
5083     if (vp->goingOffline && !vp->nUsers) {
5084         Error error;
5085         osi_Assert(programType == fileServer);
5086
5087         ret = 1;
5088         vp->goingOffline = 0;
5089         V_inUse(vp) = 0;
5090         VUpdateVolume_r(&error, vp, 0);
5091         VCloseVolumeHandles_r(vp);
5092         if (LogLevel) {
5093             if (V_offlineMessage(vp)[0]) {
5094                 Log("VOffline: Volume %lu (%s) is now offline (%s)\n",
5095                     afs_printable_uint32_lu(V_id(vp)), V_name(vp),
5096                     V_offlineMessage(vp));
5097             } else {
5098                 Log("VOffline: Volume %lu (%s) is now offline\n",
5099                     afs_printable_uint32_lu(V_id(vp)), V_name(vp));
5100             }
5101         }
5102         FreeVolumeHeader(vp);
5103 #ifdef AFS_PTHREAD_ENV
5104         CV_BROADCAST(&vol_put_volume_cond);
5105 #else /* AFS_PTHREAD_ENV */
5106         LWP_NoYieldSignal(VPutVolume);
5107 #endif /* AFS_PTHREAD_ENV */
5108     }
5109     return ret;
5110 }
5111 #endif /* AFS_DEMAND_ATTACH_FS */
5112
5113 /***************************************************/
5114 /* demand attach fs ref counting routines          */
5115 /***************************************************/
5116
5117 #ifdef AFS_DEMAND_ATTACH_FS
5118 /* the following two functions handle reference counting for
5119  * asynchronous operations on volume structs.
5120  *
5121  * their purpose is to prevent a VDetachVolume or VShutdown
5122  * from free()ing the Volume struct during an async i/o op */
5123
5124 /* register with the async volume op ref counter */
5125 /* VCreateReservation_r moved into inline code header because it
5126  * is now needed in vnode.c -- tkeiser 11/20/2007
5127  */
5128
5129 /**
5130  * decrement volume-package internal refcount.
5131  *
5132  * @param vp  volume object pointer
5133  *
5134  * @internal volume package internal use only
5135  *
5136  * @pre
5137  *    @arg VOL_LOCK is held
5138  *    @arg lightweight refcount held
5139  *
5140  * @post volume waiters refcount is decremented; volume may
5141  *       have been deallocated/shutdown/offlined/salvaged/
5142  *       whatever during the process
5143  *
5144  * @warning once you have tossed your last reference (you can acquire
5145  *          lightweight refs recursively) it is NOT SAFE to reference
5146  *          a volume object pointer ever again
5147  *
5148  * @see VCreateReservation_r
5149  *
5150  * @note DEMAND_ATTACH_FS only
5151  */
5152 void
5153 VCancelReservation_r(Volume * vp)
5154 {
5155     osi_Assert(--vp->nWaiters >= 0);
5156     if (vp->nWaiters == 0) {
5157         VCheckOffline(vp);
5158         if (!VCheckDetach(vp)) {
5159             VCheckSalvage(vp);
5160             VCheckFree(vp);
5161         }
5162     }
5163 }
5164
5165 /* check to see if we should free this volume now
5166  * return 1 if volume was freed, 0 otherwise */
5167 static int
5168 VCheckFree(Volume * vp)
5169 {
5170     int ret = 0;
5171     if ((vp->nUsers == 0) &&
5172         (vp->nWaiters == 0) &&
5173         !(V_attachFlags(vp) & (VOL_IN_HASH |
5174                                VOL_ON_VBYP_LIST |
5175                                VOL_IS_BUSY |
5176                                VOL_ON_VLRU))) {
5177         ReallyFreeVolume(vp);
5178         ret = 1;
5179     }
5180     return ret;
5181 }
5182 #endif /* AFS_DEMAND_ATTACH_FS */
5183
5184
5185 /***************************************************/
5186 /* online volume operations routines               */
5187 /***************************************************/
5188
5189 #ifdef AFS_DEMAND_ATTACH_FS
5190 /**
5191  * register a volume operation on a given volume.
5192  *
5193  * @param[in] vp       volume object
5194  * @param[in] vopinfo  volume operation info object
5195  *
5196  * @pre VOL_LOCK is held
5197  *
5198  * @post volume operation info object attached to volume object.
5199  *       volume operation statistics updated.
5200  *
5201  * @note by "attached" we mean a copy of the passed in object is made
5202  *
5203  * @internal volume package internal use only
5204  */
5205 int
5206 VRegisterVolOp_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
5207 {
5208     FSSYNC_VolOp_info * info;
5209
5210     /* attach a vol op info node to the volume struct */
5211     info = (FSSYNC_VolOp_info *) malloc(sizeof(FSSYNC_VolOp_info));
5212     osi_Assert(info != NULL);
5213     memcpy(info, vopinfo, sizeof(FSSYNC_VolOp_info));
5214     vp->pending_vol_op = info;
5215
5216     /* update stats */
5217     vp->stats.last_vol_op = FT_ApproxTime();
5218     vp->stats.vol_ops++;
5219     IncUInt64(&VStats.vol_ops);
5220
5221     return 0;
5222 }
5223
5224 /**
5225  * deregister the volume operation attached to this volume.
5226  *
5227  * @param[in] vp  volume object pointer
5228  *
5229  * @pre VOL_LOCK is held
5230  *
5231  * @post the volume operation info object is detached from the volume object
5232  *
5233  * @internal volume package internal use only
5234  */
5235 int
5236 VDeregisterVolOp_r(Volume * vp)
5237 {
5238     if (vp->pending_vol_op) {
5239         free(vp->pending_vol_op);
5240         vp->pending_vol_op = NULL;
5241     }
5242     return 0;
5243 }
5244 #endif /* AFS_DEMAND_ATTACH_FS */
5245
5246 /**
5247  * determine whether it is safe to leave a volume online during
5248  * the volume operation described by the vopinfo object.
5249  *
5250  * @param[in] vp        volume object
5251  * @param[in] vopinfo   volume operation info object
5252  *
5253  * @return whether it is safe to leave volume online
5254  *    @retval 0  it is NOT SAFE to leave the volume online
5255  *    @retval 1  it is safe to leave the volume online during the operation
5256  *
5257  * @pre
5258  *    @arg VOL_LOCK is held
5259  *    @arg disk header attached to vp (heavyweight ref on vp will guarantee
5260  *         this condition is met)
5261  *
5262  * @internal volume package internal use only
5263  */
5264 int
5265 VVolOpLeaveOnline_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
5266 {
5267     return (vopinfo->vol_op_state == FSSYNC_VolOpRunningOnline ||
5268             (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
5269             (vopinfo->com.reason == V_READONLY ||
5270              (!VolumeWriteable(vp) &&
5271               (vopinfo->com.reason == V_CLONE ||
5272                vopinfo->com.reason == V_DUMP)))));
5273 }
5274
5275 /**
5276  * same as VVolOpLeaveOnline_r, but does not require a volume with an attached
5277  * header.
5278  *
5279  * @param[in] vp        volume object
5280  * @param[in] vopinfo   volume operation info object
5281  *
5282  * @return whether it is safe to leave volume online
5283  *    @retval 0  it is NOT SAFE to leave the volume online
5284  *    @retval 1  it is safe to leave the volume online during the operation
5285  *    @retval -1 unsure; volume header is required in order to know whether or
5286  *               not is is safe to leave the volume online
5287  *
5288  * @pre VOL_LOCK is held
5289  *
5290  * @internal volume package internal use only
5291  */
5292 int
5293 VVolOpLeaveOnlineNoHeader_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
5294 {
5295     /* follow the logic in VVolOpLeaveOnline_r; this is the same, except
5296      * assume that we don't know VolumeWriteable; return -1 if the answer
5297      * depends on VolumeWriteable */
5298
5299     if (vopinfo->vol_op_state == FSSYNC_VolOpRunningOnline) {
5300         return 1;
5301     }
5302     if (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
5303         vopinfo->com.reason == V_READONLY) {
5304
5305         return 1;
5306     }
5307     if (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
5308         (vopinfo->com.reason == V_CLONE ||
5309          vopinfo->com.reason == V_DUMP)) {
5310
5311         /* must know VolumeWriteable */
5312         return -1;
5313     }
5314     return 0;
5315 }
5316
5317 /**
5318  * determine whether VBUSY should be set during this volume operation.
5319  *
5320  * @param[in] vp        volume object
5321  * @param[in] vopinfo   volume operation info object
5322  *
5323  * @return whether VBUSY should be set
5324  *   @retval 0  VBUSY does NOT need to be set
5325  *   @retval 1  VBUSY SHOULD be set
5326  *
5327  * @pre VOL_LOCK is held
5328  *
5329  * @internal volume package internal use only
5330  */
5331 int
5332 VVolOpSetVBusy_r(Volume * vp, FSSYNC_VolOp_info * vopinfo)
5333 {
5334     return ((vopinfo->com.command == FSYNC_VOL_OFF &&
5335             vopinfo->com.reason == FSYNC_SALVAGE) ||
5336             (vopinfo->com.command == FSYNC_VOL_NEEDVOLUME &&
5337             (vopinfo->com.reason == V_CLONE ||
5338              vopinfo->com.reason == V_DUMP)));
5339 }
5340
5341
5342 /***************************************************/
5343 /* online salvager routines                        */
5344 /***************************************************/
5345 #if defined(AFS_DEMAND_ATTACH_FS)
5346
5347 /**
5348  * offline a volume to let it be salvaged.
5349  *
5350  * @param[in] vp  Volume to offline
5351  *
5352  * @return whether we offlined the volume successfully
5353  *  @retval 0 volume was not offlined
5354  *  @retval 1 volume is now offline
5355  *
5356  * @note This is similar to VCheckOffline, but slightly different. We do not
5357  *       deal with vp->goingOffline, and we try to avoid touching the volume
5358  *       header except just to set needsSalvaged
5359  *
5360  * @pre VOL_LOCK held
5361  * @pre vp->nUsers == 0
5362  * @pre V_attachState(vp) == VOL_STATE_SALVAGE_REQ
5363  */
5364 static int
5365 VOfflineForSalvage_r(struct Volume *vp)
5366 {
5367     Error error;
5368
5369     VCreateReservation_r(vp);
5370     VWaitExclusiveState_r(vp);
5371
5372     if (vp->nUsers || V_attachState(vp) == VOL_STATE_SALVAGING) {
5373         /* Someone's using the volume, or someone got to scheduling the salvage
5374          * before us. I don't think either of these should be possible, as we
5375          * should gain no new heavyweight references while we're trying to
5376          * salvage, but just to be sure... */
5377         VCancelReservation_r(vp);
5378         return 0;
5379     }
5380
5381     VChangeState_r(vp, VOL_STATE_OFFLINING);
5382
5383     VLRU_Delete_r(vp);
5384     if (vp->header) {
5385         V_needsSalvaged(vp) = 1;
5386         /* ignore error; updating needsSalvaged is just best effort */
5387         VUpdateVolume_r(&error, vp, VOL_UPDATE_NOFORCEOFF);
5388     }
5389     VCloseVolumeHandles_r(vp);
5390
5391     FreeVolumeHeader(vp);
5392
5393     /* volume has been effectively offlined; we can mark it in the SALVAGING
5394      * state now, which lets FSSYNC give it away */
5395     VChangeState_r(vp, VOL_STATE_SALVAGING);
5396
5397     VCancelReservation_r(vp);
5398
5399     return 1;
5400 }
5401
5402 /**
5403  * check whether a salvage needs to be performed on this volume.
5404  *
5405  * @param[in] vp   pointer to volume object
5406  *
5407  * @return status code
5408  *    @retval 0 no salvage scheduled
5409  *    @retval 1 a salvage has been scheduled with the salvageserver
5410  *
5411  * @pre VOL_LOCK is held
5412  *
5413  * @post if salvage request flag is set and nUsers and nWaiters are zero,
5414  *       then a salvage will be requested
5415  *
5416  * @note this is one of the event handlers called by VCancelReservation_r
5417  *
5418  * @note the caller must check if the volume needs to be freed after calling
5419  *       this; the volume may not have any references or be on any lists after
5420  *       we return, and we do not free it
5421  *
5422  * @see VCancelReservation_r
5423  *
5424  * @internal volume package internal use only.
5425  */
5426 static int
5427 VCheckSalvage(Volume * vp)
5428 {
5429     int ret = 0;
5430 #if defined(SALVSYNC_BUILD_CLIENT) || defined(FSSYNC_BUILD_CLIENT)
5431     if (vp->nUsers)
5432         return ret;
5433     if (!vp->salvage.requested) {
5434         return ret;
5435     }
5436
5437     /* prevent recursion; some of the code below creates and removes
5438      * lightweight refs, which can call VCheckSalvage */
5439     if (vp->salvage.scheduling) {
5440         return ret;
5441     }
5442     vp->salvage.scheduling = 1;
5443
5444     if (V_attachState(vp) == VOL_STATE_SALVAGE_REQ) {
5445         if (!VOfflineForSalvage_r(vp)) {
5446             vp->salvage.scheduling = 0;
5447             return ret;
5448         }
5449     }
5450
5451     if (vp->salvage.requested) {
5452         VScheduleSalvage_r(vp);
5453         ret = 1;
5454     }
5455     vp->salvage.scheduling = 0;
5456 #endif /* SALVSYNC_BUILD_CLIENT || FSSYNC_BUILD_CLIENT */
5457     return ret;
5458 }
5459
5460 /**
5461  * request volume salvage.
5462  *
5463  * @param[out] ec      computed client error code
5464  * @param[in]  vp      volume object pointer
5465  * @param[in]  reason  reason code (passed to salvageserver via SALVSYNC)
5466  * @param[in]  flags   see flags note below
5467  *
5468  * @note flags:
5469  *       VOL_SALVAGE_INVALIDATE_HEADER causes volume header cache entry
5470  *                                     to be invalidated.
5471  *
5472  * @pre VOL_LOCK is held.
5473  *
5474  * @post volume state is changed.
5475  *       for fileserver, salvage will be requested once refcount reaches zero.
5476  *
5477  * @return operation status code
5478  *   @retval 0  volume salvage will occur
5479  *   @retval 1  volume salvage could not be scheduled
5480  *
5481  * @note DAFS only
5482  *
5483  * @note in the fileserver, this call does not synchronously schedule a volume
5484  *       salvage. rather, it sets volume state so that when volume refcounts
5485  *       reach zero, a volume salvage will occur. by "refcounts", we mean both
5486  *       nUsers and nWaiters must be zero.
5487  *
5488  * @internal volume package internal use only.
5489  */
5490 int
5491 VRequestSalvage_r(Error * ec, Volume * vp, int reason, int flags)
5492 {
5493     int code = 0;
5494     /*
5495      * for DAFS volume utilities that are not supposed to schedule salvages,
5496      * just transition to error state instead
5497      */
5498     if (!VCanScheduleSalvage()) {
5499         VChangeState_r(vp, VOL_STATE_ERROR);
5500         *ec = VSALVAGE;
5501         return 1;
5502     }
5503
5504     if (programType != fileServer && !VCanUseFSSYNC()) {
5505         VChangeState_r(vp, VOL_STATE_ERROR);
5506         *ec = VSALVAGE;
5507         return 1;
5508     }
5509
5510     if (!vp->salvage.requested) {
5511         vp->salvage.requested = 1;
5512         vp->salvage.reason = reason;
5513         vp->stats.last_salvage = FT_ApproxTime();
5514
5515         /* Note that it is not possible for us to reach this point if a
5516          * salvage is already running on this volume (even if the fileserver
5517          * was restarted during the salvage). If a salvage were running, the
5518          * salvager would have write-locked the volume header file, so when
5519          * we tried to lock the volume header, the lock would have failed,
5520          * and we would have failed during attachment prior to calling
5521          * VRequestSalvage. So we know that we can schedule salvages without
5522          * fear of a salvage already running for this volume. */
5523
5524         if (vp->stats.salvages < SALVAGE_COUNT_MAX) {
5525
5526             /* if we don't need to offline the volume, we can go directly
5527              * to SALVAGING. SALVAGING says the volume is offline and is
5528              * either salvaging or ready to be handed to the salvager.
5529              * SALVAGE_REQ says that we want to salvage the volume, but we
5530              * are waiting for it to go offline first. */
5531             if (flags & VOL_SALVAGE_NO_OFFLINE) {
5532                 VChangeState_r(vp, VOL_STATE_SALVAGING);
5533             } else {
5534                 VChangeState_r(vp, VOL_STATE_SALVAGE_REQ);
5535                 if (vp->nUsers == 0) {
5536                     /* normally VOfflineForSalvage_r would be called from
5537                      * PutVolume et al when nUsers reaches 0, but if
5538                      * it's already 0, just do it ourselves, since PutVolume
5539                      * isn't going to get called */
5540                     VOfflineForSalvage_r(vp);
5541                 }
5542             }
5543             /* If we are non-fileserver, we're telling the fileserver to
5544              * salvage the vol, so we don't need to give it back separately. */
5545             vp->needsPutBack = 0;
5546
5547             *ec = VSALVAGING;
5548         } else {
5549             Log("VRequestSalvage: volume %u online salvaged too many times; forced offline.\n", vp->hashid);
5550
5551             /* make sure neither VScheduleSalvage_r nor
5552              * VUpdateSalvagePriority_r try to schedule another salvage */
5553             vp->salvage.requested = vp->salvage.scheduled = 0;
5554
5555             VChangeState_r(vp, VOL_STATE_ERROR);
5556             *ec = VSALVAGE;
5557             code = 1;
5558         }
5559         if (flags & VOL_SALVAGE_INVALIDATE_HEADER) {
5560             /* Instead of ReleaseVolumeHeader, we do FreeVolumeHeader()
5561                so that the the next VAttachVolumeByVp_r() invocation
5562                of attach2() will pull in a cached header
5563                entry and fail, then load a fresh one from disk and attach
5564                it to the volume.
5565             */
5566             FreeVolumeHeader(vp);
5567         }
5568     }
5569     return code;
5570 }
5571
5572 /**
5573  * update salvageserver scheduling priority for a volume.
5574  *
5575  * @param[in] vp  pointer to volume object
5576  *
5577  * @return operation status
5578  *   @retval 0  success
5579  *   @retval 1  request denied, or SALVSYNC communications failure
5580  *
5581  * @pre VOL_LOCK is held.
5582  *
5583  * @post in-core salvage priority counter is incremented.  if at least
5584  *       SALVAGE_PRIO_UPDATE_INTERVAL seconds have elapsed since the
5585  *       last SALVSYNC_RAISEPRIO request, we contact the salvageserver
5586  *       to update its priority queue.  if no salvage is scheduled,
5587  *       this function is a no-op.
5588  *
5589  * @note DAFS fileserver only
5590  *
5591  * @note this should be called whenever a VGetVolume fails due to a
5592  *       pending salvage request
5593  *
5594  * @todo should set exclusive state and drop glock around salvsync call
5595  *
5596  * @internal volume package internal use only.
5597  */
5598 int
5599 VUpdateSalvagePriority_r(Volume * vp)
5600 {
5601     int ret=0;
5602
5603 #ifdef SALVSYNC_BUILD_CLIENT
5604     afs_uint32 now;
5605     int code;
5606
5607     vp->salvage.prio++;
5608     now = FT_ApproxTime();
5609
5610     /* update the salvageserver priority queue occasionally so that
5611      * frequently requested volumes get moved to the head of the queue
5612      */
5613     if ((vp->salvage.scheduled) &&
5614         (vp->stats.last_salvage_req < (now-SALVAGE_PRIO_UPDATE_INTERVAL))) {
5615         code = SALVSYNC_SalvageVolume(vp->hashid,
5616                                       VPartitionPath(vp->partition),
5617                                       SALVSYNC_RAISEPRIO,
5618                                       vp->salvage.reason,
5619                                       vp->salvage.prio,
5620                                       NULL);
5621         vp->stats.last_salvage_req = now;
5622         if (code != SYNC_OK) {
5623             ret = 1;
5624         }
5625     }
5626 #endif /* SALVSYNC_BUILD_CLIENT */
5627     return ret;
5628 }
5629
5630
5631 #if defined(SALVSYNC_BUILD_CLIENT) || defined(FSSYNC_BUILD_CLIENT)
5632
5633 /* A couple of little helper functions. These return true if we tried to
5634  * use this mechanism to schedule a salvage, false if we haven't tried.
5635  * If we did try a salvage then the results are contained in code.
5636  */
5637
5638 static_inline int
5639 try_SALVSYNC(Volume *vp, char *partName, int *code) {
5640 #ifdef SALVSYNC_BUILD_CLIENT
5641     if (VCanUseSALVSYNC()) {
5642         Log("Scheduling salvage for volume %lu on part %s over SALVSYNC\n",
5643             afs_printable_uint32_lu(vp->hashid), partName);
5644
5645         /* can't use V_id() since there's no guarantee
5646          * we have the disk data header at this point */
5647         *code = SALVSYNC_SalvageVolume(vp->hashid,
5648                                        partName,
5649                                        SALVSYNC_SALVAGE,
5650                                        vp->salvage.reason,
5651                                        vp->salvage.prio,
5652                                        NULL);
5653         return 1;
5654     }
5655 #endif
5656     return 0;
5657 }
5658
5659 static_inline int
5660 try_FSSYNC(Volume *vp, char *partName, int *code) {
5661 #ifdef FSSYNC_BUILD_CLIENT
5662     if (VCanUseFSSYNC()) {
5663         Log("Scheduling salvage for volume %lu on part %s over FSSYNC\n",
5664             afs_printable_uint32_lu(vp->hashid), partName);
5665
5666         /*
5667          * If we aren't the fileserver, tell the fileserver the volume
5668          * needs to be salvaged. We could directly tell the
5669          * salvageserver, but the fileserver keeps track of some stats
5670          * related to salvages, and handles some other salvage-related
5671          * complications for us.
5672          */
5673         *code = FSYNC_VolOp(vp->hashid, partName,
5674                             FSYNC_VOL_FORCE_ERROR, FSYNC_SALVAGE, NULL);
5675         return 1;
5676     }
5677 #endif /* FSSYNC_BUILD_CLIENT */
5678     return 0;
5679 }
5680
5681 /**
5682  * schedule a salvage with the salvage server or fileserver.
5683  *
5684  * @param[in] vp  pointer to volume object
5685  *
5686  * @return operation status
5687  *    @retval 0 salvage scheduled successfully
5688  *    @retval 1 salvage not scheduled, or SALVSYNC/FSSYNC com error
5689  *
5690  * @pre
5691  *    @arg VOL_LOCK is held.
5692  *    @arg nUsers and nWaiters should be zero.
5693  *
5694  * @post salvageserver or fileserver is sent a salvage request
5695  *
5696  * @note If we are the fileserver, the request will be sent to the salvage
5697  * server over SALVSYNC. If we are not the fileserver, the request will be
5698  * sent to the fileserver over FSSYNC (FSYNC_VOL_FORCE_ERROR/FSYNC_SALVAGE).
5699  *
5700  * @note the caller must check if the volume needs to be freed after calling
5701  *       this; the volume may not have any references or be on any lists after
5702  *       we return, and we do not free it
5703  *
5704  * @note DAFS only
5705  *
5706  * @internal volume package internal use only.
5707  */
5708 static int
5709 VScheduleSalvage_r(Volume * vp)
5710 {
5711     int ret=0;
5712     int code = 0;
5713     VolState state_save;
5714     VThreadOptions_t * thread_opts;
5715     char partName[16];
5716
5717     osi_Assert(VCanUseSALVSYNC() || VCanUseFSSYNC());
5718
5719     if (vp->nWaiters || vp->nUsers) {
5720         return 1;
5721     }
5722
5723     /* prevent endless salvage,attach,salvage,attach,... loops */
5724     if (vp->stats.salvages >= SALVAGE_COUNT_MAX)
5725         return 1;
5726
5727     /*
5728      * don't perform salvsync ops on certain threads
5729      */
5730     thread_opts = pthread_getspecific(VThread_key);
5731     if (thread_opts == NULL) {
5732         thread_opts = &VThread_defaults;
5733     }
5734     if (thread_opts->disallow_salvsync || vol_disallow_salvsync) {
5735         return 1;
5736     }
5737
5738     if (vp->salvage.scheduled) {
5739         return ret;
5740     }
5741
5742     VCreateReservation_r(vp);
5743     VWaitExclusiveState_r(vp);
5744
5745     /*
5746      * XXX the scheduling process should really be done asynchronously
5747      *     to avoid fssync deadlocks
5748      */
5749     if (!vp->salvage.scheduled) {
5750         /* if we haven't previously scheduled a salvage, do so now
5751          *
5752          * set the volume to an exclusive state and drop the lock
5753          * around the SALVSYNC call
5754          */
5755         strlcpy(partName, VPartitionPath(vp->partition), sizeof(partName));
5756         state_save = VChangeState_r(vp, VOL_STATE_SALVSYNC_REQ);
5757         VOL_UNLOCK;
5758
5759         osi_Assert(try_SALVSYNC(vp, partName, &code) ||
5760                try_FSSYNC(vp, partName, &code));
5761
5762         VOL_LOCK;
5763         VChangeState_r(vp, state_save);
5764
5765         if (code == SYNC_OK) {
5766             vp->salvage.scheduled = 1;
5767             vp->stats.last_salvage_req = FT_ApproxTime();
5768             if (VCanUseSALVSYNC()) {
5769                 /* don't record these stats for non-fileservers; let the
5770                  * fileserver take care of these */
5771                 vp->stats.salvages++;
5772                 IncUInt64(&VStats.salvages);
5773             }
5774         } else {
5775             ret = 1;
5776             switch(code) {
5777             case SYNC_BAD_COMMAND:
5778             case SYNC_COM_ERROR:
5779                 break;
5780             case SYNC_DENIED:
5781                 Log("VScheduleSalvage_r: Salvage request for volume %lu "
5782                     "denied\n", afs_printable_uint32_lu(vp->hashid));
5783                 break;
5784             default:
5785                 Log("VScheduleSalvage_r: Salvage request for volume %lu "
5786                     "received unknown protocol error %d\n",
5787                     afs_printable_uint32_lu(vp->hashid), code);
5788                 break;
5789             }
5790
5791             if (VCanUseFSSYNC()) {
5792                 VChangeState_r(vp, VOL_STATE_ERROR);
5793             }
5794         }
5795     }
5796
5797     /* NB: this is cancelling the reservation we obtained above, but we do
5798      * not call VCancelReservation_r, since that may trigger the vp dtor,
5799      * possibly free'ing the vp. We need to keep the vp around after
5800      * this, as the caller may reference vp without any refs. Instead, it
5801      * is the duty of the caller to inspect 'vp' after we return to see if
5802      * needs to be freed. */
5803     osi_Assert(--vp->nWaiters >= 0);
5804     return ret;
5805 }
5806 #endif /* SALVSYNC_BUILD_CLIENT || FSSYNC_BUILD_CLIENT */
5807
5808 #ifdef SALVSYNC_BUILD_CLIENT
5809
5810 /**
5811  * connect to the salvageserver SYNC service.
5812  *
5813  * @return operation status
5814  *    @retval 0 failure
5815  *    @retval 1 success
5816  *
5817  * @post connection to salvageserver SYNC service established
5818  *
5819  * @see VConnectSALV_r
5820  * @see VDisconnectSALV
5821  * @see VReconnectSALV
5822  */
5823 int
5824 VConnectSALV(void)
5825 {
5826     int retVal;
5827     VOL_LOCK;
5828     retVal = VConnectSALV_r();
5829     VOL_UNLOCK;
5830     return retVal;
5831 }
5832
5833 /**
5834  * connect to the salvageserver SYNC service.
5835  *
5836  * @return operation status
5837  *    @retval 0 failure
5838  *    @retval 1 success
5839  *
5840  * @pre VOL_LOCK is held.
5841  *
5842  * @post connection to salvageserver SYNC service established
5843  *
5844  * @see VConnectSALV
5845  * @see VDisconnectSALV_r
5846  * @see VReconnectSALV_r
5847  * @see SALVSYNC_clientInit
5848  *
5849  * @internal volume package internal use only.
5850  */
5851 int
5852 VConnectSALV_r(void)
5853 {
5854     return SALVSYNC_clientInit();
5855 }
5856
5857 /**
5858  * disconnect from the salvageserver SYNC service.
5859  *
5860  * @return operation status
5861  *    @retval 0 success
5862  *
5863  * @pre client should have a live connection to the salvageserver
5864  *
5865  * @post connection to salvageserver SYNC service destroyed
5866  *
5867  * @see VDisconnectSALV_r
5868  * @see VConnectSALV
5869  * @see VReconnectSALV
5870  */
5871 int
5872 VDisconnectSALV(void)
5873 {
5874     VOL_LOCK;
5875     VDisconnectSALV_r();
5876     VOL_UNLOCK;
5877     return 0;
5878 }
5879
5880 /**
5881  * disconnect from the salvageserver SYNC service.
5882  *
5883  * @return operation status
5884  *    @retval 0 success
5885  *
5886  * @pre
5887  *    @arg VOL_LOCK is held.
5888  *    @arg client should have a live connection to the salvageserver.
5889  *
5890  * @post connection to salvageserver SYNC service destroyed
5891  *
5892  * @see VDisconnectSALV
5893  * @see VConnectSALV_r
5894  * @see VReconnectSALV_r
5895  * @see SALVSYNC_clientFinis
5896  *
5897  * @internal volume package internal use only.
5898  */
5899 int
5900 VDisconnectSALV_r(void)
5901 {
5902     return SALVSYNC_clientFinis();
5903 }
5904
5905 /**
5906  * disconnect and then re-connect to the salvageserver SYNC service.
5907  *
5908  * @return operation status
5909  *    @retval 0 failure
5910  *    @retval 1 success
5911  *
5912  * @pre client should have a live connection to the salvageserver
5913  *
5914  * @post old connection is dropped, and a new one is established
5915  *
5916  * @see VConnectSALV
5917  * @see VDisconnectSALV
5918  * @see VReconnectSALV_r
5919  */
5920 int
5921 VReconnectSALV(void)
5922 {
5923     int retVal;
5924     VOL_LOCK;
5925     retVal = VReconnectSALV_r();
5926     VOL_UNLOCK;
5927     return retVal;
5928 }
5929
5930 /**
5931  * disconnect and then re-connect to the salvageserver SYNC service.
5932  *
5933  * @return operation status
5934  *    @retval 0 failure
5935  *    @retval 1 success
5936  *
5937  * @pre
5938  *    @arg VOL_LOCK is held.
5939  *    @arg client should have a live connection to the salvageserver.
5940  *
5941  * @post old connection is dropped, and a new one is established
5942  *
5943  * @see VConnectSALV_r
5944  * @see VDisconnectSALV
5945  * @see VReconnectSALV
5946  * @see SALVSYNC_clientReconnect
5947  *
5948  * @internal volume package internal use only.
5949  */
5950 int
5951 VReconnectSALV_r(void)
5952 {
5953     return SALVSYNC_clientReconnect();
5954 }
5955 #endif /* SALVSYNC_BUILD_CLIENT */
5956 #endif /* AFS_DEMAND_ATTACH_FS */
5957
5958
5959 /***************************************************/
5960 /* FSSYNC routines                                 */
5961 /***************************************************/
5962
5963 /* This must be called by any volume utility which needs to run while the
5964    file server is also running.  This is separated from VInitVolumePackage2 so
5965    that a utility can fork--and each of the children can independently
5966    initialize communication with the file server */
5967 #ifdef FSSYNC_BUILD_CLIENT
5968 /**
5969  * connect to the fileserver SYNC service.
5970  *
5971  * @return operation status
5972  *    @retval 0 failure
5973  *    @retval 1 success
5974  *
5975  * @pre
5976  *    @arg VInit must equal 2.
5977  *    @arg Program Type must not be fileserver or salvager.
5978  *
5979  * @post connection to fileserver SYNC service established
5980  *
5981  * @see VConnectFS_r
5982  * @see VDisconnectFS
5983  * @see VChildProcReconnectFS
5984  */
5985 int
5986 VConnectFS(void)
5987 {
5988     int retVal;
5989     VOL_LOCK;
5990     retVal = VConnectFS_r();
5991     VOL_UNLOCK;
5992     return retVal;
5993 }
5994
5995 /**
5996  * connect to the fileserver SYNC service.
5997  *
5998  * @return operation status
5999  *    @retval 0 failure
6000  *    @retval 1 success
6001  *
6002  * @pre
6003  *    @arg VInit must equal 2.
6004  *    @arg Program Type must not be fileserver or salvager.
6005  *    @arg VOL_LOCK is held.
6006  *
6007  * @post connection to fileserver SYNC service established
6008  *
6009  * @see VConnectFS
6010  * @see VDisconnectFS_r
6011  * @see VChildProcReconnectFS_r
6012  *
6013  * @internal volume package internal use only.
6014  */
6015 int
6016 VConnectFS_r(void)
6017 {
6018     int rc;
6019     osi_Assert((VInit == 2) &&
6020            (programType != fileServer) &&
6021            (programType != salvager));
6022     rc = FSYNC_clientInit();
6023     if (rc) {
6024         VSetVInit_r(3);
6025     }
6026     return rc;
6027 }
6028
6029 /**
6030  * disconnect from the fileserver SYNC service.
6031  *
6032  * @pre
6033  *    @arg client should have a live connection to the fileserver.
6034  *    @arg VOL_LOCK is held.
6035  *    @arg Program Type must not be fileserver or salvager.
6036  *
6037  * @post connection to fileserver SYNC service destroyed
6038  *
6039  * @see VDisconnectFS
6040  * @see VConnectFS_r
6041  * @see VChildProcReconnectFS_r
6042  *
6043  * @internal volume package internal use only.
6044  */
6045 void
6046 VDisconnectFS_r(void)
6047 {
6048     osi_Assert((programType != fileServer) &&
6049            (programType != salvager));
6050     FSYNC_clientFinis();
6051     VSetVInit_r(2);
6052 }
6053
6054 /**
6055  * disconnect from the fileserver SYNC service.
6056  *
6057  * @pre
6058  *    @arg client should have a live connection to the fileserver.
6059  *    @arg Program Type must not be fileserver or salvager.
6060  *
6061  * @post connection to fileserver SYNC service destroyed
6062  *
6063  * @see VDisconnectFS_r
6064  * @see VConnectFS
6065  * @see VChildProcReconnectFS
6066  */
6067 void
6068 VDisconnectFS(void)
6069 {
6070     VOL_LOCK;
6071     VDisconnectFS_r();
6072     VOL_UNLOCK;
6073 }
6074
6075 /**
6076  * connect to the fileserver SYNC service from a child process following a fork.
6077  *
6078  * @return operation status
6079  *    @retval 0 failure
6080  *    @retval 1 success
6081  *
6082  * @pre
6083  *    @arg VOL_LOCK is held.
6084  *    @arg current FSYNC handle is shared with a parent process
6085  *
6086  * @post current FSYNC handle is discarded and a new connection to the
6087  *       fileserver SYNC service is established
6088  *
6089  * @see VChildProcReconnectFS
6090  * @see VConnectFS_r
6091  * @see VDisconnectFS_r
6092  *
6093  * @internal volume package internal use only.
6094  */
6095 int
6096 VChildProcReconnectFS_r(void)
6097 {
6098     return FSYNC_clientChildProcReconnect();
6099 }
6100
6101 /**
6102  * connect to the fileserver SYNC service from a child process following a fork.
6103  *
6104  * @return operation status
6105  *    @retval 0 failure
6106  *    @retval 1 success
6107  *
6108  * @pre current FSYNC handle is shared with a parent process
6109  *
6110  * @post current FSYNC handle is discarded and a new connection to the
6111  *       fileserver SYNC service is established
6112  *
6113  * @see VChildProcReconnectFS_r
6114  * @see VConnectFS
6115  * @see VDisconnectFS
6116  */
6117 int
6118 VChildProcReconnectFS(void)
6119 {
6120     int ret;
6121     VOL_LOCK;
6122     ret = VChildProcReconnectFS_r();
6123     VOL_UNLOCK;
6124     return ret;
6125 }
6126 #endif /* FSSYNC_BUILD_CLIENT */
6127
6128
6129 /***************************************************/
6130 /* volume bitmap routines                          */
6131 /***************************************************/
6132
6133 /**
6134  * allocate a vnode bitmap number for the vnode
6135  *
6136  * @param[out] ec  error code
6137  * @param[in] vp   volume object pointer
6138  * @param[in] index vnode index number for the vnode
6139  * @param[in] flags flag values described in note
6140  *
6141  * @note for DAFS, flags parameter controls locking behavior.
6142  * If (flags & VOL_ALLOC_BITMAP_WAIT) is set, then this function
6143  * will create a reservation and block on any other exclusive
6144  * operations.  Otherwise, this function assumes the caller
6145  * already has exclusive access to vp, and we just change the
6146  * volume state.
6147  *
6148  * @pre VOL_LOCK held
6149  *
6150  * @return bit number allocated
6151  */
6152 /*
6153
6154  */
6155 int
6156 VAllocBitmapEntry_r(Error * ec, Volume * vp,
6157                     struct vnodeIndex *index, int flags)
6158 {
6159     int ret = 0;
6160     byte *bp, *ep;
6161 #ifdef AFS_DEMAND_ATTACH_FS
6162     VolState state_save;
6163 #endif /* AFS_DEMAND_ATTACH_FS */
6164
6165     *ec = 0;
6166
6167     /* This test is probably redundant */
6168     if (!VolumeWriteable(vp)) {
6169         *ec = (bit32) VREADONLY;
6170         return ret;
6171     }
6172
6173 #ifdef AFS_DEMAND_ATTACH_FS
6174     if (flags & VOL_ALLOC_BITMAP_WAIT) {
6175         VCreateReservation_r(vp);
6176         VWaitExclusiveState_r(vp);
6177     }
6178     state_save = VChangeState_r(vp, VOL_STATE_GET_BITMAP);
6179 #endif /* AFS_DEMAND_ATTACH_FS */
6180
6181 #ifdef BITMAP_LATER
6182     if ((programType == fileServer) && !index->bitmap) {
6183         int i;
6184 #ifndef AFS_DEMAND_ATTACH_FS
6185         /* demand attach fs uses the volume state to avoid races.
6186          * specialStatus field is not used at all */
6187         int wasVBUSY = 0;
6188         if (vp->specialStatus == VBUSY) {
6189             if (vp->goingOffline) {     /* vos dump waiting for the volume to
6190                                          * go offline. We probably come here
6191                                          * from AddNewReadableResidency */
6192                 wasVBUSY = 1;
6193             } else {
6194                 while (vp->specialStatus == VBUSY) {
6195 #ifdef AFS_PTHREAD_ENV
6196                     VOL_UNLOCK;
6197                     sleep(2);
6198                     VOL_LOCK;
6199 #else /* !AFS_PTHREAD_ENV */
6200                     IOMGR_Sleep(2);
6201 #endif /* !AFS_PTHREAD_ENV */
6202                 }
6203             }
6204         }
6205 #endif /* !AFS_DEMAND_ATTACH_FS */
6206
6207         if (!index->bitmap) {
6208 #ifndef AFS_DEMAND_ATTACH_FS
6209             vp->specialStatus = VBUSY;  /* Stop anyone else from using it. */
6210 #endif /* AFS_DEMAND_ATTACH_FS */
6211             for (i = 0; i < nVNODECLASSES; i++) {
6212                 VGetBitmap_r(ec, vp, i);
6213                 if (*ec) {
6214 #ifdef AFS_DEMAND_ATTACH_FS
6215                     VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
6216 #else /* AFS_DEMAND_ATTACH_FS */
6217                     DeleteVolumeFromHashTable(vp);
6218                     vp->shuttingDown = 1;       /* Let who has it free it. */
6219                     vp->specialStatus = 0;
6220 #endif /* AFS_DEMAND_ATTACH_FS */
6221                     goto done;
6222                 }
6223             }
6224 #ifndef AFS_DEMAND_ATTACH_FS
6225             if (!wasVBUSY)
6226                 vp->specialStatus = 0;  /* Allow others to have access. */
6227 #endif /* AFS_DEMAND_ATTACH_FS */
6228         }
6229     }
6230 #endif /* BITMAP_LATER */
6231
6232 #ifdef AFS_DEMAND_ATTACH_FS
6233     VOL_UNLOCK;
6234 #endif /* AFS_DEMAND_ATTACH_FS */
6235     bp = index->bitmap + index->bitmapOffset;
6236     ep = index->bitmap + index->bitmapSize;
6237     while (bp < ep) {
6238         if ((*(bit32 *) bp) != (bit32) 0xffffffff) {
6239             int o;
6240             index->bitmapOffset = (afs_uint32) (bp - index->bitmap);
6241             while (*bp == 0xff)
6242                 bp++;
6243             o = ffs(~*bp) - 1;  /* ffs is documented in BSTRING(3) */
6244             *bp |= (1 << o);
6245             ret = ((bp - index->bitmap) * 8 + o);
6246 #ifdef AFS_DEMAND_ATTACH_FS
6247             VOL_LOCK;
6248 #endif /* AFS_DEMAND_ATTACH_FS */
6249             goto done;
6250         }
6251         bp += sizeof(bit32) /* i.e. 4 */ ;
6252     }
6253     /* No bit map entry--must grow bitmap */
6254     bp = (byte *)
6255         realloc(index->bitmap, index->bitmapSize + VOLUME_BITMAP_GROWSIZE);
6256     osi_Assert(bp != NULL);
6257     index->bitmap = bp;
6258     bp += index->bitmapSize;
6259     memset(bp, 0, VOLUME_BITMAP_GROWSIZE);
6260     index->bitmapOffset = index->bitmapSize;
6261     index->bitmapSize += VOLUME_BITMAP_GROWSIZE;
6262     *bp = 1;
6263     ret = index->bitmapOffset * 8;
6264 #ifdef AFS_DEMAND_ATTACH_FS
6265     VOL_LOCK;
6266 #endif /* AFS_DEMAND_ATTACH_FS */
6267
6268  done:
6269 #ifdef AFS_DEMAND_ATTACH_FS
6270     VChangeState_r(vp, state_save);
6271     if (flags & VOL_ALLOC_BITMAP_WAIT) {
6272         VCancelReservation_r(vp);
6273     }
6274 #endif /* AFS_DEMAND_ATTACH_FS */
6275     return ret;
6276 }
6277
6278 int
6279 VAllocBitmapEntry(Error * ec, Volume * vp, struct vnodeIndex * index)
6280 {
6281     int retVal;
6282     VOL_LOCK;
6283     retVal = VAllocBitmapEntry_r(ec, vp, index, VOL_ALLOC_BITMAP_WAIT);
6284     VOL_UNLOCK;
6285     return retVal;
6286 }
6287
6288 void
6289 VFreeBitMapEntry_r(Error * ec, Volume *vp, struct vnodeIndex *index,
6290                    unsigned bitNumber, int flags)
6291 {
6292     unsigned int offset;
6293
6294     *ec = 0;
6295
6296 #ifdef AFS_DEMAND_ATTACH_FS
6297     if (flags & VOL_FREE_BITMAP_WAIT) {
6298         /* VAllocBitmapEntry_r allocs bitmap entries under an exclusive volume
6299          * state, so ensure we're not in an exclusive volume state when we update
6300          * the bitmap */
6301         VCreateReservation_r(vp);
6302         VWaitExclusiveState_r(vp);
6303     }
6304 #endif
6305
6306 #ifdef BITMAP_LATER
6307     if (!index->bitmap)
6308         goto done;
6309 #endif /* BITMAP_LATER */
6310
6311     offset = bitNumber >> 3;
6312     if (offset >= index->bitmapSize) {
6313         *ec = VNOVNODE;
6314         goto done;
6315     }
6316     if (offset < index->bitmapOffset)
6317         index->bitmapOffset = offset & ~3;      /* Truncate to nearest bit32 */
6318     *(index->bitmap + offset) &= ~(1 << (bitNumber & 0x7));
6319
6320  done:
6321 #ifdef AFS_DEMAND_ATTACH_FS
6322     VCancelReservation_r(vp);
6323 #endif
6324     return; /* make the compiler happy for non-DAFS */
6325 }
6326
6327 void
6328 VFreeBitMapEntry(Error * ec, Volume *vp, struct vnodeIndex *index,
6329                  unsigned bitNumber)
6330 {
6331     VOL_LOCK;
6332     VFreeBitMapEntry_r(ec, vp, index, bitNumber, VOL_FREE_BITMAP_WAIT);
6333     VOL_UNLOCK;
6334 }
6335
6336 /* this function will drop the glock internally.
6337  * for old pthread fileservers, this is safe thanks to vbusy.
6338  *
6339  * for demand attach fs, caller must have already called
6340  * VCreateReservation_r and VWaitExclusiveState_r */
6341 static void
6342 VGetBitmap_r(Error * ec, Volume * vp, VnodeClass class)
6343 {
6344     StreamHandle_t *file;
6345     afs_sfsize_t nVnodes, size;
6346     struct VnodeClassInfo *vcp = &VnodeClassInfo[class];
6347     struct vnodeIndex *vip = &vp->vnodeIndex[class];
6348     struct VnodeDiskObject *vnode;
6349     unsigned int unique = 0;
6350     FdHandle_t *fdP;
6351 #ifdef BITMAP_LATER
6352     byte *BitMap = 0;
6353 #endif /* BITMAP_LATER */
6354 #ifdef AFS_DEMAND_ATTACH_FS
6355     VolState state_save;
6356 #endif /* AFS_DEMAND_ATTACH_FS */
6357
6358     *ec = 0;
6359
6360 #ifdef AFS_DEMAND_ATTACH_FS
6361     state_save = VChangeState_r(vp, VOL_STATE_GET_BITMAP);
6362 #endif /* AFS_DEMAND_ATTACH_FS */
6363     VOL_UNLOCK;
6364
6365     fdP = IH_OPEN(vip->handle);
6366     osi_Assert(fdP != NULL);
6367     file = FDH_FDOPEN(fdP, "r");
6368     osi_Assert(file != NULL);
6369     vnode = (VnodeDiskObject *) malloc(vcp->diskSize);
6370     osi_Assert(vnode != NULL);
6371     size = OS_SIZE(fdP->fd_fd);
6372     osi_Assert(size != -1);
6373     nVnodes = (size <= vcp->diskSize ? 0 : size - vcp->diskSize)
6374         >> vcp->logSize;
6375     vip->bitmapSize = ((nVnodes / 8) + 10) / 4 * 4;     /* The 10 is a little extra so
6376                                                          * a few files can be created in this volume,
6377                                                          * the whole thing is rounded up to nearest 4
6378                                                          * bytes, because the bit map allocator likes
6379                                                          * it that way */
6380 #ifdef BITMAP_LATER
6381     BitMap = (byte *) calloc(1, vip->bitmapSize);
6382     osi_Assert(BitMap != NULL);
6383 #else /* BITMAP_LATER */
6384     vip->bitmap = (byte *) calloc(1, vip->bitmapSize);
6385     osi_Assert(vip->bitmap != NULL);
6386     vip->bitmapOffset = 0;
6387 #endif /* BITMAP_LATER */
6388     if (STREAM_ASEEK(file, vcp->diskSize) != -1) {
6389         int bitNumber = 0;
6390         for (bitNumber = 0; bitNumber < nVnodes + 100; bitNumber++) {
6391             if (STREAM_READ(vnode, vcp->diskSize, 1, file) != 1)
6392                 break;
6393             if (vnode->type != vNull) {
6394                 if (vnode->vnodeMagic != vcp->magic) {
6395                     Log("GetBitmap: addled vnode index in volume %s; volume needs salvage\n", V_name(vp));
6396                     *ec = VSALVAGE;
6397                     break;
6398                 }
6399 #ifdef BITMAP_LATER
6400                 *(BitMap + (bitNumber >> 3)) |= (1 << (bitNumber & 0x7));
6401 #else /* BITMAP_LATER */
6402                 *(vip->bitmap + (bitNumber >> 3)) |= (1 << (bitNumber & 0x7));
6403 #endif /* BITMAP_LATER */
6404                 if (unique <= vnode->uniquifier)
6405                     unique = vnode->uniquifier + 1;
6406             }
6407 #ifndef AFS_PTHREAD_ENV
6408             if ((bitNumber & 0x00ff) == 0x0ff) {        /* every 256 iterations */
6409                 IOMGR_Poll();
6410             }
6411 #endif /* !AFS_PTHREAD_ENV */
6412         }
6413     }
6414     if (vp->nextVnodeUnique < unique) {
6415         Log("GetBitmap: bad volume uniquifier for volume %s; volume needs salvage\n", V_name(vp));
6416         *ec = VSALVAGE;
6417     }
6418     /* Paranoia, partly justified--I think fclose after fdopen
6419      * doesn't seem to close fd.  In any event, the documentation
6420      * doesn't specify, so it's safer to close it twice.
6421      */
6422     STREAM_CLOSE(file);
6423     FDH_CLOSE(fdP);
6424     free(vnode);
6425
6426     VOL_LOCK;
6427 #ifdef BITMAP_LATER
6428     /* There may have been a racing condition with some other thread, both
6429      * creating the bitmaps for this volume. If the other thread was faster
6430      * the pointer to bitmap should already be filled and we can free ours.
6431      */
6432     if (vip->bitmap == NULL) {
6433         vip->bitmap = BitMap;
6434         vip->bitmapOffset = 0;
6435     } else
6436         free((byte *) BitMap);
6437 #endif /* BITMAP_LATER */
6438 #ifdef AFS_DEMAND_ATTACH_FS
6439     VChangeState_r(vp, state_save);
6440 #endif /* AFS_DEMAND_ATTACH_FS */
6441 }
6442
6443
6444 /***************************************************/
6445 /* Volume Path and Volume Number utility routines  */
6446 /***************************************************/
6447
6448 /**
6449  * find the first occurrence of a volume header file and return the path.
6450  *
6451  * @param[out] ec          outbound error code
6452  * @param[in]  volumeId    volume id to find
6453  * @param[out] partitionp  pointer to disk partition path string
6454  * @param[out] namep       pointer to volume header file name string
6455  *
6456  * @post path to first occurrence of volume header is returned in partitionp
6457  *       and namep, or ec is set accordingly.
6458  *
6459  * @warning this function is NOT re-entrant -- partitionp and namep point to
6460  *          static data segments
6461  *
6462  * @note if a volume utility inadvertently leaves behind a stale volume header
6463  *       on a vice partition, it is possible for callers to get the wrong one,
6464  *       depending on the order of the disk partition linked list.
6465  *
6466  */
6467 void
6468 VGetVolumePath(Error * ec, VolId volumeId, char **partitionp, char **namep)
6469 {
6470     static char partition[VMAXPATHLEN], name[VMAXPATHLEN];
6471     char path[VMAXPATHLEN];
6472     int found = 0;
6473     struct DiskPartition64 *dp;
6474
6475     *ec = 0;
6476     name[0] = OS_DIRSEPC;
6477     snprintf(&name[1], (sizeof name) - 1, VFORMAT,
6478              afs_printable_uint32_lu(volumeId));
6479     for (dp = DiskPartitionList; dp; dp = dp->next) {
6480         struct afs_stat_st status;
6481         strcpy(path, VPartitionPath(dp));
6482         strcat(path, name);
6483         if (afs_stat(path, &status) == 0) {
6484             strcpy(partition, dp->name);
6485             found = 1;
6486             break;
6487         }
6488     }
6489     if (!found) {
6490         *ec = VNOVOL;
6491         *partitionp = *namep = NULL;
6492     } else {
6493         *partitionp = partition;
6494         *namep = name;
6495     }
6496 }
6497
6498 /**
6499  * extract a volume number from a volume header filename string.
6500  *
6501  * @param[in] name  volume header filename string
6502  *
6503  * @return volume number
6504  *
6505  * @note the string must be of the form VFORMAT.  the only permissible
6506  *       deviation is a leading OS_DIRSEPC character.
6507  *
6508  * @see VFORMAT
6509  */
6510 int
6511 VolumeNumber(char *name)
6512 {
6513     if (*name == OS_DIRSEPC)
6514         name++;
6515     return strtoul(name + 1, NULL, 10);
6516 }
6517
6518 /**
6519  * compute the volume header filename.
6520  *
6521  * @param[in] volumeId
6522  *
6523  * @return volume header filename
6524  *
6525  * @post volume header filename string is constructed
6526  *
6527  * @warning this function is NOT re-entrant -- the returned string is
6528  *          stored in a static char array.  see VolumeExternalName_r
6529  *          for a re-entrant equivalent.
6530  *
6531  * @see VolumeExternalName_r
6532  *
6533  * @deprecated due to the above re-entrancy warning, this interface should
6534  *             be considered deprecated.  Please use VolumeExternalName_r
6535  *             in its stead.
6536  */
6537 char *
6538 VolumeExternalName(VolumeId volumeId)
6539 {
6540     static char name[VMAXPATHLEN];
6541     snprintf(name, sizeof name, VFORMAT, afs_printable_uint32_lu(volumeId));
6542     return name;
6543 }
6544
6545 /**
6546  * compute the volume header filename.
6547  *
6548  * @param[in]     volumeId
6549  * @param[inout]  name       array in which to store filename
6550  * @param[in]     len        length of name array
6551  *
6552  * @return result code from afs_snprintf
6553  *
6554  * @see VolumeExternalName
6555  * @see afs_snprintf
6556  *
6557  * @note re-entrant equivalent of VolumeExternalName
6558  */
6559 int
6560 VolumeExternalName_r(VolumeId volumeId, char * name, size_t len)
6561 {
6562     return snprintf(name, len, VFORMAT, afs_printable_uint32_lu(volumeId));
6563 }
6564
6565
6566 /***************************************************/
6567 /* Volume Usage Statistics routines                */
6568 /***************************************************/
6569
6570 #if OPENAFS_VOL_STATS
6571 #define OneDay  (86400)         /* 24 hours' worth of seconds */
6572 #else
6573 #define OneDay  (24*60*60)      /* 24 hours */
6574 #endif /* OPENAFS_VOL_STATS */
6575
6576 static time_t
6577 Midnight(time_t t) {
6578     struct tm local, *l;
6579     time_t midnight;
6580
6581 #if defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
6582     l = localtime_r(&t, &local);
6583 #else
6584     l = localtime(&t);
6585 #endif
6586
6587     if (l != NULL) {
6588         /* the following is strictly speaking problematic on the
6589            switching day to daylight saving time, after the switch,
6590            as tm_isdst does not match.  Similarly, on the looong day when
6591            switching back the OneDay check will not do what naively expected!
6592            The effects are minor, though, and more a matter of interpreting
6593            the numbers. */
6594 #ifndef AFS_PTHREAD_ENV
6595         local = *l;
6596 #endif
6597         local.tm_hour = local.tm_min=local.tm_sec = 0;
6598         midnight = mktime(&local);
6599         if (midnight != (time_t) -1) return(midnight);
6600     }
6601     return( (t/OneDay)*OneDay );
6602
6603 }
6604
6605 /*------------------------------------------------------------------------
6606  * [export] VAdjustVolumeStatistics
6607  *
6608  * Description:
6609  *      If we've passed midnight, we need to update all the day use
6610  *      statistics as well as zeroing the detailed volume statistics
6611  *      (if we are implementing them).
6612  *
6613  * Arguments:
6614  *      vp : Pointer to the volume structure describing the lucky
6615  *              volume being considered for update.
6616  *
6617  * Returns:
6618  *      0 (always!)
6619  *
6620  * Environment:
6621  *      Nothing interesting.
6622  *
6623  * Side Effects:
6624  *      As described.
6625  *------------------------------------------------------------------------*/
6626
6627 int
6628 VAdjustVolumeStatistics_r(Volume * vp)
6629 {
6630     unsigned int now = FT_ApproxTime();
6631
6632     if (now - V_dayUseDate(vp) > OneDay) {
6633         int ndays, i;
6634
6635         ndays = (now - V_dayUseDate(vp)) / OneDay;
6636         for (i = 6; i > ndays - 1; i--)
6637             V_weekUse(vp)[i] = V_weekUse(vp)[i - ndays];
6638         for (i = 0; i < ndays - 1 && i < 7; i++)
6639             V_weekUse(vp)[i] = 0;
6640         if (ndays <= 7)
6641             V_weekUse(vp)[ndays - 1] = V_dayUse(vp);
6642         V_dayUse(vp) = 0;
6643         V_dayUseDate(vp) = Midnight(now);
6644
6645 #if OPENAFS_VOL_STATS
6646         /*
6647          * All we need to do is bzero the entire VOL_STATS_BYTES of
6648          * the detailed volume statistics area.
6649          */
6650         memset((V_stat_area(vp)), 0, VOL_STATS_BYTES);
6651 #endif /* OPENAFS_VOL_STATS */
6652     }
6653
6654     /*It's been more than a day of collection */
6655     /*
6656      * Always return happily.
6657      */
6658     return (0);
6659 }                               /*VAdjustVolumeStatistics */
6660
6661 int
6662 VAdjustVolumeStatistics(Volume * vp)
6663 {
6664     int retVal;
6665     VOL_LOCK;
6666     retVal = VAdjustVolumeStatistics_r(vp);
6667     VOL_UNLOCK;
6668     return retVal;
6669 }
6670
6671 void
6672 VBumpVolumeUsage_r(Volume * vp)
6673 {
6674     unsigned int now = FT_ApproxTime();
6675     V_accessDate(vp) = now;
6676     if (now - V_dayUseDate(vp) > OneDay)
6677         VAdjustVolumeStatistics_r(vp);
6678     /*
6679      * Save the volume header image to disk after every 128 bumps to dayUse.
6680      */
6681     if ((V_dayUse(vp)++ & 127) == 0) {
6682         Error error;
6683         VUpdateVolume_r(&error, vp, VOL_UPDATE_WAIT);
6684     }
6685 }
6686
6687 void
6688 VBumpVolumeUsage(Volume * vp)
6689 {
6690     VOL_LOCK;
6691     VBumpVolumeUsage_r(vp);
6692     VOL_UNLOCK;
6693 }
6694
6695 void
6696 VSetDiskUsage_r(void)
6697 {
6698 #ifndef AFS_DEMAND_ATTACH_FS
6699     static int FifteenMinuteCounter = 0;
6700 #endif
6701
6702     while (VInit < 2) {
6703         /* NOTE: Don't attempt to access the partitions list until the
6704          * initialization level indicates that all volumes are attached,
6705          * which implies that all partitions are initialized. */
6706 #ifdef AFS_PTHREAD_ENV
6707         VOL_CV_WAIT(&vol_vinit_cond);
6708 #else /* AFS_PTHREAD_ENV */
6709         IOMGR_Sleep(10);
6710 #endif /* AFS_PTHREAD_ENV */
6711     }
6712
6713     VResetDiskUsage_r();
6714
6715 #ifndef AFS_DEMAND_ATTACH_FS
6716     if (++FifteenMinuteCounter == 3) {
6717         FifteenMinuteCounter = 0;
6718         VScanUpdateList();
6719     }
6720 #endif /* !AFS_DEMAND_ATTACH_FS */
6721 }
6722
6723 void
6724 VSetDiskUsage(void)
6725 {
6726     VOL_LOCK;
6727     VSetDiskUsage_r();
6728     VOL_UNLOCK;
6729 }
6730
6731
6732 /***************************************************/
6733 /* Volume Update List routines                     */
6734 /***************************************************/
6735
6736 /* The number of minutes that a volume hasn't been updated before the
6737  * "Dont salvage" flag in the volume header will be turned on */
6738 #define SALVAGE_INTERVAL        (10*60)
6739
6740 /*
6741  * demand attach fs
6742  *
6743  * volume update list functionality has been moved into the VLRU
6744  * the DONT_SALVAGE flag is now set during VLRU demotion
6745  */
6746
6747 #ifndef AFS_DEMAND_ATTACH_FS
6748 static VolumeId *UpdateList = NULL;     /* Pointer to array of Volume ID's */
6749 static int nUpdatedVolumes = 0;         /* Updated with entry in UpdateList, salvage after crash flag on */
6750 static int updateSize = 0;              /* number of entries possible */
6751 #define UPDATE_LIST_SIZE 128            /* initial size increment (must be a power of 2!) */
6752 #endif /* !AFS_DEMAND_ATTACH_FS */
6753
6754 void
6755 VAddToVolumeUpdateList_r(Error * ec, Volume * vp)
6756 {
6757     *ec = 0;
6758     vp->updateTime = FT_ApproxTime();
6759     if (V_dontSalvage(vp) == 0)
6760         return;
6761     V_dontSalvage(vp) = 0;
6762     VSyncVolume_r(ec, vp, 0);
6763 #ifdef AFS_DEMAND_ATTACH_FS
6764     V_attachFlags(vp) &= ~(VOL_HDR_DONTSALV);
6765 #else /* !AFS_DEMAND_ATTACH_FS */
6766     if (*ec)
6767         return;
6768     if (UpdateList == NULL) {
6769         updateSize = UPDATE_LIST_SIZE;
6770         UpdateList = (VolumeId *) malloc(sizeof(VolumeId) * updateSize);
6771     } else {
6772         if (nUpdatedVolumes == updateSize) {
6773             updateSize <<= 1;
6774             if (updateSize > 524288) {
6775                 Log("warning: there is likely a bug in the volume update scanner\n");
6776                 return;
6777             }
6778             UpdateList =
6779                 (VolumeId *) realloc(UpdateList,
6780                                      sizeof(VolumeId) * updateSize);
6781         }
6782     }
6783     osi_Assert(UpdateList != NULL);
6784     UpdateList[nUpdatedVolumes++] = V_id(vp);
6785 #endif /* !AFS_DEMAND_ATTACH_FS */
6786 }
6787
6788 #ifndef AFS_DEMAND_ATTACH_FS
6789 static void
6790 VScanUpdateList(void)
6791 {
6792     int i, gap;
6793     Volume *vp;
6794     Error error;
6795     afs_uint32 now = FT_ApproxTime();
6796     /* Be careful with this code, since it works with interleaved calls to AddToVolumeUpdateList */
6797     for (i = gap = 0; i < nUpdatedVolumes; i++) {
6798         if (gap)
6799             UpdateList[i - gap] = UpdateList[i];
6800
6801         /* XXX this routine needlessly messes up the Volume LRU by
6802          * breaking the LRU temporal-locality assumptions.....
6803          * we should use a special volume header allocator here */
6804         vp = VGetVolume_r(&error, UpdateList[i - gap] = UpdateList[i]);
6805         if (error) {
6806             gap++;
6807         } else if (vp->nUsers == 1 && now - vp->updateTime > SALVAGE_INTERVAL) {
6808             V_dontSalvage(vp) = DONT_SALVAGE;
6809             VUpdateVolume_r(&error, vp, 0);     /* No need to fsync--not critical */
6810             gap++;
6811         }
6812
6813         if (vp) {
6814             VPutVolume_r(vp);
6815         }
6816
6817 #ifndef AFS_PTHREAD_ENV
6818         IOMGR_Poll();
6819 #endif /* !AFS_PTHREAD_ENV */
6820     }
6821     nUpdatedVolumes -= gap;
6822 }
6823 #endif /* !AFS_DEMAND_ATTACH_FS */
6824
6825
6826 /***************************************************/
6827 /* Volume LRU routines                             */
6828 /***************************************************/
6829
6830 /* demand attach fs
6831  * volume LRU
6832  *
6833  * with demand attach fs, we attempt to soft detach(1)
6834  * volumes which have not been accessed in a long time
6835  * in order to speed up fileserver shutdown
6836  *
6837  * (1) by soft detach we mean a process very similar
6838  *     to VOffline, except the final state of the
6839  *     Volume will be VOL_STATE_PREATTACHED, instead
6840  *     of the usual VOL_STATE_UNATTACHED
6841  */
6842 #ifdef AFS_DEMAND_ATTACH_FS
6843
6844 /* implementation is reminiscent of a generational GC
6845  *
6846  * queue 0 is newly attached volumes. this queue is
6847  * sorted by attach timestamp
6848  *
6849  * queue 1 is volumes that have been around a bit
6850  * longer than queue 0. this queue is sorted by
6851  * attach timestamp
6852  *
6853  * queue 2 is volumes tha have been around the longest.
6854  * this queue is unsorted
6855  *
6856  * queue 3 is volumes that have been marked as
6857  * candidates for soft detachment. this queue is
6858  * unsorted
6859  */
6860 #define VLRU_GENERATIONS  3   /**< number of generations in VLRU */
6861 #define VLRU_QUEUES       5   /**< total number of VLRU queues */
6862
6863 /**
6864  * definition of a VLRU queue.
6865  */
6866 struct VLRU_q {
6867     volatile struct rx_queue q;
6868     volatile int len;
6869     volatile int busy;
6870     pthread_cond_t cv;
6871 };
6872
6873 /**
6874  * main VLRU data structure.
6875  */
6876 struct VLRU {
6877     struct VLRU_q q[VLRU_QUEUES];   /**< VLRU queues */
6878
6879     /* VLRU config */
6880     /** time interval (in seconds) between promotion passes for
6881      *  each young generation queue. */
6882     afs_uint32 promotion_interval[VLRU_GENERATIONS-1];
6883
6884     /** time interval (in seconds) between soft detach candidate
6885      *  scans for each generation queue.
6886      *
6887      *  scan_interval[VLRU_QUEUE_CANDIDATE] defines how frequently
6888      *  we perform a soft detach pass. */
6889     afs_uint32 scan_interval[VLRU_GENERATIONS+1];
6890
6891     /* scheduler state */
6892     int next_idx;                                       /**< next queue to receive attention */
6893     afs_uint32 last_promotion[VLRU_GENERATIONS-1];      /**< timestamp of last promotion scan */
6894     afs_uint32 last_scan[VLRU_GENERATIONS+1];           /**< timestamp of last detach scan */
6895
6896     int scanner_state;                                  /**< state of scanner thread */
6897     pthread_cond_t cv;                                  /**< state transition CV */
6898 };
6899
6900 /** global VLRU state */
6901 static struct VLRU volume_LRU;
6902
6903 /**
6904  * defined states for VLRU scanner thread.
6905  */
6906 typedef enum {
6907     VLRU_SCANNER_STATE_OFFLINE        = 0,    /**< vlru scanner thread is offline */
6908     VLRU_SCANNER_STATE_ONLINE         = 1,    /**< vlru scanner thread is online */
6909     VLRU_SCANNER_STATE_SHUTTING_DOWN  = 2,    /**< vlru scanner thread is shutting down */
6910     VLRU_SCANNER_STATE_PAUSING        = 3,    /**< vlru scanner thread is getting ready to pause */
6911     VLRU_SCANNER_STATE_PAUSED         = 4     /**< vlru scanner thread is paused */
6912 } vlru_thread_state_t;
6913
6914 /* vlru disk data header stuff */
6915 #define VLRU_DISK_MAGIC      0x7a8b9cad        /**< vlru disk entry magic number */
6916 #define VLRU_DISK_VERSION    1                 /**< vlru disk entry version number */
6917
6918 /** vlru default expiration time (for eventual fs state serialization of vlru data) */
6919 #define VLRU_DUMP_EXPIRATION_TIME   (60*60*24*7)  /* expire vlru data after 1 week */
6920
6921
6922 /** minimum volume inactivity (in seconds) before a volume becomes eligible for
6923  *  soft detachment. */
6924 static afs_uint32 VLRU_offline_thresh = VLRU_DEFAULT_OFFLINE_THRESH;
6925
6926 /** time interval (in seconds) between VLRU scanner thread soft detach passes. */
6927 static afs_uint32 VLRU_offline_interval = VLRU_DEFAULT_OFFLINE_INTERVAL;
6928
6929 /** maximum number of volumes to soft detach in a VLRU soft detach pass. */
6930 static afs_uint32 VLRU_offline_max = VLRU_DEFAULT_OFFLINE_MAX;
6931
6932 /** VLRU control flag.  non-zero value implies VLRU subsystem is activated. */
6933 static afs_uint32 VLRU_enabled = 1;
6934
6935 /* queue synchronization routines */
6936 static void VLRU_BeginExclusive_r(struct VLRU_q * q);
6937 static void VLRU_EndExclusive_r(struct VLRU_q * q);
6938 static void VLRU_Wait_r(struct VLRU_q * q);
6939
6940 /**
6941  * set VLRU subsystem tunable parameters.
6942  *
6943  * @param[in] option  tunable option to modify
6944  * @param[in] val     new value for tunable parameter
6945  *
6946  * @pre @c VInitVolumePackage2 has not yet been called.
6947  *
6948  * @post tunable parameter is modified
6949  *
6950  * @note DAFS only
6951  *
6952  * @note valid option parameters are:
6953  *    @arg @c VLRU_SET_THRESH
6954  *         set the period of inactivity after which
6955  *         volumes are eligible for soft detachment
6956  *    @arg @c VLRU_SET_INTERVAL
6957  *         set the time interval between calls
6958  *         to the volume LRU "garbage collector"
6959  *    @arg @c VLRU_SET_MAX
6960  *         set the max number of volumes to deallocate
6961  *         in one GC pass
6962  */
6963 void
6964 VLRU_SetOptions(int option, afs_uint32 val)
6965 {
6966     if (option == VLRU_SET_THRESH) {
6967         VLRU_offline_thresh = val;
6968     } else if (option == VLRU_SET_INTERVAL) {
6969         VLRU_offline_interval = val;
6970     } else if (option == VLRU_SET_MAX) {
6971         VLRU_offline_max = val;
6972     } else if (option == VLRU_SET_ENABLED) {
6973         VLRU_enabled = val;
6974     }
6975     VLRU_ComputeConstants();
6976 }
6977
6978 /**
6979  * compute VLRU internal timing parameters.
6980  *
6981  * @post VLRU scanner thread internal timing parameters are computed
6982  *
6983  * @note computes internal timing parameters based upon user-modifiable
6984  *       tunable parameters.
6985  *
6986  * @note DAFS only
6987  *
6988  * @internal volume package internal use only.
6989  */
6990 static void
6991 VLRU_ComputeConstants(void)
6992 {
6993     afs_uint32 factor = VLRU_offline_thresh / VLRU_offline_interval;
6994
6995     /* compute the candidate scan interval */
6996     volume_LRU.scan_interval[VLRU_QUEUE_CANDIDATE] = VLRU_offline_interval;
6997
6998     /* compute the promotion intervals */
6999     volume_LRU.promotion_interval[VLRU_QUEUE_NEW] = VLRU_offline_thresh * 2;
7000     volume_LRU.promotion_interval[VLRU_QUEUE_MID] = VLRU_offline_thresh * 4;
7001
7002     if (factor > 16) {
7003         /* compute the gen 0 scan interval */
7004         volume_LRU.scan_interval[VLRU_QUEUE_NEW] = VLRU_offline_thresh / 8;
7005     } else {
7006         /* compute the gen 0 scan interval */
7007         volume_LRU.scan_interval[VLRU_QUEUE_NEW] = VLRU_offline_interval * 2;
7008     }
7009 }
7010
7011 /**
7012  * initialize VLRU subsystem.
7013  *
7014  * @pre this function has not yet been called
7015  *
7016  * @post VLRU subsystem is initialized and VLRU scanner thread is starting
7017  *
7018  * @note DAFS only
7019  *
7020  * @internal volume package internal use only.
7021  */
7022 static void
7023 VInitVLRU(void)
7024 {
7025     pthread_t tid;
7026     pthread_attr_t attrs;
7027     int i;
7028
7029     if (!VLRU_enabled) {
7030         Log("VLRU: disabled\n");
7031         return;
7032     }
7033
7034     /* initialize each of the VLRU queues */
7035     for (i = 0; i < VLRU_QUEUES; i++) {
7036         queue_Init(&volume_LRU.q[i]);
7037         volume_LRU.q[i].len = 0;
7038         volume_LRU.q[i].busy = 0;
7039         CV_INIT(&volume_LRU.q[i].cv, "vol lru", CV_DEFAULT, 0);
7040     }
7041
7042     /* setup the timing constants */
7043     VLRU_ComputeConstants();
7044
7045     /* XXX put inside LogLevel check? */
7046     Log("VLRU: starting scanner with the following configuration parameters:\n");
7047     Log("VLRU:  offlining volumes after minimum of %d seconds of inactivity\n", VLRU_offline_thresh);
7048     Log("VLRU:  running VLRU soft detach pass every %d seconds\n", VLRU_offline_interval);
7049     Log("VLRU:  taking up to %d volumes offline per pass\n", VLRU_offline_max);
7050     Log("VLRU:  scanning generation 0 for inactive volumes every %d seconds\n", volume_LRU.scan_interval[0]);
7051     Log("VLRU:  scanning for promotion/demotion between generations 0 and 1 every %d seconds\n", volume_LRU.promotion_interval[0]);
7052     Log("VLRU:  scanning for promotion/demotion between generations 1 and 2 every %d seconds\n", volume_LRU.promotion_interval[1]);
7053
7054     /* start up the VLRU scanner */
7055     volume_LRU.scanner_state = VLRU_SCANNER_STATE_OFFLINE;
7056     if (programType == fileServer) {
7057         CV_INIT(&volume_LRU.cv, "vol lru", CV_DEFAULT, 0);
7058         osi_Assert(pthread_attr_init(&attrs) == 0);
7059         osi_Assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
7060         osi_Assert(pthread_create(&tid, &attrs, &VLRU_ScannerThread, NULL) == 0);
7061     }
7062 }
7063
7064 /**
7065  * initialize the VLRU-related fields of a newly allocated volume object.
7066  *
7067  * @param[in] vp  pointer to volume object
7068  *
7069  * @pre
7070  *    @arg @c VOL_LOCK is held.
7071  *    @arg volume object is not on a VLRU queue.
7072  *
7073  * @post VLRU fields are initialized to indicate that volume object is not
7074  *       currently registered with the VLRU subsystem
7075  *
7076  * @note DAFS only
7077  *
7078  * @internal volume package interal use only.
7079  */
7080 static void
7081 VLRU_Init_Node_r(Volume * vp)
7082 {
7083     if (!VLRU_enabled)
7084         return;
7085
7086     osi_Assert(queue_IsNotOnQueue(&vp->vlru));
7087     vp->vlru.idx = VLRU_QUEUE_INVALID;
7088 }
7089
7090 /**
7091  * add a volume object to a VLRU queue.
7092  *
7093  * @param[in] vp  pointer to volume object
7094  *
7095  * @pre
7096  *    @arg @c VOL_LOCK is held.
7097  *    @arg caller MUST hold a lightweight ref on @p vp.
7098  *    @arg caller MUST NOT hold exclusive ownership of the VLRU queue.
7099  *
7100  * @post the volume object is added to the appropriate VLRU queue
7101  *
7102  * @note if @c vp->vlru.idx contains the index of a valid VLRU queue,
7103  *       then the volume is added to that queue.  Otherwise, the value
7104  *       @c VLRU_QUEUE_NEW is stored into @c vp->vlru.idx and the
7105  *       volume is added to the NEW generation queue.
7106  *
7107  * @note @c VOL_LOCK may be dropped internally
7108  *
7109  * @note Volume state is temporarily set to @c VOL_STATE_VLRU_ADD
7110  *       during the add operation, and is restored to the previous
7111  *       state prior to return.
7112  *
7113  * @note DAFS only
7114  *
7115  * @internal volume package internal use only.
7116  */
7117 static void
7118 VLRU_Add_r(Volume * vp)
7119 {
7120     int idx;
7121     VolState state_save;
7122
7123     if (!VLRU_enabled)
7124         return;
7125
7126     if (queue_IsOnQueue(&vp->vlru))
7127         return;
7128
7129     state_save = VChangeState_r(vp, VOL_STATE_VLRU_ADD);
7130
7131     idx = vp->vlru.idx;
7132     if ((idx < 0) || (idx >= VLRU_QUEUE_INVALID)) {
7133         idx = VLRU_QUEUE_NEW;
7134     }
7135
7136     VLRU_Wait_r(&volume_LRU.q[idx]);
7137
7138     /* repeat check since VLRU_Wait_r may have dropped
7139      * the glock */
7140     if (queue_IsNotOnQueue(&vp->vlru)) {
7141         vp->vlru.idx = idx;
7142         queue_Prepend(&volume_LRU.q[idx], &vp->vlru);
7143         volume_LRU.q[idx].len++;
7144         V_attachFlags(vp) |= VOL_ON_VLRU;
7145         vp->stats.last_promote = FT_ApproxTime();
7146     }
7147
7148     VChangeState_r(vp, state_save);
7149 }
7150
7151 /**
7152  * delete a volume object from a VLRU queue.
7153  *
7154  * @param[in] vp  pointer to volume object
7155  *
7156  * @pre
7157  *    @arg @c VOL_LOCK is held.
7158  *    @arg caller MUST hold a lightweight ref on @p vp.
7159  *    @arg caller MUST NOT hold exclusive ownership of the VLRU queue.
7160  *
7161  * @post volume object is removed from the VLRU queue
7162  *
7163  * @note @c VOL_LOCK may be dropped internally
7164  *
7165  * @note DAFS only
7166  *
7167  * @todo We should probably set volume state to something exlcusive
7168  *       (as @c VLRU_Add_r does) prior to dropping @c VOL_LOCK.
7169  *
7170  * @internal volume package internal use only.
7171  */
7172 static void
7173 VLRU_Delete_r(Volume * vp)
7174 {
7175     int idx;
7176
7177     if (!VLRU_enabled)
7178         return;
7179
7180     if (queue_IsNotOnQueue(&vp->vlru))
7181         return;
7182
7183     /* handle races */
7184     do {
7185       idx = vp->vlru.idx;
7186       if (idx == VLRU_QUEUE_INVALID)
7187           return;
7188       VLRU_Wait_r(&volume_LRU.q[idx]);
7189     } while (idx != vp->vlru.idx);
7190
7191     /* now remove from the VLRU and update
7192      * the appropriate counter */
7193     queue_Remove(&vp->vlru);
7194     volume_LRU.q[idx].len--;
7195     vp->vlru.idx = VLRU_QUEUE_INVALID;
7196     V_attachFlags(vp) &= ~(VOL_ON_VLRU);
7197 }
7198
7199 /**
7200  * tell the VLRU subsystem that a volume was just accessed.
7201  *
7202  * @param[in] vp  pointer to volume object
7203  *
7204  * @pre
7205  *    @arg @c VOL_LOCK is held
7206  *    @arg caller MUST hold a lightweight ref on @p vp
7207  *    @arg caller MUST NOT hold exclusive ownership of any VLRU queue
7208  *
7209  * @post volume VLRU access statistics are updated.  If the volume was on
7210  *       the VLRU soft detach candidate queue, it is moved to the NEW
7211  *       generation queue.
7212  *
7213  * @note @c VOL_LOCK may be dropped internally
7214  *
7215  * @note DAFS only
7216  *
7217  * @internal volume package internal use only.
7218  */
7219 static void
7220 VLRU_UpdateAccess_r(Volume * vp)
7221 {
7222     Volume * rvp = NULL;
7223
7224     if (!VLRU_enabled)
7225         return;
7226
7227     if (queue_IsNotOnQueue(&vp->vlru))
7228         return;
7229
7230     osi_Assert(V_attachFlags(vp) & VOL_ON_VLRU);
7231
7232     /* update the access timestamp */
7233     vp->stats.last_get = FT_ApproxTime();
7234
7235     /*
7236      * if the volume is on the soft detach candidate
7237      * list, we need to safely move it back to a
7238      * regular generation.  this has to be done
7239      * carefully so we don't race against the scanner
7240      * thread.
7241      */
7242
7243     /* if this volume is on the soft detach candidate queue,
7244      * then grab exclusive access to the necessary queues */
7245     if (vp->vlru.idx == VLRU_QUEUE_CANDIDATE) {
7246         rvp = vp;
7247         VCreateReservation_r(rvp);
7248
7249         VLRU_Wait_r(&volume_LRU.q[VLRU_QUEUE_NEW]);
7250         VLRU_BeginExclusive_r(&volume_LRU.q[VLRU_QUEUE_NEW]);
7251         VLRU_Wait_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7252         VLRU_BeginExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7253     }
7254
7255     /* make sure multiple threads don't race to update */
7256     if (vp->vlru.idx == VLRU_QUEUE_CANDIDATE) {
7257         VLRU_SwitchQueues(vp, VLRU_QUEUE_NEW, 1);
7258     }
7259
7260     if (rvp) {
7261       VLRU_EndExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7262       VLRU_EndExclusive_r(&volume_LRU.q[VLRU_QUEUE_NEW]);
7263       VCancelReservation_r(rvp);
7264     }
7265 }
7266
7267 /**
7268  * switch a volume between two VLRU queues.
7269  *
7270  * @param[in] vp       pointer to volume object
7271  * @param[in] new_idx  index of VLRU queue onto which the volume will be moved
7272  * @param[in] append   controls whether the volume will be appended or
7273  *                     prepended to the queue.  A nonzero value means it will
7274  *                     be appended; zero means it will be prepended.
7275  *
7276  * @pre The new (and old, if applicable) queue(s) must either be owned
7277  *      exclusively by the calling thread for asynchronous manipulation,
7278  *      or the queue(s) must be quiescent and VOL_LOCK must be held.
7279  *      Please see VLRU_BeginExclusive_r, VLRU_EndExclusive_r and VLRU_Wait_r
7280  *      for further details of the queue asynchronous processing mechanism.
7281  *
7282  * @post If the volume object was already on a VLRU queue, it is
7283  *       removed from the queue.  Depending on the value of the append
7284  *       parameter, the volume object is either appended or prepended
7285  *       to the VLRU queue referenced by the new_idx parameter.
7286  *
7287  * @note DAFS only
7288  *
7289  * @see VLRU_BeginExclusive_r
7290  * @see VLRU_EndExclusive_r
7291  * @see VLRU_Wait_r
7292  *
7293  * @internal volume package internal use only.
7294  */
7295 static void
7296 VLRU_SwitchQueues(Volume * vp, int new_idx, int append)
7297 {
7298     if (queue_IsNotOnQueue(&vp->vlru))
7299         return;
7300
7301     queue_Remove(&vp->vlru);
7302     volume_LRU.q[vp->vlru.idx].len--;
7303
7304     /* put the volume back on the correct generational queue */
7305     if (append) {
7306         queue_Append(&volume_LRU.q[new_idx], &vp->vlru);
7307     } else {
7308         queue_Prepend(&volume_LRU.q[new_idx], &vp->vlru);
7309     }
7310
7311     volume_LRU.q[new_idx].len++;
7312     vp->vlru.idx = new_idx;
7313 }
7314
7315 /**
7316  * VLRU background thread.
7317  *
7318  * The VLRU Scanner Thread is responsible for periodically scanning through
7319  * each VLRU queue looking for volumes which should be moved to another
7320  * queue, or soft detached.
7321  *
7322  * @param[in] args  unused thread arguments parameter
7323  *
7324  * @return unused thread return value
7325  *    @retval NULL always
7326  *
7327  * @internal volume package internal use only.
7328  */
7329 static void *
7330 VLRU_ScannerThread(void * args)
7331 {
7332     afs_uint32 now, min_delay, delay;
7333     int i, min_idx, min_op, overdue, state;
7334
7335     /* set t=0 for promotion cycle to be
7336      * fileserver startup */
7337     now = FT_ApproxTime();
7338     for (i=0; i < VLRU_GENERATIONS-1; i++) {
7339         volume_LRU.last_promotion[i] = now;
7340     }
7341
7342     /* don't start the scanner until VLRU_offline_thresh
7343      * plus a small delay for VInitVolumePackage2 to finish
7344      * has gone by */
7345
7346     sleep(VLRU_offline_thresh + 60);
7347
7348     /* set t=0 for scan cycle to be now */
7349     now = FT_ApproxTime();
7350     for (i=0; i < VLRU_GENERATIONS+1; i++) {
7351         volume_LRU.last_scan[i] = now;
7352     }
7353
7354     VOL_LOCK;
7355     if (volume_LRU.scanner_state == VLRU_SCANNER_STATE_OFFLINE) {
7356         volume_LRU.scanner_state = VLRU_SCANNER_STATE_ONLINE;
7357     }
7358
7359     while ((state = volume_LRU.scanner_state) != VLRU_SCANNER_STATE_SHUTTING_DOWN) {
7360         /* check to see if we've been asked to pause */
7361         if (volume_LRU.scanner_state == VLRU_SCANNER_STATE_PAUSING) {
7362             volume_LRU.scanner_state = VLRU_SCANNER_STATE_PAUSED;
7363             CV_BROADCAST(&volume_LRU.cv);
7364             do {
7365                 VOL_CV_WAIT(&volume_LRU.cv);
7366             } while (volume_LRU.scanner_state == VLRU_SCANNER_STATE_PAUSED);
7367         }
7368
7369         /* scheduling can happen outside the glock */
7370         VOL_UNLOCK;
7371
7372         /* figure out what is next on the schedule */
7373
7374         /* figure out a potential schedule for the new generation first */
7375         overdue = 0;
7376         min_delay = volume_LRU.scan_interval[0] + volume_LRU.last_scan[0] - now;
7377         min_idx = 0;
7378         min_op = 0;
7379         if (min_delay > volume_LRU.scan_interval[0]) {
7380             /* unsigned overflow -- we're overdue to run this scan */
7381             min_delay = 0;
7382             overdue = 1;
7383         }
7384
7385         /* if we're not overdue for gen 0, figure out schedule for candidate gen */
7386         if (!overdue) {
7387             i = VLRU_QUEUE_CANDIDATE;
7388             delay = volume_LRU.scan_interval[i] + volume_LRU.last_scan[i] - now;
7389             if (delay < min_delay) {
7390                 min_delay = delay;
7391                 min_idx = i;
7392             }
7393             if (delay > volume_LRU.scan_interval[i]) {
7394                 /* unsigned overflow -- we're overdue to run this scan */
7395                 min_delay = 0;
7396                 min_idx = i;
7397                 overdue = 1;
7398             }
7399         }
7400
7401         /* if we're still not overdue for something, figure out schedules for promotions */
7402         for (i=0; !overdue && i < VLRU_GENERATIONS-1; i++) {
7403             delay = volume_LRU.promotion_interval[i] + volume_LRU.last_promotion[i] - now;
7404             if (delay < min_delay) {
7405                 min_delay = delay;
7406                 min_idx = i;
7407                 min_op = 1;
7408             }
7409             if (delay > volume_LRU.promotion_interval[i]) {
7410                 /* unsigned overflow -- we're overdue to run this promotion */
7411                 min_delay = 0;
7412                 min_idx = i;
7413                 min_op = 1;
7414                 overdue = 1;
7415                 break;
7416             }
7417         }
7418
7419         /* sleep as needed */
7420         if (min_delay) {
7421             sleep(min_delay);
7422         }
7423
7424         /* do whatever is next */
7425         VOL_LOCK;
7426         if (min_op) {
7427             VLRU_Promote_r(min_idx);
7428             VLRU_Demote_r(min_idx+1);
7429         } else {
7430             VLRU_Scan_r(min_idx);
7431         }
7432         now = FT_ApproxTime();
7433     }
7434
7435     Log("VLRU scanner asked to go offline (scanner_state=%d)\n", state);
7436
7437     /* signal that scanner is down */
7438     volume_LRU.scanner_state = VLRU_SCANNER_STATE_OFFLINE;
7439     CV_BROADCAST(&volume_LRU.cv);
7440     VOL_UNLOCK;
7441     return NULL;
7442 }
7443
7444 /**
7445  * promote volumes from one VLRU generation to the next.
7446  *
7447  * This routine scans a VLRU generation looking for volumes which are
7448  * eligible to be promoted to the next generation.  All volumes which
7449  * meet the eligibility requirement are promoted.
7450  *
7451  * Promotion eligibility is based upon meeting both of the following
7452  * requirements:
7453  *
7454  *    @arg The volume has been accessed since the last promotion:
7455  *         @c (vp->stats.last_get >= vp->stats.last_promote)
7456  *    @arg The last promotion occurred at least
7457  *         @c volume_LRU.promotion_interval[idx] seconds ago
7458  *
7459  * As a performance optimization, promotions are "globbed".  In other
7460  * words, we promote arbitrarily large contiguous sublists of elements
7461  * as one operation.
7462  *
7463  * @param[in] idx  VLRU queue index to scan
7464  *
7465  * @note DAFS only
7466  *
7467  * @internal VLRU internal use only.
7468  */
7469 static void
7470 VLRU_Promote_r(int idx)
7471 {
7472     int len, chaining, promote;
7473     afs_uint32 now, thresh;
7474     struct rx_queue *qp, *nqp;
7475     Volume * vp, *start = NULL, *end = NULL;
7476
7477     /* get exclusive access to two chains, and drop the glock */
7478     VLRU_Wait_r(&volume_LRU.q[idx]);
7479     VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
7480     VLRU_Wait_r(&volume_LRU.q[idx+1]);
7481     VLRU_BeginExclusive_r(&volume_LRU.q[idx+1]);
7482     VOL_UNLOCK;
7483
7484     thresh = volume_LRU.promotion_interval[idx];
7485     now = FT_ApproxTime();
7486
7487     len = chaining = 0;
7488     for (queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
7489         vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
7490         promote = (((vp->stats.last_promote + thresh) <= now) &&
7491                    (vp->stats.last_get >= vp->stats.last_promote));
7492
7493         if (chaining) {
7494             if (promote) {
7495                 vp->vlru.idx++;
7496                 len++;
7497                 start = vp;
7498             } else {
7499                 /* promote and prepend chain */
7500                 queue_MoveChainAfter(&volume_LRU.q[idx+1], &start->vlru, &end->vlru);
7501                 chaining = 0;
7502             }
7503         } else {
7504             if (promote) {
7505                 vp->vlru.idx++;
7506                 len++;
7507                 chaining = 1;
7508                 start = end = vp;
7509             }
7510         }
7511     }
7512
7513     if (chaining) {
7514         /* promote and prepend */
7515         queue_MoveChainAfter(&volume_LRU.q[idx+1], &start->vlru, &end->vlru);
7516     }
7517
7518     if (len) {
7519         volume_LRU.q[idx].len -= len;
7520         volume_LRU.q[idx+1].len += len;
7521     }
7522
7523     /* release exclusive access to the two chains */
7524     VOL_LOCK;
7525     volume_LRU.last_promotion[idx] = now;
7526     VLRU_EndExclusive_r(&volume_LRU.q[idx+1]);
7527     VLRU_EndExclusive_r(&volume_LRU.q[idx]);
7528 }
7529
7530 /* run the demotions */
7531 static void
7532 VLRU_Demote_r(int idx)
7533 {
7534     Error ec;
7535     int len, chaining, demote;
7536     afs_uint32 now, thresh;
7537     struct rx_queue *qp, *nqp;
7538     Volume * vp, *start = NULL, *end = NULL;
7539     Volume ** salv_flag_vec = NULL;
7540     int salv_vec_offset = 0;
7541
7542     osi_Assert(idx == VLRU_QUEUE_MID || idx == VLRU_QUEUE_OLD);
7543
7544     /* get exclusive access to two chains, and drop the glock */
7545     VLRU_Wait_r(&volume_LRU.q[idx-1]);
7546     VLRU_BeginExclusive_r(&volume_LRU.q[idx-1]);
7547     VLRU_Wait_r(&volume_LRU.q[idx]);
7548     VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
7549     VOL_UNLOCK;
7550
7551     /* no big deal if this allocation fails */
7552     if (volume_LRU.q[idx].len) {
7553         salv_flag_vec = (Volume **) malloc(volume_LRU.q[idx].len * sizeof(Volume *));
7554     }
7555
7556     now = FT_ApproxTime();
7557     thresh = volume_LRU.promotion_interval[idx-1];
7558
7559     len = chaining = 0;
7560     for (queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
7561         vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
7562         demote = (((vp->stats.last_promote + thresh) <= now) &&
7563                   (vp->stats.last_get < (now - thresh)));
7564
7565         /* we now do volume update list DONT_SALVAGE flag setting during
7566          * demotion passes */
7567         if (salv_flag_vec &&
7568             !(V_attachFlags(vp) & VOL_HDR_DONTSALV) &&
7569             demote &&
7570             (vp->updateTime < (now - SALVAGE_INTERVAL)) &&
7571             (V_attachState(vp) == VOL_STATE_ATTACHED)) {
7572             salv_flag_vec[salv_vec_offset++] = vp;
7573             VCreateReservation_r(vp);
7574         }
7575
7576         if (chaining) {
7577             if (demote) {
7578                 vp->vlru.idx--;
7579                 len++;
7580                 start = vp;
7581             } else {
7582                 /* demote and append chain */
7583                 queue_MoveChainBefore(&volume_LRU.q[idx-1], &start->vlru, &end->vlru);
7584                 chaining = 0;
7585             }
7586         } else {
7587             if (demote) {
7588                 vp->vlru.idx--;
7589                 len++;
7590                 chaining = 1;
7591                 start = end = vp;
7592             }
7593         }
7594     }
7595
7596     if (chaining) {
7597         queue_MoveChainBefore(&volume_LRU.q[idx-1], &start->vlru, &end->vlru);
7598     }
7599
7600     if (len) {
7601         volume_LRU.q[idx].len -= len;
7602         volume_LRU.q[idx-1].len += len;
7603     }
7604
7605     /* release exclusive access to the two chains */
7606     VOL_LOCK;
7607     VLRU_EndExclusive_r(&volume_LRU.q[idx]);
7608     VLRU_EndExclusive_r(&volume_LRU.q[idx-1]);
7609
7610     /* now go back and set the DONT_SALVAGE flags as appropriate */
7611     if (salv_flag_vec) {
7612         int i;
7613         for (i = 0; i < salv_vec_offset; i++) {
7614             vp = salv_flag_vec[i];
7615             if (!(V_attachFlags(vp) & VOL_HDR_DONTSALV) &&
7616                 (vp->updateTime < (now - SALVAGE_INTERVAL)) &&
7617                 (V_attachState(vp) == VOL_STATE_ATTACHED)) {
7618                 ec = VHold_r(vp);
7619                 if (!ec) {
7620                     V_attachFlags(vp) |= VOL_HDR_DONTSALV;
7621                     V_dontSalvage(vp) = DONT_SALVAGE;
7622                     VUpdateVolume_r(&ec, vp, 0);
7623                     VPutVolume_r(vp);
7624                 }
7625             }
7626             VCancelReservation_r(vp);
7627         }
7628         free(salv_flag_vec);
7629     }
7630 }
7631
7632 /* run a pass of the VLRU GC scanner */
7633 static void
7634 VLRU_Scan_r(int idx)
7635 {
7636     afs_uint32 now, thresh;
7637     struct rx_queue *qp, *nqp;
7638     Volume * vp;
7639     int i, locked = 1;
7640
7641     osi_Assert(idx == VLRU_QUEUE_NEW || idx == VLRU_QUEUE_CANDIDATE);
7642
7643     /* gain exclusive access to the idx VLRU */
7644     VLRU_Wait_r(&volume_LRU.q[idx]);
7645     VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
7646
7647     if (idx != VLRU_QUEUE_CANDIDATE) {
7648         /* gain exclusive access to the candidate VLRU */
7649         VLRU_Wait_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7650         VLRU_BeginExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7651     }
7652
7653     now = FT_ApproxTime();
7654     thresh = now - VLRU_offline_thresh;
7655
7656     /* perform candidate selection and soft detaching */
7657     if (idx == VLRU_QUEUE_CANDIDATE) {
7658         /* soft detach some volumes from the candidate pool */
7659         VOL_UNLOCK;
7660         locked = 0;
7661
7662         for (i=0,queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
7663             vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
7664             if (i >= VLRU_offline_max) {
7665                 break;
7666             }
7667             /* check timestamp to see if it's a candidate for soft detaching */
7668             if (vp->stats.last_get <= thresh) {
7669                 VOL_LOCK;
7670                 if (VCheckSoftDetach(vp, thresh))
7671                     i++;
7672                 VOL_UNLOCK;
7673             }
7674         }
7675     } else {
7676         /* scan for volumes to become soft detach candidates */
7677         for (i=1,queue_ScanBackwards(&volume_LRU.q[idx], qp, nqp, rx_queue),i++) {
7678             vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
7679
7680             /* check timestamp to see if it's a candidate for soft detaching */
7681             if (vp->stats.last_get <= thresh) {
7682                 VCheckSoftDetachCandidate(vp, thresh);
7683             }
7684
7685             if (!(i&0x7f)) {   /* lock coarsening optimization */
7686                 VOL_UNLOCK;
7687                 pthread_yield();
7688                 VOL_LOCK;
7689             }
7690         }
7691     }
7692
7693     /* relinquish exclusive access to the VLRU chains */
7694     if (!locked) {
7695         VOL_LOCK;
7696     }
7697     volume_LRU.last_scan[idx] = now;
7698     if (idx != VLRU_QUEUE_CANDIDATE) {
7699         VLRU_EndExclusive_r(&volume_LRU.q[VLRU_QUEUE_CANDIDATE]);
7700     }
7701     VLRU_EndExclusive_r(&volume_LRU.q[idx]);
7702 }
7703
7704 /* check whether volume is safe to soft detach
7705  * caller MUST NOT hold a ref count on vp */
7706 static int
7707 VCheckSoftDetach(Volume * vp, afs_uint32 thresh)
7708 {
7709     int ret=0;
7710
7711     if (vp->nUsers || vp->nWaiters)
7712         return 0;
7713
7714     if (vp->stats.last_get <= thresh) {
7715         ret = VSoftDetachVolume_r(vp, thresh);
7716     }
7717
7718     return ret;
7719 }
7720
7721 /* check whether volume should be made a
7722  * soft detach candidate */
7723 static int
7724 VCheckSoftDetachCandidate(Volume * vp, afs_uint32 thresh)
7725 {
7726     int idx, ret = 0;
7727     if (vp->nUsers || vp->nWaiters)
7728         return 0;
7729
7730     idx = vp->vlru.idx;
7731
7732     osi_Assert(idx == VLRU_QUEUE_NEW);
7733
7734     if (vp->stats.last_get <= thresh) {
7735         /* move to candidate pool */
7736         queue_Remove(&vp->vlru);
7737         volume_LRU.q[VLRU_QUEUE_NEW].len--;
7738         queue_Prepend(&volume_LRU.q[VLRU_QUEUE_CANDIDATE], &vp->vlru);
7739         vp->vlru.idx = VLRU_QUEUE_CANDIDATE;
7740         volume_LRU.q[VLRU_QUEUE_CANDIDATE].len++;
7741         ret = 1;
7742     }
7743
7744     return ret;
7745 }
7746
7747
7748 /* begin exclusive access on VLRU */
7749 static void
7750 VLRU_BeginExclusive_r(struct VLRU_q * q)
7751 {
7752     osi_Assert(q->busy == 0);
7753     q->busy = 1;
7754 }
7755
7756 /* end exclusive access on VLRU */
7757 static void
7758 VLRU_EndExclusive_r(struct VLRU_q * q)
7759 {
7760     osi_Assert(q->busy);
7761     q->busy = 0;
7762     CV_BROADCAST(&q->cv);
7763 }
7764
7765 /* wait for another thread to end exclusive access on VLRU */
7766 static void
7767 VLRU_Wait_r(struct VLRU_q * q)
7768 {
7769     while(q->busy) {
7770         VOL_CV_WAIT(&q->cv);
7771     }
7772 }
7773
7774 /* demand attach fs
7775  * volume soft detach
7776  *
7777  * caller MUST NOT hold a ref count on vp */
7778 static int
7779 VSoftDetachVolume_r(Volume * vp, afs_uint32 thresh)
7780 {
7781     afs_uint32 ts_save;
7782     int ret = 0;
7783
7784     osi_Assert(vp->vlru.idx == VLRU_QUEUE_CANDIDATE);
7785
7786     ts_save = vp->stats.last_get;
7787     if (ts_save > thresh)
7788         return 0;
7789
7790     if (vp->nUsers || vp->nWaiters)
7791         return 0;
7792
7793     if (VIsExclusiveState(V_attachState(vp))) {
7794         return 0;
7795     }
7796
7797     switch (V_attachState(vp)) {
7798     case VOL_STATE_UNATTACHED:
7799     case VOL_STATE_PREATTACHED:
7800     case VOL_STATE_ERROR:
7801     case VOL_STATE_GOING_OFFLINE:
7802     case VOL_STATE_SHUTTING_DOWN:
7803     case VOL_STATE_SALVAGING:
7804     case VOL_STATE_DELETED:
7805         volume_LRU.q[vp->vlru.idx].len--;
7806
7807         /* create and cancel a reservation to
7808          * give the volume an opportunity to
7809          * be deallocated */
7810         VCreateReservation_r(vp);
7811         queue_Remove(&vp->vlru);
7812         vp->vlru.idx = VLRU_QUEUE_INVALID;
7813         V_attachFlags(vp) &= ~(VOL_ON_VLRU);
7814         VCancelReservation_r(vp);
7815         return 0;
7816     default:
7817         break;
7818     }
7819
7820     /* hold the volume and take it offline.
7821      * no need for reservations, as VHold_r
7822      * takes care of that internally. */
7823     if (VHold_r(vp) == 0) {
7824         /* vhold drops the glock, so now we should
7825          * check to make sure we aren't racing against
7826          * other threads.  if we are racing, offlining vp
7827          * would be wasteful, and block the scanner for a while
7828          */
7829         if (vp->nWaiters ||
7830             (vp->nUsers > 1) ||
7831             (vp->shuttingDown) ||
7832             (vp->goingOffline) ||
7833             (vp->stats.last_get != ts_save)) {
7834             /* looks like we're racing someone else. bail */
7835             VPutVolume_r(vp);
7836             vp = NULL;
7837         } else {
7838             /* pull it off the VLRU */
7839             osi_Assert(vp->vlru.idx == VLRU_QUEUE_CANDIDATE);
7840             volume_LRU.q[VLRU_QUEUE_CANDIDATE].len--;
7841             queue_Remove(&vp->vlru);
7842             vp->vlru.idx = VLRU_QUEUE_INVALID;
7843             V_attachFlags(vp) &= ~(VOL_ON_VLRU);
7844
7845             /* take if offline */
7846             VOffline_r(vp, "volume has been soft detached");
7847
7848             /* invalidate the volume header cache */
7849             FreeVolumeHeader(vp);
7850
7851             /* update stats */
7852             IncUInt64(&VStats.soft_detaches);
7853             vp->stats.soft_detaches++;
7854
7855             /* put in pre-attached state so demand
7856              * attacher can work on it */
7857             VChangeState_r(vp, VOL_STATE_PREATTACHED);
7858             ret = 1;
7859         }
7860     }
7861     return ret;
7862 }
7863 #endif /* AFS_DEMAND_ATTACH_FS */
7864
7865
7866 /***************************************************/
7867 /* Volume Header Cache routines                    */
7868 /***************************************************/
7869
7870 /**
7871  * volume header cache.
7872  */
7873 struct volume_hdr_LRU_t volume_hdr_LRU;
7874
7875 /**
7876  * initialize the volume header cache.
7877  *
7878  * @param[in] howMany  number of header cache entries to preallocate
7879  *
7880  * @pre VOL_LOCK held.  Function has never been called before.
7881  *
7882  * @post howMany cache entries are allocated, initialized, and added
7883  *       to the LRU list.  Header cache statistics are initialized.
7884  *
7885  * @note only applicable to fileServer program type.  Should only be
7886  *       called once during volume package initialization.
7887  *
7888  * @internal volume package internal use only.
7889  */
7890 static void
7891 VInitVolumeHeaderCache(afs_uint32 howMany)
7892 {
7893     struct volHeader *hp;
7894     if (programType != fileServer)
7895         return;
7896     queue_Init(&volume_hdr_LRU);
7897     volume_hdr_LRU.stats.free = 0;
7898     volume_hdr_LRU.stats.used = howMany;
7899     volume_hdr_LRU.stats.attached = 0;
7900     hp = (struct volHeader *)(calloc(howMany, sizeof(struct volHeader)));
7901     osi_Assert(hp != NULL);
7902
7903     while (howMany--)
7904         /* We are using ReleaseVolumeHeader to initialize the values on the header list
7905          * to ensure they have the right values
7906          */
7907         ReleaseVolumeHeader(hp++);
7908 }
7909
7910 /**
7911  * get a volume header and attach it to the volume object.
7912  *
7913  * @param[in] vp  pointer to volume object
7914  *
7915  * @return cache entry status
7916  *    @retval 0  volume header was newly attached; cache data is invalid
7917  *    @retval 1  volume header was previously attached; cache data is valid
7918  *
7919  * @pre VOL_LOCK held.  For DAFS, lightweight ref must be held on volume object.
7920  *
7921  * @post volume header attached to volume object.  if necessary, header cache
7922  *       entry on LRU is synchronized to disk.  Header is removed from LRU list.
7923  *
7924  * @note VOL_LOCK may be dropped
7925  *
7926  * @warning this interface does not load header data from disk.  it merely
7927  *          attaches a header object to the volume object, and may sync the old
7928  *          header cache data out to disk in the process.
7929  *
7930  * @internal volume package internal use only.
7931  */
7932 static int
7933 GetVolumeHeader(Volume * vp)
7934 {
7935     Error error;
7936     struct volHeader *hd;
7937     int old;
7938     static int everLogged = 0;
7939
7940 #ifdef AFS_DEMAND_ATTACH_FS
7941     VolState vp_save = 0, back_save = 0;
7942
7943     /* XXX debug 9/19/05 we've apparently got
7944      * a ref counting bug somewhere that's
7945      * breaking the nUsers == 0 => header on LRU
7946      * assumption */
7947     if (vp->header && queue_IsNotOnQueue(vp->header)) {
7948         Log("nUsers == 0, but header not on LRU\n");
7949         return 1;
7950     }
7951 #endif
7952
7953     old = (vp->header != NULL); /* old == volume already has a header */
7954
7955     if (programType != fileServer) {
7956         /* for volume utilities, we allocate volHeaders as needed */
7957         if (!vp->header) {
7958             hd = (struct volHeader *)calloc(1, sizeof(*vp->header));
7959             osi_Assert(hd != NULL);
7960             vp->header = hd;
7961             hd->back = vp;
7962 #ifdef AFS_DEMAND_ATTACH_FS
7963             V_attachFlags(vp) |= VOL_HDR_ATTACHED;
7964 #endif
7965         }
7966     } else {
7967         /* for the fileserver, we keep a volume header cache */
7968         if (old) {
7969             /* the header we previously dropped in the lru is
7970              * still available. pull it off the lru and return */
7971             hd = vp->header;
7972             queue_Remove(hd);
7973             osi_Assert(hd->back == vp);
7974 #ifdef AFS_DEMAND_ATTACH_FS
7975             V_attachFlags(vp) &= ~(VOL_HDR_IN_LRU);
7976 #endif
7977         } else {
7978             /* we need to grab a new element off the LRU */
7979             if (queue_IsNotEmpty(&volume_hdr_LRU)) {
7980                 /* grab an element and pull off of LRU */
7981                 hd = queue_First(&volume_hdr_LRU, volHeader);
7982                 queue_Remove(hd);
7983             } else {
7984                 /* LRU is empty, so allocate a new volHeader
7985                  * this is probably indicative of a leak, so let the user know */
7986                 hd = (struct volHeader *)calloc(1, sizeof(struct volHeader));
7987                 osi_Assert(hd != NULL);
7988                 if (!everLogged) {
7989                     Log("****Allocated more volume headers, probably leak****\n");
7990                     everLogged = 1;
7991                 }
7992                 volume_hdr_LRU.stats.free++;
7993             }
7994             if (hd->back) {
7995                 /* this header used to belong to someone else.
7996                  * we'll need to check if the header needs to
7997                  * be sync'd out to disk */
7998
7999 #ifdef AFS_DEMAND_ATTACH_FS
8000                 /* if hd->back were in an exclusive state, then
8001                  * its volHeader would not be on the LRU... */
8002                 osi_Assert(!VIsExclusiveState(V_attachState(hd->back)));
8003 #endif
8004
8005                 if (hd->diskstuff.inUse) {
8006                     /* volume was in use, so we'll need to sync
8007                      * its header to disk */
8008
8009 #ifdef AFS_DEMAND_ATTACH_FS
8010                     back_save = VChangeState_r(hd->back, VOL_STATE_UPDATING);
8011                     vp_save = VChangeState_r(vp, VOL_STATE_HDR_ATTACHING);
8012                     VCreateReservation_r(hd->back);
8013                     VOL_UNLOCK;
8014 #endif
8015
8016                     WriteVolumeHeader_r(&error, hd->back);
8017                     /* Ignore errors; catch them later */
8018
8019 #ifdef AFS_DEMAND_ATTACH_FS
8020                     VOL_LOCK;
8021 #endif
8022                 }
8023
8024                 hd->back->header = NULL;
8025 #ifdef AFS_DEMAND_ATTACH_FS
8026                 V_attachFlags(hd->back) &= ~(VOL_HDR_ATTACHED | VOL_HDR_LOADED | VOL_HDR_IN_LRU);
8027
8028                 if (hd->diskstuff.inUse) {
8029                     VChangeState_r(hd->back, back_save);
8030                     VCancelReservation_r(hd->back);
8031                     VChangeState_r(vp, vp_save);
8032                 }
8033 #endif
8034             } else {
8035                 volume_hdr_LRU.stats.attached++;
8036             }
8037             hd->back = vp;
8038             vp->header = hd;
8039 #ifdef AFS_DEMAND_ATTACH_FS
8040             V_attachFlags(vp) |= VOL_HDR_ATTACHED;
8041 #endif
8042         }
8043         volume_hdr_LRU.stats.free--;
8044         volume_hdr_LRU.stats.used++;
8045     }
8046     IncUInt64(&VStats.hdr_gets);
8047 #ifdef AFS_DEMAND_ATTACH_FS
8048     IncUInt64(&vp->stats.hdr_gets);
8049     vp->stats.last_hdr_get = FT_ApproxTime();
8050 #endif
8051     return old;
8052 }
8053
8054
8055 /**
8056  * make sure volume header is attached and contains valid cache data.
8057  *
8058  * @param[out] ec  outbound error code
8059  * @param[in]  vp  pointer to volume object
8060  *
8061  * @pre VOL_LOCK held.  For DAFS, lightweight ref held on vp.
8062  *
8063  * @post header cache entry attached, and loaded with valid data, or
8064  *       *ec is nonzero, and the header is released back into the LRU.
8065  *
8066  * @internal volume package internal use only.
8067  */
8068 static void
8069 LoadVolumeHeader(Error * ec, Volume * vp)
8070 {
8071 #ifdef AFS_DEMAND_ATTACH_FS
8072     VolState state_save;
8073     afs_uint32 now;
8074     *ec = 0;
8075
8076     if (vp->nUsers == 0 && !GetVolumeHeader(vp)) {
8077         IncUInt64(&VStats.hdr_loads);
8078         state_save = VChangeState_r(vp, VOL_STATE_HDR_LOADING);
8079         VOL_UNLOCK;
8080
8081         ReadHeader(ec, V_diskDataHandle(vp), (char *)&V_disk(vp),
8082                    sizeof(V_disk(vp)), VOLUMEINFOMAGIC,
8083                    VOLUMEINFOVERSION);
8084         IncUInt64(&vp->stats.hdr_loads);
8085         now = FT_ApproxTime();
8086
8087         VOL_LOCK;
8088         if (!*ec) {
8089             V_attachFlags(vp) |= VOL_HDR_LOADED;
8090             vp->stats.last_hdr_load = now;
8091         }
8092         VChangeState_r(vp, state_save);
8093     }
8094 #else /* AFS_DEMAND_ATTACH_FS */
8095     *ec = 0;
8096     if (vp->nUsers == 0 && !GetVolumeHeader(vp)) {
8097         IncUInt64(&VStats.hdr_loads);
8098
8099         ReadHeader(ec, V_diskDataHandle(vp), (char *)&V_disk(vp),
8100                    sizeof(V_disk(vp)), VOLUMEINFOMAGIC,
8101                    VOLUMEINFOVERSION);
8102     }
8103 #endif /* AFS_DEMAND_ATTACH_FS */
8104     if (*ec) {
8105         /* maintain (nUsers==0) => header in LRU invariant */
8106         FreeVolumeHeader(vp);
8107     }
8108 }
8109
8110 /**
8111  * release a header cache entry back into the LRU list.
8112  *
8113  * @param[in] hd  pointer to volume header cache object
8114  *
8115  * @pre VOL_LOCK held.
8116  *
8117  * @post header cache object appended onto end of LRU list.
8118  *
8119  * @note only applicable to fileServer program type.
8120  *
8121  * @note used to place a header cache entry back into the
8122  *       LRU pool without invalidating it as a cache entry.
8123  *
8124  * @internal volume package internal use only.
8125  */
8126 static void
8127 ReleaseVolumeHeader(struct volHeader *hd)
8128 {
8129     if (programType != fileServer)
8130         return;
8131     if (!hd || queue_IsOnQueue(hd))     /* no header, or header already released */
8132         return;
8133     queue_Append(&volume_hdr_LRU, hd);
8134 #ifdef AFS_DEMAND_ATTACH_FS
8135     if (hd->back) {
8136         V_attachFlags(hd->back) |= VOL_HDR_IN_LRU;
8137     }
8138 #endif
8139     volume_hdr_LRU.stats.free++;
8140     volume_hdr_LRU.stats.used--;
8141 }
8142
8143 /**
8144  * free/invalidate a volume header cache entry.
8145  *
8146  * @param[in] vp  pointer to volume object
8147  *
8148  * @pre VOL_LOCK is held.
8149  *
8150  * @post For fileserver, header cache entry is returned to LRU, and it is
8151  *       invalidated as a cache entry.  For volume utilities, the header
8152  *       cache entry is freed.
8153  *
8154  * @note For fileserver, this should be utilized instead of ReleaseVolumeHeader
8155  *       whenever it is necessary to invalidate the header cache entry.
8156  *
8157  * @see ReleaseVolumeHeader
8158  *
8159  * @internal volume package internal use only.
8160  */
8161 static void
8162 FreeVolumeHeader(Volume * vp)
8163 {
8164     struct volHeader *hd = vp->header;
8165     if (!hd)
8166         return;
8167     if (programType == fileServer) {
8168         ReleaseVolumeHeader(hd);
8169         hd->back = NULL;
8170     } else {
8171         free(hd);
8172     }
8173 #ifdef AFS_DEMAND_ATTACH_FS
8174     V_attachFlags(vp) &= ~(VOL_HDR_ATTACHED | VOL_HDR_IN_LRU | VOL_HDR_LOADED);
8175 #endif
8176     volume_hdr_LRU.stats.attached--;
8177     vp->header = NULL;
8178 }
8179
8180
8181 /***************************************************/
8182 /* Volume Hash Table routines                      */
8183 /***************************************************/
8184
8185 /**
8186  * set size of volume object hash table.
8187  *
8188  * @param[in] logsize   log(2) of desired hash table size
8189  *
8190  * @return operation status
8191  *    @retval 0 success
8192  *    @retval -1 failure
8193  *
8194  * @pre MUST be called prior to VInitVolumePackage2
8195  *
8196  * @post Volume Hash Table will have 2^logsize buckets
8197  */
8198 int
8199 VSetVolHashSize(int logsize)
8200 {
8201     /* 64 to 268435456 hash buckets seems like a reasonable range */
8202     if ((logsize < 6 ) || (logsize > 28)) {
8203         return -1;
8204     }
8205
8206     if (!VInit) {
8207         VolumeHashTable.Size = 1 << logsize;
8208         VolumeHashTable.Mask = VolumeHashTable.Size - 1;
8209     } else {
8210         /* we can't yet support runtime modification of this
8211          * parameter. we'll need a configuration rwlock to
8212          * make runtime modification feasible.... */
8213         return -1;
8214     }
8215     return 0;
8216 }
8217
8218 /**
8219  * initialize dynamic data structures for volume hash table.
8220  *
8221  * @post hash table is allocated, and fields are initialized.
8222  *
8223  * @internal volume package internal use only.
8224  */
8225 static void
8226 VInitVolumeHash(void)
8227 {
8228     int i;
8229
8230     VolumeHashTable.Table = (VolumeHashChainHead *) calloc(VolumeHashTable.Size,
8231                                                            sizeof(VolumeHashChainHead));
8232     osi_Assert(VolumeHashTable.Table != NULL);
8233
8234     for (i=0; i < VolumeHashTable.Size; i++) {
8235         queue_Init(&VolumeHashTable.Table[i]);
8236 #ifdef AFS_DEMAND_ATTACH_FS
8237         CV_INIT(&VolumeHashTable.Table[i].chain_busy_cv, "vhash busy", CV_DEFAULT, 0);
8238 #endif /* AFS_DEMAND_ATTACH_FS */
8239     }
8240 }
8241
8242 /**
8243  * add a volume object to the hash table.
8244  *
8245  * @param[in] vp      pointer to volume object
8246  * @param[in] hashid  hash of volume id
8247  *
8248  * @pre VOL_LOCK is held.  For DAFS, caller must hold a lightweight
8249  *      reference on vp.
8250  *
8251  * @post volume is added to hash chain.
8252  *
8253  * @internal volume package internal use only.
8254  *
8255  * @note For DAFS, VOL_LOCK may be dropped in order to wait for an
8256  *       asynchronous hash chain reordering to finish.
8257  */
8258 static void
8259 AddVolumeToHashTable(Volume * vp, int hashid)
8260 {
8261     VolumeHashChainHead * head;
8262
8263     if (queue_IsOnQueue(vp))
8264         return;
8265
8266     head = &VolumeHashTable.Table[VOLUME_HASH(hashid)];
8267
8268 #ifdef AFS_DEMAND_ATTACH_FS
8269     /* wait for the hash chain to become available */
8270     VHashWait_r(head);
8271
8272     V_attachFlags(vp) |= VOL_IN_HASH;
8273     vp->chainCacheCheck = ++head->cacheCheck;
8274 #endif /* AFS_DEMAND_ATTACH_FS */
8275
8276     head->len++;
8277     vp->hashid = hashid;
8278     queue_Append(head, vp);
8279     vp->vnodeHashOffset = VolumeHashOffset_r();
8280 }
8281
8282 /**
8283  * delete a volume object from the hash table.
8284  *
8285  * @param[in] vp  pointer to volume object
8286  *
8287  * @pre VOL_LOCK is held.  For DAFS, caller must hold a lightweight
8288  *      reference on vp.
8289  *
8290  * @post volume is removed from 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 DeleteVolumeFromHashTable(Volume * vp)
8299 {
8300     VolumeHashChainHead * head;
8301
8302     if (!queue_IsOnQueue(vp))
8303         return;
8304
8305     head = &VolumeHashTable.Table[VOLUME_HASH(vp->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     head->cacheCheck++;
8313 #endif /* AFS_DEMAND_ATTACH_FS */
8314
8315     head->len--;
8316     queue_Remove(vp);
8317     /* do NOT reset hashid to zero, as the online
8318      * salvager package may need to know the volume id
8319      * after the volume is removed from the hash */
8320 }
8321
8322 /**
8323  * lookup a volume object in the hash table given a volume id.
8324  *
8325  * @param[out] ec        error code return
8326  * @param[in]  volumeId  volume id
8327  * @param[in]  hint      volume object which we believe could be the correct
8328                          mapping
8329  *
8330  * @return volume object pointer
8331  *    @retval NULL  no such volume id is registered with the hash table.
8332  *
8333  * @pre VOL_LOCK is held.  For DAFS, caller must hold a lightweight
8334         ref on hint.
8335  *
8336  * @post volume object with the given id is returned.  volume object and
8337  *       hash chain access statistics are updated.  hash chain may have
8338  *       been reordered.
8339  *
8340  * @note For DAFS, VOL_LOCK may be dropped in order to wait for an
8341  *       asynchronous hash chain reordering operation to finish, or
8342  *       in order for us to perform an asynchronous chain reordering.
8343  *
8344  * @note Hash chain reorderings occur when the access count for the
8345  *       volume object being looked up exceeds the sum of the previous
8346  *       node's (the node ahead of it in the hash chain linked list)
8347  *       access count plus the constant VOLUME_HASH_REORDER_THRESHOLD.
8348  *
8349  * @note For DAFS, the hint parameter allows us to short-circuit if the
8350  *       cacheCheck fields match between the hash chain head and the
8351  *       hint volume object.
8352  */
8353 Volume *
8354 VLookupVolume_r(Error * ec, VolId volumeId, Volume * hint)
8355 {
8356     int looks = 0;
8357     Volume * vp, *np;
8358 #ifdef AFS_DEMAND_ATTACH_FS
8359     Volume *pp;
8360 #endif
8361     VolumeHashChainHead * head;
8362     *ec = 0;
8363
8364     head = &VolumeHashTable.Table[VOLUME_HASH(volumeId)];
8365
8366 #ifdef AFS_DEMAND_ATTACH_FS
8367     /* wait for the hash chain to become available */
8368     VHashWait_r(head);
8369
8370     /* check to see if we can short circuit without walking the hash chain */
8371     if (hint && (hint->chainCacheCheck == head->cacheCheck)) {
8372         IncUInt64(&hint->stats.hash_short_circuits);
8373         return hint;
8374     }
8375 #endif /* AFS_DEMAND_ATTACH_FS */
8376
8377     /* someday we need to either do per-chain locks, RWlocks,
8378      * or both for volhash access.
8379      * (and move to a data structure with better cache locality) */
8380
8381     /* search the chain for this volume id */
8382     for(queue_Scan(head, vp, np, Volume)) {
8383         looks++;
8384         if ((vp->hashid == volumeId)) {
8385             break;
8386         }
8387     }
8388
8389     if (queue_IsEnd(head, vp)) {
8390         vp = NULL;
8391     }
8392
8393 #ifdef AFS_DEMAND_ATTACH_FS
8394     /* update hash chain statistics */
8395     {
8396         afs_uint64 lks;
8397         FillInt64(lks, 0, looks);
8398         AddUInt64(head->looks, lks, &head->looks);
8399         AddUInt64(VStats.hash_looks, lks, &VStats.hash_looks);
8400         IncUInt64(&head->gets);
8401     }
8402
8403     if (vp) {
8404         afs_uint64 thresh;
8405         IncUInt64(&vp->stats.hash_lookups);
8406
8407         /* for demand attach fileserver, we permit occasional hash chain reordering
8408          * so that frequently looked up volumes move towards the head of the chain */
8409         pp = queue_Prev(vp, Volume);
8410         if (!queue_IsEnd(head, pp)) {
8411             FillInt64(thresh, 0, VOLUME_HASH_REORDER_THRESHOLD);
8412             AddUInt64(thresh, pp->stats.hash_lookups, &thresh);
8413             if (GEInt64(vp->stats.hash_lookups, thresh)) {
8414                 VReorderHash_r(head, pp, vp);
8415             }
8416         }
8417
8418         /* update the short-circuit cache check */
8419         vp->chainCacheCheck = head->cacheCheck;
8420     }
8421 #endif /* AFS_DEMAND_ATTACH_FS */
8422
8423     return vp;
8424 }
8425
8426 #ifdef AFS_DEMAND_ATTACH_FS
8427 /* perform volume hash chain reordering.
8428  *
8429  * advance a subchain beginning at vp ahead of
8430  * the adjacent subchain ending at pp */
8431 static void
8432 VReorderHash_r(VolumeHashChainHead * head, Volume * pp, Volume * vp)
8433 {
8434     Volume *tp, *np, *lp;
8435     afs_uint64 move_thresh;
8436
8437     /* this should never be called if the chain is already busy, so
8438      * no need to wait for other exclusive chain ops to finish */
8439
8440     /* this is a rather heavy set of operations,
8441      * so let's set the chain busy flag and drop
8442      * the vol_glock */
8443     VHashBeginExclusive_r(head);
8444     VOL_UNLOCK;
8445
8446     /* scan forward in the chain from vp looking for the last element
8447      * in the chain we want to advance */
8448     FillInt64(move_thresh, 0, VOLUME_HASH_REORDER_CHAIN_THRESH);
8449     AddUInt64(move_thresh, pp->stats.hash_lookups, &move_thresh);
8450     for(queue_ScanFrom(head, vp, tp, np, Volume)) {
8451         if (LTInt64(tp->stats.hash_lookups, move_thresh)) {
8452             break;
8453         }
8454     }
8455     lp = queue_Prev(tp, Volume);
8456
8457     /* scan backwards from pp to determine where to splice and
8458      * insert the subchain we're advancing */
8459     for(queue_ScanBackwardsFrom(head, pp, tp, np, Volume)) {
8460         if (GTInt64(tp->stats.hash_lookups, move_thresh)) {
8461             break;
8462         }
8463     }
8464     tp = queue_Next(tp, Volume);
8465
8466     /* rebalance chain(vp,...,lp) ahead of chain(tp,...,pp) */
8467     queue_MoveChainBefore(tp,vp,lp);
8468
8469     VOL_LOCK;
8470     IncUInt64(&VStats.hash_reorders);
8471     head->cacheCheck++;
8472     IncUInt64(&head->reorders);
8473
8474     /* wake up any threads waiting for the hash chain */
8475     VHashEndExclusive_r(head);
8476 }
8477
8478
8479 /* demand-attach fs volume hash
8480  * asynchronous exclusive operations */
8481
8482 /**
8483  * begin an asynchronous exclusive operation on a volume hash chain.
8484  *
8485  * @param[in] head   pointer to volume hash chain head object
8486  *
8487  * @pre VOL_LOCK held.  hash chain is quiescent.
8488  *
8489  * @post hash chain marked busy.
8490  *
8491  * @note this interface is used in conjunction with VHashEndExclusive_r and
8492  *       VHashWait_r to perform asynchronous (wrt VOL_LOCK) operations on a
8493  *       volume hash chain.  Its main use case is hash chain reordering, which
8494  *       has the potential to be a highly latent operation.
8495  *
8496  * @see VHashEndExclusive_r
8497  * @see VHashWait_r
8498  *
8499  * @note DAFS only
8500  *
8501  * @internal volume package internal use only.
8502  */
8503 static void
8504 VHashBeginExclusive_r(VolumeHashChainHead * head)
8505 {
8506     osi_Assert(head->busy == 0);
8507     head->busy = 1;
8508 }
8509
8510 /**
8511  * relinquish exclusive ownership of a volume hash chain.
8512  *
8513  * @param[in] head   pointer to volume hash chain head object
8514  *
8515  * @pre VOL_LOCK held.  thread owns the hash chain exclusively.
8516  *
8517  * @post hash chain is marked quiescent.  threads awaiting use of
8518  *       chain are awakened.
8519  *
8520  * @see VHashBeginExclusive_r
8521  * @see VHashWait_r
8522  *
8523  * @note DAFS only
8524  *
8525  * @internal volume package internal use only.
8526  */
8527 static void
8528 VHashEndExclusive_r(VolumeHashChainHead * head)
8529 {
8530     osi_Assert(head->busy);
8531     head->busy = 0;
8532     CV_BROADCAST(&head->chain_busy_cv);
8533 }
8534
8535 /**
8536  * wait for all asynchronous operations on a hash chain to complete.
8537  *
8538  * @param[in] head   pointer to volume hash chain head object
8539  *
8540  * @pre VOL_LOCK held.
8541  *
8542  * @post hash chain object is quiescent.
8543  *
8544  * @see VHashBeginExclusive_r
8545  * @see VHashEndExclusive_r
8546  *
8547  * @note DAFS only
8548  *
8549  * @note This interface should be called before any attempt to
8550  *       traverse the hash chain.  It is permissible for a thread
8551  *       to gain exclusive access to the chain, and then perform
8552  *       latent operations on the chain asynchronously wrt the
8553  *       VOL_LOCK.
8554  *
8555  * @warning if waiting is necessary, VOL_LOCK is dropped
8556  *
8557  * @internal volume package internal use only.
8558  */
8559 static void
8560 VHashWait_r(VolumeHashChainHead * head)
8561 {
8562     while (head->busy) {
8563         VOL_CV_WAIT(&head->chain_busy_cv);
8564     }
8565 }
8566 #endif /* AFS_DEMAND_ATTACH_FS */
8567
8568
8569 /***************************************************/
8570 /* Volume by Partition List routines               */
8571 /***************************************************/
8572
8573 /*
8574  * demand attach fileserver adds a
8575  * linked list of volumes to each
8576  * partition object, thus allowing
8577  * for quick enumeration of all
8578  * volumes on a partition
8579  */
8580
8581 #ifdef AFS_DEMAND_ATTACH_FS
8582 /**
8583  * add a volume to its disk partition VByPList.
8584  *
8585  * @param[in] vp  pointer to volume object
8586  *
8587  * @pre either the disk partition VByPList is owned exclusively
8588  *      by the calling thread, or the list is quiescent and
8589  *      VOL_LOCK is held.
8590  *
8591  * @post volume is added to disk partition VByPList
8592  *
8593  * @note DAFS only
8594  *
8595  * @warning it is the caller's responsibility to ensure list
8596  *          quiescence.
8597  *
8598  * @see VVByPListWait_r
8599  * @see VVByPListBeginExclusive_r
8600  * @see VVByPListEndExclusive_r
8601  *
8602  * @internal volume package internal use only.
8603  */
8604 static void
8605 AddVolumeToVByPList_r(Volume * vp)
8606 {
8607     if (queue_IsNotOnQueue(&vp->vol_list)) {
8608         queue_Append(&vp->partition->vol_list, &vp->vol_list);
8609         V_attachFlags(vp) |= VOL_ON_VBYP_LIST;
8610         vp->partition->vol_list.len++;
8611     }
8612 }
8613
8614 /**
8615  * delete a volume from its disk partition VByPList.
8616  *
8617  * @param[in] vp  pointer to volume object
8618  *
8619  * @pre either the disk partition VByPList is owned exclusively
8620  *      by the calling thread, or the list is quiescent and
8621  *      VOL_LOCK is held.
8622  *
8623  * @post volume is removed from the disk partition VByPList
8624  *
8625  * @note DAFS only
8626  *
8627  * @warning it is the caller's responsibility to ensure list
8628  *          quiescence.
8629  *
8630  * @see VVByPListWait_r
8631  * @see VVByPListBeginExclusive_r
8632  * @see VVByPListEndExclusive_r
8633  *
8634  * @internal volume package internal use only.
8635  */
8636 static void
8637 DeleteVolumeFromVByPList_r(Volume * vp)
8638 {
8639     if (queue_IsOnQueue(&vp->vol_list)) {
8640         queue_Remove(&vp->vol_list);
8641         V_attachFlags(vp) &= ~(VOL_ON_VBYP_LIST);
8642         vp->partition->vol_list.len--;
8643     }
8644 }
8645
8646 /**
8647  * begin an asynchronous exclusive operation on a VByPList.
8648  *
8649  * @param[in] dp   pointer to disk partition object
8650  *
8651  * @pre VOL_LOCK held.  VByPList is quiescent.
8652  *
8653  * @post VByPList marked busy.
8654  *
8655  * @note this interface is used in conjunction with VVByPListEndExclusive_r and
8656  *       VVByPListWait_r to perform asynchronous (wrt VOL_LOCK) operations on a
8657  *       VByPList.
8658  *
8659  * @see VVByPListEndExclusive_r
8660  * @see VVByPListWait_r
8661  *
8662  * @note DAFS only
8663  *
8664  * @internal volume package internal use only.
8665  */
8666 /* take exclusive control over the list */
8667 static void
8668 VVByPListBeginExclusive_r(struct DiskPartition64 * dp)
8669 {
8670     osi_Assert(dp->vol_list.busy == 0);
8671     dp->vol_list.busy = 1;
8672 }
8673
8674 /**
8675  * relinquish exclusive ownership of a VByPList.
8676  *
8677  * @param[in] dp   pointer to disk partition object
8678  *
8679  * @pre VOL_LOCK held.  thread owns the VByPList exclusively.
8680  *
8681  * @post VByPList is marked quiescent.  threads awaiting use of
8682  *       the list are awakened.
8683  *
8684  * @see VVByPListBeginExclusive_r
8685  * @see VVByPListWait_r
8686  *
8687  * @note DAFS only
8688  *
8689  * @internal volume package internal use only.
8690  */
8691 static void
8692 VVByPListEndExclusive_r(struct DiskPartition64 * dp)
8693 {
8694     osi_Assert(dp->vol_list.busy);
8695     dp->vol_list.busy = 0;
8696     CV_BROADCAST(&dp->vol_list.cv);
8697 }
8698
8699 /**
8700  * wait for all asynchronous operations on a VByPList to complete.
8701  *
8702  * @param[in] dp  pointer to disk partition object
8703  *
8704  * @pre VOL_LOCK is held.
8705  *
8706  * @post disk partition's VByP list is quiescent
8707  *
8708  * @note DAFS only
8709  *
8710  * @note This interface should be called before any attempt to
8711  *       traverse the VByPList.  It is permissible for a thread
8712  *       to gain exclusive access to the list, and then perform
8713  *       latent operations on the list asynchronously wrt the
8714  *       VOL_LOCK.
8715  *
8716  * @warning if waiting is necessary, VOL_LOCK is dropped
8717  *
8718  * @see VVByPListEndExclusive_r
8719  * @see VVByPListBeginExclusive_r
8720  *
8721  * @internal volume package internal use only.
8722  */
8723 static void
8724 VVByPListWait_r(struct DiskPartition64 * dp)
8725 {
8726     while (dp->vol_list.busy) {
8727         VOL_CV_WAIT(&dp->vol_list.cv);
8728     }
8729 }
8730 #endif /* AFS_DEMAND_ATTACH_FS */
8731
8732 /***************************************************/
8733 /* Volume Cache Statistics routines                */
8734 /***************************************************/
8735
8736 void
8737 VPrintCacheStats_r(void)
8738 {
8739     afs_uint32 get_hi, get_lo, load_hi, load_lo;
8740     struct VnodeClassInfo *vcp;
8741     vcp = &VnodeClassInfo[vLarge];
8742     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);
8743     vcp = &VnodeClassInfo[vSmall];
8744     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);
8745     SplitInt64(VStats.hdr_gets, get_hi, get_lo);
8746     SplitInt64(VStats.hdr_loads, load_hi, load_lo);
8747     Log("Volume header cache, %d entries, %d gets, %d replacements\n",
8748         VStats.hdr_cache_size, get_lo, load_lo);
8749 }
8750
8751 void
8752 VPrintCacheStats(void)
8753 {
8754     VOL_LOCK;
8755     VPrintCacheStats_r();
8756     VOL_UNLOCK;
8757 }
8758
8759 #ifdef AFS_DEMAND_ATTACH_FS
8760 static double
8761 UInt64ToDouble(afs_uint64 * x)
8762 {
8763     static double c32 = 4.0 * 1.073741824 * 1000000000.0;
8764     afs_uint32 h, l;
8765     SplitInt64(*x, h, l);
8766     return (((double)h) * c32) + ((double) l);
8767 }
8768
8769 static char *
8770 DoubleToPrintable(double x, char * buf, int len)
8771 {
8772     static double billion = 1000000000.0;
8773     afs_uint32 y[3];
8774
8775     y[0] = (afs_uint32) (x / (billion * billion));
8776     y[1] = (afs_uint32) ((x - (((double)y[0]) * billion * billion)) / billion);
8777     y[2] = (afs_uint32) (x - ((((double)y[0]) * billion * billion) + (((double)y[1]) * billion)));
8778
8779     if (y[0]) {
8780         snprintf(buf, len, "%d%09d%09d", y[0], y[1], y[2]);
8781     } else if (y[1]) {
8782         snprintf(buf, len, "%d%09d", y[1], y[2]);
8783     } else {
8784         snprintf(buf, len, "%d", y[2]);
8785     }
8786     buf[len-1] = '\0';
8787     return buf;
8788 }
8789
8790 struct VLRUExtStatsEntry {
8791     VolumeId volid;
8792 };
8793
8794 struct VLRUExtStats {
8795     afs_uint32 len;
8796     afs_uint32 used;
8797     struct {
8798         afs_uint32 start;
8799         afs_uint32 len;
8800     } queue_info[VLRU_QUEUE_INVALID];
8801     struct VLRUExtStatsEntry * vec;
8802 };
8803
8804 /**
8805  * add a 256-entry fudge factor onto the vector in case state changes
8806  * out from under us.
8807  */
8808 #define VLRU_EXT_STATS_VEC_LEN_FUDGE   256
8809
8810 /**
8811  * collect extended statistics for the VLRU subsystem.
8812  *
8813  * @param[out] stats  pointer to stats structure to be populated
8814  * @param[in] nvols   number of volumes currently known to exist
8815  *
8816  * @pre VOL_LOCK held
8817  *
8818  * @post stats->vec allocated and populated
8819  *
8820  * @return operation status
8821  *    @retval 0 success
8822  *    @retval 1 failure
8823  */
8824 static int
8825 VVLRUExtStats_r(struct VLRUExtStats * stats, afs_uint32 nvols)
8826 {
8827     afs_uint32 cur, idx, len;
8828     struct rx_queue * qp, * nqp;
8829     Volume * vp;
8830     struct VLRUExtStatsEntry * vec;
8831
8832     len = nvols + VLRU_EXT_STATS_VEC_LEN_FUDGE;
8833     vec = stats->vec = calloc(len,
8834                               sizeof(struct VLRUExtStatsEntry));
8835     if (vec == NULL) {
8836         return 1;
8837     }
8838
8839     cur = 0;
8840     for (idx = VLRU_QUEUE_NEW; idx < VLRU_QUEUE_INVALID; idx++) {
8841         VLRU_Wait_r(&volume_LRU.q[idx]);
8842         VLRU_BeginExclusive_r(&volume_LRU.q[idx]);
8843         VOL_UNLOCK;
8844
8845         stats->queue_info[idx].start = cur;
8846
8847         for (queue_Scan(&volume_LRU.q[idx], qp, nqp, rx_queue)) {
8848             if (cur == len) {
8849                 /* out of space in vec */
8850                 break;
8851             }
8852             vp = (Volume *)((char *)qp - offsetof(Volume, vlru));
8853             vec[cur].volid = vp->hashid;
8854             cur++;
8855         }
8856
8857         stats->queue_info[idx].len = cur - stats->queue_info[idx].start;
8858
8859         VOL_LOCK;
8860         VLRU_EndExclusive_r(&volume_LRU.q[idx]);
8861     }
8862
8863     stats->len = len;
8864     stats->used = cur;
8865     return 0;
8866 }
8867
8868 #define ENUMTOSTRING(en)  #en
8869 #define ENUMCASE(en) \
8870     case en: return ENUMTOSTRING(en)
8871
8872 static char *
8873 vlru_idx_to_string(int idx)
8874 {
8875     switch (idx) {
8876         ENUMCASE(VLRU_QUEUE_NEW);
8877         ENUMCASE(VLRU_QUEUE_MID);
8878         ENUMCASE(VLRU_QUEUE_OLD);
8879         ENUMCASE(VLRU_QUEUE_CANDIDATE);
8880         ENUMCASE(VLRU_QUEUE_HELD);
8881         ENUMCASE(VLRU_QUEUE_INVALID);
8882     default:
8883         return "**UNKNOWN**";
8884     }
8885 }
8886
8887 void
8888 VPrintExtendedCacheStats_r(int flags)
8889 {
8890     int i;
8891     afs_uint32 vol_sum = 0;
8892     struct stats {
8893         double min;
8894         double max;
8895         double sum;
8896         double avg;
8897     };
8898     struct stats looks, gets, reorders, len;
8899     struct stats ch_looks, ch_gets, ch_reorders;
8900     char pr_buf[4][32];
8901     VolumeHashChainHead *head;
8902     Volume *vp, *np;
8903     struct VLRUExtStats vlru_stats;
8904
8905     /* zero out stats */
8906     memset(&looks, 0, sizeof(struct stats));
8907     memset(&gets, 0, sizeof(struct stats));
8908     memset(&reorders, 0, sizeof(struct stats));
8909     memset(&len, 0, sizeof(struct stats));
8910     memset(&ch_looks, 0, sizeof(struct stats));
8911     memset(&ch_gets, 0, sizeof(struct stats));
8912     memset(&ch_reorders, 0, sizeof(struct stats));
8913
8914     for (i = 0; i < VolumeHashTable.Size; i++) {
8915         head = &VolumeHashTable.Table[i];
8916
8917         VHashWait_r(head);
8918         VHashBeginExclusive_r(head);
8919         VOL_UNLOCK;
8920
8921         ch_looks.sum    = UInt64ToDouble(&head->looks);
8922         ch_gets.sum     = UInt64ToDouble(&head->gets);
8923         ch_reorders.sum = UInt64ToDouble(&head->reorders);
8924
8925         /* update global statistics */
8926         {
8927             looks.sum    += ch_looks.sum;
8928             gets.sum     += ch_gets.sum;
8929             reorders.sum += ch_reorders.sum;
8930             len.sum      += (double)head->len;
8931             vol_sum      += head->len;
8932
8933             if (i == 0) {
8934                 len.min      = (double) head->len;
8935                 len.max      = (double) head->len;
8936                 looks.min    = ch_looks.sum;
8937                 looks.max    = ch_looks.sum;
8938                 gets.min     = ch_gets.sum;
8939                 gets.max     = ch_gets.sum;
8940                 reorders.min = ch_reorders.sum;
8941                 reorders.max = ch_reorders.sum;
8942             } else {
8943                 if (((double)head->len) < len.min)
8944                     len.min = (double) head->len;
8945                 if (((double)head->len) > len.max)
8946                     len.max = (double) head->len;
8947                 if (ch_looks.sum < looks.min)
8948                     looks.min = ch_looks.sum;
8949                 else if (ch_looks.sum > looks.max)
8950                     looks.max = ch_looks.sum;
8951                 if (ch_gets.sum < gets.min)
8952                     gets.min = ch_gets.sum;
8953                 else if (ch_gets.sum > gets.max)
8954                     gets.max = ch_gets.sum;
8955                 if (ch_reorders.sum < reorders.min)
8956                     reorders.min = ch_reorders.sum;
8957                 else if (ch_reorders.sum > reorders.max)
8958                     reorders.max = ch_reorders.sum;
8959             }
8960         }
8961
8962         if ((flags & VOL_STATS_PER_CHAIN2) && queue_IsNotEmpty(head)) {
8963             /* compute detailed per-chain stats */
8964             struct stats hdr_loads, hdr_gets;
8965             double v_looks, v_loads, v_gets;
8966
8967             /* initialize stats with data from first element in chain */
8968             vp = queue_First(head, Volume);
8969             v_looks = UInt64ToDouble(&vp->stats.hash_lookups);
8970             v_loads = UInt64ToDouble(&vp->stats.hdr_loads);
8971             v_gets  = UInt64ToDouble(&vp->stats.hdr_gets);
8972             ch_gets.min = ch_gets.max = v_looks;
8973             hdr_loads.min = hdr_loads.max = v_loads;
8974             hdr_gets.min = hdr_gets.max = v_gets;
8975             hdr_loads.sum = hdr_gets.sum = 0;
8976
8977             vp = queue_Next(vp, Volume);
8978
8979             /* pull in stats from remaining elements in chain */
8980             for (queue_ScanFrom(head, vp, vp, np, Volume)) {
8981                 v_looks = UInt64ToDouble(&vp->stats.hash_lookups);
8982                 v_loads = UInt64ToDouble(&vp->stats.hdr_loads);
8983                 v_gets  = UInt64ToDouble(&vp->stats.hdr_gets);
8984
8985                 hdr_loads.sum += v_loads;
8986                 hdr_gets.sum += v_gets;
8987
8988                 if (v_looks < ch_gets.min)
8989                     ch_gets.min = v_looks;
8990                 else if (v_looks > ch_gets.max)
8991                     ch_gets.max = v_looks;
8992
8993                 if (v_loads < hdr_loads.min)
8994                     hdr_loads.min = v_loads;
8995                 else if (v_loads > hdr_loads.max)
8996                     hdr_loads.max = v_loads;
8997
8998                 if (v_gets < hdr_gets.min)
8999                     hdr_gets.min = v_gets;
9000                 else if (v_gets > hdr_gets.max)
9001                     hdr_gets.max = v_gets;
9002             }
9003
9004             /* compute per-chain averages */
9005             ch_gets.avg = ch_gets.sum / ((double)head->len);
9006             hdr_loads.avg = hdr_loads.sum / ((double)head->len);
9007             hdr_gets.avg = hdr_gets.sum / ((double)head->len);
9008
9009             /* dump per-chain stats */
9010             Log("Volume hash chain %d : len=%d, looks=%s, reorders=%s\n",
9011                 i, head->len,
9012                 DoubleToPrintable(ch_looks.sum, pr_buf[0], sizeof(pr_buf[0])),
9013                 DoubleToPrintable(ch_reorders.sum, pr_buf[1], sizeof(pr_buf[1])));
9014             Log("\tVolume gets : min=%s, max=%s, avg=%s, total=%s\n",
9015                 DoubleToPrintable(ch_gets.min, pr_buf[0], sizeof(pr_buf[0])),
9016                 DoubleToPrintable(ch_gets.max, pr_buf[1], sizeof(pr_buf[1])),
9017                 DoubleToPrintable(ch_gets.avg, pr_buf[2], sizeof(pr_buf[2])),
9018                 DoubleToPrintable(ch_gets.sum, pr_buf[3], sizeof(pr_buf[3])));
9019             Log("\tHDR gets : min=%s, max=%s, avg=%s, total=%s\n",
9020                 DoubleToPrintable(hdr_gets.min, pr_buf[0], sizeof(pr_buf[0])),
9021                 DoubleToPrintable(hdr_gets.max, pr_buf[1], sizeof(pr_buf[1])),
9022                 DoubleToPrintable(hdr_gets.avg, pr_buf[2], sizeof(pr_buf[2])),
9023                 DoubleToPrintable(hdr_gets.sum, pr_buf[3], sizeof(pr_buf[3])));
9024             Log("\tHDR loads : min=%s, max=%s, avg=%s, total=%s\n",
9025                 DoubleToPrintable(hdr_loads.min, pr_buf[0], sizeof(pr_buf[0])),
9026                 DoubleToPrintable(hdr_loads.max, pr_buf[1], sizeof(pr_buf[1])),
9027                 DoubleToPrintable(hdr_loads.avg, pr_buf[2], sizeof(pr_buf[2])),
9028                 DoubleToPrintable(hdr_loads.sum, pr_buf[3], sizeof(pr_buf[3])));
9029         } else if (flags & VOL_STATS_PER_CHAIN) {
9030             /* dump simple per-chain stats */
9031             Log("Volume hash chain %d : len=%d, looks=%s, gets=%s, reorders=%s\n",
9032                 i, head->len,
9033                 DoubleToPrintable(ch_looks.sum, pr_buf[0], sizeof(pr_buf[0])),
9034                 DoubleToPrintable(ch_gets.sum, pr_buf[1], sizeof(pr_buf[1])),
9035                 DoubleToPrintable(ch_reorders.sum, pr_buf[2], sizeof(pr_buf[2])));
9036         }
9037
9038         VOL_LOCK;
9039         VHashEndExclusive_r(head);
9040     }
9041
9042     VOL_UNLOCK;
9043
9044     /* compute global averages */
9045     len.avg      = len.sum      / ((double)VolumeHashTable.Size);
9046     looks.avg    = looks.sum    / ((double)VolumeHashTable.Size);
9047     gets.avg     = gets.sum     / ((double)VolumeHashTable.Size);
9048     reorders.avg = reorders.sum / ((double)VolumeHashTable.Size);
9049
9050     /* dump global stats */
9051     Log("Volume hash summary: %d buckets\n", VolumeHashTable.Size);
9052     Log(" chain length : min=%s, max=%s, avg=%s, total=%s\n",
9053         DoubleToPrintable(len.min, pr_buf[0], sizeof(pr_buf[0])),
9054         DoubleToPrintable(len.max, pr_buf[1], sizeof(pr_buf[1])),
9055         DoubleToPrintable(len.avg, pr_buf[2], sizeof(pr_buf[2])),
9056         DoubleToPrintable(len.sum, pr_buf[3], sizeof(pr_buf[3])));
9057     Log(" looks : min=%s, max=%s, avg=%s, total=%s\n",
9058         DoubleToPrintable(looks.min, pr_buf[0], sizeof(pr_buf[0])),
9059         DoubleToPrintable(looks.max, pr_buf[1], sizeof(pr_buf[1])),
9060         DoubleToPrintable(looks.avg, pr_buf[2], sizeof(pr_buf[2])),
9061         DoubleToPrintable(looks.sum, pr_buf[3], sizeof(pr_buf[3])));
9062     Log(" gets : min=%s, max=%s, avg=%s, total=%s\n",
9063         DoubleToPrintable(gets.min, pr_buf[0], sizeof(pr_buf[0])),
9064         DoubleToPrintable(gets.max, pr_buf[1], sizeof(pr_buf[1])),
9065         DoubleToPrintable(gets.avg, pr_buf[2], sizeof(pr_buf[2])),
9066         DoubleToPrintable(gets.sum, pr_buf[3], sizeof(pr_buf[3])));
9067     Log(" reorders : min=%s, max=%s, avg=%s, total=%s\n",
9068         DoubleToPrintable(reorders.min, pr_buf[0], sizeof(pr_buf[0])),
9069         DoubleToPrintable(reorders.max, pr_buf[1], sizeof(pr_buf[1])),
9070         DoubleToPrintable(reorders.avg, pr_buf[2], sizeof(pr_buf[2])),
9071         DoubleToPrintable(reorders.sum, pr_buf[3], sizeof(pr_buf[3])));
9072
9073     /* print extended disk related statistics */
9074     {
9075         struct DiskPartition64 * diskP;
9076         afs_uint32 vol_count[VOLMAXPARTS+1];
9077         byte part_exists[VOLMAXPARTS+1];
9078         Device id;
9079         int i;
9080
9081         memset(vol_count, 0, sizeof(vol_count));
9082         memset(part_exists, 0, sizeof(part_exists));
9083
9084         VOL_LOCK;
9085
9086         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
9087             id = diskP->index;
9088             vol_count[id] = diskP->vol_list.len;
9089             part_exists[id] = 1;
9090         }
9091
9092         VOL_UNLOCK;
9093         for (i = 0; i <= VOLMAXPARTS; i++) {
9094             if (part_exists[i]) {
9095                 /* XXX while this is currently safe, it is a violation
9096                  *     of the VGetPartitionById_r interface contract. */
9097                 diskP = VGetPartitionById_r(i, 0);
9098                 if (diskP) {
9099                     Log("Partition %s has %d online volumes\n",
9100                         VPartitionPath(diskP), diskP->vol_list.len);
9101                 }
9102             }
9103         }
9104         VOL_LOCK;
9105     }
9106
9107     /* print extended VLRU statistics */
9108     if (VVLRUExtStats_r(&vlru_stats, vol_sum) == 0) {
9109         afs_uint32 idx, cur, lpos;
9110         VolumeId line[5];
9111
9112         VOL_UNLOCK;
9113
9114         Log("VLRU State Dump:\n\n");
9115
9116         for (idx = VLRU_QUEUE_NEW; idx < VLRU_QUEUE_INVALID; idx++) {
9117             Log("\t%s:\n", vlru_idx_to_string(idx));
9118
9119             lpos = 0;
9120             for (cur = vlru_stats.queue_info[idx].start;
9121                  cur < vlru_stats.queue_info[idx].len;
9122                  cur++) {
9123                 line[lpos++] = vlru_stats.vec[cur].volid;
9124                 if (lpos==5) {
9125                     Log("\t\t%u, %u, %u, %u, %u,\n",
9126                         line[0], line[1], line[2], line[3], line[4]);
9127                     lpos = 0;
9128                 }
9129             }
9130
9131             if (lpos) {
9132                 while (lpos < 5) {
9133                     line[lpos++] = 0;
9134                 }
9135                 Log("\t\t%u, %u, %u, %u, %u\n",
9136                     line[0], line[1], line[2], line[3], line[4]);
9137             }
9138             Log("\n");
9139         }
9140
9141         free(vlru_stats.vec);
9142
9143         VOL_LOCK;
9144     }
9145 }
9146
9147 void
9148 VPrintExtendedCacheStats(int flags)
9149 {
9150     VOL_LOCK;
9151     VPrintExtendedCacheStats_r(flags);
9152     VOL_UNLOCK;
9153 }
9154 #endif /* AFS_DEMAND_ATTACH_FS */
9155
9156 afs_int32
9157 VCanScheduleSalvage(void)
9158 {
9159     return vol_opts.canScheduleSalvage;
9160 }
9161
9162 afs_int32
9163 VCanUseFSSYNC(void)
9164 {
9165     return vol_opts.canUseFSSYNC;
9166 }
9167
9168 afs_int32
9169 VCanUseSALVSYNC(void)
9170 {
9171     return vol_opts.canUseSALVSYNC;
9172 }
9173
9174 afs_int32
9175 VCanUnsafeAttach(void)
9176 {
9177     return vol_opts.unsafe_attach;
9178 }