4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright(c) 2016 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 #include <sys/queue.h>
44 #include <rte_common.h>
46 #include <rte_debug.h>
47 #include <rte_memory.h>
48 #include <rte_memzone.h>
49 #include <rte_malloc.h>
50 #include <rte_atomic.h>
51 #include <rte_launch.h>
53 #include <rte_eal_memconfig.h>
54 #include <rte_per_lcore.h>
55 #include <rte_lcore.h>
56 #include <rte_branch_prediction.h>
58 #include <rte_errno.h>
59 #include <rte_string_fns.h>
60 #include <rte_spinlock.h>
62 #include "rte_mempool.h"
64 TAILQ_HEAD(rte_mempool_list, rte_tailq_entry);
66 static struct rte_tailq_elem rte_mempool_tailq = {
67 .name = "RTE_MEMPOOL",
69 EAL_REGISTER_TAILQ(rte_mempool_tailq)
71 #define CACHE_FLUSHTHRESH_MULTIPLIER 1.5
72 #define CALC_CACHE_FLUSHTHRESH(c) \
73 ((typeof(c))((c) * CACHE_FLUSHTHRESH_MULTIPLIER))
76 * return the greatest common divisor between a and b (fast algorithm)
79 static unsigned get_gcd(unsigned a, unsigned b)
104 * Depending on memory configuration, objects addresses are spread
105 * between channels and ranks in RAM: the pool allocator will add
106 * padding between objects. This function return the new size of the
109 static unsigned optimize_object_size(unsigned obj_size)
111 unsigned nrank, nchan;
112 unsigned new_obj_size;
114 /* get number of channels */
115 nchan = rte_memory_get_nchannel();
119 nrank = rte_memory_get_nrank();
123 /* process new object size */
124 new_obj_size = (obj_size + RTE_MEMPOOL_ALIGN_MASK) / RTE_MEMPOOL_ALIGN;
125 while (get_gcd(new_obj_size, nrank * nchan) != 1)
127 return new_obj_size * RTE_MEMPOOL_ALIGN;
131 mempool_add_elem(struct rte_mempool *mp, void *obj, phys_addr_t physaddr)
133 struct rte_mempool_objhdr *hdr;
134 struct rte_mempool_objtlr *tlr __rte_unused;
136 /* set mempool ptr in header */
137 hdr = RTE_PTR_SUB(obj, sizeof(*hdr));
139 hdr->physaddr = physaddr;
140 STAILQ_INSERT_TAIL(&mp->elt_list, hdr, next);
141 mp->populated_size++;
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;
149 /* enqueue in ring */
150 rte_ring_sp_enqueue(mp->ring, obj);
153 /* call obj_cb() for each mempool element */
155 rte_mempool_obj_iter(struct rte_mempool *mp,
156 rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg)
158 struct rte_mempool_objhdr *hdr;
162 STAILQ_FOREACH(hdr, &mp->elt_list, next) {
163 obj = (char *)hdr + sizeof(*hdr);
164 obj_cb(mp, obj_cb_arg, obj, n);
171 /* call mem_cb() for each mempool memory chunk */
173 rte_mempool_mem_iter(struct rte_mempool *mp,
174 rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg)
176 struct rte_mempool_memhdr *hdr;
179 STAILQ_FOREACH(hdr, &mp->mem_list, next) {
180 mem_cb(mp, mem_cb_arg, hdr, n);
187 /* get the header, trailer and total size of a mempool element. */
189 rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
190 struct rte_mempool_objsz *sz)
192 struct rte_mempool_objsz lsz;
194 sz = (sz != NULL) ? sz : &lsz;
196 sz->header_size = sizeof(struct rte_mempool_objhdr);
197 if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
198 sz->header_size = RTE_ALIGN_CEIL(sz->header_size,
201 sz->trailer_size = sizeof(struct rte_mempool_objtlr);
203 /* element size is 8 bytes-aligned at least */
204 sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
206 /* expand trailer to next cache line */
207 if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
208 sz->total_size = sz->header_size + sz->elt_size +
210 sz->trailer_size += ((RTE_MEMPOOL_ALIGN -
211 (sz->total_size & RTE_MEMPOOL_ALIGN_MASK)) &
212 RTE_MEMPOOL_ALIGN_MASK);
216 * increase trailer to add padding between objects in order to
217 * spread them across memory channels/ranks
219 if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
221 new_size = optimize_object_size(sz->header_size + sz->elt_size +
223 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
226 if (! rte_eal_has_hugepages()) {
228 * compute trailer size so that pool elements fit exactly in
231 int page_size = getpagesize();
232 int new_size = page_size - sz->header_size - sz->elt_size;
233 if (new_size < 0 || (unsigned int)new_size < sz->trailer_size) {
234 printf("When hugepages are disabled, pool objects "
235 "can't exceed PAGE_SIZE: %d + %d + %d > %d\n",
236 sz->header_size, sz->elt_size, sz->trailer_size,
240 sz->trailer_size = new_size;
243 /* this is the size of an object, including header and trailer */
244 sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
246 return sz->total_size;
251 * Calculate maximum amount of memory required to store given number of objects.
254 rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift)
256 size_t obj_per_page, pg_num, pg_sz;
259 return total_elt_sz * elt_num;
261 pg_sz = (size_t)1 << pg_shift;
262 obj_per_page = pg_sz / total_elt_sz;
263 if (obj_per_page == 0)
264 return RTE_ALIGN_CEIL(total_elt_sz, pg_sz) * elt_num;
266 pg_num = (elt_num + obj_per_page - 1) / obj_per_page;
267 return pg_num << pg_shift;
271 * Calculate how much memory would be actually required with the
272 * given memory footprint to store required number of elements.
275 rte_mempool_xmem_usage(__rte_unused void *vaddr, uint32_t elt_num,
276 size_t total_elt_sz, const phys_addr_t paddr[], uint32_t pg_num,
279 uint32_t elt_cnt = 0;
280 phys_addr_t start, end;
282 size_t pg_sz = (size_t)1 << pg_shift;
284 /* if paddr is NULL, assume contiguous memory */
287 end = pg_sz * pg_num;
291 end = paddr[0] + pg_sz;
294 while (elt_cnt < elt_num) {
296 if (end - start >= total_elt_sz) {
297 /* enough contiguous memory, add an object */
298 start += total_elt_sz;
300 } else if (paddr_idx < pg_num) {
301 /* no room to store one obj, add a page */
302 if (end == paddr[paddr_idx]) {
305 start = paddr[paddr_idx];
306 end = paddr[paddr_idx] + pg_sz;
311 /* no more page, return how many elements fit */
312 return -(size_t)elt_cnt;
316 return (size_t)paddr_idx << pg_shift;
319 #ifndef RTE_LIBRTE_XEN_DOM0
320 /* stub if DOM0 support not configured */
322 rte_dom0_mempool_create(const char *name __rte_unused,
323 unsigned n __rte_unused,
324 unsigned elt_size __rte_unused,
325 unsigned cache_size __rte_unused,
326 unsigned private_data_size __rte_unused,
327 rte_mempool_ctor_t *mp_init __rte_unused,
328 void *mp_init_arg __rte_unused,
329 rte_mempool_obj_ctor_t *obj_init __rte_unused,
330 void *obj_init_arg __rte_unused,
331 int socket_id __rte_unused,
332 unsigned flags __rte_unused)
339 /* create the mempool */
341 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
342 unsigned cache_size, unsigned private_data_size,
343 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
344 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
345 int socket_id, unsigned flags)
347 if (rte_xen_dom0_supported())
348 return rte_dom0_mempool_create(name, n, elt_size,
349 cache_size, private_data_size,
350 mp_init, mp_init_arg,
351 obj_init, obj_init_arg,
354 return rte_mempool_xmem_create(name, n, elt_size,
355 cache_size, private_data_size,
356 mp_init, mp_init_arg,
357 obj_init, obj_init_arg,
359 NULL, NULL, MEMPOOL_PG_NUM_DEFAULT,
360 MEMPOOL_PG_SHIFT_MAX);
363 /* create the internal ring */
365 rte_mempool_ring_create(struct rte_mempool *mp)
368 char rg_name[RTE_RING_NAMESIZE];
371 snprintf(rg_name, sizeof(rg_name), RTE_MEMPOOL_MZ_FORMAT, mp->name);
374 if (mp->flags & MEMPOOL_F_SP_PUT)
375 rg_flags |= RING_F_SP_ENQ;
376 if (mp->flags & MEMPOOL_F_SC_GET)
377 rg_flags |= RING_F_SC_DEQ;
379 /* Allocate the ring that will be used to store objects.
380 * Ring functions will return appropriate errors if we are
381 * running as a secondary process etc., so no checks made
382 * in this function for that condition.
384 r = rte_ring_create(rg_name, rte_align32pow2(mp->size + 1),
385 mp->socket_id, rg_flags);
393 /* free a memchunk allocated with rte_memzone_reserve() */
394 __rte_unused static void
395 rte_mempool_memchunk_mz_free(__rte_unused struct rte_mempool_memhdr *memhdr,
398 const struct rte_memzone *mz = opaque;
399 rte_memzone_free(mz);
402 /* Free memory chunks used by a mempool. Objects must be in pool */
404 rte_mempool_free_memchunks(struct rte_mempool *mp)
406 struct rte_mempool_memhdr *memhdr;
409 while (!STAILQ_EMPTY(&mp->elt_list)) {
410 rte_ring_sc_dequeue(mp->ring, &elt);
412 STAILQ_REMOVE_HEAD(&mp->elt_list, next);
413 mp->populated_size--;
416 while (!STAILQ_EMPTY(&mp->mem_list)) {
417 memhdr = STAILQ_FIRST(&mp->mem_list);
418 STAILQ_REMOVE_HEAD(&mp->mem_list, next);
419 if (memhdr->free_cb != NULL)
420 memhdr->free_cb(memhdr, memhdr->opaque);
426 /* Add objects in the pool, using a physically contiguous memory
427 * zone. Return the number of objects added, or a negative value
431 rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
432 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
435 unsigned total_elt_sz;
438 struct rte_mempool_memhdr *memhdr;
440 /* mempool is already populated */
441 if (mp->populated_size >= mp->size)
444 total_elt_sz = mp->header_size + mp->elt_size + mp->trailer_size;
446 memhdr = rte_zmalloc("MEMPOOL_MEMHDR", sizeof(*memhdr), 0);
451 memhdr->addr = vaddr;
452 memhdr->phys_addr = paddr;
454 memhdr->free_cb = free_cb;
455 memhdr->opaque = opaque;
457 if (mp->flags & MEMPOOL_F_NO_CACHE_ALIGN)
458 off = RTE_PTR_ALIGN_CEIL(vaddr, 8) - vaddr;
460 off = RTE_PTR_ALIGN_CEIL(vaddr, RTE_CACHE_LINE_SIZE) - vaddr;
462 while (off + total_elt_sz <= len && mp->populated_size < mp->size) {
463 off += mp->header_size;
464 mempool_add_elem(mp, (char *)vaddr + off, paddr + off);
465 off += mp->elt_size + mp->trailer_size;
469 /* not enough room to store one object */
473 STAILQ_INSERT_TAIL(&mp->mem_list, memhdr, next);
478 /* Add objects in the pool, using a table of physical pages. Return the
479 * number of objects added, or a negative value on error.
482 rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
483 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
484 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque)
488 size_t pg_sz = (size_t)1 << pg_shift;
490 /* mempool must not be populated */
491 if (mp->nb_mem_chunks != 0)
494 for (i = 0; i < pg_num && mp->populated_size < mp->size; i += n) {
496 /* populate with the largest group of contiguous pages */
497 for (n = 1; (i + n) < pg_num &&
498 paddr[i] + pg_sz == paddr[i+n]; n++)
501 ret = rte_mempool_populate_phys(mp, vaddr + i * pg_sz,
502 paddr[i], n * pg_sz, free_cb, opaque);
504 rte_mempool_free_memchunks(mp);
507 /* no need to call the free callback for next chunks */
515 * Create the mempool over already allocated chunk of memory.
516 * That external memory buffer can consists of physically disjoint pages.
517 * Setting vaddr to NULL, makes mempool to fallback to original behaviour
518 * and allocate space for mempool and it's elements as one big chunk of
519 * physically continuos memory.
522 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
523 unsigned cache_size, unsigned private_data_size,
524 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
525 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
526 int socket_id, unsigned flags, void *vaddr,
527 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
529 char mz_name[RTE_MEMZONE_NAMESIZE];
530 struct rte_mempool_list *mempool_list;
531 struct rte_mempool *mp = NULL;
532 struct rte_tailq_entry *te = NULL;
533 const struct rte_memzone *mz;
535 int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
537 struct rte_mempool_objsz objsz;
539 int page_size = getpagesize();
542 /* compilation-time checks */
543 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
544 RTE_CACHE_LINE_MASK) != 0);
545 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
546 RTE_CACHE_LINE_MASK) != 0);
547 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
548 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
549 RTE_CACHE_LINE_MASK) != 0);
550 RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
551 RTE_CACHE_LINE_MASK) != 0);
554 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
556 /* asked cache too big */
557 if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
558 CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
563 /* check that we have both VA and PA */
564 if (vaddr != NULL && paddr == NULL) {
569 /* Check that pg_num and pg_shift parameters are valid. */
570 if (pg_num == 0 || pg_shift > MEMPOOL_PG_SHIFT_MAX) {
575 /* "no cache align" imply "no spread" */
576 if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
577 flags |= MEMPOOL_F_NO_SPREAD;
579 /* calculate mempool object sizes. */
580 if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
585 rte_rwlock_write_lock(RTE_EAL_MEMPOOL_RWLOCK);
588 * reserve a memory zone for this mempool: private data is
591 private_data_size = (private_data_size +
592 RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
594 if (! rte_eal_has_hugepages()) {
596 * expand private data size to a whole page, so that the
597 * first pool element will start on a new standard page
599 int head = sizeof(struct rte_mempool);
600 int new_size = (private_data_size + head) % page_size;
602 private_data_size += page_size - new_size;
605 /* try to allocate tailq entry */
606 te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
608 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
613 * If user provided an external memory buffer, then use it to
614 * store mempool objects. Otherwise reserve a memzone that is large
615 * enough to hold mempool header and metadata plus mempool objects.
617 mempool_size = MEMPOOL_HEADER_SIZE(mp, cache_size);
618 mempool_size += private_data_size;
619 mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
621 mempool_size += (size_t)objsz.total_size * n;
623 if (! rte_eal_has_hugepages()) {
625 * we want the memory pool to start on a page boundary,
626 * because pool elements crossing page boundaries would
627 * result in discontiguous physical addresses
629 mempool_size += page_size;
632 snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
634 mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
638 if (rte_eal_has_hugepages()) {
639 startaddr = (void*)mz->addr;
641 /* align memory pool start address on a page boundary */
642 unsigned long addr = (unsigned long)mz->addr;
643 if (addr & (page_size - 1)) {
645 addr &= ~(page_size - 1);
647 startaddr = (void*)addr;
650 /* init the mempool structure */
652 memset(mp, 0, sizeof(*mp));
653 snprintf(mp->name, sizeof(mp->name), "%s", name);
654 mp->phys_addr = mz->phys_addr;
655 mp->socket_id = socket_id;
658 mp->elt_size = objsz.elt_size;
659 mp->header_size = objsz.header_size;
660 mp->trailer_size = objsz.trailer_size;
661 mp->cache_size = cache_size;
662 mp->cache_flushthresh = CALC_CACHE_FLUSHTHRESH(cache_size);
663 mp->private_data_size = private_data_size;
664 STAILQ_INIT(&mp->elt_list);
665 STAILQ_INIT(&mp->mem_list);
667 if (rte_mempool_ring_create(mp) < 0)
671 * local_cache pointer is set even if cache_size is zero.
672 * The local_cache points to just past the elt_pa[] array.
674 mp->local_cache = (struct rte_mempool_cache *)
675 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, 0));
677 /* call the initializer */
679 mp_init(mp, mp_init_arg);
681 /* mempool elements allocated together with mempool */
683 /* calculate address of the first elt for continuous mempool. */
684 obj = (char *)mp + MEMPOOL_HEADER_SIZE(mp, cache_size) +
686 obj = RTE_PTR_ALIGN_CEIL(obj, RTE_MEMPOOL_ALIGN);
688 ret = rte_mempool_populate_phys(mp, obj,
689 mp->phys_addr + ((char *)obj - (char *)mp),
690 objsz.total_size * n, NULL, NULL);
691 if (ret != (int)mp->size)
694 ret = rte_mempool_populate_phys_tab(mp, vaddr,
695 paddr, pg_num, pg_shift, NULL, NULL);
696 if (ret != (int)mp->size)
700 /* call the initializer */
702 rte_mempool_obj_iter(mp, obj_init, obj_init_arg);
704 te->data = (void *) mp;
706 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
707 TAILQ_INSERT_TAIL(mempool_list, te, next);
708 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
709 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
714 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
716 rte_mempool_free_memchunks(mp);
717 rte_ring_free(mp->ring);
724 /* Return the number of entries in the mempool */
726 rte_mempool_count(const struct rte_mempool *mp)
731 count = rte_ring_count(mp->ring);
733 if (mp->cache_size == 0)
736 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
737 count += mp->local_cache[lcore_id].len;
740 * due to race condition (access to len is not locked), the
741 * total can be greater than size... so fix the result
743 if (count > mp->size)
748 /* dump the cache status */
750 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
754 unsigned cache_count;
756 fprintf(f, " cache infos:\n");
757 fprintf(f, " cache_size=%"PRIu32"\n", mp->cache_size);
759 if (mp->cache_size == 0)
762 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
763 cache_count = mp->local_cache[lcore_id].len;
764 fprintf(f, " cache_count[%u]=%u\n", lcore_id, cache_count);
765 count += cache_count;
767 fprintf(f, " total_cache_count=%u\n", count);
771 #ifndef __INTEL_COMPILER
772 #pragma GCC diagnostic ignored "-Wcast-qual"
775 /* check and update cookies or panic (internal) */
776 void rte_mempool_check_cookies(const struct rte_mempool *mp,
777 void * const *obj_table_const, unsigned n, int free)
779 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
780 struct rte_mempool_objhdr *hdr;
781 struct rte_mempool_objtlr *tlr;
787 /* Force to drop the "const" attribute. This is done only when
788 * DEBUG is enabled */
789 tmp = (void *) obj_table_const;
790 obj_table = (void **) tmp;
795 if (rte_mempool_from_obj(obj) != mp)
796 rte_panic("MEMPOOL: object is owned by another "
799 hdr = __mempool_get_header(obj);
800 cookie = hdr->cookie;
803 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
804 rte_log_set_history(0);
805 RTE_LOG(CRIT, MEMPOOL,
806 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
807 obj, (const void *) mp, cookie);
808 rte_panic("MEMPOOL: bad header cookie (put)\n");
810 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
811 } else if (free == 1) {
812 if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
813 rte_log_set_history(0);
814 RTE_LOG(CRIT, MEMPOOL,
815 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
816 obj, (const void *) mp, cookie);
817 rte_panic("MEMPOOL: bad header cookie (get)\n");
819 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
820 } else if (free == 2) {
821 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
822 cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
823 rte_log_set_history(0);
824 RTE_LOG(CRIT, MEMPOOL,
825 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
826 obj, (const void *) mp, cookie);
827 rte_panic("MEMPOOL: bad header cookie (audit)\n");
830 tlr = __mempool_get_trailer(obj);
831 cookie = tlr->cookie;
832 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
833 rte_log_set_history(0);
834 RTE_LOG(CRIT, MEMPOOL,
835 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
836 obj, (const void *) mp, cookie);
837 rte_panic("MEMPOOL: bad trailer cookie\n");
842 RTE_SET_USED(obj_table_const);
848 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
850 mempool_obj_audit(struct rte_mempool *mp, __rte_unused void *opaque,
851 void *obj, __rte_unused unsigned idx)
853 __mempool_check_cookies(mp, &obj, 1, 2);
857 mempool_audit_cookies(struct rte_mempool *mp)
861 num = rte_mempool_obj_iter(mp, mempool_obj_audit, NULL);
862 if (num != mp->size) {
863 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
864 "iterated only over %u elements\n",
869 #define mempool_audit_cookies(mp) do {} while(0)
872 #ifndef __INTEL_COMPILER
873 #pragma GCC diagnostic error "-Wcast-qual"
876 /* check cookies before and after objects */
878 mempool_audit_cache(const struct rte_mempool *mp)
880 /* check cache size consistency */
883 if (mp->cache_size == 0)
886 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
887 if (mp->local_cache[lcore_id].len > mp->cache_flushthresh) {
888 RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
890 rte_panic("MEMPOOL: invalid cache len\n");
895 /* check the consistency of mempool (size, cookies, ...) */
897 rte_mempool_audit(struct rte_mempool *mp)
899 mempool_audit_cache(mp);
900 mempool_audit_cookies(mp);
902 /* For case where mempool DEBUG is not set, and cache size is 0 */
906 /* dump the status of the mempool on the console */
908 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
910 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
911 struct rte_mempool_debug_stats sum;
914 struct rte_mempool_memhdr *memhdr;
915 unsigned common_count;
916 unsigned cache_count;
919 RTE_ASSERT(f != NULL);
920 RTE_ASSERT(mp != NULL);
922 fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
923 fprintf(f, " flags=%x\n", mp->flags);
924 fprintf(f, " ring=<%s>@%p\n", mp->ring->name, mp->ring);
925 fprintf(f, " phys_addr=0x%" PRIx64 "\n", mp->phys_addr);
926 fprintf(f, " nb_mem_chunks=%u\n", mp->nb_mem_chunks);
927 fprintf(f, " size=%"PRIu32"\n", mp->size);
928 fprintf(f, " populated_size=%"PRIu32"\n", mp->populated_size);
929 fprintf(f, " header_size=%"PRIu32"\n", mp->header_size);
930 fprintf(f, " elt_size=%"PRIu32"\n", mp->elt_size);
931 fprintf(f, " trailer_size=%"PRIu32"\n", mp->trailer_size);
932 fprintf(f, " total_obj_size=%"PRIu32"\n",
933 mp->header_size + mp->elt_size + mp->trailer_size);
935 fprintf(f, " private_data_size=%"PRIu32"\n", mp->private_data_size);
937 STAILQ_FOREACH(memhdr, &mp->mem_list, next)
938 mem_len += memhdr->len;
940 fprintf(f, " avg bytes/object=%#Lf\n",
941 (long double)mem_len / mp->size);
944 cache_count = rte_mempool_dump_cache(f, mp);
945 common_count = rte_ring_count(mp->ring);
946 if ((cache_count + common_count) > mp->size)
947 common_count = mp->size - cache_count;
948 fprintf(f, " common_pool_count=%u\n", common_count);
950 /* sum and dump statistics */
951 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
952 memset(&sum, 0, sizeof(sum));
953 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
954 sum.put_bulk += mp->stats[lcore_id].put_bulk;
955 sum.put_objs += mp->stats[lcore_id].put_objs;
956 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
957 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
958 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
959 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
961 fprintf(f, " stats:\n");
962 fprintf(f, " put_bulk=%"PRIu64"\n", sum.put_bulk);
963 fprintf(f, " put_objs=%"PRIu64"\n", sum.put_objs);
964 fprintf(f, " get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
965 fprintf(f, " get_success_objs=%"PRIu64"\n", sum.get_success_objs);
966 fprintf(f, " get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
967 fprintf(f, " get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
969 fprintf(f, " no statistics available\n");
972 rte_mempool_audit(mp);
975 /* dump the status of all mempools on the console */
977 rte_mempool_list_dump(FILE *f)
979 struct rte_mempool *mp = NULL;
980 struct rte_tailq_entry *te;
981 struct rte_mempool_list *mempool_list;
983 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
985 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
987 TAILQ_FOREACH(te, mempool_list, next) {
988 mp = (struct rte_mempool *) te->data;
989 rte_mempool_dump(f, mp);
992 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
995 /* search a mempool from its name */
997 rte_mempool_lookup(const char *name)
999 struct rte_mempool *mp = NULL;
1000 struct rte_tailq_entry *te;
1001 struct rte_mempool_list *mempool_list;
1003 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1005 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
1007 TAILQ_FOREACH(te, mempool_list, next) {
1008 mp = (struct rte_mempool *) te->data;
1009 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
1013 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
1023 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *),
1026 struct rte_tailq_entry *te = NULL;
1027 struct rte_mempool_list *mempool_list;
1029 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1031 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
1033 TAILQ_FOREACH(te, mempool_list, next) {
1034 (*func)((struct rte_mempool *) te->data, arg);
1037 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);