6 #ifndef _RTE_MEMPOOL_H_ 7 #define _RTE_MEMPOOL_H_ 41 #include <sys/queue.h> 43 #include <rte_config.h> 58 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL 59 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL 60 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL 62 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 66 struct rte_mempool_debug_stats {
69 uint64_t get_success_bulk;
70 uint64_t get_success_objs;
71 uint64_t get_fail_bulk;
72 uint64_t get_fail_objs;
74 uint64_t get_success_blks;
76 uint64_t get_fail_blks;
91 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3];
106 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \ 107 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1) 108 #define RTE_MEMPOOL_MZ_PREFIX "MP_" 111 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s" 113 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1) 116 #define MEMPOOL_PG_NUM_DEFAULT 1 118 #ifndef RTE_MEMPOOL_ALIGN 122 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE 125 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1) 144 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 154 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 162 struct rte_mempool_objtlr {
253 struct rte_mempool_objhdr_list elt_list;
255 struct rte_mempool_memhdr_list mem_list;
257 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 259 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
263 #define MEMPOOL_F_NO_SPREAD 0x0001 265 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 266 #define MEMPOOL_F_SP_PUT 0x0004 267 #define MEMPOOL_F_SC_GET 0x0008 268 #define MEMPOOL_F_POOL_CREATED 0x0010 269 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 270 #define MEMPOOL_F_NO_PHYS_CONTIG MEMPOOL_F_NO_IOVA_CONTIG 282 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 283 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \ 284 unsigned __lcore_id = rte_lcore_id(); \ 285 if (__lcore_id < RTE_MAX_LCORE) { \ 286 mp->stats[__lcore_id].name##_objs += n; \ 287 mp->stats[__lcore_id].name##_bulk += 1; \ 290 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do { \ 291 unsigned int __lcore_id = rte_lcore_id(); \ 292 if (__lcore_id < RTE_MAX_LCORE) { \ 293 mp->stats[__lcore_id].name##_blks += n; \ 294 mp->stats[__lcore_id].name##_bulk += 1; \ 298 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0) 299 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do {} while (0) 310 #define MEMPOOL_HEADER_SIZE(mp, cs) \ 311 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \ 312 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE))) 337 static inline struct rte_mempool_objtlr *__mempool_get_trailer(
void *obj)
357 void rte_mempool_check_cookies(
const struct rte_mempool *mp,
358 void *
const *obj_table_const,
unsigned n,
int free);
360 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 361 #define __mempool_check_cookies(mp, obj_table_const, n, free) \ 362 rte_mempool_check_cookies(mp, obj_table_const, n, free) 364 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0) 386 void *
const *first_obj_table_const,
unsigned int n,
int free);
388 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 389 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \ 391 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \ 394 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \ 399 #define RTE_MEMPOOL_OPS_NAMESIZE 32 411 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp); 422 void *
const *obj_table,
unsigned int n);
428 void **obj_table,
unsigned int n);
437 void **first_obj_table,
unsigned int n);
468 uint32_t obj_num, uint32_t pg_shift,
469 size_t *min_chunk_size,
size_t *align);
511 uint32_t obj_num, uint32_t pg_shift,
size_t chunk_reserve,
512 size_t *min_chunk_size,
size_t *align);
522 uint32_t obj_num, uint32_t pg_shift,
523 size_t *min_chunk_size,
size_t *align);
569 unsigned int max_objs,
576 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001 615 unsigned int flags,
unsigned int max_objs,
626 unsigned int max_objs,
668 #define RTE_MEMPOOL_MAX_OPS_IDX 16 679 struct rte_mempool_ops_table { 701 rte_mempool_get_ops(
int ops_index)
734 rte_mempool_ops_dequeue_bulk(
struct rte_mempool *mp,
735 void **obj_table,
unsigned n)
739 ops = rte_mempool_get_ops(mp->
ops_index);
740 return ops->
dequeue(mp, obj_table, n);
757 rte_mempool_ops_dequeue_contig_blocks(
struct rte_mempool *mp,
758 void **first_obj_table,
unsigned int n)
762 ops = rte_mempool_get_ops(mp->
ops_index);
781 rte_mempool_ops_enqueue_bulk(
struct rte_mempool *mp,
void *
const *obj_table,
786 ops = rte_mempool_get_ops(mp->
ops_index);
787 return ops->
enqueue(mp, obj_table, n);
799 rte_mempool_ops_get_count(
const struct rte_mempool *mp);
820 ssize_t rte_mempool_ops_calc_mem_size(
const struct rte_mempool *mp,
821 uint32_t obj_num, uint32_t pg_shift,
822 size_t *min_chunk_size,
size_t *align);
847 int rte_mempool_ops_populate(
struct rte_mempool *mp,
unsigned int max_objs,
918 #define MEMPOOL_REGISTER_OPS(ops) \ 919 RTE_INIT(mp_hdlr_init_##ops) \ 921 rte_mempool_register_ops(&ops); \ 930 void *opaque,
void *obj,
unsigned obj_idx);
1264 if (lcore_id >= RTE_MAX_LCORE)
1284 if (cache == NULL || cache->
len == 0)
1286 rte_mempool_ops_enqueue_bulk(mp, cache->
objs, cache->
len);
1303 __mempool_generic_put(
struct rte_mempool *mp,
void *
const *obj_table,
1309 __MEMPOOL_STAT_ADD(mp, put, n);
1312 if (
unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1315 cache_objs = &cache->
objs[cache->
len];
1325 rte_memcpy(&cache_objs[0], obj_table,
sizeof(
void *) * n);
1330 rte_mempool_ops_enqueue_bulk(mp, &cache->
objs[cache->
size],
1340 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG 1341 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1342 rte_panic(
"cannot put objects in mempool\n");
1344 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1365 __mempool_check_cookies(mp, obj_table, n, 0);
1366 __mempool_generic_put(mp, obj_table, n, cache);
1425 __mempool_generic_get(
struct rte_mempool *mp,
void **obj_table,
1429 uint32_t index,
len;
1436 cache_objs = cache->
objs;
1439 if (cache->
len < n) {
1441 uint32_t req = n + (cache->
size - cache->
len);
1444 ret = rte_mempool_ops_dequeue_bulk(mp,
1445 &cache->
objs[cache->
len], req);
1460 for (index = 0, len = cache->
len - 1; index < n; ++index, len--, obj_table++)
1461 *obj_table = cache_objs[
len];
1465 __MEMPOOL_STAT_ADD(mp, get_success, n);
1472 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1475 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1477 __MEMPOOL_STAT_ADD(mp, get_success, n);
1507 ret = __mempool_generic_get(mp, obj_table, n, cache);
1509 __mempool_check_cookies(mp, obj_table, n, 1);
1596 void **first_obj_table,
unsigned int n)
1600 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1602 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_success, n);
1603 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1606 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_fail, n);
__rte_experimental int rte_mempool_op_populate_helper(struct rte_mempool *mp, unsigned int flags, 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)
#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)
int(* rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
static __rte_always_inline int __rte_experimental rte_mempool_get_contig_blocks(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
rte_mempool_alloc_t alloc
void( rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr, void *opaque)
void( rte_mempool_obj_cb_t)(struct rte_mempool *mp, void *opaque, void *obj, unsigned obj_idx)
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_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)
#define MEMPOOL_HEADER_SIZE(mp, cs)
rte_mempool_get_info_t get_info
rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks
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_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)
STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr)
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)
void( rte_mempool_mem_cb_t)(struct rte_mempool *mp, void *opaque, struct rte_mempool_memhdr *memhdr, unsigned mem_idx)
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)
__rte_experimental int rte_mempool_ops_get_info(const struct rte_mempool *mp, struct rte_mempool_info *info)
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
void( rte_mempool_ctor_t)(struct rte_mempool *, void *)
__rte_experimental int rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz)
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)
int rte_mempool_populate_anon(struct rte_mempool *mp)
struct rte_mempool_cache * local_cache
rte_mempool_dequeue_t dequeue
int(* rte_mempool_enqueue_t)(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp, void *const *first_obj_table_const, unsigned int n, int free)
#define __rte_cache_aligned
__rte_experimental ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp, uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve, size_t *min_chunk_size, size_t *align)
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_populate_obj_cb_t)(struct rte_mempool *mp, void *opaque, void *vaddr, rte_iova_t iova)
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)
char name[RTE_MEMZONE_NAMESIZE]
#define RTE_MEMPOOL_MAX_OPS_IDX
void(* rte_mempool_free_t)(struct rte_mempool *mp)
rte_mempool_enqueue_t enqueue
#define RTE_MEMZONE_NAMESIZE