2 * Copyright (C) 2010 Kent Overstreet <kent.overstreet@gmail.com>
4 * Uses a block device as cache for other block devices; optimized for SSDs.
5 * All allocation is done in buckets, which should match the erase block size
8 * Buckets containing cached data are kept on a heap sorted by priority;
9 * bucket priority is increased on cache hit, and periodically all the buckets
10 * on the heap have their priority scaled down. This currently is just used as
11 * an LRU but in the future should allow for more intelligent heuristics.
13 * Buckets have an 8 bit counter; freeing is accomplished by incrementing the
14 * counter. Garbage collection is used to remove stale pointers.
16 * Indexing is done via a btree; nodes are not necessarily fully sorted, rather
17 * as keys are inserted we only sort the pages that have not yet been written.
18 * When garbage collection is run, we resort the entire node.
20 * All configuration is done via sysfs; see Documentation/bcache.txt.
28 #include <linux/slab.h>
29 #include <linux/bitops.h>
30 #include <linux/hash.h>
31 #include <linux/kthread.h>
32 #include <linux/prefetch.h>
33 #include <linux/random.h>
34 #include <linux/rcupdate.h>
35 #include <linux/sched/clock.h>
36 #include <trace/events/bcache.h>
40 * register_bcache: Return errors out to userspace correctly
42 * Writeback: don't undirty key until after a cache flush
44 * Create an iterator for key pointers
46 * On btree write error, mark bucket such that it won't be freed from the cache
49 * Check for bad keys in replay
51 * Refcount journal entries in journal_replay
54 * Finish incremental gc
55 * Gc should free old UUIDs, data for invalid UUIDs
57 * Provide a way to list backing device UUIDs we have data cached for, and
58 * probably how long it's been since we've seen them, and a way to invalidate
59 * dirty data for devices that will never be attached again
61 * Keep 1 min/5 min/15 min statistics of how busy a block device has been, so
62 * that based on that and how much dirty data we have we can keep writeback
65 * Add a tracepoint or somesuch to watch for writeback starvation
67 * When btree depth > 1 and splitting an interior node, we have to make sure
68 * alloc_bucket() cannot fail. This should be true but is not completely
73 * If data write is less than hard sector size of ssd, round up offset in open
74 * bucket to the next whole sector
76 * Superblock needs to be fleshed out for multiple cache devices
78 * Add a sysfs tunable for the number of writeback IOs in flight
80 * Add a sysfs tunable for the number of open data buckets
82 * IO tracking: Can we track when one process is doing io on behalf of another?
83 * IO tracking: Don't use just an average, weigh more recent stuff higher
85 * Test module load/unload
88 #define MAX_NEED_GC 64
89 #define MAX_SAVE_PRIO 72
91 #define PTR_DIRTY_BIT (((uint64_t) 1 << 36))
93 #define PTR_HASH(c, k) \
94 (((k)->ptr[0] >> c->bucket_bits) | PTR_GEN(k, 0))
96 #define insert_lock(s, b) ((b)->level <= (s)->lock)
99 * These macros are for recursing down the btree - they handle the details of
100 * locking and looking up nodes in the cache for you. They're best treated as
101 * mere syntax when reading code that uses them.
103 * op->lock determines whether we take a read or a write lock at a given depth.
104 * If you've got a read lock and find that you need a write lock (i.e. you're
105 * going to have to split), set op->lock and return -EINTR; btree_root() will
106 * call you again and you'll have the correct lock.
110 * btree - recurse down the btree on a specified key
111 * @fn: function to call, which will be passed the child node
112 * @key: key to recurse on
113 * @b: parent btree node
114 * @op: pointer to struct btree_op
116 #define btree(fn, key, b, op, ...) \
118 int _r, l = (b)->level - 1; \
119 bool _w = l <= (op)->lock; \
120 struct btree *_child = bch_btree_node_get((b)->c, op, key, l, \
122 if (!IS_ERR(_child)) { \
123 _r = bch_btree_ ## fn(_child, op, ##__VA_ARGS__); \
124 rw_unlock(_w, _child); \
126 _r = PTR_ERR(_child); \
131 * btree_root - call a function on the root of the btree
132 * @fn: function to call, which will be passed the child node
134 * @op: pointer to struct btree_op
136 #define btree_root(fn, c, op, ...) \
140 struct btree *_b = (c)->root; \
141 bool _w = insert_lock(op, _b); \
142 rw_lock(_w, _b, _b->level); \
143 if (_b == (c)->root && \
144 _w == insert_lock(op, _b)) { \
145 _r = bch_btree_ ## fn(_b, op, ##__VA_ARGS__); \
148 bch_cannibalize_unlock(c); \
151 } while (_r == -EINTR); \
153 finish_wait(&(c)->btree_cache_wait, &(op)->wait); \
157 static inline struct bset *write_block(struct btree *b)
159 return ((void *) btree_bset_first(b)) + b->written * block_bytes(b->c);
162 static void bch_btree_init_next(struct btree *b)
164 /* If not a leaf node, always sort */
165 if (b->level && b->keys.nsets)
166 bch_btree_sort(&b->keys, &b->c->sort);
168 bch_btree_sort_lazy(&b->keys, &b->c->sort);
170 if (b->written < btree_blocks(b))
171 bch_bset_init_next(&b->keys, write_block(b),
172 bset_magic(&b->c->sb));
176 /* Btree key manipulation */
178 void bkey_put(struct cache_set *c, struct bkey *k)
182 for (i = 0; i < KEY_PTRS(k); i++)
183 if (ptr_available(c, k, i))
184 atomic_dec_bug(&PTR_BUCKET(c, k, i)->pin);
189 static uint64_t btree_csum_set(struct btree *b, struct bset *i)
191 uint64_t crc = b->key.ptr[0];
192 void *data = (void *) i + 8, *end = bset_bkey_last(i);
194 crc = bch_crc64_update(crc, data, end - data);
195 return crc ^ 0xffffffffffffffffULL;
198 void bch_btree_node_read_done(struct btree *b)
200 const char *err = "bad btree header";
201 struct bset *i = btree_bset_first(b);
202 struct btree_iter *iter;
204 iter = mempool_alloc(b->c->fill_iter, GFP_NOIO);
205 iter->size = b->c->sb.bucket_size / b->c->sb.block_size;
208 #ifdef CONFIG_BCACHE_DEBUG
216 b->written < btree_blocks(b) && i->seq == b->keys.set[0].data->seq;
217 i = write_block(b)) {
218 err = "unsupported bset version";
219 if (i->version > BCACHE_BSET_VERSION)
222 err = "bad btree header";
223 if (b->written + set_blocks(i, block_bytes(b->c)) >
228 if (i->magic != bset_magic(&b->c->sb))
231 err = "bad checksum";
232 switch (i->version) {
234 if (i->csum != csum_set(i))
237 case BCACHE_BSET_VERSION:
238 if (i->csum != btree_csum_set(b, i))
244 if (i != b->keys.set[0].data && !i->keys)
247 bch_btree_iter_push(iter, i->start, bset_bkey_last(i));
249 b->written += set_blocks(i, block_bytes(b->c));
252 err = "corrupted btree";
253 for (i = write_block(b);
254 bset_sector_offset(&b->keys, i) < KEY_SIZE(&b->key);
255 i = ((void *) i) + block_bytes(b->c))
256 if (i->seq == b->keys.set[0].data->seq)
259 bch_btree_sort_and_fix_extents(&b->keys, iter, &b->c->sort);
261 i = b->keys.set[0].data;
262 err = "short btree key";
263 if (b->keys.set[0].size &&
264 bkey_cmp(&b->key, &b->keys.set[0].end) < 0)
267 if (b->written < btree_blocks(b))
268 bch_bset_init_next(&b->keys, write_block(b),
269 bset_magic(&b->c->sb));
271 mempool_free(iter, b->c->fill_iter);
274 set_btree_node_io_error(b);
275 bch_cache_set_error(b->c, "%s at bucket %zu, block %u, %u keys",
276 err, PTR_BUCKET_NR(b->c, &b->key, 0),
277 bset_block_offset(b, i), i->keys);
281 static void btree_node_read_endio(struct bio *bio)
283 struct closure *cl = bio->bi_private;
287 static void bch_btree_node_read(struct btree *b)
289 uint64_t start_time = local_clock();
293 trace_bcache_btree_read(b);
295 closure_init_stack(&cl);
297 bio = bch_bbio_alloc(b->c);
298 bio->bi_iter.bi_size = KEY_SIZE(&b->key) << 9;
299 bio->bi_end_io = btree_node_read_endio;
300 bio->bi_private = &cl;
301 bio->bi_opf = REQ_OP_READ | REQ_META;
303 bch_bio_map(bio, b->keys.set[0].data);
305 bch_submit_bbio(bio, b->c, &b->key, 0);
309 set_btree_node_io_error(b);
311 bch_bbio_free(bio, b->c);
313 if (btree_node_io_error(b))
316 bch_btree_node_read_done(b);
317 bch_time_stats_update(&b->c->btree_read_time, start_time);
321 bch_cache_set_error(b->c, "io error reading bucket %zu",
322 PTR_BUCKET_NR(b->c, &b->key, 0));
325 static void btree_complete_write(struct btree *b, struct btree_write *w)
327 if (w->prio_blocked &&
328 !atomic_sub_return(w->prio_blocked, &b->c->prio_blocked))
329 wake_up_allocators(b->c);
332 atomic_dec_bug(w->journal);
333 __closure_wake_up(&b->c->journal.wait);
340 static void btree_node_write_unlock(struct closure *cl)
342 struct btree *b = container_of(cl, struct btree, io);
347 static void __btree_node_write_done(struct closure *cl)
349 struct btree *b = container_of(cl, struct btree, io);
350 struct btree_write *w = btree_prev_write(b);
352 bch_bbio_free(b->bio, b->c);
354 btree_complete_write(b, w);
356 if (btree_node_dirty(b))
357 schedule_delayed_work(&b->work, 30 * HZ);
359 closure_return_with_destructor(cl, btree_node_write_unlock);
362 static void btree_node_write_done(struct closure *cl)
364 struct btree *b = container_of(cl, struct btree, io);
366 bio_free_pages(b->bio);
367 __btree_node_write_done(cl);
370 static void btree_node_write_endio(struct bio *bio)
372 struct closure *cl = bio->bi_private;
373 struct btree *b = container_of(cl, struct btree, io);
376 set_btree_node_io_error(b);
378 bch_bbio_count_io_errors(b->c, bio, bio->bi_error, "writing btree");
382 static void do_btree_node_write(struct btree *b)
384 struct closure *cl = &b->io;
385 struct bset *i = btree_bset_last(b);
388 i->version = BCACHE_BSET_VERSION;
389 i->csum = btree_csum_set(b, i);
392 b->bio = bch_bbio_alloc(b->c);
394 b->bio->bi_end_io = btree_node_write_endio;
395 b->bio->bi_private = cl;
396 b->bio->bi_iter.bi_size = roundup(set_bytes(i), block_bytes(b->c));
397 b->bio->bi_opf = REQ_OP_WRITE | REQ_META | REQ_FUA;
398 bch_bio_map(b->bio, i);
401 * If we're appending to a leaf node, we don't technically need FUA -
402 * this write just needs to be persisted before the next journal write,
403 * which will be marked FLUSH|FUA.
405 * Similarly if we're writing a new btree root - the pointer is going to
406 * be in the next journal entry.
408 * But if we're writing a new btree node (that isn't a root) or
409 * appending to a non leaf btree node, we need either FUA or a flush
410 * when we write the parent with the new pointer. FUA is cheaper than a
411 * flush, and writes appending to leaf nodes aren't blocking anything so
412 * just make all btree node writes FUA to keep things sane.
415 bkey_copy(&k.key, &b->key);
416 SET_PTR_OFFSET(&k.key, 0, PTR_OFFSET(&k.key, 0) +
417 bset_sector_offset(&b->keys, i));
419 if (!bio_alloc_pages(b->bio, __GFP_NOWARN|GFP_NOWAIT)) {
422 void *base = (void *) ((unsigned long) i & ~(PAGE_SIZE - 1));
424 bio_for_each_segment_all(bv, b->bio, j)
425 memcpy(page_address(bv->bv_page),
426 base + j * PAGE_SIZE, PAGE_SIZE);
428 bch_submit_bbio(b->bio, b->c, &k.key, 0);
430 continue_at(cl, btree_node_write_done, NULL);
433 bch_bio_map(b->bio, i);
435 bch_submit_bbio(b->bio, b->c, &k.key, 0);
438 continue_at_nobarrier(cl, __btree_node_write_done, NULL);
442 void __bch_btree_node_write(struct btree *b, struct closure *parent)
444 struct bset *i = btree_bset_last(b);
446 lockdep_assert_held(&b->write_lock);
448 trace_bcache_btree_write(b);
450 BUG_ON(current->bio_list);
451 BUG_ON(b->written >= btree_blocks(b));
452 BUG_ON(b->written && !i->keys);
453 BUG_ON(btree_bset_first(b)->seq != i->seq);
454 bch_check_keys(&b->keys, "writing");
456 cancel_delayed_work(&b->work);
458 /* If caller isn't waiting for write, parent refcount is cache set */
460 closure_init(&b->io, parent ?: &b->c->cl);
462 clear_bit(BTREE_NODE_dirty, &b->flags);
463 change_bit(BTREE_NODE_write_idx, &b->flags);
465 do_btree_node_write(b);
467 atomic_long_add(set_blocks(i, block_bytes(b->c)) * b->c->sb.block_size,
468 &PTR_CACHE(b->c, &b->key, 0)->btree_sectors_written);
470 b->written += set_blocks(i, block_bytes(b->c));
473 void bch_btree_node_write(struct btree *b, struct closure *parent)
475 unsigned nsets = b->keys.nsets;
477 lockdep_assert_held(&b->lock);
479 __bch_btree_node_write(b, parent);
482 * do verify if there was more than one set initially (i.e. we did a
483 * sort) and we sorted down to a single set:
485 if (nsets && !b->keys.nsets)
488 bch_btree_init_next(b);
491 static void bch_btree_node_write_sync(struct btree *b)
495 closure_init_stack(&cl);
497 mutex_lock(&b->write_lock);
498 bch_btree_node_write(b, &cl);
499 mutex_unlock(&b->write_lock);
504 static void btree_node_write_work(struct work_struct *w)
506 struct btree *b = container_of(to_delayed_work(w), struct btree, work);
508 mutex_lock(&b->write_lock);
509 if (btree_node_dirty(b))
510 __bch_btree_node_write(b, NULL);
511 mutex_unlock(&b->write_lock);
514 static void bch_btree_leaf_dirty(struct btree *b, atomic_t *journal_ref)
516 struct bset *i = btree_bset_last(b);
517 struct btree_write *w = btree_current_write(b);
519 lockdep_assert_held(&b->write_lock);
524 if (!btree_node_dirty(b))
525 schedule_delayed_work(&b->work, 30 * HZ);
527 set_btree_node_dirty(b);
531 journal_pin_cmp(b->c, w->journal, journal_ref)) {
532 atomic_dec_bug(w->journal);
537 w->journal = journal_ref;
538 atomic_inc(w->journal);
542 /* Force write if set is too big */
543 if (set_bytes(i) > PAGE_SIZE - 48 &&
545 bch_btree_node_write(b, NULL);
549 * Btree in memory cache - allocation/freeing
550 * mca -> memory cache
553 #define mca_reserve(c) (((c->root && c->root->level) \
554 ? c->root->level : 1) * 8 + 16)
555 #define mca_can_free(c) \
556 max_t(int, 0, c->btree_cache_used - mca_reserve(c))
558 static void mca_data_free(struct btree *b)
560 BUG_ON(b->io_mutex.count != 1);
562 bch_btree_keys_free(&b->keys);
564 b->c->btree_cache_used--;
565 list_move(&b->list, &b->c->btree_cache_freed);
568 static void mca_bucket_free(struct btree *b)
570 BUG_ON(btree_node_dirty(b));
573 hlist_del_init_rcu(&b->hash);
574 list_move(&b->list, &b->c->btree_cache_freeable);
577 static unsigned btree_order(struct bkey *k)
579 return ilog2(KEY_SIZE(k) / PAGE_SECTORS ?: 1);
582 static void mca_data_alloc(struct btree *b, struct bkey *k, gfp_t gfp)
584 if (!bch_btree_keys_alloc(&b->keys,
586 ilog2(b->c->btree_pages),
589 b->c->btree_cache_used++;
590 list_move(&b->list, &b->c->btree_cache);
592 list_move(&b->list, &b->c->btree_cache_freed);
596 static struct btree *mca_bucket_alloc(struct cache_set *c,
597 struct bkey *k, gfp_t gfp)
599 struct btree *b = kzalloc(sizeof(struct btree), gfp);
603 init_rwsem(&b->lock);
604 lockdep_set_novalidate_class(&b->lock);
605 mutex_init(&b->write_lock);
606 lockdep_set_novalidate_class(&b->write_lock);
607 INIT_LIST_HEAD(&b->list);
608 INIT_DELAYED_WORK(&b->work, btree_node_write_work);
610 sema_init(&b->io_mutex, 1);
612 mca_data_alloc(b, k, gfp);
616 static int mca_reap(struct btree *b, unsigned min_order, bool flush)
620 closure_init_stack(&cl);
621 lockdep_assert_held(&b->c->bucket_lock);
623 if (!down_write_trylock(&b->lock))
626 BUG_ON(btree_node_dirty(b) && !b->keys.set[0].data);
628 if (b->keys.page_order < min_order)
632 if (btree_node_dirty(b))
635 if (down_trylock(&b->io_mutex))
640 mutex_lock(&b->write_lock);
641 if (btree_node_dirty(b))
642 __bch_btree_node_write(b, &cl);
643 mutex_unlock(&b->write_lock);
647 /* wait for any in flight btree write */
657 static unsigned long bch_mca_scan(struct shrinker *shrink,
658 struct shrink_control *sc)
660 struct cache_set *c = container_of(shrink, struct cache_set, shrink);
662 unsigned long i, nr = sc->nr_to_scan;
663 unsigned long freed = 0;
665 if (c->shrinker_disabled)
668 if (c->btree_cache_alloc_lock)
671 /* Return -1 if we can't do anything right now */
672 if (sc->gfp_mask & __GFP_IO)
673 mutex_lock(&c->bucket_lock);
674 else if (!mutex_trylock(&c->bucket_lock))
678 * It's _really_ critical that we don't free too many btree nodes - we
679 * have to always leave ourselves a reserve. The reserve is how we
680 * guarantee that allocating memory for a new btree node can always
681 * succeed, so that inserting keys into the btree can always succeed and
682 * IO can always make forward progress:
684 nr /= c->btree_pages;
685 nr = min_t(unsigned long, nr, mca_can_free(c));
688 list_for_each_entry_safe(b, t, &c->btree_cache_freeable, list) {
693 !mca_reap(b, 0, false)) {
700 for (i = 0; (nr--) && i < c->btree_cache_used; i++) {
701 if (list_empty(&c->btree_cache))
704 b = list_first_entry(&c->btree_cache, struct btree, list);
705 list_rotate_left(&c->btree_cache);
708 !mca_reap(b, 0, false)) {
717 mutex_unlock(&c->bucket_lock);
721 static unsigned long bch_mca_count(struct shrinker *shrink,
722 struct shrink_control *sc)
724 struct cache_set *c = container_of(shrink, struct cache_set, shrink);
726 if (c->shrinker_disabled)
729 if (c->btree_cache_alloc_lock)
732 return mca_can_free(c) * c->btree_pages;
735 void bch_btree_cache_free(struct cache_set *c)
739 closure_init_stack(&cl);
741 if (c->shrink.list.next)
742 unregister_shrinker(&c->shrink);
744 mutex_lock(&c->bucket_lock);
746 #ifdef CONFIG_BCACHE_DEBUG
748 list_move(&c->verify_data->list, &c->btree_cache);
750 free_pages((unsigned long) c->verify_ondisk, ilog2(bucket_pages(c)));
753 list_splice(&c->btree_cache_freeable,
756 while (!list_empty(&c->btree_cache)) {
757 b = list_first_entry(&c->btree_cache, struct btree, list);
759 if (btree_node_dirty(b))
760 btree_complete_write(b, btree_current_write(b));
761 clear_bit(BTREE_NODE_dirty, &b->flags);
766 while (!list_empty(&c->btree_cache_freed)) {
767 b = list_first_entry(&c->btree_cache_freed,
770 cancel_delayed_work_sync(&b->work);
774 mutex_unlock(&c->bucket_lock);
777 int bch_btree_cache_alloc(struct cache_set *c)
781 for (i = 0; i < mca_reserve(c); i++)
782 if (!mca_bucket_alloc(c, &ZERO_KEY, GFP_KERNEL))
785 list_splice_init(&c->btree_cache,
786 &c->btree_cache_freeable);
788 #ifdef CONFIG_BCACHE_DEBUG
789 mutex_init(&c->verify_lock);
791 c->verify_ondisk = (void *)
792 __get_free_pages(GFP_KERNEL, ilog2(bucket_pages(c)));
794 c->verify_data = mca_bucket_alloc(c, &ZERO_KEY, GFP_KERNEL);
796 if (c->verify_data &&
797 c->verify_data->keys.set->data)
798 list_del_init(&c->verify_data->list);
800 c->verify_data = NULL;
803 c->shrink.count_objects = bch_mca_count;
804 c->shrink.scan_objects = bch_mca_scan;
806 c->shrink.batch = c->btree_pages * 2;
807 register_shrinker(&c->shrink);
812 /* Btree in memory cache - hash table */
814 static struct hlist_head *mca_hash(struct cache_set *c, struct bkey *k)
816 return &c->bucket_hash[hash_32(PTR_HASH(c, k), BUCKET_HASH_BITS)];
819 static struct btree *mca_find(struct cache_set *c, struct bkey *k)
824 hlist_for_each_entry_rcu(b, mca_hash(c, k), hash)
825 if (PTR_HASH(c, &b->key) == PTR_HASH(c, k))
833 static int mca_cannibalize_lock(struct cache_set *c, struct btree_op *op)
835 struct task_struct *old;
837 old = cmpxchg(&c->btree_cache_alloc_lock, NULL, current);
838 if (old && old != current) {
840 prepare_to_wait(&c->btree_cache_wait, &op->wait,
841 TASK_UNINTERRUPTIBLE);
848 static struct btree *mca_cannibalize(struct cache_set *c, struct btree_op *op,
853 trace_bcache_btree_cache_cannibalize(c);
855 if (mca_cannibalize_lock(c, op))
856 return ERR_PTR(-EINTR);
858 list_for_each_entry_reverse(b, &c->btree_cache, list)
859 if (!mca_reap(b, btree_order(k), false))
862 list_for_each_entry_reverse(b, &c->btree_cache, list)
863 if (!mca_reap(b, btree_order(k), true))
866 WARN(1, "btree cache cannibalize failed\n");
867 return ERR_PTR(-ENOMEM);
871 * We can only have one thread cannibalizing other cached btree nodes at a time,
872 * or we'll deadlock. We use an open coded mutex to ensure that, which a
873 * cannibalize_bucket() will take. This means every time we unlock the root of
874 * the btree, we need to release this lock if we have it held.
876 static void bch_cannibalize_unlock(struct cache_set *c)
878 if (c->btree_cache_alloc_lock == current) {
879 c->btree_cache_alloc_lock = NULL;
880 wake_up(&c->btree_cache_wait);
884 static struct btree *mca_alloc(struct cache_set *c, struct btree_op *op,
885 struct bkey *k, int level)
889 BUG_ON(current->bio_list);
891 lockdep_assert_held(&c->bucket_lock);
896 /* btree_free() doesn't free memory; it sticks the node on the end of
897 * the list. Check if there's any freed nodes there:
899 list_for_each_entry(b, &c->btree_cache_freeable, list)
900 if (!mca_reap(b, btree_order(k), false))
903 /* We never free struct btree itself, just the memory that holds the on
904 * disk node. Check the freed list before allocating a new one:
906 list_for_each_entry(b, &c->btree_cache_freed, list)
907 if (!mca_reap(b, 0, false)) {
908 mca_data_alloc(b, k, __GFP_NOWARN|GFP_NOIO);
909 if (!b->keys.set[0].data)
915 b = mca_bucket_alloc(c, k, __GFP_NOWARN|GFP_NOIO);
919 BUG_ON(!down_write_trylock(&b->lock));
920 if (!b->keys.set->data)
923 BUG_ON(b->io_mutex.count != 1);
925 bkey_copy(&b->key, k);
926 list_move(&b->list, &c->btree_cache);
927 hlist_del_init_rcu(&b->hash);
928 hlist_add_head_rcu(&b->hash, mca_hash(c, k));
930 lock_set_subclass(&b->lock.dep_map, level + 1, _THIS_IP_);
931 b->parent = (void *) ~0UL;
937 bch_btree_keys_init(&b->keys, &bch_extent_keys_ops,
938 &b->c->expensive_debug_checks);
940 bch_btree_keys_init(&b->keys, &bch_btree_keys_ops,
941 &b->c->expensive_debug_checks);
948 b = mca_cannibalize(c, op, k);
956 * bch_btree_node_get - find a btree node in the cache and lock it, reading it
957 * in from disk if necessary.
959 * If IO is necessary and running under generic_make_request, returns -EAGAIN.
961 * The btree node will have either a read or a write lock held, depending on
962 * level and op->lock.
964 struct btree *bch_btree_node_get(struct cache_set *c, struct btree_op *op,
965 struct bkey *k, int level, bool write,
966 struct btree *parent)
976 if (current->bio_list)
977 return ERR_PTR(-EAGAIN);
979 mutex_lock(&c->bucket_lock);
980 b = mca_alloc(c, op, k, level);
981 mutex_unlock(&c->bucket_lock);
988 bch_btree_node_read(b);
991 downgrade_write(&b->lock);
993 rw_lock(write, b, level);
994 if (PTR_HASH(c, &b->key) != PTR_HASH(c, k)) {
998 BUG_ON(b->level != level);
1004 for (; i <= b->keys.nsets && b->keys.set[i].size; i++) {
1005 prefetch(b->keys.set[i].tree);
1006 prefetch(b->keys.set[i].data);
1009 for (; i <= b->keys.nsets; i++)
1010 prefetch(b->keys.set[i].data);
1012 if (btree_node_io_error(b)) {
1013 rw_unlock(write, b);
1014 return ERR_PTR(-EIO);
1017 BUG_ON(!b->written);
1022 static void btree_node_prefetch(struct btree *parent, struct bkey *k)
1026 mutex_lock(&parent->c->bucket_lock);
1027 b = mca_alloc(parent->c, NULL, k, parent->level - 1);
1028 mutex_unlock(&parent->c->bucket_lock);
1030 if (!IS_ERR_OR_NULL(b)) {
1032 bch_btree_node_read(b);
1039 static void btree_node_free(struct btree *b)
1041 trace_bcache_btree_node_free(b);
1043 BUG_ON(b == b->c->root);
1045 mutex_lock(&b->write_lock);
1047 if (btree_node_dirty(b))
1048 btree_complete_write(b, btree_current_write(b));
1049 clear_bit(BTREE_NODE_dirty, &b->flags);
1051 mutex_unlock(&b->write_lock);
1053 cancel_delayed_work(&b->work);
1055 mutex_lock(&b->c->bucket_lock);
1056 bch_bucket_free(b->c, &b->key);
1058 mutex_unlock(&b->c->bucket_lock);
1061 struct btree *__bch_btree_node_alloc(struct cache_set *c, struct btree_op *op,
1062 int level, bool wait,
1063 struct btree *parent)
1066 struct btree *b = ERR_PTR(-EAGAIN);
1068 mutex_lock(&c->bucket_lock);
1070 if (__bch_bucket_alloc_set(c, RESERVE_BTREE, &k.key, 1, wait))
1073 bkey_put(c, &k.key);
1074 SET_KEY_SIZE(&k.key, c->btree_pages * PAGE_SECTORS);
1076 b = mca_alloc(c, op, &k.key, level);
1082 "Tried to allocate bucket that was in btree cache");
1088 bch_bset_init_next(&b->keys, b->keys.set->data, bset_magic(&b->c->sb));
1090 mutex_unlock(&c->bucket_lock);
1092 trace_bcache_btree_node_alloc(b);
1095 bch_bucket_free(c, &k.key);
1097 mutex_unlock(&c->bucket_lock);
1099 trace_bcache_btree_node_alloc_fail(c);
1103 static struct btree *bch_btree_node_alloc(struct cache_set *c,
1104 struct btree_op *op, int level,
1105 struct btree *parent)
1107 return __bch_btree_node_alloc(c, op, level, op != NULL, parent);
1110 static struct btree *btree_node_alloc_replacement(struct btree *b,
1111 struct btree_op *op)
1113 struct btree *n = bch_btree_node_alloc(b->c, op, b->level, b->parent);
1114 if (!IS_ERR_OR_NULL(n)) {
1115 mutex_lock(&n->write_lock);
1116 bch_btree_sort_into(&b->keys, &n->keys, &b->c->sort);
1117 bkey_copy_key(&n->key, &b->key);
1118 mutex_unlock(&n->write_lock);
1124 static void make_btree_freeing_key(struct btree *b, struct bkey *k)
1128 mutex_lock(&b->c->bucket_lock);
1130 atomic_inc(&b->c->prio_blocked);
1132 bkey_copy(k, &b->key);
1133 bkey_copy_key(k, &ZERO_KEY);
1135 for (i = 0; i < KEY_PTRS(k); i++)
1137 bch_inc_gen(PTR_CACHE(b->c, &b->key, i),
1138 PTR_BUCKET(b->c, &b->key, i)));
1140 mutex_unlock(&b->c->bucket_lock);
1143 static int btree_check_reserve(struct btree *b, struct btree_op *op)
1145 struct cache_set *c = b->c;
1147 unsigned i, reserve = (c->root->level - b->level) * 2 + 1;
1149 mutex_lock(&c->bucket_lock);
1151 for_each_cache(ca, c, i)
1152 if (fifo_used(&ca->free[RESERVE_BTREE]) < reserve) {
1154 prepare_to_wait(&c->btree_cache_wait, &op->wait,
1155 TASK_UNINTERRUPTIBLE);
1156 mutex_unlock(&c->bucket_lock);
1160 mutex_unlock(&c->bucket_lock);
1162 return mca_cannibalize_lock(b->c, op);
1165 /* Garbage collection */
1167 static uint8_t __bch_btree_mark_key(struct cache_set *c, int level,
1175 * ptr_invalid() can't return true for the keys that mark btree nodes as
1176 * freed, but since ptr_bad() returns true we'll never actually use them
1177 * for anything and thus we don't want mark their pointers here
1179 if (!bkey_cmp(k, &ZERO_KEY))
1182 for (i = 0; i < KEY_PTRS(k); i++) {
1183 if (!ptr_available(c, k, i))
1186 g = PTR_BUCKET(c, k, i);
1188 if (gen_after(g->last_gc, PTR_GEN(k, i)))
1189 g->last_gc = PTR_GEN(k, i);
1191 if (ptr_stale(c, k, i)) {
1192 stale = max(stale, ptr_stale(c, k, i));
1196 cache_bug_on(GC_MARK(g) &&
1197 (GC_MARK(g) == GC_MARK_METADATA) != (level != 0),
1198 c, "inconsistent ptrs: mark = %llu, level = %i",
1202 SET_GC_MARK(g, GC_MARK_METADATA);
1203 else if (KEY_DIRTY(k))
1204 SET_GC_MARK(g, GC_MARK_DIRTY);
1205 else if (!GC_MARK(g))
1206 SET_GC_MARK(g, GC_MARK_RECLAIMABLE);
1208 /* guard against overflow */
1209 SET_GC_SECTORS_USED(g, min_t(unsigned,
1210 GC_SECTORS_USED(g) + KEY_SIZE(k),
1211 MAX_GC_SECTORS_USED));
1213 BUG_ON(!GC_SECTORS_USED(g));
1219 #define btree_mark_key(b, k) __bch_btree_mark_key(b->c, b->level, k)
1221 void bch_initial_mark_key(struct cache_set *c, int level, struct bkey *k)
1225 for (i = 0; i < KEY_PTRS(k); i++)
1226 if (ptr_available(c, k, i) &&
1227 !ptr_stale(c, k, i)) {
1228 struct bucket *b = PTR_BUCKET(c, k, i);
1230 b->gen = PTR_GEN(k, i);
1232 if (level && bkey_cmp(k, &ZERO_KEY))
1233 b->prio = BTREE_PRIO;
1234 else if (!level && b->prio == BTREE_PRIO)
1235 b->prio = INITIAL_PRIO;
1238 __bch_btree_mark_key(c, level, k);
1241 static bool btree_gc_mark_node(struct btree *b, struct gc_stat *gc)
1244 unsigned keys = 0, good_keys = 0;
1246 struct btree_iter iter;
1247 struct bset_tree *t;
1251 for_each_key_filter(&b->keys, k, &iter, bch_ptr_invalid) {
1252 stale = max(stale, btree_mark_key(b, k));
1255 if (bch_ptr_bad(&b->keys, k))
1258 gc->key_bytes += bkey_u64s(k);
1262 gc->data += KEY_SIZE(k);
1265 for (t = b->keys.set; t <= &b->keys.set[b->keys.nsets]; t++)
1266 btree_bug_on(t->size &&
1267 bset_written(&b->keys, t) &&
1268 bkey_cmp(&b->key, &t->end) < 0,
1269 b, "found short btree key in gc");
1271 if (b->c->gc_always_rewrite)
1277 if ((keys - good_keys) * 2 > keys)
1283 #define GC_MERGE_NODES 4U
1285 struct gc_merge_info {
1290 static int bch_btree_insert_node(struct btree *, struct btree_op *,
1291 struct keylist *, atomic_t *, struct bkey *);
1293 static int btree_gc_coalesce(struct btree *b, struct btree_op *op,
1294 struct gc_stat *gc, struct gc_merge_info *r)
1296 unsigned i, nodes = 0, keys = 0, blocks;
1297 struct btree *new_nodes[GC_MERGE_NODES];
1298 struct keylist keylist;
1302 bch_keylist_init(&keylist);
1304 if (btree_check_reserve(b, NULL))
1307 memset(new_nodes, 0, sizeof(new_nodes));
1308 closure_init_stack(&cl);
1310 while (nodes < GC_MERGE_NODES && !IS_ERR_OR_NULL(r[nodes].b))
1311 keys += r[nodes++].keys;
1313 blocks = btree_default_blocks(b->c) * 2 / 3;
1316 __set_blocks(b->keys.set[0].data, keys,
1317 block_bytes(b->c)) > blocks * (nodes - 1))
1320 for (i = 0; i < nodes; i++) {
1321 new_nodes[i] = btree_node_alloc_replacement(r[i].b, NULL);
1322 if (IS_ERR_OR_NULL(new_nodes[i]))
1323 goto out_nocoalesce;
1327 * We have to check the reserve here, after we've allocated our new
1328 * nodes, to make sure the insert below will succeed - we also check
1329 * before as an optimization to potentially avoid a bunch of expensive
1332 if (btree_check_reserve(b, NULL))
1333 goto out_nocoalesce;
1335 for (i = 0; i < nodes; i++)
1336 mutex_lock(&new_nodes[i]->write_lock);
1338 for (i = nodes - 1; i > 0; --i) {
1339 struct bset *n1 = btree_bset_first(new_nodes[i]);
1340 struct bset *n2 = btree_bset_first(new_nodes[i - 1]);
1341 struct bkey *k, *last = NULL;
1347 k < bset_bkey_last(n2);
1349 if (__set_blocks(n1, n1->keys + keys +
1351 block_bytes(b->c)) > blocks)
1355 keys += bkey_u64s(k);
1359 * Last node we're not getting rid of - we're getting
1360 * rid of the node at r[0]. Have to try and fit all of
1361 * the remaining keys into this node; we can't ensure
1362 * they will always fit due to rounding and variable
1363 * length keys (shouldn't be possible in practice,
1366 if (__set_blocks(n1, n1->keys + n2->keys,
1367 block_bytes(b->c)) >
1368 btree_blocks(new_nodes[i]))
1369 goto out_nocoalesce;
1372 /* Take the key of the node we're getting rid of */
1376 BUG_ON(__set_blocks(n1, n1->keys + keys, block_bytes(b->c)) >
1377 btree_blocks(new_nodes[i]));
1380 bkey_copy_key(&new_nodes[i]->key, last);
1382 memcpy(bset_bkey_last(n1),
1384 (void *) bset_bkey_idx(n2, keys) - (void *) n2->start);
1387 r[i].keys = n1->keys;
1390 bset_bkey_idx(n2, keys),
1391 (void *) bset_bkey_last(n2) -
1392 (void *) bset_bkey_idx(n2, keys));
1396 if (__bch_keylist_realloc(&keylist,
1397 bkey_u64s(&new_nodes[i]->key)))
1398 goto out_nocoalesce;
1400 bch_btree_node_write(new_nodes[i], &cl);
1401 bch_keylist_add(&keylist, &new_nodes[i]->key);
1404 for (i = 0; i < nodes; i++)
1405 mutex_unlock(&new_nodes[i]->write_lock);
1409 /* We emptied out this node */
1410 BUG_ON(btree_bset_first(new_nodes[0])->keys);
1411 btree_node_free(new_nodes[0]);
1412 rw_unlock(true, new_nodes[0]);
1413 new_nodes[0] = NULL;
1415 for (i = 0; i < nodes; i++) {
1416 if (__bch_keylist_realloc(&keylist, bkey_u64s(&r[i].b->key)))
1417 goto out_nocoalesce;
1419 make_btree_freeing_key(r[i].b, keylist.top);
1420 bch_keylist_push(&keylist);
1423 bch_btree_insert_node(b, op, &keylist, NULL, NULL);
1424 BUG_ON(!bch_keylist_empty(&keylist));
1426 for (i = 0; i < nodes; i++) {
1427 btree_node_free(r[i].b);
1428 rw_unlock(true, r[i].b);
1430 r[i].b = new_nodes[i];
1433 memmove(r, r + 1, sizeof(r[0]) * (nodes - 1));
1434 r[nodes - 1].b = ERR_PTR(-EINTR);
1436 trace_bcache_btree_gc_coalesce(nodes);
1439 bch_keylist_free(&keylist);
1441 /* Invalidated our iterator */
1446 bch_keylist_free(&keylist);
1448 while ((k = bch_keylist_pop(&keylist)))
1449 if (!bkey_cmp(k, &ZERO_KEY))
1450 atomic_dec(&b->c->prio_blocked);
1452 for (i = 0; i < nodes; i++)
1453 if (!IS_ERR_OR_NULL(new_nodes[i])) {
1454 btree_node_free(new_nodes[i]);
1455 rw_unlock(true, new_nodes[i]);
1460 static int btree_gc_rewrite_node(struct btree *b, struct btree_op *op,
1461 struct btree *replace)
1463 struct keylist keys;
1466 if (btree_check_reserve(b, NULL))
1469 n = btree_node_alloc_replacement(replace, NULL);
1471 /* recheck reserve after allocating replacement node */
1472 if (btree_check_reserve(b, NULL)) {
1478 bch_btree_node_write_sync(n);
1480 bch_keylist_init(&keys);
1481 bch_keylist_add(&keys, &n->key);
1483 make_btree_freeing_key(replace, keys.top);
1484 bch_keylist_push(&keys);
1486 bch_btree_insert_node(b, op, &keys, NULL, NULL);
1487 BUG_ON(!bch_keylist_empty(&keys));
1489 btree_node_free(replace);
1492 /* Invalidated our iterator */
1496 static unsigned btree_gc_count_keys(struct btree *b)
1499 struct btree_iter iter;
1502 for_each_key_filter(&b->keys, k, &iter, bch_ptr_bad)
1503 ret += bkey_u64s(k);
1508 static int btree_gc_recurse(struct btree *b, struct btree_op *op,
1509 struct closure *writes, struct gc_stat *gc)
1512 bool should_rewrite;
1514 struct btree_iter iter;
1515 struct gc_merge_info r[GC_MERGE_NODES];
1516 struct gc_merge_info *i, *last = r + ARRAY_SIZE(r) - 1;
1518 bch_btree_iter_init(&b->keys, &iter, &b->c->gc_done);
1520 for (i = r; i < r + ARRAY_SIZE(r); i++)
1521 i->b = ERR_PTR(-EINTR);
1524 k = bch_btree_iter_next_filter(&iter, &b->keys, bch_ptr_bad);
1526 r->b = bch_btree_node_get(b->c, op, k, b->level - 1,
1529 ret = PTR_ERR(r->b);
1533 r->keys = btree_gc_count_keys(r->b);
1535 ret = btree_gc_coalesce(b, op, gc, r);
1543 if (!IS_ERR(last->b)) {
1544 should_rewrite = btree_gc_mark_node(last->b, gc);
1545 if (should_rewrite) {
1546 ret = btree_gc_rewrite_node(b, op, last->b);
1551 if (last->b->level) {
1552 ret = btree_gc_recurse(last->b, op, writes, gc);
1557 bkey_copy_key(&b->c->gc_done, &last->b->key);
1560 * Must flush leaf nodes before gc ends, since replace
1561 * operations aren't journalled
1563 mutex_lock(&last->b->write_lock);
1564 if (btree_node_dirty(last->b))
1565 bch_btree_node_write(last->b, writes);
1566 mutex_unlock(&last->b->write_lock);
1567 rw_unlock(true, last->b);
1570 memmove(r + 1, r, sizeof(r[0]) * (GC_MERGE_NODES - 1));
1573 if (need_resched()) {
1579 for (i = r; i < r + ARRAY_SIZE(r); i++)
1580 if (!IS_ERR_OR_NULL(i->b)) {
1581 mutex_lock(&i->b->write_lock);
1582 if (btree_node_dirty(i->b))
1583 bch_btree_node_write(i->b, writes);
1584 mutex_unlock(&i->b->write_lock);
1585 rw_unlock(true, i->b);
1591 static int bch_btree_gc_root(struct btree *b, struct btree_op *op,
1592 struct closure *writes, struct gc_stat *gc)
1594 struct btree *n = NULL;
1596 bool should_rewrite;
1598 should_rewrite = btree_gc_mark_node(b, gc);
1599 if (should_rewrite) {
1600 n = btree_node_alloc_replacement(b, NULL);
1602 if (!IS_ERR_OR_NULL(n)) {
1603 bch_btree_node_write_sync(n);
1605 bch_btree_set_root(n);
1613 __bch_btree_mark_key(b->c, b->level + 1, &b->key);
1616 ret = btree_gc_recurse(b, op, writes, gc);
1621 bkey_copy_key(&b->c->gc_done, &b->key);
1626 static void btree_gc_start(struct cache_set *c)
1632 if (!c->gc_mark_valid)
1635 mutex_lock(&c->bucket_lock);
1637 c->gc_mark_valid = 0;
1638 c->gc_done = ZERO_KEY;
1640 for_each_cache(ca, c, i)
1641 for_each_bucket(b, ca) {
1642 b->last_gc = b->gen;
1643 if (!atomic_read(&b->pin)) {
1645 SET_GC_SECTORS_USED(b, 0);
1649 mutex_unlock(&c->bucket_lock);
1652 static size_t bch_btree_gc_finish(struct cache_set *c)
1654 size_t available = 0;
1659 mutex_lock(&c->bucket_lock);
1662 c->gc_mark_valid = 1;
1665 for (i = 0; i < KEY_PTRS(&c->uuid_bucket); i++)
1666 SET_GC_MARK(PTR_BUCKET(c, &c->uuid_bucket, i),
1669 /* don't reclaim buckets to which writeback keys point */
1671 for (i = 0; i < c->nr_uuids; i++) {
1672 struct bcache_device *d = c->devices[i];
1673 struct cached_dev *dc;
1674 struct keybuf_key *w, *n;
1677 if (!d || UUID_FLASH_ONLY(&c->uuids[i]))
1679 dc = container_of(d, struct cached_dev, disk);
1681 spin_lock(&dc->writeback_keys.lock);
1682 rbtree_postorder_for_each_entry_safe(w, n,
1683 &dc->writeback_keys.keys, node)
1684 for (j = 0; j < KEY_PTRS(&w->key); j++)
1685 SET_GC_MARK(PTR_BUCKET(c, &w->key, j),
1687 spin_unlock(&dc->writeback_keys.lock);
1691 for_each_cache(ca, c, i) {
1694 ca->invalidate_needs_gc = 0;
1696 for (i = ca->sb.d; i < ca->sb.d + ca->sb.keys; i++)
1697 SET_GC_MARK(ca->buckets + *i, GC_MARK_METADATA);
1699 for (i = ca->prio_buckets;
1700 i < ca->prio_buckets + prio_buckets(ca) * 2; i++)
1701 SET_GC_MARK(ca->buckets + *i, GC_MARK_METADATA);
1703 for_each_bucket(b, ca) {
1704 c->need_gc = max(c->need_gc, bucket_gc_gen(b));
1706 if (atomic_read(&b->pin))
1709 BUG_ON(!GC_MARK(b) && GC_SECTORS_USED(b));
1711 if (!GC_MARK(b) || GC_MARK(b) == GC_MARK_RECLAIMABLE)
1716 mutex_unlock(&c->bucket_lock);
1720 static void bch_btree_gc(struct cache_set *c)
1723 unsigned long available;
1724 struct gc_stat stats;
1725 struct closure writes;
1727 uint64_t start_time = local_clock();
1729 trace_bcache_gc_start(c);
1731 memset(&stats, 0, sizeof(struct gc_stat));
1732 closure_init_stack(&writes);
1733 bch_btree_op_init(&op, SHRT_MAX);
1738 ret = btree_root(gc_root, c, &op, &writes, &stats);
1739 closure_sync(&writes);
1742 if (ret && ret != -EAGAIN)
1743 pr_warn("gc failed!");
1746 available = bch_btree_gc_finish(c);
1747 wake_up_allocators(c);
1749 bch_time_stats_update(&c->btree_gc_time, start_time);
1751 stats.key_bytes *= sizeof(uint64_t);
1753 stats.in_use = (c->nbuckets - available) * 100 / c->nbuckets;
1754 memcpy(&c->gc_stats, &stats, sizeof(struct gc_stat));
1756 trace_bcache_gc_end(c);
1761 static bool gc_should_run(struct cache_set *c)
1766 for_each_cache(ca, c, i)
1767 if (ca->invalidate_needs_gc)
1770 if (atomic_read(&c->sectors_to_gc) < 0)
1776 static int bch_gc_thread(void *arg)
1778 struct cache_set *c = arg;
1781 wait_event_interruptible(c->gc_wait,
1782 kthread_should_stop() || gc_should_run(c));
1784 if (kthread_should_stop())
1794 int bch_gc_thread_start(struct cache_set *c)
1796 c->gc_thread = kthread_run(bch_gc_thread, c, "bcache_gc");
1797 if (IS_ERR(c->gc_thread))
1798 return PTR_ERR(c->gc_thread);
1803 /* Initial partial gc */
1805 static int bch_btree_check_recurse(struct btree *b, struct btree_op *op)
1808 struct bkey *k, *p = NULL;
1809 struct btree_iter iter;
1811 for_each_key_filter(&b->keys, k, &iter, bch_ptr_invalid)
1812 bch_initial_mark_key(b->c, b->level, k);
1814 bch_initial_mark_key(b->c, b->level + 1, &b->key);
1817 bch_btree_iter_init(&b->keys, &iter, NULL);
1820 k = bch_btree_iter_next_filter(&iter, &b->keys,
1823 btree_node_prefetch(b, k);
1826 ret = btree(check_recurse, p, b, op);
1829 } while (p && !ret);
1835 int bch_btree_check(struct cache_set *c)
1839 bch_btree_op_init(&op, SHRT_MAX);
1841 return btree_root(check_recurse, c, &op);
1844 void bch_initial_gc_finish(struct cache_set *c)
1850 bch_btree_gc_finish(c);
1852 mutex_lock(&c->bucket_lock);
1855 * We need to put some unused buckets directly on the prio freelist in
1856 * order to get the allocator thread started - it needs freed buckets in
1857 * order to rewrite the prios and gens, and it needs to rewrite prios
1858 * and gens in order to free buckets.
1860 * This is only safe for buckets that have no live data in them, which
1861 * there should always be some of.
1863 for_each_cache(ca, c, i) {
1864 for_each_bucket(b, ca) {
1865 if (fifo_full(&ca->free[RESERVE_PRIO]))
1868 if (bch_can_invalidate_bucket(ca, b) &&
1870 __bch_invalidate_one_bucket(ca, b);
1871 fifo_push(&ca->free[RESERVE_PRIO],
1877 mutex_unlock(&c->bucket_lock);
1880 /* Btree insertion */
1882 static bool btree_insert_key(struct btree *b, struct bkey *k,
1883 struct bkey *replace_key)
1887 BUG_ON(bkey_cmp(k, &b->key) > 0);
1889 status = bch_btree_insert_key(&b->keys, k, replace_key);
1890 if (status != BTREE_INSERT_STATUS_NO_INSERT) {
1891 bch_check_keys(&b->keys, "%u for %s", status,
1892 replace_key ? "replace" : "insert");
1894 trace_bcache_btree_insert_key(b, k, replace_key != NULL,
1901 static size_t insert_u64s_remaining(struct btree *b)
1903 long ret = bch_btree_keys_u64s_remaining(&b->keys);
1906 * Might land in the middle of an existing extent and have to split it
1908 if (b->keys.ops->is_extents)
1909 ret -= KEY_MAX_U64S;
1911 return max(ret, 0L);
1914 static bool bch_btree_insert_keys(struct btree *b, struct btree_op *op,
1915 struct keylist *insert_keys,
1916 struct bkey *replace_key)
1919 int oldsize = bch_count_data(&b->keys);
1921 while (!bch_keylist_empty(insert_keys)) {
1922 struct bkey *k = insert_keys->keys;
1924 if (bkey_u64s(k) > insert_u64s_remaining(b))
1927 if (bkey_cmp(k, &b->key) <= 0) {
1931 ret |= btree_insert_key(b, k, replace_key);
1932 bch_keylist_pop_front(insert_keys);
1933 } else if (bkey_cmp(&START_KEY(k), &b->key) < 0) {
1934 BKEY_PADDED(key) temp;
1935 bkey_copy(&temp.key, insert_keys->keys);
1937 bch_cut_back(&b->key, &temp.key);
1938 bch_cut_front(&b->key, insert_keys->keys);
1940 ret |= btree_insert_key(b, &temp.key, replace_key);
1948 op->insert_collision = true;
1950 BUG_ON(!bch_keylist_empty(insert_keys) && b->level);
1952 BUG_ON(bch_count_data(&b->keys) < oldsize);
1956 static int btree_split(struct btree *b, struct btree_op *op,
1957 struct keylist *insert_keys,
1958 struct bkey *replace_key)
1961 struct btree *n1, *n2 = NULL, *n3 = NULL;
1962 uint64_t start_time = local_clock();
1964 struct keylist parent_keys;
1966 closure_init_stack(&cl);
1967 bch_keylist_init(&parent_keys);
1969 if (btree_check_reserve(b, op)) {
1973 WARN(1, "insufficient reserve for split\n");
1976 n1 = btree_node_alloc_replacement(b, op);
1980 split = set_blocks(btree_bset_first(n1),
1981 block_bytes(n1->c)) > (btree_blocks(b) * 4) / 5;
1986 trace_bcache_btree_node_split(b, btree_bset_first(n1)->keys);
1988 n2 = bch_btree_node_alloc(b->c, op, b->level, b->parent);
1993 n3 = bch_btree_node_alloc(b->c, op, b->level + 1, NULL);
1998 mutex_lock(&n1->write_lock);
1999 mutex_lock(&n2->write_lock);
2001 bch_btree_insert_keys(n1, op, insert_keys, replace_key);
2004 * Has to be a linear search because we don't have an auxiliary
2008 while (keys < (btree_bset_first(n1)->keys * 3) / 5)
2009 keys += bkey_u64s(bset_bkey_idx(btree_bset_first(n1),
2012 bkey_copy_key(&n1->key,
2013 bset_bkey_idx(btree_bset_first(n1), keys));
2014 keys += bkey_u64s(bset_bkey_idx(btree_bset_first(n1), keys));
2016 btree_bset_first(n2)->keys = btree_bset_first(n1)->keys - keys;
2017 btree_bset_first(n1)->keys = keys;
2019 memcpy(btree_bset_first(n2)->start,
2020 bset_bkey_last(btree_bset_first(n1)),
2021 btree_bset_first(n2)->keys * sizeof(uint64_t));
2023 bkey_copy_key(&n2->key, &b->key);
2025 bch_keylist_add(&parent_keys, &n2->key);
2026 bch_btree_node_write(n2, &cl);
2027 mutex_unlock(&n2->write_lock);
2028 rw_unlock(true, n2);
2030 trace_bcache_btree_node_compact(b, btree_bset_first(n1)->keys);
2032 mutex_lock(&n1->write_lock);
2033 bch_btree_insert_keys(n1, op, insert_keys, replace_key);
2036 bch_keylist_add(&parent_keys, &n1->key);
2037 bch_btree_node_write(n1, &cl);
2038 mutex_unlock(&n1->write_lock);
2041 /* Depth increases, make a new root */
2042 mutex_lock(&n3->write_lock);
2043 bkey_copy_key(&n3->key, &MAX_KEY);
2044 bch_btree_insert_keys(n3, op, &parent_keys, NULL);
2045 bch_btree_node_write(n3, &cl);
2046 mutex_unlock(&n3->write_lock);
2049 bch_btree_set_root(n3);
2050 rw_unlock(true, n3);
2051 } else if (!b->parent) {
2052 /* Root filled up but didn't need to be split */
2054 bch_btree_set_root(n1);
2056 /* Split a non root node */
2058 make_btree_freeing_key(b, parent_keys.top);
2059 bch_keylist_push(&parent_keys);
2061 bch_btree_insert_node(b->parent, op, &parent_keys, NULL, NULL);
2062 BUG_ON(!bch_keylist_empty(&parent_keys));
2066 rw_unlock(true, n1);
2068 bch_time_stats_update(&b->c->btree_split_time, start_time);
2072 bkey_put(b->c, &n2->key);
2073 btree_node_free(n2);
2074 rw_unlock(true, n2);
2076 bkey_put(b->c, &n1->key);
2077 btree_node_free(n1);
2078 rw_unlock(true, n1);
2080 WARN(1, "bcache: btree split failed (level %u)", b->level);
2082 if (n3 == ERR_PTR(-EAGAIN) ||
2083 n2 == ERR_PTR(-EAGAIN) ||
2084 n1 == ERR_PTR(-EAGAIN))
2090 static int bch_btree_insert_node(struct btree *b, struct btree_op *op,
2091 struct keylist *insert_keys,
2092 atomic_t *journal_ref,
2093 struct bkey *replace_key)
2097 BUG_ON(b->level && replace_key);
2099 closure_init_stack(&cl);
2101 mutex_lock(&b->write_lock);
2103 if (write_block(b) != btree_bset_last(b) &&
2104 b->keys.last_set_unwritten)
2105 bch_btree_init_next(b); /* just wrote a set */
2107 if (bch_keylist_nkeys(insert_keys) > insert_u64s_remaining(b)) {
2108 mutex_unlock(&b->write_lock);
2112 BUG_ON(write_block(b) != btree_bset_last(b));
2114 if (bch_btree_insert_keys(b, op, insert_keys, replace_key)) {
2116 bch_btree_leaf_dirty(b, journal_ref);
2118 bch_btree_node_write(b, &cl);
2121 mutex_unlock(&b->write_lock);
2123 /* wait for btree node write if necessary, after unlock */
2128 if (current->bio_list) {
2129 op->lock = b->c->root->level + 1;
2131 } else if (op->lock <= b->c->root->level) {
2132 op->lock = b->c->root->level + 1;
2135 /* Invalidated all iterators */
2136 int ret = btree_split(b, op, insert_keys, replace_key);
2138 if (bch_keylist_empty(insert_keys))
2146 int bch_btree_insert_check_key(struct btree *b, struct btree_op *op,
2147 struct bkey *check_key)
2150 uint64_t btree_ptr = b->key.ptr[0];
2151 unsigned long seq = b->seq;
2152 struct keylist insert;
2153 bool upgrade = op->lock == -1;
2155 bch_keylist_init(&insert);
2158 rw_unlock(false, b);
2159 rw_lock(true, b, b->level);
2161 if (b->key.ptr[0] != btree_ptr ||
2162 b->seq != seq + 1) {
2163 op->lock = b->level;
2168 SET_KEY_PTRS(check_key, 1);
2169 get_random_bytes(&check_key->ptr[0], sizeof(uint64_t));
2171 SET_PTR_DEV(check_key, 0, PTR_CHECK_DEV);
2173 bch_keylist_add(&insert, check_key);
2175 ret = bch_btree_insert_node(b, op, &insert, NULL, NULL);
2177 BUG_ON(!ret && !bch_keylist_empty(&insert));
2180 downgrade_write(&b->lock);
2184 struct btree_insert_op {
2186 struct keylist *keys;
2187 atomic_t *journal_ref;
2188 struct bkey *replace_key;
2191 static int btree_insert_fn(struct btree_op *b_op, struct btree *b)
2193 struct btree_insert_op *op = container_of(b_op,
2194 struct btree_insert_op, op);
2196 int ret = bch_btree_insert_node(b, &op->op, op->keys,
2197 op->journal_ref, op->replace_key);
2198 if (ret && !bch_keylist_empty(op->keys))
2204 int bch_btree_insert(struct cache_set *c, struct keylist *keys,
2205 atomic_t *journal_ref, struct bkey *replace_key)
2207 struct btree_insert_op op;
2210 BUG_ON(current->bio_list);
2211 BUG_ON(bch_keylist_empty(keys));
2213 bch_btree_op_init(&op.op, 0);
2215 op.journal_ref = journal_ref;
2216 op.replace_key = replace_key;
2218 while (!ret && !bch_keylist_empty(keys)) {
2220 ret = bch_btree_map_leaf_nodes(&op.op, c,
2221 &START_KEY(keys->keys),
2228 pr_err("error %i", ret);
2230 while ((k = bch_keylist_pop(keys)))
2232 } else if (op.op.insert_collision)
2238 void bch_btree_set_root(struct btree *b)
2243 closure_init_stack(&cl);
2245 trace_bcache_btree_set_root(b);
2247 BUG_ON(!b->written);
2249 for (i = 0; i < KEY_PTRS(&b->key); i++)
2250 BUG_ON(PTR_BUCKET(b->c, &b->key, i)->prio != BTREE_PRIO);
2252 mutex_lock(&b->c->bucket_lock);
2253 list_del_init(&b->list);
2254 mutex_unlock(&b->c->bucket_lock);
2258 bch_journal_meta(b->c, &cl);
2262 /* Map across nodes or keys */
2264 static int bch_btree_map_nodes_recurse(struct btree *b, struct btree_op *op,
2266 btree_map_nodes_fn *fn, int flags)
2268 int ret = MAP_CONTINUE;
2272 struct btree_iter iter;
2274 bch_btree_iter_init(&b->keys, &iter, from);
2276 while ((k = bch_btree_iter_next_filter(&iter, &b->keys,
2278 ret = btree(map_nodes_recurse, k, b,
2279 op, from, fn, flags);
2282 if (ret != MAP_CONTINUE)
2287 if (!b->level || flags == MAP_ALL_NODES)
2293 int __bch_btree_map_nodes(struct btree_op *op, struct cache_set *c,
2294 struct bkey *from, btree_map_nodes_fn *fn, int flags)
2296 return btree_root(map_nodes_recurse, c, op, from, fn, flags);
2299 static int bch_btree_map_keys_recurse(struct btree *b, struct btree_op *op,
2300 struct bkey *from, btree_map_keys_fn *fn,
2303 int ret = MAP_CONTINUE;
2305 struct btree_iter iter;
2307 bch_btree_iter_init(&b->keys, &iter, from);
2309 while ((k = bch_btree_iter_next_filter(&iter, &b->keys, bch_ptr_bad))) {
2312 : btree(map_keys_recurse, k, b, op, from, fn, flags);
2315 if (ret != MAP_CONTINUE)
2319 if (!b->level && (flags & MAP_END_KEY))
2320 ret = fn(op, b, &KEY(KEY_INODE(&b->key),
2321 KEY_OFFSET(&b->key), 0));
2326 int bch_btree_map_keys(struct btree_op *op, struct cache_set *c,
2327 struct bkey *from, btree_map_keys_fn *fn, int flags)
2329 return btree_root(map_keys_recurse, c, op, from, fn, flags);
2334 static inline int keybuf_cmp(struct keybuf_key *l, struct keybuf_key *r)
2336 /* Overlapping keys compare equal */
2337 if (bkey_cmp(&l->key, &START_KEY(&r->key)) <= 0)
2339 if (bkey_cmp(&START_KEY(&l->key), &r->key) >= 0)
2344 static inline int keybuf_nonoverlapping_cmp(struct keybuf_key *l,
2345 struct keybuf_key *r)
2347 return clamp_t(int64_t, bkey_cmp(&l->key, &r->key), -1, 1);
2355 keybuf_pred_fn *pred;
2358 static int refill_keybuf_fn(struct btree_op *op, struct btree *b,
2361 struct refill *refill = container_of(op, struct refill, op);
2362 struct keybuf *buf = refill->buf;
2363 int ret = MAP_CONTINUE;
2365 if (bkey_cmp(k, refill->end) >= 0) {
2370 if (!KEY_SIZE(k)) /* end key */
2373 if (refill->pred(buf, k)) {
2374 struct keybuf_key *w;
2376 spin_lock(&buf->lock);
2378 w = array_alloc(&buf->freelist);
2380 spin_unlock(&buf->lock);
2385 bkey_copy(&w->key, k);
2387 if (RB_INSERT(&buf->keys, w, node, keybuf_cmp))
2388 array_free(&buf->freelist, w);
2392 if (array_freelist_empty(&buf->freelist))
2395 spin_unlock(&buf->lock);
2398 buf->last_scanned = *k;
2402 void bch_refill_keybuf(struct cache_set *c, struct keybuf *buf,
2403 struct bkey *end, keybuf_pred_fn *pred)
2405 struct bkey start = buf->last_scanned;
2406 struct refill refill;
2410 bch_btree_op_init(&refill.op, -1);
2411 refill.nr_found = 0;
2416 bch_btree_map_keys(&refill.op, c, &buf->last_scanned,
2417 refill_keybuf_fn, MAP_END_KEY);
2419 trace_bcache_keyscan(refill.nr_found,
2420 KEY_INODE(&start), KEY_OFFSET(&start),
2421 KEY_INODE(&buf->last_scanned),
2422 KEY_OFFSET(&buf->last_scanned));
2424 spin_lock(&buf->lock);
2426 if (!RB_EMPTY_ROOT(&buf->keys)) {
2427 struct keybuf_key *w;
2428 w = RB_FIRST(&buf->keys, struct keybuf_key, node);
2429 buf->start = START_KEY(&w->key);
2431 w = RB_LAST(&buf->keys, struct keybuf_key, node);
2434 buf->start = MAX_KEY;
2438 spin_unlock(&buf->lock);
2441 static void __bch_keybuf_del(struct keybuf *buf, struct keybuf_key *w)
2443 rb_erase(&w->node, &buf->keys);
2444 array_free(&buf->freelist, w);
2447 void bch_keybuf_del(struct keybuf *buf, struct keybuf_key *w)
2449 spin_lock(&buf->lock);
2450 __bch_keybuf_del(buf, w);
2451 spin_unlock(&buf->lock);
2454 bool bch_keybuf_check_overlapping(struct keybuf *buf, struct bkey *start,
2458 struct keybuf_key *p, *w, s;
2461 if (bkey_cmp(end, &buf->start) <= 0 ||
2462 bkey_cmp(start, &buf->end) >= 0)
2465 spin_lock(&buf->lock);
2466 w = RB_GREATER(&buf->keys, s, node, keybuf_nonoverlapping_cmp);
2468 while (w && bkey_cmp(&START_KEY(&w->key), end) < 0) {
2470 w = RB_NEXT(w, node);
2475 __bch_keybuf_del(buf, p);
2478 spin_unlock(&buf->lock);
2482 struct keybuf_key *bch_keybuf_next(struct keybuf *buf)
2484 struct keybuf_key *w;
2485 spin_lock(&buf->lock);
2487 w = RB_FIRST(&buf->keys, struct keybuf_key, node);
2489 while (w && w->private)
2490 w = RB_NEXT(w, node);
2493 w->private = ERR_PTR(-EINTR);
2495 spin_unlock(&buf->lock);
2499 struct keybuf_key *bch_keybuf_next_rescan(struct cache_set *c,
2502 keybuf_pred_fn *pred)
2504 struct keybuf_key *ret;
2507 ret = bch_keybuf_next(buf);
2511 if (bkey_cmp(&buf->last_scanned, end) >= 0) {
2512 pr_debug("scan finished");
2516 bch_refill_keybuf(c, buf, end, pred);
2522 void bch_keybuf_init(struct keybuf *buf)
2524 buf->last_scanned = MAX_KEY;
2525 buf->keys = RB_ROOT;
2527 spin_lock_init(&buf->lock);
2528 array_allocator_init(&buf->freelist);