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>
23 #ifdef CONFIG_BCACHEFS_DEBUG
25 #define EBUG_ON(cond) BUG_ON(cond)
26 #define atomic_dec_bug(v) BUG_ON(atomic_dec_return(v) < 0)
27 #define atomic_inc_bug(v, i) BUG_ON(atomic_inc_return(v) <= i)
28 #define atomic_sub_bug(i, v) BUG_ON(atomic_sub_return(i, v) < 0)
29 #define atomic_add_bug(i, v) BUG_ON(atomic_add_return(i, v) < 0)
30 #define atomic_long_dec_bug(v) BUG_ON(atomic_long_dec_return(v) < 0)
31 #define atomic_long_sub_bug(i, v) BUG_ON(atomic_long_sub_return(i, v) < 0)
32 #define atomic64_dec_bug(v) BUG_ON(atomic64_dec_return(v) < 0)
33 #define atomic64_inc_bug(v, i) BUG_ON(atomic64_inc_return(v) <= i)
34 #define atomic64_sub_bug(i, v) BUG_ON(atomic64_sub_return(i, v) < 0)
35 #define atomic64_add_bug(i, v) BUG_ON(atomic64_add_return(i, v) < 0)
40 #define atomic_dec_bug(v) atomic_dec(v)
41 #define atomic_inc_bug(v, i) atomic_inc(v)
42 #define atomic_sub_bug(i, v) atomic_sub(i, v)
43 #define atomic_add_bug(i, v) atomic_add(i, v)
44 #define atomic_long_dec_bug(v) atomic_long_dec(v)
45 #define atomic_long_sub_bug(i, v) atomic_long_sub(i, v)
46 #define atomic64_dec_bug(v) atomic64_dec(v)
47 #define atomic64_inc_bug(v, i) atomic64_inc(v)
48 #define atomic64_sub_bug(i, v) atomic64_sub(i, v)
49 #define atomic64_add_bug(i, v) atomic64_add(i, v)
53 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
54 #define CPU_BIG_ENDIAN 0
55 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
56 #define CPU_BIG_ENDIAN 1
61 #define type_is_exact(_val, _type) \
62 __builtin_types_compatible_p(typeof(_val), _type)
64 #define type_is(_val, _type) \
65 (__builtin_types_compatible_p(typeof(_val), _type) || \
66 __builtin_types_compatible_p(typeof(_val), const _type))
68 /* Userspace doesn't align allocations as nicely as the kernel allocators: */
69 static inline size_t buf_pages(void *p, size_t len)
71 return DIV_ROUND_UP(len +
72 ((unsigned long) p & (PAGE_SIZE - 1)),
76 static inline void vpfree(void *p, size_t size)
78 if (is_vmalloc_addr(p))
81 free_pages((unsigned long) p, get_order(size));
84 static inline void *vpmalloc(size_t size, gfp_t gfp_mask)
86 return (void *) __get_free_pages(gfp_mask|__GFP_NOWARN,
88 __vmalloc(size, gfp_mask);
91 static inline void kvpfree(void *p, size_t size)
99 static inline void *kvpmalloc(size_t size, gfp_t gfp_mask)
101 return size < PAGE_SIZE
102 ? kmalloc(size, gfp_mask)
103 : vpmalloc(size, gfp_mask);
106 int mempool_init_kvpmalloc_pool(mempool_t *, int, size_t);
114 #define DECLARE_HEAP(type, name) HEAP(type) name
116 #define init_heap(heap, _size, gfp) \
119 (heap)->size = (_size); \
120 (heap)->data = kvpmalloc((heap)->size * sizeof((heap)->data[0]),\
124 #define free_heap(heap) \
126 kvpfree((heap)->data, (heap)->size * sizeof((heap)->data[0])); \
127 (heap)->data = NULL; \
130 #define heap_set_backpointer(h, i, _fn) \
132 void (*fn)(typeof(h), size_t) = _fn; \
137 #define heap_swap(h, i, j, set_backpointer) \
139 swap((h)->data[i], (h)->data[j]); \
140 heap_set_backpointer(h, i, set_backpointer); \
141 heap_set_backpointer(h, j, set_backpointer); \
144 #define heap_peek(h) \
146 EBUG_ON(!(h)->used); \
150 #define heap_full(h) ((h)->used == (h)->size)
152 #define heap_sift_down(h, i, cmp, set_backpointer) \
156 for (; _j * 2 + 1 < (h)->used; _j = _c) { \
158 if (_c + 1 < (h)->used && \
159 cmp(h, (h)->data[_c], (h)->data[_c + 1]) >= 0) \
162 if (cmp(h, (h)->data[_c], (h)->data[_j]) >= 0) \
164 heap_swap(h, _c, _j, set_backpointer); \
168 #define heap_sift_up(h, i, cmp, set_backpointer) \
171 size_t p = (i - 1) / 2; \
172 if (cmp(h, (h)->data[i], (h)->data[p]) >= 0) \
174 heap_swap(h, i, p, set_backpointer); \
179 #define __heap_add(h, d, cmp, set_backpointer) \
181 size_t _i = (h)->used++; \
183 heap_set_backpointer(h, _i, set_backpointer); \
185 heap_sift_up(h, _i, cmp, set_backpointer); \
189 #define heap_add(h, d, cmp, set_backpointer) \
191 bool _r = !heap_full(h); \
193 __heap_add(h, d, cmp, set_backpointer); \
197 #define heap_add_or_replace(h, new, cmp, set_backpointer) \
199 if (!heap_add(h, new, cmp, set_backpointer) && \
200 cmp(h, new, heap_peek(h)) >= 0) { \
201 (h)->data[0] = new; \
202 heap_set_backpointer(h, 0, set_backpointer); \
203 heap_sift_down(h, 0, cmp, set_backpointer); \
207 #define heap_del(h, i, cmp, set_backpointer) \
211 BUG_ON(_i >= (h)->used); \
213 heap_swap(h, _i, (h)->used, set_backpointer); \
214 heap_sift_up(h, _i, cmp, set_backpointer); \
215 heap_sift_down(h, _i, cmp, set_backpointer); \
218 #define heap_pop(h, d, cmp, set_backpointer) \
220 bool _r = (h)->used; \
222 (d) = (h)->data[0]; \
223 heap_del(h, 0, cmp, set_backpointer); \
228 #define heap_resort(heap, cmp, set_backpointer) \
231 for (_i = (ssize_t) (heap)->used / 2 - 1; _i >= 0; --_i) \
232 heap_sift_down(heap, _i, cmp, set_backpointer); \
235 #define ANYSINT_MAX(t) \
236 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
244 static inline size_t printbuf_remaining(struct printbuf *buf)
246 return buf->end - buf->pos;
249 #define _PBUF(_buf, _len) \
250 ((struct printbuf) { \
252 .end = _buf + _len, \
255 #define PBUF(_buf) _PBUF(_buf, sizeof(_buf))
257 #define pr_buf(_out, ...) \
259 (_out)->pos += scnprintf((_out)->pos, printbuf_remaining(_out), \
263 static inline void printbuf_indent_push(struct printbuf *buf, unsigned spaces)
265 buf->indent += spaces;
270 static inline void printbuf_indent_pop(struct printbuf *buf, unsigned spaces)
272 buf->indent -= spaces;
275 static inline void printbuf_newline(struct printbuf *buf)
280 for (i = 0; i < buf->indent; i++)
284 void bch_scnmemcpy(struct printbuf *, const char *, size_t);
286 int bch2_strtoint_h(const char *, int *);
287 int bch2_strtouint_h(const char *, unsigned int *);
288 int bch2_strtoll_h(const char *, long long *);
289 int bch2_strtoull_h(const char *, unsigned long long *);
290 int bch2_strtou64_h(const char *, u64 *);
292 static inline int bch2_strtol_h(const char *cp, long *res)
294 #if BITS_PER_LONG == 32
295 return bch2_strtoint_h(cp, (int *) res);
297 return bch2_strtoll_h(cp, (long long *) res);
301 static inline int bch2_strtoul_h(const char *cp, long *res)
303 #if BITS_PER_LONG == 32
304 return bch2_strtouint_h(cp, (unsigned int *) res);
306 return bch2_strtoull_h(cp, (unsigned long long *) res);
310 #define strtoi_h(cp, res) \
311 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
312 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
313 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
314 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
315 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
316 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
319 #define strtoul_safe(cp, var) \
322 int _r = kstrtoul(cp, 10, &_v); \
328 #define strtoul_safe_clamp(cp, var, min, max) \
331 int _r = kstrtoul(cp, 10, &_v); \
333 var = clamp_t(typeof(var), _v, min, max); \
337 #define strtoul_safe_restrict(cp, var, min, max) \
340 int _r = kstrtoul(cp, 10, &_v); \
341 if (!_r && _v >= min && _v <= max) \
348 #define snprint(buf, size, var) \
349 snprintf(buf, size, \
350 type_is(var, int) ? "%i\n" \
351 : type_is(var, unsigned) ? "%u\n" \
352 : type_is(var, long) ? "%li\n" \
353 : type_is(var, unsigned long) ? "%lu\n" \
354 : type_is(var, s64) ? "%lli\n" \
355 : type_is(var, u64) ? "%llu\n" \
356 : type_is(var, char *) ? "%s\n" \
359 void bch2_hprint(struct printbuf *, s64);
361 bool bch2_is_zero(const void *, size_t);
363 void bch2_string_opt_to_text(struct printbuf *,
364 const char * const [], size_t);
366 void bch2_flags_to_text(struct printbuf *, const char * const[], u64);
367 u64 bch2_read_flag_list(char *, const char * const[]);
369 #define NR_QUANTILES 15
370 #define QUANTILE_IDX(i) inorder_to_eytzinger0(i, NR_QUANTILES)
371 #define QUANTILE_FIRST eytzinger0_first(NR_QUANTILES)
372 #define QUANTILE_LAST eytzinger0_last(NR_QUANTILES)
375 struct quantile_entry {
378 } entries[NR_QUANTILES];
381 struct time_stat_buffer {
383 struct time_stat_buffer_entry {
392 /* all fields are in nanoseconds */
393 u64 average_duration;
394 u64 average_frequency;
397 struct quantiles quantiles;
399 struct time_stat_buffer __percpu *buffer;
402 void __bch2_time_stats_update(struct time_stats *stats, u64, u64);
404 static inline void bch2_time_stats_update(struct time_stats *stats, u64 start)
406 __bch2_time_stats_update(stats, start, local_clock());
409 void bch2_time_stats_to_text(struct printbuf *, struct time_stats *);
411 void bch2_time_stats_exit(struct time_stats *);
412 void bch2_time_stats_init(struct time_stats *);
414 #define ewma_add(ewma, val, weight) \
416 typeof(ewma) _ewma = (ewma); \
417 typeof(weight) _weight = (weight); \
419 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
422 struct bch_ratelimit {
423 /* Next time we want to do some work, in nanoseconds */
427 * Rate at which we want to do work, in units per nanosecond
428 * The units here correspond to the units passed to
429 * bch2_ratelimit_increment()
434 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
436 d->next = local_clock();
439 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
440 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
442 struct bch_pd_controller {
443 struct bch_ratelimit rate;
444 unsigned long last_update;
447 s64 smoothed_derivative;
449 unsigned p_term_inverse;
453 /* for exporting to sysfs (no effect on behavior) */
455 s64 last_proportional;
459 /* If true, the rate will not increase if bch2_ratelimit_delay()
460 * is not being called often enough. */
464 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
465 void bch2_pd_controller_init(struct bch_pd_controller *);
466 size_t bch2_pd_controller_print_debug(struct bch_pd_controller *, char *);
468 #define sysfs_pd_controller_attribute(name) \
469 rw_attribute(name##_rate); \
470 rw_attribute(name##_rate_bytes); \
471 rw_attribute(name##_rate_d_term); \
472 rw_attribute(name##_rate_p_term_inverse); \
473 read_attribute(name##_rate_debug)
475 #define sysfs_pd_controller_files(name) \
476 &sysfs_##name##_rate, \
477 &sysfs_##name##_rate_bytes, \
478 &sysfs_##name##_rate_d_term, \
479 &sysfs_##name##_rate_p_term_inverse, \
480 &sysfs_##name##_rate_debug
482 #define sysfs_pd_controller_show(name, var) \
484 sysfs_hprint(name##_rate, (var)->rate.rate); \
485 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
486 sysfs_print(name##_rate_d_term, (var)->d_term); \
487 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
489 if (attr == &sysfs_##name##_rate_debug) \
490 return bch2_pd_controller_print_debug(var, buf); \
493 #define sysfs_pd_controller_store(name, var) \
495 sysfs_strtoul_clamp(name##_rate, \
496 (var)->rate.rate, 1, UINT_MAX); \
497 sysfs_strtoul_clamp(name##_rate_bytes, \
498 (var)->rate.rate, 1, UINT_MAX); \
499 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
500 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
501 (var)->p_term_inverse, 1, INT_MAX); \
504 #define container_of_or_null(ptr, type, member) \
506 typeof(ptr) _ptr = ptr; \
507 _ptr ? container_of(_ptr, type, member) : NULL; \
510 /* Does linear interpolation between powers of two */
511 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
513 unsigned fract = x & ~(~0 << fract_bits);
517 x += (x * fract) >> fract_bits;
522 void bch2_bio_map(struct bio *bio, void *base, size_t);
523 int bch2_bio_alloc_pages(struct bio *, size_t, gfp_t);
525 static inline sector_t bdev_sectors(struct block_device *bdev)
527 return bdev->bd_inode->i_size >> 9;
530 #define closure_bio_submit(bio, cl) \
536 #define kthread_wait_freezable(cond) \
540 set_current_state(TASK_INTERRUPTIBLE); \
541 if (kthread_should_stop()) { \
552 set_current_state(TASK_RUNNING); \
556 size_t bch2_rand_range(size_t);
558 void memcpy_to_bio(struct bio *, struct bvec_iter, const void *);
559 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
561 static inline void memcpy_u64s_small(void *dst, const void *src,
571 static inline void __memcpy_u64s(void *dst, const void *src,
576 asm volatile("rep ; movsq"
577 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
578 : "0" (u64s), "1" (dst), "2" (src)
589 static inline void memcpy_u64s(void *dst, const void *src,
592 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
593 dst + u64s * sizeof(u64) <= src));
595 __memcpy_u64s(dst, src, u64s);
598 static inline void __memmove_u64s_down(void *dst, const void *src,
601 __memcpy_u64s(dst, src, u64s);
604 static inline void memmove_u64s_down(void *dst, const void *src,
609 __memmove_u64s_down(dst, src, u64s);
612 static inline void __memmove_u64s_up_small(void *_dst, const void *_src,
615 u64 *dst = (u64 *) _dst + u64s;
616 u64 *src = (u64 *) _src + u64s;
622 static inline void memmove_u64s_up_small(void *dst, const void *src,
627 __memmove_u64s_up_small(dst, src, u64s);
630 static inline void __memmove_u64s_up(void *_dst, const void *_src,
633 u64 *dst = (u64 *) _dst + u64s - 1;
634 u64 *src = (u64 *) _src + u64s - 1;
638 asm volatile("std ;\n"
641 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
642 : "0" (u64s), "1" (dst), "2" (src)
650 static inline void memmove_u64s_up(void *dst, const void *src,
655 __memmove_u64s_up(dst, src, u64s);
658 static inline void memmove_u64s(void *dst, const void *src,
662 __memmove_u64s_down(dst, src, u64s);
664 __memmove_u64s_up(dst, src, u64s);
667 /* Set the last few bytes up to a u64 boundary given an offset into a buffer. */
668 static inline void memset_u64s_tail(void *s, int c, unsigned bytes)
670 unsigned rem = round_up(bytes, sizeof(u64)) - bytes;
672 memset(s + bytes, c, rem);
675 void sort_cmp_size(void *base, size_t num, size_t size,
676 int (*cmp_func)(const void *, const void *, size_t),
677 void (*swap_func)(void *, void *, size_t));
679 /* just the memmove, doesn't update @_nr */
680 #define __array_insert_item(_array, _nr, _pos) \
681 memmove(&(_array)[(_pos) + 1], \
683 sizeof((_array)[0]) * ((_nr) - (_pos)))
685 #define array_insert_item(_array, _nr, _pos, _new_item) \
687 __array_insert_item(_array, _nr, _pos); \
689 (_array)[(_pos)] = (_new_item); \
692 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
694 (_nr) -= (_nr_to_remove); \
695 memmove(&(_array)[(_pos)], \
696 &(_array)[(_pos) + (_nr_to_remove)], \
697 sizeof((_array)[0]) * ((_nr) - (_pos))); \
700 #define array_remove_item(_array, _nr, _pos) \
701 array_remove_items(_array, _nr, _pos, 1)
703 #define bubble_sort(_base, _nr, _cmp) \
706 bool _swapped = true; \
708 for (_end = (ssize_t) (_nr) - 1; _end > 0 && _swapped; --_end) {\
710 for (_i = 0; _i < _end; _i++) \
711 if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) { \
712 swap((_base)[_i], (_base)[_i + 1]); \
718 static inline u64 percpu_u64_get(u64 __percpu *src)
723 for_each_possible_cpu(cpu)
724 ret += *per_cpu_ptr(src, cpu);
728 static inline void percpu_u64_set(u64 __percpu *dst, u64 src)
732 for_each_possible_cpu(cpu)
733 *per_cpu_ptr(dst, cpu) = 0;
734 this_cpu_write(*dst, src);
737 static inline void acc_u64s(u64 *acc, const u64 *src, unsigned nr)
741 for (i = 0; i < nr; i++)
745 static inline void acc_u64s_percpu(u64 *acc, const u64 __percpu *src,
750 for_each_possible_cpu(cpu)
751 acc_u64s(acc, per_cpu_ptr(src, cpu), nr);
754 static inline void percpu_memset(void __percpu *p, int c, size_t bytes)
758 for_each_possible_cpu(cpu)
759 memset(per_cpu_ptr(p, cpu), c, bytes);
762 u64 *bch2_acc_percpu_u64s(u64 __percpu *, unsigned);
764 #define cmp_int(l, r) ((l > r) - (l < r))
766 static inline int u8_cmp(u8 l, u8 r)
768 return cmp_int(l, r);
772 static inline void uuid_unparse_lower(u8 *uuid, char *out)
774 sprintf(out, "%plU", uuid);
777 #include <uuid/uuid.h>
780 #endif /* _BCACHEFS_UTIL_H */