1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2010 Kent Overstreet <kent.overstreet@gmail.com>
5 * Uses a block device as cache for other block devices; optimized for SSDs.
6 * All allocation is done in buckets, which should match the erase block size
9 * Buckets containing cached data are kept on a heap sorted by priority;
10 * bucket priority is increased on cache hit, and periodically all the buckets
11 * on the heap have their priority scaled down. This currently is just used as
12 * an LRU but in the future should allow for more intelligent heuristics.
14 * Buckets have an 8 bit counter; freeing is accomplished by incrementing the
15 * counter. Garbage collection is used to remove stale pointers.
17 * Indexing is done via a btree; nodes are not necessarily fully sorted, rather
18 * as keys are inserted we only sort the pages that have not yet been written.
19 * When garbage collection is run, we resort the entire node.
21 * All configuration is done via sysfs; see Documentation/admin-guide/bcache.rst.
29 #include <linux/slab.h>
30 #include <linux/bitops.h>
31 #include <linux/hash.h>
32 #include <linux/kthread.h>
33 #include <linux/prefetch.h>
34 #include <linux/random.h>
35 #include <linux/rcupdate.h>
36 #include <linux/sched/clock.h>
37 #include <linux/rculist.h>
39 #include <trace/events/bcache.h>
43 * register_bcache: Return errors out to userspace correctly
45 * Writeback: don't undirty key until after a cache flush
47 * Create an iterator for key pointers
49 * On btree write error, mark bucket such that it won't be freed from the cache
52 * Check for bad keys in replay
54 * Refcount journal entries in journal_replay
57 * Finish incremental gc
58 * Gc should free old UUIDs, data for invalid UUIDs
60 * Provide a way to list backing device UUIDs we have data cached for, and
61 * probably how long it's been since we've seen them, and a way to invalidate
62 * dirty data for devices that will never be attached again
64 * Keep 1 min/5 min/15 min statistics of how busy a block device has been, so
65 * that based on that and how much dirty data we have we can keep writeback
68 * Add a tracepoint or somesuch to watch for writeback starvation
70 * When btree depth > 1 and splitting an interior node, we have to make sure
71 * alloc_bucket() cannot fail. This should be true but is not completely
76 * If data write is less than hard sector size of ssd, round up offset in open
77 * bucket to the next whole sector
79 * Superblock needs to be fleshed out for multiple cache devices
81 * Add a sysfs tunable for the number of writeback IOs in flight
83 * Add a sysfs tunable for the number of open data buckets
85 * IO tracking: Can we track when one process is doing io on behalf of another?
86 * IO tracking: Don't use just an average, weigh more recent stuff higher
88 * Test module load/unload
91 #define MAX_NEED_GC 64
92 #define MAX_SAVE_PRIO 72
93 #define MAX_GC_TIMES 100
94 #define MIN_GC_NODES 100
95 #define GC_SLEEP_MS 100
97 #define PTR_DIRTY_BIT (((uint64_t) 1 << 36))
99 #define PTR_HASH(c, k) \
100 (((k)->ptr[0] >> c->bucket_bits) | PTR_GEN(k, 0))
102 #define insert_lock(s, b) ((b)->level <= (s)->lock)
105 * These macros are for recursing down the btree - they handle the details of
106 * locking and looking up nodes in the cache for you. They're best treated as
107 * mere syntax when reading code that uses them.
109 * op->lock determines whether we take a read or a write lock at a given depth.
110 * If you've got a read lock and find that you need a write lock (i.e. you're
111 * going to have to split), set op->lock and return -EINTR; btree_root() will
112 * call you again and you'll have the correct lock.
116 * btree - recurse down the btree on a specified key
117 * @fn: function to call, which will be passed the child node
118 * @key: key to recurse on
119 * @b: parent btree node
120 * @op: pointer to struct btree_op
122 #define btree(fn, key, b, op, ...) \
124 int _r, l = (b)->level - 1; \
125 bool _w = l <= (op)->lock; \
126 struct btree *_child = bch_btree_node_get((b)->c, op, key, l, \
128 if (!IS_ERR(_child)) { \
129 _r = bch_btree_ ## fn(_child, op, ##__VA_ARGS__); \
130 rw_unlock(_w, _child); \
132 _r = PTR_ERR(_child); \
137 * btree_root - call a function on the root of the btree
138 * @fn: function to call, which will be passed the child node
140 * @op: pointer to struct btree_op
142 #define btree_root(fn, c, op, ...) \
146 struct btree *_b = (c)->root; \
147 bool _w = insert_lock(op, _b); \
148 rw_lock(_w, _b, _b->level); \
149 if (_b == (c)->root && \
150 _w == insert_lock(op, _b)) { \
151 _r = bch_btree_ ## fn(_b, op, ##__VA_ARGS__); \
154 bch_cannibalize_unlock(c); \
157 } while (_r == -EINTR); \
159 finish_wait(&(c)->btree_cache_wait, &(op)->wait); \
163 static inline struct bset *write_block(struct btree *b)
165 return ((void *) btree_bset_first(b)) + b->written * block_bytes(b->c);
168 static void bch_btree_init_next(struct btree *b)
170 /* If not a leaf node, always sort */
171 if (b->level && b->keys.nsets)
172 bch_btree_sort(&b->keys, &b->c->sort);
174 bch_btree_sort_lazy(&b->keys, &b->c->sort);
176 if (b->written < btree_blocks(b))
177 bch_bset_init_next(&b->keys, write_block(b),
178 bset_magic(&b->c->sb));
182 /* Btree key manipulation */
184 void bkey_put(struct cache_set *c, struct bkey *k)
188 for (i = 0; i < KEY_PTRS(k); i++)
189 if (ptr_available(c, k, i))
190 atomic_dec_bug(&PTR_BUCKET(c, k, i)->pin);
195 static uint64_t btree_csum_set(struct btree *b, struct bset *i)
197 uint64_t crc = b->key.ptr[0];
198 void *data = (void *) i + 8, *end = bset_bkey_last(i);
200 crc = bch_crc64_update(crc, data, end - data);
201 return crc ^ 0xffffffffffffffffULL;
204 void bch_btree_node_read_done(struct btree *b)
206 const char *err = "bad btree header";
207 struct bset *i = btree_bset_first(b);
208 struct btree_iter *iter;
210 iter = mempool_alloc(&b->c->fill_iter, GFP_NOIO);
211 iter->size = b->c->sb.bucket_size / b->c->sb.block_size;
214 #ifdef CONFIG_BCACHE_DEBUG
222 b->written < btree_blocks(b) && i->seq == b->keys.set[0].data->seq;
223 i = write_block(b)) {
224 err = "unsupported bset version";
225 if (i->version > BCACHE_BSET_VERSION)
228 err = "bad btree header";
229 if (b->written + set_blocks(i, block_bytes(b->c)) >
234 if (i->magic != bset_magic(&b->c->sb))
237 err = "bad checksum";
238 switch (i->version) {
240 if (i->csum != csum_set(i))
243 case BCACHE_BSET_VERSION:
244 if (i->csum != btree_csum_set(b, i))
250 if (i != b->keys.set[0].data && !i->keys)
253 bch_btree_iter_push(iter, i->start, bset_bkey_last(i));
255 b->written += set_blocks(i, block_bytes(b->c));
258 err = "corrupted btree";
259 for (i = write_block(b);
260 bset_sector_offset(&b->keys, i) < KEY_SIZE(&b->key);
261 i = ((void *) i) + block_bytes(b->c))
262 if (i->seq == b->keys.set[0].data->seq)
265 bch_btree_sort_and_fix_extents(&b->keys, iter, &b->c->sort);
267 i = b->keys.set[0].data;
268 err = "short btree key";
269 if (b->keys.set[0].size &&
270 bkey_cmp(&b->key, &b->keys.set[0].end) < 0)
273 if (b->written < btree_blocks(b))
274 bch_bset_init_next(&b->keys, write_block(b),
275 bset_magic(&b->c->sb));
277 mempool_free(iter, &b->c->fill_iter);
280 set_btree_node_io_error(b);
281 bch_cache_set_error(b->c, "%s at bucket %zu, block %u, %u keys",
282 err, PTR_BUCKET_NR(b->c, &b->key, 0),
283 bset_block_offset(b, i), i->keys);
287 static void btree_node_read_endio(struct bio *bio)
289 struct closure *cl = bio->bi_private;
294 static void bch_btree_node_read(struct btree *b)
296 uint64_t start_time = local_clock();
300 trace_bcache_btree_read(b);
302 closure_init_stack(&cl);
304 bio = bch_bbio_alloc(b->c);
305 bio->bi_iter.bi_size = KEY_SIZE(&b->key) << 9;
306 bio->bi_end_io = btree_node_read_endio;
307 bio->bi_private = &cl;
308 bio->bi_opf = REQ_OP_READ | REQ_META;
310 bch_bio_map(bio, b->keys.set[0].data);
312 bch_submit_bbio(bio, b->c, &b->key, 0);
316 set_btree_node_io_error(b);
318 bch_bbio_free(bio, b->c);
320 if (btree_node_io_error(b))
323 bch_btree_node_read_done(b);
324 bch_time_stats_update(&b->c->btree_read_time, start_time);
328 bch_cache_set_error(b->c, "io error reading bucket %zu",
329 PTR_BUCKET_NR(b->c, &b->key, 0));
332 static void btree_complete_write(struct btree *b, struct btree_write *w)
334 if (w->prio_blocked &&
335 !atomic_sub_return(w->prio_blocked, &b->c->prio_blocked))
336 wake_up_allocators(b->c);
339 atomic_dec_bug(w->journal);
340 __closure_wake_up(&b->c->journal.wait);
347 static void btree_node_write_unlock(struct closure *cl)
349 struct btree *b = container_of(cl, struct btree, io);
354 static void __btree_node_write_done(struct closure *cl)
356 struct btree *b = container_of(cl, struct btree, io);
357 struct btree_write *w = btree_prev_write(b);
359 bch_bbio_free(b->bio, b->c);
361 btree_complete_write(b, w);
363 if (btree_node_dirty(b))
364 schedule_delayed_work(&b->work, 30 * HZ);
366 closure_return_with_destructor(cl, btree_node_write_unlock);
369 static void btree_node_write_done(struct closure *cl)
371 struct btree *b = container_of(cl, struct btree, io);
373 bio_free_pages(b->bio);
374 __btree_node_write_done(cl);
377 static void btree_node_write_endio(struct bio *bio)
379 struct closure *cl = bio->bi_private;
380 struct btree *b = container_of(cl, struct btree, io);
383 set_btree_node_io_error(b);
385 bch_bbio_count_io_errors(b->c, bio, bio->bi_status, "writing btree");
389 static void do_btree_node_write(struct btree *b)
391 struct closure *cl = &b->io;
392 struct bset *i = btree_bset_last(b);
395 i->version = BCACHE_BSET_VERSION;
396 i->csum = btree_csum_set(b, i);
399 b->bio = bch_bbio_alloc(b->c);
401 b->bio->bi_end_io = btree_node_write_endio;
402 b->bio->bi_private = cl;
403 b->bio->bi_iter.bi_size = roundup(set_bytes(i), block_bytes(b->c));
404 b->bio->bi_opf = REQ_OP_WRITE | REQ_META | REQ_FUA;
405 bch_bio_map(b->bio, i);
408 * If we're appending to a leaf node, we don't technically need FUA -
409 * this write just needs to be persisted before the next journal write,
410 * which will be marked FLUSH|FUA.
412 * Similarly if we're writing a new btree root - the pointer is going to
413 * be in the next journal entry.
415 * But if we're writing a new btree node (that isn't a root) or
416 * appending to a non leaf btree node, we need either FUA or a flush
417 * when we write the parent with the new pointer. FUA is cheaper than a
418 * flush, and writes appending to leaf nodes aren't blocking anything so
419 * just make all btree node writes FUA to keep things sane.
422 bkey_copy(&k.key, &b->key);
423 SET_PTR_OFFSET(&k.key, 0, PTR_OFFSET(&k.key, 0) +
424 bset_sector_offset(&b->keys, i));
426 if (!bch_bio_alloc_pages(b->bio, __GFP_NOWARN|GFP_NOWAIT)) {
429 void *base = (void *) ((unsigned long) i & ~(PAGE_SIZE - 1));
431 bio_for_each_segment_all(bv, b->bio, j)
432 memcpy(page_address(bv->bv_page),
433 base + j * PAGE_SIZE, PAGE_SIZE);
435 bch_submit_bbio(b->bio, b->c, &k.key, 0);
437 continue_at(cl, btree_node_write_done, NULL);
440 * No problem for multipage bvec since the bio is
444 bch_bio_map(b->bio, i);
446 bch_submit_bbio(b->bio, b->c, &k.key, 0);
449 continue_at_nobarrier(cl, __btree_node_write_done, NULL);
453 void __bch_btree_node_write(struct btree *b, struct closure *parent)
455 struct bset *i = btree_bset_last(b);
457 lockdep_assert_held(&b->write_lock);
459 trace_bcache_btree_write(b);
461 BUG_ON(current->bio_list);
462 BUG_ON(b->written >= btree_blocks(b));
463 BUG_ON(b->written && !i->keys);
464 BUG_ON(btree_bset_first(b)->seq != i->seq);
465 bch_check_keys(&b->keys, "writing");
467 cancel_delayed_work(&b->work);
469 /* If caller isn't waiting for write, parent refcount is cache set */
471 closure_init(&b->io, parent ?: &b->c->cl);
473 clear_bit(BTREE_NODE_dirty, &b->flags);
474 change_bit(BTREE_NODE_write_idx, &b->flags);
476 do_btree_node_write(b);
478 atomic_long_add(set_blocks(i, block_bytes(b->c)) * b->c->sb.block_size,
479 &PTR_CACHE(b->c, &b->key, 0)->btree_sectors_written);
481 b->written += set_blocks(i, block_bytes(b->c));
484 void bch_btree_node_write(struct btree *b, struct closure *parent)
486 unsigned int nsets = b->keys.nsets;
488 lockdep_assert_held(&b->lock);
490 __bch_btree_node_write(b, parent);
493 * do verify if there was more than one set initially (i.e. we did a
494 * sort) and we sorted down to a single set:
496 if (nsets && !b->keys.nsets)
499 bch_btree_init_next(b);
502 static void bch_btree_node_write_sync(struct btree *b)
506 closure_init_stack(&cl);
508 mutex_lock(&b->write_lock);
509 bch_btree_node_write(b, &cl);
510 mutex_unlock(&b->write_lock);
515 static void btree_node_write_work(struct work_struct *w)
517 struct btree *b = container_of(to_delayed_work(w), struct btree, work);
519 mutex_lock(&b->write_lock);
520 if (btree_node_dirty(b))
521 __bch_btree_node_write(b, NULL);
522 mutex_unlock(&b->write_lock);
525 static void bch_btree_leaf_dirty(struct btree *b, atomic_t *journal_ref)
527 struct bset *i = btree_bset_last(b);
528 struct btree_write *w = btree_current_write(b);
530 lockdep_assert_held(&b->write_lock);
535 if (!btree_node_dirty(b))
536 schedule_delayed_work(&b->work, 30 * HZ);
538 set_btree_node_dirty(b);
542 journal_pin_cmp(b->c, w->journal, journal_ref)) {
543 atomic_dec_bug(w->journal);
548 w->journal = journal_ref;
549 atomic_inc(w->journal);
553 /* Force write if set is too big */
554 if (set_bytes(i) > PAGE_SIZE - 48 &&
556 bch_btree_node_write(b, NULL);
560 * Btree in memory cache - allocation/freeing
561 * mca -> memory cache
564 #define mca_reserve(c) (((c->root && c->root->level) \
565 ? c->root->level : 1) * 8 + 16)
566 #define mca_can_free(c) \
567 max_t(int, 0, c->btree_cache_used - mca_reserve(c))
569 static void mca_data_free(struct btree *b)
571 BUG_ON(b->io_mutex.count != 1);
573 bch_btree_keys_free(&b->keys);
575 b->c->btree_cache_used--;
576 list_move(&b->list, &b->c->btree_cache_freed);
579 static void mca_bucket_free(struct btree *b)
581 BUG_ON(btree_node_dirty(b));
584 hlist_del_init_rcu(&b->hash);
585 list_move(&b->list, &b->c->btree_cache_freeable);
588 static unsigned int btree_order(struct bkey *k)
590 return ilog2(KEY_SIZE(k) / PAGE_SECTORS ?: 1);
593 static void mca_data_alloc(struct btree *b, struct bkey *k, gfp_t gfp)
595 if (!bch_btree_keys_alloc(&b->keys,
597 ilog2(b->c->btree_pages),
600 b->c->btree_cache_used++;
601 list_move(&b->list, &b->c->btree_cache);
603 list_move(&b->list, &b->c->btree_cache_freed);
607 static struct btree *mca_bucket_alloc(struct cache_set *c,
608 struct bkey *k, gfp_t gfp)
610 struct btree *b = kzalloc(sizeof(struct btree), gfp);
615 init_rwsem(&b->lock);
616 lockdep_set_novalidate_class(&b->lock);
617 mutex_init(&b->write_lock);
618 lockdep_set_novalidate_class(&b->write_lock);
619 INIT_LIST_HEAD(&b->list);
620 INIT_DELAYED_WORK(&b->work, btree_node_write_work);
622 sema_init(&b->io_mutex, 1);
624 mca_data_alloc(b, k, gfp);
628 static int mca_reap(struct btree *b, unsigned int min_order, bool flush)
632 closure_init_stack(&cl);
633 lockdep_assert_held(&b->c->bucket_lock);
635 if (!down_write_trylock(&b->lock))
638 BUG_ON(btree_node_dirty(b) && !b->keys.set[0].data);
640 if (b->keys.page_order < min_order)
644 if (btree_node_dirty(b))
647 if (down_trylock(&b->io_mutex))
652 mutex_lock(&b->write_lock);
653 if (btree_node_dirty(b))
654 __bch_btree_node_write(b, &cl);
655 mutex_unlock(&b->write_lock);
659 /* wait for any in flight btree write */
669 static unsigned long bch_mca_scan(struct shrinker *shrink,
670 struct shrink_control *sc)
672 struct cache_set *c = container_of(shrink, struct cache_set, shrink);
674 unsigned long i, nr = sc->nr_to_scan;
675 unsigned long freed = 0;
676 unsigned int btree_cache_used;
678 if (c->shrinker_disabled)
681 if (c->btree_cache_alloc_lock)
684 /* Return -1 if we can't do anything right now */
685 if (sc->gfp_mask & __GFP_IO)
686 mutex_lock(&c->bucket_lock);
687 else if (!mutex_trylock(&c->bucket_lock))
691 * It's _really_ critical that we don't free too many btree nodes - we
692 * have to always leave ourselves a reserve. The reserve is how we
693 * guarantee that allocating memory for a new btree node can always
694 * succeed, so that inserting keys into the btree can always succeed and
695 * IO can always make forward progress:
697 nr /= c->btree_pages;
698 nr = min_t(unsigned long, nr, mca_can_free(c));
701 btree_cache_used = c->btree_cache_used;
702 list_for_each_entry_safe(b, t, &c->btree_cache_freeable, list) {
707 !mca_reap(b, 0, false)) {
715 for (; (nr--) && i < btree_cache_used; i++) {
716 if (list_empty(&c->btree_cache))
719 b = list_first_entry(&c->btree_cache, struct btree, list);
720 list_rotate_left(&c->btree_cache);
723 !mca_reap(b, 0, false)) {
732 mutex_unlock(&c->bucket_lock);
733 return freed * c->btree_pages;
736 static unsigned long bch_mca_count(struct shrinker *shrink,
737 struct shrink_control *sc)
739 struct cache_set *c = container_of(shrink, struct cache_set, shrink);
741 if (c->shrinker_disabled)
744 if (c->btree_cache_alloc_lock)
747 return mca_can_free(c) * c->btree_pages;
750 void bch_btree_cache_free(struct cache_set *c)
755 closure_init_stack(&cl);
757 if (c->shrink.list.next)
758 unregister_shrinker(&c->shrink);
760 mutex_lock(&c->bucket_lock);
762 #ifdef CONFIG_BCACHE_DEBUG
764 list_move(&c->verify_data->list, &c->btree_cache);
766 free_pages((unsigned long) c->verify_ondisk, ilog2(bucket_pages(c)));
769 list_splice(&c->btree_cache_freeable,
772 while (!list_empty(&c->btree_cache)) {
773 b = list_first_entry(&c->btree_cache, struct btree, list);
775 if (btree_node_dirty(b))
776 btree_complete_write(b, btree_current_write(b));
777 clear_bit(BTREE_NODE_dirty, &b->flags);
782 while (!list_empty(&c->btree_cache_freed)) {
783 b = list_first_entry(&c->btree_cache_freed,
786 cancel_delayed_work_sync(&b->work);
790 mutex_unlock(&c->bucket_lock);
793 int bch_btree_cache_alloc(struct cache_set *c)
797 for (i = 0; i < mca_reserve(c); i++)
798 if (!mca_bucket_alloc(c, &ZERO_KEY, GFP_KERNEL))
801 list_splice_init(&c->btree_cache,
802 &c->btree_cache_freeable);
804 #ifdef CONFIG_BCACHE_DEBUG
805 mutex_init(&c->verify_lock);
807 c->verify_ondisk = (void *)
808 __get_free_pages(GFP_KERNEL, ilog2(bucket_pages(c)));
810 c->verify_data = mca_bucket_alloc(c, &ZERO_KEY, GFP_KERNEL);
812 if (c->verify_data &&
813 c->verify_data->keys.set->data)
814 list_del_init(&c->verify_data->list);
816 c->verify_data = NULL;
819 c->shrink.count_objects = bch_mca_count;
820 c->shrink.scan_objects = bch_mca_scan;
822 c->shrink.batch = c->btree_pages * 2;
824 if (register_shrinker(&c->shrink))
825 pr_warn("bcache: %s: could not register shrinker",
831 /* Btree in memory cache - hash table */
833 static struct hlist_head *mca_hash(struct cache_set *c, struct bkey *k)
835 return &c->bucket_hash[hash_32(PTR_HASH(c, k), BUCKET_HASH_BITS)];
838 static struct btree *mca_find(struct cache_set *c, struct bkey *k)
843 hlist_for_each_entry_rcu(b, mca_hash(c, k), hash)
844 if (PTR_HASH(c, &b->key) == PTR_HASH(c, k))
852 static int mca_cannibalize_lock(struct cache_set *c, struct btree_op *op)
854 struct task_struct *old;
856 old = cmpxchg(&c->btree_cache_alloc_lock, NULL, current);
857 if (old && old != current) {
859 prepare_to_wait(&c->btree_cache_wait, &op->wait,
860 TASK_UNINTERRUPTIBLE);
867 static struct btree *mca_cannibalize(struct cache_set *c, struct btree_op *op,
872 trace_bcache_btree_cache_cannibalize(c);
874 if (mca_cannibalize_lock(c, op))
875 return ERR_PTR(-EINTR);
877 list_for_each_entry_reverse(b, &c->btree_cache, list)
878 if (!mca_reap(b, btree_order(k), false))
881 list_for_each_entry_reverse(b, &c->btree_cache, list)
882 if (!mca_reap(b, btree_order(k), true))
885 WARN(1, "btree cache cannibalize failed\n");
886 return ERR_PTR(-ENOMEM);
890 * We can only have one thread cannibalizing other cached btree nodes at a time,
891 * or we'll deadlock. We use an open coded mutex to ensure that, which a
892 * cannibalize_bucket() will take. This means every time we unlock the root of
893 * the btree, we need to release this lock if we have it held.
895 static void bch_cannibalize_unlock(struct cache_set *c)
897 if (c->btree_cache_alloc_lock == current) {
898 c->btree_cache_alloc_lock = NULL;
899 wake_up(&c->btree_cache_wait);
903 static struct btree *mca_alloc(struct cache_set *c, struct btree_op *op,
904 struct bkey *k, int level)
908 BUG_ON(current->bio_list);
910 lockdep_assert_held(&c->bucket_lock);
915 /* btree_free() doesn't free memory; it sticks the node on the end of
916 * the list. Check if there's any freed nodes there:
918 list_for_each_entry(b, &c->btree_cache_freeable, list)
919 if (!mca_reap(b, btree_order(k), false))
922 /* We never free struct btree itself, just the memory that holds the on
923 * disk node. Check the freed list before allocating a new one:
925 list_for_each_entry(b, &c->btree_cache_freed, list)
926 if (!mca_reap(b, 0, false)) {
927 mca_data_alloc(b, k, __GFP_NOWARN|GFP_NOIO);
928 if (!b->keys.set[0].data)
934 b = mca_bucket_alloc(c, k, __GFP_NOWARN|GFP_NOIO);
938 BUG_ON(!down_write_trylock(&b->lock));
939 if (!b->keys.set->data)
942 BUG_ON(b->io_mutex.count != 1);
944 bkey_copy(&b->key, k);
945 list_move(&b->list, &c->btree_cache);
946 hlist_del_init_rcu(&b->hash);
947 hlist_add_head_rcu(&b->hash, mca_hash(c, k));
949 lock_set_subclass(&b->lock.dep_map, level + 1, _THIS_IP_);
950 b->parent = (void *) ~0UL;
956 bch_btree_keys_init(&b->keys, &bch_extent_keys_ops,
957 &b->c->expensive_debug_checks);
959 bch_btree_keys_init(&b->keys, &bch_btree_keys_ops,
960 &b->c->expensive_debug_checks);
967 b = mca_cannibalize(c, op, k);
975 * bch_btree_node_get - find a btree node in the cache and lock it, reading it
976 * in from disk if necessary.
978 * If IO is necessary and running under generic_make_request, returns -EAGAIN.
980 * The btree node will have either a read or a write lock held, depending on
981 * level and op->lock.
983 struct btree *bch_btree_node_get(struct cache_set *c, struct btree_op *op,
984 struct bkey *k, int level, bool write,
985 struct btree *parent)
995 if (current->bio_list)
996 return ERR_PTR(-EAGAIN);
998 mutex_lock(&c->bucket_lock);
999 b = mca_alloc(c, op, k, level);
1000 mutex_unlock(&c->bucket_lock);
1007 bch_btree_node_read(b);
1010 downgrade_write(&b->lock);
1012 rw_lock(write, b, level);
1013 if (PTR_HASH(c, &b->key) != PTR_HASH(c, k)) {
1014 rw_unlock(write, b);
1017 BUG_ON(b->level != level);
1020 if (btree_node_io_error(b)) {
1021 rw_unlock(write, b);
1022 return ERR_PTR(-EIO);
1025 BUG_ON(!b->written);
1030 for (; i <= b->keys.nsets && b->keys.set[i].size; i++) {
1031 prefetch(b->keys.set[i].tree);
1032 prefetch(b->keys.set[i].data);
1035 for (; i <= b->keys.nsets; i++)
1036 prefetch(b->keys.set[i].data);
1041 static void btree_node_prefetch(struct btree *parent, struct bkey *k)
1045 mutex_lock(&parent->c->bucket_lock);
1046 b = mca_alloc(parent->c, NULL, k, parent->level - 1);
1047 mutex_unlock(&parent->c->bucket_lock);
1049 if (!IS_ERR_OR_NULL(b)) {
1051 bch_btree_node_read(b);
1058 static void btree_node_free(struct btree *b)
1060 trace_bcache_btree_node_free(b);
1062 BUG_ON(b == b->c->root);
1064 mutex_lock(&b->write_lock);
1066 if (btree_node_dirty(b))
1067 btree_complete_write(b, btree_current_write(b));
1068 clear_bit(BTREE_NODE_dirty, &b->flags);
1070 mutex_unlock(&b->write_lock);
1072 cancel_delayed_work(&b->work);
1074 mutex_lock(&b->c->bucket_lock);
1075 bch_bucket_free(b->c, &b->key);
1077 mutex_unlock(&b->c->bucket_lock);
1080 struct btree *__bch_btree_node_alloc(struct cache_set *c, struct btree_op *op,
1081 int level, bool wait,
1082 struct btree *parent)
1085 struct btree *b = ERR_PTR(-EAGAIN);
1087 mutex_lock(&c->bucket_lock);
1089 if (__bch_bucket_alloc_set(c, RESERVE_BTREE, &k.key, 1, wait))
1092 bkey_put(c, &k.key);
1093 SET_KEY_SIZE(&k.key, c->btree_pages * PAGE_SECTORS);
1095 b = mca_alloc(c, op, &k.key, level);
1101 "Tried to allocate bucket that was in btree cache");
1107 bch_bset_init_next(&b->keys, b->keys.set->data, bset_magic(&b->c->sb));
1109 mutex_unlock(&c->bucket_lock);
1111 trace_bcache_btree_node_alloc(b);
1114 bch_bucket_free(c, &k.key);
1116 mutex_unlock(&c->bucket_lock);
1118 trace_bcache_btree_node_alloc_fail(c);
1122 static struct btree *bch_btree_node_alloc(struct cache_set *c,
1123 struct btree_op *op, int level,
1124 struct btree *parent)
1126 return __bch_btree_node_alloc(c, op, level, op != NULL, parent);
1129 static struct btree *btree_node_alloc_replacement(struct btree *b,
1130 struct btree_op *op)
1132 struct btree *n = bch_btree_node_alloc(b->c, op, b->level, b->parent);
1134 if (!IS_ERR_OR_NULL(n)) {
1135 mutex_lock(&n->write_lock);
1136 bch_btree_sort_into(&b->keys, &n->keys, &b->c->sort);
1137 bkey_copy_key(&n->key, &b->key);
1138 mutex_unlock(&n->write_lock);
1144 static void make_btree_freeing_key(struct btree *b, struct bkey *k)
1148 mutex_lock(&b->c->bucket_lock);
1150 atomic_inc(&b->c->prio_blocked);
1152 bkey_copy(k, &b->key);
1153 bkey_copy_key(k, &ZERO_KEY);
1155 for (i = 0; i < KEY_PTRS(k); i++)
1157 bch_inc_gen(PTR_CACHE(b->c, &b->key, i),
1158 PTR_BUCKET(b->c, &b->key, i)));
1160 mutex_unlock(&b->c->bucket_lock);
1163 static int btree_check_reserve(struct btree *b, struct btree_op *op)
1165 struct cache_set *c = b->c;
1167 unsigned int i, reserve = (c->root->level - b->level) * 2 + 1;
1169 mutex_lock(&c->bucket_lock);
1171 for_each_cache(ca, c, i)
1172 if (fifo_used(&ca->free[RESERVE_BTREE]) < reserve) {
1174 prepare_to_wait(&c->btree_cache_wait, &op->wait,
1175 TASK_UNINTERRUPTIBLE);
1176 mutex_unlock(&c->bucket_lock);
1180 mutex_unlock(&c->bucket_lock);
1182 return mca_cannibalize_lock(b->c, op);
1185 /* Garbage collection */
1187 static uint8_t __bch_btree_mark_key(struct cache_set *c, int level,
1195 * ptr_invalid() can't return true for the keys that mark btree nodes as
1196 * freed, but since ptr_bad() returns true we'll never actually use them
1197 * for anything and thus we don't want mark their pointers here
1199 if (!bkey_cmp(k, &ZERO_KEY))
1202 for (i = 0; i < KEY_PTRS(k); i++) {
1203 if (!ptr_available(c, k, i))
1206 g = PTR_BUCKET(c, k, i);
1208 if (gen_after(g->last_gc, PTR_GEN(k, i)))
1209 g->last_gc = PTR_GEN(k, i);
1211 if (ptr_stale(c, k, i)) {
1212 stale = max(stale, ptr_stale(c, k, i));
1216 cache_bug_on(GC_MARK(g) &&
1217 (GC_MARK(g) == GC_MARK_METADATA) != (level != 0),
1218 c, "inconsistent ptrs: mark = %llu, level = %i",
1222 SET_GC_MARK(g, GC_MARK_METADATA);
1223 else if (KEY_DIRTY(k))
1224 SET_GC_MARK(g, GC_MARK_DIRTY);
1225 else if (!GC_MARK(g))
1226 SET_GC_MARK(g, GC_MARK_RECLAIMABLE);
1228 /* guard against overflow */
1229 SET_GC_SECTORS_USED(g, min_t(unsigned int,
1230 GC_SECTORS_USED(g) + KEY_SIZE(k),
1231 MAX_GC_SECTORS_USED));
1233 BUG_ON(!GC_SECTORS_USED(g));
1239 #define btree_mark_key(b, k) __bch_btree_mark_key(b->c, b->level, k)
1241 void bch_initial_mark_key(struct cache_set *c, int level, struct bkey *k)
1245 for (i = 0; i < KEY_PTRS(k); i++)
1246 if (ptr_available(c, k, i) &&
1247 !ptr_stale(c, k, i)) {
1248 struct bucket *b = PTR_BUCKET(c, k, i);
1250 b->gen = PTR_GEN(k, i);
1252 if (level && bkey_cmp(k, &ZERO_KEY))
1253 b->prio = BTREE_PRIO;
1254 else if (!level && b->prio == BTREE_PRIO)
1255 b->prio = INITIAL_PRIO;
1258 __bch_btree_mark_key(c, level, k);
1261 void bch_update_bucket_in_use(struct cache_set *c, struct gc_stat *stats)
1263 stats->in_use = (c->nbuckets - c->avail_nbuckets) * 100 / c->nbuckets;
1266 static bool btree_gc_mark_node(struct btree *b, struct gc_stat *gc)
1269 unsigned int keys = 0, good_keys = 0;
1271 struct btree_iter iter;
1272 struct bset_tree *t;
1276 for_each_key_filter(&b->keys, k, &iter, bch_ptr_invalid) {
1277 stale = max(stale, btree_mark_key(b, k));
1280 if (bch_ptr_bad(&b->keys, k))
1283 gc->key_bytes += bkey_u64s(k);
1287 gc->data += KEY_SIZE(k);
1290 for (t = b->keys.set; t <= &b->keys.set[b->keys.nsets]; t++)
1291 btree_bug_on(t->size &&
1292 bset_written(&b->keys, t) &&
1293 bkey_cmp(&b->key, &t->end) < 0,
1294 b, "found short btree key in gc");
1296 if (b->c->gc_always_rewrite)
1302 if ((keys - good_keys) * 2 > keys)
1308 #define GC_MERGE_NODES 4U
1310 struct gc_merge_info {
1315 static int bch_btree_insert_node(struct btree *b, struct btree_op *op,
1316 struct keylist *insert_keys,
1317 atomic_t *journal_ref,
1318 struct bkey *replace_key);
1320 static int btree_gc_coalesce(struct btree *b, struct btree_op *op,
1321 struct gc_stat *gc, struct gc_merge_info *r)
1323 unsigned int i, nodes = 0, keys = 0, blocks;
1324 struct btree *new_nodes[GC_MERGE_NODES];
1325 struct keylist keylist;
1329 bch_keylist_init(&keylist);
1331 if (btree_check_reserve(b, NULL))
1334 memset(new_nodes, 0, sizeof(new_nodes));
1335 closure_init_stack(&cl);
1337 while (nodes < GC_MERGE_NODES && !IS_ERR_OR_NULL(r[nodes].b))
1338 keys += r[nodes++].keys;
1340 blocks = btree_default_blocks(b->c) * 2 / 3;
1343 __set_blocks(b->keys.set[0].data, keys,
1344 block_bytes(b->c)) > blocks * (nodes - 1))
1347 for (i = 0; i < nodes; i++) {
1348 new_nodes[i] = btree_node_alloc_replacement(r[i].b, NULL);
1349 if (IS_ERR_OR_NULL(new_nodes[i]))
1350 goto out_nocoalesce;
1354 * We have to check the reserve here, after we've allocated our new
1355 * nodes, to make sure the insert below will succeed - we also check
1356 * before as an optimization to potentially avoid a bunch of expensive
1359 if (btree_check_reserve(b, NULL))
1360 goto out_nocoalesce;
1362 for (i = 0; i < nodes; i++)
1363 mutex_lock(&new_nodes[i]->write_lock);
1365 for (i = nodes - 1; i > 0; --i) {
1366 struct bset *n1 = btree_bset_first(new_nodes[i]);
1367 struct bset *n2 = btree_bset_first(new_nodes[i - 1]);
1368 struct bkey *k, *last = NULL;
1374 k < bset_bkey_last(n2);
1376 if (__set_blocks(n1, n1->keys + keys +
1378 block_bytes(b->c)) > blocks)
1382 keys += bkey_u64s(k);
1386 * Last node we're not getting rid of - we're getting
1387 * rid of the node at r[0]. Have to try and fit all of
1388 * the remaining keys into this node; we can't ensure
1389 * they will always fit due to rounding and variable
1390 * length keys (shouldn't be possible in practice,
1393 if (__set_blocks(n1, n1->keys + n2->keys,
1394 block_bytes(b->c)) >
1395 btree_blocks(new_nodes[i]))
1396 goto out_nocoalesce;
1399 /* Take the key of the node we're getting rid of */
1403 BUG_ON(__set_blocks(n1, n1->keys + keys, block_bytes(b->c)) >
1404 btree_blocks(new_nodes[i]));
1407 bkey_copy_key(&new_nodes[i]->key, last);
1409 memcpy(bset_bkey_last(n1),
1411 (void *) bset_bkey_idx(n2, keys) - (void *) n2->start);
1414 r[i].keys = n1->keys;
1417 bset_bkey_idx(n2, keys),
1418 (void *) bset_bkey_last(n2) -
1419 (void *) bset_bkey_idx(n2, keys));
1423 if (__bch_keylist_realloc(&keylist,
1424 bkey_u64s(&new_nodes[i]->key)))
1425 goto out_nocoalesce;
1427 bch_btree_node_write(new_nodes[i], &cl);
1428 bch_keylist_add(&keylist, &new_nodes[i]->key);
1431 for (i = 0; i < nodes; i++)
1432 mutex_unlock(&new_nodes[i]->write_lock);
1436 /* We emptied out this node */
1437 BUG_ON(btree_bset_first(new_nodes[0])->keys);
1438 btree_node_free(new_nodes[0]);
1439 rw_unlock(true, new_nodes[0]);
1440 new_nodes[0] = NULL;
1442 for (i = 0; i < nodes; i++) {
1443 if (__bch_keylist_realloc(&keylist, bkey_u64s(&r[i].b->key)))
1444 goto out_nocoalesce;
1446 make_btree_freeing_key(r[i].b, keylist.top);
1447 bch_keylist_push(&keylist);
1450 bch_btree_insert_node(b, op, &keylist, NULL, NULL);
1451 BUG_ON(!bch_keylist_empty(&keylist));
1453 for (i = 0; i < nodes; i++) {
1454 btree_node_free(r[i].b);
1455 rw_unlock(true, r[i].b);
1457 r[i].b = new_nodes[i];
1460 memmove(r, r + 1, sizeof(r[0]) * (nodes - 1));
1461 r[nodes - 1].b = ERR_PTR(-EINTR);
1463 trace_bcache_btree_gc_coalesce(nodes);
1466 bch_keylist_free(&keylist);
1468 /* Invalidated our iterator */
1473 bch_keylist_free(&keylist);
1475 while ((k = bch_keylist_pop(&keylist)))
1476 if (!bkey_cmp(k, &ZERO_KEY))
1477 atomic_dec(&b->c->prio_blocked);
1479 for (i = 0; i < nodes; i++)
1480 if (!IS_ERR_OR_NULL(new_nodes[i])) {
1481 btree_node_free(new_nodes[i]);
1482 rw_unlock(true, new_nodes[i]);
1487 static int btree_gc_rewrite_node(struct btree *b, struct btree_op *op,
1488 struct btree *replace)
1490 struct keylist keys;
1493 if (btree_check_reserve(b, NULL))
1496 n = btree_node_alloc_replacement(replace, NULL);
1498 /* recheck reserve after allocating replacement node */
1499 if (btree_check_reserve(b, NULL)) {
1505 bch_btree_node_write_sync(n);
1507 bch_keylist_init(&keys);
1508 bch_keylist_add(&keys, &n->key);
1510 make_btree_freeing_key(replace, keys.top);
1511 bch_keylist_push(&keys);
1513 bch_btree_insert_node(b, op, &keys, NULL, NULL);
1514 BUG_ON(!bch_keylist_empty(&keys));
1516 btree_node_free(replace);
1519 /* Invalidated our iterator */
1523 static unsigned int btree_gc_count_keys(struct btree *b)
1526 struct btree_iter iter;
1527 unsigned int ret = 0;
1529 for_each_key_filter(&b->keys, k, &iter, bch_ptr_bad)
1530 ret += bkey_u64s(k);
1535 static size_t btree_gc_min_nodes(struct cache_set *c)
1540 * Since incremental GC would stop 100ms when front
1541 * side I/O comes, so when there are many btree nodes,
1542 * if GC only processes constant (100) nodes each time,
1543 * GC would last a long time, and the front side I/Os
1544 * would run out of the buckets (since no new bucket
1545 * can be allocated during GC), and be blocked again.
1546 * So GC should not process constant nodes, but varied
1547 * nodes according to the number of btree nodes, which
1548 * realized by dividing GC into constant(100) times,
1549 * so when there are many btree nodes, GC can process
1550 * more nodes each time, otherwise, GC will process less
1551 * nodes each time (but no less than MIN_GC_NODES)
1553 min_nodes = c->gc_stats.nodes / MAX_GC_TIMES;
1554 if (min_nodes < MIN_GC_NODES)
1555 min_nodes = MIN_GC_NODES;
1561 static int btree_gc_recurse(struct btree *b, struct btree_op *op,
1562 struct closure *writes, struct gc_stat *gc)
1565 bool should_rewrite;
1567 struct btree_iter iter;
1568 struct gc_merge_info r[GC_MERGE_NODES];
1569 struct gc_merge_info *i, *last = r + ARRAY_SIZE(r) - 1;
1571 bch_btree_iter_init(&b->keys, &iter, &b->c->gc_done);
1573 for (i = r; i < r + ARRAY_SIZE(r); i++)
1574 i->b = ERR_PTR(-EINTR);
1577 k = bch_btree_iter_next_filter(&iter, &b->keys, bch_ptr_bad);
1579 r->b = bch_btree_node_get(b->c, op, k, b->level - 1,
1582 ret = PTR_ERR(r->b);
1586 r->keys = btree_gc_count_keys(r->b);
1588 ret = btree_gc_coalesce(b, op, gc, r);
1596 if (!IS_ERR(last->b)) {
1597 should_rewrite = btree_gc_mark_node(last->b, gc);
1598 if (should_rewrite) {
1599 ret = btree_gc_rewrite_node(b, op, last->b);
1604 if (last->b->level) {
1605 ret = btree_gc_recurse(last->b, op, writes, gc);
1610 bkey_copy_key(&b->c->gc_done, &last->b->key);
1613 * Must flush leaf nodes before gc ends, since replace
1614 * operations aren't journalled
1616 mutex_lock(&last->b->write_lock);
1617 if (btree_node_dirty(last->b))
1618 bch_btree_node_write(last->b, writes);
1619 mutex_unlock(&last->b->write_lock);
1620 rw_unlock(true, last->b);
1623 memmove(r + 1, r, sizeof(r[0]) * (GC_MERGE_NODES - 1));
1626 if (atomic_read(&b->c->search_inflight) &&
1627 gc->nodes >= gc->nodes_pre + btree_gc_min_nodes(b->c)) {
1628 gc->nodes_pre = gc->nodes;
1633 if (need_resched()) {
1639 for (i = r; i < r + ARRAY_SIZE(r); i++)
1640 if (!IS_ERR_OR_NULL(i->b)) {
1641 mutex_lock(&i->b->write_lock);
1642 if (btree_node_dirty(i->b))
1643 bch_btree_node_write(i->b, writes);
1644 mutex_unlock(&i->b->write_lock);
1645 rw_unlock(true, i->b);
1651 static int bch_btree_gc_root(struct btree *b, struct btree_op *op,
1652 struct closure *writes, struct gc_stat *gc)
1654 struct btree *n = NULL;
1656 bool should_rewrite;
1658 should_rewrite = btree_gc_mark_node(b, gc);
1659 if (should_rewrite) {
1660 n = btree_node_alloc_replacement(b, NULL);
1662 if (!IS_ERR_OR_NULL(n)) {
1663 bch_btree_node_write_sync(n);
1665 bch_btree_set_root(n);
1673 __bch_btree_mark_key(b->c, b->level + 1, &b->key);
1676 ret = btree_gc_recurse(b, op, writes, gc);
1681 bkey_copy_key(&b->c->gc_done, &b->key);
1686 static void btree_gc_start(struct cache_set *c)
1692 if (!c->gc_mark_valid)
1695 mutex_lock(&c->bucket_lock);
1697 c->gc_mark_valid = 0;
1698 c->gc_done = ZERO_KEY;
1700 for_each_cache(ca, c, i)
1701 for_each_bucket(b, ca) {
1702 b->last_gc = b->gen;
1703 if (!atomic_read(&b->pin)) {
1705 SET_GC_SECTORS_USED(b, 0);
1709 mutex_unlock(&c->bucket_lock);
1712 static void bch_btree_gc_finish(struct cache_set *c)
1718 mutex_lock(&c->bucket_lock);
1721 c->gc_mark_valid = 1;
1724 for (i = 0; i < KEY_PTRS(&c->uuid_bucket); i++)
1725 SET_GC_MARK(PTR_BUCKET(c, &c->uuid_bucket, i),
1728 /* don't reclaim buckets to which writeback keys point */
1730 for (i = 0; i < c->devices_max_used; i++) {
1731 struct bcache_device *d = c->devices[i];
1732 struct cached_dev *dc;
1733 struct keybuf_key *w, *n;
1736 if (!d || UUID_FLASH_ONLY(&c->uuids[i]))
1738 dc = container_of(d, struct cached_dev, disk);
1740 spin_lock(&dc->writeback_keys.lock);
1741 rbtree_postorder_for_each_entry_safe(w, n,
1742 &dc->writeback_keys.keys, node)
1743 for (j = 0; j < KEY_PTRS(&w->key); j++)
1744 SET_GC_MARK(PTR_BUCKET(c, &w->key, j),
1746 spin_unlock(&dc->writeback_keys.lock);
1750 c->avail_nbuckets = 0;
1751 for_each_cache(ca, c, i) {
1754 ca->invalidate_needs_gc = 0;
1756 for (i = ca->sb.d; i < ca->sb.d + ca->sb.keys; i++)
1757 SET_GC_MARK(ca->buckets + *i, GC_MARK_METADATA);
1759 for (i = ca->prio_buckets;
1760 i < ca->prio_buckets + prio_buckets(ca) * 2; i++)
1761 SET_GC_MARK(ca->buckets + *i, GC_MARK_METADATA);
1763 for_each_bucket(b, ca) {
1764 c->need_gc = max(c->need_gc, bucket_gc_gen(b));
1766 if (atomic_read(&b->pin))
1769 BUG_ON(!GC_MARK(b) && GC_SECTORS_USED(b));
1771 if (!GC_MARK(b) || GC_MARK(b) == GC_MARK_RECLAIMABLE)
1772 c->avail_nbuckets++;
1776 mutex_unlock(&c->bucket_lock);
1779 static void bch_btree_gc(struct cache_set *c)
1782 struct gc_stat stats;
1783 struct closure writes;
1785 uint64_t start_time = local_clock();
1787 trace_bcache_gc_start(c);
1789 memset(&stats, 0, sizeof(struct gc_stat));
1790 closure_init_stack(&writes);
1791 bch_btree_op_init(&op, SHRT_MAX);
1795 /* if CACHE_SET_IO_DISABLE set, gc thread should stop too */
1797 ret = btree_root(gc_root, c, &op, &writes, &stats);
1798 closure_sync(&writes);
1802 schedule_timeout_interruptible(msecs_to_jiffies
1805 pr_warn("gc failed!");
1806 } while (ret && !test_bit(CACHE_SET_IO_DISABLE, &c->flags));
1808 bch_btree_gc_finish(c);
1809 wake_up_allocators(c);
1811 bch_time_stats_update(&c->btree_gc_time, start_time);
1813 stats.key_bytes *= sizeof(uint64_t);
1815 bch_update_bucket_in_use(c, &stats);
1816 memcpy(&c->gc_stats, &stats, sizeof(struct gc_stat));
1818 trace_bcache_gc_end(c);
1823 static bool gc_should_run(struct cache_set *c)
1828 for_each_cache(ca, c, i)
1829 if (ca->invalidate_needs_gc)
1832 if (atomic_read(&c->sectors_to_gc) < 0)
1838 static int bch_gc_thread(void *arg)
1840 struct cache_set *c = arg;
1843 wait_event_interruptible(c->gc_wait,
1844 kthread_should_stop() ||
1845 test_bit(CACHE_SET_IO_DISABLE, &c->flags) ||
1848 if (kthread_should_stop() ||
1849 test_bit(CACHE_SET_IO_DISABLE, &c->flags))
1856 wait_for_kthread_stop();
1860 int bch_gc_thread_start(struct cache_set *c)
1862 c->gc_thread = kthread_run(bch_gc_thread, c, "bcache_gc");
1863 return PTR_ERR_OR_ZERO(c->gc_thread);
1866 /* Initial partial gc */
1868 static int bch_btree_check_recurse(struct btree *b, struct btree_op *op)
1871 struct bkey *k, *p = NULL;
1872 struct btree_iter iter;
1874 for_each_key_filter(&b->keys, k, &iter, bch_ptr_invalid)
1875 bch_initial_mark_key(b->c, b->level, k);
1877 bch_initial_mark_key(b->c, b->level + 1, &b->key);
1880 bch_btree_iter_init(&b->keys, &iter, NULL);
1883 k = bch_btree_iter_next_filter(&iter, &b->keys,
1886 btree_node_prefetch(b, k);
1888 * initiallize c->gc_stats.nodes
1889 * for incremental GC
1891 b->c->gc_stats.nodes++;
1895 ret = btree(check_recurse, p, b, op);
1898 } while (p && !ret);
1904 int bch_btree_check(struct cache_set *c)
1908 bch_btree_op_init(&op, SHRT_MAX);
1910 return btree_root(check_recurse, c, &op);
1913 void bch_initial_gc_finish(struct cache_set *c)
1919 bch_btree_gc_finish(c);
1921 mutex_lock(&c->bucket_lock);
1924 * We need to put some unused buckets directly on the prio freelist in
1925 * order to get the allocator thread started - it needs freed buckets in
1926 * order to rewrite the prios and gens, and it needs to rewrite prios
1927 * and gens in order to free buckets.
1929 * This is only safe for buckets that have no live data in them, which
1930 * there should always be some of.
1932 for_each_cache(ca, c, i) {
1933 for_each_bucket(b, ca) {
1934 if (fifo_full(&ca->free[RESERVE_PRIO]) &&
1935 fifo_full(&ca->free[RESERVE_BTREE]))
1938 if (bch_can_invalidate_bucket(ca, b) &&
1940 __bch_invalidate_one_bucket(ca, b);
1941 if (!fifo_push(&ca->free[RESERVE_PRIO],
1943 fifo_push(&ca->free[RESERVE_BTREE],
1949 mutex_unlock(&c->bucket_lock);
1952 /* Btree insertion */
1954 static bool btree_insert_key(struct btree *b, struct bkey *k,
1955 struct bkey *replace_key)
1957 unsigned int status;
1959 BUG_ON(bkey_cmp(k, &b->key) > 0);
1961 status = bch_btree_insert_key(&b->keys, k, replace_key);
1962 if (status != BTREE_INSERT_STATUS_NO_INSERT) {
1963 bch_check_keys(&b->keys, "%u for %s", status,
1964 replace_key ? "replace" : "insert");
1966 trace_bcache_btree_insert_key(b, k, replace_key != NULL,
1973 static size_t insert_u64s_remaining(struct btree *b)
1975 long ret = bch_btree_keys_u64s_remaining(&b->keys);
1978 * Might land in the middle of an existing extent and have to split it
1980 if (b->keys.ops->is_extents)
1981 ret -= KEY_MAX_U64S;
1983 return max(ret, 0L);
1986 static bool bch_btree_insert_keys(struct btree *b, struct btree_op *op,
1987 struct keylist *insert_keys,
1988 struct bkey *replace_key)
1991 int oldsize = bch_count_data(&b->keys);
1993 while (!bch_keylist_empty(insert_keys)) {
1994 struct bkey *k = insert_keys->keys;
1996 if (bkey_u64s(k) > insert_u64s_remaining(b))
1999 if (bkey_cmp(k, &b->key) <= 0) {
2003 ret |= btree_insert_key(b, k, replace_key);
2004 bch_keylist_pop_front(insert_keys);
2005 } else if (bkey_cmp(&START_KEY(k), &b->key) < 0) {
2006 BKEY_PADDED(key) temp;
2007 bkey_copy(&temp.key, insert_keys->keys);
2009 bch_cut_back(&b->key, &temp.key);
2010 bch_cut_front(&b->key, insert_keys->keys);
2012 ret |= btree_insert_key(b, &temp.key, replace_key);
2020 op->insert_collision = true;
2022 BUG_ON(!bch_keylist_empty(insert_keys) && b->level);
2024 BUG_ON(bch_count_data(&b->keys) < oldsize);
2028 static int btree_split(struct btree *b, struct btree_op *op,
2029 struct keylist *insert_keys,
2030 struct bkey *replace_key)
2033 struct btree *n1, *n2 = NULL, *n3 = NULL;
2034 uint64_t start_time = local_clock();
2036 struct keylist parent_keys;
2038 closure_init_stack(&cl);
2039 bch_keylist_init(&parent_keys);
2041 if (btree_check_reserve(b, op)) {
2045 WARN(1, "insufficient reserve for split\n");
2048 n1 = btree_node_alloc_replacement(b, op);
2052 split = set_blocks(btree_bset_first(n1),
2053 block_bytes(n1->c)) > (btree_blocks(b) * 4) / 5;
2056 unsigned int keys = 0;
2058 trace_bcache_btree_node_split(b, btree_bset_first(n1)->keys);
2060 n2 = bch_btree_node_alloc(b->c, op, b->level, b->parent);
2065 n3 = bch_btree_node_alloc(b->c, op, b->level + 1, NULL);
2070 mutex_lock(&n1->write_lock);
2071 mutex_lock(&n2->write_lock);
2073 bch_btree_insert_keys(n1, op, insert_keys, replace_key);
2076 * Has to be a linear search because we don't have an auxiliary
2080 while (keys < (btree_bset_first(n1)->keys * 3) / 5)
2081 keys += bkey_u64s(bset_bkey_idx(btree_bset_first(n1),
2084 bkey_copy_key(&n1->key,
2085 bset_bkey_idx(btree_bset_first(n1), keys));
2086 keys += bkey_u64s(bset_bkey_idx(btree_bset_first(n1), keys));
2088 btree_bset_first(n2)->keys = btree_bset_first(n1)->keys - keys;
2089 btree_bset_first(n1)->keys = keys;
2091 memcpy(btree_bset_first(n2)->start,
2092 bset_bkey_last(btree_bset_first(n1)),
2093 btree_bset_first(n2)->keys * sizeof(uint64_t));
2095 bkey_copy_key(&n2->key, &b->key);
2097 bch_keylist_add(&parent_keys, &n2->key);
2098 bch_btree_node_write(n2, &cl);
2099 mutex_unlock(&n2->write_lock);
2100 rw_unlock(true, n2);
2102 trace_bcache_btree_node_compact(b, btree_bset_first(n1)->keys);
2104 mutex_lock(&n1->write_lock);
2105 bch_btree_insert_keys(n1, op, insert_keys, replace_key);
2108 bch_keylist_add(&parent_keys, &n1->key);
2109 bch_btree_node_write(n1, &cl);
2110 mutex_unlock(&n1->write_lock);
2113 /* Depth increases, make a new root */
2114 mutex_lock(&n3->write_lock);
2115 bkey_copy_key(&n3->key, &MAX_KEY);
2116 bch_btree_insert_keys(n3, op, &parent_keys, NULL);
2117 bch_btree_node_write(n3, &cl);
2118 mutex_unlock(&n3->write_lock);
2121 bch_btree_set_root(n3);
2122 rw_unlock(true, n3);
2123 } else if (!b->parent) {
2124 /* Root filled up but didn't need to be split */
2126 bch_btree_set_root(n1);
2128 /* Split a non root node */
2130 make_btree_freeing_key(b, parent_keys.top);
2131 bch_keylist_push(&parent_keys);
2133 bch_btree_insert_node(b->parent, op, &parent_keys, NULL, NULL);
2134 BUG_ON(!bch_keylist_empty(&parent_keys));
2138 rw_unlock(true, n1);
2140 bch_time_stats_update(&b->c->btree_split_time, start_time);
2144 bkey_put(b->c, &n2->key);
2145 btree_node_free(n2);
2146 rw_unlock(true, n2);
2148 bkey_put(b->c, &n1->key);
2149 btree_node_free(n1);
2150 rw_unlock(true, n1);
2152 WARN(1, "bcache: btree split failed (level %u)", b->level);
2154 if (n3 == ERR_PTR(-EAGAIN) ||
2155 n2 == ERR_PTR(-EAGAIN) ||
2156 n1 == ERR_PTR(-EAGAIN))
2162 static int bch_btree_insert_node(struct btree *b, struct btree_op *op,
2163 struct keylist *insert_keys,
2164 atomic_t *journal_ref,
2165 struct bkey *replace_key)
2169 BUG_ON(b->level && replace_key);
2171 closure_init_stack(&cl);
2173 mutex_lock(&b->write_lock);
2175 if (write_block(b) != btree_bset_last(b) &&
2176 b->keys.last_set_unwritten)
2177 bch_btree_init_next(b); /* just wrote a set */
2179 if (bch_keylist_nkeys(insert_keys) > insert_u64s_remaining(b)) {
2180 mutex_unlock(&b->write_lock);
2184 BUG_ON(write_block(b) != btree_bset_last(b));
2186 if (bch_btree_insert_keys(b, op, insert_keys, replace_key)) {
2188 bch_btree_leaf_dirty(b, journal_ref);
2190 bch_btree_node_write(b, &cl);
2193 mutex_unlock(&b->write_lock);
2195 /* wait for btree node write if necessary, after unlock */
2200 if (current->bio_list) {
2201 op->lock = b->c->root->level + 1;
2203 } else if (op->lock <= b->c->root->level) {
2204 op->lock = b->c->root->level + 1;
2207 /* Invalidated all iterators */
2208 int ret = btree_split(b, op, insert_keys, replace_key);
2210 if (bch_keylist_empty(insert_keys))
2218 int bch_btree_insert_check_key(struct btree *b, struct btree_op *op,
2219 struct bkey *check_key)
2222 uint64_t btree_ptr = b->key.ptr[0];
2223 unsigned long seq = b->seq;
2224 struct keylist insert;
2225 bool upgrade = op->lock == -1;
2227 bch_keylist_init(&insert);
2230 rw_unlock(false, b);
2231 rw_lock(true, b, b->level);
2233 if (b->key.ptr[0] != btree_ptr ||
2234 b->seq != seq + 1) {
2235 op->lock = b->level;
2240 SET_KEY_PTRS(check_key, 1);
2241 get_random_bytes(&check_key->ptr[0], sizeof(uint64_t));
2243 SET_PTR_DEV(check_key, 0, PTR_CHECK_DEV);
2245 bch_keylist_add(&insert, check_key);
2247 ret = bch_btree_insert_node(b, op, &insert, NULL, NULL);
2249 BUG_ON(!ret && !bch_keylist_empty(&insert));
2252 downgrade_write(&b->lock);
2256 struct btree_insert_op {
2258 struct keylist *keys;
2259 atomic_t *journal_ref;
2260 struct bkey *replace_key;
2263 static int btree_insert_fn(struct btree_op *b_op, struct btree *b)
2265 struct btree_insert_op *op = container_of(b_op,
2266 struct btree_insert_op, op);
2268 int ret = bch_btree_insert_node(b, &op->op, op->keys,
2269 op->journal_ref, op->replace_key);
2270 if (ret && !bch_keylist_empty(op->keys))
2276 int bch_btree_insert(struct cache_set *c, struct keylist *keys,
2277 atomic_t *journal_ref, struct bkey *replace_key)
2279 struct btree_insert_op op;
2282 BUG_ON(current->bio_list);
2283 BUG_ON(bch_keylist_empty(keys));
2285 bch_btree_op_init(&op.op, 0);
2287 op.journal_ref = journal_ref;
2288 op.replace_key = replace_key;
2290 while (!ret && !bch_keylist_empty(keys)) {
2292 ret = bch_btree_map_leaf_nodes(&op.op, c,
2293 &START_KEY(keys->keys),
2300 pr_err("error %i", ret);
2302 while ((k = bch_keylist_pop(keys)))
2304 } else if (op.op.insert_collision)
2310 void bch_btree_set_root(struct btree *b)
2315 closure_init_stack(&cl);
2317 trace_bcache_btree_set_root(b);
2319 BUG_ON(!b->written);
2321 for (i = 0; i < KEY_PTRS(&b->key); i++)
2322 BUG_ON(PTR_BUCKET(b->c, &b->key, i)->prio != BTREE_PRIO);
2324 mutex_lock(&b->c->bucket_lock);
2325 list_del_init(&b->list);
2326 mutex_unlock(&b->c->bucket_lock);
2330 bch_journal_meta(b->c, &cl);
2334 /* Map across nodes or keys */
2336 static int bch_btree_map_nodes_recurse(struct btree *b, struct btree_op *op,
2338 btree_map_nodes_fn *fn, int flags)
2340 int ret = MAP_CONTINUE;
2344 struct btree_iter iter;
2346 bch_btree_iter_init(&b->keys, &iter, from);
2348 while ((k = bch_btree_iter_next_filter(&iter, &b->keys,
2350 ret = btree(map_nodes_recurse, k, b,
2351 op, from, fn, flags);
2354 if (ret != MAP_CONTINUE)
2359 if (!b->level || flags == MAP_ALL_NODES)
2365 int __bch_btree_map_nodes(struct btree_op *op, struct cache_set *c,
2366 struct bkey *from, btree_map_nodes_fn *fn, int flags)
2368 return btree_root(map_nodes_recurse, c, op, from, fn, flags);
2371 static int bch_btree_map_keys_recurse(struct btree *b, struct btree_op *op,
2372 struct bkey *from, btree_map_keys_fn *fn,
2375 int ret = MAP_CONTINUE;
2377 struct btree_iter iter;
2379 bch_btree_iter_init(&b->keys, &iter, from);
2381 while ((k = bch_btree_iter_next_filter(&iter, &b->keys, bch_ptr_bad))) {
2384 : btree(map_keys_recurse, k, b, op, from, fn, flags);
2387 if (ret != MAP_CONTINUE)
2391 if (!b->level && (flags & MAP_END_KEY))
2392 ret = fn(op, b, &KEY(KEY_INODE(&b->key),
2393 KEY_OFFSET(&b->key), 0));
2398 int bch_btree_map_keys(struct btree_op *op, struct cache_set *c,
2399 struct bkey *from, btree_map_keys_fn *fn, int flags)
2401 return btree_root(map_keys_recurse, c, op, from, fn, flags);
2406 static inline int keybuf_cmp(struct keybuf_key *l, struct keybuf_key *r)
2408 /* Overlapping keys compare equal */
2409 if (bkey_cmp(&l->key, &START_KEY(&r->key)) <= 0)
2411 if (bkey_cmp(&START_KEY(&l->key), &r->key) >= 0)
2416 static inline int keybuf_nonoverlapping_cmp(struct keybuf_key *l,
2417 struct keybuf_key *r)
2419 return clamp_t(int64_t, bkey_cmp(&l->key, &r->key), -1, 1);
2424 unsigned int nr_found;
2427 keybuf_pred_fn *pred;
2430 static int refill_keybuf_fn(struct btree_op *op, struct btree *b,
2433 struct refill *refill = container_of(op, struct refill, op);
2434 struct keybuf *buf = refill->buf;
2435 int ret = MAP_CONTINUE;
2437 if (bkey_cmp(k, refill->end) >= 0) {
2442 if (!KEY_SIZE(k)) /* end key */
2445 if (refill->pred(buf, k)) {
2446 struct keybuf_key *w;
2448 spin_lock(&buf->lock);
2450 w = array_alloc(&buf->freelist);
2452 spin_unlock(&buf->lock);
2457 bkey_copy(&w->key, k);
2459 if (RB_INSERT(&buf->keys, w, node, keybuf_cmp))
2460 array_free(&buf->freelist, w);
2464 if (array_freelist_empty(&buf->freelist))
2467 spin_unlock(&buf->lock);
2470 buf->last_scanned = *k;
2474 void bch_refill_keybuf(struct cache_set *c, struct keybuf *buf,
2475 struct bkey *end, keybuf_pred_fn *pred)
2477 struct bkey start = buf->last_scanned;
2478 struct refill refill;
2482 bch_btree_op_init(&refill.op, -1);
2483 refill.nr_found = 0;
2488 bch_btree_map_keys(&refill.op, c, &buf->last_scanned,
2489 refill_keybuf_fn, MAP_END_KEY);
2491 trace_bcache_keyscan(refill.nr_found,
2492 KEY_INODE(&start), KEY_OFFSET(&start),
2493 KEY_INODE(&buf->last_scanned),
2494 KEY_OFFSET(&buf->last_scanned));
2496 spin_lock(&buf->lock);
2498 if (!RB_EMPTY_ROOT(&buf->keys)) {
2499 struct keybuf_key *w;
2501 w = RB_FIRST(&buf->keys, struct keybuf_key, node);
2502 buf->start = START_KEY(&w->key);
2504 w = RB_LAST(&buf->keys, struct keybuf_key, node);
2507 buf->start = MAX_KEY;
2511 spin_unlock(&buf->lock);
2514 static void __bch_keybuf_del(struct keybuf *buf, struct keybuf_key *w)
2516 rb_erase(&w->node, &buf->keys);
2517 array_free(&buf->freelist, w);
2520 void bch_keybuf_del(struct keybuf *buf, struct keybuf_key *w)
2522 spin_lock(&buf->lock);
2523 __bch_keybuf_del(buf, w);
2524 spin_unlock(&buf->lock);
2527 bool bch_keybuf_check_overlapping(struct keybuf *buf, struct bkey *start,
2531 struct keybuf_key *p, *w, s;
2535 if (bkey_cmp(end, &buf->start) <= 0 ||
2536 bkey_cmp(start, &buf->end) >= 0)
2539 spin_lock(&buf->lock);
2540 w = RB_GREATER(&buf->keys, s, node, keybuf_nonoverlapping_cmp);
2542 while (w && bkey_cmp(&START_KEY(&w->key), end) < 0) {
2544 w = RB_NEXT(w, node);
2549 __bch_keybuf_del(buf, p);
2552 spin_unlock(&buf->lock);
2556 struct keybuf_key *bch_keybuf_next(struct keybuf *buf)
2558 struct keybuf_key *w;
2560 spin_lock(&buf->lock);
2562 w = RB_FIRST(&buf->keys, struct keybuf_key, node);
2564 while (w && w->private)
2565 w = RB_NEXT(w, node);
2568 w->private = ERR_PTR(-EINTR);
2570 spin_unlock(&buf->lock);
2574 struct keybuf_key *bch_keybuf_next_rescan(struct cache_set *c,
2577 keybuf_pred_fn *pred)
2579 struct keybuf_key *ret;
2582 ret = bch_keybuf_next(buf);
2586 if (bkey_cmp(&buf->last_scanned, end) >= 0) {
2587 pr_debug("scan finished");
2591 bch_refill_keybuf(c, buf, end, pred);
2597 void bch_keybuf_init(struct keybuf *buf)
2599 buf->last_scanned = MAX_KEY;
2600 buf->keys = RB_ROOT;
2602 spin_lock_init(&buf->lock);
2603 array_allocator_init(&buf->freelist);