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 contiguous 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.
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);
469 * @b EXPERIMENTAL: this API may change without prior notice.
471 * @internal Helper to calculate memory size required to store given
474 * This function is internal to mempool library and mempool drivers.
476 * If page boundaries may be ignored, it is just a product of total
477 * object size including header and trailer and number of objects.
478 * Otherwise, it is a number of pages required to store given number of
479 * objects without crossing page boundary.
481 * Note that if object size is bigger than page size, then it assumes
482 * that pages are grouped in subsets of physically continuous pages big
483 * enough to store at least one object.
485 * Minimum size of memory chunk is the total element size.
486 * Required memory chunk alignment is the cache line size.
489 * A pointer to the mempool structure.
491 * Number of objects to be added in mempool.
492 * @param[in] pg_shift
493 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
494 * @param[in] chunk_reserve
495 * Amount of memory that must be reserved at the beginning of each page,
496 * or at the beginning of the memory area if pg_shift is 0.
497 * @param[out] min_chunk_size
498 * Location for minimum size of the memory chunk which may be used to
499 * store memory pool objects.
501 * Location for required memory chunk alignment.
503 * Required memory size.
506 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
507 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
508 size_t *min_chunk_size, size_t *align);
511 * Default way to calculate memory size required to store given number of
514 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
515 * 0, min_chunk_size, align).
517 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
518 uint32_t obj_num, uint32_t pg_shift,
519 size_t *min_chunk_size, size_t *align);
522 * Function to be called for each populated object.
525 * A pointer to the mempool structure.
527 * An opaque pointer passed to iterator.
529 * Object virtual address.
531 * Input/output virtual address of the object or RTE_BAD_IOVA.
533 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
534 void *opaque, void *vaddr, rte_iova_t iova);
537 * Populate memory pool objects using provided memory chunk.
539 * Populated objects should be enqueued to the pool, e.g. using
540 * rte_mempool_ops_enqueue_bulk().
542 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
543 * the chunk doesn't need to be physically contiguous (only virtually),
544 * and allocated objects may span two pages.
547 * A pointer to the mempool structure.
548 * @param[in] max_objs
549 * Maximum number of objects to be populated.
551 * The virtual address of memory that should be used to store objects.
555 * The length of memory in bytes.
557 * Callback function to be executed for each populated object.
558 * @param[in] obj_cb_arg
559 * An opaque pointer passed to the callback function.
561 * The number of objects added on success.
562 * On error, no objects are populated and a negative errno is returned.
564 typedef int (*rte_mempool_populate_t)(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);
570 * Align objects on addresses multiple of total_elt_sz.
572 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
576 * @b EXPERIMENTAL: this API may change without prior notice.
578 * @internal Helper to populate memory pool object using provided memory
579 * chunk: just slice objects one by one, taking care of not
580 * crossing page boundaries.
582 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
583 * of object headers will be aligned on a multiple of total_elt_sz.
584 * This feature is used by octeontx hardware.
586 * This function is internal to mempool library and mempool drivers.
589 * A pointer to the mempool structure.
591 * Logical OR of following flags:
592 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
593 * multiple of total_elt_sz.
594 * @param[in] max_objs
595 * Maximum number of objects to be added in mempool.
597 * The virtual address of memory that should be used to store objects.
599 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
601 * The length of memory in bytes.
603 * Callback function to be executed for each populated object.
604 * @param[in] obj_cb_arg
605 * An opaque pointer passed to the callback function.
607 * The number of objects added in mempool.
610 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
611 unsigned int flags, unsigned int max_objs,
612 void *vaddr, rte_iova_t iova, size_t len,
613 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
616 * Default way to populate memory pool object using provided memory chunk.
618 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
619 * len, obj_cb, obj_cb_arg).
621 int rte_mempool_op_populate_default(struct rte_mempool *mp,
622 unsigned int max_objs,
623 void *vaddr, rte_iova_t iova, size_t len,
624 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
628 * @b EXPERIMENTAL: this API may change without prior notice.
630 * Get some additional information about a mempool.
632 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
633 struct rte_mempool_info *info);
636 /** Structure defining mempool operations structure */
637 struct rte_mempool_ops {
638 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
639 rte_mempool_alloc_t alloc; /**< Allocate private data. */
640 rte_mempool_free_t free; /**< Free the external pool. */
641 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
642 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
643 rte_mempool_get_count get_count; /**< Get qty of available objs. */
645 * Optional callback to calculate memory size required to
646 * store specified number of objects.
648 rte_mempool_calc_mem_size_t calc_mem_size;
650 * Optional callback to populate mempool objects using
651 * provided memory chunk.
653 rte_mempool_populate_t populate;
657 rte_mempool_get_info_t get_info;
659 * Dequeue a number of contiguous object blocks.
661 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
662 } __rte_cache_aligned;
664 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
667 * Structure storing the table of registered ops structs, each of which contain
668 * the function pointers for the mempool ops functions.
669 * Each process has its own storage for this ops struct array so that
670 * the mempools can be shared across primary and secondary processes.
671 * The indices used to access the array are valid across processes, whereas
672 * any function pointers stored directly in the mempool struct would not be.
673 * This results in us simply having "ops_index" in the mempool struct.
675 struct rte_mempool_ops_table {
676 rte_spinlock_t sl; /**< Spinlock for add/delete. */
677 uint32_t num_ops; /**< Number of used ops structs in the table. */
679 * Storage for all possible ops structs.
681 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
682 } __rte_cache_aligned;
684 /** Array of registered ops structs. */
685 extern struct rte_mempool_ops_table rte_mempool_ops_table;
688 * @internal Get the mempool ops struct from its index.
691 * The index of the ops struct in the ops struct table. It must be a valid
692 * index: (0 <= idx < num_ops).
694 * The pointer to the ops struct in the table.
696 static inline struct rte_mempool_ops *
697 rte_mempool_get_ops(int ops_index)
699 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
701 return &rte_mempool_ops_table.ops[ops_index];
705 * @internal Wrapper for mempool_ops alloc callback.
708 * Pointer to the memory pool.
710 * - 0: Success; successfully allocated mempool pool_data.
711 * - <0: Error; code of alloc function.
714 rte_mempool_ops_alloc(struct rte_mempool *mp);
717 * @internal Wrapper for mempool_ops dequeue callback.
720 * Pointer to the memory pool.
722 * Pointer to a table of void * pointers (objects).
724 * Number of objects to get.
726 * - 0: Success; got n objects.
727 * - <0: Error; code of dequeue function.
730 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
731 void **obj_table, unsigned n)
733 struct rte_mempool_ops *ops;
735 ops = rte_mempool_get_ops(mp->ops_index);
736 return ops->dequeue(mp, obj_table, n);
740 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
743 * Pointer to the memory pool.
744 * @param[out] first_obj_table
745 * Pointer to a table of void * pointers (first objects).
747 * Number of blocks to get.
749 * - 0: Success; got n objects.
750 * - <0: Error; code of dequeue function.
753 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
754 void **first_obj_table, unsigned int n)
756 struct rte_mempool_ops *ops;
758 ops = rte_mempool_get_ops(mp->ops_index);
759 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
760 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
764 * @internal wrapper for mempool_ops enqueue callback.
767 * Pointer to the memory pool.
769 * Pointer to a table of void * pointers (objects).
771 * Number of objects to put.
773 * - 0: Success; n objects supplied.
774 * - <0: Error; code of enqueue function.
777 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
780 struct rte_mempool_ops *ops;
782 ops = rte_mempool_get_ops(mp->ops_index);
783 return ops->enqueue(mp, obj_table, n);
787 * @internal wrapper for mempool_ops get_count callback.
790 * Pointer to the memory pool.
792 * The number of available objects in the external pool.
795 rte_mempool_ops_get_count(const struct rte_mempool *mp);
798 * @internal wrapper for mempool_ops calc_mem_size callback.
799 * API to calculate size of memory required to store specified number of
803 * Pointer to the memory pool.
806 * @param[in] pg_shift
807 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
808 * @param[out] min_chunk_size
809 * Location for minimum size of the memory chunk which may be used to
810 * store memory pool objects.
812 * Location for required memory chunk alignment.
814 * Required memory size aligned at page boundary.
816 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
817 uint32_t obj_num, uint32_t pg_shift,
818 size_t *min_chunk_size, size_t *align);
821 * @internal wrapper for mempool_ops populate callback.
823 * Populate memory pool objects using provided memory chunk.
826 * A pointer to the mempool structure.
827 * @param[in] max_objs
828 * Maximum number of objects to be populated.
830 * The virtual address of memory that should be used to store objects.
834 * The length of memory in bytes.
836 * Callback function to be executed for each populated object.
837 * @param[in] obj_cb_arg
838 * An opaque pointer passed to the callback function.
840 * The number of objects added on success.
841 * On error, no objects are populated and a negative errno is returned.
843 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
844 void *vaddr, rte_iova_t iova, size_t len,
845 rte_mempool_populate_obj_cb_t *obj_cb,
850 * @b EXPERIMENTAL: this API may change without prior notice.
852 * Wrapper for mempool_ops get_info callback.
855 * Pointer to the memory pool.
857 * Pointer to the rte_mempool_info structure
859 * - 0: Success; The mempool driver supports retrieving supplementary
860 * mempool information
861 * - -ENOTSUP - doesn't support get_info ops (valid case).
864 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
865 struct rte_mempool_info *info);
868 * @internal wrapper for mempool_ops free callback.
871 * Pointer to the memory pool.
874 rte_mempool_ops_free(struct rte_mempool *mp);
877 * Set the ops of a mempool.
879 * This can only be done on a mempool that is not populated, i.e. just after
880 * a call to rte_mempool_create_empty().
883 * Pointer to the memory pool.
885 * Name of the ops structure to use for this mempool.
887 * Opaque data that can be passed by the application to the ops functions.
889 * - 0: Success; the mempool is now using the requested ops functions.
890 * - -EINVAL - Invalid ops struct name provided.
891 * - -EEXIST - mempool already has an ops struct assigned.
894 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
898 * Register mempool operations.
901 * Pointer to an ops structure to register.
903 * - >=0: Success; return the index of the ops struct in the table.
904 * - -EINVAL - some missing callbacks while registering ops struct.
905 * - -ENOSPC - the maximum number of ops structs has been reached.
907 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
910 * Macro to statically register the ops of a mempool handler.
911 * Note that the rte_mempool_register_ops fails silently here when
912 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
914 #define MEMPOOL_REGISTER_OPS(ops) \
915 RTE_INIT(mp_hdlr_init_##ops) \
917 rte_mempool_register_ops(&ops); \
921 * An object callback function for mempool.
923 * Used by rte_mempool_create() and rte_mempool_obj_iter().
925 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
926 void *opaque, void *obj, unsigned obj_idx);
927 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
930 * A memory callback function for mempool.
932 * Used by rte_mempool_mem_iter().
934 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
935 void *opaque, struct rte_mempool_memhdr *memhdr,
939 * A mempool constructor callback function.
941 * Arguments are the mempool and the opaque pointer given by the user in
942 * rte_mempool_create().
944 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
947 * Create a new mempool named *name* in memory.
949 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
950 * pool contains n elements of elt_size. Its size is set to n.
953 * The name of the mempool.
955 * The number of elements in the mempool. The optimum size (in terms of
956 * memory usage) for a mempool is when n is a power of two minus one:
959 * The size of each element.
961 * If cache_size is non-zero, the rte_mempool library will try to
962 * limit the accesses to the common lockless pool, by maintaining a
963 * per-lcore object cache. This argument must be lower or equal to
964 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
965 * cache_size to have "n modulo cache_size == 0": if this is
966 * not the case, some elements will always stay in the pool and will
967 * never be used. The access to the per-lcore table is of course
968 * faster than the multi-producer/consumer pool. The cache can be
969 * disabled if the cache_size argument is set to 0; it can be useful to
970 * avoid losing objects in cache.
971 * @param private_data_size
972 * The size of the private data appended after the mempool
973 * structure. This is useful for storing some private data after the
974 * mempool structure, as is done for rte_mbuf_pool for example.
976 * A function pointer that is called for initialization of the pool,
977 * before object initialization. The user can initialize the private
978 * data in this function if needed. This parameter can be NULL if
981 * An opaque pointer to data that can be used in the mempool
982 * constructor function.
984 * A function pointer that is called for each object at
985 * initialization of the pool. The user can set some meta data in
986 * objects if needed. This parameter can be NULL if not needed.
987 * The obj_init() function takes the mempool pointer, the init_arg,
988 * the object pointer and the object number as parameters.
989 * @param obj_init_arg
990 * An opaque pointer to data that can be used as an argument for
991 * each call to the object constructor function.
993 * The *socket_id* argument is the socket identifier in the case of
994 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
995 * constraint for the reserved zone.
997 * The *flags* arguments is an OR of following flags:
998 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
999 * between channels in RAM: the pool allocator will add padding
1000 * between objects depending on the hardware configuration. See
1001 * Memory alignment constraints for details. If this flag is set,
1002 * the allocator will just align them to a cache line.
1003 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
1004 * cache-aligned. This flag removes this constraint, and no
1005 * padding will be present between objects. This flag implies
1006 * MEMPOOL_F_NO_SPREAD.
1007 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
1008 * when using rte_mempool_put() or rte_mempool_put_bulk() is
1009 * "single-producer". Otherwise, it is "multi-producers".
1010 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
1011 * when using rte_mempool_get() or rte_mempool_get_bulk() is
1012 * "single-consumer". Otherwise, it is "multi-consumers".
1013 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
1014 * necessarily be contiguous in IO memory.
1016 * The pointer to the new allocated mempool, on success. NULL on error
1017 * with rte_errno set appropriately. Possible rte_errno values include:
1018 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1019 * - E_RTE_SECONDARY - function was called from a secondary process instance
1020 * - EINVAL - cache size provided is too large
1021 * - ENOSPC - the maximum number of memzones has already been allocated
1022 * - EEXIST - a memzone with the same name already exists
1023 * - ENOMEM - no appropriate memory area found in which to create memzone
1025 struct rte_mempool *
1026 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1027 unsigned cache_size, unsigned private_data_size,
1028 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1029 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1030 int socket_id, unsigned flags);
1033 * Create an empty mempool
1035 * The mempool is allocated and initialized, but it is not populated: no
1036 * memory is allocated for the mempool elements. The user has to call
1037 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1038 * populated, the user may also want to initialize each object with
1039 * rte_mempool_obj_iter().
1042 * The name of the mempool.
1044 * The maximum number of elements that can be added in the mempool.
1045 * The optimum size (in terms of memory usage) for a mempool is when n
1046 * is a power of two minus one: n = (2^q - 1).
1048 * The size of each element.
1050 * Size of the cache. See rte_mempool_create() for details.
1051 * @param private_data_size
1052 * The size of the private data appended after the mempool
1053 * structure. This is useful for storing some private data after the
1054 * mempool structure, as is done for rte_mbuf_pool for example.
1056 * The *socket_id* argument is the socket identifier in the case of
1057 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1058 * constraint for the reserved zone.
1060 * Flags controlling the behavior of the mempool. See
1061 * rte_mempool_create() for details.
1063 * The pointer to the new allocated mempool, on success. NULL on error
1064 * with rte_errno set appropriately. See rte_mempool_create() for details.
1066 struct rte_mempool *
1067 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1068 unsigned cache_size, unsigned private_data_size,
1069 int socket_id, unsigned flags);
1073 * Unlink the mempool from global list, free the memory chunks, and all
1074 * memory referenced by the mempool. The objects must not be used by
1075 * other cores as they will be freed.
1078 * A pointer to the mempool structure.
1081 rte_mempool_free(struct rte_mempool *mp);
1084 * Add physically contiguous memory for objects in the pool at init
1086 * Add a virtually and physically contiguous memory chunk in the pool
1087 * where objects can be instantiated.
1089 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1090 * the chunk doesn't need to be physically contiguous (only virtually),
1091 * and allocated objects may span two pages.
1094 * A pointer to the mempool structure.
1096 * The virtual address of memory that should be used to store objects.
1100 * The length of memory in bytes.
1102 * The callback used to free this chunk when destroying the mempool.
1104 * An opaque argument passed to free_cb.
1106 * The number of objects added on success.
1107 * On error, the chunk is not added in the memory list of the
1108 * mempool and a negative errno is returned.
1110 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1111 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1115 * Add virtually contiguous memory for objects in the pool at init
1117 * Add a virtually contiguous memory chunk in the pool where objects can
1121 * A pointer to the mempool structure.
1123 * The virtual address of memory that should be used to store objects.
1125 * The length of memory in bytes.
1127 * The size of memory pages in this virtual area.
1129 * The callback used to free this chunk when destroying the mempool.
1131 * An opaque argument passed to free_cb.
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.
1138 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1139 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1143 * Add memory for objects in the pool at init
1145 * This is the default function used by rte_mempool_create() to populate
1146 * the mempool. It adds memory allocated using rte_memzone_reserve().
1149 * A pointer to the mempool structure.
1151 * The number of objects added on success.
1152 * On error, the chunk is not added in the memory list of the
1153 * mempool and a negative errno is returned.
1155 int rte_mempool_populate_default(struct rte_mempool *mp);
1158 * Add memory from anonymous mapping for objects in the pool at init
1160 * This function mmap an anonymous memory zone that is locked in
1161 * memory to store the objects of the mempool.
1164 * A pointer to the mempool structure.
1166 * The number of objects added on success.
1167 * On error, the chunk is not added in the memory list of the
1168 * mempool and a negative errno is returned.
1170 int rte_mempool_populate_anon(struct rte_mempool *mp);
1173 * Call a function for each mempool element
1175 * Iterate across all objects attached to a rte_mempool and call the
1176 * callback function on it.
1179 * A pointer to an initialized mempool.
1181 * A function pointer that is called for each object.
1183 * An opaque pointer passed to the callback function.
1185 * Number of objects iterated.
1187 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1188 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1191 * Call a function for each mempool memory chunk
1193 * Iterate across all memory chunks attached to a rte_mempool and call
1194 * the callback function on it.
1197 * A pointer to an initialized mempool.
1199 * A function pointer that is called for each memory chunk.
1201 * An opaque pointer passed to the callback function.
1203 * Number of memory chunks iterated.
1205 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1206 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1209 * Dump the status of the mempool to a file.
1212 * A pointer to a file for output
1214 * A pointer to the mempool structure.
1216 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1219 * Create a user-owned mempool cache.
1221 * This can be used by non-EAL threads to enable caching when they
1222 * interact with a mempool.
1225 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1226 * parameter description for more information. The same limits and
1227 * considerations apply here too.
1229 * The socket identifier in the case of NUMA. The value can be
1230 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1232 struct rte_mempool_cache *
1233 rte_mempool_cache_create(uint32_t size, int socket_id);
1236 * Free a user-owned mempool cache.
1239 * A pointer to the mempool cache.
1242 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1245 * Get a pointer to the per-lcore default mempool cache.
1248 * A pointer to the mempool structure.
1250 * The logical core id.
1252 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1254 static __rte_always_inline struct rte_mempool_cache *
1255 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1257 if (mp->cache_size == 0)
1260 if (lcore_id >= RTE_MAX_LCORE)
1263 return &mp->local_cache[lcore_id];
1267 * Flush a user-owned mempool cache to the specified mempool.
1270 * A pointer to the mempool cache.
1272 * A pointer to the mempool.
1274 static __rte_always_inline void
1275 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1276 struct rte_mempool *mp)
1279 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1280 if (cache == NULL || cache->len == 0)
1282 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1287 * @internal Put several objects back in the mempool; used internally.
1289 * A pointer to the mempool structure.
1291 * A pointer to a table of void * pointers (objects).
1293 * The number of objects to store back in the mempool, must be strictly
1296 * A pointer to a mempool cache structure. May be NULL if not needed.
1298 static __rte_always_inline void
1299 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1300 unsigned int n, struct rte_mempool_cache *cache)
1304 /* increment stat now, adding in mempool always success */
1305 __MEMPOOL_STAT_ADD(mp, put, n);
1307 /* No cache provided or if put would overflow mem allocated for cache */
1308 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1311 cache_objs = &cache->objs[cache->len];
1314 * The cache follows the following algorithm
1315 * 1. Add the objects to the cache
1316 * 2. Anything greater than the cache min value (if it crosses the
1317 * cache flush threshold) is flushed to the ring.
1320 /* Add elements back into the cache */
1321 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1325 if (cache->len >= cache->flushthresh) {
1326 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1327 cache->len - cache->size);
1328 cache->len = cache->size;
1335 /* push remaining objects in ring */
1336 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1337 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1338 rte_panic("cannot put objects in mempool\n");
1340 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1346 * Put several objects back in the mempool.
1349 * A pointer to the mempool structure.
1351 * A pointer to a table of void * pointers (objects).
1353 * The number of objects to add in the mempool from the obj_table.
1355 * A pointer to a mempool cache structure. May be NULL if not needed.
1357 static __rte_always_inline void
1358 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1359 unsigned int n, struct rte_mempool_cache *cache)
1361 __mempool_check_cookies(mp, obj_table, n, 0);
1362 __mempool_generic_put(mp, obj_table, n, cache);
1366 * Put several objects back in the mempool.
1368 * This function calls the multi-producer or the single-producer
1369 * version depending on the default behavior that was specified at
1370 * mempool creation time (see flags).
1373 * A pointer to the mempool structure.
1375 * A pointer to a table of void * pointers (objects).
1377 * The number of objects to add in the mempool from obj_table.
1379 static __rte_always_inline void
1380 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1383 struct rte_mempool_cache *cache;
1384 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1385 rte_mempool_generic_put(mp, obj_table, n, cache);
1389 * Put one object back in the mempool.
1391 * This function calls the multi-producer or the single-producer
1392 * version depending on the default behavior that was specified at
1393 * mempool creation time (see flags).
1396 * A pointer to the mempool structure.
1398 * A pointer to the object to be added.
1400 static __rte_always_inline void
1401 rte_mempool_put(struct rte_mempool *mp, void *obj)
1403 rte_mempool_put_bulk(mp, &obj, 1);
1407 * @internal Get several objects from the mempool; used internally.
1409 * A pointer to the mempool structure.
1411 * A pointer to a table of void * pointers (objects).
1413 * The number of objects to get, must be strictly positive.
1415 * A pointer to a mempool cache structure. May be NULL if not needed.
1417 * - >=0: Success; number of objects supplied.
1418 * - <0: Error; code of ring dequeue function.
1420 static __rte_always_inline int
1421 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1422 unsigned int n, struct rte_mempool_cache *cache)
1425 uint32_t index, len;
1428 /* No cache provided or cannot be satisfied from cache */
1429 if (unlikely(cache == NULL || n >= cache->size))
1432 cache_objs = cache->objs;
1434 /* Can this be satisfied from the cache? */
1435 if (cache->len < n) {
1436 /* No. Backfill the cache first, and then fill from it */
1437 uint32_t req = n + (cache->size - cache->len);
1439 /* How many do we require i.e. number to fill the cache + the request */
1440 ret = rte_mempool_ops_dequeue_bulk(mp,
1441 &cache->objs[cache->len], req);
1442 if (unlikely(ret < 0)) {
1444 * In the off chance that we are buffer constrained,
1445 * where we are not able to allocate cache + n, go to
1446 * the ring directly. If that fails, we are truly out of
1455 /* Now fill in the response ... */
1456 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1457 *obj_table = cache_objs[len];
1461 __MEMPOOL_STAT_ADD(mp, get_success, n);
1467 /* get remaining objects from ring */
1468 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1471 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1473 __MEMPOOL_STAT_ADD(mp, get_success, n);
1479 * Get several objects from the mempool.
1481 * If cache is enabled, objects will be retrieved first from cache,
1482 * subsequently from the common pool. Note that it can return -ENOENT when
1483 * the local cache and common pool are empty, even if cache from other
1487 * A pointer to the mempool structure.
1489 * A pointer to a table of void * pointers (objects) that will be filled.
1491 * The number of objects to get from mempool to obj_table.
1493 * A pointer to a mempool cache structure. May be NULL if not needed.
1495 * - 0: Success; objects taken.
1496 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1498 static __rte_always_inline int
1499 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1500 unsigned int n, struct rte_mempool_cache *cache)
1503 ret = __mempool_generic_get(mp, obj_table, n, cache);
1505 __mempool_check_cookies(mp, obj_table, n, 1);
1510 * Get several objects from the mempool.
1512 * This function calls the multi-consumers or the single-consumer
1513 * version, depending on the default behaviour that was specified at
1514 * mempool creation time (see flags).
1516 * If cache is enabled, objects will be retrieved first from cache,
1517 * subsequently from the common pool. Note that it can return -ENOENT when
1518 * the local cache and common pool are empty, even if cache from other
1522 * A pointer to the mempool structure.
1524 * A pointer to a table of void * pointers (objects) that will be filled.
1526 * The number of objects to get from the mempool to obj_table.
1528 * - 0: Success; objects taken
1529 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1531 static __rte_always_inline int
1532 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1534 struct rte_mempool_cache *cache;
1535 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1536 return rte_mempool_generic_get(mp, obj_table, n, cache);
1540 * Get one object from the mempool.
1542 * This function calls the multi-consumers or the single-consumer
1543 * version, depending on the default behavior that was specified at
1544 * mempool creation (see flags).
1546 * If cache is enabled, objects will be retrieved first from cache,
1547 * subsequently from the common pool. Note that it can return -ENOENT when
1548 * the local cache and common pool are empty, even if cache from other
1552 * A pointer to the mempool structure.
1554 * A pointer to a void * pointer (object) that will be filled.
1556 * - 0: Success; objects taken.
1557 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1559 static __rte_always_inline int
1560 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1562 return rte_mempool_get_bulk(mp, obj_p, 1);
1567 * @b EXPERIMENTAL: this API may change without prior notice.
1569 * Get a contiguous blocks of objects from the mempool.
1571 * If cache is enabled, consider to flush it first, to reuse objects
1572 * as soon as possible.
1574 * The application should check that the driver supports the operation
1575 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1579 * A pointer to the mempool structure.
1580 * @param first_obj_table
1581 * A pointer to a pointer to the first object in each block.
1583 * The number of blocks to get from mempool.
1585 * - 0: Success; blocks taken.
1586 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1587 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1589 static __rte_always_inline int
1591 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1592 void **first_obj_table, unsigned int n)
1596 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1598 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_success, n);
1599 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1602 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_fail, n);
1609 * Return the number of entries in the mempool.
1611 * When cache is enabled, this function has to browse the length of
1612 * all lcores, so it should not be used in a data path, but only for
1613 * debug purposes. User-owned mempool caches are not accounted for.
1616 * A pointer to the mempool structure.
1618 * The number of entries in the mempool.
1620 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1623 * Return the number of elements which have been allocated from the mempool
1625 * When cache is enabled, this function has to browse the length of
1626 * all lcores, so it should not be used in a data path, but only for
1630 * A pointer to the mempool structure.
1632 * The number of free entries in the mempool.
1635 rte_mempool_in_use_count(const struct rte_mempool *mp);
1638 * Test if the mempool is full.
1640 * When cache is enabled, this function has to browse the length of all
1641 * lcores, so it should not be used in a data path, but only for debug
1642 * purposes. User-owned mempool caches are not accounted for.
1645 * A pointer to the mempool structure.
1647 * - 1: The mempool is full.
1648 * - 0: The mempool is not full.
1651 rte_mempool_full(const struct rte_mempool *mp)
1653 return !!(rte_mempool_avail_count(mp) == mp->size);
1657 * Test if the mempool is empty.
1659 * When cache is enabled, this function has to browse the length of all
1660 * lcores, so it should not be used in a data path, but only for debug
1661 * purposes. User-owned mempool caches are not accounted for.
1664 * A pointer to the mempool structure.
1666 * - 1: The mempool is empty.
1667 * - 0: The mempool is not empty.
1670 rte_mempool_empty(const struct rte_mempool *mp)
1672 return !!(rte_mempool_avail_count(mp) == 0);
1676 * Return the IO address of elt, which is an element of the pool mp.
1679 * A pointer (virtual address) to the element of the pool.
1681 * The IO address of the elt element.
1682 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1683 * returned value is RTE_BAD_IOVA.
1685 static inline rte_iova_t
1686 rte_mempool_virt2iova(const void *elt)
1688 const struct rte_mempool_objhdr *hdr;
1689 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1695 * Check the consistency of mempool objects.
1697 * Verify the coherency of fields in the mempool structure. Also check
1698 * that the cookies of mempool objects (even the ones that are not
1699 * present in pool) have a correct value. If not, a panic will occur.
1702 * A pointer to the mempool structure.
1704 void rte_mempool_audit(struct rte_mempool *mp);
1707 * Return a pointer to the private data in an mempool structure.
1710 * A pointer to the mempool structure.
1712 * A pointer to the private data.
1714 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1717 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1721 * Dump the status of all mempools on the console
1724 * A pointer to a file for output
1726 void rte_mempool_list_dump(FILE *f);
1729 * Search a mempool from its name
1732 * The name of the mempool.
1734 * The pointer to the mempool matching the name, or NULL if not found.
1736 * with rte_errno set appropriately. Possible rte_errno values include:
1737 * - ENOENT - required entry not available to return.
1740 struct rte_mempool *rte_mempool_lookup(const char *name);
1743 * Get the header, trailer and total size of a mempool element.
1745 * Given a desired size of the mempool element and mempool flags,
1746 * calculates header, trailer, body and total sizes of the mempool object.
1749 * The size of each element, without header and trailer.
1751 * The flags used for the mempool creation.
1752 * Consult rte_mempool_create() for more information about possible values.
1753 * The size of each element.
1755 * The calculated detailed size the mempool object. May be NULL.
1757 * Total size of the mempool object.
1759 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1760 struct rte_mempool_objsz *sz);
1763 * Walk list of all memory pools
1768 * Argument passed to iterator
1770 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1775 * @b EXPERIMENTAL: this API may change without prior notice.
1777 * @internal Get page size used for mempool object allocation.
1778 * This function is internal to mempool library and mempool drivers.
1782 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1788 #endif /* _RTE_MEMPOOL_H_ */