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