1 // SPDX-License-Identifier: GPL-2.0-only
3 * CTF writing support via babeltrace.
11 #include <linux/compiler.h>
12 #include <linux/kernel.h>
13 #include <linux/zalloc.h>
14 #include <babeltrace/ctf-writer/writer.h>
15 #include <babeltrace/ctf-writer/clock.h>
16 #include <babeltrace/ctf-writer/stream.h>
17 #include <babeltrace/ctf-writer/event.h>
18 #include <babeltrace/ctf-writer/event-types.h>
19 #include <babeltrace/ctf-writer/event-fields.h>
20 #include <babeltrace/ctf-ir/utils.h>
21 #include <babeltrace/ctf/events.h>
23 #include "data-convert.h"
31 #include <linux/ctype.h>
32 #include <linux/err.h>
33 #include <linux/time64.h>
36 #include "util/sample.h"
38 #ifdef HAVE_LIBTRACEEVENT
39 #include <event-parse.h>
42 #define pr_N(n, fmt, ...) \
43 eprintf(n, debug_data_convert, fmt, ##__VA_ARGS__)
45 #define pr(fmt, ...) pr_N(1, pr_fmt(fmt), ##__VA_ARGS__)
46 #define pr2(fmt, ...) pr_N(2, pr_fmt(fmt), ##__VA_ARGS__)
48 #define pr_time2(t, fmt, ...) pr_time_N(2, debug_data_convert, t, pr_fmt(fmt), ##__VA_ARGS__)
51 struct bt_ctf_event_class *event_class;
57 struct bt_ctf_stream *stream;
63 /* writer primitives */
64 struct bt_ctf_writer *writer;
65 struct ctf_stream **stream;
67 struct bt_ctf_stream_class *stream_class;
68 struct bt_ctf_clock *clock;
73 struct bt_ctf_field_type *s64;
74 struct bt_ctf_field_type *u64;
75 struct bt_ctf_field_type *s32;
76 struct bt_ctf_field_type *u32;
77 struct bt_ctf_field_type *string;
78 struct bt_ctf_field_type *u32_hex;
79 struct bt_ctf_field_type *u64_hex;
81 struct bt_ctf_field_type *array[6];
83 struct bt_ctf_event_class *comm_class;
84 struct bt_ctf_event_class *exit_class;
85 struct bt_ctf_event_class *fork_class;
86 struct bt_ctf_event_class *mmap_class;
87 struct bt_ctf_event_class *mmap2_class;
91 struct perf_tool tool;
92 struct ctf_writer writer;
98 /* Ordered events configured queue size. */
102 static int value_set(struct bt_ctf_field_type *type,
103 struct bt_ctf_event *event,
104 const char *name, u64 val)
106 struct bt_ctf_field *field;
107 bool sign = bt_ctf_field_type_integer_get_signed(type);
110 field = bt_ctf_field_create(type);
112 pr_err("failed to create a field %s\n", name);
117 ret = bt_ctf_field_signed_integer_set_value(field, val);
119 pr_err("failed to set field value %s\n", name);
123 ret = bt_ctf_field_unsigned_integer_set_value(field, val);
125 pr_err("failed to set field value %s\n", name);
130 ret = bt_ctf_event_set_payload(event, name, field);
132 pr_err("failed to set payload %s\n", name);
136 pr2(" SET [%s = %" PRIu64 "]\n", name, val);
139 bt_ctf_field_put(field);
143 #define __FUNC_VALUE_SET(_name, _val_type) \
144 static __maybe_unused int value_set_##_name(struct ctf_writer *cw, \
145 struct bt_ctf_event *event, \
149 struct bt_ctf_field_type *type = cw->data._name; \
150 return value_set(type, event, name, (u64) val); \
153 #define FUNC_VALUE_SET(_name) __FUNC_VALUE_SET(_name, _name)
159 __FUNC_VALUE_SET(u64_hex, u64)
161 static int string_set_value(struct bt_ctf_field *field, const char *string);
162 static __maybe_unused int
163 value_set_string(struct ctf_writer *cw, struct bt_ctf_event *event,
164 const char *name, const char *string)
166 struct bt_ctf_field_type *type = cw->data.string;
167 struct bt_ctf_field *field;
170 field = bt_ctf_field_create(type);
172 pr_err("failed to create a field %s\n", name);
176 ret = string_set_value(field, string);
178 pr_err("failed to set value %s\n", name);
182 ret = bt_ctf_event_set_payload(event, name, field);
184 pr_err("failed to set payload %s\n", name);
187 bt_ctf_field_put(field);
191 static struct bt_ctf_field_type*
192 get_tracepoint_field_type(struct ctf_writer *cw, struct tep_format_field *field)
194 unsigned long flags = field->flags;
196 if (flags & TEP_FIELD_IS_STRING)
197 return cw->data.string;
199 if (!(flags & TEP_FIELD_IS_SIGNED)) {
200 /* unsigned long are mostly pointers */
201 if (flags & TEP_FIELD_IS_LONG || flags & TEP_FIELD_IS_POINTER)
202 return cw->data.u64_hex;
205 if (flags & TEP_FIELD_IS_SIGNED) {
206 if (field->size == 8)
212 if (field->size == 8)
218 static unsigned long long adjust_signedness(unsigned long long value_int, int size)
220 unsigned long long value_mask;
223 * value_mask = (1 << (size * 8 - 1)) - 1.
224 * Directly set value_mask for code readers.
228 value_mask = 0x7fULL;
231 value_mask = 0x7fffULL;
234 value_mask = 0x7fffffffULL;
238 * For 64 bit value, return it self. There is no need
247 /* If it is a positive value, don't adjust. */
248 if ((value_int & (~0ULL - value_mask)) == 0)
251 /* Fill upper part of value_int with 1 to make it a negative long long. */
252 return (value_int & value_mask) | ~value_mask;
255 static int string_set_value(struct bt_ctf_field *field, const char *string)
258 size_t len = strlen(string), i, p;
261 for (i = p = 0; i < len; i++, p++) {
262 if (isprint(string[i])) {
265 buffer[p] = string[i];
269 snprintf(numstr, sizeof(numstr), "\\x%02x",
270 (unsigned int)(string[i]) & 0xff);
273 buffer = zalloc(i + (len - i) * 4 + 2);
275 pr_err("failed to set unprintable string '%s'\n", string);
276 return bt_ctf_field_string_set_value(field, "UNPRINTABLE-STRING");
279 strncpy(buffer, string, i);
281 memcpy(buffer + p, numstr, 4);
287 return bt_ctf_field_string_set_value(field, string);
288 err = bt_ctf_field_string_set_value(field, buffer);
293 static int add_tracepoint_field_value(struct ctf_writer *cw,
294 struct bt_ctf_event_class *event_class,
295 struct bt_ctf_event *event,
296 struct perf_sample *sample,
297 struct tep_format_field *fmtf)
299 struct bt_ctf_field_type *type;
300 struct bt_ctf_field *array_field;
301 struct bt_ctf_field *field;
302 const char *name = fmtf->name;
303 void *data = sample->raw_data;
304 unsigned long flags = fmtf->flags;
305 unsigned int n_items;
312 offset = fmtf->offset;
314 if (flags & TEP_FIELD_IS_STRING)
315 flags &= ~TEP_FIELD_IS_ARRAY;
317 if (flags & TEP_FIELD_IS_DYNAMIC) {
318 unsigned long long tmp_val;
320 tmp_val = tep_read_number(fmtf->event->tep,
325 if (tep_field_is_relative(flags))
326 offset += fmtf->offset + fmtf->size;
329 if (flags & TEP_FIELD_IS_ARRAY) {
331 type = bt_ctf_event_class_get_field_by_name(
333 array_field = bt_ctf_field_create(type);
334 bt_ctf_field_type_put(type);
336 pr_err("Failed to create array type %s\n", name);
340 len = fmtf->size / fmtf->arraylen;
341 n_items = fmtf->arraylen;
347 type = get_tracepoint_field_type(cw, fmtf);
349 for (i = 0; i < n_items; i++) {
350 if (flags & TEP_FIELD_IS_ARRAY)
351 field = bt_ctf_field_array_get_field(array_field, i);
353 field = bt_ctf_field_create(type);
356 pr_err("failed to create a field %s\n", name);
360 if (flags & TEP_FIELD_IS_STRING)
361 ret = string_set_value(field, data + offset + i * len);
363 unsigned long long value_int;
365 value_int = tep_read_number(
367 data + offset + i * len, len);
369 if (!(flags & TEP_FIELD_IS_SIGNED))
370 ret = bt_ctf_field_unsigned_integer_set_value(
373 ret = bt_ctf_field_signed_integer_set_value(
374 field, adjust_signedness(value_int, len));
378 pr_err("failed to set file value %s\n", name);
381 if (!(flags & TEP_FIELD_IS_ARRAY)) {
382 ret = bt_ctf_event_set_payload(event, name, field);
384 pr_err("failed to set payload %s\n", name);
388 bt_ctf_field_put(field);
390 if (flags & TEP_FIELD_IS_ARRAY) {
391 ret = bt_ctf_event_set_payload(event, name, array_field);
393 pr_err("Failed add payload array %s\n", name);
396 bt_ctf_field_put(array_field);
401 bt_ctf_field_put(field);
405 static int add_tracepoint_fields_values(struct ctf_writer *cw,
406 struct bt_ctf_event_class *event_class,
407 struct bt_ctf_event *event,
408 struct tep_format_field *fields,
409 struct perf_sample *sample)
411 struct tep_format_field *field;
414 for (field = fields; field; field = field->next) {
415 ret = add_tracepoint_field_value(cw, event_class, event, sample,
423 static int add_tracepoint_values(struct ctf_writer *cw,
424 struct bt_ctf_event_class *event_class,
425 struct bt_ctf_event *event,
427 struct perf_sample *sample)
429 const struct tep_event *tp_format = evsel__tp_format(evsel);
430 struct tep_format_field *common_fields = tp_format->format.common_fields;
431 struct tep_format_field *fields = tp_format->format.fields;
434 ret = add_tracepoint_fields_values(cw, event_class, event,
435 common_fields, sample);
437 ret = add_tracepoint_fields_values(cw, event_class, event,
444 add_bpf_output_values(struct bt_ctf_event_class *event_class,
445 struct bt_ctf_event *event,
446 struct perf_sample *sample)
448 struct bt_ctf_field_type *len_type, *seq_type;
449 struct bt_ctf_field *len_field, *seq_field;
450 unsigned int raw_size = sample->raw_size;
451 unsigned int nr_elements = raw_size / sizeof(u32);
455 if (nr_elements * sizeof(u32) != raw_size)
456 pr_warning("Incorrect raw_size (%u) in bpf output event, skip %zu bytes\n",
457 raw_size, nr_elements * sizeof(u32) - raw_size);
459 len_type = bt_ctf_event_class_get_field_by_name(event_class, "raw_len");
460 len_field = bt_ctf_field_create(len_type);
462 pr_err("failed to create 'raw_len' for bpf output event\n");
467 ret = bt_ctf_field_unsigned_integer_set_value(len_field, nr_elements);
469 pr_err("failed to set field value for raw_len\n");
472 ret = bt_ctf_event_set_payload(event, "raw_len", len_field);
474 pr_err("failed to set payload to raw_len\n");
478 seq_type = bt_ctf_event_class_get_field_by_name(event_class, "raw_data");
479 seq_field = bt_ctf_field_create(seq_type);
481 pr_err("failed to create 'raw_data' for bpf output event\n");
486 ret = bt_ctf_field_sequence_set_length(seq_field, len_field);
488 pr_err("failed to set length of 'raw_data'\n");
492 for (i = 0; i < nr_elements; i++) {
493 struct bt_ctf_field *elem_field =
494 bt_ctf_field_sequence_get_field(seq_field, i);
496 ret = bt_ctf_field_unsigned_integer_set_value(elem_field,
497 ((u32 *)(sample->raw_data))[i]);
499 bt_ctf_field_put(elem_field);
501 pr_err("failed to set raw_data[%d]\n", i);
506 ret = bt_ctf_event_set_payload(event, "raw_data", seq_field);
508 pr_err("failed to set payload for raw_data\n");
511 bt_ctf_field_put(seq_field);
513 bt_ctf_field_type_put(seq_type);
515 bt_ctf_field_put(len_field);
517 bt_ctf_field_type_put(len_type);
522 add_callchain_output_values(struct bt_ctf_event_class *event_class,
523 struct bt_ctf_event *event,
524 struct ip_callchain *callchain)
526 struct bt_ctf_field_type *len_type, *seq_type;
527 struct bt_ctf_field *len_field, *seq_field;
528 unsigned int nr_elements = callchain->nr;
532 len_type = bt_ctf_event_class_get_field_by_name(
533 event_class, "perf_callchain_size");
534 len_field = bt_ctf_field_create(len_type);
536 pr_err("failed to create 'perf_callchain_size' for callchain output event\n");
541 ret = bt_ctf_field_unsigned_integer_set_value(len_field, nr_elements);
543 pr_err("failed to set field value for perf_callchain_size\n");
546 ret = bt_ctf_event_set_payload(event, "perf_callchain_size", len_field);
548 pr_err("failed to set payload to perf_callchain_size\n");
552 seq_type = bt_ctf_event_class_get_field_by_name(
553 event_class, "perf_callchain");
554 seq_field = bt_ctf_field_create(seq_type);
556 pr_err("failed to create 'perf_callchain' for callchain output event\n");
561 ret = bt_ctf_field_sequence_set_length(seq_field, len_field);
563 pr_err("failed to set length of 'perf_callchain'\n");
567 for (i = 0; i < nr_elements; i++) {
568 struct bt_ctf_field *elem_field =
569 bt_ctf_field_sequence_get_field(seq_field, i);
571 ret = bt_ctf_field_unsigned_integer_set_value(elem_field,
572 ((u64 *)(callchain->ips))[i]);
574 bt_ctf_field_put(elem_field);
576 pr_err("failed to set callchain[%d]\n", i);
581 ret = bt_ctf_event_set_payload(event, "perf_callchain", seq_field);
583 pr_err("failed to set payload for raw_data\n");
586 bt_ctf_field_put(seq_field);
588 bt_ctf_field_type_put(seq_type);
590 bt_ctf_field_put(len_field);
592 bt_ctf_field_type_put(len_type);
596 static int add_generic_values(struct ctf_writer *cw,
597 struct bt_ctf_event *event,
599 struct perf_sample *sample)
601 u64 type = evsel->core.attr.sample_type;
606 * PERF_SAMPLE_TIME - not needed as we have it in
608 * PERF_SAMPLE_READ - TODO
609 * PERF_SAMPLE_RAW - tracepoint fields are handled separately
610 * PERF_SAMPLE_BRANCH_STACK - TODO
611 * PERF_SAMPLE_REGS_USER - TODO
612 * PERF_SAMPLE_STACK_USER - TODO
615 if (type & PERF_SAMPLE_IP) {
616 ret = value_set_u64_hex(cw, event, "perf_ip", sample->ip);
621 if (type & PERF_SAMPLE_TID) {
622 ret = value_set_s32(cw, event, "perf_tid", sample->tid);
626 ret = value_set_s32(cw, event, "perf_pid", sample->pid);
631 if ((type & PERF_SAMPLE_ID) ||
632 (type & PERF_SAMPLE_IDENTIFIER)) {
633 ret = value_set_u64(cw, event, "perf_id", sample->id);
638 if (type & PERF_SAMPLE_STREAM_ID) {
639 ret = value_set_u64(cw, event, "perf_stream_id", sample->stream_id);
644 if (type & PERF_SAMPLE_PERIOD) {
645 ret = value_set_u64(cw, event, "perf_period", sample->period);
650 if (type & PERF_SAMPLE_WEIGHT) {
651 ret = value_set_u64(cw, event, "perf_weight", sample->weight);
656 if (type & PERF_SAMPLE_DATA_SRC) {
657 ret = value_set_u64(cw, event, "perf_data_src",
663 if (type & PERF_SAMPLE_TRANSACTION) {
664 ret = value_set_u64(cw, event, "perf_transaction",
665 sample->transaction);
673 static int ctf_stream__flush(struct ctf_stream *cs)
678 err = bt_ctf_stream_flush(cs->stream);
680 pr_err("CTF stream %d flush failed\n", cs->cpu);
682 pr("Flush stream for cpu %d (%u samples)\n",
691 static struct ctf_stream *ctf_stream__create(struct ctf_writer *cw, int cpu)
693 struct ctf_stream *cs;
694 struct bt_ctf_field *pkt_ctx = NULL;
695 struct bt_ctf_field *cpu_field = NULL;
696 struct bt_ctf_stream *stream = NULL;
699 cs = zalloc(sizeof(*cs));
701 pr_err("Failed to allocate ctf stream\n");
705 stream = bt_ctf_writer_create_stream(cw->writer, cw->stream_class);
707 pr_err("Failed to create CTF stream\n");
711 pkt_ctx = bt_ctf_stream_get_packet_context(stream);
713 pr_err("Failed to obtain packet context\n");
717 cpu_field = bt_ctf_field_structure_get_field(pkt_ctx, "cpu_id");
718 bt_ctf_field_put(pkt_ctx);
720 pr_err("Failed to obtain cpu field\n");
724 ret = bt_ctf_field_unsigned_integer_set_value(cpu_field, (u32) cpu);
726 pr_err("Failed to update CPU number\n");
730 bt_ctf_field_put(cpu_field);
738 bt_ctf_field_put(cpu_field);
740 bt_ctf_stream_put(stream);
746 static void ctf_stream__delete(struct ctf_stream *cs)
749 bt_ctf_stream_put(cs->stream);
754 static struct ctf_stream *ctf_stream(struct ctf_writer *cw, int cpu)
756 struct ctf_stream *cs = cw->stream[cpu];
759 cs = ctf_stream__create(cw, cpu);
760 cw->stream[cpu] = cs;
766 static int get_sample_cpu(struct ctf_writer *cw, struct perf_sample *sample,
771 if (evsel->core.attr.sample_type & PERF_SAMPLE_CPU)
774 if (cpu > cw->stream_cnt) {
775 pr_err("Event was recorded for CPU %d, limit is at %d.\n",
776 cpu, cw->stream_cnt);
783 #define STREAM_FLUSH_COUNT 100000
786 * Currently we have no other way to determine the
787 * time for the stream flush other than keep track
788 * of the number of events and check it against
791 static bool is_flush_needed(struct ctf_stream *cs)
793 return cs->count >= STREAM_FLUSH_COUNT;
796 static int process_sample_event(const struct perf_tool *tool,
797 union perf_event *_event,
798 struct perf_sample *sample,
800 struct machine *machine __maybe_unused)
802 struct convert *c = container_of(tool, struct convert, tool);
803 struct evsel_priv *priv = evsel->priv;
804 struct ctf_writer *cw = &c->writer;
805 struct ctf_stream *cs;
806 struct bt_ctf_event_class *event_class;
807 struct bt_ctf_event *event;
809 unsigned long type = evsel->core.attr.sample_type;
811 if (WARN_ONCE(!priv, "Failed to setup all events.\n"))
814 event_class = priv->event_class;
818 c->events_size += _event->header.size;
820 pr_time2(sample->time, "sample %" PRIu64 "\n", c->events_count);
822 event = bt_ctf_event_create(event_class);
824 pr_err("Failed to create an CTF event\n");
828 bt_ctf_clock_set_time(cw->clock, sample->time);
830 ret = add_generic_values(cw, event, evsel, sample);
834 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT) {
835 ret = add_tracepoint_values(cw, event_class, event,
841 if (type & PERF_SAMPLE_CALLCHAIN) {
842 ret = add_callchain_output_values(event_class,
843 event, sample->callchain);
848 if (evsel__is_bpf_output(evsel)) {
849 ret = add_bpf_output_values(event_class, event, sample);
854 cs = ctf_stream(cw, get_sample_cpu(cw, sample, evsel));
856 if (is_flush_needed(cs))
857 ctf_stream__flush(cs);
860 bt_ctf_stream_append_event(cs->stream, event);
863 bt_ctf_event_put(event);
867 #define __NON_SAMPLE_SET_FIELD(_name, _type, _field) \
869 ret = value_set_##_type(cw, event, #_field, _event->_name._field);\
874 #define __FUNC_PROCESS_NON_SAMPLE(_name, body) \
875 static int process_##_name##_event(const struct perf_tool *tool, \
876 union perf_event *_event, \
877 struct perf_sample *sample, \
878 struct machine *machine) \
880 struct convert *c = container_of(tool, struct convert, tool);\
881 struct ctf_writer *cw = &c->writer; \
882 struct bt_ctf_event_class *event_class = cw->_name##_class;\
883 struct bt_ctf_event *event; \
884 struct ctf_stream *cs; \
887 c->non_sample_count++; \
888 c->events_size += _event->header.size; \
889 event = bt_ctf_event_create(event_class); \
891 pr_err("Failed to create an CTF event\n"); \
895 bt_ctf_clock_set_time(cw->clock, sample->time); \
897 cs = ctf_stream(cw, 0); \
899 if (is_flush_needed(cs)) \
900 ctf_stream__flush(cs); \
903 bt_ctf_stream_append_event(cs->stream, event); \
905 bt_ctf_event_put(event); \
907 return perf_event__process_##_name(tool, _event, sample, machine);\
910 __FUNC_PROCESS_NON_SAMPLE(comm,
911 __NON_SAMPLE_SET_FIELD(comm, u32, pid);
912 __NON_SAMPLE_SET_FIELD(comm, u32, tid);
913 __NON_SAMPLE_SET_FIELD(comm, string, comm);
915 __FUNC_PROCESS_NON_SAMPLE(fork,
916 __NON_SAMPLE_SET_FIELD(fork, u32, pid);
917 __NON_SAMPLE_SET_FIELD(fork, u32, ppid);
918 __NON_SAMPLE_SET_FIELD(fork, u32, tid);
919 __NON_SAMPLE_SET_FIELD(fork, u32, ptid);
920 __NON_SAMPLE_SET_FIELD(fork, u64, time);
923 __FUNC_PROCESS_NON_SAMPLE(exit,
924 __NON_SAMPLE_SET_FIELD(fork, u32, pid);
925 __NON_SAMPLE_SET_FIELD(fork, u32, ppid);
926 __NON_SAMPLE_SET_FIELD(fork, u32, tid);
927 __NON_SAMPLE_SET_FIELD(fork, u32, ptid);
928 __NON_SAMPLE_SET_FIELD(fork, u64, time);
930 __FUNC_PROCESS_NON_SAMPLE(mmap,
931 __NON_SAMPLE_SET_FIELD(mmap, u32, pid);
932 __NON_SAMPLE_SET_FIELD(mmap, u32, tid);
933 __NON_SAMPLE_SET_FIELD(mmap, u64_hex, start);
934 __NON_SAMPLE_SET_FIELD(mmap, string, filename);
936 __FUNC_PROCESS_NON_SAMPLE(mmap2,
937 __NON_SAMPLE_SET_FIELD(mmap2, u32, pid);
938 __NON_SAMPLE_SET_FIELD(mmap2, u32, tid);
939 __NON_SAMPLE_SET_FIELD(mmap2, u64_hex, start);
940 __NON_SAMPLE_SET_FIELD(mmap2, string, filename);
942 #undef __NON_SAMPLE_SET_FIELD
943 #undef __FUNC_PROCESS_NON_SAMPLE
945 /* If dup < 0, add a prefix. Else, add _dupl_X suffix. */
946 static char *change_name(char *name, char *orig_name, int dup)
948 char *new_name = NULL;
957 * Add '_' prefix to potential keywork. According to
959 * further CTF spec updating may require us to use '$'.
962 len = strlen(name) + sizeof("_");
964 len = strlen(orig_name) + sizeof("_dupl_X");
966 new_name = malloc(len);
971 snprintf(new_name, len, "_%s", name);
973 snprintf(new_name, len, "%s_dupl_%d", orig_name, dup);
976 if (name != orig_name)
981 static int event_class_add_field(struct bt_ctf_event_class *event_class,
982 struct bt_ctf_field_type *type,
983 struct tep_format_field *field)
985 struct bt_ctf_field_type *t = NULL;
990 /* alias was already assigned */
991 if (field->alias != field->name)
992 return bt_ctf_event_class_add_field(event_class, type,
993 (char *)field->alias);
997 /* If 'name' is a keywork, add prefix. */
998 if (bt_ctf_validate_identifier(name))
999 name = change_name(name, field->name, -1);
1002 pr_err("Failed to fix invalid identifier.");
1005 while ((t = bt_ctf_event_class_get_field_by_name(event_class, name))) {
1006 bt_ctf_field_type_put(t);
1007 name = change_name(name, field->name, dup++);
1009 pr_err("Failed to create dup name for '%s'\n", field->name);
1014 ret = bt_ctf_event_class_add_field(event_class, type, name);
1016 field->alias = name;
1021 static int add_tracepoint_fields_types(struct ctf_writer *cw,
1022 struct tep_format_field *fields,
1023 struct bt_ctf_event_class *event_class)
1025 struct tep_format_field *field;
1028 for (field = fields; field; field = field->next) {
1029 struct bt_ctf_field_type *type;
1030 unsigned long flags = field->flags;
1032 pr2(" field '%s'\n", field->name);
1034 type = get_tracepoint_field_type(cw, field);
1039 * A string is an array of chars. For this we use the string
1040 * type and don't care that it is an array. What we don't
1041 * support is an array of strings.
1043 if (flags & TEP_FIELD_IS_STRING)
1044 flags &= ~TEP_FIELD_IS_ARRAY;
1046 if (flags & TEP_FIELD_IS_ARRAY)
1047 type = bt_ctf_field_type_array_create(type, field->arraylen);
1049 ret = event_class_add_field(event_class, type, field);
1051 if (flags & TEP_FIELD_IS_ARRAY)
1052 bt_ctf_field_type_put(type);
1055 pr_err("Failed to add field '%s': %d\n",
1064 static int add_tracepoint_types(struct ctf_writer *cw,
1065 struct evsel *evsel,
1066 struct bt_ctf_event_class *class)
1068 const struct tep_event *tp_format = evsel__tp_format(evsel);
1069 struct tep_format_field *common_fields = tp_format ? tp_format->format.common_fields : NULL;
1070 struct tep_format_field *fields = tp_format ? tp_format->format.fields : NULL;
1073 ret = add_tracepoint_fields_types(cw, common_fields, class);
1075 ret = add_tracepoint_fields_types(cw, fields, class);
1080 static int add_bpf_output_types(struct ctf_writer *cw,
1081 struct bt_ctf_event_class *class)
1083 struct bt_ctf_field_type *len_type = cw->data.u32;
1084 struct bt_ctf_field_type *seq_base_type = cw->data.u32_hex;
1085 struct bt_ctf_field_type *seq_type;
1088 ret = bt_ctf_event_class_add_field(class, len_type, "raw_len");
1092 seq_type = bt_ctf_field_type_sequence_create(seq_base_type, "raw_len");
1096 return bt_ctf_event_class_add_field(class, seq_type, "raw_data");
1099 static int add_generic_types(struct ctf_writer *cw, struct evsel *evsel,
1100 struct bt_ctf_event_class *event_class)
1102 u64 type = evsel->core.attr.sample_type;
1106 * PERF_SAMPLE_TIME - not needed as we have it in
1108 * PERF_SAMPLE_READ - TODO
1109 * PERF_SAMPLE_CALLCHAIN - TODO
1110 * PERF_SAMPLE_RAW - tracepoint fields and BPF output
1111 * are handled separately
1112 * PERF_SAMPLE_BRANCH_STACK - TODO
1113 * PERF_SAMPLE_REGS_USER - TODO
1114 * PERF_SAMPLE_STACK_USER - TODO
1117 #define ADD_FIELD(cl, t, n) \
1119 pr2(" field '%s'\n", n); \
1120 if (bt_ctf_event_class_add_field(cl, t, n)) { \
1121 pr_err("Failed to add field '%s';\n", n); \
1126 if (type & PERF_SAMPLE_IP)
1127 ADD_FIELD(event_class, cw->data.u64_hex, "perf_ip");
1129 if (type & PERF_SAMPLE_TID) {
1130 ADD_FIELD(event_class, cw->data.s32, "perf_tid");
1131 ADD_FIELD(event_class, cw->data.s32, "perf_pid");
1134 if ((type & PERF_SAMPLE_ID) ||
1135 (type & PERF_SAMPLE_IDENTIFIER))
1136 ADD_FIELD(event_class, cw->data.u64, "perf_id");
1138 if (type & PERF_SAMPLE_STREAM_ID)
1139 ADD_FIELD(event_class, cw->data.u64, "perf_stream_id");
1141 if (type & PERF_SAMPLE_PERIOD)
1142 ADD_FIELD(event_class, cw->data.u64, "perf_period");
1144 if (type & PERF_SAMPLE_WEIGHT)
1145 ADD_FIELD(event_class, cw->data.u64, "perf_weight");
1147 if (type & PERF_SAMPLE_DATA_SRC)
1148 ADD_FIELD(event_class, cw->data.u64, "perf_data_src");
1150 if (type & PERF_SAMPLE_TRANSACTION)
1151 ADD_FIELD(event_class, cw->data.u64, "perf_transaction");
1153 if (type & PERF_SAMPLE_CALLCHAIN) {
1154 ADD_FIELD(event_class, cw->data.u32, "perf_callchain_size");
1155 ADD_FIELD(event_class,
1156 bt_ctf_field_type_sequence_create(
1157 cw->data.u64_hex, "perf_callchain_size"),
1165 static int add_event(struct ctf_writer *cw, struct evsel *evsel)
1167 struct bt_ctf_event_class *event_class;
1168 struct evsel_priv *priv;
1169 const char *name = evsel__name(evsel);
1172 pr("Adding event '%s' (type %d)\n", name, evsel->core.attr.type);
1174 event_class = bt_ctf_event_class_create(name);
1178 ret = add_generic_types(cw, evsel, event_class);
1182 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT) {
1183 ret = add_tracepoint_types(cw, evsel, event_class);
1188 if (evsel__is_bpf_output(evsel)) {
1189 ret = add_bpf_output_types(cw, event_class);
1194 ret = bt_ctf_stream_class_add_event_class(cw->stream_class, event_class);
1196 pr("Failed to add event class into stream.\n");
1200 priv = malloc(sizeof(*priv));
1204 priv->event_class = event_class;
1209 bt_ctf_event_class_put(event_class);
1210 pr_err("Failed to add event '%s'.\n", name);
1214 static int setup_events(struct ctf_writer *cw, struct perf_session *session)
1216 struct evlist *evlist = session->evlist;
1217 struct evsel *evsel;
1220 evlist__for_each_entry(evlist, evsel) {
1221 ret = add_event(cw, evsel);
1228 #define __NON_SAMPLE_ADD_FIELD(t, n) \
1230 pr2(" field '%s'\n", #n); \
1231 if (bt_ctf_event_class_add_field(event_class, cw->data.t, #n)) {\
1232 pr_err("Failed to add field '%s';\n", #n);\
1237 #define __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(_name, body) \
1238 static int add_##_name##_event(struct ctf_writer *cw) \
1240 struct bt_ctf_event_class *event_class; \
1243 pr("Adding "#_name" event\n"); \
1244 event_class = bt_ctf_event_class_create("perf_" #_name);\
1249 ret = bt_ctf_stream_class_add_event_class(cw->stream_class, event_class);\
1251 pr("Failed to add event class '"#_name"' into stream.\n");\
1255 cw->_name##_class = event_class; \
1256 bt_ctf_event_class_put(event_class); \
1260 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(comm,
1261 __NON_SAMPLE_ADD_FIELD(u32, pid);
1262 __NON_SAMPLE_ADD_FIELD(u32, tid);
1263 __NON_SAMPLE_ADD_FIELD(string, comm);
1266 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(fork,
1267 __NON_SAMPLE_ADD_FIELD(u32, pid);
1268 __NON_SAMPLE_ADD_FIELD(u32, ppid);
1269 __NON_SAMPLE_ADD_FIELD(u32, tid);
1270 __NON_SAMPLE_ADD_FIELD(u32, ptid);
1271 __NON_SAMPLE_ADD_FIELD(u64, time);
1274 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(exit,
1275 __NON_SAMPLE_ADD_FIELD(u32, pid);
1276 __NON_SAMPLE_ADD_FIELD(u32, ppid);
1277 __NON_SAMPLE_ADD_FIELD(u32, tid);
1278 __NON_SAMPLE_ADD_FIELD(u32, ptid);
1279 __NON_SAMPLE_ADD_FIELD(u64, time);
1282 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(mmap,
1283 __NON_SAMPLE_ADD_FIELD(u32, pid);
1284 __NON_SAMPLE_ADD_FIELD(u32, tid);
1285 __NON_SAMPLE_ADD_FIELD(u64_hex, start);
1286 __NON_SAMPLE_ADD_FIELD(string, filename);
1289 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(mmap2,
1290 __NON_SAMPLE_ADD_FIELD(u32, pid);
1291 __NON_SAMPLE_ADD_FIELD(u32, tid);
1292 __NON_SAMPLE_ADD_FIELD(u64_hex, start);
1293 __NON_SAMPLE_ADD_FIELD(string, filename);
1295 #undef __NON_SAMPLE_ADD_FIELD
1296 #undef __FUNC_ADD_NON_SAMPLE_EVENT_CLASS
1298 static int setup_non_sample_events(struct ctf_writer *cw,
1299 struct perf_session *session __maybe_unused)
1303 ret = add_comm_event(cw);
1306 ret = add_exit_event(cw);
1309 ret = add_fork_event(cw);
1312 ret = add_mmap_event(cw);
1315 ret = add_mmap2_event(cw);
1321 static void cleanup_events(struct perf_session *session)
1323 struct evlist *evlist = session->evlist;
1324 struct evsel *evsel;
1326 evlist__for_each_entry(evlist, evsel) {
1327 struct evsel_priv *priv;
1330 bt_ctf_event_class_put(priv->event_class);
1331 zfree(&evsel->priv);
1334 evlist__delete(evlist);
1335 session->evlist = NULL;
1338 static int setup_streams(struct ctf_writer *cw, struct perf_session *session)
1340 struct ctf_stream **stream;
1341 struct perf_header *ph = &session->header;
1345 * Try to get the number of cpus used in the data file,
1346 * if not present fallback to the MAX_CPUS.
1348 ncpus = ph->env.nr_cpus_avail ?: MAX_CPUS;
1350 stream = zalloc(sizeof(*stream) * ncpus);
1352 pr_err("Failed to allocate streams.\n");
1356 cw->stream = stream;
1357 cw->stream_cnt = ncpus;
1361 static void free_streams(struct ctf_writer *cw)
1365 for (cpu = 0; cpu < cw->stream_cnt; cpu++)
1366 ctf_stream__delete(cw->stream[cpu]);
1371 static int ctf_writer__setup_env(struct ctf_writer *cw,
1372 struct perf_session *session)
1374 struct perf_header *header = &session->header;
1375 struct bt_ctf_writer *writer = cw->writer;
1377 #define ADD(__n, __v) \
1379 if (bt_ctf_writer_add_environment_field(writer, __n, __v)) \
1383 ADD("host", header->env.hostname);
1384 ADD("sysname", "Linux");
1385 ADD("release", header->env.os_release);
1386 ADD("version", header->env.version);
1387 ADD("machine", header->env.arch);
1388 ADD("domain", "kernel");
1389 ADD("tracer_name", "perf");
1395 static int ctf_writer__setup_clock(struct ctf_writer *cw,
1396 struct perf_session *session,
1399 struct bt_ctf_clock *clock = cw->clock;
1400 const char *desc = "perf clock";
1404 struct perf_env *env = &session->header.env;
1406 if (!env->clock.enabled) {
1407 pr_err("Can't provide --tod time, missing clock data. "
1408 "Please record with -k/--clockid option.\n");
1412 desc = clockid_name(env->clock.clockid);
1413 offset = env->clock.tod_ns - env->clock.clockid_ns;
1416 #define SET(__n, __v) \
1418 if (bt_ctf_clock_set_##__n(clock, __v)) \
1422 SET(frequency, 1000000000);
1423 SET(offset, offset);
1424 SET(description, desc);
1426 SET(is_absolute, 0);
1432 static struct bt_ctf_field_type *create_int_type(int size, bool sign, bool hex)
1434 struct bt_ctf_field_type *type;
1436 type = bt_ctf_field_type_integer_create(size);
1441 bt_ctf_field_type_integer_set_signed(type, 1))
1445 bt_ctf_field_type_integer_set_base(type, BT_CTF_INTEGER_BASE_HEXADECIMAL))
1448 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
1449 bt_ctf_field_type_set_byte_order(type, BT_CTF_BYTE_ORDER_BIG_ENDIAN);
1451 bt_ctf_field_type_set_byte_order(type, BT_CTF_BYTE_ORDER_LITTLE_ENDIAN);
1454 pr2("Created type: INTEGER %d-bit %ssigned %s\n",
1455 size, sign ? "un" : "", hex ? "hex" : "");
1459 bt_ctf_field_type_put(type);
1463 static void ctf_writer__cleanup_data(struct ctf_writer *cw)
1467 for (i = 0; i < ARRAY_SIZE(cw->data.array); i++)
1468 bt_ctf_field_type_put(cw->data.array[i]);
1471 static int ctf_writer__init_data(struct ctf_writer *cw)
1473 #define CREATE_INT_TYPE(type, size, sign, hex) \
1475 (type) = create_int_type(size, sign, hex); \
1480 CREATE_INT_TYPE(cw->data.s64, 64, true, false);
1481 CREATE_INT_TYPE(cw->data.u64, 64, false, false);
1482 CREATE_INT_TYPE(cw->data.s32, 32, true, false);
1483 CREATE_INT_TYPE(cw->data.u32, 32, false, false);
1484 CREATE_INT_TYPE(cw->data.u32_hex, 32, false, true);
1485 CREATE_INT_TYPE(cw->data.u64_hex, 64, false, true);
1487 cw->data.string = bt_ctf_field_type_string_create();
1488 if (cw->data.string)
1492 ctf_writer__cleanup_data(cw);
1493 pr_err("Failed to create data types.\n");
1497 static void ctf_writer__cleanup(struct ctf_writer *cw)
1499 ctf_writer__cleanup_data(cw);
1501 bt_ctf_clock_put(cw->clock);
1503 bt_ctf_stream_class_put(cw->stream_class);
1504 bt_ctf_writer_put(cw->writer);
1506 /* and NULL all the pointers */
1507 memset(cw, 0, sizeof(*cw));
1510 static int ctf_writer__init(struct ctf_writer *cw, const char *path,
1511 struct perf_session *session, bool tod)
1513 struct bt_ctf_writer *writer;
1514 struct bt_ctf_stream_class *stream_class;
1515 struct bt_ctf_clock *clock;
1516 struct bt_ctf_field_type *pkt_ctx_type;
1520 writer = bt_ctf_writer_create(path);
1524 cw->writer = writer;
1527 clock = bt_ctf_clock_create("perf_clock");
1529 pr("Failed to create CTF clock.\n");
1535 if (ctf_writer__setup_clock(cw, session, tod)) {
1536 pr("Failed to setup CTF clock.\n");
1540 /* CTF stream class */
1541 stream_class = bt_ctf_stream_class_create("perf_stream");
1542 if (!stream_class) {
1543 pr("Failed to create CTF stream class.\n");
1547 cw->stream_class = stream_class;
1549 /* CTF clock stream setup */
1550 if (bt_ctf_stream_class_set_clock(stream_class, clock)) {
1551 pr("Failed to assign CTF clock to stream class.\n");
1555 if (ctf_writer__init_data(cw))
1558 /* Add cpu_id for packet context */
1559 pkt_ctx_type = bt_ctf_stream_class_get_packet_context_type(stream_class);
1563 ret = bt_ctf_field_type_structure_add_field(pkt_ctx_type, cw->data.u32, "cpu_id");
1564 bt_ctf_field_type_put(pkt_ctx_type);
1568 /* CTF clock writer setup */
1569 if (bt_ctf_writer_add_clock(writer, clock)) {
1570 pr("Failed to assign CTF clock to writer.\n");
1577 ctf_writer__cleanup(cw);
1579 pr_err("Failed to setup CTF writer.\n");
1583 static int ctf_writer__flush_streams(struct ctf_writer *cw)
1587 for (cpu = 0; cpu < cw->stream_cnt && !ret; cpu++)
1588 ret = ctf_stream__flush(cw->stream[cpu]);
1593 static int convert__config(const char *var, const char *value, void *cb)
1595 struct convert *c = cb;
1597 if (!strcmp(var, "convert.queue-size"))
1598 return perf_config_u64(&c->queue_size, var, value);
1603 int bt_convert__perf2ctf(const char *input, const char *path,
1604 struct perf_data_convert_opts *opts)
1606 struct perf_session *session;
1607 struct perf_data data = {
1609 .mode = PERF_DATA_MODE_READ,
1610 .force = opts->force,
1612 struct convert c = {};
1613 struct ctf_writer *cw = &c.writer;
1616 perf_tool__init(&c.tool, /*ordered_events=*/true);
1617 c.tool.sample = process_sample_event;
1618 c.tool.mmap = perf_event__process_mmap;
1619 c.tool.mmap2 = perf_event__process_mmap2;
1620 c.tool.comm = perf_event__process_comm;
1621 c.tool.exit = perf_event__process_exit;
1622 c.tool.fork = perf_event__process_fork;
1623 c.tool.lost = perf_event__process_lost;
1624 c.tool.tracing_data = perf_event__process_tracing_data;
1625 c.tool.build_id = perf_event__process_build_id;
1626 c.tool.namespaces = perf_event__process_namespaces;
1627 c.tool.ordering_requires_timestamps = true;
1630 c.tool.comm = process_comm_event;
1631 c.tool.exit = process_exit_event;
1632 c.tool.fork = process_fork_event;
1633 c.tool.mmap = process_mmap_event;
1634 c.tool.mmap2 = process_mmap2_event;
1637 err = perf_config(convert__config, &c);
1642 /* perf.data session */
1643 session = perf_session__new(&data, &c.tool);
1644 if (IS_ERR(session))
1645 return PTR_ERR(session);
1648 if (ctf_writer__init(cw, path, session, opts->tod))
1652 ordered_events__set_alloc_size(&session->ordered_events,
1656 /* CTF writer env/clock setup */
1657 if (ctf_writer__setup_env(cw, session))
1660 /* CTF events setup */
1661 if (setup_events(cw, session))
1664 if (opts->all && setup_non_sample_events(cw, session))
1667 if (setup_streams(cw, session))
1670 err = perf_session__process_events(session);
1672 err = ctf_writer__flush_streams(cw);
1674 pr_err("Error during conversion.\n");
1677 "[ perf data convert: Converted '%s' into CTF data '%s' ]\n",
1681 "[ perf data convert: Converted and wrote %.3f MB (%" PRIu64 " samples",
1682 (double) c.events_size / 1024.0 / 1024.0,
1685 if (!c.non_sample_count)
1686 fprintf(stderr, ") ]\n");
1688 fprintf(stderr, ", %" PRIu64 " non-samples) ]\n", c.non_sample_count);
1690 cleanup_events(session);
1691 perf_session__delete(session);
1692 ctf_writer__cleanup(cw);
1697 ctf_writer__cleanup(cw);
1699 perf_session__delete(session);
1700 pr_err("Error during conversion setup.\n");