1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_UTIL_H
3 #define _BCACHEFS_UTIL_H
6 #include <linux/blkdev.h>
7 #include <linux/closure.h>
8 #include <linux/errno.h>
9 #include <linux/freezer.h>
10 #include <linux/kernel.h>
11 #include <linux/sched/clock.h>
12 #include <linux/llist.h>
13 #include <linux/log2.h>
14 #include <linux/percpu.h>
15 #include <linux/preempt.h>
16 #include <linux/ratelimit.h>
17 #include <linux/slab.h>
18 #include <linux/vmalloc.h>
19 #include <linux/workqueue.h>
21 #define PAGE_SECTOR_SHIFT (PAGE_SHIFT - 9)
22 #define PAGE_SECTORS (1UL << PAGE_SECTOR_SHIFT)
26 #ifdef CONFIG_BCACHEFS_DEBUG
28 #define EBUG_ON(cond) BUG_ON(cond)
29 #define atomic_dec_bug(v) BUG_ON(atomic_dec_return(v) < 0)
30 #define atomic_inc_bug(v, i) BUG_ON(atomic_inc_return(v) <= i)
31 #define atomic_sub_bug(i, v) BUG_ON(atomic_sub_return(i, v) < 0)
32 #define atomic_add_bug(i, v) BUG_ON(atomic_add_return(i, v) < 0)
33 #define atomic_long_dec_bug(v) BUG_ON(atomic_long_dec_return(v) < 0)
34 #define atomic_long_sub_bug(i, v) BUG_ON(atomic_long_sub_return(i, v) < 0)
35 #define atomic64_dec_bug(v) BUG_ON(atomic64_dec_return(v) < 0)
36 #define atomic64_inc_bug(v, i) BUG_ON(atomic64_inc_return(v) <= i)
37 #define atomic64_sub_bug(i, v) BUG_ON(atomic64_sub_return(i, v) < 0)
38 #define atomic64_add_bug(i, v) BUG_ON(atomic64_add_return(i, v) < 0)
43 #define atomic_dec_bug(v) atomic_dec(v)
44 #define atomic_inc_bug(v, i) atomic_inc(v)
45 #define atomic_sub_bug(i, v) atomic_sub(i, v)
46 #define atomic_add_bug(i, v) atomic_add(i, v)
47 #define atomic_long_dec_bug(v) atomic_long_dec(v)
48 #define atomic_long_sub_bug(i, v) atomic_long_sub(i, v)
49 #define atomic64_dec_bug(v) atomic64_dec(v)
50 #define atomic64_inc_bug(v, i) atomic64_inc(v)
51 #define atomic64_sub_bug(i, v) atomic64_sub(i, v)
52 #define atomic64_add_bug(i, v) atomic64_add(i, v)
56 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
57 #define CPU_BIG_ENDIAN 0
58 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
59 #define CPU_BIG_ENDIAN 1
64 #define type_is_exact(_val, _type) \
65 __builtin_types_compatible_p(typeof(_val), _type)
67 #define type_is(_val, _type) \
68 (__builtin_types_compatible_p(typeof(_val), _type) || \
69 __builtin_types_compatible_p(typeof(_val), const _type))
71 /* Userspace doesn't align allocations as nicely as the kernel allocators: */
72 static inline size_t buf_pages(void *p, size_t len)
74 return DIV_ROUND_UP(len +
75 ((unsigned long) p & (PAGE_SIZE - 1)),
79 static inline void vpfree(void *p, size_t size)
81 if (is_vmalloc_addr(p))
84 free_pages((unsigned long) p, get_order(size));
87 static inline void *vpmalloc(size_t size, gfp_t gfp_mask)
89 return (void *) __get_free_pages(gfp_mask|__GFP_NOWARN,
91 __vmalloc(size, gfp_mask);
94 static inline void kvpfree(void *p, size_t size)
102 static inline void *kvpmalloc(size_t size, gfp_t gfp_mask)
104 return size < PAGE_SIZE
105 ? kmalloc(size, gfp_mask)
106 : vpmalloc(size, gfp_mask);
109 int mempool_init_kvpmalloc_pool(mempool_t *, int, size_t);
117 #define DECLARE_HEAP(type, name) HEAP(type) name
119 #define init_heap(heap, _size, gfp) \
122 (heap)->size = (_size); \
123 (heap)->data = kvpmalloc((heap)->size * sizeof((heap)->data[0]),\
127 #define free_heap(heap) \
129 kvpfree((heap)->data, (heap)->size * sizeof((heap)->data[0])); \
130 (heap)->data = NULL; \
133 #define heap_set_backpointer(h, i, _fn) \
135 void (*fn)(typeof(h), size_t) = _fn; \
140 #define heap_swap(h, i, j, set_backpointer) \
142 swap((h)->data[i], (h)->data[j]); \
143 heap_set_backpointer(h, i, set_backpointer); \
144 heap_set_backpointer(h, j, set_backpointer); \
147 #define heap_peek(h) \
149 EBUG_ON(!(h)->used); \
153 #define heap_full(h) ((h)->used == (h)->size)
155 #define heap_sift_down(h, i, cmp, set_backpointer) \
159 for (; _j * 2 + 1 < (h)->used; _j = _c) { \
161 if (_c + 1 < (h)->used && \
162 cmp(h, (h)->data[_c], (h)->data[_c + 1]) >= 0) \
165 if (cmp(h, (h)->data[_c], (h)->data[_j]) >= 0) \
167 heap_swap(h, _c, _j, set_backpointer); \
171 #define heap_sift_up(h, i, cmp, set_backpointer) \
174 size_t p = (i - 1) / 2; \
175 if (cmp(h, (h)->data[i], (h)->data[p]) >= 0) \
177 heap_swap(h, i, p, set_backpointer); \
182 #define __heap_add(h, d, cmp, set_backpointer) \
184 size_t _i = (h)->used++; \
186 heap_set_backpointer(h, _i, set_backpointer); \
188 heap_sift_up(h, _i, cmp, set_backpointer); \
192 #define heap_add(h, d, cmp, set_backpointer) \
194 bool _r = !heap_full(h); \
196 __heap_add(h, d, cmp, set_backpointer); \
200 #define heap_add_or_replace(h, new, cmp, set_backpointer) \
202 if (!heap_add(h, new, cmp, set_backpointer) && \
203 cmp(h, new, heap_peek(h)) >= 0) { \
204 (h)->data[0] = new; \
205 heap_set_backpointer(h, 0, set_backpointer); \
206 heap_sift_down(h, 0, cmp, set_backpointer); \
210 #define heap_del(h, i, cmp, set_backpointer) \
214 BUG_ON(_i >= (h)->used); \
216 heap_swap(h, _i, (h)->used, set_backpointer); \
217 heap_sift_up(h, _i, cmp, set_backpointer); \
218 heap_sift_down(h, _i, cmp, set_backpointer); \
221 #define heap_pop(h, d, cmp, set_backpointer) \
223 bool _r = (h)->used; \
225 (d) = (h)->data[0]; \
226 heap_del(h, 0, cmp, set_backpointer); \
231 #define heap_resort(heap, cmp, set_backpointer) \
234 for (_i = (ssize_t) (heap)->used / 2 - 1; _i >= 0; --_i) \
235 heap_sift_down(heap, _i, cmp, set_backpointer); \
238 #define ANYSINT_MAX(t) \
239 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
246 static inline size_t printbuf_remaining(struct printbuf *buf)
248 return buf->end - buf->pos;
251 #define _PBUF(_buf, _len) \
252 ((struct printbuf) { \
254 .end = _buf + _len, \
257 #define PBUF(_buf) _PBUF(_buf, sizeof(_buf))
259 #define pr_buf(_out, ...) \
261 (_out)->pos += scnprintf((_out)->pos, printbuf_remaining(_out), \
265 void bch_scnmemcpy(struct printbuf *, const char *, size_t);
267 int bch2_strtoint_h(const char *, int *);
268 int bch2_strtouint_h(const char *, unsigned int *);
269 int bch2_strtoll_h(const char *, long long *);
270 int bch2_strtoull_h(const char *, unsigned long long *);
271 int bch2_strtou64_h(const char *, u64 *);
273 static inline int bch2_strtol_h(const char *cp, long *res)
275 #if BITS_PER_LONG == 32
276 return bch2_strtoint_h(cp, (int *) res);
278 return bch2_strtoll_h(cp, (long long *) res);
282 static inline int bch2_strtoul_h(const char *cp, long *res)
284 #if BITS_PER_LONG == 32
285 return bch2_strtouint_h(cp, (unsigned int *) res);
287 return bch2_strtoull_h(cp, (unsigned long long *) res);
291 #define strtoi_h(cp, res) \
292 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
293 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
294 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
295 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
296 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
297 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
300 #define strtoul_safe(cp, var) \
303 int _r = kstrtoul(cp, 10, &_v); \
309 #define strtoul_safe_clamp(cp, var, min, max) \
312 int _r = kstrtoul(cp, 10, &_v); \
314 var = clamp_t(typeof(var), _v, min, max); \
318 #define strtoul_safe_restrict(cp, var, min, max) \
321 int _r = kstrtoul(cp, 10, &_v); \
322 if (!_r && _v >= min && _v <= max) \
329 #define snprint(buf, size, var) \
330 snprintf(buf, size, \
331 type_is(var, int) ? "%i\n" \
332 : type_is(var, unsigned) ? "%u\n" \
333 : type_is(var, long) ? "%li\n" \
334 : type_is(var, unsigned long) ? "%lu\n" \
335 : type_is(var, s64) ? "%lli\n" \
336 : type_is(var, u64) ? "%llu\n" \
337 : type_is(var, char *) ? "%s\n" \
340 void bch2_hprint(struct printbuf *, s64);
342 bool bch2_is_zero(const void *, size_t);
344 void bch2_string_opt_to_text(struct printbuf *,
345 const char * const [], size_t);
347 void bch2_flags_to_text(struct printbuf *, const char * const[], u64);
348 u64 bch2_read_flag_list(char *, const char * const[]);
350 #define NR_QUANTILES 15
351 #define QUANTILE_IDX(i) inorder_to_eytzinger0(i, NR_QUANTILES)
352 #define QUANTILE_FIRST eytzinger0_first(NR_QUANTILES)
353 #define QUANTILE_LAST eytzinger0_last(NR_QUANTILES)
356 struct quantile_entry {
359 } entries[NR_QUANTILES];
362 struct time_stat_buffer {
364 struct time_stat_buffer_entry {
373 /* all fields are in nanoseconds */
374 u64 average_duration;
375 u64 average_frequency;
378 struct quantiles quantiles;
380 struct time_stat_buffer __percpu *buffer;
383 void __bch2_time_stats_update(struct time_stats *stats, u64, u64);
385 static inline void bch2_time_stats_update(struct time_stats *stats, u64 start)
387 __bch2_time_stats_update(stats, start, local_clock());
390 void bch2_time_stats_to_text(struct printbuf *, struct time_stats *);
392 void bch2_time_stats_exit(struct time_stats *);
393 void bch2_time_stats_init(struct time_stats *);
395 #define ewma_add(ewma, val, weight) \
397 typeof(ewma) _ewma = (ewma); \
398 typeof(weight) _weight = (weight); \
400 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
403 struct bch_ratelimit {
404 /* Next time we want to do some work, in nanoseconds */
408 * Rate at which we want to do work, in units per nanosecond
409 * The units here correspond to the units passed to
410 * bch2_ratelimit_increment()
415 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
417 d->next = local_clock();
420 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
421 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
423 struct bch_pd_controller {
424 struct bch_ratelimit rate;
425 unsigned long last_update;
428 s64 smoothed_derivative;
430 unsigned p_term_inverse;
434 /* for exporting to sysfs (no effect on behavior) */
436 s64 last_proportional;
440 /* If true, the rate will not increase if bch2_ratelimit_delay()
441 * is not being called often enough. */
445 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
446 void bch2_pd_controller_init(struct bch_pd_controller *);
447 size_t bch2_pd_controller_print_debug(struct bch_pd_controller *, char *);
449 #define sysfs_pd_controller_attribute(name) \
450 rw_attribute(name##_rate); \
451 rw_attribute(name##_rate_bytes); \
452 rw_attribute(name##_rate_d_term); \
453 rw_attribute(name##_rate_p_term_inverse); \
454 read_attribute(name##_rate_debug)
456 #define sysfs_pd_controller_files(name) \
457 &sysfs_##name##_rate, \
458 &sysfs_##name##_rate_bytes, \
459 &sysfs_##name##_rate_d_term, \
460 &sysfs_##name##_rate_p_term_inverse, \
461 &sysfs_##name##_rate_debug
463 #define sysfs_pd_controller_show(name, var) \
465 sysfs_hprint(name##_rate, (var)->rate.rate); \
466 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
467 sysfs_print(name##_rate_d_term, (var)->d_term); \
468 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
470 if (attr == &sysfs_##name##_rate_debug) \
471 return bch2_pd_controller_print_debug(var, buf); \
474 #define sysfs_pd_controller_store(name, var) \
476 sysfs_strtoul_clamp(name##_rate, \
477 (var)->rate.rate, 1, UINT_MAX); \
478 sysfs_strtoul_clamp(name##_rate_bytes, \
479 (var)->rate.rate, 1, UINT_MAX); \
480 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
481 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
482 (var)->p_term_inverse, 1, INT_MAX); \
485 #define container_of_or_null(ptr, type, member) \
487 typeof(ptr) _ptr = ptr; \
488 _ptr ? container_of(_ptr, type, member) : NULL; \
491 /* Does linear interpolation between powers of two */
492 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
494 unsigned fract = x & ~(~0 << fract_bits);
498 x += (x * fract) >> fract_bits;
503 void bch2_bio_map(struct bio *bio, void *base, size_t);
504 int bch2_bio_alloc_pages(struct bio *, size_t, gfp_t);
506 static inline sector_t bdev_sectors(struct block_device *bdev)
508 return bdev->bd_inode->i_size >> 9;
511 #define closure_bio_submit(bio, cl) \
517 #define kthread_wait_freezable(cond) \
521 set_current_state(TASK_INTERRUPTIBLE); \
522 if (kthread_should_stop()) { \
533 set_current_state(TASK_RUNNING); \
537 size_t bch2_rand_range(size_t);
539 void memcpy_to_bio(struct bio *, struct bvec_iter, const void *);
540 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
542 static inline void memcpy_u64s_small(void *dst, const void *src,
552 static inline void __memcpy_u64s(void *dst, const void *src,
557 asm volatile("rep ; movsq"
558 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
559 : "0" (u64s), "1" (dst), "2" (src)
570 static inline void memcpy_u64s(void *dst, const void *src,
573 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
574 dst + u64s * sizeof(u64) <= src));
576 __memcpy_u64s(dst, src, u64s);
579 static inline void __memmove_u64s_down(void *dst, const void *src,
582 __memcpy_u64s(dst, src, u64s);
585 static inline void memmove_u64s_down(void *dst, const void *src,
590 __memmove_u64s_down(dst, src, u64s);
593 static inline void __memmove_u64s_up_small(void *_dst, const void *_src,
596 u64 *dst = (u64 *) _dst + u64s;
597 u64 *src = (u64 *) _src + u64s;
603 static inline void memmove_u64s_up_small(void *dst, const void *src,
608 __memmove_u64s_up_small(dst, src, u64s);
611 static inline void __memmove_u64s_up(void *_dst, const void *_src,
614 u64 *dst = (u64 *) _dst + u64s - 1;
615 u64 *src = (u64 *) _src + u64s - 1;
619 asm volatile("std ;\n"
622 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
623 : "0" (u64s), "1" (dst), "2" (src)
631 static inline void memmove_u64s_up(void *dst, const void *src,
636 __memmove_u64s_up(dst, src, u64s);
639 static inline void memmove_u64s(void *dst, const void *src,
643 __memmove_u64s_down(dst, src, u64s);
645 __memmove_u64s_up(dst, src, u64s);
648 /* Set the last few bytes up to a u64 boundary given an offset into a buffer. */
649 static inline void memset_u64s_tail(void *s, int c, unsigned bytes)
651 unsigned rem = round_up(bytes, sizeof(u64)) - bytes;
653 memset(s + bytes, c, rem);
656 void sort_cmp_size(void *base, size_t num, size_t size,
657 int (*cmp_func)(const void *, const void *, size_t),
658 void (*swap_func)(void *, void *, size_t));
660 /* just the memmove, doesn't update @_nr */
661 #define __array_insert_item(_array, _nr, _pos) \
662 memmove(&(_array)[(_pos) + 1], \
664 sizeof((_array)[0]) * ((_nr) - (_pos)))
666 #define array_insert_item(_array, _nr, _pos, _new_item) \
668 __array_insert_item(_array, _nr, _pos); \
670 (_array)[(_pos)] = (_new_item); \
673 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
675 (_nr) -= (_nr_to_remove); \
676 memmove(&(_array)[(_pos)], \
677 &(_array)[(_pos) + (_nr_to_remove)], \
678 sizeof((_array)[0]) * ((_nr) - (_pos))); \
681 #define array_remove_item(_array, _nr, _pos) \
682 array_remove_items(_array, _nr, _pos, 1)
684 #define bubble_sort(_base, _nr, _cmp) \
687 bool _swapped = true; \
689 for (_end = (ssize_t) (_nr) - 1; _end > 0 && _swapped; --_end) {\
691 for (_i = 0; _i < _end; _i++) \
692 if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) { \
693 swap((_base)[_i], (_base)[_i + 1]); \
699 static inline u64 percpu_u64_get(u64 __percpu *src)
704 for_each_possible_cpu(cpu)
705 ret += *per_cpu_ptr(src, cpu);
709 static inline void percpu_u64_set(u64 __percpu *dst, u64 src)
713 for_each_possible_cpu(cpu)
714 *per_cpu_ptr(dst, cpu) = 0;
717 *this_cpu_ptr(dst) = src;
721 static inline void acc_u64s(u64 *acc, const u64 *src, unsigned nr)
725 for (i = 0; i < nr; i++)
729 static inline void acc_u64s_percpu(u64 *acc, const u64 __percpu *src,
734 for_each_possible_cpu(cpu)
735 acc_u64s(acc, per_cpu_ptr(src, cpu), nr);
738 static inline void percpu_memset(void __percpu *p, int c, size_t bytes)
742 for_each_possible_cpu(cpu)
743 memset(per_cpu_ptr(p, cpu), c, bytes);
746 u64 *bch2_acc_percpu_u64s(u64 __percpu *, unsigned);
748 #define cmp_int(l, r) ((l > r) - (l < r))
750 #endif /* _BCACHEFS_UTIL_H */