1 #ifndef _BCACHEFS_UTIL_H
2 #define _BCACHEFS_UTIL_H
5 #include <linux/blkdev.h>
6 #include <linux/closure.h>
7 #include <linux/errno.h>
8 #include <linux/freezer.h>
9 #include <linux/kernel.h>
10 #include <linux/sched/clock.h>
11 #include <linux/llist.h>
12 #include <linux/log2.h>
13 #include <linux/ratelimit.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
16 #include <linux/workqueue.h>
18 #define PAGE_SECTOR_SHIFT (PAGE_SHIFT - 9)
19 #define PAGE_SECTORS (1UL << PAGE_SECTOR_SHIFT)
23 #ifdef CONFIG_BCACHEFS_DEBUG
25 #define EBUG_ON(cond) BUG_ON(cond)
26 #define atomic_dec_bug(v) BUG_ON(atomic_dec_return(v) < 0)
27 #define atomic_inc_bug(v, i) BUG_ON(atomic_inc_return(v) <= i)
28 #define atomic_sub_bug(i, v) BUG_ON(atomic_sub_return(i, v) < 0)
29 #define atomic_add_bug(i, v) BUG_ON(atomic_add_return(i, v) < 0)
30 #define atomic_long_dec_bug(v) BUG_ON(atomic_long_dec_return(v) < 0)
31 #define atomic_long_sub_bug(i, v) BUG_ON(atomic_long_sub_return(i, v) < 0)
32 #define atomic64_dec_bug(v) BUG_ON(atomic64_dec_return(v) < 0)
33 #define atomic64_inc_bug(v, i) BUG_ON(atomic64_inc_return(v) <= i)
34 #define atomic64_sub_bug(i, v) BUG_ON(atomic64_sub_return(i, v) < 0)
35 #define atomic64_add_bug(i, v) BUG_ON(atomic64_add_return(i, v) < 0)
37 #define memcpy(dst, src, len) \
40 const void *_src = (src); \
41 size_t _len = (len); \
43 BUG_ON(!((void *) (_dst) >= (void *) (_src) + (_len) || \
44 (void *) (_dst) + (_len) <= (void *) (_src))); \
45 memcpy(_dst, _src, _len); \
51 #define atomic_dec_bug(v) atomic_dec(v)
52 #define atomic_inc_bug(v, i) atomic_inc(v)
53 #define atomic_sub_bug(i, v) atomic_sub(i, v)
54 #define atomic_add_bug(i, v) atomic_add(i, v)
55 #define atomic_long_dec_bug(v) atomic_long_dec(v)
56 #define atomic_long_sub_bug(i, v) atomic_long_sub(i, v)
57 #define atomic64_dec_bug(v) atomic64_dec(v)
58 #define atomic64_inc_bug(v, i) atomic64_inc(v)
59 #define atomic64_sub_bug(i, v) atomic64_sub(i, v)
60 #define atomic64_add_bug(i, v) atomic64_add(i, v)
65 #define __flatten __attribute__((flatten))
67 /* sparse doesn't know about attribute((flatten)) */
71 #ifdef __LITTLE_ENDIAN
72 #define CPU_BIG_ENDIAN 0
74 #define CPU_BIG_ENDIAN 1
79 #define type_is_exact(_val, _type) \
80 __builtin_types_compatible_p(typeof(_val), _type)
82 #define type_is(_val, _type) \
83 (__builtin_types_compatible_p(typeof(_val), _type) || \
84 __builtin_types_compatible_p(typeof(_val), const _type))
86 static inline void vpfree(void *p, size_t size)
88 if (is_vmalloc_addr(p))
91 free_pages((unsigned long) p, get_order(size));
94 static inline void *vpmalloc(size_t size, gfp_t gfp_mask)
96 return (void *) __get_free_pages(gfp_mask|__GFP_NOWARN,
98 __vmalloc(size, gfp_mask, PAGE_KERNEL);
101 static inline void kvpfree(void *p, size_t size)
103 if (size < PAGE_SIZE)
109 static inline void *kvpmalloc(size_t size, gfp_t gfp_mask)
111 return size < PAGE_SIZE
112 ? kmalloc(size, gfp_mask)
113 : vpmalloc(size, gfp_mask);
116 void mempool_free_vp(void *element, void *pool_data);
117 void *mempool_alloc_vp(gfp_t gfp_mask, void *pool_data);
119 static inline int mempool_init_vp_pool(mempool_t *pool, int min_nr, size_t size)
121 return mempool_init(pool, min_nr, mempool_alloc_vp,
122 mempool_free_vp, (void *) size);
131 #define DECLARE_HEAP(type, name) HEAP(type) name
133 #define init_heap(heap, _size, gfp) \
136 (heap)->size = (_size); \
137 (heap)->data = kvpmalloc((heap)->size * sizeof((heap)->data[0]),\
141 #define free_heap(heap) \
143 kvpfree((heap)->data, (heap)->size * sizeof((heap)->data[0])); \
144 (heap)->data = NULL; \
147 #define heap_swap(h, i, j) swap((h)->data[i], (h)->data[j])
149 #define heap_peek(h) \
151 EBUG_ON(!(h)->used); \
155 #define heap_full(h) ((h)->used == (h)->size)
157 #define heap_sift_down(h, i, cmp) \
161 for (; _j * 2 + 1 < (h)->used; _j = _c) { \
163 if (_c + 1 < (h)->used && \
164 cmp(h, (h)->data[_c], (h)->data[_c + 1]) >= 0) \
167 if (cmp(h, (h)->data[_c], (h)->data[_j]) >= 0) \
169 heap_swap(h, _c, _j); \
173 #define heap_sift_up(h, i, cmp) \
176 size_t p = (i - 1) / 2; \
177 if (cmp(h, (h)->data[i], (h)->data[p]) >= 0) \
179 heap_swap(h, i, p); \
184 #define heap_add(h, new, cmp) \
186 bool _r = !heap_full(h); \
188 size_t _i = (h)->used++; \
189 (h)->data[_i] = new; \
191 heap_sift_up(h, _i, cmp); \
196 #define heap_add_or_replace(h, new, cmp) \
198 if (!heap_add(h, new, cmp) && \
199 cmp(h, new, heap_peek(h)) >= 0) { \
200 (h)->data[0] = new; \
201 heap_sift_down(h, 0, cmp); \
205 #define heap_del(h, i, cmp) \
209 BUG_ON(_i >= (h)->used); \
211 heap_swap(h, _i, (h)->used); \
212 heap_sift_up(h, _i, cmp); \
213 heap_sift_down(h, _i, cmp); \
216 #define heap_pop(h, d, cmp) \
218 bool _r = (h)->used; \
220 (d) = (h)->data[0]; \
221 heap_del(h, 0, cmp); \
226 #define heap_resort(heap, cmp) \
229 for (_i = (ssize_t) (heap)->used / 2 - 1; _i >= 0; --_i) \
230 heap_sift_down(heap, _i, cmp); \
234 * Simple array based allocator - preallocates a number of elements and you can
235 * never allocate more than that, also has no locking.
237 * Handy because if you know you only need a fixed number of elements you don't
238 * have to worry about memory allocation failure, and sometimes a mempool isn't
241 * We treat the free elements as entries in a singly linked list, and the
242 * freelist as a stack - allocating and freeing push and pop off the freelist.
245 #define DECLARE_ARRAY_ALLOCATOR(type, name, size) \
251 #define array_alloc(array) \
253 typeof((array)->freelist) _ret = (array)->freelist; \
256 (array)->freelist = *((typeof((array)->freelist) *) _ret);\
261 #define array_free(array, ptr) \
263 typeof((array)->freelist) _ptr = ptr; \
265 *((typeof((array)->freelist) *) _ptr) = (array)->freelist; \
266 (array)->freelist = _ptr; \
269 #define array_allocator_init(array) \
271 typeof((array)->freelist) _i; \
273 BUILD_BUG_ON(sizeof((array)->data[0]) < sizeof(void *)); \
274 (array)->freelist = NULL; \
276 for (_i = (array)->data; \
277 _i < (array)->data + ARRAY_SIZE((array)->data); \
279 array_free(array, _i); \
282 #define array_freelist_empty(array) ((array)->freelist == NULL)
284 #define ANYSINT_MAX(t) \
285 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
287 int bch2_strtoint_h(const char *, int *);
288 int bch2_strtouint_h(const char *, unsigned int *);
289 int bch2_strtoll_h(const char *, long long *);
290 int bch2_strtoull_h(const char *, unsigned long long *);
292 static inline int bch2_strtol_h(const char *cp, long *res)
294 #if BITS_PER_LONG == 32
295 return bch2_strtoint_h(cp, (int *) res);
297 return bch2_strtoll_h(cp, (long long *) res);
301 static inline int bch2_strtoul_h(const char *cp, long *res)
303 #if BITS_PER_LONG == 32
304 return bch2_strtouint_h(cp, (unsigned int *) res);
306 return bch2_strtoull_h(cp, (unsigned long long *) res);
310 #define strtoi_h(cp, res) \
311 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
312 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
313 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
314 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
315 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
316 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
319 #define strtoul_safe(cp, var) \
322 int _r = kstrtoul(cp, 10, &_v); \
328 #define strtoul_safe_clamp(cp, var, min, max) \
331 int _r = kstrtoul(cp, 10, &_v); \
333 var = clamp_t(typeof(var), _v, min, max); \
337 #define strtoul_safe_restrict(cp, var, min, max) \
340 int _r = kstrtoul(cp, 10, &_v); \
341 if (!_r && _v >= min && _v <= max) \
348 #define snprint(buf, size, var) \
349 snprintf(buf, size, \
350 type_is(var, int) ? "%i\n" \
351 : type_is(var, unsigned) ? "%u\n" \
352 : type_is(var, long) ? "%li\n" \
353 : type_is(var, unsigned long) ? "%lu\n" \
354 : type_is(var, s64) ? "%lli\n" \
355 : type_is(var, u64) ? "%llu\n" \
356 : type_is(var, char *) ? "%s\n" \
359 ssize_t bch2_hprint(char *buf, s64 v);
361 bool bch2_is_zero(const void *, size_t);
363 ssize_t bch2_scnprint_string_list(char *, size_t, const char * const[], size_t);
365 ssize_t bch2_read_string_list(const char *, const char * const[]);
367 ssize_t bch2_scnprint_flag_list(char *, size_t, const char * const[], u64);
368 u64 bch2_read_flag_list(char *, const char * const[]);
374 * all fields are in nanoseconds, averages are ewmas stored left shifted
379 u64 average_duration;
380 u64 average_frequency;
384 void bch2_time_stats_clear(struct time_stats *stats);
385 void __bch2_time_stats_update(struct time_stats *stats, u64 time);
386 void bch2_time_stats_update(struct time_stats *stats, u64 time);
388 static inline unsigned local_clock_us(void)
390 return local_clock() >> 10;
393 #define NSEC_PER_ns 1L
394 #define NSEC_PER_us NSEC_PER_USEC
395 #define NSEC_PER_ms NSEC_PER_MSEC
396 #define NSEC_PER_sec NSEC_PER_SEC
398 #define __print_time_stat(stats, name, stat, units) \
399 sysfs_print(name ## _ ## stat ## _ ## units, \
400 div_u64((stats)->stat >> 8, NSEC_PER_ ## units))
402 #define sysfs_print_time_stats(stats, name, \
406 __print_time_stat(stats, name, \
407 average_frequency, frequency_units); \
408 __print_time_stat(stats, name, \
409 average_duration, duration_units); \
410 sysfs_print(name ## _ ##count, (stats)->count); \
411 sysfs_print(name ## _ ##last_duration ## _ ## duration_units, \
412 div_u64((stats)->last_duration, \
413 NSEC_PER_ ## duration_units)); \
414 sysfs_print(name ## _ ##max_duration ## _ ## duration_units, \
415 div_u64((stats)->max_duration, \
416 NSEC_PER_ ## duration_units)); \
418 sysfs_print(name ## _last_ ## frequency_units, (stats)->last \
419 ? div_s64(local_clock() - (stats)->last, \
420 NSEC_PER_ ## frequency_units) \
424 #define sysfs_clear_time_stats(stats, name) \
426 if (attr == &sysfs_ ## name ## _clear) \
427 bch2_time_stats_clear(stats); \
430 #define sysfs_time_stats_attribute(name, \
433 write_attribute(name ## _clear); \
434 read_attribute(name ## _count); \
435 read_attribute(name ## _average_frequency_ ## frequency_units); \
436 read_attribute(name ## _average_duration_ ## duration_units); \
437 read_attribute(name ## _last_duration_ ## duration_units); \
438 read_attribute(name ## _max_duration_ ## duration_units); \
439 read_attribute(name ## _last_ ## frequency_units)
441 #define sysfs_time_stats_attribute_list(name, \
444 &sysfs_ ## name ## _clear, \
445 &sysfs_ ## name ## _count, \
446 &sysfs_ ## name ## _average_frequency_ ## frequency_units, \
447 &sysfs_ ## name ## _average_duration_ ## duration_units, \
448 &sysfs_ ## name ## _last_duration_ ## duration_units, \
449 &sysfs_ ## name ## _max_duration_ ## duration_units, \
450 &sysfs_ ## name ## _last_ ## frequency_units,
452 #define ewma_add(ewma, val, weight) \
454 typeof(ewma) _ewma = (ewma); \
455 typeof(weight) _weight = (weight); \
457 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
460 struct bch_ratelimit {
461 /* Next time we want to do some work, in nanoseconds */
465 * Rate at which we want to do work, in units per nanosecond
466 * The units here correspond to the units passed to
467 * bch2_ratelimit_increment()
472 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
474 d->next = local_clock();
477 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
478 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
479 int bch2_ratelimit_wait_freezable_stoppable(struct bch_ratelimit *);
481 struct bch_pd_controller {
482 struct bch_ratelimit rate;
483 unsigned long last_update;
486 s64 smoothed_derivative;
488 unsigned p_term_inverse;
492 /* for exporting to sysfs (no effect on behavior) */
494 s64 last_proportional;
498 /* If true, the rate will not increase if bch2_ratelimit_delay()
499 * is not being called often enough. */
503 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
504 void bch2_pd_controller_init(struct bch_pd_controller *);
505 size_t bch2_pd_controller_print_debug(struct bch_pd_controller *, char *);
507 #define sysfs_pd_controller_attribute(name) \
508 rw_attribute(name##_rate); \
509 rw_attribute(name##_rate_bytes); \
510 rw_attribute(name##_rate_d_term); \
511 rw_attribute(name##_rate_p_term_inverse); \
512 read_attribute(name##_rate_debug)
514 #define sysfs_pd_controller_files(name) \
515 &sysfs_##name##_rate, \
516 &sysfs_##name##_rate_bytes, \
517 &sysfs_##name##_rate_d_term, \
518 &sysfs_##name##_rate_p_term_inverse, \
519 &sysfs_##name##_rate_debug
521 #define sysfs_pd_controller_show(name, var) \
523 sysfs_hprint(name##_rate, (var)->rate.rate); \
524 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
525 sysfs_print(name##_rate_d_term, (var)->d_term); \
526 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
528 if (attr == &sysfs_##name##_rate_debug) \
529 return bch2_pd_controller_print_debug(var, buf); \
532 #define sysfs_pd_controller_store(name, var) \
534 sysfs_strtoul_clamp(name##_rate, \
535 (var)->rate.rate, 1, UINT_MAX); \
536 sysfs_strtoul_clamp(name##_rate_bytes, \
537 (var)->rate.rate, 1, UINT_MAX); \
538 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
539 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
540 (var)->p_term_inverse, 1, INT_MAX); \
543 #define __DIV_SAFE(n, d, zero) \
545 typeof(n) _n = (n); \
546 typeof(d) _d = (d); \
547 _d ? _n / _d : zero; \
550 #define DIV_SAFE(n, d) __DIV_SAFE(n, d, 0)
552 #define container_of_or_null(ptr, type, member) \
554 typeof(ptr) _ptr = ptr; \
555 _ptr ? container_of(_ptr, type, member) : NULL; \
558 #define RB_INSERT(root, new, member, cmp) \
561 struct rb_node **n = &(root)->rb_node, *parent = NULL; \
567 this = container_of(*n, typeof(*(new)), member); \
568 res = cmp(new, this); \
576 rb_link_node(&(new)->member, parent, n); \
577 rb_insert_color(&(new)->member, root); \
583 #define RB_SEARCH(root, search, member, cmp) \
585 struct rb_node *n = (root)->rb_node; \
586 typeof(&(search)) this, ret = NULL; \
590 this = container_of(n, typeof(search), member); \
591 res = cmp(&(search), this); \
603 #define RB_GREATER(root, search, member, cmp) \
605 struct rb_node *n = (root)->rb_node; \
606 typeof(&(search)) this, ret = NULL; \
610 this = container_of(n, typeof(search), member); \
611 res = cmp(&(search), this); \
621 #define RB_FIRST(root, type, member) \
622 container_of_or_null(rb_first(root), type, member)
624 #define RB_LAST(root, type, member) \
625 container_of_or_null(rb_last(root), type, member)
627 #define RB_NEXT(ptr, member) \
628 container_of_or_null(rb_next(&(ptr)->member), typeof(*ptr), member)
630 #define RB_PREV(ptr, member) \
631 container_of_or_null(rb_prev(&(ptr)->member), typeof(*ptr), member)
633 /* Does linear interpolation between powers of two */
634 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
636 unsigned fract = x & ~(~0 << fract_bits);
640 x += (x * fract) >> fract_bits;
645 void bch2_bio_map(struct bio *bio, void *base);
647 static inline sector_t bdev_sectors(struct block_device *bdev)
649 return bdev->bd_inode->i_size >> 9;
652 #define closure_bio_submit(bio, cl) \
658 #define kthread_wait_freezable(cond) \
662 set_current_state(TASK_INTERRUPTIBLE); \
663 if (kthread_should_stop()) { \
674 set_current_state(TASK_RUNNING); \
678 size_t bch2_rand_range(size_t);
680 void memcpy_to_bio(struct bio *, struct bvec_iter, void *);
681 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
683 static inline void __memcpy_u64s(void *dst, const void *src,
688 asm volatile("rep ; movsq"
689 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
690 : "0" (u64s), "1" (dst), "2" (src)
701 static inline void memcpy_u64s(void *dst, const void *src,
704 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
705 dst + u64s * sizeof(u64) <= src));
707 __memcpy_u64s(dst, src, u64s);
710 static inline void __memmove_u64s_down(void *dst, const void *src,
713 __memcpy_u64s(dst, src, u64s);
716 static inline void memmove_u64s_down(void *dst, const void *src,
721 __memmove_u64s_down(dst, src, u64s);
724 static inline void __memmove_u64s_up(void *_dst, const void *_src,
727 u64 *dst = (u64 *) _dst + u64s - 1;
728 u64 *src = (u64 *) _src + u64s - 1;
732 asm volatile("std ;\n"
735 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
736 : "0" (u64s), "1" (dst), "2" (src)
744 static inline void memmove_u64s_up(void *dst, const void *src,
749 __memmove_u64s_up(dst, src, u64s);
752 static inline void memmove_u64s(void *dst, const void *src,
756 __memmove_u64s_down(dst, src, u64s);
758 __memmove_u64s_up(dst, src, u64s);
761 static inline struct bio_vec next_contig_bvec(struct bio *bio,
762 struct bvec_iter *iter)
764 struct bio_vec bv = bio_iter_iovec(bio, *iter);
766 bio_advance_iter(bio, iter, bv.bv_len);
767 #ifndef CONFIG_HIGHMEM
768 while (iter->bi_size) {
769 struct bio_vec next = bio_iter_iovec(bio, *iter);
771 if (page_address(bv.bv_page) + bv.bv_offset + bv.bv_len !=
772 page_address(next.bv_page) + next.bv_offset)
775 bv.bv_len += next.bv_len;
776 bio_advance_iter(bio, iter, next.bv_len);
782 #define __bio_for_each_contig_segment(bv, bio, iter, start) \
783 for (iter = (start); \
785 ((bv = next_contig_bvec((bio), &(iter))), 1);)
787 #define bio_for_each_contig_segment(bv, bio, iter) \
788 __bio_for_each_contig_segment(bv, bio, iter, (bio)->bi_iter)
790 size_t bch_scnmemcpy(char *, size_t, const char *, size_t);
792 void sort_cmp_size(void *base, size_t num, size_t size,
793 int (*cmp_func)(const void *, const void *, size_t),
794 void (*swap_func)(void *, void *, size_t));
796 /* just the memmove, doesn't update @_nr */
797 #define __array_insert_item(_array, _nr, _pos) \
798 memmove(&(_array)[(_pos) + 1], \
800 sizeof((_array)[0]) * ((_nr) - (_pos)))
802 #define array_insert_item(_array, _nr, _pos, _new_item) \
804 __array_insert_item(_array, _nr, _pos); \
806 (_array)[(_pos)] = (_new_item); \
809 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
811 (_nr) -= (_nr_to_remove); \
812 memmove(&(_array)[(_pos)], \
813 &(_array)[(_pos) + (_nr_to_remove)], \
814 sizeof((_array)[0]) * ((_nr) - (_pos))); \
817 #define array_remove_item(_array, _nr, _pos) \
818 array_remove_items(_array, _nr, _pos, 1)
820 #endif /* _BCACHEFS_UTIL_H */