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) \
39 BUG_ON(!((void *) (_dst) >= (void *) (_src) + (_len) || \
40 (void *) (_dst) + (_len) <= (void *) (_src))); \
41 memcpy(_dst, _src, _len); \
47 #define atomic_dec_bug(v) atomic_dec(v)
48 #define atomic_inc_bug(v, i) atomic_inc(v)
49 #define atomic_sub_bug(i, v) atomic_sub(i, v)
50 #define atomic_add_bug(i, v) atomic_add(i, v)
51 #define atomic_long_dec_bug(v) atomic_long_dec(v)
52 #define atomic_long_sub_bug(i, v) atomic_long_sub(i, v)
53 #define atomic64_dec_bug(v) atomic64_dec(v)
54 #define atomic64_inc_bug(v, i) atomic64_inc(v)
55 #define atomic64_sub_bug(i, v) atomic64_sub(i, v)
56 #define atomic64_add_bug(i, v) atomic64_add(i, v)
61 #define __flatten __attribute__((flatten))
63 /* sparse doesn't know about attribute((flatten)) */
67 #ifdef __LITTLE_ENDIAN
68 #define CPU_BIG_ENDIAN 0
70 #define CPU_BIG_ENDIAN 1
75 #define type_is_exact(_val, _type) \
76 __builtin_types_compatible_p(typeof(_val), _type)
78 #define type_is(_val, _type) \
79 (__builtin_types_compatible_p(typeof(_val), _type) || \
80 __builtin_types_compatible_p(typeof(_val), const _type))
82 static inline void vpfree(void *p, size_t size)
84 if (is_vmalloc_addr(p))
87 free_pages((unsigned long) p, get_order(size));
90 static inline void *vpmalloc(size_t size, gfp_t gfp_mask)
92 return (void *) __get_free_pages(gfp_mask|__GFP_NOWARN,
94 __vmalloc(size, gfp_mask, PAGE_KERNEL);
97 static inline void kvpfree(void *p, size_t size)
105 static inline void *kvpmalloc(size_t size, gfp_t gfp_mask)
107 return size < PAGE_SIZE
108 ? kmalloc(size, gfp_mask)
109 : vpmalloc(size, gfp_mask);
112 void mempool_free_vp(void *element, void *pool_data);
113 void *mempool_alloc_vp(gfp_t gfp_mask, void *pool_data);
115 static inline int mempool_init_vp_pool(mempool_t *pool, int min_nr, size_t size)
117 return mempool_init(pool, min_nr, mempool_alloc_vp,
118 mempool_free_vp, (void *) size);
127 #define DECLARE_HEAP(type, name) HEAP(type) name
129 #define init_heap(heap, _size, gfp) \
132 (heap)->size = (_size); \
133 (heap)->data = kvpmalloc((heap)->size * sizeof((heap)->data[0]),\
137 #define free_heap(heap) \
139 kvpfree((heap)->data, (heap)->size * sizeof((heap)->data[0])); \
140 (heap)->data = NULL; \
143 #define heap_swap(h, i, j) swap((h)->data[i], (h)->data[j])
145 #define heap_peek(h) \
147 EBUG_ON(!(h)->used); \
151 #define heap_full(h) ((h)->used == (h)->size)
153 #define heap_sift_down(h, i, cmp) \
157 for (; _j * 2 + 1 < (h)->used; _j = _c) { \
159 if (_c + 1 < (h)->used && \
160 cmp(h, (h)->data[_c], (h)->data[_c + 1]) >= 0) \
163 if (cmp(h, (h)->data[_c], (h)->data[_j]) >= 0) \
165 heap_swap(h, _c, _j); \
169 #define heap_sift_up(h, i, cmp) \
172 size_t p = (i - 1) / 2; \
173 if (cmp(h, (h)->data[i], (h)->data[p]) >= 0) \
175 heap_swap(h, i, p); \
180 #define heap_add(h, new, cmp) \
182 bool _r = !heap_full(h); \
184 size_t _i = (h)->used++; \
185 (h)->data[_i] = new; \
187 heap_sift_up(h, _i, cmp); \
192 #define heap_add_or_replace(h, new, cmp) \
194 if (!heap_add(h, new, cmp) && \
195 cmp(h, new, heap_peek(h)) >= 0) { \
196 (h)->data[0] = new; \
197 heap_sift_down(h, 0, cmp); \
201 #define heap_del(h, i, cmp) \
205 BUG_ON(_i >= (h)->used); \
207 heap_swap(h, _i, (h)->used); \
208 heap_sift_up(h, _i, cmp); \
209 heap_sift_down(h, _i, cmp); \
212 #define heap_pop(h, d, cmp) \
214 bool _r = (h)->used; \
216 (d) = (h)->data[0]; \
217 heap_del(h, 0, cmp); \
222 #define heap_resort(heap, cmp) \
225 for (_i = (ssize_t) (heap)->used / 2 - 1; _i >= 0; --_i) \
226 heap_sift_down(heap, _i, cmp); \
230 * Simple array based allocator - preallocates a number of elements and you can
231 * never allocate more than that, also has no locking.
233 * Handy because if you know you only need a fixed number of elements you don't
234 * have to worry about memory allocation failure, and sometimes a mempool isn't
237 * We treat the free elements as entries in a singly linked list, and the
238 * freelist as a stack - allocating and freeing push and pop off the freelist.
241 #define DECLARE_ARRAY_ALLOCATOR(type, name, size) \
247 #define array_alloc(array) \
249 typeof((array)->freelist) _ret = (array)->freelist; \
252 (array)->freelist = *((typeof((array)->freelist) *) _ret);\
257 #define array_free(array, ptr) \
259 typeof((array)->freelist) _ptr = ptr; \
261 *((typeof((array)->freelist) *) _ptr) = (array)->freelist; \
262 (array)->freelist = _ptr; \
265 #define array_allocator_init(array) \
267 typeof((array)->freelist) _i; \
269 BUILD_BUG_ON(sizeof((array)->data[0]) < sizeof(void *)); \
270 (array)->freelist = NULL; \
272 for (_i = (array)->data; \
273 _i < (array)->data + ARRAY_SIZE((array)->data); \
275 array_free(array, _i); \
278 #define array_freelist_empty(array) ((array)->freelist == NULL)
280 #define ANYSINT_MAX(t) \
281 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
283 int bch2_strtoint_h(const char *, int *);
284 int bch2_strtouint_h(const char *, unsigned int *);
285 int bch2_strtoll_h(const char *, long long *);
286 int bch2_strtoull_h(const char *, unsigned long long *);
288 static inline int bch2_strtol_h(const char *cp, long *res)
290 #if BITS_PER_LONG == 32
291 return bch2_strtoint_h(cp, (int *) res);
293 return bch2_strtoll_h(cp, (long long *) res);
297 static inline int bch2_strtoul_h(const char *cp, long *res)
299 #if BITS_PER_LONG == 32
300 return bch2_strtouint_h(cp, (unsigned int *) res);
302 return bch2_strtoull_h(cp, (unsigned long long *) res);
306 #define strtoi_h(cp, res) \
307 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
308 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
309 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
310 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
311 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
312 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
315 #define strtoul_safe(cp, var) \
318 int _r = kstrtoul(cp, 10, &_v); \
324 #define strtoul_safe_clamp(cp, var, min, max) \
327 int _r = kstrtoul(cp, 10, &_v); \
329 var = clamp_t(typeof(var), _v, min, max); \
333 #define strtoul_safe_restrict(cp, var, min, max) \
336 int _r = kstrtoul(cp, 10, &_v); \
337 if (!_r && _v >= min && _v <= max) \
344 #define snprint(buf, size, var) \
345 snprintf(buf, size, \
346 type_is(var, int) ? "%i\n" \
347 : type_is(var, unsigned) ? "%u\n" \
348 : type_is(var, long) ? "%li\n" \
349 : type_is(var, unsigned long) ? "%lu\n" \
350 : type_is(var, s64) ? "%lli\n" \
351 : type_is(var, u64) ? "%llu\n" \
352 : type_is(var, char *) ? "%s\n" \
355 ssize_t bch2_hprint(char *buf, s64 v);
357 bool bch2_is_zero(const void *, size_t);
359 ssize_t bch2_scnprint_string_list(char *, size_t, const char * const[], size_t);
361 ssize_t bch2_read_string_list(const char *, const char * const[]);
363 ssize_t bch2_scnprint_flag_list(char *, size_t, const char * const[], u64);
364 u64 bch2_read_flag_list(char *, const char * const[]);
370 * all fields are in nanoseconds, averages are ewmas stored left shifted
375 u64 average_duration;
376 u64 average_frequency;
380 void bch2_time_stats_clear(struct time_stats *stats);
381 void __bch2_time_stats_update(struct time_stats *stats, u64 time);
382 void bch2_time_stats_update(struct time_stats *stats, u64 time);
384 static inline unsigned local_clock_us(void)
386 return local_clock() >> 10;
389 #define NSEC_PER_ns 1L
390 #define NSEC_PER_us NSEC_PER_USEC
391 #define NSEC_PER_ms NSEC_PER_MSEC
392 #define NSEC_PER_sec NSEC_PER_SEC
394 #define __print_time_stat(stats, name, stat, units) \
395 sysfs_print(name ## _ ## stat ## _ ## units, \
396 div_u64((stats)->stat >> 8, NSEC_PER_ ## units))
398 #define sysfs_print_time_stats(stats, name, \
402 __print_time_stat(stats, name, \
403 average_frequency, frequency_units); \
404 __print_time_stat(stats, name, \
405 average_duration, duration_units); \
406 sysfs_print(name ## _ ##count, (stats)->count); \
407 sysfs_print(name ## _ ##last_duration ## _ ## duration_units, \
408 div_u64((stats)->last_duration, \
409 NSEC_PER_ ## duration_units)); \
410 sysfs_print(name ## _ ##max_duration ## _ ## duration_units, \
411 div_u64((stats)->max_duration, \
412 NSEC_PER_ ## duration_units)); \
414 sysfs_print(name ## _last_ ## frequency_units, (stats)->last \
415 ? div_s64(local_clock() - (stats)->last, \
416 NSEC_PER_ ## frequency_units) \
420 #define sysfs_clear_time_stats(stats, name) \
422 if (attr == &sysfs_ ## name ## _clear) \
423 bch2_time_stats_clear(stats); \
426 #define sysfs_time_stats_attribute(name, \
429 write_attribute(name ## _clear); \
430 read_attribute(name ## _count); \
431 read_attribute(name ## _average_frequency_ ## frequency_units); \
432 read_attribute(name ## _average_duration_ ## duration_units); \
433 read_attribute(name ## _last_duration_ ## duration_units); \
434 read_attribute(name ## _max_duration_ ## duration_units); \
435 read_attribute(name ## _last_ ## frequency_units)
437 #define sysfs_time_stats_attribute_list(name, \
440 &sysfs_ ## name ## _clear, \
441 &sysfs_ ## name ## _count, \
442 &sysfs_ ## name ## _average_frequency_ ## frequency_units, \
443 &sysfs_ ## name ## _average_duration_ ## duration_units, \
444 &sysfs_ ## name ## _last_duration_ ## duration_units, \
445 &sysfs_ ## name ## _max_duration_ ## duration_units, \
446 &sysfs_ ## name ## _last_ ## frequency_units,
448 #define ewma_add(ewma, val, weight) \
450 typeof(ewma) _ewma = (ewma); \
451 typeof(weight) _weight = (weight); \
453 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
456 struct bch_ratelimit {
457 /* Next time we want to do some work, in nanoseconds */
461 * Rate at which we want to do work, in units per nanosecond
462 * The units here correspond to the units passed to
463 * bch2_ratelimit_increment()
468 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
470 d->next = local_clock();
473 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
474 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
475 int bch2_ratelimit_wait_freezable_stoppable(struct bch_ratelimit *);
477 struct bch_pd_controller {
478 struct bch_ratelimit rate;
479 unsigned long last_update;
482 s64 smoothed_derivative;
484 unsigned p_term_inverse;
488 /* for exporting to sysfs (no effect on behavior) */
490 s64 last_proportional;
494 /* If true, the rate will not increase if bch2_ratelimit_delay()
495 * is not being called often enough. */
499 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
500 void bch2_pd_controller_init(struct bch_pd_controller *);
501 size_t bch2_pd_controller_print_debug(struct bch_pd_controller *, char *);
503 #define sysfs_pd_controller_attribute(name) \
504 rw_attribute(name##_rate); \
505 rw_attribute(name##_rate_bytes); \
506 rw_attribute(name##_rate_d_term); \
507 rw_attribute(name##_rate_p_term_inverse); \
508 read_attribute(name##_rate_debug)
510 #define sysfs_pd_controller_files(name) \
511 &sysfs_##name##_rate, \
512 &sysfs_##name##_rate_bytes, \
513 &sysfs_##name##_rate_d_term, \
514 &sysfs_##name##_rate_p_term_inverse, \
515 &sysfs_##name##_rate_debug
517 #define sysfs_pd_controller_show(name, var) \
519 sysfs_hprint(name##_rate, (var)->rate.rate); \
520 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
521 sysfs_print(name##_rate_d_term, (var)->d_term); \
522 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
524 if (attr == &sysfs_##name##_rate_debug) \
525 return bch2_pd_controller_print_debug(var, buf); \
528 #define sysfs_pd_controller_store(name, var) \
530 sysfs_strtoul_clamp(name##_rate, \
531 (var)->rate.rate, 1, UINT_MAX); \
532 sysfs_strtoul_clamp(name##_rate_bytes, \
533 (var)->rate.rate, 1, UINT_MAX); \
534 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
535 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
536 (var)->p_term_inverse, 1, INT_MAX); \
539 #define __DIV_SAFE(n, d, zero) \
541 typeof(n) _n = (n); \
542 typeof(d) _d = (d); \
543 _d ? _n / _d : zero; \
546 #define DIV_SAFE(n, d) __DIV_SAFE(n, d, 0)
548 #define container_of_or_null(ptr, type, member) \
550 typeof(ptr) _ptr = ptr; \
551 _ptr ? container_of(_ptr, type, member) : NULL; \
554 #define RB_INSERT(root, new, member, cmp) \
557 struct rb_node **n = &(root)->rb_node, *parent = NULL; \
563 this = container_of(*n, typeof(*(new)), member); \
564 res = cmp(new, this); \
572 rb_link_node(&(new)->member, parent, n); \
573 rb_insert_color(&(new)->member, root); \
579 #define RB_SEARCH(root, search, member, cmp) \
581 struct rb_node *n = (root)->rb_node; \
582 typeof(&(search)) this, ret = NULL; \
586 this = container_of(n, typeof(search), member); \
587 res = cmp(&(search), this); \
599 #define RB_GREATER(root, search, member, cmp) \
601 struct rb_node *n = (root)->rb_node; \
602 typeof(&(search)) this, ret = NULL; \
606 this = container_of(n, typeof(search), member); \
607 res = cmp(&(search), this); \
617 #define RB_FIRST(root, type, member) \
618 container_of_or_null(rb_first(root), type, member)
620 #define RB_LAST(root, type, member) \
621 container_of_or_null(rb_last(root), type, member)
623 #define RB_NEXT(ptr, member) \
624 container_of_or_null(rb_next(&(ptr)->member), typeof(*ptr), member)
626 #define RB_PREV(ptr, member) \
627 container_of_or_null(rb_prev(&(ptr)->member), typeof(*ptr), member)
629 /* Does linear interpolation between powers of two */
630 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
632 unsigned fract = x & ~(~0 << fract_bits);
636 x += (x * fract) >> fract_bits;
641 void bch2_bio_map(struct bio *bio, void *base);
643 static inline sector_t bdev_sectors(struct block_device *bdev)
645 return bdev->bd_inode->i_size >> 9;
648 #define closure_bio_submit(bio, cl) \
654 #define kthread_wait_freezable(cond) \
658 set_current_state(TASK_INTERRUPTIBLE); \
659 if (kthread_should_stop()) { \
670 set_current_state(TASK_RUNNING); \
674 size_t bch2_rand_range(size_t);
676 void memcpy_to_bio(struct bio *, struct bvec_iter, void *);
677 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
679 static inline void __memcpy_u64s(void *dst, const void *src,
684 asm volatile("rep ; movsq"
685 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
686 : "0" (u64s), "1" (dst), "2" (src)
697 static inline void memcpy_u64s(void *dst, const void *src,
700 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
701 dst + u64s * sizeof(u64) <= src));
703 __memcpy_u64s(dst, src, u64s);
706 static inline void __memmove_u64s_down(void *dst, const void *src,
709 __memcpy_u64s(dst, src, u64s);
712 static inline void memmove_u64s_down(void *dst, const void *src,
717 __memmove_u64s_down(dst, src, u64s);
720 static inline void __memmove_u64s_up(void *_dst, const void *_src,
723 u64 *dst = (u64 *) _dst + u64s - 1;
724 u64 *src = (u64 *) _src + u64s - 1;
728 asm volatile("std ;\n"
731 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
732 : "0" (u64s), "1" (dst), "2" (src)
740 static inline void memmove_u64s_up(void *dst, const void *src,
745 __memmove_u64s_up(dst, src, u64s);
748 static inline void memmove_u64s(void *dst, const void *src,
752 __memmove_u64s_down(dst, src, u64s);
754 __memmove_u64s_up(dst, src, u64s);
757 static inline struct bio_vec next_contig_bvec(struct bio *bio,
758 struct bvec_iter *iter)
760 struct bio_vec bv = bio_iter_iovec(bio, *iter);
762 bio_advance_iter(bio, iter, bv.bv_len);
763 #ifndef CONFIG_HIGHMEM
764 while (iter->bi_size) {
765 struct bio_vec next = bio_iter_iovec(bio, *iter);
767 if (page_address(bv.bv_page) + bv.bv_offset + bv.bv_len !=
768 page_address(next.bv_page) + next.bv_offset)
771 bv.bv_len += next.bv_len;
772 bio_advance_iter(bio, iter, next.bv_len);
778 #define __bio_for_each_contig_segment(bv, bio, iter, start) \
779 for (iter = (start); \
781 ((bv = next_contig_bvec((bio), &(iter))), 1);)
783 #define bio_for_each_contig_segment(bv, bio, iter) \
784 __bio_for_each_contig_segment(bv, bio, iter, (bio)->bi_iter)
786 size_t bch_scnmemcpy(char *, size_t, const char *, size_t);
788 void sort_cmp_size(void *base, size_t num, size_t size,
789 int (*cmp_func)(const void *, const void *, size_t),
790 void (*swap_func)(void *, void *, size_t));
792 /* just the memmove, doesn't update @_nr */
793 #define __array_insert_item(_array, _nr, _pos) \
794 memmove(&(_array)[(_pos) + 1], \
796 sizeof((_array)[0]) * ((_nr) - (_pos)))
798 #define array_insert_item(_array, _nr, _pos, _new_item) \
800 __array_insert_item(_array, _nr, _pos); \
802 (_array)[(_pos)] = (_new_item); \
805 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
807 (_nr) -= (_nr_to_remove); \
808 memmove(&(_array)[(_pos)], \
809 &(_array)[(_pos) + (_nr_to_remove)], \
810 sizeof((_array)[0]) * ((_nr) - (_pos))); \
813 #define array_remove_item(_array, _nr, _pos) \
814 array_remove_items(_array, _nr, _pos, 1)
816 #endif /* _BCACHEFS_UTIL_H */