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