1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(C) 2020 Marvell International Ltd.
8 #include <rte_byteorder.h>
9 #include <rte_common.h>
11 #include <rte_trace.h>
12 #include <rte_version.h>
14 #include "eal_trace.h"
16 __rte_format_printf(2, 0)
18 metadata_printf(char **str, const char *fmt, ...)
25 rc = vasprintf(str, fmt, ap);
32 meta_copy(char **meta, int *offset, char *str, int rc)
40 ptr = realloc(ptr, count + rc + 1);
44 memcpy(RTE_PTR_ADD(ptr, count), str, rc);
45 ptr[count + rc] = '\0';
60 meta_data_type_emit(char **meta, int *offset)
65 rc = metadata_printf(&str,
67 "typealias integer {size = 8; base = x;}:= uint8_t;\n"
68 "typealias integer {size = 16; base = x;} := uint16_t;\n"
69 "typealias integer {size = 32; base = x;} := uint32_t;\n"
70 "typealias integer {size = 64; base = x;} := uint64_t;\n"
71 "typealias integer {size = 8; signed = true;} := int8_t;\n"
72 "typealias integer {size = 16; signed = true;} := int16_t;\n"
73 "typealias integer {size = 32; signed = true;} := int32_t;\n"
74 "typealias integer {size = 64; signed = true;} := int64_t;\n"
76 "typealias integer {size = 64; base = x;} := uintptr_t;\n"
78 "typealias integer {size = 32; base = x;} := uintptr_t;\n"
81 "typealias integer {size = 64; base = x;} := long;\n"
83 "typealias integer {size = 32; base = x;} := long;\n"
85 "typealias integer {size = 8; signed = false; encoding = ASCII; } := string_bounded_t;\n\n"
87 "typealias integer {size = 64; base = x;} := size_t;\n"
89 "typealias integer {size = 32; base = x;} := size_t;\n"
91 "typealias floating_point {\n"
95 "typealias floating_point {\n"
100 return meta_copy(meta, offset, str, rc);
106 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
114 meta_header_emit(char **meta, int *offset)
116 struct trace *trace = trace_obj_get();
117 char uustr[RTE_UUID_STRLEN];
121 rte_uuid_unparse(trace->uuid, uustr, RTE_UUID_STRLEN);
122 rc = metadata_printf(&str,
127 " byte_order = %s;\n"
128 " packet.header := struct {\n"
130 " uint8_t uuid[16];\n"
132 "};\n\n", uustr, is_be() ? "be" : "le");
133 return meta_copy(meta, offset, str, rc);
137 meta_env_emit(char **meta, int *offset)
142 rc = metadata_printf(&str,
144 " dpdk_version = \"%s\";\n"
145 " tracer_name = \"dpdk\";\n"
146 "};\n\n", rte_version());
147 return meta_copy(meta, offset, str, rc);
151 meta_clock_pass1_emit(char **meta, int *offset)
156 rc = metadata_printf(&str,
158 " name = \"dpdk\";\n"
160 return meta_copy(meta, offset, str, rc);
164 meta_clock_pass2_emit(char **meta, int *offset)
169 rc = metadata_printf(&str,
172 return meta_copy(meta, offset, str, rc);
176 meta_clock_pass3_emit(char **meta, int *offset)
181 rc = metadata_printf(&str,
184 return meta_copy(meta, offset, str, rc);
188 meta_clock_pass4_emit(char **meta, int *offset)
193 rc = metadata_printf(&str,
194 "%20"PRIu64";\n};\n\n"
195 "typealias integer {\n"
196 " size = 48; align = 1; signed = false;\n"
197 " map = clock.dpdk.value;\n"
198 "} := uint48_clock_dpdk_t;\n\n", 0);
200 return meta_copy(meta, offset, str, rc);
204 meta_stream_emit(char **meta, int *offset)
209 rc = metadata_printf(&str,
211 " packet.context := struct {\n"
212 " uint32_t cpu_id;\n"
213 " string_bounded_t name[32];\n"
215 " event.header := struct {\n"
216 " uint48_clock_dpdk_t timestamp;\n"
220 return meta_copy(meta, offset, str, rc);
224 meta_event_emit(char **meta, int *offset, struct trace_point *tp)
229 rc = metadata_printf(&str,
233 " fields := struct {\n"
236 "};\n\n", trace_id_get(tp->handle), tp->name,
237 tp->ctf_field != NULL ? tp->ctf_field : "");
238 return meta_copy(meta, offset, str, rc);
242 trace_metadata_create(void)
244 struct trace_point_head *tp_list = trace_list_head_get();
245 struct trace *trace = trace_obj_get();
246 struct trace_point *tp;
250 rc = meta_data_type_emit(&meta, &offset);
254 rc = meta_header_emit(&meta, &offset);
258 rc = meta_env_emit(&meta, &offset);
262 rc = meta_clock_pass1_emit(&meta, &offset);
265 trace->ctf_meta_offset_freq = offset;
267 rc = meta_clock_pass2_emit(&meta, &offset);
270 trace->ctf_meta_offset_freq_off_s = offset;
272 rc = meta_clock_pass3_emit(&meta, &offset);
275 trace->ctf_meta_offset_freq_off = offset;
277 rc = meta_clock_pass4_emit(&meta, &offset);
281 rc = meta_stream_emit(&meta, &offset);
285 STAILQ_FOREACH(tp, tp_list, next)
286 if (meta_event_emit(&meta, &offset, tp) < 0)
289 trace->ctf_meta = meta;
298 trace_metadata_destroy(void)
300 struct trace *trace = trace_obj_get();
302 if (trace->ctf_meta) {
303 free(trace->ctf_meta);
304 trace->ctf_meta = NULL;
309 meta_fix_freq(struct trace *trace, char *meta)
314 str = RTE_PTR_ADD(meta, trace->ctf_meta_offset_freq);
315 rc = sprintf(str, "%20"PRIu64"", rte_get_timer_hz());
320 meta_fix_freq_offset(struct trace *trace, char *meta)
322 uint64_t uptime_tickes_floor, uptime_ticks, freq, uptime_sec;
323 uint64_t offset, offset_s;
327 uptime_ticks = trace->uptime_ticks &
328 ((1ULL << __RTE_TRACE_EVENT_HEADER_ID_SHIFT) - 1);
329 freq = rte_get_tsc_hz();
330 uptime_tickes_floor = RTE_ALIGN_MUL_FLOOR(uptime_ticks, freq);
332 uptime_sec = uptime_tickes_floor / freq;
333 offset_s = trace->epoch_sec - uptime_sec;
335 offset = uptime_ticks - uptime_tickes_floor;
336 offset += trace->epoch_nsec * (freq / NSEC_PER_SEC);
338 str = RTE_PTR_ADD(meta, trace->ctf_meta_offset_freq_off_s);
339 rc = sprintf(str, "%20"PRIu64"", offset_s);
341 str = RTE_PTR_ADD(meta, trace->ctf_meta_offset_freq_off);
342 rc = sprintf(str, "%20"PRIu64"", offset);
347 meta_fixup(struct trace *trace, char *meta)
349 meta_fix_freq(trace, meta);
350 meta_fix_freq_offset(trace, meta);
354 rte_trace_metadata_dump(FILE *f)
356 struct trace *trace = trace_obj_get();
357 char *ctf_meta = trace->ctf_meta;
360 if (!rte_trace_is_enabled())
363 if (ctf_meta == NULL)
366 if (!__atomic_load_n(&trace->ctf_fixup_done, __ATOMIC_SEQ_CST) &&
367 rte_get_timer_hz()) {
368 meta_fixup(trace, ctf_meta);
369 __atomic_store_n(&trace->ctf_fixup_done, 1, __ATOMIC_SEQ_CST);
372 rc = fprintf(f, "%s", ctf_meta);
373 return rc < 0 ? rc : 0;
376 char *trace_metadata_fixup_field(const char *field)
378 const char *ctf_reserved_words[] = {
386 /* reserved keywords */
387 for (i = 0; i < RTE_DIM(ctf_reserved_words); i++) {
388 if (strcmp(field, ctf_reserved_words[i]) != 0)
390 if (asprintf(&out, "_%s", ctf_reserved_words[i]) == -1)
395 /* nothing to replace, return early */
396 if (strstr(field, ".") == NULL && strstr(field, "->") == NULL)
403 while ((p = strstr(p, ".")) != NULL) {
408 while ((p = strstr(p, "->")) != NULL) {
411 memmove(p, p + 1, strlen(p));