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>
45 #include <rte_common.h>
47 #include <rte_debug.h>
48 #include <rte_memory.h>
49 #include <rte_memzone.h>
50 #include <rte_malloc.h>
51 #include <rte_atomic.h>
52 #include <rte_launch.h>
54 #include <rte_eal_memconfig.h>
55 #include <rte_per_lcore.h>
56 #include <rte_lcore.h>
57 #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, rte_iova_t iova)
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));
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_mempool_ops_enqueue_bulk(mp, &obj, 1);
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 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
202 sz->trailer_size = sizeof(struct rte_mempool_objtlr);
204 sz->trailer_size = 0;
207 /* element size is 8 bytes-aligned at least */
208 sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
210 /* expand trailer to next cache line */
211 if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
212 sz->total_size = sz->header_size + sz->elt_size +
214 sz->trailer_size += ((RTE_MEMPOOL_ALIGN -
215 (sz->total_size & RTE_MEMPOOL_ALIGN_MASK)) &
216 RTE_MEMPOOL_ALIGN_MASK);
220 * increase trailer to add padding between objects in order to
221 * spread them across memory channels/ranks
223 if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
225 new_size = optimize_object_size(sz->header_size + sz->elt_size +
227 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
230 /* this is the size of an object, including header and trailer */
231 sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
233 return sz->total_size;
238 * Calculate maximum amount of memory required to store given number of objects.
241 rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift,
244 size_t obj_per_page, pg_num, pg_sz;
247 mask = MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS | MEMPOOL_F_CAPA_PHYS_CONTIG;
248 if ((flags & mask) == mask)
249 /* alignment need one additional object */
252 if (total_elt_sz == 0)
256 return total_elt_sz * elt_num;
258 pg_sz = (size_t)1 << pg_shift;
259 obj_per_page = pg_sz / total_elt_sz;
260 if (obj_per_page == 0)
261 return RTE_ALIGN_CEIL(total_elt_sz, pg_sz) * elt_num;
263 pg_num = (elt_num + obj_per_page - 1) / obj_per_page;
264 return pg_num << pg_shift;
268 * Calculate how much memory would be actually required with the
269 * given memory footprint to store required number of elements.
272 rte_mempool_xmem_usage(__rte_unused void *vaddr, uint32_t elt_num,
273 size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
274 uint32_t pg_shift, unsigned int flags)
276 uint32_t elt_cnt = 0;
277 rte_iova_t start, end;
279 size_t pg_sz = (size_t)1 << pg_shift;
282 mask = MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS | MEMPOOL_F_CAPA_PHYS_CONTIG;
283 if ((flags & mask) == mask)
284 /* alignment need one additional object */
287 /* if iova is NULL, assume contiguous memory */
290 end = pg_sz * pg_num;
294 end = iova[0] + pg_sz;
297 while (elt_cnt < elt_num) {
299 if (end - start >= total_elt_sz) {
300 /* enough contiguous memory, add an object */
301 start += total_elt_sz;
303 } else if (iova_idx < pg_num) {
304 /* no room to store one obj, add a page */
305 if (end == iova[iova_idx]) {
308 start = iova[iova_idx];
309 end = iova[iova_idx] + pg_sz;
314 /* no more page, return how many elements fit */
315 return -(size_t)elt_cnt;
319 return (size_t)iova_idx << pg_shift;
322 /* free a memchunk allocated with rte_memzone_reserve() */
324 rte_mempool_memchunk_mz_free(__rte_unused struct rte_mempool_memhdr *memhdr,
327 const struct rte_memzone *mz = opaque;
328 rte_memzone_free(mz);
331 /* Free memory chunks used by a mempool. Objects must be in pool */
333 rte_mempool_free_memchunks(struct rte_mempool *mp)
335 struct rte_mempool_memhdr *memhdr;
338 while (!STAILQ_EMPTY(&mp->elt_list)) {
339 rte_mempool_ops_dequeue_bulk(mp, &elt, 1);
341 STAILQ_REMOVE_HEAD(&mp->elt_list, next);
342 mp->populated_size--;
345 while (!STAILQ_EMPTY(&mp->mem_list)) {
346 memhdr = STAILQ_FIRST(&mp->mem_list);
347 STAILQ_REMOVE_HEAD(&mp->mem_list, next);
348 if (memhdr->free_cb != NULL)
349 memhdr->free_cb(memhdr, memhdr->opaque);
355 /* Add objects in the pool, using a physically contiguous memory
356 * zone. Return the number of objects added, or a negative value
360 rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
361 rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
364 unsigned total_elt_sz;
365 unsigned int mp_capa_flags;
368 struct rte_mempool_memhdr *memhdr;
371 /* create the internal ring if not already done */
372 if ((mp->flags & MEMPOOL_F_POOL_CREATED) == 0) {
373 ret = rte_mempool_ops_alloc(mp);
376 mp->flags |= MEMPOOL_F_POOL_CREATED;
379 /* Notify memory area to mempool */
380 ret = rte_mempool_ops_register_memory_area(mp, vaddr, iova, len);
381 if (ret != -ENOTSUP && ret < 0)
384 /* mempool is already populated */
385 if (mp->populated_size >= mp->size)
388 total_elt_sz = mp->header_size + mp->elt_size + mp->trailer_size;
390 /* Get mempool capabilities */
392 ret = rte_mempool_ops_get_capabilities(mp, &mp_capa_flags);
393 if ((ret < 0) && (ret != -ENOTSUP))
396 /* update mempool capabilities */
397 mp->flags |= mp_capa_flags;
399 /* Detect pool area has sufficient space for elements */
400 if (mp_capa_flags & MEMPOOL_F_CAPA_PHYS_CONTIG) {
401 if (len < total_elt_sz * mp->size) {
402 RTE_LOG(ERR, MEMPOOL,
403 "pool area %" PRIx64 " not enough\n",
409 memhdr = rte_zmalloc("MEMPOOL_MEMHDR", sizeof(*memhdr), 0);
414 memhdr->addr = vaddr;
417 memhdr->free_cb = free_cb;
418 memhdr->opaque = opaque;
420 if (mp_capa_flags & MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS)
421 /* align object start address to a multiple of total_elt_sz */
422 off = total_elt_sz - ((uintptr_t)vaddr % total_elt_sz);
423 else if (mp->flags & MEMPOOL_F_NO_CACHE_ALIGN)
424 off = RTE_PTR_ALIGN_CEIL(vaddr, 8) - vaddr;
426 off = RTE_PTR_ALIGN_CEIL(vaddr, RTE_CACHE_LINE_SIZE) - vaddr;
428 while (off + total_elt_sz <= len && mp->populated_size < mp->size) {
429 off += mp->header_size;
430 if (iova == RTE_BAD_IOVA)
431 mempool_add_elem(mp, (char *)vaddr + off,
434 mempool_add_elem(mp, (char *)vaddr + off, iova + off);
435 off += mp->elt_size + mp->trailer_size;
439 /* not enough room to store one object */
445 STAILQ_INSERT_TAIL(&mp->mem_list, memhdr, next);
455 rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
456 phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
459 return rte_mempool_populate_iova(mp, vaddr, paddr, len, free_cb, opaque);
462 /* Add objects in the pool, using a table of physical pages. Return the
463 * number of objects added, or a negative value on error.
466 rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
467 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
468 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque)
472 size_t pg_sz = (size_t)1 << pg_shift;
474 /* mempool must not be populated */
475 if (mp->nb_mem_chunks != 0)
478 if (mp->flags & MEMPOOL_F_NO_PHYS_CONTIG)
479 return rte_mempool_populate_iova(mp, vaddr, RTE_BAD_IOVA,
480 pg_num * pg_sz, free_cb, opaque);
482 for (i = 0; i < pg_num && mp->populated_size < mp->size; i += n) {
484 /* populate with the largest group of contiguous pages */
485 for (n = 1; (i + n) < pg_num &&
486 iova[i + n - 1] + pg_sz == iova[i + n]; n++)
489 ret = rte_mempool_populate_iova(mp, vaddr + i * pg_sz,
490 iova[i], n * pg_sz, free_cb, opaque);
492 rte_mempool_free_memchunks(mp);
495 /* no need to call the free callback for next chunks */
503 rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
504 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
505 rte_mempool_memchunk_free_cb_t *free_cb, void *opaque)
507 return rte_mempool_populate_iova_tab(mp, vaddr, paddr, pg_num, pg_shift,
511 /* Populate the mempool with a virtual area. Return the number of
512 * objects added, or a negative value on error.
515 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
516 size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
520 size_t off, phys_len;
523 /* address and len must be page-aligned */
524 if (RTE_PTR_ALIGN_CEIL(addr, pg_sz) != addr)
526 if (RTE_ALIGN_CEIL(len, pg_sz) != len)
529 if (mp->flags & MEMPOOL_F_NO_PHYS_CONTIG)
530 return rte_mempool_populate_iova(mp, addr, RTE_BAD_IOVA,
531 len, free_cb, opaque);
533 for (off = 0; off + pg_sz <= len &&
534 mp->populated_size < mp->size; off += phys_len) {
536 iova = rte_mem_virt2iova(addr + off);
538 if (iova == RTE_BAD_IOVA && rte_eal_has_hugepages()) {
543 /* populate with the largest group of contiguous pages */
544 for (phys_len = pg_sz; off + phys_len < len; phys_len += pg_sz) {
547 iova_tmp = rte_mem_virt2iova(addr + off + phys_len);
549 if (iova_tmp != iova + phys_len)
553 ret = rte_mempool_populate_iova(mp, addr + off, iova,
554 phys_len, free_cb, opaque);
557 /* no need to call the free callback for next chunks */
565 rte_mempool_free_memchunks(mp);
569 /* Default function to populate the mempool: allocate memory in memzones,
570 * and populate them. Return the number of objects added, or a negative
574 rte_mempool_populate_default(struct rte_mempool *mp)
576 unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
577 char mz_name[RTE_MEMZONE_NAMESIZE];
578 const struct rte_memzone *mz;
579 size_t size, total_elt_sz, align, pg_sz, pg_shift;
582 unsigned int mp_flags;
585 /* mempool must not be populated */
586 if (mp->nb_mem_chunks != 0)
589 /* Get mempool capabilities */
591 ret = rte_mempool_ops_get_capabilities(mp, &mp_flags);
592 if ((ret < 0) && (ret != -ENOTSUP))
595 /* update mempool capabilities */
596 mp->flags |= mp_flags;
598 if (rte_eal_has_hugepages()) {
599 pg_shift = 0; /* not needed, zone is physically contiguous */
601 align = RTE_CACHE_LINE_SIZE;
603 pg_sz = getpagesize();
604 pg_shift = rte_bsf32(pg_sz);
608 total_elt_sz = mp->header_size + mp->elt_size + mp->trailer_size;
609 for (mz_id = 0, n = mp->size; n > 0; mz_id++, n -= ret) {
610 size = rte_mempool_xmem_size(n, total_elt_sz, pg_shift,
613 ret = snprintf(mz_name, sizeof(mz_name),
614 RTE_MEMPOOL_MZ_FORMAT "_%d", mp->name, mz_id);
615 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
620 mz = rte_memzone_reserve_aligned(mz_name, size,
621 mp->socket_id, mz_flags, align);
622 /* not enough memory, retry with the biggest zone we have */
624 mz = rte_memzone_reserve_aligned(mz_name, 0,
625 mp->socket_id, mz_flags, align);
631 if (mp->flags & MEMPOOL_F_NO_PHYS_CONTIG)
636 if (rte_eal_has_hugepages())
637 ret = rte_mempool_populate_iova(mp, mz->addr,
639 rte_mempool_memchunk_mz_free,
640 (void *)(uintptr_t)mz);
642 ret = rte_mempool_populate_virt(mp, mz->addr,
644 rte_mempool_memchunk_mz_free,
645 (void *)(uintptr_t)mz);
647 rte_memzone_free(mz);
655 rte_mempool_free_memchunks(mp);
659 /* return the memory size required for mempool objects in anonymous mem */
661 get_anon_size(const struct rte_mempool *mp)
663 size_t size, total_elt_sz, pg_sz, pg_shift;
665 pg_sz = getpagesize();
666 pg_shift = rte_bsf32(pg_sz);
667 total_elt_sz = mp->header_size + mp->elt_size + mp->trailer_size;
668 size = rte_mempool_xmem_size(mp->size, total_elt_sz, pg_shift,
674 /* unmap a memory zone mapped by rte_mempool_populate_anon() */
676 rte_mempool_memchunk_anon_free(struct rte_mempool_memhdr *memhdr,
679 munmap(opaque, get_anon_size(memhdr->mp));
682 /* populate the mempool with an anonymous mapping */
684 rte_mempool_populate_anon(struct rte_mempool *mp)
690 /* mempool is already populated, error */
691 if ((!STAILQ_EMPTY(&mp->mem_list)) || mp->nb_mem_chunks != 0) {
696 /* get chunk of virtually continuous memory */
697 size = get_anon_size(mp);
698 addr = mmap(NULL, size, PROT_READ | PROT_WRITE,
699 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
700 if (addr == MAP_FAILED) {
704 /* can't use MMAP_LOCKED, it does not exist on BSD */
705 if (mlock(addr, size) < 0) {
711 ret = rte_mempool_populate_virt(mp, addr, size, getpagesize(),
712 rte_mempool_memchunk_anon_free, addr);
716 return mp->populated_size;
719 rte_mempool_free_memchunks(mp);
725 rte_mempool_free(struct rte_mempool *mp)
727 struct rte_mempool_list *mempool_list = NULL;
728 struct rte_tailq_entry *te;
733 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
734 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
735 /* find out tailq entry */
736 TAILQ_FOREACH(te, mempool_list, next) {
737 if (te->data == (void *)mp)
742 TAILQ_REMOVE(mempool_list, te, next);
745 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
747 rte_mempool_free_memchunks(mp);
748 rte_mempool_ops_free(mp);
749 rte_memzone_free(mp->mz);
753 mempool_cache_init(struct rte_mempool_cache *cache, uint32_t size)
756 cache->flushthresh = CALC_CACHE_FLUSHTHRESH(size);
761 * Create and initialize a cache for objects that are retrieved from and
762 * returned to an underlying mempool. This structure is identical to the
763 * local_cache[lcore_id] pointed to by the mempool structure.
765 struct rte_mempool_cache *
766 rte_mempool_cache_create(uint32_t size, int socket_id)
768 struct rte_mempool_cache *cache;
770 if (size == 0 || size > RTE_MEMPOOL_CACHE_MAX_SIZE) {
775 cache = rte_zmalloc_socket("MEMPOOL_CACHE", sizeof(*cache),
776 RTE_CACHE_LINE_SIZE, socket_id);
778 RTE_LOG(ERR, MEMPOOL, "Cannot allocate mempool cache.\n");
783 mempool_cache_init(cache, size);
789 * Free a cache. It's the responsibility of the user to make sure that any
790 * remaining objects in the cache are flushed to the corresponding
794 rte_mempool_cache_free(struct rte_mempool_cache *cache)
799 /* create an empty mempool */
801 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
802 unsigned cache_size, unsigned private_data_size,
803 int socket_id, unsigned flags)
805 char mz_name[RTE_MEMZONE_NAMESIZE];
806 struct rte_mempool_list *mempool_list;
807 struct rte_mempool *mp = NULL;
808 struct rte_tailq_entry *te = NULL;
809 const struct rte_memzone *mz = NULL;
811 unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
812 struct rte_mempool_objsz objsz;
816 /* compilation-time checks */
817 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
818 RTE_CACHE_LINE_MASK) != 0);
819 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
820 RTE_CACHE_LINE_MASK) != 0);
821 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
822 RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
823 RTE_CACHE_LINE_MASK) != 0);
824 RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
825 RTE_CACHE_LINE_MASK) != 0);
828 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
830 /* asked cache too big */
831 if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
832 CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
837 /* "no cache align" imply "no spread" */
838 if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
839 flags |= MEMPOOL_F_NO_SPREAD;
841 /* calculate mempool object sizes. */
842 if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
847 rte_rwlock_write_lock(RTE_EAL_MEMPOOL_RWLOCK);
850 * reserve a memory zone for this mempool: private data is
853 private_data_size = (private_data_size +
854 RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
857 /* try to allocate tailq entry */
858 te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
860 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
864 mempool_size = MEMPOOL_HEADER_SIZE(mp, cache_size);
865 mempool_size += private_data_size;
866 mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
868 ret = snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
869 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
870 rte_errno = ENAMETOOLONG;
874 mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
878 /* init the mempool structure */
880 memset(mp, 0, MEMPOOL_HEADER_SIZE(mp, cache_size));
881 ret = snprintf(mp->name, sizeof(mp->name), "%s", name);
882 if (ret < 0 || ret >= (int)sizeof(mp->name)) {
883 rte_errno = ENAMETOOLONG;
889 mp->socket_id = socket_id;
890 mp->elt_size = objsz.elt_size;
891 mp->header_size = objsz.header_size;
892 mp->trailer_size = objsz.trailer_size;
893 /* Size of default caches, zero means disabled. */
894 mp->cache_size = cache_size;
895 mp->private_data_size = private_data_size;
896 STAILQ_INIT(&mp->elt_list);
897 STAILQ_INIT(&mp->mem_list);
900 * local_cache pointer is set even if cache_size is zero.
901 * The local_cache points to just past the elt_pa[] array.
903 mp->local_cache = (struct rte_mempool_cache *)
904 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, 0));
906 /* Init all default caches. */
907 if (cache_size != 0) {
908 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
909 mempool_cache_init(&mp->local_cache[lcore_id],
915 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
916 TAILQ_INSERT_TAIL(mempool_list, te, next);
917 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
918 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
923 rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
925 rte_mempool_free(mp);
929 /* create the mempool */
931 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
932 unsigned cache_size, unsigned private_data_size,
933 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
934 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
935 int socket_id, unsigned flags)
938 struct rte_mempool *mp;
940 mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
941 private_data_size, socket_id, flags);
946 * Since we have 4 combinations of the SP/SC/MP/MC examine the flags to
947 * set the correct index into the table of ops structs.
949 if ((flags & MEMPOOL_F_SP_PUT) && (flags & MEMPOOL_F_SC_GET))
950 ret = rte_mempool_set_ops_byname(mp, "ring_sp_sc", NULL);
951 else if (flags & MEMPOOL_F_SP_PUT)
952 ret = rte_mempool_set_ops_byname(mp, "ring_sp_mc", NULL);
953 else if (flags & MEMPOOL_F_SC_GET)
954 ret = rte_mempool_set_ops_byname(mp, "ring_mp_sc", NULL);
956 ret = rte_mempool_set_ops_byname(mp, "ring_mp_mc", NULL);
961 /* call the mempool priv initializer */
963 mp_init(mp, mp_init_arg);
965 if (rte_mempool_populate_default(mp) < 0)
968 /* call the object initializers */
970 rte_mempool_obj_iter(mp, obj_init, obj_init_arg);
975 rte_mempool_free(mp);
980 * Create the mempool over already allocated chunk of memory.
981 * That external memory buffer can consists of physically disjoint pages.
982 * Setting vaddr to NULL, makes mempool to fallback to rte_mempool_create()
986 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
987 unsigned cache_size, unsigned private_data_size,
988 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
989 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
990 int socket_id, unsigned flags, void *vaddr,
991 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift)
993 struct rte_mempool *mp = NULL;
996 /* no virtual address supplied, use rte_mempool_create() */
998 return rte_mempool_create(name, n, elt_size, cache_size,
999 private_data_size, mp_init, mp_init_arg,
1000 obj_init, obj_init_arg, socket_id, flags);
1002 /* check that we have both VA and PA */
1008 /* Check that pg_shift parameter is valid. */
1009 if (pg_shift > MEMPOOL_PG_SHIFT_MAX) {
1014 mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
1015 private_data_size, socket_id, flags);
1019 /* call the mempool priv initializer */
1021 mp_init(mp, mp_init_arg);
1023 ret = rte_mempool_populate_iova_tab(mp, vaddr, iova, pg_num, pg_shift,
1025 if (ret < 0 || ret != (int)mp->size)
1028 /* call the object initializers */
1030 rte_mempool_obj_iter(mp, obj_init, obj_init_arg);
1035 rte_mempool_free(mp);
1039 /* Return the number of entries in the mempool */
1041 rte_mempool_avail_count(const struct rte_mempool *mp)
1046 count = rte_mempool_ops_get_count(mp);
1048 if (mp->cache_size == 0)
1051 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
1052 count += mp->local_cache[lcore_id].len;
1055 * due to race condition (access to len is not locked), the
1056 * total can be greater than size... so fix the result
1058 if (count > mp->size)
1063 /* return the number of entries allocated from the mempool */
1065 rte_mempool_in_use_count(const struct rte_mempool *mp)
1067 return mp->size - rte_mempool_avail_count(mp);
1070 /* dump the cache status */
1072 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
1076 unsigned cache_count;
1078 fprintf(f, " internal cache infos:\n");
1079 fprintf(f, " cache_size=%"PRIu32"\n", mp->cache_size);
1081 if (mp->cache_size == 0)
1084 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1085 cache_count = mp->local_cache[lcore_id].len;
1086 fprintf(f, " cache_count[%u]=%"PRIu32"\n",
1087 lcore_id, cache_count);
1088 count += cache_count;
1090 fprintf(f, " total_cache_count=%u\n", count);
1094 #ifndef __INTEL_COMPILER
1095 #pragma GCC diagnostic ignored "-Wcast-qual"
1098 /* check and update cookies or panic (internal) */
1099 void rte_mempool_check_cookies(const struct rte_mempool *mp,
1100 void * const *obj_table_const, unsigned n, int free)
1102 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1103 struct rte_mempool_objhdr *hdr;
1104 struct rte_mempool_objtlr *tlr;
1110 /* Force to drop the "const" attribute. This is done only when
1111 * DEBUG is enabled */
1112 tmp = (void *) obj_table_const;
1118 if (rte_mempool_from_obj(obj) != mp)
1119 rte_panic("MEMPOOL: object is owned by another "
1122 hdr = __mempool_get_header(obj);
1123 cookie = hdr->cookie;
1126 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
1127 RTE_LOG(CRIT, MEMPOOL,
1128 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1129 obj, (const void *) mp, cookie);
1130 rte_panic("MEMPOOL: bad header cookie (put)\n");
1132 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
1133 } else if (free == 1) {
1134 if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1135 RTE_LOG(CRIT, MEMPOOL,
1136 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1137 obj, (const void *) mp, cookie);
1138 rte_panic("MEMPOOL: bad header cookie (get)\n");
1140 hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
1141 } else if (free == 2) {
1142 if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
1143 cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1144 RTE_LOG(CRIT, MEMPOOL,
1145 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1146 obj, (const void *) mp, cookie);
1147 rte_panic("MEMPOOL: bad header cookie (audit)\n");
1150 tlr = __mempool_get_trailer(obj);
1151 cookie = tlr->cookie;
1152 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
1153 RTE_LOG(CRIT, MEMPOOL,
1154 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1155 obj, (const void *) mp, cookie);
1156 rte_panic("MEMPOOL: bad trailer cookie\n");
1161 RTE_SET_USED(obj_table_const);
1167 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1169 mempool_obj_audit(struct rte_mempool *mp, __rte_unused void *opaque,
1170 void *obj, __rte_unused unsigned idx)
1172 __mempool_check_cookies(mp, &obj, 1, 2);
1176 mempool_audit_cookies(struct rte_mempool *mp)
1180 num = rte_mempool_obj_iter(mp, mempool_obj_audit, NULL);
1181 if (num != mp->size) {
1182 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
1183 "iterated only over %u elements\n",
1188 #define mempool_audit_cookies(mp) do {} while(0)
1191 #ifndef __INTEL_COMPILER
1192 #pragma GCC diagnostic error "-Wcast-qual"
1195 /* check cookies before and after objects */
1197 mempool_audit_cache(const struct rte_mempool *mp)
1199 /* check cache size consistency */
1202 if (mp->cache_size == 0)
1205 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1206 const struct rte_mempool_cache *cache;
1207 cache = &mp->local_cache[lcore_id];
1208 if (cache->len > cache->flushthresh) {
1209 RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
1211 rte_panic("MEMPOOL: invalid cache len\n");
1216 /* check the consistency of mempool (size, cookies, ...) */
1218 rte_mempool_audit(struct rte_mempool *mp)
1220 mempool_audit_cache(mp);
1221 mempool_audit_cookies(mp);
1223 /* For case where mempool DEBUG is not set, and cache size is 0 */
1227 /* dump the status of the mempool on the console */
1229 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
1231 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1232 struct rte_mempool_debug_stats sum;
1235 struct rte_mempool_memhdr *memhdr;
1236 unsigned common_count;
1237 unsigned cache_count;
1240 RTE_ASSERT(f != NULL);
1241 RTE_ASSERT(mp != NULL);
1243 fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
1244 fprintf(f, " flags=%x\n", mp->flags);
1245 fprintf(f, " pool=%p\n", mp->pool_data);
1246 fprintf(f, " iova=0x%" PRIx64 "\n", mp->mz->iova);
1247 fprintf(f, " nb_mem_chunks=%u\n", mp->nb_mem_chunks);
1248 fprintf(f, " size=%"PRIu32"\n", mp->size);
1249 fprintf(f, " populated_size=%"PRIu32"\n", mp->populated_size);
1250 fprintf(f, " header_size=%"PRIu32"\n", mp->header_size);
1251 fprintf(f, " elt_size=%"PRIu32"\n", mp->elt_size);
1252 fprintf(f, " trailer_size=%"PRIu32"\n", mp->trailer_size);
1253 fprintf(f, " total_obj_size=%"PRIu32"\n",
1254 mp->header_size + mp->elt_size + mp->trailer_size);
1256 fprintf(f, " private_data_size=%"PRIu32"\n", mp->private_data_size);
1258 STAILQ_FOREACH(memhdr, &mp->mem_list, next)
1259 mem_len += memhdr->len;
1261 fprintf(f, " avg bytes/object=%#Lf\n",
1262 (long double)mem_len / mp->size);
1265 cache_count = rte_mempool_dump_cache(f, mp);
1266 common_count = rte_mempool_ops_get_count(mp);
1267 if ((cache_count + common_count) > mp->size)
1268 common_count = mp->size - cache_count;
1269 fprintf(f, " common_pool_count=%u\n", common_count);
1271 /* sum and dump statistics */
1272 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1273 memset(&sum, 0, sizeof(sum));
1274 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1275 sum.put_bulk += mp->stats[lcore_id].put_bulk;
1276 sum.put_objs += mp->stats[lcore_id].put_objs;
1277 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
1278 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
1279 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
1280 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
1282 fprintf(f, " stats:\n");
1283 fprintf(f, " put_bulk=%"PRIu64"\n", sum.put_bulk);
1284 fprintf(f, " put_objs=%"PRIu64"\n", sum.put_objs);
1285 fprintf(f, " get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
1286 fprintf(f, " get_success_objs=%"PRIu64"\n", sum.get_success_objs);
1287 fprintf(f, " get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
1288 fprintf(f, " get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
1290 fprintf(f, " no statistics available\n");
1293 rte_mempool_audit(mp);
1296 /* dump the status of all mempools on the console */
1298 rte_mempool_list_dump(FILE *f)
1300 struct rte_mempool *mp = NULL;
1301 struct rte_tailq_entry *te;
1302 struct rte_mempool_list *mempool_list;
1304 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1306 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
1308 TAILQ_FOREACH(te, mempool_list, next) {
1309 mp = (struct rte_mempool *) te->data;
1310 rte_mempool_dump(f, mp);
1313 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
1316 /* search a mempool from its name */
1317 struct rte_mempool *
1318 rte_mempool_lookup(const char *name)
1320 struct rte_mempool *mp = NULL;
1321 struct rte_tailq_entry *te;
1322 struct rte_mempool_list *mempool_list;
1324 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1326 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
1328 TAILQ_FOREACH(te, mempool_list, next) {
1329 mp = (struct rte_mempool *) te->data;
1330 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
1334 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
1344 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *),
1347 struct rte_tailq_entry *te = NULL;
1348 struct rte_mempool_list *mempool_list;
1351 mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1353 rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
1355 TAILQ_FOREACH_SAFE(te, mempool_list, next, tmp_te) {
1356 (*func)((struct rte_mempool *) te->data, arg);
1359 rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);