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