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 /** Successful allocation number of contiguous blocks. */
74 uint64_t get_success_blks;
75 /** Failed allocation number of contiguous blocks. */
76 uint64_t get_fail_blks;
77 } __rte_cache_aligned;
81 * A structure that stores a per-core object cache.
83 struct rte_mempool_cache {
84 uint32_t size; /**< Size of the cache */
85 uint32_t flushthresh; /**< Threshold before we flush excess elements */
86 uint32_t len; /**< Current cache count */
88 * Cache is allocated to this size to allow it to overflow in certain
89 * cases to avoid needless emptying of cache.
91 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
92 } __rte_cache_aligned;
95 * A structure that stores the size of mempool elements.
97 struct rte_mempool_objsz {
98 uint32_t elt_size; /**< Size of an element. */
99 uint32_t header_size; /**< Size of header (before elt). */
100 uint32_t trailer_size; /**< Size of trailer (after elt). */
102 /**< Total size of an object (header + elt + trailer). */
105 /**< Maximum length of a memory pool's name. */
106 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
107 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
108 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
111 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
113 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
115 /** Mempool over one chunk of physically continuous memory */
116 #define MEMPOOL_PG_NUM_DEFAULT 1
118 #ifndef RTE_MEMPOOL_ALIGN
119 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
122 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
125 * Mempool object header structure
127 * Each object stored in mempools are prefixed by this header structure,
128 * it allows to retrieve the mempool pointer from the object and to
129 * iterate on all objects attached to a mempool. When debug is enabled,
130 * a cookie is also added in this structure preventing corruptions and
133 struct rte_mempool_objhdr {
134 STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
135 struct rte_mempool *mp; /**< The mempool owning the object. */
138 rte_iova_t iova; /**< IO address of the object. */
139 phys_addr_t physaddr; /**< deprecated - Physical address of the object. */
141 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
142 uint64_t cookie; /**< Debug cookie. */
147 * A list of object headers type
149 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
151 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
154 * Mempool object trailer structure
156 * In debug mode, each object stored in mempools are suffixed by this
157 * trailer structure containing a cookie preventing memory corruptions.
159 struct rte_mempool_objtlr {
160 uint64_t cookie; /**< Debug cookie. */
166 * A list of memory where objects are stored
168 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
171 * Callback used to free a memory chunk
173 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
177 * Mempool objects memory header structure
179 * The memory chunks where objects are stored. Each chunk is virtually
180 * and physically contiguous.
182 struct rte_mempool_memhdr {
183 STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
184 struct rte_mempool *mp; /**< The mempool owning the chunk */
185 void *addr; /**< Virtual address of the chunk */
188 rte_iova_t iova; /**< IO address of the chunk */
189 phys_addr_t phys_addr; /**< Physical address of the chunk */
191 size_t len; /**< length of the chunk */
192 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
193 void *opaque; /**< Argument passed to the free callback */
198 * @b EXPERIMENTAL: this API may change without prior notice.
200 * Additional information about the mempool
202 * The structure is cache-line aligned to avoid ABI breakages in
203 * a number of cases when something small is added.
205 struct rte_mempool_info {
206 /** Number of objects in the contiguous block */
207 unsigned int contig_block_size;
208 } __rte_cache_aligned;
211 * The RTE mempool structure.
215 * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
216 * compatibility requirements, it could be changed to
217 * RTE_MEMPOOL_NAMESIZE next time the ABI changes
219 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
222 void *pool_data; /**< Ring or pool to store objects. */
223 uint64_t pool_id; /**< External mempool identifier. */
225 void *pool_config; /**< optional args for ops alloc. */
226 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
227 unsigned int flags; /**< Flags of the mempool. */
228 int socket_id; /**< Socket id passed at create. */
229 uint32_t size; /**< Max size of the mempool. */
231 /**< Size of per-lcore default local cache. */
233 uint32_t elt_size; /**< Size of an element. */
234 uint32_t header_size; /**< Size of header (before elt). */
235 uint32_t trailer_size; /**< Size of trailer (after elt). */
237 unsigned private_data_size; /**< Size of private data. */
239 * Index into rte_mempool_ops_table array of mempool ops
240 * structs, which contain callback function pointers.
241 * We're using an index here rather than pointers to the callbacks
242 * to facilitate any secondary processes that may want to use
247 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
249 uint32_t populated_size; /**< Number of populated objects. */
250 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
251 uint32_t nb_mem_chunks; /**< Number of memory chunks */
252 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
254 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
255 /** Per-lcore statistics. */
256 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
258 } __rte_cache_aligned;
260 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread among memory channels. */
261 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
262 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
263 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
264 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
265 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
266 #define MEMPOOL_F_NO_PHYS_CONTIG MEMPOOL_F_NO_IOVA_CONTIG /* deprecated */
269 * @internal When debug is enabled, store some statistics.
272 * Pointer to the memory pool.
274 * Name of the statistics field to increment in the memory pool.
276 * Number to add to the object-oriented statistics.
278 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
279 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
280 unsigned __lcore_id = rte_lcore_id(); \
281 if (__lcore_id < RTE_MAX_LCORE) { \
282 mp->stats[__lcore_id].name##_objs += n; \
283 mp->stats[__lcore_id].name##_bulk += 1; \
286 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do { \
287 unsigned int __lcore_id = rte_lcore_id(); \
288 if (__lcore_id < RTE_MAX_LCORE) { \
289 mp->stats[__lcore_id].name##_blks += n; \
290 mp->stats[__lcore_id].name##_bulk += 1; \
294 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
295 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do {} while (0)
299 * Calculate the size of the mempool header.
302 * Pointer to the memory pool.
304 * Size of the per-lcore cache.
306 #define MEMPOOL_HEADER_SIZE(mp, cs) \
307 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
308 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
310 /* return the header of a mempool object (internal) */
311 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
313 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
314 sizeof(struct rte_mempool_objhdr));
318 * Return a pointer to the mempool owning this object.
321 * An object that is owned by a pool. If this is not the case,
322 * the behavior is undefined.
324 * A pointer to the mempool structure.
326 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
328 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
332 /* return the trailer of a mempool object (internal) */
333 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
335 struct rte_mempool *mp = rte_mempool_from_obj(obj);
336 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
340 * @internal Check and update cookies or panic.
343 * Pointer to the memory pool.
344 * @param obj_table_const
345 * Pointer to a table of void * pointers (objects).
347 * Index of object in object table.
349 * - 0: object is supposed to be allocated, mark it as free
350 * - 1: object is supposed to be free, mark it as allocated
351 * - 2: just check that cookie is valid (free or allocated)
353 void rte_mempool_check_cookies(const struct rte_mempool *mp,
354 void * const *obj_table_const, unsigned n, int free);
356 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
357 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
358 rte_mempool_check_cookies(mp, obj_table_const, n, free)
360 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
361 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
365 * @b EXPERIMENTAL: this API may change without prior notice.
367 * @internal Check contiguous object blocks and update cookies or panic.
370 * Pointer to the memory pool.
371 * @param first_obj_table_const
372 * Pointer to a table of void * pointers (first object of the contiguous
375 * Number of contiguous object blocks.
377 * - 0: object is supposed to be allocated, mark it as free
378 * - 1: object is supposed to be free, mark it as allocated
379 * - 2: just check that cookie is valid (free or allocated)
381 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
382 void * const *first_obj_table_const, unsigned int n, int free);
384 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
385 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
387 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
390 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
393 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
395 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
398 * Prototype for implementation specific data provisioning function.
400 * The function should provide the implementation specific memory for
401 * use by the other mempool ops functions in a given mempool ops struct.
402 * E.g. the default ops provides an instance of the rte_ring for this purpose.
403 * it will most likely point to a different type of data structure, and
404 * will be transparent to the application programmer.
405 * This function should set mp->pool_data.
407 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
410 * Free the opaque private data pointed to by mp->pool_data pointer.
412 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
415 * Enqueue an object into the external pool.
417 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
418 void * const *obj_table, unsigned int n);
421 * Dequeue an object from the external pool.
423 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
424 void **obj_table, unsigned int n);
428 * @b EXPERIMENTAL: this API may change without prior notice.
430 * Dequeue a number of contiquous object blocks from the external pool.
432 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
433 void **first_obj_table, unsigned int n);
436 * Return the number of available objects in the external pool.
438 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
441 * Calculate memory size required to store given number of objects.
443 * If mempool objects are not required to be IOVA-contiguous
444 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
445 * virtually contiguous chunk size. Otherwise, if mempool objects must
446 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
447 * min_chunk_size defines IOVA-contiguous chunk size.
450 * Pointer to the memory pool.
453 * @param[in] pg_shift
454 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
455 * @param[out] min_chunk_size
456 * Location for minimum size of the memory chunk which may be used to
457 * store memory pool objects.
459 * Location for required memory chunk alignment.
461 * Required memory size aligned at page boundary.
463 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
464 uint32_t obj_num, uint32_t pg_shift,
465 size_t *min_chunk_size, size_t *align);
468 * Default way to calculate memory size required to store given number of
471 * If page boundaries may be ignored, it is just a product of total
472 * object size including header and trailer and number of objects.
473 * Otherwise, it is a number of pages required to store given number of
474 * objects without crossing page boundary.
476 * Note that if object size is bigger than page size, then it assumes
477 * that pages are grouped in subsets of physically continuous pages big
478 * enough to store at least one object.
480 * Minimum size of memory chunk is a maximum of the page size and total
483 * Required memory chunk alignment is a maximum of page size and cache
486 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
487 uint32_t obj_num, uint32_t pg_shift,
488 size_t *min_chunk_size, size_t *align);
491 * @internal Helper function to calculate memory size required to store
492 * specified number of objects in assumption that the memory buffer will
493 * be aligned at page boundary.
495 * Note that if object size is bigger than page size, then it assumes
496 * that pages are grouped in subsets of physically continuous pages big
497 * enough to store at least one object.
500 * Number of elements.
501 * @param total_elt_sz
502 * The size of each element, including header and trailer, as returned
503 * by rte_mempool_calc_obj_size().
505 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
507 * Required memory size aligned at page boundary.
509 size_t rte_mempool_calc_mem_size_helper(uint32_t elt_num, size_t total_elt_sz,
513 * Function to be called for each populated object.
516 * A pointer to the mempool structure.
518 * An opaque pointer passed to iterator.
520 * Object virtual address.
522 * Input/output virtual address of the object or RTE_BAD_IOVA.
524 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
525 void *opaque, void *vaddr, rte_iova_t iova);
528 * Populate memory pool objects using provided memory chunk.
530 * Populated objects should be enqueued to the pool, e.g. using
531 * rte_mempool_ops_enqueue_bulk().
533 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
534 * the chunk doesn't need to be physically contiguous (only virtually),
535 * and allocated objects may span two pages.
538 * A pointer to the mempool structure.
539 * @param[in] max_objs
540 * Maximum number of objects to be populated.
542 * The virtual address of memory that should be used to store objects.
546 * The length of memory in bytes.
548 * Callback function to be executed for each populated object.
549 * @param[in] obj_cb_arg
550 * An opaque pointer passed to the callback function.
552 * The number of objects added on success.
553 * On error, no objects are populated and a negative errno is returned.
555 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
556 unsigned int max_objs,
557 void *vaddr, rte_iova_t iova, size_t len,
558 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
561 * Default way to populate memory pool object using provided memory
562 * chunk: just slice objects one by one.
564 int rte_mempool_op_populate_default(struct rte_mempool *mp,
565 unsigned int max_objs,
566 void *vaddr, rte_iova_t iova, size_t len,
567 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
571 * @b EXPERIMENTAL: this API may change without prior notice.
573 * Get some additional information about a mempool.
575 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
576 struct rte_mempool_info *info);
579 /** Structure defining mempool operations structure */
580 struct rte_mempool_ops {
581 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
582 rte_mempool_alloc_t alloc; /**< Allocate private data. */
583 rte_mempool_free_t free; /**< Free the external pool. */
584 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
585 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
586 rte_mempool_get_count get_count; /**< Get qty of available objs. */
588 * Optional callback to calculate memory size required to
589 * store specified number of objects.
591 rte_mempool_calc_mem_size_t calc_mem_size;
593 * Optional callback to populate mempool objects using
594 * provided memory chunk.
596 rte_mempool_populate_t populate;
600 rte_mempool_get_info_t get_info;
602 * Dequeue a number of contiguous object blocks.
604 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
605 } __rte_cache_aligned;
607 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
610 * Structure storing the table of registered ops structs, each of which contain
611 * the function pointers for the mempool ops functions.
612 * Each process has its own storage for this ops struct array so that
613 * the mempools can be shared across primary and secondary processes.
614 * The indices used to access the array are valid across processes, whereas
615 * any function pointers stored directly in the mempool struct would not be.
616 * This results in us simply having "ops_index" in the mempool struct.
618 struct rte_mempool_ops_table {
619 rte_spinlock_t sl; /**< Spinlock for add/delete. */
620 uint32_t num_ops; /**< Number of used ops structs in the table. */
622 * Storage for all possible ops structs.
624 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
625 } __rte_cache_aligned;
627 /** Array of registered ops structs. */
628 extern struct rte_mempool_ops_table rte_mempool_ops_table;
631 * @internal Get the mempool ops struct from its index.
634 * The index of the ops struct in the ops struct table. It must be a valid
635 * index: (0 <= idx < num_ops).
637 * The pointer to the ops struct in the table.
639 static inline struct rte_mempool_ops *
640 rte_mempool_get_ops(int ops_index)
642 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
644 return &rte_mempool_ops_table.ops[ops_index];
648 * @internal Wrapper for mempool_ops alloc callback.
651 * Pointer to the memory pool.
653 * - 0: Success; successfully allocated mempool pool_data.
654 * - <0: Error; code of alloc function.
657 rte_mempool_ops_alloc(struct rte_mempool *mp);
660 * @internal Wrapper for mempool_ops dequeue callback.
663 * Pointer to the memory pool.
665 * Pointer to a table of void * pointers (objects).
667 * Number of objects to get.
669 * - 0: Success; got n objects.
670 * - <0: Error; code of dequeue function.
673 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
674 void **obj_table, unsigned n)
676 struct rte_mempool_ops *ops;
678 ops = rte_mempool_get_ops(mp->ops_index);
679 return ops->dequeue(mp, obj_table, n);
683 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
686 * Pointer to the memory pool.
687 * @param[out] first_obj_table
688 * Pointer to a table of void * pointers (first objects).
690 * Number of blocks to get.
692 * - 0: Success; got n objects.
693 * - <0: Error; code of dequeue function.
696 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
697 void **first_obj_table, unsigned int n)
699 struct rte_mempool_ops *ops;
701 ops = rte_mempool_get_ops(mp->ops_index);
702 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
703 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
707 * @internal wrapper for mempool_ops enqueue callback.
710 * Pointer to the memory pool.
712 * Pointer to a table of void * pointers (objects).
714 * Number of objects to put.
716 * - 0: Success; n objects supplied.
717 * - <0: Error; code of enqueue function.
720 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
723 struct rte_mempool_ops *ops;
725 ops = rte_mempool_get_ops(mp->ops_index);
726 return ops->enqueue(mp, obj_table, n);
730 * @internal wrapper for mempool_ops get_count callback.
733 * Pointer to the memory pool.
735 * The number of available objects in the external pool.
738 rte_mempool_ops_get_count(const struct rte_mempool *mp);
741 * @internal wrapper for mempool_ops calc_mem_size callback.
742 * API to calculate size of memory required to store specified number of
746 * Pointer to the memory pool.
749 * @param[in] pg_shift
750 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
751 * @param[out] min_chunk_size
752 * Location for minimum size of the memory chunk which may be used to
753 * store memory pool objects.
755 * Location for required memory chunk alignment.
757 * Required memory size aligned at page boundary.
759 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
760 uint32_t obj_num, uint32_t pg_shift,
761 size_t *min_chunk_size, size_t *align);
764 * @internal wrapper for mempool_ops populate callback.
766 * Populate memory pool objects using provided memory chunk.
769 * A pointer to the mempool structure.
770 * @param[in] max_objs
771 * Maximum number of objects to be populated.
773 * The virtual address of memory that should be used to store objects.
777 * The length of memory in bytes.
779 * Callback function to be executed for each populated object.
780 * @param[in] obj_cb_arg
781 * An opaque pointer passed to the callback function.
783 * The number of objects added on success.
784 * On error, no objects are populated and a negative errno is returned.
786 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
787 void *vaddr, rte_iova_t iova, size_t len,
788 rte_mempool_populate_obj_cb_t *obj_cb,
793 * @b EXPERIMENTAL: this API may change without prior notice.
795 * Wrapper for mempool_ops get_info callback.
798 * Pointer to the memory pool.
800 * Pointer to the rte_mempool_info structure
802 * - 0: Success; The mempool driver supports retrieving supplementary
803 * mempool information
804 * - -ENOTSUP - doesn't support get_info ops (valid case).
807 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
808 struct rte_mempool_info *info);
811 * @internal wrapper for mempool_ops free callback.
814 * Pointer to the memory pool.
817 rte_mempool_ops_free(struct rte_mempool *mp);
820 * Set the ops of a mempool.
822 * This can only be done on a mempool that is not populated, i.e. just after
823 * a call to rte_mempool_create_empty().
826 * Pointer to the memory pool.
828 * Name of the ops structure to use for this mempool.
830 * Opaque data that can be passed by the application to the ops functions.
832 * - 0: Success; the mempool is now using the requested ops functions.
833 * - -EINVAL - Invalid ops struct name provided.
834 * - -EEXIST - mempool already has an ops struct assigned.
837 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
841 * Register mempool operations.
844 * Pointer to an ops structure to register.
846 * - >=0: Success; return the index of the ops struct in the table.
847 * - -EINVAL - some missing callbacks while registering ops struct.
848 * - -ENOSPC - the maximum number of ops structs has been reached.
850 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
853 * Macro to statically register the ops of a mempool handler.
854 * Note that the rte_mempool_register_ops fails silently here when
855 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
857 #define MEMPOOL_REGISTER_OPS(ops) \
858 void mp_hdlr_init_##ops(void); \
859 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
861 rte_mempool_register_ops(&ops); \
865 * An object callback function for mempool.
867 * Used by rte_mempool_create() and rte_mempool_obj_iter().
869 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
870 void *opaque, void *obj, unsigned obj_idx);
871 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
874 * A memory callback function for mempool.
876 * Used by rte_mempool_mem_iter().
878 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
879 void *opaque, struct rte_mempool_memhdr *memhdr,
883 * A mempool constructor callback function.
885 * Arguments are the mempool and the opaque pointer given by the user in
886 * rte_mempool_create().
888 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
891 * Create a new mempool named *name* in memory.
893 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
894 * pool contains n elements of elt_size. Its size is set to n.
897 * The name of the mempool.
899 * The number of elements in the mempool. The optimum size (in terms of
900 * memory usage) for a mempool is when n is a power of two minus one:
903 * The size of each element.
905 * If cache_size is non-zero, the rte_mempool library will try to
906 * limit the accesses to the common lockless pool, by maintaining a
907 * per-lcore object cache. This argument must be lower or equal to
908 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
909 * cache_size to have "n modulo cache_size == 0": if this is
910 * not the case, some elements will always stay in the pool and will
911 * never be used. The access to the per-lcore table is of course
912 * faster than the multi-producer/consumer pool. The cache can be
913 * disabled if the cache_size argument is set to 0; it can be useful to
914 * avoid losing objects in cache.
915 * @param private_data_size
916 * The size of the private data appended after the mempool
917 * structure. This is useful for storing some private data after the
918 * mempool structure, as is done for rte_mbuf_pool for example.
920 * A function pointer that is called for initialization of the pool,
921 * before object initialization. The user can initialize the private
922 * data in this function if needed. This parameter can be NULL if
925 * An opaque pointer to data that can be used in the mempool
926 * constructor function.
928 * A function pointer that is called for each object at
929 * initialization of the pool. The user can set some meta data in
930 * objects if needed. This parameter can be NULL if not needed.
931 * The obj_init() function takes the mempool pointer, the init_arg,
932 * the object pointer and the object number as parameters.
933 * @param obj_init_arg
934 * An opaque pointer to data that can be used as an argument for
935 * each call to the object constructor function.
937 * The *socket_id* argument is the socket identifier in the case of
938 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
939 * constraint for the reserved zone.
941 * The *flags* arguments is an OR of following flags:
942 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
943 * between channels in RAM: the pool allocator will add padding
944 * between objects depending on the hardware configuration. See
945 * Memory alignment constraints for details. If this flag is set,
946 * the allocator will just align them to a cache line.
947 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
948 * cache-aligned. This flag removes this constraint, and no
949 * padding will be present between objects. This flag implies
950 * MEMPOOL_F_NO_SPREAD.
951 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
952 * when using rte_mempool_put() or rte_mempool_put_bulk() is
953 * "single-producer". Otherwise, it is "multi-producers".
954 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
955 * when using rte_mempool_get() or rte_mempool_get_bulk() is
956 * "single-consumer". Otherwise, it is "multi-consumers".
957 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
958 * necessarily be contiguous in IO memory.
960 * The pointer to the new allocated mempool, on success. NULL on error
961 * with rte_errno set appropriately. Possible rte_errno values include:
962 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
963 * - E_RTE_SECONDARY - function was called from a secondary process instance
964 * - EINVAL - cache size provided is too large
965 * - ENOSPC - the maximum number of memzones has already been allocated
966 * - EEXIST - a memzone with the same name already exists
967 * - ENOMEM - no appropriate memory area found in which to create memzone
970 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
971 unsigned cache_size, unsigned private_data_size,
972 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
973 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
974 int socket_id, unsigned flags);
978 * Create a new mempool named *name* in memory.
980 * The pool contains n elements of elt_size. Its size is set to n.
981 * This function uses ``memzone_reserve()`` to allocate the mempool header
982 * (and the objects if vaddr is NULL).
983 * Depending on the input parameters, mempool elements can be either allocated
984 * together with the mempool header, or an externally provided memory buffer
985 * could be used to store mempool objects. In later case, that external
986 * memory buffer can consist of set of disjoint physical pages.
989 * The name of the mempool.
991 * The number of elements in the mempool. The optimum size (in terms of
992 * memory usage) for a mempool is when n is a power of two minus one:
995 * The size of each element.
997 * Size of the cache. See rte_mempool_create() for details.
998 * @param private_data_size
999 * The size of the private data appended after the mempool
1000 * structure. This is useful for storing some private data after the
1001 * mempool structure, as is done for rte_mbuf_pool for example.
1003 * A function pointer that is called for initialization of the pool,
1004 * before object initialization. The user can initialize the private
1005 * data in this function if needed. This parameter can be NULL if
1007 * @param mp_init_arg
1008 * An opaque pointer to data that can be used in the mempool
1009 * constructor function.
1011 * A function called for each object at initialization of the pool.
1012 * See rte_mempool_create() for details.
1013 * @param obj_init_arg
1014 * An opaque pointer passed to the object constructor function.
1016 * The *socket_id* argument is the socket identifier in the case of
1017 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1018 * constraint for the reserved zone.
1020 * Flags controlling the behavior of the mempool. See
1021 * rte_mempool_create() for details.
1023 * Virtual address of the externally allocated memory buffer.
1024 * Will be used to store mempool objects.
1026 * Array of IO addresses of the pages that comprises given memory buffer.
1028 * Number of elements in the iova array.
1030 * LOG2 of the physical pages size.
1032 * The pointer to the new allocated mempool, on success. NULL on error
1033 * with rte_errno set appropriately. See rte_mempool_create() for details.
1036 struct rte_mempool *
1037 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
1038 unsigned cache_size, unsigned private_data_size,
1039 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1040 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1041 int socket_id, unsigned flags, void *vaddr,
1042 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift);
1045 * Create an empty mempool
1047 * The mempool is allocated and initialized, but it is not populated: no
1048 * memory is allocated for the mempool elements. The user has to call
1049 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1050 * populated, the user may also want to initialize each object with
1051 * rte_mempool_obj_iter().
1054 * The name of the mempool.
1056 * The maximum number of elements that can be added in the mempool.
1057 * The optimum size (in terms of memory usage) for a mempool is when n
1058 * is a power of two minus one: n = (2^q - 1).
1060 * The size of each element.
1062 * Size of the cache. See rte_mempool_create() for details.
1063 * @param private_data_size
1064 * The size of the private data appended after the mempool
1065 * structure. This is useful for storing some private data after the
1066 * mempool structure, as is done for rte_mbuf_pool for example.
1068 * The *socket_id* argument is the socket identifier in the case of
1069 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1070 * constraint for the reserved zone.
1072 * Flags controlling the behavior of the mempool. See
1073 * rte_mempool_create() for details.
1075 * The pointer to the new allocated mempool, on success. NULL on error
1076 * with rte_errno set appropriately. See rte_mempool_create() for details.
1078 struct rte_mempool *
1079 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1080 unsigned cache_size, unsigned private_data_size,
1081 int socket_id, unsigned flags);
1085 * Unlink the mempool from global list, free the memory chunks, and all
1086 * memory referenced by the mempool. The objects must not be used by
1087 * other cores as they will be freed.
1090 * A pointer to the mempool structure.
1093 rte_mempool_free(struct rte_mempool *mp);
1096 * Add physically contiguous memory for objects in the pool at init
1098 * Add a virtually and physically contiguous memory chunk in the pool
1099 * where objects can be instantiated.
1101 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1102 * the chunk doesn't need to be physically contiguous (only virtually),
1103 * and allocated objects may span two pages.
1106 * A pointer to the mempool structure.
1108 * The virtual address of memory that should be used to store objects.
1112 * The length of memory in bytes.
1114 * The callback used to free this chunk when destroying the mempool.
1116 * An opaque argument passed to free_cb.
1118 * The number of objects added on success.
1119 * On error, the chunk is not added in the memory list of the
1120 * mempool and a negative errno is returned.
1122 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1123 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1127 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
1128 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1133 * Add physical memory for objects in the pool at init
1135 * Add a virtually contiguous memory chunk in the pool where objects can
1136 * be instantiated. The IO addresses corresponding to the virtual
1137 * area are described in iova[], pg_num, pg_shift.
1140 * A pointer to the mempool structure.
1142 * The virtual address of memory that should be used to store objects.
1144 * An array of IO addresses of each page composing the virtual area.
1146 * Number of elements in the iova array.
1148 * LOG2 of the physical pages size.
1150 * The callback used to free this chunk when destroying the mempool.
1152 * An opaque argument passed to free_cb.
1154 * The number of objects added on success.
1155 * On error, the chunks are not added in the memory list of the
1156 * mempool and a negative errno is returned.
1159 int rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
1160 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
1161 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1164 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
1165 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
1166 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1169 * Add virtually contiguous memory for objects in the pool at init
1171 * Add a virtually contiguous memory chunk in the pool where objects can
1175 * A pointer to the mempool structure.
1177 * The virtual address of memory that should be used to store objects.
1178 * Must be page-aligned.
1180 * The length of memory in bytes. Must be page-aligned.
1182 * The size of memory pages in this virtual area.
1184 * The callback used to free this chunk when destroying the mempool.
1186 * An opaque argument passed to free_cb.
1188 * The number of objects added on success.
1189 * On error, the chunk is not added in the memory list of the
1190 * mempool and a negative errno is returned.
1193 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1194 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1198 * Add memory for objects in the pool at init
1200 * This is the default function used by rte_mempool_create() to populate
1201 * the mempool. It adds memory allocated using rte_memzone_reserve().
1204 * A pointer to the mempool structure.
1206 * The number of objects added on success.
1207 * On error, the chunk is not added in the memory list of the
1208 * mempool and a negative errno is returned.
1210 int rte_mempool_populate_default(struct rte_mempool *mp);
1213 * Add memory from anonymous mapping for objects in the pool at init
1215 * This function mmap an anonymous memory zone that is locked in
1216 * memory to store the objects of the mempool.
1219 * A pointer to the mempool structure.
1221 * The number of objects added on success.
1222 * On error, the chunk is not added in the memory list of the
1223 * mempool and a negative errno is returned.
1225 int rte_mempool_populate_anon(struct rte_mempool *mp);
1228 * Call a function for each mempool element
1230 * Iterate across all objects attached to a rte_mempool and call the
1231 * callback function on it.
1234 * A pointer to an initialized mempool.
1236 * A function pointer that is called for each object.
1238 * An opaque pointer passed to the callback function.
1240 * Number of objects iterated.
1242 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1243 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1246 * Call a function for each mempool memory chunk
1248 * Iterate across all memory chunks attached to a rte_mempool and call
1249 * the callback function on it.
1252 * A pointer to an initialized mempool.
1254 * A function pointer that is called for each memory chunk.
1256 * An opaque pointer passed to the callback function.
1258 * Number of memory chunks iterated.
1260 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1261 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1264 * Dump the status of the mempool to a file.
1267 * A pointer to a file for output
1269 * A pointer to the mempool structure.
1271 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1274 * Create a user-owned mempool cache.
1276 * This can be used by non-EAL threads to enable caching when they
1277 * interact with a mempool.
1280 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1281 * parameter description for more information. The same limits and
1282 * considerations apply here too.
1284 * The socket identifier in the case of NUMA. The value can be
1285 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1287 struct rte_mempool_cache *
1288 rte_mempool_cache_create(uint32_t size, int socket_id);
1291 * Free a user-owned mempool cache.
1294 * A pointer to the mempool cache.
1297 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1300 * Get a pointer to the per-lcore default mempool cache.
1303 * A pointer to the mempool structure.
1305 * The logical core id.
1307 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1309 static __rte_always_inline struct rte_mempool_cache *
1310 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1312 if (mp->cache_size == 0)
1315 if (lcore_id >= RTE_MAX_LCORE)
1318 return &mp->local_cache[lcore_id];
1322 * Flush a user-owned mempool cache to the specified mempool.
1325 * A pointer to the mempool cache.
1327 * A pointer to the mempool.
1329 static __rte_always_inline void
1330 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1331 struct rte_mempool *mp)
1334 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1335 if (cache == NULL || cache->len == 0)
1337 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1342 * @internal Put several objects back in the mempool; used internally.
1344 * A pointer to the mempool structure.
1346 * A pointer to a table of void * pointers (objects).
1348 * The number of objects to store back in the mempool, must be strictly
1351 * A pointer to a mempool cache structure. May be NULL if not needed.
1353 static __rte_always_inline void
1354 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1355 unsigned int n, struct rte_mempool_cache *cache)
1359 /* increment stat now, adding in mempool always success */
1360 __MEMPOOL_STAT_ADD(mp, put, n);
1362 /* No cache provided or if put would overflow mem allocated for cache */
1363 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1366 cache_objs = &cache->objs[cache->len];
1369 * The cache follows the following algorithm
1370 * 1. Add the objects to the cache
1371 * 2. Anything greater than the cache min value (if it crosses the
1372 * cache flush threshold) is flushed to the ring.
1375 /* Add elements back into the cache */
1376 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1380 if (cache->len >= cache->flushthresh) {
1381 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1382 cache->len - cache->size);
1383 cache->len = cache->size;
1390 /* push remaining objects in ring */
1391 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1392 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1393 rte_panic("cannot put objects in mempool\n");
1395 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1401 * Put several objects back in the mempool.
1404 * A pointer to the mempool structure.
1406 * A pointer to a table of void * pointers (objects).
1408 * The number of objects to add in the mempool from the obj_table.
1410 * A pointer to a mempool cache structure. May be NULL if not needed.
1412 static __rte_always_inline void
1413 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1414 unsigned int n, struct rte_mempool_cache *cache)
1416 __mempool_check_cookies(mp, obj_table, n, 0);
1417 __mempool_generic_put(mp, obj_table, n, cache);
1421 * Put several objects back in the mempool.
1423 * This function calls the multi-producer or the single-producer
1424 * version depending on the default behavior that was specified at
1425 * mempool creation time (see flags).
1428 * A pointer to the mempool structure.
1430 * A pointer to a table of void * pointers (objects).
1432 * The number of objects to add in the mempool from obj_table.
1434 static __rte_always_inline void
1435 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1438 struct rte_mempool_cache *cache;
1439 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1440 rte_mempool_generic_put(mp, obj_table, n, cache);
1444 * Put one object back in the mempool.
1446 * This function calls the multi-producer or the single-producer
1447 * version depending on the default behavior that was specified at
1448 * mempool creation time (see flags).
1451 * A pointer to the mempool structure.
1453 * A pointer to the object to be added.
1455 static __rte_always_inline void
1456 rte_mempool_put(struct rte_mempool *mp, void *obj)
1458 rte_mempool_put_bulk(mp, &obj, 1);
1462 * @internal Get several objects from the mempool; used internally.
1464 * A pointer to the mempool structure.
1466 * A pointer to a table of void * pointers (objects).
1468 * The number of objects to get, must be strictly positive.
1470 * A pointer to a mempool cache structure. May be NULL if not needed.
1472 * - >=0: Success; number of objects supplied.
1473 * - <0: Error; code of ring dequeue function.
1475 static __rte_always_inline int
1476 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1477 unsigned int n, struct rte_mempool_cache *cache)
1480 uint32_t index, len;
1483 /* No cache provided or cannot be satisfied from cache */
1484 if (unlikely(cache == NULL || n >= cache->size))
1487 cache_objs = cache->objs;
1489 /* Can this be satisfied from the cache? */
1490 if (cache->len < n) {
1491 /* No. Backfill the cache first, and then fill from it */
1492 uint32_t req = n + (cache->size - cache->len);
1494 /* How many do we require i.e. number to fill the cache + the request */
1495 ret = rte_mempool_ops_dequeue_bulk(mp,
1496 &cache->objs[cache->len], req);
1497 if (unlikely(ret < 0)) {
1499 * In the offchance that we are buffer constrained,
1500 * where we are not able to allocate cache + n, go to
1501 * the ring directly. If that fails, we are truly out of
1510 /* Now fill in the response ... */
1511 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1512 *obj_table = cache_objs[len];
1516 __MEMPOOL_STAT_ADD(mp, get_success, n);
1522 /* get remaining objects from ring */
1523 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1526 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1528 __MEMPOOL_STAT_ADD(mp, get_success, n);
1534 * Get several objects from the mempool.
1536 * If cache is enabled, objects will be retrieved first from cache,
1537 * subsequently from the common pool. Note that it can return -ENOENT when
1538 * the local cache and common pool are empty, even if cache from other
1542 * A pointer to the mempool structure.
1544 * A pointer to a table of void * pointers (objects) that will be filled.
1546 * The number of objects to get from mempool to obj_table.
1548 * A pointer to a mempool cache structure. May be NULL if not needed.
1550 * - 0: Success; objects taken.
1551 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1553 static __rte_always_inline int
1554 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1555 unsigned int n, struct rte_mempool_cache *cache)
1558 ret = __mempool_generic_get(mp, obj_table, n, cache);
1560 __mempool_check_cookies(mp, obj_table, n, 1);
1565 * Get several objects from the mempool.
1567 * This function calls the multi-consumers or the single-consumer
1568 * version, depending on the default behaviour that was specified at
1569 * mempool creation time (see flags).
1571 * If cache is enabled, objects will be retrieved first from cache,
1572 * subsequently from the common pool. Note that it can return -ENOENT when
1573 * the local cache and common pool are empty, even if cache from other
1577 * A pointer to the mempool structure.
1579 * A pointer to a table of void * pointers (objects) that will be filled.
1581 * The number of objects to get from the mempool to obj_table.
1583 * - 0: Success; objects taken
1584 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1586 static __rte_always_inline int
1587 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1589 struct rte_mempool_cache *cache;
1590 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1591 return rte_mempool_generic_get(mp, obj_table, n, cache);
1595 * Get one object from the mempool.
1597 * This function calls the multi-consumers or the single-consumer
1598 * version, depending on the default behavior that was specified at
1599 * mempool creation (see flags).
1601 * If cache is enabled, objects will be retrieved first from cache,
1602 * subsequently from the common pool. Note that it can return -ENOENT when
1603 * the local cache and common pool are empty, even if cache from other
1607 * A pointer to the mempool structure.
1609 * A pointer to a void * pointer (object) that will be filled.
1611 * - 0: Success; objects taken.
1612 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1614 static __rte_always_inline int
1615 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1617 return rte_mempool_get_bulk(mp, obj_p, 1);
1622 * @b EXPERIMENTAL: this API may change without prior notice.
1624 * Get a contiguous blocks of objects from the mempool.
1626 * If cache is enabled, consider to flush it first, to reuse objects
1627 * as soon as possible.
1629 * The application should check that the driver supports the operation
1630 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1634 * A pointer to the mempool structure.
1635 * @param first_obj_table
1636 * A pointer to a pointer to the first object in each block.
1638 * The number of blocks to get from mempool.
1640 * - 0: Success; blocks taken.
1641 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1642 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1644 static __rte_always_inline int
1646 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1647 void **first_obj_table, unsigned int n)
1651 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1653 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_success, n);
1654 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1657 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_fail, n);
1664 * Return the number of entries in the mempool.
1666 * When cache is enabled, this function has to browse the length of
1667 * all lcores, so it should not be used in a data path, but only for
1668 * debug purposes. User-owned mempool caches are not accounted for.
1671 * A pointer to the mempool structure.
1673 * The number of entries in the mempool.
1675 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1678 * Return the number of elements which have been allocated from the mempool
1680 * When cache is enabled, this function has to browse the length of
1681 * all lcores, so it should not be used in a data path, but only for
1685 * A pointer to the mempool structure.
1687 * The number of free entries in the mempool.
1690 rte_mempool_in_use_count(const struct rte_mempool *mp);
1693 * Test if the mempool is full.
1695 * When cache is enabled, this function has to browse the length of all
1696 * lcores, so it should not be used in a data path, but only for debug
1697 * purposes. User-owned mempool caches are not accounted for.
1700 * A pointer to the mempool structure.
1702 * - 1: The mempool is full.
1703 * - 0: The mempool is not full.
1706 rte_mempool_full(const struct rte_mempool *mp)
1708 return !!(rte_mempool_avail_count(mp) == mp->size);
1712 * Test if the mempool is empty.
1714 * When cache is enabled, this function has to browse the length of all
1715 * lcores, so it should not be used in a data path, but only for debug
1716 * purposes. User-owned mempool caches are not accounted for.
1719 * A pointer to the mempool structure.
1721 * - 1: The mempool is empty.
1722 * - 0: The mempool is not empty.
1725 rte_mempool_empty(const struct rte_mempool *mp)
1727 return !!(rte_mempool_avail_count(mp) == 0);
1731 * Return the IO address of elt, which is an element of the pool mp.
1734 * A pointer (virtual address) to the element of the pool.
1736 * The IO address of the elt element.
1737 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1738 * returned value is RTE_BAD_IOVA.
1740 static inline rte_iova_t
1741 rte_mempool_virt2iova(const void *elt)
1743 const struct rte_mempool_objhdr *hdr;
1744 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1750 static inline phys_addr_t
1751 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1753 return rte_mempool_virt2iova(elt);
1757 * Check the consistency of mempool objects.
1759 * Verify the coherency of fields in the mempool structure. Also check
1760 * that the cookies of mempool objects (even the ones that are not
1761 * present in pool) have a correct value. If not, a panic will occur.
1764 * A pointer to the mempool structure.
1766 void rte_mempool_audit(struct rte_mempool *mp);
1769 * Return a pointer to the private data in an mempool structure.
1772 * A pointer to the mempool structure.
1774 * A pointer to the private data.
1776 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1779 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1783 * Dump the status of all mempools on the console
1786 * A pointer to a file for output
1788 void rte_mempool_list_dump(FILE *f);
1791 * Search a mempool from its name
1794 * The name of the mempool.
1796 * The pointer to the mempool matching the name, or NULL if not found.
1798 * with rte_errno set appropriately. Possible rte_errno values include:
1799 * - ENOENT - required entry not available to return.
1802 struct rte_mempool *rte_mempool_lookup(const char *name);
1805 * Get the header, trailer and total size of a mempool element.
1807 * Given a desired size of the mempool element and mempool flags,
1808 * calculates header, trailer, body and total sizes of the mempool object.
1811 * The size of each element, without header and trailer.
1813 * The flags used for the mempool creation.
1814 * Consult rte_mempool_create() for more information about possible values.
1815 * The size of each element.
1817 * The calculated detailed size the mempool object. May be NULL.
1819 * Total size of the mempool object.
1821 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1822 struct rte_mempool_objsz *sz);
1826 * Get the size of memory required to store mempool elements.
1828 * Calculate the maximum amount of memory required to store given number
1829 * of objects. Assume that the memory buffer will be aligned at page
1832 * Note that if object size is bigger than page size, then it assumes
1833 * that pages are grouped in subsets of physically continuous pages big
1834 * enough to store at least one object.
1837 * Number of elements.
1838 * @param total_elt_sz
1839 * The size of each element, including header and trailer, as returned
1840 * by rte_mempool_calc_obj_size().
1842 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1844 * The mempool flags.
1846 * Required memory size aligned at page boundary.
1849 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1850 uint32_t pg_shift, unsigned int flags);
1854 * Get the size of memory required to store mempool elements.
1856 * Calculate how much memory would be actually required with the given
1857 * memory footprint to store required number of objects.
1860 * Virtual address of the externally allocated memory buffer.
1861 * Will be used to store mempool objects.
1863 * Number of elements.
1864 * @param total_elt_sz
1865 * The size of each element, including header and trailer, as returned
1866 * by rte_mempool_calc_obj_size().
1868 * Array of IO addresses of the pages that comprises given memory buffer.
1870 * Number of elements in the iova array.
1872 * LOG2 of the physical pages size.
1874 * The mempool flags.
1876 * On success, the number of bytes needed to store given number of
1877 * objects, aligned to the given page size. If the provided memory
1878 * buffer is too small, return a negative value whose absolute value
1879 * is the actual number of elements that can be stored in that buffer.
1882 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1883 size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
1884 uint32_t pg_shift, unsigned int flags);
1887 * Walk list of all memory pools
1892 * Argument passed to iterator
1894 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1901 #endif /* _RTE_MEMPOOL_H_ */