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