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 static inline struct btree_iter *
52 __trans_next_iter(struct btree_trans *trans, unsigned idx)
54 u64 l = trans->iters_linked >> idx;
59 EBUG_ON(trans->iters[idx].idx != idx);
60 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->c.level].b == b &&
72 btree_node_lock_seq_matches(iter, b, b->c.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_trans_verify_iters(struct btree_trans *, struct btree *);
95 void bch2_btree_trans_verify_locks(struct btree_trans *);
97 static inline void bch2_btree_trans_verify_iters(struct btree_trans *trans,
99 static inline void bch2_btree_trans_verify_locks(struct btree_trans *iter) {}
102 void bch2_btree_iter_fix_key_modified(struct btree_iter *, struct btree *,
103 struct bkey_packed *);
104 void bch2_btree_node_iter_fix(struct btree_iter *, struct btree *,
105 struct btree_node_iter *, struct bkey_packed *,
108 bool bch2_btree_iter_relock(struct btree_iter *, bool);
109 bool bch2_trans_relock(struct btree_trans *);
110 void bch2_trans_unlock(struct btree_trans *);
112 bool __bch2_btree_iter_upgrade(struct btree_iter *, unsigned);
113 bool __bch2_btree_iter_upgrade_nounlock(struct btree_iter *, unsigned);
115 static inline bool bch2_btree_iter_upgrade(struct btree_iter *iter,
116 unsigned new_locks_want)
118 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
120 return iter->locks_want < new_locks_want
121 ? (!iter->trans->nounlock
122 ? __bch2_btree_iter_upgrade(iter, new_locks_want)
123 : __bch2_btree_iter_upgrade_nounlock(iter, new_locks_want))
124 : iter->uptodate <= BTREE_ITER_NEED_PEEK;
127 void __bch2_btree_iter_downgrade(struct btree_iter *, unsigned);
129 static inline void bch2_btree_iter_downgrade(struct btree_iter *iter)
131 if (iter->locks_want > (iter->flags & BTREE_ITER_INTENT) ? 1 : 0)
132 __bch2_btree_iter_downgrade(iter, 0);
135 void bch2_trans_downgrade(struct btree_trans *);
137 void bch2_btree_iter_node_replace(struct btree_iter *, struct btree *);
138 void bch2_btree_iter_node_drop(struct btree_iter *, struct btree *);
140 void bch2_btree_iter_reinit_node(struct btree_iter *, struct btree *);
142 int __must_check __bch2_btree_iter_traverse(struct btree_iter *);
144 static inline int __must_check
145 bch2_btree_iter_traverse(struct btree_iter *iter)
147 return iter->uptodate >= BTREE_ITER_NEED_RELOCK
148 ? __bch2_btree_iter_traverse(iter)
152 int bch2_btree_iter_traverse_all(struct btree_trans *);
154 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
155 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
157 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
158 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
160 struct bkey_s_c bch2_btree_iter_peek_with_updates(struct btree_iter *);
161 struct bkey_s_c bch2_btree_iter_next_with_updates(struct btree_iter *);
163 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
164 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
166 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
167 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
169 struct bkey_s_c bch2_btree_iter_peek_cached(struct btree_iter *);
171 void bch2_btree_iter_set_pos_same_leaf(struct btree_iter *, struct bpos);
172 void __bch2_btree_iter_set_pos(struct btree_iter *, struct bpos, bool);
173 void bch2_btree_iter_set_pos(struct btree_iter *, struct bpos);
175 /* Sort order for locking btree iterators: */
176 static inline int btree_iter_lock_cmp(const struct btree_iter *l,
177 const struct btree_iter *r)
179 return cmp_int(l->btree_id, r->btree_id) ?:
180 -cmp_int(btree_iter_is_cached(l), btree_iter_is_cached(r)) ?:
181 bkey_cmp(l->pos, r->pos);
185 * Unlocks before scheduling
186 * Note: does not revalidate iterator
188 static inline int bch2_trans_cond_resched(struct btree_trans *trans)
190 if (need_resched() || race_fault()) {
191 bch2_trans_unlock(trans);
193 return bch2_trans_relock(trans) ? 0 : -EINTR;
199 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
200 _locks_want, _depth, _flags, _b) \
201 for (iter = bch2_trans_get_node_iter((_trans), (_btree_id), \
202 _start, _locks_want, _depth, _flags), \
203 _b = bch2_btree_iter_peek_node(_iter); \
205 (_b) = bch2_btree_iter_next_node(_iter))
207 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
209 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
212 static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
215 if ((flags & BTREE_ITER_TYPE) == BTREE_ITER_CACHED)
216 return bch2_btree_iter_peek_cached(iter);
218 return flags & BTREE_ITER_SLOTS
219 ? bch2_btree_iter_peek_slot(iter)
220 : bch2_btree_iter_peek(iter);
223 static inline struct bkey_s_c __bch2_btree_iter_next(struct btree_iter *iter,
226 return flags & BTREE_ITER_SLOTS
227 ? bch2_btree_iter_next_slot(iter)
228 : bch2_btree_iter_next(iter);
231 static inline int bkey_err(struct bkey_s_c k)
233 return PTR_ERR_OR_ZERO(k.k);
236 #define for_each_btree_key(_trans, _iter, _btree_id, \
237 _start, _flags, _k, _ret) \
238 for ((_iter) = bch2_trans_get_iter((_trans), (_btree_id), \
239 (_start), (_flags)), \
240 (_ret) = PTR_ERR_OR_ZERO(((_k) = \
241 __bch2_btree_iter_peek(_iter, _flags)).k); \
243 (_ret) = PTR_ERR_OR_ZERO(((_k) = \
244 __bch2_btree_iter_next(_iter, _flags)).k))
246 #define for_each_btree_key_continue(_iter, _flags, _k, _ret) \
247 for ((_k) = __bch2_btree_iter_peek(_iter, _flags); \
248 !((_ret) = bkey_err(_k)) && (_k).k; \
249 (_k) = __bch2_btree_iter_next(_iter, _flags))
251 /* new multiple iterator interface: */
253 int bch2_trans_iter_put(struct btree_trans *, struct btree_iter *);
254 int bch2_trans_iter_free(struct btree_trans *, struct btree_iter *);
256 void bch2_trans_unlink_iters(struct btree_trans *);
258 struct btree_iter *__bch2_trans_get_iter(struct btree_trans *, enum btree_id,
259 struct bpos, unsigned);
261 static inline struct btree_iter *
262 bch2_trans_get_iter(struct btree_trans *trans, enum btree_id btree_id,
263 struct bpos pos, unsigned flags)
265 struct btree_iter *iter =
266 __bch2_trans_get_iter(trans, btree_id, pos, flags);
267 iter->ip_allocated = _THIS_IP_;
271 struct btree_iter *__bch2_trans_copy_iter(struct btree_trans *,
272 struct btree_iter *);
273 static inline struct btree_iter *
274 bch2_trans_copy_iter(struct btree_trans *trans, struct btree_iter *src)
276 struct btree_iter *iter =
277 __bch2_trans_copy_iter(trans, src);
279 iter->ip_allocated = _THIS_IP_;
283 struct btree_iter *bch2_trans_get_node_iter(struct btree_trans *,
284 enum btree_id, struct bpos,
285 unsigned, unsigned, unsigned);
287 #define TRANS_RESET_NOTRAVERSE (1 << 0)
289 void bch2_trans_reset(struct btree_trans *, unsigned);
291 static inline void bch2_trans_begin(struct btree_trans *trans)
293 return bch2_trans_reset(trans, 0);
296 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
297 void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
298 int bch2_trans_exit(struct btree_trans *);
300 void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
302 void bch2_fs_btree_iter_exit(struct bch_fs *);
303 int bch2_fs_btree_iter_init(struct bch_fs *);
305 #endif /* _BCACHEFS_BTREE_ITER_H */