mempool.h 3.3 KB

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