1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright(c) 2016 6WIND S.A.
6 #ifndef _RTE_MEMPOOL_H_
7 #define _RTE_MEMPOOL_H_
13 * A memory pool is an allocator of fixed-size object. It is
14 * identified by its name, and uses a ring to store free objects. It
15 * provides some other optional services, like a per-core object
16 * cache, and an alignment helper to ensure that objects are padded
17 * to spread them equally on all RAM channels, ranks, and so on.
19 * Objects owned by a mempool should never be added in another
20 * mempool. When an object is freed using rte_mempool_put() or
21 * equivalent, the object data is not modified; the user can save some
22 * meta-data in the object data and retrieve them when allocating a
25 * Note: the mempool implementation is not preemptible. An lcore must not be
26 * interrupted by another task that uses the same mempool (because it uses a
27 * ring which is not preemptible). Also, usual mempool functions like
28 * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
29 * thread due to the internal per-lcore cache. Due to the lack of caching,
30 * rte_mempool_get() or rte_mempool_put() performance will suffer when called
31 * by non-EAL threads. Instead, non-EAL threads should call
32 * rte_mempool_generic_get() or rte_mempool_generic_put() with a user cache
33 * created with rte_mempool_cache_create().
41 #include <sys/queue.h>
43 #include <rte_config.h>
44 #include <rte_spinlock.h>
46 #include <rte_debug.h>
47 #include <rte_lcore.h>
48 #include <rte_memory.h>
49 #include <rte_branch_prediction.h>
51 #include <rte_memcpy.h>
52 #include <rte_common.h>
58 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
59 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
60 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
62 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
64 * A structure that stores the mempool statistics (per-lcore).
66 struct rte_mempool_debug_stats {
67 uint64_t put_bulk; /**< Number of puts. */
68 uint64_t put_objs; /**< Number of objects successfully put. */
69 uint64_t get_success_bulk; /**< Successful allocation number. */
70 uint64_t get_success_objs; /**< Objects successfully allocated. */
71 uint64_t get_fail_bulk; /**< Failed allocation number. */
72 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
73 } __rte_cache_aligned;
77 * A structure that stores a per-core object cache.
79 struct rte_mempool_cache {
80 uint32_t size; /**< Size of the cache */
81 uint32_t flushthresh; /**< Threshold before we flush excess elements */
82 uint32_t len; /**< Current cache count */
84 * Cache is allocated to this size to allow it to overflow in certain
85 * cases to avoid needless emptying of cache.
87 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
88 } __rte_cache_aligned;
91 * A structure that stores the size of mempool elements.
93 struct rte_mempool_objsz {
94 uint32_t elt_size; /**< Size of an element. */
95 uint32_t header_size; /**< Size of header (before elt). */
96 uint32_t trailer_size; /**< Size of trailer (after elt). */
98 /**< Total size of an object (header + elt + trailer). */
101 /**< Maximum length of a memory pool's name. */
102 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
103 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
104 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
107 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
109 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
111 /** Mempool over one chunk of physically continuous memory */
112 #define MEMPOOL_PG_NUM_DEFAULT 1
114 #ifndef RTE_MEMPOOL_ALIGN
115 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
118 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
121 * Mempool object header structure
123 * Each object stored in mempools are prefixed by this header structure,
124 * it allows to retrieve the mempool pointer from the object and to
125 * iterate on all objects attached to a mempool. When debug is enabled,
126 * a cookie is also added in this structure preventing corruptions and
129 struct rte_mempool_objhdr {
130 STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
131 struct rte_mempool *mp; /**< The mempool owning the object. */
134 rte_iova_t iova; /**< IO address of the object. */
135 phys_addr_t physaddr; /**< deprecated - Physical address of the object. */
137 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
138 uint64_t cookie; /**< Debug cookie. */
143 * A list of object headers type
145 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
147 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
150 * Mempool object trailer structure
152 * In debug mode, each object stored in mempools are suffixed by this
153 * trailer structure containing a cookie preventing memory corruptions.
155 struct rte_mempool_objtlr {
156 uint64_t cookie; /**< Debug cookie. */
162 * A list of memory where objects are stored
164 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
167 * Callback used to free a memory chunk
169 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
173 * Mempool objects memory header structure
175 * The memory chunks where objects are stored. Each chunk is virtually
176 * and physically contiguous.
178 struct rte_mempool_memhdr {
179 STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
180 struct rte_mempool *mp; /**< The mempool owning the chunk */
181 void *addr; /**< Virtual address of the chunk */
184 rte_iova_t iova; /**< IO address of the chunk */
185 phys_addr_t phys_addr; /**< Physical address of the chunk */
187 size_t len; /**< length of the chunk */
188 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
189 void *opaque; /**< Argument passed to the free callback */
193 * The RTE mempool structure.
197 * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
198 * compatibility requirements, it could be changed to
199 * RTE_MEMPOOL_NAMESIZE next time the ABI changes
201 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
204 void *pool_data; /**< Ring or pool to store objects. */
205 uint64_t pool_id; /**< External mempool identifier. */
207 void *pool_config; /**< optional args for ops alloc. */
208 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
209 unsigned int flags; /**< Flags of the mempool. */
210 int socket_id; /**< Socket id passed at create. */
211 uint32_t size; /**< Max size of the mempool. */
213 /**< Size of per-lcore default local cache. */
215 uint32_t elt_size; /**< Size of an element. */
216 uint32_t header_size; /**< Size of header (before elt). */
217 uint32_t trailer_size; /**< Size of trailer (after elt). */
219 unsigned private_data_size; /**< Size of private data. */
221 * Index into rte_mempool_ops_table array of mempool ops
222 * structs, which contain callback function pointers.
223 * We're using an index here rather than pointers to the callbacks
224 * to facilitate any secondary processes that may want to use
229 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
231 uint32_t populated_size; /**< Number of populated objects. */
232 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
233 uint32_t nb_mem_chunks; /**< Number of memory chunks */
234 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
236 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
237 /** Per-lcore statistics. */
238 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
240 } __rte_cache_aligned;
242 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread among memory channels. */
243 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
244 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
245 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
246 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
247 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
248 #define MEMPOOL_F_NO_PHYS_CONTIG MEMPOOL_F_NO_IOVA_CONTIG /* deprecated */
251 * @internal When debug is enabled, store some statistics.
254 * Pointer to the memory pool.
256 * Name of the statistics field to increment in the memory pool.
258 * Number to add to the object-oriented statistics.
260 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
261 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
262 unsigned __lcore_id = rte_lcore_id(); \
263 if (__lcore_id < RTE_MAX_LCORE) { \
264 mp->stats[__lcore_id].name##_objs += n; \
265 mp->stats[__lcore_id].name##_bulk += 1; \
269 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
273 * Calculate the size of the mempool header.
276 * Pointer to the memory pool.
278 * Size of the per-lcore cache.
280 #define MEMPOOL_HEADER_SIZE(mp, cs) \
281 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
282 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
284 /* return the header of a mempool object (internal) */
285 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
287 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
288 sizeof(struct rte_mempool_objhdr));
292 * Return a pointer to the mempool owning this object.
295 * An object that is owned by a pool. If this is not the case,
296 * the behavior is undefined.
298 * A pointer to the mempool structure.
300 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
302 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
306 /* return the trailer of a mempool object (internal) */
307 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
309 struct rte_mempool *mp = rte_mempool_from_obj(obj);
310 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
314 * @internal Check and update cookies or panic.
317 * Pointer to the memory pool.
318 * @param obj_table_const
319 * Pointer to a table of void * pointers (objects).
321 * Index of object in object table.
323 * - 0: object is supposed to be allocated, mark it as free
324 * - 1: object is supposed to be free, mark it as allocated
325 * - 2: just check that cookie is valid (free or allocated)
327 void rte_mempool_check_cookies(const struct rte_mempool *mp,
328 void * const *obj_table_const, unsigned n, int free);
330 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
331 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
332 rte_mempool_check_cookies(mp, obj_table_const, n, free)
334 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
335 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
337 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
340 * Prototype for implementation specific data provisioning function.
342 * The function should provide the implementation specific memory for
343 * use by the other mempool ops functions in a given mempool ops struct.
344 * E.g. the default ops provides an instance of the rte_ring for this purpose.
345 * it will most likely point to a different type of data structure, and
346 * will be transparent to the application programmer.
347 * This function should set mp->pool_data.
349 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
352 * Free the opaque private data pointed to by mp->pool_data pointer.
354 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
357 * Enqueue an object into the external pool.
359 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
360 void * const *obj_table, unsigned int n);
363 * Dequeue an object from the external pool.
365 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
366 void **obj_table, unsigned int n);
369 * Return the number of available objects in the external pool.
371 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
374 * Calculate memory size required to store given number of objects.
376 * If mempool objects are not required to be IOVA-contiguous
377 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
378 * virtually contiguous chunk size. Otherwise, if mempool objects must
379 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
380 * min_chunk_size defines IOVA-contiguous chunk size.
383 * Pointer to the memory pool.
386 * @param[in] pg_shift
387 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
388 * @param[out] min_chunk_size
389 * Location for minimum size of the memory chunk which may be used to
390 * store memory pool objects.
392 * Location for required memory chunk alignment.
394 * Required memory size aligned at page boundary.
396 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
397 uint32_t obj_num, uint32_t pg_shift,
398 size_t *min_chunk_size, size_t *align);
401 * Default way to calculate memory size required to store given number of
404 * If page boundaries may be ignored, it is just a product of total
405 * object size including header and trailer and number of objects.
406 * Otherwise, it is a number of pages required to store given number of
407 * objects without crossing page boundary.
409 * Note that if object size is bigger than page size, then it assumes
410 * that pages are grouped in subsets of physically continuous pages big
411 * enough to store at least one object.
413 * Minimum size of memory chunk is a maximum of the page size and total
416 * Required memory chunk alignment is a maximum of page size and cache
419 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
420 uint32_t obj_num, uint32_t pg_shift,
421 size_t *min_chunk_size, size_t *align);
424 * @internal Helper function to calculate memory size required to store
425 * specified number of objects in assumption that the memory buffer will
426 * be aligned at page boundary.
428 * Note that if object size is bigger than page size, then it assumes
429 * that pages are grouped in subsets of physically continuous pages big
430 * enough to store at least one object.
433 * Number of elements.
434 * @param total_elt_sz
435 * The size of each element, including header and trailer, as returned
436 * by rte_mempool_calc_obj_size().
438 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
440 * Required memory size aligned at page boundary.
442 size_t rte_mempool_calc_mem_size_helper(uint32_t elt_num, size_t total_elt_sz,
446 * Function to be called for each populated object.
449 * A pointer to the mempool structure.
451 * An opaque pointer passed to iterator.
453 * Object virtual address.
455 * Input/output virtual address of the object or RTE_BAD_IOVA.
457 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
458 void *opaque, void *vaddr, rte_iova_t iova);
461 * Populate memory pool objects using provided memory chunk.
463 * Populated objects should be enqueued to the pool, e.g. using
464 * rte_mempool_ops_enqueue_bulk().
466 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
467 * the chunk doesn't need to be physically contiguous (only virtually),
468 * and allocated objects may span two pages.
471 * A pointer to the mempool structure.
472 * @param[in] max_objs
473 * Maximum number of objects to be populated.
475 * The virtual address of memory that should be used to store objects.
479 * The length of memory in bytes.
481 * Callback function to be executed for each populated object.
482 * @param[in] obj_cb_arg
483 * An opaque pointer passed to the callback function.
485 * The number of objects added on success.
486 * On error, no objects are populated and a negative errno is returned.
488 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
489 unsigned int max_objs,
490 void *vaddr, rte_iova_t iova, size_t len,
491 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
494 * Default way to populate memory pool object using provided memory
495 * chunk: just slice objects one by one.
497 int rte_mempool_op_populate_default(struct rte_mempool *mp,
498 unsigned int max_objs,
499 void *vaddr, rte_iova_t iova, size_t len,
500 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
502 /** Structure defining mempool operations structure */
503 struct rte_mempool_ops {
504 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
505 rte_mempool_alloc_t alloc; /**< Allocate private data. */
506 rte_mempool_free_t free; /**< Free the external pool. */
507 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
508 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
509 rte_mempool_get_count get_count; /**< Get qty of available objs. */
511 * Optional callback to calculate memory size required to
512 * store specified number of objects.
514 rte_mempool_calc_mem_size_t calc_mem_size;
516 * Optional callback to populate mempool objects using
517 * provided memory chunk.
519 rte_mempool_populate_t populate;
520 } __rte_cache_aligned;
522 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
525 * Structure storing the table of registered ops structs, each of which contain
526 * the function pointers for the mempool ops functions.
527 * Each process has its own storage for this ops struct array so that
528 * the mempools can be shared across primary and secondary processes.
529 * The indices used to access the array are valid across processes, whereas
530 * any function pointers stored directly in the mempool struct would not be.
531 * This results in us simply having "ops_index" in the mempool struct.
533 struct rte_mempool_ops_table {
534 rte_spinlock_t sl; /**< Spinlock for add/delete. */
535 uint32_t num_ops; /**< Number of used ops structs in the table. */
537 * Storage for all possible ops structs.
539 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
540 } __rte_cache_aligned;
542 /** Array of registered ops structs. */
543 extern struct rte_mempool_ops_table rte_mempool_ops_table;
546 * @internal Get the mempool ops struct from its index.
549 * The index of the ops struct in the ops struct table. It must be a valid
550 * index: (0 <= idx < num_ops).
552 * The pointer to the ops struct in the table.
554 static inline struct rte_mempool_ops *
555 rte_mempool_get_ops(int ops_index)
557 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
559 return &rte_mempool_ops_table.ops[ops_index];
563 * @internal Wrapper for mempool_ops alloc callback.
566 * Pointer to the memory pool.
568 * - 0: Success; successfully allocated mempool pool_data.
569 * - <0: Error; code of alloc function.
572 rte_mempool_ops_alloc(struct rte_mempool *mp);
575 * @internal Wrapper for mempool_ops dequeue callback.
578 * Pointer to the memory pool.
580 * Pointer to a table of void * pointers (objects).
582 * Number of objects to get.
584 * - 0: Success; got n objects.
585 * - <0: Error; code of dequeue function.
588 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
589 void **obj_table, unsigned n)
591 struct rte_mempool_ops *ops;
593 ops = rte_mempool_get_ops(mp->ops_index);
594 return ops->dequeue(mp, obj_table, n);
598 * @internal wrapper for mempool_ops enqueue callback.
601 * Pointer to the memory pool.
603 * Pointer to a table of void * pointers (objects).
605 * Number of objects to put.
607 * - 0: Success; n objects supplied.
608 * - <0: Error; code of enqueue function.
611 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
614 struct rte_mempool_ops *ops;
616 ops = rte_mempool_get_ops(mp->ops_index);
617 return ops->enqueue(mp, obj_table, n);
621 * @internal wrapper for mempool_ops get_count callback.
624 * Pointer to the memory pool.
626 * The number of available objects in the external pool.
629 rte_mempool_ops_get_count(const struct rte_mempool *mp);
632 * @internal wrapper for mempool_ops calc_mem_size callback.
633 * API to calculate size of memory required to store specified number of
637 * Pointer to the memory pool.
640 * @param[in] pg_shift
641 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
642 * @param[out] min_chunk_size
643 * Location for minimum size of the memory chunk which may be used to
644 * store memory pool objects.
646 * Location for required memory chunk alignment.
648 * Required memory size aligned at page boundary.
650 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
651 uint32_t obj_num, uint32_t pg_shift,
652 size_t *min_chunk_size, size_t *align);
655 * @internal wrapper for mempool_ops populate callback.
657 * Populate memory pool objects using provided memory chunk.
660 * A pointer to the mempool structure.
661 * @param[in] max_objs
662 * Maximum number of objects to be populated.
664 * The virtual address of memory that should be used to store objects.
668 * The length of memory in bytes.
670 * Callback function to be executed for each populated object.
671 * @param[in] obj_cb_arg
672 * An opaque pointer passed to the callback function.
674 * The number of objects added on success.
675 * On error, no objects are populated and a negative errno is returned.
677 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
678 void *vaddr, rte_iova_t iova, size_t len,
679 rte_mempool_populate_obj_cb_t *obj_cb,
683 * @internal wrapper for mempool_ops free callback.
686 * Pointer to the memory pool.
689 rte_mempool_ops_free(struct rte_mempool *mp);
692 * Set the ops of a mempool.
694 * This can only be done on a mempool that is not populated, i.e. just after
695 * a call to rte_mempool_create_empty().
698 * Pointer to the memory pool.
700 * Name of the ops structure to use for this mempool.
702 * Opaque data that can be passed by the application to the ops functions.
704 * - 0: Success; the mempool is now using the requested ops functions.
705 * - -EINVAL - Invalid ops struct name provided.
706 * - -EEXIST - mempool already has an ops struct assigned.
709 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
713 * Register mempool operations.
716 * Pointer to an ops structure to register.
718 * - >=0: Success; return the index of the ops struct in the table.
719 * - -EINVAL - some missing callbacks while registering ops struct.
720 * - -ENOSPC - the maximum number of ops structs has been reached.
722 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
725 * Macro to statically register the ops of a mempool handler.
726 * Note that the rte_mempool_register_ops fails silently here when
727 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
729 #define MEMPOOL_REGISTER_OPS(ops) \
730 void mp_hdlr_init_##ops(void); \
731 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
733 rte_mempool_register_ops(&ops); \
737 * An object callback function for mempool.
739 * Used by rte_mempool_create() and rte_mempool_obj_iter().
741 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
742 void *opaque, void *obj, unsigned obj_idx);
743 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
746 * A memory callback function for mempool.
748 * Used by rte_mempool_mem_iter().
750 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
751 void *opaque, struct rte_mempool_memhdr *memhdr,
755 * A mempool constructor callback function.
757 * Arguments are the mempool and the opaque pointer given by the user in
758 * rte_mempool_create().
760 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
763 * Create a new mempool named *name* in memory.
765 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
766 * pool contains n elements of elt_size. Its size is set to n.
769 * The name of the mempool.
771 * The number of elements in the mempool. The optimum size (in terms of
772 * memory usage) for a mempool is when n is a power of two minus one:
775 * The size of each element.
777 * If cache_size is non-zero, the rte_mempool library will try to
778 * limit the accesses to the common lockless pool, by maintaining a
779 * per-lcore object cache. This argument must be lower or equal to
780 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
781 * cache_size to have "n modulo cache_size == 0": if this is
782 * not the case, some elements will always stay in the pool and will
783 * never be used. The access to the per-lcore table is of course
784 * faster than the multi-producer/consumer pool. The cache can be
785 * disabled if the cache_size argument is set to 0; it can be useful to
786 * avoid losing objects in cache.
787 * @param private_data_size
788 * The size of the private data appended after the mempool
789 * structure. This is useful for storing some private data after the
790 * mempool structure, as is done for rte_mbuf_pool for example.
792 * A function pointer that is called for initialization of the pool,
793 * before object initialization. The user can initialize the private
794 * data in this function if needed. This parameter can be NULL if
797 * An opaque pointer to data that can be used in the mempool
798 * constructor function.
800 * A function pointer that is called for each object at
801 * initialization of the pool. The user can set some meta data in
802 * objects if needed. This parameter can be NULL if not needed.
803 * The obj_init() function takes the mempool pointer, the init_arg,
804 * the object pointer and the object number as parameters.
805 * @param obj_init_arg
806 * An opaque pointer to data that can be used as an argument for
807 * each call to the object constructor function.
809 * The *socket_id* argument is the socket identifier in the case of
810 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
811 * constraint for the reserved zone.
813 * The *flags* arguments is an OR of following flags:
814 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
815 * between channels in RAM: the pool allocator will add padding
816 * between objects depending on the hardware configuration. See
817 * Memory alignment constraints for details. If this flag is set,
818 * the allocator will just align them to a cache line.
819 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
820 * cache-aligned. This flag removes this constraint, and no
821 * padding will be present between objects. This flag implies
822 * MEMPOOL_F_NO_SPREAD.
823 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
824 * when using rte_mempool_put() or rte_mempool_put_bulk() is
825 * "single-producer". Otherwise, it is "multi-producers".
826 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
827 * when using rte_mempool_get() or rte_mempool_get_bulk() is
828 * "single-consumer". Otherwise, it is "multi-consumers".
829 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
830 * necessarily be contiguous in IO memory.
832 * The pointer to the new allocated mempool, on success. NULL on error
833 * with rte_errno set appropriately. Possible rte_errno values include:
834 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
835 * - E_RTE_SECONDARY - function was called from a secondary process instance
836 * - EINVAL - cache size provided is too large
837 * - ENOSPC - the maximum number of memzones has already been allocated
838 * - EEXIST - a memzone with the same name already exists
839 * - ENOMEM - no appropriate memory area found in which to create memzone
842 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
843 unsigned cache_size, unsigned private_data_size,
844 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
845 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
846 int socket_id, unsigned flags);
850 * Create a new mempool named *name* in memory.
852 * The pool contains n elements of elt_size. Its size is set to n.
853 * This function uses ``memzone_reserve()`` to allocate the mempool header
854 * (and the objects if vaddr is NULL).
855 * Depending on the input parameters, mempool elements can be either allocated
856 * together with the mempool header, or an externally provided memory buffer
857 * could be used to store mempool objects. In later case, that external
858 * memory buffer can consist of set of disjoint physical pages.
861 * The name of the mempool.
863 * The number of elements in the mempool. The optimum size (in terms of
864 * memory usage) for a mempool is when n is a power of two minus one:
867 * The size of each element.
869 * Size of the cache. See rte_mempool_create() for details.
870 * @param private_data_size
871 * The size of the private data appended after the mempool
872 * structure. This is useful for storing some private data after the
873 * mempool structure, as is done for rte_mbuf_pool for example.
875 * A function pointer that is called for initialization of the pool,
876 * before object initialization. The user can initialize the private
877 * data in this function if needed. This parameter can be NULL if
880 * An opaque pointer to data that can be used in the mempool
881 * constructor function.
883 * A function called for each object at initialization of the pool.
884 * See rte_mempool_create() for details.
885 * @param obj_init_arg
886 * An opaque pointer passed to the object constructor function.
888 * The *socket_id* argument is the socket identifier in the case of
889 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
890 * constraint for the reserved zone.
892 * Flags controlling the behavior of the mempool. See
893 * rte_mempool_create() for details.
895 * Virtual address of the externally allocated memory buffer.
896 * Will be used to store mempool objects.
898 * Array of IO addresses of the pages that comprises given memory buffer.
900 * Number of elements in the iova array.
902 * LOG2 of the physical pages size.
904 * The pointer to the new allocated mempool, on success. NULL on error
905 * with rte_errno set appropriately. See rte_mempool_create() for details.
909 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
910 unsigned cache_size, unsigned private_data_size,
911 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
912 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
913 int socket_id, unsigned flags, void *vaddr,
914 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift);
917 * Create an empty mempool
919 * The mempool is allocated and initialized, but it is not populated: no
920 * memory is allocated for the mempool elements. The user has to call
921 * rte_mempool_populate_*() to add memory chunks to the pool. Once
922 * populated, the user may also want to initialize each object with
923 * rte_mempool_obj_iter().
926 * The name of the mempool.
928 * The maximum number of elements that can be added in the mempool.
929 * The optimum size (in terms of memory usage) for a mempool is when n
930 * is a power of two minus one: n = (2^q - 1).
932 * The size of each element.
934 * Size of the cache. See rte_mempool_create() for details.
935 * @param private_data_size
936 * The size of the private data appended after the mempool
937 * structure. This is useful for storing some private data after the
938 * mempool structure, as is done for rte_mbuf_pool for example.
940 * The *socket_id* argument is the socket identifier in the case of
941 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
942 * constraint for the reserved zone.
944 * Flags controlling the behavior of the mempool. See
945 * rte_mempool_create() for details.
947 * The pointer to the new allocated mempool, on success. NULL on error
948 * with rte_errno set appropriately. See rte_mempool_create() for details.
951 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
952 unsigned cache_size, unsigned private_data_size,
953 int socket_id, unsigned flags);
957 * Unlink the mempool from global list, free the memory chunks, and all
958 * memory referenced by the mempool. The objects must not be used by
959 * other cores as they will be freed.
962 * A pointer to the mempool structure.
965 rte_mempool_free(struct rte_mempool *mp);
968 * Add physically contiguous memory for objects in the pool at init
970 * Add a virtually and physically contiguous memory chunk in the pool
971 * where objects can be instantiated.
973 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
974 * the chunk doesn't need to be physically contiguous (only virtually),
975 * and allocated objects may span two pages.
978 * A pointer to the mempool structure.
980 * The virtual address of memory that should be used to store objects.
984 * The length of memory in bytes.
986 * The callback used to free this chunk when destroying the mempool.
988 * An opaque argument passed to free_cb.
990 * The number of objects added on success.
991 * On error, the chunk is not added in the memory list of the
992 * mempool and a negative errno is returned.
994 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
995 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
999 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
1000 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1005 * Add physical memory for objects in the pool at init
1007 * Add a virtually contiguous memory chunk in the pool where objects can
1008 * be instantiated. The IO addresses corresponding to the virtual
1009 * area are described in iova[], pg_num, pg_shift.
1012 * A pointer to the mempool structure.
1014 * The virtual address of memory that should be used to store objects.
1016 * An array of IO addresses of each page composing the virtual area.
1018 * Number of elements in the iova array.
1020 * LOG2 of the physical pages size.
1022 * The callback used to free this chunk when destroying the mempool.
1024 * An opaque argument passed to free_cb.
1026 * The number of objects added on success.
1027 * On error, the chunks are not added in the memory list of the
1028 * mempool and a negative errno is returned.
1031 int rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
1032 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
1033 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1036 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
1037 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
1038 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1041 * Add virtually contiguous memory for objects in the pool at init
1043 * Add a virtually contiguous memory chunk in the pool where objects can
1047 * A pointer to the mempool structure.
1049 * The virtual address of memory that should be used to store objects.
1050 * Must be page-aligned.
1052 * The length of memory in bytes. Must be page-aligned.
1054 * The size of memory pages in this virtual area.
1056 * The callback used to free this chunk when destroying the mempool.
1058 * An opaque argument passed to free_cb.
1060 * The number of objects added on success.
1061 * On error, the chunk is not added in the memory list of the
1062 * mempool and a negative errno is returned.
1065 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1066 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1070 * Add memory for objects in the pool at init
1072 * This is the default function used by rte_mempool_create() to populate
1073 * the mempool. It adds memory allocated using rte_memzone_reserve().
1076 * A pointer to the mempool structure.
1078 * The number of objects added on success.
1079 * On error, the chunk is not added in the memory list of the
1080 * mempool and a negative errno is returned.
1082 int rte_mempool_populate_default(struct rte_mempool *mp);
1085 * Add memory from anonymous mapping for objects in the pool at init
1087 * This function mmap an anonymous memory zone that is locked in
1088 * memory to store the objects of the mempool.
1091 * A pointer to the mempool structure.
1093 * The number of objects added on success.
1094 * On error, the chunk is not added in the memory list of the
1095 * mempool and a negative errno is returned.
1097 int rte_mempool_populate_anon(struct rte_mempool *mp);
1100 * Call a function for each mempool element
1102 * Iterate across all objects attached to a rte_mempool and call the
1103 * callback function on it.
1106 * A pointer to an initialized mempool.
1108 * A function pointer that is called for each object.
1110 * An opaque pointer passed to the callback function.
1112 * Number of objects iterated.
1114 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1115 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1118 * Call a function for each mempool memory chunk
1120 * Iterate across all memory chunks attached to a rte_mempool and call
1121 * the callback function on it.
1124 * A pointer to an initialized mempool.
1126 * A function pointer that is called for each memory chunk.
1128 * An opaque pointer passed to the callback function.
1130 * Number of memory chunks iterated.
1132 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1133 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1136 * Dump the status of the mempool to a file.
1139 * A pointer to a file for output
1141 * A pointer to the mempool structure.
1143 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1146 * Create a user-owned mempool cache.
1148 * This can be used by non-EAL threads to enable caching when they
1149 * interact with a mempool.
1152 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1153 * parameter description for more information. The same limits and
1154 * considerations apply here too.
1156 * The socket identifier in the case of NUMA. The value can be
1157 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1159 struct rte_mempool_cache *
1160 rte_mempool_cache_create(uint32_t size, int socket_id);
1163 * Free a user-owned mempool cache.
1166 * A pointer to the mempool cache.
1169 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1172 * Flush a user-owned mempool cache to the specified mempool.
1175 * A pointer to the mempool cache.
1177 * A pointer to the mempool.
1179 static __rte_always_inline void
1180 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1181 struct rte_mempool *mp)
1183 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1188 * Get a pointer to the per-lcore default mempool cache.
1191 * A pointer to the mempool structure.
1193 * The logical core id.
1195 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1197 static __rte_always_inline struct rte_mempool_cache *
1198 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1200 if (mp->cache_size == 0)
1203 if (lcore_id >= RTE_MAX_LCORE)
1206 return &mp->local_cache[lcore_id];
1210 * @internal Put several objects back in the mempool; used internally.
1212 * A pointer to the mempool structure.
1214 * A pointer to a table of void * pointers (objects).
1216 * The number of objects to store back in the mempool, must be strictly
1219 * A pointer to a mempool cache structure. May be NULL if not needed.
1221 static __rte_always_inline void
1222 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1223 unsigned int n, struct rte_mempool_cache *cache)
1227 /* increment stat now, adding in mempool always success */
1228 __MEMPOOL_STAT_ADD(mp, put, n);
1230 /* No cache provided or if put would overflow mem allocated for cache */
1231 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1234 cache_objs = &cache->objs[cache->len];
1237 * The cache follows the following algorithm
1238 * 1. Add the objects to the cache
1239 * 2. Anything greater than the cache min value (if it crosses the
1240 * cache flush threshold) is flushed to the ring.
1243 /* Add elements back into the cache */
1244 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1248 if (cache->len >= cache->flushthresh) {
1249 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1250 cache->len - cache->size);
1251 cache->len = cache->size;
1258 /* push remaining objects in ring */
1259 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1260 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1261 rte_panic("cannot put objects in mempool\n");
1263 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1269 * Put several objects back in the mempool.
1272 * A pointer to the mempool structure.
1274 * A pointer to a table of void * pointers (objects).
1276 * The number of objects to add in the mempool from the obj_table.
1278 * A pointer to a mempool cache structure. May be NULL if not needed.
1280 static __rte_always_inline void
1281 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1282 unsigned int n, struct rte_mempool_cache *cache)
1284 __mempool_check_cookies(mp, obj_table, n, 0);
1285 __mempool_generic_put(mp, obj_table, n, cache);
1289 * Put several objects back in the mempool.
1291 * This function calls the multi-producer or the single-producer
1292 * version depending on the default behavior that was specified at
1293 * mempool creation time (see flags).
1296 * A pointer to the mempool structure.
1298 * A pointer to a table of void * pointers (objects).
1300 * The number of objects to add in the mempool from obj_table.
1302 static __rte_always_inline void
1303 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1306 struct rte_mempool_cache *cache;
1307 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1308 rte_mempool_generic_put(mp, obj_table, n, cache);
1312 * Put one object back in the mempool.
1314 * This function calls the multi-producer or the single-producer
1315 * version depending on the default behavior that was specified at
1316 * mempool creation time (see flags).
1319 * A pointer to the mempool structure.
1321 * A pointer to the object to be added.
1323 static __rte_always_inline void
1324 rte_mempool_put(struct rte_mempool *mp, void *obj)
1326 rte_mempool_put_bulk(mp, &obj, 1);
1330 * @internal Get several objects from the mempool; used internally.
1332 * A pointer to the mempool structure.
1334 * A pointer to a table of void * pointers (objects).
1336 * The number of objects to get, must be strictly positive.
1338 * A pointer to a mempool cache structure. May be NULL if not needed.
1340 * - >=0: Success; number of objects supplied.
1341 * - <0: Error; code of ring dequeue function.
1343 static __rte_always_inline int
1344 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1345 unsigned int n, struct rte_mempool_cache *cache)
1348 uint32_t index, len;
1351 /* No cache provided or cannot be satisfied from cache */
1352 if (unlikely(cache == NULL || n >= cache->size))
1355 cache_objs = cache->objs;
1357 /* Can this be satisfied from the cache? */
1358 if (cache->len < n) {
1359 /* No. Backfill the cache first, and then fill from it */
1360 uint32_t req = n + (cache->size - cache->len);
1362 /* How many do we require i.e. number to fill the cache + the request */
1363 ret = rte_mempool_ops_dequeue_bulk(mp,
1364 &cache->objs[cache->len], req);
1365 if (unlikely(ret < 0)) {
1367 * In the offchance that we are buffer constrained,
1368 * where we are not able to allocate cache + n, go to
1369 * the ring directly. If that fails, we are truly out of
1378 /* Now fill in the response ... */
1379 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1380 *obj_table = cache_objs[len];
1384 __MEMPOOL_STAT_ADD(mp, get_success, n);
1390 /* get remaining objects from ring */
1391 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1394 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1396 __MEMPOOL_STAT_ADD(mp, get_success, n);
1402 * Get several objects from the mempool.
1404 * If cache is enabled, objects will be retrieved first from cache,
1405 * subsequently from the common pool. Note that it can return -ENOENT when
1406 * the local cache and common pool are empty, even if cache from other
1410 * A pointer to the mempool structure.
1412 * A pointer to a table of void * pointers (objects) that will be filled.
1414 * The number of objects to get from mempool to obj_table.
1416 * A pointer to a mempool cache structure. May be NULL if not needed.
1418 * - 0: Success; objects taken.
1419 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1421 static __rte_always_inline int
1422 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1423 unsigned int n, struct rte_mempool_cache *cache)
1426 ret = __mempool_generic_get(mp, obj_table, n, cache);
1428 __mempool_check_cookies(mp, obj_table, n, 1);
1433 * Get several objects from the mempool.
1435 * This function calls the multi-consumers or the single-consumer
1436 * version, depending on the default behaviour that was specified at
1437 * mempool creation time (see flags).
1439 * If cache is enabled, objects will be retrieved first from cache,
1440 * subsequently from the common pool. Note that it can return -ENOENT when
1441 * the local cache and common pool are empty, even if cache from other
1445 * A pointer to the mempool structure.
1447 * A pointer to a table of void * pointers (objects) that will be filled.
1449 * The number of objects to get from the mempool to obj_table.
1451 * - 0: Success; objects taken
1452 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1454 static __rte_always_inline int
1455 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1457 struct rte_mempool_cache *cache;
1458 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1459 return rte_mempool_generic_get(mp, obj_table, n, cache);
1463 * Get one object from the mempool.
1465 * This function calls the multi-consumers or the single-consumer
1466 * version, depending on the default behavior that was specified at
1467 * mempool creation (see flags).
1469 * If cache is enabled, objects will be retrieved first from cache,
1470 * subsequently from the common pool. Note that it can return -ENOENT when
1471 * the local cache and common pool are empty, even if cache from other
1475 * A pointer to the mempool structure.
1477 * A pointer to a void * pointer (object) that will be filled.
1479 * - 0: Success; objects taken.
1480 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1482 static __rte_always_inline int
1483 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1485 return rte_mempool_get_bulk(mp, obj_p, 1);
1489 * Return the number of entries in the mempool.
1491 * When cache is enabled, this function has to browse the length of
1492 * all lcores, so it should not be used in a data path, but only for
1493 * debug purposes. User-owned mempool caches are not accounted for.
1496 * A pointer to the mempool structure.
1498 * The number of entries in the mempool.
1500 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1503 * Return the number of elements which have been allocated from the mempool
1505 * When cache is enabled, this function has to browse the length of
1506 * all lcores, so it should not be used in a data path, but only for
1510 * A pointer to the mempool structure.
1512 * The number of free entries in the mempool.
1515 rte_mempool_in_use_count(const struct rte_mempool *mp);
1518 * Test if the mempool is full.
1520 * When cache is enabled, this function has to browse the length of all
1521 * lcores, so it should not be used in a data path, but only for debug
1522 * purposes. User-owned mempool caches are not accounted for.
1525 * A pointer to the mempool structure.
1527 * - 1: The mempool is full.
1528 * - 0: The mempool is not full.
1531 rte_mempool_full(const struct rte_mempool *mp)
1533 return !!(rte_mempool_avail_count(mp) == mp->size);
1537 * Test if the mempool is empty.
1539 * When cache is enabled, this function has to browse the length of all
1540 * lcores, so it should not be used in a data path, but only for debug
1541 * purposes. User-owned mempool caches are not accounted for.
1544 * A pointer to the mempool structure.
1546 * - 1: The mempool is empty.
1547 * - 0: The mempool is not empty.
1550 rte_mempool_empty(const struct rte_mempool *mp)
1552 return !!(rte_mempool_avail_count(mp) == 0);
1556 * Return the IO address of elt, which is an element of the pool mp.
1559 * A pointer (virtual address) to the element of the pool.
1561 * The IO address of the elt element.
1562 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1563 * returned value is RTE_BAD_IOVA.
1565 static inline rte_iova_t
1566 rte_mempool_virt2iova(const void *elt)
1568 const struct rte_mempool_objhdr *hdr;
1569 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1575 static inline phys_addr_t
1576 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1578 return rte_mempool_virt2iova(elt);
1582 * Check the consistency of mempool objects.
1584 * Verify the coherency of fields in the mempool structure. Also check
1585 * that the cookies of mempool objects (even the ones that are not
1586 * present in pool) have a correct value. If not, a panic will occur.
1589 * A pointer to the mempool structure.
1591 void rte_mempool_audit(struct rte_mempool *mp);
1594 * Return a pointer to the private data in an mempool structure.
1597 * A pointer to the mempool structure.
1599 * A pointer to the private data.
1601 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1604 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1608 * Dump the status of all mempools on the console
1611 * A pointer to a file for output
1613 void rte_mempool_list_dump(FILE *f);
1616 * Search a mempool from its name
1619 * The name of the mempool.
1621 * The pointer to the mempool matching the name, or NULL if not found.
1623 * with rte_errno set appropriately. Possible rte_errno values include:
1624 * - ENOENT - required entry not available to return.
1627 struct rte_mempool *rte_mempool_lookup(const char *name);
1630 * Get the header, trailer and total size of a mempool element.
1632 * Given a desired size of the mempool element and mempool flags,
1633 * calculates header, trailer, body and total sizes of the mempool object.
1636 * The size of each element, without header and trailer.
1638 * The flags used for the mempool creation.
1639 * Consult rte_mempool_create() for more information about possible values.
1640 * The size of each element.
1642 * The calculated detailed size the mempool object. May be NULL.
1644 * Total size of the mempool object.
1646 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1647 struct rte_mempool_objsz *sz);
1651 * Get the size of memory required to store mempool elements.
1653 * Calculate the maximum amount of memory required to store given number
1654 * of objects. Assume that the memory buffer will be aligned at page
1657 * Note that if object size is bigger than page size, then it assumes
1658 * that pages are grouped in subsets of physically continuous pages big
1659 * enough to store at least one object.
1662 * Number of elements.
1663 * @param total_elt_sz
1664 * The size of each element, including header and trailer, as returned
1665 * by rte_mempool_calc_obj_size().
1667 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1669 * The mempool flags.
1671 * Required memory size aligned at page boundary.
1674 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1675 uint32_t pg_shift, unsigned int flags);
1679 * Get the size of memory required to store mempool elements.
1681 * Calculate how much memory would be actually required with the given
1682 * memory footprint to store required number of objects.
1685 * Virtual address of the externally allocated memory buffer.
1686 * Will be used to store mempool objects.
1688 * Number of elements.
1689 * @param total_elt_sz
1690 * The size of each element, including header and trailer, as returned
1691 * by rte_mempool_calc_obj_size().
1693 * Array of IO addresses of the pages that comprises given memory buffer.
1695 * Number of elements in the iova array.
1697 * LOG2 of the physical pages size.
1699 * The mempool flags.
1701 * On success, the number of bytes needed to store given number of
1702 * objects, aligned to the given page size. If the provided memory
1703 * buffer is too small, return a negative value whose absolute value
1704 * is the actual number of elements that can be stored in that buffer.
1707 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1708 size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
1709 uint32_t pg_shift, unsigned int flags);
1712 * Walk list of all memory pools
1717 * Argument passed to iterator
1719 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1726 #endif /* _RTE_MEMPOOL_H_ */