* rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
* thread due to the internal per-lcore cache. Due to the lack of caching,
* rte_mempool_get() or rte_mempool_put() performance will suffer when called
- * by non-EAL threads. Instead, non-EAL threads should call
- * rte_mempool_generic_get() or rte_mempool_generic_put() with a user cache
- * created with rte_mempool_cache_create().
+ * by unregistered non-EAL threads. Instead, unregistered non-EAL threads
+ * should call rte_mempool_generic_get() or rte_mempool_generic_put() with a
+ * user cache created with rte_mempool_cache_create().
*/
#include <stdio.h>
struct rte_mempool_objhdr {
STAILQ_ENTRY(rte_mempool_objhdr) next; /**< Next in list. */
struct rte_mempool *mp; /**< The mempool owning the object. */
- RTE_STD_C11
- union {
- rte_iova_t iova; /**< IO address of the object. */
- phys_addr_t physaddr; /**< deprecated - Physical address of the object. */
- };
+ rte_iova_t iova; /**< IO address of the object. */
#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
uint64_t cookie; /**< Debug cookie. */
#endif
STAILQ_ENTRY(rte_mempool_memhdr) next; /**< Next in list. */
struct rte_mempool *mp; /**< The mempool owning the chunk */
void *addr; /**< Virtual address of the chunk */
- RTE_STD_C11
- union {
- rte_iova_t iova; /**< IO address of the chunk */
- phys_addr_t phys_addr; /**< Physical address of the chunk */
- };
+ rte_iova_t iova; /**< IO address of the chunk */
size_t len; /**< length of the chunk */
rte_mempool_memchunk_free_cb_t *free_cb; /**< Free callback */
void *opaque; /**< Argument passed to the free callback */
};
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* Additional information about the mempool
*
* The structure is cache-line aligned to avoid ABI breakages in
#define MEMPOOL_F_SC_GET 0x0008 /**< Default get is "single-consumer".*/
#define MEMPOOL_F_POOL_CREATED 0x0010 /**< Internal: pool is created. */
#define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
-#define MEMPOOL_F_NO_PHYS_CONTIG MEMPOOL_F_NO_IOVA_CONTIG /* deprecated */
/**
* @internal When debug is enabled, store some statistics.
#endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* @internal Check contiguous object blocks and update cookies or panic.
*
* @param mp
void **obj_table, unsigned int n);
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* Dequeue a number of contiguous object blocks from the external pool.
*/
typedef int (*rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp,
size_t *min_chunk_size, size_t *align);
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* @internal Helper to calculate memory size required to store given
* number of objects.
*
* @return
* Required memory size.
*/
-__rte_experimental
ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
size_t *min_chunk_size, size_t *align);
#define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* @internal Helper to populate memory pool object using provided memory
* chunk: just slice objects one by one, taking care of not
* crossing page boundaries.
* @return
* The number of objects added in mempool.
*/
-__rte_experimental
int rte_mempool_op_populate_helper(struct rte_mempool *mp,
unsigned int flags, unsigned int max_objs,
void *vaddr, rte_iova_t iova, size_t len,
rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* Get some additional information about a mempool.
*/
typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
void *obj_cb_arg);
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* Wrapper for mempool_ops get_info callback.
*
* @param[in] mp
* mempool information
* - -ENOTSUP - doesn't support get_info ops (valid case).
*/
-__rte_experimental
int rte_mempool_ops_get_info(const struct rte_mempool *mp,
struct rte_mempool_info *info);
* If cache_size is non-zero, the rte_mempool library will try to
* limit the accesses to the common lockless pool, by maintaining a
* per-lcore object cache. This argument must be lower or equal to
- * CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
+ * RTE_MEMPOOL_CACHE_MAX_SIZE and n / 1.5. It is advised to choose
* cache_size to have "n modulo cache_size == 0": if this is
* not the case, some elements will always stay in the pool and will
* never be used. The access to the per-lcore table is of course
* @param opaque
* An opaque argument passed to free_cb.
* @return
- * The number of objects added on success.
+ * The number of objects added on success (strictly positive).
* On error, the chunk is not added in the memory list of the
- * mempool and a negative errno is returned.
+ * mempool the following code is returned:
+ * (0): not enough room in chunk for one object.
+ * (-ENOSPC): mempool is already populated.
+ * (-ENOMEM): allocation failure.
*/
int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
* @param opaque
* An opaque argument passed to free_cb.
* @return
- * The number of objects added on success.
+ * The number of objects added on success (strictly positive).
* On error, the chunk is not added in the memory list of the
- * mempool and a negative errno is returned.
+ * mempool the following code is returned:
+ * (0): not enough room in chunk for one object.
+ * (-ENOSPC): mempool is already populated.
+ * (-ENOMEM): allocation failure.
*/
int
rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
/**
* Create a user-owned mempool cache.
*
- * This can be used by non-EAL threads to enable caching when they
+ * This can be used by unregistered non-EAL threads to enable caching when they
* interact with a mempool.
*
* @param size
* @param lcore_id
* The logical core id.
* @return
- * A pointer to the mempool cache or NULL if disabled or non-EAL thread.
+ * A pointer to the mempool cache or NULL if disabled or unregistered non-EAL
+ * thread.
*/
static __rte_always_inline struct rte_mempool_cache *
rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
}
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* Get a contiguous blocks of objects from the mempool.
*
* If cache is enabled, consider to flush it first, to reuse objects
* - -EOPNOTSUPP: The mempool driver does not support block dequeue
*/
static __rte_always_inline int
-__rte_experimental
rte_mempool_get_contig_blocks(struct rte_mempool *mp,
void **first_obj_table, unsigned int n)
{
void *arg);
/**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice.
- *
* @internal Get page size used for mempool object allocation.
* This function is internal to mempool library and mempool drivers.
*/
-__rte_experimental
int
rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
git.droids-corp.org / dpdk.git / blobdiff