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 unregistered non-EAL threads. Instead, unregistered non-EAL threads
32 * should call rte_mempool_generic_get() or rte_mempool_generic_put() with a
33 * user cache created with rte_mempool_cache_create().
42 #include <rte_config.h>
43 #include <rte_spinlock.h>
45 #include <rte_debug.h>
46 #include <rte_lcore.h>
47 #include <rte_memory.h>
48 #include <rte_branch_prediction.h>
50 #include <rte_memcpy.h>
51 #include <rte_common.h>
53 #include "rte_mempool_trace_fp.h"
59 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
60 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
61 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
63 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
65 * A structure that stores the mempool statistics (per-lcore).
66 * Note: Cache stats (put_cache_bulk/objs, get_cache_bulk/objs) are not
67 * captured since they can be calculated from other stats.
68 * For example: put_cache_objs = put_objs - put_common_pool_objs.
70 struct rte_mempool_debug_stats {
71 uint64_t put_bulk; /**< Number of puts. */
72 uint64_t put_objs; /**< Number of objects successfully put. */
73 uint64_t put_common_pool_bulk; /**< Number of bulks enqueued in common pool. */
74 uint64_t put_common_pool_objs; /**< Number of objects enqueued in common pool. */
75 uint64_t get_common_pool_bulk; /**< Number of bulks dequeued from common pool. */
76 uint64_t get_common_pool_objs; /**< Number of objects dequeued from common pool. */
77 uint64_t get_success_bulk; /**< Successful allocation number. */
78 uint64_t get_success_objs; /**< Objects successfully allocated. */
79 uint64_t get_fail_bulk; /**< Failed allocation number. */
80 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
81 uint64_t get_success_blks; /**< Successful allocation number of contiguous blocks. */
82 uint64_t get_fail_blks; /**< Failed allocation number of contiguous blocks. */
83 } __rte_cache_aligned;
87 * A structure that stores a per-core object cache.
89 struct rte_mempool_cache {
90 uint32_t size; /**< Size of the cache */
91 uint32_t flushthresh; /**< Threshold before we flush excess elements */
92 uint32_t len; /**< Current cache count */
94 * Cache is allocated to this size to allow it to overflow in certain
95 * cases to avoid needless emptying of cache.
97 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
98 } __rte_cache_aligned;
101 * A structure that stores the size of mempool elements.
103 struct rte_mempool_objsz {
104 uint32_t elt_size; /**< Size of an element. */
105 uint32_t header_size; /**< Size of header (before elt). */
106 uint32_t trailer_size; /**< Size of trailer (after elt). */
108 /**< Total size of an object (header + elt + trailer). */
111 /**< Maximum length of a memory pool's name. */
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 (sizeof(uintptr_t) * CHAR_BIT - 1)
121 /** Mempool over one chunk of physically continuous memory */
122 #define MEMPOOL_PG_NUM_DEFAULT 1
124 #ifndef RTE_MEMPOOL_ALIGN
126 * Alignment of elements inside mempool.
128 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
131 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
134 * Mempool object header structure
136 * Each object stored in mempools are prefixed by this header structure,
137 * it allows to retrieve the mempool pointer from the object and to
138 * iterate on all objects attached to a mempool. When debug is enabled,
139 * a cookie is also added in this structure preventing corruptions and
142 struct rte_mempool_objhdr {
143 RTE_STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
144 struct rte_mempool *mp; /**< The mempool owning the object. */
145 rte_iova_t iova; /**< IO address of the object. */
146 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
147 uint64_t cookie; /**< Debug cookie. */
152 * A list of object headers type
154 RTE_STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
156 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
159 * Mempool object trailer structure
161 * In debug mode, each object stored in mempools are suffixed by this
162 * trailer structure containing a cookie preventing memory corruptions.
164 struct rte_mempool_objtlr {
165 uint64_t cookie; /**< Debug cookie. */
171 * A list of memory where objects are stored
173 RTE_STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
176 * Callback used to free a memory chunk
178 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
182 * Mempool objects memory header structure
184 * The memory chunks where objects are stored. Each chunk is virtually
185 * and physically contiguous.
187 struct rte_mempool_memhdr {
188 RTE_STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
189 struct rte_mempool *mp; /**< The mempool owning the chunk */
190 void *addr; /**< Virtual address of the chunk */
191 rte_iova_t iova; /**< IO address of the chunk */
192 size_t len; /**< length of the chunk */
193 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
194 void *opaque; /**< Argument passed to the free callback */
198 * Additional information about the mempool
200 * The structure is cache-line aligned to avoid ABI breakages in
201 * a number of cases when something small is added.
203 struct rte_mempool_info {
204 /** Number of objects in the contiguous block */
205 unsigned int contig_block_size;
206 } __rte_cache_aligned;
209 * The RTE mempool structure.
212 char name[RTE_MEMPOOL_NAMESIZE]; /**< Name of mempool. */
215 void *pool_data; /**< Ring or pool to store objects. */
216 uint64_t pool_id; /**< External mempool identifier. */
218 void *pool_config; /**< optional args for ops alloc. */
219 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
220 unsigned int flags; /**< Flags of the mempool. */
221 int socket_id; /**< Socket id passed at create. */
222 uint32_t size; /**< Max size of the mempool. */
224 /**< Size of per-lcore default local cache. */
226 uint32_t elt_size; /**< Size of an element. */
227 uint32_t header_size; /**< Size of header (before elt). */
228 uint32_t trailer_size; /**< Size of trailer (after elt). */
230 unsigned private_data_size; /**< Size of private data. */
232 * Index into rte_mempool_ops_table array of mempool ops
233 * structs, which contain callback function pointers.
234 * We're using an index here rather than pointers to the callbacks
235 * to facilitate any secondary processes that may want to use
240 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
242 uint32_t populated_size; /**< Number of populated objects. */
243 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
244 uint32_t nb_mem_chunks; /**< Number of memory chunks */
245 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
247 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
248 /** Per-lcore statistics. */
249 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
251 } __rte_cache_aligned;
253 #define MEMPOOL_F_NO_SPREAD 0x0001
254 /**< Spreading among memory channels not required. */
255 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
256 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
257 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
258 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
259 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
260 /** Internal: no object from the pool can be used for device IO (DMA). */
261 #define MEMPOOL_F_NON_IO 0x0040
264 * @internal When debug is enabled, store some statistics.
267 * Pointer to the memory pool.
269 * Name of the statistics field to increment in the memory pool.
271 * Number to add to the object-oriented statistics.
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 += n; \
281 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
285 * Calculate the size of the mempool header.
288 * Pointer to the memory pool.
290 * Size of the per-lcore cache.
292 #define MEMPOOL_HEADER_SIZE(mp, cs) \
293 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
294 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
296 /* return the header of a mempool object (internal) */
297 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
299 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
300 sizeof(struct rte_mempool_objhdr));
304 * Return a pointer to the mempool owning this object.
307 * An object that is owned by a pool. If this is not the case,
308 * the behavior is undefined.
310 * A pointer to the mempool structure.
312 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
314 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
318 /* return the trailer of a mempool object (internal) */
319 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
321 struct rte_mempool *mp = rte_mempool_from_obj(obj);
322 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
326 * @internal Check and update cookies or panic.
329 * Pointer to the memory pool.
330 * @param obj_table_const
331 * Pointer to a table of void * pointers (objects).
333 * Index of object in object table.
335 * - 0: object is supposed to be allocated, mark it as free
336 * - 1: object is supposed to be free, mark it as allocated
337 * - 2: just check that cookie is valid (free or allocated)
339 void rte_mempool_check_cookies(const struct rte_mempool *mp,
340 void * const *obj_table_const, unsigned n, int free);
342 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
343 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
344 rte_mempool_check_cookies(mp, obj_table_const, n, free)
346 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
347 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
350 * @internal Check contiguous object blocks and update cookies or panic.
353 * Pointer to the memory pool.
354 * @param first_obj_table_const
355 * Pointer to a table of void * pointers (first object of the contiguous
358 * Number of contiguous object blocks.
360 * - 0: object is supposed to be allocated, mark it as free
361 * - 1: object is supposed to be free, mark it as allocated
362 * - 2: just check that cookie is valid (free or allocated)
364 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
365 void * const *first_obj_table_const, unsigned int n, int free);
367 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
368 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
370 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
373 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
376 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
378 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
381 * Prototype for implementation specific data provisioning function.
383 * The function should provide the implementation specific memory for
384 * use by the other mempool ops functions in a given mempool ops struct.
385 * E.g. the default ops provides an instance of the rte_ring for this purpose.
386 * it will most likely point to a different type of data structure, and
387 * will be transparent to the application programmer.
388 * This function should set mp->pool_data.
390 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
393 * Free the opaque private data pointed to by mp->pool_data pointer.
395 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
398 * Enqueue an object into the external pool.
400 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
401 void * const *obj_table, unsigned int n);
404 * Dequeue an object from the external pool.
406 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
407 void **obj_table, unsigned int n);
410 * Dequeue a number of contiguous object blocks from the external pool.
412 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
413 void **first_obj_table, unsigned int n);
416 * Return the number of available objects in the external pool.
418 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
421 * Calculate memory size required to store given number of objects.
423 * If mempool objects are not required to be IOVA-contiguous
424 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
425 * virtually contiguous chunk size. Otherwise, if mempool objects must
426 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
427 * min_chunk_size defines IOVA-contiguous chunk size.
430 * Pointer to the memory pool.
433 * @param[in] pg_shift
434 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
435 * @param[out] min_chunk_size
436 * Location for minimum size of the memory chunk which may be used to
437 * store memory pool objects.
439 * Location for required memory chunk alignment.
441 * Required memory size.
443 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
444 uint32_t obj_num, uint32_t pg_shift,
445 size_t *min_chunk_size, size_t *align);
448 * @internal Helper to calculate memory size required to store given
451 * This function is internal to mempool library and mempool drivers.
453 * If page boundaries may be ignored, it is just a product of total
454 * object size including header and trailer and number of objects.
455 * Otherwise, it is a number of pages required to store given number of
456 * objects without crossing page boundary.
458 * Note that if object size is bigger than page size, then it assumes
459 * that pages are grouped in subsets of physically continuous pages big
460 * enough to store at least one object.
462 * Minimum size of memory chunk is the total element size.
463 * Required memory chunk alignment is the cache line size.
466 * A pointer to the mempool structure.
468 * Number of objects to be added in mempool.
469 * @param[in] pg_shift
470 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
471 * @param[in] chunk_reserve
472 * Amount of memory that must be reserved at the beginning of each page,
473 * or at the beginning of the memory area if pg_shift is 0.
474 * @param[out] min_chunk_size
475 * Location for minimum size of the memory chunk which may be used to
476 * store memory pool objects.
478 * Location for required memory chunk alignment.
480 * Required memory size.
482 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
483 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
484 size_t *min_chunk_size, size_t *align);
487 * Default way to calculate memory size required to store given number of
490 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
491 * 0, min_chunk_size, align).
493 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
494 uint32_t obj_num, uint32_t pg_shift,
495 size_t *min_chunk_size, size_t *align);
498 * Function to be called for each populated object.
501 * A pointer to the mempool structure.
503 * An opaque pointer passed to iterator.
505 * Object virtual address.
507 * Input/output virtual address of the object or RTE_BAD_IOVA.
509 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
510 void *opaque, void *vaddr, rte_iova_t iova);
513 * Populate memory pool objects using provided memory chunk.
515 * Populated objects should be enqueued to the pool, e.g. using
516 * rte_mempool_ops_enqueue_bulk().
518 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
519 * the chunk doesn't need to be physically contiguous (only virtually),
520 * and allocated objects may span two pages.
523 * A pointer to the mempool structure.
524 * @param[in] max_objs
525 * Maximum number of objects to be populated.
527 * The virtual address of memory that should be used to store objects.
531 * The length of memory in bytes.
533 * Callback function to be executed for each populated object.
534 * @param[in] obj_cb_arg
535 * An opaque pointer passed to the callback function.
537 * The number of objects added on success.
538 * On error, no objects are populated and a negative errno is returned.
540 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
541 unsigned int max_objs,
542 void *vaddr, rte_iova_t iova, size_t len,
543 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
546 * Align objects on addresses multiple of total_elt_sz.
548 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
551 * @internal Helper to populate memory pool object using provided memory
552 * chunk: just slice objects one by one, taking care of not
553 * crossing page boundaries.
555 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
556 * of object headers will be aligned on a multiple of total_elt_sz.
557 * This feature is used by octeontx hardware.
559 * This function is internal to mempool library and mempool drivers.
562 * A pointer to the mempool structure.
564 * Logical OR of following flags:
565 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
566 * multiple of total_elt_sz.
567 * @param[in] max_objs
568 * Maximum number of objects to be added in mempool.
570 * The virtual address of memory that should be used to store objects.
572 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
574 * The length of memory in bytes.
576 * Callback function to be executed for each populated object.
577 * @param[in] obj_cb_arg
578 * An opaque pointer passed to the callback function.
580 * The number of objects added in mempool.
582 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
583 unsigned int flags, unsigned int max_objs,
584 void *vaddr, rte_iova_t iova, size_t len,
585 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
588 * Default way to populate memory pool object using provided memory chunk.
590 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
591 * len, obj_cb, obj_cb_arg).
593 int rte_mempool_op_populate_default(struct rte_mempool *mp,
594 unsigned int max_objs,
595 void *vaddr, rte_iova_t iova, size_t len,
596 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
599 * Get some additional information about a mempool.
601 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
602 struct rte_mempool_info *info);
605 /** Structure defining mempool operations structure */
606 struct rte_mempool_ops {
607 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
608 rte_mempool_alloc_t alloc; /**< Allocate private data. */
609 rte_mempool_free_t free; /**< Free the external pool. */
610 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
611 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
612 rte_mempool_get_count get_count; /**< Get qty of available objs. */
614 * Optional callback to calculate memory size required to
615 * store specified number of objects.
617 rte_mempool_calc_mem_size_t calc_mem_size;
619 * Optional callback to populate mempool objects using
620 * provided memory chunk.
622 rte_mempool_populate_t populate;
626 rte_mempool_get_info_t get_info;
628 * Dequeue a number of contiguous object blocks.
630 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
631 } __rte_cache_aligned;
633 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
636 * Structure storing the table of registered ops structs, each of which contain
637 * the function pointers for the mempool ops functions.
638 * Each process has its own storage for this ops struct array so that
639 * the mempools can be shared across primary and secondary processes.
640 * The indices used to access the array are valid across processes, whereas
641 * any function pointers stored directly in the mempool struct would not be.
642 * This results in us simply having "ops_index" in the mempool struct.
644 struct rte_mempool_ops_table {
645 rte_spinlock_t sl; /**< Spinlock for add/delete. */
646 uint32_t num_ops; /**< Number of used ops structs in the table. */
648 * Storage for all possible ops structs.
650 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
651 } __rte_cache_aligned;
653 /** Array of registered ops structs. */
654 extern struct rte_mempool_ops_table rte_mempool_ops_table;
657 * @internal Get the mempool ops struct from its index.
660 * The index of the ops struct in the ops struct table. It must be a valid
661 * index: (0 <= idx < num_ops).
663 * The pointer to the ops struct in the table.
665 static inline struct rte_mempool_ops *
666 rte_mempool_get_ops(int ops_index)
668 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
670 return &rte_mempool_ops_table.ops[ops_index];
674 * @internal Wrapper for mempool_ops alloc callback.
677 * Pointer to the memory pool.
679 * - 0: Success; successfully allocated mempool pool_data.
680 * - <0: Error; code of alloc function.
683 rte_mempool_ops_alloc(struct rte_mempool *mp);
686 * @internal Wrapper for mempool_ops dequeue callback.
689 * Pointer to the memory pool.
691 * Pointer to a table of void * pointers (objects).
693 * Number of objects to get.
695 * - 0: Success; got n objects.
696 * - <0: Error; code of dequeue function.
699 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
700 void **obj_table, unsigned n)
702 struct rte_mempool_ops *ops;
705 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
706 ops = rte_mempool_get_ops(mp->ops_index);
707 ret = ops->dequeue(mp, obj_table, n);
709 __MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
710 __MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
716 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
719 * Pointer to the memory pool.
720 * @param[out] first_obj_table
721 * Pointer to a table of void * pointers (first objects).
723 * Number of blocks to get.
725 * - 0: Success; got n objects.
726 * - <0: Error; code of dequeue function.
729 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
730 void **first_obj_table, unsigned int n)
732 struct rte_mempool_ops *ops;
734 ops = rte_mempool_get_ops(mp->ops_index);
735 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
736 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
737 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
741 * @internal wrapper for mempool_ops enqueue callback.
744 * Pointer to the memory pool.
746 * Pointer to a table of void * pointers (objects).
748 * Number of objects to put.
750 * - 0: Success; n objects supplied.
751 * - <0: Error; code of enqueue function.
754 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
757 struct rte_mempool_ops *ops;
759 __MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
760 __MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
761 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
762 ops = rte_mempool_get_ops(mp->ops_index);
763 return ops->enqueue(mp, obj_table, n);
767 * @internal wrapper for mempool_ops get_count callback.
770 * Pointer to the memory pool.
772 * The number of available objects in the external pool.
775 rte_mempool_ops_get_count(const struct rte_mempool *mp);
778 * @internal wrapper for mempool_ops calc_mem_size callback.
779 * API to calculate size of memory required to store specified number of
783 * Pointer to the memory pool.
786 * @param[in] pg_shift
787 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
788 * @param[out] min_chunk_size
789 * Location for minimum size of the memory chunk which may be used to
790 * store memory pool objects.
792 * Location for required memory chunk alignment.
794 * Required memory size aligned at page boundary.
796 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
797 uint32_t obj_num, uint32_t pg_shift,
798 size_t *min_chunk_size, size_t *align);
801 * @internal wrapper for mempool_ops populate callback.
803 * Populate memory pool objects using provided memory chunk.
806 * A pointer to the mempool structure.
807 * @param[in] max_objs
808 * Maximum number of objects to be populated.
810 * The virtual address of memory that should be used to store objects.
814 * The length of memory in bytes.
816 * Callback function to be executed for each populated object.
817 * @param[in] obj_cb_arg
818 * An opaque pointer passed to the callback function.
820 * The number of objects added on success.
821 * On error, no objects are populated and a negative errno is returned.
823 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
824 void *vaddr, rte_iova_t iova, size_t len,
825 rte_mempool_populate_obj_cb_t *obj_cb,
829 * Wrapper for mempool_ops get_info callback.
832 * Pointer to the memory pool.
834 * Pointer to the rte_mempool_info structure
836 * - 0: Success; The mempool driver supports retrieving supplementary
837 * mempool information
838 * - -ENOTSUP - doesn't support get_info ops (valid case).
840 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
841 struct rte_mempool_info *info);
844 * @internal wrapper for mempool_ops free callback.
847 * Pointer to the memory pool.
850 rte_mempool_ops_free(struct rte_mempool *mp);
853 * Set the ops of a mempool.
855 * This can only be done on a mempool that is not populated, i.e. just after
856 * a call to rte_mempool_create_empty().
859 * Pointer to the memory pool.
861 * Name of the ops structure to use for this mempool.
863 * Opaque data that can be passed by the application to the ops functions.
865 * - 0: Success; the mempool is now using the requested ops functions.
866 * - -EINVAL - Invalid ops struct name provided.
867 * - -EEXIST - mempool already has an ops struct assigned.
870 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
874 * Register mempool operations.
877 * Pointer to an ops structure to register.
879 * - >=0: Success; return the index of the ops struct in the table.
880 * - -EINVAL - some missing callbacks while registering ops struct.
881 * - -ENOSPC - the maximum number of ops structs has been reached.
883 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
886 * Macro to statically register the ops of a mempool handler.
887 * Note that the rte_mempool_register_ops fails silently here when
888 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
890 #define MEMPOOL_REGISTER_OPS(ops) \
891 RTE_INIT(mp_hdlr_init_##ops) \
893 rte_mempool_register_ops(&ops); \
897 * An object callback function for mempool.
899 * Used by rte_mempool_create() and rte_mempool_obj_iter().
901 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
902 void *opaque, void *obj, unsigned obj_idx);
903 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
906 * A memory callback function for mempool.
908 * Used by rte_mempool_mem_iter().
910 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
911 void *opaque, struct rte_mempool_memhdr *memhdr,
915 * A mempool constructor callback function.
917 * Arguments are the mempool and the opaque pointer given by the user in
918 * rte_mempool_create().
920 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
923 * Create a new mempool named *name* in memory.
925 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
926 * pool contains n elements of elt_size. Its size is set to n.
929 * The name of the mempool.
931 * The number of elements in the mempool. The optimum size (in terms of
932 * memory usage) for a mempool is when n is a power of two minus one:
935 * The size of each element.
937 * If cache_size is non-zero, the rte_mempool library will try to
938 * limit the accesses to the common lockless pool, by maintaining a
939 * per-lcore object cache. This argument must be lower or equal to
940 * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
941 * cache_size to have "n modulo cache_size == 0": if this is
942 * not the case, some elements will always stay in the pool and will
943 * never be used. The access to the per-lcore table is of course
944 * faster than the multi-producer/consumer pool. The cache can be
945 * disabled if the cache_size argument is set to 0; it can be useful to
946 * avoid losing objects in cache.
947 * @param private_data_size
948 * The size of the private data appended after the mempool
949 * structure. This is useful for storing some private data after the
950 * mempool structure, as is done for rte_mbuf_pool for example.
952 * A function pointer that is called for initialization of the pool,
953 * before object initialization. The user can initialize the private
954 * data in this function if needed. This parameter can be NULL if
957 * An opaque pointer to data that can be used in the mempool
958 * constructor function.
960 * A function pointer that is called for each object at
961 * initialization of the pool. The user can set some meta data in
962 * objects if needed. This parameter can be NULL if not needed.
963 * The obj_init() function takes the mempool pointer, the init_arg,
964 * the object pointer and the object number as parameters.
965 * @param obj_init_arg
966 * An opaque pointer to data that can be used as an argument for
967 * each call to the object constructor function.
969 * The *socket_id* argument is the socket identifier in the case of
970 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
971 * constraint for the reserved zone.
973 * The *flags* arguments is an OR of following flags:
974 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
975 * between channels in RAM: the pool allocator will add padding
976 * between objects depending on the hardware configuration. See
977 * Memory alignment constraints for details. If this flag is set,
978 * the allocator will just align them to a cache line.
979 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
980 * cache-aligned. This flag removes this constraint, and no
981 * padding will be present between objects. This flag implies
982 * MEMPOOL_F_NO_SPREAD.
983 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
984 * when using rte_mempool_put() or rte_mempool_put_bulk() is
985 * "single-producer". Otherwise, it is "multi-producers".
986 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
987 * when using rte_mempool_get() or rte_mempool_get_bulk() is
988 * "single-consumer". Otherwise, it is "multi-consumers".
989 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
990 * necessarily be contiguous in IO memory.
992 * The pointer to the new allocated mempool, on success. NULL on error
993 * with rte_errno set appropriately. Possible rte_errno values include:
994 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
995 * - E_RTE_SECONDARY - function was called from a secondary process instance
996 * - EINVAL - cache size provided is too large or an unknown flag was passed
997 * - ENOSPC - the maximum number of memzones has already been allocated
998 * - EEXIST - a memzone with the same name already exists
999 * - ENOMEM - no appropriate memory area found in which to create memzone
1001 struct rte_mempool *
1002 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1003 unsigned cache_size, unsigned private_data_size,
1004 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1005 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1006 int socket_id, unsigned flags);
1009 * Create an empty mempool
1011 * The mempool is allocated and initialized, but it is not populated: no
1012 * memory is allocated for the mempool elements. The user has to call
1013 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1014 * populated, the user may also want to initialize each object with
1015 * rte_mempool_obj_iter().
1018 * The name of the mempool.
1020 * The maximum number of elements that can be added in the mempool.
1021 * The optimum size (in terms of memory usage) for a mempool is when n
1022 * is a power of two minus one: n = (2^q - 1).
1024 * The size of each element.
1026 * Size of the cache. See rte_mempool_create() for details.
1027 * @param private_data_size
1028 * The size of the private data appended after the mempool
1029 * structure. This is useful for storing some private data after the
1030 * mempool structure, as is done for rte_mbuf_pool for example.
1032 * The *socket_id* argument is the socket identifier in the case of
1033 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1034 * constraint for the reserved zone.
1036 * Flags controlling the behavior of the mempool. See
1037 * rte_mempool_create() for details.
1039 * The pointer to the new allocated mempool, on success. NULL on error
1040 * with rte_errno set appropriately. See rte_mempool_create() for details.
1042 struct rte_mempool *
1043 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1044 unsigned cache_size, unsigned private_data_size,
1045 int socket_id, unsigned flags);
1049 * Unlink the mempool from global list, free the memory chunks, and all
1050 * memory referenced by the mempool. The objects must not be used by
1051 * other cores as they will be freed.
1054 * A pointer to the mempool structure.
1057 rte_mempool_free(struct rte_mempool *mp);
1060 * Add physically contiguous memory for objects in the pool at init
1062 * Add a virtually and physically contiguous memory chunk in the pool
1063 * where objects can be instantiated.
1065 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1066 * the chunk doesn't need to be physically contiguous (only virtually),
1067 * and allocated objects may span two pages.
1070 * A pointer to the mempool structure.
1072 * The virtual address of memory that should be used to store objects.
1076 * The length of memory in bytes.
1078 * The callback used to free this chunk when destroying the mempool.
1080 * An opaque argument passed to free_cb.
1082 * The number of objects added on success (strictly positive).
1083 * On error, the chunk is not added in the memory list of the
1084 * mempool the following code is returned:
1085 * (0): not enough room in chunk for one object.
1086 * (-ENOSPC): mempool is already populated.
1087 * (-ENOMEM): allocation failure.
1089 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1090 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1094 * Add virtually contiguous memory for objects in the pool at init
1096 * Add a virtually contiguous memory chunk in the pool where objects can
1100 * A pointer to the mempool structure.
1102 * The virtual address of memory that should be used to store objects.
1104 * The length of memory in bytes.
1106 * The size of memory pages in this virtual area.
1108 * The callback used to free this chunk when destroying the mempool.
1110 * An opaque argument passed to free_cb.
1112 * The number of objects added on success (strictly positive).
1113 * On error, the chunk is not added in the memory list of the
1114 * mempool the following code is returned:
1115 * (0): not enough room in chunk for one object.
1116 * (-ENOSPC): mempool is already populated.
1117 * (-ENOMEM): allocation failure.
1120 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1121 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1125 * Add memory for objects in the pool at init
1127 * This is the default function used by rte_mempool_create() to populate
1128 * the mempool. It adds memory allocated using rte_memzone_reserve().
1131 * A pointer to the mempool structure.
1133 * The number of objects added on success.
1134 * On error, the chunk is not added in the memory list of the
1135 * mempool and a negative errno is returned.
1137 int rte_mempool_populate_default(struct rte_mempool *mp);
1140 * Add memory from anonymous mapping for objects in the pool at init
1142 * This function mmap an anonymous memory zone that is locked in
1143 * memory to store the objects of the mempool.
1146 * A pointer to the mempool structure.
1148 * The number of objects added on success.
1149 * On error, 0 is returned, rte_errno is set, and the chunk is not added in
1150 * the memory list of the mempool.
1152 int rte_mempool_populate_anon(struct rte_mempool *mp);
1155 * Call a function for each mempool element
1157 * Iterate across all objects attached to a rte_mempool and call the
1158 * callback function on it.
1161 * A pointer to an initialized mempool.
1163 * A function pointer that is called for each object.
1165 * An opaque pointer passed to the callback function.
1167 * Number of objects iterated.
1169 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1170 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1173 * Call a function for each mempool memory chunk
1175 * Iterate across all memory chunks attached to a rte_mempool and call
1176 * the callback function on it.
1179 * A pointer to an initialized mempool.
1181 * A function pointer that is called for each memory chunk.
1183 * An opaque pointer passed to the callback function.
1185 * Number of memory chunks iterated.
1187 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1188 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1191 * Dump the status of the mempool to a file.
1194 * A pointer to a file for output
1196 * A pointer to the mempool structure.
1198 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1201 * Create a user-owned mempool cache.
1203 * This can be used by unregistered non-EAL threads to enable caching when they
1204 * interact with a mempool.
1207 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1208 * parameter description for more information. The same limits and
1209 * considerations apply here too.
1211 * The socket identifier in the case of NUMA. The value can be
1212 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1214 struct rte_mempool_cache *
1215 rte_mempool_cache_create(uint32_t size, int socket_id);
1218 * Free a user-owned mempool cache.
1221 * A pointer to the mempool cache.
1224 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1227 * Get a pointer to the per-lcore default mempool cache.
1230 * A pointer to the mempool structure.
1232 * The logical core id.
1234 * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
1237 static __rte_always_inline struct rte_mempool_cache *
1238 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1240 if (mp->cache_size == 0)
1243 if (lcore_id >= RTE_MAX_LCORE)
1246 rte_mempool_trace_default_cache(mp, lcore_id,
1247 &mp->local_cache[lcore_id]);
1248 return &mp->local_cache[lcore_id];
1252 * Flush a user-owned mempool cache to the specified mempool.
1255 * A pointer to the mempool cache.
1257 * A pointer to the mempool.
1259 static __rte_always_inline void
1260 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1261 struct rte_mempool *mp)
1264 cache = rte_mempool_default_cache(mp, rte_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);
1273 * @internal Put several objects back in the mempool; used internally.
1275 * A pointer to the mempool structure.
1277 * A pointer to a table of void * pointers (objects).
1279 * The number of objects to store back in the mempool, must be strictly
1282 * A pointer to a mempool cache structure. May be NULL if not needed.
1284 static __rte_always_inline void
1285 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1286 unsigned int n, struct rte_mempool_cache *cache)
1290 /* increment stat now, adding in mempool always success */
1291 __MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1292 __MEMPOOL_STAT_ADD(mp, put_objs, n);
1294 /* No cache provided or if put would overflow mem allocated for cache */
1295 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1298 cache_objs = &cache->objs[cache->len];
1301 * The cache follows the following algorithm
1302 * 1. Add the objects to the cache
1303 * 2. Anything greater than the cache min value (if it crosses the
1304 * cache flush threshold) is flushed to the ring.
1307 /* Add elements back into the cache */
1308 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1312 if (cache->len >= cache->flushthresh) {
1313 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1314 cache->len - cache->size);
1315 cache->len = cache->size;
1322 /* push remaining objects in ring */
1323 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1324 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1325 rte_panic("cannot put objects in mempool\n");
1327 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1333 * Put several objects back in the mempool.
1336 * A pointer to the mempool structure.
1338 * A pointer to a table of void * pointers (objects).
1340 * The number of objects to add in the mempool from the obj_table.
1342 * A pointer to a mempool cache structure. May be NULL if not needed.
1344 static __rte_always_inline void
1345 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1346 unsigned int n, struct rte_mempool_cache *cache)
1348 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1349 __mempool_check_cookies(mp, obj_table, n, 0);
1350 __mempool_generic_put(mp, obj_table, n, cache);
1354 * Put several objects back in the mempool.
1356 * This function calls the multi-producer or the single-producer
1357 * version depending on the default behavior that was specified at
1358 * mempool creation time (see flags).
1361 * A pointer to the mempool structure.
1363 * A pointer to a table of void * pointers (objects).
1365 * The number of objects to add in the mempool from obj_table.
1367 static __rte_always_inline void
1368 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1371 struct rte_mempool_cache *cache;
1372 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1373 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1374 rte_mempool_generic_put(mp, obj_table, n, cache);
1378 * Put one object back in the mempool.
1380 * This function calls the multi-producer or the single-producer
1381 * version depending on the default behavior that was specified at
1382 * mempool creation time (see flags).
1385 * A pointer to the mempool structure.
1387 * A pointer to the object to be added.
1389 static __rte_always_inline void
1390 rte_mempool_put(struct rte_mempool *mp, void *obj)
1392 rte_mempool_put_bulk(mp, &obj, 1);
1396 * @internal Get several objects from the mempool; used internally.
1398 * A pointer to the mempool structure.
1400 * A pointer to a table of void * pointers (objects).
1402 * The number of objects to get, must be strictly positive.
1404 * A pointer to a mempool cache structure. May be NULL if not needed.
1406 * - >=0: Success; number of objects supplied.
1407 * - <0: Error; code of ring dequeue function.
1409 static __rte_always_inline int
1410 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1411 unsigned int n, struct rte_mempool_cache *cache)
1414 uint32_t index, len;
1417 /* No cache provided or cannot be satisfied from cache */
1418 if (unlikely(cache == NULL || n >= cache->size))
1421 cache_objs = cache->objs;
1423 /* Can this be satisfied from the cache? */
1424 if (cache->len < n) {
1425 /* No. Backfill the cache first, and then fill from it */
1426 uint32_t req = n + (cache->size - cache->len);
1428 /* How many do we require i.e. number to fill the cache + the request */
1429 ret = rte_mempool_ops_dequeue_bulk(mp,
1430 &cache->objs[cache->len], req);
1431 if (unlikely(ret < 0)) {
1433 * In the off chance that we are buffer constrained,
1434 * where we are not able to allocate cache + n, go to
1435 * the ring directly. If that fails, we are truly out of
1444 /* Now fill in the response ... */
1445 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1446 *obj_table = cache_objs[len];
1450 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1451 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1457 /* get remaining objects from ring */
1458 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1461 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1462 __MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1464 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1465 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1472 * Get several objects from the mempool.
1474 * If cache is enabled, objects will be retrieved first from cache,
1475 * subsequently from the common pool. Note that it can return -ENOENT when
1476 * the local cache and common pool are empty, even if cache from other
1480 * A pointer to the mempool structure.
1482 * A pointer to a table of void * pointers (objects) that will be filled.
1484 * The number of objects to get from mempool to obj_table.
1486 * A pointer to a mempool cache structure. May be NULL if not needed.
1488 * - 0: Success; objects taken.
1489 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1491 static __rte_always_inline int
1492 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1493 unsigned int n, struct rte_mempool_cache *cache)
1496 ret = __mempool_generic_get(mp, obj_table, n, cache);
1498 __mempool_check_cookies(mp, obj_table, n, 1);
1499 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1504 * Get several objects from the mempool.
1506 * This function calls the multi-consumers or the single-consumer
1507 * version, depending on the default behaviour that was specified at
1508 * mempool creation time (see flags).
1510 * If cache is enabled, objects will be retrieved first from cache,
1511 * subsequently from the common pool. Note that it can return -ENOENT when
1512 * the local cache and common pool are empty, even if cache from other
1516 * A pointer to the mempool structure.
1518 * A pointer to a table of void * pointers (objects) that will be filled.
1520 * The number of objects to get from the mempool to obj_table.
1522 * - 0: Success; objects taken
1523 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1525 static __rte_always_inline int
1526 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1528 struct rte_mempool_cache *cache;
1529 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1530 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1531 return rte_mempool_generic_get(mp, obj_table, n, cache);
1535 * Get one object from the mempool.
1537 * This function calls the multi-consumers or the single-consumer
1538 * version, depending on the default behavior that was specified at
1539 * mempool creation (see flags).
1541 * If cache is enabled, objects will be retrieved first from cache,
1542 * subsequently from the common pool. Note that it can return -ENOENT when
1543 * the local cache and common pool are empty, even if cache from other
1547 * A pointer to the mempool structure.
1549 * A pointer to a void * pointer (object) that will be filled.
1551 * - 0: Success; objects taken.
1552 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1554 static __rte_always_inline int
1555 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1557 return rte_mempool_get_bulk(mp, obj_p, 1);
1561 * Get a contiguous blocks of objects from the mempool.
1563 * If cache is enabled, consider to flush it first, to reuse objects
1564 * as soon as possible.
1566 * The application should check that the driver supports the operation
1567 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1571 * A pointer to the mempool structure.
1572 * @param first_obj_table
1573 * A pointer to a pointer to the first object in each block.
1575 * The number of blocks to get from mempool.
1577 * - 0: Success; blocks taken.
1578 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1579 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1581 static __rte_always_inline int
1582 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1583 void **first_obj_table, unsigned int n)
1587 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1589 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1590 __MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1591 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1594 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1595 __MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1598 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1603 * Return the number of entries in the mempool.
1605 * When cache is enabled, this function has to browse the length of
1606 * all lcores, so it should not be used in a data path, but only for
1607 * debug purposes. User-owned mempool caches are not accounted for.
1610 * A pointer to the mempool structure.
1612 * The number of entries in the mempool.
1614 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1617 * Return the number of elements which have been allocated from the mempool
1619 * When cache is enabled, this function has to browse the length of
1620 * all lcores, so it should not be used in a data path, but only for
1624 * A pointer to the mempool structure.
1626 * The number of free entries in the mempool.
1629 rte_mempool_in_use_count(const struct rte_mempool *mp);
1632 * Test if the mempool is full.
1634 * When cache is enabled, this function has to browse the length of all
1635 * lcores, so it should not be used in a data path, but only for debug
1636 * purposes. User-owned mempool caches are not accounted for.
1639 * A pointer to the mempool structure.
1641 * - 1: The mempool is full.
1642 * - 0: The mempool is not full.
1645 rte_mempool_full(const struct rte_mempool *mp)
1647 return rte_mempool_avail_count(mp) == mp->size;
1651 * Test if the mempool is empty.
1653 * When cache is enabled, this function has to browse the length of all
1654 * lcores, so it should not be used in a data path, but only for debug
1655 * purposes. User-owned mempool caches are not accounted for.
1658 * A pointer to the mempool structure.
1660 * - 1: The mempool is empty.
1661 * - 0: The mempool is not empty.
1664 rte_mempool_empty(const struct rte_mempool *mp)
1666 return rte_mempool_avail_count(mp) == 0;
1670 * Return the IO address of elt, which is an element of the pool mp.
1673 * A pointer (virtual address) to the element of the pool.
1675 * The IO address of the elt element.
1676 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1677 * returned value is RTE_BAD_IOVA.
1679 static inline rte_iova_t
1680 rte_mempool_virt2iova(const void *elt)
1682 const struct rte_mempool_objhdr *hdr;
1683 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1689 * Check the consistency of mempool objects.
1691 * Verify the coherency of fields in the mempool structure. Also check
1692 * that the cookies of mempool objects (even the ones that are not
1693 * present in pool) have a correct value. If not, a panic will occur.
1696 * A pointer to the mempool structure.
1698 void rte_mempool_audit(struct rte_mempool *mp);
1701 * Return a pointer to the private data in an mempool structure.
1704 * A pointer to the mempool structure.
1706 * A pointer to the private data.
1708 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1711 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1715 * Dump the status of all mempools on the console
1718 * A pointer to a file for output
1720 void rte_mempool_list_dump(FILE *f);
1723 * Search a mempool from its name
1726 * The name of the mempool.
1728 * The pointer to the mempool matching the name, or NULL if not found.
1730 * with rte_errno set appropriately. Possible rte_errno values include:
1731 * - ENOENT - required entry not available to return.
1734 struct rte_mempool *rte_mempool_lookup(const char *name);
1737 * Get the header, trailer and total size of a mempool element.
1739 * Given a desired size of the mempool element and mempool flags,
1740 * calculates header, trailer, body and total sizes of the mempool object.
1743 * The size of each element, without header and trailer.
1745 * The flags used for the mempool creation.
1746 * Consult rte_mempool_create() for more information about possible values.
1747 * The size of each element.
1749 * The calculated detailed size the mempool object. May be NULL.
1751 * Total size of the mempool object.
1753 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1754 struct rte_mempool_objsz *sz);
1757 * Walk list of all memory pools
1762 * Argument passed to iterator
1764 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1768 * @internal Get page size used for mempool object allocation.
1769 * This function is internal to mempool library and mempool drivers.
1772 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1775 * Mempool event type.
1778 enum rte_mempool_event {
1779 /** Occurs after a mempool is fully populated. */
1780 RTE_MEMPOOL_EVENT_READY = 0,
1781 /** Occurs before the destruction of a mempool begins. */
1782 RTE_MEMPOOL_EVENT_DESTROY = 1,
1787 * Mempool event callback.
1789 * rte_mempool_event_callback_register() may be called from within the callback,
1790 * but the callbacks registered this way will not be invoked for the same event.
1791 * rte_mempool_event_callback_unregister() may only be safely called
1792 * to remove the running callback.
1794 typedef void (rte_mempool_event_callback)(
1795 enum rte_mempool_event event,
1796 struct rte_mempool *mp,
1801 * Register a callback function invoked on mempool life cycle event.
1802 * The function will be invoked in the process
1803 * that performs an action which triggers the callback.
1806 * Callback function.
1811 * 0 on success, negative on failure and rte_errno is set.
1815 rte_mempool_event_callback_register(rte_mempool_event_callback *func,
1820 * Unregister a callback added with rte_mempool_event_callback_register().
1821 * @p func and @p user_data must exactly match registration parameters.
1824 * Callback function.
1829 * 0 on success, negative on failure and rte_errno is set.
1833 rte_mempool_event_callback_unregister(rte_mempool_event_callback *func,
1840 #endif /* _RTE_MEMPOOL_H_ */