lib/librte_mempool/rte_mempool.h

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