git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bcachefs_format.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_FORMAT_H
   3 #define _BCACHEFS_FORMAT_H
   4
   5 /*
   6  * bcachefs on disk data structures
   7  *
   8  * OVERVIEW:
   9  *
  10  * There are three main types of on disk data structures in bcachefs (this is
  11  * reduced from 5 in bcache)
  12  *
  13  *  - superblock
  14  *  - journal
  15  *  - btree
  16  *
  17  * The btree is the primary structure; most metadata exists as keys in the
  18  * various btrees. There are only a small number of btrees, they're not
  19  * sharded - we have one btree for extents, another for inodes, et cetera.
  20  *
  21  * SUPERBLOCK:
  22  *
  23  * The superblock contains the location of the journal, the list of devices in
  24  * the filesystem, and in general any metadata we need in order to decide
  25  * whether we can start a filesystem or prior to reading the journal/btree
  26  * roots.
  27  *
  28  * The superblock is extensible, and most of the contents of the superblock are
  29  * in variable length, type tagged fields; see struct bch_sb_field.
  30  *
  31  * Backup superblocks do not reside in a fixed location; also, superblocks do
  32  * not have a fixed size. To locate backup superblocks we have struct
  33  * bch_sb_layout; we store a copy of this inside every superblock, and also
  34  * before the first superblock.
  35  *
  36  * JOURNAL:
  37  *
  38  * The journal primarily records btree updates in the order they occurred;
  39  * journal replay consists of just iterating over all the keys in the open
  40  * journal entries and re-inserting them into the btrees.
  41  *
  42  * The journal also contains entry types for the btree roots, and blacklisted
  43  * journal sequence numbers (see journal_seq_blacklist.c).
  44  *
  45  * BTREE:
  46  *
  47  * bcachefs btrees are copy on write b+ trees, where nodes are big (typically
  48  * 128k-256k) and log structured. We use struct btree_node for writing the first
  49  * entry in a given node (offset 0), and struct btree_node_entry for all
  50  * subsequent writes.
  51  *
  52  * After the header, btree node entries contain a list of keys in sorted order.
  53  * Values are stored inline with the keys; since values are variable length (and
  54  * keys effectively are variable length too, due to packing) we can't do random
  55  * access without building up additional in memory tables in the btree node read
  56  * path.
  57  *
  58  * BTREE KEYS (struct bkey):
  59  *
  60  * The various btrees share a common format for the key - so as to avoid
  61  * switching in fastpath lookup/comparison code - but define their own
  62  * structures for the key values.
  63  *
  64  * The size of a key/value pair is stored as a u8 in units of u64s, so the max
  65  * size is just under 2k. The common part also contains a type tag for the
  66  * value, and a format field indicating whether the key is packed or not (and
  67  * also meant to allow adding new key fields in the future, if desired).
  68  *
  69  * bkeys, when stored within a btree node, may also be packed. In that case, the
  70  * bkey_format in that node is used to unpack it. Packed bkeys mean that we can
  71  * be generous with field sizes in the common part of the key format (64 bit
  72  * inode number, 64 bit offset, 96 bit version field, etc.) for negligible cost.
  73  */
  74
  75 #include <asm/types.h>
  76 #include <asm/byteorder.h>
  77 #include <linux/kernel.h>
  78 #include <linux/uuid.h>
  79
  80 #define LE_BITMASK(_bits, name, type, field, offset, end)               \
  81 static const unsigned   name##_OFFSET = offset;                         \
  82 static const unsigned   name##_BITS = (end - offset);                   \
  83 static const __u##_bits name##_MAX = (1ULL << (end - offset)) - 1;      \
  84                                                                         \
  85 static inline __u64 name(const type *k)                                 \
  86 {                                                                       \
  87         return (__le##_bits##_to_cpu(k->field) >> offset) &             \
  88                 ~(~0ULL << (end - offset));                             \
  89 }                                                                       \
  90                                                                         \
  91 static inline void SET_##name(type *k, __u64 v)                         \
  92 {                                                                       \
  93         __u##_bits new = __le##_bits##_to_cpu(k->field);                \
  94                                                                         \
  95         new &= ~(~(~0ULL << (end - offset)) << offset);                 \
  96         new |= (v & ~(~0ULL << (end - offset))) << offset;              \
  97         k->field = __cpu_to_le##_bits(new);                             \
  98 }
  99
 100 #define LE16_BITMASK(n, t, f, o, e)     LE_BITMASK(16, n, t, f, o, e)
 101 #define LE32_BITMASK(n, t, f, o, e)     LE_BITMASK(32, n, t, f, o, e)
 102 #define LE64_BITMASK(n, t, f, o, e)     LE_BITMASK(64, n, t, f, o, e)
 103
 104 struct bkey_format {
 105         __u8            key_u64s;
 106         __u8            nr_fields;
 107         /* One unused slot for now: */
 108         __u8            bits_per_field[6];
 109         __le64          field_offset[6];
 110 };
 111
 112 /* Btree keys - all units are in sectors */
 113
 114 struct bpos {
 115         /*
 116          * Word order matches machine byte order - btree code treats a bpos as a
 117          * single large integer, for search/comparison purposes
 118          *
 119          * Note that wherever a bpos is embedded in another on disk data
 120          * structure, it has to be byte swabbed when reading in metadata that
 121          * wasn't written in native endian order:
 122          */
 123 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 124         __u32           snapshot;
 125         __u64           offset;
 126         __u64           inode;
 127 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 128         __u64           inode;
 129         __u64           offset;         /* Points to end of extent - sectors */
 130         __u32           snapshot;
 131 #else
 132 #error edit for your odd byteorder.
 133 #endif
 134 } __attribute__((packed, aligned(4)));
 135
 136 #define KEY_INODE_MAX                   ((__u64)~0ULL)
 137 #define KEY_OFFSET_MAX                  ((__u64)~0ULL)
 138 #define KEY_SNAPSHOT_MAX                ((__u32)~0U)
 139 #define KEY_SIZE_MAX                    ((__u32)~0U)
 140
 141 static inline struct bpos POS(__u64 inode, __u64 offset)
 142 {
 143         struct bpos ret;
 144
 145         ret.inode       = inode;
 146         ret.offset      = offset;
 147         ret.snapshot    = 0;
 148
 149         return ret;
 150 }
 151
 152 #define POS_MIN                         POS(0, 0)
 153 #define POS_MAX                         POS(KEY_INODE_MAX, KEY_OFFSET_MAX)
 154
 155 /* Empty placeholder struct, for container_of() */
 156 struct bch_val {
 157         __u64           __nothing[0];
 158 };
 159
 160 struct bversion {
 161 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 162         __u64           lo;
 163         __u32           hi;
 164 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 165         __u32           hi;
 166         __u64           lo;
 167 #endif
 168 } __attribute__((packed, aligned(4)));
 169
 170 struct bkey {
 171         /* Size of combined key and value, in u64s */
 172         __u8            u64s;
 173
 174         /* Format of key (0 for format local to btree node) */
 175 #if defined(__LITTLE_ENDIAN_BITFIELD)
 176         __u8            format:7,
 177                         needs_whiteout:1;
 178 #elif defined (__BIG_ENDIAN_BITFIELD)
 179         __u8            needs_whiteout:1,
 180                         format:7;
 181 #else
 182 #error edit for your odd byteorder.
 183 #endif
 184
 185         /* Type of the value */
 186         __u8            type;
 187
 188 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 189         __u8            pad[1];
 190
 191         struct bversion version;
 192         __u32           size;           /* extent size, in sectors */
 193         struct bpos     p;
 194 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 195         struct bpos     p;
 196         __u32           size;           /* extent size, in sectors */
 197         struct bversion version;
 198
 199         __u8            pad[1];
 200 #endif
 201 } __attribute__((packed, aligned(8)));
 202
 203 struct bkey_packed {
 204         __u64           _data[0];
 205
 206         /* Size of combined key and value, in u64s */
 207         __u8            u64s;
 208
 209         /* Format of key (0 for format local to btree node) */
 210
 211         /*
 212          * XXX: next incompat on disk format change, switch format and
 213          * needs_whiteout - bkey_packed() will be cheaper if format is the high
 214          * bits of the bitfield
 215          */
 216 #if defined(__LITTLE_ENDIAN_BITFIELD)
 217         __u8            format:7,
 218                         needs_whiteout:1;
 219 #elif defined (__BIG_ENDIAN_BITFIELD)
 220         __u8            needs_whiteout:1,
 221                         format:7;
 222 #endif
 223
 224         /* Type of the value */
 225         __u8            type;
 226         __u8            key_start[0];
 227
 228         /*
 229          * We copy bkeys with struct assignment in various places, and while
 230          * that shouldn't be done with packed bkeys we can't disallow it in C,
 231          * and it's legal to cast a bkey to a bkey_packed  - so padding it out
 232          * to the same size as struct bkey should hopefully be safest.
 233          */
 234         __u8            pad[sizeof(struct bkey) - 3];
 235 } __attribute__((packed, aligned(8)));
 236
 237 #define BKEY_U64s                       (sizeof(struct bkey) / sizeof(__u64))
 238 #define BKEY_U64s_MAX                   U8_MAX
 239 #define BKEY_VAL_U64s_MAX               (BKEY_U64s_MAX - BKEY_U64s)
 240
 241 #define KEY_PACKED_BITS_START           24
 242
 243 #define KEY_FORMAT_LOCAL_BTREE          0
 244 #define KEY_FORMAT_CURRENT              1
 245
 246 enum bch_bkey_fields {
 247         BKEY_FIELD_INODE,
 248         BKEY_FIELD_OFFSET,
 249         BKEY_FIELD_SNAPSHOT,
 250         BKEY_FIELD_SIZE,
 251         BKEY_FIELD_VERSION_HI,
 252         BKEY_FIELD_VERSION_LO,
 253         BKEY_NR_FIELDS,
 254 };
 255
 256 #define bkey_format_field(name, field)                                  \
 257         [BKEY_FIELD_##name] = (sizeof(((struct bkey *) NULL)->field) * 8)
 258
 259 #define BKEY_FORMAT_CURRENT                                             \
 260 ((struct bkey_format) {                                                 \
 261         .key_u64s       = BKEY_U64s,                                    \
 262         .nr_fields      = BKEY_NR_FIELDS,                               \
 263         .bits_per_field = {                                             \
 264                 bkey_format_field(INODE,        p.inode),               \
 265                 bkey_format_field(OFFSET,       p.offset),              \
 266                 bkey_format_field(SNAPSHOT,     p.snapshot),            \
 267                 bkey_format_field(SIZE,         size),                  \
 268                 bkey_format_field(VERSION_HI,   version.hi),            \
 269                 bkey_format_field(VERSION_LO,   version.lo),            \
 270         },                                                              \
 271 })
 272
 273 /* bkey with inline value */
 274 struct bkey_i {
 275         __u64                   _data[0];
 276
 277         union {
 278         struct {
 279                 /* Size of combined key and value, in u64s */
 280                 __u8            u64s;
 281         };
 282         struct {
 283                 struct bkey     k;
 284                 struct bch_val  v;
 285         };
 286         };
 287 };
 288
 289 #define KEY(_inode, _offset, _size)                                     \
 290 ((struct bkey) {                                                        \
 291         .u64s           = BKEY_U64s,                                    \
 292         .format         = KEY_FORMAT_CURRENT,                           \
 293         .p              = POS(_inode, _offset),                         \
 294         .size           = _size,                                        \
 295 })
 296
 297 static inline void bkey_init(struct bkey *k)
 298 {
 299         *k = KEY(0, 0, 0);
 300 }
 301
 302 #define bkey_bytes(_k)          ((_k)->u64s * sizeof(__u64))
 303
 304 #define __BKEY_PADDED(key, pad)                                 \
 305         struct { struct bkey_i key; __u64 key ## _pad[pad]; }
 306
 307 /*
 308  * - DELETED keys are used internally to mark keys that should be ignored but
 309  *   override keys in composition order.  Their version number is ignored.
 310  *
 311  * - DISCARDED keys indicate that the data is all 0s because it has been
 312  *   discarded. DISCARDs may have a version; if the version is nonzero the key
 313  *   will be persistent, otherwise the key will be dropped whenever the btree
 314  *   node is rewritten (like DELETED keys).
 315  *
 316  * - ERROR: any read of the data returns a read error, as the data was lost due
 317  *   to a failing device. Like DISCARDED keys, they can be removed (overridden)
 318  *   by new writes or cluster-wide GC. Node repair can also overwrite them with
 319  *   the same or a more recent version number, but not with an older version
 320  *   number.
 321  *
 322  * - WHITEOUT: for hash table btrees
 323 */
 324 #define BCH_BKEY_TYPES()                                \
 325         x(deleted,              0)                      \
 326         x(discard,              1)                      \
 327         x(error,                2)                      \
 328         x(cookie,               3)                      \
 329         x(whiteout,             4)                      \
 330         x(btree_ptr,            5)                      \
 331         x(extent,               6)                      \
 332         x(reservation,          7)                      \
 333         x(inode,                8)                      \
 334         x(inode_generation,     9)                      \
 335         x(dirent,               10)                     \
 336         x(xattr,                11)                     \
 337         x(alloc,                12)                     \
 338         x(quota,                13)                     \
 339         x(stripe,               14)                     \
 340         x(reflink_p,            15)                     \
 341         x(reflink_v,            16)                     \
 342         x(inline_data,          17)
 343
 344 enum bch_bkey_type {
 345 #define x(name, nr) KEY_TYPE_##name     = nr,
 346         BCH_BKEY_TYPES()
 347 #undef x
 348         KEY_TYPE_MAX,
 349 };
 350
 351 struct bch_cookie {
 352         struct bch_val          v;
 353         __le64                  cookie;
 354 };
 355
 356 /* Extents */
 357
 358 /*
 359  * In extent bkeys, the value is a list of pointers (bch_extent_ptr), optionally
 360  * preceded by checksum/compression information (bch_extent_crc32 or
 361  * bch_extent_crc64).
 362  *
 363  * One major determining factor in the format of extents is how we handle and
 364  * represent extents that have been partially overwritten and thus trimmed:
 365  *
 366  * If an extent is not checksummed or compressed, when the extent is trimmed we
 367  * don't have to remember the extent we originally allocated and wrote: we can
 368  * merely adjust ptr->offset to point to the start of the data that is currently
 369  * live. The size field in struct bkey records the current (live) size of the
 370  * extent, and is also used to mean "size of region on disk that we point to" in
 371  * this case.
 372  *
 373  * Thus an extent that is not checksummed or compressed will consist only of a
 374  * list of bch_extent_ptrs, with none of the fields in
 375  * bch_extent_crc32/bch_extent_crc64.
 376  *
 377  * When an extent is checksummed or compressed, it's not possible to read only
 378  * the data that is currently live: we have to read the entire extent that was
 379  * originally written, and then return only the part of the extent that is
 380  * currently live.
 381  *
 382  * Thus, in addition to the current size of the extent in struct bkey, we need
 383  * to store the size of the originally allocated space - this is the
 384  * compressed_size and uncompressed_size fields in bch_extent_crc32/64. Also,
 385  * when the extent is trimmed, instead of modifying the offset field of the
 386  * pointer, we keep a second smaller offset field - "offset into the original
 387  * extent of the currently live region".
 388  *
 389  * The other major determining factor is replication and data migration:
 390  *
 391  * Each pointer may have its own bch_extent_crc32/64. When doing a replicated
 392  * write, we will initially write all the replicas in the same format, with the
 393  * same checksum type and compression format - however, when copygc runs later (or
 394  * tiering/cache promotion, anything that moves data), it is not in general
 395  * going to rewrite all the pointers at once - one of the replicas may be in a
 396  * bucket on one device that has very little fragmentation while another lives
 397  * in a bucket that has become heavily fragmented, and thus is being rewritten
 398  * sooner than the rest.
 399  *
 400  * Thus it will only move a subset of the pointers (or in the case of
 401  * tiering/cache promotion perhaps add a single pointer without dropping any
 402  * current pointers), and if the extent has been partially overwritten it must
 403  * write only the currently live portion (or copygc would not be able to reduce
 404  * fragmentation!) - which necessitates a different bch_extent_crc format for
 405  * the new pointer.
 406  *
 407  * But in the interests of space efficiency, we don't want to store one
 408  * bch_extent_crc for each pointer if we don't have to.
 409  *
 410  * Thus, a bch_extent consists of bch_extent_crc32s, bch_extent_crc64s, and
 411  * bch_extent_ptrs appended arbitrarily one after the other. We determine the
 412  * type of a given entry with a scheme similar to utf8 (except we're encoding a
 413  * type, not a size), encoding the type in the position of the first set bit:
 414  *
 415  * bch_extent_crc32     - 0b1
 416  * bch_extent_ptr       - 0b10
 417  * bch_extent_crc64     - 0b100
 418  *
 419  * We do it this way because bch_extent_crc32 is _very_ constrained on bits (and
 420  * bch_extent_crc64 is the least constrained).
 421  *
 422  * Then, each bch_extent_crc32/64 applies to the pointers that follow after it,
 423  * until the next bch_extent_crc32/64.
 424  *
 425  * If there are no bch_extent_crcs preceding a bch_extent_ptr, then that pointer
 426  * is neither checksummed nor compressed.
 427  */
 428
 429 /* 128 bits, sufficient for cryptographic MACs: */
 430 struct bch_csum {
 431         __le64                  lo;
 432         __le64                  hi;
 433 } __attribute__((packed, aligned(8)));
 434
 435 enum bch_csum_type {
 436         BCH_CSUM_NONE                   = 0,
 437         BCH_CSUM_CRC32C_NONZERO         = 1,
 438         BCH_CSUM_CRC64_NONZERO          = 2,
 439         BCH_CSUM_CHACHA20_POLY1305_80   = 3,
 440         BCH_CSUM_CHACHA20_POLY1305_128  = 4,
 441         BCH_CSUM_CRC32C                 = 5,
 442         BCH_CSUM_CRC64                  = 6,
 443         BCH_CSUM_NR                     = 7,
 444 };
 445
 446 static const unsigned bch_crc_bytes[] = {
 447         [BCH_CSUM_NONE]                         = 0,
 448         [BCH_CSUM_CRC32C_NONZERO]               = 4,
 449         [BCH_CSUM_CRC32C]                       = 4,
 450         [BCH_CSUM_CRC64_NONZERO]                = 8,
 451         [BCH_CSUM_CRC64]                        = 8,
 452         [BCH_CSUM_CHACHA20_POLY1305_80]         = 10,
 453         [BCH_CSUM_CHACHA20_POLY1305_128]        = 16,
 454 };
 455
 456 static inline _Bool bch2_csum_type_is_encryption(enum bch_csum_type type)
 457 {
 458         switch (type) {
 459         case BCH_CSUM_CHACHA20_POLY1305_80:
 460         case BCH_CSUM_CHACHA20_POLY1305_128:
 461                 return true;
 462         default:
 463                 return false;
 464         }
 465 }
 466
 467 enum bch_compression_type {
 468         BCH_COMPRESSION_NONE            = 0,
 469         BCH_COMPRESSION_LZ4_OLD         = 1,
 470         BCH_COMPRESSION_GZIP            = 2,
 471         BCH_COMPRESSION_LZ4             = 3,
 472         BCH_COMPRESSION_ZSTD            = 4,
 473         BCH_COMPRESSION_NR              = 5,
 474 };
 475
 476 #define BCH_EXTENT_ENTRY_TYPES()                \
 477         x(ptr,                  0)              \
 478         x(crc32,                1)              \
 479         x(crc64,                2)              \
 480         x(crc128,               3)              \
 481         x(stripe_ptr,           4)
 482 #define BCH_EXTENT_ENTRY_MAX    5
 483
 484 enum bch_extent_entry_type {
 485 #define x(f, n) BCH_EXTENT_ENTRY_##f = n,
 486         BCH_EXTENT_ENTRY_TYPES()
 487 #undef x
 488 };
 489
 490 /* Compressed/uncompressed size are stored biased by 1: */
 491 struct bch_extent_crc32 {
 492 #if defined(__LITTLE_ENDIAN_BITFIELD)
 493         __u32                   type:2,
 494                                 _compressed_size:7,
 495                                 _uncompressed_size:7,
 496                                 offset:7,
 497                                 _unused:1,
 498                                 csum_type:4,
 499                                 compression_type:4;
 500         __u32                   csum;
 501 #elif defined (__BIG_ENDIAN_BITFIELD)
 502         __u32                   csum;
 503         __u32                   compression_type:4,
 504                                 csum_type:4,
 505                                 _unused:1,
 506                                 offset:7,
 507                                 _uncompressed_size:7,
 508                                 _compressed_size:7,
 509                                 type:2;
 510 #endif
 511 } __attribute__((packed, aligned(8)));
 512
 513 #define CRC32_SIZE_MAX          (1U << 7)
 514 #define CRC32_NONCE_MAX         0
 515
 516 struct bch_extent_crc64 {
 517 #if defined(__LITTLE_ENDIAN_BITFIELD)
 518         __u64                   type:3,
 519                                 _compressed_size:9,
 520                                 _uncompressed_size:9,
 521                                 offset:9,
 522                                 nonce:10,
 523                                 csum_type:4,
 524                                 compression_type:4,
 525                                 csum_hi:16;
 526 #elif defined (__BIG_ENDIAN_BITFIELD)
 527         __u64                   csum_hi:16,
 528                                 compression_type:4,
 529                                 csum_type:4,
 530                                 nonce:10,
 531                                 offset:9,
 532                                 _uncompressed_size:9,
 533                                 _compressed_size:9,
 534                                 type:3;
 535 #endif
 536         __u64                   csum_lo;
 537 } __attribute__((packed, aligned(8)));
 538
 539 #define CRC64_SIZE_MAX          (1U << 9)
 540 #define CRC64_NONCE_MAX         ((1U << 10) - 1)
 541
 542 struct bch_extent_crc128 {
 543 #if defined(__LITTLE_ENDIAN_BITFIELD)
 544         __u64                   type:4,
 545                                 _compressed_size:13,
 546                                 _uncompressed_size:13,
 547                                 offset:13,
 548                                 nonce:13,
 549                                 csum_type:4,
 550                                 compression_type:4;
 551 #elif defined (__BIG_ENDIAN_BITFIELD)
 552         __u64                   compression_type:4,
 553                                 csum_type:4,
 554                                 nonce:13,
 555                                 offset:13,
 556                                 _uncompressed_size:13,
 557                                 _compressed_size:13,
 558                                 type:4;
 559 #endif
 560         struct bch_csum         csum;
 561 } __attribute__((packed, aligned(8)));
 562
 563 #define CRC128_SIZE_MAX         (1U << 13)
 564 #define CRC128_NONCE_MAX        ((1U << 13) - 1)
 565
 566 /*
 567  * @reservation - pointer hasn't been written to, just reserved
 568  */
 569 struct bch_extent_ptr {
 570 #if defined(__LITTLE_ENDIAN_BITFIELD)
 571         __u64                   type:1,
 572                                 cached:1,
 573                                 unused:1,
 574                                 reservation:1,
 575                                 offset:44, /* 8 petabytes */
 576                                 dev:8,
 577                                 gen:8;
 578 #elif defined (__BIG_ENDIAN_BITFIELD)
 579         __u64                   gen:8,
 580                                 dev:8,
 581                                 offset:44,
 582                                 reservation:1,
 583                                 unused:1,
 584                                 cached:1,
 585                                 type:1;
 586 #endif
 587 } __attribute__((packed, aligned(8)));
 588
 589 struct bch_extent_stripe_ptr {
 590 #if defined(__LITTLE_ENDIAN_BITFIELD)
 591         __u64                   type:5,
 592                                 block:8,
 593                                 idx:51;
 594 #elif defined (__BIG_ENDIAN_BITFIELD)
 595         __u64                   idx:51,
 596                                 block:8,
 597                                 type:5;
 598 #endif
 599 };
 600
 601 struct bch_extent_reservation {
 602 #if defined(__LITTLE_ENDIAN_BITFIELD)
 603         __u64                   type:6,
 604                                 unused:22,
 605                                 replicas:4,
 606                                 generation:32;
 607 #elif defined (__BIG_ENDIAN_BITFIELD)
 608         __u64                   generation:32,
 609                                 replicas:4,
 610                                 unused:22,
 611                                 type:6;
 612 #endif
 613 };
 614
 615 union bch_extent_entry {
 616 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ ||  __BITS_PER_LONG == 64
 617         unsigned long                   type;
 618 #elif __BITS_PER_LONG == 32
 619         struct {
 620                 unsigned long           pad;
 621                 unsigned long           type;
 622         };
 623 #else
 624 #error edit for your odd byteorder.
 625 #endif
 626
 627 #define x(f, n) struct bch_extent_##f   f;
 628         BCH_EXTENT_ENTRY_TYPES()
 629 #undef x
 630 };
 631
 632 struct bch_btree_ptr {
 633         struct bch_val          v;
 634
 635         struct bch_extent_ptr   start[0];
 636         __u64                   _data[0];
 637 } __attribute__((packed, aligned(8)));
 638
 639 struct bch_extent {
 640         struct bch_val          v;
 641
 642         union bch_extent_entry  start[0];
 643         __u64                   _data[0];
 644 } __attribute__((packed, aligned(8)));
 645
 646 struct bch_reservation {
 647         struct bch_val          v;
 648
 649         __le32                  generation;
 650         __u8                    nr_replicas;
 651         __u8                    pad[3];
 652 } __attribute__((packed, aligned(8)));
 653
 654 /* Maximum size (in u64s) a single pointer could be: */
 655 #define BKEY_EXTENT_PTR_U64s_MAX\
 656         ((sizeof(struct bch_extent_crc128) +                    \
 657           sizeof(struct bch_extent_ptr)) / sizeof(u64))
 658
 659 /* Maximum possible size of an entire extent value: */
 660 #define BKEY_EXTENT_VAL_U64s_MAX                                \
 661         (1 + BKEY_EXTENT_PTR_U64s_MAX * (BCH_REPLICAS_MAX + 1))
 662
 663 #define BKEY_PADDED(key)        __BKEY_PADDED(key, BKEY_EXTENT_VAL_U64s_MAX)
 664
 665 /* * Maximum possible size of an entire extent, key + value: */
 666 #define BKEY_EXTENT_U64s_MAX            (BKEY_U64s + BKEY_EXTENT_VAL_U64s_MAX)
 667
 668 /* Btree pointers don't carry around checksums: */
 669 #define BKEY_BTREE_PTR_VAL_U64s_MAX                             \
 670         ((sizeof(struct bch_extent_ptr)) / sizeof(u64) * BCH_REPLICAS_MAX)
 671 #define BKEY_BTREE_PTR_U64s_MAX                                 \
 672         (BKEY_U64s + BKEY_BTREE_PTR_VAL_U64s_MAX)
 673
 674 /* Inodes */
 675
 676 #define BLOCKDEV_INODE_MAX      4096
 677
 678 #define BCACHEFS_ROOT_INO       4096
 679
 680 struct bch_inode {
 681         struct bch_val          v;
 682
 683         __le64                  bi_hash_seed;
 684         __le32                  bi_flags;
 685         __le16                  bi_mode;
 686         __u8                    fields[0];
 687 } __attribute__((packed, aligned(8)));
 688
 689 struct bch_inode_generation {
 690         struct bch_val          v;
 691
 692         __le32                  bi_generation;
 693         __le32                  pad;
 694 } __attribute__((packed, aligned(8)));
 695
 696 #define BCH_INODE_FIELDS()                      \
 697         x(bi_atime,                     64)     \
 698         x(bi_ctime,                     64)     \
 699         x(bi_mtime,                     64)     \
 700         x(bi_otime,                     64)     \
 701         x(bi_size,                      64)     \
 702         x(bi_sectors,                   64)     \
 703         x(bi_uid,                       32)     \
 704         x(bi_gid,                       32)     \
 705         x(bi_nlink,                     32)     \
 706         x(bi_generation,                32)     \
 707         x(bi_dev,                       32)     \
 708         x(bi_data_checksum,             8)      \
 709         x(bi_compression,               8)      \
 710         x(bi_project,                   32)     \
 711         x(bi_background_compression,    8)      \
 712         x(bi_data_replicas,             8)      \
 713         x(bi_promote_target,            16)     \
 714         x(bi_foreground_target,         16)     \
 715         x(bi_background_target,         16)     \
 716         x(bi_erasure_code,              16)     \
 717         x(bi_fields_set,                16)
 718
 719 /* subset of BCH_INODE_FIELDS */
 720 #define BCH_INODE_OPTS()                        \
 721         x(data_checksum,                8)      \
 722         x(compression,                  8)      \
 723         x(project,                      32)     \
 724         x(background_compression,       8)      \
 725         x(data_replicas,                8)      \
 726         x(promote_target,               16)     \
 727         x(foreground_target,            16)     \
 728         x(background_target,            16)     \
 729         x(erasure_code,                 16)
 730
 731 enum inode_opt_id {
 732 #define x(name, ...)                            \
 733         Inode_opt_##name,
 734         BCH_INODE_OPTS()
 735 #undef  x
 736         Inode_opt_nr,
 737 };
 738
 739 enum {
 740         /*
 741          * User flags (get/settable with FS_IOC_*FLAGS, correspond to FS_*_FL
 742          * flags)
 743          */
 744         __BCH_INODE_SYNC        = 0,
 745         __BCH_INODE_IMMUTABLE   = 1,
 746         __BCH_INODE_APPEND      = 2,
 747         __BCH_INODE_NODUMP      = 3,
 748         __BCH_INODE_NOATIME     = 4,
 749
 750         __BCH_INODE_I_SIZE_DIRTY= 5,
 751         __BCH_INODE_I_SECTORS_DIRTY= 6,
 752         __BCH_INODE_UNLINKED    = 7,
 753
 754         /* bits 20+ reserved for packed fields below: */
 755 };
 756
 757 #define BCH_INODE_SYNC          (1 << __BCH_INODE_SYNC)
 758 #define BCH_INODE_IMMUTABLE     (1 << __BCH_INODE_IMMUTABLE)
 759 #define BCH_INODE_APPEND        (1 << __BCH_INODE_APPEND)
 760 #define BCH_INODE_NODUMP        (1 << __BCH_INODE_NODUMP)
 761 #define BCH_INODE_NOATIME       (1 << __BCH_INODE_NOATIME)
 762 #define BCH_INODE_I_SIZE_DIRTY  (1 << __BCH_INODE_I_SIZE_DIRTY)
 763 #define BCH_INODE_I_SECTORS_DIRTY (1 << __BCH_INODE_I_SECTORS_DIRTY)
 764 #define BCH_INODE_UNLINKED      (1 << __BCH_INODE_UNLINKED)
 765
 766 LE32_BITMASK(INODE_STR_HASH,    struct bch_inode, bi_flags, 20, 24);
 767 LE32_BITMASK(INODE_NR_FIELDS,   struct bch_inode, bi_flags, 24, 32);
 768
 769 /* Dirents */
 770
 771 /*
 772  * Dirents (and xattrs) have to implement string lookups; since our b-tree
 773  * doesn't support arbitrary length strings for the key, we instead index by a
 774  * 64 bit hash (currently truncated sha1) of the string, stored in the offset
 775  * field of the key - using linear probing to resolve hash collisions. This also
 776  * provides us with the readdir cookie posix requires.
 777  *
 778  * Linear probing requires us to use whiteouts for deletions, in the event of a
 779  * collision:
 780  */
 781
 782 struct bch_dirent {
 783         struct bch_val          v;
 784
 785         /* Target inode number: */
 786         __le64                  d_inum;
 787
 788         /*
 789          * Copy of mode bits 12-15 from the target inode - so userspace can get
 790          * the filetype without having to do a stat()
 791          */
 792         __u8                    d_type;
 793
 794         __u8                    d_name[];
 795 } __attribute__((packed, aligned(8)));
 796
 797 #define BCH_NAME_MAX    (U8_MAX * sizeof(u64) -                         \
 798                          sizeof(struct bkey) -                          \
 799                          offsetof(struct bch_dirent, d_name))
 800
 801
 802 /* Xattrs */
 803
 804 #define KEY_TYPE_XATTR_INDEX_USER                       0
 805 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS   1
 806 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT  2
 807 #define KEY_TYPE_XATTR_INDEX_TRUSTED                    3
 808 #define KEY_TYPE_XATTR_INDEX_SECURITY           4
 809
 810 struct bch_xattr {
 811         struct bch_val          v;
 812         __u8                    x_type;
 813         __u8                    x_name_len;
 814         __le16                  x_val_len;
 815         __u8                    x_name[];
 816 } __attribute__((packed, aligned(8)));
 817
 818 /* Bucket/allocation information: */
 819
 820 struct bch_alloc {
 821         struct bch_val          v;
 822         __u8                    fields;
 823         __u8                    gen;
 824         __u8                    data[];
 825 } __attribute__((packed, aligned(8)));
 826
 827 #define BCH_ALLOC_FIELDS()                      \
 828         x(read_time,            16)             \
 829         x(write_time,           16)             \
 830         x(data_type,            8)              \
 831         x(dirty_sectors,        16)             \
 832         x(cached_sectors,       16)             \
 833         x(oldest_gen,           8)
 834
 835 enum {
 836 #define x(name, bytes) BCH_ALLOC_FIELD_##name,
 837         BCH_ALLOC_FIELDS()
 838 #undef x
 839         BCH_ALLOC_FIELD_NR
 840 };
 841
 842 static const unsigned BCH_ALLOC_FIELD_BYTES[] = {
 843 #define x(name, bits) [BCH_ALLOC_FIELD_##name] = bits / 8,
 844         BCH_ALLOC_FIELDS()
 845 #undef x
 846 };
 847
 848 #define x(name, bits) + (bits / 8)
 849 static const unsigned BKEY_ALLOC_VAL_U64s_MAX =
 850         DIV_ROUND_UP(offsetof(struct bch_alloc, data)
 851                      BCH_ALLOC_FIELDS(), sizeof(u64));
 852 #undef x
 853
 854 #define BKEY_ALLOC_U64s_MAX     (BKEY_U64s + BKEY_ALLOC_VAL_U64s_MAX)
 855
 856 /* Quotas: */
 857
 858 enum quota_types {
 859         QTYP_USR                = 0,
 860         QTYP_GRP                = 1,
 861         QTYP_PRJ                = 2,
 862         QTYP_NR                 = 3,
 863 };
 864
 865 enum quota_counters {
 866         Q_SPC                   = 0,
 867         Q_INO                   = 1,
 868         Q_COUNTERS              = 2,
 869 };
 870
 871 struct bch_quota_counter {
 872         __le64                  hardlimit;
 873         __le64                  softlimit;
 874 };
 875
 876 struct bch_quota {
 877         struct bch_val          v;
 878         struct bch_quota_counter c[Q_COUNTERS];
 879 } __attribute__((packed, aligned(8)));
 880
 881 /* Erasure coding */
 882
 883 struct bch_stripe {
 884         struct bch_val          v;
 885         __le16                  sectors;
 886         __u8                    algorithm;
 887         __u8                    nr_blocks;
 888         __u8                    nr_redundant;
 889
 890         __u8                    csum_granularity_bits;
 891         __u8                    csum_type;
 892         __u8                    pad;
 893
 894         struct bch_extent_ptr   ptrs[0];
 895 } __attribute__((packed, aligned(8)));
 896
 897 /* Reflink: */
 898
 899 struct bch_reflink_p {
 900         struct bch_val          v;
 901         __le64                  idx;
 902
 903         __le32                  reservation_generation;
 904         __u8                    nr_replicas;
 905         __u8                    pad[3];
 906 };
 907
 908 struct bch_reflink_v {
 909         struct bch_val          v;
 910         __le64                  refcount;
 911         union bch_extent_entry  start[0];
 912         __u64                   _data[0];
 913 };
 914
 915 /* Inline data */
 916
 917 struct bch_inline_data {
 918         struct bch_val          v;
 919         u8                      data[0];
 920 };
 921
 922 /* Optional/variable size superblock sections: */
 923
 924 struct bch_sb_field {
 925         __u64                   _data[0];
 926         __le32                  u64s;
 927         __le32                  type;
 928 };
 929
 930 #define BCH_SB_FIELDS()         \
 931         x(journal,      0)      \
 932         x(members,      1)      \
 933         x(crypt,        2)      \
 934         x(replicas_v0,  3)      \
 935         x(quota,        4)      \
 936         x(disk_groups,  5)      \
 937         x(clean,        6)      \
 938         x(replicas,     7)      \
 939         x(journal_seq_blacklist, 8)
 940
 941 enum bch_sb_field_type {
 942 #define x(f, nr)        BCH_SB_FIELD_##f = nr,
 943         BCH_SB_FIELDS()
 944 #undef x
 945         BCH_SB_FIELD_NR
 946 };
 947
 948 /* BCH_SB_FIELD_journal: */
 949
 950 struct bch_sb_field_journal {
 951         struct bch_sb_field     field;
 952         __le64                  buckets[0];
 953 };
 954
 955 /* BCH_SB_FIELD_members: */
 956
 957 #define BCH_MIN_NR_NBUCKETS     (1 << 6)
 958
 959 struct bch_member {
 960         uuid_le                 uuid;
 961         __le64                  nbuckets;       /* device size */
 962         __le16                  first_bucket;   /* index of first bucket used */
 963         __le16                  bucket_size;    /* sectors */
 964         __le32                  pad;
 965         __le64                  last_mount;     /* time_t */
 966
 967         __le64                  flags[2];
 968 };
 969
 970 LE64_BITMASK(BCH_MEMBER_STATE,          struct bch_member, flags[0],  0,  4)
 971 /* 4-10 unused, was TIER, HAS_(META)DATA */
 972 LE64_BITMASK(BCH_MEMBER_REPLACEMENT,    struct bch_member, flags[0], 10, 14)
 973 LE64_BITMASK(BCH_MEMBER_DISCARD,        struct bch_member, flags[0], 14, 15)
 974 LE64_BITMASK(BCH_MEMBER_DATA_ALLOWED,   struct bch_member, flags[0], 15, 20)
 975 LE64_BITMASK(BCH_MEMBER_GROUP,          struct bch_member, flags[0], 20, 28)
 976 LE64_BITMASK(BCH_MEMBER_DURABILITY,     struct bch_member, flags[0], 28, 30)
 977
 978 #define BCH_TIER_MAX                    4U
 979
 980 #if 0
 981 LE64_BITMASK(BCH_MEMBER_NR_READ_ERRORS, struct bch_member, flags[1], 0,  20);
 982 LE64_BITMASK(BCH_MEMBER_NR_WRITE_ERRORS,struct bch_member, flags[1], 20, 40);
 983 #endif
 984
 985 enum bch_member_state {
 986         BCH_MEMBER_STATE_RW             = 0,
 987         BCH_MEMBER_STATE_RO             = 1,
 988         BCH_MEMBER_STATE_FAILED         = 2,
 989         BCH_MEMBER_STATE_SPARE          = 3,
 990         BCH_MEMBER_STATE_NR             = 4,
 991 };
 992
 993 enum cache_replacement {
 994         CACHE_REPLACEMENT_LRU           = 0,
 995         CACHE_REPLACEMENT_FIFO          = 1,
 996         CACHE_REPLACEMENT_RANDOM        = 2,
 997         CACHE_REPLACEMENT_NR            = 3,
 998 };
 999
1000 struct bch_sb_field_members {
1001         struct bch_sb_field     field;
1002         struct bch_member       members[0];
1003 };
1004
1005 /* BCH_SB_FIELD_crypt: */
1006
1007 struct nonce {
1008         __le32                  d[4];
1009 };
1010
1011 struct bch_key {
1012         __le64                  key[4];
1013 };
1014
1015 #define BCH_KEY_MAGIC                                   \
1016         (((u64) 'b' <<  0)|((u64) 'c' <<  8)|           \
1017          ((u64) 'h' << 16)|((u64) '*' << 24)|           \
1018          ((u64) '*' << 32)|((u64) 'k' << 40)|           \
1019          ((u64) 'e' << 48)|((u64) 'y' << 56))
1020
1021 struct bch_encrypted_key {
1022         __le64                  magic;
1023         struct bch_key          key;
1024 };
1025
1026 /*
1027  * If this field is present in the superblock, it stores an encryption key which
1028  * is used encrypt all other data/metadata. The key will normally be encrypted
1029  * with the key userspace provides, but if encryption has been turned off we'll
1030  * just store the master key unencrypted in the superblock so we can access the
1031  * previously encrypted data.
1032  */
1033 struct bch_sb_field_crypt {
1034         struct bch_sb_field     field;
1035
1036         __le64                  flags;
1037         __le64                  kdf_flags;
1038         struct bch_encrypted_key key;
1039 };
1040
1041 LE64_BITMASK(BCH_CRYPT_KDF_TYPE,        struct bch_sb_field_crypt, flags, 0, 4);
1042
1043 enum bch_kdf_types {
1044         BCH_KDF_SCRYPT          = 0,
1045         BCH_KDF_NR              = 1,
1046 };
1047
1048 /* stored as base 2 log of scrypt params: */
1049 LE64_BITMASK(BCH_KDF_SCRYPT_N,  struct bch_sb_field_crypt, kdf_flags,  0, 16);
1050 LE64_BITMASK(BCH_KDF_SCRYPT_R,  struct bch_sb_field_crypt, kdf_flags, 16, 32);
1051 LE64_BITMASK(BCH_KDF_SCRYPT_P,  struct bch_sb_field_crypt, kdf_flags, 32, 48);
1052
1053 /* BCH_SB_FIELD_replicas: */
1054
1055 enum bch_data_type {
1056         BCH_DATA_NONE           = 0,
1057         BCH_DATA_SB             = 1,
1058         BCH_DATA_JOURNAL        = 2,
1059         BCH_DATA_BTREE          = 3,
1060         BCH_DATA_USER           = 4,
1061         BCH_DATA_CACHED         = 5,
1062         BCH_DATA_NR             = 6,
1063 };
1064
1065 struct bch_replicas_entry_v0 {
1066         __u8                    data_type;
1067         __u8                    nr_devs;
1068         __u8                    devs[0];
1069 } __attribute__((packed));
1070
1071 struct bch_sb_field_replicas_v0 {
1072         struct bch_sb_field     field;
1073         struct bch_replicas_entry_v0 entries[0];
1074 } __attribute__((packed, aligned(8)));
1075
1076 struct bch_replicas_entry {
1077         __u8                    data_type;
1078         __u8                    nr_devs;
1079         __u8                    nr_required;
1080         __u8                    devs[0];
1081 } __attribute__((packed));
1082
1083 struct bch_sb_field_replicas {
1084         struct bch_sb_field     field;
1085         struct bch_replicas_entry entries[0];
1086 } __attribute__((packed, aligned(8)));
1087
1088 /* BCH_SB_FIELD_quota: */
1089
1090 struct bch_sb_quota_counter {
1091         __le32                          timelimit;
1092         __le32                          warnlimit;
1093 };
1094
1095 struct bch_sb_quota_type {
1096         __le64                          flags;
1097         struct bch_sb_quota_counter     c[Q_COUNTERS];
1098 };
1099
1100 struct bch_sb_field_quota {
1101         struct bch_sb_field             field;
1102         struct bch_sb_quota_type        q[QTYP_NR];
1103 } __attribute__((packed, aligned(8)));
1104
1105 /* BCH_SB_FIELD_disk_groups: */
1106
1107 #define BCH_SB_LABEL_SIZE               32
1108
1109 struct bch_disk_group {
1110         __u8                    label[BCH_SB_LABEL_SIZE];
1111         __le64                  flags[2];
1112 } __attribute__((packed, aligned(8)));
1113
1114 LE64_BITMASK(BCH_GROUP_DELETED,         struct bch_disk_group, flags[0], 0,  1)
1115 LE64_BITMASK(BCH_GROUP_DATA_ALLOWED,    struct bch_disk_group, flags[0], 1,  6)
1116 LE64_BITMASK(BCH_GROUP_PARENT,          struct bch_disk_group, flags[0], 6, 24)
1117
1118 struct bch_sb_field_disk_groups {
1119         struct bch_sb_field     field;
1120         struct bch_disk_group   entries[0];
1121 } __attribute__((packed, aligned(8)));
1122
1123 /*
1124  * On clean shutdown, store btree roots and current journal sequence number in
1125  * the superblock:
1126  */
1127 struct jset_entry {
1128         __le16                  u64s;
1129         __u8                    btree_id;
1130         __u8                    level;
1131         __u8                    type; /* designates what this jset holds */
1132         __u8                    pad[3];
1133
1134         union {
1135                 struct bkey_i   start[0];
1136                 __u64           _data[0];
1137         };
1138 };
1139
1140 struct bch_sb_field_clean {
1141         struct bch_sb_field     field;
1142
1143         __le32                  flags;
1144         __le16                  read_clock;
1145         __le16                  write_clock;
1146         __le64                  journal_seq;
1147
1148         union {
1149                 struct jset_entry start[0];
1150                 __u64           _data[0];
1151         };
1152 };
1153
1154 struct journal_seq_blacklist_entry {
1155         __le64                  start;
1156         __le64                  end;
1157 };
1158
1159 struct bch_sb_field_journal_seq_blacklist {
1160         struct bch_sb_field     field;
1161
1162         union {
1163                 struct journal_seq_blacklist_entry start[0];
1164                 __u64           _data[0];
1165         };
1166 };
1167
1168 /* Superblock: */
1169
1170 /*
1171  * New versioning scheme:
1172  * One common version number for all on disk data structures - superblock, btree
1173  * nodes, journal entries
1174  */
1175 #define BCH_JSET_VERSION_OLD                    2
1176 #define BCH_BSET_VERSION_OLD                    3
1177
1178 enum bcachefs_metadata_version {
1179         bcachefs_metadata_version_min                   = 9,
1180         bcachefs_metadata_version_new_versioning        = 10,
1181         bcachefs_metadata_version_bkey_renumber         = 10,
1182         bcachefs_metadata_version_max                   = 11,
1183 };
1184
1185 #define bcachefs_metadata_version_current       (bcachefs_metadata_version_max - 1)
1186
1187 #define BCH_SB_SECTOR                   8
1188 #define BCH_SB_MEMBERS_MAX              64 /* XXX kill */
1189
1190 struct bch_sb_layout {
1191         uuid_le                 magic;  /* bcachefs superblock UUID */
1192         __u8                    layout_type;
1193         __u8                    sb_max_size_bits; /* base 2 of 512 byte sectors */
1194         __u8                    nr_superblocks;
1195         __u8                    pad[5];
1196         __le64                  sb_offset[61];
1197 } __attribute__((packed, aligned(8)));
1198
1199 #define BCH_SB_LAYOUT_SECTOR    7
1200
1201 /*
1202  * @offset      - sector where this sb was written
1203  * @version     - on disk format version
1204  * @version_min - Oldest metadata version this filesystem contains; so we can
1205  *                safely drop compatibility code and refuse to mount filesystems
1206  *                we'd need it for
1207  * @magic       - identifies as a bcachefs superblock (BCACHE_MAGIC)
1208  * @seq         - incremented each time superblock is written
1209  * @uuid        - used for generating various magic numbers and identifying
1210  *                member devices, never changes
1211  * @user_uuid   - user visible UUID, may be changed
1212  * @label       - filesystem label
1213  * @seq         - identifies most recent superblock, incremented each time
1214  *                superblock is written
1215  * @features    - enabled incompatible features
1216  */
1217 struct bch_sb {
1218         struct bch_csum         csum;
1219         __le16                  version;
1220         __le16                  version_min;
1221         __le16                  pad[2];
1222         uuid_le                 magic;
1223         uuid_le                 uuid;
1224         uuid_le                 user_uuid;
1225         __u8                    label[BCH_SB_LABEL_SIZE];
1226         __le64                  offset;
1227         __le64                  seq;
1228
1229         __le16                  block_size;
1230         __u8                    dev_idx;
1231         __u8                    nr_devices;
1232         __le32                  u64s;
1233
1234         __le64                  time_base_lo;
1235         __le32                  time_base_hi;
1236         __le32                  time_precision;
1237
1238         __le64                  flags[8];
1239         __le64                  features[2];
1240         __le64                  compat[2];
1241
1242         struct bch_sb_layout    layout;
1243
1244         union {
1245                 struct bch_sb_field start[0];
1246                 __le64          _data[0];
1247         };
1248 } __attribute__((packed, aligned(8)));
1249
1250 /*
1251  * Flags:
1252  * BCH_SB_INITALIZED    - set on first mount
1253  * BCH_SB_CLEAN         - did we shut down cleanly? Just a hint, doesn't affect
1254  *                        behaviour of mount/recovery path:
1255  * BCH_SB_INODE_32BIT   - limit inode numbers to 32 bits
1256  * BCH_SB_128_BIT_MACS  - 128 bit macs instead of 80
1257  * BCH_SB_ENCRYPTION_TYPE - if nonzero encryption is enabled; overrides
1258  *                         DATA/META_CSUM_TYPE. Also indicates encryption
1259  *                         algorithm in use, if/when we get more than one
1260  */
1261
1262 LE16_BITMASK(BCH_SB_BLOCK_SIZE,         struct bch_sb, block_size, 0, 16);
1263
1264 LE64_BITMASK(BCH_SB_INITIALIZED,        struct bch_sb, flags[0],  0,  1);
1265 LE64_BITMASK(BCH_SB_CLEAN,              struct bch_sb, flags[0],  1,  2);
1266 LE64_BITMASK(BCH_SB_CSUM_TYPE,          struct bch_sb, flags[0],  2,  8);
1267 LE64_BITMASK(BCH_SB_ERROR_ACTION,       struct bch_sb, flags[0],  8, 12);
1268
1269 LE64_BITMASK(BCH_SB_BTREE_NODE_SIZE,    struct bch_sb, flags[0], 12, 28);
1270
1271 LE64_BITMASK(BCH_SB_GC_RESERVE,         struct bch_sb, flags[0], 28, 33);
1272 LE64_BITMASK(BCH_SB_ROOT_RESERVE,       struct bch_sb, flags[0], 33, 40);
1273
1274 LE64_BITMASK(BCH_SB_META_CSUM_TYPE,     struct bch_sb, flags[0], 40, 44);
1275 LE64_BITMASK(BCH_SB_DATA_CSUM_TYPE,     struct bch_sb, flags[0], 44, 48);
1276
1277 LE64_BITMASK(BCH_SB_META_REPLICAS_WANT, struct bch_sb, flags[0], 48, 52);
1278 LE64_BITMASK(BCH_SB_DATA_REPLICAS_WANT, struct bch_sb, flags[0], 52, 56);
1279
1280 LE64_BITMASK(BCH_SB_POSIX_ACL,          struct bch_sb, flags[0], 56, 57);
1281 LE64_BITMASK(BCH_SB_USRQUOTA,           struct bch_sb, flags[0], 57, 58);
1282 LE64_BITMASK(BCH_SB_GRPQUOTA,           struct bch_sb, flags[0], 58, 59);
1283 LE64_BITMASK(BCH_SB_PRJQUOTA,           struct bch_sb, flags[0], 59, 60);
1284
1285 LE64_BITMASK(BCH_SB_HAS_ERRORS,         struct bch_sb, flags[0], 60, 61);
1286
1287 /* 61-64 unused */
1288
1289 LE64_BITMASK(BCH_SB_STR_HASH_TYPE,      struct bch_sb, flags[1],  0,  4);
1290 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE,   struct bch_sb, flags[1],  4,  8);
1291 LE64_BITMASK(BCH_SB_INODE_32BIT,        struct bch_sb, flags[1],  8,  9);
1292
1293 LE64_BITMASK(BCH_SB_128_BIT_MACS,       struct bch_sb, flags[1],  9, 10);
1294 LE64_BITMASK(BCH_SB_ENCRYPTION_TYPE,    struct bch_sb, flags[1], 10, 14);
1295
1296 /*
1297  * Max size of an extent that may require bouncing to read or write
1298  * (checksummed, compressed): 64k
1299  */
1300 LE64_BITMASK(BCH_SB_ENCODED_EXTENT_MAX_BITS,
1301                                         struct bch_sb, flags[1], 14, 20);
1302
1303 LE64_BITMASK(BCH_SB_META_REPLICAS_REQ,  struct bch_sb, flags[1], 20, 24);
1304 LE64_BITMASK(BCH_SB_DATA_REPLICAS_REQ,  struct bch_sb, flags[1], 24, 28);
1305
1306 LE64_BITMASK(BCH_SB_PROMOTE_TARGET,     struct bch_sb, flags[1], 28, 40);
1307 LE64_BITMASK(BCH_SB_FOREGROUND_TARGET,  struct bch_sb, flags[1], 40, 52);
1308 LE64_BITMASK(BCH_SB_BACKGROUND_TARGET,  struct bch_sb, flags[1], 52, 64);
1309
1310 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE,
1311                                         struct bch_sb, flags[2],  0,  4);
1312 LE64_BITMASK(BCH_SB_GC_RESERVE_BYTES,   struct bch_sb, flags[2],  4, 64);
1313
1314 LE64_BITMASK(BCH_SB_ERASURE_CODE,       struct bch_sb, flags[3],  0, 16);
1315
1316 /* Features: */
1317 enum bch_sb_features {
1318         BCH_FEATURE_LZ4                 = 0,
1319         BCH_FEATURE_GZIP                = 1,
1320         BCH_FEATURE_ZSTD                = 2,
1321         BCH_FEATURE_ATOMIC_NLINK        = 3, /* should have gone under compat */
1322         BCH_FEATURE_EC                  = 4,
1323         BCH_FEATURE_JOURNAL_SEQ_BLACKLIST_V3 = 5,
1324         BCH_FEATURE_REFLINK             = 6,
1325         BCH_FEATURE_NEW_SIPHASH         = 7,
1326         BCH_FEATURE_INLINE_DATA         = 8,
1327         BCH_FEATURE_NR,
1328 };
1329
1330 enum bch_sb_compat {
1331         BCH_COMPAT_FEAT_ALLOC_INFO      = 0,
1332         BCH_COMPAT_FEAT_ALLOC_METADATA  = 1,
1333 };
1334
1335 /* options: */
1336
1337 #define BCH_REPLICAS_MAX                4U
1338
1339 enum bch_error_actions {
1340         BCH_ON_ERROR_CONTINUE           = 0,
1341         BCH_ON_ERROR_RO                 = 1,
1342         BCH_ON_ERROR_PANIC              = 2,
1343         BCH_NR_ERROR_ACTIONS            = 3,
1344 };
1345
1346 enum bch_csum_opts {
1347         BCH_CSUM_OPT_NONE               = 0,
1348         BCH_CSUM_OPT_CRC32C             = 1,
1349         BCH_CSUM_OPT_CRC64              = 2,
1350         BCH_CSUM_OPT_NR                 = 3,
1351 };
1352
1353 enum bch_str_hash_type {
1354         BCH_STR_HASH_CRC32C             = 0,
1355         BCH_STR_HASH_CRC64              = 1,
1356         BCH_STR_HASH_SIPHASH_OLD        = 2,
1357         BCH_STR_HASH_SIPHASH            = 3,
1358         BCH_STR_HASH_NR                 = 4,
1359 };
1360
1361 enum bch_str_hash_opts {
1362         BCH_STR_HASH_OPT_CRC32C         = 0,
1363         BCH_STR_HASH_OPT_CRC64          = 1,
1364         BCH_STR_HASH_OPT_SIPHASH        = 2,
1365         BCH_STR_HASH_OPT_NR             = 3,
1366 };
1367
1368 #define BCH_COMPRESSION_TYPES()         \
1369         x(NONE)                         \
1370         x(LZ4)                          \
1371         x(GZIP)                         \
1372         x(ZSTD)
1373
1374 enum bch_compression_opts {
1375 #define x(t) BCH_COMPRESSION_OPT_##t,
1376         BCH_COMPRESSION_TYPES()
1377 #undef x
1378         BCH_COMPRESSION_OPT_NR
1379 };
1380
1381 /*
1382  * Magic numbers
1383  *
1384  * The various other data structures have their own magic numbers, which are
1385  * xored with the first part of the cache set's UUID
1386  */
1387
1388 #define BCACHE_MAGIC                                                    \
1389         UUID_LE(0xf67385c6, 0x1a4e, 0xca45,                             \
1390                 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81)
1391
1392 #define BCACHEFS_STATFS_MAGIC           0xca451a4e
1393
1394 #define JSET_MAGIC              __cpu_to_le64(0x245235c1a3625032ULL)
1395 #define BSET_MAGIC              __cpu_to_le64(0x90135c78b99e07f5ULL)
1396
1397 static inline __le64 __bch2_sb_magic(struct bch_sb *sb)
1398 {
1399         __le64 ret;
1400         memcpy(&ret, &sb->uuid, sizeof(ret));
1401         return ret;
1402 }
1403
1404 static inline __u64 __jset_magic(struct bch_sb *sb)
1405 {
1406         return __le64_to_cpu(__bch2_sb_magic(sb) ^ JSET_MAGIC);
1407 }
1408
1409 static inline __u64 __bset_magic(struct bch_sb *sb)
1410 {
1411         return __le64_to_cpu(__bch2_sb_magic(sb) ^ BSET_MAGIC);
1412 }
1413
1414 /* Journal */
1415
1416 #define JSET_KEYS_U64s  (sizeof(struct jset_entry) / sizeof(__u64))
1417
1418 #define BCH_JSET_ENTRY_TYPES()                  \
1419         x(btree_keys,           0)              \
1420         x(btree_root,           1)              \
1421         x(prio_ptrs,            2)              \
1422         x(blacklist,            3)              \
1423         x(blacklist_v2,         4)              \
1424         x(usage,                5)              \
1425         x(data_usage,           6)
1426
1427 enum {
1428 #define x(f, nr)        BCH_JSET_ENTRY_##f      = nr,
1429         BCH_JSET_ENTRY_TYPES()
1430 #undef x
1431         BCH_JSET_ENTRY_NR
1432 };
1433
1434 /*
1435  * Journal sequence numbers can be blacklisted: bsets record the max sequence
1436  * number of all the journal entries they contain updates for, so that on
1437  * recovery we can ignore those bsets that contain index updates newer that what
1438  * made it into the journal.
1439  *
1440  * This means that we can't reuse that journal_seq - we have to skip it, and
1441  * then record that we skipped it so that the next time we crash and recover we
1442  * don't think there was a missing journal entry.
1443  */
1444 struct jset_entry_blacklist {
1445         struct jset_entry       entry;
1446         __le64                  seq;
1447 };
1448
1449 struct jset_entry_blacklist_v2 {
1450         struct jset_entry       entry;
1451         __le64                  start;
1452         __le64                  end;
1453 };
1454
1455 enum {
1456         FS_USAGE_RESERVED               = 0,
1457         FS_USAGE_INODES                 = 1,
1458         FS_USAGE_KEY_VERSION            = 2,
1459         FS_USAGE_NR                     = 3
1460 };
1461
1462 struct jset_entry_usage {
1463         struct jset_entry       entry;
1464         __le64                  v;
1465 } __attribute__((packed));
1466
1467 struct jset_entry_data_usage {
1468         struct jset_entry       entry;
1469         __le64                  v;
1470         struct bch_replicas_entry r;
1471 } __attribute__((packed));
1472
1473 /*
1474  * On disk format for a journal entry:
1475  * seq is monotonically increasing; every journal entry has its own unique
1476  * sequence number.
1477  *
1478  * last_seq is the oldest journal entry that still has keys the btree hasn't
1479  * flushed to disk yet.
1480  *
1481  * version is for on disk format changes.
1482  */
1483 struct jset {
1484         struct bch_csum         csum;
1485
1486         __le64                  magic;
1487         __le64                  seq;
1488         __le32                  version;
1489         __le32                  flags;
1490
1491         __le32                  u64s; /* size of d[] in u64s */
1492
1493         __u8                    encrypted_start[0];
1494
1495         __le16                  read_clock;
1496         __le16                  write_clock;
1497
1498         /* Sequence number of oldest dirty journal entry */
1499         __le64                  last_seq;
1500
1501
1502         union {
1503                 struct jset_entry start[0];
1504                 __u64           _data[0];
1505         };
1506 } __attribute__((packed, aligned(8)));
1507
1508 LE32_BITMASK(JSET_CSUM_TYPE,    struct jset, flags, 0, 4);
1509 LE32_BITMASK(JSET_BIG_ENDIAN,   struct jset, flags, 4, 5);
1510
1511 #define BCH_JOURNAL_BUCKETS_MIN         8
1512
1513 /* Btree: */
1514
1515 #define BCH_BTREE_IDS()                                 \
1516         x(EXTENTS,      0, "extents")                   \
1517         x(INODES,       1, "inodes")                    \
1518         x(DIRENTS,      2, "dirents")                   \
1519         x(XATTRS,       3, "xattrs")                    \
1520         x(ALLOC,        4, "alloc")                     \
1521         x(QUOTAS,       5, "quotas")                    \
1522         x(EC,           6, "stripes")                   \
1523         x(REFLINK,      7, "reflink")
1524
1525 enum btree_id {
1526 #define x(kwd, val, name) BTREE_ID_##kwd = val,
1527         BCH_BTREE_IDS()
1528 #undef x
1529         BTREE_ID_NR
1530 };
1531
1532 #define BTREE_MAX_DEPTH         4U
1533
1534 /* Btree nodes */
1535
1536 /*
1537  * Btree nodes
1538  *
1539  * On disk a btree node is a list/log of these; within each set the keys are
1540  * sorted
1541  */
1542 struct bset {
1543         __le64                  seq;
1544
1545         /*
1546          * Highest journal entry this bset contains keys for.
1547          * If on recovery we don't see that journal entry, this bset is ignored:
1548          * this allows us to preserve the order of all index updates after a
1549          * crash, since the journal records a total order of all index updates
1550          * and anything that didn't make it to the journal doesn't get used.
1551          */
1552         __le64                  journal_seq;
1553
1554         __le32                  flags;
1555         __le16                  version;
1556         __le16                  u64s; /* count of d[] in u64s */
1557
1558         union {
1559                 struct bkey_packed start[0];
1560                 __u64           _data[0];
1561         };
1562 } __attribute__((packed, aligned(8)));
1563
1564 LE32_BITMASK(BSET_CSUM_TYPE,    struct bset, flags, 0, 4);
1565
1566 LE32_BITMASK(BSET_BIG_ENDIAN,   struct bset, flags, 4, 5);
1567 LE32_BITMASK(BSET_SEPARATE_WHITEOUTS,
1568                                 struct bset, flags, 5, 6);
1569
1570 struct btree_node {
1571         struct bch_csum         csum;
1572         __le64                  magic;
1573
1574         /* this flags field is encrypted, unlike bset->flags: */
1575         __le64                  flags;
1576
1577         /* Closed interval: */
1578         struct bpos             min_key;
1579         struct bpos             max_key;
1580         struct bch_extent_ptr   ptr;
1581         struct bkey_format      format;
1582
1583         union {
1584         struct bset             keys;
1585         struct {
1586                 __u8            pad[22];
1587                 __le16          u64s;
1588                 __u64           _data[0];
1589
1590         };
1591         };
1592 } __attribute__((packed, aligned(8)));
1593
1594 LE64_BITMASK(BTREE_NODE_ID,     struct btree_node, flags,  0,  4);
1595 LE64_BITMASK(BTREE_NODE_LEVEL,  struct btree_node, flags,  4,  8);
1596 /* 8-32 unused */
1597 LE64_BITMASK(BTREE_NODE_SEQ,    struct btree_node, flags, 32, 64);
1598
1599 struct btree_node_entry {
1600         struct bch_csum         csum;
1601
1602         union {
1603         struct bset             keys;
1604         struct {
1605                 __u8            pad[22];
1606                 __le16          u64s;
1607                 __u64           _data[0];
1608
1609         };
1610         };
1611 } __attribute__((packed, aligned(8)));
1612
1613 #endif /* _BCACHEFS_FORMAT_H */