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);
460 * Function to be called for each populated object.
463 * A pointer to the mempool structure.
465 * An opaque pointer passed to iterator.
467 * Object virtual address.
469 * Input/output virtual address of the object or RTE_BAD_IOVA.
471 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
472 void *opaque, void *vaddr, rte_iova_t iova);
475 * Populate memory pool objects using provided memory chunk.
477 * Populated objects should be enqueued to the pool, e.g. using
478 * rte_mempool_ops_enqueue_bulk().
480 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
481 * the chunk doesn't need to be physically contiguous (only virtually),
482 * and allocated objects may span two pages.
485 * A pointer to the mempool structure.
486 * @param[in] max_objs
487 * Maximum number of objects to be populated.
489 * The virtual address of memory that should be used to store objects.
493 * The length of memory in bytes.
495 * Callback function to be executed for each populated object.
496 * @param[in] obj_cb_arg
497 * An opaque pointer passed to the callback function.
499 * The number of objects added on success.
500 * On error, no objects are populated and a negative errno is returned.
502 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
503 unsigned int max_objs,
504 void *vaddr, rte_iova_t iova, size_t len,
505 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
508 * Default way to populate memory pool object using provided memory
509 * chunk: just slice objects one by one.
511 int rte_mempool_op_populate_default(struct rte_mempool *mp,
512 unsigned int max_objs,
513 void *vaddr, rte_iova_t iova, size_t len,
514 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
516 /** Structure defining mempool operations structure */
517 struct rte_mempool_ops {
518 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
519 rte_mempool_alloc_t alloc; /**< Allocate private data. */
520 rte_mempool_free_t free; /**< Free the external pool. */
521 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
522 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
523 rte_mempool_get_count get_count; /**< Get qty of available objs. */
525 * Get the mempool capabilities
527 rte_mempool_get_capabilities_t get_capabilities;
529 * Notify new memory area to mempool
531 rte_mempool_ops_register_memory_area_t register_memory_area;
533 * Optional callback to calculate memory size required to
534 * store specified number of objects.
536 rte_mempool_calc_mem_size_t calc_mem_size;
538 * Optional callback to populate mempool objects using
539 * provided memory chunk.
541 rte_mempool_populate_t populate;
542 } __rte_cache_aligned;
544 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
547 * Structure storing the table of registered ops structs, each of which contain
548 * the function pointers for the mempool ops functions.
549 * Each process has its own storage for this ops struct array so that
550 * the mempools can be shared across primary and secondary processes.
551 * The indices used to access the array are valid across processes, whereas
552 * any function pointers stored directly in the mempool struct would not be.
553 * This results in us simply having "ops_index" in the mempool struct.
555 struct rte_mempool_ops_table {
556 rte_spinlock_t sl; /**< Spinlock for add/delete. */
557 uint32_t num_ops; /**< Number of used ops structs in the table. */
559 * Storage for all possible ops structs.
561 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
562 } __rte_cache_aligned;
564 /** Array of registered ops structs. */
565 extern struct rte_mempool_ops_table rte_mempool_ops_table;
568 * @internal Get the mempool ops struct from its index.
571 * The index of the ops struct in the ops struct table. It must be a valid
572 * index: (0 <= idx < num_ops).
574 * The pointer to the ops struct in the table.
576 static inline struct rte_mempool_ops *
577 rte_mempool_get_ops(int ops_index)
579 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
581 return &rte_mempool_ops_table.ops[ops_index];
585 * @internal Wrapper for mempool_ops alloc callback.
588 * Pointer to the memory pool.
590 * - 0: Success; successfully allocated mempool pool_data.
591 * - <0: Error; code of alloc function.
594 rte_mempool_ops_alloc(struct rte_mempool *mp);
597 * @internal Wrapper for mempool_ops dequeue callback.
600 * Pointer to the memory pool.
602 * Pointer to a table of void * pointers (objects).
604 * Number of objects to get.
606 * - 0: Success; got n objects.
607 * - <0: Error; code of dequeue function.
610 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
611 void **obj_table, unsigned n)
613 struct rte_mempool_ops *ops;
615 ops = rte_mempool_get_ops(mp->ops_index);
616 return ops->dequeue(mp, obj_table, n);
620 * @internal wrapper for mempool_ops enqueue callback.
623 * Pointer to the memory pool.
625 * Pointer to a table of void * pointers (objects).
627 * Number of objects to put.
629 * - 0: Success; n objects supplied.
630 * - <0: Error; code of enqueue function.
633 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
636 struct rte_mempool_ops *ops;
638 ops = rte_mempool_get_ops(mp->ops_index);
639 return ops->enqueue(mp, obj_table, n);
643 * @internal wrapper for mempool_ops get_count callback.
646 * Pointer to the memory pool.
648 * The number of available objects in the external pool.
651 rte_mempool_ops_get_count(const struct rte_mempool *mp);
654 * @internal wrapper for mempool_ops get_capabilities callback.
657 * Pointer to the memory pool.
659 * Pointer to the mempool flags.
661 * - 0: Success; The mempool driver has advertised his pool capabilities in
663 * - -ENOTSUP - doesn't support get_capabilities ops (valid case).
664 * - Otherwise, pool create fails.
667 rte_mempool_ops_get_capabilities(const struct rte_mempool *mp,
668 unsigned int *flags);
670 * @internal wrapper for mempool_ops register_memory_area callback.
671 * API to notify the mempool handler when a new memory area is added to pool.
674 * Pointer to the memory pool.
676 * Pointer to the buffer virtual address.
678 * Pointer to the buffer IO address.
683 * - -ENOTSUP - doesn't support register_memory_area ops (valid error case).
684 * - Otherwise, rte_mempool_populate_phys fails thus pool create fails.
687 rte_mempool_ops_register_memory_area(const struct rte_mempool *mp,
688 char *vaddr, rte_iova_t iova, size_t len);
691 * @internal wrapper for mempool_ops calc_mem_size callback.
692 * API to calculate size of memory required to store specified number of
696 * Pointer to the memory pool.
699 * @param[in] pg_shift
700 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
701 * @param[out] min_chunk_size
702 * Location for minimum size of the memory chunk which may be used to
703 * store memory pool objects.
705 * Location for required memory chunk alignment.
707 * Required memory size aligned at page boundary.
709 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
710 uint32_t obj_num, uint32_t pg_shift,
711 size_t *min_chunk_size, size_t *align);
714 * @internal wrapper for mempool_ops populate callback.
716 * Populate memory pool objects using provided memory chunk.
719 * A pointer to the mempool structure.
720 * @param[in] max_objs
721 * Maximum number of objects to be populated.
723 * The virtual address of memory that should be used to store objects.
727 * The length of memory in bytes.
729 * Callback function to be executed for each populated object.
730 * @param[in] obj_cb_arg
731 * An opaque pointer passed to the callback function.
733 * The number of objects added on success.
734 * On error, no objects are populated and a negative errno is returned.
736 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
737 void *vaddr, rte_iova_t iova, size_t len,
738 rte_mempool_populate_obj_cb_t *obj_cb,
742 * @internal wrapper for mempool_ops free callback.
745 * Pointer to the memory pool.
748 rte_mempool_ops_free(struct rte_mempool *mp);
751 * Set the ops of a mempool.
753 * This can only be done on a mempool that is not populated, i.e. just after
754 * a call to rte_mempool_create_empty().
757 * Pointer to the memory pool.
759 * Name of the ops structure to use for this mempool.
761 * Opaque data that can be passed by the application to the ops functions.
763 * - 0: Success; the mempool is now using the requested ops functions.
764 * - -EINVAL - Invalid ops struct name provided.
765 * - -EEXIST - mempool already has an ops struct assigned.
768 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
772 * Register mempool operations.
775 * Pointer to an ops structure to register.
777 * - >=0: Success; return the index of the ops struct in the table.
778 * - -EINVAL - some missing callbacks while registering ops struct.
779 * - -ENOSPC - the maximum number of ops structs has been reached.
781 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
784 * Macro to statically register the ops of a mempool handler.
785 * Note that the rte_mempool_register_ops fails silently here when
786 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
788 #define MEMPOOL_REGISTER_OPS(ops) \
789 void mp_hdlr_init_##ops(void); \
790 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
792 rte_mempool_register_ops(&ops); \
796 * An object callback function for mempool.
798 * Used by rte_mempool_create() and rte_mempool_obj_iter().
800 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
801 void *opaque, void *obj, unsigned obj_idx);
802 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
805 * A memory callback function for mempool.
807 * Used by rte_mempool_mem_iter().
809 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
810 void *opaque, struct rte_mempool_memhdr *memhdr,
814 * A mempool constructor callback function.
816 * Arguments are the mempool and the opaque pointer given by the user in
817 * rte_mempool_create().
819 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
822 * Create a new mempool named *name* in memory.
824 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
825 * pool contains n elements of elt_size. Its size is set to n.
828 * The name of the mempool.
830 * The number of elements in the mempool. The optimum size (in terms of
831 * memory usage) for a mempool is when n is a power of two minus one:
834 * The size of each element.
836 * If cache_size is non-zero, the rte_mempool library will try to
837 * limit the accesses to the common lockless pool, by maintaining a
838 * per-lcore object cache. This argument must be lower or equal to
839 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
840 * cache_size to have "n modulo cache_size == 0": if this is
841 * not the case, some elements will always stay in the pool and will
842 * never be used. The access to the per-lcore table is of course
843 * faster than the multi-producer/consumer pool. The cache can be
844 * disabled if the cache_size argument is set to 0; it can be useful to
845 * avoid losing objects in cache.
846 * @param private_data_size
847 * The size of the private data appended after the mempool
848 * structure. This is useful for storing some private data after the
849 * mempool structure, as is done for rte_mbuf_pool for example.
851 * A function pointer that is called for initialization of the pool,
852 * before object initialization. The user can initialize the private
853 * data in this function if needed. This parameter can be NULL if
856 * An opaque pointer to data that can be used in the mempool
857 * constructor function.
859 * A function pointer that is called for each object at
860 * initialization of the pool. The user can set some meta data in
861 * objects if needed. This parameter can be NULL if not needed.
862 * The obj_init() function takes the mempool pointer, the init_arg,
863 * the object pointer and the object number as parameters.
864 * @param obj_init_arg
865 * An opaque pointer to data that can be used as an argument for
866 * each call to the object constructor function.
868 * The *socket_id* argument is the socket identifier in the case of
869 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
870 * constraint for the reserved zone.
872 * The *flags* arguments is an OR of following flags:
873 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
874 * between channels in RAM: the pool allocator will add padding
875 * between objects depending on the hardware configuration. See
876 * Memory alignment constraints for details. If this flag is set,
877 * the allocator will just align them to a cache line.
878 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
879 * cache-aligned. This flag removes this constraint, and no
880 * padding will be present between objects. This flag implies
881 * MEMPOOL_F_NO_SPREAD.
882 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
883 * when using rte_mempool_put() or rte_mempool_put_bulk() is
884 * "single-producer". Otherwise, it is "multi-producers".
885 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
886 * when using rte_mempool_get() or rte_mempool_get_bulk() is
887 * "single-consumer". Otherwise, it is "multi-consumers".
888 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
889 * necessarily be contiguous in IO memory.
891 * The pointer to the new allocated mempool, on success. NULL on error
892 * with rte_errno set appropriately. Possible rte_errno values include:
893 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
894 * - E_RTE_SECONDARY - function was called from a secondary process instance
895 * - EINVAL - cache size provided is too large
896 * - ENOSPC - the maximum number of memzones has already been allocated
897 * - EEXIST - a memzone with the same name already exists
898 * - ENOMEM - no appropriate memory area found in which to create memzone
901 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
902 unsigned cache_size, unsigned private_data_size,
903 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
904 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
905 int socket_id, unsigned flags);
908 * Create a new mempool named *name* in memory.
910 * The pool contains n elements of elt_size. Its size is set to n.
911 * This function uses ``memzone_reserve()`` to allocate the mempool header
912 * (and the objects if vaddr is NULL).
913 * Depending on the input parameters, mempool elements can be either allocated
914 * together with the mempool header, or an externally provided memory buffer
915 * could be used to store mempool objects. In later case, that external
916 * memory buffer can consist of set of disjoint physical pages.
919 * The name of the mempool.
921 * The number of elements in the mempool. The optimum size (in terms of
922 * memory usage) for a mempool is when n is a power of two minus one:
925 * The size of each element.
927 * Size of the cache. See rte_mempool_create() for details.
928 * @param private_data_size
929 * The size of the private data appended after the mempool
930 * structure. This is useful for storing some private data after the
931 * mempool structure, as is done for rte_mbuf_pool for example.
933 * A function pointer that is called for initialization of the pool,
934 * before object initialization. The user can initialize the private
935 * data in this function if needed. This parameter can be NULL if
938 * An opaque pointer to data that can be used in the mempool
939 * constructor function.
941 * A function called for each object at initialization of the pool.
942 * See rte_mempool_create() for details.
943 * @param obj_init_arg
944 * An opaque pointer passed to the object constructor function.
946 * The *socket_id* argument is the socket identifier in the case of
947 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
948 * constraint for the reserved zone.
950 * Flags controlling the behavior of the mempool. See
951 * rte_mempool_create() for details.
953 * Virtual address of the externally allocated memory buffer.
954 * Will be used to store mempool objects.
956 * Array of IO addresses of the pages that comprises given memory buffer.
958 * Number of elements in the iova array.
960 * LOG2 of the physical pages size.
962 * The pointer to the new allocated mempool, on success. NULL on error
963 * with rte_errno set appropriately. See rte_mempool_create() for details.
966 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
967 unsigned cache_size, unsigned private_data_size,
968 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
969 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
970 int socket_id, unsigned flags, void *vaddr,
971 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift);
974 * Create an empty mempool
976 * The mempool is allocated and initialized, but it is not populated: no
977 * memory is allocated for the mempool elements. The user has to call
978 * rte_mempool_populate_*() to add memory chunks to the pool. Once
979 * populated, the user may also want to initialize each object with
980 * rte_mempool_obj_iter().
983 * The name of the mempool.
985 * The maximum number of elements that can be added in the mempool.
986 * The optimum size (in terms of memory usage) for a mempool is when n
987 * is a power of two minus one: n = (2^q - 1).
989 * The size of each element.
991 * Size of the cache. See rte_mempool_create() for details.
992 * @param private_data_size
993 * The size of the private data appended after the mempool
994 * structure. This is useful for storing some private data after the
995 * mempool structure, as is done for rte_mbuf_pool for example.
997 * The *socket_id* argument is the socket identifier in the case of
998 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
999 * constraint for the reserved zone.
1001 * Flags controlling the behavior of the mempool. See
1002 * rte_mempool_create() for details.
1004 * The pointer to the new allocated mempool, on success. NULL on error
1005 * with rte_errno set appropriately. See rte_mempool_create() for details.
1007 struct rte_mempool *
1008 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1009 unsigned cache_size, unsigned private_data_size,
1010 int socket_id, unsigned flags);
1014 * Unlink the mempool from global list, free the memory chunks, and all
1015 * memory referenced by the mempool. The objects must not be used by
1016 * other cores as they will be freed.
1019 * A pointer to the mempool structure.
1022 rte_mempool_free(struct rte_mempool *mp);
1025 * Add physically contiguous memory for objects in the pool at init
1027 * Add a virtually and physically contiguous memory chunk in the pool
1028 * where objects can be instantiated.
1030 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1031 * the chunk doesn't need to be physically contiguous (only virtually),
1032 * and allocated objects may span two pages.
1035 * A pointer to the mempool structure.
1037 * The virtual address of memory that should be used to store objects.
1041 * The length of memory in bytes.
1043 * The callback used to free this chunk when destroying the mempool.
1045 * An opaque argument passed to free_cb.
1047 * The number of objects added on success.
1048 * On error, the chunk is not added in the memory list of the
1049 * mempool and a negative errno is returned.
1051 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1052 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1056 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
1057 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1061 * Add physical memory for objects in the pool at init
1063 * Add a virtually contiguous memory chunk in the pool where objects can
1064 * be instantiated. The IO addresses corresponding to the virtual
1065 * area are described in iova[], pg_num, pg_shift.
1068 * A pointer to the mempool structure.
1070 * The virtual address of memory that should be used to store objects.
1072 * An array of IO addresses of each page composing the virtual area.
1074 * Number of elements in the iova array.
1076 * LOG2 of the physical pages size.
1078 * The callback used to free this chunk when destroying the mempool.
1080 * An opaque argument passed to free_cb.
1082 * The number of objects added on success.
1083 * On error, the chunks are not added in the memory list of the
1084 * mempool and a negative errno is returned.
1086 int rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
1087 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
1088 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1091 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
1092 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
1093 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1096 * Add virtually contiguous memory for objects in the pool at init
1098 * Add a virtually contiguous memory chunk in the pool where objects can
1102 * A pointer to the mempool structure.
1104 * The virtual address of memory that should be used to store objects.
1105 * Must be page-aligned.
1107 * The length of memory in bytes. Must be page-aligned.
1109 * The size of memory pages in this virtual area.
1111 * The callback used to free this chunk when destroying the mempool.
1113 * An opaque argument passed to free_cb.
1115 * The number of objects added on success.
1116 * On error, the chunk is not added in the memory list of the
1117 * mempool and a negative errno is returned.
1120 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1121 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1125 * Add memory for objects in the pool at init
1127 * This is the default function used by rte_mempool_create() to populate
1128 * the mempool. It adds memory allocated using rte_memzone_reserve().
1131 * A pointer to the mempool structure.
1133 * The number of objects added on success.
1134 * On error, the chunk is not added in the memory list of the
1135 * mempool and a negative errno is returned.
1137 int rte_mempool_populate_default(struct rte_mempool *mp);
1140 * Add memory from anonymous mapping for objects in the pool at init
1142 * This function mmap an anonymous memory zone that is locked in
1143 * memory to store the objects of the mempool.
1146 * A pointer to the mempool structure.
1148 * The number of objects added on success.
1149 * On error, the chunk is not added in the memory list of the
1150 * mempool and a negative errno is returned.
1152 int rte_mempool_populate_anon(struct rte_mempool *mp);
1155 * Call a function for each mempool element
1157 * Iterate across all objects attached to a rte_mempool and call the
1158 * callback function on it.
1161 * A pointer to an initialized mempool.
1163 * A function pointer that is called for each object.
1165 * An opaque pointer passed to the callback function.
1167 * Number of objects iterated.
1169 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1170 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1173 * Call a function for each mempool memory chunk
1175 * Iterate across all memory chunks attached to a rte_mempool and call
1176 * the callback function on it.
1179 * A pointer to an initialized mempool.
1181 * A function pointer that is called for each memory chunk.
1183 * An opaque pointer passed to the callback function.
1185 * Number of memory chunks iterated.
1187 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1188 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1191 * Dump the status of the mempool to a file.
1194 * A pointer to a file for output
1196 * A pointer to the mempool structure.
1198 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1201 * Create a user-owned mempool cache.
1203 * This can be used by non-EAL threads to enable caching when they
1204 * interact with a mempool.
1207 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1208 * parameter description for more information. The same limits and
1209 * considerations apply here too.
1211 * The socket identifier in the case of NUMA. The value can be
1212 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1214 struct rte_mempool_cache *
1215 rte_mempool_cache_create(uint32_t size, int socket_id);
1218 * Free a user-owned mempool cache.
1221 * A pointer to the mempool cache.
1224 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1227 * Flush a user-owned mempool cache to the specified mempool.
1230 * A pointer to the mempool cache.
1232 * A pointer to the mempool.
1234 static __rte_always_inline void
1235 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1236 struct rte_mempool *mp)
1238 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1243 * Get a pointer to the per-lcore default mempool cache.
1246 * A pointer to the mempool structure.
1248 * The logical core id.
1250 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1252 static __rte_always_inline struct rte_mempool_cache *
1253 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1255 if (mp->cache_size == 0)
1258 if (lcore_id >= RTE_MAX_LCORE)
1261 return &mp->local_cache[lcore_id];
1265 * @internal Put several objects back in the mempool; used internally.
1267 * A pointer to the mempool structure.
1269 * A pointer to a table of void * pointers (objects).
1271 * The number of objects to store back in the mempool, must be strictly
1274 * A pointer to a mempool cache structure. May be NULL if not needed.
1276 static __rte_always_inline void
1277 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1278 unsigned int n, struct rte_mempool_cache *cache)
1282 /* increment stat now, adding in mempool always success */
1283 __MEMPOOL_STAT_ADD(mp, put, n);
1285 /* No cache provided or if put would overflow mem allocated for cache */
1286 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1289 cache_objs = &cache->objs[cache->len];
1292 * The cache follows the following algorithm
1293 * 1. Add the objects to the cache
1294 * 2. Anything greater than the cache min value (if it crosses the
1295 * cache flush threshold) is flushed to the ring.
1298 /* Add elements back into the cache */
1299 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1303 if (cache->len >= cache->flushthresh) {
1304 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1305 cache->len - cache->size);
1306 cache->len = cache->size;
1313 /* push remaining objects in ring */
1314 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1315 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1316 rte_panic("cannot put objects in mempool\n");
1318 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1324 * Put several objects back in the mempool.
1327 * A pointer to the mempool structure.
1329 * A pointer to a table of void * pointers (objects).
1331 * The number of objects to add in the mempool from the obj_table.
1333 * A pointer to a mempool cache structure. May be NULL if not needed.
1335 static __rte_always_inline void
1336 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1337 unsigned int n, struct rte_mempool_cache *cache)
1339 __mempool_check_cookies(mp, obj_table, n, 0);
1340 __mempool_generic_put(mp, obj_table, n, cache);
1344 * Put several objects back in the mempool.
1346 * This function calls the multi-producer or the single-producer
1347 * version depending on the default behavior that was specified at
1348 * mempool creation time (see flags).
1351 * A pointer to the mempool structure.
1353 * A pointer to a table of void * pointers (objects).
1355 * The number of objects to add in the mempool from obj_table.
1357 static __rte_always_inline void
1358 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1361 struct rte_mempool_cache *cache;
1362 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1363 rte_mempool_generic_put(mp, obj_table, n, cache);
1367 * Put one object back in the mempool.
1369 * This function calls the multi-producer or the single-producer
1370 * version depending on the default behavior that was specified at
1371 * mempool creation time (see flags).
1374 * A pointer to the mempool structure.
1376 * A pointer to the object to be added.
1378 static __rte_always_inline void
1379 rte_mempool_put(struct rte_mempool *mp, void *obj)
1381 rte_mempool_put_bulk(mp, &obj, 1);
1385 * @internal Get several objects from the mempool; used internally.
1387 * A pointer to the mempool structure.
1389 * A pointer to a table of void * pointers (objects).
1391 * The number of objects to get, must be strictly positive.
1393 * A pointer to a mempool cache structure. May be NULL if not needed.
1395 * - >=0: Success; number of objects supplied.
1396 * - <0: Error; code of ring dequeue function.
1398 static __rte_always_inline int
1399 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1400 unsigned int n, struct rte_mempool_cache *cache)
1403 uint32_t index, len;
1406 /* No cache provided or cannot be satisfied from cache */
1407 if (unlikely(cache == NULL || n >= cache->size))
1410 cache_objs = cache->objs;
1412 /* Can this be satisfied from the cache? */
1413 if (cache->len < n) {
1414 /* No. Backfill the cache first, and then fill from it */
1415 uint32_t req = n + (cache->size - cache->len);
1417 /* How many do we require i.e. number to fill the cache + the request */
1418 ret = rte_mempool_ops_dequeue_bulk(mp,
1419 &cache->objs[cache->len], req);
1420 if (unlikely(ret < 0)) {
1422 * In the offchance that we are buffer constrained,
1423 * where we are not able to allocate cache + n, go to
1424 * the ring directly. If that fails, we are truly out of
1433 /* Now fill in the response ... */
1434 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1435 *obj_table = cache_objs[len];
1439 __MEMPOOL_STAT_ADD(mp, get_success, n);
1445 /* get remaining objects from ring */
1446 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1449 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1451 __MEMPOOL_STAT_ADD(mp, get_success, n);
1457 * Get several objects from the mempool.
1459 * If cache is enabled, objects will be retrieved first from cache,
1460 * subsequently from the common pool. Note that it can return -ENOENT when
1461 * the local cache and common pool are empty, even if cache from other
1465 * A pointer to the mempool structure.
1467 * A pointer to a table of void * pointers (objects) that will be filled.
1469 * The number of objects to get from mempool to obj_table.
1471 * A pointer to a mempool cache structure. May be NULL if not needed.
1473 * - 0: Success; objects taken.
1474 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1476 static __rte_always_inline int
1477 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1478 unsigned int n, struct rte_mempool_cache *cache)
1481 ret = __mempool_generic_get(mp, obj_table, n, cache);
1483 __mempool_check_cookies(mp, obj_table, n, 1);
1488 * Get several objects from the mempool.
1490 * This function calls the multi-consumers or the single-consumer
1491 * version, depending on the default behaviour that was specified at
1492 * mempool creation time (see flags).
1494 * If cache is enabled, objects will be retrieved first from cache,
1495 * subsequently from the common pool. Note that it can return -ENOENT when
1496 * the local cache and common pool are empty, even if cache from other
1500 * A pointer to the mempool structure.
1502 * A pointer to a table of void * pointers (objects) that will be filled.
1504 * The number of objects to get from the mempool to obj_table.
1506 * - 0: Success; objects taken
1507 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1509 static __rte_always_inline int
1510 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1512 struct rte_mempool_cache *cache;
1513 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1514 return rte_mempool_generic_get(mp, obj_table, n, cache);
1518 * Get one object from the mempool.
1520 * This function calls the multi-consumers or the single-consumer
1521 * version, depending on the default behavior that was specified at
1522 * mempool creation (see flags).
1524 * If cache is enabled, objects will be retrieved first from cache,
1525 * subsequently from the common pool. Note that it can return -ENOENT when
1526 * the local cache and common pool are empty, even if cache from other
1530 * A pointer to the mempool structure.
1532 * A pointer to a void * pointer (object) that will be filled.
1534 * - 0: Success; objects taken.
1535 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1537 static __rte_always_inline int
1538 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1540 return rte_mempool_get_bulk(mp, obj_p, 1);
1544 * Return the number of entries in the mempool.
1546 * When cache is enabled, this function has to browse the length of
1547 * all lcores, so it should not be used in a data path, but only for
1548 * debug purposes. User-owned mempool caches are not accounted for.
1551 * A pointer to the mempool structure.
1553 * The number of entries in the mempool.
1555 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1558 * Return the number of elements which have been allocated from the mempool
1560 * When cache is enabled, this function has to browse the length of
1561 * all lcores, so it should not be used in a data path, but only for
1565 * A pointer to the mempool structure.
1567 * The number of free entries in the mempool.
1570 rte_mempool_in_use_count(const struct rte_mempool *mp);
1573 * Test if the mempool is full.
1575 * When cache is enabled, this function has to browse the length of all
1576 * lcores, so it should not be used in a data path, but only for debug
1577 * purposes. User-owned mempool caches are not accounted for.
1580 * A pointer to the mempool structure.
1582 * - 1: The mempool is full.
1583 * - 0: The mempool is not full.
1586 rte_mempool_full(const struct rte_mempool *mp)
1588 return !!(rte_mempool_avail_count(mp) == mp->size);
1592 * Test if the mempool is empty.
1594 * When cache is enabled, this function has to browse the length of all
1595 * lcores, so it should not be used in a data path, but only for debug
1596 * purposes. User-owned mempool caches are not accounted for.
1599 * A pointer to the mempool structure.
1601 * - 1: The mempool is empty.
1602 * - 0: The mempool is not empty.
1605 rte_mempool_empty(const struct rte_mempool *mp)
1607 return !!(rte_mempool_avail_count(mp) == 0);
1611 * Return the IO address of elt, which is an element of the pool mp.
1614 * A pointer (virtual address) to the element of the pool.
1616 * The IO address of the elt element.
1617 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1618 * returned value is RTE_BAD_IOVA.
1620 static inline rte_iova_t
1621 rte_mempool_virt2iova(const void *elt)
1623 const struct rte_mempool_objhdr *hdr;
1624 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1630 static inline phys_addr_t
1631 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1633 return rte_mempool_virt2iova(elt);
1637 * Check the consistency of mempool objects.
1639 * Verify the coherency of fields in the mempool structure. Also check
1640 * that the cookies of mempool objects (even the ones that are not
1641 * present in pool) have a correct value. If not, a panic will occur.
1644 * A pointer to the mempool structure.
1646 void rte_mempool_audit(struct rte_mempool *mp);
1649 * Return a pointer to the private data in an mempool structure.
1652 * A pointer to the mempool structure.
1654 * A pointer to the private data.
1656 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1659 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1663 * Dump the status of all mempools on the console
1666 * A pointer to a file for output
1668 void rte_mempool_list_dump(FILE *f);
1671 * Search a mempool from its name
1674 * The name of the mempool.
1676 * The pointer to the mempool matching the name, or NULL if not found.
1678 * with rte_errno set appropriately. Possible rte_errno values include:
1679 * - ENOENT - required entry not available to return.
1682 struct rte_mempool *rte_mempool_lookup(const char *name);
1685 * Get the header, trailer and total size of a mempool element.
1687 * Given a desired size of the mempool element and mempool flags,
1688 * calculates header, trailer, body and total sizes of the mempool object.
1691 * The size of each element, without header and trailer.
1693 * The flags used for the mempool creation.
1694 * Consult rte_mempool_create() for more information about possible values.
1695 * The size of each element.
1697 * The calculated detailed size the mempool object. May be NULL.
1699 * Total size of the mempool object.
1701 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1702 struct rte_mempool_objsz *sz);
1705 * Get the size of memory required to store mempool elements.
1707 * Calculate the maximum amount of memory required to store given number
1708 * of objects. Assume that the memory buffer will be aligned at page
1711 * Note that if object size is bigger than page size, then it assumes
1712 * that pages are grouped in subsets of physically continuous pages big
1713 * enough to store at least one object.
1716 * Number of elements.
1717 * @param total_elt_sz
1718 * The size of each element, including header and trailer, as returned
1719 * by rte_mempool_calc_obj_size().
1721 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1723 * The mempool flags.
1725 * Required memory size aligned at page boundary.
1727 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1728 uint32_t pg_shift, unsigned int flags);
1731 * Get the size of memory required to store mempool elements.
1733 * Calculate how much memory would be actually required with the given
1734 * memory footprint to store required number of objects.
1737 * Virtual address of the externally allocated memory buffer.
1738 * Will be used to store mempool objects.
1740 * Number of elements.
1741 * @param total_elt_sz
1742 * The size of each element, including header and trailer, as returned
1743 * by rte_mempool_calc_obj_size().
1745 * Array of IO addresses of the pages that comprises given memory buffer.
1747 * Number of elements in the iova array.
1749 * LOG2 of the physical pages size.
1751 * The mempool flags.
1753 * On success, the number of bytes needed to store given number of
1754 * objects, aligned to the given page size. If the provided memory
1755 * buffer is too small, return a negative value whose absolute value
1756 * is the actual number of elements that can be stored in that buffer.
1758 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1759 size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
1760 uint32_t pg_shift, unsigned int flags);
1763 * Walk list of all memory pools
1768 * Argument passed to iterator
1770 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1777 #endif /* _RTE_MEMPOOL_H_ */