[dpdk-dev] [PATCH v5 27/33] eal/trace: add unit test cases

[<jerinj@marvell.com>]

From: Sunil Kumar Kori <skori@marvell.com>

Example commands to run UT and check the traces with babeltrace viewer.

- Delete the existing /root/dpdk-traces/ directory if needed.
> sudo rm -rf /root/dpdk-traces/

- Start the dpdk-test
> sudo ./build/app/test/dpdk-test  -c 0x3 - --trace=.*

- Run trace_autotest
> trace_autotest

- View the traces with babletrace viewer.
> sudo babeltrace /root/dpdk-traces/

Signed-off-by: Sunil Kumar Kori <skori@marvell.com>
---
 app/test/Makefile              |   3 +-
 app/test/meson.build           |   2 +
 app/test/test_trace.c          | 258 +++++++++++++++++++++++++++++++++
 app/test/test_trace.h          |  15 ++
 app/test/test_trace_register.c |  19 +++
 5 files changed, 296 insertions(+), 1 deletion(-)
 create mode 100644 app/test/test_trace.c
 create mode 100644 app/test/test_trace.h
 create mode 100644 app/test/test_trace_register.c

diff --git a/app/test/Makefile b/app/test/Makefile
index be53d33c3..9fb7b843f 100644
--- a/app/test/Makefile
+++ b/app/test/Makefile
@@ -148,7 +148,8 @@ SRCS-y += test_alarm.c
 SRCS-y += test_interrupts.c
 SRCS-y += test_version.c
 SRCS-y += test_func_reentrancy.c
-
+SRCS-y += test_trace.c
+SRCS-y += test_trace_register.c
 SRCS-y += test_service_cores.c
 
 ifeq ($(CONFIG_RTE_LIBRTE_PMD_RING),y)
diff --git a/app/test/meson.build b/app/test/meson.build
index 351d29cb6..4966236e8 100644
--- a/app/test/meson.build
+++ b/app/test/meson.build
@@ -121,6 +121,8 @@ test_sources = files('commands.c',
 	'test_timer_racecond.c',
 	'test_timer_secondary.c',
 	'test_ticketlock.c',
+	'test_trace.c',
+	'test_trace_register.c',
 	'test_version.c',
 	'virtual_pmd.c'
 )
diff --git a/app/test/test_trace.c b/app/test/test_trace.c
new file mode 100644
index 000000000..1f69e4142
--- /dev/null
+++ b/app/test/test_trace.c
@@ -0,0 +1,258 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2020 Marvell International Ltd.
+ */
+
+#include <rte_trace_eal.h>
+#include <rte_lcore.h>
+
+#include "test.h"
+#include "test_trace.h"
+
+static int32_t
+test_trace_point_globbing(void)
+{
+	bool val;
+	int rc;
+
+	rc = rte_trace_pattern("app.dpdk.test*", false);
+	if (rc != 1)
+		goto failed;
+
+	val = rte_trace_is_disabled(&__app_dpdk_test_tp);
+	if (val == false)
+		goto failed;
+
+	rc = rte_trace_pattern("app.dpdk.test*", true);
+	if (rc != 1)
+		goto failed;
+
+	val = rte_trace_is_enabled(&__app_dpdk_test_tp);
+	if (val == false)
+		goto failed;
+
+	rc = rte_trace_pattern("invalid_testpoint.*", true);
+	if (rc != 0)
+		goto failed;
+
+	return TEST_SUCCESS;
+
+failed:
+	return TEST_FAILED;
+}
+
+static int32_t
+test_trace_point_regex(void)
+{
+	bool val;
+	int rc;
+
+
+	rc = rte_trace_regexp("app.dpdk.test*", false);
+	if (rc != 1)
+		goto failed;
+
+	val = rte_trace_is_disabled(&__app_dpdk_test_tp);
+	if (val == false)
+		goto failed;
+
+	rc = rte_trace_regexp("app.dpdk.test*", true);
+	if (rc != 1)
+		goto failed;
+
+	val = rte_trace_is_enabled(&__app_dpdk_test_tp);
+	if (val == false)
+		goto failed;
+
+	rc = rte_trace_regexp("invalid_testpoint.*", true);
+	if (rc != 0)
+		goto failed;
+
+	return TEST_SUCCESS;
+
+failed:
+	return TEST_FAILED;
+}
+
+static int32_t
+test_trace_point_disable_enable(void)
+{
+	bool val;
+	int rc;
+
+	rc = rte_trace_disable(&__app_dpdk_test_tp);
+	if (rc < 0)
+		goto failed;
+
+	val = rte_trace_is_disabled(&__app_dpdk_test_tp);
+	if (val == false)
+		goto failed;
+
+	rc = rte_trace_enable(&__app_dpdk_test_tp);
+	if (rc < 0)
+		goto failed;
+
+	val = rte_trace_is_enabled(&__app_dpdk_test_tp);
+	if (val == false)
+		goto failed;
+
+	/* Emit the trace */
+	app_dpdk_test_tp("app.dpdk.test.tp");
+	return TEST_SUCCESS;
+
+failed:
+	return TEST_FAILED;
+}
+
+static int32_t
+test_trace_validity(void)
+{
+	rte_trace_t invalid_trace = (int64_t)-1; /* Invalid trace */
+	bool rc;
+
+	rc = rte_trace_id_is_invalid(&__app_dpdk_test_tp);
+	if (rc == true)
+		goto failed;
+
+	rc = rte_trace_id_is_invalid(&invalid_trace);
+	if (rc == false)
+		goto failed;
+
+	return TEST_SUCCESS;
+
+failed:
+	return TEST_FAILED;
+}
+
+static int
+test_trace_global_status(void)
+{
+	bool enabled, disabled;
+
+	enabled = rte_trace_global_is_enabled();
+	disabled = rte_trace_global_is_disabled();
+
+	if (enabled != disabled)
+		return TEST_SUCCESS;
+
+	return TEST_FAILED;
+}
+
+static int
+test_trace_mode(void)
+{
+	enum rte_trace_mode current;
+
+	current = rte_trace_mode_get();
+
+	if (rte_trace_global_is_disabled())
+		return TEST_SKIPPED;
+
+	rte_trace_mode_set(RTE_TRACE_MODE_DISCARD);
+	if (rte_trace_mode_get() != RTE_TRACE_MODE_DISCARD)
+		goto failed;
+
+	rte_trace_mode_set(RTE_TRACE_MODE_OVERWRITE);
+	if (rte_trace_mode_get() != RTE_TRACE_MODE_OVERWRITE)
+		goto failed;
+
+	rte_trace_mode_set(current);
+	return TEST_SUCCESS;
+
+failed:
+	return TEST_FAILED;
+
+}
+
+static int
+test_trace_points_lookup(void)
+{
+	rte_trace_t *trace;
+
+	trace =  rte_trace_by_name("app.dpdk.test.tp");
+	if (trace == NULL)
+		goto fail;
+	trace = rte_trace_by_name("this_trace_point_does_not_exist");
+	if (trace != NULL)
+		goto fail;
+
+	return TEST_SUCCESS;
+fail:
+	return TEST_FAILED;
+}
+
+static int
+test_trace_fastpath_point(void)
+{
+	/* Emit the FP trace */
+	app_dpdk_test_fp();
+
+	return TEST_SUCCESS;
+}
+
+static int
+test_generic_trace_points(void)
+{
+	int tmp;
+
+	rte_trace_lib_eal_generic_void();
+	rte_trace_lib_eal_generic_u64(0x10000000000000);
+	rte_trace_lib_eal_generic_u32(0x10000000);
+	rte_trace_lib_eal_generic_u16(0xffee);
+	rte_trace_lib_eal_generic_u8(0xc);
+	rte_trace_lib_eal_generic_i64(-1234);
+	rte_trace_lib_eal_generic_i32(-1234567);
+	rte_trace_lib_eal_generic_i16(12);
+	rte_trace_lib_eal_generic_i8(-3);
+	rte_trace_lib_eal_generic_int(3333333);
+	rte_trace_lib_eal_generic_long(333);
+	rte_trace_lib_eal_generic_float(20.45);
+	rte_trace_lib_eal_generic_double(20000.5000004);
+	rte_trace_lib_eal_generic_ptr(&tmp);
+	rte_trace_lib_eal_generic_str("my string");
+	RTE_TRACE_LIB_EAL_GENERIC_FUNC;
+
+	return TEST_SUCCESS;
+}
+
+static struct unit_test_suite trace_tests = {
+	.suite_name = "trace autotest",
+	.setup = NULL,
+	.teardown = NULL,
+	.unit_test_cases = {
+		TEST_CASE(test_trace_global_status),
+		TEST_CASE(test_trace_mode),
+		TEST_CASE(test_generic_trace_points),
+		TEST_CASE(test_trace_fastpath_point),
+		TEST_CASE(test_trace_point_disable_enable),
+		TEST_CASE(test_trace_point_globbing),
+		TEST_CASE(test_trace_point_regex),
+		TEST_CASE(test_trace_points_lookup),
+		TEST_CASE(test_trace_validity),
+		TEST_CASES_END()
+	}
+};
+
+static int
+test_trace(void)
+{
+	return unit_test_suite_runner(&trace_tests);
+}
+
+REGISTER_TEST_COMMAND(trace_autotest, test_trace);
+
+static int
+test_trace_dump(void)
+{
+	rte_trace_dump(stdout);
+	return 0;
+}
+
+REGISTER_TEST_COMMAND(trace_dump, test_trace_dump);
+
+static int
+test_trace_metadata_dump(void)
+{
+	return rte_trace_metadata_dump(stdout);
+}
+
+REGISTER_TEST_COMMAND(trace_metadata_dump, test_trace_metadata_dump);
diff --git a/app/test/test_trace.h b/app/test/test_trace.h
new file mode 100644
index 000000000..18dd573f3
--- /dev/null
+++ b/app/test/test_trace.h
@@ -0,0 +1,15 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2020 Marvell International Ltd.
+ */
+#include <rte_trace.h>
+
+RTE_TRACE_POINT(
+	app_dpdk_test_tp,
+	RTE_TRACE_POINT_ARGS(const char *str),
+	rte_trace_ctf_string(str);
+)
+
+RTE_TRACE_POINT_FP(
+	app_dpdk_test_fp,
+	RTE_TRACE_POINT_ARGS(void),
+)
diff --git a/app/test/test_trace_register.c b/app/test/test_trace_register.c
new file mode 100644
index 000000000..074b4f4bb
--- /dev/null
+++ b/app/test/test_trace_register.c
@@ -0,0 +1,19 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2020 Marvell International Ltd.
+ */
+#define RTE_TRACE_POINT_REGISTER_SELECT /* Select trace point register macros */
+
+#include <rte_trace.h>
+
+#include "test_trace.h"
+
+/* Define trace points */
+RTE_TRACE_POINT_DEFINE(app_dpdk_test_tp);
+RTE_TRACE_POINT_DEFINE(app_dpdk_test_fp);
+
+RTE_INIT(register_valid_trace_points)
+{
+	RTE_TRACE_POINT_REGISTER(app_dpdk_test_tp, app.dpdk.test.tp);
+	RTE_TRACE_POINT_REGISTER(app_dpdk_test_fp, app.dpdk.test.fp);
+}
+
-- 
2.25.1