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", (u64) (_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);
247 void bch2_prt_datetime(struct printbuf *, time64_t);
250 static inline void uuid_unparse_lower(u8 *uuid, char *out)
252 sprintf(out, "%pUb", uuid);
255 #include <uuid/uuid.h>
258 static inline void pr_uuid(struct printbuf *out, u8 *uuid)
262 uuid_unparse_lower(uuid, uuid_str);
263 prt_printf(out, "%s", uuid_str);
266 int bch2_strtoint_h(const char *, int *);
267 int bch2_strtouint_h(const char *, unsigned int *);
268 int bch2_strtoll_h(const char *, long long *);
269 int bch2_strtoull_h(const char *, unsigned long long *);
270 int bch2_strtou64_h(const char *, u64 *);
272 static inline int bch2_strtol_h(const char *cp, long *res)
274 #if BITS_PER_LONG == 32
275 return bch2_strtoint_h(cp, (int *) res);
277 return bch2_strtoll_h(cp, (long long *) res);
281 static inline int bch2_strtoul_h(const char *cp, long *res)
283 #if BITS_PER_LONG == 32
284 return bch2_strtouint_h(cp, (unsigned int *) res);
286 return bch2_strtoull_h(cp, (unsigned long long *) res);
290 #define strtoi_h(cp, res) \
291 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
292 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
293 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
294 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
295 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
296 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
299 #define strtoul_safe(cp, var) \
302 int _r = kstrtoul(cp, 10, &_v); \
308 #define strtoul_safe_clamp(cp, var, min, max) \
311 int _r = kstrtoul(cp, 10, &_v); \
313 var = clamp_t(typeof(var), _v, min, max); \
317 #define strtoul_safe_restrict(cp, var, min, max) \
320 int _r = kstrtoul(cp, 10, &_v); \
321 if (!_r && _v >= min && _v <= max) \
328 #define snprint(out, var) \
330 type_is(var, int) ? "%i\n" \
331 : type_is(var, unsigned) ? "%u\n" \
332 : type_is(var, long) ? "%li\n" \
333 : type_is(var, unsigned long) ? "%lu\n" \
334 : type_is(var, s64) ? "%lli\n" \
335 : type_is(var, u64) ? "%llu\n" \
336 : type_is(var, char *) ? "%s\n" \
339 bool bch2_is_zero(const void *, size_t);
341 u64 bch2_read_flag_list(char *, const char * const[]);
343 void bch2_prt_u64_binary(struct printbuf *, u64, unsigned);
345 void bch2_print_string_as_lines(const char *prefix, const char *lines);
347 typedef DARRAY(unsigned long) bch_stacktrace;
348 int bch2_save_backtrace(bch_stacktrace *stack, struct task_struct *);
349 void bch2_prt_backtrace(struct printbuf *, bch_stacktrace *);
350 int bch2_prt_task_backtrace(struct printbuf *, struct task_struct *);
352 #define NR_QUANTILES 15
353 #define QUANTILE_IDX(i) inorder_to_eytzinger0(i, NR_QUANTILES)
354 #define QUANTILE_FIRST eytzinger0_first(NR_QUANTILES)
355 #define QUANTILE_LAST eytzinger0_last(NR_QUANTILES)
357 struct bch2_quantiles {
358 struct bch2_quantile_entry {
361 } entries[NR_QUANTILES];
364 struct bch2_time_stat_buffer {
366 struct bch2_time_stat_buffer_entry {
372 struct bch2_time_stats {
374 /* all fields are in nanoseconds */
381 struct bch2_quantiles quantiles;
383 struct mean_and_variance duration_stats;
384 struct mean_and_variance_weighted duration_stats_weighted;
385 struct mean_and_variance freq_stats;
386 struct mean_and_variance_weighted freq_stats_weighted;
387 struct bch2_time_stat_buffer __percpu *buffer;
390 #ifndef CONFIG_BCACHEFS_NO_LATENCY_ACCT
391 void __bch2_time_stats_update(struct bch2_time_stats *stats, u64, u64);
393 static inline void bch2_time_stats_update(struct bch2_time_stats *stats, u64 start)
395 __bch2_time_stats_update(stats, start, local_clock());
398 static inline bool track_event_change(struct bch2_time_stats *stats,
403 bch2_time_stats_update(stats, *start);
406 *start = local_clock() ?: 1;
414 static inline void __bch2_time_stats_update(struct bch2_time_stats *stats, u64 start, u64 end) {}
415 static inline void bch2_time_stats_update(struct bch2_time_stats *stats, u64 start) {}
416 static inline bool track_event_change(struct bch2_time_stats *stats,
419 bool ret = v && !*start;
425 void bch2_time_stats_to_text(struct printbuf *, struct bch2_time_stats *);
427 void bch2_time_stats_exit(struct bch2_time_stats *);
428 void bch2_time_stats_init(struct bch2_time_stats *);
430 #define ewma_add(ewma, val, weight) \
432 typeof(ewma) _ewma = (ewma); \
433 typeof(weight) _weight = (weight); \
435 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
438 struct bch_ratelimit {
439 /* Next time we want to do some work, in nanoseconds */
443 * Rate at which we want to do work, in units per nanosecond
444 * The units here correspond to the units passed to
445 * bch2_ratelimit_increment()
450 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
452 d->next = local_clock();
455 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
456 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
458 struct bch_pd_controller {
459 struct bch_ratelimit rate;
460 unsigned long last_update;
463 s64 smoothed_derivative;
465 unsigned p_term_inverse;
469 /* for exporting to sysfs (no effect on behavior) */
471 s64 last_proportional;
476 * If true, the rate will not increase if bch2_ratelimit_delay()
477 * is not being called often enough.
482 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
483 void bch2_pd_controller_init(struct bch_pd_controller *);
484 void bch2_pd_controller_debug_to_text(struct printbuf *, struct bch_pd_controller *);
486 #define sysfs_pd_controller_attribute(name) \
487 rw_attribute(name##_rate); \
488 rw_attribute(name##_rate_bytes); \
489 rw_attribute(name##_rate_d_term); \
490 rw_attribute(name##_rate_p_term_inverse); \
491 read_attribute(name##_rate_debug)
493 #define sysfs_pd_controller_files(name) \
494 &sysfs_##name##_rate, \
495 &sysfs_##name##_rate_bytes, \
496 &sysfs_##name##_rate_d_term, \
497 &sysfs_##name##_rate_p_term_inverse, \
498 &sysfs_##name##_rate_debug
500 #define sysfs_pd_controller_show(name, var) \
502 sysfs_hprint(name##_rate, (var)->rate.rate); \
503 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
504 sysfs_print(name##_rate_d_term, (var)->d_term); \
505 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
507 if (attr == &sysfs_##name##_rate_debug) \
508 bch2_pd_controller_debug_to_text(out, var); \
511 #define sysfs_pd_controller_store(name, var) \
513 sysfs_strtoul_clamp(name##_rate, \
514 (var)->rate.rate, 1, UINT_MAX); \
515 sysfs_strtoul_clamp(name##_rate_bytes, \
516 (var)->rate.rate, 1, UINT_MAX); \
517 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
518 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
519 (var)->p_term_inverse, 1, INT_MAX); \
522 #define container_of_or_null(ptr, type, member) \
524 typeof(ptr) _ptr = ptr; \
525 _ptr ? container_of(_ptr, type, member) : NULL; \
528 /* Does linear interpolation between powers of two */
529 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
531 unsigned fract = x & ~(~0 << fract_bits);
535 x += (x * fract) >> fract_bits;
540 void bch2_bio_map(struct bio *bio, void *base, size_t);
541 int bch2_bio_alloc_pages(struct bio *, size_t, gfp_t);
543 static inline sector_t bdev_sectors(struct block_device *bdev)
545 return bdev->bd_inode->i_size >> 9;
548 #define closure_bio_submit(bio, cl) \
554 #define kthread_wait(cond) \
559 set_current_state(TASK_INTERRUPTIBLE); \
560 if (kthread_should_stop()) { \
570 set_current_state(TASK_RUNNING); \
574 #define kthread_wait_freezable(cond) \
578 set_current_state(TASK_INTERRUPTIBLE); \
579 if (kthread_should_stop()) { \
590 set_current_state(TASK_RUNNING); \
594 size_t bch2_rand_range(size_t);
596 void memcpy_to_bio(struct bio *, struct bvec_iter, const void *);
597 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
599 static inline void memcpy_u64s_small(void *dst, const void *src,
609 static inline void __memcpy_u64s(void *dst, const void *src,
615 asm volatile("rep ; movsq"
616 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
617 : "0" (u64s), "1" (dst), "2" (src)
628 static inline void memcpy_u64s(void *dst, const void *src,
631 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
632 dst + u64s * sizeof(u64) <= src));
634 __memcpy_u64s(dst, src, u64s);
637 static inline void __memmove_u64s_down(void *dst, const void *src,
640 __memcpy_u64s(dst, src, u64s);
643 static inline void memmove_u64s_down(void *dst, const void *src,
648 __memmove_u64s_down(dst, src, u64s);
651 static inline void __memmove_u64s_down_small(void *dst, const void *src,
654 memcpy_u64s_small(dst, src, u64s);
657 static inline void memmove_u64s_down_small(void *dst, const void *src,
662 __memmove_u64s_down_small(dst, src, u64s);
665 static inline void __memmove_u64s_up_small(void *_dst, const void *_src,
668 u64 *dst = (u64 *) _dst + u64s;
669 u64 *src = (u64 *) _src + u64s;
675 static inline void memmove_u64s_up_small(void *dst, const void *src,
680 __memmove_u64s_up_small(dst, src, u64s);
683 static inline void __memmove_u64s_up(void *_dst, const void *_src,
686 u64 *dst = (u64 *) _dst + u64s - 1;
687 u64 *src = (u64 *) _src + u64s - 1;
692 asm volatile("std ;\n"
695 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
696 : "0" (u64s), "1" (dst), "2" (src)
704 static inline void memmove_u64s_up(void *dst, const void *src,
709 __memmove_u64s_up(dst, src, u64s);
712 static inline void memmove_u64s(void *dst, const void *src,
716 __memmove_u64s_down(dst, src, u64s);
718 __memmove_u64s_up(dst, src, u64s);
721 /* Set the last few bytes up to a u64 boundary given an offset into a buffer. */
722 static inline void memset_u64s_tail(void *s, int c, unsigned bytes)
724 unsigned rem = round_up(bytes, sizeof(u64)) - bytes;
726 memset(s + bytes, c, rem);
729 void sort_cmp_size(void *base, size_t num, size_t size,
730 int (*cmp_func)(const void *, const void *, size_t),
731 void (*swap_func)(void *, void *, size_t));
733 /* just the memmove, doesn't update @_nr */
734 #define __array_insert_item(_array, _nr, _pos) \
735 memmove(&(_array)[(_pos) + 1], \
737 sizeof((_array)[0]) * ((_nr) - (_pos)))
739 #define array_insert_item(_array, _nr, _pos, _new_item) \
741 __array_insert_item(_array, _nr, _pos); \
743 (_array)[(_pos)] = (_new_item); \
746 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
748 (_nr) -= (_nr_to_remove); \
749 memmove(&(_array)[(_pos)], \
750 &(_array)[(_pos) + (_nr_to_remove)], \
751 sizeof((_array)[0]) * ((_nr) - (_pos))); \
754 #define array_remove_item(_array, _nr, _pos) \
755 array_remove_items(_array, _nr, _pos, 1)
757 static inline void __move_gap(void *array, size_t element_size,
758 size_t nr, size_t size,
759 size_t old_gap, size_t new_gap)
761 size_t gap_end = old_gap + size - nr;
763 if (new_gap < old_gap) {
764 size_t move = old_gap - new_gap;
766 memmove(array + element_size * (gap_end - move),
767 array + element_size * (old_gap - move),
768 element_size * move);
769 } else if (new_gap > old_gap) {
770 size_t move = new_gap - old_gap;
772 memmove(array + element_size * old_gap,
773 array + element_size * gap_end,
774 element_size * move);
778 /* Move the gap in a gap buffer: */
779 #define move_gap(_array, _nr, _size, _old_gap, _new_gap) \
780 __move_gap(_array, sizeof(_array[0]), _nr, _size, _old_gap, _new_gap)
782 #define bubble_sort(_base, _nr, _cmp) \
785 bool _swapped = true; \
787 for (_last= (ssize_t) (_nr) - 1; _last > 0 && _swapped; --_last) {\
789 for (_i = 0; _i < _last; _i++) \
790 if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) { \
791 swap((_base)[_i], (_base)[_i + 1]); \
797 static inline u64 percpu_u64_get(u64 __percpu *src)
802 for_each_possible_cpu(cpu)
803 ret += *per_cpu_ptr(src, cpu);
807 static inline void percpu_u64_set(u64 __percpu *dst, u64 src)
811 for_each_possible_cpu(cpu)
812 *per_cpu_ptr(dst, cpu) = 0;
813 this_cpu_write(*dst, src);
816 static inline void acc_u64s(u64 *acc, const u64 *src, unsigned nr)
820 for (i = 0; i < nr; i++)
824 static inline void acc_u64s_percpu(u64 *acc, const u64 __percpu *src,
829 for_each_possible_cpu(cpu)
830 acc_u64s(acc, per_cpu_ptr(src, cpu), nr);
833 static inline void percpu_memset(void __percpu *p, int c, size_t bytes)
837 for_each_possible_cpu(cpu)
838 memset(per_cpu_ptr(p, cpu), c, bytes);
841 u64 *bch2_acc_percpu_u64s(u64 __percpu *, unsigned);
843 #define cmp_int(l, r) ((l > r) - (l < r))
845 static inline int u8_cmp(u8 l, u8 r)
847 return cmp_int(l, r);
850 static inline int cmp_le32(__le32 l, __le32 r)
852 return cmp_int(le32_to_cpu(l), le32_to_cpu(r));
855 #include <linux/uuid.h>
857 #endif /* _BCACHEFS_UTIL_H */