1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright(c) 2016 6WIND S.A.
6 #ifndef _RTE_MEMPOOL_H_
7 #define _RTE_MEMPOOL_H_
13 * A memory pool is an allocator of fixed-size object. It is
14 * identified by its name, and uses a ring to store free objects. It
15 * provides some other optional services, like a per-core object
16 * cache, and an alignment helper to ensure that objects are padded
17 * to spread them equally on all RAM channels, ranks, and so on.
19 * Objects owned by a mempool should never be added in another
20 * mempool. When an object is freed using rte_mempool_put() or
21 * equivalent, the object data is not modified; the user can save some
22 * meta-data in the object data and retrieve them when allocating a
25 * Note: the mempool implementation is not preemptible. An lcore must not be
26 * interrupted by another task that uses the same mempool (because it uses a
27 * ring which is not preemptible). Also, usual mempool functions like
28 * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
29 * thread due to the internal per-lcore cache. Due to the lack of caching,
30 * rte_mempool_get() or rte_mempool_put() performance will suffer when called
31 * by non-EAL threads. Instead, non-EAL threads should call
32 * rte_mempool_generic_get() or rte_mempool_generic_put() with a user cache
33 * created with rte_mempool_cache_create().
41 #include <sys/queue.h>
43 #include <rte_config.h>
44 #include <rte_spinlock.h>
46 #include <rte_debug.h>
47 #include <rte_lcore.h>
48 #include <rte_memory.h>
49 #include <rte_branch_prediction.h>
51 #include <rte_memcpy.h>
52 #include <rte_common.h>
58 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
59 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
60 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
62 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
64 * A structure that stores the mempool statistics (per-lcore).
66 struct rte_mempool_debug_stats {
67 uint64_t put_bulk; /**< Number of puts. */
68 uint64_t put_objs; /**< Number of objects successfully put. */
69 uint64_t get_success_bulk; /**< Successful allocation number. */
70 uint64_t get_success_objs; /**< Objects successfully allocated. */
71 uint64_t get_fail_bulk; /**< Failed allocation number. */
72 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
73 } __rte_cache_aligned;
77 * A structure that stores a per-core object cache.
79 struct rte_mempool_cache {
80 uint32_t size; /**< Size of the cache */
81 uint32_t flushthresh; /**< Threshold before we flush excess elements */
82 uint32_t len; /**< Current cache count */
84 * Cache is allocated to this size to allow it to overflow in certain
85 * cases to avoid needless emptying of cache.
87 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
88 } __rte_cache_aligned;
91 * A structure that stores the size of mempool elements.
93 struct rte_mempool_objsz {
94 uint32_t elt_size; /**< Size of an element. */
95 uint32_t header_size; /**< Size of header (before elt). */
96 uint32_t trailer_size; /**< Size of trailer (after elt). */
98 /**< Total size of an object (header + elt + trailer). */
101 /**< Maximum length of a memory pool's name. */
102 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
103 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
104 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
107 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
109 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
111 /** Mempool over one chunk of physically continuous memory */
112 #define MEMPOOL_PG_NUM_DEFAULT 1
114 #ifndef RTE_MEMPOOL_ALIGN
115 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
118 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
121 * Mempool object header structure
123 * Each object stored in mempools are prefixed by this header structure,
124 * it allows to retrieve the mempool pointer from the object and to
125 * iterate on all objects attached to a mempool. When debug is enabled,
126 * a cookie is also added in this structure preventing corruptions and
129 struct rte_mempool_objhdr {
130 STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
131 struct rte_mempool *mp; /**< The mempool owning the object. */
134 rte_iova_t iova; /**< IO address of the object. */
135 phys_addr_t physaddr; /**< deprecated - Physical address of the object. */
137 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
138 uint64_t cookie; /**< Debug cookie. */
143 * A list of object headers type
145 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
147 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
150 * Mempool object trailer structure
152 * In debug mode, each object stored in mempools are suffixed by this
153 * trailer structure containing a cookie preventing memory corruptions.
155 struct rte_mempool_objtlr {
156 uint64_t cookie; /**< Debug cookie. */
162 * A list of memory where objects are stored
164 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
167 * Callback used to free a memory chunk
169 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
173 * Mempool objects memory header structure
175 * The memory chunks where objects are stored. Each chunk is virtually
176 * and physically contiguous.
178 struct rte_mempool_memhdr {
179 STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
180 struct rte_mempool *mp; /**< The mempool owning the chunk */
181 void *addr; /**< Virtual address of the chunk */
184 rte_iova_t iova; /**< IO address of the chunk */
185 phys_addr_t phys_addr; /**< Physical address of the chunk */
187 size_t len; /**< length of the chunk */
188 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
189 void *opaque; /**< Argument passed to the free callback */
193 * The RTE mempool structure.
197 * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
198 * compatibility requirements, it could be changed to
199 * RTE_MEMPOOL_NAMESIZE next time the ABI changes
201 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
204 void *pool_data; /**< Ring or pool to store objects. */
205 uint64_t pool_id; /**< External mempool identifier. */
207 void *pool_config; /**< optional args for ops alloc. */
208 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
209 unsigned int flags; /**< Flags of the mempool. */
210 int socket_id; /**< Socket id passed at create. */
211 uint32_t size; /**< Max size of the mempool. */
213 /**< Size of per-lcore default local cache. */
215 uint32_t elt_size; /**< Size of an element. */
216 uint32_t header_size; /**< Size of header (before elt). */
217 uint32_t trailer_size; /**< Size of trailer (after elt). */
219 unsigned private_data_size; /**< Size of private data. */
221 * Index into rte_mempool_ops_table array of mempool ops
222 * structs, which contain callback function pointers.
223 * We're using an index here rather than pointers to the callbacks
224 * to facilitate any secondary processes that may want to use
229 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
231 uint32_t populated_size; /**< Number of populated objects. */
232 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
233 uint32_t nb_mem_chunks; /**< Number of memory chunks */
234 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
236 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
237 /** Per-lcore statistics. */
238 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
240 } __rte_cache_aligned;
242 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread among memory channels. */
243 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
244 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
245 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
246 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
247 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
248 #define MEMPOOL_F_NO_PHYS_CONTIG MEMPOOL_F_NO_IOVA_CONTIG /* deprecated */
251 * @internal When debug is enabled, store some statistics.
254 * Pointer to the memory pool.
256 * Name of the statistics field to increment in the memory pool.
258 * Number to add to the object-oriented statistics.
260 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
261 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
262 unsigned __lcore_id = rte_lcore_id(); \
263 if (__lcore_id < RTE_MAX_LCORE) { \
264 mp->stats[__lcore_id].name##_objs += n; \
265 mp->stats[__lcore_id].name##_bulk += 1; \
269 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
273 * Calculate the size of the mempool header.
276 * Pointer to the memory pool.
278 * Size of the per-lcore cache.
280 #define MEMPOOL_HEADER_SIZE(mp, cs) \
281 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
282 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
284 /* return the header of a mempool object (internal) */
285 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
287 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
288 sizeof(struct rte_mempool_objhdr));
292 * Return a pointer to the mempool owning this object.
295 * An object that is owned by a pool. If this is not the case,
296 * the behavior is undefined.
298 * A pointer to the mempool structure.
300 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
302 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
306 /* return the trailer of a mempool object (internal) */
307 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
309 struct rte_mempool *mp = rte_mempool_from_obj(obj);
310 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
314 * @internal Check and update cookies or panic.
317 * Pointer to the memory pool.
318 * @param obj_table_const
319 * Pointer to a table of void * pointers (objects).
321 * Index of object in object table.
323 * - 0: object is supposed to be allocated, mark it as free
324 * - 1: object is supposed to be free, mark it as allocated
325 * - 2: just check that cookie is valid (free or allocated)
327 void rte_mempool_check_cookies(const struct rte_mempool *mp,
328 void * const *obj_table_const, unsigned n, int free);
330 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
331 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
332 rte_mempool_check_cookies(mp, obj_table_const, n, free)
334 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
335 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
337 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
340 * Prototype for implementation specific data provisioning function.
342 * The function should provide the implementation specific memory for
343 * use by the other mempool ops functions in a given mempool ops struct.
344 * E.g. the default ops provides an instance of the rte_ring for this purpose.
345 * it will most likely point to a different type of data structure, and
346 * will be transparent to the application programmer.
347 * This function should set mp->pool_data.
349 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
352 * Free the opaque private data pointed to by mp->pool_data pointer.
354 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
357 * Enqueue an object into the external pool.
359 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
360 void * const *obj_table, unsigned int n);
363 * Dequeue an object from the external pool.
365 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
366 void **obj_table, unsigned int n);
369 * Return the number of available objects in the external pool.
371 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
374 * Notify new memory area to mempool.
376 typedef int (*rte_mempool_ops_register_memory_area_t)
377 (const struct rte_mempool *mp, char *vaddr, rte_iova_t iova, size_t len);
380 * Calculate memory size required to store given number of objects.
382 * If mempool objects are not required to be IOVA-contiguous
383 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
384 * virtually contiguous chunk size. Otherwise, if mempool objects must
385 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
386 * min_chunk_size defines IOVA-contiguous chunk size.
389 * Pointer to the memory pool.
392 * @param[in] pg_shift
393 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
394 * @param[out] min_chunk_size
395 * Location for minimum size of the memory chunk which may be used to
396 * store memory pool objects.
398 * Location for required memory chunk alignment.
400 * Required memory size aligned at page boundary.
402 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
403 uint32_t obj_num, uint32_t pg_shift,
404 size_t *min_chunk_size, size_t *align);
407 * Default way to calculate memory size required to store given number of
410 * If page boundaries may be ignored, it is just a product of total
411 * object size including header and trailer and number of objects.
412 * Otherwise, it is a number of pages required to store given number of
413 * objects without crossing page boundary.
415 * Note that if object size is bigger than page size, then it assumes
416 * that pages are grouped in subsets of physically continuous pages big
417 * enough to store at least one object.
419 * Minimum size of memory chunk is a maximum of the page size and total
422 * Required memory chunk alignment is a maximum of page size and cache
425 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
426 uint32_t obj_num, uint32_t pg_shift,
427 size_t *min_chunk_size, size_t *align);
430 * @internal Helper function to calculate memory size required to store
431 * specified number of objects in assumption that the memory buffer will
432 * be aligned at page boundary.
434 * Note that if object size is bigger than page size, then it assumes
435 * that pages are grouped in subsets of physically continuous pages big
436 * enough to store at least one object.
439 * Number of elements.
440 * @param total_elt_sz
441 * The size of each element, including header and trailer, as returned
442 * by rte_mempool_calc_obj_size().
444 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
446 * Required memory size aligned at page boundary.
448 size_t rte_mempool_calc_mem_size_helper(uint32_t elt_num, size_t total_elt_sz,
452 * Function to be called for each populated object.
455 * A pointer to the mempool structure.
457 * An opaque pointer passed to iterator.
459 * Object virtual address.
461 * Input/output virtual address of the object or RTE_BAD_IOVA.
463 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
464 void *opaque, void *vaddr, rte_iova_t iova);
467 * Populate memory pool objects using provided memory chunk.
469 * Populated objects should be enqueued to the pool, e.g. using
470 * rte_mempool_ops_enqueue_bulk().
472 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
473 * the chunk doesn't need to be physically contiguous (only virtually),
474 * and allocated objects may span two pages.
477 * A pointer to the mempool structure.
478 * @param[in] max_objs
479 * Maximum number of objects to be populated.
481 * The virtual address of memory that should be used to store objects.
485 * The length of memory in bytes.
487 * Callback function to be executed for each populated object.
488 * @param[in] obj_cb_arg
489 * An opaque pointer passed to the callback function.
491 * The number of objects added on success.
492 * On error, no objects are populated and a negative errno is returned.
494 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
495 unsigned int max_objs,
496 void *vaddr, rte_iova_t iova, size_t len,
497 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
500 * Default way to populate memory pool object using provided memory
501 * chunk: just slice objects one by one.
503 int rte_mempool_op_populate_default(struct rte_mempool *mp,
504 unsigned int max_objs,
505 void *vaddr, rte_iova_t iova, size_t len,
506 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
508 /** Structure defining mempool operations structure */
509 struct rte_mempool_ops {
510 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
511 rte_mempool_alloc_t alloc; /**< Allocate private data. */
512 rte_mempool_free_t free; /**< Free the external pool. */
513 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
514 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
515 rte_mempool_get_count get_count; /**< Get qty of available objs. */
517 * Notify new memory area to mempool
519 rte_mempool_ops_register_memory_area_t register_memory_area;
521 * Optional callback to calculate memory size required to
522 * store specified number of objects.
524 rte_mempool_calc_mem_size_t calc_mem_size;
526 * Optional callback to populate mempool objects using
527 * provided memory chunk.
529 rte_mempool_populate_t populate;
530 } __rte_cache_aligned;
532 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
535 * Structure storing the table of registered ops structs, each of which contain
536 * the function pointers for the mempool ops functions.
537 * Each process has its own storage for this ops struct array so that
538 * the mempools can be shared across primary and secondary processes.
539 * The indices used to access the array are valid across processes, whereas
540 * any function pointers stored directly in the mempool struct would not be.
541 * This results in us simply having "ops_index" in the mempool struct.
543 struct rte_mempool_ops_table {
544 rte_spinlock_t sl; /**< Spinlock for add/delete. */
545 uint32_t num_ops; /**< Number of used ops structs in the table. */
547 * Storage for all possible ops structs.
549 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
550 } __rte_cache_aligned;
552 /** Array of registered ops structs. */
553 extern struct rte_mempool_ops_table rte_mempool_ops_table;
556 * @internal Get the mempool ops struct from its index.
559 * The index of the ops struct in the ops struct table. It must be a valid
560 * index: (0 <= idx < num_ops).
562 * The pointer to the ops struct in the table.
564 static inline struct rte_mempool_ops *
565 rte_mempool_get_ops(int ops_index)
567 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
569 return &rte_mempool_ops_table.ops[ops_index];
573 * @internal Wrapper for mempool_ops alloc callback.
576 * Pointer to the memory pool.
578 * - 0: Success; successfully allocated mempool pool_data.
579 * - <0: Error; code of alloc function.
582 rte_mempool_ops_alloc(struct rte_mempool *mp);
585 * @internal Wrapper for mempool_ops dequeue callback.
588 * Pointer to the memory pool.
590 * Pointer to a table of void * pointers (objects).
592 * Number of objects to get.
594 * - 0: Success; got n objects.
595 * - <0: Error; code of dequeue function.
598 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
599 void **obj_table, unsigned n)
601 struct rte_mempool_ops *ops;
603 ops = rte_mempool_get_ops(mp->ops_index);
604 return ops->dequeue(mp, obj_table, n);
608 * @internal wrapper for mempool_ops enqueue callback.
611 * Pointer to the memory pool.
613 * Pointer to a table of void * pointers (objects).
615 * Number of objects to put.
617 * - 0: Success; n objects supplied.
618 * - <0: Error; code of enqueue function.
621 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
624 struct rte_mempool_ops *ops;
626 ops = rte_mempool_get_ops(mp->ops_index);
627 return ops->enqueue(mp, obj_table, n);
631 * @internal wrapper for mempool_ops get_count callback.
634 * Pointer to the memory pool.
636 * The number of available objects in the external pool.
639 rte_mempool_ops_get_count(const struct rte_mempool *mp);
642 * @internal wrapper for mempool_ops register_memory_area callback.
643 * API to notify the mempool handler when a new memory area is added to pool.
646 * Pointer to the memory pool.
648 * Pointer to the buffer virtual address.
650 * Pointer to the buffer IO address.
655 * - -ENOTSUP - doesn't support register_memory_area ops (valid error case).
656 * - Otherwise, rte_mempool_populate_phys fails thus pool create fails.
659 rte_mempool_ops_register_memory_area(const struct rte_mempool *mp,
660 char *vaddr, rte_iova_t iova, size_t len);
663 * @internal wrapper for mempool_ops calc_mem_size callback.
664 * API to calculate size of memory required to store specified number of
668 * Pointer to the memory pool.
671 * @param[in] pg_shift
672 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
673 * @param[out] min_chunk_size
674 * Location for minimum size of the memory chunk which may be used to
675 * store memory pool objects.
677 * Location for required memory chunk alignment.
679 * Required memory size aligned at page boundary.
681 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
682 uint32_t obj_num, uint32_t pg_shift,
683 size_t *min_chunk_size, size_t *align);
686 * @internal wrapper for mempool_ops populate callback.
688 * Populate memory pool objects using provided memory chunk.
691 * A pointer to the mempool structure.
692 * @param[in] max_objs
693 * Maximum number of objects to be populated.
695 * The virtual address of memory that should be used to store objects.
699 * The length of memory in bytes.
701 * Callback function to be executed for each populated object.
702 * @param[in] obj_cb_arg
703 * An opaque pointer passed to the callback function.
705 * The number of objects added on success.
706 * On error, no objects are populated and a negative errno is returned.
708 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
709 void *vaddr, rte_iova_t iova, size_t len,
710 rte_mempool_populate_obj_cb_t *obj_cb,
714 * @internal wrapper for mempool_ops free callback.
717 * Pointer to the memory pool.
720 rte_mempool_ops_free(struct rte_mempool *mp);
723 * Set the ops of a mempool.
725 * This can only be done on a mempool that is not populated, i.e. just after
726 * a call to rte_mempool_create_empty().
729 * Pointer to the memory pool.
731 * Name of the ops structure to use for this mempool.
733 * Opaque data that can be passed by the application to the ops functions.
735 * - 0: Success; the mempool is now using the requested ops functions.
736 * - -EINVAL - Invalid ops struct name provided.
737 * - -EEXIST - mempool already has an ops struct assigned.
740 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
744 * Register mempool operations.
747 * Pointer to an ops structure to register.
749 * - >=0: Success; return the index of the ops struct in the table.
750 * - -EINVAL - some missing callbacks while registering ops struct.
751 * - -ENOSPC - the maximum number of ops structs has been reached.
753 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
756 * Macro to statically register the ops of a mempool handler.
757 * Note that the rte_mempool_register_ops fails silently here when
758 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
760 #define MEMPOOL_REGISTER_OPS(ops) \
761 void mp_hdlr_init_##ops(void); \
762 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
764 rte_mempool_register_ops(&ops); \
768 * An object callback function for mempool.
770 * Used by rte_mempool_create() and rte_mempool_obj_iter().
772 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
773 void *opaque, void *obj, unsigned obj_idx);
774 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
777 * A memory callback function for mempool.
779 * Used by rte_mempool_mem_iter().
781 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
782 void *opaque, struct rte_mempool_memhdr *memhdr,
786 * A mempool constructor callback function.
788 * Arguments are the mempool and the opaque pointer given by the user in
789 * rte_mempool_create().
791 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
794 * Create a new mempool named *name* in memory.
796 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
797 * pool contains n elements of elt_size. Its size is set to n.
800 * The name of the mempool.
802 * The number of elements in the mempool. The optimum size (in terms of
803 * memory usage) for a mempool is when n is a power of two minus one:
806 * The size of each element.
808 * If cache_size is non-zero, the rte_mempool library will try to
809 * limit the accesses to the common lockless pool, by maintaining a
810 * per-lcore object cache. This argument must be lower or equal to
811 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
812 * cache_size to have "n modulo cache_size == 0": if this is
813 * not the case, some elements will always stay in the pool and will
814 * never be used. The access to the per-lcore table is of course
815 * faster than the multi-producer/consumer pool. The cache can be
816 * disabled if the cache_size argument is set to 0; it can be useful to
817 * avoid losing objects in cache.
818 * @param private_data_size
819 * The size of the private data appended after the mempool
820 * structure. This is useful for storing some private data after the
821 * mempool structure, as is done for rte_mbuf_pool for example.
823 * A function pointer that is called for initialization of the pool,
824 * before object initialization. The user can initialize the private
825 * data in this function if needed. This parameter can be NULL if
828 * An opaque pointer to data that can be used in the mempool
829 * constructor function.
831 * A function pointer that is called for each object at
832 * initialization of the pool. The user can set some meta data in
833 * objects if needed. This parameter can be NULL if not needed.
834 * The obj_init() function takes the mempool pointer, the init_arg,
835 * the object pointer and the object number as parameters.
836 * @param obj_init_arg
837 * An opaque pointer to data that can be used as an argument for
838 * each call to the object constructor function.
840 * The *socket_id* argument is the socket identifier in the case of
841 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
842 * constraint for the reserved zone.
844 * The *flags* arguments is an OR of following flags:
845 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
846 * between channels in RAM: the pool allocator will add padding
847 * between objects depending on the hardware configuration. See
848 * Memory alignment constraints for details. If this flag is set,
849 * the allocator will just align them to a cache line.
850 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
851 * cache-aligned. This flag removes this constraint, and no
852 * padding will be present between objects. This flag implies
853 * MEMPOOL_F_NO_SPREAD.
854 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
855 * when using rte_mempool_put() or rte_mempool_put_bulk() is
856 * "single-producer". Otherwise, it is "multi-producers".
857 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
858 * when using rte_mempool_get() or rte_mempool_get_bulk() is
859 * "single-consumer". Otherwise, it is "multi-consumers".
860 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
861 * necessarily be contiguous in IO memory.
863 * The pointer to the new allocated mempool, on success. NULL on error
864 * with rte_errno set appropriately. Possible rte_errno values include:
865 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
866 * - E_RTE_SECONDARY - function was called from a secondary process instance
867 * - EINVAL - cache size provided is too large
868 * - ENOSPC - the maximum number of memzones has already been allocated
869 * - EEXIST - a memzone with the same name already exists
870 * - ENOMEM - no appropriate memory area found in which to create memzone
873 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
874 unsigned cache_size, unsigned private_data_size,
875 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
876 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
877 int socket_id, unsigned flags);
881 * Create a new mempool named *name* in memory.
883 * The pool contains n elements of elt_size. Its size is set to n.
884 * This function uses ``memzone_reserve()`` to allocate the mempool header
885 * (and the objects if vaddr is NULL).
886 * Depending on the input parameters, mempool elements can be either allocated
887 * together with the mempool header, or an externally provided memory buffer
888 * could be used to store mempool objects. In later case, that external
889 * memory buffer can consist of set of disjoint physical pages.
892 * The name of the mempool.
894 * The number of elements in the mempool. The optimum size (in terms of
895 * memory usage) for a mempool is when n is a power of two minus one:
898 * The size of each element.
900 * Size of the cache. See rte_mempool_create() for details.
901 * @param private_data_size
902 * The size of the private data appended after the mempool
903 * structure. This is useful for storing some private data after the
904 * mempool structure, as is done for rte_mbuf_pool for example.
906 * A function pointer that is called for initialization of the pool,
907 * before object initialization. The user can initialize the private
908 * data in this function if needed. This parameter can be NULL if
911 * An opaque pointer to data that can be used in the mempool
912 * constructor function.
914 * A function called for each object at initialization of the pool.
915 * See rte_mempool_create() for details.
916 * @param obj_init_arg
917 * An opaque pointer passed to the object constructor function.
919 * The *socket_id* argument is the socket identifier in the case of
920 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
921 * constraint for the reserved zone.
923 * Flags controlling the behavior of the mempool. See
924 * rte_mempool_create() for details.
926 * Virtual address of the externally allocated memory buffer.
927 * Will be used to store mempool objects.
929 * Array of IO addresses of the pages that comprises given memory buffer.
931 * Number of elements in the iova array.
933 * LOG2 of the physical pages size.
935 * The pointer to the new allocated mempool, on success. NULL on error
936 * with rte_errno set appropriately. See rte_mempool_create() for details.
940 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
941 unsigned cache_size, unsigned private_data_size,
942 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
943 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
944 int socket_id, unsigned flags, void *vaddr,
945 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift);
948 * Create an empty mempool
950 * The mempool is allocated and initialized, but it is not populated: no
951 * memory is allocated for the mempool elements. The user has to call
952 * rte_mempool_populate_*() to add memory chunks to the pool. Once
953 * populated, the user may also want to initialize each object with
954 * rte_mempool_obj_iter().
957 * The name of the mempool.
959 * The maximum number of elements that can be added in the mempool.
960 * The optimum size (in terms of memory usage) for a mempool is when n
961 * is a power of two minus one: n = (2^q - 1).
963 * The size of each element.
965 * Size of the cache. See rte_mempool_create() for details.
966 * @param private_data_size
967 * The size of the private data appended after the mempool
968 * structure. This is useful for storing some private data after the
969 * mempool structure, as is done for rte_mbuf_pool for example.
971 * The *socket_id* argument is the socket identifier in the case of
972 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
973 * constraint for the reserved zone.
975 * Flags controlling the behavior of the mempool. See
976 * rte_mempool_create() for details.
978 * The pointer to the new allocated mempool, on success. NULL on error
979 * with rte_errno set appropriately. See rte_mempool_create() for details.
982 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
983 unsigned cache_size, unsigned private_data_size,
984 int socket_id, unsigned flags);
988 * Unlink the mempool from global list, free the memory chunks, and all
989 * memory referenced by the mempool. The objects must not be used by
990 * other cores as they will be freed.
993 * A pointer to the mempool structure.
996 rte_mempool_free(struct rte_mempool *mp);
999 * Add physically contiguous memory for objects in the pool at init
1001 * Add a virtually and physically contiguous memory chunk in the pool
1002 * where objects can be instantiated.
1004 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1005 * the chunk doesn't need to be physically contiguous (only virtually),
1006 * and allocated objects may span two pages.
1009 * A pointer to the mempool structure.
1011 * The virtual address of memory that should be used to store objects.
1015 * The length of memory in bytes.
1017 * The callback used to free this chunk when destroying the mempool.
1019 * An opaque argument passed to free_cb.
1021 * The number of objects added on success.
1022 * On error, the chunk is not added in the memory list of the
1023 * mempool and a negative errno is returned.
1025 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1026 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1030 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
1031 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1036 * Add physical memory for objects in the pool at init
1038 * Add a virtually contiguous memory chunk in the pool where objects can
1039 * be instantiated. The IO addresses corresponding to the virtual
1040 * area are described in iova[], pg_num, pg_shift.
1043 * A pointer to the mempool structure.
1045 * The virtual address of memory that should be used to store objects.
1047 * An array of IO addresses of each page composing the virtual area.
1049 * Number of elements in the iova array.
1051 * LOG2 of the physical pages size.
1053 * The callback used to free this chunk when destroying the mempool.
1055 * An opaque argument passed to free_cb.
1057 * The number of objects added on success.
1058 * On error, the chunks are not added in the memory list of the
1059 * mempool and a negative errno is returned.
1062 int rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
1063 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
1064 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1067 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
1068 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
1069 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1072 * Add virtually contiguous memory for objects in the pool at init
1074 * Add a virtually contiguous memory chunk in the pool where objects can
1078 * A pointer to the mempool structure.
1080 * The virtual address of memory that should be used to store objects.
1081 * Must be page-aligned.
1083 * The length of memory in bytes. Must be page-aligned.
1085 * The size of memory pages in this virtual area.
1087 * The callback used to free this chunk when destroying the mempool.
1089 * An opaque argument passed to free_cb.
1091 * The number of objects added on success.
1092 * On error, the chunk is not added in the memory list of the
1093 * mempool and a negative errno is returned.
1096 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1097 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1101 * Add memory for objects in the pool at init
1103 * This is the default function used by rte_mempool_create() to populate
1104 * the mempool. It adds memory allocated using rte_memzone_reserve().
1107 * A pointer to the mempool structure.
1109 * The number of objects added on success.
1110 * On error, the chunk is not added in the memory list of the
1111 * mempool and a negative errno is returned.
1113 int rte_mempool_populate_default(struct rte_mempool *mp);
1116 * Add memory from anonymous mapping for objects in the pool at init
1118 * This function mmap an anonymous memory zone that is locked in
1119 * memory to store the objects of the mempool.
1122 * A pointer to the mempool structure.
1124 * The number of objects added on success.
1125 * On error, the chunk is not added in the memory list of the
1126 * mempool and a negative errno is returned.
1128 int rte_mempool_populate_anon(struct rte_mempool *mp);
1131 * Call a function for each mempool element
1133 * Iterate across all objects attached to a rte_mempool and call the
1134 * callback function on it.
1137 * A pointer to an initialized mempool.
1139 * A function pointer that is called for each object.
1141 * An opaque pointer passed to the callback function.
1143 * Number of objects iterated.
1145 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1146 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1149 * Call a function for each mempool memory chunk
1151 * Iterate across all memory chunks attached to a rte_mempool and call
1152 * the callback function on it.
1155 * A pointer to an initialized mempool.
1157 * A function pointer that is called for each memory chunk.
1159 * An opaque pointer passed to the callback function.
1161 * Number of memory chunks iterated.
1163 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1164 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1167 * Dump the status of the mempool to a file.
1170 * A pointer to a file for output
1172 * A pointer to the mempool structure.
1174 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1177 * Create a user-owned mempool cache.
1179 * This can be used by non-EAL threads to enable caching when they
1180 * interact with a mempool.
1183 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1184 * parameter description for more information. The same limits and
1185 * considerations apply here too.
1187 * The socket identifier in the case of NUMA. The value can be
1188 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1190 struct rte_mempool_cache *
1191 rte_mempool_cache_create(uint32_t size, int socket_id);
1194 * Free a user-owned mempool cache.
1197 * A pointer to the mempool cache.
1200 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1203 * Flush a user-owned mempool cache to the specified mempool.
1206 * A pointer to the mempool cache.
1208 * A pointer to the mempool.
1210 static __rte_always_inline void
1211 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1212 struct rte_mempool *mp)
1214 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1219 * Get a pointer to the per-lcore default mempool cache.
1222 * A pointer to the mempool structure.
1224 * The logical core id.
1226 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1228 static __rte_always_inline struct rte_mempool_cache *
1229 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1231 if (mp->cache_size == 0)
1234 if (lcore_id >= RTE_MAX_LCORE)
1237 return &mp->local_cache[lcore_id];
1241 * @internal Put several objects back in the mempool; used internally.
1243 * A pointer to the mempool structure.
1245 * A pointer to a table of void * pointers (objects).
1247 * The number of objects to store back in the mempool, must be strictly
1250 * A pointer to a mempool cache structure. May be NULL if not needed.
1252 static __rte_always_inline void
1253 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1254 unsigned int n, struct rte_mempool_cache *cache)
1258 /* increment stat now, adding in mempool always success */
1259 __MEMPOOL_STAT_ADD(mp, put, n);
1261 /* No cache provided or if put would overflow mem allocated for cache */
1262 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1265 cache_objs = &cache->objs[cache->len];
1268 * The cache follows the following algorithm
1269 * 1. Add the objects to the cache
1270 * 2. Anything greater than the cache min value (if it crosses the
1271 * cache flush threshold) is flushed to the ring.
1274 /* Add elements back into the cache */
1275 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1279 if (cache->len >= cache->flushthresh) {
1280 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1281 cache->len - cache->size);
1282 cache->len = cache->size;
1289 /* push remaining objects in ring */
1290 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1291 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1292 rte_panic("cannot put objects in mempool\n");
1294 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1300 * Put several objects back in the mempool.
1303 * A pointer to the mempool structure.
1305 * A pointer to a table of void * pointers (objects).
1307 * The number of objects to add in the mempool from the obj_table.
1309 * A pointer to a mempool cache structure. May be NULL if not needed.
1311 static __rte_always_inline void
1312 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1313 unsigned int n, struct rte_mempool_cache *cache)
1315 __mempool_check_cookies(mp, obj_table, n, 0);
1316 __mempool_generic_put(mp, obj_table, n, cache);
1320 * Put several objects back in the mempool.
1322 * This function calls the multi-producer or the single-producer
1323 * version depending on the default behavior that was specified at
1324 * mempool creation time (see flags).
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 obj_table.
1333 static __rte_always_inline void
1334 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1337 struct rte_mempool_cache *cache;
1338 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1339 rte_mempool_generic_put(mp, obj_table, n, cache);
1343 * Put one object back in the mempool.
1345 * This function calls the multi-producer or the single-producer
1346 * version depending on the default behavior that was specified at
1347 * mempool creation time (see flags).
1350 * A pointer to the mempool structure.
1352 * A pointer to the object to be added.
1354 static __rte_always_inline void
1355 rte_mempool_put(struct rte_mempool *mp, void *obj)
1357 rte_mempool_put_bulk(mp, &obj, 1);
1361 * @internal Get several objects from the mempool; used internally.
1363 * A pointer to the mempool structure.
1365 * A pointer to a table of void * pointers (objects).
1367 * The number of objects to get, must be strictly positive.
1369 * A pointer to a mempool cache structure. May be NULL if not needed.
1371 * - >=0: Success; number of objects supplied.
1372 * - <0: Error; code of ring dequeue function.
1374 static __rte_always_inline int
1375 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1376 unsigned int n, struct rte_mempool_cache *cache)
1379 uint32_t index, len;
1382 /* No cache provided or cannot be satisfied from cache */
1383 if (unlikely(cache == NULL || n >= cache->size))
1386 cache_objs = cache->objs;
1388 /* Can this be satisfied from the cache? */
1389 if (cache->len < n) {
1390 /* No. Backfill the cache first, and then fill from it */
1391 uint32_t req = n + (cache->size - cache->len);
1393 /* How many do we require i.e. number to fill the cache + the request */
1394 ret = rte_mempool_ops_dequeue_bulk(mp,
1395 &cache->objs[cache->len], req);
1396 if (unlikely(ret < 0)) {
1398 * In the offchance that we are buffer constrained,
1399 * where we are not able to allocate cache + n, go to
1400 * the ring directly. If that fails, we are truly out of
1409 /* Now fill in the response ... */
1410 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1411 *obj_table = cache_objs[len];
1415 __MEMPOOL_STAT_ADD(mp, get_success, n);
1421 /* get remaining objects from ring */
1422 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1425 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1427 __MEMPOOL_STAT_ADD(mp, get_success, n);
1433 * Get several objects from the mempool.
1435 * If cache is enabled, objects will be retrieved first from cache,
1436 * subsequently from the common pool. Note that it can return -ENOENT when
1437 * the local cache and common pool are empty, even if cache from other
1441 * A pointer to the mempool structure.
1443 * A pointer to a table of void * pointers (objects) that will be filled.
1445 * The number of objects to get from mempool to obj_table.
1447 * A pointer to a mempool cache structure. May be NULL if not needed.
1449 * - 0: Success; objects taken.
1450 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1452 static __rte_always_inline int
1453 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1454 unsigned int n, struct rte_mempool_cache *cache)
1457 ret = __mempool_generic_get(mp, obj_table, n, cache);
1459 __mempool_check_cookies(mp, obj_table, n, 1);
1464 * Get several objects from the mempool.
1466 * This function calls the multi-consumers or the single-consumer
1467 * version, depending on the default behaviour that was specified at
1468 * mempool creation time (see flags).
1470 * If cache is enabled, objects will be retrieved first from cache,
1471 * subsequently from the common pool. Note that it can return -ENOENT when
1472 * the local cache and common pool are empty, even if cache from other
1476 * A pointer to the mempool structure.
1478 * A pointer to a table of void * pointers (objects) that will be filled.
1480 * The number of objects to get from the mempool to obj_table.
1482 * - 0: Success; objects taken
1483 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1485 static __rte_always_inline int
1486 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1488 struct rte_mempool_cache *cache;
1489 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1490 return rte_mempool_generic_get(mp, obj_table, n, cache);
1494 * Get one object from the mempool.
1496 * This function calls the multi-consumers or the single-consumer
1497 * version, depending on the default behavior that was specified at
1498 * mempool creation (see flags).
1500 * If cache is enabled, objects will be retrieved first from cache,
1501 * subsequently from the common pool. Note that it can return -ENOENT when
1502 * the local cache and common pool are empty, even if cache from other
1506 * A pointer to the mempool structure.
1508 * A pointer to a void * pointer (object) that will be filled.
1510 * - 0: Success; objects taken.
1511 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1513 static __rte_always_inline int
1514 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1516 return rte_mempool_get_bulk(mp, obj_p, 1);
1520 * Return the number of entries in the mempool.
1522 * When cache is enabled, this function has to browse the length of
1523 * all lcores, so it should not be used in a data path, but only for
1524 * debug purposes. User-owned mempool caches are not accounted for.
1527 * A pointer to the mempool structure.
1529 * The number of entries in the mempool.
1531 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1534 * Return the number of elements which have been allocated from the mempool
1536 * When cache is enabled, this function has to browse the length of
1537 * all lcores, so it should not be used in a data path, but only for
1541 * A pointer to the mempool structure.
1543 * The number of free entries in the mempool.
1546 rte_mempool_in_use_count(const struct rte_mempool *mp);
1549 * Test if the mempool is full.
1551 * When cache is enabled, this function has to browse the length of all
1552 * lcores, so it should not be used in a data path, but only for debug
1553 * purposes. User-owned mempool caches are not accounted for.
1556 * A pointer to the mempool structure.
1558 * - 1: The mempool is full.
1559 * - 0: The mempool is not full.
1562 rte_mempool_full(const struct rte_mempool *mp)
1564 return !!(rte_mempool_avail_count(mp) == mp->size);
1568 * Test if the mempool is empty.
1570 * When cache is enabled, this function has to browse the length of all
1571 * lcores, so it should not be used in a data path, but only for debug
1572 * purposes. User-owned mempool caches are not accounted for.
1575 * A pointer to the mempool structure.
1577 * - 1: The mempool is empty.
1578 * - 0: The mempool is not empty.
1581 rte_mempool_empty(const struct rte_mempool *mp)
1583 return !!(rte_mempool_avail_count(mp) == 0);
1587 * Return the IO address of elt, which is an element of the pool mp.
1590 * A pointer (virtual address) to the element of the pool.
1592 * The IO address of the elt element.
1593 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1594 * returned value is RTE_BAD_IOVA.
1596 static inline rte_iova_t
1597 rte_mempool_virt2iova(const void *elt)
1599 const struct rte_mempool_objhdr *hdr;
1600 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1606 static inline phys_addr_t
1607 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1609 return rte_mempool_virt2iova(elt);
1613 * Check the consistency of mempool objects.
1615 * Verify the coherency of fields in the mempool structure. Also check
1616 * that the cookies of mempool objects (even the ones that are not
1617 * present in pool) have a correct value. If not, a panic will occur.
1620 * A pointer to the mempool structure.
1622 void rte_mempool_audit(struct rte_mempool *mp);
1625 * Return a pointer to the private data in an mempool structure.
1628 * A pointer to the mempool structure.
1630 * A pointer to the private data.
1632 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1635 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1639 * Dump the status of all mempools on the console
1642 * A pointer to a file for output
1644 void rte_mempool_list_dump(FILE *f);
1647 * Search a mempool from its name
1650 * The name of the mempool.
1652 * The pointer to the mempool matching the name, or NULL if not found.
1654 * with rte_errno set appropriately. Possible rte_errno values include:
1655 * - ENOENT - required entry not available to return.
1658 struct rte_mempool *rte_mempool_lookup(const char *name);
1661 * Get the header, trailer and total size of a mempool element.
1663 * Given a desired size of the mempool element and mempool flags,
1664 * calculates header, trailer, body and total sizes of the mempool object.
1667 * The size of each element, without header and trailer.
1669 * The flags used for the mempool creation.
1670 * Consult rte_mempool_create() for more information about possible values.
1671 * The size of each element.
1673 * The calculated detailed size the mempool object. May be NULL.
1675 * Total size of the mempool object.
1677 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1678 struct rte_mempool_objsz *sz);
1682 * Get the size of memory required to store mempool elements.
1684 * Calculate the maximum amount of memory required to store given number
1685 * of objects. Assume that the memory buffer will be aligned at page
1688 * Note that if object size is bigger than page size, then it assumes
1689 * that pages are grouped in subsets of physically continuous pages big
1690 * enough to store at least one object.
1693 * Number of elements.
1694 * @param total_elt_sz
1695 * The size of each element, including header and trailer, as returned
1696 * by rte_mempool_calc_obj_size().
1698 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1700 * The mempool flags.
1702 * Required memory size aligned at page boundary.
1705 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1706 uint32_t pg_shift, unsigned int flags);
1710 * Get the size of memory required to store mempool elements.
1712 * Calculate how much memory would be actually required with the given
1713 * memory footprint to store required number of objects.
1716 * Virtual address of the externally allocated memory buffer.
1717 * Will be used to store mempool objects.
1719 * Number of elements.
1720 * @param total_elt_sz
1721 * The size of each element, including header and trailer, as returned
1722 * by rte_mempool_calc_obj_size().
1724 * Array of IO addresses of the pages that comprises given memory buffer.
1726 * Number of elements in the iova array.
1728 * LOG2 of the physical pages size.
1730 * The mempool flags.
1732 * On success, the number of bytes needed to store given number of
1733 * objects, aligned to the given page size. If the provided memory
1734 * buffer is too small, return a negative value whose absolute value
1735 * is the actual number of elements that can be stored in that buffer.
1738 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1739 size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
1740 uint32_t pg_shift, unsigned int flags);
1743 * Walk list of all memory pools
1748 * Argument passed to iterator
1750 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1757 #endif /* _RTE_MEMPOOL_H_ */