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->c.lock.state.seq >> 1;
33 static inline struct btree *btree_node_parent(struct btree_iter *iter,
36 return btree_iter_node(iter, b->c.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 #define trans_for_each_iter_all(_trans, _iter) \
52 for (_iter = (_trans)->iters; \
53 _iter < (_trans)->iters + (_trans)->nr_iters; \
56 static inline struct btree_iter *
57 __trans_next_iter(struct btree_trans *trans, unsigned idx)
59 EBUG_ON(idx < trans->nr_iters && trans->iters[idx].idx != idx);
61 for (; idx < trans->nr_iters; idx++)
62 if (trans->iters_linked & (1ULL << idx))
63 return &trans->iters[idx];
68 #define trans_for_each_iter(_trans, _iter) \
69 for (_iter = __trans_next_iter((_trans), 0); \
71 _iter = __trans_next_iter((_trans), (_iter)->idx + 1))
73 static inline bool __iter_has_node(const struct btree_iter *iter,
74 const struct btree *b)
76 return iter->l[b->c.level].b == b &&
77 btree_node_lock_seq_matches(iter, b, b->c.level);
80 static inline struct btree_iter *
81 __trans_next_iter_with_node(struct btree_trans *trans, struct btree *b,
84 struct btree_iter *iter = __trans_next_iter(trans, idx);
86 while (iter && !__iter_has_node(iter, b))
87 iter = __trans_next_iter(trans, iter->idx + 1);
92 #define trans_for_each_iter_with_node(_trans, _b, _iter) \
93 for (_iter = __trans_next_iter_with_node((_trans), (_b), 0); \
95 _iter = __trans_next_iter_with_node((_trans), (_b), \
98 #ifdef CONFIG_BCACHEFS_DEBUG
99 void bch2_btree_trans_verify_iters(struct btree_trans *, struct btree *);
100 void bch2_btree_trans_verify_locks(struct btree_trans *);
102 static inline void bch2_btree_trans_verify_iters(struct btree_trans *trans,
104 static inline void bch2_btree_trans_verify_locks(struct btree_trans *iter) {}
107 void bch2_btree_iter_fix_key_modified(struct btree_iter *, struct btree *,
108 struct bkey_packed *);
109 void bch2_btree_node_iter_fix(struct btree_iter *, struct btree *,
110 struct btree_node_iter *, struct bkey_packed *,
113 bool bch2_btree_iter_relock(struct btree_iter *, bool);
114 bool bch2_trans_relock(struct btree_trans *);
115 void bch2_trans_unlock(struct btree_trans *);
117 bool __bch2_btree_iter_upgrade(struct btree_iter *, unsigned);
118 bool __bch2_btree_iter_upgrade_nounlock(struct btree_iter *, unsigned);
120 static inline bool bch2_btree_iter_upgrade(struct btree_iter *iter,
121 unsigned new_locks_want)
123 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
125 return iter->locks_want < new_locks_want
126 ? (!iter->trans->nounlock
127 ? __bch2_btree_iter_upgrade(iter, new_locks_want)
128 : __bch2_btree_iter_upgrade_nounlock(iter, new_locks_want))
129 : iter->uptodate <= BTREE_ITER_NEED_PEEK;
132 void __bch2_btree_iter_downgrade(struct btree_iter *, unsigned);
134 static inline void bch2_btree_iter_downgrade(struct btree_iter *iter)
136 if (iter->locks_want > (iter->flags & BTREE_ITER_INTENT) ? 1 : 0)
137 __bch2_btree_iter_downgrade(iter, 0);
140 void bch2_trans_downgrade(struct btree_trans *);
142 void bch2_btree_iter_node_replace(struct btree_iter *, struct btree *);
143 void bch2_btree_iter_node_drop(struct btree_iter *, struct btree *);
145 void bch2_btree_iter_reinit_node(struct btree_iter *, struct btree *);
147 int __must_check __bch2_btree_iter_traverse(struct btree_iter *);
149 static inline int __must_check
150 bch2_btree_iter_traverse(struct btree_iter *iter)
152 return iter->uptodate >= BTREE_ITER_NEED_RELOCK
153 ? __bch2_btree_iter_traverse(iter)
157 int bch2_btree_iter_traverse_all(struct btree_trans *);
159 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
160 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
162 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
163 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
165 struct bkey_s_c bch2_btree_iter_peek_with_updates(struct btree_iter *);
166 struct bkey_s_c bch2_btree_iter_next_with_updates(struct btree_iter *);
168 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
169 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
171 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
172 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
174 struct bkey_s_c bch2_btree_iter_peek_cached(struct btree_iter *);
176 void bch2_btree_iter_set_pos_same_leaf(struct btree_iter *, struct bpos);
177 void __bch2_btree_iter_set_pos(struct btree_iter *, struct bpos, bool);
178 void bch2_btree_iter_set_pos(struct btree_iter *, struct bpos);
180 static inline int btree_iter_cmp(const struct btree_iter *l,
181 const struct btree_iter *r)
183 return cmp_int(l->btree_id, r->btree_id) ?:
184 -cmp_int(btree_iter_type(l), btree_iter_type(r)) ?:
185 bkey_cmp(l->pos, r->pos);
189 * Unlocks before scheduling
190 * Note: does not revalidate iterator
192 static inline int bch2_trans_cond_resched(struct btree_trans *trans)
194 if (need_resched() || race_fault()) {
195 bch2_trans_unlock(trans);
197 return bch2_trans_relock(trans) ? 0 : -EINTR;
203 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
204 _locks_want, _depth, _flags, _b) \
205 for (iter = bch2_trans_get_node_iter((_trans), (_btree_id), \
206 _start, _locks_want, _depth, _flags), \
207 _b = bch2_btree_iter_peek_node(_iter); \
209 (_b) = bch2_btree_iter_next_node(_iter))
211 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
213 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
216 static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
219 if ((flags & BTREE_ITER_TYPE) == BTREE_ITER_CACHED)
220 return bch2_btree_iter_peek_cached(iter);
222 return flags & BTREE_ITER_SLOTS
223 ? bch2_btree_iter_peek_slot(iter)
224 : bch2_btree_iter_peek(iter);
227 static inline struct bkey_s_c __bch2_btree_iter_next(struct btree_iter *iter,
230 return flags & BTREE_ITER_SLOTS
231 ? bch2_btree_iter_next_slot(iter)
232 : bch2_btree_iter_next(iter);
235 static inline int bkey_err(struct bkey_s_c k)
237 return PTR_ERR_OR_ZERO(k.k);
240 #define for_each_btree_key(_trans, _iter, _btree_id, \
241 _start, _flags, _k, _ret) \
242 for ((_ret) = PTR_ERR_OR_ZERO((_iter) = \
243 bch2_trans_get_iter((_trans), (_btree_id), \
244 (_start), (_flags))) ?: \
245 PTR_ERR_OR_ZERO(((_k) = \
246 __bch2_btree_iter_peek(_iter, _flags)).k); \
248 (_ret) = PTR_ERR_OR_ZERO(((_k) = \
249 __bch2_btree_iter_next(_iter, _flags)).k))
251 #define for_each_btree_key_continue(_iter, _flags, _k, _ret) \
252 for ((_k) = __bch2_btree_iter_peek(_iter, _flags); \
253 !((_ret) = bkey_err(_k)) && (_k).k; \
254 (_k) = __bch2_btree_iter_next(_iter, _flags))
256 /* new multiple iterator interface: */
258 int bch2_trans_iter_put(struct btree_trans *, struct btree_iter *);
259 int bch2_trans_iter_free(struct btree_trans *, struct btree_iter *);
261 void bch2_trans_unlink_iters(struct btree_trans *);
263 struct btree_iter *__bch2_trans_get_iter(struct btree_trans *, enum btree_id,
264 struct bpos, unsigned);
266 static inline struct btree_iter *
267 bch2_trans_get_iter(struct btree_trans *trans, enum btree_id btree_id,
268 struct bpos pos, unsigned flags)
270 struct btree_iter *iter =
271 __bch2_trans_get_iter(trans, btree_id, pos, flags);
274 iter->ip_allocated = _THIS_IP_;
278 struct btree_iter *__bch2_trans_copy_iter(struct btree_trans *,
279 struct btree_iter *);
280 static inline struct btree_iter *
281 bch2_trans_copy_iter(struct btree_trans *trans, struct btree_iter *src)
283 struct btree_iter *iter =
284 __bch2_trans_copy_iter(trans, src);
287 iter->ip_allocated = _THIS_IP_;
292 struct btree_iter *bch2_trans_get_node_iter(struct btree_trans *,
293 enum btree_id, struct bpos,
294 unsigned, unsigned, unsigned);
296 #define TRANS_RESET_NOTRAVERSE (1 << 0)
298 void bch2_trans_reset(struct btree_trans *, unsigned);
300 static inline void bch2_trans_begin(struct btree_trans *trans)
302 return bch2_trans_reset(trans, 0);
305 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
306 void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
307 int bch2_trans_exit(struct btree_trans *);
309 void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
311 void bch2_fs_btree_iter_exit(struct bch_fs *);
312 int bch2_fs_btree_iter_init(struct bch_fs *);
314 #endif /* _BCACHEFS_BTREE_ITER_H */