mempool: enforce valid flags at creation
[dpdk.git] / lib / 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
16 #include <rte_common.h>
17 #include <rte_log.h>
18 #include <rte_debug.h>
19 #include <rte_memory.h>
20 #include <rte_memzone.h>
21 #include <rte_malloc.h>
22 #include <rte_atomic.h>
23 #include <rte_launch.h>
24 #include <rte_eal.h>
25 #include <rte_eal_memconfig.h>
26 #include <rte_per_lcore.h>
27 #include <rte_lcore.h>
28 #include <rte_branch_prediction.h>
29 #include <rte_errno.h>
30 #include <rte_string_fns.h>
31 #include <rte_spinlock.h>
32 #include <rte_tailq.h>
33 #include <rte_eal_paging.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) rte_mem_page_size() : 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 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
363         rte_mempool_trace_populate_iova(mp, vaddr, iova, len, free_cb, opaque);
364         return i;
365
366 fail:
367         rte_free(memhdr);
368         return ret;
369 }
370
371 static rte_iova_t
372 get_iova(void *addr)
373 {
374         struct rte_memseg *ms;
375
376         /* try registered memory first */
377         ms = rte_mem_virt2memseg(addr, NULL);
378         if (ms == NULL || ms->iova == RTE_BAD_IOVA)
379                 /* fall back to actual physical address */
380                 return rte_mem_virt2iova(addr);
381         return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
382 }
383
384 /* Populate the mempool with a virtual area. Return the number of
385  * objects added, or a negative value on error.
386  */
387 int
388 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
389         size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
390         void *opaque)
391 {
392         rte_iova_t iova;
393         size_t off, phys_len;
394         int ret, cnt = 0;
395
396         if (mp->flags & MEMPOOL_F_NO_IOVA_CONTIG)
397                 return rte_mempool_populate_iova(mp, addr, RTE_BAD_IOVA,
398                         len, free_cb, opaque);
399
400         for (off = 0; off < len &&
401                      mp->populated_size < mp->size; off += phys_len) {
402
403                 iova = get_iova(addr + off);
404
405                 /* populate with the largest group of contiguous pages */
406                 for (phys_len = RTE_MIN(
407                         (size_t)(RTE_PTR_ALIGN_CEIL(addr + off + 1, pg_sz) -
408                                 (addr + off)),
409                         len - off);
410                      off + phys_len < len;
411                      phys_len = RTE_MIN(phys_len + pg_sz, len - off)) {
412                         rte_iova_t iova_tmp;
413
414                         iova_tmp = get_iova(addr + off + phys_len);
415
416                         if (iova_tmp == RTE_BAD_IOVA ||
417                                         iova_tmp != iova + phys_len)
418                                 break;
419                 }
420
421                 ret = rte_mempool_populate_iova(mp, addr + off, iova,
422                         phys_len, free_cb, opaque);
423                 if (ret == 0)
424                         continue;
425                 if (ret < 0)
426                         goto fail;
427                 /* no need to call the free callback for next chunks */
428                 free_cb = NULL;
429                 cnt += ret;
430         }
431
432         rte_mempool_trace_populate_virt(mp, addr, len, pg_sz, free_cb, opaque);
433         return cnt;
434
435  fail:
436         rte_mempool_free_memchunks(mp);
437         return ret;
438 }
439
440 /* Get the minimal page size used in a mempool before populating it. */
441 int
442 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz)
443 {
444         bool need_iova_contig_obj;
445         bool alloc_in_ext_mem;
446         int ret;
447
448         /* check if we can retrieve a valid socket ID */
449         ret = rte_malloc_heap_socket_is_external(mp->socket_id);
450         if (ret < 0)
451                 return -EINVAL;
452         alloc_in_ext_mem = (ret == 1);
453         need_iova_contig_obj = !(mp->flags & MEMPOOL_F_NO_IOVA_CONTIG);
454
455         if (!need_iova_contig_obj)
456                 *pg_sz = 0;
457         else if (rte_eal_has_hugepages() || alloc_in_ext_mem)
458                 *pg_sz = get_min_page_size(mp->socket_id);
459         else
460                 *pg_sz = rte_mem_page_size();
461
462         rte_mempool_trace_get_page_size(mp, *pg_sz);
463         return 0;
464 }
465
466 /* Default function to populate the mempool: allocate memory in memzones,
467  * and populate them. Return the number of objects added, or a negative
468  * value on error.
469  */
470 int
471 rte_mempool_populate_default(struct rte_mempool *mp)
472 {
473         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
474         char mz_name[RTE_MEMZONE_NAMESIZE];
475         const struct rte_memzone *mz;
476         ssize_t mem_size;
477         size_t align, pg_sz, pg_shift = 0;
478         rte_iova_t iova;
479         unsigned mz_id, n;
480         int ret;
481         bool need_iova_contig_obj;
482         size_t max_alloc_size = SIZE_MAX;
483
484         ret = mempool_ops_alloc_once(mp);
485         if (ret != 0)
486                 return ret;
487
488         /* mempool must not be populated */
489         if (mp->nb_mem_chunks != 0)
490                 return -EEXIST;
491
492         /*
493          * the following section calculates page shift and page size values.
494          *
495          * these values impact the result of calc_mem_size operation, which
496          * returns the amount of memory that should be allocated to store the
497          * desired number of objects. when not zero, it allocates more memory
498          * for the padding between objects, to ensure that an object does not
499          * cross a page boundary. in other words, page size/shift are to be set
500          * to zero if mempool elements won't care about page boundaries.
501          * there are several considerations for page size and page shift here.
502          *
503          * if we don't need our mempools to have physically contiguous objects,
504          * then just set page shift and page size to 0, because the user has
505          * indicated that there's no need to care about anything.
506          *
507          * if we do need contiguous objects (if a mempool driver has its
508          * own calc_size() method returning min_chunk_size = mem_size),
509          * there is also an option to reserve the entire mempool memory
510          * as one contiguous block of memory.
511          *
512          * if we require contiguous objects, but not necessarily the entire
513          * mempool reserved space to be contiguous, pg_sz will be != 0,
514          * and the default ops->populate() will take care of not placing
515          * objects across pages.
516          *
517          * if our IO addresses are physical, we may get memory from bigger
518          * pages, or we might get memory from smaller pages, and how much of it
519          * we require depends on whether we want bigger or smaller pages.
520          * However, requesting each and every memory size is too much work, so
521          * what we'll do instead is walk through the page sizes available, pick
522          * the smallest one and set up page shift to match that one. We will be
523          * wasting some space this way, but it's much nicer than looping around
524          * trying to reserve each and every page size.
525          *
526          * If we fail to get enough contiguous memory, then we'll go and
527          * reserve space in smaller chunks.
528          */
529
530         need_iova_contig_obj = !(mp->flags & MEMPOOL_F_NO_IOVA_CONTIG);
531         ret = rte_mempool_get_page_size(mp, &pg_sz);
532         if (ret < 0)
533                 return ret;
534
535         if (pg_sz != 0)
536                 pg_shift = rte_bsf32(pg_sz);
537
538         for (mz_id = 0, n = mp->size; n > 0; mz_id++, n -= ret) {
539                 size_t min_chunk_size;
540
541                 mem_size = rte_mempool_ops_calc_mem_size(
542                         mp, n, pg_shift, &min_chunk_size, &align);
543
544                 if (mem_size < 0) {
545                         ret = mem_size;
546                         goto fail;
547                 }
548
549                 ret = snprintf(mz_name, sizeof(mz_name),
550                         RTE_MEMPOOL_MZ_FORMAT "_%d", mp->name, mz_id);
551                 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
552                         ret = -ENAMETOOLONG;
553                         goto fail;
554                 }
555
556                 /* if we're trying to reserve contiguous memory, add appropriate
557                  * memzone flag.
558                  */
559                 if (min_chunk_size == (size_t)mem_size)
560                         mz_flags |= RTE_MEMZONE_IOVA_CONTIG;
561
562                 /* Allocate a memzone, retrying with a smaller area on ENOMEM */
563                 do {
564                         mz = rte_memzone_reserve_aligned(mz_name,
565                                 RTE_MIN((size_t)mem_size, max_alloc_size),
566                                 mp->socket_id, mz_flags, align);
567
568                         if (mz != NULL || rte_errno != ENOMEM)
569                                 break;
570
571                         max_alloc_size = RTE_MIN(max_alloc_size,
572                                                 (size_t)mem_size) / 2;
573                 } while (mz == NULL && max_alloc_size >= min_chunk_size);
574
575                 if (mz == NULL) {
576                         ret = -rte_errno;
577                         goto fail;
578                 }
579
580                 if (need_iova_contig_obj)
581                         iova = mz->iova;
582                 else
583                         iova = RTE_BAD_IOVA;
584
585                 if (pg_sz == 0 || (mz_flags & RTE_MEMZONE_IOVA_CONTIG))
586                         ret = rte_mempool_populate_iova(mp, mz->addr,
587                                 iova, mz->len,
588                                 rte_mempool_memchunk_mz_free,
589                                 (void *)(uintptr_t)mz);
590                 else
591                         ret = rte_mempool_populate_virt(mp, mz->addr,
592                                 mz->len, pg_sz,
593                                 rte_mempool_memchunk_mz_free,
594                                 (void *)(uintptr_t)mz);
595                 if (ret == 0) /* should not happen */
596                         ret = -ENOBUFS;
597                 if (ret < 0) {
598                         rte_memzone_free(mz);
599                         goto fail;
600                 }
601         }
602
603         rte_mempool_trace_populate_default(mp);
604         return mp->size;
605
606  fail:
607         rte_mempool_free_memchunks(mp);
608         return ret;
609 }
610
611 /* return the memory size required for mempool objects in anonymous mem */
612 static ssize_t
613 get_anon_size(const struct rte_mempool *mp)
614 {
615         ssize_t size;
616         size_t pg_sz, pg_shift;
617         size_t min_chunk_size;
618         size_t align;
619
620         pg_sz = rte_mem_page_size();
621         pg_shift = rte_bsf32(pg_sz);
622         size = rte_mempool_ops_calc_mem_size(mp, mp->size, pg_shift,
623                                              &min_chunk_size, &align);
624
625         return size;
626 }
627
628 /* unmap a memory zone mapped by rte_mempool_populate_anon() */
629 static void
630 rte_mempool_memchunk_anon_free(struct rte_mempool_memhdr *memhdr,
631         void *opaque)
632 {
633         ssize_t size;
634
635         /*
636          * Calculate size since memhdr->len has contiguous chunk length
637          * which may be smaller if anon map is split into many contiguous
638          * chunks. Result must be the same as we calculated on populate.
639          */
640         size = get_anon_size(memhdr->mp);
641         if (size < 0)
642                 return;
643
644         rte_mem_unmap(opaque, size);
645 }
646
647 /* populate the mempool with an anonymous mapping */
648 int
649 rte_mempool_populate_anon(struct rte_mempool *mp)
650 {
651         ssize_t size;
652         int ret;
653         char *addr;
654
655         /* mempool is already populated, error */
656         if ((!STAILQ_EMPTY(&mp->mem_list)) || mp->nb_mem_chunks != 0) {
657                 rte_errno = EINVAL;
658                 return 0;
659         }
660
661         ret = mempool_ops_alloc_once(mp);
662         if (ret < 0) {
663                 rte_errno = -ret;
664                 return 0;
665         }
666
667         size = get_anon_size(mp);
668         if (size < 0) {
669                 rte_errno = -size;
670                 return 0;
671         }
672
673         /* get chunk of virtually continuous memory */
674         addr = rte_mem_map(NULL, size, RTE_PROT_READ | RTE_PROT_WRITE,
675                 RTE_MAP_SHARED | RTE_MAP_ANONYMOUS, -1, 0);
676         if (addr == NULL)
677                 return 0;
678         /* can't use MMAP_LOCKED, it does not exist on BSD */
679         if (rte_mem_lock(addr, size) < 0) {
680                 rte_mem_unmap(addr, size);
681                 return 0;
682         }
683
684         ret = rte_mempool_populate_virt(mp, addr, size, rte_mem_page_size(),
685                 rte_mempool_memchunk_anon_free, addr);
686         if (ret == 0) /* should not happen */
687                 ret = -ENOBUFS;
688         if (ret < 0) {
689                 rte_errno = -ret;
690                 goto fail;
691         }
692
693         rte_mempool_trace_populate_anon(mp);
694         return mp->populated_size;
695
696  fail:
697         rte_mempool_free_memchunks(mp);
698         return 0;
699 }
700
701 /* free a mempool */
702 void
703 rte_mempool_free(struct rte_mempool *mp)
704 {
705         struct rte_mempool_list *mempool_list = NULL;
706         struct rte_tailq_entry *te;
707
708         if (mp == NULL)
709                 return;
710
711         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
712         rte_mcfg_tailq_write_lock();
713         /* find out tailq entry */
714         TAILQ_FOREACH(te, mempool_list, next) {
715                 if (te->data == (void *)mp)
716                         break;
717         }
718
719         if (te != NULL) {
720                 TAILQ_REMOVE(mempool_list, te, next);
721                 rte_free(te);
722         }
723         rte_mcfg_tailq_write_unlock();
724
725         rte_mempool_trace_free(mp);
726         rte_mempool_free_memchunks(mp);
727         rte_mempool_ops_free(mp);
728         rte_memzone_free(mp->mz);
729 }
730
731 static void
732 mempool_cache_init(struct rte_mempool_cache *cache, uint32_t size)
733 {
734         cache->size = size;
735         cache->flushthresh = CALC_CACHE_FLUSHTHRESH(size);
736         cache->len = 0;
737 }
738
739 /*
740  * Create and initialize a cache for objects that are retrieved from and
741  * returned to an underlying mempool. This structure is identical to the
742  * local_cache[lcore_id] pointed to by the mempool structure.
743  */
744 struct rte_mempool_cache *
745 rte_mempool_cache_create(uint32_t size, int socket_id)
746 {
747         struct rte_mempool_cache *cache;
748
749         if (size == 0 || size > RTE_MEMPOOL_CACHE_MAX_SIZE) {
750                 rte_errno = EINVAL;
751                 return NULL;
752         }
753
754         cache = rte_zmalloc_socket("MEMPOOL_CACHE", sizeof(*cache),
755                                   RTE_CACHE_LINE_SIZE, socket_id);
756         if (cache == NULL) {
757                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate mempool cache.\n");
758                 rte_errno = ENOMEM;
759                 return NULL;
760         }
761
762         mempool_cache_init(cache, size);
763
764         rte_mempool_trace_cache_create(size, socket_id, cache);
765         return cache;
766 }
767
768 /*
769  * Free a cache. It's the responsibility of the user to make sure that any
770  * remaining objects in the cache are flushed to the corresponding
771  * mempool.
772  */
773 void
774 rte_mempool_cache_free(struct rte_mempool_cache *cache)
775 {
776         rte_mempool_trace_cache_free(cache);
777         rte_free(cache);
778 }
779
780 #define MEMPOOL_KNOWN_FLAGS (MEMPOOL_F_NO_SPREAD \
781         | MEMPOOL_F_NO_CACHE_ALIGN \
782         | MEMPOOL_F_SP_PUT \
783         | MEMPOOL_F_SC_GET \
784         | MEMPOOL_F_POOL_CREATED \
785         | MEMPOOL_F_NO_IOVA_CONTIG \
786         )
787 /* create an empty mempool */
788 struct rte_mempool *
789 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
790         unsigned cache_size, unsigned private_data_size,
791         int socket_id, unsigned flags)
792 {
793         char mz_name[RTE_MEMZONE_NAMESIZE];
794         struct rte_mempool_list *mempool_list;
795         struct rte_mempool *mp = NULL;
796         struct rte_tailq_entry *te = NULL;
797         const struct rte_memzone *mz = NULL;
798         size_t mempool_size;
799         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
800         struct rte_mempool_objsz objsz;
801         unsigned lcore_id;
802         int ret;
803
804         /* compilation-time checks */
805         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
806                           RTE_CACHE_LINE_MASK) != 0);
807         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
808                           RTE_CACHE_LINE_MASK) != 0);
809 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
810         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
811                           RTE_CACHE_LINE_MASK) != 0);
812         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
813                           RTE_CACHE_LINE_MASK) != 0);
814 #endif
815
816         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
817
818         /* asked for zero items */
819         if (n == 0) {
820                 rte_errno = EINVAL;
821                 return NULL;
822         }
823
824         /* asked cache too big */
825         if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
826             CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
827                 rte_errno = EINVAL;
828                 return NULL;
829         }
830
831         /* enforce no unknown flag is passed by the application */
832         if ((flags & ~MEMPOOL_KNOWN_FLAGS) != 0) {
833                 rte_errno = EINVAL;
834                 return NULL;
835         }
836
837         /* "no cache align" imply "no spread" */
838         if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
839                 flags |= MEMPOOL_F_NO_SPREAD;
840
841         /* calculate mempool object sizes. */
842         if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
843                 rte_errno = EINVAL;
844                 return NULL;
845         }
846
847         rte_mcfg_mempool_write_lock();
848
849         /*
850          * reserve a memory zone for this mempool: private data is
851          * cache-aligned
852          */
853         private_data_size = (private_data_size +
854                              RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
855
856
857         /* try to allocate tailq entry */
858         te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
859         if (te == NULL) {
860                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
861                 goto exit_unlock;
862         }
863
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);
867
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;
871                 goto exit_unlock;
872         }
873
874         mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
875         if (mz == NULL)
876                 goto exit_unlock;
877
878         /* init the mempool structure */
879         mp = mz->addr;
880         memset(mp, 0, MEMPOOL_HEADER_SIZE(mp, cache_size));
881         ret = strlcpy(mp->name, name, sizeof(mp->name));
882         if (ret < 0 || ret >= (int)sizeof(mp->name)) {
883                 rte_errno = ENAMETOOLONG;
884                 goto exit_unlock;
885         }
886         mp->mz = mz;
887         mp->size = n;
888         mp->flags = flags;
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);
898
899         /*
900          * local_cache pointer is set even if cache_size is zero.
901          * The local_cache points to just past the elt_pa[] array.
902          */
903         mp->local_cache = (struct rte_mempool_cache *)
904                 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, 0));
905
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],
910                                            cache_size);
911         }
912
913         te->data = mp;
914
915         rte_mcfg_tailq_write_lock();
916         TAILQ_INSERT_TAIL(mempool_list, te, next);
917         rte_mcfg_tailq_write_unlock();
918         rte_mcfg_mempool_write_unlock();
919
920         rte_mempool_trace_create_empty(name, n, elt_size, cache_size,
921                 private_data_size, flags, mp);
922         return mp;
923
924 exit_unlock:
925         rte_mcfg_mempool_write_unlock();
926         rte_free(te);
927         rte_mempool_free(mp);
928         return NULL;
929 }
930
931 /* create the mempool */
932 struct rte_mempool *
933 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
934         unsigned cache_size, unsigned private_data_size,
935         rte_mempool_ctor_t *mp_init, void *mp_init_arg,
936         rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
937         int socket_id, unsigned flags)
938 {
939         int ret;
940         struct rte_mempool *mp;
941
942         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
943                 private_data_size, socket_id, flags);
944         if (mp == NULL)
945                 return NULL;
946
947         /*
948          * Since we have 4 combinations of the SP/SC/MP/MC examine the flags to
949          * set the correct index into the table of ops structs.
950          */
951         if ((flags & MEMPOOL_F_SP_PUT) && (flags & MEMPOOL_F_SC_GET))
952                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_sc", NULL);
953         else if (flags & MEMPOOL_F_SP_PUT)
954                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_mc", NULL);
955         else if (flags & MEMPOOL_F_SC_GET)
956                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_sc", NULL);
957         else
958                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_mc", NULL);
959
960         if (ret)
961                 goto fail;
962
963         /* call the mempool priv initializer */
964         if (mp_init)
965                 mp_init(mp, mp_init_arg);
966
967         if (rte_mempool_populate_default(mp) < 0)
968                 goto fail;
969
970         /* call the object initializers */
971         if (obj_init)
972                 rte_mempool_obj_iter(mp, obj_init, obj_init_arg);
973
974         rte_mempool_trace_create(name, n, elt_size, cache_size,
975                 private_data_size, mp_init, mp_init_arg, obj_init,
976                 obj_init_arg, flags, mp);
977         return mp;
978
979  fail:
980         rte_mempool_free(mp);
981         return NULL;
982 }
983
984 /* Return the number of entries in the mempool */
985 unsigned int
986 rte_mempool_avail_count(const struct rte_mempool *mp)
987 {
988         unsigned count;
989         unsigned lcore_id;
990
991         count = rte_mempool_ops_get_count(mp);
992
993         if (mp->cache_size == 0)
994                 return count;
995
996         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
997                 count += mp->local_cache[lcore_id].len;
998
999         /*
1000          * due to race condition (access to len is not locked), the
1001          * total can be greater than size... so fix the result
1002          */
1003         if (count > mp->size)
1004                 return mp->size;
1005         return count;
1006 }
1007
1008 /* return the number of entries allocated from the mempool */
1009 unsigned int
1010 rte_mempool_in_use_count(const struct rte_mempool *mp)
1011 {
1012         return mp->size - rte_mempool_avail_count(mp);
1013 }
1014
1015 /* dump the cache status */
1016 static unsigned
1017 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
1018 {
1019         unsigned lcore_id;
1020         unsigned count = 0;
1021         unsigned cache_count;
1022
1023         fprintf(f, "  internal cache infos:\n");
1024         fprintf(f, "    cache_size=%"PRIu32"\n", mp->cache_size);
1025
1026         if (mp->cache_size == 0)
1027                 return count;
1028
1029         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1030                 cache_count = mp->local_cache[lcore_id].len;
1031                 fprintf(f, "    cache_count[%u]=%"PRIu32"\n",
1032                         lcore_id, cache_count);
1033                 count += cache_count;
1034         }
1035         fprintf(f, "    total_cache_count=%u\n", count);
1036         return count;
1037 }
1038
1039 #ifndef __INTEL_COMPILER
1040 #pragma GCC diagnostic ignored "-Wcast-qual"
1041 #endif
1042
1043 /* check and update cookies or panic (internal) */
1044 void rte_mempool_check_cookies(const struct rte_mempool *mp,
1045         void * const *obj_table_const, unsigned n, int free)
1046 {
1047 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1048         struct rte_mempool_objhdr *hdr;
1049         struct rte_mempool_objtlr *tlr;
1050         uint64_t cookie;
1051         void *tmp;
1052         void *obj;
1053         void **obj_table;
1054
1055         /* Force to drop the "const" attribute. This is done only when
1056          * DEBUG is enabled */
1057         tmp = (void *) obj_table_const;
1058         obj_table = tmp;
1059
1060         while (n--) {
1061                 obj = obj_table[n];
1062
1063                 if (rte_mempool_from_obj(obj) != mp)
1064                         rte_panic("MEMPOOL: object is owned by another "
1065                                   "mempool\n");
1066
1067                 hdr = __mempool_get_header(obj);
1068                 cookie = hdr->cookie;
1069
1070                 if (free == 0) {
1071                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
1072                                 RTE_LOG(CRIT, MEMPOOL,
1073                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1074                                         obj, (const void *) mp, cookie);
1075                                 rte_panic("MEMPOOL: bad header cookie (put)\n");
1076                         }
1077                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
1078                 } else if (free == 1) {
1079                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1080                                 RTE_LOG(CRIT, MEMPOOL,
1081                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1082                                         obj, (const void *) mp, cookie);
1083                                 rte_panic("MEMPOOL: bad header cookie (get)\n");
1084                         }
1085                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
1086                 } else if (free == 2) {
1087                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
1088                             cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1089                                 RTE_LOG(CRIT, MEMPOOL,
1090                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1091                                         obj, (const void *) mp, cookie);
1092                                 rte_panic("MEMPOOL: bad header cookie (audit)\n");
1093                         }
1094                 }
1095                 tlr = __mempool_get_trailer(obj);
1096                 cookie = tlr->cookie;
1097                 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
1098                         RTE_LOG(CRIT, MEMPOOL,
1099                                 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1100                                 obj, (const void *) mp, cookie);
1101                         rte_panic("MEMPOOL: bad trailer cookie\n");
1102                 }
1103         }
1104 #else
1105         RTE_SET_USED(mp);
1106         RTE_SET_USED(obj_table_const);
1107         RTE_SET_USED(n);
1108         RTE_SET_USED(free);
1109 #endif
1110 }
1111
1112 void
1113 rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
1114         void * const *first_obj_table_const, unsigned int n, int free)
1115 {
1116 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1117         struct rte_mempool_info info;
1118         const size_t total_elt_sz =
1119                 mp->header_size + mp->elt_size + mp->trailer_size;
1120         unsigned int i, j;
1121
1122         rte_mempool_ops_get_info(mp, &info);
1123
1124         for (i = 0; i < n; ++i) {
1125                 void *first_obj = first_obj_table_const[i];
1126
1127                 for (j = 0; j < info.contig_block_size; ++j) {
1128                         void *obj;
1129
1130                         obj = (void *)((uintptr_t)first_obj + j * total_elt_sz);
1131                         rte_mempool_check_cookies(mp, &obj, 1, free);
1132                 }
1133         }
1134 #else
1135         RTE_SET_USED(mp);
1136         RTE_SET_USED(first_obj_table_const);
1137         RTE_SET_USED(n);
1138         RTE_SET_USED(free);
1139 #endif
1140 }
1141
1142 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1143 static void
1144 mempool_obj_audit(struct rte_mempool *mp, __rte_unused void *opaque,
1145         void *obj, __rte_unused unsigned idx)
1146 {
1147         __mempool_check_cookies(mp, &obj, 1, 2);
1148 }
1149
1150 static void
1151 mempool_audit_cookies(struct rte_mempool *mp)
1152 {
1153         unsigned num;
1154
1155         num = rte_mempool_obj_iter(mp, mempool_obj_audit, NULL);
1156         if (num != mp->size) {
1157                 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
1158                         "iterated only over %u elements\n",
1159                         mp, mp->size, num);
1160         }
1161 }
1162 #else
1163 #define mempool_audit_cookies(mp) do {} while(0)
1164 #endif
1165
1166 #ifndef __INTEL_COMPILER
1167 #pragma GCC diagnostic error "-Wcast-qual"
1168 #endif
1169
1170 /* check cookies before and after objects */
1171 static void
1172 mempool_audit_cache(const struct rte_mempool *mp)
1173 {
1174         /* check cache size consistency */
1175         unsigned lcore_id;
1176
1177         if (mp->cache_size == 0)
1178                 return;
1179
1180         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1181                 const struct rte_mempool_cache *cache;
1182                 cache = &mp->local_cache[lcore_id];
1183                 if (cache->len > RTE_DIM(cache->objs)) {
1184                         RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
1185                                 lcore_id);
1186                         rte_panic("MEMPOOL: invalid cache len\n");
1187                 }
1188         }
1189 }
1190
1191 /* check the consistency of mempool (size, cookies, ...) */
1192 void
1193 rte_mempool_audit(struct rte_mempool *mp)
1194 {
1195         mempool_audit_cache(mp);
1196         mempool_audit_cookies(mp);
1197
1198         /* For case where mempool DEBUG is not set, and cache size is 0 */
1199         RTE_SET_USED(mp);
1200 }
1201
1202 /* dump the status of the mempool on the console */
1203 void
1204 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
1205 {
1206 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1207         struct rte_mempool_info info;
1208         struct rte_mempool_debug_stats sum;
1209         unsigned lcore_id;
1210 #endif
1211         struct rte_mempool_memhdr *memhdr;
1212         struct rte_mempool_ops *ops;
1213         unsigned common_count;
1214         unsigned cache_count;
1215         size_t mem_len = 0;
1216
1217         RTE_ASSERT(f != NULL);
1218         RTE_ASSERT(mp != NULL);
1219
1220         fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
1221         fprintf(f, "  flags=%x\n", mp->flags);
1222         fprintf(f, "  socket_id=%d\n", mp->socket_id);
1223         fprintf(f, "  pool=%p\n", mp->pool_data);
1224         fprintf(f, "  iova=0x%" PRIx64 "\n", mp->mz->iova);
1225         fprintf(f, "  nb_mem_chunks=%u\n", mp->nb_mem_chunks);
1226         fprintf(f, "  size=%"PRIu32"\n", mp->size);
1227         fprintf(f, "  populated_size=%"PRIu32"\n", mp->populated_size);
1228         fprintf(f, "  header_size=%"PRIu32"\n", mp->header_size);
1229         fprintf(f, "  elt_size=%"PRIu32"\n", mp->elt_size);
1230         fprintf(f, "  trailer_size=%"PRIu32"\n", mp->trailer_size);
1231         fprintf(f, "  total_obj_size=%"PRIu32"\n",
1232                mp->header_size + mp->elt_size + mp->trailer_size);
1233
1234         fprintf(f, "  private_data_size=%"PRIu32"\n", mp->private_data_size);
1235
1236         fprintf(f, "  ops_index=%d\n", mp->ops_index);
1237         ops = rte_mempool_get_ops(mp->ops_index);
1238         fprintf(f, "  ops_name: <%s>\n", (ops != NULL) ? ops->name : "NA");
1239
1240         STAILQ_FOREACH(memhdr, &mp->mem_list, next)
1241                 mem_len += memhdr->len;
1242         if (mem_len != 0) {
1243                 fprintf(f, "  avg bytes/object=%#Lf\n",
1244                         (long double)mem_len / mp->size);
1245         }
1246
1247         cache_count = rte_mempool_dump_cache(f, mp);
1248         common_count = rte_mempool_ops_get_count(mp);
1249         if ((cache_count + common_count) > mp->size)
1250                 common_count = mp->size - cache_count;
1251         fprintf(f, "  common_pool_count=%u\n", common_count);
1252
1253         /* sum and dump statistics */
1254 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1255         rte_mempool_ops_get_info(mp, &info);
1256         memset(&sum, 0, sizeof(sum));
1257         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1258                 sum.put_bulk += mp->stats[lcore_id].put_bulk;
1259                 sum.put_objs += mp->stats[lcore_id].put_objs;
1260                 sum.put_common_pool_bulk += mp->stats[lcore_id].put_common_pool_bulk;
1261                 sum.put_common_pool_objs += mp->stats[lcore_id].put_common_pool_objs;
1262                 sum.get_common_pool_bulk += mp->stats[lcore_id].get_common_pool_bulk;
1263                 sum.get_common_pool_objs += mp->stats[lcore_id].get_common_pool_objs;
1264                 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
1265                 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
1266                 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
1267                 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
1268                 sum.get_success_blks += mp->stats[lcore_id].get_success_blks;
1269                 sum.get_fail_blks += mp->stats[lcore_id].get_fail_blks;
1270         }
1271         fprintf(f, "  stats:\n");
1272         fprintf(f, "    put_bulk=%"PRIu64"\n", sum.put_bulk);
1273         fprintf(f, "    put_objs=%"PRIu64"\n", sum.put_objs);
1274         fprintf(f, "    put_common_pool_bulk=%"PRIu64"\n", sum.put_common_pool_bulk);
1275         fprintf(f, "    put_common_pool_objs=%"PRIu64"\n", sum.put_common_pool_objs);
1276         fprintf(f, "    get_common_pool_bulk=%"PRIu64"\n", sum.get_common_pool_bulk);
1277         fprintf(f, "    get_common_pool_objs=%"PRIu64"\n", sum.get_common_pool_objs);
1278         fprintf(f, "    get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
1279         fprintf(f, "    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
1280         fprintf(f, "    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
1281         fprintf(f, "    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
1282         if (info.contig_block_size > 0) {
1283                 fprintf(f, "    get_success_blks=%"PRIu64"\n",
1284                         sum.get_success_blks);
1285                 fprintf(f, "    get_fail_blks=%"PRIu64"\n", sum.get_fail_blks);
1286         }
1287 #else
1288         fprintf(f, "  no statistics available\n");
1289 #endif
1290
1291         rte_mempool_audit(mp);
1292 }
1293
1294 /* dump the status of all mempools on the console */
1295 void
1296 rte_mempool_list_dump(FILE *f)
1297 {
1298         struct rte_mempool *mp = NULL;
1299         struct rte_tailq_entry *te;
1300         struct rte_mempool_list *mempool_list;
1301
1302         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1303
1304         rte_mcfg_mempool_read_lock();
1305
1306         TAILQ_FOREACH(te, mempool_list, next) {
1307                 mp = (struct rte_mempool *) te->data;
1308                 rte_mempool_dump(f, mp);
1309         }
1310
1311         rte_mcfg_mempool_read_unlock();
1312 }
1313
1314 /* search a mempool from its name */
1315 struct rte_mempool *
1316 rte_mempool_lookup(const char *name)
1317 {
1318         struct rte_mempool *mp = NULL;
1319         struct rte_tailq_entry *te;
1320         struct rte_mempool_list *mempool_list;
1321
1322         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1323
1324         rte_mcfg_mempool_read_lock();
1325
1326         TAILQ_FOREACH(te, mempool_list, next) {
1327                 mp = (struct rte_mempool *) te->data;
1328                 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
1329                         break;
1330         }
1331
1332         rte_mcfg_mempool_read_unlock();
1333
1334         if (te == NULL) {
1335                 rte_errno = ENOENT;
1336                 return NULL;
1337         }
1338
1339         return mp;
1340 }
1341
1342 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *),
1343                       void *arg)
1344 {
1345         struct rte_tailq_entry *te = NULL;
1346         struct rte_mempool_list *mempool_list;
1347         void *tmp_te;
1348
1349         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1350
1351         rte_mcfg_mempool_read_lock();
1352
1353         RTE_TAILQ_FOREACH_SAFE(te, mempool_list, next, tmp_te) {
1354                 (*func)((struct rte_mempool *) te->data, arg);
1355         }
1356
1357         rte_mcfg_mempool_read_unlock();
1358 }