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