1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright(c) 2016 6WIND S.A.
6 #ifndef _RTE_MEMPOOL_H_
7 #define _RTE_MEMPOOL_H_
13 * A memory pool is an allocator of fixed-size object. It is
14 * identified by its name, and uses a ring to store free objects. It
15 * provides some other optional services, like a per-core object
16 * cache, and an alignment helper to ensure that objects are padded
17 * to spread them equally on all RAM channels, ranks, and so on.
19 * Objects owned by a mempool should never be added in another
20 * mempool. When an object is freed using rte_mempool_put() or
21 * equivalent, the object data is not modified; the user can save some
22 * meta-data in the object data and retrieve them when allocating a
25 * Note: the mempool implementation is not preemptible. An lcore must not be
26 * interrupted by another task that uses the same mempool (because it uses a
27 * ring which is not preemptible). Also, usual mempool functions like
28 * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
29 * thread due to the internal per-lcore cache. Due to the lack of caching,
30 * rte_mempool_get() or rte_mempool_put() performance will suffer when called
31 * by unregistered non-EAL threads. Instead, unregistered non-EAL threads
32 * should call rte_mempool_generic_get() or rte_mempool_generic_put() with a
33 * user cache created with rte_mempool_cache_create().
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>
54 #include "rte_mempool_trace_fp.h"
60 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
61 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
62 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
64 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
66 * A structure that stores the mempool statistics (per-lcore).
68 struct rte_mempool_debug_stats {
69 uint64_t put_bulk; /**< Number of puts. */
70 uint64_t put_objs; /**< Number of objects successfully put. */
71 uint64_t get_success_bulk; /**< Successful allocation number. */
72 uint64_t get_success_objs; /**< Objects successfully allocated. */
73 uint64_t get_fail_bulk; /**< Failed allocation number. */
74 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
75 /** Successful allocation number of contiguous blocks. */
76 uint64_t get_success_blks;
77 /** Failed allocation number of contiguous blocks. */
78 uint64_t get_fail_blks;
79 } __rte_cache_aligned;
83 * A structure that stores a per-core object cache.
85 struct rte_mempool_cache {
86 uint32_t size; /**< Size of the cache */
87 uint32_t flushthresh; /**< Threshold before we flush excess elements */
88 uint32_t len; /**< Current cache count */
90 * Cache is allocated to this size to allow it to overflow in certain
91 * cases to avoid needless emptying of cache.
93 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
94 } __rte_cache_aligned;
97 * A structure that stores the size of mempool elements.
99 struct rte_mempool_objsz {
100 uint32_t elt_size; /**< Size of an element. */
101 uint32_t header_size; /**< Size of header (before elt). */
102 uint32_t trailer_size; /**< Size of trailer (after elt). */
104 /**< Total size of an object (header + elt + trailer). */
107 /**< Maximum length of a memory pool's name. */
108 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
109 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
110 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
113 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
115 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
117 /** Mempool over one chunk of physically continuous memory */
118 #define MEMPOOL_PG_NUM_DEFAULT 1
120 #ifndef RTE_MEMPOOL_ALIGN
122 * Alignment of elements inside mempool.
124 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
127 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
130 * Mempool object header structure
132 * Each object stored in mempools are prefixed by this header structure,
133 * it allows to retrieve the mempool pointer from the object and to
134 * iterate on all objects attached to a mempool. When debug is enabled,
135 * a cookie is also added in this structure preventing corruptions and
138 struct rte_mempool_objhdr {
139 STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
140 struct rte_mempool *mp; /**< The mempool owning the object. */
141 rte_iova_t iova; /**< IO address of the object. */
142 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
143 uint64_t cookie; /**< Debug cookie. */
148 * A list of object headers type
150 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
152 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
155 * Mempool object trailer structure
157 * In debug mode, each object stored in mempools are suffixed by this
158 * trailer structure containing a cookie preventing memory corruptions.
160 struct rte_mempool_objtlr {
161 uint64_t cookie; /**< Debug cookie. */
167 * A list of memory where objects are stored
169 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
172 * Callback used to free a memory chunk
174 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
178 * Mempool objects memory header structure
180 * The memory chunks where objects are stored. Each chunk is virtually
181 * and physically contiguous.
183 struct rte_mempool_memhdr {
184 STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
185 struct rte_mempool *mp; /**< The mempool owning the chunk */
186 void *addr; /**< Virtual address of the chunk */
187 rte_iova_t iova; /**< IO address of the chunk */
188 size_t len; /**< length of the chunk */
189 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
190 void *opaque; /**< Argument passed to the free callback */
195 * @b EXPERIMENTAL: this API may change without prior notice.
197 * Additional information about the mempool
199 * The structure is cache-line aligned to avoid ABI breakages in
200 * a number of cases when something small is added.
202 struct rte_mempool_info {
203 /** Number of objects in the contiguous block */
204 unsigned int contig_block_size;
205 } __rte_cache_aligned;
208 * The RTE mempool structure.
212 * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
213 * compatibility requirements, it could be changed to
214 * RTE_MEMPOOL_NAMESIZE next time the ABI changes
216 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
219 void *pool_data; /**< Ring or pool to store objects. */
220 uint64_t pool_id; /**< External mempool identifier. */
222 void *pool_config; /**< optional args for ops alloc. */
223 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
224 unsigned int flags; /**< Flags of the mempool. */
225 int socket_id; /**< Socket id passed at create. */
226 uint32_t size; /**< Max size of the mempool. */
228 /**< Size of per-lcore default local cache. */
230 uint32_t elt_size; /**< Size of an element. */
231 uint32_t header_size; /**< Size of header (before elt). */
232 uint32_t trailer_size; /**< Size of trailer (after elt). */
234 unsigned private_data_size; /**< Size of private data. */
236 * Index into rte_mempool_ops_table array of mempool ops
237 * structs, which contain callback function pointers.
238 * We're using an index here rather than pointers to the callbacks
239 * to facilitate any secondary processes that may want to use
244 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
246 uint32_t populated_size; /**< Number of populated objects. */
247 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
248 uint32_t nb_mem_chunks; /**< Number of memory chunks */
249 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
251 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
252 /** Per-lcore statistics. */
253 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
255 } __rte_cache_aligned;
257 #define MEMPOOL_F_NO_SPREAD 0x0001
258 /**< Spreading among memory channels not required. */
259 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
260 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
261 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
262 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
263 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
266 * @internal When debug is enabled, store some statistics.
269 * Pointer to the memory pool.
271 * Name of the statistics field to increment in the memory pool.
273 * Number to add to the object-oriented statistics.
275 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
276 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
277 unsigned __lcore_id = rte_lcore_id(); \
278 if (__lcore_id < RTE_MAX_LCORE) { \
279 mp->stats[__lcore_id].name##_objs += n; \
280 mp->stats[__lcore_id].name##_bulk += 1; \
283 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do { \
284 unsigned int __lcore_id = rte_lcore_id(); \
285 if (__lcore_id < RTE_MAX_LCORE) { \
286 mp->stats[__lcore_id].name##_blks += n; \
287 mp->stats[__lcore_id].name##_bulk += 1; \
291 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
292 #define __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, name, n) do {} while (0)
296 * Calculate the size of the mempool header.
299 * Pointer to the memory pool.
301 * Size of the per-lcore cache.
303 #define MEMPOOL_HEADER_SIZE(mp, cs) \
304 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
305 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
307 /* return the header of a mempool object (internal) */
308 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
310 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
311 sizeof(struct rte_mempool_objhdr));
315 * Return a pointer to the mempool owning this object.
318 * An object that is owned by a pool. If this is not the case,
319 * the behavior is undefined.
321 * A pointer to the mempool structure.
323 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
325 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
329 /* return the trailer of a mempool object (internal) */
330 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
332 struct rte_mempool *mp = rte_mempool_from_obj(obj);
333 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
337 * @internal Check and update cookies or panic.
340 * Pointer to the memory pool.
341 * @param obj_table_const
342 * Pointer to a table of void * pointers (objects).
344 * Index of object in object table.
346 * - 0: object is supposed to be allocated, mark it as free
347 * - 1: object is supposed to be free, mark it as allocated
348 * - 2: just check that cookie is valid (free or allocated)
350 void rte_mempool_check_cookies(const struct rte_mempool *mp,
351 void * const *obj_table_const, unsigned n, int free);
353 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
354 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
355 rte_mempool_check_cookies(mp, obj_table_const, n, free)
357 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
358 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
362 * @b EXPERIMENTAL: this API may change without prior notice.
364 * @internal Check contiguous object blocks and update cookies or panic.
367 * Pointer to the memory pool.
368 * @param first_obj_table_const
369 * Pointer to a table of void * pointers (first object of the contiguous
372 * Number of contiguous object blocks.
374 * - 0: object is supposed to be allocated, mark it as free
375 * - 1: object is supposed to be free, mark it as allocated
376 * - 2: just check that cookie is valid (free or allocated)
378 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
379 void * const *first_obj_table_const, unsigned int n, int free);
381 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
382 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
384 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
387 #define __mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
390 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
392 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
395 * Prototype for implementation specific data provisioning function.
397 * The function should provide the implementation specific memory for
398 * use by the other mempool ops functions in a given mempool ops struct.
399 * E.g. the default ops provides an instance of the rte_ring for this purpose.
400 * it will most likely point to a different type of data structure, and
401 * will be transparent to the application programmer.
402 * This function should set mp->pool_data.
404 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
407 * Free the opaque private data pointed to by mp->pool_data pointer.
409 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
412 * Enqueue an object into the external pool.
414 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
415 void * const *obj_table, unsigned int n);
418 * Dequeue an object from the external pool.
420 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
421 void **obj_table, unsigned int n);
425 * @b EXPERIMENTAL: this API may change without prior notice.
427 * Dequeue a number of contiguous object blocks from the external pool.
429 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
430 void **first_obj_table, unsigned int n);
433 * Return the number of available objects in the external pool.
435 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
438 * Calculate memory size required to store given number of objects.
440 * If mempool objects are not required to be IOVA-contiguous
441 * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
442 * virtually contiguous chunk size. Otherwise, if mempool objects must
443 * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
444 * min_chunk_size defines IOVA-contiguous chunk size.
447 * Pointer to the memory pool.
450 * @param[in] pg_shift
451 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
452 * @param[out] min_chunk_size
453 * Location for minimum size of the memory chunk which may be used to
454 * store memory pool objects.
456 * Location for required memory chunk alignment.
458 * Required memory size.
460 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
461 uint32_t obj_num, uint32_t pg_shift,
462 size_t *min_chunk_size, size_t *align);
466 * @b EXPERIMENTAL: this API may change without prior notice.
468 * @internal Helper to calculate memory size required to store given
471 * This function is internal to mempool library and mempool drivers.
473 * If page boundaries may be ignored, it is just a product of total
474 * object size including header and trailer and number of objects.
475 * Otherwise, it is a number of pages required to store given number of
476 * objects without crossing page boundary.
478 * Note that if object size is bigger than page size, then it assumes
479 * that pages are grouped in subsets of physically continuous pages big
480 * enough to store at least one object.
482 * Minimum size of memory chunk is the total element size.
483 * Required memory chunk alignment is the cache line size.
486 * A pointer to the mempool structure.
488 * Number of objects to be added in mempool.
489 * @param[in] pg_shift
490 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
491 * @param[in] chunk_reserve
492 * Amount of memory that must be reserved at the beginning of each page,
493 * or at the beginning of the memory area if pg_shift is 0.
494 * @param[out] min_chunk_size
495 * Location for minimum size of the memory chunk which may be used to
496 * store memory pool objects.
498 * Location for required memory chunk alignment.
500 * Required memory size.
503 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
504 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
505 size_t *min_chunk_size, size_t *align);
508 * Default way to calculate memory size required to store given number of
511 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
512 * 0, min_chunk_size, align).
514 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
515 uint32_t obj_num, uint32_t pg_shift,
516 size_t *min_chunk_size, size_t *align);
519 * Function to be called for each populated object.
522 * A pointer to the mempool structure.
524 * An opaque pointer passed to iterator.
526 * Object virtual address.
528 * Input/output virtual address of the object or RTE_BAD_IOVA.
530 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
531 void *opaque, void *vaddr, rte_iova_t iova);
534 * Populate memory pool objects using provided memory chunk.
536 * Populated objects should be enqueued to the pool, e.g. using
537 * rte_mempool_ops_enqueue_bulk().
539 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
540 * the chunk doesn't need to be physically contiguous (only virtually),
541 * and allocated objects may span two pages.
544 * A pointer to the mempool structure.
545 * @param[in] max_objs
546 * Maximum number of objects to be populated.
548 * The virtual address of memory that should be used to store objects.
552 * The length of memory in bytes.
554 * Callback function to be executed for each populated object.
555 * @param[in] obj_cb_arg
556 * An opaque pointer passed to the callback function.
558 * The number of objects added on success.
559 * On error, no objects are populated and a negative errno is returned.
561 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
562 unsigned int max_objs,
563 void *vaddr, rte_iova_t iova, size_t len,
564 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
567 * Align objects on addresses multiple of total_elt_sz.
569 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
573 * @b EXPERIMENTAL: this API may change without prior notice.
575 * @internal Helper to populate memory pool object using provided memory
576 * chunk: just slice objects one by one, taking care of not
577 * crossing page boundaries.
579 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
580 * of object headers will be aligned on a multiple of total_elt_sz.
581 * This feature is used by octeontx hardware.
583 * This function is internal to mempool library and mempool drivers.
586 * A pointer to the mempool structure.
588 * Logical OR of following flags:
589 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
590 * multiple of total_elt_sz.
591 * @param[in] max_objs
592 * Maximum number of objects to be added in mempool.
594 * The virtual address of memory that should be used to store objects.
596 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
598 * The length of memory in bytes.
600 * Callback function to be executed for each populated object.
601 * @param[in] obj_cb_arg
602 * An opaque pointer passed to the callback function.
604 * The number of objects added in mempool.
607 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
608 unsigned int flags, unsigned int max_objs,
609 void *vaddr, rte_iova_t iova, size_t len,
610 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
613 * Default way to populate memory pool object using provided memory chunk.
615 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
616 * len, obj_cb, obj_cb_arg).
618 int rte_mempool_op_populate_default(struct rte_mempool *mp,
619 unsigned int max_objs,
620 void *vaddr, rte_iova_t iova, size_t len,
621 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
625 * @b EXPERIMENTAL: this API may change without prior notice.
627 * Get some additional information about a mempool.
629 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
630 struct rte_mempool_info *info);
633 /** Structure defining mempool operations structure */
634 struct rte_mempool_ops {
635 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
636 rte_mempool_alloc_t alloc; /**< Allocate private data. */
637 rte_mempool_free_t free; /**< Free the external pool. */
638 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
639 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
640 rte_mempool_get_count get_count; /**< Get qty of available objs. */
642 * Optional callback to calculate memory size required to
643 * store specified number of objects.
645 rte_mempool_calc_mem_size_t calc_mem_size;
647 * Optional callback to populate mempool objects using
648 * provided memory chunk.
650 rte_mempool_populate_t populate;
654 rte_mempool_get_info_t get_info;
656 * Dequeue a number of contiguous object blocks.
658 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
659 } __rte_cache_aligned;
661 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
664 * Structure storing the table of registered ops structs, each of which contain
665 * the function pointers for the mempool ops functions.
666 * Each process has its own storage for this ops struct array so that
667 * the mempools can be shared across primary and secondary processes.
668 * The indices used to access the array are valid across processes, whereas
669 * any function pointers stored directly in the mempool struct would not be.
670 * This results in us simply having "ops_index" in the mempool struct.
672 struct rte_mempool_ops_table {
673 rte_spinlock_t sl; /**< Spinlock for add/delete. */
674 uint32_t num_ops; /**< Number of used ops structs in the table. */
676 * Storage for all possible ops structs.
678 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
679 } __rte_cache_aligned;
681 /** Array of registered ops structs. */
682 extern struct rte_mempool_ops_table rte_mempool_ops_table;
685 * @internal Get the mempool ops struct from its index.
688 * The index of the ops struct in the ops struct table. It must be a valid
689 * index: (0 <= idx < num_ops).
691 * The pointer to the ops struct in the table.
693 static inline struct rte_mempool_ops *
694 rte_mempool_get_ops(int ops_index)
696 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
698 return &rte_mempool_ops_table.ops[ops_index];
702 * @internal Wrapper for mempool_ops alloc callback.
705 * Pointer to the memory pool.
707 * - 0: Success; successfully allocated mempool pool_data.
708 * - <0: Error; code of alloc function.
711 rte_mempool_ops_alloc(struct rte_mempool *mp);
714 * @internal Wrapper for mempool_ops dequeue callback.
717 * Pointer to the memory pool.
719 * Pointer to a table of void * pointers (objects).
721 * Number of objects to get.
723 * - 0: Success; got n objects.
724 * - <0: Error; code of dequeue function.
727 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
728 void **obj_table, unsigned n)
730 struct rte_mempool_ops *ops;
732 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
733 ops = rte_mempool_get_ops(mp->ops_index);
734 return ops->dequeue(mp, obj_table, n);
738 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
741 * Pointer to the memory pool.
742 * @param[out] first_obj_table
743 * Pointer to a table of void * pointers (first objects).
745 * Number of blocks to get.
747 * - 0: Success; got n objects.
748 * - <0: Error; code of dequeue function.
751 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
752 void **first_obj_table, unsigned int n)
754 struct rte_mempool_ops *ops;
756 ops = rte_mempool_get_ops(mp->ops_index);
757 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
758 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
759 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
763 * @internal wrapper for mempool_ops enqueue callback.
766 * Pointer to the memory pool.
768 * Pointer to a table of void * pointers (objects).
770 * Number of objects to put.
772 * - 0: Success; n objects supplied.
773 * - <0: Error; code of enqueue function.
776 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
779 struct rte_mempool_ops *ops;
781 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
782 ops = rte_mempool_get_ops(mp->ops_index);
783 return ops->enqueue(mp, obj_table, n);
787 * @internal wrapper for mempool_ops get_count callback.
790 * Pointer to the memory pool.
792 * The number of available objects in the external pool.
795 rte_mempool_ops_get_count(const struct rte_mempool *mp);
798 * @internal wrapper for mempool_ops calc_mem_size callback.
799 * API to calculate size of memory required to store specified number of
803 * Pointer to the memory pool.
806 * @param[in] pg_shift
807 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
808 * @param[out] min_chunk_size
809 * Location for minimum size of the memory chunk which may be used to
810 * store memory pool objects.
812 * Location for required memory chunk alignment.
814 * Required memory size aligned at page boundary.
816 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
817 uint32_t obj_num, uint32_t pg_shift,
818 size_t *min_chunk_size, size_t *align);
821 * @internal wrapper for mempool_ops populate callback.
823 * Populate memory pool objects using provided memory chunk.
826 * A pointer to the mempool structure.
827 * @param[in] max_objs
828 * Maximum number of objects to be populated.
830 * The virtual address of memory that should be used to store objects.
834 * The length of memory in bytes.
836 * Callback function to be executed for each populated object.
837 * @param[in] obj_cb_arg
838 * An opaque pointer passed to the callback function.
840 * The number of objects added on success.
841 * On error, no objects are populated and a negative errno is returned.
843 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
844 void *vaddr, rte_iova_t iova, size_t len,
845 rte_mempool_populate_obj_cb_t *obj_cb,
850 * @b EXPERIMENTAL: this API may change without prior notice.
852 * Wrapper for mempool_ops get_info callback.
855 * Pointer to the memory pool.
857 * Pointer to the rte_mempool_info structure
859 * - 0: Success; The mempool driver supports retrieving supplementary
860 * mempool information
861 * - -ENOTSUP - doesn't support get_info ops (valid case).
864 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
865 struct rte_mempool_info *info);
868 * @internal wrapper for mempool_ops free callback.
871 * Pointer to the memory pool.
874 rte_mempool_ops_free(struct rte_mempool *mp);
877 * Set the ops of a mempool.
879 * This can only be done on a mempool that is not populated, i.e. just after
880 * a call to rte_mempool_create_empty().
883 * Pointer to the memory pool.
885 * Name of the ops structure to use for this mempool.
887 * Opaque data that can be passed by the application to the ops functions.
889 * - 0: Success; the mempool is now using the requested ops functions.
890 * - -EINVAL - Invalid ops struct name provided.
891 * - -EEXIST - mempool already has an ops struct assigned.
894 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
898 * Register mempool operations.
901 * Pointer to an ops structure to register.
903 * - >=0: Success; return the index of the ops struct in the table.
904 * - -EINVAL - some missing callbacks while registering ops struct.
905 * - -ENOSPC - the maximum number of ops structs has been reached.
907 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
910 * Macro to statically register the ops of a mempool handler.
911 * Note that the rte_mempool_register_ops fails silently here when
912 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
914 #define MEMPOOL_REGISTER_OPS(ops) \
915 RTE_INIT(mp_hdlr_init_##ops) \
917 rte_mempool_register_ops(&ops); \
921 * An object callback function for mempool.
923 * Used by rte_mempool_create() and rte_mempool_obj_iter().
925 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
926 void *opaque, void *obj, unsigned obj_idx);
927 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
930 * A memory callback function for mempool.
932 * Used by rte_mempool_mem_iter().
934 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
935 void *opaque, struct rte_mempool_memhdr *memhdr,
939 * A mempool constructor callback function.
941 * Arguments are the mempool and the opaque pointer given by the user in
942 * rte_mempool_create().
944 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
947 * Create a new mempool named *name* in memory.
949 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
950 * pool contains n elements of elt_size. Its size is set to n.
953 * The name of the mempool.
955 * The number of elements in the mempool. The optimum size (in terms of
956 * memory usage) for a mempool is when n is a power of two minus one:
959 * The size of each element.
961 * If cache_size is non-zero, the rte_mempool library will try to
962 * limit the accesses to the common lockless pool, by maintaining a
963 * per-lcore object cache. This argument must be lower or equal to
964 * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
965 * cache_size to have "n modulo cache_size == 0": if this is
966 * not the case, some elements will always stay in the pool and will
967 * never be used. The access to the per-lcore table is of course
968 * faster than the multi-producer/consumer pool. The cache can be
969 * disabled if the cache_size argument is set to 0; it can be useful to
970 * avoid losing objects in cache.
971 * @param private_data_size
972 * The size of the private data appended after the mempool
973 * structure. This is useful for storing some private data after the
974 * mempool structure, as is done for rte_mbuf_pool for example.
976 * A function pointer that is called for initialization of the pool,
977 * before object initialization. The user can initialize the private
978 * data in this function if needed. This parameter can be NULL if
981 * An opaque pointer to data that can be used in the mempool
982 * constructor function.
984 * A function pointer that is called for each object at
985 * initialization of the pool. The user can set some meta data in
986 * objects if needed. This parameter can be NULL if not needed.
987 * The obj_init() function takes the mempool pointer, the init_arg,
988 * the object pointer and the object number as parameters.
989 * @param obj_init_arg
990 * An opaque pointer to data that can be used as an argument for
991 * each call to the object constructor function.
993 * The *socket_id* argument is the socket identifier in the case of
994 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
995 * constraint for the reserved zone.
997 * The *flags* arguments is an OR of following flags:
998 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
999 * between channels in RAM: the pool allocator will add padding
1000 * between objects depending on the hardware configuration. See
1001 * Memory alignment constraints for details. If this flag is set,
1002 * the allocator will just align them to a cache line.
1003 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
1004 * cache-aligned. This flag removes this constraint, and no
1005 * padding will be present between objects. This flag implies
1006 * MEMPOOL_F_NO_SPREAD.
1007 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
1008 * when using rte_mempool_put() or rte_mempool_put_bulk() is
1009 * "single-producer". Otherwise, it is "multi-producers".
1010 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
1011 * when using rte_mempool_get() or rte_mempool_get_bulk() is
1012 * "single-consumer". Otherwise, it is "multi-consumers".
1013 * - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
1014 * necessarily be contiguous in IO memory.
1016 * The pointer to the new allocated mempool, on success. NULL on error
1017 * with rte_errno set appropriately. Possible rte_errno values include:
1018 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1019 * - E_RTE_SECONDARY - function was called from a secondary process instance
1020 * - EINVAL - cache size provided is too large
1021 * - ENOSPC - the maximum number of memzones has already been allocated
1022 * - EEXIST - a memzone with the same name already exists
1023 * - ENOMEM - no appropriate memory area found in which to create memzone
1025 struct rte_mempool *
1026 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1027 unsigned cache_size, unsigned private_data_size,
1028 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1029 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1030 int socket_id, unsigned flags);
1033 * Create an empty mempool
1035 * The mempool is allocated and initialized, but it is not populated: no
1036 * memory is allocated for the mempool elements. The user has to call
1037 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1038 * populated, the user may also want to initialize each object with
1039 * rte_mempool_obj_iter().
1042 * The name of the mempool.
1044 * The maximum number of elements that can be added in the mempool.
1045 * The optimum size (in terms of memory usage) for a mempool is when n
1046 * is a power of two minus one: n = (2^q - 1).
1048 * The size of each element.
1050 * Size of the cache. See rte_mempool_create() for details.
1051 * @param private_data_size
1052 * The size of the private data appended after the mempool
1053 * structure. This is useful for storing some private data after the
1054 * mempool structure, as is done for rte_mbuf_pool for example.
1056 * The *socket_id* argument is the socket identifier in the case of
1057 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1058 * constraint for the reserved zone.
1060 * Flags controlling the behavior of the mempool. See
1061 * rte_mempool_create() for details.
1063 * The pointer to the new allocated mempool, on success. NULL on error
1064 * with rte_errno set appropriately. See rte_mempool_create() for details.
1066 struct rte_mempool *
1067 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1068 unsigned cache_size, unsigned private_data_size,
1069 int socket_id, unsigned flags);
1073 * Unlink the mempool from global list, free the memory chunks, and all
1074 * memory referenced by the mempool. The objects must not be used by
1075 * other cores as they will be freed.
1078 * A pointer to the mempool structure.
1081 rte_mempool_free(struct rte_mempool *mp);
1084 * Add physically contiguous memory for objects in the pool at init
1086 * Add a virtually and physically contiguous memory chunk in the pool
1087 * where objects can be instantiated.
1089 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1090 * the chunk doesn't need to be physically contiguous (only virtually),
1091 * and allocated objects may span two pages.
1094 * A pointer to the mempool structure.
1096 * The virtual address of memory that should be used to store objects.
1100 * The length of memory in bytes.
1102 * The callback used to free this chunk when destroying the mempool.
1104 * An opaque argument passed to free_cb.
1106 * The number of objects added on success (strictly positive).
1107 * On error, the chunk is not added in the memory list of the
1108 * mempool the following code is returned:
1109 * (0): not enough room in chunk for one object.
1110 * (-ENOSPC): mempool is already populated.
1111 * (-ENOMEM): allocation failure.
1113 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1114 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1118 * Add virtually contiguous memory for objects in the pool at init
1120 * Add a virtually contiguous memory chunk in the pool where objects can
1124 * A pointer to the mempool structure.
1126 * The virtual address of memory that should be used to store objects.
1128 * The length of memory in bytes.
1130 * The size of memory pages in this virtual area.
1132 * The callback used to free this chunk when destroying the mempool.
1134 * An opaque argument passed to free_cb.
1136 * The number of objects added on success (strictly positive).
1137 * On error, the chunk is not added in the memory list of the
1138 * mempool the following code is returned:
1139 * (0): not enough room in chunk for one object.
1140 * (-ENOSPC): mempool is already populated.
1141 * (-ENOMEM): allocation failure.
1144 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1145 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1149 * Add memory for objects in the pool at init
1151 * This is the default function used by rte_mempool_create() to populate
1152 * the mempool. It adds memory allocated using rte_memzone_reserve().
1155 * A pointer to the mempool structure.
1157 * The number of objects added on success.
1158 * On error, the chunk is not added in the memory list of the
1159 * mempool and a negative errno is returned.
1161 int rte_mempool_populate_default(struct rte_mempool *mp);
1164 * Add memory from anonymous mapping for objects in the pool at init
1166 * This function mmap an anonymous memory zone that is locked in
1167 * memory to store the objects of the mempool.
1170 * A pointer to the mempool structure.
1172 * The number of objects added on success.
1173 * On error, 0 is returned, rte_errno is set, and the chunk is not added in
1174 * the memory list of the mempool.
1176 int rte_mempool_populate_anon(struct rte_mempool *mp);
1179 * Call a function for each mempool element
1181 * Iterate across all objects attached to a rte_mempool and call the
1182 * callback function on it.
1185 * A pointer to an initialized mempool.
1187 * A function pointer that is called for each object.
1189 * An opaque pointer passed to the callback function.
1191 * Number of objects iterated.
1193 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1194 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1197 * Call a function for each mempool memory chunk
1199 * Iterate across all memory chunks attached to a rte_mempool and call
1200 * the callback function on it.
1203 * A pointer to an initialized mempool.
1205 * A function pointer that is called for each memory chunk.
1207 * An opaque pointer passed to the callback function.
1209 * Number of memory chunks iterated.
1211 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1212 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1215 * Dump the status of the mempool to a file.
1218 * A pointer to a file for output
1220 * A pointer to the mempool structure.
1222 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1225 * Create a user-owned mempool cache.
1227 * This can be used by unregistered non-EAL threads to enable caching when they
1228 * interact with a mempool.
1231 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1232 * parameter description for more information. The same limits and
1233 * considerations apply here too.
1235 * The socket identifier in the case of NUMA. The value can be
1236 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1238 struct rte_mempool_cache *
1239 rte_mempool_cache_create(uint32_t size, int socket_id);
1242 * Free a user-owned mempool cache.
1245 * A pointer to the mempool cache.
1248 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1251 * Get a pointer to the per-lcore default mempool cache.
1254 * A pointer to the mempool structure.
1256 * The logical core id.
1258 * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
1261 static __rte_always_inline struct rte_mempool_cache *
1262 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1264 if (mp->cache_size == 0)
1267 if (lcore_id >= RTE_MAX_LCORE)
1270 rte_mempool_trace_default_cache(mp, lcore_id,
1271 &mp->local_cache[lcore_id]);
1272 return &mp->local_cache[lcore_id];
1276 * Flush a user-owned mempool cache to the specified mempool.
1279 * A pointer to the mempool cache.
1281 * A pointer to the mempool.
1283 static __rte_always_inline void
1284 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1285 struct rte_mempool *mp)
1288 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1289 if (cache == NULL || cache->len == 0)
1291 rte_mempool_trace_cache_flush(cache, mp);
1292 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1297 * @internal Put several objects back in the mempool; used internally.
1299 * A pointer to the mempool structure.
1301 * A pointer to a table of void * pointers (objects).
1303 * The number of objects to store back in the mempool, must be strictly
1306 * A pointer to a mempool cache structure. May be NULL if not needed.
1308 static __rte_always_inline void
1309 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1310 unsigned int n, struct rte_mempool_cache *cache)
1314 /* increment stat now, adding in mempool always success */
1315 __MEMPOOL_STAT_ADD(mp, put, n);
1317 /* No cache provided or if put would overflow mem allocated for cache */
1318 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1321 cache_objs = &cache->objs[cache->len];
1324 * The cache follows the following algorithm
1325 * 1. Add the objects to the cache
1326 * 2. Anything greater than the cache min value (if it crosses the
1327 * cache flush threshold) is flushed to the ring.
1330 /* Add elements back into the cache */
1331 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1335 if (cache->len >= cache->flushthresh) {
1336 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1337 cache->len - cache->size);
1338 cache->len = cache->size;
1345 /* push remaining objects in ring */
1346 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1347 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1348 rte_panic("cannot put objects in mempool\n");
1350 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1356 * Put several objects back in the mempool.
1359 * A pointer to the mempool structure.
1361 * A pointer to a table of void * pointers (objects).
1363 * The number of objects to add in the mempool from the obj_table.
1365 * A pointer to a mempool cache structure. May be NULL if not needed.
1367 static __rte_always_inline void
1368 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1369 unsigned int n, struct rte_mempool_cache *cache)
1371 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1372 __mempool_check_cookies(mp, obj_table, n, 0);
1373 __mempool_generic_put(mp, obj_table, n, cache);
1377 * Put several objects back in the mempool.
1379 * This function calls the multi-producer or the single-producer
1380 * version depending on the default behavior that was specified at
1381 * mempool creation time (see flags).
1384 * A pointer to the mempool structure.
1386 * A pointer to a table of void * pointers (objects).
1388 * The number of objects to add in the mempool from obj_table.
1390 static __rte_always_inline void
1391 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1394 struct rte_mempool_cache *cache;
1395 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1396 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1397 rte_mempool_generic_put(mp, obj_table, n, cache);
1401 * Put one object back in the mempool.
1403 * This function calls the multi-producer or the single-producer
1404 * version depending on the default behavior that was specified at
1405 * mempool creation time (see flags).
1408 * A pointer to the mempool structure.
1410 * A pointer to the object to be added.
1412 static __rte_always_inline void
1413 rte_mempool_put(struct rte_mempool *mp, void *obj)
1415 rte_mempool_put_bulk(mp, &obj, 1);
1419 * @internal Get several objects from the mempool; used internally.
1421 * A pointer to the mempool structure.
1423 * A pointer to a table of void * pointers (objects).
1425 * The number of objects to get, must be strictly positive.
1427 * A pointer to a mempool cache structure. May be NULL if not needed.
1429 * - >=0: Success; number of objects supplied.
1430 * - <0: Error; code of ring dequeue function.
1432 static __rte_always_inline int
1433 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1434 unsigned int n, struct rte_mempool_cache *cache)
1437 uint32_t index, len;
1440 /* No cache provided or cannot be satisfied from cache */
1441 if (unlikely(cache == NULL || n >= cache->size))
1444 cache_objs = cache->objs;
1446 /* Can this be satisfied from the cache? */
1447 if (cache->len < n) {
1448 /* No. Backfill the cache first, and then fill from it */
1449 uint32_t req = n + (cache->size - cache->len);
1451 /* How many do we require i.e. number to fill the cache + the request */
1452 ret = rte_mempool_ops_dequeue_bulk(mp,
1453 &cache->objs[cache->len], req);
1454 if (unlikely(ret < 0)) {
1456 * In the off chance that we are buffer constrained,
1457 * where we are not able to allocate cache + n, go to
1458 * the ring directly. If that fails, we are truly out of
1467 /* Now fill in the response ... */
1468 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1469 *obj_table = cache_objs[len];
1473 __MEMPOOL_STAT_ADD(mp, get_success, n);
1479 /* get remaining objects from ring */
1480 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1483 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1485 __MEMPOOL_STAT_ADD(mp, get_success, n);
1491 * Get several objects from the mempool.
1493 * If cache is enabled, objects will be retrieved first from cache,
1494 * subsequently from the common pool. Note that it can return -ENOENT when
1495 * the local cache and common pool are empty, even if cache from other
1499 * A pointer to the mempool structure.
1501 * A pointer to a table of void * pointers (objects) that will be filled.
1503 * The number of objects to get from mempool to obj_table.
1505 * A pointer to a mempool cache structure. May be NULL if not needed.
1507 * - 0: Success; objects taken.
1508 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1510 static __rte_always_inline int
1511 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1512 unsigned int n, struct rte_mempool_cache *cache)
1515 ret = __mempool_generic_get(mp, obj_table, n, cache);
1517 __mempool_check_cookies(mp, obj_table, n, 1);
1518 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1523 * Get several objects from the mempool.
1525 * This function calls the multi-consumers or the single-consumer
1526 * version, depending on the default behaviour that was specified at
1527 * mempool creation time (see flags).
1529 * If cache is enabled, objects will be retrieved first from cache,
1530 * subsequently from the common pool. Note that it can return -ENOENT when
1531 * the local cache and common pool are empty, even if cache from other
1535 * A pointer to the mempool structure.
1537 * A pointer to a table of void * pointers (objects) that will be filled.
1539 * The number of objects to get from the mempool to obj_table.
1541 * - 0: Success; objects taken
1542 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1544 static __rte_always_inline int
1545 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1547 struct rte_mempool_cache *cache;
1548 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1549 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1550 return rte_mempool_generic_get(mp, obj_table, n, cache);
1554 * Get one object from the mempool.
1556 * This function calls the multi-consumers or the single-consumer
1557 * version, depending on the default behavior that was specified at
1558 * mempool creation (see flags).
1560 * If cache is enabled, objects will be retrieved first from cache,
1561 * subsequently from the common pool. Note that it can return -ENOENT when
1562 * the local cache and common pool are empty, even if cache from other
1566 * A pointer to the mempool structure.
1568 * A pointer to a void * pointer (object) that will be filled.
1570 * - 0: Success; objects taken.
1571 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1573 static __rte_always_inline int
1574 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1576 return rte_mempool_get_bulk(mp, obj_p, 1);
1581 * @b EXPERIMENTAL: this API may change without prior notice.
1583 * Get a contiguous blocks of objects from the mempool.
1585 * If cache is enabled, consider to flush it first, to reuse objects
1586 * as soon as possible.
1588 * The application should check that the driver supports the operation
1589 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1593 * A pointer to the mempool structure.
1594 * @param first_obj_table
1595 * A pointer to a pointer to the first object in each block.
1597 * The number of blocks to get from mempool.
1599 * - 0: Success; blocks taken.
1600 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1601 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1603 static __rte_always_inline int
1605 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1606 void **first_obj_table, unsigned int n)
1610 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1612 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_success, n);
1613 __mempool_contig_blocks_check_cookies(mp, first_obj_table, n,
1616 __MEMPOOL_CONTIG_BLOCKS_STAT_ADD(mp, get_fail, n);
1619 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1624 * Return the number of entries in the mempool.
1626 * When cache is enabled, this function has to browse the length of
1627 * all lcores, so it should not be used in a data path, but only for
1628 * debug purposes. User-owned mempool caches are not accounted for.
1631 * A pointer to the mempool structure.
1633 * The number of entries in the mempool.
1635 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1638 * Return the number of elements which have been allocated from the mempool
1640 * When cache is enabled, this function has to browse the length of
1641 * all lcores, so it should not be used in a data path, but only for
1645 * A pointer to the mempool structure.
1647 * The number of free entries in the mempool.
1650 rte_mempool_in_use_count(const struct rte_mempool *mp);
1653 * Test if the mempool is full.
1655 * When cache is enabled, this function has to browse the length of all
1656 * lcores, so it should not be used in a data path, but only for debug
1657 * purposes. User-owned mempool caches are not accounted for.
1660 * A pointer to the mempool structure.
1662 * - 1: The mempool is full.
1663 * - 0: The mempool is not full.
1666 rte_mempool_full(const struct rte_mempool *mp)
1668 return rte_mempool_avail_count(mp) == mp->size;
1672 * Test if the mempool is empty.
1674 * When cache is enabled, this function has to browse the length of all
1675 * lcores, so it should not be used in a data path, but only for debug
1676 * purposes. User-owned mempool caches are not accounted for.
1679 * A pointer to the mempool structure.
1681 * - 1: The mempool is empty.
1682 * - 0: The mempool is not empty.
1685 rte_mempool_empty(const struct rte_mempool *mp)
1687 return rte_mempool_avail_count(mp) == 0;
1691 * Return the IO address of elt, which is an element of the pool mp.
1694 * A pointer (virtual address) to the element of the pool.
1696 * The IO address of the elt element.
1697 * If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1698 * returned value is RTE_BAD_IOVA.
1700 static inline rte_iova_t
1701 rte_mempool_virt2iova(const void *elt)
1703 const struct rte_mempool_objhdr *hdr;
1704 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1710 * Check the consistency of mempool objects.
1712 * Verify the coherency of fields in the mempool structure. Also check
1713 * that the cookies of mempool objects (even the ones that are not
1714 * present in pool) have a correct value. If not, a panic will occur.
1717 * A pointer to the mempool structure.
1719 void rte_mempool_audit(struct rte_mempool *mp);
1722 * Return a pointer to the private data in an mempool structure.
1725 * A pointer to the mempool structure.
1727 * A pointer to the private data.
1729 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1732 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1736 * Dump the status of all mempools on the console
1739 * A pointer to a file for output
1741 void rte_mempool_list_dump(FILE *f);
1744 * Search a mempool from its name
1747 * The name of the mempool.
1749 * The pointer to the mempool matching the name, or NULL if not found.
1751 * with rte_errno set appropriately. Possible rte_errno values include:
1752 * - ENOENT - required entry not available to return.
1755 struct rte_mempool *rte_mempool_lookup(const char *name);
1758 * Get the header, trailer and total size of a mempool element.
1760 * Given a desired size of the mempool element and mempool flags,
1761 * calculates header, trailer, body and total sizes of the mempool object.
1764 * The size of each element, without header and trailer.
1766 * The flags used for the mempool creation.
1767 * Consult rte_mempool_create() for more information about possible values.
1768 * The size of each element.
1770 * The calculated detailed size the mempool object. May be NULL.
1772 * Total size of the mempool object.
1774 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1775 struct rte_mempool_objsz *sz);
1778 * Walk list of all memory pools
1783 * Argument passed to iterator
1785 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1790 * @b EXPERIMENTAL: this API may change without prior notice.
1792 * @internal Get page size used for mempool object allocation.
1793 * This function is internal to mempool library and mempool drivers.
1797 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1803 #endif /* _RTE_MEMPOOL_H_ */