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