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