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