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