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>
20 #include <linux/mean_and_variance.h>
26 #ifdef CONFIG_BCACHEFS_DEBUG
27 #define EBUG_ON(cond) BUG_ON(cond)
32 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
33 #define CPU_BIG_ENDIAN 0
34 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
35 #define CPU_BIG_ENDIAN 1
40 #define type_is_exact(_val, _type) \
41 __builtin_types_compatible_p(typeof(_val), _type)
43 #define type_is(_val, _type) \
44 (__builtin_types_compatible_p(typeof(_val), _type) || \
45 __builtin_types_compatible_p(typeof(_val), const _type))
47 /* Userspace doesn't align allocations as nicely as the kernel allocators: */
48 static inline size_t buf_pages(void *p, size_t len)
50 return DIV_ROUND_UP(len +
51 ((unsigned long) p & (PAGE_SIZE - 1)),
55 static inline void vpfree(void *p, size_t size)
57 if (is_vmalloc_addr(p))
60 free_pages((unsigned long) p, get_order(size));
63 static inline void *vpmalloc(size_t size, gfp_t gfp_mask)
65 return (void *) __get_free_pages(gfp_mask|__GFP_NOWARN,
67 __vmalloc(size, gfp_mask);
70 static inline void kvpfree(void *p, size_t size)
78 static inline void *kvpmalloc(size_t size, gfp_t gfp_mask)
80 return size < PAGE_SIZE
81 ? kmalloc(size, gfp_mask)
82 : vpmalloc(size, gfp_mask);
85 int mempool_init_kvpmalloc_pool(mempool_t *, int, size_t);
93 #define DECLARE_HEAP(type, name) HEAP(type) name
95 #define init_heap(heap, _size, gfp) \
98 (heap)->size = (_size); \
99 (heap)->data = kvpmalloc((heap)->size * sizeof((heap)->data[0]),\
103 #define free_heap(heap) \
105 kvpfree((heap)->data, (heap)->size * sizeof((heap)->data[0])); \
106 (heap)->data = NULL; \
109 #define heap_set_backpointer(h, i, _fn) \
111 void (*fn)(typeof(h), size_t) = _fn; \
116 #define heap_swap(h, i, j, set_backpointer) \
118 swap((h)->data[i], (h)->data[j]); \
119 heap_set_backpointer(h, i, set_backpointer); \
120 heap_set_backpointer(h, j, set_backpointer); \
123 #define heap_peek(h) \
125 EBUG_ON(!(h)->used); \
129 #define heap_full(h) ((h)->used == (h)->size)
131 #define heap_sift_down(h, i, cmp, set_backpointer) \
135 for (; _j * 2 + 1 < (h)->used; _j = _c) { \
137 if (_c + 1 < (h)->used && \
138 cmp(h, (h)->data[_c], (h)->data[_c + 1]) >= 0) \
141 if (cmp(h, (h)->data[_c], (h)->data[_j]) >= 0) \
143 heap_swap(h, _c, _j, set_backpointer); \
147 #define heap_sift_up(h, i, cmp, set_backpointer) \
150 size_t p = (i - 1) / 2; \
151 if (cmp(h, (h)->data[i], (h)->data[p]) >= 0) \
153 heap_swap(h, i, p, set_backpointer); \
158 #define __heap_add(h, d, cmp, set_backpointer) \
160 size_t _i = (h)->used++; \
162 heap_set_backpointer(h, _i, set_backpointer); \
164 heap_sift_up(h, _i, cmp, set_backpointer); \
168 #define heap_add(h, d, cmp, set_backpointer) \
170 bool _r = !heap_full(h); \
172 __heap_add(h, d, cmp, set_backpointer); \
176 #define heap_add_or_replace(h, new, cmp, set_backpointer) \
178 if (!heap_add(h, new, cmp, set_backpointer) && \
179 cmp(h, new, heap_peek(h)) >= 0) { \
180 (h)->data[0] = new; \
181 heap_set_backpointer(h, 0, set_backpointer); \
182 heap_sift_down(h, 0, cmp, set_backpointer); \
186 #define heap_del(h, i, cmp, set_backpointer) \
190 BUG_ON(_i >= (h)->used); \
192 if ((_i) < (h)->used) { \
193 heap_swap(h, _i, (h)->used, set_backpointer); \
194 heap_sift_up(h, _i, cmp, set_backpointer); \
195 heap_sift_down(h, _i, cmp, set_backpointer); \
199 #define heap_pop(h, d, cmp, set_backpointer) \
201 bool _r = (h)->used; \
203 (d) = (h)->data[0]; \
204 heap_del(h, 0, cmp, set_backpointer); \
209 #define heap_resort(heap, cmp, set_backpointer) \
212 for (_i = (ssize_t) (heap)->used / 2 - 1; _i >= 0; --_i) \
213 heap_sift_down(heap, _i, cmp, set_backpointer); \
216 #define ANYSINT_MAX(t) \
217 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
219 #include "printbuf.h"
221 #define prt_vprintf(_out, ...) bch2_prt_vprintf(_out, __VA_ARGS__)
222 #define prt_printf(_out, ...) bch2_prt_printf(_out, __VA_ARGS__)
223 #define printbuf_str(_buf) bch2_printbuf_str(_buf)
224 #define printbuf_exit(_buf) bch2_printbuf_exit(_buf)
226 #define printbuf_tabstops_reset(_buf) bch2_printbuf_tabstops_reset(_buf)
227 #define printbuf_tabstop_pop(_buf) bch2_printbuf_tabstop_pop(_buf)
228 #define printbuf_tabstop_push(_buf, _n) bch2_printbuf_tabstop_push(_buf, _n)
230 #define printbuf_indent_add(_out, _n) bch2_printbuf_indent_add(_out, _n)
231 #define printbuf_indent_sub(_out, _n) bch2_printbuf_indent_sub(_out, _n)
233 #define prt_newline(_out) bch2_prt_newline(_out)
234 #define prt_tab(_out) bch2_prt_tab(_out)
235 #define prt_tab_rjust(_out) bch2_prt_tab_rjust(_out)
237 #define prt_bytes_indented(...) bch2_prt_bytes_indented(__VA_ARGS__)
238 #define prt_u64(_out, _v) prt_printf(_out, "%llu", _v)
239 #define prt_human_readable_u64(...) bch2_prt_human_readable_u64(__VA_ARGS__)
240 #define prt_human_readable_s64(...) bch2_prt_human_readable_s64(__VA_ARGS__)
241 #define prt_units_u64(...) bch2_prt_units_u64(__VA_ARGS__)
242 #define prt_units_s64(...) bch2_prt_units_s64(__VA_ARGS__)
243 #define prt_string_option(...) bch2_prt_string_option(__VA_ARGS__)
244 #define prt_bitflags(...) bch2_prt_bitflags(__VA_ARGS__)
246 void bch2_pr_time_units(struct printbuf *, u64);
249 static inline void pr_time(struct printbuf *out, u64 time)
251 prt_printf(out, "%llu", time);
255 static inline void pr_time(struct printbuf *out, u64 _time)
259 struct tm *tm = localtime(&time);
260 size_t err = strftime(time_str, sizeof(time_str), "%c", tm);
262 prt_printf(out, "(formatting error)");
264 prt_printf(out, "%s", time_str);
269 static inline void uuid_unparse_lower(u8 *uuid, char *out)
271 sprintf(out, "%pUb", uuid);
274 #include <uuid/uuid.h>
277 static inline void pr_uuid(struct printbuf *out, u8 *uuid)
281 uuid_unparse_lower(uuid, uuid_str);
282 prt_printf(out, "%s", uuid_str);
285 int bch2_strtoint_h(const char *, int *);
286 int bch2_strtouint_h(const char *, unsigned int *);
287 int bch2_strtoll_h(const char *, long long *);
288 int bch2_strtoull_h(const char *, unsigned long long *);
289 int bch2_strtou64_h(const char *, u64 *);
291 static inline int bch2_strtol_h(const char *cp, long *res)
293 #if BITS_PER_LONG == 32
294 return bch2_strtoint_h(cp, (int *) res);
296 return bch2_strtoll_h(cp, (long long *) res);
300 static inline int bch2_strtoul_h(const char *cp, long *res)
302 #if BITS_PER_LONG == 32
303 return bch2_strtouint_h(cp, (unsigned int *) res);
305 return bch2_strtoull_h(cp, (unsigned long long *) res);
309 #define strtoi_h(cp, res) \
310 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
311 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
312 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
313 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
314 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
315 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
318 #define strtoul_safe(cp, var) \
321 int _r = kstrtoul(cp, 10, &_v); \
327 #define strtoul_safe_clamp(cp, var, min, max) \
330 int _r = kstrtoul(cp, 10, &_v); \
332 var = clamp_t(typeof(var), _v, min, max); \
336 #define strtoul_safe_restrict(cp, var, min, max) \
339 int _r = kstrtoul(cp, 10, &_v); \
340 if (!_r && _v >= min && _v <= max) \
347 #define snprint(out, var) \
349 type_is(var, int) ? "%i\n" \
350 : type_is(var, unsigned) ? "%u\n" \
351 : type_is(var, long) ? "%li\n" \
352 : type_is(var, unsigned long) ? "%lu\n" \
353 : type_is(var, s64) ? "%lli\n" \
354 : type_is(var, u64) ? "%llu\n" \
355 : type_is(var, char *) ? "%s\n" \
358 bool bch2_is_zero(const void *, size_t);
360 u64 bch2_read_flag_list(char *, const char * const[]);
362 void bch2_prt_u64_binary(struct printbuf *, u64, unsigned);
364 void bch2_print_string_as_lines(const char *prefix, const char *lines);
366 typedef DARRAY(unsigned long) bch_stacktrace;
367 int bch2_save_backtrace(bch_stacktrace *stack, struct task_struct *);
368 void bch2_prt_backtrace(struct printbuf *, bch_stacktrace *);
369 int bch2_prt_task_backtrace(struct printbuf *, struct task_struct *);
371 #define NR_QUANTILES 15
372 #define QUANTILE_IDX(i) inorder_to_eytzinger0(i, NR_QUANTILES)
373 #define QUANTILE_FIRST eytzinger0_first(NR_QUANTILES)
374 #define QUANTILE_LAST eytzinger0_last(NR_QUANTILES)
376 struct bch2_quantiles {
377 struct bch2_quantile_entry {
380 } entries[NR_QUANTILES];
383 struct bch2_time_stat_buffer {
385 struct bch2_time_stat_buffer_entry {
391 struct bch2_time_stats {
393 /* all fields are in nanoseconds */
399 struct bch2_quantiles quantiles;
401 struct mean_and_variance duration_stats;
402 struct mean_and_variance_weighted duration_stats_weighted;
403 struct mean_and_variance freq_stats;
404 struct mean_and_variance_weighted freq_stats_weighted;
405 struct bch2_time_stat_buffer __percpu *buffer;
408 #ifndef CONFIG_BCACHEFS_NO_LATENCY_ACCT
409 void __bch2_time_stats_update(struct bch2_time_stats *stats, u64, u64);
411 static inline void __bch2_time_stats_update(struct bch2_time_stats *stats, u64 start, u64 end) {}
414 static inline void bch2_time_stats_update(struct bch2_time_stats *stats, u64 start)
416 __bch2_time_stats_update(stats, start, local_clock());
419 void bch2_time_stats_to_text(struct printbuf *, struct bch2_time_stats *);
421 void bch2_time_stats_exit(struct bch2_time_stats *);
422 void bch2_time_stats_init(struct bch2_time_stats *);
424 #define ewma_add(ewma, val, weight) \
426 typeof(ewma) _ewma = (ewma); \
427 typeof(weight) _weight = (weight); \
429 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
432 struct bch_ratelimit {
433 /* Next time we want to do some work, in nanoseconds */
437 * Rate at which we want to do work, in units per nanosecond
438 * The units here correspond to the units passed to
439 * bch2_ratelimit_increment()
444 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
446 d->next = local_clock();
449 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
450 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
452 struct bch_pd_controller {
453 struct bch_ratelimit rate;
454 unsigned long last_update;
457 s64 smoothed_derivative;
459 unsigned p_term_inverse;
463 /* for exporting to sysfs (no effect on behavior) */
465 s64 last_proportional;
469 /* If true, the rate will not increase if bch2_ratelimit_delay()
470 * is not being called often enough. */
474 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
475 void bch2_pd_controller_init(struct bch_pd_controller *);
476 void bch2_pd_controller_debug_to_text(struct printbuf *, struct bch_pd_controller *);
478 #define sysfs_pd_controller_attribute(name) \
479 rw_attribute(name##_rate); \
480 rw_attribute(name##_rate_bytes); \
481 rw_attribute(name##_rate_d_term); \
482 rw_attribute(name##_rate_p_term_inverse); \
483 read_attribute(name##_rate_debug)
485 #define sysfs_pd_controller_files(name) \
486 &sysfs_##name##_rate, \
487 &sysfs_##name##_rate_bytes, \
488 &sysfs_##name##_rate_d_term, \
489 &sysfs_##name##_rate_p_term_inverse, \
490 &sysfs_##name##_rate_debug
492 #define sysfs_pd_controller_show(name, var) \
494 sysfs_hprint(name##_rate, (var)->rate.rate); \
495 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
496 sysfs_print(name##_rate_d_term, (var)->d_term); \
497 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
499 if (attr == &sysfs_##name##_rate_debug) \
500 bch2_pd_controller_debug_to_text(out, var); \
503 #define sysfs_pd_controller_store(name, var) \
505 sysfs_strtoul_clamp(name##_rate, \
506 (var)->rate.rate, 1, UINT_MAX); \
507 sysfs_strtoul_clamp(name##_rate_bytes, \
508 (var)->rate.rate, 1, UINT_MAX); \
509 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
510 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
511 (var)->p_term_inverse, 1, INT_MAX); \
514 #define container_of_or_null(ptr, type, member) \
516 typeof(ptr) _ptr = ptr; \
517 _ptr ? container_of(_ptr, type, member) : NULL; \
520 /* Does linear interpolation between powers of two */
521 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
523 unsigned fract = x & ~(~0 << fract_bits);
527 x += (x * fract) >> fract_bits;
532 void bch2_bio_map(struct bio *bio, void *base, size_t);
533 int bch2_bio_alloc_pages(struct bio *, size_t, gfp_t);
535 static inline sector_t bdev_sectors(struct block_device *bdev)
537 return bdev->bd_inode->i_size >> 9;
540 #define closure_bio_submit(bio, cl) \
546 #define kthread_wait_freezable(cond) \
550 set_current_state(TASK_INTERRUPTIBLE); \
551 if (kthread_should_stop()) { \
562 set_current_state(TASK_RUNNING); \
566 size_t bch2_rand_range(size_t);
568 void memcpy_to_bio(struct bio *, struct bvec_iter, const void *);
569 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
571 static inline void memcpy_u64s_small(void *dst, const void *src,
581 static inline void __memcpy_u64s(void *dst, const void *src,
586 asm volatile("rep ; movsq"
587 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
588 : "0" (u64s), "1" (dst), "2" (src)
599 static inline void memcpy_u64s(void *dst, const void *src,
602 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
603 dst + u64s * sizeof(u64) <= src));
605 __memcpy_u64s(dst, src, u64s);
608 static inline void __memmove_u64s_down(void *dst, const void *src,
611 __memcpy_u64s(dst, src, u64s);
614 static inline void memmove_u64s_down(void *dst, const void *src,
619 __memmove_u64s_down(dst, src, u64s);
622 static inline void __memmove_u64s_down_small(void *dst, const void *src,
625 memcpy_u64s_small(dst, src, u64s);
628 static inline void memmove_u64s_down_small(void *dst, const void *src,
633 __memmove_u64s_down_small(dst, src, u64s);
636 static inline void __memmove_u64s_up_small(void *_dst, const void *_src,
639 u64 *dst = (u64 *) _dst + u64s;
640 u64 *src = (u64 *) _src + u64s;
646 static inline void memmove_u64s_up_small(void *dst, const void *src,
651 __memmove_u64s_up_small(dst, src, u64s);
654 static inline void __memmove_u64s_up(void *_dst, const void *_src,
657 u64 *dst = (u64 *) _dst + u64s - 1;
658 u64 *src = (u64 *) _src + u64s - 1;
662 asm volatile("std ;\n"
665 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
666 : "0" (u64s), "1" (dst), "2" (src)
674 static inline void memmove_u64s_up(void *dst, const void *src,
679 __memmove_u64s_up(dst, src, u64s);
682 static inline void memmove_u64s(void *dst, const void *src,
686 __memmove_u64s_down(dst, src, u64s);
688 __memmove_u64s_up(dst, src, u64s);
691 /* Set the last few bytes up to a u64 boundary given an offset into a buffer. */
692 static inline void memset_u64s_tail(void *s, int c, unsigned bytes)
694 unsigned rem = round_up(bytes, sizeof(u64)) - bytes;
696 memset(s + bytes, c, rem);
699 void sort_cmp_size(void *base, size_t num, size_t size,
700 int (*cmp_func)(const void *, const void *, size_t),
701 void (*swap_func)(void *, void *, size_t));
703 /* just the memmove, doesn't update @_nr */
704 #define __array_insert_item(_array, _nr, _pos) \
705 memmove(&(_array)[(_pos) + 1], \
707 sizeof((_array)[0]) * ((_nr) - (_pos)))
709 #define array_insert_item(_array, _nr, _pos, _new_item) \
711 __array_insert_item(_array, _nr, _pos); \
713 (_array)[(_pos)] = (_new_item); \
716 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
718 (_nr) -= (_nr_to_remove); \
719 memmove(&(_array)[(_pos)], \
720 &(_array)[(_pos) + (_nr_to_remove)], \
721 sizeof((_array)[0]) * ((_nr) - (_pos))); \
724 #define array_remove_item(_array, _nr, _pos) \
725 array_remove_items(_array, _nr, _pos, 1)
727 static inline void __move_gap(void *array, size_t element_size,
728 size_t nr, size_t size,
729 size_t old_gap, size_t new_gap)
731 size_t gap_end = old_gap + size - nr;
733 if (new_gap < old_gap) {
734 size_t move = old_gap - new_gap;
736 memmove(array + element_size * (gap_end - move),
737 array + element_size * (old_gap - move),
738 element_size * move);
739 } else if (new_gap > old_gap) {
740 size_t move = new_gap - old_gap;
742 memmove(array + element_size * old_gap,
743 array + element_size * gap_end,
744 element_size * move);
748 /* Move the gap in a gap buffer: */
749 #define move_gap(_array, _nr, _size, _old_gap, _new_gap) \
750 __move_gap(_array, sizeof(_array[0]), _nr, _size, _old_gap, _new_gap)
752 #define bubble_sort(_base, _nr, _cmp) \
755 bool _swapped = true; \
757 for (_end = (ssize_t) (_nr) - 1; _end > 0 && _swapped; --_end) {\
759 for (_i = 0; _i < _end; _i++) \
760 if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) { \
761 swap((_base)[_i], (_base)[_i + 1]); \
767 static inline u64 percpu_u64_get(u64 __percpu *src)
772 for_each_possible_cpu(cpu)
773 ret += *per_cpu_ptr(src, cpu);
777 static inline void percpu_u64_set(u64 __percpu *dst, u64 src)
781 for_each_possible_cpu(cpu)
782 *per_cpu_ptr(dst, cpu) = 0;
783 this_cpu_write(*dst, src);
786 static inline void acc_u64s(u64 *acc, const u64 *src, unsigned nr)
790 for (i = 0; i < nr; i++)
794 static inline void acc_u64s_percpu(u64 *acc, const u64 __percpu *src,
799 for_each_possible_cpu(cpu)
800 acc_u64s(acc, per_cpu_ptr(src, cpu), nr);
803 static inline void percpu_memset(void __percpu *p, int c, size_t bytes)
807 for_each_possible_cpu(cpu)
808 memset(per_cpu_ptr(p, cpu), c, bytes);
811 u64 *bch2_acc_percpu_u64s(u64 __percpu *, unsigned);
813 #define cmp_int(l, r) ((l > r) - (l < r))
815 static inline int u8_cmp(u8 l, u8 r)
817 return cmp_int(l, r);
820 #endif /* _BCACHEFS_UTIL_H */