git.sesse.net Git - bcachefs-tools-debian/blob - c_src/include/linux/mempool.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * memory buffer pool support
   4  */
   5 #ifndef _LINUX_MEMPOOL_H
   6 #define _LINUX_MEMPOOL_H
   7
   8 #include <linux/wait.h>
   9 #include <linux/compiler.h>
  10 #include <linux/slab.h>
  11
  12 struct kmem_cache;
  13
  14 typedef void * (mempool_alloc_t)(gfp_t gfp_mask, void *pool_data);
  15 typedef void (mempool_free_t)(void *element, void *pool_data);
  16
  17 typedef struct mempool_s {
  18         spinlock_t lock;
  19         int min_nr;             /* nr of elements at *elements */
  20         int curr_nr;            /* Current nr of elements at *elements */
  21         void **elements;
  22
  23         void *pool_data;
  24         mempool_alloc_t *alloc;
  25         mempool_free_t *free;
  26         wait_queue_head_t wait;
  27 } mempool_t;
  28
  29 static inline bool mempool_initialized(mempool_t *pool)
  30 {
  31         return pool->elements != NULL;
  32 }
  33
  34 void mempool_exit(mempool_t *pool);
  35 int mempool_init_node(mempool_t *pool, int min_nr, mempool_alloc_t *alloc_fn,
  36                       mempool_free_t *free_fn, void *pool_data,
  37                       gfp_t gfp_mask, int node_id);
  38 int mempool_init(mempool_t *pool, int min_nr, mempool_alloc_t *alloc_fn,
  39                  mempool_free_t *free_fn, void *pool_data);
  40
  41 extern mempool_t *mempool_create(int min_nr, mempool_alloc_t *alloc_fn,
  42                         mempool_free_t *free_fn, void *pool_data);
  43 extern mempool_t *mempool_create_node(int min_nr, mempool_alloc_t *alloc_fn,
  44                         mempool_free_t *free_fn, void *pool_data,
  45                         gfp_t gfp_mask, int nid);
  46
  47 extern int mempool_resize(mempool_t *pool, int new_min_nr);
  48 extern void mempool_destroy(mempool_t *pool);
  49 extern void *mempool_alloc(mempool_t *pool, gfp_t gfp_mask) __malloc;
  50 extern void mempool_free(void *element, mempool_t *pool);
  51
  52 /*
  53  * A mempool_alloc_t and mempool_free_t that get the memory from
  54  * a slab cache that is passed in through pool_data.
  55  * Note: the slab cache may not have a ctor function.
  56  */
  57 void *mempool_alloc_slab(gfp_t gfp_mask, void *pool_data);
  58 void mempool_free_slab(void *element, void *pool_data);
  59
  60 static inline int
  61 mempool_init_slab_pool(mempool_t *pool, int min_nr, struct kmem_cache *kc)
  62 {
  63         return mempool_init(pool, min_nr, mempool_alloc_slab,
  64                             mempool_free_slab, (void *) kc);
  65 }
  66
  67 static inline mempool_t *
  68 mempool_create_slab_pool(int min_nr, struct kmem_cache *kc)
  69 {
  70         return mempool_create(min_nr, mempool_alloc_slab, mempool_free_slab,
  71                               (void *) kc);
  72 }
  73
  74 /*
  75  * a mempool_alloc_t and a mempool_free_t to kmalloc and kfree the
  76  * amount of memory specified by pool_data
  77  */
  78 void *mempool_kmalloc(gfp_t gfp_mask, void *pool_data);
  79 void mempool_kfree(void *element, void *pool_data);
  80
  81 static inline int mempool_init_kmalloc_pool(mempool_t *pool, int min_nr, size_t size)
  82 {
  83         return mempool_init(pool, min_nr, mempool_kmalloc,
  84                             mempool_kfree, (void *) size);
  85 }
  86
  87 static inline mempool_t *mempool_create_kmalloc_pool(int min_nr, size_t size)
  88 {
  89         return mempool_create(min_nr, mempool_kmalloc, mempool_kfree,
  90                               (void *) size);
  91 }
  92
  93 /*
  94  * A mempool_alloc_t and mempool_free_t for a simple page allocator that
  95  * allocates pages of the order specified by pool_data
  96  */
  97 void *mempool_alloc_pages(gfp_t gfp_mask, void *pool_data);
  98 void mempool_free_pages(void *element, void *pool_data);
  99
 100 static inline int mempool_init_page_pool(mempool_t *pool, int min_nr, int order)
 101 {
 102         return mempool_init(pool, min_nr, mempool_alloc_pages,
 103                             mempool_free_pages, (void *)(long)order);
 104 }
 105
 106 static inline mempool_t *mempool_create_page_pool(int min_nr, int order)
 107 {
 108         return mempool_create(min_nr, mempool_alloc_pages, mempool_free_pages,
 109                               (void *)(long)order);
 110 }
 111
 112 #endif /* _LINUX_MEMPOOL_H */