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