0be8f9f59d099629acbac3853b54b51dfdd7f6cd
[dpdk.git] / lib / librte_mempool / rte_mempool.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation.
3  * Copyright(c) 2016 6WIND S.A.
4  */
5
6 #include <stdbool.h>
7 #include <stdio.h>
8 #include <string.h>
9 #include <stdint.h>
10 #include <stdarg.h>
11 #include <unistd.h>
12 #include <inttypes.h>
13 #include <errno.h>
14 #include <sys/queue.h>
15 #include <sys/mman.h>
16
17 #include <rte_common.h>
18 #include <rte_log.h>
19 #include <rte_debug.h>
20 #include <rte_memory.h>
21 #include <rte_memzone.h>
22 #include <rte_malloc.h>
23 #include <rte_atomic.h>
24 #include <rte_launch.h>
25 #include <rte_eal.h>
26 #include <rte_eal_memconfig.h>
27 #include <rte_per_lcore.h>
28 #include <rte_lcore.h>
29 #include <rte_branch_prediction.h>
30 #include <rte_errno.h>
31 #include <rte_string_fns.h>
32 #include <rte_spinlock.h>
33 #include <rte_tailq.h>
34
35 #include "rte_mempool.h"
36 #include "rte_mempool_trace.h"
37
38 TAILQ_HEAD(rte_mempool_list, rte_tailq_entry);
39
40 static struct rte_tailq_elem rte_mempool_tailq = {
41         .name = "RTE_MEMPOOL",
42 };
43 EAL_REGISTER_TAILQ(rte_mempool_tailq)
44
45 #define CACHE_FLUSHTHRESH_MULTIPLIER 1.5
46 #define CALC_CACHE_FLUSHTHRESH(c)       \
47         ((typeof(c))((c) * CACHE_FLUSHTHRESH_MULTIPLIER))
48
49 #if defined(RTE_ARCH_X86)
50 /*
51  * return the greatest common divisor between a and b (fast algorithm)
52  *
53  */
54 static unsigned get_gcd(unsigned a, unsigned b)
55 {
56         unsigned c;
57
58         if (0 == a)
59                 return b;
60         if (0 == b)
61                 return a;
62
63         if (a < b) {
64                 c = a;
65                 a = b;
66                 b = c;
67         }
68
69         while (b != 0) {
70                 c = a % b;
71                 a = b;
72                 b = c;
73         }
74
75         return a;
76 }
77
78 /*
79  * Depending on memory configuration on x86 arch, objects addresses are spread
80  * between channels and ranks in RAM: the pool allocator will add
81  * padding between objects. This function return the new size of the
82  * object.
83  */
84 static unsigned int
85 arch_mem_object_align(unsigned int obj_size)
86 {
87         unsigned nrank, nchan;
88         unsigned new_obj_size;
89
90         /* get number of channels */
91         nchan = rte_memory_get_nchannel();
92         if (nchan == 0)
93                 nchan = 4;
94
95         nrank = rte_memory_get_nrank();
96         if (nrank == 0)
97                 nrank = 1;
98
99         /* process new object size */
100         new_obj_size = (obj_size + RTE_MEMPOOL_ALIGN_MASK) / RTE_MEMPOOL_ALIGN;
101         while (get_gcd(new_obj_size, nrank * nchan) != 1)
102                 new_obj_size++;
103         return new_obj_size * RTE_MEMPOOL_ALIGN;
104 }
105 #else
106 static unsigned int
107 arch_mem_object_align(unsigned int obj_size)
108 {
109         return obj_size;
110 }
111 #endif
112
113 struct pagesz_walk_arg {
114         int socket_id;
115         size_t min;
116 };
117
118 static int
119 find_min_pagesz(const struct rte_memseg_list *msl, void *arg)
120 {
121         struct pagesz_walk_arg *wa = arg;
122         bool valid;
123
124         /*
125          * we need to only look at page sizes available for a particular socket
126          * ID.  so, we either need an exact match on socket ID (can match both
127          * native and external memory), or, if SOCKET_ID_ANY was specified as a
128          * socket ID argument, we must only look at native memory and ignore any
129          * page sizes associated with external memory.
130          */
131         valid = msl->socket_id == wa->socket_id;
132         valid |= wa->socket_id == SOCKET_ID_ANY && msl->external == 0;
133
134         if (valid && msl->page_sz < wa->min)
135                 wa->min = msl->page_sz;
136
137         return 0;
138 }
139
140 static size_t
141 get_min_page_size(int socket_id)
142 {
143         struct pagesz_walk_arg wa;
144
145         wa.min = SIZE_MAX;
146         wa.socket_id = socket_id;
147
148         rte_memseg_list_walk(find_min_pagesz, &wa);
149
150         return wa.min == SIZE_MAX ? (size_t) getpagesize() : wa.min;
151 }
152
153
154 static void
155 mempool_add_elem(struct rte_mempool *mp, __rte_unused void *opaque,
156                  void *obj, rte_iova_t iova)
157 {
158         struct rte_mempool_objhdr *hdr;
159         struct rte_mempool_objtlr *tlr __rte_unused;
160
161         /* set mempool ptr in header */
162         hdr = RTE_PTR_SUB(obj, sizeof(*hdr));
163         hdr->mp = mp;
164         hdr->iova = iova;
165         STAILQ_INSERT_TAIL(&mp->elt_list, hdr, next);
166         mp->populated_size++;
167
168 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
169         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
170         tlr = __mempool_get_trailer(obj);
171         tlr->cookie = RTE_MEMPOOL_TRAILER_COOKIE;
172 #endif
173 }
174
175 /* call obj_cb() for each mempool element */
176 uint32_t
177 rte_mempool_obj_iter(struct rte_mempool *mp,
178         rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg)
179 {
180         struct rte_mempool_objhdr *hdr;
181         void *obj;
182         unsigned n = 0;
183
184         STAILQ_FOREACH(hdr, &mp->elt_list, next) {
185                 obj = (char *)hdr + sizeof(*hdr);
186                 obj_cb(mp, obj_cb_arg, obj, n);
187                 n++;
188         }
189
190         return n;
191 }
192
193 /* call mem_cb() for each mempool memory chunk */
194 uint32_t
195 rte_mempool_mem_iter(struct rte_mempool *mp,
196         rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg)
197 {
198         struct rte_mempool_memhdr *hdr;
199         unsigned n = 0;
200
201         STAILQ_FOREACH(hdr, &mp->mem_list, next) {
202                 mem_cb(mp, mem_cb_arg, hdr, n);
203                 n++;
204         }
205
206         return n;
207 }
208
209 /* get the header, trailer and total size of a mempool element. */
210 uint32_t
211 rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
212         struct rte_mempool_objsz *sz)
213 {
214         struct rte_mempool_objsz lsz;
215
216         sz = (sz != NULL) ? sz : &lsz;
217
218         sz->header_size = sizeof(struct rte_mempool_objhdr);
219         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
220                 sz->header_size = RTE_ALIGN_CEIL(sz->header_size,
221                         RTE_MEMPOOL_ALIGN);
222
223 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
224         sz->trailer_size = sizeof(struct rte_mempool_objtlr);
225 #else
226         sz->trailer_size = 0;
227 #endif
228
229         /* element size is 8 bytes-aligned at least */
230         sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
231
232         /* expand trailer to next cache line */
233         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
234                 sz->total_size = sz->header_size + sz->elt_size +
235                         sz->trailer_size;
236                 sz->trailer_size += ((RTE_MEMPOOL_ALIGN -
237                                   (sz->total_size & RTE_MEMPOOL_ALIGN_MASK)) &
238                                  RTE_MEMPOOL_ALIGN_MASK);
239         }
240
241         /*
242          * increase trailer to add padding between objects in order to
243          * spread them across memory channels/ranks
244          */
245         if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
246                 unsigned new_size;
247                 new_size = arch_mem_object_align
248                             (sz->header_size + sz->elt_size + sz->trailer_size);
249                 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
250         }
251
252         /* this is the size of an object, including header and trailer */
253         sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
254
255         return sz->total_size;
256 }
257
258 /* free a memchunk allocated with rte_memzone_reserve() */
259 static void
260 rte_mempool_memchunk_mz_free(__rte_unused struct rte_mempool_memhdr *memhdr,
261         void *opaque)
262 {
263         const struct rte_memzone *mz = opaque;
264         rte_memzone_free(mz);
265 }
266
267 /* Free memory chunks used by a mempool. Objects must be in pool */
268 static void
269 rte_mempool_free_memchunks(struct rte_mempool *mp)
270 {
271         struct rte_mempool_memhdr *memhdr;
272         void *elt;
273
274         while (!STAILQ_EMPTY(&mp->elt_list)) {
275                 rte_mempool_ops_dequeue_bulk(mp, &elt, 1);
276                 (void)elt;
277                 STAILQ_REMOVE_HEAD(&mp->elt_list, next);
278                 mp->populated_size--;
279         }
280
281         while (!STAILQ_EMPTY(&mp->mem_list)) {
282                 memhdr = STAILQ_FIRST(&mp->mem_list);
283                 STAILQ_REMOVE_HEAD(&mp->mem_list, next);
284                 if (memhdr->free_cb != NULL)
285                         memhdr->free_cb(memhdr, memhdr->opaque);
286                 rte_free(memhdr);
287                 mp->nb_mem_chunks--;
288         }
289 }
290
291 static int
292 mempool_ops_alloc_once(struct rte_mempool *mp)
293 {
294         int ret;
295
296         /* create the internal ring if not already done */
297         if ((mp->flags & MEMPOOL_F_POOL_CREATED) == 0) {
298                 ret = rte_mempool_ops_alloc(mp);
299                 if (ret != 0)
300                         return ret;
301                 mp->flags |= MEMPOOL_F_POOL_CREATED;
302         }
303         return 0;
304 }
305
306 /* Add objects in the pool, using a physically contiguous memory
307  * zone. Return the number of objects added, or a negative value
308  * on error.
309  */
310 static int
311 __rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
312         rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
313         void *opaque)
314 {
315         unsigned i = 0;
316         size_t off;
317         struct rte_mempool_memhdr *memhdr;
318         int ret;
319
320         ret = mempool_ops_alloc_once(mp);
321         if (ret != 0)
322                 return ret;
323
324         /* mempool is already populated */
325         if (mp->populated_size >= mp->size)
326                 return -ENOSPC;
327
328         memhdr = rte_zmalloc("MEMPOOL_MEMHDR", sizeof(*memhdr), 0);
329         if (memhdr == NULL)
330                 return -ENOMEM;
331
332         memhdr->mp = mp;
333         memhdr->addr = vaddr;
334         memhdr->iova = iova;
335         memhdr->len = len;
336         memhdr->free_cb = free_cb;
337         memhdr->opaque = opaque;
338
339         if (mp->flags & MEMPOOL_F_NO_CACHE_ALIGN)
340                 off = RTE_PTR_ALIGN_CEIL(vaddr, 8) - vaddr;
341         else
342                 off = RTE_PTR_ALIGN_CEIL(vaddr, RTE_MEMPOOL_ALIGN) - vaddr;
343
344         if (off > len) {
345                 ret = 0;
346                 goto fail;
347         }
348
349         i = rte_mempool_ops_populate(mp, mp->size - mp->populated_size,
350                 (char *)vaddr + off,
351                 (iova == RTE_BAD_IOVA) ? RTE_BAD_IOVA : (iova + off),
352                 len - off, mempool_add_elem, NULL);
353
354         /* not enough room to store one object */
355         if (i == 0) {
356                 ret = 0;
357                 goto fail;
358         }
359
360         STAILQ_INSERT_TAIL(&mp->mem_list, memhdr, next);
361         mp->nb_mem_chunks++;
362         return i;
363
364 fail:
365         rte_free(memhdr);
366         return ret;
367 }
368
369 int
370 rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
371         rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
372         void *opaque)
373 {
374         int ret;
375
376         ret = __rte_mempool_populate_iova(mp, vaddr, iova, len, free_cb,
377                                         opaque);
378         if (ret == 0)
379                 ret = -EINVAL;
380
381         rte_mempool_trace_populate_iova(mp, vaddr, iova, len, free_cb, opaque);
382         return ret;
383 }
384
385 static rte_iova_t
386 get_iova(void *addr)
387 {
388         struct rte_memseg *ms;
389
390         /* try registered memory first */
391         ms = rte_mem_virt2memseg(addr, NULL);
392         if (ms == NULL || ms->iova == RTE_BAD_IOVA)
393                 /* fall back to actual physical address */
394                 return rte_mem_virt2iova(addr);
395         return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
396 }
397
398 /* Populate the mempool with a virtual area. Return the number of
399  * objects added, or a negative value on error.
400  */
401 int
402 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
403         size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
404         void *opaque)
405 {
406         rte_iova_t iova;
407         size_t off, phys_len;
408         int ret, cnt = 0;
409
410         if (mp->flags & MEMPOOL_F_NO_IOVA_CONTIG)
411                 return rte_mempool_populate_iova(mp, addr, RTE_BAD_IOVA,
412                         len, free_cb, opaque);
413
414         for (off = 0; off < len &&
415                      mp->populated_size < mp->size; off += phys_len) {
416
417                 iova = get_iova(addr + off);
418
419                 /* populate with the largest group of contiguous pages */
420                 for (phys_len = RTE_MIN(
421                         (size_t)(RTE_PTR_ALIGN_CEIL(addr + off + 1, pg_sz) -
422                                 (addr + off)),
423                         len - off);
424                      off + phys_len < len;
425                      phys_len = RTE_MIN(phys_len + pg_sz, len - off)) {
426                         rte_iova_t iova_tmp;
427
428                         iova_tmp = get_iova(addr + off + phys_len);
429
430                         if (iova_tmp == RTE_BAD_IOVA ||
431                                         iova_tmp != iova + phys_len)
432                                 break;
433                 }
434
435                 ret = __rte_mempool_populate_iova(mp, addr + off, iova,
436                         phys_len, free_cb, opaque);
437                 if (ret == 0)
438                         continue;
439                 if (ret < 0)
440                         goto fail;
441                 /* no need to call the free callback for next chunks */
442                 free_cb = NULL;
443                 cnt += ret;
444         }
445
446         if (cnt == 0)
447                 return -EINVAL;
448
449         rte_mempool_trace_populate_virt(mp, addr, len, pg_sz, free_cb, opaque);
450         return cnt;
451
452  fail:
453         rte_mempool_free_memchunks(mp);
454         return ret;
455 }
456
457 /* Get the minimal page size used in a mempool before populating it. */
458 int
459 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz)
460 {
461         bool need_iova_contig_obj;
462         bool alloc_in_ext_mem;
463         int ret;
464
465         /* check if we can retrieve a valid socket ID */
466         ret = rte_malloc_heap_socket_is_external(mp->socket_id);
467         if (ret < 0)
468                 return -EINVAL;
469         alloc_in_ext_mem = (ret == 1);
470         need_iova_contig_obj = !(mp->flags & MEMPOOL_F_NO_IOVA_CONTIG);
471
472         if (!need_iova_contig_obj)
473                 *pg_sz = 0;
474         else if (rte_eal_has_hugepages() || alloc_in_ext_mem)
475                 *pg_sz = get_min_page_size(mp->socket_id);
476         else
477                 *pg_sz = getpagesize();
478
479         rte_mempool_trace_get_page_size(mp, *pg_sz);
480         return 0;
481 }
482
483 /* Default function to populate the mempool: allocate memory in memzones,
484  * and populate them. Return the number of objects added, or a negative
485  * value on error.
486  */
487 int
488 rte_mempool_populate_default(struct rte_mempool *mp)
489 {
490         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
491         char mz_name[RTE_MEMZONE_NAMESIZE];
492         const struct rte_memzone *mz;
493         ssize_t mem_size;
494         size_t align, pg_sz, pg_shift = 0;
495         rte_iova_t iova;
496         unsigned mz_id, n;
497         int ret;
498         bool need_iova_contig_obj;
499         size_t max_alloc_size = SIZE_MAX;
500
501         ret = mempool_ops_alloc_once(mp);
502         if (ret != 0)
503                 return ret;
504
505         /* mempool must not be populated */
506         if (mp->nb_mem_chunks != 0)
507                 return -EEXIST;
508
509         /*
510          * the following section calculates page shift and page size values.
511          *
512          * these values impact the result of calc_mem_size operation, which
513          * returns the amount of memory that should be allocated to store the
514          * desired number of objects. when not zero, it allocates more memory
515          * for the padding between objects, to ensure that an object does not
516          * cross a page boundary. in other words, page size/shift are to be set
517          * to zero if mempool elements won't care about page boundaries.
518          * there are several considerations for page size and page shift here.
519          *
520          * if we don't need our mempools to have physically contiguous objects,
521          * then just set page shift and page size to 0, because the user has
522          * indicated that there's no need to care about anything.
523          *
524          * if we do need contiguous objects (if a mempool driver has its
525          * own calc_size() method returning min_chunk_size = mem_size),
526          * there is also an option to reserve the entire mempool memory
527          * as one contiguous block of memory.
528          *
529          * if we require contiguous objects, but not necessarily the entire
530          * mempool reserved space to be contiguous, pg_sz will be != 0,
531          * and the default ops->populate() will take care of not placing
532          * objects across pages.
533          *
534          * if our IO addresses are physical, we may get memory from bigger
535          * pages, or we might get memory from smaller pages, and how much of it
536          * we require depends on whether we want bigger or smaller pages.
537          * However, requesting each and every memory size is too much work, so
538          * what we'll do instead is walk through the page sizes available, pick
539          * the smallest one and set up page shift to match that one. We will be
540          * wasting some space this way, but it's much nicer than looping around
541          * trying to reserve each and every page size.
542          *
543          * If we fail to get enough contiguous memory, then we'll go and
544          * reserve space in smaller chunks.
545          */
546
547         need_iova_contig_obj = !(mp->flags & MEMPOOL_F_NO_IOVA_CONTIG);
548         ret = rte_mempool_get_page_size(mp, &pg_sz);
549         if (ret < 0)
550                 return ret;
551
552         if (pg_sz != 0)
553                 pg_shift = rte_bsf32(pg_sz);
554
555         for (mz_id = 0, n = mp->size; n > 0; mz_id++, n -= ret) {
556                 size_t min_chunk_size;
557
558                 mem_size = rte_mempool_ops_calc_mem_size(
559                         mp, n, pg_shift, &min_chunk_size, &align);
560
561                 if (mem_size < 0) {
562                         ret = mem_size;
563                         goto fail;
564                 }
565
566                 ret = snprintf(mz_name, sizeof(mz_name),
567                         RTE_MEMPOOL_MZ_FORMAT "_%d", mp->name, mz_id);
568                 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
569                         ret = -ENAMETOOLONG;
570                         goto fail;
571                 }
572
573                 /* if we're trying to reserve contiguous memory, add appropriate
574                  * memzone flag.
575                  */
576                 if (min_chunk_size == (size_t)mem_size)
577                         mz_flags |= RTE_MEMZONE_IOVA_CONTIG;
578
579                 /* Allocate a memzone, retrying with a smaller area on ENOMEM */
580                 do {
581                         mz = rte_memzone_reserve_aligned(mz_name,
582                                 RTE_MIN((size_t)mem_size, max_alloc_size),
583                                 mp->socket_id, mz_flags, align);
584
585                         if (mz == NULL && rte_errno != ENOMEM)
586                                 break;
587
588                         max_alloc_size = RTE_MIN(max_alloc_size,
589                                                 (size_t)mem_size) / 2;
590                 } while (mz == NULL && max_alloc_size >= min_chunk_size);
591
592                 if (mz == NULL) {
593                         ret = -rte_errno;
594                         goto fail;
595                 }
596
597                 if (need_iova_contig_obj)
598                         iova = mz->iova;
599                 else
600                         iova = RTE_BAD_IOVA;
601
602                 if (pg_sz == 0 || (mz_flags & RTE_MEMZONE_IOVA_CONTIG))
603                         ret = rte_mempool_populate_iova(mp, mz->addr,
604                                 iova, mz->len,
605                                 rte_mempool_memchunk_mz_free,
606                                 (void *)(uintptr_t)mz);
607                 else
608                         ret = rte_mempool_populate_virt(mp, mz->addr,
609                                 mz->len, pg_sz,
610                                 rte_mempool_memchunk_mz_free,
611                                 (void *)(uintptr_t)mz);
612                 if (ret < 0) {
613                         rte_memzone_free(mz);
614                         goto fail;
615                 }
616         }
617
618         rte_mempool_trace_populate_default(mp);
619         return mp->size;
620
621  fail:
622         rte_mempool_free_memchunks(mp);
623         return ret;
624 }
625
626 /* return the memory size required for mempool objects in anonymous mem */
627 static ssize_t
628 get_anon_size(const struct rte_mempool *mp)
629 {
630         ssize_t size;
631         size_t pg_sz, pg_shift;
632         size_t min_chunk_size;
633         size_t align;
634
635         pg_sz = getpagesize();
636         pg_shift = rte_bsf32(pg_sz);
637         size = rte_mempool_ops_calc_mem_size(mp, mp->size, pg_shift,
638                                              &min_chunk_size, &align);
639
640         return size;
641 }
642
643 /* unmap a memory zone mapped by rte_mempool_populate_anon() */
644 static void
645 rte_mempool_memchunk_anon_free(struct rte_mempool_memhdr *memhdr,
646         void *opaque)
647 {
648         ssize_t size;
649
650         /*
651          * Calculate size since memhdr->len has contiguous chunk length
652          * which may be smaller if anon map is split into many contiguous
653          * chunks. Result must be the same as we calculated on populate.
654          */
655         size = get_anon_size(memhdr->mp);
656         if (size < 0)
657                 return;
658
659         munmap(opaque, size);
660 }
661
662 /* populate the mempool with an anonymous mapping */
663 int
664 rte_mempool_populate_anon(struct rte_mempool *mp)
665 {
666         ssize_t size;
667         int ret;
668         char *addr;
669
670         /* mempool is already populated, error */
671         if ((!STAILQ_EMPTY(&mp->mem_list)) || mp->nb_mem_chunks != 0) {
672                 rte_errno = EINVAL;
673                 return 0;
674         }
675
676         ret = mempool_ops_alloc_once(mp);
677         if (ret < 0) {
678                 rte_errno = -ret;
679                 return 0;
680         }
681
682         size = get_anon_size(mp);
683         if (size < 0) {
684                 rte_errno = -size;
685                 return 0;
686         }
687
688         /* get chunk of virtually continuous memory */
689         addr = mmap(NULL, size, PROT_READ | PROT_WRITE,
690                 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
691         if (addr == MAP_FAILED) {
692                 rte_errno = errno;
693                 return 0;
694         }
695         /* can't use MMAP_LOCKED, it does not exist on BSD */
696         if (mlock(addr, size) < 0) {
697                 rte_errno = errno;
698                 munmap(addr, size);
699                 return 0;
700         }
701
702         ret = rte_mempool_populate_virt(mp, addr, size, getpagesize(),
703                 rte_mempool_memchunk_anon_free, addr);
704         if (ret < 0) {
705                 rte_errno = -ret;
706                 goto fail;
707         }
708
709         rte_mempool_trace_populate_anon(mp);
710         return mp->populated_size;
711
712  fail:
713         rte_mempool_free_memchunks(mp);
714         return 0;
715 }
716
717 /* free a mempool */
718 void
719 rte_mempool_free(struct rte_mempool *mp)
720 {
721         struct rte_mempool_list *mempool_list = NULL;
722         struct rte_tailq_entry *te;
723
724         if (mp == NULL)
725                 return;
726
727         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
728         rte_mcfg_tailq_write_lock();
729         /* find out tailq entry */
730         TAILQ_FOREACH(te, mempool_list, next) {
731                 if (te->data == (void *)mp)
732                         break;
733         }
734
735         if (te != NULL) {
736                 TAILQ_REMOVE(mempool_list, te, next);
737                 rte_free(te);
738         }
739         rte_mcfg_tailq_write_unlock();
740
741         rte_mempool_trace_free(mp);
742         rte_mempool_free_memchunks(mp);
743         rte_mempool_ops_free(mp);
744         rte_memzone_free(mp->mz);
745 }
746
747 static void
748 mempool_cache_init(struct rte_mempool_cache *cache, uint32_t size)
749 {
750         cache->size = size;
751         cache->flushthresh = CALC_CACHE_FLUSHTHRESH(size);
752         cache->len = 0;
753 }
754
755 /*
756  * Create and initialize a cache for objects that are retrieved from and
757  * returned to an underlying mempool. This structure is identical to the
758  * local_cache[lcore_id] pointed to by the mempool structure.
759  */
760 struct rte_mempool_cache *
761 rte_mempool_cache_create(uint32_t size, int socket_id)
762 {
763         struct rte_mempool_cache *cache;
764
765         if (size == 0 || size > RTE_MEMPOOL_CACHE_MAX_SIZE) {
766                 rte_errno = EINVAL;
767                 return NULL;
768         }
769
770         cache = rte_zmalloc_socket("MEMPOOL_CACHE", sizeof(*cache),
771                                   RTE_CACHE_LINE_SIZE, socket_id);
772         if (cache == NULL) {
773                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate mempool cache.\n");
774                 rte_errno = ENOMEM;
775                 return NULL;
776         }
777
778         mempool_cache_init(cache, size);
779
780         rte_mempool_trace_cache_create(size, socket_id, cache);
781         return cache;
782 }
783
784 /*
785  * Free a cache. It's the responsibility of the user to make sure that any
786  * remaining objects in the cache are flushed to the corresponding
787  * mempool.
788  */
789 void
790 rte_mempool_cache_free(struct rte_mempool_cache *cache)
791 {
792         rte_mempool_trace_cache_free(cache);
793         rte_free(cache);
794 }
795
796 /* create an empty mempool */
797 struct rte_mempool *
798 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
799         unsigned cache_size, unsigned private_data_size,
800         int socket_id, unsigned flags)
801 {
802         char mz_name[RTE_MEMZONE_NAMESIZE];
803         struct rte_mempool_list *mempool_list;
804         struct rte_mempool *mp = NULL;
805         struct rte_tailq_entry *te = NULL;
806         const struct rte_memzone *mz = NULL;
807         size_t mempool_size;
808         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
809         struct rte_mempool_objsz objsz;
810         unsigned lcore_id;
811         int ret;
812
813         /* compilation-time checks */
814         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
815                           RTE_CACHE_LINE_MASK) != 0);
816         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
817                           RTE_CACHE_LINE_MASK) != 0);
818 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
819         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
820                           RTE_CACHE_LINE_MASK) != 0);
821         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
822                           RTE_CACHE_LINE_MASK) != 0);
823 #endif
824
825         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
826
827         /* asked for zero items */
828         if (n == 0) {
829                 rte_errno = EINVAL;
830                 return NULL;
831         }
832
833         /* asked cache too big */
834         if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
835             CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
836                 rte_errno = EINVAL;
837                 return NULL;
838         }
839
840         /* "no cache align" imply "no spread" */
841         if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
842                 flags |= MEMPOOL_F_NO_SPREAD;
843
844         /* calculate mempool object sizes. */
845         if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
846                 rte_errno = EINVAL;
847                 return NULL;
848         }
849
850         rte_mcfg_mempool_write_lock();
851
852         /*
853          * reserve a memory zone for this mempool: private data is
854          * cache-aligned
855          */
856         private_data_size = (private_data_size +
857                              RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
858
859
860         /* try to allocate tailq entry */
861         te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
862         if (te == NULL) {
863                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
864                 goto exit_unlock;
865         }
866
867         mempool_size = MEMPOOL_HEADER_SIZE(mp, cache_size);
868         mempool_size += private_data_size;
869         mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
870
871         ret = snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
872         if (ret < 0 || ret >= (int)sizeof(mz_name)) {
873                 rte_errno = ENAMETOOLONG;
874                 goto exit_unlock;
875         }
876
877         mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
878         if (mz == NULL)
879                 goto exit_unlock;
880
881         /* init the mempool structure */
882         mp = mz->addr;
883         memset(mp, 0, MEMPOOL_HEADER_SIZE(mp, cache_size));
884         ret = strlcpy(mp->name, name, sizeof(mp->name));
885         if (ret < 0 || ret >= (int)sizeof(mp->name)) {
886                 rte_errno = ENAMETOOLONG;
887                 goto exit_unlock;
888         }
889         mp->mz = mz;
890         mp->size = n;
891         mp->flags = flags;
892         mp->socket_id = socket_id;
893         mp->elt_size = objsz.elt_size;
894         mp->header_size = objsz.header_size;
895         mp->trailer_size = objsz.trailer_size;
896         /* Size of default caches, zero means disabled. */
897         mp->cache_size = cache_size;
898         mp->private_data_size = private_data_size;
899         STAILQ_INIT(&mp->elt_list);
900         STAILQ_INIT(&mp->mem_list);
901
902         /*
903          * local_cache pointer is set even if cache_size is zero.
904          * The local_cache points to just past the elt_pa[] array.
905          */
906         mp->local_cache = (struct rte_mempool_cache *)
907                 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, 0));
908
909         /* Init all default caches. */
910         if (cache_size != 0) {
911                 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
912                         mempool_cache_init(&mp->local_cache[lcore_id],
913                                            cache_size);
914         }
915
916         te->data = mp;
917
918         rte_mcfg_tailq_write_lock();
919         TAILQ_INSERT_TAIL(mempool_list, te, next);
920         rte_mcfg_tailq_write_unlock();
921         rte_mcfg_mempool_write_unlock();
922
923         rte_mempool_trace_create_empty(name, n, elt_size, cache_size,
924                 private_data_size, flags, mp);
925         return mp;
926
927 exit_unlock:
928         rte_mcfg_mempool_write_unlock();
929         rte_free(te);
930         rte_mempool_free(mp);
931         return NULL;
932 }
933
934 /* create the mempool */
935 struct rte_mempool *
936 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
937         unsigned cache_size, unsigned private_data_size,
938         rte_mempool_ctor_t *mp_init, void *mp_init_arg,
939         rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
940         int socket_id, unsigned flags)
941 {
942         int ret;
943         struct rte_mempool *mp;
944
945         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
946                 private_data_size, socket_id, flags);
947         if (mp == NULL)
948                 return NULL;
949
950         /*
951          * Since we have 4 combinations of the SP/SC/MP/MC examine the flags to
952          * set the correct index into the table of ops structs.
953          */
954         if ((flags & MEMPOOL_F_SP_PUT) && (flags & MEMPOOL_F_SC_GET))
955                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_sc", NULL);
956         else if (flags & MEMPOOL_F_SP_PUT)
957                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_mc", NULL);
958         else if (flags & MEMPOOL_F_SC_GET)
959                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_sc", NULL);
960         else
961                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_mc", NULL);
962
963         if (ret)
964                 goto fail;
965
966         /* call the mempool priv initializer */
967         if (mp_init)
968                 mp_init(mp, mp_init_arg);
969
970         if (rte_mempool_populate_default(mp) < 0)
971                 goto fail;
972
973         /* call the object initializers */
974         if (obj_init)
975                 rte_mempool_obj_iter(mp, obj_init, obj_init_arg);
976
977         rte_mempool_trace_create(name, n, elt_size, cache_size,
978                 private_data_size, mp_init, mp_init_arg, obj_init,
979                 obj_init_arg, flags, mp);
980         return mp;
981
982  fail:
983         rte_mempool_free(mp);
984         return NULL;
985 }
986
987 /* Return the number of entries in the mempool */
988 unsigned int
989 rte_mempool_avail_count(const struct rte_mempool *mp)
990 {
991         unsigned count;
992         unsigned lcore_id;
993
994         count = rte_mempool_ops_get_count(mp);
995
996         if (mp->cache_size == 0)
997                 return count;
998
999         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
1000                 count += mp->local_cache[lcore_id].len;
1001
1002         /*
1003          * due to race condition (access to len is not locked), the
1004          * total can be greater than size... so fix the result
1005          */
1006         if (count > mp->size)
1007                 return mp->size;
1008         return count;
1009 }
1010
1011 /* return the number of entries allocated from the mempool */
1012 unsigned int
1013 rte_mempool_in_use_count(const struct rte_mempool *mp)
1014 {
1015         return mp->size - rte_mempool_avail_count(mp);
1016 }
1017
1018 /* dump the cache status */
1019 static unsigned
1020 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
1021 {
1022         unsigned lcore_id;
1023         unsigned count = 0;
1024         unsigned cache_count;
1025
1026         fprintf(f, "  internal cache infos:\n");
1027         fprintf(f, "    cache_size=%"PRIu32"\n", mp->cache_size);
1028
1029         if (mp->cache_size == 0)
1030                 return count;
1031
1032         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1033                 cache_count = mp->local_cache[lcore_id].len;
1034                 fprintf(f, "    cache_count[%u]=%"PRIu32"\n",
1035                         lcore_id, cache_count);
1036                 count += cache_count;
1037         }
1038         fprintf(f, "    total_cache_count=%u\n", count);
1039         return count;
1040 }
1041
1042 #ifndef __INTEL_COMPILER
1043 #pragma GCC diagnostic ignored "-Wcast-qual"
1044 #endif
1045
1046 /* check and update cookies or panic (internal) */
1047 void rte_mempool_check_cookies(const struct rte_mempool *mp,
1048         void * const *obj_table_const, unsigned n, int free)
1049 {
1050 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1051         struct rte_mempool_objhdr *hdr;
1052         struct rte_mempool_objtlr *tlr;
1053         uint64_t cookie;
1054         void *tmp;
1055         void *obj;
1056         void **obj_table;
1057
1058         /* Force to drop the "const" attribute. This is done only when
1059          * DEBUG is enabled */
1060         tmp = (void *) obj_table_const;
1061         obj_table = tmp;
1062
1063         while (n--) {
1064                 obj = obj_table[n];
1065
1066                 if (rte_mempool_from_obj(obj) != mp)
1067                         rte_panic("MEMPOOL: object is owned by another "
1068                                   "mempool\n");
1069
1070                 hdr = __mempool_get_header(obj);
1071                 cookie = hdr->cookie;
1072
1073                 if (free == 0) {
1074                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
1075                                 RTE_LOG(CRIT, MEMPOOL,
1076                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1077                                         obj, (const void *) mp, cookie);
1078                                 rte_panic("MEMPOOL: bad header cookie (put)\n");
1079                         }
1080                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
1081                 } else if (free == 1) {
1082                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1083                                 RTE_LOG(CRIT, MEMPOOL,
1084                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1085                                         obj, (const void *) mp, cookie);
1086                                 rte_panic("MEMPOOL: bad header cookie (get)\n");
1087                         }
1088                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
1089                 } else if (free == 2) {
1090                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
1091                             cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1092                                 RTE_LOG(CRIT, MEMPOOL,
1093                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1094                                         obj, (const void *) mp, cookie);
1095                                 rte_panic("MEMPOOL: bad header cookie (audit)\n");
1096                         }
1097                 }
1098                 tlr = __mempool_get_trailer(obj);
1099                 cookie = tlr->cookie;
1100                 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
1101                         RTE_LOG(CRIT, MEMPOOL,
1102                                 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1103                                 obj, (const void *) mp, cookie);
1104                         rte_panic("MEMPOOL: bad trailer cookie\n");
1105                 }
1106         }
1107 #else
1108         RTE_SET_USED(mp);
1109         RTE_SET_USED(obj_table_const);
1110         RTE_SET_USED(n);
1111         RTE_SET_USED(free);
1112 #endif
1113 }
1114
1115 void
1116 rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
1117         void * const *first_obj_table_const, unsigned int n, int free)
1118 {
1119 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1120         struct rte_mempool_info info;
1121         const size_t total_elt_sz =
1122                 mp->header_size + mp->elt_size + mp->trailer_size;
1123         unsigned int i, j;
1124
1125         rte_mempool_ops_get_info(mp, &info);
1126
1127         for (i = 0; i < n; ++i) {
1128                 void *first_obj = first_obj_table_const[i];
1129
1130                 for (j = 0; j < info.contig_block_size; ++j) {
1131                         void *obj;
1132
1133                         obj = (void *)((uintptr_t)first_obj + j * total_elt_sz);
1134                         rte_mempool_check_cookies(mp, &obj, 1, free);
1135                 }
1136         }
1137 #else
1138         RTE_SET_USED(mp);
1139         RTE_SET_USED(first_obj_table_const);
1140         RTE_SET_USED(n);
1141         RTE_SET_USED(free);
1142 #endif
1143 }
1144
1145 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1146 static void
1147 mempool_obj_audit(struct rte_mempool *mp, __rte_unused void *opaque,
1148         void *obj, __rte_unused unsigned idx)
1149 {
1150         __mempool_check_cookies(mp, &obj, 1, 2);
1151 }
1152
1153 static void
1154 mempool_audit_cookies(struct rte_mempool *mp)
1155 {
1156         unsigned num;
1157
1158         num = rte_mempool_obj_iter(mp, mempool_obj_audit, NULL);
1159         if (num != mp->size) {
1160                 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
1161                         "iterated only over %u elements\n",
1162                         mp, mp->size, num);
1163         }
1164 }
1165 #else
1166 #define mempool_audit_cookies(mp) do {} while(0)
1167 #endif
1168
1169 #ifndef __INTEL_COMPILER
1170 #pragma GCC diagnostic error "-Wcast-qual"
1171 #endif
1172
1173 /* check cookies before and after objects */
1174 static void
1175 mempool_audit_cache(const struct rte_mempool *mp)
1176 {
1177         /* check cache size consistency */
1178         unsigned lcore_id;
1179
1180         if (mp->cache_size == 0)
1181                 return;
1182
1183         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1184                 const struct rte_mempool_cache *cache;
1185                 cache = &mp->local_cache[lcore_id];
1186                 if (cache->len > cache->flushthresh) {
1187                         RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
1188                                 lcore_id);
1189                         rte_panic("MEMPOOL: invalid cache len\n");
1190                 }
1191         }
1192 }
1193
1194 /* check the consistency of mempool (size, cookies, ...) */
1195 void
1196 rte_mempool_audit(struct rte_mempool *mp)
1197 {
1198         mempool_audit_cache(mp);
1199         mempool_audit_cookies(mp);
1200
1201         /* For case where mempool DEBUG is not set, and cache size is 0 */
1202         RTE_SET_USED(mp);
1203 }
1204
1205 /* dump the status of the mempool on the console */
1206 void
1207 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
1208 {
1209 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1210         struct rte_mempool_info info;
1211         struct rte_mempool_debug_stats sum;
1212         unsigned lcore_id;
1213 #endif
1214         struct rte_mempool_memhdr *memhdr;
1215         unsigned common_count;
1216         unsigned cache_count;
1217         size_t mem_len = 0;
1218
1219         RTE_ASSERT(f != NULL);
1220         RTE_ASSERT(mp != NULL);
1221
1222         fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
1223         fprintf(f, "  flags=%x\n", mp->flags);
1224         fprintf(f, "  pool=%p\n", mp->pool_data);
1225         fprintf(f, "  iova=0x%" PRIx64 "\n", mp->mz->iova);
1226         fprintf(f, "  nb_mem_chunks=%u\n", mp->nb_mem_chunks);
1227         fprintf(f, "  size=%"PRIu32"\n", mp->size);
1228         fprintf(f, "  populated_size=%"PRIu32"\n", mp->populated_size);
1229         fprintf(f, "  header_size=%"PRIu32"\n", mp->header_size);
1230         fprintf(f, "  elt_size=%"PRIu32"\n", mp->elt_size);
1231         fprintf(f, "  trailer_size=%"PRIu32"\n", mp->trailer_size);
1232         fprintf(f, "  total_obj_size=%"PRIu32"\n",
1233                mp->header_size + mp->elt_size + mp->trailer_size);
1234
1235         fprintf(f, "  private_data_size=%"PRIu32"\n", mp->private_data_size);
1236
1237         STAILQ_FOREACH(memhdr, &mp->mem_list, next)
1238                 mem_len += memhdr->len;
1239         if (mem_len != 0) {
1240                 fprintf(f, "  avg bytes/object=%#Lf\n",
1241                         (long double)mem_len / mp->size);
1242         }
1243
1244         cache_count = rte_mempool_dump_cache(f, mp);
1245         common_count = rte_mempool_ops_get_count(mp);
1246         if ((cache_count + common_count) > mp->size)
1247                 common_count = mp->size - cache_count;
1248         fprintf(f, "  common_pool_count=%u\n", common_count);
1249
1250         /* sum and dump statistics */
1251 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1252         rte_mempool_ops_get_info(mp, &info);
1253         memset(&sum, 0, sizeof(sum));
1254         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1255                 sum.put_bulk += mp->stats[lcore_id].put_bulk;
1256                 sum.put_objs += mp->stats[lcore_id].put_objs;
1257                 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
1258                 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
1259                 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
1260                 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
1261                 sum.get_success_blks += mp->stats[lcore_id].get_success_blks;
1262                 sum.get_fail_blks += mp->stats[lcore_id].get_fail_blks;
1263         }
1264         fprintf(f, "  stats:\n");
1265         fprintf(f, "    put_bulk=%"PRIu64"\n", sum.put_bulk);
1266         fprintf(f, "    put_objs=%"PRIu64"\n", sum.put_objs);
1267         fprintf(f, "    get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
1268         fprintf(f, "    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
1269         fprintf(f, "    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
1270         fprintf(f, "    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
1271         if (info.contig_block_size > 0) {
1272                 fprintf(f, "    get_success_blks=%"PRIu64"\n",
1273                         sum.get_success_blks);
1274                 fprintf(f, "    get_fail_blks=%"PRIu64"\n", sum.get_fail_blks);
1275         }
1276 #else
1277         fprintf(f, "  no statistics available\n");
1278 #endif
1279
1280         rte_mempool_audit(mp);
1281 }
1282
1283 /* dump the status of all mempools on the console */
1284 void
1285 rte_mempool_list_dump(FILE *f)
1286 {
1287         struct rte_mempool *mp = NULL;
1288         struct rte_tailq_entry *te;
1289         struct rte_mempool_list *mempool_list;
1290
1291         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1292
1293         rte_mcfg_mempool_read_lock();
1294
1295         TAILQ_FOREACH(te, mempool_list, next) {
1296                 mp = (struct rte_mempool *) te->data;
1297                 rte_mempool_dump(f, mp);
1298         }
1299
1300         rte_mcfg_mempool_read_unlock();
1301 }
1302
1303 /* search a mempool from its name */
1304 struct rte_mempool *
1305 rte_mempool_lookup(const char *name)
1306 {
1307         struct rte_mempool *mp = NULL;
1308         struct rte_tailq_entry *te;
1309         struct rte_mempool_list *mempool_list;
1310
1311         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1312
1313         rte_mcfg_mempool_read_lock();
1314
1315         TAILQ_FOREACH(te, mempool_list, next) {
1316                 mp = (struct rte_mempool *) te->data;
1317                 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
1318                         break;
1319         }
1320
1321         rte_mcfg_mempool_read_unlock();
1322
1323         if (te == NULL) {
1324                 rte_errno = ENOENT;
1325                 return NULL;
1326         }
1327
1328         return mp;
1329 }
1330
1331 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *),
1332                       void *arg)
1333 {
1334         struct rte_tailq_entry *te = NULL;
1335         struct rte_mempool_list *mempool_list;
1336         void *tmp_te;
1337
1338         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1339
1340         rte_mcfg_mempool_read_lock();
1341
1342         TAILQ_FOREACH_SAFE(te, mempool_list, next, tmp_te) {
1343                 (*func)((struct rte_mempool *) te->data, arg);
1344         }
1345
1346         rte_mcfg_mempool_read_unlock();
1347 }