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/min_heap.h>
12 #include <linux/sched/clock.h>
13 #include <linux/llist.h>
14 #include <linux/log2.h>
15 #include <linux/percpu.h>
16 #include <linux/preempt.h>
17 #include <linux/ratelimit.h>
18 #include <linux/slab.h>
19 #include <linux/vmalloc.h>
20 #include <linux/workqueue.h>
22 #include "mean_and_variance.h"
25 #include "time_stats.h"
29 #ifdef CONFIG_BCACHEFS_DEBUG
30 #define EBUG_ON(cond) BUG_ON(cond)
35 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
36 #define CPU_BIG_ENDIAN 0
37 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
38 #define CPU_BIG_ENDIAN 1
43 #define type_is_exact(_val, _type) \
44 __builtin_types_compatible_p(typeof(_val), _type)
46 #define type_is(_val, _type) \
47 (__builtin_types_compatible_p(typeof(_val), _type) || \
48 __builtin_types_compatible_p(typeof(_val), const _type))
50 /* Userspace doesn't align allocations as nicely as the kernel allocators: */
51 static inline size_t buf_pages(void *p, size_t len)
53 return DIV_ROUND_UP(len +
54 ((unsigned long) p & (PAGE_SIZE - 1)),
58 static inline void *bch2_kvmalloc(size_t n, gfp_t flags)
60 void *p = unlikely(n >= INT_MAX)
62 : kvmalloc(n, flags & ~__GFP_ZERO);
63 if (p && (flags & __GFP_ZERO))
68 #define init_heap(heap, _size, gfp) \
71 (heap)->size = (_size); \
72 (heap)->data = kvmalloc((heap)->size * sizeof((heap)->data[0]),\
76 #define free_heap(heap) \
78 kvfree((heap)->data); \
79 (heap)->data = NULL; \
82 #define ANYSINT_MAX(t) \
83 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
87 #define prt_vprintf(_out, ...) bch2_prt_vprintf(_out, __VA_ARGS__)
88 #define prt_printf(_out, ...) bch2_prt_printf(_out, __VA_ARGS__)
89 #define printbuf_str(_buf) bch2_printbuf_str(_buf)
90 #define printbuf_exit(_buf) bch2_printbuf_exit(_buf)
92 #define printbuf_tabstops_reset(_buf) bch2_printbuf_tabstops_reset(_buf)
93 #define printbuf_tabstop_pop(_buf) bch2_printbuf_tabstop_pop(_buf)
94 #define printbuf_tabstop_push(_buf, _n) bch2_printbuf_tabstop_push(_buf, _n)
96 #define printbuf_indent_add(_out, _n) bch2_printbuf_indent_add(_out, _n)
97 #define printbuf_indent_sub(_out, _n) bch2_printbuf_indent_sub(_out, _n)
99 #define prt_newline(_out) bch2_prt_newline(_out)
100 #define prt_tab(_out) bch2_prt_tab(_out)
101 #define prt_tab_rjust(_out) bch2_prt_tab_rjust(_out)
103 #define prt_bytes_indented(...) bch2_prt_bytes_indented(__VA_ARGS__)
104 #define prt_u64(_out, _v) prt_printf(_out, "%llu", (u64) (_v))
105 #define prt_human_readable_u64(...) bch2_prt_human_readable_u64(__VA_ARGS__)
106 #define prt_human_readable_s64(...) bch2_prt_human_readable_s64(__VA_ARGS__)
107 #define prt_units_u64(...) bch2_prt_units_u64(__VA_ARGS__)
108 #define prt_units_s64(...) bch2_prt_units_s64(__VA_ARGS__)
109 #define prt_string_option(...) bch2_prt_string_option(__VA_ARGS__)
110 #define prt_bitflags(...) bch2_prt_bitflags(__VA_ARGS__)
111 #define prt_bitflags_vector(...) bch2_prt_bitflags_vector(__VA_ARGS__)
113 void bch2_pr_time_units(struct printbuf *, u64);
114 void bch2_prt_datetime(struct printbuf *, time64_t);
117 static inline void uuid_unparse_lower(u8 *uuid, char *out)
119 sprintf(out, "%pUb", uuid);
122 #include <uuid/uuid.h>
125 static inline void pr_uuid(struct printbuf *out, u8 *uuid)
129 uuid_unparse_lower(uuid, uuid_str);
130 prt_printf(out, "%s", uuid_str);
133 int bch2_strtoint_h(const char *, int *);
134 int bch2_strtouint_h(const char *, unsigned int *);
135 int bch2_strtoll_h(const char *, long long *);
136 int bch2_strtoull_h(const char *, unsigned long long *);
137 int bch2_strtou64_h(const char *, u64 *);
139 static inline int bch2_strtol_h(const char *cp, long *res)
141 #if BITS_PER_LONG == 32
142 return bch2_strtoint_h(cp, (int *) res);
144 return bch2_strtoll_h(cp, (long long *) res);
148 static inline int bch2_strtoul_h(const char *cp, long *res)
150 #if BITS_PER_LONG == 32
151 return bch2_strtouint_h(cp, (unsigned int *) res);
153 return bch2_strtoull_h(cp, (unsigned long long *) res);
157 #define strtoi_h(cp, res) \
158 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
159 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
160 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
161 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
162 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
163 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
166 #define strtoul_safe(cp, var) \
169 int _r = kstrtoul(cp, 10, &_v); \
175 #define strtoul_safe_clamp(cp, var, min, max) \
178 int _r = kstrtoul(cp, 10, &_v); \
180 var = clamp_t(typeof(var), _v, min, max); \
184 #define strtoul_safe_restrict(cp, var, min, max) \
187 int _r = kstrtoul(cp, 10, &_v); \
188 if (!_r && _v >= min && _v <= max) \
195 #define snprint(out, var) \
197 type_is(var, int) ? "%i\n" \
198 : type_is(var, unsigned) ? "%u\n" \
199 : type_is(var, long) ? "%li\n" \
200 : type_is(var, unsigned long) ? "%lu\n" \
201 : type_is(var, s64) ? "%lli\n" \
202 : type_is(var, u64) ? "%llu\n" \
203 : type_is(var, char *) ? "%s\n" \
206 bool bch2_is_zero(const void *, size_t);
208 u64 bch2_read_flag_list(const char *, const char * const[]);
210 void bch2_prt_u64_base2_nbits(struct printbuf *, u64, unsigned);
211 void bch2_prt_u64_base2(struct printbuf *, u64);
213 void bch2_print_string_as_lines(const char *prefix, const char *lines);
214 void bch2_print_string_as_lines_nonblocking(const char *prefix, const char *lines);
216 typedef DARRAY(unsigned long) bch_stacktrace;
217 int bch2_save_backtrace(bch_stacktrace *stack, struct task_struct *, unsigned, gfp_t);
218 void bch2_prt_backtrace(struct printbuf *, bch_stacktrace *);
219 int bch2_prt_task_backtrace(struct printbuf *, struct task_struct *, unsigned, gfp_t);
221 static inline void prt_bdevname(struct printbuf *out, struct block_device *bdev)
224 prt_printf(out, "%pg", bdev);
226 prt_str(out, bdev->name);
230 void bch2_time_stats_to_text(struct printbuf *, struct bch2_time_stats *);
232 #define ewma_add(ewma, val, weight) \
234 typeof(ewma) _ewma = (ewma); \
235 typeof(weight) _weight = (weight); \
237 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
240 struct bch_ratelimit {
241 /* Next time we want to do some work, in nanoseconds */
245 * Rate at which we want to do work, in units per nanosecond
246 * The units here correspond to the units passed to
247 * bch2_ratelimit_increment()
252 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
254 d->next = local_clock();
257 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
258 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
260 struct bch_pd_controller {
261 struct bch_ratelimit rate;
262 unsigned long last_update;
265 s64 smoothed_derivative;
267 unsigned p_term_inverse;
271 /* for exporting to sysfs (no effect on behavior) */
273 s64 last_proportional;
278 * If true, the rate will not increase if bch2_ratelimit_delay()
279 * is not being called often enough.
284 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
285 void bch2_pd_controller_init(struct bch_pd_controller *);
286 void bch2_pd_controller_debug_to_text(struct printbuf *, struct bch_pd_controller *);
288 #define sysfs_pd_controller_attribute(name) \
289 rw_attribute(name##_rate); \
290 rw_attribute(name##_rate_bytes); \
291 rw_attribute(name##_rate_d_term); \
292 rw_attribute(name##_rate_p_term_inverse); \
293 read_attribute(name##_rate_debug)
295 #define sysfs_pd_controller_files(name) \
296 &sysfs_##name##_rate, \
297 &sysfs_##name##_rate_bytes, \
298 &sysfs_##name##_rate_d_term, \
299 &sysfs_##name##_rate_p_term_inverse, \
300 &sysfs_##name##_rate_debug
302 #define sysfs_pd_controller_show(name, var) \
304 sysfs_hprint(name##_rate, (var)->rate.rate); \
305 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
306 sysfs_print(name##_rate_d_term, (var)->d_term); \
307 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
309 if (attr == &sysfs_##name##_rate_debug) \
310 bch2_pd_controller_debug_to_text(out, var); \
313 #define sysfs_pd_controller_store(name, var) \
315 sysfs_strtoul_clamp(name##_rate, \
316 (var)->rate.rate, 1, UINT_MAX); \
317 sysfs_strtoul_clamp(name##_rate_bytes, \
318 (var)->rate.rate, 1, UINT_MAX); \
319 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
320 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
321 (var)->p_term_inverse, 1, INT_MAX); \
324 #define container_of_or_null(ptr, type, member) \
326 typeof(ptr) _ptr = ptr; \
327 _ptr ? container_of(_ptr, type, member) : NULL; \
330 static inline struct list_head *list_pop(struct list_head *head)
332 if (list_empty(head))
335 struct list_head *ret = head->next;
340 #define list_pop_entry(head, type, member) \
341 container_of_or_null(list_pop(head), type, member)
343 /* Does linear interpolation between powers of two */
344 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
346 unsigned fract = x & ~(~0 << fract_bits);
350 x += (x * fract) >> fract_bits;
355 void bch2_bio_map(struct bio *bio, void *base, size_t);
356 int bch2_bio_alloc_pages(struct bio *, size_t, gfp_t);
358 #define closure_bio_submit(bio, cl) \
364 #define kthread_wait(cond) \
369 set_current_state(TASK_INTERRUPTIBLE); \
370 if (kthread_should_stop()) { \
380 set_current_state(TASK_RUNNING); \
384 #define kthread_wait_freezable(cond) \
388 set_current_state(TASK_INTERRUPTIBLE); \
389 if (kthread_should_stop()) { \
400 set_current_state(TASK_RUNNING); \
404 size_t bch2_rand_range(size_t);
406 void memcpy_to_bio(struct bio *, struct bvec_iter, const void *);
407 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
409 static inline void memcpy_u64s_small(void *dst, const void *src,
419 static inline void __memcpy_u64s(void *dst, const void *src,
425 asm volatile("rep ; movsq"
426 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
427 : "0" (u64s), "1" (dst), "2" (src)
438 static inline void memcpy_u64s(void *dst, const void *src,
441 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
442 dst + u64s * sizeof(u64) <= src));
444 __memcpy_u64s(dst, src, u64s);
447 static inline void __memmove_u64s_down(void *dst, const void *src,
450 __memcpy_u64s(dst, src, u64s);
453 static inline void memmove_u64s_down(void *dst, const void *src,
458 __memmove_u64s_down(dst, src, u64s);
461 static inline void __memmove_u64s_down_small(void *dst, const void *src,
464 memcpy_u64s_small(dst, src, u64s);
467 static inline void memmove_u64s_down_small(void *dst, const void *src,
472 __memmove_u64s_down_small(dst, src, u64s);
475 static inline void __memmove_u64s_up_small(void *_dst, const void *_src,
478 u64 *dst = (u64 *) _dst + u64s;
479 u64 *src = (u64 *) _src + u64s;
485 static inline void memmove_u64s_up_small(void *dst, const void *src,
490 __memmove_u64s_up_small(dst, src, u64s);
493 static inline void __memmove_u64s_up(void *_dst, const void *_src,
496 u64 *dst = (u64 *) _dst + u64s - 1;
497 u64 *src = (u64 *) _src + u64s - 1;
502 asm volatile("std ;\n"
505 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
506 : "0" (u64s), "1" (dst), "2" (src)
514 static inline void memmove_u64s_up(void *dst, const void *src,
519 __memmove_u64s_up(dst, src, u64s);
522 static inline void memmove_u64s(void *dst, const void *src,
526 __memmove_u64s_down(dst, src, u64s);
528 __memmove_u64s_up(dst, src, u64s);
531 /* Set the last few bytes up to a u64 boundary given an offset into a buffer. */
532 static inline void memset_u64s_tail(void *s, int c, unsigned bytes)
534 unsigned rem = round_up(bytes, sizeof(u64)) - bytes;
536 memset(s + bytes, c, rem);
539 /* just the memmove, doesn't update @_nr */
540 #define __array_insert_item(_array, _nr, _pos) \
541 memmove(&(_array)[(_pos) + 1], \
543 sizeof((_array)[0]) * ((_nr) - (_pos)))
545 #define array_insert_item(_array, _nr, _pos, _new_item) \
547 __array_insert_item(_array, _nr, _pos); \
549 (_array)[(_pos)] = (_new_item); \
552 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
554 (_nr) -= (_nr_to_remove); \
555 memmove(&(_array)[(_pos)], \
556 &(_array)[(_pos) + (_nr_to_remove)], \
557 sizeof((_array)[0]) * ((_nr) - (_pos))); \
560 #define array_remove_item(_array, _nr, _pos) \
561 array_remove_items(_array, _nr, _pos, 1)
563 static inline void __move_gap(void *array, size_t element_size,
564 size_t nr, size_t size,
565 size_t old_gap, size_t new_gap)
567 size_t gap_end = old_gap + size - nr;
569 if (new_gap < old_gap) {
570 size_t move = old_gap - new_gap;
572 memmove(array + element_size * (gap_end - move),
573 array + element_size * (old_gap - move),
574 element_size * move);
575 } else if (new_gap > old_gap) {
576 size_t move = new_gap - old_gap;
578 memmove(array + element_size * old_gap,
579 array + element_size * gap_end,
580 element_size * move);
584 /* Move the gap in a gap buffer: */
585 #define move_gap(_d, _new_gap) \
587 BUG_ON(_new_gap > (_d)->nr); \
588 BUG_ON((_d)->gap > (_d)->nr); \
590 __move_gap((_d)->data, sizeof((_d)->data[0]), \
591 (_d)->nr, (_d)->size, (_d)->gap, _new_gap); \
592 (_d)->gap = _new_gap; \
595 #define bubble_sort(_base, _nr, _cmp) \
598 bool _swapped = true; \
600 for (_last= (ssize_t) (_nr) - 1; _last > 0 && _swapped; --_last) {\
602 for (_i = 0; _i < _last; _i++) \
603 if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) { \
604 swap((_base)[_i], (_base)[_i + 1]); \
610 #define per_cpu_sum(_p) \
612 typeof(*_p) _ret = 0; \
615 for_each_possible_cpu(cpu) \
616 _ret += *per_cpu_ptr(_p, cpu); \
620 static inline u64 percpu_u64_get(u64 __percpu *src)
622 return per_cpu_sum(src);
625 static inline void percpu_u64_set(u64 __percpu *dst, u64 src)
629 for_each_possible_cpu(cpu)
630 *per_cpu_ptr(dst, cpu) = 0;
631 this_cpu_write(*dst, src);
634 static inline void acc_u64s(u64 *acc, const u64 *src, unsigned nr)
636 for (unsigned i = 0; i < nr; i++)
640 static inline void acc_u64s_percpu(u64 *acc, const u64 __percpu *src,
645 for_each_possible_cpu(cpu)
646 acc_u64s(acc, per_cpu_ptr(src, cpu), nr);
649 static inline void percpu_memset(void __percpu *p, int c, size_t bytes)
653 for_each_possible_cpu(cpu)
654 memset(per_cpu_ptr(p, cpu), c, bytes);
657 u64 *bch2_acc_percpu_u64s(u64 __percpu *, unsigned);
659 #define cmp_int(l, r) ((l > r) - (l < r))
661 static inline int u8_cmp(u8 l, u8 r)
663 return cmp_int(l, r);
666 static inline int cmp_le32(__le32 l, __le32 r)
668 return cmp_int(le32_to_cpu(l), le32_to_cpu(r));
671 #include <linux/uuid.h>
673 static inline bool qstr_eq(const struct qstr l, const struct qstr r)
675 return l.len == r.len && !memcmp(l.name, r.name, l.len);
678 void bch2_darray_str_exit(darray_str *);
679 int bch2_split_devs(const char *, darray_str *);
684 static inline int copy_to_user_errcode(void __user *to, const void *from, unsigned long n)
686 return copy_to_user(to, from, n) ? -EFAULT : 0;
690 static inline int copy_from_user_errcode(void *to, const void __user *from, unsigned long n)
692 return copy_from_user(to, from, n) ? -EFAULT : 0;
697 static inline void mod_bit(long nr, volatile unsigned long *addr, bool v)
705 static inline void __set_bit_le64(size_t bit, __le64 *addr)
707 addr[bit / 64] |= cpu_to_le64(BIT_ULL(bit % 64));
710 static inline void __clear_bit_le64(size_t bit, __le64 *addr)
712 addr[bit / 64] &= ~cpu_to_le64(BIT_ULL(bit % 64));
715 static inline bool test_bit_le64(size_t bit, __le64 *addr)
717 return (addr[bit / 64] & cpu_to_le64(BIT_ULL(bit % 64))) != 0;
720 static inline void memcpy_swab(void *_dst, void *_src, size_t len)
722 u8 *dst = _dst + len;
729 #endif /* _BCACHEFS_UTIL_H */