lib/librte_mempool/rte_mempool.c

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