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