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