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