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 /** Spreading among memory channels not required. */
254 #define MEMPOOL_F_NO_SPREAD 0x0001
255 /** Do not align objects on cache lines. */
256 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002
257 /** Default put is "single-producer". */
258 #define MEMPOOL_F_SP_PUT 0x0004
259 /** Default get is "single-consumer". */
260 #define MEMPOOL_F_SC_GET 0x0008
261 /** Internal: pool is created. */
262 #define MEMPOOL_F_POOL_CREATED 0x0010
263 /** Don't need IOVA contiguous objects. */
264 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020
265 /** Internal: no object from the pool can be used for device IO (DMA). */
266 #define MEMPOOL_F_NON_IO 0x0040
269 * @internal When debug is enabled, store some statistics.
272 * Pointer to the memory pool.
274 * Name of the statistics field to increment in the memory pool.
276 * Number to add to the object-oriented statistics.
278 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
279 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
280 unsigned __lcore_id = rte_lcore_id(); \
281 if (__lcore_id < RTE_MAX_LCORE) { \
282 mp->stats[__lcore_id].name += n; \
286 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
290 * Calculate the size of the mempool header.
293 * Pointer to the memory pool.
295 * Size of the per-lcore cache.
297 #define MEMPOOL_HEADER_SIZE(mp, cs) \
298 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
299 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
301 /* return the header of a mempool object (internal) */
302 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
304 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
305 sizeof(struct rte_mempool_objhdr));
309 * Return a pointer to the mempool owning this object.
312 * An object that is owned by a pool. If this is not the case,
313 * the behavior is undefined.
315 * A pointer to the mempool structure.
317 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
319 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
323 /* return the trailer of a mempool object (internal) */
324 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
326 struct rte_mempool *mp = rte_mempool_from_obj(obj);
327 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
331 * @internal Check and update cookies or panic.
334 * Pointer to the memory pool.
335 * @param obj_table_const
336 * Pointer to a table of void * pointers (objects).
338 * Index of object in object table.
340 * - 0: object is supposed to be allocated, mark it as free
341 * - 1: object is supposed to be free, mark it as allocated
342 * - 2: just check that cookie is valid (free or allocated)
344 void rte_mempool_check_cookies(const struct rte_mempool *mp,
345 void * const *obj_table_const, unsigned n, int free);
347 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
348 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
349 rte_mempool_check_cookies(mp, obj_table_const, n, free)
351 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
352 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
355 * @internal Check contiguous object blocks and update cookies or panic.
358 * Pointer to the memory pool.
359 * @param first_obj_table_const
360 * Pointer to a table of void * pointers (first object of the contiguous
363 * Number of contiguous object blocks.
365 * - 0: object is supposed to be allocated, mark it as free
366 * - 1: object is supposed to be free, mark it as allocated
367 * - 2: just check that cookie is valid (free or allocated)
369 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
370 void * const *first_obj_table_const, unsigned int n, int free);
372 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
373 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
375 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
378 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
381 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
383 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
386 * Prototype for implementation specific data provisioning function.
388 * The function should provide the implementation specific memory for
389 * use by the other mempool ops functions in a given mempool ops struct.
390 * E.g. the default ops provides an instance of the rte_ring for this purpose.
391 * it will most likely point to a different type of data structure, and
392 * will be transparent to the application programmer.
393 * This function should set mp->pool_data.
395 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
398 * Free the opaque private data pointed to by mp->pool_data pointer.
400 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
403 * Enqueue an object into the external pool.
405 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
406 void * const *obj_table, unsigned int n);
409 * Dequeue an object from the external pool.
411 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
412 void **obj_table, unsigned int n);
415 * Dequeue a number of contiguous object blocks from the external pool.
417 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
418 void **first_obj_table, unsigned int n);
421 * Return the number of available objects in the external pool.
423 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
426 * Calculate memory size required to store given number of objects.
428 * If mempool objects are not required to be IOVA-contiguous
429 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
430 * virtually contiguous chunk size. Otherwise, if mempool objects must
431 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
432 * min_chunk_size defines IOVA-contiguous chunk size.
435 * Pointer to the memory pool.
438 * @param[in] pg_shift
439 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
440 * @param[out] min_chunk_size
441 * Location for minimum size of the memory chunk which may be used to
442 * store memory pool objects.
444 * Location for required memory chunk alignment.
446 * Required memory size.
448 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
449 uint32_t obj_num, uint32_t pg_shift,
450 size_t *min_chunk_size, size_t *align);
453 * @internal Helper to calculate memory size required to store given
456 * This function is internal to mempool library and mempool drivers.
458 * If page boundaries may be ignored, it is just a product of total
459 * object size including header and trailer and number of objects.
460 * Otherwise, it is a number of pages required to store given number of
461 * objects without crossing page boundary.
463 * Note that if object size is bigger than page size, then it assumes
464 * that pages are grouped in subsets of physically continuous pages big
465 * enough to store at least one object.
467 * Minimum size of memory chunk is the total element size.
468 * Required memory chunk alignment is the cache line size.
471 * A pointer to the mempool structure.
473 * Number of objects to be added in mempool.
474 * @param[in] pg_shift
475 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
476 * @param[in] chunk_reserve
477 * Amount of memory that must be reserved at the beginning of each page,
478 * or at the beginning of the memory area if pg_shift is 0.
479 * @param[out] min_chunk_size
480 * Location for minimum size of the memory chunk which may be used to
481 * store memory pool objects.
483 * Location for required memory chunk alignment.
485 * Required memory size.
487 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
488 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
489 size_t *min_chunk_size, size_t *align);
492 * Default way to calculate memory size required to store given number of
495 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
496 * 0, min_chunk_size, align).
498 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
499 uint32_t obj_num, uint32_t pg_shift,
500 size_t *min_chunk_size, size_t *align);
503 * Function to be called for each populated object.
506 * A pointer to the mempool structure.
508 * An opaque pointer passed to iterator.
510 * Object virtual address.
512 * Input/output virtual address of the object or RTE_BAD_IOVA.
514 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
515 void *opaque, void *vaddr, rte_iova_t iova);
518 * Populate memory pool objects using provided memory chunk.
520 * Populated objects should be enqueued to the pool, e.g. using
521 * rte_mempool_ops_enqueue_bulk().
523 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
524 * the chunk doesn't need to be physically contiguous (only virtually),
525 * and allocated objects may span two pages.
528 * A pointer to the mempool structure.
529 * @param[in] max_objs
530 * Maximum number of objects to be populated.
532 * The virtual address of memory that should be used to store objects.
536 * The length of memory in bytes.
538 * Callback function to be executed for each populated object.
539 * @param[in] obj_cb_arg
540 * An opaque pointer passed to the callback function.
542 * The number of objects added on success.
543 * On error, no objects are populated and a negative errno is returned.
545 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
546 unsigned int max_objs,
547 void *vaddr, rte_iova_t iova, size_t len,
548 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
551 * Align objects on addresses multiple of total_elt_sz.
553 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
556 * @internal Helper to populate memory pool object using provided memory
557 * chunk: just slice objects one by one, taking care of not
558 * crossing page boundaries.
560 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
561 * of object headers will be aligned on a multiple of total_elt_sz.
562 * This feature is used by octeontx hardware.
564 * This function is internal to mempool library and mempool drivers.
567 * A pointer to the mempool structure.
569 * Logical OR of following flags:
570 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
571 * multiple of total_elt_sz.
572 * @param[in] max_objs
573 * Maximum number of objects to be added in mempool.
575 * The virtual address of memory that should be used to store objects.
577 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
579 * The length of memory in bytes.
581 * Callback function to be executed for each populated object.
582 * @param[in] obj_cb_arg
583 * An opaque pointer passed to the callback function.
585 * The number of objects added in mempool.
587 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
588 unsigned int flags, unsigned int max_objs,
589 void *vaddr, rte_iova_t iova, size_t len,
590 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
593 * Default way to populate memory pool object using provided memory chunk.
595 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
596 * len, obj_cb, obj_cb_arg).
598 int rte_mempool_op_populate_default(struct rte_mempool *mp,
599 unsigned int max_objs,
600 void *vaddr, rte_iova_t iova, size_t len,
601 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
604 * Get some additional information about a mempool.
606 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
607 struct rte_mempool_info *info);
610 /** Structure defining mempool operations structure */
611 struct rte_mempool_ops {
612 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
613 rte_mempool_alloc_t alloc; /**< Allocate private data. */
614 rte_mempool_free_t free; /**< Free the external pool. */
615 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
616 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
617 rte_mempool_get_count get_count; /**< Get qty of available objs. */
619 * Optional callback to calculate memory size required to
620 * store specified number of objects.
622 rte_mempool_calc_mem_size_t calc_mem_size;
624 * Optional callback to populate mempool objects using
625 * provided memory chunk.
627 rte_mempool_populate_t populate;
631 rte_mempool_get_info_t get_info;
633 * Dequeue a number of contiguous object blocks.
635 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
636 } __rte_cache_aligned;
638 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
641 * Structure storing the table of registered ops structs, each of which contain
642 * the function pointers for the mempool ops functions.
643 * Each process has its own storage for this ops struct array so that
644 * the mempools can be shared across primary and secondary processes.
645 * The indices used to access the array are valid across processes, whereas
646 * any function pointers stored directly in the mempool struct would not be.
647 * This results in us simply having "ops_index" in the mempool struct.
649 struct rte_mempool_ops_table {
650 rte_spinlock_t sl; /**< Spinlock for add/delete. */
651 uint32_t num_ops; /**< Number of used ops structs in the table. */
653 * Storage for all possible ops structs.
655 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
656 } __rte_cache_aligned;
658 /** Array of registered ops structs. */
659 extern struct rte_mempool_ops_table rte_mempool_ops_table;
662 * @internal Get the mempool ops struct from its index.
665 * The index of the ops struct in the ops struct table. It must be a valid
666 * index: (0 <= idx < num_ops).
668 * The pointer to the ops struct in the table.
670 static inline struct rte_mempool_ops *
671 rte_mempool_get_ops(int ops_index)
673 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
675 return &rte_mempool_ops_table.ops[ops_index];
679 * @internal Wrapper for mempool_ops alloc callback.
682 * Pointer to the memory pool.
684 * - 0: Success; successfully allocated mempool pool_data.
685 * - <0: Error; code of alloc function.
688 rte_mempool_ops_alloc(struct rte_mempool *mp);
691 * @internal Wrapper for mempool_ops dequeue callback.
694 * Pointer to the memory pool.
696 * Pointer to a table of void * pointers (objects).
698 * Number of objects to get.
700 * - 0: Success; got n objects.
701 * - <0: Error; code of dequeue function.
704 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
705 void **obj_table, unsigned n)
707 struct rte_mempool_ops *ops;
710 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
711 ops = rte_mempool_get_ops(mp->ops_index);
712 ret = ops->dequeue(mp, obj_table, n);
714 __MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
715 __MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
721 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
724 * Pointer to the memory pool.
725 * @param[out] first_obj_table
726 * Pointer to a table of void * pointers (first objects).
728 * Number of blocks to get.
730 * - 0: Success; got n objects.
731 * - <0: Error; code of dequeue function.
734 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
735 void **first_obj_table, unsigned int n)
737 struct rte_mempool_ops *ops;
739 ops = rte_mempool_get_ops(mp->ops_index);
740 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
741 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
742 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
746 * @internal wrapper for mempool_ops enqueue callback.
749 * Pointer to the memory pool.
751 * Pointer to a table of void * pointers (objects).
753 * Number of objects to put.
755 * - 0: Success; n objects supplied.
756 * - <0: Error; code of enqueue function.
759 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
762 struct rte_mempool_ops *ops;
764 __MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
765 __MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
766 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
767 ops = rte_mempool_get_ops(mp->ops_index);
768 return ops->enqueue(mp, obj_table, n);
772 * @internal wrapper for mempool_ops get_count callback.
775 * Pointer to the memory pool.
777 * The number of available objects in the external pool.
780 rte_mempool_ops_get_count(const struct rte_mempool *mp);
783 * @internal wrapper for mempool_ops calc_mem_size callback.
784 * API to calculate size of memory required to store specified number of
788 * Pointer to the memory pool.
791 * @param[in] pg_shift
792 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
793 * @param[out] min_chunk_size
794 * Location for minimum size of the memory chunk which may be used to
795 * store memory pool objects.
797 * Location for required memory chunk alignment.
799 * Required memory size aligned at page boundary.
801 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
802 uint32_t obj_num, uint32_t pg_shift,
803 size_t *min_chunk_size, size_t *align);
806 * @internal wrapper for mempool_ops populate callback.
808 * Populate memory pool objects using provided memory chunk.
811 * A pointer to the mempool structure.
812 * @param[in] max_objs
813 * Maximum number of objects to be populated.
815 * The virtual address of memory that should be used to store objects.
819 * The length of memory in bytes.
821 * Callback function to be executed for each populated object.
822 * @param[in] obj_cb_arg
823 * An opaque pointer passed to the callback function.
825 * The number of objects added on success.
826 * On error, no objects are populated and a negative errno is returned.
828 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
829 void *vaddr, rte_iova_t iova, size_t len,
830 rte_mempool_populate_obj_cb_t *obj_cb,
834 * Wrapper for mempool_ops get_info callback.
837 * Pointer to the memory pool.
839 * Pointer to the rte_mempool_info structure
841 * - 0: Success; The mempool driver supports retrieving supplementary
842 * mempool information
843 * - -ENOTSUP - doesn't support get_info ops (valid case).
845 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
846 struct rte_mempool_info *info);
849 * @internal wrapper for mempool_ops free callback.
852 * Pointer to the memory pool.
855 rte_mempool_ops_free(struct rte_mempool *mp);
858 * Set the ops of a mempool.
860 * This can only be done on a mempool that is not populated, i.e. just after
861 * a call to rte_mempool_create_empty().
864 * Pointer to the memory pool.
866 * Name of the ops structure to use for this mempool.
868 * Opaque data that can be passed by the application to the ops functions.
870 * - 0: Success; the mempool is now using the requested ops functions.
871 * - -EINVAL - Invalid ops struct name provided.
872 * - -EEXIST - mempool already has an ops struct assigned.
875 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
879 * Register mempool operations.
882 * Pointer to an ops structure to register.
884 * - >=0: Success; return the index of the ops struct in the table.
885 * - -EINVAL - some missing callbacks while registering ops struct.
886 * - -ENOSPC - the maximum number of ops structs has been reached.
888 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
891 * Macro to statically register the ops of a mempool handler.
892 * Note that the rte_mempool_register_ops fails silently here when
893 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
895 #define MEMPOOL_REGISTER_OPS(ops) \
896 RTE_INIT(mp_hdlr_init_##ops) \
898 rte_mempool_register_ops(&ops); \
902 * An object callback function for mempool.
904 * Used by rte_mempool_create() and rte_mempool_obj_iter().
906 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
907 void *opaque, void *obj, unsigned obj_idx);
908 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
911 * A memory callback function for mempool.
913 * Used by rte_mempool_mem_iter().
915 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
916 void *opaque, struct rte_mempool_memhdr *memhdr,
920 * A mempool constructor callback function.
922 * Arguments are the mempool and the opaque pointer given by the user in
923 * rte_mempool_create().
925 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
928 * Create a new mempool named *name* in memory.
930 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
931 * pool contains n elements of elt_size. Its size is set to n.
934 * The name of the mempool.
936 * The number of elements in the mempool. The optimum size (in terms of
937 * memory usage) for a mempool is when n is a power of two minus one:
940 * The size of each element.
942 * If cache_size is non-zero, the rte_mempool library will try to
943 * limit the accesses to the common lockless pool, by maintaining a
944 * per-lcore object cache. This argument must be lower or equal to
945 * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
946 * cache_size to have "n modulo cache_size == 0": if this is
947 * not the case, some elements will always stay in the pool and will
948 * never be used. The access to the per-lcore table is of course
949 * faster than the multi-producer/consumer pool. The cache can be
950 * disabled if the cache_size argument is set to 0; it can be useful to
951 * avoid losing objects in cache.
952 * @param private_data_size
953 * The size of the private data appended after the mempool
954 * structure. This is useful for storing some private data after the
955 * mempool structure, as is done for rte_mbuf_pool for example.
957 * A function pointer that is called for initialization of the pool,
958 * before object initialization. The user can initialize the private
959 * data in this function if needed. This parameter can be NULL if
962 * An opaque pointer to data that can be used in the mempool
963 * constructor function.
965 * A function pointer that is called for each object at
966 * initialization of the pool. The user can set some meta data in
967 * objects if needed. This parameter can be NULL if not needed.
968 * The obj_init() function takes the mempool pointer, the init_arg,
969 * the object pointer and the object number as parameters.
970 * @param obj_init_arg
971 * An opaque pointer to data that can be used as an argument for
972 * each call to the object constructor function.
974 * The *socket_id* argument is the socket identifier in the case of
975 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
976 * constraint for the reserved zone.
978 * The *flags* arguments is an OR of following flags:
979 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
980 * between channels in RAM: the pool allocator will add padding
981 * between objects depending on the hardware configuration. See
982 * Memory alignment constraints for details. If this flag is set,
983 * the allocator will just align them to a cache line.
984 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
985 * cache-aligned. This flag removes this constraint, and no
986 * padding will be present between objects. This flag implies
987 * MEMPOOL_F_NO_SPREAD.
988 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
989 * when using rte_mempool_put() or rte_mempool_put_bulk() is
990 * "single-producer". Otherwise, it is "multi-producers".
991 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
992 * when using rte_mempool_get() or rte_mempool_get_bulk() is
993 * "single-consumer". Otherwise, it is "multi-consumers".
994 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
995 * necessarily be contiguous in IO memory.
997 * The pointer to the new allocated mempool, on success. NULL on error
998 * with rte_errno set appropriately. Possible rte_errno values include:
999 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1000 * - E_RTE_SECONDARY - function was called from a secondary process instance
1001 * - EINVAL - cache size provided is too large or an unknown flag was passed
1002 * - ENOSPC - the maximum number of memzones has already been allocated
1003 * - EEXIST - a memzone with the same name already exists
1004 * - ENOMEM - no appropriate memory area found in which to create memzone
1006 struct rte_mempool *
1007 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1008 unsigned cache_size, unsigned private_data_size,
1009 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1010 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1011 int socket_id, unsigned flags);
1014 * Create an empty mempool
1016 * The mempool is allocated and initialized, but it is not populated: no
1017 * memory is allocated for the mempool elements. The user has to call
1018 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1019 * populated, the user may also want to initialize each object with
1020 * rte_mempool_obj_iter().
1023 * The name of the mempool.
1025 * The maximum number of elements that can be added in the mempool.
1026 * The optimum size (in terms of memory usage) for a mempool is when n
1027 * is a power of two minus one: n = (2^q - 1).
1029 * The size of each element.
1031 * Size of the cache. See rte_mempool_create() for details.
1032 * @param private_data_size
1033 * The size of the private data appended after the mempool
1034 * structure. This is useful for storing some private data after the
1035 * mempool structure, as is done for rte_mbuf_pool for example.
1037 * The *socket_id* argument is the socket identifier in the case of
1038 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1039 * constraint for the reserved zone.
1041 * Flags controlling the behavior of the mempool. See
1042 * rte_mempool_create() for details.
1044 * The pointer to the new allocated mempool, on success. NULL on error
1045 * with rte_errno set appropriately. See rte_mempool_create() for details.
1047 struct rte_mempool *
1048 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1049 unsigned cache_size, unsigned private_data_size,
1050 int socket_id, unsigned flags);
1054 * Unlink the mempool from global list, free the memory chunks, and all
1055 * memory referenced by the mempool. The objects must not be used by
1056 * other cores as they will be freed.
1059 * A pointer to the mempool structure.
1062 rte_mempool_free(struct rte_mempool *mp);
1065 * Add physically contiguous memory for objects in the pool at init
1067 * Add a virtually and physically contiguous memory chunk in the pool
1068 * where objects can be instantiated.
1070 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1071 * the chunk doesn't need to be physically contiguous (only virtually),
1072 * and allocated objects may span two pages.
1075 * A pointer to the mempool structure.
1077 * The virtual address of memory that should be used to store objects.
1081 * The length of memory in bytes.
1083 * The callback used to free this chunk when destroying the mempool.
1085 * An opaque argument passed to free_cb.
1087 * The number of objects added on success (strictly positive).
1088 * On error, the chunk is not added in the memory list of the
1089 * mempool the following code is returned:
1090 * (0): not enough room in chunk for one object.
1091 * (-ENOSPC): mempool is already populated.
1092 * (-ENOMEM): allocation failure.
1094 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1095 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1099 * Add virtually contiguous memory for objects in the pool at init
1101 * Add a virtually contiguous memory chunk in the pool where objects can
1105 * A pointer to the mempool structure.
1107 * The virtual address of memory that should be used to store objects.
1109 * The length of memory in bytes.
1111 * The size of memory pages in this virtual area.
1113 * The callback used to free this chunk when destroying the mempool.
1115 * An opaque argument passed to free_cb.
1117 * The number of objects added on success (strictly positive).
1118 * On error, the chunk is not added in the memory list of the
1119 * mempool the following code is returned:
1120 * (0): not enough room in chunk for one object.
1121 * (-ENOSPC): mempool is already populated.
1122 * (-ENOMEM): allocation failure.
1125 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1126 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1130 * Add memory for objects in the pool at init
1132 * This is the default function used by rte_mempool_create() to populate
1133 * the mempool. It adds memory allocated using rte_memzone_reserve().
1136 * A pointer to the mempool structure.
1138 * The number of objects added on success.
1139 * On error, the chunk is not added in the memory list of the
1140 * mempool and a negative errno is returned.
1142 int rte_mempool_populate_default(struct rte_mempool *mp);
1145 * Add memory from anonymous mapping for objects in the pool at init
1147 * This function mmap an anonymous memory zone that is locked in
1148 * memory to store the objects of the mempool.
1151 * A pointer to the mempool structure.
1153 * The number of objects added on success.
1154 * On error, 0 is returned, rte_errno is set, and the chunk is not added in
1155 * the memory list of the mempool.
1157 int rte_mempool_populate_anon(struct rte_mempool *mp);
1160 * Call a function for each mempool element
1162 * Iterate across all objects attached to a rte_mempool and call the
1163 * callback function on it.
1166 * A pointer to an initialized mempool.
1168 * A function pointer that is called for each object.
1170 * An opaque pointer passed to the callback function.
1172 * Number of objects iterated.
1174 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1175 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1178 * Call a function for each mempool memory chunk
1180 * Iterate across all memory chunks attached to a rte_mempool and call
1181 * the callback function on it.
1184 * A pointer to an initialized mempool.
1186 * A function pointer that is called for each memory chunk.
1188 * An opaque pointer passed to the callback function.
1190 * Number of memory chunks iterated.
1192 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1193 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1196 * Dump the status of the mempool to a file.
1199 * A pointer to a file for output
1201 * A pointer to the mempool structure.
1203 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1206 * Create a user-owned mempool cache.
1208 * This can be used by unregistered non-EAL threads to enable caching when they
1209 * interact with a mempool.
1212 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1213 * parameter description for more information. The same limits and
1214 * considerations apply here too.
1216 * The socket identifier in the case of NUMA. The value can be
1217 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1219 struct rte_mempool_cache *
1220 rte_mempool_cache_create(uint32_t size, int socket_id);
1223 * Free a user-owned mempool cache.
1226 * A pointer to the mempool cache.
1229 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1232 * Get a pointer to the per-lcore default mempool cache.
1235 * A pointer to the mempool structure.
1237 * The logical core id.
1239 * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
1242 static __rte_always_inline struct rte_mempool_cache *
1243 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1245 if (mp->cache_size == 0)
1248 if (lcore_id >= RTE_MAX_LCORE)
1251 rte_mempool_trace_default_cache(mp, lcore_id,
1252 &mp->local_cache[lcore_id]);
1253 return &mp->local_cache[lcore_id];
1257 * Flush a user-owned mempool cache to the specified mempool.
1260 * A pointer to the mempool cache.
1262 * A pointer to the mempool.
1264 static __rte_always_inline void
1265 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1266 struct rte_mempool *mp)
1269 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1270 if (cache == NULL || cache->len == 0)
1272 rte_mempool_trace_cache_flush(cache, mp);
1273 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1278 * @internal Put several objects back in the mempool; used internally.
1280 * A pointer to the mempool structure.
1282 * A pointer to a table of void * pointers (objects).
1284 * The number of objects to store back in the mempool, must be strictly
1287 * A pointer to a mempool cache structure. May be NULL if not needed.
1289 static __rte_always_inline void
1290 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1291 unsigned int n, struct rte_mempool_cache *cache)
1295 /* increment stat now, adding in mempool always success */
1296 __MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1297 __MEMPOOL_STAT_ADD(mp, put_objs, n);
1299 /* No cache provided or if put would overflow mem allocated for cache */
1300 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1303 cache_objs = &cache->objs[cache->len];
1306 * The cache follows the following algorithm
1307 * 1. Add the objects to the cache
1308 * 2. Anything greater than the cache min value (if it crosses the
1309 * cache flush threshold) is flushed to the ring.
1312 /* Add elements back into the cache */
1313 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1317 if (cache->len >= cache->flushthresh) {
1318 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1319 cache->len - cache->size);
1320 cache->len = cache->size;
1327 /* push remaining objects in ring */
1328 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1329 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1330 rte_panic("cannot put objects in mempool\n");
1332 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1338 * Put several objects back in the mempool.
1341 * A pointer to the mempool structure.
1343 * A pointer to a table of void * pointers (objects).
1345 * The number of objects to add in the mempool from the obj_table.
1347 * A pointer to a mempool cache structure. May be NULL if not needed.
1349 static __rte_always_inline void
1350 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1351 unsigned int n, struct rte_mempool_cache *cache)
1353 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1354 __mempool_check_cookies(mp, obj_table, n, 0);
1355 __mempool_generic_put(mp, obj_table, n, cache);
1359 * Put several objects back in the mempool.
1361 * This function calls the multi-producer or the single-producer
1362 * version depending on the default behavior that was specified at
1363 * mempool creation time (see flags).
1366 * A pointer to the mempool structure.
1368 * A pointer to a table of void * pointers (objects).
1370 * The number of objects to add in the mempool from obj_table.
1372 static __rte_always_inline void
1373 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1376 struct rte_mempool_cache *cache;
1377 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1378 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1379 rte_mempool_generic_put(mp, obj_table, n, cache);
1383 * Put one object back in the mempool.
1385 * This function calls the multi-producer or the single-producer
1386 * version depending on the default behavior that was specified at
1387 * mempool creation time (see flags).
1390 * A pointer to the mempool structure.
1392 * A pointer to the object to be added.
1394 static __rte_always_inline void
1395 rte_mempool_put(struct rte_mempool *mp, void *obj)
1397 rte_mempool_put_bulk(mp, &obj, 1);
1401 * @internal Get several objects from the mempool; used internally.
1403 * A pointer to the mempool structure.
1405 * A pointer to a table of void * pointers (objects).
1407 * The number of objects to get, must be strictly positive.
1409 * A pointer to a mempool cache structure. May be NULL if not needed.
1411 * - >=0: Success; number of objects supplied.
1412 * - <0: Error; code of ring dequeue function.
1414 static __rte_always_inline int
1415 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1416 unsigned int n, struct rte_mempool_cache *cache)
1419 uint32_t index, len;
1422 /* No cache provided or cannot be satisfied from cache */
1423 if (unlikely(cache == NULL || n >= cache->size))
1426 cache_objs = cache->objs;
1428 /* Can this be satisfied from the cache? */
1429 if (cache->len < n) {
1430 /* No. Backfill the cache first, and then fill from it */
1431 uint32_t req = n + (cache->size - cache->len);
1433 /* How many do we require i.e. number to fill the cache + the request */
1434 ret = rte_mempool_ops_dequeue_bulk(mp,
1435 &cache->objs[cache->len], req);
1436 if (unlikely(ret < 0)) {
1438 * In the off chance that we are buffer constrained,
1439 * where we are not able to allocate cache + n, go to
1440 * the ring directly. If that fails, we are truly out of
1449 /* Now fill in the response ... */
1450 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1451 *obj_table = cache_objs[len];
1455 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1456 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1462 /* get remaining objects from ring */
1463 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1466 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1467 __MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1469 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1470 __MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1477 * Get several objects from the mempool.
1479 * If cache is enabled, objects will be retrieved first from cache,
1480 * subsequently from the common pool. Note that it can return -ENOENT when
1481 * the local cache and common pool are empty, even if cache from other
1485 * A pointer to the mempool structure.
1487 * A pointer to a table of void * pointers (objects) that will be filled.
1489 * The number of objects to get from mempool to obj_table.
1491 * A pointer to a mempool cache structure. May be NULL if not needed.
1493 * - 0: Success; objects taken.
1494 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1496 static __rte_always_inline int
1497 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1498 unsigned int n, struct rte_mempool_cache *cache)
1501 ret = __mempool_generic_get(mp, obj_table, n, cache);
1503 __mempool_check_cookies(mp, obj_table, n, 1);
1504 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1509 * Get several objects from the mempool.
1511 * This function calls the multi-consumers or the single-consumer
1512 * version, depending on the default behaviour that was specified at
1513 * mempool creation time (see flags).
1515 * If cache is enabled, objects will be retrieved first from cache,
1516 * subsequently from the common pool. Note that it can return -ENOENT when
1517 * the local cache and common pool are empty, even if cache from other
1521 * A pointer to the mempool structure.
1523 * A pointer to a table of void * pointers (objects) that will be filled.
1525 * The number of objects to get from the mempool to obj_table.
1527 * - 0: Success; objects taken
1528 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1530 static __rte_always_inline int
1531 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1533 struct rte_mempool_cache *cache;
1534 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1535 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1536 return rte_mempool_generic_get(mp, obj_table, n, cache);
1540 * Get one object from the mempool.
1542 * This function calls the multi-consumers or the single-consumer
1543 * version, depending on the default behavior that was specified at
1544 * mempool creation (see flags).
1546 * If cache is enabled, objects will be retrieved first from cache,
1547 * subsequently from the common pool. Note that it can return -ENOENT when
1548 * the local cache and common pool are empty, even if cache from other
1552 * A pointer to the mempool structure.
1554 * A pointer to a void * pointer (object) that will be filled.
1556 * - 0: Success; objects taken.
1557 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1559 static __rte_always_inline int
1560 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1562 return rte_mempool_get_bulk(mp, obj_p, 1);
1566 * Get a contiguous blocks of objects from the mempool.
1568 * If cache is enabled, consider to flush it first, to reuse objects
1569 * as soon as possible.
1571 * The application should check that the driver supports the operation
1572 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1576 * A pointer to the mempool structure.
1577 * @param first_obj_table
1578 * A pointer to a pointer to the first object in each block.
1580 * The number of blocks to get from mempool.
1582 * - 0: Success; blocks taken.
1583 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1584 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1586 static __rte_always_inline int
1587 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1588 void **first_obj_table, unsigned int n)
1592 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1594 __MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1595 __MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1596 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1599 __MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1600 __MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1603 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1608 * Return the number of entries in the mempool.
1610 * When cache is enabled, this function has to browse the length of
1611 * all lcores, so it should not be used in a data path, but only for
1612 * debug purposes. User-owned mempool caches are not accounted for.
1615 * A pointer to the mempool structure.
1617 * The number of entries in the mempool.
1619 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1622 * Return the number of elements which have been allocated from the mempool
1624 * When cache is enabled, this function has to browse the length of
1625 * all lcores, so it should not be used in a data path, but only for
1629 * A pointer to the mempool structure.
1631 * The number of free entries in the mempool.
1634 rte_mempool_in_use_count(const struct rte_mempool *mp);
1637 * Test if the mempool is full.
1639 * When cache is enabled, this function has to browse the length of all
1640 * lcores, so it should not be used in a data path, but only for debug
1641 * purposes. User-owned mempool caches are not accounted for.
1644 * A pointer to the mempool structure.
1646 * - 1: The mempool is full.
1647 * - 0: The mempool is not full.
1650 rte_mempool_full(const struct rte_mempool *mp)
1652 return rte_mempool_avail_count(mp) == mp->size;
1656 * Test if the mempool is empty.
1658 * When cache is enabled, this function has to browse the length of all
1659 * lcores, so it should not be used in a data path, but only for debug
1660 * purposes. User-owned mempool caches are not accounted for.
1663 * A pointer to the mempool structure.
1665 * - 1: The mempool is empty.
1666 * - 0: The mempool is not empty.
1669 rte_mempool_empty(const struct rte_mempool *mp)
1671 return rte_mempool_avail_count(mp) == 0;
1675 * Return the IO address of elt, which is an element of the pool mp.
1678 * A pointer (virtual address) to the element of the pool.
1680 * The IO address of the elt element.
1681 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1682 * returned value is RTE_BAD_IOVA.
1684 static inline rte_iova_t
1685 rte_mempool_virt2iova(const void *elt)
1687 const struct rte_mempool_objhdr *hdr;
1688 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1694 * Check the consistency of mempool objects.
1696 * Verify the coherency of fields in the mempool structure. Also check
1697 * that the cookies of mempool objects (even the ones that are not
1698 * present in pool) have a correct value. If not, a panic will occur.
1701 * A pointer to the mempool structure.
1703 void rte_mempool_audit(struct rte_mempool *mp);
1706 * Return a pointer to the private data in an mempool structure.
1709 * A pointer to the mempool structure.
1711 * A pointer to the private data.
1713 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1716 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1720 * Dump the status of all mempools on the console
1723 * A pointer to a file for output
1725 void rte_mempool_list_dump(FILE *f);
1728 * Search a mempool from its name
1731 * The name of the mempool.
1733 * The pointer to the mempool matching the name, or NULL if not found.
1735 * with rte_errno set appropriately. Possible rte_errno values include:
1736 * - ENOENT - required entry not available to return.
1739 struct rte_mempool *rte_mempool_lookup(const char *name);
1742 * Get the header, trailer and total size of a mempool element.
1744 * Given a desired size of the mempool element and mempool flags,
1745 * calculates header, trailer, body and total sizes of the mempool object.
1748 * The size of each element, without header and trailer.
1750 * The flags used for the mempool creation.
1751 * Consult rte_mempool_create() for more information about possible values.
1752 * The size of each element.
1754 * The calculated detailed size the mempool object. May be NULL.
1756 * Total size of the mempool object.
1758 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1759 struct rte_mempool_objsz *sz);
1762 * Walk list of all memory pools
1767 * Argument passed to iterator
1769 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1773 * @internal Get page size used for mempool object allocation.
1774 * This function is internal to mempool library and mempool drivers.
1777 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1780 * Mempool event type.
1783 enum rte_mempool_event {
1784 /** Occurs after a mempool is fully populated. */
1785 RTE_MEMPOOL_EVENT_READY = 0,
1786 /** Occurs before the destruction of a mempool begins. */
1787 RTE_MEMPOOL_EVENT_DESTROY = 1,
1792 * Mempool event callback.
1794 * rte_mempool_event_callback_register() may be called from within the callback,
1795 * but the callbacks registered this way will not be invoked for the same event.
1796 * rte_mempool_event_callback_unregister() may only be safely called
1797 * to remove the running callback.
1799 typedef void (rte_mempool_event_callback)(
1800 enum rte_mempool_event event,
1801 struct rte_mempool *mp,
1806 * Register a callback function invoked on mempool life cycle event.
1807 * The function will be invoked in the process
1808 * that performs an action which triggers the callback.
1811 * Callback function.
1816 * 0 on success, negative on failure and rte_errno is set.
1820 rte_mempool_event_callback_register(rte_mempool_event_callback *func,
1825 * Unregister a callback added with rte_mempool_event_callback_register().
1826 * @p func and @p user_data must exactly match registration parameters.
1829 * Callback function.
1834 * 0 on success, negative on failure and rte_errno is set.
1838 rte_mempool_event_callback_unregister(rte_mempool_event_callback *func,
1845 #endif /* _RTE_MEMPOOL_H_ */