lib/librte_mempool/rte_mempool.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <stdint.h>
  38 #include <stdarg.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_atomic.h>
  49 #include <rte_launch.h>
  50 #include <rte_tailq.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_mempool);
  64
  65 #define CACHE_FLUSHTHRESH_MULTIPLIER 1.5
  66
  67 /*
  68  * return the greatest common divisor between a and b (fast algorithm)
  69  *
  70  */
  71 static unsigned get_gcd(unsigned a, unsigned b)
  72 {
  73         unsigned c;
  74
  75         if (0 == a)
  76                 return b;
  77         if (0 == b)
  78                 return a;
  79
  80         if (a < b) {
  81                 c = a;
  82                 a = b;
  83                 b = c;
  84         }
  85
  86         while (b != 0) {
  87                 c = a % b;
  88                 a = b;
  89                 b = c;
  90         }
  91
  92         return a;
  93 }
  94
  95 /*
  96  * Depending on memory configuration, objects addresses are spreaded
  97  * between channels and ranks in RAM: the pool allocator will add
  98  * padding between objects. This function return the new size of the
  99  * object.
 100  */
 101 static unsigned optimize_object_size(unsigned obj_size)
 102 {
 103         unsigned nrank, nchan;
 104         unsigned new_obj_size;
 105
 106         /* get number of channels */
 107         nchan = rte_memory_get_nchannel();
 108         if (nchan == 0)
 109                 nchan = 1;
 110
 111         nrank = rte_memory_get_nrank();
 112         if (nrank == 0)
 113                 nrank = 1;
 114
 115         /* process new object size */
 116         new_obj_size = (obj_size + CACHE_LINE_MASK) / CACHE_LINE_SIZE;
 117         while (get_gcd(new_obj_size, nrank * nchan) != 1 ||
 118                         get_gcd(nchan, new_obj_size) != 1)
 119                 new_obj_size++;
 120         return new_obj_size * CACHE_LINE_SIZE;
 121 }
 122
 123 /* create the mempool */
 124 struct rte_mempool *
 125 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
 126                    unsigned cache_size, unsigned private_data_size,
 127                    rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 128                    rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
 129                    int socket_id, unsigned flags)
 130 {
 131         char mz_name[RTE_MEMZONE_NAMESIZE];
 132         char rg_name[RTE_RING_NAMESIZE];
 133         struct rte_mempool *mp = NULL;
 134         struct rte_ring *r;
 135         const struct rte_memzone *mz;
 136         uint64_t mempool_size, total_elt_size;
 137         int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
 138         int rg_flags = 0;
 139         uint32_t header_size, trailer_size;
 140         unsigned i;
 141         void *obj;
 142
 143         /* compilation-time checks */
 144         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
 145                           CACHE_LINE_MASK) != 0);
 146 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 147         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
 148                           CACHE_LINE_MASK) != 0);
 149         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, local_cache) &
 150                           CACHE_LINE_MASK) != 0);
 151 #endif
 152 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 153         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
 154                           CACHE_LINE_MASK) != 0);
 155         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
 156                           CACHE_LINE_MASK) != 0);
 157 #endif
 158
 159         /* check that we have an initialised tail queue */
 160         if (RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_MEMPOOL, rte_mempool_list) == NULL) {
 161                 rte_errno = E_RTE_NO_TAILQ;
 162                 return NULL;
 163         }
 164
 165         /* asked cache too big */
 166         if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE){
 167                 rte_errno = EINVAL;
 168                 return NULL;
 169         }
 170
 171         /* "no cache align" imply "no spread" */
 172         if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
 173                 flags |= MEMPOOL_F_NO_SPREAD;
 174
 175         /* ring flags */
 176         if (flags & MEMPOOL_F_SP_PUT)
 177                 rg_flags |= RING_F_SP_ENQ;
 178         if (flags & MEMPOOL_F_SC_GET)
 179                 rg_flags |= RING_F_SC_DEQ;
 180
 181         rte_rwlock_write_lock(RTE_EAL_MEMPOOL_RWLOCK);
 182
 183         /* allocate the ring that will be used to store objects */
 184         /* Ring functions will return appropriate errors if we are
 185          * running as a secondary process etc., so no checks made
 186          * in this function for that condition */
 187         rte_snprintf(rg_name, sizeof(rg_name), "MP_%s", name);
 188         r = rte_ring_create(rg_name, rte_align32pow2(n+1), socket_id, rg_flags);
 189         if (r == NULL)
 190                 goto exit;
 191
 192         /*
 193          * In header, we have at least the pointer to the pool, and
 194          * optionaly a 64 bits cookie.
 195          */
 196         header_size = 0;
 197         header_size += sizeof(struct rte_mempool *); /* ptr to pool */
 198 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 199         header_size += sizeof(uint64_t); /* cookie */
 200 #endif
 201         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
 202                 header_size = (header_size + CACHE_LINE_MASK) & (~CACHE_LINE_MASK);
 203
 204         /* trailer contains the cookie in debug mode */
 205         trailer_size = 0;
 206 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 207         trailer_size += sizeof(uint64_t); /* cookie */
 208 #endif
 209         /* element size is 8 bytes-aligned at least */
 210         elt_size = (elt_size + 7) & (~7);
 211
 212         /* expand trailer to next cache line */
 213         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
 214                 total_elt_size = header_size + elt_size + trailer_size;
 215                 trailer_size += ((CACHE_LINE_SIZE -
 216                                   (total_elt_size & CACHE_LINE_MASK)) &
 217                                  CACHE_LINE_MASK);
 218         }
 219
 220         /*
 221          * increase trailer to add padding between objects in order to
 222          * spread them accross memory channels/ranks
 223          */
 224         if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
 225                 unsigned new_size;
 226                 new_size = optimize_object_size(header_size + elt_size +
 227                                                 trailer_size);
 228                 trailer_size = new_size - header_size - elt_size;
 229         }
 230
 231         /* this is the size of an object, including header and trailer */
 232         total_elt_size = header_size + elt_size + trailer_size;
 233
 234         /* reserve a memory zone for this mempool: private data is
 235          * cache-aligned */
 236         private_data_size = (private_data_size +
 237                              CACHE_LINE_MASK) & (~CACHE_LINE_MASK);
 238         mempool_size = total_elt_size * n +
 239                 sizeof(struct rte_mempool) + private_data_size;
 240         rte_snprintf(mz_name, sizeof(mz_name), "MP_%s", name);
 241
 242         mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
 243
 244         /*
 245          * no more memory: in this case we loose previously reserved
 246          * space for the as we cannot free it
 247          */
 248         if (mz == NULL)
 249                 goto exit;
 250
 251         /* init the mempool structure */
 252         mp = mz->addr;
 253         memset(mp, 0, sizeof(*mp));
 254         rte_snprintf(mp->name, sizeof(mp->name), "%s", name);
 255         mp->phys_addr = mz->phys_addr;
 256         mp->ring = r;
 257         mp->size = n;
 258         mp->flags = flags;
 259         mp->elt_size = elt_size;
 260         mp->header_size = header_size;
 261         mp->trailer_size = trailer_size;
 262         mp->cache_size = cache_size;
 263         mp->cache_flushthresh = (uint32_t)(cache_size * CACHE_FLUSHTHRESH_MULTIPLIER);
 264         mp->private_data_size = private_data_size;
 265
 266         /* call the initializer */
 267         if (mp_init)
 268                 mp_init(mp, mp_init_arg);
 269
 270         /* fill the headers and trailers, and add objects in ring */
 271         obj = (char *)mp + sizeof(struct rte_mempool) + private_data_size;
 272         for (i = 0; i < n; i++) {
 273                 struct rte_mempool **mpp;
 274                 obj = (char *)obj + header_size;
 275
 276                 /* set mempool ptr in header */
 277                 mpp = __mempool_from_obj(obj);
 278                 *mpp = mp;
 279
 280 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 281                 __mempool_write_header_cookie(obj, 1);
 282                 __mempool_write_trailer_cookie(obj);
 283 #endif
 284                 /* call the initializer */
 285                 if (obj_init)
 286                         obj_init(mp, obj_init_arg, obj, i);
 287
 288                 /* enqueue in ring */
 289                 rte_ring_sp_enqueue(mp->ring, obj);
 290                 obj = (char *)obj + elt_size + trailer_size;
 291         }
 292
 293         RTE_EAL_TAILQ_INSERT_TAIL(RTE_TAILQ_MEMPOOL, rte_mempool_list, mp);
 294
 295 exit:
 296         rte_rwlock_write_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 297
 298         return mp;
 299 }
 300
 301 /* Return the number of entries in the mempool */
 302 unsigned
 303 rte_mempool_count(const struct rte_mempool *mp)
 304 {
 305         unsigned count;
 306
 307         count = rte_ring_count(mp->ring);
 308
 309 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 310         {
 311                 unsigned lcore_id;
 312                 if (mp->cache_size == 0)
 313                         return count;
 314
 315                 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
 316                         count += mp->local_cache[lcore_id].len;
 317         }
 318 #endif
 319
 320         /*
 321          * due to race condition (access to len is not locked), the
 322          * total can be greater than size... so fix the result
 323          */
 324         if (count > mp->size)
 325                 return mp->size;
 326         return count;
 327 }
 328
 329 /* dump the cache status */
 330 static unsigned
 331 rte_mempool_dump_cache(const struct rte_mempool *mp)
 332 {
 333 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 334         unsigned lcore_id;
 335         unsigned count = 0;
 336         unsigned cache_count;
 337
 338         printf("  cache infos:\n");
 339         printf("    cache_size=%"PRIu32"\n", mp->cache_size);
 340         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 341                 cache_count = mp->local_cache[lcore_id].len;
 342                 printf("    cache_count[%u]=%u\n", lcore_id, cache_count);
 343                 count += cache_count;
 344         }
 345         printf("    total_cache_count=%u\n", count);
 346         return count;
 347 #else
 348         RTE_SET_USED(mp);
 349         printf("  cache disabled\n");
 350         return 0;
 351 #endif
 352 }
 353
 354 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 355 /* check cookies before and after objects */
 356 #ifndef __INTEL_COMPILER
 357 #pragma GCC diagnostic ignored "-Wcast-qual"
 358 #endif
 359 static void
 360 mempool_audit_cookies(const struct rte_mempool *mp)
 361 {
 362         unsigned i;
 363         void *obj;
 364         void * const *obj_table;
 365
 366         obj = (char *)mp + sizeof(struct rte_mempool) + mp->private_data_size;
 367         for (i = 0; i < mp->size; i++) {
 368                 obj = (char *)obj + mp->header_size;
 369                 obj_table = &obj;
 370                 __mempool_check_cookies(mp, obj_table, 1, 2);
 371                 obj = (char *)obj + mp->elt_size + mp->trailer_size;
 372         }
 373 }
 374 #ifndef __INTEL_COMPILER
 375 #pragma GCC diagnostic error "-Wcast-qual"
 376 #endif
 377 #else
 378 #define mempool_audit_cookies(mp) do {} while(0)
 379 #endif
 380
 381 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 382 /* check cookies before and after objects */
 383 static void
 384 mempool_audit_cache(const struct rte_mempool *mp)
 385 {
 386         /* check cache size consistency */
 387         unsigned lcore_id;
 388         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 389                 if (mp->local_cache[lcore_id].len > mp->cache_flushthresh) {
 390                         RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
 391                                 lcore_id);
 392                         rte_panic("MEMPOOL: invalid cache len\n");
 393                 }
 394         }
 395 }
 396 #else
 397 #define mempool_audit_cache(mp) do {} while(0)
 398 #endif
 399
 400
 401 /* check the consistency of mempool (size, cookies, ...) */
 402 void
 403 rte_mempool_audit(const struct rte_mempool *mp)
 404 {
 405         mempool_audit_cache(mp);
 406         mempool_audit_cookies(mp);
 407
 408         /* For case where mempool DEBUG is not set, and cache size is 0 */
 409         RTE_SET_USED(mp);
 410 }
 411
 412 /* dump the status of the mempool on the console */
 413 void
 414 rte_mempool_dump(const struct rte_mempool *mp)
 415 {
 416 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 417         struct rte_mempool_debug_stats sum;
 418         unsigned lcore_id;
 419 #endif
 420         unsigned common_count;
 421         unsigned cache_count;
 422
 423         printf("mempool <%s>@%p\n", mp->name, mp);
 424         printf("  flags=%x\n", mp->flags);
 425         printf("  ring=<%s>@%p\n", mp->ring->name, mp->ring);
 426         printf("  size=%"PRIu32"\n", mp->size);
 427         printf("  header_size=%"PRIu32"\n", mp->header_size);
 428         printf("  elt_size=%"PRIu32"\n", mp->elt_size);
 429         printf("  trailer_size=%"PRIu32"\n", mp->trailer_size);
 430         printf("  total_obj_size=%"PRIu32"\n",
 431                mp->header_size + mp->elt_size + mp->trailer_size);
 432
 433         cache_count = rte_mempool_dump_cache(mp);
 434         common_count = rte_ring_count(mp->ring);
 435         if ((cache_count + common_count) > mp->size)
 436                 common_count = mp->size - cache_count;
 437         printf("  common_pool_count=%u\n", common_count);
 438
 439         /* sum and dump statistics */
 440 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 441         memset(&sum, 0, sizeof(sum));
 442         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 443                 sum.put_bulk += mp->stats[lcore_id].put_bulk;
 444                 sum.put_objs += mp->stats[lcore_id].put_objs;
 445                 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
 446                 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
 447                 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
 448                 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
 449         }
 450         printf("  stats:\n");
 451         printf("    put_bulk=%"PRIu64"\n", sum.put_bulk);
 452         printf("    put_objs=%"PRIu64"\n", sum.put_objs);
 453         printf("    get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
 454         printf("    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
 455         printf("    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
 456         printf("    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
 457 #else
 458         printf("  no statistics available\n");
 459 #endif
 460
 461         rte_mempool_audit(mp);
 462 }
 463
 464 /* dump the status of all mempools on the console */
 465 void
 466 rte_mempool_list_dump(void)
 467 {
 468         const struct rte_mempool *mp = NULL;
 469         struct rte_mempool_list *mempool_list;
 470
 471         if ((mempool_list =
 472              RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_MEMPOOL, rte_mempool_list)) == NULL) {
 473                 rte_errno = E_RTE_NO_TAILQ;
 474                 return;
 475         }
 476
 477         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 478
 479         TAILQ_FOREACH(mp, mempool_list, next) {
 480                 rte_mempool_dump(mp);
 481         }
 482
 483         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 484 }
 485
 486 /* search a mempool from its name */
 487 struct rte_mempool *
 488 rte_mempool_lookup(const char *name)
 489 {
 490         struct rte_mempool *mp = NULL;
 491         struct rte_mempool_list *mempool_list;
 492
 493         if ((mempool_list =
 494              RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_MEMPOOL, rte_mempool_list)) == NULL) {
 495                 rte_errno = E_RTE_NO_TAILQ;
 496                 return NULL;
 497         }
 498
 499         rte_rwlock_read_lock(RTE_EAL_MEMPOOL_RWLOCK);
 500
 501         TAILQ_FOREACH(mp, mempool_list, next) {
 502                 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
 503                         break;
 504         }
 505
 506         rte_rwlock_read_unlock(RTE_EAL_MEMPOOL_RWLOCK);
 507
 508         if (mp == NULL)
 509                 rte_errno = ENOENT;
 510
 511         return mp;
 512 }