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