Add -unsafe-nosalvage fileserver option
[openafs.git] / src / vol / volume.h
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) 2006-2008 Sine Nomine Associates
10  */
11
12 /*
13         System:         VICE-TWO
14         Module:         volume.h
15         Institution:    The Information Technology Center, Carnegie-Mellon University
16
17  */
18
19 #ifndef __volume_h
20 #define __volume_h  1
21
22 #include <afs/afssyscalls.h>
23 #include "voldefs.h"
24 #include "ihandle.h"
25 #define VolumeWriteable(vp)             (V_type(vp)==readwriteVolume)
26 #define VolumeWriteable2(vol)           (vol.type == readwriteVolume)
27 typedef bit32 FileOffset;       /* Offset in this file */
28 #define Date afs_uint32
29 #include "daemon_com.h"
30 #include "fssync.h"
31
32 #if 0
33 /** turn this on if you suspect a volume package locking bug */
34 #define VOL_LOCK_DEBUG 1
35 #endif
36
37 #ifdef VOL_LOCK_DEBUG
38 #define VOL_LOCK_ASSERT_HELD \
39     assert(vol_glock_holder == pthread_self())
40 #define VOL_LOCK_ASSERT_UNHELD \
41     assert(vol_glock_holder == 0)
42 #define _VOL_LOCK_SET_HELD \
43     vol_glock_holder = pthread_self()
44 #define _VOL_LOCK_SET_UNHELD \
45     vol_glock_holder = 0
46 #define VOL_LOCK_DBG_CV_WAIT_END \
47     do { \
48         VOL_LOCK_ASSERT_UNHELD; \
49         _VOL_LOCK_SET_HELD; \
50     } while(0)
51 #define VOL_LOCK_DBG_CV_WAIT_BEGIN \
52     do { \
53          VOL_LOCK_ASSERT_HELD; \
54          _VOL_LOCK_SET_UNHELD; \
55     } while(0)
56 #else
57 #define VOL_LOCK_ASSERT_HELD
58 #define VOL_LOCK_ASSERT_UNHELD
59 #define VOL_LOCK_DBG_CV_WAIT_BEGIN
60 #define VOL_LOCK_DBG_CV_WAIT_END
61 #endif
62
63
64 #ifdef AFS_PTHREAD_ENV
65 #include <assert.h>
66 #include <pthread.h>
67 extern pthread_mutex_t vol_glock_mutex;
68 extern pthread_mutex_t vol_trans_mutex;
69 extern pthread_cond_t vol_put_volume_cond;
70 extern pthread_cond_t vol_sleep_cond;
71 extern ih_init_params vol_io_params;
72 extern int vol_attach_threads;
73 #ifdef VOL_LOCK_DEBUG
74 extern pthread_t vol_glock_holder;
75 #define VOL_LOCK \
76     do { \
77         assert(pthread_mutex_lock(&vol_glock_mutex) == 0); \
78         assert(vol_glock_holder == 0); \
79         vol_glock_holder = pthread_self(); \
80     } while (0)
81 #define VOL_UNLOCK \
82     do { \
83         VOL_LOCK_ASSERT_HELD; \
84         vol_glock_holder = 0; \
85         assert(pthread_mutex_unlock(&vol_glock_mutex) == 0); \
86     } while (0)
87 #define VOL_CV_WAIT(cv) \
88     do { \
89         VOL_LOCK_DBG_CV_WAIT_BEGIN; \
90         assert(pthread_cond_wait((cv), &vol_glock_mutex) == 0); \
91         VOL_LOCK_DBG_CV_WAIT_END; \
92     } while (0)
93 #else /* !VOL_LOCK_DEBUG */
94 #define VOL_LOCK \
95     assert(pthread_mutex_lock(&vol_glock_mutex) == 0)
96 #define VOL_UNLOCK \
97     assert(pthread_mutex_unlock(&vol_glock_mutex) == 0)
98 #define VOL_CV_WAIT(cv) assert(pthread_cond_wait((cv), &vol_glock_mutex) == 0)
99 #endif /* !VOL_LOCK_DEBUG */
100 #define VSALVSYNC_LOCK \
101     assert(pthread_mutex_lock(&vol_salvsync_mutex) == 0)
102 #define VSALVSYNC_UNLOCK \
103     assert(pthread_mutex_unlock(&vol_salvsync_mutex) == 0)
104 #define VTRANS_LOCK \
105     assert(pthread_mutex_lock(&vol_trans_mutex) == 0)
106 #define VTRANS_UNLOCK \
107     assert(pthread_mutex_unlock(&vol_trans_mutex) == 0)
108 #else /* AFS_PTHREAD_ENV */
109 #define VOL_LOCK
110 #define VOL_UNLOCK
111 #define VSALVSYNC_LOCK
112 #define VSALVSYNC_UNLOCK
113 #define VTRANS_LOCK
114 #define VTRANS_UNLOCK
115 #endif /* AFS_PTHREAD_ENV */
116
117 /**
118  * volume package program type enumeration.
119  */
120 typedef enum {
121     fileServer          = 1,    /**< the fileserver process */
122     volumeUtility       = 2,    /**< any miscellaneous volume utility */
123     salvager            = 3,    /**< standalone whole-partition salvager */
124     salvageServer       = 4,    /**< dafs online salvager */
125     debugUtility        = 5,    /**< fssync-debug or similar utility */
126     volumeServer        = 6,    /**< the volserver process */
127     volumeSalvager      = 7,    /**< the standalone single-volume salvager */
128 } ProgramType;
129 extern ProgramType programType; /* The type of program using the package */
130
131 /* Some initialization parameters for the volume package */
132 /* Add new initialization parameters here */
133 extern int (*V_BreakVolumeCallbacks) (VolumeId);
134 extern int (*vol_PollProc) (void);
135
136 #define DOPOLL  ((vol_PollProc)? (*vol_PollProc)() : 0)
137
138 #ifdef AFS_DEMAND_ATTACH_FS
139 /**
140  * variable error return code based upon programType and DAFS presence
141  */
142 #define DAFS_VSALVAGE   ((programType == fileServer) ? VSALVAGING : VSALVAGE)
143 #else
144 #define DAFS_VSALVAGE   (VSALVAGE)
145 #endif
146
147 struct versionStamp {           /* Version stamp for critical volume files */
148     bit32 magic;                /* Magic number */
149     bit32 version;              /* Version number of this file, or software
150                                  * that created this file */
151 };
152
153 #ifdef AFS_DEMAND_ATTACH_FS
154 /**
155  * demand attach volume state enumeration.
156  *
157  * @note values must be contiguous in order for VIsValidState() to work correctly
158  */
159 typedef enum {
160     VOL_STATE_UNATTACHED        = 0,    /**< volume is unattached */
161     VOL_STATE_PREATTACHED       = 1,    /**< volume has been pre-attached */
162     VOL_STATE_ATTACHING         = 2,    /**< volume is transitioning to fully attached */
163     VOL_STATE_ATTACHED          = 3,    /**< volume has been fully attached */
164     VOL_STATE_UPDATING          = 4,    /**< volume is updating on-disk structures */
165     VOL_STATE_GET_BITMAP        = 5,    /**< volume is getting bitmap entries */
166     VOL_STATE_HDR_LOADING       = 6,    /**< volume is loading disk header */
167     VOL_STATE_HDR_ATTACHING     = 7,    /**< volume is getting a header from the LRU */
168     VOL_STATE_SHUTTING_DOWN     = 8,    /**< volume is shutting down */
169     VOL_STATE_GOING_OFFLINE     = 9,    /**< volume is going offline */
170     VOL_STATE_OFFLINING         = 10,   /**< volume is transitioning to offline */
171     VOL_STATE_DETACHING         = 11,   /**< volume is transitioning to detached */
172     VOL_STATE_SALVSYNC_REQ      = 12,   /**< volume is blocked on a salvsync request */
173     VOL_STATE_SALVAGING         = 13,   /**< volume is being salvaged */
174     VOL_STATE_ERROR             = 14,   /**< volume is in an error state */
175     VOL_STATE_VNODE_ALLOC       = 15,   /**< volume is busy allocating a new vnode */
176     VOL_STATE_VNODE_GET         = 16,   /**< volume is busy getting vnode disk data */
177     VOL_STATE_VNODE_CLOSE       = 17,   /**< volume is busy closing vnodes */
178     VOL_STATE_VNODE_RELEASE     = 18,   /**< volume is busy releasing vnodes */
179     VOL_STATE_VLRU_ADD          = 19,   /**< volume is busy being added to a VLRU queue */
180     /* please add new states directly above this line */
181     VOL_STATE_FREED             = 20,   /**< debugging aid */
182     VOL_STATE_COUNT             = 21,   /**< total number of valid states */
183 } VolState;
184
185 /**
186  * V_attachFlags bits.
187  */
188 enum VolFlags {
189     VOL_HDR_ATTACHED      = 0x1,     /**< volume header is attached to Volume struct */
190     VOL_HDR_LOADED        = 0x2,     /**< volume header contents are valid */
191     VOL_HDR_IN_LRU        = 0x4,     /**< volume header is in LRU */
192     VOL_IN_HASH           = 0x8,     /**< volume is in hash table */
193     VOL_ON_VBYP_LIST      = 0x10,    /**< volume is on VByP list */
194     VOL_IS_BUSY           = 0x20,    /**< volume is not to be free()d */
195     VOL_ON_VLRU           = 0x40,    /**< volume is on the VLRU */
196     VOL_HDR_DONTSALV      = 0x80,    /**< volume header DONTSALVAGE flag is set */
197     VOL_LOCKED            = 0x100,   /**< volume is disk-locked (@see VLockVolumeNB) */
198 };
199
200 /* VPrintExtendedCacheStats flags */
201 #define VOL_STATS_PER_CHAIN   0x1  /**< compute simple per-chain stats */
202 #define VOL_STATS_PER_CHAIN2  0x2  /**< compute per-chain stats that require scanning
203                                     *   every element of the chain */
204
205 /* VLRU_SetOptions options */
206 #define VLRU_SET_THRESH       1
207 #define VLRU_SET_INTERVAL     2
208 #define VLRU_SET_MAX          3
209 #define VLRU_SET_ENABLED      4
210
211 /**
212  * VLRU queue names.
213  */
214 typedef enum {
215     VLRU_QUEUE_NEW        = 0,  /**< LRU queue for new volumes */
216     VLRU_QUEUE_MID        = 1,  /**< survivor generation */
217     VLRU_QUEUE_OLD        = 2,  /**< old generation */
218     VLRU_QUEUE_CANDIDATE  = 3,  /**< soft detach candidate pool */
219     VLRU_QUEUE_HELD       = 4,  /*   volumes which are not allowed
220                                  *   to be soft detached */
221     VLRU_QUEUE_INVALID    = 5,  /**< invalid queue id */
222 } VLRUQueueName;
223
224 /* default scanner timing parameters */
225 #define VLRU_DEFAULT_OFFLINE_THRESH (60*60*2) /* 2 hours */
226 #define VLRU_DEFAULT_OFFLINE_INTERVAL (60*2) /* 2 minutes */
227 #define VLRU_DEFAULT_OFFLINE_MAX 8 /* 8 volumes */
228
229
230 /**
231  * DAFS thread-specific options structure
232  */
233 typedef struct VThreadOptions {
234      int disallow_salvsync;     /**< whether or not salvsync calls are allowed
235                                  *   on this thread (deadlock prevention). */
236 } VThreadOptions_t;
237 extern pthread_key_t VThread_key;
238 extern VThreadOptions_t VThread_defaults;
239
240 #endif /* AFS_DEMAND_ATTACH_FS */
241
242 typedef struct VolumePackageOptions {
243     afs_uint32 nLargeVnodes;      /**< size of large vnode cache */
244     afs_uint32 nSmallVnodes;      /**< size of small vnode cache */
245     afs_uint32 volcache;          /**< size of volume header cache */
246
247     afs_int32 canScheduleSalvage; /**< can we schedule salvages? (DAFS) */
248                                   /* (if 'no', we will just error out if we
249                                    * find a bad vol) */
250     afs_int32 canUseFSSYNC;       /**< can we use the FSSYNC channel? */
251     afs_int32 canUseSALVSYNC;     /**< can we use the SALVSYNC channel? (DAFS) */
252     afs_int32 unsafe_attach;      /**< can we bypass checking the inUse vol
253                                    *   header on attach? */
254 } VolumePackageOptions;
255
256 /* Magic numbers and version stamps for each type of file */
257 #define VOLUMEHEADERMAGIC       ((bit32)0x88a1bb3c)
258 #define VOLUMEINFOMAGIC         ((bit32)0x78a1b2c5)
259 #define SMALLINDEXMAGIC         0x99776655
260 #define LARGEINDEXMAGIC         0x88664433
261 #define MOUNTMAGIC              0x9a8b7c6d
262 #define ACLMAGIC                0x88877712
263 #define LINKTABLEMAGIC          0x99877712
264
265 #define VOLUMEHEADERVERSION     1
266 #define VOLUMEINFOVERSION       1
267 #define SMALLINDEXVERSION       1
268 #define LARGEINDEXVERSION       1
269 #define MOUNTVERSION            1
270 #define ACLVERSION              1
271 #define LINKTABLEVERSION        1
272
273 /*
274  * Define whether we are keeping detailed statistics on volume dealings.
275  */
276 #define OPENAFS_VOL_STATS       1
277
278 #if OPENAFS_VOL_STATS
279 /*
280  * Define various indices and counts used in keeping volume-level statistics.
281  */
282 #define VOL_STATS_NUM_RWINFO_FIELDS 4
283
284 #define VOL_STATS_SAME_NET      0       /*Within same site (total) */
285 #define VOL_STATS_SAME_NET_AUTH 1       /*Within same site (authenticated);
286                                          * (must be 1 more than above) */
287 #define VOL_STATS_DIFF_NET      2       /*From external site (total) */
288 #define VOL_STATS_DIFF_NET_AUTH 3       /*From external site (authenticated)
289                                          * (must be 1 more than above) */
290
291 #define VOL_STATS_NUM_TIME_RANGES 6
292
293 #define VOL_STATS_TIME_CAP_0        60  /*60 seconds */
294 #define VOL_STATS_TIME_CAP_1       600  /*10 minutes, in seconds */
295 #define VOL_STATS_TIME_CAP_2      3600  /*1 hour, in seconds */
296 #define VOL_STATS_TIME_CAP_3     86400  /*1 day, in seconds */
297 #define VOL_STATS_TIME_CAP_4    604800  /*1 week, in seconds */
298
299 #define VOL_STATS_NUM_TIME_FIELDS 6
300
301 #define VOL_STATS_TIME_IDX_0    0       /*0 secs to 60 secs */
302 #define VOL_STATS_TIME_IDX_1    1       /*1 min to 10 mins */
303 #define VOL_STATS_TIME_IDX_2    2       /*10 mins to 60 mins */
304 #define VOL_STATS_TIME_IDX_3    3       /*1 hr to 24 hrs */
305 #define VOL_STATS_TIME_IDX_4    4       /*1 day to 7 days */
306 #define VOL_STATS_TIME_IDX_5    5       /*Greater than 1 week */
307 #endif /* OPENAFS_VOL_STATS */
308
309 /* Volume header.  This is the contents of the named file representing
310  * the volume.  Read-only by the file server!
311  */
312 typedef struct VolumeHeader {
313     struct versionStamp stamp;  /* Must be first field */
314     VolumeId id;                /* Volume number */
315     VolumeId parent;            /* Read-write volume number (or this volume
316                                  * number if this is a read-write volume) */
317     Inode volumeInfo;
318     Inode smallVnodeIndex;
319     Inode largeVnodeIndex;
320     Inode volumeAcl;
321     Inode volumeMountTable;
322     Inode linkTable;
323 } VolumeHeader_t;
324
325
326 typedef struct VolumeDiskHeader {
327     struct versionStamp stamp;  /* Must be first field */
328     VolumeId id;                /* Volume number */
329     VolumeId parent;            /* Read-write volume number (or this volume
330                                  * number if this is a read-write volume) */
331     afs_int32 volumeInfo_lo;
332     afs_int32 smallVnodeIndex_lo;
333     afs_int32 largeVnodeIndex_lo;
334     afs_int32 volumeAcl_lo;
335     afs_int32 volumeMountTable_lo;
336     afs_int32 volumeInfo_hi;
337     afs_int32 smallVnodeIndex_hi;
338     afs_int32 largeVnodeIndex_hi;
339     afs_int32 volumeAcl_hi;
340     afs_int32 volumeMountTable_hi;
341     afs_int32 linkTable_lo;
342     afs_int32 linkTable_hi;
343     /* If you add fields, add them before here and reduce the size of  array */
344     bit32 reserved[3];
345 } VolumeDiskHeader_t;
346
347 /* A vnode index file header */
348 struct IndexFileHeader {
349     struct versionStamp stamp;
350 };
351
352
353 /******************************************************************************/
354 /* Volume Data which is stored on disk and can also be maintained in memory.  */
355 /******************************************************************************/
356 typedef struct VolumeDiskData {
357     struct versionStamp stamp;  /* Must be first field */
358     VolumeId id;                /* Volume id--unique over all systems */
359 #define VNAMESIZE 32            /* including 0 byte */
360     char name[VNAMESIZE];       /* Unofficial name for the volume */
361     byte inUse;                 /* Volume is being used (perhaps it is online),
362                                  * or the system crashed while it was used */
363     byte inService;             /* Volume in service, not necessarily on line
364                                  * This bit is set by an operator/system
365                                  * programmer.  Manually taking a volume offline
366                                  * always clears the inService bit. Taking
367                                  * it out of service also takes it offline */
368     byte blessed;               /* Volume is administratively blessed with
369                                  * the ability to go on line.  Set by a system
370                                  * administrator. Clearing this bit will
371                                  * take the volume offline */
372     byte needsSalvaged;         /* Volume needs salvaged--an unrecoverable
373                                  * error occured to the volume.  Note:  a volume
374                                  * may still require salvage even if this
375                                  * flag isn't set--e.g. if a system crash
376                                  * occurred while the volume was on line. */
377     bit32 uniquifier;           /* Next vnode uniquifier for this volume */
378     int type;                   /* */
379     VolId parentId;             /* Id of parent, if type==readonly */
380     VolId cloneId;              /* Latest read-only clone, if type==readwrite,
381                                  * 0 if the volume has never been cloned.  Note: the
382                                  * indicated volume does not necessarily exist (it
383                                  * may have been deleted since cloning). */
384     VolId backupId;             /* Latest backup copy of this read write volume */
385     VolId restoredFromId;       /* The id in the dump this volume was restored from--used simply
386                                  * to make sure that an incremental dump is not restored on top
387                                  * of something inappropriate:  Note:  this field itself is NEVER
388                                  * dumped!!! */
389     byte needsCallback;         /* Set by the salvager if anything was changed
390                                  * about the volume.  Note:  this is not set by
391                                  * clone/makebackups when setting the copy-on-write
392                                  * flag in directories; this flag is not seen by
393                                  * the clients. */
394 #define DESTROY_ME      0xD3
395     byte destroyMe;             /* If this is set to DESTROY_ME, then the salvager should destroy
396                                  * this volume; it is bogus (left over from an aborted  volume move,
397                                  * for example).  Note:  if this flag is on, then inService should
398                                  * be OFF--only the salvager checks this flag */
399 #ifdef ALPHA_DUX40_ENV
400 #define DONT_SALVAGE    0xE6
401 #else                           /* ALPHA_DUX40_ENV */
402 #define DONT_SALVAGE    0xE5
403 #endif                          /* ALPHA_DUX40_ENV */
404     byte dontSalvage;           /* If this is on, then don't bother salvaging this volume */
405     byte reserveb3;
406
407     bit32 reserved1[6];
408
409
410     /* Administrative stuff */
411     int maxquota;               /* Quota maximum, 1K blocks */
412     int minquota;               /* Quota minimum, 1K blocks */
413     int maxfiles;               /* Maximum number of files (i.e. inodes) */
414     bit32 accountNumber;        /* Uninterpreted account number */
415     bit32 owner;                /* The person administratively responsible
416                                  * for this volume */
417     int reserved2[8];           /* Other administrative constraints */
418
419     /* Resource usage & statistics */
420     int filecount;              /* Actual number of files */
421     int diskused;               /* Actual disk space used, 1K blocks */
422     int dayUse;                 /* Metric for today's usage of this volume so far */
423     int weekUse[7];             /* Usage of the volume for the last week.
424                                  * weekUse[0] is for most recent complete 24 hour period
425                                  * of measurement; week[6] is 7 days ago */
426     Date dayUseDate;            /* Date the dayUse statistics refer to; the week use stats
427                                  * are the preceding 7 days */
428     unsigned int volUpdateCounter; /*incremented at every update of volume*/
429     int reserved3[10];          /* Other stats here */
430
431     /* Server supplied dates */
432     Date creationDate;          /* Creation date for a read/write
433                                  * volume; cloning date for original copy of
434                                  * a readonly volume (replicated volumes have
435                                  * the same creation date) */
436     Date accessDate;            /* Last access time by a user, large granularity */
437     Date updateDate;            /* Last modification by user */
438     Date expirationDate;        /* 0 if it never expires */
439     Date backupDate;            /* last time a backup clone was taken */
440
441     /* Time that this copy of this volume was made.  NEVER backed up.  This field is only
442      * set when the copy is created */
443     Date copyDate;
444
445 #if OPENAFS_VOL_STATS
446     bit32 stat_initialized;     /*Are the stat fields below set up? */
447     bit32 reserved4[7];
448 #else
449     bit32 reserved4[8];
450 #endif                          /* OPENAFS_VOL_STATS */
451
452     /* messages */
453 #define VMSGSIZE 128
454     char offlineMessage[VMSGSIZE];      /* Why the volume is offline */
455 #if OPENAFS_VOL_STATS
456 #define VOL_STATS_BYTES 128
457     /*
458      * Keep per-volume aggregate statistics on type and distance of access,
459      * along with authorship info.
460      */
461     bit32 stat_reads[VOL_STATS_NUM_RWINFO_FIELDS];
462     bit32 stat_writes[VOL_STATS_NUM_RWINFO_FIELDS];
463     bit32 stat_fileSameAuthor[VOL_STATS_NUM_TIME_FIELDS];
464     bit32 stat_fileDiffAuthor[VOL_STATS_NUM_TIME_FIELDS];
465     bit32 stat_dirSameAuthor[VOL_STATS_NUM_TIME_FIELDS];
466     bit32 stat_dirDiffAuthor[VOL_STATS_NUM_TIME_FIELDS];
467 #else
468     char motd[VMSGSIZE];        /* Volume "message of the day" */
469 #endif                          /* OPENAFS_VOL_STATS */
470
471 } VolumeDiskData;
472
473
474 /**************************************/
475 /* Memory resident volume information */
476 /**************************************/
477
478 /** 
479  * global volume package stats.
480  */
481 typedef struct VolPkgStats {
482 #ifdef AFS_DEMAND_ATTACH_FS
483     /*
484      * demand attach fs
485      * extended volume package statistics
486      */
487
488     /* levels */
489     afs_uint32 state_levels[VOL_STATE_COUNT]; /**< volume state transition counters */
490
491     /* counters */
492     afs_uint64 hash_looks;           /**< number of hash chain element traversals */
493     afs_uint64 hash_reorders;        /**< number of hash chain reorders */
494     afs_uint64 salvages;             /**< online salvages since fileserver start */
495     afs_uint64 vol_ops;              /**< volume operations since fileserver start */
496 #endif /* AFS_DEMAND_ATTACH_FS */
497
498     afs_uint64 hdr_loads;            /**< header loads from disk */
499     afs_uint64 hdr_gets;             /**< header pulls out of LRU */
500     afs_uint64 attaches;             /**< volume attaches since fileserver start */
501     afs_uint64 soft_detaches;        /**< soft detach ops since fileserver start */
502
503     /* configuration parameters */
504     afs_uint32 hdr_cache_size;       /**< size of volume header cache */
505 } VolPkgStats;
506 extern VolPkgStats VStats;
507
508 /*
509  * volume header cache supporting structures
510  */
511 struct volume_hdr_LRU_stats {
512     afs_uint32 free;
513     afs_uint32 used;
514     afs_uint32 attached;
515 };
516
517 struct volume_hdr_LRU_t {
518     struct rx_queue lru;
519     struct volume_hdr_LRU_stats stats;
520 };
521 extern struct volume_hdr_LRU_t volume_hdr_LRU;
522
523 /*
524  * volume hash chain supporting structures
525  */
526 typedef struct VolumeHashChainHead {
527     struct rx_queue queue;
528     int len;
529     /* someday we could put a per-chain lock here... */
530 #ifdef AFS_DEMAND_ATTACH_FS
531     int busy;
532     int cacheCheck;
533
534     /* per-chain statistics */
535     afs_uint64 looks;
536     afs_uint64 gets;
537     afs_uint64 reorders;
538
539     pthread_cond_t chain_busy_cv;
540 #endif /* AFS_DEMAND_ATTACH_FS */
541 } VolumeHashChainHead;
542
543 typedef struct VolumeHashTable {
544     int Size;
545     int Mask;
546     VolumeHashChainHead * Table;
547 } VolumeHashTable_t;
548 extern VolumeHashTable_t VolumeHashTable;
549
550 struct VolumeHashChainStats {
551     afs_int32 table_size;
552     afs_int32 chain_len;
553 #ifdef AFS_DEMAND_ATTACH_FS
554     afs_int32 chain_cacheCheck;
555     afs_int32 chain_busy;
556     afs_uint64 chain_looks;
557     afs_uint64 chain_gets;
558     afs_uint64 chain_reorders;
559 #endif
560 };
561
562
563 #ifdef AFS_DEMAND_ATTACH_FS
564 /**
565  * DAFS extended per-volume statistics.
566  *
567  * @note this data lives across the entire
568  *       lifetime of the fileserver process
569  */
570 typedef struct VolumeStats {
571     /* counters */
572     afs_uint64 hash_lookups;         /**< hash table lookups */
573     afs_uint64 hash_short_circuits;  /**< short circuited hash lookups (due to cacheCheck) */
574     afs_uint64 hdr_loads;            /**< header loads from disk */
575     afs_uint64 hdr_gets;             /**< header pulls out of LRU */
576     afs_uint16 attaches;             /**< attaches of this volume since fileserver start */
577     afs_uint16 soft_detaches;        /**< soft detaches of this volume */
578     afs_uint16 salvages;             /**< online salvages since fileserver start */
579     afs_uint16 vol_ops;              /**< volume operations since fileserver start */
580
581     /* timestamps */
582     afs_uint32 last_attach;      /**< unix timestamp of last VAttach */
583     afs_uint32 last_get;         /**< unix timestamp of last VGet/VHold */
584     afs_uint32 last_promote;     /**< unix timestamp of last VLRU promote/demote */
585     afs_uint32 last_hdr_get;     /**< unix timestamp of last GetVolumeHeader() */
586     afs_uint32 last_hdr_load;    /**< unix timestamp of last LoadVolumeHeader() */
587     afs_uint32 last_salvage;     /**< unix timestamp of last initiation of an online salvage */
588     afs_uint32 last_salvage_req; /**< unix timestamp of last SALVSYNC request */
589     afs_uint32 last_vol_op;      /**< unix timestamp of last volume operation */
590 } VolumeStats;
591
592
593 #define SALVAGE_PRIO_UPDATE_INTERVAL 3      /**< number of seconds between prio updates */
594 #define SALVAGE_COUNT_MAX 16                /**< number of online salvages we
595                                              *   allow before moving the volume
596                                              *   into a permanent error state
597                                              *
598                                              *   once this threshold is reached,
599                                              *   the operator will have to manually
600                                              *   issue a 'bos salvage' to bring
601                                              *   the volume back online
602                                              */
603
604 /**
605  * DAFS online salvager state.
606  */
607 typedef struct VolumeOnlineSalvage {
608     afs_uint32 prio;            /**< number of VGetVolume's since salvage requested */
609     int reason;                 /**< reason for requesting online salvage */
610     byte requested;             /**< flag specifying that salvage should be scheduled */
611     byte scheduled;             /**< flag specifying whether online salvage scheduled */
612     byte reserved[2];           /**< padding */
613 } VolumeOnlineSalvage;
614
615 /**
616  * DAFS Volume LRU state.
617  */
618 typedef struct VolumeVLRUState {
619     struct rx_queue lru;        /**< VLRU queue for this generation */
620     VLRUQueueName idx;          /**< VLRU generation index */
621 } VolumeVLRUState;
622 #endif /* AFS_DEMAND_ATTACH_FS */
623
624 typedef struct Volume {
625     struct rx_queue q;          /* Volume hash chain pointers */
626     VolumeId hashid;            /* Volume number -- for hash table lookup */
627     struct volHeader *header;   /* Cached disk data */
628     Device device;              /* Unix device for the volume */
629     struct DiskPartition64
630      *partition;                /* Information about the Unix partition */
631     struct vnodeIndex {
632         IHandle_t *handle;      /* Unix inode holding this index */
633         byte *bitmap;           /* Index bitmap */
634         afs_uint32 bitmapSize;  /* length of bitmap, in bytes */
635         afs_uint32 bitmapOffset;        /* Which byte address of the first long to
636                                          * start search from in bitmap */
637     } vnodeIndex[nVNODECLASSES];
638     IHandle_t *linkHandle;
639     Unique nextVnodeUnique;     /* Derived originally from volume uniquifier.
640                                  * This is the actual next version number to
641                                  * assign; the uniquifier is bumped by 200 and
642                                  * and written to disk every 200 file creates
643                                  * If the volume is shutdown gracefully, the
644                                  * uniquifier should be rewritten with the
645                                  * value nextVnodeVersion */
646     IHandle_t *diskDataHandle;  /* Unix inode holding general volume info */
647     bit16 vnodeHashOffset;      /* Computed by HashOffset function in vnode.h.
648                                  * Assigned to the volume when initialized. 
649                                  * Added to vnode number for hash table index */
650     byte shuttingDown;          /* This volume is going to be detached */
651     byte goingOffline;          /* This volume is going offline */
652     bit32 cacheCheck;           /* Online sequence number to be used to invalidate vnode cache entries
653                                  * that stayed around while a volume was offline */
654     short nUsers;               /* Number of users of this volume header */
655     byte needsPutBack;          /* For a volume utility, this flag is set if we need
656                                  * to give the volume back when we detach it.  The server has
657                                  * certain modes where it doesn't detach the volume, and
658                                  * if we give it back spuriously, the server aborts.  This field
659                                  * is meaningless on the file server */
660     byte specialStatus;         /* An error code to return on VGetVolume: the
661                                  * volume is unavailable for the reason quoted,
662                                  * currently VBUSY or VMOVED */
663     afs_uint32 checkoutMode;    /* for volume utilities, mode number for current checkout */
664     afs_uint32 updateTime;      /* Time that this volume was put on the updated
665                                  * volume list--the list of volumes that will be
666                                  * salvaged should the file server crash */
667     struct rx_queue vnode_list; /**< linked list of cached vnodes for this volume */
668 #ifdef AFS_DEMAND_ATTACH_FS
669     VolState attach_state;      /* what stage of attachment has been completed */
670     afs_uint32 attach_flags;    /* flags related to attachment state */
671     pthread_cond_t attach_cv;   /* state change condition variable */
672     short nWaiters;             /* volume package internal ref count */
673     int chainCacheCheck;        /* Volume hash chain cache check */
674     struct rx_queue vol_list;   /* per-partition volume list (VByPList) */
675
676     VolumeOnlineSalvage salvage;  /* online salvager state */
677     VolumeStats stats;            /* per-volume statistics */
678     VolumeVLRUState vlru;         /* state specific to the VLRU */
679     FSSYNC_VolOp_info * pending_vol_op;  /* fssync command info for any pending vol ops */
680 #endif /* AFS_DEMAND_ATTACH_FS */
681 } Volume;
682
683 struct volHeader {
684     struct rx_queue lru;
685     VolumeDiskData diskstuff;   /* General volume info read from disk */
686     Volume *back;               /* back pointer to current volume structure */
687 };
688
689 /* These macros are used to export fields within the volume header.  This was added
690    to facilitate changing the actual representation */
691
692 #define V_device(vp)            ((vp)->device)
693 #define V_partition(vp)         ((vp)->partition)
694 #define V_diskDataHandle(vp)    ((vp)->diskDataHandle)
695 #define V_vnodeIndex(vp)        ((vp)->vnodeIndex)
696 #define V_nextVnodeUnique(vp)   ((vp)->nextVnodeUnique)
697 #define V_linkHandle(vp)        ((vp)->linkHandle)
698 #define V_checkoutMode(vp)      ((vp)->checkoutMode)
699 #ifdef AFS_DEMAND_ATTACH_FS
700 #define V_attachState(vp)       ((vp)->attach_state)
701 #define V_attachFlags(vp)       ((vp)->attach_flags)
702 #define V_attachCV(vp)          ((vp)->attach_cv)
703 #endif /* AFS_DEMAND_ATTACH_FS */
704
705 /* N.B. V_id must be this, rather than vp->id, or some programs will break, probably */
706 #define V_stamp(vp)             ((vp)->header->diskstuff.stamp)
707 #define V_id(vp)                ((vp)->header->diskstuff.id)
708 #define V_name(vp)              ((vp)->header->diskstuff.name)
709 #define V_inUse(vp)             ((vp)->header->diskstuff.inUse)
710 #define V_inService(vp)         ((vp)->header->diskstuff.inService)
711 #define V_blessed(vp)           ((vp)->header->diskstuff.blessed)
712 #define V_needsSalvaged(vp)     ((vp)->header->diskstuff.needsSalvaged)
713 #define V_uniquifier(vp)        ((vp)->header->diskstuff.uniquifier)
714 #define V_type(vp)              ((vp)->header->diskstuff.type)
715 #define V_parentId(vp)          ((vp)->header->diskstuff.parentId)
716 #define V_cloneId(vp)           ((vp)->header->diskstuff.cloneId)
717 #define V_backupId(vp)          ((vp)->header->diskstuff.backupId)
718 #define V_restoredFromId(vp)    ((vp)->header->diskstuff.restoredFromId)
719 #define V_needsCallback(vp)     ((vp)->header->diskstuff.needsCallback)
720 #define V_destroyMe(vp)         ((vp)->header->diskstuff.destroyMe)
721 #define V_dontSalvage(vp)       ((vp)->header->diskstuff.dontSalvage)
722 #define V_maxquota(vp)          ((vp)->header->diskstuff.maxquota)
723 #define V_minquota(vp)          ((vp)->header->diskstuff.minquota)
724 #define V_maxfiles(vp)          ((vp)->header->diskstuff.maxfiles)
725 #define V_accountNumber(vp)     ((vp)->header->diskstuff.accountNumber)
726 #define V_owner(vp)             ((vp)->header->diskstuff.owner)
727 #define V_filecount(vp)         ((vp)->header->diskstuff.filecount)
728 #define V_diskused(vp)          ((vp)->header->diskstuff.diskused)
729 #define V_dayUse(vp)            ((vp)->header->diskstuff.dayUse)
730 #define V_weekUse(vp)           ((vp)->header->diskstuff.weekUse)
731 #define V_dayUseDate(vp)        ((vp)->header->diskstuff.dayUseDate)
732 #define V_creationDate(vp)      ((vp)->header->diskstuff.creationDate)
733 #define V_accessDate(vp)        ((vp)->header->diskstuff.accessDate)
734 #define V_updateDate(vp)        ((vp)->header->diskstuff.updateDate)
735 #define V_expirationDate(vp)    ((vp)->header->diskstuff.expirationDate)
736 #define V_backupDate(vp)        ((vp)->header->diskstuff.backupDate)
737 #define V_copyDate(vp)          ((vp)->header->diskstuff.copyDate)
738 #define V_offlineMessage(vp)    ((vp)->header->diskstuff.offlineMessage)
739 #define V_disk(vp)              ((vp)->header->diskstuff)
740 #define V_motd(vp)              ((vp)->header->diskstuff.motd)
741 #if OPENAFS_VOL_STATS
742 #define V_stat_initialized(vp)  ((vp)->header->diskstuff.stat_initialized)
743 #define V_stat_area(vp)         (((vp)->header->diskstuff.stat_reads))
744 #define V_stat_reads(vp, idx)   (((vp)->header->diskstuff.stat_reads)[idx])
745 #define V_stat_writes(vp, idx)  (((vp)->header->diskstuff.stat_writes)[idx])
746 #define V_stat_fileSameAuthor(vp, idx) (((vp)->header->diskstuff.stat_fileSameAuthor)[idx])
747 #define V_stat_fileDiffAuthor(vp, idx) (((vp)->header->diskstuff.stat_fileDiffAuthor)[idx])
748 #define V_stat_dirSameAuthor(vp, idx)  (((vp)->header->diskstuff.stat_dirSameAuthor)[idx])
749 #define V_stat_dirDiffAuthor(vp, idx)  (((vp)->header->diskstuff.stat_dirDiffAuthor)[idx])
750 #endif /* OPENAFS_VOL_STATS */
751 #define V_volUpCounter(vp)              ((vp)->header->diskstuff.volUpdateCounter)
752
753 /* File offset computations.  The offset values in the volume header are
754    computed with these macros -- when the file is written only!! */
755 #define VOLUME_MOUNT_TABLE_OFFSET(Volume)       (sizeof (VolumeDiskData))
756 #define VOLUME_BITMAP_OFFSET(Volume)    \
757         (sizeof (VolumeDiskData) + (Volume)->disk.mountTableSize)
758
759
760 extern char *VSalvageMessage;   /* Canonical message when a volume is forced
761                                  * offline */
762 extern Volume *VGetVolume(Error * ec, Error * client_ec, VolId volumeId);
763 extern Volume *VGetVolumeNoWait(Error * ec, Error * client_ec, VolId volumeId);
764 extern Volume *VGetVolume_r(Error * ec, VolId volumeId);
765 extern void VPutVolume(Volume *);
766 extern void VPutVolume_r(Volume *);
767 extern void VOffline(Volume * vp, char *message);
768 extern void VOffline_r(Volume * vp, char *message);
769 extern int VConnectFS(void);
770 extern int VConnectFS_r(void);
771 extern void VDisconnectFS(void);
772 extern void VDisconnectFS_r(void);
773 extern int VChildProcReconnectFS(void);
774 extern Volume *VAttachVolume(Error * ec, VolumeId volumeId, int mode);
775 extern Volume *VAttachVolume_r(Error * ec, VolumeId volumeId, int mode);
776 extern Volume *VCreateVolume(Error * ec, char *partname, VolId volumeId,
777                              VolId parentId);
778 extern Volume *VCreateVolume_r(Error * ec, char *partname, VolId volumeId,
779                                VolId parentId);
780 extern int VAllocBitmapEntry(Error * ec, Volume * vp,
781                              struct vnodeIndex *index);
782 extern int VAllocBitmapEntry_r(Error * ec, Volume * vp,
783                                struct vnodeIndex *index, int flags);
784 extern void VFreeBitMapEntry(Error * ec, register struct vnodeIndex *index,
785                              unsigned bitNumber);
786 extern void VFreeBitMapEntry_r(Error * ec, register struct vnodeIndex *index,
787                                unsigned bitNumber);
788 extern int VolumeNumber(char *name);
789 extern char *VolumeExternalName(VolumeId volumeId);
790 extern int VolumeExternalName_r(VolumeId volumeId, char *name, size_t len);
791 extern Volume *VAttachVolumeByName(Error * ec, char *partition, char *name,
792                                    int mode);
793 extern Volume *VAttachVolumeByName_r(Error * ec, char *partition, char *name,
794                                      int mode);
795 extern void VShutdown(void);
796 extern void VSetTranquil(void);
797 extern void VUpdateVolume(Error * ec, Volume * vp);
798 extern void VUpdateVolume_r(Error * ec, Volume * vp, int flags);
799 extern void VAddToVolumeUpdateList(Error * ec, Volume * vp);
800 extern void VAddToVolumeUpdateList_r(Error * ec, Volume * vp);
801 extern void VDetachVolume(Error * ec, Volume * vp);
802 extern void VDetachVolume_r(Error * ec, Volume * vp);
803 extern void VForceOffline(Volume * vp);
804 extern void VForceOffline_r(Volume * vp, int flags);
805 extern void VBumpVolumeUsage(register Volume * vp);
806 extern void VBumpVolumeUsage_r(register Volume * vp);
807 extern void VSetDiskUsage(void);
808 extern void VPrintCacheStats(void);
809 extern void VReleaseVnodeFiles_r(Volume * vp);
810 extern void VCloseVnodeFiles_r(Volume * vp);
811 extern struct DiskPartition64 *VGetPartition(char *name, int abortp);
812 extern struct DiskPartition64 *VGetPartition_r(char *name, int abortp);
813 extern void VOptDefaults(ProgramType pt, VolumePackageOptions * opts);
814 extern int VInitVolumePackage2(ProgramType pt, VolumePackageOptions * opts);
815 extern int VInitAttachVolumes(ProgramType pt);
816 extern void DiskToVolumeHeader(VolumeHeader_t * h, VolumeDiskHeader_t * dh);
817 extern void VolumeHeaderToDisk(VolumeDiskHeader_t * dh, VolumeHeader_t * h);
818 extern void AssignVolumeName(VolumeDiskData * vol, char *name, char *ext);
819 extern void VTakeOffline_r(register Volume * vp);
820 extern void VTakeOffline(register Volume * vp);
821 extern Volume * VLookupVolume_r(Error * ec, VolId volumeId, Volume * hint);
822 extern void VGetVolumePath(Error * ec, VolId volumeId, char **partitionp,
823                            char **namep);
824 extern char *vol_DevName(dev_t adev, char *wpath);
825
826 struct VLockFile;
827 extern void VLockFileInit(struct VLockFile *lf, const char *path);
828 extern void VLockFileReinit(struct VLockFile *lf);
829 extern int VLockFileLock(struct VLockFile *lf, afs_uint32 offset,
830                          int locktype, int nonblock);
831 extern void VLockFileUnlock(struct VLockFile *lf, afs_uint32 offset);
832
833 #ifdef AFS_DEMAND_ATTACH_FS
834 extern Volume *VPreAttachVolumeByName(Error * ec, char *partition, char *name);
835 extern Volume *VPreAttachVolumeByName_r(Error * ec, char *partition, char *name);
836 extern Volume *VPreAttachVolumeById_r(Error * ec, char * partition, 
837                                       VolId volumeId);
838 extern Volume *VPreAttachVolumeByVp_r(Error * ec, struct DiskPartition64 * partp, 
839                                       Volume * vp, VolId volume_id);
840 extern Volume *VGetVolumeByVp_r(Error * ec, Volume * vp);
841 extern int VShutdownByPartition_r(struct DiskPartition64 * dp);
842 extern int VShutdownVolume_r(Volume * vp);
843 extern int VConnectSALV(void);
844 extern int VConnectSALV_r(void);
845 extern int VReconnectSALV(void);
846 extern int VReconnectSALV_r(void);
847 extern int VDisconnectSALV(void);
848 extern int VDisconnectSALV_r(void);
849 extern void VPrintExtendedCacheStats(int flags);
850 extern void VPrintExtendedCacheStats_r(int flags);
851 extern void VLRU_SetOptions(int option, afs_uint32 val);
852 extern int VSetVolHashSize(int logsize);
853 extern int VRequestSalvage_r(Error * ec, Volume * vp, int reason, int flags);
854 extern int VUpdateSalvagePriority_r(Volume * vp);
855 extern int VRegisterVolOp_r(Volume * vp, FSSYNC_VolOp_info * vopinfo);
856 extern int VDeregisterVolOp_r(Volume * vp);
857 extern void VCancelReservation_r(Volume * vp);
858 extern int VChildProcReconnectFS_r(void);
859 extern void VOfflineForVolOp_r(Error *ec, Volume *vp, char *message);
860
861 struct VDiskLock;
862 extern void VDiskLockInit(struct VDiskLock *dl, struct VLockFile *lf,
863                           afs_uint32 offset);
864 extern int VGetDiskLock(struct VDiskLock *dl, int locktype, int nonblock);
865 extern void VReleaseDiskLock(struct VDiskLock *dl, int locktype);
866 #endif /* AFS_DEMAND_ATTACH_FS */
867 extern int VVolOpLeaveOnline_r(Volume * vp, FSSYNC_VolOp_info * vopinfo);
868 extern int VVolOpLeaveOnlineNoHeader_r(Volume * vp, FSSYNC_VolOp_info * vopinfo);
869 extern int VVolOpSetVBusy_r(Volume * vp, FSSYNC_VolOp_info * vopinfo);
870
871 extern void VPurgeVolume(Error * ec, Volume * vp);
872
873 extern afs_int32 VCanScheduleSalvage(void);
874 extern afs_int32 VCanUseFSSYNC(void);
875 extern afs_int32 VCanUseSALVSYNC(void);
876 extern afs_int32 VCanUnsafeAttach(void);
877 extern afs_int32 VReadVolumeDiskHeader(VolumeId volid,
878                                        struct DiskPartition64 * dp,
879                                        VolumeDiskHeader_t * hdr);
880 extern afs_int32 VWriteVolumeDiskHeader(VolumeDiskHeader_t * hdr,
881                                         struct DiskPartition64 * dp);
882 extern afs_int32 VCreateVolumeDiskHeader(VolumeDiskHeader_t * hdr,
883                                          struct DiskPartition64 * dp);
884 extern afs_int32 VDestroyVolumeDiskHeader(struct DiskPartition64 * dp,
885                                           VolumeId volid, VolumeId parent);
886
887 /**
888  * VWalkVolumeHeaders header callback.
889  *
890  * @param[in] dp   disk partition
891  * @param[in] name full path to the .vol header file
892  * @param[in] hdr  the header data that was read from the .vol header
893  * @param[in] last 1 if this is the last attempt to read the vol header, 0
894  *                 otherwise. DAFS VWalkVolumeHeaders will retry reading the
895  *                 header once, if a non-fatal error occurs when reading the
896  *                 header, or if this function returns a positive error code.
897  *                 So, if there is a problem, this function will be called
898  *                 first with last=0, then with last=1, then the error function
899  *                 callback will be called. For non-DAFS, this is always 1.
900  * @param[in] rock the rock passed to VWalkVolumeHeaders
901  *
902  * @return operation status
903  *  @retval 0 success
904  *  @retval negative a fatal error that should stop the walk immediately
905  *  @retval positive an error with the volume header was encountered; the walk
906  *          should continue, but the error function should be called on this
907  *          header
908  *
909  * @see VWalkVolumeHeaders
910  */
911 typedef int (*VWalkVolFunc)(struct DiskPartition64 *dp, const char *name,
912                             struct VolumeDiskHeader *hdr, int last,
913                             void *rock);
914 /**
915  * VWalkVolumeHeaders error callback.
916  *
917  * This is called from VWalkVolumeHeaders when an invalid or otherwise
918  * problematic volume header is encountered. It is typically implemented as a
919  * wrapper to unlink the .vol file.
920  *
921  * @param[in] dp   disk partition
922  * @param[in] name full path to the .vol header file
923  * @param[in] hdr  header read in from the .vol file, or NULL if it could not
924  *                 be read
925  * @param[in] rock rock passed to VWalkVolumeHeaders
926  *
927  * @see VWalkVolumeHeaders
928  */
929 typedef void (*VWalkErrFunc)(struct DiskPartition64 *dp, const char *name,
930                              struct VolumeDiskHeader *hdr, void *rock);
931 extern int VWalkVolumeHeaders(struct DiskPartition64 *dp, const char *partpath,
932                               VWalkVolFunc volfunc, VWalkErrFunc errfunc,
933                               void *rock);
934
935 /* Naive formula relating number of file size to number of 1K blocks in file */
936 /* Note:  we charge 1 block for 0 length files so the user can't store
937    an inifite number of them; for most files, we give him the inode, vnode,
938    and indirect block overhead, for FREE! */
939 #define nBlocks(bytes) ((afs_sfsize_t)((bytes) == 0? 1: (((afs_sfsize_t)(bytes))+1023)/1024))
940
941 /* Client process id -- file server sends a Check volumes signal back to the client at this pid */
942 #define CLIENTPID       "/vice/vol/clientpid"
943
944 /* Modes of attachment, for VAttachVolume[ByName] to convey to the file server */
945 #define V_READONLY 1            /* Absolutely no updates will be done to the volume */
946 #define V_CLONE    2            /* Cloning the volume:  if it is read/write, then directory
947                                  * version numbers will change.  Header will be updated.  If
948                                  * the volume is read-only, the file server may continue to
949                                  * server it; it may also continue to server it in read/write
950                                  * mode if the writes are deferred */
951 #define V_VOLUPD   3            /* General update or volume purge is possible.  Volume must
952                                  * go offline */
953 #define V_DUMP     4            /* A dump of the volume is requested; the volume can be served
954                                  * read-only during this time */
955 #define V_SECRETLY 5            /* Secret attach of the volume.  This is used to attach a volume
956                                  * which the file server doesn't know about--and which it shouldn't
957                                  * know about yet, since the volume has just been created and
958                                  * is somewhat bogus.  Required to make sure that a file server
959                                  * never knows about more than one copy of the same volume--when
960                                  * a volume is moved from one partition to another on a single
961                                  * server */
962 #define V_PEEK     6            /* "Peek" at the volume without telling the fileserver.  This is
963                                  * similar to V_SECRETLY, but read-only.  It is used in cases where
964                                  * not impacting fileserver performance is more important than
965                                  * getting the most recent data. */
966
967
968
969 /* VUpdateVolume_r flags */
970 #define VOL_UPDATE_WAIT          0x1  /* for demand attach, wait for other exclusive ops to end */
971 #define VOL_UPDATE_NOFORCEOFF    0x2  /* don't force offline on failure. this is to prevent
972                                        * infinite recursion between vupdate and vforceoff */
973
974 /* VForceOffline_r flags */
975 #define VOL_FORCEOFF_NOUPDATE    0x1  /* don't force update on forceoff. this is to prevent
976                                        * infinite recursion between vupdate and vforceoff */
977
978 /* VSyncVolume_r flags */
979 #define VOL_SYNC_WAIT            0x1  /* for demand attach, wait for other exclusive ops to end */
980
981 /* VAllocBitmapEntry_r flags */
982 #define VOL_ALLOC_BITMAP_WAIT    0x1  /* for demand attach, wait for other exclusive ops to end */
983
984 /* VRequestSalvage_r flags */
985 #define VOL_SALVAGE_INVALIDATE_HEADER 0x1 /* for demand attach fs, invalidate volume header cache */
986
987
988 #if     defined(NEARINODE_HINT)
989 #define V_pref(vp,nearInode)  nearInodeHash(V_id(vp),(nearInode)); (nearInode) %= V_partition(vp)->f_files
990 #else
991 #define V_pref(vp,nearInode)   nearInode = 0
992 #endif /* NEARINODE_HINT */
993
994 hdr_static_inline(unsigned int)
995 afs_printable_VolumeId_u(VolumeId d) { return (unsigned int) d; }
996
997 hdr_static_inline(unsigned int)
998 afs_printable_VnodeId_u(VnodeId d) { return (unsigned int) d; }
999
1000 #endif /* __volume_h */