Add functional test suite to exercise the <rte_lcore_var.h> API.
Signed-off-by: Mattias Rönnblom <mattias.ronnb...@ericsson.com>
Acked-by: Morten Brørup <m...@smartsharesystems.com>
Acked-by: Chengwen Feng <fengcheng...@huawei.com>
Acked-by: Stephen Hemminger <step...@networkplumber.org>
--
PATCH v6:
* Update FOREACH invocations to match new API.
RFC v5:
* Adapt tests to reflect the removal of the GET() and SET() macros.
RFC v4:
* Check all lcore id's values for all variables in the many variables
test case.
* Introduce test case for max-sized lcore variables.
RFC v2:
* Improve alignment-related test coverage.
---
app/test/meson.build | 1 +
app/test/test_lcore_var.c | 436 ++++++++++++++++++++++++++++++++++++++
2 files changed, 437 insertions(+)
create mode 100644 app/test/test_lcore_var.c
diff --git a/app/test/meson.build b/app/test/meson.build
index e29258e6ec..48279522f0 100644
--- a/app/test/meson.build
+++ b/app/test/meson.build
@@ -103,6 +103,7 @@ source_file_deps = {
'test_ipsec_sad.c': ['ipsec'],
'test_kvargs.c': ['kvargs'],
'test_latencystats.c': ['ethdev', 'latencystats', 'metrics'] +
sample_packet_forward_deps,
+ 'test_lcore_var.c': [],
'test_lcores.c': [],
'test_link_bonding.c': ['ethdev', 'net_bond',
'net'] + packet_burst_generator_deps + virtual_pmd_deps,
diff --git a/app/test/test_lcore_var.c b/app/test/test_lcore_var.c
new file mode 100644
index 0000000000..2a1f258548
--- /dev/null
+++ b/app/test/test_lcore_var.c
@@ -0,0 +1,436 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2024 Ericsson AB
+ */
+
+#include <inttypes.h>
+#include <stdio.h>
+#include <string.h>
+
+#include <rte_launch.h>
+#include <rte_lcore_var.h>
+#include <rte_random.h>
+
+#include "test.h"
+
+#define MIN_LCORES 2
+
+RTE_LCORE_VAR_HANDLE(int, test_int);
+RTE_LCORE_VAR_HANDLE(char, test_char);
+RTE_LCORE_VAR_HANDLE(long, test_long_sized);
+RTE_LCORE_VAR_HANDLE(short, test_short);
+RTE_LCORE_VAR_HANDLE(long, test_long_sized_aligned);
+
+struct int_checker_state {
+ int old_value;
+ int new_value;
+ bool success;
+};
+
+static void
+rand_blk(void *blk, size_t size)
+{
+ size_t i;
+
+ for (i = 0; i < size; i++)
+ ((unsigned char *)blk)[i] = (unsigned char)rte_rand();
+}
+
+static bool
+is_ptr_aligned(const void *ptr, size_t align)
+{
+ return ptr != NULL ? (uintptr_t)ptr % align == 0 : false;
+}
+
+static int
+check_int(void *arg)
+{
+ struct int_checker_state *state = arg;
+
+ int *ptr = RTE_LCORE_VAR_VALUE(test_int);
+
+ bool naturally_aligned = is_ptr_aligned(ptr, sizeof(int));
+
+ bool equal = *(RTE_LCORE_VAR_VALUE(test_int)) == state->old_value;
+
+ state->success = equal && naturally_aligned;
+
+ *ptr = state->new_value;
+
+ return 0;
+}
+
+RTE_LCORE_VAR_INIT(test_int);
+RTE_LCORE_VAR_INIT(test_char);
+RTE_LCORE_VAR_INIT_SIZE(test_long_sized, 32);
+RTE_LCORE_VAR_INIT(test_short);
+RTE_LCORE_VAR_INIT_SIZE_ALIGN(test_long_sized_aligned, sizeof(long),
+ RTE_CACHE_LINE_SIZE);
+
+static int
+test_int_lvar(void)
+{
+ unsigned int lcore_id;
+
+ struct int_checker_state states[RTE_MAX_LCORE] = {};
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ struct int_checker_state *state = &states[lcore_id];
+
+ state->old_value = (int)rte_rand();
+ state->new_value = (int)rte_rand();
+
+ *RTE_LCORE_VAR_LCORE_VALUE(lcore_id, test_int) =
+ state->old_value;
+ }
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id)
+ rte_eal_remote_launch(check_int, &states[lcore_id], lcore_id);
+
+ rte_eal_mp_wait_lcore();
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ struct int_checker_state *state = &states[lcore_id];
+ int value;
+
+ TEST_ASSERT(state->success, "Unexpected value "
+ "encountered on lcore %d", lcore_id);
+
+ value = *RTE_LCORE_VAR_LCORE_VALUE(lcore_id, test_int);
+ TEST_ASSERT_EQUAL(state->new_value, value,
+ "Lcore %d failed to update int", lcore_id);
+ }
+
+ /* take the opportunity to test the foreach macro */
+ int *v;
+ unsigned int i = 0;
+ RTE_LCORE_VAR_FOREACH_VALUE(lcore_id, v, test_int) {
+ TEST_ASSERT_EQUAL(i, lcore_id, "Encountered lcore id %d "
+ "while expecting %d during iteration",
+ lcore_id, i);
+ TEST_ASSERT_EQUAL(states[lcore_id].new_value, *v,
+ "Unexpected value on lcore %d during "
+ "iteration", lcore_id);
+ i++;
+ }
+
+ return TEST_SUCCESS;
+}
+
+static int
+test_sized_alignment(void)
+{
+ unsigned int lcore_id;
+ long *v;
+
+ RTE_LCORE_VAR_FOREACH_VALUE(lcore_id, v, test_long_sized) {
+ TEST_ASSERT(is_ptr_aligned(v, alignof(long)),
+ "Type-derived alignment failed");
+ }
+
+ RTE_LCORE_VAR_FOREACH_VALUE(lcore_id, v, test_long_sized_aligned) {
+ TEST_ASSERT(is_ptr_aligned(v, RTE_CACHE_LINE_SIZE),
+ "Explicit alignment failed");
+ }
+
+ return TEST_SUCCESS;
+}
+
+/* private, larger, struct */
+#define TEST_STRUCT_DATA_SIZE 1234
+
+struct test_struct {
+ uint8_t data[TEST_STRUCT_DATA_SIZE];
+};
+
+static RTE_LCORE_VAR_HANDLE(char, before_struct);
+static RTE_LCORE_VAR_HANDLE(struct test_struct, test_struct);
+static RTE_LCORE_VAR_HANDLE(char, after_struct);
+
+struct struct_checker_state {
+ struct test_struct old_value;
+ struct test_struct new_value;
+ bool success;
+};
+
+static int check_struct(void *arg)
+{
+ struct struct_checker_state *state = arg;
+
+ struct test_struct *lcore_struct = RTE_LCORE_VAR_VALUE(test_struct);
+
+ bool properly_aligned =
+ is_ptr_aligned(test_struct, alignof(struct test_struct));
+
+ bool equal = memcmp(lcore_struct->data, state->old_value.data,
+ TEST_STRUCT_DATA_SIZE) == 0;
+
+ state->success = equal && properly_aligned;
+
+ memcpy(lcore_struct->data, state->new_value.data,
+ TEST_STRUCT_DATA_SIZE);
+
+ return 0;
+}
+
+static int
+test_struct_lvar(void)
+{
+ unsigned int lcore_id;
+
+ RTE_LCORE_VAR_ALLOC(before_struct);
+ RTE_LCORE_VAR_ALLOC(test_struct);
+ RTE_LCORE_VAR_ALLOC(after_struct);
+
+ struct struct_checker_state states[RTE_MAX_LCORE];
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ struct struct_checker_state *state = &states[lcore_id];
+
+ rand_blk(state->old_value.data, TEST_STRUCT_DATA_SIZE);
+ rand_blk(state->new_value.data, TEST_STRUCT_DATA_SIZE);
+
+ memcpy(RTE_LCORE_VAR_LCORE_VALUE(lcore_id, test_struct)->data,
+ state->old_value.data, TEST_STRUCT_DATA_SIZE);
+ }
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id)
+ rte_eal_remote_launch(check_struct, &states[lcore_id],
+ lcore_id);
+
+ rte_eal_mp_wait_lcore();
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ struct struct_checker_state *state = &states[lcore_id];
+ struct test_struct *lstruct =
+ RTE_LCORE_VAR_LCORE_VALUE(lcore_id, test_struct);
+
+ TEST_ASSERT(state->success, "Unexpected value encountered on "
+ "lcore %d", lcore_id);
+
+ bool equal = memcmp(lstruct->data, state->new_value.data,
+ TEST_STRUCT_DATA_SIZE) == 0;
+
+ TEST_ASSERT(equal, "Lcore %d failed to update struct",
+ lcore_id);
+ }
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ char before =
+ *RTE_LCORE_VAR_LCORE_VALUE(lcore_id, before_struct);
+ char after =
+ *RTE_LCORE_VAR_LCORE_VALUE(lcore_id, after_struct);
+
+ TEST_ASSERT_EQUAL(before, 0, "Lcore variable before test "
+ "struct was modified on lcore %d", lcore_id);
+ TEST_ASSERT_EQUAL(after, 0, "Lcore variable after test "
+ "struct was modified on lcore %d", lcore_id);
+ }
+
+ return TEST_SUCCESS;
+}
+
+#define TEST_ARRAY_SIZE 99
+
+typedef uint16_t test_array_t[TEST_ARRAY_SIZE];
+
+static void test_array_init_rand(test_array_t a)
+{
+ size_t i;
+ for (i = 0; i < TEST_ARRAY_SIZE; i++)
+ a[i] = (uint16_t)rte_rand();
+}
+
+static bool test_array_equal(test_array_t a, test_array_t b)
+{
+ size_t i;
+ for (i = 0; i < TEST_ARRAY_SIZE; i++) {
+ if (a[i] != b[i])
+ return false;
+ }
+ return true;
+}
+
+static void test_array_copy(test_array_t dst, const test_array_t src)
+{
+ size_t i;
+ for (i = 0; i < TEST_ARRAY_SIZE; i++)
+ dst[i] = src[i];
+}
+
+static RTE_LCORE_VAR_HANDLE(char, before_array);
+static RTE_LCORE_VAR_HANDLE(test_array_t, test_array);
+static RTE_LCORE_VAR_HANDLE(char, after_array);
+
+struct array_checker_state {
+ test_array_t old_value;
+ test_array_t new_value;
+ bool success;
+};
+
+static int check_array(void *arg)
+{
+ struct array_checker_state *state = arg;
+
+ test_array_t *lcore_array = RTE_LCORE_VAR_VALUE(test_array);
+
+ bool properly_aligned =
+ is_ptr_aligned(lcore_array, alignof(test_array_t));
+
+ bool equal = test_array_equal(*lcore_array, state->old_value);
+
+ state->success = equal && properly_aligned;
+
+ test_array_copy(*lcore_array, state->new_value);
+
+ return 0;
+}
+
+static int
+test_array_lvar(void)
+{
+ unsigned int lcore_id;
+
+ RTE_LCORE_VAR_ALLOC(before_array);
+ RTE_LCORE_VAR_ALLOC(test_array);
+ RTE_LCORE_VAR_ALLOC(after_array);
+
+ struct array_checker_state states[RTE_MAX_LCORE];
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ struct array_checker_state *state = &states[lcore_id];
+
+ test_array_init_rand(state->new_value);
+ test_array_init_rand(state->old_value);
+
+ test_array_copy(*RTE_LCORE_VAR_LCORE_VALUE(lcore_id,
+ test_array),
+ state->old_value);
+ }
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id)
+ rte_eal_remote_launch(check_array, &states[lcore_id],
+ lcore_id);
+
+ rte_eal_mp_wait_lcore();
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ struct array_checker_state *state = &states[lcore_id];
+ test_array_t *larray =
+ RTE_LCORE_VAR_LCORE_VALUE(lcore_id, test_array);
+
+ TEST_ASSERT(state->success, "Unexpected value encountered on "
+ "lcore %d", lcore_id);
+
+ bool equal = test_array_equal(*larray, state->new_value);
+
+ TEST_ASSERT(equal, "Lcore %d failed to update array",
+ lcore_id);
+ }
+
+ RTE_LCORE_FOREACH_WORKER(lcore_id) {
+ char before =
+ *RTE_LCORE_VAR_LCORE_VALUE(lcore_id, before_array);
+ char after =
+ *RTE_LCORE_VAR_LCORE_VALUE(lcore_id, after_array);
+
+ TEST_ASSERT_EQUAL(before, 0, "Lcore variable before test "
+ "array was modified on lcore %d", lcore_id);
+ TEST_ASSERT_EQUAL(after, 0, "Lcore variable after test "
+ "array was modified on lcore %d", lcore_id);
+ }
+
+ return TEST_SUCCESS;
+}
+
+#define MANY_LVARS (2 * RTE_MAX_LCORE_VAR / sizeof(uint32_t))
+
+static int
+test_many_lvars(void)
+{
+ uint32_t **handlers = malloc(sizeof(uint32_t *) * MANY_LVARS);
+ unsigned int i;
+
+ TEST_ASSERT(handlers != NULL, "Unable to allocate memory");
+
+ for (i = 0; i < MANY_LVARS; i++) {
+ unsigned int lcore_id;
+
+ RTE_LCORE_VAR_ALLOC(handlers[i]);
+
+ for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
+ uint32_t *v =
+ RTE_LCORE_VAR_LCORE_VALUE(lcore_id,
handlers[i]);
+ *v = (uint32_t)(i * lcore_id);
+ }
+ }
+
+ for (i = 0; i < MANY_LVARS; i++) {
+ unsigned int lcore_id;
+
+ for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
+ uint32_t v = *RTE_LCORE_VAR_LCORE_VALUE(lcore_id,
+ handlers[i]);
+ TEST_ASSERT_EQUAL((uint32_t)(i * lcore_id), v,
+ "Unexpected lcore variable value on "
+ "lcore %d", lcore_id);
+ }
+ }
+
+ free(handlers);
+
+ return TEST_SUCCESS;
+}
+
+static int
+test_large_lvar(void)
+{
+ RTE_LCORE_VAR_HANDLE(unsigned char, large);
+ unsigned int lcore_id;
+
+ RTE_LCORE_VAR_ALLOC_SIZE(large, RTE_MAX_LCORE_VAR);
+
+ for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
+ unsigned char *ptr = RTE_LCORE_VAR_LCORE_VALUE(lcore_id, large);
+
+ memset(ptr, (unsigned char)lcore_id, RTE_MAX_LCORE_VAR);
+ }
+
+ for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
+ unsigned char *ptr = RTE_LCORE_VAR_LCORE_VALUE(lcore_id, large);
+ size_t i;
+
+ for (i = 0; i < RTE_MAX_LCORE_VAR; i++)
+ TEST_ASSERT_EQUAL(ptr[i], (unsigned char)lcore_id,
+ "Large lcore variable value is "
+ "corrupted on lcore %d.",
+ lcore_id);
+ }
+
+ return TEST_SUCCESS;
+}
+
+static struct unit_test_suite lcore_var_testsuite = {
+ .suite_name = "lcore variable autotest",
+ .unit_test_cases = {
+ TEST_CASE(test_int_lvar),
+ TEST_CASE(test_sized_alignment),
+ TEST_CASE(test_struct_lvar),
+ TEST_CASE(test_array_lvar),
+ TEST_CASE(test_many_lvars),
+ TEST_CASE(test_large_lvar),
+ TEST_CASES_END()
+ },
+};
+
+static int test_lcore_var(void)
+{
+ if (rte_lcore_count() < MIN_LCORES) {
+ printf("Not enough cores for lcore_var_autotest; expecting at "
+ "least %d.\n", MIN_LCORES);
+ return TEST_SKIPPED;
+ }
+
+ return unit_test_suite_runner(&lcore_var_testsuite);
+}
+
+REGISTER_FAST_TEST(lcore_var_autotest, true, false, test_lcore_var);
--
2.43.0
