]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bkey_methods.h
Makefile: detect rst2man
[bcachefs-tools-debian] / libbcachefs / bkey_methods.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BKEY_METHODS_H
3 #define _BCACHEFS_BKEY_METHODS_H
4
5 #include "bkey.h"
6
7 struct bch_fs;
8 struct btree;
9 struct bkey;
10 enum btree_node_type;
11
12 extern const char * const bch2_bkey_types[];
13
14 struct bkey_ops {
15         /* Returns reason for being invalid if invalid, else NULL: */
16         const char *    (*key_invalid)(const struct bch_fs *,
17                                        struct bkey_s_c);
18         void            (*val_to_text)(struct printbuf *, struct bch_fs *,
19                                        struct bkey_s_c);
20         void            (*swab)(struct bkey_s);
21         bool            (*key_normalize)(struct bch_fs *, struct bkey_s);
22         bool            (*key_merge)(struct bch_fs *, struct bkey_s, struct bkey_s_c);
23         void            (*compat)(enum btree_id id, unsigned version,
24                                   unsigned big_endian, int write,
25                                   struct bkey_s);
26 };
27
28 extern const struct bkey_ops bch2_bkey_ops[];
29
30 const char *bch2_bkey_val_invalid(struct bch_fs *, struct bkey_s_c);
31 const char *__bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
32                                 enum btree_node_type);
33 const char *bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
34                               enum btree_node_type);
35 const char *bch2_bkey_in_btree_node(struct btree *, struct bkey_s_c);
36
37 void bch2_bkey_debugcheck(struct bch_fs *, struct btree *, struct bkey_s_c);
38
39 void bch2_bpos_to_text(struct printbuf *, struct bpos);
40 void bch2_bkey_to_text(struct printbuf *, const struct bkey *);
41 void bch2_val_to_text(struct printbuf *, struct bch_fs *,
42                       struct bkey_s_c);
43 void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *,
44                            struct bkey_s_c);
45
46 void bch2_bkey_swab_val(struct bkey_s);
47
48 bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s);
49
50 static inline bool bch2_bkey_maybe_mergable(const struct bkey *l, const struct bkey *r)
51 {
52         return l->type == r->type &&
53                 !bversion_cmp(l->version, r->version) &&
54                 !bpos_cmp(l->p, bkey_start_pos(r)) &&
55                 (u64) l->size + r->size <= KEY_SIZE_MAX &&
56                 bch2_bkey_ops[l->type].key_merge &&
57                 !bch2_key_merging_disabled;
58 }
59
60 bool bch2_bkey_merge(struct bch_fs *, struct bkey_s, struct bkey_s_c);
61
62 void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int);
63
64 void __bch2_bkey_compat(unsigned, enum btree_id, unsigned, unsigned,
65                         int, struct bkey_format *, struct bkey_packed *);
66
67 static inline void bch2_bkey_compat(unsigned level, enum btree_id btree_id,
68                                unsigned version, unsigned big_endian,
69                                int write,
70                                struct bkey_format *f,
71                                struct bkey_packed *k)
72 {
73         if (version < bcachefs_metadata_version_current ||
74             big_endian != CPU_BIG_ENDIAN)
75                 __bch2_bkey_compat(level, btree_id, version,
76                                    big_endian, write, f, k);
77
78 }
79
80 #endif /* _BCACHEFS_BKEY_METHODS_H */