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