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