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