trace: create CTF TDSL metadata in memory

Common trace format(CTF) defines the metadata[1][2] for trace events,
This patch creates the metadata for the DPDK events in memory and
later this will be saved to trace directory on rte_trace_save()
invocation.

[1] https://diamon.org/ctf/#specification
[2] https://diamon.org/ctf/#examples

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
Acked-by: David Marchand <david.marchand@redhat.com>

diff --git a/lib/librte_eal/common/eal_common_trace.c b/lib/librte_eal/common/eal_common_trace.c
index d88b2cd..923b1dc 100644 (file)
--- a/lib/librte_eal/common/eal_common_trace.c
+++ b/lib/librte_eal/common/eal_common_trace.c
@@ -57,9 +57,13 @@ eal_trace_init(void)
         */
        trace_uuid_generate();
 
+       /* Generate CTF TDSL metadata */
+       if (trace_metadata_create() < 0)
+               goto fail;
+
        /* Create trace directory */
        if (trace_mkdir())
-               goto fail;
+               goto free_meta;
 
        /* Save current epoch timestamp for future use */
        if (trace_epoch_time_save() < 0)
@@ -69,6 +73,8 @@ eal_trace_init(void)
 
        return 0;
 
+free_meta:
+       trace_metadata_destroy();
 fail:
        trace_err("failed to initialize trace [%s]", rte_strerror(rte_errno));
        return -rte_errno;
@@ -79,6 +85,7 @@ eal_trace_fini(void)
 {
        if (!rte_trace_is_enabled())
                return;
+       trace_metadata_destroy();
 }
 
 bool

diff --git a/lib/librte_eal/common/eal_common_trace_ctf.c b/lib/librte_eal/common/eal_common_trace_ctf.c
new file mode 100644 (file)
index 0000000..5ad44cc
--- /dev/null
+++ b/lib/librte_eal/common/eal_common_trace_ctf.c
@@ -0,0 +1,302 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2020 Marvell International Ltd.
+ */
+
+#include <inttypes.h>
+#include <time.h>
+
+#include <rte_byteorder.h>
+#include <rte_common.h>
+#include <rte_time.h>
+#include <rte_trace.h>
+#include <rte_version.h>
+
+#include "eal_trace.h"
+
+__rte_format_printf(2, 0)
+static int
+metadata_printf(char **str, const char *fmt, ...)
+{
+       va_list ap;
+       int rc;
+
+       *str = NULL;
+       va_start(ap, fmt);
+       rc = vasprintf(str, fmt, ap);
+       va_end(ap);
+
+       return rc;
+}
+
+static int
+meta_copy(char **meta, int *offset, char *str, int rc)
+{
+       int count = *offset;
+       char *ptr = *meta;
+
+       if (rc < 0)
+               return rc;
+
+       ptr = realloc(ptr, count + rc);
+       if (ptr == NULL)
+               goto free_str;
+
+       memcpy(RTE_PTR_ADD(ptr, count), str, rc);
+       count += rc;
+       free(str);
+
+       *meta = ptr;
+       *offset = count;
+
+       return rc;
+
+free_str:
+       if (str)
+               free(str);
+       return -ENOMEM;
+}
+
+static int
+meta_data_type_emit(char **meta, int *offset)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "/* CTF 1.8 */\n"
+               "typealias integer {size = 8; base = x;}:= uint8_t;\n"
+               "typealias integer {size = 16; base = x;} := uint16_t;\n"
+               "typealias integer {size = 32; base = x;} := uint32_t;\n"
+               "typealias integer {size = 64; base = x;} := uint64_t;\n"
+               "typealias integer {size = 8; signed = true;}  := int8_t;\n"
+               "typealias integer {size = 16; signed = true;} := int16_t;\n"
+               "typealias integer {size = 32; signed = true;} := int32_t;\n"
+               "typealias integer {size = 64; signed = true;} := int64_t;\n"
+#ifdef RTE_ARCH_64
+               "typealias integer {size = 64; base = x;} := uintptr_t;\n"
+#else
+               "typealias integer {size = 32; base = x;} := uintptr_t;\n"
+#endif
+#ifdef RTE_ARCH_64
+               "typealias integer {size = 64; base = x;} := long;\n"
+#else
+               "typealias integer {size = 32; base = x;} := long;\n"
+#endif
+               "typealias integer {size = 8; signed = false; encoding = ASCII; } := string_bounded_t;\n\n"
+               "typealias floating_point {\n"
+               "    exp_dig = 8;\n"
+               "    mant_dig = 24;\n"
+               "} := float;\n\n"
+               "typealias floating_point {\n"
+               "    exp_dig = 11;\n"
+               "    mant_dig = 53;\n"
+               "} := double;\n\n");
+
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+is_be(void)
+{
+#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+       return 1;
+#else
+       return 0;
+#endif
+}
+
+static int
+meta_header_emit(char **meta, int *offset)
+{
+       struct trace *trace = trace_obj_get();
+       char uustr[RTE_UUID_STRLEN];
+       char *str = NULL;
+       int rc;
+
+       rte_uuid_unparse(trace->uuid, uustr, RTE_UUID_STRLEN);
+       rc = metadata_printf(&str,
+               "trace {\n"
+               "    major = 1;\n"
+               "    minor = 8;\n"
+               "    uuid = \"%s\";\n"
+               "    byte_order = %s;\n"
+               "    packet.header := struct {\n"
+               "           uint32_t magic;\n"
+               "           uint8_t  uuid[16];\n"
+               "    };\n"
+               "};\n\n", uustr, is_be() ? "be" : "le");
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+meta_env_emit(char **meta, int *offset)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "env {\n"
+               "    dpdk_version = \"%s\";\n"
+               "    tracer_name = \"dpdk\";\n"
+               "};\n\n", rte_version());
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+meta_clock_pass1_emit(char **meta, int *offset)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "clock {\n"
+               "    name = \"dpdk\";\n"
+               "    freq = ");
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+meta_clock_pass2_emit(char **meta, int *offset)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "%20"PRIu64";\n"
+               "    offset_s =", 0);
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+meta_clock_pass3_emit(char **meta, int *offset)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "%20"PRIu64";\n"
+               "    offset =", 0);
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+meta_clock_pass4_emit(char **meta, int *offset)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "%20"PRIu64";\n};\n\n"
+               "typealias integer {\n"
+               "    size = 48; align = 1; signed = false;\n"
+               "    map = clock.dpdk.value;\n"
+               "} := uint48_clock_dpdk_t;\n\n", 0);
+
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+meta_stream_emit(char **meta, int *offset)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "stream {\n"
+               "    packet.context := struct {\n"
+               "         uint32_t cpu_id;\n"
+               "         string_bounded_t name[32];\n"
+               "    };\n"
+               "    event.header := struct {\n"
+               "          uint48_clock_dpdk_t timestamp;\n"
+               "          uint16_t id;\n"
+               "    } align(64);\n"
+               "};\n\n");
+       return meta_copy(meta, offset, str, rc);
+}
+
+static int
+meta_event_emit(char **meta, int *offset, struct trace_point *tp)
+{
+       char *str = NULL;
+       int rc;
+
+       rc = metadata_printf(&str,
+               "event {\n"
+               "    id = %d;\n"
+               "    name = \"%s\";\n"
+               "    fields := struct {\n"
+               "        %s\n"
+               "    };\n"
+               "};\n\n", trace_id_get(tp->handle), tp->name, tp->ctf_field);
+       return meta_copy(meta, offset, str, rc);
+}
+
+int
+trace_metadata_create(void)
+{
+       struct trace_point_head *tp_list = trace_list_head_get();
+       struct trace *trace = trace_obj_get();
+       struct trace_point *tp;
+       int rc, offset = 0;
+       char *meta = NULL;
+
+       rc = meta_data_type_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+
+       rc = meta_header_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+
+       rc = meta_env_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+
+       rc = meta_clock_pass1_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+       trace->ctf_meta_offset_freq = offset;
+
+       rc = meta_clock_pass2_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+       trace->ctf_meta_offset_freq_off_s = offset;
+
+       rc = meta_clock_pass3_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+       trace->ctf_meta_offset_freq_off = offset;
+
+       rc = meta_clock_pass4_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+
+       rc = meta_stream_emit(&meta, &offset);
+       if (rc < 0)
+               goto fail;
+
+       STAILQ_FOREACH(tp, tp_list, next)
+               if (meta_event_emit(&meta, &offset, tp) < 0)
+                       goto fail;
+
+       trace->ctf_meta = meta;
+       return 0;
+
+fail:
+       if (meta)
+               free(meta);
+       return -EBADF;
+}
+
+void
+trace_metadata_destroy(void)
+{
+       struct trace *trace = trace_obj_get();
+
+       if (trace->ctf_meta) {
+               free(trace->ctf_meta);
+               trace->ctf_meta = NULL;
+       }
+}
+

diff --git a/lib/librte_eal/common/eal_trace.h b/lib/librte_eal/common/eal_trace.h
index 51bb2c3..f8d75bb 100644 (file)
--- a/lib/librte_eal/common/eal_trace.h
+++ b/lib/librte_eal/common/eal_trace.h
@@ -41,6 +41,11 @@ struct trace {
        uint64_t epoch_sec;
        uint64_t epoch_nsec;
        uint64_t uptime_ticks;
+       char *ctf_meta;
+       uint32_t ctf_meta_offset_freq;
+       uint32_t ctf_meta_offset_freq_off_s;
+       uint32_t ctf_meta_offset_freq_off;
+       uint16_t ctf_fixup_done;
        rte_spinlock_t lock;
 };
 
@@ -62,6 +67,8 @@ struct trace_point_head *trace_list_head_get(void);
 /* Util functions */
 bool trace_has_duplicate_entry(void);
 void trace_uuid_generate(void);
+int trace_metadata_create(void);
+void trace_metadata_destroy(void);
 int trace_mkdir(void);
 int trace_epoch_time_save(void);
 

diff --git a/lib/librte_eal/common/meson.build b/lib/librte_eal/common/meson.build
index 3dc3203..d2ac443 100644 (file)
--- a/lib/librte_eal/common/meson.build
+++ b/lib/librte_eal/common/meson.build
@@ -43,6 +43,7 @@ sources += files(
        'eal_common_thread.c',
        'eal_common_timer.c',
        'eal_common_trace.c',
+       'eal_common_trace_ctf.c',
        'eal_common_trace_utils.c',
        'eal_common_uuid.c',
        'hotplug_mp.c',

diff --git a/lib/librte_eal/freebsd/Makefile b/lib/librte_eal/freebsd/Makefile
index ae59c8c..539ad44 100644 (file)
--- a/lib/librte_eal/freebsd/Makefile
+++ b/lib/librte_eal/freebsd/Makefile
@@ -60,6 +60,7 @@ SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += eal_common_proc.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += eal_common_fbarray.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += eal_common_uuid.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += eal_common_trace.c
+SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += eal_common_trace_ctf.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += eal_common_trace_utils.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += rte_malloc.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += hotplug_mp.c

diff --git a/lib/librte_eal/linux/Makefile b/lib/librte_eal/linux/Makefile
index 7992500..f00588d 100644 (file)
--- a/lib/librte_eal/linux/Makefile
+++ b/lib/librte_eal/linux/Makefile
@@ -67,6 +67,7 @@ SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += eal_common_proc.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += eal_common_fbarray.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += eal_common_uuid.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += eal_common_trace.c
+SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += eal_common_trace_ctf.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += eal_common_trace_utils.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += rte_malloc.c
 SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += hotplug_mp.c