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.
66 #include <sys/queue.h>
69 #include <rte_debug.h>
70 #include <rte_lcore.h>
71 #include <rte_memory.h>
72 #include <rte_branch_prediction.h>
79 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL /**< Header cookie. */
80 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL /**< Header cookie. */
81 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL /**< Trailer cookie.*/
83 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
85 * A structure that stores the mempool statistics (per-lcore).
87 struct rte_mempool_debug_stats {
88 uint64_t put_bulk; /**< Number of puts. */
89 uint64_t put_objs; /**< Number of objects successfully put. */
90 uint64_t get_success_bulk; /**< Successful allocation number. */
91 uint64_t get_success_objs; /**< Objects successfully allocated. */
92 uint64_t get_fail_bulk; /**< Failed allocation number. */
93 uint64_t get_fail_objs; /**< Objects that failed to be allocated. */
94 } __rte_cache_aligned;
97 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
99 * A structure that stores a per-core object cache.
101 struct rte_mempool_cache {
102 unsigned len; /**< Cache len */
104 * Cache is allocated to this size to allow it to overflow in certain
105 * cases to avoid needless emptying of cache.
107 void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
108 } __rte_cache_aligned;
109 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
111 struct rte_mempool_objsz {
112 uint32_t elt_size; /**< Size of an element. */
113 uint32_t header_size; /**< Size of header (before elt). */
114 uint32_t trailer_size; /**< Size of trailer (after elt). */
116 /**< Total size of an object (header + elt + trailer). */
119 #define RTE_MEMPOOL_NAMESIZE 32 /**< Maximum length of a memory pool. */
120 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
123 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
125 #ifdef RTE_LIBRTE_XEN_DOM0
127 /* "<name>_MP_elt" */
128 #define RTE_MEMPOOL_OBJ_NAME "%s_" RTE_MEMPOOL_MZ_PREFIX "elt"
132 #define RTE_MEMPOOL_OBJ_NAME RTE_MEMPOOL_MZ_FORMAT
134 #endif /* RTE_LIBRTE_XEN_DOM0 */
136 #define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
138 /** Mempool over one chunk of physically continuous memory */
139 #define MEMPOOL_PG_NUM_DEFAULT 1
142 * The RTE mempool structure.
145 TAILQ_ENTRY(rte_mempool) next; /**< Next in list. */
147 char name[RTE_MEMPOOL_NAMESIZE]; /**< Name of mempool. */
148 struct rte_ring *ring; /**< Ring to store objects. */
149 phys_addr_t phys_addr; /**< Phys. addr. of mempool struct. */
150 int flags; /**< Flags of the mempool. */
151 uint32_t size; /**< Size of the mempool. */
152 uint32_t cache_size; /**< Size of per-lcore local cache. */
153 uint32_t cache_flushthresh;
154 /**< Threshold before we flush excess elements. */
156 uint32_t elt_size; /**< Size of an element. */
157 uint32_t header_size; /**< Size of header (before elt). */
158 uint32_t trailer_size; /**< Size of trailer (after elt). */
160 unsigned private_data_size; /**< Size of private data. */
162 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
163 /** Per-lcore local cache. */
164 struct rte_mempool_cache local_cache[RTE_MAX_LCORE];
167 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
168 /** Per-lcore statistics. */
169 struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
172 /* Address translation support, starts from next cache line. */
174 /** Number of elements in the elt_pa array. */
175 uint32_t pg_num __rte_cache_aligned;
176 uint32_t pg_shift; /**< LOG2 of the physical pages. */
177 uintptr_t pg_mask; /**< physical page mask value. */
178 uintptr_t elt_va_start;
179 /**< Virtual address of the first mempool object. */
180 uintptr_t elt_va_end;
181 /**< Virtual address of the <size + 1> mempool object. */
182 phys_addr_t elt_pa[MEMPOOL_PG_NUM_DEFAULT];
183 /**< Array of physical pages addresses for the mempool objects buffer. */
185 } __rte_cache_aligned;
187 #define MEMPOOL_F_NO_SPREAD 0x0001 /**< Do not spread in memory. */
188 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
189 #define MEMPOOL_F_SP_PUT 0x0004 /**< Default put is "single-producer".*/
190 #define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
193 * @internal When debug is enabled, store some statistics.
195 * Pointer to the memory pool.
197 * Name of the statistics field to increment in the memory pool.
199 * Number to add to the object-oriented statistics.
201 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
202 #define __MEMPOOL_STAT_ADD(mp, name, n) do { \
203 unsigned __lcore_id = rte_lcore_id(); \
204 mp->stats[__lcore_id].name##_objs += n; \
205 mp->stats[__lcore_id].name##_bulk += 1; \
208 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
212 * Calculates size of the mempool header.
214 * Pointer to the memory pool.
216 * Number of page used to store mempool objects.
218 #define MEMPOOL_HEADER_SIZE(mp, pgn) (sizeof(*(mp)) + \
219 RTE_ALIGN_CEIL(((pgn) - RTE_DIM((mp)->elt_pa)) * \
220 sizeof ((mp)->elt_pa[0]), CACHE_LINE_SIZE))
223 * Returns TRUE if whole mempool is allocated in one contiguous block of memory.
225 #define MEMPOOL_IS_CONTIG(mp) \
226 ((mp)->pg_num == MEMPOOL_PG_NUM_DEFAULT && \
227 (mp)->phys_addr == (mp)->elt_pa[0])
230 * @internal Get a pointer to a mempool pointer in the object header.
234 * The pointer to the mempool from which the object was allocated.
236 static inline struct rte_mempool **__mempool_from_obj(void *obj)
238 struct rte_mempool **mpp;
241 off = sizeof(struct rte_mempool *);
242 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
243 off += sizeof(uint64_t);
245 mpp = (struct rte_mempool **)((char *)obj - off);
250 * Return a pointer to the mempool owning this object.
253 * An object that is owned by a pool. If this is not the case,
254 * the behavior is undefined.
256 * A pointer to the mempool structure.
258 static inline const struct rte_mempool *rte_mempool_from_obj(void *obj)
260 struct rte_mempool * const *mpp;
261 mpp = __mempool_from_obj(obj);
265 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
266 /* get header cookie value */
267 static inline uint64_t __mempool_read_header_cookie(const void *obj)
269 return *(const uint64_t *)((const char *)obj - sizeof(uint64_t));
272 /* get trailer cookie value */
273 static inline uint64_t __mempool_read_trailer_cookie(void *obj)
275 struct rte_mempool **mpp = __mempool_from_obj(obj);
276 return *(uint64_t *)((char *)obj + (*mpp)->elt_size);
279 /* write header cookie value */
280 static inline void __mempool_write_header_cookie(void *obj, int free)
283 cookie_p = (uint64_t *)((char *)obj - sizeof(uint64_t));
285 *cookie_p = RTE_MEMPOOL_HEADER_COOKIE1;
287 *cookie_p = RTE_MEMPOOL_HEADER_COOKIE2;
291 /* write trailer cookie value */
292 static inline void __mempool_write_trailer_cookie(void *obj)
295 struct rte_mempool **mpp = __mempool_from_obj(obj);
296 cookie_p = (uint64_t *)((char *)obj + (*mpp)->elt_size);
297 *cookie_p = RTE_MEMPOOL_TRAILER_COOKIE;
299 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
302 * @internal Check and update cookies or panic.
305 * Pointer to the memory pool.
306 * @param obj_table_const
307 * Pointer to a table of void * pointers (objects).
309 * Index of object in object table.
311 * - 0: object is supposed to be allocated, mark it as free
312 * - 1: object is supposed to be free, mark it as allocated
313 * - 2: just check that cookie is valid (free or allocated)
315 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
316 #ifndef __INTEL_COMPILER
317 #pragma GCC push_options
318 #pragma GCC diagnostic ignored "-Wcast-qual"
320 static inline void __mempool_check_cookies(const struct rte_mempool *mp,
321 void * const *obj_table_const,
322 unsigned n, int free)
329 /* Force to drop the "const" attribute. This is done only when
330 * DEBUG is enabled */
331 tmp = (void *) obj_table_const;
332 obj_table = (void **) tmp;
337 if (rte_mempool_from_obj(obj) != mp)
338 rte_panic("MEMPOOL: object is owned by another "
341 cookie = __mempool_read_header_cookie(obj);
344 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
345 rte_log_set_history(0);
346 RTE_LOG(CRIT, MEMPOOL,
347 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
349 rte_panic("MEMPOOL: bad header cookie (put)\n");
351 __mempool_write_header_cookie(obj, 1);
353 else if (free == 1) {
354 if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
355 rte_log_set_history(0);
356 RTE_LOG(CRIT, MEMPOOL,
357 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
359 rte_panic("MEMPOOL: bad header cookie (get)\n");
361 __mempool_write_header_cookie(obj, 0);
363 else if (free == 2) {
364 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
365 cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
366 rte_log_set_history(0);
367 RTE_LOG(CRIT, MEMPOOL,
368 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
370 rte_panic("MEMPOOL: bad header cookie (audit)\n");
373 cookie = __mempool_read_trailer_cookie(obj);
374 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
375 rte_log_set_history(0);
376 RTE_LOG(CRIT, MEMPOOL,
377 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
379 rte_panic("MEMPOOL: bad trailer cookie\n");
383 #ifndef __INTEL_COMPILER
384 #pragma GCC pop_options
387 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
388 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
391 * An mempool's object iterator callback function.
393 typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/,
394 void * /*obj_start*/,
396 uint32_t /*obj_index */);
399 * Iterates across objects of the given size and alignment in the
400 * provided chunk of memory. The given memory buffer can consist of
401 * disjoint physical pages.
402 * For each object calls the provided callback (if any).
403 * Used to populate mempool, walk through all elements of the mempool,
404 * estimate how many elements of the given size could be created in the given
407 * Virtual address of the memory buffer.
409 * Maximum number of objects to iterate through.
411 * Size of each object.
413 * Array of phyiscall addresses of the pages that comprises given memory
416 * Number of elements in the paddr array.
418 * LOG2 of the physical pages size.
420 * Object iterator callback function (could be NULL).
421 * @param obj_iter_arg
422 * User defined Prameter for the object iterator callback function.
425 * Number of objects iterated through.
428 uint32_t rte_mempool_obj_iter(void *vaddr,
429 uint32_t elt_num, size_t elt_sz, size_t align,
430 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
431 rte_mempool_obj_iter_t obj_iter, void *obj_iter_arg);
434 * An object constructor callback function for mempool.
436 * Arguments are the mempool, the opaque pointer given by the user in
437 * rte_mempool_create(), the pointer to the element and the index of
438 * the element in the pool.
440 typedef void (rte_mempool_obj_ctor_t)(struct rte_mempool *, void *,
444 * A mempool constructor callback function.
446 * Arguments are the mempool and the opaque pointer given by the user in
447 * rte_mempool_create().
449 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
452 * Creates a new mempool named *name* in memory.
454 * This function uses ``memzone_reserve()`` to allocate memory. The
455 * pool contains n elements of elt_size. Its size is set to n.
456 * All elements of the mempool are allocated together with the mempool header,
457 * in one physically continuous chunk of memory.
460 * The name of the mempool.
462 * The number of elements in the mempool. The optimum size (in terms of
463 * memory usage) for a mempool is when n is a power of two minus one:
466 * The size of each element.
468 * If cache_size is non-zero, the rte_mempool library will try to
469 * limit the accesses to the common lockless pool, by maintaining a
470 * per-lcore object cache. This argument must be lower or equal to
471 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE. It is advised to choose
472 * cache_size to have "n modulo cache_size == 0": if this is
473 * not the case, some elements will always stay in the pool and will
474 * never be used. The access to the per-lcore table is of course
475 * faster than the multi-producer/consumer pool. The cache can be
476 * disabled if the cache_size argument is set to 0; it can be useful to
477 * avoid loosing objects in cache. Note that even if not used, the
478 * memory space for cache is always reserved in a mempool structure,
479 * except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
480 * @param private_data_size
481 * The size of the private data appended after the mempool
482 * structure. This is useful for storing some private data after the
483 * mempool structure, as is done for rte_mbuf_pool for example.
485 * A function pointer that is called for initialization of the pool,
486 * before object initialization. The user can initialize the private
487 * data in this function if needed. This parameter can be NULL if
490 * An opaque pointer to data that can be used in the mempool
491 * constructor function.
493 * A function pointer that is called for each object at
494 * initialization of the pool. The user can set some meta data in
495 * objects if needed. This parameter can be NULL if not needed.
496 * The obj_init() function takes the mempool pointer, the init_arg,
497 * the object pointer and the object number as parameters.
498 * @param obj_init_arg
499 * An opaque pointer to data that can be used as an argument for
500 * each call to the object constructor function.
502 * The *socket_id* argument is the socket identifier in the case of
503 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
504 * constraint for the reserved zone.
506 * The *flags* arguments is an OR of following flags:
507 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
508 * between channels in RAM: the pool allocator will add padding
509 * between objects depending on the hardware configuration. See
510 * Memory alignment constraints for details. If this flag is set,
511 * the allocator will just align them to a cache line.
512 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
513 * cache-aligned. This flag removes this constraint, and no
514 * padding will be present between objects. This flag implies
515 * MEMPOOL_F_NO_SPREAD.
516 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
517 * when using rte_mempool_put() or rte_mempool_put_bulk() is
518 * "single-producer". Otherwise, it is "multi-producers".
519 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
520 * when using rte_mempool_get() or rte_mempool_get_bulk() is
521 * "single-consumer". Otherwise, it is "multi-consumers".
523 * The pointer to the new allocated mempool, on success. NULL on error
524 * with rte_errno set appropriately. Possible rte_errno values include:
525 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
526 * - E_RTE_SECONDARY - function was called from a secondary process instance
527 * - E_RTE_NO_TAILQ - no tailq list could be got for the ring or mempool list
528 * - EINVAL - cache size provided is too large
529 * - ENOSPC - the maximum number of memzones has already been allocated
530 * - EEXIST - a memzone with the same name already exists
531 * - ENOMEM - no appropriate memory area found in which to create memzone
534 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
535 unsigned cache_size, unsigned private_data_size,
536 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
537 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
538 int socket_id, unsigned flags);
541 * Creates a new mempool named *name* in memory.
543 * This function uses ``memzone_reserve()`` to allocate memory. The
544 * pool contains n elements of elt_size. Its size is set to n.
545 * Depending on the input parameters, mempool elements can be either allocated
546 * together with the mempool header, or an externally provided memory buffer
547 * could be used to store mempool objects. In later case, that external
548 * memory buffer can consist of set of disjoint phyiscal pages.
551 * The name of the mempool.
553 * The number of elements in the mempool. The optimum size (in terms of
554 * memory usage) for a mempool is when n is a power of two minus one:
557 * The size of each element.
559 * If cache_size is non-zero, the rte_mempool library will try to
560 * limit the accesses to the common lockless pool, by maintaining a
561 * per-lcore object cache. This argument must be lower or equal to
562 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE. It is advised to choose
563 * cache_size to have "n modulo cache_size == 0": if this is
564 * not the case, some elements will always stay in the pool and will
565 * never be used. The access to the per-lcore table is of course
566 * faster than the multi-producer/consumer pool. The cache can be
567 * disabled if the cache_size argument is set to 0; it can be useful to
568 * avoid loosing objects in cache. Note that even if not used, the
569 * memory space for cache is always reserved in a mempool structure,
570 * except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
571 * @param private_data_size
572 * The size of the private data appended after the mempool
573 * structure. This is useful for storing some private data after the
574 * mempool structure, as is done for rte_mbuf_pool for example.
576 * A function pointer that is called for initialization of the pool,
577 * before object initialization. The user can initialize the private
578 * data in this function if needed. This parameter can be NULL if
581 * An opaque pointer to data that can be used in the mempool
582 * constructor function.
584 * A function pointer that is called for each object at
585 * initialization of the pool. The user can set some meta data in
586 * objects if needed. This parameter can be NULL if not needed.
587 * The obj_init() function takes the mempool pointer, the init_arg,
588 * the object pointer and the object number as parameters.
589 * @param obj_init_arg
590 * An opaque pointer to data that can be used as an argument for
591 * each call to the object constructor function.
593 * The *socket_id* argument is the socket identifier in the case of
594 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
595 * constraint for the reserved zone.
597 * The *flags* arguments is an OR of following flags:
598 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
599 * between channels in RAM: the pool allocator will add padding
600 * between objects depending on the hardware configuration. See
601 * Memory alignment constraints for details. If this flag is set,
602 * the allocator will just align them to a cache line.
603 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
604 * cache-aligned. This flag removes this constraint, and no
605 * padding will be present between objects. This flag implies
606 * MEMPOOL_F_NO_SPREAD.
607 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
608 * when using rte_mempool_put() or rte_mempool_put_bulk() is
609 * "single-producer". Otherwise, it is "multi-producers".
610 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
611 * when using rte_mempool_get() or rte_mempool_get_bulk() is
612 * "single-consumer". Otherwise, it is "multi-consumers".
614 * Virtual address of the externally allocated memory buffer.
615 * Will be used to store mempool objects.
617 * Array of phyiscall addresses of the pages that comprises given memory
620 * Number of elements in the paddr array.
622 * LOG2 of the physical pages size.
624 * The pointer to the new allocated mempool, on success. NULL on error
625 * with rte_errno set appropriately. Possible rte_errno values include:
626 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
627 * - E_RTE_SECONDARY - function was called from a secondary process instance
628 * - E_RTE_NO_TAILQ - no tailq list could be got for the ring or mempool list
629 * - EINVAL - cache size provided is too large
630 * - ENOSPC - the maximum number of memzones has already been allocated
631 * - EEXIST - a memzone with the same name already exists
632 * - ENOMEM - no appropriate memory area found in which to create memzone
635 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
636 unsigned cache_size, unsigned private_data_size,
637 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
638 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
639 int socket_id, unsigned flags, void *vaddr,
640 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift);
642 #ifdef RTE_LIBRTE_XEN_DOM0
644 * Creates a new mempool named *name* in memory on Xen Dom0.
646 * This function uses ``rte_mempool_xmem_create()`` to allocate memory. The
647 * pool contains n elements of elt_size. Its size is set to n.
648 * All elements of the mempool are allocated together with the mempool header,
649 * and memory buffer can consist of set of disjoint phyiscal pages.
652 * The name of the mempool.
654 * The number of elements in the mempool. The optimum size (in terms of
655 * memory usage) for a mempool is when n is a power of two minus one:
658 * The size of each element.
660 * If cache_size is non-zero, the rte_mempool library will try to
661 * limit the accesses to the common lockless pool, by maintaining a
662 * per-lcore object cache. This argument must be lower or equal to
663 * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE. It is advised to choose
664 * cache_size to have "n modulo cache_size == 0": if this is
665 * not the case, some elements will always stay in the pool and will
666 * never be used. The access to the per-lcore table is of course
667 * faster than the multi-producer/consumer pool. The cache can be
668 * disabled if the cache_size argument is set to 0; it can be useful to
669 * avoid loosing objects in cache. Note that even if not used, the
670 * memory space for cache is always reserved in a mempool structure,
671 * except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
672 * @param private_data_size
673 * The size of the private data appended after the mempool
674 * structure. This is useful for storing some private data after the
675 * mempool structure, as is done for rte_mbuf_pool for example.
677 * A function pointer that is called for initialization of the pool,
678 * before object initialization. The user can initialize the private
679 * data in this function if needed. This parameter can be NULL if
682 * An opaque pointer to data that can be used in the mempool
683 * constructor function.
685 * A function pointer that is called for each object at
686 * initialization of the pool. The user can set some meta data in
687 * objects if needed. This parameter can be NULL if not needed.
688 * The obj_init() function takes the mempool pointer, the init_arg,
689 * the object pointer and the object number as parameters.
690 * @param obj_init_arg
691 * An opaque pointer to data that can be used as an argument for
692 * each call to the object constructor function.
694 * The *socket_id* argument is the socket identifier in the case of
695 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
696 * constraint for the reserved zone.
698 * The *flags* arguments is an OR of following flags:
699 * - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
700 * between channels in RAM: the pool allocator will add padding
701 * between objects depending on the hardware configuration. See
702 * Memory alignment constraints for details. If this flag is set,
703 * the allocator will just align them to a cache line.
704 * - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
705 * cache-aligned. This flag removes this constraint, and no
706 * padding will be present between objects. This flag implies
707 * MEMPOOL_F_NO_SPREAD.
708 * - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
709 * when using rte_mempool_put() or rte_mempool_put_bulk() is
710 * "single-producer". Otherwise, it is "multi-producers".
711 * - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
712 * when using rte_mempool_get() or rte_mempool_get_bulk() is
713 * "single-consumer". Otherwise, it is "multi-consumers".
715 * The pointer to the new allocated mempool, on success. NULL on error
716 * with rte_errno set appropriately. Possible rte_errno values include:
717 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
718 * - E_RTE_SECONDARY - function was called from a secondary process instance
719 * - E_RTE_NO_TAILQ - no tailq list could be got for the ring or mempool list
720 * - EINVAL - cache size provided is too large
721 * - ENOSPC - the maximum number of memzones has already been allocated
722 * - EEXIST - a memzone with the same name already exists
723 * - ENOMEM - no appropriate memory area found in which to create memzone
726 rte_dom0_mempool_create(const char *name, unsigned n, unsigned elt_size,
727 unsigned cache_size, unsigned private_data_size,
728 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
729 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
730 int socket_id, unsigned flags);
734 * Dump the status of the mempool to the console.
737 * A pointer to the mempool structure.
739 void rte_mempool_dump(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 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
950 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
951 struct rte_mempool_cache *cache;
954 unsigned lcore_id = rte_lcore_id();
955 uint32_t cache_size = mp->cache_size;
957 /* cache is not enabled or single consumer */
958 if (unlikely(cache_size == 0 || is_mc == 0 || n >= cache_size))
961 cache = &mp->local_cache[lcore_id];
962 cache_objs = cache->objs;
964 /* Can this be satisfied from the cache? */
965 if (cache->len < n) {
966 /* No. Backfill the cache first, and then fill from it */
967 uint32_t req = n + (cache_size - cache->len);
969 /* How many do we require i.e. number to fill the cache + the request */
970 ret = rte_ring_mc_dequeue_bulk(mp->ring, &cache->objs[cache->len], req);
971 if (unlikely(ret < 0)) {
973 * In the offchance that we are buffer constrained,
974 * where we are not able to allocate cache + n, go to
975 * the ring directly. If that fails, we are truly out of
984 /* Now fill in the response ... */
985 for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
986 *obj_table = cache_objs[len];
990 __MEMPOOL_STAT_ADD(mp, get_success, n_orig);
995 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
997 /* get remaining objects from ring */
999 ret = rte_ring_mc_dequeue_bulk(mp->ring, obj_table, n);
1001 ret = rte_ring_sc_dequeue_bulk(mp->ring, obj_table, n);
1004 __MEMPOOL_STAT_ADD(mp, get_fail, n_orig);
1006 __MEMPOOL_STAT_ADD(mp, get_success, n_orig);
1012 * Get several objects from the mempool (multi-consumers safe).
1014 * If cache is enabled, objects will be retrieved first from cache,
1015 * subsequently from the common pool. Note that it can return -ENOENT when
1016 * the local cache and common pool are empty, even if cache from other
1020 * A pointer to the mempool structure.
1022 * A pointer to a table of void * pointers (objects) that will be filled.
1024 * The number of objects to get from mempool to obj_table.
1026 * - 0: Success; objects taken.
1027 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1029 static inline int __attribute__((always_inline))
1030 rte_mempool_mc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1033 ret = __mempool_get_bulk(mp, obj_table, n, 1);
1035 __mempool_check_cookies(mp, obj_table, n, 1);
1040 * Get several objects from the mempool (NOT multi-consumers safe).
1042 * If cache is enabled, objects will be retrieved first from cache,
1043 * subsequently from the common pool. Note that it can return -ENOENT when
1044 * the local cache and common pool are empty, even if cache from other
1048 * A pointer to the mempool structure.
1050 * A pointer to a table of void * pointers (objects) that will be filled.
1052 * The number of objects to get from the mempool to obj_table.
1054 * - 0: Success; objects taken.
1055 * - -ENOENT: Not enough entries in the mempool; no object is
1058 static inline int __attribute__((always_inline))
1059 rte_mempool_sc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1062 ret = __mempool_get_bulk(mp, obj_table, n, 0);
1064 __mempool_check_cookies(mp, obj_table, n, 1);
1069 * Get several objects from the mempool.
1071 * This function calls the multi-consumers or the single-consumer
1072 * version, depending on the default behaviour that was specified at
1073 * mempool creation time (see flags).
1075 * If cache is enabled, objects will be retrieved first from cache,
1076 * subsequently from the common pool. Note that it can return -ENOENT when
1077 * the local cache and common pool are empty, even if cache from other
1081 * A pointer to the mempool structure.
1083 * A pointer to a table of void * pointers (objects) that will be filled.
1085 * The number of objects to get from the mempool to obj_table.
1087 * - 0: Success; objects taken
1088 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1090 static inline int __attribute__((always_inline))
1091 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
1094 ret = __mempool_get_bulk(mp, obj_table, n,
1095 !(mp->flags & MEMPOOL_F_SC_GET));
1097 __mempool_check_cookies(mp, obj_table, n, 1);
1102 * Get one object from the mempool (multi-consumers safe).
1104 * If cache is enabled, objects will be retrieved first from cache,
1105 * subsequently from the common pool. Note that it can return -ENOENT when
1106 * the local cache and common pool are empty, even if cache from other
1110 * A pointer to the mempool structure.
1112 * A pointer to a void * pointer (object) that will be filled.
1114 * - 0: Success; objects taken.
1115 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1117 static inline int __attribute__((always_inline))
1118 rte_mempool_mc_get(struct rte_mempool *mp, void **obj_p)
1120 return rte_mempool_mc_get_bulk(mp, obj_p, 1);
1124 * Get one object from the mempool (NOT multi-consumers safe).
1126 * If cache is enabled, objects will be retrieved first from cache,
1127 * subsequently from the common pool. Note that it can return -ENOENT when
1128 * the local cache and common pool are empty, even if cache from other
1132 * A pointer to the mempool structure.
1134 * A pointer to a void * pointer (object) that will be filled.
1136 * - 0: Success; objects taken.
1137 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1139 static inline int __attribute__((always_inline))
1140 rte_mempool_sc_get(struct rte_mempool *mp, void **obj_p)
1142 return rte_mempool_sc_get_bulk(mp, obj_p, 1);
1146 * Get one object from the mempool.
1148 * This function calls the multi-consumers or the single-consumer
1149 * version, depending on the default behavior that was specified at
1150 * mempool creation (see flags).
1152 * If cache is enabled, objects will be retrieved first from cache,
1153 * subsequently from the common pool. Note that it can return -ENOENT when
1154 * the local cache and common pool are empty, even if cache from other
1158 * A pointer to the mempool structure.
1160 * A pointer to a void * pointer (object) that will be filled.
1162 * - 0: Success; objects taken.
1163 * - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1165 static inline int __attribute__((always_inline))
1166 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1168 return rte_mempool_get_bulk(mp, obj_p, 1);
1172 * Return the number of entries in the mempool.
1174 * When cache is enabled, this function has to browse the length of
1175 * all lcores, so it should not be used in a data path, but only for
1179 * A pointer to the mempool structure.
1181 * The number of entries in the mempool.
1183 unsigned rte_mempool_count(const struct rte_mempool *mp);
1186 * Return the number of free entries in the mempool ring.
1187 * i.e. how many entries can be freed back to the mempool.
1189 * NOTE: This corresponds to the number of elements *allocated* from the
1190 * memory pool, not the number of elements in the pool itself. To count
1191 * the number elements currently available in the pool, use "rte_mempool_count"
1193 * When cache is enabled, this function has to browse the length of
1194 * all lcores, so it should not be used in a data path, but only for
1198 * A pointer to the mempool structure.
1200 * The number of free entries in the mempool.
1202 static inline unsigned
1203 rte_mempool_free_count(const struct rte_mempool *mp)
1205 return mp->size - rte_mempool_count(mp);
1209 * Test if the mempool is full.
1211 * When cache is enabled, this function has to browse the length of all
1212 * lcores, so it should not be used in a data path, but only for debug
1216 * A pointer to the mempool structure.
1218 * - 1: The mempool is full.
1219 * - 0: The mempool is not full.
1222 rte_mempool_full(const struct rte_mempool *mp)
1224 return !!(rte_mempool_count(mp) == mp->size);
1228 * Test if the mempool is empty.
1230 * When cache is enabled, this function has to browse the length of all
1231 * lcores, so it should not be used in a data path, but only for debug
1235 * A pointer to the mempool structure.
1237 * - 1: The mempool is empty.
1238 * - 0: The mempool is not empty.
1241 rte_mempool_empty(const struct rte_mempool *mp)
1243 return !!(rte_mempool_count(mp) == 0);
1247 * Return the physical address of elt, which is an element of the pool mp.
1250 * A pointer to the mempool structure.
1252 * A pointer (virtual address) to the element of the pool.
1254 * The physical address of the elt element.
1256 static inline phys_addr_t
1257 rte_mempool_virt2phy(const struct rte_mempool *mp, const void *elt)
1259 if (rte_eal_has_hugepages()) {
1262 off = (const char *)elt - (const char *)mp->elt_va_start;
1263 return (mp->elt_pa[off >> mp->pg_shift] + (off & mp->pg_mask));
1266 * If huge pages are disabled, we cannot assume the
1267 * memory region to be physically contiguous.
1268 * Lookup for each element.
1270 return rte_mem_virt2phy(elt);
1275 * Check the consistency of mempool objects.
1277 * Verify the coherency of fields in the mempool structure. Also check
1278 * that the cookies of mempool objects (even the ones that are not
1279 * present in pool) have a correct value. If not, a panic will occur.
1282 * A pointer to the mempool structure.
1284 void rte_mempool_audit(const struct rte_mempool *mp);
1287 * Return a pointer to the private data in an mempool structure.
1290 * A pointer to the mempool structure.
1292 * A pointer to the private data.
1294 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1296 return (char *)mp + MEMPOOL_HEADER_SIZE(mp, mp->pg_num);
1300 * Dump the status of all mempools on the console
1302 void rte_mempool_list_dump(void);
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 alligned 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);
1381 #endif /* _RTE_MEMPOOL_H_ */