]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/extents.h
Update bcachefs sources to 5a3a4087af bcachefs: Convert a BUG_ON() to a warning
[bcachefs-tools-debian] / libbcachefs / extents.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_EXTENTS_H
3 #define _BCACHEFS_EXTENTS_H
4
5 #include "bcachefs.h"
6 #include "bkey.h"
7 #include "extents_types.h"
8
9 struct bch_fs;
10 struct btree_trans;
11 struct btree_insert_entry;
12
13 /* extent entries: */
14
15 #define extent_entry_last(_e)                                           \
16         ((typeof(&(_e).v->start[0])) bkey_val_end(_e))
17
18 #define entry_to_ptr(_entry)                                            \
19 ({                                                                      \
20         EBUG_ON((_entry) && !extent_entry_is_ptr(_entry));              \
21                                                                         \
22         __builtin_choose_expr(                                          \
23                 type_is_exact(_entry, const union bch_extent_entry *),  \
24                 (const struct bch_extent_ptr *) (_entry),               \
25                 (struct bch_extent_ptr *) (_entry));                    \
26 })
27
28 /* downcast, preserves const */
29 #define to_entry(_entry)                                                \
30 ({                                                                      \
31         BUILD_BUG_ON(!type_is(_entry, union bch_extent_crc *) &&        \
32                      !type_is(_entry, struct bch_extent_ptr *) &&       \
33                      !type_is(_entry, struct bch_extent_stripe_ptr *)); \
34                                                                         \
35         __builtin_choose_expr(                                          \
36                 (type_is_exact(_entry, const union bch_extent_crc *) || \
37                  type_is_exact(_entry, const struct bch_extent_ptr *) ||\
38                  type_is_exact(_entry, const struct bch_extent_stripe_ptr *)),\
39                 (const union bch_extent_entry *) (_entry),              \
40                 (union bch_extent_entry *) (_entry));                   \
41 })
42
43 static inline unsigned
44 __extent_entry_type(const union bch_extent_entry *e)
45 {
46         return e->type ? __ffs(e->type) : BCH_EXTENT_ENTRY_MAX;
47 }
48
49 static inline enum bch_extent_entry_type
50 extent_entry_type(const union bch_extent_entry *e)
51 {
52         int ret = __ffs(e->type);
53
54         EBUG_ON(ret < 0 || ret >= BCH_EXTENT_ENTRY_MAX);
55
56         return ret;
57 }
58
59 static inline size_t extent_entry_bytes(const union bch_extent_entry *entry)
60 {
61         switch (extent_entry_type(entry)) {
62 #define x(f, n)                                         \
63         case BCH_EXTENT_ENTRY_##f:                      \
64                 return sizeof(struct bch_extent_##f);
65         BCH_EXTENT_ENTRY_TYPES()
66 #undef x
67         default:
68                 BUG();
69         }
70 }
71
72 static inline size_t extent_entry_u64s(const union bch_extent_entry *entry)
73 {
74         return extent_entry_bytes(entry) / sizeof(u64);
75 }
76
77 static inline bool extent_entry_is_ptr(const union bch_extent_entry *e)
78 {
79         switch (extent_entry_type(e)) {
80         case BCH_EXTENT_ENTRY_ptr:
81                 return true;
82         default:
83                 return false;
84         }
85 }
86
87 static inline bool extent_entry_is_crc(const union bch_extent_entry *e)
88 {
89         switch (extent_entry_type(e)) {
90         case BCH_EXTENT_ENTRY_crc32:
91         case BCH_EXTENT_ENTRY_crc64:
92         case BCH_EXTENT_ENTRY_crc128:
93                 return true;
94         default:
95                 return false;
96         }
97 }
98
99 union bch_extent_crc {
100         u8                              type;
101         struct bch_extent_crc32         crc32;
102         struct bch_extent_crc64         crc64;
103         struct bch_extent_crc128        crc128;
104 };
105
106 #define __entry_to_crc(_entry)                                          \
107         __builtin_choose_expr(                                          \
108                 type_is_exact(_entry, const union bch_extent_entry *),  \
109                 (const union bch_extent_crc *) (_entry),                \
110                 (union bch_extent_crc *) (_entry))
111
112 #define entry_to_crc(_entry)                                            \
113 ({                                                                      \
114         EBUG_ON((_entry) && !extent_entry_is_crc(_entry));              \
115                                                                         \
116         __entry_to_crc(_entry);                                         \
117 })
118
119 static inline struct bch_extent_crc_unpacked
120 bch2_extent_crc_unpack(const struct bkey *k, const union bch_extent_crc *crc)
121 {
122 #define common_fields(_crc)                                             \
123                 .csum_type              = _crc.csum_type,               \
124                 .compression_type       = _crc.compression_type,        \
125                 .compressed_size        = _crc._compressed_size + 1,    \
126                 .uncompressed_size      = _crc._uncompressed_size + 1,  \
127                 .offset                 = _crc.offset,                  \
128                 .live_size              = k->size
129
130         if (!crc)
131                 return (struct bch_extent_crc_unpacked) {
132                         .compressed_size        = k->size,
133                         .uncompressed_size      = k->size,
134                         .live_size              = k->size,
135                 };
136
137         switch (extent_entry_type(to_entry(crc))) {
138         case BCH_EXTENT_ENTRY_crc32: {
139                 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
140                         common_fields(crc->crc32),
141                 };
142
143                 *((__le32 *) &ret.csum.lo) = crc->crc32.csum;
144
145                 memcpy(&ret.csum.lo, &crc->crc32.csum,
146                        sizeof(crc->crc32.csum));
147
148                 return ret;
149         }
150         case BCH_EXTENT_ENTRY_crc64: {
151                 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
152                         common_fields(crc->crc64),
153                         .nonce                  = crc->crc64.nonce,
154                         .csum.lo                = (__force __le64) crc->crc64.csum_lo,
155                 };
156
157                 *((__le16 *) &ret.csum.hi) = crc->crc64.csum_hi;
158
159                 return ret;
160         }
161         case BCH_EXTENT_ENTRY_crc128: {
162                 struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
163                         common_fields(crc->crc128),
164                         .nonce                  = crc->crc128.nonce,
165                         .csum                   = crc->crc128.csum,
166                 };
167
168                 return ret;
169         }
170         default:
171                 BUG();
172         }
173 #undef common_fields
174 }
175
176 /* bkey_ptrs: generically over any key type that has ptrs */
177
178 struct bkey_ptrs_c {
179         const union bch_extent_entry    *start;
180         const union bch_extent_entry    *end;
181 };
182
183 struct bkey_ptrs {
184         union bch_extent_entry  *start;
185         union bch_extent_entry  *end;
186 };
187
188 /* iterate over bkey ptrs */
189
190 #define extent_entry_next(_entry)                                       \
191         ((typeof(_entry)) ((void *) (_entry) + extent_entry_bytes(_entry)))
192
193 #define __bkey_extent_entry_for_each_from(_start, _end, _entry)         \
194         for ((_entry) = (_start);                                       \
195              (_entry) < (_end);                                         \
196              (_entry) = extent_entry_next(_entry))
197
198 #define __bkey_ptr_next(_ptr, _end)                                     \
199 ({                                                                      \
200         typeof(_end) _entry;                                            \
201                                                                         \
202         __bkey_extent_entry_for_each_from(to_entry(_ptr), _end, _entry) \
203                 if (extent_entry_is_ptr(_entry))                        \
204                         break;                                          \
205                                                                         \
206         _entry < (_end) ? entry_to_ptr(_entry) : NULL;                  \
207 })
208
209 #define bkey_extent_entry_for_each_from(_p, _entry, _start)             \
210         __bkey_extent_entry_for_each_from(_start, (_p).end, _entry)
211
212 #define bkey_extent_entry_for_each(_p, _entry)                          \
213         bkey_extent_entry_for_each_from(_p, _entry, _p.start)
214
215 #define __bkey_for_each_ptr(_start, _end, _ptr)                         \
216         for ((_ptr) = (_start);                                         \
217              ((_ptr) = __bkey_ptr_next(_ptr, _end));                    \
218              (_ptr)++)
219
220 #define bkey_ptr_next(_p, _ptr)                                         \
221         __bkey_ptr_next(_ptr, (_p).end)
222
223 #define bkey_for_each_ptr(_p, _ptr)                                     \
224         __bkey_for_each_ptr(&(_p).start->ptr, (_p).end, _ptr)
225
226 #define __bkey_ptr_next_decode(_k, _end, _ptr, _entry)                  \
227 ({                                                                      \
228         __label__ out;                                                  \
229                                                                         \
230         (_ptr).idx      = 0;                                            \
231         (_ptr).ec_nr    = 0;                                            \
232                                                                         \
233         __bkey_extent_entry_for_each_from(_entry, _end, _entry)         \
234                 switch (extent_entry_type(_entry)) {                    \
235                 case BCH_EXTENT_ENTRY_ptr:                              \
236                         (_ptr).ptr              = _entry->ptr;          \
237                         goto out;                                       \
238                 case BCH_EXTENT_ENTRY_crc32:                            \
239                 case BCH_EXTENT_ENTRY_crc64:                            \
240                 case BCH_EXTENT_ENTRY_crc128:                           \
241                         (_ptr).crc = bch2_extent_crc_unpack(_k,         \
242                                         entry_to_crc(_entry));          \
243                         break;                                          \
244                 case BCH_EXTENT_ENTRY_stripe_ptr:                       \
245                         (_ptr).ec[(_ptr).ec_nr++] = _entry->stripe_ptr; \
246                         break;                                          \
247                 }                                                       \
248 out:                                                                    \
249         _entry < (_end);                                                \
250 })
251
252 #define __bkey_for_each_ptr_decode(_k, _start, _end, _ptr, _entry)      \
253         for ((_ptr).crc = bch2_extent_crc_unpack(_k, NULL),             \
254              (_entry) = _start;                                         \
255              __bkey_ptr_next_decode(_k, _end, _ptr, _entry);            \
256              (_entry) = extent_entry_next(_entry))
257
258 #define bkey_for_each_ptr_decode(_k, _p, _ptr, _entry)                  \
259         __bkey_for_each_ptr_decode(_k, (_p).start, (_p).end,            \
260                                    _ptr, _entry)
261
262 #define bkey_crc_next(_k, _start, _end, _crc, _iter)                    \
263 ({                                                                      \
264         __bkey_extent_entry_for_each_from(_iter, _end, _iter)           \
265                 if (extent_entry_is_crc(_iter)) {                       \
266                         (_crc) = bch2_extent_crc_unpack(_k,             \
267                                                 entry_to_crc(_iter));   \
268                         break;                                          \
269                 }                                                       \
270                                                                         \
271         (_iter) < (_end);                                               \
272 })
273
274 #define __bkey_for_each_crc(_k, _start, _end, _crc, _iter)              \
275         for ((_crc) = bch2_extent_crc_unpack(_k, NULL),                 \
276              (_iter) = (_start);                                        \
277              bkey_crc_next(_k, _start, _end, _crc, _iter);              \
278              (_iter) = extent_entry_next(_iter))
279
280 #define bkey_for_each_crc(_k, _p, _crc, _iter)                          \
281         __bkey_for_each_crc(_k, (_p).start, (_p).end, _crc, _iter)
282
283 /* utility code common to all keys with pointers: */
284
285 static inline struct bkey_ptrs_c bch2_bkey_ptrs_c(struct bkey_s_c k)
286 {
287         switch (k.k->type) {
288         case KEY_TYPE_btree_ptr: {
289                 struct bkey_s_c_btree_ptr e = bkey_s_c_to_btree_ptr(k);
290                 return (struct bkey_ptrs_c) {
291                         to_entry(&e.v->start[0]),
292                         to_entry(extent_entry_last(e))
293                 };
294         }
295         case KEY_TYPE_extent: {
296                 struct bkey_s_c_extent e = bkey_s_c_to_extent(k);
297                 return (struct bkey_ptrs_c) {
298                         e.v->start,
299                         extent_entry_last(e)
300                 };
301         }
302         case KEY_TYPE_stripe: {
303                 struct bkey_s_c_stripe s = bkey_s_c_to_stripe(k);
304                 return (struct bkey_ptrs_c) {
305                         to_entry(&s.v->ptrs[0]),
306                         to_entry(&s.v->ptrs[s.v->nr_blocks]),
307                 };
308         }
309         case KEY_TYPE_reflink_v: {
310                 struct bkey_s_c_reflink_v r = bkey_s_c_to_reflink_v(k);
311
312                 return (struct bkey_ptrs_c) {
313                         r.v->start,
314                         bkey_val_end(r),
315                 };
316         }
317         default:
318                 return (struct bkey_ptrs_c) { NULL, NULL };
319         }
320 }
321
322 static inline struct bkey_ptrs bch2_bkey_ptrs(struct bkey_s k)
323 {
324         struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k.s_c);
325
326         return (struct bkey_ptrs) {
327                 (void *) p.start,
328                 (void *) p.end
329         };
330 }
331
332 static inline struct bch_devs_list bch2_bkey_devs(struct bkey_s_c k)
333 {
334         struct bch_devs_list ret = (struct bch_devs_list) { 0 };
335         struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
336         const struct bch_extent_ptr *ptr;
337
338         bkey_for_each_ptr(p, ptr)
339                 ret.devs[ret.nr++] = ptr->dev;
340
341         return ret;
342 }
343
344 static inline struct bch_devs_list bch2_bkey_dirty_devs(struct bkey_s_c k)
345 {
346         struct bch_devs_list ret = (struct bch_devs_list) { 0 };
347         struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
348         const struct bch_extent_ptr *ptr;
349
350         bkey_for_each_ptr(p, ptr)
351                 if (!ptr->cached)
352                         ret.devs[ret.nr++] = ptr->dev;
353
354         return ret;
355 }
356
357 static inline struct bch_devs_list bch2_bkey_cached_devs(struct bkey_s_c k)
358 {
359         struct bch_devs_list ret = (struct bch_devs_list) { 0 };
360         struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
361         const struct bch_extent_ptr *ptr;
362
363         bkey_for_each_ptr(p, ptr)
364                 if (ptr->cached)
365                         ret.devs[ret.nr++] = ptr->dev;
366
367         return ret;
368 }
369
370 unsigned bch2_bkey_nr_ptrs(struct bkey_s_c);
371 unsigned bch2_bkey_nr_dirty_ptrs(struct bkey_s_c);
372 unsigned bch2_bkey_durability(struct bch_fs *, struct bkey_s_c);
373
374 void bch2_mark_io_failure(struct bch_io_failures *,
375                           struct extent_ptr_decoded *);
376 int bch2_bkey_pick_read_device(struct bch_fs *, struct bkey_s_c,
377                                struct bch_io_failures *,
378                                struct extent_ptr_decoded *);
379
380 void bch2_bkey_append_ptr(struct bkey_i *, struct bch_extent_ptr);
381 void bch2_bkey_drop_device(struct bkey_s, unsigned);
382 const struct bch_extent_ptr *bch2_bkey_has_device(struct bkey_s_c, unsigned);
383 bool bch2_bkey_has_target(struct bch_fs *, struct bkey_s_c, unsigned);
384
385 void bch2_bkey_ptrs_to_text(struct printbuf *, struct bch_fs *,
386                             struct bkey_s_c);
387 const char *bch2_bkey_ptrs_invalid(const struct bch_fs *, struct bkey_s_c);
388
389 /* bch_btree_ptr: */
390
391 const char *bch2_btree_ptr_invalid(const struct bch_fs *, struct bkey_s_c);
392 void bch2_btree_ptr_debugcheck(struct bch_fs *, struct bkey_s_c);
393 void bch2_btree_ptr_to_text(struct printbuf *, struct bch_fs *,
394                             struct bkey_s_c);
395 void bch2_ptr_swab(const struct bkey_format *, struct bkey_packed *);
396
397 #define bch2_bkey_ops_btree_ptr (struct bkey_ops) {             \
398         .key_invalid    = bch2_btree_ptr_invalid,               \
399         .key_debugcheck = bch2_btree_ptr_debugcheck,            \
400         .val_to_text    = bch2_btree_ptr_to_text,               \
401         .swab           = bch2_ptr_swab,                        \
402 }
403
404 /* bch_extent: */
405
406 const char *bch2_extent_invalid(const struct bch_fs *, struct bkey_s_c);
407 void bch2_extent_debugcheck(struct bch_fs *, struct bkey_s_c);
408 void bch2_extent_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
409 bool bch2_extent_normalize(struct bch_fs *, struct bkey_s);
410 enum merge_result bch2_extent_merge(struct bch_fs *,
411                                     struct bkey_s, struct bkey_s);
412
413 #define bch2_bkey_ops_extent (struct bkey_ops) {                \
414         .key_invalid    = bch2_extent_invalid,                  \
415         .key_debugcheck = bch2_extent_debugcheck,               \
416         .val_to_text    = bch2_extent_to_text,                  \
417         .swab           = bch2_ptr_swab,                        \
418         .key_normalize  = bch2_extent_normalize,                \
419         .key_merge      = bch2_extent_merge,                    \
420 }
421
422 /* bch_reservation: */
423
424 const char *bch2_reservation_invalid(const struct bch_fs *, struct bkey_s_c);
425 void bch2_reservation_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
426 enum merge_result bch2_reservation_merge(struct bch_fs *,
427                                          struct bkey_s, struct bkey_s);
428
429 #define bch2_bkey_ops_reservation (struct bkey_ops) {           \
430         .key_invalid    = bch2_reservation_invalid,             \
431         .val_to_text    = bch2_reservation_to_text,             \
432         .key_merge      = bch2_reservation_merge,               \
433 }
434
435 int bch2_extent_atomic_end(struct btree_iter *, struct bkey_i *,
436                            struct bpos *);
437 int bch2_extent_trim_atomic(struct bkey_i *, struct btree_iter *);
438 int bch2_extent_is_atomic(struct bkey_i *, struct btree_iter *);
439
440 enum btree_insert_ret
441 bch2_extent_can_insert(struct btree_trans *, struct btree_insert_entry *,
442                        unsigned *);
443 void bch2_insert_fixup_extent(struct btree_trans *,
444                               struct btree_insert_entry *);
445
446 void bch2_bkey_mark_replicas_cached(struct bch_fs *, struct bkey_s,
447                                     unsigned, unsigned);
448
449 const struct bch_extent_ptr *
450 bch2_extent_has_device(struct bkey_s_c_extent, unsigned);
451
452 unsigned bch2_extent_is_compressed(struct bkey_s_c);
453
454 bool bch2_bkey_matches_ptr(struct bch_fs *, struct bkey_s_c,
455                            struct bch_extent_ptr, u64);
456
457 static inline bool bkey_extent_is_direct_data(const struct bkey *k)
458 {
459         switch (k->type) {
460         case KEY_TYPE_btree_ptr:
461         case KEY_TYPE_extent:
462         case KEY_TYPE_reflink_v:
463                 return true;
464         default:
465                 return false;
466         }
467 }
468
469 static inline bool bkey_extent_is_data(const struct bkey *k)
470 {
471         return bkey_extent_is_direct_data(k) ||
472                 k->type == KEY_TYPE_reflink_p;
473 }
474
475 /*
476  * Should extent be counted under inode->i_sectors?
477  */
478 static inline bool bkey_extent_is_allocation(const struct bkey *k)
479 {
480         switch (k->type) {
481         case KEY_TYPE_extent:
482         case KEY_TYPE_reservation:
483         case KEY_TYPE_reflink_p:
484         case KEY_TYPE_reflink_v:
485                 return true;
486         default:
487                 return false;
488         }
489 }
490
491 /* Extent entry iteration: */
492
493 #define extent_for_each_entry_from(_e, _entry, _start)                  \
494         __bkey_extent_entry_for_each_from(_start,                       \
495                                 extent_entry_last(_e),_entry)
496
497 #define extent_for_each_entry(_e, _entry)                               \
498         extent_for_each_entry_from(_e, _entry, (_e).v->start)
499
500 #define extent_ptr_next(_e, _ptr)                                       \
501         __bkey_ptr_next(_ptr, extent_entry_last(_e))
502
503 #define extent_for_each_ptr(_e, _ptr)                                   \
504         __bkey_for_each_ptr(&(_e).v->start->ptr, extent_entry_last(_e), _ptr)
505
506 #define extent_for_each_ptr_decode(_e, _ptr, _entry)                    \
507         __bkey_for_each_ptr_decode((_e).k, (_e).v->start,               \
508                                    extent_entry_last(_e), _ptr, _entry)
509
510 void bch2_extent_ptr_decoded_append(struct bkey_i *,
511                                     struct extent_ptr_decoded *);
512
513 bool bch2_can_narrow_extent_crcs(struct bkey_s_c,
514                                  struct bch_extent_crc_unpacked);
515 bool bch2_bkey_narrow_crcs(struct bkey_i *, struct bch_extent_crc_unpacked);
516
517 union bch_extent_entry *bch2_bkey_drop_ptr(struct bkey_s,
518                                            struct bch_extent_ptr *);
519
520 #define bch2_bkey_drop_ptrs(_k, _ptr, _cond)                            \
521 do {                                                                    \
522         struct bkey_ptrs _ptrs = bch2_bkey_ptrs(_k);                    \
523                                                                         \
524         _ptr = &_ptrs.start->ptr;                                       \
525                                                                         \
526         while ((_ptr = bkey_ptr_next(_ptrs, _ptr))) {                   \
527                 if (_cond) {                                            \
528                         _ptr = (void *) bch2_bkey_drop_ptr(_k, _ptr);   \
529                         _ptrs = bch2_bkey_ptrs(_k);                     \
530                         continue;                                       \
531                 }                                                       \
532                                                                         \
533                 (_ptr)++;                                               \
534         }                                                               \
535 } while (0)
536
537 void __bch2_cut_front(struct bpos, struct bkey_s);
538
539 static inline void bch2_cut_front(struct bpos where, struct bkey_i *k)
540 {
541         __bch2_cut_front(where, bkey_i_to_s(k));
542 }
543
544 bool bch2_cut_back(struct bpos, struct bkey *);
545
546 /**
547  * bch_key_resize - adjust size of @k
548  *
549  * bkey_start_offset(k) will be preserved, modifies where the extent ends
550  */
551 static inline void bch2_key_resize(struct bkey *k, unsigned new_size)
552 {
553         k->p.offset -= k->size;
554         k->p.offset += new_size;
555         k->size = new_size;
556 }
557
558 /*
559  * In extent_sort_fix_overlapping(), insert_fixup_extent(),
560  * extent_merge_inline() - we're modifying keys in place that are packed. To do
561  * that we have to unpack the key, modify the unpacked key - then this
562  * copies/repacks the unpacked to the original as necessary.
563  */
564 static inline void extent_save(struct btree *b, struct bkey_packed *dst,
565                                struct bkey *src)
566 {
567         struct bkey_format *f = &b->format;
568         struct bkey_i *dst_unpacked;
569
570         if ((dst_unpacked = packed_to_bkey(dst)))
571                 dst_unpacked->k = *src;
572         else
573                 BUG_ON(!bch2_bkey_pack_key(dst, src, f));
574 }
575
576 bool bch2_check_range_allocated(struct bch_fs *, struct bpos, u64, unsigned);
577 unsigned bch2_bkey_nr_ptrs_allocated(struct bkey_s_c);
578
579 #endif /* _BCACHEFS_EXTENTS_H */