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