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