lib/librte_mempool/rte_mempool.h

   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 #ifndef _RTE_MEMPOOL_H_
  35 #define _RTE_MEMPOOL_H_
  36
  37 /**
  38  * @file
  39  * RTE Mempool.
  40  *
  41  * A memory pool is an allocator of fixed-size object. It is
  42  * identified by its name, and uses a ring to store free objects. It
  43  * provides some other optional services, like a per-core object
  44  * cache, and an alignment helper to ensure that objects are padded
  45  * to spread them equally on all RAM channels, ranks, and so on.
  46  *
  47  * Objects owned by a mempool should never be added in another
  48  * mempool. When an object is freed using rte_mempool_put() or
  49  * equivalent, the object data is not modified; the user can save some
  50  * meta-data in the object data and retrieve them when allocating a
  51  * new object.
  52  *
  53  * Note: the mempool implementation is not preemptable. A lcore must
  54  * not be interrupted by another task that uses the same mempool
  55  * (because it uses a ring which is not preemptable). Also, mempool
  56  * functions must not be used outside the DPDK environment: for
  57  * example, in linuxapp environment, a thread that is not created by
  58  * the EAL must not use mempools. This is due to the per-lcore cache
  59  * that won't work as rte_lcore_id() will not return a correct value.
  60  */
  61
  62 #include <stdlib.h>
  63 #include <stdint.h>
  64 #include <errno.h>
  65 #include <inttypes.h>
  66 #include <sys/queue.h>
  67
  68 #include <rte_log.h>
  69 #include <rte_debug.h>
  70 #include <rte_lcore.h>
  71 #include <rte_memory.h>
  72 #include <rte_branch_prediction.h>
  73 #include <rte_ring.h>
  74
  75 #ifdef __cplusplus
  76 extern "C" {
  77 #endif
  78
  79 #define RTE_MEMPOOL_HEADER_COOKIE1  0xbadbadbadadd2e55ULL /**< Header cookie. */
  80 #define RTE_MEMPOOL_HEADER_COOKIE2  0xf2eef2eedadd2e55ULL /**< Header cookie. */
  81 #define RTE_MEMPOOL_TRAILER_COOKIE  0xadd2e55badbadbadULL /**< Trailer cookie.*/
  82
  83 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
  84 /**
  85  * A structure that stores the mempool statistics (per-lcore).
  86  */
  87 struct rte_mempool_debug_stats {
  88         uint64_t put_bulk;         /**< Number of puts. */
  89         uint64_t put_objs;         /**< Number of objects successfully put. */
  90         uint64_t get_success_bulk; /**< Successful allocation number. */
  91         uint64_t get_success_objs; /**< Objects successfully allocated. */
  92         uint64_t get_fail_bulk;    /**< Failed allocation number. */
  93         uint64_t get_fail_objs;    /**< Objects that failed to be allocated. */
  94 } __rte_cache_aligned;
  95 #endif
  96
  97 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
  98 /**
  99  * A structure that stores a per-core object cache.
 100  */
 101 struct rte_mempool_cache {
 102         unsigned len; /**< Cache len */
 103         /*
 104          * Cache is allocated to this size to allow it to overflow in certain
 105          * cases to avoid needless emptying of cache.
 106          */
 107         void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
 108 } __rte_cache_aligned;
 109 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
 110
 111 #define RTE_MEMPOOL_NAMESIZE 32 /**< Maximum length of a memory pool. */
 112
 113 /**
 114  * The RTE mempool structure.
 115  */
 116 struct rte_mempool {
 117         TAILQ_ENTRY(rte_mempool) next;   /**< Next in list. */
 118
 119         char name[RTE_MEMPOOL_NAMESIZE]; /**< Name of mempool. */
 120         struct rte_ring *ring;           /**< Ring to store objects. */
 121         phys_addr_t phys_addr;           /**< Phys. addr. of mempool struct. */
 122         int flags;                       /**< Flags of the mempool. */
 123         uint32_t size;                   /**< Size of the mempool. */
 124         uint32_t cache_size;             /**< Size of per-lcore local cache. */
 125         uint32_t cache_flushthresh;      /**< Threshold before we flush excess elements. */
 126
 127         uint32_t elt_size;               /**< Size of an element. */
 128         uint32_t header_size;            /**< Size of header (before elt). */
 129         uint32_t trailer_size;           /**< Size of trailer (after elt). */
 130
 131         unsigned private_data_size;      /**< Size of private data. */
 132
 133 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 134         /** Per-lcore local cache. */
 135         struct rte_mempool_cache local_cache[RTE_MAX_LCORE];
 136 #endif
 137
 138 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 139         /** Per-lcore statistics. */
 140         struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
 141 #endif
 142 }  __rte_cache_aligned;
 143
 144 #define MEMPOOL_F_NO_SPREAD      0x0001 /**< Do not spread in memory. */
 145 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
 146 #define MEMPOOL_F_SP_PUT         0x0004 /**< Default put is "single-producer".*/
 147 #define MEMPOOL_F_SC_GET         0x0008 /**< Default get is "single-consumer".*/
 148
 149 /**
 150  * @internal When debug is enabled, store some statistics.
 151  * @param mp
 152  *   Pointer to the memory pool.
 153  * @param name
 154  *   Name of the statistics field to increment in the memory pool.
 155  * @param n
 156  *   Number to add to the object-oriented statistics.
 157  */
 158 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 159 #define __MEMPOOL_STAT_ADD(mp, name, n) do {                    \
 160                 unsigned __lcore_id = rte_lcore_id();           \
 161                 mp->stats[__lcore_id].name##_objs += n;         \
 162                 mp->stats[__lcore_id].name##_bulk += 1;         \
 163         } while(0)
 164 #else
 165 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
 166 #endif
 167
 168 /**
 169  * @internal Get a pointer to a mempool pointer in the object header.
 170  * @param obj
 171  *   Pointer to object.
 172  * @return
 173  *   The pointer to the mempool from which the object was allocated.
 174  */
 175 static inline struct rte_mempool **__mempool_from_obj(void *obj)
 176 {
 177         struct rte_mempool **mpp;
 178         unsigned off;
 179
 180         off = sizeof(struct rte_mempool *);
 181 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 182         off += sizeof(uint64_t);
 183 #endif
 184         mpp = (struct rte_mempool **)((char *)obj - off);
 185         return mpp;
 186 }
 187
 188 /**
 189  * Return a pointer to the mempool owning this object.
 190  *
 191  * @param obj
 192  *   An object that is owned by a pool. If this is not the case,
 193  *   the behavior is undefined.
 194  * @return
 195  *   A pointer to the mempool structure.
 196  */
 197 static inline const struct rte_mempool *rte_mempool_from_obj(void *obj)
 198 {
 199         struct rte_mempool * const *mpp;
 200         mpp = __mempool_from_obj(obj);
 201         return *mpp;
 202 }
 203
 204 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 205 /* get header cookie value */
 206 static inline uint64_t __mempool_read_header_cookie(const void *obj)
 207 {
 208         return *(const uint64_t *)((const char *)obj - sizeof(uint64_t));
 209 }
 210
 211 /* get trailer cookie value */
 212 static inline uint64_t __mempool_read_trailer_cookie(void *obj)
 213 {
 214         struct rte_mempool **mpp = __mempool_from_obj(obj);
 215         return *(uint64_t *)((char *)obj + (*mpp)->elt_size);
 216 }
 217
 218 /* write header cookie value */
 219 static inline void __mempool_write_header_cookie(void *obj, int free)
 220 {
 221         uint64_t *cookie_p;
 222         cookie_p = (uint64_t *)((char *)obj - sizeof(uint64_t));
 223         if (free == 0)
 224                 *cookie_p = RTE_MEMPOOL_HEADER_COOKIE1;
 225         else
 226                 *cookie_p = RTE_MEMPOOL_HEADER_COOKIE2;
 227
 228 }
 229
 230 /* write trailer cookie value */
 231 static inline void __mempool_write_trailer_cookie(void *obj)
 232 {
 233         uint64_t *cookie_p;
 234         struct rte_mempool **mpp = __mempool_from_obj(obj);
 235         cookie_p = (uint64_t *)((char *)obj + (*mpp)->elt_size);
 236         *cookie_p = RTE_MEMPOOL_TRAILER_COOKIE;
 237 }
 238 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
 239
 240 /**
 241  * @internal Check and update cookies or panic.
 242  *
 243  * @param mp
 244  *   Pointer to the memory pool.
 245  * @param obj_table_const
 246  *   Pointer to a table of void * pointers (objects).
 247  * @param n
 248  *   Index of object in object table.
 249  * @param free
 250  *   - 0: object is supposed to be allocated, mark it as free
 251  *   - 1: object is supposed to be free, mark it as allocated
 252  *   - 2: just check that cookie is valid (free or allocated)
 253  */
 254 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 255 #ifndef __INTEL_COMPILER
 256 #pragma GCC diagnostic ignored "-Wcast-qual"
 257 #endif
 258 static inline void __mempool_check_cookies(const struct rte_mempool *mp,
 259                                            void * const *obj_table_const,
 260                                            unsigned n, int free)
 261 {
 262         uint64_t cookie;
 263         void *tmp;
 264         void *obj;
 265         void **obj_table;
 266
 267         /* Force to drop the "const" attribute. This is done only when
 268          * DEBUG is enabled */
 269         tmp = (void *) obj_table_const;
 270         obj_table = (void **) tmp;
 271
 272         while (n--) {
 273                 obj = obj_table[n];
 274
 275                 if (rte_mempool_from_obj(obj) != mp)
 276                         rte_panic("MEMPOOL: object is owned by another "
 277                                   "mempool\n");
 278
 279                 cookie = __mempool_read_header_cookie(obj);
 280
 281                 if (free == 0) {
 282                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
 283                                 rte_log_set_history(0);
 284                                 RTE_LOG(CRIT, MEMPOOL,
 285                                         "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
 286                                         obj, mp, cookie);
 287                                 rte_panic("MEMPOOL: bad header cookie (put)\n");
 288                         }
 289                         __mempool_write_header_cookie(obj, 1);
 290                 }
 291                 else if (free == 1) {
 292                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
 293                                 rte_log_set_history(0);
 294                                 RTE_LOG(CRIT, MEMPOOL,
 295                                         "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
 296                                         obj, mp, cookie);
 297                                 rte_panic("MEMPOOL: bad header cookie (get)\n");
 298                         }
 299                         __mempool_write_header_cookie(obj, 0);
 300                 }
 301                 else if (free == 2) {
 302                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
 303                             cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
 304                                 rte_log_set_history(0);
 305                                 RTE_LOG(CRIT, MEMPOOL,
 306                                         "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
 307                                         obj, mp, cookie);
 308                                 rte_panic("MEMPOOL: bad header cookie (audit)\n");
 309                         }
 310                 }
 311                 cookie = __mempool_read_trailer_cookie(obj);
 312                 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
 313                         rte_log_set_history(0);
 314                         RTE_LOG(CRIT, MEMPOOL,
 315                                 "obj=%p, mempool=%p, cookie=%"PRIx64"\n",
 316                                 obj, mp, cookie);
 317                         rte_panic("MEMPOOL: bad trailer cookie\n");
 318                 }
 319         }
 320 }
 321 #ifndef __INTEL_COMPILER
 322 #pragma GCC diagnostic error "-Wcast-qual"
 323 #endif
 324 #else
 325 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
 326 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
 327
 328 /**
 329  * An object constructor callback function for mempool.
 330  *
 331  * Arguments are the mempool, the opaque pointer given by the user in
 332  * rte_mempool_create(), the pointer to the element and the index of
 333  * the element in the pool.
 334  */
 335 typedef void (rte_mempool_obj_ctor_t)(struct rte_mempool *, void *,
 336                                       void *, unsigned);
 337
 338 /**
 339  * A mempool constructor callback function.
 340  *
 341  * Arguments are the mempool and the opaque pointer given by the user in
 342  * rte_mempool_create().
 343  */
 344 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
 345
 346 /**
 347  * Creates a new mempool named *name* in memory.
 348  *
 349  * This function uses ``memzone_reserve()`` to allocate memory. The
 350  * pool contains n elements of elt_size. Its size is set to n.
 351  *
 352  * @param name
 353  *   The name of the mempool.
 354  * @param n
 355  *   The number of elements in the mempool. The optimum size (in terms of
 356  *   memory usage) for a mempool is when n is a power of two minus one:
 357  *   n = (2^q - 1).
 358  * @param elt_size
 359  *   The size of each element.
 360  * @param cache_size
 361  *   If cache_size is non-zero, the rte_mempool library will try to
 362  *   limit the accesses to the common lockless pool, by maintaining a
 363  *   per-lcore object cache. This argument must be lower or equal to
 364  *   CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE. It is advised to choose
 365  *   cache_size to have "n modulo cache_size == 0": if this is
 366  *   not the case, some elements will always stay in the pool and will
 367  *   never be used. The access to the per-lcore table is of course
 368  *   faster than the multi-producer/consumer pool. The cache can be
 369  *   disabled if the cache_size argument is set to 0; it can be useful to
 370  *   avoid loosing objects in cache. Note that even if not used, the
 371  *   memory space for cache is always reserved in a mempool structure,
 372  *   except if CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE is set to 0.
 373  * @param private_data_size
 374  *   The size of the private data appended after the mempool
 375  *   structure. This is useful for storing some private data after the
 376  *   mempool structure, as is done for rte_mbuf_pool for example.
 377  * @param mp_init
 378  *   A function pointer that is called for initialization of the pool,
 379  *   before object initialization. The user can initialize the private
 380  *   data in this function if needed. This parameter can be NULL if
 381  *   not needed.
 382  * @param mp_init_arg
 383  *   An opaque pointer to data that can be used in the mempool
 384  *   constructor function.
 385  * @param obj_init
 386  *   A function pointer that is called for each object at
 387  *   initialization of the pool. The user can set some meta data in
 388  *   objects if needed. This parameter can be NULL if not needed.
 389  *   The obj_init() function takes the mempool pointer, the init_arg,
 390  *   the object pointer and the object number as parameters.
 391  * @param obj_init_arg
 392  *   An opaque pointer to data that can be used as an argument for
 393  *   each call to the object constructor function.
 394  * @param socket_id
 395  *   The *socket_id* argument is the socket identifier in the case of
 396  *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
 397  *   constraint for the reserved zone.
 398  * @param flags
 399  *   The *flags* arguments is an OR of following flags:
 400  *   - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
 401  *     between channels in RAM: the pool allocator will add padding
 402  *     between objects depending on the hardware configuration. See
 403  *     Memory alignment constraints for details. If this flag is set,
 404  *     the allocator will just align them to a cache line.
 405  *   - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
 406  *     cache-aligned. This flag removes this constraint, and no
 407  *     padding will be present between objects. This flag implies
 408  *     MEMPOOL_F_NO_SPREAD.
 409  *   - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
 410  *     when using rte_mempool_put() or rte_mempool_put_bulk() is
 411  *     "single-producer". Otherwise, it is "multi-producers".
 412  *   - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
 413  *     when using rte_mempool_get() or rte_mempool_get_bulk() is
 414  *     "single-consumer". Otherwise, it is "multi-consumers".
 415  * @return
 416  *   The pointer to the new allocated mempool, on success. NULL on error
 417  *   with rte_errno set appropriately. Possible rte_errno values include:
 418  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
 419  *    - E_RTE_SECONDARY - function was called from a secondary process instance
 420  *    - E_RTE_NO_TAILQ - no tailq list could be got for the ring or mempool list
 421  *    - EINVAL - cache size provided is too large
 422  *    - ENOSPC - the maximum number of memzones has already been allocated
 423  *    - EEXIST - a memzone with the same name already exists
 424  *    - ENOMEM - no appropriate memory area found in which to create memzone
 425  */
 426 struct rte_mempool *
 427 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
 428                    unsigned cache_size, unsigned private_data_size,
 429                    rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 430                    rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg,
 431                    int socket_id, unsigned flags);
 432
 433 /**
 434  * Dump the status of the mempool to the console.
 435  *
 436  * @param mp
 437  *   A pointer to the mempool structure.
 438  */
 439 void rte_mempool_dump(const struct rte_mempool *mp);
 440
 441 /**
 442  * @internal Put several objects back in the mempool; used internally.
 443  * @param mp
 444  *   A pointer to the mempool structure.
 445  * @param obj_table
 446  *   A pointer to a table of void * pointers (objects).
 447  * @param n
 448  *   The number of objects to store back in the mempool, must be strictly
 449  *   positive.
 450  * @param is_mp
 451  *   Mono-producer (0) or multi-producers (1).
 452  */
 453 static inline void __attribute__((always_inline))
 454 __mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
 455                     unsigned n, int is_mp)
 456 {
 457 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 458         struct rte_mempool_cache *cache;
 459         uint32_t index;
 460         void **cache_objs;
 461         unsigned lcore_id = rte_lcore_id();
 462         uint32_t cache_size = mp->cache_size;
 463         uint32_t flushthresh = mp->cache_flushthresh;
 464 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
 465
 466         /* increment stat now, adding in mempool always success */
 467         __MEMPOOL_STAT_ADD(mp, put, n);
 468
 469 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 470         /* cache is not enabled or single producer */
 471         if (unlikely(cache_size == 0 || is_mp == 0))
 472                 goto ring_enqueue;
 473
 474         /* Go straight to ring if put would overflow mem allocated for cache */
 475         if (unlikely(n > RTE_MEMPOOL_CACHE_MAX_SIZE))
 476                 goto ring_enqueue;
 477
 478         cache = &mp->local_cache[lcore_id];
 479         cache_objs = &cache->objs[cache->len];
 480
 481         /*
 482          * The cache follows the following algorithm
 483          *   1. Add the objects to the cache
 484          *   2. Anything greater than the cache min value (if it crosses the
 485          *   cache flush threshold) is flushed to the ring.
 486          */
 487
 488         /* Add elements back into the cache */
 489         for (index = 0; index < n; ++index, obj_table++)
 490                 cache_objs[index] = *obj_table;
 491
 492         cache->len += n;
 493
 494         if (cache->len >= flushthresh) {
 495                 rte_ring_mp_enqueue_bulk(mp->ring, &cache->objs[cache_size],
 496                                 cache->len - cache_size);
 497                 cache->len = cache_size;
 498         }
 499
 500         return;
 501
 502 ring_enqueue:
 503 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
 504
 505         /* push remaining objects in ring */
 506 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 507         if (is_mp) {
 508                 if (rte_ring_mp_enqueue_bulk(mp->ring, obj_table, n) < 0)
 509                         rte_panic("cannot put objects in mempool\n");
 510         }
 511         else {
 512                 if (rte_ring_sp_enqueue_bulk(mp->ring, obj_table, n) < 0)
 513                         rte_panic("cannot put objects in mempool\n");
 514         }
 515 #else
 516         if (is_mp)
 517                 rte_ring_mp_enqueue_bulk(mp->ring, obj_table, n);
 518         else
 519                 rte_ring_sp_enqueue_bulk(mp->ring, obj_table, n);
 520 #endif
 521 }
 522
 523
 524 /**
 525  * Put several objects back in the mempool (multi-producers safe).
 526  *
 527  * @param mp
 528  *   A pointer to the mempool structure.
 529  * @param obj_table
 530  *   A pointer to a table of void * pointers (objects).
 531  * @param n
 532  *   The number of objects to add in the mempool from the obj_table.
 533  */
 534 static inline void __attribute__((always_inline))
 535 rte_mempool_mp_put_bulk(struct rte_mempool *mp, void * const *obj_table,
 536                         unsigned n)
 537 {
 538         __mempool_check_cookies(mp, obj_table, n, 0);
 539         __mempool_put_bulk(mp, obj_table, n, 1);
 540 }
 541
 542 /**
 543  * Put several objects back in the mempool (NOT multi-producers safe).
 544  *
 545  * @param mp
 546  *   A pointer to the mempool structure.
 547  * @param obj_table
 548  *   A pointer to a table of void * pointers (objects).
 549  * @param n
 550  *   The number of objects to add in the mempool from obj_table.
 551  */
 552 static inline void
 553 rte_mempool_sp_put_bulk(struct rte_mempool *mp, void * const *obj_table,
 554                         unsigned n)
 555 {
 556         __mempool_check_cookies(mp, obj_table, n, 0);
 557         __mempool_put_bulk(mp, obj_table, n, 0);
 558 }
 559
 560 /**
 561  * Put several objects back in the mempool.
 562  *
 563  * This function calls the multi-producer or the single-producer
 564  * version depending on the default behavior that was specified at
 565  * mempool creation time (see flags).
 566  *
 567  * @param mp
 568  *   A pointer to the mempool structure.
 569  * @param obj_table
 570  *   A pointer to a table of void * pointers (objects).
 571  * @param n
 572  *   The number of objects to add in the mempool from obj_table.
 573  */
 574 static inline void __attribute__((always_inline))
 575 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
 576                      unsigned n)
 577 {
 578         __mempool_check_cookies(mp, obj_table, n, 0);
 579         __mempool_put_bulk(mp, obj_table, n, !(mp->flags & MEMPOOL_F_SP_PUT));
 580 }
 581
 582 /**
 583  * Put one object in the mempool (multi-producers safe).
 584  *
 585  * @param mp
 586  *   A pointer to the mempool structure.
 587  * @param obj
 588  *   A pointer to the object to be added.
 589  */
 590 static inline void __attribute__((always_inline))
 591 rte_mempool_mp_put(struct rte_mempool *mp, void *obj)
 592 {
 593         rte_mempool_mp_put_bulk(mp, &obj, 1);
 594 }
 595
 596 /**
 597  * Put one object back in the mempool (NOT multi-producers safe).
 598  *
 599  * @param mp
 600  *   A pointer to the mempool structure.
 601  * @param obj
 602  *   A pointer to the object to be added.
 603  */
 604 static inline void __attribute__((always_inline))
 605 rte_mempool_sp_put(struct rte_mempool *mp, void *obj)
 606 {
 607         rte_mempool_sp_put_bulk(mp, &obj, 1);
 608 }
 609
 610 /**
 611  * Put one object back in the mempool.
 612  *
 613  * This function calls the multi-producer or the single-producer
 614  * version depending on the default behavior that was specified at
 615  * mempool creation time (see flags).
 616  *
 617  * @param mp
 618  *   A pointer to the mempool structure.
 619  * @param obj
 620  *   A pointer to the object to be added.
 621  */
 622 static inline void __attribute__((always_inline))
 623 rte_mempool_put(struct rte_mempool *mp, void *obj)
 624 {
 625         rte_mempool_put_bulk(mp, &obj, 1);
 626 }
 627
 628 /**
 629  * @internal Get several objects from the mempool; used internally.
 630  * @param mp
 631  *   A pointer to the mempool structure.
 632  * @param obj_table
 633  *   A pointer to a table of void * pointers (objects).
 634  * @param n
 635  *   The number of objects to get, must be strictly positive.
 636  * @param is_mc
 637  *   Mono-consumer (0) or multi-consumers (1).
 638  * @return
 639  *   - >=0: Success; number of objects supplied.
 640  *   - <0: Error; code of ring dequeue function.
 641  */
 642 static inline int __attribute__((always_inline))
 643 __mempool_get_bulk(struct rte_mempool *mp, void **obj_table,
 644                    unsigned n, int is_mc)
 645 {
 646         int ret;
 647 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 648         unsigned n_orig = n;
 649 #endif
 650 #if RTE_MEMPOOL_CACHE_MAX_SIZE > 0
 651         struct rte_mempool_cache *cache;
 652         uint32_t index, len;
 653         void **cache_objs;
 654         unsigned lcore_id = rte_lcore_id();
 655         uint32_t cache_size = mp->cache_size;
 656
 657         cache = &mp->local_cache[lcore_id];
 658
 659         /* cache is not enabled or single consumer */
 660         if (unlikely(cache_size == 0 || is_mc == 0 || n >= cache_size))
 661                 goto ring_dequeue;
 662
 663         cache_objs = cache->objs;
 664
 665         /* Can this be satisfied from the cache? */
 666         if (cache->len < n) {
 667                 /* No. Backfill the cache first, and then fill from it */
 668                 uint32_t req = n + (cache_size - cache->len);
 669
 670                 /* How many do we require i.e. number to fill the cache + the request */
 671                 ret = rte_ring_mc_dequeue_bulk(mp->ring, &cache->objs[cache->len], req);
 672                 if (unlikely(ret < 0)) {
 673                         /*
 674                          * In the offchance that we are buffer constrained,
 675                          * where we are not able to allocate cache + n, go to
 676                          * the ring directly. If that fails, we are truly out of
 677                          * buffers.
 678                          */
 679                         goto ring_dequeue;
 680                 }
 681
 682                 cache->len += req;
 683         }
 684
 685         /* Now fill in the response ... */
 686         for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
 687                 *obj_table = cache_objs[len];
 688
 689         cache->len -= n;
 690
 691         __MEMPOOL_STAT_ADD(mp, get_success, n_orig);
 692
 693         return 0;
 694
 695 ring_dequeue:
 696 #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */
 697
 698         /* get remaining objects from ring */
 699         if (is_mc)
 700                 ret = rte_ring_mc_dequeue_bulk(mp->ring, obj_table, n);
 701         else
 702                 ret = rte_ring_sc_dequeue_bulk(mp->ring, obj_table, n);
 703
 704         if (ret < 0)
 705                 __MEMPOOL_STAT_ADD(mp, get_fail, n_orig);
 706         else
 707                 __MEMPOOL_STAT_ADD(mp, get_success, n_orig);
 708
 709         return ret;
 710 }
 711
 712 /**
 713  * Get several objects from the mempool (multi-consumers safe).
 714  *
 715  * If cache is enabled, objects will be retrieved first from cache,
 716  * subsequently from the common pool. Note that it can return -ENOENT when
 717  * the local cache and common pool are empty, even if cache from other
 718  * lcores are full.
 719  *
 720  * @param mp
 721  *   A pointer to the mempool structure.
 722  * @param obj_table
 723  *   A pointer to a table of void * pointers (objects) that will be filled.
 724  * @param n
 725  *   The number of objects to get from mempool to obj_table.
 726  * @return
 727  *   - 0: Success; objects taken.
 728  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
 729  */
 730 static inline int __attribute__((always_inline))
 731 rte_mempool_mc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
 732 {
 733         int ret;
 734         ret = __mempool_get_bulk(mp, obj_table, n, 1);
 735         if (ret == 0)
 736                 __mempool_check_cookies(mp, obj_table, n, 1);
 737         return ret;
 738 }
 739
 740 /**
 741  * Get several objects from the mempool (NOT multi-consumers safe).
 742  *
 743  * If cache is enabled, objects will be retrieved first from cache,
 744  * subsequently from the common pool. Note that it can return -ENOENT when
 745  * the local cache and common pool are empty, even if cache from other
 746  * lcores are full.
 747  *
 748  * @param mp
 749  *   A pointer to the mempool structure.
 750  * @param obj_table
 751  *   A pointer to a table of void * pointers (objects) that will be filled.
 752  * @param n
 753  *   The number of objects to get from the mempool to obj_table.
 754  * @return
 755  *   - 0: Success; objects taken.
 756  *   - -ENOENT: Not enough entries in the mempool; no object is
 757  *     retrieved.
 758  */
 759 static inline int __attribute__((always_inline))
 760 rte_mempool_sc_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
 761 {
 762         int ret;
 763         ret = __mempool_get_bulk(mp, obj_table, n, 0);
 764         if (ret == 0)
 765                 __mempool_check_cookies(mp, obj_table, n, 1);
 766         return ret;
 767 }
 768
 769 /**
 770  * Get several objects from the mempool.
 771  *
 772  * This function calls the multi-consumers or the single-consumer
 773  * version, depending on the default behaviour that was specified at
 774  * mempool creation time (see flags).
 775  *
 776  * If cache is enabled, objects will be retrieved first from cache,
 777  * subsequently from the common pool. Note that it can return -ENOENT when
 778  * the local cache and common pool are empty, even if cache from other
 779  * lcores are full.
 780  *
 781  * @param mp
 782  *   A pointer to the mempool structure.
 783  * @param obj_table
 784  *   A pointer to a table of void * pointers (objects) that will be filled.
 785  * @param n
 786  *   The number of objects to get from the mempool to obj_table.
 787  * @return
 788  *   - 0: Success; objects taken
 789  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
 790  */
 791 static inline int __attribute__((always_inline))
 792 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned n)
 793 {
 794         int ret;
 795         ret = __mempool_get_bulk(mp, obj_table, n,
 796                                  !(mp->flags & MEMPOOL_F_SC_GET));
 797         if (ret == 0)
 798                 __mempool_check_cookies(mp, obj_table, n, 1);
 799         return ret;
 800 }
 801
 802 /**
 803  * Get one object from the mempool (multi-consumers safe).
 804  *
 805  * If cache is enabled, objects will be retrieved first from cache,
 806  * subsequently from the common pool. Note that it can return -ENOENT when
 807  * the local cache and common pool are empty, even if cache from other
 808  * lcores are full.
 809  *
 810  * @param mp
 811  *   A pointer to the mempool structure.
 812  * @param obj_p
 813  *   A pointer to a void * pointer (object) that will be filled.
 814  * @return
 815  *   - 0: Success; objects taken.
 816  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
 817  */
 818 static inline int __attribute__((always_inline))
 819 rte_mempool_mc_get(struct rte_mempool *mp, void **obj_p)
 820 {
 821         return rte_mempool_mc_get_bulk(mp, obj_p, 1);
 822 }
 823
 824 /**
 825  * Get one object from the mempool (NOT multi-consumers safe).
 826  *
 827  * If cache is enabled, objects will be retrieved first from cache,
 828  * subsequently from the common pool. Note that it can return -ENOENT when
 829  * the local cache and common pool are empty, even if cache from other
 830  * lcores are full.
 831  *
 832  * @param mp
 833  *   A pointer to the mempool structure.
 834  * @param obj_p
 835  *   A pointer to a void * pointer (object) that will be filled.
 836  * @return
 837  *   - 0: Success; objects taken.
 838  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
 839  */
 840 static inline int __attribute__((always_inline))
 841 rte_mempool_sc_get(struct rte_mempool *mp, void **obj_p)
 842 {
 843         return rte_mempool_sc_get_bulk(mp, obj_p, 1);
 844 }
 845
 846 /**
 847  * Get one object from the mempool.
 848  *
 849  * This function calls the multi-consumers or the single-consumer
 850  * version, depending on the default behavior that was specified at
 851  * mempool creation (see flags).
 852  *
 853  * If cache is enabled, objects will be retrieved first from cache,
 854  * subsequently from the common pool. Note that it can return -ENOENT when
 855  * the local cache and common pool are empty, even if cache from other
 856  * lcores are full.
 857  *
 858  * @param mp
 859  *   A pointer to the mempool structure.
 860  * @param obj_p
 861  *   A pointer to a void * pointer (object) that will be filled.
 862  * @return
 863  *   - 0: Success; objects taken.
 864  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
 865  */
 866 static inline int __attribute__((always_inline))
 867 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
 868 {
 869         return rte_mempool_get_bulk(mp, obj_p, 1);
 870 }
 871
 872 /**
 873  * Return the number of entries in the mempool.
 874  *
 875  * When cache is enabled, this function has to browse the length of
 876  * all lcores, so it should not be used in a data path, but only for
 877  * debug purposes.
 878  *
 879  * @param mp
 880  *   A pointer to the mempool structure.
 881  * @return
 882  *   The number of entries in the mempool.
 883  */
 884 unsigned rte_mempool_count(const struct rte_mempool *mp);
 885
 886 /**
 887  * Return the number of free entries in the mempool ring.
 888  * i.e. how many entries can be freed back to the mempool.
 889  *
 890  * NOTE: This corresponds to the number of elements *allocated* from the
 891  * memory pool, not the number of elements in the pool itself. To count
 892  * the number elements currently available in the pool, use "rte_mempool_count"
 893  *
 894  * When cache is enabled, this function has to browse the length of
 895  * all lcores, so it should not be used in a data path, but only for
 896  * debug purposes.
 897  *
 898  * @param mp
 899  *   A pointer to the mempool structure.
 900  * @return
 901  *   The number of free entries in the mempool.
 902  */
 903 static inline unsigned
 904 rte_mempool_free_count(const struct rte_mempool *mp)
 905 {
 906         return mp->size - rte_mempool_count(mp);
 907 }
 908
 909 /**
 910  * Test if the mempool is full.
 911  *
 912  * When cache is enabled, this function has to browse the length of all
 913  * lcores, so it should not be used in a data path, but only for debug
 914  * purposes.
 915  *
 916  * @param mp
 917  *   A pointer to the mempool structure.
 918  * @return
 919  *   - 1: The mempool is full.
 920  *   - 0: The mempool is not full.
 921  */
 922 static inline int
 923 rte_mempool_full(const struct rte_mempool *mp)
 924 {
 925         return !!(rte_mempool_count(mp) == mp->size);
 926 }
 927
 928 /**
 929  * Test if the mempool is empty.
 930  *
 931  * When cache is enabled, this function has to browse the length of all
 932  * lcores, so it should not be used in a data path, but only for debug
 933  * purposes.
 934  *
 935  * @param mp
 936  *   A pointer to the mempool structure.
 937  * @return
 938  *   - 1: The mempool is empty.
 939  *   - 0: The mempool is not empty.
 940  */
 941 static inline int
 942 rte_mempool_empty(const struct rte_mempool *mp)
 943 {
 944         return !!(rte_mempool_count(mp) == 0);
 945 }
 946
 947 /**
 948  * Return the physical address of elt, which is an element of the pool mp.
 949  *
 950  * @param mp
 951  *   A pointer to the mempool structure.
 952  * @param elt
 953  *   A pointer (virtual address) to the element of the pool.
 954  * @return
 955  *   The physical address of the elt element.
 956  */
 957 static inline phys_addr_t rte_mempool_virt2phy(const struct rte_mempool *mp,
 958         const void *elt)
 959 {
 960         uintptr_t off;
 961
 962         off = (const char *)elt - (const char *)mp;
 963         return mp->phys_addr + off;
 964 }
 965
 966
 967 /**
 968  * Check the consistency of mempool objects.
 969  *
 970  * Verify the coherency of fields in the mempool structure. Also check
 971  * that the cookies of mempool objects (even the ones that are not
 972  * present in pool) have a correct value. If not, a panic will occur.
 973  *
 974  * @param mp
 975  *   A pointer to the mempool structure.
 976  */
 977 void rte_mempool_audit(const struct rte_mempool *mp);
 978
 979 /**
 980  * Return a pointer to the private data in an mempool structure.
 981  *
 982  * @param mp
 983  *   A pointer to the mempool structure.
 984  * @return
 985  *   A pointer to the private data.
 986  */
 987 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
 988 {
 989         return (char *)mp + sizeof(struct rte_mempool);
 990 }
 991
 992 /**
 993  * Dump the status of all mempools on the console
 994  */
 995 void rte_mempool_list_dump(void);
 996
 997 /**
 998  * Search a mempool from its name
 999  *
1000  * @param name
1001  *   The name of the mempool.
1002  * @return
1003  *   The pointer to the mempool matching the name, or NULL if not found.NULL on error
1004  *   with rte_errno set appropriately. Possible rte_errno values include:
1005  *    - ENOENT - required entry not available to return.
1006  *
1007  */
1008 struct rte_mempool *rte_mempool_lookup(const char *name);
1009
1010 #ifdef __cplusplus
1011 }
1012 #endif
1013
1014 #endif /* _RTE_MEMPOOL_H_ */