40#include <rte_config.h>
55#define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL
56#define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL
57#define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL
59#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
66struct rte_mempool_debug_stats {
69 uint64_t put_common_pool_bulk;
70 uint64_t put_common_pool_objs;
71 uint64_t get_common_pool_bulk;
72 uint64_t get_common_pool_objs;
73 uint64_t get_success_bulk;
74 uint64_t get_success_objs;
75 uint64_t get_fail_bulk;
76 uint64_t get_fail_objs;
77 uint64_t get_success_blks;
78 uint64_t get_fail_blks;
110#define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
111 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
112#define RTE_MEMPOOL_MZ_PREFIX "MP_"
115#define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
117#ifndef RTE_MEMPOOL_ALIGN
121#define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
124#define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
139#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
149#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
157struct rte_mempool_objtlr {
205 char name[RTE_MEMPOOL_NAMESIZE];
240#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
242 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
247#define RTE_MEMPOOL_F_NO_SPREAD 0x0001
252#define MEMPOOL_F_NO_SPREAD RTE_MEMPOOL_F_NO_SPREAD
254#define RTE_MEMPOOL_F_NO_CACHE_ALIGN 0x0002
259#define MEMPOOL_F_NO_CACHE_ALIGN RTE_MEMPOOL_F_NO_CACHE_ALIGN
261#define RTE_MEMPOOL_F_SP_PUT 0x0004
266#define MEMPOOL_F_SP_PUT RTE_MEMPOOL_F_SP_PUT
268#define RTE_MEMPOOL_F_SC_GET 0x0008
273#define MEMPOOL_F_SC_GET RTE_MEMPOOL_F_SC_GET
275#define RTE_MEMPOOL_F_POOL_CREATED 0x0010
277#define RTE_MEMPOOL_F_NO_IOVA_CONTIG 0x0020
282#define MEMPOOL_F_NO_IOVA_CONTIG RTE_MEMPOOL_F_NO_IOVA_CONTIG
284#define RTE_MEMPOOL_F_NON_IO 0x0040
289#define RTE_MEMPOOL_VALID_USER_FLAGS (RTE_MEMPOOL_F_NO_SPREAD \
290 | RTE_MEMPOOL_F_NO_CACHE_ALIGN \
291 | RTE_MEMPOOL_F_SP_PUT \
292 | RTE_MEMPOOL_F_SC_GET \
293 | RTE_MEMPOOL_F_NO_IOVA_CONTIG \
305#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
306#define RTE_MEMPOOL_STAT_ADD(mp, name, n) do { \
307 unsigned __lcore_id = rte_lcore_id(); \
308 if (__lcore_id < RTE_MAX_LCORE) { \
309 mp->stats[__lcore_id].name += n; \
313#define RTE_MEMPOOL_STAT_ADD(mp, name, n) do {} while (0)
324#define RTE_MEMPOOL_HEADER_SIZE(mp, cs) \
325 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
326 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
330rte_mempool_get_header(
void *obj)
352static inline struct rte_mempool_objtlr *rte_mempool_get_trailer(
void *obj)
372void rte_mempool_check_cookies(
const struct rte_mempool *mp,
373 void *
const *obj_table_const,
unsigned n,
int free);
375#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
376#define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) \
377 rte_mempool_check_cookies(mp, obj_table_const, n, free)
379#define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) do {} while (0)
397void rte_mempool_contig_blocks_check_cookies(
const struct rte_mempool *mp,
398 void *
const *first_obj_table_const,
unsigned int n,
int free);
400#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
401#define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
403 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
406#define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
411#define RTE_MEMPOOL_OPS_NAMESIZE 32
434 void *
const *obj_table,
unsigned int n);
440 void **obj_table,
unsigned int n);
446 void **first_obj_table,
unsigned int n);
477 uint32_t obj_num, uint32_t pg_shift,
478 size_t *min_chunk_size,
size_t *align);
515ssize_t rte_mempool_op_calc_mem_size_helper(
const struct rte_mempool *mp,
516 uint32_t obj_num, uint32_t pg_shift,
size_t chunk_reserve,
517 size_t *min_chunk_size,
size_t *align);
527 uint32_t obj_num, uint32_t pg_shift,
528 size_t *min_chunk_size,
size_t *align);
574 unsigned int max_objs,
581#define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
615int rte_mempool_op_populate_helper(
struct rte_mempool *mp,
616 unsigned int flags,
unsigned int max_objs,
627 unsigned int max_objs,
666#define RTE_MEMPOOL_MAX_OPS_IDX 16
699rte_mempool_get_ops(
int ops_index)
732rte_mempool_ops_dequeue_bulk(
struct rte_mempool *mp,
733 void **obj_table,
unsigned n)
738 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
739 ops = rte_mempool_get_ops(mp->
ops_index);
740 ret = ops->
dequeue(mp, obj_table, n);
742 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
743 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
762rte_mempool_ops_dequeue_contig_blocks(
struct rte_mempool *mp,
763 void **first_obj_table,
unsigned int n)
767 ops = rte_mempool_get_ops(mp->
ops_index);
769 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
787rte_mempool_ops_enqueue_bulk(
struct rte_mempool *mp,
void *
const *obj_table,
793 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
794 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
795 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
796 ops = rte_mempool_get_ops(mp->
ops_index);
797 ret = ops->
enqueue(mp, obj_table, n);
798#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
800 RTE_LOG(CRIT, MEMPOOL,
"cannot enqueue %u objects to mempool %s\n",
815rte_mempool_ops_get_count(
const struct rte_mempool *mp);
836ssize_t rte_mempool_ops_calc_mem_size(
const struct rte_mempool *mp,
837 uint32_t obj_num, uint32_t pg_shift,
838 size_t *min_chunk_size,
size_t *align);
863int rte_mempool_ops_populate(
struct rte_mempool *mp,
unsigned int max_objs,
930#define RTE_MEMPOOL_REGISTER_OPS(ops) \
931 RTE_INIT(mp_hdlr_init_##ops) \
933 rte_mempool_register_ops(&ops); \
942 void *opaque,
void *obj,
unsigned obj_idx);
1283 if (lcore_id >= RTE_MAX_LCORE)
1286 rte_mempool_trace_default_cache(mp, lcore_id,
1305 if (cache == NULL || cache->
len == 0)
1307 rte_mempool_trace_cache_flush(cache, mp);
1308 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->
len);
1325rte_mempool_do_generic_put(
struct rte_mempool *mp,
void *
const *obj_table,
1331 RTE_MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1332 RTE_MEMPOOL_STAT_ADD(mp, put_objs, n);
1336 goto driver_enqueue;
1346 cache_objs = &cache->objs[cache->
len];
1349 cache_objs = &cache->objs[0];
1350 rte_mempool_ops_enqueue_bulk(mp, cache_objs, cache->
len);
1355 rte_memcpy(cache_objs, obj_table,
sizeof(
void *) * n);
1362 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1382 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1383 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 0);
1384 rte_mempool_do_generic_put(mp, obj_table, n, cache);
1407 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1444rte_mempool_do_generic_get(
struct rte_mempool *mp,
void **obj_table,
1448 unsigned int remaining = n;
1449 uint32_t index,
len;
1454 goto driver_dequeue;
1458 cache_objs = &cache->objs[cache->
len];
1461 for (index = 0; index <
len; index++)
1462 *obj_table++ = *--cache_objs;
1464 if (remaining == 0) {
1467 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1468 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1474 if (
unlikely(remaining > RTE_MEMPOOL_CACHE_MAX_SIZE))
1475 goto driver_dequeue;
1478 ret = rte_mempool_ops_dequeue_bulk(mp, cache->objs,
1479 cache->
size + remaining);
1487 goto driver_dequeue;
1491 cache_objs = &cache->objs[cache->
size + remaining];
1492 for (index = 0; index < remaining; index++)
1493 *obj_table++ = *--cache_objs;
1497 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1498 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1505 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, remaining);
1508 if (
likely(cache != NULL)) {
1509 cache->
len = n - remaining;
1517 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1518 RTE_MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1520 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1521 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1552 ret = rte_mempool_do_generic_get(mp, obj_table, n, cache);
1554 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 1);
1555 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1586 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1639 void **first_obj_table,
unsigned int n)
1643 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1645 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1646 RTE_MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1647 RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table, n,
1650 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1651 RTE_MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1654 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1828rte_mempool_get_page_size(
struct rte_mempool *mp,
size_t *pg_sz);
1850typedef void (rte_mempool_event_callback)(
1873rte_mempool_event_callback_register(rte_mempool_event_callback *func,
1891rte_mempool_event_callback_unregister(rte_mempool_event_callback *func,
#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)
#define RTE_LOG(l, t,...)
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)
static __rte_always_inline struct rte_mempool_cache * rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
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)
struct rte_mempool * rte_mempool_lookup(const char *name)
int(* rte_mempool_enqueue_t)(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
static struct rte_mempool * rte_mempool_from_obj(void *obj)
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)
@ RTE_MEMPOOL_EVENT_DESTROY
@ RTE_MEMPOOL_EVENT_READY
unsigned(* rte_mempool_get_count)(const struct rte_mempool *mp)
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)
unsigned int rte_mempool_avail_count(const 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)
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)
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)
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)
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)
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)
struct rte_mempool_cache * rte_mempool_cache_create(uint32_t size, int socket_id)
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 *)
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)
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)
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)
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 void * rte_mempool_get_priv(struct rte_mempool *mp)
RTE_STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr)
int(* rte_mempool_get_info_t)(const struct rte_mempool *mp, struct rte_mempool_info *info)
void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE *2] __rte_cache_aligned
unsigned int contig_block_size
RTE_STAILQ_ENTRY(rte_mempool_memhdr) next
rte_mempool_memchunk_free_cb_t * free_cb
RTE_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
const struct rte_memzone * mz
struct rte_mempool_memhdr_list mem_list
char name[RTE_MEMPOOL_NAMESIZE]
unsigned private_data_size
struct rte_mempool_cache * local_cache
struct rte_mempool_objhdr_list elt_list