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