1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_FORMAT_H
3 #define _BCACHEFS_FORMAT_H
6 * bcachefs on disk data structures
10 * There are three main types of on disk data structures in bcachefs (this is
11 * reduced from 5 in bcache)
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.
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
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.
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.
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.
42 * The journal also contains entry types for the btree roots, and blacklisted
43 * journal sequence numbers (see journal_seq_blacklist.c).
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
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
58 * BTREE KEYS (struct bkey):
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.
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).
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.
75 #include <asm/types.h>
76 #include <asm/byteorder.h>
77 #include <linux/kernel.h>
78 #include <linux/uuid.h>
81 #define BITMASK(name, type, field, offset, end) \
82 static const unsigned name##_OFFSET = offset; \
83 static const unsigned name##_BITS = (end - offset); \
85 static inline __u64 name(const type *k) \
87 return (k->field >> offset) & ~(~0ULL << (end - offset)); \
90 static inline void SET_##name(type *k, __u64 v) \
92 k->field &= ~(~(~0ULL << (end - offset)) << offset); \
93 k->field |= (v & ~(~0ULL << (end - offset))) << offset; \
96 #define LE_BITMASK(_bits, name, type, field, offset, end) \
97 static const unsigned name##_OFFSET = offset; \
98 static const unsigned name##_BITS = (end - offset); \
99 static const __u##_bits name##_MAX = (1ULL << (end - offset)) - 1; \
101 static inline __u64 name(const type *k) \
103 return (__le##_bits##_to_cpu(k->field) >> offset) & \
104 ~(~0ULL << (end - offset)); \
107 static inline void SET_##name(type *k, __u64 v) \
109 __u##_bits new = __le##_bits##_to_cpu(k->field); \
111 new &= ~(~(~0ULL << (end - offset)) << offset); \
112 new |= (v & ~(~0ULL << (end - offset))) << offset; \
113 k->field = __cpu_to_le##_bits(new); \
116 #define LE16_BITMASK(n, t, f, o, e) LE_BITMASK(16, n, t, f, o, e)
117 #define LE32_BITMASK(n, t, f, o, e) LE_BITMASK(32, n, t, f, o, e)
118 #define LE64_BITMASK(n, t, f, o, e) LE_BITMASK(64, n, t, f, o, e)
123 /* One unused slot for now: */
124 __u8 bits_per_field[6];
125 __le64 field_offset[6];
128 /* Btree keys - all units are in sectors */
132 * Word order matches machine byte order - btree code treats a bpos as a
133 * single large integer, for search/comparison purposes
135 * Note that wherever a bpos is embedded in another on disk data
136 * structure, it has to be byte swabbed when reading in metadata that
137 * wasn't written in native endian order:
139 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
143 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
145 __u64 offset; /* Points to end of extent - sectors */
148 #error edit for your odd byteorder.
150 } __packed __aligned(4);
152 #define KEY_INODE_MAX ((__u64)~0ULL)
153 #define KEY_OFFSET_MAX ((__u64)~0ULL)
154 #define KEY_SNAPSHOT_MAX ((__u32)~0U)
155 #define KEY_SIZE_MAX ((__u32)~0U)
157 static inline struct bpos SPOS(__u64 inode, __u64 offset, __u32 snapshot)
159 return (struct bpos) {
162 .snapshot = snapshot,
166 #define POS_MIN SPOS(0, 0, 0)
167 #define POS_MAX SPOS(KEY_INODE_MAX, KEY_OFFSET_MAX, 0)
168 #define SPOS_MAX SPOS(KEY_INODE_MAX, KEY_OFFSET_MAX, KEY_SNAPSHOT_MAX)
169 #define POS(_inode, _offset) SPOS(_inode, _offset, 0)
171 /* Empty placeholder struct, for container_of() */
177 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
180 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
184 } __packed __aligned(4);
187 /* Size of combined key and value, in u64s */
190 /* Format of key (0 for format local to btree node) */
191 #if defined(__LITTLE_ENDIAN_BITFIELD)
194 #elif defined (__BIG_ENDIAN_BITFIELD)
195 __u8 needs_whiteout:1,
198 #error edit for your odd byteorder.
201 /* Type of the value */
204 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
207 struct bversion version;
208 __u32 size; /* extent size, in sectors */
210 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
212 __u32 size; /* extent size, in sectors */
213 struct bversion version;
217 } __packed __aligned(8);
222 /* Size of combined key and value, in u64s */
225 /* Format of key (0 for format local to btree node) */
228 * XXX: next incompat on disk format change, switch format and
229 * needs_whiteout - bkey_packed() will be cheaper if format is the high
230 * bits of the bitfield
232 #if defined(__LITTLE_ENDIAN_BITFIELD)
235 #elif defined (__BIG_ENDIAN_BITFIELD)
236 __u8 needs_whiteout:1,
240 /* Type of the value */
245 * We copy bkeys with struct assignment in various places, and while
246 * that shouldn't be done with packed bkeys we can't disallow it in C,
247 * and it's legal to cast a bkey to a bkey_packed - so padding it out
248 * to the same size as struct bkey should hopefully be safest.
250 __u8 pad[sizeof(struct bkey) - 3];
251 } __packed __aligned(8);
253 #define BKEY_U64s (sizeof(struct bkey) / sizeof(__u64))
254 #define BKEY_U64s_MAX U8_MAX
255 #define BKEY_VAL_U64s_MAX (BKEY_U64s_MAX - BKEY_U64s)
257 #define KEY_PACKED_BITS_START 24
259 #define KEY_FORMAT_LOCAL_BTREE 0
260 #define KEY_FORMAT_CURRENT 1
262 enum bch_bkey_fields {
267 BKEY_FIELD_VERSION_HI,
268 BKEY_FIELD_VERSION_LO,
272 #define bkey_format_field(name, field) \
273 [BKEY_FIELD_##name] = (sizeof(((struct bkey *) NULL)->field) * 8)
275 #define BKEY_FORMAT_CURRENT \
276 ((struct bkey_format) { \
277 .key_u64s = BKEY_U64s, \
278 .nr_fields = BKEY_NR_FIELDS, \
279 .bits_per_field = { \
280 bkey_format_field(INODE, p.inode), \
281 bkey_format_field(OFFSET, p.offset), \
282 bkey_format_field(SNAPSHOT, p.snapshot), \
283 bkey_format_field(SIZE, size), \
284 bkey_format_field(VERSION_HI, version.hi), \
285 bkey_format_field(VERSION_LO, version.lo), \
289 /* bkey with inline value */
295 /* Size of combined key and value, in u64s */
305 #define KEY(_inode, _offset, _size) \
308 .format = KEY_FORMAT_CURRENT, \
309 .p = POS(_inode, _offset), \
313 static inline void bkey_init(struct bkey *k)
318 #define bkey_bytes(_k) ((_k)->u64s * sizeof(__u64))
320 #define __BKEY_PADDED(key, pad) \
321 struct { struct bkey_i key; __u64 key ## _pad[pad]; }
324 * - DELETED keys are used internally to mark keys that should be ignored but
325 * override keys in composition order. Their version number is ignored.
327 * - DISCARDED keys indicate that the data is all 0s because it has been
328 * discarded. DISCARDs may have a version; if the version is nonzero the key
329 * will be persistent, otherwise the key will be dropped whenever the btree
330 * node is rewritten (like DELETED keys).
332 * - ERROR: any read of the data returns a read error, as the data was lost due
333 * to a failing device. Like DISCARDED keys, they can be removed (overridden)
334 * by new writes or cluster-wide GC. Node repair can also overwrite them with
335 * the same or a more recent version number, but not with an older version
338 * - WHITEOUT: for hash table btrees
340 #define BCH_BKEY_TYPES() \
345 x(hash_whiteout, 4) \
350 x(inode_generation, 9) \
359 x(btree_ptr_v2, 18) \
360 x(indirect_inline_data, 19) \
374 #define x(name, nr) KEY_TYPE_##name = nr,
384 struct bch_whiteout {
397 struct bch_hash_whiteout {
408 * In extent bkeys, the value is a list of pointers (bch_extent_ptr), optionally
409 * preceded by checksum/compression information (bch_extent_crc32 or
412 * One major determining factor in the format of extents is how we handle and
413 * represent extents that have been partially overwritten and thus trimmed:
415 * If an extent is not checksummed or compressed, when the extent is trimmed we
416 * don't have to remember the extent we originally allocated and wrote: we can
417 * merely adjust ptr->offset to point to the start of the data that is currently
418 * live. The size field in struct bkey records the current (live) size of the
419 * extent, and is also used to mean "size of region on disk that we point to" in
422 * Thus an extent that is not checksummed or compressed will consist only of a
423 * list of bch_extent_ptrs, with none of the fields in
424 * bch_extent_crc32/bch_extent_crc64.
426 * When an extent is checksummed or compressed, it's not possible to read only
427 * the data that is currently live: we have to read the entire extent that was
428 * originally written, and then return only the part of the extent that is
431 * Thus, in addition to the current size of the extent in struct bkey, we need
432 * to store the size of the originally allocated space - this is the
433 * compressed_size and uncompressed_size fields in bch_extent_crc32/64. Also,
434 * when the extent is trimmed, instead of modifying the offset field of the
435 * pointer, we keep a second smaller offset field - "offset into the original
436 * extent of the currently live region".
438 * The other major determining factor is replication and data migration:
440 * Each pointer may have its own bch_extent_crc32/64. When doing a replicated
441 * write, we will initially write all the replicas in the same format, with the
442 * same checksum type and compression format - however, when copygc runs later (or
443 * tiering/cache promotion, anything that moves data), it is not in general
444 * going to rewrite all the pointers at once - one of the replicas may be in a
445 * bucket on one device that has very little fragmentation while another lives
446 * in a bucket that has become heavily fragmented, and thus is being rewritten
447 * sooner than the rest.
449 * Thus it will only move a subset of the pointers (or in the case of
450 * tiering/cache promotion perhaps add a single pointer without dropping any
451 * current pointers), and if the extent has been partially overwritten it must
452 * write only the currently live portion (or copygc would not be able to reduce
453 * fragmentation!) - which necessitates a different bch_extent_crc format for
456 * But in the interests of space efficiency, we don't want to store one
457 * bch_extent_crc for each pointer if we don't have to.
459 * Thus, a bch_extent consists of bch_extent_crc32s, bch_extent_crc64s, and
460 * bch_extent_ptrs appended arbitrarily one after the other. We determine the
461 * type of a given entry with a scheme similar to utf8 (except we're encoding a
462 * type, not a size), encoding the type in the position of the first set bit:
464 * bch_extent_crc32 - 0b1
465 * bch_extent_ptr - 0b10
466 * bch_extent_crc64 - 0b100
468 * We do it this way because bch_extent_crc32 is _very_ constrained on bits (and
469 * bch_extent_crc64 is the least constrained).
471 * Then, each bch_extent_crc32/64 applies to the pointers that follow after it,
472 * until the next bch_extent_crc32/64.
474 * If there are no bch_extent_crcs preceding a bch_extent_ptr, then that pointer
475 * is neither checksummed nor compressed.
478 /* 128 bits, sufficient for cryptographic MACs: */
482 } __packed __aligned(8);
484 #define BCH_EXTENT_ENTRY_TYPES() \
490 #define BCH_EXTENT_ENTRY_MAX 5
492 enum bch_extent_entry_type {
493 #define x(f, n) BCH_EXTENT_ENTRY_##f = n,
494 BCH_EXTENT_ENTRY_TYPES()
498 /* Compressed/uncompressed size are stored biased by 1: */
499 struct bch_extent_crc32 {
500 #if defined(__LITTLE_ENDIAN_BITFIELD)
503 _uncompressed_size:7,
509 #elif defined (__BIG_ENDIAN_BITFIELD)
511 __u32 compression_type:4,
515 _uncompressed_size:7,
519 } __packed __aligned(8);
521 #define CRC32_SIZE_MAX (1U << 7)
522 #define CRC32_NONCE_MAX 0
524 struct bch_extent_crc64 {
525 #if defined(__LITTLE_ENDIAN_BITFIELD)
528 _uncompressed_size:9,
534 #elif defined (__BIG_ENDIAN_BITFIELD)
540 _uncompressed_size:9,
545 } __packed __aligned(8);
547 #define CRC64_SIZE_MAX (1U << 9)
548 #define CRC64_NONCE_MAX ((1U << 10) - 1)
550 struct bch_extent_crc128 {
551 #if defined(__LITTLE_ENDIAN_BITFIELD)
554 _uncompressed_size:13,
559 #elif defined (__BIG_ENDIAN_BITFIELD)
560 __u64 compression_type:4,
564 _uncompressed_size:13,
568 struct bch_csum csum;
569 } __packed __aligned(8);
571 #define CRC128_SIZE_MAX (1U << 13)
572 #define CRC128_NONCE_MAX ((1U << 13) - 1)
575 * @reservation - pointer hasn't been written to, just reserved
577 struct bch_extent_ptr {
578 #if defined(__LITTLE_ENDIAN_BITFIELD)
583 offset:44, /* 8 petabytes */
586 #elif defined (__BIG_ENDIAN_BITFIELD)
595 } __packed __aligned(8);
597 struct bch_extent_stripe_ptr {
598 #if defined(__LITTLE_ENDIAN_BITFIELD)
603 #elif defined (__BIG_ENDIAN_BITFIELD)
611 struct bch_extent_reservation {
612 #if defined(__LITTLE_ENDIAN_BITFIELD)
617 #elif defined (__BIG_ENDIAN_BITFIELD)
625 union bch_extent_entry {
626 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ || __BITS_PER_LONG == 64
628 #elif __BITS_PER_LONG == 32
634 #error edit for your odd byteorder.
637 #define x(f, n) struct bch_extent_##f f;
638 BCH_EXTENT_ENTRY_TYPES()
642 struct bch_btree_ptr {
646 struct bch_extent_ptr start[];
647 } __packed __aligned(8);
649 struct bch_btree_ptr_v2 {
654 __le16 sectors_written;
658 struct bch_extent_ptr start[];
659 } __packed __aligned(8);
661 LE16_BITMASK(BTREE_PTR_RANGE_UPDATED, struct bch_btree_ptr_v2, flags, 0, 1);
667 union bch_extent_entry start[];
668 } __packed __aligned(8);
670 struct bch_reservation {
676 } __packed __aligned(8);
678 /* Maximum size (in u64s) a single pointer could be: */
679 #define BKEY_EXTENT_PTR_U64s_MAX\
680 ((sizeof(struct bch_extent_crc128) + \
681 sizeof(struct bch_extent_ptr)) / sizeof(u64))
683 /* Maximum possible size of an entire extent value: */
684 #define BKEY_EXTENT_VAL_U64s_MAX \
685 (1 + BKEY_EXTENT_PTR_U64s_MAX * (BCH_REPLICAS_MAX + 1))
687 /* * Maximum possible size of an entire extent, key + value: */
688 #define BKEY_EXTENT_U64s_MAX (BKEY_U64s + BKEY_EXTENT_VAL_U64s_MAX)
690 /* Btree pointers don't carry around checksums: */
691 #define BKEY_BTREE_PTR_VAL_U64s_MAX \
692 ((sizeof(struct bch_btree_ptr_v2) + \
693 sizeof(struct bch_extent_ptr) * BCH_REPLICAS_MAX) / sizeof(u64))
694 #define BKEY_BTREE_PTR_U64s_MAX \
695 (BKEY_U64s + BKEY_BTREE_PTR_VAL_U64s_MAX)
699 #define BLOCKDEV_INODE_MAX 4096
701 #define BCACHEFS_ROOT_INO 4096
710 } __packed __aligned(8);
712 struct bch_inode_v2 {
715 __le64 bi_journal_seq;
720 } __packed __aligned(8);
722 struct bch_inode_v3 {
725 __le64 bi_journal_seq;
732 } __packed __aligned(8);
734 #define INODEv3_FIELDS_START_INITIAL 6
735 #define INODEv3_FIELDS_START_CUR (offsetof(struct bch_inode_v3, fields) / sizeof(u64))
737 struct bch_inode_generation {
740 __le32 bi_generation;
742 } __packed __aligned(8);
745 * bi_subvol and bi_parent_subvol are only set for subvolume roots:
748 #define BCH_INODE_FIELDS_v2() \
758 x(bi_generation, 32) \
760 x(bi_data_checksum, 8) \
761 x(bi_compression, 8) \
763 x(bi_background_compression, 8) \
764 x(bi_data_replicas, 8) \
765 x(bi_promote_target, 16) \
766 x(bi_foreground_target, 16) \
767 x(bi_background_target, 16) \
768 x(bi_erasure_code, 16) \
769 x(bi_fields_set, 16) \
771 x(bi_dir_offset, 64) \
773 x(bi_parent_subvol, 32)
775 #define BCH_INODE_FIELDS_v3() \
783 x(bi_generation, 32) \
785 x(bi_data_checksum, 8) \
786 x(bi_compression, 8) \
788 x(bi_background_compression, 8) \
789 x(bi_data_replicas, 8) \
790 x(bi_promote_target, 16) \
791 x(bi_foreground_target, 16) \
792 x(bi_background_target, 16) \
793 x(bi_erasure_code, 16) \
794 x(bi_fields_set, 16) \
796 x(bi_dir_offset, 64) \
798 x(bi_parent_subvol, 32) \
801 /* subset of BCH_INODE_FIELDS */
802 #define BCH_INODE_OPTS() \
803 x(data_checksum, 8) \
806 x(background_compression, 8) \
807 x(data_replicas, 8) \
808 x(promote_target, 16) \
809 x(foreground_target, 16) \
810 x(background_target, 16) \
811 x(erasure_code, 16) \
815 #define x(name, ...) \
824 * User flags (get/settable with FS_IOC_*FLAGS, correspond to FS_*_FL
827 __BCH_INODE_SYNC = 0,
828 __BCH_INODE_IMMUTABLE = 1,
829 __BCH_INODE_APPEND = 2,
830 __BCH_INODE_NODUMP = 3,
831 __BCH_INODE_NOATIME = 4,
833 __BCH_INODE_I_SIZE_DIRTY = 5,
834 __BCH_INODE_I_SECTORS_DIRTY = 6,
835 __BCH_INODE_UNLINKED = 7,
836 __BCH_INODE_BACKPTR_UNTRUSTED = 8,
838 /* bits 20+ reserved for packed fields below: */
841 #define BCH_INODE_SYNC (1 << __BCH_INODE_SYNC)
842 #define BCH_INODE_IMMUTABLE (1 << __BCH_INODE_IMMUTABLE)
843 #define BCH_INODE_APPEND (1 << __BCH_INODE_APPEND)
844 #define BCH_INODE_NODUMP (1 << __BCH_INODE_NODUMP)
845 #define BCH_INODE_NOATIME (1 << __BCH_INODE_NOATIME)
846 #define BCH_INODE_I_SIZE_DIRTY (1 << __BCH_INODE_I_SIZE_DIRTY)
847 #define BCH_INODE_I_SECTORS_DIRTY (1 << __BCH_INODE_I_SECTORS_DIRTY)
848 #define BCH_INODE_UNLINKED (1 << __BCH_INODE_UNLINKED)
849 #define BCH_INODE_BACKPTR_UNTRUSTED (1 << __BCH_INODE_BACKPTR_UNTRUSTED)
851 LE32_BITMASK(INODE_STR_HASH, struct bch_inode, bi_flags, 20, 24);
852 LE32_BITMASK(INODE_NR_FIELDS, struct bch_inode, bi_flags, 24, 31);
853 LE32_BITMASK(INODE_NEW_VARINT, struct bch_inode, bi_flags, 31, 32);
855 LE64_BITMASK(INODEv2_STR_HASH, struct bch_inode_v2, bi_flags, 20, 24);
856 LE64_BITMASK(INODEv2_NR_FIELDS, struct bch_inode_v2, bi_flags, 24, 31);
858 LE64_BITMASK(INODEv3_STR_HASH, struct bch_inode_v3, bi_flags, 20, 24);
859 LE64_BITMASK(INODEv3_NR_FIELDS, struct bch_inode_v3, bi_flags, 24, 31);
861 LE64_BITMASK(INODEv3_FIELDS_START,
862 struct bch_inode_v3, bi_flags, 31, 36);
863 LE64_BITMASK(INODEv3_MODE, struct bch_inode_v3, bi_flags, 36, 52);
868 * Dirents (and xattrs) have to implement string lookups; since our b-tree
869 * doesn't support arbitrary length strings for the key, we instead index by a
870 * 64 bit hash (currently truncated sha1) of the string, stored in the offset
871 * field of the key - using linear probing to resolve hash collisions. This also
872 * provides us with the readdir cookie posix requires.
874 * Linear probing requires us to use whiteouts for deletions, in the event of a
881 /* Target inode number: */
884 struct { /* DT_SUBVOL */
885 __le32 d_child_subvol;
886 __le32 d_parent_subvol;
891 * Copy of mode bits 12-15 from the target inode - so userspace can get
892 * the filetype without having to do a stat()
897 } __packed __aligned(8);
900 #define BCH_DT_MAX 17
902 #define BCH_NAME_MAX ((unsigned) (U8_MAX * sizeof(u64) - \
903 sizeof(struct bkey) - \
904 offsetof(struct bch_dirent, d_name)))
908 #define KEY_TYPE_XATTR_INDEX_USER 0
909 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS 1
910 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT 2
911 #define KEY_TYPE_XATTR_INDEX_TRUSTED 3
912 #define KEY_TYPE_XATTR_INDEX_SECURITY 4
920 } __packed __aligned(8);
922 /* Bucket/allocation information: */
929 } __packed __aligned(8);
931 #define BCH_ALLOC_FIELDS_V1() \
935 x(dirty_sectors, 16) \
936 x(cached_sectors, 16) \
939 x(stripe_redundancy, 8)
942 #define x(name, _bits) BCH_ALLOC_FIELD_V1_##name,
943 BCH_ALLOC_FIELDS_V1()
947 struct bch_alloc_v2 {
954 } __packed __aligned(8);
956 #define BCH_ALLOC_FIELDS_V2() \
959 x(dirty_sectors, 32) \
960 x(cached_sectors, 32) \
962 x(stripe_redundancy, 8)
964 struct bch_alloc_v3 {
973 } __packed __aligned(8);
975 LE32_BITMASK(BCH_ALLOC_V3_NEED_DISCARD,struct bch_alloc_v3, flags, 0, 1)
976 LE32_BITMASK(BCH_ALLOC_V3_NEED_INC_GEN,struct bch_alloc_v3, flags, 1, 2)
978 struct bch_alloc_v4 {
985 __u8 stripe_redundancy;
987 __u32 cached_sectors;
990 __u32 nr_external_backpointers;
991 __u64 fragmentation_lru;
992 } __packed __aligned(8);
994 #define BCH_ALLOC_V4_U64s_V0 6
995 #define BCH_ALLOC_V4_U64s (sizeof(struct bch_alloc_v4) / sizeof(u64))
997 BITMASK(BCH_ALLOC_V4_NEED_DISCARD, struct bch_alloc_v4, flags, 0, 1)
998 BITMASK(BCH_ALLOC_V4_NEED_INC_GEN, struct bch_alloc_v4, flags, 1, 2)
999 BITMASK(BCH_ALLOC_V4_BACKPOINTERS_START,struct bch_alloc_v4, flags, 2, 8)
1000 BITMASK(BCH_ALLOC_V4_NR_BACKPOINTERS, struct bch_alloc_v4, flags, 8, 14)
1002 #define BCH_ALLOC_V4_NR_BACKPOINTERS_MAX 40
1004 struct bch_backpointer {
1009 __u64 bucket_offset:40;
1012 } __packed __aligned(8);
1014 #define KEY_TYPE_BUCKET_GENS_BITS 8
1015 #define KEY_TYPE_BUCKET_GENS_NR (1U << KEY_TYPE_BUCKET_GENS_BITS)
1016 #define KEY_TYPE_BUCKET_GENS_MASK (KEY_TYPE_BUCKET_GENS_NR - 1)
1018 struct bch_bucket_gens {
1020 u8 gens[KEY_TYPE_BUCKET_GENS_NR];
1021 } __packed __aligned(8);
1032 enum quota_counters {
1038 struct bch_quota_counter {
1045 struct bch_quota_counter c[Q_COUNTERS];
1046 } __packed __aligned(8);
1048 /* Erasure coding */
1057 __u8 csum_granularity_bits;
1061 struct bch_extent_ptr ptrs[];
1062 } __packed __aligned(8);
1066 struct bch_reflink_p {
1070 * A reflink pointer might point to an indirect extent which is then
1071 * later split (by copygc or rebalance). If we only pointed to part of
1072 * the original indirect extent, and then one of the fragments is
1073 * outside the range we point to, we'd leak a refcount: so when creating
1074 * reflink pointers, we need to store pad values to remember the full
1075 * range we were taking a reference on.
1079 } __packed __aligned(8);
1081 struct bch_reflink_v {
1084 union bch_extent_entry start[0];
1086 } __packed __aligned(8);
1088 struct bch_indirect_inline_data {
1096 struct bch_inline_data {
1103 #define SUBVOL_POS_MIN POS(0, 1)
1104 #define SUBVOL_POS_MAX POS(0, S32_MAX)
1105 #define BCACHEFS_ROOT_SUBVOL 1
1107 struct bch_subvolume {
1114 LE32_BITMASK(BCH_SUBVOLUME_RO, struct bch_subvolume, flags, 0, 1)
1116 * We need to know whether a subvolume is a snapshot so we can know whether we
1117 * can delete it (or whether it should just be rm -rf'd)
1119 LE32_BITMASK(BCH_SUBVOLUME_SNAP, struct bch_subvolume, flags, 1, 2)
1120 LE32_BITMASK(BCH_SUBVOLUME_UNLINKED, struct bch_subvolume, flags, 2, 3)
1124 struct bch_snapshot {
1133 LE32_BITMASK(BCH_SNAPSHOT_DELETED, struct bch_snapshot, flags, 0, 1)
1135 /* True if a subvolume points to this snapshot node: */
1136 LE32_BITMASK(BCH_SNAPSHOT_SUBVOL, struct bch_snapshot, flags, 1, 2)
1143 } __packed __aligned(8);
1145 #define LRU_ID_STRIPES (1U << 16)
1147 /* Optional/variable size superblock sections: */
1149 struct bch_sb_field {
1155 #define BCH_SB_FIELDS() \
1164 x(journal_seq_blacklist, 8) \
1168 enum bch_sb_field_type {
1169 #define x(f, nr) BCH_SB_FIELD_##f = nr,
1176 * Most superblock fields are replicated in all device's superblocks - a few are
1179 #define BCH_SINGLE_DEVICE_SB_FIELDS \
1180 ((1U << BCH_SB_FIELD_journal)| \
1181 (1U << BCH_SB_FIELD_journal_v2))
1183 /* BCH_SB_FIELD_journal: */
1185 struct bch_sb_field_journal {
1186 struct bch_sb_field field;
1190 struct bch_sb_field_journal_v2 {
1191 struct bch_sb_field field;
1193 struct bch_sb_field_journal_v2_entry {
1199 /* BCH_SB_FIELD_members: */
1201 #define BCH_MIN_NR_NBUCKETS (1 << 6)
1205 __le64 nbuckets; /* device size */
1206 __le16 first_bucket; /* index of first bucket used */
1207 __le16 bucket_size; /* sectors */
1209 __le64 last_mount; /* time_t */
1214 LE64_BITMASK(BCH_MEMBER_STATE, struct bch_member, flags[0], 0, 4)
1215 /* 4-14 unused, was TIER, HAS_(META)DATA, REPLACEMENT */
1216 LE64_BITMASK(BCH_MEMBER_DISCARD, struct bch_member, flags[0], 14, 15)
1217 LE64_BITMASK(BCH_MEMBER_DATA_ALLOWED, struct bch_member, flags[0], 15, 20)
1218 LE64_BITMASK(BCH_MEMBER_GROUP, struct bch_member, flags[0], 20, 28)
1219 LE64_BITMASK(BCH_MEMBER_DURABILITY, struct bch_member, flags[0], 28, 30)
1220 LE64_BITMASK(BCH_MEMBER_FREESPACE_INITIALIZED,
1221 struct bch_member, flags[0], 30, 31)
1224 LE64_BITMASK(BCH_MEMBER_NR_READ_ERRORS, struct bch_member, flags[1], 0, 20);
1225 LE64_BITMASK(BCH_MEMBER_NR_WRITE_ERRORS,struct bch_member, flags[1], 20, 40);
1228 #define BCH_MEMBER_STATES() \
1234 enum bch_member_state {
1235 #define x(t, n) BCH_MEMBER_STATE_##t = n,
1241 struct bch_sb_field_members {
1242 struct bch_sb_field field;
1243 struct bch_member members[0];
1246 /* BCH_SB_FIELD_crypt: */
1256 #define BCH_KEY_MAGIC \
1257 (((u64) 'b' << 0)|((u64) 'c' << 8)| \
1258 ((u64) 'h' << 16)|((u64) '*' << 24)| \
1259 ((u64) '*' << 32)|((u64) 'k' << 40)| \
1260 ((u64) 'e' << 48)|((u64) 'y' << 56))
1262 struct bch_encrypted_key {
1268 * If this field is present in the superblock, it stores an encryption key which
1269 * is used encrypt all other data/metadata. The key will normally be encrypted
1270 * with the key userspace provides, but if encryption has been turned off we'll
1271 * just store the master key unencrypted in the superblock so we can access the
1272 * previously encrypted data.
1274 struct bch_sb_field_crypt {
1275 struct bch_sb_field field;
1279 struct bch_encrypted_key key;
1282 LE64_BITMASK(BCH_CRYPT_KDF_TYPE, struct bch_sb_field_crypt, flags, 0, 4);
1284 enum bch_kdf_types {
1289 /* stored as base 2 log of scrypt params: */
1290 LE64_BITMASK(BCH_KDF_SCRYPT_N, struct bch_sb_field_crypt, kdf_flags, 0, 16);
1291 LE64_BITMASK(BCH_KDF_SCRYPT_R, struct bch_sb_field_crypt, kdf_flags, 16, 32);
1292 LE64_BITMASK(BCH_KDF_SCRYPT_P, struct bch_sb_field_crypt, kdf_flags, 32, 48);
1294 /* BCH_SB_FIELD_replicas: */
1296 #define BCH_DATA_TYPES() \
1305 x(need_gc_gens, 8) \
1308 enum bch_data_type {
1309 #define x(t, n) BCH_DATA_##t,
1315 static inline bool data_type_is_empty(enum bch_data_type type)
1319 case BCH_DATA_need_gc_gens:
1320 case BCH_DATA_need_discard:
1327 static inline bool data_type_is_hidden(enum bch_data_type type)
1331 case BCH_DATA_journal:
1338 struct bch_replicas_entry_v0 {
1344 struct bch_sb_field_replicas_v0 {
1345 struct bch_sb_field field;
1346 struct bch_replicas_entry_v0 entries[];
1347 } __packed __aligned(8);
1349 struct bch_replicas_entry {
1356 #define replicas_entry_bytes(_i) \
1357 (offsetof(typeof(*(_i)), devs) + (_i)->nr_devs)
1359 struct bch_sb_field_replicas {
1360 struct bch_sb_field field;
1361 struct bch_replicas_entry entries[];
1362 } __packed __aligned(8);
1364 /* BCH_SB_FIELD_quota: */
1366 struct bch_sb_quota_counter {
1371 struct bch_sb_quota_type {
1373 struct bch_sb_quota_counter c[Q_COUNTERS];
1376 struct bch_sb_field_quota {
1377 struct bch_sb_field field;
1378 struct bch_sb_quota_type q[QTYP_NR];
1379 } __packed __aligned(8);
1381 /* BCH_SB_FIELD_disk_groups: */
1383 #define BCH_SB_LABEL_SIZE 32
1385 struct bch_disk_group {
1386 __u8 label[BCH_SB_LABEL_SIZE];
1388 } __packed __aligned(8);
1390 LE64_BITMASK(BCH_GROUP_DELETED, struct bch_disk_group, flags[0], 0, 1)
1391 LE64_BITMASK(BCH_GROUP_DATA_ALLOWED, struct bch_disk_group, flags[0], 1, 6)
1392 LE64_BITMASK(BCH_GROUP_PARENT, struct bch_disk_group, flags[0], 6, 24)
1394 struct bch_sb_field_disk_groups {
1395 struct bch_sb_field field;
1396 struct bch_disk_group entries[0];
1397 } __packed __aligned(8);
1399 /* BCH_SB_FIELD_counters */
1401 #define BCH_PERSISTENT_COUNTERS() \
1405 x(bucket_invalidate, 3) \
1406 x(bucket_discard, 4) \
1407 x(bucket_alloc, 5) \
1408 x(bucket_alloc_fail, 6) \
1409 x(btree_cache_scan, 7) \
1410 x(btree_cache_reap, 8) \
1411 x(btree_cache_cannibalize, 9) \
1412 x(btree_cache_cannibalize_lock, 10) \
1413 x(btree_cache_cannibalize_lock_fail, 11) \
1414 x(btree_cache_cannibalize_unlock, 12) \
1415 x(btree_node_write, 13) \
1416 x(btree_node_read, 14) \
1417 x(btree_node_compact, 15) \
1418 x(btree_node_merge, 16) \
1419 x(btree_node_split, 17) \
1420 x(btree_node_rewrite, 18) \
1421 x(btree_node_alloc, 19) \
1422 x(btree_node_free, 20) \
1423 x(btree_node_set_root, 21) \
1424 x(btree_path_relock_fail, 22) \
1425 x(btree_path_upgrade_fail, 23) \
1426 x(btree_reserve_get_fail, 24) \
1427 x(journal_entry_full, 25) \
1428 x(journal_full, 26) \
1429 x(journal_reclaim_finish, 27) \
1430 x(journal_reclaim_start, 28) \
1431 x(journal_write, 29) \
1432 x(read_promote, 30) \
1433 x(read_bounce, 31) \
1436 x(read_reuse_race, 34) \
1437 x(move_extent_read, 35) \
1438 x(move_extent_write, 36) \
1439 x(move_extent_finish, 37) \
1440 x(move_extent_fail, 38) \
1441 x(move_extent_alloc_mem_fail, 39) \
1443 x(copygc_wait, 41) \
1444 x(gc_gens_end, 42) \
1445 x(gc_gens_start, 43) \
1446 x(trans_blocked_journal_reclaim, 44) \
1447 x(trans_restart_btree_node_reused, 45) \
1448 x(trans_restart_btree_node_split, 46) \
1449 x(trans_restart_fault_inject, 47) \
1450 x(trans_restart_iter_upgrade, 48) \
1451 x(trans_restart_journal_preres_get, 49) \
1452 x(trans_restart_journal_reclaim, 50) \
1453 x(trans_restart_journal_res_get, 51) \
1454 x(trans_restart_key_cache_key_realloced, 52) \
1455 x(trans_restart_key_cache_raced, 53) \
1456 x(trans_restart_mark_replicas, 54) \
1457 x(trans_restart_mem_realloced, 55) \
1458 x(trans_restart_memory_allocation_failure, 56) \
1459 x(trans_restart_relock, 57) \
1460 x(trans_restart_relock_after_fill, 58) \
1461 x(trans_restart_relock_key_cache_fill, 59) \
1462 x(trans_restart_relock_next_node, 60) \
1463 x(trans_restart_relock_parent_for_fill, 61) \
1464 x(trans_restart_relock_path, 62) \
1465 x(trans_restart_relock_path_intent, 63) \
1466 x(trans_restart_too_many_iters, 64) \
1467 x(trans_restart_traverse, 65) \
1468 x(trans_restart_upgrade, 66) \
1469 x(trans_restart_would_deadlock, 67) \
1470 x(trans_restart_would_deadlock_write, 68) \
1471 x(trans_restart_injected, 69) \
1472 x(trans_restart_key_cache_upgrade, 70) \
1473 x(trans_traverse_all, 71) \
1474 x(transaction_commit, 72) \
1475 x(write_super, 73) \
1476 x(trans_restart_would_deadlock_recursion_limit, 74) \
1477 x(trans_restart_write_buffer_flush, 75)
1479 enum bch_persistent_counters {
1480 #define x(t, n, ...) BCH_COUNTER_##t,
1481 BCH_PERSISTENT_COUNTERS()
1486 struct bch_sb_field_counters {
1487 struct bch_sb_field field;
1492 * On clean shutdown, store btree roots and current journal sequence number in
1499 __u8 type; /* designates what this jset holds */
1503 struct bkey_i start[0];
1508 struct bch_sb_field_clean {
1509 struct bch_sb_field field;
1512 __le16 _read_clock; /* no longer used */
1513 __le16 _write_clock;
1517 struct jset_entry start[0];
1522 struct journal_seq_blacklist_entry {
1527 struct bch_sb_field_journal_seq_blacklist {
1528 struct bch_sb_field field;
1531 struct journal_seq_blacklist_entry start[0];
1539 * New versioning scheme:
1540 * One common version number for all on disk data structures - superblock, btree
1541 * nodes, journal entries
1543 #define BCH_JSET_VERSION_OLD 2
1544 #define BCH_BSET_VERSION_OLD 3
1546 #define BCH_METADATA_VERSIONS() \
1547 x(bkey_renumber, 10) \
1548 x(inode_btree_change, 11) \
1550 x(inode_backpointers, 13) \
1551 x(btree_ptr_sectors_written, 14) \
1553 x(reflink_p_fix, 16) \
1554 x(subvol_dirent, 17) \
1558 x(new_data_types, 21) \
1559 x(backpointers, 22) \
1561 x(unwritten_extents, 24) \
1562 x(bucket_gens, 25) \
1564 x(fragmentation_lru, 27)
1566 enum bcachefs_metadata_version {
1567 bcachefs_metadata_version_min = 9,
1568 #define x(t, n) bcachefs_metadata_version_##t = n,
1569 BCH_METADATA_VERSIONS()
1571 bcachefs_metadata_version_max
1574 #define bcachefs_metadata_version_current (bcachefs_metadata_version_max - 1)
1576 #define BCH_SB_SECTOR 8
1577 #define BCH_SB_MEMBERS_MAX 64 /* XXX kill */
1579 struct bch_sb_layout {
1580 uuid_le magic; /* bcachefs superblock UUID */
1582 __u8 sb_max_size_bits; /* base 2 of 512 byte sectors */
1583 __u8 nr_superblocks;
1585 __le64 sb_offset[61];
1586 } __packed __aligned(8);
1588 #define BCH_SB_LAYOUT_SECTOR 7
1591 * @offset - sector where this sb was written
1592 * @version - on disk format version
1593 * @version_min - Oldest metadata version this filesystem contains; so we can
1594 * safely drop compatibility code and refuse to mount filesystems
1596 * @magic - identifies as a bcachefs superblock (BCHFS_MAGIC)
1597 * @seq - incremented each time superblock is written
1598 * @uuid - used for generating various magic numbers and identifying
1599 * member devices, never changes
1600 * @user_uuid - user visible UUID, may be changed
1601 * @label - filesystem label
1602 * @seq - identifies most recent superblock, incremented each time
1603 * superblock is written
1604 * @features - enabled incompatible features
1607 struct bch_csum csum;
1614 __u8 label[BCH_SB_LABEL_SIZE];
1623 __le64 time_base_lo;
1624 __le32 time_base_hi;
1625 __le32 time_precision;
1631 struct bch_sb_layout layout;
1634 struct bch_sb_field start[0];
1637 } __packed __aligned(8);
1641 * BCH_SB_INITALIZED - set on first mount
1642 * BCH_SB_CLEAN - did we shut down cleanly? Just a hint, doesn't affect
1643 * behaviour of mount/recovery path:
1644 * BCH_SB_INODE_32BIT - limit inode numbers to 32 bits
1645 * BCH_SB_128_BIT_MACS - 128 bit macs instead of 80
1646 * BCH_SB_ENCRYPTION_TYPE - if nonzero encryption is enabled; overrides
1647 * DATA/META_CSUM_TYPE. Also indicates encryption
1648 * algorithm in use, if/when we get more than one
1651 LE16_BITMASK(BCH_SB_BLOCK_SIZE, struct bch_sb, block_size, 0, 16);
1653 LE64_BITMASK(BCH_SB_INITIALIZED, struct bch_sb, flags[0], 0, 1);
1654 LE64_BITMASK(BCH_SB_CLEAN, struct bch_sb, flags[0], 1, 2);
1655 LE64_BITMASK(BCH_SB_CSUM_TYPE, struct bch_sb, flags[0], 2, 8);
1656 LE64_BITMASK(BCH_SB_ERROR_ACTION, struct bch_sb, flags[0], 8, 12);
1658 LE64_BITMASK(BCH_SB_BTREE_NODE_SIZE, struct bch_sb, flags[0], 12, 28);
1660 LE64_BITMASK(BCH_SB_GC_RESERVE, struct bch_sb, flags[0], 28, 33);
1661 LE64_BITMASK(BCH_SB_ROOT_RESERVE, struct bch_sb, flags[0], 33, 40);
1663 LE64_BITMASK(BCH_SB_META_CSUM_TYPE, struct bch_sb, flags[0], 40, 44);
1664 LE64_BITMASK(BCH_SB_DATA_CSUM_TYPE, struct bch_sb, flags[0], 44, 48);
1666 LE64_BITMASK(BCH_SB_META_REPLICAS_WANT, struct bch_sb, flags[0], 48, 52);
1667 LE64_BITMASK(BCH_SB_DATA_REPLICAS_WANT, struct bch_sb, flags[0], 52, 56);
1669 LE64_BITMASK(BCH_SB_POSIX_ACL, struct bch_sb, flags[0], 56, 57);
1670 LE64_BITMASK(BCH_SB_USRQUOTA, struct bch_sb, flags[0], 57, 58);
1671 LE64_BITMASK(BCH_SB_GRPQUOTA, struct bch_sb, flags[0], 58, 59);
1672 LE64_BITMASK(BCH_SB_PRJQUOTA, struct bch_sb, flags[0], 59, 60);
1674 LE64_BITMASK(BCH_SB_HAS_ERRORS, struct bch_sb, flags[0], 60, 61);
1675 LE64_BITMASK(BCH_SB_HAS_TOPOLOGY_ERRORS,struct bch_sb, flags[0], 61, 62);
1677 LE64_BITMASK(BCH_SB_BIG_ENDIAN, struct bch_sb, flags[0], 62, 63);
1679 LE64_BITMASK(BCH_SB_STR_HASH_TYPE, struct bch_sb, flags[1], 0, 4);
1680 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE, struct bch_sb, flags[1], 4, 8);
1681 LE64_BITMASK(BCH_SB_INODE_32BIT, struct bch_sb, flags[1], 8, 9);
1683 LE64_BITMASK(BCH_SB_128_BIT_MACS, struct bch_sb, flags[1], 9, 10);
1684 LE64_BITMASK(BCH_SB_ENCRYPTION_TYPE, struct bch_sb, flags[1], 10, 14);
1687 * Max size of an extent that may require bouncing to read or write
1688 * (checksummed, compressed): 64k
1690 LE64_BITMASK(BCH_SB_ENCODED_EXTENT_MAX_BITS,
1691 struct bch_sb, flags[1], 14, 20);
1693 LE64_BITMASK(BCH_SB_META_REPLICAS_REQ, struct bch_sb, flags[1], 20, 24);
1694 LE64_BITMASK(BCH_SB_DATA_REPLICAS_REQ, struct bch_sb, flags[1], 24, 28);
1696 LE64_BITMASK(BCH_SB_PROMOTE_TARGET, struct bch_sb, flags[1], 28, 40);
1697 LE64_BITMASK(BCH_SB_FOREGROUND_TARGET, struct bch_sb, flags[1], 40, 52);
1698 LE64_BITMASK(BCH_SB_BACKGROUND_TARGET, struct bch_sb, flags[1], 52, 64);
1700 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE,
1701 struct bch_sb, flags[2], 0, 4);
1702 LE64_BITMASK(BCH_SB_GC_RESERVE_BYTES, struct bch_sb, flags[2], 4, 64);
1704 LE64_BITMASK(BCH_SB_ERASURE_CODE, struct bch_sb, flags[3], 0, 16);
1705 LE64_BITMASK(BCH_SB_METADATA_TARGET, struct bch_sb, flags[3], 16, 28);
1706 LE64_BITMASK(BCH_SB_SHARD_INUMS, struct bch_sb, flags[3], 28, 29);
1707 LE64_BITMASK(BCH_SB_INODES_USE_KEY_CACHE,struct bch_sb, flags[3], 29, 30);
1708 LE64_BITMASK(BCH_SB_JOURNAL_FLUSH_DELAY,struct bch_sb, flags[3], 30, 62);
1709 LE64_BITMASK(BCH_SB_JOURNAL_FLUSH_DISABLED,struct bch_sb, flags[3], 62, 63);
1710 LE64_BITMASK(BCH_SB_JOURNAL_RECLAIM_DELAY,struct bch_sb, flags[4], 0, 32);
1711 LE64_BITMASK(BCH_SB_JOURNAL_TRANSACTION_NAMES,struct bch_sb, flags[4], 32, 33);
1712 LE64_BITMASK(BCH_SB_NOCOW, struct bch_sb, flags[4], 33, 34);
1713 LE64_BITMASK(BCH_SB_WRITE_BUFFER_SIZE, struct bch_sb, flags[4], 34, 54);
1718 * journal_seq_blacklist_v3: gates BCH_SB_FIELD_journal_seq_blacklist
1719 * reflink: gates KEY_TYPE_reflink
1720 * inline_data: gates KEY_TYPE_inline_data
1721 * new_siphash: gates BCH_STR_HASH_siphash
1722 * new_extent_overwrite: gates BTREE_NODE_NEW_EXTENT_OVERWRITE
1724 #define BCH_SB_FEATURES() \
1728 x(atomic_nlink, 3) \
1730 x(journal_seq_blacklist_v3, 5) \
1734 x(new_extent_overwrite, 9) \
1735 x(incompressible, 10) \
1736 x(btree_ptr_v2, 11) \
1737 x(extents_above_btree_updates, 12) \
1738 x(btree_updates_journalled, 13) \
1739 x(reflink_inline_data, 14) \
1741 x(journal_no_flush, 16) \
1743 x(extents_across_btree_nodes, 18)
1745 #define BCH_SB_FEATURES_ALWAYS \
1746 ((1ULL << BCH_FEATURE_new_extent_overwrite)| \
1747 (1ULL << BCH_FEATURE_extents_above_btree_updates)|\
1748 (1ULL << BCH_FEATURE_btree_updates_journalled)|\
1749 (1ULL << BCH_FEATURE_alloc_v2)|\
1750 (1ULL << BCH_FEATURE_extents_across_btree_nodes))
1752 #define BCH_SB_FEATURES_ALL \
1753 (BCH_SB_FEATURES_ALWAYS| \
1754 (1ULL << BCH_FEATURE_new_siphash)| \
1755 (1ULL << BCH_FEATURE_btree_ptr_v2)| \
1756 (1ULL << BCH_FEATURE_new_varint)| \
1757 (1ULL << BCH_FEATURE_journal_no_flush))
1759 enum bch_sb_feature {
1760 #define x(f, n) BCH_FEATURE_##f,
1766 #define BCH_SB_COMPAT() \
1768 x(alloc_metadata, 1) \
1769 x(extents_above_btree_updates_done, 2) \
1770 x(bformat_overflow_done, 3)
1772 enum bch_sb_compat {
1773 #define x(f, n) BCH_COMPAT_##f,
1781 #define BCH_REPLICAS_MAX 4U
1783 #define BCH_BKEY_PTRS_MAX 16U
1785 #define BCH_ERROR_ACTIONS() \
1790 enum bch_error_actions {
1791 #define x(t, n) BCH_ON_ERROR_##t = n,
1797 #define BCH_STR_HASH_TYPES() \
1803 enum bch_str_hash_type {
1804 #define x(t, n) BCH_STR_HASH_##t = n,
1805 BCH_STR_HASH_TYPES()
1810 #define BCH_STR_HASH_OPTS() \
1815 enum bch_str_hash_opts {
1816 #define x(t, n) BCH_STR_HASH_OPT_##t = n,
1822 #define BCH_CSUM_TYPES() \
1824 x(crc32c_nonzero, 1) \
1825 x(crc64_nonzero, 2) \
1826 x(chacha20_poly1305_80, 3) \
1827 x(chacha20_poly1305_128, 4) \
1832 enum bch_csum_type {
1833 #define x(t, n) BCH_CSUM_##t = n,
1839 static const unsigned bch_crc_bytes[] = {
1840 [BCH_CSUM_none] = 0,
1841 [BCH_CSUM_crc32c_nonzero] = 4,
1842 [BCH_CSUM_crc32c] = 4,
1843 [BCH_CSUM_crc64_nonzero] = 8,
1844 [BCH_CSUM_crc64] = 8,
1845 [BCH_CSUM_xxhash] = 8,
1846 [BCH_CSUM_chacha20_poly1305_80] = 10,
1847 [BCH_CSUM_chacha20_poly1305_128] = 16,
1850 static inline _Bool bch2_csum_type_is_encryption(enum bch_csum_type type)
1853 case BCH_CSUM_chacha20_poly1305_80:
1854 case BCH_CSUM_chacha20_poly1305_128:
1861 #define BCH_CSUM_OPTS() \
1867 enum bch_csum_opts {
1868 #define x(t, n) BCH_CSUM_OPT_##t = n,
1874 #define BCH_COMPRESSION_TYPES() \
1880 x(incompressible, 5)
1882 enum bch_compression_type {
1883 #define x(t, n) BCH_COMPRESSION_TYPE_##t = n,
1884 BCH_COMPRESSION_TYPES()
1886 BCH_COMPRESSION_TYPE_NR
1889 #define BCH_COMPRESSION_OPTS() \
1895 enum bch_compression_opts {
1896 #define x(t, n) BCH_COMPRESSION_OPT_##t = n,
1897 BCH_COMPRESSION_OPTS()
1899 BCH_COMPRESSION_OPT_NR
1905 * The various other data structures have their own magic numbers, which are
1906 * xored with the first part of the cache set's UUID
1909 #define BCACHE_MAGIC \
1910 UUID_LE(0xf67385c6, 0x1a4e, 0xca45, \
1911 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81)
1912 #define BCHFS_MAGIC \
1913 UUID_LE(0xf67385c6, 0xce66, 0xa990, \
1914 0xd9, 0x6a, 0x60, 0xcf, 0x80, 0x3d, 0xf7, 0xef)
1916 #define BCACHEFS_STATFS_MAGIC 0xca451a4e
1918 #define JSET_MAGIC __cpu_to_le64(0x245235c1a3625032ULL)
1919 #define BSET_MAGIC __cpu_to_le64(0x90135c78b99e07f5ULL)
1921 static inline __le64 __bch2_sb_magic(struct bch_sb *sb)
1925 memcpy(&ret, &sb->uuid, sizeof(ret));
1929 static inline __u64 __jset_magic(struct bch_sb *sb)
1931 return __le64_to_cpu(__bch2_sb_magic(sb) ^ JSET_MAGIC);
1934 static inline __u64 __bset_magic(struct bch_sb *sb)
1936 return __le64_to_cpu(__bch2_sb_magic(sb) ^ BSET_MAGIC);
1941 #define JSET_KEYS_U64s (sizeof(struct jset_entry) / sizeof(__u64))
1943 #define BCH_JSET_ENTRY_TYPES() \
1948 x(blacklist_v2, 4) \
1957 #define x(f, nr) BCH_JSET_ENTRY_##f = nr,
1958 BCH_JSET_ENTRY_TYPES()
1964 * Journal sequence numbers can be blacklisted: bsets record the max sequence
1965 * number of all the journal entries they contain updates for, so that on
1966 * recovery we can ignore those bsets that contain index updates newer that what
1967 * made it into the journal.
1969 * This means that we can't reuse that journal_seq - we have to skip it, and
1970 * then record that we skipped it so that the next time we crash and recover we
1971 * don't think there was a missing journal entry.
1973 struct jset_entry_blacklist {
1974 struct jset_entry entry;
1978 struct jset_entry_blacklist_v2 {
1979 struct jset_entry entry;
1984 #define BCH_FS_USAGE_TYPES() \
1990 #define x(f, nr) BCH_FS_USAGE_##f = nr,
1991 BCH_FS_USAGE_TYPES()
1996 struct jset_entry_usage {
1997 struct jset_entry entry;
2001 struct jset_entry_data_usage {
2002 struct jset_entry entry;
2004 struct bch_replicas_entry r;
2007 struct jset_entry_clock {
2008 struct jset_entry entry;
2014 struct jset_entry_dev_usage_type {
2020 struct jset_entry_dev_usage {
2021 struct jset_entry entry;
2026 __le64 _buckets_unavailable; /* No longer used */
2028 struct jset_entry_dev_usage_type d[];
2031 static inline unsigned jset_entry_dev_usage_nr_types(struct jset_entry_dev_usage *u)
2033 return (vstruct_bytes(&u->entry) - sizeof(struct jset_entry_dev_usage)) /
2034 sizeof(struct jset_entry_dev_usage_type);
2037 struct jset_entry_log {
2038 struct jset_entry entry;
2043 * On disk format for a journal entry:
2044 * seq is monotonically increasing; every journal entry has its own unique
2047 * last_seq is the oldest journal entry that still has keys the btree hasn't
2048 * flushed to disk yet.
2050 * version is for on disk format changes.
2053 struct bch_csum csum;
2060 __le32 u64s; /* size of d[] in u64s */
2062 __u8 encrypted_start[0];
2064 __le16 _read_clock; /* no longer used */
2065 __le16 _write_clock;
2067 /* Sequence number of oldest dirty journal entry */
2072 struct jset_entry start[0];
2075 } __packed __aligned(8);
2077 LE32_BITMASK(JSET_CSUM_TYPE, struct jset, flags, 0, 4);
2078 LE32_BITMASK(JSET_BIG_ENDIAN, struct jset, flags, 4, 5);
2079 LE32_BITMASK(JSET_NO_FLUSH, struct jset, flags, 5, 6);
2081 #define BCH_JOURNAL_BUCKETS_MIN 8
2085 #define BCH_BTREE_IDS() \
2098 x(need_discard, 12) \
2099 x(backpointers, 13) \
2103 #define x(kwd, val) BTREE_ID_##kwd = val,
2109 #define BTREE_MAX_DEPTH 4U
2116 * On disk a btree node is a list/log of these; within each set the keys are
2123 * Highest journal entry this bset contains keys for.
2124 * If on recovery we don't see that journal entry, this bset is ignored:
2125 * this allows us to preserve the order of all index updates after a
2126 * crash, since the journal records a total order of all index updates
2127 * and anything that didn't make it to the journal doesn't get used.
2133 __le16 u64s; /* count of d[] in u64s */
2136 struct bkey_packed start[0];
2139 } __packed __aligned(8);
2141 LE32_BITMASK(BSET_CSUM_TYPE, struct bset, flags, 0, 4);
2143 LE32_BITMASK(BSET_BIG_ENDIAN, struct bset, flags, 4, 5);
2144 LE32_BITMASK(BSET_SEPARATE_WHITEOUTS,
2145 struct bset, flags, 5, 6);
2147 /* Sector offset within the btree node: */
2148 LE32_BITMASK(BSET_OFFSET, struct bset, flags, 16, 32);
2151 struct bch_csum csum;
2154 /* this flags field is encrypted, unlike bset->flags: */
2157 /* Closed interval: */
2158 struct bpos min_key;
2159 struct bpos max_key;
2160 struct bch_extent_ptr _ptr; /* not used anymore */
2161 struct bkey_format format;
2172 } __packed __aligned(8);
2174 LE64_BITMASK(BTREE_NODE_ID, struct btree_node, flags, 0, 4);
2175 LE64_BITMASK(BTREE_NODE_LEVEL, struct btree_node, flags, 4, 8);
2176 LE64_BITMASK(BTREE_NODE_NEW_EXTENT_OVERWRITE,
2177 struct btree_node, flags, 8, 9);
2179 LE64_BITMASK(BTREE_NODE_SEQ, struct btree_node, flags, 32, 64);
2181 struct btree_node_entry {
2182 struct bch_csum csum;
2193 } __packed __aligned(8);
2195 #endif /* _BCACHEFS_FORMAT_H */