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