sys/vfs/hammer/hammer_disk.h

   1 /*
   2  * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/vfs/hammer/hammer_disk.h,v 1.55 2008/11/13 02:18:43 dillon Exp $
  35  */
  36
  37 #ifndef VFS_HAMMER_DISK_H_
  38 #define VFS_HAMMER_DISK_H_
  39
  40 #ifndef _SYS_UUID_H_
  41 #include <sys/uuid.h>
  42 #endif
  43
  44 /*
  45  * The structures below represent the on-disk format for a HAMMER
  46  * filesystem.  Note that all fields for on-disk structures are naturally
  47  * aligned.  The host endian format is used - compatibility is possible
  48  * if the implementation detects reversed endian and adjusts data accordingly.
  49  *
  50  * Most of HAMMER revolves around the concept of an object identifier.  An
  51  * obj_id is a 64 bit quantity which uniquely identifies a filesystem object
  52  * FOR THE ENTIRE LIFE OF THE FILESYSTEM.  This uniqueness allows backups
  53  * and mirrors to retain varying amounts of filesystem history by removing
  54  * any possibility of conflict through identifier reuse.
  55  *
  56  * A HAMMER filesystem may span multiple volumes.
  57  *
  58  * A HAMMER filesystem uses a 16K filesystem buffer size.  All filesystem
  59  * I/O is done in multiples of 16K.
  60  *
  61  * 64K X-bufs are used for blocks >= a file's 1MB mark.
  62  *
  63  * Per-volume storage limit: 52 bits            4096 TB
  64  * Per-Zone storage limit: 60 bits              1 MTB
  65  * Per-filesystem storage limit: 60 bits        1 MTB
  66  */
  67 #define HAMMER_BUFSIZE          16384
  68 #define HAMMER_XBUFSIZE         65536
  69 #define HAMMER_HBUFSIZE         (HAMMER_BUFSIZE / 2)
  70 #define HAMMER_XDEMARC          (1024 * 1024)
  71 #define HAMMER_BUFMASK          (HAMMER_BUFSIZE - 1)
  72 #define HAMMER_XBUFMASK         (HAMMER_XBUFSIZE - 1)
  73
  74 #define HAMMER_BUFSIZE64        ((uint64_t)HAMMER_BUFSIZE)
  75 #define HAMMER_BUFMASK64        ((uint64_t)HAMMER_BUFMASK)
  76
  77 #define HAMMER_XBUFSIZE64       ((uint64_t)HAMMER_XBUFSIZE)
  78 #define HAMMER_XBUFMASK64       ((uint64_t)HAMMER_XBUFMASK)
  79
  80 #define HAMMER_OFF_ZONE_MASK    0xF000000000000000ULL /* zone portion */
  81 #define HAMMER_OFF_VOL_MASK     0x0FF0000000000000ULL /* volume portion */
  82 #define HAMMER_OFF_SHORT_MASK   0x000FFFFFFFFFFFFFULL /* offset portion */
  83 #define HAMMER_OFF_LONG_MASK    0x0FFFFFFFFFFFFFFFULL /* offset portion */
  84
  85 #define HAMMER_OFF_BAD          ((hammer_off_t)-1)
  86
  87 /*
  88  * The current limit of volumes that can make up a HAMMER FS
  89  */
  90 #define HAMMER_MAX_VOLUMES      256
  91
  92 /*
  93  * Hammer transaction ids are 64 bit unsigned integers and are usually
  94  * synchronized with the time of day in nanoseconds.
  95  *
  96  * Hammer offsets are used for FIFO indexing and embed a cycle counter
  97  * and volume number in addition to the offset.  Most offsets are required
  98  * to be 16 KB aligned.
  99  */
 100 typedef uint64_t hammer_tid_t;
 101 typedef uint64_t hammer_off_t;
 102 typedef uint32_t hammer_crc_t;
 103
 104 #define HAMMER_MIN_TID          0ULL                    /* unsigned */
 105 #define HAMMER_MAX_TID          0xFFFFFFFFFFFFFFFFULL   /* unsigned */
 106 #define HAMMER_MIN_KEY          -0x8000000000000000LL   /* signed */
 107 #define HAMMER_MAX_KEY          0x7FFFFFFFFFFFFFFFLL    /* signed */
 108 #define HAMMER_MIN_OBJID        HAMMER_MIN_KEY          /* signed */
 109 #define HAMMER_MAX_OBJID        HAMMER_MAX_KEY          /* signed */
 110 #define HAMMER_MIN_RECTYPE      0x0U                    /* unsigned */
 111 #define HAMMER_MAX_RECTYPE      0xFFFFU                 /* unsigned */
 112 #define HAMMER_MIN_OFFSET       0ULL                    /* unsigned */
 113 #define HAMMER_MAX_OFFSET       0xFFFFFFFFFFFFFFFFULL   /* unsigned */
 114
 115 /*
 116  * hammer_off_t has several different encodings.  Note that not all zones
 117  * encode a vol_no.  Zone bits are not a part of filesystem capacity.
 118  *
 119  * zone 0:              available, a big-block that contains the offset is unused
 120  * zone 1 (z,v,o):      raw volume relative (offset 0 is the volume header)
 121  * zone 2 (z,v,o):      raw buffer relative (offset 0 is the first buffer)
 122  * zone 3 (z,o):        undo fifo       - actually zone-2 address, fixed phys array in vol hdr
 123  * zone 4 (z,v,o):      freemap         - only real blockmap
 124  * zone 8 (z,v,o):      B-Tree          - actually zone-2 address
 125  * zone 9 (z,v,o):      meta            - actually zone-2 address
 126  * zone 10 (z,v,o):     large-data      - actually zone-2 address
 127  * zone 11 (z,v,o):     small-data      - actually zone-2 address
 128  * zone 15:             unavailable, usually the offset is beyond volume size
 129  *
 130  * layer1/layer2 direct map:
 131  *           Maximum HAMMER filesystem capacity from volume aspect
 132  *           2^8(max volumes) * 2^52(max volume size) = 2^60 = 1EB
 133  *          <------------------------------------------------------------->
 134  *           8bits   52bits
 135  *          <------><----------------------------------------------------->
 136  *      zzzzvvvvvvvvoooo oooooooooooooooo oooooooooooooooo oooooooooooooooo
 137  *      ----111111111111 1111112222222222 222222222ooooooo oooooooooooooooo
 138  *          <-----------------><------------------><---------------------->
 139  *           18bits             19bits              23bits
 140  *          <------------------------------------------------------------->
 141  *           2^18(layer1) * 2^19(layer2) * 2^23(big-block) = 2^60 = 1EB
 142  *           Maximum HAMMER filesystem capacity from blockmap aspect
 143  */
 144
 145 #define HAMMER_ZONE_RAW_VOLUME          0x1000000000000000ULL
 146 #define HAMMER_ZONE_RAW_BUFFER          0x2000000000000000ULL
 147 #define HAMMER_ZONE_UNDO                0x3000000000000000ULL
 148 #define HAMMER_ZONE_FREEMAP             0x4000000000000000ULL
 149 #define HAMMER_ZONE_RESERVED05          0x5000000000000000ULL  /* not used */
 150 #define HAMMER_ZONE_RESERVED06          0x6000000000000000ULL  /* not used */
 151 #define HAMMER_ZONE_RESERVED07          0x7000000000000000ULL  /* not used */
 152 #define HAMMER_ZONE_BTREE               0x8000000000000000ULL
 153 #define HAMMER_ZONE_META                0x9000000000000000ULL
 154 #define HAMMER_ZONE_LARGE_DATA          0xA000000000000000ULL
 155 #define HAMMER_ZONE_SMALL_DATA          0xB000000000000000ULL
 156 #define HAMMER_ZONE_RESERVED0C          0xC000000000000000ULL  /* not used */
 157 #define HAMMER_ZONE_RESERVED0D          0xD000000000000000ULL  /* not used */
 158 #define HAMMER_ZONE_RESERVED0E          0xE000000000000000ULL  /* not used */
 159 #define HAMMER_ZONE_UNAVAIL             0xF000000000000000ULL
 160
 161 #define HAMMER_ZONE_RAW_VOLUME_INDEX    1
 162 #define HAMMER_ZONE_RAW_BUFFER_INDEX    2
 163 #define HAMMER_ZONE_UNDO_INDEX          3
 164 #define HAMMER_ZONE_FREEMAP_INDEX       4
 165 #define HAMMER_ZONE_BTREE_INDEX         8
 166 #define HAMMER_ZONE_META_INDEX          9
 167 #define HAMMER_ZONE_LARGE_DATA_INDEX    10
 168 #define HAMMER_ZONE_SMALL_DATA_INDEX    11
 169 #define HAMMER_ZONE_UNAVAIL_INDEX       15
 170
 171 #define HAMMER_MAX_ZONES                16
 172
 173 /*
 174  * Backend zones that are mapped to zone-2 (except for zone-3)
 175  * starts from this index which is 8.
 176  */
 177 #define HAMMER_ZONE2_MAPPED_INDEX       HAMMER_ZONE_BTREE_INDEX
 178
 179 #define HAMMER_ZONE_ENCODE(zone, ham_off)               \
 180         (((hammer_off_t)(zone) << 60) | (ham_off))
 181 #define HAMMER_ZONE_DECODE(ham_off)                     \
 182         (int32_t)(((hammer_off_t)(ham_off) >> 60))
 183
 184 #define HAMMER_VOL_ENCODE(vol_no)                       \
 185         ((hammer_off_t)((vol_no) & 255) << 52)
 186 #define HAMMER_VOL_DECODE(ham_off)                      \
 187         (int32_t)(((hammer_off_t)(ham_off) >> 52) & 255)
 188
 189 #define HAMMER_OFF_SHORT_ENCODE(offset)                 \
 190         ((hammer_off_t)(offset) & HAMMER_OFF_SHORT_MASK)
 191 #define HAMMER_OFF_LONG_ENCODE(offset)                  \
 192         ((hammer_off_t)(offset) & HAMMER_OFF_LONG_MASK)
 193
 194 #define HAMMER_ENCODE(zone, vol_no, offset)             \
 195         (((hammer_off_t)(zone) << 60) |                 \
 196         HAMMER_VOL_ENCODE(vol_no) |                     \
 197         HAMMER_OFF_SHORT_ENCODE(offset))
 198 #define HAMMER_ENCODE_RAW_VOLUME(vol_no, offset)        \
 199         HAMMER_ENCODE(HAMMER_ZONE_RAW_VOLUME_INDEX, vol_no, offset)
 200 #define HAMMER_ENCODE_RAW_BUFFER(vol_no, offset)        \
 201         HAMMER_ENCODE(HAMMER_ZONE_RAW_BUFFER_INDEX, vol_no, offset)
 202 #define HAMMER_ENCODE_FREEMAP(vol_no, offset)           \
 203         HAMMER_ENCODE(HAMMER_ZONE_FREEMAP_INDEX, vol_no, offset)
 204
 205 /*
 206  * Translate a zone address to zone-X address.
 207  */
 208 #define hammer_xlate_to_zoneX(zone, offset)             \
 209         HAMMER_ZONE_ENCODE((zone), (offset) & ~HAMMER_OFF_ZONE_MASK)
 210 #define hammer_xlate_to_zone2(offset)                   \
 211         hammer_xlate_to_zoneX(HAMMER_ZONE_RAW_BUFFER_INDEX, (offset))
 212
 213 #define hammer_data_zone(data_len)                      \
 214         (((data_len) >= HAMMER_BUFSIZE) ?               \
 215          HAMMER_ZONE_LARGE_DATA :                       \
 216          HAMMER_ZONE_SMALL_DATA)
 217 #define hammer_data_zone_index(data_len)                \
 218         (((data_len) >= HAMMER_BUFSIZE) ?               \
 219          HAMMER_ZONE_LARGE_DATA_INDEX :                 \
 220          HAMMER_ZONE_SMALL_DATA_INDEX)
 221
 222 /*
 223  * Big-Block backing store
 224  *
 225  * A blockmap is a two-level map which translates a blockmap-backed zone
 226  * offset into a raw zone 2 offset.  The layer 1 handles 18 bits and the
 227  * layer 2 handles 19 bits.  The 8M big-block size is 23 bits so two
 228  * layers gives us 18+19+23 = 60 bits of address space.
 229  *
 230  * When using hinting for a blockmap lookup, the hint is lost when the
 231  * scan leaves the HINTBLOCK, which is typically several BIGBLOCK's.
 232  * HINTBLOCK is a heuristic.
 233  */
 234 #define HAMMER_HINTBLOCK_SIZE           (HAMMER_BIGBLOCK_SIZE * 4)
 235 #define HAMMER_HINTBLOCK_MASK64         ((uint64_t)HAMMER_HINTBLOCK_SIZE - 1)
 236 #define HAMMER_BIGBLOCK_SIZE            (8192 * 1024)
 237 #define HAMMER_BIGBLOCK_SIZE64          ((uint64_t)HAMMER_BIGBLOCK_SIZE)
 238 #define HAMMER_BIGBLOCK_MASK            (HAMMER_BIGBLOCK_SIZE - 1)
 239 #define HAMMER_BIGBLOCK_MASK64          ((uint64_t)HAMMER_BIGBLOCK_SIZE - 1)
 240 #define HAMMER_BIGBLOCK_BITS            23
 241 #if 0
 242 #define HAMMER_BIGBLOCK_OVERFILL        (6144 * 1024)
 243 #endif
 244 #if (1 << HAMMER_BIGBLOCK_BITS) != HAMMER_BIGBLOCK_SIZE
 245 #error "HAMMER_BIGBLOCK_BITS BROKEN"
 246 #endif
 247
 248 #define HAMMER_BUFFERS_PER_BIGBLOCK                     \
 249         (HAMMER_BIGBLOCK_SIZE / HAMMER_BUFSIZE)
 250 #define HAMMER_BUFFERS_PER_BIGBLOCK_MASK                \
 251         (HAMMER_BUFFERS_PER_BIGBLOCK - 1)
 252 #define HAMMER_BUFFERS_PER_BIGBLOCK_MASK64              \
 253         ((hammer_off_t)HAMMER_BUFFERS_PER_BIGBLOCK_MASK)
 254
 255 /*
 256  * Maximum number of mirrors operating in master mode (multi-master
 257  * clustering and mirroring). Note that HAMMER1 does not support
 258  * multi-master clustering as of 2015.
 259  */
 260 #define HAMMER_MAX_MASTERS              16
 261
 262 /*
 263  * The blockmap is somewhat of a degenerate structure.  HAMMER only actually
 264  * uses it in its original incarnation to implement the freemap.
 265  *
 266  * zone:1       raw volume (no blockmap)
 267  * zone:2       raw buffer (no blockmap)
 268  * zone:3       undomap    (direct layer2 array in volume header)
 269  * zone:4       freemap    (the only real blockmap)
 270  * zone:8-15    zone id used to classify big-block only, address is actually
 271  *              a zone-2 address.
 272  */
 273 struct hammer_blockmap {
 274         hammer_off_t    phys_offset;    /* zone-2 physical offset */
 275         hammer_off_t    first_offset;   /* zone-X logical offset (zone 3) */
 276         hammer_off_t    next_offset;    /* zone-X logical offset */
 277         hammer_off_t    alloc_offset;   /* zone-X logical offset */
 278         uint32_t        reserved01;
 279         hammer_crc_t    entry_crc;
 280 };
 281
 282 typedef struct hammer_blockmap *hammer_blockmap_t;
 283
 284 #define HAMMER_BLOCKMAP_CRCSIZE \
 285         offsetof(struct hammer_blockmap, entry_crc)
 286
 287 /*
 288  * The blockmap is a 2-layer entity made up of big-blocks.  The first layer
 289  * contains 262144 32-byte entries (18 bits), the second layer contains
 290  * 524288 16-byte entries (19 bits), representing 8MB (23 bit) blockmaps.
 291  * 18+19+23 = 60 bits.  The top four bits are the zone id.
 292  *
 293  * Currently only the freemap utilizes both layers in all their glory.
 294  * All primary data/meta-data zones actually encode a zone-2 address
 295  * requiring no real blockmap translation.
 296  *
 297  * The freemap uses the upper 8 bits of layer-1 to identify the volume,
 298  * thus any space allocated via the freemap can be directly translated
 299  * to a zone:2 (or zone:8-15) address.
 300  *
 301  * zone-X blockmap offset: [zone:4][layer1:18][layer2:19][big-block:23]
 302  */
 303
 304 /*
 305  * 32 bytes layer1 entry for 8MB big-block.
 306  * A big-block can hold 2^23 / 2^5 = 2^18 layer1 entries,
 307  * which equals bits assigned for layer1 in zone-2 address.
 308  */
 309 struct hammer_blockmap_layer1 {
 310         hammer_off_t    blocks_free;    /* big-blocks free */
 311         hammer_off_t    phys_offset;    /* UNAVAIL or zone-2 */
 312         hammer_off_t    reserved01;
 313         hammer_crc_t    layer2_crc;     /* xor'd crc's of HAMMER_BLOCKSIZE */
 314                                         /* (not yet used) */
 315         hammer_crc_t    layer1_crc;     /* MUST BE LAST FIELD OF STRUCTURE*/
 316 };
 317
 318 typedef struct hammer_blockmap_layer1 *hammer_blockmap_layer1_t;
 319
 320 #define HAMMER_LAYER1_CRCSIZE   \
 321         offsetof(struct hammer_blockmap_layer1, layer1_crc)
 322
 323 /*
 324  * 16 bytes layer2 entry for 8MB big-blocks.
 325  * A big-block can hold 2^23 / 2^4 = 2^19 layer2 entries,
 326  * which equals bits assigned for layer2 in zone-2 address.
 327  *
 328  * NOTE: bytes_free is signed and can legally go negative if/when data
 329  *       de-dup occurs.  This field will never go higher than
 330  *       HAMMER_BIGBLOCK_SIZE.  If exactly HAMMER_BIGBLOCK_SIZE
 331  *       the big-block is completely free.
 332  */
 333 struct hammer_blockmap_layer2 {
 334         uint8_t         zone;           /* typed allocation zone */
 335         uint8_t         unused01;
 336         uint16_t        unused02;
 337         uint32_t        append_off;     /* allocatable space index */
 338         int32_t         bytes_free;     /* bytes free within this big-block */
 339         hammer_crc_t    entry_crc;
 340 };
 341
 342 typedef struct hammer_blockmap_layer2 *hammer_blockmap_layer2_t;
 343
 344 #define HAMMER_LAYER2_CRCSIZE   \
 345         offsetof(struct hammer_blockmap_layer2, entry_crc)
 346
 347 #define HAMMER_BLOCKMAP_UNAVAIL ((hammer_off_t)-1LL)
 348
 349 #define HAMMER_BLOCKMAP_RADIX1  /* 2^18 = 262144 */     \
 350         ((int)(HAMMER_BIGBLOCK_SIZE / sizeof(struct hammer_blockmap_layer1)))
 351 #define HAMMER_BLOCKMAP_RADIX2  /* 2^19 = 524288 */     \
 352         ((int)(HAMMER_BIGBLOCK_SIZE / sizeof(struct hammer_blockmap_layer2)))
 353
 354 #define HAMMER_BLOCKMAP_LAYER1  /* 2^(18+19+23) = 1EB */        \
 355         (HAMMER_BLOCKMAP_RADIX1 * HAMMER_BLOCKMAP_LAYER2)
 356 #define HAMMER_BLOCKMAP_LAYER2  /* 2^(19+23) = 4TB */           \
 357         (HAMMER_BLOCKMAP_RADIX2 * HAMMER_BIGBLOCK_SIZE64)
 358
 359 #define HAMMER_BLOCKMAP_LAYER1_MASK     (HAMMER_BLOCKMAP_LAYER1 - 1)
 360 #define HAMMER_BLOCKMAP_LAYER2_MASK     (HAMMER_BLOCKMAP_LAYER2 - 1)
 361
 362 /*
 363  * Index within layer1 or layer2 big-block for the entry representing
 364  * a zone-2 physical offset.
 365  */
 366 #define HAMMER_BLOCKMAP_LAYER1_INDEX(zone2_offset)              \
 367         ((int)(((zone2_offset) & HAMMER_BLOCKMAP_LAYER1_MASK) / \
 368          HAMMER_BLOCKMAP_LAYER2))
 369
 370 #define HAMMER_BLOCKMAP_LAYER2_INDEX(zone2_offset)              \
 371         ((int)(((zone2_offset) & HAMMER_BLOCKMAP_LAYER2_MASK) / \
 372         HAMMER_BIGBLOCK_SIZE64))
 373
 374 /*
 375  * Byte offset within layer1 or layer2 big-block for the entry representing
 376  * a zone-2 physical offset.  Multiply the index by sizeof(blockmap_layer).
 377  */
 378 #define HAMMER_BLOCKMAP_LAYER1_OFFSET(zone2_offset)             \
 379         (HAMMER_BLOCKMAP_LAYER1_INDEX(zone2_offset) *           \
 380          sizeof(struct hammer_blockmap_layer1))
 381
 382 #define HAMMER_BLOCKMAP_LAYER2_OFFSET(zone2_offset)             \
 383         (HAMMER_BLOCKMAP_LAYER2_INDEX(zone2_offset) *           \
 384          sizeof(struct hammer_blockmap_layer2))
 385
 386 /*
 387  * HAMMER UNDO parameters.  The UNDO fifo is mapped directly in the volume
 388  * header with an array of layer2 structures.  A maximum of (128x8MB) = 1GB
 389  * may be reserved.  The size of the undo fifo is usually set a newfs time
 390  * but can be adjusted if the filesystem is taken offline.
 391  */
 392 #define HAMMER_UNDO_LAYER2      128     /* max layer2 undo mapping entries */
 393
 394 /*
 395  * All on-disk HAMMER structures which make up elements of the UNDO FIFO
 396  * contain a hammer_fifo_head and hammer_fifo_tail structure.  This structure
 397  * contains all the information required to validate the fifo element
 398  * and to scan the fifo in either direction.  The head is typically embedded
 399  * in higher level hammer on-disk structures while the tail is typically
 400  * out-of-band.  hdr_size is the size of the whole mess, including the tail.
 401  *
 402  * All undo structures are guaranteed to not cross a 16K filesystem
 403  * buffer boundary.  Most undo structures are fairly small.  Data spaces
 404  * are not immediately reused by HAMMER so file data is not usually recorded
 405  * as part of an UNDO.
 406  *
 407  * PAD elements are allowed to take up only 8 bytes of space as a special
 408  * case, containing only hdr_signature, hdr_type, and hdr_size fields,
 409  * and with the tail overloaded onto the head structure for 8 bytes total.
 410  *
 411  * Every undo record has a sequence number.  This number is unrelated to
 412  * transaction ids and instead collects the undo transactions associated
 413  * with a single atomic operation.  A larger transactional operation, such
 414  * as a remove(), may consist of several smaller atomic operations
 415  * representing raw meta-data operations.
 416  *
 417  *                              HAMMER VERSION 4 CHANGES
 418  *
 419  * In HAMMER version 4 the undo structure alignment is reduced from 16384
 420  * to 512 bytes in order to ensure that each 512 byte sector begins with
 421  * a header.  The reserved01 field in the header is now a 32 bit sequence
 422  * number.  This allows the recovery code to detect missing sectors
 423  * without relying on the 32-bit crc and to definitively identify the current
 424  * undo sequence space without having to rely on information from the volume
 425  * header.  In addition, new REDO entries in the undo space are used to
 426  * record write, write/extend, and transaction id updates.
 427  *
 428  * The grand result is:
 429  *
 430  * (1) The volume header no longer needs to be synchronized for most
 431  *     flush and fsync operations.
 432  *
 433  * (2) Most fsync operations need only lay down REDO records
 434  *
 435  * (3) Data overwrite for nohistory operations covered by REDO records
 436  *     can be supported (instead of rolling a new block allocation),
 437  *     by rolling UNDO for the prior contents of the data.
 438  *
 439  *                              HAMMER VERSION 5 CHANGES
 440  *
 441  * Hammer version 5 contains a minor adjustment making layer2's bytes_free
 442  * field signed, allowing dedup to push it into the negative domain.
 443  */
 444 #define HAMMER_HEAD_ALIGN               8
 445 #define HAMMER_HEAD_ALIGN_MASK          (HAMMER_HEAD_ALIGN - 1)
 446 #define HAMMER_HEAD_DOALIGN(bytes)      \
 447         (((bytes) + HAMMER_HEAD_ALIGN_MASK) & ~HAMMER_HEAD_ALIGN_MASK)
 448
 449 #define HAMMER_UNDO_ALIGN               512
 450 #define HAMMER_UNDO_ALIGN64             ((uint64_t)512)
 451 #define HAMMER_UNDO_MASK                (HAMMER_UNDO_ALIGN - 1)
 452 #define HAMMER_UNDO_MASK64              (HAMMER_UNDO_ALIGN64 - 1)
 453
 454 struct hammer_fifo_head {
 455         uint16_t hdr_signature;
 456         uint16_t hdr_type;
 457         uint32_t hdr_size;      /* Aligned size of the whole mess */
 458         uint32_t hdr_seq;       /* Sequence number */
 459         hammer_crc_t hdr_crc;   /* XOR crc up to field w/ crc after field */
 460 };
 461
 462 #define HAMMER_FIFO_HEAD_CRCOFF offsetof(struct hammer_fifo_head, hdr_crc)
 463
 464 struct hammer_fifo_tail {
 465         uint16_t tail_signature;
 466         uint16_t tail_type;
 467         uint32_t tail_size;     /* aligned size of the whole mess */
 468 };
 469
 470 typedef struct hammer_fifo_head *hammer_fifo_head_t;
 471 typedef struct hammer_fifo_tail *hammer_fifo_tail_t;
 472
 473 /*
 474  * Fifo header types.
 475  *
 476  * NOTE: 0x8000U part of HAMMER_HEAD_TYPE_PAD can be removed if the HAMMER
 477  * version ever gets bumped again. It exists only to keep compatibility with
 478  * older versions.
 479  */
 480 #define HAMMER_HEAD_TYPE_PAD    (0x0040U | 0x8000U)
 481 #define HAMMER_HEAD_TYPE_DUMMY  0x0041U         /* dummy entry w/seqno */
 482 #define HAMMER_HEAD_TYPE_UNDO   0x0043U         /* random UNDO information */
 483 #define HAMMER_HEAD_TYPE_REDO   0x0044U         /* data REDO / fast fsync */
 484
 485 #define HAMMER_HEAD_SIGNATURE   0xC84EU
 486 #define HAMMER_TAIL_SIGNATURE   0xC74FU
 487
 488 /*
 489  * Misc FIFO structures.
 490  *
 491  * UNDO - Raw meta-data media updates.
 492  */
 493 struct hammer_fifo_undo {
 494         struct hammer_fifo_head head;
 495         hammer_off_t            undo_offset;    /* zone-1,2 offset */
 496         int32_t                 undo_data_bytes;
 497         int32_t                 undo_reserved01;
 498         /* followed by data */
 499 };
 500
 501 /*
 502  * REDO (HAMMER version 4+) - Logical file writes/truncates.
 503  *
 504  * REDOs contain information which will be duplicated in a later meta-data
 505  * update, allowing fast write()+fsync() operations.  REDOs can be ignored
 506  * without harming filesystem integrity but must be processed if fsync()
 507  * semantics are desired.
 508  *
 509  * Unlike UNDOs which are processed backwards within the recovery span,
 510  * REDOs must be processed forwards starting further back (starting outside
 511  * the recovery span).
 512  *
 513  *      WRITE   - Write logical file (with payload).  Executed both
 514  *                out-of-span and in-span.  Out-of-span WRITEs may be
 515  *                filtered out by TERMs.
 516  *
 517  *      TRUNC   - Truncate logical file (no payload).  Executed both
 518  *                out-of-span and in-span.  Out-of-span WRITEs may be
 519  *                filtered out by TERMs.
 520  *
 521  *      TERM_*  - Indicates meta-data was committed (if out-of-span) or
 522  *                will be rolled-back (in-span).  Any out-of-span TERMs
 523  *                matching earlier WRITEs remove those WRITEs from
 524  *                consideration as they might conflict with a later data
 525  *                commit (which is not being rolled-back).
 526  *
 527  *      SYNC    - The earliest in-span SYNC (the last one when scanning
 528  *                backwards) tells the recovery code how far out-of-span
 529  *                it must go to run REDOs.
 530  *
 531  * NOTE: WRITEs do not always have matching TERMs even under
 532  *       perfect conditions because truncations might remove the
 533  *       buffers from consideration.  I/O problems can also remove
 534  *       buffers from consideration.
 535  *
 536  *       TRUNCSs do not always have matching TERMs because several
 537  *       truncations may be aggregated together into a single TERM.
 538  */
 539 struct hammer_fifo_redo {
 540         struct hammer_fifo_head head;
 541         int64_t                 redo_objid;     /* file being written */
 542         hammer_off_t            redo_offset;    /* logical offset in file */
 543         int32_t                 redo_data_bytes;
 544         uint32_t                redo_flags;
 545         uint32_t                redo_localization;
 546         uint32_t                redo_reserved;
 547         uint64_t                redo_mtime;     /* set mtime */
 548 };
 549
 550 #define HAMMER_REDO_WRITE       0x00000001
 551 #define HAMMER_REDO_TRUNC       0x00000002
 552 #define HAMMER_REDO_TERM_WRITE  0x00000004
 553 #define HAMMER_REDO_TERM_TRUNC  0x00000008
 554 #define HAMMER_REDO_SYNC        0x00000010
 555
 556 union hammer_fifo_any {
 557         struct hammer_fifo_head head;
 558         struct hammer_fifo_undo undo;
 559         struct hammer_fifo_redo redo;
 560 };
 561
 562 typedef struct hammer_fifo_redo *hammer_fifo_redo_t;
 563 typedef struct hammer_fifo_undo *hammer_fifo_undo_t;
 564 typedef union hammer_fifo_any *hammer_fifo_any_t;
 565
 566 /*
 567  * Volume header types
 568  */
 569 #define HAMMER_FSBUF_VOLUME     0xC8414D4DC5523031ULL   /* HAMMER01 */
 570 #define HAMMER_FSBUF_VOLUME_REV 0x313052C54D4D41C8ULL   /* (reverse endian) */
 571
 572 /*
 573  * HAMMER Volume header
 574  *
 575  * A HAMMER filesystem can be built from 1-256 block devices, each block
 576  * device contains a volume header followed by however many buffers fit
 577  * into the volume.
 578  *
 579  * One of the volumes making up a HAMMER filesystem is the root volume.
 580  * The root volume is always volume #0 which is the first block device path
 581  * specified by newfs_hammer(8).  All HAMMER volumes have a volume header,
 582  * however the root volume may be the only volume that has valid values for
 583  * some fields in the header.
 584  *
 585  * Special field notes:
 586  *
 587  *      vol_bot_beg - offset of boot area (mem_beg - bot_beg bytes)
 588  *      vol_mem_beg - offset of memory log (buf_beg - mem_beg bytes)
 589  *      vol_buf_beg - offset of the first buffer in volume
 590  *      vol_buf_end - offset of volume EOF (on buffer boundary)
 591  *
 592  *      The memory log area allows a kernel to cache new records and data
 593  *      in memory without allocating space in the actual filesystem to hold
 594  *      the records and data.  In the event that a filesystem becomes full,
 595  *      any records remaining in memory can be flushed to the memory log
 596  *      area.  This allows the kernel to immediately return success.
 597  *
 598  *      The buffer offset is a physical offset of zone-2 offset. The lower
 599  *      52 bits of the zone-2 offset is added to the buffer offset of each
 600  *      volume to generate an actual I/O offset within the block device.
 601  *
 602  *      NOTE: boot area and memory log are currently not used.
 603  */
 604
 605 /*
 606  * These macros are only used by userspace when userspace commands either
 607  * initialize or add a new HAMMER volume.
 608  */
 609 #define HAMMER_BOOT_MINBYTES            (32*1024)
 610 #define HAMMER_BOOT_NOMBYTES            (64LL*1024*1024)
 611 #define HAMMER_BOOT_MAXBYTES            (256LL*1024*1024)
 612
 613 #define HAMMER_MEM_MINBYTES             (256*1024)
 614 #define HAMMER_MEM_NOMBYTES             (1LL*1024*1024*1024)
 615 #define HAMMER_MEM_MAXBYTES             (64LL*1024*1024*1024)
 616
 617 struct hammer_volume_ondisk {
 618         uint64_t vol_signature; /* HAMMER_FSBUF_VOLUME for a valid header */
 619
 620         int64_t vol_bot_beg;    /* offset of boot area */
 621         int64_t vol_mem_beg;    /* offset of memory log */
 622         int64_t vol_buf_beg;    /* offset of the first buffer in volume */
 623         int64_t vol_buf_end;    /* offset of volume EOF (on buffer boundary) */
 624         int64_t vol_locked;     /* not used */
 625
 626         uuid_t    vol_fsid;     /* identify filesystem */
 627         uuid_t    vol_fstype;   /* identify filesystem type */
 628         char      vol_name[64]; /* filesystem label, not a block device path */
 629
 630         int32_t vol_no;         /* volume number within filesystem */
 631         int32_t vol_count;      /* number of volumes making up FS */
 632
 633         uint32_t vol_version;   /* version control information */
 634         hammer_crc_t vol_crc;   /* header crc */
 635         uint32_t vol_flags;     /* volume flags */
 636         uint32_t vol_rootvol;   /* which volume is the root volume? */
 637
 638         int32_t vol_reserved04;
 639         int32_t vol_reserved05;
 640         uint32_t vol_reserved06;
 641         uint32_t vol_reserved07;
 642
 643         int32_t vol_blocksize;          /* for statfs only */
 644         int32_t vol_reserved08;
 645         int64_t vol_nblocks;            /* total allocatable hammer bufs */
 646
 647         /*
 648          * These fields are initialized and space is reserved in every
 649          * volume making up a HAMMER filesytem, but only the root volume
 650          * contains valid data.  Note that vol0_stat_bigblocks does not
 651          * include big-blocks for freemap and undomap initially allocated
 652          * by newfs_hammer(8).
 653          */
 654         int64_t vol0_stat_bigblocks;    /* total big-blocks when fs is empty */
 655         int64_t vol0_stat_freebigblocks;/* number of free big-blocks */
 656         int64_t vol0_stat_bytes;        /* for statfs only */
 657         int64_t vol0_stat_inodes;       /* for statfs only */
 658         int64_t vol0_stat_records;      /* total records in filesystem */
 659         hammer_off_t vol0_btree_root;   /* B-Tree root */
 660         hammer_tid_t vol0_next_tid;     /* highest partially synchronized TID */
 661         hammer_off_t vol0_unused03;
 662
 663         /*
 664          * Blockmaps for zones.  Not all zones use a blockmap.  Note that
 665          * the entire root blockmap is cached in the hammer_mount structure.
 666          */
 667         struct hammer_blockmap  vol0_blockmap[HAMMER_MAX_ZONES];
 668
 669         /*
 670          * Array of zone-2 addresses for undo FIFO.
 671          */
 672         hammer_off_t            vol0_undo_array[HAMMER_UNDO_LAYER2];
 673 };
 674
 675 typedef struct hammer_volume_ondisk *hammer_volume_ondisk_t;
 676
 677 #define HAMMER_VOLF_NEEDFLUSH           0x0004  /* volume needs flush */
 678
 679 #define HAMMER_VOL_CRCSIZE1     \
 680         offsetof(struct hammer_volume_ondisk, vol_crc)
 681 #define HAMMER_VOL_CRCSIZE2     \
 682         (sizeof(struct hammer_volume_ondisk) - HAMMER_VOL_CRCSIZE1 -    \
 683          sizeof(hammer_crc_t))
 684
 685 #define HAMMER_VOL_VERSION_MIN          1       /* minimum supported version */
 686 #define HAMMER_VOL_VERSION_DEFAULT      6       /* newfs default version */
 687 #define HAMMER_VOL_VERSION_WIP          7       /* version >= this is WIP */
 688 #define HAMMER_VOL_VERSION_MAX          6       /* maximum supported version */
 689
 690 #define HAMMER_VOL_VERSION_ONE          1
 691 #define HAMMER_VOL_VERSION_TWO          2       /* new dirent layout (2.3+) */
 692 #define HAMMER_VOL_VERSION_THREE        3       /* new snapshot layout (2.5+) */
 693 #define HAMMER_VOL_VERSION_FOUR         4       /* new undo/flush (2.5+) */
 694 #define HAMMER_VOL_VERSION_FIVE         5       /* dedup (2.9+) */
 695 #define HAMMER_VOL_VERSION_SIX          6       /* DIRHASH_ALG1 */
 696
 697 /*
 698  * Record types are fairly straightforward.  The B-Tree includes the record
 699  * type in its index sort.
 700  */
 701 #define HAMMER_RECTYPE_UNKNOWN          0x0000
 702 #define HAMMER_RECTYPE_LOWEST           0x0001  /* lowest record type avail */
 703 #define HAMMER_RECTYPE_INODE            0x0001  /* inode in obj_id space */
 704 #define HAMMER_RECTYPE_DATA             0x0010
 705 #define HAMMER_RECTYPE_DIRENTRY         0x0011
 706 #define HAMMER_RECTYPE_DB               0x0012
 707 #define HAMMER_RECTYPE_EXT              0x0013  /* ext attributes */
 708 #define HAMMER_RECTYPE_FIX              0x0014  /* fixed attribute */
 709 #define HAMMER_RECTYPE_PFS              0x0015  /* PFS management */
 710 #define HAMMER_RECTYPE_SNAPSHOT         0x0016  /* Snapshot management */
 711 #define HAMMER_RECTYPE_CONFIG           0x0017  /* hammer cleanup config */
 712 #define HAMMER_RECTYPE_MAX              0xFFFF
 713
 714 #define HAMMER_RECTYPE_ENTRY_START      (HAMMER_RECTYPE_INODE + 1)
 715 #define HAMMER_RECTYPE_CLEAN_START      HAMMER_RECTYPE_EXT
 716
 717 #define HAMMER_FIXKEY_SYMLINK           1
 718
 719 #define HAMMER_OBJTYPE_UNKNOWN          0       /* never exists on-disk as unknown */
 720 #define HAMMER_OBJTYPE_DIRECTORY        1
 721 #define HAMMER_OBJTYPE_REGFILE          2
 722 #define HAMMER_OBJTYPE_DBFILE           3
 723 #define HAMMER_OBJTYPE_FIFO             4
 724 #define HAMMER_OBJTYPE_CDEV             5
 725 #define HAMMER_OBJTYPE_BDEV             6
 726 #define HAMMER_OBJTYPE_SOFTLINK         7
 727 #define HAMMER_OBJTYPE_PSEUDOFS         8       /* pseudo filesystem obj */
 728 #define HAMMER_OBJTYPE_SOCKET           9
 729
 730 /*
 731  * HAMMER inode attribute data
 732  *
 733  * The data reference for a HAMMER inode points to this structure.  Any
 734  * modifications to the contents of this structure will result in a
 735  * replacement operation.
 736  *
 737  * parent_obj_id is only valid for directories (which cannot be hard-linked),
 738  * and specifies the parent directory obj_id.  This field will also be set
 739  * for non-directory inodes as a recovery aid, but can wind up holding
 740  * stale information.  However, since object id's are not reused, the worse
 741  * that happens is that the recovery code is unable to use it.
 742  *
 743  * NOTE: Future note on directory hardlinks.  We can implement a record type
 744  * which allows us to point to multiple parent directories.
 745  */
 746 struct hammer_inode_data {
 747         uint16_t version;       /* inode data version */
 748         uint16_t mode;          /* basic unix permissions */
 749         uint32_t uflags;        /* chflags */
 750         uint32_t rmajor;        /* used by device nodes */
 751         uint32_t rminor;        /* used by device nodes */
 752         uint64_t ctime;
 753         int64_t parent_obj_id;  /* parent directory obj_id */
 754         uuid_t    uid;
 755         uuid_t    gid;
 756
 757         uint8_t obj_type;
 758         uint8_t cap_flags;      /* capability support flags (extension) */
 759         uint16_t reserved01;
 760         uint32_t reserved02;    /* RESERVED FOR POSSIBLE FUTURE BIRTHTIME */
 761         uint64_t nlinks;        /* hard links */
 762         uint64_t size;          /* filesystem object size */
 763         union {
 764                 struct {
 765                         uint32_t reserved03[4];
 766                         uint32_t parent_obj_localization;
 767                         uint32_t reserved04;
 768                 } obj;
 769                 char    symlink[24];    /* HAMMER_INODE_BASESYMLEN */
 770         } ext;
 771         uint64_t mtime; /* mtime must be second-to-last */
 772         uint64_t atime; /* atime must be last */
 773 };
 774
 775 /*
 776  * Neither mtime nor atime upates are CRCd by the B-Tree element.
 777  * mtime updates have UNDO, atime updates do not.
 778  */
 779 #define HAMMER_INODE_CRCSIZE    \
 780         offsetof(struct hammer_inode_data, mtime)
 781
 782 #define HAMMER_INODE_DATA_VERSION       1
 783 #define HAMMER_OBJID_ROOT               1       /* root inodes # */
 784 #define HAMMER_INODE_BASESYMLEN         24      /* see ext.symlink */
 785
 786 /*
 787  * Capability & implementation flags.
 788  *
 789  * HAMMER_INODE_CAP_DIR_LOCAL_INO - Use inode B-Tree localization
 790  * for directory entries.  Also see HAMMER_DIR_INODE_LOCALIZATION().
 791  */
 792 #define HAMMER_INODE_CAP_DIRHASH_MASK   0x03    /* directory: hash algorithm */
 793 #define HAMMER_INODE_CAP_DIRHASH_ALG0   0x00
 794 #define HAMMER_INODE_CAP_DIRHASH_ALG1   0x01
 795 #define HAMMER_INODE_CAP_DIRHASH_ALG2   0x02
 796 #define HAMMER_INODE_CAP_DIRHASH_ALG3   0x03
 797 #define HAMMER_INODE_CAP_DIR_LOCAL_INO  0x04    /* use inode localization */
 798
 799 /*
 800  * A HAMMER directory entry associates a HAMMER filesystem object with a
 801  * namespace.  It is possible to hook into a pseudo-filesystem (with its
 802  * own inode numbering space) in the filesystem by setting the high
 803  * 16 bits of the localization field.  The low 16 bits must be 0 and
 804  * are reserved for future use.
 805  *
 806  * Directory entries are indexed with a 128 bit namekey rather then an
 807  * offset.  A portion of the namekey is an iterator/randomizer to deal
 808  * with collisions.
 809  *
 810  * NOTE: leaf.base.obj_type from the related B-Tree leaf entry holds
 811  * the filesystem object type of obj_id, e.g. a den_type equivalent.
 812  * It is not stored in hammer_entry_data.
 813  *
 814  * NOTE: name field / the filename data reference is NOT terminated with \0.
 815  */
 816 struct hammer_entry_data {
 817         int64_t obj_id;                 /* object being referenced */
 818         uint32_t localization;          /* identify pseudo-filesystem */
 819         uint32_t reserved02;
 820         char    name[16];               /* name (extended) */
 821 };
 822
 823 #define HAMMER_ENTRY_NAME_OFF   offsetof(struct hammer_entry_data, name[0])
 824 #define HAMMER_ENTRY_SIZE(nlen) offsetof(struct hammer_entry_data, name[nlen])
 825
 826 /*
 827  * Symlink data which does not fit in the inode is stored in a separate
 828  * FIX type record.
 829  */
 830 struct hammer_symlink_data {
 831         char    name[16];               /* name (extended) */
 832 };
 833
 834 #define HAMMER_SYMLINK_NAME_OFF offsetof(struct hammer_symlink_data, name[0])
 835
 836 /*
 837  * The root inode for the primary filesystem and root inode for any
 838  * pseudo-fs may be tagged with an optional data structure using
 839  * HAMMER_RECTYPE_PFS and localization id.  This structure allows
 840  * the node to be used as a mirroring master or slave.
 841  *
 842  * When operating as a slave CD's into the node automatically become read-only
 843  * and as-of sync_end_tid.
 844  *
 845  * When operating as a master the read PFSD info sets sync_end_tid to
 846  * the most recently flushed TID.
 847  *
 848  * sync_low_tid is not yet used but will represent the highest pruning
 849  * end-point, after which full history is available.
 850  *
 851  * We need to pack this structure making it equally sized on both 32-bit and
 852  * 64-bit machines as it is part of struct hammer_ioc_mrecord_pfs which is
 853  * send over the wire in hammer mirror operations. Only on 64-bit machines
 854  * the size of this struct differ when packed or not. This leads us to the
 855  * situation where old 64-bit systems (using the non-packed structure),
 856  * which were never able to mirror to/from 32-bit systems, are now no longer
 857  * able to mirror to/from newer 64-bit systems (using the packed structure).
 858  */
 859 struct hammer_pseudofs_data {
 860         hammer_tid_t    sync_low_tid;   /* full history beyond this point */
 861         hammer_tid_t    sync_beg_tid;   /* earliest tid w/ full history avail */
 862         hammer_tid_t    sync_end_tid;   /* current synchronizatoin point */
 863         uint64_t        sync_beg_ts;    /* real-time of last completed sync */
 864         uint64_t        sync_end_ts;    /* initiation of current sync cycle */
 865         uuid_t          shared_uuid;    /* shared uuid (match required) */
 866         uuid_t          unique_uuid;    /* unique uuid of this master/slave */
 867         int32_t         reserved01;     /* reserved for future master_id */
 868         int32_t         mirror_flags;   /* misc flags */
 869         char            label[64];      /* filesystem space label */
 870         char            snapshots[64];  /* softlink dir for pruning */
 871         int32_t         reserved02;     /* was prune_{time,freq} */
 872         int32_t         reserved03;     /* was reblock_{time,freq} */
 873         int32_t         reserved04;     /* was snapshot_freq */
 874         int32_t         prune_min;      /* do not prune recent history */
 875         int32_t         prune_max;      /* do not retain history beyond here */
 876         int32_t         reserved[16];
 877 } __packed;
 878
 879 typedef struct hammer_pseudofs_data *hammer_pseudofs_data_t;
 880
 881 #define HAMMER_PFSD_SLAVE       0x00000001
 882 #define HAMMER_PFSD_DELETED     0x80000000
 883
 884 /*
 885  * Snapshot meta-data { Objid = HAMMER_OBJID_ROOT, Key = tid, rectype = SNAPSHOT }.
 886  *
 887  * Snapshot records replace the old <fs>/snapshots/<softlink> methodology.  Snapshot
 888  * records are mirrored but may be independantly managed once they are laid down on
 889  * a slave.
 890  *
 891  * NOTE: The b-tree key is signed, the tid is not, so callers must still sort the
 892  *       results.
 893  *
 894  * NOTE: Reserved fields must be zero (as usual)
 895  */
 896 struct hammer_snapshot_data {
 897         hammer_tid_t    tid;            /* the snapshot TID itself (== key) */
 898         uint64_t        ts;             /* real-time when snapshot was made */
 899         uint64_t        reserved01;
 900         uint64_t        reserved02;
 901         char            label[64];      /* user-supplied description */
 902         uint64_t        reserved03[4];
 903 };
 904
 905 /*
 906  * Config meta-data { ObjId = HAMMER_OBJID_ROOT, Key = 0, rectype = CONFIG }.
 907  *
 908  * Used to store the hammer cleanup config.  This data is not mirrored.
 909  */
 910 struct hammer_config_data {
 911         char            text[1024];
 912 };
 913
 914 /*
 915  * Rollup various structures embedded as record data
 916  */
 917 union hammer_data_ondisk {
 918         struct hammer_entry_data entry;
 919         struct hammer_inode_data inode;
 920         struct hammer_symlink_data symlink;
 921         struct hammer_pseudofs_data pfsd;
 922         struct hammer_snapshot_data snap;
 923         struct hammer_config_data config;
 924 };
 925
 926 typedef union hammer_data_ondisk *hammer_data_ondisk_t;
 927
 928 /*
 929  * Ondisk layout of B-Tree related structures
 930  */
 931 #include "hammer_btree.h"
 932
 933 #define HAMMER_DIR_INODE_LOCALIZATION(ino_data)                         \
 934         (((ino_data)->cap_flags & HAMMER_INODE_CAP_DIR_LOCAL_INO) ?     \
 935          HAMMER_LOCALIZE_INODE :                                        \
 936          HAMMER_LOCALIZE_MISC)
 937
 938 #endif /* !VFS_HAMMER_DISK_H_ */