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));
142 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
143 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
144 tlr = __mempool_get_trailer(obj);
145 tlr->cookie = RTE_MEMPOOL_TRAILER_COOKIE;
147 /* call the initializer */
149 obj_init(mp, obj_init_arg, obj, obj_idx);
151 /* enqueue in ring */
152 rte_ring_sp_enqueue(mp->ring, obj);
155 /* Iterate through objects at the given address
157 * Given the pointer to the memory, and its topology in physical memory
158 * (the physical addresses table), iterate through the "elt_num" objects
159 * of size "elt_sz" aligned at "align". For each object in this memory
160 * chunk, invoke a callback. It returns the effective number of objects
164 rte_mempool_obj_iter(void *vaddr, uint32_t elt_num, size_t total_elt_sz,
165 size_t align, const phys_addr_t paddr[], uint32_t pg_num,
166 uint32_t pg_shift, rte_mempool_obj_iter_t obj_iter, void *obj_iter_arg)
170 uintptr_t end, start, va;
173 pg_sz = (uintptr_t)1 << pg_shift;
174 va = (uintptr_t)vaddr;
179 while (i != elt_num && j != pg_num) {
181 start = RTE_ALIGN_CEIL(va, align);
182 end = start + total_elt_sz;
184 /* index of the first page for the next element. */
185 pgf = (end >> pg_shift) - (start >> pg_shift);
187 /* index of the last page for the current element. */
188 pgn = ((end - 1) >> pg_shift) - (start >> pg_shift);
191 /* do we have enough space left for the element. */
197 paddr[k] + pg_sz == paddr[k + 1];
202 * if next pgn chunks of memory physically continuous,
203 * use it to create next element.
204 * otherwise, just skip that chunk unused.
207 if (obj_iter != NULL)
208 obj_iter(obj_iter_arg, (void *)start,
214 va = RTE_ALIGN_CEIL((va + 1), pg_sz);
223 * Populate mempool with the objects.
226 struct mempool_populate_arg {
227 struct rte_mempool *mp;
228 rte_mempool_obj_cb_t *obj_init;
233 mempool_obj_populate(void *arg, void *start, void *end, uint32_t idx)
235 struct mempool_populate_arg *pa = arg;
237 mempool_add_elem(pa->mp, start, idx, pa->obj_init, pa->obj_init_arg);
238 pa->mp->elt_va_end = (uintptr_t)end;
242 mempool_populate(struct rte_mempool *mp, size_t num, size_t align,
243 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg)
246 struct mempool_populate_arg arg;
248 elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
250 arg.obj_init = obj_init;
251 arg.obj_init_arg = obj_init_arg;
253 mp->size = rte_mempool_obj_iter((void *)mp->elt_va_start,
255 mp->elt_pa, mp->pg_num, mp->pg_shift,
256 mempool_obj_populate, &arg);
259 /* get the header, trailer and total size of a mempool element. */
261 rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
262 struct rte_mempool_objsz *sz)
264 struct rte_mempool_objsz lsz;
266 sz = (sz != NULL) ? sz : &lsz;
268 sz->header_size = sizeof(struct rte_mempool_objhdr);
269 if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
270 sz->header_size = RTE_ALIGN_CEIL(sz->header_size,
273 sz->trailer_size = sizeof(struct rte_mempool_objtlr);
275 /* element size is 8 bytes-aligned at least */
276 sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
278 /* expand trailer to next cache line */
279 if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
280 sz->total_size = sz->header_size + sz->elt_size +
282 sz->trailer_size += ((RTE_MEMPOOL_ALIGN -
283 (sz->total_size & RTE_MEMPOOL_ALIGN_MASK)) &
284 RTE_MEMPOOL_ALIGN_MASK);
288 * increase trailer to add padding between objects in order to
289 * spread them across memory channels/ranks
291 if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
293 new_size = optimize_object_size(sz->header_size + sz->elt_size +
295 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
298 if (! rte_eal_has_hugepages()) {
300 * compute trailer size so that pool elements fit exactly in
303 int page_size = getpagesize();
304 int new_size = page_size - sz->header_size - sz->elt_size;
305 if (new_size < 0 || (unsigned int)new_size < sz->trailer_size) {
306 printf("When hugepages are disabled, pool objects "
307 "can't exceed PAGE_SIZE: %d + %d + %d > %d\n",
308 sz->header_size, sz->elt_size, sz->trailer_size,
312 sz->trailer_size = new_size;
315 /* this is the size of an object, including header and trailer */
316 sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
318 return sz->total_size;
323 * Calculate maximum amount of memory required to store given number of objects.
326 rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift)
328 size_t n, pg_num, pg_sz, sz;
330 pg_sz = (size_t)1 << pg_shift;
332 if ((n = pg_sz / total_elt_sz) > 0) {
333 pg_num = (elt_num + n - 1) / n;
334 sz = pg_num << pg_shift;
336 sz = RTE_ALIGN_CEIL(total_elt_sz, pg_sz) * elt_num;
342 /* Callback used by rte_mempool_xmem_usage(): it sets the opaque
343 * argument to the end of the object.
346 mempool_lelem_iter(void *arg, __rte_unused void *start, void *end,
347 __rte_unused uint32_t idx)
349 *(uintptr_t *)arg = (uintptr_t)end;
353 * Calculate how much memory would be actually required with the
354 * given memory footprint to store required number of elements.
357 rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num, size_t total_elt_sz,
358 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
364 pg_sz = (size_t)1 << pg_shift;
365 va = (uintptr_t)vaddr;
368 if ((n = rte_mempool_obj_iter(vaddr, elt_num, total_elt_sz, 1,
369 paddr, pg_num, pg_shift, mempool_lelem_iter,
374 uv = RTE_ALIGN_CEIL(uv, pg_sz);
379 #ifndef RTE_LIBRTE_XEN_DOM0
380 /* stub if DOM0 support not configured */
382 rte_dom0_mempool_create(const char *name __rte_unused,
383 unsigned n __rte_unused,
384 unsigned elt_size __rte_unused,
385 unsigned cache_size __rte_unused,
386 unsigned private_data_size __rte_unused,
387 rte_mempool_ctor_t *mp_init __rte_unused,
388 void *mp_init_arg __rte_unused,
389 rte_mempool_obj_ctor_t *obj_init __rte_unused,
390 void *obj_init_arg __rte_unused,
391 int socket_id __rte_unused,
392 unsigned flags __rte_unused)
399 /* create the mempool */
401 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
402 unsigned cache_size, unsigned private_data_size,
403 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
404 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
405 int socket_id, unsigned flags)
407 if (rte_xen_dom0_supported())
408 return rte_dom0_mempool_create(name, n, elt_size,
409 cache_size, private_data_size,
410 mp_init, mp_init_arg,
411 obj_init, obj_init_arg,
414 return rte_mempool_xmem_create(name, n, elt_size,
415 cache_size, private_data_size,
416 mp_init, mp_init_arg,
417 obj_init, obj_init_arg,
419 NULL, NULL, MEMPOOL_PG_NUM_DEFAULT,
420 MEMPOOL_PG_SHIFT_MAX);
424 * Create the mempool over already allocated chunk of memory.
425 * That external memory buffer can consists of physically disjoint pages.
426 * Setting vaddr to NULL, makes mempool to fallback to original behaviour
427 * and allocate space for mempool and it's elements as one big chunk of
428 * physically continuos memory.
431 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
432 unsigned cache_size, unsigned private_data_size,
433 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
434 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
435 int socket_id, unsigned flags, void *vaddr,
436 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
438 char mz_name[RTE_MEMZONE_NAMESIZE];
439 char rg_name[RTE_RING_NAMESIZE];
440 struct rte_mempool_list *mempool_list;
441 struct rte_mempool *mp = NULL;
442 struct rte_tailq_entry *te = NULL;
443 struct rte_ring *r = NULL;
444 const struct rte_memzone *mz;
446 int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
449 struct rte_mempool_objsz objsz;
451 int page_size = getpagesize();
453 /* compilation-time checks */
454 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
455 RTE_CACHE_LINE_MASK) != 0);
456 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
457 RTE_CACHE_LINE_MASK) != 0);
458 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
459 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
460 RTE_CACHE_LINE_MASK) != 0);
461 RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
462 RTE_CACHE_LINE_MASK) != 0);
465 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
467 /* asked cache too big */
468 if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
469 CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
474 /* check that we have both VA and PA */
475 if (vaddr != NULL && paddr == NULL) {
480 /* Check that pg_num and pg_shift parameters are valid. */
481 if (pg_num < RTE_DIM(mp->elt_pa) || pg_shift > MEMPOOL_PG_SHIFT_MAX) {
486 /* "no cache align" imply "no spread" */
487 if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
488 flags |= MEMPOOL_F_NO_SPREAD;
491 if (flags & MEMPOOL_F_SP_PUT)
492 rg_flags |= RING_F_SP_ENQ;
493 if (flags & MEMPOOL_F_SC_GET)
494 rg_flags |= RING_F_SC_DEQ;
496 /* calculate mempool object sizes. */
497 if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
502 rte_rwlock_write_lock(RTE_EAL_MEMPOOL_RWLOCK);
504 /* allocate the ring that will be used to store objects */
505 /* Ring functions will return appropriate errors if we are
506 * running as a secondary process etc., so no checks made
507 * in this function for that condition */
508 snprintf(rg_name, sizeof(rg_name), RTE_MEMPOOL_MZ_FORMAT, name);
509 r = rte_ring_create(rg_name, rte_align32pow2(n+1), socket_id, rg_flags);
514 * reserve a memory zone for this mempool: private data is
517 private_data_size = (private_data_size +
518 RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
520 if (! rte_eal_has_hugepages()) {
522 * expand private data size to a whole page, so that the
523 * first pool element will start on a new standard page
525 int head = sizeof(struct rte_mempool);
526 int new_size = (private_data_size + head) % page_size;
528 private_data_size += page_size - new_size;
531 /* try to allocate tailq entry */
532 te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
534 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
539 * If user provided an external memory buffer, then use it to
540 * store mempool objects. Otherwise reserve a memzone that is large
541 * enough to hold mempool header and metadata plus mempool objects.
543 mempool_size = MEMPOOL_HEADER_SIZE(mp, pg_num, cache_size);
544 mempool_size += private_data_size;
545 mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
547 mempool_size += (size_t)objsz.total_size * n;
549 if (! rte_eal_has_hugepages()) {
551 * we want the memory pool to start on a page boundary,
552 * because pool elements crossing page boundaries would
553 * result in discontiguous physical addresses
555 mempool_size += page_size;
558 snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
560 mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
564 if (rte_eal_has_hugepages()) {
565 startaddr = (void*)mz->addr;
567 /* align memory pool start address on a page boundary */
568 unsigned long addr = (unsigned long)mz->addr;
569 if (addr & (page_size - 1)) {
571 addr &= ~(page_size - 1);
573 startaddr = (void*)addr;
576 /* init the mempool structure */
578 memset(mp, 0, sizeof(*mp));
579 snprintf(mp->name, sizeof(mp->name), "%s", name);
580 mp->phys_addr = mz->phys_addr;
584 mp->elt_size = objsz.elt_size;
585 mp->header_size = objsz.header_size;
586 mp->trailer_size = objsz.trailer_size;
587 mp->cache_size = cache_size;
588 mp->cache_flushthresh = CALC_CACHE_FLUSHTHRESH(cache_size);
589 mp->private_data_size = private_data_size;
592 * local_cache pointer is set even if cache_size is zero.
593 * The local_cache points to just past the elt_pa[] array.
595 mp->local_cache = (struct rte_mempool_cache *)
596 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, pg_num, 0));
598 /* calculate address of the first element for continuous mempool. */
599 obj = (char *)mp + MEMPOOL_HEADER_SIZE(mp, pg_num, cache_size) +
601 obj = RTE_PTR_ALIGN_CEIL(obj, RTE_MEMPOOL_ALIGN);
603 /* populate address translation fields. */
605 mp->pg_shift = pg_shift;
606 mp->pg_mask = RTE_LEN2MASK(mp->pg_shift, typeof(mp->pg_mask));
608 /* mempool elements allocated together with mempool */
610 mp->elt_va_start = (uintptr_t)obj;
611 mp->elt_pa[0] = mp->phys_addr +
612 (mp->elt_va_start - (uintptr_t)mp);
614 /* mempool elements in a separate chunk of memory. */
615 mp->elt_va_start = (uintptr_t)vaddr;
616 memcpy(mp->elt_pa, paddr, sizeof (mp->elt_pa[0]) * pg_num);
619 mp->elt_va_end = mp->elt_va_start;
621 /* call the initializer */
623 mp_init(mp, mp_init_arg);
625 mempool_populate(mp, n, 1, obj_init, obj_init_arg);
627 te->data = (void *) mp;
629 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
630 TAILQ_INSERT_TAIL(mempool_list, te, next);
631 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
632 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
637 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
644 /* Return the number of entries in the mempool */
646 rte_mempool_count(const struct rte_mempool *mp)
651 count = rte_ring_count(mp->ring);
653 if (mp->cache_size == 0)
656 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
657 count += mp->local_cache[lcore_id].len;
660 * due to race condition (access to len is not locked), the
661 * total can be greater than size... so fix the result
663 if (count > mp->size)
668 /* dump the cache status */
670 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
674 unsigned cache_count;
676 fprintf(f, " cache infos:\n");
677 fprintf(f, " cache_size=%"PRIu32"\n", mp->cache_size);
679 if (mp->cache_size == 0)
682 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
683 cache_count = mp->local_cache[lcore_id].len;
684 fprintf(f, " cache_count[%u]=%u\n", lcore_id, cache_count);
685 count += cache_count;
687 fprintf(f, " total_cache_count=%u\n", count);
691 #ifndef __INTEL_COMPILER
692 #pragma GCC diagnostic ignored "-Wcast-qual"
695 struct mempool_audit_arg {
696 const struct rte_mempool *mp;
701 /* check and update cookies or panic (internal) */
702 void rte_mempool_check_cookies(const struct rte_mempool *mp,
703 void * const *obj_table_const, unsigned n, int free)
705 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
706 struct rte_mempool_objhdr *hdr;
707 struct rte_mempool_objtlr *tlr;
713 /* Force to drop the "const" attribute. This is done only when
714 * DEBUG is enabled */
715 tmp = (void *) obj_table_const;
716 obj_table = (void **) tmp;
721 if (rte_mempool_from_obj(obj) != mp)
722 rte_panic("MEMPOOL: object is owned by another "
725 hdr = __mempool_get_header(obj);
726 cookie = hdr->cookie;
729 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
730 rte_log_set_history(0);
731 RTE_LOG(CRIT, MEMPOOL,
732 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
733 obj, (const void *) mp, cookie);
734 rte_panic("MEMPOOL: bad header cookie (put)\n");
736 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
737 } else if (free == 1) {
738 if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
739 rte_log_set_history(0);
740 RTE_LOG(CRIT, MEMPOOL,
741 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
742 obj, (const void *) mp, cookie);
743 rte_panic("MEMPOOL: bad header cookie (get)\n");
745 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
746 } else if (free == 2) {
747 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
748 cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
749 rte_log_set_history(0);
750 RTE_LOG(CRIT, MEMPOOL,
751 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
752 obj, (const void *) mp, cookie);
753 rte_panic("MEMPOOL: bad header cookie (audit)\n");
756 tlr = __mempool_get_trailer(obj);
757 cookie = tlr->cookie;
758 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
759 rte_log_set_history(0);
760 RTE_LOG(CRIT, MEMPOOL,
761 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
762 obj, (const void *) mp, cookie);
763 rte_panic("MEMPOOL: bad trailer cookie\n");
768 RTE_SET_USED(obj_table_const);
774 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
776 mempool_obj_audit(void *arg, void *start, void *end, uint32_t idx)
778 struct mempool_audit_arg *pa = arg;
781 obj = (char *)start + pa->mp->header_size;
782 pa->obj_end = (uintptr_t)end;
783 pa->obj_num = idx + 1;
784 __mempool_check_cookies(pa->mp, &obj, 1, 2);
788 mempool_audit_cookies(const struct rte_mempool *mp)
790 uint32_t elt_sz, num;
791 struct mempool_audit_arg arg;
793 elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
796 arg.obj_end = mp->elt_va_start;
799 num = rte_mempool_obj_iter((void *)mp->elt_va_start,
801 mp->elt_pa, mp->pg_num, mp->pg_shift,
802 mempool_obj_audit, &arg);
804 if (num != mp->size) {
805 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
806 "iterated only over %u elements\n",
808 } else if (arg.obj_end != mp->elt_va_end || arg.obj_num != mp->size) {
809 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
810 "last callback va_end: %#tx (%#tx expeceted), "
811 "num of objects: %u (%u expected)\n",
813 arg.obj_end, mp->elt_va_end,
814 arg.obj_num, mp->size);
818 #define mempool_audit_cookies(mp) do {} while(0)
821 #ifndef __INTEL_COMPILER
822 #pragma GCC diagnostic error "-Wcast-qual"
825 /* check cookies before and after objects */
827 mempool_audit_cache(const struct rte_mempool *mp)
829 /* check cache size consistency */
832 if (mp->cache_size == 0)
835 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
836 if (mp->local_cache[lcore_id].len > mp->cache_flushthresh) {
837 RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
839 rte_panic("MEMPOOL: invalid cache len\n");
844 /* check the consistency of mempool (size, cookies, ...) */
846 rte_mempool_audit(const struct rte_mempool *mp)
848 mempool_audit_cache(mp);
849 mempool_audit_cookies(mp);
851 /* For case where mempool DEBUG is not set, and cache size is 0 */
855 /* dump the status of the mempool on the console */
857 rte_mempool_dump(FILE *f, const struct rte_mempool *mp)
859 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
860 struct rte_mempool_debug_stats sum;
863 unsigned common_count;
864 unsigned cache_count;
866 RTE_ASSERT(f != NULL);
867 RTE_ASSERT(mp != NULL);
869 fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
870 fprintf(f, " flags=%x\n", mp->flags);
871 fprintf(f, " ring=<%s>@%p\n", mp->ring->name, mp->ring);
872 fprintf(f, " phys_addr=0x%" PRIx64 "\n", mp->phys_addr);
873 fprintf(f, " size=%"PRIu32"\n", mp->size);
874 fprintf(f, " header_size=%"PRIu32"\n", mp->header_size);
875 fprintf(f, " elt_size=%"PRIu32"\n", mp->elt_size);
876 fprintf(f, " trailer_size=%"PRIu32"\n", mp->trailer_size);
877 fprintf(f, " total_obj_size=%"PRIu32"\n",
878 mp->header_size + mp->elt_size + mp->trailer_size);
880 fprintf(f, " private_data_size=%"PRIu32"\n", mp->private_data_size);
881 fprintf(f, " pg_num=%"PRIu32"\n", mp->pg_num);
882 fprintf(f, " pg_shift=%"PRIu32"\n", mp->pg_shift);
883 fprintf(f, " pg_mask=%#tx\n", mp->pg_mask);
884 fprintf(f, " elt_va_start=%#tx\n", mp->elt_va_start);
885 fprintf(f, " elt_va_end=%#tx\n", mp->elt_va_end);
886 fprintf(f, " elt_pa[0]=0x%" PRIx64 "\n", mp->elt_pa[0]);
889 fprintf(f, " avg bytes/object=%#Lf\n",
890 (long double)(mp->elt_va_end - mp->elt_va_start) /
893 cache_count = rte_mempool_dump_cache(f, mp);
894 common_count = rte_ring_count(mp->ring);
895 if ((cache_count + common_count) > mp->size)
896 common_count = mp->size - cache_count;
897 fprintf(f, " common_pool_count=%u\n", common_count);
899 /* sum and dump statistics */
900 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
901 memset(&sum, 0, sizeof(sum));
902 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
903 sum.put_bulk += mp->stats[lcore_id].put_bulk;
904 sum.put_objs += mp->stats[lcore_id].put_objs;
905 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
906 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
907 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
908 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
910 fprintf(f, " stats:\n");
911 fprintf(f, " put_bulk=%"PRIu64"\n", sum.put_bulk);
912 fprintf(f, " put_objs=%"PRIu64"\n", sum.put_objs);
913 fprintf(f, " get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
914 fprintf(f, " get_success_objs=%"PRIu64"\n", sum.get_success_objs);
915 fprintf(f, " get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
916 fprintf(f, " get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
918 fprintf(f, " no statistics available\n");
921 rte_mempool_audit(mp);
924 /* dump the status of all mempools on the console */
926 rte_mempool_list_dump(FILE *f)
928 const struct rte_mempool *mp = NULL;
929 struct rte_tailq_entry *te;
930 struct rte_mempool_list *mempool_list;
932 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
934 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
936 TAILQ_FOREACH(te, mempool_list, next) {
937 mp = (struct rte_mempool *) te->data;
938 rte_mempool_dump(f, mp);
941 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
944 /* search a mempool from its name */
946 rte_mempool_lookup(const char *name)
948 struct rte_mempool *mp = NULL;
949 struct rte_tailq_entry *te;
950 struct rte_mempool_list *mempool_list;
952 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
954 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
956 TAILQ_FOREACH(te, mempool_list, next) {
957 mp = (struct rte_mempool *) te->data;
958 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
962 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
972 void rte_mempool_walk(void (*func)(const struct rte_mempool *, void *),
975 struct rte_tailq_entry *te = NULL;
976 struct rte_mempool_list *mempool_list;
978 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
980 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
982 TAILQ_FOREACH(te, mempool_list, next) {
983 (*func)((struct rte_mempool *) te->data, arg);
986 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);