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/freezer.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 <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 static struct workqueue_struct *btree_io_wq;
98 #define insert_lock(s, b) ((b)->level <= (s)->lock)
101 * These macros are for recursing down the btree - they handle the details of
102 * locking and looking up nodes in the cache for you. They're best treated as
103 * mere syntax when reading code that uses them.
105 * op->lock determines whether we take a read or a write lock at a given depth.
106 * If you've got a read lock and find that you need a write lock (i.e. you're
107 * going to have to split), set op->lock and return -EINTR; btree_root() will
108 * call you again and you'll have the correct lock.
112 * btree - recurse down the btree on a specified key
113 * @fn: function to call, which will be passed the child node
114 * @key: key to recurse on
115 * @b: parent btree node
116 * @op: pointer to struct btree_op
118 #define btree(fn, key, b, op, ...) \
120 int _r, l = (b)->level - 1; \
121 bool _w = l <= (op)->lock; \
122 struct btree *_child = bch_btree_node_get((b)->c, key, l, _w); \
123 if (!IS_ERR(_child)) { \
124 _child->parent = (b); \
125 _r = bch_btree_ ## fn(_child, op, ##__VA_ARGS__); \
126 rw_unlock(_w, _child); \
128 _r = PTR_ERR(_child); \
133 * btree_root - call a function on the root of the btree
134 * @fn: function to call, which will be passed the child node
136 * @op: pointer to struct btree_op
138 #define btree_root(fn, c, op, ...) \
142 struct btree *_b = (c)->root; \
143 bool _w = insert_lock(op, _b); \
144 rw_lock(_w, _b, _b->level); \
145 if (_b == (c)->root && \
146 _w == insert_lock(op, _b)) { \
148 _r = bch_btree_ ## fn(_b, op, ##__VA_ARGS__); \
153 bch_cannibalize_unlock(c); \
154 if (_r == -ENOSPC) { \
155 wait_event((c)->try_wait, \
159 } while (_r == -EINTR); \
161 finish_wait(&(c)->bucket_wait, &(op)->wait); \
165 static inline struct bset *write_block(struct btree *b)
167 return ((void *) btree_bset_first(b)) + b->written * block_bytes(b->c);
170 static void bch_btree_init_next(struct btree *b)
172 /* If not a leaf node, always sort */
173 if (b->level && b->keys.nsets)
174 bch_btree_sort(&b->keys, &b->c->sort);
176 bch_btree_sort_lazy(&b->keys, &b->c->sort);
178 if (b->written < btree_blocks(b))
179 bch_bset_init_next(&b->keys, write_block(b),
180 bset_magic(&b->c->sb));
184 /* Btree key manipulation */
186 void bkey_put(struct cache_set *c, struct bkey *k)
190 for (i = 0; i < KEY_PTRS(k); i++)
191 if (ptr_available(c, k, i))
192 atomic_dec_bug(&PTR_BUCKET(c, k, i)->pin);
197 static uint64_t btree_csum_set(struct btree *b, struct bset *i)
199 uint64_t crc = b->key.ptr[0];
200 void *data = (void *) i + 8, *end = bset_bkey_last(i);
202 crc = bch_crc64_update(crc, data, end - data);
203 return crc ^ 0xffffffffffffffffULL;
206 void bch_btree_node_read_done(struct btree *b)
208 const char *err = "bad btree header";
209 struct bset *i = btree_bset_first(b);
210 struct btree_iter *iter;
212 iter = mempool_alloc(b->c->fill_iter, GFP_NOWAIT);
213 iter->size = b->c->sb.bucket_size / b->c->sb.block_size;
216 #ifdef CONFIG_BCACHE_DEBUG
224 b->written < btree_blocks(b) && i->seq == b->keys.set[0].data->seq;
225 i = write_block(b)) {
226 err = "unsupported bset version";
227 if (i->version > BCACHE_BSET_VERSION)
230 err = "bad btree header";
231 if (b->written + set_blocks(i, block_bytes(b->c)) >
236 if (i->magic != bset_magic(&b->c->sb))
239 err = "bad checksum";
240 switch (i->version) {
242 if (i->csum != csum_set(i))
245 case BCACHE_BSET_VERSION:
246 if (i->csum != btree_csum_set(b, i))
252 if (i != b->keys.set[0].data && !i->keys)
255 bch_btree_iter_push(iter, i->start, bset_bkey_last(i));
257 b->written += set_blocks(i, block_bytes(b->c));
260 err = "corrupted btree";
261 for (i = write_block(b);
262 bset_sector_offset(&b->keys, i) < KEY_SIZE(&b->key);
263 i = ((void *) i) + block_bytes(b->c))
264 if (i->seq == b->keys.set[0].data->seq)
267 bch_btree_sort_and_fix_extents(&b->keys, iter, &b->c->sort);
269 i = b->keys.set[0].data;
270 err = "short btree key";
271 if (b->keys.set[0].size &&
272 bkey_cmp(&b->key, &b->keys.set[0].end) < 0)
275 if (b->written < btree_blocks(b))
276 bch_bset_init_next(&b->keys, write_block(b),
277 bset_magic(&b->c->sb));
279 mempool_free(iter, b->c->fill_iter);
282 set_btree_node_io_error(b);
283 bch_cache_set_error(b->c, "%s at bucket %zu, block %u, %u keys",
284 err, PTR_BUCKET_NR(b->c, &b->key, 0),
285 bset_block_offset(b, i), i->keys);
289 static void btree_node_read_endio(struct bio *bio, int error)
291 struct closure *cl = bio->bi_private;
295 static void bch_btree_node_read(struct btree *b)
297 uint64_t start_time = local_clock();
301 trace_bcache_btree_read(b);
303 closure_init_stack(&cl);
305 bio = bch_bbio_alloc(b->c);
306 bio->bi_rw = REQ_META|READ_SYNC;
307 bio->bi_iter.bi_size = KEY_SIZE(&b->key) << 9;
308 bio->bi_end_io = btree_node_read_endio;
309 bio->bi_private = &cl;
311 bch_bio_map(bio, b->keys.set[0].data);
313 bch_submit_bbio(bio, b->c, &b->key, 0);
316 if (!test_bit(BIO_UPTODATE, &bio->bi_flags))
317 set_btree_node_io_error(b);
319 bch_bbio_free(bio, b->c);
321 if (btree_node_io_error(b))
324 bch_btree_node_read_done(b);
325 bch_time_stats_update(&b->c->btree_read_time, start_time);
329 bch_cache_set_error(b->c, "io error reading bucket %zu",
330 PTR_BUCKET_NR(b->c, &b->key, 0));
333 static void btree_complete_write(struct btree *b, struct btree_write *w)
335 if (w->prio_blocked &&
336 !atomic_sub_return(w->prio_blocked, &b->c->prio_blocked))
337 wake_up_allocators(b->c);
340 atomic_dec_bug(w->journal);
341 __closure_wake_up(&b->c->journal.wait);
348 static void btree_node_write_unlock(struct closure *cl)
350 struct btree *b = container_of(cl, struct btree, io);
355 static void __btree_node_write_done(struct closure *cl)
357 struct btree *b = container_of(cl, struct btree, io);
358 struct btree_write *w = btree_prev_write(b);
360 bch_bbio_free(b->bio, b->c);
362 btree_complete_write(b, w);
364 if (btree_node_dirty(b))
365 queue_delayed_work(btree_io_wq, &b->work,
366 msecs_to_jiffies(30000));
368 closure_return_with_destructor(cl, btree_node_write_unlock);
371 static void btree_node_write_done(struct closure *cl)
373 struct btree *b = container_of(cl, struct btree, io);
377 bio_for_each_segment_all(bv, b->bio, n)
378 __free_page(bv->bv_page);
380 __btree_node_write_done(cl);
383 static void btree_node_write_endio(struct bio *bio, int error)
385 struct closure *cl = bio->bi_private;
386 struct btree *b = container_of(cl, struct btree, io);
389 set_btree_node_io_error(b);
391 bch_bbio_count_io_errors(b->c, bio, error, "writing btree");
395 static void do_btree_node_write(struct btree *b)
397 struct closure *cl = &b->io;
398 struct bset *i = btree_bset_last(b);
401 i->version = BCACHE_BSET_VERSION;
402 i->csum = btree_csum_set(b, i);
405 b->bio = bch_bbio_alloc(b->c);
407 b->bio->bi_end_io = btree_node_write_endio;
408 b->bio->bi_private = cl;
409 b->bio->bi_rw = REQ_META|WRITE_SYNC|REQ_FUA;
410 b->bio->bi_iter.bi_size = roundup(set_bytes(i), block_bytes(b->c));
411 bch_bio_map(b->bio, i);
414 * If we're appending to a leaf node, we don't technically need FUA -
415 * this write just needs to be persisted before the next journal write,
416 * which will be marked FLUSH|FUA.
418 * Similarly if we're writing a new btree root - the pointer is going to
419 * be in the next journal entry.
421 * But if we're writing a new btree node (that isn't a root) or
422 * appending to a non leaf btree node, we need either FUA or a flush
423 * when we write the parent with the new pointer. FUA is cheaper than a
424 * flush, and writes appending to leaf nodes aren't blocking anything so
425 * just make all btree node writes FUA to keep things sane.
428 bkey_copy(&k.key, &b->key);
429 SET_PTR_OFFSET(&k.key, 0, PTR_OFFSET(&k.key, 0) +
430 bset_sector_offset(&b->keys, i));
432 if (!bio_alloc_pages(b->bio, GFP_NOIO)) {
435 void *base = (void *) ((unsigned long) i & ~(PAGE_SIZE - 1));
437 bio_for_each_segment_all(bv, b->bio, j)
438 memcpy(page_address(bv->bv_page),
439 base + j * PAGE_SIZE, PAGE_SIZE);
441 bch_submit_bbio(b->bio, b->c, &k.key, 0);
443 continue_at(cl, btree_node_write_done, NULL);
446 bch_bio_map(b->bio, i);
448 bch_submit_bbio(b->bio, b->c, &k.key, 0);
451 continue_at_nobarrier(cl, __btree_node_write_done, NULL);
455 void __bch_btree_node_write(struct btree *b, struct closure *parent)
457 struct bset *i = btree_bset_last(b);
459 lockdep_assert_held(&b->write_lock);
461 trace_bcache_btree_write(b);
463 BUG_ON(current->bio_list);
464 BUG_ON(b->written >= btree_blocks(b));
465 BUG_ON(b->written && !i->keys);
466 BUG_ON(btree_bset_first(b)->seq != i->seq);
467 bch_check_keys(&b->keys, "writing");
469 cancel_delayed_work(&b->work);
471 /* If caller isn't waiting for write, parent refcount is cache set */
473 closure_init(&b->io, parent ?: &b->c->cl);
475 clear_bit(BTREE_NODE_dirty, &b->flags);
476 change_bit(BTREE_NODE_write_idx, &b->flags);
478 do_btree_node_write(b);
480 atomic_long_add(set_blocks(i, block_bytes(b->c)) * b->c->sb.block_size,
481 &PTR_CACHE(b->c, &b->key, 0)->btree_sectors_written);
483 b->written += set_blocks(i, block_bytes(b->c));
486 void bch_btree_node_write(struct btree *b, struct closure *parent)
488 unsigned nsets = b->keys.nsets;
490 lockdep_assert_held(&b->lock);
492 __bch_btree_node_write(b, parent);
495 * do verify if there was more than one set initially (i.e. we did a
496 * sort) and we sorted down to a single set:
498 if (nsets && !b->keys.nsets)
501 bch_btree_init_next(b);
504 static void bch_btree_node_write_sync(struct btree *b)
508 closure_init_stack(&cl);
510 mutex_lock(&b->write_lock);
511 bch_btree_node_write(b, &cl);
512 mutex_unlock(&b->write_lock);
517 static void btree_node_write_work(struct work_struct *w)
519 struct btree *b = container_of(to_delayed_work(w), struct btree, work);
521 mutex_lock(&b->write_lock);
522 if (btree_node_dirty(b))
523 __bch_btree_node_write(b, NULL);
524 mutex_unlock(&b->write_lock);
527 static void bch_btree_leaf_dirty(struct btree *b, atomic_t *journal_ref)
529 struct bset *i = btree_bset_last(b);
530 struct btree_write *w = btree_current_write(b);
532 lockdep_assert_held(&b->write_lock);
537 if (!btree_node_dirty(b))
538 queue_delayed_work(btree_io_wq, &b->work, 30 * HZ);
540 set_btree_node_dirty(b);
544 journal_pin_cmp(b->c, w->journal, journal_ref)) {
545 atomic_dec_bug(w->journal);
550 w->journal = journal_ref;
551 atomic_inc(w->journal);
555 /* Force write if set is too big */
556 if (set_bytes(i) > PAGE_SIZE - 48 &&
558 bch_btree_node_write(b, NULL);
562 * Btree in memory cache - allocation/freeing
563 * mca -> memory cache
566 #define mca_reserve(c) (((c->root && c->root->level) \
567 ? c->root->level : 1) * 8 + 16)
568 #define mca_can_free(c) \
569 max_t(int, 0, c->bucket_cache_used - mca_reserve(c))
571 static void mca_data_free(struct btree *b)
573 BUG_ON(b->io_mutex.count != 1);
575 bch_btree_keys_free(&b->keys);
577 b->c->bucket_cache_used--;
578 list_move(&b->list, &b->c->btree_cache_freed);
581 static void mca_bucket_free(struct btree *b)
583 BUG_ON(btree_node_dirty(b));
586 hlist_del_init_rcu(&b->hash);
587 list_move(&b->list, &b->c->btree_cache_freeable);
590 static unsigned btree_order(struct bkey *k)
592 return ilog2(KEY_SIZE(k) / PAGE_SECTORS ?: 1);
595 static void mca_data_alloc(struct btree *b, struct bkey *k, gfp_t gfp)
597 if (!bch_btree_keys_alloc(&b->keys,
599 ilog2(b->c->btree_pages),
602 b->c->bucket_cache_used++;
603 list_move(&b->list, &b->c->btree_cache);
605 list_move(&b->list, &b->c->btree_cache_freed);
609 static struct btree *mca_bucket_alloc(struct cache_set *c,
610 struct bkey *k, gfp_t gfp)
612 struct btree *b = kzalloc(sizeof(struct btree), gfp);
616 init_rwsem(&b->lock);
617 lockdep_set_novalidate_class(&b->lock);
618 mutex_init(&b->write_lock);
619 lockdep_set_novalidate_class(&b->write_lock);
620 INIT_LIST_HEAD(&b->list);
621 INIT_DELAYED_WORK(&b->work, btree_node_write_work);
623 sema_init(&b->io_mutex, 1);
625 mca_data_alloc(b, k, gfp);
629 static int mca_reap(struct btree *b, unsigned min_order, bool flush)
633 closure_init_stack(&cl);
634 lockdep_assert_held(&b->c->bucket_lock);
636 if (!down_write_trylock(&b->lock))
639 BUG_ON(btree_node_dirty(b) && !b->keys.set[0].data);
641 if (b->keys.page_order < min_order)
645 if (btree_node_dirty(b))
648 if (down_trylock(&b->io_mutex))
653 mutex_lock(&b->write_lock);
654 if (btree_node_dirty(b))
655 __bch_btree_node_write(b, &cl);
656 mutex_unlock(&b->write_lock);
660 /* wait for any in flight btree write */
670 static unsigned long bch_mca_scan(struct shrinker *shrink,
671 struct shrink_control *sc)
673 struct cache_set *c = container_of(shrink, struct cache_set, shrink);
675 unsigned long i, nr = sc->nr_to_scan;
676 unsigned long freed = 0;
678 if (c->shrinker_disabled)
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 list_for_each_entry_safe(b, t, &c->btree_cache_freeable, list) {
706 !mca_reap(b, 0, false)) {
713 for (i = 0; (nr--) && i < c->bucket_cache_used; i++) {
714 if (list_empty(&c->btree_cache))
717 b = list_first_entry(&c->btree_cache, struct btree, list);
718 list_rotate_left(&c->btree_cache);
721 !mca_reap(b, 0, false)) {
730 mutex_unlock(&c->bucket_lock);
734 static unsigned long bch_mca_count(struct shrinker *shrink,
735 struct shrink_control *sc)
737 struct cache_set *c = container_of(shrink, struct cache_set, shrink);
739 if (c->shrinker_disabled)
745 return mca_can_free(c) * c->btree_pages;
748 void bch_btree_cache_free(struct cache_set *c)
752 closure_init_stack(&cl);
754 if (c->shrink.list.next)
755 unregister_shrinker(&c->shrink);
757 mutex_lock(&c->bucket_lock);
759 #ifdef CONFIG_BCACHE_DEBUG
761 list_move(&c->verify_data->list, &c->btree_cache);
763 free_pages((unsigned long) c->verify_ondisk, ilog2(bucket_pages(c)));
766 list_splice(&c->btree_cache_freeable,
769 while (!list_empty(&c->btree_cache)) {
770 b = list_first_entry(&c->btree_cache, struct btree, list);
772 if (btree_node_dirty(b))
773 btree_complete_write(b, btree_current_write(b));
774 clear_bit(BTREE_NODE_dirty, &b->flags);
779 while (!list_empty(&c->btree_cache_freed)) {
780 b = list_first_entry(&c->btree_cache_freed,
783 cancel_delayed_work_sync(&b->work);
787 mutex_unlock(&c->bucket_lock);
790 int bch_btree_cache_alloc(struct cache_set *c)
794 for (i = 0; i < mca_reserve(c); i++)
795 if (!mca_bucket_alloc(c, &ZERO_KEY, GFP_KERNEL))
798 list_splice_init(&c->btree_cache,
799 &c->btree_cache_freeable);
801 #ifdef CONFIG_BCACHE_DEBUG
802 mutex_init(&c->verify_lock);
804 c->verify_ondisk = (void *)
805 __get_free_pages(GFP_KERNEL, ilog2(bucket_pages(c)));
807 c->verify_data = mca_bucket_alloc(c, &ZERO_KEY, GFP_KERNEL);
809 if (c->verify_data &&
810 c->verify_data->keys.set->data)
811 list_del_init(&c->verify_data->list);
813 c->verify_data = NULL;
816 c->shrink.count_objects = bch_mca_count;
817 c->shrink.scan_objects = bch_mca_scan;
819 c->shrink.batch = c->btree_pages * 2;
820 register_shrinker(&c->shrink);
825 /* Btree in memory cache - hash table */
827 static struct hlist_head *mca_hash(struct cache_set *c, struct bkey *k)
829 return &c->bucket_hash[hash_32(PTR_HASH(c, k), BUCKET_HASH_BITS)];
832 static struct btree *mca_find(struct cache_set *c, struct bkey *k)
837 hlist_for_each_entry_rcu(b, mca_hash(c, k), hash)
838 if (PTR_HASH(c, &b->key) == PTR_HASH(c, k))
846 static struct btree *mca_cannibalize(struct cache_set *c, struct bkey *k)
850 trace_bcache_btree_cache_cannibalize(c);
852 if (!c->try_harder) {
853 c->try_harder = current;
854 c->try_harder_start = local_clock();
855 } else if (c->try_harder != current)
856 return ERR_PTR(-ENOSPC);
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 return ERR_PTR(-ENOMEM);
870 * We can only have one thread cannibalizing other cached btree nodes at a time,
871 * or we'll deadlock. We use an open coded mutex to ensure that, which a
872 * cannibalize_bucket() will take. This means every time we unlock the root of
873 * the btree, we need to release this lock if we have it held.
875 static void bch_cannibalize_unlock(struct cache_set *c)
877 if (c->try_harder == current) {
878 bch_time_stats_update(&c->try_harder_time, c->try_harder_start);
879 c->try_harder = NULL;
880 wake_up(&c->try_wait);
884 static struct btree *mca_alloc(struct cache_set *c, struct bkey *k, int level)
888 BUG_ON(current->bio_list);
890 lockdep_assert_held(&c->bucket_lock);
895 /* btree_free() doesn't free memory; it sticks the node on the end of
896 * the list. Check if there's any freed nodes there:
898 list_for_each_entry(b, &c->btree_cache_freeable, list)
899 if (!mca_reap(b, btree_order(k), false))
902 /* We never free struct btree itself, just the memory that holds the on
903 * disk node. Check the freed list before allocating a new one:
905 list_for_each_entry(b, &c->btree_cache_freed, list)
906 if (!mca_reap(b, 0, false)) {
907 mca_data_alloc(b, k, __GFP_NOWARN|GFP_NOIO);
908 if (!b->keys.set[0].data)
914 b = mca_bucket_alloc(c, k, __GFP_NOWARN|GFP_NOIO);
918 BUG_ON(!down_write_trylock(&b->lock));
919 if (!b->keys.set->data)
922 BUG_ON(b->io_mutex.count != 1);
924 bkey_copy(&b->key, k);
925 list_move(&b->list, &c->btree_cache);
926 hlist_del_init_rcu(&b->hash);
927 hlist_add_head_rcu(&b->hash, mca_hash(c, k));
929 lock_set_subclass(&b->lock.dep_map, level + 1, _THIS_IP_);
930 b->parent = (void *) ~0UL;
936 bch_btree_keys_init(&b->keys, &bch_extent_keys_ops,
937 &b->c->expensive_debug_checks);
939 bch_btree_keys_init(&b->keys, &bch_btree_keys_ops,
940 &b->c->expensive_debug_checks);
947 b = mca_cannibalize(c, k);
955 * bch_btree_node_get - find a btree node in the cache and lock it, reading it
956 * in from disk if necessary.
958 * If IO is necessary and running under generic_make_request, returns -EAGAIN.
960 * The btree node will have either a read or a write lock held, depending on
961 * level and op->lock.
963 struct btree *bch_btree_node_get(struct cache_set *c, struct bkey *k,
964 int level, bool write)
974 if (current->bio_list)
975 return ERR_PTR(-EAGAIN);
977 mutex_lock(&c->bucket_lock);
978 b = mca_alloc(c, k, level);
979 mutex_unlock(&c->bucket_lock);
986 bch_btree_node_read(b);
989 downgrade_write(&b->lock);
991 rw_lock(write, b, level);
992 if (PTR_HASH(c, &b->key) != PTR_HASH(c, k)) {
996 BUG_ON(b->level != level);
1001 for (; i <= b->keys.nsets && b->keys.set[i].size; i++) {
1002 prefetch(b->keys.set[i].tree);
1003 prefetch(b->keys.set[i].data);
1006 for (; i <= b->keys.nsets; i++)
1007 prefetch(b->keys.set[i].data);
1009 if (btree_node_io_error(b)) {
1010 rw_unlock(write, b);
1011 return ERR_PTR(-EIO);
1014 BUG_ON(!b->written);
1019 static void btree_node_prefetch(struct cache_set *c, struct bkey *k, int level)
1023 mutex_lock(&c->bucket_lock);
1024 b = mca_alloc(c, k, level);
1025 mutex_unlock(&c->bucket_lock);
1027 if (!IS_ERR_OR_NULL(b)) {
1028 bch_btree_node_read(b);
1035 static void btree_node_free(struct btree *b)
1037 trace_bcache_btree_node_free(b);
1039 BUG_ON(b == b->c->root);
1041 mutex_lock(&b->write_lock);
1043 if (btree_node_dirty(b))
1044 btree_complete_write(b, btree_current_write(b));
1045 clear_bit(BTREE_NODE_dirty, &b->flags);
1047 mutex_unlock(&b->write_lock);
1049 cancel_delayed_work(&b->work);
1051 mutex_lock(&b->c->bucket_lock);
1052 bch_bucket_free(b->c, &b->key);
1054 mutex_unlock(&b->c->bucket_lock);
1057 struct btree *bch_btree_node_alloc(struct cache_set *c, int level, bool wait)
1060 struct btree *b = ERR_PTR(-EAGAIN);
1062 mutex_lock(&c->bucket_lock);
1064 if (__bch_bucket_alloc_set(c, RESERVE_BTREE, &k.key, 1, wait))
1067 bkey_put(c, &k.key);
1068 SET_KEY_SIZE(&k.key, c->btree_pages * PAGE_SECTORS);
1070 b = mca_alloc(c, &k.key, level);
1076 "Tried to allocate bucket that was in btree cache");
1081 bch_bset_init_next(&b->keys, b->keys.set->data, bset_magic(&b->c->sb));
1083 mutex_unlock(&c->bucket_lock);
1085 trace_bcache_btree_node_alloc(b);
1088 bch_bucket_free(c, &k.key);
1090 mutex_unlock(&c->bucket_lock);
1092 trace_bcache_btree_node_alloc_fail(b);
1096 static struct btree *btree_node_alloc_replacement(struct btree *b, bool wait)
1098 struct btree *n = bch_btree_node_alloc(b->c, b->level, wait);
1099 if (!IS_ERR_OR_NULL(n)) {
1100 mutex_lock(&n->write_lock);
1101 bch_btree_sort_into(&b->keys, &n->keys, &b->c->sort);
1102 bkey_copy_key(&n->key, &b->key);
1103 mutex_unlock(&n->write_lock);
1109 static void make_btree_freeing_key(struct btree *b, struct bkey *k)
1113 mutex_lock(&b->c->bucket_lock);
1115 atomic_inc(&b->c->prio_blocked);
1117 bkey_copy(k, &b->key);
1118 bkey_copy_key(k, &ZERO_KEY);
1120 for (i = 0; i < KEY_PTRS(k); i++)
1122 bch_inc_gen(PTR_CACHE(b->c, &b->key, i),
1123 PTR_BUCKET(b->c, &b->key, i)));
1125 mutex_unlock(&b->c->bucket_lock);
1128 static int btree_check_reserve(struct btree *b, struct btree_op *op)
1130 struct cache_set *c = b->c;
1132 unsigned i, reserve = c->root->level * 2 + 1;
1135 mutex_lock(&c->bucket_lock);
1137 for_each_cache(ca, c, i)
1138 if (fifo_used(&ca->free[RESERVE_BTREE]) < reserve) {
1140 prepare_to_wait(&c->bucket_wait, &op->wait,
1141 TASK_UNINTERRUPTIBLE);
1146 mutex_unlock(&c->bucket_lock);
1150 /* Garbage collection */
1152 static uint8_t __bch_btree_mark_key(struct cache_set *c, int level,
1160 * ptr_invalid() can't return true for the keys that mark btree nodes as
1161 * freed, but since ptr_bad() returns true we'll never actually use them
1162 * for anything and thus we don't want mark their pointers here
1164 if (!bkey_cmp(k, &ZERO_KEY))
1167 for (i = 0; i < KEY_PTRS(k); i++) {
1168 if (!ptr_available(c, k, i))
1171 g = PTR_BUCKET(c, k, i);
1173 if (gen_after(g->gc_gen, PTR_GEN(k, i)))
1174 g->gc_gen = PTR_GEN(k, i);
1176 if (ptr_stale(c, k, i)) {
1177 stale = max(stale, ptr_stale(c, k, i));
1181 cache_bug_on(GC_MARK(g) &&
1182 (GC_MARK(g) == GC_MARK_METADATA) != (level != 0),
1183 c, "inconsistent ptrs: mark = %llu, level = %i",
1187 SET_GC_MARK(g, GC_MARK_METADATA);
1188 else if (KEY_DIRTY(k))
1189 SET_GC_MARK(g, GC_MARK_DIRTY);
1190 else if (!GC_MARK(g))
1191 SET_GC_MARK(g, GC_MARK_RECLAIMABLE);
1193 /* guard against overflow */
1194 SET_GC_SECTORS_USED(g, min_t(unsigned,
1195 GC_SECTORS_USED(g) + KEY_SIZE(k),
1196 MAX_GC_SECTORS_USED));
1198 BUG_ON(!GC_SECTORS_USED(g));
1204 #define btree_mark_key(b, k) __bch_btree_mark_key(b->c, b->level, k)
1206 void bch_initial_mark_key(struct cache_set *c, int level, struct bkey *k)
1210 for (i = 0; i < KEY_PTRS(k); i++)
1211 if (ptr_available(c, k, i) &&
1212 !ptr_stale(c, k, i)) {
1213 struct bucket *b = PTR_BUCKET(c, k, i);
1215 b->gen = PTR_GEN(k, i);
1217 if (level && bkey_cmp(k, &ZERO_KEY))
1218 b->prio = BTREE_PRIO;
1219 else if (!level && b->prio == BTREE_PRIO)
1220 b->prio = INITIAL_PRIO;
1223 __bch_btree_mark_key(c, level, k);
1226 static bool btree_gc_mark_node(struct btree *b, struct gc_stat *gc)
1229 unsigned keys = 0, good_keys = 0;
1231 struct btree_iter iter;
1232 struct bset_tree *t;
1236 for_each_key_filter(&b->keys, k, &iter, bch_ptr_invalid) {
1237 stale = max(stale, btree_mark_key(b, k));
1240 if (bch_ptr_bad(&b->keys, k))
1243 gc->key_bytes += bkey_u64s(k);
1247 gc->data += KEY_SIZE(k);
1250 for (t = b->keys.set; t <= &b->keys.set[b->keys.nsets]; t++)
1251 btree_bug_on(t->size &&
1252 bset_written(&b->keys, t) &&
1253 bkey_cmp(&b->key, &t->end) < 0,
1254 b, "found short btree key in gc");
1256 if (b->c->gc_always_rewrite)
1262 if ((keys - good_keys) * 2 > keys)
1268 #define GC_MERGE_NODES 4U
1270 struct gc_merge_info {
1275 static int bch_btree_insert_node(struct btree *, struct btree_op *,
1276 struct keylist *, atomic_t *, struct bkey *);
1278 static int btree_gc_coalesce(struct btree *b, struct btree_op *op,
1279 struct keylist *keylist, struct gc_stat *gc,
1280 struct gc_merge_info *r)
1282 unsigned i, nodes = 0, keys = 0, blocks;
1283 struct btree *new_nodes[GC_MERGE_NODES];
1287 memset(new_nodes, 0, sizeof(new_nodes));
1288 closure_init_stack(&cl);
1290 while (nodes < GC_MERGE_NODES && !IS_ERR_OR_NULL(r[nodes].b))
1291 keys += r[nodes++].keys;
1293 blocks = btree_default_blocks(b->c) * 2 / 3;
1296 __set_blocks(b->keys.set[0].data, keys,
1297 block_bytes(b->c)) > blocks * (nodes - 1))
1300 for (i = 0; i < nodes; i++) {
1301 new_nodes[i] = btree_node_alloc_replacement(r[i].b, false);
1302 if (IS_ERR_OR_NULL(new_nodes[i]))
1303 goto out_nocoalesce;
1306 for (i = 0; i < nodes; i++)
1307 mutex_lock(&new_nodes[i]->write_lock);
1309 for (i = nodes - 1; i > 0; --i) {
1310 struct bset *n1 = btree_bset_first(new_nodes[i]);
1311 struct bset *n2 = btree_bset_first(new_nodes[i - 1]);
1312 struct bkey *k, *last = NULL;
1318 k < bset_bkey_last(n2);
1320 if (__set_blocks(n1, n1->keys + keys +
1322 block_bytes(b->c)) > blocks)
1326 keys += bkey_u64s(k);
1330 * Last node we're not getting rid of - we're getting
1331 * rid of the node at r[0]. Have to try and fit all of
1332 * the remaining keys into this node; we can't ensure
1333 * they will always fit due to rounding and variable
1334 * length keys (shouldn't be possible in practice,
1337 if (__set_blocks(n1, n1->keys + n2->keys,
1338 block_bytes(b->c)) >
1339 btree_blocks(new_nodes[i]))
1340 goto out_nocoalesce;
1343 /* Take the key of the node we're getting rid of */
1347 BUG_ON(__set_blocks(n1, n1->keys + keys, block_bytes(b->c)) >
1348 btree_blocks(new_nodes[i]));
1351 bkey_copy_key(&new_nodes[i]->key, last);
1353 memcpy(bset_bkey_last(n1),
1355 (void *) bset_bkey_idx(n2, keys) - (void *) n2->start);
1358 r[i].keys = n1->keys;
1361 bset_bkey_idx(n2, keys),
1362 (void *) bset_bkey_last(n2) -
1363 (void *) bset_bkey_idx(n2, keys));
1367 if (__bch_keylist_realloc(keylist,
1368 bkey_u64s(&new_nodes[i]->key)))
1369 goto out_nocoalesce;
1371 bch_btree_node_write(new_nodes[i], &cl);
1372 bch_keylist_add(keylist, &new_nodes[i]->key);
1375 for (i = 0; i < nodes; i++)
1376 mutex_unlock(&new_nodes[i]->write_lock);
1380 /* We emptied out this node */
1381 BUG_ON(btree_bset_first(new_nodes[0])->keys);
1382 btree_node_free(new_nodes[0]);
1383 rw_unlock(true, new_nodes[0]);
1385 for (i = 0; i < nodes; i++) {
1386 if (__bch_keylist_realloc(keylist, bkey_u64s(&r[i].b->key)))
1387 goto out_nocoalesce;
1389 make_btree_freeing_key(r[i].b, keylist->top);
1390 bch_keylist_push(keylist);
1393 bch_btree_insert_node(b, op, keylist, NULL, NULL);
1394 BUG_ON(!bch_keylist_empty(keylist));
1396 for (i = 0; i < nodes; i++) {
1397 btree_node_free(r[i].b);
1398 rw_unlock(true, r[i].b);
1400 r[i].b = new_nodes[i];
1403 memmove(r, r + 1, sizeof(r[0]) * (nodes - 1));
1404 r[nodes - 1].b = ERR_PTR(-EINTR);
1406 trace_bcache_btree_gc_coalesce(nodes);
1409 /* Invalidated our iterator */
1415 while ((k = bch_keylist_pop(keylist)))
1416 if (!bkey_cmp(k, &ZERO_KEY))
1417 atomic_dec(&b->c->prio_blocked);
1419 for (i = 0; i < nodes; i++)
1420 if (!IS_ERR_OR_NULL(new_nodes[i])) {
1421 btree_node_free(new_nodes[i]);
1422 rw_unlock(true, new_nodes[i]);
1427 static unsigned btree_gc_count_keys(struct btree *b)
1430 struct btree_iter iter;
1433 for_each_key_filter(&b->keys, k, &iter, bch_ptr_bad)
1434 ret += bkey_u64s(k);
1439 static int btree_gc_recurse(struct btree *b, struct btree_op *op,
1440 struct closure *writes, struct gc_stat *gc)
1443 bool should_rewrite;
1446 struct keylist keys;
1447 struct btree_iter iter;
1448 struct gc_merge_info r[GC_MERGE_NODES];
1449 struct gc_merge_info *i, *last = r + ARRAY_SIZE(r) - 1;
1451 bch_keylist_init(&keys);
1452 bch_btree_iter_init(&b->keys, &iter, &b->c->gc_done);
1454 for (i = r; i < r + ARRAY_SIZE(r); i++)
1455 i->b = ERR_PTR(-EINTR);
1458 k = bch_btree_iter_next_filter(&iter, &b->keys, bch_ptr_bad);
1460 r->b = bch_btree_node_get(b->c, k, b->level - 1, true);
1462 ret = PTR_ERR(r->b);
1466 r->keys = btree_gc_count_keys(r->b);
1468 ret = btree_gc_coalesce(b, op, &keys, gc, r);
1476 if (!IS_ERR(last->b)) {
1477 should_rewrite = btree_gc_mark_node(last->b, gc);
1478 if (should_rewrite &&
1479 !btree_check_reserve(b, NULL)) {
1480 n = btree_node_alloc_replacement(last->b,
1483 if (!IS_ERR_OR_NULL(n)) {
1484 bch_btree_node_write_sync(n);
1486 bch_keylist_add(&keys, &n->key);
1488 make_btree_freeing_key(last->b,
1490 bch_keylist_push(&keys);
1492 bch_btree_insert_node(b, op, &keys,
1494 BUG_ON(!bch_keylist_empty(&keys));
1496 btree_node_free(last->b);
1497 rw_unlock(true, last->b);
1500 /* Invalidated our iterator */
1506 if (last->b->level) {
1507 ret = btree_gc_recurse(last->b, op, writes, gc);
1512 bkey_copy_key(&b->c->gc_done, &last->b->key);
1515 * Must flush leaf nodes before gc ends, since replace
1516 * operations aren't journalled
1518 mutex_lock(&last->b->write_lock);
1519 if (btree_node_dirty(last->b))
1520 bch_btree_node_write(last->b, writes);
1521 mutex_unlock(&last->b->write_lock);
1522 rw_unlock(true, last->b);
1525 memmove(r + 1, r, sizeof(r[0]) * (GC_MERGE_NODES - 1));
1528 if (need_resched()) {
1534 for (i = r; i < r + ARRAY_SIZE(r); i++)
1535 if (!IS_ERR_OR_NULL(i->b)) {
1536 mutex_lock(&i->b->write_lock);
1537 if (btree_node_dirty(i->b))
1538 bch_btree_node_write(i->b, writes);
1539 mutex_unlock(&i->b->write_lock);
1540 rw_unlock(true, i->b);
1543 bch_keylist_free(&keys);
1548 static int bch_btree_gc_root(struct btree *b, struct btree_op *op,
1549 struct closure *writes, struct gc_stat *gc)
1551 struct btree *n = NULL;
1553 bool should_rewrite;
1555 should_rewrite = btree_gc_mark_node(b, gc);
1556 if (should_rewrite) {
1557 n = btree_node_alloc_replacement(b, false);
1559 if (!IS_ERR_OR_NULL(n)) {
1560 bch_btree_node_write_sync(n);
1562 bch_btree_set_root(n);
1570 __bch_btree_mark_key(b->c, b->level + 1, &b->key);
1573 ret = btree_gc_recurse(b, op, writes, gc);
1578 bkey_copy_key(&b->c->gc_done, &b->key);
1583 static void btree_gc_start(struct cache_set *c)
1589 if (!c->gc_mark_valid)
1592 mutex_lock(&c->bucket_lock);
1594 c->gc_mark_valid = 0;
1595 c->gc_done = ZERO_KEY;
1597 for_each_cache(ca, c, i)
1598 for_each_bucket(b, ca) {
1600 if (!atomic_read(&b->pin)) {
1602 SET_GC_SECTORS_USED(b, 0);
1606 mutex_unlock(&c->bucket_lock);
1609 size_t bch_btree_gc_finish(struct cache_set *c)
1611 size_t available = 0;
1616 mutex_lock(&c->bucket_lock);
1619 c->gc_mark_valid = 1;
1622 for (i = 0; i < KEY_PTRS(&c->uuid_bucket); i++)
1623 SET_GC_MARK(PTR_BUCKET(c, &c->uuid_bucket, i),
1626 /* don't reclaim buckets to which writeback keys point */
1628 for (i = 0; i < c->nr_uuids; i++) {
1629 struct bcache_device *d = c->devices[i];
1630 struct cached_dev *dc;
1631 struct keybuf_key *w, *n;
1634 if (!d || UUID_FLASH_ONLY(&c->uuids[i]))
1636 dc = container_of(d, struct cached_dev, disk);
1638 spin_lock(&dc->writeback_keys.lock);
1639 rbtree_postorder_for_each_entry_safe(w, n,
1640 &dc->writeback_keys.keys, node)
1641 for (j = 0; j < KEY_PTRS(&w->key); j++)
1642 SET_GC_MARK(PTR_BUCKET(c, &w->key, j),
1644 spin_unlock(&dc->writeback_keys.lock);
1648 for_each_cache(ca, c, i) {
1651 ca->invalidate_needs_gc = 0;
1653 for (i = ca->sb.d; i < ca->sb.d + ca->sb.keys; i++)
1654 SET_GC_MARK(ca->buckets + *i, GC_MARK_METADATA);
1656 for (i = ca->prio_buckets;
1657 i < ca->prio_buckets + prio_buckets(ca) * 2; i++)
1658 SET_GC_MARK(ca->buckets + *i, GC_MARK_METADATA);
1660 for_each_bucket(b, ca) {
1661 b->last_gc = b->gc_gen;
1662 c->need_gc = max(c->need_gc, bucket_gc_gen(b));
1664 if (atomic_read(&b->pin))
1667 BUG_ON(!GC_MARK(b) && GC_SECTORS_USED(b));
1669 if (!GC_MARK(b) || GC_MARK(b) == GC_MARK_RECLAIMABLE)
1673 bch_bucket_add_unused(ca, b);
1677 mutex_unlock(&c->bucket_lock);
1681 static void bch_btree_gc(struct cache_set *c)
1684 unsigned long available;
1685 struct gc_stat stats;
1686 struct closure writes;
1688 uint64_t start_time = local_clock();
1690 trace_bcache_gc_start(c);
1692 memset(&stats, 0, sizeof(struct gc_stat));
1693 closure_init_stack(&writes);
1694 bch_btree_op_init(&op, SHRT_MAX);
1699 ret = btree_root(gc_root, c, &op, &writes, &stats);
1700 closure_sync(&writes);
1702 if (ret && ret != -EAGAIN)
1703 pr_warn("gc failed!");
1706 available = bch_btree_gc_finish(c);
1707 wake_up_allocators(c);
1709 bch_time_stats_update(&c->btree_gc_time, start_time);
1711 stats.key_bytes *= sizeof(uint64_t);
1713 stats.in_use = (c->nbuckets - available) * 100 / c->nbuckets;
1714 memcpy(&c->gc_stats, &stats, sizeof(struct gc_stat));
1716 trace_bcache_gc_end(c);
1721 static int bch_gc_thread(void *arg)
1723 struct cache_set *c = arg;
1731 set_current_state(TASK_INTERRUPTIBLE);
1732 if (kthread_should_stop())
1735 mutex_lock(&c->bucket_lock);
1737 for_each_cache(ca, c, i)
1738 if (ca->invalidate_needs_gc) {
1739 mutex_unlock(&c->bucket_lock);
1740 set_current_state(TASK_RUNNING);
1744 mutex_unlock(&c->bucket_lock);
1753 int bch_gc_thread_start(struct cache_set *c)
1755 c->gc_thread = kthread_create(bch_gc_thread, c, "bcache_gc");
1756 if (IS_ERR(c->gc_thread))
1757 return PTR_ERR(c->gc_thread);
1759 set_task_state(c->gc_thread, TASK_INTERRUPTIBLE);
1763 /* Initial partial gc */
1765 static int bch_btree_check_recurse(struct btree *b, struct btree_op *op)
1768 struct bkey *k, *p = NULL;
1769 struct btree_iter iter;
1771 for_each_key_filter(&b->keys, k, &iter, bch_ptr_invalid)
1772 bch_initial_mark_key(b->c, b->level, k);
1774 bch_initial_mark_key(b->c, b->level + 1, &b->key);
1777 bch_btree_iter_init(&b->keys, &iter, NULL);
1780 k = bch_btree_iter_next_filter(&iter, &b->keys,
1783 btree_node_prefetch(b->c, k, b->level - 1);
1786 ret = btree(check_recurse, p, b, op);
1789 } while (p && !ret);
1795 int bch_btree_check(struct cache_set *c)
1799 bch_btree_op_init(&op, SHRT_MAX);
1801 return btree_root(check_recurse, c, &op);
1804 /* Btree insertion */
1806 static bool btree_insert_key(struct btree *b, struct bkey *k,
1807 struct bkey *replace_key)
1811 BUG_ON(bkey_cmp(k, &b->key) > 0);
1813 status = bch_btree_insert_key(&b->keys, k, replace_key);
1814 if (status != BTREE_INSERT_STATUS_NO_INSERT) {
1815 bch_check_keys(&b->keys, "%u for %s", status,
1816 replace_key ? "replace" : "insert");
1818 trace_bcache_btree_insert_key(b, k, replace_key != NULL,
1825 static size_t insert_u64s_remaining(struct btree *b)
1827 long ret = bch_btree_keys_u64s_remaining(&b->keys);
1830 * Might land in the middle of an existing extent and have to split it
1832 if (b->keys.ops->is_extents)
1833 ret -= KEY_MAX_U64S;
1835 return max(ret, 0L);
1838 static bool bch_btree_insert_keys(struct btree *b, struct btree_op *op,
1839 struct keylist *insert_keys,
1840 struct bkey *replace_key)
1843 int oldsize = bch_count_data(&b->keys);
1845 while (!bch_keylist_empty(insert_keys)) {
1846 struct bkey *k = insert_keys->keys;
1848 if (bkey_u64s(k) > insert_u64s_remaining(b))
1851 if (bkey_cmp(k, &b->key) <= 0) {
1855 ret |= btree_insert_key(b, k, replace_key);
1856 bch_keylist_pop_front(insert_keys);
1857 } else if (bkey_cmp(&START_KEY(k), &b->key) < 0) {
1858 BKEY_PADDED(key) temp;
1859 bkey_copy(&temp.key, insert_keys->keys);
1861 bch_cut_back(&b->key, &temp.key);
1862 bch_cut_front(&b->key, insert_keys->keys);
1864 ret |= btree_insert_key(b, &temp.key, replace_key);
1872 op->insert_collision = true;
1874 BUG_ON(!bch_keylist_empty(insert_keys) && b->level);
1876 BUG_ON(bch_count_data(&b->keys) < oldsize);
1880 static int btree_split(struct btree *b, struct btree_op *op,
1881 struct keylist *insert_keys,
1882 struct bkey *replace_key)
1885 struct btree *n1, *n2 = NULL, *n3 = NULL;
1886 uint64_t start_time = local_clock();
1888 struct keylist parent_keys;
1890 closure_init_stack(&cl);
1891 bch_keylist_init(&parent_keys);
1894 btree_check_reserve(b, op))
1897 n1 = btree_node_alloc_replacement(b, true);
1901 split = set_blocks(btree_bset_first(n1),
1902 block_bytes(n1->c)) > (btree_blocks(b) * 4) / 5;
1907 trace_bcache_btree_node_split(b, btree_bset_first(n1)->keys);
1909 n2 = bch_btree_node_alloc(b->c, b->level, true);
1914 n3 = bch_btree_node_alloc(b->c, b->level + 1, true);
1919 mutex_lock(&n1->write_lock);
1920 mutex_lock(&n2->write_lock);
1922 bch_btree_insert_keys(n1, op, insert_keys, replace_key);
1925 * Has to be a linear search because we don't have an auxiliary
1929 while (keys < (btree_bset_first(n1)->keys * 3) / 5)
1930 keys += bkey_u64s(bset_bkey_idx(btree_bset_first(n1),
1933 bkey_copy_key(&n1->key,
1934 bset_bkey_idx(btree_bset_first(n1), keys));
1935 keys += bkey_u64s(bset_bkey_idx(btree_bset_first(n1), keys));
1937 btree_bset_first(n2)->keys = btree_bset_first(n1)->keys - keys;
1938 btree_bset_first(n1)->keys = keys;
1940 memcpy(btree_bset_first(n2)->start,
1941 bset_bkey_last(btree_bset_first(n1)),
1942 btree_bset_first(n2)->keys * sizeof(uint64_t));
1944 bkey_copy_key(&n2->key, &b->key);
1946 bch_keylist_add(&parent_keys, &n2->key);
1947 bch_btree_node_write(n2, &cl);
1948 mutex_unlock(&n2->write_lock);
1949 rw_unlock(true, n2);
1951 trace_bcache_btree_node_compact(b, btree_bset_first(n1)->keys);
1953 mutex_lock(&n1->write_lock);
1954 bch_btree_insert_keys(n1, op, insert_keys, replace_key);
1957 bch_keylist_add(&parent_keys, &n1->key);
1958 bch_btree_node_write(n1, &cl);
1959 mutex_unlock(&n1->write_lock);
1962 /* Depth increases, make a new root */
1963 mutex_lock(&n3->write_lock);
1964 bkey_copy_key(&n3->key, &MAX_KEY);
1965 bch_btree_insert_keys(n3, op, &parent_keys, NULL);
1966 bch_btree_node_write(n3, &cl);
1967 mutex_unlock(&n3->write_lock);
1970 bch_btree_set_root(n3);
1971 rw_unlock(true, n3);
1972 } else if (!b->parent) {
1973 /* Root filled up but didn't need to be split */
1975 bch_btree_set_root(n1);
1977 /* Split a non root node */
1979 make_btree_freeing_key(b, parent_keys.top);
1980 bch_keylist_push(&parent_keys);
1982 bch_btree_insert_node(b->parent, op, &parent_keys, NULL, NULL);
1983 BUG_ON(!bch_keylist_empty(&parent_keys));
1987 rw_unlock(true, n1);
1989 bch_time_stats_update(&b->c->btree_split_time, start_time);
1993 bkey_put(b->c, &n2->key);
1994 btree_node_free(n2);
1995 rw_unlock(true, n2);
1997 bkey_put(b->c, &n1->key);
1998 btree_node_free(n1);
1999 rw_unlock(true, n1);
2001 WARN(1, "bcache: btree split failed");
2003 if (n3 == ERR_PTR(-EAGAIN) ||
2004 n2 == ERR_PTR(-EAGAIN) ||
2005 n1 == ERR_PTR(-EAGAIN))
2011 static int bch_btree_insert_node(struct btree *b, struct btree_op *op,
2012 struct keylist *insert_keys,
2013 atomic_t *journal_ref,
2014 struct bkey *replace_key)
2018 BUG_ON(b->level && replace_key);
2020 closure_init_stack(&cl);
2022 mutex_lock(&b->write_lock);
2024 if (write_block(b) != btree_bset_last(b) &&
2025 b->keys.last_set_unwritten)
2026 bch_btree_init_next(b); /* just wrote a set */
2028 if (bch_keylist_nkeys(insert_keys) > insert_u64s_remaining(b)) {
2029 mutex_unlock(&b->write_lock);
2033 BUG_ON(write_block(b) != btree_bset_last(b));
2035 if (bch_btree_insert_keys(b, op, insert_keys, replace_key)) {
2037 bch_btree_leaf_dirty(b, journal_ref);
2039 bch_btree_node_write(b, &cl);
2042 mutex_unlock(&b->write_lock);
2044 /* wait for btree node write if necessary, after unlock */
2049 if (current->bio_list) {
2050 op->lock = b->c->root->level + 1;
2052 } else if (op->lock <= b->c->root->level) {
2053 op->lock = b->c->root->level + 1;
2056 /* Invalidated all iterators */
2057 int ret = btree_split(b, op, insert_keys, replace_key);
2059 if (bch_keylist_empty(insert_keys))
2067 int bch_btree_insert_check_key(struct btree *b, struct btree_op *op,
2068 struct bkey *check_key)
2071 uint64_t btree_ptr = b->key.ptr[0];
2072 unsigned long seq = b->seq;
2073 struct keylist insert;
2074 bool upgrade = op->lock == -1;
2076 bch_keylist_init(&insert);
2079 rw_unlock(false, b);
2080 rw_lock(true, b, b->level);
2082 if (b->key.ptr[0] != btree_ptr ||
2087 SET_KEY_PTRS(check_key, 1);
2088 get_random_bytes(&check_key->ptr[0], sizeof(uint64_t));
2090 SET_PTR_DEV(check_key, 0, PTR_CHECK_DEV);
2092 bch_keylist_add(&insert, check_key);
2094 ret = bch_btree_insert_node(b, op, &insert, NULL, NULL);
2096 BUG_ON(!ret && !bch_keylist_empty(&insert));
2099 downgrade_write(&b->lock);
2103 struct btree_insert_op {
2105 struct keylist *keys;
2106 atomic_t *journal_ref;
2107 struct bkey *replace_key;
2110 static int btree_insert_fn(struct btree_op *b_op, struct btree *b)
2112 struct btree_insert_op *op = container_of(b_op,
2113 struct btree_insert_op, op);
2115 int ret = bch_btree_insert_node(b, &op->op, op->keys,
2116 op->journal_ref, op->replace_key);
2117 if (ret && !bch_keylist_empty(op->keys))
2123 int bch_btree_insert(struct cache_set *c, struct keylist *keys,
2124 atomic_t *journal_ref, struct bkey *replace_key)
2126 struct btree_insert_op op;
2129 BUG_ON(current->bio_list);
2130 BUG_ON(bch_keylist_empty(keys));
2132 bch_btree_op_init(&op.op, 0);
2134 op.journal_ref = journal_ref;
2135 op.replace_key = replace_key;
2137 while (!ret && !bch_keylist_empty(keys)) {
2139 ret = bch_btree_map_leaf_nodes(&op.op, c,
2140 &START_KEY(keys->keys),
2147 pr_err("error %i", ret);
2149 while ((k = bch_keylist_pop(keys)))
2151 } else if (op.op.insert_collision)
2157 void bch_btree_set_root(struct btree *b)
2162 closure_init_stack(&cl);
2164 trace_bcache_btree_set_root(b);
2166 BUG_ON(!b->written);
2168 for (i = 0; i < KEY_PTRS(&b->key); i++)
2169 BUG_ON(PTR_BUCKET(b->c, &b->key, i)->prio != BTREE_PRIO);
2171 mutex_lock(&b->c->bucket_lock);
2172 list_del_init(&b->list);
2173 mutex_unlock(&b->c->bucket_lock);
2177 bch_journal_meta(b->c, &cl);
2181 /* Map across nodes or keys */
2183 static int bch_btree_map_nodes_recurse(struct btree *b, struct btree_op *op,
2185 btree_map_nodes_fn *fn, int flags)
2187 int ret = MAP_CONTINUE;
2191 struct btree_iter iter;
2193 bch_btree_iter_init(&b->keys, &iter, from);
2195 while ((k = bch_btree_iter_next_filter(&iter, &b->keys,
2197 ret = btree(map_nodes_recurse, k, b,
2198 op, from, fn, flags);
2201 if (ret != MAP_CONTINUE)
2206 if (!b->level || flags == MAP_ALL_NODES)
2212 int __bch_btree_map_nodes(struct btree_op *op, struct cache_set *c,
2213 struct bkey *from, btree_map_nodes_fn *fn, int flags)
2215 return btree_root(map_nodes_recurse, c, op, from, fn, flags);
2218 static int bch_btree_map_keys_recurse(struct btree *b, struct btree_op *op,
2219 struct bkey *from, btree_map_keys_fn *fn,
2222 int ret = MAP_CONTINUE;
2224 struct btree_iter iter;
2226 bch_btree_iter_init(&b->keys, &iter, from);
2228 while ((k = bch_btree_iter_next_filter(&iter, &b->keys, bch_ptr_bad))) {
2231 : btree(map_keys_recurse, k, b, op, from, fn, flags);
2234 if (ret != MAP_CONTINUE)
2238 if (!b->level && (flags & MAP_END_KEY))
2239 ret = fn(op, b, &KEY(KEY_INODE(&b->key),
2240 KEY_OFFSET(&b->key), 0));
2245 int bch_btree_map_keys(struct btree_op *op, struct cache_set *c,
2246 struct bkey *from, btree_map_keys_fn *fn, int flags)
2248 return btree_root(map_keys_recurse, c, op, from, fn, flags);
2253 static inline int keybuf_cmp(struct keybuf_key *l, struct keybuf_key *r)
2255 /* Overlapping keys compare equal */
2256 if (bkey_cmp(&l->key, &START_KEY(&r->key)) <= 0)
2258 if (bkey_cmp(&START_KEY(&l->key), &r->key) >= 0)
2263 static inline int keybuf_nonoverlapping_cmp(struct keybuf_key *l,
2264 struct keybuf_key *r)
2266 return clamp_t(int64_t, bkey_cmp(&l->key, &r->key), -1, 1);
2274 keybuf_pred_fn *pred;
2277 static int refill_keybuf_fn(struct btree_op *op, struct btree *b,
2280 struct refill *refill = container_of(op, struct refill, op);
2281 struct keybuf *buf = refill->buf;
2282 int ret = MAP_CONTINUE;
2284 if (bkey_cmp(k, refill->end) >= 0) {
2289 if (!KEY_SIZE(k)) /* end key */
2292 if (refill->pred(buf, k)) {
2293 struct keybuf_key *w;
2295 spin_lock(&buf->lock);
2297 w = array_alloc(&buf->freelist);
2299 spin_unlock(&buf->lock);
2304 bkey_copy(&w->key, k);
2306 if (RB_INSERT(&buf->keys, w, node, keybuf_cmp))
2307 array_free(&buf->freelist, w);
2311 if (array_freelist_empty(&buf->freelist))
2314 spin_unlock(&buf->lock);
2317 buf->last_scanned = *k;
2321 void bch_refill_keybuf(struct cache_set *c, struct keybuf *buf,
2322 struct bkey *end, keybuf_pred_fn *pred)
2324 struct bkey start = buf->last_scanned;
2325 struct refill refill;
2329 bch_btree_op_init(&refill.op, -1);
2330 refill.nr_found = 0;
2335 bch_btree_map_keys(&refill.op, c, &buf->last_scanned,
2336 refill_keybuf_fn, MAP_END_KEY);
2338 trace_bcache_keyscan(refill.nr_found,
2339 KEY_INODE(&start), KEY_OFFSET(&start),
2340 KEY_INODE(&buf->last_scanned),
2341 KEY_OFFSET(&buf->last_scanned));
2343 spin_lock(&buf->lock);
2345 if (!RB_EMPTY_ROOT(&buf->keys)) {
2346 struct keybuf_key *w;
2347 w = RB_FIRST(&buf->keys, struct keybuf_key, node);
2348 buf->start = START_KEY(&w->key);
2350 w = RB_LAST(&buf->keys, struct keybuf_key, node);
2353 buf->start = MAX_KEY;
2357 spin_unlock(&buf->lock);
2360 static void __bch_keybuf_del(struct keybuf *buf, struct keybuf_key *w)
2362 rb_erase(&w->node, &buf->keys);
2363 array_free(&buf->freelist, w);
2366 void bch_keybuf_del(struct keybuf *buf, struct keybuf_key *w)
2368 spin_lock(&buf->lock);
2369 __bch_keybuf_del(buf, w);
2370 spin_unlock(&buf->lock);
2373 bool bch_keybuf_check_overlapping(struct keybuf *buf, struct bkey *start,
2377 struct keybuf_key *p, *w, s;
2380 if (bkey_cmp(end, &buf->start) <= 0 ||
2381 bkey_cmp(start, &buf->end) >= 0)
2384 spin_lock(&buf->lock);
2385 w = RB_GREATER(&buf->keys, s, node, keybuf_nonoverlapping_cmp);
2387 while (w && bkey_cmp(&START_KEY(&w->key), end) < 0) {
2389 w = RB_NEXT(w, node);
2394 __bch_keybuf_del(buf, p);
2397 spin_unlock(&buf->lock);
2401 struct keybuf_key *bch_keybuf_next(struct keybuf *buf)
2403 struct keybuf_key *w;
2404 spin_lock(&buf->lock);
2406 w = RB_FIRST(&buf->keys, struct keybuf_key, node);
2408 while (w && w->private)
2409 w = RB_NEXT(w, node);
2412 w->private = ERR_PTR(-EINTR);
2414 spin_unlock(&buf->lock);
2418 struct keybuf_key *bch_keybuf_next_rescan(struct cache_set *c,
2421 keybuf_pred_fn *pred)
2423 struct keybuf_key *ret;
2426 ret = bch_keybuf_next(buf);
2430 if (bkey_cmp(&buf->last_scanned, end) >= 0) {
2431 pr_debug("scan finished");
2435 bch_refill_keybuf(c, buf, end, pred);
2441 void bch_keybuf_init(struct keybuf *buf)
2443 buf->last_scanned = MAX_KEY;
2444 buf->keys = RB_ROOT;
2446 spin_lock_init(&buf->lock);
2447 array_allocator_init(&buf->freelist);
2450 void bch_btree_exit(void)
2453 destroy_workqueue(btree_io_wq);
2456 int __init bch_btree_init(void)
2458 btree_io_wq = create_singlethread_workqueue("bch_btree_io");