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 = 1;
 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_CACHE_LINE_MASK) / RTE_CACHE_LINE_SIZE;
 124         while (get_gcd(new_obj_size, nrank * nchan) != 1)
 125                 new_obj_size++;
 126         return new_obj_size * RTE_CACHE_LINE_SIZE;
 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 **mpp;
 134
 135         obj = (char *)obj + mp->header_size;
 136
 137         /* set mempool ptr in header */
 138         mpp = __mempool_from_obj(obj);
 139         *mpp = mp;
 140
 141 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 142         __mempool_write_header_cookie(obj, 1);
 143         __mempool_write_trailer_cookie(obj);
 144 #endif
 145         /* call the initializer */
 146         if (obj_init)
 147                 obj_init(mp, obj_init_arg, obj, obj_idx);
 148
 149         /* enqueue in ring */
 150         rte_ring_sp_enqueue(mp->ring, obj);
 151 }
 152
 153 uint32_t
 154 rte_mempool_obj_iter(void *vaddr, uint32_t elt_num, size_t elt_sz, size_t align,
 155         const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
 156         rte_mempool_obj_iter_t obj_iter, void *obj_iter_arg)
 157 {
 158         uint32_t i, j, k;
 159         uint32_t pgn;
 160         uintptr_t end, start, va;
 161         uintptr_t pg_sz;
 162
 163         pg_sz = (uintptr_t)1 << pg_shift;
 164         va = (uintptr_t)vaddr;
 165
 166         i = 0;
 167         j = 0;
 168
 169         while (i != elt_num && j != pg_num) {
 170
 171                 start = RTE_ALIGN_CEIL(va, align);
 172                 end = start + elt_sz;
 173
 174                 pgn = (end >> pg_shift) - (start >> pg_shift);
 175                 pgn += j;
 176
 177                 /* do we have enough space left for the next element. */
 178                 if (pgn >= pg_num)
 179                         break;
 180
 181                 for (k = j;
 182                                 k != pgn &&
 183                                 paddr[k] + pg_sz == paddr[k + 1];
 184                                 k++)
 185                         ;
 186
 187                 /*
 188                  * if next pgn chunks of memory physically continuous,
 189                  * use it to create next element.
 190                  * otherwise, just skip that chunk unused.
 191                  */
 192                 if (k == pgn) {
 193                         if (obj_iter != NULL)
 194                                 obj_iter(obj_iter_arg, (void *)start,
 195                                         (void *)end, i);
 196                         va = end;
 197                         j = pgn;
 198                         i++;
 199                 } else {
 200                         va = RTE_ALIGN_CEIL((va + 1), pg_sz);
 201                         j++;
 202                 }
 203         }
 204
 205         return (i);
 206 }
 207
 208 /*
 209  * Populate  mempool with the objects.
 210  */
 211
 212 struct mempool_populate_arg {
 213         struct rte_mempool     *mp;
 214         rte_mempool_obj_ctor_t *obj_init;
 215         void                   *obj_init_arg;
 216 };
 217
 218 static void
 219 mempool_obj_populate(void *arg, void *start, void *end, uint32_t idx)
 220 {
 221         struct mempool_populate_arg *pa = arg;
 222
 223         mempool_add_elem(pa->mp, start, idx, pa->obj_init, pa->obj_init_arg);
 224         pa->mp->elt_va_end = (uintptr_t)end;
 225 }
 226
 227 static void
 228 mempool_populate(struct rte_mempool *mp, size_t num, size_t align,
 229         rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg)
 230 {
 231         uint32_t elt_sz;
 232         struct mempool_populate_arg arg;
 233
 234         elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
 235         arg.mp = mp;
 236         arg.obj_init = obj_init;
 237         arg.obj_init_arg = obj_init_arg;
 238
 239         mp->size = rte_mempool_obj_iter((void *)mp->elt_va_start,
 240                 num, elt_sz, align,
 241                 mp->elt_pa, mp->pg_num, mp->pg_shift,
 242                 mempool_obj_populate, &arg);
 243 }
 244
 245 uint32_t
 246 rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
 247         struct rte_mempool_objsz *sz)
 248 {
 249         struct rte_mempool_objsz lsz;
 250
 251         sz = (sz != NULL) ? sz : &lsz;
 252
 253         /*
 254          * In header, we have at least the pointer to the pool, and
 255          * optionaly a 64 bits cookie.
 256          */
 257         sz->header_size = 0;
 258         sz->header_size += sizeof(struct rte_mempool *); /* ptr to pool */
 259 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 260         sz->header_size += sizeof(uint64_t); /* cookie */
 261 #endif
 262         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
 263                 sz->header_size = RTE_ALIGN_CEIL(sz->header_size,
 264                         RTE_CACHE_LINE_SIZE);
 265
 266         /* trailer contains the cookie in debug mode */
 267         sz->trailer_size = 0;
 268 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 269         sz->trailer_size += sizeof(uint64_t); /* cookie */
 270 #endif
 271         /* element size is 8 bytes-aligned at least */
 272         sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
 273
 274         /* expand trailer to next cache line */
 275         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
 276                 sz->total_size = sz->header_size + sz->elt_size +
 277                         sz->trailer_size;
 278                 sz->trailer_size += ((RTE_CACHE_LINE_SIZE -
 279                                   (sz->total_size & RTE_CACHE_LINE_MASK)) &
 280                                  RTE_CACHE_LINE_MASK);
 281         }
 282
 283         /*
 284          * increase trailer to add padding between objects in order to
 285          * spread them across memory channels/ranks
 286          */
 287         if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
 288                 unsigned new_size;
 289                 new_size = optimize_object_size(sz->header_size + sz->elt_size +
 290                         sz->trailer_size);
 291                 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
 292         }
 293
 294         if (! rte_eal_has_hugepages()) {
 295                 /*
 296                  * compute trailer size so that pool elements fit exactly in
 297                  * a standard page
 298                  */
 299                 int page_size = getpagesize();
 300                 int new_size = page_size - sz->header_size - sz->elt_size;
 301                 if (new_size < 0 || (unsigned int)new_size < sz->trailer_size) {
 302                         printf("When hugepages are disabled, pool objects "
 303                                "can't exceed PAGE_SIZE: %d + %d + %d > %d\n",
 304                                sz->header_size, sz->elt_size, sz->trailer_size,
 305                                page_size);
 306                         return 0;
 307                 }
 308                 sz->trailer_size = new_size;
 309         }
 310
 311         /* this is the size of an object, including header and trailer */
 312         sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
 313
 314         return (sz->total_size);
 315 }
 316
 317
 318 /*
 319  * Calculate maximum amount of memory required to store given number of objects.
 320  */
 321 size_t
 322 rte_mempool_xmem_size(uint32_t elt_num, size_t elt_sz, uint32_t pg_shift)
 323 {
 324         size_t n, pg_num, pg_sz, sz;
 325
 326         pg_sz = (size_t)1 << pg_shift;
 327
 328         if ((n = pg_sz / elt_sz) > 0) {
 329                 pg_num = (elt_num + n - 1) / n;
 330                 sz = pg_num << pg_shift;
 331         } else {
 332                 sz = RTE_ALIGN_CEIL(elt_sz, pg_sz) * elt_num;
 333         }
 334
 335         return (sz);
 336 }
 337
 338 /*
 339  * Calculate how much memory would be actually required with the
 340  * given memory footprint to store required number of elements.
 341  */
 342 static void
 343 mempool_lelem_iter(void *arg, __rte_unused void *start, void *end,
 344         __rte_unused uint32_t idx)
 345 {
 346         *(uintptr_t *)arg = (uintptr_t)end;
 347 }
 348
 349 ssize_t
 350 rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num, size_t elt_sz,
 351         const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
 352 {
 353         uint32_t n;
 354         uintptr_t va, uv;
 355         size_t pg_sz, usz;
 356
 357         pg_sz = (size_t)1 << pg_shift;
 358         va = (uintptr_t)vaddr;
 359         uv = va;
 360
 361         if ((n = rte_mempool_obj_iter(vaddr, elt_num, elt_sz, 1,
 362                         paddr, pg_num, pg_shift, mempool_lelem_iter,
 363                         &uv)) != elt_num) {
 364                 return (-(ssize_t)n);
 365         }
 366
 367         uv = RTE_ALIGN_CEIL(uv, pg_sz);
 368         usz = uv - va;
 369         return (usz);
 370 }
 371
 372 /* create the mempool */
 373 struct rte_mempool *
 374 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
 375                    unsigned cache_size, unsigned private_data_size,
 376                    rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 377                    rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
 378                    int socket_id, unsigned flags)
 379 {
 380 #ifdef RTE_LIBRTE_XEN_DOM0
 381         return (rte_dom0_mempool_create(name, n, elt_size,
 382                 cache_size, private_data_size,
 383                 mp_init, mp_init_arg,
 384                 obj_init, obj_init_arg,
 385                 socket_id, flags));
 386 #else
 387         return (rte_mempool_xmem_create(name, n, elt_size,
 388                 cache_size, private_data_size,
 389                 mp_init, mp_init_arg,
 390                 obj_init, obj_init_arg,
 391                 socket_id, flags,
 392                 NULL, NULL, MEMPOOL_PG_NUM_DEFAULT, MEMPOOL_PG_SHIFT_MAX));
 393 #endif
 394 }
 395
 396 /*
 397  * Create the mempool over already allocated chunk of memory.
 398  * That external memory buffer can consists of physically disjoint pages.
 399  * Setting vaddr to NULL, makes mempool to fallback to original behaviour
 400  * and allocate space for mempool and it's elements as one big chunk of
 401  * physically continuos memory.
 402  * */
 403 struct rte_mempool *
 404 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
 405                 unsigned cache_size, unsigned private_data_size,
 406                 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 407                 rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
 408                 int socket_id, unsigned flags, void *vaddr,
 409                 const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift)
 410 {
 411         char mz_name[RTE_MEMZONE_NAMESIZE];
 412         char rg_name[RTE_RING_NAMESIZE];
 413         struct rte_mempool_list *mempool_list;
 414         struct rte_mempool *mp = NULL;
 415         struct rte_tailq_entry *te;
 416         struct rte_ring *r;
 417         const struct rte_memzone *mz;
 418         size_t mempool_size;
 419         int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
 420         int rg_flags = 0;
 421         void *obj;
 422         struct rte_mempool_objsz objsz;
 423         void *startaddr;
 424         int page_size = getpagesize();
 425
 426         /* compilation-time checks */
 427         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
 428                           RTE_CACHE_LINE_MASK) != 0);
 429 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 430         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
 431                           RTE_CACHE_LINE_MASK) != 0);
 432         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, local_cache) &
 433                           RTE_CACHE_LINE_MASK) != 0);
 434 #endif
 435 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 436         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
 437                           RTE_CACHE_LINE_MASK) != 0);
 438         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
 439                           RTE_CACHE_LINE_MASK) != 0);
 440 #endif
 441
 442         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 443
 444         /* asked cache too big */
 445         if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
 446             CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
 447                 rte_errno = EINVAL;
 448                 return NULL;
 449         }
 450
 451         /* check that we have both VA and PA */
 452         if (vaddr != NULL && paddr == NULL) {
 453                 rte_errno = EINVAL;
 454                 return NULL;
 455         }
 456
 457         /* Check that pg_num and pg_shift parameters are valid. */
 458         if (pg_num < RTE_DIM(mp->elt_pa) || pg_shift > MEMPOOL_PG_SHIFT_MAX) {
 459                 rte_errno = EINVAL;
 460                 return NULL;
 461         }
 462
 463         /* "no cache align" imply "no spread" */
 464         if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
 465                 flags |= MEMPOOL_F_NO_SPREAD;
 466
 467         /* ring flags */
 468         if (flags & MEMPOOL_F_SP_PUT)
 469                 rg_flags |= RING_F_SP_ENQ;
 470         if (flags & MEMPOOL_F_SC_GET)
 471                 rg_flags |= RING_F_SC_DEQ;
 472
 473         /* calculate mempool object sizes. */
 474         if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
 475                 rte_errno = EINVAL;
 476                 return NULL;
 477         }
 478
 479         rte_rwlock_write_lock(RTE_EAL_MEMPOOL_RWLOCK);
 480
 481         /* allocate the ring that will be used to store objects */
 482         /* Ring functions will return appropriate errors if we are
 483          * running as a secondary process etc., so no checks made
 484          * in this function for that condition */
 485         snprintf(rg_name, sizeof(rg_name), RTE_MEMPOOL_MZ_FORMAT, name);
 486         r = rte_ring_create(rg_name, rte_align32pow2(n+1), socket_id, rg_flags);
 487         if (r == NULL)
 488                 goto exit;
 489
 490         /*
 491          * reserve a memory zone for this mempool: private data is
 492          * cache-aligned
 493          */
 494         private_data_size = (private_data_size +
 495                              RTE_CACHE_LINE_MASK) & (~RTE_CACHE_LINE_MASK);
 496
 497         if (! rte_eal_has_hugepages()) {
 498                 /*
 499                  * expand private data size to a whole page, so that the
 500                  * first pool element will start on a new standard page
 501                  */
 502                 int head = sizeof(struct rte_mempool);
 503                 int new_size = (private_data_size + head) % page_size;
 504                 if (new_size) {
 505                         private_data_size += page_size - new_size;
 506                 }
 507         }
 508
 509         /* try to allocate tailq entry */
 510         te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
 511         if (te == NULL) {
 512                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
 513                 goto exit;
 514         }
 515
 516         /*
 517          * If user provided an external memory buffer, then use it to
 518          * store mempool objects. Otherwise reserve memzone big enough to
 519          * hold mempool header and metadata plus mempool objects.
 520          */
 521         mempool_size = MEMPOOL_HEADER_SIZE(mp, pg_num) + private_data_size;
 522         if (vaddr == NULL)
 523                 mempool_size += (size_t)objsz.total_size * n;
 524
 525         if (! rte_eal_has_hugepages()) {
 526                 /*
 527                  * we want the memory pool to start on a page boundary,
 528                  * because pool elements crossing page boundaries would
 529                  * result in discontiguous physical addresses
 530                  */
 531                 mempool_size += page_size;
 532         }
 533
 534         snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
 535
 536         mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
 537
 538         /*
 539          * no more memory: in this case we loose previously reserved
 540          * space for the as we cannot free it
 541          */
 542         if (mz == NULL) {
 543                 rte_free(te);
 544                 goto exit;
 545         }
 546
 547         if (rte_eal_has_hugepages()) {
 548                 startaddr = (void*)mz->addr;
 549         } else {
 550                 /* align memory pool start address on a page boundary */
 551                 unsigned long addr = (unsigned long)mz->addr;
 552                 if (addr & (page_size - 1)) {
 553                         addr += page_size;
 554                         addr &= ~(page_size - 1);
 555                 }
 556                 startaddr = (void*)addr;
 557         }
 558
 559         /* init the mempool structure */
 560         mp = startaddr;
 561         memset(mp, 0, sizeof(*mp));
 562         snprintf(mp->name, sizeof(mp->name), "%s", name);
 563         mp->phys_addr = mz->phys_addr;
 564         mp->ring = r;
 565         mp->size = n;
 566         mp->flags = flags;
 567         mp->elt_size = objsz.elt_size;
 568         mp->header_size = objsz.header_size;
 569         mp->trailer_size = objsz.trailer_size;
 570         mp->cache_size = cache_size;
 571         mp->cache_flushthresh = CALC_CACHE_FLUSHTHRESH(cache_size);
 572         mp->private_data_size = private_data_size;
 573
 574         /* calculate address of the first element for continuous mempool. */
 575         obj = (char *)mp + MEMPOOL_HEADER_SIZE(mp, pg_num) +
 576                 private_data_size;
 577
 578         /* populate address translation fields. */
 579         mp->pg_num = pg_num;
 580         mp->pg_shift = pg_shift;
 581         mp->pg_mask = RTE_LEN2MASK(mp->pg_shift, typeof(mp->pg_mask));
 582
 583         /* mempool elements allocated together with mempool */
 584         if (vaddr == NULL) {
 585                 mp->elt_va_start = (uintptr_t)obj;
 586                 mp->elt_pa[0] = mp->phys_addr +
 587                         (mp->elt_va_start - (uintptr_t)mp);
 588
 589         /* mempool elements in a separate chunk of memory. */
 590         } else {
 591                 mp->elt_va_start = (uintptr_t)vaddr;
 592                 memcpy(mp->elt_pa, paddr, sizeof (mp->elt_pa[0]) * pg_num);
 593         }
 594
 595         mp->elt_va_end = mp->elt_va_start;
 596
 597         /* call the initializer */
 598         if (mp_init)
 599                 mp_init(mp, mp_init_arg);
 600
 601         mempool_populate(mp, n, 1, obj_init, obj_init_arg);
 602
 603         te->data = (void *) mp;
 604
 605         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 606         TAILQ_INSERT_TAIL(mempool_list, te, next);
 607         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 608
 609 exit:
 610         rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 611
 612         return mp;
 613 }
 614
 615 /* Return the number of entries in the mempool */
 616 unsigned
 617 rte_mempool_count(const struct rte_mempool *mp)
 618 {
 619         unsigned count;
 620
 621         count = rte_ring_count(mp->ring);
 622
 623 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 624         {
 625                 unsigned lcore_id;
 626                 if (mp->cache_size == 0)
 627                         return count;
 628
 629                 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
 630                         count += mp->local_cache[lcore_id].len;
 631         }
 632 #endif
 633
 634         /*
 635          * due to race condition (access to len is not locked), the
 636          * total can be greater than size... so fix the result
 637          */
 638         if (count > mp->size)
 639                 return mp->size;
 640         return count;
 641 }
 642
 643 /* dump the cache status */
 644 static unsigned
 645 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
 646 {
 647 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 648         unsigned lcore_id;
 649         unsigned count = 0;
 650         unsigned cache_count;
 651
 652         fprintf(f, "  cache infos:\n");
 653         fprintf(f, "    cache_size=%"PRIu32"\n", mp->cache_size);
 654         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 655                 cache_count = mp->local_cache[lcore_id].len;
 656                 fprintf(f, "    cache_count[%u]=%u\n", lcore_id, cache_count);
 657                 count += cache_count;
 658         }
 659         fprintf(f, "    total_cache_count=%u\n", count);
 660         return count;
 661 #else
 662         RTE_SET_USED(mp);
 663         fprintf(f, "  cache disabled\n");
 664         return 0;
 665 #endif
 666 }
 667
 668 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 669 /* check cookies before and after objects */
 670 #ifndef __INTEL_COMPILER
 671 #pragma GCC diagnostic ignored "-Wcast-qual"
 672 #endif
 673
 674 struct mempool_audit_arg {
 675         const struct rte_mempool *mp;
 676         uintptr_t obj_end;
 677         uint32_t obj_num;
 678 };
 679
 680 static void
 681 mempool_obj_audit(void *arg, void *start, void *end, uint32_t idx)
 682 {
 683         struct mempool_audit_arg *pa = arg;
 684         void *obj;
 685
 686         obj = (char *)start + pa->mp->header_size;
 687         pa->obj_end = (uintptr_t)end;
 688         pa->obj_num = idx + 1;
 689         __mempool_check_cookies(pa->mp, &obj, 1, 2);
 690 }
 691
 692 static void
 693 mempool_audit_cookies(const struct rte_mempool *mp)
 694 {
 695         uint32_t elt_sz, num;
 696         struct mempool_audit_arg arg;
 697
 698         elt_sz = mp->elt_size + mp->header_size + mp->trailer_size;
 699
 700         arg.mp = mp;
 701         arg.obj_end = mp->elt_va_start;
 702         arg.obj_num = 0;
 703
 704         num = rte_mempool_obj_iter((void *)mp->elt_va_start,
 705                 mp->size, elt_sz, 1,
 706                 mp->elt_pa, mp->pg_num, mp->pg_shift,
 707                 mempool_obj_audit, &arg);
 708
 709         if (num != mp->size) {
 710                         rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
 711                         "iterated only over %u elements\n",
 712                         mp, mp->size, num);
 713         } else if (arg.obj_end != mp->elt_va_end || arg.obj_num != mp->size) {
 714                         rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
 715                         "last callback va_end: %#tx (%#tx expeceted), "
 716                         "num of objects: %u (%u expected)\n",
 717                         mp, mp->size,
 718                         arg.obj_end, mp->elt_va_end,
 719                         arg.obj_num, mp->size);
 720         }
 721 }
 722
 723 #ifndef __INTEL_COMPILER
 724 #pragma GCC diagnostic error "-Wcast-qual"
 725 #endif
 726 #else
 727 #define mempool_audit_cookies(mp) do {} while(0)
 728 #endif
 729
 730 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 731 /* check cookies before and after objects */
 732 static void
 733 mempool_audit_cache(const struct rte_mempool *mp)
 734 {
 735         /* check cache size consistency */
 736         unsigned lcore_id;
 737         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 738                 if (mp->local_cache[lcore_id].len > mp->cache_flushthresh) {
 739                         RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
 740                                 lcore_id);
 741                         rte_panic("MEMPOOL: invalid cache len\n");
 742                 }
 743         }
 744 }
 745 #else
 746 #define mempool_audit_cache(mp) do {} while(0)
 747 #endif
 748
 749
 750 /* check the consistency of mempool (size, cookies, ...) */
 751 void
 752 rte_mempool_audit(const struct rte_mempool *mp)
 753 {
 754         mempool_audit_cache(mp);
 755         mempool_audit_cookies(mp);
 756
 757         /* For case where mempool DEBUG is not set, and cache size is 0 */
 758         RTE_SET_USED(mp);
 759 }
 760
 761 /* dump the status of the mempool on the console */
 762 void
 763 rte_mempool_dump(FILE *f, const struct rte_mempool *mp)
 764 {
 765 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 766         struct rte_mempool_debug_stats sum;
 767         unsigned lcore_id;
 768 #endif
 769         unsigned common_count;
 770         unsigned cache_count;
 771
 772         RTE_VERIFY(f != NULL);
 773         RTE_VERIFY(mp != NULL);
 774
 775         fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
 776         fprintf(f, "  flags=%x\n", mp->flags);
 777         fprintf(f, "  ring=<%s>@%p\n", mp->ring->name, mp->ring);
 778         fprintf(f, "  phys_addr=0x%" PRIx64 "\n", mp->phys_addr);
 779         fprintf(f, "  size=%"PRIu32"\n", mp->size);
 780         fprintf(f, "  header_size=%"PRIu32"\n", mp->header_size);
 781         fprintf(f, "  elt_size=%"PRIu32"\n", mp->elt_size);
 782         fprintf(f, "  trailer_size=%"PRIu32"\n", mp->trailer_size);
 783         fprintf(f, "  total_obj_size=%"PRIu32"\n",
 784                mp->header_size + mp->elt_size + mp->trailer_size);
 785
 786         fprintf(f, "  private_data_size=%"PRIu32"\n", mp->private_data_size);
 787         fprintf(f, "  pg_num=%"PRIu32"\n", mp->pg_num);
 788         fprintf(f, "  pg_shift=%"PRIu32"\n", mp->pg_shift);
 789         fprintf(f, "  pg_mask=%#tx\n", mp->pg_mask);
 790         fprintf(f, "  elt_va_start=%#tx\n", mp->elt_va_start);
 791         fprintf(f, "  elt_va_end=%#tx\n", mp->elt_va_end);
 792         fprintf(f, "  elt_pa[0]=0x%" PRIx64 "\n", mp->elt_pa[0]);
 793
 794         if (mp->size != 0)
 795                 fprintf(f, "  avg bytes/object=%#Lf\n",
 796                         (long double)(mp->elt_va_end - mp->elt_va_start) /
 797                         mp->size);
 798
 799         cache_count = rte_mempool_dump_cache(f, mp);
 800         common_count = rte_ring_count(mp->ring);
 801         if ((cache_count + common_count) > mp->size)
 802                 common_count = mp->size - cache_count;
 803         fprintf(f, "  common_pool_count=%u\n", common_count);
 804
 805         /* sum and dump statistics */
 806 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 807         memset(&sum, 0, sizeof(sum));
 808         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 809                 sum.put_bulk += mp->stats[lcore_id].put_bulk;
 810                 sum.put_objs += mp->stats[lcore_id].put_objs;
 811                 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
 812                 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
 813                 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
 814                 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
 815         }
 816         fprintf(f, "  stats:\n");
 817         fprintf(f, "    put_bulk=%"PRIu64"\n", sum.put_bulk);
 818         fprintf(f, "    put_objs=%"PRIu64"\n", sum.put_objs);
 819         fprintf(f, "    get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
 820         fprintf(f, "    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
 821         fprintf(f, "    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
 822         fprintf(f, "    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
 823 #else
 824         fprintf(f, "  no statistics available\n");
 825 #endif
 826
 827         rte_mempool_audit(mp);
 828 }
 829
 830 /* dump the status of all mempools on the console */
 831 void
 832 rte_mempool_list_dump(FILE *f)
 833 {
 834         const struct rte_mempool *mp = NULL;
 835         struct rte_tailq_entry *te;
 836         struct rte_mempool_list *mempool_list;
 837
 838         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 839
 840         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 841
 842         TAILQ_FOREACH(te, mempool_list, next) {
 843                 mp = (struct rte_mempool *) te->data;
 844                 rte_mempool_dump(f, mp);
 845         }
 846
 847         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 848 }
 849
 850 /* search a mempool from its name */
 851 struct rte_mempool *
 852 rte_mempool_lookup(const char *name)
 853 {
 854         struct rte_mempool *mp = NULL;
 855         struct rte_tailq_entry *te;
 856         struct rte_mempool_list *mempool_list;
 857
 858         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 859
 860         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 861
 862         TAILQ_FOREACH(te, mempool_list, next) {
 863                 mp = (struct rte_mempool *) te->data;
 864                 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
 865                         break;
 866         }
 867
 868         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 869
 870         if (te == NULL) {
 871                 rte_errno = ENOENT;
 872                 return NULL;
 873         }
 874
 875         return mp;
 876 }
 877
 878 void rte_mempool_walk(void (*func)(const struct rte_mempool *, void *),
 879                       void *arg)
 880 {
 881         struct rte_tailq_entry *te = NULL;
 882         struct rte_mempool_list *mempool_list;
 883
 884         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
 885
 886         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 887
 888         TAILQ_FOREACH(te, mempool_list, next) {
 889                 (*func)((struct rte_mempool *) te->data, arg);
 890         }
 891
 892         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 893 }