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