1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_EXTENTS_H
3 #define _BCACHEFS_EXTENTS_H
7 #include "extents_types.h"
11 struct btree_insert_entry;
15 #define extent_entry_last(_e) bkey_val_end(_e)
17 #define entry_to_ptr(_entry) \
19 EBUG_ON((_entry) && !extent_entry_is_ptr(_entry)); \
21 __builtin_choose_expr( \
22 type_is_exact(_entry, const union bch_extent_entry *), \
23 (const struct bch_extent_ptr *) (_entry), \
24 (struct bch_extent_ptr *) (_entry)); \
27 /* downcast, preserves const */
28 #define to_entry(_entry) \
30 BUILD_BUG_ON(!type_is(_entry, union bch_extent_crc *) && \
31 !type_is(_entry, struct bch_extent_ptr *) && \
32 !type_is(_entry, struct bch_extent_stripe_ptr *)); \
34 __builtin_choose_expr( \
35 (type_is_exact(_entry, const union bch_extent_crc *) || \
36 type_is_exact(_entry, const struct bch_extent_ptr *) ||\
37 type_is_exact(_entry, const struct bch_extent_stripe_ptr *)),\
38 (const union bch_extent_entry *) (_entry), \
39 (union bch_extent_entry *) (_entry)); \
42 static inline unsigned
43 __extent_entry_type(const union bch_extent_entry *e)
45 return e->type ? __ffs(e->type) : BCH_EXTENT_ENTRY_MAX;
48 static inline enum bch_extent_entry_type
49 extent_entry_type(const union bch_extent_entry *e)
51 int ret = __ffs(e->type);
53 EBUG_ON(ret < 0 || ret >= BCH_EXTENT_ENTRY_MAX);
58 static inline size_t extent_entry_bytes(const union bch_extent_entry *entry)
60 switch (extent_entry_type(entry)) {
62 case BCH_EXTENT_ENTRY_##f: \
63 return sizeof(struct bch_extent_##f);
64 BCH_EXTENT_ENTRY_TYPES()
71 static inline size_t extent_entry_u64s(const union bch_extent_entry *entry)
73 return extent_entry_bytes(entry) / sizeof(u64);
76 static inline bool extent_entry_is_ptr(const union bch_extent_entry *e)
78 switch (extent_entry_type(e)) {
79 case BCH_EXTENT_ENTRY_ptr:
86 static inline bool extent_entry_is_crc(const union bch_extent_entry *e)
88 switch (extent_entry_type(e)) {
89 case BCH_EXTENT_ENTRY_crc32:
90 case BCH_EXTENT_ENTRY_crc64:
91 case BCH_EXTENT_ENTRY_crc128:
98 union bch_extent_crc {
100 struct bch_extent_crc32 crc32;
101 struct bch_extent_crc64 crc64;
102 struct bch_extent_crc128 crc128;
105 #define __entry_to_crc(_entry) \
106 __builtin_choose_expr( \
107 type_is_exact(_entry, const union bch_extent_entry *), \
108 (const union bch_extent_crc *) (_entry), \
109 (union bch_extent_crc *) (_entry))
111 #define entry_to_crc(_entry) \
113 EBUG_ON((_entry) && !extent_entry_is_crc(_entry)); \
115 __entry_to_crc(_entry); \
118 static inline struct bch_extent_crc_unpacked
119 bch2_extent_crc_unpack(const struct bkey *k, const union bch_extent_crc *crc)
121 #define common_fields(_crc) \
122 .csum_type = _crc.csum_type, \
123 .compression_type = _crc.compression_type, \
124 .compressed_size = _crc._compressed_size + 1, \
125 .uncompressed_size = _crc._uncompressed_size + 1, \
126 .offset = _crc.offset, \
130 return (struct bch_extent_crc_unpacked) {
131 .compressed_size = k->size,
132 .uncompressed_size = k->size,
133 .live_size = k->size,
136 switch (extent_entry_type(to_entry(crc))) {
137 case BCH_EXTENT_ENTRY_crc32: {
138 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
139 common_fields(crc->crc32),
142 *((__le32 *) &ret.csum.lo) = crc->crc32.csum;
144 memcpy(&ret.csum.lo, &crc->crc32.csum,
145 sizeof(crc->crc32.csum));
149 case BCH_EXTENT_ENTRY_crc64: {
150 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
151 common_fields(crc->crc64),
152 .nonce = crc->crc64.nonce,
153 .csum.lo = (__force __le64) crc->crc64.csum_lo,
156 *((__le16 *) &ret.csum.hi) = crc->crc64.csum_hi;
160 case BCH_EXTENT_ENTRY_crc128: {
161 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
162 common_fields(crc->crc128),
163 .nonce = crc->crc128.nonce,
164 .csum = crc->crc128.csum,
175 /* bkey_ptrs: generically over any key type that has ptrs */
178 const union bch_extent_entry *start;
179 const union bch_extent_entry *end;
183 union bch_extent_entry *start;
184 union bch_extent_entry *end;
187 /* iterate over bkey ptrs */
189 #define extent_entry_next(_entry) \
190 ((typeof(_entry)) ((void *) (_entry) + extent_entry_bytes(_entry)))
192 #define __bkey_extent_entry_for_each_from(_start, _end, _entry) \
193 for ((_entry) = (_start); \
195 (_entry) = extent_entry_next(_entry))
197 #define __bkey_ptr_next(_ptr, _end) \
199 typeof(_end) _entry; \
201 __bkey_extent_entry_for_each_from(to_entry(_ptr), _end, _entry) \
202 if (extent_entry_is_ptr(_entry)) \
205 _entry < (_end) ? entry_to_ptr(_entry) : NULL; \
208 #define bkey_extent_entry_for_each_from(_p, _entry, _start) \
209 __bkey_extent_entry_for_each_from(_start, (_p).end, _entry)
211 #define bkey_extent_entry_for_each(_p, _entry) \
212 bkey_extent_entry_for_each_from(_p, _entry, _p.start)
214 #define __bkey_for_each_ptr(_start, _end, _ptr) \
215 for ((_ptr) = (_start); \
216 ((_ptr) = __bkey_ptr_next(_ptr, _end)); \
219 #define bkey_ptr_next(_p, _ptr) \
220 __bkey_ptr_next(_ptr, (_p).end)
222 #define bkey_for_each_ptr(_p, _ptr) \
223 __bkey_for_each_ptr(&(_p).start->ptr, (_p).end, _ptr)
225 #define __bkey_ptr_next_decode(_k, _end, _ptr, _entry) \
232 __bkey_extent_entry_for_each_from(_entry, _end, _entry) \
233 switch (extent_entry_type(_entry)) { \
234 case BCH_EXTENT_ENTRY_ptr: \
235 (_ptr).ptr = _entry->ptr; \
237 case BCH_EXTENT_ENTRY_crc32: \
238 case BCH_EXTENT_ENTRY_crc64: \
239 case BCH_EXTENT_ENTRY_crc128: \
240 (_ptr).crc = bch2_extent_crc_unpack(_k, \
241 entry_to_crc(_entry)); \
243 case BCH_EXTENT_ENTRY_stripe_ptr: \
244 (_ptr).ec[(_ptr).ec_nr++] = _entry->stripe_ptr; \
251 #define __bkey_for_each_ptr_decode(_k, _start, _end, _ptr, _entry) \
252 for ((_ptr).crc = bch2_extent_crc_unpack(_k, NULL), \
254 __bkey_ptr_next_decode(_k, _end, _ptr, _entry); \
255 (_entry) = extent_entry_next(_entry))
257 #define bkey_for_each_ptr_decode(_k, _p, _ptr, _entry) \
258 __bkey_for_each_ptr_decode(_k, (_p).start, (_p).end, \
261 /* utility code common to all keys with pointers: */
263 static inline struct bkey_ptrs_c bch2_bkey_ptrs_c(struct bkey_s_c k)
266 case KEY_TYPE_btree_ptr: {
267 struct bkey_s_c_btree_ptr e = bkey_s_c_to_btree_ptr(k);
268 return (struct bkey_ptrs_c) {
269 to_entry(&e.v->start[0]),
270 to_entry(bkey_val_end(e))
273 case KEY_TYPE_extent: {
274 struct bkey_s_c_extent e = bkey_s_c_to_extent(k);
275 return (struct bkey_ptrs_c) {
280 case KEY_TYPE_stripe: {
281 struct bkey_s_c_stripe s = bkey_s_c_to_stripe(k);
282 return (struct bkey_ptrs_c) {
283 to_entry(&s.v->ptrs[0]),
284 to_entry(&s.v->ptrs[s.v->nr_blocks]),
288 return (struct bkey_ptrs_c) { NULL, NULL };
292 static inline struct bkey_ptrs bch2_bkey_ptrs(struct bkey_s k)
294 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k.s_c);
296 return (struct bkey_ptrs) {
302 static inline struct bch_devs_list bch2_bkey_devs(struct bkey_s_c k)
304 struct bch_devs_list ret = (struct bch_devs_list) { 0 };
305 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
306 const struct bch_extent_ptr *ptr;
308 bkey_for_each_ptr(p, ptr)
309 ret.devs[ret.nr++] = ptr->dev;
314 static inline struct bch_devs_list bch2_bkey_dirty_devs(struct bkey_s_c k)
316 struct bch_devs_list ret = (struct bch_devs_list) { 0 };
317 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
318 const struct bch_extent_ptr *ptr;
320 bkey_for_each_ptr(p, ptr)
322 ret.devs[ret.nr++] = ptr->dev;
327 static inline struct bch_devs_list bch2_bkey_cached_devs(struct bkey_s_c k)
329 struct bch_devs_list ret = (struct bch_devs_list) { 0 };
330 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
331 const struct bch_extent_ptr *ptr;
333 bkey_for_each_ptr(p, ptr)
335 ret.devs[ret.nr++] = ptr->dev;
340 static inline bool bch2_bkey_has_device(struct bkey_s_c k, unsigned dev)
342 struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
343 const struct bch_extent_ptr *ptr;
345 bkey_for_each_ptr(p, ptr)
352 unsigned bch2_bkey_nr_ptrs(struct bkey_s_c);
353 unsigned bch2_bkey_nr_dirty_ptrs(struct bkey_s_c);
354 unsigned bch2_bkey_durability(struct bch_fs *, struct bkey_s_c);
356 void bch2_mark_io_failure(struct bch_io_failures *,
357 struct extent_ptr_decoded *);
358 int bch2_bkey_pick_read_device(struct bch_fs *, struct bkey_s_c,
359 struct bch_io_failures *,
360 struct extent_ptr_decoded *);
362 void bch2_bkey_ptrs_to_text(struct printbuf *, struct bch_fs *,
364 const char *bch2_bkey_ptrs_invalid(const struct bch_fs *, struct bkey_s_c);
368 const char *bch2_btree_ptr_invalid(const struct bch_fs *, struct bkey_s_c);
369 void bch2_btree_ptr_debugcheck(struct bch_fs *, struct btree *,
371 void bch2_btree_ptr_to_text(struct printbuf *, struct bch_fs *,
373 void bch2_ptr_swab(const struct bkey_format *, struct bkey_packed *);
375 #define bch2_bkey_ops_btree_ptr (struct bkey_ops) { \
376 .key_invalid = bch2_btree_ptr_invalid, \
377 .key_debugcheck = bch2_btree_ptr_debugcheck, \
378 .val_to_text = bch2_btree_ptr_to_text, \
379 .swab = bch2_ptr_swab, \
384 const char *bch2_extent_invalid(const struct bch_fs *, struct bkey_s_c);
385 void bch2_extent_debugcheck(struct bch_fs *, struct btree *, struct bkey_s_c);
386 void bch2_extent_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
387 bool bch2_extent_normalize(struct bch_fs *, struct bkey_s);
388 enum merge_result bch2_extent_merge(struct bch_fs *,
389 struct bkey_s, struct bkey_s);
391 #define bch2_bkey_ops_extent (struct bkey_ops) { \
392 .key_invalid = bch2_extent_invalid, \
393 .key_debugcheck = bch2_extent_debugcheck, \
394 .val_to_text = bch2_extent_to_text, \
395 .swab = bch2_ptr_swab, \
396 .key_normalize = bch2_extent_normalize, \
397 .key_merge = bch2_extent_merge, \
400 /* bch_reservation: */
402 const char *bch2_reservation_invalid(const struct bch_fs *, struct bkey_s_c);
403 void bch2_reservation_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
404 enum merge_result bch2_reservation_merge(struct bch_fs *,
405 struct bkey_s, struct bkey_s);
407 #define bch2_bkey_ops_reservation (struct bkey_ops) { \
408 .key_invalid = bch2_reservation_invalid, \
409 .val_to_text = bch2_reservation_to_text, \
410 .key_merge = bch2_reservation_merge, \
413 void bch2_extent_trim_atomic(struct bkey_i *, struct btree_iter *);
414 bool bch2_extent_is_atomic(struct bkey_i *, struct btree_iter *);
416 enum btree_insert_ret
417 bch2_extent_can_insert(struct btree_trans *, struct btree_insert_entry *,
419 void bch2_insert_fixup_extent(struct btree_trans *,
420 struct btree_insert_entry *);
422 void bch2_extent_mark_replicas_cached(struct bch_fs *, struct bkey_s_extent,
425 const struct bch_extent_ptr *
426 bch2_extent_has_device(struct bkey_s_c_extent, unsigned);
427 const struct bch_extent_ptr *
428 bch2_extent_has_group(struct bch_fs *, struct bkey_s_c_extent, unsigned);
429 const struct bch_extent_ptr *
430 bch2_extent_has_target(struct bch_fs *, struct bkey_s_c_extent, unsigned);
432 unsigned bch2_extent_is_compressed(struct bkey_s_c);
434 bool bch2_extent_matches_ptr(struct bch_fs *, struct bkey_s_c_extent,
435 struct bch_extent_ptr, u64);
437 static inline bool bkey_extent_is_data(const struct bkey *k)
440 case KEY_TYPE_btree_ptr:
441 case KEY_TYPE_extent:
448 static inline bool bkey_extent_is_allocation(const struct bkey *k)
451 case KEY_TYPE_extent:
452 case KEY_TYPE_reservation:
459 static inline bool bch2_extent_is_fully_allocated(struct bkey_s_c k)
461 return bkey_extent_is_allocation(k.k) &&
462 !bch2_extent_is_compressed(k);
465 void bch2_bkey_append_ptr(struct bkey_i *, struct bch_extent_ptr);
466 void bch2_bkey_drop_device(struct bkey_s, unsigned);
468 /* Extent entry iteration: */
470 #define extent_for_each_entry_from(_e, _entry, _start) \
471 __bkey_extent_entry_for_each_from(_start, \
472 extent_entry_last(_e),_entry)
474 #define extent_for_each_entry(_e, _entry) \
475 extent_for_each_entry_from(_e, _entry, (_e).v->start)
477 #define extent_ptr_next(_e, _ptr) \
478 __bkey_ptr_next(_ptr, extent_entry_last(_e))
480 #define extent_for_each_ptr(_e, _ptr) \
481 __bkey_for_each_ptr(&(_e).v->start->ptr, extent_entry_last(_e), _ptr)
483 #define extent_crc_next(_e, _crc, _iter) \
485 extent_for_each_entry_from(_e, _iter, _iter) \
486 if (extent_entry_is_crc(_iter)) { \
487 (_crc) = bch2_extent_crc_unpack((_e).k, entry_to_crc(_iter));\
491 (_iter) < extent_entry_last(_e); \
494 #define extent_for_each_crc(_e, _crc, _iter) \
495 for ((_crc) = bch2_extent_crc_unpack((_e).k, NULL), \
496 (_iter) = (_e).v->start; \
497 extent_crc_next(_e, _crc, _iter); \
498 (_iter) = extent_entry_next(_iter))
500 #define extent_for_each_ptr_decode(_e, _ptr, _entry) \
501 __bkey_for_each_ptr_decode((_e).k, (_e).v->start, \
502 extent_entry_last(_e), _ptr, _entry)
504 void bch2_extent_crc_append(struct bkey_i_extent *,
505 struct bch_extent_crc_unpacked);
506 void bch2_extent_ptr_decoded_append(struct bkey_i_extent *,
507 struct extent_ptr_decoded *);
509 static inline void __extent_entry_push(struct bkey_i_extent *e)
511 union bch_extent_entry *entry = extent_entry_last(extent_i_to_s(e));
513 EBUG_ON(bkey_val_u64s(&e->k) + extent_entry_u64s(entry) >
514 BKEY_EXTENT_VAL_U64s_MAX);
516 e->k.u64s += extent_entry_u64s(entry);
519 bool bch2_can_narrow_extent_crcs(struct bkey_s_c_extent,
520 struct bch_extent_crc_unpacked);
521 bool bch2_extent_narrow_crcs(struct bkey_i_extent *, struct bch_extent_crc_unpacked);
523 union bch_extent_entry *bch2_bkey_drop_ptr(struct bkey_s,
524 struct bch_extent_ptr *);
526 #define bch2_bkey_drop_ptrs(_k, _ptr, _cond) \
528 struct bkey_ptrs _ptrs = bch2_bkey_ptrs(_k); \
530 _ptr = &_ptrs.start->ptr; \
532 while ((_ptr = bkey_ptr_next(_ptrs, _ptr))) { \
534 _ptr = (void *) bch2_bkey_drop_ptr(_k, _ptr); \
535 _ptrs = bch2_bkey_ptrs(_k); \
543 bool __bch2_cut_front(struct bpos, struct bkey_s);
545 static inline bool bch2_cut_front(struct bpos where, struct bkey_i *k)
547 return __bch2_cut_front(where, bkey_i_to_s(k));
550 bool bch2_cut_back(struct bpos, struct bkey *);
551 void bch2_key_resize(struct bkey *, unsigned);
554 * In extent_sort_fix_overlapping(), insert_fixup_extent(),
555 * extent_merge_inline() - we're modifying keys in place that are packed. To do
556 * that we have to unpack the key, modify the unpacked key - then this
557 * copies/repacks the unpacked to the original as necessary.
559 static inline void extent_save(struct btree *b, struct bkey_packed *dst,
562 struct bkey_format *f = &b->format;
563 struct bkey_i *dst_unpacked;
565 if ((dst_unpacked = packed_to_bkey(dst)))
566 dst_unpacked->k = *src;
568 BUG_ON(!bch2_bkey_pack_key(dst, src, f));
571 bool bch2_check_range_allocated(struct bch_fs *, struct bpos, u64, unsigned);
572 unsigned bch2_bkey_nr_ptrs_allocated(struct bkey_s_c);
574 #endif /* _BCACHEFS_EXTENTS_H */