1 // SPDX-License-Identifier: GPL-2.0
3 * Code for working with individual keys, and sorted sets of keys with in a
6 * Copyright 2012 Google, Inc.
9 #define pr_fmt(fmt) "bcache: %s() " fmt, __func__
14 #include <linux/console.h>
15 #include <linux/sched/clock.h>
16 #include <linux/random.h>
17 #include <linux/prefetch.h>
19 #ifdef CONFIG_BCACHE_DEBUG
21 void bch_dump_bset(struct btree_keys *b, struct bset *i, unsigned int set)
23 struct bkey *k, *next;
25 for (k = i->start; k < bset_bkey_last(i); k = next) {
28 pr_err("block %u key %u/%u: ", set,
29 (unsigned int) ((u64 *) k - i->d), i->keys);
32 b->ops->key_dump(b, k);
34 pr_cont("%llu:%llu\n", KEY_INODE(k), KEY_OFFSET(k));
36 if (next < bset_bkey_last(i) &&
37 bkey_cmp(k, b->ops->is_extents ?
38 &START_KEY(next) : next) > 0)
39 pr_err("Key skipped backwards\n");
43 void bch_dump_bucket(struct btree_keys *b)
48 for (i = 0; i <= b->nsets; i++)
49 bch_dump_bset(b, b->set[i].data,
50 bset_sector_offset(b, b->set[i].data));
54 int __bch_count_data(struct btree_keys *b)
57 struct btree_iter iter;
60 min_heap_init(&iter.heap, NULL, MAX_BSETS);
62 if (b->ops->is_extents)
63 for_each_key(b, k, &iter)
68 void __bch_check_keys(struct btree_keys *b, const char *fmt, ...)
71 struct bkey *k, *p = NULL;
72 struct btree_iter iter;
75 min_heap_init(&iter.heap, NULL, MAX_BSETS);
77 for_each_key(b, k, &iter) {
78 if (b->ops->is_extents) {
79 err = "Keys out of order";
80 if (p && bkey_cmp(&START_KEY(p), &START_KEY(k)) > 0)
83 if (bch_ptr_invalid(b, k))
86 err = "Overlapping keys";
87 if (p && bkey_cmp(p, &START_KEY(k)) > 0)
90 if (bch_ptr_bad(b, k))
93 err = "Duplicate keys";
94 if (p && !bkey_cmp(p, k))
100 err = "Key larger than btree node key";
101 if (p && bkey_cmp(p, &b->key) > 0)
112 panic("bch_check_keys error: %s:\n", err);
115 static void bch_btree_iter_next_check(struct btree_iter *iter)
117 struct bkey *k = iter->heap.data->k, *next = bkey_next(k);
119 if (next < iter->heap.data->end &&
120 bkey_cmp(k, iter->b->ops->is_extents ?
121 &START_KEY(next) : next) > 0) {
122 bch_dump_bucket(iter->b);
123 panic("Key skipped backwards\n");
129 static inline void bch_btree_iter_next_check(struct btree_iter *iter) {}
135 int __bch_keylist_realloc(struct keylist *l, unsigned int u64s)
137 size_t oldsize = bch_keylist_nkeys(l);
138 size_t newsize = oldsize + u64s;
139 uint64_t *old_keys = l->keys_p == l->inline_keys ? NULL : l->keys_p;
142 newsize = roundup_pow_of_two(newsize);
144 if (newsize <= KEYLIST_INLINE ||
145 roundup_pow_of_two(oldsize) == newsize)
148 new_keys = krealloc(old_keys, sizeof(uint64_t) * newsize, GFP_NOIO);
154 memcpy(new_keys, l->inline_keys, sizeof(uint64_t) * oldsize);
156 l->keys_p = new_keys;
157 l->top_p = new_keys + oldsize;
162 /* Pop the top key of keylist by pointing l->top to its previous key */
163 struct bkey *bch_keylist_pop(struct keylist *l)
165 struct bkey *k = l->keys;
170 while (bkey_next(k) != l->top)
176 /* Pop the bottom key of keylist and update l->top_p */
177 void bch_keylist_pop_front(struct keylist *l)
179 l->top_p -= bkey_u64s(l->keys);
183 bch_keylist_bytes(l));
186 /* Key/pointer manipulation */
188 void bch_bkey_copy_single_ptr(struct bkey *dest, const struct bkey *src,
191 BUG_ON(i > KEY_PTRS(src));
193 /* Only copy the header, key, and one pointer. */
194 memcpy(dest, src, 2 * sizeof(uint64_t));
195 dest->ptr[0] = src->ptr[i];
196 SET_KEY_PTRS(dest, 1);
197 /* We didn't copy the checksum so clear that bit. */
198 SET_KEY_CSUM(dest, 0);
201 bool __bch_cut_front(const struct bkey *where, struct bkey *k)
203 unsigned int i, len = 0;
205 if (bkey_cmp(where, &START_KEY(k)) <= 0)
208 if (bkey_cmp(where, k) < 0)
209 len = KEY_OFFSET(k) - KEY_OFFSET(where);
211 bkey_copy_key(k, where);
213 for (i = 0; i < KEY_PTRS(k); i++)
214 SET_PTR_OFFSET(k, i, PTR_OFFSET(k, i) + KEY_SIZE(k) - len);
216 BUG_ON(len > KEY_SIZE(k));
217 SET_KEY_SIZE(k, len);
221 bool __bch_cut_back(const struct bkey *where, struct bkey *k)
223 unsigned int len = 0;
225 if (bkey_cmp(where, k) >= 0)
228 BUG_ON(KEY_INODE(where) != KEY_INODE(k));
230 if (bkey_cmp(where, &START_KEY(k)) > 0)
231 len = KEY_OFFSET(where) - KEY_START(k);
233 bkey_copy_key(k, where);
235 BUG_ON(len > KEY_SIZE(k));
236 SET_KEY_SIZE(k, len);
240 /* Auxiliary search trees */
243 #define BKEY_MID_BITS 3
244 #define BKEY_EXPONENT_BITS 7
245 #define BKEY_MANTISSA_BITS (32 - BKEY_MID_BITS - BKEY_EXPONENT_BITS)
246 #define BKEY_MANTISSA_MASK ((1 << BKEY_MANTISSA_BITS) - 1)
249 unsigned int exponent:BKEY_EXPONENT_BITS;
250 unsigned int m:BKEY_MID_BITS;
251 unsigned int mantissa:BKEY_MANTISSA_BITS;
255 * BSET_CACHELINE was originally intended to match the hardware cacheline size -
256 * it used to be 64, but I realized the lookup code would touch slightly less
257 * memory if it was 128.
259 * It definites the number of bytes (in struct bset) per struct bkey_float in
260 * the auxiliar search tree - when we're done searching the bset_float tree we
261 * have this many bytes left that we do a linear search over.
263 * Since (after level 5) every level of the bset_tree is on a new cacheline,
264 * we're touching one fewer cacheline in the bset tree in exchange for one more
265 * cacheline in the linear search - but the linear search might stop before it
266 * gets to the second cacheline.
269 #define BSET_CACHELINE 128
271 /* Space required for the btree node keys */
272 static inline size_t btree_keys_bytes(struct btree_keys *b)
274 return PAGE_SIZE << b->page_order;
277 static inline size_t btree_keys_cachelines(struct btree_keys *b)
279 return btree_keys_bytes(b) / BSET_CACHELINE;
282 /* Space required for the auxiliary search trees */
283 static inline size_t bset_tree_bytes(struct btree_keys *b)
285 return btree_keys_cachelines(b) * sizeof(struct bkey_float);
288 /* Space required for the prev pointers */
289 static inline size_t bset_prev_bytes(struct btree_keys *b)
291 return btree_keys_cachelines(b) * sizeof(uint8_t);
294 /* Memory allocation */
296 void bch_btree_keys_free(struct btree_keys *b)
298 struct bset_tree *t = b->set;
300 if (bset_prev_bytes(b) < PAGE_SIZE)
303 free_pages((unsigned long) t->prev,
304 get_order(bset_prev_bytes(b)));
306 if (bset_tree_bytes(b) < PAGE_SIZE)
309 free_pages((unsigned long) t->tree,
310 get_order(bset_tree_bytes(b)));
312 free_pages((unsigned long) t->data, b->page_order);
319 int bch_btree_keys_alloc(struct btree_keys *b,
320 unsigned int page_order,
323 struct bset_tree *t = b->set;
327 b->page_order = page_order;
329 t->data = (void *) __get_free_pages(__GFP_COMP|gfp, b->page_order);
333 t->tree = bset_tree_bytes(b) < PAGE_SIZE
334 ? kmalloc(bset_tree_bytes(b), gfp)
335 : (void *) __get_free_pages(gfp, get_order(bset_tree_bytes(b)));
339 t->prev = bset_prev_bytes(b) < PAGE_SIZE
340 ? kmalloc(bset_prev_bytes(b), gfp)
341 : (void *) __get_free_pages(gfp, get_order(bset_prev_bytes(b)));
347 bch_btree_keys_free(b);
351 void bch_btree_keys_init(struct btree_keys *b, const struct btree_keys_ops *ops,
352 bool *expensive_debug_checks)
355 b->expensive_debug_checks = expensive_debug_checks;
357 b->last_set_unwritten = 0;
360 * struct btree_keys in embedded in struct btree, and struct
361 * bset_tree is embedded into struct btree_keys. They are all
362 * initialized as 0 by kzalloc() in mca_bucket_alloc(), and
363 * b->set[0].data is allocated in bch_btree_keys_alloc(), so we
364 * don't have to initiate b->set[].size and b->set[].data here
369 /* Binary tree stuff for auxiliary search trees */
372 * return array index next to j when does in-order traverse
373 * of a binary tree which is stored in a linear array
375 static unsigned int inorder_next(unsigned int j, unsigned int size)
377 if (j * 2 + 1 < size) {
389 * return array index previous to j when does in-order traverse
390 * of a binary tree which is stored in a linear array
392 static unsigned int inorder_prev(unsigned int j, unsigned int size)
397 while (j * 2 + 1 < size)
406 * I have no idea why this code works... and I'm the one who wrote it
408 * However, I do know what it does:
409 * Given a binary tree constructed in an array (i.e. how you normally implement
410 * a heap), it converts a node in the tree - referenced by array index - to the
411 * index it would have if you did an inorder traversal.
413 * Also tested for every j, size up to size somewhere around 6 million.
415 * The binary tree starts at array index 1, not 0
416 * extra is a function of size:
417 * extra = (size - rounddown_pow_of_two(size - 1)) << 1;
419 static unsigned int __to_inorder(unsigned int j,
423 unsigned int b = fls(j);
424 unsigned int shift = fls(size - 1) - b;
432 j -= (j - extra) >> 1;
438 * Return the cacheline index in bset_tree->data, where j is index
439 * from a linear array which stores the auxiliar binary tree
441 static unsigned int to_inorder(unsigned int j, struct bset_tree *t)
443 return __to_inorder(j, t->size, t->extra);
446 static unsigned int __inorder_to_tree(unsigned int j,
458 j |= roundup_pow_of_two(size) >> shift;
464 * Return an index from a linear array which stores the auxiliar binary
465 * tree, j is the cacheline index of t->data.
467 static unsigned int inorder_to_tree(unsigned int j, struct bset_tree *t)
469 return __inorder_to_tree(j, t->size, t->extra);
473 void inorder_test(void)
475 unsigned long done = 0;
476 ktime_t start = ktime_get();
478 for (unsigned int size = 2;
482 (size - rounddown_pow_of_two(size - 1)) << 1;
483 unsigned int i = 1, j = rounddown_pow_of_two(size - 1);
486 pr_notice("loop %u, %llu per us\n", size,
487 done / ktime_us_delta(ktime_get(), start));
490 if (__inorder_to_tree(i, size, extra) != j)
491 panic("size %10u j %10u i %10u", size, j, i);
493 if (__to_inorder(j, size, extra) != i)
494 panic("size %10u j %10u i %10u", size, j, i);
496 if (j == rounddown_pow_of_two(size) - 1)
499 BUG_ON(inorder_prev(inorder_next(j, size), size) != j);
501 j = inorder_next(j, size);
511 * Cacheline/offset <-> bkey pointer arithmetic:
513 * t->tree is a binary search tree in an array; each node corresponds to a key
514 * in one cacheline in t->set (BSET_CACHELINE bytes).
516 * This means we don't have to store the full index of the key that a node in
517 * the binary tree points to; to_inorder() gives us the cacheline, and then
518 * bkey_float->m gives us the offset within that cacheline, in units of 8 bytes.
520 * cacheline_to_bkey() and friends abstract out all the pointer arithmetic to
523 * To construct the bfloat for an arbitrary key we need to know what the key
524 * immediately preceding it is: we have to check if the two keys differ in the
525 * bits we're going to store in bkey_float->mantissa. t->prev[j] stores the size
526 * of the previous key so we can walk backwards to it from t->tree[j]'s key.
529 static struct bkey *cacheline_to_bkey(struct bset_tree *t,
530 unsigned int cacheline,
533 return ((void *) t->data) + cacheline * BSET_CACHELINE + offset * 8;
536 static unsigned int bkey_to_cacheline(struct bset_tree *t, struct bkey *k)
538 return ((void *) k - (void *) t->data) / BSET_CACHELINE;
541 static unsigned int bkey_to_cacheline_offset(struct bset_tree *t,
542 unsigned int cacheline,
545 return (u64 *) k - (u64 *) cacheline_to_bkey(t, cacheline, 0);
548 static struct bkey *tree_to_bkey(struct bset_tree *t, unsigned int j)
550 return cacheline_to_bkey(t, to_inorder(j, t), t->tree[j].m);
553 static struct bkey *tree_to_prev_bkey(struct bset_tree *t, unsigned int j)
555 return (void *) (((uint64_t *) tree_to_bkey(t, j)) - t->prev[j]);
559 * For the write set - the one we're currently inserting keys into - we don't
560 * maintain a full search tree, we just keep a simple lookup table in t->prev.
562 static struct bkey *table_to_bkey(struct bset_tree *t, unsigned int cacheline)
564 return cacheline_to_bkey(t, cacheline, t->prev[cacheline]);
567 static inline uint64_t shrd128(uint64_t high, uint64_t low, uint8_t shift)
570 low |= (high << 1) << (63U - shift);
575 * Calculate mantissa value for struct bkey_float.
576 * If most significant bit of f->exponent is not set, then
577 * - f->exponent >> 6 is 0
578 * - p[0] points to bkey->low
579 * - p[-1] borrows bits from KEY_INODE() of bkey->high
580 * if most isgnificant bits of f->exponent is set, then
581 * - f->exponent >> 6 is 1
582 * - p[0] points to bits from KEY_INODE() of bkey->high
583 * - p[-1] points to other bits from KEY_INODE() of
585 * See make_bfloat() to check when most significant bit of f->exponent
588 static inline unsigned int bfloat_mantissa(const struct bkey *k,
589 struct bkey_float *f)
591 const uint64_t *p = &k->low - (f->exponent >> 6);
593 return shrd128(p[-1], p[0], f->exponent & 63) & BKEY_MANTISSA_MASK;
596 static void make_bfloat(struct bset_tree *t, unsigned int j)
598 struct bkey_float *f = &t->tree[j];
599 struct bkey *m = tree_to_bkey(t, j);
600 struct bkey *p = tree_to_prev_bkey(t, j);
602 struct bkey *l = is_power_of_2(j)
604 : tree_to_prev_bkey(t, j >> ffs(j));
606 struct bkey *r = is_power_of_2(j + 1)
607 ? bset_bkey_idx(t->data, t->data->keys - bkey_u64s(&t->end))
608 : tree_to_bkey(t, j >> (ffz(j) + 1));
610 BUG_ON(m < l || m > r);
611 BUG_ON(bkey_next(p) != m);
614 * If l and r have different KEY_INODE values (different backing
615 * device), f->exponent records how many least significant bits
616 * are different in KEY_INODE values and sets most significant
617 * bits to 1 (by +64).
618 * If l and r have same KEY_INODE value, f->exponent records
619 * how many different bits in least significant bits of bkey->low.
620 * See bfloat_mantiss() how the most significant bit of
621 * f->exponent is used to calculate bfloat mantissa value.
623 if (KEY_INODE(l) != KEY_INODE(r))
624 f->exponent = fls64(KEY_INODE(r) ^ KEY_INODE(l)) + 64;
626 f->exponent = fls64(r->low ^ l->low);
628 f->exponent = max_t(int, f->exponent - BKEY_MANTISSA_BITS, 0);
631 * Setting f->exponent = 127 flags this node as failed, and causes the
632 * lookup code to fall back to comparing against the original key.
635 if (bfloat_mantissa(m, f) != bfloat_mantissa(p, f))
636 f->mantissa = bfloat_mantissa(m, f) - 1;
641 static void bset_alloc_tree(struct btree_keys *b, struct bset_tree *t)
644 unsigned int j = roundup(t[-1].size,
645 64 / sizeof(struct bkey_float));
647 t->tree = t[-1].tree + j;
648 t->prev = t[-1].prev + j;
651 while (t < b->set + MAX_BSETS)
655 static void bch_bset_build_unwritten_tree(struct btree_keys *b)
657 struct bset_tree *t = bset_tree_last(b);
659 BUG_ON(b->last_set_unwritten);
660 b->last_set_unwritten = 1;
662 bset_alloc_tree(b, t);
664 if (t->tree != b->set->tree + btree_keys_cachelines(b)) {
665 t->prev[0] = bkey_to_cacheline_offset(t, 0, t->data->start);
670 void bch_bset_init_next(struct btree_keys *b, struct bset *i, uint64_t magic)
672 if (i != b->set->data) {
673 b->set[++b->nsets].data = i;
674 i->seq = b->set->data->seq;
676 get_random_bytes(&i->seq, sizeof(uint64_t));
682 bch_bset_build_unwritten_tree(b);
686 * Build auxiliary binary tree 'struct bset_tree *t', this tree is used to
687 * accelerate bkey search in a btree node (pointed by bset_tree->data in
688 * memory). After search in the auxiliar tree by calling bset_search_tree(),
689 * a struct bset_search_iter is returned which indicates range [l, r] from
690 * bset_tree->data where the searching bkey might be inside. Then a followed
691 * linear comparison does the exact search, see __bch_bset_search() for how
692 * the auxiliary tree is used.
694 void bch_bset_build_written_tree(struct btree_keys *b)
696 struct bset_tree *t = bset_tree_last(b);
697 struct bkey *prev = NULL, *k = t->data->start;
698 unsigned int j, cacheline = 1;
700 b->last_set_unwritten = 0;
702 bset_alloc_tree(b, t);
704 t->size = min_t(unsigned int,
705 bkey_to_cacheline(t, bset_bkey_last(t->data)),
706 b->set->tree + btree_keys_cachelines(b) - t->tree);
713 t->extra = (t->size - rounddown_pow_of_two(t->size - 1)) << 1;
715 /* First we figure out where the first key in each cacheline is */
716 for (j = inorder_next(0, t->size);
718 j = inorder_next(j, t->size)) {
719 while (bkey_to_cacheline(t, k) < cacheline) {
724 t->prev[j] = bkey_u64s(prev);
725 t->tree[j].m = bkey_to_cacheline_offset(t, cacheline++, k);
728 while (bkey_next(k) != bset_bkey_last(t->data))
733 /* Then we build the tree */
734 for (j = inorder_next(0, t->size);
736 j = inorder_next(j, t->size))
742 void bch_bset_fix_invalidated_key(struct btree_keys *b, struct bkey *k)
745 unsigned int inorder, j = 1;
747 for (t = b->set; t <= bset_tree_last(b); t++)
748 if (k < bset_bkey_last(t->data))
753 if (!t->size || !bset_written(b, t))
756 inorder = bkey_to_cacheline(t, k);
758 if (k == t->data->start)
761 if (bkey_next(k) == bset_bkey_last(t->data)) {
766 j = inorder_to_tree(inorder, t);
770 k == tree_to_bkey(t, j))
774 } while (j < t->size);
776 j = inorder_to_tree(inorder + 1, t);
780 k == tree_to_prev_bkey(t, j))
784 } while (j < t->size);
787 static void bch_bset_fix_lookup_table(struct btree_keys *b,
791 unsigned int shift = bkey_u64s(k);
792 unsigned int j = bkey_to_cacheline(t, k);
794 /* We're getting called from btree_split() or btree_gc, just bail out */
799 * k is the key we just inserted; we need to find the entry in the
800 * lookup table for the first key that is strictly greater than k:
801 * it's either k's cacheline or the next one
803 while (j < t->size &&
804 table_to_bkey(t, j) <= k)
808 * Adjust all the lookup table entries, and find a new key for any that
809 * have gotten too big
811 for (; j < t->size; j++) {
814 if (t->prev[j] > 7) {
815 k = table_to_bkey(t, j - 1);
817 while (k < cacheline_to_bkey(t, j, 0))
820 t->prev[j] = bkey_to_cacheline_offset(t, j, k);
824 if (t->size == b->set->tree + btree_keys_cachelines(b) - t->tree)
827 /* Possibly add a new entry to the end of the lookup table */
829 for (k = table_to_bkey(t, t->size - 1);
830 k != bset_bkey_last(t->data);
832 if (t->size == bkey_to_cacheline(t, k)) {
834 bkey_to_cacheline_offset(t, t->size, k);
840 * Tries to merge l and r: l should be lower than r
841 * Returns true if we were able to merge. If we did merge, l will be the merged
842 * key, r will be untouched.
844 bool bch_bkey_try_merge(struct btree_keys *b, struct bkey *l, struct bkey *r)
846 if (!b->ops->key_merge)
850 * Generic header checks
851 * Assumes left and right are in order
852 * Left and right must be exactly aligned
854 if (!bch_bkey_equal_header(l, r) ||
855 bkey_cmp(l, &START_KEY(r)))
858 return b->ops->key_merge(b, l, r);
861 void bch_bset_insert(struct btree_keys *b, struct bkey *where,
864 struct bset_tree *t = bset_tree_last(b);
866 BUG_ON(!b->last_set_unwritten);
867 BUG_ON(bset_byte_offset(b, t->data) +
868 __set_bytes(t->data, t->data->keys + bkey_u64s(insert)) >
869 PAGE_SIZE << b->page_order);
871 memmove((uint64_t *) where + bkey_u64s(insert),
873 (void *) bset_bkey_last(t->data) - (void *) where);
875 t->data->keys += bkey_u64s(insert);
876 bkey_copy(where, insert);
877 bch_bset_fix_lookup_table(b, t, where);
880 unsigned int bch_btree_insert_key(struct btree_keys *b, struct bkey *k,
881 struct bkey *replace_key)
883 unsigned int status = BTREE_INSERT_STATUS_NO_INSERT;
884 struct bset *i = bset_tree_last(b)->data;
885 struct bkey *m, *prev = NULL;
886 struct btree_iter iter;
887 struct bkey preceding_key_on_stack = ZERO_KEY;
888 struct bkey *preceding_key_p = &preceding_key_on_stack;
890 BUG_ON(b->ops->is_extents && !KEY_SIZE(k));
892 min_heap_init(&iter.heap, NULL, MAX_BSETS);
895 * If k has preceding key, preceding_key_p will be set to address
896 * of k's preceding key; otherwise preceding_key_p will be set
897 * to NULL inside preceding_key().
899 if (b->ops->is_extents)
900 preceding_key(&START_KEY(k), &preceding_key_p);
902 preceding_key(k, &preceding_key_p);
904 m = bch_btree_iter_init(b, &iter, preceding_key_p);
906 if (b->ops->insert_fixup(b, k, &iter, replace_key))
909 status = BTREE_INSERT_STATUS_INSERT;
911 while (m != bset_bkey_last(i) &&
912 bkey_cmp(k, b->ops->is_extents ? &START_KEY(m) : m) > 0) {
917 /* prev is in the tree, if we merge we're done */
918 status = BTREE_INSERT_STATUS_BACK_MERGE;
920 bch_bkey_try_merge(b, prev, k))
923 status = BTREE_INSERT_STATUS_OVERWROTE;
924 if (m != bset_bkey_last(i) &&
925 KEY_PTRS(m) == KEY_PTRS(k) && !KEY_SIZE(m))
928 status = BTREE_INSERT_STATUS_FRONT_MERGE;
929 if (m != bset_bkey_last(i) &&
930 bch_bkey_try_merge(b, k, m))
933 bch_bset_insert(b, m, k);
934 copy: bkey_copy(m, k);
941 struct bset_search_iter {
945 static struct bset_search_iter bset_search_write_set(struct bset_tree *t,
946 const struct bkey *search)
948 unsigned int li = 0, ri = t->size;
950 while (li + 1 != ri) {
951 unsigned int m = (li + ri) >> 1;
953 if (bkey_cmp(table_to_bkey(t, m), search) > 0)
959 return (struct bset_search_iter) {
960 table_to_bkey(t, li),
961 ri < t->size ? table_to_bkey(t, ri) : bset_bkey_last(t->data)
965 static struct bset_search_iter bset_search_tree(struct bset_tree *t,
966 const struct bkey *search)
969 struct bkey_float *f;
970 unsigned int inorder, j, n = 1;
973 unsigned int p = n << 4;
976 prefetch(&t->tree[p]);
981 if (likely(f->exponent != 127)) {
982 if (f->mantissa >= bfloat_mantissa(search, f))
987 if (bkey_cmp(tree_to_bkey(t, j), search) > 0)
992 } while (n < t->size);
994 inorder = to_inorder(j, t);
997 * n would have been the node we recursed to - the low bit tells us if
998 * we recursed left or recursed right.
1001 l = cacheline_to_bkey(t, inorder, f->m);
1003 if (++inorder != t->size) {
1004 f = &t->tree[inorder_next(j, t->size)];
1005 r = cacheline_to_bkey(t, inorder, f->m);
1007 r = bset_bkey_last(t->data);
1009 r = cacheline_to_bkey(t, inorder, f->m);
1012 f = &t->tree[inorder_prev(j, t->size)];
1013 l = cacheline_to_bkey(t, inorder, f->m);
1018 return (struct bset_search_iter) {l, r};
1021 struct bkey *__bch_bset_search(struct btree_keys *b, struct bset_tree *t,
1022 const struct bkey *search)
1024 struct bset_search_iter i;
1027 * First, we search for a cacheline, then lastly we do a linear search
1028 * within that cacheline.
1030 * To search for the cacheline, there's three different possibilities:
1031 * * The set is too small to have a search tree, so we just do a linear
1032 * search over the whole set.
1033 * * The set is the one we're currently inserting into; keeping a full
1034 * auxiliary search tree up to date would be too expensive, so we
1035 * use a much simpler lookup table to do a binary search -
1036 * bset_search_write_set().
1037 * * Or we use the auxiliary search tree we constructed earlier -
1038 * bset_search_tree()
1041 if (unlikely(!t->size)) {
1042 i.l = t->data->start;
1043 i.r = bset_bkey_last(t->data);
1044 } else if (bset_written(b, t)) {
1046 * Each node in the auxiliary search tree covers a certain range
1047 * of bits, and keys above and below the set it covers might
1048 * differ outside those bits - so we have to special case the
1049 * start and end - handle that here:
1052 if (unlikely(bkey_cmp(search, &t->end) >= 0))
1053 return bset_bkey_last(t->data);
1055 if (unlikely(bkey_cmp(search, t->data->start) < 0))
1056 return t->data->start;
1058 i = bset_search_tree(t, search);
1061 t->size < bkey_to_cacheline(t, bset_bkey_last(t->data)));
1063 i = bset_search_write_set(t, search);
1066 if (btree_keys_expensive_checks(b)) {
1067 BUG_ON(bset_written(b, t) &&
1068 i.l != t->data->start &&
1069 bkey_cmp(tree_to_prev_bkey(t,
1070 inorder_to_tree(bkey_to_cacheline(t, i.l), t)),
1073 BUG_ON(i.r != bset_bkey_last(t->data) &&
1074 bkey_cmp(i.r, search) <= 0);
1077 while (likely(i.l != i.r) &&
1078 bkey_cmp(i.l, search) <= 0)
1079 i.l = bkey_next(i.l);
1084 /* Btree iterator */
1086 typedef bool (new_btree_iter_cmp_fn)(const void *, const void *, void *);
1088 static inline bool new_btree_iter_cmp(const void *l, const void *r, void __always_unused *args)
1090 const struct btree_iter_set *_l = l;
1091 const struct btree_iter_set *_r = r;
1093 return bkey_cmp(_l->k, _r->k) <= 0;
1096 static inline bool btree_iter_end(struct btree_iter *iter)
1098 return !iter->heap.nr;
1101 void bch_btree_iter_push(struct btree_iter *iter, struct bkey *k,
1104 const struct min_heap_callbacks callbacks = {
1105 .less = new_btree_iter_cmp,
1110 BUG_ON(!min_heap_push(&iter->heap,
1111 &((struct btree_iter_set) { k, end }),
1116 static struct bkey *__bch_btree_iter_init(struct btree_keys *b,
1117 struct btree_iter *iter,
1118 struct bkey *search,
1119 struct bset_tree *start)
1121 struct bkey *ret = NULL;
1123 iter->heap.size = ARRAY_SIZE(iter->heap.preallocated);
1126 #ifdef CONFIG_BCACHE_DEBUG
1130 for (; start <= bset_tree_last(b); start++) {
1131 ret = bch_bset_search(b, start, search);
1132 bch_btree_iter_push(iter, ret, bset_bkey_last(start->data));
1138 struct bkey *bch_btree_iter_init(struct btree_keys *b,
1139 struct btree_iter *iter,
1140 struct bkey *search)
1142 return __bch_btree_iter_init(b, iter, search, b->set);
1145 static inline struct bkey *__bch_btree_iter_next(struct btree_iter *iter,
1146 new_btree_iter_cmp_fn *cmp)
1148 struct btree_iter_set b __maybe_unused;
1149 struct bkey *ret = NULL;
1150 const struct min_heap_callbacks callbacks = {
1155 if (!btree_iter_end(iter)) {
1156 bch_btree_iter_next_check(iter);
1158 ret = iter->heap.data->k;
1159 iter->heap.data->k = bkey_next(iter->heap.data->k);
1161 if (iter->heap.data->k > iter->heap.data->end) {
1162 WARN_ONCE(1, "bset was corrupt!\n");
1163 iter->heap.data->k = iter->heap.data->end;
1166 if (iter->heap.data->k == iter->heap.data->end) {
1167 if (iter->heap.nr) {
1168 b = min_heap_peek(&iter->heap)[0];
1169 min_heap_pop(&iter->heap, &callbacks, NULL);
1173 min_heap_sift_down(&iter->heap, 0, &callbacks, NULL);
1179 struct bkey *bch_btree_iter_next(struct btree_iter *iter)
1181 return __bch_btree_iter_next(iter, new_btree_iter_cmp);
1185 struct bkey *bch_btree_iter_next_filter(struct btree_iter *iter,
1186 struct btree_keys *b, ptr_filter_fn fn)
1191 ret = bch_btree_iter_next(iter);
1192 } while (ret && fn(b, ret));
1199 void bch_bset_sort_state_free(struct bset_sort_state *state)
1201 mempool_exit(&state->pool);
1204 int bch_bset_sort_state_init(struct bset_sort_state *state,
1205 unsigned int page_order)
1207 spin_lock_init(&state->time.lock);
1209 state->page_order = page_order;
1210 state->crit_factor = int_sqrt(1 << page_order);
1212 return mempool_init_page_pool(&state->pool, 1, page_order);
1215 static void btree_mergesort(struct btree_keys *b, struct bset *out,
1216 struct btree_iter *iter,
1217 bool fixup, bool remove_stale)
1219 struct bkey *k, *last = NULL;
1221 bool (*bad)(struct btree_keys *, const struct bkey *) = remove_stale
1224 const struct min_heap_callbacks callbacks = {
1225 .less = b->ops->sort_cmp,
1229 /* Heapify the iterator, using our comparison function */
1230 min_heapify_all(&iter->heap, &callbacks, NULL);
1232 while (!btree_iter_end(iter)) {
1233 if (b->ops->sort_fixup && fixup)
1234 k = b->ops->sort_fixup(iter, &tmp.k);
1239 k = __bch_btree_iter_next(iter, b->ops->sort_cmp);
1247 } else if (!bch_bkey_try_merge(b, last, k)) {
1248 last = bkey_next(last);
1253 out->keys = last ? (uint64_t *) bkey_next(last) - out->d : 0;
1255 pr_debug("sorted %i keys\n", out->keys);
1258 static void __btree_sort(struct btree_keys *b, struct btree_iter *iter,
1259 unsigned int start, unsigned int order, bool fixup,
1260 struct bset_sort_state *state)
1262 uint64_t start_time;
1263 bool used_mempool = false;
1264 struct bset *out = (void *) __get_free_pages(__GFP_NOWARN|GFP_NOWAIT,
1269 BUG_ON(order > state->page_order);
1271 outp = mempool_alloc(&state->pool, GFP_NOIO);
1272 out = page_address(outp);
1273 used_mempool = true;
1274 order = state->page_order;
1277 start_time = local_clock();
1279 btree_mergesort(b, out, iter, fixup, false);
1282 if (!start && order == b->page_order) {
1284 * Our temporary buffer is the same size as the btree node's
1285 * buffer, we can just swap buffers instead of doing a big
1288 * Don't worry event 'out' is allocated from mempool, it can
1289 * still be swapped here. Because state->pool is a page mempool
1290 * created by mempool_init_page_pool(), which allocates
1291 * pages by alloc_pages() indeed.
1294 out->magic = b->set->data->magic;
1295 out->seq = b->set->data->seq;
1296 out->version = b->set->data->version;
1297 swap(out, b->set->data);
1299 b->set[start].data->keys = out->keys;
1300 memcpy(b->set[start].data->start, out->start,
1301 (void *) bset_bkey_last(out) - (void *) out->start);
1305 mempool_free(virt_to_page(out), &state->pool);
1307 free_pages((unsigned long) out, order);
1309 bch_bset_build_written_tree(b);
1312 bch_time_stats_update(&state->time, start_time);
1315 void bch_btree_sort_partial(struct btree_keys *b, unsigned int start,
1316 struct bset_sort_state *state)
1318 size_t order = b->page_order, keys = 0;
1319 struct btree_iter iter;
1320 int oldsize = bch_count_data(b);
1322 min_heap_init(&iter.heap, NULL, MAX_BSETS);
1323 __bch_btree_iter_init(b, &iter, NULL, &b->set[start]);
1328 for (i = start; i <= b->nsets; i++)
1329 keys += b->set[i].data->keys;
1331 order = get_order(__set_bytes(b->set->data, keys));
1334 __btree_sort(b, &iter, start, order, false, state);
1336 EBUG_ON(oldsize >= 0 && bch_count_data(b) != oldsize);
1339 void bch_btree_sort_and_fix_extents(struct btree_keys *b,
1340 struct btree_iter *iter,
1341 struct bset_sort_state *state)
1343 __btree_sort(b, iter, 0, b->page_order, true, state);
1346 void bch_btree_sort_into(struct btree_keys *b, struct btree_keys *new,
1347 struct bset_sort_state *state)
1349 uint64_t start_time = local_clock();
1350 struct btree_iter iter;
1352 min_heap_init(&iter.heap, NULL, MAX_BSETS);
1354 bch_btree_iter_init(b, &iter, NULL);
1356 btree_mergesort(b, new->set->data, &iter, false, true);
1358 bch_time_stats_update(&state->time, start_time);
1360 new->set->size = 0; // XXX: why?
1363 #define SORT_CRIT (4096 / sizeof(uint64_t))
1365 void bch_btree_sort_lazy(struct btree_keys *b, struct bset_sort_state *state)
1367 unsigned int crit = SORT_CRIT;
1370 /* Don't sort if nothing to do */
1374 for (i = b->nsets - 1; i >= 0; --i) {
1375 crit *= state->crit_factor;
1377 if (b->set[i].data->keys < crit) {
1378 bch_btree_sort_partial(b, i, state);
1383 /* Sort if we'd overflow */
1384 if (b->nsets + 1 == MAX_BSETS) {
1385 bch_btree_sort(b, state);
1390 bch_bset_build_written_tree(b);
1393 void bch_btree_keys_stats(struct btree_keys *b, struct bset_stats *stats)
1397 for (i = 0; i <= b->nsets; i++) {
1398 struct bset_tree *t = &b->set[i];
1399 size_t bytes = t->data->keys * sizeof(uint64_t);
1402 if (bset_written(b, t)) {
1403 stats->sets_written++;
1404 stats->bytes_written += bytes;
1406 stats->floats += t->size - 1;
1408 for (j = 1; j < t->size; j++)
1409 if (t->tree[j].exponent == 127)
1412 stats->sets_unwritten++;
1413 stats->bytes_unwritten += bytes;