lib/librte_mempool/rte_mempool.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <stdint.h>
  37 #include <stdarg.h>
  38 #include <unistd.h>
  39 #include <inttypes.h>
  40 #include <errno.h>
  41 #include <sys/queue.h>
  42
  43 #include <rte_common.h>
  44 #include <rte_log.h>
  45 #include <rte_debug.h>
  46 #include <rte_memory.h>
  47 #include <rte_memzone.h>
  48 #include <rte_malloc.h>
  49 #include <rte_atomic.h>
  50 #include <rte_launch.h>
  51 #include <rte_eal.h>
  52 #include <rte_eal_memconfig.h>
  53 #include <rte_per_lcore.h>
  54 #include <rte_lcore.h>
  55 #include <rte_branch_prediction.h>
  56 #include <rte_ring.h>
  57 #include <rte_errno.h>
  58 #include <rte_string_fns.h>
  59 #include <rte_spinlock.h>
  60
  61 #include "rte_mempool.h"
  62
  63 TAILQ_HEAD(rte_mempool_list, rte_tailq_entry);
  64
  65 static struct rte_tailq_elem rte_mempool_tailq = {
  66         .name = "RTE_MEMPOOL",
  67 };
  68 EAL_REGISTER_TAILQ(rte_mempool_tailq)
  69
  70 #define CACHE_FLUSHTHRESH_MULTIPLIER 1.5
  71 #define CALC_CACHE_FLUSHTHRESH(c)       \
  72         ((typeof(c))((c) * CACHE_FLUSHTHRESH_MULTIPLIER))
  73
  74 /*
  75  * return the greatest common divisor between a and b (fast algorithm)
  76  *
  77  */
  78 static unsigned get_gcd(unsigned a, unsigned b)
  79 {
  80         unsigned c;
  81
  82         if (0 == a)
  83                 return b;
  84         if (0 == b)
  85                 return a;
  86
  87         if (a < b) {
  88                 c = a;
  89                 a = b;
  90                 b = c;
  91         }
  92
  93         while (b != 0) {
  94                 c = a % b;
  95                 a = b;
  96                 b = c;
  97         }
  98
  99         return a;
 100 }
 101
 102 /*
 103  * Depending on memory configuration, objects addresses are spread
 104  * between channels and ranks in RAM: the pool allocator will add
 105  * padding between objects. This function return the new size of the
 106  * object.
 107  */
 108 static unsigned optimize_object_size(unsigned obj_size)
 109 {
 110         unsigned nrank, nchan;
 111         unsigned new_obj_size;
 112
 113         /* get number of channels */
 114         nchan = rte_memory_get_nchannel();
 115         if (nchan == 0)
 116                 nchan = 4;
 117
 118         nrank = rte_memory_get_nrank();
 119         if (nrank == 0)
 120                 nrank = 1;
 121
 122         /* process new object size */
 123         new_obj_size = (obj_size + RTE_MEMPOOL_ALIGN_MASK) / RTE_MEMPOOL_ALIGN;
 124         while (get_gcd(new_obj_size, nrank * nchan) != 1)
 125                 new_obj_size++;
 126         return new_obj_size * RTE_MEMPOOL_ALIGN;
 127 }
 128
 129 static void
 130 mempool_add_elem(struct rte_mempool *mp, void *obj, uint32_t obj_idx,
 131         rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg)
 132 {
 133         struct rte_mempool_objhdr *hdr;
 134         struct rte_mempool_objtlr *tlr __rte_unused;
 135
 136         obj = (char *)obj + mp->header_size;
 137
 138         /* set mempool ptr in header */
 139         hdr = RTE_PTR_SUB(obj, sizeof(*hdr));
 140         hdr->mp = mp;
 141
 142 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 143         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
 144         tlr = __mempool_get_trailer(obj);
 145         tlr->cookie = RTE_MEMPOOL_TRAILER_COOKIE;
 146 #endif
 147         /* call the initializer */
 148         if (obj_init)
 149                 obj_init(mp, obj_init_arg, obj, obj_idx);
 150
 151         /* enqueue in ring */
 152         rte_ring_sp_enqueue(mp->ring, obj);
 153 }
 154
 155 /* Iterate through objects at the given address
 156  *
 157  * Given the pointer to the memory, and its topology in physical memory
 158  * (the physical addresses table), iterate through the "elt_num" objects
 159  * of size "elt_sz" aligned at "align". For each object in this memory
 160  * chunk, invoke a callback. It returns the effective number of objects
 161  * in this memory.
 162  */
 163 uint32_t
 164 rte_mempool_obj_iter(void *vaddr, uint32_t elt_num, size_t total_elt_sz,
 165         size_t align, const phys_addr_t paddr[], uint32_t pg_num,
 166         uint32_t pg_shift, rte_mempool_obj_iter_t obj_iter, void *obj_iter_arg)
 167 {
 168         uint32_t i, j, k;
 169         uint32_t pgn, pgf;
 170         uintptr_t end, start, va;
 171         uintptr_t pg_sz;
 172
 173         pg_sz = (uintptr_t)1 << pg_shift;
 174         va = (uintptr_t)vaddr;
 175
 176         i = 0;
 177         j = 0;
 178
 179         while (i != elt_num && j != pg_num) {
 180
 181                 start = RTE_ALIGN_CEIL(va, align);
 182                 end = start + total_elt_sz;
 183
 184                 /* index of the first page for the next element. */
 185                 pgf = (end >> pg_shift) - (start >> pg_shift);
 186
 187                 /* index of the last page for the current element. */
 188                 pgn = ((end - 1) >> pg_shift) - (start >> pg_shift);
 189                 pgn += j;
 190
 191                 /* do we have enough space left for the element. */
 192                 if (pgn >= pg_num)
 193                         break;
 194
 195                 for (k = j;
 196                                 k != pgn &&
 197                                 paddr[k] + pg_sz == paddr[k + 1];
 198                                 k++)
 199                         ;
 200
 201                 /*
 202                  * if next pgn chunks of memory physically continuous,
 203                  * use it to create next element.
 204                  * otherwise, just skip that chunk unused.
 205                  */
 206                 if (k == pgn) {
 207                         if (obj_iter != NULL)
 208                                 obj_iter(obj_iter_arg, (void *)start,
 209                                         (void *)end, i);
 210                         va = end;
 211                         j += pgf;
 212                         i++;
 213                 } else {
 214                         va = RTE_ALIGN_CEIL((va + 1), pg_sz);
 215                         j++;
 216                 }
 217         }
 218
 219         return i;
 220 }
 221
 222 /*
 223  * Populate  mempool with the objects.
 224  */
 225
 226 struct mempool_populate_arg {
 227         struct rte_mempool     *mp;
 228         rte_mempool_obj_ctor_t *obj_init;
 229         void                   *obj_init_arg;
 230 };
 231
 232 static void
 233 mempool_obj_populate(void *arg, void *start, void *end, uint32_t idx)
 234 {
 235         struct mempool_populate_arg *pa = arg;
 236
 237         mempool_add_elem(pa->mp, start, idx, pa->obj_init, pa->obj_init_arg);
 238         pa->mp->elt_va_end = (uintptr_t)end;
 239 }
 240
 241 static void
 242 mempool_populate(struct rte_mempool *mp, size_t num, size_t align,
 243         rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg)
 244 {
 245         uint32_t elt_sz;
 246         struct mempool_populate_arg arg;
 247
 248         elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
 249         arg.mp = mp;
 250         arg.obj_init = obj_init;
 251         arg.obj_init_arg = obj_init_arg;
 252
 253         mp->size = rte_mempool_obj_iter((void *)mp->elt_va_start,
 254                 num, elt_sz, align,
 255                 mp->elt_pa, mp->pg_num, mp->pg_shift,
 256                 mempool_obj_populate, &arg);
 257 }
 258
 259 /* get the header, trailer and total size of a mempool element. */
 260 uint32_t
 261 rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
 262         struct rte_mempool_objsz *sz)
 263 {
 264         struct rte_mempool_objsz lsz;
 265
 266         sz = (sz != NULL) ? sz : &lsz;
 267
 268         /*
 269          * In header, we have at least the pointer to the pool, and
 270          * optionaly a 64 bits cookie.
 271          */
 272         sz->header_size = 0;
 273         sz->header_size += sizeof(struct rte_mempool *); /* ptr to pool */
 274 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 275         sz->header_size += sizeof(uint64_t); /* cookie */
 276 #endif
 277         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
 278                 sz->header_size = RTE_ALIGN_CEIL(sz->header_size,
 279                         RTE_MEMPOOL_ALIGN);
 280
 281         /* trailer contains the cookie in debug mode */
 282         sz->trailer_size = 0;
 283 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 284         sz->trailer_size += sizeof(uint64_t); /* cookie */
 285 #endif
 286         /* element size is 8 bytes-aligned at least */
 287         sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
 288
 289         /* expand trailer to next cache line */
 290         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
 291                 sz->total_size = sz->header_size + sz->elt_size +
 292                         sz->trailer_size;
 293                 sz->trailer_size += ((RTE_MEMPOOL_ALIGN -
 294                                   (sz->total_size & RTE_MEMPOOL_ALIGN_MASK)) &
 295                                  RTE_MEMPOOL_ALIGN_MASK);
 296         }
 297
 298         /*
 299          * increase trailer to add padding between objects in order to
 300          * spread them across memory channels/ranks
 301          */
 302         if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
 303                 unsigned new_size;
 304                 new_size = optimize_object_size(sz->header_size + sz->elt_size +
 305                         sz->trailer_size);
 306                 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
 307         }
 308
 309         if (! rte_eal_has_hugepages()) {
 310                 /*
 311                  * compute trailer size so that pool elements fit exactly in
 312                  * a standard page
 313                  */
 314                 int page_size = getpagesize();
 315                 int new_size = page_size - sz->header_size - sz->elt_size;
 316                 if (new_size < 0 || (unsigned int)new_size < sz->trailer_size) {
 317                         printf("When hugepages are disabled, pool objects "
 318                                "can't exceed PAGE_SIZE: %d + %d + %d > %d\n",
 319                                sz->header_size, sz->elt_size, sz->trailer_size,
 320                                page_size);
 321                         return 0;
 322                 }
 323                 sz->trailer_size = new_size;
 324         }
 325
 326         /* this is the size of an object, including header and trailer */
 327         sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
 328
 329         return sz->total_size;
 330 }
 331
 332
 333 /*
 334  * Calculate maximum amount of memory required to store given number of objects.
 335  */
 336 size_t
 337 rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift)
 338 {
 339         size_t n, pg_num, pg_sz, sz;
 340
 341         pg_sz = (size_t)1 << pg_shift;
 342
 343         if ((n = pg_sz / total_elt_sz) > 0) {
 344                 pg_num = (elt_num + n - 1) / n;
 345                 sz = pg_num << pg_shift;
 346         } else {
 347                 sz = RTE_ALIGN_CEIL(total_elt_sz, pg_sz) * elt_num;
 348         }
 349
 350         return sz;
 351 }
 352
 353 /* Callback used by rte_mempool_xmem_usage(): it sets the opaque
 354  * argument to the end of the object.
 355  */
 356 static void
 357 mempool_lelem_iter(void *arg, __rte_unused void *start, void *end,
 358         __rte_unused uint32_t idx)
 359 {
 360         *(uintptr_t *)arg = (uintptr_t)end;
 361 }
 362
 363 /*
 364  * Calculate how much memory would be actually required with the
 365  * given memory footprint to store required number of elements.
 366  */
 367 ssize_t
 368 rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num, size_t total_elt_sz,
 369         const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
 370 {
 371         uint32_t n;
 372         uintptr_t va, uv;
 373         size_t pg_sz, usz;
 374
 375         pg_sz = (size_t)1 << pg_shift;
 376         va = (uintptr_t)vaddr;
 377         uv = va;
 378
 379         if ((n = rte_mempool_obj_iter(vaddr, elt_num, total_elt_sz, 1,
 380                         paddr, pg_num, pg_shift, mempool_lelem_iter,
 381                         &uv)) != elt_num) {
 382                 return -(ssize_t)n;
 383         }
 384
 385         uv = RTE_ALIGN_CEIL(uv, pg_sz);
 386         usz = uv - va;
 387         return usz;
 388 }
 389
 390 #ifndef RTE_LIBRTE_XEN_DOM0
 391 /* stub if DOM0 support not configured */
 392 struct rte_mempool *
 393 rte_dom0_mempool_create(const char *name __rte_unused,
 394                         unsigned n __rte_unused,
 395                         unsigned elt_size __rte_unused,
 396                         unsigned cache_size __rte_unused,
 397                         unsigned private_data_size __rte_unused,
 398                         rte_mempool_ctor_t *mp_init __rte_unused,
 399                         void *mp_init_arg __rte_unused,
 400                         rte_mempool_obj_ctor_t *obj_init __rte_unused,
 401                         void *obj_init_arg __rte_unused,
 402                         int socket_id __rte_unused,
 403                         unsigned flags __rte_unused)
 404 {
 405         rte_errno = EINVAL;
 406         return NULL;
 407 }
 408 #endif
 409
 410 /* create the mempool */
 411 struct rte_mempool *
 412 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
 413                    unsigned cache_size, unsigned private_data_size,
 414                    rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 415                    rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
 416                    int socket_id, unsigned flags)
 417 {
 418         if (rte_xen_dom0_supported())
 419                 return rte_dom0_mempool_create(name, n, elt_size,
 420                                                cache_size, private_data_size,
 421                                                mp_init, mp_init_arg,
 422                                                obj_init, obj_init_arg,
 423                                                socket_id, flags);
 424         else
 425                 return rte_mempool_xmem_create(name, n, elt_size,
 426                                                cache_size, private_data_size,
 427                                                mp_init, mp_init_arg,
 428                                                obj_init, obj_init_arg,
 429                                                socket_id, flags,
 430                                                NULL, NULL, MEMPOOL_PG_NUM_DEFAULT,
 431                                                MEMPOOL_PG_SHIFT_MAX);
 432 }
 433
 434 /*
 435  * Create the mempool over already allocated chunk of memory.
 436  * That external memory buffer can consists of physically disjoint pages.
 437  * Setting vaddr to NULL, makes mempool to fallback to original behaviour
 438  * and allocate space for mempool and it's elements as one big chunk of
 439  * physically continuos memory.
 440  * */
 441 struct rte_mempool *
 442 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
 443                 unsigned cache_size, unsigned private_data_size,
 444                 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 445                 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
 446                 int socket_id, unsigned flags, void *vaddr,
 447                 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
 448 {
 449         char mz_name[RTE_MEMZONE_NAMESIZE];
 450         char rg_name[RTE_RING_NAMESIZE];
 451         struct rte_mempool_list *mempool_list;
 452         struct rte_mempool *mp = NULL;
 453         struct rte_tailq_entry *te = NULL;
 454         struct rte_ring *r = NULL;
 455         const struct rte_memzone *mz;
 456         size_t mempool_size;
 457         int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
 458         int rg_flags = 0;
 459         void *obj;
 460         struct rte_mempool_objsz objsz;
 461         void *startaddr;
 462         int page_size = getpagesize();
 463
 464         /* compilation-time checks */
 465         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
 466                           RTE_CACHE_LINE_MASK) != 0);
 467         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
 468                           RTE_CACHE_LINE_MASK) != 0);
 469 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 470         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
 471                           RTE_CACHE_LINE_MASK) != 0);
 472         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
 473                           RTE_CACHE_LINE_MASK) != 0);
 474 #endif
 475
 476         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 477
 478         /* asked cache too big */
 479         if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
 480             CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
 481                 rte_errno = EINVAL;
 482                 return NULL;
 483         }
 484
 485         /* check that we have both VA and PA */
 486         if (vaddr != NULL && paddr == NULL) {
 487                 rte_errno = EINVAL;
 488                 return NULL;
 489         }
 490
 491         /* Check that pg_num and pg_shift parameters are valid. */
 492         if (pg_num < RTE_DIM(mp->elt_pa) || pg_shift > MEMPOOL_PG_SHIFT_MAX) {
 493                 rte_errno = EINVAL;
 494                 return NULL;
 495         }
 496
 497         /* "no cache align" imply "no spread" */
 498         if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
 499                 flags |= MEMPOOL_F_NO_SPREAD;
 500
 501         /* ring flags */
 502         if (flags & MEMPOOL_F_SP_PUT)
 503                 rg_flags |= RING_F_SP_ENQ;
 504         if (flags & MEMPOOL_F_SC_GET)
 505                 rg_flags |= RING_F_SC_DEQ;
 506
 507         /* calculate mempool object sizes. */
 508         if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
 509                 rte_errno = EINVAL;
 510                 return NULL;
 511         }
 512
 513         rte_rwlock_write_lock(RTE_EAL_MEMPOOL_RWLOCK);
 514
 515         /* allocate the ring that will be used to store objects */
 516         /* Ring functions will return appropriate errors if we are
 517          * running as a secondary process etc., so no checks made
 518          * in this function for that condition */
 519         snprintf(rg_name, sizeof(rg_name), RTE_MEMPOOL_MZ_FORMAT, name);
 520         r = rte_ring_create(rg_name, rte_align32pow2(n+1), socket_id, rg_flags);
 521         if (r == NULL)
 522                 goto exit_unlock;
 523
 524         /*
 525          * reserve a memory zone for this mempool: private data is
 526          * cache-aligned
 527          */
 528         private_data_size = (private_data_size +
 529                              RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
 530
 531         if (! rte_eal_has_hugepages()) {
 532                 /*
 533                  * expand private data size to a whole page, so that the
 534                  * first pool element will start on a new standard page
 535                  */
 536                 int head = sizeof(struct rte_mempool);
 537                 int new_size = (private_data_size + head) % page_size;
 538                 if (new_size)
 539                         private_data_size += page_size - new_size;
 540         }
 541
 542         /* try to allocate tailq entry */
 543         te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
 544         if (te == NULL) {
 545                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
 546                 goto exit_unlock;
 547         }
 548
 549         /*
 550          * If user provided an external memory buffer, then use it to
 551          * store mempool objects. Otherwise reserve a memzone that is large
 552          * enough to hold mempool header and metadata plus mempool objects.
 553          */
 554         mempool_size = MEMPOOL_HEADER_SIZE(mp, pg_num, cache_size);
 555         mempool_size += private_data_size;
 556         mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
 557         if (vaddr == NULL)
 558                 mempool_size += (size_t)objsz.total_size * n;
 559
 560         if (! rte_eal_has_hugepages()) {
 561                 /*
 562                  * we want the memory pool to start on a page boundary,
 563                  * because pool elements crossing page boundaries would
 564                  * result in discontiguous physical addresses
 565                  */
 566                 mempool_size += page_size;
 567         }
 568
 569         snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
 570
 571         mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
 572         if (mz == NULL)
 573                 goto exit_unlock;
 574
 575         if (rte_eal_has_hugepages()) {
 576                 startaddr = (void*)mz->addr;
 577         } else {
 578                 /* align memory pool start address on a page boundary */
 579                 unsigned long addr = (unsigned long)mz->addr;
 580                 if (addr & (page_size - 1)) {
 581                         addr += page_size;
 582                         addr &= ~(page_size - 1);
 583                 }
 584                 startaddr = (void*)addr;
 585         }
 586
 587         /* init the mempool structure */
 588         mp = startaddr;
 589         memset(mp, 0, sizeof(*mp));
 590         snprintf(mp->name, sizeof(mp->name), "%s", name);
 591         mp->phys_addr = mz->phys_addr;
 592         mp->ring = r;
 593         mp->size = n;
 594         mp->flags = flags;
 595         mp->elt_size = objsz.elt_size;
 596         mp->header_size = objsz.header_size;
 597         mp->trailer_size = objsz.trailer_size;
 598         mp->cache_size = cache_size;
 599         mp->cache_flushthresh = CALC_CACHE_FLUSHTHRESH(cache_size);
 600         mp->private_data_size = private_data_size;
 601
 602         /*
 603          * local_cache pointer is set even if cache_size is zero.
 604          * The local_cache points to just past the elt_pa[] array.
 605          */
 606         mp->local_cache = (struct rte_mempool_cache *)
 607                 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, pg_num, 0));
 608
 609         /* calculate address of the first element for continuous mempool. */
 610         obj = (char *)mp + MEMPOOL_HEADER_SIZE(mp, pg_num, cache_size) +
 611                 private_data_size;
 612         obj = RTE_PTR_ALIGN_CEIL(obj, RTE_MEMPOOL_ALIGN);
 613
 614         /* populate address translation fields. */
 615         mp->pg_num = pg_num;
 616         mp->pg_shift = pg_shift;
 617         mp->pg_mask = RTE_LEN2MASK(mp->pg_shift, typeof(mp->pg_mask));
 618
 619         /* mempool elements allocated together with mempool */
 620         if (vaddr == NULL) {
 621                 mp->elt_va_start = (uintptr_t)obj;
 622                 mp->elt_pa[0] = mp->phys_addr +
 623                         (mp->elt_va_start - (uintptr_t)mp);
 624         } else {
 625                 /* mempool elements in a separate chunk of memory. */
 626                 mp->elt_va_start = (uintptr_t)vaddr;
 627                 memcpy(mp->elt_pa, paddr, sizeof (mp->elt_pa[0]) * pg_num);
 628         }
 629
 630         mp->elt_va_end = mp->elt_va_start;
 631
 632         /* call the initializer */
 633         if (mp_init)
 634                 mp_init(mp, mp_init_arg);
 635
 636         mempool_populate(mp, n, 1, obj_init, obj_init_arg);
 637
 638         te->data = (void *) mp;
 639
 640         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 641         TAILQ_INSERT_TAIL(mempool_list, te, next);
 642         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 643         rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 644
 645         return mp;
 646
 647 exit_unlock:
 648         rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 649         rte_ring_free(r);
 650         rte_free(te);
 651
 652         return NULL;
 653 }
 654
 655 /* Return the number of entries in the mempool */
 656 unsigned
 657 rte_mempool_count(const struct rte_mempool *mp)
 658 {
 659         unsigned count;
 660         unsigned lcore_id;
 661
 662         count = rte_ring_count(mp->ring);
 663
 664         if (mp->cache_size == 0)
 665                 return count;
 666
 667         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
 668                 count += mp->local_cache[lcore_id].len;
 669
 670         /*
 671          * due to race condition (access to len is not locked), the
 672          * total can be greater than size... so fix the result
 673          */
 674         if (count > mp->size)
 675                 return mp->size;
 676         return count;
 677 }
 678
 679 /* dump the cache status */
 680 static unsigned
 681 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
 682 {
 683         unsigned lcore_id;
 684         unsigned count = 0;
 685         unsigned cache_count;
 686
 687         fprintf(f, "  cache infos:\n");
 688         fprintf(f, "    cache_size=%"PRIu32"\n", mp->cache_size);
 689
 690         if (mp->cache_size == 0)
 691                 return count;
 692
 693         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 694                 cache_count = mp->local_cache[lcore_id].len;
 695                 fprintf(f, "    cache_count[%u]=%u\n", lcore_id, cache_count);
 696                 count += cache_count;
 697         }
 698         fprintf(f, "    total_cache_count=%u\n", count);
 699         return count;
 700 }
 701
 702 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 703 /* check cookies before and after objects */
 704 #ifndef __INTEL_COMPILER
 705 #pragma GCC diagnostic ignored "-Wcast-qual"
 706 #endif
 707
 708 struct mempool_audit_arg {
 709         const struct rte_mempool *mp;
 710         uintptr_t obj_end;
 711         uint32_t obj_num;
 712 };
 713
 714 static void
 715 mempool_obj_audit(void *arg, void *start, void *end, uint32_t idx)
 716 {
 717         struct mempool_audit_arg *pa = arg;
 718         void *obj;
 719
 720         obj = (char *)start + pa->mp->header_size;
 721         pa->obj_end = (uintptr_t)end;
 722         pa->obj_num = idx + 1;
 723         __mempool_check_cookies(pa->mp, &obj, 1, 2);
 724 }
 725
 726 static void
 727 mempool_audit_cookies(const struct rte_mempool *mp)
 728 {
 729         uint32_t elt_sz, num;
 730         struct mempool_audit_arg arg;
 731
 732         elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
 733
 734         arg.mp = mp;
 735         arg.obj_end = mp->elt_va_start;
 736         arg.obj_num = 0;
 737
 738         num = rte_mempool_obj_iter((void *)mp->elt_va_start,
 739                 mp->size, elt_sz, 1,
 740                 mp->elt_pa, mp->pg_num, mp->pg_shift,
 741                 mempool_obj_audit, &arg);
 742
 743         if (num != mp->size) {
 744                         rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
 745                         "iterated only over %u elements\n",
 746                         mp, mp->size, num);
 747         } else if (arg.obj_end != mp->elt_va_end || arg.obj_num != mp->size) {
 748                         rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
 749                         "last callback va_end: %#tx (%#tx expeceted), "
 750                         "num of objects: %u (%u expected)\n",
 751                         mp, mp->size,
 752                         arg.obj_end, mp->elt_va_end,
 753                         arg.obj_num, mp->size);
 754         }
 755 }
 756
 757 #ifndef __INTEL_COMPILER
 758 #pragma GCC diagnostic error "-Wcast-qual"
 759 #endif
 760 #else
 761 #define mempool_audit_cookies(mp) do {} while(0)
 762 #endif
 763
 764 /* check cookies before and after objects */
 765 static void
 766 mempool_audit_cache(const struct rte_mempool *mp)
 767 {
 768         /* check cache size consistency */
 769         unsigned lcore_id;
 770
 771         if (mp->cache_size == 0)
 772                 return;
 773
 774         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 775                 if (mp->local_cache[lcore_id].len > mp->cache_flushthresh) {
 776                         RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
 777                                 lcore_id);
 778                         rte_panic("MEMPOOL: invalid cache len\n");
 779                 }
 780         }
 781 }
 782
 783 /* check the consistency of mempool (size, cookies, ...) */
 784 void
 785 rte_mempool_audit(const struct rte_mempool *mp)
 786 {
 787         mempool_audit_cache(mp);
 788         mempool_audit_cookies(mp);
 789
 790         /* For case where mempool DEBUG is not set, and cache size is 0 */
 791         RTE_SET_USED(mp);
 792 }
 793
 794 /* dump the status of the mempool on the console */
 795 void
 796 rte_mempool_dump(FILE *f, const struct rte_mempool *mp)
 797 {
 798 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 799         struct rte_mempool_debug_stats sum;
 800         unsigned lcore_id;
 801 #endif
 802         unsigned common_count;
 803         unsigned cache_count;
 804
 805         RTE_ASSERT(f != NULL);
 806         RTE_ASSERT(mp != NULL);
 807
 808         fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
 809         fprintf(f, "  flags=%x\n", mp->flags);
 810         fprintf(f, "  ring=<%s>@%p\n", mp->ring->name, mp->ring);
 811         fprintf(f, "  phys_addr=0x%" PRIx64 "\n", mp->phys_addr);
 812         fprintf(f, "  size=%"PRIu32"\n", mp->size);
 813         fprintf(f, "  header_size=%"PRIu32"\n", mp->header_size);
 814         fprintf(f, "  elt_size=%"PRIu32"\n", mp->elt_size);
 815         fprintf(f, "  trailer_size=%"PRIu32"\n", mp->trailer_size);
 816         fprintf(f, "  total_obj_size=%"PRIu32"\n",
 817                mp->header_size + mp->elt_size + mp->trailer_size);
 818
 819         fprintf(f, "  private_data_size=%"PRIu32"\n", mp->private_data_size);
 820         fprintf(f, "  pg_num=%"PRIu32"\n", mp->pg_num);
 821         fprintf(f, "  pg_shift=%"PRIu32"\n", mp->pg_shift);
 822         fprintf(f, "  pg_mask=%#tx\n", mp->pg_mask);
 823         fprintf(f, "  elt_va_start=%#tx\n", mp->elt_va_start);
 824         fprintf(f, "  elt_va_end=%#tx\n", mp->elt_va_end);
 825         fprintf(f, "  elt_pa[0]=0x%" PRIx64 "\n", mp->elt_pa[0]);
 826
 827         if (mp->size != 0)
 828                 fprintf(f, "  avg bytes/object=%#Lf\n",
 829                         (long double)(mp->elt_va_end - mp->elt_va_start) /
 830                         mp->size);
 831
 832         cache_count = rte_mempool_dump_cache(f, mp);
 833         common_count = rte_ring_count(mp->ring);
 834         if ((cache_count + common_count) > mp->size)
 835                 common_count = mp->size - cache_count;
 836         fprintf(f, "  common_pool_count=%u\n", common_count);
 837
 838         /* sum and dump statistics */
 839 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 840         memset(&sum, 0, sizeof(sum));
 841         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 842                 sum.put_bulk += mp->stats[lcore_id].put_bulk;
 843                 sum.put_objs += mp->stats[lcore_id].put_objs;
 844                 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
 845                 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
 846                 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
 847                 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
 848         }
 849         fprintf(f, "  stats:\n");
 850         fprintf(f, "    put_bulk=%"PRIu64"\n", sum.put_bulk);
 851         fprintf(f, "    put_objs=%"PRIu64"\n", sum.put_objs);
 852         fprintf(f, "    get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
 853         fprintf(f, "    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
 854         fprintf(f, "    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
 855         fprintf(f, "    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
 856 #else
 857         fprintf(f, "  no statistics available\n");
 858 #endif
 859
 860         rte_mempool_audit(mp);
 861 }
 862
 863 /* dump the status of all mempools on the console */
 864 void
 865 rte_mempool_list_dump(FILE *f)
 866 {
 867         const struct rte_mempool *mp = NULL;
 868         struct rte_tailq_entry *te;
 869         struct rte_mempool_list *mempool_list;
 870
 871         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 872
 873         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 874
 875         TAILQ_FOREACH(te, mempool_list, next) {
 876                 mp = (struct rte_mempool *) te->data;
 877                 rte_mempool_dump(f, mp);
 878         }
 879
 880         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 881 }
 882
 883 /* search a mempool from its name */
 884 struct rte_mempool *
 885 rte_mempool_lookup(const char *name)
 886 {
 887         struct rte_mempool *mp = NULL;
 888         struct rte_tailq_entry *te;
 889         struct rte_mempool_list *mempool_list;
 890
 891         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 892
 893         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 894
 895         TAILQ_FOREACH(te, mempool_list, next) {
 896                 mp = (struct rte_mempool *) te->data;
 897                 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
 898                         break;
 899         }
 900
 901         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 902
 903         if (te == NULL) {
 904                 rte_errno = ENOENT;
 905                 return NULL;
 906         }
 907
 908         return mp;
 909 }
 910
 911 void rte_mempool_walk(void (*func)(const struct rte_mempool *, void *),
 912                       void *arg)
 913 {
 914         struct rte_tailq_entry *te = NULL;
 915         struct rte_mempool_list *mempool_list;
 916
 917         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 918
 919         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 920
 921         TAILQ_FOREACH(te, mempool_list, next) {
 922                 (*func)((struct rte_mempool *) te->data, arg);
 923         }
 924
 925         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 926 }