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 preemptible. An lcore must not be
55 * interrupted by another task that uses the same mempool (because it uses a
56 * ring which is not preemptible). Also, usual mempool functions like
57 * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
58 * thread due to the internal per-lcore cache. Due to the lack of caching,
59 * rte_mempool_get() or rte_mempool_put() performance will suffer when called
60 * by non-EAL threads. Instead, non-EAL threads should call
61 * rte_mempool_generic_get() or rte_mempool_generic_put() with a user cache
62 * created with rte_mempool_cache_create().
70 #include <sys/queue.h>
72 #include <rte_spinlock.h>
74 #include <rte_debug.h>
75 #include <rte_lcore.h>
76 #include <rte_memory.h>
77 #include <rte_branch_prediction.h>
79 #include <rte_memcpy.h>
80 #include <rte_common.h>
86 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
87 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
88 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
90 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
92 * A structure that stores the mempool statistics (per-lcore).
94 struct rte_mempool_debug_stats {
95 uint64_t put_bulk; /**< Number of puts. */
96 uint64_t put_objs; /**< Number of objects successfully put. */
97 uint64_t get_success_bulk; /**< Successful allocation number. */
98 uint64_t get_success_objs; /**< Objects successfully allocated. */
99 uint64_t get_fail_bulk; /**< Failed allocation number. */
100 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
101 } __rte_cache_aligned;
105 * A structure that stores a per-core object cache.
107 struct rte_mempool_cache {
108 uint32_t size; /**< Size of the cache */
109 uint32_t flushthresh; /**< Threshold before we flush excess elements */
110 uint32_t len; /**< Current cache count */
112 * Cache is allocated to this size to allow it to overflow in certain
113 * cases to avoid needless emptying of cache.
115 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
116 } __rte_cache_aligned;
119 * A structure that stores the size of mempool elements.
121 struct rte_mempool_objsz {
122 uint32_t elt_size; /**< Size of an element. */
123 uint32_t header_size; /**< Size of header (before elt). */
124 uint32_t trailer_size; /**< Size of trailer (after elt). */
126 /**< Total size of an object (header + elt + trailer). */
129 /**< Maximum length of a memory pool's name. */
130 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
131 sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
132 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
135 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
137 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
139 /** Mempool over one chunk of physically continuous memory */
140 #define MEMPOOL_PG_NUM_DEFAULT 1
142 #ifndef RTE_MEMPOOL_ALIGN
143 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
146 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
149 * Mempool object header structure
151 * Each object stored in mempools are prefixed by this header structure,
152 * it allows to retrieve the mempool pointer from the object and to
153 * iterate on all objects attached to a mempool. When debug is enabled,
154 * a cookie is also added in this structure preventing corruptions and
157 struct rte_mempool_objhdr {
158 STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
159 struct rte_mempool *mp; /**< The mempool owning the object. */
160 phys_addr_t physaddr; /**< Physical address of the object. */
161 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
162 uint64_t cookie; /**< Debug cookie. */
167 * A list of object headers type
169 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
171 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
174 * Mempool object trailer structure
176 * In debug mode, each object stored in mempools are suffixed by this
177 * trailer structure containing a cookie preventing memory corruptions.
179 struct rte_mempool_objtlr {
180 uint64_t cookie; /**< Debug cookie. */
186 * A list of memory where objects are stored
188 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
191 * Callback used to free a memory chunk
193 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
197 * Mempool objects memory header structure
199 * The memory chunks where objects are stored. Each chunk is virtually
200 * and physically contiguous.
202 struct rte_mempool_memhdr {
203 STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
204 struct rte_mempool *mp; /**< The mempool owning the chunk */
205 void *addr; /**< Virtual address of the chunk */
206 phys_addr_t phys_addr; /**< Physical address of the chunk */
207 size_t len; /**< length of the chunk */
208 rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
209 void *opaque; /**< Argument passed to the free callback */
213 * The RTE mempool structure.
217 * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
218 * compatibility requirements, it could be changed to
219 * RTE_MEMPOOL_NAMESIZE next time the ABI changes
221 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
224 void *pool_data; /**< Ring or pool to store objects. */
225 uint64_t pool_id; /**< External mempool identifier. */
227 void *pool_config; /**< optional args for ops alloc. */
228 const struct rte_memzone *mz; /**< Memzone where pool is alloc'd. */
229 int flags; /**< Flags of the mempool. */
230 int socket_id; /**< Socket id passed at create. */
231 uint32_t size; /**< Max size of the mempool. */
233 /**< Size of per-lcore default local cache. */
235 uint32_t elt_size; /**< Size of an element. */
236 uint32_t header_size; /**< Size of header (before elt). */
237 uint32_t trailer_size; /**< Size of trailer (after elt). */
239 unsigned private_data_size; /**< Size of private data. */
241 * Index into rte_mempool_ops_table array of mempool ops
242 * structs, which contain callback function pointers.
243 * We're using an index here rather than pointers to the callbacks
244 * to facilitate any secondary processes that may want to use
249 struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
251 uint32_t populated_size; /**< Number of populated objects. */
252 struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
253 uint32_t nb_mem_chunks; /**< Number of memory chunks */
254 struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
256 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
257 /** Per-lcore statistics. */
258 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
260 } __rte_cache_aligned;
262 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread among memory channels. */
263 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
264 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
265 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
266 #define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
267 #define MEMPOOL_F_NO_PHYS_CONTIG 0x0020 /**< Don't need physically contiguous objs. */
270 * @internal When debug is enabled, store some statistics.
273 * Pointer to the memory pool.
275 * Name of the statistics field to increment in the memory pool.
277 * Number to add to the object-oriented statistics.
279 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
280 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
281 unsigned __lcore_id = rte_lcore_id(); \
282 if (__lcore_id < RTE_MAX_LCORE) { \
283 mp->stats[__lcore_id].name##_objs += n; \
284 mp->stats[__lcore_id].name##_bulk += 1; \
288 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
292 * Calculate the size of the mempool header.
295 * Pointer to the memory pool.
297 * Size of the per-lcore cache.
299 #define MEMPOOL_HEADER_SIZE(mp, cs) \
300 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
301 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
303 /* return the header of a mempool object (internal) */
304 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
306 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
307 sizeof(struct rte_mempool_objhdr));
311 * Return a pointer to the mempool owning this object.
314 * An object that is owned by a pool. If this is not the case,
315 * the behavior is undefined.
317 * A pointer to the mempool structure.
319 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
321 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
325 /* return the trailer of a mempool object (internal) */
326 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
328 struct rte_mempool *mp = rte_mempool_from_obj(obj);
329 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
333 * @internal Check and update cookies or panic.
336 * Pointer to the memory pool.
337 * @param obj_table_const
338 * Pointer to a table of void * pointers (objects).
340 * Index of object in object table.
342 * - 0: object is supposed to be allocated, mark it as free
343 * - 1: object is supposed to be free, mark it as allocated
344 * - 2: just check that cookie is valid (free or allocated)
346 void rte_mempool_check_cookies(const struct rte_mempool *mp,
347 void * const *obj_table_const, unsigned n, int free);
349 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
350 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
351 rte_mempool_check_cookies(mp, obj_table_const, n, free)
353 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
354 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
356 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
359 * Prototype for implementation specific data provisioning function.
361 * The function should provide the implementation specific memory for
362 * use by the other mempool ops functions in a given mempool ops struct.
363 * E.g. the default ops provides an instance of the rte_ring for this purpose.
364 * it will most likely point to a different type of data structure, and
365 * will be transparent to the application programmer.
366 * This function should set mp->pool_data.
368 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
371 * Free the opaque private data pointed to by mp->pool_data pointer.
373 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
376 * Enqueue an object into the external pool.
378 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
379 void * const *obj_table, unsigned int n);
382 * Dequeue an object from the external pool.
384 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
385 void **obj_table, unsigned int n);
388 * Return the number of available objects in the external pool.
390 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
392 /** Structure defining mempool operations structure */
393 struct rte_mempool_ops {
394 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
395 rte_mempool_alloc_t alloc; /**< Allocate private data. */
396 rte_mempool_free_t free; /**< Free the external pool. */
397 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
398 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
399 rte_mempool_get_count get_count; /**< Get qty of available objs. */
400 } __rte_cache_aligned;
402 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
405 * Structure storing the table of registered ops structs, each of which contain
406 * the function pointers for the mempool ops functions.
407 * Each process has its own storage for this ops struct array so that
408 * the mempools can be shared across primary and secondary processes.
409 * The indices used to access the array are valid across processes, whereas
410 * any function pointers stored directly in the mempool struct would not be.
411 * This results in us simply having "ops_index" in the mempool struct.
413 struct rte_mempool_ops_table {
414 rte_spinlock_t sl; /**< Spinlock for add/delete. */
415 uint32_t num_ops; /**< Number of used ops structs in the table. */
417 * Storage for all possible ops structs.
419 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
420 } __rte_cache_aligned;
422 /** Array of registered ops structs. */
423 extern struct rte_mempool_ops_table rte_mempool_ops_table;
426 * @internal Get the mempool ops struct from its index.
429 * The index of the ops struct in the ops struct table. It must be a valid
430 * index: (0 <= idx < num_ops).
432 * The pointer to the ops struct in the table.
434 static inline struct rte_mempool_ops *
435 rte_mempool_get_ops(int ops_index)
437 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
439 return &rte_mempool_ops_table.ops[ops_index];
443 * @internal Wrapper for mempool_ops alloc callback.
446 * Pointer to the memory pool.
448 * - 0: Success; successfully allocated mempool pool_data.
449 * - <0: Error; code of alloc function.
452 rte_mempool_ops_alloc(struct rte_mempool *mp);
455 * @internal Wrapper for mempool_ops dequeue callback.
458 * Pointer to the memory pool.
460 * Pointer to a table of void * pointers (objects).
462 * Number of objects to get.
464 * - 0: Success; got n objects.
465 * - <0: Error; code of dequeue function.
468 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
469 void **obj_table, unsigned n)
471 struct rte_mempool_ops *ops;
473 ops = rte_mempool_get_ops(mp->ops_index);
474 return ops->dequeue(mp, obj_table, n);
478 * @internal wrapper for mempool_ops enqueue callback.
481 * Pointer to the memory pool.
483 * Pointer to a table of void * pointers (objects).
485 * Number of objects to put.
487 * - 0: Success; n objects supplied.
488 * - <0: Error; code of enqueue function.
491 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
494 struct rte_mempool_ops *ops;
496 ops = rte_mempool_get_ops(mp->ops_index);
497 return ops->enqueue(mp, obj_table, n);
501 * @internal wrapper for mempool_ops get_count callback.
504 * Pointer to the memory pool.
506 * The number of available objects in the external pool.
509 rte_mempool_ops_get_count(const struct rte_mempool *mp);
512 * @internal wrapper for mempool_ops free callback.
515 * Pointer to the memory pool.
518 rte_mempool_ops_free(struct rte_mempool *mp);
521 * Set the ops of a mempool.
523 * This can only be done on a mempool that is not populated, i.e. just after
524 * a call to rte_mempool_create_empty().
527 * Pointer to the memory pool.
529 * Name of the ops structure to use for this mempool.
531 * Opaque data that can be passed by the application to the ops functions.
533 * - 0: Success; the mempool is now using the requested ops functions.
534 * - -EINVAL - Invalid ops struct name provided.
535 * - -EEXIST - mempool already has an ops struct assigned.
538 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
542 * Register mempool operations.
545 * Pointer to an ops structure to register.
547 * - >=0: Success; return the index of the ops struct in the table.
548 * - -EINVAL - some missing callbacks while registering ops struct.
549 * - -ENOSPC - the maximum number of ops structs has been reached.
551 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
554 * Macro to statically register the ops of a mempool handler.
555 * Note that the rte_mempool_register_ops fails silently here when
556 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
558 #define MEMPOOL_REGISTER_OPS(ops) \
559 void mp_hdlr_init_##ops(void); \
560 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
562 rte_mempool_register_ops(&ops); \
566 * An object callback function for mempool.
568 * Used by rte_mempool_create() and rte_mempool_obj_iter().
570 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
571 void *opaque, void *obj, unsigned obj_idx);
572 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
575 * A memory callback function for mempool.
577 * Used by rte_mempool_mem_iter().
579 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
580 void *opaque, struct rte_mempool_memhdr *memhdr,
584 * A mempool constructor callback function.
586 * Arguments are the mempool and the opaque pointer given by the user in
587 * rte_mempool_create().
589 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
592 * Create a new mempool named *name* in memory.
594 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
595 * pool contains n elements of elt_size. Its size is set to n.
598 * The name of the mempool.
600 * The number of elements in the mempool. The optimum size (in terms of
601 * memory usage) for a mempool is when n is a power of two minus one:
604 * The size of each element.
606 * If cache_size is non-zero, the rte_mempool library will try to
607 * limit the accesses to the common lockless pool, by maintaining a
608 * per-lcore object cache. This argument must be lower or equal to
609 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
610 * cache_size to have "n modulo cache_size == 0": if this is
611 * not the case, some elements will always stay in the pool and will
612 * never be used. The access to the per-lcore table is of course
613 * faster than the multi-producer/consumer pool. The cache can be
614 * disabled if the cache_size argument is set to 0; it can be useful to
615 * avoid losing objects in cache.
616 * @param private_data_size
617 * The size of the private data appended after the mempool
618 * structure. This is useful for storing some private data after the
619 * mempool structure, as is done for rte_mbuf_pool for example.
621 * A function pointer that is called for initialization of the pool,
622 * before object initialization. The user can initialize the private
623 * data in this function if needed. This parameter can be NULL if
626 * An opaque pointer to data that can be used in the mempool
627 * constructor function.
629 * A function pointer that is called for each object at
630 * initialization of the pool. The user can set some meta data in
631 * objects if needed. This parameter can be NULL if not needed.
632 * The obj_init() function takes the mempool pointer, the init_arg,
633 * the object pointer and the object number as parameters.
634 * @param obj_init_arg
635 * An opaque pointer to data that can be used as an argument for
636 * each call to the object constructor function.
638 * The *socket_id* argument is the socket identifier in the case of
639 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
640 * constraint for the reserved zone.
642 * The *flags* arguments is an OR of following flags:
643 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
644 * between channels in RAM: the pool allocator will add padding
645 * between objects depending on the hardware configuration. See
646 * Memory alignment constraints for details. If this flag is set,
647 * the allocator will just align them to a cache line.
648 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
649 * cache-aligned. This flag removes this constraint, and no
650 * padding will be present between objects. This flag implies
651 * MEMPOOL_F_NO_SPREAD.
652 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
653 * when using rte_mempool_put() or rte_mempool_put_bulk() is
654 * "single-producer". Otherwise, it is "multi-producers".
655 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
656 * when using rte_mempool_get() or rte_mempool_get_bulk() is
657 * "single-consumer". Otherwise, it is "multi-consumers".
658 * - MEMPOOL_F_NO_PHYS_CONTIG: If set, allocated objects won't
659 * necessarily be contiguous in physical memory.
661 * The pointer to the new allocated mempool, on success. NULL on error
662 * with rte_errno set appropriately. Possible rte_errno values include:
663 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
664 * - E_RTE_SECONDARY - function was called from a secondary process instance
665 * - EINVAL - cache size provided is too large
666 * - ENOSPC - the maximum number of memzones has already been allocated
667 * - EEXIST - a memzone with the same name already exists
668 * - ENOMEM - no appropriate memory area found in which to create memzone
671 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
672 unsigned cache_size, unsigned private_data_size,
673 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
674 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
675 int socket_id, unsigned flags);
678 * Create a new mempool named *name* in memory.
680 * The pool contains n elements of elt_size. Its size is set to n.
681 * This function uses ``memzone_reserve()`` to allocate the mempool header
682 * (and the objects if vaddr is NULL).
683 * Depending on the input parameters, mempool elements can be either allocated
684 * together with the mempool header, or an externally provided memory buffer
685 * could be used to store mempool objects. In later case, that external
686 * memory buffer can consist of set of disjoint physical pages.
689 * The name of the mempool.
691 * The number of elements in the mempool. The optimum size (in terms of
692 * memory usage) for a mempool is when n is a power of two minus one:
695 * The size of each element.
697 * Size of the cache. See rte_mempool_create() for details.
698 * @param private_data_size
699 * The size of the private data appended after the mempool
700 * structure. This is useful for storing some private data after the
701 * mempool structure, as is done for rte_mbuf_pool for example.
703 * A function pointer that is called for initialization of the pool,
704 * before object initialization. The user can initialize the private
705 * data in this function if needed. This parameter can be NULL if
708 * An opaque pointer to data that can be used in the mempool
709 * constructor function.
711 * A function called for each object at initialization of the pool.
712 * See rte_mempool_create() for details.
713 * @param obj_init_arg
714 * An opaque pointer passed to the object constructor function.
716 * The *socket_id* argument is the socket identifier in the case of
717 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
718 * constraint for the reserved zone.
720 * Flags controlling the behavior of the mempool. See
721 * rte_mempool_create() for details.
723 * Virtual address of the externally allocated memory buffer.
724 * Will be used to store mempool objects.
726 * Array of physical addresses of the pages that comprises given memory
729 * Number of elements in the paddr array.
731 * LOG2 of the physical pages size.
733 * The pointer to the new allocated mempool, on success. NULL on error
734 * with rte_errno set appropriately. See rte_mempool_create() for details.
737 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
738 unsigned cache_size, unsigned private_data_size,
739 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
740 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
741 int socket_id, unsigned flags, void *vaddr,
742 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift);
745 * Create an empty mempool
747 * The mempool is allocated and initialized, but it is not populated: no
748 * memory is allocated for the mempool elements. The user has to call
749 * rte_mempool_populate_*() to add memory chunks to the pool. Once
750 * populated, the user may also want to initialize each object with
751 * rte_mempool_obj_iter().
754 * The name of the mempool.
756 * The maximum number of elements that can be added in the mempool.
757 * The optimum size (in terms of memory usage) for a mempool is when n
758 * is a power of two minus one: n = (2^q - 1).
760 * The size of each element.
762 * Size of the cache. See rte_mempool_create() for details.
763 * @param private_data_size
764 * The size of the private data appended after the mempool
765 * structure. This is useful for storing some private data after the
766 * mempool structure, as is done for rte_mbuf_pool for example.
768 * The *socket_id* argument is the socket identifier in the case of
769 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
770 * constraint for the reserved zone.
772 * Flags controlling the behavior of the mempool. See
773 * rte_mempool_create() for details.
775 * The pointer to the new allocated mempool, on success. NULL on error
776 * with rte_errno set appropriately. See rte_mempool_create() for details.
779 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
780 unsigned cache_size, unsigned private_data_size,
781 int socket_id, unsigned flags);
785 * Unlink the mempool from global list, free the memory chunks, and all
786 * memory referenced by the mempool. The objects must not be used by
787 * other cores as they will be freed.
790 * A pointer to the mempool structure.
793 rte_mempool_free(struct rte_mempool *mp);
796 * Add physically contiguous memory for objects in the pool at init
798 * Add a virtually and physically contiguous memory chunk in the pool
799 * where objects can be instantiated.
801 * If the given physical address is unknown (paddr = RTE_BAD_PHYS_ADDR),
802 * the chunk doesn't need to be physically contiguous (only virtually),
803 * and allocated objects may span two pages.
806 * A pointer to the mempool structure.
808 * The virtual address of memory that should be used to store objects.
810 * The physical address
812 * The length of memory in bytes.
814 * The callback used to free this chunk when destroying the mempool.
816 * An opaque argument passed to free_cb.
818 * The number of objects added on success.
819 * On error, the chunk is not added in the memory list of the
820 * mempool and a negative errno is returned.
822 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
823 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
827 * Add physical memory for objects in the pool at init
829 * Add a virtually contiguous memory chunk in the pool where objects can
830 * be instantiated. The physical addresses corresponding to the virtual
831 * area are described in paddr[], pg_num, pg_shift.
834 * A pointer to the mempool structure.
836 * The virtual address of memory that should be used to store objects.
838 * An array of physical addresses of each page composing the virtual
841 * Number of elements in the paddr array.
843 * LOG2 of the physical pages size.
845 * The callback used to free this chunk when destroying the mempool.
847 * An opaque argument passed to free_cb.
849 * The number of objects added on success.
850 * On error, the chunks are not added in the memory list of the
851 * mempool and a negative errno is returned.
853 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
854 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
855 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
858 * Add virtually contiguous memory for objects in the pool at init
860 * Add a virtually contiguous memory chunk in the pool where objects can
864 * A pointer to the mempool structure.
866 * The virtual address of memory that should be used to store objects.
867 * Must be page-aligned.
869 * The length of memory in bytes. Must be page-aligned.
871 * The size of memory pages in this virtual area.
873 * The callback used to free this chunk when destroying the mempool.
875 * An opaque argument passed to free_cb.
877 * The number of objects added on success.
878 * On error, the chunk is not added in the memory list of the
879 * mempool and a negative errno is returned.
882 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
883 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
887 * Add memory for objects in the pool at init
889 * This is the default function used by rte_mempool_create() to populate
890 * the mempool. It adds memory allocated using rte_memzone_reserve().
893 * A pointer to the mempool structure.
895 * The number of objects added on success.
896 * On error, the chunk is not added in the memory list of the
897 * mempool and a negative errno is returned.
899 int rte_mempool_populate_default(struct rte_mempool *mp);
902 * Add memory from anonymous mapping for objects in the pool at init
904 * This function mmap an anonymous memory zone that is locked in
905 * memory to store the objects of the mempool.
908 * A pointer to the mempool structure.
910 * The number of objects added on success.
911 * On error, the chunk is not added in the memory list of the
912 * mempool and a negative errno is returned.
914 int rte_mempool_populate_anon(struct rte_mempool *mp);
917 * Call a function for each mempool element
919 * Iterate across all objects attached to a rte_mempool and call the
920 * callback function on it.
923 * A pointer to an initialized mempool.
925 * A function pointer that is called for each object.
927 * An opaque pointer passed to the callback function.
929 * Number of objects iterated.
931 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
932 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
935 * Call a function for each mempool memory chunk
937 * Iterate across all memory chunks attached to a rte_mempool and call
938 * the callback function on it.
941 * A pointer to an initialized mempool.
943 * A function pointer that is called for each memory chunk.
945 * An opaque pointer passed to the callback function.
947 * Number of memory chunks iterated.
949 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
950 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
953 * Dump the status of the mempool to a file.
956 * A pointer to a file for output
958 * A pointer to the mempool structure.
960 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
963 * Create a user-owned mempool cache.
965 * This can be used by non-EAL threads to enable caching when they
966 * interact with a mempool.
969 * The size of the mempool cache. See rte_mempool_create()'s cache_size
970 * parameter description for more information. The same limits and
971 * considerations apply here too.
973 * The socket identifier in the case of NUMA. The value can be
974 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
976 struct rte_mempool_cache *
977 rte_mempool_cache_create(uint32_t size, int socket_id);
980 * Free a user-owned mempool cache.
983 * A pointer to the mempool cache.
986 rte_mempool_cache_free(struct rte_mempool_cache *cache);
989 * Flush a user-owned mempool cache to the specified mempool.
992 * A pointer to the mempool cache.
994 * A pointer to the mempool.
996 static inline void __attribute__((always_inline))
997 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
998 struct rte_mempool *mp)
1000 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1005 * Get a pointer to the per-lcore default mempool cache.
1008 * A pointer to the mempool structure.
1010 * The logical core id.
1012 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1014 static inline struct rte_mempool_cache *__attribute__((always_inline))
1015 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1017 if (mp->cache_size == 0)
1020 if (lcore_id >= RTE_MAX_LCORE)
1023 return &mp->local_cache[lcore_id];
1027 * @internal Put several objects back in the mempool; used internally.
1029 * A pointer to the mempool structure.
1031 * A pointer to a table of void * pointers (objects).
1033 * The number of objects to store back in the mempool, must be strictly
1036 * A pointer to a mempool cache structure. May be NULL if not needed.
1038 * The flags used for the mempool creation.
1039 * Single-producer (MEMPOOL_F_SP_PUT flag) or multi-producers.
1041 static inline void __attribute__((always_inline))
1042 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1043 unsigned n, struct rte_mempool_cache *cache)
1047 /* increment stat now, adding in mempool always success */
1048 __MEMPOOL_STAT_ADD(mp, put, n);
1050 /* No cache provided or if put would overflow mem allocated for cache */
1051 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1054 cache_objs = &cache->objs[cache->len];
1057 * The cache follows the following algorithm
1058 * 1. Add the objects to the cache
1059 * 2. Anything greater than the cache min value (if it crosses the
1060 * cache flush threshold) is flushed to the ring.
1063 /* Add elements back into the cache */
1064 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1068 if (cache->len >= cache->flushthresh) {
1069 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1070 cache->len - cache->size);
1071 cache->len = cache->size;
1078 /* push remaining objects in ring */
1079 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1080 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1081 rte_panic("cannot put objects in mempool\n");
1083 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1089 * Put several objects back in the mempool.
1092 * A pointer to the mempool structure.
1094 * A pointer to a table of void * pointers (objects).
1096 * The number of objects to add in the mempool from the obj_table.
1098 * A pointer to a mempool cache structure. May be NULL if not needed.
1100 * The flags used for the mempool creation.
1101 * Single-producer (MEMPOOL_F_SP_PUT flag) or multi-producers.
1103 static inline void __attribute__((always_inline))
1104 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1105 unsigned n, struct rte_mempool_cache *cache,
1106 __rte_unused int flags)
1108 __mempool_check_cookies(mp, obj_table, n, 0);
1109 __mempool_generic_put(mp, obj_table, n, cache);
1113 * Put several objects back in the mempool.
1115 * This function calls the multi-producer or the single-producer
1116 * version depending on the default behavior that was specified at
1117 * mempool creation time (see flags).
1120 * A pointer to the mempool structure.
1122 * A pointer to a table of void * pointers (objects).
1124 * The number of objects to add in the mempool from obj_table.
1126 static inline void __attribute__((always_inline))
1127 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1130 struct rte_mempool_cache *cache;
1131 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1132 rte_mempool_generic_put(mp, obj_table, n, cache, mp->flags);
1136 * Put one object back in the mempool.
1138 * This function calls the multi-producer or the single-producer
1139 * version depending on the default behavior that was specified at
1140 * mempool creation time (see flags).
1143 * A pointer to the mempool structure.
1145 * A pointer to the object to be added.
1147 static inline void __attribute__((always_inline))
1148 rte_mempool_put(struct rte_mempool *mp, void *obj)
1150 rte_mempool_put_bulk(mp, &obj, 1);
1154 * @internal Get several objects from the mempool; used internally.
1156 * A pointer to the mempool structure.
1158 * A pointer to a table of void * pointers (objects).
1160 * The number of objects to get, must be strictly positive.
1162 * A pointer to a mempool cache structure. May be NULL if not needed.
1164 * The flags used for the mempool creation.
1165 * Single-consumer (MEMPOOL_F_SC_GET flag) or multi-consumers.
1167 * - >=0: Success; number of objects supplied.
1168 * - <0: Error; code of ring dequeue function.
1170 static inline int __attribute__((always_inline))
1171 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1172 unsigned n, struct rte_mempool_cache *cache)
1175 uint32_t index, len;
1178 /* No cache provided or cannot be satisfied from cache */
1179 if (unlikely(cache == NULL || n >= cache->size))
1182 cache_objs = cache->objs;
1184 /* Can this be satisfied from the cache? */
1185 if (cache->len < n) {
1186 /* No. Backfill the cache first, and then fill from it */
1187 uint32_t req = n + (cache->size - cache->len);
1189 /* How many do we require i.e. number to fill the cache + the request */
1190 ret = rte_mempool_ops_dequeue_bulk(mp,
1191 &cache->objs[cache->len], req);
1192 if (unlikely(ret < 0)) {
1194 * In the offchance that we are buffer constrained,
1195 * where we are not able to allocate cache + n, go to
1196 * the ring directly. If that fails, we are truly out of
1205 /* Now fill in the response ... */
1206 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1207 *obj_table = cache_objs[len];
1211 __MEMPOOL_STAT_ADD(mp, get_success, n);
1217 /* get remaining objects from ring */
1218 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1221 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1223 __MEMPOOL_STAT_ADD(mp, get_success, n);
1229 * Get several objects from the mempool.
1231 * If cache is enabled, objects will be retrieved first from cache,
1232 * subsequently from the common pool. Note that it can return -ENOENT when
1233 * the local cache and common pool are empty, even if cache from other
1237 * A pointer to the mempool structure.
1239 * A pointer to a table of void * pointers (objects) that will be filled.
1241 * The number of objects to get from mempool to obj_table.
1243 * A pointer to a mempool cache structure. May be NULL if not needed.
1245 * The flags used for the mempool creation.
1246 * Single-consumer (MEMPOOL_F_SC_GET flag) or multi-consumers.
1248 * - 0: Success; objects taken.
1249 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1251 static inline int __attribute__((always_inline))
1252 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table, unsigned n,
1253 struct rte_mempool_cache *cache, __rte_unused int flags)
1256 ret = __mempool_generic_get(mp, obj_table, n, cache);
1258 __mempool_check_cookies(mp, obj_table, n, 1);
1263 * Get several objects from the mempool.
1265 * This function calls the multi-consumers or the single-consumer
1266 * version, depending on the default behaviour that was specified at
1267 * mempool creation time (see flags).
1269 * If cache is enabled, objects will be retrieved first from cache,
1270 * subsequently from the common pool. Note that it can return -ENOENT when
1271 * the local cache and common pool are empty, even if cache from other
1275 * A pointer to the mempool structure.
1277 * A pointer to a table of void * pointers (objects) that will be filled.
1279 * The number of objects to get from the mempool to obj_table.
1281 * - 0: Success; objects taken
1282 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1284 static inline int __attribute__((always_inline))
1285 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1287 struct rte_mempool_cache *cache;
1288 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1289 return rte_mempool_generic_get(mp, obj_table, n, cache, mp->flags);
1293 * Get one object from the mempool.
1295 * This function calls the multi-consumers or the single-consumer
1296 * version, depending on the default behavior that was specified at
1297 * mempool creation (see flags).
1299 * If cache is enabled, objects will be retrieved first from cache,
1300 * subsequently from the common pool. Note that it can return -ENOENT when
1301 * the local cache and common pool are empty, even if cache from other
1305 * A pointer to the mempool structure.
1307 * A pointer to a void * pointer (object) that will be filled.
1309 * - 0: Success; objects taken.
1310 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1312 static inline int __attribute__((always_inline))
1313 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1315 return rte_mempool_get_bulk(mp, obj_p, 1);
1319 * Return the number of entries in the mempool.
1321 * When cache is enabled, this function has to browse the length of
1322 * all lcores, so it should not be used in a data path, but only for
1323 * debug purposes. User-owned mempool caches are not accounted for.
1326 * A pointer to the mempool structure.
1328 * The number of entries in the mempool.
1330 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1333 * Return the number of elements which have been allocated from the mempool
1335 * When cache is enabled, this function has to browse the length of
1336 * all lcores, so it should not be used in a data path, but only for
1340 * A pointer to the mempool structure.
1342 * The number of free entries in the mempool.
1345 rte_mempool_in_use_count(const struct rte_mempool *mp);
1348 * Test if the mempool is full.
1350 * When cache is enabled, this function has to browse the length of all
1351 * lcores, so it should not be used in a data path, but only for debug
1352 * purposes. User-owned mempool caches are not accounted for.
1355 * A pointer to the mempool structure.
1357 * - 1: The mempool is full.
1358 * - 0: The mempool is not full.
1361 rte_mempool_full(const struct rte_mempool *mp)
1363 return !!(rte_mempool_avail_count(mp) == mp->size);
1367 * Test if the mempool is empty.
1369 * When cache is enabled, this function has to browse the length of all
1370 * lcores, so it should not be used in a data path, but only for debug
1371 * purposes. User-owned mempool caches are not accounted for.
1374 * A pointer to the mempool structure.
1376 * - 1: The mempool is empty.
1377 * - 0: The mempool is not empty.
1380 rte_mempool_empty(const struct rte_mempool *mp)
1382 return !!(rte_mempool_avail_count(mp) == 0);
1386 * Return the physical address of elt, which is an element of the pool mp.
1389 * A pointer to the mempool structure.
1391 * A pointer (virtual address) to the element of the pool.
1393 * The physical address of the elt element.
1394 * If the mempool was created with MEMPOOL_F_NO_PHYS_CONTIG, the
1395 * returned value is RTE_BAD_PHYS_ADDR.
1397 static inline phys_addr_t
1398 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1400 const struct rte_mempool_objhdr *hdr;
1401 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1403 return hdr->physaddr;
1407 * Check the consistency of mempool objects.
1409 * Verify the coherency of fields in the mempool structure. Also check
1410 * that the cookies of mempool objects (even the ones that are not
1411 * present in pool) have a correct value. If not, a panic will occur.
1414 * A pointer to the mempool structure.
1416 void rte_mempool_audit(struct rte_mempool *mp);
1419 * Return a pointer to the private data in an mempool structure.
1422 * A pointer to the mempool structure.
1424 * A pointer to the private data.
1426 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1429 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1433 * Dump the status of all mempools on the console
1436 * A pointer to a file for output
1438 void rte_mempool_list_dump(FILE *f);
1441 * Search a mempool from its name
1444 * The name of the mempool.
1446 * The pointer to the mempool matching the name, or NULL if not found.
1448 * with rte_errno set appropriately. Possible rte_errno values include:
1449 * - ENOENT - required entry not available to return.
1452 struct rte_mempool *rte_mempool_lookup(const char *name);
1455 * Get the header, trailer and total size of a mempool element.
1457 * Given a desired size of the mempool element and mempool flags,
1458 * calculates header, trailer, body and total sizes of the mempool object.
1461 * The size of each element, without header and trailer.
1463 * The flags used for the mempool creation.
1464 * Consult rte_mempool_create() for more information about possible values.
1465 * The size of each element.
1467 * The calculated detailed size the mempool object. May be NULL.
1469 * Total size of the mempool object.
1471 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1472 struct rte_mempool_objsz *sz);
1475 * Get the size of memory required to store mempool elements.
1477 * Calculate the maximum amount of memory required to store given number
1478 * of objects. Assume that the memory buffer will be aligned at page
1481 * Note that if object size is bigger then page size, then it assumes
1482 * that pages are grouped in subsets of physically continuous pages big
1483 * enough to store at least one object.
1486 * Number of elements.
1487 * @param total_elt_sz
1488 * The size of each element, including header and trailer, as returned
1489 * by rte_mempool_calc_obj_size().
1491 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1493 * Required memory size aligned at page boundary.
1495 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1499 * Get the size of memory required to store mempool elements.
1501 * Calculate how much memory would be actually required with the given
1502 * memory footprint to store required number of objects.
1505 * Virtual address of the externally allocated memory buffer.
1506 * Will be used to store mempool objects.
1508 * Number of elements.
1509 * @param total_elt_sz
1510 * The size of each element, including header and trailer, as returned
1511 * by rte_mempool_calc_obj_size().
1513 * Array of physical addresses of the pages that comprises given memory
1516 * Number of elements in the paddr array.
1518 * LOG2 of the physical pages size.
1520 * On success, the number of bytes needed to store given number of
1521 * objects, aligned to the given page size. If the provided memory
1522 * buffer is too small, return a negative value whose absolute value
1523 * is the actual number of elements that can be stored in that buffer.
1525 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1526 size_t total_elt_sz, const phys_addr_t paddr[], uint32_t pg_num,
1530 * Walk list of all memory pools
1535 * Argument passed to iterator
1537 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1544 #endif /* _RTE_MEMPOOL_H_ */