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 */
250 * This capability flag is advertised by a mempool handler, if the whole
251 * memory area containing the objects must be physically contiguous.
252 * Note: This flag should not be passed by application.
254 #define MEMPOOL_F_CAPA_PHYS_CONTIG 0x0040
256 * This capability flag is advertised by a mempool handler. Used for a case
257 * where mempool driver wants object start address(vaddr) aligned to block
258 * size(/ total element size).
261 * - This flag should not be passed by application.
262 * Flag used for mempool driver only.
263 * - Mempool driver must also set MEMPOOL_F_CAPA_PHYS_CONTIG flag along with
264 * MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS.
266 #define MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS 0x0080
269 * @internal When debug is enabled, store some statistics.
272 * Pointer to the memory pool.
274 * Name of the statistics field to increment in the memory pool.
276 * Number to add to the object-oriented statistics.
278 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
279 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
280 unsigned __lcore_id = rte_lcore_id(); \
281 if (__lcore_id < RTE_MAX_LCORE) { \
282 mp->stats[__lcore_id].name##_objs += n; \
283 mp->stats[__lcore_id].name##_bulk += 1; \
287 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
291 * Calculate the size of the mempool header.
294 * Pointer to the memory pool.
296 * Size of the per-lcore cache.
298 #define MEMPOOL_HEADER_SIZE(mp, cs) \
299 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
300 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
302 /* return the header of a mempool object (internal) */
303 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
305 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
306 sizeof(struct rte_mempool_objhdr));
310 * Return a pointer to the mempool owning this object.
313 * An object that is owned by a pool. If this is not the case,
314 * the behavior is undefined.
316 * A pointer to the mempool structure.
318 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
320 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
324 /* return the trailer of a mempool object (internal) */
325 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
327 struct rte_mempool *mp = rte_mempool_from_obj(obj);
328 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
332 * @internal Check and update cookies or panic.
335 * Pointer to the memory pool.
336 * @param obj_table_const
337 * Pointer to a table of void * pointers (objects).
339 * Index of object in object table.
341 * - 0: object is supposed to be allocated, mark it as free
342 * - 1: object is supposed to be free, mark it as allocated
343 * - 2: just check that cookie is valid (free or allocated)
345 void rte_mempool_check_cookies(const struct rte_mempool *mp,
346 void * const *obj_table_const, unsigned n, int free);
348 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
349 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
350 rte_mempool_check_cookies(mp, obj_table_const, n, free)
352 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
353 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
355 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
358 * Prototype for implementation specific data provisioning function.
360 * The function should provide the implementation specific memory for
361 * use by the other mempool ops functions in a given mempool ops struct.
362 * E.g. the default ops provides an instance of the rte_ring for this purpose.
363 * it will most likely point to a different type of data structure, and
364 * will be transparent to the application programmer.
365 * This function should set mp->pool_data.
367 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
370 * Free the opaque private data pointed to by mp->pool_data pointer.
372 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
375 * Enqueue an object into the external pool.
377 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
378 void * const *obj_table, unsigned int n);
381 * Dequeue an object from the external pool.
383 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
384 void **obj_table, unsigned int n);
387 * Return the number of available objects in the external pool.
389 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
392 * Get the mempool capabilities.
394 typedef int (*rte_mempool_get_capabilities_t)(const struct rte_mempool *mp,
395 unsigned int *flags);
398 * Notify new memory area to mempool.
400 typedef int (*rte_mempool_ops_register_memory_area_t)
401 (const struct rte_mempool *mp, char *vaddr, rte_iova_t iova, size_t len);
404 * Calculate memory size required to store given number of objects.
406 * If mempool objects are not required to be IOVA-contiguous
407 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
408 * virtually contiguous chunk size. Otherwise, if mempool objects must
409 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
410 * min_chunk_size defines IOVA-contiguous chunk size.
413 * Pointer to the memory pool.
416 * @param[in] pg_shift
417 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
418 * @param[out] min_chunk_size
419 * Location for minimum size of the memory chunk which may be used to
420 * store memory pool objects.
422 * Location for required memory chunk alignment.
424 * Required memory size aligned at page boundary.
426 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
427 uint32_t obj_num, uint32_t pg_shift,
428 size_t *min_chunk_size, size_t *align);
431 * Default way to calculate memory size required to store given number of
434 * If page boundaries may be ignored, it is just a product of total
435 * object size including header and trailer and number of objects.
436 * Otherwise, it is a number of pages required to store given number of
437 * objects without crossing page boundary.
439 * Note that if object size is bigger than page size, then it assumes
440 * that pages are grouped in subsets of physically continuous pages big
441 * enough to store at least one object.
443 * If mempool driver requires object addresses to be block size aligned
444 * (MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS), space for one extra element is
445 * reserved to be able to meet the requirement.
447 * Minimum size of memory chunk is either all required space, if
448 * capabilities say that whole memory area must be physically contiguous
449 * (MEMPOOL_F_CAPA_PHYS_CONTIG), or a maximum of the page size and total
452 * Required memory chunk alignment is a maximum of page size and cache
455 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
456 uint32_t obj_num, uint32_t pg_shift,
457 size_t *min_chunk_size, size_t *align);
459 /** Structure defining mempool operations structure */
460 struct rte_mempool_ops {
461 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
462 rte_mempool_alloc_t alloc; /**< Allocate private data. */
463 rte_mempool_free_t free; /**< Free the external pool. */
464 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
465 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
466 rte_mempool_get_count get_count; /**< Get qty of available objs. */
468 * Get the mempool capabilities
470 rte_mempool_get_capabilities_t get_capabilities;
472 * Notify new memory area to mempool
474 rte_mempool_ops_register_memory_area_t register_memory_area;
476 * Optional callback to calculate memory size required to
477 * store specified number of objects.
479 rte_mempool_calc_mem_size_t calc_mem_size;
480 } __rte_cache_aligned;
482 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
485 * Structure storing the table of registered ops structs, each of which contain
486 * the function pointers for the mempool ops functions.
487 * Each process has its own storage for this ops struct array so that
488 * the mempools can be shared across primary and secondary processes.
489 * The indices used to access the array are valid across processes, whereas
490 * any function pointers stored directly in the mempool struct would not be.
491 * This results in us simply having "ops_index" in the mempool struct.
493 struct rte_mempool_ops_table {
494 rte_spinlock_t sl; /**< Spinlock for add/delete. */
495 uint32_t num_ops; /**< Number of used ops structs in the table. */
497 * Storage for all possible ops structs.
499 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
500 } __rte_cache_aligned;
502 /** Array of registered ops structs. */
503 extern struct rte_mempool_ops_table rte_mempool_ops_table;
506 * @internal Get the mempool ops struct from its index.
509 * The index of the ops struct in the ops struct table. It must be a valid
510 * index: (0 <= idx < num_ops).
512 * The pointer to the ops struct in the table.
514 static inline struct rte_mempool_ops *
515 rte_mempool_get_ops(int ops_index)
517 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
519 return &rte_mempool_ops_table.ops[ops_index];
523 * @internal Wrapper for mempool_ops alloc callback.
526 * Pointer to the memory pool.
528 * - 0: Success; successfully allocated mempool pool_data.
529 * - <0: Error; code of alloc function.
532 rte_mempool_ops_alloc(struct rte_mempool *mp);
535 * @internal Wrapper for mempool_ops dequeue callback.
538 * Pointer to the memory pool.
540 * Pointer to a table of void * pointers (objects).
542 * Number of objects to get.
544 * - 0: Success; got n objects.
545 * - <0: Error; code of dequeue function.
548 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
549 void **obj_table, unsigned n)
551 struct rte_mempool_ops *ops;
553 ops = rte_mempool_get_ops(mp->ops_index);
554 return ops->dequeue(mp, obj_table, n);
558 * @internal wrapper for mempool_ops enqueue callback.
561 * Pointer to the memory pool.
563 * Pointer to a table of void * pointers (objects).
565 * Number of objects to put.
567 * - 0: Success; n objects supplied.
568 * - <0: Error; code of enqueue function.
571 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
574 struct rte_mempool_ops *ops;
576 ops = rte_mempool_get_ops(mp->ops_index);
577 return ops->enqueue(mp, obj_table, n);
581 * @internal wrapper for mempool_ops get_count callback.
584 * Pointer to the memory pool.
586 * The number of available objects in the external pool.
589 rte_mempool_ops_get_count(const struct rte_mempool *mp);
592 * @internal wrapper for mempool_ops get_capabilities callback.
595 * Pointer to the memory pool.
597 * Pointer to the mempool flags.
599 * - 0: Success; The mempool driver has advertised his pool capabilities in
601 * - -ENOTSUP - doesn't support get_capabilities ops (valid case).
602 * - Otherwise, pool create fails.
605 rte_mempool_ops_get_capabilities(const struct rte_mempool *mp,
606 unsigned int *flags);
608 * @internal wrapper for mempool_ops register_memory_area callback.
609 * API to notify the mempool handler when a new memory area is added to pool.
612 * Pointer to the memory pool.
614 * Pointer to the buffer virtual address.
616 * Pointer to the buffer IO address.
621 * - -ENOTSUP - doesn't support register_memory_area ops (valid error case).
622 * - Otherwise, rte_mempool_populate_phys fails thus pool create fails.
625 rte_mempool_ops_register_memory_area(const struct rte_mempool *mp,
626 char *vaddr, rte_iova_t iova, size_t len);
629 * @internal wrapper for mempool_ops calc_mem_size callback.
630 * API to calculate size of memory required to store specified number of
634 * Pointer to the memory pool.
637 * @param[in] pg_shift
638 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
639 * @param[out] min_chunk_size
640 * Location for minimum size of the memory chunk which may be used to
641 * store memory pool objects.
643 * Location for required memory chunk alignment.
645 * Required memory size aligned at page boundary.
647 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
648 uint32_t obj_num, uint32_t pg_shift,
649 size_t *min_chunk_size, size_t *align);
652 * @internal wrapper for mempool_ops free callback.
655 * Pointer to the memory pool.
658 rte_mempool_ops_free(struct rte_mempool *mp);
661 * Set the ops of a mempool.
663 * This can only be done on a mempool that is not populated, i.e. just after
664 * a call to rte_mempool_create_empty().
667 * Pointer to the memory pool.
669 * Name of the ops structure to use for this mempool.
671 * Opaque data that can be passed by the application to the ops functions.
673 * - 0: Success; the mempool is now using the requested ops functions.
674 * - -EINVAL - Invalid ops struct name provided.
675 * - -EEXIST - mempool already has an ops struct assigned.
678 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
682 * Register mempool operations.
685 * Pointer to an ops structure to register.
687 * - >=0: Success; return the index of the ops struct in the table.
688 * - -EINVAL - some missing callbacks while registering ops struct.
689 * - -ENOSPC - the maximum number of ops structs has been reached.
691 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
694 * Macro to statically register the ops of a mempool handler.
695 * Note that the rte_mempool_register_ops fails silently here when
696 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
698 #define MEMPOOL_REGISTER_OPS(ops) \
699 void mp_hdlr_init_##ops(void); \
700 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
702 rte_mempool_register_ops(&ops); \
706 * An object callback function for mempool.
708 * Used by rte_mempool_create() and rte_mempool_obj_iter().
710 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
711 void *opaque, void *obj, unsigned obj_idx);
712 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
715 * A memory callback function for mempool.
717 * Used by rte_mempool_mem_iter().
719 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
720 void *opaque, struct rte_mempool_memhdr *memhdr,
724 * A mempool constructor callback function.
726 * Arguments are the mempool and the opaque pointer given by the user in
727 * rte_mempool_create().
729 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
732 * Create a new mempool named *name* in memory.
734 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
735 * pool contains n elements of elt_size. Its size is set to n.
738 * The name of the mempool.
740 * The number of elements in the mempool. The optimum size (in terms of
741 * memory usage) for a mempool is when n is a power of two minus one:
744 * The size of each element.
746 * If cache_size is non-zero, the rte_mempool library will try to
747 * limit the accesses to the common lockless pool, by maintaining a
748 * per-lcore object cache. This argument must be lower or equal to
749 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
750 * cache_size to have "n modulo cache_size == 0": if this is
751 * not the case, some elements will always stay in the pool and will
752 * never be used. The access to the per-lcore table is of course
753 * faster than the multi-producer/consumer pool. The cache can be
754 * disabled if the cache_size argument is set to 0; it can be useful to
755 * avoid losing objects in cache.
756 * @param private_data_size
757 * The size of the private data appended after the mempool
758 * structure. This is useful for storing some private data after the
759 * mempool structure, as is done for rte_mbuf_pool for example.
761 * A function pointer that is called for initialization of the pool,
762 * before object initialization. The user can initialize the private
763 * data in this function if needed. This parameter can be NULL if
766 * An opaque pointer to data that can be used in the mempool
767 * constructor function.
769 * A function pointer that is called for each object at
770 * initialization of the pool. The user can set some meta data in
771 * objects if needed. This parameter can be NULL if not needed.
772 * The obj_init() function takes the mempool pointer, the init_arg,
773 * the object pointer and the object number as parameters.
774 * @param obj_init_arg
775 * An opaque pointer to data that can be used as an argument for
776 * each call to the object constructor function.
778 * The *socket_id* argument is the socket identifier in the case of
779 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
780 * constraint for the reserved zone.
782 * The *flags* arguments is an OR of following flags:
783 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
784 * between channels in RAM: the pool allocator will add padding
785 * between objects depending on the hardware configuration. See
786 * Memory alignment constraints for details. If this flag is set,
787 * the allocator will just align them to a cache line.
788 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
789 * cache-aligned. This flag removes this constraint, and no
790 * padding will be present between objects. This flag implies
791 * MEMPOOL_F_NO_SPREAD.
792 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
793 * when using rte_mempool_put() or rte_mempool_put_bulk() is
794 * "single-producer". Otherwise, it is "multi-producers".
795 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
796 * when using rte_mempool_get() or rte_mempool_get_bulk() is
797 * "single-consumer". Otherwise, it is "multi-consumers".
798 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
799 * necessarily be contiguous in IO memory.
801 * The pointer to the new allocated mempool, on success. NULL on error
802 * with rte_errno set appropriately. Possible rte_errno values include:
803 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
804 * - E_RTE_SECONDARY - function was called from a secondary process instance
805 * - EINVAL - cache size provided is too large
806 * - ENOSPC - the maximum number of memzones has already been allocated
807 * - EEXIST - a memzone with the same name already exists
808 * - ENOMEM - no appropriate memory area found in which to create memzone
811 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
812 unsigned cache_size, unsigned private_data_size,
813 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
814 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
815 int socket_id, unsigned flags);
818 * Create a new mempool named *name* in memory.
820 * The pool contains n elements of elt_size. Its size is set to n.
821 * This function uses ``memzone_reserve()`` to allocate the mempool header
822 * (and the objects if vaddr is NULL).
823 * Depending on the input parameters, mempool elements can be either allocated
824 * together with the mempool header, or an externally provided memory buffer
825 * could be used to store mempool objects. In later case, that external
826 * memory buffer can consist of set of disjoint physical pages.
829 * The name of the mempool.
831 * The number of elements in the mempool. The optimum size (in terms of
832 * memory usage) for a mempool is when n is a power of two minus one:
835 * The size of each element.
837 * Size of the cache. See rte_mempool_create() for details.
838 * @param private_data_size
839 * The size of the private data appended after the mempool
840 * structure. This is useful for storing some private data after the
841 * mempool structure, as is done for rte_mbuf_pool for example.
843 * A function pointer that is called for initialization of the pool,
844 * before object initialization. The user can initialize the private
845 * data in this function if needed. This parameter can be NULL if
848 * An opaque pointer to data that can be used in the mempool
849 * constructor function.
851 * A function called for each object at initialization of the pool.
852 * See rte_mempool_create() for details.
853 * @param obj_init_arg
854 * An opaque pointer passed to the object constructor function.
856 * The *socket_id* argument is the socket identifier in the case of
857 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
858 * constraint for the reserved zone.
860 * Flags controlling the behavior of the mempool. See
861 * rte_mempool_create() for details.
863 * Virtual address of the externally allocated memory buffer.
864 * Will be used to store mempool objects.
866 * Array of IO addresses of the pages that comprises given memory buffer.
868 * Number of elements in the iova array.
870 * LOG2 of the physical pages size.
872 * The pointer to the new allocated mempool, on success. NULL on error
873 * with rte_errno set appropriately. See rte_mempool_create() for details.
876 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
877 unsigned cache_size, unsigned private_data_size,
878 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
879 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
880 int socket_id, unsigned flags, void *vaddr,
881 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift);
884 * Create an empty mempool
886 * The mempool is allocated and initialized, but it is not populated: no
887 * memory is allocated for the mempool elements. The user has to call
888 * rte_mempool_populate_*() to add memory chunks to the pool. Once
889 * populated, the user may also want to initialize each object with
890 * rte_mempool_obj_iter().
893 * The name of the mempool.
895 * The maximum number of elements that can be added in the mempool.
896 * The optimum size (in terms of memory usage) for a mempool is when n
897 * is a power of two minus one: n = (2^q - 1).
899 * The size of each element.
901 * Size of the cache. See rte_mempool_create() for details.
902 * @param private_data_size
903 * The size of the private data appended after the mempool
904 * structure. This is useful for storing some private data after the
905 * mempool structure, as is done for rte_mbuf_pool for example.
907 * The *socket_id* argument is the socket identifier in the case of
908 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
909 * constraint for the reserved zone.
911 * Flags controlling the behavior of the mempool. See
912 * rte_mempool_create() for details.
914 * The pointer to the new allocated mempool, on success. NULL on error
915 * with rte_errno set appropriately. See rte_mempool_create() for details.
918 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
919 unsigned cache_size, unsigned private_data_size,
920 int socket_id, unsigned flags);
924 * Unlink the mempool from global list, free the memory chunks, and all
925 * memory referenced by the mempool. The objects must not be used by
926 * other cores as they will be freed.
929 * A pointer to the mempool structure.
932 rte_mempool_free(struct rte_mempool *mp);
935 * Add physically contiguous memory for objects in the pool at init
937 * Add a virtually and physically contiguous memory chunk in the pool
938 * where objects can be instantiated.
940 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
941 * the chunk doesn't need to be physically contiguous (only virtually),
942 * and allocated objects may span two pages.
945 * A pointer to the mempool structure.
947 * The virtual address of memory that should be used to store objects.
951 * The length of memory in bytes.
953 * The callback used to free this chunk when destroying the mempool.
955 * An opaque argument passed to free_cb.
957 * The number of objects added on success.
958 * On error, the chunk is not added in the memory list of the
959 * mempool and a negative errno is returned.
961 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
962 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
966 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
967 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
971 * Add physical memory for objects in the pool at init
973 * Add a virtually contiguous memory chunk in the pool where objects can
974 * be instantiated. The IO addresses corresponding to the virtual
975 * area are described in iova[], pg_num, pg_shift.
978 * A pointer to the mempool structure.
980 * The virtual address of memory that should be used to store objects.
982 * An array of IO addresses of each page composing the virtual area.
984 * Number of elements in the iova array.
986 * LOG2 of the physical pages size.
988 * The callback used to free this chunk when destroying the mempool.
990 * An opaque argument passed to free_cb.
992 * The number of objects added on success.
993 * On error, the chunks are not added in the memory list of the
994 * mempool and a negative errno is returned.
996 int rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
997 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
998 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1001 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
1002 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
1003 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1006 * Add virtually contiguous memory for objects in the pool at init
1008 * Add a virtually contiguous memory chunk in the pool where objects can
1012 * A pointer to the mempool structure.
1014 * The virtual address of memory that should be used to store objects.
1015 * Must be page-aligned.
1017 * The length of memory in bytes. Must be page-aligned.
1019 * The size of memory pages in this virtual area.
1021 * The callback used to free this chunk when destroying the mempool.
1023 * An opaque argument passed to free_cb.
1025 * The number of objects added on success.
1026 * On error, the chunk is not added in the memory list of the
1027 * mempool and a negative errno is returned.
1030 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1031 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1035 * Add memory for objects in the pool at init
1037 * This is the default function used by rte_mempool_create() to populate
1038 * the mempool. It adds memory allocated using rte_memzone_reserve().
1041 * A pointer to the mempool structure.
1043 * The number of objects added on success.
1044 * On error, the chunk is not added in the memory list of the
1045 * mempool and a negative errno is returned.
1047 int rte_mempool_populate_default(struct rte_mempool *mp);
1050 * Add memory from anonymous mapping for objects in the pool at init
1052 * This function mmap an anonymous memory zone that is locked in
1053 * memory to store the objects of the mempool.
1056 * A pointer to the mempool structure.
1058 * The number of objects added on success.
1059 * On error, the chunk is not added in the memory list of the
1060 * mempool and a negative errno is returned.
1062 int rte_mempool_populate_anon(struct rte_mempool *mp);
1065 * Call a function for each mempool element
1067 * Iterate across all objects attached to a rte_mempool and call the
1068 * callback function on it.
1071 * A pointer to an initialized mempool.
1073 * A function pointer that is called for each object.
1075 * An opaque pointer passed to the callback function.
1077 * Number of objects iterated.
1079 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1080 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1083 * Call a function for each mempool memory chunk
1085 * Iterate across all memory chunks attached to a rte_mempool and call
1086 * the callback function on it.
1089 * A pointer to an initialized mempool.
1091 * A function pointer that is called for each memory chunk.
1093 * An opaque pointer passed to the callback function.
1095 * Number of memory chunks iterated.
1097 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1098 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1101 * Dump the status of the mempool to a file.
1104 * A pointer to a file for output
1106 * A pointer to the mempool structure.
1108 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1111 * Create a user-owned mempool cache.
1113 * This can be used by non-EAL threads to enable caching when they
1114 * interact with a mempool.
1117 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1118 * parameter description for more information. The same limits and
1119 * considerations apply here too.
1121 * The socket identifier in the case of NUMA. The value can be
1122 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1124 struct rte_mempool_cache *
1125 rte_mempool_cache_create(uint32_t size, int socket_id);
1128 * Free a user-owned mempool cache.
1131 * A pointer to the mempool cache.
1134 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1137 * Flush a user-owned mempool cache to the specified mempool.
1140 * A pointer to the mempool cache.
1142 * A pointer to the mempool.
1144 static __rte_always_inline void
1145 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1146 struct rte_mempool *mp)
1148 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1153 * Get a pointer to the per-lcore default mempool cache.
1156 * A pointer to the mempool structure.
1158 * The logical core id.
1160 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1162 static __rte_always_inline struct rte_mempool_cache *
1163 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1165 if (mp->cache_size == 0)
1168 if (lcore_id >= RTE_MAX_LCORE)
1171 return &mp->local_cache[lcore_id];
1175 * @internal Put several objects back in the mempool; used internally.
1177 * A pointer to the mempool structure.
1179 * A pointer to a table of void * pointers (objects).
1181 * The number of objects to store back in the mempool, must be strictly
1184 * A pointer to a mempool cache structure. May be NULL if not needed.
1186 static __rte_always_inline void
1187 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1188 unsigned int n, struct rte_mempool_cache *cache)
1192 /* increment stat now, adding in mempool always success */
1193 __MEMPOOL_STAT_ADD(mp, put, n);
1195 /* No cache provided or if put would overflow mem allocated for cache */
1196 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1199 cache_objs = &cache->objs[cache->len];
1202 * The cache follows the following algorithm
1203 * 1. Add the objects to the cache
1204 * 2. Anything greater than the cache min value (if it crosses the
1205 * cache flush threshold) is flushed to the ring.
1208 /* Add elements back into the cache */
1209 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1213 if (cache->len >= cache->flushthresh) {
1214 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1215 cache->len - cache->size);
1216 cache->len = cache->size;
1223 /* push remaining objects in ring */
1224 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1225 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1226 rte_panic("cannot put objects in mempool\n");
1228 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1234 * Put several objects back in the mempool.
1237 * A pointer to the mempool structure.
1239 * A pointer to a table of void * pointers (objects).
1241 * The number of objects to add in the mempool from the obj_table.
1243 * A pointer to a mempool cache structure. May be NULL if not needed.
1245 static __rte_always_inline void
1246 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1247 unsigned int n, struct rte_mempool_cache *cache)
1249 __mempool_check_cookies(mp, obj_table, n, 0);
1250 __mempool_generic_put(mp, obj_table, n, cache);
1254 * Put several objects back in the mempool.
1256 * This function calls the multi-producer or the single-producer
1257 * version depending on the default behavior that was specified at
1258 * mempool creation time (see flags).
1261 * A pointer to the mempool structure.
1263 * A pointer to a table of void * pointers (objects).
1265 * The number of objects to add in the mempool from obj_table.
1267 static __rte_always_inline void
1268 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1271 struct rte_mempool_cache *cache;
1272 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1273 rte_mempool_generic_put(mp, obj_table, n, cache);
1277 * Put one object back in the mempool.
1279 * This function calls the multi-producer or the single-producer
1280 * version depending on the default behavior that was specified at
1281 * mempool creation time (see flags).
1284 * A pointer to the mempool structure.
1286 * A pointer to the object to be added.
1288 static __rte_always_inline void
1289 rte_mempool_put(struct rte_mempool *mp, void *obj)
1291 rte_mempool_put_bulk(mp, &obj, 1);
1295 * @internal Get several objects from the mempool; used internally.
1297 * A pointer to the mempool structure.
1299 * A pointer to a table of void * pointers (objects).
1301 * The number of objects to get, must be strictly positive.
1303 * A pointer to a mempool cache structure. May be NULL if not needed.
1305 * - >=0: Success; number of objects supplied.
1306 * - <0: Error; code of ring dequeue function.
1308 static __rte_always_inline int
1309 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1310 unsigned int n, struct rte_mempool_cache *cache)
1313 uint32_t index, len;
1316 /* No cache provided or cannot be satisfied from cache */
1317 if (unlikely(cache == NULL || n >= cache->size))
1320 cache_objs = cache->objs;
1322 /* Can this be satisfied from the cache? */
1323 if (cache->len < n) {
1324 /* No. Backfill the cache first, and then fill from it */
1325 uint32_t req = n + (cache->size - cache->len);
1327 /* How many do we require i.e. number to fill the cache + the request */
1328 ret = rte_mempool_ops_dequeue_bulk(mp,
1329 &cache->objs[cache->len], req);
1330 if (unlikely(ret < 0)) {
1332 * In the offchance that we are buffer constrained,
1333 * where we are not able to allocate cache + n, go to
1334 * the ring directly. If that fails, we are truly out of
1343 /* Now fill in the response ... */
1344 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1345 *obj_table = cache_objs[len];
1349 __MEMPOOL_STAT_ADD(mp, get_success, n);
1355 /* get remaining objects from ring */
1356 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1359 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1361 __MEMPOOL_STAT_ADD(mp, get_success, n);
1367 * Get several objects from the mempool.
1369 * If cache is enabled, objects will be retrieved first from cache,
1370 * subsequently from the common pool. Note that it can return -ENOENT when
1371 * the local cache and common pool are empty, even if cache from other
1375 * A pointer to the mempool structure.
1377 * A pointer to a table of void * pointers (objects) that will be filled.
1379 * The number of objects to get from mempool to obj_table.
1381 * A pointer to a mempool cache structure. May be NULL if not needed.
1383 * - 0: Success; objects taken.
1384 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1386 static __rte_always_inline int
1387 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1388 unsigned int n, struct rte_mempool_cache *cache)
1391 ret = __mempool_generic_get(mp, obj_table, n, cache);
1393 __mempool_check_cookies(mp, obj_table, n, 1);
1398 * Get several objects from the mempool.
1400 * This function calls the multi-consumers or the single-consumer
1401 * version, depending on the default behaviour that was specified at
1402 * mempool creation time (see flags).
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 the mempool to obj_table.
1416 * - 0: Success; objects taken
1417 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1419 static __rte_always_inline int
1420 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1422 struct rte_mempool_cache *cache;
1423 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1424 return rte_mempool_generic_get(mp, obj_table, n, cache);
1428 * Get one object from the mempool.
1430 * This function calls the multi-consumers or the single-consumer
1431 * version, depending on the default behavior that was specified at
1432 * mempool creation (see flags).
1434 * If cache is enabled, objects will be retrieved first from cache,
1435 * subsequently from the common pool. Note that it can return -ENOENT when
1436 * the local cache and common pool are empty, even if cache from other
1440 * A pointer to the mempool structure.
1442 * A pointer to a void * pointer (object) that will be filled.
1444 * - 0: Success; objects taken.
1445 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1447 static __rte_always_inline int
1448 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1450 return rte_mempool_get_bulk(mp, obj_p, 1);
1454 * Return the number of entries in the mempool.
1456 * When cache is enabled, this function has to browse the length of
1457 * all lcores, so it should not be used in a data path, but only for
1458 * debug purposes. User-owned mempool caches are not accounted for.
1461 * A pointer to the mempool structure.
1463 * The number of entries in the mempool.
1465 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1468 * Return the number of elements which have been allocated from the mempool
1470 * When cache is enabled, this function has to browse the length of
1471 * all lcores, so it should not be used in a data path, but only for
1475 * A pointer to the mempool structure.
1477 * The number of free entries in the mempool.
1480 rte_mempool_in_use_count(const struct rte_mempool *mp);
1483 * Test if the mempool is full.
1485 * When cache is enabled, this function has to browse the length of all
1486 * lcores, so it should not be used in a data path, but only for debug
1487 * purposes. User-owned mempool caches are not accounted for.
1490 * A pointer to the mempool structure.
1492 * - 1: The mempool is full.
1493 * - 0: The mempool is not full.
1496 rte_mempool_full(const struct rte_mempool *mp)
1498 return !!(rte_mempool_avail_count(mp) == mp->size);
1502 * Test if the mempool is empty.
1504 * When cache is enabled, this function has to browse the length of all
1505 * lcores, so it should not be used in a data path, but only for debug
1506 * purposes. User-owned mempool caches are not accounted for.
1509 * A pointer to the mempool structure.
1511 * - 1: The mempool is empty.
1512 * - 0: The mempool is not empty.
1515 rte_mempool_empty(const struct rte_mempool *mp)
1517 return !!(rte_mempool_avail_count(mp) == 0);
1521 * Return the IO address of elt, which is an element of the pool mp.
1524 * A pointer (virtual address) to the element of the pool.
1526 * The IO address of the elt element.
1527 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1528 * returned value is RTE_BAD_IOVA.
1530 static inline rte_iova_t
1531 rte_mempool_virt2iova(const void *elt)
1533 const struct rte_mempool_objhdr *hdr;
1534 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1540 static inline phys_addr_t
1541 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1543 return rte_mempool_virt2iova(elt);
1547 * Check the consistency of mempool objects.
1549 * Verify the coherency of fields in the mempool structure. Also check
1550 * that the cookies of mempool objects (even the ones that are not
1551 * present in pool) have a correct value. If not, a panic will occur.
1554 * A pointer to the mempool structure.
1556 void rte_mempool_audit(struct rte_mempool *mp);
1559 * Return a pointer to the private data in an mempool structure.
1562 * A pointer to the mempool structure.
1564 * A pointer to the private data.
1566 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1569 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1573 * Dump the status of all mempools on the console
1576 * A pointer to a file for output
1578 void rte_mempool_list_dump(FILE *f);
1581 * Search a mempool from its name
1584 * The name of the mempool.
1586 * The pointer to the mempool matching the name, or NULL if not found.
1588 * with rte_errno set appropriately. Possible rte_errno values include:
1589 * - ENOENT - required entry not available to return.
1592 struct rte_mempool *rte_mempool_lookup(const char *name);
1595 * Get the header, trailer and total size of a mempool element.
1597 * Given a desired size of the mempool element and mempool flags,
1598 * calculates header, trailer, body and total sizes of the mempool object.
1601 * The size of each element, without header and trailer.
1603 * The flags used for the mempool creation.
1604 * Consult rte_mempool_create() for more information about possible values.
1605 * The size of each element.
1607 * The calculated detailed size the mempool object. May be NULL.
1609 * Total size of the mempool object.
1611 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1612 struct rte_mempool_objsz *sz);
1615 * Get the size of memory required to store mempool elements.
1617 * Calculate the maximum amount of memory required to store given number
1618 * of objects. Assume that the memory buffer will be aligned at page
1621 * Note that if object size is bigger than page size, then it assumes
1622 * that pages are grouped in subsets of physically continuous pages big
1623 * enough to store at least one object.
1626 * Number of elements.
1627 * @param total_elt_sz
1628 * The size of each element, including header and trailer, as returned
1629 * by rte_mempool_calc_obj_size().
1631 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1633 * The mempool flags.
1635 * Required memory size aligned at page boundary.
1637 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1638 uint32_t pg_shift, unsigned int flags);
1641 * Get the size of memory required to store mempool elements.
1643 * Calculate how much memory would be actually required with the given
1644 * memory footprint to store required number of objects.
1647 * Virtual address of the externally allocated memory buffer.
1648 * Will be used to store mempool objects.
1650 * Number of elements.
1651 * @param total_elt_sz
1652 * The size of each element, including header and trailer, as returned
1653 * by rte_mempool_calc_obj_size().
1655 * Array of IO addresses of the pages that comprises given memory buffer.
1657 * Number of elements in the iova array.
1659 * LOG2 of the physical pages size.
1661 * The mempool flags.
1663 * On success, the number of bytes needed to store given number of
1664 * objects, aligned to the given page size. If the provided memory
1665 * buffer is too small, return a negative value whose absolute value
1666 * is the actual number of elements that can be stored in that buffer.
1668 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1669 size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
1670 uint32_t pg_shift, unsigned int flags);
1673 * Walk list of all memory pools
1678 * Argument passed to iterator
1680 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1687 #endif /* _RTE_MEMPOOL_H_ */