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