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