3 #include "btree_cache.h"
5 #include "btree_iter.h"
6 #include "btree_locking.h"
10 #include <linux/prefetch.h>
11 #include <trace/events/bcachefs.h>
13 #define DEF_BTREE_ID(kwd, val, name) name,
15 const char * const bch2_btree_ids[] = {
16 DEFINE_BCH_BTREE_IDS()
22 void bch2_recalc_btree_reserve(struct bch_fs *c)
24 unsigned i, reserve = 16;
26 if (!c->btree_roots[0].b)
29 for (i = 0; i < BTREE_ID_NR; i++)
30 if (c->btree_roots[i].b)
31 reserve += min_t(unsigned, 1,
32 c->btree_roots[i].b->level) * 8;
34 c->btree_cache_reserve = reserve;
37 #define mca_can_free(c) \
38 max_t(int, 0, c->btree_cache_used - c->btree_cache_reserve)
40 static void __mca_data_free(struct bch_fs *c, struct btree *b)
42 EBUG_ON(btree_node_write_in_flight(b));
44 kvpfree(b->data, btree_bytes(c));
46 bch2_btree_keys_free(b);
49 static void mca_data_free(struct bch_fs *c, struct btree *b)
51 __mca_data_free(c, b);
52 c->btree_cache_used--;
53 list_move(&b->list, &c->btree_cache_freed);
56 static const struct rhashtable_params bch_btree_cache_params = {
57 .head_offset = offsetof(struct btree, hash),
58 .key_offset = offsetof(struct btree, key.v),
59 .key_len = sizeof(struct bch_extent_ptr),
62 static void mca_data_alloc(struct bch_fs *c, struct btree *b, gfp_t gfp)
64 b->data = kvpmalloc(btree_bytes(c), gfp);
68 if (bch2_btree_keys_alloc(b, btree_page_order(c), gfp))
71 c->btree_cache_used++;
72 list_move(&b->list, &c->btree_cache_freeable);
75 kvpfree(b->data, btree_bytes(c));
77 list_move(&b->list, &c->btree_cache_freed);
80 static struct btree *mca_bucket_alloc(struct bch_fs *c, gfp_t gfp)
82 struct btree *b = kzalloc(sizeof(struct btree), gfp);
86 bkey_extent_init(&b->key);
87 six_lock_init(&b->lock);
88 INIT_LIST_HEAD(&b->list);
89 INIT_LIST_HEAD(&b->write_blocked);
91 mca_data_alloc(c, b, gfp);
92 return b->data ? b : NULL;
95 /* Btree in memory cache - hash table */
97 void bch2_btree_node_hash_remove(struct bch_fs *c, struct btree *b)
99 rhashtable_remove_fast(&c->btree_cache_table, &b->hash,
100 bch_btree_cache_params);
102 /* Cause future lookups for this node to fail: */
103 bkey_i_to_extent(&b->key)->v._data[0] = 0;
106 int __bch2_btree_node_hash_insert(struct bch_fs *c, struct btree *b)
108 return rhashtable_lookup_insert_fast(&c->btree_cache_table, &b->hash,
109 bch_btree_cache_params);
112 int bch2_btree_node_hash_insert(struct bch_fs *c, struct btree *b,
113 unsigned level, enum btree_id id)
120 mutex_lock(&c->btree_cache_lock);
121 ret = __bch2_btree_node_hash_insert(c, b);
123 list_add(&b->list, &c->btree_cache);
124 mutex_unlock(&c->btree_cache_lock);
130 static inline struct btree *mca_find(struct bch_fs *c,
131 const struct bkey_i *k)
133 return rhashtable_lookup_fast(&c->btree_cache_table, &PTR_HASH(k),
134 bch_btree_cache_params);
138 * this version is for btree nodes that have already been freed (we're not
139 * reaping a real btree node)
141 static int __btree_node_reclaim(struct bch_fs *c, struct btree *b, bool flush)
145 lockdep_assert_held(&c->btree_cache_lock);
147 if (!six_trylock_intent(&b->lock))
150 if (!six_trylock_write(&b->lock))
151 goto out_unlock_intent;
153 if (btree_node_noevict(b))
156 if (!btree_node_may_write(b))
159 if (btree_node_dirty(b) ||
160 btree_node_write_in_flight(b) ||
161 btree_node_read_in_flight(b)) {
165 wait_on_bit_io(&b->flags, BTREE_NODE_read_in_flight,
166 TASK_UNINTERRUPTIBLE);
169 * Using the underscore version because we don't want to compact
170 * bsets after the write, since this node is about to be evicted
171 * - unless btree verify mode is enabled, since it runs out of
172 * the post write cleanup:
174 if (verify_btree_ondisk(c))
175 bch2_btree_node_write(c, b, NULL, SIX_LOCK_intent);
177 __bch2_btree_node_write(c, b, NULL, SIX_LOCK_read);
179 /* wait for any in flight btree write */
180 btree_node_wait_on_io(b);
183 if (PTR_HASH(&b->key))
184 trace_btree_node_reap(c, b, ret);
187 six_unlock_write(&b->lock);
189 six_unlock_intent(&b->lock);
194 static int btree_node_reclaim(struct bch_fs *c, struct btree *b)
196 return __btree_node_reclaim(c, b, false);
199 static int btree_node_write_and_reclaim(struct bch_fs *c, struct btree *b)
201 return __btree_node_reclaim(c, b, true);
204 static unsigned long bch2_mca_scan(struct shrinker *shrink,
205 struct shrink_control *sc)
207 struct bch_fs *c = container_of(shrink, struct bch_fs,
210 unsigned long nr = sc->nr_to_scan;
211 unsigned long can_free;
212 unsigned long touched = 0;
213 unsigned long freed = 0;
216 if (btree_shrinker_disabled(c))
219 if (c->btree_cache_alloc_lock)
222 /* Return -1 if we can't do anything right now */
223 if (sc->gfp_mask & __GFP_IO)
224 mutex_lock(&c->btree_cache_lock);
225 else if (!mutex_trylock(&c->btree_cache_lock))
229 * It's _really_ critical that we don't free too many btree nodes - we
230 * have to always leave ourselves a reserve. The reserve is how we
231 * guarantee that allocating memory for a new btree node can always
232 * succeed, so that inserting keys into the btree can always succeed and
233 * IO can always make forward progress:
235 nr /= btree_pages(c);
236 can_free = mca_can_free(c);
237 nr = min_t(unsigned long, nr, can_free);
240 list_for_each_entry_safe(b, t, &c->btree_cache_freeable, list) {
247 !btree_node_reclaim(c, b)) {
249 six_unlock_write(&b->lock);
250 six_unlock_intent(&b->lock);
255 list_for_each_entry_safe(b, t, &c->btree_cache, list) {
260 if (&t->list != &c->btree_cache)
261 list_move_tail(&c->btree_cache, &t->list);
265 if (!btree_node_accessed(b) &&
266 !btree_node_reclaim(c, b)) {
267 /* can't call bch2_btree_node_hash_remove under btree_cache_lock */
269 if (&t->list != &c->btree_cache)
270 list_move_tail(&c->btree_cache, &t->list);
273 mutex_unlock(&c->btree_cache_lock);
275 bch2_btree_node_hash_remove(c, b);
276 six_unlock_write(&b->lock);
277 six_unlock_intent(&b->lock);
282 if (sc->gfp_mask & __GFP_IO)
283 mutex_lock(&c->btree_cache_lock);
284 else if (!mutex_trylock(&c->btree_cache_lock))
288 clear_btree_node_accessed(b);
291 mutex_unlock(&c->btree_cache_lock);
293 return (unsigned long) freed * btree_pages(c);
296 static unsigned long bch2_mca_count(struct shrinker *shrink,
297 struct shrink_control *sc)
299 struct bch_fs *c = container_of(shrink, struct bch_fs,
302 if (btree_shrinker_disabled(c))
305 if (c->btree_cache_alloc_lock)
308 return mca_can_free(c) * btree_pages(c);
311 void bch2_fs_btree_exit(struct bch_fs *c)
316 if (c->btree_cache_shrink.list.next)
317 unregister_shrinker(&c->btree_cache_shrink);
319 mutex_lock(&c->btree_cache_lock);
321 #ifdef CONFIG_BCACHEFS_DEBUG
323 list_move(&c->verify_data->list, &c->btree_cache);
325 kvpfree(c->verify_ondisk, btree_bytes(c));
328 for (i = 0; i < BTREE_ID_NR; i++)
329 if (c->btree_roots[i].b)
330 list_add(&c->btree_roots[i].b->list, &c->btree_cache);
332 list_splice(&c->btree_cache_freeable,
335 while (!list_empty(&c->btree_cache)) {
336 b = list_first_entry(&c->btree_cache, struct btree, list);
338 if (btree_node_dirty(b))
339 bch2_btree_complete_write(c, b, btree_current_write(b));
340 clear_btree_node_dirty(b);
345 while (!list_empty(&c->btree_cache_freed)) {
346 b = list_first_entry(&c->btree_cache_freed,
352 mutex_unlock(&c->btree_cache_lock);
354 if (c->btree_cache_table_init_done)
355 rhashtable_destroy(&c->btree_cache_table);
358 int bch2_fs_btree_init(struct bch_fs *c)
363 ret = rhashtable_init(&c->btree_cache_table, &bch_btree_cache_params);
367 c->btree_cache_table_init_done = true;
369 bch2_recalc_btree_reserve(c);
371 for (i = 0; i < c->btree_cache_reserve; i++)
372 if (!mca_bucket_alloc(c, GFP_KERNEL))
375 list_splice_init(&c->btree_cache,
376 &c->btree_cache_freeable);
378 #ifdef CONFIG_BCACHEFS_DEBUG
379 mutex_init(&c->verify_lock);
381 c->verify_ondisk = kvpmalloc(btree_bytes(c), GFP_KERNEL);
382 if (!c->verify_ondisk)
385 c->verify_data = mca_bucket_alloc(c, GFP_KERNEL);
389 list_del_init(&c->verify_data->list);
392 c->btree_cache_shrink.count_objects = bch2_mca_count;
393 c->btree_cache_shrink.scan_objects = bch2_mca_scan;
394 c->btree_cache_shrink.seeks = 4;
395 c->btree_cache_shrink.batch = btree_pages(c) * 2;
396 register_shrinker(&c->btree_cache_shrink);
402 * We can only have one thread cannibalizing other cached btree nodes at a time,
403 * or we'll deadlock. We use an open coded mutex to ensure that, which a
404 * cannibalize_bucket() will take. This means every time we unlock the root of
405 * the btree, we need to release this lock if we have it held.
407 void bch2_btree_node_cannibalize_unlock(struct bch_fs *c)
409 if (c->btree_cache_alloc_lock == current) {
410 trace_btree_node_cannibalize_unlock(c);
411 c->btree_cache_alloc_lock = NULL;
412 closure_wake_up(&c->mca_wait);
416 int bch2_btree_node_cannibalize_lock(struct bch_fs *c, struct closure *cl)
418 struct task_struct *old;
420 old = cmpxchg(&c->btree_cache_alloc_lock, NULL, current);
421 if (old == NULL || old == current)
425 trace_btree_node_cannibalize_lock_fail(c);
429 closure_wait(&c->mca_wait, cl);
431 /* Try again, after adding ourselves to waitlist */
432 old = cmpxchg(&c->btree_cache_alloc_lock, NULL, current);
433 if (old == NULL || old == current) {
435 closure_wake_up(&c->mca_wait);
439 trace_btree_node_cannibalize_lock_fail(c);
443 trace_btree_node_cannibalize_lock(c);
447 static struct btree *mca_cannibalize(struct bch_fs *c)
451 list_for_each_entry_reverse(b, &c->btree_cache, list)
452 if (!btree_node_reclaim(c, b))
456 list_for_each_entry_reverse(b, &c->btree_cache, list)
457 if (!btree_node_write_and_reclaim(c, b))
461 * Rare case: all nodes were intent-locked.
464 WARN_ONCE(1, "btree cache cannibalize failed\n");
469 struct btree *bch2_btree_node_mem_alloc(struct bch_fs *c)
472 u64 start_time = local_clock();
474 mutex_lock(&c->btree_cache_lock);
477 * btree_free() doesn't free memory; it sticks the node on the end of
478 * the list. Check if there's any freed nodes there:
480 list_for_each_entry(b, &c->btree_cache_freeable, list)
481 if (!btree_node_reclaim(c, b))
485 * We never free struct btree itself, just the memory that holds the on
486 * disk node. Check the freed list before allocating a new one:
488 list_for_each_entry(b, &c->btree_cache_freed, list)
489 if (!btree_node_reclaim(c, b)) {
490 mca_data_alloc(c, b, __GFP_NOWARN|GFP_NOIO);
494 six_unlock_write(&b->lock);
495 six_unlock_intent(&b->lock);
499 b = mca_bucket_alloc(c, __GFP_NOWARN|GFP_NOIO);
503 BUG_ON(!six_trylock_intent(&b->lock));
504 BUG_ON(!six_trylock_write(&b->lock));
506 BUG_ON(btree_node_hashed(b));
507 BUG_ON(btree_node_write_in_flight(b));
509 list_del_init(&b->list);
510 mutex_unlock(&c->btree_cache_lock);
517 b->whiteout_u64s = 0;
518 b->uncompacted_whiteout_u64s = 0;
519 bch2_btree_keys_init(b, &c->expensive_debug_checks);
521 bch2_time_stats_update(&c->btree_node_mem_alloc_time, start_time);
525 /* Try to cannibalize another cached btree node: */
526 if (c->btree_cache_alloc_lock == current) {
527 b = mca_cannibalize(c);
528 list_del_init(&b->list);
529 mutex_unlock(&c->btree_cache_lock);
531 bch2_btree_node_hash_remove(c, b);
533 trace_btree_node_cannibalize(c);
537 mutex_unlock(&c->btree_cache_lock);
538 return ERR_PTR(-ENOMEM);
541 /* Slowpath, don't want it inlined into btree_iter_traverse() */
542 static noinline struct btree *bch2_btree_node_fill(struct bch_fs *c,
543 struct btree_iter *iter,
544 const struct bkey_i *k,
546 enum six_lock_type lock_type)
551 * Parent node must be locked, else we could read in a btree node that's
554 BUG_ON(!btree_node_locked(iter, level + 1));
556 b = bch2_btree_node_mem_alloc(c);
560 bkey_copy(&b->key, k);
561 if (bch2_btree_node_hash_insert(c, b, level, iter->btree_id)) {
562 /* raced with another fill: */
564 /* mark as unhashed... */
565 bkey_i_to_extent(&b->key)->v._data[0] = 0;
567 mutex_lock(&c->btree_cache_lock);
568 list_add(&b->list, &c->btree_cache_freeable);
569 mutex_unlock(&c->btree_cache_lock);
571 six_unlock_write(&b->lock);
572 six_unlock_intent(&b->lock);
577 * If the btree node wasn't cached, we can't drop our lock on
578 * the parent until after it's added to the cache - because
579 * otherwise we could race with a btree_split() freeing the node
580 * we're trying to lock.
582 * But the deadlock described below doesn't exist in this case,
583 * so it's safe to not drop the parent lock until here:
585 if (btree_node_read_locked(iter, level + 1))
586 btree_node_unlock(iter, level + 1);
588 bch2_btree_node_read(c, b, true);
589 six_unlock_write(&b->lock);
591 if (lock_type == SIX_LOCK_read)
592 six_lock_downgrade(&b->lock);
598 * bch_btree_node_get - find a btree node in the cache and lock it, reading it
599 * in from disk if necessary.
601 * If IO is necessary and running under generic_make_request, returns -EAGAIN.
603 * The btree node will have either a read or a write lock held, depending on
604 * the @write parameter.
606 struct btree *bch2_btree_node_get(struct bch_fs *c, struct btree_iter *iter,
607 const struct bkey_i *k, unsigned level,
608 enum six_lock_type lock_type)
613 BUG_ON(level >= BTREE_MAX_DEPTH);
621 * We must have the parent locked to call bch2_btree_node_fill(),
622 * else we could read in a btree node from disk that's been
625 b = bch2_btree_node_fill(c, iter, k, level, lock_type);
627 /* We raced and found the btree node in the cache */
635 * There's a potential deadlock with splits and insertions into
636 * interior nodes we have to avoid:
638 * The other thread might be holding an intent lock on the node
639 * we want, and they want to update its parent node so they're
640 * going to upgrade their intent lock on the parent node to a
643 * But if we're holding a read lock on the parent, and we're
644 * trying to get the intent lock they're holding, we deadlock.
646 * So to avoid this we drop the read locks on parent nodes when
647 * we're starting to take intent locks - and handle the race.
649 * The race is that they might be about to free the node we
650 * want, and dropping our read lock on the parent node lets them
651 * update the parent marking the node we want as freed, and then
654 * To guard against this, btree nodes are evicted from the cache
655 * when they're freed - and PTR_HASH() is zeroed out, which we
656 * check for after we lock the node.
658 * Then, bch2_btree_node_relock() on the parent will fail - because
659 * the parent was modified, when the pointer to the node we want
660 * was removed - and we'll bail out:
662 if (btree_node_read_locked(iter, level + 1))
663 btree_node_unlock(iter, level + 1);
665 if (!btree_node_lock(b, k->k.p, level, iter, lock_type))
666 return ERR_PTR(-EINTR);
668 if (unlikely(PTR_HASH(&b->key) != PTR_HASH(k) ||
671 six_unlock_type(&b->lock, lock_type);
672 if (bch2_btree_node_relock(iter, level + 1))
675 return ERR_PTR(-EINTR);
679 wait_on_bit_io(&b->flags, BTREE_NODE_read_in_flight,
680 TASK_UNINTERRUPTIBLE);
682 prefetch(b->aux_data);
684 for_each_bset(b, t) {
685 void *p = (u64 *) b->aux_data + t->aux_data_offset;
687 prefetch(p + L1_CACHE_BYTES * 0);
688 prefetch(p + L1_CACHE_BYTES * 1);
689 prefetch(p + L1_CACHE_BYTES * 2);
692 /* avoid atomic set bit if it's not needed: */
693 if (btree_node_accessed(b))
694 set_btree_node_accessed(b);
696 if (unlikely(btree_node_read_error(b))) {
697 six_unlock_type(&b->lock, lock_type);
698 return ERR_PTR(-EIO);
701 EBUG_ON(!b->written);
702 EBUG_ON(b->btree_id != iter->btree_id ||
703 BTREE_NODE_LEVEL(b->data) != level ||
704 bkey_cmp(b->data->max_key, k->k.p));
709 struct btree *bch2_btree_node_get_sibling(struct bch_fs *c,
710 struct btree_iter *iter,
712 enum btree_node_sibling sib)
714 struct btree *parent;
715 struct btree_node_iter node_iter;
716 struct bkey_packed *k;
719 unsigned level = b->level;
721 parent = iter->nodes[level + 1];
725 if (!bch2_btree_node_relock(iter, level + 1)) {
726 bch2_btree_iter_set_locks_want(iter, level + 2);
727 return ERR_PTR(-EINTR);
730 node_iter = iter->node_iters[parent->level];
732 k = bch2_btree_node_iter_peek_all(&node_iter, parent);
733 BUG_ON(bkey_cmp_left_packed(parent, k, &b->key.k.p));
736 k = sib == btree_prev_sib
737 ? bch2_btree_node_iter_prev_all(&node_iter, parent)
738 : (bch2_btree_node_iter_advance(&node_iter, parent),
739 bch2_btree_node_iter_peek_all(&node_iter, parent));
742 } while (bkey_deleted(k));
744 bch2_bkey_unpack(parent, &tmp.k, k);
746 ret = bch2_btree_node_get(c, iter, &tmp.k, level, SIX_LOCK_intent);
748 if (IS_ERR(ret) && PTR_ERR(ret) == -EINTR) {
749 btree_node_unlock(iter, level);
750 ret = bch2_btree_node_get(c, iter, &tmp.k, level, SIX_LOCK_intent);
753 if (!IS_ERR(ret) && !bch2_btree_node_relock(iter, level)) {
754 six_unlock_intent(&ret->lock);
755 ret = ERR_PTR(-EINTR);
761 void bch2_btree_node_prefetch(struct bch_fs *c, const struct bkey_i *k,
762 unsigned level, enum btree_id btree_id)
766 BUG_ON(level >= BTREE_MAX_DEPTH);
775 b = bch2_btree_node_mem_alloc(c);
779 bkey_copy(&b->key, k);
780 if (bch2_btree_node_hash_insert(c, b, level, btree_id)) {
781 /* raced with another fill: */
783 /* mark as unhashed... */
784 bkey_i_to_extent(&b->key)->v._data[0] = 0;
786 mutex_lock(&c->btree_cache_lock);
787 list_add(&b->list, &c->btree_cache_freeable);
788 mutex_unlock(&c->btree_cache_lock);
792 bch2_btree_node_read(c, b, false);
794 six_unlock_write(&b->lock);
795 six_unlock_intent(&b->lock);
798 int bch2_print_btree_node(struct bch_fs *c, struct btree *b,
799 char *buf, size_t len)
801 const struct bkey_format *f = &b->format;
802 struct bset_stats stats;
805 memset(&stats, 0, sizeof(stats));
807 bch2_val_to_text(c, BKEY_TYPE_BTREE, ptrs, sizeof(ptrs),
808 bkey_i_to_s_c(&b->key));
809 bch2_btree_keys_stats(b, &stats);
811 return scnprintf(buf, len,
812 "l %u %llu:%llu - %llu:%llu:\n"
814 " format: u64s %u fields %u %u %u %u %u\n"
815 " unpack fn len: %u\n"
816 " bytes used %zu/%zu (%zu%% full)\n"
817 " sib u64s: %u, %u (merge threshold %zu)\n"
818 " nr packed keys %u\n"
819 " nr unpacked keys %u\n"
821 " failed unpacked %zu\n"
823 " failed overflow %zu\n",
825 b->data->min_key.inode,
826 b->data->min_key.offset,
827 b->data->max_key.inode,
828 b->data->max_key.offset,
831 f->bits_per_field[0],
832 f->bits_per_field[1],
833 f->bits_per_field[2],
834 f->bits_per_field[3],
835 f->bits_per_field[4],
837 b->nr.live_u64s * sizeof(u64),
838 btree_bytes(c) - sizeof(struct btree_node),
839 b->nr.live_u64s * 100 / btree_max_u64s(c),
842 BTREE_FOREGROUND_MERGE_THRESHOLD(c),
846 stats.failed_unpacked,
848 stats.failed_overflow);