2 * Copyright (C) 2010 Kent Overstreet <kent.overstreet@gmail.com>
4 * Code for managing the extent btree and dynamically updating the writeback
9 #include "bkey_methods.h"
11 #include "btree_update.h"
20 #include "writeback.h"
23 #include <trace/events/bcache.h>
25 static enum merge_result bch_extent_merge(struct bch_fs *, struct btree *,
26 struct bkey_i *, struct bkey_i *);
28 static void sort_key_next(struct btree_node_iter *iter,
30 struct btree_node_iter_set *i)
32 i->k += __btree_node_offset_to_key(b, i->k)->u64s;
35 *i = iter->data[--iter->used];
39 * Returns true if l > r - unless l == r, in which case returns true if l is
42 * Necessary for btree_sort_fixup() - if there are multiple keys that compare
43 * equal in different sets, we have to process them newest to oldest.
45 #define key_sort_cmp(l, r) \
47 int _c = bkey_cmp_packed(b, \
48 __btree_node_offset_to_key(b, (l).k), \
49 __btree_node_offset_to_key(b, (r).k)); \
51 _c ? _c > 0 : (l).k > (r).k; \
54 static inline bool should_drop_next_key(struct btree_node_iter *iter,
57 struct btree_node_iter_set *l = iter->data, *r = iter->data + 1;
58 struct bkey_packed *k = __btree_node_offset_to_key(b, l->k);
67 key_sort_cmp(r[0], r[1]))
71 * key_sort_cmp() ensures that when keys compare equal the older key
72 * comes first; so if l->k compares equal to r->k then l->k is older and
75 return !bkey_cmp_packed(b,
76 __btree_node_offset_to_key(b, l->k),
77 __btree_node_offset_to_key(b, r->k));
80 struct btree_nr_keys bch_key_sort_fix_overlapping(struct bset *dst,
82 struct btree_node_iter *iter)
84 struct bkey_packed *out = dst->start;
85 struct btree_nr_keys nr;
87 memset(&nr, 0, sizeof(nr));
89 heap_resort(iter, key_sort_cmp);
91 while (!bch_btree_node_iter_end(iter)) {
92 if (!should_drop_next_key(iter, b)) {
93 struct bkey_packed *k =
94 __btree_node_offset_to_key(b, iter->data->k);
97 btree_keys_account_key_add(&nr, 0, out);
101 sort_key_next(iter, b, iter->data);
102 heap_sift(iter, 0, key_sort_cmp);
105 dst->u64s = cpu_to_le16((u64 *) out - dst->_data);
109 /* Common among btree and extent ptrs */
111 const struct bch_extent_ptr *
112 bch_extent_has_device(struct bkey_s_c_extent e, unsigned dev)
114 const struct bch_extent_ptr *ptr;
116 extent_for_each_ptr(e, ptr)
123 unsigned bch_extent_nr_ptrs(struct bkey_s_c_extent e)
125 const struct bch_extent_ptr *ptr;
126 unsigned nr_ptrs = 0;
128 extent_for_each_ptr(e, ptr)
134 unsigned bch_extent_nr_dirty_ptrs(struct bkey_s_c k)
136 struct bkey_s_c_extent e;
137 const struct bch_extent_ptr *ptr;
138 unsigned nr_ptrs = 0;
142 case BCH_EXTENT_CACHED:
143 e = bkey_s_c_to_extent(k);
145 extent_for_each_ptr(e, ptr)
146 nr_ptrs += !ptr->cached;
149 case BCH_RESERVATION:
150 nr_ptrs = bkey_s_c_to_reservation(k).v->nr_replicas;
157 /* returns true if equal */
158 static bool crc_cmp(union bch_extent_crc *l, union bch_extent_crc *r)
160 return extent_crc_type(l) == extent_crc_type(r) &&
161 !memcmp(l, r, extent_entry_bytes(to_entry(l)));
164 /* Increment pointers after @crc by crc's offset until the next crc entry: */
165 void bch_extent_crc_narrow_pointers(struct bkey_s_extent e, union bch_extent_crc *crc)
167 union bch_extent_entry *entry;
169 extent_for_each_entry_from(e, entry, extent_entry_next(to_entry(crc))) {
170 if (!extent_entry_is_ptr(entry))
173 entry->ptr.offset += crc_offset(crc);
178 * We're writing another replica for this extent, so while we've got the data in
179 * memory we'll be computing a new checksum for the currently live data.
181 * If there are other replicas we aren't moving, and they are checksummed but
182 * not compressed, we can modify them to point to only the data that is
183 * currently live (so that readers won't have to bounce) while we've got the
186 * XXX: to guard against data being corrupted while in memory, instead of
187 * recomputing the checksum here, it would be better in the read path to instead
188 * of computing the checksum of the entire extent:
192 * compute the checksums of the live and dead data separately
193 * | dead data || live data || dead data |
195 * and then verify that crc_dead1 + crc_live + crc_dead2 == orig_crc, and then
196 * use crc_live here (that we verified was correct earlier)
198 * note: doesn't work with encryption
200 void bch_extent_narrow_crcs(struct bkey_s_extent e)
202 union bch_extent_crc *crc;
203 bool have_wide = false, have_narrow = false;
204 struct bch_csum csum = { 0 };
205 unsigned csum_type = 0;
207 extent_for_each_crc(e, crc) {
208 if (crc_compression_type(crc) ||
209 bch_csum_type_is_encryption(crc_csum_type(crc)))
212 if (crc_uncompressed_size(e.k, crc) != e.k->size) {
216 csum = crc_csum(crc);
217 csum_type = crc_csum_type(crc);
221 if (!have_wide || !have_narrow)
224 extent_for_each_crc(e, crc) {
225 if (crc_compression_type(crc))
228 if (crc_uncompressed_size(e.k, crc) != e.k->size) {
229 switch (extent_crc_type(crc)) {
230 case BCH_EXTENT_CRC_NONE:
232 case BCH_EXTENT_CRC32:
233 if (bch_crc_bytes[csum_type] > 4)
236 bch_extent_crc_narrow_pointers(e, crc);
237 crc->crc32._compressed_size = e.k->size - 1;
238 crc->crc32._uncompressed_size = e.k->size - 1;
239 crc->crc32.offset = 0;
240 crc->crc32.csum_type = csum_type;
241 crc->crc32.csum = csum.lo;
243 case BCH_EXTENT_CRC64:
244 if (bch_crc_bytes[csum_type] > 10)
247 bch_extent_crc_narrow_pointers(e, crc);
248 crc->crc64._compressed_size = e.k->size - 1;
249 crc->crc64._uncompressed_size = e.k->size - 1;
250 crc->crc64.offset = 0;
251 crc->crc64.csum_type = csum_type;
252 crc->crc64.csum_lo = csum.lo;
253 crc->crc64.csum_hi = csum.hi;
255 case BCH_EXTENT_CRC128:
256 if (bch_crc_bytes[csum_type] > 16)
259 bch_extent_crc_narrow_pointers(e, crc);
260 crc->crc128._compressed_size = e.k->size - 1;
261 crc->crc128._uncompressed_size = e.k->size - 1;
262 crc->crc128.offset = 0;
263 crc->crc128.csum_type = csum_type;
264 crc->crc128.csum = csum;
271 void bch_extent_drop_redundant_crcs(struct bkey_s_extent e)
273 union bch_extent_entry *entry = e.v->start;
274 union bch_extent_crc *crc, *prev = NULL;
276 while (entry != extent_entry_last(e)) {
277 union bch_extent_entry *next = extent_entry_next(entry);
278 size_t crc_u64s = extent_entry_u64s(entry);
280 if (!extent_entry_is_crc(entry))
283 crc = entry_to_crc(entry);
285 if (next == extent_entry_last(e)) {
286 /* crc entry with no pointers after it: */
290 if (extent_entry_is_crc(next)) {
291 /* no pointers before next crc entry: */
295 if (prev && crc_cmp(crc, prev)) {
296 /* identical to previous crc entry: */
301 !crc_csum_type(crc) &&
302 !crc_compression_type(crc)) {
303 /* null crc entry: */
304 bch_extent_crc_narrow_pointers(e, crc);
313 memmove_u64s_down(crc, next,
314 (u64 *) extent_entry_last(e) - (u64 *) next);
315 e.k->u64s -= crc_u64s;
318 EBUG_ON(bkey_val_u64s(e.k) && !bch_extent_nr_ptrs(e.c));
321 static bool should_drop_ptr(const struct bch_fs *c,
322 struct bkey_s_c_extent e,
323 const struct bch_extent_ptr *ptr)
325 struct bch_dev *ca = c->devs[ptr->dev];
327 return ptr_stale(ca, ptr);
330 static void bch_extent_drop_stale(struct bch_fs *c, struct bkey_s_extent e)
332 struct bch_extent_ptr *ptr = &e.v->start->ptr;
333 bool dropped = false;
335 while ((ptr = extent_ptr_next(e, ptr)))
336 if (should_drop_ptr(c, e.c, ptr)) {
337 __bch_extent_drop_ptr(e, ptr);
343 bch_extent_drop_redundant_crcs(e);
346 static bool bch_ptr_normalize(struct bch_fs *c, struct btree *bk,
349 return bch_extent_normalize(c, k);
352 static void bch_ptr_swab(const struct bkey_format *f, struct bkey_packed *k)
356 case BCH_EXTENT_CACHED: {
357 union bch_extent_entry *entry;
358 u64 *d = (u64 *) bkeyp_val(f, k);
361 for (i = 0; i < bkeyp_val_u64s(f, k); i++)
364 for (entry = (union bch_extent_entry *) d;
365 entry < (union bch_extent_entry *) (d + bkeyp_val_u64s(f, k));
366 entry = extent_entry_next(entry)) {
367 switch (extent_entry_type(entry)) {
368 case BCH_EXTENT_ENTRY_crc32:
369 entry->crc32.csum = swab32(entry->crc32.csum);
371 case BCH_EXTENT_ENTRY_crc64:
372 entry->crc64.csum_hi = swab16(entry->crc64.csum_hi);
373 entry->crc64.csum_lo = swab64(entry->crc64.csum_lo);
375 case BCH_EXTENT_ENTRY_crc128:
376 entry->crc128.csum.hi = swab64(entry->crc64.csum_hi);
377 entry->crc128.csum.lo = swab64(entry->crc64.csum_lo);
379 case BCH_EXTENT_ENTRY_ptr:
388 static const char *extent_ptr_invalid(const struct bch_fs *c,
389 struct bkey_s_c_extent e,
390 const struct bch_extent_ptr *ptr,
391 unsigned size_ondisk,
394 const struct bch_extent_ptr *ptr2;
397 if (ptr->dev >= c->sb.nr_devices)
398 return "pointer to invalid device";
400 ca = c->devs[ptr->dev];
402 return "pointer to invalid device";
404 extent_for_each_ptr(e, ptr2)
405 if (ptr != ptr2 && ptr->dev == ptr2->dev)
406 return "multiple pointers to same device";
408 if (ptr->offset + size_ondisk > ca->mi.bucket_size * ca->mi.nbuckets)
409 return "offset past end of device";
411 if (ptr->offset < ca->mi.bucket_size * ca->mi.first_bucket)
412 return "offset before first bucket";
414 if ((ptr->offset & (ca->mi.bucket_size - 1)) +
415 size_ondisk > ca->mi.bucket_size)
416 return "spans multiple buckets";
418 if (!(metadata ? ca->mi.has_metadata : ca->mi.has_data))
419 return "device not marked as containing data";
424 static size_t extent_print_ptrs(struct bch_fs *c, char *buf,
425 size_t size, struct bkey_s_c_extent e)
427 char *out = buf, *end = buf + size;
428 const union bch_extent_entry *entry;
429 const union bch_extent_crc *crc;
430 const struct bch_extent_ptr *ptr;
434 #define p(...) (out += scnprintf(out, end - out, __VA_ARGS__))
436 extent_for_each_entry(e, entry) {
440 switch (__extent_entry_type(entry)) {
441 case BCH_EXTENT_ENTRY_crc32:
442 case BCH_EXTENT_ENTRY_crc64:
443 case BCH_EXTENT_ENTRY_crc128:
444 crc = entry_to_crc(entry);
446 p("crc: c_size %u size %u offset %u csum %u compress %u",
447 crc_compressed_size(e.k, crc),
448 crc_uncompressed_size(e.k, crc),
449 crc_offset(crc), crc_csum_type(crc),
450 crc_compression_type(crc));
452 case BCH_EXTENT_ENTRY_ptr:
453 ptr = entry_to_ptr(entry);
454 ca = c->devs[ptr->dev];
456 p("ptr: %u:%llu gen %u%s", ptr->dev,
457 (u64) ptr->offset, ptr->gen,
458 ca && ptr_stale(ca, ptr)
462 p("(invalid extent entry %.16llx)", *((u64 *) entry));
469 if (bkey_extent_is_cached(e.k))
477 static const char *bch_btree_ptr_invalid(const struct bch_fs *c,
480 if (bkey_extent_is_cached(k.k))
484 return "nonzero key size";
486 if (bkey_val_u64s(k.k) > BKEY_BTREE_PTR_VAL_U64s_MAX)
487 return "value too big";
491 struct bkey_s_c_extent e = bkey_s_c_to_extent(k);
492 const union bch_extent_entry *entry;
493 const struct bch_extent_ptr *ptr;
494 const union bch_extent_crc *crc;
497 extent_for_each_entry(e, entry)
498 if (__extent_entry_type(entry) >= BCH_EXTENT_ENTRY_MAX)
499 return "invalid extent entry type";
501 extent_for_each_ptr_crc(e, ptr, crc) {
502 reason = extent_ptr_invalid(c, e, ptr,
503 c->sb.btree_node_size,
510 return "has crc field";
516 return "invalid value type";
520 static void btree_ptr_debugcheck(struct bch_fs *c, struct btree *b,
523 struct bkey_s_c_extent e = bkey_s_c_to_extent(k);
524 const struct bch_extent_ptr *ptr;
530 unsigned replicas = 0;
533 extent_for_each_ptr(e, ptr) {
534 ca = c->devs[ptr->dev];
535 g = PTR_BUCKET(ca, ptr);
539 if (ptr_stale(ca, ptr))
543 seq = read_seqcount_begin(&c->gc_pos_lock);
544 bad = gc_pos_cmp(c->gc_pos, gc_pos_btree_node(b)) > 0 &&
545 g->mark.data_type != BUCKET_BTREE;
546 } while (read_seqcount_retry(&c->gc_pos_lock, seq));
548 err = "inconsistent";
553 if (replicas < c->sb.meta_replicas_have) {
554 bch_bkey_val_to_text(c, btree_node_type(b),
555 buf, sizeof(buf), k);
557 "btree key bad (too few replicas, %u < %u): %s",
558 replicas, c->sb.meta_replicas_have, buf);
564 bch_bkey_val_to_text(c, btree_node_type(b), buf, sizeof(buf), k);
565 bch_fs_bug(c, "%s btree pointer %s: bucket %zi prio %i "
566 "gen %i last_gc %i mark %08x",
567 err, buf, PTR_BUCKET_NR(ca, ptr),
568 g->read_prio, PTR_BUCKET(ca, ptr)->mark.gen,
569 ca->oldest_gens[PTR_BUCKET_NR(ca, ptr)],
570 (unsigned) g->mark.counter);
573 static void bch_btree_ptr_to_text(struct bch_fs *c, char *buf,
574 size_t size, struct bkey_s_c k)
576 char *out = buf, *end = buf + size;
579 #define p(...) (out += scnprintf(out, end - out, __VA_ARGS__))
581 if (bkey_extent_is_data(k.k))
582 out += extent_print_ptrs(c, buf, size, bkey_s_c_to_extent(k));
584 invalid = bch_btree_ptr_invalid(c, k);
586 p(" invalid: %s", invalid);
590 struct extent_pick_ptr
591 bch_btree_pick_ptr(struct bch_fs *c, const struct btree *b)
593 struct bkey_s_c_extent e = bkey_i_to_s_c_extent(&b->key);
594 const union bch_extent_crc *crc;
595 const struct bch_extent_ptr *ptr;
596 struct extent_pick_ptr pick = { .ca = NULL };
598 extent_for_each_ptr_crc(e, ptr, crc) {
599 struct bch_dev *ca = c->devs[ptr->dev];
600 struct btree *root = btree_node_root(c, b);
602 if (bch_fs_inconsistent_on(crc, c,
603 "btree node pointer with crc at btree %u level %u/%u bucket %zu",
604 b->btree_id, b->level, root ? root->level : -1,
605 PTR_BUCKET_NR(ca, ptr)))
608 if (bch_dev_inconsistent_on(ptr_stale(ca, ptr), ca,
609 "stale btree node pointer at btree %u level %u/%u bucket %zu",
610 b->btree_id, b->level, root ? root->level : -1,
611 PTR_BUCKET_NR(ca, ptr)))
614 if (ca->mi.state == BCH_MEMBER_STATE_FAILED)
617 if (pick.ca && pick.ca->mi.tier < ca->mi.tier)
620 if (!percpu_ref_tryget(&ca->io_ref))
624 percpu_ref_put(&pick.ca->io_ref);
633 const struct bkey_ops bch_bkey_btree_ops = {
634 .key_invalid = bch_btree_ptr_invalid,
635 .key_debugcheck = btree_ptr_debugcheck,
636 .val_to_text = bch_btree_ptr_to_text,
637 .swab = bch_ptr_swab,
642 static bool __bch_cut_front(struct bpos where, struct bkey_s k)
646 if (bkey_cmp(where, bkey_start_pos(k.k)) <= 0)
649 EBUG_ON(bkey_cmp(where, k.k->p) > 0);
651 len = k.k->p.offset - where.offset;
653 BUG_ON(len > k.k->size);
656 * Don't readjust offset if the key size is now 0, because that could
657 * cause offset to point to the next bucket:
660 __set_bkey_deleted(k.k);
661 else if (bkey_extent_is_data(k.k)) {
662 struct bkey_s_extent e = bkey_s_to_extent(k);
663 struct bch_extent_ptr *ptr;
664 union bch_extent_crc *crc, *prev_crc = NULL;
666 extent_for_each_ptr_crc(e, ptr, crc) {
667 switch (extent_crc_type(crc)) {
668 case BCH_EXTENT_CRC_NONE:
669 ptr->offset += e.k->size - len;
671 case BCH_EXTENT_CRC32:
673 crc->crc32.offset += e.k->size - len;
675 case BCH_EXTENT_CRC64:
677 crc->crc64.offset += e.k->size - len;
679 case BCH_EXTENT_CRC128:
681 crc->crc128.offset += e.k->size - len;
693 bool bch_cut_front(struct bpos where, struct bkey_i *k)
695 return __bch_cut_front(where, bkey_i_to_s(k));
698 bool bch_cut_back(struct bpos where, struct bkey *k)
702 if (bkey_cmp(where, k->p) >= 0)
705 EBUG_ON(bkey_cmp(where, bkey_start_pos(k)) < 0);
707 len = where.offset - bkey_start_offset(k);
709 BUG_ON(len > k->size);
715 __set_bkey_deleted(k);
721 * bch_key_resize - adjust size of @k
723 * bkey_start_offset(k) will be preserved, modifies where the extent ends
725 void bch_key_resize(struct bkey *k,
728 k->p.offset -= k->size;
729 k->p.offset += new_size;
734 * In extent_sort_fix_overlapping(), insert_fixup_extent(),
735 * extent_merge_inline() - we're modifying keys in place that are packed. To do
736 * that we have to unpack the key, modify the unpacked key - then this
737 * copies/repacks the unpacked to the original as necessary.
739 static bool __extent_save(struct btree *b, struct btree_node_iter *iter,
740 struct bkey_packed *dst, struct bkey *src)
742 struct bkey_format *f = &b->format;
743 struct bkey_i *dst_unpacked;
746 if ((dst_unpacked = packed_to_bkey(dst))) {
747 dst_unpacked->k = *src;
750 ret = bkey_pack_key(dst, src, f);
754 bch_verify_key_order(b, iter, dst);
759 static void extent_save(struct btree *b, struct btree_node_iter *iter,
760 struct bkey_packed *dst, struct bkey *src)
762 BUG_ON(!__extent_save(b, iter, dst, src));
766 * Returns true if l > r - unless l == r, in which case returns true if l is
769 * Necessary for sort_fix_overlapping() - if there are multiple keys that
770 * compare equal in different sets, we have to process them newest to oldest.
772 #define extent_sort_cmp(l, r) \
774 struct bkey _ul = bkey_unpack_key(b, \
775 __btree_node_offset_to_key(b, (l).k)); \
776 struct bkey _ur = bkey_unpack_key(b, \
777 __btree_node_offset_to_key(b, (r).k)); \
779 int _c = bkey_cmp(bkey_start_pos(&_ul), bkey_start_pos(&_ur)); \
780 _c ? _c > 0 : (l).k < (r).k; \
783 static inline void extent_sort_sift(struct btree_node_iter *iter,
784 struct btree *b, size_t i)
786 heap_sift(iter, i, extent_sort_cmp);
789 static inline void extent_sort_next(struct btree_node_iter *iter,
791 struct btree_node_iter_set *i)
793 sort_key_next(iter, b, i);
794 heap_sift(iter, i - iter->data, extent_sort_cmp);
797 static void extent_sort_append(struct bch_fs *c,
799 struct btree_nr_keys *nr,
800 struct bkey_packed *start,
801 struct bkey_packed **prev,
802 struct bkey_packed *k)
804 struct bkey_format *f = &b->format;
807 if (bkey_whiteout(k))
810 bkey_unpack(b, &tmp.k, k);
813 bch_extent_merge(c, b, (void *) *prev, &tmp.k))
817 bkey_pack(*prev, (void *) *prev, f);
819 btree_keys_account_key_add(nr, 0, *prev);
820 *prev = bkey_next(*prev);
825 bkey_copy(*prev, &tmp.k);
828 struct btree_nr_keys bch_extent_sort_fix_overlapping(struct bch_fs *c,
831 struct btree_node_iter *iter)
833 struct bkey_format *f = &b->format;
834 struct btree_node_iter_set *_l = iter->data, *_r;
835 struct bkey_packed *prev = NULL, *out, *lk, *rk;
836 struct bkey l_unpacked, r_unpacked;
838 struct btree_nr_keys nr;
840 memset(&nr, 0, sizeof(nr));
842 heap_resort(iter, extent_sort_cmp);
844 while (!bch_btree_node_iter_end(iter)) {
845 lk = __btree_node_offset_to_key(b, _l->k);
847 if (iter->used == 1) {
848 extent_sort_append(c, b, &nr, dst->start, &prev, lk);
849 extent_sort_next(iter, b, _l);
854 if (iter->used > 2 &&
855 extent_sort_cmp(_r[0], _r[1]))
858 rk = __btree_node_offset_to_key(b, _r->k);
860 l = __bkey_disassemble(b, lk, &l_unpacked);
861 r = __bkey_disassemble(b, rk, &r_unpacked);
863 /* If current key and next key don't overlap, just append */
864 if (bkey_cmp(l.k->p, bkey_start_pos(r.k)) <= 0) {
865 extent_sort_append(c, b, &nr, dst->start, &prev, lk);
866 extent_sort_next(iter, b, _l);
870 /* Skip 0 size keys */
872 extent_sort_next(iter, b, _r);
877 * overlap: keep the newer key and trim the older key so they
878 * don't overlap. comparing pointers tells us which one is
879 * newer, since the bsets are appended one after the other.
882 /* can't happen because of comparison func */
883 BUG_ON(_l->k < _r->k &&
884 !bkey_cmp(bkey_start_pos(l.k), bkey_start_pos(r.k)));
888 if (bkey_cmp(l.k->p, r.k->p) >= 0) {
889 sort_key_next(iter, b, _r);
891 __bch_cut_front(l.k->p, r);
892 extent_save(b, NULL, rk, r.k);
895 extent_sort_sift(iter, b, _r - iter->data);
896 } else if (bkey_cmp(l.k->p, r.k->p) > 0) {
900 * r wins, but it overlaps in the middle of l - split l:
902 bkey_reassemble(&tmp.k, l.s_c);
903 bch_cut_back(bkey_start_pos(r.k), &tmp.k.k);
905 __bch_cut_front(r.k->p, l);
906 extent_save(b, NULL, lk, l.k);
908 extent_sort_sift(iter, b, 0);
910 extent_sort_append(c, b, &nr, dst->start, &prev,
911 bkey_to_packed(&tmp.k));
913 bch_cut_back(bkey_start_pos(r.k), l.k);
914 extent_save(b, NULL, lk, l.k);
919 bkey_pack(prev, (void *) prev, f);
920 btree_keys_account_key_add(&nr, 0, prev);
921 out = bkey_next(prev);
926 dst->u64s = cpu_to_le16((u64 *) out - dst->_data);
930 struct extent_insert_state {
931 struct btree_insert *trans;
932 struct btree_insert_entry *insert;
933 struct bpos committed;
934 struct bch_fs_usage stats;
937 struct bkey_i whiteout;
942 static void bch_add_sectors(struct extent_insert_state *s,
943 struct bkey_s_c k, u64 offset, s64 sectors)
945 struct bch_fs *c = s->trans->c;
946 struct btree *b = s->insert->iter->nodes[0];
948 EBUG_ON(bkey_cmp(bkey_start_pos(k.k), b->data->min_key) < 0);
953 bch_mark_key(c, k, sectors, false, gc_pos_btree_node(b),
954 &s->stats, s->trans->journal_res.seq);
956 if (bkey_extent_is_data(k.k) &&
957 !bkey_extent_is_cached(k.k))
958 bcache_dev_sectors_dirty_add(c, k.k->p.inode, offset, sectors);
961 static void bch_subtract_sectors(struct extent_insert_state *s,
962 struct bkey_s_c k, u64 offset, s64 sectors)
964 bch_add_sectors(s, k, offset, -sectors);
967 /* These wrappers subtract exactly the sectors that we're removing from @k */
968 static void bch_cut_subtract_back(struct extent_insert_state *s,
969 struct bpos where, struct bkey_s k)
971 bch_subtract_sectors(s, k.s_c, where.offset,
972 k.k->p.offset - where.offset);
973 bch_cut_back(where, k.k);
976 static void bch_cut_subtract_front(struct extent_insert_state *s,
977 struct bpos where, struct bkey_s k)
979 bch_subtract_sectors(s, k.s_c, bkey_start_offset(k.k),
980 where.offset - bkey_start_offset(k.k));
981 __bch_cut_front(where, k);
984 static void bch_drop_subtract(struct extent_insert_state *s, struct bkey_s k)
987 bch_subtract_sectors(s, k.s_c,
988 bkey_start_offset(k.k), k.k->size);
990 __set_bkey_deleted(k.k);
994 * Note: If this returns true because only some pointers matched,
995 * we can lose some caching that had happened in the interim.
996 * Because cache promotion only promotes the part of the extent
997 * actually read, and not the whole extent, and due to the key
998 * splitting done in bch_extent_insert_fixup, preserving such
999 * caching is difficult.
1001 static bool bch_extent_cmpxchg_cmp(struct bkey_s_c l, struct bkey_s_c r)
1003 struct bkey_s_c_extent le, re;
1004 const struct bch_extent_ptr *lp, *rp;
1007 BUG_ON(!l.k->size || !r.k->size);
1009 if (l.k->type != r.k->type ||
1010 bversion_cmp(l.k->version, r.k->version))
1013 switch (l.k->type) {
1014 case KEY_TYPE_COOKIE:
1015 return !memcmp(bkey_s_c_to_cookie(l).v,
1016 bkey_s_c_to_cookie(r).v,
1017 sizeof(struct bch_cookie));
1020 case BCH_EXTENT_CACHED:
1021 le = bkey_s_c_to_extent(l);
1022 re = bkey_s_c_to_extent(r);
1025 * bkey_cmpxchg() handles partial matches - when either l or r
1026 * has been trimmed - so we need just to handle l or r not
1027 * starting at the same place when checking for a match here.
1029 * If the starts of the keys are different, we just apply that
1030 * offset to the device pointer offsets when checking those -
1031 * matching how bch_cut_front() adjusts device pointer offsets
1032 * when adjusting the start of a key:
1034 offset = bkey_start_offset(l.k) - bkey_start_offset(r.k);
1037 * XXX: perhaps we only raced with copygc or tiering replacing
1038 * one of the pointers: it should suffice to find _any_ matching
1042 if (bkey_val_u64s(le.k) != bkey_val_u64s(re.k))
1045 extent_for_each_ptr(le, lp) {
1046 const union bch_extent_entry *entry =
1047 vstruct_idx(re.v, (u64 *) lp - le.v->_data);
1049 if (!extent_entry_is_ptr(entry))
1054 if (lp->offset != rp->offset + offset ||
1055 lp->dev != rp->dev ||
1068 * Returns true on success, false on failure (and false means @new no longer
1071 * If returned true, we may have inserted up to one key in @b.
1072 * If returned false, we may have inserted up to two keys in @b.
1074 * On return, there is room in @res for at least one more key of the same size
1077 enum extent_insert_hook_ret bch_extent_cmpxchg(struct extent_insert_hook *hook,
1078 struct bpos committed_pos,
1079 struct bpos next_pos,
1081 const struct bkey_i *new)
1083 struct bch_replace_info *replace = container_of(hook,
1084 struct bch_replace_info, hook);
1085 struct bkey_i *old = &replace->key;
1087 EBUG_ON(bkey_cmp(committed_pos, bkey_start_pos(&new->k)) < 0);
1089 /* must have something to compare against */
1090 EBUG_ON(!bkey_val_u64s(&old->k));
1092 /* new must be a subset of old */
1093 EBUG_ON(bkey_cmp(new->k.p, old->k.p) > 0 ||
1094 bkey_cmp(bkey_start_pos(&new->k), bkey_start_pos(&old->k)) < 0);
1096 if (k.k && bch_extent_cmpxchg_cmp(k, bkey_i_to_s_c(old))) {
1097 replace->successes++;
1098 return BTREE_HOOK_DO_INSERT;
1100 replace->failures++;
1101 return BTREE_HOOK_NO_INSERT;
1105 static bool bch_extent_merge_inline(struct bch_fs *,
1106 struct btree_iter *,
1107 struct bkey_packed *,
1108 struct bkey_packed *,
1111 #define MAX_LOCK_HOLD_TIME (5 * NSEC_PER_MSEC)
1113 static enum btree_insert_ret
1114 extent_insert_should_stop(struct extent_insert_state *s)
1116 struct btree *b = s->insert->iter->nodes[0];
1119 * Check if we have sufficient space in both the btree node and the
1120 * journal reservation:
1122 * Each insert checks for room in the journal entry, but we check for
1123 * room in the btree node up-front. In the worst case, bkey_cmpxchg()
1124 * will insert two keys, and one iteration of this room will insert one
1125 * key, so we need room for three keys.
1127 if (!bch_btree_node_insert_fits(s->trans->c, b, s->insert->k->k.u64s))
1128 return BTREE_INSERT_BTREE_NODE_FULL;
1129 else if (!journal_res_insert_fits(s->trans, s->insert))
1130 return BTREE_INSERT_JOURNAL_RES_FULL; /* XXX worth tracing */
1132 return BTREE_INSERT_OK;
1135 static void extent_bset_insert(struct bch_fs *c, struct btree_iter *iter,
1136 struct bkey_i *insert)
1138 struct btree *b = iter->nodes[0];
1139 struct btree_node_iter *node_iter = &iter->node_iters[0];
1140 struct bset_tree *t = bset_tree_last(b);
1141 struct bkey_packed *where =
1142 bch_btree_node_iter_bset_pos(node_iter, b, t);
1143 struct bkey_packed *prev = bkey_prev(b, t, where);
1144 struct bkey_packed *next_live_key = where;
1145 unsigned clobber_u64s;
1148 where = bkey_next(prev);
1150 while (next_live_key != btree_bkey_last(b, t) &&
1151 bkey_deleted(next_live_key))
1152 next_live_key = bkey_next(next_live_key);
1155 * Everything between where and next_live_key is now deleted keys, and
1158 clobber_u64s = (u64 *) next_live_key - (u64 *) where;
1161 bch_extent_merge_inline(c, iter, prev, bkey_to_packed(insert), true))
1162 goto drop_deleted_keys;
1164 if (next_live_key != btree_bkey_last(b, t) &&
1165 bch_extent_merge_inline(c, iter, bkey_to_packed(insert),
1166 next_live_key, false))
1167 goto drop_deleted_keys;
1169 bch_bset_insert(b, node_iter, where, insert, clobber_u64s);
1170 bch_btree_node_iter_fix(iter, b, node_iter, t, where,
1171 clobber_u64s, where->u64s);
1174 bch_bset_delete(b, where, clobber_u64s);
1175 bch_btree_node_iter_fix(iter, b, node_iter, t, where, clobber_u64s, 0);
1178 static void extent_insert_committed(struct extent_insert_state *s)
1180 struct bch_fs *c = s->trans->c;
1181 struct btree_iter *iter = s->insert->iter;
1182 struct bkey_i *insert = !s->deleting
1185 BKEY_PADDED(k) split;
1187 EBUG_ON(bkey_cmp(insert->k.p, s->committed) < 0);
1188 EBUG_ON(bkey_cmp(s->committed, bkey_start_pos(&insert->k)) < 0);
1190 if (!bkey_cmp(s->committed, bkey_start_pos(&insert->k)))
1193 if (s->deleting && !s->do_journal) {
1194 bch_cut_front(s->committed, insert);
1198 EBUG_ON(bkey_deleted(&insert->k) || !insert->k.size);
1200 bkey_copy(&split.k, insert);
1202 if (!(s->trans->flags & BTREE_INSERT_JOURNAL_REPLAY) &&
1203 bkey_cmp(s->committed, insert->k.p) &&
1204 bkey_extent_is_compressed(bkey_i_to_s_c(insert))) {
1205 /* XXX: possibly need to increase our reservation? */
1206 bch_cut_subtract_back(s, s->committed,
1207 bkey_i_to_s(&split.k));
1208 bch_cut_front(s->committed, insert);
1209 bch_add_sectors(s, bkey_i_to_s_c(insert),
1210 bkey_start_offset(&insert->k),
1213 bch_cut_back(s->committed, &split.k.k);
1214 bch_cut_front(s->committed, insert);
1217 if (debug_check_bkeys(c))
1218 bkey_debugcheck(c, iter->nodes[iter->level],
1219 bkey_i_to_s_c(&split.k));
1221 bch_btree_journal_key(s->trans, iter, &split.k);
1224 extent_bset_insert(c, iter, &split.k);
1226 bch_btree_iter_set_pos_same_leaf(iter, s->committed);
1228 insert->k.needs_whiteout = false;
1229 s->do_journal = false;
1230 s->trans->did_work = true;
1233 static enum extent_insert_hook_ret
1234 __extent_insert_advance_pos(struct extent_insert_state *s,
1235 struct bpos next_pos,
1238 struct extent_insert_hook *hook = s->trans->hook;
1239 enum extent_insert_hook_ret ret;
1242 * Currently disabled for encryption - broken with fcollapse. Will have
1243 * to reenable when versions are exposed for send/receive - versions
1244 * will have to be monotonic then:
1246 if (k.k && k.k->size &&
1247 !bversion_zero(s->insert->k->k.version) &&
1248 bversion_cmp(k.k->version, s->insert->k->k.version) > 0) {
1249 ret = BTREE_HOOK_NO_INSERT;
1253 ret = hook->fn(hook, s->committed, next_pos, k, s->insert->k);
1255 ret = BTREE_HOOK_DO_INSERT;
1257 EBUG_ON(bkey_deleted(&s->insert->k->k) || !s->insert->k->k.size);
1260 case BTREE_HOOK_DO_INSERT:
1262 case BTREE_HOOK_NO_INSERT:
1263 extent_insert_committed(s);
1264 bch_cut_subtract_front(s, next_pos, bkey_i_to_s(s->insert->k));
1266 bch_btree_iter_set_pos_same_leaf(s->insert->iter, next_pos);
1268 case BTREE_HOOK_RESTART_TRANS:
1272 s->committed = next_pos;
1277 * Update iter->pos, marking how much of @insert we've processed, and call hook
1280 static enum extent_insert_hook_ret
1281 extent_insert_advance_pos(struct extent_insert_state *s, struct bkey_s_c k)
1283 struct btree *b = s->insert->iter->nodes[0];
1284 struct bpos next_pos = bpos_min(s->insert->k->k.p,
1285 k.k ? k.k->p : b->key.k.p);
1288 if (k.k && bkey_cmp(s->committed, bkey_start_pos(k.k)) < 0) {
1289 bool have_uncommitted = bkey_cmp(s->committed,
1290 bkey_start_pos(&s->insert->k->k)) > 0;
1292 switch (__extent_insert_advance_pos(s, bkey_start_pos(k.k),
1294 case BTREE_HOOK_DO_INSERT:
1296 case BTREE_HOOK_NO_INSERT:
1298 * we had to split @insert and insert the committed
1299 * part - need to bail out and recheck journal
1300 * reservation/btree node before we advance pos past @k:
1302 if (have_uncommitted)
1303 return BTREE_HOOK_NO_INSERT;
1305 case BTREE_HOOK_RESTART_TRANS:
1306 return BTREE_HOOK_RESTART_TRANS;
1310 /* avoid redundant calls to hook fn: */
1311 if (!bkey_cmp(s->committed, next_pos))
1312 return BTREE_HOOK_DO_INSERT;
1314 return __extent_insert_advance_pos(s, next_pos, k);
1317 static enum btree_insert_ret
1318 extent_insert_check_split_compressed(struct extent_insert_state *s,
1320 enum bch_extent_overlap overlap)
1322 struct bch_fs *c = s->trans->c;
1325 if (overlap == BCH_EXTENT_OVERLAP_MIDDLE &&
1326 (sectors = bkey_extent_is_compressed(k))) {
1327 int flags = BCH_DISK_RESERVATION_BTREE_LOCKS_HELD;
1329 if (s->trans->flags & BTREE_INSERT_NOFAIL)
1330 flags |= BCH_DISK_RESERVATION_NOFAIL;
1332 switch (bch_disk_reservation_add(c,
1338 return BTREE_INSERT_ENOSPC;
1340 return BTREE_INSERT_NEED_GC_LOCK;
1346 return BTREE_INSERT_OK;
1349 static enum btree_insert_ret
1350 extent_squash(struct extent_insert_state *s, struct bkey_i *insert,
1351 struct bset_tree *t, struct bkey_packed *_k, struct bkey_s k,
1352 enum bch_extent_overlap overlap)
1354 struct bch_fs *c = s->trans->c;
1355 struct btree_iter *iter = s->insert->iter;
1356 struct btree *b = iter->nodes[0];
1357 struct btree_node_iter *node_iter = &iter->node_iters[0];
1360 case BCH_EXTENT_OVERLAP_FRONT:
1361 /* insert overlaps with start of k: */
1362 bch_cut_subtract_front(s, insert->k.p, k);
1363 BUG_ON(bkey_deleted(k.k));
1364 extent_save(b, node_iter, _k, k.k);
1367 case BCH_EXTENT_OVERLAP_BACK:
1368 /* insert overlaps with end of k: */
1369 bch_cut_subtract_back(s, bkey_start_pos(&insert->k), k);
1370 BUG_ON(bkey_deleted(k.k));
1371 extent_save(b, node_iter, _k, k.k);
1374 * As the auxiliary tree is indexed by the end of the
1375 * key and we've just changed the end, update the
1378 bch_bset_fix_invalidated_key(b, t, _k);
1379 bch_btree_node_iter_fix(iter, b, node_iter, t,
1380 _k, _k->u64s, _k->u64s);
1383 case BCH_EXTENT_OVERLAP_ALL: {
1384 struct bpos orig_pos = k.k->p;
1386 /* The insert key completely covers k, invalidate k */
1387 if (!bkey_whiteout(k.k))
1388 btree_keys_account_key_drop(&b->nr,
1391 bch_drop_subtract(s, k);
1392 k.k->p = bkey_start_pos(&insert->k);
1393 if (!__extent_save(b, node_iter, _k, k.k)) {
1395 * Couldn't repack: we aren't necessarily able
1396 * to repack if the new key is outside the range
1397 * of the old extent, so we have to split
1401 extent_save(b, node_iter, _k, k.k);
1403 if (extent_insert_advance_pos(s, k.s_c) ==
1404 BTREE_HOOK_RESTART_TRANS)
1405 return BTREE_INSERT_NEED_TRAVERSE;
1407 extent_insert_committed(s);
1409 * We split and inserted upto at k.k->p - that
1410 * has to coincide with iter->pos, so that we
1411 * don't have anything more we have to insert
1412 * until we recheck our journal reservation:
1414 EBUG_ON(bkey_cmp(s->committed, k.k->p));
1416 bch_bset_fix_invalidated_key(b, t, _k);
1417 bch_btree_node_iter_fix(iter, b, node_iter, t,
1418 _k, _k->u64s, _k->u64s);
1423 case BCH_EXTENT_OVERLAP_MIDDLE: {
1424 BKEY_PADDED(k) split;
1426 * The insert key falls 'in the middle' of k
1427 * The insert key splits k in 3:
1428 * - start only in k, preserve
1429 * - middle common section, invalidate in k
1430 * - end only in k, preserve
1432 * We update the old key to preserve the start,
1433 * insert will be the new common section,
1434 * we manually insert the end that we are preserving.
1436 * modify k _before_ doing the insert (which will move
1439 bkey_reassemble(&split.k, k.s_c);
1440 split.k.k.needs_whiteout |= bset_written(b, bset(b, t));
1442 bch_cut_back(bkey_start_pos(&insert->k), &split.k.k);
1443 BUG_ON(bkey_deleted(&split.k.k));
1445 bch_cut_subtract_front(s, insert->k.p, k);
1446 BUG_ON(bkey_deleted(k.k));
1447 extent_save(b, node_iter, _k, k.k);
1449 bch_add_sectors(s, bkey_i_to_s_c(&split.k),
1450 bkey_start_offset(&split.k.k),
1452 extent_bset_insert(c, iter, &split.k);
1457 return BTREE_INSERT_OK;
1460 static enum btree_insert_ret
1461 bch_delete_fixup_extent(struct extent_insert_state *s)
1463 struct bch_fs *c = s->trans->c;
1464 struct btree_iter *iter = s->insert->iter;
1465 struct btree *b = iter->nodes[0];
1466 struct btree_node_iter *node_iter = &iter->node_iters[0];
1467 struct bkey_packed *_k;
1468 struct bkey unpacked;
1469 struct bkey_i *insert = s->insert->k;
1470 enum btree_insert_ret ret = BTREE_INSERT_OK;
1472 EBUG_ON(bkey_cmp(iter->pos, bkey_start_pos(&insert->k)));
1474 s->whiteout = *insert;
1475 s->do_journal = false;
1477 while (bkey_cmp(s->committed, insert->k.p) < 0 &&
1478 (ret = extent_insert_should_stop(s)) == BTREE_INSERT_OK &&
1479 (_k = bch_btree_node_iter_peek_all(node_iter, b))) {
1480 struct bset_tree *t = bch_bkey_to_bset(b, _k);
1481 struct bkey_s k = __bkey_disassemble(b, _k, &unpacked);
1482 enum bch_extent_overlap overlap;
1484 EBUG_ON(bkey_cmp(iter->pos, bkey_start_pos(&insert->k)));
1485 EBUG_ON(bkey_cmp(iter->pos, k.k->p) >= 0);
1487 if (bkey_cmp(bkey_start_pos(k.k), insert->k.p) >= 0)
1490 if (bkey_whiteout(k.k)) {
1491 s->committed = bpos_min(insert->k.p, k.k->p);
1495 overlap = bch_extent_overlap(&insert->k, k.k);
1497 ret = extent_insert_check_split_compressed(s, k.s_c, overlap);
1498 if (ret != BTREE_INSERT_OK)
1501 switch (extent_insert_advance_pos(s, k.s_c)) {
1502 case BTREE_HOOK_DO_INSERT:
1504 case BTREE_HOOK_NO_INSERT:
1506 case BTREE_HOOK_RESTART_TRANS:
1507 ret = BTREE_INSERT_NEED_TRAVERSE;
1511 s->do_journal = true;
1513 if (overlap == BCH_EXTENT_OVERLAP_ALL) {
1514 btree_keys_account_key_drop(&b->nr,
1516 bch_subtract_sectors(s, k.s_c,
1517 bkey_start_offset(k.k), k.k->size);
1518 _k->type = KEY_TYPE_DISCARD;
1519 reserve_whiteout(b, t, _k);
1520 } else if (k.k->needs_whiteout ||
1521 bset_written(b, bset(b, t))) {
1522 struct bkey_i discard = *insert;
1525 case BCH_EXTENT_OVERLAP_FRONT:
1526 bch_cut_front(bkey_start_pos(k.k), &discard);
1528 case BCH_EXTENT_OVERLAP_BACK:
1529 bch_cut_back(k.k->p, &discard.k);
1535 discard.k.needs_whiteout = true;
1537 ret = extent_squash(s, insert, t, _k, k, overlap);
1538 BUG_ON(ret != BTREE_INSERT_OK);
1540 extent_bset_insert(c, iter, &discard);
1542 ret = extent_squash(s, insert, t, _k, k, overlap);
1543 BUG_ON(ret != BTREE_INSERT_OK);
1546 bch_cut_front(s->committed, insert);
1547 bch_btree_iter_set_pos_same_leaf(iter, s->committed);
1550 if (bkey_cmp(s->committed, insert->k.p) < 0 &&
1551 ret == BTREE_INSERT_OK &&
1552 extent_insert_advance_pos(s, bkey_s_c_null) == BTREE_HOOK_RESTART_TRANS)
1553 ret = BTREE_INSERT_NEED_TRAVERSE;
1555 extent_insert_committed(s);
1557 bch_fs_stats_apply(c, &s->stats, s->trans->disk_res,
1558 gc_pos_btree_node(b));
1560 EBUG_ON(bkey_cmp(iter->pos, s->committed));
1561 EBUG_ON((bkey_cmp(iter->pos, b->key.k.p) == 0) != iter->at_end_of_leaf);
1563 bch_cut_front(iter->pos, insert);
1565 if (insert->k.size && iter->at_end_of_leaf)
1566 ret = BTREE_INSERT_NEED_TRAVERSE;
1568 EBUG_ON(insert->k.size && ret == BTREE_INSERT_OK);
1574 * bch_extent_insert_fixup - insert a new extent and deal with overlaps
1576 * this may result in not actually doing the insert, or inserting some subset
1577 * of the insert key. For cmpxchg operations this is where that logic lives.
1579 * All subsets of @insert that need to be inserted are inserted using
1580 * bch_btree_insert_and_journal(). If @b or @res fills up, this function
1581 * returns false, setting @iter->pos for the prefix of @insert that actually got
1584 * BSET INVARIANTS: this function is responsible for maintaining all the
1585 * invariants for bsets of extents in memory. things get really hairy with 0
1590 * bkey_start_pos(bkey_next(k)) >= k
1591 * or bkey_start_offset(bkey_next(k)) >= k->offset
1593 * i.e. strict ordering, no overlapping extents.
1595 * multiple bsets (i.e. full btree node):
1598 * k.size != 0 ∧ j.size != 0 →
1599 * ¬ (k > bkey_start_pos(j) ∧ k < j)
1601 * i.e. no two overlapping keys _of nonzero size_
1603 * We can't realistically maintain this invariant for zero size keys because of
1604 * the key merging done in bch_btree_insert_key() - for two mergeable keys k, j
1605 * there may be another 0 size key between them in another bset, and it will
1606 * thus overlap with the merged key.
1608 * In addition, the end of iter->pos indicates how much has been processed.
1609 * If the end of iter->pos is not the same as the end of insert, then
1610 * key insertion needs to continue/be retried.
1612 enum btree_insert_ret
1613 bch_insert_fixup_extent(struct btree_insert *trans,
1614 struct btree_insert_entry *insert)
1616 struct bch_fs *c = trans->c;
1617 struct btree_iter *iter = insert->iter;
1618 struct btree *b = iter->nodes[0];
1619 struct btree_node_iter *node_iter = &iter->node_iters[0];
1620 struct bkey_packed *_k;
1621 struct bkey unpacked;
1622 enum btree_insert_ret ret = BTREE_INSERT_OK;
1624 struct extent_insert_state s = {
1627 .committed = insert->iter->pos,
1628 .deleting = bkey_whiteout(&insert->k->k),
1631 EBUG_ON(iter->level);
1632 EBUG_ON(bkey_deleted(&insert->k->k) || !insert->k->k.size);
1635 return bch_delete_fixup_extent(&s);
1638 * As we process overlapping extents, we advance @iter->pos both to
1639 * signal to our caller (btree_insert_key()) how much of @insert->k has
1640 * been inserted, and also to keep @iter->pos consistent with
1641 * @insert->k and the node iterator that we're advancing:
1643 EBUG_ON(bkey_cmp(iter->pos, bkey_start_pos(&insert->k->k)));
1645 if (!(trans->flags & BTREE_INSERT_JOURNAL_REPLAY))
1646 bch_add_sectors(&s, bkey_i_to_s_c(insert->k),
1647 bkey_start_offset(&insert->k->k),
1650 while (bkey_cmp(s.committed, insert->k->k.p) < 0 &&
1651 (ret = extent_insert_should_stop(&s)) == BTREE_INSERT_OK &&
1652 (_k = bch_btree_node_iter_peek_all(node_iter, b))) {
1653 struct bset_tree *t = bch_bkey_to_bset(b, _k);
1654 struct bkey_s k = __bkey_disassemble(b, _k, &unpacked);
1655 enum bch_extent_overlap overlap;
1657 EBUG_ON(bkey_cmp(iter->pos, bkey_start_pos(&insert->k->k)));
1658 EBUG_ON(bkey_cmp(iter->pos, k.k->p) >= 0);
1660 if (bkey_cmp(bkey_start_pos(k.k), insert->k->k.p) >= 0)
1663 overlap = bch_extent_overlap(&insert->k->k, k.k);
1665 ret = extent_insert_check_split_compressed(&s, k.s_c, overlap);
1666 if (ret != BTREE_INSERT_OK)
1673 * Only call advance pos & call hook for nonzero size extents:
1674 * If hook returned BTREE_HOOK_NO_INSERT, @insert->k no longer
1677 switch (extent_insert_advance_pos(&s, k.s_c)) {
1678 case BTREE_HOOK_DO_INSERT:
1680 case BTREE_HOOK_NO_INSERT:
1682 case BTREE_HOOK_RESTART_TRANS:
1683 ret = BTREE_INSERT_NEED_TRAVERSE;
1688 (k.k->needs_whiteout || bset_written(b, bset(b, t))))
1689 insert->k->k.needs_whiteout = true;
1691 if (overlap == BCH_EXTENT_OVERLAP_ALL &&
1692 bkey_whiteout(k.k) &&
1693 k.k->needs_whiteout) {
1694 unreserve_whiteout(b, t, _k);
1695 _k->needs_whiteout = false;
1698 ret = extent_squash(&s, insert->k, t, _k, k, overlap);
1699 if (ret != BTREE_INSERT_OK)
1703 if (bkey_cmp(s.committed, insert->k->k.p) < 0 &&
1704 ret == BTREE_INSERT_OK &&
1705 extent_insert_advance_pos(&s, bkey_s_c_null) == BTREE_HOOK_RESTART_TRANS)
1706 ret = BTREE_INSERT_NEED_TRAVERSE;
1708 extent_insert_committed(&s);
1710 * Subtract any remaining sectors from @insert, if we bailed out early
1711 * and didn't fully insert @insert:
1713 if (insert->k->k.size &&
1714 !(trans->flags & BTREE_INSERT_JOURNAL_REPLAY))
1715 bch_subtract_sectors(&s, bkey_i_to_s_c(insert->k),
1716 bkey_start_offset(&insert->k->k),
1719 bch_fs_stats_apply(c, &s.stats, trans->disk_res,
1720 gc_pos_btree_node(b));
1722 EBUG_ON(bkey_cmp(iter->pos, bkey_start_pos(&insert->k->k)));
1723 EBUG_ON(bkey_cmp(iter->pos, s.committed));
1724 EBUG_ON((bkey_cmp(iter->pos, b->key.k.p) == 0) != iter->at_end_of_leaf);
1726 if (insert->k->k.size && iter->at_end_of_leaf)
1727 ret = BTREE_INSERT_NEED_TRAVERSE;
1729 EBUG_ON(insert->k->k.size && ret == BTREE_INSERT_OK);
1734 static const char *bch_extent_invalid(const struct bch_fs *c,
1737 if (bkey_val_u64s(k.k) > BKEY_EXTENT_VAL_U64s_MAX)
1738 return "value too big";
1741 return "zero key size";
1743 switch (k.k->type) {
1745 case BCH_EXTENT_CACHED: {
1746 struct bkey_s_c_extent e = bkey_s_c_to_extent(k);
1747 const union bch_extent_entry *entry;
1748 const union bch_extent_crc *crc;
1749 const struct bch_extent_ptr *ptr;
1750 unsigned size_ondisk = e.k->size;
1753 extent_for_each_entry(e, entry) {
1754 if (__extent_entry_type(entry) >= BCH_EXTENT_ENTRY_MAX)
1755 return "invalid extent entry type";
1757 if (extent_entry_is_crc(entry)) {
1758 crc = entry_to_crc(entry);
1760 if (crc_offset(crc) + e.k->size >
1761 crc_uncompressed_size(e.k, crc))
1762 return "checksum offset + key size > uncompressed size";
1764 size_ondisk = crc_compressed_size(e.k, crc);
1766 if (!bch_checksum_type_valid(c, crc_csum_type(crc)))
1767 return "invalid checksum type";
1769 if (crc_compression_type(crc) >= BCH_COMPRESSION_NR)
1770 return "invalid compression type";
1772 ptr = entry_to_ptr(entry);
1774 reason = extent_ptr_invalid(c, e, &entry->ptr,
1775 size_ondisk, false);
1784 case BCH_RESERVATION: {
1785 struct bkey_s_c_reservation r = bkey_s_c_to_reservation(k);
1787 if (bkey_val_bytes(k.k) != sizeof(struct bch_reservation))
1788 return "incorrect value size";
1790 if (!r.v->nr_replicas || r.v->nr_replicas > BCH_REPLICAS_MAX)
1791 return "invalid nr_replicas";
1797 return "invalid value type";
1801 static void bch_extent_debugcheck_extent(struct bch_fs *c, struct btree *b,
1802 struct bkey_s_c_extent e)
1804 const struct bch_extent_ptr *ptr;
1807 unsigned seq, stale;
1810 unsigned ptrs_per_tier[BCH_TIER_MAX];
1811 unsigned replicas = 0;
1814 * XXX: we should be doing most/all of these checks at startup time,
1815 * where we check bkey_invalid() in btree_node_read_done()
1817 * But note that we can't check for stale pointers or incorrect gc marks
1818 * until after journal replay is done (it might be an extent that's
1819 * going to get overwritten during replay)
1822 memset(ptrs_per_tier, 0, sizeof(ptrs_per_tier));
1824 extent_for_each_ptr(e, ptr) {
1825 ca = c->devs[ptr->dev];
1826 g = PTR_BUCKET(ca, ptr);
1828 ptrs_per_tier[ca->mi.tier]++;
1831 * If journal replay hasn't finished, we might be seeing keys
1832 * that will be overwritten by the time journal replay is done:
1834 if (!test_bit(JOURNAL_REPLAY_DONE, &c->journal.flags))
1840 struct bucket_mark mark;
1842 seq = read_seqcount_begin(&c->gc_pos_lock);
1843 mark = READ_ONCE(g->mark);
1845 /* between mark and bucket gen */
1848 stale = ptr_stale(ca, ptr);
1850 bch_fs_bug_on(stale && !ptr->cached, c,
1851 "stale dirty pointer");
1853 bch_fs_bug_on(stale > 96, c,
1854 "key too stale: %i",
1860 bad = (mark.data_type != BUCKET_DATA ||
1861 (gc_pos_cmp(c->gc_pos, gc_pos_btree_node(b)) > 0 &&
1862 !mark.owned_by_allocator &&
1864 ? mark.cached_sectors
1865 : mark.dirty_sectors)));
1866 } while (read_seqcount_retry(&c->gc_pos_lock, seq));
1872 if (replicas > BCH_REPLICAS_MAX) {
1873 bch_bkey_val_to_text(c, btree_node_type(b), buf,
1874 sizeof(buf), e.s_c);
1876 "extent key bad (too many replicas: %u): %s",
1881 if (!bkey_extent_is_cached(e.k) &&
1882 replicas < c->sb.data_replicas_have) {
1883 bch_bkey_val_to_text(c, btree_node_type(b), buf,
1884 sizeof(buf), e.s_c);
1886 "extent key bad (too few replicas, %u < %u): %s",
1887 replicas, c->sb.data_replicas_have, buf);
1894 bch_bkey_val_to_text(c, btree_node_type(b), buf,
1895 sizeof(buf), e.s_c);
1896 bch_fs_bug(c, "extent pointer bad gc mark: %s:\nbucket %zu prio %i "
1897 "gen %i last_gc %i mark 0x%08x",
1898 buf, PTR_BUCKET_NR(ca, ptr),
1899 g->read_prio, PTR_BUCKET(ca, ptr)->mark.gen,
1900 ca->oldest_gens[PTR_BUCKET_NR(ca, ptr)],
1901 (unsigned) g->mark.counter);
1905 static void bch_extent_debugcheck(struct bch_fs *c, struct btree *b,
1908 switch (k.k->type) {
1910 case BCH_EXTENT_CACHED:
1911 bch_extent_debugcheck_extent(c, b, bkey_s_c_to_extent(k));
1913 case BCH_RESERVATION:
1920 static void bch_extent_to_text(struct bch_fs *c, char *buf,
1921 size_t size, struct bkey_s_c k)
1923 char *out = buf, *end = buf + size;
1924 const char *invalid;
1926 #define p(...) (out += scnprintf(out, end - out, __VA_ARGS__))
1928 if (bkey_extent_is_data(k.k))
1929 out += extent_print_ptrs(c, buf, size, bkey_s_c_to_extent(k));
1931 invalid = bch_extent_invalid(c, k);
1933 p(" invalid: %s", invalid);
1937 static unsigned PTR_TIER(struct bch_fs *c,
1938 const struct bch_extent_ptr *ptr)
1940 return c->devs[ptr->dev]->mi.tier;
1943 static void bch_extent_crc_init(union bch_extent_crc *crc,
1944 unsigned compressed_size,
1945 unsigned uncompressed_size,
1946 unsigned compression_type,
1948 struct bch_csum csum, unsigned csum_type)
1950 if (bch_crc_bytes[csum_type] <= 4 &&
1951 uncompressed_size <= CRC32_SIZE_MAX &&
1952 nonce <= CRC32_NONCE_MAX) {
1953 crc->crc32 = (struct bch_extent_crc32) {
1954 .type = 1 << BCH_EXTENT_ENTRY_crc32,
1955 ._compressed_size = compressed_size - 1,
1956 ._uncompressed_size = uncompressed_size - 1,
1958 .compression_type = compression_type,
1959 .csum_type = csum_type,
1960 .csum = *((__le32 *) &csum.lo),
1965 if (bch_crc_bytes[csum_type] <= 10 &&
1966 uncompressed_size <= CRC64_SIZE_MAX &&
1967 nonce <= CRC64_NONCE_MAX) {
1968 crc->crc64 = (struct bch_extent_crc64) {
1969 .type = 1 << BCH_EXTENT_ENTRY_crc64,
1970 ._compressed_size = compressed_size - 1,
1971 ._uncompressed_size = uncompressed_size - 1,
1974 .compression_type = compression_type,
1975 .csum_type = csum_type,
1977 .csum_hi = *((__le16 *) &csum.hi),
1982 if (bch_crc_bytes[csum_type] <= 16 &&
1983 uncompressed_size <= CRC128_SIZE_MAX &&
1984 nonce <= CRC128_NONCE_MAX) {
1985 crc->crc128 = (struct bch_extent_crc128) {
1986 .type = 1 << BCH_EXTENT_ENTRY_crc128,
1987 ._compressed_size = compressed_size - 1,
1988 ._uncompressed_size = uncompressed_size - 1,
1991 .compression_type = compression_type,
1992 .csum_type = csum_type,
2001 void bch_extent_crc_append(struct bkey_i_extent *e,
2002 unsigned compressed_size,
2003 unsigned uncompressed_size,
2004 unsigned compression_type,
2006 struct bch_csum csum, unsigned csum_type)
2008 union bch_extent_crc *crc;
2010 BUG_ON(compressed_size > uncompressed_size);
2011 BUG_ON(uncompressed_size != e->k.size);
2012 BUG_ON(!compressed_size || !uncompressed_size);
2015 * Look up the last crc entry, so we can check if we need to add
2018 extent_for_each_crc(extent_i_to_s(e), crc)
2021 if (!crc && !csum_type && !compression_type)
2025 crc_compressed_size(&e->k, crc) == compressed_size &&
2026 crc_uncompressed_size(&e->k, crc) == uncompressed_size &&
2027 crc_offset(crc) == 0 &&
2028 crc_nonce(crc) == nonce &&
2029 crc_csum_type(crc) == csum_type &&
2030 crc_compression_type(crc) == compression_type &&
2031 crc_csum(crc).lo == csum.lo &&
2032 crc_csum(crc).hi == csum.hi)
2035 bch_extent_crc_init((void *) extent_entry_last(extent_i_to_s(e)),
2039 nonce, csum, csum_type);
2040 __extent_entry_push(e);
2044 * bch_extent_normalize - clean up an extent, dropping stale pointers etc.
2046 * Returns true if @k should be dropped entirely
2048 * For existing keys, only called when btree nodes are being rewritten, not when
2049 * they're merely being compacted/resorted in memory.
2051 bool bch_extent_normalize(struct bch_fs *c, struct bkey_s k)
2053 struct bkey_s_extent e;
2055 switch (k.k->type) {
2056 case KEY_TYPE_ERROR:
2059 case KEY_TYPE_DELETED:
2060 case KEY_TYPE_COOKIE:
2063 case KEY_TYPE_DISCARD:
2064 return bversion_zero(k.k->version);
2067 case BCH_EXTENT_CACHED:
2068 e = bkey_s_to_extent(k);
2070 bch_extent_drop_stale(c, e);
2072 if (!bkey_val_u64s(e.k)) {
2073 if (bkey_extent_is_cached(e.k)) {
2074 k.k->type = KEY_TYPE_DISCARD;
2075 if (bversion_zero(k.k->version))
2078 k.k->type = KEY_TYPE_ERROR;
2083 case BCH_RESERVATION:
2090 void bch_extent_mark_replicas_cached(struct bch_fs *c,
2091 struct bkey_s_extent e,
2094 struct bch_extent_ptr *ptr;
2095 bool have_higher_tier;
2102 have_higher_tier = false;
2104 extent_for_each_ptr(e, ptr) {
2106 PTR_TIER(c, ptr) == tier) {
2113 if (PTR_TIER(c, ptr) > tier)
2114 have_higher_tier = true;
2118 } while (have_higher_tier);
2122 * This picks a non-stale pointer, preferabbly from a device other than
2123 * avoid. Avoid can be NULL, meaning pick any. If there are no non-stale
2124 * pointers to other devices, it will still pick a pointer from avoid.
2125 * Note that it prefers lowered-numbered pointers to higher-numbered pointers
2126 * as the pointers are sorted by tier, hence preferring pointers to tier 0
2127 * rather than pointers to tier 1.
2129 void bch_extent_pick_ptr_avoiding(struct bch_fs *c, struct bkey_s_c k,
2130 struct bch_dev *avoid,
2131 struct extent_pick_ptr *ret)
2133 struct bkey_s_c_extent e;
2134 const union bch_extent_crc *crc;
2135 const struct bch_extent_ptr *ptr;
2137 switch (k.k->type) {
2138 case KEY_TYPE_DELETED:
2139 case KEY_TYPE_DISCARD:
2140 case KEY_TYPE_COOKIE:
2144 case KEY_TYPE_ERROR:
2145 ret->ca = ERR_PTR(-EIO);
2149 case BCH_EXTENT_CACHED:
2150 e = bkey_s_c_to_extent(k);
2153 extent_for_each_ptr_crc(e, ptr, crc) {
2154 struct bch_dev *ca = c->devs[ptr->dev];
2156 if (ptr_stale(ca, ptr))
2159 if (ca->mi.state == BCH_MEMBER_STATE_FAILED)
2164 ret->ca->mi.tier < ca->mi.tier))
2167 if (!percpu_ref_tryget(&ca->io_ref))
2171 percpu_ref_put(&ret->ca->io_ref);
2173 *ret = (struct extent_pick_ptr) {
2174 .crc = crc_to_128(e.k, crc),
2180 if (!ret->ca && !bkey_extent_is_cached(e.k))
2181 ret->ca = ERR_PTR(-EIO);
2184 case BCH_RESERVATION:
2193 static enum merge_result bch_extent_merge(struct bch_fs *c,
2195 struct bkey_i *l, struct bkey_i *r)
2197 struct bkey_s_extent el, er;
2198 union bch_extent_entry *en_l, *en_r;
2200 if (key_merging_disabled(c))
2201 return BCH_MERGE_NOMERGE;
2204 * Generic header checks
2205 * Assumes left and right are in order
2206 * Left and right must be exactly aligned
2209 if (l->k.u64s != r->k.u64s ||
2210 l->k.type != r->k.type ||
2211 bversion_cmp(l->k.version, r->k.version) ||
2212 bkey_cmp(l->k.p, bkey_start_pos(&r->k)))
2213 return BCH_MERGE_NOMERGE;
2215 switch (l->k.type) {
2216 case KEY_TYPE_DELETED:
2217 case KEY_TYPE_DISCARD:
2218 case KEY_TYPE_ERROR:
2219 /* These types are mergeable, and no val to check */
2223 case BCH_EXTENT_CACHED:
2224 el = bkey_i_to_s_extent(l);
2225 er = bkey_i_to_s_extent(r);
2227 extent_for_each_entry(el, en_l) {
2228 struct bch_extent_ptr *lp, *rp;
2229 unsigned bucket_size;
2231 en_r = vstruct_idx(er.v, (u64 *) en_l - el.v->_data);
2233 if ((extent_entry_type(en_l) !=
2234 extent_entry_type(en_r)) ||
2235 extent_entry_is_crc(en_l))
2236 return BCH_MERGE_NOMERGE;
2241 if (lp->offset + el.k->size != rp->offset ||
2242 lp->dev != rp->dev ||
2244 return BCH_MERGE_NOMERGE;
2246 /* We don't allow extents to straddle buckets: */
2247 bucket_size = c->devs[lp->dev]->mi.bucket_size;
2249 if ((lp->offset & ~((u64) bucket_size - 1)) !=
2250 (rp->offset & ~((u64) bucket_size - 1)))
2251 return BCH_MERGE_NOMERGE;
2255 case BCH_RESERVATION: {
2256 struct bkey_i_reservation *li = bkey_i_to_reservation(l);
2257 struct bkey_i_reservation *ri = bkey_i_to_reservation(r);
2259 if (li->v.generation != ri->v.generation ||
2260 li->v.nr_replicas != ri->v.nr_replicas)
2261 return BCH_MERGE_NOMERGE;
2265 return BCH_MERGE_NOMERGE;
2268 l->k.needs_whiteout |= r->k.needs_whiteout;
2270 /* Keys with no pointers aren't restricted to one bucket and could
2273 if ((u64) l->k.size + r->k.size > KEY_SIZE_MAX) {
2274 bch_key_resize(&l->k, KEY_SIZE_MAX);
2275 bch_cut_front(l->k.p, r);
2276 return BCH_MERGE_PARTIAL;
2279 bch_key_resize(&l->k, l->k.size + r->k.size);
2281 return BCH_MERGE_MERGE;
2284 static void extent_i_save(struct btree *b, struct bkey_packed *dst,
2287 struct bkey_format *f = &b->format;
2288 struct bkey_i *dst_unpacked;
2290 BUG_ON(bkeyp_val_u64s(f, dst) != bkey_val_u64s(&src->k));
2293 * We don't want the bch_verify_key_order() call in extent_save(),
2294 * because we may be out of order with deleted keys that are about to be
2295 * removed by extent_bset_insert()
2298 if ((dst_unpacked = packed_to_bkey(dst)))
2299 bkey_copy(dst_unpacked, src);
2301 BUG_ON(!bkey_pack(dst, src, f));
2304 static bool extent_merge_one_overlapping(struct btree_iter *iter,
2305 struct bpos new_pos,
2306 struct bset_tree *t,
2307 struct bkey_packed *k, struct bkey uk,
2308 bool check, bool could_pack)
2310 struct btree *b = iter->nodes[0];
2311 struct btree_node_iter *node_iter = &iter->node_iters[0];
2313 BUG_ON(!bkey_deleted(k));
2316 return !bkey_packed(k) || could_pack;
2319 extent_save(b, node_iter, k, &uk);
2320 bch_bset_fix_invalidated_key(b, t, k);
2321 bch_btree_node_iter_fix(iter, b, node_iter, t,
2322 k, k->u64s, k->u64s);
2327 static bool extent_merge_do_overlapping(struct btree_iter *iter,
2328 struct bkey *m, bool back_merge)
2330 struct btree *b = iter->nodes[0];
2331 struct btree_node_iter *node_iter = &iter->node_iters[0];
2332 struct bset_tree *t;
2333 struct bkey_packed *k;
2335 struct bpos new_pos = back_merge ? m->p : bkey_start_pos(m);
2336 bool could_pack = bkey_pack_pos((void *) &uk, new_pos, b);
2340 * @m is the new merged extent:
2342 * The merge took place in the last bset; we know there can't be any 0
2343 * size extents overlapping with m there because if so they would have
2344 * been between the two extents we merged.
2346 * But in the other bsets, we have to check for and fix such extents:
2349 for_each_bset(b, t) {
2350 if (t == bset_tree_last(b))
2354 * if we don't find this bset in the iterator we already got to
2355 * the end of that bset, so start searching from the end.
2357 k = bch_btree_node_iter_bset_pos(node_iter, b, t);
2359 if (k == btree_bkey_last(b, t))
2360 k = bkey_prev_all(b, t, k);
2366 * Back merge: 0 size extents will be before the key
2367 * that was just inserted (and thus the iterator
2368 * position) - walk backwards to find them
2372 (uk = bkey_unpack_key(b, k),
2373 bkey_cmp(uk.p, bkey_start_pos(m)) > 0);
2374 k = bkey_prev_all(b, t, k)) {
2375 if (bkey_cmp(uk.p, m->p) >= 0)
2378 if (!extent_merge_one_overlapping(iter, new_pos,
2379 t, k, uk, check, could_pack))
2383 /* Front merge - walk forwards */
2385 k != btree_bkey_last(b, t) &&
2386 (uk = bkey_unpack_key(b, k),
2387 bkey_cmp(uk.p, m->p) < 0);
2390 bkey_start_pos(m)) <= 0)
2393 if (!extent_merge_one_overlapping(iter, new_pos,
2394 t, k, uk, check, could_pack))
2409 * When merging an extent that we're inserting into a btree node, the new merged
2410 * extent could overlap with an existing 0 size extent - if we don't fix that,
2411 * it'll break the btree node iterator so this code finds those 0 size extents
2412 * and shifts them out of the way.
2414 * Also unpacks and repacks.
2416 static bool bch_extent_merge_inline(struct bch_fs *c,
2417 struct btree_iter *iter,
2418 struct bkey_packed *l,
2419 struct bkey_packed *r,
2422 struct btree *b = iter->nodes[0];
2423 struct btree_node_iter *node_iter = &iter->node_iters[0];
2424 const struct bkey_format *f = &b->format;
2425 struct bset_tree *t = bset_tree_last(b);
2426 struct bkey_packed *m;
2433 * We need to save copies of both l and r, because we might get a
2434 * partial merge (which modifies both) and then fails to repack
2436 bkey_unpack(b, &li.k, l);
2437 bkey_unpack(b, &ri.k, r);
2439 m = back_merge ? l : r;
2440 mi = back_merge ? &li.k : &ri.k;
2442 /* l & r should be in last bset: */
2443 EBUG_ON(bch_bkey_to_bset(b, m) != t);
2445 switch (bch_extent_merge(c, b, &li.k, &ri.k)) {
2446 case BCH_MERGE_NOMERGE:
2448 case BCH_MERGE_PARTIAL:
2449 if (bkey_packed(m) && !bkey_pack_key((void *) &tmp, &mi->k, f))
2452 if (!extent_merge_do_overlapping(iter, &li.k.k, back_merge))
2455 extent_i_save(b, m, mi);
2456 bch_bset_fix_invalidated_key(b, t, m);
2459 * Update iterator to reflect what we just inserted - otherwise,
2460 * the iter_fix() call is going to put us _before_ the key we
2461 * just partially merged with:
2464 bch_btree_iter_set_pos_same_leaf(iter, li.k.k.p);
2466 bch_btree_node_iter_fix(iter, iter->nodes[0], node_iter,
2467 t, m, m->u64s, m->u64s);
2470 bkey_copy(packed_to_bkey(l), &li.k);
2472 bkey_copy(packed_to_bkey(r), &ri.k);
2474 case BCH_MERGE_MERGE:
2475 if (bkey_packed(m) && !bkey_pack_key((void *) &tmp, &li.k.k, f))
2478 if (!extent_merge_do_overlapping(iter, &li.k.k, back_merge))
2481 extent_i_save(b, m, &li.k);
2482 bch_bset_fix_invalidated_key(b, t, m);
2484 bch_btree_node_iter_fix(iter, iter->nodes[0], node_iter,
2485 t, m, m->u64s, m->u64s);
2492 const struct bkey_ops bch_bkey_extent_ops = {
2493 .key_invalid = bch_extent_invalid,
2494 .key_debugcheck = bch_extent_debugcheck,
2495 .val_to_text = bch_extent_to_text,
2496 .swab = bch_ptr_swab,
2497 .key_normalize = bch_ptr_normalize,
2498 .key_merge = bch_extent_merge,