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