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 #include <trace/events/bcachefs.h>
10 static inline void __btree_path_get(struct btree_path *path, bool intent)
13 path->intent_ref += intent;
16 static inline bool __btree_path_put(struct btree_path *path, bool intent)
19 EBUG_ON(!path->intent_ref && intent);
20 path->intent_ref -= intent;
21 return --path->ref == 0;
24 static inline void btree_path_set_dirty(struct btree_path *path,
25 enum btree_path_uptodate u)
27 path->uptodate = max_t(unsigned, path->uptodate, u);
30 static inline struct btree *btree_path_node(struct btree_path *path,
33 return level < BTREE_MAX_DEPTH ? path->l[level].b : NULL;
36 static inline bool btree_node_lock_seq_matches(const struct btree_path *path,
37 const struct btree *b, unsigned level)
40 * We don't compare the low bits of the lock sequence numbers because
41 * @path might have taken a write lock on @b, and we don't want to skip
42 * the linked path if the sequence numbers were equal before taking that
43 * write lock. The lock sequence number is incremented by taking and
44 * releasing write locks and is even when unlocked:
46 return path->l[level].lock_seq >> 1 == b->c.lock.state.seq >> 1;
49 static inline struct btree *btree_node_parent(struct btree_path *path,
52 return btree_path_node(path, b->c.level + 1);
55 /* Iterate over paths within a transaction: */
57 static inline struct btree_path *
58 __trans_next_path(struct btree_trans *trans, unsigned idx)
62 if (idx == BTREE_ITER_MAX)
65 l = trans->paths_allocated >> idx;
70 EBUG_ON(idx >= BTREE_ITER_MAX);
71 EBUG_ON(trans->paths[idx].idx != idx);
72 return &trans->paths[idx];
75 void bch2_btree_path_check_sort(struct btree_trans *, struct btree_path *, int);
77 #define trans_for_each_path(_trans, _path) \
78 for (_path = __trans_next_path((_trans), 0); \
80 _path = __trans_next_path((_trans), (_path)->idx + 1))
82 static inline struct btree_path *next_btree_path(struct btree_trans *trans, struct btree_path *path)
84 unsigned idx = path ? path->sorted_idx + 1 : 0;
86 EBUG_ON(idx > trans->nr_sorted);
88 return idx < trans->nr_sorted
89 ? trans->paths + trans->sorted[idx]
93 static inline struct btree_path *prev_btree_path(struct btree_trans *trans, struct btree_path *path)
95 EBUG_ON(path->sorted_idx >= trans->nr_sorted);
96 return path->sorted_idx
97 ? trans->paths + trans->sorted[path->sorted_idx - 1]
101 #define trans_for_each_path_inorder(_trans, _path, _i) \
103 ((_path) = (_trans)->paths + trans->sorted[_i]), (_i) < (_trans)->nr_sorted;\
106 static inline bool __path_has_node(const struct btree_path *path,
107 const struct btree *b)
109 return path->l[b->c.level].b == b &&
110 btree_node_lock_seq_matches(path, b, b->c.level);
113 static inline struct btree_path *
114 __trans_next_path_with_node(struct btree_trans *trans, struct btree *b,
117 struct btree_path *path = __trans_next_path(trans, idx);
119 while (path && !__path_has_node(path, b))
120 path = __trans_next_path(trans, path->idx + 1);
125 #define trans_for_each_path_with_node(_trans, _b, _path) \
126 for (_path = __trans_next_path_with_node((_trans), (_b), 0); \
128 _path = __trans_next_path_with_node((_trans), (_b), \
131 struct btree_path * __must_check
132 bch2_btree_path_make_mut(struct btree_trans *, struct btree_path *,
133 bool, unsigned long);
134 struct btree_path * __must_check
135 bch2_btree_path_set_pos(struct btree_trans *, struct btree_path *,
136 struct bpos, bool, unsigned long);
137 int __must_check bch2_btree_path_traverse(struct btree_trans *,
138 struct btree_path *, unsigned);
139 struct btree_path *bch2_path_get(struct btree_trans *, enum btree_id, struct bpos,
140 unsigned, unsigned, unsigned, unsigned long);
141 inline struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *, struct bkey *);
143 struct bkey_i *bch2_btree_journal_peek_slot(struct btree_trans *,
144 struct btree_iter *, struct bpos);
146 #ifdef CONFIG_BCACHEFS_DEBUG
147 void bch2_trans_verify_paths(struct btree_trans *);
148 void bch2_trans_verify_locks(struct btree_trans *);
149 void bch2_assert_pos_locked(struct btree_trans *, enum btree_id,
152 static inline void bch2_trans_verify_paths(struct btree_trans *trans) {}
153 static inline void bch2_trans_verify_locks(struct btree_trans *trans) {}
154 static inline void bch2_assert_pos_locked(struct btree_trans *trans, enum btree_id id,
155 struct bpos pos, bool key_cache) {}
158 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
159 struct btree *, struct bkey_packed *);
160 void bch2_btree_node_iter_fix(struct btree_trans *trans, struct btree_path *,
161 struct btree *, struct btree_node_iter *,
162 struct bkey_packed *, unsigned, unsigned);
164 int bch2_btree_path_relock_intent(struct btree_trans *, struct btree_path *);
166 void bch2_path_put(struct btree_trans *, struct btree_path *, bool);
168 int bch2_trans_relock(struct btree_trans *);
169 void bch2_trans_unlock(struct btree_trans *);
171 static inline bool trans_was_restarted(struct btree_trans *trans, u32 restart_count)
173 return restart_count != trans->restart_count;
176 void bch2_trans_verify_not_restarted(struct btree_trans *, u32);
179 static inline int btree_trans_restart_nounlock(struct btree_trans *trans, int err)
182 BUG_ON(!bch2_err_matches(err, BCH_ERR_transaction_restart));
184 trans->restarted = err;
189 static inline int btree_trans_restart(struct btree_trans *trans, int err)
191 btree_trans_restart_nounlock(trans, err);
195 bool bch2_btree_node_upgrade(struct btree_trans *,
196 struct btree_path *, unsigned);
198 bool __bch2_btree_path_upgrade(struct btree_trans *,
199 struct btree_path *, unsigned);
201 static inline bool bch2_btree_path_upgrade(struct btree_trans *trans,
202 struct btree_path *path,
203 unsigned new_locks_want)
205 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
207 return path->locks_want < new_locks_want
208 ? __bch2_btree_path_upgrade(trans, path, new_locks_want)
209 : path->uptodate == BTREE_ITER_UPTODATE;
212 void __bch2_btree_path_downgrade(struct btree_trans *, struct btree_path *, unsigned);
214 static inline void bch2_btree_path_downgrade(struct btree_trans *trans,
215 struct btree_path *path)
217 unsigned new_locks_want = path->level + !!path->intent_ref;
219 if (path->locks_want > new_locks_want)
220 __bch2_btree_path_downgrade(trans, path, new_locks_want);
223 void bch2_trans_downgrade(struct btree_trans *);
225 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
226 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
228 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
229 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
231 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
232 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
234 struct bkey_s_c bch2_btree_iter_peek_upto(struct btree_iter *, struct bpos);
235 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
237 struct bkey_s_c bch2_btree_iter_peek_all_levels(struct btree_iter *);
239 static inline struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *iter)
241 return bch2_btree_iter_peek_upto(iter, SPOS_MAX);
244 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
245 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
247 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
248 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
249 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
251 bool bch2_btree_iter_advance(struct btree_iter *);
252 bool bch2_btree_iter_rewind(struct btree_iter *);
254 static inline void __bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
256 iter->k.type = KEY_TYPE_deleted;
257 iter->k.p.inode = iter->pos.inode = new_pos.inode;
258 iter->k.p.offset = iter->pos.offset = new_pos.offset;
259 iter->k.p.snapshot = iter->pos.snapshot = new_pos.snapshot;
263 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
265 if (unlikely(iter->update_path))
266 bch2_path_put(iter->trans, iter->update_path,
267 iter->flags & BTREE_ITER_INTENT);
268 iter->update_path = NULL;
270 if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
271 new_pos.snapshot = iter->snapshot;
273 __bch2_btree_iter_set_pos(iter, new_pos);
276 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
278 BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
279 iter->pos = bkey_start_pos(&iter->k);
282 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
284 struct bpos pos = iter->pos;
286 iter->snapshot = snapshot;
287 pos.snapshot = snapshot;
288 bch2_btree_iter_set_pos(iter, pos);
291 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
292 void bch2_trans_iter_init(struct btree_trans *, struct btree_iter *,
293 unsigned, struct bpos, unsigned);
294 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
295 enum btree_id, struct bpos,
296 unsigned, unsigned, unsigned);
297 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
299 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
301 if (!iter->trans->restarted)
302 iter->path->preserve = false;
305 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
306 u32 bch2_trans_begin(struct btree_trans *);
308 static inline struct btree *
309 __btree_iter_peek_node_and_restart(struct btree_trans *trans, struct btree_iter *iter)
313 while (b = bch2_btree_iter_peek_node(iter),
314 bch2_err_matches(PTR_ERR_OR_ZERO(b), BCH_ERR_transaction_restart))
315 bch2_trans_begin(trans);
320 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
321 _locks_want, _depth, _flags, _b, _ret) \
322 for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
323 _start, _locks_want, _depth, _flags); \
324 (_b) = __btree_iter_peek_node_and_restart((_trans), &(_iter)),\
325 !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b); \
326 (_b) = bch2_btree_iter_next_node(&(_iter)))
328 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
330 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
331 0, 0, _flags, _b, _ret)
333 static inline int bkey_err(struct bkey_s_c k)
335 return PTR_ERR_OR_ZERO(k.k);
338 static inline struct bkey_s_c bch2_btree_iter_peek_prev_type(struct btree_iter *iter,
341 BUG_ON(flags & BTREE_ITER_ALL_LEVELS);
343 return flags & BTREE_ITER_SLOTS ? bch2_btree_iter_peek_slot(iter) :
344 bch2_btree_iter_peek_prev(iter);
347 static inline struct bkey_s_c bch2_btree_iter_peek_type(struct btree_iter *iter,
350 return flags & BTREE_ITER_ALL_LEVELS ? bch2_btree_iter_peek_all_levels(iter) :
351 flags & BTREE_ITER_SLOTS ? bch2_btree_iter_peek_slot(iter) :
352 bch2_btree_iter_peek(iter);
355 static inline struct bkey_s_c bch2_btree_iter_peek_upto_type(struct btree_iter *iter,
359 if (!(flags & BTREE_ITER_SLOTS))
360 return bch2_btree_iter_peek_upto(iter, end);
362 if (bkey_cmp(iter->pos, end) > 0)
363 return bkey_s_c_null;
365 return bch2_btree_iter_peek_slot(iter);
368 static inline int btree_trans_too_many_iters(struct btree_trans *trans)
370 if (hweight64(trans->paths_allocated) > BTREE_ITER_MAX / 2) {
371 trace_trans_restart_too_many_iters(trans, _THIS_IP_);
372 return btree_trans_restart(trans, BCH_ERR_transaction_restart_too_many_iters);
378 static inline struct bkey_s_c
379 __bch2_btree_iter_peek_and_restart(struct btree_trans *trans,
380 struct btree_iter *iter, unsigned flags)
384 while (btree_trans_too_many_iters(trans) ||
385 (k = bch2_btree_iter_peek_type(iter, flags),
386 bch2_err_matches(bkey_err(k), BCH_ERR_transaction_restart)))
387 bch2_trans_begin(trans);
392 #define lockrestart_do(_trans, _do) \
394 u32 _restart_count; \
398 _restart_count = bch2_trans_begin(_trans); \
400 } while (bch2_err_matches(_ret, BCH_ERR_transaction_restart)); \
403 bch2_trans_verify_not_restarted(_trans, _restart_count);\
409 * nested_lockrestart_do(), nested_commit_do():
411 * These are like lockrestart_do() and commit_do(), with two differences:
413 * - We don't call bch2_trans_begin() unless we had a transaction restart
414 * - We return -BCH_ERR_transaction_restart_nested if we succeeded after a
415 * transaction restart
417 #define nested_lockrestart_do(_trans, _do) \
419 u32 _restart_count, _orig_restart_count; \
422 _restart_count = _orig_restart_count = (_trans)->restart_count; \
424 while (bch2_err_matches(_ret = (_do), BCH_ERR_transaction_restart))\
425 _restart_count = bch2_trans_begin(_trans); \
428 bch2_trans_verify_not_restarted(_trans, _restart_count);\
430 if (!_ret && trans_was_restarted(_trans, _orig_restart_count)) \
431 _ret = -BCH_ERR_transaction_restart_nested; \
436 #define for_each_btree_key2(_trans, _iter, _btree_id, \
437 _start, _flags, _k, _do) \
441 bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
442 (_start), (_flags)); \
445 u32 _restart_count = bch2_trans_begin(_trans); \
446 (_k) = bch2_btree_iter_peek_type(&(_iter), (_flags)); \
452 _ret = bkey_err(_k) ?: (_do); \
453 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
457 bch2_trans_verify_not_restarted(_trans, _restart_count);\
458 if (!bch2_btree_iter_advance(&(_iter))) \
462 bch2_trans_iter_exit((_trans), &(_iter)); \
466 #define for_each_btree_key_reverse(_trans, _iter, _btree_id, \
467 _start, _flags, _k, _do) \
471 bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
472 (_start), (_flags)); \
475 u32 _restart_count = bch2_trans_begin(_trans); \
476 (_k) = bch2_btree_iter_peek_prev_type(&(_iter), (_flags));\
482 _ret = bkey_err(_k) ?: (_do); \
483 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
487 bch2_trans_verify_not_restarted(_trans, _restart_count);\
488 if (!bch2_btree_iter_rewind(&(_iter))) \
492 bch2_trans_iter_exit((_trans), &(_iter)); \
496 #define for_each_btree_key_commit(_trans, _iter, _btree_id, \
497 _start, _iter_flags, _k, \
498 _disk_res, _journal_seq, _commit_flags,\
500 for_each_btree_key2(_trans, _iter, _btree_id, _start, _iter_flags, _k,\
501 (_do) ?: bch2_trans_commit(_trans, (_disk_res),\
502 (_journal_seq), (_commit_flags)))
504 #define for_each_btree_key(_trans, _iter, _btree_id, \
505 _start, _flags, _k, _ret) \
506 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
507 (_start), (_flags)); \
508 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
509 !((_ret) = bkey_err(_k)) && (_k).k; \
510 bch2_btree_iter_advance(&(_iter)))
512 #define for_each_btree_key_norestart(_trans, _iter, _btree_id, \
513 _start, _flags, _k, _ret) \
514 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
515 (_start), (_flags)); \
516 (_k) = bch2_btree_iter_peek_type(&(_iter), _flags), \
517 !((_ret) = bkey_err(_k)) && (_k).k; \
518 bch2_btree_iter_advance(&(_iter)))
520 #define for_each_btree_key_upto_norestart(_trans, _iter, _btree_id, \
521 _start, _end, _flags, _k, _ret) \
522 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
523 (_start), (_flags)); \
524 (_k) = bch2_btree_iter_peek_upto_type(&(_iter), _end, _flags),\
525 !((_ret) = bkey_err(_k)) && (_k).k; \
526 bch2_btree_iter_advance(&(_iter)))
528 #define for_each_btree_key_continue(_trans, _iter, _flags, _k, _ret) \
530 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
531 !((_ret) = bkey_err(_k)) && (_k).k; \
532 bch2_btree_iter_advance(&(_iter)))
534 #define for_each_btree_key_continue_norestart(_iter, _flags, _k, _ret) \
536 (_k) = bch2_btree_iter_peek_type(&(_iter), _flags), \
537 !((_ret) = bkey_err(_k)) && (_k).k; \
538 bch2_btree_iter_advance(&(_iter)))
540 /* new multiple iterator interface: */
542 void bch2_trans_updates_to_text(struct printbuf *, struct btree_trans *);
543 void bch2_btree_path_to_text(struct printbuf *, struct btree_path *);
544 void bch2_trans_paths_to_text(struct printbuf *, struct btree_trans *);
545 void bch2_dump_trans_updates(struct btree_trans *);
546 void bch2_dump_trans_paths_updates(struct btree_trans *);
547 void __bch2_trans_init(struct btree_trans *, struct bch_fs *,
548 unsigned, size_t, const char *);
549 void bch2_trans_exit(struct btree_trans *);
551 #define bch2_trans_init(...) __bch2_trans_init(__VA_ARGS__, __func__)
553 void bch2_btree_trans_to_text(struct printbuf *, struct btree_trans *);
555 void bch2_fs_btree_iter_exit(struct bch_fs *);
556 int bch2_fs_btree_iter_init(struct bch_fs *);
558 #endif /* _BCACHEFS_BTREE_ITER_H */