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
68 struct rte_mempool_debug_stats {
71 uint64_t get_success_bulk;
72 uint64_t get_success_objs;
73 uint64_t get_fail_bulk;
74 uint64_t get_fail_objs;
76 uint64_t get_success_blks;
78 uint64_t get_fail_blks;
93 void *
objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3];
108 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
109 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
110 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
113 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
115 #define MEMPOOL_PG_SHIFT_MAX \
116 RTE_DEPRECATED(MEMPOOL_PG_SHIFT_MAX) (sizeof(uintptr_t) * CHAR_BIT - 1)
119 #define MEMPOOL_PG_NUM_DEFAULT RTE_DEPRECATED(MEMPOOL_PG_NUM_DEFAULT) 1
121 #ifndef RTE_MEMPOOL_ALIGN
125 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
128 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
143 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
153 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
161 struct rte_mempool_objtlr {
245 struct rte_mempool_objhdr_list
elt_list;
247 struct rte_mempool_memhdr_list
mem_list;
249 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
251 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
255 #define MEMPOOL_F_NO_SPREAD 0x0001
257 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002
258 #define MEMPOOL_F_SP_PUT 0x0004
259 #define MEMPOOL_F_SC_GET 0x0008
260 #define MEMPOOL_F_POOL_CREATED 0x0010
261 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020
273 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
274 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
275 unsigned __lcore_id = rte_lcore_id(); \
276 if (__lcore_id < RTE_MAX_LCORE) { \
277 mp->stats[__lcore_id].name##_objs += n; \
278 mp->stats[__lcore_id].name##_bulk += 1; \
281 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do { \
282 unsigned int __lcore_id = rte_lcore_id(); \
283 if (__lcore_id < RTE_MAX_LCORE) { \
284 mp->stats[__lcore_id].name##_blks += n; \
285 mp->stats[__lcore_id].name##_bulk += 1; \
289 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
290 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do {} while (0)
301 #define MEMPOOL_HEADER_SIZE(mp, cs) \
302 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
303 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
328 static inline struct rte_mempool_objtlr *__mempool_get_trailer(
void *obj)
348 void rte_mempool_check_cookies(
const struct rte_mempool *mp,
349 void *
const *obj_table_const,
unsigned n,
int free);
351 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
352 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
353 rte_mempool_check_cookies(mp, obj_table_const, n, free)
355 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
373 void rte_mempool_contig_blocks_check_cookies(
const struct rte_mempool *mp,
374 void *
const *first_obj_table_const,
unsigned int n,
int free);
376 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
377 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
379 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
382 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
387 #define RTE_MEMPOOL_OPS_NAMESIZE 32
410 void *
const *obj_table,
unsigned int n);
416 void **obj_table,
unsigned int n);
422 void **first_obj_table,
unsigned int n);
453 uint32_t obj_num, uint32_t pg_shift,
454 size_t *min_chunk_size,
size_t *align);
491 ssize_t rte_mempool_op_calc_mem_size_helper(
const struct rte_mempool *mp,
492 uint32_t obj_num, uint32_t pg_shift,
size_t chunk_reserve,
493 size_t *min_chunk_size,
size_t *align);
503 uint32_t obj_num, uint32_t pg_shift,
504 size_t *min_chunk_size,
size_t *align);
550 unsigned int max_objs,
557 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
591 int rte_mempool_op_populate_helper(
struct rte_mempool *mp,
592 unsigned int flags,
unsigned int max_objs,
603 unsigned int max_objs,
642 #define RTE_MEMPOOL_MAX_OPS_IDX 16
675 rte_mempool_get_ops(
int ops_index)
708 rte_mempool_ops_dequeue_bulk(
struct rte_mempool *mp,
709 void **obj_table,
unsigned n)
713 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
714 ops = rte_mempool_get_ops(mp->
ops_index);
715 return ops->
dequeue(mp, obj_table, n);
732 rte_mempool_ops_dequeue_contig_blocks(
struct rte_mempool *mp,
733 void **first_obj_table,
unsigned int n)
737 ops = rte_mempool_get_ops(mp->
ops_index);
739 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
757 rte_mempool_ops_enqueue_bulk(
struct rte_mempool *mp,
void *
const *obj_table,
762 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
763 ops = rte_mempool_get_ops(mp->
ops_index);
764 return ops->
enqueue(mp, obj_table, n);
776 rte_mempool_ops_get_count(
const struct rte_mempool *mp);
797 ssize_t rte_mempool_ops_calc_mem_size(
const struct rte_mempool *mp,
798 uint32_t obj_num, uint32_t pg_shift,
799 size_t *min_chunk_size,
size_t *align);
824 int rte_mempool_ops_populate(
struct rte_mempool *mp,
unsigned int max_objs,
891 #define MEMPOOL_REGISTER_OPS(ops) \
892 RTE_INIT(mp_hdlr_init_##ops) \
894 rte_mempool_register_ops(&ops); \
903 void *opaque,
void *obj,
unsigned obj_idx);
1243 if (lcore_id >= RTE_MAX_LCORE)
1246 rte_mempool_trace_default_cache(mp, lcore_id,
1265 if (cache == NULL || cache->
len == 0)
1267 rte_mempool_trace_cache_flush(cache, mp);
1268 rte_mempool_ops_enqueue_bulk(mp, cache->
objs, cache->
len);
1285 __mempool_generic_put(
struct rte_mempool *mp,
void *
const *obj_table,
1291 __MEMPOOL_STAT_ADD(mp, put, n);
1294 if (
unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1297 cache_objs = &cache->
objs[cache->
len];
1307 rte_memcpy(&cache_objs[0], obj_table,
sizeof(
void *) * n);
1312 rte_mempool_ops_enqueue_bulk(mp, &cache->
objs[cache->
size],
1322 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1323 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1324 rte_panic(
"cannot put objects in mempool\n");
1326 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1347 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1348 __mempool_check_cookies(mp, obj_table, n, 0);
1349 __mempool_generic_put(mp, obj_table, n, cache);
1372 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1409 __mempool_generic_get(
struct rte_mempool *mp,
void **obj_table,
1413 unsigned int remaining = n;
1414 uint32_t index,
len;
1419 goto driver_dequeue;
1423 cache_objs = &cache->
objs[cache->
len];
1426 for (index = 0; index <
len; index++)
1427 *obj_table++ = *--cache_objs;
1429 if (remaining == 0) {
1432 __MEMPOOL_STAT_ADD(mp, get_success, n);
1438 if (
unlikely(remaining > RTE_MEMPOOL_CACHE_MAX_SIZE))
1439 goto driver_dequeue;
1442 ret = rte_mempool_ops_dequeue_bulk(mp, cache->
objs,
1443 cache->
size + remaining);
1451 goto driver_dequeue;
1455 cache_objs = &cache->
objs[cache->
size + remaining];
1456 for (index = 0; index < remaining; index++)
1457 *obj_table++ = *--cache_objs;
1461 __MEMPOOL_STAT_ADD(mp, get_success, n);
1468 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, remaining);
1471 if (
likely(cache != NULL)) {
1472 cache->
len = n - remaining;
1480 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1482 __MEMPOOL_STAT_ADD(mp, get_success, n);
1512 ret = __mempool_generic_get(mp, obj_table, n, cache);
1514 __mempool_check_cookies(mp, obj_table, n, 1);
1515 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1546 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1599 void **first_obj_table,
unsigned int n)
1603 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1605 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_success, n);
1606 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1609 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_fail, n);
1612 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1786 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