1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BKEY_METHODS_H
3 #define _BCACHEFS_BKEY_METHODS_H
13 extern const char * const bch2_bkey_types[];
14 extern const struct bkey_ops bch2_bkey_null_ops;
17 * key_invalid: checks validity of @k, returns 0 if good or -EINVAL if bad. If
18 * invalid, entire key will be deleted.
20 * When invalid, error string is returned via @err. @rw indicates whether key is
21 * being read or written; more aggressive checks can be enabled when rw == WRITE.
24 int (*key_invalid)(struct bch_fs *c, struct bkey_s_c k,
25 enum bkey_invalid_flags flags, struct printbuf *err);
26 void (*val_to_text)(struct printbuf *, struct bch_fs *,
28 void (*swab)(struct bkey_s);
29 bool (*key_normalize)(struct bch_fs *, struct bkey_s);
30 bool (*key_merge)(struct bch_fs *, struct bkey_s, struct bkey_s_c);
31 int (*trans_trigger)(struct btree_trans *, enum btree_id, unsigned,
32 struct bkey_s_c, struct bkey_i *, unsigned);
33 int (*atomic_trigger)(struct btree_trans *, enum btree_id, unsigned,
34 struct bkey_s_c, struct bkey_s_c, unsigned);
35 void (*compat)(enum btree_id id, unsigned version,
36 unsigned big_endian, int write,
39 /* Size of value type when first created: */
40 unsigned min_val_size;
43 extern const struct bkey_ops bch2_bkey_ops[];
45 static inline const struct bkey_ops *bch2_bkey_type_ops(enum bch_bkey_type type)
47 return likely(type < KEY_TYPE_MAX)
48 ? &bch2_bkey_ops[type]
49 : &bch2_bkey_null_ops;
52 int bch2_bkey_val_invalid(struct bch_fs *, struct bkey_s_c,
53 enum bkey_invalid_flags, struct printbuf *);
54 int __bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c, enum btree_node_type,
55 enum bkey_invalid_flags, struct printbuf *);
56 int bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c, enum btree_node_type,
57 enum bkey_invalid_flags, struct printbuf *);
58 int bch2_bkey_in_btree_node(struct bch_fs *, struct btree *,
59 struct bkey_s_c, struct printbuf *);
61 void bch2_bpos_to_text(struct printbuf *, struct bpos);
62 void bch2_bkey_to_text(struct printbuf *, const struct bkey *);
63 void bch2_val_to_text(struct printbuf *, struct bch_fs *,
65 void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *,
68 void bch2_bkey_swab_val(struct bkey_s);
70 bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s);
72 static inline bool bch2_bkey_maybe_mergable(const struct bkey *l, const struct bkey *r)
74 return l->type == r->type &&
75 !bversion_cmp(l->version, r->version) &&
76 bpos_eq(l->p, bkey_start_pos(r));
79 bool bch2_bkey_merge(struct bch_fs *, struct bkey_s, struct bkey_s_c);
81 static inline int bch2_mark_key(struct btree_trans *trans,
82 enum btree_id btree, unsigned level,
83 struct bkey_s_c old, struct bkey_s_c new,
86 const struct bkey_ops *ops = bch2_bkey_type_ops(old.k->type ?: new.k->type);
88 return ops->atomic_trigger
89 ? ops->atomic_trigger(trans, btree, level, old, new, flags)
93 enum btree_update_flags {
94 __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE = __BTREE_ITER_FLAGS_END,
95 __BTREE_UPDATE_NOJOURNAL,
96 __BTREE_UPDATE_KEY_CACHE_RECLAIM,
98 __BTREE_TRIGGER_NORUN, /* Don't run triggers at all */
100 __BTREE_TRIGGER_INSERT,
101 __BTREE_TRIGGER_OVERWRITE,
104 __BTREE_TRIGGER_BUCKET_INVALIDATE,
105 __BTREE_TRIGGER_NOATOMIC,
108 #define BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE (1U << __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE)
109 #define BTREE_UPDATE_NOJOURNAL (1U << __BTREE_UPDATE_NOJOURNAL)
110 #define BTREE_UPDATE_KEY_CACHE_RECLAIM (1U << __BTREE_UPDATE_KEY_CACHE_RECLAIM)
112 #define BTREE_TRIGGER_NORUN (1U << __BTREE_TRIGGER_NORUN)
114 #define BTREE_TRIGGER_INSERT (1U << __BTREE_TRIGGER_INSERT)
115 #define BTREE_TRIGGER_OVERWRITE (1U << __BTREE_TRIGGER_OVERWRITE)
117 #define BTREE_TRIGGER_GC (1U << __BTREE_TRIGGER_GC)
118 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE)
119 #define BTREE_TRIGGER_NOATOMIC (1U << __BTREE_TRIGGER_NOATOMIC)
121 static inline int bch2_trans_mark_key(struct btree_trans *trans,
122 enum btree_id btree_id, unsigned level,
123 struct bkey_s_c old, struct bkey_i *new,
126 const struct bkey_ops *ops = bch2_bkey_type_ops(old.k->type ?: new->k.type);
128 return ops->trans_trigger
129 ? ops->trans_trigger(trans, btree_id, level, old, new, flags)
133 static inline int bch2_trans_mark_old(struct btree_trans *trans,
134 enum btree_id btree_id, unsigned level,
135 struct bkey_s_c old, unsigned flags)
137 struct bkey_i deleted;
139 bkey_init(&deleted.k);
140 deleted.k.p = old.k->p;
142 return bch2_trans_mark_key(trans, btree_id, level, old, &deleted,
143 BTREE_TRIGGER_OVERWRITE|flags);
146 static inline int bch2_trans_mark_new(struct btree_trans *trans,
147 enum btree_id btree_id, unsigned level,
148 struct bkey_i *new, unsigned flags)
150 struct bkey_i deleted;
152 bkey_init(&deleted.k);
153 deleted.k.p = new->k.p;
155 return bch2_trans_mark_key(trans, btree_id, level, bkey_i_to_s_c(&deleted), new,
156 BTREE_TRIGGER_INSERT|flags);
159 void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int);
161 void __bch2_bkey_compat(unsigned, enum btree_id, unsigned, unsigned,
162 int, struct bkey_format *, struct bkey_packed *);
164 static inline void bch2_bkey_compat(unsigned level, enum btree_id btree_id,
165 unsigned version, unsigned big_endian,
167 struct bkey_format *f,
168 struct bkey_packed *k)
170 if (version < bcachefs_metadata_version_current ||
171 big_endian != CPU_BIG_ENDIAN)
172 __bch2_bkey_compat(level, btree_id, version,
173 big_endian, write, f, k);
177 #endif /* _BCACHEFS_BKEY_METHODS_H */