include/linux/sbitmap.h

   1 /*
   2  * Fast and scalable bitmaps.
   3  *
   4  * Copyright (C) 2016 Facebook
   5  * Copyright (C) 2013-2014 Jens Axboe
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public
   9  * License v2 as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef __LINUX_SCALE_BITMAP_H
  21 #define __LINUX_SCALE_BITMAP_H
  22
  23 #include <linux/kernel.h>
  24 #include <linux/slab.h>
  25
  26 /**
  27  * struct sbitmap_word - Word in a &struct sbitmap.
  28  */
  29 struct sbitmap_word {
  30         /**
  31          * @word: The bitmap word itself.
  32          */
  33         unsigned long word;
  34
  35         /**
  36          * @depth: Number of bits being used in @word.
  37          */
  38         unsigned long depth;
  39 } ____cacheline_aligned_in_smp;
  40
  41 /**
  42  * struct sbitmap - Scalable bitmap.
  43  *
  44  * A &struct sbitmap is spread over multiple cachelines to avoid ping-pong. This
  45  * trades off higher memory usage for better scalability.
  46  */
  47 struct sbitmap {
  48         /**
  49          * @depth: Number of bits used in the whole bitmap.
  50          */
  51         unsigned int depth;
  52
  53         /**
  54          * @shift: log2(number of bits used per word)
  55          */
  56         unsigned int shift;
  57
  58         /**
  59          * @map_nr: Number of words (cachelines) being used for the bitmap.
  60          */
  61         unsigned int map_nr;
  62
  63         /**
  64          * @map: Allocated bitmap.
  65          */
  66         struct sbitmap_word *map;
  67 };
  68
  69 #define SBQ_WAIT_QUEUES 8
  70 #define SBQ_WAKE_BATCH 8
  71
  72 /**
  73  * struct sbq_wait_state - Wait queue in a &struct sbitmap_queue.
  74  */
  75 struct sbq_wait_state {
  76         /**
  77          * @wait_cnt: Number of frees remaining before we wake up.
  78          */
  79         atomic_t wait_cnt;
  80
  81         /**
  82          * @wait: Wait queue.
  83          */
  84         wait_queue_head_t wait;
  85 } ____cacheline_aligned_in_smp;
  86
  87 /**
  88  * struct sbitmap_queue - Scalable bitmap with the added ability to wait on free
  89  * bits.
  90  *
  91  * A &struct sbitmap_queue uses multiple wait queues and rolling wakeups to
  92  * avoid contention on the wait queue spinlock. This ensures that we don't hit a
  93  * scalability wall when we run out of free bits and have to start putting tasks
  94  * to sleep.
  95  */
  96 struct sbitmap_queue {
  97         /**
  98          * @sb: Scalable bitmap.
  99          */
 100         struct sbitmap sb;
 101
 102         /*
 103          * @alloc_hint: Cache of last successfully allocated or freed bit.
 104          *
 105          * This is per-cpu, which allows multiple users to stick to different
 106          * cachelines until the map is exhausted.
 107          */
 108         unsigned int __percpu *alloc_hint;
 109
 110         /**
 111          * @wake_batch: Number of bits which must be freed before we wake up any
 112          * waiters.
 113          */
 114         unsigned int wake_batch;
 115
 116         /**
 117          * @wake_index: Next wait queue in @ws to wake up.
 118          */
 119         atomic_t wake_index;
 120
 121         /**
 122          * @ws: Wait queues.
 123          */
 124         struct sbq_wait_state *ws;
 125
 126         /**
 127          * @round_robin: Allocate bits in strict round-robin order.
 128          */
 129         bool round_robin;
 130 };
 131
 132 /**
 133  * sbitmap_init_node() - Initialize a &struct sbitmap on a specific memory node.
 134  * @sb: Bitmap to initialize.
 135  * @depth: Number of bits to allocate.
 136  * @shift: Use 2^@shift bits per word in the bitmap; if a negative number if
 137  *         given, a good default is chosen.
 138  * @flags: Allocation flags.
 139  * @node: Memory node to allocate on.
 140  *
 141  * Return: Zero on success or negative errno on failure.
 142  */
 143 int sbitmap_init_node(struct sbitmap *sb, unsigned int depth, int shift,
 144                       gfp_t flags, int node);
 145
 146 /**
 147  * sbitmap_free() - Free memory used by a &struct sbitmap.
 148  * @sb: Bitmap to free.
 149  */
 150 static inline void sbitmap_free(struct sbitmap *sb)
 151 {
 152         kfree(sb->map);
 153         sb->map = NULL;
 154 }
 155
 156 /**
 157  * sbitmap_resize() - Resize a &struct sbitmap.
 158  * @sb: Bitmap to resize.
 159  * @depth: New number of bits to resize to.
 160  *
 161  * Doesn't reallocate anything. It's up to the caller to ensure that the new
 162  * depth doesn't exceed the depth that the sb was initialized with.
 163  */
 164 void sbitmap_resize(struct sbitmap *sb, unsigned int depth);
 165
 166 /**
 167  * sbitmap_get() - Try to allocate a free bit from a &struct sbitmap.
 168  * @sb: Bitmap to allocate from.
 169  * @alloc_hint: Hint for where to start searching for a free bit.
 170  * @round_robin: If true, be stricter about allocation order; always allocate
 171  *               starting from the last allocated bit. This is less efficient
 172  *               than the default behavior (false).
 173  *
 174  * This operation provides acquire barrier semantics if it succeeds.
 175  *
 176  * Return: Non-negative allocated bit number if successful, -1 otherwise.
 177  */
 178 int sbitmap_get(struct sbitmap *sb, unsigned int alloc_hint, bool round_robin);
 179
 180 /**
 181  * sbitmap_get_shallow() - Try to allocate a free bit from a &struct sbitmap,
 182  * limiting the depth used from each word.
 183  * @sb: Bitmap to allocate from.
 184  * @alloc_hint: Hint for where to start searching for a free bit.
 185  * @shallow_depth: The maximum number of bits to allocate from a single word.
 186  *
 187  * This rather specific operation allows for having multiple users with
 188  * different allocation limits. E.g., there can be a high-priority class that
 189  * uses sbitmap_get() and a low-priority class that uses sbitmap_get_shallow()
 190  * with a @shallow_depth of (1 << (@sb->shift - 1)). Then, the low-priority
 191  * class can only allocate half of the total bits in the bitmap, preventing it
 192  * from starving out the high-priority class.
 193  *
 194  * Return: Non-negative allocated bit number if successful, -1 otherwise.
 195  */
 196 int sbitmap_get_shallow(struct sbitmap *sb, unsigned int alloc_hint,
 197                         unsigned long shallow_depth);
 198
 199 /**
 200  * sbitmap_any_bit_set() - Check for a set bit in a &struct sbitmap.
 201  * @sb: Bitmap to check.
 202  *
 203  * Return: true if any bit in the bitmap is set, false otherwise.
 204  */
 205 bool sbitmap_any_bit_set(const struct sbitmap *sb);
 206
 207 /**
 208  * sbitmap_any_bit_clear() - Check for an unset bit in a &struct
 209  * sbitmap.
 210  * @sb: Bitmap to check.
 211  *
 212  * Return: true if any bit in the bitmap is clear, false otherwise.
 213  */
 214 bool sbitmap_any_bit_clear(const struct sbitmap *sb);
 215
 216 #define SB_NR_TO_INDEX(sb, bitnr) ((bitnr) >> (sb)->shift)
 217 #define SB_NR_TO_BIT(sb, bitnr) ((bitnr) & ((1U << (sb)->shift) - 1U))
 218
 219 typedef bool (*sb_for_each_fn)(struct sbitmap *, unsigned int, void *);
 220
 221 /**
 222  * __sbitmap_for_each_set() - Iterate over each set bit in a &struct sbitmap.
 223  * @start: Where to start the iteration.
 224  * @sb: Bitmap to iterate over.
 225  * @fn: Callback. Should return true to continue or false to break early.
 226  * @data: Pointer to pass to callback.
 227  *
 228  * This is inline even though it's non-trivial so that the function calls to the
 229  * callback will hopefully get optimized away.
 230  */
 231 static inline void __sbitmap_for_each_set(struct sbitmap *sb,
 232                                           unsigned int start,
 233                                           sb_for_each_fn fn, void *data)
 234 {
 235         unsigned int index;
 236         unsigned int nr;
 237         unsigned int scanned = 0;
 238
 239         if (start >= sb->depth)
 240                 start = 0;
 241         index = SB_NR_TO_INDEX(sb, start);
 242         nr = SB_NR_TO_BIT(sb, start);
 243
 244         while (scanned < sb->depth) {
 245                 struct sbitmap_word *word = &sb->map[index];
 246                 unsigned int depth = min_t(unsigned int, word->depth - nr,
 247                                            sb->depth - scanned);
 248
 249                 scanned += depth;
 250                 if (!word->word)
 251                         goto next;
 252
 253                 /*
 254                  * On the first iteration of the outer loop, we need to add the
 255                  * bit offset back to the size of the word for find_next_bit().
 256                  * On all other iterations, nr is zero, so this is a noop.
 257                  */
 258                 depth += nr;
 259                 while (1) {
 260                         nr = find_next_bit(&word->word, depth, nr);
 261                         if (nr >= depth)
 262                                 break;
 263                         if (!fn(sb, (index << sb->shift) + nr, data))
 264                                 return;
 265
 266                         nr++;
 267                 }
 268 next:
 269                 nr = 0;
 270                 if (++index >= sb->map_nr)
 271                         index = 0;
 272         }
 273 }
 274
 275 /**
 276  * sbitmap_for_each_set() - Iterate over each set bit in a &struct sbitmap.
 277  * @sb: Bitmap to iterate over.
 278  * @fn: Callback. Should return true to continue or false to break early.
 279  * @data: Pointer to pass to callback.
 280  */
 281 static inline void sbitmap_for_each_set(struct sbitmap *sb, sb_for_each_fn fn,
 282                                         void *data)
 283 {
 284         __sbitmap_for_each_set(sb, 0, fn, data);
 285 }
 286
 287 static inline unsigned long *__sbitmap_word(struct sbitmap *sb,
 288                                             unsigned int bitnr)
 289 {
 290         return &sb->map[SB_NR_TO_INDEX(sb, bitnr)].word;
 291 }
 292
 293 /* Helpers equivalent to the operations in asm/bitops.h and linux/bitmap.h */
 294
 295 static inline void sbitmap_set_bit(struct sbitmap *sb, unsigned int bitnr)
 296 {
 297         set_bit(SB_NR_TO_BIT(sb, bitnr), __sbitmap_word(sb, bitnr));
 298 }
 299
 300 static inline void sbitmap_clear_bit(struct sbitmap *sb, unsigned int bitnr)
 301 {
 302         clear_bit(SB_NR_TO_BIT(sb, bitnr), __sbitmap_word(sb, bitnr));
 303 }
 304
 305 static inline void sbitmap_clear_bit_unlock(struct sbitmap *sb,
 306                                             unsigned int bitnr)
 307 {
 308         clear_bit_unlock(SB_NR_TO_BIT(sb, bitnr), __sbitmap_word(sb, bitnr));
 309 }
 310
 311 static inline int sbitmap_test_bit(struct sbitmap *sb, unsigned int bitnr)
 312 {
 313         return test_bit(SB_NR_TO_BIT(sb, bitnr), __sbitmap_word(sb, bitnr));
 314 }
 315
 316 unsigned int sbitmap_weight(const struct sbitmap *sb);
 317
 318 /**
 319  * sbitmap_show() - Dump &struct sbitmap information to a &struct seq_file.
 320  * @sb: Bitmap to show.
 321  * @m: struct seq_file to write to.
 322  *
 323  * This is intended for debugging. The format may change at any time.
 324  */
 325 void sbitmap_show(struct sbitmap *sb, struct seq_file *m);
 326
 327 /**
 328  * sbitmap_bitmap_show() - Write a hex dump of a &struct sbitmap to a &struct
 329  * seq_file.
 330  * @sb: Bitmap to show.
 331  * @m: struct seq_file to write to.
 332  *
 333  * This is intended for debugging. The output isn't guaranteed to be internally
 334  * consistent.
 335  */
 336 void sbitmap_bitmap_show(struct sbitmap *sb, struct seq_file *m);
 337
 338 /**
 339  * sbitmap_queue_init_node() - Initialize a &struct sbitmap_queue on a specific
 340  * memory node.
 341  * @sbq: Bitmap queue to initialize.
 342  * @depth: See sbitmap_init_node().
 343  * @shift: See sbitmap_init_node().
 344  * @round_robin: See sbitmap_get().
 345  * @flags: Allocation flags.
 346  * @node: Memory node to allocate on.
 347  *
 348  * Return: Zero on success or negative errno on failure.
 349  */
 350 int sbitmap_queue_init_node(struct sbitmap_queue *sbq, unsigned int depth,
 351                             int shift, bool round_robin, gfp_t flags, int node);
 352
 353 /**
 354  * sbitmap_queue_free() - Free memory used by a &struct sbitmap_queue.
 355  *
 356  * @sbq: Bitmap queue to free.
 357  */
 358 static inline void sbitmap_queue_free(struct sbitmap_queue *sbq)
 359 {
 360         kfree(sbq->ws);
 361         free_percpu(sbq->alloc_hint);
 362         sbitmap_free(&sbq->sb);
 363 }
 364
 365 /**
 366  * sbitmap_queue_resize() - Resize a &struct sbitmap_queue.
 367  * @sbq: Bitmap queue to resize.
 368  * @depth: New number of bits to resize to.
 369  *
 370  * Like sbitmap_resize(), this doesn't reallocate anything. It has to do
 371  * some extra work on the &struct sbitmap_queue, so it's not safe to just
 372  * resize the underlying &struct sbitmap.
 373  */
 374 void sbitmap_queue_resize(struct sbitmap_queue *sbq, unsigned int depth);
 375
 376 /**
 377  * __sbitmap_queue_get() - Try to allocate a free bit from a &struct
 378  * sbitmap_queue with preemption already disabled.
 379  * @sbq: Bitmap queue to allocate from.
 380  *
 381  * Return: Non-negative allocated bit number if successful, -1 otherwise.
 382  */
 383 int __sbitmap_queue_get(struct sbitmap_queue *sbq);
 384
 385 /**
 386  * __sbitmap_queue_get_shallow() - Try to allocate a free bit from a &struct
 387  * sbitmap_queue, limiting the depth used from each word, with preemption
 388  * already disabled.
 389  * @sbq: Bitmap queue to allocate from.
 390  * @shallow_depth: The maximum number of bits to allocate from a single word.
 391  * See sbitmap_get_shallow().
 392  *
 393  * Return: Non-negative allocated bit number if successful, -1 otherwise.
 394  */
 395 int __sbitmap_queue_get_shallow(struct sbitmap_queue *sbq,
 396                                 unsigned int shallow_depth);
 397
 398 /**
 399  * sbitmap_queue_get() - Try to allocate a free bit from a &struct
 400  * sbitmap_queue.
 401  * @sbq: Bitmap queue to allocate from.
 402  * @cpu: Output parameter; will contain the CPU we ran on (e.g., to be passed to
 403  *       sbitmap_queue_clear()).
 404  *
 405  * Return: Non-negative allocated bit number if successful, -1 otherwise.
 406  */
 407 static inline int sbitmap_queue_get(struct sbitmap_queue *sbq,
 408                                     unsigned int *cpu)
 409 {
 410         int nr;
 411
 412         *cpu = get_cpu();
 413         nr = __sbitmap_queue_get(sbq);
 414         put_cpu();
 415         return nr;
 416 }
 417
 418 /**
 419  * sbitmap_queue_get_shallow() - Try to allocate a free bit from a &struct
 420  * sbitmap_queue, limiting the depth used from each word.
 421  * @sbq: Bitmap queue to allocate from.
 422  * @cpu: Output parameter; will contain the CPU we ran on (e.g., to be passed to
 423  *       sbitmap_queue_clear()).
 424  * @shallow_depth: The maximum number of bits to allocate from a single word.
 425  * See sbitmap_get_shallow().
 426  *
 427  * Return: Non-negative allocated bit number if successful, -1 otherwise.
 428  */
 429 static inline int sbitmap_queue_get_shallow(struct sbitmap_queue *sbq,
 430                                             unsigned int *cpu,
 431                                             unsigned int shallow_depth)
 432 {
 433         int nr;
 434
 435         *cpu = get_cpu();
 436         nr = __sbitmap_queue_get_shallow(sbq, shallow_depth);
 437         put_cpu();
 438         return nr;
 439 }
 440
 441 /**
 442  * sbitmap_queue_clear() - Free an allocated bit and wake up waiters on a
 443  * &struct sbitmap_queue.
 444  * @sbq: Bitmap to free from.
 445  * @nr: Bit number to free.
 446  * @cpu: CPU the bit was allocated on.
 447  */
 448 void sbitmap_queue_clear(struct sbitmap_queue *sbq, unsigned int nr,
 449                          unsigned int cpu);
 450
 451 static inline int sbq_index_inc(int index)
 452 {
 453         return (index + 1) & (SBQ_WAIT_QUEUES - 1);
 454 }
 455
 456 static inline void sbq_index_atomic_inc(atomic_t *index)
 457 {
 458         int old = atomic_read(index);
 459         int new = sbq_index_inc(old);
 460         atomic_cmpxchg(index, old, new);
 461 }
 462
 463 /**
 464  * sbq_wait_ptr() - Get the next wait queue to use for a &struct
 465  * sbitmap_queue.
 466  * @sbq: Bitmap queue to wait on.
 467  * @wait_index: A counter per "user" of @sbq.
 468  */
 469 static inline struct sbq_wait_state *sbq_wait_ptr(struct sbitmap_queue *sbq,
 470                                                   atomic_t *wait_index)
 471 {
 472         struct sbq_wait_state *ws;
 473
 474         ws = &sbq->ws[atomic_read(wait_index)];
 475         sbq_index_atomic_inc(wait_index);
 476         return ws;
 477 }
 478
 479 /**
 480  * sbitmap_queue_wake_all() - Wake up everything waiting on a &struct
 481  * sbitmap_queue.
 482  * @sbq: Bitmap queue to wake up.
 483  */
 484 void sbitmap_queue_wake_all(struct sbitmap_queue *sbq);
 485
 486 /**
 487  * sbitmap_queue_show() - Dump &struct sbitmap_queue information to a &struct
 488  * seq_file.
 489  * @sbq: Bitmap queue to show.
 490  * @m: struct seq_file to write to.
 491  *
 492  * This is intended for debugging. The format may change at any time.
 493  */
 494 void sbitmap_queue_show(struct sbitmap_queue *sbq, struct seq_file *m);
 495
 496 #endif /* __LINUX_SCALE_BITMAP_H */