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