1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright(c) 2016 6WIND S.A.
6 #ifndef _RTE_MEMPOOL_H_
7 #define _RTE_MEMPOOL_H_
13 * A memory pool is an allocator of fixed-size object. It is
14 * identified by its name, and uses a ring to store free objects. It
15 * provides some other optional services, like a per-core object
16 * cache, and an alignment helper to ensure that objects are padded
17 * to spread them equally on all RAM channels, ranks, and so on.
19 * Objects owned by a mempool should never be added in another
20 * mempool. When an object is freed using rte_mempool_put() or
21 * equivalent, the object data is not modified; the user can save some
22 * meta-data in the object data and retrieve them when allocating a
25 * Note: the mempool implementation is not preemptible. An lcore must not be
26 * interrupted by another task that uses the same mempool (because it uses a
27 * ring which is not preemptible). Also, usual mempool functions like
28 * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
29 * thread due to the internal per-lcore cache. Due to the lack of caching,
30 * rte_mempool_get() or rte_mempool_put() performance will suffer when called
31 * by unregistered non-EAL threads. Instead, unregistered non-EAL threads
32 * should call rte_mempool_generic_get() or rte_mempool_generic_put() with a
33 * user cache created with rte_mempool_cache_create().
42 #include <rte_config.h>
43 #include <rte_spinlock.h>
45 #include <rte_debug.h>
46 #include <rte_lcore.h>
47 #include <rte_memory.h>
48 #include <rte_branch_prediction.h>
50 #include <rte_memcpy.h>
51 #include <rte_common.h>
53 #include "rte_mempool_trace_fp.h"
59 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
60 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
61 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
63 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
65 * A structure that stores the mempool statistics (per-lcore).
66 * Note: Cache stats (put_cache_bulk/objs, get_cache_bulk/objs) are not
67 * captured since they can be calculated from other stats.
68 * For example: put_cache_objs = put_objs - put_common_pool_objs.
70 struct rte_mempool_debug_stats {
71 uint64_t put_bulk; /**< Number of puts. */
72 uint64_t put_objs; /**< Number of objects successfully put. */
73 uint64_t put_common_pool_bulk; /**< Number of bulks enqueued in common pool. */
74 uint64_t put_common_pool_objs; /**< Number of objects enqueued in common pool. */
75 uint64_t get_common_pool_bulk; /**< Number of bulks dequeued from common pool. */
76 uint64_t get_common_pool_objs; /**< Number of objects dequeued from common pool. */
77 uint64_t get_success_bulk; /**< Successful allocation number. */
78 uint64_t get_success_objs; /**< Objects successfully allocated. */
79 uint64_t get_fail_bulk; /**< Failed allocation number. */
80 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
81 uint64_t get_success_blks; /**< Successful allocation number of contiguous blocks. */
82 uint64_t get_fail_blks; /**< Failed allocation number of contiguous blocks. */
83 } __rte_cache_aligned;
87 * A structure that stores a per-core object cache.
89 struct rte_mempool_cache {
90 uint32_t size; /**< Size of the cache */
91 uint32_t flushthresh; /**< Threshold before we flush excess elements */
92 uint32_t len; /**< Current cache count */
94 * Cache is allocated to this size to allow it to overflow in certain
95 * cases to avoid needless emptying of cache.
97 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
98 } __rte_cache_aligned;
101 * A structure that stores the size of mempool elements.
103 struct rte_mempool_objsz {
104 uint32_t elt_size; /**< Size of an element. */
105 uint32_t header_size; /**< Size of header (before elt). */
106 uint32_t trailer_size; /**< Size of trailer (after elt). */
108 /**< Total size of an object (header + elt + trailer). */
111 /**< Maximum length of a memory pool's name. */
112 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
113 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
114 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
117 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
119 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
121 /** Mempool over one chunk of physically continuous memory */
122 #define MEMPOOL_PG_NUM_DEFAULT 1
124 #ifndef RTE_MEMPOOL_ALIGN
126 * Alignment of elements inside mempool.
128 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
131 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
134 * Mempool object header structure
136 * Each object stored in mempools are prefixed by this header structure,
137 * it allows to retrieve the mempool pointer from the object and to
138 * iterate on all objects attached to a mempool. When debug is enabled,
139 * a cookie is also added in this structure preventing corruptions and
142 struct rte_mempool_objhdr {
143 RTE_STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
144 struct rte_mempool *mp; /**< The mempool owning the object. */
145 rte_iova_t iova; /**< IO address of the object. */
146 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
147 uint64_t cookie; /**< Debug cookie. */
152 * A list of object headers type
154 RTE_STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
156 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
159 * Mempool object trailer structure
161 * In debug mode, each object stored in mempools are suffixed by this
162 * trailer structure containing a cookie preventing memory corruptions.
164 struct rte_mempool_objtlr {
165 uint64_t cookie; /**< Debug cookie. */
171 * A list of memory where objects are stored
173 RTE_STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
176 * Callback used to free a memory chunk
178 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
182 * Mempool objects memory header structure
184 * The memory chunks where objects are stored. Each chunk is virtually
185 * and physically contiguous.
187 struct rte_mempool_memhdr {
188 RTE_STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
189 struct rte_mempool *mp; /**< The mempool owning the chunk */
190 void *addr; /**< Virtual address of the chunk */
191 rte_iova_t iova; /**< IO address of the chunk */
192 size_t len; /**< length of the chunk */
193 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
194 void *opaque; /**< Argument passed to the free callback */
198 * Additional information about the mempool
200 * The structure is cache-line aligned to avoid ABI breakages in
201 * a number of cases when something small is added.
203 struct rte_mempool_info {
204 /** Number of objects in the contiguous block */
205 unsigned int contig_block_size;
206 } __rte_cache_aligned;
209 * The RTE mempool structure.
212 char name[RTE_MEMPOOL_NAMESIZE]; /**< Name of mempool. */
215 void *pool_data; /**< Ring or pool to store objects. */
216 uint64_t pool_id; /**< External mempool identifier. */
218 void *pool_config; /**< optional args for ops alloc. */
219 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
220 unsigned int flags; /**< Flags of the mempool. */
221 int socket_id; /**< Socket id passed at create. */
222 uint32_t size; /**< Max size of the mempool. */
224 /**< Size of per-lcore default local cache. */
226 uint32_t elt_size; /**< Size of an element. */
227 uint32_t header_size; /**< Size of header (before elt). */
228 uint32_t trailer_size; /**< Size of trailer (after elt). */
230 unsigned private_data_size; /**< Size of private data. */
232 * Index into rte_mempool_ops_table array of mempool ops
233 * structs, which contain callback function pointers.
234 * We're using an index here rather than pointers to the callbacks
235 * to facilitate any secondary processes that may want to use
240 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
242 uint32_t populated_size; /**< Number of populated objects. */
243 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
244 uint32_t nb_mem_chunks; /**< Number of memory chunks */
245 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
247 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
248 /** Per-lcore statistics. */
249 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
251 } __rte_cache_aligned;
253 #define MEMPOOL_F_NO_SPREAD 0x0001
254 /**< Spreading among memory channels not required. */
255 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
256 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
257 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
258 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
259 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
262 * @internal When debug is enabled, store some statistics.
265 * Pointer to the memory pool.
267 * Name of the statistics field to increment in the memory pool.
269 * Number to add to the object-oriented statistics.
271 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
272 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
273 unsigned __lcore_id = rte_lcore_id(); \
274 if (__lcore_id < RTE_MAX_LCORE) { \
275 mp->stats[__lcore_id].name += n; \
279 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
283 * Calculate the size of the mempool header.
286 * Pointer to the memory pool.
288 * Size of the per-lcore cache.
290 #define MEMPOOL_HEADER_SIZE(mp, cs) \
291 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
292 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
294 /* return the header of a mempool object (internal) */
295 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
297 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
298 sizeof(struct rte_mempool_objhdr));
302 * Return a pointer to the mempool owning this object.
305 * An object that is owned by a pool. If this is not the case,
306 * the behavior is undefined.
308 * A pointer to the mempool structure.
310 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
312 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
316 /* return the trailer of a mempool object (internal) */
317 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
319 struct rte_mempool *mp = rte_mempool_from_obj(obj);
320 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
324 * @internal Check and update cookies or panic.
327 * Pointer to the memory pool.
328 * @param obj_table_const
329 * Pointer to a table of void * pointers (objects).
331 * Index of object in object table.
333 * - 0: object is supposed to be allocated, mark it as free
334 * - 1: object is supposed to be free, mark it as allocated
335 * - 2: just check that cookie is valid (free or allocated)
337 void rte_mempool_check_cookies(const struct rte_mempool *mp,
338 void * const *obj_table_const, unsigned n, int free);
340 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
341 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
342 rte_mempool_check_cookies(mp, obj_table_const, n, free)
344 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
345 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
348 * @internal Check contiguous object blocks and update cookies or panic.
351 * Pointer to the memory pool.
352 * @param first_obj_table_const
353 * Pointer to a table of void * pointers (first object of the contiguous
356 * Number of contiguous object blocks.
358 * - 0: object is supposed to be allocated, mark it as free
359 * - 1: object is supposed to be free, mark it as allocated
360 * - 2: just check that cookie is valid (free or allocated)
362 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
363 void * const *first_obj_table_const, unsigned int n, int free);
365 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
366 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
368 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
371 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
374 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
376 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
379 * Prototype for implementation specific data provisioning function.
381 * The function should provide the implementation specific memory for
382 * use by the other mempool ops functions in a given mempool ops struct.
383 * E.g. the default ops provides an instance of the rte_ring for this purpose.
384 * it will most likely point to a different type of data structure, and
385 * will be transparent to the application programmer.
386 * This function should set mp->pool_data.
388 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
391 * Free the opaque private data pointed to by mp->pool_data pointer.
393 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
396 * Enqueue an object into the external pool.
398 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
399 void * const *obj_table, unsigned int n);
402 * Dequeue an object from the external pool.
404 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
405 void **obj_table, unsigned int n);
408 * Dequeue a number of contiguous object blocks from the external pool.
410 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
411 void **first_obj_table, unsigned int n);
414 * Return the number of available objects in the external pool.
416 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
419 * Calculate memory size required to store given number of objects.
421 * If mempool objects are not required to be IOVA-contiguous
422 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
423 * virtually contiguous chunk size. Otherwise, if mempool objects must
424 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
425 * min_chunk_size defines IOVA-contiguous chunk size.
428 * Pointer to the memory pool.
431 * @param[in] pg_shift
432 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
433 * @param[out] min_chunk_size
434 * Location for minimum size of the memory chunk which may be used to
435 * store memory pool objects.
437 * Location for required memory chunk alignment.
439 * Required memory size.
441 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
442 uint32_t obj_num, uint32_t pg_shift,
443 size_t *min_chunk_size, size_t *align);
446 * @internal Helper to calculate memory size required to store given
449 * This function is internal to mempool library and mempool drivers.
451 * If page boundaries may be ignored, it is just a product of total
452 * object size including header and trailer and number of objects.
453 * Otherwise, it is a number of pages required to store given number of
454 * objects without crossing page boundary.
456 * Note that if object size is bigger than page size, then it assumes
457 * that pages are grouped in subsets of physically continuous pages big
458 * enough to store at least one object.
460 * Minimum size of memory chunk is the total element size.
461 * Required memory chunk alignment is the cache line size.
464 * A pointer to the mempool structure.
466 * Number of objects to be added in mempool.
467 * @param[in] pg_shift
468 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
469 * @param[in] chunk_reserve
470 * Amount of memory that must be reserved at the beginning of each page,
471 * or at the beginning of the memory area if pg_shift is 0.
472 * @param[out] min_chunk_size
473 * Location for minimum size of the memory chunk which may be used to
474 * store memory pool objects.
476 * Location for required memory chunk alignment.
478 * Required memory size.
480 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
481 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
482 size_t *min_chunk_size, size_t *align);
485 * Default way to calculate memory size required to store given number of
488 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
489 * 0, min_chunk_size, align).
491 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
492 uint32_t obj_num, uint32_t pg_shift,
493 size_t *min_chunk_size, size_t *align);
496 * Function to be called for each populated object.
499 * A pointer to the mempool structure.
501 * An opaque pointer passed to iterator.
503 * Object virtual address.
505 * Input/output virtual address of the object or RTE_BAD_IOVA.
507 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
508 void *opaque, void *vaddr, rte_iova_t iova);
511 * Populate memory pool objects using provided memory chunk.
513 * Populated objects should be enqueued to the pool, e.g. using
514 * rte_mempool_ops_enqueue_bulk().
516 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
517 * the chunk doesn't need to be physically contiguous (only virtually),
518 * and allocated objects may span two pages.
521 * A pointer to the mempool structure.
522 * @param[in] max_objs
523 * Maximum number of objects to be populated.
525 * The virtual address of memory that should be used to store objects.
529 * The length of memory in bytes.
531 * Callback function to be executed for each populated object.
532 * @param[in] obj_cb_arg
533 * An opaque pointer passed to the callback function.
535 * The number of objects added on success.
536 * On error, no objects are populated and a negative errno is returned.
538 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
539 unsigned int max_objs,
540 void *vaddr, rte_iova_t iova, size_t len,
541 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
544 * Align objects on addresses multiple of total_elt_sz.
546 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
549 * @internal Helper to populate memory pool object using provided memory
550 * chunk: just slice objects one by one, taking care of not
551 * crossing page boundaries.
553 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
554 * of object headers will be aligned on a multiple of total_elt_sz.
555 * This feature is used by octeontx hardware.
557 * This function is internal to mempool library and mempool drivers.
560 * A pointer to the mempool structure.
562 * Logical OR of following flags:
563 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
564 * multiple of total_elt_sz.
565 * @param[in] max_objs
566 * Maximum number of objects to be added in mempool.
568 * The virtual address of memory that should be used to store objects.
570 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
572 * The length of memory in bytes.
574 * Callback function to be executed for each populated object.
575 * @param[in] obj_cb_arg
576 * An opaque pointer passed to the callback function.
578 * The number of objects added in mempool.
580 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
581 unsigned int flags, unsigned int max_objs,
582 void *vaddr, rte_iova_t iova, size_t len,
583 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
586 * Default way to populate memory pool object using provided memory chunk.
588 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
589 * len, obj_cb, obj_cb_arg).
591 int rte_mempool_op_populate_default(struct rte_mempool *mp,
592 unsigned int max_objs,
593 void *vaddr, rte_iova_t iova, size_t len,
594 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
597 * Get some additional information about a mempool.
599 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
600 struct rte_mempool_info *info);
603 /** Structure defining mempool operations structure */
604 struct rte_mempool_ops {
605 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
606 rte_mempool_alloc_t alloc; /**< Allocate private data. */
607 rte_mempool_free_t free; /**< Free the external pool. */
608 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
609 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
610 rte_mempool_get_count get_count; /**< Get qty of available objs. */
612 * Optional callback to calculate memory size required to
613 * store specified number of objects.
615 rte_mempool_calc_mem_size_t calc_mem_size;
617 * Optional callback to populate mempool objects using
618 * provided memory chunk.
620 rte_mempool_populate_t populate;
624 rte_mempool_get_info_t get_info;
626 * Dequeue a number of contiguous object blocks.
628 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
629 } __rte_cache_aligned;
631 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
634 * Structure storing the table of registered ops structs, each of which contain
635 * the function pointers for the mempool ops functions.
636 * Each process has its own storage for this ops struct array so that
637 * the mempools can be shared across primary and secondary processes.
638 * The indices used to access the array are valid across processes, whereas
639 * any function pointers stored directly in the mempool struct would not be.
640 * This results in us simply having "ops_index" in the mempool struct.
642 struct rte_mempool_ops_table {
643 rte_spinlock_t sl; /**< Spinlock for add/delete. */
644 uint32_t num_ops; /**< Number of used ops structs in the table. */
646 * Storage for all possible ops structs.
648 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
649 } __rte_cache_aligned;
651 /** Array of registered ops structs. */
652 extern struct rte_mempool_ops_table rte_mempool_ops_table;
655 * @internal Get the mempool ops struct from its index.
658 * The index of the ops struct in the ops struct table. It must be a valid
659 * index: (0 <= idx < num_ops).
661 * The pointer to the ops struct in the table.
663 static inline struct rte_mempool_ops *
664 rte_mempool_get_ops(int ops_index)
666 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
668 return &rte_mempool_ops_table.ops[ops_index];
672 * @internal Wrapper for mempool_ops alloc callback.
675 * Pointer to the memory pool.
677 * - 0: Success; successfully allocated mempool pool_data.
678 * - <0: Error; code of alloc function.
681 rte_mempool_ops_alloc(struct rte_mempool *mp);
684 * @internal Wrapper for mempool_ops dequeue callback.
687 * Pointer to the memory pool.
689 * Pointer to a table of void * pointers (objects).
691 * Number of objects to get.
693 * - 0: Success; got n objects.
694 * - <0: Error; code of dequeue function.
697 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
698 void **obj_table, unsigned n)
700 struct rte_mempool_ops *ops;
703 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
704 ops = rte_mempool_get_ops(mp->ops_index);
705 ret = ops->dequeue(mp, obj_table, n);
707 __MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
708 __MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
714 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
717 * Pointer to the memory pool.
718 * @param[out] first_obj_table
719 * Pointer to a table of void * pointers (first objects).
721 * Number of blocks to get.
723 * - 0: Success; got n objects.
724 * - <0: Error; code of dequeue function.
727 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
728 void **first_obj_table, unsigned int n)
730 struct rte_mempool_ops *ops;
732 ops = rte_mempool_get_ops(mp->ops_index);
733 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
734 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
735 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
739 * @internal wrapper for mempool_ops enqueue callback.
742 * Pointer to the memory pool.
744 * Pointer to a table of void * pointers (objects).
746 * Number of objects to put.
748 * - 0: Success; n objects supplied.
749 * - <0: Error; code of enqueue function.
752 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
755 struct rte_mempool_ops *ops;
757 __MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
758 __MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
759 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
760 ops = rte_mempool_get_ops(mp->ops_index);
761 return ops->enqueue(mp, obj_table, n);
765 * @internal wrapper for mempool_ops get_count callback.
768 * Pointer to the memory pool.
770 * The number of available objects in the external pool.
773 rte_mempool_ops_get_count(const struct rte_mempool *mp);
776 * @internal wrapper for mempool_ops calc_mem_size callback.
777 * API to calculate size of memory required to store specified number of
781 * Pointer to the memory pool.
784 * @param[in] pg_shift
785 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
786 * @param[out] min_chunk_size
787 * Location for minimum size of the memory chunk which may be used to
788 * store memory pool objects.
790 * Location for required memory chunk alignment.
792 * Required memory size aligned at page boundary.
794 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
795 uint32_t obj_num, uint32_t pg_shift,
796 size_t *min_chunk_size, size_t *align);
799 * @internal wrapper for mempool_ops populate callback.
801 * Populate memory pool objects using provided memory chunk.
804 * A pointer to the mempool structure.
805 * @param[in] max_objs
806 * Maximum number of objects to be populated.
808 * The virtual address of memory that should be used to store objects.
812 * The length of memory in bytes.
814 * Callback function to be executed for each populated object.
815 * @param[in] obj_cb_arg
816 * An opaque pointer passed to the callback function.
818 * The number of objects added on success.
819 * On error, no objects are populated and a negative errno is returned.
821 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
822 void *vaddr, rte_iova_t iova, size_t len,
823 rte_mempool_populate_obj_cb_t *obj_cb,
827 * Wrapper for mempool_ops get_info callback.
830 * Pointer to the memory pool.
832 * Pointer to the rte_mempool_info structure
834 * - 0: Success; The mempool driver supports retrieving supplementary
835 * mempool information
836 * - -ENOTSUP - doesn't support get_info ops (valid case).
838 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
839 struct rte_mempool_info *info);
842 * @internal wrapper for mempool_ops free callback.
845 * Pointer to the memory pool.
848 rte_mempool_ops_free(struct rte_mempool *mp);
851 * Set the ops of a mempool.
853 * This can only be done on a mempool that is not populated, i.e. just after
854 * a call to rte_mempool_create_empty().
857 * Pointer to the memory pool.
859 * Name of the ops structure to use for this mempool.
861 * Opaque data that can be passed by the application to the ops functions.
863 * - 0: Success; the mempool is now using the requested ops functions.
864 * - -EINVAL - Invalid ops struct name provided.
865 * - -EEXIST - mempool already has an ops struct assigned.
868 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
872 * Register mempool operations.
875 * Pointer to an ops structure to register.
877 * - >=0: Success; return the index of the ops struct in the table.
878 * - -EINVAL - some missing callbacks while registering ops struct.
879 * - -ENOSPC - the maximum number of ops structs has been reached.
881 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
884 * Macro to statically register the ops of a mempool handler.
885 * Note that the rte_mempool_register_ops fails silently here when
886 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
888 #define MEMPOOL_REGISTER_OPS(ops) \
889 RTE_INIT(mp_hdlr_init_##ops) \
891 rte_mempool_register_ops(&ops); \
895 * An object callback function for mempool.
897 * Used by rte_mempool_create() and rte_mempool_obj_iter().
899 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
900 void *opaque, void *obj, unsigned obj_idx);
901 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
904 * A memory callback function for mempool.
906 * Used by rte_mempool_mem_iter().
908 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
909 void *opaque, struct rte_mempool_memhdr *memhdr,
913 * A mempool constructor callback function.
915 * Arguments are the mempool and the opaque pointer given by the user in
916 * rte_mempool_create().
918 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
921 * Create a new mempool named *name* in memory.
923 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
924 * pool contains n elements of elt_size. Its size is set to n.
927 * The name of the mempool.
929 * The number of elements in the mempool. The optimum size (in terms of
930 * memory usage) for a mempool is when n is a power of two minus one:
933 * The size of each element.
935 * If cache_size is non-zero, the rte_mempool library will try to
936 * limit the accesses to the common lockless pool, by maintaining a
937 * per-lcore object cache. This argument must be lower or equal to
938 * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
939 * cache_size to have "n modulo cache_size == 0": if this is
940 * not the case, some elements will always stay in the pool and will
941 * never be used. The access to the per-lcore table is of course
942 * faster than the multi-producer/consumer pool. The cache can be
943 * disabled if the cache_size argument is set to 0; it can be useful to
944 * avoid losing objects in cache.
945 * @param private_data_size
946 * The size of the private data appended after the mempool
947 * structure. This is useful for storing some private data after the
948 * mempool structure, as is done for rte_mbuf_pool for example.
950 * A function pointer that is called for initialization of the pool,
951 * before object initialization. The user can initialize the private
952 * data in this function if needed. This parameter can be NULL if
955 * An opaque pointer to data that can be used in the mempool
956 * constructor function.
958 * A function pointer that is called for each object at
959 * initialization of the pool. The user can set some meta data in
960 * objects if needed. This parameter can be NULL if not needed.
961 * The obj_init() function takes the mempool pointer, the init_arg,
962 * the object pointer and the object number as parameters.
963 * @param obj_init_arg
964 * An opaque pointer to data that can be used as an argument for
965 * each call to the object constructor function.
967 * The *socket_id* argument is the socket identifier in the case of
968 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
969 * constraint for the reserved zone.
971 * The *flags* arguments is an OR of following flags:
972 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
973 * between channels in RAM: the pool allocator will add padding
974 * between objects depending on the hardware configuration. See
975 * Memory alignment constraints for details. If this flag is set,
976 * the allocator will just align them to a cache line.
977 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
978 * cache-aligned. This flag removes this constraint, and no
979 * padding will be present between objects. This flag implies
980 * MEMPOOL_F_NO_SPREAD.
981 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
982 * when using rte_mempool_put() or rte_mempool_put_bulk() is
983 * "single-producer". Otherwise, it is "multi-producers".
984 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
985 * when using rte_mempool_get() or rte_mempool_get_bulk() is
986 * "single-consumer". Otherwise, it is "multi-consumers".
987 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
988 * necessarily be contiguous in IO memory.
990 * The pointer to the new allocated mempool, on success. NULL on error
991 * with rte_errno set appropriately. Possible rte_errno values include:
992 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
993 * - E_RTE_SECONDARY - function was called from a secondary process instance
994 * - EINVAL - cache size provided is too large or an unknown flag was passed
995 * - ENOSPC - the maximum number of memzones has already been allocated
996 * - EEXIST - a memzone with the same name already exists
997 * - ENOMEM - no appropriate memory area found in which to create memzone
1000 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1001 unsigned cache_size, unsigned private_data_size,
1002 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1003 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1004 int socket_id, unsigned flags);
1007 * Create an empty mempool
1009 * The mempool is allocated and initialized, but it is not populated: no
1010 * memory is allocated for the mempool elements. The user has to call
1011 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1012 * populated, the user may also want to initialize each object with
1013 * rte_mempool_obj_iter().
1016 * The name of the mempool.
1018 * The maximum number of elements that can be added in the mempool.
1019 * The optimum size (in terms of memory usage) for a mempool is when n
1020 * is a power of two minus one: n = (2^q - 1).
1022 * The size of each element.
1024 * Size of the cache. See rte_mempool_create() for details.
1025 * @param private_data_size
1026 * The size of the private data appended after the mempool
1027 * structure. This is useful for storing some private data after the
1028 * mempool structure, as is done for rte_mbuf_pool for example.
1030 * The *socket_id* argument is the socket identifier in the case of
1031 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1032 * constraint for the reserved zone.
1034 * Flags controlling the behavior of the mempool. See
1035 * rte_mempool_create() for details.
1037 * The pointer to the new allocated mempool, on success. NULL on error
1038 * with rte_errno set appropriately. See rte_mempool_create() for details.
1040 struct rte_mempool *
1041 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1042 unsigned cache_size, unsigned private_data_size,
1043 int socket_id, unsigned flags);
1047 * Unlink the mempool from global list, free the memory chunks, and all
1048 * memory referenced by the mempool. The objects must not be used by
1049 * other cores as they will be freed.
1052 * A pointer to the mempool structure.
1055 rte_mempool_free(struct rte_mempool *mp);
1058 * Add physically contiguous memory for objects in the pool at init
1060 * Add a virtually and physically contiguous memory chunk in the pool
1061 * where objects can be instantiated.
1063 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1064 * the chunk doesn't need to be physically contiguous (only virtually),
1065 * and allocated objects may span two pages.
1068 * A pointer to the mempool structure.
1070 * The virtual address of memory that should be used to store objects.
1074 * The length of memory in bytes.
1076 * The callback used to free this chunk when destroying the mempool.
1078 * An opaque argument passed to free_cb.
1080 * The number of objects added on success (strictly positive).
1081 * On error, the chunk is not added in the memory list of the
1082 * mempool the following code is returned:
1083 * (0): not enough room in chunk for one object.
1084 * (-ENOSPC): mempool is already populated.
1085 * (-ENOMEM): allocation failure.
1087 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1088 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1092 * Add virtually contiguous memory for objects in the pool at init
1094 * Add a virtually contiguous memory chunk in the pool where objects can
1098 * A pointer to the mempool structure.
1100 * The virtual address of memory that should be used to store objects.
1102 * The length of memory in bytes.
1104 * The size of memory pages in this virtual area.
1106 * The callback used to free this chunk when destroying the mempool.
1108 * An opaque argument passed to free_cb.
1110 * The number of objects added on success (strictly positive).
1111 * On error, the chunk is not added in the memory list of the
1112 * mempool the following code is returned:
1113 * (0): not enough room in chunk for one object.
1114 * (-ENOSPC): mempool is already populated.
1115 * (-ENOMEM): allocation failure.
1118 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1119 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1123 * Add memory for objects in the pool at init
1125 * This is the default function used by rte_mempool_create() to populate
1126 * the mempool. It adds memory allocated using rte_memzone_reserve().
1129 * A pointer to the mempool structure.
1131 * The number of objects added on success.
1132 * On error, the chunk is not added in the memory list of the
1133 * mempool and a negative errno is returned.
1135 int rte_mempool_populate_default(struct rte_mempool *mp);
1138 * Add memory from anonymous mapping for objects in the pool at init
1140 * This function mmap an anonymous memory zone that is locked in
1141 * memory to store the objects of the mempool.
1144 * A pointer to the mempool structure.
1146 * The number of objects added on success.
1147 * On error, 0 is returned, rte_errno is set, and the chunk is not added in
1148 * the memory list of the mempool.
1150 int rte_mempool_populate_anon(struct rte_mempool *mp);
1153 * Call a function for each mempool element
1155 * Iterate across all objects attached to a rte_mempool and call the
1156 * callback function on it.
1159 * A pointer to an initialized mempool.
1161 * A function pointer that is called for each object.
1163 * An opaque pointer passed to the callback function.
1165 * Number of objects iterated.
1167 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1168 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1171 * Call a function for each mempool memory chunk
1173 * Iterate across all memory chunks attached to a rte_mempool and call
1174 * the callback function on it.
1177 * A pointer to an initialized mempool.
1179 * A function pointer that is called for each memory chunk.
1181 * An opaque pointer passed to the callback function.
1183 * Number of memory chunks iterated.
1185 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1186 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1189 * Dump the status of the mempool to a file.
1192 * A pointer to a file for output
1194 * A pointer to the mempool structure.
1196 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1199 * Create a user-owned mempool cache.
1201 * This can be used by unregistered non-EAL threads to enable caching when they
1202 * interact with a mempool.
1205 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1206 * parameter description for more information. The same limits and
1207 * considerations apply here too.
1209 * The socket identifier in the case of NUMA. The value can be
1210 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1212 struct rte_mempool_cache *
1213 rte_mempool_cache_create(uint32_t size, int socket_id);
1216 * Free a user-owned mempool cache.
1219 * A pointer to the mempool cache.
1222 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1225 * Get a pointer to the per-lcore default mempool cache.
1228 * A pointer to the mempool structure.
1230 * The logical core id.
1232 * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
1235 static __rte_always_inline struct rte_mempool_cache *
1236 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1238 if (mp->cache_size == 0)
1241 if (lcore_id >= RTE_MAX_LCORE)
1244 rte_mempool_trace_default_cache(mp, lcore_id,
1245 &mp->local_cache[lcore_id]);
1246 return &mp->local_cache[lcore_id];
1250 * Flush a user-owned mempool cache to the specified mempool.
1253 * A pointer to the mempool cache.
1255 * A pointer to the mempool.
1257 static __rte_always_inline void
1258 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1259 struct rte_mempool *mp)
1262 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1263 if (cache == NULL || cache->len == 0)
1265 rte_mempool_trace_cache_flush(cache, mp);
1266 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1271 * @internal Put several objects back in the mempool; used internally.
1273 * A pointer to the mempool structure.
1275 * A pointer to a table of void * pointers (objects).
1277 * The number of objects to store back in the mempool, must be strictly
1280 * A pointer to a mempool cache structure. May be NULL if not needed.
1282 static __rte_always_inline void
1283 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1284 unsigned int n, struct rte_mempool_cache *cache)
1288 /* increment stat now, adding in mempool always success */
1289 __MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1290 __MEMPOOL_STAT_ADD(mp, put_objs, n);
1292 /* No cache provided or if put would overflow mem allocated for cache */
1293 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1296 cache_objs = &cache->objs[cache->len];
1299 * The cache follows the following algorithm
1300 * 1. Add the objects to the cache
1301 * 2. Anything greater than the cache min value (if it crosses the
1302 * cache flush threshold) is flushed to the ring.
1305 /* Add elements back into the cache */
1306 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1310 if (cache->len >= cache->flushthresh) {
1311 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1312 cache->len - cache->size);
1313 cache->len = cache->size;
1320 /* push remaining objects in ring */
1321 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1322 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1323 rte_panic("cannot put objects in mempool\n");
1325 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1331 * Put several objects back in the mempool.
1334 * A pointer to the mempool structure.
1336 * A pointer to a table of void * pointers (objects).
1338 * The number of objects to add in the mempool from the obj_table.
1340 * A pointer to a mempool cache structure. May be NULL if not needed.
1342 static __rte_always_inline void
1343 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1344 unsigned int n, struct rte_mempool_cache *cache)
1346 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1347 __mempool_check_cookies(mp, obj_table, n, 0);
1348 __mempool_generic_put(mp, obj_table, n, cache);
1352 * Put several objects back in the mempool.
1354 * This function calls the multi-producer or the single-producer
1355 * version depending on the default behavior that was specified at
1356 * mempool creation time (see flags).
1359 * A pointer to the mempool structure.
1361 * A pointer to a table of void * pointers (objects).
1363 * The number of objects to add in the mempool from obj_table.
1365 static __rte_always_inline void
1366 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1369 struct rte_mempool_cache *cache;
1370 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1371 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1372 rte_mempool_generic_put(mp, obj_table, n, cache);
1376 * Put one object back in the mempool.
1378 * This function calls the multi-producer or the single-producer
1379 * version depending on the default behavior that was specified at
1380 * mempool creation time (see flags).
1383 * A pointer to the mempool structure.
1385 * A pointer to the object to be added.
1387 static __rte_always_inline void
1388 rte_mempool_put(struct rte_mempool *mp, void *obj)
1390 rte_mempool_put_bulk(mp, &obj, 1);
1394 * @internal Get several objects from the mempool; used internally.
1396 * A pointer to the mempool structure.
1398 * A pointer to a table of void * pointers (objects).
1400 * The number of objects to get, must be strictly positive.
1402 * A pointer to a mempool cache structure. May be NULL if not needed.
1404 * - >=0: Success; number of objects supplied.
1405 * - <0: Error; code of ring dequeue function.
1407 static __rte_always_inline int
1408 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1409 unsigned int n, struct rte_mempool_cache *cache)
1412 uint32_t index, len;
1415 /* No cache provided or cannot be satisfied from cache */
1416 if (unlikely(cache == NULL || n >= cache->size))
1419 cache_objs = cache->objs;
1421 /* Can this be satisfied from the cache? */
1422 if (cache->len < n) {
1423 /* No. Backfill the cache first, and then fill from it */
1424 uint32_t req = n + (cache->size - cache->len);
1426 /* How many do we require i.e. number to fill the cache + the request */
1427 ret = rte_mempool_ops_dequeue_bulk(mp,
1428 &cache->objs[cache->len], req);
1429 if (unlikely(ret < 0)) {
1431 * In the off chance that we are buffer constrained,
1432 * where we are not able to allocate cache + n, go to
1433 * the ring directly. If that fails, we are truly out of
1442 /* Now fill in the response ... */
1443 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1444 *obj_table = cache_objs[len];
1448 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1449 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1455 /* get remaining objects from ring */
1456 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1459 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1460 __MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1462 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1463 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1470 * Get several objects from the mempool.
1472 * If cache is enabled, objects will be retrieved first from cache,
1473 * subsequently from the common pool. Note that it can return -ENOENT when
1474 * the local cache and common pool are empty, even if cache from other
1478 * A pointer to the mempool structure.
1480 * A pointer to a table of void * pointers (objects) that will be filled.
1482 * The number of objects to get from mempool to obj_table.
1484 * A pointer to a mempool cache structure. May be NULL if not needed.
1486 * - 0: Success; objects taken.
1487 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1489 static __rte_always_inline int
1490 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1491 unsigned int n, struct rte_mempool_cache *cache)
1494 ret = __mempool_generic_get(mp, obj_table, n, cache);
1496 __mempool_check_cookies(mp, obj_table, n, 1);
1497 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1502 * Get several objects from the mempool.
1504 * This function calls the multi-consumers or the single-consumer
1505 * version, depending on the default behaviour that was specified at
1506 * mempool creation time (see flags).
1508 * If cache is enabled, objects will be retrieved first from cache,
1509 * subsequently from the common pool. Note that it can return -ENOENT when
1510 * the local cache and common pool are empty, even if cache from other
1514 * A pointer to the mempool structure.
1516 * A pointer to a table of void * pointers (objects) that will be filled.
1518 * The number of objects to get from the mempool to obj_table.
1520 * - 0: Success; objects taken
1521 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1523 static __rte_always_inline int
1524 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1526 struct rte_mempool_cache *cache;
1527 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1528 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1529 return rte_mempool_generic_get(mp, obj_table, n, cache);
1533 * Get one object from the mempool.
1535 * This function calls the multi-consumers or the single-consumer
1536 * version, depending on the default behavior that was specified at
1537 * mempool creation (see flags).
1539 * If cache is enabled, objects will be retrieved first from cache,
1540 * subsequently from the common pool. Note that it can return -ENOENT when
1541 * the local cache and common pool are empty, even if cache from other
1545 * A pointer to the mempool structure.
1547 * A pointer to a void * pointer (object) that will be filled.
1549 * - 0: Success; objects taken.
1550 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1552 static __rte_always_inline int
1553 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1555 return rte_mempool_get_bulk(mp, obj_p, 1);
1559 * Get a contiguous blocks of objects from the mempool.
1561 * If cache is enabled, consider to flush it first, to reuse objects
1562 * as soon as possible.
1564 * The application should check that the driver supports the operation
1565 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1569 * A pointer to the mempool structure.
1570 * @param first_obj_table
1571 * A pointer to a pointer to the first object in each block.
1573 * The number of blocks to get from mempool.
1575 * - 0: Success; blocks taken.
1576 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1577 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1579 static __rte_always_inline int
1580 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1581 void **first_obj_table, unsigned int n)
1585 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1587 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1588 __MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1589 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1592 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1593 __MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1596 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1601 * Return the number of entries in the mempool.
1603 * When cache is enabled, this function has to browse the length of
1604 * all lcores, so it should not be used in a data path, but only for
1605 * debug purposes. User-owned mempool caches are not accounted for.
1608 * A pointer to the mempool structure.
1610 * The number of entries in the mempool.
1612 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1615 * Return the number of elements which have been allocated from the mempool
1617 * When cache is enabled, this function has to browse the length of
1618 * all lcores, so it should not be used in a data path, but only for
1622 * A pointer to the mempool structure.
1624 * The number of free entries in the mempool.
1627 rte_mempool_in_use_count(const struct rte_mempool *mp);
1630 * Test if the mempool is full.
1632 * When cache is enabled, this function has to browse the length of all
1633 * lcores, so it should not be used in a data path, but only for debug
1634 * purposes. User-owned mempool caches are not accounted for.
1637 * A pointer to the mempool structure.
1639 * - 1: The mempool is full.
1640 * - 0: The mempool is not full.
1643 rte_mempool_full(const struct rte_mempool *mp)
1645 return rte_mempool_avail_count(mp) == mp->size;
1649 * Test if the mempool is empty.
1651 * When cache is enabled, this function has to browse the length of all
1652 * lcores, so it should not be used in a data path, but only for debug
1653 * purposes. User-owned mempool caches are not accounted for.
1656 * A pointer to the mempool structure.
1658 * - 1: The mempool is empty.
1659 * - 0: The mempool is not empty.
1662 rte_mempool_empty(const struct rte_mempool *mp)
1664 return rte_mempool_avail_count(mp) == 0;
1668 * Return the IO address of elt, which is an element of the pool mp.
1671 * A pointer (virtual address) to the element of the pool.
1673 * The IO address of the elt element.
1674 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1675 * returned value is RTE_BAD_IOVA.
1677 static inline rte_iova_t
1678 rte_mempool_virt2iova(const void *elt)
1680 const struct rte_mempool_objhdr *hdr;
1681 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1687 * Check the consistency of mempool objects.
1689 * Verify the coherency of fields in the mempool structure. Also check
1690 * that the cookies of mempool objects (even the ones that are not
1691 * present in pool) have a correct value. If not, a panic will occur.
1694 * A pointer to the mempool structure.
1696 void rte_mempool_audit(struct rte_mempool *mp);
1699 * Return a pointer to the private data in an mempool structure.
1702 * A pointer to the mempool structure.
1704 * A pointer to the private data.
1706 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1709 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1713 * Dump the status of all mempools on the console
1716 * A pointer to a file for output
1718 void rte_mempool_list_dump(FILE *f);
1721 * Search a mempool from its name
1724 * The name of the mempool.
1726 * The pointer to the mempool matching the name, or NULL if not found.
1728 * with rte_errno set appropriately. Possible rte_errno values include:
1729 * - ENOENT - required entry not available to return.
1732 struct rte_mempool *rte_mempool_lookup(const char *name);
1735 * Get the header, trailer and total size of a mempool element.
1737 * Given a desired size of the mempool element and mempool flags,
1738 * calculates header, trailer, body and total sizes of the mempool object.
1741 * The size of each element, without header and trailer.
1743 * The flags used for the mempool creation.
1744 * Consult rte_mempool_create() for more information about possible values.
1745 * The size of each element.
1747 * The calculated detailed size the mempool object. May be NULL.
1749 * Total size of the mempool object.
1751 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1752 struct rte_mempool_objsz *sz);
1755 * Walk list of all memory pools
1760 * Argument passed to iterator
1762 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1766 * @internal Get page size used for mempool object allocation.
1767 * This function is internal to mempool library and mempool drivers.
1770 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1776 #endif /* _RTE_MEMPOOL_H_ */