lib/librte_mempool/rte_mempool.h

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