1217ec6149d188f10f9ddfb21f99ffdd1251e65a
[openafs.git] / src / vol / volume.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  *
9  * Portions Copyright (c) 2005-2008 Sine Nomine Associates
10  */
11
12 /* 1/1/89: NB:  this stuff is all going to be replaced.  Don't take it too seriously */
13 /*
14
15         System:         VICE-TWO
16         Module:         volume.c
17         Institution:    The Information Technology Center, Carnegie-Mellon University
18
19  */
20
21 #include <afsconfig.h>
22 #include <afs/param.h>
23
24 #include <roken.h>
25
26 #include <rx/xdr.h>
27 #include <afs/afsint.h>
28 #include <ctype.h>
29 #include <signal.h>
30 #ifndef AFS_NT40_ENV
31 #include <sys/param.h>
32 #if !defined(AFS_SGI_ENV)
33 #ifdef  AFS_OSF_ENV
34 #include <ufs/fs.h>
35 #else /* AFS_OSF_ENV */
36 #ifdef AFS_VFSINCL_ENV
37 #define VFS
38 #ifdef  AFS_SUN5_ENV
39 #include <sys/fs/ufs_fs.h>
40 #else
41 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
42 #include <ufs/ufs/dinode.h>
43 #include <ufs/ffs/fs.h>
44 #else
45 #include <ufs/fs.h>
46 #endif
47 #endif
48 #else /* AFS_VFSINCL_ENV */
49 #if !defined(AFS_AIX_ENV) && !defined(AFS_LINUX20_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_ARM_DARWIN_ENV)
50 #include <sys/fs.h>
51 #endif
52 #endif /* AFS_VFSINCL_ENV */
53 #endif /* AFS_OSF_ENV */
54 #endif /* AFS_SGI_ENV */
55 #endif /* AFS_NT40_ENV */
56 #include <errno.h>
57 #include <sys/stat.h>
58 #include <stdio.h>
59 #ifdef AFS_NT40_ENV
60 #include <fcntl.h>
61 #else
62 #include <sys/file.h>
63 #endif
64 #include <dirent.h>
65 #ifdef  AFS_AIX_ENV
66 #include <sys/vfs.h>
67 #include <fcntl.h>
68 #else
69 #ifdef  AFS_HPUX_ENV
70 #include <fcntl.h>
71 #include <mntent.h>
72 #else
73 #if     defined(AFS_SUN_ENV) || defined(AFS_SUN5_ENV)
74 #ifdef  AFS_SUN5_ENV
75 #include <sys/mnttab.h>
76 #include <sys/mntent.h>
77 #else
78 #include <mntent.h>
79 #endif
80 #else
81 #ifndef AFS_NT40_ENV
82 #if defined(AFS_SGI_ENV)
83 #include <fcntl.h>
84 #include <mntent.h>
85
86 #else
87 #ifndef AFS_LINUX20_ENV
88 #include <fstab.h>              /* Need to find in libc 5, present in libc 6 */
89 #endif
90 #endif
91 #endif /* AFS_SGI_ENV */
92 #endif
93 #endif /* AFS_HPUX_ENV */
94 #endif
95 #ifndef AFS_NT40_ENV
96 #include <netdb.h>
97 #include <netinet/in.h>
98 #include <sys/wait.h>
99 #include <setjmp.h>
100 #ifndef ITIMER_REAL
101 #include <sys/time.h>
102 #endif /* ITIMER_REAL */
103 #endif /* AFS_NT40_ENV */
104 #if defined(AFS_SUN5_ENV) || defined(AFS_NT40_ENV) || defined(AFS_LINUX20_ENV)
105 #include <string.h>
106 #else
107 #include <strings.h>
108 #endif
109
110 #include "nfs.h"
111 #include <afs/errors.h>
112 #include "lock.h"
113 #include "lwp.h"
114 #include <afs/afssyscalls.h>
115 #include "ihandle.h"
116 #include <afs/afsutil.h>
117 #ifdef AFS_NT40_ENV
118 #include <io.h>
119 #endif
120 #include "daemon_com.h"
121 #include "fssync.h"
122 #include "salvsync.h"
123 #include "vnode.h"
124 #include "volume.h"
125 #include "partition.h"
126 #include "volume_inline.h"
127 #include "common.h"
128 #include "afs/afs_assert.h"
129 #include "vutils.h"
130 #ifndef AFS_NT40_ENV
131 #include <afs/dir.h>
132 #include <unistd.h>
133 #endif
134
135 #if !defined(offsetof)
136 #include <stddef.h>
137 #endif
138
139 #ifdef O_LARGEFILE
140 #define afs_stat        stat64
141 #define afs_fstat       fstat64
142 #define afs_open        open64
143 #else /* !O_LARGEFILE */
144 #define afs_stat        stat
145 #define afs_fstat       fstat
146 #define afs_open        open
147 #endif /* !O_LARGEFILE */
148
149 #ifdef AFS_PTHREAD_ENV
150 pthread_mutex_t vol_glock_mutex;
151 pthread_mutex_t vol_trans_mutex;
152 pthread_cond_t vol_put_volume_cond;
153 pthread_cond_t vol_sleep_cond;
154 pthread_cond_t vol_init_attach_cond;
155 pthread_cond_t vol_vinit_cond;
156 int vol_attach_threads = 1;
157 #endif /* AFS_PTHREAD_ENV */
158
159 /* start-time configurable I/O parameters */
160 ih_init_params vol_io_params;
161
162 #ifdef AFS_DEMAND_ATTACH_FS
163 pthread_mutex_t vol_salvsync_mutex;
164
165 /*
166  * Set this to 1 to disallow SALVSYNC communication in all threads; used
167  * during shutdown, since the salvageserver may have gone away.
168  */
169 static volatile sig_atomic_t vol_disallow_salvsync = 0;
170 #endif /* AFS_DEMAND_ATTACH_FS */
171
172 /**
173  * has VShutdown_r been called / is VShutdown_r running?
174  */
175 static int vol_shutting_down = 0;
176
177 #ifdef  AFS_OSF_ENV
178 extern void *calloc(), *realloc();
179 #endif
180
181 /* Forward declarations */
182 static Volume *attach2(Error * ec, VolId volumeId, char *path,
183                        struct DiskPartition64 *partp, Volume * vp,
184                        int isbusy, int mode, int *acheckedOut);
185 static void ReallyFreeVolume(Volume * vp);
186 #ifdef AFS_DEMAND_ATTACH_FS
187 static void FreeVolume(Volume * vp);
188 #else /* !AFS_DEMAND_ATTACH_FS */
189 #define FreeVolume(vp) ReallyFreeVolume(vp)
190 static void VScanUpdateList(void);
191 #endif /* !AFS_DEMAND_ATTACH_FS */
192 static void VInitVolumeHeaderCache(afs_uint32 howMany);
193 static int GetVolumeHeader(Volume * vp);
194 static void ReleaseVolumeHeader(struct volHeader *hd);
195 static void FreeVolumeHeader(Volume * vp);
196 static void AddVolumeToHashTable(Volume * vp, int hashid);
197 static void DeleteVolumeFromHashTable(Volume * vp);
198 #if 0
199 static int VHold(Volume * vp);
200 #endif
201 static int VHold_r(Volume * vp);
202 static void VGetBitmap_r(Error * ec, Volume * vp, VnodeClass class);
203 static void VReleaseVolumeHandles_r(Volume * vp);
204 static void VCloseVolumeHandles_r(Volume * vp);
205 static void LoadVolumeHeader(Error * ec, Volume * vp);
206 static int VCheckOffline(Volume * vp);
207 static int VCheckDetach(Volume * vp);
208 static Volume * GetVolume(Error * ec, Error * client_ec, VolId volumeId,
209                           Volume * hint, const struct timespec *ts);
210
211 int LogLevel;                   /* Vice loglevel--not defined as extern so that it will be
212                                  * defined when not linked with vice, XXXX */
213 ProgramType programType;        /* The type of program using the package */
214 static VolumePackageOptions vol_opts;
215
216 /* extended volume package statistics */
217 VolPkgStats VStats;
218
219 #ifdef VOL_LOCK_DEBUG
220 pthread_t vol_glock_holder = 0;
221 #endif
222
223
224 #define VOLUME_BITMAP_GROWSIZE  16      /* bytes, => 128vnodes */
225                                         /* Must be a multiple of 4 (1 word) !! */
226
227 /* this parameter needs to be tunable at runtime.
228  * 128 was really inadequate for largish servers -- at 16384 volumes this
229  * puts average chain length at 128, thus an average 65 deref's to find a volptr.
230  * talk about bad spatial locality...
231  *
232  * an AVL or splay tree might work a lot better, but we'll just increase
233  * the default hash table size for now
234  */
235 #define DEFAULT_VOLUME_HASH_SIZE 256   /* Must be a power of 2!! */
236 #define DEFAULT_VOLUME_HASH_MASK (DEFAULT_VOLUME_HASH_SIZE-1)
237 #define VOLUME_HASH(volumeId) (volumeId&(VolumeHashTable.Mask))
238
239 /*
240  * turn volume hash chains into partially ordered lists.
241  * when the threshold is exceeded between two adjacent elements,
242  * perform a chain rebalancing operation.
243  *
244  * keep the threshold high in order to keep cache line invalidates
245  * low "enough" on SMPs
246  */
247 #define VOLUME_HASH_REORDER_THRESHOLD 200
248
249 /*
250  * when possible, don't just reorder single elements, but reorder
251  * entire chains of elements at once.  a chain of elements that
252  * exceed the element previous to the pivot by at least CHAIN_THRESH
253  * accesses are moved in front of the chain whose elements have at
254  * least CHAIN_THRESH less accesses than the pivot element
255  */
256 #define VOLUME_HASH_REORDER_CHAIN_THRESH (VOLUME_HASH_REORDER_THRESHOLD / 2)
257
258 #include "rx/rx_queue.h"
259
260
261 VolumeHashTable_t VolumeHashTable = {
262     DEFAULT_VOLUME_HASH_SIZE,
263     DEFAULT_VOLUME_HASH_MASK,
264     NULL
265 };
266
267
268 static void VInitVolumeHash(void);
269
270
271 #ifndef AFS_HAVE_FFS
272 /* This macro is used where an ffs() call does not exist. Was in util/ffs.c */
273 ffs(x)
274 {
275     afs_int32 ffs_i;
276     afs_int32 ffs_tmp = x;
277     if (ffs_tmp == 0)
278         return (-1);
279     else
280         for (ffs_i = 1;; ffs_i++) {
281             if (ffs_tmp & 1)
282                 return (ffs_i);
283             else
284                 ffs_tmp >>= 1;
285         }
286 }
287 #endif /* !AFS_HAVE_FFS */
288
289 #ifdef AFS_PTHREAD_ENV
290 /**
291  * disk partition queue element
292  */
293 typedef struct diskpartition_queue_t {
294     struct rx_queue queue;             /**< queue header */
295     struct DiskPartition64 *diskP;     /**< disk partition table entry */
296 } diskpartition_queue_t;
297
298 #ifndef AFS_DEMAND_ATTACH_FS
299
300 typedef struct vinitvolumepackage_thread_t {
301     struct rx_queue queue;
302     pthread_cond_t thread_done_cv;
303     int n_threads_complete;
304 } vinitvolumepackage_thread_t;
305 static void * VInitVolumePackageThread(void * args);
306
307 #else  /* !AFS_DEMAND_ATTTACH_FS */
308 #define VINIT_BATCH_MAX_SIZE 512
309
310 /**
311  * disk partition work queue
312  */
313 struct partition_queue {
314     struct rx_queue head;              /**< diskpartition_queue_t queue */
315     pthread_mutex_t mutex;
316     pthread_cond_t cv;
317 };
318
319 /**
320  * volumes parameters for preattach
321  */
322 struct volume_init_batch {
323     struct rx_queue queue;               /**< queue header */
324     int thread;                          /**< posting worker thread */
325     int last;                            /**< indicates thread is done */
326     int size;                            /**< number of volume ids in batch */
327     Volume *batch[VINIT_BATCH_MAX_SIZE]; /**< volumes ids to preattach */
328 };
329
330 /**
331  * volume parameters work queue
332  */
333 struct volume_init_queue {
334     struct rx_queue head;                /**< volume_init_batch queue */
335     pthread_mutex_t mutex;
336     pthread_cond_t cv;
337 };
338
339 /**
340  * volume init worker thread parameters
341  */
342 struct vinitvolumepackage_thread_param {
343     int nthreads;                        /**< total number of worker threads */
344     int thread;                          /**< thread number for this worker thread */
345     struct partition_queue *pq;          /**< queue partitions to scan */
346     struct volume_init_queue *vq;        /**< queue of volume to preattach */
347 };
348
349 static void *VInitVolumePackageThread(void *args);
350 static struct DiskPartition64 *VInitNextPartition(struct partition_queue *pq);
351 static VolId VInitNextVolumeId(DIR *dirp);
352 static int VInitPreAttachVolumes(int nthreads, struct volume_init_queue *vq);
353
354 #endif /* !AFS_DEMAND_ATTACH_FS */
355 #endif /* AFS_PTHREAD_ENV */
356
357 #ifndef AFS_DEMAND_ATTACH_FS
358 static int VAttachVolumesByPartition(struct DiskPartition64 *diskP,
359                                      int * nAttached, int * nUnattached);
360 #endif /* AFS_DEMAND_ATTACH_FS */
361
362
363 #ifdef AFS_DEMAND_ATTACH_FS
364 /* demand attach fileserver extensions */
365
366 /* XXX
367  * in the future we will support serialization of VLRU state into the fs_state
368  * disk dumps
369  *
370  * these structures are the beginning of that effort
371  */
372 struct VLRU_DiskHeader {
373     struct versionStamp stamp;            /* magic and structure version number */
374     afs_uint32 mtime;                     /* time of dump to disk */
375     afs_uint32 num_records;               /* number of VLRU_DiskEntry records */
376 };
377
378 struct VLRU_DiskEntry {
379     afs_uint32 vid;                       /* volume ID */
380     afs_uint32 idx;                       /* generation */
381     afs_uint32 last_get;                  /* timestamp of last get */
382 };
383
384 struct VLRU_StartupQueue {
385     struct VLRU_DiskEntry * entry;
386     int num_entries;
387     int next_idx;
388 };
389
390 typedef struct vshutdown_thread_t {
391     struct rx_queue q;
392     pthread_mutex_t lock;
393     pthread_cond_t cv;
394     pthread_cond_t master_cv;
395     int n_threads;
396     int n_threads_complete;
397     int vol_remaining;
398     int schedule_version;
399     int pass;
400     byte n_parts;
401     byte n_parts_done_pass;
402     byte part_thread_target[VOLMAXPARTS+1];
403     byte part_done_pass[VOLMAXPARTS+1];
404     struct rx_queue * part_pass_head[VOLMAXPARTS+1];
405     int stats[4][VOLMAXPARTS+1];
406 } vshutdown_thread_t;
407 static void * VShutdownThread(void * args);
408
409
410 static Volume * VAttachVolumeByVp_r(Error * ec, Volume * vp, int mode);
411 static int VCheckFree(Volume * vp);
412
413 /* VByP List */
414 static void AddVolumeToVByPList_r(Volume * vp);
415 static void DeleteVolumeFromVByPList_r(Volume * vp);
416 static void VVByPListBeginExclusive_r(struct DiskPartition64 * dp);
417 static void VVByPListEndExclusive_r(struct DiskPartition64 * dp);
418 static void VVByPListWait_r(struct DiskPartition64 * dp);
419
420 /* online salvager */
421 static int VCheckSalvage(Volume * vp);
422 #if defined(SALVSYNC_BUILD_CLIENT) || defined(FSSYNC_BUILD_CLIENT)
423 static int VScheduleSalvage_r(Volume * vp);
424 #endif
425
426 /* Volume hash table */
427 static void VReorderHash_r(VolumeHashChainHead * head, Volume * pp, Volume * vp);
428 static void VHashBeginExclusive_r(VolumeHashChainHead * head);
429 static void VHashEndExclusive_r(VolumeHashChainHead * head);
430 static void VHashWait_r(VolumeHashChainHead * head);
431
432 /* shutdown */
433 static int ShutdownVByPForPass_r(struct DiskPartition64 * dp, int pass);
434 static int ShutdownVolumeWalk_r(struct DiskPartition64 * dp, int pass,
435                                 struct rx_queue ** idx);
436 static void ShutdownController(vshutdown_thread_t * params);
437 static void ShutdownCreateSchedule(vshutdown_thread_t * params);
438
439 /* VLRU */
440 static void VLRU_ComputeConstants(void);
441 static void VInitVLRU(void);
442 static void VLRU_Init_Node_r(Volume * vp);
443 static void VLRU_Add_r(Volume * vp);
444 static void VLRU_Delete_r(Volume * vp);
445 static void VLRU_UpdateAccess_r(Volume * vp);
446 static void * VLRU_ScannerThread(void * args);
447 static void VLRU_Scan_r(int idx);
448 static void VLRU_Promote_r(int idx);
449 static void VLRU_Demote_r(int idx);
450 static void VLRU_SwitchQueues(Volume * vp, int new_idx, int append);
451
452 /* soft detach */
453 static int VCheckSoftDetach(Volume * vp, afs_uint32 thresh);
454 static int VCheckSoftDetachCandidate(Volume * vp, afs_uint32 thresh);
455 static int VSoftDetachVolume_r(Volume * vp, afs_uint32 thresh);
456
457
458 pthread_key_t VThread_key;
459 VThreadOptions_t VThread_defaults = {
460     0                           /**< allow salvsync */
461 };
462 #endif /* AFS_DEMAND_ATTACH_FS */
463
464
465 struct Lock vol_listLock;       /* Lock obtained when listing volumes:
466                                  * prevents a volume from being missed
467                                  * if the volume is attached during a
468                                  * list volumes */
469
470
471 /* Common message used when the volume goes off line */
472 char *VSalvageMessage =
473     "Files in this volume are currently unavailable; call operations";
474
475 int VInit;                      /* 0 - uninitialized,
476                                  * 1 - initialized but not all volumes have been attached,
477                                  * 2 - initialized and all volumes have been attached,
478                                  * 3 - initialized, all volumes have been attached, and
479                                  * VConnectFS() has completed. */
480
481 static int vinit_attach_abort = 0;
482
483 bit32 VolumeCacheCheck;         /* Incremented everytime a volume goes on line--
484                                  * used to stamp volume headers and in-core
485                                  * vnodes.  When the volume goes on-line the
486                                  * vnode will be invalidated
487                                  * access only with VOL_LOCK held */
488
489
490
491
492 /***************************************************/
493 /* Startup routines                                */
494 /***************************************************/
495
496 #if defined(FAST_RESTART) && defined(AFS_DEMAND_ATTACH_FS)
497 # error FAST_RESTART and DAFS are incompatible. For the DAFS equivalent \
498         of FAST_RESTART, use the -unsafe-nosalvage fileserver argument
499 #endif
500
501 /**
502  * assign default values to a VolumePackageOptions struct.
503  *
504  * Always call this on a VolumePackageOptions struct first, then set any
505  * specific options you want, then call VInitVolumePackage2.
506  *
507  * @param[in]  pt   caller's program type
508  * @param[out] opts volume package options
509  */
510 void
511 VOptDefaults(ProgramType pt, VolumePackageOptions *opts)
512 {
513     opts->nLargeVnodes = opts->nSmallVnodes = 5;
514     opts->volcache = 0;
515
516     opts->canScheduleSalvage = 0;
517     opts->canUseFSSYNC = 0;
518     opts->canUseSALVSYNC = 0;
519
520     opts->interrupt_rxcall = NULL;
521     opts->offline_timeout = -1;
522     opts->offline_shutdown_timeout = -1;
523
524 #ifdef FAST_RESTART
525     opts->unsafe_attach = 1;
526 #else /* !FAST_RESTART */
527     opts->unsafe_attach = 0;
528 #endif /* !FAST_RESTART */
529
530     switch (pt) {
531     case fileServer:
532         opts->canScheduleSalvage = 1;
533         opts->canUseSALVSYNC = 1;
534         break;
535
536     case salvageServer:
537         opts->canUseFSSYNC = 1;
538         break;
539
540     case volumeServer:
541         opts->nLargeVnodes = 0;
542         opts->nSmallVnodes = 0;
543
544         opts->canScheduleSalvage = 1;
545         opts->canUseFSSYNC = 1;
546         break;
547
548     default:
549         /* noop */
550         break;
551     }
552 }
553
554 /**
555  * Set VInit to a certain value, and signal waiters.
556  *
557  * @param[in] value  the value to set VInit to
558  *
559  * @pre VOL_LOCK held
560  */
561 static void
562 VSetVInit_r(int value)
563 {
564     VInit = value;
565     CV_BROADCAST(&vol_vinit_cond);
566 }
567
568 static_inline void
569 VLogOfflineTimeout(const char *type, afs_int32 timeout)
570 {
571     if (timeout < 0) {
572         return;
573     }
574     if (timeout == 0) {
575         Log("VInitVolumePackage: Interrupting clients accessing %s "
576             "immediately\n", type);
577     } else {
578         Log("VInitVolumePackage: Interrupting clients accessing %s "
579             "after %ld second%s\n", type, (long)timeout, timeout==1?"":"s");
580     }
581 }
582
583 int
584 VInitVolumePackage2(ProgramType pt, VolumePackageOptions * opts)
585 {
586     int errors = 0;             /* Number of errors while finding vice partitions. */
587
588     programType = pt;
589     vol_opts = *opts;
590
591 #ifndef AFS_PTHREAD_ENV
592     if (opts->offline_timeout != -1 || opts->offline_shutdown_timeout != -1) {
593         Log("VInitVolumePackage: offline_timeout and/or "
594             "offline_shutdown_timeout was specified, but the volume package "
595             "does not support these for LWP builds\n");
596         return -1;
597     }
598 #endif
599     VLogOfflineTimeout("volumes going offline", opts->offline_timeout);
600     VLogOfflineTimeout("volumes going offline during shutdown",
601                        opts->offline_shutdown_timeout);
602
603     memset(&VStats, 0, sizeof(VStats));
604     VStats.hdr_cache_size = 200;
605
606     VInitPartitionPackage();
607     VInitVolumeHash();
608 #ifdef AFS_DEMAND_ATTACH_FS
609     if (programType == fileServer) {
610         VInitVLRU();
611     } else {
612         VLRU_SetOptions(VLRU_SET_ENABLED, 0);
613     }
614     osi_Assert(pthread_key_create(&VThread_key, NULL) == 0);
615 #endif
616
617     MUTEX_INIT(&vol_glock_mutex, "vol glock", MUTEX_DEFAULT, 0);
618     MUTEX_INIT(&vol_trans_mutex, "vol trans", MUTEX_DEFAULT, 0);
619     CV_INIT(&vol_put_volume_cond, "vol put", CV_DEFAULT, 0);
620     CV_INIT(&vol_sleep_cond, "vol sleep", CV_DEFAULT, 0);
621     CV_INIT(&vol_init_attach_cond, "vol init attach", CV_DEFAULT, 0);
622     CV_INIT(&vol_vinit_cond, "vol init", CV_DEFAULT, 0);
623 #ifndef AFS_PTHREAD_ENV
624     IOMGR_Initialize();
625 #endif /* AFS_PTHREAD_ENV */
626     Lock_Init(&vol_listLock);
627
628     srandom(time(0));           /* For VGetVolumeInfo */
629
630 #ifdef AFS_DEMAND_ATTACH_FS
631     MUTEX_INIT(&vol_salvsync_mutex, "salvsync", MUTEX_DEFAULT, 0);
632 #endif /* AFS_DEMAND_ATTACH_FS */
633
634     /* Ok, we have done enough initialization that fileserver can
635      * start accepting calls, even though the volumes may not be
636      * available just yet.
637      */
638     VInit = 1;
639
640 #if defined(AFS_DEMAND_ATTACH_FS) && defined(SALVSYNC_BUILD_SERVER)
641     if (programType == salvageServer) {
642         SALVSYNC_salvInit();
643     }
644 #endif /* AFS_DEMAND_ATTACH_FS */
645 #ifdef FSSYNC_BUILD_SERVER
646     if (programType == fileServer) {
647         FSYNC_fsInit();
648     }
649 #endif
650 #if defined(AFS_DEMAND_ATTACH_FS) && defined(SALVSYNC_BUILD_CLIENT)
651     if (VCanUseSALVSYNC()) {
652         /* establish a connection to the salvager at this point */
653         osi_Assert(VConnectSALV() != 0);
654     }
655 #endif /* AFS_DEMAND_ATTACH_FS */
656
657     if (opts->volcache > VStats.hdr_cache_size)
658         VStats.hdr_cache_size = opts->volcache;
659     VInitVolumeHeaderCache(VStats.hdr_cache_size);
660
661     VInitVnodes(vLarge, opts->nLargeVnodes);
662     VInitVnodes(vSmall, opts->nSmallVnodes);
663
664
665     errors = VAttachPartitions();
666     if (errors)
667         return -1;
668
669     if (programType != fileServer) {
670         errors = VInitAttachVolumes(programType);
671         if (errors) {
672             return -1;
673         }
674     }
675
676 #ifdef FSSYNC_BUILD_CLIENT
677     if (VCanUseFSSYNC()) {
678         if (!VConnectFS()) {
679 #ifdef AFS_DEMAND_ATTACH_FS
680             if (programType == salvageServer) {
681                 Log("Unable to connect to file server; aborted\n");
682                 exit(1);
683             }
684 #endif /* AFS_DEMAND_ATTACH_FS */
685             Log("Unable to connect to file server; will retry at need\n");
686         }
687     }
688 #endif /* FSSYNC_BUILD_CLIENT */
689     return 0;
690 }
691
692
693 #if !defined(AFS_PTHREAD_ENV)
694 /**
695  * Attach volumes in vice partitions
696  *
697  * @param[in]  pt         calling program type
698  *
699  * @return 0
700  * @note This is the original, non-threaded version of attach parititions.
701  *
702  * @post VInit state is 2
703  */
704 int
705 VInitAttachVolumes(ProgramType pt)
706 {
707     osi_Assert(VInit==1);
708     if (pt == fileServer) {
709         struct DiskPartition64 *diskP;
710         /* Attach all the volumes in this partition */
711         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
712             int nAttached = 0, nUnattached = 0;
713             osi_Assert(VAttachVolumesByPartition(diskP, &nAttached, &nUnattached) == 0);
714         }
715     }
716     VOL_LOCK;
717     VSetVInit_r(2);                     /* Initialized, and all volumes have been attached */
718     LWP_NoYieldSignal(VInitAttachVolumes);
719     VOL_UNLOCK;
720     return 0;
721 }
722 #endif /* !AFS_PTHREAD_ENV */
723
724 #if defined(AFS_PTHREAD_ENV) && !defined(AFS_DEMAND_ATTACH_FS)
725 /**
726  * Attach volumes in vice partitions
727  *
728  * @param[in]  pt         calling program type
729  *
730  * @return 0
731  * @note Threaded version of attach parititions.
732  *
733  * @post VInit state is 2
734  */
735 int
736 VInitAttachVolumes(ProgramType pt)
737 {
738     osi_Assert(VInit==1);
739     if (pt == fileServer) {
740         struct DiskPartition64 *diskP;
741         struct vinitvolumepackage_thread_t params;
742         struct diskpartition_queue_t * dpq;
743         int i, threads, parts;
744         pthread_t tid;
745         pthread_attr_t attrs;
746
747         CV_INIT(&params.thread_done_cv, "thread done", CV_DEFAULT, 0);
748         queue_Init(&params);
749         params.n_threads_complete = 0;
750
751         /* create partition work queue */
752         for (parts=0, diskP = DiskPartitionList; diskP; diskP = diskP->next, parts++) {
753             dpq = (diskpartition_queue_t *) malloc(sizeof(struct diskpartition_queue_t));
754             osi_Assert(dpq != NULL);
755             dpq->diskP = diskP;
756             queue_Append(&params,dpq);
757         }
758
759         threads = MIN(parts, vol_attach_threads);
760
761         if (threads > 1) {
762             /* spawn off a bunch of initialization threads */
763             osi_Assert(pthread_attr_init(&attrs) == 0);
764             osi_Assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
765
766             Log("VInitVolumePackage: beginning parallel fileserver startup\n");
767             Log("VInitVolumePackage: using %d threads to attach volumes on %d partitions\n",
768                 threads, parts);
769
770             VOL_LOCK;
771             for (i=0; i < threads; i++) {
772                 AFS_SIGSET_DECL;
773                 AFS_SIGSET_CLEAR();
774                 osi_Assert(pthread_create
775                        (&tid, &attrs, &VInitVolumePackageThread,
776                         &params) == 0);
777                 AFS_SIGSET_RESTORE();
778             }
779
780             while(params.n_threads_complete < threads) {
781                 VOL_CV_WAIT(&params.thread_done_cv);
782             }
783             VOL_UNLOCK;
784
785             osi_Assert(pthread_attr_destroy(&attrs) == 0);
786         } else {
787             /* if we're only going to run one init thread, don't bother creating
788              * another LWP */
789             Log("VInitVolumePackage: beginning single-threaded fileserver startup\n");
790             Log("VInitVolumePackage: using 1 thread to attach volumes on %d partition(s)\n",
791                 parts);
792
793             VInitVolumePackageThread(&params);
794         }
795
796         CV_DESTROY(&params.thread_done_cv);
797     }
798     VOL_LOCK;
799     VSetVInit_r(2);                     /* Initialized, and all volumes have been attached */
800     CV_BROADCAST(&vol_init_attach_cond);
801     VOL_UNLOCK;
802     return 0;
803 }
804
805 static void *
806 VInitVolumePackageThread(void * args) {
807
808     struct DiskPartition64 *diskP;
809     struct vinitvolumepackage_thread_t * params;
810     struct diskpartition_queue_t * dpq;
811
812     params = (vinitvolumepackage_thread_t *) args;
813
814
815     VOL_LOCK;
816     /* Attach all the volumes in this partition */
817     while (queue_IsNotEmpty(params)) {
818         int nAttached = 0, nUnattached = 0;
819
820         if (vinit_attach_abort) {
821             Log("Aborting initialization\n");
822             goto done;
823         }
824
825         dpq = queue_First(params,diskpartition_queue_t);
826         queue_Remove(dpq);
827         VOL_UNLOCK;
828         diskP = dpq->diskP;
829         free(dpq);
830
831         osi_Assert(VAttachVolumesByPartition(diskP, &nAttached, &nUnattached) == 0);
832
833         VOL_LOCK;
834     }
835
836 done:
837     params->n_threads_complete++;
838     CV_SIGNAL(&params->thread_done_cv);
839     VOL_UNLOCK;
840     return NULL;
841 }
842 #endif /* AFS_PTHREAD_ENV && !AFS_DEMAND_ATTACH_FS */
843
844 #if defined(AFS_DEMAND_ATTACH_FS)
845 /**
846  * Attach volumes in vice partitions
847  *
848  * @param[in]  pt         calling program type
849  *
850  * @return 0
851  * @note Threaded version of attach partitions.
852  *
853  * @post VInit state is 2
854  */
855 int
856 VInitAttachVolumes(ProgramType pt)
857 {
858     osi_Assert(VInit==1);
859     if (pt == fileServer) {
860
861         struct DiskPartition64 *diskP;
862         struct partition_queue pq;
863         struct volume_init_queue vq;
864
865         int i, threads, parts;
866         pthread_t tid;
867         pthread_attr_t attrs;
868
869         /* create partition work queue */
870         queue_Init(&pq);
871         CV_INIT(&(pq.cv), "partq", CV_DEFAULT, 0);
872         MUTEX_INIT(&(pq.mutex), "partq", MUTEX_DEFAULT, 0);
873         for (parts = 0, diskP = DiskPartitionList; diskP; diskP = diskP->next, parts++) {
874             struct diskpartition_queue_t *dp;
875             dp = (struct diskpartition_queue_t*)malloc(sizeof(struct diskpartition_queue_t));
876             osi_Assert(dp != NULL);
877             dp->diskP = diskP;
878             queue_Append(&pq, dp);
879         }
880
881         /* number of worker threads; at least one, not to exceed the number of partitions */
882         threads = MIN(parts, vol_attach_threads);
883
884         /* create volume work queue */
885         queue_Init(&vq);
886         CV_INIT(&(vq.cv), "volq", CV_DEFAULT, 0);
887         MUTEX_INIT(&(vq.mutex), "volq", MUTEX_DEFAULT, 0);
888
889         osi_Assert(pthread_attr_init(&attrs) == 0);
890         osi_Assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
891
892         Log("VInitVolumePackage: beginning parallel fileserver startup\n");
893         Log("VInitVolumePackage: using %d threads to pre-attach volumes on %d partitions\n",
894                 threads, parts);
895
896         /* create threads to scan disk partitions. */
897         for (i=0; i < threads; i++) {
898             struct vinitvolumepackage_thread_param *params;
899             AFS_SIGSET_DECL;
900
901             params = (struct vinitvolumepackage_thread_param *)malloc(sizeof(struct vinitvolumepackage_thread_param));
902             osi_Assert(params);
903             params->pq = &pq;
904             params->vq = &vq;
905             params->nthreads = threads;
906             params->thread = i+1;
907
908             AFS_SIGSET_CLEAR();
909             osi_Assert(pthread_create (&tid, &attrs, &VInitVolumePackageThread, (void*)params) == 0);
910             AFS_SIGSET_RESTORE();
911         }
912
913         VInitPreAttachVolumes(threads, &vq);
914
915         osi_Assert(pthread_attr_destroy(&attrs) == 0);
916         CV_DESTROY(&pq.cv);
917         MUTEX_DESTROY(&pq.mutex);
918         CV_DESTROY(&vq.cv);
919         MUTEX_DESTROY(&vq.mutex);
920     }
921
922     VOL_LOCK;
923     VSetVInit_r(2);                     /* Initialized, and all volumes have been attached */
924     CV_BROADCAST(&vol_init_attach_cond);
925     VOL_UNLOCK;
926
927     return 0;
928 }
929
930 /**
931  * Volume package initialization worker thread. Scan partitions for volume
932  * header files. Gather batches of volume ids and dispatch them to
933  * the main thread to be preattached.  The volume preattachement is done
934  * in the main thread to avoid global volume lock contention.
935  */
936 static void *
937 VInitVolumePackageThread(void *args)
938 {
939     struct vinitvolumepackage_thread_param *params;
940     struct DiskPartition64 *partition;
941     struct partition_queue *pq;
942     struct volume_init_queue *vq;
943     struct volume_init_batch *vb;
944
945     osi_Assert(args);
946     params = (struct vinitvolumepackage_thread_param *)args;
947     pq = params->pq;
948     vq = params->vq;
949     osi_Assert(pq);
950     osi_Assert(vq);
951
952     vb = (struct volume_init_batch*)malloc(sizeof(struct volume_init_batch));
953     osi_Assert(vb);
954     vb->thread = params->thread;
955     vb->last = 0;
956     vb->size = 0;
957
958     Log("Scanning partitions on thread %d of %d\n", params->thread, params->nthreads);
959     while((partition = VInitNextPartition(pq))) {
960         DIR *dirp;
961         VolId vid;
962
963         Log("Partition %s: pre-attaching volumes\n", partition->name);
964         dirp = opendir(VPartitionPath(partition));
965         if (!dirp) {
966             Log("opendir on Partition %s failed, errno=%d!\n", partition->name, errno);
967             continue;
968         }
969         while ((vid = VInitNextVolumeId(dirp))) {
970             Volume *vp = (Volume*)malloc(sizeof(Volume));
971             osi_Assert(vp);
972             memset(vp, 0, sizeof(Volume));
973             vp->device = partition->device;
974             vp->partition = partition;
975             vp->hashid = vid;
976             queue_Init(&vp->vnode_list);
977             queue_Init(&vp->rx_call_list);
978             CV_INIT(&V_attachCV(vp), "partattach", CV_DEFAULT, 0);
979
980             vb->batch[vb->size++] = vp;
981             if (vb->size == VINIT_BATCH_MAX_SIZE) {
982                 MUTEX_ENTER(&vq->mutex);
983                 queue_Append(vq, vb);
984                 CV_BROADCAST(&vq->cv);
985                 MUTEX_EXIT(&vq->mutex);
986
987                 vb = (struct volume_init_batch*)malloc(sizeof(struct volume_init_batch));
988                 osi_Assert(vb);
989                 vb->thread = params->thread;
990                 vb->size = 0;
991                 vb->last = 0;
992             }
993         }
994         closedir(dirp);
995     }
996
997     vb->last = 1;
998     MUTEX_ENTER(&vq->mutex);
999     queue_Append(vq, vb);
1000     CV_BROADCAST(&vq->cv);
1001     MUTEX_EXIT(&vq->mutex);
1002
1003     Log("Partition scan thread %d of %d ended\n", params->thread, params->nthreads);
1004     free(params);
1005     return NULL;
1006 }
1007
1008 /**
1009  * Read next element from the pre-populated partition list.
1010  */
1011 static struct DiskPartition64*
1012 VInitNextPartition(struct partition_queue *pq)
1013 {
1014     struct DiskPartition64 *partition;
1015     struct diskpartition_queue_t *dp; /* queue element */
1016
1017     if (vinit_attach_abort) {
1018         Log("Aborting volume preattach thread.\n");
1019         return NULL;
1020     }
1021
1022     /* get next partition to scan */
1023     MUTEX_ENTER(&pq->mutex);
1024     if (queue_IsEmpty(pq)) {
1025         MUTEX_EXIT(&pq->mutex);
1026         return NULL;
1027     }
1028     dp = queue_First(pq, diskpartition_queue_t);
1029     queue_Remove(dp);
1030     MUTEX_EXIT(&pq->mutex);
1031
1032     osi_Assert(dp);
1033     osi_Assert(dp->diskP);
1034
1035     partition = dp->diskP;
1036     free(dp);
1037     return partition;
1038 }
1039
1040 /**
1041  * Find next volume id on the partition.
1042  */
1043 static VolId
1044 VInitNextVolumeId(DIR *dirp)
1045 {
1046     struct dirent *d;
1047     VolId vid = 0;
1048     char *ext;
1049
1050     while((d = readdir(dirp))) {
1051         if (vinit_attach_abort) {
1052             Log("Aborting volume preattach thread.\n");
1053             break;
1054         }
1055         ext = strrchr(d->d_name, '.');
1056         if (d->d_name[0] == 'V' && ext && strcmp(ext, VHDREXT) == 0) {
1057             vid = VolumeNumber(d->d_name);
1058             if (vid) {
1059                break;
1060             }
1061             Log("Warning: bogus volume header file: %s\n", d->d_name);
1062         }
1063     }
1064     return vid;
1065 }
1066
1067 /**
1068  * Preattach volumes in batches to avoid lock contention.
1069  */
1070 static int
1071 VInitPreAttachVolumes(int nthreads, struct volume_init_queue *vq)
1072 {
1073     struct volume_init_batch *vb;
1074     int i;
1075
1076     while (nthreads) {
1077         /* dequeue next volume */
1078         MUTEX_ENTER(&vq->mutex);
1079         if (queue_IsEmpty(vq)) {
1080             CV_WAIT(&vq->cv, &vq->mutex);
1081         }
1082         vb = queue_First(vq, volume_init_batch);
1083         queue_Remove(vb);
1084         MUTEX_EXIT(&vq->mutex);
1085
1086         if (vb->size) {
1087             VOL_LOCK;
1088             for (i = 0; i<vb->size; i++) {
1089                 Volume *vp;
1090                 Volume *dup;
1091                 Error ec = 0;
1092
1093                 vp = vb->batch[i];
1094                 dup = VLookupVolume_r(&ec, vp->hashid, NULL);
1095                 if (ec) {
1096                     Log("Error looking up volume, code=%d\n", ec);
1097                 }
1098                 else if (dup) {
1099                     Log("Warning: Duplicate volume id %d detected.\n", vp->hashid);
1100                 }
1101                 else {
1102                     /* put pre-attached volume onto the hash table
1103                      * and bring it up to the pre-attached state */
1104                     AddVolumeToHashTable(vp, vp->hashid);
1105                     AddVolumeToVByPList_r(vp);
1106                     VLRU_Init_Node_r(vp);
1107                     VChangeState_r(vp, VOL_STATE_PREATTACHED);
1108                 }
1109             }
1110             VOL_UNLOCK;
1111         }
1112
1113         if (vb->last) {
1114             nthreads--;
1115         }
1116         free(vb);
1117     }
1118     return 0;
1119 }
1120 #endif /* AFS_DEMAND_ATTACH_FS */
1121
1122 #if !defined(AFS_DEMAND_ATTACH_FS)
1123 /*
1124  * attach all volumes on a given disk partition
1125  */
1126 static int
1127 VAttachVolumesByPartition(struct DiskPartition64 *diskP, int * nAttached, int * nUnattached)
1128 {
1129   DIR * dirp;
1130   struct dirent * dp;
1131   int ret = 0;
1132
1133   Log("Partition %s: attaching volumes\n", diskP->name);
1134   dirp = opendir(VPartitionPath(diskP));
1135   if (!dirp) {
1136     Log("opendir on Partition %s failed!\n", diskP->name);
1137     return 1;
1138   }
1139
1140   while ((dp = readdir(dirp))) {
1141     char *p;
1142     p = strrchr(dp->d_name, '.');
1143
1144     if (vinit_attach_abort) {
1145       Log("Partition %s: abort attach volumes\n", diskP->name);
1146       goto done;
1147     }
1148
1149     if (p != NULL && strcmp(p, VHDREXT) == 0) {
1150       Error error;
1151       Volume *vp;
1152       vp = VAttachVolumeByName(&error, diskP->name, dp->d_name,
1153                                V_VOLUPD);
1154       (*(vp ? nAttached : nUnattached))++;
1155       if (error == VOFFLINE)
1156         Log("Volume %d stays offline (/vice/offline/%s exists)\n", VolumeNumber(dp->d_name), dp->d_name);
1157       else if (LogLevel >= 5) {
1158         Log("Partition %s: attached volume %d (%s)\n",
1159             diskP->name, VolumeNumber(dp->d_name),
1160             dp->d_name);
1161       }
1162       if (vp) {
1163         VPutVolume(vp);
1164       }
1165     }
1166   }
1167
1168   Log("Partition %s: attached %d volumes; %d volumes not attached\n", diskP->name, *nAttached, *nUnattached);
1169 done:
1170   closedir(dirp);
1171   return ret;
1172 }
1173 #endif /* !AFS_DEMAND_ATTACH_FS */
1174
1175 /***************************************************/
1176 /* Shutdown routines                               */
1177 /***************************************************/
1178
1179 /*
1180  * demand attach fs
1181  * highly multithreaded volume package shutdown
1182  *
1183  * with the demand attach fileserver extensions,
1184  * VShutdown has been modified to be multithreaded.
1185  * In order to achieve optimal use of many threads,
1186  * the shutdown code involves one control thread and
1187  * n shutdown worker threads.  The control thread
1188  * periodically examines the number of volumes available
1189  * for shutdown on each partition, and produces a worker
1190  * thread allocation schedule.  The idea is to eliminate
1191  * redundant scheduling computation on the workers by
1192  * having a single master scheduler.
1193  *
1194  * The scheduler's objectives are:
1195  * (1) fairness
1196  *   each partition with volumes remaining gets allocated
1197  *   at least 1 thread (assuming sufficient threads)
1198  * (2) performance
1199  *   threads are allocated proportional to the number of
1200  *   volumes remaining to be offlined.  This ensures that
1201  *   the OS I/O scheduler has many requests to elevator
1202  *   seek on partitions that will (presumably) take the
1203  *   longest amount of time (from now) to finish shutdown
1204  * (3) keep threads busy
1205  *   when there are extra threads, they are assigned to
1206  *   partitions using a simple round-robin algorithm
1207  *
1208  * In the future, we may wish to add the ability to adapt
1209  * to the relative performance patterns of each disk
1210  * partition.
1211  *
1212  *
1213  * demand attach fs
1214  * multi-step shutdown process
1215  *
1216  * demand attach shutdown is a four-step process. Each
1217  * shutdown "pass" shuts down increasingly more difficult
1218  * volumes.  The main purpose is to achieve better cache
1219  * utilization during shutdown.
1220  *
1221  * pass 0
1222  *   shutdown volumes in the unattached, pre-attached
1223  *   and error states
1224  * pass 1
1225  *   shutdown attached volumes with cached volume headers
1226  * pass 2
1227  *   shutdown all volumes in non-exclusive states
1228  * pass 3
1229  *   shutdown all remaining volumes
1230  */
1231
1232 #ifdef AFS_DEMAND_ATTACH_FS
1233
1234 void
1235 VShutdown_r(void)
1236 {
1237     int i;
1238     struct DiskPartition64 * diskP;
1239     struct diskpartition_queue_t * dpq;
1240     vshutdown_thread_t params;
1241     pthread_t tid;
1242     pthread_attr_t attrs;
1243
1244     memset(&params, 0, sizeof(vshutdown_thread_t));
1245
1246     if (VInit < 2) {
1247         Log("VShutdown:  aborting attach volumes\n");
1248         vinit_attach_abort = 1;
1249         VOL_CV_WAIT(&vol_init_attach_cond);
1250     }
1251
1252     for (params.n_parts=0, diskP = DiskPartitionList;
1253          diskP; diskP = diskP->next, params.n_parts++);
1254
1255     Log("VShutdown:  shutting down on-line volumes on %d partition%s...\n",
1256         params.n_parts, params.n_parts > 1 ? "s" : "");
1257
1258     vol_shutting_down = 1;
1259
1260     if (vol_attach_threads > 1) {
1261         /* prepare for parallel shutdown */
1262         params.n_threads = vol_attach_threads;
1263         MUTEX_INIT(&params.lock, "params", MUTEX_DEFAULT, 0);
1264         CV_INIT(&params.cv, "params", CV_DEFAULT, 0);
1265         CV_INIT(&params.master_cv, "params master", CV_DEFAULT, 0);
1266         osi_Assert(pthread_attr_init(&attrs) == 0);
1267         osi_Assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
1268         queue_Init(&params);
1269
1270         /* setup the basic partition information structures for
1271          * parallel shutdown */
1272         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1273             /* XXX debug */
1274             struct rx_queue * qp, * nqp;
1275             Volume * vp;
1276             int count = 0;
1277
1278             VVByPListWait_r(diskP);
1279             VVByPListBeginExclusive_r(diskP);
1280
1281             /* XXX debug */
1282             for (queue_Scan(&diskP->vol_list, qp, nqp, rx_queue)) {
1283                 vp = (Volume *)((char *)qp - offsetof(Volume, vol_list));
1284                 if (vp->header)
1285                     count++;
1286             }
1287             Log("VShutdown: partition %s has %d volumes with attached headers\n",
1288                 VPartitionPath(diskP), count);
1289
1290
1291             /* build up the pass 0 shutdown work queue */
1292             dpq = (struct diskpartition_queue_t *) malloc(sizeof(struct diskpartition_queue_t));
1293             osi_Assert(dpq != NULL);
1294             dpq->diskP = diskP;
1295             queue_Prepend(&params, dpq);
1296
1297             params.part_pass_head[diskP->index] = queue_First(&diskP->vol_list, rx_queue);
1298         }
1299
1300         Log("VShutdown:  beginning parallel fileserver shutdown\n");
1301         Log("VShutdown:  using %d threads to offline volumes on %d partition%s\n",
1302             vol_attach_threads, params.n_parts, params.n_parts > 1 ? "s" : "" );
1303
1304         /* do pass 0 shutdown */
1305         MUTEX_ENTER(&params.lock);
1306         for (i=0; i < params.n_threads; i++) {
1307             osi_Assert(pthread_create
1308                    (&tid, &attrs, &VShutdownThread,
1309                     &params) == 0);
1310         }
1311
1312         /* wait for all the pass 0 shutdowns to complete */
1313         while (params.n_threads_complete < params.n_threads) {
1314             CV_WAIT(&params.master_cv, &params.lock);
1315         }
1316         params.n_threads_complete = 0;
1317         params.pass = 1;
1318         CV_BROADCAST(&params.cv);
1319         MUTEX_EXIT(&params.lock);
1320
1321         Log("VShutdown:  pass 0 completed using the 1 thread per partition algorithm\n");
1322         Log("VShutdown:  starting passes 1 through 3 using finely-granular mp-fast algorithm\n");
1323
1324         /* run the parallel shutdown scheduler. it will drop the glock internally */
1325         ShutdownController(&params);
1326
1327         /* wait for all the workers to finish pass 3 and terminate */
1328         while (params.pass < 4) {
1329             VOL_CV_WAIT(&params.cv);
1330         }
1331
1332         osi_Assert(pthread_attr_destroy(&attrs) == 0);
1333         CV_DESTROY(&params.cv);
1334         CV_DESTROY(&params.master_cv);
1335         MUTEX_DESTROY(&params.lock);
1336
1337         /* drop the VByPList exclusive reservations */
1338         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1339             VVByPListEndExclusive_r(diskP);
1340             Log("VShutdown:  %s stats : (pass[0]=%d, pass[1]=%d, pass[2]=%d, pass[3]=%d)\n",
1341                 VPartitionPath(diskP),
1342                 params.stats[0][diskP->index],
1343                 params.stats[1][diskP->index],
1344                 params.stats[2][diskP->index],
1345                 params.stats[3][diskP->index]);
1346         }
1347
1348         Log("VShutdown:  shutdown finished using %d threads\n", params.n_threads);
1349     } else {
1350         /* if we're only going to run one shutdown thread, don't bother creating
1351          * another LWP */
1352         Log("VShutdown:  beginning single-threaded fileserver shutdown\n");
1353
1354         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1355             VShutdownByPartition_r(diskP);
1356         }
1357     }
1358
1359     Log("VShutdown:  complete.\n");
1360 }
1361
1362 #else /* AFS_DEMAND_ATTACH_FS */
1363
1364 void
1365 VShutdown_r(void)
1366 {
1367     int i;
1368     Volume *vp, *np;
1369     afs_int32 code;
1370
1371     if (VInit < 2) {
1372         Log("VShutdown:  aborting attach volumes\n");
1373         vinit_attach_abort = 1;
1374 #ifdef AFS_PTHREAD_ENV
1375         VOL_CV_WAIT(&vol_init_attach_cond);
1376 #else
1377         LWP_WaitProcess(VInitAttachVolumes);
1378 #endif /* AFS_PTHREAD_ENV */
1379     }
1380
1381     Log("VShutdown:  shutting down on-line volumes...\n");
1382     vol_shutting_down = 1;
1383     for (i = 0; i < VolumeHashTable.Size; i++) {
1384         /* try to hold first volume in the hash table */
1385         for (queue_Scan(&VolumeHashTable.Table[i],vp,np,Volume)) {
1386             code = VHold_r(vp);
1387             if (code == 0) {
1388                 if (LogLevel >= 5)
1389                     Log("VShutdown:  Attempting to take volume %u offline.\n",
1390                         vp->hashid);
1391
1392                 /* next, take the volume offline (drops reference count) */
1393                 VOffline_r(vp, "File server was shut down");
1394             }
1395         }
1396     }
1397     Log("VShutdown:  complete.\n");
1398 }
1399 #endif /* AFS_DEMAND_ATTACH_FS */
1400
1401
1402 void
1403 VShutdown(void)
1404 {
1405     osi_Assert(VInit>0);
1406     VOL_LOCK;
1407     VShutdown_r();
1408     VOL_UNLOCK;
1409 }
1410
1411 /**
1412  * stop new activity (e.g. SALVSYNC) from occurring
1413  *
1414  * Use this to make the volume package less busy; for example, during
1415  * shutdown. This doesn't actually shutdown/detach anything in the
1416  * volume package, but prevents certain processes from ocurring. For
1417  * example, preventing new SALVSYNC communication in DAFS. In theory, we
1418  * could also use this to prevent new volume attachment, or prevent
1419  * other programs from checking out volumes, etc.
1420  */
1421 void
1422 VSetTranquil(void)
1423 {
1424 #ifdef AFS_DEMAND_ATTACH_FS
1425     /* make sure we don't try to contact the salvageserver, since it may
1426      * not be around anymore */
1427     vol_disallow_salvsync = 1;
1428 #endif
1429 }
1430
1431 #ifdef AFS_DEMAND_ATTACH_FS
1432 /*
1433  * demand attach fs
1434  * shutdown control thread
1435  */
1436 static void
1437 ShutdownController(vshutdown_thread_t * params)
1438 {
1439     /* XXX debug */
1440     struct DiskPartition64 * diskP;
1441     Device id;
1442     vshutdown_thread_t shadow;
1443
1444     ShutdownCreateSchedule(params);
1445
1446     while ((params->pass < 4) &&
1447            (params->n_threads_complete < params->n_threads)) {
1448         /* recompute schedule once per second */
1449
1450         memcpy(&shadow, params, sizeof(vshutdown_thread_t));
1451
1452         VOL_UNLOCK;
1453         /* XXX debug */
1454         Log("ShutdownController:  schedule version=%d, vol_remaining=%d, pass=%d\n",
1455             shadow.schedule_version, shadow.vol_remaining, shadow.pass);
1456         Log("ShutdownController:  n_threads_complete=%d, n_parts_done_pass=%d\n",
1457             shadow.n_threads_complete, shadow.n_parts_done_pass);
1458         for (diskP = DiskPartitionList; diskP; diskP=diskP->next) {
1459             id = diskP->index;
1460             Log("ShutdownController:  part[%d] : (len=%d, thread_target=%d, done_pass=%d, pass_head=%p)\n",
1461                 id,
1462                 diskP->vol_list.len,
1463                 shadow.part_thread_target[id],
1464                 shadow.part_done_pass[id],
1465                 shadow.part_pass_head[id]);
1466         }
1467
1468         sleep(1);
1469         VOL_LOCK;
1470
1471         ShutdownCreateSchedule(params);
1472     }
1473 }
1474
1475 /* create the shutdown thread work schedule.
1476  * this scheduler tries to implement fairness
1477  * by allocating at least 1 thread to each
1478  * partition with volumes to be shutdown,
1479  * and then it attempts to allocate remaining
1480  * threads based upon the amount of work left
1481  */
1482 static void
1483 ShutdownCreateSchedule(vshutdown_thread_t * params)
1484 {
1485     struct DiskPartition64 * diskP;
1486     int sum, thr_workload, thr_left;
1487     int part_residue[VOLMAXPARTS+1];
1488     Device id;
1489
1490     /* compute the total number of outstanding volumes */
1491     sum = 0;
1492     for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1493         sum += diskP->vol_list.len;
1494     }
1495
1496     params->schedule_version++;
1497     params->vol_remaining = sum;
1498
1499     if (!sum)
1500         return;
1501
1502     /* compute average per-thread workload */
1503     thr_workload = sum / params->n_threads;
1504     if (sum % params->n_threads)
1505         thr_workload++;
1506
1507     thr_left = params->n_threads;
1508     memset(&part_residue, 0, sizeof(part_residue));
1509
1510     /* for fairness, give every partition with volumes remaining
1511      * at least one thread */
1512     for (diskP = DiskPartitionList; diskP && thr_left; diskP = diskP->next) {
1513         id = diskP->index;
1514         if (diskP->vol_list.len) {
1515             params->part_thread_target[id] = 1;
1516             thr_left--;
1517         } else {
1518             params->part_thread_target[id] = 0;
1519         }
1520     }
1521
1522     if (thr_left && thr_workload) {
1523         /* compute length-weighted workloads */
1524         int delta;
1525
1526         for (diskP = DiskPartitionList; diskP && thr_left; diskP = diskP->next) {
1527             id = diskP->index;
1528             delta = (diskP->vol_list.len / thr_workload) -
1529                 params->part_thread_target[id];
1530             if (delta < 0) {
1531                 continue;
1532             }
1533             if (delta < thr_left) {
1534                 params->part_thread_target[id] += delta;
1535                 thr_left -= delta;
1536             } else {
1537                 params->part_thread_target[id] += thr_left;
1538                 thr_left = 0;
1539                 break;
1540             }
1541         }
1542     }
1543
1544     if (thr_left) {
1545         /* try to assign any leftover threads to partitions that
1546          * had volume lengths closer to needing thread_target+1 */
1547         int max_residue, max_id = 0;
1548
1549         /* compute the residues */
1550         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1551             id = diskP->index;
1552             part_residue[id] = diskP->vol_list.len -
1553                 (params->part_thread_target[id] * thr_workload);
1554         }
1555
1556         /* now try to allocate remaining threads to partitions with the
1557          * highest residues */
1558         while (thr_left) {
1559             max_residue = 0;
1560             for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1561                 id = diskP->index;
1562                 if (part_residue[id] > max_residue) {
1563                     max_residue = part_residue[id];
1564                     max_id = id;
1565                 }
1566             }
1567
1568             if (!max_residue) {
1569                 break;
1570             }
1571
1572             params->part_thread_target[max_id]++;
1573             thr_left--;
1574             part_residue[max_id] = 0;
1575         }
1576     }
1577
1578     if (thr_left) {
1579         /* punt and give any remaining threads equally to each partition */
1580         int alloc;
1581         if (thr_left >= params->n_parts) {
1582             alloc = thr_left / params->n_parts;
1583             for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1584                 id = diskP->index;
1585                 params->part_thread_target[id] += alloc;
1586                 thr_left -= alloc;
1587             }
1588         }
1589
1590         /* finish off the last of the threads */
1591         for (diskP = DiskPartitionList; thr_left && diskP; diskP = diskP->next) {
1592             id = diskP->index;
1593             params->part_thread_target[id]++;
1594             thr_left--;
1595         }
1596     }
1597 }
1598
1599 /* worker thread for parallel shutdown */
1600 static void *
1601 VShutdownThread(void * args)
1602 {
1603     vshutdown_thread_t * params;
1604     int found, pass, schedule_version_save, count;
1605     struct DiskPartition64 *diskP;
1606     struct diskpartition_queue_t * dpq;
1607     Device id;
1608
1609     params = (vshutdown_thread_t *) args;
1610
1611     /* acquire the shutdown pass 0 lock */
1612     MUTEX_ENTER(&params->lock);
1613
1614     /* if there's still pass 0 work to be done,
1615      * get a work entry, and do a pass 0 shutdown */
1616     if (queue_IsNotEmpty(params)) {
1617         dpq = queue_First(params, diskpartition_queue_t);
1618         queue_Remove(dpq);
1619         MUTEX_EXIT(&params->lock);
1620         diskP = dpq->diskP;
1621         free(dpq);
1622         id = diskP->index;
1623
1624         count = 0;
1625         while (ShutdownVolumeWalk_r(diskP, 0, &params->part_pass_head[id]))
1626             count++;
1627         params->stats[0][diskP->index] = count;
1628         MUTEX_ENTER(&params->lock);
1629     }
1630
1631     params->n_threads_complete++;
1632     if (params->n_threads_complete == params->n_threads) {
1633         /* notify control thread that all workers have completed pass 0 */
1634         CV_SIGNAL(&params->master_cv);
1635     }
1636     while (params->pass == 0) {
1637         CV_WAIT(&params->cv, &params->lock);
1638     }
1639
1640     /* switch locks */
1641     MUTEX_EXIT(&params->lock);
1642     VOL_LOCK;
1643
1644     pass = params->pass;
1645     osi_Assert(pass > 0);
1646
1647     /* now escalate through the more complicated shutdowns */
1648     while (pass <= 3) {
1649         schedule_version_save = params->schedule_version;
1650         found = 0;
1651         /* find a disk partition to work on */
1652         for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1653             id = diskP->index;
1654             if (params->part_thread_target[id] && !params->part_done_pass[id]) {
1655                 params->part_thread_target[id]--;
1656                 found = 1;
1657                 break;
1658             }
1659         }
1660
1661         if (!found) {
1662             /* hmm. for some reason the controller thread couldn't find anything for
1663              * us to do. let's see if there's anything we can do */
1664             for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1665                 id = diskP->index;
1666                 if (diskP->vol_list.len && !params->part_done_pass[id]) {
1667                     found = 1;
1668                     break;
1669                 } else if (!params->part_done_pass[id]) {
1670                     params->part_done_pass[id] = 1;
1671                     params->n_parts_done_pass++;
1672                     if (pass == 3) {
1673                         Log("VShutdown:  done shutting down volumes on partition %s.\n",
1674                             VPartitionPath(diskP));
1675                     }
1676                 }
1677             }
1678         }
1679
1680         /* do work on this partition until either the controller
1681          * creates a new schedule, or we run out of things to do
1682          * on this partition */
1683         if (found) {
1684             count = 0;
1685             while (!params->part_done_pass[id] &&
1686                    (schedule_version_save == params->schedule_version)) {
1687                 /* ShutdownVolumeWalk_r will drop the glock internally */
1688                 if (!ShutdownVolumeWalk_r(diskP, pass, &params->part_pass_head[id])) {
1689                     if (!params->part_done_pass[id]) {
1690                         params->part_done_pass[id] = 1;
1691                         params->n_parts_done_pass++;
1692                         if (pass == 3) {
1693                             Log("VShutdown:  done shutting down volumes on partition %s.\n",
1694                                 VPartitionPath(diskP));
1695                         }
1696                     }
1697                     break;
1698                 }
1699                 count++;
1700             }
1701
1702             params->stats[pass][id] += count;
1703         } else {
1704             /* ok, everyone is done this pass, proceed */
1705
1706             /* barrier lock */
1707             params->n_threads_complete++;
1708             while (params->pass == pass) {
1709                 if (params->n_threads_complete == params->n_threads) {
1710                     /* we are the last thread to complete, so we will
1711                      * reinitialize worker pool state for the next pass */
1712                     params->n_threads_complete = 0;
1713                     params->n_parts_done_pass = 0;
1714                     params->pass++;
1715                     for (diskP = DiskPartitionList; diskP; diskP = diskP->next) {
1716                         id = diskP->index;
1717                         params->part_done_pass[id] = 0;
1718                         params->part_pass_head[id] = queue_First(&diskP->vol_list, rx_queue);
1719                     }
1720
1721                     /* compute a new thread schedule before releasing all the workers */
1722                     ShutdownCreateSchedule(params);
1723
1724                     /* wake up all the workers */
1725                     CV_BROADCAST(&params->cv);
1726
1727                     VOL_UNLOCK;
1728                     Log("VShutdown:  pass %d completed using %d threads on %d partitions\n",
1729                         pass, params->n_threads, params->n_parts);
1730                     VOL_LOCK;
1731                 } else {
1732                     VOL_CV_WAIT(&params->cv);
1733                 }
1734             }
1735             pass = params->pass;
1736         }
1737
1738         /* for fairness */
1739         VOL_UNLOCK;
1740         pthread_yield();
1741         VOL_LOCK;
1742     }
1743
1744     VOL_UNLOCK;
1745
1746     return NULL;
1747 }
1748
1749 /* shut down all volumes on a given disk partition
1750  *
1751  * note that this function will not allow mp-fast
1752  * shutdown of a partition */
1753 int
1754 VShutdownByPartition_r(struct DiskPartition64 * dp)
1755 {
1756     int pass;
1757     int pass_stats[4];
1758     int total;
1759
1760     /* wait for other exclusive ops to finish */
1761     VVByPListWait_r(dp);
1762
1763     /* begin exclusive access */
1764     VVByPListBeginExclusive_r(dp);
1765
1766     /* pick the low-hanging fruit first,
1767      * then do the complicated ones last
1768      * (has the advantage of keeping
1769      *  in-use volumes up until the bitter end) */
1770     for (pass = 0, total=0; pass < 4; pass++) {
1771         pass_stats[pass] = ShutdownVByPForPass_r(dp, pass);
1772         total += pass_stats[pass];
1773     }
1774
1775     /* end exclusive access */
1776     VVByPListEndExclusive_r(dp);
1777
1778     Log("VShutdownByPartition:  shut down %d volumes on %s (pass[0]=%d, pass[1]=%d, pass[2]=%d, pass[3]=%d)\n",
1779         total, VPartitionPath(dp), pass_stats[0], pass_stats[1], pass_stats[2], pass_stats[3]);
1780
1781     return 0;
1782 }
1783
1784 /* internal shutdown functionality
1785  *
1786  * for multi-pass shutdown:
1787  * 0 to only "shutdown" {pre,un}attached and error state volumes
1788  * 1 to also shutdown attached volumes w/ volume header loaded
1789  * 2 to also shutdown attached volumes w/o volume header loaded
1790  * 3 to also shutdown exclusive state volumes
1791  *
1792  * caller MUST hold exclusive access on the hash chain
1793  * because we drop vol_glock_mutex internally
1794  *
1795  * this function is reentrant for passes 1--3
1796  * (e.g. multiple threads can cooperate to
1797  *  shutdown a partition mp-fast)
1798  *
1799  * pass 0 is not scaleable because the volume state data is
1800  * synchronized by vol_glock mutex, and the locking overhead
1801  * is too high to drop the lock long enough to do linked list
1802  * traversal
1803  */
1804 static int
1805 ShutdownVByPForPass_r(struct DiskPartition64 * dp, int pass)
1806 {
1807     struct rx_queue * q = queue_First(&dp->vol_list, rx_queue);
1808     int i = 0;
1809
1810     while (ShutdownVolumeWalk_r(dp, pass, &q))
1811         i++;
1812
1813     return i;
1814 }
1815
1816 /* conditionally shutdown one volume on partition dp
1817  * returns 1 if a volume was shutdown in this pass,
1818  * 0 otherwise */
1819 static int
1820 ShutdownVolumeWalk_r(struct DiskPartition64 * dp, int pass,
1821                      struct rx_queue ** idx)
1822 {
1823     struct rx_queue *qp, *nqp;
1824     Volume * vp;
1825
1826     qp = *idx;
1827
1828     for (queue_ScanFrom(&dp->vol_list, qp, qp, nqp, rx_queue)) {
1829         vp = (Volume *) (((char *)qp) - offsetof(Volume, vol_list));
1830
1831         switch (pass) {
1832         case 0:
1833             if ((V_attachState(vp) != VOL_STATE_UNATTACHED) &&
1834                 (V_attachState(vp) != VOL_STATE_ERROR) &&
1835                 (V_attachState(vp) != VOL_STATE_DELETED) &&
1836                 (V_attachState(vp) != VOL_STATE_PREATTACHED)) {
1837                 break;
1838             }
1839         case 1:
1840             if ((V_attachState(vp) == VOL_STATE_ATTACHED) &&
1841                 (vp->header == NULL)) {
1842                 break;
1843             }
1844         case 2:
1845             if (VIsExclusiveState(V_attachState(vp))) {
1846                 break;
1847             }
1848         case 3:
1849             *idx = nqp;
1850             DeleteVolumeFromVByPList_r(vp);
1851             VShutdownVolume_r(vp);
1852             vp = NULL;
1853             return 1;
1854         }
1855     }
1856
1857     return 0;
1858 }
1859
1860 /*
1861  * shutdown a specific volume
1862  */
1863 /* caller MUST NOT hold a heavyweight ref on vp */
1864 int
1865 VShutdownVolume_r(Volume * vp)
1866 {
1867     int code;
1868
1869     VCreateReservation_r(vp);
1870
1871     if (LogLevel >= 5) {
1872         Log("VShutdownVolume_r:  vid=%u, device=%d, state=%hu\n",
1873             vp->hashid, vp->partition->device, V_attachState(vp));
1874     }
1875
1876     /* wait for other blocking ops to finish */
1877     VWaitExclusiveState_r(vp);
1878
1879     osi_Assert(VIsValidState(V_attachState(vp)));
1880
1881     switch(V_attachState(vp)) {
1882     case VOL_STATE_SALVAGING:
1883         /* Leave salvaging volumes alone. Any in-progress salvages will
1884          * continue working after viced shuts down. This is intentional.
1885          */
1886
1887     case VOL_STATE_PREATTACHED:
1888     case VOL_STATE_ERROR:
1889         VChangeState_r(vp, VOL_STATE_UNATTACHED);
1890     case VOL_STATE_UNATTACHED:
1891     case VOL_STATE_DELETED:
1892         break;
1893     case VOL_STATE_GOING_OFFLINE:
1894     case VOL_STATE_SHUTTING_DOWN:
1895     case VOL_STATE_ATTACHED:
1896         code = VHold_r(vp);
1897         if (!code) {
1898             if (LogLevel >= 5)
1899                 Log("VShutdown:  Attempting to take volume %u offline.\n",
1900                     vp->hashid);
1901
1902             /* take the volume offline (drops reference count) */
1903             VOffline_r(vp, "File server was shut down");
1904         }
1905         break;
1906     default:
1907         break;
1908     }
1909
1910     VCancelReservation_r(vp);
1911     vp = NULL;
1912     return 0;
1913 }
1914 #endif /* AFS_DEMAND_ATTACH_FS */
1915
1916
1917 /***************************************************/
1918 /* Header I/O routines                             */
1919 /***************************************************/
1920
1921 /* open a descriptor for the inode (h),
1922  * read in an on-disk structure into buffer (to) of size (size),
1923  * verify versionstamp in structure has magic (magic) and
1924  * optionally verify version (version) if (version) is nonzero
1925  */
1926 static void
1927 ReadHeader(Error * ec, IHandle_t * h, char *to, int size, bit32 magic,
1928            bit32 version)
1929 {
1930     struct versionStamp *vsn;
1931     FdHandle_t *fdP;
1932
1933     *ec = 0;
1934     if (h == NULL) {
1935         *ec = VSALVAGE;
1936         return;
1937     }
1938
1939     fdP = IH_OPEN(h);
1940     if (fdP == NULL) {
1941         *ec = VSALVAGE;
1942         return;
1943     }
1944
1945     vsn = (struct versionStamp *)to;
1946     if (FDH_PREAD(fdP, to, size, 0) != size || vsn->magic != magic) {
1947         *ec = VSALVAGE;
1948         FDH_REALLYCLOSE(fdP);
1949         return;
1950     }
1951     FDH_CLOSE(fdP);
1952
1953     /* Check is conditional, in case caller wants to inspect version himself */
1954     if (version && vsn->version != version) {
1955         *ec = VSALVAGE;
1956     }
1957 }
1958
1959 void
1960 WriteVolumeHeader_r(Error * ec, Volume * vp)
1961 {
1962     IHandle_t *h = V_diskDataHandle(vp);
1963     FdHandle_t *fdP;
1964
1965     *ec = 0;
1966
1967     fdP = IH_OPEN(h);
1968     if (fdP == NULL) {
1969         *ec = VSALVAGE;
1970         return;
1971     }
1972     if (FDH_PWRITE(fdP, (char *)&V_disk(vp), sizeof(V_disk(vp)), 0)
1973         != sizeof(V_disk(vp))) {
1974         *ec = VSALVAGE;
1975         FDH_REALLYCLOSE(fdP);
1976         return;
1977     }
1978     FDH_CLOSE(fdP);
1979 }
1980
1981 /* VolumeHeaderToDisk
1982  * Allows for storing 64 bit inode numbers in on-disk volume header
1983  * file.
1984  */
1985 /* convert in-memory representation of a volume header to the
1986  * on-disk representation of a volume header */
1987 void
1988 VolumeHeaderToDisk(VolumeDiskHeader_t * dh, VolumeHeader_t * h)
1989 {
1990
1991     memset(dh, 0, sizeof(VolumeDiskHeader_t));
1992     dh->stamp = h->stamp;
1993     dh->id = h->id;
1994     dh->parent = h->parent;
1995
1996 #ifdef AFS_64BIT_IOPS_ENV
1997     dh->volumeInfo_lo = (afs_int32) h->volumeInfo & 0xffffffff;
1998     dh->volumeInfo_hi = (afs_int32) (h->volumeInfo >> 32) & 0xffffffff;
1999     dh->smallVnodeIndex_lo = (afs_int32) h->smallVnodeIndex & 0xffffffff;
2000     dh->smallVnodeIndex_hi =
2001         (afs_int32) (h->smallVnodeIndex >> 32) & 0xffffffff;
2002     dh->largeVnodeIndex_lo = (afs_int32) h->largeVnodeIndex & 0xffffffff;
2003     dh->largeVnodeIndex_hi =
2004         (afs_int32) (h->largeVnodeIndex >> 32) & 0xffffffff;
2005     dh->linkTable_lo = (afs_int32) h->linkTable & 0xffffffff;
2006     dh->linkTable_hi = (afs_int32) (h->linkTable >> 32) & 0xffffffff;
2007 #else
2008     dh->volumeInfo_lo = h->volumeInfo;
2009     dh->smallVnodeIndex_lo = h->smallVnodeIndex;
2010     dh->largeVnodeIndex_lo = h->largeVnodeIndex;
2011     dh->linkTable_lo = h->linkTable;
2012 #endif
2013 }
2014
2015 /* DiskToVolumeHeader
2016  * Converts an on-disk representation of a volume header to
2017  * the in-memory representation of a volume header.
2018  *
2019  * Makes the assumption that AFS has *always*
2020  * zero'd the volume header file so that high parts of inode
2021  * numbers are 0 in older (SGI EFS) volume header files.
2022  */
2023 void
2024 DiskToVolumeHeader(VolumeHeader_t * h, VolumeDiskHeader_t * dh)
2025 {
2026     memset(h, 0, sizeof(VolumeHeader_t));
2027     h->stamp = dh->stamp;
2028     h->id = dh->id;
2029     h->parent = dh->parent;
2030
2031 #ifdef AFS_64BIT_IOPS_ENV
2032     h->volumeInfo =
2033         (Inode) dh->volumeInfo_lo | ((Inode) dh->volumeInfo_hi << 32);
2034
2035     h->smallVnodeIndex =
2036         (Inode) dh->smallVnodeIndex_lo | ((Inode) dh->
2037                                           smallVnodeIndex_hi << 32);
2038
2039     h->largeVnodeIndex =
2040         (Inode) dh->largeVnodeIndex_lo | ((Inode) dh->
2041                                           largeVnodeIndex_hi << 32);
2042     h->linkTable =
2043         (Inode) dh->linkTable_lo | ((Inode) dh->linkTable_hi << 32);
2044 #else
2045     h->volumeInfo = dh->volumeInfo_lo;
2046     h->smallVnodeIndex = dh->smallVnodeIndex_lo;
2047     h->largeVnodeIndex = dh->largeVnodeIndex_lo;
2048     h->linkTable = dh->linkTable_lo;
2049 #endif
2050 }
2051
2052
2053 /***************************************************/
2054 /* Volume Attachment routines                      */
2055 /***************************************************/
2056
2057 #ifdef AFS_DEMAND_ATTACH_FS
2058 /**
2059  * pre-attach a volume given its path.
2060  *
2061  * @param[out] ec         outbound error code
2062  * @param[in]  partition  partition path string
2063  * @param[in]  name       volume id string
2064  *
2065  * @return volume object pointer
2066  *
2067  * @note A pre-attached volume will only have its partition
2068  *       and hashid fields initialized.  At first call to
2069  *       VGetVolume, the volume will be fully attached.
2070  *
2071  */
2072 Volume *
2073 VPreAttachVolumeByName(Error * ec, char *partition, char *name)
2074 {
2075     Volume * vp;
2076     VOL_LOCK;
2077     vp = VPreAttachVolumeByName_r(ec, partition, name);
2078     VOL_UNLOCK;
2079     return vp;
2080 }
2081
2082 /**
2083  * pre-attach a volume given its path.
2084  *
2085  * @param[out] ec         outbound error code
2086  * @param[in]  partition  path to vice partition
2087  * @param[in]  name       volume id string
2088  *
2089  * @return volume object pointer
2090  *
2091  * @pre VOL_LOCK held
2092  *
2093  * @internal volume package internal use only.
2094  */
2095 Volume *
2096 VPreAttachVolumeByName_r(Error * ec, char *partition, char *name)
2097 {
2098     return VPreAttachVolumeById_r(ec,
2099                                   partition,
2100                                   VolumeNumber(name));
2101 }
2102
2103 /**
2104  * pre-attach a volume given its path and numeric volume id.
2105  *
2106  * @param[out] ec          error code return
2107  * @param[in]  partition   path to vice partition
2108  * @param[in]  volumeId    numeric volume id
2109  *
2110  * @return volume object pointer
2111  *
2112  * @pre VOL_LOCK held
2113  *
2114  * @internal volume package internal use only.
2115  */
2116 Volume *
2117 VPreAttachVolumeById_r(Error * ec,
2118                        char * partition,
2119                        VolId volumeId)
2120 {
2121     Volume *vp;
2122     struct DiskPartition64 *partp;
2123
2124     *ec = 0;
2125
2126     osi_Assert(programType == fileServer);
2127
2128     if (!(partp = VGetPartition_r(partition, 0))) {
2129         *ec = VNOVOL;
2130         Log("VPreAttachVolumeById_r:  Error getting partition (%s)\n", partition);
2131         return NULL;
2132     }
2133
2134     vp = VLookupVolume_r(ec, volumeId, NULL);
2135     if (*ec) {
2136         return NULL;
2137     }
2138
2139     return VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2140 }
2141
2142 /**
2143  * preattach a volume.
2144  *
2145  * @param[out] ec     outbound error code
2146  * @param[in]  partp  pointer to partition object
2147  * @param[in]  vp     pointer to volume object
2148  * @param[in]  vid    volume id
2149  *
2150  * @return volume object pointer
2151  *
2152  * @pre VOL_LOCK is held.
2153  *
2154  * @warning Returned volume object pointer does not have to
2155  *          equal the pointer passed in as argument vp.  There
2156  *          are potential race conditions which can result in
2157  *          the pointers having different values.  It is up to
2158  *          the caller to make sure that references are handled
2159  *          properly in this case.
2160  *
2161  * @note If there is already a volume object registered with
2162  *       the same volume id, its pointer MUST be passed as
2163  *       argument vp.  Failure to do so will result in a silent
2164  *       failure to preattach.
2165  *
2166  * @internal volume package internal use only.
2167  */
2168 Volume *
2169 VPreAttachVolumeByVp_r(Error * ec,
2170                        struct DiskPartition64 * partp,
2171                        Volume * vp,
2172                        VolId vid)
2173 {
2174     Volume *nvp = NULL;
2175
2176     *ec = 0;
2177
2178     /* check to see if pre-attach already happened */
2179     if (vp &&
2180         (V_attachState(vp) != VOL_STATE_UNATTACHED) &&
2181         (V_attachState(vp) != VOL_STATE_DELETED) &&
2182         (V_attachState(vp) != VOL_STATE_PREATTACHED) &&
2183         !VIsErrorState(V_attachState(vp))) {
2184         /*
2185          * pre-attach is a no-op in all but the following cases:
2186          *
2187          *   - volume is unattached
2188          *   - volume is in an error state
2189          *   - volume is pre-attached
2190          */
2191         Log("VPreattachVolumeByVp_r: volume %u not in quiescent state\n", vid);
2192         goto done;
2193     } else if (vp) {
2194         /* we're re-attaching a volume; clear out some old state */
2195         memset(&vp->salvage, 0, sizeof(struct VolumeOnlineSalvage));
2196
2197         if (V_partition(vp) != partp) {
2198             /* XXX potential race */
2199             DeleteVolumeFromVByPList_r(vp);
2200         }
2201     } else {
2202         /* if we need to allocate a new Volume struct,
2203          * go ahead and drop the vol glock, otherwise
2204          * do the basic setup synchronised, as it's
2205          * probably not worth dropping the lock */
2206         VOL_UNLOCK;
2207
2208         /* allocate the volume structure */
2209         vp = nvp = (Volume *) malloc(sizeof(Volume));
2210         osi_Assert(vp != NULL);
2211         memset(vp, 0, sizeof(Volume));
2212         queue_Init(&vp->vnode_list);
2213         queue_Init(&vp->rx_call_list);
2214         CV_INIT(&V_attachCV(vp), "vp attach", CV_DEFAULT, 0);
2215     }
2216
2217     /* link the volume with its associated vice partition */
2218     vp->device = partp->device;
2219     vp->partition = partp;
2220
2221     vp->hashid = vid;
2222     vp->specialStatus = 0;
2223
2224     /* if we dropped the lock, reacquire the lock,
2225      * check for pre-attach races, and then add
2226      * the volume to the hash table */
2227     if (nvp) {
2228         VOL_LOCK;
2229         nvp = VLookupVolume_r(ec, vid, NULL);
2230         if (*ec) {
2231             free(vp);
2232             vp = NULL;
2233             goto done;
2234         } else if (nvp) { /* race detected */
2235             free(vp);
2236             vp = nvp;
2237             goto done;
2238         } else {
2239           /* hack to make up for VChangeState_r() decrementing
2240            * the old state counter */
2241           VStats.state_levels[0]++;
2242         }
2243     }
2244
2245     /* put pre-attached volume onto the hash table
2246      * and bring it up to the pre-attached state */
2247     AddVolumeToHashTable(vp, vp->hashid);
2248     AddVolumeToVByPList_r(vp);
2249     VLRU_Init_Node_r(vp);
2250     VChangeState_r(vp, VOL_STATE_PREATTACHED);
2251
2252     if (LogLevel >= 5)
2253         Log("VPreAttachVolumeByVp_r:  volume %u pre-attached\n", vp->hashid);
2254
2255   done:
2256     if (*ec)
2257         return NULL;
2258     else
2259         return vp;
2260 }
2261 #endif /* AFS_DEMAND_ATTACH_FS */
2262
2263 /* Attach an existing volume, given its pathname, and return a
2264    pointer to the volume header information.  The volume also
2265    normally goes online at this time.  An offline volume
2266    must be reattached to make it go online */
2267 Volume *
2268 VAttachVolumeByName(Error * ec, char *partition, char *name, int mode)
2269 {
2270     Volume *retVal;
2271     VOL_LOCK;
2272     retVal = VAttachVolumeByName_r(ec, partition, name, mode);
2273     VOL_UNLOCK;
2274     return retVal;
2275 }
2276
2277 Volume *
2278 VAttachVolumeByName_r(Error * ec, char *partition, char *name, int mode)
2279 {
2280     Volume *vp = NULL;
2281     struct DiskPartition64 *partp;
2282     char path[64];
2283     int isbusy = 0;
2284     VolId volumeId;
2285     int checkedOut;
2286 #ifdef AFS_DEMAND_ATTACH_FS
2287     VolumeStats stats_save;
2288     Volume *svp = NULL;
2289 #endif /* AFS_DEMAND_ATTACH_FS */
2290
2291     *ec = 0;
2292
2293     volumeId = VolumeNumber(name);
2294
2295     if (!(partp = VGetPartition_r(partition, 0))) {
2296         *ec = VNOVOL;
2297         Log("VAttachVolume: Error getting partition (%s)\n", partition);
2298         goto done;
2299     }
2300
2301     if (VRequiresPartLock()) {
2302         osi_Assert(VInit == 3);
2303         VLockPartition_r(partition);
2304     } else if (programType == fileServer) {
2305 #ifdef AFS_DEMAND_ATTACH_FS
2306         /* lookup the volume in the hash table */
2307         vp = VLookupVolume_r(ec, volumeId, NULL);
2308         if (*ec) {
2309             return NULL;
2310         }
2311
2312         if (vp) {
2313             /* save any counters that are supposed to
2314              * be monotonically increasing over the
2315              * lifetime of the fileserver */
2316             memcpy(&stats_save, &vp->stats, sizeof(VolumeStats));
2317         } else {
2318             memset(&stats_save, 0, sizeof(VolumeStats));
2319         }
2320
2321         /* if there's something in the hash table, and it's not
2322          * in the pre-attach state, then we may need to detach
2323          * it before proceeding */
2324         if (vp && (V_attachState(vp) != VOL_STATE_PREATTACHED)) {
2325             VCreateReservation_r(vp);
2326             VWaitExclusiveState_r(vp);
2327
2328             /* at this point state must be one of:
2329              *   - UNATTACHED
2330              *   - ATTACHED
2331              *   - SHUTTING_DOWN
2332              *   - GOING_OFFLINE
2333              *   - SALVAGING
2334              *   - ERROR
2335              *   - DELETED
2336              */
2337
2338             if (vp->specialStatus == VBUSY)
2339                 isbusy = 1;
2340
2341             /* if it's already attached, see if we can return it */
2342             if (V_attachState(vp) == VOL_STATE_ATTACHED) {
2343                 VGetVolumeByVp_r(ec, vp);
2344                 if (V_inUse(vp) == fileServer) {
2345                     VCancelReservation_r(vp);
2346                     return vp;
2347                 }
2348
2349                 /* otherwise, we need to detach, and attempt to re-attach */
2350                 VDetachVolume_r(ec, vp);
2351                 if (*ec) {
2352                     Log("VAttachVolume: Error detaching old volume instance (%s)\n", name);
2353                 }
2354             } else {
2355                 /* if it isn't fully attached, delete from the hash tables,
2356                    and let the refcounter handle the rest */
2357                 DeleteVolumeFromHashTable(vp);
2358                 DeleteVolumeFromVByPList_r(vp);
2359             }
2360
2361             VCancelReservation_r(vp);
2362             vp = NULL;
2363         }
2364
2365         /* pre-attach volume if it hasn't been done yet */
2366         if (!vp ||
2367             (V_attachState(vp) == VOL_STATE_UNATTACHED) ||
2368             (V_attachState(vp) == VOL_STATE_DELETED) ||
2369             (V_attachState(vp) == VOL_STATE_ERROR)) {
2370             svp = vp;
2371             vp = VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2372             if (*ec) {
2373                 return NULL;
2374             }
2375         }
2376
2377         osi_Assert(vp != NULL);
2378
2379         /* handle pre-attach races
2380          *
2381          * multiple threads can race to pre-attach a volume,
2382          * but we can't let them race beyond that
2383          *
2384          * our solution is to let the first thread to bring
2385          * the volume into an exclusive state win; the other
2386          * threads just wait until it finishes bringing the
2387          * volume online, and then they do a vgetvolumebyvp
2388          */
2389         if (svp && (svp != vp)) {
2390             /* wait for other exclusive ops to finish */
2391             VCreateReservation_r(vp);
2392             VWaitExclusiveState_r(vp);
2393
2394             /* get a heavyweight ref, kill the lightweight ref, and return */
2395             VGetVolumeByVp_r(ec, vp);
2396             VCancelReservation_r(vp);
2397             return vp;
2398         }
2399
2400         /* at this point, we are chosen as the thread to do
2401          * demand attachment for this volume. all other threads
2402          * doing a getvolume on vp->hashid will block until we finish */
2403
2404         /* make sure any old header cache entries are invalidated
2405          * before proceeding */
2406         FreeVolumeHeader(vp);
2407
2408         VChangeState_r(vp, VOL_STATE_ATTACHING);
2409
2410         /* restore any saved counters */
2411         memcpy(&vp->stats, &stats_save, sizeof(VolumeStats));
2412 #else /* AFS_DEMAND_ATTACH_FS */
2413         vp = VGetVolume_r(ec, volumeId);
2414         if (vp) {
2415             if (V_inUse(vp) == fileServer)
2416                 return vp;
2417             if (vp->specialStatus == VBUSY)
2418                 isbusy = 1;
2419             VDetachVolume_r(ec, vp);
2420             if (*ec) {
2421                 Log("VAttachVolume: Error detaching volume (%s)\n", name);
2422             }
2423             vp = NULL;
2424         }
2425 #endif /* AFS_DEMAND_ATTACH_FS */
2426     }
2427
2428     *ec = 0;
2429     strcpy(path, VPartitionPath(partp));
2430
2431     VOL_UNLOCK;
2432
2433     strcat(path, OS_DIRSEP);
2434     strcat(path, name);
2435
2436     if (!vp) {
2437       vp = (Volume *) calloc(1, sizeof(Volume));
2438       osi_Assert(vp != NULL);
2439       vp->hashid = volumeId;
2440       vp->device = partp->device;
2441       vp->partition = partp;
2442       queue_Init(&vp->vnode_list);
2443       queue_Init(&vp->rx_call_list);
2444 #ifdef AFS_DEMAND_ATTACH_FS
2445       CV_INIT(&V_attachCV(vp), "vp attach", CV_DEFAULT, 0);
2446 #endif /* AFS_DEMAND_ATTACH_FS */
2447     }
2448
2449     /* attach2 is entered without any locks, and returns
2450      * with vol_glock_mutex held */
2451     vp = attach2(ec, volumeId, path, partp, vp, isbusy, mode, &checkedOut);
2452
2453     if (VCanUseFSSYNC() && vp) {
2454 #ifdef AFS_DEMAND_ATTACH_FS
2455         if ((mode == V_VOLUPD) || (VolumeWriteable(vp) && (mode == V_CLONE))) {
2456             /* mark volume header as in use so that volser crashes lead to a
2457              * salvage attempt */
2458             VUpdateVolume_r(ec, vp, 0);
2459         }
2460         /* for dafs, we should tell the fileserver, except for V_PEEK
2461          * where we know it is not necessary */
2462         if (mode == V_PEEK) {
2463             vp->needsPutBack = 0;
2464         } else {
2465             vp->needsPutBack = VOL_PUTBACK;
2466         }
2467 #else /* !AFS_DEMAND_ATTACH_FS */
2468         /* duplicate computation in fssync.c about whether the server
2469          * takes the volume offline or not.  If the volume isn't
2470          * offline, we must not return it when we detach the volume,
2471          * or the server will abort */
2472         if (mode == V_READONLY || mode == V_PEEK
2473             || (!VolumeWriteable(vp) && (mode == V_CLONE || mode == V_DUMP)))
2474             vp->needsPutBack = 0;
2475         else
2476             vp->needsPutBack = VOL_PUTBACK;
2477 #endif /* !AFS_DEMAND_ATTACH_FS */
2478     }
2479 #ifdef FSSYNC_BUILD_CLIENT
2480     /* Only give back the vol to the fileserver if we checked it out; attach2
2481      * will set checkedOut only if we successfully checked it out from the
2482      * fileserver. */
2483     if (VCanUseFSSYNC() && vp == NULL && checkedOut) {
2484
2485 #ifdef AFS_DEMAND_ATTACH_FS
2486         /* If we couldn't attach but we scheduled a salvage, we already
2487          * notified the fileserver; don't online it now */
2488         if (*ec != VSALVAGING)
2489 #endif /* AFS_DEMAND_ATTACH_FS */
2490         FSYNC_VolOp(volumeId, partition, FSYNC_VOL_ON, 0, NULL);
2491     } else
2492 #endif
2493     if (programType == fileServer && vp) {
2494 #ifdef AFS_DEMAND_ATTACH_FS
2495         /*
2496          * we can get here in cases where we don't "own"
2497          * the volume (e.g. volume owned by a utility).
2498          * short circuit around potential disk header races.
2499          */
2500         if (V_attachState(vp) != VOL_STATE_ATTACHED) {
2501             goto done;
2502         }
2503 #endif
2504         VUpdateVolume_r(ec, vp, 0);
2505         if (*ec) {
2506             Log("VAttachVolume: Error updating volume\n");
2507             if (vp)
2508                 VPutVolume_r(vp);
2509             goto done;
2510         }
2511         if (VolumeWriteable(vp) && V_dontSalvage(vp) == 0) {
2512 #ifndef AFS_DEMAND_ATTACH_FS
2513             /* This is a hack: by temporarily setting the incore
2514              * dontSalvage flag ON, the volume will be put back on the
2515              * Update list (with dontSalvage OFF again).  It will then
2516              * come back in N minutes with DONT_SALVAGE eventually
2517              * set.  This is the way that volumes that have never had
2518              * it set get it set; or that volumes that have been
2519              * offline without DONT SALVAGE having been set also
2520              * eventually get it set */
2521             V_dontSalvage(vp) = DONT_SALVAGE;
2522 #endif /* !AFS_DEMAND_ATTACH_FS */
2523             VAddToVolumeUpdateList_r(ec, vp);
2524             if (*ec) {
2525                 Log("VAttachVolume: Error adding volume to update list\n");
2526                 if (vp)
2527                     VPutVolume_r(vp);
2528                 goto done;
2529             }
2530         }
2531         if (LogLevel)
2532             Log("VOnline:  volume %u (%s) attached and online\n", V_id(vp),
2533                 V_name(vp));
2534     }
2535
2536   done:
2537     if (VRequiresPartLock()) {
2538         VUnlockPartition_r(partition);
2539     }
2540     if (*ec) {
2541 #ifdef AFS_DEMAND_ATTACH_FS
2542         /* attach failed; make sure we're in error state */
2543         if (vp && !VIsErrorState(V_attachState(vp))) {
2544             VChangeState_r(vp, VOL_STATE_ERROR);
2545         }
2546 #endif /* AFS_DEMAND_ATTACH_FS */
2547         return NULL;
2548     } else {
2549         return vp;
2550     }
2551 }
2552
2553 #ifdef AFS_DEMAND_ATTACH_FS
2554 /* VAttachVolumeByVp_r
2555  *
2556  * finish attaching a volume that is
2557  * in a less than fully attached state
2558  */
2559 /* caller MUST hold a ref count on vp */
2560 static Volume *
2561 VAttachVolumeByVp_r(Error * ec, Volume * vp, int mode)
2562 {
2563     char name[VMAXPATHLEN];
2564     int reserve = 0;
2565     struct DiskPartition64 *partp;
2566     char path[64];
2567     int isbusy = 0;
2568     VolId volumeId;
2569     Volume * nvp = NULL;
2570     VolumeStats stats_save;
2571     int checkedOut;
2572     *ec = 0;
2573
2574     /* volume utility should never call AttachByVp */
2575     osi_Assert(programType == fileServer);
2576
2577     volumeId = vp->hashid;
2578     partp = vp->partition;
2579     VolumeExternalName_r(volumeId, name, sizeof(name));
2580
2581
2582     /* if another thread is performing a blocking op, wait */
2583     VWaitExclusiveState_r(vp);
2584
2585     memcpy(&stats_save, &vp->stats, sizeof(VolumeStats));
2586
2587     /* if it's already attached, see if we can return it */
2588     if (V_attachState(vp) == VOL_STATE_ATTACHED) {
2589         VGetVolumeByVp_r(ec, vp);
2590         if (V_inUse(vp) == fileServer) {
2591             return vp;
2592         } else {
2593             if (vp->specialStatus == VBUSY)
2594                 isbusy = 1;
2595             VDetachVolume_r(ec, vp);
2596             if (*ec) {
2597                 Log("VAttachVolume: Error detaching volume (%s)\n", name);
2598             }
2599             vp = NULL;
2600         }
2601     }
2602
2603     /* pre-attach volume if it hasn't been done yet */
2604     if (!vp ||
2605         (V_attachState(vp) == VOL_STATE_UNATTACHED) ||
2606         (V_attachState(vp) == VOL_STATE_DELETED) ||
2607         (V_attachState(vp) == VOL_STATE_ERROR)) {
2608         nvp = VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2609         if (*ec) {
2610             return NULL;
2611         }
2612         if (nvp != vp) {
2613             reserve = 1;
2614             VCreateReservation_r(nvp);
2615             vp = nvp;
2616         }
2617     }
2618
2619     osi_Assert(vp != NULL);
2620     VChangeState_r(vp, VOL_STATE_ATTACHING);
2621
2622     /* restore monotonically increasing stats */
2623     memcpy(&vp->stats, &stats_save, sizeof(VolumeStats));
2624
2625     *ec = 0;
2626
2627     /* compute path to disk header */
2628     strcpy(path, VPartitionPath(partp));
2629
2630     VOL_UNLOCK;
2631
2632     strcat(path, OS_DIRSEP);
2633     strcat(path, name);
2634
2635     /* do volume attach
2636      *
2637      * NOTE: attach2 is entered without any locks, and returns
2638      * with vol_glock_mutex held */
2639     vp = attach2(ec, volumeId, path, partp, vp, isbusy, mode, &checkedOut);
2640
2641     /*
2642      * the event that an error was encountered, or
2643      * the volume was not brought to an attached state
2644      * for any reason, skip to the end.  We cannot
2645      * safely call VUpdateVolume unless we "own" it.
2646      */
2647     if (*ec ||
2648         (vp == NULL) ||
2649         (V_attachState(vp) != VOL_STATE_ATTACHED)) {
2650         goto done;
2651     }
2652
2653     VUpdateVolume_r(ec, vp, 0);
2654     if (*ec) {
2655         Log("VAttachVolume: Error updating volume %u\n", vp->hashid);
2656         VPutVolume_r(vp);
2657         goto done;
2658     }
2659     if (VolumeWriteable(vp) && V_dontSalvage(vp) == 0) {
2660 #ifndef AFS_DEMAND_ATTACH_FS
2661         /* This is a hack: by temporarily setting the incore
2662          * dontSalvage flag ON, the volume will be put back on the
2663          * Update list (with dontSalvage OFF again).  It will then
2664          * come back in N minutes with DONT_SALVAGE eventually
2665          * set.  This is the way that volumes that have never had
2666          * it set get it set; or that volumes that have been
2667          * offline without DONT SALVAGE having been set also
2668          * eventually get it set */
2669         V_dontSalvage(vp) = DONT_SALVAGE;
2670 #endif /* !AFS_DEMAND_ATTACH_FS */
2671         VAddToVolumeUpdateList_r(ec, vp);
2672         if (*ec) {
2673             Log("VAttachVolume: Error adding volume %u to update list\n", vp->hashid);
2674             if (vp)
2675                 VPutVolume_r(vp);
2676             goto done;
2677         }
2678     }
2679     if (LogLevel)
2680         Log("VOnline:  volume %u (%s) attached and online\n", V_id(vp),
2681             V_name(vp));
2682   done:
2683     if (reserve) {
2684         VCancelReservation_r(nvp);
2685         reserve = 0;
2686     }
2687     if (*ec && (*ec != VOFFLINE) && (*ec != VSALVAGE)) {
2688         if (vp && !VIsErrorState(V_attachState(vp))) {
2689             VChangeState_r(vp, VOL_STATE_ERROR);
2690         }
2691         return NULL;
2692     } else {
2693         return vp;
2694     }
2695 }
2696
2697 /**
2698  * lock a volume on disk (non-blocking).
2699  *
2700  * @param[in] vp  The volume to lock
2701  * @param[in] locktype READ_LOCK or WRITE_LOCK
2702  *
2703  * @return operation status
2704  *  @retval 0 success, lock was obtained
2705  *  @retval EBUSY a conflicting lock was held by another process
2706  *  @retval EIO   error acquiring lock
2707  *
2708  * @pre If we're in the fileserver, vp is in an exclusive state
2709  *
2710  * @pre vp is not already locked
2711  */
2712 static int
2713 VLockVolumeNB(Volume *vp, int locktype)
2714 {
2715     int code;
2716
2717     osi_Assert(programType != fileServer || VIsExclusiveState(V_attachState(vp)));
2718     osi_Assert(!(V_attachFlags(vp) & VOL_LOCKED));
2719
2720     code = VLockVolumeByIdNB(vp->hashid, vp->partition, locktype);
2721     if (code == 0) {
2722         V_attachFlags(vp) |= VOL_LOCKED;
2723     }
2724
2725     return code;
2726 }
2727
2728 /**
2729  * unlock a volume on disk that was locked with VLockVolumeNB.
2730  *
2731  * @param[in] vp  volume to unlock
2732  *
2733  * @pre If we're in the fileserver, vp is in an exclusive state
2734  *
2735  * @pre vp has already been locked
2736  */
2737 static void
2738 VUnlockVolume(Volume *vp)
2739 {
2740     osi_Assert(programType != fileServer || VIsExclusiveState(V_attachState(vp)));
2741     osi_Assert((V_attachFlags(vp) & VOL_LOCKED));
2742
2743     VUnlockVolumeById(vp->hashid, vp->partition);
2744
2745     V_attachFlags(vp) &= ~VOL_LOCKED;
2746 }
2747 #endif /* AFS_DEMAND_ATTACH_FS */
2748
2749 /**
2750  * read in a vol header, possibly lock the vol header, and possibly check out
2751  * the vol header from the fileserver, as part of volume attachment.
2752  *
2753  * @param[out] ec     error code
2754  * @param[in] vp      volume pointer object
2755  * @param[in] partp   disk partition object of the attaching partition
2756  * @param[in] mode    attachment mode such as V_VOLUPD, V_DUMP, etc (see
2757  *                    volume.h)
2758  * @param[in] peek    1 to just try to read in the volume header and make sure
2759  *                    we don't try to lock the vol, or check it out from
2760  *                    FSSYNC or anything like that; 0 otherwise, for 'normal'
2761  *                    operation
2762  * @param[out] acheckedOut   If we successfully checked-out the volume from
2763  *                           the fileserver (if we needed to), this is set
2764  *                           to 1, otherwise it is untouched.
2765  *
2766  * @note As part of DAFS volume attachment, the volume header may be either
2767  *       read- or write-locked to ensure mutual exclusion of certain volume
2768  *       operations. In some cases in order to determine whether we need to
2769  *       read- or write-lock the header, we need to read in the header to see
2770  *       if the volume is RW or not. So, if we read in the header under a
2771  *       read-lock and determine that we actually need a write-lock on the
2772  *       volume header, this function will drop the read lock, acquire a write
2773  *       lock, and read the header in again.
2774  */
2775 static void
2776 attach_volume_header(Error *ec, Volume *vp, struct DiskPartition64 *partp,
2777                      int mode, int peek, int *acheckedOut)
2778 {
2779     struct VolumeDiskHeader diskHeader;
2780     struct VolumeHeader header;
2781     int code;
2782     int first_try = 1;
2783     int lock_tries = 0, checkout_tries = 0;
2784     int retry;
2785     VolumeId volid = vp->hashid;
2786 #ifdef FSSYNC_BUILD_CLIENT
2787     int checkout, done_checkout = 0;
2788 #endif /* FSSYNC_BUILD_CLIENT */
2789 #ifdef AFS_DEMAND_ATTACH_FS
2790     int locktype = 0, use_locktype = -1;
2791 #endif /* AFS_DEMAND_ATTACH_FS */
2792
2793  retry:
2794     retry = 0;
2795     *ec = 0;
2796
2797     if (lock_tries > VOL_MAX_CHECKOUT_RETRIES) {
2798         Log("VAttachVolume: retried too many times trying to lock header for "
2799             "vol %lu part %s; giving up\n", afs_printable_uint32_lu(volid),
2800             VPartitionPath(partp));
2801         *ec = VNOVOL;
2802         goto done;
2803     }
2804     if (checkout_tries > VOL_MAX_CHECKOUT_RETRIES) {
2805         Log("VAttachVolume: retried too many times trying to checkout "
2806             "vol %lu part %s; giving up\n", afs_printable_uint32_lu(volid),
2807             VPartitionPath(partp));
2808         *ec = VNOVOL;
2809         goto done;
2810     }
2811
2812     if (VReadVolumeDiskHeader(volid, partp, NULL)) {
2813         /* short-circuit the 'volume does not exist' case */
2814         *ec = VNOVOL;
2815         goto done;
2816     }
2817
2818 #ifdef FSSYNC_BUILD_CLIENT
2819     checkout = !done_checkout;
2820     done_checkout = 1;
2821     if (!peek && checkout && VMustCheckoutVolume(mode)) {
2822         SYNC_response res;
2823         memset(&res, 0, sizeof(res));
2824
2825         if (FSYNC_VolOp(volid, VPartitionPath(partp), FSYNC_VOL_NEEDVOLUME, mode, &res)
2826             != SYNC_OK) {
2827
2828             if (res.hdr.reason == FSYNC_SALVAGE) {
2829                 Log("VAttachVolume: file server says volume %lu is salvaging\n",
2830                      afs_printable_uint32_lu(volid));
2831                 *ec = VSALVAGING;
2832             } else {
2833                 Log("VAttachVolume: attach of volume %lu apparently denied by file server\n",
2834                      afs_printable_uint32_lu(volid));
2835                 *ec = VNOVOL;   /* XXXX */
2836             }
2837             goto done;
2838         }
2839         *acheckedOut = 1;
2840     }
2841 #endif
2842
2843 #ifdef AFS_DEMAND_ATTACH_FS
2844     if (use_locktype < 0) {
2845         /* don't know whether vol is RO or RW; assume it's RO and we can retry
2846          * if it turns out to be RW */
2847         locktype = VVolLockType(mode, 0);
2848
2849     } else {
2850         /* a previous try says we should use use_locktype to lock the volume,
2851          * so use that */
2852         locktype = use_locktype;
2853     }
2854
2855     if (!peek && locktype) {
2856         code = VLockVolumeNB(vp, locktype);
2857         if (code) {
2858             if (code == EBUSY) {
2859                 Log("VAttachVolume: another program has vol %lu locked\n",
2860                     afs_printable_uint32_lu(volid));
2861             } else {
2862                 Log("VAttachVolume: error %d trying to lock vol %lu\n",
2863                     code, afs_printable_uint32_lu(volid));
2864             }
2865
2866             *ec = VNOVOL;
2867             goto done;
2868         }
2869     }
2870 #endif /* AFS_DEMAND_ATTACH_FS */
2871
2872     code = VReadVolumeDiskHeader(volid, partp, &diskHeader);
2873     if (code) {
2874         if (code == EIO) {
2875             *ec = VSALVAGE;
2876         } else {
2877             *ec = VNOVOL;
2878         }
2879         goto done;
2880     }
2881
2882     DiskToVolumeHeader(&header, &diskHeader);
2883
2884     IH_INIT(vp->vnodeIndex[vLarge].handle, partp->device, header.parent,
2885             header.largeVnodeIndex);
2886     IH_INIT(vp->vnodeIndex[vSmall].handle, partp->device, header.parent,
2887             header.smallVnodeIndex);
2888     IH_INIT(vp->diskDataHandle, partp->device, header.parent,
2889             header.volumeInfo);
2890     IH_INIT(vp->linkHandle, partp->device, header.parent, header.linkTable);
2891
2892     if (first_try) {
2893         /* only need to do this once */
2894         VOL_LOCK;
2895         GetVolumeHeader(vp);
2896         VOL_UNLOCK;
2897     }
2898
2899 #if defined(AFS_DEMAND_ATTACH_FS) && defined(FSSYNC_BUILD_CLIENT)
2900     /* demand attach changes the V_PEEK mechanism
2901      *
2902      * we can now suck the current disk data structure over
2903      * the fssync interface without going to disk
2904      *
2905      * (technically, we don't need to restrict this feature
2906      *  to demand attach fileservers.  However, I'm trying
2907      *  to limit the number of common code changes)
2908      */
2909     if (VCanUseFSSYNC() && (mode == V_PEEK || peek)) {
2910         SYNC_response res;
2911         res.payload.len = sizeof(VolumeDiskData);
2912         res.payload.buf = &vp->header->diskstuff;
2913
2914         if (FSYNC_VolOp(vp->hashid,
2915                         partp->name,
2916                         FSYNC_VOL_QUERY_HDR,
2917                         FSYNC_WHATEVER,
2918                         &res) == SYNC_OK) {
2919             goto disk_header_loaded;
2920         }
2921     }
2922 #endif /* AFS_DEMAND_ATTACH_FS && FSSYNC_BUILD_CLIENT */
2923     (void)ReadHeader(ec, V_diskDataHandle(vp), (char *)&V_disk(vp),
2924                      sizeof(V_disk(vp)), VOLUMEINFOMAGIC, VOLUMEINFOVERSION);
2925
2926 #ifdef AFS_DEMAND_ATTACH_FS
2927     /* update stats */
2928     VOL_LOCK;
2929     IncUInt64(&VStats.hdr_loads);
2930     IncUInt64(&vp->stats.hdr_loads);
2931     VOL_UNLOCK;
2932 #endif /* AFS_DEMAND_ATTACH_FS */
2933
2934     if (*ec) {
2935         Log("VAttachVolume: Error reading diskDataHandle header for vol %lu; "
2936             "error=%u\n", afs_printable_uint32_lu(volid), *ec);
2937         goto done;
2938     }
2939
2940 #ifdef AFS_DEMAND_ATTACH_FS
2941 # ifdef FSSYNC_BUILD_CLIENT
2942  disk_header_loaded:
2943 # endif /* FSSYNC_BUILD_CLIENT */
2944
2945     /* if the lock type we actually used to lock the volume is different than
2946      * the lock type we should have used, retry with the lock type we should
2947      * use */
2948     use_locktype = VVolLockType(mode, VolumeWriteable(vp));
2949     if (locktype != use_locktype) {
2950         retry = 1;
2951         lock_tries++;
2952     }
2953 #endif /* AFS_DEMAND_ATTACH_FS */
2954
2955     *ec = 0;
2956
2957  done:
2958 #if defined(AFS_DEMAND_ATTACH_FS) && defined(FSSYNC_BUILD_CLIENT)
2959     if (!peek && *ec == 0 && retry == 0 && VMustCheckoutVolume(mode)) {
2960
2961         code = FSYNC_VerifyCheckout(volid, VPartitionPath(partp), FSYNC_VOL_NEEDVOLUME, mode);
2962
2963         if (code == SYNC_DENIED) {
2964             /* must retry checkout; fileserver no longer thinks we have
2965              * the volume */
2966             retry = 1;
2967             checkout_tries++;
2968             done_checkout = 0;
2969
2970         } else if (code != SYNC_OK) {
2971             *ec = VNOVOL;
2972         }
2973     }
2974 #endif /* AFS_DEMAND_ATTACH_FS && FSSYNC_BUILD_CLIENT */
2975
2976     if (*ec || retry) {
2977         /* either we are going to be called again for a second pass, or we
2978          * encountered an error; clean up in either case */
2979
2980 #ifdef AFS_DEMAND_ATTACH_FS
2981         if ((V_attachFlags(vp) & VOL_LOCKED)) {
2982             VUnlockVolume(vp);
2983         }
2984 #endif /* AFS_DEMAND_ATTACH_FS */
2985         if (vp->linkHandle) {
2986             IH_RELEASE(vp->vnodeIndex[vLarge].handle);
2987             IH_RELEASE(vp->vnodeIndex[vSmall].handle);
2988             IH_RELEASE(vp->diskDataHandle);
2989             IH_RELEASE(vp->linkHandle);
2990         }
2991     }
2992
2993     if (*ec) {
2994         return;
2995     }
2996     if (retry) {
2997         first_try = 0;
2998         goto retry;
2999     }
3000 }
3001
3002 #ifdef AFS_DEMAND_ATTACH_FS
3003 static void
3004 attach_check_vop(Error *ec, VolumeId volid, struct DiskPartition64 *partp,
3005                  Volume *vp, int *acheckedOut)
3006 {
3007     *ec = 0;
3008
3009     if (vp->pending_vol_op) {
3010
3011         VOL_LOCK;
3012
3013         if (vp->pending_vol_op->vol_op_state == FSSYNC_VolOpRunningUnknown) {
3014             int code;
3015             code = VVolOpLeaveOnlineNoHeader_r(vp, vp->pending_vol_op);
3016             if (code == 1) {
3017                 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
3018             } else if (code == 0) {
3019                 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline;
3020
3021             } else {
3022                 /* we need the vol header to determine if the volume can be
3023                  * left online for the vop, so... get the header */
3024
3025                 VOL_UNLOCK;
3026
3027                 /* attach header with peek=1 to avoid checking out the volume
3028                  * or locking it; we just want the header info, we're not
3029                  * messing with the volume itself at all */
3030                 attach_volume_header(ec, vp, partp, V_PEEK, 1, acheckedOut);
3031                 if (*ec) {
3032                     return;
3033                 }
3034
3035                 VOL_LOCK;
3036
3037                 if (VVolOpLeaveOnline_r(vp, vp->pending_vol_op)) {
3038                     vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
3039                 } else {
3040                     vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline;
3041                 }
3042
3043                 /* make sure we grab a new vol header and re-open stuff on
3044                  * actual attachment; we can't keep the data we grabbed, since
3045                  * it was not done under a lock and thus not safe */
3046                 FreeVolumeHeader(vp);
3047                 VReleaseVolumeHandles_r(vp);
3048             }
3049         }
3050         /* see if the pending volume op requires exclusive access */
3051         switch (vp->pending_vol_op->vol_op_state) {
3052         case FSSYNC_VolOpPending:
3053             /* this should never happen */
3054             osi_Assert(vp->pending_vol_op->vol_op_state != FSSYNC_VolOpPending);
3055             break;
3056
3057         case FSSYNC_VolOpRunningUnknown:
3058             /* this should never happen; we resolved 'unknown' above */
3059             osi_Assert(vp->pending_vol_op->vol_op_state != FSSYNC_VolOpRunningUnknown);
3060             break;
3061
3062         case FSSYNC_VolOpRunningOffline:
3063             /* mark the volume down */
3064             *ec = VOFFLINE;
3065             VChangeState_r(vp, VOL_STATE_UNATTACHED);
3066
3067             /* do not set V_offlineMessage here; we don't have ownership of
3068              * the volume (and probably do not have the header loaded), so we
3069              * can't alter the disk header */
3070
3071             /* check to see if we should set the specialStatus flag */
3072             if (VVolOpSetVBusy_r(vp, vp->pending_vol_op)) {
3073                 vp->specialStatus = VBUSY;
3074             }
3075             break;
3076
3077         default:
3078             break;
3079         }
3080
3081         VOL_UNLOCK;
3082     }
3083 }
3084 #endif /* AFS_DEMAND_ATTACH_FS */
3085
3086 /**
3087  * volume attachment helper function.
3088  *
3089  * @param[out] ec      error code
3090  * @param[in] volumeId volume ID of the attaching volume
3091  * @param[in] path     full path to the volume header .vol file
3092  * @param[in] partp    disk partition object for the attaching partition
3093  * @param[in] vp       volume object; vp->hashid, vp->device, vp->partition,
3094  *                     vp->vnode_list, vp->rx_call_list, and V_attachCV (for
3095  *                     DAFS) should already be initialized
3096  * @param[in] isbusy   1 if vp->specialStatus should be set to VBUSY; that is,
3097  *                     if there is a volume operation running for this volume
3098  *                     that should set the volume to VBUSY during its run. 0
3099  *                     otherwise. (see VVolOpSetVBusy_r)
3100  * @param[in] mode     attachment mode such as V_VOLUPD, V_DUMP, etc (see
3101  *                     volume.h)
3102  * @param[out] acheckedOut   If we successfully checked-out the volume from
3103  *                           the fileserver (if we needed to), this is set
3104  *                           to 1, otherwise it is 0.
3105  *
3106  * @return pointer to the semi-attached volume pointer
3107  *  @retval NULL an error occurred (check value of *ec)
3108  *  @retval vp volume successfully attaching
3109  *
3110  * @pre no locks held
3111  *
3112  * @post VOL_LOCK held
3113  */
3114 static Volume *
3115 attach2(Error * ec, VolId volumeId, char *path, struct DiskPartition64 *partp,
3116         Volume * vp, int isbusy, int mode, int *acheckedOut)
3117 {
3118     /* have we read in the header successfully? */
3119     int read_header = 0;
3120
3121 #ifdef AFS_DEMAND_ATTACH_FS
3122     /* should we FreeVolume(vp) instead of VCheckFree(vp) in the error
3123      * cleanup? */
3124     int forcefree = 0;
3125
3126     /* in the case of an error, to what state should the volume be
3127      * transitioned? */
3128     VolState error_state = VOL_STATE_ERROR;
3129 #endif /* AFS_DEMAND_ATTACH_FS */
3130
3131     *ec = 0;
3132
3133     vp->vnodeIndex[vLarge].handle = NULL;
3134     vp->vnodeIndex[vSmall].handle = NULL;
3135     vp->diskDataHandle = NULL;
3136     vp->linkHandle = NULL;
3137
3138     *acheckedOut = 0;
3139
3140 #ifdef AFS_DEMAND_ATTACH_FS
3141     attach_check_vop(ec, volumeId, partp, vp, acheckedOut);
3142     if (!*ec) {
3143         attach_volume_header(ec, vp, partp, mode, 0, acheckedOut);
3144     }
3145 #else
3146     attach_volume_header(ec, vp, partp, mode, 0, acheckedOut);
3147 #endif /* !AFS_DEMAND_ATTACH_FS */
3148
3149     if (*ec == VNOVOL) {
3150         /* if the volume doesn't exist, skip straight to 'error' so we don't
3151          * request a salvage */
3152         goto unlocked_error;
3153     }
3154
3155     if (!*ec) {
3156         read_header = 1;
3157
3158         vp->specialStatus = (byte) (isbusy ? VBUSY : 0);
3159         vp->shuttingDown = 0;
3160         vp->goingOffline = 0;
3161         vp->nUsers = 1;
3162 #ifdef AFS_DEMAND_ATTACH_FS
3163         vp->stats.last_attach = FT_ApproxTime();
3164         vp->stats.attaches++;
3165 #endif
3166
3167         VOL_LOCK;
3168         IncUInt64(&VStats.attaches);
3169         vp->cacheCheck = ++VolumeCacheCheck;
3170         /* just in case this ever rolls over */
3171         if (!vp->cacheCheck)
3172             vp->cacheCheck = ++VolumeCacheCheck;
3173         VOL_UNLOCK;
3174
3175 #ifdef AFS_DEMAND_ATTACH_FS
3176         V_attachFlags(vp) |= VOL_HDR_LOADED;
3177         vp->stats.last_hdr_load = vp->stats.last_attach;
3178 #endif /* AFS_DEMAND_ATTACH_FS */
3179     }
3180
3181     if (!*ec) {
3182         struct IndexFileHeader iHead;
3183
3184 #if OPENAFS_VOL_STATS
3185         /*
3186          * We just read in the diskstuff part of the header.  If the detailed
3187          * volume stats area has not yet been initialized, we should bzero the
3188          * area and mark it as initialized.
3189          */
3190         if (!(V_stat_initialized(vp))) {
3191             memset((V_stat_area(vp)), 0, VOL_STATS_BYTES);
3192             V_stat_initialized(vp) = 1;
3193         }
3194 #endif /* OPENAFS_VOL_STATS */
3195
3196         (void)ReadHeader(ec, vp->vnodeIndex[vSmall].handle,
3197                          (char *)&iHead, sizeof(iHead),
3198                          SMALLINDEXMAGIC, SMALLINDEXVERSION);
3199
3200         if (*ec) {
3201             Log("VAttachVolume: Error reading smallVnode vol header %s; error=%u\n", path, *ec);
3202         }
3203     }
3204
3205     if (!*ec) {
3206         struct IndexFileHeader iHead;
3207
3208         (void)ReadHeader(ec, vp->vnodeIndex[vLarge].handle,
3209                          (char *)&iHead, sizeof(iHead),
3210                          LARGEINDEXMAGIC, LARGEINDEXVERSION);
3211
3212         if (*ec) {
3213             Log("VAttachVolume: Error reading largeVnode vol header %s; error=%u\n", path, *ec);
3214         }
3215     }
3216
3217 #ifdef AFS_NAMEI_ENV
3218     if (!*ec) {
3219         struct versionStamp stamp;
3220
3221         (void)ReadHeader(ec, V_linkHandle(vp), (char *)&stamp,
3222                          sizeof(stamp), LINKTABLEMAGIC, LINKTABLEVERSION);
3223
3224         if (*ec) {
3225             Log("VAttachVolume: Error reading namei vol header %s; error=%u\n", path, *ec);
3226         }
3227     }
3228 #endif /* AFS_NAMEI_ENV */
3229
3230 #if defined(AFS_DEMAND_ATTACH_FS)
3231     if (*ec && ((*ec != VOFFLINE) || (V_attachState(vp) != VOL_STATE_UNATTACHED))) {
3232         VOL_LOCK;
3233         if (!VCanScheduleSalvage()) {
3234             Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3235         }
3236         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3237                                                   VOL_SALVAGE_NO_OFFLINE);
3238         vp->nUsers = 0;
3239
3240         goto locked_error;
3241     } else if (*ec) {
3242         /* volume operation in progress */
3243         goto unlocked_error;
3244     }
3245 #else /* AFS_DEMAND_ATTACH_FS */
3246     if (*ec) {
3247         Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3248         goto unlocked_error;
3249     }
3250 #endif /* AFS_DEMAND_ATTACH_FS */
3251
3252     if (V_needsSalvaged(vp)) {
3253         if (vp->specialStatus)
3254             vp->specialStatus = 0;
3255         VOL_LOCK;
3256 #if defined(AFS_DEMAND_ATTACH_FS)
3257         if (!VCanScheduleSalvage()) {
3258             Log("VAttachVolume: volume salvage flag is ON for %s; volume needs salvage\n", path);
3259         }
3260         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER |
3261                                                    VOL_SALVAGE_NO_OFFLINE);
3262         vp->nUsers = 0;
3263
3264 #else /* AFS_DEMAND_ATTACH_FS */
3265         *ec = VSALVAGE;
3266 #endif /* AFS_DEMAND_ATTACH_FS */
3267
3268         goto locked_error;
3269     }
3270
3271     VOL_LOCK;
3272     vp->nextVnodeUnique = V_uniquifier(vp);
3273
3274     if (VShouldCheckInUse(mode) && V_inUse(vp) && VolumeWriteable(vp)) {
3275         if (!V_needsSalvaged(vp)) {
3276             V_needsSalvaged(vp) = 1;
3277             VUpdateVolume_r(ec, vp, 0);
3278         }
3279 #if defined(AFS_DEMAND_ATTACH_FS)
3280         if (!VCanScheduleSalvage()) {
3281             Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3282         }
3283         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER |
3284                                                    VOL_SALVAGE_NO_OFFLINE);
3285         vp->nUsers = 0;
3286
3287 #else /* AFS_DEMAND_ATTACH_FS */
3288         Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3289         *ec = VSALVAGE;
3290 #endif /* AFS_DEMAND_ATTACH_FS */
3291
3292         goto locked_error;
3293     }
3294
3295     if (programType == fileServer && V_destroyMe(vp) == DESTROY_ME) {
3296         /* Only check destroyMe if we are the fileserver, since the
3297          * volserver et al sometimes need to work with volumes with
3298          * destroyMe set. Examples are 'temporary' volumes the
3299          * volserver creates, and when we create a volume (destroyMe
3300          * is set on creation; sometimes a separate volserver
3301          * transaction is created to clear destroyMe).
3302          */
3303
3304 #if defined(AFS_DEMAND_ATTACH_FS)
3305         /* schedule a salvage so the volume goes away on disk */
3306         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3307                                                   VOL_SALVAGE_NO_OFFLINE);
3308         VChangeState_r(vp, VOL_STATE_ERROR);
3309         vp->nUsers = 0;
3310         forcefree = 1;
3311 #endif /* AFS_DEMAND_ATTACH_FS */
3312         Log("VAttachVolume: volume %s is junk; it should be destroyed at next salvage\n", path);
3313         *ec = VNOVOL;
3314         goto locked_error;
3315     }
3316
3317     vp->vnodeIndex[vSmall].bitmap = vp->vnodeIndex[vLarge].bitmap = NULL;
3318 #ifndef BITMAP_LATER
3319     if (programType == fileServer && VolumeWriteable(vp)) {
3320         int i;
3321         for (i = 0; i < nVNODECLASSES; i++) {
3322             VGetBitmap_r(ec, vp, i);
3323             if (*ec) {
3324 #ifdef AFS_DEMAND_ATTACH_FS
3325                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3326                                                           VOL_SALVAGE_NO_OFFLINE);
3327                 vp->nUsers = 0;
3328 #endif /* AFS_DEMAND_ATTACH_FS */
3329                 Log("VAttachVolume: error getting bitmap for volume (%s)\n",
3330                     path);
3331                 goto locked_error;
3332             }
3333         }
3334     }
3335 #endif /* BITMAP_LATER */
3336
3337     if (VInit >= 2 && V_needsCallback(vp)) {
3338         if (V_BreakVolumeCallbacks) {
3339             Log("VAttachVolume: Volume %lu was changed externally; breaking callbacks\n",
3340                 afs_printable_uint32_lu(V_id(vp)));
3341             V_needsCallback(vp) = 0;
3342             VOL_UNLOCK;
3343             (*V_BreakVolumeCallbacks) (V_id(vp));
3344             VOL_LOCK;
3345
3346             VUpdateVolume_r(ec, vp, 0);
3347         }
3348 #ifdef FSSYNC_BUILD_CLIENT
3349         else if (VCanUseFSSYNC()) {
3350             afs_int32 fsync_code;
3351
3352             V_needsCallback(vp) = 0;
3353             VOL_UNLOCK;
3354             fsync_code = FSYNC_VolOp(V_id(vp), NULL, FSYNC_VOL_BREAKCBKS, FSYNC_WHATEVER, NULL);
3355             VOL_LOCK;
3356
3357             if (fsync_code) {
3358                 V_needsCallback(vp) = 1;
3359                 Log("Error trying to tell the fileserver to break callbacks for "
3360                     "changed volume %lu; error code %ld\n",
3361                     afs_printable_uint32_lu(V_id(vp)),
3362                     afs_printable_int32_ld(fsync_code));
3363             } else {
3364                 VUpdateVolume_r(ec, vp, 0);
3365             }
3366         }
3367 #endif /* FSSYNC_BUILD_CLIENT */
3368
3369         if (*ec) {
3370             Log("VAttachVolume: error %d clearing needsCallback on volume "
3371                 "%lu; needs salvage\n", (int)*ec,
3372                 afs_printable_uint32_lu(V_id(vp)));
3373 #ifdef AFS_DEMAND_ATTACH_FS
3374             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER |
3375                                                       VOL_SALVAGE_NO_OFFLINE);
3376             vp->nUsers = 0;
3377 #else /* !AFS_DEMAND_ATTACH_FS */
3378             *ec = VSALVAGE;
3379 #endif /* !AFS_DEMAND_ATTACh_FS */
3380             goto locked_error;
3381         }
3382     }
3383
3384     if (programType == fileServer) {
3385         if (vp->specialStatus)
3386             vp->specialStatus = 0;
3387         if (V_blessed(vp) && V_inService(vp) && !V_needsSalvaged(vp)) {
3388             V_inUse(vp) = fileServer;
3389             V_offlineMessage(vp)[0] = '\0';
3390         }
3391         if (!V_inUse(vp)) {
3392             *ec = VNOVOL;
3393 #ifdef AFS_DEMAND_ATTACH_FS
3394             /* Put the vol into PREATTACHED state, so if someone tries to
3395              * access it again, we try to attach, see that we're not blessed,
3396              * and give a VNOVOL error again. Putting it into UNATTACHED state
3397              * would result in a VOFFLINE error instead. */
3398             error_state = VOL_STATE_PREATTACHED;
3399 #endif /* AFS_DEMAND_ATTACH_FS */
3400
3401             /* mimic e.g. GetVolume errors */
3402             if (!V_blessed(vp)) {
3403                 Log("Volume %lu offline: not blessed\n", afs_printable_uint32_lu(V_id(vp)));
3404                 FreeVolumeHeader(vp);
3405             } else if (!V_inService(vp)) {
3406                 Log("Volume %lu offline: not in service\n", afs_printable_uint32_lu(V_id(vp)));
3407                 FreeVolumeHeader(vp);
3408             } else {
3409                 Log("Volume %lu offline: needs salvage\n", afs_printable_uint32_lu(V_id(vp)));
3410                 *ec = VSALVAGE;
3411 #ifdef AFS_DEMAND_ATTACH_FS
3412                 error_state = VOL_STATE_ERROR;
3413                 /* see if we can recover */
3414                 VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_INVALIDATE_HEADER);
3415 #endif
3416             }
3417 #ifdef AFS_DEMAND_ATTACH_FS
3418             vp->nUsers = 0;
3419 #endif
3420             goto locked_error;
3421         }
3422     } else {
3423 #ifdef AFS_DEMAND_ATTACH_FS
3424         if ((mode != V_PEEK) && (mode != V_SECRETLY))
3425             V_inUse(vp) = programType;
3426 #endif /* AFS_DEMAND_ATTACH_FS */
3427         V_checkoutMode(vp) = mode;
3428     }
3429
3430     AddVolumeToHashTable(vp, V_id(vp));
3431 #ifdef AFS_DEMAND_ATTACH_FS
3432     if (VCanUnlockAttached() && (V_attachFlags(vp) & VOL_LOCKED)) {
3433         VUnlockVolume(vp);
3434     }
3435     if ((programType != fileServer) ||
3436         (V_inUse(vp) == fileServer)) {
3437         AddVolumeToVByPList_r(vp);
3438         VLRU_Add_r(vp);
3439         VChangeState_r(vp, VOL_STATE_ATTACHED);
3440     } else {
3441         VChangeState_r(vp, VOL_STATE_UNATTACHED);
3442     }
3443 #endif
3444
3445     return vp;
3446
3447 unlocked_error:
3448     VOL_LOCK;
3449 locked_error:
3450 #ifdef AFS_DEMAND_ATTACH_FS
3451     if (!VIsErrorState(V_attachState(vp))) {
3452         VChangeState_r(vp, error_state);
3453     }
3454 #endif /* AFS_DEMAND_ATTACH_FS */
3455
3456     if (read_header) {
3457         VReleaseVolumeHandles_r(vp);
3458     }
3459
3460 #ifdef AFS_DEMAND_ATTACH_FS
3461     VCheckSalvage(vp);
3462     if (forcefree) {
3463         FreeVolume(vp);
3464     } else {
3465         VCheckFree(vp);
3466     }
3467 #else /* !AFS_DEMAND_ATTACH_FS */
3468     FreeVolume(vp);
3469 #endif /* !AFS_DEMAND_ATTACH_FS */
3470     return NULL;
3471 }
3472
3473 /* Attach an existing volume.
3474    The volume also normally goes online at this time.
3475    An offline volume must be reattached to make it go online.
3476  */
3477
3478 Volume *
3479 VAttachVolume(Error * ec, VolumeId volumeId, int mode)
3480 {
3481     Volume *retVal;
3482     VOL_LOCK;
3483     retVal = VAttachVolume_r(ec, volumeId, mode);
3484     VOL_UNLOCK;
3485     return retVal;
3486 }
3487
3488 Volume *
3489 VAttachVolume_r(Error * ec, VolumeId volumeId, int mode)
3490 {
3491     char *part, *name;
3492     VGetVolumePath(ec, volumeId, &part, &name);
3493     if (*ec) {
3494         Volume *vp;
3495         Error error;
3496         vp = VGetVolume_r(&error, volumeId);
3497         if (vp) {
3498             osi_Assert(V_inUse(vp) == 0);
3499             VDetachVolume_r(ec, vp);
3500         }
3501         return NULL;
3502     }
3503     return VAttachVolumeByName_r(ec, part, name, mode);
3504 }
3505
3506 /* Increment a reference count to a volume, sans context swaps.  Requires
3507  * possibly reading the volume header in from the disk, since there's
3508  * an invariant in the volume package that nUsers>0 ==> vp->header is valid.
3509  *
3510  * N.B. This call can fail if we can't read in the header!!  In this case
3511  * we still guarantee we won't context swap, but the ref count won't be
3512  * incremented (otherwise we'd violate the invariant).
3513  */
3514 /* NOTE: with the demand attach fileserver extensions, the global lock
3515  * is dropped within VHold */
3516 #ifdef AFS_DEMAND_ATTACH_FS
3517 static int
3518 VHold_r(Volume * vp)
3519 {
3520     Error error;
3521
3522     VCreateReservation_r(vp);
3523     VWaitExclusiveState_r(vp);
3524
3525     LoadVolumeHeader(&error, vp);
3526     if (error) {
3527         VCancelReservation_r(vp);
3528         return error;
3529     }
3530     vp->nUsers++;
3531     VCancelReservation_r(vp);
3532     return 0;
3533 }
3534 #else /* AFS_DEMAND_ATTACH_FS */
3535 static int
3536 VHold_r(Volume * vp)
3537 {
3538     Error error;
3539
3540     LoadVolumeHeader(&error, vp);
3541     if (error)
3542         return error;
3543     vp->nUsers++;
3544     return 0;
3545 }
3546 #endif /* AFS_DEMAND_ATTACH_FS */
3547
3548 /**** volume timeout-related stuff ****/
3549
3550 #ifdef AFS_PTHREAD_ENV
3551
3552 static struct timespec *shutdown_timeout;
3553 static pthread_once_t shutdown_timeout_once = PTHREAD_ONCE_INIT;
3554
3555 static_inline int
3556 VTimedOut(const struct timespec *ts)
3557 {
3558     struct timeval tv;
3559     int code;
3560
3561     if (ts->tv_sec == 0) {
3562         /* short-circuit; this will have always timed out */
3563         return 1;
3564     }
3565
3566     code = gettimeofday(&tv, NULL);
3567     if (code) {
3568         Log("Error %d from gettimeofday, assuming we have not timed out\n", errno);
3569         /* assume no timeout; failure mode is we just wait longer than normal
3570          * instead of returning errors when we shouldn't */
3571         return 0;
3572     }
3573
3574     if (tv.tv_sec < ts->tv_sec ||
3575         (tv.tv_sec == ts->tv_sec && tv.tv_usec*1000 < ts->tv_nsec)) {
3576
3577         return 0;
3578     }
3579
3580     return 1;
3581 }
3582
3583 /**
3584  * Calculate an absolute timeout.
3585  *
3586  * @param[out] ts  A timeout that is "timeout" seconds from now, if we return
3587  *                 NULL, the memory is not touched
3588  * @param[in]  timeout  How long the timeout should be from now
3589  *
3590  * @return timeout to use
3591  *  @retval NULL      no timeout; wait forever
3592  *  @retval non-NULL  the given value for "ts"
3593  *
3594  * @internal
3595  */
3596 static struct timespec *
3597 VCalcTimeout(struct timespec *ts, afs_int32 timeout)
3598 {
3599     struct timeval now;
3600     int code;
3601
3602     if (timeout < 0) {
3603         return NULL;
3604     }
3605
3606     if (timeout == 0) {
3607         ts->tv_sec = ts->tv_nsec = 0;
3608         return ts;
3609     }
3610
3611     code = gettimeofday(&now, NULL);
3612     if (code) {
3613         Log("Error %d from gettimeofday, falling back to 'forever' timeout\n", errno);
3614         return NULL;
3615     }
3616
3617     ts->tv_sec = now.tv_sec + timeout;
3618     ts->tv_nsec = now.tv_usec * 1000;
3619
3620     return ts;
3621 }
3622
3623 /**
3624  * Initialize the shutdown_timeout global.
3625  */
3626 static void
3627 VShutdownTimeoutInit(void)
3628 {
3629     struct timespec *ts;
3630
3631     ts = malloc(sizeof(*ts));
3632
3633     shutdown_timeout = VCalcTimeout(ts, vol_opts.offline_shutdown_timeout);
3634
3635     if (!shutdown_timeout) {
3636         free(ts);
3637     }
3638 }
3639
3640 /**
3641  * Figure out the timeout that should be used for waiting for offline volumes.
3642  *
3643  * @param[out] ats  Storage space for a local timeout value if needed
3644  *
3645  * @return The timeout value that should be used
3646  *   @retval NULL      No timeout; wait forever for offlining volumes
3647  *   @retval non-NULL  A pointer to the absolute time that should be used as
3648  *                     the deadline for waiting for offlining volumes.
3649  *
3650  * @note If we return non-NULL, the pointer we return may or may not be the
3651  *       same as "ats"
3652  */
3653 static const struct timespec *
3654 VOfflineTimeout(struct timespec *ats)
3655 {
3656     if (vol_shutting_down) {
3657         osi_Assert(pthread_once(&shutdown_timeout_once, VShutdownTimeoutInit) == 0);
3658         return shutdown_timeout;
3659     } else {
3660         return VCalcTimeout(ats, vol_opts.offline_timeout);
3661     }
3662 }
3663
3664 #else /* AFS_PTHREAD_ENV */
3665
3666 /* Waiting a certain amount of time for offlining volumes is not supported
3667  * for LWP due to a lack of primitives. So, we never time out */
3668 # define VTimedOut(x) (0)
3669 # define VOfflineTimeout(x) (NULL)
3670
3671 #endif /* !AFS_PTHREAD_ENV */
3672
3673 #if 0
3674 static int
3675 VHold(Volume * vp)
3676 {
3677     int retVal;
3678     VOL_LOCK;
3679     retVal = VHold_r(vp);
3680     VOL_UNLOCK;
3681     return retVal;
3682 }
3683 #endif
3684
3685 static afs_int32
3686 VIsGoingOffline_r(struct Volume *vp)
3687 {
3688     afs_int32 code = 0;
3689
3690     if (vp->goingOffline) {
3691         if (vp->specialStatus) {
3692             code = vp->specialStatus;
3693         } else if (V_inService(vp) == 0 || V_blessed(vp) == 0) {
3694             code = VNOVOL;
3695         } else {
3696             code = VOFFLINE;
3697         }
3698     }
3699
3700     return code;
3701 }
3702
3703 /**
3704  * Tell the caller if a volume is waiting to go offline.
3705  *
3706  * @param[in] vp  The volume we want to know about
3707  *
3708  * @return volume status
3709  *   @retval 0 volume is not waiting to go offline, go ahead and use it
3710  *   @retval nonzero volume is waiting to offline, and give the returned code
3711  *           as an error to anyone accessing the volume
3712  *
3713  * @pre VOL_LOCK is NOT held
3714  * @pre caller holds a heavyweight reference on vp
3715  */
3716 afs_int32
3717 VIsGoingOffline(struct Volume *vp)
3718 {
3719     afs_int32 code;
3720
3721     VOL_LOCK;
3722     code = VIsGoingOffline_r(vp);
3723     VOL_UNLOCK;
3724
3725     return code;
3726 }
3727
3728 /**
3729  * Register an RX call with a volume.
3730  *
3731  * @param[inout] ec        Error code; if unset when passed in, may be set if
3732  *                         the volume starts going offline
3733  * @param[out]   client_ec @see GetVolume
3734  * @param[in] vp   Volume struct
3735  * @param[in] cbv  VCallByVol struct containing the RX call to register
3736  *
3737  * @pre VOL_LOCK held
3738  * @pre caller holds heavy ref on vp
3739  *
3740  * @internal
3741  */
3742 static void
3743 VRegisterCall_r(Error *ec, Error *client_ec, Volume *vp, struct VCallByVol *cbv)
3744 {
3745     if (vp && cbv) {
3746 #ifdef AFS_DEMAND_ATTACH_FS
3747         if (!*ec) {
3748             /* just in case the volume started going offline after we got the
3749              * reference to it... otherwise, if the volume started going
3750              * offline right at the end of GetVolume(), we might race with the
3751              * RX call scanner, and return success and add our cbv to the
3752              * rx_call_list _after_ the scanner has scanned the list. */
3753             *ec = VIsGoingOffline_r(vp);
3754             if (client_ec) {
3755                 *client_ec = *ec;
3756             }
3757         }
3758
3759         while (V_attachState(vp) == VOL_STATE_SCANNING_RXCALLS) {
3760             VWaitStateChange_r(vp);
3761         }
3762 #endif /* AFS_DEMAND_ATTACH_FS */
3763
3764         queue_Prepend(&vp->rx_call_list, cbv);
3765     }
3766 }
3767
3768 /**
3769  * Deregister an RX call with a volume.
3770  *
3771  * @param[in] vp   Volume struct
3772  * @param[in] cbv  VCallByVol struct containing the RX call to deregister
3773  *
3774  * @pre VOL_LOCK held
3775  * @pre caller holds heavy ref on vp
3776  *
3777  * @internal
3778  */
3779 static void
3780 VDeregisterCall_r(Volume *vp, struct VCallByVol *cbv)
3781 {
3782     if (cbv && queue_IsOnQueue(cbv)) {
3783 #ifdef AFS_DEMAND_ATTACH_FS
3784         while (V_attachState(vp) == VOL_STATE_SCANNING_RXCALLS) {
3785             VWaitStateChange_r(vp);
3786         }
3787 #endif /* AFS_DEMAND_ATTACH_FS */
3788
3789         queue_Remove(cbv);
3790     }
3791 }
3792
3793 /***************************************************/
3794 /* get and put volume routines                     */
3795 /***************************************************/
3796
3797 /**
3798  * put back a heavyweight reference to a volume object.
3799  *
3800  * @param[in] vp  volume object pointer
3801  *
3802  * @pre VOL_LOCK held
3803  *
3804  * @post heavyweight volume reference put back.
3805  *       depending on state, volume may have been taken offline,
3806  *       detached, salvaged, freed, etc.
3807  *
3808  * @internal volume package internal use only
3809  */
3810 void
3811 VPutVolume_r(Volume * vp)
3812 {
3813     osi_Assert(--vp->nUsers >= 0);
3814     if (vp->nUsers == 0) {
3815         VCheckOffline(vp);
3816         ReleaseVolumeHeader(vp->header);
3817 #ifdef AFS_DEMAND_ATTACH_FS
3818         if (!VCheckDetach(vp)) {
3819             VCheckSalvage(vp);
3820             VCheckFree(vp);
3821         }
3822 #else /* AFS_DEMAND_ATTACH_FS */
3823         VCheckDetach(vp);
3824 #endif /* AFS_DEMAND_ATTACH_FS */
3825     }
3826 }
3827
3828 void
3829 VPutVolume(Volume * vp)
3830 {
3831     VOL_LOCK;
3832     VPutVolume_r(vp);
3833     VOL_UNLOCK;
3834 }
3835
3836 /**
3837  * Puts a volume reference obtained with VGetVolumeWithCall.
3838  *
3839  * @param[in] vp  Volume struct
3840  * @param[in] cbv VCallByVol struct given to VGetVolumeWithCall, or NULL if none
3841  *
3842  * @pre VOL_LOCK is NOT held
3843  */
3844 void
3845 VPutVolumeWithCall(Volume *vp, struct VCallByVol *cbv)
3846 {
3847     VOL_LOCK;
3848     VDeregisterCall_r(vp, cbv);
3849     VPutVolume_r(vp);
3850     VOL_UNLOCK;
3851 }
3852
3853 /* Get a pointer to an attached volume.  The pointer is returned regardless
3854    of whether or not the volume is in service or on/off line.  An error
3855    code, however, is returned with an indication of the volume's status */
3856 Volume *
3857 VGetVolume(Error * ec, Error * client_ec, VolId volumeId)
3858 {
3859     Volume *retVal;
3860     VOL_LOCK;
3861     retVal = GetVolume(ec, client_ec, volumeId, NULL, 0);
3862     VOL_UNLOCK;
3863     return retVal;
3864 }
3865
3866 /**
3867  * Get a volume reference associated with an RX call.
3868  *
3869  * @param[out] ec @see GetVolume
3870  * @param[out] client_ec @see GetVolume
3871  * @param[in] volumeId @see GetVolume
3872  * @param[in] ts  How long to wait for going-offline volumes (absolute time).
3873  *                If NULL, wait forever. If ts->tv_sec == 0, return immediately
3874  *                with an error if the volume is going offline.
3875  * @param[in] cbv Contains an RX call to be associated with this volume
3876  *                reference. This call may be interrupted if the volume is
3877  *                requested to go offline while we hold a ref on it. Give NULL
3878  *                to not associate an RX call with this reference.
3879  *
3880  * @return @see GetVolume
3881  *
3882  * @note for LWP builds, ts must be NULL
3883  *
3884  * @note A reference obtained with this function MUST be put back with
3885  *       VPutVolumeWithCall
3886  */
3887 Volume *
3888 VGetVolumeWithCall(Error * ec, Error * client_ec, VolId volumeId,
3889                    const struct timespec *ts, struct VCallByVol *cbv)
3890 {
3891     Volume *retVal;
3892     VOL_LOCK;
3893     retVal = GetVolume(ec, client_ec, volumeId, NULL, ts);
3894     VRegisterCall_r(ec, client_ec, retVal, cbv);
3895     VOL_UNLOCK;
3896     return retVal;
3897 }
3898
3899 Volume *
3900 VGetVolume_r(Error * ec, VolId volumeId)
3901 {
3902     return GetVolume(ec, NULL, volumeId, NULL, NULL);
3903 }
3904
3905 /* try to get a volume we've previously looked up */
3906 /* for demand attach fs, caller MUST NOT hold a ref count on vp */
3907 Volume *
3908 VGetVolumeByVp_r(Error * ec, Volume * vp)
3909 {
3910     return GetVolume(ec, NULL, vp->hashid, vp, NULL);
3911 }
3912
3913 /**
3914  * private interface for getting a volume handle
3915  *
3916  * @param[out] ec         error code (0 if no error)
3917  * @param[out] client_ec  wire error code to be given to clients
3918  * @param[in]  volumeId   ID of the volume we want
3919  * @param[in]  hint       optional hint for hash lookups, or NULL
3920  * @param[in]  timeout    absolute deadline for waiting for the volume to go
3921  *                        offline, if it is going offline. NULL to wait forever.
3922  *
3923  * @return a volume handle for the specified volume
3924  *  @retval NULL an error occurred, or the volume is in such a state that
3925  *               we cannot load a header or return any volume struct
3926  *
3927  * @note for DAFS, caller must NOT hold a ref count on 'hint'
3928  *
3929  * @note 'timeout' is only checked if the volume is actually going offline; so
3930  *       if you pass timeout->tv_sec = 0, this will exhibit typical
3931  *       nonblocking behavior.
3932  *
3933  * @note for LWP builds, 'timeout' must be NULL
3934  */
3935 static Volume *
3936 GetVolume(Error * ec, Error * client_ec, VolId volumeId, Volume * hint,
3937           const struct timespec *timeout)
3938 {
3939     Volume *vp = hint;
3940     /* pull this profiling/debugging code out of regular builds */
3941 #ifdef notdef
3942 #define VGET_CTR_INC(x) x++
3943     unsigned short V0 = 0, V1 = 0, V2 = 0, V3 = 0, V5 = 0, V6 =
3944         0, V7 = 0, V8 = 0, V9 = 0;
3945     unsigned short V10 = 0, V11 = 0, V12 = 0, V13 = 0, V14 = 0, V15 = 0;
3946 #else
3947 #define VGET_CTR_INC(x)
3948 #endif
3949 #ifdef AFS_DEMAND_ATTACH_FS
3950     Volume *avp, * rvp = hint;
3951 #endif
3952
3953     /*
3954      * if VInit is zero, the volume package dynamic
3955      * data structures have not been initialized yet,
3956      * and we must immediately return an error
3957      */
3958     if (VInit == 0) {
3959         vp = NULL;
3960         *ec = VOFFLINE;
3961         if (client_ec) {
3962             *client_ec = VOFFLINE;
3963         }
3964         goto not_inited;
3965     }
3966
3967 #ifdef AFS_DEMAND_ATTACH_FS
3968     if (rvp) {
3969         VCreateReservation_r(rvp);
3970     }
3971 #endif /* AFS_DEMAND_ATTACH_FS */
3972
3973     for (;;) {
3974         *ec = 0;
3975         if (client_ec)
3976             *client_ec = 0;
3977         VGET_CTR_INC(V0);
3978
3979         vp = VLookupVolume_r(ec, volumeId, vp);
3980         if (*ec) {
3981             vp = NULL;
3982             break;
3983         }
3984
3985 #ifdef AFS_DEMAND_ATTACH_FS
3986         if (rvp && (rvp != vp)) {
3987             /* break reservation on old vp */
3988             VCancelReservation_r(rvp);
3989             rvp = NULL;
3990         }
3991 #endif /* AFS_DEMAND_ATTACH_FS */
3992
3993         if (!vp) {
3994             VGET_CTR_INC(V1);
3995             if (VInit < 2) {
3996                 VGET_CTR_INC(V2);
3997                 /* Until we have reached an initialization level of 2
3998                  * we don't know whether this volume exists or not.
3999                  * We can't sleep and retry later because before a volume
4000                  * is attached, the caller tries to get it first.  Just
4001                  * return VOFFLINE and the caller can choose whether to
4002                  * retry the command or not. */
4003                 *ec = VOFFLINE;
4004                 break;
4005             }
4006
4007             *ec = VNOVOL;
4008             break;
4009         }
4010
4011         VGET_CTR_INC(V3);
4012         IncUInt64(&VStats.hdr_gets);
4013
4014 #ifdef AFS_DEMAND_ATTACH_FS
4015         /* block if someone else is performing an exclusive op on this volume */
4016         if (rvp != vp) {
4017             rvp = vp;
4018             VCreateReservation_r(rvp);
4019         }
4020         VWaitExclusiveState_r(vp);
4021
4022         /* short circuit with VNOVOL in the following circumstances:
4023          *
4024          *   - VOL_STATE_ERROR
4025          *   - VOL_STATE_SHUTTING_DOWN
4026          */
4027         if ((V_attachState(vp) == VOL_STATE_ERROR) ||
4028             (V_attachState(vp) == VOL_STATE_SHUTTING_DOWN) ||
4029             (V_attachState(vp) == VOL_STATE_GOING_OFFLINE)) {
4030             *ec = VNOVOL;
4031             vp = NULL;
4032             break;
4033         }
4034
4035         /*
4036          * short circuit with VOFFLINE for VOL_STATE_UNATTACHED and
4037          *                    VNOVOL   for VOL_STATE_DELETED
4038          */
4039        if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
4040            (V_attachState(vp) == VOL_STATE_DELETED)) {
4041            if (vp->specialStatus) {
4042                *ec = vp->specialStatus;
4043            } else if (V_attachState(vp) == VOL_STATE_DELETED) {
4044                *ec = VNOVOL;
4045            } else {
4046                *ec = VOFFLINE;
4047            }
4048            vp = NULL;
4049            break;
4050        }
4051
4052         /* allowable states:
4053          *   - PREATTACHED
4054          *   - ATTACHED
4055          *   - SALVAGING
4056          *   - SALVAGE_REQ
4057          */
4058
4059         if (vp->salvage.requested) {
4060             VUpdateSalvagePriority_r(vp);
4061         }
4062
4063         if (V_attachState(vp) == VOL_STATE_PREATTACHED) {
4064             avp = VAttachVolumeByVp_r(ec, vp, 0);
4065             if (avp) {
4066                 if (vp != avp) {
4067                     /* VAttachVolumeByVp_r can return a pointer
4068                      * != the vp passed to it under certain
4069                      * conditions; make sure we don't leak
4070                      * reservations if that happens */
4071                     vp = avp;
4072                     VCancelReservation_r(rvp);
4073                     rvp = avp;
4074                     VCreateReservation_r(rvp);
4075                 }
4076                 VPutVolume_r(avp);
4077             }
4078             if (*ec) {
4079                 int endloop = 0;
4080                 switch (*ec) {
4081                 case VSALVAGING:
4082                     break;
4083                 case VOFFLINE:
4084                     if (!vp->pending_vol_op) {
4085                         endloop = 1;
4086                     }
4087                     break;
4088                 default:
4089                     *ec = VNOVOL;
4090                     endloop = 1;
4091                 }
4092                 if (endloop) {
4093                     vp = NULL;
4094                     break;
4095                 }
4096             }
4097         }
4098
4099         if (VIsSalvaging(vp) || (*ec == VSALVAGING)) {
4100             if (client_ec) {
4101                 /* see CheckVnode() in afsfileprocs.c for an explanation
4102                  * of this error code logic */
4103                 afs_uint32 now = FT_ApproxTime();
4104                 if ((vp->stats.last_salvage + (10 * 60)) >= now) {
4105                     *client_ec = VBUSY;
4106                 } else {
4107                     *client_ec = VRESTARTING;
4108                 }
4109             }
4110             *ec = VSALVAGING;
4111             vp = NULL;
4112             break;
4113         }
4114 #endif
4115
4116 #ifdef AFS_DEMAND_ATTACH_FS
4117         /*
4118          * this test MUST happen after VAttachVolymeByVp, so vol_op_state is
4119          * not VolOpRunningUnknown (attach2 would have converted it to Online
4120          * or Offline)
4121          */
4122
4123          /* only valid before/during demand attachment */
4124          osi_Assert(!vp->pending_vol_op || vp->pending_vol_op->vol_op_state != FSSYNC_VolOpRunningUnknown);
4125
4126          /* deny getvolume due to running mutually exclusive vol op */
4127          if (vp->pending_vol_op && vp->pending_vol_op->vol_op_state==FSSYNC_VolOpRunningOffline) {
4128            /*
4129             * volume cannot remain online during this volume operation.
4130             * notify client.
4131             */
4132            if (vp->specialStatus) {
4133                /*
4134                 * special status codes outrank normal VOFFLINE code
4135                 */
4136                *ec = vp->specialStatus;
4137                if (client_ec) {
4138                    *client_ec = vp->specialStatus;
4139                }
4140            } else {
4141                if (client_ec) {
4142                    /* see CheckVnode() in afsfileprocs.c for an explanation
4143                     * of this error code logic */
4144                    afs_uint32 now = FT_ApproxTime();
4145                    if ((vp->stats.last_vol_op + (10 * 60)) >= now) {
4146                        *client_ec = VBUSY;
4147                    } else {
4148                        *client_ec = VRESTARTING;
4149                    }
4150                }
4151                *ec = VOFFLINE;
4152            }
4153            VChangeState_r(vp, VOL_STATE_UNATTACHED);
4154            FreeVolumeHeader(vp);
4155            vp = NULL;
4156            break;
4157         }
4158 #endif /* AFS_DEMAND_ATTACH_FS */
4159
4160         LoadVolumeHeader(ec, vp);
4161         if (*ec) {
4162             VGET_CTR_INC(V6);
4163             /* Only log the error if it was a totally unexpected error.  Simply
4164              * a missing inode is likely to be caused by the volume being deleted */
4165             if (errno != ENXIO || LogLevel)
4166                 Log("Volume %u: couldn't reread volume header\n",
4167                     vp->hashid);
4168 #ifdef AFS_DEMAND_ATTACH_FS
4169             if (VCanScheduleSalvage()) {
4170                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
4171             } else {
4172                 FreeVolume(vp);
4173                 vp = NULL;
4174             }
4175 #else /* AFS_DEMAND_ATTACH_FS */
4176             FreeVolume(vp);
4177             vp = NULL;
4178 #endif /* AFS_DEMAND_ATTACH_FS */
4179             break;
4180         }
4181
4182         VGET_CTR_INC(V7);
4183         if (vp->shuttingDown) {
4184             VGET_CTR_INC(V8);
4185             *ec = VNOVOL;
4186             vp = NULL;
4187             break;
4188         }
4189
4190         if (programType == fileServer) {
4191             VGET_CTR_INC(V9);
4192             if (vp->goingOffline) {
4193                 if (timeout && VTimedOut(timeout)) {
4194                     /* we've timed out; don't wait for the vol */
4195                 } else {
4196                     VGET_CTR_INC(V10);
4197 #ifdef AFS_DEMAND_ATTACH_FS
4198                     /* wait for the volume to go offline */
4199                     if (V_attachState(vp) == VOL_STATE_GOING_OFFLINE) {
4200                         VTimedWaitStateChange_r(vp, timeout, NULL);
4201                     }
4202 #elif defined(AFS_PTHREAD_ENV)
4203                     VOL_CV_TIMEDWAIT(&vol_put_volume_cond, timeout, NULL);
4204 #else /* AFS_PTHREAD_ENV */
4205                     /* LWP has no timed wait, so the caller better not be
4206                      * expecting one */
4207                     osi_Assert(!timeout);
4208                     LWP_WaitProcess(VPutVolume);
4209 #endif /* AFS_PTHREAD_ENV */
4210                     continue;
4211                 }
4212             }
4213             if (vp->specialStatus) {
4214                 VGET_CTR_INC(V11);
4215                 *ec = vp->specialStatus;
4216             } else if (V_inService(vp) == 0 || V_blessed(vp) == 0) {
4217                 VGET_CTR_INC(V12);
4218                 *ec = VNOVOL;
4219             } else if (V_inUse(vp) == 0 || vp->goingOffline) {
4220                 VGET_CTR_INC(V13);
4221                 *ec = VOFFLINE;
4222             } else {
4223                 VGET_CTR_INC(V14);
4224             }
4225         }
4226         break;
4227     }
4228     VGET_CTR_INC(V15);
4229
4230 #ifdef AFS_DEMAND_ATTACH_FS
4231     /* if no error, bump nUsers */
4232     if (vp) {
4233         vp->nUsers++;
4234         VLRU_UpdateAccess_r(vp);
4235     }
4236     if (rvp) {
4237         VCancelReservation_r(rvp);
4238         rvp = NULL;
4239     }
4240     if (client_ec && !*client_ec) {
4241         *client_ec = *ec;
4242     }
4243 #else /* AFS_DEMAND_ATTACH_FS */
4244     /* if no error, bump nUsers */
4245     if (vp) {
4246         vp->nUsers++;
4247     }
4248     if (client_ec) {
4249         *client_ec = *ec;
4250     }
4251 #endif /* AFS_DEMAND_ATTACH_FS */
4252
4253  not_inited:
4254     osi_Assert(vp || *ec);
4255     return vp;
4256 }
4257
4258
4259 /***************************************************/
4260 /* Volume offline/detach routines                  */
4261 /***************************************************/
4262
4263 /* caller MUST hold a heavyweight ref on vp */
4264 #ifdef AFS_DEMAND_ATTACH_FS
4265 void
4266 VTakeOffline_r(Volume * vp)
4267 {
4268     Error error;
4269
4270     osi_Assert(vp->nUsers > 0);
4271     osi_Assert(programType == fileServer);
4272
4273     VCreateReservation_r(vp);
4274     VWaitExclusiveState_r(vp);
4275
4276     vp->goingOffline = 1;
4277     V_needsSalvaged(vp) = 1;
4278
4279     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0);
4280     VCancelReservation_r(vp);
4281 }
4282 #else /* AFS_DEMAND_ATTACH_FS */
4283 void
4284 VTakeOffline_r(Volume * vp)
4285 {
4286     osi_Assert(vp->nUsers > 0);
4287     osi_Assert(programType == fileServer);
4288
4289     vp->goingOffline = 1;
4290     V_needsSalvaged(vp) = 1;
4291 }
4292 #endif /* AFS_DEMAND_ATTACH_FS */
4293
4294 void
4295 VTakeOffline(Volume * vp)
4296 {
4297     VOL_LOCK;
4298     VTakeOffline_r(vp);
4299     VOL_UNLOCK;
4300 }
4301
4302 /**
4303  * force a volume offline.
4304  *
4305  * @param[in] vp     volume object pointer
4306  * @param[in] flags  flags (see note below)
4307  *
4308  * @note the flag VOL_FORCEOFF_NOUPDATE is a recursion control flag
4309  *       used when VUpdateVolume_r needs to call VForceOffline_r
4310  *       (which in turn would normally call VUpdateVolume_r)
4311  *
4312  * @see VUpdateVolume_r
4313  *
4314  * @pre VOL_LOCK must be held.
4315  *      for DAFS, caller must hold ref.
4316  *
4317  * @note for DAFS, it _is safe_ to call this function from an
4318  *       exclusive state
4319  *
4320  * @post needsSalvaged flag is set.
4321  *       for DAFS, salvage is requested.
4322  *       no further references to the volume through the volume
4323  *       package will be honored.
4324  *       all file descriptor and vnode caches are invalidated.
4325  *
4326  * @warning this is a heavy-handed interface.  it results in
4327  *          a volume going offline regardless of the current
4328  *          reference count state.
4329  *
4330  * @internal  volume package internal use only
4331  */
4332 void
4333 VForceOffline_r(Volume * vp, int flags)
4334 {
4335     Error error;
4336     if (!V_inUse(vp)) {
4337 #ifdef AFS_DEMAND_ATTACH_FS
4338         VChangeState_r(vp, VOL_STATE_ERROR);
4339 #endif
4340         return;
4341     }
4342
4343     strcpy(V_offlineMessage(vp),
4344            "Forced offline due to internal error: volume needs to be salvaged");
4345     Log("Volume %u forced offline:  it needs salvaging!\n", V_id(vp));
4346
4347     V_inUse(vp) = 0;
4348     vp->goingOffline = 0;
4349     V_needsSalvaged(vp) = 1;
4350     if (!(flags & VOL_FORCEOFF_NOUPDATE)) {
4351         VUpdateVolume_r(&error, vp, VOL_UPDATE_NOFORCEOFF);
4352     }
4353
4354 #ifdef AFS_DEMAND_ATTACH_FS
4355     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, VOL_SALVAGE_INVALIDATE_HEADER);
4356 #endif /* AFS_DEMAND_ATTACH_FS */
4357
4358 #ifdef AFS_PTHREAD_ENV
4359     CV_BROADCAST(&vol_put_volume_cond);
4360 #else /* AFS_PTHREAD_ENV */
4361     LWP_NoYieldSignal(VPutVolume);
4362 #endif /* AFS_PTHREAD_ENV */
4363
4364     VReleaseVolumeHandles_r(vp);
4365 }
4366
4367 /**
4368  * force a volume offline.
4369  *
4370  * @param[in] vp  volume object pointer
4371  *
4372  * @see VForceOffline_r
4373  */
4374 void
4375 VForceOffline(Volume * vp)
4376 {
4377     VOL_LOCK;
4378     VForceOffline_r(vp, 0);
4379     VOL_UNLOCK;
4380 }
4381
4382 /**
4383  * Iterate over the RX calls associated with a volume, and interrupt them.
4384  *
4385  * @param[in] vp The volume whose RX calls we want to scan
4386  *
4387  * @pre VOL_LOCK held
4388  */
4389 static void
4390 VScanCalls_r(struct Volume *vp)
4391 {
4392     struct VCallByVol *cbv, *ncbv;
4393     afs_int32 err;
4394 #ifdef AFS_DEMAND_ATTACH_FS
4395     VolState state_save;
4396 #endif
4397
4398     if (queue_IsEmpty(&vp->rx_call_list))
4399         return; /* no calls to interrupt */
4400     if (!vol_opts.interrupt_rxcall)
4401         return; /* we have no function with which to interrupt calls */
4402     err = VIsGoingOffline_r(vp);
4403     if (!err)
4404         return; /* we're not going offline anymore */
4405
4406 #ifdef AFS_DEMAND_ATTACH_FS
4407     VWaitExclusiveState_r(vp);
4408     state_save = VChangeState_r(vp, VOL_STATE_SCANNING_RXCALLS);
4409     VOL_UNLOCK;
4410 #endif /* AFS_DEMAND_ATTACH_FS */
4411
4412     for(queue_Scan(&vp->rx_call_list, cbv, ncbv, VCallByVol)) {
4413         if (LogLevel > 0) {
4414             struct rx_peer *peer;
4415             char hoststr[16];
4416             peer = rx_PeerOf(rx_ConnectionOf(cbv->call));
4417
4418             Log("Offlining volume %lu while client %s:%u is trying to read "
4419                 "from it; kicking client off with error %ld\n",
4420                 (long unsigned) vp->hashid,
4421                 afs_inet_ntoa_r(rx_HostOf(peer), hoststr),
4422                 (unsigned) ntohs(rx_PortOf(peer)),
4423                 (long) err);
4424         }
4425         (*vol_opts.interrupt_rxcall) (cbv->call, err);
4426     }
4427
4428 #ifdef AFS_DEMAND_ATTACH_FS
4429     VOL_LOCK;
4430     VChangeState_r(vp, state_save);
4431 #endif /* AFS_DEMAND_ATTACH_FS */
4432 }
4433
4434 #ifdef AFS_DEMAND_ATTACH_FS
4435 /**
4436  * Wait for a vp to go offline.
4437  *
4438  * @param[out] ec 1 if a salvage on the volume has been requested and
4439  *                salvok == 0, 0 otherwise
4440  * @param[in] vp  The volume to wait for
4441  * @param[in] salvok  If 0, we return immediately with *ec = 1 if the volume
4442  *                    has been requested to salvage. Otherwise we keep waiting
4443  *                    until the volume has gone offline.
4444  *
4445  * @pre VOL_LOCK held
4446  * @pre caller holds a lightweight ref on vp
4447  *
4448  * @note DAFS only
4449  */
4450 static void
4451 VWaitForOfflineByVp_r(Error *ec, struct Volume *vp, int salvok)
4452 {
4453     struct timespec timeout_ts;
4454     const struct timespec *ts;
4455     int timedout = 0;
4456
4457     ts = VOfflineTimeout(&timeout_ts);
4458
4459     *ec = 0;
4460
4461     while (!VIsOfflineState(V_attachState(vp)) && !timedout) {
4462         if (!salvok && vp->salvage.requested) {
4463             *ec = 1;
4464             return;
4465         }
4466         VTimedWaitStateChange_r(vp, ts, &timedout);
4467     }
4468     if (!timedout) {
4469         /* we didn't time out, so the volume must be offline, so we're done */
4470         return;
4471     }
4472
4473     /* If we got here, we timed out waiting for the volume to go offline.
4474      * Kick off the accessing RX calls and wait again */
4475
4476     VScanCalls_r(vp);
4477
4478     while (!VIsOfflineState(V_attachState(vp))) {
4479         if (!salvok && vp->salvage.requested) {
4480             *ec = 1;
4481             return;
4482         }
4483
4484         VWaitStateChange_r(vp);
4485     }
4486 }
4487
4488 #else /* AFS_DEMAND_ATTACH_FS */
4489
4490 /**
4491  * Wait for a volume to go offline.
4492  *
4493  * @pre VOL_LOCK held
4494  *
4495  * @note non-DAFS only (for DAFS, use @see WaitForOfflineByVp_r)
4496  */
4497 static void
4498 VWaitForOffline_r(Error *ec, VolumeId volid)
4499 {
4500     struct Volume *vp;
4501     const struct timespec *ts;
4502 #ifdef AFS_PTHREAD_ENV
4503     struct timespec timeout_ts;
4504 #endif
4505
4506     ts = VOfflineTimeout(&timeout_ts);
4507
4508     vp = GetVolume(ec, NULL, volid, NULL, ts);
4509     if (!vp) {
4510         /* error occurred so bad that we can't even get a vp; we have no
4511          * information on the vol so we don't know whether to wait, so just
4512          * return */
4513         return;
4514     }
4515     if (!VIsGoingOffline_r(vp)) {
4516         /* volume is no longer going offline, so we're done */
4517         VPutVolume_r(vp);
4518         return;
4519     }
4520
4521     /* If we got here, we timed out waiting for the volume to go offline.
4522      * Kick off the accessing RX calls and wait again */
4523
4524     VScanCalls_r(vp);
4525     VPutVolume_r(vp);
4526     vp = NULL;
4527
4528     vp = VGetVolume_r(ec, volid);
4529     if (vp) {
4530         /* In case it was reattached... */
4531         VPutVolume_r(vp);
4532     }
4533 }
4534 #endif /* !AFS_DEMAND_ATTACH_FS */
4535
4536 /* The opposite of VAttachVolume.  The volume header is written to disk, with
4537    the inUse bit turned off.  A copy of the header is maintained in memory,
4538    however (which is why this is VOffline, not VDetach).
4539  */
4540 void
4541 VOffline_r(Volume * vp, char *message)
4542 {
4543     Error error;