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>
82 typedef uuid_t __uuid_t;
85 #define BITMASK(name, type, field, offset, end) \
86 static const __maybe_unused unsigned name##_OFFSET = offset; \
87 static const __maybe_unused unsigned name##_BITS = (end - offset); \
89 static inline __u64 name(const type *k) \
91 return (k->field >> offset) & ~(~0ULL << (end - offset)); \
94 static inline void SET_##name(type *k, __u64 v) \
96 k->field &= ~(~(~0ULL << (end - offset)) << offset); \
97 k->field |= (v & ~(~0ULL << (end - offset))) << offset; \
100 #define LE_BITMASK(_bits, name, type, field, offset, end) \
101 static const __maybe_unused unsigned name##_OFFSET = offset; \
102 static const __maybe_unused unsigned name##_BITS = (end - offset); \
103 static const __maybe_unused __u##_bits name##_MAX = (1ULL << (end - offset)) - 1;\
105 static inline __u64 name(const type *k) \
107 return (__le##_bits##_to_cpu(k->field) >> offset) & \
108 ~(~0ULL << (end - offset)); \
111 static inline void SET_##name(type *k, __u64 v) \
113 __u##_bits new = __le##_bits##_to_cpu(k->field); \
115 new &= ~(~(~0ULL << (end - offset)) << offset); \
116 new |= (v & ~(~0ULL << (end - offset))) << offset; \
117 k->field = __cpu_to_le##_bits(new); \
120 #define LE16_BITMASK(n, t, f, o, e) LE_BITMASK(16, n, t, f, o, e)
121 #define LE32_BITMASK(n, t, f, o, e) LE_BITMASK(32, n, t, f, o, e)
122 #define LE64_BITMASK(n, t, f, o, e) LE_BITMASK(64, n, t, f, o, e)
127 /* One unused slot for now: */
128 __u8 bits_per_field[6];
129 __le64 field_offset[6];
132 /* Btree keys - all units are in sectors */
136 * Word order matches machine byte order - btree code treats a bpos as a
137 * single large integer, for search/comparison purposes
139 * Note that wherever a bpos is embedded in another on disk data
140 * structure, it has to be byte swabbed when reading in metadata that
141 * wasn't written in native endian order:
143 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
147 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
149 __u64 offset; /* Points to end of extent - sectors */
152 #error edit for your odd byteorder.
155 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
160 #define KEY_INODE_MAX ((__u64)~0ULL)
161 #define KEY_OFFSET_MAX ((__u64)~0ULL)
162 #define KEY_SNAPSHOT_MAX ((__u32)~0U)
163 #define KEY_SIZE_MAX ((__u32)~0U)
165 static inline struct bpos SPOS(__u64 inode, __u64 offset, __u32 snapshot)
167 return (struct bpos) {
170 .snapshot = snapshot,
174 #define POS_MIN SPOS(0, 0, 0)
175 #define POS_MAX SPOS(KEY_INODE_MAX, KEY_OFFSET_MAX, 0)
176 #define SPOS_MAX SPOS(KEY_INODE_MAX, KEY_OFFSET_MAX, KEY_SNAPSHOT_MAX)
177 #define POS(_inode, _offset) SPOS(_inode, _offset, 0)
179 /* Empty placeholder struct, for container_of() */
185 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
188 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
192 } __packed __aligned(4);
195 /* Size of combined key and value, in u64s */
198 /* Format of key (0 for format local to btree node) */
199 #if defined(__LITTLE_ENDIAN_BITFIELD)
202 #elif defined (__BIG_ENDIAN_BITFIELD)
203 __u8 needs_whiteout:1,
206 #error edit for your odd byteorder.
209 /* Type of the value */
212 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
215 struct bversion version;
216 __u32 size; /* extent size, in sectors */
218 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
220 __u32 size; /* extent size, in sectors */
221 struct bversion version;
225 } __packed __aligned(8);
230 /* Size of combined key and value, in u64s */
233 /* Format of key (0 for format local to btree node) */
236 * XXX: next incompat on disk format change, switch format and
237 * needs_whiteout - bkey_packed() will be cheaper if format is the high
238 * bits of the bitfield
240 #if defined(__LITTLE_ENDIAN_BITFIELD)
243 #elif defined (__BIG_ENDIAN_BITFIELD)
244 __u8 needs_whiteout:1,
248 /* Type of the value */
253 * We copy bkeys with struct assignment in various places, and while
254 * that shouldn't be done with packed bkeys we can't disallow it in C,
255 * and it's legal to cast a bkey to a bkey_packed - so padding it out
256 * to the same size as struct bkey should hopefully be safest.
258 __u8 pad[sizeof(struct bkey) - 3];
259 } __packed __aligned(8);
266 #define BKEY_U64s (sizeof(struct bkey) / sizeof(__u64))
267 #define BKEY_U64s_MAX U8_MAX
268 #define BKEY_VAL_U64s_MAX (BKEY_U64s_MAX - BKEY_U64s)
270 #define KEY_PACKED_BITS_START 24
272 #define KEY_FORMAT_LOCAL_BTREE 0
273 #define KEY_FORMAT_CURRENT 1
275 enum bch_bkey_fields {
280 BKEY_FIELD_VERSION_HI,
281 BKEY_FIELD_VERSION_LO,
285 #define bkey_format_field(name, field) \
286 [BKEY_FIELD_##name] = (sizeof(((struct bkey *) NULL)->field) * 8)
288 #define BKEY_FORMAT_CURRENT \
289 ((struct bkey_format) { \
290 .key_u64s = BKEY_U64s, \
291 .nr_fields = BKEY_NR_FIELDS, \
292 .bits_per_field = { \
293 bkey_format_field(INODE, p.inode), \
294 bkey_format_field(OFFSET, p.offset), \
295 bkey_format_field(SNAPSHOT, p.snapshot), \
296 bkey_format_field(SIZE, size), \
297 bkey_format_field(VERSION_HI, version.hi), \
298 bkey_format_field(VERSION_LO, version.lo), \
302 /* bkey with inline value */
310 #define POS_KEY(_pos) \
313 .format = KEY_FORMAT_CURRENT, \
317 #define KEY(_inode, _offset, _size) \
320 .format = KEY_FORMAT_CURRENT, \
321 .p = POS(_inode, _offset), \
325 static inline void bkey_init(struct bkey *k)
330 #define bkey_bytes(_k) ((_k)->u64s * sizeof(__u64))
332 #define __BKEY_PADDED(key, pad) \
333 struct bkey_i key; __u64 key ## _pad[pad]
336 * - DELETED keys are used internally to mark keys that should be ignored but
337 * override keys in composition order. Their version number is ignored.
339 * - DISCARDED keys indicate that the data is all 0s because it has been
340 * discarded. DISCARDs may have a version; if the version is nonzero the key
341 * will be persistent, otherwise the key will be dropped whenever the btree
342 * node is rewritten (like DELETED keys).
344 * - ERROR: any read of the data returns a read error, as the data was lost due
345 * to a failing device. Like DISCARDED keys, they can be removed (overridden)
346 * by new writes or cluster-wide GC. Node repair can also overwrite them with
347 * the same or a more recent version number, but not with an older version
350 * - WHITEOUT: for hash table btrees
352 #define BCH_BKEY_TYPES() \
357 x(hash_whiteout, 4) \
362 x(inode_generation, 9) \
371 x(btree_ptr_v2, 18) \
372 x(indirect_inline_data, 19) \
384 x(snapshot_tree, 31) \
385 x(logged_op_truncate, 32) \
386 x(logged_op_finsert, 33)
389 #define x(name, nr) KEY_TYPE_##name = nr,
399 struct bch_whiteout {
412 struct bch_hash_whiteout {
420 /* 128 bits, sufficient for cryptographic MACs: */
424 } __packed __aligned(8);
426 struct bch_backpointer {
431 __u64 bucket_offset:40;
434 } __packed __aligned(8);
441 } __packed __aligned(8);
443 #define LRU_ID_STRIPES (1U << 16)
445 /* Optional/variable size superblock sections: */
447 struct bch_sb_field {
453 #define BCH_SB_FIELDS() \
462 x(journal_seq_blacklist, 8) \
470 #include "alloc_background_format.h"
471 #include "extents_format.h"
472 #include "reflink_format.h"
473 #include "ec_format.h"
474 #include "inode_format.h"
475 #include "dirent_format.h"
476 #include "xattr_format.h"
477 #include "quota_format.h"
478 #include "logged_ops_format.h"
479 #include "snapshot_format.h"
480 #include "subvolume_format.h"
481 #include "sb-counters_format.h"
483 enum bch_sb_field_type {
484 #define x(f, nr) BCH_SB_FIELD_##f = nr,
491 * Most superblock fields are replicated in all device's superblocks - a few are
494 #define BCH_SINGLE_DEVICE_SB_FIELDS \
495 ((1U << BCH_SB_FIELD_journal)| \
496 (1U << BCH_SB_FIELD_journal_v2))
498 /* BCH_SB_FIELD_journal: */
500 struct bch_sb_field_journal {
501 struct bch_sb_field field;
505 struct bch_sb_field_journal_v2 {
506 struct bch_sb_field field;
508 struct bch_sb_field_journal_v2_entry {
514 /* BCH_SB_FIELD_members_v1: */
516 #define BCH_MIN_NR_NBUCKETS (1 << 6)
518 #define BCH_IOPS_MEASUREMENTS() \
524 enum bch_iops_measurement {
525 #define x(t, n) BCH_IOPS_##t = n,
526 BCH_IOPS_MEASUREMENTS()
531 #define BCH_MEMBER_ERROR_TYPES() \
536 enum bch_member_error_type {
537 #define x(t, n) BCH_MEMBER_ERROR_##t = n,
538 BCH_MEMBER_ERROR_TYPES()
545 __le64 nbuckets; /* device size */
546 __le16 first_bucket; /* index of first bucket used */
547 __le16 bucket_size; /* sectors */
549 __le64 last_mount; /* time_t */
553 __le64 errors[BCH_MEMBER_ERROR_NR];
554 __le64 errors_at_reset[BCH_MEMBER_ERROR_NR];
555 __le64 errors_reset_time;
559 #define BCH_MEMBER_V1_BYTES 56
561 LE64_BITMASK(BCH_MEMBER_STATE, struct bch_member, flags, 0, 4)
562 /* 4-14 unused, was TIER, HAS_(META)DATA, REPLACEMENT */
563 LE64_BITMASK(BCH_MEMBER_DISCARD, struct bch_member, flags, 14, 15)
564 LE64_BITMASK(BCH_MEMBER_DATA_ALLOWED, struct bch_member, flags, 15, 20)
565 LE64_BITMASK(BCH_MEMBER_GROUP, struct bch_member, flags, 20, 28)
566 LE64_BITMASK(BCH_MEMBER_DURABILITY, struct bch_member, flags, 28, 30)
567 LE64_BITMASK(BCH_MEMBER_FREESPACE_INITIALIZED,
568 struct bch_member, flags, 30, 31)
571 LE64_BITMASK(BCH_MEMBER_NR_READ_ERRORS, struct bch_member, flags[1], 0, 20);
572 LE64_BITMASK(BCH_MEMBER_NR_WRITE_ERRORS,struct bch_member, flags[1], 20, 40);
575 #define BCH_MEMBER_STATES() \
581 enum bch_member_state {
582 #define x(t, n) BCH_MEMBER_STATE_##t = n,
588 struct bch_sb_field_members_v1 {
589 struct bch_sb_field field;
590 struct bch_member _members[]; //Members are now variable size
593 struct bch_sb_field_members_v2 {
594 struct bch_sb_field field;
595 __le16 member_bytes; //size of single member entry
597 struct bch_member _members[];
600 /* BCH_SB_FIELD_crypt: */
610 #define BCH_KEY_MAGIC \
611 (((__u64) 'b' << 0)|((__u64) 'c' << 8)| \
612 ((__u64) 'h' << 16)|((__u64) '*' << 24)| \
613 ((__u64) '*' << 32)|((__u64) 'k' << 40)| \
614 ((__u64) 'e' << 48)|((__u64) 'y' << 56))
616 struct bch_encrypted_key {
622 * If this field is present in the superblock, it stores an encryption key which
623 * is used encrypt all other data/metadata. The key will normally be encrypted
624 * with the key userspace provides, but if encryption has been turned off we'll
625 * just store the master key unencrypted in the superblock so we can access the
626 * previously encrypted data.
628 struct bch_sb_field_crypt {
629 struct bch_sb_field field;
633 struct bch_encrypted_key key;
636 LE64_BITMASK(BCH_CRYPT_KDF_TYPE, struct bch_sb_field_crypt, flags, 0, 4);
643 /* stored as base 2 log of scrypt params: */
644 LE64_BITMASK(BCH_KDF_SCRYPT_N, struct bch_sb_field_crypt, kdf_flags, 0, 16);
645 LE64_BITMASK(BCH_KDF_SCRYPT_R, struct bch_sb_field_crypt, kdf_flags, 16, 32);
646 LE64_BITMASK(BCH_KDF_SCRYPT_P, struct bch_sb_field_crypt, kdf_flags, 32, 48);
648 /* BCH_SB_FIELD_replicas: */
650 #define BCH_DATA_TYPES() \
663 #define x(t, n) BCH_DATA_##t,
669 static inline bool data_type_is_empty(enum bch_data_type type)
673 case BCH_DATA_need_gc_gens:
674 case BCH_DATA_need_discard:
681 static inline bool data_type_is_hidden(enum bch_data_type type)
685 case BCH_DATA_journal:
692 struct bch_replicas_entry_v0 {
698 struct bch_sb_field_replicas_v0 {
699 struct bch_sb_field field;
700 struct bch_replicas_entry_v0 entries[];
701 } __packed __aligned(8);
703 struct bch_replicas_entry_v1 {
710 #define replicas_entry_bytes(_i) \
711 (offsetof(typeof(*(_i)), devs) + (_i)->nr_devs)
713 struct bch_sb_field_replicas {
714 struct bch_sb_field field;
715 struct bch_replicas_entry_v1 entries[];
716 } __packed __aligned(8);
718 /* BCH_SB_FIELD_disk_groups: */
720 #define BCH_SB_LABEL_SIZE 32
722 struct bch_disk_group {
723 __u8 label[BCH_SB_LABEL_SIZE];
725 } __packed __aligned(8);
727 LE64_BITMASK(BCH_GROUP_DELETED, struct bch_disk_group, flags[0], 0, 1)
728 LE64_BITMASK(BCH_GROUP_DATA_ALLOWED, struct bch_disk_group, flags[0], 1, 6)
729 LE64_BITMASK(BCH_GROUP_PARENT, struct bch_disk_group, flags[0], 6, 24)
731 struct bch_sb_field_disk_groups {
732 struct bch_sb_field field;
733 struct bch_disk_group entries[];
734 } __packed __aligned(8);
737 * On clean shutdown, store btree roots and current journal sequence number in
744 __u8 type; /* designates what this jset holds */
747 struct bkey_i start[0];
751 struct bch_sb_field_clean {
752 struct bch_sb_field field;
755 __le16 _read_clock; /* no longer used */
759 struct jset_entry start[0];
763 struct journal_seq_blacklist_entry {
768 struct bch_sb_field_journal_seq_blacklist {
769 struct bch_sb_field field;
770 struct journal_seq_blacklist_entry start[];
773 struct bch_sb_field_errors {
774 struct bch_sb_field field;
775 struct bch_sb_field_error_entry {
777 __le64 last_error_time;
781 LE64_BITMASK(BCH_SB_ERROR_ENTRY_ID, struct bch_sb_field_error_entry, v, 0, 16);
782 LE64_BITMASK(BCH_SB_ERROR_ENTRY_NR, struct bch_sb_field_error_entry, v, 16, 64);
784 struct bch_sb_field_ext {
785 struct bch_sb_field field;
786 __le64 recovery_passes_required[2];
787 __le64 errors_silent[8];
790 struct bch_sb_field_downgrade_entry {
792 __le64 recovery_passes[2];
794 __le16 errors[] __counted_by(nr_errors);
795 } __packed __aligned(2);
797 struct bch_sb_field_downgrade {
798 struct bch_sb_field field;
799 struct bch_sb_field_downgrade_entry entries[];
805 * New versioning scheme:
806 * One common version number for all on disk data structures - superblock, btree
807 * nodes, journal entries
809 #define BCH_VERSION_MAJOR(_v) ((__u16) ((_v) >> 10))
810 #define BCH_VERSION_MINOR(_v) ((__u16) ((_v) & ~(~0U << 10)))
811 #define BCH_VERSION(_major, _minor) (((_major) << 10)|(_minor) << 0)
814 * field 1: version name
815 * field 2: BCH_VERSION(major, minor)
816 * field 3: recovery passess required on upgrade
818 #define BCH_METADATA_VERSIONS() \
819 x(bkey_renumber, BCH_VERSION(0, 10)) \
820 x(inode_btree_change, BCH_VERSION(0, 11)) \
821 x(snapshot, BCH_VERSION(0, 12)) \
822 x(inode_backpointers, BCH_VERSION(0, 13)) \
823 x(btree_ptr_sectors_written, BCH_VERSION(0, 14)) \
824 x(snapshot_2, BCH_VERSION(0, 15)) \
825 x(reflink_p_fix, BCH_VERSION(0, 16)) \
826 x(subvol_dirent, BCH_VERSION(0, 17)) \
827 x(inode_v2, BCH_VERSION(0, 18)) \
828 x(freespace, BCH_VERSION(0, 19)) \
829 x(alloc_v4, BCH_VERSION(0, 20)) \
830 x(new_data_types, BCH_VERSION(0, 21)) \
831 x(backpointers, BCH_VERSION(0, 22)) \
832 x(inode_v3, BCH_VERSION(0, 23)) \
833 x(unwritten_extents, BCH_VERSION(0, 24)) \
834 x(bucket_gens, BCH_VERSION(0, 25)) \
835 x(lru_v2, BCH_VERSION(0, 26)) \
836 x(fragmentation_lru, BCH_VERSION(0, 27)) \
837 x(no_bps_in_alloc_keys, BCH_VERSION(0, 28)) \
838 x(snapshot_trees, BCH_VERSION(0, 29)) \
839 x(major_minor, BCH_VERSION(1, 0)) \
840 x(snapshot_skiplists, BCH_VERSION(1, 1)) \
841 x(deleted_inodes, BCH_VERSION(1, 2)) \
842 x(rebalance_work, BCH_VERSION(1, 3)) \
843 x(member_seq, BCH_VERSION(1, 4))
845 enum bcachefs_metadata_version {
846 bcachefs_metadata_version_min = 9,
847 #define x(t, n) bcachefs_metadata_version_##t = n,
848 BCH_METADATA_VERSIONS()
850 bcachefs_metadata_version_max
853 static const __maybe_unused
854 unsigned bcachefs_metadata_required_upgrade_below = bcachefs_metadata_version_rebalance_work;
856 #define bcachefs_metadata_version_current (bcachefs_metadata_version_max - 1)
858 #define BCH_SB_SECTOR 8
859 #define BCH_SB_MEMBERS_MAX 64 /* XXX kill */
861 struct bch_sb_layout {
862 __uuid_t magic; /* bcachefs superblock UUID */
864 __u8 sb_max_size_bits; /* base 2 of 512 byte sectors */
867 __le64 sb_offset[61];
868 } __packed __aligned(8);
870 #define BCH_SB_LAYOUT_SECTOR 7
873 * @offset - sector where this sb was written
874 * @version - on disk format version
875 * @version_min - Oldest metadata version this filesystem contains; so we can
876 * safely drop compatibility code and refuse to mount filesystems
878 * @magic - identifies as a bcachefs superblock (BCHFS_MAGIC)
879 * @seq - incremented each time superblock is written
880 * @uuid - used for generating various magic numbers and identifying
881 * member devices, never changes
882 * @user_uuid - user visible UUID, may be changed
883 * @label - filesystem label
884 * @seq - identifies most recent superblock, incremented each time
885 * superblock is written
886 * @features - enabled incompatible features
889 struct bch_csum csum;
896 __u8 label[BCH_SB_LABEL_SIZE];
907 __le32 time_precision;
914 struct bch_sb_layout layout;
916 struct bch_sb_field start[0];
918 } __packed __aligned(8);
922 * BCH_SB_INITALIZED - set on first mount
923 * BCH_SB_CLEAN - did we shut down cleanly? Just a hint, doesn't affect
924 * behaviour of mount/recovery path:
925 * BCH_SB_INODE_32BIT - limit inode numbers to 32 bits
926 * BCH_SB_128_BIT_MACS - 128 bit macs instead of 80
927 * BCH_SB_ENCRYPTION_TYPE - if nonzero encryption is enabled; overrides
928 * DATA/META_CSUM_TYPE. Also indicates encryption
929 * algorithm in use, if/when we get more than one
932 LE16_BITMASK(BCH_SB_BLOCK_SIZE, struct bch_sb, block_size, 0, 16);
934 LE64_BITMASK(BCH_SB_INITIALIZED, struct bch_sb, flags[0], 0, 1);
935 LE64_BITMASK(BCH_SB_CLEAN, struct bch_sb, flags[0], 1, 2);
936 LE64_BITMASK(BCH_SB_CSUM_TYPE, struct bch_sb, flags[0], 2, 8);
937 LE64_BITMASK(BCH_SB_ERROR_ACTION, struct bch_sb, flags[0], 8, 12);
939 LE64_BITMASK(BCH_SB_BTREE_NODE_SIZE, struct bch_sb, flags[0], 12, 28);
941 LE64_BITMASK(BCH_SB_GC_RESERVE, struct bch_sb, flags[0], 28, 33);
942 LE64_BITMASK(BCH_SB_ROOT_RESERVE, struct bch_sb, flags[0], 33, 40);
944 LE64_BITMASK(BCH_SB_META_CSUM_TYPE, struct bch_sb, flags[0], 40, 44);
945 LE64_BITMASK(BCH_SB_DATA_CSUM_TYPE, struct bch_sb, flags[0], 44, 48);
947 LE64_BITMASK(BCH_SB_META_REPLICAS_WANT, struct bch_sb, flags[0], 48, 52);
948 LE64_BITMASK(BCH_SB_DATA_REPLICAS_WANT, struct bch_sb, flags[0], 52, 56);
950 LE64_BITMASK(BCH_SB_POSIX_ACL, struct bch_sb, flags[0], 56, 57);
951 LE64_BITMASK(BCH_SB_USRQUOTA, struct bch_sb, flags[0], 57, 58);
952 LE64_BITMASK(BCH_SB_GRPQUOTA, struct bch_sb, flags[0], 58, 59);
953 LE64_BITMASK(BCH_SB_PRJQUOTA, struct bch_sb, flags[0], 59, 60);
955 LE64_BITMASK(BCH_SB_HAS_ERRORS, struct bch_sb, flags[0], 60, 61);
956 LE64_BITMASK(BCH_SB_HAS_TOPOLOGY_ERRORS,struct bch_sb, flags[0], 61, 62);
958 LE64_BITMASK(BCH_SB_BIG_ENDIAN, struct bch_sb, flags[0], 62, 63);
960 LE64_BITMASK(BCH_SB_STR_HASH_TYPE, struct bch_sb, flags[1], 0, 4);
961 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE_LO,struct bch_sb, flags[1], 4, 8);
962 LE64_BITMASK(BCH_SB_INODE_32BIT, struct bch_sb, flags[1], 8, 9);
964 LE64_BITMASK(BCH_SB_128_BIT_MACS, struct bch_sb, flags[1], 9, 10);
965 LE64_BITMASK(BCH_SB_ENCRYPTION_TYPE, struct bch_sb, flags[1], 10, 14);
968 * Max size of an extent that may require bouncing to read or write
969 * (checksummed, compressed): 64k
971 LE64_BITMASK(BCH_SB_ENCODED_EXTENT_MAX_BITS,
972 struct bch_sb, flags[1], 14, 20);
974 LE64_BITMASK(BCH_SB_META_REPLICAS_REQ, struct bch_sb, flags[1], 20, 24);
975 LE64_BITMASK(BCH_SB_DATA_REPLICAS_REQ, struct bch_sb, flags[1], 24, 28);
977 LE64_BITMASK(BCH_SB_PROMOTE_TARGET, struct bch_sb, flags[1], 28, 40);
978 LE64_BITMASK(BCH_SB_FOREGROUND_TARGET, struct bch_sb, flags[1], 40, 52);
979 LE64_BITMASK(BCH_SB_BACKGROUND_TARGET, struct bch_sb, flags[1], 52, 64);
981 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE_LO,
982 struct bch_sb, flags[2], 0, 4);
983 LE64_BITMASK(BCH_SB_GC_RESERVE_BYTES, struct bch_sb, flags[2], 4, 64);
985 LE64_BITMASK(BCH_SB_ERASURE_CODE, struct bch_sb, flags[3], 0, 16);
986 LE64_BITMASK(BCH_SB_METADATA_TARGET, struct bch_sb, flags[3], 16, 28);
987 LE64_BITMASK(BCH_SB_SHARD_INUMS, struct bch_sb, flags[3], 28, 29);
988 LE64_BITMASK(BCH_SB_INODES_USE_KEY_CACHE,struct bch_sb, flags[3], 29, 30);
989 LE64_BITMASK(BCH_SB_JOURNAL_FLUSH_DELAY,struct bch_sb, flags[3], 30, 62);
990 LE64_BITMASK(BCH_SB_JOURNAL_FLUSH_DISABLED,struct bch_sb, flags[3], 62, 63);
991 LE64_BITMASK(BCH_SB_JOURNAL_RECLAIM_DELAY,struct bch_sb, flags[4], 0, 32);
992 LE64_BITMASK(BCH_SB_JOURNAL_TRANSACTION_NAMES,struct bch_sb, flags[4], 32, 33);
993 LE64_BITMASK(BCH_SB_NOCOW, struct bch_sb, flags[4], 33, 34);
994 LE64_BITMASK(BCH_SB_WRITE_BUFFER_SIZE, struct bch_sb, flags[4], 34, 54);
995 LE64_BITMASK(BCH_SB_VERSION_UPGRADE, struct bch_sb, flags[4], 54, 56);
997 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE_HI,struct bch_sb, flags[4], 56, 60);
998 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE_HI,
999 struct bch_sb, flags[4], 60, 64);
1001 LE64_BITMASK(BCH_SB_VERSION_UPGRADE_COMPLETE,
1002 struct bch_sb, flags[5], 0, 16);
1004 static inline __u64 BCH_SB_COMPRESSION_TYPE(const struct bch_sb *sb)
1006 return BCH_SB_COMPRESSION_TYPE_LO(sb) | (BCH_SB_COMPRESSION_TYPE_HI(sb) << 4);
1009 static inline void SET_BCH_SB_COMPRESSION_TYPE(struct bch_sb *sb, __u64 v)
1011 SET_BCH_SB_COMPRESSION_TYPE_LO(sb, v);
1012 SET_BCH_SB_COMPRESSION_TYPE_HI(sb, v >> 4);
1015 static inline __u64 BCH_SB_BACKGROUND_COMPRESSION_TYPE(const struct bch_sb *sb)
1017 return BCH_SB_BACKGROUND_COMPRESSION_TYPE_LO(sb) |
1018 (BCH_SB_BACKGROUND_COMPRESSION_TYPE_HI(sb) << 4);
1021 static inline void SET_BCH_SB_BACKGROUND_COMPRESSION_TYPE(struct bch_sb *sb, __u64 v)
1023 SET_BCH_SB_BACKGROUND_COMPRESSION_TYPE_LO(sb, v);
1024 SET_BCH_SB_BACKGROUND_COMPRESSION_TYPE_HI(sb, v >> 4);
1030 * journal_seq_blacklist_v3: gates BCH_SB_FIELD_journal_seq_blacklist
1031 * reflink: gates KEY_TYPE_reflink
1032 * inline_data: gates KEY_TYPE_inline_data
1033 * new_siphash: gates BCH_STR_HASH_siphash
1034 * new_extent_overwrite: gates BTREE_NODE_NEW_EXTENT_OVERWRITE
1036 #define BCH_SB_FEATURES() \
1040 x(atomic_nlink, 3) \
1042 x(journal_seq_blacklist_v3, 5) \
1046 x(new_extent_overwrite, 9) \
1047 x(incompressible, 10) \
1048 x(btree_ptr_v2, 11) \
1049 x(extents_above_btree_updates, 12) \
1050 x(btree_updates_journalled, 13) \
1051 x(reflink_inline_data, 14) \
1053 x(journal_no_flush, 16) \
1055 x(extents_across_btree_nodes, 18)
1057 #define BCH_SB_FEATURES_ALWAYS \
1058 ((1ULL << BCH_FEATURE_new_extent_overwrite)| \
1059 (1ULL << BCH_FEATURE_extents_above_btree_updates)|\
1060 (1ULL << BCH_FEATURE_btree_updates_journalled)|\
1061 (1ULL << BCH_FEATURE_alloc_v2)|\
1062 (1ULL << BCH_FEATURE_extents_across_btree_nodes))
1064 #define BCH_SB_FEATURES_ALL \
1065 (BCH_SB_FEATURES_ALWAYS| \
1066 (1ULL << BCH_FEATURE_new_siphash)| \
1067 (1ULL << BCH_FEATURE_btree_ptr_v2)| \
1068 (1ULL << BCH_FEATURE_new_varint)| \
1069 (1ULL << BCH_FEATURE_journal_no_flush))
1071 enum bch_sb_feature {
1072 #define x(f, n) BCH_FEATURE_##f,
1078 #define BCH_SB_COMPAT() \
1080 x(alloc_metadata, 1) \
1081 x(extents_above_btree_updates_done, 2) \
1082 x(bformat_overflow_done, 3)
1084 enum bch_sb_compat {
1085 #define x(f, n) BCH_COMPAT_##f,
1093 #define BCH_VERSION_UPGRADE_OPTS() \
1095 x(incompatible, 1) \
1098 enum bch_version_upgrade_opts {
1099 #define x(t, n) BCH_VERSION_UPGRADE_##t = n,
1100 BCH_VERSION_UPGRADE_OPTS()
1104 #define BCH_REPLICAS_MAX 4U
1106 #define BCH_BKEY_PTRS_MAX 16U
1108 #define BCH_ERROR_ACTIONS() \
1113 enum bch_error_actions {
1114 #define x(t, n) BCH_ON_ERROR_##t = n,
1120 #define BCH_STR_HASH_TYPES() \
1126 enum bch_str_hash_type {
1127 #define x(t, n) BCH_STR_HASH_##t = n,
1128 BCH_STR_HASH_TYPES()
1133 #define BCH_STR_HASH_OPTS() \
1138 enum bch_str_hash_opts {
1139 #define x(t, n) BCH_STR_HASH_OPT_##t = n,
1145 #define BCH_CSUM_TYPES() \
1147 x(crc32c_nonzero, 1) \
1148 x(crc64_nonzero, 2) \
1149 x(chacha20_poly1305_80, 3) \
1150 x(chacha20_poly1305_128, 4) \
1155 enum bch_csum_type {
1156 #define x(t, n) BCH_CSUM_##t = n,
1162 static const __maybe_unused unsigned bch_crc_bytes[] = {
1163 [BCH_CSUM_none] = 0,
1164 [BCH_CSUM_crc32c_nonzero] = 4,
1165 [BCH_CSUM_crc32c] = 4,
1166 [BCH_CSUM_crc64_nonzero] = 8,
1167 [BCH_CSUM_crc64] = 8,
1168 [BCH_CSUM_xxhash] = 8,
1169 [BCH_CSUM_chacha20_poly1305_80] = 10,
1170 [BCH_CSUM_chacha20_poly1305_128] = 16,
1173 static inline _Bool bch2_csum_type_is_encryption(enum bch_csum_type type)
1176 case BCH_CSUM_chacha20_poly1305_80:
1177 case BCH_CSUM_chacha20_poly1305_128:
1184 #define BCH_CSUM_OPTS() \
1190 enum bch_csum_opts {
1191 #define x(t, n) BCH_CSUM_OPT_##t = n,
1197 #define BCH_COMPRESSION_TYPES() \
1203 x(incompressible, 5)
1205 enum bch_compression_type {
1206 #define x(t, n) BCH_COMPRESSION_TYPE_##t = n,
1207 BCH_COMPRESSION_TYPES()
1209 BCH_COMPRESSION_TYPE_NR
1212 #define BCH_COMPRESSION_OPTS() \
1218 enum bch_compression_opts {
1219 #define x(t, n) BCH_COMPRESSION_OPT_##t = n,
1220 BCH_COMPRESSION_OPTS()
1222 BCH_COMPRESSION_OPT_NR
1228 * The various other data structures have their own magic numbers, which are
1229 * xored with the first part of the cache set's UUID
1232 #define BCACHE_MAGIC \
1233 UUID_INIT(0xc68573f6, 0x4e1a, 0x45ca, \
1234 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81)
1235 #define BCHFS_MAGIC \
1236 UUID_INIT(0xc68573f6, 0x66ce, 0x90a9, \
1237 0xd9, 0x6a, 0x60, 0xcf, 0x80, 0x3d, 0xf7, 0xef)
1239 #define BCACHEFS_STATFS_MAGIC 0xca451a4e
1241 #define JSET_MAGIC __cpu_to_le64(0x245235c1a3625032ULL)
1242 #define BSET_MAGIC __cpu_to_le64(0x90135c78b99e07f5ULL)
1244 static inline __le64 __bch2_sb_magic(struct bch_sb *sb)
1248 memcpy(&ret, &sb->uuid, sizeof(ret));
1252 static inline __u64 __jset_magic(struct bch_sb *sb)
1254 return __le64_to_cpu(__bch2_sb_magic(sb) ^ JSET_MAGIC);
1257 static inline __u64 __bset_magic(struct bch_sb *sb)
1259 return __le64_to_cpu(__bch2_sb_magic(sb) ^ BSET_MAGIC);
1264 #define JSET_KEYS_U64s (sizeof(struct jset_entry) / sizeof(__u64))
1266 #define BCH_JSET_ENTRY_TYPES() \
1271 x(blacklist_v2, 4) \
1278 x(write_buffer_keys, 11)
1281 #define x(f, nr) BCH_JSET_ENTRY_##f = nr,
1282 BCH_JSET_ENTRY_TYPES()
1287 static inline bool jset_entry_is_key(struct jset_entry *e)
1290 case BCH_JSET_ENTRY_btree_keys:
1291 case BCH_JSET_ENTRY_btree_root:
1292 case BCH_JSET_ENTRY_overwrite:
1293 case BCH_JSET_ENTRY_write_buffer_keys:
1301 * Journal sequence numbers can be blacklisted: bsets record the max sequence
1302 * number of all the journal entries they contain updates for, so that on
1303 * recovery we can ignore those bsets that contain index updates newer that what
1304 * made it into the journal.
1306 * This means that we can't reuse that journal_seq - we have to skip it, and
1307 * then record that we skipped it so that the next time we crash and recover we
1308 * don't think there was a missing journal entry.
1310 struct jset_entry_blacklist {
1311 struct jset_entry entry;
1315 struct jset_entry_blacklist_v2 {
1316 struct jset_entry entry;
1321 #define BCH_FS_USAGE_TYPES() \
1327 #define x(f, nr) BCH_FS_USAGE_##f = nr,
1328 BCH_FS_USAGE_TYPES()
1333 struct jset_entry_usage {
1334 struct jset_entry entry;
1338 struct jset_entry_data_usage {
1339 struct jset_entry entry;
1341 struct bch_replicas_entry_v1 r;
1344 struct jset_entry_clock {
1345 struct jset_entry entry;
1351 struct jset_entry_dev_usage_type {
1357 struct jset_entry_dev_usage {
1358 struct jset_entry entry;
1362 __le64 _buckets_ec; /* No longer used */
1363 __le64 _buckets_unavailable; /* No longer used */
1365 struct jset_entry_dev_usage_type d[];
1368 static inline unsigned jset_entry_dev_usage_nr_types(struct jset_entry_dev_usage *u)
1370 return (vstruct_bytes(&u->entry) - sizeof(struct jset_entry_dev_usage)) /
1371 sizeof(struct jset_entry_dev_usage_type);
1374 struct jset_entry_log {
1375 struct jset_entry entry;
1377 } __packed __aligned(8);
1380 * On disk format for a journal entry:
1381 * seq is monotonically increasing; every journal entry has its own unique
1384 * last_seq is the oldest journal entry that still has keys the btree hasn't
1385 * flushed to disk yet.
1387 * version is for on disk format changes.
1390 struct bch_csum csum;
1397 __le32 u64s; /* size of d[] in u64s */
1399 __u8 encrypted_start[0];
1401 __le16 _read_clock; /* no longer used */
1402 __le16 _write_clock;
1404 /* Sequence number of oldest dirty journal entry */
1408 struct jset_entry start[0];
1410 } __packed __aligned(8);
1412 LE32_BITMASK(JSET_CSUM_TYPE, struct jset, flags, 0, 4);
1413 LE32_BITMASK(JSET_BIG_ENDIAN, struct jset, flags, 4, 5);
1414 LE32_BITMASK(JSET_NO_FLUSH, struct jset, flags, 5, 6);
1416 #define BCH_JOURNAL_BUCKETS_MIN 8
1420 enum btree_id_flags {
1421 BTREE_ID_EXTENTS = BIT(0),
1422 BTREE_ID_SNAPSHOTS = BIT(1),
1423 BTREE_ID_SNAPSHOT_FIELD = BIT(2),
1424 BTREE_ID_DATA = BIT(3),
1427 #define BCH_BTREE_IDS() \
1428 x(extents, 0, BTREE_ID_EXTENTS|BTREE_ID_SNAPSHOTS|BTREE_ID_DATA,\
1429 BIT_ULL(KEY_TYPE_whiteout)| \
1430 BIT_ULL(KEY_TYPE_error)| \
1431 BIT_ULL(KEY_TYPE_cookie)| \
1432 BIT_ULL(KEY_TYPE_extent)| \
1433 BIT_ULL(KEY_TYPE_reservation)| \
1434 BIT_ULL(KEY_TYPE_reflink_p)| \
1435 BIT_ULL(KEY_TYPE_inline_data)) \
1436 x(inodes, 1, BTREE_ID_SNAPSHOTS, \
1437 BIT_ULL(KEY_TYPE_whiteout)| \
1438 BIT_ULL(KEY_TYPE_inode)| \
1439 BIT_ULL(KEY_TYPE_inode_v2)| \
1440 BIT_ULL(KEY_TYPE_inode_v3)| \
1441 BIT_ULL(KEY_TYPE_inode_generation)) \
1442 x(dirents, 2, BTREE_ID_SNAPSHOTS, \
1443 BIT_ULL(KEY_TYPE_whiteout)| \
1444 BIT_ULL(KEY_TYPE_hash_whiteout)| \
1445 BIT_ULL(KEY_TYPE_dirent)) \
1446 x(xattrs, 3, BTREE_ID_SNAPSHOTS, \
1447 BIT_ULL(KEY_TYPE_whiteout)| \
1448 BIT_ULL(KEY_TYPE_cookie)| \
1449 BIT_ULL(KEY_TYPE_hash_whiteout)| \
1450 BIT_ULL(KEY_TYPE_xattr)) \
1452 BIT_ULL(KEY_TYPE_alloc)| \
1453 BIT_ULL(KEY_TYPE_alloc_v2)| \
1454 BIT_ULL(KEY_TYPE_alloc_v3)| \
1455 BIT_ULL(KEY_TYPE_alloc_v4)) \
1457 BIT_ULL(KEY_TYPE_quota)) \
1459 BIT_ULL(KEY_TYPE_stripe)) \
1460 x(reflink, 7, BTREE_ID_EXTENTS|BTREE_ID_DATA, \
1461 BIT_ULL(KEY_TYPE_reflink_v)| \
1462 BIT_ULL(KEY_TYPE_indirect_inline_data)) \
1463 x(subvolumes, 8, 0, \
1464 BIT_ULL(KEY_TYPE_subvolume)) \
1465 x(snapshots, 9, 0, \
1466 BIT_ULL(KEY_TYPE_snapshot)) \
1468 BIT_ULL(KEY_TYPE_set)) \
1469 x(freespace, 11, BTREE_ID_EXTENTS, \
1470 BIT_ULL(KEY_TYPE_set)) \
1471 x(need_discard, 12, 0, \
1472 BIT_ULL(KEY_TYPE_set)) \
1473 x(backpointers, 13, 0, \
1474 BIT_ULL(KEY_TYPE_backpointer)) \
1475 x(bucket_gens, 14, 0, \
1476 BIT_ULL(KEY_TYPE_bucket_gens)) \
1477 x(snapshot_trees, 15, 0, \
1478 BIT_ULL(KEY_TYPE_snapshot_tree)) \
1479 x(deleted_inodes, 16, BTREE_ID_SNAPSHOT_FIELD, \
1480 BIT_ULL(KEY_TYPE_set)) \
1481 x(logged_ops, 17, 0, \
1482 BIT_ULL(KEY_TYPE_logged_op_truncate)| \
1483 BIT_ULL(KEY_TYPE_logged_op_finsert)) \
1484 x(rebalance_work, 18, BTREE_ID_SNAPSHOT_FIELD, \
1485 BIT_ULL(KEY_TYPE_set)|BIT_ULL(KEY_TYPE_cookie))
1488 #define x(name, nr, ...) BTREE_ID_##name = nr,
1494 #define BTREE_MAX_DEPTH 4U
1501 * On disk a btree node is a list/log of these; within each set the keys are
1508 * Highest journal entry this bset contains keys for.
1509 * If on recovery we don't see that journal entry, this bset is ignored:
1510 * this allows us to preserve the order of all index updates after a
1511 * crash, since the journal records a total order of all index updates
1512 * and anything that didn't make it to the journal doesn't get used.
1518 __le16 u64s; /* count of d[] in u64s */
1520 struct bkey_packed start[0];
1522 } __packed __aligned(8);
1524 LE32_BITMASK(BSET_CSUM_TYPE, struct bset, flags, 0, 4);
1526 LE32_BITMASK(BSET_BIG_ENDIAN, struct bset, flags, 4, 5);
1527 LE32_BITMASK(BSET_SEPARATE_WHITEOUTS,
1528 struct bset, flags, 5, 6);
1530 /* Sector offset within the btree node: */
1531 LE32_BITMASK(BSET_OFFSET, struct bset, flags, 16, 32);
1534 struct bch_csum csum;
1537 /* this flags field is encrypted, unlike bset->flags: */
1540 /* Closed interval: */
1541 struct bpos min_key;
1542 struct bpos max_key;
1543 struct bch_extent_ptr _ptr; /* not used anymore */
1544 struct bkey_format format;
1555 } __packed __aligned(8);
1557 LE64_BITMASK(BTREE_NODE_ID_LO, struct btree_node, flags, 0, 4);
1558 LE64_BITMASK(BTREE_NODE_LEVEL, struct btree_node, flags, 4, 8);
1559 LE64_BITMASK(BTREE_NODE_NEW_EXTENT_OVERWRITE,
1560 struct btree_node, flags, 8, 9);
1561 LE64_BITMASK(BTREE_NODE_ID_HI, struct btree_node, flags, 9, 25);
1563 LE64_BITMASK(BTREE_NODE_SEQ, struct btree_node, flags, 32, 64);
1565 static inline __u64 BTREE_NODE_ID(struct btree_node *n)
1567 return BTREE_NODE_ID_LO(n) | (BTREE_NODE_ID_HI(n) << 4);
1570 static inline void SET_BTREE_NODE_ID(struct btree_node *n, __u64 v)
1572 SET_BTREE_NODE_ID_LO(n, v);
1573 SET_BTREE_NODE_ID_HI(n, v >> 4);
1576 struct btree_node_entry {
1577 struct bch_csum csum;
1587 } __packed __aligned(8);
1589 #endif /* _BCACHEFS_FORMAT_H */