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 btree_trans; 10 struct bkey; 11 enum btree_node_type; 12 13 extern const char * const bch2_bkey_types[]; 14 extern const struct bkey_ops bch2_bkey_null_ops; 15 16 /* 17 * key_invalid: checks validity of @k, returns 0 if good or -EINVAL if bad. If 18 * invalid, entire key will be deleted. 19 * 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. 22 */ 23 struct bkey_ops { 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 *, 27 struct bkey_s_c); 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, 37 struct bkey_s); 38 39 /* Size of value type when first created: */ 40 unsigned min_val_size; 41 }; 42 43 extern const struct bkey_ops bch2_bkey_ops[]; 44 45 static inline const struct bkey_ops *bch2_bkey_type_ops(enum bch_bkey_type type) 46 { 47 return likely(type < KEY_TYPE_MAX) 48 ? &bch2_bkey_ops[type] 49 : &bch2_bkey_null_ops; 50 } 51 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 *); 60 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 *, 64 struct bkey_s_c); 65 void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *, 66 struct bkey_s_c); 67 68 void bch2_bkey_swab_val(struct bkey_s); 69 70 bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s); 71 72 static inline bool bch2_bkey_maybe_mergable(const struct bkey *l, const struct bkey *r) 73 { 74 return l->type == r->type && 75 !bversion_cmp(l->version, r->version) && 76 bpos_eq(l->p, bkey_start_pos(r)); 77 } 78 79 bool bch2_bkey_merge(struct bch_fs *, struct bkey_s, struct bkey_s_c); 80 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, 84 unsigned flags) 85 { 86 const struct bkey_ops *ops = bch2_bkey_type_ops(old.k->type ?: new.k->type); 87 88 return ops->atomic_trigger 89 ? ops->atomic_trigger(trans, btree, level, old, new, flags) 90 : 0; 91 } 92 93 enum btree_update_flags { 94 __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE = __BTREE_ITER_FLAGS_END, 95 __BTREE_UPDATE_NOJOURNAL, 96 __BTREE_UPDATE_PREJOURNAL, 97 __BTREE_UPDATE_KEY_CACHE_RECLAIM, 98 99 __BTREE_TRIGGER_NORUN, /* Don't run triggers at all */ 100 101 __BTREE_TRIGGER_INSERT, 102 __BTREE_TRIGGER_OVERWRITE, 103 104 __BTREE_TRIGGER_GC, 105 __BTREE_TRIGGER_BUCKET_INVALIDATE, 106 __BTREE_TRIGGER_NOATOMIC, 107 }; 108 109 #define BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE (1U << __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE) 110 #define BTREE_UPDATE_NOJOURNAL (1U << __BTREE_UPDATE_NOJOURNAL) 111 #define BTREE_UPDATE_PREJOURNAL (1U << __BTREE_UPDATE_PREJOURNAL) 112 #define BTREE_UPDATE_KEY_CACHE_RECLAIM (1U << __BTREE_UPDATE_KEY_CACHE_RECLAIM) 113 114 #define BTREE_TRIGGER_NORUN (1U << __BTREE_TRIGGER_NORUN) 115 116 #define BTREE_TRIGGER_INSERT (1U << __BTREE_TRIGGER_INSERT) 117 #define BTREE_TRIGGER_OVERWRITE (1U << __BTREE_TRIGGER_OVERWRITE) 118 119 #define BTREE_TRIGGER_GC (1U << __BTREE_TRIGGER_GC) 120 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE) 121 #define BTREE_TRIGGER_NOATOMIC (1U << __BTREE_TRIGGER_NOATOMIC) 122 123 static inline int bch2_trans_mark_key(struct btree_trans *trans, 124 enum btree_id btree_id, unsigned level, 125 struct bkey_s_c old, struct bkey_i *new, 126 unsigned flags) 127 { 128 const struct bkey_ops *ops = bch2_bkey_type_ops(old.k->type ?: new->k.type); 129 130 return ops->trans_trigger 131 ? ops->trans_trigger(trans, btree_id, level, old, new, flags) 132 : 0; 133 } 134 135 static inline int bch2_trans_mark_old(struct btree_trans *trans, 136 enum btree_id btree_id, unsigned level, 137 struct bkey_s_c old, unsigned flags) 138 { 139 struct bkey_i deleted; 140 141 bkey_init(&deleted.k); 142 deleted.k.p = old.k->p; 143 144 return bch2_trans_mark_key(trans, btree_id, level, old, &deleted, 145 BTREE_TRIGGER_OVERWRITE|flags); 146 } 147 148 static inline int bch2_trans_mark_new(struct btree_trans *trans, 149 enum btree_id btree_id, unsigned level, 150 struct bkey_i *new, unsigned flags) 151 { 152 struct bkey_i deleted; 153 154 bkey_init(&deleted.k); 155 deleted.k.p = new->k.p; 156 157 return bch2_trans_mark_key(trans, btree_id, level, bkey_i_to_s_c(&deleted), new, 158 BTREE_TRIGGER_INSERT|flags); 159 } 160 161 void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int); 162 163 void __bch2_bkey_compat(unsigned, enum btree_id, unsigned, unsigned, 164 int, struct bkey_format *, struct bkey_packed *); 165 166 static inline void bch2_bkey_compat(unsigned level, enum btree_id btree_id, 167 unsigned version, unsigned big_endian, 168 int write, 169 struct bkey_format *f, 170 struct bkey_packed *k) 171 { 172 if (version < bcachefs_metadata_version_current || 173 big_endian != CPU_BIG_ENDIAN) 174 __bch2_bkey_compat(level, btree_id, version, 175 big_endian, write, f, k); 176 177 } 178 179 #endif /* _BCACHEFS_BKEY_METHODS_H */ 180