1 #ifndef _BCACHEFS_EXTENTS_H
2 #define _BCACHEFS_EXTENTS_H
6 #include "extents_types.h"
10 struct btree_insert_entry;
14 #define extent_entry_last(_e) bkey_val_end(_e)
16 #define entry_to_ptr(_entry) \
18 EBUG_ON((_entry) && !extent_entry_is_ptr(_entry)); \
20 __builtin_choose_expr( \
21 type_is_exact(_entry, const union bch_extent_entry *), \
22 (const struct bch_extent_ptr *) (_entry), \
23 (struct bch_extent_ptr *) (_entry)); \
26 /* downcast, preserves const */
27 #define to_entry(_entry) \
29 BUILD_BUG_ON(!type_is(_entry, union bch_extent_crc *) && \
30 !type_is(_entry, struct bch_extent_ptr *) && \
31 !type_is(_entry, struct bch_extent_stripe_ptr *)); \
33 __builtin_choose_expr( \
34 (type_is_exact(_entry, const union bch_extent_crc *) || \
35 type_is_exact(_entry, const struct bch_extent_ptr *) ||\
36 type_is_exact(_entry, const struct bch_extent_stripe_ptr *)),\
37 (const union bch_extent_entry *) (_entry), \
38 (union bch_extent_entry *) (_entry)); \
41 static inline unsigned
42 __extent_entry_type(const union bch_extent_entry *e)
44 return e->type ? __ffs(e->type) : BCH_EXTENT_ENTRY_MAX;
47 static inline enum bch_extent_entry_type
48 extent_entry_type(const union bch_extent_entry *e)
50 int ret = __ffs(e->type);
52 EBUG_ON(ret < 0 || ret >= BCH_EXTENT_ENTRY_MAX);
57 static inline size_t extent_entry_bytes(const union bch_extent_entry *entry)
59 switch (extent_entry_type(entry)) {
61 case BCH_EXTENT_ENTRY_##f: \
62 return sizeof(struct bch_extent_##f);
63 BCH_EXTENT_ENTRY_TYPES()
70 static inline size_t extent_entry_u64s(const union bch_extent_entry *entry)
72 return extent_entry_bytes(entry) / sizeof(u64);
75 static inline bool extent_entry_is_ptr(const union bch_extent_entry *e)
77 switch (extent_entry_type(e)) {
78 case BCH_EXTENT_ENTRY_ptr:
85 static inline bool extent_entry_is_crc(const union bch_extent_entry *e)
87 switch (extent_entry_type(e)) {
88 case BCH_EXTENT_ENTRY_crc32:
89 case BCH_EXTENT_ENTRY_crc64:
90 case BCH_EXTENT_ENTRY_crc128:
97 union bch_extent_crc {
99 struct bch_extent_crc32 crc32;
100 struct bch_extent_crc64 crc64;
101 struct bch_extent_crc128 crc128;
104 #define __entry_to_crc(_entry) \
105 __builtin_choose_expr( \
106 type_is_exact(_entry, const union bch_extent_entry *), \
107 (const union bch_extent_crc *) (_entry), \
108 (union bch_extent_crc *) (_entry))
110 #define entry_to_crc(_entry) \
112 EBUG_ON((_entry) && !extent_entry_is_crc(_entry)); \
114 __entry_to_crc(_entry); \
117 static inline struct bch_extent_crc_unpacked
118 bch2_extent_crc_unpack(const struct bkey *k, const union bch_extent_crc *crc)
120 #define common_fields(_crc) \
121 .csum_type = _crc.csum_type, \
122 .compression_type = _crc.compression_type, \
123 .compressed_size = _crc._compressed_size + 1, \
124 .uncompressed_size = _crc._uncompressed_size + 1, \
125 .offset = _crc.offset, \
129 return (struct bch_extent_crc_unpacked) {
130 .compressed_size = k->size,
131 .uncompressed_size = k->size,
132 .live_size = k->size,
135 switch (extent_entry_type(to_entry(crc))) {
136 case BCH_EXTENT_ENTRY_crc32: {
137 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
138 common_fields(crc->crc32),
141 *((__le32 *) &ret.csum.lo) = crc->crc32.csum;
143 memcpy(&ret.csum.lo, &crc->crc32.csum,
144 sizeof(crc->crc32.csum));
148 case BCH_EXTENT_ENTRY_crc64: {
149 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
150 common_fields(crc->crc64),
151 .nonce = crc->crc64.nonce,
152 .csum.lo = (__force __le64) crc->crc64.csum_lo,
155 *((__le16 *) &ret.csum.hi) = crc->crc64.csum_hi;
159 case BCH_EXTENT_ENTRY_crc128: {
160 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
161 common_fields(crc->crc128),
162 .nonce = crc->crc128.nonce,
163 .csum = crc->crc128.csum,
174 /* bkey_ptrs: generically over any key type that has ptrs */
177 const union bch_extent_entry *start;
178 const union bch_extent_entry *end;
182 union bch_extent_entry *start;
183 union bch_extent_entry *end;
186 /* iterate over bkey ptrs */
188 #define extent_entry_next(_entry) \
189 ((typeof(_entry)) ((void *) (_entry) + extent_entry_bytes(_entry)))
191 #define __bkey_extent_entry_for_each_from(_start, _end, _entry) \
192 for ((_entry) = (_start); \
194 (_entry) = extent_entry_next(_entry))
196 #define __bkey_ptr_next(_ptr, _end) \
198 typeof(_end) _entry; \
200 __bkey_extent_entry_for_each_from(to_entry(_ptr), _end, _entry) \
201 if (extent_entry_is_ptr(_entry)) \
204 _entry < (_end) ? entry_to_ptr(_entry) : NULL; \
207 #define bkey_extent_entry_for_each_from(_p, _entry, _start) \
208 __bkey_extent_entry_for_each_from(_start, (_p).end, _entry)
210 #define bkey_extent_entry_for_each(_p, _entry) \
211 bkey_extent_entry_for_each_from(_p, _entry, _p.start)
213 #define __bkey_for_each_ptr(_start, _end, _ptr) \
214 for ((_ptr) = (_start); \
215 ((_ptr) = __bkey_ptr_next(_ptr, _end)); \
218 #define bkey_ptr_next(_p, _ptr) \
219 __bkey_ptr_next(_ptr, (_p).end)
221 #define bkey_for_each_ptr(_p, _ptr) \
222 __bkey_for_each_ptr(&(_p).start->ptr, (_p).end, _ptr)
224 #define __bkey_ptr_next_decode(_k, _end, _ptr, _entry) \
231 __bkey_extent_entry_for_each_from(_entry, _end, _entry) \
232 switch (extent_entry_type(_entry)) { \
233 case BCH_EXTENT_ENTRY_ptr: \
234 (_ptr).ptr = _entry->ptr; \
236 case BCH_EXTENT_ENTRY_crc32: \
237 case BCH_EXTENT_ENTRY_crc64: \
238 case BCH_EXTENT_ENTRY_crc128: \
239 (_ptr).crc = bch2_extent_crc_unpack(_k, \
240 entry_to_crc(_entry)); \
242 case BCH_EXTENT_ENTRY_stripe_ptr: \
243 (_ptr).ec[(_ptr).ec_nr++] = _entry->stripe_ptr; \
250 #define __bkey_for_each_ptr_decode(_k, _start, _end, _ptr, _entry) \
251 for ((_ptr).crc = bch2_extent_crc_unpack(_k, NULL), \
253 __bkey_ptr_next_decode(_k, _end, _ptr, _entry); \
254 (_entry) = extent_entry_next(_entry))
256 #define bkey_for_each_ptr_decode(_k, _p, _ptr, _entry) \
257 __bkey_for_each_ptr_decode(_k, (_p).start, (_p).end, \
260 /* utility code common to all keys with pointers: */
262 static inline struct bkey_ptrs_c bch2_bkey_ptrs_c(struct bkey_s_c k)
265 case KEY_TYPE_btree_ptr: {
266 struct bkey_s_c_btree_ptr e = bkey_s_c_to_btree_ptr(k);
267 return (struct bkey_ptrs_c) {
268 to_entry(&e.v->start[0]),
269 to_entry(bkey_val_end(e))
272 case KEY_TYPE_extent: {
273 struct bkey_s_c_extent e = bkey_s_c_to_extent(k);
274 return (struct bkey_ptrs_c) {
279 case KEY_TYPE_stripe: {
280 struct bkey_s_c_stripe s = bkey_s_c_to_stripe(k);
281 return (struct bkey_ptrs_c) {
282 to_entry(&s.v->ptrs[0]),
283 to_entry(&s.v->ptrs[s.v->nr_blocks]),
287 return (struct bkey_ptrs_c) { NULL, NULL };
291 static inline struct bkey_ptrs bch2_bkey_ptrs(struct bkey_s k)
293 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k.s_c);
295 return (struct bkey_ptrs) {
301 static inline struct bch_devs_list bch2_bkey_devs(struct bkey_s_c k)
303 struct bch_devs_list ret = (struct bch_devs_list) { 0 };
304 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
305 const struct bch_extent_ptr *ptr;
307 bkey_for_each_ptr(p, ptr)
308 ret.devs[ret.nr++] = ptr->dev;
313 static inline struct bch_devs_list bch2_bkey_dirty_devs(struct bkey_s_c k)
315 struct bch_devs_list ret = (struct bch_devs_list) { 0 };
316 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
317 const struct bch_extent_ptr *ptr;
319 bkey_for_each_ptr(p, ptr)
321 ret.devs[ret.nr++] = ptr->dev;
326 static inline struct bch_devs_list bch2_bkey_cached_devs(struct bkey_s_c k)
328 struct bch_devs_list ret = (struct bch_devs_list) { 0 };
329 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
330 const struct bch_extent_ptr *ptr;
332 bkey_for_each_ptr(p, ptr)
334 ret.devs[ret.nr++] = ptr->dev;
339 static inline bool bch2_bkey_has_device(struct bkey_s_c k, unsigned dev)
341 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
342 const struct bch_extent_ptr *ptr;
344 bkey_for_each_ptr(p, ptr)
351 unsigned bch2_bkey_nr_ptrs(struct bkey_s_c);
352 unsigned bch2_bkey_nr_dirty_ptrs(struct bkey_s_c);
353 unsigned bch2_bkey_durability(struct bch_fs *, struct bkey_s_c);
355 void bch2_mark_io_failure(struct bch_io_failures *,
356 struct extent_ptr_decoded *);
357 int bch2_bkey_pick_read_device(struct bch_fs *, struct bkey_s_c,
358 struct bch_io_failures *,
359 struct extent_ptr_decoded *);
361 void bch2_bkey_ptrs_to_text(struct printbuf *, struct bch_fs *,
363 const char *bch2_bkey_ptrs_invalid(const struct bch_fs *, struct bkey_s_c);
367 const char *bch2_btree_ptr_invalid(const struct bch_fs *, struct bkey_s_c);
368 void bch2_btree_ptr_debugcheck(struct bch_fs *, struct btree *,
370 void bch2_btree_ptr_to_text(struct printbuf *, struct bch_fs *,
372 void bch2_ptr_swab(const struct bkey_format *, struct bkey_packed *);
374 #define bch2_bkey_ops_btree_ptr (struct bkey_ops) { \
375 .key_invalid = bch2_btree_ptr_invalid, \
376 .key_debugcheck = bch2_btree_ptr_debugcheck, \
377 .val_to_text = bch2_btree_ptr_to_text, \
378 .swab = bch2_ptr_swab, \
383 const char *bch2_extent_invalid(const struct bch_fs *, struct bkey_s_c);
384 void bch2_extent_debugcheck(struct bch_fs *, struct btree *, struct bkey_s_c);
385 void bch2_extent_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
386 bool bch2_extent_normalize(struct bch_fs *, struct bkey_s);
387 enum merge_result bch2_extent_merge(struct bch_fs *,
388 struct bkey_i *, struct bkey_i *);
390 #define bch2_bkey_ops_extent (struct bkey_ops) { \
391 .key_invalid = bch2_extent_invalid, \
392 .key_debugcheck = bch2_extent_debugcheck, \
393 .val_to_text = bch2_extent_to_text, \
394 .swab = bch2_ptr_swab, \
395 .key_normalize = bch2_extent_normalize, \
396 .key_merge = bch2_extent_merge, \
399 /* bch_reservation: */
401 const char *bch2_reservation_invalid(const struct bch_fs *, struct bkey_s_c);
402 void bch2_reservation_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
403 enum merge_result bch2_reservation_merge(struct bch_fs *,
404 struct bkey_i *, struct bkey_i *);
406 #define bch2_bkey_ops_reservation (struct bkey_ops) { \
407 .key_invalid = bch2_reservation_invalid, \
408 .val_to_text = bch2_reservation_to_text, \
409 .key_merge = bch2_reservation_merge, \
412 void bch2_extent_trim_atomic(struct bkey_i *, struct btree_iter *);
413 bool bch2_extent_is_atomic(struct bkey_i *, struct btree_iter *);
415 enum btree_insert_ret
416 bch2_extent_can_insert(struct btree_trans *, struct btree_insert_entry *,
418 void bch2_insert_fixup_extent(struct btree_trans *,
419 struct btree_insert_entry *);
421 void bch2_extent_mark_replicas_cached(struct bch_fs *, struct bkey_s_extent,
424 const struct bch_extent_ptr *
425 bch2_extent_has_device(struct bkey_s_c_extent, unsigned);
426 const struct bch_extent_ptr *
427 bch2_extent_has_group(struct bch_fs *, struct bkey_s_c_extent, unsigned);
428 const struct bch_extent_ptr *
429 bch2_extent_has_target(struct bch_fs *, struct bkey_s_c_extent, unsigned);
431 unsigned bch2_extent_is_compressed(struct bkey_s_c);
433 bool bch2_extent_matches_ptr(struct bch_fs *, struct bkey_s_c_extent,
434 struct bch_extent_ptr, u64);
436 static inline bool bkey_extent_is_data(const struct bkey *k)
439 case KEY_TYPE_btree_ptr:
440 case KEY_TYPE_extent:
447 static inline bool bkey_extent_is_allocation(const struct bkey *k)
450 case KEY_TYPE_extent:
451 case KEY_TYPE_reservation:
458 static inline bool bch2_extent_is_fully_allocated(struct bkey_s_c k)
460 return bkey_extent_is_allocation(k.k) &&
461 !bch2_extent_is_compressed(k);
464 void bch2_bkey_append_ptr(struct bkey_i *, struct bch_extent_ptr);
465 void bch2_bkey_drop_device(struct bkey_s, unsigned);
467 /* Extent entry iteration: */
469 #define extent_for_each_entry_from(_e, _entry, _start) \
470 __bkey_extent_entry_for_each_from(_start, \
471 extent_entry_last(_e),_entry)
473 #define extent_for_each_entry(_e, _entry) \
474 extent_for_each_entry_from(_e, _entry, (_e).v->start)
476 #define extent_ptr_next(_e, _ptr) \
477 __bkey_ptr_next(_ptr, extent_entry_last(_e))
479 #define extent_for_each_ptr(_e, _ptr) \
480 __bkey_for_each_ptr(&(_e).v->start->ptr, extent_entry_last(_e), _ptr)
482 #define extent_crc_next(_e, _crc, _iter) \
484 extent_for_each_entry_from(_e, _iter, _iter) \
485 if (extent_entry_is_crc(_iter)) { \
486 (_crc) = bch2_extent_crc_unpack((_e).k, entry_to_crc(_iter));\
490 (_iter) < extent_entry_last(_e); \
493 #define extent_for_each_crc(_e, _crc, _iter) \
494 for ((_crc) = bch2_extent_crc_unpack((_e).k, NULL), \
495 (_iter) = (_e).v->start; \
496 extent_crc_next(_e, _crc, _iter); \
497 (_iter) = extent_entry_next(_iter))
499 #define extent_for_each_ptr_decode(_e, _ptr, _entry) \
500 __bkey_for_each_ptr_decode((_e).k, (_e).v->start, \
501 extent_entry_last(_e), _ptr, _entry)
503 void bch2_extent_crc_append(struct bkey_i_extent *,
504 struct bch_extent_crc_unpacked);
505 void bch2_extent_ptr_decoded_append(struct bkey_i_extent *,
506 struct extent_ptr_decoded *);
508 static inline void __extent_entry_push(struct bkey_i_extent *e)
510 union bch_extent_entry *entry = extent_entry_last(extent_i_to_s(e));
512 EBUG_ON(bkey_val_u64s(&e->k) + extent_entry_u64s(entry) >
513 BKEY_EXTENT_VAL_U64s_MAX);
515 e->k.u64s += extent_entry_u64s(entry);
518 bool bch2_can_narrow_extent_crcs(struct bkey_s_c_extent,
519 struct bch_extent_crc_unpacked);
520 bool bch2_extent_narrow_crcs(struct bkey_i_extent *, struct bch_extent_crc_unpacked);
522 union bch_extent_entry *bch2_bkey_drop_ptr(struct bkey_s,
523 struct bch_extent_ptr *);
525 #define bch2_bkey_drop_ptrs(_k, _ptr, _cond) \
527 struct bkey_ptrs _ptrs = bch2_bkey_ptrs(_k); \
529 _ptr = &_ptrs.start->ptr; \
531 while ((_ptr = bkey_ptr_next(_ptrs, _ptr))) { \
533 _ptr = (void *) bch2_bkey_drop_ptr(_k, _ptr); \
534 _ptrs = bch2_bkey_ptrs(_k); \
542 bool __bch2_cut_front(struct bpos, struct bkey_s);
544 static inline bool bch2_cut_front(struct bpos where, struct bkey_i *k)
546 return __bch2_cut_front(where, bkey_i_to_s(k));
549 bool bch2_cut_back(struct bpos, struct bkey *);
550 void bch2_key_resize(struct bkey *, unsigned);
553 * In extent_sort_fix_overlapping(), insert_fixup_extent(),
554 * extent_merge_inline() - we're modifying keys in place that are packed. To do
555 * that we have to unpack the key, modify the unpacked key - then this
556 * copies/repacks the unpacked to the original as necessary.
558 static inline void extent_save(struct btree *b, struct bkey_packed *dst,
561 struct bkey_format *f = &b->format;
562 struct bkey_i *dst_unpacked;
564 if ((dst_unpacked = packed_to_bkey(dst)))
565 dst_unpacked->k = *src;
567 BUG_ON(!bch2_bkey_pack_key(dst, src, f));
570 bool bch2_check_range_allocated(struct bch_fs *, struct bpos, u64, unsigned);
571 unsigned bch2_bkey_nr_ptrs_allocated(struct bkey_s_c);
573 #endif /* _BCACHEFS_EXTENTS_H */