1 // SPDX-License-Identifier: GPL-2.0
4 #include "bkey_methods.h"
6 #include "btree_cache.h"
7 #include "btree_iter.h"
8 #include "btree_key_cache.h"
9 #include "btree_locking.h"
10 #include "btree_update.h"
17 #include "subvolume.h"
19 #include <linux/prefetch.h>
20 #include <trace/events/bcachefs.h>
22 static void btree_trans_verify_sorted(struct btree_trans *);
23 inline void bch2_btree_path_check_sort(struct btree_trans *, struct btree_path *, int);
25 static inline void btree_path_list_remove(struct btree_trans *, struct btree_path *);
26 static inline void btree_path_list_add(struct btree_trans *, struct btree_path *,
29 static inline unsigned long btree_iter_ip_allocated(struct btree_iter *iter)
31 #ifdef CONFIG_BCACHEFS_DEBUG
32 return iter->ip_allocated;
38 static struct btree_path *btree_path_alloc(struct btree_trans *, struct btree_path *);
41 * Unlocks before scheduling
42 * Note: does not revalidate iterator
44 static inline int bch2_trans_cond_resched(struct btree_trans *trans)
46 if (need_resched() || race_fault()) {
47 bch2_trans_unlock(trans);
49 return bch2_trans_relock(trans) ? 0 : -EINTR;
55 static inline int __btree_path_cmp(const struct btree_path *l,
56 enum btree_id r_btree_id,
62 * Must match lock ordering as defined by __bch2_btree_node_lock:
64 return cmp_int(l->btree_id, r_btree_id) ?:
65 cmp_int((int) l->cached, (int) r_cached) ?:
66 bpos_cmp(l->pos, r_pos) ?:
67 -cmp_int(l->level, r_level);
70 static inline int btree_path_cmp(const struct btree_path *l,
71 const struct btree_path *r)
73 return __btree_path_cmp(l, r->btree_id, r->cached, r->pos, r->level);
76 static inline struct bpos bkey_successor(struct btree_iter *iter, struct bpos p)
78 /* Are we iterating over keys in all snapshots? */
79 if (iter->flags & BTREE_ITER_ALL_SNAPSHOTS) {
80 p = bpos_successor(p);
82 p = bpos_nosnap_successor(p);
83 p.snapshot = iter->snapshot;
89 static inline struct bpos bkey_predecessor(struct btree_iter *iter, struct bpos p)
91 /* Are we iterating over keys in all snapshots? */
92 if (iter->flags & BTREE_ITER_ALL_SNAPSHOTS) {
93 p = bpos_predecessor(p);
95 p = bpos_nosnap_predecessor(p);
96 p.snapshot = iter->snapshot;
102 static inline bool is_btree_node(struct btree_path *path, unsigned l)
104 return l < BTREE_MAX_DEPTH &&
105 (unsigned long) path->l[l].b >= 128;
108 static inline struct bpos btree_iter_search_key(struct btree_iter *iter)
110 struct bpos pos = iter->pos;
112 if ((iter->flags & BTREE_ITER_IS_EXTENTS) &&
113 bkey_cmp(pos, POS_MAX))
114 pos = bkey_successor(iter, pos);
118 static inline bool btree_path_pos_before_node(struct btree_path *path,
121 return bpos_cmp(path->pos, b->data->min_key) < 0;
124 static inline bool btree_path_pos_after_node(struct btree_path *path,
127 return bpos_cmp(b->key.k.p, path->pos) < 0;
130 static inline bool btree_path_pos_in_node(struct btree_path *path,
133 return path->btree_id == b->c.btree_id &&
134 !btree_path_pos_before_node(path, b) &&
135 !btree_path_pos_after_node(path, b);
138 /* Btree node locking: */
140 void bch2_btree_node_unlock_write(struct btree_trans *trans,
141 struct btree_path *path, struct btree *b)
143 bch2_btree_node_unlock_write_inlined(trans, path, b);
146 void __bch2_btree_node_lock_write(struct btree_trans *trans, struct btree *b)
148 struct btree_path *linked;
149 unsigned readers = 0;
151 trans_for_each_path(trans, linked)
152 if (linked->l[b->c.level].b == b &&
153 btree_node_read_locked(linked, b->c.level))
157 * Must drop our read locks before calling six_lock_write() -
158 * six_unlock() won't do wakeups until the reader count
159 * goes to 0, and it's safe because we have the node intent
162 if (!b->c.lock.readers)
163 atomic64_sub(__SIX_VAL(read_lock, readers),
164 &b->c.lock.state.counter);
166 this_cpu_sub(*b->c.lock.readers, readers);
168 six_lock_write(&b->c.lock, NULL, NULL);
170 if (!b->c.lock.readers)
171 atomic64_add(__SIX_VAL(read_lock, readers),
172 &b->c.lock.state.counter);
174 this_cpu_add(*b->c.lock.readers, readers);
177 bool __bch2_btree_node_relock(struct btree_trans *trans,
178 struct btree_path *path, unsigned level)
180 struct btree *b = btree_path_node(path, level);
181 int want = __btree_lock_want(path, level);
183 if (!is_btree_node(path, level))
189 if (six_relock_type(&b->c.lock, want, path->l[level].lock_seq) ||
190 (btree_node_lock_seq_matches(path, b, level) &&
191 btree_node_lock_increment(trans, b, level, want))) {
192 mark_btree_node_locked(trans, path, level, want);
196 trace_btree_node_relock_fail(trans->fn, _RET_IP_,
200 path->l[level].lock_seq,
201 is_btree_node(path, level) ? b->c.lock.state.seq : 0);
205 bool bch2_btree_node_upgrade(struct btree_trans *trans,
206 struct btree_path *path, unsigned level)
208 struct btree *b = path->l[level].b;
210 if (!is_btree_node(path, level))
213 switch (btree_lock_want(path, level)) {
214 case BTREE_NODE_UNLOCKED:
215 BUG_ON(btree_node_locked(path, level));
217 case BTREE_NODE_READ_LOCKED:
218 BUG_ON(btree_node_intent_locked(path, level));
219 return bch2_btree_node_relock(trans, path, level);
220 case BTREE_NODE_INTENT_LOCKED:
224 if (btree_node_intent_locked(path, level))
230 if (btree_node_locked(path, level)
231 ? six_lock_tryupgrade(&b->c.lock)
232 : six_relock_type(&b->c.lock, SIX_LOCK_intent, path->l[level].lock_seq))
235 if (btree_node_lock_seq_matches(path, b, level) &&
236 btree_node_lock_increment(trans, b, level, BTREE_NODE_INTENT_LOCKED)) {
237 btree_node_unlock(path, level);
243 mark_btree_node_intent_locked(trans, path, level);
247 static inline bool btree_path_get_locks(struct btree_trans *trans,
248 struct btree_path *path,
251 unsigned l = path->level;
255 if (!btree_path_node(path, l))
259 ? bch2_btree_node_upgrade(trans, path, l)
260 : bch2_btree_node_relock(trans, path, l)))
264 } while (l < path->locks_want);
267 * When we fail to get a lock, we have to ensure that any child nodes
268 * can't be relocked so bch2_btree_path_traverse has to walk back up to
269 * the node that we failed to relock:
272 __bch2_btree_path_unlock(path);
273 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
276 path->l[fail_idx].b = BTREE_ITER_NO_NODE_GET_LOCKS;
278 } while (fail_idx >= 0);
281 if (path->uptodate == BTREE_ITER_NEED_RELOCK)
282 path->uptodate = BTREE_ITER_UPTODATE;
284 bch2_trans_verify_locks(trans);
286 return path->uptodate < BTREE_ITER_NEED_RELOCK;
289 static struct bpos btree_node_pos(struct btree_bkey_cached_common *_b,
293 ? container_of(_b, struct btree, c)->key.k.p
294 : container_of(_b, struct bkey_cached, c)->key.pos;
298 bool __bch2_btree_node_lock(struct btree_trans *trans,
299 struct btree_path *path,
301 struct bpos pos, unsigned level,
302 enum six_lock_type type,
303 six_lock_should_sleep_fn should_sleep_fn, void *p,
306 struct btree_path *linked;
309 /* Check if it's safe to block: */
310 trans_for_each_path(trans, linked) {
311 if (!linked->nodes_locked)
315 * Can't block taking an intent lock if we have _any_ nodes read
318 * - Our read lock blocks another thread with an intent lock on
319 * the same node from getting a write lock, and thus from
320 * dropping its intent lock
322 * - And the other thread may have multiple nodes intent locked:
323 * both the node we want to intent lock, and the node we
324 * already have read locked - deadlock:
326 if (type == SIX_LOCK_intent &&
327 linked->nodes_locked != linked->nodes_intent_locked) {
332 if (linked->btree_id != path->btree_id) {
333 if (linked->btree_id < path->btree_id)
341 * Within the same btree, non-cached paths come before cached
344 if (linked->cached != path->cached) {
353 * Interior nodes must be locked before their descendants: if
354 * another path has possible descendants locked of the node
355 * we're about to lock, it must have the ancestors locked too:
357 if (level > __fls(linked->nodes_locked)) {
362 /* Must lock btree nodes in key order: */
363 if (btree_node_locked(linked, level) &&
364 bpos_cmp(pos, btree_node_pos((void *) linked->l[level].b,
365 linked->cached)) <= 0) {
366 BUG_ON(trans->in_traverse_all);
372 return btree_node_lock_type(trans, path, b, pos, level,
373 type, should_sleep_fn, p);
375 trace_trans_restart_would_deadlock(trans->fn, ip,
376 trans->in_traverse_all, reason,
383 btree_trans_restart(trans);
387 /* Btree iterator locking: */
389 #ifdef CONFIG_BCACHEFS_DEBUG
391 static void bch2_btree_path_verify_locks(struct btree_path *path)
395 if (!path->nodes_locked) {
396 BUG_ON(path->uptodate == BTREE_ITER_UPTODATE &&
397 btree_path_node(path, path->level));
401 for (l = 0; btree_path_node(path, l); l++)
402 BUG_ON(btree_lock_want(path, l) !=
403 btree_node_locked_type(path, l));
406 void bch2_trans_verify_locks(struct btree_trans *trans)
408 struct btree_path *path;
410 trans_for_each_path(trans, path)
411 bch2_btree_path_verify_locks(path);
414 static inline void bch2_btree_path_verify_locks(struct btree_path *path) {}
417 /* Btree path locking: */
420 * Only for btree_cache.c - only relocks intent locks
422 bool bch2_btree_path_relock_intent(struct btree_trans *trans,
423 struct btree_path *path)
427 for (l = path->level;
428 l < path->locks_want && btree_path_node(path, l);
430 if (!bch2_btree_node_relock(trans, path, l)) {
431 __bch2_btree_path_unlock(path);
432 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
433 trace_trans_restart_relock_path_intent(trans->fn, _RET_IP_,
434 path->btree_id, &path->pos);
435 btree_trans_restart(trans);
444 static bool bch2_btree_path_relock(struct btree_trans *trans,
445 struct btree_path *path, unsigned long trace_ip)
447 bool ret = btree_path_get_locks(trans, path, false);
450 trace_trans_restart_relock_path(trans->fn, trace_ip,
451 path->btree_id, &path->pos);
452 btree_trans_restart(trans);
457 bool __bch2_btree_path_upgrade(struct btree_trans *trans,
458 struct btree_path *path,
459 unsigned new_locks_want)
461 struct btree_path *linked;
463 EBUG_ON(path->locks_want >= new_locks_want);
465 path->locks_want = new_locks_want;
467 if (btree_path_get_locks(trans, path, true))
471 * XXX: this is ugly - we'd prefer to not be mucking with other
472 * iterators in the btree_trans here.
474 * On failure to upgrade the iterator, setting iter->locks_want and
475 * calling get_locks() is sufficient to make bch2_btree_path_traverse()
476 * get the locks we want on transaction restart.
478 * But if this iterator was a clone, on transaction restart what we did
479 * to this iterator isn't going to be preserved.
481 * Possibly we could add an iterator field for the parent iterator when
482 * an iterator is a copy - for now, we'll just upgrade any other
483 * iterators with the same btree id.
485 * The code below used to be needed to ensure ancestor nodes get locked
486 * before interior nodes - now that's handled by
487 * bch2_btree_path_traverse_all().
489 if (!path->cached && !trans->in_traverse_all)
490 trans_for_each_path(trans, linked)
491 if (linked != path &&
492 linked->cached == path->cached &&
493 linked->btree_id == path->btree_id &&
494 linked->locks_want < new_locks_want) {
495 linked->locks_want = new_locks_want;
496 btree_path_get_locks(trans, linked, true);
502 void __bch2_btree_path_downgrade(struct btree_path *path,
503 unsigned new_locks_want)
507 EBUG_ON(path->locks_want < new_locks_want);
509 path->locks_want = new_locks_want;
511 while (path->nodes_locked &&
512 (l = __fls(path->nodes_locked)) >= path->locks_want) {
513 if (l > path->level) {
514 btree_node_unlock(path, l);
516 if (btree_node_intent_locked(path, l)) {
517 six_lock_downgrade(&path->l[l].b->c.lock);
518 path->nodes_intent_locked ^= 1 << l;
524 bch2_btree_path_verify_locks(path);
527 void bch2_trans_downgrade(struct btree_trans *trans)
529 struct btree_path *path;
531 trans_for_each_path(trans, path)
532 bch2_btree_path_downgrade(path);
535 /* Btree transaction locking: */
537 bool bch2_trans_relock(struct btree_trans *trans)
539 struct btree_path *path;
541 if (unlikely(trans->restarted))
544 trans_for_each_path(trans, path)
545 if (path->should_be_locked &&
546 !bch2_btree_path_relock(trans, path, _RET_IP_)) {
547 trace_trans_restart_relock(trans->fn, _RET_IP_,
548 path->btree_id, &path->pos);
549 BUG_ON(!trans->restarted);
555 void bch2_trans_unlock(struct btree_trans *trans)
557 struct btree_path *path;
559 trans_for_each_path(trans, path)
560 __bch2_btree_path_unlock(path);
563 * bch2_gc_btree_init_recurse() doesn't use btree iterators for walking
564 * btree nodes, it implements its own walking:
566 BUG_ON(!trans->is_initial_gc &&
567 lock_class_is_held(&bch2_btree_node_lock_key));
570 /* Btree iterator: */
572 #ifdef CONFIG_BCACHEFS_DEBUG
574 static void bch2_btree_path_verify_cached(struct btree_trans *trans,
575 struct btree_path *path)
577 struct bkey_cached *ck;
578 bool locked = btree_node_locked(path, 0);
580 if (!bch2_btree_node_relock(trans, path, 0))
583 ck = (void *) path->l[0].b;
584 BUG_ON(ck->key.btree_id != path->btree_id ||
585 bkey_cmp(ck->key.pos, path->pos));
588 btree_node_unlock(path, 0);
591 static void bch2_btree_path_verify_level(struct btree_trans *trans,
592 struct btree_path *path, unsigned level)
594 struct btree_path_level *l;
595 struct btree_node_iter tmp;
597 struct bkey_packed *p, *k;
598 struct printbuf buf1 = PRINTBUF;
599 struct printbuf buf2 = PRINTBUF;
600 struct printbuf buf3 = PRINTBUF;
603 if (!bch2_debug_check_iterators)
608 locked = btree_node_locked(path, level);
612 bch2_btree_path_verify_cached(trans, path);
616 if (!btree_path_node(path, level))
619 if (!bch2_btree_node_relock(trans, path, level))
622 BUG_ON(!btree_path_pos_in_node(path, l->b));
624 bch2_btree_node_iter_verify(&l->iter, l->b);
627 * For interior nodes, the iterator will have skipped past deleted keys:
630 ? bch2_btree_node_iter_prev(&tmp, l->b)
631 : bch2_btree_node_iter_prev_all(&tmp, l->b);
632 k = bch2_btree_node_iter_peek_all(&l->iter, l->b);
634 if (p && bkey_iter_pos_cmp(l->b, p, &path->pos) >= 0) {
639 if (k && bkey_iter_pos_cmp(l->b, k, &path->pos) < 0) {
645 btree_node_unlock(path, level);
648 bch2_bpos_to_text(&buf1, path->pos);
651 struct bkey uk = bkey_unpack_key(l->b, p);
652 bch2_bkey_to_text(&buf2, &uk);
654 pr_buf(&buf2, "(none)");
658 struct bkey uk = bkey_unpack_key(l->b, k);
659 bch2_bkey_to_text(&buf3, &uk);
661 pr_buf(&buf3, "(none)");
664 panic("path should be %s key at level %u:\n"
668 msg, level, buf1.buf, buf2.buf, buf3.buf);
671 static void bch2_btree_path_verify(struct btree_trans *trans,
672 struct btree_path *path)
674 struct bch_fs *c = trans->c;
677 EBUG_ON(path->btree_id >= BTREE_ID_NR);
679 for (i = 0; i < (!path->cached ? BTREE_MAX_DEPTH : 1); i++) {
681 BUG_ON(!path->cached &&
682 c->btree_roots[path->btree_id].b->c.level > i);
686 bch2_btree_path_verify_level(trans, path, i);
689 bch2_btree_path_verify_locks(path);
692 void bch2_trans_verify_paths(struct btree_trans *trans)
694 struct btree_path *path;
696 trans_for_each_path(trans, path)
697 bch2_btree_path_verify(trans, path);
700 static void bch2_btree_iter_verify(struct btree_iter *iter)
702 struct btree_trans *trans = iter->trans;
704 BUG_ON(iter->btree_id >= BTREE_ID_NR);
706 BUG_ON(!!(iter->flags & BTREE_ITER_CACHED) != iter->path->cached);
708 BUG_ON((iter->flags & BTREE_ITER_IS_EXTENTS) &&
709 (iter->flags & BTREE_ITER_ALL_SNAPSHOTS));
711 BUG_ON(!(iter->flags & __BTREE_ITER_ALL_SNAPSHOTS) &&
712 (iter->flags & BTREE_ITER_ALL_SNAPSHOTS) &&
713 !btree_type_has_snapshots(iter->btree_id));
715 if (iter->update_path)
716 bch2_btree_path_verify(trans, iter->update_path);
717 bch2_btree_path_verify(trans, iter->path);
720 static void bch2_btree_iter_verify_entry_exit(struct btree_iter *iter)
722 BUG_ON((iter->flags & BTREE_ITER_FILTER_SNAPSHOTS) &&
723 !iter->pos.snapshot);
725 BUG_ON(!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS) &&
726 iter->pos.snapshot != iter->snapshot);
728 BUG_ON(bkey_cmp(iter->pos, bkey_start_pos(&iter->k)) < 0 ||
729 bkey_cmp(iter->pos, iter->k.p) > 0);
732 static int bch2_btree_iter_verify_ret(struct btree_iter *iter, struct bkey_s_c k)
734 struct btree_trans *trans = iter->trans;
735 struct btree_iter copy;
736 struct bkey_s_c prev;
739 if (!bch2_debug_check_iterators)
742 if (!(iter->flags & BTREE_ITER_FILTER_SNAPSHOTS))
745 if (bkey_err(k) || !k.k)
748 BUG_ON(!bch2_snapshot_is_ancestor(trans->c,
752 bch2_trans_iter_init(trans, ©, iter->btree_id, iter->pos,
753 BTREE_ITER_NOPRESERVE|
754 BTREE_ITER_ALL_SNAPSHOTS);
755 prev = bch2_btree_iter_prev(©);
759 ret = bkey_err(prev);
763 if (!bkey_cmp(prev.k->p, k.k->p) &&
764 bch2_snapshot_is_ancestor(trans->c, iter->snapshot,
765 prev.k->p.snapshot) > 0) {
766 struct printbuf buf1 = PRINTBUF, buf2 = PRINTBUF;
768 bch2_bkey_to_text(&buf1, k.k);
769 bch2_bkey_to_text(&buf2, prev.k);
771 panic("iter snap %u\n"
778 bch2_trans_iter_exit(trans, ©);
782 void bch2_assert_pos_locked(struct btree_trans *trans, enum btree_id id,
783 struct bpos pos, bool key_cache)
785 struct btree_path *path;
787 struct printbuf buf = PRINTBUF;
789 trans_for_each_path_inorder(trans, path, idx) {
790 int cmp = cmp_int(path->btree_id, id) ?:
791 cmp_int(path->cached, key_cache);
798 if (!(path->nodes_locked & 1) ||
799 !path->should_be_locked)
803 if (bkey_cmp(pos, path->l[0].b->data->min_key) >= 0 &&
804 bkey_cmp(pos, path->l[0].b->key.k.p) <= 0)
807 if (!bkey_cmp(pos, path->pos))
812 bch2_dump_trans_paths_updates(trans);
813 bch2_bpos_to_text(&buf, pos);
815 panic("not locked: %s %s%s\n",
816 bch2_btree_ids[id], buf.buf,
817 key_cache ? " cached" : "");
822 static inline void bch2_btree_path_verify_level(struct btree_trans *trans,
823 struct btree_path *path, unsigned l) {}
824 static inline void bch2_btree_path_verify(struct btree_trans *trans,
825 struct btree_path *path) {}
826 static inline void bch2_btree_iter_verify(struct btree_iter *iter) {}
827 static inline void bch2_btree_iter_verify_entry_exit(struct btree_iter *iter) {}
828 static inline int bch2_btree_iter_verify_ret(struct btree_iter *iter, struct bkey_s_c k) { return 0; }
832 /* Btree path: fixups after btree updates */
834 static void btree_node_iter_set_set_pos(struct btree_node_iter *iter,
837 struct bkey_packed *k)
839 struct btree_node_iter_set *set;
841 btree_node_iter_for_each(iter, set)
842 if (set->end == t->end_offset) {
843 set->k = __btree_node_key_to_offset(b, k);
844 bch2_btree_node_iter_sort(iter, b);
848 bch2_btree_node_iter_push(iter, b, k, btree_bkey_last(b, t));
851 static void __bch2_btree_path_fix_key_modified(struct btree_path *path,
853 struct bkey_packed *where)
855 struct btree_path_level *l = &path->l[b->c.level];
857 if (where != bch2_btree_node_iter_peek_all(&l->iter, l->b))
860 if (bkey_iter_pos_cmp(l->b, where, &path->pos) < 0)
861 bch2_btree_node_iter_advance(&l->iter, l->b);
864 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
866 struct bkey_packed *where)
868 struct btree_path *path;
870 trans_for_each_path_with_node(trans, b, path) {
871 __bch2_btree_path_fix_key_modified(path, b, where);
872 bch2_btree_path_verify_level(trans, path, b->c.level);
876 static void __bch2_btree_node_iter_fix(struct btree_path *path,
878 struct btree_node_iter *node_iter,
880 struct bkey_packed *where,
881 unsigned clobber_u64s,
884 const struct bkey_packed *end = btree_bkey_last(b, t);
885 struct btree_node_iter_set *set;
886 unsigned offset = __btree_node_key_to_offset(b, where);
887 int shift = new_u64s - clobber_u64s;
888 unsigned old_end = t->end_offset - shift;
889 unsigned orig_iter_pos = node_iter->data[0].k;
890 bool iter_current_key_modified =
891 orig_iter_pos >= offset &&
892 orig_iter_pos <= offset + clobber_u64s;
894 btree_node_iter_for_each(node_iter, set)
895 if (set->end == old_end)
898 /* didn't find the bset in the iterator - might have to readd it: */
900 bkey_iter_pos_cmp(b, where, &path->pos) >= 0) {
901 bch2_btree_node_iter_push(node_iter, b, where, end);
904 /* Iterator is after key that changed */
908 set->end = t->end_offset;
910 /* Iterator hasn't gotten to the key that changed yet: */
915 bkey_iter_pos_cmp(b, where, &path->pos) >= 0) {
917 } else if (set->k < offset + clobber_u64s) {
918 set->k = offset + new_u64s;
919 if (set->k == set->end)
920 bch2_btree_node_iter_set_drop(node_iter, set);
922 /* Iterator is after key that changed */
923 set->k = (int) set->k + shift;
927 bch2_btree_node_iter_sort(node_iter, b);
929 if (node_iter->data[0].k != orig_iter_pos)
930 iter_current_key_modified = true;
933 * When a new key is added, and the node iterator now points to that
934 * key, the iterator might have skipped past deleted keys that should
935 * come after the key the iterator now points to. We have to rewind to
936 * before those deleted keys - otherwise
937 * bch2_btree_node_iter_prev_all() breaks:
939 if (!bch2_btree_node_iter_end(node_iter) &&
940 iter_current_key_modified &&
943 struct bkey_packed *k, *k2, *p;
945 k = bch2_btree_node_iter_peek_all(node_iter, b);
947 for_each_bset(b, t) {
948 bool set_pos = false;
950 if (node_iter->data[0].end == t->end_offset)
953 k2 = bch2_btree_node_iter_bset_pos(node_iter, b, t);
955 while ((p = bch2_bkey_prev_all(b, t, k2)) &&
956 bkey_iter_cmp(b, k, p) < 0) {
962 btree_node_iter_set_set_pos(node_iter,
968 void bch2_btree_node_iter_fix(struct btree_trans *trans,
969 struct btree_path *path,
971 struct btree_node_iter *node_iter,
972 struct bkey_packed *where,
973 unsigned clobber_u64s,
976 struct bset_tree *t = bch2_bkey_to_bset(b, where);
977 struct btree_path *linked;
979 if (node_iter != &path->l[b->c.level].iter) {
980 __bch2_btree_node_iter_fix(path, b, node_iter, t,
981 where, clobber_u64s, new_u64s);
983 if (bch2_debug_check_iterators)
984 bch2_btree_node_iter_verify(node_iter, b);
987 trans_for_each_path_with_node(trans, b, linked) {
988 __bch2_btree_node_iter_fix(linked, b,
989 &linked->l[b->c.level].iter, t,
990 where, clobber_u64s, new_u64s);
991 bch2_btree_path_verify_level(trans, linked, b->c.level);
995 /* Btree path level: pointer to a particular btree node and node iter */
997 static inline struct bkey_s_c __btree_iter_unpack(struct bch_fs *c,
998 struct btree_path_level *l,
1000 struct bkey_packed *k)
1004 * signal to bch2_btree_iter_peek_slot() that we're currently at
1007 u->type = KEY_TYPE_deleted;
1008 return bkey_s_c_null;
1011 return bkey_disassemble(l->b, k, u);
1014 static inline struct bkey_s_c btree_path_level_peek_all(struct bch_fs *c,
1015 struct btree_path_level *l,
1018 return __btree_iter_unpack(c, l, u,
1019 bch2_btree_node_iter_peek_all(&l->iter, l->b));
1022 static inline struct bkey_s_c btree_path_level_peek(struct bch_fs *c,
1023 struct btree_path *path,
1024 struct btree_path_level *l,
1027 struct bkey_s_c k = __btree_iter_unpack(c, l, u,
1028 bch2_btree_node_iter_peek(&l->iter, l->b));
1030 path->pos = k.k ? k.k->p : l->b->key.k.p;
1034 static inline struct bkey_s_c btree_path_level_prev(struct bch_fs *c,
1035 struct btree_path *path,
1036 struct btree_path_level *l,
1039 struct bkey_s_c k = __btree_iter_unpack(c, l, u,
1040 bch2_btree_node_iter_prev(&l->iter, l->b));
1042 path->pos = k.k ? k.k->p : l->b->data->min_key;
1046 static inline bool btree_path_advance_to_pos(struct btree_path *path,
1047 struct btree_path_level *l,
1050 struct bkey_packed *k;
1051 int nr_advanced = 0;
1053 while ((k = bch2_btree_node_iter_peek_all(&l->iter, l->b)) &&
1054 bkey_iter_pos_cmp(l->b, k, &path->pos) < 0) {
1055 if (max_advance > 0 && nr_advanced >= max_advance)
1058 bch2_btree_node_iter_advance(&l->iter, l->b);
1066 * Verify that iterator for parent node points to child node:
1068 static void btree_path_verify_new_node(struct btree_trans *trans,
1069 struct btree_path *path, struct btree *b)
1071 struct bch_fs *c = trans->c;
1072 struct btree_path_level *l;
1075 struct bkey_packed *k;
1077 if (!IS_ENABLED(CONFIG_BCACHEFS_DEBUG))
1080 if (!test_bit(JOURNAL_REPLAY_DONE, &c->journal.flags))
1083 plevel = b->c.level + 1;
1084 if (!btree_path_node(path, plevel))
1087 parent_locked = btree_node_locked(path, plevel);
1089 if (!bch2_btree_node_relock(trans, path, plevel))
1092 l = &path->l[plevel];
1093 k = bch2_btree_node_iter_peek_all(&l->iter, l->b);
1096 bkey_cmp_left_packed(l->b, k, &b->key.k.p)) {
1097 struct printbuf buf1 = PRINTBUF;
1098 struct printbuf buf2 = PRINTBUF;
1099 struct printbuf buf3 = PRINTBUF;
1100 struct printbuf buf4 = PRINTBUF;
1101 struct bkey uk = bkey_unpack_key(b, k);
1103 bch2_dump_btree_node(c, l->b);
1104 bch2_bpos_to_text(&buf1, path->pos);
1105 bch2_bkey_to_text(&buf2, &uk);
1106 bch2_bpos_to_text(&buf3, b->data->min_key);
1107 bch2_bpos_to_text(&buf3, b->data->max_key);
1108 panic("parent iter doesn't point to new node:\n"
1112 bch2_btree_ids[path->btree_id],
1113 buf1.buf, buf2.buf, buf3.buf, buf4.buf);
1117 btree_node_unlock(path, plevel);
1120 static inline void __btree_path_level_init(struct btree_path *path,
1123 struct btree_path_level *l = &path->l[level];
1125 bch2_btree_node_iter_init(&l->iter, l->b, &path->pos);
1128 * Iterators to interior nodes should always be pointed at the first non
1132 bch2_btree_node_iter_peek(&l->iter, l->b);
1135 static inline void btree_path_level_init(struct btree_trans *trans,
1136 struct btree_path *path,
1139 BUG_ON(path->cached);
1141 btree_path_verify_new_node(trans, path, b);
1143 EBUG_ON(!btree_path_pos_in_node(path, b));
1144 EBUG_ON(b->c.lock.state.seq & 1);
1146 path->l[b->c.level].lock_seq = b->c.lock.state.seq;
1147 path->l[b->c.level].b = b;
1148 __btree_path_level_init(path, b->c.level);
1151 /* Btree path: fixups after btree node updates: */
1154 * A btree node is being replaced - update the iterator to point to the new
1157 void bch2_trans_node_add(struct btree_trans *trans, struct btree *b)
1159 struct btree_path *path;
1161 trans_for_each_path(trans, path)
1162 if (!path->cached &&
1163 btree_path_pos_in_node(path, b)) {
1164 enum btree_node_locked_type t =
1165 btree_lock_want(path, b->c.level);
1167 if (path->nodes_locked &&
1168 t != BTREE_NODE_UNLOCKED) {
1169 btree_node_unlock(path, b->c.level);
1170 six_lock_increment(&b->c.lock, t);
1171 mark_btree_node_locked(trans, path, b->c.level, t);
1174 btree_path_level_init(trans, path, b);
1179 * A btree node has been modified in such a way as to invalidate iterators - fix
1182 void bch2_trans_node_reinit_iter(struct btree_trans *trans, struct btree *b)
1184 struct btree_path *path;
1186 trans_for_each_path_with_node(trans, b, path)
1187 __btree_path_level_init(path, b->c.level);
1190 /* Btree path: traverse, set_pos: */
1192 static int lock_root_check_fn(struct six_lock *lock, void *p)
1194 struct btree *b = container_of(lock, struct btree, c.lock);
1195 struct btree **rootp = p;
1197 return b == *rootp ? 0 : -1;
1200 static inline int btree_path_lock_root(struct btree_trans *trans,
1201 struct btree_path *path,
1202 unsigned depth_want,
1203 unsigned long trace_ip)
1205 struct bch_fs *c = trans->c;
1206 struct btree *b, **rootp = &c->btree_roots[path->btree_id].b;
1207 enum six_lock_type lock_type;
1210 EBUG_ON(path->nodes_locked);
1213 b = READ_ONCE(*rootp);
1214 path->level = READ_ONCE(b->c.level);
1216 if (unlikely(path->level < depth_want)) {
1218 * the root is at a lower depth than the depth we want:
1219 * got to the end of the btree, or we're walking nodes
1220 * greater than some depth and there are no nodes >=
1223 path->level = depth_want;
1224 for (i = path->level; i < BTREE_MAX_DEPTH; i++)
1225 path->l[i].b = NULL;
1229 lock_type = __btree_lock_want(path, path->level);
1230 if (unlikely(!btree_node_lock(trans, path, b, SPOS_MAX,
1231 path->level, lock_type,
1232 lock_root_check_fn, rootp,
1234 if (trans->restarted)
1239 if (likely(b == READ_ONCE(*rootp) &&
1240 b->c.level == path->level &&
1242 for (i = 0; i < path->level; i++)
1243 path->l[i].b = BTREE_ITER_NO_NODE_LOCK_ROOT;
1244 path->l[path->level].b = b;
1245 for (i = path->level + 1; i < BTREE_MAX_DEPTH; i++)
1246 path->l[i].b = NULL;
1248 mark_btree_node_locked(trans, path, path->level, lock_type);
1249 btree_path_level_init(trans, path, b);
1253 six_unlock_type(&b->c.lock, lock_type);
1258 static int btree_path_prefetch(struct btree_trans *trans, struct btree_path *path)
1260 struct bch_fs *c = trans->c;
1261 struct btree_path_level *l = path_l(path);
1262 struct btree_node_iter node_iter = l->iter;
1263 struct bkey_packed *k;
1264 struct bkey_buf tmp;
1265 unsigned nr = test_bit(BCH_FS_STARTED, &c->flags)
1266 ? (path->level > 1 ? 0 : 2)
1267 : (path->level > 1 ? 1 : 16);
1268 bool was_locked = btree_node_locked(path, path->level);
1271 bch2_bkey_buf_init(&tmp);
1273 while (nr && !ret) {
1274 if (!bch2_btree_node_relock(trans, path, path->level))
1277 bch2_btree_node_iter_advance(&node_iter, l->b);
1278 k = bch2_btree_node_iter_peek(&node_iter, l->b);
1282 bch2_bkey_buf_unpack(&tmp, c, l->b, k);
1283 ret = bch2_btree_node_prefetch(c, trans, path, tmp.k, path->btree_id,
1288 btree_node_unlock(path, path->level);
1290 bch2_bkey_buf_exit(&tmp, c);
1294 static int btree_path_prefetch_j(struct btree_trans *trans, struct btree_path *path,
1295 struct btree_and_journal_iter *jiter)
1297 struct bch_fs *c = trans->c;
1299 struct bkey_buf tmp;
1300 unsigned nr = test_bit(BCH_FS_STARTED, &c->flags)
1301 ? (path->level > 1 ? 0 : 2)
1302 : (path->level > 1 ? 1 : 16);
1303 bool was_locked = btree_node_locked(path, path->level);
1306 bch2_bkey_buf_init(&tmp);
1308 while (nr && !ret) {
1309 if (!bch2_btree_node_relock(trans, path, path->level))
1312 bch2_btree_and_journal_iter_advance(jiter);
1313 k = bch2_btree_and_journal_iter_peek(jiter);
1317 bch2_bkey_buf_reassemble(&tmp, c, k);
1318 ret = bch2_btree_node_prefetch(c, trans, path, tmp.k, path->btree_id,
1323 btree_node_unlock(path, path->level);
1325 bch2_bkey_buf_exit(&tmp, c);
1329 static noinline void btree_node_mem_ptr_set(struct btree_trans *trans,
1330 struct btree_path *path,
1331 unsigned plevel, struct btree *b)
1333 struct btree_path_level *l = &path->l[plevel];
1334 bool locked = btree_node_locked(path, plevel);
1335 struct bkey_packed *k;
1336 struct bch_btree_ptr_v2 *bp;
1338 if (!bch2_btree_node_relock(trans, path, plevel))
1341 k = bch2_btree_node_iter_peek_all(&l->iter, l->b);
1342 BUG_ON(k->type != KEY_TYPE_btree_ptr_v2);
1344 bp = (void *) bkeyp_val(&l->b->format, k);
1345 bp->mem_ptr = (unsigned long)b;
1348 btree_node_unlock(path, plevel);
1351 static noinline int btree_node_iter_and_journal_peek(struct btree_trans *trans,
1352 struct btree_path *path,
1354 struct bkey_buf *out)
1356 struct bch_fs *c = trans->c;
1357 struct btree_path_level *l = path_l(path);
1358 struct btree_and_journal_iter jiter;
1362 __bch2_btree_and_journal_iter_init_node_iter(&jiter, c, l->b, l->iter, path->pos);
1364 k = bch2_btree_and_journal_iter_peek(&jiter);
1366 bch2_bkey_buf_reassemble(out, c, k);
1368 if (flags & BTREE_ITER_PREFETCH)
1369 ret = btree_path_prefetch_j(trans, path, &jiter);
1371 bch2_btree_and_journal_iter_exit(&jiter);
1375 static __always_inline int btree_path_down(struct btree_trans *trans,
1376 struct btree_path *path,
1378 unsigned long trace_ip)
1380 struct bch_fs *c = trans->c;
1381 struct btree_path_level *l = path_l(path);
1383 unsigned level = path->level - 1;
1384 enum six_lock_type lock_type = __btree_lock_want(path, level);
1385 bool replay_done = test_bit(JOURNAL_REPLAY_DONE, &c->journal.flags);
1386 struct bkey_buf tmp;
1389 EBUG_ON(!btree_node_locked(path, path->level));
1391 bch2_bkey_buf_init(&tmp);
1393 if (unlikely(!replay_done)) {
1394 ret = btree_node_iter_and_journal_peek(trans, path, flags, &tmp);
1398 bch2_bkey_buf_unpack(&tmp, c, l->b,
1399 bch2_btree_node_iter_peek(&l->iter, l->b));
1401 if (flags & BTREE_ITER_PREFETCH) {
1402 ret = btree_path_prefetch(trans, path);
1408 b = bch2_btree_node_get(trans, path, tmp.k, level, lock_type, trace_ip);
1409 ret = PTR_ERR_OR_ZERO(b);
1413 mark_btree_node_locked(trans, path, level, lock_type);
1414 btree_path_level_init(trans, path, b);
1416 if (likely(replay_done && tmp.k->k.type == KEY_TYPE_btree_ptr_v2) &&
1417 unlikely(b != btree_node_mem_ptr(tmp.k)))
1418 btree_node_mem_ptr_set(trans, path, level + 1, b);
1420 if (btree_node_read_locked(path, level + 1))
1421 btree_node_unlock(path, level + 1);
1422 path->level = level;
1424 bch2_btree_path_verify_locks(path);
1426 bch2_bkey_buf_exit(&tmp, c);
1430 static int btree_path_traverse_one(struct btree_trans *, struct btree_path *,
1431 unsigned, unsigned long);
1433 static int bch2_btree_path_traverse_all(struct btree_trans *trans)
1435 struct bch_fs *c = trans->c;
1436 struct btree_path *path;
1437 unsigned long trace_ip = _RET_IP_;
1440 if (trans->in_traverse_all)
1443 trans->in_traverse_all = true;
1445 trans->restarted = false;
1446 trans->traverse_all_idx = U8_MAX;
1448 trans_for_each_path(trans, path)
1449 path->should_be_locked = false;
1451 btree_trans_verify_sorted(trans);
1453 for (i = trans->nr_sorted - 2; i >= 0; --i) {
1454 struct btree_path *path1 = trans->paths + trans->sorted[i];
1455 struct btree_path *path2 = trans->paths + trans->sorted[i + 1];
1457 if (path1->btree_id == path2->btree_id &&
1458 path1->locks_want < path2->locks_want)
1459 __bch2_btree_path_upgrade(trans, path1, path2->locks_want);
1460 else if (!path1->locks_want && path2->locks_want)
1461 __bch2_btree_path_upgrade(trans, path1, 1);
1464 bch2_trans_unlock(trans);
1467 if (unlikely(trans->memory_allocation_failure)) {
1470 closure_init_stack(&cl);
1473 ret = bch2_btree_cache_cannibalize_lock(c, &cl);
1478 /* Now, redo traversals in correct order: */
1479 trans->traverse_all_idx = 0;
1480 while (trans->traverse_all_idx < trans->nr_sorted) {
1481 path = trans->paths + trans->sorted[trans->traverse_all_idx];
1484 * Traversing a path can cause another path to be added at about
1485 * the same position:
1487 if (path->uptodate) {
1488 ret = btree_path_traverse_one(trans, path, 0, _THIS_IP_);
1489 if (ret == -EINTR || ret == -ENOMEM)
1493 BUG_ON(path->uptodate);
1495 trans->traverse_all_idx++;
1500 * BTREE_ITER_NEED_RELOCK is ok here - if we called bch2_trans_unlock()
1501 * and relock(), relock() won't relock since path->should_be_locked
1502 * isn't set yet, which is all fine
1504 trans_for_each_path(trans, path)
1505 BUG_ON(path->uptodate >= BTREE_ITER_NEED_TRAVERSE);
1507 bch2_btree_cache_cannibalize_unlock(c);
1509 trans->in_traverse_all = false;
1511 trace_trans_traverse_all(trans->fn, trace_ip);
1515 static inline bool btree_path_good_node(struct btree_trans *trans,
1516 struct btree_path *path,
1517 unsigned l, int check_pos)
1519 if (!is_btree_node(path, l) ||
1520 !bch2_btree_node_relock(trans, path, l))
1523 if (check_pos < 0 && btree_path_pos_before_node(path, path->l[l].b))
1525 if (check_pos > 0 && btree_path_pos_after_node(path, path->l[l].b))
1530 static inline unsigned btree_path_up_until_good_node(struct btree_trans *trans,
1531 struct btree_path *path,
1534 unsigned i, l = path->level;
1536 while (btree_path_node(path, l) &&
1537 !btree_path_good_node(trans, path, l, check_pos)) {
1538 btree_node_unlock(path, l);
1539 path->l[l].b = BTREE_ITER_NO_NODE_UP;
1543 /* If we need intent locks, take them too: */
1545 i < path->locks_want && btree_path_node(path, i);
1547 if (!bch2_btree_node_relock(trans, path, i))
1549 btree_node_unlock(path, l);
1550 path->l[l].b = BTREE_ITER_NO_NODE_UP;
1558 * This is the main state machine for walking down the btree - walks down to a
1561 * Returns 0 on success, -EIO on error (error reading in a btree node).
1563 * On error, caller (peek_node()/peek_key()) must return NULL; the error is
1564 * stashed in the iterator and returned from bch2_trans_exit().
1566 static int btree_path_traverse_one(struct btree_trans *trans,
1567 struct btree_path *path,
1569 unsigned long trace_ip)
1571 unsigned depth_want = path->level;
1574 if (unlikely(trans->restarted)) {
1580 * Ensure we obey path->should_be_locked: if it's set, we can't unlock
1581 * and re-traverse the path without a transaction restart:
1583 if (path->should_be_locked) {
1584 ret = bch2_btree_path_relock(trans, path, trace_ip) ? 0 : -EINTR;
1589 ret = bch2_btree_path_traverse_cached(trans, path, flags);
1593 if (unlikely(path->level >= BTREE_MAX_DEPTH))
1596 path->level = btree_path_up_until_good_node(trans, path, 0);
1599 * Note: path->nodes[path->level] may be temporarily NULL here - that
1600 * would indicate to other code that we got to the end of the btree,
1601 * here it indicates that relocking the root failed - it's critical that
1602 * btree_path_lock_root() comes next and that it can't fail
1604 while (path->level > depth_want) {
1605 ret = btree_path_node(path, path->level)
1606 ? btree_path_down(trans, path, flags, trace_ip)
1607 : btree_path_lock_root(trans, path, depth_want, trace_ip);
1608 if (unlikely(ret)) {
1611 * No nodes at this level - got to the end of
1618 __bch2_btree_path_unlock(path);
1619 path->level = depth_want;
1622 path->l[path->level].b =
1623 BTREE_ITER_NO_NODE_ERROR;
1625 path->l[path->level].b =
1626 BTREE_ITER_NO_NODE_DOWN;
1631 path->uptodate = BTREE_ITER_UPTODATE;
1633 BUG_ON((ret == -EINTR) != !!trans->restarted);
1634 bch2_btree_path_verify(trans, path);
1638 int __must_check bch2_btree_path_traverse(struct btree_trans *trans,
1639 struct btree_path *path, unsigned flags)
1641 if (path->uptodate < BTREE_ITER_NEED_RELOCK)
1644 return bch2_trans_cond_resched(trans) ?:
1645 btree_path_traverse_one(trans, path, flags, _RET_IP_);
1648 static void btree_path_copy(struct btree_trans *trans, struct btree_path *dst,
1649 struct btree_path *src)
1653 memcpy(&dst->pos, &src->pos,
1654 sizeof(struct btree_path) - offsetof(struct btree_path, pos));
1656 for (i = 0; i < BTREE_MAX_DEPTH; i++)
1657 if (btree_node_locked(dst, i))
1658 six_lock_increment(&dst->l[i].b->c.lock,
1659 __btree_lock_want(dst, i));
1661 bch2_btree_path_check_sort(trans, dst, 0);
1664 static struct btree_path *btree_path_clone(struct btree_trans *trans, struct btree_path *src,
1667 struct btree_path *new = btree_path_alloc(trans, src);
1669 btree_path_copy(trans, new, src);
1670 __btree_path_get(new, intent);
1674 inline struct btree_path * __must_check
1675 bch2_btree_path_make_mut(struct btree_trans *trans,
1676 struct btree_path *path, bool intent,
1679 if (path->ref > 1 || path->preserve) {
1680 __btree_path_put(path, intent);
1681 path = btree_path_clone(trans, path, intent);
1682 path->preserve = false;
1683 #ifdef CONFIG_BCACHEFS_DEBUG
1684 path->ip_allocated = ip;
1686 btree_trans_verify_sorted(trans);
1689 path->should_be_locked = false;
1693 struct btree_path * __must_check
1694 bch2_btree_path_set_pos(struct btree_trans *trans,
1695 struct btree_path *path, struct bpos new_pos,
1696 bool intent, unsigned long ip)
1698 int cmp = bpos_cmp(new_pos, path->pos);
1699 unsigned l = path->level;
1701 EBUG_ON(trans->restarted);
1702 EBUG_ON(!path->ref);
1707 path = bch2_btree_path_make_mut(trans, path, intent, ip);
1709 path->pos = new_pos;
1711 bch2_btree_path_check_sort(trans, path, cmp);
1713 if (unlikely(path->cached)) {
1714 btree_node_unlock(path, 0);
1715 path->l[0].b = BTREE_ITER_NO_NODE_CACHED;
1716 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
1720 l = btree_path_up_until_good_node(trans, path, cmp);
1722 if (btree_path_node(path, l)) {
1723 BUG_ON(!btree_node_locked(path, l));
1725 * We might have to skip over many keys, or just a few: try
1726 * advancing the node iterator, and if we have to skip over too
1727 * many keys just reinit it (or if we're rewinding, since that
1731 !btree_path_advance_to_pos(path, &path->l[l], 8))
1732 __btree_path_level_init(path, l);
1735 if (l != path->level) {
1736 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
1737 __bch2_btree_path_unlock(path);
1740 bch2_btree_path_verify(trans, path);
1744 /* Btree path: main interface: */
1746 static struct btree_path *have_path_at_pos(struct btree_trans *trans, struct btree_path *path)
1748 struct btree_path *next;
1750 next = prev_btree_path(trans, path);
1751 if (next && !btree_path_cmp(next, path))
1754 next = next_btree_path(trans, path);
1755 if (next && !btree_path_cmp(next, path))
1761 static struct btree_path *have_node_at_pos(struct btree_trans *trans, struct btree_path *path)
1763 struct btree_path *next;
1765 next = prev_btree_path(trans, path);
1766 if (next && next->level == path->level && path_l(next)->b == path_l(path)->b)
1769 next = next_btree_path(trans, path);
1770 if (next && next->level == path->level && path_l(next)->b == path_l(path)->b)
1776 static inline void __bch2_path_free(struct btree_trans *trans, struct btree_path *path)
1778 __bch2_btree_path_unlock(path);
1779 btree_path_list_remove(trans, path);
1780 trans->paths_allocated &= ~(1ULL << path->idx);
1783 void bch2_path_put(struct btree_trans *trans, struct btree_path *path, bool intent)
1785 struct btree_path *dup;
1787 EBUG_ON(trans->paths + path->idx != path);
1788 EBUG_ON(!path->ref);
1790 if (!__btree_path_put(path, intent))
1794 * Perhaps instead we should check for duplicate paths in traverse_all:
1796 if (path->preserve &&
1797 (dup = have_path_at_pos(trans, path))) {
1798 dup->preserve = true;
1799 path->preserve = false;
1803 if (!path->preserve &&
1804 (dup = have_node_at_pos(trans, path)))
1808 if (path->should_be_locked &&
1809 !btree_node_locked(dup, path->level))
1812 dup->should_be_locked |= path->should_be_locked;
1813 __bch2_path_free(trans, path);
1816 void bch2_trans_updates_to_text(struct printbuf *buf, struct btree_trans *trans)
1818 struct btree_insert_entry *i;
1820 pr_buf(buf, "transaction updates for %s journal seq %llu",
1821 trans->fn, trans->journal_res.seq);
1823 pr_indent_push(buf, 2);
1825 trans_for_each_update(trans, i) {
1826 struct bkey_s_c old = { &i->old_k, i->old_v };
1828 pr_buf(buf, "update: btree %s %pS",
1829 bch2_btree_ids[i->btree_id],
1830 (void *) i->ip_allocated);
1833 pr_buf(buf, " old ");
1834 bch2_bkey_val_to_text(buf, trans->c, old);
1837 pr_buf(buf, " new ");
1838 bch2_bkey_val_to_text(buf, trans->c, bkey_i_to_s_c(i->k));
1842 pr_indent_pop(buf, 2);
1846 void bch2_dump_trans_updates(struct btree_trans *trans)
1848 struct printbuf buf = PRINTBUF;
1850 bch2_trans_updates_to_text(&buf, trans);
1851 bch_err(trans->c, "%s", buf.buf);
1852 printbuf_exit(&buf);
1856 void bch2_dump_trans_paths_updates(struct btree_trans *trans)
1858 struct btree_path *path;
1859 struct printbuf buf = PRINTBUF;
1862 trans_for_each_path_inorder(trans, path, idx) {
1863 printbuf_reset(&buf);
1865 bch2_bpos_to_text(&buf, path->pos);
1867 printk(KERN_ERR "path: idx %u ref %u:%u%s%s btree=%s l=%u pos %s locks %u %pS\n",
1868 path->idx, path->ref, path->intent_ref,
1869 path->should_be_locked ? " S" : "",
1870 path->preserve ? " P" : "",
1871 bch2_btree_ids[path->btree_id],
1875 #ifdef CONFIG_BCACHEFS_DEBUG
1876 (void *) path->ip_allocated
1883 printbuf_exit(&buf);
1885 bch2_dump_trans_updates(trans);
1888 static struct btree_path *btree_path_alloc(struct btree_trans *trans,
1889 struct btree_path *pos)
1891 struct btree_path *path;
1894 if (unlikely(trans->paths_allocated ==
1895 ~((~0ULL << 1) << (BTREE_ITER_MAX - 1)))) {
1896 bch2_dump_trans_paths_updates(trans);
1897 panic("trans path oveflow\n");
1900 idx = __ffs64(~trans->paths_allocated);
1901 trans->paths_allocated |= 1ULL << idx;
1903 path = &trans->paths[idx];
1907 path->intent_ref = 0;
1908 path->nodes_locked = 0;
1909 path->nodes_intent_locked = 0;
1911 btree_path_list_add(trans, pos, path);
1915 struct btree_path *bch2_path_get(struct btree_trans *trans,
1916 enum btree_id btree_id, struct bpos pos,
1917 unsigned locks_want, unsigned level,
1918 unsigned flags, unsigned long ip)
1920 struct btree_path *path, *path_pos = NULL;
1921 bool cached = flags & BTREE_ITER_CACHED;
1922 bool intent = flags & BTREE_ITER_INTENT;
1925 BUG_ON(trans->restarted);
1926 btree_trans_verify_sorted(trans);
1927 bch2_trans_verify_locks(trans);
1929 trans_for_each_path_inorder(trans, path, i) {
1930 if (__btree_path_cmp(path,
1941 path_pos->cached == cached &&
1942 path_pos->btree_id == btree_id &&
1943 path_pos->level == level) {
1944 __btree_path_get(path_pos, intent);
1945 path = bch2_btree_path_set_pos(trans, path_pos, pos, intent, ip);
1947 path = btree_path_alloc(trans, path_pos);
1950 __btree_path_get(path, intent);
1952 path->btree_id = btree_id;
1953 path->cached = cached;
1954 path->uptodate = BTREE_ITER_NEED_TRAVERSE;
1955 path->should_be_locked = false;
1956 path->level = level;
1957 path->locks_want = locks_want;
1958 path->nodes_locked = 0;
1959 path->nodes_intent_locked = 0;
1960 for (i = 0; i < ARRAY_SIZE(path->l); i++)
1961 path->l[i].b = BTREE_ITER_NO_NODE_INIT;
1962 #ifdef CONFIG_BCACHEFS_DEBUG
1963 path->ip_allocated = ip;
1965 btree_trans_verify_sorted(trans);
1968 if (!(flags & BTREE_ITER_NOPRESERVE))
1969 path->preserve = true;
1971 if (path->intent_ref)
1972 locks_want = max(locks_want, level + 1);
1975 * If the path has locks_want greater than requested, we don't downgrade
1976 * it here - on transaction restart because btree node split needs to
1977 * upgrade locks, we might be putting/getting the iterator again.
1978 * Downgrading iterators only happens via bch2_trans_downgrade(), after
1979 * a successful transaction commit.
1982 locks_want = min(locks_want, BTREE_MAX_DEPTH);
1983 if (locks_want > path->locks_want) {
1984 path->locks_want = locks_want;
1985 btree_path_get_locks(trans, path, true);
1991 inline struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *path, struct bkey *u)
1996 if (!path->cached) {
1997 struct btree_path_level *l = path_l(path);
1998 struct bkey_packed *_k;
2000 EBUG_ON(path->uptodate != BTREE_ITER_UPTODATE);
2002 _k = bch2_btree_node_iter_peek_all(&l->iter, l->b);
2003 k = _k ? bkey_disassemble(l->b, _k, u) : bkey_s_c_null;
2005 EBUG_ON(k.k && bkey_deleted(k.k) && bpos_cmp(k.k->p, path->pos) == 0);
2007 if (!k.k || bpos_cmp(path->pos, k.k->p))
2010 struct bkey_cached *ck = (void *) path->l[0].b;
2013 (path->btree_id != ck->key.btree_id ||
2014 bkey_cmp(path->pos, ck->key.pos)));
2016 /* BTREE_ITER_CACHED_NOFILL|BTREE_ITER_CACHED_NOCREATE? */
2017 if (unlikely(!ck || !ck->valid))
2018 return bkey_s_c_null;
2020 EBUG_ON(path->uptodate != BTREE_ITER_UPTODATE);
2023 k = bkey_i_to_s_c(ck->k);
2030 return (struct bkey_s_c) { u, NULL };
2033 /* Btree iterators: */
2036 __bch2_btree_iter_traverse(struct btree_iter *iter)
2038 return bch2_btree_path_traverse(iter->trans, iter->path, iter->flags);
2042 bch2_btree_iter_traverse(struct btree_iter *iter)
2046 iter->path = bch2_btree_path_set_pos(iter->trans, iter->path,
2047 btree_iter_search_key(iter),
2048 iter->flags & BTREE_ITER_INTENT,
2049 btree_iter_ip_allocated(iter));
2051 ret = bch2_btree_path_traverse(iter->trans, iter->path, iter->flags);
2055 iter->path->should_be_locked = true;
2059 /* Iterate across nodes (leaf and interior nodes) */
2061 struct btree *bch2_btree_iter_peek_node(struct btree_iter *iter)
2063 struct btree_trans *trans = iter->trans;
2064 struct btree *b = NULL;
2067 EBUG_ON(iter->path->cached);
2068 bch2_btree_iter_verify(iter);
2070 ret = bch2_btree_path_traverse(trans, iter->path, iter->flags);
2074 b = btree_path_node(iter->path, iter->path->level);
2078 BUG_ON(bpos_cmp(b->key.k.p, iter->pos) < 0);
2080 bkey_init(&iter->k);
2081 iter->k.p = iter->pos = b->key.k.p;
2083 iter->path = bch2_btree_path_set_pos(trans, iter->path, b->key.k.p,
2084 iter->flags & BTREE_ITER_INTENT,
2085 btree_iter_ip_allocated(iter));
2086 iter->path->should_be_locked = true;
2087 BUG_ON(iter->path->uptodate);
2089 bch2_btree_iter_verify_entry_exit(iter);
2090 bch2_btree_iter_verify(iter);
2098 struct btree *bch2_btree_iter_next_node(struct btree_iter *iter)
2100 struct btree_trans *trans = iter->trans;
2101 struct btree_path *path = iter->path;
2102 struct btree *b = NULL;
2106 BUG_ON(trans->restarted);
2107 EBUG_ON(iter->path->cached);
2108 bch2_btree_iter_verify(iter);
2110 /* already at end? */
2111 if (!btree_path_node(path, path->level))
2115 if (!btree_path_node(path, path->level + 1)) {
2116 btree_node_unlock(path, path->level);
2117 path->l[path->level].b = BTREE_ITER_NO_NODE_UP;
2119 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
2123 if (!bch2_btree_node_relock(trans, path, path->level + 1)) {
2124 __bch2_btree_path_unlock(path);
2125 path->l[path->level].b = BTREE_ITER_NO_NODE_GET_LOCKS;
2126 path->l[path->level + 1].b = BTREE_ITER_NO_NODE_GET_LOCKS;
2127 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
2128 trace_trans_restart_relock_next_node(trans->fn, _THIS_IP_,
2129 path->btree_id, &path->pos);
2130 btree_trans_restart(trans);
2135 b = btree_path_node(path, path->level + 1);
2137 if (!bpos_cmp(iter->pos, b->key.k.p)) {
2138 btree_node_unlock(path, path->level);
2139 path->l[path->level].b = BTREE_ITER_NO_NODE_UP;
2143 * Haven't gotten to the end of the parent node: go back down to
2144 * the next child node
2147 bch2_btree_path_set_pos(trans, path, bpos_successor(iter->pos),
2148 iter->flags & BTREE_ITER_INTENT,
2149 btree_iter_ip_allocated(iter));
2151 path->level = iter->min_depth;
2153 for (l = path->level + 1; l < BTREE_MAX_DEPTH; l++)
2154 if (btree_lock_want(path, l) == BTREE_NODE_UNLOCKED)
2155 btree_node_unlock(path, l);
2157 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
2158 bch2_btree_iter_verify(iter);
2160 ret = bch2_btree_path_traverse(trans, path, iter->flags);
2164 b = path->l[path->level].b;
2167 bkey_init(&iter->k);
2168 iter->k.p = iter->pos = b->key.k.p;
2170 iter->path = bch2_btree_path_set_pos(trans, iter->path, b->key.k.p,
2171 iter->flags & BTREE_ITER_INTENT,
2172 btree_iter_ip_allocated(iter));
2173 iter->path->should_be_locked = true;
2174 BUG_ON(iter->path->uptodate);
2176 bch2_btree_iter_verify_entry_exit(iter);
2177 bch2_btree_iter_verify(iter);
2185 /* Iterate across keys (in leaf nodes only) */
2187 inline bool bch2_btree_iter_advance(struct btree_iter *iter)
2189 struct bpos pos = iter->k.p;
2190 bool ret = (iter->flags & BTREE_ITER_ALL_SNAPSHOTS
2191 ? bpos_cmp(pos, SPOS_MAX)
2192 : bkey_cmp(pos, SPOS_MAX)) != 0;
2194 if (ret && !(iter->flags & BTREE_ITER_IS_EXTENTS))
2195 pos = bkey_successor(iter, pos);
2196 bch2_btree_iter_set_pos(iter, pos);
2200 inline bool bch2_btree_iter_rewind(struct btree_iter *iter)
2202 struct bpos pos = bkey_start_pos(&iter->k);
2203 bool ret = (iter->flags & BTREE_ITER_ALL_SNAPSHOTS
2204 ? bpos_cmp(pos, POS_MIN)
2205 : bkey_cmp(pos, POS_MIN)) != 0;
2207 if (ret && !(iter->flags & BTREE_ITER_IS_EXTENTS))
2208 pos = bkey_predecessor(iter, pos);
2209 bch2_btree_iter_set_pos(iter, pos);
2213 static inline struct bkey_i *btree_trans_peek_updates(struct btree_trans *trans,
2214 enum btree_id btree_id,
2217 struct btree_insert_entry *i;
2219 trans_for_each_update(trans, i)
2220 if ((cmp_int(btree_id, i->btree_id) ?:
2221 bpos_cmp(pos, i->k->k.p)) <= 0) {
2222 if (btree_id == i->btree_id)
2231 struct bkey_s_c btree_trans_peek_journal(struct btree_trans *trans,
2232 struct btree_iter *iter,
2235 struct bkey_i *next_journal =
2236 bch2_journal_keys_peek(trans->c, iter->btree_id, 0,
2240 bpos_cmp(next_journal->k.p,
2241 k.k ? k.k->p : iter->path->l[0].b->key.k.p) <= 0) {
2242 iter->k = next_journal->k;
2243 k = bkey_i_to_s_c(next_journal);
2250 * Checks btree key cache for key at iter->pos and returns it if present, or
2254 struct bkey_s_c btree_trans_peek_key_cache(struct btree_iter *iter, struct bpos pos)
2256 struct btree_trans *trans = iter->trans;
2257 struct bch_fs *c = trans->c;
2261 if (!bch2_btree_key_cache_find(c, iter->btree_id, pos))
2262 return bkey_s_c_null;
2264 if (!iter->key_cache_path)
2265 iter->key_cache_path = bch2_path_get(trans, iter->btree_id, pos,
2266 iter->flags & BTREE_ITER_INTENT, 0,
2267 iter->flags|BTREE_ITER_CACHED,
2270 iter->key_cache_path = bch2_btree_path_set_pos(trans, iter->key_cache_path, pos,
2271 iter->flags & BTREE_ITER_INTENT,
2272 btree_iter_ip_allocated(iter));
2274 ret = bch2_btree_path_traverse(trans, iter->key_cache_path, iter->flags|BTREE_ITER_CACHED);
2276 return bkey_s_c_err(ret);
2278 iter->key_cache_path->should_be_locked = true;
2280 return bch2_btree_path_peek_slot(iter->key_cache_path, &u);
2283 static struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter, struct bpos search_key)
2285 struct btree_trans *trans = iter->trans;
2286 struct bkey_i *next_update;
2287 struct bkey_s_c k, k2;
2290 EBUG_ON(iter->path->cached || iter->path->level);
2291 bch2_btree_iter_verify(iter);
2294 iter->path = bch2_btree_path_set_pos(trans, iter->path, search_key,
2295 iter->flags & BTREE_ITER_INTENT,
2296 btree_iter_ip_allocated(iter));
2298 ret = bch2_btree_path_traverse(trans, iter->path, iter->flags);
2299 if (unlikely(ret)) {
2300 /* ensure that iter->k is consistent with iter->pos: */
2301 bch2_btree_iter_set_pos(iter, iter->pos);
2302 k = bkey_s_c_err(ret);
2306 iter->path->should_be_locked = true;
2308 k = btree_path_level_peek_all(trans->c, &iter->path->l[0], &iter->k);
2310 if (unlikely(iter->flags & BTREE_ITER_WITH_KEY_CACHE) &&
2312 (k2 = btree_trans_peek_key_cache(iter, k.k->p)).k) {
2316 bch2_btree_iter_set_pos(iter, iter->pos);
2324 if (unlikely(iter->flags & BTREE_ITER_WITH_JOURNAL))
2325 k = btree_trans_peek_journal(trans, iter, k);
2327 next_update = iter->flags & BTREE_ITER_WITH_UPDATES
2328 ? btree_trans_peek_updates(trans, iter->btree_id, search_key)
2331 bpos_cmp(next_update->k.p,
2332 k.k ? k.k->p : iter->path->l[0].b->key.k.p) <= 0) {
2333 iter->k = next_update->k;
2334 k = bkey_i_to_s_c(next_update);
2337 if (k.k && bkey_deleted(k.k)) {
2339 * If we've got a whiteout, and it's after the search
2340 * key, advance the search key to the whiteout instead
2341 * of just after the whiteout - it might be a btree
2342 * whiteout, with a real key at the same position, since
2343 * in the btree deleted keys sort before non deleted.
2345 search_key = bpos_cmp(search_key, k.k->p)
2347 : bpos_successor(k.k->p);
2353 } else if (likely(bpos_cmp(iter->path->l[0].b->key.k.p, SPOS_MAX))) {
2354 /* Advance to next leaf node: */
2355 search_key = bpos_successor(iter->path->l[0].b->key.k.p);
2358 bch2_btree_iter_set_pos(iter, SPOS_MAX);
2364 bch2_btree_iter_verify(iter);
2370 * bch2_btree_iter_peek: returns first key greater than or equal to iterator's
2373 struct bkey_s_c bch2_btree_iter_peek_upto(struct btree_iter *iter, struct bpos end)
2375 struct btree_trans *trans = iter->trans;
2376 struct bpos search_key = btree_iter_search_key(iter);
2378 struct bpos iter_pos;
2381 if (iter->update_path) {
2382 bch2_path_put(trans, iter->update_path,
2383 iter->flags & BTREE_ITER_INTENT);
2384 iter->update_path = NULL;
2387 bch2_btree_iter_verify_entry_exit(iter);
2390 k = __bch2_btree_iter_peek(iter, search_key);
2391 if (!k.k || bkey_err(k))
2395 * iter->pos should be mononotically increasing, and always be
2396 * equal to the key we just returned - except extents can
2397 * straddle iter->pos:
2399 if (!(iter->flags & BTREE_ITER_IS_EXTENTS))
2401 else if (bkey_cmp(bkey_start_pos(k.k), iter->pos) > 0)
2402 iter_pos = bkey_start_pos(k.k);
2404 iter_pos = iter->pos;
2406 if (bkey_cmp(iter_pos, end) > 0) {
2407 bch2_btree_iter_set_pos(iter, end);
2412 if (iter->update_path &&
2413 bkey_cmp(iter->update_path->pos, k.k->p)) {
2414 bch2_path_put(trans, iter->update_path,
2415 iter->flags & BTREE_ITER_INTENT);
2416 iter->update_path = NULL;
2419 if ((iter->flags & BTREE_ITER_FILTER_SNAPSHOTS) &&
2420 (iter->flags & BTREE_ITER_INTENT) &&
2421 !(iter->flags & BTREE_ITER_IS_EXTENTS) &&
2422 !iter->update_path) {
2423 struct bpos pos = k.k->p;
2425 if (pos.snapshot < iter->snapshot) {
2426 search_key = bpos_successor(k.k->p);
2430 pos.snapshot = iter->snapshot;
2433 * advance, same as on exit for iter->path, but only up
2436 __btree_path_get(iter->path, iter->flags & BTREE_ITER_INTENT);
2437 iter->update_path = iter->path;
2439 iter->update_path = bch2_btree_path_set_pos(trans,
2440 iter->update_path, pos,
2441 iter->flags & BTREE_ITER_INTENT,
2446 * We can never have a key in a leaf node at POS_MAX, so
2447 * we don't have to check these successor() calls:
2449 if ((iter->flags & BTREE_ITER_FILTER_SNAPSHOTS) &&
2450 !bch2_snapshot_is_ancestor(trans->c,
2453 search_key = bpos_successor(k.k->p);
2457 if (bkey_whiteout(k.k) &&
2458 !(iter->flags & BTREE_ITER_ALL_SNAPSHOTS)) {
2459 search_key = bkey_successor(iter, k.k->p);
2466 iter->pos = iter_pos;
2468 iter->path = bch2_btree_path_set_pos(trans, iter->path, k.k->p,
2469 iter->flags & BTREE_ITER_INTENT,
2470 btree_iter_ip_allocated(iter));
2471 BUG_ON(!iter->path->nodes_locked);
2473 if (iter->update_path) {
2474 if (iter->update_path->uptodate &&
2475 !bch2_btree_path_relock(trans, iter->update_path, _THIS_IP_)) {
2476 k = bkey_s_c_err(-EINTR);
2478 BUG_ON(!(iter->update_path->nodes_locked & 1));
2479 iter->update_path->should_be_locked = true;
2482 iter->path->should_be_locked = true;
2484 if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
2485 iter->pos.snapshot = iter->snapshot;
2487 ret = bch2_btree_iter_verify_ret(iter, k);
2488 if (unlikely(ret)) {
2489 bch2_btree_iter_set_pos(iter, iter->pos);
2490 k = bkey_s_c_err(ret);
2493 bch2_btree_iter_verify_entry_exit(iter);
2499 * bch2_btree_iter_next: returns first key greater than iterator's current
2502 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *iter)
2504 if (!bch2_btree_iter_advance(iter))
2505 return bkey_s_c_null;
2507 return bch2_btree_iter_peek(iter);
2511 * bch2_btree_iter_peek_prev: returns first key less than or equal to
2512 * iterator's current position
2514 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *iter)
2516 struct btree_trans *trans = iter->trans;
2517 struct bpos search_key = iter->pos;
2518 struct btree_path *saved_path = NULL;
2520 struct bkey saved_k;
2521 const struct bch_val *saved_v;
2524 EBUG_ON(iter->path->cached || iter->path->level);
2525 EBUG_ON(iter->flags & BTREE_ITER_WITH_UPDATES);
2527 if (iter->flags & BTREE_ITER_WITH_JOURNAL)
2528 return bkey_s_c_err(-EIO);
2530 bch2_btree_iter_verify(iter);
2531 bch2_btree_iter_verify_entry_exit(iter);
2533 if (iter->flags & BTREE_ITER_FILTER_SNAPSHOTS)
2534 search_key.snapshot = U32_MAX;
2537 iter->path = bch2_btree_path_set_pos(trans, iter->path, search_key,
2538 iter->flags & BTREE_ITER_INTENT,
2539 btree_iter_ip_allocated(iter));
2541 ret = bch2_btree_path_traverse(trans, iter->path, iter->flags);
2542 if (unlikely(ret)) {
2543 /* ensure that iter->k is consistent with iter->pos: */
2544 bch2_btree_iter_set_pos(iter, iter->pos);
2545 k = bkey_s_c_err(ret);
2549 k = btree_path_level_peek(trans->c, iter->path,
2550 &iter->path->l[0], &iter->k);
2552 ((iter->flags & BTREE_ITER_IS_EXTENTS)
2553 ? bpos_cmp(bkey_start_pos(k.k), search_key) >= 0
2554 : bpos_cmp(k.k->p, search_key) > 0))
2555 k = btree_path_level_prev(trans->c, iter->path,
2556 &iter->path->l[0], &iter->k);
2558 bch2_btree_path_check_sort(trans, iter->path, 0);
2561 if (iter->flags & BTREE_ITER_FILTER_SNAPSHOTS) {
2562 if (k.k->p.snapshot == iter->snapshot)
2566 * If we have a saved candidate, and we're no
2567 * longer at the same _key_ (not pos), return
2570 if (saved_path && bkey_cmp(k.k->p, saved_k.p)) {
2571 bch2_path_put(trans, iter->path,
2572 iter->flags & BTREE_ITER_INTENT);
2573 iter->path = saved_path;
2580 if (bch2_snapshot_is_ancestor(iter->trans->c,
2584 bch2_path_put(trans, saved_path,
2585 iter->flags & BTREE_ITER_INTENT);
2586 saved_path = btree_path_clone(trans, iter->path,
2587 iter->flags & BTREE_ITER_INTENT);
2592 search_key = bpos_predecessor(k.k->p);
2596 if (bkey_whiteout(k.k) &&
2597 !(iter->flags & BTREE_ITER_ALL_SNAPSHOTS)) {
2598 search_key = bkey_predecessor(iter, k.k->p);
2599 if (iter->flags & BTREE_ITER_FILTER_SNAPSHOTS)
2600 search_key.snapshot = U32_MAX;
2605 } else if (likely(bpos_cmp(iter->path->l[0].b->data->min_key, POS_MIN))) {
2606 /* Advance to previous leaf node: */
2607 search_key = bpos_predecessor(iter->path->l[0].b->data->min_key);
2609 /* Start of btree: */
2610 bch2_btree_iter_set_pos(iter, POS_MIN);
2616 EBUG_ON(bkey_cmp(bkey_start_pos(k.k), iter->pos) > 0);
2618 /* Extents can straddle iter->pos: */
2619 if (bkey_cmp(k.k->p, iter->pos) < 0)
2622 if (iter->flags & BTREE_ITER_FILTER_SNAPSHOTS)
2623 iter->pos.snapshot = iter->snapshot;
2626 bch2_path_put(trans, saved_path, iter->flags & BTREE_ITER_INTENT);
2627 iter->path->should_be_locked = true;
2629 bch2_btree_iter_verify_entry_exit(iter);
2630 bch2_btree_iter_verify(iter);
2636 * bch2_btree_iter_prev: returns first key less than iterator's current
2639 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *iter)
2641 if (!bch2_btree_iter_rewind(iter))
2642 return bkey_s_c_null;
2644 return bch2_btree_iter_peek_prev(iter);
2647 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *iter)
2649 struct btree_trans *trans = iter->trans;
2650 struct bpos search_key;
2654 EBUG_ON(iter->path->level);
2655 bch2_btree_iter_verify(iter);
2656 bch2_btree_iter_verify_entry_exit(iter);
2658 /* extents can't span inode numbers: */
2659 if ((iter->flags & BTREE_ITER_IS_EXTENTS) &&
2660 unlikely(iter->pos.offset == KEY_OFFSET_MAX)) {
2661 if (iter->pos.inode == KEY_INODE_MAX)
2662 return bkey_s_c_null;
2664 bch2_btree_iter_set_pos(iter, bpos_nosnap_successor(iter->pos));
2667 search_key = btree_iter_search_key(iter);
2668 iter->path = bch2_btree_path_set_pos(trans, iter->path, search_key,
2669 iter->flags & BTREE_ITER_INTENT,
2670 btree_iter_ip_allocated(iter));
2672 ret = bch2_btree_path_traverse(trans, iter->path, iter->flags);
2674 return bkey_s_c_err(ret);
2676 if ((iter->flags & BTREE_ITER_CACHED) ||
2677 !(iter->flags & (BTREE_ITER_IS_EXTENTS|BTREE_ITER_FILTER_SNAPSHOTS))) {
2678 struct bkey_i *next_update;
2680 if ((iter->flags & BTREE_ITER_WITH_UPDATES) &&
2681 (next_update = btree_trans_peek_updates(trans,
2682 iter->btree_id, search_key)) &&
2683 !bpos_cmp(next_update->k.p, iter->pos)) {
2684 iter->k = next_update->k;
2685 k = bkey_i_to_s_c(next_update);
2689 if (unlikely(iter->flags & BTREE_ITER_WITH_JOURNAL) &&
2690 (next_update = bch2_journal_keys_peek(trans->c, iter->btree_id,
2692 !bpos_cmp(next_update->k.p, iter->pos)) {
2693 iter->k = next_update->k;
2694 k = bkey_i_to_s_c(next_update);
2698 if (unlikely(iter->flags & BTREE_ITER_WITH_KEY_CACHE) &&
2699 (k = btree_trans_peek_key_cache(iter, iter->pos)).k) {
2705 k = bch2_btree_path_peek_slot(iter->path, &iter->k);
2709 if (iter->flags & BTREE_ITER_INTENT) {
2710 struct btree_iter iter2;
2711 struct bpos end = iter->pos;
2713 if (iter->flags & BTREE_ITER_IS_EXTENTS)
2714 end.offset = U64_MAX;
2716 bch2_trans_copy_iter(&iter2, iter);
2717 k = bch2_btree_iter_peek_upto(&iter2, end);
2719 if (k.k && !bkey_err(k)) {
2723 bch2_trans_iter_exit(trans, &iter2);
2725 struct bpos pos = iter->pos;
2727 k = bch2_btree_iter_peek(iter);
2731 if (unlikely(bkey_err(k)))
2734 next = k.k ? bkey_start_pos(k.k) : POS_MAX;
2736 if (bkey_cmp(iter->pos, next) < 0) {
2737 bkey_init(&iter->k);
2738 iter->k.p = iter->pos;
2740 if (iter->flags & BTREE_ITER_IS_EXTENTS) {
2741 bch2_key_resize(&iter->k,
2742 min_t(u64, KEY_SIZE_MAX,
2743 (next.inode == iter->pos.inode
2747 EBUG_ON(!iter->k.size);
2750 k = (struct bkey_s_c) { &iter->k, NULL };
2754 iter->path->should_be_locked = true;
2756 bch2_btree_iter_verify_entry_exit(iter);
2757 bch2_btree_iter_verify(iter);
2758 ret = bch2_btree_iter_verify_ret(iter, k);
2760 return bkey_s_c_err(ret);
2765 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *iter)
2767 if (!bch2_btree_iter_advance(iter))
2768 return bkey_s_c_null;
2770 return bch2_btree_iter_peek_slot(iter);
2773 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *iter)
2775 if (!bch2_btree_iter_rewind(iter))
2776 return bkey_s_c_null;
2778 return bch2_btree_iter_peek_slot(iter);
2781 /* new transactional stuff: */
2783 static inline void btree_path_verify_sorted_ref(struct btree_trans *trans,
2784 struct btree_path *path)
2786 EBUG_ON(path->sorted_idx >= trans->nr_sorted);
2787 EBUG_ON(trans->sorted[path->sorted_idx] != path->idx);
2788 EBUG_ON(!(trans->paths_allocated & (1ULL << path->idx)));
2791 static inline void btree_trans_verify_sorted_refs(struct btree_trans *trans)
2793 #ifdef CONFIG_BCACHEFS_DEBUG
2796 for (i = 0; i < trans->nr_sorted; i++)
2797 btree_path_verify_sorted_ref(trans, trans->paths + trans->sorted[i]);
2801 static void btree_trans_verify_sorted(struct btree_trans *trans)
2803 #ifdef CONFIG_BCACHEFS_DEBUG
2804 struct btree_path *path, *prev = NULL;
2807 trans_for_each_path_inorder(trans, path, i) {
2808 if (prev && btree_path_cmp(prev, path) > 0) {
2809 bch2_dump_trans_paths_updates(trans);
2810 panic("trans paths out of order!\n");
2817 static inline void btree_path_swap(struct btree_trans *trans,
2818 struct btree_path *l, struct btree_path *r)
2820 swap(l->sorted_idx, r->sorted_idx);
2821 swap(trans->sorted[l->sorted_idx],
2822 trans->sorted[r->sorted_idx]);
2824 btree_path_verify_sorted_ref(trans, l);
2825 btree_path_verify_sorted_ref(trans, r);
2828 inline void bch2_btree_path_check_sort(struct btree_trans *trans, struct btree_path *path,
2831 struct btree_path *n;
2834 n = prev_btree_path(trans, path);
2835 if (n && btree_path_cmp(n, path) > 0) {
2837 btree_path_swap(trans, n, path);
2838 n = prev_btree_path(trans, path);
2839 } while (n && btree_path_cmp(n, path) > 0);
2846 n = next_btree_path(trans, path);
2847 if (n && btree_path_cmp(path, n) > 0) {
2849 btree_path_swap(trans, path, n);
2850 n = next_btree_path(trans, path);
2851 } while (n && btree_path_cmp(path, n) > 0);
2855 btree_trans_verify_sorted(trans);
2858 static inline void btree_path_list_remove(struct btree_trans *trans,
2859 struct btree_path *path)
2863 EBUG_ON(path->sorted_idx >= trans->nr_sorted);
2865 array_remove_item(trans->sorted, trans->nr_sorted, path->sorted_idx);
2867 for (i = path->sorted_idx; i < trans->nr_sorted; i++)
2868 trans->paths[trans->sorted[i]].sorted_idx = i;
2870 path->sorted_idx = U8_MAX;
2872 btree_trans_verify_sorted_refs(trans);
2875 static inline void btree_path_list_add(struct btree_trans *trans,
2876 struct btree_path *pos,
2877 struct btree_path *path)
2881 btree_trans_verify_sorted_refs(trans);
2883 path->sorted_idx = pos ? pos->sorted_idx + 1 : 0;
2885 if (trans->in_traverse_all &&
2886 trans->traverse_all_idx != U8_MAX &&
2887 trans->traverse_all_idx >= path->sorted_idx)
2888 trans->traverse_all_idx++;
2890 array_insert_item(trans->sorted, trans->nr_sorted, path->sorted_idx, path->idx);
2892 for (i = path->sorted_idx; i < trans->nr_sorted; i++)
2893 trans->paths[trans->sorted[i]].sorted_idx = i;
2895 btree_trans_verify_sorted_refs(trans);
2898 void bch2_trans_iter_exit(struct btree_trans *trans, struct btree_iter *iter)
2901 bch2_path_put(trans, iter->path,
2902 iter->flags & BTREE_ITER_INTENT);
2903 if (iter->update_path)
2904 bch2_path_put(trans, iter->update_path,
2905 iter->flags & BTREE_ITER_INTENT);
2906 if (iter->key_cache_path)
2907 bch2_path_put(trans, iter->key_cache_path,
2908 iter->flags & BTREE_ITER_INTENT);
2910 iter->update_path = NULL;
2911 iter->key_cache_path = NULL;
2914 static void __bch2_trans_iter_init(struct btree_trans *trans,
2915 struct btree_iter *iter,
2916 unsigned btree_id, struct bpos pos,
2917 unsigned locks_want,
2922 EBUG_ON(trans->restarted);
2924 if (!(flags & (BTREE_ITER_ALL_SNAPSHOTS|BTREE_ITER_NOT_EXTENTS)) &&
2925 btree_node_type_is_extents(btree_id))
2926 flags |= BTREE_ITER_IS_EXTENTS;
2928 if (!(flags & __BTREE_ITER_ALL_SNAPSHOTS) &&
2929 !btree_type_has_snapshots(btree_id))
2930 flags &= ~BTREE_ITER_ALL_SNAPSHOTS;
2932 if (!(flags & BTREE_ITER_ALL_SNAPSHOTS) &&
2933 btree_type_has_snapshots(btree_id))
2934 flags |= BTREE_ITER_FILTER_SNAPSHOTS;
2936 if (!test_bit(JOURNAL_REPLAY_DONE, &trans->c->journal.flags))
2937 flags |= BTREE_ITER_WITH_JOURNAL;
2939 if (!btree_id_cached(trans->c, btree_id)) {
2940 flags &= ~BTREE_ITER_CACHED;
2941 flags &= ~BTREE_ITER_WITH_KEY_CACHE;
2942 } else if (!(flags & BTREE_ITER_CACHED))
2943 flags |= BTREE_ITER_WITH_KEY_CACHE;
2945 iter->trans = trans;
2947 iter->update_path = NULL;
2948 iter->key_cache_path = NULL;
2949 iter->btree_id = btree_id;
2950 iter->min_depth = depth;
2951 iter->flags = flags;
2952 iter->snapshot = pos.snapshot;
2954 iter->k.type = KEY_TYPE_deleted;
2957 #ifdef CONFIG_BCACHEFS_DEBUG
2958 iter->ip_allocated = ip;
2961 iter->path = bch2_path_get(trans, btree_id, iter->pos,
2962 locks_want, depth, flags, ip);
2965 void bch2_trans_iter_init(struct btree_trans *trans,
2966 struct btree_iter *iter,
2967 unsigned btree_id, struct bpos pos,
2970 __bch2_trans_iter_init(trans, iter, btree_id, pos,
2971 0, 0, flags, _RET_IP_);
2974 void bch2_trans_node_iter_init(struct btree_trans *trans,
2975 struct btree_iter *iter,
2976 enum btree_id btree_id,
2978 unsigned locks_want,
2982 __bch2_trans_iter_init(trans, iter, btree_id, pos, locks_want, depth,
2983 BTREE_ITER_NOT_EXTENTS|
2984 __BTREE_ITER_ALL_SNAPSHOTS|
2985 BTREE_ITER_ALL_SNAPSHOTS|
2987 BUG_ON(iter->path->locks_want < min(locks_want, BTREE_MAX_DEPTH));
2988 BUG_ON(iter->path->level != depth);
2989 BUG_ON(iter->min_depth != depth);
2992 void bch2_trans_copy_iter(struct btree_iter *dst, struct btree_iter *src)
2996 __btree_path_get(src->path, src->flags & BTREE_ITER_INTENT);
2997 if (src->update_path)
2998 __btree_path_get(src->update_path, src->flags & BTREE_ITER_INTENT);
2999 dst->key_cache_path = NULL;
3002 void *bch2_trans_kmalloc(struct btree_trans *trans, size_t size)
3004 size_t new_top = trans->mem_top + size;
3007 if (new_top > trans->mem_bytes) {
3008 size_t old_bytes = trans->mem_bytes;
3009 size_t new_bytes = roundup_pow_of_two(new_top);
3012 WARN_ON_ONCE(new_bytes > BTREE_TRANS_MEM_MAX);
3014 new_mem = krealloc(trans->mem, new_bytes, GFP_NOFS);
3015 if (!new_mem && new_bytes <= BTREE_TRANS_MEM_MAX) {
3016 new_mem = mempool_alloc(&trans->c->btree_trans_mem_pool, GFP_KERNEL);
3017 new_bytes = BTREE_TRANS_MEM_MAX;
3022 return ERR_PTR(-ENOMEM);
3024 trans->mem = new_mem;
3025 trans->mem_bytes = new_bytes;
3028 trace_trans_restart_mem_realloced(trans->fn, _RET_IP_, new_bytes);
3029 btree_trans_restart(trans);
3030 return ERR_PTR(-EINTR);
3034 p = trans->mem + trans->mem_top;
3035 trans->mem_top += size;
3041 * bch2_trans_begin() - reset a transaction after a interrupted attempt
3042 * @trans: transaction to reset
3044 * While iterating over nodes or updating nodes a attempt to lock a btree
3045 * node may return EINTR when the trylock fails. When this occurs
3046 * bch2_trans_begin() should be called and the transaction retried.
3048 void bch2_trans_begin(struct btree_trans *trans)
3050 struct btree_insert_entry *i;
3051 struct btree_path *path;
3053 trans_for_each_update(trans, i)
3054 __btree_path_put(i->path, true);
3056 memset(&trans->journal_res, 0, sizeof(trans->journal_res));
3057 trans->extra_journal_res = 0;
3058 trans->nr_updates = 0;
3061 trans->hooks = NULL;
3062 trans->extra_journal_entries.nr = 0;
3064 if (trans->fs_usage_deltas) {
3065 trans->fs_usage_deltas->used = 0;
3066 memset(&trans->fs_usage_deltas->memset_start, 0,
3067 (void *) &trans->fs_usage_deltas->memset_end -
3068 (void *) &trans->fs_usage_deltas->memset_start);
3071 trans_for_each_path(trans, path) {
3072 path->should_be_locked = false;
3075 * If the transaction wasn't restarted, we're presuming to be
3076 * doing something new: dont keep iterators excpt the ones that
3077 * are in use - except for the subvolumes btree:
3079 if (!trans->restarted && path->btree_id != BTREE_ID_subvolumes)
3080 path->preserve = false;
3083 * XXX: we probably shouldn't be doing this if the transaction
3084 * was restarted, but currently we still overflow transaction
3085 * iterators if we do that
3087 if (!path->ref && !path->preserve)
3088 __bch2_path_free(trans, path);
3090 path->preserve = false;
3093 bch2_trans_cond_resched(trans);
3095 if (trans->restarted)
3096 bch2_btree_path_traverse_all(trans);
3098 trans->restarted = false;
3101 static void bch2_trans_alloc_paths(struct btree_trans *trans, struct bch_fs *c)
3103 size_t paths_bytes = sizeof(struct btree_path) * BTREE_ITER_MAX;
3104 size_t updates_bytes = sizeof(struct btree_insert_entry) * BTREE_ITER_MAX;
3107 BUG_ON(trans->used_mempool);
3110 p = this_cpu_xchg(c->btree_paths_bufs->path , NULL);
3113 p = mempool_alloc(&trans->c->btree_paths_pool, GFP_NOFS);
3115 trans->paths = p; p += paths_bytes;
3116 trans->updates = p; p += updates_bytes;
3119 void __bch2_trans_init(struct btree_trans *trans, struct bch_fs *c,
3120 unsigned expected_nr_iters,
3121 size_t expected_mem_bytes,
3123 __acquires(&c->btree_trans_barrier)
3125 BUG_ON(lock_class_is_held(&bch2_btree_node_lock_key));
3127 memset(trans, 0, sizeof(*trans));
3131 bch2_trans_alloc_paths(trans, c);
3133 if (expected_mem_bytes) {
3134 trans->mem_bytes = roundup_pow_of_two(expected_mem_bytes);
3135 trans->mem = kmalloc(trans->mem_bytes, GFP_KERNEL|__GFP_NOFAIL);
3137 if (!unlikely(trans->mem)) {
3138 trans->mem = mempool_alloc(&c->btree_trans_mem_pool, GFP_KERNEL);
3139 trans->mem_bytes = BTREE_TRANS_MEM_MAX;
3143 trans->srcu_idx = srcu_read_lock(&c->btree_trans_barrier);
3145 trans->pid = current->pid;
3146 mutex_lock(&c->btree_trans_lock);
3147 list_add(&trans->list, &c->btree_trans_list);
3148 mutex_unlock(&c->btree_trans_lock);
3151 static void check_btree_paths_leaked(struct btree_trans *trans)
3153 #ifdef CONFIG_BCACHEFS_DEBUG
3154 struct bch_fs *c = trans->c;
3155 struct btree_path *path;
3157 trans_for_each_path(trans, path)
3162 bch_err(c, "btree paths leaked from %s!", trans->fn);
3163 trans_for_each_path(trans, path)
3165 printk(KERN_ERR " btree %s %pS\n",
3166 bch2_btree_ids[path->btree_id],
3167 (void *) path->ip_allocated);
3168 /* Be noisy about this: */
3169 bch2_fatal_error(c);
3173 void bch2_trans_exit(struct btree_trans *trans)
3174 __releases(&c->btree_trans_barrier)
3176 struct btree_insert_entry *i;
3177 struct bch_fs *c = trans->c;
3179 bch2_trans_unlock(trans);
3181 trans_for_each_update(trans, i)
3182 __btree_path_put(i->path, true);
3183 trans->nr_updates = 0;
3185 check_btree_paths_leaked(trans);
3187 mutex_lock(&c->btree_trans_lock);
3188 list_del(&trans->list);
3189 mutex_unlock(&c->btree_trans_lock);
3191 srcu_read_unlock(&c->btree_trans_barrier, trans->srcu_idx);
3193 bch2_journal_preres_put(&c->journal, &trans->journal_preres);
3195 kfree(trans->extra_journal_entries.data);
3197 if (trans->fs_usage_deltas) {
3198 if (trans->fs_usage_deltas->size + sizeof(trans->fs_usage_deltas) ==
3199 REPLICAS_DELTA_LIST_MAX)
3200 mempool_free(trans->fs_usage_deltas,
3201 &c->replicas_delta_pool);
3203 kfree(trans->fs_usage_deltas);
3206 if (trans->mem_bytes == BTREE_TRANS_MEM_MAX)
3207 mempool_free(trans->mem, &c->btree_trans_mem_pool);
3213 * Userspace doesn't have a real percpu implementation:
3215 trans->paths = this_cpu_xchg(c->btree_paths_bufs->path, trans->paths);
3219 mempool_free(trans->paths, &c->btree_paths_pool);
3221 trans->mem = (void *) 0x1;
3222 trans->paths = (void *) 0x1;
3225 static void __maybe_unused
3226 bch2_btree_path_node_to_text(struct printbuf *out,
3227 struct btree_bkey_cached_common *_b,
3230 pr_buf(out, " l=%u %s:",
3231 _b->level, bch2_btree_ids[_b->btree_id]);
3232 bch2_bpos_to_text(out, btree_node_pos(_b, cached));
3235 static bool trans_has_locks(struct btree_trans *trans)
3237 struct btree_path *path;
3239 trans_for_each_path(trans, path)
3240 if (path->nodes_locked)
3245 void bch2_btree_trans_to_text(struct printbuf *out, struct bch_fs *c)
3247 struct btree_trans *trans;
3248 struct btree_path *path;
3250 static char lock_types[] = { 'r', 'i', 'w' };
3253 mutex_lock(&c->btree_trans_lock);
3254 list_for_each_entry(trans, &c->btree_trans_list, list) {
3255 if (!trans_has_locks(trans))
3258 pr_buf(out, "%i %s\n", trans->pid, trans->fn);
3260 trans_for_each_path(trans, path) {
3261 if (!path->nodes_locked)
3264 pr_buf(out, " path %u %c l=%u %s:",
3266 path->cached ? 'c' : 'b',
3268 bch2_btree_ids[path->btree_id]);
3269 bch2_bpos_to_text(out, path->pos);
3272 for (l = 0; l < BTREE_MAX_DEPTH; l++) {
3273 if (btree_node_locked(path, l)) {
3274 pr_buf(out, " %s l=%u ",
3275 btree_node_intent_locked(path, l) ? "i" : "r", l);
3276 bch2_btree_path_node_to_text(out,
3277 (void *) path->l[l].b,
3284 b = READ_ONCE(trans->locking);
3286 path = &trans->paths[trans->locking_path_idx];
3287 pr_buf(out, " locking path %u %c l=%u %c %s:",
3288 trans->locking_path_idx,
3289 path->cached ? 'c' : 'b',
3290 trans->locking_level,
3291 lock_types[trans->locking_lock_type],
3292 bch2_btree_ids[trans->locking_btree_id]);
3293 bch2_bpos_to_text(out, trans->locking_pos);
3295 pr_buf(out, " node ");
3296 bch2_btree_path_node_to_text(out,
3297 (void *) b, path->cached);
3301 mutex_unlock(&c->btree_trans_lock);
3304 void bch2_fs_btree_iter_exit(struct bch_fs *c)
3306 if (c->btree_trans_barrier_initialized)
3307 cleanup_srcu_struct(&c->btree_trans_barrier);
3308 mempool_exit(&c->btree_trans_mem_pool);
3309 mempool_exit(&c->btree_paths_pool);
3312 int bch2_fs_btree_iter_init(struct bch_fs *c)
3314 unsigned nr = BTREE_ITER_MAX;
3317 INIT_LIST_HEAD(&c->btree_trans_list);
3318 mutex_init(&c->btree_trans_lock);
3320 ret = mempool_init_kmalloc_pool(&c->btree_paths_pool, 1,
3321 sizeof(struct btree_path) * nr +
3322 sizeof(struct btree_insert_entry) * nr) ?:
3323 mempool_init_kmalloc_pool(&c->btree_trans_mem_pool, 1,
3324 BTREE_TRANS_MEM_MAX) ?:
3325 init_srcu_struct(&c->btree_trans_barrier);
3327 c->btree_trans_barrier_initialized = true;