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