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