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().
42 #include <rte_config.h>
43 #include <rte_spinlock.h>
45 #include <rte_debug.h>
46 #include <rte_lcore.h>
47 #include <rte_memory.h>
48 #include <rte_branch_prediction.h>
50 #include <rte_memcpy.h>
51 #include <rte_common.h>
53 #include "rte_mempool_trace_fp.h"
59 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
60 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
61 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
63 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
65 * A structure that stores the mempool statistics (per-lcore).
66 * Note: Cache stats (put_cache_bulk/objs, get_cache_bulk/objs) are not
67 * captured since they can be calculated from other stats.
68 * For example: put_cache_objs = put_objs - put_common_pool_objs.
70 struct rte_mempool_debug_stats {
71 uint64_t put_bulk; /**< Number of puts. */
72 uint64_t put_objs; /**< Number of objects successfully put. */
73 uint64_t put_common_pool_bulk; /**< Number of bulks enqueued in common pool. */
74 uint64_t put_common_pool_objs; /**< Number of objects enqueued in common pool. */
75 uint64_t get_common_pool_bulk; /**< Number of bulks dequeued from common pool. */
76 uint64_t get_common_pool_objs; /**< Number of objects dequeued from common pool. */
77 uint64_t get_success_bulk; /**< Successful allocation number. */
78 uint64_t get_success_objs; /**< Objects successfully allocated. */
79 uint64_t get_fail_bulk; /**< Failed allocation number. */
80 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
81 uint64_t get_success_blks; /**< Successful allocation number of contiguous blocks. */
82 uint64_t get_fail_blks; /**< Failed allocation number of contiguous blocks. */
83 } __rte_cache_aligned;
87 * A structure that stores a per-core object cache.
89 struct rte_mempool_cache {
90 uint32_t size; /**< Size of the cache */
91 uint32_t flushthresh; /**< Threshold before we flush excess elements */
92 uint32_t len; /**< Current cache count */
94 * Cache is allocated to this size to allow it to overflow in certain
95 * cases to avoid needless emptying of cache.
97 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
98 } __rte_cache_aligned;
101 * A structure that stores the size of mempool elements.
103 struct rte_mempool_objsz {
104 uint32_t elt_size; /**< Size of an element. */
105 uint32_t header_size; /**< Size of header (before elt). */
106 uint32_t trailer_size; /**< Size of trailer (after elt). */
108 /**< Total size of an object (header + elt + trailer). */
111 /**< Maximum length of a memory pool's name. */
112 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
113 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
114 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
117 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
119 #define MEMPOOL_PG_SHIFT_MAX \
120 RTE_DEPRECATED(MEMPOOL_PG_SHIFT_MAX) (sizeof(uintptr_t) * CHAR_BIT - 1)
122 /** Deprecated. Mempool over one chunk of physically continuous memory */
123 #define MEMPOOL_PG_NUM_DEFAULT RTE_DEPRECATED(MEMPOOL_PG_NUM_DEFAULT) 1
125 #ifndef RTE_MEMPOOL_ALIGN
127 * Alignment of elements inside mempool.
129 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
132 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
135 * Mempool object header structure
137 * Each object stored in mempools are prefixed by this header structure,
138 * it allows to retrieve the mempool pointer from the object and to
139 * iterate on all objects attached to a mempool. When debug is enabled,
140 * a cookie is also added in this structure preventing corruptions and
143 struct rte_mempool_objhdr {
144 RTE_STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
145 struct rte_mempool *mp; /**< The mempool owning the object. */
146 rte_iova_t iova; /**< IO address of the object. */
147 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
148 uint64_t cookie; /**< Debug cookie. */
153 * A list of object headers type
155 RTE_STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
157 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
160 * Mempool object trailer structure
162 * In debug mode, each object stored in mempools are suffixed by this
163 * trailer structure containing a cookie preventing memory corruptions.
165 struct rte_mempool_objtlr {
166 uint64_t cookie; /**< Debug cookie. */
172 * A list of memory where objects are stored
174 RTE_STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
177 * Callback used to free a memory chunk
179 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
183 * Mempool objects memory header structure
185 * The memory chunks where objects are stored. Each chunk is virtually
186 * and physically contiguous.
188 struct rte_mempool_memhdr {
189 RTE_STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
190 struct rte_mempool *mp; /**< The mempool owning the chunk */
191 void *addr; /**< Virtual address of the chunk */
192 rte_iova_t iova; /**< IO address of the chunk */
193 size_t len; /**< length of the chunk */
194 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
195 void *opaque; /**< Argument passed to the free callback */
199 * Additional information about the mempool
201 * The structure is cache-line aligned to avoid ABI breakages in
202 * a number of cases when something small is added.
204 struct rte_mempool_info {
205 /** Number of objects in the contiguous block */
206 unsigned int contig_block_size;
207 } __rte_cache_aligned;
210 * The RTE mempool structure.
213 char name[RTE_MEMPOOL_NAMESIZE]; /**< Name of mempool. */
216 void *pool_data; /**< Ring or pool to store objects. */
217 uint64_t pool_id; /**< External mempool identifier. */
219 void *pool_config; /**< optional args for ops alloc. */
220 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
221 unsigned int flags; /**< Flags of the mempool. */
222 int socket_id; /**< Socket id passed at create. */
223 uint32_t size; /**< Max size of the mempool. */
225 /**< Size of per-lcore default local cache. */
227 uint32_t elt_size; /**< Size of an element. */
228 uint32_t header_size; /**< Size of header (before elt). */
229 uint32_t trailer_size; /**< Size of trailer (after elt). */
231 unsigned private_data_size; /**< Size of private data. */
233 * Index into rte_mempool_ops_table array of mempool ops
234 * structs, which contain callback function pointers.
235 * We're using an index here rather than pointers to the callbacks
236 * to facilitate any secondary processes that may want to use
241 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
243 uint32_t populated_size; /**< Number of populated objects. */
244 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
245 uint32_t nb_mem_chunks; /**< Number of memory chunks */
246 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
248 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
249 /** Per-lcore statistics. */
250 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
252 } __rte_cache_aligned;
254 /** Spreading among memory channels not required. */
255 #define RTE_MEMPOOL_F_NO_SPREAD 0x0001
257 * Backward compatibility synonym for RTE_MEMPOOL_F_NO_SPREAD.
260 #define MEMPOOL_F_NO_SPREAD RTE_MEMPOOL_F_NO_SPREAD
261 /** Do not align objects on cache lines. */
262 #define RTE_MEMPOOL_F_NO_CACHE_ALIGN 0x0002
264 * Backward compatibility synonym for RTE_MEMPOOL_F_NO_CACHE_ALIGN.
267 #define MEMPOOL_F_NO_CACHE_ALIGN RTE_MEMPOOL_F_NO_CACHE_ALIGN
268 /** Default put is "single-producer". */
269 #define RTE_MEMPOOL_F_SP_PUT 0x0004
271 * Backward compatibility synonym for RTE_MEMPOOL_F_SP_PUT.
274 #define MEMPOOL_F_SP_PUT RTE_MEMPOOL_F_SP_PUT
275 /** Default get is "single-consumer". */
276 #define RTE_MEMPOOL_F_SC_GET 0x0008
278 * Backward compatibility synonym for RTE_MEMPOOL_F_SC_GET.
281 #define MEMPOOL_F_SC_GET RTE_MEMPOOL_F_SC_GET
282 /** Internal: pool is created. */
283 #define RTE_MEMPOOL_F_POOL_CREATED 0x0010
284 /** Don't need IOVA contiguous objects. */
285 #define RTE_MEMPOOL_F_NO_IOVA_CONTIG 0x0020
287 * Backward compatibility synonym for RTE_MEMPOOL_F_NO_IOVA_CONTIG.
290 #define MEMPOOL_F_NO_IOVA_CONTIG RTE_MEMPOOL_F_NO_IOVA_CONTIG
291 /** Internal: no object from the pool can be used for device IO (DMA). */
292 #define RTE_MEMPOOL_F_NON_IO 0x0040
295 * This macro lists all the mempool flags an application may request.
297 #define RTE_MEMPOOL_VALID_USER_FLAGS (RTE_MEMPOOL_F_NO_SPREAD \
298 | RTE_MEMPOOL_F_NO_CACHE_ALIGN \
299 | RTE_MEMPOOL_F_SP_PUT \
300 | RTE_MEMPOOL_F_SC_GET \
301 | RTE_MEMPOOL_F_NO_IOVA_CONTIG \
304 * @internal When debug is enabled, store some statistics.
307 * Pointer to the memory pool.
309 * Name of the statistics field to increment in the memory pool.
311 * Number to add to the object-oriented statistics.
313 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
314 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do { \
315 unsigned __lcore_id = rte_lcore_id(); \
316 if (__lcore_id < RTE_MAX_LCORE) { \
317 mp->stats[__lcore_id].name += n; \
321 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do {} while (0)
325 * @internal Calculate the size of the mempool header.
328 * Pointer to the memory pool.
330 * Size of the per-lcore cache.
332 #define RTE_MEMPOOL_HEADER_SIZE(mp, cs) \
333 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
334 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
336 /** Deprecated. Use RTE_MEMPOOL_HEADER_SIZE() for internal purposes only. */
337 #define MEMPOOL_HEADER_SIZE(mp, cs) \
338 RTE_DEPRECATED(MEMPOOL_HEADER_SIZE) RTE_MEMPOOL_HEADER_SIZE(mp, cs)
340 /* return the header of a mempool object (internal) */
341 static inline struct rte_mempool_objhdr *
342 rte_mempool_get_header(void *obj)
344 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
345 sizeof(struct rte_mempool_objhdr));
349 * Return a pointer to the mempool owning this object.
352 * An object that is owned by a pool. If this is not the case,
353 * the behavior is undefined.
355 * A pointer to the mempool structure.
357 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
359 struct rte_mempool_objhdr *hdr = rte_mempool_get_header(obj);
363 /* return the trailer of a mempool object (internal) */
364 static inline struct rte_mempool_objtlr *rte_mempool_get_trailer(void *obj)
366 struct rte_mempool *mp = rte_mempool_from_obj(obj);
367 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
371 * @internal Check and update cookies or panic.
374 * Pointer to the memory pool.
375 * @param obj_table_const
376 * Pointer to a table of void * pointers (objects).
378 * Index of object in object table.
380 * - 0: object is supposed to be allocated, mark it as free
381 * - 1: object is supposed to be free, mark it as allocated
382 * - 2: just check that cookie is valid (free or allocated)
384 void rte_mempool_check_cookies(const struct rte_mempool *mp,
385 void * const *obj_table_const, unsigned n, int free);
387 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
388 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) \
389 rte_mempool_check_cookies(mp, obj_table_const, n, free)
391 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) do {} while (0)
392 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
395 * @internal Check contiguous object blocks and update cookies or panic.
398 * Pointer to the memory pool.
399 * @param first_obj_table_const
400 * Pointer to a table of void * pointers (first object of the contiguous
403 * Number of contiguous object blocks.
405 * - 0: object is supposed to be allocated, mark it as free
406 * - 1: object is supposed to be free, mark it as allocated
407 * - 2: just check that cookie is valid (free or allocated)
409 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
410 void * const *first_obj_table_const, unsigned int n, int free);
412 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
413 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
415 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
418 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
421 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
423 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
426 * Prototype for implementation specific data provisioning function.
428 * The function should provide the implementation specific memory for
429 * use by the other mempool ops functions in a given mempool ops struct.
430 * E.g. the default ops provides an instance of the rte_ring for this purpose.
431 * it will most likely point to a different type of data structure, and
432 * will be transparent to the application programmer.
433 * This function should set mp->pool_data.
435 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
438 * Free the opaque private data pointed to by mp->pool_data pointer.
440 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
443 * Enqueue an object into the external pool.
445 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
446 void * const *obj_table, unsigned int n);
449 * Dequeue an object from the external pool.
451 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
452 void **obj_table, unsigned int n);
455 * Dequeue a number of contiguous object blocks from the external pool.
457 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
458 void **first_obj_table, unsigned int n);
461 * Return the number of available objects in the external pool.
463 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
466 * Calculate memory size required to store given number of objects.
468 * If mempool objects are not required to be IOVA-contiguous
469 * (the flag RTE_MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
470 * virtually contiguous chunk size. Otherwise, if mempool objects must
471 * be IOVA-contiguous (the flag RTE_MEMPOOL_F_NO_IOVA_CONTIG is clear),
472 * min_chunk_size defines IOVA-contiguous chunk size.
475 * Pointer to the memory pool.
478 * @param[in] pg_shift
479 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
480 * @param[out] min_chunk_size
481 * Location for minimum size of the memory chunk which may be used to
482 * store memory pool objects.
484 * Location for required memory chunk alignment.
486 * Required memory size.
488 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
489 uint32_t obj_num, uint32_t pg_shift,
490 size_t *min_chunk_size, size_t *align);
493 * @internal Helper to calculate memory size required to store given
496 * This function is internal to mempool library and mempool drivers.
498 * If page boundaries may be ignored, it is just a product of total
499 * object size including header and trailer and number of objects.
500 * Otherwise, it is a number of pages required to store given number of
501 * objects without crossing page boundary.
503 * Note that if object size is bigger than page size, then it assumes
504 * that pages are grouped in subsets of physically continuous pages big
505 * enough to store at least one object.
507 * Minimum size of memory chunk is the total element size.
508 * Required memory chunk alignment is the cache line size.
511 * A pointer to the mempool structure.
513 * Number of objects to be added in mempool.
514 * @param[in] pg_shift
515 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
516 * @param[in] chunk_reserve
517 * Amount of memory that must be reserved at the beginning of each page,
518 * or at the beginning of the memory area if pg_shift is 0.
519 * @param[out] min_chunk_size
520 * Location for minimum size of the memory chunk which may be used to
521 * store memory pool objects.
523 * Location for required memory chunk alignment.
525 * Required memory size.
527 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
528 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
529 size_t *min_chunk_size, size_t *align);
532 * Default way to calculate memory size required to store given number of
535 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
536 * 0, min_chunk_size, align).
538 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
539 uint32_t obj_num, uint32_t pg_shift,
540 size_t *min_chunk_size, size_t *align);
543 * Function to be called for each populated object.
546 * A pointer to the mempool structure.
548 * An opaque pointer passed to iterator.
550 * Object virtual address.
552 * Input/output virtual address of the object or RTE_BAD_IOVA.
554 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
555 void *opaque, void *vaddr, rte_iova_t iova);
558 * Populate memory pool objects using provided memory chunk.
560 * Populated objects should be enqueued to the pool, e.g. using
561 * rte_mempool_ops_enqueue_bulk().
563 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
564 * the chunk doesn't need to be physically contiguous (only virtually),
565 * and allocated objects may span two pages.
568 * A pointer to the mempool structure.
569 * @param[in] max_objs
570 * Maximum number of objects to be populated.
572 * The virtual address of memory that should be used to store objects.
576 * The length of memory in bytes.
578 * Callback function to be executed for each populated object.
579 * @param[in] obj_cb_arg
580 * An opaque pointer passed to the callback function.
582 * The number of objects added on success.
583 * On error, no objects are populated and a negative errno is returned.
585 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
586 unsigned int max_objs,
587 void *vaddr, rte_iova_t iova, size_t len,
588 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
591 * Align objects on addresses multiple of total_elt_sz.
593 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
596 * @internal Helper to populate memory pool object using provided memory
597 * chunk: just slice objects one by one, taking care of not
598 * crossing page boundaries.
600 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
601 * of object headers will be aligned on a multiple of total_elt_sz.
602 * This feature is used by octeontx hardware.
604 * This function is internal to mempool library and mempool drivers.
607 * A pointer to the mempool structure.
609 * Logical OR of following flags:
610 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
611 * multiple of total_elt_sz.
612 * @param[in] max_objs
613 * Maximum number of objects to be added in mempool.
615 * The virtual address of memory that should be used to store objects.
617 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
619 * The length of memory in bytes.
621 * Callback function to be executed for each populated object.
622 * @param[in] obj_cb_arg
623 * An opaque pointer passed to the callback function.
625 * The number of objects added in mempool.
627 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
628 unsigned int flags, unsigned int max_objs,
629 void *vaddr, rte_iova_t iova, size_t len,
630 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
633 * Default way to populate memory pool object using provided memory chunk.
635 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
636 * len, obj_cb, obj_cb_arg).
638 int rte_mempool_op_populate_default(struct rte_mempool *mp,
639 unsigned int max_objs,
640 void *vaddr, rte_iova_t iova, size_t len,
641 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
644 * Get some additional information about a mempool.
646 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
647 struct rte_mempool_info *info);
650 /** Structure defining mempool operations structure */
651 struct rte_mempool_ops {
652 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
653 rte_mempool_alloc_t alloc; /**< Allocate private data. */
654 rte_mempool_free_t free; /**< Free the external pool. */
655 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
656 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
657 rte_mempool_get_count get_count; /**< Get qty of available objs. */
659 * Optional callback to calculate memory size required to
660 * store specified number of objects.
662 rte_mempool_calc_mem_size_t calc_mem_size;
664 * Optional callback to populate mempool objects using
665 * provided memory chunk.
667 rte_mempool_populate_t populate;
671 rte_mempool_get_info_t get_info;
673 * Dequeue a number of contiguous object blocks.
675 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
676 } __rte_cache_aligned;
678 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
681 * Structure storing the table of registered ops structs, each of which contain
682 * the function pointers for the mempool ops functions.
683 * Each process has its own storage for this ops struct array so that
684 * the mempools can be shared across primary and secondary processes.
685 * The indices used to access the array are valid across processes, whereas
686 * any function pointers stored directly in the mempool struct would not be.
687 * This results in us simply having "ops_index" in the mempool struct.
689 struct rte_mempool_ops_table {
690 rte_spinlock_t sl; /**< Spinlock for add/delete. */
691 uint32_t num_ops; /**< Number of used ops structs in the table. */
693 * Storage for all possible ops structs.
695 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
696 } __rte_cache_aligned;
698 /** Array of registered ops structs. */
699 extern struct rte_mempool_ops_table rte_mempool_ops_table;
702 * @internal Get the mempool ops struct from its index.
705 * The index of the ops struct in the ops struct table. It must be a valid
706 * index: (0 <= idx < num_ops).
708 * The pointer to the ops struct in the table.
710 static inline struct rte_mempool_ops *
711 rte_mempool_get_ops(int ops_index)
713 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
715 return &rte_mempool_ops_table.ops[ops_index];
719 * @internal Wrapper for mempool_ops alloc callback.
722 * Pointer to the memory pool.
724 * - 0: Success; successfully allocated mempool pool_data.
725 * - <0: Error; code of alloc function.
728 rte_mempool_ops_alloc(struct rte_mempool *mp);
731 * @internal Wrapper for mempool_ops dequeue callback.
734 * Pointer to the memory pool.
736 * Pointer to a table of void * pointers (objects).
738 * Number of objects to get.
740 * - 0: Success; got n objects.
741 * - <0: Error; code of dequeue function.
744 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
745 void **obj_table, unsigned n)
747 struct rte_mempool_ops *ops;
750 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
751 ops = rte_mempool_get_ops(mp->ops_index);
752 ret = ops->dequeue(mp, obj_table, n);
754 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
755 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
761 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
764 * Pointer to the memory pool.
765 * @param[out] first_obj_table
766 * Pointer to a table of void * pointers (first objects).
768 * Number of blocks to get.
770 * - 0: Success; got n objects.
771 * - <0: Error; code of dequeue function.
774 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
775 void **first_obj_table, unsigned int n)
777 struct rte_mempool_ops *ops;
779 ops = rte_mempool_get_ops(mp->ops_index);
780 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
781 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
782 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
786 * @internal wrapper for mempool_ops enqueue callback.
789 * Pointer to the memory pool.
791 * Pointer to a table of void * pointers (objects).
793 * Number of objects to put.
795 * - 0: Success; n objects supplied.
796 * - <0: Error; code of enqueue function.
799 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
802 struct rte_mempool_ops *ops;
804 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
805 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
806 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
807 ops = rte_mempool_get_ops(mp->ops_index);
808 return ops->enqueue(mp, obj_table, n);
812 * @internal wrapper for mempool_ops get_count callback.
815 * Pointer to the memory pool.
817 * The number of available objects in the external pool.
820 rte_mempool_ops_get_count(const struct rte_mempool *mp);
823 * @internal wrapper for mempool_ops calc_mem_size callback.
824 * API to calculate size of memory required to store specified number of
828 * Pointer to the memory pool.
831 * @param[in] pg_shift
832 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
833 * @param[out] min_chunk_size
834 * Location for minimum size of the memory chunk which may be used to
835 * store memory pool objects.
837 * Location for required memory chunk alignment.
839 * Required memory size aligned at page boundary.
841 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
842 uint32_t obj_num, uint32_t pg_shift,
843 size_t *min_chunk_size, size_t *align);
846 * @internal wrapper for mempool_ops populate callback.
848 * Populate memory pool objects using provided memory chunk.
851 * A pointer to the mempool structure.
852 * @param[in] max_objs
853 * Maximum number of objects to be populated.
855 * The virtual address of memory that should be used to store objects.
859 * The length of memory in bytes.
861 * Callback function to be executed for each populated object.
862 * @param[in] obj_cb_arg
863 * An opaque pointer passed to the callback function.
865 * The number of objects added on success.
866 * On error, no objects are populated and a negative errno is returned.
868 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
869 void *vaddr, rte_iova_t iova, size_t len,
870 rte_mempool_populate_obj_cb_t *obj_cb,
874 * Wrapper for mempool_ops get_info callback.
877 * Pointer to the memory pool.
879 * Pointer to the rte_mempool_info structure
881 * - 0: Success; The mempool driver supports retrieving supplementary
882 * mempool information
883 * - -ENOTSUP - doesn't support get_info ops (valid case).
885 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
886 struct rte_mempool_info *info);
889 * @internal wrapper for mempool_ops free callback.
892 * Pointer to the memory pool.
895 rte_mempool_ops_free(struct rte_mempool *mp);
898 * Set the ops of a mempool.
900 * This can only be done on a mempool that is not populated, i.e. just after
901 * a call to rte_mempool_create_empty().
904 * Pointer to the memory pool.
906 * Name of the ops structure to use for this mempool.
908 * Opaque data that can be passed by the application to the ops functions.
910 * - 0: Success; the mempool is now using the requested ops functions.
911 * - -EINVAL - Invalid ops struct name provided.
912 * - -EEXIST - mempool already has an ops struct assigned.
915 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
919 * Register mempool operations.
922 * Pointer to an ops structure to register.
924 * - >=0: Success; return the index of the ops struct in the table.
925 * - -EINVAL - some missing callbacks while registering ops struct.
926 * - -ENOSPC - the maximum number of ops structs has been reached.
928 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
931 * Macro to statically register the ops of a mempool handler.
932 * Note that the rte_mempool_register_ops fails silently here when
933 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
935 #define RTE_MEMPOOL_REGISTER_OPS(ops) \
936 RTE_INIT(mp_hdlr_init_##ops) \
938 rte_mempool_register_ops(&ops); \
941 /** Deprecated. Use RTE_MEMPOOL_REGISTER_OPS() instead. */
942 #define MEMPOOL_REGISTER_OPS(ops) \
943 RTE_DEPRECATED(MEMPOOL_REGISTER_OPS) RTE_MEMPOOL_REGISTER_OPS(ops)
946 * An object callback function for mempool.
948 * Used by rte_mempool_create() and rte_mempool_obj_iter().
950 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
951 void *opaque, void *obj, unsigned obj_idx);
952 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
955 * A memory callback function for mempool.
957 * Used by rte_mempool_mem_iter().
959 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
960 void *opaque, struct rte_mempool_memhdr *memhdr,
964 * A mempool constructor callback function.
966 * Arguments are the mempool and the opaque pointer given by the user in
967 * rte_mempool_create().
969 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
972 * Create a new mempool named *name* in memory.
974 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
975 * pool contains n elements of elt_size. Its size is set to n.
978 * The name of the mempool.
980 * The number of elements in the mempool. The optimum size (in terms of
981 * memory usage) for a mempool is when n is a power of two minus one:
984 * The size of each element.
986 * If cache_size is non-zero, the rte_mempool library will try to
987 * limit the accesses to the common lockless pool, by maintaining a
988 * per-lcore object cache. This argument must be lower or equal to
989 * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
990 * cache_size to have "n modulo cache_size == 0": if this is
991 * not the case, some elements will always stay in the pool and will
992 * never be used. The access to the per-lcore table is of course
993 * faster than the multi-producer/consumer pool. The cache can be
994 * disabled if the cache_size argument is set to 0; it can be useful to
995 * avoid losing objects in cache.
996 * @param private_data_size
997 * The size of the private data appended after the mempool
998 * structure. This is useful for storing some private data after the
999 * mempool structure, as is done for rte_mbuf_pool for example.
1001 * A function pointer that is called for initialization of the pool,
1002 * before object initialization. The user can initialize the private
1003 * data in this function if needed. This parameter can be NULL if
1005 * @param mp_init_arg
1006 * An opaque pointer to data that can be used in the mempool
1007 * constructor function.
1009 * A function pointer that is called for each object at
1010 * initialization of the pool. The user can set some meta data in
1011 * objects if needed. This parameter can be NULL if not needed.
1012 * The obj_init() function takes the mempool pointer, the init_arg,
1013 * the object pointer and the object number as parameters.
1014 * @param obj_init_arg
1015 * An opaque pointer to data that can be used as an argument for
1016 * each call to the object constructor function.
1018 * The *socket_id* argument is the socket identifier in the case of
1019 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1020 * constraint for the reserved zone.
1022 * The *flags* arguments is an OR of following flags:
1023 * - RTE_MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
1024 * between channels in RAM: the pool allocator will add padding
1025 * between objects depending on the hardware configuration. See
1026 * Memory alignment constraints for details. If this flag is set,
1027 * the allocator will just align them to a cache line.
1028 * - RTE_MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
1029 * cache-aligned. This flag removes this constraint, and no
1030 * padding will be present between objects. This flag implies
1031 * RTE_MEMPOOL_F_NO_SPREAD.
1032 * - RTE_MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
1033 * when using rte_mempool_put() or rte_mempool_put_bulk() is
1034 * "single-producer". Otherwise, it is "multi-producers".
1035 * - RTE_MEMPOOL_F_SC_GET: If this flag is set, the default behavior
1036 * when using rte_mempool_get() or rte_mempool_get_bulk() is
1037 * "single-consumer". Otherwise, it is "multi-consumers".
1038 * - RTE_MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
1039 * necessarily be contiguous in IO memory.
1041 * The pointer to the new allocated mempool, on success. NULL on error
1042 * with rte_errno set appropriately. Possible rte_errno values include:
1043 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1044 * - E_RTE_SECONDARY - function was called from a secondary process instance
1045 * - EINVAL - cache size provided is too large or an unknown flag was passed
1046 * - ENOSPC - the maximum number of memzones has already been allocated
1047 * - EEXIST - a memzone with the same name already exists
1048 * - ENOMEM - no appropriate memory area found in which to create memzone
1050 struct rte_mempool *
1051 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1052 unsigned cache_size, unsigned private_data_size,
1053 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1054 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1055 int socket_id, unsigned flags);
1058 * Create an empty mempool
1060 * The mempool is allocated and initialized, but it is not populated: no
1061 * memory is allocated for the mempool elements. The user has to call
1062 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1063 * populated, the user may also want to initialize each object with
1064 * rte_mempool_obj_iter().
1067 * The name of the mempool.
1069 * The maximum number of elements that can be added in the mempool.
1070 * The optimum size (in terms of memory usage) for a mempool is when n
1071 * is a power of two minus one: n = (2^q - 1).
1073 * The size of each element.
1075 * Size of the cache. See rte_mempool_create() for details.
1076 * @param private_data_size
1077 * The size of the private data appended after the mempool
1078 * structure. This is useful for storing some private data after the
1079 * mempool structure, as is done for rte_mbuf_pool for example.
1081 * The *socket_id* argument is the socket identifier in the case of
1082 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1083 * constraint for the reserved zone.
1085 * Flags controlling the behavior of the mempool. See
1086 * rte_mempool_create() for details.
1088 * The pointer to the new allocated mempool, on success. NULL on error
1089 * with rte_errno set appropriately. See rte_mempool_create() for details.
1091 struct rte_mempool *
1092 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1093 unsigned cache_size, unsigned private_data_size,
1094 int socket_id, unsigned flags);
1098 * Unlink the mempool from global list, free the memory chunks, and all
1099 * memory referenced by the mempool. The objects must not be used by
1100 * other cores as they will be freed.
1103 * A pointer to the mempool structure.
1106 rte_mempool_free(struct rte_mempool *mp);
1109 * Add physically contiguous memory for objects in the pool at init
1111 * Add a virtually and physically contiguous memory chunk in the pool
1112 * where objects can be instantiated.
1114 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1115 * the chunk doesn't need to be physically contiguous (only virtually),
1116 * and allocated objects may span two pages.
1119 * A pointer to the mempool structure.
1121 * The virtual address of memory that should be used to store objects.
1125 * The length of memory in bytes.
1127 * The callback used to free this chunk when destroying the mempool.
1129 * An opaque argument passed to free_cb.
1131 * The number of objects added on success (strictly positive).
1132 * On error, the chunk is not added in the memory list of the
1133 * mempool the following code is returned:
1134 * (0): not enough room in chunk for one object.
1135 * (-ENOSPC): mempool is already populated.
1136 * (-ENOMEM): allocation failure.
1138 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1139 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1143 * Add virtually contiguous memory for objects in the pool at init
1145 * Add a virtually contiguous memory chunk in the pool where objects can
1149 * A pointer to the mempool structure.
1151 * The virtual address of memory that should be used to store objects.
1153 * The length of memory in bytes.
1155 * The size of memory pages in this virtual area.
1157 * The callback used to free this chunk when destroying the mempool.
1159 * An opaque argument passed to free_cb.
1161 * The number of objects added on success (strictly positive).
1162 * On error, the chunk is not added in the memory list of the
1163 * mempool the following code is returned:
1164 * (0): not enough room in chunk for one object.
1165 * (-ENOSPC): mempool is already populated.
1166 * (-ENOMEM): allocation failure.
1169 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1170 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1174 * Add memory for objects in the pool at init
1176 * This is the default function used by rte_mempool_create() to populate
1177 * the mempool. It adds memory allocated using rte_memzone_reserve().
1180 * A pointer to the mempool structure.
1182 * The number of objects added on success.
1183 * On error, the chunk is not added in the memory list of the
1184 * mempool and a negative errno is returned.
1186 int rte_mempool_populate_default(struct rte_mempool *mp);
1189 * Add memory from anonymous mapping for objects in the pool at init
1191 * This function mmap an anonymous memory zone that is locked in
1192 * memory to store the objects of the mempool.
1195 * A pointer to the mempool structure.
1197 * The number of objects added on success.
1198 * On error, 0 is returned, rte_errno is set, and the chunk is not added in
1199 * the memory list of the mempool.
1201 int rte_mempool_populate_anon(struct rte_mempool *mp);
1204 * Call a function for each mempool element
1206 * Iterate across all objects attached to a rte_mempool and call the
1207 * callback function on it.
1210 * A pointer to an initialized mempool.
1212 * A function pointer that is called for each object.
1214 * An opaque pointer passed to the callback function.
1216 * Number of objects iterated.
1218 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1219 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1222 * Call a function for each mempool memory chunk
1224 * Iterate across all memory chunks attached to a rte_mempool and call
1225 * the callback function on it.
1228 * A pointer to an initialized mempool.
1230 * A function pointer that is called for each memory chunk.
1232 * An opaque pointer passed to the callback function.
1234 * Number of memory chunks iterated.
1236 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1237 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1240 * Dump the status of the mempool to a file.
1243 * A pointer to a file for output
1245 * A pointer to the mempool structure.
1247 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1250 * Create a user-owned mempool cache.
1252 * This can be used by unregistered non-EAL threads to enable caching when they
1253 * interact with a mempool.
1256 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1257 * parameter description for more information. The same limits and
1258 * considerations apply here too.
1260 * The socket identifier in the case of NUMA. The value can be
1261 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1263 struct rte_mempool_cache *
1264 rte_mempool_cache_create(uint32_t size, int socket_id);
1267 * Free a user-owned mempool cache.
1270 * A pointer to the mempool cache.
1273 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1276 * Get a pointer to the per-lcore default mempool cache.
1279 * A pointer to the mempool structure.
1281 * The logical core id.
1283 * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
1286 static __rte_always_inline struct rte_mempool_cache *
1287 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1289 if (mp->cache_size == 0)
1292 if (lcore_id >= RTE_MAX_LCORE)
1295 rte_mempool_trace_default_cache(mp, lcore_id,
1296 &mp->local_cache[lcore_id]);
1297 return &mp->local_cache[lcore_id];
1301 * Flush a user-owned mempool cache to the specified mempool.
1304 * A pointer to the mempool cache.
1306 * A pointer to the mempool.
1308 static __rte_always_inline void
1309 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1310 struct rte_mempool *mp)
1313 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1314 if (cache == NULL || cache->len == 0)
1316 rte_mempool_trace_cache_flush(cache, mp);
1317 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1322 * @internal Put several objects back in the mempool; used internally.
1324 * A pointer to the mempool structure.
1326 * A pointer to a table of void * pointers (objects).
1328 * The number of objects to store back in the mempool, must be strictly
1331 * A pointer to a mempool cache structure. May be NULL if not needed.
1333 static __rte_always_inline void
1334 rte_mempool_do_generic_put(struct rte_mempool *mp, void * const *obj_table,
1335 unsigned int n, struct rte_mempool_cache *cache)
1339 /* increment stat now, adding in mempool always success */
1340 RTE_MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1341 RTE_MEMPOOL_STAT_ADD(mp, put_objs, n);
1343 /* No cache provided or if put would overflow mem allocated for cache */
1344 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1347 cache_objs = &cache->objs[cache->len];
1350 * The cache follows the following algorithm
1351 * 1. Add the objects to the cache
1352 * 2. Anything greater than the cache min value (if it crosses the
1353 * cache flush threshold) is flushed to the ring.
1356 /* Add elements back into the cache */
1357 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1361 if (cache->len >= cache->flushthresh) {
1362 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1363 cache->len - cache->size);
1364 cache->len = cache->size;
1371 /* push remaining objects in ring */
1372 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1373 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1374 rte_panic("cannot put objects in mempool\n");
1376 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1382 * Put several objects back in the mempool.
1385 * A pointer to the mempool structure.
1387 * A pointer to a table of void * pointers (objects).
1389 * The number of objects to add in the mempool from the obj_table.
1391 * A pointer to a mempool cache structure. May be NULL if not needed.
1393 static __rte_always_inline void
1394 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1395 unsigned int n, struct rte_mempool_cache *cache)
1397 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1398 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 0);
1399 rte_mempool_do_generic_put(mp, obj_table, n, cache);
1403 * Put several objects back in the mempool.
1405 * This function calls the multi-producer or the single-producer
1406 * version depending on the default behavior that was specified at
1407 * mempool creation time (see flags).
1410 * A pointer to the mempool structure.
1412 * A pointer to a table of void * pointers (objects).
1414 * The number of objects to add in the mempool from obj_table.
1416 static __rte_always_inline void
1417 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1420 struct rte_mempool_cache *cache;
1421 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1422 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1423 rte_mempool_generic_put(mp, obj_table, n, cache);
1427 * Put one object back in the mempool.
1429 * This function calls the multi-producer or the single-producer
1430 * version depending on the default behavior that was specified at
1431 * mempool creation time (see flags).
1434 * A pointer to the mempool structure.
1436 * A pointer to the object to be added.
1438 static __rte_always_inline void
1439 rte_mempool_put(struct rte_mempool *mp, void *obj)
1441 rte_mempool_put_bulk(mp, &obj, 1);
1445 * @internal Get several objects from the mempool; used internally.
1447 * A pointer to the mempool structure.
1449 * A pointer to a table of void * pointers (objects).
1451 * The number of objects to get, must be strictly positive.
1453 * A pointer to a mempool cache structure. May be NULL if not needed.
1455 * - >=0: Success; number of objects supplied.
1456 * - <0: Error; code of ring dequeue function.
1458 static __rte_always_inline int
1459 rte_mempool_do_generic_get(struct rte_mempool *mp, void **obj_table,
1460 unsigned int n, struct rte_mempool_cache *cache)
1463 uint32_t index, len;
1466 /* No cache provided or cannot be satisfied from cache */
1467 if (unlikely(cache == NULL || n >= cache->size))
1470 cache_objs = cache->objs;
1472 /* Can this be satisfied from the cache? */
1473 if (cache->len < n) {
1474 /* No. Backfill the cache first, and then fill from it */
1475 uint32_t req = n + (cache->size - cache->len);
1477 /* How many do we require i.e. number to fill the cache + the request */
1478 ret = rte_mempool_ops_dequeue_bulk(mp,
1479 &cache->objs[cache->len], req);
1480 if (unlikely(ret < 0)) {
1482 * In the off chance that we are buffer constrained,
1483 * where we are not able to allocate cache + n, go to
1484 * the ring directly. If that fails, we are truly out of
1493 /* Now fill in the response ... */
1494 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1495 *obj_table = cache_objs[len];
1499 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1500 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1506 /* get remaining objects from ring */
1507 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1510 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1511 RTE_MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1513 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1514 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1521 * Get several objects from the mempool.
1523 * If cache is enabled, objects will be retrieved first from cache,
1524 * subsequently from the common pool. Note that it can return -ENOENT when
1525 * the local cache and common pool are empty, even if cache from other
1529 * A pointer to the mempool structure.
1531 * A pointer to a table of void * pointers (objects) that will be filled.
1533 * The number of objects to get from mempool to obj_table.
1535 * A pointer to a mempool cache structure. May be NULL if not needed.
1537 * - 0: Success; objects taken.
1538 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1540 static __rte_always_inline int
1541 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1542 unsigned int n, struct rte_mempool_cache *cache)
1545 ret = rte_mempool_do_generic_get(mp, obj_table, n, cache);
1547 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 1);
1548 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1553 * Get several objects from the mempool.
1555 * This function calls the multi-consumers or the single-consumer
1556 * version, depending on the default behaviour that was specified at
1557 * mempool creation time (see flags).
1559 * If cache is enabled, objects will be retrieved first from cache,
1560 * subsequently from the common pool. Note that it can return -ENOENT when
1561 * the local cache and common pool are empty, even if cache from other
1565 * A pointer to the mempool structure.
1567 * A pointer to a table of void * pointers (objects) that will be filled.
1569 * The number of objects to get from the mempool to obj_table.
1571 * - 0: Success; objects taken
1572 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1574 static __rte_always_inline int
1575 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1577 struct rte_mempool_cache *cache;
1578 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1579 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1580 return rte_mempool_generic_get(mp, obj_table, n, cache);
1584 * Get one object from the mempool.
1586 * This function calls the multi-consumers or the single-consumer
1587 * version, depending on the default behavior that was specified at
1588 * mempool creation (see flags).
1590 * If cache is enabled, objects will be retrieved first from cache,
1591 * subsequently from the common pool. Note that it can return -ENOENT when
1592 * the local cache and common pool are empty, even if cache from other
1596 * A pointer to the mempool structure.
1598 * A pointer to a void * pointer (object) that will be filled.
1600 * - 0: Success; objects taken.
1601 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1603 static __rte_always_inline int
1604 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1606 return rte_mempool_get_bulk(mp, obj_p, 1);
1610 * Get a contiguous blocks of objects from the mempool.
1612 * If cache is enabled, consider to flush it first, to reuse objects
1613 * as soon as possible.
1615 * The application should check that the driver supports the operation
1616 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1620 * A pointer to the mempool structure.
1621 * @param first_obj_table
1622 * A pointer to a pointer to the first object in each block.
1624 * The number of blocks to get from mempool.
1626 * - 0: Success; blocks taken.
1627 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1628 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1630 static __rte_always_inline int
1631 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1632 void **first_obj_table, unsigned int n)
1636 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1638 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1639 RTE_MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1640 RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table, n,
1643 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1644 RTE_MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1647 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1652 * Return the number of entries in the mempool.
1654 * When cache is enabled, this function has to browse the length of
1655 * all lcores, so it should not be used in a data path, but only for
1656 * debug purposes. User-owned mempool caches are not accounted for.
1659 * A pointer to the mempool structure.
1661 * The number of entries in the mempool.
1663 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1666 * Return the number of elements which have been allocated from the mempool
1668 * When cache is enabled, this function has to browse the length of
1669 * all lcores, so it should not be used in a data path, but only for
1673 * A pointer to the mempool structure.
1675 * The number of free entries in the mempool.
1678 rte_mempool_in_use_count(const struct rte_mempool *mp);
1681 * Test if the mempool is full.
1683 * When cache is enabled, this function has to browse the length of all
1684 * lcores, so it should not be used in a data path, but only for debug
1685 * purposes. User-owned mempool caches are not accounted for.
1688 * A pointer to the mempool structure.
1690 * - 1: The mempool is full.
1691 * - 0: The mempool is not full.
1694 rte_mempool_full(const struct rte_mempool *mp)
1696 return rte_mempool_avail_count(mp) == mp->size;
1700 * Test if the mempool is empty.
1702 * When cache is enabled, this function has to browse the length of all
1703 * lcores, so it should not be used in a data path, but only for debug
1704 * purposes. User-owned mempool caches are not accounted for.
1707 * A pointer to the mempool structure.
1709 * - 1: The mempool is empty.
1710 * - 0: The mempool is not empty.
1713 rte_mempool_empty(const struct rte_mempool *mp)
1715 return rte_mempool_avail_count(mp) == 0;
1719 * Return the IO address of elt, which is an element of the pool mp.
1722 * A pointer (virtual address) to the element of the pool.
1724 * The IO address of the elt element.
1725 * If the mempool was created with RTE_MEMPOOL_F_NO_IOVA_CONTIG, the
1726 * returned value is RTE_BAD_IOVA.
1728 static inline rte_iova_t
1729 rte_mempool_virt2iova(const void *elt)
1731 const struct rte_mempool_objhdr *hdr;
1732 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1738 * Check the consistency of mempool objects.
1740 * Verify the coherency of fields in the mempool structure. Also check
1741 * that the cookies of mempool objects (even the ones that are not
1742 * present in pool) have a correct value. If not, a panic will occur.
1745 * A pointer to the mempool structure.
1747 void rte_mempool_audit(struct rte_mempool *mp);
1750 * Return a pointer to the private data in an mempool structure.
1753 * A pointer to the mempool structure.
1755 * A pointer to the private data.
1757 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1760 RTE_MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1764 * Dump the status of all mempools on the console
1767 * A pointer to a file for output
1769 void rte_mempool_list_dump(FILE *f);
1772 * Search a mempool from its name
1775 * The name of the mempool.
1777 * The pointer to the mempool matching the name, or NULL if not found.
1779 * with rte_errno set appropriately. Possible rte_errno values include:
1780 * - ENOENT - required entry not available to return.
1783 struct rte_mempool *rte_mempool_lookup(const char *name);
1786 * Get the header, trailer and total size of a mempool element.
1788 * Given a desired size of the mempool element and mempool flags,
1789 * calculates header, trailer, body and total sizes of the mempool object.
1792 * The size of each element, without header and trailer.
1794 * The flags used for the mempool creation.
1795 * Consult rte_mempool_create() for more information about possible values.
1796 * The size of each element.
1798 * The calculated detailed size the mempool object. May be NULL.
1800 * Total size of the mempool object.
1802 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1803 struct rte_mempool_objsz *sz);
1806 * Walk list of all memory pools
1811 * Argument passed to iterator
1813 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1817 * @internal Get page size used for mempool object allocation.
1818 * This function is internal to mempool library and mempool drivers.
1821 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1824 * Mempool event type.
1827 enum rte_mempool_event {
1828 /** Occurs after a mempool is fully populated. */
1829 RTE_MEMPOOL_EVENT_READY = 0,
1830 /** Occurs before the destruction of a mempool begins. */
1831 RTE_MEMPOOL_EVENT_DESTROY = 1,
1836 * Mempool event callback.
1838 * rte_mempool_event_callback_register() may be called from within the callback,
1839 * but the callbacks registered this way will not be invoked for the same event.
1840 * rte_mempool_event_callback_unregister() may only be safely called
1841 * to remove the running callback.
1843 typedef void (rte_mempool_event_callback)(
1844 enum rte_mempool_event event,
1845 struct rte_mempool *mp,
1850 * Register a callback function invoked on mempool life cycle event.
1851 * The function will be invoked in the process
1852 * that performs an action which triggers the callback.
1855 * Callback function.
1860 * 0 on success, negative on failure and rte_errno is set.
1864 rte_mempool_event_callback_register(rte_mempool_event_callback *func,
1869 * Unregister a callback added with rte_mempool_event_callback_register().
1870 * @p func and @p user_data must exactly match registration parameters.
1873 * Callback function.
1878 * 0 on success, negative on failure and rte_errno is set.
1882 rte_mempool_event_callback_unregister(rte_mempool_event_callback *func,
1889 #endif /* _RTE_MEMPOOL_H_ */