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 * @internal When debug is enabled, store some statistics.
298 * Pointer to the memory pool.
300 * Name of the statistics field to increment in the memory pool.
302 * Number to add to the object-oriented statistics.
304 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
305 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do { \
306 unsigned __lcore_id = rte_lcore_id(); \
307 if (__lcore_id < RTE_MAX_LCORE) { \
308 mp->stats[__lcore_id].name += n; \
312 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do {} while (0)
316 * @internal Calculate the size of the mempool header.
319 * Pointer to the memory pool.
321 * Size of the per-lcore cache.
323 #define RTE_MEMPOOL_HEADER_SIZE(mp, cs) \
324 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
325 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
327 /** Deprecated. Use RTE_MEMPOOL_HEADER_SIZE() for internal purposes only. */
328 #define MEMPOOL_HEADER_SIZE(mp, cs) \
329 RTE_DEPRECATED(MEMPOOL_HEADER_SIZE) RTE_MEMPOOL_HEADER_SIZE(mp, cs)
331 /* return the header of a mempool object (internal) */
332 static inline struct rte_mempool_objhdr *
333 rte_mempool_get_header(void *obj)
335 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
336 sizeof(struct rte_mempool_objhdr));
340 * Return a pointer to the mempool owning this object.
343 * An object that is owned by a pool. If this is not the case,
344 * the behavior is undefined.
346 * A pointer to the mempool structure.
348 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
350 struct rte_mempool_objhdr *hdr = rte_mempool_get_header(obj);
354 /* return the trailer of a mempool object (internal) */
355 static inline struct rte_mempool_objtlr *rte_mempool_get_trailer(void *obj)
357 struct rte_mempool *mp = rte_mempool_from_obj(obj);
358 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
362 * @internal Check and update cookies or panic.
365 * Pointer to the memory pool.
366 * @param obj_table_const
367 * Pointer to a table of void * pointers (objects).
369 * Index of object in object table.
371 * - 0: object is supposed to be allocated, mark it as free
372 * - 1: object is supposed to be free, mark it as allocated
373 * - 2: just check that cookie is valid (free or allocated)
375 void rte_mempool_check_cookies(const struct rte_mempool *mp,
376 void * const *obj_table_const, unsigned n, int free);
378 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
379 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) \
380 rte_mempool_check_cookies(mp, obj_table_const, n, free)
382 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) do {} while (0)
383 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
386 * @internal Check contiguous object blocks and update cookies or panic.
389 * Pointer to the memory pool.
390 * @param first_obj_table_const
391 * Pointer to a table of void * pointers (first object of the contiguous
394 * Number of contiguous object blocks.
396 * - 0: object is supposed to be allocated, mark it as free
397 * - 1: object is supposed to be free, mark it as allocated
398 * - 2: just check that cookie is valid (free or allocated)
400 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
401 void * const *first_obj_table_const, unsigned int n, int free);
403 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
404 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
406 rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
409 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
412 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
414 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
417 * Prototype for implementation specific data provisioning function.
419 * The function should provide the implementation specific memory for
420 * use by the other mempool ops functions in a given mempool ops struct.
421 * E.g. the default ops provides an instance of the rte_ring for this purpose.
422 * it will most likely point to a different type of data structure, and
423 * will be transparent to the application programmer.
424 * This function should set mp->pool_data.
426 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
429 * Free the opaque private data pointed to by mp->pool_data pointer.
431 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
434 * Enqueue an object into the external pool.
436 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
437 void * const *obj_table, unsigned int n);
440 * Dequeue an object from the external pool.
442 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
443 void **obj_table, unsigned int n);
446 * Dequeue a number of contiguous object blocks from the external pool.
448 typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
449 void **first_obj_table, unsigned int n);
452 * Return the number of available objects in the external pool.
454 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
457 * Calculate memory size required to store given number of objects.
459 * If mempool objects are not required to be IOVA-contiguous
460 * (the flag RTE_MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
461 * virtually contiguous chunk size. Otherwise, if mempool objects must
462 * be IOVA-contiguous (the flag RTE_MEMPOOL_F_NO_IOVA_CONTIG is clear),
463 * min_chunk_size defines IOVA-contiguous chunk size.
466 * Pointer to the memory pool.
469 * @param[in] pg_shift
470 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
471 * @param[out] min_chunk_size
472 * Location for minimum size of the memory chunk which may be used to
473 * store memory pool objects.
475 * Location for required memory chunk alignment.
477 * Required memory size.
479 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
480 uint32_t obj_num, uint32_t pg_shift,
481 size_t *min_chunk_size, size_t *align);
484 * @internal Helper to calculate memory size required to store given
487 * This function is internal to mempool library and mempool drivers.
489 * If page boundaries may be ignored, it is just a product of total
490 * object size including header and trailer and number of objects.
491 * Otherwise, it is a number of pages required to store given number of
492 * objects without crossing page boundary.
494 * Note that if object size is bigger than page size, then it assumes
495 * that pages are grouped in subsets of physically continuous pages big
496 * enough to store at least one object.
498 * Minimum size of memory chunk is the total element size.
499 * Required memory chunk alignment is the cache line size.
502 * A pointer to the mempool structure.
504 * Number of objects to be added in mempool.
505 * @param[in] pg_shift
506 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
507 * @param[in] chunk_reserve
508 * Amount of memory that must be reserved at the beginning of each page,
509 * or at the beginning of the memory area if pg_shift is 0.
510 * @param[out] min_chunk_size
511 * Location for minimum size of the memory chunk which may be used to
512 * store memory pool objects.
514 * Location for required memory chunk alignment.
516 * Required memory size.
518 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
519 uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
520 size_t *min_chunk_size, size_t *align);
523 * Default way to calculate memory size required to store given number of
526 * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
527 * 0, min_chunk_size, align).
529 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
530 uint32_t obj_num, uint32_t pg_shift,
531 size_t *min_chunk_size, size_t *align);
534 * Function to be called for each populated object.
537 * A pointer to the mempool structure.
539 * An opaque pointer passed to iterator.
541 * Object virtual address.
543 * Input/output virtual address of the object or RTE_BAD_IOVA.
545 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
546 void *opaque, void *vaddr, rte_iova_t iova);
549 * Populate memory pool objects using provided memory chunk.
551 * Populated objects should be enqueued to the pool, e.g. using
552 * rte_mempool_ops_enqueue_bulk().
554 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
555 * the chunk doesn't need to be physically contiguous (only virtually),
556 * and allocated objects may span two pages.
559 * A pointer to the mempool structure.
560 * @param[in] max_objs
561 * Maximum number of objects to be populated.
563 * The virtual address of memory that should be used to store objects.
567 * The length of memory in bytes.
569 * Callback function to be executed for each populated object.
570 * @param[in] obj_cb_arg
571 * An opaque pointer passed to the callback function.
573 * The number of objects added on success.
574 * On error, no objects are populated and a negative errno is returned.
576 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
577 unsigned int max_objs,
578 void *vaddr, rte_iova_t iova, size_t len,
579 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
582 * Align objects on addresses multiple of total_elt_sz.
584 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
587 * @internal Helper to populate memory pool object using provided memory
588 * chunk: just slice objects one by one, taking care of not
589 * crossing page boundaries.
591 * If RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ is set in flags, the addresses
592 * of object headers will be aligned on a multiple of total_elt_sz.
593 * This feature is used by octeontx hardware.
595 * This function is internal to mempool library and mempool drivers.
598 * A pointer to the mempool structure.
600 * Logical OR of following flags:
601 * - RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ: align objects on addresses
602 * multiple of total_elt_sz.
603 * @param[in] max_objs
604 * Maximum number of objects to be added in mempool.
606 * The virtual address of memory that should be used to store objects.
608 * The IO address corresponding to vaddr, or RTE_BAD_IOVA.
610 * The length of memory in bytes.
612 * Callback function to be executed for each populated object.
613 * @param[in] obj_cb_arg
614 * An opaque pointer passed to the callback function.
616 * The number of objects added in mempool.
618 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
619 unsigned int flags, 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);
624 * Default way to populate memory pool object using provided memory chunk.
626 * Equivalent to rte_mempool_op_populate_helper(mp, 0, max_objs, vaddr, iova,
627 * len, obj_cb, obj_cb_arg).
629 int rte_mempool_op_populate_default(struct rte_mempool *mp,
630 unsigned int max_objs,
631 void *vaddr, rte_iova_t iova, size_t len,
632 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
635 * Get some additional information about a mempool.
637 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
638 struct rte_mempool_info *info);
641 /** Structure defining mempool operations structure */
642 struct rte_mempool_ops {
643 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
644 rte_mempool_alloc_t alloc; /**< Allocate private data. */
645 rte_mempool_free_t free; /**< Free the external pool. */
646 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
647 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
648 rte_mempool_get_count get_count; /**< Get qty of available objs. */
650 * Optional callback to calculate memory size required to
651 * store specified number of objects.
653 rte_mempool_calc_mem_size_t calc_mem_size;
655 * Optional callback to populate mempool objects using
656 * provided memory chunk.
658 rte_mempool_populate_t populate;
662 rte_mempool_get_info_t get_info;
664 * Dequeue a number of contiguous object blocks.
666 rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks;
667 } __rte_cache_aligned;
669 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
672 * Structure storing the table of registered ops structs, each of which contain
673 * the function pointers for the mempool ops functions.
674 * Each process has its own storage for this ops struct array so that
675 * the mempools can be shared across primary and secondary processes.
676 * The indices used to access the array are valid across processes, whereas
677 * any function pointers stored directly in the mempool struct would not be.
678 * This results in us simply having "ops_index" in the mempool struct.
680 struct rte_mempool_ops_table {
681 rte_spinlock_t sl; /**< Spinlock for add/delete. */
682 uint32_t num_ops; /**< Number of used ops structs in the table. */
684 * Storage for all possible ops structs.
686 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
687 } __rte_cache_aligned;
689 /** Array of registered ops structs. */
690 extern struct rte_mempool_ops_table rte_mempool_ops_table;
693 * @internal Get the mempool ops struct from its index.
696 * The index of the ops struct in the ops struct table. It must be a valid
697 * index: (0 <= idx < num_ops).
699 * The pointer to the ops struct in the table.
701 static inline struct rte_mempool_ops *
702 rte_mempool_get_ops(int ops_index)
704 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
706 return &rte_mempool_ops_table.ops[ops_index];
710 * @internal Wrapper for mempool_ops alloc callback.
713 * Pointer to the memory pool.
715 * - 0: Success; successfully allocated mempool pool_data.
716 * - <0: Error; code of alloc function.
719 rte_mempool_ops_alloc(struct rte_mempool *mp);
722 * @internal Wrapper for mempool_ops dequeue callback.
725 * Pointer to the memory pool.
727 * Pointer to a table of void * pointers (objects).
729 * Number of objects to get.
731 * - 0: Success; got n objects.
732 * - <0: Error; code of dequeue function.
735 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
736 void **obj_table, unsigned n)
738 struct rte_mempool_ops *ops;
741 rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
742 ops = rte_mempool_get_ops(mp->ops_index);
743 ret = ops->dequeue(mp, obj_table, n);
745 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
746 RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
752 * @internal Wrapper for mempool_ops dequeue_contig_blocks callback.
755 * Pointer to the memory pool.
756 * @param[out] first_obj_table
757 * Pointer to a table of void * pointers (first objects).
759 * Number of blocks to get.
761 * - 0: Success; got n objects.
762 * - <0: Error; code of dequeue function.
765 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
766 void **first_obj_table, unsigned int n)
768 struct rte_mempool_ops *ops;
770 ops = rte_mempool_get_ops(mp->ops_index);
771 RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
772 rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
773 return ops->dequeue_contig_blocks(mp, first_obj_table, n);
777 * @internal wrapper for mempool_ops enqueue callback.
780 * Pointer to the memory pool.
782 * Pointer to a table of void * pointers (objects).
784 * Number of objects to put.
786 * - 0: Success; n objects supplied.
787 * - <0: Error; code of enqueue function.
790 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
793 struct rte_mempool_ops *ops;
795 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
796 RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
797 rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
798 ops = rte_mempool_get_ops(mp->ops_index);
799 return ops->enqueue(mp, obj_table, n);
803 * @internal wrapper for mempool_ops get_count callback.
806 * Pointer to the memory pool.
808 * The number of available objects in the external pool.
811 rte_mempool_ops_get_count(const struct rte_mempool *mp);
814 * @internal wrapper for mempool_ops calc_mem_size callback.
815 * API to calculate size of memory required to store specified number of
819 * Pointer to the memory pool.
822 * @param[in] pg_shift
823 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
824 * @param[out] min_chunk_size
825 * Location for minimum size of the memory chunk which may be used to
826 * store memory pool objects.
828 * Location for required memory chunk alignment.
830 * Required memory size aligned at page boundary.
832 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
833 uint32_t obj_num, uint32_t pg_shift,
834 size_t *min_chunk_size, size_t *align);
837 * @internal wrapper for mempool_ops populate callback.
839 * Populate memory pool objects using provided memory chunk.
842 * A pointer to the mempool structure.
843 * @param[in] max_objs
844 * Maximum number of objects to be populated.
846 * The virtual address of memory that should be used to store objects.
850 * The length of memory in bytes.
852 * Callback function to be executed for each populated object.
853 * @param[in] obj_cb_arg
854 * An opaque pointer passed to the callback function.
856 * The number of objects added on success.
857 * On error, no objects are populated and a negative errno is returned.
859 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
860 void *vaddr, rte_iova_t iova, size_t len,
861 rte_mempool_populate_obj_cb_t *obj_cb,
865 * Wrapper for mempool_ops get_info callback.
868 * Pointer to the memory pool.
870 * Pointer to the rte_mempool_info structure
872 * - 0: Success; The mempool driver supports retrieving supplementary
873 * mempool information
874 * - -ENOTSUP - doesn't support get_info ops (valid case).
876 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
877 struct rte_mempool_info *info);
880 * @internal wrapper for mempool_ops free callback.
883 * Pointer to the memory pool.
886 rte_mempool_ops_free(struct rte_mempool *mp);
889 * Set the ops of a mempool.
891 * This can only be done on a mempool that is not populated, i.e. just after
892 * a call to rte_mempool_create_empty().
895 * Pointer to the memory pool.
897 * Name of the ops structure to use for this mempool.
899 * Opaque data that can be passed by the application to the ops functions.
901 * - 0: Success; the mempool is now using the requested ops functions.
902 * - -EINVAL - Invalid ops struct name provided.
903 * - -EEXIST - mempool already has an ops struct assigned.
906 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
910 * Register mempool operations.
913 * Pointer to an ops structure to register.
915 * - >=0: Success; return the index of the ops struct in the table.
916 * - -EINVAL - some missing callbacks while registering ops struct.
917 * - -ENOSPC - the maximum number of ops structs has been reached.
919 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
922 * Macro to statically register the ops of a mempool handler.
923 * Note that the rte_mempool_register_ops fails silently here when
924 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
926 #define RTE_MEMPOOL_REGISTER_OPS(ops) \
927 RTE_INIT(mp_hdlr_init_##ops) \
929 rte_mempool_register_ops(&ops); \
932 /** Deprecated. Use RTE_MEMPOOL_REGISTER_OPS() instead. */
933 #define MEMPOOL_REGISTER_OPS(ops) \
934 RTE_DEPRECATED(MEMPOOL_REGISTER_OPS) RTE_MEMPOOL_REGISTER_OPS(ops)
937 * An object callback function for mempool.
939 * Used by rte_mempool_create() and rte_mempool_obj_iter().
941 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
942 void *opaque, void *obj, unsigned obj_idx);
943 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
946 * A memory callback function for mempool.
948 * Used by rte_mempool_mem_iter().
950 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
951 void *opaque, struct rte_mempool_memhdr *memhdr,
955 * A mempool constructor callback function.
957 * Arguments are the mempool and the opaque pointer given by the user in
958 * rte_mempool_create().
960 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
963 * Create a new mempool named *name* in memory.
965 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
966 * pool contains n elements of elt_size. Its size is set to n.
969 * The name of the mempool.
971 * The number of elements in the mempool. The optimum size (in terms of
972 * memory usage) for a mempool is when n is a power of two minus one:
975 * The size of each element.
977 * If cache_size is non-zero, the rte_mempool library will try to
978 * limit the accesses to the common lockless pool, by maintaining a
979 * per-lcore object cache. This argument must be lower or equal to
980 * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
981 * cache_size to have "n modulo cache_size == 0": if this is
982 * not the case, some elements will always stay in the pool and will
983 * never be used. The access to the per-lcore table is of course
984 * faster than the multi-producer/consumer pool. The cache can be
985 * disabled if the cache_size argument is set to 0; it can be useful to
986 * avoid losing objects in cache.
987 * @param private_data_size
988 * The size of the private data appended after the mempool
989 * structure. This is useful for storing some private data after the
990 * mempool structure, as is done for rte_mbuf_pool for example.
992 * A function pointer that is called for initialization of the pool,
993 * before object initialization. The user can initialize the private
994 * data in this function if needed. This parameter can be NULL if
997 * An opaque pointer to data that can be used in the mempool
998 * constructor function.
1000 * A function pointer that is called for each object at
1001 * initialization of the pool. The user can set some meta data in
1002 * objects if needed. This parameter can be NULL if not needed.
1003 * The obj_init() function takes the mempool pointer, the init_arg,
1004 * the object pointer and the object number as parameters.
1005 * @param obj_init_arg
1006 * An opaque pointer to data that can be used as an argument for
1007 * each call to the object constructor function.
1009 * The *socket_id* argument is the socket identifier in the case of
1010 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1011 * constraint for the reserved zone.
1013 * The *flags* arguments is an OR of following flags:
1014 * - RTE_MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
1015 * between channels in RAM: the pool allocator will add padding
1016 * between objects depending on the hardware configuration. See
1017 * Memory alignment constraints for details. If this flag is set,
1018 * the allocator will just align them to a cache line.
1019 * - RTE_MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
1020 * cache-aligned. This flag removes this constraint, and no
1021 * padding will be present between objects. This flag implies
1022 * RTE_MEMPOOL_F_NO_SPREAD.
1023 * - RTE_MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
1024 * when using rte_mempool_put() or rte_mempool_put_bulk() is
1025 * "single-producer". Otherwise, it is "multi-producers".
1026 * - RTE_MEMPOOL_F_SC_GET: If this flag is set, the default behavior
1027 * when using rte_mempool_get() or rte_mempool_get_bulk() is
1028 * "single-consumer". Otherwise, it is "multi-consumers".
1029 * - RTE_MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
1030 * necessarily be contiguous in IO memory.
1032 * The pointer to the new allocated mempool, on success. NULL on error
1033 * with rte_errno set appropriately. Possible rte_errno values include:
1034 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1035 * - E_RTE_SECONDARY - function was called from a secondary process instance
1036 * - EINVAL - cache size provided is too large or an unknown flag was passed
1037 * - ENOSPC - the maximum number of memzones has already been allocated
1038 * - EEXIST - a memzone with the same name already exists
1039 * - ENOMEM - no appropriate memory area found in which to create memzone
1041 struct rte_mempool *
1042 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1043 unsigned cache_size, unsigned private_data_size,
1044 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1045 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1046 int socket_id, unsigned flags);
1049 * Create an empty mempool
1051 * The mempool is allocated and initialized, but it is not populated: no
1052 * memory is allocated for the mempool elements. The user has to call
1053 * rte_mempool_populate_*() to add memory chunks to the pool. Once
1054 * populated, the user may also want to initialize each object with
1055 * rte_mempool_obj_iter().
1058 * The name of the mempool.
1060 * The maximum number of elements that can be added in the mempool.
1061 * The optimum size (in terms of memory usage) for a mempool is when n
1062 * is a power of two minus one: n = (2^q - 1).
1064 * The size of each element.
1066 * Size of the cache. See rte_mempool_create() for details.
1067 * @param private_data_size
1068 * The size of the private data appended after the mempool
1069 * structure. This is useful for storing some private data after the
1070 * mempool structure, as is done for rte_mbuf_pool for example.
1072 * The *socket_id* argument is the socket identifier in the case of
1073 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1074 * constraint for the reserved zone.
1076 * Flags controlling the behavior of the mempool. See
1077 * rte_mempool_create() for details.
1079 * The pointer to the new allocated mempool, on success. NULL on error
1080 * with rte_errno set appropriately. See rte_mempool_create() for details.
1082 struct rte_mempool *
1083 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1084 unsigned cache_size, unsigned private_data_size,
1085 int socket_id, unsigned flags);
1089 * Unlink the mempool from global list, free the memory chunks, and all
1090 * memory referenced by the mempool. The objects must not be used by
1091 * other cores as they will be freed.
1094 * A pointer to the mempool structure.
1097 rte_mempool_free(struct rte_mempool *mp);
1100 * Add physically contiguous memory for objects in the pool at init
1102 * Add a virtually and physically contiguous memory chunk in the pool
1103 * where objects can be instantiated.
1105 * If the given IO address is unknown (iova = RTE_BAD_IOVA),
1106 * the chunk doesn't need to be physically contiguous (only virtually),
1107 * and allocated objects may span two pages.
1110 * A pointer to the mempool structure.
1112 * The virtual address of memory that should be used to store objects.
1116 * The length of memory in bytes.
1118 * The callback used to free this chunk when destroying the mempool.
1120 * An opaque argument passed to free_cb.
1122 * The number of objects added on success (strictly positive).
1123 * On error, the chunk is not added in the memory list of the
1124 * mempool the following code is returned:
1125 * (0): not enough room in chunk for one object.
1126 * (-ENOSPC): mempool is already populated.
1127 * (-ENOMEM): allocation failure.
1129 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1130 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1134 * Add virtually contiguous memory for objects in the pool at init
1136 * Add a virtually contiguous memory chunk in the pool where objects can
1140 * A pointer to the mempool structure.
1142 * The virtual address of memory that should be used to store objects.
1144 * The length of memory in bytes.
1146 * The size of memory pages in this virtual area.
1148 * The callback used to free this chunk when destroying the mempool.
1150 * An opaque argument passed to free_cb.
1152 * The number of objects added on success (strictly positive).
1153 * On error, the chunk is not added in the memory list of the
1154 * mempool the following code is returned:
1155 * (0): not enough room in chunk for one object.
1156 * (-ENOSPC): mempool is already populated.
1157 * (-ENOMEM): allocation failure.
1160 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1161 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1165 * Add memory for objects in the pool at init
1167 * This is the default function used by rte_mempool_create() to populate
1168 * the mempool. It adds memory allocated using rte_memzone_reserve().
1171 * A pointer to the mempool structure.
1173 * The number of objects added on success.
1174 * On error, the chunk is not added in the memory list of the
1175 * mempool and a negative errno is returned.
1177 int rte_mempool_populate_default(struct rte_mempool *mp);
1180 * Add memory from anonymous mapping for objects in the pool at init
1182 * This function mmap an anonymous memory zone that is locked in
1183 * memory to store the objects of the mempool.
1186 * A pointer to the mempool structure.
1188 * The number of objects added on success.
1189 * On error, 0 is returned, rte_errno is set, and the chunk is not added in
1190 * the memory list of the mempool.
1192 int rte_mempool_populate_anon(struct rte_mempool *mp);
1195 * Call a function for each mempool element
1197 * Iterate across all objects attached to a rte_mempool and call the
1198 * callback function on it.
1201 * A pointer to an initialized mempool.
1203 * A function pointer that is called for each object.
1205 * An opaque pointer passed to the callback function.
1207 * Number of objects iterated.
1209 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1210 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1213 * Call a function for each mempool memory chunk
1215 * Iterate across all memory chunks attached to a rte_mempool and call
1216 * the callback function on it.
1219 * A pointer to an initialized mempool.
1221 * A function pointer that is called for each memory chunk.
1223 * An opaque pointer passed to the callback function.
1225 * Number of memory chunks iterated.
1227 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1228 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1231 * Dump the status of the mempool to a file.
1234 * A pointer to a file for output
1236 * A pointer to the mempool structure.
1238 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1241 * Create a user-owned mempool cache.
1243 * This can be used by unregistered non-EAL threads to enable caching when they
1244 * interact with a mempool.
1247 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1248 * parameter description for more information. The same limits and
1249 * considerations apply here too.
1251 * The socket identifier in the case of NUMA. The value can be
1252 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1254 struct rte_mempool_cache *
1255 rte_mempool_cache_create(uint32_t size, int socket_id);
1258 * Free a user-owned mempool cache.
1261 * A pointer to the mempool cache.
1264 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1267 * Get a pointer to the per-lcore default mempool cache.
1270 * A pointer to the mempool structure.
1272 * The logical core id.
1274 * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
1277 static __rte_always_inline struct rte_mempool_cache *
1278 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1280 if (mp->cache_size == 0)
1283 if (lcore_id >= RTE_MAX_LCORE)
1286 rte_mempool_trace_default_cache(mp, lcore_id,
1287 &mp->local_cache[lcore_id]);
1288 return &mp->local_cache[lcore_id];
1292 * Flush a user-owned mempool cache to the specified mempool.
1295 * A pointer to the mempool cache.
1297 * A pointer to the mempool.
1299 static __rte_always_inline void
1300 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1301 struct rte_mempool *mp)
1304 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1305 if (cache == NULL || cache->len == 0)
1307 rte_mempool_trace_cache_flush(cache, mp);
1308 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1313 * @internal Put several objects back in the mempool; used internally.
1315 * A pointer to the mempool structure.
1317 * A pointer to a table of void * pointers (objects).
1319 * The number of objects to store back in the mempool, must be strictly
1322 * A pointer to a mempool cache structure. May be NULL if not needed.
1324 static __rte_always_inline void
1325 rte_mempool_do_generic_put(struct rte_mempool *mp, void * const *obj_table,
1326 unsigned int n, struct rte_mempool_cache *cache)
1330 /* increment stat now, adding in mempool always success */
1331 RTE_MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1332 RTE_MEMPOOL_STAT_ADD(mp, put_objs, n);
1334 /* No cache provided or if put would overflow mem allocated for cache */
1335 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1338 cache_objs = &cache->objs[cache->len];
1341 * The cache follows the following algorithm
1342 * 1. Add the objects to the cache
1343 * 2. Anything greater than the cache min value (if it crosses the
1344 * cache flush threshold) is flushed to the ring.
1347 /* Add elements back into the cache */
1348 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1352 if (cache->len >= cache->flushthresh) {
1353 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1354 cache->len - cache->size);
1355 cache->len = cache->size;
1362 /* push remaining objects in ring */
1363 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1364 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1365 rte_panic("cannot put objects in mempool\n");
1367 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1373 * Put several objects back in the mempool.
1376 * A pointer to the mempool structure.
1378 * A pointer to a table of void * pointers (objects).
1380 * The number of objects to add in the mempool from the obj_table.
1382 * A pointer to a mempool cache structure. May be NULL if not needed.
1384 static __rte_always_inline void
1385 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1386 unsigned int n, struct rte_mempool_cache *cache)
1388 rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1389 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 0);
1390 rte_mempool_do_generic_put(mp, obj_table, n, cache);
1394 * Put several objects back in the mempool.
1396 * This function calls the multi-producer or the single-producer
1397 * version depending on the default behavior that was specified at
1398 * mempool creation time (see flags).
1401 * A pointer to the mempool structure.
1403 * A pointer to a table of void * pointers (objects).
1405 * The number of objects to add in the mempool from obj_table.
1407 static __rte_always_inline void
1408 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1411 struct rte_mempool_cache *cache;
1412 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1413 rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1414 rte_mempool_generic_put(mp, obj_table, n, cache);
1418 * Put one object back in the mempool.
1420 * This function calls the multi-producer or the single-producer
1421 * version depending on the default behavior that was specified at
1422 * mempool creation time (see flags).
1425 * A pointer to the mempool structure.
1427 * A pointer to the object to be added.
1429 static __rte_always_inline void
1430 rte_mempool_put(struct rte_mempool *mp, void *obj)
1432 rte_mempool_put_bulk(mp, &obj, 1);
1436 * @internal Get several objects from the mempool; used internally.
1438 * A pointer to the mempool structure.
1440 * A pointer to a table of void * pointers (objects).
1442 * The number of objects to get, must be strictly positive.
1444 * A pointer to a mempool cache structure. May be NULL if not needed.
1446 * - >=0: Success; number of objects supplied.
1447 * - <0: Error; code of ring dequeue function.
1449 static __rte_always_inline int
1450 rte_mempool_do_generic_get(struct rte_mempool *mp, void **obj_table,
1451 unsigned int n, struct rte_mempool_cache *cache)
1454 uint32_t index, len;
1457 /* No cache provided or cannot be satisfied from cache */
1458 if (unlikely(cache == NULL || n >= cache->size))
1461 cache_objs = cache->objs;
1463 /* Can this be satisfied from the cache? */
1464 if (cache->len < n) {
1465 /* No. Backfill the cache first, and then fill from it */
1466 uint32_t req = n + (cache->size - cache->len);
1468 /* How many do we require i.e. number to fill the cache + the request */
1469 ret = rte_mempool_ops_dequeue_bulk(mp,
1470 &cache->objs[cache->len], req);
1471 if (unlikely(ret < 0)) {
1473 * In the off chance that we are buffer constrained,
1474 * where we are not able to allocate cache + n, go to
1475 * the ring directly. If that fails, we are truly out of
1484 /* Now fill in the response ... */
1485 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1486 *obj_table = cache_objs[len];
1490 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1491 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1497 /* get remaining objects from ring */
1498 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1501 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1502 RTE_MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1504 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1505 RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1512 * Get several objects from the mempool.
1514 * If cache is enabled, objects will be retrieved first from cache,
1515 * subsequently from the common pool. Note that it can return -ENOENT when
1516 * the local cache and common pool are empty, even if cache from other
1520 * A pointer to the mempool structure.
1522 * A pointer to a table of void * pointers (objects) that will be filled.
1524 * The number of objects to get from mempool to obj_table.
1526 * A pointer to a mempool cache structure. May be NULL if not needed.
1528 * - 0: Success; objects taken.
1529 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1531 static __rte_always_inline int
1532 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1533 unsigned int n, struct rte_mempool_cache *cache)
1536 ret = rte_mempool_do_generic_get(mp, obj_table, n, cache);
1538 RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 1);
1539 rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1544 * Get several objects from the mempool.
1546 * This function calls the multi-consumers or the single-consumer
1547 * version, depending on the default behaviour that was specified at
1548 * mempool creation time (see flags).
1550 * If cache is enabled, objects will be retrieved first from cache,
1551 * subsequently from the common pool. Note that it can return -ENOENT when
1552 * the local cache and common pool are empty, even if cache from other
1556 * A pointer to the mempool structure.
1558 * A pointer to a table of void * pointers (objects) that will be filled.
1560 * The number of objects to get from the mempool to obj_table.
1562 * - 0: Success; objects taken
1563 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1565 static __rte_always_inline int
1566 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1568 struct rte_mempool_cache *cache;
1569 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1570 rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1571 return rte_mempool_generic_get(mp, obj_table, n, cache);
1575 * Get one object from the mempool.
1577 * This function calls the multi-consumers or the single-consumer
1578 * version, depending on the default behavior that was specified at
1579 * mempool creation (see flags).
1581 * If cache is enabled, objects will be retrieved first from cache,
1582 * subsequently from the common pool. Note that it can return -ENOENT when
1583 * the local cache and common pool are empty, even if cache from other
1587 * A pointer to the mempool structure.
1589 * A pointer to a void * pointer (object) that will be filled.
1591 * - 0: Success; objects taken.
1592 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1594 static __rte_always_inline int
1595 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1597 return rte_mempool_get_bulk(mp, obj_p, 1);
1601 * Get a contiguous blocks of objects from the mempool.
1603 * If cache is enabled, consider to flush it first, to reuse objects
1604 * as soon as possible.
1606 * The application should check that the driver supports the operation
1607 * by calling rte_mempool_ops_get_info() and checking that `contig_block_size`
1611 * A pointer to the mempool structure.
1612 * @param first_obj_table
1613 * A pointer to a pointer to the first object in each block.
1615 * The number of blocks to get from mempool.
1617 * - 0: Success; blocks taken.
1618 * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved.
1619 * - -EOPNOTSUPP: The mempool driver does not support block dequeue
1621 static __rte_always_inline int
1622 rte_mempool_get_contig_blocks(struct rte_mempool *mp,
1623 void **first_obj_table, unsigned int n)
1627 ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1629 RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1630 RTE_MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1631 RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table, n,
1634 RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1635 RTE_MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1638 rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1643 * Return the number of entries in the mempool.
1645 * When cache is enabled, this function has to browse the length of
1646 * all lcores, so it should not be used in a data path, but only for
1647 * debug purposes. User-owned mempool caches are not accounted for.
1650 * A pointer to the mempool structure.
1652 * The number of entries in the mempool.
1654 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1657 * Return the number of elements which have been allocated from the mempool
1659 * When cache is enabled, this function has to browse the length of
1660 * all lcores, so it should not be used in a data path, but only for
1664 * A pointer to the mempool structure.
1666 * The number of free entries in the mempool.
1669 rte_mempool_in_use_count(const struct rte_mempool *mp);
1672 * Test if the mempool is full.
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 full.
1682 * - 0: The mempool is not full.
1685 rte_mempool_full(const struct rte_mempool *mp)
1687 return rte_mempool_avail_count(mp) == mp->size;
1691 * Test if the mempool is empty.
1693 * When cache is enabled, this function has to browse the length of all
1694 * lcores, so it should not be used in a data path, but only for debug
1695 * purposes. User-owned mempool caches are not accounted for.
1698 * A pointer to the mempool structure.
1700 * - 1: The mempool is empty.
1701 * - 0: The mempool is not empty.
1704 rte_mempool_empty(const struct rte_mempool *mp)
1706 return rte_mempool_avail_count(mp) == 0;
1710 * Return the IO address of elt, which is an element of the pool mp.
1713 * A pointer (virtual address) to the element of the pool.
1715 * The IO address of the elt element.
1716 * If the mempool was created with RTE_MEMPOOL_F_NO_IOVA_CONTIG, the
1717 * returned value is RTE_BAD_IOVA.
1719 static inline rte_iova_t
1720 rte_mempool_virt2iova(const void *elt)
1722 const struct rte_mempool_objhdr *hdr;
1723 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1729 * Check the consistency of mempool objects.
1731 * Verify the coherency of fields in the mempool structure. Also check
1732 * that the cookies of mempool objects (even the ones that are not
1733 * present in pool) have a correct value. If not, a panic will occur.
1736 * A pointer to the mempool structure.
1738 void rte_mempool_audit(struct rte_mempool *mp);
1741 * Return a pointer to the private data in an mempool structure.
1744 * A pointer to the mempool structure.
1746 * A pointer to the private data.
1748 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1751 RTE_MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1755 * Dump the status of all mempools on the console
1758 * A pointer to a file for output
1760 void rte_mempool_list_dump(FILE *f);
1763 * Search a mempool from its name
1766 * The name of the mempool.
1768 * The pointer to the mempool matching the name, or NULL if not found.
1770 * with rte_errno set appropriately. Possible rte_errno values include:
1771 * - ENOENT - required entry not available to return.
1774 struct rte_mempool *rte_mempool_lookup(const char *name);
1777 * Get the header, trailer and total size of a mempool element.
1779 * Given a desired size of the mempool element and mempool flags,
1780 * calculates header, trailer, body and total sizes of the mempool object.
1783 * The size of each element, without header and trailer.
1785 * The flags used for the mempool creation.
1786 * Consult rte_mempool_create() for more information about possible values.
1787 * The size of each element.
1789 * The calculated detailed size the mempool object. May be NULL.
1791 * Total size of the mempool object.
1793 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1794 struct rte_mempool_objsz *sz);
1797 * Walk list of all memory pools
1802 * Argument passed to iterator
1804 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1808 * @internal Get page size used for mempool object allocation.
1809 * This function is internal to mempool library and mempool drivers.
1812 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1815 * Mempool event type.
1818 enum rte_mempool_event {
1819 /** Occurs after a mempool is fully populated. */
1820 RTE_MEMPOOL_EVENT_READY = 0,
1821 /** Occurs before the destruction of a mempool begins. */
1822 RTE_MEMPOOL_EVENT_DESTROY = 1,
1827 * Mempool event callback.
1829 * rte_mempool_event_callback_register() may be called from within the callback,
1830 * but the callbacks registered this way will not be invoked for the same event.
1831 * rte_mempool_event_callback_unregister() may only be safely called
1832 * to remove the running callback.
1834 typedef void (rte_mempool_event_callback)(
1835 enum rte_mempool_event event,
1836 struct rte_mempool *mp,
1841 * Register a callback function invoked on mempool life cycle event.
1842 * The function will be invoked in the process
1843 * that performs an action which triggers the callback.
1846 * Callback function.
1851 * 0 on success, negative on failure and rte_errno is set.
1855 rte_mempool_event_callback_register(rte_mempool_event_callback *func,
1860 * Unregister a callback added with rte_mempool_event_callback_register().
1861 * @p func and @p user_data must exactly match registration parameters.
1864 * Callback function.
1869 * 0 on success, negative on failure and rte_errno is set.
1873 rte_mempool_event_callback_unregister(rte_mempool_event_callback *func,
1880 #endif /* _RTE_MEMPOOL_H_ */