1 /* SPDX-License-Identifier: GPL-2.0 */
6 #include <linux/blkdev.h>
7 #include <linux/errno.h>
8 #include <linux/kernel.h>
9 #include <linux/sched/clock.h>
10 #include <linux/llist.h>
11 #include <linux/ratelimit.h>
12 #include <linux/vmalloc.h>
13 #include <linux/workqueue.h>
14 #include <linux/crc64.h>
18 #define PAGE_SECTORS (PAGE_SIZE / 512)
22 #ifdef CONFIG_BCACHE_DEBUG
24 #define EBUG_ON(cond) BUG_ON(cond)
25 #define atomic_dec_bug(v) BUG_ON(atomic_dec_return(v) < 0)
26 #define atomic_inc_bug(v, i) BUG_ON(atomic_inc_return(v) <= i)
30 #define EBUG_ON(cond) do { if (cond); } while (0)
31 #define atomic_dec_bug(v) atomic_dec(v)
32 #define atomic_inc_bug(v, i) atomic_inc(v)
36 #define DECLARE_HEAP(type, name) \
42 #define init_heap(heap, _size, gfp) \
46 (heap)->size = (_size); \
47 _bytes = (heap)->size * sizeof(*(heap)->data); \
48 (heap)->data = kvmalloc(_bytes, (gfp) & GFP_KERNEL); \
52 #define free_heap(heap) \
54 kvfree((heap)->data); \
55 (heap)->data = NULL; \
58 #define heap_swap(h, i, j) swap((h)->data[i], (h)->data[j])
60 #define heap_sift(h, i, cmp) \
64 for (; _j * 2 + 1 < (h)->used; _j = _r) { \
66 if (_r + 1 < (h)->used && \
67 cmp((h)->data[_r], (h)->data[_r + 1])) \
70 if (cmp((h)->data[_r], (h)->data[_j])) \
72 heap_swap(h, _r, _j); \
76 #define heap_sift_down(h, i, cmp) \
79 size_t p = (i - 1) / 2; \
80 if (cmp((h)->data[i], (h)->data[p])) \
87 #define heap_add(h, d, cmp) \
89 bool _r = !heap_full(h); \
91 size_t _i = (h)->used++; \
94 heap_sift_down(h, _i, cmp); \
95 heap_sift(h, _i, cmp); \
100 #define heap_pop(h, d, cmp) \
102 bool _r = (h)->used; \
104 (d) = (h)->data[0]; \
106 heap_swap(h, 0, (h)->used); \
107 heap_sift(h, 0, cmp); \
112 #define heap_peek(h) ((h)->used ? (h)->data[0] : NULL)
114 #define heap_full(h) ((h)->used == (h)->size)
116 #define heap_empty(h) ((h)->used == 0)
118 #define DECLARE_FIFO(type, name) \
120 size_t front, back, size, mask; \
124 #define fifo_for_each(c, fifo, iter) \
125 for (iter = (fifo)->front; \
126 c = (fifo)->data[iter], iter != (fifo)->back; \
127 iter = (iter + 1) & (fifo)->mask)
129 #define __init_fifo(fifo, gfp) \
131 size_t _allocated_size, _bytes; \
132 BUG_ON(!(fifo)->size); \
134 _allocated_size = roundup_pow_of_two((fifo)->size + 1); \
135 _bytes = _allocated_size * sizeof(*(fifo)->data); \
137 (fifo)->mask = _allocated_size - 1; \
138 (fifo)->front = (fifo)->back = 0; \
140 (fifo)->data = kvmalloc(_bytes, (gfp) & GFP_KERNEL); \
144 #define init_fifo_exact(fifo, _size, gfp) \
146 (fifo)->size = (_size); \
147 __init_fifo(fifo, gfp); \
150 #define init_fifo(fifo, _size, gfp) \
152 (fifo)->size = (_size); \
153 if ((fifo)->size > 4) \
154 (fifo)->size = roundup_pow_of_two((fifo)->size) - 1; \
155 __init_fifo(fifo, gfp); \
158 #define free_fifo(fifo) \
160 kvfree((fifo)->data); \
161 (fifo)->data = NULL; \
164 #define fifo_used(fifo) (((fifo)->back - (fifo)->front) & (fifo)->mask)
165 #define fifo_free(fifo) ((fifo)->size - fifo_used(fifo))
167 #define fifo_empty(fifo) (!fifo_used(fifo))
168 #define fifo_full(fifo) (!fifo_free(fifo))
170 #define fifo_front(fifo) ((fifo)->data[(fifo)->front])
171 #define fifo_back(fifo) \
172 ((fifo)->data[((fifo)->back - 1) & (fifo)->mask])
174 #define fifo_idx(fifo, p) (((p) - &fifo_front(fifo)) & (fifo)->mask)
176 #define fifo_push_back(fifo, i) \
178 bool _r = !fifo_full((fifo)); \
180 (fifo)->data[(fifo)->back++] = (i); \
181 (fifo)->back &= (fifo)->mask; \
186 #define fifo_pop_front(fifo, i) \
188 bool _r = !fifo_empty((fifo)); \
190 (i) = (fifo)->data[(fifo)->front++]; \
191 (fifo)->front &= (fifo)->mask; \
196 #define fifo_push_front(fifo, i) \
198 bool _r = !fifo_full((fifo)); \
201 (fifo)->front &= (fifo)->mask; \
202 (fifo)->data[(fifo)->front] = (i); \
207 #define fifo_pop_back(fifo, i) \
209 bool _r = !fifo_empty((fifo)); \
212 (fifo)->back &= (fifo)->mask; \
213 (i) = (fifo)->data[(fifo)->back] \
218 #define fifo_push(fifo, i) fifo_push_back(fifo, (i))
219 #define fifo_pop(fifo, i) fifo_pop_front(fifo, (i))
221 #define fifo_swap(l, r) \
223 swap((l)->front, (r)->front); \
224 swap((l)->back, (r)->back); \
225 swap((l)->size, (r)->size); \
226 swap((l)->mask, (r)->mask); \
227 swap((l)->data, (r)->data); \
230 #define fifo_move(dest, src) \
232 typeof(*((dest)->data)) _t; \
233 while (!fifo_full(dest) && \
235 fifo_push(dest, _t); \
239 * Simple array based allocator - preallocates a number of elements and you can
240 * never allocate more than that, also has no locking.
242 * Handy because if you know you only need a fixed number of elements you don't
243 * have to worry about memory allocation failure, and sometimes a mempool isn't
246 * We treat the free elements as entries in a singly linked list, and the
247 * freelist as a stack - allocating and freeing push and pop off the freelist.
250 #define DECLARE_ARRAY_ALLOCATOR(type, name, size) \
256 #define array_alloc(array) \
258 typeof((array)->freelist) _ret = (array)->freelist; \
261 (array)->freelist = *((typeof((array)->freelist) *) _ret);\
266 #define array_free(array, ptr) \
268 typeof((array)->freelist) _ptr = ptr; \
270 *((typeof((array)->freelist) *) _ptr) = (array)->freelist; \
271 (array)->freelist = _ptr; \
274 #define array_allocator_init(array) \
276 typeof((array)->freelist) _i; \
278 BUILD_BUG_ON(sizeof((array)->data[0]) < sizeof(void *)); \
279 (array)->freelist = NULL; \
281 for (_i = (array)->data; \
282 _i < (array)->data + ARRAY_SIZE((array)->data); \
284 array_free(array, _i); \
287 #define array_freelist_empty(array) ((array)->freelist == NULL)
289 #define ANYSINT_MAX(t) \
290 ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
292 int bch_strtoint_h(const char *cp, int *res);
293 int bch_strtouint_h(const char *cp, unsigned int *res);
294 int bch_strtoll_h(const char *cp, long long *res);
295 int bch_strtoull_h(const char *cp, unsigned long long *res);
297 static inline int bch_strtol_h(const char *cp, long *res)
299 #if BITS_PER_LONG == 32
300 return bch_strtoint_h(cp, (int *) res);
302 return bch_strtoll_h(cp, (long long *) res);
306 static inline int bch_strtoul_h(const char *cp, long *res)
308 #if BITS_PER_LONG == 32
309 return bch_strtouint_h(cp, (unsigned int *) res);
311 return bch_strtoull_h(cp, (unsigned long long *) res);
315 #define strtoi_h(cp, res) \
316 (__builtin_types_compatible_p(typeof(*res), int) \
317 ? bch_strtoint_h(cp, (void *) res) \
318 : __builtin_types_compatible_p(typeof(*res), long) \
319 ? bch_strtol_h(cp, (void *) res) \
320 : __builtin_types_compatible_p(typeof(*res), long long) \
321 ? bch_strtoll_h(cp, (void *) res) \
322 : __builtin_types_compatible_p(typeof(*res), unsigned int) \
323 ? bch_strtouint_h(cp, (void *) res) \
324 : __builtin_types_compatible_p(typeof(*res), unsigned long) \
325 ? bch_strtoul_h(cp, (void *) res) \
326 : __builtin_types_compatible_p(typeof(*res), unsigned long long)\
327 ? bch_strtoull_h(cp, (void *) res) : -EINVAL)
329 #define strtoul_safe(cp, var) \
332 int _r = kstrtoul(cp, 10, &_v); \
338 #define strtoul_safe_clamp(cp, var, min, max) \
341 int _r = kstrtoul(cp, 10, &_v); \
343 var = clamp_t(typeof(var), _v, min, max); \
347 #define snprint(buf, size, var) \
348 snprintf(buf, size, \
349 __builtin_types_compatible_p(typeof(var), int) \
351 __builtin_types_compatible_p(typeof(var), unsigned int) \
353 __builtin_types_compatible_p(typeof(var), long) \
355 __builtin_types_compatible_p(typeof(var), unsigned long)\
357 __builtin_types_compatible_p(typeof(var), int64_t) \
359 __builtin_types_compatible_p(typeof(var), uint64_t) \
361 __builtin_types_compatible_p(typeof(var), const char *) \
362 ? "%s\n" : "%i\n", var)
364 ssize_t bch_hprint(char *buf, int64_t v);
366 bool bch_is_zero(const char *p, size_t n);
367 int bch_parse_uuid(const char *s, char *uuid);
372 * all fields are in nanoseconds, averages are ewmas stored left shifted
375 uint64_t max_duration;
376 uint64_t average_duration;
377 uint64_t average_frequency;
381 void bch_time_stats_update(struct time_stats *stats, uint64_t time);
383 static inline unsigned int local_clock_us(void)
385 return local_clock() >> 10;
388 #define NSEC_PER_ns 1L
389 #define NSEC_PER_us NSEC_PER_USEC
390 #define NSEC_PER_ms NSEC_PER_MSEC
391 #define NSEC_PER_sec NSEC_PER_SEC
393 #define __print_time_stat(stats, name, stat, units) \
394 sysfs_print(name ## _ ## stat ## _ ## units, \
395 div_u64((stats)->stat >> 8, NSEC_PER_ ## units))
397 #define sysfs_print_time_stats(stats, name, \
401 __print_time_stat(stats, name, \
402 average_frequency, frequency_units); \
403 __print_time_stat(stats, name, \
404 average_duration, duration_units); \
405 sysfs_print(name ## _ ##max_duration ## _ ## duration_units, \
406 div_u64((stats)->max_duration, \
407 NSEC_PER_ ## duration_units)); \
409 sysfs_print(name ## _last_ ## frequency_units, (stats)->last \
410 ? div_s64(local_clock() - (stats)->last, \
411 NSEC_PER_ ## frequency_units) \
415 #define sysfs_time_stats_attribute(name, \
418 read_attribute(name ## _average_frequency_ ## frequency_units); \
419 read_attribute(name ## _average_duration_ ## duration_units); \
420 read_attribute(name ## _max_duration_ ## duration_units); \
421 read_attribute(name ## _last_ ## frequency_units)
423 #define sysfs_time_stats_attribute_list(name, \
426 &sysfs_ ## name ## _average_frequency_ ## frequency_units, \
427 &sysfs_ ## name ## _average_duration_ ## duration_units, \
428 &sysfs_ ## name ## _max_duration_ ## duration_units, \
429 &sysfs_ ## name ## _last_ ## frequency_units,
431 #define ewma_add(ewma, val, weight, factor) \
433 (ewma) *= (weight) - 1; \
434 (ewma) += (val) << factor; \
435 (ewma) /= (weight); \
439 struct bch_ratelimit {
440 /* Next time we want to do some work, in nanoseconds */
444 * Rate at which we want to do work, in units per second
445 * The units here correspond to the units passed to bch_next_delay()
450 static inline void bch_ratelimit_reset(struct bch_ratelimit *d)
452 d->next = local_clock();
455 uint64_t bch_next_delay(struct bch_ratelimit *d, uint64_t done);
457 #define __DIV_SAFE(n, d, zero) \
459 typeof(n) _n = (n); \
460 typeof(d) _d = (d); \
461 _d ? _n / _d : zero; \
464 #define DIV_SAFE(n, d) __DIV_SAFE(n, d, 0)
466 #define container_of_or_null(ptr, type, member) \
468 typeof(ptr) _ptr = ptr; \
469 _ptr ? container_of(_ptr, type, member) : NULL; \
472 #define RB_INSERT(root, new, member, cmp) \
475 struct rb_node **n = &(root)->rb_node, *parent = NULL; \
481 this = container_of(*n, typeof(*(new)), member); \
482 res = cmp(new, this); \
490 rb_link_node(&(new)->member, parent, n); \
491 rb_insert_color(&(new)->member, root); \
497 #define RB_SEARCH(root, search, member, cmp) \
499 struct rb_node *n = (root)->rb_node; \
500 typeof(&(search)) this, ret = NULL; \
504 this = container_of(n, typeof(search), member); \
505 res = cmp(&(search), this); \
517 #define RB_GREATER(root, search, member, cmp) \
519 struct rb_node *n = (root)->rb_node; \
520 typeof(&(search)) this, ret = NULL; \
524 this = container_of(n, typeof(search), member); \
525 res = cmp(&(search), this); \
535 #define RB_FIRST(root, type, member) \
536 container_of_or_null(rb_first(root), type, member)
538 #define RB_LAST(root, type, member) \
539 container_of_or_null(rb_last(root), type, member)
541 #define RB_NEXT(ptr, member) \
542 container_of_or_null(rb_next(&(ptr)->member), typeof(*ptr), member)
544 #define RB_PREV(ptr, member) \
545 container_of_or_null(rb_prev(&(ptr)->member), typeof(*ptr), member)
547 static inline uint64_t bch_crc64(const void *p, size_t len)
549 uint64_t crc = 0xffffffffffffffffULL;
551 crc = crc64_be(crc, p, len);
552 return crc ^ 0xffffffffffffffffULL;
555 static inline uint64_t bch_crc64_update(uint64_t crc,
559 crc = crc64_be(crc, p, len);
563 /* Does linear interpolation between powers of two */
564 static inline unsigned int fract_exp_two(unsigned int x,
565 unsigned int fract_bits)
567 unsigned int fract = x & ~(~0 << fract_bits);
571 x += (x * fract) >> fract_bits;
576 void bch_bio_map(struct bio *bio, void *base);
577 int bch_bio_alloc_pages(struct bio *bio, gfp_t gfp_mask);
579 static inline sector_t bdev_sectors(struct block_device *bdev)
581 return bdev->bd_inode->i_size >> 9;
583 #endif /* _BCACHE_UTIL_H */