src/vol/volume.c

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