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.
213 * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
214 * compatibility requirements, it could be changed to
215 * RTE_MEMPOOL_NAMESIZE next time the ABI changes
217 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
220 void *pool_data; /**< Ring or pool to store objects. */
221 uint64_t pool_id; /**< External mempool identifier. */
223 void *pool_config; /**< optional args for ops alloc. */
224 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
225 unsigned int flags; /**< Flags of the mempool. */
226 int socket_id; /**< Socket id passed at create. */
227 uint32_t size; /**< Max size of the mempool. */
229 /**< Size of per-lcore default local cache. */
231 uint32_t elt_size; /**< Size of an element. */
232 uint32_t header_size; /**< Size of header (before elt). */
233 uint32_t trailer_size; /**< Size of trailer (after elt). */
235 unsigned private_data_size; /**< Size of private data. */
237 * Index into rte_mempool_ops_table array of mempool ops
238 * structs, which contain callback function pointers.
239 * We're using an index here rather than pointers to the callbacks
240 * to facilitate any secondary processes that may want to use
245 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
247 uint32_t populated_size; /**< Number of populated objects. */
248 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
249 uint32_t nb_mem_chunks; /**< Number of memory chunks */
250 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
252 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
253 /** Per-lcore statistics. */
254 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
256 } __rte_cache_aligned;
258 #define MEMPOOL_F_NO_SPREAD 0x0001
259 /**< Spreading among memory channels not required. */
260 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
261 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
262 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
263 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
264 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
267 * @internal When debug is enabled, store some statistics.
270 * Pointer to the memory pool.
272 * Name of the statistics field to increment in the memory pool.
274 * Number to add to the object-oriented statistics.
276 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
277 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
278 unsigned __lcore_id = rte_lcore_id(); \
279 if (__lcore_id < RTE_MAX_LCORE) { \
280 mp->stats[__lcore_id].name += n; \
284 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
288 * Calculate the size of the mempool header.
291 * Pointer to the memory pool.
293 * Size of the per-lcore cache.
295 #define MEMPOOL_HEADER_SIZE(mp, cs) \
296 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
297 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
299 /* return the header of a mempool object (internal) */
300 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
302 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
303 sizeof(struct rte_mempool_objhdr));
307 * Return a pointer to the mempool owning this object.
310 * An object that is owned by a pool. If this is not the case,
311 * the behavior is undefined.
313 * A pointer to the mempool structure.
315 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
317 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
321 /* return the trailer of a mempool object (internal) */
322 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
324 struct rte_mempool *mp = rte_mempool_from_obj(obj);
325 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
329 * @internal Check and update cookies or panic.
332 * Pointer to the memory pool.
333 * @param obj_table_const
334 * Pointer to a table of void * pointers (objects).
336 * Index of object in object table.
338 * - 0: object is supposed to be allocated, mark it as free
339 * - 1: object is supposed to be free, mark it as allocated
340 * - 2: just check that cookie is valid (free or allocated)
342 void rte_mempool_check_cookies(const struct rte_mempool *mp,
343 void * const *obj_table_const, unsigned n, int free);
345 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
346 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
347 rte_mempool_check_cookies(mp, obj_table_const, n, free)
349 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
350 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
353 * @internal Check contiguous object blocks and update cookies or panic.
356 * Pointer to the memory pool.
357 * @param first_obj_table_const
358 * Pointer to a table of void * pointers (first object of the contiguous
361 * Number of contiguous object blocks.
363 * - 0: object is supposed to be allocated, mark it as free
364 * - 1: object is supposed to be free, mark it as allocated
365 * - 2: just check that cookie is valid (free or allocated)
367 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
368 void * const *first_obj_table_const, unsigned int n, int free);
370 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
371 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
373 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
376 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
379 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
381 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
384 * Prototype for implementation specific data provisioning function.
386 * The function should provide the implementation specific memory for
387 * use by the other mempool ops functions in a given mempool ops struct.
388 * E.g. the default ops provides an instance of the rte_ring for this purpose.
389 * it will most likely point to a different type of data structure, and
390 * will be transparent to the application programmer.
391 * This function should set mp->pool_data.
393 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
396 * Free the opaque private data pointed to by mp->pool_data pointer.
398 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
401 * Enqueue an object into the external pool.
403 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
404 void * const *obj_table, unsigned int n);
407 * Dequeue an object from the external pool.
409 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
410 void **obj_table, unsigned int n);
413 * Dequeue a number of contiguous object blocks from the external pool.
415 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
416 void **first_obj_table, unsigned int n);
419 * Return the number of available objects in the external pool.
421 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
424 * Calculate memory size required to store given number of objects.
426 * If mempool objects are not required to be IOVA-contiguous
427 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
428 * virtually contiguous chunk size. Otherwise, if mempool objects must
429 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
430 * min_chunk_size defines IOVA-contiguous chunk size.
433 * Pointer to the memory pool.
436 * @param[in] pg_shift
437 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
438 * @param[out] min_chunk_size
439 * Location for minimum size of the memory chunk which may be used to
440 * store memory pool objects.
442 * Location for required memory chunk alignment.
444 * Required memory size.
446 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
447 uint32_t obj_num, uint32_t pg_shift,
448 size_t *min_chunk_size, size_t *align);
451 * @internal Helper to calculate memory size required to store given
454 * This function is internal to mempool library and mempool drivers.
456 * If page boundaries may be ignored, it is just a product of total
457 * object size including header and trailer and number of objects.
458 * Otherwise, it is a number of pages required to store given number of
459 * objects without crossing page boundary.
461 * Note that if object size is bigger than page size, then it assumes
462 * that pages are grouped in subsets of physically continuous pages big
463 * enough to store at least one object.
465 * Minimum size of memory chunk is the total element size.
466 * Required memory chunk alignment is the cache line size.
469 * A pointer to the mempool structure.
471 * Number of objects to be added in mempool.
472 * @param[in] pg_shift
473 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
474 * @param[in] chunk_reserve
475 * Amount of memory that must be reserved at the beginning of each page,
476 * or at the beginning of the memory area if pg_shift is 0.
477 * @param[out] min_chunk_size
478 * Location for minimum size of the memory chunk which may be used to
479 * store memory pool objects.
481 * Location for required memory chunk alignment.
483 * Required memory size.
485 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
486 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
487 size_t *min_chunk_size, size_t *align);
490 * Default way to calculate memory size required to store given number of
493 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
494 * 0, min_chunk_size, align).
496 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
497 uint32_t obj_num, uint32_t pg_shift,
498 size_t *min_chunk_size, size_t *align);
501 * Function to be called for each populated object.
504 * A pointer to the mempool structure.
506 * An opaque pointer passed to iterator.
508 * Object virtual address.
510 * Input/output virtual address of the object or RTE_BAD_IOVA.
512 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
513 void *opaque, void *vaddr, rte_iova_t iova);
516 * Populate memory pool objects using provided memory chunk.
518 * Populated objects should be enqueued to the pool, e.g. using
519 * rte_mempool_ops_enqueue_bulk().
521 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
522 * the chunk doesn't need to be physically contiguous (only virtually),
523 * and allocated objects may span two pages.
526 * A pointer to the mempool structure.
527 * @param[in] max_objs
528 * Maximum number of objects to be populated.
530 * The virtual address of memory that should be used to store objects.
534 * The length of memory in bytes.
536 * Callback function to be executed for each populated object.
537 * @param[in] obj_cb_arg
538 * An opaque pointer passed to the callback function.
540 * The number of objects added on success.
541 * On error, no objects are populated and a negative errno is returned.
543 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
544 unsigned int max_objs,
545 void *vaddr, rte_iova_t iova, size_t len,
546 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
549 * Align objects on addresses multiple of total_elt_sz.
551 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
554 * @internal Helper to populate memory pool object using provided memory
555 * chunk: just slice objects one by one, taking care of not
556 * crossing page boundaries.
558 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
559 * of object headers will be aligned on a multiple of total_elt_sz.
560 * This feature is used by octeontx hardware.
562 * This function is internal to mempool library and mempool drivers.
565 * A pointer to the mempool structure.
567 * Logical OR of following flags:
568 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
569 * multiple of total_elt_sz.
570 * @param[in] max_objs
571 * Maximum number of objects to be added in mempool.
573 * The virtual address of memory that should be used to store objects.
575 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
577 * The length of memory in bytes.
579 * Callback function to be executed for each populated object.
580 * @param[in] obj_cb_arg
581 * An opaque pointer passed to the callback function.
583 * The number of objects added in mempool.
585 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
586 unsigned int flags, unsigned int max_objs,
587 void *vaddr, rte_iova_t iova, size_t len,
588 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
591 * Default way to populate memory pool object using provided memory chunk.
593 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
594 * len, obj_cb, obj_cb_arg).
596 int rte_mempool_op_populate_default(struct rte_mempool *mp,
597 unsigned int max_objs,
598 void *vaddr, rte_iova_t iova, size_t len,
599 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
602 * Get some additional information about a mempool.
604 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
605 struct rte_mempool_info *info);
608 /** Structure defining mempool operations structure */
609 struct rte_mempool_ops {
610 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
611 rte_mempool_alloc_t alloc; /**< Allocate private data. */
612 rte_mempool_free_t free; /**< Free the external pool. */
613 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
614 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
615 rte_mempool_get_count get_count; /**< Get qty of available objs. */
617 * Optional callback to calculate memory size required to
618 * store specified number of objects.
620 rte_mempool_calc_mem_size_t calc_mem_size;
622 * Optional callback to populate mempool objects using
623 * provided memory chunk.
625 rte_mempool_populate_t populate;
629 rte_mempool_get_info_t get_info;
631 * Dequeue a number of contiguous object blocks.
633 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
634 } __rte_cache_aligned;
636 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
639 * Structure storing the table of registered ops structs, each of which contain
640 * the function pointers for the mempool ops functions.
641 * Each process has its own storage for this ops struct array so that
642 * the mempools can be shared across primary and secondary processes.
643 * The indices used to access the array are valid across processes, whereas
644 * any function pointers stored directly in the mempool struct would not be.
645 * This results in us simply having "ops_index" in the mempool struct.
647 struct rte_mempool_ops_table {
648 rte_spinlock_t sl; /**< Spinlock for add/delete. */
649 uint32_t num_ops; /**< Number of used ops structs in the table. */
651 * Storage for all possible ops structs.
653 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
654 } __rte_cache_aligned;
656 /** Array of registered ops structs. */
657 extern struct rte_mempool_ops_table rte_mempool_ops_table;
660 * @internal Get the mempool ops struct from its index.
663 * The index of the ops struct in the ops struct table. It must be a valid
664 * index: (0 <= idx < num_ops).
666 * The pointer to the ops struct in the table.
668 static inline struct rte_mempool_ops *
669 rte_mempool_get_ops(int ops_index)
671 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
673 return &rte_mempool_ops_table.ops[ops_index];
677 * @internal Wrapper for mempool_ops alloc callback.
680 * Pointer to the memory pool.
682 * - 0: Success; successfully allocated mempool pool_data.
683 * - <0: Error; code of alloc function.
686 rte_mempool_ops_alloc(struct rte_mempool *mp);
689 * @internal Wrapper for mempool_ops dequeue callback.
692 * Pointer to the memory pool.
694 * Pointer to a table of void * pointers (objects).
696 * Number of objects to get.
698 * - 0: Success; got n objects.
699 * - <0: Error; code of dequeue function.
702 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
703 void **obj_table, unsigned n)
705 struct rte_mempool_ops *ops;
708 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
709 ops = rte_mempool_get_ops(mp->ops_index);
710 ret = ops->dequeue(mp, obj_table, n);
712 __MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
713 __MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
719 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
722 * Pointer to the memory pool.
723 * @param[out] first_obj_table
724 * Pointer to a table of void * pointers (first objects).
726 * Number of blocks to get.
728 * - 0: Success; got n objects.
729 * - <0: Error; code of dequeue function.
732 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
733 void **first_obj_table, unsigned int n)
735 struct rte_mempool_ops *ops;
737 ops = rte_mempool_get_ops(mp->ops_index);
738 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
739 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
740 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
744 * @internal wrapper for mempool_ops enqueue callback.
747 * Pointer to the memory pool.
749 * Pointer to a table of void * pointers (objects).
751 * Number of objects to put.
753 * - 0: Success; n objects supplied.
754 * - <0: Error; code of enqueue function.
757 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
760 struct rte_mempool_ops *ops;
762 __MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
763 __MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
764 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
765 ops = rte_mempool_get_ops(mp->ops_index);
766 return ops->enqueue(mp, obj_table, n);
770 * @internal wrapper for mempool_ops get_count callback.
773 * Pointer to the memory pool.
775 * The number of available objects in the external pool.
778 rte_mempool_ops_get_count(const struct rte_mempool *mp);
781 * @internal wrapper for mempool_ops calc_mem_size callback.
782 * API to calculate size of memory required to store specified number of
786 * Pointer to the memory pool.
789 * @param[in] pg_shift
790 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
791 * @param[out] min_chunk_size
792 * Location for minimum size of the memory chunk which may be used to
793 * store memory pool objects.
795 * Location for required memory chunk alignment.
797 * Required memory size aligned at page boundary.
799 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
800 uint32_t obj_num, uint32_t pg_shift,
801 size_t *min_chunk_size, size_t *align);
804 * @internal wrapper for mempool_ops populate callback.
806 * Populate memory pool objects using provided memory chunk.
809 * A pointer to the mempool structure.
810 * @param[in] max_objs
811 * Maximum number of objects to be populated.
813 * The virtual address of memory that should be used to store objects.
817 * The length of memory in bytes.
819 * Callback function to be executed for each populated object.
820 * @param[in] obj_cb_arg
821 * An opaque pointer passed to the callback function.
823 * The number of objects added on success.
824 * On error, no objects are populated and a negative errno is returned.
826 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
827 void *vaddr, rte_iova_t iova, size_t len,
828 rte_mempool_populate_obj_cb_t *obj_cb,
832 * Wrapper for mempool_ops get_info callback.
835 * Pointer to the memory pool.
837 * Pointer to the rte_mempool_info structure
839 * - 0: Success; The mempool driver supports retrieving supplementary
840 * mempool information
841 * - -ENOTSUP - doesn't support get_info ops (valid case).
843 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
844 struct rte_mempool_info *info);
847 * @internal wrapper for mempool_ops free callback.
850 * Pointer to the memory pool.
853 rte_mempool_ops_free(struct rte_mempool *mp);
856 * Set the ops of a mempool.
858 * This can only be done on a mempool that is not populated, i.e. just after
859 * a call to rte_mempool_create_empty().
862 * Pointer to the memory pool.
864 * Name of the ops structure to use for this mempool.
866 * Opaque data that can be passed by the application to the ops functions.
868 * - 0: Success; the mempool is now using the requested ops functions.
869 * - -EINVAL - Invalid ops struct name provided.
870 * - -EEXIST - mempool already has an ops struct assigned.
873 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
877 * Register mempool operations.
880 * Pointer to an ops structure to register.
882 * - >=0: Success; return the index of the ops struct in the table.
883 * - -EINVAL - some missing callbacks while registering ops struct.
884 * - -ENOSPC - the maximum number of ops structs has been reached.
886 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
889 * Macro to statically register the ops of a mempool handler.
890 * Note that the rte_mempool_register_ops fails silently here when
891 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
893 #define MEMPOOL_REGISTER_OPS(ops) \
894 RTE_INIT(mp_hdlr_init_##ops) \
896 rte_mempool_register_ops(&ops); \
900 * An object callback function for mempool.
902 * Used by rte_mempool_create() and rte_mempool_obj_iter().
904 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
905 void *opaque, void *obj, unsigned obj_idx);
906 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
909 * A memory callback function for mempool.
911 * Used by rte_mempool_mem_iter().
913 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
914 void *opaque, struct rte_mempool_memhdr *memhdr,
918 * A mempool constructor callback function.
920 * Arguments are the mempool and the opaque pointer given by the user in
921 * rte_mempool_create().
923 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
926 * Create a new mempool named *name* in memory.
928 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
929 * pool contains n elements of elt_size. Its size is set to n.
932 * The name of the mempool.
934 * The number of elements in the mempool. The optimum size (in terms of
935 * memory usage) for a mempool is when n is a power of two minus one:
938 * The size of each element.
940 * If cache_size is non-zero, the rte_mempool library will try to
941 * limit the accesses to the common lockless pool, by maintaining a
942 * per-lcore object cache. This argument must be lower or equal to
943 * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
944 * cache_size to have "n modulo cache_size == 0": if this is
945 * not the case, some elements will always stay in the pool and will
946 * never be used. The access to the per-lcore table is of course
947 * faster than the multi-producer/consumer pool. The cache can be
948 * disabled if the cache_size argument is set to 0; it can be useful to
949 * avoid losing objects in cache.
950 * @param private_data_size
951 * The size of the private data appended after the mempool
952 * structure. This is useful for storing some private data after the
953 * mempool structure, as is done for rte_mbuf_pool for example.
955 * A function pointer that is called for initialization of the pool,
956 * before object initialization. The user can initialize the private
957 * data in this function if needed. This parameter can be NULL if
960 * An opaque pointer to data that can be used in the mempool
961 * constructor function.
963 * A function pointer that is called for each object at
964 * initialization of the pool. The user can set some meta data in
965 * objects if needed. This parameter can be NULL if not needed.
966 * The obj_init() function takes the mempool pointer, the init_arg,
967 * the object pointer and the object number as parameters.
968 * @param obj_init_arg
969 * An opaque pointer to data that can be used as an argument for
970 * each call to the object constructor function.
972 * The *socket_id* argument is the socket identifier in the case of
973 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
974 * constraint for the reserved zone.
976 * The *flags* arguments is an OR of following flags:
977 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
978 * between channels in RAM: the pool allocator will add padding
979 * between objects depending on the hardware configuration. See
980 * Memory alignment constraints for details. If this flag is set,
981 * the allocator will just align them to a cache line.
982 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
983 * cache-aligned. This flag removes this constraint, and no
984 * padding will be present between objects. This flag implies
985 * MEMPOOL_F_NO_SPREAD.
986 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
987 * when using rte_mempool_put() or rte_mempool_put_bulk() is
988 * "single-producer". Otherwise, it is "multi-producers".
989 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
990 * when using rte_mempool_get() or rte_mempool_get_bulk() is
991 * "single-consumer". Otherwise, it is "multi-consumers".
992 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
993 * necessarily be contiguous in IO memory.
995 * The pointer to the new allocated mempool, on success. NULL on error
996 * with rte_errno set appropriately. Possible rte_errno values include:
997 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
998 * - E_RTE_SECONDARY - function was called from a secondary process instance
999 * - EINVAL - cache size provided is too large
1000 * - ENOSPC - the maximum number of memzones has already been allocated
1001 * - EEXIST - a memzone with the same name already exists
1002 * - ENOMEM - no appropriate memory area found in which to create memzone
1004 struct rte_mempool *
1005 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1006 unsigned cache_size, unsigned private_data_size,
1007 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1008 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1009 int socket_id, unsigned flags);
1012 * Create an empty mempool
1014 * The mempool is allocated and initialized, but it is not populated: no
1015 * memory is allocated for the mempool elements. The user has to call
1016 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1017 * populated, the user may also want to initialize each object with
1018 * rte_mempool_obj_iter().
1021 * The name of the mempool.
1023 * The maximum number of elements that can be added in the mempool.
1024 * The optimum size (in terms of memory usage) for a mempool is when n
1025 * is a power of two minus one: n = (2^q - 1).
1027 * The size of each element.
1029 * Size of the cache. See rte_mempool_create() for details.
1030 * @param private_data_size
1031 * The size of the private data appended after the mempool
1032 * structure. This is useful for storing some private data after the
1033 * mempool structure, as is done for rte_mbuf_pool for example.
1035 * The *socket_id* argument is the socket identifier in the case of
1036 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1037 * constraint for the reserved zone.
1039 * Flags controlling the behavior of the mempool. See
1040 * rte_mempool_create() for details.
1042 * The pointer to the new allocated mempool, on success. NULL on error
1043 * with rte_errno set appropriately. See rte_mempool_create() for details.
1045 struct rte_mempool *
1046 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1047 unsigned cache_size, unsigned private_data_size,
1048 int socket_id, unsigned flags);
1052 * Unlink the mempool from global list, free the memory chunks, and all
1053 * memory referenced by the mempool. The objects must not be used by
1054 * other cores as they will be freed.
1057 * A pointer to the mempool structure.
1060 rte_mempool_free(struct rte_mempool *mp);
1063 * Add physically contiguous memory for objects in the pool at init
1065 * Add a virtually and physically contiguous memory chunk in the pool
1066 * where objects can be instantiated.
1068 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1069 * the chunk doesn't need to be physically contiguous (only virtually),
1070 * and allocated objects may span two pages.
1073 * A pointer to the mempool structure.
1075 * The virtual address of memory that should be used to store objects.
1079 * The length of memory in bytes.
1081 * The callback used to free this chunk when destroying the mempool.
1083 * An opaque argument passed to free_cb.
1085 * The number of objects added on success (strictly positive).
1086 * On error, the chunk is not added in the memory list of the
1087 * mempool the following code is returned:
1088 * (0): not enough room in chunk for one object.
1089 * (-ENOSPC): mempool is already populated.
1090 * (-ENOMEM): allocation failure.
1092 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1093 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1097 * Add virtually contiguous memory for objects in the pool at init
1099 * Add a virtually contiguous memory chunk in the pool where objects can
1103 * A pointer to the mempool structure.
1105 * The virtual address of memory that should be used to store objects.
1107 * The length of memory in bytes.
1109 * The size of memory pages in this virtual area.
1111 * The callback used to free this chunk when destroying the mempool.
1113 * An opaque argument passed to free_cb.
1115 * The number of objects added on success (strictly positive).
1116 * On error, the chunk is not added in the memory list of the
1117 * mempool the following code is returned:
1118 * (0): not enough room in chunk for one object.
1119 * (-ENOSPC): mempool is already populated.
1120 * (-ENOMEM): allocation failure.
1123 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1124 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1128 * Add memory for objects in the pool at init
1130 * This is the default function used by rte_mempool_create() to populate
1131 * the mempool. It adds memory allocated using rte_memzone_reserve().
1134 * A pointer to the mempool structure.
1136 * The number of objects added on success.
1137 * On error, the chunk is not added in the memory list of the
1138 * mempool and a negative errno is returned.
1140 int rte_mempool_populate_default(struct rte_mempool *mp);
1143 * Add memory from anonymous mapping for objects in the pool at init
1145 * This function mmap an anonymous memory zone that is locked in
1146 * memory to store the objects of the mempool.
1149 * A pointer to the mempool structure.
1151 * The number of objects added on success.
1152 * On error, 0 is returned, rte_errno is set, and the chunk is not added in
1153 * the memory list of the mempool.
1155 int rte_mempool_populate_anon(struct rte_mempool *mp);
1158 * Call a function for each mempool element
1160 * Iterate across all objects attached to a rte_mempool and call the
1161 * callback function on it.
1164 * A pointer to an initialized mempool.
1166 * A function pointer that is called for each object.
1168 * An opaque pointer passed to the callback function.
1170 * Number of objects iterated.
1172 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1173 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1176 * Call a function for each mempool memory chunk
1178 * Iterate across all memory chunks attached to a rte_mempool and call
1179 * the callback function on it.
1182 * A pointer to an initialized mempool.
1184 * A function pointer that is called for each memory chunk.
1186 * An opaque pointer passed to the callback function.
1188 * Number of memory chunks iterated.
1190 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1191 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1194 * Dump the status of the mempool to a file.
1197 * A pointer to a file for output
1199 * A pointer to the mempool structure.
1201 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1204 * Create a user-owned mempool cache.
1206 * This can be used by unregistered non-EAL threads to enable caching when they
1207 * interact with a mempool.
1210 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1211 * parameter description for more information. The same limits and
1212 * considerations apply here too.
1214 * The socket identifier in the case of NUMA. The value can be
1215 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1217 struct rte_mempool_cache *
1218 rte_mempool_cache_create(uint32_t size, int socket_id);
1221 * Free a user-owned mempool cache.
1224 * A pointer to the mempool cache.
1227 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1230 * Get a pointer to the per-lcore default mempool cache.
1233 * A pointer to the mempool structure.
1235 * The logical core id.
1237 * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
1240 static __rte_always_inline struct rte_mempool_cache *
1241 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1243 if (mp->cache_size == 0)
1246 if (lcore_id >= RTE_MAX_LCORE)
1249 rte_mempool_trace_default_cache(mp, lcore_id,
1250 &mp->local_cache[lcore_id]);
1251 return &mp->local_cache[lcore_id];
1255 * Flush a user-owned mempool cache to the specified mempool.
1258 * A pointer to the mempool cache.
1260 * A pointer to the mempool.
1262 static __rte_always_inline void
1263 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1264 struct rte_mempool *mp)
1267 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1268 if (cache == NULL || cache->len == 0)
1270 rte_mempool_trace_cache_flush(cache, mp);
1271 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1276 * @internal Put several objects back in the mempool; used internally.
1278 * A pointer to the mempool structure.
1280 * A pointer to a table of void * pointers (objects).
1282 * The number of objects to store back in the mempool, must be strictly
1285 * A pointer to a mempool cache structure. May be NULL if not needed.
1287 static __rte_always_inline void
1288 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1289 unsigned int n, struct rte_mempool_cache *cache)
1293 /* increment stat now, adding in mempool always success */
1294 __MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1295 __MEMPOOL_STAT_ADD(mp, put_objs, n);
1297 /* No cache provided or if put would overflow mem allocated for cache */
1298 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1301 cache_objs = &cache->objs[cache->len];
1304 * The cache follows the following algorithm
1305 * 1. Add the objects to the cache
1306 * 2. Anything greater than the cache min value (if it crosses the
1307 * cache flush threshold) is flushed to the ring.
1310 /* Add elements back into the cache */
1311 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1315 if (cache->len >= cache->flushthresh) {
1316 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1317 cache->len - cache->size);
1318 cache->len = cache->size;
1325 /* push remaining objects in ring */
1326 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1327 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1328 rte_panic("cannot put objects in mempool\n");
1330 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1336 * Put several objects back in the mempool.
1339 * A pointer to the mempool structure.
1341 * A pointer to a table of void * pointers (objects).
1343 * The number of objects to add in the mempool from the obj_table.
1345 * A pointer to a mempool cache structure. May be NULL if not needed.
1347 static __rte_always_inline void
1348 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1349 unsigned int n, struct rte_mempool_cache *cache)
1351 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1352 __mempool_check_cookies(mp, obj_table, n, 0);
1353 __mempool_generic_put(mp, obj_table, n, cache);
1357 * Put several objects back in the mempool.
1359 * This function calls the multi-producer or the single-producer
1360 * version depending on the default behavior that was specified at
1361 * mempool creation time (see flags).
1364 * A pointer to the mempool structure.
1366 * A pointer to a table of void * pointers (objects).
1368 * The number of objects to add in the mempool from obj_table.
1370 static __rte_always_inline void
1371 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1374 struct rte_mempool_cache *cache;
1375 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1376 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1377 rte_mempool_generic_put(mp, obj_table, n, cache);
1381 * Put one object back in the mempool.
1383 * This function calls the multi-producer or the single-producer
1384 * version depending on the default behavior that was specified at
1385 * mempool creation time (see flags).
1388 * A pointer to the mempool structure.
1390 * A pointer to the object to be added.
1392 static __rte_always_inline void
1393 rte_mempool_put(struct rte_mempool *mp, void *obj)
1395 rte_mempool_put_bulk(mp, &obj, 1);
1399 * @internal Get several objects from the mempool; used internally.
1401 * A pointer to the mempool structure.
1403 * A pointer to a table of void * pointers (objects).
1405 * The number of objects to get, must be strictly positive.
1407 * A pointer to a mempool cache structure. May be NULL if not needed.
1409 * - >=0: Success; number of objects supplied.
1410 * - <0: Error; code of ring dequeue function.
1412 static __rte_always_inline int
1413 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1414 unsigned int n, struct rte_mempool_cache *cache)
1417 uint32_t index, len;
1420 /* No cache provided or cannot be satisfied from cache */
1421 if (unlikely(cache == NULL || n >= cache->size))
1424 cache_objs = cache->objs;
1426 /* Can this be satisfied from the cache? */
1427 if (cache->len < n) {
1428 /* No. Backfill the cache first, and then fill from it */
1429 uint32_t req = n + (cache->size - cache->len);
1431 /* How many do we require i.e. number to fill the cache + the request */
1432 ret = rte_mempool_ops_dequeue_bulk(mp,
1433 &cache->objs[cache->len], req);
1434 if (unlikely(ret < 0)) {
1436 * In the off chance that we are buffer constrained,
1437 * where we are not able to allocate cache + n, go to
1438 * the ring directly. If that fails, we are truly out of
1447 /* Now fill in the response ... */
1448 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1449 *obj_table = cache_objs[len];
1453 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1454 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1460 /* get remaining objects from ring */
1461 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1464 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1465 __MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1467 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1468 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1475 * Get several objects from the mempool.
1477 * If cache is enabled, objects will be retrieved first from cache,
1478 * subsequently from the common pool. Note that it can return -ENOENT when
1479 * the local cache and common pool are empty, even if cache from other
1483 * A pointer to the mempool structure.
1485 * A pointer to a table of void * pointers (objects) that will be filled.
1487 * The number of objects to get from mempool to obj_table.
1489 * A pointer to a mempool cache structure. May be NULL if not needed.
1491 * - 0: Success; objects taken.
1492 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1494 static __rte_always_inline int
1495 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1496 unsigned int n, struct rte_mempool_cache *cache)
1499 ret = __mempool_generic_get(mp, obj_table, n, cache);
1501 __mempool_check_cookies(mp, obj_table, n, 1);
1502 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1507 * Get several objects from the mempool.
1509 * This function calls the multi-consumers or the single-consumer
1510 * version, depending on the default behaviour that was specified at
1511 * mempool creation time (see flags).
1513 * If cache is enabled, objects will be retrieved first from cache,
1514 * subsequently from the common pool. Note that it can return -ENOENT when
1515 * the local cache and common pool are empty, even if cache from other
1519 * A pointer to the mempool structure.
1521 * A pointer to a table of void * pointers (objects) that will be filled.
1523 * The number of objects to get from the mempool to obj_table.
1525 * - 0: Success; objects taken
1526 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1528 static __rte_always_inline int
1529 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1531 struct rte_mempool_cache *cache;
1532 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1533 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1534 return rte_mempool_generic_get(mp, obj_table, n, cache);
1538 * Get one object from the mempool.
1540 * This function calls the multi-consumers or the single-consumer
1541 * version, depending on the default behavior that was specified at
1542 * mempool creation (see flags).
1544 * If cache is enabled, objects will be retrieved first from cache,
1545 * subsequently from the common pool. Note that it can return -ENOENT when
1546 * the local cache and common pool are empty, even if cache from other
1550 * A pointer to the mempool structure.
1552 * A pointer to a void * pointer (object) that will be filled.
1554 * - 0: Success; objects taken.
1555 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1557 static __rte_always_inline int
1558 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1560 return rte_mempool_get_bulk(mp, obj_p, 1);
1564 * Get a contiguous blocks of objects from the mempool.
1566 * If cache is enabled, consider to flush it first, to reuse objects
1567 * as soon as possible.
1569 * The application should check that the driver supports the operation
1570 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1574 * A pointer to the mempool structure.
1575 * @param first_obj_table
1576 * A pointer to a pointer to the first object in each block.
1578 * The number of blocks to get from mempool.
1580 * - 0: Success; blocks taken.
1581 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1582 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1584 static __rte_always_inline int
1585 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1586 void **first_obj_table, unsigned int n)
1590 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1592 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1593 __MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1594 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1597 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1598 __MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1601 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1606 * Return the number of entries in the mempool.
1608 * When cache is enabled, this function has to browse the length of
1609 * all lcores, so it should not be used in a data path, but only for
1610 * debug purposes. User-owned mempool caches are not accounted for.
1613 * A pointer to the mempool structure.
1615 * The number of entries in the mempool.
1617 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1620 * Return the number of elements which have been allocated from the mempool
1622 * When cache is enabled, this function has to browse the length of
1623 * all lcores, so it should not be used in a data path, but only for
1627 * A pointer to the mempool structure.
1629 * The number of free entries in the mempool.
1632 rte_mempool_in_use_count(const struct rte_mempool *mp);
1635 * Test if the mempool is full.
1637 * When cache is enabled, this function has to browse the length of all
1638 * lcores, so it should not be used in a data path, but only for debug
1639 * purposes. User-owned mempool caches are not accounted for.
1642 * A pointer to the mempool structure.
1644 * - 1: The mempool is full.
1645 * - 0: The mempool is not full.
1648 rte_mempool_full(const struct rte_mempool *mp)
1650 return rte_mempool_avail_count(mp) == mp->size;
1654 * Test if the mempool is empty.
1656 * When cache is enabled, this function has to browse the length of all
1657 * lcores, so it should not be used in a data path, but only for debug
1658 * purposes. User-owned mempool caches are not accounted for.
1661 * A pointer to the mempool structure.
1663 * - 1: The mempool is empty.
1664 * - 0: The mempool is not empty.
1667 rte_mempool_empty(const struct rte_mempool *mp)
1669 return rte_mempool_avail_count(mp) == 0;
1673 * Return the IO address of elt, which is an element of the pool mp.
1676 * A pointer (virtual address) to the element of the pool.
1678 * The IO address of the elt element.
1679 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1680 * returned value is RTE_BAD_IOVA.
1682 static inline rte_iova_t
1683 rte_mempool_virt2iova(const void *elt)
1685 const struct rte_mempool_objhdr *hdr;
1686 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1692 * Check the consistency of mempool objects.
1694 * Verify the coherency of fields in the mempool structure. Also check
1695 * that the cookies of mempool objects (even the ones that are not
1696 * present in pool) have a correct value. If not, a panic will occur.
1699 * A pointer to the mempool structure.
1701 void rte_mempool_audit(struct rte_mempool *mp);
1704 * Return a pointer to the private data in an mempool structure.
1707 * A pointer to the mempool structure.
1709 * A pointer to the private data.
1711 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1714 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1718 * Dump the status of all mempools on the console
1721 * A pointer to a file for output
1723 void rte_mempool_list_dump(FILE *f);
1726 * Search a mempool from its name
1729 * The name of the mempool.
1731 * The pointer to the mempool matching the name, or NULL if not found.
1733 * with rte_errno set appropriately. Possible rte_errno values include:
1734 * - ENOENT - required entry not available to return.
1737 struct rte_mempool *rte_mempool_lookup(const char *name);
1740 * Get the header, trailer and total size of a mempool element.
1742 * Given a desired size of the mempool element and mempool flags,
1743 * calculates header, trailer, body and total sizes of the mempool object.
1746 * The size of each element, without header and trailer.
1748 * The flags used for the mempool creation.
1749 * Consult rte_mempool_create() for more information about possible values.
1750 * The size of each element.
1752 * The calculated detailed size the mempool object. May be NULL.
1754 * Total size of the mempool object.
1756 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1757 struct rte_mempool_objsz *sz);
1760 * Walk list of all memory pools
1765 * Argument passed to iterator
1767 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1771 * @internal Get page size used for mempool object allocation.
1772 * This function is internal to mempool library and mempool drivers.
1775 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1781 #endif /* _RTE_MEMPOOL_H_ */