lib/librte_mempool/rte_mempool.c

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