6 #ifndef _RTE_MEMPOOL_H_ 7 #define _RTE_MEMPOOL_H_ 42 #include <rte_config.h> 59 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL 60 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL 61 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL 63 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 70 struct rte_mempool_debug_stats {
73 uint64_t put_common_pool_bulk;
74 uint64_t put_common_pool_objs;
75 uint64_t get_common_pool_bulk;
76 uint64_t get_common_pool_objs;
77 uint64_t get_success_bulk;
78 uint64_t get_success_objs;
79 uint64_t get_fail_bulk;
80 uint64_t get_fail_objs;
81 uint64_t get_success_blks;
82 uint64_t get_fail_blks;
97 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3];
112 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \ 113 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1) 114 #define RTE_MEMPOOL_MZ_PREFIX "MP_" 117 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s" 119 #define MEMPOOL_PG_SHIFT_MAX \ 120 RTE_DEPRECATED(MEMPOOL_PG_SHIFT_MAX) (sizeof(uintptr_t) * CHAR_BIT - 1) 123 #define MEMPOOL_PG_NUM_DEFAULT RTE_DEPRECATED(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 {
213 char name[RTE_MEMPOOL_NAMESIZE];
244 struct rte_mempool_objhdr_list elt_list;
246 struct rte_mempool_memhdr_list mem_list;
248 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 250 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
255 #define RTE_MEMPOOL_F_NO_SPREAD 0x0001 260 #define MEMPOOL_F_NO_SPREAD RTE_MEMPOOL_F_NO_SPREAD 262 #define RTE_MEMPOOL_F_NO_CACHE_ALIGN 0x0002 267 #define MEMPOOL_F_NO_CACHE_ALIGN RTE_MEMPOOL_F_NO_CACHE_ALIGN 269 #define RTE_MEMPOOL_F_SP_PUT 0x0004 274 #define MEMPOOL_F_SP_PUT RTE_MEMPOOL_F_SP_PUT 276 #define RTE_MEMPOOL_F_SC_GET 0x0008 281 #define MEMPOOL_F_SC_GET RTE_MEMPOOL_F_SC_GET 283 #define RTE_MEMPOOL_F_POOL_CREATED 0x0010 285 #define RTE_MEMPOOL_F_NO_IOVA_CONTIG 0x0020 290 #define MEMPOOL_F_NO_IOVA_CONTIG RTE_MEMPOOL_F_NO_IOVA_CONTIG 292 #define RTE_MEMPOOL_F_NON_IO 0x0040 297 #define RTE_MEMPOOL_VALID_USER_FLAGS (RTE_MEMPOOL_F_NO_SPREAD \ 298 | RTE_MEMPOOL_F_NO_CACHE_ALIGN \ 299 | RTE_MEMPOOL_F_SP_PUT \ 300 | RTE_MEMPOOL_F_SC_GET \ 301 | RTE_MEMPOOL_F_NO_IOVA_CONTIG \ 313 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 314 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do { \ 315 unsigned __lcore_id = rte_lcore_id(); \ 316 if (__lcore_id < RTE_MAX_LCORE) { \ 317 mp->stats[__lcore_id].name += n; \ 321 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do {} while (0) 332 #define RTE_MEMPOOL_HEADER_SIZE(mp, cs) \ 333 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \ 334 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE))) 337 #define MEMPOOL_HEADER_SIZE(mp, cs) \ 338 RTE_DEPRECATED(MEMPOOL_HEADER_SIZE) RTE_MEMPOOL_HEADER_SIZE(mp, cs) 342 rte_mempool_get_header(
void *obj)
364 static inline struct rte_mempool_objtlr *rte_mempool_get_trailer(
void *obj)
384 void rte_mempool_check_cookies(
const struct rte_mempool *mp,
385 void *
const *obj_table_const,
unsigned n,
int free);
387 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 388 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) \ 389 rte_mempool_check_cookies(mp, obj_table_const, n, free) 391 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) do {} while (0) 409 void rte_mempool_contig_blocks_check_cookies(
const struct rte_mempool *mp,
410 void *
const *first_obj_table_const,
unsigned int n,
int free);
412 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 413 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \ 415 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \ 418 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \ 423 #define RTE_MEMPOOL_OPS_NAMESIZE 32 435 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp); 449 void *
const *obj_table,
unsigned int n);
458 void **obj_table,
unsigned int n);
464 void **first_obj_table,
unsigned int n);
495 uint32_t obj_num, uint32_t pg_shift,
496 size_t *min_chunk_size,
size_t *align);
533 ssize_t rte_mempool_op_calc_mem_size_helper(
const struct rte_mempool *mp,
534 uint32_t obj_num, uint32_t pg_shift,
size_t chunk_reserve,
535 size_t *min_chunk_size,
size_t *align);
545 uint32_t obj_num, uint32_t pg_shift,
546 size_t *min_chunk_size,
size_t *align);
592 unsigned int max_objs,
599 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001 633 int rte_mempool_op_populate_helper(
struct rte_mempool *mp,
634 unsigned int flags,
unsigned int max_objs,
645 unsigned int max_objs,
684 #define RTE_MEMPOOL_MAX_OPS_IDX 16 695 struct rte_mempool_ops_table { 717 rte_mempool_get_ops(
int ops_index)
750 rte_mempool_ops_dequeue_bulk(
struct rte_mempool *mp,
751 void **obj_table,
unsigned n)
756 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
757 ops = rte_mempool_get_ops(mp->
ops_index);
758 ret = ops->
dequeue(mp, obj_table, n);
760 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
761 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
780 rte_mempool_ops_dequeue_contig_blocks(
struct rte_mempool *mp,
781 void **first_obj_table,
unsigned int n)
785 ops = rte_mempool_get_ops(mp->
ops_index);
787 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
805 rte_mempool_ops_enqueue_bulk(
struct rte_mempool *mp,
void *
const *obj_table,
810 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
811 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
812 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
813 ops = rte_mempool_get_ops(mp->
ops_index);
814 return ops->
enqueue(mp, obj_table, n);
826 rte_mempool_ops_get_count(
const struct rte_mempool *mp);
847 ssize_t rte_mempool_ops_calc_mem_size(
const struct rte_mempool *mp,
848 uint32_t obj_num, uint32_t pg_shift,
849 size_t *min_chunk_size,
size_t *align);
874 int rte_mempool_ops_populate(
struct rte_mempool *mp,
unsigned int max_objs,
941 #define RTE_MEMPOOL_REGISTER_OPS(ops) \ 942 RTE_INIT(mp_hdlr_init_##ops) \ 944 rte_mempool_register_ops(&ops); \ 948 #define MEMPOOL_REGISTER_OPS(ops) \ 949 RTE_DEPRECATED(MEMPOOL_REGISTER_OPS) RTE_MEMPOOL_REGISTER_OPS(ops) 957 void *opaque,
void *obj,
unsigned obj_idx);
1297 if (lcore_id >= RTE_MAX_LCORE)
1300 rte_mempool_trace_default_cache(mp, lcore_id,
1319 if (cache == NULL || cache->
len == 0)
1321 rte_mempool_trace_cache_flush(cache, mp);
1322 rte_mempool_ops_enqueue_bulk(mp, cache->
objs, cache->
len);
1339 rte_mempool_do_generic_put(
struct rte_mempool *mp,
void *
const *obj_table,
1345 RTE_MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1346 RTE_MEMPOOL_STAT_ADD(mp, put_objs, n);
1349 if (
unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1352 cache_objs = &cache->
objs[cache->
len];
1362 rte_memcpy(&cache_objs[0], obj_table,
sizeof(
void *) * n);
1367 rte_mempool_ops_enqueue_bulk(mp, &cache->
objs[cache->
size],
1377 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 1378 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1379 rte_panic(
"cannot put objects in mempool\n");
1381 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1402 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1403 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 0);
1404 rte_mempool_do_generic_put(mp, obj_table, n, cache);
1427 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1464 rte_mempool_do_generic_get(
struct rte_mempool *mp,
void **obj_table,
1468 uint32_t index,
len;
1475 cache_objs = cache->
objs;
1478 if (cache->
len < n) {
1480 uint32_t req = n + (cache->
size - cache->
len);
1483 ret = rte_mempool_ops_dequeue_bulk(mp,
1484 &cache->
objs[cache->
len], req);
1499 for (index = 0, len = cache->
len - 1; index < n; ++index, len--, obj_table++)
1500 *obj_table = cache_objs[
len];
1504 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1505 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1512 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1515 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1516 RTE_MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1518 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1519 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1550 ret = rte_mempool_do_generic_get(mp, obj_table, n, cache);
1552 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 1);
1553 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1584 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1637 void **first_obj_table,
unsigned int n)
1641 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1643 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1644 RTE_MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1645 RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table, n,
1648 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1649 RTE_MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1652 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1826 rte_mempool_get_page_size(
struct rte_mempool *mp,
size_t *pg_sz);
1848 typedef void (rte_mempool_event_callback)(
1871 rte_mempool_event_callback_register(rte_mempool_event_callback *func,
1889 rte_mempool_event_callback_unregister(rte_mempool_event_callback *func,
#define __rte_always_inline
struct rte_mempool * rte_mempool_lookup(const char *name)
struct rte_mempool_cache * rte_mempool_cache_create(uint32_t size, int socket_id)
uint32_t rte_mempool_mem_iter(struct rte_mempool *mp, rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg)
const struct rte_memzone * mz
static __rte_always_inline void rte_mempool_put_bulk(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
void rte_mempool_list_dump(FILE *f)
void() rte_mempool_memchunk_free_cb_t(struct rte_mempool_memhdr *memhdr, void *opaque)
int(* rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
rte_mempool_alloc_t alloc
void() rte_mempool_populate_obj_cb_t(struct rte_mempool *mp, void *opaque, void *vaddr, rte_iova_t iova)
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)
int(* rte_mempool_alloc_t)(struct rte_mempool *mp)
static int rte_mempool_empty(const struct rte_mempool *mp)
RTE_STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr)
rte_mempool_memchunk_free_cb_t * free_cb
char name[RTE_MEMPOOL_OPS_NAMESIZE]
int(* rte_mempool_dequeue_t)(struct rte_mempool *mp, void **obj_table, unsigned int n)
rte_mempool_get_info_t get_info
rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks
char name[RTE_MEMPOOL_NAMESIZE]
unsigned int rte_mempool_avail_count(const struct rte_mempool *mp)
#define RTE_PTR_ADD(ptr, x)
void rte_mempool_cache_free(struct rte_mempool_cache *cache)
uint32_t rte_mempool_obj_iter(struct rte_mempool *mp, rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg)
int rte_mempool_ops_get_info(const struct rte_mempool *mp, struct rte_mempool_info *info)
int rte_mempool_register_ops(const struct rte_mempool_ops *ops)
static __rte_always_inline int rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table, unsigned int n, struct rte_mempool_cache *cache)
int rte_mempool_populate_default(struct rte_mempool *mp)
static __rte_always_inline void rte_mempool_cache_flush(struct rte_mempool_cache *cache, struct rte_mempool *mp)
#define RTE_MEMPOOL_OPS_NAMESIZE
static __rte_always_inline int rte_mempool_get(struct rte_mempool *mp, void **obj_p)
struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX]
rte_mempool_get_count get_count
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 int rte_mempool_full(const struct rte_mempool *mp)
static unsigned rte_lcore_id(void)
unsigned int rte_mempool_in_use_count(const struct rte_mempool *mp)
static __rte_always_inline int rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
int rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name, void *pool_config)
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)
rte_mempool_calc_mem_size_t calc_mem_size
unsigned(* rte_mempool_get_count)(const struct rte_mempool *mp)
uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags, struct rte_mempool_objsz *sz)
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)
void * objs[RTE_MEMPOOL_CACHE_MAX_SIZE *3]
unsigned int contig_block_size
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)
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)
void rte_mempool_audit(struct rte_mempool *mp)
int(* rte_mempool_get_info_t)(const struct rte_mempool *mp, struct rte_mempool_info *info)
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)
unsigned private_data_size
static __rte_always_inline struct rte_mempool_cache * rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
void rte_mempool_dump(FILE *f, struct rte_mempool *mp)
void() rte_mempool_ctor_t(struct rte_mempool *, void *)
int rte_mempool_populate_anon(struct rte_mempool *mp)
struct rte_mempool_cache * local_cache
#define __rte_cache_aligned
rte_mempool_dequeue_t dequeue
int(* rte_mempool_enqueue_t)(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
void() rte_mempool_obj_cb_t(struct rte_mempool *mp, void *opaque, void *obj, unsigned obj_idx)
void() rte_mempool_mem_cb_t(struct rte_mempool *mp, void *opaque, struct rte_mempool_memhdr *memhdr, unsigned mem_idx)
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)
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)
#define RTE_PTR_SUB(ptr, x)
static struct rte_mempool * rte_mempool_from_obj(void *obj)
static void * rte_memcpy(void *dst, const void *src, size_t n)
static rte_iova_t rte_mempool_virt2iova(const void *elt)
static __rte_always_inline void rte_mempool_put(struct rte_mempool *mp, void *obj)
rte_mempool_populate_t populate
void rte_mempool_free(struct rte_mempool *mp)
void rte_mempool_walk(void(*func)(struct rte_mempool *, void *arg), void *arg)
static void * rte_mempool_get_priv(struct rte_mempool *mp)
#define RTE_MEMPOOL_MAX_OPS_IDX
void(* rte_mempool_free_t)(struct rte_mempool *mp)
static __rte_always_inline int rte_mempool_get_contig_blocks(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
rte_mempool_enqueue_t enqueue