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