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 unsigned 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. */
269 * This capability flag is advertised by a mempool handler, if the whole
270 * memory area containing the objects must be physically contiguous.
271 * Note: This flag should not be passed by application.
273 #define MEMPOOL_F_CAPA_PHYS_CONTIG 0x0040
276 * @internal When debug is enabled, store some statistics.
279 * Pointer to the memory pool.
281 * Name of the statistics field to increment in the memory pool.
283 * Number to add to the object-oriented statistics.
285 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
286 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
287 unsigned __lcore_id = rte_lcore_id(); \
288 if (__lcore_id < RTE_MAX_LCORE) { \
289 mp->stats[__lcore_id].name##_objs += n; \
290 mp->stats[__lcore_id].name##_bulk += 1; \
294 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
298 * Calculate the size of the mempool header.
301 * Pointer to the memory pool.
303 * Size of the per-lcore cache.
305 #define MEMPOOL_HEADER_SIZE(mp, cs) \
306 (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
307 (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
309 /* return the header of a mempool object (internal) */
310 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
312 return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
313 sizeof(struct rte_mempool_objhdr));
317 * Return a pointer to the mempool owning this object.
320 * An object that is owned by a pool. If this is not the case,
321 * the behavior is undefined.
323 * A pointer to the mempool structure.
325 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
327 struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
331 /* return the trailer of a mempool object (internal) */
332 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
334 struct rte_mempool *mp = rte_mempool_from_obj(obj);
335 return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
339 * @internal Check and update cookies or panic.
342 * Pointer to the memory pool.
343 * @param obj_table_const
344 * Pointer to a table of void * pointers (objects).
346 * Index of object in object table.
348 * - 0: object is supposed to be allocated, mark it as free
349 * - 1: object is supposed to be free, mark it as allocated
350 * - 2: just check that cookie is valid (free or allocated)
352 void rte_mempool_check_cookies(const struct rte_mempool *mp,
353 void * const *obj_table_const, unsigned n, int free);
355 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
356 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
357 rte_mempool_check_cookies(mp, obj_table_const, n, free)
359 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
360 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
362 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
365 * Prototype for implementation specific data provisioning function.
367 * The function should provide the implementation specific memory for
368 * use by the other mempool ops functions in a given mempool ops struct.
369 * E.g. the default ops provides an instance of the rte_ring for this purpose.
370 * it will most likely point to a different type of data structure, and
371 * will be transparent to the application programmer.
372 * This function should set mp->pool_data.
374 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
377 * Free the opaque private data pointed to by mp->pool_data pointer.
379 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
382 * Enqueue an object into the external pool.
384 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
385 void * const *obj_table, unsigned int n);
388 * Dequeue an object from the external pool.
390 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
391 void **obj_table, unsigned int n);
394 * Return the number of available objects in the external pool.
396 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
399 * Get the mempool capabilities.
401 typedef int (*rte_mempool_get_capabilities_t)(const struct rte_mempool *mp,
402 unsigned int *flags);
404 /** Structure defining mempool operations structure */
405 struct rte_mempool_ops {
406 char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
407 rte_mempool_alloc_t alloc; /**< Allocate private data. */
408 rte_mempool_free_t free; /**< Free the external pool. */
409 rte_mempool_enqueue_t enqueue; /**< Enqueue an object. */
410 rte_mempool_dequeue_t dequeue; /**< Dequeue an object. */
411 rte_mempool_get_count get_count; /**< Get qty of available objs. */
413 * Get the mempool capabilities
415 rte_mempool_get_capabilities_t get_capabilities;
416 } __rte_cache_aligned;
418 #define RTE_MEMPOOL_MAX_OPS_IDX 16 /**< Max registered ops structs */
421 * Structure storing the table of registered ops structs, each of which contain
422 * the function pointers for the mempool ops functions.
423 * Each process has its own storage for this ops struct array so that
424 * the mempools can be shared across primary and secondary processes.
425 * The indices used to access the array are valid across processes, whereas
426 * any function pointers stored directly in the mempool struct would not be.
427 * This results in us simply having "ops_index" in the mempool struct.
429 struct rte_mempool_ops_table {
430 rte_spinlock_t sl; /**< Spinlock for add/delete. */
431 uint32_t num_ops; /**< Number of used ops structs in the table. */
433 * Storage for all possible ops structs.
435 struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
436 } __rte_cache_aligned;
438 /** Array of registered ops structs. */
439 extern struct rte_mempool_ops_table rte_mempool_ops_table;
442 * @internal Get the mempool ops struct from its index.
445 * The index of the ops struct in the ops struct table. It must be a valid
446 * index: (0 <= idx < num_ops).
448 * The pointer to the ops struct in the table.
450 static inline struct rte_mempool_ops *
451 rte_mempool_get_ops(int ops_index)
453 RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
455 return &rte_mempool_ops_table.ops[ops_index];
459 * @internal Wrapper for mempool_ops alloc callback.
462 * Pointer to the memory pool.
464 * - 0: Success; successfully allocated mempool pool_data.
465 * - <0: Error; code of alloc function.
468 rte_mempool_ops_alloc(struct rte_mempool *mp);
471 * @internal Wrapper for mempool_ops dequeue callback.
474 * Pointer to the memory pool.
476 * Pointer to a table of void * pointers (objects).
478 * Number of objects to get.
480 * - 0: Success; got n objects.
481 * - <0: Error; code of dequeue function.
484 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
485 void **obj_table, unsigned n)
487 struct rte_mempool_ops *ops;
489 ops = rte_mempool_get_ops(mp->ops_index);
490 return ops->dequeue(mp, obj_table, n);
494 * @internal wrapper for mempool_ops enqueue callback.
497 * Pointer to the memory pool.
499 * Pointer to a table of void * pointers (objects).
501 * Number of objects to put.
503 * - 0: Success; n objects supplied.
504 * - <0: Error; code of enqueue function.
507 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
510 struct rte_mempool_ops *ops;
512 ops = rte_mempool_get_ops(mp->ops_index);
513 return ops->enqueue(mp, obj_table, n);
517 * @internal wrapper for mempool_ops get_count callback.
520 * Pointer to the memory pool.
522 * The number of available objects in the external pool.
525 rte_mempool_ops_get_count(const struct rte_mempool *mp);
528 * @internal wrapper for mempool_ops get_capabilities callback.
531 * Pointer to the memory pool.
533 * Pointer to the mempool flags.
535 * - 0: Success; The mempool driver has advertised his pool capabilities in
537 * - -ENOTSUP - doesn't support get_capabilities ops (valid case).
538 * - Otherwise, pool create fails.
541 rte_mempool_ops_get_capabilities(const struct rte_mempool *mp,
542 unsigned int *flags);
545 * @internal wrapper for mempool_ops free callback.
548 * Pointer to the memory pool.
551 rte_mempool_ops_free(struct rte_mempool *mp);
554 * Set the ops of a mempool.
556 * This can only be done on a mempool that is not populated, i.e. just after
557 * a call to rte_mempool_create_empty().
560 * Pointer to the memory pool.
562 * Name of the ops structure to use for this mempool.
564 * Opaque data that can be passed by the application to the ops functions.
566 * - 0: Success; the mempool is now using the requested ops functions.
567 * - -EINVAL - Invalid ops struct name provided.
568 * - -EEXIST - mempool already has an ops struct assigned.
571 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
575 * Register mempool operations.
578 * Pointer to an ops structure to register.
580 * - >=0: Success; return the index of the ops struct in the table.
581 * - -EINVAL - some missing callbacks while registering ops struct.
582 * - -ENOSPC - the maximum number of ops structs has been reached.
584 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
587 * Macro to statically register the ops of a mempool handler.
588 * Note that the rte_mempool_register_ops fails silently here when
589 * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
591 #define MEMPOOL_REGISTER_OPS(ops) \
592 void mp_hdlr_init_##ops(void); \
593 void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
595 rte_mempool_register_ops(&ops); \
599 * An object callback function for mempool.
601 * Used by rte_mempool_create() and rte_mempool_obj_iter().
603 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
604 void *opaque, void *obj, unsigned obj_idx);
605 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
608 * A memory callback function for mempool.
610 * Used by rte_mempool_mem_iter().
612 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
613 void *opaque, struct rte_mempool_memhdr *memhdr,
617 * A mempool constructor callback function.
619 * Arguments are the mempool and the opaque pointer given by the user in
620 * rte_mempool_create().
622 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
625 * Create a new mempool named *name* in memory.
627 * This function uses ``rte_memzone_reserve()`` to allocate memory. The
628 * pool contains n elements of elt_size. Its size is set to n.
631 * The name of the mempool.
633 * The number of elements in the mempool. The optimum size (in terms of
634 * memory usage) for a mempool is when n is a power of two minus one:
637 * The size of each element.
639 * If cache_size is non-zero, the rte_mempool library will try to
640 * limit the accesses to the common lockless pool, by maintaining a
641 * per-lcore object cache. This argument must be lower or equal to
642 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
643 * cache_size to have "n modulo cache_size == 0": if this is
644 * not the case, some elements will always stay in the pool and will
645 * never be used. The access to the per-lcore table is of course
646 * faster than the multi-producer/consumer pool. The cache can be
647 * disabled if the cache_size argument is set to 0; it can be useful to
648 * avoid losing objects in cache.
649 * @param private_data_size
650 * The size of the private data appended after the mempool
651 * structure. This is useful for storing some private data after the
652 * mempool structure, as is done for rte_mbuf_pool for example.
654 * A function pointer that is called for initialization of the pool,
655 * before object initialization. The user can initialize the private
656 * data in this function if needed. This parameter can be NULL if
659 * An opaque pointer to data that can be used in the mempool
660 * constructor function.
662 * A function pointer that is called for each object at
663 * initialization of the pool. The user can set some meta data in
664 * objects if needed. This parameter can be NULL if not needed.
665 * The obj_init() function takes the mempool pointer, the init_arg,
666 * the object pointer and the object number as parameters.
667 * @param obj_init_arg
668 * An opaque pointer to data that can be used as an argument for
669 * each call to the object constructor function.
671 * The *socket_id* argument is the socket identifier in the case of
672 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
673 * constraint for the reserved zone.
675 * The *flags* arguments is an OR of following flags:
676 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
677 * between channels in RAM: the pool allocator will add padding
678 * between objects depending on the hardware configuration. See
679 * Memory alignment constraints for details. If this flag is set,
680 * the allocator will just align them to a cache line.
681 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
682 * cache-aligned. This flag removes this constraint, and no
683 * padding will be present between objects. This flag implies
684 * MEMPOOL_F_NO_SPREAD.
685 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
686 * when using rte_mempool_put() or rte_mempool_put_bulk() is
687 * "single-producer". Otherwise, it is "multi-producers".
688 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
689 * when using rte_mempool_get() or rte_mempool_get_bulk() is
690 * "single-consumer". Otherwise, it is "multi-consumers".
691 * - MEMPOOL_F_NO_PHYS_CONTIG: If set, allocated objects won't
692 * necessarily be contiguous in physical memory.
694 * The pointer to the new allocated mempool, on success. NULL on error
695 * with rte_errno set appropriately. Possible rte_errno values include:
696 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
697 * - E_RTE_SECONDARY - function was called from a secondary process instance
698 * - EINVAL - cache size provided is too large
699 * - ENOSPC - the maximum number of memzones has already been allocated
700 * - EEXIST - a memzone with the same name already exists
701 * - ENOMEM - no appropriate memory area found in which to create memzone
704 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
705 unsigned cache_size, unsigned private_data_size,
706 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
707 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
708 int socket_id, unsigned flags);
711 * Create a new mempool named *name* in memory.
713 * The pool contains n elements of elt_size. Its size is set to n.
714 * This function uses ``memzone_reserve()`` to allocate the mempool header
715 * (and the objects if vaddr is NULL).
716 * Depending on the input parameters, mempool elements can be either allocated
717 * together with the mempool header, or an externally provided memory buffer
718 * could be used to store mempool objects. In later case, that external
719 * memory buffer can consist of set of disjoint physical pages.
722 * The name of the mempool.
724 * The number of elements in the mempool. The optimum size (in terms of
725 * memory usage) for a mempool is when n is a power of two minus one:
728 * The size of each element.
730 * Size of the cache. See rte_mempool_create() for details.
731 * @param private_data_size
732 * The size of the private data appended after the mempool
733 * structure. This is useful for storing some private data after the
734 * mempool structure, as is done for rte_mbuf_pool for example.
736 * A function pointer that is called for initialization of the pool,
737 * before object initialization. The user can initialize the private
738 * data in this function if needed. This parameter can be NULL if
741 * An opaque pointer to data that can be used in the mempool
742 * constructor function.
744 * A function called for each object at initialization of the pool.
745 * See rte_mempool_create() for details.
746 * @param obj_init_arg
747 * An opaque pointer passed to the object constructor function.
749 * The *socket_id* argument is the socket identifier in the case of
750 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
751 * constraint for the reserved zone.
753 * Flags controlling the behavior of the mempool. See
754 * rte_mempool_create() for details.
756 * Virtual address of the externally allocated memory buffer.
757 * Will be used to store mempool objects.
759 * Array of physical addresses of the pages that comprises given memory
762 * Number of elements in the paddr array.
764 * LOG2 of the physical pages size.
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_xmem_create(const char *name, unsigned n, unsigned elt_size,
771 unsigned cache_size, unsigned private_data_size,
772 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
773 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
774 int socket_id, unsigned flags, void *vaddr,
775 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift);
778 * Create an empty mempool
780 * The mempool is allocated and initialized, but it is not populated: no
781 * memory is allocated for the mempool elements. The user has to call
782 * rte_mempool_populate_*() to add memory chunks to the pool. Once
783 * populated, the user may also want to initialize each object with
784 * rte_mempool_obj_iter().
787 * The name of the mempool.
789 * The maximum number of elements that can be added in the mempool.
790 * The optimum size (in terms of memory usage) for a mempool is when n
791 * is a power of two minus one: n = (2^q - 1).
793 * The size of each element.
795 * Size of the cache. See rte_mempool_create() for details.
796 * @param private_data_size
797 * The size of the private data appended after the mempool
798 * structure. This is useful for storing some private data after the
799 * mempool structure, as is done for rte_mbuf_pool for example.
801 * The *socket_id* argument is the socket identifier in the case of
802 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
803 * constraint for the reserved zone.
805 * Flags controlling the behavior of the mempool. See
806 * rte_mempool_create() for details.
808 * The pointer to the new allocated mempool, on success. NULL on error
809 * with rte_errno set appropriately. See rte_mempool_create() for details.
812 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
813 unsigned cache_size, unsigned private_data_size,
814 int socket_id, unsigned flags);
818 * Unlink the mempool from global list, free the memory chunks, and all
819 * memory referenced by the mempool. The objects must not be used by
820 * other cores as they will be freed.
823 * A pointer to the mempool structure.
826 rte_mempool_free(struct rte_mempool *mp);
829 * Add physically contiguous memory for objects in the pool at init
831 * Add a virtually and physically contiguous memory chunk in the pool
832 * where objects can be instantiated.
834 * If the given physical address is unknown (paddr = RTE_BAD_PHYS_ADDR),
835 * the chunk doesn't need to be physically contiguous (only virtually),
836 * and allocated objects may span two pages.
839 * A pointer to the mempool structure.
841 * The virtual address of memory that should be used to store objects.
843 * The physical address
845 * The length of memory in bytes.
847 * The callback used to free this chunk when destroying the mempool.
849 * An opaque argument passed to free_cb.
851 * The number of objects added on success.
852 * On error, the chunk is not added in the memory list of the
853 * mempool and a negative errno is returned.
855 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
856 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
860 * Add physical memory for objects in the pool at init
862 * Add a virtually contiguous memory chunk in the pool where objects can
863 * be instantiated. The physical addresses corresponding to the virtual
864 * area are described in paddr[], pg_num, pg_shift.
867 * A pointer to the mempool structure.
869 * The virtual address of memory that should be used to store objects.
871 * An array of physical addresses of each page composing the virtual
874 * Number of elements in the paddr array.
876 * LOG2 of the physical pages size.
878 * The callback used to free this chunk when destroying the mempool.
880 * An opaque argument passed to free_cb.
882 * The number of objects added on success.
883 * On error, the chunks are not added in the memory list of the
884 * mempool and a negative errno is returned.
886 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
887 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
888 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
891 * Add virtually contiguous memory for objects in the pool at init
893 * Add a virtually contiguous memory chunk in the pool where objects can
897 * A pointer to the mempool structure.
899 * The virtual address of memory that should be used to store objects.
900 * Must be page-aligned.
902 * The length of memory in bytes. Must be page-aligned.
904 * The size of memory pages in this virtual area.
906 * The callback used to free this chunk when destroying the mempool.
908 * An opaque argument passed to free_cb.
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.
915 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
916 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
920 * Add memory for objects in the pool at init
922 * This is the default function used by rte_mempool_create() to populate
923 * the mempool. It adds memory allocated using rte_memzone_reserve().
926 * A pointer to the mempool structure.
928 * The number of objects added on success.
929 * On error, the chunk is not added in the memory list of the
930 * mempool and a negative errno is returned.
932 int rte_mempool_populate_default(struct rte_mempool *mp);
935 * Add memory from anonymous mapping for objects in the pool at init
937 * This function mmap an anonymous memory zone that is locked in
938 * memory to store the objects of the mempool.
941 * A pointer to the mempool structure.
943 * The number of objects added on success.
944 * On error, the chunk is not added in the memory list of the
945 * mempool and a negative errno is returned.
947 int rte_mempool_populate_anon(struct rte_mempool *mp);
950 * Call a function for each mempool element
952 * Iterate across all objects attached to a rte_mempool and call the
953 * callback function on it.
956 * A pointer to an initialized mempool.
958 * A function pointer that is called for each object.
960 * An opaque pointer passed to the callback function.
962 * Number of objects iterated.
964 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
965 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
968 * Call a function for each mempool memory chunk
970 * Iterate across all memory chunks attached to a rte_mempool and call
971 * the callback function on it.
974 * A pointer to an initialized mempool.
976 * A function pointer that is called for each memory chunk.
978 * An opaque pointer passed to the callback function.
980 * Number of memory chunks iterated.
982 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
983 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
986 * Dump the status of the mempool to a file.
989 * A pointer to a file for output
991 * A pointer to the mempool structure.
993 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
996 * Create a user-owned mempool cache.
998 * This can be used by non-EAL threads to enable caching when they
999 * interact with a mempool.
1002 * The size of the mempool cache. See rte_mempool_create()'s cache_size
1003 * parameter description for more information. The same limits and
1004 * considerations apply here too.
1006 * The socket identifier in the case of NUMA. The value can be
1007 * SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1009 struct rte_mempool_cache *
1010 rte_mempool_cache_create(uint32_t size, int socket_id);
1013 * Free a user-owned mempool cache.
1016 * A pointer to the mempool cache.
1019 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1022 * Flush a user-owned mempool cache to the specified mempool.
1025 * A pointer to the mempool cache.
1027 * A pointer to the mempool.
1029 static __rte_always_inline void
1030 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1031 struct rte_mempool *mp)
1033 rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1038 * Get a pointer to the per-lcore default mempool cache.
1041 * A pointer to the mempool structure.
1043 * The logical core id.
1045 * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1047 static __rte_always_inline struct rte_mempool_cache *
1048 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1050 if (mp->cache_size == 0)
1053 if (lcore_id >= RTE_MAX_LCORE)
1056 return &mp->local_cache[lcore_id];
1060 * @internal Put several objects back in the mempool; used internally.
1062 * A pointer to the mempool structure.
1064 * A pointer to a table of void * pointers (objects).
1066 * The number of objects to store back in the mempool, must be strictly
1069 * A pointer to a mempool cache structure. May be NULL if not needed.
1071 static __rte_always_inline void
1072 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1073 unsigned int n, struct rte_mempool_cache *cache)
1077 /* increment stat now, adding in mempool always success */
1078 __MEMPOOL_STAT_ADD(mp, put, n);
1080 /* No cache provided or if put would overflow mem allocated for cache */
1081 if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1084 cache_objs = &cache->objs[cache->len];
1087 * The cache follows the following algorithm
1088 * 1. Add the objects to the cache
1089 * 2. Anything greater than the cache min value (if it crosses the
1090 * cache flush threshold) is flushed to the ring.
1093 /* Add elements back into the cache */
1094 rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1098 if (cache->len >= cache->flushthresh) {
1099 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1100 cache->len - cache->size);
1101 cache->len = cache->size;
1108 /* push remaining objects in ring */
1109 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1110 if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1111 rte_panic("cannot put objects in mempool\n");
1113 rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1119 * Put several objects back in the mempool.
1122 * A pointer to the mempool structure.
1124 * A pointer to a table of void * pointers (objects).
1126 * The number of objects to add in the mempool from the obj_table.
1128 * A pointer to a mempool cache structure. May be NULL if not needed.
1130 static __rte_always_inline void
1131 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1132 unsigned int n, struct rte_mempool_cache *cache)
1134 __mempool_check_cookies(mp, obj_table, n, 0);
1135 __mempool_generic_put(mp, obj_table, n, cache);
1139 * Put several objects back in the mempool.
1141 * This function calls the multi-producer or the single-producer
1142 * version depending on the default behavior that was specified at
1143 * mempool creation time (see flags).
1146 * A pointer to the mempool structure.
1148 * A pointer to a table of void * pointers (objects).
1150 * The number of objects to add in the mempool from obj_table.
1152 static __rte_always_inline void
1153 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1156 struct rte_mempool_cache *cache;
1157 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1158 rte_mempool_generic_put(mp, obj_table, n, cache);
1162 * Put one object back in the mempool.
1164 * This function calls the multi-producer or the single-producer
1165 * version depending on the default behavior that was specified at
1166 * mempool creation time (see flags).
1169 * A pointer to the mempool structure.
1171 * A pointer to the object to be added.
1173 static __rte_always_inline void
1174 rte_mempool_put(struct rte_mempool *mp, void *obj)
1176 rte_mempool_put_bulk(mp, &obj, 1);
1180 * @internal Get several objects from the mempool; used internally.
1182 * A pointer to the mempool structure.
1184 * A pointer to a table of void * pointers (objects).
1186 * The number of objects to get, must be strictly positive.
1188 * A pointer to a mempool cache structure. May be NULL if not needed.
1190 * - >=0: Success; number of objects supplied.
1191 * - <0: Error; code of ring dequeue function.
1193 static __rte_always_inline int
1194 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1195 unsigned int n, struct rte_mempool_cache *cache)
1198 uint32_t index, len;
1201 /* No cache provided or cannot be satisfied from cache */
1202 if (unlikely(cache == NULL || n >= cache->size))
1205 cache_objs = cache->objs;
1207 /* Can this be satisfied from the cache? */
1208 if (cache->len < n) {
1209 /* No. Backfill the cache first, and then fill from it */
1210 uint32_t req = n + (cache->size - cache->len);
1212 /* How many do we require i.e. number to fill the cache + the request */
1213 ret = rte_mempool_ops_dequeue_bulk(mp,
1214 &cache->objs[cache->len], req);
1215 if (unlikely(ret < 0)) {
1217 * In the offchance that we are buffer constrained,
1218 * where we are not able to allocate cache + n, go to
1219 * the ring directly. If that fails, we are truly out of
1228 /* Now fill in the response ... */
1229 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1230 *obj_table = cache_objs[len];
1234 __MEMPOOL_STAT_ADD(mp, get_success, n);
1240 /* get remaining objects from ring */
1241 ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1244 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1246 __MEMPOOL_STAT_ADD(mp, get_success, n);
1252 * Get several objects from the mempool.
1254 * If cache is enabled, objects will be retrieved first from cache,
1255 * subsequently from the common pool. Note that it can return -ENOENT when
1256 * the local cache and common pool are empty, even if cache from other
1260 * A pointer to the mempool structure.
1262 * A pointer to a table of void * pointers (objects) that will be filled.
1264 * The number of objects to get from mempool to obj_table.
1266 * A pointer to a mempool cache structure. May be NULL if not needed.
1268 * - 0: Success; objects taken.
1269 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1271 static __rte_always_inline int
1272 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1273 unsigned int n, struct rte_mempool_cache *cache)
1276 ret = __mempool_generic_get(mp, obj_table, n, cache);
1278 __mempool_check_cookies(mp, obj_table, n, 1);
1283 * Get several objects from the mempool.
1285 * This function calls the multi-consumers or the single-consumer
1286 * version, depending on the default behaviour that was specified at
1287 * mempool creation time (see flags).
1289 * If cache is enabled, objects will be retrieved first from cache,
1290 * subsequently from the common pool. Note that it can return -ENOENT when
1291 * the local cache and common pool are empty, even if cache from other
1295 * A pointer to the mempool structure.
1297 * A pointer to a table of void * pointers (objects) that will be filled.
1299 * The number of objects to get from the mempool to obj_table.
1301 * - 0: Success; objects taken
1302 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1304 static __rte_always_inline int
1305 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1307 struct rte_mempool_cache *cache;
1308 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1309 return rte_mempool_generic_get(mp, obj_table, n, cache);
1313 * Get one object from the mempool.
1315 * This function calls the multi-consumers or the single-consumer
1316 * version, depending on the default behavior that was specified at
1317 * mempool creation (see flags).
1319 * If cache is enabled, objects will be retrieved first from cache,
1320 * subsequently from the common pool. Note that it can return -ENOENT when
1321 * the local cache and common pool are empty, even if cache from other
1325 * A pointer to the mempool structure.
1327 * A pointer to a void * pointer (object) that will be filled.
1329 * - 0: Success; objects taken.
1330 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1332 static __rte_always_inline int
1333 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1335 return rte_mempool_get_bulk(mp, obj_p, 1);
1339 * Return the number of entries in the mempool.
1341 * When cache is enabled, this function has to browse the length of
1342 * all lcores, so it should not be used in a data path, but only for
1343 * debug purposes. User-owned mempool caches are not accounted for.
1346 * A pointer to the mempool structure.
1348 * The number of entries in the mempool.
1350 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1353 * Return the number of elements which have been allocated from the mempool
1355 * When cache is enabled, this function has to browse the length of
1356 * all lcores, so it should not be used in a data path, but only for
1360 * A pointer to the mempool structure.
1362 * The number of free entries in the mempool.
1365 rte_mempool_in_use_count(const struct rte_mempool *mp);
1368 * Test if the mempool is full.
1370 * When cache is enabled, this function has to browse the length of all
1371 * lcores, so it should not be used in a data path, but only for debug
1372 * purposes. User-owned mempool caches are not accounted for.
1375 * A pointer to the mempool structure.
1377 * - 1: The mempool is full.
1378 * - 0: The mempool is not full.
1381 rte_mempool_full(const struct rte_mempool *mp)
1383 return !!(rte_mempool_avail_count(mp) == mp->size);
1387 * Test if the mempool is empty.
1389 * When cache is enabled, this function has to browse the length of all
1390 * lcores, so it should not be used in a data path, but only for debug
1391 * purposes. User-owned mempool caches are not accounted for.
1394 * A pointer to the mempool structure.
1396 * - 1: The mempool is empty.
1397 * - 0: The mempool is not empty.
1400 rte_mempool_empty(const struct rte_mempool *mp)
1402 return !!(rte_mempool_avail_count(mp) == 0);
1406 * Return the physical address of elt, which is an element of the pool mp.
1409 * A pointer to the mempool structure.
1411 * A pointer (virtual address) to the element of the pool.
1413 * The physical address of the elt element.
1414 * If the mempool was created with MEMPOOL_F_NO_PHYS_CONTIG, the
1415 * returned value is RTE_BAD_PHYS_ADDR.
1417 static inline phys_addr_t
1418 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1420 const struct rte_mempool_objhdr *hdr;
1421 hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1423 return hdr->physaddr;
1427 * Check the consistency of mempool objects.
1429 * Verify the coherency of fields in the mempool structure. Also check
1430 * that the cookies of mempool objects (even the ones that are not
1431 * present in pool) have a correct value. If not, a panic will occur.
1434 * A pointer to the mempool structure.
1436 void rte_mempool_audit(struct rte_mempool *mp);
1439 * Return a pointer to the private data in an mempool structure.
1442 * A pointer to the mempool structure.
1444 * A pointer to the private data.
1446 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1449 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1453 * Dump the status of all mempools on the console
1456 * A pointer to a file for output
1458 void rte_mempool_list_dump(FILE *f);
1461 * Search a mempool from its name
1464 * The name of the mempool.
1466 * The pointer to the mempool matching the name, or NULL if not found.
1468 * with rte_errno set appropriately. Possible rte_errno values include:
1469 * - ENOENT - required entry not available to return.
1472 struct rte_mempool *rte_mempool_lookup(const char *name);
1475 * Get the header, trailer and total size of a mempool element.
1477 * Given a desired size of the mempool element and mempool flags,
1478 * calculates header, trailer, body and total sizes of the mempool object.
1481 * The size of each element, without header and trailer.
1483 * The flags used for the mempool creation.
1484 * Consult rte_mempool_create() for more information about possible values.
1485 * The size of each element.
1487 * The calculated detailed size the mempool object. May be NULL.
1489 * Total size of the mempool object.
1491 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1492 struct rte_mempool_objsz *sz);
1495 * Get the size of memory required to store mempool elements.
1497 * Calculate the maximum amount of memory required to store given number
1498 * of objects. Assume that the memory buffer will be aligned at page
1501 * Note that if object size is bigger then page size, then it assumes
1502 * that pages are grouped in subsets of physically continuous pages big
1503 * enough to store at least one object.
1506 * Number of elements.
1507 * @param total_elt_sz
1508 * The size of each element, including header and trailer, as returned
1509 * by rte_mempool_calc_obj_size().
1511 * LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1513 * The mempool flags.
1515 * Required memory size aligned at page boundary.
1517 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1518 uint32_t pg_shift, unsigned int flags);
1521 * Get the size of memory required to store mempool elements.
1523 * Calculate how much memory would be actually required with the given
1524 * memory footprint to store required number of objects.
1527 * Virtual address of the externally allocated memory buffer.
1528 * Will be used to store mempool objects.
1530 * Number of elements.
1531 * @param total_elt_sz
1532 * The size of each element, including header and trailer, as returned
1533 * by rte_mempool_calc_obj_size().
1535 * Array of physical addresses of the pages that comprises given memory
1538 * Number of elements in the paddr array.
1540 * LOG2 of the physical pages size.
1542 * The mempool flags.
1544 * On success, the number of bytes needed to store given number of
1545 * objects, aligned to the given page size. If the provided memory
1546 * buffer is too small, return a negative value whose absolute value
1547 * is the actual number of elements that can be stored in that buffer.
1549 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1550 size_t total_elt_sz, const phys_addr_t paddr[], uint32_t pg_num,
1551 uint32_t pg_shift, unsigned int flags);
1554 * Walk list of all memory pools
1559 * Argument passed to iterator
1561 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1568 #endif /* _RTE_MEMPOOL_H_ */