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.
41 #include <sys/queue.h>
43 #include <rte_common.h>
45 #include <rte_debug.h>
46 #include <rte_memory.h>
47 #include <rte_memzone.h>
48 #include <rte_malloc.h>
49 #include <rte_atomic.h>
50 #include <rte_launch.h>
52 #include <rte_eal_memconfig.h>
53 #include <rte_per_lcore.h>
54 #include <rte_lcore.h>
55 #include <rte_branch_prediction.h>
57 #include <rte_errno.h>
58 #include <rte_string_fns.h>
59 #include <rte_spinlock.h>
61 #include "rte_mempool.h"
63 TAILQ_HEAD(rte_mempool_list, rte_tailq_entry);
65 static struct rte_tailq_elem rte_mempool_tailq = {
66 .name = "RTE_MEMPOOL",
68 EAL_REGISTER_TAILQ(rte_mempool_tailq)
70 #define CACHE_FLUSHTHRESH_MULTIPLIER 1.5
71 #define CALC_CACHE_FLUSHTHRESH(c) \
72 ((typeof(c))((c) * CACHE_FLUSHTHRESH_MULTIPLIER))
75 * return the greatest common divisor between a and b (fast algorithm)
78 static unsigned get_gcd(unsigned a, unsigned b)
103 * Depending on memory configuration, objects addresses are spread
104 * between channels and ranks in RAM: the pool allocator will add
105 * padding between objects. This function return the new size of the
108 static unsigned optimize_object_size(unsigned obj_size)
110 unsigned nrank, nchan;
111 unsigned new_obj_size;
113 /* get number of channels */
114 nchan = rte_memory_get_nchannel();
118 nrank = rte_memory_get_nrank();
122 /* process new object size */
123 new_obj_size = (obj_size + RTE_MEMPOOL_ALIGN_MASK) / RTE_MEMPOOL_ALIGN;
124 while (get_gcd(new_obj_size, nrank * nchan) != 1)
126 return new_obj_size * RTE_MEMPOOL_ALIGN;
130 mempool_add_elem(struct rte_mempool *mp, void *obj, uint32_t obj_idx,
131 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg)
133 struct rte_mempool_objhdr *hdr;
134 struct rte_mempool_objtlr *tlr __rte_unused;
136 obj = (char *)obj + mp->header_size;
138 /* set mempool ptr in header */
139 hdr = RTE_PTR_SUB(obj, sizeof(*hdr));
141 STAILQ_INSERT_TAIL(&mp->elt_list, hdr, next);
143 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
144 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
145 tlr = __mempool_get_trailer(obj);
146 tlr->cookie = RTE_MEMPOOL_TRAILER_COOKIE;
148 /* call the initializer */
150 obj_init(mp, obj_init_arg, obj, obj_idx);
152 /* enqueue in ring */
153 rte_ring_sp_enqueue(mp->ring, obj);
156 /* Iterate through objects at the given address
158 * Given the pointer to the memory, and its topology in physical memory
159 * (the physical addresses table), iterate through the "elt_num" objects
160 * of size "elt_sz" aligned at "align". For each object in this memory
161 * chunk, invoke a callback. It returns the effective number of objects
165 rte_mempool_obj_iter(void *vaddr, uint32_t elt_num, size_t total_elt_sz,
166 size_t align, const phys_addr_t paddr[], uint32_t pg_num,
167 uint32_t pg_shift, rte_mempool_obj_iter_t obj_iter, void *obj_iter_arg)
171 uintptr_t end, start, va;
174 pg_sz = (uintptr_t)1 << pg_shift;
175 va = (uintptr_t)vaddr;
180 while (i != elt_num && j != pg_num) {
182 start = RTE_ALIGN_CEIL(va, align);
183 end = start + total_elt_sz;
185 /* index of the first page for the next element. */
186 pgf = (end >> pg_shift) - (start >> pg_shift);
188 /* index of the last page for the current element. */
189 pgn = ((end - 1) >> pg_shift) - (start >> pg_shift);
192 /* do we have enough space left for the element. */
198 paddr[k] + pg_sz == paddr[k + 1];
203 * if next pgn chunks of memory physically continuous,
204 * use it to create next element.
205 * otherwise, just skip that chunk unused.
208 if (obj_iter != NULL)
209 obj_iter(obj_iter_arg, (void *)start,
215 va = RTE_ALIGN_CEIL((va + 1), pg_sz);
224 * Populate mempool with the objects.
227 struct mempool_populate_arg {
228 struct rte_mempool *mp;
229 rte_mempool_obj_cb_t *obj_init;
234 mempool_obj_populate(void *arg, void *start, void *end, uint32_t idx)
236 struct mempool_populate_arg *pa = arg;
238 mempool_add_elem(pa->mp, start, idx, pa->obj_init, pa->obj_init_arg);
239 pa->mp->elt_va_end = (uintptr_t)end;
243 mempool_populate(struct rte_mempool *mp, size_t num, size_t align,
244 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg)
247 struct mempool_populate_arg arg;
249 elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
251 arg.obj_init = obj_init;
252 arg.obj_init_arg = obj_init_arg;
254 mp->size = rte_mempool_obj_iter((void *)mp->elt_va_start,
256 mp->elt_pa, mp->pg_num, mp->pg_shift,
257 mempool_obj_populate, &arg);
260 /* get the header, trailer and total size of a mempool element. */
262 rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
263 struct rte_mempool_objsz *sz)
265 struct rte_mempool_objsz lsz;
267 sz = (sz != NULL) ? sz : &lsz;
269 sz->header_size = sizeof(struct rte_mempool_objhdr);
270 if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
271 sz->header_size = RTE_ALIGN_CEIL(sz->header_size,
274 sz->trailer_size = sizeof(struct rte_mempool_objtlr);
276 /* element size is 8 bytes-aligned at least */
277 sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
279 /* expand trailer to next cache line */
280 if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
281 sz->total_size = sz->header_size + sz->elt_size +
283 sz->trailer_size += ((RTE_MEMPOOL_ALIGN -
284 (sz->total_size & RTE_MEMPOOL_ALIGN_MASK)) &
285 RTE_MEMPOOL_ALIGN_MASK);
289 * increase trailer to add padding between objects in order to
290 * spread them across memory channels/ranks
292 if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
294 new_size = optimize_object_size(sz->header_size + sz->elt_size +
296 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
299 if (! rte_eal_has_hugepages()) {
301 * compute trailer size so that pool elements fit exactly in
304 int page_size = getpagesize();
305 int new_size = page_size - sz->header_size - sz->elt_size;
306 if (new_size < 0 || (unsigned int)new_size < sz->trailer_size) {
307 printf("When hugepages are disabled, pool objects "
308 "can't exceed PAGE_SIZE: %d + %d + %d > %d\n",
309 sz->header_size, sz->elt_size, sz->trailer_size,
313 sz->trailer_size = new_size;
316 /* this is the size of an object, including header and trailer */
317 sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
319 return sz->total_size;
324 * Calculate maximum amount of memory required to store given number of objects.
327 rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift)
329 size_t n, pg_num, pg_sz, sz;
331 pg_sz = (size_t)1 << pg_shift;
333 if ((n = pg_sz / total_elt_sz) > 0) {
334 pg_num = (elt_num + n - 1) / n;
335 sz = pg_num << pg_shift;
337 sz = RTE_ALIGN_CEIL(total_elt_sz, pg_sz) * elt_num;
343 /* Callback used by rte_mempool_xmem_usage(): it sets the opaque
344 * argument to the end of the object.
347 mempool_lelem_iter(void *arg, __rte_unused void *start, void *end,
348 __rte_unused uint32_t idx)
350 *(uintptr_t *)arg = (uintptr_t)end;
354 * Calculate how much memory would be actually required with the
355 * given memory footprint to store required number of elements.
358 rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num, size_t total_elt_sz,
359 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
365 pg_sz = (size_t)1 << pg_shift;
366 va = (uintptr_t)vaddr;
369 if ((n = rte_mempool_obj_iter(vaddr, elt_num, total_elt_sz, 1,
370 paddr, pg_num, pg_shift, mempool_lelem_iter,
375 uv = RTE_ALIGN_CEIL(uv, pg_sz);
380 #ifndef RTE_LIBRTE_XEN_DOM0
381 /* stub if DOM0 support not configured */
383 rte_dom0_mempool_create(const char *name __rte_unused,
384 unsigned n __rte_unused,
385 unsigned elt_size __rte_unused,
386 unsigned cache_size __rte_unused,
387 unsigned private_data_size __rte_unused,
388 rte_mempool_ctor_t *mp_init __rte_unused,
389 void *mp_init_arg __rte_unused,
390 rte_mempool_obj_ctor_t *obj_init __rte_unused,
391 void *obj_init_arg __rte_unused,
392 int socket_id __rte_unused,
393 unsigned flags __rte_unused)
400 /* create the mempool */
402 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
403 unsigned cache_size, unsigned private_data_size,
404 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
405 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
406 int socket_id, unsigned flags)
408 if (rte_xen_dom0_supported())
409 return rte_dom0_mempool_create(name, n, elt_size,
410 cache_size, private_data_size,
411 mp_init, mp_init_arg,
412 obj_init, obj_init_arg,
415 return rte_mempool_xmem_create(name, n, elt_size,
416 cache_size, private_data_size,
417 mp_init, mp_init_arg,
418 obj_init, obj_init_arg,
420 NULL, NULL, MEMPOOL_PG_NUM_DEFAULT,
421 MEMPOOL_PG_SHIFT_MAX);
425 * Create the mempool over already allocated chunk of memory.
426 * That external memory buffer can consists of physically disjoint pages.
427 * Setting vaddr to NULL, makes mempool to fallback to original behaviour
428 * and allocate space for mempool and it's elements as one big chunk of
429 * physically continuos memory.
432 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
433 unsigned cache_size, unsigned private_data_size,
434 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
435 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
436 int socket_id, unsigned flags, void *vaddr,
437 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
439 char mz_name[RTE_MEMZONE_NAMESIZE];
440 char rg_name[RTE_RING_NAMESIZE];
441 struct rte_mempool_list *mempool_list;
442 struct rte_mempool *mp = NULL;
443 struct rte_tailq_entry *te = NULL;
444 struct rte_ring *r = NULL;
445 const struct rte_memzone *mz;
447 int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
450 struct rte_mempool_objsz objsz;
452 int page_size = getpagesize();
454 /* compilation-time checks */
455 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
456 RTE_CACHE_LINE_MASK) != 0);
457 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
458 RTE_CACHE_LINE_MASK) != 0);
459 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
460 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
461 RTE_CACHE_LINE_MASK) != 0);
462 RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
463 RTE_CACHE_LINE_MASK) != 0);
466 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
468 /* asked cache too big */
469 if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
470 CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
475 /* check that we have both VA and PA */
476 if (vaddr != NULL && paddr == NULL) {
481 /* Check that pg_num and pg_shift parameters are valid. */
482 if (pg_num < RTE_DIM(mp->elt_pa) || pg_shift > MEMPOOL_PG_SHIFT_MAX) {
487 /* "no cache align" imply "no spread" */
488 if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
489 flags |= MEMPOOL_F_NO_SPREAD;
492 if (flags & MEMPOOL_F_SP_PUT)
493 rg_flags |= RING_F_SP_ENQ;
494 if (flags & MEMPOOL_F_SC_GET)
495 rg_flags |= RING_F_SC_DEQ;
497 /* calculate mempool object sizes. */
498 if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
503 rte_rwlock_write_lock(RTE_EAL_MEMPOOL_RWLOCK);
505 /* allocate the ring that will be used to store objects */
506 /* Ring functions will return appropriate errors if we are
507 * running as a secondary process etc., so no checks made
508 * in this function for that condition */
509 snprintf(rg_name, sizeof(rg_name), RTE_MEMPOOL_MZ_FORMAT, name);
510 r = rte_ring_create(rg_name, rte_align32pow2(n+1), socket_id, rg_flags);
515 * reserve a memory zone for this mempool: private data is
518 private_data_size = (private_data_size +
519 RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
521 if (! rte_eal_has_hugepages()) {
523 * expand private data size to a whole page, so that the
524 * first pool element will start on a new standard page
526 int head = sizeof(struct rte_mempool);
527 int new_size = (private_data_size + head) % page_size;
529 private_data_size += page_size - new_size;
532 /* try to allocate tailq entry */
533 te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
535 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
540 * If user provided an external memory buffer, then use it to
541 * store mempool objects. Otherwise reserve a memzone that is large
542 * enough to hold mempool header and metadata plus mempool objects.
544 mempool_size = MEMPOOL_HEADER_SIZE(mp, pg_num, cache_size);
545 mempool_size += private_data_size;
546 mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
548 mempool_size += (size_t)objsz.total_size * n;
550 if (! rte_eal_has_hugepages()) {
552 * we want the memory pool to start on a page boundary,
553 * because pool elements crossing page boundaries would
554 * result in discontiguous physical addresses
556 mempool_size += page_size;
559 snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
561 mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
565 if (rte_eal_has_hugepages()) {
566 startaddr = (void*)mz->addr;
568 /* align memory pool start address on a page boundary */
569 unsigned long addr = (unsigned long)mz->addr;
570 if (addr & (page_size - 1)) {
572 addr &= ~(page_size - 1);
574 startaddr = (void*)addr;
577 /* init the mempool structure */
579 memset(mp, 0, sizeof(*mp));
580 snprintf(mp->name, sizeof(mp->name), "%s", name);
581 mp->phys_addr = mz->phys_addr;
585 mp->elt_size = objsz.elt_size;
586 mp->header_size = objsz.header_size;
587 mp->trailer_size = objsz.trailer_size;
588 mp->cache_size = cache_size;
589 mp->cache_flushthresh = CALC_CACHE_FLUSHTHRESH(cache_size);
590 mp->private_data_size = private_data_size;
591 STAILQ_INIT(&mp->elt_list);
594 * local_cache pointer is set even if cache_size is zero.
595 * The local_cache points to just past the elt_pa[] array.
597 mp->local_cache = (struct rte_mempool_cache *)
598 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, pg_num, 0));
600 /* calculate address of the first element for continuous mempool. */
601 obj = (char *)mp + MEMPOOL_HEADER_SIZE(mp, pg_num, cache_size) +
603 obj = RTE_PTR_ALIGN_CEIL(obj, RTE_MEMPOOL_ALIGN);
605 /* populate address translation fields. */
607 mp->pg_shift = pg_shift;
608 mp->pg_mask = RTE_LEN2MASK(mp->pg_shift, typeof(mp->pg_mask));
610 /* mempool elements allocated together with mempool */
612 mp->elt_va_start = (uintptr_t)obj;
613 mp->elt_pa[0] = mp->phys_addr +
614 (mp->elt_va_start - (uintptr_t)mp);
616 /* mempool elements in a separate chunk of memory. */
617 mp->elt_va_start = (uintptr_t)vaddr;
618 memcpy(mp->elt_pa, paddr, sizeof (mp->elt_pa[0]) * pg_num);
621 mp->elt_va_end = mp->elt_va_start;
623 /* call the initializer */
625 mp_init(mp, mp_init_arg);
627 mempool_populate(mp, n, 1, obj_init, obj_init_arg);
629 te->data = (void *) mp;
631 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
632 TAILQ_INSERT_TAIL(mempool_list, te, next);
633 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
634 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
639 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
646 /* Return the number of entries in the mempool */
648 rte_mempool_count(const struct rte_mempool *mp)
653 count = rte_ring_count(mp->ring);
655 if (mp->cache_size == 0)
658 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
659 count += mp->local_cache[lcore_id].len;
662 * due to race condition (access to len is not locked), the
663 * total can be greater than size... so fix the result
665 if (count > mp->size)
670 /* dump the cache status */
672 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
676 unsigned cache_count;
678 fprintf(f, " cache infos:\n");
679 fprintf(f, " cache_size=%"PRIu32"\n", mp->cache_size);
681 if (mp->cache_size == 0)
684 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
685 cache_count = mp->local_cache[lcore_id].len;
686 fprintf(f, " cache_count[%u]=%u\n", lcore_id, cache_count);
687 count += cache_count;
689 fprintf(f, " total_cache_count=%u\n", count);
693 #ifndef __INTEL_COMPILER
694 #pragma GCC diagnostic ignored "-Wcast-qual"
697 struct mempool_audit_arg {
698 const struct rte_mempool *mp;
703 /* check and update cookies or panic (internal) */
704 void rte_mempool_check_cookies(const struct rte_mempool *mp,
705 void * const *obj_table_const, unsigned n, int free)
707 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
708 struct rte_mempool_objhdr *hdr;
709 struct rte_mempool_objtlr *tlr;
715 /* Force to drop the "const" attribute. This is done only when
716 * DEBUG is enabled */
717 tmp = (void *) obj_table_const;
718 obj_table = (void **) tmp;
723 if (rte_mempool_from_obj(obj) != mp)
724 rte_panic("MEMPOOL: object is owned by another "
727 hdr = __mempool_get_header(obj);
728 cookie = hdr->cookie;
731 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
732 rte_log_set_history(0);
733 RTE_LOG(CRIT, MEMPOOL,
734 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
735 obj, (const void *) mp, cookie);
736 rte_panic("MEMPOOL: bad header cookie (put)\n");
738 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
739 } else if (free == 1) {
740 if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
741 rte_log_set_history(0);
742 RTE_LOG(CRIT, MEMPOOL,
743 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
744 obj, (const void *) mp, cookie);
745 rte_panic("MEMPOOL: bad header cookie (get)\n");
747 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
748 } else if (free == 2) {
749 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
750 cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
751 rte_log_set_history(0);
752 RTE_LOG(CRIT, MEMPOOL,
753 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
754 obj, (const void *) mp, cookie);
755 rte_panic("MEMPOOL: bad header cookie (audit)\n");
758 tlr = __mempool_get_trailer(obj);
759 cookie = tlr->cookie;
760 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
761 rte_log_set_history(0);
762 RTE_LOG(CRIT, MEMPOOL,
763 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
764 obj, (const void *) mp, cookie);
765 rte_panic("MEMPOOL: bad trailer cookie\n");
770 RTE_SET_USED(obj_table_const);
776 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
778 mempool_obj_audit(void *arg, void *start, void *end, uint32_t idx)
780 struct mempool_audit_arg *pa = arg;
783 obj = (char *)start + pa->mp->header_size;
784 pa->obj_end = (uintptr_t)end;
785 pa->obj_num = idx + 1;
786 __mempool_check_cookies(pa->mp, &obj, 1, 2);
790 mempool_audit_cookies(struct rte_mempool *mp)
792 uint32_t elt_sz, num;
793 struct mempool_audit_arg arg;
795 elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
798 arg.obj_end = mp->elt_va_start;
801 num = rte_mempool_obj_iter((void *)mp->elt_va_start,
803 mp->elt_pa, mp->pg_num, mp->pg_shift,
804 mempool_obj_audit, &arg);
806 if (num != mp->size) {
807 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
808 "iterated only over %u elements\n",
810 } else if (arg.obj_end != mp->elt_va_end || arg.obj_num != mp->size) {
811 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
812 "last callback va_end: %#tx (%#tx expeceted), "
813 "num of objects: %u (%u expected)\n",
815 arg.obj_end, mp->elt_va_end,
816 arg.obj_num, mp->size);
820 #define mempool_audit_cookies(mp) do {} while(0)
823 #ifndef __INTEL_COMPILER
824 #pragma GCC diagnostic error "-Wcast-qual"
827 /* check cookies before and after objects */
829 mempool_audit_cache(const struct rte_mempool *mp)
831 /* check cache size consistency */
834 if (mp->cache_size == 0)
837 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
838 if (mp->local_cache[lcore_id].len > mp->cache_flushthresh) {
839 RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
841 rte_panic("MEMPOOL: invalid cache len\n");
846 /* check the consistency of mempool (size, cookies, ...) */
848 rte_mempool_audit(struct rte_mempool *mp)
850 mempool_audit_cache(mp);
851 mempool_audit_cookies(mp);
853 /* For case where mempool DEBUG is not set, and cache size is 0 */
857 /* dump the status of the mempool on the console */
859 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
861 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
862 struct rte_mempool_debug_stats sum;
865 unsigned common_count;
866 unsigned cache_count;
868 RTE_ASSERT(f != NULL);
869 RTE_ASSERT(mp != NULL);
871 fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
872 fprintf(f, " flags=%x\n", mp->flags);
873 fprintf(f, " ring=<%s>@%p\n", mp->ring->name, mp->ring);
874 fprintf(f, " phys_addr=0x%" PRIx64 "\n", mp->phys_addr);
875 fprintf(f, " size=%"PRIu32"\n", mp->size);
876 fprintf(f, " header_size=%"PRIu32"\n", mp->header_size);
877 fprintf(f, " elt_size=%"PRIu32"\n", mp->elt_size);
878 fprintf(f, " trailer_size=%"PRIu32"\n", mp->trailer_size);
879 fprintf(f, " total_obj_size=%"PRIu32"\n",
880 mp->header_size + mp->elt_size + mp->trailer_size);
882 fprintf(f, " private_data_size=%"PRIu32"\n", mp->private_data_size);
883 fprintf(f, " pg_num=%"PRIu32"\n", mp->pg_num);
884 fprintf(f, " pg_shift=%"PRIu32"\n", mp->pg_shift);
885 fprintf(f, " pg_mask=%#tx\n", mp->pg_mask);
886 fprintf(f, " elt_va_start=%#tx\n", mp->elt_va_start);
887 fprintf(f, " elt_va_end=%#tx\n", mp->elt_va_end);
888 fprintf(f, " elt_pa[0]=0x%" PRIx64 "\n", mp->elt_pa[0]);
891 fprintf(f, " avg bytes/object=%#Lf\n",
892 (long double)(mp->elt_va_end - mp->elt_va_start) /
895 cache_count = rte_mempool_dump_cache(f, mp);
896 common_count = rte_ring_count(mp->ring);
897 if ((cache_count + common_count) > mp->size)
898 common_count = mp->size - cache_count;
899 fprintf(f, " common_pool_count=%u\n", common_count);
901 /* sum and dump statistics */
902 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
903 memset(&sum, 0, sizeof(sum));
904 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
905 sum.put_bulk += mp->stats[lcore_id].put_bulk;
906 sum.put_objs += mp->stats[lcore_id].put_objs;
907 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
908 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
909 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
910 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
912 fprintf(f, " stats:\n");
913 fprintf(f, " put_bulk=%"PRIu64"\n", sum.put_bulk);
914 fprintf(f, " put_objs=%"PRIu64"\n", sum.put_objs);
915 fprintf(f, " get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
916 fprintf(f, " get_success_objs=%"PRIu64"\n", sum.get_success_objs);
917 fprintf(f, " get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
918 fprintf(f, " get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
920 fprintf(f, " no statistics available\n");
923 rte_mempool_audit(mp);
926 /* dump the status of all mempools on the console */
928 rte_mempool_list_dump(FILE *f)
930 struct rte_mempool *mp = NULL;
931 struct rte_tailq_entry *te;
932 struct rte_mempool_list *mempool_list;
934 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
936 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
938 TAILQ_FOREACH(te, mempool_list, next) {
939 mp = (struct rte_mempool *) te->data;
940 rte_mempool_dump(f, mp);
943 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
946 /* search a mempool from its name */
948 rte_mempool_lookup(const char *name)
950 struct rte_mempool *mp = NULL;
951 struct rte_tailq_entry *te;
952 struct rte_mempool_list *mempool_list;
954 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
956 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
958 TAILQ_FOREACH(te, mempool_list, next) {
959 mp = (struct rte_mempool *) te->data;
960 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
964 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
974 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *),
977 struct rte_tailq_entry *te = NULL;
978 struct rte_mempool_list *mempool_list;
980 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
982 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
984 TAILQ_FOREACH(te, mempool_list, next) {
985 (*func)((struct rte_mempool *) te->data, arg);
988 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);