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