c2d06681e2f4a5d8d8613c70240439d5db5bce7a
[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         case 1:
1800             if ((V_attachState(vp) == VOL_STATE_ATTACHED) &&
1801                 (vp->header == NULL)) {
1802                 break;
1803             }
1804         case 2:
1805             if (VIsExclusiveState(V_attachState(vp))) {
1806                 break;
1807             }
1808         case 3:
1809             *idx = nqp;
1810             DeleteVolumeFromVByPList_r(vp);
1811             VShutdownVolume_r(vp);
1812             vp = NULL;
1813             return 1;
1814         }
1815     }
1816
1817     return 0;
1818 }
1819
1820 /*
1821  * shutdown a specific volume
1822  */
1823 /* caller MUST NOT hold a heavyweight ref on vp */
1824 int
1825 VShutdownVolume_r(Volume * vp)
1826 {
1827     int code;
1828
1829     VCreateReservation_r(vp);
1830
1831     if (GetLogLevel() >= 5) {
1832         Log("VShutdownVolume_r:  vid=%" AFS_VOLID_FMT ", device=%d, state=%u\n",
1833             afs_printable_VolumeId_lu(vp->hashid), vp->partition->device,
1834             (unsigned int) V_attachState(vp));
1835     }
1836
1837     /* wait for other blocking ops to finish */
1838     VWaitExclusiveState_r(vp);
1839
1840     opr_Assert(VIsValidState(V_attachState(vp)));
1841
1842     switch(V_attachState(vp)) {
1843     case VOL_STATE_SALVAGING:
1844         /* Leave salvaging volumes alone. Any in-progress salvages will
1845          * continue working after viced shuts down. This is intentional.
1846          */
1847
1848     case VOL_STATE_PREATTACHED:
1849     case VOL_STATE_ERROR:
1850         VChangeState_r(vp, VOL_STATE_UNATTACHED);
1851     case VOL_STATE_UNATTACHED:
1852     case VOL_STATE_DELETED:
1853         break;
1854     case VOL_STATE_GOING_OFFLINE:
1855     case VOL_STATE_SHUTTING_DOWN:
1856     case VOL_STATE_ATTACHED:
1857         code = VHold_r(vp);
1858         if (!code) {
1859             if (GetLogLevel() >= 5)
1860                 Log("VShutdown:  Attempting to take volume %" AFS_VOLID_FMT " offline.\n",
1861                     afs_printable_VolumeId_lu(vp->hashid));
1862
1863             /* take the volume offline (drops reference count) */
1864             VOffline_r(vp, "File server was shut down");
1865         }
1866         break;
1867     default:
1868         break;
1869     }
1870
1871     VCancelReservation_r(vp);
1872     vp = NULL;
1873     return 0;
1874 }
1875 #endif /* AFS_DEMAND_ATTACH_FS */
1876
1877
1878 /***************************************************/
1879 /* Header I/O routines                             */
1880 /***************************************************/
1881
1882 static const char *
1883 HeaderName(bit32 magic)
1884 {
1885     switch (magic) {
1886     case VOLUMEINFOMAGIC:
1887         return "volume info";
1888     case SMALLINDEXMAGIC:
1889         return "small index";
1890     case LARGEINDEXMAGIC:
1891         return "large index";
1892     case LINKTABLEMAGIC:
1893         return "link table";
1894     }
1895     return "unknown";
1896 }
1897
1898 /* open a descriptor for the inode (h),
1899  * read in an on-disk structure into buffer (to) of size (size),
1900  * verify versionstamp in structure has magic (magic) and
1901  * optionally verify version (version) if (version) is nonzero
1902  */
1903 static void
1904 ReadHeader(Error * ec, IHandle_t * h, char *to, int size, bit32 magic,
1905            bit32 version)
1906 {
1907     struct versionStamp *vsn;
1908     FdHandle_t *fdP;
1909     afs_sfsize_t nbytes;
1910     afs_ino_str_t stmp;
1911
1912     *ec = 0;
1913     if (h == NULL) {
1914         Log("ReadHeader: Null inode handle argument for %s header file.\n",
1915             HeaderName(magic));
1916         *ec = VSALVAGE;
1917         return;
1918     }
1919
1920     fdP = IH_OPEN(h);
1921     if (fdP == NULL) {
1922         Log("ReadHeader: Failed to open %s header file "
1923             "(volume=%" AFS_VOLID_FMT ", inode=%s); errno=%d\n", HeaderName(magic), afs_printable_VolumeId_lu(h->ih_vid),
1924             PrintInode(stmp, h->ih_ino), errno);
1925         *ec = VSALVAGE;
1926         return;
1927     }
1928
1929     vsn = (struct versionStamp *)to;
1930     nbytes = FDH_PREAD(fdP, to, size, 0);
1931     if (nbytes < 0) {
1932         Log("ReadHeader: Failed to read %s header file "
1933             "(volume=%" AFS_VOLID_FMT ", inode=%s); errno=%d\n", HeaderName(magic), afs_printable_VolumeId_lu(h->ih_vid),
1934             PrintInode(stmp, h->ih_ino), errno);
1935         *ec = VSALVAGE;
1936         FDH_REALLYCLOSE(fdP);
1937         return;
1938     }
1939     if (nbytes != size) {
1940         Log("ReadHeader: Incorrect number of bytes read from %s header file "
1941             "(volume=%" AFS_VOLID_FMT ", inode=%s); expected=%d, read=%d\n",
1942             HeaderName(magic), afs_printable_VolumeId_lu(h->ih_vid), 
1943             PrintInode(stmp, h->ih_ino), size, (int)nbytes);
1944         *ec = VSALVAGE;
1945         FDH_REALLYCLOSE(fdP);
1946         return;
1947     }
1948     if (vsn->magic != magic) {
1949         Log("ReadHeader: Incorrect magic for %s header file "
1950             "(volume=%" AFS_VOLID_FMT ", inode=%s); expected=0x%x, read=0x%x\n",
1951             HeaderName(magic), afs_printable_VolumeId_lu(h->ih_vid),
1952             PrintInode(stmp, h->ih_ino), magic, vsn->magic);
1953         *ec = VSALVAGE;
1954         FDH_REALLYCLOSE(fdP);
1955         return;
1956     }
1957
1958     FDH_CLOSE(fdP);
1959
1960     /* Check is conditional, in case caller wants to inspect version himself */
1961     if (version && vsn->version != version) {
1962         Log("ReadHeader: Incorrect version for %s header file "
1963             "(volume=%" AFS_VOLID_FMT ", inode=%s); expected=%x, read=%x\n",
1964             HeaderName(magic), afs_printable_VolumeId_lu(h->ih_vid), PrintInode(stmp, h->ih_ino),
1965             version, vsn->version);
1966         *ec = VSALVAGE;
1967     }
1968 }
1969
1970 void
1971 WriteVolumeHeader_r(Error * ec, Volume * vp)
1972 {
1973     IHandle_t *h = V_diskDataHandle(vp);
1974     FdHandle_t *fdP;
1975
1976     *ec = 0;
1977
1978     fdP = IH_OPEN(h);
1979     if (fdP == NULL) {
1980         *ec = VSALVAGE;
1981         return;
1982     }
1983     if (FDH_PWRITE(fdP, (char *)&V_disk(vp), sizeof(V_disk(vp)), 0)
1984         != sizeof(V_disk(vp))) {
1985         *ec = VSALVAGE;
1986         FDH_REALLYCLOSE(fdP);
1987         return;
1988     }
1989     FDH_CLOSE(fdP);
1990 }
1991
1992 /* VolumeHeaderToDisk
1993  * Allows for storing 64 bit inode numbers in on-disk volume header
1994  * file.
1995  */
1996 /* convert in-memory representation of a volume header to the
1997  * on-disk representation of a volume header */
1998 void
1999 VolumeHeaderToDisk(VolumeDiskHeader_t * dh, VolumeHeader_t * h)
2000 {
2001
2002     memset(dh, 0, sizeof(VolumeDiskHeader_t));
2003     dh->stamp = h->stamp;
2004     dh->id = h->id;
2005     dh->parent = h->parent;
2006
2007 #ifdef AFS_64BIT_IOPS_ENV
2008     dh->volumeInfo_lo = (afs_int32) h->volumeInfo & 0xffffffff;
2009     dh->volumeInfo_hi = (afs_int32) (h->volumeInfo >> 32) & 0xffffffff;
2010     dh->smallVnodeIndex_lo = (afs_int32) h->smallVnodeIndex & 0xffffffff;
2011     dh->smallVnodeIndex_hi =
2012         (afs_int32) (h->smallVnodeIndex >> 32) & 0xffffffff;
2013     dh->largeVnodeIndex_lo = (afs_int32) h->largeVnodeIndex & 0xffffffff;
2014     dh->largeVnodeIndex_hi =
2015         (afs_int32) (h->largeVnodeIndex >> 32) & 0xffffffff;
2016     dh->linkTable_lo = (afs_int32) h->linkTable & 0xffffffff;
2017     dh->linkTable_hi = (afs_int32) (h->linkTable >> 32) & 0xffffffff;
2018 #else
2019     dh->volumeInfo_lo = h->volumeInfo;
2020     dh->smallVnodeIndex_lo = h->smallVnodeIndex;
2021     dh->largeVnodeIndex_lo = h->largeVnodeIndex;
2022     dh->linkTable_lo = h->linkTable;
2023 #endif
2024 }
2025
2026 /* DiskToVolumeHeader
2027  * Converts an on-disk representation of a volume header to
2028  * the in-memory representation of a volume header.
2029  *
2030  * Makes the assumption that AFS has *always*
2031  * zero'd the volume header file so that high parts of inode
2032  * numbers are 0 in older (SGI EFS) volume header files.
2033  */
2034 void
2035 DiskToVolumeHeader(VolumeHeader_t * h, VolumeDiskHeader_t * dh)
2036 {
2037     memset(h, 0, sizeof(VolumeHeader_t));
2038     h->stamp = dh->stamp;
2039     h->id = dh->id;
2040     h->parent = dh->parent;
2041
2042 #ifdef AFS_64BIT_IOPS_ENV
2043     h->volumeInfo =
2044         (Inode) dh->volumeInfo_lo | ((Inode) dh->volumeInfo_hi << 32);
2045
2046     h->smallVnodeIndex =
2047         (Inode) dh->smallVnodeIndex_lo | ((Inode) dh->
2048                                           smallVnodeIndex_hi << 32);
2049
2050     h->largeVnodeIndex =
2051         (Inode) dh->largeVnodeIndex_lo | ((Inode) dh->
2052                                           largeVnodeIndex_hi << 32);
2053     h->linkTable =
2054         (Inode) dh->linkTable_lo | ((Inode) dh->linkTable_hi << 32);
2055 #else
2056     h->volumeInfo = dh->volumeInfo_lo;
2057     h->smallVnodeIndex = dh->smallVnodeIndex_lo;
2058     h->largeVnodeIndex = dh->largeVnodeIndex_lo;
2059     h->linkTable = dh->linkTable_lo;
2060 #endif
2061 }
2062
2063
2064 /***************************************************/
2065 /* Volume Attachment routines                      */
2066 /***************************************************/
2067
2068 #ifdef AFS_DEMAND_ATTACH_FS
2069 /**
2070  * pre-attach a volume given its path.
2071  *
2072  * @param[out] ec         outbound error code
2073  * @param[in]  partition  partition path string
2074  * @param[in]  name       volume id string
2075  *
2076  * @return volume object pointer
2077  *
2078  * @note A pre-attached volume will only have its partition
2079  *       and hashid fields initialized.  At first call to
2080  *       VGetVolume, the volume will be fully attached.
2081  *
2082  */
2083 Volume *
2084 VPreAttachVolumeByName(Error * ec, char *partition, char *name)
2085 {
2086     Volume * vp;
2087     VOL_LOCK;
2088     vp = VPreAttachVolumeByName_r(ec, partition, name);
2089     VOL_UNLOCK;
2090     return vp;
2091 }
2092
2093 /**
2094  * pre-attach a volume given its path.
2095  *
2096  * @param[out] ec         outbound error code
2097  * @param[in]  partition  path to vice partition
2098  * @param[in]  name       volume id string
2099  *
2100  * @return volume object pointer
2101  *
2102  * @pre VOL_LOCK held
2103  *
2104  * @internal volume package internal use only.
2105  */
2106 Volume *
2107 VPreAttachVolumeByName_r(Error * ec, char *partition, char *name)
2108 {
2109     return VPreAttachVolumeById_r(ec,
2110                                   partition,
2111                                   VolumeNumber(name));
2112 }
2113
2114 /**
2115  * pre-attach a volume given its path and numeric volume id.
2116  *
2117  * @param[out] ec          error code return
2118  * @param[in]  partition   path to vice partition
2119  * @param[in]  volumeId    numeric volume id
2120  *
2121  * @return volume object pointer
2122  *
2123  * @pre VOL_LOCK held
2124  *
2125  * @internal volume package internal use only.
2126  */
2127 Volume *
2128 VPreAttachVolumeById_r(Error * ec,
2129                        char * partition,
2130                        VolumeId volumeId)
2131 {
2132     Volume *vp;
2133     struct DiskPartition64 *partp;
2134
2135     *ec = 0;
2136
2137     opr_Assert(programType == fileServer);
2138
2139     if (!(partp = VGetPartition_r(partition, 0))) {
2140         *ec = VNOVOL;
2141         Log("VPreAttachVolumeById_r:  Error getting partition (%s)\n", partition);
2142         return NULL;
2143     }
2144
2145     /* ensure that any vp we pass to VPreAttachVolumeByVp_r
2146      * is NOT in exclusive state.
2147      */
2148  retry:
2149     vp = VLookupVolume_r(ec, volumeId, NULL);
2150
2151     if (*ec) {
2152         return NULL;
2153     }
2154
2155     if (vp && VIsExclusiveState(V_attachState(vp))) {
2156         VCreateReservation_r(vp);
2157         VWaitExclusiveState_r(vp);
2158         VCancelReservation_r(vp);
2159         vp = NULL;
2160         goto retry;    /* look up volume again */
2161     }
2162
2163     /* vp == NULL or vp not exclusive both OK */
2164
2165     return VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2166 }
2167
2168 /**
2169  * preattach a volume.
2170  *
2171  * @param[out] ec     outbound error code
2172  * @param[in]  partp  pointer to partition object
2173  * @param[in]  vp     pointer to volume object
2174  * @param[in]  vid    volume id
2175  *
2176  * @return volume object pointer
2177  *
2178  * @pre VOL_LOCK is held.
2179  *
2180  * @pre vp (if specified) must not be in exclusive state.
2181  *
2182  * @warning Returned volume object pointer does not have to
2183  *          equal the pointer passed in as argument vp.  There
2184  *          are potential race conditions which can result in
2185  *          the pointers having different values.  It is up to
2186  *          the caller to make sure that references are handled
2187  *          properly in this case.
2188  *
2189  * @note If there is already a volume object registered with
2190  *       the same volume id, its pointer MUST be passed as
2191  *       argument vp.  Failure to do so will result in a silent
2192  *       failure to preattach.
2193  *
2194  * @internal volume package internal use only.
2195  */
2196 Volume *
2197 VPreAttachVolumeByVp_r(Error * ec,
2198                        struct DiskPartition64 * partp,
2199                        Volume * vp,
2200                        VolumeId vid)
2201 {
2202     Volume *nvp = NULL;
2203
2204     *ec = 0;
2205
2206     /* don't proceed unless it's safe */
2207     if (vp) {
2208         opr_Assert(!VIsExclusiveState(V_attachState(vp)));
2209     }
2210
2211     /* check to see if pre-attach already happened */
2212     if (vp &&
2213         (V_attachState(vp) != VOL_STATE_UNATTACHED) &&
2214         (V_attachState(vp) != VOL_STATE_DELETED) &&
2215         (V_attachState(vp) != VOL_STATE_PREATTACHED) &&
2216         !VIsErrorState(V_attachState(vp))) {
2217         /*
2218          * pre-attach is a no-op in all but the following cases:
2219          *
2220          *   - volume is unattached
2221          *   - volume is in an error state
2222          *   - volume is pre-attached
2223          */
2224         Log("VPreattachVolumeByVp_r: volume %" AFS_VOLID_FMT " not in quiescent state (state %u flags 0x%x)\n",
2225             afs_printable_VolumeId_lu(vid), V_attachState(vp),
2226             V_attachFlags(vp));
2227         goto done;
2228     } else if (vp) {
2229         /* we're re-attaching a volume; clear out some old state */
2230         memset(&vp->salvage, 0, sizeof(struct VolumeOnlineSalvage));
2231
2232         if (V_partition(vp) != partp) {
2233             /* XXX potential race */
2234             DeleteVolumeFromVByPList_r(vp);
2235         }
2236     } else {
2237         /* if we need to allocate a new Volume struct,
2238          * go ahead and drop the vol glock, otherwise
2239          * do the basic setup synchronised, as it's
2240          * probably not worth dropping the lock */
2241         VOL_UNLOCK;
2242
2243         /* allocate the volume structure */
2244         vp = nvp = calloc(1, sizeof(Volume));
2245         opr_Assert(vp != NULL);
2246         queue_Init(&vp->vnode_list);
2247         queue_Init(&vp->rx_call_list);
2248         opr_cv_init(&V_attachCV(vp));
2249     }
2250
2251     /* link the volume with its associated vice partition */
2252     vp->device = partp->device;
2253     vp->partition = partp;
2254
2255     vp->hashid = vid;
2256     vp->specialStatus = 0;
2257
2258     /* if we dropped the lock, reacquire the lock,
2259      * check for pre-attach races, and then add
2260      * the volume to the hash table */
2261     if (nvp) {
2262         VOL_LOCK;
2263         nvp = VLookupVolume_r(ec, vid, NULL);
2264         if (*ec) {
2265             free(vp);
2266             vp = NULL;
2267             goto done;
2268         } else if (nvp) { /* race detected */
2269             free(vp);
2270             vp = nvp;
2271             goto done;
2272         } else {
2273           /* hack to make up for VChangeState_r() decrementing
2274            * the old state counter */
2275           VStats.state_levels[0]++;
2276         }
2277     }
2278
2279     /* put pre-attached volume onto the hash table
2280      * and bring it up to the pre-attached state */
2281     AddVolumeToHashTable(vp, vp->hashid);
2282     AddVolumeToVByPList_r(vp);
2283     VLRU_Init_Node_r(vp);
2284     VChangeState_r(vp, VOL_STATE_PREATTACHED);
2285
2286     if (GetLogLevel() >= 5)
2287         Log("VPreAttachVolumeByVp_r:  volume %" AFS_VOLID_FMT " pre-attached\n", afs_printable_VolumeId_lu(vp->hashid));
2288
2289   done:
2290     if (*ec)
2291         return NULL;
2292     else
2293         return vp;
2294 }
2295 #endif /* AFS_DEMAND_ATTACH_FS */
2296
2297 /* Attach an existing volume, given its pathname, and return a
2298    pointer to the volume header information.  The volume also
2299    normally goes online at this time.  An offline volume
2300    must be reattached to make it go online */
2301 Volume *
2302 VAttachVolumeByName(Error * ec, char *partition, char *name, int mode)
2303 {
2304     Volume *retVal;
2305     VOL_LOCK;
2306     retVal = VAttachVolumeByName_r(ec, partition, name, mode);
2307     VOL_UNLOCK;
2308     return retVal;
2309 }
2310
2311 Volume *
2312 VAttachVolumeByName_r(Error * ec, char *partition, char *name, int mode)
2313 {
2314     Volume *vp = NULL;
2315     struct DiskPartition64 *partp;
2316     char path[64];
2317     int isbusy = 0;
2318     VolumeId volumeId;
2319     int checkedOut;
2320 #ifdef AFS_DEMAND_ATTACH_FS
2321     VolumeStats stats_save;
2322     Volume *svp = NULL;
2323 #endif /* AFS_DEMAND_ATTACH_FS */
2324
2325     *ec = 0;
2326
2327     volumeId = VolumeNumber(name);
2328
2329     if (!(partp = VGetPartition_r(partition, 0))) {
2330         *ec = VNOVOL;
2331         Log("VAttachVolume: Error getting partition (%s)\n", partition);
2332         goto done;
2333     }
2334
2335     if (VRequiresPartLock()) {
2336         opr_Assert(VInit == 3);
2337         VLockPartition_r(partition);
2338     } else if (programType == fileServer) {
2339 #ifdef AFS_DEMAND_ATTACH_FS
2340         /* lookup the volume in the hash table */
2341         vp = VLookupVolume_r(ec, volumeId, NULL);
2342         if (*ec) {
2343             return NULL;
2344         }
2345
2346         if (vp) {
2347             /* save any counters that are supposed to
2348              * be monotonically increasing over the
2349              * lifetime of the fileserver */
2350             memcpy(&stats_save, &vp->stats, sizeof(VolumeStats));
2351         } else {
2352             memset(&stats_save, 0, sizeof(VolumeStats));
2353         }
2354
2355         /* if there's something in the hash table, and it's not
2356          * in the pre-attach state, then we may need to detach
2357          * it before proceeding */
2358         if (vp && (V_attachState(vp) != VOL_STATE_PREATTACHED)) {
2359             VCreateReservation_r(vp);
2360             VWaitExclusiveState_r(vp);
2361
2362             /* at this point state must be one of:
2363              *   - UNATTACHED
2364              *   - ATTACHED
2365              *   - SHUTTING_DOWN
2366              *   - GOING_OFFLINE
2367              *   - SALVAGING
2368              *   - ERROR
2369              *   - DELETED
2370              */
2371
2372             if (vp->specialStatus == VBUSY)
2373                 isbusy = 1;
2374
2375             /* if it's already attached, see if we can return it */
2376             if (V_attachState(vp) == VOL_STATE_ATTACHED) {
2377                 VGetVolumeByVp_r(ec, vp);
2378                 if (V_inUse(vp) == fileServer) {
2379                     VCancelReservation_r(vp);
2380                     return vp;
2381                 }
2382
2383                 /* otherwise, we need to detach, and attempt to re-attach */
2384                 VDetachVolume_r(ec, vp);
2385                 if (*ec) {
2386                     Log("VAttachVolume: Error detaching old volume instance (%s)\n", name);
2387                 }
2388             } else {
2389                 /* if it isn't fully attached, delete from the hash tables,
2390                    and let the refcounter handle the rest */
2391                 DeleteVolumeFromHashTable(vp);
2392                 DeleteVolumeFromVByPList_r(vp);
2393             }
2394
2395             VCancelReservation_r(vp);
2396             vp = NULL;
2397         }
2398
2399         /* pre-attach volume if it hasn't been done yet */
2400         if (!vp ||
2401             (V_attachState(vp) == VOL_STATE_UNATTACHED) ||
2402             (V_attachState(vp) == VOL_STATE_DELETED) ||
2403             (V_attachState(vp) == VOL_STATE_ERROR)) {
2404             svp = vp;
2405             vp = VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2406             if (*ec) {
2407                 return NULL;
2408             }
2409         }
2410
2411         opr_Assert(vp != NULL);
2412
2413         /* handle pre-attach races
2414          *
2415          * multiple threads can race to pre-attach a volume,
2416          * but we can't let them race beyond that
2417          *
2418          * our solution is to let the first thread to bring
2419          * the volume into an exclusive state win; the other
2420          * threads just wait until it finishes bringing the
2421          * volume online, and then they do a vgetvolumebyvp
2422          */
2423         if (svp && (svp != vp)) {
2424             /* wait for other exclusive ops to finish */
2425             VCreateReservation_r(vp);
2426             VWaitExclusiveState_r(vp);
2427
2428             /* get a heavyweight ref, kill the lightweight ref, and return */
2429             VGetVolumeByVp_r(ec, vp);
2430             VCancelReservation_r(vp);
2431             return vp;
2432         }
2433
2434         /* at this point, we are chosen as the thread to do
2435          * demand attachment for this volume. all other threads
2436          * doing a getvolume on vp->hashid will block until we finish */
2437
2438         /* make sure any old header cache entries are invalidated
2439          * before proceeding */
2440         FreeVolumeHeader(vp);
2441
2442         VChangeState_r(vp, VOL_STATE_ATTACHING);
2443
2444         /* restore any saved counters */
2445         memcpy(&vp->stats, &stats_save, sizeof(VolumeStats));
2446 #else /* AFS_DEMAND_ATTACH_FS */
2447         vp = VGetVolume_r(ec, volumeId);
2448         if (vp) {
2449             if (V_inUse(vp) == fileServer)
2450                 return vp;
2451             if (vp->specialStatus == VBUSY)
2452                 isbusy = 1;
2453             VDetachVolume_r(ec, vp);
2454             if (*ec) {
2455                 Log("VAttachVolume: Error detaching volume (%s)\n", name);
2456             }
2457             vp = NULL;
2458         }
2459 #endif /* AFS_DEMAND_ATTACH_FS */
2460     }
2461
2462     *ec = 0;
2463     strcpy(path, VPartitionPath(partp));
2464
2465     VOL_UNLOCK;
2466
2467     strcat(path, OS_DIRSEP);
2468     strcat(path, name);
2469
2470     if (!vp) {
2471       vp = (Volume *) calloc(1, sizeof(Volume));
2472       opr_Assert(vp != NULL);
2473       vp->hashid = volumeId;
2474       vp->device = partp->device;
2475       vp->partition = partp;
2476       queue_Init(&vp->vnode_list);
2477       queue_Init(&vp->rx_call_list);
2478 #ifdef AFS_DEMAND_ATTACH_FS
2479       opr_cv_init(&V_attachCV(vp));
2480 #endif /* AFS_DEMAND_ATTACH_FS */
2481     }
2482
2483     /* attach2 is entered without any locks, and returns
2484      * with vol_glock_mutex held */
2485     vp = attach2(ec, volumeId, path, partp, vp, isbusy, mode, &checkedOut);
2486
2487     if (VCanUseFSSYNC() && vp) {
2488 #ifdef AFS_DEMAND_ATTACH_FS
2489         if ((mode == V_VOLUPD) || (VolumeWriteable(vp) && (mode == V_CLONE))) {
2490             /* mark volume header as in use so that volser crashes lead to a
2491              * salvage attempt */
2492             VUpdateVolume_r(ec, vp, 0);
2493         }
2494         /* for dafs, we should tell the fileserver, except for V_PEEK
2495          * where we know it is not necessary */
2496         if (mode == V_PEEK) {
2497             vp->needsPutBack = 0;
2498         } else {
2499             vp->needsPutBack = VOL_PUTBACK;
2500         }
2501 #else /* !AFS_DEMAND_ATTACH_FS */
2502         /* duplicate computation in fssync.c about whether the server
2503          * takes the volume offline or not.  If the volume isn't
2504          * offline, we must not return it when we detach the volume,
2505          * or the server will abort */
2506         if (mode == V_READONLY || mode == V_PEEK
2507             || (!VolumeWriteable(vp) && (mode == V_CLONE || mode == V_DUMP)))
2508             vp->needsPutBack = 0;
2509         else
2510             vp->needsPutBack = VOL_PUTBACK;
2511 #endif /* !AFS_DEMAND_ATTACH_FS */
2512     }
2513 #ifdef FSSYNC_BUILD_CLIENT
2514     /* Only give back the vol to the fileserver if we checked it out; attach2
2515      * will set checkedOut only if we successfully checked it out from the
2516      * fileserver. */
2517     if (VCanUseFSSYNC() && vp == NULL && checkedOut) {
2518
2519 #ifdef AFS_DEMAND_ATTACH_FS
2520         /* If we couldn't attach but we scheduled a salvage, we already
2521          * notified the fileserver; don't online it now */
2522         if (*ec != VSALVAGING)
2523 #endif /* AFS_DEMAND_ATTACH_FS */
2524         FSYNC_VolOp(volumeId, partition, FSYNC_VOL_ON, 0, NULL);
2525     } else
2526 #endif
2527     if (programType == fileServer && vp) {
2528 #ifdef AFS_DEMAND_ATTACH_FS
2529         /*
2530          * we can get here in cases where we don't "own"
2531          * the volume (e.g. volume owned by a utility).
2532          * short circuit around potential disk header races.
2533          */
2534         if (V_attachState(vp) != VOL_STATE_ATTACHED) {
2535             goto done;
2536         }
2537 #endif
2538         VUpdateVolume_r(ec, vp, 0);
2539         if (*ec) {
2540             Log("VAttachVolume: Error updating volume\n");
2541             if (vp)
2542                 VPutVolume_r(vp);
2543             goto done;
2544         }
2545         if (VolumeWriteable(vp) && V_dontSalvage(vp) == 0) {
2546 #ifndef AFS_DEMAND_ATTACH_FS
2547             /* This is a hack: by temporarily setting the incore
2548              * dontSalvage flag ON, the volume will be put back on the
2549              * Update list (with dontSalvage OFF again).  It will then
2550              * come back in N minutes with DONT_SALVAGE eventually
2551              * set.  This is the way that volumes that have never had
2552              * it set get it set; or that volumes that have been
2553              * offline without DONT SALVAGE having been set also
2554              * eventually get it set */
2555             V_dontSalvage(vp) = DONT_SALVAGE;
2556 #endif /* !AFS_DEMAND_ATTACH_FS */
2557             VAddToVolumeUpdateList_r(ec, vp);
2558             if (*ec) {
2559                 Log("VAttachVolume: Error adding volume to update list\n");
2560                 if (vp)
2561                     VPutVolume_r(vp);
2562                 goto done;
2563             }
2564         }
2565         if (GetLogLevel() != 0)
2566           Log("VOnline:  volume %" AFS_VOLID_FMT " (%s) attached and online\n", afs_printable_VolumeId_lu(V_id(vp)),
2567                 V_name(vp));
2568     }
2569
2570   done:
2571     if (VRequiresPartLock()) {
2572         VUnlockPartition_r(partition);
2573     }
2574     if (*ec) {
2575 #ifdef AFS_DEMAND_ATTACH_FS
2576         /* attach failed; make sure we're in error state */
2577         if (vp && !VIsErrorState(V_attachState(vp))) {
2578             VChangeState_r(vp, VOL_STATE_ERROR);
2579         }
2580 #endif /* AFS_DEMAND_ATTACH_FS */
2581         return NULL;
2582     } else {
2583         return vp;
2584     }
2585 }
2586
2587 #ifdef AFS_DEMAND_ATTACH_FS
2588 /* VAttachVolumeByVp_r
2589  *
2590  * finish attaching a volume that is
2591  * in a less than fully attached state
2592  */
2593 /* caller MUST hold a ref count on vp */
2594 static Volume *
2595 VAttachVolumeByVp_r(Error * ec, Volume * vp, int mode)
2596 {
2597     char name[VMAXPATHLEN];
2598     int reserve = 0;
2599     struct DiskPartition64 *partp;
2600     char path[64];
2601     int isbusy = 0;
2602     VolumeId volumeId;
2603     Volume * nvp = NULL;
2604     VolumeStats stats_save;
2605     int checkedOut;
2606     *ec = 0;
2607
2608     /* volume utility should never call AttachByVp */
2609     opr_Assert(programType == fileServer);
2610
2611     volumeId = vp->hashid;
2612     partp = vp->partition;
2613     VolumeExternalName_r(volumeId, name, sizeof(name));
2614
2615
2616     /* if another thread is performing a blocking op, wait */
2617     VWaitExclusiveState_r(vp);
2618
2619     memcpy(&stats_save, &vp->stats, sizeof(VolumeStats));
2620
2621     /* if it's already attached, see if we can return it */
2622     if (V_attachState(vp) == VOL_STATE_ATTACHED) {
2623         VGetVolumeByVp_r(ec, vp);
2624         if (V_inUse(vp) == fileServer) {
2625             return vp;
2626         } else {
2627             if (vp->specialStatus == VBUSY)
2628                 isbusy = 1;
2629             VDetachVolume_r(ec, vp);
2630             if (*ec) {
2631                 Log("VAttachVolume: Error detaching volume (%s)\n", name);
2632             }
2633             vp = NULL;
2634         }
2635     }
2636
2637     /* pre-attach volume if it hasn't been done yet */
2638     if (!vp ||
2639         (V_attachState(vp) == VOL_STATE_UNATTACHED) ||
2640         (V_attachState(vp) == VOL_STATE_DELETED) ||
2641         (V_attachState(vp) == VOL_STATE_ERROR)) {
2642         nvp = VPreAttachVolumeByVp_r(ec, partp, vp, volumeId);
2643         if (*ec) {
2644             return NULL;
2645         }
2646         if (nvp != vp) {
2647             reserve = 1;
2648             VCreateReservation_r(nvp);
2649             vp = nvp;
2650         }
2651     }
2652
2653     opr_Assert(vp != NULL);
2654     VChangeState_r(vp, VOL_STATE_ATTACHING);
2655
2656     /* restore monotonically increasing stats */
2657     memcpy(&vp->stats, &stats_save, sizeof(VolumeStats));
2658
2659     *ec = 0;
2660
2661     /* compute path to disk header */
2662     strcpy(path, VPartitionPath(partp));
2663
2664     VOL_UNLOCK;
2665
2666     strcat(path, OS_DIRSEP);
2667     strcat(path, name);
2668
2669     /* do volume attach
2670      *
2671      * NOTE: attach2 is entered without any locks, and returns
2672      * with vol_glock_mutex held */
2673     vp = attach2(ec, volumeId, path, partp, vp, isbusy, mode, &checkedOut);
2674
2675     /*
2676      * the event that an error was encountered, or
2677      * the volume was not brought to an attached state
2678      * for any reason, skip to the end.  We cannot
2679      * safely call VUpdateVolume unless we "own" it.
2680      */
2681     if (*ec ||
2682         (vp == NULL) ||
2683         (V_attachState(vp) != VOL_STATE_ATTACHED)) {
2684         goto done;
2685     }
2686
2687     VUpdateVolume_r(ec, vp, 0);
2688     if (*ec) {
2689         Log("VAttachVolume: Error updating volume %" AFS_VOLID_FMT "\n",
2690             afs_printable_VolumeId_lu(vp->hashid));
2691         VPutVolume_r(vp);
2692         goto done;
2693     }
2694     if (VolumeWriteable(vp) && V_dontSalvage(vp) == 0) {
2695 #ifndef AFS_DEMAND_ATTACH_FS
2696         /* This is a hack: by temporarily setting the incore
2697          * dontSalvage flag ON, the volume will be put back on the
2698          * Update list (with dontSalvage OFF again).  It will then
2699          * come back in N minutes with DONT_SALVAGE eventually
2700          * set.  This is the way that volumes that have never had
2701          * it set get it set; or that volumes that have been
2702          * offline without DONT SALVAGE having been set also
2703          * eventually get it set */
2704         V_dontSalvage(vp) = DONT_SALVAGE;
2705 #endif /* !AFS_DEMAND_ATTACH_FS */
2706         VAddToVolumeUpdateList_r(ec, vp);
2707         if (*ec) {
2708             Log("VAttachVolume: Error adding volume %" AFS_VOLID_FMT " to update list\n",
2709                 afs_printable_VolumeId_lu(vp->hashid));
2710             if (vp)
2711                 VPutVolume_r(vp);
2712             goto done;
2713         }
2714     }
2715     if (GetLogLevel() != 0)
2716         Log("VOnline:  volume %" AFS_VOLID_FMT " (%s) attached and online\n",
2717             afs_printable_VolumeId_lu(V_id(vp)), V_name(vp));
2718   done:
2719     if (reserve) {
2720         VCancelReservation_r(nvp);
2721         reserve = 0;
2722     }
2723     if (*ec && (*ec != VOFFLINE) && (*ec != VSALVAGE)) {
2724         if (vp && !VIsErrorState(V_attachState(vp))) {
2725             VChangeState_r(vp, VOL_STATE_ERROR);
2726         }
2727         return NULL;
2728     } else {
2729         return vp;
2730     }
2731 }
2732
2733 /**
2734  * lock a volume on disk (non-blocking).
2735  *
2736  * @param[in] vp  The volume to lock
2737  * @param[in] locktype READ_LOCK or WRITE_LOCK
2738  *
2739  * @return operation status
2740  *  @retval 0 success, lock was obtained
2741  *  @retval EBUSY a conflicting lock was held by another process
2742  *  @retval EIO   error acquiring lock
2743  *
2744  * @pre If we're in the fileserver, vp is in an exclusive state
2745  *
2746  * @pre vp is not already locked
2747  */
2748 static int
2749 VLockVolumeNB(Volume *vp, int locktype)
2750 {
2751     int code;
2752
2753     opr_Assert(programType != fileServer
2754                || VIsExclusiveState(V_attachState(vp)));
2755     opr_Assert(!(V_attachFlags(vp) & VOL_LOCKED));
2756
2757     code = VLockVolumeByIdNB(vp->hashid, vp->partition, locktype);
2758     if (code == 0) {
2759         V_attachFlags(vp) |= VOL_LOCKED;
2760     }
2761
2762     return code;
2763 }
2764
2765 /**
2766  * unlock a volume on disk that was locked with VLockVolumeNB.
2767  *
2768  * @param[in] vp  volume to unlock
2769  *
2770  * @pre If we're in the fileserver, vp is in an exclusive state
2771  *
2772  * @pre vp has already been locked
2773  */
2774 static void
2775 VUnlockVolume(Volume *vp)
2776 {
2777     opr_Assert(programType != fileServer
2778                || VIsExclusiveState(V_attachState(vp)));
2779     opr_Assert((V_attachFlags(vp) & VOL_LOCKED));
2780
2781     VUnlockVolumeById(vp->hashid, vp->partition);
2782
2783     V_attachFlags(vp) &= ~VOL_LOCKED;
2784 }
2785 #endif /* AFS_DEMAND_ATTACH_FS */
2786
2787 /**
2788  * read in a vol header, possibly lock the vol header, and possibly check out
2789  * the vol header from the fileserver, as part of volume attachment.
2790  *
2791  * @param[out] ec     error code
2792  * @param[in] vp      volume pointer object
2793  * @param[in] partp   disk partition object of the attaching partition
2794  * @param[in] mode    attachment mode such as V_VOLUPD, V_DUMP, etc (see
2795  *                    volume.h)
2796  * @param[in] peek    1 to just try to read in the volume header and make sure
2797  *                    we don't try to lock the vol, or check it out from
2798  *                    FSSYNC or anything like that; 0 otherwise, for 'normal'
2799  *                    operation
2800  * @param[out] acheckedOut   If we successfully checked-out the volume from
2801  *                           the fileserver (if we needed to), this is set
2802  *                           to 1, otherwise it is untouched.
2803  *
2804  * @note As part of DAFS volume attachment, the volume header may be either
2805  *       read- or write-locked to ensure mutual exclusion of certain volume
2806  *       operations. In some cases in order to determine whether we need to
2807  *       read- or write-lock the header, we need to read in the header to see
2808  *       if the volume is RW or not. So, if we read in the header under a
2809  *       read-lock and determine that we actually need a write-lock on the
2810  *       volume header, this function will drop the read lock, acquire a write
2811  *       lock, and read the header in again.
2812  */
2813 static void
2814 attach_volume_header(Error *ec, Volume *vp, struct DiskPartition64 *partp,
2815                      int mode, int peek, int *acheckedOut)
2816 {
2817     struct VolumeDiskHeader diskHeader;
2818     struct VolumeHeader header;
2819     int code;
2820     int first_try = 1;
2821     int lock_tries = 0, checkout_tries = 0;
2822     int retry;
2823     VolumeId volid = vp->hashid;
2824 #ifdef FSSYNC_BUILD_CLIENT
2825     int checkout, done_checkout = 0;
2826 #endif /* FSSYNC_BUILD_CLIENT */
2827 #ifdef AFS_DEMAND_ATTACH_FS
2828     int locktype = 0, use_locktype = -1;
2829 #endif /* AFS_DEMAND_ATTACH_FS */
2830
2831  retry:
2832     retry = 0;
2833     *ec = 0;
2834
2835     if (lock_tries > VOL_MAX_CHECKOUT_RETRIES) {
2836         Log("VAttachVolume: retried too many times trying to lock header for "
2837             "vol %lu part %s; giving up\n", afs_printable_uint32_lu(volid),
2838             VPartitionPath(partp));
2839         *ec = VNOVOL;
2840         goto done;
2841     }
2842     if (checkout_tries > VOL_MAX_CHECKOUT_RETRIES) {
2843         Log("VAttachVolume: retried too many times trying to checkout "
2844             "vol %lu part %s; giving up\n", afs_printable_uint32_lu(volid),
2845             VPartitionPath(partp));
2846         *ec = VNOVOL;
2847         goto done;
2848     }
2849
2850     if (VReadVolumeDiskHeader(volid, partp, NULL)) {
2851         /* short-circuit the 'volume does not exist' case */
2852         *ec = VNOVOL;
2853         goto done;
2854     }
2855
2856 #ifdef FSSYNC_BUILD_CLIENT
2857     checkout = !done_checkout;
2858     done_checkout = 1;
2859     if (!peek && checkout && VMustCheckoutVolume(mode)) {
2860         SYNC_response res;
2861         memset(&res, 0, sizeof(res));
2862
2863         if (FSYNC_VolOp(volid, partp->name, FSYNC_VOL_NEEDVOLUME, mode, &res)
2864             != SYNC_OK) {
2865
2866             if (res.hdr.reason == FSYNC_SALVAGE) {
2867                 Log("VAttachVolume: file server says volume %lu is salvaging\n",
2868                      afs_printable_uint32_lu(volid));
2869                 *ec = VSALVAGING;
2870             } else {
2871                 Log("VAttachVolume: attach of volume %lu apparently denied by file server\n",
2872                      afs_printable_uint32_lu(volid));
2873                 *ec = VNOVOL;   /* XXXX */
2874             }
2875             goto done;
2876         }
2877         *acheckedOut = 1;
2878     }
2879 #endif
2880
2881 #ifdef AFS_DEMAND_ATTACH_FS
2882     if (use_locktype < 0) {
2883         /* don't know whether vol is RO or RW; assume it's RO and we can retry
2884          * if it turns out to be RW */
2885         locktype = VVolLockType(mode, 0);
2886
2887     } else {
2888         /* a previous try says we should use use_locktype to lock the volume,
2889          * so use that */
2890         locktype = use_locktype;
2891     }
2892
2893     if (!peek && locktype) {
2894         code = VLockVolumeNB(vp, locktype);
2895         if (code) {
2896             if (code == EBUSY) {
2897                 Log("VAttachVolume: another program has vol %lu locked\n",
2898                     afs_printable_uint32_lu(volid));
2899             } else {
2900                 Log("VAttachVolume: error %d trying to lock vol %lu\n",
2901                     code, afs_printable_uint32_lu(volid));
2902             }
2903
2904             *ec = VNOVOL;
2905             goto done;
2906         }
2907     }
2908 #endif /* AFS_DEMAND_ATTACH_FS */
2909
2910     code = VReadVolumeDiskHeader(volid, partp, &diskHeader);
2911     if (code) {
2912         if (code == EIO) {
2913             *ec = VSALVAGE;
2914         } else {
2915             *ec = VNOVOL;
2916         }
2917         goto done;
2918     }
2919
2920     DiskToVolumeHeader(&header, &diskHeader);
2921
2922     IH_INIT(vp->vnodeIndex[vLarge].handle, partp->device, header.parent,
2923             header.largeVnodeIndex);
2924     IH_INIT(vp->vnodeIndex[vSmall].handle, partp->device, header.parent,
2925             header.smallVnodeIndex);
2926     IH_INIT(vp->diskDataHandle, partp->device, header.parent,
2927             header.volumeInfo);
2928     IH_INIT(vp->linkHandle, partp->device, header.parent, header.linkTable);
2929
2930     if (first_try) {
2931         /* only need to do this once */
2932         VOL_LOCK;
2933         GetVolumeHeader(vp);
2934         VOL_UNLOCK;
2935     }
2936
2937 #if defined(AFS_DEMAND_ATTACH_FS) && defined(FSSYNC_BUILD_CLIENT)
2938     /* demand attach changes the V_PEEK mechanism
2939      *
2940      * we can now suck the current disk data structure over
2941      * the fssync interface without going to disk
2942      *
2943      * (technically, we don't need to restrict this feature
2944      *  to demand attach fileservers.  However, I'm trying
2945      *  to limit the number of common code changes)
2946      */
2947     if (VCanUseFSSYNC() && (mode == V_PEEK || peek)) {
2948         SYNC_response res;
2949         res.payload.len = sizeof(VolumeDiskData);
2950         res.payload.buf = &(V_disk(vp));
2951
2952         if (FSYNC_VolOp(vp->hashid,
2953                         partp->name,
2954                         FSYNC_VOL_QUERY_HDR,
2955                         FSYNC_WHATEVER,
2956                         &res) == SYNC_OK) {
2957             goto disk_header_loaded;
2958         }
2959     }
2960 #endif /* AFS_DEMAND_ATTACH_FS && FSSYNC_BUILD_CLIENT */
2961     (void)ReadHeader(ec, V_diskDataHandle(vp), (char *)&V_disk(vp),
2962                      sizeof(V_disk(vp)), VOLUMEINFOMAGIC, VOLUMEINFOVERSION);
2963
2964 #ifdef AFS_DEMAND_ATTACH_FS
2965     /* update stats */
2966     VOL_LOCK;
2967     IncUInt64(&VStats.hdr_loads);
2968     IncUInt64(&vp->stats.hdr_loads);
2969     VOL_UNLOCK;
2970 #endif /* AFS_DEMAND_ATTACH_FS */
2971
2972     if (*ec) {
2973         Log("VAttachVolume: Error reading diskDataHandle header for vol %lu; "
2974             "error=%u\n", afs_printable_uint32_lu(volid), *ec);
2975         goto done;
2976     }
2977
2978 #ifdef AFS_DEMAND_ATTACH_FS
2979 # ifdef FSSYNC_BUILD_CLIENT
2980  disk_header_loaded:
2981 # endif /* FSSYNC_BUILD_CLIENT */
2982
2983     /* if the lock type we actually used to lock the volume is different than
2984      * the lock type we should have used, retry with the lock type we should
2985      * use */
2986     use_locktype = VVolLockType(mode, VolumeWriteable(vp));
2987     if (locktype != use_locktype) {
2988         retry = 1;
2989         lock_tries++;
2990     }
2991 #endif /* AFS_DEMAND_ATTACH_FS */
2992
2993     *ec = 0;
2994
2995  done:
2996 #if defined(AFS_DEMAND_ATTACH_FS) && defined(FSSYNC_BUILD_CLIENT)
2997     if (!peek && *ec == 0 && retry == 0 && VMustCheckoutVolume(mode)) {
2998
2999         code = FSYNC_VerifyCheckout(volid, partp->name, FSYNC_VOL_NEEDVOLUME, mode);
3000
3001         if (code == SYNC_DENIED) {
3002             /* must retry checkout; fileserver no longer thinks we have
3003              * the volume */
3004             retry = 1;
3005             checkout_tries++;
3006             done_checkout = 0;
3007
3008         } else if (code != SYNC_OK) {
3009             *ec = VNOVOL;
3010         }
3011     }
3012 #endif /* AFS_DEMAND_ATTACH_FS && FSSYNC_BUILD_CLIENT */
3013
3014     if (*ec || retry) {
3015         /* either we are going to be called again for a second pass, or we
3016          * encountered an error; clean up in either case */
3017
3018 #ifdef AFS_DEMAND_ATTACH_FS
3019         if ((V_attachFlags(vp) & VOL_LOCKED)) {
3020             VUnlockVolume(vp);
3021         }
3022 #endif /* AFS_DEMAND_ATTACH_FS */
3023         if (vp->linkHandle) {
3024             IH_RELEASE(vp->vnodeIndex[vLarge].handle);
3025             IH_RELEASE(vp->vnodeIndex[vSmall].handle);
3026             IH_RELEASE(vp->diskDataHandle);
3027             IH_RELEASE(vp->linkHandle);
3028         }
3029     }
3030
3031     if (*ec) {
3032         VOL_LOCK;
3033         FreeVolumeHeader(vp);
3034         VOL_UNLOCK;
3035         return;
3036     }
3037     if (retry) {
3038         first_try = 0;
3039         goto retry;
3040     }
3041 }
3042
3043 #ifdef AFS_DEMAND_ATTACH_FS
3044 static void
3045 attach_check_vop(Error *ec, VolumeId volid, struct DiskPartition64 *partp,
3046                  Volume *vp, int *acheckedOut)
3047 {
3048     *ec = 0;
3049
3050     if (vp->pending_vol_op) {
3051
3052         VOL_LOCK;
3053
3054         if (vp->pending_vol_op->vol_op_state == FSSYNC_VolOpRunningUnknown) {
3055             int code;
3056             code = VVolOpLeaveOnlineNoHeader_r(vp, vp->pending_vol_op);
3057             if (code == 1) {
3058                 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
3059             } else if (code == 0) {
3060                 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline;
3061
3062             } else {
3063                 /* we need the vol header to determine if the volume can be
3064                  * left online for the vop, so... get the header */
3065
3066                 VOL_UNLOCK;
3067
3068                 /* attach header with peek=1 to avoid checking out the volume
3069                  * or locking it; we just want the header info, we're not
3070                  * messing with the volume itself at all */
3071                 attach_volume_header(ec, vp, partp, V_PEEK, 1, acheckedOut);
3072                 if (*ec) {
3073                     return;
3074                 }
3075
3076                 VOL_LOCK;
3077
3078                 if (VVolOpLeaveOnline_r(vp, vp->pending_vol_op)) {
3079                     vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
3080                 } else {
3081                     vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline;
3082                 }
3083
3084                 /* make sure we grab a new vol header and re-open stuff on
3085                  * actual attachment; we can't keep the data we grabbed, since
3086                  * it was not done under a lock and thus not safe */
3087                 FreeVolumeHeader(vp);
3088                 VReleaseVolumeHandles_r(vp);
3089             }
3090         }
3091         /* see if the pending volume op requires exclusive access */
3092         switch (vp->pending_vol_op->vol_op_state) {
3093         case FSSYNC_VolOpPending:
3094             /* this should never happen */
3095             opr_Assert(vp->pending_vol_op->vol_op_state
3096                             != FSSYNC_VolOpPending);
3097             break;
3098
3099         case FSSYNC_VolOpRunningUnknown:
3100             /* this should never happen; we resolved 'unknown' above */
3101             opr_Assert(vp->pending_vol_op->vol_op_state
3102                             != FSSYNC_VolOpRunningUnknown);
3103             break;
3104
3105         case FSSYNC_VolOpRunningOffline:
3106             /* mark the volume down */
3107             *ec = VOFFLINE;
3108             VChangeState_r(vp, VOL_STATE_UNATTACHED);
3109
3110             /* do not set V_offlineMessage here; we don't have ownership of
3111              * the volume (and probably do not have the header loaded), so we
3112              * can't alter the disk header */
3113
3114             /* check to see if we should set the specialStatus flag */
3115             if (VVolOpSetVBusy_r(vp, vp->pending_vol_op)) {
3116                 /* don't overwrite specialStatus if it was already set to
3117                  * something else (e.g. VMOVED) */
3118                 if (!vp->specialStatus) {
3119                     vp->specialStatus = VBUSY;
3120                 }
3121             }
3122             break;
3123
3124         default:
3125             break;
3126         }
3127
3128         VOL_UNLOCK;
3129     }
3130 }
3131 #endif /* AFS_DEMAND_ATTACH_FS */
3132
3133 /**
3134  * volume attachment helper function.
3135  *
3136  * @param[out] ec      error code
3137  * @param[in] volumeId volume ID of the attaching volume
3138  * @param[in] path     full path to the volume header .vol file
3139  * @param[in] partp    disk partition object for the attaching partition
3140  * @param[in] vp       volume object; vp->hashid, vp->device, vp->partition,
3141  *                     vp->vnode_list, vp->rx_call_list, and V_attachCV (for
3142  *                     DAFS) should already be initialized
3143  * @param[in] isbusy   1 if vp->specialStatus should be set to VBUSY; that is,
3144  *                     if there is a volume operation running for this volume
3145  *                     that should set the volume to VBUSY during its run. 0
3146  *                     otherwise. (see VVolOpSetVBusy_r)
3147  * @param[in] mode     attachment mode such as V_VOLUPD, V_DUMP, etc (see
3148  *                     volume.h)
3149  * @param[out] acheckedOut   If we successfully checked-out the volume from
3150  *                           the fileserver (if we needed to), this is set
3151  *                           to 1, otherwise it is 0.
3152  *
3153  * @return pointer to the semi-attached volume pointer
3154  *  @retval NULL an error occurred (check value of *ec)
3155  *  @retval vp volume successfully attaching
3156  *
3157  * @pre no locks held
3158  *
3159  * @post VOL_LOCK held
3160  */
3161 static Volume *
3162 attach2(Error * ec, VolumeId volumeId, char *path, struct DiskPartition64 *partp,
3163         Volume * vp, int isbusy, int mode, int *acheckedOut)
3164 {
3165     /* have we read in the header successfully? */
3166     int read_header = 0;
3167
3168 #ifdef AFS_DEMAND_ATTACH_FS
3169     /* should we FreeVolume(vp) instead of VCheckFree(vp) in the error
3170      * cleanup? */
3171     int forcefree = 0;
3172
3173     /* in the case of an error, to what state should the volume be
3174      * transitioned? */
3175     VolState error_state = VOL_STATE_ERROR;
3176 #endif /* AFS_DEMAND_ATTACH_FS */
3177
3178     *ec = 0;
3179
3180     vp->vnodeIndex[vLarge].handle = NULL;
3181     vp->vnodeIndex[vSmall].handle = NULL;
3182     vp->diskDataHandle = NULL;
3183     vp->linkHandle = NULL;
3184
3185     *acheckedOut = 0;
3186
3187 #ifdef AFS_DEMAND_ATTACH_FS
3188     attach_check_vop(ec, volumeId, partp, vp, acheckedOut);
3189     if (!*ec) {
3190         attach_volume_header(ec, vp, partp, mode, 0, acheckedOut);
3191     }
3192 #else
3193     attach_volume_header(ec, vp, partp, mode, 0, acheckedOut);
3194 #endif /* !AFS_DEMAND_ATTACH_FS */
3195
3196     if (*ec == VNOVOL) {
3197         /* if the volume doesn't exist, skip straight to 'error' so we don't
3198          * request a salvage */
3199         goto unlocked_error;
3200     }
3201
3202     if (!*ec) {
3203         read_header = 1;
3204
3205         /* ensure that we don't override specialStatus if it was set to
3206          * something else (e.g. VMOVED) */
3207         if (isbusy && !vp->specialStatus) {
3208             vp->specialStatus = VBUSY;
3209         }
3210         vp->shuttingDown = 0;
3211         vp->goingOffline = 0;
3212         vp->nUsers = 1;
3213 #ifdef AFS_DEMAND_ATTACH_FS
3214         vp->stats.last_attach = FT_ApproxTime();
3215         vp->stats.attaches++;
3216 #endif
3217
3218         VOL_LOCK;
3219         IncUInt64(&VStats.attaches);
3220         vp->cacheCheck = ++VolumeCacheCheck;
3221         /* just in case this ever rolls over */
3222         if (!vp->cacheCheck)
3223             vp->cacheCheck = ++VolumeCacheCheck;
3224         VOL_UNLOCK;
3225
3226 #ifdef AFS_DEMAND_ATTACH_FS
3227         V_attachFlags(vp) |= VOL_HDR_LOADED;
3228         vp->stats.last_hdr_load = vp->stats.last_attach;
3229 #endif /* AFS_DEMAND_ATTACH_FS */
3230     }
3231
3232     if (!*ec) {
3233         struct IndexFileHeader iHead;
3234
3235         /*
3236          * We just read in the diskstuff part of the header.  If the detailed
3237          * volume stats area has not yet been initialized, we should bzero the
3238          * area and mark it as initialized.
3239          */
3240         if (!(V_stat_initialized(vp))) {
3241             memset((V_stat_area(vp)), 0, VOL_STATS_BYTES);
3242             V_stat_initialized(vp) = 1;
3243         }
3244
3245         (void)ReadHeader(ec, vp->vnodeIndex[vSmall].handle,
3246                          (char *)&iHead, sizeof(iHead),
3247                          SMALLINDEXMAGIC, SMALLINDEXVERSION);
3248
3249         if (*ec) {
3250             Log("VAttachVolume: Error reading smallVnode vol header %s; error=%u\n", path, *ec);
3251         }
3252     }
3253
3254     if (!*ec) {
3255         struct IndexFileHeader iHead;
3256
3257         (void)ReadHeader(ec, vp->vnodeIndex[vLarge].handle,
3258                          (char *)&iHead, sizeof(iHead),
3259                          LARGEINDEXMAGIC, LARGEINDEXVERSION);
3260
3261         if (*ec) {
3262             Log("VAttachVolume: Error reading largeVnode vol header %s; error=%u\n", path, *ec);
3263         }
3264     }
3265
3266 #ifdef AFS_NAMEI_ENV
3267     if (!*ec) {
3268         struct versionStamp stamp;
3269
3270         (void)ReadHeader(ec, V_linkHandle(vp), (char *)&stamp,
3271                          sizeof(stamp), LINKTABLEMAGIC, LINKTABLEVERSION);
3272
3273         if (*ec) {
3274             Log("VAttachVolume: Error reading namei vol header %s; error=%u\n", path, *ec);
3275         }
3276     }
3277 #endif /* AFS_NAMEI_ENV */
3278
3279 #if defined(AFS_DEMAND_ATTACH_FS)
3280     if (*ec && ((*ec != VOFFLINE) || (V_attachState(vp) != VOL_STATE_UNATTACHED))) {
3281         VOL_LOCK;
3282         if (!VCanScheduleSalvage()) {
3283             Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3284         }
3285         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_NO_OFFLINE);
3286         vp->nUsers = 0;
3287
3288         goto locked_error;
3289     } else if (*ec) {
3290         /* volume operation in progress */
3291         VOL_LOCK;
3292         /* we have already transitioned the vp away from ATTACHING state, so we
3293          * can go right to the end of attach2, and we do not need to transition
3294          * to ERROR. */
3295         goto error_notbroken;
3296     }
3297 #else /* AFS_DEMAND_ATTACH_FS */
3298     if (*ec) {
3299         Log("VAttachVolume: Error attaching volume %s; volume needs salvage; error=%u\n", path, *ec);
3300         goto unlocked_error;
3301     }
3302 #endif /* AFS_DEMAND_ATTACH_FS */
3303
3304     if (V_needsSalvaged(vp)) {
3305         if (vp->specialStatus)
3306             vp->specialStatus = 0;
3307         VOL_LOCK;
3308 #if defined(AFS_DEMAND_ATTACH_FS)
3309         if (!VCanScheduleSalvage()) {
3310             Log("VAttachVolume: volume salvage flag is ON for %s; volume needs salvage\n", path);
3311         }
3312         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_NO_OFFLINE);
3313         vp->nUsers = 0;
3314
3315 #else /* AFS_DEMAND_ATTACH_FS */
3316         *ec = VSALVAGE;
3317 #endif /* AFS_DEMAND_ATTACH_FS */
3318
3319         goto locked_error;
3320     }
3321
3322     VOL_LOCK;
3323     vp->nextVnodeUnique = V_uniquifier(vp);
3324
3325     if (VShouldCheckInUse(mode) && V_inUse(vp) && VolumeWriteable(vp)) {
3326         if (!V_needsSalvaged(vp)) {
3327             V_needsSalvaged(vp) = 1;
3328             VUpdateVolume_r(ec, vp, 0);
3329         }
3330 #if defined(AFS_DEMAND_ATTACH_FS)
3331         if (!VCanScheduleSalvage()) {
3332             Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3333         }
3334         VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_NO_OFFLINE);
3335         vp->nUsers = 0;
3336
3337 #else /* AFS_DEMAND_ATTACH_FS */
3338         Log("VAttachVolume: volume %s needs to be salvaged; not attached.\n", path);
3339         *ec = VSALVAGE;
3340 #endif /* AFS_DEMAND_ATTACH_FS */
3341
3342         goto locked_error;
3343     }
3344
3345     if (programType == fileServer && V_destroyMe(vp) == DESTROY_ME) {
3346         /* Only check destroyMe if we are the fileserver, since the
3347          * volserver et al sometimes need to work with volumes with
3348          * destroyMe set. Examples are 'temporary' volumes the
3349          * volserver creates, and when we create a volume (destroyMe
3350          * is set on creation; sometimes a separate volserver
3351          * transaction is created to clear destroyMe).
3352          */
3353
3354 #if defined(AFS_DEMAND_ATTACH_FS)
3355         /* schedule a salvage so the volume goes away on disk */
3356         VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_NO_OFFLINE);
3357         VChangeState_r(vp, VOL_STATE_ERROR);
3358         vp->nUsers = 0;
3359         forcefree = 1;
3360 #endif /* AFS_DEMAND_ATTACH_FS */
3361         Log("VAttachVolume: volume %s is junk; it should be destroyed at next salvage\n", path);
3362         *ec = VNOVOL;
3363         goto locked_error;
3364     }
3365
3366     vp->vnodeIndex[vSmall].bitmap = vp->vnodeIndex[vLarge].bitmap = NULL;
3367 #ifndef BITMAP_LATER
3368     if (programType == fileServer && VolumeWriteable(vp)) {
3369         int i;
3370         for (i = 0; i < nVNODECLASSES; i++) {
3371             VGetBitmap_r(ec, vp, i);
3372             if (*ec) {
3373 #ifdef AFS_DEMAND_ATTACH_FS
3374                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_NO_OFFLINE);
3375                 vp->nUsers = 0;
3376 #endif /* AFS_DEMAND_ATTACH_FS */
3377                 Log("VAttachVolume: error getting bitmap for volume (%s)\n",
3378                     path);
3379                 goto locked_error;
3380             }
3381         }
3382     }
3383 #endif /* BITMAP_LATER */
3384
3385     if (VInit >= 2 && V_needsCallback(vp)) {
3386         if (V_BreakVolumeCallbacks) {
3387             Log("VAttachVolume: Volume %lu was changed externally; breaking callbacks\n",
3388                 afs_printable_uint32_lu(V_id(vp)));
3389             V_needsCallback(vp) = 0;
3390             VOL_UNLOCK;
3391             (*V_BreakVolumeCallbacks) (V_id(vp));
3392             VOL_LOCK;
3393
3394             VUpdateVolume_r(ec, vp, 0);
3395         }
3396 #ifdef FSSYNC_BUILD_CLIENT
3397         else if (VCanUseFSSYNC()) {
3398             afs_int32 fsync_code;
3399
3400             V_needsCallback(vp) = 0;
3401             VOL_UNLOCK;
3402             fsync_code = FSYNC_VolOp(V_id(vp), NULL, FSYNC_VOL_BREAKCBKS, FSYNC_WHATEVER, NULL);
3403             VOL_LOCK;
3404
3405             if (fsync_code) {
3406                 V_needsCallback(vp) = 1;
3407                 Log("Error trying to tell the fileserver to break callbacks for "
3408                     "changed volume %lu; error code %ld\n",
3409                     afs_printable_uint32_lu(V_id(vp)),
3410                     afs_printable_int32_ld(fsync_code));
3411             } else {
3412                 VUpdateVolume_r(ec, vp, 0);
3413             }
3414         }
3415 #endif /* FSSYNC_BUILD_CLIENT */
3416
3417         if (*ec) {
3418             Log("VAttachVolume: error %d clearing needsCallback on volume "
3419                 "%lu; needs salvage\n", (int)*ec,
3420                 afs_printable_uint32_lu(V_id(vp)));
3421 #ifdef AFS_DEMAND_ATTACH_FS
3422             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, VOL_SALVAGE_NO_OFFLINE);
3423             vp->nUsers = 0;
3424 #else /* !AFS_DEMAND_ATTACH_FS */
3425             *ec = VSALVAGE;
3426 #endif /* !AFS_DEMAND_ATTACh_FS */
3427             goto locked_error;
3428         }
3429     }
3430
3431     if (programType == fileServer) {
3432         if (vp->specialStatus)
3433             vp->specialStatus = 0;
3434         if (V_blessed(vp) && V_inService(vp) && !V_needsSalvaged(vp)) {
3435             V_inUse(vp) = fileServer;
3436             V_offlineMessage(vp)[0] = '\0';
3437         }
3438 #ifdef AFS_DEMAND_ATTACH_FS
3439         /* check if the volume is actually usable. only do this for DAFS; for
3440          * non-DAFS, volumes that are not inService/blessed can still be
3441          * attached, even if clients cannot access them. this is relevant
3442          * because for non-DAFS, we try to attach the volume when e.g.
3443          * volserver gives us back then vol when its done with it, but
3444          * volserver may give us back a volume that is not inService/blessed. */
3445
3446         if (!V_inUse(vp)) {
3447             *ec = VNOVOL;
3448             /* Put the vol into PREATTACHED state, so if someone tries to
3449              * access it again, we try to attach, see that we're not blessed,
3450              * and give a VNOVOL error again. Putting it into UNATTACHED state
3451              * would result in a VOFFLINE error instead. */
3452             error_state = VOL_STATE_PREATTACHED;
3453
3454             /* mimic e.g. GetVolume errors */
3455             if (!V_blessed(vp)) {
3456                 Log("Volume %lu offline: not blessed\n", afs_printable_uint32_lu(V_id(vp)));
3457                 FreeVolumeHeader(vp);
3458             } else if (!V_inService(vp)) {
3459                 Log("Volume %lu offline: not in service\n", afs_printable_uint32_lu(V_id(vp)));
3460                 /* the volume is offline and should be unattached */
3461                 *ec = VOFFLINE;
3462                 error_state = VOL_STATE_UNATTACHED;
3463                 FreeVolumeHeader(vp);
3464             } else {
3465                 Log("Volume %lu offline: needs salvage\n", afs_printable_uint32_lu(V_id(vp)));
3466                 *ec = VSALVAGE;
3467                 error_state = VOL_STATE_ERROR;
3468                 /* see if we can recover */
3469                 VRequestSalvage_r(ec, vp, SALVSYNC_NEEDED, VOL_SALVAGE_NO_OFFLINE);
3470             }
3471             vp->nUsers = 0;
3472             goto locked_error;
3473         }
3474 #endif /* AFS_DEMAND_ATTACH_FS */
3475     } else {
3476 #ifdef AFS_DEMAND_ATTACH_FS
3477         if ((mode != V_PEEK) && (mode != V_SECRETLY) && (mode != V_READONLY))
3478             V_inUse(vp) = programType;
3479 #endif /* AFS_DEMAND_ATTACH_FS */
3480         V_checkoutMode(vp) = mode;
3481     }
3482
3483     AddVolumeToHashTable(vp, vp->hashid);
3484 #ifdef AFS_DEMAND_ATTACH_FS
3485     if (VCanUnlockAttached() && (V_attachFlags(vp) & VOL_LOCKED)) {
3486         VUnlockVolume(vp);
3487     }
3488     if ((programType != fileServer) ||
3489         (V_inUse(vp) == fileServer)) {
3490         AddVolumeToVByPList_r(vp);
3491         VLRU_Add_r(vp);
3492         VChangeState_r(vp, VOL_STATE_ATTACHED);
3493     } else {
3494         VChangeState_r(vp, VOL_STATE_UNATTACHED);
3495     }
3496 #endif
3497
3498     return vp;
3499
3500 unlocked_error:
3501     VOL_LOCK;
3502 locked_error:
3503 #ifdef AFS_DEMAND_ATTACH_FS
3504     if (!VIsErrorState(V_attachState(vp))) {
3505         if (programType != fileServer && *ec == VNOVOL) {
3506             /* do not log anything in this case; it is common for
3507              * non-fileserver programs to fail here with VNOVOL, since that
3508              * is what happens when they simply try to use a volume, but that
3509              * volume doesn't exist. */
3510
3511         } else if (VIsErrorState(error_state)) {
3512             Log("attach2: forcing vol %" AFS_VOLID_FMT " to error state (state %u flags 0x%x ec %d)\n",
3513                 afs_printable_VolumeId_lu(vp->hashid), V_attachState(vp),
3514                 V_attachFlags(vp), *ec);
3515         }
3516         VChangeState_r(vp, error_state);
3517     }
3518 #endif /* AFS_DEMAND_ATTACH_FS */
3519
3520     if (read_header) {
3521         VReleaseVolumeHandles_r(vp);
3522     }
3523
3524 #ifdef AFS_DEMAND_ATTACH_FS
3525  error_notbroken:
3526     if (VCheckSalvage(vp) == VCHECK_SALVAGE_FAIL) {
3527         /* The salvage could not be scheduled with the salvage server
3528          * due to a hard error. Reset the error code to prevent retry loops by
3529          * callers. */
3530         if (*ec == VSALVAGING) {
3531             *ec = VSALVAGE;
3532         }
3533     }
3534     if (forcefree) {
3535         FreeVolume(vp);
3536     } else {
3537         VCheckFree(vp);
3538     }
3539 #else /* !AFS_DEMAND_ATTACH_FS */
3540     FreeVolume(vp);
3541 #endif /* !AFS_DEMAND_ATTACH_FS */
3542     return NULL;
3543 }
3544
3545 /* Attach an existing volume.
3546    The volume also normally goes online at this time.
3547    An offline volume must be reattached to make it go online.
3548  */
3549
3550 Volume *
3551 VAttachVolume(Error * ec, VolumeId volumeId, int mode)
3552 {
3553     Volume *retVal;
3554     VOL_LOCK;
3555     retVal = VAttachVolume_r(ec, volumeId, mode);
3556     VOL_UNLOCK;
3557     return retVal;
3558 }
3559
3560 Volume *
3561 VAttachVolume_r(Error * ec, VolumeId volumeId, int mode)
3562 {
3563     char *part, *name;
3564     VGetVolumePath(ec, volumeId, &part, &name);
3565     if (*ec) {
3566         Volume *vp;
3567         Error error;
3568         vp = VGetVolume_r(&error, volumeId);
3569         if (vp) {
3570             opr_Assert(V_inUse(vp) == 0);
3571             VDetachVolume_r(ec, vp);
3572         }
3573         return NULL;
3574     }
3575     return VAttachVolumeByName_r(ec, part, name, mode);
3576 }
3577
3578 /* Increment a reference count to a volume, sans context swaps.  Requires
3579  * possibly reading the volume header in from the disk, since there's
3580  * an invariant in the volume package that nUsers>0 ==> vp->header is valid.
3581  *
3582  * N.B. This call can fail if we can't read in the header!!  In this case
3583  * we still guarantee we won't context swap, but the ref count won't be
3584  * incremented (otherwise we'd violate the invariant).
3585  */
3586 /* NOTE: with the demand attach fileserver extensions, the global lock
3587  * is dropped within VHold */
3588 #ifdef AFS_DEMAND_ATTACH_FS
3589 static int
3590 VHold_r(Volume * vp)
3591 {
3592     Error error;
3593
3594     VCreateReservation_r(vp);
3595     VWaitExclusiveState_r(vp);
3596
3597     LoadVolumeHeader(&error, vp);
3598     if (error) {
3599         VCancelReservation_r(vp);
3600         return error;
3601     }
3602     vp->nUsers++;
3603     VCancelReservation_r(vp);
3604     return 0;
3605 }
3606 #else /* AFS_DEMAND_ATTACH_FS */
3607 static int
3608 VHold_r(Volume * vp)
3609 {
3610     Error error;
3611
3612     LoadVolumeHeader(&error, vp);
3613     if (error)
3614         return error;
3615     vp->nUsers++;
3616     return 0;
3617 }
3618 #endif /* AFS_DEMAND_ATTACH_FS */
3619
3620 /**** volume timeout-related stuff ****/
3621
3622 #ifdef AFS_PTHREAD_ENV
3623
3624 static struct timespec *shutdown_timeout;
3625 static pthread_once_t shutdown_timeout_once = PTHREAD_ONCE_INIT;
3626
3627 static_inline int
3628 VTimedOut(const struct timespec *ts)
3629 {
3630     struct timeval tv;
3631     int code;
3632
3633     if (ts->tv_sec == 0) {
3634         /* short-circuit; this will have always timed out */
3635         return 1;
3636     }
3637
3638     code = gettimeofday(&tv, NULL);
3639     if (code) {
3640         Log("Error %d from gettimeofday, assuming we have not timed out\n", errno);
3641         /* assume no timeout; failure mode is we just wait longer than normal
3642          * instead of returning errors when we shouldn't */
3643         return 0;
3644     }
3645
3646     if (tv.tv_sec < ts->tv_sec ||
3647         (tv.tv_sec == ts->tv_sec && tv.tv_usec*1000 < ts->tv_nsec)) {
3648
3649         return 0;
3650     }
3651
3652     return 1;
3653 }
3654
3655 /**
3656  * Calculate an absolute timeout.
3657  *
3658  * @param[out] ts  A timeout that is "timeout" seconds from now, if we return
3659  *                 NULL, the memory is not touched
3660  * @param[in]  timeout  How long the timeout should be from now
3661  *
3662  * @return timeout to use
3663  *  @retval NULL      no timeout; wait forever
3664  *  @retval non-NULL  the given value for "ts"
3665  *
3666  * @internal
3667  */
3668 static struct timespec *
3669 VCalcTimeout(struct timespec *ts, afs_int32 timeout)
3670 {
3671     struct timeval now;
3672     int code;
3673
3674     if (timeout < 0) {
3675         return NULL;
3676     }
3677
3678     if (timeout == 0) {
3679         ts->tv_sec = ts->tv_nsec = 0;
3680         return ts;
3681     }
3682
3683     code = gettimeofday(&now, NULL);
3684     if (code) {
3685         Log("Error %d from gettimeofday, falling back to 'forever' timeout\n", errno);
3686         return NULL;
3687     }
3688
3689     ts->tv_sec = now.tv_sec + timeout;
3690     ts->tv_nsec = now.tv_usec * 1000;
3691
3692     return ts;
3693 }
3694
3695 /**
3696  * Initialize the shutdown_timeout global.
3697  */
3698 static void
3699 VShutdownTimeoutInit(void)
3700 {
3701     struct timespec *ts;
3702
3703     ts = malloc(sizeof(*ts));
3704
3705     shutdown_timeout = VCalcTimeout(ts, vol_opts.offline_shutdown_timeout);
3706
3707     if (!shutdown_timeout) {
3708         free(ts);
3709     }
3710 }
3711
3712 /**
3713  * Figure out the timeout that should be used for waiting for offline volumes.
3714  *
3715  * @param[out] ats  Storage space for a local timeout value if needed
3716  *
3717  * @return The timeout value that should be used
3718  *   @retval NULL      No timeout; wait forever for offlining volumes
3719  *   @retval non-NULL  A pointer to the absolute time that should be used as
3720  *                     the deadline for waiting for offlining volumes.
3721  *
3722  * @note If we return non-NULL, the pointer we return may or may not be the
3723  *       same as "ats"
3724  */
3725 static const struct timespec *
3726 VOfflineTimeout(struct timespec *ats)
3727 {
3728     if (vol_shutting_down) {
3729         opr_Verify(pthread_once(&shutdown_timeout_once,
3730                                 VShutdownTimeoutInit) == 0);
3731         return shutdown_timeout;
3732     } else {
3733         return VCalcTimeout(ats, vol_opts.offline_timeout);
3734     }
3735 }
3736
3737 #else /* AFS_PTHREAD_ENV */
3738
3739 /* Waiting a certain amount of time for offlining volumes is not supported
3740  * for LWP due to a lack of primitives. So, we never time out */
3741 # define VTimedOut(x) (0)
3742 # define VOfflineTimeout(x) (NULL)
3743
3744 #endif /* !AFS_PTHREAD_ENV */
3745
3746 static afs_int32
3747 VIsGoingOffline_r(struct Volume *vp)
3748 {
3749     afs_int32 code = 0;
3750
3751     if (vp->goingOffline) {
3752         if (vp->specialStatus) {
3753             code = vp->specialStatus;
3754         } else if (V_inService(vp) == 0 || V_blessed(vp) == 0) {
3755             code = VNOVOL;
3756         } else {
3757             code = VOFFLINE;
3758         }
3759     }
3760
3761     return code;
3762 }
3763
3764 /**
3765  * Tell the caller if a volume is waiting to go offline.
3766  *
3767  * @param[in] vp  The volume we want to know about
3768  *
3769  * @return volume status
3770  *   @retval 0 volume is not waiting to go offline, go ahead and use it
3771  *   @retval nonzero volume is waiting to offline, and give the returned code
3772  *           as an error to anyone accessing the volume
3773  *
3774  * @pre VOL_LOCK is NOT held
3775  * @pre caller holds a heavyweight reference on vp
3776  */
3777 afs_int32
3778 VIsGoingOffline(struct Volume *vp)
3779 {
3780     afs_int32 code;
3781
3782     VOL_LOCK;
3783     code = VIsGoingOffline_r(vp);
3784     VOL_UNLOCK;
3785
3786     return code;
3787 }
3788
3789 /**
3790  * Register an RX call with a volume.
3791  *
3792  * @param[inout] ec        Error code; if unset when passed in, may be set if
3793  *                         the volume starts going offline
3794  * @param[out]   client_ec @see GetVolume
3795  * @param[in] vp   Volume struct
3796  * @param[in] cbv  VCallByVol struct containing the RX call to register
3797  *
3798  * @pre VOL_LOCK held
3799  * @pre caller holds heavy ref on vp
3800  *
3801  * @internal
3802  */
3803 static void
3804 VRegisterCall_r(Error *ec, Error *client_ec, Volume *vp, struct VCallByVol *cbv)
3805 {
3806     if (vp && cbv) {
3807 #ifdef AFS_DEMAND_ATTACH_FS
3808         if (!*ec) {
3809             /* just in case the volume started going offline after we got the
3810              * reference to it... otherwise, if the volume started going
3811              * offline right at the end of GetVolume(), we might race with the
3812              * RX call scanner, and return success and add our cbv to the
3813              * rx_call_list _after_ the scanner has scanned the list. */
3814             *ec = VIsGoingOffline_r(vp);
3815             if (client_ec) {
3816                 *client_ec = *ec;
3817             }
3818         }
3819
3820         while (V_attachState(vp) == VOL_STATE_SCANNING_RXCALLS) {
3821             VWaitStateChange_r(vp);
3822         }
3823 #endif /* AFS_DEMAND_ATTACH_FS */
3824
3825         queue_Prepend(&vp->rx_call_list, cbv);
3826     }
3827 }
3828
3829 /**
3830  * Deregister an RX call with a volume.
3831  *
3832  * @param[in] vp   Volume struct
3833  * @param[in] cbv  VCallByVol struct containing the RX call to deregister
3834  *
3835  * @pre VOL_LOCK held
3836  * @pre caller holds heavy ref on vp
3837  *
3838  * @internal
3839  */
3840 static void
3841 VDeregisterCall_r(Volume *vp, struct VCallByVol *cbv)
3842 {
3843     if (cbv && queue_IsOnQueue(cbv)) {
3844 #ifdef AFS_DEMAND_ATTACH_FS
3845         while (V_attachState(vp) == VOL_STATE_SCANNING_RXCALLS) {
3846             VWaitStateChange_r(vp);
3847         }
3848 #endif /* AFS_DEMAND_ATTACH_FS */
3849
3850         queue_Remove(cbv);
3851     }
3852 }
3853
3854 /***************************************************/
3855 /* get and put volume routines                     */
3856 /***************************************************/
3857
3858 /**
3859  * put back a heavyweight reference to a volume object.
3860  *
3861  * @param[in] vp  volume object pointer
3862  *
3863  * @pre VOL_LOCK held
3864  *
3865  * @post heavyweight volume reference put back.
3866  *       depending on state, volume may have been taken offline,
3867  *       detached, salvaged, freed, etc.
3868  *
3869  * @internal volume package internal use only
3870  */
3871 void
3872 VPutVolume_r(Volume * vp)
3873 {
3874     opr_Verify(--vp->nUsers >= 0);
3875     if (vp->nUsers == 0) {
3876         VCheckOffline(vp);
3877         ReleaseVolumeHeader(vp->header);
3878 #ifdef AFS_DEMAND_ATTACH_FS
3879         if (!VCheckDetach(vp)) {
3880             VCheckSalvage(vp);
3881             VCheckFree(vp);
3882         }
3883 #else /* AFS_DEMAND_ATTACH_FS */
3884         VCheckDetach(vp);
3885 #endif /* AFS_DEMAND_ATTACH_FS */
3886     }
3887 }
3888
3889 void
3890 VPutVolume(Volume * vp)
3891 {
3892     VOL_LOCK;
3893     VPutVolume_r(vp);
3894     VOL_UNLOCK;
3895 }
3896
3897 /**
3898  * Puts a volume reference obtained with VGetVolumeWithCall.
3899  *
3900  * @param[in] vp  Volume struct
3901  * @param[in] cbv VCallByVol struct given to VGetVolumeWithCall, or NULL if none
3902  *
3903  * @pre VOL_LOCK is NOT held
3904  */
3905 void
3906 VPutVolumeWithCall(Volume *vp, struct VCallByVol *cbv)
3907 {
3908     VOL_LOCK;
3909     VDeregisterCall_r(vp, cbv);
3910     VPutVolume_r(vp);
3911     VOL_UNLOCK;
3912 }
3913
3914 /* Get a pointer to an attached volume.  The pointer is returned regardless
3915    of whether or not the volume is in service or on/off line.  An error
3916    code, however, is returned with an indication of the volume's status */
3917 Volume *
3918 VGetVolume(Error * ec, Error * client_ec, VolumeId volumeId)
3919 {
3920     Volume *retVal;
3921     VOL_LOCK;
3922     retVal = GetVolume(ec, client_ec, volumeId, NULL, 0);
3923     VOL_UNLOCK;
3924     return retVal;
3925 }
3926
3927 /**
3928  * Get a volume reference associated with an RX call.
3929  *
3930  * @param[out] ec @see GetVolume
3931  * @param[out] client_ec @see GetVolume
3932  * @param[in] volumeId @see GetVolume
3933  * @param[in] ts  How long to wait for going-offline volumes (absolute time).
3934  *                If NULL, wait forever. If ts->tv_sec == 0, return immediately
3935  *                with an error if the volume is going offline.
3936  * @param[in] cbv Contains an RX call to be associated with this volume
3937  *                reference. This call may be interrupted if the volume is
3938  *                requested to go offline while we hold a ref on it. Give NULL
3939  *                to not associate an RX call with this reference.
3940  *
3941  * @return @see GetVolume
3942  *
3943  * @note for LWP builds, ts must be NULL
3944  *
3945  * @note A reference obtained with this function MUST be put back with
3946  *       VPutVolumeWithCall
3947  */
3948 Volume *
3949 VGetVolumeWithCall(Error * ec, Error * client_ec, VolumeId volumeId,
3950                    const struct timespec *ts, struct VCallByVol *cbv)
3951 {
3952     Volume *retVal;
3953     VOL_LOCK;
3954     retVal = GetVolume(ec, client_ec, volumeId, NULL, ts);
3955     VRegisterCall_r(ec, client_ec, retVal, cbv);
3956     VOL_UNLOCK;
3957     return retVal;
3958 }
3959
3960 Volume *
3961 VGetVolume_r(Error * ec, VolumeId volumeId)
3962 {
3963     return GetVolume(ec, NULL, volumeId, NULL, NULL);
3964 }
3965
3966 /* try to get a volume we've previously looked up */
3967 /* for demand attach fs, caller MUST NOT hold a ref count on vp */
3968 Volume *
3969 VGetVolumeByVp_r(Error * ec, Volume * vp)
3970 {
3971     return GetVolume(ec, NULL, vp->hashid, vp, NULL);
3972 }
3973
3974 /**
3975  * private interface for getting a volume handle
3976  *
3977  * @param[out] ec         error code (0 if no error)
3978  * @param[out] client_ec  wire error code to be given to clients
3979  * @param[in]  volumeId   ID of the volume we want
3980  * @param[in]  hint       optional hint for hash lookups, or NULL
3981  * @param[in]  timeout    absolute deadline for waiting for the volume to go
3982  *                        offline, if it is going offline. NULL to wait forever.
3983  *
3984  * @return a volume handle for the specified volume
3985  *  @retval NULL an error occurred, or the volume is in such a state that
3986  *               we cannot load a header or return any volume struct
3987  *
3988  * @note for DAFS, caller must NOT hold a ref count on 'hint'
3989  *
3990  * @note 'timeout' is only checked if the volume is actually going offline; so
3991  *       if you pass timeout->tv_sec = 0, this will exhibit typical
3992  *       nonblocking behavior.
3993  *
3994  * @note for LWP builds, 'timeout' must be NULL
3995  */
3996 static Volume *
3997 GetVolume(Error * ec, Error * client_ec, VolumeId volumeId, Volume * hint,
3998           const struct timespec *timeout)
3999 {
4000     Volume *vp = hint;
4001 #ifdef AFS_DEMAND_ATTACH_FS
4002     Volume *avp, * rvp = hint;
4003 #endif
4004
4005     /*
4006      * if VInit is zero, the volume package dynamic
4007      * data structures have not been initialized yet,
4008      * and we must immediately return an error
4009      */
4010     if (VInit == 0) {
4011         vp = NULL;
4012         *ec = VOFFLINE;
4013         if (client_ec) {
4014             *client_ec = VOFFLINE;
4015         }
4016         goto not_inited;
4017     }
4018
4019 #ifdef AFS_DEMAND_ATTACH_FS
4020     if (rvp) {
4021         VCreateReservation_r(rvp);
4022     }
4023 #endif /* AFS_DEMAND_ATTACH_FS */
4024
4025     for (;;) {
4026         *ec = 0;
4027         if (client_ec)
4028             *client_ec = 0;
4029
4030         vp = VLookupVolume_r(ec, volumeId, vp);
4031         if (*ec) {
4032             vp = NULL;
4033             break;
4034         }
4035
4036 #ifdef AFS_DEMAND_ATTACH_FS
4037         if (rvp && (rvp != vp)) {
4038             /* break reservation on old vp */
4039             VCancelReservation_r(rvp);
4040             rvp = NULL;
4041         }
4042 #endif /* AFS_DEMAND_ATTACH_FS */
4043
4044         if (!vp) {
4045             if (VInit < 2) {
4046                 /* Until we have reached an initialization level of 2
4047                  * we don't know whether this volume exists or not.
4048                  * We can't sleep and retry later because before a volume
4049                  * is attached, the caller tries to get it first.  Just
4050                  * return VOFFLINE and the caller can choose whether to
4051                  * retry the command or not. */
4052                 *ec = VOFFLINE;
4053                 break;
4054             }
4055
4056             *ec = VNOVOL;
4057             break;
4058         }
4059
4060         IncUInt64(&VStats.hdr_gets);
4061
4062 #ifdef AFS_DEMAND_ATTACH_FS
4063         /* block if someone else is performing an exclusive op on this volume */
4064         if (rvp != vp) {
4065             rvp = vp;
4066             VCreateReservation_r(rvp);
4067         }
4068         VWaitExclusiveState_r(vp);
4069
4070         /* short circuit with VNOVOL in the following circumstances:
4071          *
4072          *   - VOL_STATE_ERROR
4073          *   - VOL_STATE_SHUTTING_DOWN
4074          */
4075         if ((V_attachState(vp) == VOL_STATE_ERROR) ||
4076             (V_attachState(vp) == VOL_STATE_SHUTTING_DOWN)) {
4077             *ec = VNOVOL;
4078             vp = NULL;
4079             break;
4080         }
4081
4082         /*
4083          * short circuit with VOFFLINE for VOL_STATE_UNATTACHED/GOING_OFFLINE and
4084          *                    VNOVOL   for VOL_STATE_DELETED
4085          */
4086        if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
4087            (V_attachState(vp) == VOL_STATE_GOING_OFFLINE) ||
4088            (V_attachState(vp) == VOL_STATE_DELETED)) {
4089            if (vp->specialStatus) {
4090                *ec = vp->specialStatus;
4091            } else if (V_attachState(vp) == VOL_STATE_DELETED) {
4092                *ec = VNOVOL;
4093            } else {
4094                *ec = VOFFLINE;
4095            }
4096            vp = NULL;
4097            break;
4098        }
4099
4100         /* allowable states:
4101          *   - PREATTACHED
4102          *   - ATTACHED
4103          *   - SALVAGING
4104          *   - SALVAGE_REQ
4105          */
4106
4107         if (vp->salvage.requested) {
4108             VUpdateSalvagePriority_r(vp);
4109         }
4110
4111         if (V_attachState(vp) == VOL_STATE_PREATTACHED) {
4112             if (vp->specialStatus) {
4113                 *ec = vp->specialStatus;
4114                 vp = NULL;
4115                 break;
4116             }
4117             avp = VAttachVolumeByVp_r(ec, vp, 0);
4118             if (avp) {
4119                 if (vp != avp) {
4120                     /* VAttachVolumeByVp_r can return a pointer
4121                      * != the vp passed to it under certain
4122                      * conditions; make sure we don't leak
4123                      * reservations if that happens */
4124                     vp = avp;
4125                     VCancelReservation_r(rvp);
4126                     rvp = avp;
4127                     VCreateReservation_r(rvp);
4128                 }
4129                 VPutVolume_r(avp);
4130             }
4131             if (*ec) {
4132                 int endloop = 0;
4133                 switch (*ec) {
4134                 case VSALVAGING:
4135                     break;
4136                 case VOFFLINE:
4137                     endloop = 1;
4138                     if (vp->specialStatus) {
4139                         *ec = vp->specialStatus;
4140                     }
4141                     break;
4142
4143                 default:
4144                     if (vp->specialStatus) {
4145                         *ec = vp->specialStatus;
4146                     } else {
4147                         *ec = VNOVOL;
4148                     }
4149                     endloop = 1;
4150                 }
4151                 if (endloop) {
4152                     vp = NULL;
4153                     break;
4154                 }
4155             }
4156         }
4157
4158         if (VIsSalvaging(vp) || (*ec == VSALVAGING)) {
4159             if (client_ec) {
4160                 /* see CheckVnode() in afsfileprocs.c for an explanation
4161                  * of this error code logic */
4162                 afs_uint32 now = FT_ApproxTime();
4163                 if ((vp->stats.last_salvage + (10 * 60)) >= now) {
4164                     *client_ec = VBUSY;
4165                 } else {
4166                     *client_ec = VRESTARTING;
4167                 }
4168             }
4169             *ec = VSALVAGING;
4170             vp = NULL;
4171             break;
4172         }
4173
4174         if (VIsErrorState(V_attachState(vp))) {
4175             /* make sure we don't take a vp in VOL_STATE_ERROR state and use
4176              * it, or transition it out of that state */
4177             if (!*ec) {
4178                 *ec = VNOVOL;
4179             }
4180             vp = NULL;
4181             break;
4182         }
4183
4184         /*
4185          * this test MUST happen after VAttachVolymeByVp, so we have no
4186          * conflicting vol op. (attach2 would have errored out if we had one;
4187          * specifically attach_check_vop must have detected a conflicting vop)
4188          */
4189          opr_Assert(!vp->pending_vol_op || vp->pending_vol_op->vol_op_state == FSSYNC_VolOpRunningOnline);
4190
4191 #endif /* AFS_DEMAND_ATTACH_FS */
4192
4193         LoadVolumeHeader(ec, vp);
4194         if (*ec) {
4195             /* Only log the error if it was a totally unexpected error.  Simply
4196              * a missing inode is likely to be caused by the volume being deleted */
4197             if (errno != ENXIO || GetLogLevel() != 0)
4198                 Log("Volume %" AFS_VOLID_FMT ": couldn't reread volume header\n",
4199                     afs_printable_VolumeId_lu(vp->hashid));
4200 #ifdef AFS_DEMAND_ATTACH_FS
4201             if (VCanScheduleSalvage()) {
4202                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0 /*flags*/);
4203             } else {
4204                 FreeVolume(vp);
4205                 vp = NULL;
4206             }
4207 #else /* AFS_DEMAND_ATTACH_FS */
4208             FreeVolume(vp);
4209             vp = NULL;
4210 #endif /* AFS_DEMAND_ATTACH_FS */
4211             break;
4212         }
4213
4214         if (vp->shuttingDown) {
4215             *ec = VNOVOL;
4216             vp = NULL;
4217             break;
4218         }
4219
4220         if (programType == fileServer) {
4221             if (vp->goingOffline) {
4222                 if (timeout && VTimedOut(timeout)) {
4223                     /* we've timed out; don't wait for the vol */
4224                 } else {
4225 #ifdef AFS_DEMAND_ATTACH_FS
4226                     /* wait for the volume to go offline */
4227                     if (V_attachState(vp) == VOL_STATE_GOING_OFFLINE) {
4228                         VTimedWaitStateChange_r(vp, timeout, NULL);
4229                     }
4230 #elif defined(AFS_PTHREAD_ENV)
4231                     VOL_CV_TIMEDWAIT(&vol_put_volume_cond, timeout, NULL);
4232 #else /* AFS_PTHREAD_ENV */
4233                     /* LWP has no timed wait, so the caller better not be
4234                      * expecting one */
4235                     opr_Assert(!timeout);
4236                     LWP_WaitProcess(VPutVolume);
4237 #endif /* AFS_PTHREAD_ENV */
4238                     continue;
4239                 }
4240             }
4241             if (vp->specialStatus) {
4242                 *ec = vp->specialStatus;
4243             } else if (V_inService(vp) == 0 || V_blessed(vp) == 0) {
4244                 *ec = VNOVOL;
4245             } else if (V_inUse(vp) == 0 || vp->goingOffline) {
4246                 *ec = VOFFLINE;
4247             }
4248         }
4249         break;
4250     }
4251
4252 #ifdef AFS_DEMAND_ATTACH_FS
4253     /* if no error, bump nUsers */
4254     if (vp) {
4255         vp->nUsers++;
4256         VLRU_UpdateAccess_r(vp);
4257     }
4258     if (rvp) {
4259         VCancelReservation_r(rvp);
4260         rvp = NULL;
4261     }
4262     if (client_ec && !*client_ec) {
4263         *client_ec = *ec;
4264     }
4265 #else /* AFS_DEMAND_ATTACH_FS */
4266     /* if no error, bump nUsers */
4267     if (vp) {
4268         vp->nUsers++;
4269     }
4270     if (client_ec) {
4271         *client_ec = *ec;
4272     }
4273 #endif /* AFS_DEMAND_ATTACH_FS */
4274
4275  not_inited:
4276     opr_Assert(vp || *ec);
4277     return vp;
4278 }
4279
4280
4281 /***************************************************/
4282 /* Volume offline/detach routines                  */
4283 /***************************************************/
4284
4285 /* caller MUST hold a heavyweight ref on vp */
4286 #ifdef AFS_DEMAND_ATTACH_FS
4287 void
4288 VTakeOffline_r(Volume * vp)
4289 {
4290     Error error;
4291
4292     opr_Assert(vp->nUsers > 0);
4293     opr_Assert(programType == fileServer);
4294
4295     VCreateReservation_r(vp);
4296     VWaitExclusiveState_r(vp);
4297
4298     vp->goingOffline = 1;
4299     V_needsSalvaged(vp) = 1;
4300
4301     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0);
4302     VCancelReservation_r(vp);
4303 }
4304 #else /* AFS_DEMAND_ATTACH_FS */
4305 void
4306 VTakeOffline_r(Volume * vp)
4307 {
4308     opr_Assert(vp->nUsers > 0);
4309     opr_Assert(programType == fileServer);
4310
4311     vp->goingOffline = 1;
4312     V_needsSalvaged(vp) = 1;
4313 }
4314 #endif /* AFS_DEMAND_ATTACH_FS */
4315
4316 void
4317 VTakeOffline(Volume * vp)
4318 {
4319     VOL_LOCK;
4320     VTakeOffline_r(vp);
4321     VOL_UNLOCK;
4322 }
4323
4324 /**
4325  * force a volume offline.
4326  *
4327  * @param[in] vp     volume object pointer
4328  * @param[in] flags  flags (see note below)
4329  *
4330  * @note the flag VOL_FORCEOFF_NOUPDATE is a recursion control flag
4331  *       used when VUpdateVolume_r needs to call VForceOffline_r
4332  *       (which in turn would normally call VUpdateVolume_r)
4333  *
4334  * @see VUpdateVolume_r
4335  *
4336  * @pre VOL_LOCK must be held.
4337  *      for DAFS, caller must hold ref.
4338  *
4339  * @note for DAFS, it _is safe_ to call this function from an
4340  *       exclusive state
4341  *
4342  * @post needsSalvaged flag is set.
4343  *       for DAFS, salvage is requested.
4344  *       no further references to the volume through the volume
4345  *       package will be honored.
4346  *       all file descriptor and vnode caches are invalidated.
4347  *
4348  * @warning this is a heavy-handed interface.  it results in
4349  *          a volume going offline regardless of the current
4350  *          reference count state.
4351  *
4352  * @internal  volume package internal use only
4353  */
4354 void
4355 VForceOffline_r(Volume * vp, int flags)
4356 {
4357     Error error;
4358     if (!V_inUse(vp)) {
4359 #ifdef AFS_DEMAND_ATTACH_FS
4360         VChangeState_r(vp, VOL_STATE_ERROR);
4361 #endif
4362         return;
4363     }
4364
4365     strcpy(V_offlineMessage(vp),
4366            "Forced offline due to internal error: volume needs to be salvaged");
4367     Log("Volume %" AFS_VOLID_FMT " forced offline:  it needs salvaging!\n", afs_printable_VolumeId_lu(V_id(vp)));
4368
4369     V_inUse(vp) = 0;
4370     vp->goingOffline = 0;
4371     V_needsSalvaged(vp) = 1;
4372     if (!(flags & VOL_FORCEOFF_NOUPDATE)) {
4373         VUpdateVolume_r(&error, vp, VOL_UPDATE_NOFORCEOFF);
4374     }
4375
4376 #ifdef AFS_DEMAND_ATTACH_FS
4377     VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0 /*flags*/);
4378 #endif /* AFS_DEMAND_ATTACH_FS */
4379
4380 #ifdef AFS_PTHREAD_ENV
4381     opr_cv_broadcast(&vol_put_volume_cond);
4382 #else /* AFS_PTHREAD_ENV */
4383     LWP_NoYieldSignal(VPutVolume);
4384 #endif /* AFS_PTHREAD_ENV */
4385
4386     VReleaseVolumeHandles_r(vp);
4387 }
4388
4389 /**
4390  * force a volume offline.
4391  *
4392  * @param[in] vp  volume object pointer
4393  *
4394  * @see VForceOffline_r
4395  */
4396 void
4397 VForceOffline(Volume * vp)
4398 {
4399     VOL_LOCK;
4400     VForceOffline_r(vp, 0);
4401     VOL_UNLOCK;
4402 }
4403
4404 /**
4405  * Iterate over the RX calls associated with a volume, and interrupt them.
4406  *
4407  * @param[in] vp The volume whose RX calls we want to scan
4408  *
4409  * @pre VOL_LOCK held
4410  */
4411 static void
4412 VScanCalls_r(struct Volume *vp)
4413 {
4414     struct VCallByVol *cbv, *ncbv;
4415     afs_int32 err;
4416 #ifdef AFS_DEMAND_ATTACH_FS
4417     VolState state_save;
4418 #endif
4419
4420     if (queue_IsEmpty(&vp->rx_call_list))
4421         return; /* no calls to interrupt */
4422     if (!vol_opts.interrupt_rxcall)
4423         return; /* we have no function with which to interrupt calls */
4424     err = VIsGoingOffline_r(vp);
4425     if (!err)
4426         return; /* we're not going offline anymore */
4427
4428 #ifdef AFS_DEMAND_ATTACH_FS
4429     VWaitExclusiveState_r(vp);
4430     state_save = VChangeState_r(vp, VOL_STATE_SCANNING_RXCALLS);
4431     VOL_UNLOCK;
4432 #endif /* AFS_DEMAND_ATTACH_FS */
4433
4434     for(queue_Scan(&vp->rx_call_list, cbv, ncbv, VCallByVol)) {
4435         if (GetLogLevel() != 0) {
4436             struct rx_peer *peer;
4437             char hoststr[16];
4438             peer = rx_PeerOf(rx_ConnectionOf(cbv->call));
4439
4440             Log("Offlining volume %" AFS_VOLID_FMT " while client %s:%u is trying to read "
4441                 "from it; kicking client off with error %ld\n",
4442                 afs_printable_VolumeId_lu(vp->hashid),
4443                 afs_inet_ntoa_r(rx_HostOf(peer), hoststr),
4444                 (unsigned) ntohs(rx_PortOf(peer)),
4445                 (long) err);
4446         }
4447         (*vol_opts.interrupt_rxcall) (cbv->call, err);
4448     }
4449
4450 #ifdef AFS_DEMAND_ATTACH_FS
4451     VOL_LOCK;
4452     VChangeState_r(vp, state_save);
4453 #endif /* AFS_DEMAND_ATTACH_FS */
4454 }
4455
4456 #ifdef AFS_DEMAND_ATTACH_FS
4457 /**
4458  * Wait for a vp to go offline.
4459  *
4460  * @param[out] ec 1 if a salvage on the volume has been requested and
4461  *                salvok == 0, 0 otherwise
4462  * @param[in] vp  The volume to wait for
4463  * @param[in] salvok  If 0, we return immediately with *ec = 1 if the volume
4464  *                    has been requested to salvage. Otherwise we keep waiting
4465  *                    until the volume has gone offline.
4466  *
4467  * @pre VOL_LOCK held
4468  * @pre caller holds a lightweight ref on vp
4469  *
4470  * @note DAFS only
4471  */
4472 static void
4473 VWaitForOfflineByVp_r(Error *ec, struct Volume *vp, int salvok)
4474 {
4475     struct timespec timeout_ts;
4476     const struct timespec *ts;
4477     int timedout = 0;
4478
4479     ts = VOfflineTimeout(&timeout_ts);
4480
4481     *ec = 0;
4482
4483     while (!VIsOfflineState(V_attachState(vp)) && !timedout) {
4484         if (!salvok && vp->salvage.requested) {
4485             *ec = 1;
4486             return;
4487         }
4488         VTimedWaitStateChange_r(vp, ts, &timedout);
4489     }
4490     if (!timedout) {
4491         /* we didn't time out, so the volume must be offline, so we're done */
4492         return;
4493     }
4494
4495     /* If we got here, we timed out waiting for the volume to go offline.
4496      * Kick off the accessing RX calls and wait again */
4497
4498     VScanCalls_r(vp);
4499
4500     while (!VIsOfflineState(V_attachState(vp))) {
4501         if (!salvok && vp->salvage.requested) {
4502             *ec = 1;
4503             return;
4504         }
4505
4506         VWaitStateChange_r(vp);
4507     }
4508 }
4509
4510 #else /* AFS_DEMAND_ATTACH_FS */
4511
4512 /**
4513  * Wait for a volume to go offline.
4514  *
4515  * @pre VOL_LOCK held
4516  *
4517  * @note non-DAFS only (for DAFS, use @see WaitForOfflineByVp_r)
4518  */
4519 static void