[PATCH v15 4/6] test/memarea: support alloc and free API test
This patch supports rte_memarea_alloc() and rte_memarea_free() API
test.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
app/test/test_memarea.c | 214 +++-
1 file changed, 213 insertions(+), 1 deletion(-)
diff --git a/app/test/test_memarea.c b/app/test/test_memarea.c
index 90117caa38..2e13b7431e 100644
--- a/app/test/test_memarea.c
+++ b/app/test/test_memarea.c
@@ -23,6 +23,12 @@ test_memarea_init_param(struct rte_memarea_param *init)
init->mt_safe = 1;
}
+static void
+test_memarea_fill_region(void *ptr, size_t size)
+{
+ memset(ptr, 0xff, size);
+}
+
static int
test_memarea_create_bad_param(void)
{
@@ -78,7 +84,7 @@ test_memarea_create_bad_param(void)
static int
test_memarea_create_destroy(void)
{
- struct rte_memarea *ma;
+ struct rte_memarea *ma, *src_ma;
struct rte_memarea_param init;
rte_errno = 0;
@@ -98,6 +104,207 @@ test_memarea_create_destroy(void)
TEST_ASSERT(ma != NULL, "Expected Non-NULL");
rte_memarea_destroy(ma);
+ /* test for create with another memarea */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ src_ma = rte_memarea_create(&init);
+ TEST_ASSERT(src_ma != NULL, "Expected Non-NULL");
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_MEMAREA;
+ init.total_sz = init.total_sz >> 1;
+ init.ma.src = src_ma;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+ rte_memarea_destroy(ma);
+ rte_memarea_destroy(src_ma);
+
+ TEST_ASSERT(rte_errno == 0, "Expected ZERO");
+
+ return 0;
+}
+
+static int
+test_memarea_alloc_bad_param(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ size_t size;
+ void *ptr;
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+
+ /* test for invalid ma */
+ ptr = rte_memarea_alloc(NULL, 1);
+ TEST_ASSERT(ptr == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid size (size = 0) */
+ ptr = rte_memarea_alloc(ma, 0);
+ TEST_ASSERT(ptr == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid size (size rewind) */
+ memset(&size, 0xff, sizeof(size));
+ ptr = rte_memarea_alloc(ma, size);
+ TEST_ASSERT(ptr == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ rte_memarea_destroy(ma);
+
+ return 0;
+}
+
+static int
+test_memarea_free_bad_param(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ void *ptr;
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+ ptr = rte_memarea_alloc(ma, 1);
+ TEST_ASSERT(ptr != NULL, "Expected Non-NULL");
+ test_memarea_fill_region(ptr, 1);
+
+ /* test for invalid ma */
+ rte_memarea_free(NULL, ptr);
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid ptr */
+ rte_memarea_free(ma, NULL);
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ rte_memarea_destroy(ma);
+
+ return 0;
+}
+
+static int
+test_memarea_alloc_fail(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ void *ptr[2];
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+
+ /* test alloc fail with big size */
+ ptr[0] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE);
+ TEST_ASSERT(ptr[0] == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == ENOMEM, "Expected ENOMEM");
+
+ /* test alloc fail because no memory */
+ ptr[0] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ TEST_ASSERT(ptr[0] != NULL, "Expected Non-NULL");
+ test_memarea_fill_region(ptr[0], MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ ptr[1] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ TEST_ASSERT(ptr[1] == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == ENOMEM, "Expected ENOMEM");
+ rte_memarea_free(ma, ptr[0]);
+
+ /* test alloc fail when second fail */
+ ptr[0] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ TEST_ASSERT(ptr[0] != NULL, "Expected Non-NULL");
+ test_memarea_fill_region(ptr[0], MEMAREA_TEST_DEFAULT_SIZ
[PATCH v15 2/6] test/memarea: support memarea test
This patch supports memarea test of rte_memarea_create() and
rte_memarea_destroy() API.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
MAINTAINERS | 1 +
app/test/meson.build| 2 +
app/test/test_memarea.c | 122
3 files changed, 125 insertions(+)
create mode 100644 app/test/test_memarea.c
diff --git a/MAINTAINERS b/MAINTAINERS
index 93de0876f1..cc082ae821 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1616,6 +1616,7 @@ Memarea - EXPERIMENTAL
M: Chengwen Feng
F: lib/memarea
F: doc/guides/prog_guide/memarea_lib.rst
+F: app/test/test_memarea*
Membership - EXPERIMENTAL
M: Yipeng Wang
diff --git a/app/test/meson.build b/app/test/meson.build
index 3e0a2360a3..5e3012328d 100644
--- a/app/test/meson.build
+++ b/app/test/meson.build
@@ -83,6 +83,7 @@ test_sources = files(
'test_malloc.c',
'test_malloc_perf.c',
'test_mbuf.c',
+'test_memarea.c',
'test_member.c',
'test_member_perf.c',
'test_memcpy.c',
@@ -200,6 +201,7 @@ fast_tests = [
['malloc_autotest', false, true],
['mbuf_autotest', false, true],
['mcslock_autotest', false, true],
+['memarea_autotest', true, true],
['memcpy_autotest', true, true],
['memory_autotest', false, true],
['mempool_autotest', false, true],
diff --git a/app/test/test_memarea.c b/app/test/test_memarea.c
new file mode 100644
index 00..90117caa38
--- /dev/null
+++ b/app/test/test_memarea.c
@@ -0,0 +1,122 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2023 HiSilicon Limited
+ */
+
+#include
+#include
+
+#include
+#include
+#include
+
+#include "test.h"
+
+#define MEMAREA_TEST_DEFAULT_SIZE 0x1000
+
+static void
+test_memarea_init_param(struct rte_memarea_param *init)
+{
+ memset(init, 0, sizeof(struct rte_memarea_param));
+ sprintf(init->name, "%s", "autotest");
+ init->source = RTE_MEMAREA_SOURCE_LIBC;
+ init->total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ init->mt_safe = 1;
+}
+
+static int
+test_memarea_create_bad_param(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+
+ /* test for NULL */
+ ma = rte_memarea_create(NULL);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid name */
+ memset(&init, 0, sizeof(init));
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+ memset(&init.name, 1, sizeof(init.name));
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid source */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_MEMAREA + 1;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for total_sz */
+ test_memarea_init_param(&init);
+ init.total_sz = 0;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for memarea NULL */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_MEMAREA;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for algorithm invalid */
+ test_memarea_init_param(&init);
+ init.alg = RTE_MEMAREA_ALGORITHM_NEXTFIT + 1;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ return 0;
+}
+
+static int
+test_memarea_create_destroy(void)
+{
+ struct rte_memarea *ma;
+ struct rte_memarea_param init;
+
+ rte_errno = 0;
+
+ /* test for create with HEAP */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_HEAP;
+ init.heap.socket_id = SOCKET_ID_ANY;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+ rte_memarea_destroy(ma);
+
+ /* test for create with LIBC */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+ rte_memarea_destroy(ma);
+
+ return 0;
+}
+
+static struct unit_test_suite memarea_test_suite = {
+ .suite_name = "Memarea Unit Test Suite",
+ .setup = NULL,
+ .teardown = NULL,
+ .unit_test_cases = {
+ TEST_CASE(test_memarea_create_bad_param),
+ TEST_CASE(test_memarea_create_destro
[PATCH v15 6/6] test/memarea: support dump API test
This patch supports rte_memarea_dump() API test.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
app/test/test_memarea.c | 40
1 file changed, 40 insertions(+)
diff --git a/app/test/test_memarea.c b/app/test/test_memarea.c
index 2e13b7431e..b373bce309 100644
--- a/app/test/test_memarea.c
+++ b/app/test/test_memarea.c
@@ -303,6 +303,45 @@ test_memarea_alloc_free(void)
TEST_ASSERT(rte_errno == 0, "Expected Zero");
+ fprintf(stderr, "There should have no allocated object.\n");
+ rte_memarea_dump(ma, stderr, true);
+
+ rte_memarea_destroy(ma);
+
+ return 0;
+}
+
+static int
+test_memarea_dump(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ int ret;
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+
+ /* test for invalid parameters */
+ ret = rte_memarea_dump(NULL, stderr, false);
+ TEST_ASSERT(ret == -1, "Expected -1");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+ ret = rte_memarea_dump(ma, NULL, false);
+ TEST_ASSERT(ret == -1, "Expected -1");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for dump */
+ (void)rte_memarea_alloc(ma, 1);
+ (void)rte_memarea_alloc(ma, 1);
+ (void)rte_memarea_alloc(ma, 1);
+ (void)rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE);
+ (void)rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE);
+ fprintf(stderr, "There should have three allocated object.\n");
+ ret = rte_memarea_dump(ma, stderr, true);
+ TEST_ASSERT(ret == 0, "Expected ZERO");
+
rte_memarea_destroy(ma);
return 0;
@@ -320,6 +359,7 @@ static struct unit_test_suite memarea_test_suite = {
TEST_CASE(test_memarea_alloc_fail),
TEST_CASE(test_memarea_free_fail),
TEST_CASE(test_memarea_alloc_free),
+ TEST_CASE(test_memarea_dump),
TEST_CASES_END() /**< NULL terminate unit test array */
}
--
2.17.1
[PATCH v15 0/6] introduce memarea library
The memarea library is an allocator of variable-size object which based on a memory region. The main features are as follows: - The memory region can be initialized from the following memory sources: 1. HEAP: e.g. invoke rte_malloc_socket. 2. LIBC: e.g. invoke posix_memalign. 3. Another memarea: it can be from another memarea. - It supports MT-safe as long as it's specified at creation time. Note: a) The memarea is oriented towards the application layer, which could provides 'region-based memory management' [1] function. b) The eal library also provide memory zone/heap management, but these are tied to huge pages management. [1] https://en.wikipedia.org/wiki/Region-based_memory_management Chengwen Feng (6): memarea: introduce memarea library test/memarea: support memarea test memarea: support alloc and free API test/memarea: support alloc and free API test memarea: support dump API test/memarea: support dump API test --- v15: * rebase 23.07 * address Anatoly's mostly comments: use rte_errno, abstract cookie helper, more comment about critical function, rename add with split, doc limitation. v14: * address Stephen's comments: RTE_MEMAREA_LOG use easy impl and add __func__ print. v13: * address Morten's comments: make debug cookies optional, controlled by RTE_LIBRTE_MEMAREA_DEBUG; disabled by default. * reduce management data overhead. v12: * remove rte_memarea_refcnt_update() API which address Dongdong's comments. * refine the variable naming. * fix some bugs. v11: * rebase 23.03 * remove "app/test: add memarea to malloc-perf-autotest" because the two algorithm are not comparable which also address previous comments. v10: * support windows platform. * add rte_memarea.libc perftest to malloc-perf-autotest. v9: * address Dmitry's comments. * drop features of SOURCE_USER and backup memarea mechanism. * rename rte_memarea_update_refcnt to rte_memarea_refcnt_update to keep with rte_mbuf_refcnt_update name style. * fix memarea perftest compile failed at windows platform. * fix spell warning. v8: * address Mattias's comments (rename ALG_DEFAULT with ALG_NEXTFIT). * small feature patches are combined. * enhanced backup memory mechanism. * add memarea to malloc-perf-autotest. * other tiny naming optimize. v7: * repost patches as there are spread over different series in patchwork. v6: * address Mattias's comments. v5: * fix 09/10 patch spell warning. v4: * repost patches as there are spread over different series in patchwork. v3: * add memory source of RTE memory. * add algorithm field to facilitate the introduction of new algorithms. * fix memarea log don't output problem. v2: * fix compile issues reported by dpdk-test-report. * address Dimitry and Jerin's comments. * add no MT-safe test. MAINTAINERS| 6 + app/test/meson.build | 2 + app/test/test_memarea.c| 374 +++ doc/api/doxy-api-index.md | 3 +- doc/api/doxy-api.conf.in | 1 + doc/guides/prog_guide/index.rst| 1 + doc/guides/prog_guide/memarea_lib.rst | 57 +++ doc/guides/rel_notes/release_23_07.rst | 6 + lib/memarea/memarea_private.h | 96 + lib/memarea/meson.build| 10 + lib/memarea/rte_memarea.c | 479 + lib/memarea/rte_memarea.h | 202 +++ lib/memarea/version.map| 15 + lib/meson.build| 1 + 14 files changed, 1252 insertions(+), 1 deletion(-) create mode 100644 app/test/test_memarea.c create mode 100644 doc/guides/prog_guide/memarea_lib.rst create mode 100644 lib/memarea/memarea_private.h create mode 100644 lib/memarea/meson.build create mode 100644 lib/memarea/rte_memarea.c create mode 100644 lib/memarea/rte_memarea.h create mode 100644 lib/memarea/version.map -- 2.17.1
[PATCH v15 1/6] memarea: introduce memarea library
The memarea library is an allocator of variable-size object which based on a memory region. This patch provides rte_memarea_create() and rte_memarea_destroy() API. Signed-off-by: Chengwen Feng Reviewed-by: Dongdong Liu Acked-by: Morten Brørup --- MAINTAINERS| 5 + doc/api/doxy-api-index.md | 3 +- doc/api/doxy-api.conf.in | 1 + doc/guides/prog_guide/index.rst| 1 + doc/guides/prog_guide/memarea_lib.rst | 48 ++ doc/guides/rel_notes/release_23_07.rst | 6 + lib/memarea/memarea_private.h | 86 ++ lib/memarea/meson.build| 10 ++ lib/memarea/rte_memarea.c | 215 + lib/memarea/rte_memarea.h | 137 lib/memarea/version.map| 12 ++ lib/meson.build| 1 + 12 files changed, 524 insertions(+), 1 deletion(-) create mode 100644 doc/guides/prog_guide/memarea_lib.rst create mode 100644 lib/memarea/memarea_private.h create mode 100644 lib/memarea/meson.build create mode 100644 lib/memarea/rte_memarea.c create mode 100644 lib/memarea/rte_memarea.h create mode 100644 lib/memarea/version.map diff --git a/MAINTAINERS b/MAINTAINERS index 1c3be16a91..93de0876f1 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1612,6 +1612,11 @@ F: app/test/test_lpm* F: app/test/test_func_reentrancy.c F: app/test/test_xmmt_ops.h +Memarea - EXPERIMENTAL +M: Chengwen Feng +F: lib/memarea +F: doc/guides/prog_guide/memarea_lib.rst + Membership - EXPERIMENTAL M: Yipeng Wang M: Sameh Gobriel diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index 3bc8778981..5c32913f92 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -65,7 +65,8 @@ The public API headers are grouped by topics: [memzone](@ref rte_memzone.h), [mempool](@ref rte_mempool.h), [malloc](@ref rte_malloc.h), - [memcpy](@ref rte_memcpy.h) + [memcpy](@ref rte_memcpy.h), + [memarea](@ref rte_memarea.h) - **timers**: [cycles](@ref rte_cycles.h), diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index 1a4210b948..1f35d8483e 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -54,6 +54,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/lib/latencystats \ @TOPDIR@/lib/lpm \ @TOPDIR@/lib/mbuf \ + @TOPDIR@/lib/memarea \ @TOPDIR@/lib/member \ @TOPDIR@/lib/mempool \ @TOPDIR@/lib/meter \ diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst index d89cd3edb6..aa8eebe256 100644 --- a/doc/guides/prog_guide/index.rst +++ b/doc/guides/prog_guide/index.rst @@ -38,6 +38,7 @@ Programmer's Guide hash_lib toeplitz_hash_lib efd_lib +memarea_lib member_lib lpm_lib lpm6_lib diff --git a/doc/guides/prog_guide/memarea_lib.rst b/doc/guides/prog_guide/memarea_lib.rst new file mode 100644 index 00..bf19090294 --- /dev/null +++ b/doc/guides/prog_guide/memarea_lib.rst @@ -0,0 +1,48 @@ +.. SPDX-License-Identifier: BSD-3-Clause +Copyright(c) 2023 HiSilicon Limited + +Memarea Library +=== + +Introduction + + +The memarea library provides an allocator of variable-size objects, it is +oriented towards the application layer, providing 'region-based memory +management' function [1]. + +The main features are as follows: + +* The memory region can be initialized from the following memory sources: + + - HEAP: e.g. invoke ``rte_malloc_socket``. + + - LIBC: e.g. invoke posix_memalign. + + - Another memarea: it can be allocated from another memarea. + +* It supports MT-safe as long as it's specified at creation time. + +* The address returned by the allocator is align to 8B. + +Library API Overview + + +The ``rte_memarea_create()`` function is used to create a memarea, the function +returns the pointer to the created memarea or ``NULL`` if the creation failed. + +The ``rte_memarea_destroy()`` function is used to destroy a memarea. + +Debug Mode +-- + +In debug mode, cookies are added at the beginning and end of objects, it will +help debugging buffer overflows. + +Debug mode is disabled by default, but can be enabled by setting +``RTE_LIBRTE_MEMAREA_DEBUG`` in ``config/rte_config.h``. + +Reference +- + +[1] https://en.wikipedia.org/wiki/Region-based_memory_management diff --git a/doc/guides/rel_notes/release_23_07.rst b/doc/guides/rel_notes/release_23_07.rst index dcfd692425..ccef40e8cb 100644 --- a/doc/guides/rel_notes/release_23_07.rst +++ b/doc/guides/rel_notes/release_23_07.rst @@ -206,6 +206,12 @@ New Features See the :doc:`../tools/dmaperf` for more details. +* **Added memarea library.** + + The memarea library is an allocator of variable-size obj
[PATCH v15 5/6] memarea: support dump API
This patch supports rte_memarea_dump() API which could be used for
debug.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
Acked-by: Anatoly Burakov
---
doc/guides/prog_guide/memarea_lib.rst | 3 +
lib/memarea/rte_memarea.c | 100 ++
lib/memarea/rte_memarea.h | 21 ++
lib/memarea/version.map | 1 +
4 files changed, 125 insertions(+)
diff --git a/doc/guides/prog_guide/memarea_lib.rst
b/doc/guides/prog_guide/memarea_lib.rst
index 157baf3c7e..ef22294664 100644
--- a/doc/guides/prog_guide/memarea_lib.rst
+++ b/doc/guides/prog_guide/memarea_lib.rst
@@ -39,6 +39,9 @@ the memarea.
The ``rte_memarea_free()`` function is used to free one memory object which
allocated by ``rte_memarea_alloc()``.
++The ``rte_memarea_dump()`` function is used to dump the internal information
++of a memarea.
+
Debug Mode
--
diff --git a/lib/memarea/rte_memarea.c b/lib/memarea/rte_memarea.c
index 393068f008..83d31af61c 100644
--- a/lib/memarea/rte_memarea.c
+++ b/lib/memarea/rte_memarea.c
@@ -377,3 +377,103 @@ rte_memarea_free(struct rte_memarea *ma, void *ptr)
memarea_unlock(ma);
}
+
+static const char *
+memarea_source_name(enum rte_memarea_source source)
+{
+ if (source == RTE_MEMAREA_SOURCE_HEAP)
+ return "heap";
+ else if (source == RTE_MEMAREA_SOURCE_LIBC)
+ return "libc";
+ else if (source == RTE_MEMAREA_SOURCE_MEMAREA)
+ return "memarea";
+ else
+ return "unknown";
+}
+
+static const char *
+memarea_alg_name(enum rte_memarea_algorithm alg)
+{
+ if (alg == RTE_MEMAREA_ALGORITHM_NEXTFIT)
+ return "nextfit";
+ else
+ return "unknown";
+}
+
+static void
+memarea_dump_objects_brief(struct rte_memarea *ma, FILE *f)
+{
+ uint32_t total_objs = 0, total_avail_objs = 0;
+ struct memarea_objhdr *hdr;
+ size_t total_avail_sz = 0;
+
+ TAILQ_FOREACH(hdr, &ma->obj_list, obj_next) {
+ if (hdr == ma->guard_hdr)
+ break;
+ memarea_check_cookie(ma, hdr, 2);
+ total_objs++;
+ if (!MEMAREA_OBJECT_IS_ALLOCATED(hdr)) {
+ total_avail_objs++;
+ total_avail_sz += MEMAREA_OBJECT_GET_SIZE(hdr);
+ }
+ }
+ fprintf(f, " total-objects: %u\n", total_objs);
+ fprintf(f, " total-avail-objects: %u\n", total_avail_objs);
+ fprintf(f, " total-avail-objects-size: 0x%zx\n", total_avail_sz);
+}
+
+static void
+memarea_dump_objects_detail(struct rte_memarea *ma, FILE *f)
+{
+ struct memarea_objhdr *hdr;
+ size_t offset;
+ void *ptr;
+
+ fprintf(f, " objects:\n");
+ TAILQ_FOREACH(hdr, &ma->obj_list, obj_next) {
+ if (hdr == ma->guard_hdr)
+ break;
+ memarea_check_cookie(ma, hdr, 2);
+ ptr = RTE_PTR_ADD(hdr, sizeof(struct memarea_objhdr));
+ offset = RTE_PTR_DIFF(ptr, ma->area_base);
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+ fprintf(f, "%p off: 0x%zx size: 0x%zx %s\n",
+ ptr, offset, MEMAREA_OBJECT_GET_SIZE(hdr),
+ MEMAREA_OBJECT_IS_ALLOCATED(hdr) ? "allocated" : "");
+#else
+ fprintf(f, "off: 0x%zx size: 0x%zx %s\n",
+ offset, MEMAREA_OBJECT_GET_SIZE(hdr),
+ MEMAREA_OBJECT_IS_ALLOCATED(hdr) ? "allocated" : "");
+#endif
+ }
+}
+
+int
+rte_memarea_dump(struct rte_memarea *ma, FILE *f, bool dump_all)
+{
+ if (ma == NULL || f == NULL) {
+ rte_errno = EINVAL;
+ return -1;
+ }
+
+ memarea_lock(ma);
+ fprintf(f, "memarea name: %s\n", ma->init.name);
+ fprintf(f, " source: %s\n", memarea_source_name(ma->init.source));
+ if (ma->init.source == RTE_MEMAREA_SOURCE_HEAP)
+ fprintf(f, " heap-numa-socket: %d\n", ma->init.heap.socket_id);
+ else if (ma->init.source == RTE_MEMAREA_SOURCE_MEMAREA)
+ fprintf(f, " source-memarea: %s\n",
ma->init.ma.src->init.name);
+ fprintf(f, " algorithm: %s\n", memarea_alg_name(ma->init.alg));
+ fprintf(f, " total-size: 0x%zx\n", ma->init.total_sz);
+ fprintf(f, " mt-safe: %s\n", ma->init.mt_safe ? "yes" : "no");
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+ fprintf(f, " area-base: %p\n", ma->area_base);
+ fprintf(f, " guard-header: %p\n", ma->guard_hdr);
+#endif
+ memarea_dump_objects_brief(ma, f);
+ if (dump_all)
+ memarea_dump_objects_detail(ma, f);
+ memarea_unlock(ma);
+
+ return 0;
+}
diff --git a/lib/memarea/rte_memarea.h b/lib/memarea/rte_memarea.h
index f11add0bcf..8092436d57 100644
--- a/lib/memarea/rte_memarea.h
+++ b/lib/memarea/rte_memarea.h
@@ -174,6 +174,27 @@ void *rte_memarea_alloc(struct rte_memarea *ma, size_t
[PATCH v15 3/6] memarea: support alloc and free API
This patch supports rte_memarea_alloc() and rte_memarea_free() API.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
doc/guides/prog_guide/memarea_lib.rst | 6 +
lib/memarea/memarea_private.h | 10 ++
lib/memarea/rte_memarea.c | 164 ++
lib/memarea/rte_memarea.h | 44 +++
lib/memarea/version.map | 2 +
5 files changed, 226 insertions(+)
diff --git a/doc/guides/prog_guide/memarea_lib.rst
b/doc/guides/prog_guide/memarea_lib.rst
index bf19090294..157baf3c7e 100644
--- a/doc/guides/prog_guide/memarea_lib.rst
+++ b/doc/guides/prog_guide/memarea_lib.rst
@@ -33,6 +33,12 @@ returns the pointer to the created memarea or ``NULL`` if
the creation failed.
The ``rte_memarea_destroy()`` function is used to destroy a memarea.
+The ``rte_memarea_alloc()`` function is used to alloc one memory object from
+the memarea.
+
+The ``rte_memarea_free()`` function is used to free one memory object which
+allocated by ``rte_memarea_alloc()``.
+
Debug Mode
--
diff --git a/lib/memarea/memarea_private.h b/lib/memarea/memarea_private.h
index 61dc518777..43286e413d 100644
--- a/lib/memarea/memarea_private.h
+++ b/lib/memarea/memarea_private.h
@@ -22,10 +22,20 @@
#define MEMAREA_OBJECT_GET_SIZE(hdr) \
((uintptr_t)TAILQ_NEXT((hdr), obj_next) - (uintptr_t)(hdr) - \
sizeof(struct memarea_objhdr) - sizeof(struct memarea_objtlr))
+#define MEMAREA_SPLIT_OBJECT_MIN_SIZE \
+ (sizeof(struct memarea_objhdr) + MEMAREA_OBJECT_SIZE_ALIGN + \
+sizeof(struct memarea_objtlr))
+#define MEMAREA_SPLIT_OBJECT_GET_HEADER(hdr, alloc_sz) \
+ RTE_PTR_ADD(hdr, sizeof(struct memarea_objhdr) + alloc_sz + \
+ sizeof(struct memarea_objtlr))
#else
#define MEMAREA_OBJECT_GET_SIZE(hdr) \
((uintptr_t)TAILQ_NEXT((hdr), obj_next) - (uintptr_t)(hdr) - \
sizeof(struct memarea_objhdr))
+#define MEMAREA_SPLIT_OBJECT_MIN_SIZE \
+ (sizeof(struct memarea_objhdr) + MEMAREA_OBJECT_SIZE_ALIGN)
+#define MEMAREA_SPLIT_OBJECT_GET_HEADER(hdr, alloc_sz) \
+ RTE_PTR_ADD(hdr, sizeof(struct memarea_objhdr) + alloc_sz)
#endif
struct memarea_objhdr {
diff --git a/lib/memarea/rte_memarea.c b/lib/memarea/rte_memarea.c
index 70ac08a572..393068f008 100644
--- a/lib/memarea/rte_memarea.c
+++ b/lib/memarea/rte_memarea.c
@@ -2,8 +2,10 @@
* Copyright(c) 2023 HiSilicon Limited
*/
+#include
#include
#include
+#include
#include
#include
@@ -88,6 +90,8 @@ memarea_alloc_area(const struct rte_memarea_param *init)
init->heap.socket_id);
else if (init->source == RTE_MEMAREA_SOURCE_LIBC)
ptr = memarea_alloc_from_libc(init->total_sz);
+ else if (init->source == RTE_MEMAREA_SOURCE_MEMAREA)
+ ptr = rte_memarea_alloc(init->ma.src, init->total_sz);
return ptr;
}
@@ -99,6 +103,8 @@ memarea_free_area(const struct rte_memarea_param *init, void
*ptr)
rte_free(ptr);
else if (init->source == RTE_MEMAREA_SOURCE_LIBC)
free(ptr);
+ else if (init->source == RTE_MEMAREA_SOURCE_MEMAREA)
+ rte_memarea_free(init->ma.src, ptr);
}
/**
@@ -213,3 +219,161 @@ rte_memarea_destroy(struct rte_memarea *ma)
memarea_free_area(&ma->init, ma->area_base);
rte_free(ma);
}
+
+static inline void
+memarea_lock(struct rte_memarea *ma)
+{
+ if (ma->init.mt_safe)
+ rte_spinlock_lock(&ma->lock);
+}
+
+static inline void
+memarea_unlock(struct rte_memarea *ma)
+{
+ if (ma->init.mt_safe)
+ rte_spinlock_unlock(&ma->lock);
+}
+
+/**
+ * Check cookie or panic.
+ *
+ * @param status
+ * - 0: object is supposed to be available.
+ * - 1: object is supposed to be allocated.
+ * - 2: just check that cookie is valid (available or allocated).
+ */
+static inline void
+memarea_check_cookie(const struct rte_memarea *ma, const struct memarea_objhdr
*hdr, int status)
+{
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+ static const char *const str[] = { "PASS", "FAILED" };
+ struct memarea_objtlr *tlr;
+ bool hdr_fail, tlr_fail;
+
+ if (hdr == ma->guard_hdr)
+ return;
+
+ tlr = RTE_PTR_SUB(TAILQ_NEXT(hdr, obj_next), sizeof(struct
memarea_objtlr));
+ hdr_fail = (status == 0 && hdr->cookie !=
MEMAREA_OBJECT_HEADER_AVAILABLE_COOKIE) ||
+ (status == 1 && hdr->cookie !=
MEMAREA_OBJECT_HEADER_ALLOCATED_COOKIE) ||
+ (status == 2 && (hdr->cookie !=
MEMAREA_OBJECT_HEADER_AVAILABLE_COOKIE &&
+ hdr->cookie !=
MEMAREA_OBJECT_HEADER_ALLOCATED_COOKIE));
+ tlr_fail = (tlr->cookie != MEMAREA_OBJECT_TRAILER_COOKIE);
+ if (!hdr_fail && !tlr_fail)
+ return;
+
+ rte_panic("MEMAREA: %s check cookies failed
[PATCH] net/mlx5/hws: add support for multi pattern
When creating an action it can contain a bulk of objects,
but the objects are fixed to a specific pattern and cannot
be reused. This can lead to inefficient usage of the HW resources,
This support allows creating multiple patterns over a single
mlx5dr action.
Signed-off-by: Alex Vesker
Reviewed-by: Erez Shitrit
Acked-by: Matan Azrad
---
drivers/net/mlx5/hws/mlx5dr.h | 45 ++-
drivers/net/mlx5/hws/mlx5dr_action.c | 538 +++---
drivers/net/mlx5/hws/mlx5dr_action.h | 8 +-
drivers/net/mlx5/hws/mlx5dr_pat_arg.c | 252 +---
drivers/net/mlx5/hws/mlx5dr_pat_arg.h | 34 +-
drivers/net/mlx5/mlx5_flow_hw.c | 11 +-
6 files changed, 483 insertions(+), 405 deletions(-)
diff --git a/drivers/net/mlx5/hws/mlx5dr.h b/drivers/net/mlx5/hws/mlx5dr.h
index ec2230d136..6b96a120f7 100644
--- a/drivers/net/mlx5/hws/mlx5dr.h
+++ b/drivers/net/mlx5/hws/mlx5dr.h
@@ -156,8 +156,21 @@ struct mlx5dr_devx_obj {
uint32_t id;
};
-/* In actions that take offset, the offset is unique, and the user should not
- * reuse the same index because data changing is not atomic.
+struct mlx5dr_action_reformat_header {
+ size_t sz;
+ void *data;
+};
+
+struct mlx5dr_action_mh_pattern {
+ /* Byte size of modify actions provided by "data" */
+ size_t sz;
+ /* PRM format modify actions pattern */
+ __be64 *data;
+};
+
+/* In actions that take offset, the offset is unique, pointing to a single
+ * resource and the user should not reuse the same index because data changing
+ * is not atomic.
*/
struct mlx5dr_rule_action {
struct mlx5dr_action *action;
@@ -172,11 +185,13 @@ struct mlx5dr_rule_action {
struct {
uint32_t offset;
+ uint8_t pattern_idx;
uint8_t *data;
} modify_header;
struct {
uint32_t offset;
+ uint8_t hdr_idx;
uint8_t *data;
} reformat;
@@ -481,12 +496,12 @@ mlx5dr_action_create_counter(struct mlx5dr_context *ctx,
* The context in which the new action will be created.
* @param[in] reformat_type
* Type of reformat prefixed with MLX5DR_ACTION_TYP_REFORMAT.
- * @param[in] data_sz
- * Size in bytes of data.
- * @param[in] inline_data
- * Header data array in case of inline action.
+ * @param[in] num_of_hdrs
+ * Number of provided headers in "hdrs" array.
+ * @param[in] hdrs
+ * Headers array containing header information.
* @param[in] log_bulk_size
- * Number of unique values used with this pattern.
+ * Number of unique values used with this reformat.
* @param[in] flags
* Action creation flags. (enum mlx5dr_action_flags)
* @return pointer to mlx5dr_action on success NULL otherwise.
@@ -494,8 +509,8 @@ mlx5dr_action_create_counter(struct mlx5dr_context *ctx,
struct mlx5dr_action *
mlx5dr_action_create_reformat(struct mlx5dr_context *ctx,
enum mlx5dr_action_type reformat_type,
- size_t data_sz,
- void *inline_data,
+ uint8_t num_of_hdrs,
+ struct mlx5dr_action_reformat_header *hdrs,
uint32_t log_bulk_size,
uint32_t flags);
@@ -503,10 +518,10 @@ mlx5dr_action_create_reformat(struct mlx5dr_context *ctx,
*
* @param[in] ctx
* The context in which the new action will be created.
- * @param[in] pattern_sz
- * Byte size of the pattern array.
- * @param[in] pattern
- * PRM format modify pattern action array.
+ * @param[in] num_of_patterns
+ * Number of provided patterns in "patterns" array.
+ * @param[in] patterns
+ * Patterns array containing pattern information.
* @param[in] log_bulk_size
* Number of unique values used with this pattern.
* @param[in] flags
@@ -515,8 +530,8 @@ mlx5dr_action_create_reformat(struct mlx5dr_context *ctx,
*/
struct mlx5dr_action *
mlx5dr_action_create_modify_header(struct mlx5dr_context *ctx,
- size_t pattern_sz,
- __be64 pattern[],
+ uint8_t num_of_patterns,
+ struct mlx5dr_action_mh_pattern *patterns,
uint32_t log_bulk_size,
uint32_t flags);
diff --git a/drivers/net/mlx5/hws/mlx5dr_action.c
b/drivers/net/mlx5/hws/mlx5dr_action.c
index 920099ba5b..48fb6d3eaa 100644
--- a/drivers/net/mlx5/hws/mlx5dr_action.c
+++ b/drivers/net/mlx5/hws/mlx5dr_action.c
@@ -529,7 +529,7 @@ static void mlx5dr_action_fill_stc_attr(struct
mlx5dr_action *action,
} else {
attr->action_type =
MLX5_IFC_STC_ACTION_TYPE_ACC_MODIFY_LIST;
attr->modify_header.arg_id =
action->modify_
Re: [PATCH v15 1/6] memarea: introduce memarea library
On Sun, 9 Jul 2023 13:00:36 +
Chengwen Feng wrote:
> +struct rte_memarea_param {
> + char name[RTE_MEMAREA_NAMESIZE]; /**< Name of memarea. */
> + enum rte_memarea_source source; /**< Memory source of memarea. */
> + enum rte_memarea_algorithm alg; /**< Memory management algorithm. */
> + /** Total size (bytes) of memarea, it should not be less be 1024. */
> + size_t total_sz;
> + /** Indicates whether the memarea API should be MT-safe. */
> + uint32_t mt_safe : 1;
> + union {
> + /** The initialization parameters if the source is set to be
> + * RTE_MEMAREA_SOURCE_HEAP.
> + */
> + struct {
> + /** Socket from which to apply for memarea's memory. */
> + int socket_id;
> + } heap;
> + /** The initialization parameters if the source is set to be
> + * RTE_MEMAREA_SOURCE_MEMAREA.
> + */
> + struct {
> + /** Source memarea which to apply for this memarea's
> + * memory from.
> + */
> + struct rte_memarea *src;
> + } ma;
> + };
> +};
FYI - since this data structure has holes in it. Given the current API you can
not assume that those holes are zero and try to reuse them later.
One alternative would to put in explicit reserved fields and check for zero
if you want to add more bits later.
RE: [PATCH] net/iavf: fix vlan offload strip flag inconsistency
> -Original Message-
> From: Wenjing Qiao
> Sent: Friday, July 7, 2023 3:58 PM
> To: Wu, Jingjing ; Xing, Beilei
> Cc: dev@dpdk.org; Huang, ZhiminX ; Qiao,
> Wenjing
> Subject: [PATCH] net/iavf: fix vlan offload strip flag inconsistency
>
> For i40e in-tree kernel driver, it will set strip on when setting filter on.
> To be
> consistent with dpdk, disable strip again.
>
> Fixes: cb25d4323fbf ("net/avf: enable MAC VLAN and promisc ops")
>
> Signed-off-by: Wenjing Qiao
> ---
> drivers/net/iavf/iavf.h| 1 +
> drivers/net/iavf/iavf_ethdev.c | 18 ++
> drivers/net/iavf/iavf_vchnl.c | 2 ++
> 3 files changed, 21 insertions(+)
>
> diff --git a/drivers/net/iavf/iavf.h b/drivers/net/iavf/iavf.h index
> 98861e4242..18b05f5cce 100644
> --- a/drivers/net/iavf/iavf.h
> +++ b/drivers/net/iavf/iavf.h
> @@ -325,6 +325,7 @@ struct iavf_adapter {
> bool closed;
> uint16_t fdir_ref_cnt;
> struct iavf_devargs devargs;
> + bool is_strip; /* only for vlan v1 */
Can we just use " dev_conf->rxmode.offloads & RTE_ETH_RX_OFFLOAD_VLAN_STRIP"?
> };
>
> /* IAVF_DEV_PRIVATE_TO */
> diff --git a/drivers/net/iavf/iavf_ethdev.c b/drivers/net/iavf/iavf_ethdev.c
> index 00b963128b..8cd534e93c 100644
> --- a/drivers/net/iavf/iavf_ethdev.c
> +++ b/drivers/net/iavf/iavf_ethdev.c
> @@ -1379,6 +1379,24 @@ iavf_dev_vlan_filter_set(struct rte_eth_dev *dev,
> uint16_t vlan_id, int on)
> err = iavf_add_del_vlan(adapter, vlan_id, on);
> if (err)
> return -EIO;
> + /* for i40e in-tree kernel driver, it will set strip on when setting
> + * filter on. To be consistent with dpdk, disable strip again.
> + */
> + if (adapter->hw.vendor_id == IAVF_INTEL_VENDOR_ID) {
> + switch (adapter->hw.device_id) {
> + case IAVF_DEV_ID_VF:
> + case IAVF_DEV_ID_VF_HV:
> + case IAVF_DEV_ID_X722_VF:
How we identify this is an in-tree or out-of-tree i40e kernel driver?
> + if (on && !adapter->is_strip) {
> + err = iavf_disable_vlan_strip(adapter);
> + if (err)
> + return -EIO;
> + }
> + break;
> + default:
> + break;
> + }
> + }
> return 0;
> }
>
> diff --git a/drivers/net/iavf/iavf_vchnl.c b/drivers/net/iavf/iavf_vchnl.c
> index
> 524732f67d..2d2fee4312 100644
> --- a/drivers/net/iavf/iavf_vchnl.c
> +++ b/drivers/net/iavf/iavf_vchnl.c
> @@ -589,6 +589,7 @@ iavf_enable_vlan_strip(struct iavf_adapter *adapter)
> PMD_DRV_LOG(ERR, "Failed to execute command of"
> " OP_ENABLE_VLAN_STRIPPING");
>
> + adapter->is_strip = true;
> return ret;
> }
>
> @@ -611,6 +612,7 @@ iavf_disable_vlan_strip(struct iavf_adapter *adapter)
> " OP_DISABLE_VLAN_STRIPPING");
>
> return ret;
> + adapter->is_strip = false;
> }
>
> #define VIRTCHNL_VERSION_MAJOR_START 1
> --
> 2.34.1
RE: [PATCH v1 0/2] add IPv6 extension push remove
Hi Ferruh & Andrew & Ori & Thomas: Sorry, we can't commit the PMD implementation for "IPv6 extension push remove" feature in time for this release. There are some dis-agreements which need to be addressed internally. We will continue to work on this and plan to push it in the next release. RFC link: https://patchwork.dpdk.org/project/dpdk/cover/20230417022630.2377505-1-rongw...@nvidia.com/ V1 patch with full PMD implementation: https://patchwork.dpdk.org/project/dpdk/cover/20230417092540.2617450-1-rongw...@nvidia.com/ BR Rongwei > -Original Message- > From: Ferruh Yigit > Sent: Friday, June 2, 2023 22:39 > To: Rongwei Liu ; Matan Azrad ; > Slava Ovsiienko ; Ori Kam ; > Suanming Mou ; NBU-Contact-Thomas Monjalon > (EXTERNAL) > Cc: dev@dpdk.org > Subject: Re: [PATCH v1 0/2] add IPv6 extension push remove > > External email: Use caution opening links or attachments > > > On 5/24/2023 8:39 AM, Rongwei Liu wrote: > > Add new rte_actions to push and remove the specific type of IPv6 > > extension to and from original packets. > > > > v1: Split the PMD implementation, add a description into release notes. > > > > Rongwei Liu (2): > > ethdev: add IPv6 extension push remove action > > app/testpmd: add IPv6 extension push remove cli > > > > Series applied to dpdk-next-net/main, thanks.
RE: [PATCH v3] graph: fix graph model check in core binding
> -Original Message-
> From: Jerin Jacob
> Sent: Friday, July 7, 2023 6:17 PM
> To: Yan, Zhirun
> Cc: dev@dpdk.org; jer...@marvell.com; kirankum...@marvell.com;
> ndabilpu...@marvell.com; Fu, Qi
> Subject: Re: [PATCH v3] graph: fix graph model check in core binding
>
> On Wed, Jul 5, 2023 at 7:38 AM Zhirun Yan wrote:
> >
> > Fix graph model check in core binding with graph. And
> > rte_graph_clone()
>
> Two fixes, Lets have two patches. Also tell what is fixed and how it is fixed.
Ok, will do in next version.
>
>
> > need to use valid params rather than NULL pointer. Update release
> > notes for new mcore dispatch model.
> >
> > Fixes: ecb22a294980 ("graph: introduce graph bind unbind API")
> > Fixes: 67e2303cd823 ("test/graph: add functional tests for mcore
> > dispatch model")
> >
> > Signed-off-by: Zhirun Yan
> > ---
> > app/test/test_graph.c | 15 ---
> > doc/guides/rel_notes/release_23_07.rst | 11 +++
> > lib/graph/graph.c | 2 +-
> > 3 files changed, 24 insertions(+), 4 deletions(-)
> >
> > diff --git a/app/test/test_graph.c b/app/test/test_graph.c index
> > 8609c0b3a4..8983363c8e 100644
> > --- a/app/test/test_graph.c
> > +++ b/app/test/test_graph.c
> > @@ -702,6 +702,7 @@
> test_graph_model_mcore_dispatch_node_lcore_affinity_set(void)
> > unsigned int worker_lcore = RTE_MAX_LCORE;
> > rte_node_t nid = RTE_NODE_ID_INVALID;
> > char node_name[64] = "test_node00";
> > + struct rte_graph_param graph_conf;
>
> Initialize with zero or defaults, aka add = { 0 }
Got it, thanks.
Re: [PATCH v4] dmadev: add tracepoints
09/07/2023 05:23, fengchengwen:
> Hi Thomas,
>
> On 2023/7/7 18:40, Thomas Monjalon wrote:
> > 26/05/2023 10:42, Chengwen Feng:
> >> Add tracepoints at important APIs for tracing support.
> >>
> >> Signed-off-by: Chengwen Feng
> >> Acked-by: Morten Brørup
> >>
> >> ---
> >> v4: Fix asan smoke fail.
> >> v3: Address Morten's comment:
> >> Move stats_get and vchan_status and to trace_fp.h.
> >> v2: Address Morten's comment:
> >> Make stats_get as fast-path trace-points.
> >> Place fast-path trace-point functions behind in version.map.
> >
> > There are more things to fix.
> > First you must export rte_dmadev_trace_fp.h as it is included by
> > rte_dmadev.h.
>
> It was already included by rte_dmadev.h:
> diff --git a/lib/dmadev/rte_dmadev.h b/lib/dmadev/rte_dmadev.h
> index e61d71959e..e792b90ef8 100644
> --- a/lib/dmadev/rte_dmadev.h
> +++ b/lib/dmadev/rte_dmadev.h
> @@ -796,6 +796,7 @@ struct rte_dma_sge {
> };
>
> #include "rte_dmadev_core.h"
> +#include "rte_dmadev_trace_fp.h"
>
>
> > Note: you could have caught this if testing the example app for DMA.
> > Second, you must avoid structs and enum in this header file,
>
> Let me explain the #if #endif logic:
>
> For the function:
> uint16_t
> rte_dma_completed(int16_t dev_id, uint16_t vchan, const uint16_t nb_cpls,
> uint16_t *last_idx, bool *has_error)
>
> The common trace implementation:
> RTE_TRACE_POINT_FP(
> rte_dma_trace_completed,
> RTE_TRACE_POINT_ARGS(int16_t dev_id, uint16_t vchan,
>const uint16_t nb_cpls, uint16_t *last_idx,
>bool *has_error, uint16_t ret),
> rte_trace_point_emit_i16(dev_id);
> rte_trace_point_emit_u16(vchan);
> rte_trace_point_emit_u16(nb_cpls);
> rte_trace_point_emit_ptr(idx_val);
> rte_trace_point_emit_ptr(has_error);
> rte_trace_point_emit_u16(ret);
> )
>
> But it has a problem: for pointer parameter (e.g. last_idx and has_error),
> only record
> the pointer value (i.e. address value).
>
> I think the pointer value has no mean (in particular, many of there pointers
> are stack
> variables), the value of the pointer point to is meaningful.
>
> So I add the pointer reference like below (as V3 did):
> RTE_TRACE_POINT_FP(
> rte_dma_trace_completed,
> RTE_TRACE_POINT_ARGS(int16_t dev_id, uint16_t vchan,
>const uint16_t nb_cpls, uint16_t *last_idx,
>bool *has_error, uint16_t ret),
> int has_error_val = *has_error;// pointer reference
> int last_idx_val = *last_idx; // pointer reference
> rte_trace_point_emit_i16(dev_id);
> rte_trace_point_emit_u16(vchan);
> rte_trace_point_emit_u16(nb_cpls);
> rte_trace_point_emit_int(last_idx_val);// record the value of
> pointer
> rte_trace_point_emit_int(has_error_val); // record the value of
> pointer
> rte_trace_point_emit_u16(ret);
> )
>
> Unfortunately, the above lead to asan failed. because in:
> RTE_TRACE_POINT_REGISTER(rte_dma_trace_completed,
> lib.dmadev.completed)
> it will invoke rte_dma_trace_completed() with the parameter is undefined.
>
>
> To solve this problem, consider the rte_dmadev_trace_points.c will include
> rte_trace_point_register.h,
> and the rte_trace_point_register.h will defined macro:
> _RTE_TRACE_POINT_REGISTER_H_.
>
> so we update trace points as (as V4 did):
> RTE_TRACE_POINT_FP(
> rte_dma_trace_completed,
> RTE_TRACE_POINT_ARGS(int16_t dev_id, uint16_t vchan,
>const uint16_t nb_cpls, uint16_t *last_idx,
>bool *has_error, uint16_t ret),
> #ifdef _RTE_TRACE_POINT_REGISTER_H_
> uint16_t __last_idx = 0;
> bool __has_error = false;
> last_idx = &__last_idx; // make sure the pointer has
> meaningful value.
> has_error = &__has_error;// so that the next pointer
> reference will work well.
> #endif /* _RTE_TRACE_POINT_REGISTER_H_ */
> int has_error_val = *has_error;
> int last_idx_val = *last_idx;
> rte_trace_point_emit_i16(dev_id);
> rte_trace_point_emit_u16(vchan);
> rte_trace_point_emit_u16(nb_cpls);
> rte_trace_point_emit_int(last_idx_val);
> rte_trace_point_emit_int(has_error_val);
> rte_trace_point_emit_u16(ret);
> )
>
> > otherwise it cannot be included alone.
> > Look at what is done in other *_trace_fp.h files.
> >
> >
>
> Whether enable_trace_fp is true or false, the v4 work well.
> Below is that run examples with enable_trace_fp=true.
>
> ./dpdk-test --file-prefix=feng123 --trace=lib.dmadev.* -l 10-11
This is the test application, not the example.
Please make sure examples/dma/ is compiling.
Also, the test chkincs must run fine.
[PATCH v16 6/6] test/memarea: support dump API test
This patch supports rte_memarea_dump() API test.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
app/test/test_memarea.c | 40
1 file changed, 40 insertions(+)
diff --git a/app/test/test_memarea.c b/app/test/test_memarea.c
index 4053cdcac9..6511a86699 100644
--- a/app/test/test_memarea.c
+++ b/app/test/test_memarea.c
@@ -320,6 +320,45 @@ test_memarea_alloc_free(void)
TEST_ASSERT(rte_errno == 0, "Expected Zero");
+ fprintf(stderr, "There should have no allocated object.\n");
+ rte_memarea_dump(ma, stderr, true);
+
+ rte_memarea_destroy(ma);
+
+ return 0;
+}
+
+static int
+test_memarea_dump(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ int ret;
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+
+ /* test for invalid parameters */
+ ret = rte_memarea_dump(NULL, stderr, false);
+ TEST_ASSERT(ret == -1, "Expected -1");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+ ret = rte_memarea_dump(ma, NULL, false);
+ TEST_ASSERT(ret == -1, "Expected -1");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for dump */
+ (void)rte_memarea_alloc(ma, 1);
+ (void)rte_memarea_alloc(ma, 1);
+ (void)rte_memarea_alloc(ma, 1);
+ (void)rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE);
+ (void)rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE);
+ fprintf(stderr, "There should have three allocated object.\n");
+ ret = rte_memarea_dump(ma, stderr, true);
+ TEST_ASSERT(ret == 0, "Expected ZERO");
+
rte_memarea_destroy(ma);
return 0;
@@ -337,6 +376,7 @@ static struct unit_test_suite memarea_test_suite = {
TEST_CASE(test_memarea_alloc_fail),
TEST_CASE(test_memarea_free_fail),
TEST_CASE(test_memarea_alloc_free),
+ TEST_CASE(test_memarea_dump),
TEST_CASES_END() /**< NULL terminate unit test array */
}
--
2.17.1
[PATCH v16 4/6] test/memarea: support alloc and free API test
This patch supports rte_memarea_alloc() and rte_memarea_free() API
test.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
app/test/test_memarea.c | 214 +++-
1 file changed, 213 insertions(+), 1 deletion(-)
diff --git a/app/test/test_memarea.c b/app/test/test_memarea.c
index d8d5fc35d4..4053cdcac9 100644
--- a/app/test/test_memarea.c
+++ b/app/test/test_memarea.c
@@ -23,6 +23,12 @@ test_memarea_init_param(struct rte_memarea_param *init)
init->mt_safe = 1;
}
+static void
+test_memarea_fill_region(void *ptr, size_t size)
+{
+ memset(ptr, 0xff, size);
+}
+
static int
test_memarea_create_bad_param(void)
{
@@ -95,7 +101,7 @@ test_memarea_create_bad_param(void)
static int
test_memarea_create_destroy(void)
{
- struct rte_memarea *ma;
+ struct rte_memarea *ma, *src_ma;
struct rte_memarea_param init;
rte_errno = 0;
@@ -115,6 +121,207 @@ test_memarea_create_destroy(void)
TEST_ASSERT(ma != NULL, "Expected Non-NULL");
rte_memarea_destroy(ma);
+ /* test for create with another memarea */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ src_ma = rte_memarea_create(&init);
+ TEST_ASSERT(src_ma != NULL, "Expected Non-NULL");
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_MEMAREA;
+ init.total_sz = init.total_sz >> 1;
+ init.ma.src = src_ma;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+ rte_memarea_destroy(ma);
+ rte_memarea_destroy(src_ma);
+
+ TEST_ASSERT(rte_errno == 0, "Expected ZERO");
+
+ return 0;
+}
+
+static int
+test_memarea_alloc_bad_param(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ size_t size;
+ void *ptr;
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+
+ /* test for invalid ma */
+ ptr = rte_memarea_alloc(NULL, 1);
+ TEST_ASSERT(ptr == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid size (size = 0) */
+ ptr = rte_memarea_alloc(ma, 0);
+ TEST_ASSERT(ptr == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid size (size rewind) */
+ memset(&size, 0xff, sizeof(size));
+ ptr = rte_memarea_alloc(ma, size);
+ TEST_ASSERT(ptr == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ rte_memarea_destroy(ma);
+
+ return 0;
+}
+
+static int
+test_memarea_free_bad_param(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ void *ptr;
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+ ptr = rte_memarea_alloc(ma, 1);
+ TEST_ASSERT(ptr != NULL, "Expected Non-NULL");
+ test_memarea_fill_region(ptr, 1);
+
+ /* test for invalid ma */
+ rte_memarea_free(NULL, ptr);
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid ptr */
+ rte_memarea_free(ma, NULL);
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ rte_memarea_destroy(ma);
+
+ return 0;
+}
+
+static int
+test_memarea_alloc_fail(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+ void *ptr[2];
+
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_LIBC;
+ init.total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma != NULL, "Expected Non-NULL");
+
+ /* test alloc fail with big size */
+ ptr[0] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE);
+ TEST_ASSERT(ptr[0] == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == ENOMEM, "Expected ENOMEM");
+
+ /* test alloc fail because no memory */
+ ptr[0] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ TEST_ASSERT(ptr[0] != NULL, "Expected Non-NULL");
+ test_memarea_fill_region(ptr[0], MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ ptr[1] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ TEST_ASSERT(ptr[1] == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == ENOMEM, "Expected ENOMEM");
+ rte_memarea_free(ma, ptr[0]);
+
+ /* test alloc fail when second fail */
+ ptr[0] = rte_memarea_alloc(ma, MEMAREA_TEST_DEFAULT_SIZE >> 1);
+ TEST_ASSERT(ptr[0] != NULL, "Expected Non-NULL");
+ test_memarea_fill_region(ptr[0], MEMAREA_TEST_DEFAULT_S
[PATCH v16 3/6] memarea: support alloc and free API
This patch supports rte_memarea_alloc() and rte_memarea_free() API.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
doc/guides/prog_guide/memarea_lib.rst | 6 +
lib/memarea/memarea_private.h | 10 ++
lib/memarea/rte_memarea.c | 164 ++
lib/memarea/rte_memarea.h | 44 +++
lib/memarea/version.map | 2 +
5 files changed, 226 insertions(+)
diff --git a/doc/guides/prog_guide/memarea_lib.rst
b/doc/guides/prog_guide/memarea_lib.rst
index bf19090294..157baf3c7e 100644
--- a/doc/guides/prog_guide/memarea_lib.rst
+++ b/doc/guides/prog_guide/memarea_lib.rst
@@ -33,6 +33,12 @@ returns the pointer to the created memarea or ``NULL`` if
the creation failed.
The ``rte_memarea_destroy()`` function is used to destroy a memarea.
+The ``rte_memarea_alloc()`` function is used to alloc one memory object from
+the memarea.
+
+The ``rte_memarea_free()`` function is used to free one memory object which
+allocated by ``rte_memarea_alloc()``.
+
Debug Mode
--
diff --git a/lib/memarea/memarea_private.h b/lib/memarea/memarea_private.h
index 384c6dde9d..cef7d0f859 100644
--- a/lib/memarea/memarea_private.h
+++ b/lib/memarea/memarea_private.h
@@ -22,10 +22,20 @@
#define MEMAREA_OBJECT_GET_SIZE(hdr) \
((uintptr_t)TAILQ_NEXT((hdr), obj_next) - (uintptr_t)(hdr) - \
sizeof(struct memarea_objhdr) - sizeof(struct memarea_objtlr))
+#define MEMAREA_SPLIT_OBJECT_MIN_SIZE \
+ (sizeof(struct memarea_objhdr) + MEMAREA_OBJECT_SIZE_ALIGN + \
+sizeof(struct memarea_objtlr))
+#define MEMAREA_SPLIT_OBJECT_GET_HEADER(hdr, alloc_sz) \
+ RTE_PTR_ADD(hdr, sizeof(struct memarea_objhdr) + alloc_sz + \
+ sizeof(struct memarea_objtlr))
#else
#define MEMAREA_OBJECT_GET_SIZE(hdr) \
((uintptr_t)TAILQ_NEXT((hdr), obj_next) - (uintptr_t)(hdr) - \
sizeof(struct memarea_objhdr))
+#define MEMAREA_SPLIT_OBJECT_MIN_SIZE \
+ (sizeof(struct memarea_objhdr) + MEMAREA_OBJECT_SIZE_ALIGN)
+#define MEMAREA_SPLIT_OBJECT_GET_HEADER(hdr, alloc_sz) \
+ RTE_PTR_ADD(hdr, sizeof(struct memarea_objhdr) + alloc_sz)
#endif
struct memarea_objhdr {
diff --git a/lib/memarea/rte_memarea.c b/lib/memarea/rte_memarea.c
index 69ffeac4e4..d941e64a1e 100644
--- a/lib/memarea/rte_memarea.c
+++ b/lib/memarea/rte_memarea.c
@@ -2,8 +2,10 @@
* Copyright(c) 2023 HiSilicon Limited
*/
+#include
#include
#include
+#include
#include
#include
@@ -94,6 +96,8 @@ memarea_alloc_area(const struct rte_memarea_param *init)
init->heap.socket_id);
else if (init->source == RTE_MEMAREA_SOURCE_LIBC)
ptr = memarea_alloc_from_libc(init->total_sz);
+ else if (init->source == RTE_MEMAREA_SOURCE_MEMAREA)
+ ptr = rte_memarea_alloc(init->ma.src, init->total_sz);
return ptr;
}
@@ -105,6 +109,8 @@ memarea_free_area(const struct rte_memarea_param *init,
void *ptr)
rte_free(ptr);
else if (init->source == RTE_MEMAREA_SOURCE_LIBC)
free(ptr);
+ else if (init->source == RTE_MEMAREA_SOURCE_MEMAREA)
+ rte_memarea_free(init->ma.src, ptr);
}
/**
@@ -219,3 +225,161 @@ rte_memarea_destroy(struct rte_memarea *ma)
memarea_free_area(&ma->init, ma->area_base);
rte_free(ma);
}
+
+static inline void
+memarea_lock(struct rte_memarea *ma)
+{
+ if (ma->init.mt_safe)
+ rte_spinlock_lock(&ma->lock);
+}
+
+static inline void
+memarea_unlock(struct rte_memarea *ma)
+{
+ if (ma->init.mt_safe)
+ rte_spinlock_unlock(&ma->lock);
+}
+
+/**
+ * Check cookie or panic.
+ *
+ * @param status
+ * - 0: object is supposed to be available.
+ * - 1: object is supposed to be allocated.
+ * - 2: just check that cookie is valid (available or allocated).
+ */
+static inline void
+memarea_check_cookie(const struct rte_memarea *ma, const struct memarea_objhdr
*hdr, int status)
+{
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+ static const char *const str[] = { "PASS", "FAILED" };
+ struct memarea_objtlr *tlr;
+ bool hdr_fail, tlr_fail;
+
+ if (hdr == ma->guard_hdr)
+ return;
+
+ tlr = RTE_PTR_SUB(TAILQ_NEXT(hdr, obj_next), sizeof(struct
memarea_objtlr));
+ hdr_fail = (status == 0 && hdr->cookie !=
MEMAREA_OBJECT_HEADER_AVAILABLE_COOKIE) ||
+ (status == 1 && hdr->cookie !=
MEMAREA_OBJECT_HEADER_ALLOCATED_COOKIE) ||
+ (status == 2 && (hdr->cookie !=
MEMAREA_OBJECT_HEADER_AVAILABLE_COOKIE &&
+ hdr->cookie !=
MEMAREA_OBJECT_HEADER_ALLOCATED_COOKIE));
+ tlr_fail = (tlr->cookie != MEMAREA_OBJECT_TRAILER_COOKIE);
+ if (!hdr_fail && !tlr_fail)
+ return;
+
+ rte_panic("MEMAREA: %s check cookies faile
[PATCH v16 0/6] introduce memarea library
The memarea library is an allocator of variable-size object which based on a memory region. The main features are as follows: - The memory region can be initialized from the following memory sources: 1. HEAP: e.g. invoke rte_malloc_socket. 2. LIBC: e.g. invoke posix_memalign. 3. Another memarea: it can be from another memarea. - It supports MT-safe as long as it's specified at creation time. - The address returned by the allocator is align to 8B. Note: a) The memarea is oriented towards the application layer, which could provides 'region-based memory management' [1] function. b) The eal library also provide memory zone/heap management, but these are tied to huge pages management. [1] https://en.wikipedia.org/wiki/Region-based_memory_management Chengwen Feng (6): memarea: introduce memarea library test/memarea: support memarea test memarea: support alloc and free API test/memarea: support alloc and free API test memarea: support dump API test/memarea: support dump API test --- v16: * fix compile failed when clang with thread-safety-analysis (by disable annotate_locks in lib/memarea/meson.build). * add reserved field for 'struct rte_memarea_param' which address Stephen's comments. * fix typo. v15: * rebase 23.07 * address Anatoly's mostly comments: use rte_errno, abstract cookie helper, more comment about critical function, rename add with split, doc limitation. v14: * address Stephen's comments: RTE_MEMAREA_LOG use easy impl and add __func__ print. v13: * address Morten's comments: make debug cookies optional, controlled by RTE_LIBRTE_MEMAREA_DEBUG; disabled by default. * reduce management data overhead. v12: * remove rte_memarea_refcnt_update() API which address Dongdong's comments. * refine the variable naming. * fix some bugs. v11: * rebase 23.03 * remove "app/test: add memarea to malloc-perf-autotest" because the two algorithm are not comparable which also address previous comments. v10: * support windows platform. * add rte_memarea.libc perftest to malloc-perf-autotest. v9: * address Dmitry's comments. * drop features of SOURCE_USER and backup memarea mechanism. * rename rte_memarea_update_refcnt to rte_memarea_refcnt_update to keep with rte_mbuf_refcnt_update name style. * fix memarea perftest compile failed at windows platform. * fix spell warning. v8: * address Mattias's comments (rename ALG_DEFAULT with ALG_NEXTFIT). * small feature patches are combined. * enhanced backup memory mechanism. * add memarea to malloc-perf-autotest. * other tiny naming optimize. v7: * repost patches as there are spread over different series in patchwork. v6: * address Mattias's comments. v5: * fix 09/10 patch spell warning. v4: * repost patches as there are spread over different series in patchwork. v3: * add memory source of RTE memory. * add algorithm field to facilitate the introduction of new algorithms. * fix memarea log don't output problem. v2: * fix compile issues reported by dpdk-test-report. * address Dimitry and Jerin's comments. * add no MT-safe test. MAINTAINERS| 6 + app/test/meson.build | 2 + app/test/test_memarea.c| 391 doc/api/doxy-api-index.md | 3 +- doc/api/doxy-api.conf.in | 1 + doc/guides/prog_guide/index.rst| 1 + doc/guides/prog_guide/memarea_lib.rst | 57 +++ doc/guides/rel_notes/release_23_07.rst | 6 + lib/memarea/memarea_private.h | 96 + lib/memarea/meson.build| 12 + lib/memarea/rte_memarea.c | 485 + lib/memarea/rte_memarea.h | 206 +++ lib/memarea/version.map| 15 + lib/meson.build| 1 + 14 files changed, 1281 insertions(+), 1 deletion(-) create mode 100644 app/test/test_memarea.c create mode 100644 doc/guides/prog_guide/memarea_lib.rst create mode 100644 lib/memarea/memarea_private.h create mode 100644 lib/memarea/meson.build create mode 100644 lib/memarea/rte_memarea.c create mode 100644 lib/memarea/rte_memarea.h create mode 100644 lib/memarea/version.map -- 2.17.1
[PATCH v16 1/6] memarea: introduce memarea library
The memarea library is an allocator of variable-size object which based on a memory region. This patch provides rte_memarea_create() and rte_memarea_destroy() API. Signed-off-by: Chengwen Feng Reviewed-by: Dongdong Liu Acked-by: Morten Brørup --- MAINTAINERS| 5 + doc/api/doxy-api-index.md | 3 +- doc/api/doxy-api.conf.in | 1 + doc/guides/prog_guide/index.rst| 1 + doc/guides/prog_guide/memarea_lib.rst | 48 ++ doc/guides/rel_notes/release_23_07.rst | 6 + lib/memarea/memarea_private.h | 86 ++ lib/memarea/meson.build| 12 ++ lib/memarea/rte_memarea.c | 221 + lib/memarea/rte_memarea.h | 141 lib/memarea/version.map| 12 ++ lib/meson.build| 1 + 12 files changed, 536 insertions(+), 1 deletion(-) create mode 100644 doc/guides/prog_guide/memarea_lib.rst create mode 100644 lib/memarea/memarea_private.h create mode 100644 lib/memarea/meson.build create mode 100644 lib/memarea/rte_memarea.c create mode 100644 lib/memarea/rte_memarea.h create mode 100644 lib/memarea/version.map diff --git a/MAINTAINERS b/MAINTAINERS index 1c3be16a91..93de0876f1 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1612,6 +1612,11 @@ F: app/test/test_lpm* F: app/test/test_func_reentrancy.c F: app/test/test_xmmt_ops.h +Memarea - EXPERIMENTAL +M: Chengwen Feng +F: lib/memarea +F: doc/guides/prog_guide/memarea_lib.rst + Membership - EXPERIMENTAL M: Yipeng Wang M: Sameh Gobriel diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index 3bc8778981..5c32913f92 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -65,7 +65,8 @@ The public API headers are grouped by topics: [memzone](@ref rte_memzone.h), [mempool](@ref rte_mempool.h), [malloc](@ref rte_malloc.h), - [memcpy](@ref rte_memcpy.h) + [memcpy](@ref rte_memcpy.h), + [memarea](@ref rte_memarea.h) - **timers**: [cycles](@ref rte_cycles.h), diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index 1a4210b948..1f35d8483e 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -54,6 +54,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/lib/latencystats \ @TOPDIR@/lib/lpm \ @TOPDIR@/lib/mbuf \ + @TOPDIR@/lib/memarea \ @TOPDIR@/lib/member \ @TOPDIR@/lib/mempool \ @TOPDIR@/lib/meter \ diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst index d89cd3edb6..aa8eebe256 100644 --- a/doc/guides/prog_guide/index.rst +++ b/doc/guides/prog_guide/index.rst @@ -38,6 +38,7 @@ Programmer's Guide hash_lib toeplitz_hash_lib efd_lib +memarea_lib member_lib lpm_lib lpm6_lib diff --git a/doc/guides/prog_guide/memarea_lib.rst b/doc/guides/prog_guide/memarea_lib.rst new file mode 100644 index 00..bf19090294 --- /dev/null +++ b/doc/guides/prog_guide/memarea_lib.rst @@ -0,0 +1,48 @@ +.. SPDX-License-Identifier: BSD-3-Clause +Copyright(c) 2023 HiSilicon Limited + +Memarea Library +=== + +Introduction + + +The memarea library provides an allocator of variable-size objects, it is +oriented towards the application layer, providing 'region-based memory +management' function [1]. + +The main features are as follows: + +* The memory region can be initialized from the following memory sources: + + - HEAP: e.g. invoke ``rte_malloc_socket``. + + - LIBC: e.g. invoke posix_memalign. + + - Another memarea: it can be allocated from another memarea. + +* It supports MT-safe as long as it's specified at creation time. + +* The address returned by the allocator is align to 8B. + +Library API Overview + + +The ``rte_memarea_create()`` function is used to create a memarea, the function +returns the pointer to the created memarea or ``NULL`` if the creation failed. + +The ``rte_memarea_destroy()`` function is used to destroy a memarea. + +Debug Mode +-- + +In debug mode, cookies are added at the beginning and end of objects, it will +help debugging buffer overflows. + +Debug mode is disabled by default, but can be enabled by setting +``RTE_LIBRTE_MEMAREA_DEBUG`` in ``config/rte_config.h``. + +Reference +- + +[1] https://en.wikipedia.org/wiki/Region-based_memory_management diff --git a/doc/guides/rel_notes/release_23_07.rst b/doc/guides/rel_notes/release_23_07.rst index dcfd692425..ccef40e8cb 100644 --- a/doc/guides/rel_notes/release_23_07.rst +++ b/doc/guides/rel_notes/release_23_07.rst @@ -206,6 +206,12 @@ New Features See the :doc:`../tools/dmaperf` for more details. +* **Added memarea library.** + + The memarea library is an allocator of variable-size obj
[PATCH v16 2/6] test/memarea: support memarea test
This patch supports memarea test of rte_memarea_create() and
rte_memarea_destroy() API.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
---
MAINTAINERS | 1 +
app/test/meson.build| 2 +
app/test/test_memarea.c | 139
3 files changed, 142 insertions(+)
create mode 100644 app/test/test_memarea.c
diff --git a/MAINTAINERS b/MAINTAINERS
index 93de0876f1..cc082ae821 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1616,6 +1616,7 @@ Memarea - EXPERIMENTAL
M: Chengwen Feng
F: lib/memarea
F: doc/guides/prog_guide/memarea_lib.rst
+F: app/test/test_memarea*
Membership - EXPERIMENTAL
M: Yipeng Wang
diff --git a/app/test/meson.build b/app/test/meson.build
index 3e0a2360a3..5e3012328d 100644
--- a/app/test/meson.build
+++ b/app/test/meson.build
@@ -83,6 +83,7 @@ test_sources = files(
'test_malloc.c',
'test_malloc_perf.c',
'test_mbuf.c',
+'test_memarea.c',
'test_member.c',
'test_member_perf.c',
'test_memcpy.c',
@@ -200,6 +201,7 @@ fast_tests = [
['malloc_autotest', false, true],
['mbuf_autotest', false, true],
['mcslock_autotest', false, true],
+['memarea_autotest', true, true],
['memcpy_autotest', true, true],
['memory_autotest', false, true],
['mempool_autotest', false, true],
diff --git a/app/test/test_memarea.c b/app/test/test_memarea.c
new file mode 100644
index 00..d8d5fc35d4
--- /dev/null
+++ b/app/test/test_memarea.c
@@ -0,0 +1,139 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2023 HiSilicon Limited
+ */
+
+#include
+#include
+
+#include
+#include
+#include
+
+#include "test.h"
+
+#define MEMAREA_TEST_DEFAULT_SIZE 0x1000
+
+static void
+test_memarea_init_param(struct rte_memarea_param *init)
+{
+ memset(init, 0, sizeof(struct rte_memarea_param));
+ sprintf(init->name, "%s", "autotest");
+ init->source = RTE_MEMAREA_SOURCE_LIBC;
+ init->total_sz = MEMAREA_TEST_DEFAULT_SIZE;
+ init->mt_safe = 1;
+}
+
+static int
+test_memarea_create_bad_param(void)
+{
+ struct rte_memarea_param init;
+ struct rte_memarea *ma;
+
+ /* test for NULL */
+ ma = rte_memarea_create(NULL);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid name */
+ memset(&init, 0, sizeof(init));
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+ memset(&init.name, 1, sizeof(init.name));
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for invalid source */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_MEMAREA + 1;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for total_sz */
+ test_memarea_init_param(&init);
+ init.total_sz = 0;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for memarea NULL */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_MEMAREA;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for algorithm invalid */
+ test_memarea_init_param(&init);
+ init.alg = RTE_MEMAREA_ALGORITHM_NEXTFIT + 1;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ /* test for reserved field */
+ test_memarea_init_param(&init);
+ init.reserved_bits = 1;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+ test_memarea_init_param(&init);
+ init.reserved_64s[0] = 1;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+ test_memarea_init_param(&init);
+ init.reserved_64s[1] = 1;
+ ma = rte_memarea_create(&init);
+ TEST_ASSERT(ma == NULL, "Expected NULL");
+ TEST_ASSERT(rte_errno == EINVAL, "Expected EINVAL");
+
+ return 0;
+}
+
+static int
+test_memarea_create_destroy(void)
+{
+ struct rte_memarea *ma;
+ struct rte_memarea_param init;
+
+ rte_errno = 0;
+
+ /* test for create with HEAP */
+ test_memarea_init_param(&init);
+ init.source = RTE_MEMAREA_SOURCE_HEAP;
+ init.heap.socket_id = SO
[PATCH v16 5/6] memarea: support dump API
This patch supports rte_memarea_dump() API which could be used for
debug.
Signed-off-by: Chengwen Feng
Reviewed-by: Dongdong Liu
Acked-by: Morten Brørup
Acked-by: Anatoly Burakov
---
doc/guides/prog_guide/memarea_lib.rst | 3 +
lib/memarea/rte_memarea.c | 100 ++
lib/memarea/rte_memarea.h | 21 ++
lib/memarea/version.map | 1 +
4 files changed, 125 insertions(+)
diff --git a/doc/guides/prog_guide/memarea_lib.rst
b/doc/guides/prog_guide/memarea_lib.rst
index 157baf3c7e..ef22294664 100644
--- a/doc/guides/prog_guide/memarea_lib.rst
+++ b/doc/guides/prog_guide/memarea_lib.rst
@@ -39,6 +39,9 @@ the memarea.
The ``rte_memarea_free()`` function is used to free one memory object which
allocated by ``rte_memarea_alloc()``.
++The ``rte_memarea_dump()`` function is used to dump the internal information
++of a memarea.
+
Debug Mode
--
diff --git a/lib/memarea/rte_memarea.c b/lib/memarea/rte_memarea.c
index d941e64a1e..4a2cc84d84 100644
--- a/lib/memarea/rte_memarea.c
+++ b/lib/memarea/rte_memarea.c
@@ -383,3 +383,103 @@ rte_memarea_free(struct rte_memarea *ma, void *ptr)
memarea_unlock(ma);
}
+
+static const char *
+memarea_source_name(enum rte_memarea_source source)
+{
+ if (source == RTE_MEMAREA_SOURCE_HEAP)
+ return "heap";
+ else if (source == RTE_MEMAREA_SOURCE_LIBC)
+ return "libc";
+ else if (source == RTE_MEMAREA_SOURCE_MEMAREA)
+ return "memarea";
+ else
+ return "unknown";
+}
+
+static const char *
+memarea_alg_name(enum rte_memarea_algorithm alg)
+{
+ if (alg == RTE_MEMAREA_ALGORITHM_NEXTFIT)
+ return "nextfit";
+ else
+ return "unknown";
+}
+
+static void
+memarea_dump_objects_brief(struct rte_memarea *ma, FILE *f)
+{
+ uint32_t total_objs = 0, total_avail_objs = 0;
+ struct memarea_objhdr *hdr;
+ size_t total_avail_sz = 0;
+
+ TAILQ_FOREACH(hdr, &ma->obj_list, obj_next) {
+ if (hdr == ma->guard_hdr)
+ break;
+ memarea_check_cookie(ma, hdr, 2);
+ total_objs++;
+ if (!MEMAREA_OBJECT_IS_ALLOCATED(hdr)) {
+ total_avail_objs++;
+ total_avail_sz += MEMAREA_OBJECT_GET_SIZE(hdr);
+ }
+ }
+ fprintf(f, " total-objects: %u\n", total_objs);
+ fprintf(f, " total-avail-objects: %u\n", total_avail_objs);
+ fprintf(f, " total-avail-objects-size: 0x%zx\n", total_avail_sz);
+}
+
+static void
+memarea_dump_objects_detail(struct rte_memarea *ma, FILE *f)
+{
+ struct memarea_objhdr *hdr;
+ size_t offset;
+ void *ptr;
+
+ fprintf(f, " objects:\n");
+ TAILQ_FOREACH(hdr, &ma->obj_list, obj_next) {
+ if (hdr == ma->guard_hdr)
+ break;
+ memarea_check_cookie(ma, hdr, 2);
+ ptr = RTE_PTR_ADD(hdr, sizeof(struct memarea_objhdr));
+ offset = RTE_PTR_DIFF(ptr, ma->area_base);
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+ fprintf(f, "%p off: 0x%zx size: 0x%zx %s\n",
+ ptr, offset, MEMAREA_OBJECT_GET_SIZE(hdr),
+ MEMAREA_OBJECT_IS_ALLOCATED(hdr) ? "allocated" : "");
+#else
+ fprintf(f, "off: 0x%zx size: 0x%zx %s\n",
+ offset, MEMAREA_OBJECT_GET_SIZE(hdr),
+ MEMAREA_OBJECT_IS_ALLOCATED(hdr) ? "allocated" : "");
+#endif
+ }
+}
+
+int
+rte_memarea_dump(struct rte_memarea *ma, FILE *f, bool dump_all)
+{
+ if (ma == NULL || f == NULL) {
+ rte_errno = EINVAL;
+ return -1;
+ }
+
+ memarea_lock(ma);
+ fprintf(f, "memarea name: %s\n", ma->init.name);
+ fprintf(f, " source: %s\n", memarea_source_name(ma->init.source));
+ if (ma->init.source == RTE_MEMAREA_SOURCE_HEAP)
+ fprintf(f, " heap-numa-socket: %d\n", ma->init.heap.socket_id);
+ else if (ma->init.source == RTE_MEMAREA_SOURCE_MEMAREA)
+ fprintf(f, " source-memarea: %s\n",
ma->init.ma.src->init.name);
+ fprintf(f, " algorithm: %s\n", memarea_alg_name(ma->init.alg));
+ fprintf(f, " total-size: 0x%zx\n", ma->init.total_sz);
+ fprintf(f, " mt-safe: %s\n", ma->init.mt_safe ? "yes" : "no");
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+ fprintf(f, " area-base: %p\n", ma->area_base);
+ fprintf(f, " guard-header: %p\n", ma->guard_hdr);
+#endif
+ memarea_dump_objects_brief(ma, f);
+ if (dump_all)
+ memarea_dump_objects_detail(ma, f);
+ memarea_unlock(ma);
+
+ return 0;
+}
diff --git a/lib/memarea/rte_memarea.h b/lib/memarea/rte_memarea.h
index f771fcaf68..834fddcc4d 100644
--- a/lib/memarea/rte_memarea.h
+++ b/lib/memarea/rte_memarea.h
@@ -178,6 +178,27 @@ void *rte_memarea_alloc(struct rte_memarea *ma, size_t
