mempool: introduce helpers for populate and required size
authorOlivier Matz <olivier.matz@6wind.com>
Tue, 5 Nov 2019 15:37:04 +0000 (16:37 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 6 Nov 2019 10:11:13 +0000 (11:11 +0100)
Introduce new functions that can used by mempool drivers to
calculate required memory size and to populate mempool.

For now, these helpers just replace the *_default() functions
without change. They will be enhanced in next commit.

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Nipun Gupta <nipun.gupta@nxp.com>
Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com>
14 files changed:
drivers/mempool/bucket/Makefile
drivers/mempool/bucket/meson.build
drivers/mempool/bucket/rte_mempool_bucket.c
drivers/mempool/dpaa/dpaa_mempool.c
drivers/mempool/dpaa2/dpaa2_hw_mempool.c
drivers/mempool/octeontx/Makefile
drivers/mempool/octeontx/meson.build
drivers/mempool/octeontx/rte_mempool_octeontx.c
drivers/mempool/octeontx2/Makefile
drivers/mempool/octeontx2/meson.build
drivers/mempool/octeontx2/otx2_mempool_ops.c
lib/librte_mempool/rte_mempool.h
lib/librte_mempool/rte_mempool_ops_default.c
lib/librte_mempool/rte_mempool_version.map

index 7364916..d6660b0 100644 (file)
@@ -15,6 +15,7 @@ LIB = librte_mempool_bucket.a
 
 CFLAGS += -O3
 CFLAGS += $(WERROR_FLAGS)
+CFLAGS += -DALLOW_EXPERIMENTAL_API
 
 LDLIBS += -lrte_eal -lrte_mempool -lrte_ring
 
index 618d791..2fd77f9 100644 (file)
@@ -6,4 +6,6 @@
 # This software was jointly developed between OKTET Labs (under contract
 # for Solarflare) and Solarflare Communications, Inc.
 
+allow_experimental_apis = true
+
 sources = files('rte_mempool_bucket.c')
index 78d2b9d..dfeaf4e 100644 (file)
@@ -585,7 +585,7 @@ bucket_populate(struct rte_mempool *mp, unsigned int max_objs,
 
                hdr->fill_cnt = 0;
                hdr->lcore_id = LCORE_ID_ANY;
-               rc = rte_mempool_op_populate_default(mp,
+               rc = rte_mempool_op_populate_helper(mp,
                                                     RTE_MIN(bd->obj_per_bucket,
                                                             max_objs - n_objs),
                                                     iter + bucket_header_sz,
index a25697f..27736e6 100644 (file)
@@ -341,7 +341,7 @@ dpaa_populate(struct rte_mempool *mp, unsigned int max_objs,
         */
        TAILQ_INSERT_HEAD(&rte_dpaa_memsegs, ms, next);
 
-       return rte_mempool_op_populate_default(mp, max_objs, vaddr, paddr, len,
+       return rte_mempool_op_populate_helper(mp, max_objs, vaddr, paddr, len,
                                               obj_cb, obj_cb_arg);
 }
 
index cc4f837..2ecbb10 100644 (file)
@@ -432,7 +432,7 @@ dpaa2_populate(struct rte_mempool *mp, unsigned int max_objs,
        /* Insert entry into the PA->VA Table */
        dpaax_iova_table_update(paddr, vaddr, len);
 
-       return rte_mempool_op_populate_default(mp, max_objs, vaddr, paddr, len,
+       return rte_mempool_op_populate_helper(mp, max_objs, vaddr, paddr, len,
                                               obj_cb, obj_cb_arg);
 }
 
index a3e1dce..25efc5c 100644 (file)
@@ -11,6 +11,8 @@ LIB = librte_mempool_octeontx.a
 
 CFLAGS += $(WERROR_FLAGS)
 CFLAGS += -I$(RTE_SDK)/drivers/common/octeontx/
+CFLAGS += -DALLOW_EXPERIMENTAL_API
+
 EXPORT_MAP := rte_mempool_octeontx_version.map
 
 LIBABIVER := 1
index 3baaf7d..1954359 100644 (file)
@@ -1,6 +1,8 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright(c) 2017 Cavium, Inc
 
+allow_experimental_apis = true
+
 sources = files('octeontx_fpavf.c',
                'rte_mempool_octeontx.c'
 )
index ab94dfe..fff33e5 100644 (file)
@@ -137,7 +137,7 @@ octeontx_fpavf_calc_mem_size(const struct rte_mempool *mp,
         * Simply need space for one more object to be able to
         * fulfil alignment requirements.
         */
-       mem_size = rte_mempool_op_calc_mem_size_default(mp, obj_num + 1,
+       mem_size = rte_mempool_op_calc_mem_size_helper(mp, obj_num + 1,
                                                        pg_shift,
                                                        min_chunk_size, align);
        if (mem_size >= 0) {
@@ -184,7 +184,7 @@ octeontx_fpavf_populate(struct rte_mempool *mp, unsigned int max_objs,
        if (ret < 0)
                return ret;
 
-       return rte_mempool_op_populate_default(mp, max_objs, vaddr, iova, len,
+       return rte_mempool_op_populate_helper(mp, max_objs, vaddr, iova, len,
                                               obj_cb, obj_cb_arg);
 }
 
index 87cce22..4961a4a 100644 (file)
@@ -23,6 +23,8 @@ CFLAGS += -diag-disable 2259
 endif
 endif
 
+CFLAGS += -DALLOW_EXPERIMENTAL_API
+
 EXPORT_MAP := rte_mempool_octeontx2_version.map
 
 LIBABIVER := 1
index 9fde40f..8255377 100644 (file)
@@ -2,6 +2,8 @@
 # Copyright(C) 2019 Marvell International Ltd.
 #
 
+allow_experimental_apis = true
+
 sources = files('otx2_mempool_ops.c',
                'otx2_mempool.c',
                'otx2_mempool_irq.c',
index d769575..3aea92a 100644 (file)
@@ -717,7 +717,7 @@ otx2_npa_calc_mem_size(const struct rte_mempool *mp, uint32_t obj_num,
         * Simply need space for one more object to be able to
         * fulfill alignment requirements.
         */
-       return rte_mempool_op_calc_mem_size_default(mp, obj_num + 1, pg_shift,
+       return rte_mempool_op_calc_mem_size_helper(mp, obj_num + 1, pg_shift,
                                                    min_chunk_size, align);
 }
 
@@ -749,7 +749,7 @@ otx2_npa_populate(struct rte_mempool *mp, unsigned int max_objs, void *vaddr,
        if (npa_lf_aura_range_update_check(mp->pool_id) < 0)
                return -EBUSY;
 
-       return rte_mempool_op_populate_default(mp, max_objs, vaddr, iova, len,
+       return rte_mempool_op_populate_helper(mp, max_objs, vaddr, iova, len,
                                               obj_cb, obj_cb_arg);
 }
 
index 9e41f59..ad7cc6a 100644 (file)
@@ -465,8 +465,13 @@ typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
                size_t *min_chunk_size, size_t *align);
 
 /**
- * Default way to calculate memory size required to store given number of
- * objects.
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * @internal Helper to calculate memory size required to store given
+ * number of objects.
+ *
+ * This function is internal to mempool library and mempool drivers.
  *
  * If page boundaries may be ignored, it is just a product of total
  * object size including header and trailer and number of objects.
@@ -479,6 +484,32 @@ typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
  *
  * Minimum size of memory chunk is the total element size.
  * Required memory chunk alignment is the cache line size.
+ *
+ * @param[in] mp
+ *   A pointer to the mempool structure.
+ * @param[in] obj_num
+ *   Number of objects to be added in mempool.
+ * @param[in] pg_shift
+ *   LOG2 of the physical pages size. If set to 0, ignore page boundaries.
+ * @param[out] min_chunk_size
+ *   Location for minimum size of the memory chunk which may be used to
+ *   store memory pool objects.
+ * @param[out] align
+ *   Location for required memory chunk alignment.
+ * @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 *min_chunk_size, size_t *align);
+
+/**
+ * Default way to calculate memory size required to store given number of
+ * objects.
+ *
+ * Equivalent to rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
+ * min_chunk_size, align).
  */
 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
                uint32_t obj_num, uint32_t pg_shift,
@@ -533,8 +564,42 @@ typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
                rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
 
 /**
- * Default way to populate memory pool object using provided memory
+ * @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.
+ *
+ * This function is internal to mempool library and mempool drivers.
+ *
+ * @param[in] mp
+ *   A pointer to the mempool structure.
+ * @param[in] max_objs
+ *   Maximum number of objects to be added in mempool.
+ * @param[in] vaddr
+ *   The virtual address of memory that should be used to store objects.
+ * @param[in] iova
+ *   The IO address corresponding to vaddr, or RTE_BAD_IOVA.
+ * @param[in] len
+ *   The length of memory in bytes.
+ * @param[in] obj_cb
+ *   Callback function to be executed for each populated object.
+ * @param[in] obj_cb_arg
+ *   An opaque pointer passed to the callback function.
+ * @return
+ *   The number of objects added in mempool.
+ */
+__rte_experimental
+int rte_mempool_op_populate_helper(struct rte_mempool *mp,
+               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);
+
+/**
+ * Default way to populate memory pool object using provided memory chunk.
+ *
+ * Equivalent to rte_mempool_op_populate_helper(mp, max_objs, vaddr, iova,
+ * len, obj_cb, obj_cb_arg).
  */
 int rte_mempool_op_populate_default(struct rte_mempool *mp,
                unsigned int max_objs,
index f6aea76..0bfc634 100644 (file)
@@ -7,9 +7,9 @@
 #include <rte_mempool.h>
 
 ssize_t
-rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
-                                    uint32_t obj_num, uint32_t pg_shift,
-                                    size_t *min_chunk_size, size_t *align)
+rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
+                               uint32_t obj_num, uint32_t pg_shift,
+                               size_t *min_chunk_size, size_t *align)
 {
        size_t total_elt_sz;
        size_t obj_per_page, pg_sz, objs_in_last_page;
@@ -61,10 +61,19 @@ rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
        return mem_size;
 }
 
+ssize_t
+rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
+                               uint32_t obj_num, uint32_t pg_shift,
+                               size_t *min_chunk_size, size_t *align)
+{
+       return rte_mempool_op_calc_mem_size_helper(mp, obj_num, pg_shift,
+                                               min_chunk_size, align);
+}
+
 int
-rte_mempool_op_populate_default(struct rte_mempool *mp, 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)
+rte_mempool_op_populate_helper(struct rte_mempool *mp, 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)
 {
        size_t total_elt_sz;
        size_t off;
@@ -84,3 +93,13 @@ rte_mempool_op_populate_default(struct rte_mempool *mp, unsigned int max_objs,
 
        return i;
 }
+
+int
+rte_mempool_op_populate_default(struct rte_mempool *mp, 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)
+{
+       return rte_mempool_op_populate_helper(mp, max_objs, vaddr, iova,
+                                       len, obj_cb, obj_cb_arg);
+}
index aa75cf0..ce9e791 100644 (file)
@@ -61,4 +61,6 @@ EXPERIMENTAL {
 
        # added in 19.11
        rte_mempool_get_page_size;
+       rte_mempool_op_calc_mem_size_helper;
+       rte_mempool_op_populate_helper;
 };