lib/librte_mempool/rte_mempool.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation.
   3  * Copyright(c) 2016 6WIND S.A.
   4  */
   5
   6 #ifndef _RTE_MEMPOOL_H_
   7 #define _RTE_MEMPOOL_H_
   8
   9 /**
  10  * @file
  11  * RTE Mempool.
  12  *
  13  * A memory pool is an allocator of fixed-size object. It is
  14  * identified by its name, and uses a ring to store free objects. It
  15  * provides some other optional services, like a per-core object
  16  * cache, and an alignment helper to ensure that objects are padded
  17  * to spread them equally on all RAM channels, ranks, and so on.
  18  *
  19  * Objects owned by a mempool should never be added in another
  20  * mempool. When an object is freed using rte_mempool_put() or
  21  * equivalent, the object data is not modified; the user can save some
  22  * meta-data in the object data and retrieve them when allocating a
  23  * new object.
  24  *
  25  * Note: the mempool implementation is not preemptible. An lcore must not be
  26  * interrupted by another task that uses the same mempool (because it uses a
  27  * ring which is not preemptible). Also, usual mempool functions like
  28  * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
  29  * thread due to the internal per-lcore cache. Due to the lack of caching,
  30  * rte_mempool_get() or rte_mempool_put() performance will suffer when called
  31  * by non-EAL threads. Instead, non-EAL threads should call
  32  * rte_mempool_generic_get() or rte_mempool_generic_put() with a user cache
  33  * created with rte_mempool_cache_create().
  34  */
  35
  36 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <stdint.h>
  39 #include <errno.h>
  40 #include <inttypes.h>
  41 #include <sys/queue.h>
  42
  43 #include <rte_config.h>
  44 #include <rte_spinlock.h>
  45 #include <rte_log.h>
  46 #include <rte_debug.h>
  47 #include <rte_lcore.h>
  48 #include <rte_memory.h>
  49 #include <rte_branch_prediction.h>
  50 #include <rte_ring.h>
  51 #include <rte_memcpy.h>
  52 #include <rte_common.h>
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58 #define RTE_MEMPOOL_HEADER_COOKIE1  0xbadbadbadadd2e55ULL /**< Header cookie. */
  59 #define RTE_MEMPOOL_HEADER_COOKIE2  0xf2eef2eedadd2e55ULL /**< Header cookie. */
  60 #define RTE_MEMPOOL_TRAILER_COOKIE  0xadd2e55badbadbadULL /**< Trailer cookie.*/
  61
  62 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
  63 /**
  64  * A structure that stores the mempool statistics (per-lcore).
  65  */
  66 struct rte_mempool_debug_stats {
  67         uint64_t put_bulk;         /**< Number of puts. */
  68         uint64_t put_objs;         /**< Number of objects successfully put. */
  69         uint64_t get_success_bulk; /**< Successful allocation number. */
  70         uint64_t get_success_objs; /**< Objects successfully allocated. */
  71         uint64_t get_fail_bulk;    /**< Failed allocation number. */
  72         uint64_t get_fail_objs;    /**< Objects that failed to be allocated. */
  73 } __rte_cache_aligned;
  74 #endif
  75
  76 /**
  77  * A structure that stores a per-core object cache.
  78  */
  79 struct rte_mempool_cache {
  80         uint32_t size;        /**< Size of the cache */
  81         uint32_t flushthresh; /**< Threshold before we flush excess elements */
  82         uint32_t len;         /**< Current cache count */
  83         /*
  84          * Cache is allocated to this size to allow it to overflow in certain
  85          * cases to avoid needless emptying of cache.
  86          */
  87         void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 3]; /**< Cache objects */
  88 } __rte_cache_aligned;
  89
  90 /**
  91  * A structure that stores the size of mempool elements.
  92  */
  93 struct rte_mempool_objsz {
  94         uint32_t elt_size;     /**< Size of an element. */
  95         uint32_t header_size;  /**< Size of header (before elt). */
  96         uint32_t trailer_size; /**< Size of trailer (after elt). */
  97         uint32_t total_size;
  98         /**< Total size of an object (header + elt + trailer). */
  99 };
 100
 101 /**< Maximum length of a memory pool's name. */
 102 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
 103                               sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
 104 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
 105
 106 /* "MP_<name>" */
 107 #define RTE_MEMPOOL_MZ_FORMAT   RTE_MEMPOOL_MZ_PREFIX "%s"
 108
 109 #define MEMPOOL_PG_SHIFT_MAX    (sizeof(uintptr_t) * CHAR_BIT - 1)
 110
 111 /** Mempool over one chunk of physically continuous memory */
 112 #define MEMPOOL_PG_NUM_DEFAULT  1
 113
 114 #ifndef RTE_MEMPOOL_ALIGN
 115 #define RTE_MEMPOOL_ALIGN       RTE_CACHE_LINE_SIZE
 116 #endif
 117
 118 #define RTE_MEMPOOL_ALIGN_MASK  (RTE_MEMPOOL_ALIGN - 1)
 119
 120 /**
 121  * Mempool object header structure
 122  *
 123  * Each object stored in mempools are prefixed by this header structure,
 124  * it allows to retrieve the mempool pointer from the object and to
 125  * iterate on all objects attached to a mempool. When debug is enabled,
 126  * a cookie is also added in this structure preventing corruptions and
 127  * double-frees.
 128  */
 129 struct rte_mempool_objhdr {
 130         STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
 131         struct rte_mempool *mp;          /**< The mempool owning the object. */
 132         RTE_STD_C11
 133         union {
 134                 rte_iova_t iova;         /**< IO address of the object. */
 135                 phys_addr_t physaddr;    /**< deprecated - Physical address of the object. */
 136         };
 137 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 138         uint64_t cookie;                 /**< Debug cookie. */
 139 #endif
 140 };
 141
 142 /**
 143  * A list of object headers type
 144  */
 145 STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
 146
 147 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 148
 149 /**
 150  * Mempool object trailer structure
 151  *
 152  * In debug mode, each object stored in mempools are suffixed by this
 153  * trailer structure containing a cookie preventing memory corruptions.
 154  */
 155 struct rte_mempool_objtlr {
 156         uint64_t cookie;                 /**< Debug cookie. */
 157 };
 158
 159 #endif
 160
 161 /**
 162  * A list of memory where objects are stored
 163  */
 164 STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
 165
 166 /**
 167  * Callback used to free a memory chunk
 168  */
 169 typedef void (rte_mempool_memchunk_free_cb_t)(struct rte_mempool_memhdr *memhdr,
 170         void *opaque);
 171
 172 /**
 173  * Mempool objects memory header structure
 174  *
 175  * The memory chunks where objects are stored. Each chunk is virtually
 176  * and physically contiguous.
 177  */
 178 struct rte_mempool_memhdr {
 179         STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
 180         struct rte_mempool *mp;  /**< The mempool owning the chunk */
 181         void *addr;              /**< Virtual address of the chunk */
 182         RTE_STD_C11
 183         union {
 184                 rte_iova_t iova;       /**< IO address of the chunk */
 185                 phys_addr_t phys_addr; /**< Physical address of the chunk */
 186         };
 187         size_t len;              /**< length of the chunk */
 188         rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
 189         void *opaque;            /**< Argument passed to the free callback */
 190 };
 191
 192 /**
 193  * The RTE mempool structure.
 194  */
 195 struct rte_mempool {
 196         /*
 197          * Note: this field kept the RTE_MEMZONE_NAMESIZE size due to ABI
 198          * compatibility requirements, it could be changed to
 199          * RTE_MEMPOOL_NAMESIZE next time the ABI changes
 200          */
 201         char name[RTE_MEMZONE_NAMESIZE]; /**< Name of mempool. */
 202         RTE_STD_C11
 203         union {
 204                 void *pool_data;         /**< Ring or pool to store objects. */
 205                 uint64_t pool_id;        /**< External mempool identifier. */
 206         };
 207         void *pool_config;               /**< optional args for ops alloc. */
 208         const struct rte_memzone *mz;    /**< Memzone where pool is alloc'd. */
 209         unsigned int flags;              /**< Flags of the mempool. */
 210         int socket_id;                   /**< Socket id passed at create. */
 211         uint32_t size;                   /**< Max size of the mempool. */
 212         uint32_t cache_size;
 213         /**< Size of per-lcore default local cache. */
 214
 215         uint32_t elt_size;               /**< Size of an element. */
 216         uint32_t header_size;            /**< Size of header (before elt). */
 217         uint32_t trailer_size;           /**< Size of trailer (after elt). */
 218
 219         unsigned private_data_size;      /**< Size of private data. */
 220         /**
 221          * Index into rte_mempool_ops_table array of mempool ops
 222          * structs, which contain callback function pointers.
 223          * We're using an index here rather than pointers to the callbacks
 224          * to facilitate any secondary processes that may want to use
 225          * this mempool.
 226          */
 227         int32_t ops_index;
 228
 229         struct rte_mempool_cache *local_cache; /**< Per-lcore local cache */
 230
 231         uint32_t populated_size;         /**< Number of populated objects. */
 232         struct rte_mempool_objhdr_list elt_list; /**< List of objects in pool */
 233         uint32_t nb_mem_chunks;          /**< Number of memory chunks */
 234         struct rte_mempool_memhdr_list mem_list; /**< List of memory chunks */
 235
 236 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 237         /** Per-lcore statistics. */
 238         struct rte_mempool_debug_stats stats[RTE_MAX_LCORE];
 239 #endif
 240 }  __rte_cache_aligned;
 241
 242 #define MEMPOOL_F_NO_SPREAD      0x0001 /**< Do not spread among memory channels. */
 243 #define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
 244 #define MEMPOOL_F_SP_PUT         0x0004 /**< Default put is "single-producer".*/
 245 #define MEMPOOL_F_SC_GET         0x0008 /**< Default get is "single-consumer".*/
 246 #define MEMPOOL_F_POOL_CREATED   0x0010 /**< Internal: pool is created. */
 247 #define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
 248 #define MEMPOOL_F_NO_PHYS_CONTIG MEMPOOL_F_NO_IOVA_CONTIG /* deprecated */
 249
 250 /**
 251  * @internal When debug is enabled, store some statistics.
 252  *
 253  * @param mp
 254  *   Pointer to the memory pool.
 255  * @param name
 256  *   Name of the statistics field to increment in the memory pool.
 257  * @param n
 258  *   Number to add to the object-oriented statistics.
 259  */
 260 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 261 #define __MEMPOOL_STAT_ADD(mp, name, n) do {                    \
 262                 unsigned __lcore_id = rte_lcore_id();           \
 263                 if (__lcore_id < RTE_MAX_LCORE) {               \
 264                         mp->stats[__lcore_id].name##_objs += n; \
 265                         mp->stats[__lcore_id].name##_bulk += 1; \
 266                 }                                               \
 267         } while(0)
 268 #else
 269 #define __MEMPOOL_STAT_ADD(mp, name, n) do {} while(0)
 270 #endif
 271
 272 /**
 273  * Calculate the size of the mempool header.
 274  *
 275  * @param mp
 276  *   Pointer to the memory pool.
 277  * @param cs
 278  *   Size of the per-lcore cache.
 279  */
 280 #define MEMPOOL_HEADER_SIZE(mp, cs) \
 281         (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
 282         (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
 283
 284 /* return the header of a mempool object (internal) */
 285 static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj)
 286 {
 287         return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
 288                 sizeof(struct rte_mempool_objhdr));
 289 }
 290
 291 /**
 292  * Return a pointer to the mempool owning this object.
 293  *
 294  * @param obj
 295  *   An object that is owned by a pool. If this is not the case,
 296  *   the behavior is undefined.
 297  * @return
 298  *   A pointer to the mempool structure.
 299  */
 300 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
 301 {
 302         struct rte_mempool_objhdr *hdr = __mempool_get_header(obj);
 303         return hdr->mp;
 304 }
 305
 306 /* return the trailer of a mempool object (internal) */
 307 static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj)
 308 {
 309         struct rte_mempool *mp = rte_mempool_from_obj(obj);
 310         return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
 311 }
 312
 313 /**
 314  * @internal Check and update cookies or panic.
 315  *
 316  * @param mp
 317  *   Pointer to the memory pool.
 318  * @param obj_table_const
 319  *   Pointer to a table of void * pointers (objects).
 320  * @param n
 321  *   Index of object in object table.
 322  * @param free
 323  *   - 0: object is supposed to be allocated, mark it as free
 324  *   - 1: object is supposed to be free, mark it as allocated
 325  *   - 2: just check that cookie is valid (free or allocated)
 326  */
 327 void rte_mempool_check_cookies(const struct rte_mempool *mp,
 328         void * const *obj_table_const, unsigned n, int free);
 329
 330 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 331 #define __mempool_check_cookies(mp, obj_table_const, n, free) \
 332         rte_mempool_check_cookies(mp, obj_table_const, n, free)
 333 #else
 334 #define __mempool_check_cookies(mp, obj_table_const, n, free) do {} while(0)
 335 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
 336
 337 #define RTE_MEMPOOL_OPS_NAMESIZE 32 /**< Max length of ops struct name. */
 338
 339 /**
 340  * Prototype for implementation specific data provisioning function.
 341  *
 342  * The function should provide the implementation specific memory for
 343  * use by the other mempool ops functions in a given mempool ops struct.
 344  * E.g. the default ops provides an instance of the rte_ring for this purpose.
 345  * it will most likely point to a different type of data structure, and
 346  * will be transparent to the application programmer.
 347  * This function should set mp->pool_data.
 348  */
 349 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
 350
 351 /**
 352  * Free the opaque private data pointed to by mp->pool_data pointer.
 353  */
 354 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
 355
 356 /**
 357  * Enqueue an object into the external pool.
 358  */
 359 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
 360                 void * const *obj_table, unsigned int n);
 361
 362 /**
 363  * Dequeue an object from the external pool.
 364  */
 365 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
 366                 void **obj_table, unsigned int n);
 367
 368 /**
 369  * Return the number of available objects in the external pool.
 370  */
 371 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
 372
 373 /**
 374  * Calculate memory size required to store given number of objects.
 375  *
 376  * If mempool objects are not required to be IOVA-contiguous
 377  * (the flag MEMPOOL_F_NO_IOVA_CONTIG is set), min_chunk_size defines
 378  * virtually contiguous chunk size. Otherwise, if mempool objects must
 379  * be IOVA-contiguous (the flag MEMPOOL_F_NO_IOVA_CONTIG is clear),
 380  * min_chunk_size defines IOVA-contiguous chunk size.
 381  *
 382  * @param[in] mp
 383  *   Pointer to the memory pool.
 384  * @param[in] obj_num
 385  *   Number of objects.
 386  * @param[in] pg_shift
 387  *   LOG2 of the physical pages size. If set to 0, ignore page boundaries.
 388  * @param[out] min_chunk_size
 389  *   Location for minimum size of the memory chunk which may be used to
 390  *   store memory pool objects.
 391  * @param[out] align
 392  *   Location for required memory chunk alignment.
 393  * @return
 394  *   Required memory size aligned at page boundary.
 395  */
 396 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
 397                 uint32_t obj_num,  uint32_t pg_shift,
 398                 size_t *min_chunk_size, size_t *align);
 399
 400 /**
 401  * Default way to calculate memory size required to store given number of
 402  * objects.
 403  *
 404  * If page boundaries may be ignored, it is just a product of total
 405  * object size including header and trailer and number of objects.
 406  * Otherwise, it is a number of pages required to store given number of
 407  * objects without crossing page boundary.
 408  *
 409  * Note that if object size is bigger than page size, then it assumes
 410  * that pages are grouped in subsets of physically continuous pages big
 411  * enough to store at least one object.
 412  *
 413  * Minimum size of memory chunk is a maximum of the page size and total
 414  * element size.
 415  *
 416  * Required memory chunk alignment is a maximum of page size and cache
 417  * line size.
 418  */
 419 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
 420                 uint32_t obj_num, uint32_t pg_shift,
 421                 size_t *min_chunk_size, size_t *align);
 422
 423 /**
 424  * @internal Helper function to calculate memory size required to store
 425  * specified number of objects in assumption that the memory buffer will
 426  * be aligned at page boundary.
 427  *
 428  * Note that if object size is bigger than page size, then it assumes
 429  * that pages are grouped in subsets of physically continuous pages big
 430  * enough to store at least one object.
 431  *
 432  * @param elt_num
 433  *   Number of elements.
 434  * @param total_elt_sz
 435  *   The size of each element, including header and trailer, as returned
 436  *   by rte_mempool_calc_obj_size().
 437  * @param pg_shift
 438  *   LOG2 of the physical pages size. If set to 0, ignore page boundaries.
 439  * @return
 440  *   Required memory size aligned at page boundary.
 441  */
 442 size_t rte_mempool_calc_mem_size_helper(uint32_t elt_num, size_t total_elt_sz,
 443                 uint32_t pg_shift);
 444
 445 /**
 446  * Function to be called for each populated object.
 447  *
 448  * @param[in] mp
 449  *   A pointer to the mempool structure.
 450  * @param[in] opaque
 451  *   An opaque pointer passed to iterator.
 452  * @param[in] vaddr
 453  *   Object virtual address.
 454  * @param[in] iova
 455  *   Input/output virtual address of the object or RTE_BAD_IOVA.
 456  */
 457 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
 458                 void *opaque, void *vaddr, rte_iova_t iova);
 459
 460 /**
 461  * Populate memory pool objects using provided memory chunk.
 462  *
 463  * Populated objects should be enqueued to the pool, e.g. using
 464  * rte_mempool_ops_enqueue_bulk().
 465  *
 466  * If the given IO address is unknown (iova = RTE_BAD_IOVA),
 467  * the chunk doesn't need to be physically contiguous (only virtually),
 468  * and allocated objects may span two pages.
 469  *
 470  * @param[in] mp
 471  *   A pointer to the mempool structure.
 472  * @param[in] max_objs
 473  *   Maximum number of objects to be populated.
 474  * @param[in] vaddr
 475  *   The virtual address of memory that should be used to store objects.
 476  * @param[in] iova
 477  *   The IO address
 478  * @param[in] len
 479  *   The length of memory in bytes.
 480  * @param[in] obj_cb
 481  *   Callback function to be executed for each populated object.
 482  * @param[in] obj_cb_arg
 483  *   An opaque pointer passed to the callback function.
 484  * @return
 485  *   The number of objects added on success.
 486  *   On error, no objects are populated and a negative errno is returned.
 487  */
 488 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
 489                 unsigned int max_objs,
 490                 void *vaddr, rte_iova_t iova, size_t len,
 491                 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
 492
 493 /**
 494  * Default way to populate memory pool object using provided memory
 495  * chunk: just slice objects one by one.
 496  */
 497 int rte_mempool_op_populate_default(struct rte_mempool *mp,
 498                 unsigned int max_objs,
 499                 void *vaddr, rte_iova_t iova, size_t len,
 500                 rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
 501
 502 /** Structure defining mempool operations structure */
 503 struct rte_mempool_ops {
 504         char name[RTE_MEMPOOL_OPS_NAMESIZE]; /**< Name of mempool ops struct. */
 505         rte_mempool_alloc_t alloc;       /**< Allocate private data. */
 506         rte_mempool_free_t free;         /**< Free the external pool. */
 507         rte_mempool_enqueue_t enqueue;   /**< Enqueue an object. */
 508         rte_mempool_dequeue_t dequeue;   /**< Dequeue an object. */
 509         rte_mempool_get_count get_count; /**< Get qty of available objs. */
 510         /**
 511          * Optional callback to calculate memory size required to
 512          * store specified number of objects.
 513          */
 514         rte_mempool_calc_mem_size_t calc_mem_size;
 515         /**
 516          * Optional callback to populate mempool objects using
 517          * provided memory chunk.
 518          */
 519         rte_mempool_populate_t populate;
 520 } __rte_cache_aligned;
 521
 522 #define RTE_MEMPOOL_MAX_OPS_IDX 16  /**< Max registered ops structs */
 523
 524 /**
 525  * Structure storing the table of registered ops structs, each of which contain
 526  * the function pointers for the mempool ops functions.
 527  * Each process has its own storage for this ops struct array so that
 528  * the mempools can be shared across primary and secondary processes.
 529  * The indices used to access the array are valid across processes, whereas
 530  * any function pointers stored directly in the mempool struct would not be.
 531  * This results in us simply having "ops_index" in the mempool struct.
 532  */
 533 struct rte_mempool_ops_table {
 534         rte_spinlock_t sl;     /**< Spinlock for add/delete. */
 535         uint32_t num_ops;      /**< Number of used ops structs in the table. */
 536         /**
 537          * Storage for all possible ops structs.
 538          */
 539         struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX];
 540 } __rte_cache_aligned;
 541
 542 /** Array of registered ops structs. */
 543 extern struct rte_mempool_ops_table rte_mempool_ops_table;
 544
 545 /**
 546  * @internal Get the mempool ops struct from its index.
 547  *
 548  * @param ops_index
 549  *   The index of the ops struct in the ops struct table. It must be a valid
 550  *   index: (0 <= idx < num_ops).
 551  * @return
 552  *   The pointer to the ops struct in the table.
 553  */
 554 static inline struct rte_mempool_ops *
 555 rte_mempool_get_ops(int ops_index)
 556 {
 557         RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
 558
 559         return &rte_mempool_ops_table.ops[ops_index];
 560 }
 561
 562 /**
 563  * @internal Wrapper for mempool_ops alloc callback.
 564  *
 565  * @param mp
 566  *   Pointer to the memory pool.
 567  * @return
 568  *   - 0: Success; successfully allocated mempool pool_data.
 569  *   - <0: Error; code of alloc function.
 570  */
 571 int
 572 rte_mempool_ops_alloc(struct rte_mempool *mp);
 573
 574 /**
 575  * @internal Wrapper for mempool_ops dequeue callback.
 576  *
 577  * @param mp
 578  *   Pointer to the memory pool.
 579  * @param obj_table
 580  *   Pointer to a table of void * pointers (objects).
 581  * @param n
 582  *   Number of objects to get.
 583  * @return
 584  *   - 0: Success; got n objects.
 585  *   - <0: Error; code of dequeue function.
 586  */
 587 static inline int
 588 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
 589                 void **obj_table, unsigned n)
 590 {
 591         struct rte_mempool_ops *ops;
 592
 593         ops = rte_mempool_get_ops(mp->ops_index);
 594         return ops->dequeue(mp, obj_table, n);
 595 }
 596
 597 /**
 598  * @internal wrapper for mempool_ops enqueue callback.
 599  *
 600  * @param mp
 601  *   Pointer to the memory pool.
 602  * @param obj_table
 603  *   Pointer to a table of void * pointers (objects).
 604  * @param n
 605  *   Number of objects to put.
 606  * @return
 607  *   - 0: Success; n objects supplied.
 608  *   - <0: Error; code of enqueue function.
 609  */
 610 static inline int
 611 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
 612                 unsigned n)
 613 {
 614         struct rte_mempool_ops *ops;
 615
 616         ops = rte_mempool_get_ops(mp->ops_index);
 617         return ops->enqueue(mp, obj_table, n);
 618 }
 619
 620 /**
 621  * @internal wrapper for mempool_ops get_count callback.
 622  *
 623  * @param mp
 624  *   Pointer to the memory pool.
 625  * @return
 626  *   The number of available objects in the external pool.
 627  */
 628 unsigned
 629 rte_mempool_ops_get_count(const struct rte_mempool *mp);
 630
 631 /**
 632  * @internal wrapper for mempool_ops calc_mem_size callback.
 633  * API to calculate size of memory required to store specified number of
 634  * object.
 635  *
 636  * @param[in] mp
 637  *   Pointer to the memory pool.
 638  * @param[in] obj_num
 639  *   Number of objects.
 640  * @param[in] pg_shift
 641  *   LOG2 of the physical pages size. If set to 0, ignore page boundaries.
 642  * @param[out] min_chunk_size
 643  *   Location for minimum size of the memory chunk which may be used to
 644  *   store memory pool objects.
 645  * @param[out] align
 646  *   Location for required memory chunk alignment.
 647  * @return
 648  *   Required memory size aligned at page boundary.
 649  */
 650 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
 651                                       uint32_t obj_num, uint32_t pg_shift,
 652                                       size_t *min_chunk_size, size_t *align);
 653
 654 /**
 655  * @internal wrapper for mempool_ops populate callback.
 656  *
 657  * Populate memory pool objects using provided memory chunk.
 658  *
 659  * @param[in] mp
 660  *   A pointer to the mempool structure.
 661  * @param[in] max_objs
 662  *   Maximum number of objects to be populated.
 663  * @param[in] vaddr
 664  *   The virtual address of memory that should be used to store objects.
 665  * @param[in] iova
 666  *   The IO address
 667  * @param[in] len
 668  *   The length of memory in bytes.
 669  * @param[in] obj_cb
 670  *   Callback function to be executed for each populated object.
 671  * @param[in] obj_cb_arg
 672  *   An opaque pointer passed to the callback function.
 673  * @return
 674  *   The number of objects added on success.
 675  *   On error, no objects are populated and a negative errno is returned.
 676  */
 677 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
 678                              void *vaddr, rte_iova_t iova, size_t len,
 679                              rte_mempool_populate_obj_cb_t *obj_cb,
 680                              void *obj_cb_arg);
 681
 682 /**
 683  * @internal wrapper for mempool_ops free callback.
 684  *
 685  * @param mp
 686  *   Pointer to the memory pool.
 687  */
 688 void
 689 rte_mempool_ops_free(struct rte_mempool *mp);
 690
 691 /**
 692  * Set the ops of a mempool.
 693  *
 694  * This can only be done on a mempool that is not populated, i.e. just after
 695  * a call to rte_mempool_create_empty().
 696  *
 697  * @param mp
 698  *   Pointer to the memory pool.
 699  * @param name
 700  *   Name of the ops structure to use for this mempool.
 701  * @param pool_config
 702  *   Opaque data that can be passed by the application to the ops functions.
 703  * @return
 704  *   - 0: Success; the mempool is now using the requested ops functions.
 705  *   - -EINVAL - Invalid ops struct name provided.
 706  *   - -EEXIST - mempool already has an ops struct assigned.
 707  */
 708 int
 709 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
 710                 void *pool_config);
 711
 712 /**
 713  * Register mempool operations.
 714  *
 715  * @param ops
 716  *   Pointer to an ops structure to register.
 717  * @return
 718  *   - >=0: Success; return the index of the ops struct in the table.
 719  *   - -EINVAL - some missing callbacks while registering ops struct.
 720  *   - -ENOSPC - the maximum number of ops structs has been reached.
 721  */
 722 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
 723
 724 /**
 725  * Macro to statically register the ops of a mempool handler.
 726  * Note that the rte_mempool_register_ops fails silently here when
 727  * more than RTE_MEMPOOL_MAX_OPS_IDX is registered.
 728  */
 729 #define MEMPOOL_REGISTER_OPS(ops)                                       \
 730         void mp_hdlr_init_##ops(void);                                  \
 731         void __attribute__((constructor, used)) mp_hdlr_init_##ops(void)\
 732         {                                                               \
 733                 rte_mempool_register_ops(&ops);                 \
 734         }
 735
 736 /**
 737  * An object callback function for mempool.
 738  *
 739  * Used by rte_mempool_create() and rte_mempool_obj_iter().
 740  */
 741 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
 742                 void *opaque, void *obj, unsigned obj_idx);
 743 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
 744
 745 /**
 746  * A memory callback function for mempool.
 747  *
 748  * Used by rte_mempool_mem_iter().
 749  */
 750 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
 751                 void *opaque, struct rte_mempool_memhdr *memhdr,
 752                 unsigned mem_idx);
 753
 754 /**
 755  * A mempool constructor callback function.
 756  *
 757  * Arguments are the mempool and the opaque pointer given by the user in
 758  * rte_mempool_create().
 759  */
 760 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
 761
 762 /**
 763  * Create a new mempool named *name* in memory.
 764  *
 765  * This function uses ``rte_memzone_reserve()`` to allocate memory. The
 766  * pool contains n elements of elt_size. Its size is set to n.
 767  *
 768  * @param name
 769  *   The name of the mempool.
 770  * @param n
 771  *   The number of elements in the mempool. The optimum size (in terms of
 772  *   memory usage) for a mempool is when n is a power of two minus one:
 773  *   n = (2^q - 1).
 774  * @param elt_size
 775  *   The size of each element.
 776  * @param cache_size
 777  *   If cache_size is non-zero, the rte_mempool library will try to
 778  *   limit the accesses to the common lockless pool, by maintaining a
 779  *   per-lcore object cache. This argument must be lower or equal to
 780  *   CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
 781  *   cache_size to have "n modulo cache_size == 0": if this is
 782  *   not the case, some elements will always stay in the pool and will
 783  *   never be used. The access to the per-lcore table is of course
 784  *   faster than the multi-producer/consumer pool. The cache can be
 785  *   disabled if the cache_size argument is set to 0; it can be useful to
 786  *   avoid losing objects in cache.
 787  * @param private_data_size
 788  *   The size of the private data appended after the mempool
 789  *   structure. This is useful for storing some private data after the
 790  *   mempool structure, as is done for rte_mbuf_pool for example.
 791  * @param mp_init
 792  *   A function pointer that is called for initialization of the pool,
 793  *   before object initialization. The user can initialize the private
 794  *   data in this function if needed. This parameter can be NULL if
 795  *   not needed.
 796  * @param mp_init_arg
 797  *   An opaque pointer to data that can be used in the mempool
 798  *   constructor function.
 799  * @param obj_init
 800  *   A function pointer that is called for each object at
 801  *   initialization of the pool. The user can set some meta data in
 802  *   objects if needed. This parameter can be NULL if not needed.
 803  *   The obj_init() function takes the mempool pointer, the init_arg,
 804  *   the object pointer and the object number as parameters.
 805  * @param obj_init_arg
 806  *   An opaque pointer to data that can be used as an argument for
 807  *   each call to the object constructor function.
 808  * @param socket_id
 809  *   The *socket_id* argument is the socket identifier in the case of
 810  *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
 811  *   constraint for the reserved zone.
 812  * @param flags
 813  *   The *flags* arguments is an OR of following flags:
 814  *   - MEMPOOL_F_NO_SPREAD: By default, objects addresses are spread
 815  *     between channels in RAM: the pool allocator will add padding
 816  *     between objects depending on the hardware configuration. See
 817  *     Memory alignment constraints for details. If this flag is set,
 818  *     the allocator will just align them to a cache line.
 819  *   - MEMPOOL_F_NO_CACHE_ALIGN: By default, the returned objects are
 820  *     cache-aligned. This flag removes this constraint, and no
 821  *     padding will be present between objects. This flag implies
 822  *     MEMPOOL_F_NO_SPREAD.
 823  *   - MEMPOOL_F_SP_PUT: If this flag is set, the default behavior
 824  *     when using rte_mempool_put() or rte_mempool_put_bulk() is
 825  *     "single-producer". Otherwise, it is "multi-producers".
 826  *   - MEMPOOL_F_SC_GET: If this flag is set, the default behavior
 827  *     when using rte_mempool_get() or rte_mempool_get_bulk() is
 828  *     "single-consumer". Otherwise, it is "multi-consumers".
 829  *   - MEMPOOL_F_NO_IOVA_CONTIG: If set, allocated objects won't
 830  *     necessarily be contiguous in IO memory.
 831  * @return
 832  *   The pointer to the new allocated mempool, on success. NULL on error
 833  *   with rte_errno set appropriately. Possible rte_errno values include:
 834  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
 835  *    - E_RTE_SECONDARY - function was called from a secondary process instance
 836  *    - EINVAL - cache size provided is too large
 837  *    - ENOSPC - the maximum number of memzones has already been allocated
 838  *    - EEXIST - a memzone with the same name already exists
 839  *    - ENOMEM - no appropriate memory area found in which to create memzone
 840  */
 841 struct rte_mempool *
 842 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
 843                    unsigned cache_size, unsigned private_data_size,
 844                    rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 845                    rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
 846                    int socket_id, unsigned flags);
 847
 848 /**
 849  * @deprecated
 850  * Create a new mempool named *name* in memory.
 851  *
 852  * The pool contains n elements of elt_size. Its size is set to n.
 853  * This function uses ``memzone_reserve()`` to allocate the mempool header
 854  * (and the objects if vaddr is NULL).
 855  * Depending on the input parameters, mempool elements can be either allocated
 856  * together with the mempool header, or an externally provided memory buffer
 857  * could be used to store mempool objects. In later case, that external
 858  * memory buffer can consist of set of disjoint physical pages.
 859  *
 860  * @param name
 861  *   The name of the mempool.
 862  * @param n
 863  *   The number of elements in the mempool. The optimum size (in terms of
 864  *   memory usage) for a mempool is when n is a power of two minus one:
 865  *   n = (2^q - 1).
 866  * @param elt_size
 867  *   The size of each element.
 868  * @param cache_size
 869  *   Size of the cache. See rte_mempool_create() for details.
 870  * @param private_data_size
 871  *   The size of the private data appended after the mempool
 872  *   structure. This is useful for storing some private data after the
 873  *   mempool structure, as is done for rte_mbuf_pool for example.
 874  * @param mp_init
 875  *   A function pointer that is called for initialization of the pool,
 876  *   before object initialization. The user can initialize the private
 877  *   data in this function if needed. This parameter can be NULL if
 878  *   not needed.
 879  * @param mp_init_arg
 880  *   An opaque pointer to data that can be used in the mempool
 881  *   constructor function.
 882  * @param obj_init
 883  *   A function called for each object at initialization of the pool.
 884  *   See rte_mempool_create() for details.
 885  * @param obj_init_arg
 886  *   An opaque pointer passed to the object constructor function.
 887  * @param socket_id
 888  *   The *socket_id* argument is the socket identifier in the case of
 889  *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
 890  *   constraint for the reserved zone.
 891  * @param flags
 892  *   Flags controlling the behavior of the mempool. See
 893  *   rte_mempool_create() for details.
 894  * @param vaddr
 895  *   Virtual address of the externally allocated memory buffer.
 896  *   Will be used to store mempool objects.
 897  * @param iova
 898  *   Array of IO addresses of the pages that comprises given memory buffer.
 899  * @param pg_num
 900  *   Number of elements in the iova array.
 901  * @param pg_shift
 902  *   LOG2 of the physical pages size.
 903  * @return
 904  *   The pointer to the new allocated mempool, on success. NULL on error
 905  *   with rte_errno set appropriately. See rte_mempool_create() for details.
 906  */
 907 __rte_deprecated
 908 struct rte_mempool *
 909 rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size,
 910                 unsigned cache_size, unsigned private_data_size,
 911                 rte_mempool_ctor_t *mp_init, void *mp_init_arg,
 912                 rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
 913                 int socket_id, unsigned flags, void *vaddr,
 914                 const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift);
 915
 916 /**
 917  * Create an empty mempool
 918  *
 919  * The mempool is allocated and initialized, but it is not populated: no
 920  * memory is allocated for the mempool elements. The user has to call
 921  * rte_mempool_populate_*() to add memory chunks to the pool. Once
 922  * populated, the user may also want to initialize each object with
 923  * rte_mempool_obj_iter().
 924  *
 925  * @param name
 926  *   The name of the mempool.
 927  * @param n
 928  *   The maximum number of elements that can be added in the mempool.
 929  *   The optimum size (in terms of memory usage) for a mempool is when n
 930  *   is a power of two minus one: n = (2^q - 1).
 931  * @param elt_size
 932  *   The size of each element.
 933  * @param cache_size
 934  *   Size of the cache. See rte_mempool_create() for details.
 935  * @param private_data_size
 936  *   The size of the private data appended after the mempool
 937  *   structure. This is useful for storing some private data after the
 938  *   mempool structure, as is done for rte_mbuf_pool for example.
 939  * @param socket_id
 940  *   The *socket_id* argument is the socket identifier in the case of
 941  *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
 942  *   constraint for the reserved zone.
 943  * @param flags
 944  *   Flags controlling the behavior of the mempool. See
 945  *   rte_mempool_create() for details.
 946  * @return
 947  *   The pointer to the new allocated mempool, on success. NULL on error
 948  *   with rte_errno set appropriately. See rte_mempool_create() for details.
 949  */
 950 struct rte_mempool *
 951 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
 952         unsigned cache_size, unsigned private_data_size,
 953         int socket_id, unsigned flags);
 954 /**
 955  * Free a mempool
 956  *
 957  * Unlink the mempool from global list, free the memory chunks, and all
 958  * memory referenced by the mempool. The objects must not be used by
 959  * other cores as they will be freed.
 960  *
 961  * @param mp
 962  *   A pointer to the mempool structure.
 963  */
 964 void
 965 rte_mempool_free(struct rte_mempool *mp);
 966
 967 /**
 968  * Add physically contiguous memory for objects in the pool at init
 969  *
 970  * Add a virtually and physically contiguous memory chunk in the pool
 971  * where objects can be instantiated.
 972  *
 973  * If the given IO address is unknown (iova = RTE_BAD_IOVA),
 974  * the chunk doesn't need to be physically contiguous (only virtually),
 975  * and allocated objects may span two pages.
 976  *
 977  * @param mp
 978  *   A pointer to the mempool structure.
 979  * @param vaddr
 980  *   The virtual address of memory that should be used to store objects.
 981  * @param iova
 982  *   The IO address
 983  * @param len
 984  *   The length of memory in bytes.
 985  * @param free_cb
 986  *   The callback used to free this chunk when destroying the mempool.
 987  * @param opaque
 988  *   An opaque argument passed to free_cb.
 989  * @return
 990  *   The number of objects added on success.
 991  *   On error, the chunk is not added in the memory list of the
 992  *   mempool and a negative errno is returned.
 993  */
 994 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
 995         rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
 996         void *opaque);
 997
 998 __rte_deprecated
 999 int rte_mempool_populate_phys(struct rte_mempool *mp, char *vaddr,
1000         phys_addr_t paddr, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1001         void *opaque);
1002
1003 /**
1004  * @deprecated
1005  * Add physical memory for objects in the pool at init
1006  *
1007  * Add a virtually contiguous memory chunk in the pool where objects can
1008  * be instantiated. The IO addresses corresponding to the virtual
1009  * area are described in iova[], pg_num, pg_shift.
1010  *
1011  * @param mp
1012  *   A pointer to the mempool structure.
1013  * @param vaddr
1014  *   The virtual address of memory that should be used to store objects.
1015  * @param iova
1016  *   An array of IO addresses of each page composing the virtual area.
1017  * @param pg_num
1018  *   Number of elements in the iova array.
1019  * @param pg_shift
1020  *   LOG2 of the physical pages size.
1021  * @param free_cb
1022  *   The callback used to free this chunk when destroying the mempool.
1023  * @param opaque
1024  *   An opaque argument passed to free_cb.
1025  * @return
1026  *   The number of objects added on success.
1027  *   On error, the chunks are not added in the memory list of the
1028  *   mempool and a negative errno is returned.
1029  */
1030 __rte_deprecated
1031 int rte_mempool_populate_iova_tab(struct rte_mempool *mp, char *vaddr,
1032         const rte_iova_t iova[], uint32_t pg_num, uint32_t pg_shift,
1033         rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1034
1035 __rte_deprecated
1036 int rte_mempool_populate_phys_tab(struct rte_mempool *mp, char *vaddr,
1037         const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift,
1038         rte_mempool_memchunk_free_cb_t *free_cb, void *opaque);
1039
1040 /**
1041  * Add virtually contiguous memory for objects in the pool at init
1042  *
1043  * Add a virtually contiguous memory chunk in the pool where objects can
1044  * be instantiated.
1045  *
1046  * @param mp
1047  *   A pointer to the mempool structure.
1048  * @param addr
1049  *   The virtual address of memory that should be used to store objects.
1050  *   Must be page-aligned.
1051  * @param len
1052  *   The length of memory in bytes. Must be page-aligned.
1053  * @param pg_sz
1054  *   The size of memory pages in this virtual area.
1055  * @param free_cb
1056  *   The callback used to free this chunk when destroying the mempool.
1057  * @param opaque
1058  *   An opaque argument passed to free_cb.
1059  * @return
1060  *   The number of objects added on success.
1061  *   On error, the chunk is not added in the memory list of the
1062  *   mempool and a negative errno is returned.
1063  */
1064 int
1065 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1066         size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1067         void *opaque);
1068
1069 /**
1070  * Add memory for objects in the pool at init
1071  *
1072  * This is the default function used by rte_mempool_create() to populate
1073  * the mempool. It adds memory allocated using rte_memzone_reserve().
1074  *
1075  * @param mp
1076  *   A pointer to the mempool structure.
1077  * @return
1078  *   The number of objects added on success.
1079  *   On error, the chunk is not added in the memory list of the
1080  *   mempool and a negative errno is returned.
1081  */
1082 int rte_mempool_populate_default(struct rte_mempool *mp);
1083
1084 /**
1085  * Add memory from anonymous mapping for objects in the pool at init
1086  *
1087  * This function mmap an anonymous memory zone that is locked in
1088  * memory to store the objects of the mempool.
1089  *
1090  * @param mp
1091  *   A pointer to the mempool structure.
1092  * @return
1093  *   The number of objects added on success.
1094  *   On error, the chunk is not added in the memory list of the
1095  *   mempool and a negative errno is returned.
1096  */
1097 int rte_mempool_populate_anon(struct rte_mempool *mp);
1098
1099 /**
1100  * Call a function for each mempool element
1101  *
1102  * Iterate across all objects attached to a rte_mempool and call the
1103  * callback function on it.
1104  *
1105  * @param mp
1106  *   A pointer to an initialized mempool.
1107  * @param obj_cb
1108  *   A function pointer that is called for each object.
1109  * @param obj_cb_arg
1110  *   An opaque pointer passed to the callback function.
1111  * @return
1112  *   Number of objects iterated.
1113  */
1114 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1115         rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1116
1117 /**
1118  * Call a function for each mempool memory chunk
1119  *
1120  * Iterate across all memory chunks attached to a rte_mempool and call
1121  * the callback function on it.
1122  *
1123  * @param mp
1124  *   A pointer to an initialized mempool.
1125  * @param mem_cb
1126  *   A function pointer that is called for each memory chunk.
1127  * @param mem_cb_arg
1128  *   An opaque pointer passed to the callback function.
1129  * @return
1130  *   Number of memory chunks iterated.
1131  */
1132 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1133         rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1134
1135 /**
1136  * Dump the status of the mempool to a file.
1137  *
1138  * @param f
1139  *   A pointer to a file for output
1140  * @param mp
1141  *   A pointer to the mempool structure.
1142  */
1143 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1144
1145 /**
1146  * Create a user-owned mempool cache.
1147  *
1148  * This can be used by non-EAL threads to enable caching when they
1149  * interact with a mempool.
1150  *
1151  * @param size
1152  *   The size of the mempool cache. See rte_mempool_create()'s cache_size
1153  *   parameter description for more information. The same limits and
1154  *   considerations apply here too.
1155  * @param socket_id
1156  *   The socket identifier in the case of NUMA. The value can be
1157  *   SOCKET_ID_ANY if there is no NUMA constraint for the reserved zone.
1158  */
1159 struct rte_mempool_cache *
1160 rte_mempool_cache_create(uint32_t size, int socket_id);
1161
1162 /**
1163  * Free a user-owned mempool cache.
1164  *
1165  * @param cache
1166  *   A pointer to the mempool cache.
1167  */
1168 void
1169 rte_mempool_cache_free(struct rte_mempool_cache *cache);
1170
1171 /**
1172  * Get a pointer to the per-lcore default mempool cache.
1173  *
1174  * @param mp
1175  *   A pointer to the mempool structure.
1176  * @param lcore_id
1177  *   The logical core id.
1178  * @return
1179  *   A pointer to the mempool cache or NULL if disabled or non-EAL thread.
1180  */
1181 static __rte_always_inline struct rte_mempool_cache *
1182 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1183 {
1184         if (mp->cache_size == 0)
1185                 return NULL;
1186
1187         if (lcore_id >= RTE_MAX_LCORE)
1188                 return NULL;
1189
1190         return &mp->local_cache[lcore_id];
1191 }
1192
1193 /**
1194  * Flush a user-owned mempool cache to the specified mempool.
1195  *
1196  * @param cache
1197  *   A pointer to the mempool cache.
1198  * @param mp
1199  *   A pointer to the mempool.
1200  */
1201 static __rte_always_inline void
1202 rte_mempool_cache_flush(struct rte_mempool_cache *cache,
1203                         struct rte_mempool *mp)
1204 {
1205         if (cache == NULL)
1206                 cache = rte_mempool_default_cache(mp, rte_lcore_id());
1207         if (cache == NULL || cache->len == 0)
1208                 return;
1209         rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1210         cache->len = 0;
1211 }
1212
1213 /**
1214  * @internal Put several objects back in the mempool; used internally.
1215  * @param mp
1216  *   A pointer to the mempool structure.
1217  * @param obj_table
1218  *   A pointer to a table of void * pointers (objects).
1219  * @param n
1220  *   The number of objects to store back in the mempool, must be strictly
1221  *   positive.
1222  * @param cache
1223  *   A pointer to a mempool cache structure. May be NULL if not needed.
1224  */
1225 static __rte_always_inline void
1226 __mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1227                       unsigned int n, struct rte_mempool_cache *cache)
1228 {
1229         void **cache_objs;
1230
1231         /* increment stat now, adding in mempool always success */
1232         __MEMPOOL_STAT_ADD(mp, put, n);
1233
1234         /* No cache provided or if put would overflow mem allocated for cache */
1235         if (unlikely(cache == NULL || n > RTE_MEMPOOL_CACHE_MAX_SIZE))
1236                 goto ring_enqueue;
1237
1238         cache_objs = &cache->objs[cache->len];
1239
1240         /*
1241          * The cache follows the following algorithm
1242          *   1. Add the objects to the cache
1243          *   2. Anything greater than the cache min value (if it crosses the
1244          *   cache flush threshold) is flushed to the ring.
1245          */
1246
1247         /* Add elements back into the cache */
1248         rte_memcpy(&cache_objs[0], obj_table, sizeof(void *) * n);
1249
1250         cache->len += n;
1251
1252         if (cache->len >= cache->flushthresh) {
1253                 rte_mempool_ops_enqueue_bulk(mp, &cache->objs[cache->size],
1254                                 cache->len - cache->size);
1255                 cache->len = cache->size;
1256         }
1257
1258         return;
1259
1260 ring_enqueue:
1261
1262         /* push remaining objects in ring */
1263 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1264         if (rte_mempool_ops_enqueue_bulk(mp, obj_table, n) < 0)
1265                 rte_panic("cannot put objects in mempool\n");
1266 #else
1267         rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1268 #endif
1269 }
1270
1271
1272 /**
1273  * Put several objects back in the mempool.
1274  *
1275  * @param mp
1276  *   A pointer to the mempool structure.
1277  * @param obj_table
1278  *   A pointer to a table of void * pointers (objects).
1279  * @param n
1280  *   The number of objects to add in the mempool from the obj_table.
1281  * @param cache
1282  *   A pointer to a mempool cache structure. May be NULL if not needed.
1283  */
1284 static __rte_always_inline void
1285 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1286                         unsigned int n, struct rte_mempool_cache *cache)
1287 {
1288         __mempool_check_cookies(mp, obj_table, n, 0);
1289         __mempool_generic_put(mp, obj_table, n, cache);
1290 }
1291
1292 /**
1293  * Put several objects back in the mempool.
1294  *
1295  * This function calls the multi-producer or the single-producer
1296  * version depending on the default behavior that was specified at
1297  * mempool creation time (see flags).
1298  *
1299  * @param mp
1300  *   A pointer to the mempool structure.
1301  * @param obj_table
1302  *   A pointer to a table of void * pointers (objects).
1303  * @param n
1304  *   The number of objects to add in the mempool from obj_table.
1305  */
1306 static __rte_always_inline void
1307 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1308                      unsigned int n)
1309 {
1310         struct rte_mempool_cache *cache;
1311         cache = rte_mempool_default_cache(mp, rte_lcore_id());
1312         rte_mempool_generic_put(mp, obj_table, n, cache);
1313 }
1314
1315 /**
1316  * Put one object back in the mempool.
1317  *
1318  * This function calls the multi-producer or the single-producer
1319  * version depending on the default behavior that was specified at
1320  * mempool creation time (see flags).
1321  *
1322  * @param mp
1323  *   A pointer to the mempool structure.
1324  * @param obj
1325  *   A pointer to the object to be added.
1326  */
1327 static __rte_always_inline void
1328 rte_mempool_put(struct rte_mempool *mp, void *obj)
1329 {
1330         rte_mempool_put_bulk(mp, &obj, 1);
1331 }
1332
1333 /**
1334  * @internal Get several objects from the mempool; used internally.
1335  * @param mp
1336  *   A pointer to the mempool structure.
1337  * @param obj_table
1338  *   A pointer to a table of void * pointers (objects).
1339  * @param n
1340  *   The number of objects to get, must be strictly positive.
1341  * @param cache
1342  *   A pointer to a mempool cache structure. May be NULL if not needed.
1343  * @return
1344  *   - >=0: Success; number of objects supplied.
1345  *   - <0: Error; code of ring dequeue function.
1346  */
1347 static __rte_always_inline int
1348 __mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1349                       unsigned int n, struct rte_mempool_cache *cache)
1350 {
1351         int ret;
1352         uint32_t index, len;
1353         void **cache_objs;
1354
1355         /* No cache provided or cannot be satisfied from cache */
1356         if (unlikely(cache == NULL || n >= cache->size))
1357                 goto ring_dequeue;
1358
1359         cache_objs = cache->objs;
1360
1361         /* Can this be satisfied from the cache? */
1362         if (cache->len < n) {
1363                 /* No. Backfill the cache first, and then fill from it */
1364                 uint32_t req = n + (cache->size - cache->len);
1365
1366                 /* How many do we require i.e. number to fill the cache + the request */
1367                 ret = rte_mempool_ops_dequeue_bulk(mp,
1368                         &cache->objs[cache->len], req);
1369                 if (unlikely(ret < 0)) {
1370                         /*
1371                          * In the offchance that we are buffer constrained,
1372                          * where we are not able to allocate cache + n, go to
1373                          * the ring directly. If that fails, we are truly out of
1374                          * buffers.
1375                          */
1376                         goto ring_dequeue;
1377                 }
1378
1379                 cache->len += req;
1380         }
1381
1382         /* Now fill in the response ... */
1383         for (index = 0, len = cache->len - 1; index < n; ++index, len--, obj_table++)
1384                 *obj_table = cache_objs[len];
1385
1386         cache->len -= n;
1387
1388         __MEMPOOL_STAT_ADD(mp, get_success, n);
1389
1390         return 0;
1391
1392 ring_dequeue:
1393
1394         /* get remaining objects from ring */
1395         ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, n);
1396
1397         if (ret < 0)
1398                 __MEMPOOL_STAT_ADD(mp, get_fail, n);
1399         else
1400                 __MEMPOOL_STAT_ADD(mp, get_success, n);
1401
1402         return ret;
1403 }
1404
1405 /**
1406  * Get several objects from the mempool.
1407  *
1408  * If cache is enabled, objects will be retrieved first from cache,
1409  * subsequently from the common pool. Note that it can return -ENOENT when
1410  * the local cache and common pool are empty, even if cache from other
1411  * lcores are full.
1412  *
1413  * @param mp
1414  *   A pointer to the mempool structure.
1415  * @param obj_table
1416  *   A pointer to a table of void * pointers (objects) that will be filled.
1417  * @param n
1418  *   The number of objects to get from mempool to obj_table.
1419  * @param cache
1420  *   A pointer to a mempool cache structure. May be NULL if not needed.
1421  * @return
1422  *   - 0: Success; objects taken.
1423  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1424  */
1425 static __rte_always_inline int
1426 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1427                         unsigned int n, struct rte_mempool_cache *cache)
1428 {
1429         int ret;
1430         ret = __mempool_generic_get(mp, obj_table, n, cache);
1431         if (ret == 0)
1432                 __mempool_check_cookies(mp, obj_table, n, 1);
1433         return ret;
1434 }
1435
1436 /**
1437  * Get several objects from the mempool.
1438  *
1439  * This function calls the multi-consumers or the single-consumer
1440  * version, depending on the default behaviour that was specified at
1441  * mempool creation time (see flags).
1442  *
1443  * If cache is enabled, objects will be retrieved first from cache,
1444  * subsequently from the common pool. Note that it can return -ENOENT when
1445  * the local cache and common pool are empty, even if cache from other
1446  * lcores are full.
1447  *
1448  * @param mp
1449  *   A pointer to the mempool structure.
1450  * @param obj_table
1451  *   A pointer to a table of void * pointers (objects) that will be filled.
1452  * @param n
1453  *   The number of objects to get from the mempool to obj_table.
1454  * @return
1455  *   - 0: Success; objects taken
1456  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1457  */
1458 static __rte_always_inline int
1459 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1460 {
1461         struct rte_mempool_cache *cache;
1462         cache = rte_mempool_default_cache(mp, rte_lcore_id());
1463         return rte_mempool_generic_get(mp, obj_table, n, cache);
1464 }
1465
1466 /**
1467  * Get one object from the mempool.
1468  *
1469  * This function calls the multi-consumers or the single-consumer
1470  * version, depending on the default behavior that was specified at
1471  * mempool creation (see flags).
1472  *
1473  * If cache is enabled, objects will be retrieved first from cache,
1474  * subsequently from the common pool. Note that it can return -ENOENT when
1475  * the local cache and common pool are empty, even if cache from other
1476  * lcores are full.
1477  *
1478  * @param mp
1479  *   A pointer to the mempool structure.
1480  * @param obj_p
1481  *   A pointer to a void * pointer (object) that will be filled.
1482  * @return
1483  *   - 0: Success; objects taken.
1484  *   - -ENOENT: Not enough entries in the mempool; no object is retrieved.
1485  */
1486 static __rte_always_inline int
1487 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1488 {
1489         return rte_mempool_get_bulk(mp, obj_p, 1);
1490 }
1491
1492 /**
1493  * Return the number of entries in the mempool.
1494  *
1495  * When cache is enabled, this function has to browse the length of
1496  * all lcores, so it should not be used in a data path, but only for
1497  * debug purposes. User-owned mempool caches are not accounted for.
1498  *
1499  * @param mp
1500  *   A pointer to the mempool structure.
1501  * @return
1502  *   The number of entries in the mempool.
1503  */
1504 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1505
1506 /**
1507  * Return the number of elements which have been allocated from the mempool
1508  *
1509  * When cache is enabled, this function has to browse the length of
1510  * all lcores, so it should not be used in a data path, but only for
1511  * debug purposes.
1512  *
1513  * @param mp
1514  *   A pointer to the mempool structure.
1515  * @return
1516  *   The number of free entries in the mempool.
1517  */
1518 unsigned int
1519 rte_mempool_in_use_count(const struct rte_mempool *mp);
1520
1521 /**
1522  * Test if the mempool is full.
1523  *
1524  * When cache is enabled, this function has to browse the length of all
1525  * lcores, so it should not be used in a data path, but only for debug
1526  * purposes. User-owned mempool caches are not accounted for.
1527  *
1528  * @param mp
1529  *   A pointer to the mempool structure.
1530  * @return
1531  *   - 1: The mempool is full.
1532  *   - 0: The mempool is not full.
1533  */
1534 static inline int
1535 rte_mempool_full(const struct rte_mempool *mp)
1536 {
1537         return !!(rte_mempool_avail_count(mp) == mp->size);
1538 }
1539
1540 /**
1541  * Test if the mempool is empty.
1542  *
1543  * When cache is enabled, this function has to browse the length of all
1544  * lcores, so it should not be used in a data path, but only for debug
1545  * purposes. User-owned mempool caches are not accounted for.
1546  *
1547  * @param mp
1548  *   A pointer to the mempool structure.
1549  * @return
1550  *   - 1: The mempool is empty.
1551  *   - 0: The mempool is not empty.
1552  */
1553 static inline int
1554 rte_mempool_empty(const struct rte_mempool *mp)
1555 {
1556         return !!(rte_mempool_avail_count(mp) == 0);
1557 }
1558
1559 /**
1560  * Return the IO address of elt, which is an element of the pool mp.
1561  *
1562  * @param elt
1563  *   A pointer (virtual address) to the element of the pool.
1564  * @return
1565  *   The IO address of the elt element.
1566  *   If the mempool was created with MEMPOOL_F_NO_IOVA_CONTIG, the
1567  *   returned value is RTE_BAD_IOVA.
1568  */
1569 static inline rte_iova_t
1570 rte_mempool_virt2iova(const void *elt)
1571 {
1572         const struct rte_mempool_objhdr *hdr;
1573         hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1574                 sizeof(*hdr));
1575         return hdr->iova;
1576 }
1577
1578 __rte_deprecated
1579 static inline phys_addr_t
1580 rte_mempool_virt2phy(__rte_unused const struct rte_mempool *mp, const void *elt)
1581 {
1582         return rte_mempool_virt2iova(elt);
1583 }
1584
1585 /**
1586  * Check the consistency of mempool objects.
1587  *
1588  * Verify the coherency of fields in the mempool structure. Also check
1589  * that the cookies of mempool objects (even the ones that are not
1590  * present in pool) have a correct value. If not, a panic will occur.
1591  *
1592  * @param mp
1593  *   A pointer to the mempool structure.
1594  */
1595 void rte_mempool_audit(struct rte_mempool *mp);
1596
1597 /**
1598  * Return a pointer to the private data in an mempool structure.
1599  *
1600  * @param mp
1601  *   A pointer to the mempool structure.
1602  * @return
1603  *   A pointer to the private data.
1604  */
1605 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1606 {
1607         return (char *)mp +
1608                 MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1609 }
1610
1611 /**
1612  * Dump the status of all mempools on the console
1613  *
1614  * @param f
1615  *   A pointer to a file for output
1616  */
1617 void rte_mempool_list_dump(FILE *f);
1618
1619 /**
1620  * Search a mempool from its name
1621  *
1622  * @param name
1623  *   The name of the mempool.
1624  * @return
1625  *   The pointer to the mempool matching the name, or NULL if not found.
1626  *   NULL on error
1627  *   with rte_errno set appropriately. Possible rte_errno values include:
1628  *    - ENOENT - required entry not available to return.
1629  *
1630  */
1631 struct rte_mempool *rte_mempool_lookup(const char *name);
1632
1633 /**
1634  * Get the header, trailer and total size of a mempool element.
1635  *
1636  * Given a desired size of the mempool element and mempool flags,
1637  * calculates header, trailer, body and total sizes of the mempool object.
1638  *
1639  * @param elt_size
1640  *   The size of each element, without header and trailer.
1641  * @param flags
1642  *   The flags used for the mempool creation.
1643  *   Consult rte_mempool_create() for more information about possible values.
1644  *   The size of each element.
1645  * @param sz
1646  *   The calculated detailed size the mempool object. May be NULL.
1647  * @return
1648  *   Total size of the mempool object.
1649  */
1650 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1651         struct rte_mempool_objsz *sz);
1652
1653 /**
1654  * @deprecated
1655  * Get the size of memory required to store mempool elements.
1656  *
1657  * Calculate the maximum amount of memory required to store given number
1658  * of objects. Assume that the memory buffer will be aligned at page
1659  * boundary.
1660  *
1661  * Note that if object size is bigger than page size, then it assumes
1662  * that pages are grouped in subsets of physically continuous pages big
1663  * enough to store at least one object.
1664  *
1665  * @param elt_num
1666  *   Number of elements.
1667  * @param total_elt_sz
1668  *   The size of each element, including header and trailer, as returned
1669  *   by rte_mempool_calc_obj_size().
1670  * @param pg_shift
1671  *   LOG2 of the physical pages size. If set to 0, ignore page boundaries.
1672  * @param flags
1673  *  The mempool flags.
1674  * @return
1675  *   Required memory size aligned at page boundary.
1676  */
1677 __rte_deprecated
1678 size_t rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz,
1679         uint32_t pg_shift, unsigned int flags);
1680
1681 /**
1682  * @deprecated
1683  * Get the size of memory required to store mempool elements.
1684  *
1685  * Calculate how much memory would be actually required with the given
1686  * memory footprint to store required number of objects.
1687  *
1688  * @param vaddr
1689  *   Virtual address of the externally allocated memory buffer.
1690  *   Will be used to store mempool objects.
1691  * @param elt_num
1692  *   Number of elements.
1693  * @param total_elt_sz
1694  *   The size of each element, including header and trailer, as returned
1695  *   by rte_mempool_calc_obj_size().
1696  * @param iova
1697  *   Array of IO addresses of the pages that comprises given memory buffer.
1698  * @param pg_num
1699  *   Number of elements in the iova array.
1700  * @param pg_shift
1701  *   LOG2 of the physical pages size.
1702  * @param flags
1703  *  The mempool flags.
1704  * @return
1705  *   On success, the number of bytes needed to store given number of
1706  *   objects, aligned to the given page size. If the provided memory
1707  *   buffer is too small, return a negative value whose absolute value
1708  *   is the actual number of elements that can be stored in that buffer.
1709  */
1710 __rte_deprecated
1711 ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num,
1712         size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
1713         uint32_t pg_shift, unsigned int flags);
1714
1715 /**
1716  * Walk list of all memory pools
1717  *
1718  * @param func
1719  *   Iterator function
1720  * @param arg
1721  *   Argument passed to iterator
1722  */
1723 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1724                       void *arg);
1725
1726 #ifdef __cplusplus
1727 }
1728 #endif
1729
1730 #endif /* _RTE_MEMPOOL_H_ */