git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/util.h

   1 #ifndef _BCACHEFS_UTIL_H
   2 #define _BCACHEFS_UTIL_H
   3
   4 #include <linux/bio.h>
   5 #include <linux/blkdev.h>
   6 #include <linux/closure.h>
   7 #include <linux/errno.h>
   8 #include <linux/freezer.h>
   9 #include <linux/kernel.h>
  10 #include <linux/sched/clock.h>
  11 #include <linux/llist.h>
  12 #include <linux/log2.h>
  13 #include <linux/ratelimit.h>
  14 #include <linux/slab.h>
  15 #include <linux/vmalloc.h>
  16 #include <linux/workqueue.h>
  17
  18 #define PAGE_SECTOR_SHIFT       (PAGE_SHIFT - 9)
  19 #define PAGE_SECTORS            (1UL << PAGE_SECTOR_SHIFT)
  20
  21 struct closure;
  22
  23 #ifdef CONFIG_BCACHEFS_DEBUG
  24
  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)
  36
  37 #define memcpy(dst, src, len)                                           \
  38 ({                                                                      \
  39         void *_dst = (dst);                                             \
  40         const void *_src = (src);                                       \
  41         size_t _len = (len);                                            \
  42                                                                         \
  43         BUG_ON(!((void *) (_dst) >= (void *) (_src) + (_len) ||         \
  44                  (void *) (_dst) + (_len) <= (void *) (_src)));         \
  45         memcpy(_dst, _src, _len);                                       \
  46 })
  47
  48 #else /* DEBUG */
  49
  50 #define EBUG_ON(cond)
  51 #define atomic_dec_bug(v)       atomic_dec(v)
  52 #define atomic_inc_bug(v, i)    atomic_inc(v)
  53 #define atomic_sub_bug(i, v)    atomic_sub(i, v)
  54 #define atomic_add_bug(i, v)    atomic_add(i, v)
  55 #define atomic_long_dec_bug(v)          atomic_long_dec(v)
  56 #define atomic_long_sub_bug(i, v)       atomic_long_sub(i, v)
  57 #define atomic64_dec_bug(v)     atomic64_dec(v)
  58 #define atomic64_inc_bug(v, i)  atomic64_inc(v)
  59 #define atomic64_sub_bug(i, v)  atomic64_sub(i, v)
  60 #define atomic64_add_bug(i, v)  atomic64_add(i, v)
  61
  62 #endif
  63
  64 #ifndef __CHECKER__
  65 #define __flatten __attribute__((flatten))
  66 #else
  67 /* sparse doesn't know about attribute((flatten)) */
  68 #define __flatten
  69 #endif
  70
  71 #ifdef __LITTLE_ENDIAN
  72 #define CPU_BIG_ENDIAN          0
  73 #else
  74 #define CPU_BIG_ENDIAN          1
  75 #endif
  76
  77 /* type hackery */
  78
  79 #define type_is_exact(_val, _type)                                      \
  80         __builtin_types_compatible_p(typeof(_val), _type)
  81
  82 #define type_is(_val, _type)                                            \
  83         (__builtin_types_compatible_p(typeof(_val), _type) ||           \
  84          __builtin_types_compatible_p(typeof(_val), const _type))
  85
  86 static inline void vpfree(void *p, size_t size)
  87 {
  88         if (is_vmalloc_addr(p))
  89                 vfree(p);
  90         else
  91                 free_pages((unsigned long) p, get_order(size));
  92 }
  93
  94 static inline void *vpmalloc(size_t size, gfp_t gfp_mask)
  95 {
  96         return (void *) __get_free_pages(gfp_mask|__GFP_NOWARN,
  97                                          get_order(size)) ?:
  98                 __vmalloc(size, gfp_mask, PAGE_KERNEL);
  99 }
 100
 101 static inline void kvpfree(void *p, size_t size)
 102 {
 103         if (size < PAGE_SIZE)
 104                 kfree(p);
 105         else
 106                 vpfree(p, size);
 107 }
 108
 109 static inline void *kvpmalloc(size_t size, gfp_t gfp_mask)
 110 {
 111         return size < PAGE_SIZE
 112                 ? kmalloc(size, gfp_mask)
 113                 : vpmalloc(size, gfp_mask);
 114 }
 115
 116 void mempool_free_vp(void *element, void *pool_data);
 117 void *mempool_alloc_vp(gfp_t gfp_mask, void *pool_data);
 118
 119 static inline int mempool_init_vp_pool(mempool_t *pool, int min_nr, size_t size)
 120 {
 121         return mempool_init(pool, min_nr, mempool_alloc_vp,
 122                             mempool_free_vp, (void *) size);
 123 }
 124
 125 #define HEAP(type)                                                      \
 126 struct {                                                                \
 127         size_t size, used;                                              \
 128         type *data;                                                     \
 129 }
 130
 131 #define DECLARE_HEAP(type, name) HEAP(type) name
 132
 133 #define init_heap(heap, _size, gfp)                                     \
 134 ({                                                                      \
 135         (heap)->used = 0;                                               \
 136         (heap)->size = (_size);                                         \
 137         (heap)->data = kvpmalloc((heap)->size * sizeof((heap)->data[0]),\
 138                                  (gfp));                                \
 139 })
 140
 141 #define free_heap(heap)                                                 \
 142 do {                                                                    \
 143         kvpfree((heap)->data, (heap)->size * sizeof((heap)->data[0]));  \
 144         (heap)->data = NULL;                                            \
 145 } while (0)
 146
 147 #define heap_swap(h, i, j)      swap((h)->data[i], (h)->data[j])
 148
 149 #define heap_peek(h)                                                    \
 150 ({                                                                      \
 151         EBUG_ON(!(h)->used);                                            \
 152         (h)->data[0];                                                   \
 153 })
 154
 155 #define heap_full(h)    ((h)->used == (h)->size)
 156
 157 #define heap_sift_down(h, i, cmp)                                       \
 158 do {                                                                    \
 159         size_t _c, _j = i;                                              \
 160                                                                         \
 161         for (; _j * 2 + 1 < (h)->used; _j = _c) {                       \
 162                 _c = _j * 2 + 1;                                        \
 163                 if (_c + 1 < (h)->used &&                               \
 164                     cmp(h, (h)->data[_c], (h)->data[_c + 1]) >= 0)      \
 165                         _c++;                                           \
 166                                                                         \
 167                 if (cmp(h, (h)->data[_c], (h)->data[_j]) >= 0)          \
 168                         break;                                          \
 169                 heap_swap(h, _c, _j);                                   \
 170         }                                                               \
 171 } while (0)
 172
 173 #define heap_sift_up(h, i, cmp)                                         \
 174 do {                                                                    \
 175         while (i) {                                                     \
 176                 size_t p = (i - 1) / 2;                                 \
 177                 if (cmp(h, (h)->data[i], (h)->data[p]) >= 0)            \
 178                         break;                                          \
 179                 heap_swap(h, i, p);                                     \
 180                 i = p;                                                  \
 181         }                                                               \
 182 } while (0)
 183
 184 #define heap_add(h, new, cmp)                                           \
 185 ({                                                                      \
 186         bool _r = !heap_full(h);                                        \
 187         if (_r) {                                                       \
 188                 size_t _i = (h)->used++;                                \
 189                 (h)->data[_i] = new;                                    \
 190                                                                         \
 191                 heap_sift_up(h, _i, cmp);                               \
 192         }                                                               \
 193         _r;                                                             \
 194 })
 195
 196 #define heap_add_or_replace(h, new, cmp)                                \
 197 do {                                                                    \
 198         if (!heap_add(h, new, cmp) &&                                   \
 199             cmp(h, new, heap_peek(h)) >= 0) {                           \
 200                 (h)->data[0] = new;                                     \
 201                 heap_sift_down(h, 0, cmp);                              \
 202         }                                                               \
 203 } while (0)
 204
 205 #define heap_del(h, i, cmp)                                             \
 206 do {                                                                    \
 207         size_t _i = (i);                                                \
 208                                                                         \
 209         BUG_ON(_i >= (h)->used);                                        \
 210         (h)->used--;                                                    \
 211         heap_swap(h, _i, (h)->used);                                    \
 212         heap_sift_up(h, _i, cmp);                                       \
 213         heap_sift_down(h, _i, cmp);                                     \
 214 } while (0)
 215
 216 #define heap_pop(h, d, cmp)                                             \
 217 ({                                                                      \
 218         bool _r = (h)->used;                                            \
 219         if (_r) {                                                       \
 220                 (d) = (h)->data[0];                                     \
 221                 heap_del(h, 0, cmp);                                    \
 222         }                                                               \
 223         _r;                                                             \
 224 })
 225
 226 #define heap_resort(heap, cmp)                                          \
 227 do {                                                                    \
 228         ssize_t _i;                                                     \
 229         for (_i = (ssize_t) (heap)->used / 2 -  1; _i >= 0; --_i)       \
 230                 heap_sift_down(heap, _i, cmp);                          \
 231 } while (0)
 232
 233 /*
 234  * Simple array based allocator - preallocates a number of elements and you can
 235  * never allocate more than that, also has no locking.
 236  *
 237  * Handy because if you know you only need a fixed number of elements you don't
 238  * have to worry about memory allocation failure, and sometimes a mempool isn't
 239  * what you want.
 240  *
 241  * We treat the free elements as entries in a singly linked list, and the
 242  * freelist as a stack - allocating and freeing push and pop off the freelist.
 243  */
 244
 245 #define DECLARE_ARRAY_ALLOCATOR(type, name, size)                       \
 246         struct {                                                        \
 247                 type    *freelist;                                      \
 248                 type    data[size];                                     \
 249         } name
 250
 251 #define array_alloc(array)                                              \
 252 ({                                                                      \
 253         typeof((array)->freelist) _ret = (array)->freelist;             \
 254                                                                         \
 255         if (_ret)                                                       \
 256                 (array)->freelist = *((typeof((array)->freelist) *) _ret);\
 257                                                                         \
 258         _ret;                                                           \
 259 })
 260
 261 #define array_free(array, ptr)                                          \
 262 do {                                                                    \
 263         typeof((array)->freelist) _ptr = ptr;                           \
 264                                                                         \
 265         *((typeof((array)->freelist) *) _ptr) = (array)->freelist;      \
 266         (array)->freelist = _ptr;                                       \
 267 } while (0)
 268
 269 #define array_allocator_init(array)                                     \
 270 do {                                                                    \
 271         typeof((array)->freelist) _i;                                   \
 272                                                                         \
 273         BUILD_BUG_ON(sizeof((array)->data[0]) < sizeof(void *));        \
 274         (array)->freelist = NULL;                                       \
 275                                                                         \
 276         for (_i = (array)->data;                                        \
 277              _i < (array)->data + ARRAY_SIZE((array)->data);            \
 278              _i++)                                                      \
 279                 array_free(array, _i);                                  \
 280 } while (0)
 281
 282 #define array_freelist_empty(array)     ((array)->freelist == NULL)
 283
 284 #define ANYSINT_MAX(t)                                                  \
 285         ((((t) 1 << (sizeof(t) * 8 - 2)) - (t) 1) * (t) 2 + (t) 1)
 286
 287 int bch2_strtoint_h(const char *, int *);
 288 int bch2_strtouint_h(const char *, unsigned int *);
 289 int bch2_strtoll_h(const char *, long long *);
 290 int bch2_strtoull_h(const char *, unsigned long long *);
 291
 292 static inline int bch2_strtol_h(const char *cp, long *res)
 293 {
 294 #if BITS_PER_LONG == 32
 295         return bch2_strtoint_h(cp, (int *) res);
 296 #else
 297         return bch2_strtoll_h(cp, (long long *) res);
 298 #endif
 299 }
 300
 301 static inline int bch2_strtoul_h(const char *cp, long *res)
 302 {
 303 #if BITS_PER_LONG == 32
 304         return bch2_strtouint_h(cp, (unsigned int *) res);
 305 #else
 306         return bch2_strtoull_h(cp, (unsigned long long *) res);
 307 #endif
 308 }
 309
 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)\
 317         : -EINVAL)
 318
 319 #define strtoul_safe(cp, var)                                           \
 320 ({                                                                      \
 321         unsigned long _v;                                               \
 322         int _r = kstrtoul(cp, 10, &_v);                                 \
 323         if (!_r)                                                        \
 324                 var = _v;                                               \
 325         _r;                                                             \
 326 })
 327
 328 #define strtoul_safe_clamp(cp, var, min, max)                           \
 329 ({                                                                      \
 330         unsigned long _v;                                               \
 331         int _r = kstrtoul(cp, 10, &_v);                                 \
 332         if (!_r)                                                        \
 333                 var = clamp_t(typeof(var), _v, min, max);               \
 334         _r;                                                             \
 335 })
 336
 337 #define strtoul_safe_restrict(cp, var, min, max)                        \
 338 ({                                                                      \
 339         unsigned long _v;                                               \
 340         int _r = kstrtoul(cp, 10, &_v);                                 \
 341         if (!_r && _v >= min && _v <= max)                              \
 342                 var = _v;                                               \
 343         else                                                            \
 344                 _r = -EINVAL;                                           \
 345         _r;                                                             \
 346 })
 347
 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"                \
 357                  : "%i\n", var)
 358
 359 ssize_t bch2_hprint(char *buf, s64 v);
 360
 361 bool bch2_is_zero(const void *, size_t);
 362
 363 ssize_t bch2_scnprint_string_list(char *, size_t, const char * const[], size_t);
 364
 365 ssize_t bch2_read_string_list(const char *, const char * const[]);
 366
 367 ssize_t bch2_scnprint_flag_list(char *, size_t, const char * const[], u64);
 368 u64 bch2_read_flag_list(char *, const char * const[]);
 369
 370 struct time_stats {
 371         spinlock_t      lock;
 372         u64             count;
 373         /*
 374          * all fields are in nanoseconds, averages are ewmas stored left shifted
 375          * by 8
 376          */
 377         u64             last_duration;
 378         u64             max_duration;
 379         u64             average_duration;
 380         u64             average_frequency;
 381         u64             last;
 382 };
 383
 384 void bch2_time_stats_clear(struct time_stats *stats);
 385 void __bch2_time_stats_update(struct time_stats *stats, u64 time);
 386 void bch2_time_stats_update(struct time_stats *stats, u64 time);
 387
 388 static inline unsigned local_clock_us(void)
 389 {
 390         return local_clock() >> 10;
 391 }
 392
 393 #define NSEC_PER_ns                     1L
 394 #define NSEC_PER_us                     NSEC_PER_USEC
 395 #define NSEC_PER_ms                     NSEC_PER_MSEC
 396 #define NSEC_PER_sec                    NSEC_PER_SEC
 397
 398 #define __print_time_stat(stats, name, stat, units)                     \
 399         sysfs_print(name ## _ ## stat ## _ ## units,                    \
 400                     div_u64((stats)->stat >> 8, NSEC_PER_ ## units))
 401
 402 #define sysfs_print_time_stats(stats, name,                             \
 403                                frequency_units,                         \
 404                                duration_units)                          \
 405 do {                                                                    \
 406         __print_time_stat(stats, name,                                  \
 407                           average_frequency,    frequency_units);       \
 408         __print_time_stat(stats, name,                                  \
 409                           average_duration,     duration_units);        \
 410         sysfs_print(name ## _ ##count, (stats)->count);                 \
 411         sysfs_print(name ## _ ##last_duration ## _ ## duration_units,   \
 412                         div_u64((stats)->last_duration,                 \
 413                                 NSEC_PER_ ## duration_units));          \
 414         sysfs_print(name ## _ ##max_duration ## _ ## duration_units,    \
 415                         div_u64((stats)->max_duration,                  \
 416                                 NSEC_PER_ ## duration_units));          \
 417                                                                         \
 418         sysfs_print(name ## _last_ ## frequency_units, (stats)->last    \
 419                     ? div_s64(local_clock() - (stats)->last,            \
 420                               NSEC_PER_ ## frequency_units)             \
 421                     : -1LL);                                            \
 422 } while (0)
 423
 424 #define sysfs_clear_time_stats(stats, name)                             \
 425 do {                                                                    \
 426         if (attr == &sysfs_ ## name ## _clear)                          \
 427                 bch2_time_stats_clear(stats);                           \
 428 } while (0)
 429
 430 #define sysfs_time_stats_attribute(name,                                \
 431                                    frequency_units,                     \
 432                                    duration_units)                      \
 433 write_attribute(name ## _clear);                                        \
 434 read_attribute(name ## _count);                                         \
 435 read_attribute(name ## _average_frequency_ ## frequency_units);         \
 436 read_attribute(name ## _average_duration_ ## duration_units);           \
 437 read_attribute(name ## _last_duration_ ## duration_units);              \
 438 read_attribute(name ## _max_duration_ ## duration_units);               \
 439 read_attribute(name ## _last_ ## frequency_units)
 440
 441 #define sysfs_time_stats_attribute_list(name,                           \
 442                                         frequency_units,                \
 443                                         duration_units)                 \
 444 &sysfs_ ## name ## _clear,                                              \
 445 &sysfs_ ## name ## _count,                                              \
 446 &sysfs_ ## name ## _average_frequency_ ## frequency_units,              \
 447 &sysfs_ ## name ## _average_duration_ ## duration_units,                \
 448 &sysfs_ ## name ## _last_duration_ ## duration_units,                   \
 449 &sysfs_ ## name ## _max_duration_ ## duration_units,                    \
 450 &sysfs_ ## name ## _last_ ## frequency_units,
 451
 452 #define ewma_add(ewma, val, weight)                                     \
 453 ({                                                                      \
 454         typeof(ewma) _ewma = (ewma);                                    \
 455         typeof(weight) _weight = (weight);                              \
 456                                                                         \
 457         (((_ewma << _weight) - _ewma) + (val)) >> _weight;              \
 458 })
 459
 460 struct bch_ratelimit {
 461         /* Next time we want to do some work, in nanoseconds */
 462         u64                     next;
 463
 464         /*
 465          * Rate at which we want to do work, in units per nanosecond
 466          * The units here correspond to the units passed to
 467          * bch2_ratelimit_increment()
 468          */
 469         unsigned                rate;
 470 };
 471
 472 static inline void bch2_ratelimit_reset(struct bch_ratelimit *d)
 473 {
 474         d->next = local_clock();
 475 }
 476
 477 u64 bch2_ratelimit_delay(struct bch_ratelimit *);
 478 void bch2_ratelimit_increment(struct bch_ratelimit *, u64);
 479 int bch2_ratelimit_wait_freezable_stoppable(struct bch_ratelimit *);
 480
 481 struct bch_pd_controller {
 482         struct bch_ratelimit    rate;
 483         unsigned long           last_update;
 484
 485         s64                     last_actual;
 486         s64                     smoothed_derivative;
 487
 488         unsigned                p_term_inverse;
 489         unsigned                d_smooth;
 490         unsigned                d_term;
 491
 492         /* for exporting to sysfs (no effect on behavior) */
 493         s64                     last_derivative;
 494         s64                     last_proportional;
 495         s64                     last_change;
 496         s64                     last_target;
 497
 498         /* If true, the rate will not increase if bch2_ratelimit_delay()
 499          * is not being called often enough. */
 500         bool                    backpressure;
 501 };
 502
 503 void bch2_pd_controller_update(struct bch_pd_controller *, s64, s64, int);
 504 void bch2_pd_controller_init(struct bch_pd_controller *);
 505 size_t bch2_pd_controller_print_debug(struct bch_pd_controller *, char *);
 506
 507 #define sysfs_pd_controller_attribute(name)                             \
 508         rw_attribute(name##_rate);                                      \
 509         rw_attribute(name##_rate_bytes);                                \
 510         rw_attribute(name##_rate_d_term);                               \
 511         rw_attribute(name##_rate_p_term_inverse);                       \
 512         read_attribute(name##_rate_debug)
 513
 514 #define sysfs_pd_controller_files(name)                                 \
 515         &sysfs_##name##_rate,                                           \
 516         &sysfs_##name##_rate_bytes,                                     \
 517         &sysfs_##name##_rate_d_term,                                    \
 518         &sysfs_##name##_rate_p_term_inverse,                            \
 519         &sysfs_##name##_rate_debug
 520
 521 #define sysfs_pd_controller_show(name, var)                             \
 522 do {                                                                    \
 523         sysfs_hprint(name##_rate,               (var)->rate.rate);      \
 524         sysfs_print(name##_rate_bytes,          (var)->rate.rate);      \
 525         sysfs_print(name##_rate_d_term,         (var)->d_term);         \
 526         sysfs_print(name##_rate_p_term_inverse, (var)->p_term_inverse); \
 527                                                                         \
 528         if (attr == &sysfs_##name##_rate_debug)                         \
 529                 return bch2_pd_controller_print_debug(var, buf);                \
 530 } while (0)
 531
 532 #define sysfs_pd_controller_store(name, var)                            \
 533 do {                                                                    \
 534         sysfs_strtoul_clamp(name##_rate,                                \
 535                             (var)->rate.rate, 1, UINT_MAX);             \
 536         sysfs_strtoul_clamp(name##_rate_bytes,                          \
 537                             (var)->rate.rate, 1, UINT_MAX);             \
 538         sysfs_strtoul(name##_rate_d_term,       (var)->d_term);         \
 539         sysfs_strtoul_clamp(name##_rate_p_term_inverse,                 \
 540                             (var)->p_term_inverse, 1, INT_MAX);         \
 541 } while (0)
 542
 543 #define __DIV_SAFE(n, d, zero)                                          \
 544 ({                                                                      \
 545         typeof(n) _n = (n);                                             \
 546         typeof(d) _d = (d);                                             \
 547         _d ? _n / _d : zero;                                            \
 548 })
 549
 550 #define DIV_SAFE(n, d)  __DIV_SAFE(n, d, 0)
 551
 552 #define container_of_or_null(ptr, type, member)                         \
 553 ({                                                                      \
 554         typeof(ptr) _ptr = ptr;                                         \
 555         _ptr ? container_of(_ptr, type, member) : NULL;                 \
 556 })
 557
 558 #define RB_INSERT(root, new, member, cmp)                               \
 559 ({                                                                      \
 560         __label__ dup;                                                  \
 561         struct rb_node **n = &(root)->rb_node, *parent = NULL;          \
 562         typeof(new) this;                                               \
 563         int res, ret = -1;                                              \
 564                                                                         \
 565         while (*n) {                                                    \
 566                 parent = *n;                                            \
 567                 this = container_of(*n, typeof(*(new)), member);        \
 568                 res = cmp(new, this);                                   \
 569                 if (!res)                                               \
 570                         goto dup;                                       \
 571                 n = res < 0                                             \
 572                         ? &(*n)->rb_left                                \
 573                         : &(*n)->rb_right;                              \
 574         }                                                               \
 575                                                                         \
 576         rb_link_node(&(new)->member, parent, n);                        \
 577         rb_insert_color(&(new)->member, root);                          \
 578         ret = 0;                                                        \
 579 dup:                                                                    \
 580         ret;                                                            \
 581 })
 582
 583 #define RB_SEARCH(root, search, member, cmp)                            \
 584 ({                                                                      \
 585         struct rb_node *n = (root)->rb_node;                            \
 586         typeof(&(search)) this, ret = NULL;                             \
 587         int res;                                                        \
 588                                                                         \
 589         while (n) {                                                     \
 590                 this = container_of(n, typeof(search), member);         \
 591                 res = cmp(&(search), this);                             \
 592                 if (!res) {                                             \
 593                         ret = this;                                     \
 594                         break;                                          \
 595                 }                                                       \
 596                 n = res < 0                                             \
 597                         ? n->rb_left                                    \
 598                         : n->rb_right;                                  \
 599         }                                                               \
 600         ret;                                                            \
 601 })
 602
 603 #define RB_GREATER(root, search, member, cmp)                           \
 604 ({                                                                      \
 605         struct rb_node *n = (root)->rb_node;                            \
 606         typeof(&(search)) this, ret = NULL;                             \
 607         int res;                                                        \
 608                                                                         \
 609         while (n) {                                                     \
 610                 this = container_of(n, typeof(search), member);         \
 611                 res = cmp(&(search), this);                             \
 612                 if (res < 0) {                                          \
 613                         ret = this;                                     \
 614                         n = n->rb_left;                                 \
 615                 } else                                                  \
 616                         n = n->rb_right;                                \
 617         }                                                               \
 618         ret;                                                            \
 619 })
 620
 621 #define RB_FIRST(root, type, member)                                    \
 622         container_of_or_null(rb_first(root), type, member)
 623
 624 #define RB_LAST(root, type, member)                                     \
 625         container_of_or_null(rb_last(root), type, member)
 626
 627 #define RB_NEXT(ptr, member)                                            \
 628         container_of_or_null(rb_next(&(ptr)->member), typeof(*ptr), member)
 629
 630 #define RB_PREV(ptr, member)                                            \
 631         container_of_or_null(rb_prev(&(ptr)->member), typeof(*ptr), member)
 632
 633 /* Does linear interpolation between powers of two */
 634 static inline unsigned fract_exp_two(unsigned x, unsigned fract_bits)
 635 {
 636         unsigned fract = x & ~(~0 << fract_bits);
 637
 638         x >>= fract_bits;
 639         x   = 1 << x;
 640         x  += (x * fract) >> fract_bits;
 641
 642         return x;
 643 }
 644
 645 void bch2_bio_map(struct bio *bio, void *base);
 646
 647 static inline sector_t bdev_sectors(struct block_device *bdev)
 648 {
 649         return bdev->bd_inode->i_size >> 9;
 650 }
 651
 652 #define closure_bio_submit(bio, cl)                                     \
 653 do {                                                                    \
 654         closure_get(cl);                                                \
 655         submit_bio(bio);                                                \
 656 } while (0)
 657
 658 #define kthread_wait_freezable(cond)                                    \
 659 ({                                                                      \
 660         int _ret = 0;                                                   \
 661         while (1) {                                                     \
 662                 set_current_state(TASK_INTERRUPTIBLE);                  \
 663                 if (kthread_should_stop()) {                            \
 664                         _ret = -1;                                      \
 665                         break;                                          \
 666                 }                                                       \
 667                                                                         \
 668                 if (cond)                                               \
 669                         break;                                          \
 670                                                                         \
 671                 schedule();                                             \
 672                 try_to_freeze();                                        \
 673         }                                                               \
 674         set_current_state(TASK_RUNNING);                                \
 675         _ret;                                                           \
 676 })
 677
 678 size_t bch2_rand_range(size_t);
 679
 680 void memcpy_to_bio(struct bio *, struct bvec_iter, void *);
 681 void memcpy_from_bio(void *, struct bio *, struct bvec_iter);
 682
 683 static inline void __memcpy_u64s(void *dst, const void *src,
 684                                  unsigned u64s)
 685 {
 686 #ifdef CONFIG_X86_64
 687         long d0, d1, d2;
 688         asm volatile("rep ; movsq"
 689                      : "=&c" (d0), "=&D" (d1), "=&S" (d2)
 690                      : "0" (u64s), "1" (dst), "2" (src)
 691                      : "memory");
 692 #else
 693         u64 *d = dst;
 694         const u64 *s = src;
 695
 696         while (u64s--)
 697                 *d++ = *s++;
 698 #endif
 699 }
 700
 701 static inline void memcpy_u64s(void *dst, const void *src,
 702                                unsigned u64s)
 703 {
 704         EBUG_ON(!(dst >= src + u64s * sizeof(u64) ||
 705                  dst + u64s * sizeof(u64) <= src));
 706
 707         __memcpy_u64s(dst, src, u64s);
 708 }
 709
 710 static inline void __memmove_u64s_down(void *dst, const void *src,
 711                                        unsigned u64s)
 712 {
 713         __memcpy_u64s(dst, src, u64s);
 714 }
 715
 716 static inline void memmove_u64s_down(void *dst, const void *src,
 717                                      unsigned u64s)
 718 {
 719         EBUG_ON(dst > src);
 720
 721         __memmove_u64s_down(dst, src, u64s);
 722 }
 723
 724 static inline void __memmove_u64s_up(void *_dst, const void *_src,
 725                                      unsigned u64s)
 726 {
 727         u64 *dst = (u64 *) _dst + u64s - 1;
 728         u64 *src = (u64 *) _src + u64s - 1;
 729
 730 #ifdef CONFIG_X86_64
 731         long d0, d1, d2;
 732         asm volatile("std ;\n"
 733                      "rep ; movsq\n"
 734                      "cld ;\n"
 735                      : "=&c" (d0), "=&D" (d1), "=&S" (d2)
 736                      : "0" (u64s), "1" (dst), "2" (src)
 737                      : "memory");
 738 #else
 739         while (u64s--)
 740                 *dst-- = *src--;
 741 #endif
 742 }
 743
 744 static inline void memmove_u64s_up(void *dst, const void *src,
 745                                    unsigned u64s)
 746 {
 747         EBUG_ON(dst < src);
 748
 749         __memmove_u64s_up(dst, src, u64s);
 750 }
 751
 752 static inline void memmove_u64s(void *dst, const void *src,
 753                                 unsigned u64s)
 754 {
 755         if (dst < src)
 756                 __memmove_u64s_down(dst, src, u64s);
 757         else
 758                 __memmove_u64s_up(dst, src, u64s);
 759 }
 760
 761 static inline struct bio_vec next_contig_bvec(struct bio *bio,
 762                                               struct bvec_iter *iter)
 763 {
 764         struct bio_vec bv = bio_iter_iovec(bio, *iter);
 765
 766         bio_advance_iter(bio, iter, bv.bv_len);
 767 #ifndef CONFIG_HIGHMEM
 768         while (iter->bi_size) {
 769                 struct bio_vec next = bio_iter_iovec(bio, *iter);
 770
 771                 if (page_address(bv.bv_page) + bv.bv_offset + bv.bv_len !=
 772                     page_address(next.bv_page) + next.bv_offset)
 773                         break;
 774
 775                 bv.bv_len += next.bv_len;
 776                 bio_advance_iter(bio, iter, next.bv_len);
 777         }
 778 #endif
 779         return bv;
 780 }
 781
 782 #define __bio_for_each_contig_segment(bv, bio, iter, start)             \
 783         for (iter = (start);                                            \
 784              (iter).bi_size &&                                          \
 785                 ((bv = next_contig_bvec((bio), &(iter))), 1);)
 786
 787 #define bio_for_each_contig_segment(bv, bio, iter)                      \
 788         __bio_for_each_contig_segment(bv, bio, iter, (bio)->bi_iter)
 789
 790 size_t bch_scnmemcpy(char *, size_t, const char *, size_t);
 791
 792 void sort_cmp_size(void *base, size_t num, size_t size,
 793           int (*cmp_func)(const void *, const void *, size_t),
 794           void (*swap_func)(void *, void *, size_t));
 795
 796 /* just the memmove, doesn't update @_nr */
 797 #define __array_insert_item(_array, _nr, _pos)                          \
 798         memmove(&(_array)[(_pos) + 1],                                  \
 799                 &(_array)[(_pos)],                                      \
 800                 sizeof((_array)[0]) * ((_nr) - (_pos)))
 801
 802 #define array_insert_item(_array, _nr, _pos, _new_item)                 \
 803 do {                                                                    \
 804         __array_insert_item(_array, _nr, _pos);                         \
 805         (_nr)++;                                                        \
 806         (_array)[(_pos)] = (_new_item);                                 \
 807 } while (0)
 808
 809 #define array_remove_items(_array, _nr, _pos, _nr_to_remove)            \
 810 do {                                                                    \
 811         (_nr) -= (_nr_to_remove);                                       \
 812         memmove(&(_array)[(_pos)],                                      \
 813                 &(_array)[(_pos) + (_nr_to_remove)],                    \
 814                 sizeof((_array)[0]) * ((_nr) - (_pos)));                \
 815 } while (0)
 816
 817 #define array_remove_item(_array, _nr, _pos)                            \
 818         array_remove_items(_array, _nr, _pos, 1)
 819
 820 #define bubble_sort(_base, _nr, _cmp)                                   \
 821 do {                                                                    \
 822         ssize_t _i, _end;                                               \
 823         bool _swapped = true;                                           \
 824                                                                         \
 825         for (_end = (ssize_t) (_nr) - 1; _end > 0 && _swapped; --_end) {\
 826                 _swapped = false;                                       \
 827                 for (_i = 0; _i < _end; _i++)                           \
 828                         if (_cmp((_base)[_i], (_base)[_i + 1]) > 0) {   \
 829                                 swap((_base)[_i], (_base)[_i + 1]);     \
 830                                 _swapped = true;                        \
 831                         }                                               \
 832         }                                                               \
 833 } while (0)
 834
 835 #endif /* _BCACHEFS_UTIL_H */