1 // SPDX-License-Identifier: GPL-2.0-only
3 * CTF writing support via babeltrace.
5 * Copyright (C) 2014, Jiri Olsa <jolsa@redhat.com>
6 * Copyright (C) 2014, Sebastian Andrzej Siewior <bigeasy@linutronix.de>
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 struct tep_format_field
*common_fields
= evsel
->tp_format
->format
.common_fields
;
430 struct tep_format_field
*fields
= evsel
->tp_format
->format
.fields
;
433 ret
= add_tracepoint_fields_values(cw
, event_class
, event
,
434 common_fields
, sample
);
436 ret
= add_tracepoint_fields_values(cw
, event_class
, event
,
443 add_bpf_output_values(struct bt_ctf_event_class
*event_class
,
444 struct bt_ctf_event
*event
,
445 struct perf_sample
*sample
)
447 struct bt_ctf_field_type
*len_type
, *seq_type
;
448 struct bt_ctf_field
*len_field
, *seq_field
;
449 unsigned int raw_size
= sample
->raw_size
;
450 unsigned int nr_elements
= raw_size
/ sizeof(u32
);
454 if (nr_elements
* sizeof(u32
) != raw_size
)
455 pr_warning("Incorrect raw_size (%u) in bpf output event, skip %zu bytes\n",
456 raw_size
, nr_elements
* sizeof(u32
) - raw_size
);
458 len_type
= bt_ctf_event_class_get_field_by_name(event_class
, "raw_len");
459 len_field
= bt_ctf_field_create(len_type
);
461 pr_err("failed to create 'raw_len' for bpf output event\n");
466 ret
= bt_ctf_field_unsigned_integer_set_value(len_field
, nr_elements
);
468 pr_err("failed to set field value for raw_len\n");
471 ret
= bt_ctf_event_set_payload(event
, "raw_len", len_field
);
473 pr_err("failed to set payload to raw_len\n");
477 seq_type
= bt_ctf_event_class_get_field_by_name(event_class
, "raw_data");
478 seq_field
= bt_ctf_field_create(seq_type
);
480 pr_err("failed to create 'raw_data' for bpf output event\n");
485 ret
= bt_ctf_field_sequence_set_length(seq_field
, len_field
);
487 pr_err("failed to set length of 'raw_data'\n");
491 for (i
= 0; i
< nr_elements
; i
++) {
492 struct bt_ctf_field
*elem_field
=
493 bt_ctf_field_sequence_get_field(seq_field
, i
);
495 ret
= bt_ctf_field_unsigned_integer_set_value(elem_field
,
496 ((u32
*)(sample
->raw_data
))[i
]);
498 bt_ctf_field_put(elem_field
);
500 pr_err("failed to set raw_data[%d]\n", i
);
505 ret
= bt_ctf_event_set_payload(event
, "raw_data", seq_field
);
507 pr_err("failed to set payload for raw_data\n");
510 bt_ctf_field_put(seq_field
);
512 bt_ctf_field_type_put(seq_type
);
514 bt_ctf_field_put(len_field
);
516 bt_ctf_field_type_put(len_type
);
521 add_callchain_output_values(struct bt_ctf_event_class
*event_class
,
522 struct bt_ctf_event
*event
,
523 struct ip_callchain
*callchain
)
525 struct bt_ctf_field_type
*len_type
, *seq_type
;
526 struct bt_ctf_field
*len_field
, *seq_field
;
527 unsigned int nr_elements
= callchain
->nr
;
531 len_type
= bt_ctf_event_class_get_field_by_name(
532 event_class
, "perf_callchain_size");
533 len_field
= bt_ctf_field_create(len_type
);
535 pr_err("failed to create 'perf_callchain_size' for callchain output event\n");
540 ret
= bt_ctf_field_unsigned_integer_set_value(len_field
, nr_elements
);
542 pr_err("failed to set field value for perf_callchain_size\n");
545 ret
= bt_ctf_event_set_payload(event
, "perf_callchain_size", len_field
);
547 pr_err("failed to set payload to perf_callchain_size\n");
551 seq_type
= bt_ctf_event_class_get_field_by_name(
552 event_class
, "perf_callchain");
553 seq_field
= bt_ctf_field_create(seq_type
);
555 pr_err("failed to create 'perf_callchain' for callchain output event\n");
560 ret
= bt_ctf_field_sequence_set_length(seq_field
, len_field
);
562 pr_err("failed to set length of 'perf_callchain'\n");
566 for (i
= 0; i
< nr_elements
; i
++) {
567 struct bt_ctf_field
*elem_field
=
568 bt_ctf_field_sequence_get_field(seq_field
, i
);
570 ret
= bt_ctf_field_unsigned_integer_set_value(elem_field
,
571 ((u64
*)(callchain
->ips
))[i
]);
573 bt_ctf_field_put(elem_field
);
575 pr_err("failed to set callchain[%d]\n", i
);
580 ret
= bt_ctf_event_set_payload(event
, "perf_callchain", seq_field
);
582 pr_err("failed to set payload for raw_data\n");
585 bt_ctf_field_put(seq_field
);
587 bt_ctf_field_type_put(seq_type
);
589 bt_ctf_field_put(len_field
);
591 bt_ctf_field_type_put(len_type
);
595 static int add_generic_values(struct ctf_writer
*cw
,
596 struct bt_ctf_event
*event
,
598 struct perf_sample
*sample
)
600 u64 type
= evsel
->core
.attr
.sample_type
;
605 * PERF_SAMPLE_TIME - not needed as we have it in
607 * PERF_SAMPLE_READ - TODO
608 * PERF_SAMPLE_RAW - tracepoint fields are handled separately
609 * PERF_SAMPLE_BRANCH_STACK - TODO
610 * PERF_SAMPLE_REGS_USER - TODO
611 * PERF_SAMPLE_STACK_USER - TODO
614 if (type
& PERF_SAMPLE_IP
) {
615 ret
= value_set_u64_hex(cw
, event
, "perf_ip", sample
->ip
);
620 if (type
& PERF_SAMPLE_TID
) {
621 ret
= value_set_s32(cw
, event
, "perf_tid", sample
->tid
);
625 ret
= value_set_s32(cw
, event
, "perf_pid", sample
->pid
);
630 if ((type
& PERF_SAMPLE_ID
) ||
631 (type
& PERF_SAMPLE_IDENTIFIER
)) {
632 ret
= value_set_u64(cw
, event
, "perf_id", sample
->id
);
637 if (type
& PERF_SAMPLE_STREAM_ID
) {
638 ret
= value_set_u64(cw
, event
, "perf_stream_id", sample
->stream_id
);
643 if (type
& PERF_SAMPLE_PERIOD
) {
644 ret
= value_set_u64(cw
, event
, "perf_period", sample
->period
);
649 if (type
& PERF_SAMPLE_WEIGHT
) {
650 ret
= value_set_u64(cw
, event
, "perf_weight", sample
->weight
);
655 if (type
& PERF_SAMPLE_DATA_SRC
) {
656 ret
= value_set_u64(cw
, event
, "perf_data_src",
662 if (type
& PERF_SAMPLE_TRANSACTION
) {
663 ret
= value_set_u64(cw
, event
, "perf_transaction",
664 sample
->transaction
);
672 static int ctf_stream__flush(struct ctf_stream
*cs
)
677 err
= bt_ctf_stream_flush(cs
->stream
);
679 pr_err("CTF stream %d flush failed\n", cs
->cpu
);
681 pr("Flush stream for cpu %d (%u samples)\n",
690 static struct ctf_stream
*ctf_stream__create(struct ctf_writer
*cw
, int cpu
)
692 struct ctf_stream
*cs
;
693 struct bt_ctf_field
*pkt_ctx
= NULL
;
694 struct bt_ctf_field
*cpu_field
= NULL
;
695 struct bt_ctf_stream
*stream
= NULL
;
698 cs
= zalloc(sizeof(*cs
));
700 pr_err("Failed to allocate ctf stream\n");
704 stream
= bt_ctf_writer_create_stream(cw
->writer
, cw
->stream_class
);
706 pr_err("Failed to create CTF stream\n");
710 pkt_ctx
= bt_ctf_stream_get_packet_context(stream
);
712 pr_err("Failed to obtain packet context\n");
716 cpu_field
= bt_ctf_field_structure_get_field(pkt_ctx
, "cpu_id");
717 bt_ctf_field_put(pkt_ctx
);
719 pr_err("Failed to obtain cpu field\n");
723 ret
= bt_ctf_field_unsigned_integer_set_value(cpu_field
, (u32
) cpu
);
725 pr_err("Failed to update CPU number\n");
729 bt_ctf_field_put(cpu_field
);
737 bt_ctf_field_put(cpu_field
);
739 bt_ctf_stream_put(stream
);
745 static void ctf_stream__delete(struct ctf_stream
*cs
)
748 bt_ctf_stream_put(cs
->stream
);
753 static struct ctf_stream
*ctf_stream(struct ctf_writer
*cw
, int cpu
)
755 struct ctf_stream
*cs
= cw
->stream
[cpu
];
758 cs
= ctf_stream__create(cw
, cpu
);
759 cw
->stream
[cpu
] = cs
;
765 static int get_sample_cpu(struct ctf_writer
*cw
, struct perf_sample
*sample
,
770 if (evsel
->core
.attr
.sample_type
& PERF_SAMPLE_CPU
)
773 if (cpu
> cw
->stream_cnt
) {
774 pr_err("Event was recorded for CPU %d, limit is at %d.\n",
775 cpu
, cw
->stream_cnt
);
782 #define STREAM_FLUSH_COUNT 100000
785 * Currently we have no other way to determine the
786 * time for the stream flush other than keep track
787 * of the number of events and check it against
790 static bool is_flush_needed(struct ctf_stream
*cs
)
792 return cs
->count
>= STREAM_FLUSH_COUNT
;
795 static int process_sample_event(const struct perf_tool
*tool
,
796 union perf_event
*_event
,
797 struct perf_sample
*sample
,
799 struct machine
*machine __maybe_unused
)
801 struct convert
*c
= container_of(tool
, struct convert
, tool
);
802 struct evsel_priv
*priv
= evsel
->priv
;
803 struct ctf_writer
*cw
= &c
->writer
;
804 struct ctf_stream
*cs
;
805 struct bt_ctf_event_class
*event_class
;
806 struct bt_ctf_event
*event
;
808 unsigned long type
= evsel
->core
.attr
.sample_type
;
810 if (WARN_ONCE(!priv
, "Failed to setup all events.\n"))
813 event_class
= priv
->event_class
;
817 c
->events_size
+= _event
->header
.size
;
819 pr_time2(sample
->time
, "sample %" PRIu64
"\n", c
->events_count
);
821 event
= bt_ctf_event_create(event_class
);
823 pr_err("Failed to create an CTF event\n");
827 bt_ctf_clock_set_time(cw
->clock
, sample
->time
);
829 ret
= add_generic_values(cw
, event
, evsel
, sample
);
833 if (evsel
->core
.attr
.type
== PERF_TYPE_TRACEPOINT
) {
834 ret
= add_tracepoint_values(cw
, event_class
, event
,
840 if (type
& PERF_SAMPLE_CALLCHAIN
) {
841 ret
= add_callchain_output_values(event_class
,
842 event
, sample
->callchain
);
847 if (evsel__is_bpf_output(evsel
)) {
848 ret
= add_bpf_output_values(event_class
, event
, sample
);
853 cs
= ctf_stream(cw
, get_sample_cpu(cw
, sample
, evsel
));
855 if (is_flush_needed(cs
))
856 ctf_stream__flush(cs
);
859 bt_ctf_stream_append_event(cs
->stream
, event
);
862 bt_ctf_event_put(event
);
866 #define __NON_SAMPLE_SET_FIELD(_name, _type, _field) \
868 ret = value_set_##_type(cw, event, #_field, _event->_name._field);\
873 #define __FUNC_PROCESS_NON_SAMPLE(_name, body) \
874 static int process_##_name##_event(const struct perf_tool *tool, \
875 union perf_event *_event, \
876 struct perf_sample *sample, \
877 struct machine *machine) \
879 struct convert *c = container_of(tool, struct convert, tool);\
880 struct ctf_writer *cw = &c->writer; \
881 struct bt_ctf_event_class *event_class = cw->_name##_class;\
882 struct bt_ctf_event *event; \
883 struct ctf_stream *cs; \
886 c->non_sample_count++; \
887 c->events_size += _event->header.size; \
888 event = bt_ctf_event_create(event_class); \
890 pr_err("Failed to create an CTF event\n"); \
894 bt_ctf_clock_set_time(cw->clock, sample->time); \
896 cs = ctf_stream(cw, 0); \
898 if (is_flush_needed(cs)) \
899 ctf_stream__flush(cs); \
902 bt_ctf_stream_append_event(cs->stream, event); \
904 bt_ctf_event_put(event); \
906 return perf_event__process_##_name(tool, _event, sample, machine);\
909 __FUNC_PROCESS_NON_SAMPLE(comm
,
910 __NON_SAMPLE_SET_FIELD(comm
, u32
, pid
);
911 __NON_SAMPLE_SET_FIELD(comm
, u32
, tid
);
912 __NON_SAMPLE_SET_FIELD(comm
, string
, comm
);
914 __FUNC_PROCESS_NON_SAMPLE(fork
,
915 __NON_SAMPLE_SET_FIELD(fork
, u32
, pid
);
916 __NON_SAMPLE_SET_FIELD(fork
, u32
, ppid
);
917 __NON_SAMPLE_SET_FIELD(fork
, u32
, tid
);
918 __NON_SAMPLE_SET_FIELD(fork
, u32
, ptid
);
919 __NON_SAMPLE_SET_FIELD(fork
, u64
, time
);
922 __FUNC_PROCESS_NON_SAMPLE(exit
,
923 __NON_SAMPLE_SET_FIELD(fork
, u32
, pid
);
924 __NON_SAMPLE_SET_FIELD(fork
, u32
, ppid
);
925 __NON_SAMPLE_SET_FIELD(fork
, u32
, tid
);
926 __NON_SAMPLE_SET_FIELD(fork
, u32
, ptid
);
927 __NON_SAMPLE_SET_FIELD(fork
, u64
, time
);
929 __FUNC_PROCESS_NON_SAMPLE(mmap
,
930 __NON_SAMPLE_SET_FIELD(mmap
, u32
, pid
);
931 __NON_SAMPLE_SET_FIELD(mmap
, u32
, tid
);
932 __NON_SAMPLE_SET_FIELD(mmap
, u64_hex
, start
);
933 __NON_SAMPLE_SET_FIELD(mmap
, string
, filename
);
935 __FUNC_PROCESS_NON_SAMPLE(mmap2
,
936 __NON_SAMPLE_SET_FIELD(mmap2
, u32
, pid
);
937 __NON_SAMPLE_SET_FIELD(mmap2
, u32
, tid
);
938 __NON_SAMPLE_SET_FIELD(mmap2
, u64_hex
, start
);
939 __NON_SAMPLE_SET_FIELD(mmap2
, string
, filename
);
941 #undef __NON_SAMPLE_SET_FIELD
942 #undef __FUNC_PROCESS_NON_SAMPLE
944 /* If dup < 0, add a prefix. Else, add _dupl_X suffix. */
945 static char *change_name(char *name
, char *orig_name
, int dup
)
947 char *new_name
= NULL
;
956 * Add '_' prefix to potential keywork. According to
957 * Mathieu Desnoyers (https://lore.kernel.org/lkml/1074266107.40857.1422045946295.JavaMail.zimbra@efficios.com),
958 * further CTF spec updating may require us to use '$'.
961 len
= strlen(name
) + sizeof("_");
963 len
= strlen(orig_name
) + sizeof("_dupl_X");
965 new_name
= malloc(len
);
970 snprintf(new_name
, len
, "_%s", name
);
972 snprintf(new_name
, len
, "%s_dupl_%d", orig_name
, dup
);
975 if (name
!= orig_name
)
980 static int event_class_add_field(struct bt_ctf_event_class
*event_class
,
981 struct bt_ctf_field_type
*type
,
982 struct tep_format_field
*field
)
984 struct bt_ctf_field_type
*t
= NULL
;
989 /* alias was already assigned */
990 if (field
->alias
!= field
->name
)
991 return bt_ctf_event_class_add_field(event_class
, type
,
992 (char *)field
->alias
);
996 /* If 'name' is a keywork, add prefix. */
997 if (bt_ctf_validate_identifier(name
))
998 name
= change_name(name
, field
->name
, -1);
1001 pr_err("Failed to fix invalid identifier.");
1004 while ((t
= bt_ctf_event_class_get_field_by_name(event_class
, name
))) {
1005 bt_ctf_field_type_put(t
);
1006 name
= change_name(name
, field
->name
, dup
++);
1008 pr_err("Failed to create dup name for '%s'\n", field
->name
);
1013 ret
= bt_ctf_event_class_add_field(event_class
, type
, name
);
1015 field
->alias
= name
;
1020 static int add_tracepoint_fields_types(struct ctf_writer
*cw
,
1021 struct tep_format_field
*fields
,
1022 struct bt_ctf_event_class
*event_class
)
1024 struct tep_format_field
*field
;
1027 for (field
= fields
; field
; field
= field
->next
) {
1028 struct bt_ctf_field_type
*type
;
1029 unsigned long flags
= field
->flags
;
1031 pr2(" field '%s'\n", field
->name
);
1033 type
= get_tracepoint_field_type(cw
, field
);
1038 * A string is an array of chars. For this we use the string
1039 * type and don't care that it is an array. What we don't
1040 * support is an array of strings.
1042 if (flags
& TEP_FIELD_IS_STRING
)
1043 flags
&= ~TEP_FIELD_IS_ARRAY
;
1045 if (flags
& TEP_FIELD_IS_ARRAY
)
1046 type
= bt_ctf_field_type_array_create(type
, field
->arraylen
);
1048 ret
= event_class_add_field(event_class
, type
, field
);
1050 if (flags
& TEP_FIELD_IS_ARRAY
)
1051 bt_ctf_field_type_put(type
);
1054 pr_err("Failed to add field '%s': %d\n",
1063 static int add_tracepoint_types(struct ctf_writer
*cw
,
1064 struct evsel
*evsel
,
1065 struct bt_ctf_event_class
*class)
1067 struct tep_format_field
*common_fields
= evsel
->tp_format
->format
.common_fields
;
1068 struct tep_format_field
*fields
= evsel
->tp_format
->format
.fields
;
1071 ret
= add_tracepoint_fields_types(cw
, common_fields
, class);
1073 ret
= add_tracepoint_fields_types(cw
, fields
, class);
1078 static int add_bpf_output_types(struct ctf_writer
*cw
,
1079 struct bt_ctf_event_class
*class)
1081 struct bt_ctf_field_type
*len_type
= cw
->data
.u32
;
1082 struct bt_ctf_field_type
*seq_base_type
= cw
->data
.u32_hex
;
1083 struct bt_ctf_field_type
*seq_type
;
1086 ret
= bt_ctf_event_class_add_field(class, len_type
, "raw_len");
1090 seq_type
= bt_ctf_field_type_sequence_create(seq_base_type
, "raw_len");
1094 return bt_ctf_event_class_add_field(class, seq_type
, "raw_data");
1097 static int add_generic_types(struct ctf_writer
*cw
, struct evsel
*evsel
,
1098 struct bt_ctf_event_class
*event_class
)
1100 u64 type
= evsel
->core
.attr
.sample_type
;
1104 * PERF_SAMPLE_TIME - not needed as we have it in
1106 * PERF_SAMPLE_READ - TODO
1107 * PERF_SAMPLE_CALLCHAIN - TODO
1108 * PERF_SAMPLE_RAW - tracepoint fields and BPF output
1109 * are handled separately
1110 * PERF_SAMPLE_BRANCH_STACK - TODO
1111 * PERF_SAMPLE_REGS_USER - TODO
1112 * PERF_SAMPLE_STACK_USER - TODO
1115 #define ADD_FIELD(cl, t, n) \
1117 pr2(" field '%s'\n", n); \
1118 if (bt_ctf_event_class_add_field(cl, t, n)) { \
1119 pr_err("Failed to add field '%s';\n", n); \
1124 if (type
& PERF_SAMPLE_IP
)
1125 ADD_FIELD(event_class
, cw
->data
.u64_hex
, "perf_ip");
1127 if (type
& PERF_SAMPLE_TID
) {
1128 ADD_FIELD(event_class
, cw
->data
.s32
, "perf_tid");
1129 ADD_FIELD(event_class
, cw
->data
.s32
, "perf_pid");
1132 if ((type
& PERF_SAMPLE_ID
) ||
1133 (type
& PERF_SAMPLE_IDENTIFIER
))
1134 ADD_FIELD(event_class
, cw
->data
.u64
, "perf_id");
1136 if (type
& PERF_SAMPLE_STREAM_ID
)
1137 ADD_FIELD(event_class
, cw
->data
.u64
, "perf_stream_id");
1139 if (type
& PERF_SAMPLE_PERIOD
)
1140 ADD_FIELD(event_class
, cw
->data
.u64
, "perf_period");
1142 if (type
& PERF_SAMPLE_WEIGHT
)
1143 ADD_FIELD(event_class
, cw
->data
.u64
, "perf_weight");
1145 if (type
& PERF_SAMPLE_DATA_SRC
)
1146 ADD_FIELD(event_class
, cw
->data
.u64
, "perf_data_src");
1148 if (type
& PERF_SAMPLE_TRANSACTION
)
1149 ADD_FIELD(event_class
, cw
->data
.u64
, "perf_transaction");
1151 if (type
& PERF_SAMPLE_CALLCHAIN
) {
1152 ADD_FIELD(event_class
, cw
->data
.u32
, "perf_callchain_size");
1153 ADD_FIELD(event_class
,
1154 bt_ctf_field_type_sequence_create(
1155 cw
->data
.u64_hex
, "perf_callchain_size"),
1163 static int add_event(struct ctf_writer
*cw
, struct evsel
*evsel
)
1165 struct bt_ctf_event_class
*event_class
;
1166 struct evsel_priv
*priv
;
1167 const char *name
= evsel__name(evsel
);
1170 pr("Adding event '%s' (type %d)\n", name
, evsel
->core
.attr
.type
);
1172 event_class
= bt_ctf_event_class_create(name
);
1176 ret
= add_generic_types(cw
, evsel
, event_class
);
1180 if (evsel
->core
.attr
.type
== PERF_TYPE_TRACEPOINT
) {
1181 ret
= add_tracepoint_types(cw
, evsel
, event_class
);
1186 if (evsel__is_bpf_output(evsel
)) {
1187 ret
= add_bpf_output_types(cw
, event_class
);
1192 ret
= bt_ctf_stream_class_add_event_class(cw
->stream_class
, event_class
);
1194 pr("Failed to add event class into stream.\n");
1198 priv
= malloc(sizeof(*priv
));
1202 priv
->event_class
= event_class
;
1207 bt_ctf_event_class_put(event_class
);
1208 pr_err("Failed to add event '%s'.\n", name
);
1212 static int setup_events(struct ctf_writer
*cw
, struct perf_session
*session
)
1214 struct evlist
*evlist
= session
->evlist
;
1215 struct evsel
*evsel
;
1218 evlist__for_each_entry(evlist
, evsel
) {
1219 ret
= add_event(cw
, evsel
);
1226 #define __NON_SAMPLE_ADD_FIELD(t, n) \
1228 pr2(" field '%s'\n", #n); \
1229 if (bt_ctf_event_class_add_field(event_class, cw->data.t, #n)) {\
1230 pr_err("Failed to add field '%s';\n", #n);\
1235 #define __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(_name, body) \
1236 static int add_##_name##_event(struct ctf_writer *cw) \
1238 struct bt_ctf_event_class *event_class; \
1241 pr("Adding "#_name" event\n"); \
1242 event_class = bt_ctf_event_class_create("perf_" #_name);\
1247 ret = bt_ctf_stream_class_add_event_class(cw->stream_class, event_class);\
1249 pr("Failed to add event class '"#_name"' into stream.\n");\
1253 cw->_name##_class = event_class; \
1254 bt_ctf_event_class_put(event_class); \
1258 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(comm
,
1259 __NON_SAMPLE_ADD_FIELD(u32
, pid
);
1260 __NON_SAMPLE_ADD_FIELD(u32
, tid
);
1261 __NON_SAMPLE_ADD_FIELD(string
, comm
);
1264 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(fork
,
1265 __NON_SAMPLE_ADD_FIELD(u32
, pid
);
1266 __NON_SAMPLE_ADD_FIELD(u32
, ppid
);
1267 __NON_SAMPLE_ADD_FIELD(u32
, tid
);
1268 __NON_SAMPLE_ADD_FIELD(u32
, ptid
);
1269 __NON_SAMPLE_ADD_FIELD(u64
, time
);
1272 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(exit
,
1273 __NON_SAMPLE_ADD_FIELD(u32
, pid
);
1274 __NON_SAMPLE_ADD_FIELD(u32
, ppid
);
1275 __NON_SAMPLE_ADD_FIELD(u32
, tid
);
1276 __NON_SAMPLE_ADD_FIELD(u32
, ptid
);
1277 __NON_SAMPLE_ADD_FIELD(u64
, time
);
1280 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(mmap
,
1281 __NON_SAMPLE_ADD_FIELD(u32
, pid
);
1282 __NON_SAMPLE_ADD_FIELD(u32
, tid
);
1283 __NON_SAMPLE_ADD_FIELD(u64_hex
, start
);
1284 __NON_SAMPLE_ADD_FIELD(string
, filename
);
1287 __FUNC_ADD_NON_SAMPLE_EVENT_CLASS(mmap2
,
1288 __NON_SAMPLE_ADD_FIELD(u32
, pid
);
1289 __NON_SAMPLE_ADD_FIELD(u32
, tid
);
1290 __NON_SAMPLE_ADD_FIELD(u64_hex
, start
);
1291 __NON_SAMPLE_ADD_FIELD(string
, filename
);
1293 #undef __NON_SAMPLE_ADD_FIELD
1294 #undef __FUNC_ADD_NON_SAMPLE_EVENT_CLASS
1296 static int setup_non_sample_events(struct ctf_writer
*cw
,
1297 struct perf_session
*session __maybe_unused
)
1301 ret
= add_comm_event(cw
);
1304 ret
= add_exit_event(cw
);
1307 ret
= add_fork_event(cw
);
1310 ret
= add_mmap_event(cw
);
1313 ret
= add_mmap2_event(cw
);
1319 static void cleanup_events(struct perf_session
*session
)
1321 struct evlist
*evlist
= session
->evlist
;
1322 struct evsel
*evsel
;
1324 evlist__for_each_entry(evlist
, evsel
) {
1325 struct evsel_priv
*priv
;
1328 bt_ctf_event_class_put(priv
->event_class
);
1329 zfree(&evsel
->priv
);
1332 evlist__delete(evlist
);
1333 session
->evlist
= NULL
;
1336 static int setup_streams(struct ctf_writer
*cw
, struct perf_session
*session
)
1338 struct ctf_stream
**stream
;
1339 struct perf_header
*ph
= &session
->header
;
1343 * Try to get the number of cpus used in the data file,
1344 * if not present fallback to the MAX_CPUS.
1346 ncpus
= ph
->env
.nr_cpus_avail
?: MAX_CPUS
;
1348 stream
= zalloc(sizeof(*stream
) * ncpus
);
1350 pr_err("Failed to allocate streams.\n");
1354 cw
->stream
= stream
;
1355 cw
->stream_cnt
= ncpus
;
1359 static void free_streams(struct ctf_writer
*cw
)
1363 for (cpu
= 0; cpu
< cw
->stream_cnt
; cpu
++)
1364 ctf_stream__delete(cw
->stream
[cpu
]);
1369 static int ctf_writer__setup_env(struct ctf_writer
*cw
,
1370 struct perf_session
*session
)
1372 struct perf_header
*header
= &session
->header
;
1373 struct bt_ctf_writer
*writer
= cw
->writer
;
1375 #define ADD(__n, __v) \
1377 if (bt_ctf_writer_add_environment_field(writer, __n, __v)) \
1381 ADD("host", header
->env
.hostname
);
1382 ADD("sysname", "Linux");
1383 ADD("release", header
->env
.os_release
);
1384 ADD("version", header
->env
.version
);
1385 ADD("machine", header
->env
.arch
);
1386 ADD("domain", "kernel");
1387 ADD("tracer_name", "perf");
1393 static int ctf_writer__setup_clock(struct ctf_writer
*cw
,
1394 struct perf_session
*session
,
1397 struct bt_ctf_clock
*clock
= cw
->clock
;
1398 const char *desc
= "perf clock";
1402 struct perf_env
*env
= &session
->header
.env
;
1404 if (!env
->clock
.enabled
) {
1405 pr_err("Can't provide --tod time, missing clock data. "
1406 "Please record with -k/--clockid option.\n");
1410 desc
= clockid_name(env
->clock
.clockid
);
1411 offset
= env
->clock
.tod_ns
- env
->clock
.clockid_ns
;
1414 #define SET(__n, __v) \
1416 if (bt_ctf_clock_set_##__n(clock, __v)) \
1420 SET(frequency
, 1000000000);
1421 SET(offset
, offset
);
1422 SET(description
, desc
);
1424 SET(is_absolute
, 0);
1430 static struct bt_ctf_field_type
*create_int_type(int size
, bool sign
, bool hex
)
1432 struct bt_ctf_field_type
*type
;
1434 type
= bt_ctf_field_type_integer_create(size
);
1439 bt_ctf_field_type_integer_set_signed(type
, 1))
1443 bt_ctf_field_type_integer_set_base(type
, BT_CTF_INTEGER_BASE_HEXADECIMAL
))
1446 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
1447 bt_ctf_field_type_set_byte_order(type
, BT_CTF_BYTE_ORDER_BIG_ENDIAN
);
1449 bt_ctf_field_type_set_byte_order(type
, BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
);
1452 pr2("Created type: INTEGER %d-bit %ssigned %s\n",
1453 size
, sign
? "un" : "", hex
? "hex" : "");
1457 bt_ctf_field_type_put(type
);
1461 static void ctf_writer__cleanup_data(struct ctf_writer
*cw
)
1465 for (i
= 0; i
< ARRAY_SIZE(cw
->data
.array
); i
++)
1466 bt_ctf_field_type_put(cw
->data
.array
[i
]);
1469 static int ctf_writer__init_data(struct ctf_writer
*cw
)
1471 #define CREATE_INT_TYPE(type, size, sign, hex) \
1473 (type) = create_int_type(size, sign, hex); \
1478 CREATE_INT_TYPE(cw
->data
.s64
, 64, true, false);
1479 CREATE_INT_TYPE(cw
->data
.u64
, 64, false, false);
1480 CREATE_INT_TYPE(cw
->data
.s32
, 32, true, false);
1481 CREATE_INT_TYPE(cw
->data
.u32
, 32, false, false);
1482 CREATE_INT_TYPE(cw
->data
.u32_hex
, 32, false, true);
1483 CREATE_INT_TYPE(cw
->data
.u64_hex
, 64, false, true);
1485 cw
->data
.string
= bt_ctf_field_type_string_create();
1486 if (cw
->data
.string
)
1490 ctf_writer__cleanup_data(cw
);
1491 pr_err("Failed to create data types.\n");
1495 static void ctf_writer__cleanup(struct ctf_writer
*cw
)
1497 ctf_writer__cleanup_data(cw
);
1499 bt_ctf_clock_put(cw
->clock
);
1501 bt_ctf_stream_class_put(cw
->stream_class
);
1502 bt_ctf_writer_put(cw
->writer
);
1504 /* and NULL all the pointers */
1505 memset(cw
, 0, sizeof(*cw
));
1508 static int ctf_writer__init(struct ctf_writer
*cw
, const char *path
,
1509 struct perf_session
*session
, bool tod
)
1511 struct bt_ctf_writer
*writer
;
1512 struct bt_ctf_stream_class
*stream_class
;
1513 struct bt_ctf_clock
*clock
;
1514 struct bt_ctf_field_type
*pkt_ctx_type
;
1518 writer
= bt_ctf_writer_create(path
);
1522 cw
->writer
= writer
;
1525 clock
= bt_ctf_clock_create("perf_clock");
1527 pr("Failed to create CTF clock.\n");
1533 if (ctf_writer__setup_clock(cw
, session
, tod
)) {
1534 pr("Failed to setup CTF clock.\n");
1538 /* CTF stream class */
1539 stream_class
= bt_ctf_stream_class_create("perf_stream");
1540 if (!stream_class
) {
1541 pr("Failed to create CTF stream class.\n");
1545 cw
->stream_class
= stream_class
;
1547 /* CTF clock stream setup */
1548 if (bt_ctf_stream_class_set_clock(stream_class
, clock
)) {
1549 pr("Failed to assign CTF clock to stream class.\n");
1553 if (ctf_writer__init_data(cw
))
1556 /* Add cpu_id for packet context */
1557 pkt_ctx_type
= bt_ctf_stream_class_get_packet_context_type(stream_class
);
1561 ret
= bt_ctf_field_type_structure_add_field(pkt_ctx_type
, cw
->data
.u32
, "cpu_id");
1562 bt_ctf_field_type_put(pkt_ctx_type
);
1566 /* CTF clock writer setup */
1567 if (bt_ctf_writer_add_clock(writer
, clock
)) {
1568 pr("Failed to assign CTF clock to writer.\n");
1575 ctf_writer__cleanup(cw
);
1577 pr_err("Failed to setup CTF writer.\n");
1581 static int ctf_writer__flush_streams(struct ctf_writer
*cw
)
1585 for (cpu
= 0; cpu
< cw
->stream_cnt
&& !ret
; cpu
++)
1586 ret
= ctf_stream__flush(cw
->stream
[cpu
]);
1591 static int convert__config(const char *var
, const char *value
, void *cb
)
1593 struct convert
*c
= cb
;
1595 if (!strcmp(var
, "convert.queue-size"))
1596 return perf_config_u64(&c
->queue_size
, var
, value
);
1601 int bt_convert__perf2ctf(const char *input
, const char *path
,
1602 struct perf_data_convert_opts
*opts
)
1604 struct perf_session
*session
;
1605 struct perf_data data
= {
1607 .mode
= PERF_DATA_MODE_READ
,
1608 .force
= opts
->force
,
1610 struct convert c
= {};
1611 struct ctf_writer
*cw
= &c
.writer
;
1614 perf_tool__init(&c
.tool
, /*ordered_events=*/true);
1615 c
.tool
.sample
= process_sample_event
;
1616 c
.tool
.mmap
= perf_event__process_mmap
;
1617 c
.tool
.mmap2
= perf_event__process_mmap2
;
1618 c
.tool
.comm
= perf_event__process_comm
;
1619 c
.tool
.exit
= perf_event__process_exit
;
1620 c
.tool
.fork
= perf_event__process_fork
;
1621 c
.tool
.lost
= perf_event__process_lost
;
1622 c
.tool
.tracing_data
= perf_event__process_tracing_data
;
1623 c
.tool
.build_id
= perf_event__process_build_id
;
1624 c
.tool
.namespaces
= perf_event__process_namespaces
;
1625 c
.tool
.ordering_requires_timestamps
= true;
1628 c
.tool
.comm
= process_comm_event
;
1629 c
.tool
.exit
= process_exit_event
;
1630 c
.tool
.fork
= process_fork_event
;
1631 c
.tool
.mmap
= process_mmap_event
;
1632 c
.tool
.mmap2
= process_mmap2_event
;
1635 err
= perf_config(convert__config
, &c
);
1640 /* perf.data session */
1641 session
= perf_session__new(&data
, &c
.tool
);
1642 if (IS_ERR(session
))
1643 return PTR_ERR(session
);
1646 if (ctf_writer__init(cw
, path
, session
, opts
->tod
))
1650 ordered_events__set_alloc_size(&session
->ordered_events
,
1654 /* CTF writer env/clock setup */
1655 if (ctf_writer__setup_env(cw
, session
))
1658 /* CTF events setup */
1659 if (setup_events(cw
, session
))
1662 if (opts
->all
&& setup_non_sample_events(cw
, session
))
1665 if (setup_streams(cw
, session
))
1668 err
= perf_session__process_events(session
);
1670 err
= ctf_writer__flush_streams(cw
);
1672 pr_err("Error during conversion.\n");
1675 "[ perf data convert: Converted '%s' into CTF data '%s' ]\n",
1679 "[ perf data convert: Converted and wrote %.3f MB (%" PRIu64
" samples",
1680 (double) c
.events_size
/ 1024.0 / 1024.0,
1683 if (!c
.non_sample_count
)
1684 fprintf(stderr
, ") ]\n");
1686 fprintf(stderr
, ", %" PRIu64
" non-samples) ]\n", c
.non_sample_count
);
1688 cleanup_events(session
);
1689 perf_session__delete(session
);
1690 ctf_writer__cleanup(cw
);
1695 ctf_writer__cleanup(cw
);
1697 perf_session__delete(session
);
1698 pr_err("Error during conversion setup.\n");