Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 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 | |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 7 | struct bch_fs; |
| 8 | struct btree; |
Kent Overstreet | 880e227 | 2022-03-13 00:26:52 -0500 | [diff] [blame] | 9 | struct btree_trans; |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 10 | struct bkey; |
Kent Overstreet | 26609b6 | 2018-11-01 15:10:01 -0400 | [diff] [blame] | 11 | enum btree_node_type; |
| 12 | |
Kent Overstreet | a4461c8 | 2019-07-16 12:23:04 -0400 | [diff] [blame] | 13 | extern const char * const bch2_bkey_types[]; |
Kent Overstreet | 183e9c4 | 2023-07-06 19:23:27 -0400 | [diff] [blame] | 14 | extern const struct bkey_ops bch2_bkey_null_ops; |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 15 | |
Kent Overstreet | 275c842 | 2022-04-03 21:50:25 -0400 | [diff] [blame] | 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. |
Kent Overstreet | a101957 | 2022-10-22 15:59:53 -0400 | [diff] [blame] | 22 | */ |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 23 | struct bkey_ops { |
Kent Overstreet | b65db75 | 2023-10-24 20:44:36 -0400 | [diff] [blame] | 24 | int (*key_invalid)(struct bch_fs *c, struct bkey_s_c k, |
Kent Overstreet | 65eaf4e | 2024-05-08 18:40:42 -0400 | [diff] [blame] | 25 | enum bch_validate_flags flags, struct printbuf *err); |
Kent Overstreet | 319f9ac | 2018-11-09 01:24:07 -0500 | [diff] [blame] | 26 | void (*val_to_text)(struct printbuf *, struct bch_fs *, |
| 27 | struct bkey_s_c); |
Kent Overstreet | 1f49daf | 2020-02-06 20:15:15 -0500 | [diff] [blame] | 28 | void (*swab)(struct bkey_s); |
Kent Overstreet | 26609b6 | 2018-11-01 15:10:01 -0400 | [diff] [blame] | 29 | bool (*key_normalize)(struct bch_fs *, struct bkey_s); |
Kent Overstreet | 59ba21d | 2021-04-28 23:49:30 -0400 | [diff] [blame] | 30 | bool (*key_merge)(struct bch_fs *, struct bkey_s, struct bkey_s_c); |
Kent Overstreet | f0431c5 | 2023-12-31 21:01:06 -0500 | [diff] [blame] | 31 | int (*trigger)(struct btree_trans *, enum btree_id, unsigned, |
Kent Overstreet | 5dd8c60 | 2024-04-07 18:05:34 -0400 | [diff] [blame] | 32 | struct bkey_s_c, struct bkey_s, |
| 33 | enum btree_iter_update_trigger_flags); |
Kent Overstreet | 39fb298 | 2020-01-07 13:29:32 -0500 | [diff] [blame] | 34 | void (*compat)(enum btree_id id, unsigned version, |
| 35 | unsigned big_endian, int write, |
| 36 | struct bkey_s); |
Kent Overstreet | 174f930 | 2023-04-29 13:24:18 -0400 | [diff] [blame] | 37 | |
| 38 | /* Size of value type when first created: */ |
| 39 | unsigned min_val_size; |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 40 | }; |
| 41 | |
Kent Overstreet | 59ba21d | 2021-04-28 23:49:30 -0400 | [diff] [blame] | 42 | extern const struct bkey_ops bch2_bkey_ops[]; |
| 43 | |
Kent Overstreet | 183e9c4 | 2023-07-06 19:23:27 -0400 | [diff] [blame] | 44 | static inline const struct bkey_ops *bch2_bkey_type_ops(enum bch_bkey_type type) |
| 45 | { |
| 46 | return likely(type < KEY_TYPE_MAX) |
| 47 | ? &bch2_bkey_ops[type] |
| 48 | : &bch2_bkey_null_ops; |
| 49 | } |
| 50 | |
Kent Overstreet | 8726dc9 | 2023-07-06 21:16:10 -0400 | [diff] [blame] | 51 | int bch2_bkey_val_invalid(struct bch_fs *, struct bkey_s_c, |
Kent Overstreet | 65eaf4e | 2024-05-08 18:40:42 -0400 | [diff] [blame] | 52 | enum bch_validate_flags, struct printbuf *); |
Kent Overstreet | 8726dc9 | 2023-07-06 21:16:10 -0400 | [diff] [blame] | 53 | int __bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c, enum btree_node_type, |
Kent Overstreet | 65eaf4e | 2024-05-08 18:40:42 -0400 | [diff] [blame] | 54 | enum bch_validate_flags, struct printbuf *); |
Kent Overstreet | 8726dc9 | 2023-07-06 21:16:10 -0400 | [diff] [blame] | 55 | int bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c, enum btree_node_type, |
Kent Overstreet | 65eaf4e | 2024-05-08 18:40:42 -0400 | [diff] [blame] | 56 | enum bch_validate_flags, struct printbuf *); |
Kent Overstreet | b65db75 | 2023-10-24 20:44:36 -0400 | [diff] [blame] | 57 | int bch2_bkey_in_btree_node(struct bch_fs *, struct btree *, |
| 58 | struct bkey_s_c, struct printbuf *); |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 59 | |
Kent Overstreet | 319f9ac | 2018-11-09 01:24:07 -0500 | [diff] [blame] | 60 | void bch2_bpos_to_text(struct printbuf *, struct bpos); |
| 61 | void bch2_bkey_to_text(struct printbuf *, const struct bkey *); |
Kent Overstreet | 26609b6 | 2018-11-01 15:10:01 -0400 | [diff] [blame] | 62 | void bch2_val_to_text(struct printbuf *, struct bch_fs *, |
Kent Overstreet | 319f9ac | 2018-11-09 01:24:07 -0500 | [diff] [blame] | 63 | struct bkey_s_c); |
| 64 | void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *, |
Kent Overstreet | 26609b6 | 2018-11-01 15:10:01 -0400 | [diff] [blame] | 65 | struct bkey_s_c); |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 66 | |
Kent Overstreet | 1f49daf | 2020-02-06 20:15:15 -0500 | [diff] [blame] | 67 | void bch2_bkey_swab_val(struct bkey_s); |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 68 | |
Kent Overstreet | 26609b6 | 2018-11-01 15:10:01 -0400 | [diff] [blame] | 69 | bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s); |
| 70 | |
Kent Overstreet | 59ba21d | 2021-04-28 23:49:30 -0400 | [diff] [blame] | 71 | static inline bool bch2_bkey_maybe_mergable(const struct bkey *l, const struct bkey *r) |
| 72 | { |
| 73 | return l->type == r->type && |
| 74 | !bversion_cmp(l->version, r->version) && |
Kent Overstreet | e88a75e | 2022-11-24 03:12:22 -0500 | [diff] [blame] | 75 | bpos_eq(l->p, bkey_start_pos(r)); |
Kent Overstreet | 59ba21d | 2021-04-28 23:49:30 -0400 | [diff] [blame] | 76 | } |
| 77 | |
| 78 | bool bch2_bkey_merge(struct bch_fs *, struct bkey_s, struct bkey_s_c); |
Kent Overstreet | 26609b6 | 2018-11-01 15:10:01 -0400 | [diff] [blame] | 79 | |
Kent Overstreet | f0431c5 | 2023-12-31 21:01:06 -0500 | [diff] [blame] | 80 | static inline int bch2_key_trigger(struct btree_trans *trans, |
| 81 | enum btree_id btree, unsigned level, |
| 82 | struct bkey_s_c old, struct bkey_s new, |
Kent Overstreet | 5dd8c60 | 2024-04-07 18:05:34 -0400 | [diff] [blame] | 83 | enum btree_iter_update_trigger_flags flags) |
Kent Overstreet | 880e227 | 2022-03-13 00:26:52 -0500 | [diff] [blame] | 84 | { |
Kent Overstreet | 717296c | 2023-12-27 23:19:09 -0500 | [diff] [blame] | 85 | const struct bkey_ops *ops = bch2_bkey_type_ops(old.k->type ?: new.k->type); |
Kent Overstreet | 880e227 | 2022-03-13 00:26:52 -0500 | [diff] [blame] | 86 | |
Kent Overstreet | f0431c5 | 2023-12-31 21:01:06 -0500 | [diff] [blame] | 87 | return ops->trigger |
| 88 | ? ops->trigger(trans, btree, level, old, new, flags) |
Kent Overstreet | 880e227 | 2022-03-13 00:26:52 -0500 | [diff] [blame] | 89 | : 0; |
| 90 | } |
| 91 | |
Kent Overstreet | f0431c5 | 2023-12-31 21:01:06 -0500 | [diff] [blame] | 92 | static inline int bch2_key_trigger_old(struct btree_trans *trans, |
Kent Overstreet | 5dd8c60 | 2024-04-07 18:05:34 -0400 | [diff] [blame] | 93 | enum btree_id btree_id, unsigned level, |
| 94 | struct bkey_s_c old, |
| 95 | enum btree_iter_update_trigger_flags flags) |
Kent Overstreet | e1b8f5f | 2022-03-31 21:44:55 -0400 | [diff] [blame] | 96 | { |
| 97 | struct bkey_i deleted; |
| 98 | |
| 99 | bkey_init(&deleted.k); |
| 100 | deleted.k.p = old.k->p; |
| 101 | |
Kent Overstreet | f0431c5 | 2023-12-31 21:01:06 -0500 | [diff] [blame] | 102 | return bch2_key_trigger(trans, btree_id, level, old, bkey_i_to_s(&deleted), |
Kent Overstreet | 5dd8c60 | 2024-04-07 18:05:34 -0400 | [diff] [blame] | 103 | BTREE_TRIGGER_overwrite|flags); |
Kent Overstreet | e1b8f5f | 2022-03-31 21:44:55 -0400 | [diff] [blame] | 104 | } |
| 105 | |
Kent Overstreet | f0431c5 | 2023-12-31 21:01:06 -0500 | [diff] [blame] | 106 | static inline int bch2_key_trigger_new(struct btree_trans *trans, |
Kent Overstreet | 5dd8c60 | 2024-04-07 18:05:34 -0400 | [diff] [blame] | 107 | enum btree_id btree_id, unsigned level, |
| 108 | struct bkey_s new, |
| 109 | enum btree_iter_update_trigger_flags flags) |
Kent Overstreet | e1b8f5f | 2022-03-31 21:44:55 -0400 | [diff] [blame] | 110 | { |
| 111 | struct bkey_i deleted; |
| 112 | |
| 113 | bkey_init(&deleted.k); |
Kent Overstreet | 717296c | 2023-12-27 23:19:09 -0500 | [diff] [blame] | 114 | deleted.k.p = new.k->p; |
Kent Overstreet | e1b8f5f | 2022-03-31 21:44:55 -0400 | [diff] [blame] | 115 | |
Kent Overstreet | f0431c5 | 2023-12-31 21:01:06 -0500 | [diff] [blame] | 116 | return bch2_key_trigger(trans, btree_id, level, bkey_i_to_s_c(&deleted), new, |
Kent Overstreet | 5dd8c60 | 2024-04-07 18:05:34 -0400 | [diff] [blame] | 117 | BTREE_TRIGGER_insert|flags); |
Kent Overstreet | e1b8f5f | 2022-03-31 21:44:55 -0400 | [diff] [blame] | 118 | } |
| 119 | |
Kent Overstreet | 26609b6 | 2018-11-01 15:10:01 -0400 | [diff] [blame] | 120 | void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int); |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 121 | |
Kent Overstreet | 39fb298 | 2020-01-07 13:29:32 -0500 | [diff] [blame] | 122 | void __bch2_bkey_compat(unsigned, enum btree_id, unsigned, unsigned, |
| 123 | int, struct bkey_format *, struct bkey_packed *); |
| 124 | |
| 125 | static inline void bch2_bkey_compat(unsigned level, enum btree_id btree_id, |
| 126 | unsigned version, unsigned big_endian, |
| 127 | int write, |
| 128 | struct bkey_format *f, |
| 129 | struct bkey_packed *k) |
| 130 | { |
| 131 | if (version < bcachefs_metadata_version_current || |
| 132 | big_endian != CPU_BIG_ENDIAN) |
| 133 | __bch2_bkey_compat(level, btree_id, version, |
| 134 | big_endian, write, f, k); |
| 135 | |
| 136 | } |
| 137 | |
Kent Overstreet | 1c6fdbd | 2017-03-16 22:18:50 -0800 | [diff] [blame] | 138 | #endif /* _BCACHEFS_BKEY_METHODS_H */ |