4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_MEMPOOL_H_
35 #define _RTE_MEMPOOL_H_
41 * A memory pool is an allocator of fixed-size object. It is
42 * identified by its name, and uses a ring to store free objects. It
43 * provides some other optional services, like a per-core object
44 * cache, and an alignment helper to ensure that objects are padded
45 * to spread them equally on all RAM channels, ranks, and so on.
47 * Objects owned by a mempool should never be added in another
48 * mempool. When an object is freed using rte_mempool_put() or
49 * equivalent, the object data is not modified; the user can save some
50 * meta-data in the object data and retrieve them when allocating a
53 * Note: the mempool implementation is not preemptable. A lcore must
54 * not be interrupted by another task that uses the same mempool
55 * (because it uses a ring which is not preemptable). Also, mempool
56 * functions must not be used outside the DPDK environment: for
57 * example, in linuxapp environment, a thread that is not created by
58 * the EAL must not use mempools. This is due to the per-lcore cache
59 * that won't work as rte_lcore_id() will not return a correct value.
67 #include <sys/queue.h>
70 #include <rte_debug.h>
71 #include <rte_lcore.h>
72 #include <rte_memory.h>
73 #include <rte_branch_prediction.h>
80 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
81 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
82 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
84 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
86 * A structure that stores the mempool statistics (per-lcore).
88 struct rte_mempool_debug_stats {
89 uint64_t put_bulk; /**< Number of puts. */
90 uint64_t put_objs; /**< Number of objects successfully put. */
91 uint64_t get_success_bulk; /**< Successful allocation number. */
92 uint64_t get_success_objs; /**< Objects successfully allocated. */
93 uint64_t get_fail_bulk; /**< Failed allocation number. */
94 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
95 } __rte_cache_aligned;
98 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
100 * A structure that stores a per-core object cache.
102 struct rte_mempool_cache {
103 unsigned len; /**< Cache len */
105 * Cache is allocated to this size to allow it to overflow in certain
106 * cases to avoid needless emptying of cache.
108 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
109 } __rte_cache_aligned;
110 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
112 struct rte_mempool_objsz {
113 uint32_t elt_size; /**< Size of an element. */
114 uint32_t header_size; /**< Size of header (before elt). */
115 uint32_t trailer_size; /**< Size of trailer (after elt). */
117 /**< Total size of an object (header + elt + trailer). */
120 #define RTE_MEMPOOL_NAMESIZE 32 /**< Maximum length of a memory pool. */
121 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
124 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
126 #ifdef RTE_LIBRTE_XEN_DOM0
128 /* "<name>_MP_elt" */
129 #define RTE_MEMPOOL_OBJ_NAME "%s_" RTE_MEMPOOL_MZ_PREFIX "elt"
133 #define RTE_MEMPOOL_OBJ_NAME RTE_MEMPOOL_MZ_FORMAT
135 #endif /* RTE_LIBRTE_XEN_DOM0 */
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
143 * The RTE mempool structure.
146 char name[RTE_MEMPOOL_NAMESIZE]; /**< Name of mempool. */
147 struct rte_ring *ring; /**< Ring to store objects. */
148 phys_addr_t phys_addr; /**< Phys. addr. of mempool struct. */
149 int flags; /**< Flags of the mempool. */
150 uint32_t size; /**< Size of the mempool. */
151 uint32_t cache_size; /**< Size of per-lcore local cache. */
152 uint32_t cache_flushthresh;
153 /**< Threshold before we flush excess elements. */
155 uint32_t elt_size; /**< Size of an element. */
156 uint32_t header_size; /**< Size of header (before elt). */
157 uint32_t trailer_size; /**< Size of trailer (after elt). */
159 unsigned private_data_size; /**< Size of private data. */
161 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
162 /** Per-lcore local cache. */
163 struct rte_mempool_cache local_cache[RTE_MAX_LCORE];
166 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
167 /** Per-lcore statistics. */
168 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
171 /* Address translation support, starts from next cache line. */
173 /** Number of elements in the elt_pa array. */
174 uint32_t pg_num __rte_cache_aligned;
175 uint32_t pg_shift; /**< LOG2 of the physical pages. */
176 uintptr_t pg_mask; /**< physical page mask value. */
177 uintptr_t elt_va_start;
178 /**< Virtual address of the first mempool object. */
179 uintptr_t elt_va_end;
180 /**< Virtual address of the <size + 1> mempool object. */
181 phys_addr_t elt_pa[MEMPOOL_PG_NUM_DEFAULT];
182 /**< Array of physical pages addresses for the mempool objects buffer. */
184 } __rte_cache_aligned;
186 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread in memory. */
187 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
188 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
189 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
192 * @internal When debug is enabled, store some statistics.
194 * Pointer to the memory pool.
196 * Name of the statistics field to increment in the memory pool.
198 * Number to add to the object-oriented statistics.
200 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
201 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
202 unsigned __lcore_id = rte_lcore_id(); \
203 mp->stats[__lcore_id].name##_objs += n; \
204 mp->stats[__lcore_id].name##_bulk += 1; \
207 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
211 * Calculates size of the mempool header.
213 * Pointer to the memory pool.
215 * Number of page used to store mempool objects.
217 #define MEMPOOL_HEADER_SIZE(mp, pgn) (sizeof(*(mp)) + \
218 RTE_ALIGN_CEIL(((pgn) - RTE_DIM((mp)->elt_pa)) * \
219 sizeof ((mp)->elt_pa[0]), RTE_CACHE_LINE_SIZE))
222 * Returns TRUE if whole mempool is allocated in one contiguous block of memory.
224 #define MEMPOOL_IS_CONTIG(mp) \
225 ((mp)->pg_num == MEMPOOL_PG_NUM_DEFAULT && \
226 (mp)->phys_addr == (mp)->elt_pa[0])
229 * @internal Get a pointer to a mempool pointer in the object header.
233 * The pointer to the mempool from which the object was allocated.
235 static inline struct rte_mempool **__mempool_from_obj(void *obj)
237 struct rte_mempool **mpp;
240 off = sizeof(struct rte_mempool *);
241 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
242 off += sizeof(uint64_t);
244 mpp = (struct rte_mempool **)((char *)obj - off);
249 * Return a pointer to the mempool owning this object.
252 * An object that is owned by a pool. If this is not the case,
253 * the behavior is undefined.
255 * A pointer to the mempool structure.
257 static inline const struct rte_mempool *rte_mempool_from_obj(void *obj)
259 struct rte_mempool * const *mpp;
260 mpp = __mempool_from_obj(obj);
264 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
265 /* get header cookie value */
266 static inline uint64_t __mempool_read_header_cookie(const void *obj)
268 return *(const uint64_t *)((const char *)obj - sizeof(uint64_t));
271 /* get trailer cookie value */
272 static inline uint64_t __mempool_read_trailer_cookie(void *obj)
274 struct rte_mempool **mpp = __mempool_from_obj(obj);
275 return *(uint64_t *)((char *)obj + (*mpp)->elt_size);
278 /* write header cookie value */
279 static inline void __mempool_write_header_cookie(void *obj, int free)
282 cookie_p = (uint64_t *)((char *)obj - sizeof(uint64_t));
284 *cookie_p = RTE_MEMPOOL_HEADER_COOKIE1;
286 *cookie_p = RTE_MEMPOOL_HEADER_COOKIE2;
290 /* write trailer cookie value */
291 static inline void __mempool_write_trailer_cookie(void *obj)
294 struct rte_mempool **mpp = __mempool_from_obj(obj);
295 cookie_p = (uint64_t *)((char *)obj + (*mpp)->elt_size);
296 *cookie_p = RTE_MEMPOOL_TRAILER_COOKIE;
298 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
301 * @internal Check and update cookies or panic.
304 * Pointer to the memory pool.
305 * @param obj_table_const
306 * Pointer to a table of void * pointers (objects).
308 * Index of object in object table.
310 * - 0: object is supposed to be allocated, mark it as free
311 * - 1: object is supposed to be free, mark it as allocated
312 * - 2: just check that cookie is valid (free or allocated)
314 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
315 #ifndef __INTEL_COMPILER
316 #pragma GCC diagnostic ignored "-Wcast-qual"
318 static inline void __mempool_check_cookies(const struct rte_mempool *mp,
319 void * const *obj_table_const,
320 unsigned n, int free)
327 /* Force to drop the "const" attribute. This is done only when
328 * DEBUG is enabled */
329 tmp = (void *) obj_table_const;
330 obj_table = (void **) tmp;
335 if (rte_mempool_from_obj(obj) != mp)
336 rte_panic("MEMPOOL: object is owned by another "
339 cookie = __mempool_read_header_cookie(obj);
342 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
343 rte_log_set_history(0);
344 RTE_LOG(CRIT, MEMPOOL,
345 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
347 rte_panic("MEMPOOL: bad header cookie (put)\n");
349 __mempool_write_header_cookie(obj, 1);
351 else if (free == 1) {
352 if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
353 rte_log_set_history(0);
354 RTE_LOG(CRIT, MEMPOOL,
355 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
357 rte_panic("MEMPOOL: bad header cookie (get)\n");
359 __mempool_write_header_cookie(obj, 0);
361 else if (free == 2) {
362 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
363 cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
364 rte_log_set_history(0);
365 RTE_LOG(CRIT, MEMPOOL,
366 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
368 rte_panic("MEMPOOL: bad header cookie (audit)\n");
371 cookie = __mempool_read_trailer_cookie(obj);
372 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
373 rte_log_set_history(0);
374 RTE_LOG(CRIT, MEMPOOL,
375 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
377 rte_panic("MEMPOOL: bad trailer cookie\n");
381 #ifndef __INTEL_COMPILER
382 #pragma GCC diagnostic error "-Wcast-qual"
385 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
386 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
389 * An mempool's object iterator callback function.
391 typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/,
392 void * /*obj_start*/,
394 uint32_t /*obj_index */);
397 * Iterates across objects of the given size and alignment in the
398 * provided chunk of memory. The given memory buffer can consist of
399 * disjoint physical pages.
400 * For each object calls the provided callback (if any).
401 * Used to populate mempool, walk through all elements of the mempool,
402 * estimate how many elements of the given size could be created in the given
405 * Virtual address of the memory buffer.
407 * Maximum number of objects to iterate through.
409 * Size of each object.
411 * Array of phyiscall addresses of the pages that comprises given memory
414 * Number of elements in the paddr array.
416 * LOG2 of the physical pages size.
418 * Object iterator callback function (could be NULL).
419 * @param obj_iter_arg
420 * User defined Prameter for the object iterator callback function.
423 * Number of objects iterated through.
426 uint32_t rte_mempool_obj_iter(void *vaddr,
427 uint32_t elt_num, size_t elt_sz, size_t align,
428 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
429 rte_mempool_obj_iter_t obj_iter, void *obj_iter_arg);
432 * An object constructor callback function for mempool.
434 * Arguments are the mempool, the opaque pointer given by the user in
435 * rte_mempool_create(), the pointer to the element and the index of
436 * the element in the pool.
438 typedef void (rte_mempool_obj_ctor_t)(struct rte_mempool *, void *,
442 * A mempool constructor callback function.
444 * Arguments are the mempool and the opaque pointer given by the user in
445 * rte_mempool_create().
447 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
450 * Creates a new mempool named *name* in memory.
452 * This function uses ``memzone_reserve()`` to allocate memory. The
453 * pool contains n elements of elt_size. Its size is set to n.
454 * All elements of the mempool are allocated together with the mempool header,
455 * in one physically continuous chunk of memory.
458 * The name of the mempool.
460 * The number of elements in the mempool. The optimum size (in terms of
461 * memory usage) for a mempool is when n is a power of two minus one:
464 * The size of each element.
466 * If cache_size is non-zero, the rte_mempool library will try to
467 * limit the accesses to the common lockless pool, by maintaining a
468 * per-lcore object cache. This argument must be lower or equal to
469 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE. It is advised to choose
470 * cache_size to have "n modulo cache_size == 0": if this is
471 * not the case, some elements will always stay in the pool and will
472 * never be used. The access to the per-lcore table is of course
473 * faster than the multi-producer/consumer pool. The cache can be
474 * disabled if the cache_size argument is set to 0; it can be useful to
475 * avoid losing objects in cache. Note that even if not used, the
476 * memory space for cache is always reserved in a mempool structure,
477 * except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
478 * @param private_data_size
479 * The size of the private data appended after the mempool
480 * structure. This is useful for storing some private data after the
481 * mempool structure, as is done for rte_mbuf_pool for example.
483 * A function pointer that is called for initialization of the pool,
484 * before object initialization. The user can initialize the private
485 * data in this function if needed. This parameter can be NULL if
488 * An opaque pointer to data that can be used in the mempool
489 * constructor function.
491 * A function pointer that is called for each object at
492 * initialization of the pool. The user can set some meta data in
493 * objects if needed. This parameter can be NULL if not needed.
494 * The obj_init() function takes the mempool pointer, the init_arg,
495 * the object pointer and the object number as parameters.
496 * @param obj_init_arg
497 * An opaque pointer to data that can be used as an argument for
498 * each call to the object constructor function.
500 * The *socket_id* argument is the socket identifier in the case of
501 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
502 * constraint for the reserved zone.
504 * The *flags* arguments is an OR of following flags:
505 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
506 * between channels in RAM: the pool allocator will add padding
507 * between objects depending on the hardware configuration. See
508 * Memory alignment constraints for details. If this flag is set,
509 * the allocator will just align them to a cache line.
510 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
511 * cache-aligned. This flag removes this constraint, and no
512 * padding will be present between objects. This flag implies
513 * MEMPOOL_F_NO_SPREAD.
514 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
515 * when using rte_mempool_put() or rte_mempool_put_bulk() is
516 * "single-producer". Otherwise, it is "multi-producers".
517 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
518 * when using rte_mempool_get() or rte_mempool_get_bulk() is
519 * "single-consumer". Otherwise, it is "multi-consumers".
521 * The pointer to the new allocated mempool, on success. NULL on error
522 * with rte_errno set appropriately. Possible rte_errno values include:
523 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
524 * - E_RTE_SECONDARY - function was called from a secondary process instance
525 * - E_RTE_NO_TAILQ - no tailq list could be got for the ring or mempool list
526 * - EINVAL - cache size provided is too large
527 * - ENOSPC - the maximum number of memzones has already been allocated
528 * - EEXIST - a memzone with the same name already exists
529 * - ENOMEM - no appropriate memory area found in which to create memzone
532 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
533 unsigned cache_size, unsigned private_data_size,
534 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
535 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
536 int socket_id, unsigned flags);
539 * Creates a new mempool named *name* in memory.
541 * This function uses ``memzone_reserve()`` to allocate memory. The
542 * pool contains n elements of elt_size. Its size is set to n.
543 * Depending on the input parameters, mempool elements can be either allocated
544 * together with the mempool header, or an externally provided memory buffer
545 * could be used to store mempool objects. In later case, that external
546 * memory buffer can consist of set of disjoint phyiscal pages.
549 * The name of the mempool.
551 * The number of elements in the mempool. The optimum size (in terms of
552 * memory usage) for a mempool is when n is a power of two minus one:
555 * The size of each element.
557 * If cache_size is non-zero, the rte_mempool library will try to
558 * limit the accesses to the common lockless pool, by maintaining a
559 * per-lcore object cache. This argument must be lower or equal to
560 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE. It is advised to choose
561 * cache_size to have "n modulo cache_size == 0": if this is
562 * not the case, some elements will always stay in the pool and will
563 * never be used. The access to the per-lcore table is of course
564 * faster than the multi-producer/consumer pool. The cache can be
565 * disabled if the cache_size argument is set to 0; it can be useful to
566 * avoid losing objects in cache. Note that even if not used, the
567 * memory space for cache is always reserved in a mempool structure,
568 * except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
569 * @param private_data_size
570 * The size of the private data appended after the mempool
571 * structure. This is useful for storing some private data after the
572 * mempool structure, as is done for rte_mbuf_pool for example.
574 * A function pointer that is called for initialization of the pool,
575 * before object initialization. The user can initialize the private
576 * data in this function if needed. This parameter can be NULL if
579 * An opaque pointer to data that can be used in the mempool
580 * constructor function.
582 * A function pointer that is called for each object at
583 * initialization of the pool. The user can set some meta data in
584 * objects if needed. This parameter can be NULL if not needed.
585 * The obj_init() function takes the mempool pointer, the init_arg,
586 * the object pointer and the object number as parameters.
587 * @param obj_init_arg
588 * An opaque pointer to data that can be used as an argument for
589 * each call to the object constructor function.
591 * The *socket_id* argument is the socket identifier in the case of
592 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
593 * constraint for the reserved zone.
595 * The *flags* arguments is an OR of following flags:
596 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
597 * between channels in RAM: the pool allocator will add padding
598 * between objects depending on the hardware configuration. See
599 * Memory alignment constraints for details. If this flag is set,
600 * the allocator will just align them to a cache line.
601 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
602 * cache-aligned. This flag removes this constraint, and no
603 * padding will be present between objects. This flag implies
604 * MEMPOOL_F_NO_SPREAD.
605 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
606 * when using rte_mempool_put() or rte_mempool_put_bulk() is
607 * "single-producer". Otherwise, it is "multi-producers".
608 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
609 * when using rte_mempool_get() or rte_mempool_get_bulk() is
610 * "single-consumer". Otherwise, it is "multi-consumers".
612 * Virtual address of the externally allocated memory buffer.
613 * Will be used to store mempool objects.
615 * Array of phyiscall addresses of the pages that comprises given memory
618 * Number of elements in the paddr array.
620 * LOG2 of the physical pages size.
622 * The pointer to the new allocated mempool, on success. NULL on error
623 * with rte_errno set appropriately. Possible rte_errno values include:
624 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
625 * - E_RTE_SECONDARY - function was called from a secondary process instance
626 * - E_RTE_NO_TAILQ - no tailq list could be got for the ring or mempool list
627 * - EINVAL - cache size provided is too large
628 * - ENOSPC - the maximum number of memzones has already been allocated
629 * - EEXIST - a memzone with the same name already exists
630 * - ENOMEM - no appropriate memory area found in which to create memzone
633 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
634 unsigned cache_size, unsigned private_data_size,
635 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
636 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
637 int socket_id, unsigned flags, void *vaddr,
638 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift);
640 #ifdef RTE_LIBRTE_XEN_DOM0
642 * Creates a new mempool named *name* in memory on Xen Dom0.
644 * This function uses ``rte_mempool_xmem_create()`` to allocate memory. The
645 * pool contains n elements of elt_size. Its size is set to n.
646 * All elements of the mempool are allocated together with the mempool header,
647 * and memory buffer can consist of set of disjoint phyiscal pages.
650 * The name of the mempool.
652 * The number of elements in the mempool. The optimum size (in terms of
653 * memory usage) for a mempool is when n is a power of two minus one:
656 * The size of each element.
658 * If cache_size is non-zero, the rte_mempool library will try to
659 * limit the accesses to the common lockless pool, by maintaining a
660 * per-lcore object cache. This argument must be lower or equal to
661 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE. It is advised to choose
662 * cache_size to have "n modulo cache_size == 0": if this is
663 * not the case, some elements will always stay in the pool and will
664 * never be used. The access to the per-lcore table is of course
665 * faster than the multi-producer/consumer pool. The cache can be
666 * disabled if the cache_size argument is set to 0; it can be useful to
667 * avoid losing objects in cache. Note that even if not used, the
668 * memory space for cache is always reserved in a mempool structure,
669 * except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
670 * @param private_data_size
671 * The size of the private data appended after the mempool
672 * structure. This is useful for storing some private data after the
673 * mempool structure, as is done for rte_mbuf_pool for example.
675 * A function pointer that is called for initialization of the pool,
676 * before object initialization. The user can initialize the private
677 * data in this function if needed. This parameter can be NULL if
680 * An opaque pointer to data that can be used in the mempool
681 * constructor function.
683 * A function pointer that is called for each object at
684 * initialization of the pool. The user can set some meta data in
685 * objects if needed. This parameter can be NULL if not needed.
686 * The obj_init() function takes the mempool pointer, the init_arg,
687 * the object pointer and the object number as parameters.
688 * @param obj_init_arg
689 * An opaque pointer to data that can be used as an argument for
690 * each call to the object constructor function.
692 * The *socket_id* argument is the socket identifier in the case of
693 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
694 * constraint for the reserved zone.
696 * The *flags* arguments is an OR of following flags:
697 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
698 * between channels in RAM: the pool allocator will add padding
699 * between objects depending on the hardware configuration. See
700 * Memory alignment constraints for details. If this flag is set,
701 * the allocator will just align them to a cache line.
702 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
703 * cache-aligned. This flag removes this constraint, and no
704 * padding will be present between objects. This flag implies
705 * MEMPOOL_F_NO_SPREAD.
706 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
707 * when using rte_mempool_put() or rte_mempool_put_bulk() is
708 * "single-producer". Otherwise, it is "multi-producers".
709 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
710 * when using rte_mempool_get() or rte_mempool_get_bulk() is
711 * "single-consumer". Otherwise, it is "multi-consumers".
713 * The pointer to the new allocated mempool, on success. NULL on error
714 * with rte_errno set appropriately. Possible rte_errno values include:
715 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
716 * - E_RTE_SECONDARY - function was called from a secondary process instance
717 * - E_RTE_NO_TAILQ - no tailq list could be got for the ring or mempool list
718 * - EINVAL - cache size provided is too large
719 * - ENOSPC - the maximum number of memzones has already been allocated
720 * - EEXIST - a memzone with the same name already exists
721 * - ENOMEM - no appropriate memory area found in which to create memzone
724 rte_dom0_mempool_create(const char *name, unsigned n, unsigned elt_size,
725 unsigned cache_size, unsigned private_data_size,
726 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
727 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
728 int socket_id, unsigned flags);
732 * Dump the status of the mempool to the console.
735 * A pointer to a file for output
737 * A pointer to the mempool structure.
739 void rte_mempool_dump(FILE *f, const struct rte_mempool *mp);
742 * @internal Put several objects back in the mempool; used internally.
744 * A pointer to the mempool structure.
746 * A pointer to a table of void * pointers (objects).
748 * The number of objects to store back in the mempool, must be strictly
751 * Mono-producer (0) or multi-producers (1).
753 static inline void __attribute__((always_inline))
754 __mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
755 unsigned n, int is_mp)
757 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
758 struct rte_mempool_cache *cache;
761 unsigned lcore_id = rte_lcore_id();
762 uint32_t cache_size = mp->cache_size;
763 uint32_t flushthresh = mp->cache_flushthresh;
764 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
766 /* increment stat now, adding in mempool always success */
767 __MEMPOOL_STAT_ADD(mp, put, n);
769 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
770 /* cache is not enabled or single producer */
771 if (unlikely(cache_size == 0 || is_mp == 0))
774 /* Go straight to ring if put would overflow mem allocated for cache */
775 if (unlikely(n > RTE_MEMPOOL_CACHE_MAX_SIZE))
778 cache = &mp->local_cache[lcore_id];
779 cache_objs = &cache->objs[cache->len];
782 * The cache follows the following algorithm
783 * 1. Add the objects to the cache
784 * 2. Anything greater than the cache min value (if it crosses the
785 * cache flush threshold) is flushed to the ring.
788 /* Add elements back into the cache */
789 for (index = 0; index < n; ++index, obj_table++)
790 cache_objs[index] = *obj_table;
794 if (cache->len >= flushthresh) {
795 rte_ring_mp_enqueue_bulk(mp->ring, &cache->objs[cache_size],
796 cache->len - cache_size);
797 cache->len = cache_size;
803 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
805 /* push remaining objects in ring */
806 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
808 if (rte_ring_mp_enqueue_bulk(mp->ring, obj_table, n) < 0)
809 rte_panic("cannot put objects in mempool\n");
812 if (rte_ring_sp_enqueue_bulk(mp->ring, obj_table, n) < 0)
813 rte_panic("cannot put objects in mempool\n");
817 rte_ring_mp_enqueue_bulk(mp->ring, obj_table, n);
819 rte_ring_sp_enqueue_bulk(mp->ring, obj_table, n);
825 * Put several objects back in the mempool (multi-producers safe).
828 * A pointer to the mempool structure.
830 * A pointer to a table of void * pointers (objects).
832 * The number of objects to add in the mempool from the obj_table.
834 static inline void __attribute__((always_inline))
835 rte_mempool_mp_put_bulk(struct rte_mempool *mp, void * const *obj_table,
838 __mempool_check_cookies(mp, obj_table, n, 0);
839 __mempool_put_bulk(mp, obj_table, n, 1);
843 * Put several objects back in the mempool (NOT multi-producers safe).
846 * A pointer to the mempool structure.
848 * A pointer to a table of void * pointers (objects).
850 * The number of objects to add in the mempool from obj_table.
853 rte_mempool_sp_put_bulk(struct rte_mempool *mp, void * const *obj_table,
856 __mempool_check_cookies(mp, obj_table, n, 0);
857 __mempool_put_bulk(mp, obj_table, n, 0);
861 * Put several objects back in the mempool.
863 * This function calls the multi-producer or the single-producer
864 * version depending on the default behavior that was specified at
865 * mempool creation time (see flags).
868 * A pointer to the mempool structure.
870 * A pointer to a table of void * pointers (objects).
872 * The number of objects to add in the mempool from obj_table.
874 static inline void __attribute__((always_inline))
875 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
878 __mempool_check_cookies(mp, obj_table, n, 0);
879 __mempool_put_bulk(mp, obj_table, n, !(mp->flags & MEMPOOL_F_SP_PUT));
883 * Put one object in the mempool (multi-producers safe).
886 * A pointer to the mempool structure.
888 * A pointer to the object to be added.
890 static inline void __attribute__((always_inline))
891 rte_mempool_mp_put(struct rte_mempool *mp, void *obj)
893 rte_mempool_mp_put_bulk(mp, &obj, 1);
897 * Put one object back in the mempool (NOT multi-producers safe).
900 * A pointer to the mempool structure.
902 * A pointer to the object to be added.
904 static inline void __attribute__((always_inline))
905 rte_mempool_sp_put(struct rte_mempool *mp, void *obj)
907 rte_mempool_sp_put_bulk(mp, &obj, 1);
911 * Put one object back in the mempool.
913 * This function calls the multi-producer or the single-producer
914 * version depending on the default behavior that was specified at
915 * mempool creation time (see flags).
918 * A pointer to the mempool structure.
920 * A pointer to the object to be added.
922 static inline void __attribute__((always_inline))
923 rte_mempool_put(struct rte_mempool *mp, void *obj)
925 rte_mempool_put_bulk(mp, &obj, 1);
929 * @internal Get several objects from the mempool; used internally.
931 * A pointer to the mempool structure.
933 * A pointer to a table of void * pointers (objects).
935 * The number of objects to get, must be strictly positive.
937 * Mono-consumer (0) or multi-consumers (1).
939 * - >=0: Success; number of objects supplied.
940 * - <0: Error; code of ring dequeue function.
942 static inline int __attribute__((always_inline))
943 __mempool_get_bulk(struct rte_mempool *mp, void **obj_table,
944 unsigned n, int is_mc)
947 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
948 struct rte_mempool_cache *cache;
951 unsigned lcore_id = rte_lcore_id();
952 uint32_t cache_size = mp->cache_size;
954 /* cache is not enabled or single consumer */
955 if (unlikely(cache_size == 0 || is_mc == 0 || n >= cache_size))
958 cache = &mp->local_cache[lcore_id];
959 cache_objs = cache->objs;
961 /* Can this be satisfied from the cache? */
962 if (cache->len < n) {
963 /* No. Backfill the cache first, and then fill from it */
964 uint32_t req = n + (cache_size - cache->len);
966 /* How many do we require i.e. number to fill the cache + the request */
967 ret = rte_ring_mc_dequeue_bulk(mp->ring, &cache->objs[cache->len], req);
968 if (unlikely(ret < 0)) {
970 * In the offchance that we are buffer constrained,
971 * where we are not able to allocate cache + n, go to
972 * the ring directly. If that fails, we are truly out of
981 /* Now fill in the response ... */
982 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
983 *obj_table = cache_objs[len];
987 __MEMPOOL_STAT_ADD(mp, get_success, n);
992 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
994 /* get remaining objects from ring */
996 ret = rte_ring_mc_dequeue_bulk(mp->ring, obj_table, n);
998 ret = rte_ring_sc_dequeue_bulk(mp->ring, obj_table, n);
1001 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1003 __MEMPOOL_STAT_ADD(mp, get_success, n);
1009 * Get several objects from the mempool (multi-consumers safe).
1011 * If cache is enabled, objects will be retrieved first from cache,
1012 * subsequently from the common pool. Note that it can return -ENOENT when
1013 * the local cache and common pool are empty, even if cache from other
1017 * A pointer to the mempool structure.
1019 * A pointer to a table of void * pointers (objects) that will be filled.
1021 * The number of objects to get from mempool to obj_table.
1023 * - 0: Success; objects taken.
1024 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1026 static inline int __attribute__((always_inline))
1027 rte_mempool_mc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1030 ret = __mempool_get_bulk(mp, obj_table, n, 1);
1032 __mempool_check_cookies(mp, obj_table, n, 1);
1037 * Get several objects from the mempool (NOT multi-consumers safe).
1039 * If cache is enabled, objects will be retrieved first from cache,
1040 * subsequently from the common pool. Note that it can return -ENOENT when
1041 * the local cache and common pool are empty, even if cache from other
1045 * A pointer to the mempool structure.
1047 * A pointer to a table of void * pointers (objects) that will be filled.
1049 * The number of objects to get from the mempool to obj_table.
1051 * - 0: Success; objects taken.
1052 * - -ENOENT: Not enough entries in the mempool; no object is
1055 static inline int __attribute__((always_inline))
1056 rte_mempool_sc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1059 ret = __mempool_get_bulk(mp, obj_table, n, 0);
1061 __mempool_check_cookies(mp, obj_table, n, 1);
1066 * Get several objects from the mempool.
1068 * This function calls the multi-consumers or the single-consumer
1069 * version, depending on the default behaviour that was specified at
1070 * mempool creation time (see flags).
1072 * If cache is enabled, objects will be retrieved first from cache,
1073 * subsequently from the common pool. Note that it can return -ENOENT when
1074 * the local cache and common pool are empty, even if cache from other
1078 * A pointer to the mempool structure.
1080 * A pointer to a table of void * pointers (objects) that will be filled.
1082 * The number of objects to get from the mempool to obj_table.
1084 * - 0: Success; objects taken
1085 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1087 static inline int __attribute__((always_inline))
1088 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1091 ret = __mempool_get_bulk(mp, obj_table, n,
1092 !(mp->flags & MEMPOOL_F_SC_GET));
1094 __mempool_check_cookies(mp, obj_table, n, 1);
1099 * Get one object from the mempool (multi-consumers safe).
1101 * If cache is enabled, objects will be retrieved first from cache,
1102 * subsequently from the common pool. Note that it can return -ENOENT when
1103 * the local cache and common pool are empty, even if cache from other
1107 * A pointer to the mempool structure.
1109 * A pointer to a void * pointer (object) that will be filled.
1111 * - 0: Success; objects taken.
1112 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1114 static inline int __attribute__((always_inline))
1115 rte_mempool_mc_get(struct rte_mempool *mp, void **obj_p)
1117 return rte_mempool_mc_get_bulk(mp, obj_p, 1);
1121 * Get one object from the mempool (NOT multi-consumers safe).
1123 * If cache is enabled, objects will be retrieved first from cache,
1124 * subsequently from the common pool. Note that it can return -ENOENT when
1125 * the local cache and common pool are empty, even if cache from other
1129 * A pointer to the mempool structure.
1131 * A pointer to a void * pointer (object) that will be filled.
1133 * - 0: Success; objects taken.
1134 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1136 static inline int __attribute__((always_inline))
1137 rte_mempool_sc_get(struct rte_mempool *mp, void **obj_p)
1139 return rte_mempool_sc_get_bulk(mp, obj_p, 1);
1143 * Get one object from the mempool.
1145 * This function calls the multi-consumers or the single-consumer
1146 * version, depending on the default behavior that was specified at
1147 * mempool creation (see flags).
1149 * If cache is enabled, objects will be retrieved first from cache,
1150 * subsequently from the common pool. Note that it can return -ENOENT when
1151 * the local cache and common pool are empty, even if cache from other
1155 * A pointer to the mempool structure.
1157 * A pointer to a void * pointer (object) that will be filled.
1159 * - 0: Success; objects taken.
1160 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1162 static inline int __attribute__((always_inline))
1163 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1165 return rte_mempool_get_bulk(mp, obj_p, 1);
1169 * Return the number of entries in the mempool.
1171 * When cache is enabled, this function has to browse the length of
1172 * all lcores, so it should not be used in a data path, but only for
1176 * A pointer to the mempool structure.
1178 * The number of entries in the mempool.
1180 unsigned rte_mempool_count(const struct rte_mempool *mp);
1183 * Return the number of free entries in the mempool ring.
1184 * i.e. how many entries can be freed back to the mempool.
1186 * NOTE: This corresponds to the number of elements *allocated* from the
1187 * memory pool, not the number of elements in the pool itself. To count
1188 * the number elements currently available in the pool, use "rte_mempool_count"
1190 * When cache is enabled, this function has to browse the length of
1191 * all lcores, so it should not be used in a data path, but only for
1195 * A pointer to the mempool structure.
1197 * The number of free entries in the mempool.
1199 static inline unsigned
1200 rte_mempool_free_count(const struct rte_mempool *mp)
1202 return mp->size - rte_mempool_count(mp);
1206 * Test if the mempool is full.
1208 * When cache is enabled, this function has to browse the length of all
1209 * lcores, so it should not be used in a data path, but only for debug
1213 * A pointer to the mempool structure.
1215 * - 1: The mempool is full.
1216 * - 0: The mempool is not full.
1219 rte_mempool_full(const struct rte_mempool *mp)
1221 return !!(rte_mempool_count(mp) == mp->size);
1225 * Test if the mempool is empty.
1227 * When cache is enabled, this function has to browse the length of all
1228 * lcores, so it should not be used in a data path, but only for debug
1232 * A pointer to the mempool structure.
1234 * - 1: The mempool is empty.
1235 * - 0: The mempool is not empty.
1238 rte_mempool_empty(const struct rte_mempool *mp)
1240 return !!(rte_mempool_count(mp) == 0);
1244 * Return the physical address of elt, which is an element of the pool mp.
1247 * A pointer to the mempool structure.
1249 * A pointer (virtual address) to the element of the pool.
1251 * The physical address of the elt element.
1253 static inline phys_addr_t
1254 rte_mempool_virt2phy(const struct rte_mempool *mp, const void *elt)
1256 if (rte_eal_has_hugepages()) {
1259 off = (const char *)elt - (const char *)mp->elt_va_start;
1260 return (mp->elt_pa[off >> mp->pg_shift] + (off & mp->pg_mask));
1263 * If huge pages are disabled, we cannot assume the
1264 * memory region to be physically contiguous.
1265 * Lookup for each element.
1267 return rte_mem_virt2phy(elt);
1272 * Check the consistency of mempool objects.
1274 * Verify the coherency of fields in the mempool structure. Also check
1275 * that the cookies of mempool objects (even the ones that are not
1276 * present in pool) have a correct value. If not, a panic will occur.
1279 * A pointer to the mempool structure.
1281 void rte_mempool_audit(const struct rte_mempool *mp);
1284 * Return a pointer to the private data in an mempool structure.
1287 * A pointer to the mempool structure.
1289 * A pointer to the private data.
1291 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1293 return (char *)mp + MEMPOOL_HEADER_SIZE(mp, mp->pg_num);
1297 * Dump the status of all mempools on the console
1300 * A pointer to a file for output
1302 void rte_mempool_list_dump(FILE *f);
1305 * Search a mempool from its name
1308 * The name of the mempool.
1310 * The pointer to the mempool matching the name, or NULL if not found.
1312 * with rte_errno set appropriately. Possible rte_errno values include:
1313 * - ENOENT - required entry not available to return.
1316 struct rte_mempool *rte_mempool_lookup(const char *name);
1319 * Given a desired size of the mempool element and mempool flags,
1320 * caluclates header, trailer, body and total sizes of the mempool object.
1322 * The size of each element.
1324 * The flags used for the mempool creation.
1325 * Consult rte_mempool_create() for more information about possible values.
1326 * The size of each element.
1328 * Total size of the mempool object.
1330 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1331 struct rte_mempool_objsz *sz);
1334 * Calculate maximum amount of memory required to store given number of objects.
1335 * Assumes that the memory buffer will be aligned at page boundary.
1336 * Note, that if object size is bigger then page size, then it assumes that
1337 * we have a subsets of physically continuous pages big enough to store
1338 * at least one object.
1340 * Number of elements.
1342 * The size of each element.
1344 * LOG2 of the physical pages size.
1346 * Required memory size aligned at page boundary.
1348 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t elt_sz,
1352 * Calculate how much memory would be actually required with the given
1353 * memory footprint to store required number of objects.
1355 * Virtual address of the externally allocated memory buffer.
1356 * Will be used to store mempool objects.
1358 * Number of elements.
1360 * The size of each element.
1362 * Array of phyiscall addresses of the pages that comprises given memory
1365 * Number of elements in the paddr array.
1367 * LOG2 of the physical pages size.
1369 * Number of bytes needed to store given number of objects,
1370 * aligned to the given page size.
1371 * If provided memory buffer is not big enough:
1372 * (-1) * actual number of elemnts that can be stored in that buffer.
1374 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num, size_t elt_sz,
1375 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift);
1378 * Walk list of all memory pools
1383 * Argument passed to iterator
1385 void rte_mempool_walk(void (*func)(const struct rte_mempool *, void *arg),
1392 #endif /* _RTE_MEMPOOL_H_ */