6 #ifndef _RTE_MEMPOOL_H_
7 #define _RTE_MEMPOOL_H_
41 #include <sys/queue.h>
43 #include <rte_config.h>
60 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL
61 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL
62 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL
64 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
71 struct rte_mempool_debug_stats {
74 uint64_t put_common_pool_bulk;
75 uint64_t put_common_pool_objs;
76 uint64_t get_common_pool_bulk;
77 uint64_t get_common_pool_objs;
78 uint64_t get_success_bulk;
79 uint64_t get_success_objs;
80 uint64_t get_fail_bulk;
81 uint64_t get_fail_objs;
82 uint64_t get_success_blks;
83 uint64_t get_fail_blks;
98 void *
objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3];
113 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
114 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
115 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
118 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
120 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
123 #define MEMPOOL_PG_NUM_DEFAULT 1
125 #ifndef RTE_MEMPOOL_ALIGN
129 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
132 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
147 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
157 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
165 struct rte_mempool_objtlr {
249 struct rte_mempool_objhdr_list
elt_list;
251 struct rte_mempool_memhdr_list
mem_list;
253 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
255 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
259 #define MEMPOOL_F_NO_SPREAD 0x0001
261 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002
262 #define MEMPOOL_F_SP_PUT 0x0004
263 #define MEMPOOL_F_SC_GET 0x0008
264 #define MEMPOOL_F_POOL_CREATED 0x0010
265 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020
277 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
278 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
279 unsigned __lcore_id = rte_lcore_id(); \
280 if (__lcore_id < RTE_MAX_LCORE) { \
281 mp->stats[__lcore_id].name += n; \
285 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
296 #define MEMPOOL_HEADER_SIZE(mp, cs) \
297 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
298 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
323 static inline struct rte_mempool_objtlr *__mempool_get_trailer(
void *obj)
343 void rte_mempool_check_cookies(
const struct rte_mempool *mp,
344 void *
const *obj_table_const,
unsigned n,
int free);
346 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
347 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
348 rte_mempool_check_cookies(mp, obj_table_const, n, free)
350 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
368 void rte_mempool_contig_blocks_check_cookies(
const struct rte_mempool *mp,
369 void *
const *first_obj_table_const,
unsigned int n,
int free);
371 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
372 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
374 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
377 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
382 #define RTE_MEMPOOL_OPS_NAMESIZE 32
405 void *
const *obj_table,
unsigned int n);
411 void **obj_table,
unsigned int n);
417 void **first_obj_table,
unsigned int n);
448 uint32_t obj_num, uint32_t pg_shift,
449 size_t *min_chunk_size,
size_t *align);
486 ssize_t rte_mempool_op_calc_mem_size_helper(
const struct rte_mempool *mp,
487 uint32_t obj_num, uint32_t pg_shift,
size_t chunk_reserve,
488 size_t *min_chunk_size,
size_t *align);
498 uint32_t obj_num, uint32_t pg_shift,
499 size_t *min_chunk_size,
size_t *align);
545 unsigned int max_objs,
552 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
586 int rte_mempool_op_populate_helper(
struct rte_mempool *mp,
587 unsigned int flags,
unsigned int max_objs,
598 unsigned int max_objs,
637 #define RTE_MEMPOOL_MAX_OPS_IDX 16
670 rte_mempool_get_ops(
int ops_index)
703 rte_mempool_ops_dequeue_bulk(
struct rte_mempool *mp,
704 void **obj_table,
unsigned n)
709 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
710 ops = rte_mempool_get_ops(mp->
ops_index);
711 ret = ops->
dequeue(mp, obj_table, n);
713 __MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
714 __MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
733 rte_mempool_ops_dequeue_contig_blocks(
struct rte_mempool *mp,
734 void **first_obj_table,
unsigned int n)
738 ops = rte_mempool_get_ops(mp->
ops_index);
740 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
758 rte_mempool_ops_enqueue_bulk(
struct rte_mempool *mp,
void *
const *obj_table,
763 __MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
764 __MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
765 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
766 ops = rte_mempool_get_ops(mp->
ops_index);
767 return ops->
enqueue(mp, obj_table, n);
779 rte_mempool_ops_get_count(
const struct rte_mempool *mp);
800 ssize_t rte_mempool_ops_calc_mem_size(
const struct rte_mempool *mp,
801 uint32_t obj_num, uint32_t pg_shift,
802 size_t *min_chunk_size,
size_t *align);
827 int rte_mempool_ops_populate(
struct rte_mempool *mp,
unsigned int max_objs,
894 #define MEMPOOL_REGISTER_OPS(ops) \
895 RTE_INIT(mp_hdlr_init_##ops) \
897 rte_mempool_register_ops(&ops); \
906 void *opaque,
void *obj,
unsigned obj_idx);
1247 if (lcore_id >= RTE_MAX_LCORE)
1250 rte_mempool_trace_default_cache(mp, lcore_id,
1269 if (cache == NULL || cache->
len == 0)
1271 rte_mempool_trace_cache_flush(cache, mp);
1272 rte_mempool_ops_enqueue_bulk(mp, cache->
objs, cache->
len);
1289 __mempool_generic_put(
struct rte_mempool *mp,
void *
const *obj_table,
1295 __MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1296 __MEMPOOL_STAT_ADD(mp, put_objs, n);
1299 if (
unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1302 cache_objs = &cache->
objs[cache->
len];
1312 rte_memcpy(&cache_objs[0], obj_table,
sizeof(
void *) * n);
1317 rte_mempool_ops_enqueue_bulk(mp, &cache->
objs[cache->
size],
1327 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1328 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1329 rte_panic(
"cannot put objects in mempool\n");
1331 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1352 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1353 __mempool_check_cookies(mp, obj_table, n, 0);
1354 __mempool_generic_put(mp, obj_table, n, cache);
1377 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1414 __mempool_generic_get(
struct rte_mempool *mp,
void **obj_table,
1418 uint32_t index,
len;
1425 cache_objs = cache->
objs;
1428 if (cache->
len < n) {
1430 uint32_t req = n + (cache->
size - cache->
len);
1433 ret = rte_mempool_ops_dequeue_bulk(mp,
1434 &cache->
objs[cache->
len], req);
1449 for (index = 0,
len = cache->
len - 1; index < n; ++index,
len--, obj_table++)
1450 *obj_table = cache_objs[
len];
1454 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1455 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1462 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1465 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1466 __MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1468 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1469 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1500 ret = __mempool_generic_get(mp, obj_table, n, cache);
1502 __mempool_check_cookies(mp, obj_table, n, 1);
1503 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1534 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1587 void **first_obj_table,
unsigned int n)
1591 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1593 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1594 __MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1595 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1598 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1599 __MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1602 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1776 rte_mempool_get_page_size(
struct rte_mempool *mp,
size_t *pg_sz);
#define __rte_cache_aligned
#define RTE_PTR_SUB(ptr, x)
#define RTE_PTR_ADD(ptr, x)
#define __rte_always_inline
static unsigned rte_lcore_id(void)
static void * rte_memcpy(void *dst, const void *src, size_t n)
void() rte_mempool_memchunk_free_cb_t(struct rte_mempool_memhdr *memhdr, void *opaque)
int rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name, void *pool_config)
static __rte_always_inline int rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
int rte_mempool_op_populate_default(struct rte_mempool *mp, unsigned int max_objs, void *vaddr, rte_iova_t iova, size_t len, rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg)
uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags, struct rte_mempool_objsz *sz)
void() rte_mempool_obj_cb_t(struct rte_mempool *mp, void *opaque, void *obj, unsigned obj_idx)
int(* rte_mempool_enqueue_t)(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
static rte_iova_t rte_mempool_virt2iova(const void *elt)
int(* rte_mempool_dequeue_t)(struct rte_mempool *mp, void **obj_table, unsigned int n)
void rte_mempool_free(struct rte_mempool *mp)
unsigned(* rte_mempool_get_count)(const struct rte_mempool *mp)
struct rte_mempool * rte_mempool_lookup(const char *name)
void() rte_mempool_populate_obj_cb_t(struct rte_mempool *mp, void *opaque, void *vaddr, rte_iova_t iova)
int rte_mempool_populate_default(struct rte_mempool *mp)
struct rte_mempool * rte_mempool_create(const char *name, unsigned n, unsigned elt_size, unsigned cache_size, unsigned private_data_size, rte_mempool_ctor_t *mp_init, void *mp_init_arg, rte_mempool_obj_cb_t *obj_init, void *obj_init_arg, int socket_id, unsigned flags)
unsigned int rte_mempool_avail_count(const struct rte_mempool *mp)
struct rte_mempool * rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size, unsigned cache_size, unsigned private_data_size, int socket_id, unsigned flags)
static __rte_always_inline int rte_mempool_get_contig_blocks(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
int(* rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
void(* rte_mempool_free_t)(struct rte_mempool *mp)
static __rte_always_inline void rte_mempool_cache_flush(struct rte_mempool_cache *cache, struct rte_mempool *mp)
STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr)
static __rte_always_inline void rte_mempool_put_bulk(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
static __rte_always_inline int rte_mempool_get(struct rte_mempool *mp, void **obj_p)
int rte_mempool_register_ops(const struct rte_mempool_ops *ops)
int rte_mempool_populate_virt(struct rte_mempool *mp, char *addr, size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb, void *opaque)
static void * rte_mempool_get_priv(struct rte_mempool *mp)
ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp, uint32_t obj_num, uint32_t pg_shift, size_t *min_chunk_size, size_t *align)
int rte_mempool_populate_anon(struct rte_mempool *mp)
void rte_mempool_cache_free(struct rte_mempool_cache *cache)
static __rte_always_inline void rte_mempool_generic_put(struct rte_mempool *mp, void *const *obj_table, unsigned int n, struct rte_mempool_cache *cache)
static int rte_mempool_full(const struct rte_mempool *mp)
int(* rte_mempool_alloc_t)(struct rte_mempool *mp)
void rte_mempool_dump(FILE *f, struct rte_mempool *mp)
static __rte_always_inline int rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table, unsigned int n, struct rte_mempool_cache *cache)
static struct rte_mempool * rte_mempool_from_obj(void *obj)
void rte_mempool_audit(struct rte_mempool *mp)
void rte_mempool_walk(void(*func)(struct rte_mempool *, void *arg), void *arg)
#define RTE_MEMPOOL_OPS_NAMESIZE
void() rte_mempool_ctor_t(struct rte_mempool *, void *)
void() rte_mempool_mem_cb_t(struct rte_mempool *mp, void *opaque, struct rte_mempool_memhdr *memhdr, unsigned mem_idx)
ssize_t(* rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp, uint32_t obj_num, uint32_t pg_shift, size_t *min_chunk_size, size_t *align)
static __rte_always_inline void rte_mempool_put(struct rte_mempool *mp, void *obj)
int rte_mempool_ops_get_info(const struct rte_mempool *mp, struct rte_mempool_info *info)
struct rte_mempool_cache * rte_mempool_cache_create(uint32_t size, int socket_id)
unsigned int rte_mempool_in_use_count(const struct rte_mempool *mp)
uint32_t rte_mempool_obj_iter(struct rte_mempool *mp, rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg)
#define MEMPOOL_HEADER_SIZE(mp, cs)
int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr, rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb, void *opaque)
void rte_mempool_list_dump(FILE *f)
#define RTE_MEMPOOL_MAX_OPS_IDX
static int rte_mempool_empty(const struct rte_mempool *mp)
uint32_t rte_mempool_mem_iter(struct rte_mempool *mp, rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg)
int(* rte_mempool_populate_t)(struct rte_mempool *mp, unsigned int max_objs, void *vaddr, rte_iova_t iova, size_t len, rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg)
static __rte_always_inline struct rte_mempool_cache * rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
int(* rte_mempool_get_info_t)(const struct rte_mempool *mp, struct rte_mempool_info *info)
#define RTE_MEMZONE_NAMESIZE
void * objs[RTE_MEMPOOL_CACHE_MAX_SIZE *3]
unsigned int contig_block_size
STAILQ_ENTRY(rte_mempool_memhdr) next
rte_mempool_memchunk_free_cb_t * free_cb
STAILQ_ENTRY(rte_mempool_objhdr) next
struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX]
char name[RTE_MEMPOOL_OPS_NAMESIZE]
rte_mempool_alloc_t alloc
rte_mempool_dequeue_t dequeue
rte_mempool_get_info_t get_info
rte_mempool_calc_mem_size_t calc_mem_size
rte_mempool_get_count get_count
rte_mempool_populate_t populate
rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks
rte_mempool_enqueue_t enqueue
char name[RTE_MEMZONE_NAMESIZE]
const struct rte_memzone * mz
struct rte_mempool_memhdr_list mem_list
unsigned private_data_size
struct rte_mempool_cache * local_cache
struct rte_mempool_objhdr_list elt_list