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