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