1 /* SPDX-License-Identifier: GPL-2.0 */
3 * memory buffer pool support
5 #ifndef _LINUX_MEMPOOL_H
6 #define _LINUX_MEMPOOL_H
8 #include <linux/wait.h>
9 #include <linux/compiler.h>
10 #include <linux/slab.h>
14 typedef void * (mempool_alloc_t)(gfp_t gfp_mask, void *pool_data);
15 typedef void (mempool_free_t)(void *element, void *pool_data);
17 typedef struct mempool_s {
19 int min_nr; /* nr of elements at *elements */
20 int curr_nr; /* Current nr of elements at *elements */
24 mempool_alloc_t *alloc;
26 wait_queue_head_t wait;
29 static inline bool mempool_initialized(mempool_t *pool)
31 return pool->elements != NULL;
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);
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);
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);
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.
57 void *mempool_alloc_slab(gfp_t gfp_mask, void *pool_data);
58 void mempool_free_slab(void *element, void *pool_data);
61 mempool_init_slab_pool(mempool_t *pool, int min_nr, struct kmem_cache *kc)
63 return mempool_init(pool, min_nr, mempool_alloc_slab,
64 mempool_free_slab, (void *) kc);
67 static inline mempool_t *
68 mempool_create_slab_pool(int min_nr, struct kmem_cache *kc)
70 return mempool_create(min_nr, mempool_alloc_slab, mempool_free_slab,
75 * a mempool_alloc_t and a mempool_free_t to kmalloc and kfree the
76 * amount of memory specified by pool_data
78 void *mempool_kmalloc(gfp_t gfp_mask, void *pool_data);
79 void mempool_kfree(void *element, void *pool_data);
81 static inline int mempool_init_kmalloc_pool(mempool_t *pool, int min_nr, size_t size)
83 return mempool_init(pool, min_nr, mempool_kmalloc,
84 mempool_kfree, (void *) size);
87 static inline mempool_t *mempool_create_kmalloc_pool(int min_nr, size_t size)
89 return mempool_create(min_nr, mempool_kmalloc, mempool_kfree,
93 void *mempool_kvmalloc(gfp_t gfp_mask, void *pool_data);
94 void mempool_kvfree(void *element, void *pool_data);
96 static inline int mempool_init_kvmalloc_pool(mempool_t *pool, int min_nr, size_t size)
98 return mempool_init(pool, min_nr, mempool_kvmalloc, mempool_kvfree, (void *) size);
101 static inline mempool_t *mempool_create_kvmalloc_pool(int min_nr, size_t size)
103 return mempool_create(min_nr, mempool_kvmalloc, mempool_kvfree, (void *) size);
107 * A mempool_alloc_t and mempool_free_t for a simple page allocator that
108 * allocates pages of the order specified by pool_data
110 void *mempool_alloc_pages(gfp_t gfp_mask, void *pool_data);
111 void mempool_free_pages(void *element, void *pool_data);
113 static inline int mempool_init_page_pool(mempool_t *pool, int min_nr, int order)
115 return mempool_init(pool, min_nr, mempool_alloc_pages,
116 mempool_free_pages, (void *)(long)order);
119 static inline mempool_t *mempool_create_page_pool(int min_nr, int order)
121 return mempool_create(min_nr, mempool_alloc_pages, mempool_free_pages,
122 (void *)(long)order);
125 #endif /* _LINUX_MEMPOOL_H */