4 #include "bkey_methods.h"
5 #include "btree_cache.h"
7 #include "btree_update.h"
9 #include "btree_iter.h"
10 #include "btree_locking.h"
17 #include <linux/random.h>
18 #include <linux/sort.h>
19 #include <trace/events/bcache.h>
21 static void btree_interior_update_updated_root(struct cache_set *,
22 struct btree_interior_update *,
25 /* Calculate ideal packed bkey format for new btree nodes: */
27 void __bch_btree_calc_format(struct bkey_format_state *s, struct btree *b)
29 struct bkey_packed *k;
33 bch_bkey_format_add_pos(s, b->data->min_key);
36 for (k = btree_bkey_first(b, t);
37 k != btree_bkey_last(b, t);
39 if (!bkey_whiteout(k)) {
40 uk = bkey_unpack_key(b, k);
41 bch_bkey_format_add_key(s, &uk);
45 static struct bkey_format bch_btree_calc_format(struct btree *b)
47 struct bkey_format_state s;
49 bch_bkey_format_init(&s);
50 __bch_btree_calc_format(&s, b);
52 return bch_bkey_format_done(&s);
55 static size_t btree_node_u64s_with_format(struct btree *b,
56 struct bkey_format *new_f)
58 struct bkey_format *old_f = &b->format;
60 /* stupid integer promotion rules */
62 (((int) new_f->key_u64s - old_f->key_u64s) *
63 (int) b->nr.packed_keys) +
64 (((int) new_f->key_u64s - BKEY_U64s) *
65 (int) b->nr.unpacked_keys);
67 BUG_ON(delta + b->nr.live_u64s < 0);
69 return b->nr.live_u64s + delta;
73 * btree_node_format_fits - check if we could rewrite node with a new format
75 * This assumes all keys can pack with the new format -- it just checks if
76 * the re-packed keys would fit inside the node itself.
78 bool bch_btree_node_format_fits(struct cache_set *c, struct btree *b,
79 struct bkey_format *new_f)
81 size_t u64s = btree_node_u64s_with_format(b, new_f);
83 return __vstruct_bytes(struct btree_node, u64s) < btree_bytes(c);
86 /* Btree node freeing/allocation: */
89 * We're doing the index update that makes @b unreachable, update stuff to
92 * Must be called _before_ btree_interior_update_updated_root() or
93 * btree_interior_update_updated_btree:
95 static void bch_btree_node_free_index(struct cache_set *c, struct btree *b,
96 enum btree_id id, struct bkey_s_c k,
97 struct bch_fs_usage *stats)
99 struct btree_interior_update *as;
100 struct pending_btree_node_free *d;
102 mutex_lock(&c->btree_interior_update_lock);
104 for_each_pending_btree_node_free(c, as, d)
105 if (!bkey_cmp(k.k->p, d->key.k.p) &&
106 bkey_val_bytes(k.k) == bkey_val_bytes(&d->key.k) &&
107 !memcmp(k.v, &d->key.v, bkey_val_bytes(k.k)))
112 d->index_update_done = true;
115 * Btree nodes are accounted as freed in bch_alloc_stats when they're
116 * freed from the index:
118 stats->s[S_COMPRESSED][S_META] -= c->sb.btree_node_size;
119 stats->s[S_UNCOMPRESSED][S_META] -= c->sb.btree_node_size;
122 * We're dropping @k from the btree, but it's still live until the
123 * index update is persistent so we need to keep a reference around for
124 * mark and sweep to find - that's primarily what the
125 * btree_node_pending_free list is for.
127 * So here (when we set index_update_done = true), we're moving an
128 * existing reference to a different part of the larger "gc keyspace" -
129 * and the new position comes after the old position, since GC marks
130 * the pending free list after it walks the btree.
132 * If we move the reference while mark and sweep is _between_ the old
133 * and the new position, mark and sweep will see the reference twice
134 * and it'll get double accounted - so check for that here and subtract
135 * to cancel out one of mark and sweep's markings if necessary:
139 * bch_mark_key() compares the current gc pos to the pos we're
140 * moving this reference from, hence one comparison here:
142 if (gc_pos_cmp(c->gc_pos, gc_phase(GC_PHASE_PENDING_DELETE)) < 0) {
143 struct bch_fs_usage tmp = { 0 };
145 bch_mark_key(c, bkey_i_to_s_c(&d->key),
146 -c->sb.btree_node_size, true, b
147 ? gc_pos_btree_node(b)
148 : gc_pos_btree_root(id),
151 * Don't apply tmp - pending deletes aren't tracked in
156 mutex_unlock(&c->btree_interior_update_lock);
159 static void __btree_node_free(struct cache_set *c, struct btree *b,
160 struct btree_iter *iter)
162 trace_bcache_btree_node_free(c, b);
164 BUG_ON(b == btree_node_root(c, b));
166 BUG_ON(!list_empty(&b->write_blocked));
168 six_lock_write(&b->lock);
170 if (btree_node_dirty(b))
171 bch_btree_complete_write(c, b, btree_current_write(b));
172 clear_btree_node_dirty(b);
174 mca_hash_remove(c, b);
176 mutex_lock(&c->btree_cache_lock);
177 list_move(&b->list, &c->btree_cache_freeable);
178 mutex_unlock(&c->btree_cache_lock);
181 * By using six_unlock_write() directly instead of
182 * btree_node_unlock_write(), we don't update the iterator's sequence
183 * numbers and cause future btree_node_relock() calls to fail:
185 six_unlock_write(&b->lock);
188 void bch_btree_node_free_never_inserted(struct cache_set *c, struct btree *b)
190 struct open_bucket *ob = b->ob;
194 __btree_node_free(c, b, NULL);
196 bch_open_bucket_put(c, ob);
199 void bch_btree_node_free_inmem(struct btree_iter *iter, struct btree *b)
201 bch_btree_iter_node_drop_linked(iter, b);
203 __btree_node_free(iter->c, b, iter);
205 bch_btree_iter_node_drop(iter, b);
208 static void bch_btree_node_free_ondisk(struct cache_set *c,
209 struct pending_btree_node_free *pending)
211 struct bch_fs_usage stats = { 0 };
213 BUG_ON(!pending->index_update_done);
215 bch_mark_key(c, bkey_i_to_s_c(&pending->key),
216 -c->sb.btree_node_size, true,
217 gc_phase(GC_PHASE_PENDING_DELETE),
220 * Don't apply stats - pending deletes aren't tracked in
225 void btree_open_bucket_put(struct cache_set *c, struct btree *b)
227 bch_open_bucket_put(c, b->ob);
231 static struct btree *__bch_btree_node_alloc(struct cache_set *c,
233 struct disk_reservation *res,
237 struct open_bucket *ob;
239 unsigned reserve = use_reserve ? 0 : BTREE_NODE_RESERVE;
241 mutex_lock(&c->btree_reserve_cache_lock);
242 if (c->btree_reserve_cache_nr > reserve) {
243 struct btree_alloc *a =
244 &c->btree_reserve_cache[--c->btree_reserve_cache_nr];
247 bkey_copy(&tmp.k, &a->k);
248 mutex_unlock(&c->btree_reserve_cache_lock);
251 mutex_unlock(&c->btree_reserve_cache_lock);
254 /* alloc_sectors is weird, I suppose */
255 bkey_extent_init(&tmp.k);
256 tmp.k.k.size = c->sb.btree_node_size,
258 ob = bch_alloc_sectors(c, &c->btree_write_point,
259 bkey_i_to_extent(&tmp.k),
261 c->opts.metadata_replicas_required,
262 use_reserve ? RESERVE_BTREE : RESERVE_NONE,
267 if (tmp.k.k.size < c->sb.btree_node_size) {
268 bch_open_bucket_put(c, ob);
274 /* we hold cannibalize_lock: */
278 bkey_copy(&b->key, &tmp.k);
285 static struct btree *bch_btree_node_alloc(struct cache_set *c,
286 unsigned level, enum btree_id id,
287 struct btree_reserve *reserve)
291 BUG_ON(!reserve->nr);
293 b = reserve->b[--reserve->nr];
295 BUG_ON(mca_hash_insert(c, b, level, id));
297 set_btree_node_accessed(b);
298 set_btree_node_dirty(b);
300 bch_bset_init_first(b, &b->data->keys);
301 memset(&b->nr, 0, sizeof(b->nr));
302 b->data->magic = cpu_to_le64(bset_magic(c));
304 SET_BTREE_NODE_ID(b->data, id);
305 SET_BTREE_NODE_LEVEL(b->data, level);
306 b->data->ptr = bkey_i_to_extent(&b->key)->v.start->ptr;
308 bch_btree_build_aux_trees(b);
310 bch_check_mark_super(c, &b->key, true);
312 trace_bcache_btree_node_alloc(c, b);
316 struct btree *__btree_node_alloc_replacement(struct cache_set *c,
318 struct bkey_format format,
319 struct btree_reserve *reserve)
323 n = bch_btree_node_alloc(c, b->level, b->btree_id, reserve);
325 n->data->min_key = b->data->min_key;
326 n->data->max_key = b->data->max_key;
327 n->data->format = format;
329 btree_node_set_format(n, format);
331 bch_btree_sort_into(c, n, b);
333 btree_node_reset_sib_u64s(n);
335 n->key.k.p = b->key.k.p;
336 trace_bcache_btree_node_alloc_replacement(c, b, n);
341 struct btree *btree_node_alloc_replacement(struct cache_set *c,
343 struct btree_reserve *reserve)
345 struct bkey_format new_f = bch_btree_calc_format(b);
348 * The keys might expand with the new format - if they wouldn't fit in
349 * the btree node anymore, use the old format for now:
351 if (!bch_btree_node_format_fits(c, b, &new_f))
354 return __btree_node_alloc_replacement(c, b, new_f, reserve);
357 static void bch_btree_set_root_inmem(struct cache_set *c, struct btree *b,
358 struct btree_reserve *btree_reserve)
360 struct btree *old = btree_node_root(c, b);
362 /* Root nodes cannot be reaped */
363 mutex_lock(&c->btree_cache_lock);
364 list_del_init(&b->list);
365 mutex_unlock(&c->btree_cache_lock);
367 mutex_lock(&c->btree_root_lock);
368 btree_node_root(c, b) = b;
369 mutex_unlock(&c->btree_root_lock);
373 * New allocation (we're not being called because we're in
374 * bch_btree_root_read()) - do marking while holding
377 struct bch_fs_usage stats = { 0 };
379 bch_mark_key(c, bkey_i_to_s_c(&b->key),
380 c->sb.btree_node_size, true,
381 gc_pos_btree_root(b->btree_id),
385 bch_btree_node_free_index(c, NULL, old->btree_id,
386 bkey_i_to_s_c(&old->key),
388 bch_fs_stats_apply(c, &stats, &btree_reserve->disk_res,
389 gc_pos_btree_root(b->btree_id));
392 bch_recalc_btree_reserve(c);
395 static void bch_btree_set_root_ondisk(struct cache_set *c, struct btree *b)
397 struct btree_root *r = &c->btree_roots[b->btree_id];
399 mutex_lock(&c->btree_root_lock);
402 bkey_copy(&r->key, &b->key);
406 mutex_unlock(&c->btree_root_lock);
410 * Only for cache set bringup, when first reading the btree roots or allocating
411 * btree roots when initializing a new cache set:
413 void bch_btree_set_root_initial(struct cache_set *c, struct btree *b,
414 struct btree_reserve *btree_reserve)
416 BUG_ON(btree_node_root(c, b));
418 bch_btree_set_root_inmem(c, b, btree_reserve);
419 bch_btree_set_root_ondisk(c, b);
423 * bch_btree_set_root - update the root in memory and on disk
425 * To ensure forward progress, the current task must not be holding any
426 * btree node write locks. However, you must hold an intent lock on the
429 * Note: This allocates a journal entry but doesn't add any keys to
430 * it. All the btree roots are part of every journal write, so there
431 * is nothing new to be done. This just guarantees that there is a
434 static void bch_btree_set_root(struct btree_iter *iter, struct btree *b,
435 struct btree_interior_update *as,
436 struct btree_reserve *btree_reserve)
438 struct cache_set *c = iter->c;
441 trace_bcache_btree_set_root(c, b);
444 old = btree_node_root(c, b);
447 * Ensure no one is using the old root while we switch to the
450 btree_node_lock_write(old, iter);
452 bch_btree_set_root_inmem(c, b, btree_reserve);
454 btree_interior_update_updated_root(c, as, iter->btree_id);
457 * Unlock old root after new root is visible:
459 * The new root isn't persistent, but that's ok: we still have
460 * an intent lock on the new root, and any updates that would
461 * depend on the new root would have to update the new root.
463 btree_node_unlock_write(old, iter);
466 static struct btree *__btree_root_alloc(struct cache_set *c, unsigned level,
468 struct btree_reserve *reserve)
470 struct btree *b = bch_btree_node_alloc(c, level, id, reserve);
472 b->data->min_key = POS_MIN;
473 b->data->max_key = POS_MAX;
474 b->data->format = bch_btree_calc_format(b);
475 b->key.k.p = POS_MAX;
477 btree_node_set_format(b, b->data->format);
478 bch_btree_build_aux_trees(b);
480 six_unlock_write(&b->lock);
485 void bch_btree_reserve_put(struct cache_set *c, struct btree_reserve *reserve)
487 bch_disk_reservation_put(c, &reserve->disk_res);
489 mutex_lock(&c->btree_reserve_cache_lock);
491 while (reserve->nr) {
492 struct btree *b = reserve->b[--reserve->nr];
494 six_unlock_write(&b->lock);
496 if (c->btree_reserve_cache_nr <
497 ARRAY_SIZE(c->btree_reserve_cache)) {
498 struct btree_alloc *a =
499 &c->btree_reserve_cache[c->btree_reserve_cache_nr++];
503 bkey_copy(&a->k, &b->key);
505 bch_open_bucket_put(c, b->ob);
509 __btree_node_free(c, b, NULL);
511 six_unlock_intent(&b->lock);
514 mutex_unlock(&c->btree_reserve_cache_lock);
516 mempool_free(reserve, &c->btree_reserve_pool);
519 static struct btree_reserve *__bch_btree_reserve_get(struct cache_set *c,
524 struct btree_reserve *reserve;
526 struct disk_reservation disk_res = { 0, 0 };
527 unsigned sectors = nr_nodes * c->sb.btree_node_size;
528 int ret, disk_res_flags = BCH_DISK_RESERVATION_GC_LOCK_HELD|
529 BCH_DISK_RESERVATION_METADATA;
531 if (flags & BTREE_INSERT_NOFAIL)
532 disk_res_flags |= BCH_DISK_RESERVATION_NOFAIL;
535 * This check isn't necessary for correctness - it's just to potentially
536 * prevent us from doing a lot of work that'll end up being wasted:
538 ret = bch_journal_error(&c->journal);
542 if (bch_disk_reservation_get(c, &disk_res, sectors, disk_res_flags))
543 return ERR_PTR(-ENOSPC);
545 BUG_ON(nr_nodes > BTREE_RESERVE_MAX);
548 * Protects reaping from the btree node cache and using the btree node
549 * open bucket reserve:
551 ret = mca_cannibalize_lock(c, cl);
553 bch_disk_reservation_put(c, &disk_res);
557 reserve = mempool_alloc(&c->btree_reserve_pool, GFP_NOIO);
559 reserve->disk_res = disk_res;
562 while (reserve->nr < nr_nodes) {
563 b = __bch_btree_node_alloc(c, flags & BTREE_INSERT_USE_RESERVE,
570 reserve->b[reserve->nr++] = b;
573 mca_cannibalize_unlock(c);
576 bch_btree_reserve_put(c, reserve);
577 mca_cannibalize_unlock(c);
578 trace_bcache_btree_reserve_get_fail(c, nr_nodes, cl);
582 struct btree_reserve *bch_btree_reserve_get(struct cache_set *c,
584 unsigned extra_nodes,
588 unsigned depth = btree_node_root(c, b)->level - b->level;
589 unsigned nr_nodes = btree_reserve_required_nodes(depth) + extra_nodes;
591 return __bch_btree_reserve_get(c, nr_nodes, flags, cl);
595 int bch_btree_root_alloc(struct cache_set *c, enum btree_id id,
596 struct closure *writes)
599 struct btree_reserve *reserve;
602 closure_init_stack(&cl);
605 /* XXX haven't calculated capacity yet :/ */
606 reserve = __bch_btree_reserve_get(c, 1, 0, &cl);
607 if (!IS_ERR(reserve))
610 if (PTR_ERR(reserve) == -ENOSPC)
611 return PTR_ERR(reserve);
616 b = __btree_root_alloc(c, 0, id, reserve);
618 bch_btree_node_write(c, b, writes, SIX_LOCK_intent, -1);
620 bch_btree_set_root_initial(c, b, reserve);
621 btree_open_bucket_put(c, b);
622 six_unlock_intent(&b->lock);
624 bch_btree_reserve_put(c, reserve);
629 static void bch_insert_fixup_btree_ptr(struct btree_iter *iter,
631 struct bkey_i *insert,
632 struct btree_node_iter *node_iter,
633 struct disk_reservation *disk_res)
635 struct cache_set *c = iter->c;
636 struct bch_fs_usage stats = { 0 };
637 struct bkey_packed *k;
640 if (bkey_extent_is_data(&insert->k))
641 bch_mark_key(c, bkey_i_to_s_c(insert),
642 c->sb.btree_node_size, true,
643 gc_pos_btree_node(b), &stats, 0);
645 while ((k = bch_btree_node_iter_peek_all(node_iter, b)) &&
646 !btree_iter_pos_cmp_packed(b, &insert->k.p, k, false))
647 bch_btree_node_iter_advance(node_iter, b);
650 * If we're overwriting, look up pending delete and mark so that gc
651 * marks it on the pending delete list:
653 if (k && !bkey_cmp_packed(b, k, &insert->k))
654 bch_btree_node_free_index(c, b, iter->btree_id,
655 bkey_disassemble(b, k, &tmp),
658 bch_fs_stats_apply(c, &stats, disk_res, gc_pos_btree_node(b));
660 bch_btree_bset_insert_key(iter, b, node_iter, insert);
661 set_btree_node_dirty(b);
664 /* Inserting into a given leaf node (last stage of insert): */
666 /* Handle overwrites and do insert, for non extents: */
667 bool bch_btree_bset_insert_key(struct btree_iter *iter,
669 struct btree_node_iter *node_iter,
670 struct bkey_i *insert)
672 const struct bkey_format *f = &b->format;
673 struct bkey_packed *k;
675 unsigned clobber_u64s;
677 EBUG_ON(btree_node_just_written(b));
678 EBUG_ON(bset_written(b, btree_bset_last(b)));
679 EBUG_ON(bkey_deleted(&insert->k) && bkey_val_u64s(&insert->k));
680 EBUG_ON(bkey_cmp(bkey_start_pos(&insert->k), b->data->min_key) < 0 ||
681 bkey_cmp(insert->k.p, b->data->max_key) > 0);
682 BUG_ON(insert->k.u64s > bch_btree_keys_u64s_remaining(iter->c, b));
684 k = bch_btree_node_iter_peek_all(node_iter, b);
685 if (k && !bkey_cmp_packed(b, k, &insert->k)) {
686 BUG_ON(bkey_whiteout(k));
688 t = bch_bkey_to_bset(b, k);
690 if (bset_unwritten(b, bset(b, t)) &&
691 bkey_val_u64s(&insert->k) == bkeyp_val_u64s(f, k)) {
692 BUG_ON(bkey_whiteout(k) != bkey_whiteout(&insert->k));
694 k->type = insert->k.type;
695 memcpy_u64s(bkeyp_val(f, k), &insert->v,
696 bkey_val_u64s(&insert->k));
700 insert->k.needs_whiteout = k->needs_whiteout;
702 btree_keys_account_key_drop(&b->nr, t - b->set, k);
704 if (t == bset_tree_last(b)) {
705 clobber_u64s = k->u64s;
708 * If we're deleting, and the key we're deleting doesn't
709 * need a whiteout (it wasn't overwriting a key that had
710 * been written to disk) - just delete it:
712 if (bkey_whiteout(&insert->k) && !k->needs_whiteout) {
713 bch_bset_delete(b, k, clobber_u64s);
714 bch_btree_node_iter_fix(iter, b, node_iter, t,
722 k->type = KEY_TYPE_DELETED;
723 bch_btree_node_iter_fix(iter, b, node_iter, t, k,
726 if (bkey_whiteout(&insert->k)) {
727 reserve_whiteout(b, t, k);
730 k->needs_whiteout = false;
734 * Deleting, but the key to delete wasn't found - nothing to do:
736 if (bkey_whiteout(&insert->k))
739 insert->k.needs_whiteout = false;
742 t = bset_tree_last(b);
743 k = bch_btree_node_iter_bset_pos(node_iter, b, t);
746 bch_bset_insert(b, node_iter, k, insert, clobber_u64s);
747 if (k->u64s != clobber_u64s || bkey_whiteout(&insert->k))
748 bch_btree_node_iter_fix(iter, b, node_iter, t, k,
749 clobber_u64s, k->u64s);
753 static void __btree_node_flush(struct journal *j, struct journal_entry_pin *pin,
756 struct cache_set *c = container_of(j, struct cache_set, journal);
757 struct btree_write *w = container_of(pin, struct btree_write, journal);
758 struct btree *b = container_of(w, struct btree, writes[i]);
760 six_lock_read(&b->lock);
762 * Reusing a btree node can race with the journal reclaim code calling
763 * the journal pin flush fn, and there's no good fix for this: we don't
764 * really want journal_pin_drop() to block until the flush fn is no
765 * longer running, because journal_pin_drop() is called from the btree
766 * node write endio function, and we can't wait on the flush fn to
767 * finish running in mca_reap() - where we make reused btree nodes ready
768 * to use again - because there, we're holding the lock this function
771 * So, the b->level check is a hack so we don't try to write nodes we
775 bch_btree_node_write(c, b, NULL, SIX_LOCK_read, i);
776 six_unlock_read(&b->lock);
779 static void btree_node_flush0(struct journal *j, struct journal_entry_pin *pin)
781 return __btree_node_flush(j, pin, 0);
784 static void btree_node_flush1(struct journal *j, struct journal_entry_pin *pin)
786 return __btree_node_flush(j, pin, 1);
789 void bch_btree_journal_key(struct btree_insert *trans,
790 struct btree_iter *iter,
791 struct bkey_i *insert)
793 struct cache_set *c = trans->c;
794 struct journal *j = &c->journal;
795 struct btree *b = iter->nodes[0];
796 struct btree_write *w = btree_current_write(b);
798 EBUG_ON(iter->level || b->level);
799 EBUG_ON(!trans->journal_res.ref &&
800 test_bit(JOURNAL_REPLAY_DONE, &j->flags));
802 if (!journal_pin_active(&w->journal))
803 bch_journal_pin_add(j, &w->journal,
804 btree_node_write_idx(b) == 0
806 : btree_node_flush1);
808 if (trans->journal_res.ref) {
809 u64 seq = trans->journal_res.seq;
810 bool needs_whiteout = insert->k.needs_whiteout;
813 * have a bug where we're seeing an extent with an invalid crc
814 * entry in the journal, trying to track it down:
816 BUG_ON(bkey_invalid(c, b->btree_id, bkey_i_to_s_c(insert)));
819 insert->k.needs_whiteout = false;
820 bch_journal_add_keys(j, &trans->journal_res,
821 b->btree_id, insert);
822 insert->k.needs_whiteout = needs_whiteout;
824 if (trans->journal_seq)
825 *trans->journal_seq = seq;
826 btree_bset_last(b)->journal_seq = cpu_to_le64(seq);
829 if (!btree_node_dirty(b))
830 set_btree_node_dirty(b);
833 static enum btree_insert_ret
834 bch_insert_fixup_key(struct btree_insert *trans,
835 struct btree_insert_entry *insert)
837 struct btree_iter *iter = insert->iter;
841 if (bch_btree_bset_insert_key(iter,
843 &iter->node_iters[0],
845 bch_btree_journal_key(trans, iter, insert->k);
847 trans->did_work = true;
848 return BTREE_INSERT_OK;
851 static void verify_keys_sorted(struct keylist *l)
853 #ifdef CONFIG_BCACHE_DEBUG
856 for_each_keylist_key(l, k)
857 BUG_ON(bkey_next(k) != l->top &&
858 bkey_cmp(k->k.p, bkey_next(k)->k.p) >= 0);
862 static void btree_node_lock_for_insert(struct btree *b, struct btree_iter *iter)
864 struct cache_set *c = iter->c;
866 btree_node_lock_write(b, iter);
868 if (btree_node_just_written(b) &&
869 bch_btree_post_write_cleanup(c, b))
870 bch_btree_iter_reinit_node(iter, b);
873 * If the last bset has been written, or if it's gotten too big - start
874 * a new bset to insert into:
876 if (want_new_bset(c, b))
877 bch_btree_init_next(c, b, iter);
880 /* Asynchronous interior node update machinery */
882 struct btree_interior_update *
883 bch_btree_interior_update_alloc(struct cache_set *c)
885 struct btree_interior_update *as;
887 as = mempool_alloc(&c->btree_interior_update_pool, GFP_NOIO);
888 memset(as, 0, sizeof(*as));
889 closure_init(&as->cl, &c->cl);
891 as->mode = BTREE_INTERIOR_NO_UPDATE;
893 bch_keylist_init(&as->parent_keys, as->inline_keys,
894 ARRAY_SIZE(as->inline_keys));
896 mutex_lock(&c->btree_interior_update_lock);
897 list_add(&as->list, &c->btree_interior_update_list);
898 mutex_unlock(&c->btree_interior_update_lock);
903 static void btree_interior_update_free(struct closure *cl)
905 struct btree_interior_update *as = container_of(cl, struct btree_interior_update, cl);
907 mempool_free(as, &as->c->btree_interior_update_pool);
910 static void btree_interior_update_nodes_reachable(struct closure *cl)
912 struct btree_interior_update *as =
913 container_of(cl, struct btree_interior_update, cl);
914 struct cache_set *c = as->c;
917 bch_journal_pin_drop(&c->journal, &as->journal);
919 mutex_lock(&c->btree_interior_update_lock);
921 for (i = 0; i < as->nr_pending; i++)
922 bch_btree_node_free_ondisk(c, &as->pending[i]);
925 mutex_unlock(&c->btree_interior_update_lock);
927 mutex_lock(&c->btree_interior_update_lock);
929 mutex_unlock(&c->btree_interior_update_lock);
931 closure_wake_up(&as->wait);
933 closure_return_with_destructor(cl, btree_interior_update_free);
936 static void btree_interior_update_nodes_written(struct closure *cl)
938 struct btree_interior_update *as =
939 container_of(cl, struct btree_interior_update, cl);
940 struct cache_set *c = as->c;
943 if (bch_journal_error(&c->journal)) {
947 /* XXX: missing error handling, damnit */
949 /* check for journal error, bail out if we flushed */
952 * We did an update to a parent node where the pointers we added pointed
953 * to child nodes that weren't written yet: now, the child nodes have
954 * been written so we can write out the update to the interior node.
957 mutex_lock(&c->btree_interior_update_lock);
959 case BTREE_INTERIOR_NO_UPDATE:
961 case BTREE_INTERIOR_UPDATING_NODE:
962 /* The usual case: */
963 b = READ_ONCE(as->b);
965 if (!six_trylock_read(&b->lock)) {
966 mutex_unlock(&c->btree_interior_update_lock);
967 six_lock_read(&b->lock);
968 six_unlock_read(&b->lock);
972 BUG_ON(!btree_node_dirty(b));
973 closure_wait(&btree_current_write(b)->wait, cl);
975 list_del(&as->write_blocked_list);
977 if (list_empty(&b->write_blocked))
978 bch_btree_node_write(c, b, NULL, SIX_LOCK_read, -1);
979 six_unlock_read(&b->lock);
982 case BTREE_INTERIOR_UPDATING_AS:
984 * The btree node we originally updated has been freed and is
985 * being rewritten - so we need to write anything here, we just
986 * need to signal to that btree_interior_update that it's ok to make the
987 * new replacement node visible:
989 closure_put(&as->parent_as->cl);
992 * and then we have to wait on that btree_interior_update to finish:
994 closure_wait(&as->parent_as->wait, cl);
997 case BTREE_INTERIOR_UPDATING_ROOT:
998 /* b is the new btree root: */
999 b = READ_ONCE(as->b);
1001 if (!six_trylock_read(&b->lock)) {
1002 mutex_unlock(&c->btree_interior_update_lock);
1003 six_lock_read(&b->lock);
1004 six_unlock_read(&b->lock);
1008 BUG_ON(c->btree_roots[b->btree_id].as != as);
1009 c->btree_roots[b->btree_id].as = NULL;
1011 bch_btree_set_root_ondisk(c, b);
1014 * We don't have to wait anything anything here (before
1015 * btree_interior_update_nodes_reachable frees the old nodes
1016 * ondisk) - we've ensured that the very next journal write will
1017 * have the pointer to the new root, and before the allocator
1018 * can reuse the old nodes it'll have to do a journal commit:
1020 six_unlock_read(&b->lock);
1022 mutex_unlock(&c->btree_interior_update_lock);
1024 continue_at(cl, btree_interior_update_nodes_reachable, system_wq);
1028 * We're updating @b with pointers to nodes that haven't finished writing yet:
1029 * block @b from being written until @as completes
1031 static void btree_interior_update_updated_btree(struct cache_set *c,
1032 struct btree_interior_update *as,
1035 mutex_lock(&c->btree_interior_update_lock);
1037 BUG_ON(as->mode != BTREE_INTERIOR_NO_UPDATE);
1038 BUG_ON(!btree_node_dirty(b));
1040 as->mode = BTREE_INTERIOR_UPDATING_NODE;
1042 list_add(&as->write_blocked_list, &b->write_blocked);
1044 mutex_unlock(&c->btree_interior_update_lock);
1046 bch_journal_wait_on_seq(&c->journal, as->journal_seq, &as->cl);
1048 continue_at(&as->cl, btree_interior_update_nodes_written,
1049 system_freezable_wq);
1052 static void btree_interior_update_updated_root(struct cache_set *c,
1053 struct btree_interior_update *as,
1054 enum btree_id btree_id)
1056 struct btree_root *r = &c->btree_roots[btree_id];
1058 mutex_lock(&c->btree_interior_update_lock);
1060 BUG_ON(as->mode != BTREE_INTERIOR_NO_UPDATE);
1063 * Old root might not be persistent yet - if so, redirect its
1064 * btree_interior_update operation to point to us:
1067 BUG_ON(r->as->mode != BTREE_INTERIOR_UPDATING_ROOT);
1070 r->as->mode = BTREE_INTERIOR_UPDATING_AS;
1071 r->as->parent_as = as;
1072 closure_get(&as->cl);
1075 as->mode = BTREE_INTERIOR_UPDATING_ROOT;
1079 mutex_unlock(&c->btree_interior_update_lock);
1081 bch_journal_wait_on_seq(&c->journal, as->journal_seq, &as->cl);
1083 continue_at(&as->cl, btree_interior_update_nodes_written,
1084 system_freezable_wq);
1087 static void interior_update_flush(struct journal *j, struct journal_entry_pin *pin)
1089 struct btree_interior_update *as =
1090 container_of(pin, struct btree_interior_update, journal);
1092 bch_journal_flush_seq_async(j, as->journal_seq, NULL);
1096 * @b is being split/rewritten: it may have pointers to not-yet-written btree
1097 * nodes and thus outstanding btree_interior_updates - redirect @b's
1098 * btree_interior_updates to point to this btree_interior_update:
1100 void bch_btree_interior_update_will_free_node(struct cache_set *c,
1101 struct btree_interior_update *as,
1104 struct btree_interior_update *p, *n;
1105 struct pending_btree_node_free *d;
1106 struct bset_tree *t;
1109 * Does this node have data that hasn't been written in the journal?
1111 * If so, we have to wait for the corresponding journal entry to be
1112 * written before making the new nodes reachable - we can't just carry
1113 * over the bset->journal_seq tracking, since we'll be mixing those keys
1114 * in with keys that aren't in the journal anymore:
1117 as->journal_seq = max(as->journal_seq, bset(b, t)->journal_seq);
1120 * Does this node have unwritten data that has a pin on the journal?
1122 * If so, transfer that pin to the btree_interior_update operation -
1123 * note that if we're freeing multiple nodes, we only need to keep the
1124 * oldest pin of any of the nodes we're freeing. We'll release the pin
1125 * when the new nodes are persistent and reachable on disk:
1127 bch_journal_pin_add_if_older(&c->journal,
1128 &b->writes[0].journal,
1129 &as->journal, interior_update_flush);
1130 bch_journal_pin_add_if_older(&c->journal,
1131 &b->writes[1].journal,
1132 &as->journal, interior_update_flush);
1134 mutex_lock(&c->btree_interior_update_lock);
1137 * Does this node have any btree_interior_update operations preventing
1138 * it from being written?
1140 * If so, redirect them to point to this btree_interior_update: we can
1141 * write out our new nodes, but we won't make them visible until those
1142 * operations complete
1144 list_for_each_entry_safe(p, n, &b->write_blocked, write_blocked_list) {
1145 BUG_ON(p->mode != BTREE_INTERIOR_UPDATING_NODE);
1147 p->mode = BTREE_INTERIOR_UPDATING_AS;
1148 list_del(&p->write_blocked_list);
1151 closure_get(&as->cl);
1154 /* Add this node to the list of nodes being freed: */
1155 BUG_ON(as->nr_pending >= ARRAY_SIZE(as->pending));
1157 d = &as->pending[as->nr_pending++];
1158 d->index_update_done = false;
1159 d->seq = b->data->keys.seq;
1160 d->btree_id = b->btree_id;
1161 d->level = b->level;
1162 bkey_copy(&d->key, &b->key);
1164 mutex_unlock(&c->btree_interior_update_lock);
1167 static void btree_node_interior_verify(struct btree *b)
1169 struct btree_node_iter iter;
1170 struct bkey_packed *k;
1174 bch_btree_node_iter_init(&iter, b, b->key.k.p, false, false);
1176 BUG_ON(!(k = bch_btree_node_iter_peek(&iter, b)) ||
1177 bkey_cmp_left_packed(b, k, &b->key.k.p));
1179 BUG_ON((bch_btree_node_iter_advance(&iter, b),
1180 !bch_btree_node_iter_end(&iter)));
1185 k = bch_btree_node_iter_peek(&iter, b);
1189 msg = "isn't what it should be";
1190 if (bkey_cmp_left_packed(b, k, &b->key.k.p))
1193 bch_btree_node_iter_advance(&iter, b);
1195 msg = "isn't last key";
1196 if (!bch_btree_node_iter_end(&iter))
1200 bch_dump_btree_node(b);
1201 printk(KERN_ERR "last key %llu:%llu %s\n", b->key.k.p.inode,
1202 b->key.k.p.offset, msg);
1207 static enum btree_insert_ret
1208 bch_btree_insert_keys_interior(struct btree *b,
1209 struct btree_iter *iter,
1210 struct keylist *insert_keys,
1211 struct btree_interior_update *as,
1212 struct btree_reserve *res)
1214 struct cache_set *c = iter->c;
1215 struct btree_iter *linked;
1216 struct btree_node_iter node_iter;
1217 struct bkey_i *insert = bch_keylist_front(insert_keys);
1218 struct bkey_packed *k;
1220 BUG_ON(!btree_node_intent_locked(iter, btree_node_root(c, b)->level));
1222 BUG_ON(!as || as->b);
1223 verify_keys_sorted(insert_keys);
1225 btree_node_lock_for_insert(b, iter);
1227 if (bch_keylist_u64s(insert_keys) >
1228 bch_btree_keys_u64s_remaining(c, b)) {
1229 btree_node_unlock_write(b, iter);
1230 return BTREE_INSERT_BTREE_NODE_FULL;
1233 /* Don't screw up @iter's position: */
1234 node_iter = iter->node_iters[b->level];
1237 * btree_split(), btree_gc_coalesce() will insert keys before
1238 * the iterator's current position - they know the keys go in
1239 * the node the iterator points to:
1241 while ((k = bch_btree_node_iter_prev_all(&node_iter, b)) &&
1242 (bkey_cmp_packed(b, k, &insert->k) >= 0))
1245 while (!bch_keylist_empty(insert_keys)) {
1246 insert = bch_keylist_front(insert_keys);
1248 bch_insert_fixup_btree_ptr(iter, b, insert,
1249 &node_iter, &res->disk_res);
1250 bch_keylist_pop_front(insert_keys);
1253 btree_interior_update_updated_btree(c, as, b);
1255 for_each_linked_btree_node(iter, b, linked)
1256 bch_btree_node_iter_peek(&linked->node_iters[b->level],
1258 bch_btree_node_iter_peek(&iter->node_iters[b->level], b);
1260 bch_btree_iter_verify(iter, b);
1262 if (bch_maybe_compact_whiteouts(c, b))
1263 bch_btree_iter_reinit_node(iter, b);
1265 btree_node_unlock_write(b, iter);
1267 btree_node_interior_verify(b);
1268 return BTREE_INSERT_OK;
1272 * Move keys from n1 (original replacement node, now lower node) to n2 (higher
1275 static struct btree *__btree_split_node(struct btree_iter *iter, struct btree *n1,
1276 struct btree_reserve *reserve)
1278 size_t nr_packed = 0, nr_unpacked = 0;
1280 struct bset *set1, *set2;
1281 struct bkey_packed *k, *prev = NULL;
1283 n2 = bch_btree_node_alloc(iter->c, n1->level, iter->btree_id, reserve);
1284 n2->data->max_key = n1->data->max_key;
1285 n2->data->format = n1->format;
1286 n2->key.k.p = n1->key.k.p;
1288 btree_node_set_format(n2, n2->data->format);
1290 set1 = btree_bset_first(n1);
1291 set2 = btree_bset_first(n2);
1294 * Has to be a linear search because we don't have an auxiliary
1299 if (bkey_next(k) == vstruct_last(set1))
1301 if (k->_data - set1->_data >= (le16_to_cpu(set1->u64s) * 3) / 5)
1315 n1->key.k.p = bkey_unpack_pos(n1, prev);
1316 n1->data->max_key = n1->key.k.p;
1318 btree_type_successor(n1->btree_id, n1->key.k.p);
1320 set2->u64s = cpu_to_le16((u64 *) vstruct_end(set1) - (u64 *) k);
1321 set1->u64s = cpu_to_le16(le16_to_cpu(set1->u64s) - le16_to_cpu(set2->u64s));
1323 set_btree_bset_end(n1, n1->set);
1324 set_btree_bset_end(n2, n2->set);
1326 n2->nr.live_u64s = le16_to_cpu(set2->u64s);
1327 n2->nr.bset_u64s[0] = le16_to_cpu(set2->u64s);
1328 n2->nr.packed_keys = n1->nr.packed_keys - nr_packed;
1329 n2->nr.unpacked_keys = n1->nr.unpacked_keys - nr_unpacked;
1331 n1->nr.live_u64s = le16_to_cpu(set1->u64s);
1332 n1->nr.bset_u64s[0] = le16_to_cpu(set1->u64s);
1333 n1->nr.packed_keys = nr_packed;
1334 n1->nr.unpacked_keys = nr_unpacked;
1336 BUG_ON(!set1->u64s);
1337 BUG_ON(!set2->u64s);
1339 memcpy_u64s(set2->start,
1341 le16_to_cpu(set2->u64s));
1343 btree_node_reset_sib_u64s(n1);
1344 btree_node_reset_sib_u64s(n2);
1346 bch_verify_btree_nr_keys(n1);
1347 bch_verify_btree_nr_keys(n2);
1350 btree_node_interior_verify(n1);
1351 btree_node_interior_verify(n2);
1358 * For updates to interior nodes, we've got to do the insert before we split
1359 * because the stuff we're inserting has to be inserted atomically. Post split,
1360 * the keys might have to go in different nodes and the split would no longer be
1363 * Worse, if the insert is from btree node coalescing, if we do the insert after
1364 * we do the split (and pick the pivot) - the pivot we pick might be between
1365 * nodes that were coalesced, and thus in the middle of a child node post
1368 static void btree_split_insert_keys(struct btree_iter *iter, struct btree *b,
1369 struct keylist *keys,
1370 struct btree_reserve *res)
1372 struct btree_node_iter node_iter;
1373 struct bkey_i *k = bch_keylist_front(keys);
1374 struct bkey_packed *p;
1377 BUG_ON(btree_node_type(b) != BKEY_TYPE_BTREE);
1379 bch_btree_node_iter_init(&node_iter, b, k->k.p, false, false);
1381 while (!bch_keylist_empty(keys)) {
1382 k = bch_keylist_front(keys);
1384 BUG_ON(bch_keylist_u64s(keys) >
1385 bch_btree_keys_u64s_remaining(iter->c, b));
1386 BUG_ON(bkey_cmp(k->k.p, b->data->min_key) < 0);
1387 BUG_ON(bkey_cmp(k->k.p, b->data->max_key) > 0);
1389 bch_insert_fixup_btree_ptr(iter, b, k, &node_iter, &res->disk_res);
1390 bch_keylist_pop_front(keys);
1394 * We can't tolerate whiteouts here - with whiteouts there can be
1395 * duplicate keys, and it would be rather bad if we picked a duplicate
1398 i = btree_bset_first(b);
1400 while (p != vstruct_last(i))
1401 if (bkey_deleted(p)) {
1402 le16_add_cpu(&i->u64s, -p->u64s);
1403 set_btree_bset_end(b, b->set);
1404 memmove_u64s_down(p, bkey_next(p),
1405 (u64 *) vstruct_last(i) -
1410 BUG_ON(b->nsets != 1 ||
1411 b->nr.live_u64s != le16_to_cpu(btree_bset_first(b)->u64s));
1413 btree_node_interior_verify(b);
1416 static void btree_split(struct btree *b, struct btree_iter *iter,
1417 struct keylist *insert_keys,
1418 struct btree_reserve *reserve,
1419 struct btree_interior_update *as)
1421 struct cache_set *c = iter->c;
1422 struct btree *parent = iter->nodes[b->level + 1];
1423 struct btree *n1, *n2 = NULL, *n3 = NULL;
1424 u64 start_time = local_clock();
1426 BUG_ON(!parent && (b != btree_node_root(c, b)));
1427 BUG_ON(!btree_node_intent_locked(iter, btree_node_root(c, b)->level));
1429 bch_btree_interior_update_will_free_node(c, as, b);
1431 n1 = btree_node_alloc_replacement(c, b, reserve);
1433 btree_split_insert_keys(iter, n1, insert_keys, reserve);
1435 if (vstruct_blocks(n1->data, c->block_bits) > BTREE_SPLIT_THRESHOLD(c)) {
1436 trace_bcache_btree_node_split(c, b, b->nr.live_u64s);
1438 n2 = __btree_split_node(iter, n1, reserve);
1440 bch_btree_build_aux_trees(n2);
1441 bch_btree_build_aux_trees(n1);
1442 six_unlock_write(&n2->lock);
1443 six_unlock_write(&n1->lock);
1445 bch_btree_node_write(c, n2, &as->cl, SIX_LOCK_intent, -1);
1448 * Note that on recursive parent_keys == insert_keys, so we
1449 * can't start adding new keys to parent_keys before emptying it
1450 * out (which we did with btree_split_insert_keys() above)
1452 bch_keylist_add(&as->parent_keys, &n1->key);
1453 bch_keylist_add(&as->parent_keys, &n2->key);
1456 /* Depth increases, make a new root */
1457 n3 = __btree_root_alloc(c, b->level + 1,
1460 n3->sib_u64s[0] = U16_MAX;
1461 n3->sib_u64s[1] = U16_MAX;
1463 btree_split_insert_keys(iter, n3, &as->parent_keys,
1465 bch_btree_node_write(c, n3, &as->cl, SIX_LOCK_intent, -1);
1468 trace_bcache_btree_node_compact(c, b, b->nr.live_u64s);
1470 bch_btree_build_aux_trees(n1);
1471 six_unlock_write(&n1->lock);
1473 bch_keylist_add(&as->parent_keys, &n1->key);
1476 bch_btree_node_write(c, n1, &as->cl, SIX_LOCK_intent, -1);
1478 /* New nodes all written, now make them visible: */
1481 /* Split a non root node */
1482 bch_btree_insert_node(parent, iter, &as->parent_keys,
1485 bch_btree_set_root(iter, n3, as, reserve);
1487 /* Root filled up but didn't need to be split */
1488 bch_btree_set_root(iter, n1, as, reserve);
1491 btree_open_bucket_put(c, n1);
1493 btree_open_bucket_put(c, n2);
1495 btree_open_bucket_put(c, n3);
1498 * Note - at this point other linked iterators could still have @b read
1499 * locked; we're depending on the bch_btree_iter_node_replace() calls
1500 * below removing all references to @b so we don't return with other
1501 * iterators pointing to a node they have locked that's been freed.
1503 * We have to free the node first because the bch_iter_node_replace()
1504 * calls will drop _our_ iterator's reference - and intent lock - to @b.
1506 bch_btree_node_free_inmem(iter, b);
1508 /* Successful split, update the iterator to point to the new nodes: */
1511 bch_btree_iter_node_replace(iter, n3);
1513 bch_btree_iter_node_replace(iter, n2);
1514 bch_btree_iter_node_replace(iter, n1);
1516 bch_time_stats_update(&c->btree_split_time, start_time);
1520 * bch_btree_insert_node - insert bkeys into a given btree node
1522 * @iter: btree iterator
1523 * @insert_keys: list of keys to insert
1524 * @hook: insert callback
1525 * @persistent: if not null, @persistent will wait on journal write
1527 * Inserts as many keys as it can into a given btree node, splitting it if full.
1528 * If a split occurred, this function will return early. This can only happen
1529 * for leaf nodes -- inserts into interior nodes have to be atomic.
1531 void bch_btree_insert_node(struct btree *b,
1532 struct btree_iter *iter,
1533 struct keylist *insert_keys,
1534 struct btree_reserve *reserve,
1535 struct btree_interior_update *as)
1538 BUG_ON(!reserve || !as);
1540 switch (bch_btree_insert_keys_interior(b, iter, insert_keys,
1542 case BTREE_INSERT_OK:
1544 case BTREE_INSERT_BTREE_NODE_FULL:
1545 btree_split(b, iter, insert_keys, reserve, as);
1552 static int bch_btree_split_leaf(struct btree_iter *iter, unsigned flags)
1554 struct cache_set *c = iter->c;
1555 struct btree *b = iter->nodes[0];
1556 struct btree_reserve *reserve;
1557 struct btree_interior_update *as;
1561 closure_init_stack(&cl);
1563 /* Hack, because gc and splitting nodes doesn't mix yet: */
1564 if (!down_read_trylock(&c->gc_lock)) {
1565 bch_btree_iter_unlock(iter);
1566 down_read(&c->gc_lock);
1570 * XXX: figure out how far we might need to split,
1571 * instead of locking/reserving all the way to the root:
1573 if (!bch_btree_iter_set_locks_want(iter, U8_MAX)) {
1578 reserve = bch_btree_reserve_get(c, b, 0, flags, &cl);
1579 if (IS_ERR(reserve)) {
1580 ret = PTR_ERR(reserve);
1581 if (ret == -EAGAIN) {
1582 bch_btree_iter_unlock(iter);
1583 up_read(&c->gc_lock);
1590 as = bch_btree_interior_update_alloc(c);
1592 btree_split(b, iter, NULL, reserve, as);
1593 bch_btree_reserve_put(c, reserve);
1595 bch_btree_iter_set_locks_want(iter, 1);
1597 up_read(&c->gc_lock);
1601 enum btree_node_sibling {
1606 static struct btree *btree_node_get_sibling(struct btree_iter *iter,
1608 enum btree_node_sibling sib)
1610 struct btree *parent;
1611 struct btree_node_iter node_iter;
1612 struct bkey_packed *k;
1615 unsigned level = b->level;
1617 parent = iter->nodes[level + 1];
1621 if (!btree_node_relock(iter, level + 1)) {
1622 bch_btree_iter_set_locks_want(iter, level + 2);
1623 return ERR_PTR(-EINTR);
1626 node_iter = iter->node_iters[parent->level];
1628 k = bch_btree_node_iter_peek_all(&node_iter, parent);
1629 BUG_ON(bkey_cmp_left_packed(parent, k, &b->key.k.p));
1632 k = sib == btree_prev_sib
1633 ? bch_btree_node_iter_prev_all(&node_iter, parent)
1634 : (bch_btree_node_iter_advance(&node_iter, parent),
1635 bch_btree_node_iter_peek_all(&node_iter, parent));
1638 } while (bkey_deleted(k));
1640 bkey_unpack(parent, &tmp.k, k);
1642 ret = bch_btree_node_get(iter, &tmp.k, level, SIX_LOCK_intent);
1644 if (IS_ERR(ret) && PTR_ERR(ret) == -EINTR) {
1645 btree_node_unlock(iter, level);
1646 ret = bch_btree_node_get(iter, &tmp.k, level, SIX_LOCK_intent);
1649 if (!IS_ERR(ret) && !btree_node_relock(iter, level)) {
1650 six_unlock_intent(&ret->lock);
1651 ret = ERR_PTR(-EINTR);
1657 static int __foreground_maybe_merge(struct btree_iter *iter,
1658 enum btree_node_sibling sib)
1660 struct cache_set *c = iter->c;
1661 struct btree_reserve *reserve;
1662 struct btree_interior_update *as;
1663 struct bkey_format_state new_s;
1664 struct bkey_format new_f;
1665 struct bkey_i delete;
1666 struct btree *b, *m, *n, *prev, *next, *parent;
1671 closure_init_stack(&cl);
1673 if (!btree_node_relock(iter, iter->level))
1676 b = iter->nodes[iter->level];
1678 parent = iter->nodes[b->level + 1];
1682 if (b->sib_u64s[sib] > BTREE_FOREGROUND_MERGE_THRESHOLD(c))
1685 /* XXX: can't be holding read locks */
1686 m = btree_node_get_sibling(iter, b, sib);
1692 /* NULL means no sibling: */
1694 b->sib_u64s[sib] = U16_MAX;
1698 if (sib == btree_prev_sib) {
1706 bch_bkey_format_init(&new_s);
1707 __bch_btree_calc_format(&new_s, b);
1708 __bch_btree_calc_format(&new_s, m);
1709 new_f = bch_bkey_format_done(&new_s);
1711 sib_u64s = btree_node_u64s_with_format(b, &new_f) +
1712 btree_node_u64s_with_format(m, &new_f);
1714 if (sib_u64s > BTREE_FOREGROUND_MERGE_HYSTERESIS(c)) {
1715 sib_u64s -= BTREE_FOREGROUND_MERGE_HYSTERESIS(c);
1717 sib_u64s += BTREE_FOREGROUND_MERGE_HYSTERESIS(c);
1720 sib_u64s = min(sib_u64s, btree_max_u64s(c));
1721 b->sib_u64s[sib] = sib_u64s;
1723 if (b->sib_u64s[sib] > BTREE_FOREGROUND_MERGE_THRESHOLD(c)) {
1724 six_unlock_intent(&m->lock);
1728 /* We're changing btree topology, doesn't mix with gc: */
1729 if (!down_read_trylock(&c->gc_lock)) {
1730 six_unlock_intent(&m->lock);
1731 bch_btree_iter_unlock(iter);
1733 down_read(&c->gc_lock);
1734 up_read(&c->gc_lock);
1739 if (!bch_btree_iter_set_locks_want(iter, U8_MAX)) {
1744 reserve = bch_btree_reserve_get(c, b, 0,
1745 BTREE_INSERT_NOFAIL|
1746 BTREE_INSERT_USE_RESERVE,
1748 if (IS_ERR(reserve)) {
1749 ret = PTR_ERR(reserve);
1753 as = bch_btree_interior_update_alloc(c);
1755 bch_btree_interior_update_will_free_node(c, as, b);
1756 bch_btree_interior_update_will_free_node(c, as, m);
1758 n = bch_btree_node_alloc(c, b->level, b->btree_id, reserve);
1759 n->data->min_key = prev->data->min_key;
1760 n->data->max_key = next->data->max_key;
1761 n->data->format = new_f;
1762 n->key.k.p = next->key.k.p;
1764 btree_node_set_format(n, new_f);
1766 bch_btree_sort_into(c, n, prev);
1767 bch_btree_sort_into(c, n, next);
1769 bch_btree_build_aux_trees(n);
1770 six_unlock_write(&n->lock);
1772 bkey_init(&delete.k);
1773 delete.k.p = prev->key.k.p;
1774 bch_keylist_add(&as->parent_keys, &delete);
1775 bch_keylist_add(&as->parent_keys, &n->key);
1777 bch_btree_node_write(c, n, &as->cl, SIX_LOCK_intent, -1);
1779 bch_btree_insert_node(parent, iter, &as->parent_keys, reserve, as);
1781 btree_open_bucket_put(c, n);
1782 bch_btree_node_free_inmem(iter, b);
1783 bch_btree_node_free_inmem(iter, m);
1784 bch_btree_iter_node_replace(iter, n);
1786 bch_btree_iter_verify(iter, n);
1788 bch_btree_reserve_put(c, reserve);
1790 if (ret != -EINTR && ret != -EAGAIN)
1791 bch_btree_iter_set_locks_want(iter, 1);
1792 six_unlock_intent(&m->lock);
1793 up_read(&c->gc_lock);
1795 if (ret == -EAGAIN || ret == -EINTR) {
1796 bch_btree_iter_unlock(iter);
1802 if (ret == -EINTR) {
1803 ret = bch_btree_iter_traverse(iter);
1811 static int inline foreground_maybe_merge(struct btree_iter *iter,
1812 enum btree_node_sibling sib)
1814 struct cache_set *c = iter->c;
1817 if (!btree_node_locked(iter, iter->level))
1820 b = iter->nodes[iter->level];
1821 if (b->sib_u64s[sib] > BTREE_FOREGROUND_MERGE_THRESHOLD(c))
1824 return __foreground_maybe_merge(iter, sib);
1828 * btree_insert_key - insert a key one key into a leaf node
1830 static enum btree_insert_ret
1831 btree_insert_key(struct btree_insert *trans,
1832 struct btree_insert_entry *insert)
1834 struct cache_set *c = trans->c;
1835 struct btree_iter *iter = insert->iter;
1836 struct btree *b = iter->nodes[0];
1837 enum btree_insert_ret ret;
1838 int old_u64s = le16_to_cpu(btree_bset_last(b)->u64s);
1839 int old_live_u64s = b->nr.live_u64s;
1840 int live_u64s_added, u64s_added;
1842 ret = !btree_node_is_extents(b)
1843 ? bch_insert_fixup_key(trans, insert)
1844 : bch_insert_fixup_extent(trans, insert);
1846 live_u64s_added = (int) b->nr.live_u64s - old_live_u64s;
1847 u64s_added = (int) le16_to_cpu(btree_bset_last(b)->u64s) - old_u64s;
1849 if (b->sib_u64s[0] != U16_MAX && live_u64s_added < 0)
1850 b->sib_u64s[0] = max(0, (int) b->sib_u64s[0] + live_u64s_added);
1851 if (b->sib_u64s[1] != U16_MAX && live_u64s_added < 0)
1852 b->sib_u64s[1] = max(0, (int) b->sib_u64s[1] + live_u64s_added);
1854 if (u64s_added > live_u64s_added &&
1855 bch_maybe_compact_whiteouts(iter->c, b))
1856 bch_btree_iter_reinit_node(iter, b);
1858 trace_bcache_btree_insert_key(c, b, insert->k);
1862 static bool same_leaf_as_prev(struct btree_insert *trans,
1863 struct btree_insert_entry *i)
1866 * Because we sorted the transaction entries, if multiple iterators
1867 * point to the same leaf node they'll always be adjacent now:
1869 return i != trans->entries &&
1870 i[0].iter->nodes[0] == i[-1].iter->nodes[0];
1873 #define trans_for_each_entry(trans, i) \
1874 for ((i) = (trans)->entries; (i) < (trans)->entries + (trans)->nr; (i)++)
1876 static void multi_lock_write(struct btree_insert *trans)
1878 struct btree_insert_entry *i;
1880 trans_for_each_entry(trans, i)
1881 if (!same_leaf_as_prev(trans, i))
1882 btree_node_lock_for_insert(i->iter->nodes[0], i->iter);
1885 static void multi_unlock_write(struct btree_insert *trans)
1887 struct btree_insert_entry *i;
1889 trans_for_each_entry(trans, i)
1890 if (!same_leaf_as_prev(trans, i))
1891 btree_node_unlock_write(i->iter->nodes[0], i->iter);
1894 static int btree_trans_entry_cmp(const void *_l, const void *_r)
1896 const struct btree_insert_entry *l = _l;
1897 const struct btree_insert_entry *r = _r;
1899 return btree_iter_cmp(l->iter, r->iter);
1902 /* Normal update interface: */
1905 * __bch_btree_insert_at - insert keys at given iterator positions
1907 * This is main entry point for btree updates.
1910 * -EINTR: locking changed, this function should be called again. Only returned
1911 * if passed BTREE_INSERT_ATOMIC.
1912 * -EROFS: cache set read only
1913 * -EIO: journal or btree node IO error
1915 int __bch_btree_insert_at(struct btree_insert *trans)
1917 struct cache_set *c = trans->c;
1918 struct btree_insert_entry *i;
1919 struct btree_iter *split = NULL;
1920 bool cycle_gc_lock = false;
1924 trans_for_each_entry(trans, i) {
1925 EBUG_ON(i->iter->level);
1926 EBUG_ON(bkey_cmp(bkey_start_pos(&i->k->k), i->iter->pos));
1929 sort(trans->entries, trans->nr, sizeof(trans->entries[0]),
1930 btree_trans_entry_cmp, NULL);
1932 if (unlikely(!percpu_ref_tryget(&c->writes)))
1936 trans_for_each_entry(trans, i)
1937 if (!bch_btree_iter_set_locks_want(i->iter, 1))
1940 trans->did_work = false;
1942 trans_for_each_entry(trans, i)
1944 u64s += jset_u64s(i->k->k.u64s + i->extra_res);
1946 memset(&trans->journal_res, 0, sizeof(trans->journal_res));
1948 ret = !(trans->flags & BTREE_INSERT_JOURNAL_REPLAY)
1949 ? bch_journal_res_get(&c->journal,
1950 &trans->journal_res,
1956 multi_lock_write(trans);
1959 trans_for_each_entry(trans, i) {
1960 /* Multiple inserts might go to same leaf: */
1961 if (!same_leaf_as_prev(trans, i))
1965 * bch_btree_node_insert_fits() must be called under write lock:
1966 * with only an intent lock, another thread can still call
1967 * bch_btree_node_write(), converting an unwritten bset to a
1971 u64s += i->k->k.u64s + i->extra_res;
1972 if (!bch_btree_node_insert_fits(c,
1973 i->iter->nodes[0], u64s)) {
1982 cycle_gc_lock = false;
1984 trans_for_each_entry(trans, i) {
1988 switch (btree_insert_key(trans, i)) {
1989 case BTREE_INSERT_OK:
1992 case BTREE_INSERT_JOURNAL_RES_FULL:
1993 case BTREE_INSERT_NEED_TRAVERSE:
1996 case BTREE_INSERT_NEED_RESCHED:
1999 case BTREE_INSERT_BTREE_NODE_FULL:
2002 case BTREE_INSERT_ENOSPC:
2005 case BTREE_INSERT_NEED_GC_LOCK:
2006 cycle_gc_lock = true;
2013 if (!trans->did_work && (ret || split))
2017 multi_unlock_write(trans);
2018 bch_journal_res_put(&c->journal, &trans->journal_res);
2026 * hack: iterators are inconsistent when they hit end of leaf, until
2029 trans_for_each_entry(trans, i)
2030 if (i->iter->at_end_of_leaf)
2033 trans_for_each_entry(trans, i)
2034 if (!same_leaf_as_prev(trans, i)) {
2035 foreground_maybe_merge(i->iter, btree_prev_sib);
2036 foreground_maybe_merge(i->iter, btree_next_sib);
2039 /* make sure we didn't lose an error: */
2040 if (!ret && IS_ENABLED(CONFIG_BCACHE_DEBUG))
2041 trans_for_each_entry(trans, i)
2044 percpu_ref_put(&c->writes);
2048 * have to drop journal res before splitting, because splitting means
2049 * allocating new btree nodes, and holding a journal reservation
2050 * potentially blocks the allocator:
2052 ret = bch_btree_split_leaf(split, trans->flags);
2056 * if the split didn't have to drop locks the insert will still be
2057 * atomic (in the BTREE_INSERT_ATOMIC sense, what the caller peeked()
2058 * and is overwriting won't have changed)
2062 if (cycle_gc_lock) {
2063 down_read(&c->gc_lock);
2064 up_read(&c->gc_lock);
2067 if (ret == -EINTR) {
2068 trans_for_each_entry(trans, i) {
2069 int ret2 = bch_btree_iter_traverse(i->iter);
2077 * BTREE_ITER_ATOMIC means we have to return -EINTR if we
2080 if (!(trans->flags & BTREE_INSERT_ATOMIC))
2087 int bch_btree_insert_list_at(struct btree_iter *iter,
2088 struct keylist *keys,
2089 struct disk_reservation *disk_res,
2090 struct extent_insert_hook *hook,
2091 u64 *journal_seq, unsigned flags)
2093 BUG_ON(flags & BTREE_INSERT_ATOMIC);
2094 BUG_ON(bch_keylist_empty(keys));
2095 verify_keys_sorted(keys);
2097 while (!bch_keylist_empty(keys)) {
2098 /* need to traverse between each insert */
2099 int ret = bch_btree_iter_traverse(iter);
2103 ret = bch_btree_insert_at(iter->c, disk_res, hook,
2105 BTREE_INSERT_ENTRY(iter, bch_keylist_front(keys)));
2109 bch_keylist_pop_front(keys);
2116 * bch_btree_insert_check_key - insert dummy key into btree
2118 * We insert a random key on a cache miss, then compare exchange on it
2119 * once the cache promotion or backing device read completes. This
2120 * ensures that if this key is written to after the read, the read will
2121 * lose and not overwrite the key with stale data.
2124 * -EAGAIN: @iter->cl was put on a waitlist waiting for btree node allocation
2125 * -EINTR: btree node was changed while upgrading to write lock
2127 int bch_btree_insert_check_key(struct btree_iter *iter,
2128 struct bkey_i *check_key)
2130 struct bpos saved_pos = iter->pos;
2131 struct bkey_i_cookie *cookie;
2132 BKEY_PADDED(key) tmp;
2135 BUG_ON(bkey_cmp(iter->pos, bkey_start_pos(&check_key->k)));
2137 check_key->k.type = KEY_TYPE_COOKIE;
2138 set_bkey_val_bytes(&check_key->k, sizeof(struct bch_cookie));
2140 cookie = bkey_i_to_cookie(check_key);
2141 get_random_bytes(&cookie->v, sizeof(cookie->v));
2143 bkey_copy(&tmp.key, check_key);
2145 ret = bch_btree_insert_at(iter->c, NULL, NULL, NULL,
2146 BTREE_INSERT_ATOMIC,
2147 BTREE_INSERT_ENTRY(iter, &tmp.key));
2149 bch_btree_iter_rewind(iter, saved_pos);
2155 * bch_btree_insert - insert keys into the extent btree
2156 * @c: pointer to struct cache_set
2157 * @id: btree to insert into
2158 * @insert_keys: list of keys to insert
2159 * @hook: insert callback
2161 int bch_btree_insert(struct cache_set *c, enum btree_id id,
2163 struct disk_reservation *disk_res,
2164 struct extent_insert_hook *hook,
2165 u64 *journal_seq, int flags)
2167 struct btree_iter iter;
2170 bch_btree_iter_init_intent(&iter, c, id, bkey_start_pos(&k->k));
2172 ret = bch_btree_iter_traverse(&iter);
2176 ret = bch_btree_insert_at(c, disk_res, hook, journal_seq, flags,
2177 BTREE_INSERT_ENTRY(&iter, k));
2178 out: ret2 = bch_btree_iter_unlock(&iter);
2184 * bch_btree_update - like bch_btree_insert(), but asserts that we're
2185 * overwriting an existing key
2187 int bch_btree_update(struct cache_set *c, enum btree_id id,
2188 struct bkey_i *k, u64 *journal_seq)
2190 struct btree_iter iter;
2194 EBUG_ON(id == BTREE_ID_EXTENTS);
2196 bch_btree_iter_init_intent(&iter, c, id, k->k.p);
2198 u = bch_btree_iter_peek_with_holes(&iter);
2199 ret = btree_iter_err(u);
2203 if (bkey_deleted(u.k)) {
2204 bch_btree_iter_unlock(&iter);
2208 ret = bch_btree_insert_at(c, NULL, NULL, journal_seq, 0,
2209 BTREE_INSERT_ENTRY(&iter, k));
2210 bch_btree_iter_unlock(&iter);
2215 * bch_btree_delete_range - delete everything within a given range
2217 * Range is a half open interval - [start, end)
2219 int bch_btree_delete_range(struct cache_set *c, enum btree_id id,
2222 struct bversion version,
2223 struct disk_reservation *disk_res,
2224 struct extent_insert_hook *hook,
2227 struct btree_iter iter;
2231 bch_btree_iter_init_intent(&iter, c, id, start);
2233 while ((k = bch_btree_iter_peek(&iter)).k &&
2234 !(ret = btree_iter_err(k))) {
2235 unsigned max_sectors = KEY_SIZE_MAX & (~0 << c->block_bits);
2236 /* really shouldn't be using a bare, unpadded bkey_i */
2237 struct bkey_i delete;
2239 if (bkey_cmp(iter.pos, end) >= 0)
2242 bkey_init(&delete.k);
2245 * For extents, iter.pos won't necessarily be the same as
2246 * bkey_start_pos(k.k) (for non extents they always will be the
2247 * same). It's important that we delete starting from iter.pos
2248 * because the range we want to delete could start in the middle
2251 * (bch_btree_iter_peek() does guarantee that iter.pos >=
2252 * bkey_start_pos(k.k)).
2254 delete.k.p = iter.pos;
2255 delete.k.version = version;
2257 if (iter.is_extents) {
2259 * The extents btree is special - KEY_TYPE_DISCARD is
2260 * used for deletions, not KEY_TYPE_DELETED. This is an
2261 * internal implementation detail that probably
2262 * shouldn't be exposed (internally, KEY_TYPE_DELETED is
2263 * used as a proxy for k->size == 0):
2265 delete.k.type = KEY_TYPE_DISCARD;
2267 /* create the biggest key we can */
2268 bch_key_resize(&delete.k, max_sectors);
2269 bch_cut_back(end, &delete.k);
2272 ret = bch_btree_insert_at(c, disk_res, hook, journal_seq,
2273 BTREE_INSERT_NOFAIL,
2274 BTREE_INSERT_ENTRY(&iter, &delete));
2278 bch_btree_iter_cond_resched(&iter);
2281 bch_btree_iter_unlock(&iter);
2286 * bch_btree_node_rewrite - Rewrite/move a btree node
2288 * Returns 0 on success, -EINTR or -EAGAIN on failure (i.e.
2289 * btree_check_reserve() has to wait)
2291 int bch_btree_node_rewrite(struct btree_iter *iter, struct btree *b,
2294 struct cache_set *c = iter->c;
2295 struct btree *n, *parent = iter->nodes[b->level + 1];
2296 struct btree_reserve *reserve;
2297 struct btree_interior_update *as;
2298 unsigned flags = BTREE_INSERT_NOFAIL;
2301 * if caller is going to wait if allocating reserve fails, then this is
2302 * a rewrite that must succeed:
2305 flags |= BTREE_INSERT_USE_RESERVE;
2307 if (!bch_btree_iter_set_locks_want(iter, U8_MAX))
2310 reserve = bch_btree_reserve_get(c, b, 0, flags, cl);
2311 if (IS_ERR(reserve)) {
2312 trace_bcache_btree_gc_rewrite_node_fail(c, b);
2313 return PTR_ERR(reserve);
2316 as = bch_btree_interior_update_alloc(c);
2318 bch_btree_interior_update_will_free_node(c, as, b);
2320 n = btree_node_alloc_replacement(c, b, reserve);
2322 bch_btree_build_aux_trees(n);
2323 six_unlock_write(&n->lock);
2325 trace_bcache_btree_gc_rewrite_node(c, b);
2327 bch_btree_node_write(c, n, &as->cl, SIX_LOCK_intent, -1);
2330 bch_btree_insert_node(parent, iter,
2331 &keylist_single(&n->key),
2334 bch_btree_set_root(iter, n, as, reserve);
2337 btree_open_bucket_put(c, n);
2339 bch_btree_node_free_inmem(iter, b);
2341 BUG_ON(!bch_btree_iter_node_replace(iter, n));
2343 bch_btree_reserve_put(c, reserve);