1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright(c) 2016 6WIND S.A.
6 #ifndef _RTE_MEMPOOL_H_
7 #define _RTE_MEMPOOL_H_
13 * A memory pool is an allocator of fixed-size object. It is
14 * identified by its name, and uses a ring to store free objects. It
15 * provides some other optional services, like a per-core object
16 * cache, and an alignment helper to ensure that objects are padded
17 * to spread them equally on all RAM channels, ranks, and so on.
19 * Objects owned by a mempool should never be added in another
20 * mempool. When an object is freed using rte_mempool_put() or
21 * equivalent, the object data is not modified; the user can save some
22 * meta-data in the object data and retrieve them when allocating a
25 * Note: the mempool implementation is not preemptible. An lcore must not be
26 * interrupted by another task that uses the same mempool (because it uses a
27 * ring which is not preemptible). Also, usual mempool functions like
28 * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
29 * thread due to the internal per-lcore cache. Due to the lack of caching,
30 * rte_mempool_get() or rte_mempool_put() performance will suffer when called
31 * by non-EAL threads. Instead, non-EAL threads should call
32 * rte_mempool_generic_get() or rte_mempool_generic_put() with a user cache
33 * created with rte_mempool_cache_create().
41 #include <sys/queue.h>
43 #include <rte_config.h>
44 #include <rte_spinlock.h>
46 #include <rte_debug.h>
47 #include <rte_lcore.h>
48 #include <rte_memory.h>
49 #include <rte_branch_prediction.h>
51 #include <rte_memcpy.h>
52 #include <rte_common.h>
58 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
59 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
60 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
62 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
64 * A structure that stores the mempool statistics (per-lcore).
66 struct rte_mempool_debug_stats {
67 uint64_t put_bulk; /**< Number of puts. */
68 uint64_t put_objs; /**< Number of objects successfully put. */
69 uint64_t get_success_bulk; /**< Successful allocation number. */
70 uint64_t get_success_objs; /**< Objects successfully allocated. */
71 uint64_t get_fail_bulk; /**< Failed allocation number. */
72 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
73 } __rte_cache_aligned;
77 * A structure that stores a per-core object cache.
79 struct rte_mempool_cache {
80 uint32_t size; /**< Size of the cache */
81 uint32_t flushthresh; /**< Threshold before we flush excess elements */
82 uint32_t len; /**< Current cache count */
84 * Cache is allocated to this size to allow it to overflow in certain
85 * cases to avoid needless emptying of cache.
87 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
88 } __rte_cache_aligned;
91 * A structure that stores the size of mempool elements.
93 struct rte_mempool_objsz {
94 uint32_t elt_size; /**< Size of an element. */
95 uint32_t header_size; /**< Size of header (before elt). */
96 uint32_t trailer_size; /**< Size of trailer (after elt). */
98 /**< Total size of an object (header + elt + trailer). */
101 /**< Maximum length of a memory pool's name. */
102 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
103 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
104 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
107 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
109 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
111 /** Mempool over one chunk of physically continuous memory */
112 #define MEMPOOL_PG_NUM_DEFAULT 1
114 #ifndef RTE_MEMPOOL_ALIGN
115 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
118 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
121 * Mempool object header structure
123 * Each object stored in mempools are prefixed by this header structure,
124 * it allows to retrieve the mempool pointer from the object and to
125 * iterate on all objects attached to a mempool. When debug is enabled,
126 * a cookie is also added in this structure preventing corruptions and
129 struct rte_mempool_objhdr {
130 STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
131 struct rte_mempool *mp; /**< The mempool owning the object. */
134 rte_iova_t iova; /**< IO address of the object. */
135 phys_addr_t physaddr; /**< deprecated - Physical address of the object. */
137 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
138 uint64_t cookie; /**< Debug cookie. */
143 * A list of object headers type
145 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
147 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
150 * Mempool object trailer structure
152 * In debug mode, each object stored in mempools are suffixed by this
153 * trailer structure containing a cookie preventing memory corruptions.
155 struct rte_mempool_objtlr {
156 uint64_t cookie; /**< Debug cookie. */
162 * A list of memory where objects are stored
164 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
167 * Callback used to free a memory chunk
169 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
173 * Mempool objects memory header structure
175 * The memory chunks where objects are stored. Each chunk is virtually
176 * and physically contiguous.
178 struct rte_mempool_memhdr {
179 STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
180 struct rte_mempool *mp; /**< The mempool owning the chunk */
181 void *addr; /**< Virtual address of the chunk */
184 rte_iova_t iova; /**< IO address of the chunk */
185 phys_addr_t phys_addr; /**< Physical address of the chunk */
187 size_t len; /**< length of the chunk */
188 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
189 void *opaque; /**< Argument passed to the free callback */
193 * The RTE mempool structure.
197 * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
198 * compatibility requirements, it could be changed to
199 * RTE_MEMPOOL_NAMESIZE next time the ABI changes
201 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
204 void *pool_data; /**< Ring or pool to store objects. */
205 uint64_t pool_id; /**< External mempool identifier. */
207 void *pool_config; /**< optional args for ops alloc. */
208 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
209 unsigned int flags; /**< Flags of the mempool. */
210 int socket_id; /**< Socket id passed at create. */
211 uint32_t size; /**< Max size of the mempool. */
213 /**< Size of per-lcore default local cache. */
215 uint32_t elt_size; /**< Size of an element. */
216 uint32_t header_size; /**< Size of header (before elt). */
217 uint32_t trailer_size; /**< Size of trailer (after elt). */
219 unsigned private_data_size; /**< Size of private data. */
221 * Index into rte_mempool_ops_table array of mempool ops
222 * structs, which contain callback function pointers.
223 * We're using an index here rather than pointers to the callbacks
224 * to facilitate any secondary processes that may want to use
229 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
231 uint32_t populated_size; /**< Number of populated objects. */
232 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
233 uint32_t nb_mem_chunks; /**< Number of memory chunks */
234 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
236 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
237 /** Per-lcore statistics. */
238 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
240 } __rte_cache_aligned;
242 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread among memory channels. */
243 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
244 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
245 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
246 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
247 #define MEMPOOL_F_NO_PHYS_CONTIG 0x0020 /**< Don't need physically contiguous objs. */
249 * This capability flag is advertised by a mempool handler, if the whole
250 * memory area containing the objects must be physically contiguous.
251 * Note: This flag should not be passed by application.
253 #define MEMPOOL_F_CAPA_PHYS_CONTIG 0x0040
255 * This capability flag is advertised by a mempool handler. Used for a case
256 * where mempool driver wants object start address(vaddr) aligned to block
257 * size(/ total element size).
260 * - This flag should not be passed by application.
261 * Flag used for mempool driver only.
262 * - Mempool driver must also set MEMPOOL_F_CAPA_PHYS_CONTIG flag along with
263 * MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS.
265 #define MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS 0x0080
268 * @internal When debug is enabled, store some statistics.
271 * Pointer to the memory pool.
273 * Name of the statistics field to increment in the memory pool.
275 * Number to add to the object-oriented statistics.
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##_objs += n; \
282 mp->stats[__lcore_id].name##_bulk += 1; \
286 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
290 * Calculate the size of the mempool header.
293 * Pointer to the memory pool.
295 * Size of the per-lcore cache.
297 #define MEMPOOL_HEADER_SIZE(mp, cs) \
298 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
299 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
301 /* return the header of a mempool object (internal) */
302 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
304 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
305 sizeof(struct rte_mempool_objhdr));
309 * Return a pointer to the mempool owning this object.
312 * An object that is owned by a pool. If this is not the case,
313 * the behavior is undefined.
315 * A pointer to the mempool structure.
317 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
319 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
323 /* return the trailer of a mempool object (internal) */
324 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
326 struct rte_mempool *mp = rte_mempool_from_obj(obj);
327 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
331 * @internal Check and update cookies or panic.
334 * Pointer to the memory pool.
335 * @param obj_table_const
336 * Pointer to a table of void * pointers (objects).
338 * Index of object in object table.
340 * - 0: object is supposed to be allocated, mark it as free
341 * - 1: object is supposed to be free, mark it as allocated
342 * - 2: just check that cookie is valid (free or allocated)
344 void rte_mempool_check_cookies(const struct rte_mempool *mp,
345 void * const *obj_table_const, unsigned n, int free);
347 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
348 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
349 rte_mempool_check_cookies(mp, obj_table_const, n, free)
351 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
352 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
354 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
357 * Prototype for implementation specific data provisioning function.
359 * The function should provide the implementation specific memory for
360 * use by the other mempool ops functions in a given mempool ops struct.
361 * E.g. the default ops provides an instance of the rte_ring for this purpose.
362 * it will most likely point to a different type of data structure, and
363 * will be transparent to the application programmer.
364 * This function should set mp->pool_data.
366 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
369 * Free the opaque private data pointed to by mp->pool_data pointer.
371 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
374 * Enqueue an object into the external pool.
376 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
377 void * const *obj_table, unsigned int n);
380 * Dequeue an object from the external pool.
382 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
383 void **obj_table, unsigned int n);
386 * Return the number of available objects in the external pool.
388 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
391 * Get the mempool capabilities.
393 typedef int (*rte_mempool_get_capabilities_t)(const struct rte_mempool *mp,
394 unsigned int *flags);
397 * Notify new memory area to mempool.
399 typedef int (*rte_mempool_ops_register_memory_area_t)
400 (const struct rte_mempool *mp, char *vaddr, rte_iova_t iova, size_t len);
402 /** Structure defining mempool operations structure */
403 struct rte_mempool_ops {
404 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
405 rte_mempool_alloc_t alloc; /**< Allocate private data. */
406 rte_mempool_free_t free; /**< Free the external pool. */
407 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
408 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
409 rte_mempool_get_count get_count; /**< Get qty of available objs. */
411 * Get the mempool capabilities
413 rte_mempool_get_capabilities_t get_capabilities;
415 * Notify new memory area to mempool
417 rte_mempool_ops_register_memory_area_t register_memory_area;
418 } __rte_cache_aligned;
420 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
423 * Structure storing the table of registered ops structs, each of which contain
424 * the function pointers for the mempool ops functions.
425 * Each process has its own storage for this ops struct array so that
426 * the mempools can be shared across primary and secondary processes.
427 * The indices used to access the array are valid across processes, whereas
428 * any function pointers stored directly in the mempool struct would not be.
429 * This results in us simply having "ops_index" in the mempool struct.
431 struct rte_mempool_ops_table {
432 rte_spinlock_t sl; /**< Spinlock for add/delete. */
433 uint32_t num_ops; /**< Number of used ops structs in the table. */
435 * Storage for all possible ops structs.
437 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
438 } __rte_cache_aligned;
440 /** Array of registered ops structs. */
441 extern struct rte_mempool_ops_table rte_mempool_ops_table;
444 * @internal Get the mempool ops struct from its index.
447 * The index of the ops struct in the ops struct table. It must be a valid
448 * index: (0 <= idx < num_ops).
450 * The pointer to the ops struct in the table.
452 static inline struct rte_mempool_ops *
453 rte_mempool_get_ops(int ops_index)
455 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
457 return &rte_mempool_ops_table.ops[ops_index];
461 * @internal Wrapper for mempool_ops alloc callback.
464 * Pointer to the memory pool.
466 * - 0: Success; successfully allocated mempool pool_data.
467 * - <0: Error; code of alloc function.
470 rte_mempool_ops_alloc(struct rte_mempool *mp);
473 * @internal Wrapper for mempool_ops dequeue callback.
476 * Pointer to the memory pool.
478 * Pointer to a table of void * pointers (objects).
480 * Number of objects to get.
482 * - 0: Success; got n objects.
483 * - <0: Error; code of dequeue function.
486 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
487 void **obj_table, unsigned n)
489 struct rte_mempool_ops *ops;
491 ops = rte_mempool_get_ops(mp->ops_index);
492 return ops->dequeue(mp, obj_table, n);
496 * @internal wrapper for mempool_ops enqueue callback.
499 * Pointer to the memory pool.
501 * Pointer to a table of void * pointers (objects).
503 * Number of objects to put.
505 * - 0: Success; n objects supplied.
506 * - <0: Error; code of enqueue function.
509 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
512 struct rte_mempool_ops *ops;
514 ops = rte_mempool_get_ops(mp->ops_index);
515 return ops->enqueue(mp, obj_table, n);
519 * @internal wrapper for mempool_ops get_count callback.
522 * Pointer to the memory pool.
524 * The number of available objects in the external pool.
527 rte_mempool_ops_get_count(const struct rte_mempool *mp);
530 * @internal wrapper for mempool_ops get_capabilities callback.
533 * Pointer to the memory pool.
535 * Pointer to the mempool flags.
537 * - 0: Success; The mempool driver has advertised his pool capabilities in
539 * - -ENOTSUP - doesn't support get_capabilities ops (valid case).
540 * - Otherwise, pool create fails.
543 rte_mempool_ops_get_capabilities(const struct rte_mempool *mp,
544 unsigned int *flags);
546 * @internal wrapper for mempool_ops register_memory_area callback.
547 * API to notify the mempool handler when a new memory area is added to pool.
550 * Pointer to the memory pool.
552 * Pointer to the buffer virtual address.
554 * Pointer to the buffer IO address.
559 * - -ENOTSUP - doesn't support register_memory_area ops (valid error case).
560 * - Otherwise, rte_mempool_populate_phys fails thus pool create fails.
563 rte_mempool_ops_register_memory_area(const struct rte_mempool *mp,
564 char *vaddr, rte_iova_t iova, size_t len);
567 * @internal wrapper for mempool_ops free callback.
570 * Pointer to the memory pool.
573 rte_mempool_ops_free(struct rte_mempool *mp);
576 * Set the ops of a mempool.
578 * This can only be done on a mempool that is not populated, i.e. just after
579 * a call to rte_mempool_create_empty().
582 * Pointer to the memory pool.
584 * Name of the ops structure to use for this mempool.
586 * Opaque data that can be passed by the application to the ops functions.
588 * - 0: Success; the mempool is now using the requested ops functions.
589 * - -EINVAL - Invalid ops struct name provided.
590 * - -EEXIST - mempool already has an ops struct assigned.
593 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
597 * Register mempool operations.
600 * Pointer to an ops structure to register.
602 * - >=0: Success; return the index of the ops struct in the table.
603 * - -EINVAL - some missing callbacks while registering ops struct.
604 * - -ENOSPC - the maximum number of ops structs has been reached.
606 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
609 * Macro to statically register the ops of a mempool handler.
610 * Note that the rte_mempool_register_ops fails silently here when
611 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
613 #define MEMPOOL_REGISTER_OPS(ops) \
614 void mp_hdlr_init_##ops(void); \
615 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
617 rte_mempool_register_ops(&ops); \
621 * An object callback function for mempool.
623 * Used by rte_mempool_create() and rte_mempool_obj_iter().
625 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
626 void *opaque, void *obj, unsigned obj_idx);
627 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
630 * A memory callback function for mempool.
632 * Used by rte_mempool_mem_iter().
634 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
635 void *opaque, struct rte_mempool_memhdr *memhdr,
639 * A mempool constructor callback function.
641 * Arguments are the mempool and the opaque pointer given by the user in
642 * rte_mempool_create().
644 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
647 * Create a new mempool named *name* in memory.
649 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
650 * pool contains n elements of elt_size. Its size is set to n.
653 * The name of the mempool.
655 * The number of elements in the mempool. The optimum size (in terms of
656 * memory usage) for a mempool is when n is a power of two minus one:
659 * The size of each element.
661 * If cache_size is non-zero, the rte_mempool library will try to
662 * limit the accesses to the common lockless pool, by maintaining a
663 * per-lcore object cache. This argument must be lower or equal to
664 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
665 * cache_size to have "n modulo cache_size == 0": if this is
666 * not the case, some elements will always stay in the pool and will
667 * never be used. The access to the per-lcore table is of course
668 * faster than the multi-producer/consumer pool. The cache can be
669 * disabled if the cache_size argument is set to 0; it can be useful to
670 * avoid losing objects in cache.
671 * @param private_data_size
672 * The size of the private data appended after the mempool
673 * structure. This is useful for storing some private data after the
674 * mempool structure, as is done for rte_mbuf_pool for example.
676 * A function pointer that is called for initialization of the pool,
677 * before object initialization. The user can initialize the private
678 * data in this function if needed. This parameter can be NULL if
681 * An opaque pointer to data that can be used in the mempool
682 * constructor function.
684 * A function pointer that is called for each object at
685 * initialization of the pool. The user can set some meta data in
686 * objects if needed. This parameter can be NULL if not needed.
687 * The obj_init() function takes the mempool pointer, the init_arg,
688 * the object pointer and the object number as parameters.
689 * @param obj_init_arg
690 * An opaque pointer to data that can be used as an argument for
691 * each call to the object constructor function.
693 * The *socket_id* argument is the socket identifier in the case of
694 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
695 * constraint for the reserved zone.
697 * The *flags* arguments is an OR of following flags:
698 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
699 * between channels in RAM: the pool allocator will add padding
700 * between objects depending on the hardware configuration. See
701 * Memory alignment constraints for details. If this flag is set,
702 * the allocator will just align them to a cache line.
703 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
704 * cache-aligned. This flag removes this constraint, and no
705 * padding will be present between objects. This flag implies
706 * MEMPOOL_F_NO_SPREAD.
707 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
708 * when using rte_mempool_put() or rte_mempool_put_bulk() is
709 * "single-producer". Otherwise, it is "multi-producers".
710 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
711 * when using rte_mempool_get() or rte_mempool_get_bulk() is
712 * "single-consumer". Otherwise, it is "multi-consumers".
713 * - MEMPOOL_F_NO_PHYS_CONTIG: If set, allocated objects won't
714 * necessarily be contiguous in physical memory.
716 * The pointer to the new allocated mempool, on success. NULL on error
717 * with rte_errno set appropriately. Possible rte_errno values include:
718 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
719 * - E_RTE_SECONDARY - function was called from a secondary process instance
720 * - EINVAL - cache size provided is too large
721 * - ENOSPC - the maximum number of memzones has already been allocated
722 * - EEXIST - a memzone with the same name already exists
723 * - ENOMEM - no appropriate memory area found in which to create memzone
726 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
727 unsigned cache_size, unsigned private_data_size,
728 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
729 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
730 int socket_id, unsigned flags);
733 * Create a new mempool named *name* in memory.
735 * The pool contains n elements of elt_size. Its size is set to n.
736 * This function uses ``memzone_reserve()`` to allocate the mempool header
737 * (and the objects if vaddr is NULL).
738 * Depending on the input parameters, mempool elements can be either allocated
739 * together with the mempool header, or an externally provided memory buffer
740 * could be used to store mempool objects. In later case, that external
741 * memory buffer can consist of set of disjoint physical pages.
744 * The name of the mempool.
746 * The number of elements in the mempool. The optimum size (in terms of
747 * memory usage) for a mempool is when n is a power of two minus one:
750 * The size of each element.
752 * Size of the cache. See rte_mempool_create() for details.
753 * @param private_data_size
754 * The size of the private data appended after the mempool
755 * structure. This is useful for storing some private data after the
756 * mempool structure, as is done for rte_mbuf_pool for example.
758 * A function pointer that is called for initialization of the pool,
759 * before object initialization. The user can initialize the private
760 * data in this function if needed. This parameter can be NULL if
763 * An opaque pointer to data that can be used in the mempool
764 * constructor function.
766 * A function called for each object at initialization of the pool.
767 * See rte_mempool_create() for details.
768 * @param obj_init_arg
769 * An opaque pointer passed to the object constructor function.
771 * The *socket_id* argument is the socket identifier in the case of
772 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
773 * constraint for the reserved zone.
775 * Flags controlling the behavior of the mempool. See
776 * rte_mempool_create() for details.
778 * Virtual address of the externally allocated memory buffer.
779 * Will be used to store mempool objects.
781 * Array of IO addresses of the pages that comprises given memory buffer.
783 * Number of elements in the iova array.
785 * LOG2 of the physical pages size.
787 * The pointer to the new allocated mempool, on success. NULL on error
788 * with rte_errno set appropriately. See rte_mempool_create() for details.
791 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
792 unsigned cache_size, unsigned private_data_size,
793 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
794 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
795 int socket_id, unsigned flags, void *vaddr,
796 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift);
799 * Create an empty mempool
801 * The mempool is allocated and initialized, but it is not populated: no
802 * memory is allocated for the mempool elements. The user has to call
803 * rte_mempool_populate_*() to add memory chunks to the pool. Once
804 * populated, the user may also want to initialize each object with
805 * rte_mempool_obj_iter().
808 * The name of the mempool.
810 * The maximum number of elements that can be added in the mempool.
811 * The optimum size (in terms of memory usage) for a mempool is when n
812 * is a power of two minus one: n = (2^q - 1).
814 * The size of each element.
816 * Size of the cache. See rte_mempool_create() for details.
817 * @param private_data_size
818 * The size of the private data appended after the mempool
819 * structure. This is useful for storing some private data after the
820 * mempool structure, as is done for rte_mbuf_pool for example.
822 * The *socket_id* argument is the socket identifier in the case of
823 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
824 * constraint for the reserved zone.
826 * Flags controlling the behavior of the mempool. See
827 * rte_mempool_create() for details.
829 * The pointer to the new allocated mempool, on success. NULL on error
830 * with rte_errno set appropriately. See rte_mempool_create() for details.
833 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
834 unsigned cache_size, unsigned private_data_size,
835 int socket_id, unsigned flags);
839 * Unlink the mempool from global list, free the memory chunks, and all
840 * memory referenced by the mempool. The objects must not be used by
841 * other cores as they will be freed.
844 * A pointer to the mempool structure.
847 rte_mempool_free(struct rte_mempool *mp);
850 * Add physically contiguous memory for objects in the pool at init
852 * Add a virtually and physically contiguous memory chunk in the pool
853 * where objects can be instantiated.
855 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
856 * the chunk doesn't need to be physically contiguous (only virtually),
857 * and allocated objects may span two pages.
860 * A pointer to the mempool structure.
862 * The virtual address of memory that should be used to store objects.
866 * The length of memory in bytes.
868 * The callback used to free this chunk when destroying the mempool.
870 * An opaque argument passed to free_cb.
872 * The number of objects added on success.
873 * On error, the chunk is not added in the memory list of the
874 * mempool and a negative errno is returned.
876 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
877 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
881 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
882 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
886 * Add physical memory for objects in the pool at init
888 * Add a virtually contiguous memory chunk in the pool where objects can
889 * be instantiated. The IO addresses corresponding to the virtual
890 * area are described in iova[], pg_num, pg_shift.
893 * A pointer to the mempool structure.
895 * The virtual address of memory that should be used to store objects.
897 * An array of IO addresses of each page composing the virtual area.
899 * Number of elements in the iova array.
901 * LOG2 of the physical pages size.
903 * The callback used to free this chunk when destroying the mempool.
905 * An opaque argument passed to free_cb.
907 * The number of objects added on success.
908 * On error, the chunks are not added in the memory list of the
909 * mempool and a negative errno is returned.
911 int rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
912 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
913 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
916 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
917 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
918 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
921 * Add virtually contiguous memory for objects in the pool at init
923 * Add a virtually contiguous memory chunk in the pool where objects can
927 * A pointer to the mempool structure.
929 * The virtual address of memory that should be used to store objects.
930 * Must be page-aligned.
932 * The length of memory in bytes. Must be page-aligned.
934 * The size of memory pages in this virtual area.
936 * The callback used to free this chunk when destroying the mempool.
938 * An opaque argument passed to free_cb.
940 * The number of objects added on success.
941 * On error, the chunk is not added in the memory list of the
942 * mempool and a negative errno is returned.
945 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
946 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
950 * Add memory for objects in the pool at init
952 * This is the default function used by rte_mempool_create() to populate
953 * the mempool. It adds memory allocated using rte_memzone_reserve().
956 * A pointer to the mempool structure.
958 * The number of objects added on success.
959 * On error, the chunk is not added in the memory list of the
960 * mempool and a negative errno is returned.
962 int rte_mempool_populate_default(struct rte_mempool *mp);
965 * Add memory from anonymous mapping for objects in the pool at init
967 * This function mmap an anonymous memory zone that is locked in
968 * memory to store the objects of the mempool.
971 * A pointer to the mempool structure.
973 * The number of objects added on success.
974 * On error, the chunk is not added in the memory list of the
975 * mempool and a negative errno is returned.
977 int rte_mempool_populate_anon(struct rte_mempool *mp);
980 * Call a function for each mempool element
982 * Iterate across all objects attached to a rte_mempool and call the
983 * callback function on it.
986 * A pointer to an initialized mempool.
988 * A function pointer that is called for each object.
990 * An opaque pointer passed to the callback function.
992 * Number of objects iterated.
994 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
995 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
998 * Call a function for each mempool memory chunk
1000 * Iterate across all memory chunks attached to a rte_mempool and call
1001 * the callback function on it.
1004 * A pointer to an initialized mempool.
1006 * A function pointer that is called for each memory chunk.
1008 * An opaque pointer passed to the callback function.
1010 * Number of memory chunks iterated.
1012 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1013 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1016 * Dump the status of the mempool to a file.
1019 * A pointer to a file for output
1021 * A pointer to the mempool structure.
1023 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1026 * Create a user-owned mempool cache.
1028 * This can be used by non-EAL threads to enable caching when they
1029 * interact with a mempool.
1032 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1033 * parameter description for more information. The same limits and
1034 * considerations apply here too.
1036 * The socket identifier in the case of NUMA. The value can be
1037 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1039 struct rte_mempool_cache *
1040 rte_mempool_cache_create(uint32_t size, int socket_id);
1043 * Free a user-owned mempool cache.
1046 * A pointer to the mempool cache.
1049 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1052 * Flush a user-owned mempool cache to the specified mempool.
1055 * A pointer to the mempool cache.
1057 * A pointer to the mempool.
1059 static __rte_always_inline void
1060 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1061 struct rte_mempool *mp)
1063 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1068 * Get a pointer to the per-lcore default mempool cache.
1071 * A pointer to the mempool structure.
1073 * The logical core id.
1075 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1077 static __rte_always_inline struct rte_mempool_cache *
1078 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1080 if (mp->cache_size == 0)
1083 if (lcore_id >= RTE_MAX_LCORE)
1086 return &mp->local_cache[lcore_id];
1090 * @internal Put several objects back in the mempool; used internally.
1092 * A pointer to the mempool structure.
1094 * A pointer to a table of void * pointers (objects).
1096 * The number of objects to store back in the mempool, must be strictly
1099 * A pointer to a mempool cache structure. May be NULL if not needed.
1101 static __rte_always_inline void
1102 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1103 unsigned int n, struct rte_mempool_cache *cache)
1107 /* increment stat now, adding in mempool always success */
1108 __MEMPOOL_STAT_ADD(mp, put, n);
1110 /* No cache provided or if put would overflow mem allocated for cache */
1111 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1114 cache_objs = &cache->objs[cache->len];
1117 * The cache follows the following algorithm
1118 * 1. Add the objects to the cache
1119 * 2. Anything greater than the cache min value (if it crosses the
1120 * cache flush threshold) is flushed to the ring.
1123 /* Add elements back into the cache */
1124 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1128 if (cache->len >= cache->flushthresh) {
1129 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1130 cache->len - cache->size);
1131 cache->len = cache->size;
1138 /* push remaining objects in ring */
1139 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1140 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1141 rte_panic("cannot put objects in mempool\n");
1143 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1149 * Put several objects back in the mempool.
1152 * A pointer to the mempool structure.
1154 * A pointer to a table of void * pointers (objects).
1156 * The number of objects to add in the mempool from the obj_table.
1158 * A pointer to a mempool cache structure. May be NULL if not needed.
1160 static __rte_always_inline void
1161 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1162 unsigned int n, struct rte_mempool_cache *cache)
1164 __mempool_check_cookies(mp, obj_table, n, 0);
1165 __mempool_generic_put(mp, obj_table, n, cache);
1169 * Put several objects back in the mempool.
1171 * This function calls the multi-producer or the single-producer
1172 * version depending on the default behavior that was specified at
1173 * mempool creation time (see flags).
1176 * A pointer to the mempool structure.
1178 * A pointer to a table of void * pointers (objects).
1180 * The number of objects to add in the mempool from obj_table.
1182 static __rte_always_inline void
1183 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1186 struct rte_mempool_cache *cache;
1187 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1188 rte_mempool_generic_put(mp, obj_table, n, cache);
1192 * Put one object back in the mempool.
1194 * This function calls the multi-producer or the single-producer
1195 * version depending on the default behavior that was specified at
1196 * mempool creation time (see flags).
1199 * A pointer to the mempool structure.
1201 * A pointer to the object to be added.
1203 static __rte_always_inline void
1204 rte_mempool_put(struct rte_mempool *mp, void *obj)
1206 rte_mempool_put_bulk(mp, &obj, 1);
1210 * @internal Get several objects from the mempool; used internally.
1212 * A pointer to the mempool structure.
1214 * A pointer to a table of void * pointers (objects).
1216 * The number of objects to get, must be strictly positive.
1218 * A pointer to a mempool cache structure. May be NULL if not needed.
1220 * - >=0: Success; number of objects supplied.
1221 * - <0: Error; code of ring dequeue function.
1223 static __rte_always_inline int
1224 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1225 unsigned int n, struct rte_mempool_cache *cache)
1228 uint32_t index, len;
1231 /* No cache provided or cannot be satisfied from cache */
1232 if (unlikely(cache == NULL || n >= cache->size))
1235 cache_objs = cache->objs;
1237 /* Can this be satisfied from the cache? */
1238 if (cache->len < n) {
1239 /* No. Backfill the cache first, and then fill from it */
1240 uint32_t req = n + (cache->size - cache->len);
1242 /* How many do we require i.e. number to fill the cache + the request */
1243 ret = rte_mempool_ops_dequeue_bulk(mp,
1244 &cache->objs[cache->len], req);
1245 if (unlikely(ret < 0)) {
1247 * In the offchance that we are buffer constrained,
1248 * where we are not able to allocate cache + n, go to
1249 * the ring directly. If that fails, we are truly out of
1258 /* Now fill in the response ... */
1259 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1260 *obj_table = cache_objs[len];
1264 __MEMPOOL_STAT_ADD(mp, get_success, n);
1270 /* get remaining objects from ring */
1271 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1274 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1276 __MEMPOOL_STAT_ADD(mp, get_success, n);
1282 * Get several objects from the mempool.
1284 * If cache is enabled, objects will be retrieved first from cache,
1285 * subsequently from the common pool. Note that it can return -ENOENT when
1286 * the local cache and common pool are empty, even if cache from other
1290 * A pointer to the mempool structure.
1292 * A pointer to a table of void * pointers (objects) that will be filled.
1294 * The number of objects to get from mempool to obj_table.
1296 * A pointer to a mempool cache structure. May be NULL if not needed.
1298 * - 0: Success; objects taken.
1299 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1301 static __rte_always_inline int
1302 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1303 unsigned int n, struct rte_mempool_cache *cache)
1306 ret = __mempool_generic_get(mp, obj_table, n, cache);
1308 __mempool_check_cookies(mp, obj_table, n, 1);
1313 * Get several objects from the mempool.
1315 * This function calls the multi-consumers or the single-consumer
1316 * version, depending on the default behaviour that was specified at
1317 * mempool creation time (see flags).
1319 * If cache is enabled, objects will be retrieved first from cache,
1320 * subsequently from the common pool. Note that it can return -ENOENT when
1321 * the local cache and common pool are empty, even if cache from other
1325 * A pointer to the mempool structure.
1327 * A pointer to a table of void * pointers (objects) that will be filled.
1329 * The number of objects to get from the mempool to obj_table.
1331 * - 0: Success; objects taken
1332 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1334 static __rte_always_inline int
1335 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1337 struct rte_mempool_cache *cache;
1338 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1339 return rte_mempool_generic_get(mp, obj_table, n, cache);
1343 * Get one object from the mempool.
1345 * This function calls the multi-consumers or the single-consumer
1346 * version, depending on the default behavior that was specified at
1347 * mempool creation (see flags).
1349 * If cache is enabled, objects will be retrieved first from cache,
1350 * subsequently from the common pool. Note that it can return -ENOENT when
1351 * the local cache and common pool are empty, even if cache from other
1355 * A pointer to the mempool structure.
1357 * A pointer to a void * pointer (object) that will be filled.
1359 * - 0: Success; objects taken.
1360 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1362 static __rte_always_inline int
1363 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1365 return rte_mempool_get_bulk(mp, obj_p, 1);
1369 * Return the number of entries in the mempool.
1371 * When cache is enabled, this function has to browse the length of
1372 * all lcores, so it should not be used in a data path, but only for
1373 * debug purposes. User-owned mempool caches are not accounted for.
1376 * A pointer to the mempool structure.
1378 * The number of entries in the mempool.
1380 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1383 * Return the number of elements which have been allocated from the mempool
1385 * When cache is enabled, this function has to browse the length of
1386 * all lcores, so it should not be used in a data path, but only for
1390 * A pointer to the mempool structure.
1392 * The number of free entries in the mempool.
1395 rte_mempool_in_use_count(const struct rte_mempool *mp);
1398 * Test if the mempool is full.
1400 * When cache is enabled, this function has to browse the length of all
1401 * lcores, so it should not be used in a data path, but only for debug
1402 * purposes. User-owned mempool caches are not accounted for.
1405 * A pointer to the mempool structure.
1407 * - 1: The mempool is full.
1408 * - 0: The mempool is not full.
1411 rte_mempool_full(const struct rte_mempool *mp)
1413 return !!(rte_mempool_avail_count(mp) == mp->size);
1417 * Test if the mempool is empty.
1419 * When cache is enabled, this function has to browse the length of all
1420 * lcores, so it should not be used in a data path, but only for debug
1421 * purposes. User-owned mempool caches are not accounted for.
1424 * A pointer to the mempool structure.
1426 * - 1: The mempool is empty.
1427 * - 0: The mempool is not empty.
1430 rte_mempool_empty(const struct rte_mempool *mp)
1432 return !!(rte_mempool_avail_count(mp) == 0);
1436 * Return the IO address of elt, which is an element of the pool mp.
1439 * A pointer (virtual address) to the element of the pool.
1441 * The IO address of the elt element.
1442 * If the mempool was created with MEMPOOL_F_NO_PHYS_CONTIG, the
1443 * returned value is RTE_BAD_IOVA.
1445 static inline rte_iova_t
1446 rte_mempool_virt2iova(const void *elt)
1448 const struct rte_mempool_objhdr *hdr;
1449 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1455 static inline phys_addr_t
1456 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1458 return rte_mempool_virt2iova(elt);
1462 * Check the consistency of mempool objects.
1464 * Verify the coherency of fields in the mempool structure. Also check
1465 * that the cookies of mempool objects (even the ones that are not
1466 * present in pool) have a correct value. If not, a panic will occur.
1469 * A pointer to the mempool structure.
1471 void rte_mempool_audit(struct rte_mempool *mp);
1474 * Return a pointer to the private data in an mempool structure.
1477 * A pointer to the mempool structure.
1479 * A pointer to the private data.
1481 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1484 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1488 * Dump the status of all mempools on the console
1491 * A pointer to a file for output
1493 void rte_mempool_list_dump(FILE *f);
1496 * Search a mempool from its name
1499 * The name of the mempool.
1501 * The pointer to the mempool matching the name, or NULL if not found.
1503 * with rte_errno set appropriately. Possible rte_errno values include:
1504 * - ENOENT - required entry not available to return.
1507 struct rte_mempool *rte_mempool_lookup(const char *name);
1510 * Get the header, trailer and total size of a mempool element.
1512 * Given a desired size of the mempool element and mempool flags,
1513 * calculates header, trailer, body and total sizes of the mempool object.
1516 * The size of each element, without header and trailer.
1518 * The flags used for the mempool creation.
1519 * Consult rte_mempool_create() for more information about possible values.
1520 * The size of each element.
1522 * The calculated detailed size the mempool object. May be NULL.
1524 * Total size of the mempool object.
1526 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1527 struct rte_mempool_objsz *sz);
1530 * Get the size of memory required to store mempool elements.
1532 * Calculate the maximum amount of memory required to store given number
1533 * of objects. Assume that the memory buffer will be aligned at page
1536 * Note that if object size is bigger then page size, then it assumes
1537 * that pages are grouped in subsets of physically continuous pages big
1538 * enough to store at least one object.
1541 * Number of elements.
1542 * @param total_elt_sz
1543 * The size of each element, including header and trailer, as returned
1544 * by rte_mempool_calc_obj_size().
1546 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1548 * The mempool flags.
1550 * Required memory size aligned at page boundary.
1552 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1553 uint32_t pg_shift, unsigned int flags);
1556 * Get the size of memory required to store mempool elements.
1558 * Calculate how much memory would be actually required with the given
1559 * memory footprint to store required number of objects.
1562 * Virtual address of the externally allocated memory buffer.
1563 * Will be used to store mempool objects.
1565 * Number of elements.
1566 * @param total_elt_sz
1567 * The size of each element, including header and trailer, as returned
1568 * by rte_mempool_calc_obj_size().
1570 * Array of IO addresses of the pages that comprises given memory buffer.
1572 * Number of elements in the iova array.
1574 * LOG2 of the physical pages size.
1576 * The mempool flags.
1578 * On success, the number of bytes needed to store given number of
1579 * objects, aligned to the given page size. If the provided memory
1580 * buffer is too small, return a negative value whose absolute value
1581 * is the actual number of elements that can be stored in that buffer.
1583 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1584 size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
1585 uint32_t pg_shift, unsigned int flags);
1588 * Walk list of all memory pools
1593 * Argument passed to iterator
1595 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1602 #endif /* _RTE_MEMPOOL_H_ */