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