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

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