git.sesse.net Git - bcachefs-tools-debian/blob - linux/mempool.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  linux/mm/mempool.c
   4  *
   5  *  memory buffer pool support. Such pools are mostly used
   6  *  for guaranteed, deadlock-free memory allocations during
   7  *  extreme VM load.
   8  *
   9  *  started by Ingo Molnar, Copyright (C) 2001
  10  *  debugging by David Rientjes, Copyright (C) 2015
  11  */
  12
  13 #include <linux/slab.h>
  14 //#include <linux/kasan.h>
  15 //#include <linux/kmemleak.h>
  16 #include <linux/export.h>
  17 #include <linux/jiffies.h>
  18 #include <linux/mempool.h>
  19 #include <linux/mempool.h>
  20 #include <linux/sched.h>
  21
  22 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB_DEBUG_ON)
  23 static void poison_error(mempool_t *pool, void *element, size_t size,
  24                          size_t byte)
  25 {
  26         const int nr = pool->curr_nr;
  27         const int start = max_t(int, byte - (BITS_PER_LONG / 8), 0);
  28         const int end = min_t(int, byte + (BITS_PER_LONG / 8), size);
  29         int i;
  30
  31         pr_err("BUG: mempool element poison mismatch\n");
  32         pr_err("Mempool %p size %zu\n", pool, size);
  33         pr_err(" nr=%d @ %p: %s0x", nr, element, start > 0 ? "... " : "");
  34         for (i = start; i < end; i++)
  35                 pr_cont("%x ", *(u8 *)(element + i));
  36         pr_cont("%s\n", end < size ? "..." : "");
  37         dump_stack();
  38 }
  39
  40 static void __check_element(mempool_t *pool, void *element, size_t size)
  41 {
  42         u8 *obj = element;
  43         size_t i;
  44
  45         for (i = 0; i < size; i++) {
  46                 u8 exp = (i < size - 1) ? POISON_FREE : POISON_END;
  47
  48                 if (obj[i] != exp) {
  49                         poison_error(pool, element, size, i);
  50                         return;
  51                 }
  52         }
  53         memset(obj, POISON_INUSE, size);
  54 }
  55
  56 static void check_element(mempool_t *pool, void *element)
  57 {
  58         /* Mempools backed by slab allocator */
  59         if (pool->free == mempool_free_slab || pool->free == mempool_kfree) {
  60                 __check_element(pool, element, ksize(element));
  61         } else if (pool->free == mempool_free_pages) {
  62                 /* Mempools backed by page allocator */
  63                 int order = (int)(long)pool->pool_data;
  64                 void *addr = kmap_atomic((struct page *)element);
  65
  66                 __check_element(pool, addr, 1UL << (PAGE_SHIFT + order));
  67                 kunmap_atomic(addr);
  68         }
  69 }
  70
  71 static void __poison_element(void *element, size_t size)
  72 {
  73         u8 *obj = element;
  74
  75         memset(obj, POISON_FREE, size - 1);
  76         obj[size - 1] = POISON_END;
  77 }
  78
  79 static void poison_element(mempool_t *pool, void *element)
  80 {
  81         /* Mempools backed by slab allocator */
  82         if (pool->alloc == mempool_alloc_slab || pool->alloc == mempool_kmalloc) {
  83                 __poison_element(element, ksize(element));
  84         } else if (pool->alloc == mempool_alloc_pages) {
  85                 /* Mempools backed by page allocator */
  86                 int order = (int)(long)pool->pool_data;
  87                 void *addr = kmap_atomic((struct page *)element);
  88
  89                 __poison_element(addr, 1UL << (PAGE_SHIFT + order));
  90                 kunmap_atomic(addr);
  91         }
  92 }
  93 #else /* CONFIG_DEBUG_SLAB || CONFIG_SLUB_DEBUG_ON */
  94 static inline void check_element(mempool_t *pool, void *element)
  95 {
  96 }
  97 static inline void poison_element(mempool_t *pool, void *element)
  98 {
  99 }
 100 #endif /* CONFIG_DEBUG_SLAB || CONFIG_SLUB_DEBUG_ON */
 101
 102 static __always_inline void kasan_poison_element(mempool_t *pool, void *element)
 103 {
 104 #if 0
 105         if (pool->alloc == mempool_alloc_slab || pool->alloc == mempool_kmalloc)
 106                 kasan_poison_kfree(element, _RET_IP_);
 107         else if (pool->alloc == mempool_alloc_pages)
 108                 kasan_free_pages(element, (unsigned long)pool->pool_data);
 109 #endif
 110 }
 111
 112 static void kasan_unpoison_element(mempool_t *pool, void *element)
 113 {
 114 #if 0
 115         if (pool->alloc == mempool_alloc_slab || pool->alloc == mempool_kmalloc)
 116                 kasan_unpoison_slab(element);
 117         else if (pool->alloc == mempool_alloc_pages)
 118                 kasan_alloc_pages(element, (unsigned long)pool->pool_data);
 119 #endif
 120 }
 121
 122 static __always_inline void add_element(mempool_t *pool, void *element)
 123 {
 124         BUG_ON(pool->curr_nr >= pool->min_nr);
 125         poison_element(pool, element);
 126         kasan_poison_element(pool, element);
 127         pool->elements[pool->curr_nr++] = element;
 128 }
 129
 130 static void *remove_element(mempool_t *pool)
 131 {
 132         void *element = pool->elements[--pool->curr_nr];
 133
 134         BUG_ON(pool->curr_nr < 0);
 135         kasan_unpoison_element(pool, element);
 136         check_element(pool, element);
 137         return element;
 138 }
 139
 140 /**
 141  * mempool_exit - exit a mempool initialized with mempool_init()
 142  * @pool:      pointer to the memory pool which was initialized with
 143  *             mempool_init().
 144  *
 145  * Free all reserved elements in @pool and @pool itself.  This function
 146  * only sleeps if the free_fn() function sleeps.
 147  *
 148  * May be called on a zeroed but uninitialized mempool (i.e. allocated with
 149  * kzalloc()).
 150  */
 151 void mempool_exit(mempool_t *pool)
 152 {
 153         while (pool->curr_nr) {
 154                 void *element = remove_element(pool);
 155                 pool->free(element, pool->pool_data);
 156         }
 157         kfree(pool->elements);
 158         pool->elements = NULL;
 159 }
 160 EXPORT_SYMBOL(mempool_exit);
 161
 162 /**
 163  * mempool_destroy - deallocate a memory pool
 164  * @pool:      pointer to the memory pool which was allocated via
 165  *             mempool_create().
 166  *
 167  * Free all reserved elements in @pool and @pool itself.  This function
 168  * only sleeps if the free_fn() function sleeps.
 169  */
 170 void mempool_destroy(mempool_t *pool)
 171 {
 172         if (unlikely(!pool))
 173                 return;
 174
 175         mempool_exit(pool);
 176         kfree(pool);
 177 }
 178 EXPORT_SYMBOL(mempool_destroy);
 179
 180 int mempool_init_node(mempool_t *pool, int min_nr, mempool_alloc_t *alloc_fn,
 181                       mempool_free_t *free_fn, void *pool_data,
 182                       gfp_t gfp_mask, int node_id)
 183 {
 184         spin_lock_init(&pool->lock);
 185         pool->min_nr    = min_nr;
 186         pool->pool_data = pool_data;
 187         pool->alloc     = alloc_fn;
 188         pool->free      = free_fn;
 189         init_waitqueue_head(&pool->wait);
 190
 191         pool->elements = kmalloc_array(min_nr, sizeof(void *), gfp_mask);
 192         if (!pool->elements)
 193                 return -ENOMEM;
 194
 195         /*
 196          * First pre-allocate the guaranteed number of buffers.
 197          */
 198         while (pool->curr_nr < pool->min_nr) {
 199                 void *element;
 200
 201                 element = pool->alloc(gfp_mask, pool->pool_data);
 202                 if (unlikely(!element)) {
 203                         mempool_exit(pool);
 204                         return -ENOMEM;
 205                 }
 206                 add_element(pool, element);
 207         }
 208
 209         return 0;
 210 }
 211 EXPORT_SYMBOL(mempool_init_node);
 212
 213 /**
 214  * mempool_init - initialize a memory pool
 215  * @pool:      pointer to the memory pool that should be initialized
 216  * @min_nr:    the minimum number of elements guaranteed to be
 217  *             allocated for this pool.
 218  * @alloc_fn:  user-defined element-allocation function.
 219  * @free_fn:   user-defined element-freeing function.
 220  * @pool_data: optional private data available to the user-defined functions.
 221  *
 222  * Like mempool_create(), but initializes the pool in (i.e. embedded in another
 223  * structure).
 224  *
 225  * Return: %0 on success, negative error code otherwise.
 226  */
 227 int mempool_init(mempool_t *pool, int min_nr, mempool_alloc_t *alloc_fn,
 228                  mempool_free_t *free_fn, void *pool_data)
 229 {
 230         return mempool_init_node(pool, min_nr, alloc_fn, free_fn,
 231                                  pool_data, GFP_KERNEL, 0);
 232
 233 }
 234 EXPORT_SYMBOL(mempool_init);
 235
 236 /**
 237  * mempool_create - create a memory pool
 238  * @min_nr:    the minimum number of elements guaranteed to be
 239  *             allocated for this pool.
 240  * @alloc_fn:  user-defined element-allocation function.
 241  * @free_fn:   user-defined element-freeing function.
 242  * @pool_data: optional private data available to the user-defined functions.
 243  *
 244  * this function creates and allocates a guaranteed size, preallocated
 245  * memory pool. The pool can be used from the mempool_alloc() and mempool_free()
 246  * functions. This function might sleep. Both the alloc_fn() and the free_fn()
 247  * functions might sleep - as long as the mempool_alloc() function is not called
 248  * from IRQ contexts.
 249  *
 250  * Return: pointer to the created memory pool object or %NULL on error.
 251  */
 252 mempool_t *mempool_create(int min_nr, mempool_alloc_t *alloc_fn,
 253                                 mempool_free_t *free_fn, void *pool_data)
 254 {
 255         return mempool_create_node(min_nr,alloc_fn,free_fn, pool_data,
 256                                    GFP_KERNEL, 0);
 257 }
 258 EXPORT_SYMBOL(mempool_create);
 259
 260 mempool_t *mempool_create_node(int min_nr, mempool_alloc_t *alloc_fn,
 261                                mempool_free_t *free_fn, void *pool_data,
 262                                gfp_t gfp_mask, int node_id)
 263 {
 264         mempool_t *pool;
 265
 266         pool = kzalloc(sizeof(*pool), gfp_mask);
 267         if (!pool)
 268                 return NULL;
 269
 270         if (mempool_init_node(pool, min_nr, alloc_fn, free_fn, pool_data,
 271                               gfp_mask, node_id)) {
 272                 kfree(pool);
 273                 return NULL;
 274         }
 275
 276         return pool;
 277 }
 278 EXPORT_SYMBOL(mempool_create_node);
 279
 280 /**
 281  * mempool_resize - resize an existing memory pool
 282  * @pool:       pointer to the memory pool which was allocated via
 283  *              mempool_create().
 284  * @new_min_nr: the new minimum number of elements guaranteed to be
 285  *              allocated for this pool.
 286  *
 287  * This function shrinks/grows the pool. In the case of growing,
 288  * it cannot be guaranteed that the pool will be grown to the new
 289  * size immediately, but new mempool_free() calls will refill it.
 290  * This function may sleep.
 291  *
 292  * Note, the caller must guarantee that no mempool_destroy is called
 293  * while this function is running. mempool_alloc() & mempool_free()
 294  * might be called (eg. from IRQ contexts) while this function executes.
 295  *
 296  * Return: %0 on success, negative error code otherwise.
 297  */
 298 int mempool_resize(mempool_t *pool, int new_min_nr)
 299 {
 300         void *element;
 301         void **new_elements;
 302         unsigned long flags;
 303
 304         BUG_ON(new_min_nr <= 0);
 305         might_sleep();
 306
 307         spin_lock_irqsave(&pool->lock, flags);
 308         if (new_min_nr <= pool->min_nr) {
 309                 while (new_min_nr < pool->curr_nr) {
 310                         element = remove_element(pool);
 311                         spin_unlock_irqrestore(&pool->lock, flags);
 312                         pool->free(element, pool->pool_data);
 313                         spin_lock_irqsave(&pool->lock, flags);
 314                 }
 315                 pool->min_nr = new_min_nr;
 316                 goto out_unlock;
 317         }
 318         spin_unlock_irqrestore(&pool->lock, flags);
 319
 320         /* Grow the pool */
 321         new_elements = kmalloc_array(new_min_nr, sizeof(*new_elements),
 322                                      GFP_KERNEL);
 323         if (!new_elements)
 324                 return -ENOMEM;
 325
 326         spin_lock_irqsave(&pool->lock, flags);
 327         if (unlikely(new_min_nr <= pool->min_nr)) {
 328                 /* Raced, other resize will do our work */
 329                 spin_unlock_irqrestore(&pool->lock, flags);
 330                 kfree(new_elements);
 331                 goto out;
 332         }
 333         memcpy(new_elements, pool->elements,
 334                         pool->curr_nr * sizeof(*new_elements));
 335         kfree(pool->elements);
 336         pool->elements = new_elements;
 337         pool->min_nr = new_min_nr;
 338
 339         while (pool->curr_nr < pool->min_nr) {
 340                 spin_unlock_irqrestore(&pool->lock, flags);
 341                 element = pool->alloc(GFP_KERNEL, pool->pool_data);
 342                 if (!element)
 343                         goto out;
 344                 spin_lock_irqsave(&pool->lock, flags);
 345                 if (pool->curr_nr < pool->min_nr) {
 346                         add_element(pool, element);
 347                 } else {
 348                         spin_unlock_irqrestore(&pool->lock, flags);
 349                         pool->free(element, pool->pool_data);   /* Raced */
 350                         goto out;
 351                 }
 352         }
 353 out_unlock:
 354         spin_unlock_irqrestore(&pool->lock, flags);
 355 out:
 356         return 0;
 357 }
 358 EXPORT_SYMBOL(mempool_resize);
 359
 360 /**
 361  * mempool_alloc - allocate an element from a specific memory pool
 362  * @pool:      pointer to the memory pool which was allocated via
 363  *             mempool_create().
 364  * @gfp_mask:  the usual allocation bitmask.
 365  *
 366  * this function only sleeps if the alloc_fn() function sleeps or
 367  * returns NULL. Note that due to preallocation, this function
 368  * *never* fails when called from process contexts. (it might
 369  * fail if called from an IRQ context.)
 370  * Note: using __GFP_ZERO is not supported.
 371  *
 372  * Return: pointer to the allocated element or %NULL on error.
 373  */
 374 void *mempool_alloc(mempool_t *pool, gfp_t gfp_mask)
 375 {
 376         void *element;
 377         unsigned long flags;
 378         DEFINE_WAIT(wait);
 379         gfp_t gfp_temp;
 380
 381         WARN_ON_ONCE(gfp_mask & __GFP_ZERO);
 382
 383         gfp_mask |= __GFP_NORETRY;      /* don't loop in __alloc_pages */
 384         gfp_mask |= __GFP_NOWARN;       /* failures are OK */
 385
 386         gfp_temp = gfp_mask & ~(__GFP_IO);
 387
 388 repeat_alloc:
 389
 390         element = pool->alloc(gfp_temp, pool->pool_data);
 391         if (likely(element != NULL))
 392                 return element;
 393
 394         spin_lock_irqsave(&pool->lock, flags);
 395         if (likely(pool->curr_nr)) {
 396                 element = remove_element(pool);
 397                 spin_unlock_irqrestore(&pool->lock, flags);
 398                 /* paired with rmb in mempool_free(), read comment there */
 399                 smp_wmb();
 400                 return element;
 401         }
 402
 403         /*
 404          * We use gfp mask w/o direct reclaim or IO for the first round.  If
 405          * alloc failed with that and @pool was empty, retry immediately.
 406          */
 407         if (gfp_temp != gfp_mask) {
 408                 spin_unlock_irqrestore(&pool->lock, flags);
 409                 gfp_temp = gfp_mask;
 410                 goto repeat_alloc;
 411         }
 412
 413         /* Let's wait for someone else to return an element to @pool */
 414         prepare_to_wait(&pool->wait, &wait, TASK_UNINTERRUPTIBLE);
 415
 416         spin_unlock_irqrestore(&pool->lock, flags);
 417
 418         /*
 419          * FIXME: this should be io_schedule().  The timeout is there as a
 420          * workaround for some DM problems in 2.6.18.
 421          */
 422         io_schedule_timeout(5*HZ);
 423
 424         finish_wait(&pool->wait, &wait);
 425         goto repeat_alloc;
 426 }
 427 EXPORT_SYMBOL(mempool_alloc);
 428
 429 /**
 430  * mempool_free - return an element to the pool.
 431  * @element:   pool element pointer.
 432  * @pool:      pointer to the memory pool which was allocated via
 433  *             mempool_create().
 434  *
 435  * this function only sleeps if the free_fn() function sleeps.
 436  */
 437 void mempool_free(void *element, mempool_t *pool)
 438 {
 439         unsigned long flags;
 440
 441         if (unlikely(element == NULL))
 442                 return;
 443
 444         /*
 445          * Paired with the wmb in mempool_alloc().  The preceding read is
 446          * for @element and the following @pool->curr_nr.  This ensures
 447          * that the visible value of @pool->curr_nr is from after the
 448          * allocation of @element.  This is necessary for fringe cases
 449          * where @element was passed to this task without going through
 450          * barriers.
 451          *
 452          * For example, assume @p is %NULL at the beginning and one task
 453          * performs "p = mempool_alloc(...);" while another task is doing
 454          * "while (!p) cpu_relax(); mempool_free(p, ...);".  This function
 455          * may end up using curr_nr value which is from before allocation
 456          * of @p without the following rmb.
 457          */
 458         smp_rmb();
 459
 460         /*
 461          * For correctness, we need a test which is guaranteed to trigger
 462          * if curr_nr + #allocated == min_nr.  Testing curr_nr < min_nr
 463          * without locking achieves that and refilling as soon as possible
 464          * is desirable.
 465          *
 466          * Because curr_nr visible here is always a value after the
 467          * allocation of @element, any task which decremented curr_nr below
 468          * min_nr is guaranteed to see curr_nr < min_nr unless curr_nr gets
 469          * incremented to min_nr afterwards.  If curr_nr gets incremented
 470          * to min_nr after the allocation of @element, the elements
 471          * allocated after that are subject to the same guarantee.
 472          *
 473          * Waiters happen iff curr_nr is 0 and the above guarantee also
 474          * ensures that there will be frees which return elements to the
 475          * pool waking up the waiters.
 476          */
 477         if (unlikely(READ_ONCE(pool->curr_nr) < pool->min_nr)) {
 478                 spin_lock_irqsave(&pool->lock, flags);
 479                 if (likely(pool->curr_nr < pool->min_nr)) {
 480                         add_element(pool, element);
 481                         spin_unlock_irqrestore(&pool->lock, flags);
 482                         wake_up(&pool->wait);
 483                         return;
 484                 }
 485                 spin_unlock_irqrestore(&pool->lock, flags);
 486         }
 487         pool->free(element, pool->pool_data);
 488 }
 489 EXPORT_SYMBOL(mempool_free);
 490
 491 /*
 492  * A commonly used alloc and free fn.
 493  */
 494 void *mempool_alloc_slab(gfp_t gfp_mask, void *pool_data)
 495 {
 496         struct kmem_cache *mem = pool_data;
 497         return kmem_cache_alloc(mem, gfp_mask);
 498 }
 499 EXPORT_SYMBOL(mempool_alloc_slab);
 500
 501 void mempool_free_slab(void *element, void *pool_data)
 502 {
 503         struct kmem_cache *mem = pool_data;
 504         kmem_cache_free(mem, element);
 505 }
 506 EXPORT_SYMBOL(mempool_free_slab);
 507
 508 /*
 509  * A commonly used alloc and free fn that kmalloc/kfrees the amount of memory
 510  * specified by pool_data
 511  */
 512 void *mempool_kmalloc(gfp_t gfp_mask, void *pool_data)
 513 {
 514         size_t size = (size_t)pool_data;
 515         return kmalloc(size, gfp_mask);
 516 }
 517 EXPORT_SYMBOL(mempool_kmalloc);
 518
 519 void mempool_kfree(void *element, void *pool_data)
 520 {
 521         kfree(element);
 522 }
 523 EXPORT_SYMBOL(mempool_kfree);
 524
 525 void *mempool_kvmalloc(gfp_t gfp_mask, void *pool_data)
 526 {
 527         size_t size = (size_t)pool_data;
 528         return kvmalloc(size, gfp_mask);
 529 }
 530 EXPORT_SYMBOL(mempool_kvmalloc);
 531
 532 void mempool_kvfree(void *element, void *pool_data)
 533 {
 534         kvfree(element);
 535 }
 536 EXPORT_SYMBOL(mempool_kvfree);
 537
 538 /*
 539  * A simple mempool-backed page allocator that allocates pages
 540  * of the order specified by pool_data.
 541  */
 542 void *mempool_alloc_pages(gfp_t gfp_mask, void *pool_data)
 543 {
 544         int order = (int)(long)pool_data;
 545         return alloc_pages(gfp_mask, order);
 546 }
 547 EXPORT_SYMBOL(mempool_alloc_pages);
 548
 549 void mempool_free_pages(void *element, void *pool_data)
 550 {
 551         int order = (int)(long)pool_data;
 552         __free_pages(element, order);
 553 }
 554 EXPORT_SYMBOL(mempool_free_pages);