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         x(btree_ptr_v2,         18)
 344
 345 enum bch_bkey_type {
 346 #define x(name, nr) KEY_TYPE_##name     = nr,
 347         BCH_BKEY_TYPES()
 348 #undef x
 349         KEY_TYPE_MAX,
 350 };
 351
 352 struct bch_cookie {
 353         struct bch_val          v;
 354         __le64                  cookie;
 355 };
 356
 357 /* Extents */
 358
 359 /*
 360  * In extent bkeys, the value is a list of pointers (bch_extent_ptr), optionally
 361  * preceded by checksum/compression information (bch_extent_crc32 or
 362  * bch_extent_crc64).
 363  *
 364  * One major determining factor in the format of extents is how we handle and
 365  * represent extents that have been partially overwritten and thus trimmed:
 366  *
 367  * If an extent is not checksummed or compressed, when the extent is trimmed we
 368  * don't have to remember the extent we originally allocated and wrote: we can
 369  * merely adjust ptr->offset to point to the start of the data that is currently
 370  * live. The size field in struct bkey records the current (live) size of the
 371  * extent, and is also used to mean "size of region on disk that we point to" in
 372  * this case.
 373  *
 374  * Thus an extent that is not checksummed or compressed will consist only of a
 375  * list of bch_extent_ptrs, with none of the fields in
 376  * bch_extent_crc32/bch_extent_crc64.
 377  *
 378  * When an extent is checksummed or compressed, it's not possible to read only
 379  * the data that is currently live: we have to read the entire extent that was
 380  * originally written, and then return only the part of the extent that is
 381  * currently live.
 382  *
 383  * Thus, in addition to the current size of the extent in struct bkey, we need
 384  * to store the size of the originally allocated space - this is the
 385  * compressed_size and uncompressed_size fields in bch_extent_crc32/64. Also,
 386  * when the extent is trimmed, instead of modifying the offset field of the
 387  * pointer, we keep a second smaller offset field - "offset into the original
 388  * extent of the currently live region".
 389  *
 390  * The other major determining factor is replication and data migration:
 391  *
 392  * Each pointer may have its own bch_extent_crc32/64. When doing a replicated
 393  * write, we will initially write all the replicas in the same format, with the
 394  * same checksum type and compression format - however, when copygc runs later (or
 395  * tiering/cache promotion, anything that moves data), it is not in general
 396  * going to rewrite all the pointers at once - one of the replicas may be in a
 397  * bucket on one device that has very little fragmentation while another lives
 398  * in a bucket that has become heavily fragmented, and thus is being rewritten
 399  * sooner than the rest.
 400  *
 401  * Thus it will only move a subset of the pointers (or in the case of
 402  * tiering/cache promotion perhaps add a single pointer without dropping any
 403  * current pointers), and if the extent has been partially overwritten it must
 404  * write only the currently live portion (or copygc would not be able to reduce
 405  * fragmentation!) - which necessitates a different bch_extent_crc format for
 406  * the new pointer.
 407  *
 408  * But in the interests of space efficiency, we don't want to store one
 409  * bch_extent_crc for each pointer if we don't have to.
 410  *
 411  * Thus, a bch_extent consists of bch_extent_crc32s, bch_extent_crc64s, and
 412  * bch_extent_ptrs appended arbitrarily one after the other. We determine the
 413  * type of a given entry with a scheme similar to utf8 (except we're encoding a
 414  * type, not a size), encoding the type in the position of the first set bit:
 415  *
 416  * bch_extent_crc32     - 0b1
 417  * bch_extent_ptr       - 0b10
 418  * bch_extent_crc64     - 0b100
 419  *
 420  * We do it this way because bch_extent_crc32 is _very_ constrained on bits (and
 421  * bch_extent_crc64 is the least constrained).
 422  *
 423  * Then, each bch_extent_crc32/64 applies to the pointers that follow after it,
 424  * until the next bch_extent_crc32/64.
 425  *
 426  * If there are no bch_extent_crcs preceding a bch_extent_ptr, then that pointer
 427  * is neither checksummed nor compressed.
 428  */
 429
 430 /* 128 bits, sufficient for cryptographic MACs: */
 431 struct bch_csum {
 432         __le64                  lo;
 433         __le64                  hi;
 434 } __attribute__((packed, aligned(8)));
 435
 436 #define BCH_EXTENT_ENTRY_TYPES()                \
 437         x(ptr,                  0)              \
 438         x(crc32,                1)              \
 439         x(crc64,                2)              \
 440         x(crc128,               3)              \
 441         x(stripe_ptr,           4)
 442 #define BCH_EXTENT_ENTRY_MAX    5
 443
 444 enum bch_extent_entry_type {
 445 #define x(f, n) BCH_EXTENT_ENTRY_##f = n,
 446         BCH_EXTENT_ENTRY_TYPES()
 447 #undef x
 448 };
 449
 450 /* Compressed/uncompressed size are stored biased by 1: */
 451 struct bch_extent_crc32 {
 452 #if defined(__LITTLE_ENDIAN_BITFIELD)
 453         __u32                   type:2,
 454                                 _compressed_size:7,
 455                                 _uncompressed_size:7,
 456                                 offset:7,
 457                                 _unused:1,
 458                                 csum_type:4,
 459                                 compression_type:4;
 460         __u32                   csum;
 461 #elif defined (__BIG_ENDIAN_BITFIELD)
 462         __u32                   csum;
 463         __u32                   compression_type:4,
 464                                 csum_type:4,
 465                                 _unused:1,
 466                                 offset:7,
 467                                 _uncompressed_size:7,
 468                                 _compressed_size:7,
 469                                 type:2;
 470 #endif
 471 } __attribute__((packed, aligned(8)));
 472
 473 #define CRC32_SIZE_MAX          (1U << 7)
 474 #define CRC32_NONCE_MAX         0
 475
 476 struct bch_extent_crc64 {
 477 #if defined(__LITTLE_ENDIAN_BITFIELD)
 478         __u64                   type:3,
 479                                 _compressed_size:9,
 480                                 _uncompressed_size:9,
 481                                 offset:9,
 482                                 nonce:10,
 483                                 csum_type:4,
 484                                 compression_type:4,
 485                                 csum_hi:16;
 486 #elif defined (__BIG_ENDIAN_BITFIELD)
 487         __u64                   csum_hi:16,
 488                                 compression_type:4,
 489                                 csum_type:4,
 490                                 nonce:10,
 491                                 offset:9,
 492                                 _uncompressed_size:9,
 493                                 _compressed_size:9,
 494                                 type:3;
 495 #endif
 496         __u64                   csum_lo;
 497 } __attribute__((packed, aligned(8)));
 498
 499 #define CRC64_SIZE_MAX          (1U << 9)
 500 #define CRC64_NONCE_MAX         ((1U << 10) - 1)
 501
 502 struct bch_extent_crc128 {
 503 #if defined(__LITTLE_ENDIAN_BITFIELD)
 504         __u64                   type:4,
 505                                 _compressed_size:13,
 506                                 _uncompressed_size:13,
 507                                 offset:13,
 508                                 nonce:13,
 509                                 csum_type:4,
 510                                 compression_type:4;
 511 #elif defined (__BIG_ENDIAN_BITFIELD)
 512         __u64                   compression_type:4,
 513                                 csum_type:4,
 514                                 nonce:13,
 515                                 offset:13,
 516                                 _uncompressed_size:13,
 517                                 _compressed_size:13,
 518                                 type:4;
 519 #endif
 520         struct bch_csum         csum;
 521 } __attribute__((packed, aligned(8)));
 522
 523 #define CRC128_SIZE_MAX         (1U << 13)
 524 #define CRC128_NONCE_MAX        ((1U << 13) - 1)
 525
 526 /*
 527  * @reservation - pointer hasn't been written to, just reserved
 528  */
 529 struct bch_extent_ptr {
 530 #if defined(__LITTLE_ENDIAN_BITFIELD)
 531         __u64                   type:1,
 532                                 cached:1,
 533                                 unused:1,
 534                                 reservation:1,
 535                                 offset:44, /* 8 petabytes */
 536                                 dev:8,
 537                                 gen:8;
 538 #elif defined (__BIG_ENDIAN_BITFIELD)
 539         __u64                   gen:8,
 540                                 dev:8,
 541                                 offset:44,
 542                                 reservation:1,
 543                                 unused:1,
 544                                 cached:1,
 545                                 type:1;
 546 #endif
 547 } __attribute__((packed, aligned(8)));
 548
 549 struct bch_extent_stripe_ptr {
 550 #if defined(__LITTLE_ENDIAN_BITFIELD)
 551         __u64                   type:5,
 552                                 block:8,
 553                                 idx:51;
 554 #elif defined (__BIG_ENDIAN_BITFIELD)
 555         __u64                   idx:51,
 556                                 block:8,
 557                                 type:5;
 558 #endif
 559 };
 560
 561 struct bch_extent_reservation {
 562 #if defined(__LITTLE_ENDIAN_BITFIELD)
 563         __u64                   type:6,
 564                                 unused:22,
 565                                 replicas:4,
 566                                 generation:32;
 567 #elif defined (__BIG_ENDIAN_BITFIELD)
 568         __u64                   generation:32,
 569                                 replicas:4,
 570                                 unused:22,
 571                                 type:6;
 572 #endif
 573 };
 574
 575 union bch_extent_entry {
 576 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ ||  __BITS_PER_LONG == 64
 577         unsigned long                   type;
 578 #elif __BITS_PER_LONG == 32
 579         struct {
 580                 unsigned long           pad;
 581                 unsigned long           type;
 582         };
 583 #else
 584 #error edit for your odd byteorder.
 585 #endif
 586
 587 #define x(f, n) struct bch_extent_##f   f;
 588         BCH_EXTENT_ENTRY_TYPES()
 589 #undef x
 590 };
 591
 592 struct bch_btree_ptr {
 593         struct bch_val          v;
 594
 595         struct bch_extent_ptr   start[0];
 596         __u64                   _data[0];
 597 } __attribute__((packed, aligned(8)));
 598
 599 struct bch_btree_ptr_v2 {
 600         struct bch_val          v;
 601
 602         __u64                   mem_ptr;
 603         __le64                  seq;
 604         __le16                  sectors_written;
 605         /* In case we ever decide to do variable size btree nodes: */
 606         __le16                  sectors;
 607         struct bpos             min_key;
 608         struct bch_extent_ptr   start[0];
 609         __u64                   _data[0];
 610 } __attribute__((packed, aligned(8)));
 611
 612 struct bch_extent {
 613         struct bch_val          v;
 614
 615         union bch_extent_entry  start[0];
 616         __u64                   _data[0];
 617 } __attribute__((packed, aligned(8)));
 618
 619 struct bch_reservation {
 620         struct bch_val          v;
 621
 622         __le32                  generation;
 623         __u8                    nr_replicas;
 624         __u8                    pad[3];
 625 } __attribute__((packed, aligned(8)));
 626
 627 /* Maximum size (in u64s) a single pointer could be: */
 628 #define BKEY_EXTENT_PTR_U64s_MAX\
 629         ((sizeof(struct bch_extent_crc128) +                    \
 630           sizeof(struct bch_extent_ptr)) / sizeof(u64))
 631
 632 /* Maximum possible size of an entire extent value: */
 633 #define BKEY_EXTENT_VAL_U64s_MAX                                \
 634         (1 + BKEY_EXTENT_PTR_U64s_MAX * (BCH_REPLICAS_MAX + 1))
 635
 636 #define BKEY_PADDED(key)        __BKEY_PADDED(key, BKEY_EXTENT_VAL_U64s_MAX)
 637
 638 /* * Maximum possible size of an entire extent, key + value: */
 639 #define BKEY_EXTENT_U64s_MAX            (BKEY_U64s + BKEY_EXTENT_VAL_U64s_MAX)
 640
 641 /* Btree pointers don't carry around checksums: */
 642 #define BKEY_BTREE_PTR_VAL_U64s_MAX                             \
 643         ((sizeof(struct bch_btree_ptr_v2) +                     \
 644           sizeof(struct bch_extent_ptr) * BCH_REPLICAS_MAX) / sizeof(u64))
 645 #define BKEY_BTREE_PTR_U64s_MAX                                 \
 646         (BKEY_U64s + BKEY_BTREE_PTR_VAL_U64s_MAX)
 647
 648 /* Inodes */
 649
 650 #define BLOCKDEV_INODE_MAX      4096
 651
 652 #define BCACHEFS_ROOT_INO       4096
 653
 654 struct bch_inode {
 655         struct bch_val          v;
 656
 657         __le64                  bi_hash_seed;
 658         __le32                  bi_flags;
 659         __le16                  bi_mode;
 660         __u8                    fields[0];
 661 } __attribute__((packed, aligned(8)));
 662
 663 struct bch_inode_generation {
 664         struct bch_val          v;
 665
 666         __le32                  bi_generation;
 667         __le32                  pad;
 668 } __attribute__((packed, aligned(8)));
 669
 670 #define BCH_INODE_FIELDS()                      \
 671         x(bi_atime,                     64)     \
 672         x(bi_ctime,                     64)     \
 673         x(bi_mtime,                     64)     \
 674         x(bi_otime,                     64)     \
 675         x(bi_size,                      64)     \
 676         x(bi_sectors,                   64)     \
 677         x(bi_uid,                       32)     \
 678         x(bi_gid,                       32)     \
 679         x(bi_nlink,                     32)     \
 680         x(bi_generation,                32)     \
 681         x(bi_dev,                       32)     \
 682         x(bi_data_checksum,             8)      \
 683         x(bi_compression,               8)      \
 684         x(bi_project,                   32)     \
 685         x(bi_background_compression,    8)      \
 686         x(bi_data_replicas,             8)      \
 687         x(bi_promote_target,            16)     \
 688         x(bi_foreground_target,         16)     \
 689         x(bi_background_target,         16)     \
 690         x(bi_erasure_code,              16)     \
 691         x(bi_fields_set,                16)
 692
 693 /* subset of BCH_INODE_FIELDS */
 694 #define BCH_INODE_OPTS()                        \
 695         x(data_checksum,                8)      \
 696         x(compression,                  8)      \
 697         x(project,                      32)     \
 698         x(background_compression,       8)      \
 699         x(data_replicas,                8)      \
 700         x(promote_target,               16)     \
 701         x(foreground_target,            16)     \
 702         x(background_target,            16)     \
 703         x(erasure_code,                 16)
 704
 705 enum inode_opt_id {
 706 #define x(name, ...)                            \
 707         Inode_opt_##name,
 708         BCH_INODE_OPTS()
 709 #undef  x
 710         Inode_opt_nr,
 711 };
 712
 713 enum {
 714         /*
 715          * User flags (get/settable with FS_IOC_*FLAGS, correspond to FS_*_FL
 716          * flags)
 717          */
 718         __BCH_INODE_SYNC        = 0,
 719         __BCH_INODE_IMMUTABLE   = 1,
 720         __BCH_INODE_APPEND      = 2,
 721         __BCH_INODE_NODUMP      = 3,
 722         __BCH_INODE_NOATIME     = 4,
 723
 724         __BCH_INODE_I_SIZE_DIRTY= 5,
 725         __BCH_INODE_I_SECTORS_DIRTY= 6,
 726         __BCH_INODE_UNLINKED    = 7,
 727
 728         /* bits 20+ reserved for packed fields below: */
 729 };
 730
 731 #define BCH_INODE_SYNC          (1 << __BCH_INODE_SYNC)
 732 #define BCH_INODE_IMMUTABLE     (1 << __BCH_INODE_IMMUTABLE)
 733 #define BCH_INODE_APPEND        (1 << __BCH_INODE_APPEND)
 734 #define BCH_INODE_NODUMP        (1 << __BCH_INODE_NODUMP)
 735 #define BCH_INODE_NOATIME       (1 << __BCH_INODE_NOATIME)
 736 #define BCH_INODE_I_SIZE_DIRTY  (1 << __BCH_INODE_I_SIZE_DIRTY)
 737 #define BCH_INODE_I_SECTORS_DIRTY (1 << __BCH_INODE_I_SECTORS_DIRTY)
 738 #define BCH_INODE_UNLINKED      (1 << __BCH_INODE_UNLINKED)
 739
 740 LE32_BITMASK(INODE_STR_HASH,    struct bch_inode, bi_flags, 20, 24);
 741 LE32_BITMASK(INODE_NR_FIELDS,   struct bch_inode, bi_flags, 24, 32);
 742
 743 /* Dirents */
 744
 745 /*
 746  * Dirents (and xattrs) have to implement string lookups; since our b-tree
 747  * doesn't support arbitrary length strings for the key, we instead index by a
 748  * 64 bit hash (currently truncated sha1) of the string, stored in the offset
 749  * field of the key - using linear probing to resolve hash collisions. This also
 750  * provides us with the readdir cookie posix requires.
 751  *
 752  * Linear probing requires us to use whiteouts for deletions, in the event of a
 753  * collision:
 754  */
 755
 756 struct bch_dirent {
 757         struct bch_val          v;
 758
 759         /* Target inode number: */
 760         __le64                  d_inum;
 761
 762         /*
 763          * Copy of mode bits 12-15 from the target inode - so userspace can get
 764          * the filetype without having to do a stat()
 765          */
 766         __u8                    d_type;
 767
 768         __u8                    d_name[];
 769 } __attribute__((packed, aligned(8)));
 770
 771 #define BCH_NAME_MAX    (U8_MAX * sizeof(u64) -                         \
 772                          sizeof(struct bkey) -                          \
 773                          offsetof(struct bch_dirent, d_name))
 774
 775
 776 /* Xattrs */
 777
 778 #define KEY_TYPE_XATTR_INDEX_USER                       0
 779 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS   1
 780 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT  2
 781 #define KEY_TYPE_XATTR_INDEX_TRUSTED                    3
 782 #define KEY_TYPE_XATTR_INDEX_SECURITY           4
 783
 784 struct bch_xattr {
 785         struct bch_val          v;
 786         __u8                    x_type;
 787         __u8                    x_name_len;
 788         __le16                  x_val_len;
 789         __u8                    x_name[];
 790 } __attribute__((packed, aligned(8)));
 791
 792 /* Bucket/allocation information: */
 793
 794 struct bch_alloc {
 795         struct bch_val          v;
 796         __u8                    fields;
 797         __u8                    gen;
 798         __u8                    data[];
 799 } __attribute__((packed, aligned(8)));
 800
 801 #define BCH_ALLOC_FIELDS()                      \
 802         x(read_time,            16)             \
 803         x(write_time,           16)             \
 804         x(data_type,            8)              \
 805         x(dirty_sectors,        16)             \
 806         x(cached_sectors,       16)             \
 807         x(oldest_gen,           8)
 808
 809 enum {
 810 #define x(name, bytes) BCH_ALLOC_FIELD_##name,
 811         BCH_ALLOC_FIELDS()
 812 #undef x
 813         BCH_ALLOC_FIELD_NR
 814 };
 815
 816 static const unsigned BCH_ALLOC_FIELD_BYTES[] = {
 817 #define x(name, bits) [BCH_ALLOC_FIELD_##name] = bits / 8,
 818         BCH_ALLOC_FIELDS()
 819 #undef x
 820 };
 821
 822 #define x(name, bits) + (bits / 8)
 823 static const unsigned BKEY_ALLOC_VAL_U64s_MAX =
 824         DIV_ROUND_UP(offsetof(struct bch_alloc, data)
 825                      BCH_ALLOC_FIELDS(), sizeof(u64));
 826 #undef x
 827
 828 #define BKEY_ALLOC_U64s_MAX     (BKEY_U64s + BKEY_ALLOC_VAL_U64s_MAX)
 829
 830 /* Quotas: */
 831
 832 enum quota_types {
 833         QTYP_USR                = 0,
 834         QTYP_GRP                = 1,
 835         QTYP_PRJ                = 2,
 836         QTYP_NR                 = 3,
 837 };
 838
 839 enum quota_counters {
 840         Q_SPC                   = 0,
 841         Q_INO                   = 1,
 842         Q_COUNTERS              = 2,
 843 };
 844
 845 struct bch_quota_counter {
 846         __le64                  hardlimit;
 847         __le64                  softlimit;
 848 };
 849
 850 struct bch_quota {
 851         struct bch_val          v;
 852         struct bch_quota_counter c[Q_COUNTERS];
 853 } __attribute__((packed, aligned(8)));
 854
 855 /* Erasure coding */
 856
 857 struct bch_stripe {
 858         struct bch_val          v;
 859         __le16                  sectors;
 860         __u8                    algorithm;
 861         __u8                    nr_blocks;
 862         __u8                    nr_redundant;
 863
 864         __u8                    csum_granularity_bits;
 865         __u8                    csum_type;
 866         __u8                    pad;
 867
 868         struct bch_extent_ptr   ptrs[0];
 869 } __attribute__((packed, aligned(8)));
 870
 871 /* Reflink: */
 872
 873 struct bch_reflink_p {
 874         struct bch_val          v;
 875         __le64                  idx;
 876
 877         __le32                  reservation_generation;
 878         __u8                    nr_replicas;
 879         __u8                    pad[3];
 880 };
 881
 882 struct bch_reflink_v {
 883         struct bch_val          v;
 884         __le64                  refcount;
 885         union bch_extent_entry  start[0];
 886         __u64                   _data[0];
 887 };
 888
 889 /* Inline data */
 890
 891 struct bch_inline_data {
 892         struct bch_val          v;
 893         u8                      data[0];
 894 };
 895
 896 /* Optional/variable size superblock sections: */
 897
 898 struct bch_sb_field {
 899         __u64                   _data[0];
 900         __le32                  u64s;
 901         __le32                  type;
 902 };
 903
 904 #define BCH_SB_FIELDS()         \
 905         x(journal,      0)      \
 906         x(members,      1)      \
 907         x(crypt,        2)      \
 908         x(replicas_v0,  3)      \
 909         x(quota,        4)      \
 910         x(disk_groups,  5)      \
 911         x(clean,        6)      \
 912         x(replicas,     7)      \
 913         x(journal_seq_blacklist, 8)
 914
 915 enum bch_sb_field_type {
 916 #define x(f, nr)        BCH_SB_FIELD_##f = nr,
 917         BCH_SB_FIELDS()
 918 #undef x
 919         BCH_SB_FIELD_NR
 920 };
 921
 922 /* BCH_SB_FIELD_journal: */
 923
 924 struct bch_sb_field_journal {
 925         struct bch_sb_field     field;
 926         __le64                  buckets[0];
 927 };
 928
 929 /* BCH_SB_FIELD_members: */
 930
 931 #define BCH_MIN_NR_NBUCKETS     (1 << 6)
 932
 933 struct bch_member {
 934         uuid_le                 uuid;
 935         __le64                  nbuckets;       /* device size */
 936         __le16                  first_bucket;   /* index of first bucket used */
 937         __le16                  bucket_size;    /* sectors */
 938         __le32                  pad;
 939         __le64                  last_mount;     /* time_t */
 940
 941         __le64                  flags[2];
 942 };
 943
 944 LE64_BITMASK(BCH_MEMBER_STATE,          struct bch_member, flags[0],  0,  4)
 945 /* 4-10 unused, was TIER, HAS_(META)DATA */
 946 LE64_BITMASK(BCH_MEMBER_REPLACEMENT,    struct bch_member, flags[0], 10, 14)
 947 LE64_BITMASK(BCH_MEMBER_DISCARD,        struct bch_member, flags[0], 14, 15)
 948 LE64_BITMASK(BCH_MEMBER_DATA_ALLOWED,   struct bch_member, flags[0], 15, 20)
 949 LE64_BITMASK(BCH_MEMBER_GROUP,          struct bch_member, flags[0], 20, 28)
 950 LE64_BITMASK(BCH_MEMBER_DURABILITY,     struct bch_member, flags[0], 28, 30)
 951
 952 #define BCH_TIER_MAX                    4U
 953
 954 #if 0
 955 LE64_BITMASK(BCH_MEMBER_NR_READ_ERRORS, struct bch_member, flags[1], 0,  20);
 956 LE64_BITMASK(BCH_MEMBER_NR_WRITE_ERRORS,struct bch_member, flags[1], 20, 40);
 957 #endif
 958
 959 enum bch_member_state {
 960         BCH_MEMBER_STATE_RW             = 0,
 961         BCH_MEMBER_STATE_RO             = 1,
 962         BCH_MEMBER_STATE_FAILED         = 2,
 963         BCH_MEMBER_STATE_SPARE          = 3,
 964         BCH_MEMBER_STATE_NR             = 4,
 965 };
 966
 967 enum cache_replacement {
 968         CACHE_REPLACEMENT_LRU           = 0,
 969         CACHE_REPLACEMENT_FIFO          = 1,
 970         CACHE_REPLACEMENT_RANDOM        = 2,
 971         CACHE_REPLACEMENT_NR            = 3,
 972 };
 973
 974 struct bch_sb_field_members {
 975         struct bch_sb_field     field;
 976         struct bch_member       members[0];
 977 };
 978
 979 /* BCH_SB_FIELD_crypt: */
 980
 981 struct nonce {
 982         __le32                  d[4];
 983 };
 984
 985 struct bch_key {
 986         __le64                  key[4];
 987 };
 988
 989 #define BCH_KEY_MAGIC                                   \
 990         (((u64) 'b' <<  0)|((u64) 'c' <<  8)|           \
 991          ((u64) 'h' << 16)|((u64) '*' << 24)|           \
 992          ((u64) '*' << 32)|((u64) 'k' << 40)|           \
 993          ((u64) 'e' << 48)|((u64) 'y' << 56))
 994
 995 struct bch_encrypted_key {
 996         __le64                  magic;
 997         struct bch_key          key;
 998 };
 999
1000 /*
1001  * If this field is present in the superblock, it stores an encryption key which
1002  * is used encrypt all other data/metadata. The key will normally be encrypted
1003  * with the key userspace provides, but if encryption has been turned off we'll
1004  * just store the master key unencrypted in the superblock so we can access the
1005  * previously encrypted data.
1006  */
1007 struct bch_sb_field_crypt {
1008         struct bch_sb_field     field;
1009
1010         __le64                  flags;
1011         __le64                  kdf_flags;
1012         struct bch_encrypted_key key;
1013 };
1014
1015 LE64_BITMASK(BCH_CRYPT_KDF_TYPE,        struct bch_sb_field_crypt, flags, 0, 4);
1016
1017 enum bch_kdf_types {
1018         BCH_KDF_SCRYPT          = 0,
1019         BCH_KDF_NR              = 1,
1020 };
1021
1022 /* stored as base 2 log of scrypt params: */
1023 LE64_BITMASK(BCH_KDF_SCRYPT_N,  struct bch_sb_field_crypt, kdf_flags,  0, 16);
1024 LE64_BITMASK(BCH_KDF_SCRYPT_R,  struct bch_sb_field_crypt, kdf_flags, 16, 32);
1025 LE64_BITMASK(BCH_KDF_SCRYPT_P,  struct bch_sb_field_crypt, kdf_flags, 32, 48);
1026
1027 /* BCH_SB_FIELD_replicas: */
1028
1029 enum bch_data_type {
1030         BCH_DATA_NONE           = 0,
1031         BCH_DATA_SB             = 1,
1032         BCH_DATA_JOURNAL        = 2,
1033         BCH_DATA_BTREE          = 3,
1034         BCH_DATA_USER           = 4,
1035         BCH_DATA_CACHED         = 5,
1036         BCH_DATA_NR             = 6,
1037 };
1038
1039 struct bch_replicas_entry_v0 {
1040         __u8                    data_type;
1041         __u8                    nr_devs;
1042         __u8                    devs[0];
1043 } __attribute__((packed));
1044
1045 struct bch_sb_field_replicas_v0 {
1046         struct bch_sb_field     field;
1047         struct bch_replicas_entry_v0 entries[0];
1048 } __attribute__((packed, aligned(8)));
1049
1050 struct bch_replicas_entry {
1051         __u8                    data_type;
1052         __u8                    nr_devs;
1053         __u8                    nr_required;
1054         __u8                    devs[0];
1055 } __attribute__((packed));
1056
1057 #define replicas_entry_bytes(_i)                                        \
1058         (offsetof(typeof(*(_i)), devs) + (_i)->nr_devs)
1059
1060 struct bch_sb_field_replicas {
1061         struct bch_sb_field     field;
1062         struct bch_replicas_entry entries[0];
1063 } __attribute__((packed, aligned(8)));
1064
1065 /* BCH_SB_FIELD_quota: */
1066
1067 struct bch_sb_quota_counter {
1068         __le32                          timelimit;
1069         __le32                          warnlimit;
1070 };
1071
1072 struct bch_sb_quota_type {
1073         __le64                          flags;
1074         struct bch_sb_quota_counter     c[Q_COUNTERS];
1075 };
1076
1077 struct bch_sb_field_quota {
1078         struct bch_sb_field             field;
1079         struct bch_sb_quota_type        q[QTYP_NR];
1080 } __attribute__((packed, aligned(8)));
1081
1082 /* BCH_SB_FIELD_disk_groups: */
1083
1084 #define BCH_SB_LABEL_SIZE               32
1085
1086 struct bch_disk_group {
1087         __u8                    label[BCH_SB_LABEL_SIZE];
1088         __le64                  flags[2];
1089 } __attribute__((packed, aligned(8)));
1090
1091 LE64_BITMASK(BCH_GROUP_DELETED,         struct bch_disk_group, flags[0], 0,  1)
1092 LE64_BITMASK(BCH_GROUP_DATA_ALLOWED,    struct bch_disk_group, flags[0], 1,  6)
1093 LE64_BITMASK(BCH_GROUP_PARENT,          struct bch_disk_group, flags[0], 6, 24)
1094
1095 struct bch_sb_field_disk_groups {
1096         struct bch_sb_field     field;
1097         struct bch_disk_group   entries[0];
1098 } __attribute__((packed, aligned(8)));
1099
1100 /*
1101  * On clean shutdown, store btree roots and current journal sequence number in
1102  * the superblock:
1103  */
1104 struct jset_entry {
1105         __le16                  u64s;
1106         __u8                    btree_id;
1107         __u8                    level;
1108         __u8                    type; /* designates what this jset holds */
1109         __u8                    pad[3];
1110
1111         union {
1112                 struct bkey_i   start[0];
1113                 __u64           _data[0];
1114         };
1115 };
1116
1117 struct bch_sb_field_clean {
1118         struct bch_sb_field     field;
1119
1120         __le32                  flags;
1121         __le16                  read_clock;
1122         __le16                  write_clock;
1123         __le64                  journal_seq;
1124
1125         union {
1126                 struct jset_entry start[0];
1127                 __u64           _data[0];
1128         };
1129 };
1130
1131 struct journal_seq_blacklist_entry {
1132         __le64                  start;
1133         __le64                  end;
1134 };
1135
1136 struct bch_sb_field_journal_seq_blacklist {
1137         struct bch_sb_field     field;
1138
1139         union {
1140                 struct journal_seq_blacklist_entry start[0];
1141                 __u64           _data[0];
1142         };
1143 };
1144
1145 /* Superblock: */
1146
1147 /*
1148  * New versioning scheme:
1149  * One common version number for all on disk data structures - superblock, btree
1150  * nodes, journal entries
1151  */
1152 #define BCH_JSET_VERSION_OLD                    2
1153 #define BCH_BSET_VERSION_OLD                    3
1154
1155 enum bcachefs_metadata_version {
1156         bcachefs_metadata_version_min                   = 9,
1157         bcachefs_metadata_version_new_versioning        = 10,
1158         bcachefs_metadata_version_bkey_renumber         = 10,
1159         bcachefs_metadata_version_inode_btree_change    = 11,
1160         bcachefs_metadata_version_max                   = 12,
1161 };
1162
1163 #define bcachefs_metadata_version_current       (bcachefs_metadata_version_max - 1)
1164
1165 #define BCH_SB_SECTOR                   8
1166 #define BCH_SB_MEMBERS_MAX              64 /* XXX kill */
1167
1168 struct bch_sb_layout {
1169         uuid_le                 magic;  /* bcachefs superblock UUID */
1170         __u8                    layout_type;
1171         __u8                    sb_max_size_bits; /* base 2 of 512 byte sectors */
1172         __u8                    nr_superblocks;
1173         __u8                    pad[5];
1174         __le64                  sb_offset[61];
1175 } __attribute__((packed, aligned(8)));
1176
1177 #define BCH_SB_LAYOUT_SECTOR    7
1178
1179 /*
1180  * @offset      - sector where this sb was written
1181  * @version     - on disk format version
1182  * @version_min - Oldest metadata version this filesystem contains; so we can
1183  *                safely drop compatibility code and refuse to mount filesystems
1184  *                we'd need it for
1185  * @magic       - identifies as a bcachefs superblock (BCACHE_MAGIC)
1186  * @seq         - incremented each time superblock is written
1187  * @uuid        - used for generating various magic numbers and identifying
1188  *                member devices, never changes
1189  * @user_uuid   - user visible UUID, may be changed
1190  * @label       - filesystem label
1191  * @seq         - identifies most recent superblock, incremented each time
1192  *                superblock is written
1193  * @features    - enabled incompatible features
1194  */
1195 struct bch_sb {
1196         struct bch_csum         csum;
1197         __le16                  version;
1198         __le16                  version_min;
1199         __le16                  pad[2];
1200         uuid_le                 magic;
1201         uuid_le                 uuid;
1202         uuid_le                 user_uuid;
1203         __u8                    label[BCH_SB_LABEL_SIZE];
1204         __le64                  offset;
1205         __le64                  seq;
1206
1207         __le16                  block_size;
1208         __u8                    dev_idx;
1209         __u8                    nr_devices;
1210         __le32                  u64s;
1211
1212         __le64                  time_base_lo;
1213         __le32                  time_base_hi;
1214         __le32                  time_precision;
1215
1216         __le64                  flags[8];
1217         __le64                  features[2];
1218         __le64                  compat[2];
1219
1220         struct bch_sb_layout    layout;
1221
1222         union {
1223                 struct bch_sb_field start[0];
1224                 __le64          _data[0];
1225         };
1226 } __attribute__((packed, aligned(8)));
1227
1228 /*
1229  * Flags:
1230  * BCH_SB_INITALIZED    - set on first mount
1231  * BCH_SB_CLEAN         - did we shut down cleanly? Just a hint, doesn't affect
1232  *                        behaviour of mount/recovery path:
1233  * BCH_SB_INODE_32BIT   - limit inode numbers to 32 bits
1234  * BCH_SB_128_BIT_MACS  - 128 bit macs instead of 80
1235  * BCH_SB_ENCRYPTION_TYPE - if nonzero encryption is enabled; overrides
1236  *                         DATA/META_CSUM_TYPE. Also indicates encryption
1237  *                         algorithm in use, if/when we get more than one
1238  */
1239
1240 LE16_BITMASK(BCH_SB_BLOCK_SIZE,         struct bch_sb, block_size, 0, 16);
1241
1242 LE64_BITMASK(BCH_SB_INITIALIZED,        struct bch_sb, flags[0],  0,  1);
1243 LE64_BITMASK(BCH_SB_CLEAN,              struct bch_sb, flags[0],  1,  2);
1244 LE64_BITMASK(BCH_SB_CSUM_TYPE,          struct bch_sb, flags[0],  2,  8);
1245 LE64_BITMASK(BCH_SB_ERROR_ACTION,       struct bch_sb, flags[0],  8, 12);
1246
1247 LE64_BITMASK(BCH_SB_BTREE_NODE_SIZE,    struct bch_sb, flags[0], 12, 28);
1248
1249 LE64_BITMASK(BCH_SB_GC_RESERVE,         struct bch_sb, flags[0], 28, 33);
1250 LE64_BITMASK(BCH_SB_ROOT_RESERVE,       struct bch_sb, flags[0], 33, 40);
1251
1252 LE64_BITMASK(BCH_SB_META_CSUM_TYPE,     struct bch_sb, flags[0], 40, 44);
1253 LE64_BITMASK(BCH_SB_DATA_CSUM_TYPE,     struct bch_sb, flags[0], 44, 48);
1254
1255 LE64_BITMASK(BCH_SB_META_REPLICAS_WANT, struct bch_sb, flags[0], 48, 52);
1256 LE64_BITMASK(BCH_SB_DATA_REPLICAS_WANT, struct bch_sb, flags[0], 52, 56);
1257
1258 LE64_BITMASK(BCH_SB_POSIX_ACL,          struct bch_sb, flags[0], 56, 57);
1259 LE64_BITMASK(BCH_SB_USRQUOTA,           struct bch_sb, flags[0], 57, 58);
1260 LE64_BITMASK(BCH_SB_GRPQUOTA,           struct bch_sb, flags[0], 58, 59);
1261 LE64_BITMASK(BCH_SB_PRJQUOTA,           struct bch_sb, flags[0], 59, 60);
1262
1263 LE64_BITMASK(BCH_SB_HAS_ERRORS,         struct bch_sb, flags[0], 60, 61);
1264
1265 LE64_BITMASK(BCH_SB_REFLINK,            struct bch_sb, flags[0], 61, 62);
1266
1267 /* 61-64 unused */
1268
1269 LE64_BITMASK(BCH_SB_STR_HASH_TYPE,      struct bch_sb, flags[1],  0,  4);
1270 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE,   struct bch_sb, flags[1],  4,  8);
1271 LE64_BITMASK(BCH_SB_INODE_32BIT,        struct bch_sb, flags[1],  8,  9);
1272
1273 LE64_BITMASK(BCH_SB_128_BIT_MACS,       struct bch_sb, flags[1],  9, 10);
1274 LE64_BITMASK(BCH_SB_ENCRYPTION_TYPE,    struct bch_sb, flags[1], 10, 14);
1275
1276 /*
1277  * Max size of an extent that may require bouncing to read or write
1278  * (checksummed, compressed): 64k
1279  */
1280 LE64_BITMASK(BCH_SB_ENCODED_EXTENT_MAX_BITS,
1281                                         struct bch_sb, flags[1], 14, 20);
1282
1283 LE64_BITMASK(BCH_SB_META_REPLICAS_REQ,  struct bch_sb, flags[1], 20, 24);
1284 LE64_BITMASK(BCH_SB_DATA_REPLICAS_REQ,  struct bch_sb, flags[1], 24, 28);
1285
1286 LE64_BITMASK(BCH_SB_PROMOTE_TARGET,     struct bch_sb, flags[1], 28, 40);
1287 LE64_BITMASK(BCH_SB_FOREGROUND_TARGET,  struct bch_sb, flags[1], 40, 52);
1288 LE64_BITMASK(BCH_SB_BACKGROUND_TARGET,  struct bch_sb, flags[1], 52, 64);
1289
1290 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE,
1291                                         struct bch_sb, flags[2],  0,  4);
1292 LE64_BITMASK(BCH_SB_GC_RESERVE_BYTES,   struct bch_sb, flags[2],  4, 64);
1293
1294 LE64_BITMASK(BCH_SB_ERASURE_CODE,       struct bch_sb, flags[3],  0, 16);
1295
1296 /*
1297  * Features:
1298  *
1299  * journal_seq_blacklist_v3:    gates BCH_SB_FIELD_journal_seq_blacklist
1300  * reflink:                     gates KEY_TYPE_reflink
1301  * inline_data:                 gates KEY_TYPE_inline_data
1302  * new_siphash:                 gates BCH_STR_HASH_SIPHASH
1303  * new_extent_overwrite:        gates BTREE_NODE_NEW_EXTENT_OVERWRITE
1304  */
1305 #define BCH_SB_FEATURES()                       \
1306         x(lz4,                          0)      \
1307         x(gzip,                         1)      \
1308         x(zstd,                         2)      \
1309         x(atomic_nlink,                 3)      \
1310         x(ec,                           4)      \
1311         x(journal_seq_blacklist_v3,     5)      \
1312         x(reflink,                      6)      \
1313         x(new_siphash,                  7)      \
1314         x(inline_data,                  8)      \
1315         x(new_extent_overwrite,         9)      \
1316         x(incompressible,               10)     \
1317         x(btree_ptr_v2,                 11)     \
1318         x(extents_above_btree_updates,  12)     \
1319         x(btree_updates_journalled,     13)
1320
1321 #define BCH_SB_FEATURES_ALL                             \
1322         ((1ULL << BCH_FEATURE_new_siphash)|             \
1323          (1ULL << BCH_FEATURE_new_extent_overwrite)|    \
1324          (1ULL << BCH_FEATURE_btree_ptr_v2)|            \
1325          (1ULL << BCH_FEATURE_extents_above_btree_updates))
1326
1327 enum bch_sb_feature {
1328 #define x(f, n) BCH_FEATURE_##f,
1329         BCH_SB_FEATURES()
1330 #undef x
1331         BCH_FEATURE_NR,
1332 };
1333
1334 enum bch_sb_compat {
1335         BCH_COMPAT_FEAT_ALLOC_INFO      = 0,
1336         BCH_COMPAT_FEAT_ALLOC_METADATA  = 1,
1337 };
1338
1339 /* options: */
1340
1341 #define BCH_REPLICAS_MAX                4U
1342
1343 enum bch_error_actions {
1344         BCH_ON_ERROR_CONTINUE           = 0,
1345         BCH_ON_ERROR_RO                 = 1,
1346         BCH_ON_ERROR_PANIC              = 2,
1347         BCH_NR_ERROR_ACTIONS            = 3,
1348 };
1349
1350 enum bch_str_hash_type {
1351         BCH_STR_HASH_CRC32C             = 0,
1352         BCH_STR_HASH_CRC64              = 1,
1353         BCH_STR_HASH_SIPHASH_OLD        = 2,
1354         BCH_STR_HASH_SIPHASH            = 3,
1355         BCH_STR_HASH_NR                 = 4,
1356 };
1357
1358 enum bch_str_hash_opts {
1359         BCH_STR_HASH_OPT_CRC32C         = 0,
1360         BCH_STR_HASH_OPT_CRC64          = 1,
1361         BCH_STR_HASH_OPT_SIPHASH        = 2,
1362         BCH_STR_HASH_OPT_NR             = 3,
1363 };
1364
1365 enum bch_csum_type {
1366         BCH_CSUM_NONE                   = 0,
1367         BCH_CSUM_CRC32C_NONZERO         = 1,
1368         BCH_CSUM_CRC64_NONZERO          = 2,
1369         BCH_CSUM_CHACHA20_POLY1305_80   = 3,
1370         BCH_CSUM_CHACHA20_POLY1305_128  = 4,
1371         BCH_CSUM_CRC32C                 = 5,
1372         BCH_CSUM_CRC64                  = 6,
1373         BCH_CSUM_NR                     = 7,
1374 };
1375
1376 static const unsigned bch_crc_bytes[] = {
1377         [BCH_CSUM_NONE]                         = 0,
1378         [BCH_CSUM_CRC32C_NONZERO]               = 4,
1379         [BCH_CSUM_CRC32C]                       = 4,
1380         [BCH_CSUM_CRC64_NONZERO]                = 8,
1381         [BCH_CSUM_CRC64]                        = 8,
1382         [BCH_CSUM_CHACHA20_POLY1305_80]         = 10,
1383         [BCH_CSUM_CHACHA20_POLY1305_128]        = 16,
1384 };
1385
1386 static inline _Bool bch2_csum_type_is_encryption(enum bch_csum_type type)
1387 {
1388         switch (type) {
1389         case BCH_CSUM_CHACHA20_POLY1305_80:
1390         case BCH_CSUM_CHACHA20_POLY1305_128:
1391                 return true;
1392         default:
1393                 return false;
1394         }
1395 }
1396
1397 enum bch_csum_opts {
1398         BCH_CSUM_OPT_NONE               = 0,
1399         BCH_CSUM_OPT_CRC32C             = 1,
1400         BCH_CSUM_OPT_CRC64              = 2,
1401         BCH_CSUM_OPT_NR                 = 3,
1402 };
1403
1404 #define BCH_COMPRESSION_TYPES()         \
1405         x(none,                 0)      \
1406         x(lz4_old,              1)      \
1407         x(gzip,                 2)      \
1408         x(lz4,                  3)      \
1409         x(zstd,                 4)      \
1410         x(incompressible,       5)
1411
1412 enum bch_compression_type {
1413 #define x(t, n) BCH_COMPRESSION_TYPE_##t,
1414         BCH_COMPRESSION_TYPES()
1415 #undef x
1416         BCH_COMPRESSION_TYPE_NR
1417 };
1418
1419 #define BCH_COMPRESSION_OPTS()          \
1420         x(none,         0)              \
1421         x(lz4,          1)              \
1422         x(gzip,         2)              \
1423         x(zstd,         3)
1424
1425 enum bch_compression_opts {
1426 #define x(t, n) BCH_COMPRESSION_OPT_##t,
1427         BCH_COMPRESSION_OPTS()
1428 #undef x
1429         BCH_COMPRESSION_OPT_NR
1430 };
1431
1432 /*
1433  * Magic numbers
1434  *
1435  * The various other data structures have their own magic numbers, which are
1436  * xored with the first part of the cache set's UUID
1437  */
1438
1439 #define BCACHE_MAGIC                                                    \
1440         UUID_LE(0xf67385c6, 0x1a4e, 0xca45,                             \
1441                 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81)
1442
1443 #define BCACHEFS_STATFS_MAGIC           0xca451a4e
1444
1445 #define JSET_MAGIC              __cpu_to_le64(0x245235c1a3625032ULL)
1446 #define BSET_MAGIC              __cpu_to_le64(0x90135c78b99e07f5ULL)
1447
1448 static inline __le64 __bch2_sb_magic(struct bch_sb *sb)
1449 {
1450         __le64 ret;
1451         memcpy(&ret, &sb->uuid, sizeof(ret));
1452         return ret;
1453 }
1454
1455 static inline __u64 __jset_magic(struct bch_sb *sb)
1456 {
1457         return __le64_to_cpu(__bch2_sb_magic(sb) ^ JSET_MAGIC);
1458 }
1459
1460 static inline __u64 __bset_magic(struct bch_sb *sb)
1461 {
1462         return __le64_to_cpu(__bch2_sb_magic(sb) ^ BSET_MAGIC);
1463 }
1464
1465 /* Journal */
1466
1467 #define JSET_KEYS_U64s  (sizeof(struct jset_entry) / sizeof(__u64))
1468
1469 #define BCH_JSET_ENTRY_TYPES()                  \
1470         x(btree_keys,           0)              \
1471         x(btree_root,           1)              \
1472         x(prio_ptrs,            2)              \
1473         x(blacklist,            3)              \
1474         x(blacklist_v2,         4)              \
1475         x(usage,                5)              \
1476         x(data_usage,           6)
1477
1478 enum {
1479 #define x(f, nr)        BCH_JSET_ENTRY_##f      = nr,
1480         BCH_JSET_ENTRY_TYPES()
1481 #undef x
1482         BCH_JSET_ENTRY_NR
1483 };
1484
1485 /*
1486  * Journal sequence numbers can be blacklisted: bsets record the max sequence
1487  * number of all the journal entries they contain updates for, so that on
1488  * recovery we can ignore those bsets that contain index updates newer that what
1489  * made it into the journal.
1490  *
1491  * This means that we can't reuse that journal_seq - we have to skip it, and
1492  * then record that we skipped it so that the next time we crash and recover we
1493  * don't think there was a missing journal entry.
1494  */
1495 struct jset_entry_blacklist {
1496         struct jset_entry       entry;
1497         __le64                  seq;
1498 };
1499
1500 struct jset_entry_blacklist_v2 {
1501         struct jset_entry       entry;
1502         __le64                  start;
1503         __le64                  end;
1504 };
1505
1506 enum {
1507         FS_USAGE_RESERVED               = 0,
1508         FS_USAGE_INODES                 = 1,
1509         FS_USAGE_KEY_VERSION            = 2,
1510         FS_USAGE_NR                     = 3
1511 };
1512
1513 struct jset_entry_usage {
1514         struct jset_entry       entry;
1515         __le64                  v;
1516 } __attribute__((packed));
1517
1518 struct jset_entry_data_usage {
1519         struct jset_entry       entry;
1520         __le64                  v;
1521         struct bch_replicas_entry r;
1522 } __attribute__((packed));
1523
1524 /*
1525  * On disk format for a journal entry:
1526  * seq is monotonically increasing; every journal entry has its own unique
1527  * sequence number.
1528  *
1529  * last_seq is the oldest journal entry that still has keys the btree hasn't
1530  * flushed to disk yet.
1531  *
1532  * version is for on disk format changes.
1533  */
1534 struct jset {
1535         struct bch_csum         csum;
1536
1537         __le64                  magic;
1538         __le64                  seq;
1539         __le32                  version;
1540         __le32                  flags;
1541
1542         __le32                  u64s; /* size of d[] in u64s */
1543
1544         __u8                    encrypted_start[0];
1545
1546         __le16                  read_clock;
1547         __le16                  write_clock;
1548
1549         /* Sequence number of oldest dirty journal entry */
1550         __le64                  last_seq;
1551
1552
1553         union {
1554                 struct jset_entry start[0];
1555                 __u64           _data[0];
1556         };
1557 } __attribute__((packed, aligned(8)));
1558
1559 LE32_BITMASK(JSET_CSUM_TYPE,    struct jset, flags, 0, 4);
1560 LE32_BITMASK(JSET_BIG_ENDIAN,   struct jset, flags, 4, 5);
1561
1562 #define BCH_JOURNAL_BUCKETS_MIN         8
1563
1564 /* Btree: */
1565
1566 #define BCH_BTREE_IDS()                                 \
1567         x(EXTENTS,      0, "extents")                   \
1568         x(INODES,       1, "inodes")                    \
1569         x(DIRENTS,      2, "dirents")                   \
1570         x(XATTRS,       3, "xattrs")                    \
1571         x(ALLOC,        4, "alloc")                     \
1572         x(QUOTAS,       5, "quotas")                    \
1573         x(EC,           6, "stripes")                   \
1574         x(REFLINK,      7, "reflink")
1575
1576 enum btree_id {
1577 #define x(kwd, val, name) BTREE_ID_##kwd = val,
1578         BCH_BTREE_IDS()
1579 #undef x
1580         BTREE_ID_NR
1581 };
1582
1583 #define BTREE_MAX_DEPTH         4U
1584
1585 /* Btree nodes */
1586
1587 /*
1588  * Btree nodes
1589  *
1590  * On disk a btree node is a list/log of these; within each set the keys are
1591  * sorted
1592  */
1593 struct bset {
1594         __le64                  seq;
1595
1596         /*
1597          * Highest journal entry this bset contains keys for.
1598          * If on recovery we don't see that journal entry, this bset is ignored:
1599          * this allows us to preserve the order of all index updates after a
1600          * crash, since the journal records a total order of all index updates
1601          * and anything that didn't make it to the journal doesn't get used.
1602          */
1603         __le64                  journal_seq;
1604
1605         __le32                  flags;
1606         __le16                  version;
1607         __le16                  u64s; /* count of d[] in u64s */
1608
1609         union {
1610                 struct bkey_packed start[0];
1611                 __u64           _data[0];
1612         };
1613 } __attribute__((packed, aligned(8)));
1614
1615 LE32_BITMASK(BSET_CSUM_TYPE,    struct bset, flags, 0, 4);
1616
1617 LE32_BITMASK(BSET_BIG_ENDIAN,   struct bset, flags, 4, 5);
1618 LE32_BITMASK(BSET_SEPARATE_WHITEOUTS,
1619                                 struct bset, flags, 5, 6);
1620
1621 struct btree_node {
1622         struct bch_csum         csum;
1623         __le64                  magic;
1624
1625         /* this flags field is encrypted, unlike bset->flags: */
1626         __le64                  flags;
1627
1628         /* Closed interval: */
1629         struct bpos             min_key;
1630         struct bpos             max_key;
1631         struct bch_extent_ptr   ptr;
1632         struct bkey_format      format;
1633
1634         union {
1635         struct bset             keys;
1636         struct {
1637                 __u8            pad[22];
1638                 __le16          u64s;
1639                 __u64           _data[0];
1640
1641         };
1642         };
1643 } __attribute__((packed, aligned(8)));
1644
1645 LE64_BITMASK(BTREE_NODE_ID,     struct btree_node, flags,  0,  4);
1646 LE64_BITMASK(BTREE_NODE_LEVEL,  struct btree_node, flags,  4,  8);
1647 LE64_BITMASK(BTREE_NODE_NEW_EXTENT_OVERWRITE,
1648                                 struct btree_node, flags,  8,  9);
1649 /* 9-32 unused */
1650 LE64_BITMASK(BTREE_NODE_SEQ,    struct btree_node, flags, 32, 64);
1651
1652 struct btree_node_entry {
1653         struct bch_csum         csum;
1654
1655         union {
1656         struct bset             keys;
1657         struct {
1658                 __u8            pad[22];
1659                 __le16          u64s;
1660                 __u64           _data[0];
1661
1662         };
1663         };
1664 } __attribute__((packed, aligned(8)));
1665
1666 #endif /* _BCACHEFS_FORMAT_H */