1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BTREE_ITER_H
3 #define _BCACHEFS_BTREE_ITER_H
6 #include "btree_types.h"
8 static inline void btree_iter_set_dirty(struct btree_iter *iter,
9 enum btree_iter_uptodate u)
11 iter->uptodate = max_t(unsigned, iter->uptodate, u);
14 static inline struct btree *btree_iter_node(struct btree_iter *iter,
17 return level < BTREE_MAX_DEPTH ? iter->l[level].b : NULL;
20 static inline bool btree_node_lock_seq_matches(const struct btree_iter *iter,
21 const struct btree *b, unsigned level)
24 * We don't compare the low bits of the lock sequence numbers because
25 * @iter might have taken a write lock on @b, and we don't want to skip
26 * the linked iterator if the sequence numbers were equal before taking
27 * that write lock. The lock sequence number is incremented by taking
28 * and releasing write locks and is even when unlocked:
30 return iter->l[level].lock_seq >> 1 == b->lock.state.seq >> 1;
33 static inline struct btree *btree_node_parent(struct btree_iter *iter,
36 return btree_iter_node(iter, b->level + 1);
39 static inline bool btree_trans_has_multiple_iters(const struct btree_trans *trans)
41 return hweight64(trans->iters_linked) > 1;
44 static inline int btree_iter_err(const struct btree_iter *iter)
46 return iter->flags & BTREE_ITER_ERROR ? -EIO : 0;
49 /* Iterate over iters within a transaction: */
51 static inline struct btree_iter *
52 __trans_next_iter(struct btree_trans *trans, unsigned idx)
54 EBUG_ON(idx < trans->nr_iters && trans->iters[idx].idx != idx);
56 for (; idx < trans->nr_iters; idx++)
57 if (trans->iters_linked & (1ULL << idx))
58 return &trans->iters[idx];
63 #define trans_for_each_iter(_trans, _iter) \
64 for (_iter = __trans_next_iter((_trans), 0); \
66 _iter = __trans_next_iter((_trans), (_iter)->idx + 1))
68 static inline bool __iter_has_node(const struct btree_iter *iter,
69 const struct btree *b)
71 return iter->l[b->level].b == b &&
72 btree_node_lock_seq_matches(iter, b, b->level);
75 static inline struct btree_iter *
76 __trans_next_iter_with_node(struct btree_trans *trans, struct btree *b,
79 struct btree_iter *iter = __trans_next_iter(trans, idx);
81 while (iter && !__iter_has_node(iter, b))
82 iter = __trans_next_iter(trans, iter->idx + 1);
87 #define trans_for_each_iter_with_node(_trans, _b, _iter) \
88 for (_iter = __trans_next_iter_with_node((_trans), (_b), 0); \
90 _iter = __trans_next_iter_with_node((_trans), (_b), \
93 #ifdef CONFIG_BCACHEFS_DEBUG
94 void bch2_btree_iter_verify(struct btree_iter *, struct btree *);
95 void bch2_btree_trans_verify_locks(struct btree_trans *);
97 static inline void bch2_btree_iter_verify(struct btree_iter *iter,
99 static inline void bch2_btree_trans_verify_locks(struct btree_trans *iter) {}
102 void bch2_btree_node_iter_fix(struct btree_iter *, struct btree *,
103 struct btree_node_iter *, struct bkey_packed *,
106 bool bch2_trans_relock(struct btree_trans *);
107 void bch2_trans_unlock(struct btree_trans *);
109 bool __bch2_btree_iter_upgrade(struct btree_iter *, unsigned);
110 bool __bch2_btree_iter_upgrade_nounlock(struct btree_iter *, unsigned);
112 static inline bool bch2_btree_iter_upgrade(struct btree_iter *iter,
113 unsigned new_locks_want)
115 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
117 return iter->locks_want < new_locks_want
118 ? (!iter->trans->nounlock
119 ? __bch2_btree_iter_upgrade(iter, new_locks_want)
120 : __bch2_btree_iter_upgrade_nounlock(iter, new_locks_want))
121 : iter->uptodate <= BTREE_ITER_NEED_PEEK;
124 void __bch2_btree_iter_downgrade(struct btree_iter *, unsigned);
126 static inline void bch2_btree_iter_downgrade(struct btree_iter *iter)
128 if (iter->locks_want > (iter->flags & BTREE_ITER_INTENT) ? 1 : 0)
129 __bch2_btree_iter_downgrade(iter, 0);
132 void bch2_btree_iter_node_replace(struct btree_iter *, struct btree *);
133 void bch2_btree_iter_node_drop(struct btree_iter *, struct btree *);
135 void bch2_btree_iter_reinit_node(struct btree_iter *, struct btree *);
137 int __must_check __bch2_btree_iter_traverse(struct btree_iter *);
139 static inline int __must_check
140 bch2_btree_iter_traverse(struct btree_iter *iter)
142 return iter->uptodate >= BTREE_ITER_NEED_RELOCK
143 ? __bch2_btree_iter_traverse(iter)
147 int bch2_btree_iter_traverse_all(struct btree_trans *);
149 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
150 struct btree *bch2_btree_iter_next_node(struct btree_iter *, unsigned);
152 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
153 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
155 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
156 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
158 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
159 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
161 void bch2_btree_iter_set_pos_same_leaf(struct btree_iter *, struct bpos);
162 void bch2_btree_iter_set_pos(struct btree_iter *, struct bpos);
164 static inline struct bpos btree_type_successor(enum btree_id id,
167 if (id == BTREE_ID_INODES) {
170 } else if (!btree_node_type_is_extents(id)) {
171 pos = bkey_successor(pos);
177 static inline struct bpos btree_type_predecessor(enum btree_id id,
180 if (id == BTREE_ID_INODES) {
184 pos = bkey_predecessor(pos);
190 static inline int __btree_iter_cmp(enum btree_id id,
192 const struct btree_iter *r)
194 if (id != r->btree_id)
195 return id < r->btree_id ? -1 : 1;
196 return bkey_cmp(pos, r->pos);
199 static inline int btree_iter_cmp(const struct btree_iter *l,
200 const struct btree_iter *r)
202 return __btree_iter_cmp(l->btree_id, l->pos, r);
206 * Unlocks before scheduling
207 * Note: does not revalidate iterator
209 static inline int bch2_trans_cond_resched(struct btree_trans *trans)
211 if (need_resched() || race_fault()) {
212 bch2_trans_unlock(trans);
214 return bch2_trans_relock(trans) ? 0 : -EINTR;
220 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
221 _locks_want, _depth, _flags, _b) \
222 for (iter = bch2_trans_get_node_iter((_trans), (_btree_id), \
223 _start, _locks_want, _depth, _flags), \
224 _b = bch2_btree_iter_peek_node(_iter); \
226 (_b) = bch2_btree_iter_next_node(_iter, _depth))
228 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
230 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
233 static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
236 return flags & BTREE_ITER_SLOTS
237 ? bch2_btree_iter_peek_slot(iter)
238 : bch2_btree_iter_peek(iter);
241 static inline struct bkey_s_c __bch2_btree_iter_next(struct btree_iter *iter,
244 return flags & BTREE_ITER_SLOTS
245 ? bch2_btree_iter_next_slot(iter)
246 : bch2_btree_iter_next(iter);
249 static inline int bkey_err(struct bkey_s_c k)
251 return PTR_ERR_OR_ZERO(k.k);
254 #define for_each_btree_key(_trans, _iter, _btree_id, \
255 _start, _flags, _k, _ret) \
256 for ((_ret) = PTR_ERR_OR_ZERO((_iter) = \
257 bch2_trans_get_iter((_trans), (_btree_id), \
258 (_start), (_flags))) ?: \
259 PTR_ERR_OR_ZERO(((_k) = \
260 __bch2_btree_iter_peek(_iter, _flags)).k); \
262 (_ret) = PTR_ERR_OR_ZERO(((_k) = \
263 __bch2_btree_iter_next(_iter, _flags)).k))
265 #define for_each_btree_key_continue(_iter, _flags, _k, _ret) \
266 for ((_k) = __bch2_btree_iter_peek(_iter, _flags); \
267 !((_ret) = bkey_err(_k)) && (_k).k; \
268 (_k) = __bch2_btree_iter_next(_iter, _flags))
270 /* new multiple iterator interface: */
272 int bch2_trans_iter_put(struct btree_trans *, struct btree_iter *);
273 int bch2_trans_iter_free(struct btree_trans *, struct btree_iter *);
275 void bch2_trans_unlink_iters(struct btree_trans *);
277 struct btree_iter *bch2_trans_get_iter(struct btree_trans *, enum btree_id,
278 struct bpos, unsigned);
279 struct btree_iter *bch2_trans_copy_iter(struct btree_trans *,
280 struct btree_iter *);
281 struct btree_iter *bch2_trans_get_node_iter(struct btree_trans *,
282 enum btree_id, struct bpos,
283 unsigned, unsigned, unsigned);
285 #define TRANS_RESET_ITERS (1 << 0)
286 #define TRANS_RESET_MEM (1 << 1)
288 void bch2_trans_reset(struct btree_trans *, unsigned);
290 static inline void bch2_trans_begin(struct btree_trans *trans)
292 return bch2_trans_reset(trans, TRANS_RESET_ITERS|TRANS_RESET_MEM);
295 static inline void bch2_trans_begin_updates(struct btree_trans *trans)
297 return bch2_trans_reset(trans, TRANS_RESET_MEM);
300 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
301 void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
302 int bch2_trans_exit(struct btree_trans *);
304 void bch2_fs_btree_iter_exit(struct bch_fs *);
305 int bch2_fs_btree_iter_init(struct bch_fs *);
307 #endif /* _BCACHEFS_BTREE_ITER_H */