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