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 #define init_heap(heap, _size, gfp) \
61 (heap)->size = (_size); \
62 (heap)->data = kvmalloc((heap)->size * sizeof((heap)->data[0]),\
66 #define free_heap(heap) \
68 kvfree((heap)->data); \
69 (heap)->data = NULL; \
72 #define ANYSINT_MAX(t) \
73 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
77 #define prt_vprintf(_out, ...) bch2_prt_vprintf(_out, __VA_ARGS__)
78 #define prt_printf(_out, ...) bch2_prt_printf(_out, __VA_ARGS__)
79 #define printbuf_str(_buf) bch2_printbuf_str(_buf)
80 #define printbuf_exit(_buf) bch2_printbuf_exit(_buf)
82 #define printbuf_tabstops_reset(_buf) bch2_printbuf_tabstops_reset(_buf)
83 #define printbuf_tabstop_pop(_buf) bch2_printbuf_tabstop_pop(_buf)
84 #define printbuf_tabstop_push(_buf, _n) bch2_printbuf_tabstop_push(_buf, _n)
86 #define printbuf_indent_add(_out, _n) bch2_printbuf_indent_add(_out, _n)
87 #define printbuf_indent_sub(_out, _n) bch2_printbuf_indent_sub(_out, _n)
89 #define prt_newline(_out) bch2_prt_newline(_out)
90 #define prt_tab(_out) bch2_prt_tab(_out)
91 #define prt_tab_rjust(_out) bch2_prt_tab_rjust(_out)
93 #define prt_bytes_indented(...) bch2_prt_bytes_indented(__VA_ARGS__)
94 #define prt_u64(_out, _v) prt_printf(_out, "%llu", (u64) (_v))
95 #define prt_human_readable_u64(...) bch2_prt_human_readable_u64(__VA_ARGS__)
96 #define prt_human_readable_s64(...) bch2_prt_human_readable_s64(__VA_ARGS__)
97 #define prt_units_u64(...) bch2_prt_units_u64(__VA_ARGS__)
98 #define prt_units_s64(...) bch2_prt_units_s64(__VA_ARGS__)
99 #define prt_string_option(...) bch2_prt_string_option(__VA_ARGS__)
100 #define prt_bitflags(...) bch2_prt_bitflags(__VA_ARGS__)
101 #define prt_bitflags_vector(...) bch2_prt_bitflags_vector(__VA_ARGS__)
103 void bch2_pr_time_units(struct printbuf
*, u64
);
104 void bch2_prt_datetime(struct printbuf
*, time64_t
);
107 static inline void uuid_unparse_lower(u8
*uuid
, char *out
)
109 sprintf(out
, "%pUb", uuid
);
112 #include <uuid/uuid.h>
115 static inline void pr_uuid(struct printbuf
*out
, u8
*uuid
)
119 uuid_unparse_lower(uuid
, uuid_str
);
120 prt_printf(out
, "%s", uuid_str
);
123 int bch2_strtoint_h(const char *, int *);
124 int bch2_strtouint_h(const char *, unsigned int *);
125 int bch2_strtoll_h(const char *, long long *);
126 int bch2_strtoull_h(const char *, unsigned long long *);
127 int bch2_strtou64_h(const char *, u64
*);
129 static inline int bch2_strtol_h(const char *cp
, long *res
)
131 #if BITS_PER_LONG == 32
132 return bch2_strtoint_h(cp
, (int *) res
);
134 return bch2_strtoll_h(cp
, (long long *) res
);
138 static inline int bch2_strtoul_h(const char *cp
, long *res
)
140 #if BITS_PER_LONG == 32
141 return bch2_strtouint_h(cp
, (unsigned int *) res
);
143 return bch2_strtoull_h(cp
, (unsigned long long *) res
);
147 #define strtoi_h(cp, res) \
148 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
149 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
150 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
151 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
152 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
153 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
156 #define strtoul_safe(cp, var) \
159 int _r = kstrtoul(cp, 10, &_v); \
165 #define strtoul_safe_clamp(cp, var, min, max) \
168 int _r = kstrtoul(cp, 10, &_v); \
170 var = clamp_t(typeof(var), _v, min, max); \
174 #define strtoul_safe_restrict(cp, var, min, max) \
177 int _r = kstrtoul(cp, 10, &_v); \
178 if (!_r && _v >= min && _v <= max) \
185 #define snprint(out, var) \
187 type_is(var, int) ? "%i\n" \
188 : type_is(var, unsigned) ? "%u\n" \
189 : type_is(var, long) ? "%li\n" \
190 : type_is(var, unsigned long) ? "%lu\n" \
191 : type_is(var, s64) ? "%lli\n" \
192 : type_is(var, u64) ? "%llu\n" \
193 : type_is(var, char *) ? "%s\n" \
196 bool bch2_is_zero(const void *, size_t);
198 u64
bch2_read_flag_list(const char *, const char * const[]);
200 void bch2_prt_u64_base2_nbits(struct printbuf
*, u64
, unsigned);
201 void bch2_prt_u64_base2(struct printbuf
*, u64
);
203 void bch2_print_string_as_lines(const char *prefix
, const char *lines
);
204 void bch2_print_string_as_lines_nonblocking(const char *prefix
, const char *lines
);
206 typedef DARRAY(unsigned long) bch_stacktrace
;
207 int bch2_save_backtrace(bch_stacktrace
*stack
, struct task_struct
*, unsigned, gfp_t
);
208 void bch2_prt_backtrace(struct printbuf
*, bch_stacktrace
*);
209 int bch2_prt_task_backtrace(struct printbuf
*, struct task_struct
*, unsigned, gfp_t
);
211 static inline void prt_bdevname(struct printbuf
*out
, struct block_device
*bdev
)
214 prt_printf(out
, "%pg", bdev
);
216 prt_str(out
, bdev
->name
);
220 void bch2_time_stats_to_text(struct printbuf
*, struct bch2_time_stats
*);
222 #define ewma_add(ewma, val, weight) \
224 typeof(ewma) _ewma = (ewma); \
225 typeof(weight) _weight = (weight); \
227 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
230 struct bch_ratelimit
{
231 /* Next time we want to do some work, in nanoseconds */
235 * Rate at which we want to do work, in units per nanosecond
236 * The units here correspond to the units passed to
237 * bch2_ratelimit_increment()
242 static inline void bch2_ratelimit_reset(struct bch_ratelimit
*d
)
244 d
->next
= local_clock();
247 u64
bch2_ratelimit_delay(struct bch_ratelimit
*);
248 void bch2_ratelimit_increment(struct bch_ratelimit
*, u64
);
250 struct bch_pd_controller
{
251 struct bch_ratelimit rate
;
252 unsigned long last_update
;
255 s64 smoothed_derivative
;
257 unsigned p_term_inverse
;
261 /* for exporting to sysfs (no effect on behavior) */
263 s64 last_proportional
;
268 * If true, the rate will not increase if bch2_ratelimit_delay()
269 * is not being called often enough.
274 void bch2_pd_controller_update(struct bch_pd_controller
*, s64
, s64
, int);
275 void bch2_pd_controller_init(struct bch_pd_controller
*);
276 void bch2_pd_controller_debug_to_text(struct printbuf
*, struct bch_pd_controller
*);
278 #define sysfs_pd_controller_attribute(name) \
279 rw_attribute(name##_rate); \
280 rw_attribute(name##_rate_bytes); \
281 rw_attribute(name##_rate_d_term); \
282 rw_attribute(name##_rate_p_term_inverse); \
283 read_attribute(name##_rate_debug)
285 #define sysfs_pd_controller_files(name) \
286 &sysfs_##name##_rate, \
287 &sysfs_##name##_rate_bytes, \
288 &sysfs_##name##_rate_d_term, \
289 &sysfs_##name##_rate_p_term_inverse, \
290 &sysfs_##name##_rate_debug
292 #define sysfs_pd_controller_show(name, var) \
294 sysfs_hprint(name##_rate, (var)->rate.rate); \
295 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
296 sysfs_print(name##_rate_d_term, (var)->d_term); \
297 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
299 if (attr == &sysfs_##name##_rate_debug) \
300 bch2_pd_controller_debug_to_text(out, var); \
303 #define sysfs_pd_controller_store(name, var) \
305 sysfs_strtoul_clamp(name##_rate, \
306 (var)->rate.rate, 1, UINT_MAX); \
307 sysfs_strtoul_clamp(name##_rate_bytes, \
308 (var)->rate.rate, 1, UINT_MAX); \
309 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
310 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
311 (var)->p_term_inverse, 1, INT_MAX); \
314 #define container_of_or_null(ptr, type, member) \
316 typeof(ptr) _ptr = ptr; \
317 _ptr ? container_of(_ptr, type, member) : NULL; \
320 /* Does linear interpolation between powers of two */
321 static inline unsigned fract_exp_two(unsigned x
, unsigned fract_bits
)
323 unsigned fract
= x
& ~(~0 << fract_bits
);
327 x
+= (x
* fract
) >> fract_bits
;
332 void bch2_bio_map(struct bio
*bio
, void *base
, size_t);
333 int bch2_bio_alloc_pages(struct bio
*, size_t, gfp_t
);
335 #define closure_bio_submit(bio, cl) \
341 #define kthread_wait(cond) \
346 set_current_state(TASK_INTERRUPTIBLE); \
347 if (kthread_should_stop()) { \
357 set_current_state(TASK_RUNNING); \
361 #define kthread_wait_freezable(cond) \
365 set_current_state(TASK_INTERRUPTIBLE); \
366 if (kthread_should_stop()) { \
377 set_current_state(TASK_RUNNING); \
381 size_t bch2_rand_range(size_t);
383 void memcpy_to_bio(struct bio
*, struct bvec_iter
, const void *);
384 void memcpy_from_bio(void *, struct bio
*, struct bvec_iter
);
386 static inline void memcpy_u64s_small(void *dst
, const void *src
,
396 static inline void __memcpy_u64s(void *dst
, const void *src
,
402 asm volatile("rep ; movsq"
403 : "=&c" (d0
), "=&D" (d1
), "=&S" (d2
)
404 : "0" (u64s
), "1" (dst
), "2" (src
)
415 static inline void memcpy_u64s(void *dst
, const void *src
,
418 EBUG_ON(!(dst
>= src
+ u64s
* sizeof(u64
) ||
419 dst
+ u64s
* sizeof(u64
) <= src
));
421 __memcpy_u64s(dst
, src
, u64s
);
424 static inline void __memmove_u64s_down(void *dst
, const void *src
,
427 __memcpy_u64s(dst
, src
, u64s
);
430 static inline void memmove_u64s_down(void *dst
, const void *src
,
435 __memmove_u64s_down(dst
, src
, u64s
);
438 static inline void __memmove_u64s_down_small(void *dst
, const void *src
,
441 memcpy_u64s_small(dst
, src
, u64s
);
444 static inline void memmove_u64s_down_small(void *dst
, const void *src
,
449 __memmove_u64s_down_small(dst
, src
, u64s
);
452 static inline void __memmove_u64s_up_small(void *_dst
, const void *_src
,
455 u64
*dst
= (u64
*) _dst
+ u64s
;
456 u64
*src
= (u64
*) _src
+ u64s
;
462 static inline void memmove_u64s_up_small(void *dst
, const void *src
,
467 __memmove_u64s_up_small(dst
, src
, u64s
);
470 static inline void __memmove_u64s_up(void *_dst
, const void *_src
,
473 u64
*dst
= (u64
*) _dst
+ u64s
- 1;
474 u64
*src
= (u64
*) _src
+ u64s
- 1;
479 asm volatile("std ;\n"
482 : "=&c" (d0
), "=&D" (d1
), "=&S" (d2
)
483 : "0" (u64s
), "1" (dst
), "2" (src
)
491 static inline void memmove_u64s_up(void *dst
, const void *src
,
496 __memmove_u64s_up(dst
, src
, u64s
);
499 static inline void memmove_u64s(void *dst
, const void *src
,
503 __memmove_u64s_down(dst
, src
, u64s
);
505 __memmove_u64s_up(dst
, src
, u64s
);
508 /* Set the last few bytes up to a u64 boundary given an offset into a buffer. */
509 static inline void memset_u64s_tail(void *s
, int c
, unsigned bytes
)
511 unsigned rem
= round_up(bytes
, sizeof(u64
)) - bytes
;
513 memset(s
+ bytes
, c
, rem
);
516 /* just the memmove, doesn't update @_nr */
517 #define __array_insert_item(_array, _nr, _pos) \
518 memmove(&(_array)[(_pos) + 1], \
520 sizeof((_array)[0]) * ((_nr) - (_pos)))
522 #define array_insert_item(_array, _nr, _pos, _new_item) \
524 __array_insert_item(_array, _nr, _pos); \
526 (_array)[(_pos)] = (_new_item); \
529 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
531 (_nr) -= (_nr_to_remove); \
532 memmove(&(_array)[(_pos)], \
533 &(_array)[(_pos) + (_nr_to_remove)], \
534 sizeof((_array)[0]) * ((_nr) - (_pos))); \
537 #define array_remove_item(_array, _nr, _pos) \
538 array_remove_items(_array, _nr, _pos, 1)
540 static inline void __move_gap(void *array
, size_t element_size
,
541 size_t nr
, size_t size
,
542 size_t old_gap
, size_t new_gap
)
544 size_t gap_end
= old_gap
+ size
- nr
;
546 if (new_gap
< old_gap
) {
547 size_t move
= old_gap
- new_gap
;
549 memmove(array
+ element_size
* (gap_end
- move
),
550 array
+ element_size
* (old_gap
- move
),
551 element_size
* move
);
552 } else if (new_gap
> old_gap
) {
553 size_t move
= new_gap
- old_gap
;
555 memmove(array
+ element_size
* old_gap
,
556 array
+ element_size
* gap_end
,
557 element_size
* move
);
561 /* Move the gap in a gap buffer: */
562 #define move_gap(_d, _new_gap) \
564 BUG_ON(_new_gap > (_d)->nr); \
565 BUG_ON((_d)->gap > (_d)->nr); \
567 __move_gap((_d)->data, sizeof((_d)->data[0]), \
568 (_d)->nr, (_d)->size, (_d)->gap, _new_gap); \
569 (_d)->gap = _new_gap; \
572 #define bubble_sort(_base, _nr, _cmp) \
575 bool _swapped = true; \
577 for (_last= (ssize_t) (_nr) - 1; _last > 0 && _swapped; --_last) {\
579 for (_i = 0; _i < _last; _i++) \
580 if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) { \
581 swap((_base)[_i], (_base)[_i + 1]); \
587 #define per_cpu_sum(_p) \
589 typeof(*_p) _ret = 0; \
592 for_each_possible_cpu(cpu) \
593 _ret += *per_cpu_ptr(_p, cpu); \
597 static inline u64
percpu_u64_get(u64 __percpu
*src
)
599 return per_cpu_sum(src
);
602 static inline void percpu_u64_set(u64 __percpu
*dst
, u64 src
)
606 for_each_possible_cpu(cpu
)
607 *per_cpu_ptr(dst
, cpu
) = 0;
608 this_cpu_write(*dst
, src
);
611 static inline void acc_u64s(u64
*acc
, const u64
*src
, unsigned nr
)
613 for (unsigned i
= 0; i
< nr
; i
++)
617 static inline void acc_u64s_percpu(u64
*acc
, const u64 __percpu
*src
,
622 for_each_possible_cpu(cpu
)
623 acc_u64s(acc
, per_cpu_ptr(src
, cpu
), nr
);
626 static inline void percpu_memset(void __percpu
*p
, int c
, size_t bytes
)
630 for_each_possible_cpu(cpu
)
631 memset(per_cpu_ptr(p
, cpu
), c
, bytes
);
634 u64
*bch2_acc_percpu_u64s(u64 __percpu
*, unsigned);
636 #define cmp_int(l, r) ((l > r) - (l < r))
638 static inline int u8_cmp(u8 l
, u8 r
)
640 return cmp_int(l
, r
);
643 static inline int cmp_le32(__le32 l
, __le32 r
)
645 return cmp_int(le32_to_cpu(l
), le32_to_cpu(r
));
648 #include <linux/uuid.h>
650 #define QSTR(n) { { { .len = strlen(n) } }, .name = n }
652 static inline bool qstr_eq(const struct qstr l
, const struct qstr r
)
654 return l
.len
== r
.len
&& !memcmp(l
.name
, r
.name
, l
.len
);
657 void bch2_darray_str_exit(darray_str
*);
658 int bch2_split_devs(const char *, darray_str
*);
663 static inline int copy_to_user_errcode(void __user
*to
, const void *from
, unsigned long n
)
665 return copy_to_user(to
, from
, n
) ? -EFAULT
: 0;
669 static inline int copy_from_user_errcode(void *to
, const void __user
*from
, unsigned long n
)
671 return copy_from_user(to
, from
, n
) ? -EFAULT
: 0;
676 static inline void mod_bit(long nr
, volatile unsigned long *addr
, bool v
)
684 static inline void __set_bit_le64(size_t bit
, __le64
*addr
)
686 addr
[bit
/ 64] |= cpu_to_le64(BIT_ULL(bit
% 64));
689 static inline void __clear_bit_le64(size_t bit
, __le64
*addr
)
691 addr
[bit
/ 64] &= ~cpu_to_le64(BIT_ULL(bit
% 64));
694 static inline bool test_bit_le64(size_t bit
, __le64
*addr
)
696 return (addr
[bit
/ 64] & cpu_to_le64(BIT_ULL(bit
% 64))) != 0;
699 #endif /* _BCACHEFS_UTIL_H */