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

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