4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright(c) 2016 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #ifndef _RTE_MEMPOOL_H_
36 #define _RTE_MEMPOOL_H_
42 * A memory pool is an allocator of fixed-size object. It is
43 * identified by its name, and uses a ring to store free objects. It
44 * provides some other optional services, like a per-core object
45 * cache, and an alignment helper to ensure that objects are padded
46 * to spread them equally on all RAM channels, ranks, and so on.
48 * Objects owned by a mempool should never be added in another
49 * mempool. When an object is freed using rte_mempool_put() or
50 * equivalent, the object data is not modified; the user can save some
51 * meta-data in the object data and retrieve them when allocating a
54 * Note: the mempool implementation is not preemptable. A lcore must
55 * not be interrupted by another task that uses the same mempool
56 * (because it uses a ring which is not preemptable). Also, mempool
57 * functions must not be used outside the DPDK environment: for
58 * example, in linuxapp environment, a thread that is not created by
59 * the EAL must not use mempools. This is due to the per-lcore cache
60 * that won't work as rte_lcore_id() will not return a correct value.
68 #include <sys/queue.h>
70 #include <rte_spinlock.h>
72 #include <rte_debug.h>
73 #include <rte_lcore.h>
74 #include <rte_memory.h>
75 #include <rte_branch_prediction.h>
77 #include <rte_memcpy.h>
83 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
84 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
85 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
87 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
89 * A structure that stores the mempool statistics (per-lcore).
91 struct rte_mempool_debug_stats {
92 uint64_t put_bulk; /**< Number of puts. */
93 uint64_t put_objs; /**< Number of objects successfully put. */
94 uint64_t get_success_bulk; /**< Successful allocation number. */
95 uint64_t get_success_objs; /**< Objects successfully allocated. */
96 uint64_t get_fail_bulk; /**< Failed allocation number. */
97 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
98 } __rte_cache_aligned;
102 * A structure that stores a per-core object cache.
104 struct rte_mempool_cache {
105 uint32_t size; /**< Size of the cache */
106 uint32_t flushthresh; /**< Threshold before we flush excess elements */
107 uint32_t len; /**< Current cache count */
109 * Cache is allocated to this size to allow it to overflow in certain
110 * cases to avoid needless emptying of cache.
112 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
113 } __rte_cache_aligned;
116 * A structure that stores the size of mempool elements.
118 struct rte_mempool_objsz {
119 uint32_t elt_size; /**< Size of an element. */
120 uint32_t header_size; /**< Size of header (before elt). */
121 uint32_t trailer_size; /**< Size of trailer (after elt). */
123 /**< Total size of an object (header + elt + trailer). */
126 #define RTE_MEMPOOL_NAMESIZE 32 /**< Maximum length of a memory pool. */
127 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
130 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
132 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
134 /** Mempool over one chunk of physically continuous memory */
135 #define MEMPOOL_PG_NUM_DEFAULT 1
137 #ifndef RTE_MEMPOOL_ALIGN
138 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
141 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
144 * Mempool object header structure
146 * Each object stored in mempools are prefixed by this header structure,
147 * it allows to retrieve the mempool pointer from the object and to
148 * iterate on all objects attached to a mempool. When debug is enabled,
149 * a cookie is also added in this structure preventing corruptions and
152 struct rte_mempool_objhdr {
153 STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
154 struct rte_mempool *mp; /**< The mempool owning the object. */
155 phys_addr_t physaddr; /**< Physical address of the object. */
156 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
157 uint64_t cookie; /**< Debug cookie. */
162 * A list of object headers type
164 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
167 * Mempool object trailer structure
169 * In debug mode, each object stored in mempools are suffixed by this
170 * trailer structure containing a cookie preventing memory corruptions.
172 struct rte_mempool_objtlr {
173 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
174 uint64_t cookie; /**< Debug cookie. */
179 * A list of memory where objects are stored
181 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
184 * Callback used to free a memory chunk
186 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
190 * Mempool objects memory header structure
192 * The memory chunks where objects are stored. Each chunk is virtually
193 * and physically contiguous.
195 struct rte_mempool_memhdr {
196 STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
197 struct rte_mempool *mp; /**< The mempool owning the chunk */
198 void *addr; /**< Virtual address of the chunk */
199 phys_addr_t phys_addr; /**< Physical address of the chunk */
200 size_t len; /**< length of the chunk */
201 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
202 void *opaque; /**< Argument passed to the free callback */
206 * The RTE mempool structure.
209 char name[RTE_MEMPOOL_NAMESIZE]; /**< Name of mempool. */
211 void *pool_data; /**< Ring or pool to store objects. */
212 uint64_t pool_id; /**< External mempool identifier. */
214 void *pool_config; /**< optional args for ops alloc. */
215 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
216 int flags; /**< Flags of the mempool. */
217 int socket_id; /**< Socket id passed at create. */
218 uint32_t size; /**< Max size of the mempool. */
220 /**< Size of per-lcore default local cache. */
222 uint32_t elt_size; /**< Size of an element. */
223 uint32_t header_size; /**< Size of header (before elt). */
224 uint32_t trailer_size; /**< Size of trailer (after elt). */
226 unsigned private_data_size; /**< Size of private data. */
228 * Index into rte_mempool_ops_table array of mempool ops
229 * structs, which contain callback function pointers.
230 * We're using an index here rather than pointers to the callbacks
231 * to facilitate any secondary processes that may want to use
236 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
238 uint32_t populated_size; /**< Number of populated objects. */
239 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
240 uint32_t nb_mem_chunks; /**< Number of memory chunks */
241 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
243 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
244 /** Per-lcore statistics. */
245 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
247 } __rte_cache_aligned;
249 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread among memory channels. */
250 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
251 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
252 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
253 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
254 #define MEMPOOL_F_NO_PHYS_CONTIG 0x0020 /**< Don't need physically contiguous objs. */
257 * @internal When debug is enabled, store some statistics.
260 * Pointer to the memory pool.
262 * Name of the statistics field to increment in the memory pool.
264 * Number to add to the object-oriented statistics.
266 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
267 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
268 unsigned __lcore_id = rte_lcore_id(); \
269 if (__lcore_id < RTE_MAX_LCORE) { \
270 mp->stats[__lcore_id].name##_objs += n; \
271 mp->stats[__lcore_id].name##_bulk += 1; \
275 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
279 * Calculate the size of the mempool header.
282 * Pointer to the memory pool.
284 * Size of the per-lcore cache.
286 #define MEMPOOL_HEADER_SIZE(mp, cs) \
287 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
288 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
290 /* return the header of a mempool object (internal) */
291 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
293 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
294 sizeof(struct rte_mempool_objhdr));
298 * Return a pointer to the mempool owning this object.
301 * An object that is owned by a pool. If this is not the case,
302 * the behavior is undefined.
304 * A pointer to the mempool structure.
306 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
308 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
312 /* return the trailer of a mempool object (internal) */
313 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
315 struct rte_mempool *mp = rte_mempool_from_obj(obj);
316 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
320 * @internal Check and update cookies or panic.
323 * Pointer to the memory pool.
324 * @param obj_table_const
325 * Pointer to a table of void * pointers (objects).
327 * Index of object in object table.
329 * - 0: object is supposed to be allocated, mark it as free
330 * - 1: object is supposed to be free, mark it as allocated
331 * - 2: just check that cookie is valid (free or allocated)
333 void rte_mempool_check_cookies(const struct rte_mempool *mp,
334 void * const *obj_table_const, unsigned n, int free);
336 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
337 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
338 rte_mempool_check_cookies(mp, obj_table_const, n, free)
340 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
341 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
343 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
346 * Prototype for implementation specific data provisioning function.
348 * The function should provide the implementation specific memory for
349 * for use by the other mempool ops functions in a given mempool ops struct.
350 * E.g. the default ops provides an instance of the rte_ring for this purpose.
351 * it will most likely point to a different type of data structure, and
352 * will be transparent to the application programmer.
353 * This function should set mp->pool_data.
355 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
358 * Free the opaque private data pointed to by mp->pool_data pointer.
360 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
363 * Enqueue an object into the external pool.
365 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
366 void * const *obj_table, unsigned int n);
369 * Dequeue an object from the external pool.
371 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
372 void **obj_table, unsigned int n);
375 * Return the number of available objects in the external pool.
377 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
379 /** Structure defining mempool operations structure */
380 struct rte_mempool_ops {
381 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
382 rte_mempool_alloc_t alloc; /**< Allocate private data. */
383 rte_mempool_free_t free; /**< Free the external pool. */
384 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
385 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
386 rte_mempool_get_count get_count; /**< Get qty of available objs. */
387 } __rte_cache_aligned;
389 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
392 * Structure storing the table of registered ops structs, each of which contain
393 * the function pointers for the mempool ops functions.
394 * Each process has its own storage for this ops struct array so that
395 * the mempools can be shared across primary and secondary processes.
396 * The indices used to access the array are valid across processes, whereas
397 * any function pointers stored directly in the mempool struct would not be.
398 * This results in us simply having "ops_index" in the mempool struct.
400 struct rte_mempool_ops_table {
401 rte_spinlock_t sl; /**< Spinlock for add/delete. */
402 uint32_t num_ops; /**< Number of used ops structs in the table. */
404 * Storage for all possible ops structs.
406 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
407 } __rte_cache_aligned;
409 /** Array of registered ops structs. */
410 extern struct rte_mempool_ops_table rte_mempool_ops_table;
413 * @internal Get the mempool ops struct from its index.
416 * The index of the ops struct in the ops struct table. It must be a valid
417 * index: (0 <= idx < num_ops).
419 * The pointer to the ops struct in the table.
421 static inline struct rte_mempool_ops *
422 rte_mempool_get_ops(int ops_index)
424 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
426 return &rte_mempool_ops_table.ops[ops_index];
430 * @internal Wrapper for mempool_ops alloc callback.
433 * Pointer to the memory pool.
435 * - 0: Success; successfully allocated mempool pool_data.
436 * - <0: Error; code of alloc function.
439 rte_mempool_ops_alloc(struct rte_mempool *mp);
442 * @internal Wrapper for mempool_ops dequeue callback.
445 * Pointer to the memory pool.
447 * Pointer to a table of void * pointers (objects).
449 * Number of objects to get.
451 * - 0: Success; got n objects.
452 * - <0: Error; code of dequeue function.
455 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
456 void **obj_table, unsigned n)
458 struct rte_mempool_ops *ops;
460 ops = rte_mempool_get_ops(mp->ops_index);
461 return ops->dequeue(mp, obj_table, n);
465 * @internal wrapper for mempool_ops enqueue callback.
468 * Pointer to the memory pool.
470 * Pointer to a table of void * pointers (objects).
472 * Number of objects to put.
474 * - 0: Success; n objects supplied.
475 * - <0: Error; code of enqueue function.
478 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
481 struct rte_mempool_ops *ops;
483 ops = rte_mempool_get_ops(mp->ops_index);
484 return ops->enqueue(mp, obj_table, n);
488 * @internal wrapper for mempool_ops get_count callback.
491 * Pointer to the memory pool.
493 * The number of available objects in the external pool.
496 rte_mempool_ops_get_count(const struct rte_mempool *mp);
499 * @internal wrapper for mempool_ops free callback.
502 * Pointer to the memory pool.
505 rte_mempool_ops_free(struct rte_mempool *mp);
508 * Set the ops of a mempool.
510 * This can only be done on a mempool that is not populated, i.e. just after
511 * a call to rte_mempool_create_empty().
514 * Pointer to the memory pool.
516 * Name of the ops structure to use for this mempool.
518 * Opaque data that can be passed by the application to the ops functions.
520 * - 0: Success; the mempool is now using the requested ops functions.
521 * - -EINVAL - Invalid ops struct name provided.
522 * - -EEXIST - mempool already has an ops struct assigned.
525 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
529 * Register mempool operations.
532 * Pointer to an ops structure to register.
534 * - >=0: Success; return the index of the ops struct in the table.
535 * - -EINVAL - some missing callbacks while registering ops struct.
536 * - -ENOSPC - the maximum number of ops structs has been reached.
538 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
541 * Macro to statically register the ops of a mempool handler.
542 * Note that the rte_mempool_register_ops fails silently here when
543 * more then RTE_MEMPOOL_MAX_OPS_IDX is registered.
545 #define MEMPOOL_REGISTER_OPS(ops) \
546 void mp_hdlr_init_##ops(void); \
547 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
549 rte_mempool_register_ops(&ops); \
553 * An object callback function for mempool.
555 * Used by rte_mempool_create() and rte_mempool_obj_iter().
557 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
558 void *opaque, void *obj, unsigned obj_idx);
559 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
562 * A memory callback function for mempool.
564 * Used by rte_mempool_mem_iter().
566 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
567 void *opaque, struct rte_mempool_memhdr *memhdr,
571 * A mempool constructor callback function.
573 * Arguments are the mempool and the opaque pointer given by the user in
574 * rte_mempool_create().
576 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
579 * Create a new mempool named *name* in memory.
581 * This function uses ``memzone_reserve()`` to allocate memory. The
582 * pool contains n elements of elt_size. Its size is set to n.
583 * All elements of the mempool are allocated together with the mempool header,
584 * in one physically continuous chunk of memory.
587 * The name of the mempool.
589 * The number of elements in the mempool. The optimum size (in terms of
590 * memory usage) for a mempool is when n is a power of two minus one:
593 * The size of each element.
595 * If cache_size is non-zero, the rte_mempool library will try to
596 * limit the accesses to the common lockless pool, by maintaining a
597 * per-lcore object cache. This argument must be lower or equal to
598 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
599 * cache_size to have "n modulo cache_size == 0": if this is
600 * not the case, some elements will always stay in the pool and will
601 * never be used. The access to the per-lcore table is of course
602 * faster than the multi-producer/consumer pool. The cache can be
603 * disabled if the cache_size argument is set to 0; it can be useful to
604 * avoid losing objects in cache. Note that even if not used, the
605 * memory space for cache is always reserved in a mempool structure,
606 * except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
607 * @param private_data_size
608 * The size of the private data appended after the mempool
609 * structure. This is useful for storing some private data after the
610 * mempool structure, as is done for rte_mbuf_pool for example.
612 * A function pointer that is called for initialization of the pool,
613 * before object initialization. The user can initialize the private
614 * data in this function if needed. This parameter can be NULL if
617 * An opaque pointer to data that can be used in the mempool
618 * constructor function.
620 * A function pointer that is called for each object at
621 * initialization of the pool. The user can set some meta data in
622 * objects if needed. This parameter can be NULL if not needed.
623 * The obj_init() function takes the mempool pointer, the init_arg,
624 * the object pointer and the object number as parameters.
625 * @param obj_init_arg
626 * An opaque pointer to data that can be used as an argument for
627 * each call to the object constructor function.
629 * The *socket_id* argument is the socket identifier in the case of
630 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
631 * constraint for the reserved zone.
633 * The *flags* arguments is an OR of following flags:
634 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
635 * between channels in RAM: the pool allocator will add padding
636 * between objects depending on the hardware configuration. See
637 * Memory alignment constraints for details. If this flag is set,
638 * the allocator will just align them to a cache line.
639 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
640 * cache-aligned. This flag removes this constraint, and no
641 * padding will be present between objects. This flag implies
642 * MEMPOOL_F_NO_SPREAD.
643 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
644 * when using rte_mempool_put() or rte_mempool_put_bulk() is
645 * "single-producer". Otherwise, it is "multi-producers".
646 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
647 * when using rte_mempool_get() or rte_mempool_get_bulk() is
648 * "single-consumer". Otherwise, it is "multi-consumers".
649 * - MEMPOOL_F_NO_PHYS_CONTIG: If set, allocated objects won't
650 * necessarilly be contiguous in physical memory.
652 * The pointer to the new allocated mempool, on success. NULL on error
653 * with rte_errno set appropriately. Possible rte_errno values include:
654 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
655 * - E_RTE_SECONDARY - function was called from a secondary process instance
656 * - EINVAL - cache size provided is too large
657 * - ENOSPC - the maximum number of memzones has already been allocated
658 * - EEXIST - a memzone with the same name already exists
659 * - ENOMEM - no appropriate memory area found in which to create memzone
662 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
663 unsigned cache_size, unsigned private_data_size,
664 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
665 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
666 int socket_id, unsigned flags);
669 * Create a new mempool named *name* in memory.
671 * The pool contains n elements of elt_size. Its size is set to n.
672 * This function uses ``memzone_reserve()`` to allocate the mempool header
673 * (and the objects if vaddr is NULL).
674 * Depending on the input parameters, mempool elements can be either allocated
675 * together with the mempool header, or an externally provided memory buffer
676 * could be used to store mempool objects. In later case, that external
677 * memory buffer can consist of set of disjoint physical pages.
680 * The name of the mempool.
682 * The number of elements in the mempool. The optimum size (in terms of
683 * memory usage) for a mempool is when n is a power of two minus one:
686 * The size of each element.
688 * Size of the cache. See rte_mempool_create() for details.
689 * @param private_data_size
690 * The size of the private data appended after the mempool
691 * structure. This is useful for storing some private data after the
692 * mempool structure, as is done for rte_mbuf_pool for example.
694 * A function pointer that is called for initialization of the pool,
695 * before object initialization. The user can initialize the private
696 * data in this function if needed. This parameter can be NULL if
699 * An opaque pointer to data that can be used in the mempool
700 * constructor function.
702 * A function called for each object at initialization of the pool.
703 * See rte_mempool_create() for details.
704 * @param obj_init_arg
705 * An opaque pointer passed to the object constructor function.
707 * The *socket_id* argument is the socket identifier in the case of
708 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
709 * constraint for the reserved zone.
711 * Flags controlling the behavior of the mempool. See
712 * rte_mempool_create() for details.
714 * Virtual address of the externally allocated memory buffer.
715 * Will be used to store mempool objects.
717 * Array of physical addresses of the pages that comprises given memory
720 * Number of elements in the paddr array.
722 * LOG2 of the physical pages size.
724 * The pointer to the new allocated mempool, on success. NULL on error
725 * with rte_errno set appropriately. See rte_mempool_create() for details.
728 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
729 unsigned cache_size, unsigned private_data_size,
730 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
731 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
732 int socket_id, unsigned flags, void *vaddr,
733 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift);
736 * Create an empty mempool
738 * The mempool is allocated and initialized, but it is not populated: no
739 * memory is allocated for the mempool elements. The user has to call
740 * rte_mempool_populate_*() or to add memory chunks to the pool. Once
741 * populated, the user may also want to initialize each object with
742 * rte_mempool_obj_iter().
745 * The name of the mempool.
747 * The maximum number of elements that can be added in the mempool.
748 * The optimum size (in terms of memory usage) for a mempool is when n
749 * is a power of two minus one: n = (2^q - 1).
751 * The size of each element.
753 * Size of the cache. See rte_mempool_create() for details.
754 * @param private_data_size
755 * The size of the private data appended after the mempool
756 * structure. This is useful for storing some private data after the
757 * mempool structure, as is done for rte_mbuf_pool for example.
759 * The *socket_id* argument is the socket identifier in the case of
760 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
761 * constraint for the reserved zone.
763 * Flags controlling the behavior of the mempool. See
764 * rte_mempool_create() for details.
766 * The pointer to the new allocated mempool, on success. NULL on error
767 * with rte_errno set appropriately. See rte_mempool_create() for details.
770 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
771 unsigned cache_size, unsigned private_data_size,
772 int socket_id, unsigned flags);
776 * Unlink the mempool from global list, free the memory chunks, and all
777 * memory referenced by the mempool. The objects must not be used by
778 * other cores as they will be freed.
781 * A pointer to the mempool structure.
784 rte_mempool_free(struct rte_mempool *mp);
787 * Add physically contiguous memory for objects in the pool at init
789 * Add a virtually and physically contiguous memory chunk in the pool
790 * where objects can be instanciated.
793 * A pointer to the mempool structure.
795 * The virtual address of memory that should be used to store objects.
797 * The physical address
799 * The length of memory in bytes.
801 * The callback used to free this chunk when destroying the mempool.
803 * An opaque argument passed to free_cb.
805 * The number of objects added on success.
806 * On error, the chunk is not added in the memory list of the
807 * mempool and a negative errno is returned.
809 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
810 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
814 * Add physical memory for objects in the pool at init
816 * Add a virtually contiguous memory chunk in the pool where objects can
817 * be instanciated. The physical addresses corresponding to the virtual
818 * area are described in paddr[], pg_num, pg_shift.
821 * A pointer to the mempool structure.
823 * The virtual address of memory that should be used to store objects.
825 * An array of physical addresses of each page composing the virtual
828 * Number of elements in the paddr array.
830 * LOG2 of the physical pages size.
832 * The callback used to free this chunk when destroying the mempool.
834 * An opaque argument passed to free_cb.
836 * The number of objects added on success.
837 * On error, the chunks are not added in the memory list of the
838 * mempool and a negative errno is returned.
840 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
841 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
842 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
845 * Add virtually contiguous memory for objects in the pool at init
847 * Add a virtually contiguous memory chunk in the pool where objects can
851 * A pointer to the mempool structure.
853 * The virtual address of memory that should be used to store objects.
854 * Must be page-aligned.
856 * The length of memory in bytes. Must be page-aligned.
858 * The size of memory pages in this virtual area.
860 * The callback used to free this chunk when destroying the mempool.
862 * An opaque argument passed to free_cb.
864 * The number of objects added on success.
865 * On error, the chunk is not added in the memory list of the
866 * mempool and a negative errno is returned.
869 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
870 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
874 * Add memory for objects in the pool at init
876 * This is the default function used by rte_mempool_create() to populate
877 * the mempool. It adds memory allocated using rte_memzone_reserve().
880 * A pointer to the mempool structure.
882 * The number of objects added on success.
883 * On error, the chunk is not added in the memory list of the
884 * mempool and a negative errno is returned.
886 int rte_mempool_populate_default(struct rte_mempool *mp);
889 * Add memory from anonymous mapping for objects in the pool at init
891 * This function mmap an anonymous memory zone that is locked in
892 * memory to store the objects of the mempool.
895 * A pointer to the mempool structure.
897 * The number of objects added on success.
898 * On error, the chunk is not added in the memory list of the
899 * mempool and a negative errno is returned.
901 int rte_mempool_populate_anon(struct rte_mempool *mp);
904 * Call a function for each mempool element
906 * Iterate across all objects attached to a rte_mempool and call the
907 * callback function on it.
910 * A pointer to an initialized mempool.
912 * A function pointer that is called for each object.
914 * An opaque pointer passed to the callback function.
916 * Number of objects iterated.
918 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
919 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
922 * Call a function for each mempool memory chunk
924 * Iterate across all memory chunks attached to a rte_mempool and call
925 * the callback function on it.
928 * A pointer to an initialized mempool.
930 * A function pointer that is called for each memory chunk.
932 * An opaque pointer passed to the callback function.
934 * Number of memory chunks iterated.
936 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
937 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
940 * Dump the status of the mempool to the console.
943 * A pointer to a file for output
945 * A pointer to the mempool structure.
947 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
950 * Create a user-owned mempool cache.
952 * This can be used by non-EAL threads to enable caching when they
953 * interact with a mempool.
956 * The size of the mempool cache. See rte_mempool_create()'s cache_size
957 * parameter description for more information. The same limits and
958 * considerations apply here too.
960 * The socket identifier in the case of NUMA. The value can be
961 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
963 struct rte_mempool_cache *
964 rte_mempool_cache_create(uint32_t size, int socket_id);
967 * Free a user-owned mempool cache.
970 * A pointer to the mempool cache.
973 rte_mempool_cache_free(struct rte_mempool_cache *cache);
976 * Flush a user-owned mempool cache to the specified mempool.
979 * A pointer to the mempool cache.
981 * A pointer to the mempool.
983 static inline void __attribute__((always_inline))
984 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
985 struct rte_mempool *mp)
987 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
992 * Get a pointer to the per-lcore default mempool cache.
995 * A pointer to the mempool structure.
997 * The logical core id.
999 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1001 static inline struct rte_mempool_cache *__attribute__((always_inline))
1002 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1004 if (mp->cache_size == 0)
1007 if (lcore_id >= RTE_MAX_LCORE)
1010 return &mp->local_cache[lcore_id];
1014 * @internal Put several objects back in the mempool; used internally.
1016 * A pointer to the mempool structure.
1018 * A pointer to a table of void * pointers (objects).
1020 * The number of objects to store back in the mempool, must be strictly
1023 * A pointer to a mempool cache structure. May be NULL if not needed.
1025 * The flags used for the mempool creation.
1026 * Single-producer (MEMPOOL_F_SP_PUT flag) or multi-producers.
1028 static inline void __attribute__((always_inline))
1029 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1030 unsigned n, struct rte_mempool_cache *cache, int flags)
1034 /* increment stat now, adding in mempool always success */
1035 __MEMPOOL_STAT_ADD(mp, put, n);
1037 /* No cache provided or single producer */
1038 if (unlikely(cache == NULL || flags & MEMPOOL_F_SP_PUT))
1041 /* Go straight to ring if put would overflow mem allocated for cache */
1042 if (unlikely(n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1045 cache_objs = &cache->objs[cache->len];
1048 * The cache follows the following algorithm
1049 * 1. Add the objects to the cache
1050 * 2. Anything greater than the cache min value (if it crosses the
1051 * cache flush threshold) is flushed to the ring.
1054 /* Add elements back into the cache */
1055 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1059 if (cache->len >= cache->flushthresh) {
1060 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1061 cache->len - cache->size);
1062 cache->len = cache->size;
1069 /* push remaining objects in ring */
1070 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1071 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1072 rte_panic("cannot put objects in mempool\n");
1074 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1080 * Put several objects back in the mempool.
1083 * A pointer to the mempool structure.
1085 * A pointer to a table of void * pointers (objects).
1087 * The number of objects to add in the mempool from the obj_table.
1089 * A pointer to a mempool cache structure. May be NULL if not needed.
1091 * The flags used for the mempool creation.
1092 * Single-producer (MEMPOOL_F_SP_PUT flag) or multi-producers.
1094 static inline void __attribute__((always_inline))
1095 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1096 unsigned n, struct rte_mempool_cache *cache, int flags)
1098 __mempool_check_cookies(mp, obj_table, n, 0);
1099 __mempool_generic_put(mp, obj_table, n, cache, flags);
1104 * Put several objects back in the mempool (multi-producers safe).
1107 * A pointer to the mempool structure.
1109 * A pointer to a table of void * pointers (objects).
1111 * The number of objects to add in the mempool from the obj_table.
1114 static inline void __attribute__((always_inline))
1115 rte_mempool_mp_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1118 struct rte_mempool_cache *cache;
1119 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1120 rte_mempool_generic_put(mp, obj_table, n, cache, 0);
1125 * Put several objects back in the mempool (NOT multi-producers safe).
1128 * A pointer to the mempool structure.
1130 * A pointer to a table of void * pointers (objects).
1132 * The number of objects to add in the mempool from obj_table.
1135 static inline void __attribute__((always_inline))
1136 rte_mempool_sp_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1139 rte_mempool_generic_put(mp, obj_table, n, NULL, MEMPOOL_F_SP_PUT);
1143 * Put several objects back in the mempool.
1145 * This function calls the multi-producer or the single-producer
1146 * version depending on the default behavior that was specified at
1147 * mempool creation time (see flags).
1150 * A pointer to the mempool structure.
1152 * A pointer to a table of void * pointers (objects).
1154 * The number of objects to add in the mempool from obj_table.
1156 static inline void __attribute__((always_inline))
1157 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1160 struct rte_mempool_cache *cache;
1161 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1162 rte_mempool_generic_put(mp, obj_table, n, cache, mp->flags);
1167 * Put one object in the mempool (multi-producers safe).
1170 * A pointer to the mempool structure.
1172 * A pointer to the object to be added.
1175 static inline void __attribute__((always_inline))
1176 rte_mempool_mp_put(struct rte_mempool *mp, void *obj)
1178 struct rte_mempool_cache *cache;
1179 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1180 rte_mempool_generic_put(mp, &obj, 1, cache, 0);
1185 * Put one object back in the mempool (NOT multi-producers safe).
1188 * A pointer to the mempool structure.
1190 * A pointer to the object to be added.
1193 static inline void __attribute__((always_inline))
1194 rte_mempool_sp_put(struct rte_mempool *mp, void *obj)
1196 rte_mempool_generic_put(mp, &obj, 1, NULL, MEMPOOL_F_SP_PUT);
1200 * Put one object back in the mempool.
1202 * This function calls the multi-producer or the single-producer
1203 * version depending on the default behavior that was specified at
1204 * mempool creation time (see flags).
1207 * A pointer to the mempool structure.
1209 * A pointer to the object to be added.
1211 static inline void __attribute__((always_inline))
1212 rte_mempool_put(struct rte_mempool *mp, void *obj)
1214 rte_mempool_put_bulk(mp, &obj, 1);
1218 * @internal Get several objects from the mempool; used internally.
1220 * A pointer to the mempool structure.
1222 * A pointer to a table of void * pointers (objects).
1224 * The number of objects to get, must be strictly positive.
1226 * A pointer to a mempool cache structure. May be NULL if not needed.
1228 * The flags used for the mempool creation.
1229 * Single-consumer (MEMPOOL_F_SC_GET flag) or multi-consumers.
1231 * - >=0: Success; number of objects supplied.
1232 * - <0: Error; code of ring dequeue function.
1234 static inline int __attribute__((always_inline))
1235 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1236 unsigned n, struct rte_mempool_cache *cache, int flags)
1239 uint32_t index, len;
1242 /* No cache provided or single consumer */
1243 if (unlikely(cache == NULL || flags & MEMPOOL_F_SC_GET ||
1247 cache_objs = cache->objs;
1249 /* Can this be satisfied from the cache? */
1250 if (cache->len < n) {
1251 /* No. Backfill the cache first, and then fill from it */
1252 uint32_t req = n + (cache->size - cache->len);
1254 /* How many do we require i.e. number to fill the cache + the request */
1255 ret = rte_mempool_ops_dequeue_bulk(mp,
1256 &cache->objs[cache->len], req);
1257 if (unlikely(ret < 0)) {
1259 * In the offchance that we are buffer constrained,
1260 * where we are not able to allocate cache + n, go to
1261 * the ring directly. If that fails, we are truly out of
1270 /* Now fill in the response ... */
1271 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1272 *obj_table = cache_objs[len];
1276 __MEMPOOL_STAT_ADD(mp, get_success, n);
1282 /* get remaining objects from ring */
1283 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1286 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1288 __MEMPOOL_STAT_ADD(mp, get_success, n);
1294 * Get several objects from the mempool.
1296 * If cache is enabled, objects will be retrieved first from cache,
1297 * subsequently from the common pool. Note that it can return -ENOENT when
1298 * the local cache and common pool are empty, even if cache from other
1302 * A pointer to the mempool structure.
1304 * A pointer to a table of void * pointers (objects) that will be filled.
1306 * The number of objects to get from mempool to obj_table.
1308 * A pointer to a mempool cache structure. May be NULL if not needed.
1310 * The flags used for the mempool creation.
1311 * Single-consumer (MEMPOOL_F_SC_GET flag) or multi-consumers.
1313 * - 0: Success; objects taken.
1314 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1316 static inline int __attribute__((always_inline))
1317 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table, unsigned n,
1318 struct rte_mempool_cache *cache, int flags)
1321 ret = __mempool_generic_get(mp, obj_table, n, cache, flags);
1323 __mempool_check_cookies(mp, obj_table, n, 1);
1329 * Get several objects from the mempool (multi-consumers safe).
1331 * If cache is enabled, objects will be retrieved first from cache,
1332 * subsequently from the common pool. Note that it can return -ENOENT when
1333 * the local cache and common pool are empty, even if cache from other
1337 * A pointer to the mempool structure.
1339 * A pointer to a table of void * pointers (objects) that will be filled.
1341 * The number of objects to get from mempool to obj_table.
1343 * - 0: Success; objects taken.
1344 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1347 static inline int __attribute__((always_inline))
1348 rte_mempool_mc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1350 struct rte_mempool_cache *cache;
1351 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1352 return rte_mempool_generic_get(mp, obj_table, n, cache, 0);
1357 * Get several objects from the mempool (NOT multi-consumers safe).
1359 * If cache is enabled, objects will be retrieved first from cache,
1360 * subsequently from the common pool. Note that it can return -ENOENT when
1361 * the local cache and common pool are empty, even if cache from other
1365 * A pointer to the mempool structure.
1367 * A pointer to a table of void * pointers (objects) that will be filled.
1369 * The number of objects to get from the mempool to obj_table.
1371 * - 0: Success; objects taken.
1372 * - -ENOENT: Not enough entries in the mempool; no object is
1376 static inline int __attribute__((always_inline))
1377 rte_mempool_sc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1379 return rte_mempool_generic_get(mp, obj_table, n, NULL,
1384 * Get several objects from the mempool.
1386 * This function calls the multi-consumers or the single-consumer
1387 * version, depending on the default behaviour that was specified at
1388 * mempool creation time (see flags).
1390 * If cache is enabled, objects will be retrieved first from cache,
1391 * subsequently from the common pool. Note that it can return -ENOENT when
1392 * the local cache and common pool are empty, even if cache from other
1396 * A pointer to the mempool structure.
1398 * A pointer to a table of void * pointers (objects) that will be filled.
1400 * The number of objects to get from the mempool to obj_table.
1402 * - 0: Success; objects taken
1403 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1405 static inline int __attribute__((always_inline))
1406 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1408 struct rte_mempool_cache *cache;
1409 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1410 return rte_mempool_generic_get(mp, obj_table, n, cache, mp->flags);
1415 * Get one object from the mempool (multi-consumers safe).
1417 * If cache is enabled, objects will be retrieved first from cache,
1418 * subsequently from the common pool. Note that it can return -ENOENT when
1419 * the local cache and common pool are empty, even if cache from other
1423 * A pointer to the mempool structure.
1425 * A pointer to a void * pointer (object) that will be filled.
1427 * - 0: Success; objects taken.
1428 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1431 static inline int __attribute__((always_inline))
1432 rte_mempool_mc_get(struct rte_mempool *mp, void **obj_p)
1434 struct rte_mempool_cache *cache;
1435 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1436 return rte_mempool_generic_get(mp, obj_p, 1, cache, 0);
1441 * Get one object from the mempool (NOT multi-consumers safe).
1443 * If cache is enabled, objects will be retrieved first from cache,
1444 * subsequently from the common pool. Note that it can return -ENOENT when
1445 * the local cache and common pool are empty, even if cache from other
1449 * A pointer to the mempool structure.
1451 * A pointer to a void * pointer (object) that will be filled.
1453 * - 0: Success; objects taken.
1454 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1457 static inline int __attribute__((always_inline))
1458 rte_mempool_sc_get(struct rte_mempool *mp, void **obj_p)
1460 return rte_mempool_generic_get(mp, obj_p, 1, NULL, MEMPOOL_F_SC_GET);
1464 * Get one object from the mempool.
1466 * This function calls the multi-consumers or the single-consumer
1467 * version, depending on the default behavior that was specified at
1468 * mempool creation (see flags).
1470 * If cache is enabled, objects will be retrieved first from cache,
1471 * subsequently from the common pool. Note that it can return -ENOENT when
1472 * the local cache and common pool are empty, even if cache from other
1476 * A pointer to the mempool structure.
1478 * A pointer to a void * pointer (object) that will be filled.
1480 * - 0: Success; objects taken.
1481 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1483 static inline int __attribute__((always_inline))
1484 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1486 return rte_mempool_get_bulk(mp, obj_p, 1);
1490 * Return the number of entries in the mempool.
1492 * When cache is enabled, this function has to browse the length of
1493 * all lcores, so it should not be used in a data path, but only for
1494 * debug purposes. User-owned mempool caches are not accounted for.
1497 * A pointer to the mempool structure.
1499 * The number of entries in the mempool.
1501 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1505 * Return the number of entries in the mempool.
1507 * When cache is enabled, this function has to browse the length of
1508 * all lcores, so it should not be used in a data path, but only for
1512 * A pointer to the mempool structure.
1514 * The number of entries in the mempool.
1517 unsigned rte_mempool_count(const struct rte_mempool *mp);
1520 * Return the number of elements which have been allocated from the mempool
1522 * When cache is enabled, this function has to browse the length of
1523 * all lcores, so it should not be used in a data path, but only for
1527 * A pointer to the mempool structure.
1529 * The number of free entries in the mempool.
1532 rte_mempool_in_use_count(const struct rte_mempool *mp);
1536 * Return the number of free entries in the mempool ring.
1537 * i.e. how many entries can be freed back to the mempool.
1539 * NOTE: This corresponds to the number of elements *allocated* from the
1540 * memory pool, not the number of elements in the pool itself. To count
1541 * the number elements currently available in the pool, use "rte_mempool_count"
1543 * When cache is enabled, this function has to browse the length of
1544 * all lcores, so it should not be used in a data path, but only for
1545 * debug purposes. User-owned mempool caches are not accounted for.
1548 * A pointer to the mempool structure.
1550 * The number of free entries in the mempool.
1553 static inline unsigned
1554 rte_mempool_free_count(const struct rte_mempool *mp)
1556 return rte_mempool_in_use_count(mp);
1560 * Test if the mempool is full.
1562 * When cache is enabled, this function has to browse the length of all
1563 * lcores, so it should not be used in a data path, but only for debug
1564 * purposes. User-owned mempool caches are not accounted for.
1567 * A pointer to the mempool structure.
1569 * - 1: The mempool is full.
1570 * - 0: The mempool is not full.
1573 rte_mempool_full(const struct rte_mempool *mp)
1575 return !!(rte_mempool_avail_count(mp) == mp->size);
1579 * Test if the mempool is empty.
1581 * When cache is enabled, this function has to browse the length of all
1582 * lcores, so it should not be used in a data path, but only for debug
1583 * purposes. User-owned mempool caches are not accounted for.
1586 * A pointer to the mempool structure.
1588 * - 1: The mempool is empty.
1589 * - 0: The mempool is not empty.
1592 rte_mempool_empty(const struct rte_mempool *mp)
1594 return !!(rte_mempool_avail_count(mp) == 0);
1598 * Return the physical address of elt, which is an element of the pool mp.
1601 * A pointer to the mempool structure.
1603 * A pointer (virtual address) to the element of the pool.
1605 * The physical address of the elt element.
1606 * If the mempool was created with MEMPOOL_F_NO_PHYS_CONTIG, the
1607 * returned value is RTE_BAD_PHYS_ADDR.
1609 static inline phys_addr_t
1610 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1612 const struct rte_mempool_objhdr *hdr;
1613 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1615 return hdr->physaddr;
1619 * Check the consistency of mempool objects.
1621 * Verify the coherency of fields in the mempool structure. Also check
1622 * that the cookies of mempool objects (even the ones that are not
1623 * present in pool) have a correct value. If not, a panic will occur.
1626 * A pointer to the mempool structure.
1628 void rte_mempool_audit(struct rte_mempool *mp);
1631 * Return a pointer to the private data in an mempool structure.
1634 * A pointer to the mempool structure.
1636 * A pointer to the private data.
1638 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1641 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1645 * Dump the status of all mempools on the console
1648 * A pointer to a file for output
1650 void rte_mempool_list_dump(FILE *f);
1653 * Search a mempool from its name
1656 * The name of the mempool.
1658 * The pointer to the mempool matching the name, or NULL if not found.
1660 * with rte_errno set appropriately. Possible rte_errno values include:
1661 * - ENOENT - required entry not available to return.
1664 struct rte_mempool *rte_mempool_lookup(const char *name);
1667 * Get the header, trailer and total size of a mempool element.
1669 * Given a desired size of the mempool element and mempool flags,
1670 * calculates header, trailer, body and total sizes of the mempool object.
1673 * The size of each element, without header and trailer.
1675 * The flags used for the mempool creation.
1676 * Consult rte_mempool_create() for more information about possible values.
1677 * The size of each element.
1679 * The calculated detailed size the mempool object. May be NULL.
1681 * Total size of the mempool object.
1683 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1684 struct rte_mempool_objsz *sz);
1687 * Get the size of memory required to store mempool elements.
1689 * Calculate the maximum amount of memory required to store given number
1690 * of objects. Assume that the memory buffer will be aligned at page
1693 * Note that if object size is bigger then page size, then it assumes
1694 * that pages are grouped in subsets of physically continuous pages big
1695 * enough to store at least one object.
1698 * Number of elements.
1699 * @param total_elt_sz
1700 * The size of each element, including header and trailer, as returned
1701 * by rte_mempool_calc_obj_size().
1703 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1705 * Required memory size aligned at page boundary.
1707 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1711 * Get the size of memory required to store mempool elements.
1713 * Calculate how much memory would be actually required with the given
1714 * memory footprint to store required number of objects.
1717 * Virtual address of the externally allocated memory buffer.
1718 * Will be used to store mempool objects.
1720 * Number of elements.
1721 * @param total_elt_sz
1722 * The size of each element, including header and trailer, as returned
1723 * by rte_mempool_calc_obj_size().
1725 * Array of physical addresses of the pages that comprises given memory
1728 * Number of elements in the paddr array.
1730 * LOG2 of the physical pages size.
1732 * On success, the number of bytes needed to store given number of
1733 * objects, aligned to the given page size. If the provided memory
1734 * buffer is too small, return a negative value whose absolute value
1735 * is the actual number of elements that can be stored in that buffer.
1737 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1738 size_t total_elt_sz, const phys_addr_t paddr[], uint32_t pg_num,
1742 * Walk list of all memory pools
1747 * Argument passed to iterator
1749 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1756 #endif /* _RTE_MEMPOOL_H_ */