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 if ((_i) < (h)->used) { \
214 heap_swap(h, _i, (h)->used, set_backpointer); \
215 heap_sift_up(h, _i, cmp, set_backpointer); \
216 heap_sift_down(h, _i, cmp, set_backpointer); \
220 #define heap_pop(h, d, cmp, set_backpointer) \
222 bool _r = (h)->used; \
224 (d) = (h)->data[0]; \
225 heap_del(h, 0, cmp, set_backpointer); \
230 #define heap_resort(heap, cmp, set_backpointer) \
233 for (_i = (ssize_t) (heap)->used / 2 - 1; _i >= 0; --_i) \
234 heap_sift_down(heap, _i, cmp, set_backpointer); \
237 #define ANYSINT_MAX(t) \
238 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
240 enum printbuf_units {
242 PRINTBUF_UNITS_BYTES,
243 PRINTBUF_UNITS_HUMAN_READABLE,
250 unsigned last_newline;
253 enum printbuf_units units:8;
255 bool allocation_failure:1;
260 #define PRINTBUF ((struct printbuf) { NULL })
262 static inline void printbuf_exit(struct printbuf *buf)
265 buf->buf = ERR_PTR(-EINTR); /* poison value */
268 static inline void printbuf_reset(struct printbuf *buf)
271 buf->last_newline = 0;
277 static inline size_t printbuf_remaining(struct printbuf *buf)
279 return buf->size - buf->pos;
282 static inline size_t printbuf_linelen(struct printbuf *buf)
284 return buf->pos - buf->last_newline;
287 void bch2_pr_buf(struct printbuf *out, const char *fmt, ...)
288 __attribute__ ((format (printf, 2, 3)));
290 #define pr_buf(_out, ...) bch2_pr_buf(_out, __VA_ARGS__)
292 static inline void pr_char(struct printbuf *out, char c)
294 bch2_pr_buf(out, "%c", c);
297 static inline void pr_indent_push(struct printbuf *buf, unsigned spaces)
299 buf->indent += spaces;
304 static inline void pr_indent_pop(struct printbuf *buf, unsigned spaces)
306 if (buf->last_newline + buf->indent == buf->pos) {
308 buf->buf[buf->pos] = '\0';
310 buf->indent -= spaces;
313 static inline void pr_newline(struct printbuf *buf)
319 buf->last_newline = buf->pos;
321 for (i = 0; i < buf->indent; i++)
324 buf->last_field = buf->pos;
328 static inline void pr_tab(struct printbuf *buf)
330 BUG_ON(buf->tabstop > ARRAY_SIZE(buf->tabstops));
332 while (printbuf_remaining(buf) > 1 &&
333 printbuf_linelen(buf) < buf->tabstops[buf->tabstop])
336 buf->last_field = buf->pos;
340 void bch2_pr_tab_rjust(struct printbuf *);
342 static inline void pr_tab_rjust(struct printbuf *buf)
344 bch2_pr_tab_rjust(buf);
347 void bch2_pr_units(struct printbuf *, s64, s64);
348 #define pr_units(...) bch2_pr_units(__VA_ARGS__)
350 static inline void pr_sectors(struct printbuf *out, u64 v)
352 bch2_pr_units(out, v, v << 9);
356 static inline void pr_time(struct printbuf *out, u64 time)
358 pr_buf(out, "%llu", time);
362 static inline void pr_time(struct printbuf *out, u64 _time)
366 struct tm *tm = localtime(&time);
367 size_t err = strftime(time_str, sizeof(time_str), "%c", tm);
369 pr_buf(out, "(formatting error)");
371 pr_buf(out, "%s", time_str);
376 static inline void uuid_unparse_lower(u8 *uuid, char *out)
378 sprintf(out, "%pUb", uuid);
381 #include <uuid/uuid.h>
384 static inline void pr_uuid(struct printbuf *out, u8 *uuid)
388 uuid_unparse_lower(uuid, uuid_str);
389 pr_buf(out, "%s", uuid_str);
392 int bch2_strtoint_h(const char *, int *);
393 int bch2_strtouint_h(const char *, unsigned int *);
394 int bch2_strtoll_h(const char *, long long *);
395 int bch2_strtoull_h(const char *, unsigned long long *);
396 int bch2_strtou64_h(const char *, u64 *);
398 static inline int bch2_strtol_h(const char *cp, long *res)
400 #if BITS_PER_LONG == 32
401 return bch2_strtoint_h(cp, (int *) res);
403 return bch2_strtoll_h(cp, (long long *) res);
407 static inline int bch2_strtoul_h(const char *cp, long *res)
409 #if BITS_PER_LONG == 32
410 return bch2_strtouint_h(cp, (unsigned int *) res);
412 return bch2_strtoull_h(cp, (unsigned long long *) res);
416 #define strtoi_h(cp, res) \
417 ( type_is(*res, int) ? bch2_strtoint_h(cp, (void *) res)\
418 : type_is(*res, long) ? bch2_strtol_h(cp, (void *) res)\
419 : type_is(*res, long long) ? bch2_strtoll_h(cp, (void *) res)\
420 : type_is(*res, unsigned) ? bch2_strtouint_h(cp, (void *) res)\
421 : type_is(*res, unsigned long) ? bch2_strtoul_h(cp, (void *) res)\
422 : type_is(*res, unsigned long long) ? bch2_strtoull_h(cp, (void *) res)\
425 #define strtoul_safe(cp, var) \
428 int _r = kstrtoul(cp, 10, &_v); \
434 #define strtoul_safe_clamp(cp, var, min, max) \
437 int _r = kstrtoul(cp, 10, &_v); \
439 var = clamp_t(typeof(var), _v, min, max); \
443 #define strtoul_safe_restrict(cp, var, min, max) \
446 int _r = kstrtoul(cp, 10, &_v); \
447 if (!_r && _v >= min && _v <= max) \
454 #define snprint(out, var) \
456 type_is(var, int) ? "%i\n" \
457 : type_is(var, unsigned) ? "%u\n" \
458 : type_is(var, long) ? "%li\n" \
459 : type_is(var, unsigned long) ? "%lu\n" \
460 : type_is(var, s64) ? "%lli\n" \
461 : type_is(var, u64) ? "%llu\n" \
462 : type_is(var, char *) ? "%s\n" \
465 void bch2_hprint(struct printbuf *, s64);
467 bool bch2_is_zero(const void *, size_t);
469 void bch2_string_opt_to_text(struct printbuf *,
470 const char * const [], size_t);
472 void bch2_flags_to_text(struct printbuf *, const char * const[], u64);
473 u64 bch2_read_flag_list(char *, const char * const[]);
475 #define NR_QUANTILES 15
476 #define QUANTILE_IDX(i) inorder_to_eytzinger0(i, NR_QUANTILES)
477 #define QUANTILE_FIRST eytzinger0_first(NR_QUANTILES)
478 #define QUANTILE_LAST eytzinger0_last(NR_QUANTILES)
481 struct quantile_entry {
484 } entries[NR_QUANTILES];
487 struct time_stat_buffer {
489 struct time_stat_buffer_entry {
498 /* all fields are in nanoseconds */
499 u64 average_duration;
500 u64 average_frequency;
503 struct quantiles quantiles;
505 struct time_stat_buffer __percpu *buffer;
508 void __bch2_time_stats_update(struct time_stats *stats, u64, u64);
510 static inline void bch2_time_stats_update(struct time_stats *stats, u64 start)
512 __bch2_time_stats_update(stats, start, local_clock());
515 void bch2_time_stats_to_text(struct printbuf *, struct time_stats *);
517 void bch2_time_stats_exit(struct time_stats *);
518 void bch2_time_stats_init(struct time_stats *);
520 #define ewma_add(ewma, val, weight) \
522 typeof(ewma) _ewma = (ewma); \
523 typeof(weight) _weight = (weight); \
525 (((_ewma << _weight) - _ewma) + (val)) >> _weight; \
528 struct bch_ratelimit {
529 /* Next time we want to do some work, in nanoseconds */
533 * Rate at which we want to do work, in units per nanosecond
534 * The units here correspond to the units passed to
535 * bch2_ratelimit_increment()
540 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
542 d->next = local_clock();
545 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
546 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
548 struct bch_pd_controller {
549 struct bch_ratelimit rate;
550 unsigned long last_update;
553 s64 smoothed_derivative;
555 unsigned p_term_inverse;
559 /* for exporting to sysfs (no effect on behavior) */
561 s64 last_proportional;
565 /* If true, the rate will not increase if bch2_ratelimit_delay()
566 * is not being called often enough. */
570 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
571 void bch2_pd_controller_init(struct bch_pd_controller *);
572 void bch2_pd_controller_debug_to_text(struct printbuf *, struct bch_pd_controller *);
574 #define sysfs_pd_controller_attribute(name) \
575 rw_attribute(name##_rate); \
576 rw_attribute(name##_rate_bytes); \
577 rw_attribute(name##_rate_d_term); \
578 rw_attribute(name##_rate_p_term_inverse); \
579 read_attribute(name##_rate_debug)
581 #define sysfs_pd_controller_files(name) \
582 &sysfs_##name##_rate, \
583 &sysfs_##name##_rate_bytes, \
584 &sysfs_##name##_rate_d_term, \
585 &sysfs_##name##_rate_p_term_inverse, \
586 &sysfs_##name##_rate_debug
588 #define sysfs_pd_controller_show(name, var) \
590 sysfs_hprint(name##_rate, (var)->rate.rate); \
591 sysfs_print(name##_rate_bytes, (var)->rate.rate); \
592 sysfs_print(name##_rate_d_term, (var)->d_term); \
593 sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
595 if (attr == &sysfs_##name##_rate_debug) \
596 bch2_pd_controller_debug_to_text(out, var); \
599 #define sysfs_pd_controller_store(name, var) \
601 sysfs_strtoul_clamp(name##_rate, \
602 (var)->rate.rate, 1, UINT_MAX); \
603 sysfs_strtoul_clamp(name##_rate_bytes, \
604 (var)->rate.rate, 1, UINT_MAX); \
605 sysfs_strtoul(name##_rate_d_term, (var)->d_term); \
606 sysfs_strtoul_clamp(name##_rate_p_term_inverse, \
607 (var)->p_term_inverse, 1, INT_MAX); \
610 #define container_of_or_null(ptr, type, member) \
612 typeof(ptr) _ptr = ptr; \
613 _ptr ? container_of(_ptr, type, member) : NULL; \
616 /* Does linear interpolation between powers of two */
617 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
619 unsigned fract = x & ~(~0 << fract_bits);
623 x += (x * fract) >> fract_bits;
628 void bch2_bio_map(struct bio *bio, void *base, size_t);
629 int bch2_bio_alloc_pages(struct bio *, size_t, gfp_t);
631 static inline sector_t bdev_sectors(struct block_device *bdev)
633 return bdev->bd_inode->i_size >> 9;
636 #define closure_bio_submit(bio, cl) \
642 #define kthread_wait_freezable(cond) \
646 set_current_state(TASK_INTERRUPTIBLE); \
647 if (kthread_should_stop()) { \
658 set_current_state(TASK_RUNNING); \
662 size_t bch2_rand_range(size_t);
664 void memcpy_to_bio(struct bio *, struct bvec_iter, const void *);
665 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
667 static inline void memcpy_u64s_small(void *dst, const void *src,
677 static inline void __memcpy_u64s(void *dst, const void *src,
682 asm volatile("rep ; movsq"
683 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
684 : "0" (u64s), "1" (dst), "2" (src)
695 static inline void memcpy_u64s(void *dst, const void *src,
698 EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
699 dst + u64s * sizeof(u64) <= src));
701 __memcpy_u64s(dst, src, u64s);
704 static inline void __memmove_u64s_down(void *dst, const void *src,
707 __memcpy_u64s(dst, src, u64s);
710 static inline void memmove_u64s_down(void *dst, const void *src,
715 __memmove_u64s_down(dst, src, u64s);
718 static inline void __memmove_u64s_up_small(void *_dst, const void *_src,
721 u64 *dst = (u64 *) _dst + u64s;
722 u64 *src = (u64 *) _src + u64s;
728 static inline void memmove_u64s_up_small(void *dst, const void *src,
733 __memmove_u64s_up_small(dst, src, u64s);
736 static inline void __memmove_u64s_up(void *_dst, const void *_src,
739 u64 *dst = (u64 *) _dst + u64s - 1;
740 u64 *src = (u64 *) _src + u64s - 1;
744 asm volatile("std ;\n"
747 : "=&c" (d0), "=&D" (d1), "=&S" (d2)
748 : "0" (u64s), "1" (dst), "2" (src)
756 static inline void memmove_u64s_up(void *dst, const void *src,
761 __memmove_u64s_up(dst, src, u64s);
764 static inline void memmove_u64s(void *dst, const void *src,
768 __memmove_u64s_down(dst, src, u64s);
770 __memmove_u64s_up(dst, src, u64s);
773 /* Set the last few bytes up to a u64 boundary given an offset into a buffer. */
774 static inline void memset_u64s_tail(void *s, int c, unsigned bytes)
776 unsigned rem = round_up(bytes, sizeof(u64)) - bytes;
778 memset(s + bytes, c, rem);
781 void sort_cmp_size(void *base, size_t num, size_t size,
782 int (*cmp_func)(const void *, const void *, size_t),
783 void (*swap_func)(void *, void *, size_t));
785 /* just the memmove, doesn't update @_nr */
786 #define __array_insert_item(_array, _nr, _pos) \
787 memmove(&(_array)[(_pos) + 1], \
789 sizeof((_array)[0]) * ((_nr) - (_pos)))
791 #define array_insert_item(_array, _nr, _pos, _new_item) \
793 __array_insert_item(_array, _nr, _pos); \
795 (_array)[(_pos)] = (_new_item); \
798 #define array_remove_items(_array, _nr, _pos, _nr_to_remove) \
800 (_nr) -= (_nr_to_remove); \
801 memmove(&(_array)[(_pos)], \
802 &(_array)[(_pos) + (_nr_to_remove)], \
803 sizeof((_array)[0]) * ((_nr) - (_pos))); \
806 #define array_remove_item(_array, _nr, _pos) \
807 array_remove_items(_array, _nr, _pos, 1)
809 static inline void __move_gap(void *array, size_t element_size,
810 size_t nr, size_t size,
811 size_t old_gap, size_t new_gap)
813 size_t gap_end = old_gap + size - nr;
815 if (new_gap < old_gap) {
816 size_t move = old_gap - new_gap;
818 memmove(array + element_size * (gap_end - move),
819 array + element_size * (old_gap - move),
820 element_size * move);
821 } else if (new_gap > old_gap) {
822 size_t move = new_gap - old_gap;
824 memmove(array + element_size * old_gap,
825 array + element_size * gap_end,
826 element_size * move);
830 /* Move the gap in a gap buffer: */
831 #define move_gap(_array, _nr, _size, _old_gap, _new_gap) \
832 __move_gap(_array, sizeof(_array[0]), _nr, _size, _old_gap, _new_gap)
834 #define bubble_sort(_base, _nr, _cmp) \
837 bool _swapped = true; \
839 for (_end = (ssize_t) (_nr) - 1; _end > 0 && _swapped; --_end) {\
841 for (_i = 0; _i < _end; _i++) \
842 if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) { \
843 swap((_base)[_i], (_base)[_i + 1]); \
849 static inline u64 percpu_u64_get(u64 __percpu *src)
854 for_each_possible_cpu(cpu)
855 ret += *per_cpu_ptr(src, cpu);
859 static inline void percpu_u64_set(u64 __percpu *dst, u64 src)
863 for_each_possible_cpu(cpu)
864 *per_cpu_ptr(dst, cpu) = 0;
865 this_cpu_write(*dst, src);
868 static inline void acc_u64s(u64 *acc, const u64 *src, unsigned nr)
872 for (i = 0; i < nr; i++)
876 static inline void acc_u64s_percpu(u64 *acc, const u64 __percpu *src,
881 for_each_possible_cpu(cpu)
882 acc_u64s(acc, per_cpu_ptr(src, cpu), nr);
885 static inline void percpu_memset(void __percpu *p, int c, size_t bytes)
889 for_each_possible_cpu(cpu)
890 memset(per_cpu_ptr(p, cpu), c, bytes);
893 u64 *bch2_acc_percpu_u64s(u64 __percpu *, unsigned);
895 #define cmp_int(l, r) ((l > r) - (l < r))
897 static inline int u8_cmp(u8 l, u8 r)
899 return cmp_int(l, r);
902 #endif /* _BCACHEFS_UTIL_H */