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