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