1 // SPDX-License-Identifier: GPL-2.0
4 #include "util/counts.h"
5 #include "util/debug.h"
7 #include <subcmd/exec-cmd.h>
8 #include "util/header.h"
9 #include <subcmd/parse-options.h>
10 #include "util/perf_regs.h"
11 #include "util/session.h"
12 #include "util/tool.h"
14 #include "util/srcline.h"
15 #include "util/symbol.h"
16 #include "util/thread.h"
17 #include "util/trace-event.h"
18 #include "util/evlist.h"
19 #include "util/evsel.h"
20 #include "util/evsel_fprintf.h"
21 #include "util/evswitch.h"
22 #include "util/sort.h"
23 #include "util/data.h"
24 #include "util/auxtrace.h"
25 #include "util/cpumap.h"
26 #include "util/thread_map.h"
27 #include "util/stat.h"
28 #include "util/color.h"
29 #include "util/string2.h"
30 #include "util/thread-stack.h"
31 #include "util/time-utils.h"
32 #include "util/path.h"
34 #include "print_binary.h"
36 #include <linux/bitmap.h>
37 #include <linux/kernel.h>
38 #include <linux/stringify.h>
39 #include <linux/time64.h>
40 #include <linux/zalloc.h>
41 #include <sys/utsname.h>
43 #include "util/mem-events.h"
44 #include "util/dump-insn.h"
49 #include <sys/param.h>
50 #include <sys/types.h>
54 #include <subcmd/pager.h>
55 #include <perf/evlist.h>
56 #include <linux/err.h>
57 #include "util/record.h"
58 #include "util/util.h"
61 #include <linux/ctype.h>
63 static char const *script_name;
64 static char const *generate_script_lang;
66 static u64 initial_time;
67 static bool debug_mode;
68 static u64 last_timestamp;
69 static u64 nr_unordered;
70 static bool no_callchain;
71 static bool latency_format;
72 static bool system_wide;
73 static bool print_flags;
74 static const char *cpu_list;
75 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
76 static struct perf_stat_config stat_config;
77 static int max_blocks;
78 static bool native_arch;
80 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
82 enum perf_output_field {
83 PERF_OUTPUT_COMM = 1U << 0,
84 PERF_OUTPUT_TID = 1U << 1,
85 PERF_OUTPUT_PID = 1U << 2,
86 PERF_OUTPUT_TIME = 1U << 3,
87 PERF_OUTPUT_CPU = 1U << 4,
88 PERF_OUTPUT_EVNAME = 1U << 5,
89 PERF_OUTPUT_TRACE = 1U << 6,
90 PERF_OUTPUT_IP = 1U << 7,
91 PERF_OUTPUT_SYM = 1U << 8,
92 PERF_OUTPUT_DSO = 1U << 9,
93 PERF_OUTPUT_ADDR = 1U << 10,
94 PERF_OUTPUT_SYMOFFSET = 1U << 11,
95 PERF_OUTPUT_SRCLINE = 1U << 12,
96 PERF_OUTPUT_PERIOD = 1U << 13,
97 PERF_OUTPUT_IREGS = 1U << 14,
98 PERF_OUTPUT_BRSTACK = 1U << 15,
99 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
100 PERF_OUTPUT_DATA_SRC = 1U << 17,
101 PERF_OUTPUT_WEIGHT = 1U << 18,
102 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
103 PERF_OUTPUT_CALLINDENT = 1U << 20,
104 PERF_OUTPUT_INSN = 1U << 21,
105 PERF_OUTPUT_INSNLEN = 1U << 22,
106 PERF_OUTPUT_BRSTACKINSN = 1U << 23,
107 PERF_OUTPUT_BRSTACKOFF = 1U << 24,
108 PERF_OUTPUT_SYNTH = 1U << 25,
109 PERF_OUTPUT_PHYS_ADDR = 1U << 26,
110 PERF_OUTPUT_UREGS = 1U << 27,
111 PERF_OUTPUT_METRIC = 1U << 28,
112 PERF_OUTPUT_MISC = 1U << 29,
113 PERF_OUTPUT_SRCCODE = 1U << 30,
114 PERF_OUTPUT_IPC = 1U << 31,
117 struct output_option {
119 enum perf_output_field field;
120 } all_output_options[] = {
121 {.str = "comm", .field = PERF_OUTPUT_COMM},
122 {.str = "tid", .field = PERF_OUTPUT_TID},
123 {.str = "pid", .field = PERF_OUTPUT_PID},
124 {.str = "time", .field = PERF_OUTPUT_TIME},
125 {.str = "cpu", .field = PERF_OUTPUT_CPU},
126 {.str = "event", .field = PERF_OUTPUT_EVNAME},
127 {.str = "trace", .field = PERF_OUTPUT_TRACE},
128 {.str = "ip", .field = PERF_OUTPUT_IP},
129 {.str = "sym", .field = PERF_OUTPUT_SYM},
130 {.str = "dso", .field = PERF_OUTPUT_DSO},
131 {.str = "addr", .field = PERF_OUTPUT_ADDR},
132 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
133 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
134 {.str = "period", .field = PERF_OUTPUT_PERIOD},
135 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
136 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
137 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
138 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
139 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
140 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
141 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
142 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
143 {.str = "insn", .field = PERF_OUTPUT_INSN},
144 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
145 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
146 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
147 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
148 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
149 {.str = "metric", .field = PERF_OUTPUT_METRIC},
150 {.str = "misc", .field = PERF_OUTPUT_MISC},
151 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
152 {.str = "ipc", .field = PERF_OUTPUT_IPC},
156 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
160 /* default set to maintain compatibility with current format */
164 unsigned int print_ip_opts;
168 } output[OUTPUT_TYPE_MAX] = {
170 [PERF_TYPE_HARDWARE] = {
173 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
174 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
175 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
176 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
177 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
179 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
182 [PERF_TYPE_SOFTWARE] = {
185 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
186 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
187 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
188 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
189 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
190 PERF_OUTPUT_BPF_OUTPUT,
192 .invalid_fields = PERF_OUTPUT_TRACE,
195 [PERF_TYPE_TRACEPOINT] = {
198 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
199 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
200 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
203 [PERF_TYPE_HW_CACHE] = {
206 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
207 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
208 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
209 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
210 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
212 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
218 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
219 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
220 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
221 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
222 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
223 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
224 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR,
226 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
229 [PERF_TYPE_BREAKPOINT] = {
232 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
233 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
234 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
235 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
236 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
238 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
241 [OUTPUT_TYPE_SYNTH] = {
244 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
245 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
246 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
247 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
248 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
250 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
254 struct evsel_script {
258 /* For metric output */
263 static inline struct evsel_script *evsel_script(struct evsel *evsel)
265 return (struct evsel_script *)evsel->priv;
268 static struct evsel_script *perf_evsel_script__new(struct evsel *evsel,
269 struct perf_data *data)
271 struct evsel_script *es = zalloc(sizeof(*es));
274 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, perf_evsel__name(evsel)) < 0)
276 es->fp = fopen(es->filename, "w");
278 goto out_free_filename;
283 zfree(&es->filename);
289 static void perf_evsel_script__delete(struct evsel_script *es)
291 zfree(&es->filename);
297 static int perf_evsel_script__fprintf(struct evsel_script *es, FILE *fp)
301 fstat(fileno(es->fp), &st);
302 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
303 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
306 static inline int output_type(unsigned int type)
309 case PERF_TYPE_SYNTH:
310 return OUTPUT_TYPE_SYNTH;
316 static inline unsigned int attr_type(unsigned int type)
319 case OUTPUT_TYPE_SYNTH:
320 return PERF_TYPE_SYNTH;
326 static bool output_set_by_user(void)
329 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
330 if (output[j].user_set)
336 static const char *output_field2str(enum perf_output_field field)
338 int i, imax = ARRAY_SIZE(all_output_options);
339 const char *str = "";
341 for (i = 0; i < imax; ++i) {
342 if (all_output_options[i].field == field) {
343 str = all_output_options[i].str;
350 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
352 static int perf_evsel__do_check_stype(struct evsel *evsel,
353 u64 sample_type, const char *sample_msg,
354 enum perf_output_field field,
357 struct perf_event_attr *attr = &evsel->core.attr;
358 int type = output_type(attr->type);
361 if (attr->sample_type & sample_type)
364 if (output[type].user_set_fields & field) {
367 evname = perf_evsel__name(evsel);
368 pr_err("Samples for '%s' event do not have %s attribute set. "
369 "Cannot print '%s' field.\n",
370 evname, sample_msg, output_field2str(field));
374 /* user did not ask for it explicitly so remove from the default list */
375 output[type].fields &= ~field;
376 evname = perf_evsel__name(evsel);
377 pr_debug("Samples for '%s' event do not have %s attribute set. "
378 "Skipping '%s' field.\n",
379 evname, sample_msg, output_field2str(field));
384 static int perf_evsel__check_stype(struct evsel *evsel,
385 u64 sample_type, const char *sample_msg,
386 enum perf_output_field field)
388 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
392 static int perf_evsel__check_attr(struct evsel *evsel,
393 struct perf_session *session)
395 struct perf_event_attr *attr = &evsel->core.attr;
398 if (perf_header__has_feat(&session->header, HEADER_STAT))
401 allow_user_set = perf_header__has_feat(&session->header,
404 if (PRINT_FIELD(TRACE) &&
405 !perf_session__has_traces(session, "record -R"))
408 if (PRINT_FIELD(IP)) {
409 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
414 if (PRINT_FIELD(ADDR) &&
415 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
416 PERF_OUTPUT_ADDR, allow_user_set))
419 if (PRINT_FIELD(DATA_SRC) &&
420 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
421 PERF_OUTPUT_DATA_SRC))
424 if (PRINT_FIELD(WEIGHT) &&
425 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
429 if (PRINT_FIELD(SYM) &&
430 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
431 pr_err("Display of symbols requested but neither sample IP nor "
432 "sample address\navailable. Hence, no addresses to convert "
436 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
437 pr_err("Display of offsets requested but symbol is not"
441 if (PRINT_FIELD(DSO) &&
442 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
443 pr_err("Display of DSO requested but no address to convert.\n");
446 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
447 pr_err("Display of source line number requested but sample IP is not\n"
448 "selected. Hence, no address to lookup the source line number.\n");
451 if (PRINT_FIELD(BRSTACKINSN) &&
452 !(perf_evlist__combined_branch_type(session->evlist) &
453 PERF_SAMPLE_BRANCH_ANY)) {
454 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
455 "Hint: run 'perf record -b ...'\n");
458 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
459 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
460 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
463 if (PRINT_FIELD(TIME) &&
464 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
468 if (PRINT_FIELD(CPU) &&
469 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
470 PERF_OUTPUT_CPU, allow_user_set))
473 if (PRINT_FIELD(IREGS) &&
474 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
478 if (PRINT_FIELD(UREGS) &&
479 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS",
483 if (PRINT_FIELD(PHYS_ADDR) &&
484 perf_evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR",
485 PERF_OUTPUT_PHYS_ADDR))
491 static void set_print_ip_opts(struct perf_event_attr *attr)
493 unsigned int type = output_type(attr->type);
495 output[type].print_ip_opts = 0;
497 output[type].print_ip_opts |= EVSEL__PRINT_IP;
499 if (PRINT_FIELD(SYM))
500 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
502 if (PRINT_FIELD(DSO))
503 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
505 if (PRINT_FIELD(SYMOFFSET))
506 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
508 if (PRINT_FIELD(SRCLINE))
509 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
513 * verify all user requested events exist and the samples
514 * have the expected data
516 static int perf_session__check_output_opt(struct perf_session *session)
521 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
522 evsel = perf_session__find_first_evtype(session, attr_type(j));
525 * even if fields is set to 0 (ie., show nothing) event must
526 * exist if user explicitly includes it on the command line
528 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
529 j != OUTPUT_TYPE_SYNTH) {
530 pr_err("%s events do not exist. "
531 "Remove corresponding -F option to proceed.\n",
536 if (evsel && output[j].fields &&
537 perf_evsel__check_attr(evsel, session))
543 set_print_ip_opts(&evsel->core.attr);
547 bool use_callchain = false;
548 bool not_pipe = false;
550 evlist__for_each_entry(session->evlist, evsel) {
552 if (evsel__has_callchain(evsel)) {
553 use_callchain = true;
557 if (not_pipe && !use_callchain)
558 symbol_conf.use_callchain = false;
562 * set default for tracepoints to print symbols only
563 * if callchains are present
565 if (symbol_conf.use_callchain &&
566 !output[PERF_TYPE_TRACEPOINT].user_set) {
567 j = PERF_TYPE_TRACEPOINT;
569 evlist__for_each_entry(session->evlist, evsel) {
570 if (evsel->core.attr.type != j)
573 if (evsel__has_callchain(evsel)) {
574 output[j].fields |= PERF_OUTPUT_IP;
575 output[j].fields |= PERF_OUTPUT_SYM;
576 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
577 output[j].fields |= PERF_OUTPUT_DSO;
578 set_print_ip_opts(&evsel->core.attr);
588 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
595 if (!regs || !regs->regs)
598 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
600 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
601 u64 val = regs->regs[i++];
602 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
610 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
611 struct perf_event_attr *attr, FILE *fp)
613 return perf_sample__fprintf_regs(&sample->intr_regs,
614 attr->sample_regs_intr, fp);
617 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
618 struct perf_event_attr *attr, FILE *fp)
620 return perf_sample__fprintf_regs(&sample->user_regs,
621 attr->sample_regs_user, fp);
624 static int perf_sample__fprintf_start(struct perf_sample *sample,
625 struct thread *thread,
629 struct perf_event_attr *attr = &evsel->core.attr;
631 unsigned long long nsecs;
634 if (PRINT_FIELD(COMM)) {
636 printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
637 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
638 printed += fprintf(fp, "%s ", thread__comm_str(thread));
640 printed += fprintf(fp, "%16s ", thread__comm_str(thread));
643 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
644 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
645 else if (PRINT_FIELD(PID))
646 printed += fprintf(fp, "%5d ", sample->pid);
647 else if (PRINT_FIELD(TID))
648 printed += fprintf(fp, "%5d ", sample->tid);
650 if (PRINT_FIELD(CPU)) {
652 printed += fprintf(fp, "%3d ", sample->cpu);
654 printed += fprintf(fp, "[%03d] ", sample->cpu);
657 if (PRINT_FIELD(MISC)) {
661 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
664 ret += fprintf(fp, "K");
666 ret += fprintf(fp, "U");
668 ret += fprintf(fp, "H");
669 if (has(GUEST_KERNEL))
670 ret += fprintf(fp, "G");
672 ret += fprintf(fp, "g");
675 case PERF_RECORD_MMAP:
676 case PERF_RECORD_MMAP2:
678 ret += fprintf(fp, "M");
680 case PERF_RECORD_COMM:
682 ret += fprintf(fp, "E");
684 case PERF_RECORD_SWITCH:
685 case PERF_RECORD_SWITCH_CPU_WIDE:
686 if (has(SWITCH_OUT)) {
687 ret += fprintf(fp, "S");
688 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
689 ret += fprintf(fp, "p");
697 ret += fprintf(fp, "%*s", 6 - ret, " ");
701 if (PRINT_FIELD(TIME)) {
702 u64 t = sample->time;
705 initial_time = sample->time;
706 t = sample->time - initial_time;
709 secs = nsecs / NSEC_PER_SEC;
710 nsecs -= secs * NSEC_PER_SEC;
712 if (symbol_conf.nanosecs)
713 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
715 char sample_time[32];
716 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
717 printed += fprintf(fp, "%12s: ", sample_time);
725 mispred_str(struct branch_entry *br)
727 if (!(br->flags.mispred || br->flags.predicted))
730 return br->flags.predicted ? 'P' : 'M';
733 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
734 struct thread *thread,
735 struct perf_event_attr *attr, FILE *fp)
737 struct branch_stack *br = sample->branch_stack;
738 struct addr_location alf, alt;
745 for (i = 0; i < br->nr; i++) {
746 from = br->entries[i].from;
747 to = br->entries[i].to;
749 if (PRINT_FIELD(DSO)) {
750 memset(&alf, 0, sizeof(alf));
751 memset(&alt, 0, sizeof(alt));
752 thread__find_map_fb(thread, sample->cpumode, from, &alf);
753 thread__find_map_fb(thread, sample->cpumode, to, &alt);
756 printed += fprintf(fp, " 0x%"PRIx64, from);
757 if (PRINT_FIELD(DSO)) {
758 printed += fprintf(fp, "(");
759 printed += map__fprintf_dsoname(alf.map, fp);
760 printed += fprintf(fp, ")");
763 printed += fprintf(fp, "/0x%"PRIx64, to);
764 if (PRINT_FIELD(DSO)) {
765 printed += fprintf(fp, "(");
766 printed += map__fprintf_dsoname(alt.map, fp);
767 printed += fprintf(fp, ")");
770 printed += fprintf(fp, "/%c/%c/%c/%d ",
771 mispred_str( br->entries + i),
772 br->entries[i].flags.in_tx? 'X' : '-',
773 br->entries[i].flags.abort? 'A' : '-',
774 br->entries[i].flags.cycles);
780 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
781 struct thread *thread,
782 struct perf_event_attr *attr, FILE *fp)
784 struct branch_stack *br = sample->branch_stack;
785 struct addr_location alf, alt;
792 for (i = 0; i < br->nr; i++) {
794 memset(&alf, 0, sizeof(alf));
795 memset(&alt, 0, sizeof(alt));
796 from = br->entries[i].from;
797 to = br->entries[i].to;
799 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
800 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
802 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
803 if (PRINT_FIELD(DSO)) {
804 printed += fprintf(fp, "(");
805 printed += map__fprintf_dsoname(alf.map, fp);
806 printed += fprintf(fp, ")");
808 printed += fprintf(fp, "%c", '/');
809 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
810 if (PRINT_FIELD(DSO)) {
811 printed += fprintf(fp, "(");
812 printed += map__fprintf_dsoname(alt.map, fp);
813 printed += fprintf(fp, ")");
815 printed += fprintf(fp, "/%c/%c/%c/%d ",
816 mispred_str( br->entries + i),
817 br->entries[i].flags.in_tx? 'X' : '-',
818 br->entries[i].flags.abort? 'A' : '-',
819 br->entries[i].flags.cycles);
825 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
826 struct thread *thread,
827 struct perf_event_attr *attr, FILE *fp)
829 struct branch_stack *br = sample->branch_stack;
830 struct addr_location alf, alt;
837 for (i = 0; i < br->nr; i++) {
839 memset(&alf, 0, sizeof(alf));
840 memset(&alt, 0, sizeof(alt));
841 from = br->entries[i].from;
842 to = br->entries[i].to;
844 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
845 !alf.map->dso->adjust_symbols)
846 from = map__map_ip(alf.map, from);
848 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
849 !alt.map->dso->adjust_symbols)
850 to = map__map_ip(alt.map, to);
852 printed += fprintf(fp, " 0x%"PRIx64, from);
853 if (PRINT_FIELD(DSO)) {
854 printed += fprintf(fp, "(");
855 printed += map__fprintf_dsoname(alf.map, fp);
856 printed += fprintf(fp, ")");
858 printed += fprintf(fp, "/0x%"PRIx64, to);
859 if (PRINT_FIELD(DSO)) {
860 printed += fprintf(fp, "(");
861 printed += map__fprintf_dsoname(alt.map, fp);
862 printed += fprintf(fp, ")");
864 printed += fprintf(fp, "/%c/%c/%c/%d ",
865 mispred_str(br->entries + i),
866 br->entries[i].flags.in_tx ? 'X' : '-',
867 br->entries[i].flags.abort ? 'A' : '-',
868 br->entries[i].flags.cycles);
873 #define MAXBB 16384UL
875 static int grab_bb(u8 *buffer, u64 start, u64 end,
876 struct machine *machine, struct thread *thread,
877 bool *is64bit, u8 *cpumode, bool last)
880 struct addr_location al;
886 kernel = machine__kernel_ip(machine, start);
888 *cpumode = PERF_RECORD_MISC_KERNEL;
890 *cpumode = PERF_RECORD_MISC_USER;
893 * Block overlaps between kernel and user.
894 * This can happen due to ring filtering
895 * On Intel CPUs the entry into the kernel is filtered,
896 * but the exit is not. Let the caller patch it up.
898 if (kernel != machine__kernel_ip(machine, end)) {
899 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
903 memset(&al, 0, sizeof(al));
904 if (end - start > MAXBB - MAXINSN) {
906 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
908 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
912 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
913 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
916 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
917 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
921 /* Load maps to ensure dso->is_64_bit has been updated */
924 offset = al.map->map_ip(al.map, start);
925 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
926 end - start + MAXINSN);
928 *is64bit = al.map->dso->is_64_bit;
930 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
935 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
937 struct addr_location al;
940 memset(&al, 0, sizeof(al));
941 thread__find_map(thread, cpumode, addr, &al);
944 ret = map__fprintf_srccode(al.map, al.addr, stdout,
945 &thread->srccode_state);
951 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
952 struct perf_insn *x, u8 *inbuf, int len,
953 int insn, FILE *fp, int *total_cycles)
955 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
956 dump_insn(x, ip, inbuf, len, NULL),
957 en->flags.predicted ? " PRED" : "",
958 en->flags.mispred ? " MISPRED" : "",
959 en->flags.in_tx ? " INTX" : "",
960 en->flags.abort ? " ABORT" : "");
961 if (en->flags.cycles) {
962 *total_cycles += en->flags.cycles;
963 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
965 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
967 return printed + fprintf(fp, "\n");
970 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
971 u8 cpumode, int cpu, struct symbol **lastsym,
972 struct perf_event_attr *attr, FILE *fp)
974 struct addr_location al;
975 int off, printed = 0;
977 memset(&al, 0, sizeof(al));
979 thread__find_map(thread, cpumode, addr, &al);
981 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
987 al.sym = map__find_symbol(al.map, al.addr);
992 if (al.addr < al.sym->end)
993 off = al.addr - al.sym->start;
995 off = al.addr - al.map->start - al.sym->start;
996 printed += fprintf(fp, "\t%s", al.sym->name);
998 printed += fprintf(fp, "%+d", off);
999 printed += fprintf(fp, ":");
1000 if (PRINT_FIELD(SRCLINE))
1001 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1002 printed += fprintf(fp, "\n");
1008 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1009 struct thread *thread,
1010 struct perf_event_attr *attr,
1011 struct machine *machine, FILE *fp)
1013 struct branch_stack *br = sample->branch_stack;
1015 int i, insn, len, nr, ilen, printed = 0;
1019 struct symbol *lastsym = NULL;
1020 int total_cycles = 0;
1022 if (!(br && br->nr))
1025 if (max_blocks && nr > max_blocks + 1)
1026 nr = max_blocks + 1;
1029 x.cpu = sample->cpu;
1031 printed += fprintf(fp, "%c", '\n');
1033 /* Handle first from jump, of which we don't know the entry. */
1034 len = grab_bb(buffer, br->entries[nr-1].from,
1035 br->entries[nr-1].from,
1036 machine, thread, &x.is64bit, &x.cpumode, false);
1038 printed += ip__fprintf_sym(br->entries[nr - 1].from, thread,
1039 x.cpumode, x.cpu, &lastsym, attr, fp);
1040 printed += ip__fprintf_jump(br->entries[nr - 1].from, &br->entries[nr - 1],
1041 &x, buffer, len, 0, fp, &total_cycles);
1042 if (PRINT_FIELD(SRCCODE))
1043 printed += print_srccode(thread, x.cpumode, br->entries[nr - 1].from);
1046 /* Print all blocks */
1047 for (i = nr - 2; i >= 0; i--) {
1048 if (br->entries[i].from || br->entries[i].to)
1049 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1050 br->entries[i].from,
1052 start = br->entries[i + 1].to;
1053 end = br->entries[i].from;
1055 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1056 /* Patch up missing kernel transfers due to ring filters */
1057 if (len == -ENXIO && i > 0) {
1058 end = br->entries[--i].from;
1059 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1060 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1066 for (off = 0; off < (unsigned)len; off += ilen) {
1067 uint64_t ip = start + off;
1069 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1071 printed += ip__fprintf_jump(ip, &br->entries[i], &x, buffer + off, len - off, ++insn, fp,
1073 if (PRINT_FIELD(SRCCODE))
1074 printed += print_srccode(thread, x.cpumode, ip);
1078 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1079 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1082 if (PRINT_FIELD(SRCCODE))
1083 print_srccode(thread, x.cpumode, ip);
1087 if (off != (unsigned)len)
1088 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1092 * Hit the branch? In this case we are already done, and the target
1093 * has not been executed yet.
1095 if (br->entries[0].from == sample->ip)
1097 if (br->entries[0].flags.abort)
1101 * Print final block upto sample
1103 * Due to pipeline delays the LBRs might be missing a branch
1104 * or two, which can result in very large or negative blocks
1105 * between final branch and sample. When this happens just
1106 * continue walking after the last TO until we hit a branch.
1108 start = br->entries[0].to;
1111 /* Missing jump. Scan 128 bytes for the next branch */
1114 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1115 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1117 /* Print at least last IP if basic block did not work */
1118 len = grab_bb(buffer, sample->ip, sample->ip,
1119 machine, thread, &x.is64bit, &x.cpumode, false);
1122 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1123 dump_insn(&x, sample->ip, buffer, len, NULL));
1124 if (PRINT_FIELD(SRCCODE))
1125 print_srccode(thread, x.cpumode, sample->ip);
1128 for (off = 0; off <= end - start; off += ilen) {
1130 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1131 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1134 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1136 * Hit a missing branch. Just stop.
1138 printed += fprintf(fp, "\t... not reaching sample ...\n");
1141 if (PRINT_FIELD(SRCCODE))
1142 print_srccode(thread, x.cpumode, start + off);
1148 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1149 struct thread *thread,
1150 struct perf_event_attr *attr, FILE *fp)
1152 struct addr_location al;
1153 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1155 if (!sample_addr_correlates_sym(attr))
1158 thread__resolve(thread, &al, sample);
1160 if (PRINT_FIELD(SYM)) {
1161 printed += fprintf(fp, " ");
1162 if (PRINT_FIELD(SYMOFFSET))
1163 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1165 printed += symbol__fprintf_symname(al.sym, fp);
1168 if (PRINT_FIELD(DSO)) {
1169 printed += fprintf(fp, " (");
1170 printed += map__fprintf_dsoname(al.map, fp);
1171 printed += fprintf(fp, ")");
1177 static const char *resolve_branch_sym(struct perf_sample *sample,
1178 struct evsel *evsel,
1179 struct thread *thread,
1180 struct addr_location *al,
1183 struct addr_location addr_al;
1184 struct perf_event_attr *attr = &evsel->core.attr;
1185 const char *name = NULL;
1187 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1188 if (sample_addr_correlates_sym(attr)) {
1189 thread__resolve(thread, &addr_al, sample);
1191 name = addr_al.sym->name;
1197 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1199 name = al->sym->name;
1206 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1207 struct evsel *evsel,
1208 struct thread *thread,
1209 struct addr_location *al, FILE *fp)
1211 struct perf_event_attr *attr = &evsel->core.attr;
1212 size_t depth = thread_stack__depth(thread, sample->cpu);
1213 const char *name = NULL;
1220 * The 'return' has already been popped off the stack so the depth has
1221 * to be adjusted to match the 'call'.
1223 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1226 name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1228 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1229 dlen += fprintf(fp, "(");
1230 dlen += map__fprintf_dsoname(al->map, fp);
1231 dlen += fprintf(fp, ")\t");
1235 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1237 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1243 * Try to keep the output length from changing frequently so that the
1244 * output lines up more nicely.
1246 if (len > spacing || (len && len < spacing - 52))
1247 spacing = round_up(len + 4, 32);
1250 len += fprintf(fp, "%*s", spacing - len, "");
1255 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1256 struct thread *thread __maybe_unused,
1257 struct machine *machine __maybe_unused)
1261 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1262 struct perf_event_attr *attr,
1263 struct thread *thread,
1264 struct machine *machine, FILE *fp)
1268 if (sample->insn_len == 0 && native_arch)
1269 arch_fetch_insn(sample, thread, machine);
1271 if (PRINT_FIELD(INSNLEN))
1272 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1273 if (PRINT_FIELD(INSN) && sample->insn_len) {
1276 printed += fprintf(fp, " insn:");
1277 for (i = 0; i < sample->insn_len; i++)
1278 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1280 if (PRINT_FIELD(BRSTACKINSN))
1281 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1286 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1287 struct perf_event_attr *attr, FILE *fp)
1291 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1294 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1296 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1297 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1300 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1301 struct evsel *evsel,
1302 struct thread *thread,
1303 struct addr_location *al,
1304 struct machine *machine, FILE *fp)
1306 struct perf_event_attr *attr = &evsel->core.attr;
1307 unsigned int type = output_type(attr->type);
1308 bool print_srcline_last = false;
1311 if (PRINT_FIELD(CALLINDENT))
1312 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1314 /* print branch_from information */
1315 if (PRINT_FIELD(IP)) {
1316 unsigned int print_opts = output[type].print_ip_opts;
1317 struct callchain_cursor *cursor = NULL;
1319 if (symbol_conf.use_callchain && sample->callchain &&
1320 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1321 sample, NULL, NULL, scripting_max_stack) == 0)
1322 cursor = &callchain_cursor;
1324 if (cursor == NULL) {
1325 printed += fprintf(fp, " ");
1326 if (print_opts & EVSEL__PRINT_SRCLINE) {
1327 print_srcline_last = true;
1328 print_opts &= ~EVSEL__PRINT_SRCLINE;
1331 printed += fprintf(fp, "\n");
1333 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1334 symbol_conf.bt_stop_list, fp);
1337 /* print branch_to information */
1338 if (PRINT_FIELD(ADDR) ||
1339 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1340 !output[type].user_set)) {
1341 printed += fprintf(fp, " => ");
1342 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1345 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1347 if (print_srcline_last)
1348 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1350 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1351 printed += fprintf(fp, "\n");
1352 if (PRINT_FIELD(SRCCODE)) {
1353 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1354 &thread->srccode_state);
1357 printed += printf("\n");
1366 } sample_flags[] = {
1367 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1368 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1369 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1370 {PERF_IP_FLAG_BRANCH, "jmp"},
1371 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1372 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1373 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1374 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1375 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1376 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1377 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1378 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1379 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1383 static const char *sample_flags_to_name(u32 flags)
1387 for (i = 0; sample_flags[i].name ; i++) {
1388 if (sample_flags[i].flags == flags)
1389 return sample_flags[i].name;
1395 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1397 const char *chars = PERF_IP_FLAG_CHARS;
1398 const int n = strlen(PERF_IP_FLAG_CHARS);
1399 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1400 const char *name = NULL;
1404 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1406 return fprintf(fp, " %-15s%4s ", name, in_tx ? "(x)" : "");
1408 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1409 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1411 return fprintf(fp, " tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1414 if (flags & PERF_IP_FLAG_TRACE_END) {
1415 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1417 return fprintf(fp, " tr end %-7s%4s ", name, in_tx ? "(x)" : "");
1420 for (i = 0; i < n; i++, flags >>= 1) {
1422 str[pos++] = chars[i];
1424 for (; i < 32; i++, flags >>= 1) {
1430 return fprintf(fp, " %-19s ", str);
1433 struct printer_data {
1439 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1441 void *extra, FILE *fp)
1443 unsigned char ch = (unsigned char)val;
1444 struct printer_data *printer_data = extra;
1448 case BINARY_PRINT_DATA_BEGIN:
1449 printed += fprintf(fp, "\n");
1451 case BINARY_PRINT_LINE_BEGIN:
1452 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1455 case BINARY_PRINT_ADDR:
1456 printed += fprintf(fp, " %04x:", val);
1458 case BINARY_PRINT_NUM_DATA:
1459 printed += fprintf(fp, " %02x", val);
1461 case BINARY_PRINT_NUM_PAD:
1462 printed += fprintf(fp, " ");
1464 case BINARY_PRINT_SEP:
1465 printed += fprintf(fp, " ");
1467 case BINARY_PRINT_CHAR_DATA:
1468 if (printer_data->hit_nul && ch)
1469 printer_data->is_printable = false;
1472 printed += fprintf(fp, "%c", '.');
1474 if (!printer_data->is_printable)
1478 printer_data->hit_nul = true;
1480 printer_data->is_printable = false;
1482 printed += fprintf(fp, "%c", ch);
1485 case BINARY_PRINT_CHAR_PAD:
1486 printed += fprintf(fp, " ");
1488 case BINARY_PRINT_LINE_END:
1489 printed += fprintf(fp, "\n");
1490 printer_data->line_no++;
1492 case BINARY_PRINT_DATA_END:
1500 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1502 unsigned int nr_bytes = sample->raw_size;
1503 struct printer_data printer_data = {0, false, true};
1504 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1505 sample__fprintf_bpf_output, &printer_data, fp);
1507 if (printer_data.is_printable && printer_data.hit_nul)
1508 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1513 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1515 if (len > 0 && len < spacing)
1516 return fprintf(fp, "%*s", spacing - len, "");
1521 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1523 return perf_sample__fprintf_spacing(len, 34, fp);
1526 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1528 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1531 if (perf_sample__bad_synth_size(sample, *data))
1534 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1535 data->ip, le64_to_cpu(data->payload));
1536 return len + perf_sample__fprintf_pt_spacing(len, fp);
1539 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1541 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1544 if (perf_sample__bad_synth_size(sample, *data))
1547 len = fprintf(fp, " hints: %#x extensions: %#x ",
1548 data->hints, data->extensions);
1549 return len + perf_sample__fprintf_pt_spacing(len, fp);
1552 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1554 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1557 if (perf_sample__bad_synth_size(sample, *data))
1560 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1561 data->hw, data->cstate, data->subcstate);
1562 return len + perf_sample__fprintf_pt_spacing(len, fp);
1565 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1567 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1570 if (perf_sample__bad_synth_size(sample, *data))
1573 len = fprintf(fp, " IP: %u ", data->ip);
1574 return len + perf_sample__fprintf_pt_spacing(len, fp);
1577 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1579 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1582 if (perf_sample__bad_synth_size(sample, *data))
1585 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1586 data->deepest_cstate, data->last_cstate,
1588 return len + perf_sample__fprintf_pt_spacing(len, fp);
1591 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1593 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1594 unsigned int percent, freq;
1597 if (perf_sample__bad_synth_size(sample, *data))
1600 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1601 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1602 if (data->max_nonturbo) {
1603 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1604 len += fprintf(fp, "(%3u%%) ", percent);
1606 return len + perf_sample__fprintf_pt_spacing(len, fp);
1609 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1610 struct evsel *evsel, FILE *fp)
1612 switch (evsel->core.attr.config) {
1613 case PERF_SYNTH_INTEL_PTWRITE:
1614 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1615 case PERF_SYNTH_INTEL_MWAIT:
1616 return perf_sample__fprintf_synth_mwait(sample, fp);
1617 case PERF_SYNTH_INTEL_PWRE:
1618 return perf_sample__fprintf_synth_pwre(sample, fp);
1619 case PERF_SYNTH_INTEL_EXSTOP:
1620 return perf_sample__fprintf_synth_exstop(sample, fp);
1621 case PERF_SYNTH_INTEL_PWRX:
1622 return perf_sample__fprintf_synth_pwrx(sample, fp);
1623 case PERF_SYNTH_INTEL_CBR:
1624 return perf_sample__fprintf_synth_cbr(sample, fp);
1632 struct perf_script {
1633 struct perf_tool tool;
1634 struct perf_session *session;
1635 bool show_task_events;
1636 bool show_mmap_events;
1637 bool show_switch_events;
1638 bool show_namespace_events;
1639 bool show_lost_events;
1640 bool show_round_events;
1641 bool show_bpf_events;
1643 bool per_event_dump;
1644 struct evswitch evswitch;
1645 struct perf_cpu_map *cpus;
1646 struct perf_thread_map *threads;
1648 const char *time_str;
1649 struct perf_time_interval *ptime_range;
1654 static int perf_evlist__max_name_len(struct evlist *evlist)
1656 struct evsel *evsel;
1659 evlist__for_each_entry(evlist, evsel) {
1660 int len = strlen(perf_evsel__name(evsel));
1662 max = MAX(len, max);
1668 static int data_src__fprintf(u64 data_src, FILE *fp)
1670 struct mem_info mi = { .data_src.val = data_src };
1676 perf_script__meminfo_scnprintf(decode, 100, &mi);
1678 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1682 return fprintf(fp, "%-*s", maxlen, out);
1686 struct perf_sample *sample;
1687 struct thread *thread;
1688 struct evsel *evsel;
1692 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1693 void *ctx, const char *color,
1695 const char *unit, double val)
1697 struct metric_ctx *mctx = ctx;
1701 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1702 PERF_RECORD_SAMPLE, mctx->fp);
1703 fputs("\tmetric: ", mctx->fp);
1705 color_fprintf(mctx->fp, color, fmt, val);
1708 fprintf(mctx->fp, " %s\n", unit);
1711 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1714 struct metric_ctx *mctx = ctx;
1716 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1717 PERF_RECORD_SAMPLE, mctx->fp);
1718 fputs("\tmetric: ", mctx->fp);
1721 static void perf_sample__fprint_metric(struct perf_script *script,
1722 struct thread *thread,
1723 struct evsel *evsel,
1724 struct perf_sample *sample,
1727 struct perf_stat_output_ctx ctx = {
1728 .print_metric = script_print_metric,
1729 .new_line = script_new_line,
1730 .ctx = &(struct metric_ctx) {
1736 .force_header = false,
1742 perf_evlist__alloc_stats(script->session->evlist, false);
1743 if (evsel_script(evsel->leader)->gnum++ == 0)
1744 perf_stat__reset_shadow_stats();
1745 val = sample->period * evsel->scale;
1746 perf_stat__update_shadow_stats(evsel,
1750 evsel_script(evsel)->val = val;
1751 if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1752 for_each_group_member (ev2, evsel->leader) {
1753 perf_stat__print_shadow_stats(&stat_config, ev2,
1754 evsel_script(ev2)->val,
1760 evsel_script(evsel->leader)->gnum = 0;
1764 static bool show_event(struct perf_sample *sample,
1765 struct evsel *evsel,
1766 struct thread *thread,
1767 struct addr_location *al)
1769 int depth = thread_stack__depth(thread, sample->cpu);
1771 if (!symbol_conf.graph_function)
1774 if (thread->filter) {
1775 if (depth <= thread->filter_entry_depth) {
1776 thread->filter = false;
1781 const char *s = symbol_conf.graph_function;
1783 const char *name = resolve_branch_sym(sample, evsel, thread, al,
1789 nlen = strlen(name);
1791 unsigned len = strcspn(s, ",");
1792 if (nlen == len && !strncmp(name, s, len)) {
1793 thread->filter = true;
1794 thread->filter_entry_depth = depth;
1805 static void process_event(struct perf_script *script,
1806 struct perf_sample *sample, struct evsel *evsel,
1807 struct addr_location *al,
1808 struct machine *machine)
1810 struct thread *thread = al->thread;
1811 struct perf_event_attr *attr = &evsel->core.attr;
1812 unsigned int type = output_type(attr->type);
1813 struct evsel_script *es = evsel->priv;
1816 if (output[type].fields == 0)
1819 if (!show_event(sample, evsel, thread, al))
1822 if (evswitch__discard(&script->evswitch, evsel))
1827 perf_sample__fprintf_start(sample, thread, evsel,
1828 PERF_RECORD_SAMPLE, fp);
1830 if (PRINT_FIELD(PERIOD))
1831 fprintf(fp, "%10" PRIu64 " ", sample->period);
1833 if (PRINT_FIELD(EVNAME)) {
1834 const char *evname = perf_evsel__name(evsel);
1836 if (!script->name_width)
1837 script->name_width = perf_evlist__max_name_len(script->session->evlist);
1839 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1843 perf_sample__fprintf_flags(sample->flags, fp);
1845 if (is_bts_event(attr)) {
1846 perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1850 if (PRINT_FIELD(TRACE) && sample->raw_data) {
1851 event_format__fprintf(evsel->tp_format, sample->cpu,
1852 sample->raw_data, sample->raw_size, fp);
1855 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1856 perf_sample__fprintf_synth(sample, evsel, fp);
1858 if (PRINT_FIELD(ADDR))
1859 perf_sample__fprintf_addr(sample, thread, attr, fp);
1861 if (PRINT_FIELD(DATA_SRC))
1862 data_src__fprintf(sample->data_src, fp);
1864 if (PRINT_FIELD(WEIGHT))
1865 fprintf(fp, "%16" PRIu64, sample->weight);
1867 if (PRINT_FIELD(IP)) {
1868 struct callchain_cursor *cursor = NULL;
1870 if (symbol_conf.use_callchain && sample->callchain &&
1871 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1872 sample, NULL, NULL, scripting_max_stack) == 0)
1873 cursor = &callchain_cursor;
1875 fputc(cursor ? '\n' : ' ', fp);
1876 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
1877 symbol_conf.bt_stop_list, fp);
1880 if (PRINT_FIELD(IREGS))
1881 perf_sample__fprintf_iregs(sample, attr, fp);
1883 if (PRINT_FIELD(UREGS))
1884 perf_sample__fprintf_uregs(sample, attr, fp);
1886 if (PRINT_FIELD(BRSTACK))
1887 perf_sample__fprintf_brstack(sample, thread, attr, fp);
1888 else if (PRINT_FIELD(BRSTACKSYM))
1889 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1890 else if (PRINT_FIELD(BRSTACKOFF))
1891 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
1893 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1894 perf_sample__fprintf_bpf_output(sample, fp);
1895 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1897 if (PRINT_FIELD(PHYS_ADDR))
1898 fprintf(fp, "%16" PRIx64, sample->phys_addr);
1900 perf_sample__fprintf_ipc(sample, attr, fp);
1904 if (PRINT_FIELD(SRCCODE)) {
1905 if (map__fprintf_srccode(al->map, al->addr, stdout,
1906 &thread->srccode_state))
1910 if (PRINT_FIELD(METRIC))
1911 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
1917 static struct scripting_ops *scripting_ops;
1919 static void __process_stat(struct evsel *counter, u64 tstamp)
1921 int nthreads = perf_thread_map__nr(counter->core.threads);
1922 int ncpus = perf_evsel__nr_cpus(counter);
1924 static int header_printed;
1926 if (counter->core.system_wide)
1929 if (!header_printed) {
1930 printf("%3s %8s %15s %15s %15s %15s %s\n",
1931 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
1935 for (thread = 0; thread < nthreads; thread++) {
1936 for (cpu = 0; cpu < ncpus; cpu++) {
1937 struct perf_counts_values *counts;
1939 counts = perf_counts(counter->counts, cpu, thread);
1941 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
1942 counter->core.cpus->map[cpu],
1943 perf_thread_map__pid(counter->core.threads, thread),
1948 perf_evsel__name(counter));
1953 static void process_stat(struct evsel *counter, u64 tstamp)
1955 if (scripting_ops && scripting_ops->process_stat)
1956 scripting_ops->process_stat(&stat_config, counter, tstamp);
1958 __process_stat(counter, tstamp);
1961 static void process_stat_interval(u64 tstamp)
1963 if (scripting_ops && scripting_ops->process_stat_interval)
1964 scripting_ops->process_stat_interval(tstamp);
1967 static void setup_scripting(void)
1969 setup_perl_scripting();
1970 setup_python_scripting();
1973 static int flush_scripting(void)
1975 return scripting_ops ? scripting_ops->flush_script() : 0;
1978 static int cleanup_scripting(void)
1980 pr_debug("\nperf script stopped\n");
1982 return scripting_ops ? scripting_ops->stop_script() : 0;
1985 static bool filter_cpu(struct perf_sample *sample)
1988 return !test_bit(sample->cpu, cpu_bitmap);
1992 static int process_sample_event(struct perf_tool *tool,
1993 union perf_event *event,
1994 struct perf_sample *sample,
1995 struct evsel *evsel,
1996 struct machine *machine)
1998 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1999 struct addr_location al;
2001 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2007 if (sample->time < last_timestamp) {
2008 pr_err("Samples misordered, previous: %" PRIu64
2009 " this: %" PRIu64 "\n", last_timestamp,
2013 last_timestamp = sample->time;
2017 if (machine__resolve(machine, &al, sample) < 0) {
2018 pr_err("problem processing %d event, skipping it.\n",
2019 event->header.type);
2026 if (filter_cpu(sample))
2030 scripting_ops->process_event(event, sample, evsel, &al);
2032 process_event(scr, sample, evsel, &al, machine);
2035 addr_location__put(&al);
2039 static int process_attr(struct perf_tool *tool, union perf_event *event,
2040 struct evlist **pevlist)
2042 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2043 struct evlist *evlist;
2044 struct evsel *evsel, *pos;
2046 static struct evsel_script *es;
2048 err = perf_event__process_attr(tool, event, pevlist);
2053 evsel = evlist__last(*pevlist);
2056 if (scr->per_event_dump) {
2057 evsel->priv = perf_evsel_script__new(evsel,
2058 scr->session->data);
2060 es = zalloc(sizeof(*es));
2068 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2069 evsel->core.attr.type != PERF_TYPE_SYNTH)
2072 evlist__for_each_entry(evlist, pos) {
2073 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2077 set_print_ip_opts(&evsel->core.attr);
2079 if (evsel->core.attr.sample_type)
2080 err = perf_evsel__check_attr(evsel, scr->session);
2085 static int process_comm_event(struct perf_tool *tool,
2086 union perf_event *event,
2087 struct perf_sample *sample,
2088 struct machine *machine)
2090 struct thread *thread;
2091 struct perf_script *script = container_of(tool, struct perf_script, tool);
2092 struct perf_session *session = script->session;
2093 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2096 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
2097 if (thread == NULL) {
2098 pr_debug("problem processing COMM event, skipping it.\n");
2102 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2105 if (!evsel->core.attr.sample_id_all) {
2108 sample->tid = event->comm.tid;
2109 sample->pid = event->comm.pid;
2111 if (!filter_cpu(sample)) {
2112 perf_sample__fprintf_start(sample, thread, evsel,
2113 PERF_RECORD_COMM, stdout);
2114 perf_event__fprintf(event, stdout);
2118 thread__put(thread);
2122 static int process_namespaces_event(struct perf_tool *tool,
2123 union perf_event *event,
2124 struct perf_sample *sample,
2125 struct machine *machine)
2127 struct thread *thread;
2128 struct perf_script *script = container_of(tool, struct perf_script, tool);
2129 struct perf_session *session = script->session;
2130 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2133 thread = machine__findnew_thread(machine, event->namespaces.pid,
2134 event->namespaces.tid);
2135 if (thread == NULL) {
2136 pr_debug("problem processing NAMESPACES event, skipping it.\n");
2140 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2143 if (!evsel->core.attr.sample_id_all) {
2146 sample->tid = event->namespaces.tid;
2147 sample->pid = event->namespaces.pid;
2149 if (!filter_cpu(sample)) {
2150 perf_sample__fprintf_start(sample, thread, evsel,
2151 PERF_RECORD_NAMESPACES, stdout);
2152 perf_event__fprintf(event, stdout);
2156 thread__put(thread);
2160 static int process_fork_event(struct perf_tool *tool,
2161 union perf_event *event,
2162 struct perf_sample *sample,
2163 struct machine *machine)
2165 struct thread *thread;
2166 struct perf_script *script = container_of(tool, struct perf_script, tool);
2167 struct perf_session *session = script->session;
2168 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2170 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2173 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
2174 if (thread == NULL) {
2175 pr_debug("problem processing FORK event, skipping it.\n");
2179 if (!evsel->core.attr.sample_id_all) {
2181 sample->time = event->fork.time;
2182 sample->tid = event->fork.tid;
2183 sample->pid = event->fork.pid;
2185 if (!filter_cpu(sample)) {
2186 perf_sample__fprintf_start(sample, thread, evsel,
2187 PERF_RECORD_FORK, stdout);
2188 perf_event__fprintf(event, stdout);
2190 thread__put(thread);
2194 static int process_exit_event(struct perf_tool *tool,
2195 union perf_event *event,
2196 struct perf_sample *sample,
2197 struct machine *machine)
2200 struct thread *thread;
2201 struct perf_script *script = container_of(tool, struct perf_script, tool);
2202 struct perf_session *session = script->session;
2203 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2205 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
2206 if (thread == NULL) {
2207 pr_debug("problem processing EXIT event, skipping it.\n");
2211 if (!evsel->core.attr.sample_id_all) {
2214 sample->tid = event->fork.tid;
2215 sample->pid = event->fork.pid;
2217 if (!filter_cpu(sample)) {
2218 perf_sample__fprintf_start(sample, thread, evsel,
2219 PERF_RECORD_EXIT, stdout);
2220 perf_event__fprintf(event, stdout);
2223 if (perf_event__process_exit(tool, event, sample, machine) < 0)
2226 thread__put(thread);
2230 static int process_mmap_event(struct perf_tool *tool,
2231 union perf_event *event,
2232 struct perf_sample *sample,
2233 struct machine *machine)
2235 struct thread *thread;
2236 struct perf_script *script = container_of(tool, struct perf_script, tool);
2237 struct perf_session *session = script->session;
2238 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2240 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2243 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
2244 if (thread == NULL) {
2245 pr_debug("problem processing MMAP event, skipping it.\n");
2249 if (!evsel->core.attr.sample_id_all) {
2252 sample->tid = event->mmap.tid;
2253 sample->pid = event->mmap.pid;
2255 if (!filter_cpu(sample)) {
2256 perf_sample__fprintf_start(sample, thread, evsel,
2257 PERF_RECORD_MMAP, stdout);
2258 perf_event__fprintf(event, stdout);
2260 thread__put(thread);
2264 static int process_mmap2_event(struct perf_tool *tool,
2265 union perf_event *event,
2266 struct perf_sample *sample,
2267 struct machine *machine)
2269 struct thread *thread;
2270 struct perf_script *script = container_of(tool, struct perf_script, tool);
2271 struct perf_session *session = script->session;
2272 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2274 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2277 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
2278 if (thread == NULL) {
2279 pr_debug("problem processing MMAP2 event, skipping it.\n");
2283 if (!evsel->core.attr.sample_id_all) {
2286 sample->tid = event->mmap2.tid;
2287 sample->pid = event->mmap2.pid;
2289 if (!filter_cpu(sample)) {
2290 perf_sample__fprintf_start(sample, thread, evsel,
2291 PERF_RECORD_MMAP2, stdout);
2292 perf_event__fprintf(event, stdout);
2294 thread__put(thread);
2298 static int process_switch_event(struct perf_tool *tool,
2299 union perf_event *event,
2300 struct perf_sample *sample,
2301 struct machine *machine)
2303 struct thread *thread;
2304 struct perf_script *script = container_of(tool, struct perf_script, tool);
2305 struct perf_session *session = script->session;
2306 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2308 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2311 if (scripting_ops && scripting_ops->process_switch)
2312 scripting_ops->process_switch(event, sample, machine);
2314 if (!script->show_switch_events)
2317 thread = machine__findnew_thread(machine, sample->pid,
2319 if (thread == NULL) {
2320 pr_debug("problem processing SWITCH event, skipping it.\n");
2324 if (!filter_cpu(sample)) {
2325 perf_sample__fprintf_start(sample, thread, evsel,
2326 PERF_RECORD_SWITCH, stdout);
2327 perf_event__fprintf(event, stdout);
2329 thread__put(thread);
2334 process_lost_event(struct perf_tool *tool,
2335 union perf_event *event,
2336 struct perf_sample *sample,
2337 struct machine *machine)
2339 struct perf_script *script = container_of(tool, struct perf_script, tool);
2340 struct perf_session *session = script->session;
2341 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2342 struct thread *thread;
2344 thread = machine__findnew_thread(machine, sample->pid,
2349 if (!filter_cpu(sample)) {
2350 perf_sample__fprintf_start(sample, thread, evsel,
2351 PERF_RECORD_LOST, stdout);
2352 perf_event__fprintf(event, stdout);
2354 thread__put(thread);
2359 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2360 union perf_event *event,
2361 struct ordered_events *oe __maybe_unused)
2364 perf_event__fprintf(event, stdout);
2369 process_bpf_events(struct perf_tool *tool __maybe_unused,
2370 union perf_event *event,
2371 struct perf_sample *sample,
2372 struct machine *machine)
2374 struct thread *thread;
2375 struct perf_script *script = container_of(tool, struct perf_script, tool);
2376 struct perf_session *session = script->session;
2377 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2379 if (machine__process_ksymbol(machine, event, sample) < 0)
2382 if (!evsel->core.attr.sample_id_all) {
2383 perf_event__fprintf(event, stdout);
2387 thread = machine__findnew_thread(machine, sample->pid, sample->tid);
2388 if (thread == NULL) {
2389 pr_debug("problem processing MMAP event, skipping it.\n");
2393 if (!filter_cpu(sample)) {
2394 perf_sample__fprintf_start(sample, thread, evsel,
2395 event->header.type, stdout);
2396 perf_event__fprintf(event, stdout);
2399 thread__put(thread);
2403 static void sig_handler(int sig __maybe_unused)
2408 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2410 struct evlist *evlist = script->session->evlist;
2411 struct evsel *evsel;
2413 evlist__for_each_entry(evlist, evsel) {
2416 perf_evsel_script__delete(evsel->priv);
2421 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2423 struct evsel *evsel;
2425 evlist__for_each_entry(script->session->evlist, evsel) {
2427 * Already setup? I.e. we may be called twice in cases like
2428 * Intel PT, one for the intel_pt// and dummy events, then
2429 * for the evsels syntheized from the auxtrace info.
2431 * Ses perf_script__process_auxtrace_info.
2433 if (evsel->priv != NULL)
2436 evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2437 if (evsel->priv == NULL)
2438 goto out_err_fclose;
2444 perf_script__fclose_per_event_dump(script);
2448 static int perf_script__setup_per_event_dump(struct perf_script *script)
2450 struct evsel *evsel;
2451 static struct evsel_script es_stdout;
2453 if (script->per_event_dump)
2454 return perf_script__fopen_per_event_dump(script);
2456 es_stdout.fp = stdout;
2458 evlist__for_each_entry(script->session->evlist, evsel)
2459 evsel->priv = &es_stdout;
2464 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2466 struct evsel *evsel;
2468 evlist__for_each_entry(script->session->evlist, evsel) {
2469 struct evsel_script *es = evsel->priv;
2471 perf_evsel_script__fprintf(es, stdout);
2472 perf_evsel_script__delete(es);
2477 static int __cmd_script(struct perf_script *script)
2481 signal(SIGINT, sig_handler);
2483 perf_stat__init_shadow_stats();
2485 /* override event processing functions */
2486 if (script->show_task_events) {
2487 script->tool.comm = process_comm_event;
2488 script->tool.fork = process_fork_event;
2489 script->tool.exit = process_exit_event;
2491 if (script->show_mmap_events) {
2492 script->tool.mmap = process_mmap_event;
2493 script->tool.mmap2 = process_mmap2_event;
2495 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2496 script->tool.context_switch = process_switch_event;
2497 if (script->show_namespace_events)
2498 script->tool.namespaces = process_namespaces_event;
2499 if (script->show_lost_events)
2500 script->tool.lost = process_lost_event;
2501 if (script->show_round_events) {
2502 script->tool.ordered_events = false;
2503 script->tool.finished_round = process_finished_round_event;
2505 if (script->show_bpf_events) {
2506 script->tool.ksymbol = process_bpf_events;
2507 script->tool.bpf = process_bpf_events;
2510 if (perf_script__setup_per_event_dump(script)) {
2511 pr_err("Couldn't create the per event dump files\n");
2515 ret = perf_session__process_events(script->session);
2517 if (script->per_event_dump)
2518 perf_script__exit_per_event_dump_stats(script);
2521 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2526 struct script_spec {
2527 struct list_head node;
2528 struct scripting_ops *ops;
2532 static LIST_HEAD(script_specs);
2534 static struct script_spec *script_spec__new(const char *spec,
2535 struct scripting_ops *ops)
2537 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2540 strcpy(s->spec, spec);
2547 static void script_spec__add(struct script_spec *s)
2549 list_add_tail(&s->node, &script_specs);
2552 static struct script_spec *script_spec__find(const char *spec)
2554 struct script_spec *s;
2556 list_for_each_entry(s, &script_specs, node)
2557 if (strcasecmp(s->spec, spec) == 0)
2562 int script_spec_register(const char *spec, struct scripting_ops *ops)
2564 struct script_spec *s;
2566 s = script_spec__find(spec);
2570 s = script_spec__new(spec, ops);
2574 script_spec__add(s);
2579 static struct scripting_ops *script_spec__lookup(const char *spec)
2581 struct script_spec *s = script_spec__find(spec);
2588 static void list_available_languages(void)
2590 struct script_spec *s;
2592 fprintf(stderr, "\n");
2593 fprintf(stderr, "Scripting language extensions (used in "
2594 "perf script -s [spec:]script.[spec]):\n\n");
2596 list_for_each_entry(s, &script_specs, node)
2597 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2599 fprintf(stderr, "\n");
2602 static int parse_scriptname(const struct option *opt __maybe_unused,
2603 const char *str, int unset __maybe_unused)
2605 char spec[PATH_MAX];
2606 const char *script, *ext;
2609 if (strcmp(str, "lang") == 0) {
2610 list_available_languages();
2614 script = strchr(str, ':');
2617 if (len >= PATH_MAX) {
2618 fprintf(stderr, "invalid language specifier");
2621 strncpy(spec, str, len);
2623 scripting_ops = script_spec__lookup(spec);
2624 if (!scripting_ops) {
2625 fprintf(stderr, "invalid language specifier");
2631 ext = strrchr(script, '.');
2633 fprintf(stderr, "invalid script extension");
2636 scripting_ops = script_spec__lookup(++ext);
2637 if (!scripting_ops) {
2638 fprintf(stderr, "invalid script extension");
2643 script_name = strdup(script);
2648 static int parse_output_fields(const struct option *opt __maybe_unused,
2649 const char *arg, int unset __maybe_unused)
2651 char *tok, *strtok_saveptr = NULL;
2652 int i, imax = ARRAY_SIZE(all_output_options);
2655 char *str = strdup(arg);
2657 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2662 /* first word can state for which event type the user is specifying
2663 * the fields. If no type exists, the specified fields apply to all
2664 * event types found in the file minus the invalid fields for a type.
2666 tok = strchr(str, ':');
2670 if (!strcmp(str, "hw"))
2671 type = PERF_TYPE_HARDWARE;
2672 else if (!strcmp(str, "sw"))
2673 type = PERF_TYPE_SOFTWARE;
2674 else if (!strcmp(str, "trace"))
2675 type = PERF_TYPE_TRACEPOINT;
2676 else if (!strcmp(str, "raw"))
2677 type = PERF_TYPE_RAW;
2678 else if (!strcmp(str, "break"))
2679 type = PERF_TYPE_BREAKPOINT;
2680 else if (!strcmp(str, "synth"))
2681 type = OUTPUT_TYPE_SYNTH;
2683 fprintf(stderr, "Invalid event type in field string.\n");
2688 if (output[type].user_set)
2689 pr_warning("Overriding previous field request for %s events.\n",
2692 /* Don't override defaults for +- */
2693 if (strchr(tok, '+') || strchr(tok, '-'))
2696 output[type].fields = 0;
2697 output[type].user_set = true;
2698 output[type].wildcard_set = false;
2702 if (strlen(str) == 0) {
2704 "Cannot set fields to 'none' for all event types.\n");
2709 /* Don't override defaults for +- */
2710 if (strchr(str, '+') || strchr(str, '-'))
2713 if (output_set_by_user())
2714 pr_warning("Overriding previous field request for all events.\n");
2716 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2717 output[j].fields = 0;
2718 output[j].user_set = true;
2719 output[j].wildcard_set = true;
2724 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2730 } else if (*tok == '-') {
2736 if (change != SET && change != DEFAULT)
2741 for (i = 0; i < imax; ++i) {
2742 if (strcmp(tok, all_output_options[i].str) == 0)
2745 if (i == imax && strcmp(tok, "flags") == 0) {
2746 print_flags = change == REMOVE ? false : true;
2750 fprintf(stderr, "Invalid field requested.\n");
2756 /* add user option to all events types for
2759 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2760 if (output[j].invalid_fields & all_output_options[i].field) {
2761 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2762 all_output_options[i].str, event_type(j));
2764 if (change == REMOVE) {
2765 output[j].fields &= ~all_output_options[i].field;
2766 output[j].user_set_fields &= ~all_output_options[i].field;
2768 output[j].fields |= all_output_options[i].field;
2769 output[j].user_set_fields |= all_output_options[i].field;
2771 output[j].user_set = true;
2772 output[j].wildcard_set = true;
2776 if (output[type].invalid_fields & all_output_options[i].field) {
2777 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2778 all_output_options[i].str, event_type(type));
2783 if (change == REMOVE)
2784 output[type].fields &= ~all_output_options[i].field;
2786 output[type].fields |= all_output_options[i].field;
2787 output[type].user_set = true;
2788 output[type].wildcard_set = true;
2793 if (output[type].fields == 0) {
2794 pr_debug("No fields requested for %s type. "
2795 "Events will not be displayed.\n", event_type(type));
2801 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2808 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2809 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2810 if ((lang_dirent->d_type == DT_DIR || \
2811 (lang_dirent->d_type == DT_UNKNOWN && \
2812 is_directory(scripts_path, lang_dirent))) && \
2813 (strcmp(lang_dirent->d_name, ".")) && \
2814 (strcmp(lang_dirent->d_name, "..")))
2816 #define for_each_script(lang_path, lang_dir, script_dirent) \
2817 while ((script_dirent = readdir(lang_dir)) != NULL) \
2818 if (script_dirent->d_type != DT_DIR && \
2819 (script_dirent->d_type != DT_UNKNOWN || \
2820 !is_directory(lang_path, script_dirent)))
2823 #define RECORD_SUFFIX "-record"
2824 #define REPORT_SUFFIX "-report"
2826 struct script_desc {
2827 struct list_head node;
2833 static LIST_HEAD(script_descs);
2835 static struct script_desc *script_desc__new(const char *name)
2837 struct script_desc *s = zalloc(sizeof(*s));
2839 if (s != NULL && name)
2840 s->name = strdup(name);
2845 static void script_desc__delete(struct script_desc *s)
2848 zfree(&s->half_liner);
2853 static void script_desc__add(struct script_desc *s)
2855 list_add_tail(&s->node, &script_descs);
2858 static struct script_desc *script_desc__find(const char *name)
2860 struct script_desc *s;
2862 list_for_each_entry(s, &script_descs, node)
2863 if (strcasecmp(s->name, name) == 0)
2868 static struct script_desc *script_desc__findnew(const char *name)
2870 struct script_desc *s = script_desc__find(name);
2875 s = script_desc__new(name);
2879 script_desc__add(s);
2884 static const char *ends_with(const char *str, const char *suffix)
2886 size_t suffix_len = strlen(suffix);
2887 const char *p = str;
2889 if (strlen(str) > suffix_len) {
2890 p = str + strlen(str) - suffix_len;
2891 if (!strncmp(p, suffix, suffix_len))
2898 static int read_script_info(struct script_desc *desc, const char *filename)
2900 char line[BUFSIZ], *p;
2903 fp = fopen(filename, "r");
2907 while (fgets(line, sizeof(line), fp)) {
2908 p = skip_spaces(line);
2914 if (strlen(p) && *p == '!')
2918 if (strlen(p) && p[strlen(p) - 1] == '\n')
2919 p[strlen(p) - 1] = '\0';
2921 if (!strncmp(p, "description:", strlen("description:"))) {
2922 p += strlen("description:");
2923 desc->half_liner = strdup(skip_spaces(p));
2927 if (!strncmp(p, "args:", strlen("args:"))) {
2928 p += strlen("args:");
2929 desc->args = strdup(skip_spaces(p));
2939 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2941 char *script_root, *str;
2943 script_root = strdup(script_dirent->d_name);
2947 str = (char *)ends_with(script_root, suffix);
2957 static int list_available_scripts(const struct option *opt __maybe_unused,
2958 const char *s __maybe_unused,
2959 int unset __maybe_unused)
2961 struct dirent *script_dirent, *lang_dirent;
2962 char scripts_path[MAXPATHLEN];
2963 DIR *scripts_dir, *lang_dir;
2964 char script_path[MAXPATHLEN];
2965 char lang_path[MAXPATHLEN];
2966 struct script_desc *desc;
2967 char first_half[BUFSIZ];
2970 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2972 scripts_dir = opendir(scripts_path);
2975 "open(%s) failed.\n"
2976 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2981 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2982 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2983 lang_dirent->d_name);
2984 lang_dir = opendir(lang_path);
2988 for_each_script(lang_path, lang_dir, script_dirent) {
2989 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
2991 desc = script_desc__findnew(script_root);
2992 scnprintf(script_path, MAXPATHLEN, "%s/%s",
2993 lang_path, script_dirent->d_name);
2994 read_script_info(desc, script_path);
3000 fprintf(stdout, "List of available trace scripts:\n");
3001 list_for_each_entry(desc, &script_descs, node) {
3002 sprintf(first_half, "%s %s", desc->name,
3003 desc->args ? desc->args : "");
3004 fprintf(stdout, " %-36s %s\n", first_half,
3005 desc->half_liner ? desc->half_liner : "");
3012 * Some scripts specify the required events in their "xxx-record" file,
3013 * this function will check if the events in perf.data match those
3014 * mentioned in the "xxx-record".
3016 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3017 * which is covered well now. And new parsing code should be added to
3018 * cover the future complexing formats like event groups etc.
3020 static int check_ev_match(char *dir_name, char *scriptname,
3021 struct perf_session *session)
3023 char filename[MAXPATHLEN], evname[128];
3024 char line[BUFSIZ], *p;
3029 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3031 fp = fopen(filename, "r");
3035 while (fgets(line, sizeof(line), fp)) {
3036 p = skip_spaces(line);
3041 p = strstr(p, "-e");
3047 len = strcspn(p, " \t");
3051 snprintf(evname, len + 1, "%s", p);
3054 evlist__for_each_entry(session->evlist, pos) {
3055 if (!strcmp(perf_evsel__name(pos), evname)) {
3073 * Return -1 if none is found, otherwise the actual scripts number.
3075 * Currently the only user of this function is the script browser, which
3076 * will list all statically runnable scripts, select one, execute it and
3077 * show the output in a perf browser.
3079 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3082 struct dirent *script_dirent, *lang_dirent;
3083 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3084 DIR *scripts_dir, *lang_dir;
3085 struct perf_session *session;
3086 struct perf_data data = {
3088 .mode = PERF_DATA_MODE_READ,
3093 session = perf_session__new(&data, false, NULL);
3094 if (IS_ERR(session))
3095 return PTR_ERR(session);
3097 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3099 scripts_dir = opendir(scripts_path);
3101 perf_session__delete(session);
3105 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3106 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3107 lang_dirent->d_name);
3108 #ifndef HAVE_LIBPERL_SUPPORT
3109 if (strstr(lang_path, "perl"))
3112 #ifndef HAVE_LIBPYTHON_SUPPORT
3113 if (strstr(lang_path, "python"))
3117 lang_dir = opendir(lang_path);
3121 for_each_script(lang_path, lang_dir, script_dirent) {
3122 /* Skip those real time scripts: xxxtop.p[yl] */
3123 if (strstr(script_dirent->d_name, "top."))
3127 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3129 script_dirent->d_name);
3130 temp = strchr(script_dirent->d_name, '.');
3131 snprintf(scripts_array[i],
3132 (temp - script_dirent->d_name) + 1,
3133 "%s", script_dirent->d_name);
3135 if (check_ev_match(lang_path,
3136 scripts_array[i], session))
3144 closedir(scripts_dir);
3145 perf_session__delete(session);
3149 static char *get_script_path(const char *script_root, const char *suffix)
3151 struct dirent *script_dirent, *lang_dirent;
3152 char scripts_path[MAXPATHLEN];
3153 char script_path[MAXPATHLEN];
3154 DIR *scripts_dir, *lang_dir;
3155 char lang_path[MAXPATHLEN];
3156 char *__script_root;
3158 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3160 scripts_dir = opendir(scripts_path);
3164 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3165 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3166 lang_dirent->d_name);
3167 lang_dir = opendir(lang_path);
3171 for_each_script(lang_path, lang_dir, script_dirent) {
3172 __script_root = get_script_root(script_dirent, suffix);
3173 if (__script_root && !strcmp(script_root, __script_root)) {
3174 free(__script_root);
3176 closedir(scripts_dir);
3177 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3178 lang_path, script_dirent->d_name);
3179 return strdup(script_path);
3181 free(__script_root);
3185 closedir(scripts_dir);
3190 static bool is_top_script(const char *script_path)
3192 return ends_with(script_path, "top") == NULL ? false : true;
3195 static int has_required_arg(char *script_path)
3197 struct script_desc *desc;
3201 desc = script_desc__new(NULL);
3203 if (read_script_info(desc, script_path))
3209 for (p = desc->args; *p; p++)
3213 script_desc__delete(desc);
3218 static int have_cmd(int argc, const char **argv)
3220 char **__argv = malloc(sizeof(const char *) * argc);
3223 pr_err("malloc failed\n");
3227 memcpy(__argv, argv, sizeof(const char *) * argc);
3228 argc = parse_options(argc, (const char **)__argv, record_options,
3229 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3232 system_wide = (argc == 0);
3237 static void script__setup_sample_type(struct perf_script *script)
3239 struct perf_session *session = script->session;
3240 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
3242 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3243 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3244 (sample_type & PERF_SAMPLE_STACK_USER)) {
3245 callchain_param.record_mode = CALLCHAIN_DWARF;
3246 dwarf_callchain_users = true;
3247 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3248 callchain_param.record_mode = CALLCHAIN_LBR;
3250 callchain_param.record_mode = CALLCHAIN_FP;
3254 static int process_stat_round_event(struct perf_session *session,
3255 union perf_event *event)
3257 struct perf_record_stat_round *round = &event->stat_round;
3258 struct evsel *counter;
3260 evlist__for_each_entry(session->evlist, counter) {
3261 perf_stat_process_counter(&stat_config, counter);
3262 process_stat(counter, round->time);
3265 process_stat_interval(round->time);
3269 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3270 union perf_event *event)
3272 perf_event__read_stat_config(&stat_config, &event->stat_config);
3276 static int set_maps(struct perf_script *script)
3278 struct evlist *evlist = script->session->evlist;
3280 if (!script->cpus || !script->threads)
3283 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3286 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3288 if (perf_evlist__alloc_stats(evlist, true))
3291 script->allocated = true;
3296 int process_thread_map_event(struct perf_session *session,
3297 union perf_event *event)
3299 struct perf_tool *tool = session->tool;
3300 struct perf_script *script = container_of(tool, struct perf_script, tool);
3302 if (script->threads) {
3303 pr_warning("Extra thread map event, ignoring.\n");
3307 script->threads = thread_map__new_event(&event->thread_map);
3308 if (!script->threads)
3311 return set_maps(script);
3315 int process_cpu_map_event(struct perf_session *session,
3316 union perf_event *event)
3318 struct perf_tool *tool = session->tool;
3319 struct perf_script *script = container_of(tool, struct perf_script, tool);
3322 pr_warning("Extra cpu map event, ignoring.\n");
3326 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3330 return set_maps(script);
3333 static int process_feature_event(struct perf_session *session,
3334 union perf_event *event)
3336 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3337 return perf_event__process_feature(session, event);
3341 #ifdef HAVE_AUXTRACE_SUPPORT
3342 static int perf_script__process_auxtrace_info(struct perf_session *session,
3343 union perf_event *event)
3345 struct perf_tool *tool = session->tool;
3347 int ret = perf_event__process_auxtrace_info(session, event);
3350 struct perf_script *script = container_of(tool, struct perf_script, tool);
3352 ret = perf_script__setup_per_event_dump(script);
3358 #define perf_script__process_auxtrace_info 0
3361 static int parse_insn_trace(const struct option *opt __maybe_unused,
3362 const char *str __maybe_unused,
3363 int unset __maybe_unused)
3365 parse_output_fields(NULL, "+insn,-event,-period", 0);
3366 itrace_parse_synth_opts(opt, "i0ns", 0);
3367 symbol_conf.nanosecs = true;
3371 static int parse_xed(const struct option *opt __maybe_unused,
3372 const char *str __maybe_unused,
3373 int unset __maybe_unused)
3375 force_pager("xed -F insn: -A -64 | less");
3379 static int parse_call_trace(const struct option *opt __maybe_unused,
3380 const char *str __maybe_unused,
3381 int unset __maybe_unused)
3383 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3384 itrace_parse_synth_opts(opt, "cewp", 0);
3385 symbol_conf.nanosecs = true;
3386 symbol_conf.pad_output_len_dso = 50;
3390 static int parse_callret_trace(const struct option *opt __maybe_unused,
3391 const char *str __maybe_unused,
3392 int unset __maybe_unused)
3394 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3395 itrace_parse_synth_opts(opt, "crewp", 0);
3396 symbol_conf.nanosecs = true;
3400 int cmd_script(int argc, const char **argv)
3402 bool show_full_info = false;
3403 bool header = false;
3404 bool header_only = false;
3405 bool script_started = false;
3406 char *rec_script_path = NULL;
3407 char *rep_script_path = NULL;
3408 struct perf_session *session;
3409 struct itrace_synth_opts itrace_synth_opts = {
3411 .default_no_sample = true,
3414 char *script_path = NULL;
3415 const char **__argv;
3417 struct perf_script script = {
3419 .sample = process_sample_event,
3420 .mmap = perf_event__process_mmap,
3421 .mmap2 = perf_event__process_mmap2,
3422 .comm = perf_event__process_comm,
3423 .namespaces = perf_event__process_namespaces,
3424 .exit = perf_event__process_exit,
3425 .fork = perf_event__process_fork,
3426 .attr = process_attr,
3427 .event_update = perf_event__process_event_update,
3428 .tracing_data = perf_event__process_tracing_data,
3429 .feature = process_feature_event,
3430 .build_id = perf_event__process_build_id,
3431 .id_index = perf_event__process_id_index,
3432 .auxtrace_info = perf_script__process_auxtrace_info,
3433 .auxtrace = perf_event__process_auxtrace,
3434 .auxtrace_error = perf_event__process_auxtrace_error,
3435 .stat = perf_event__process_stat_event,
3436 .stat_round = process_stat_round_event,
3437 .stat_config = process_stat_config_event,
3438 .thread_map = process_thread_map_event,
3439 .cpu_map = process_cpu_map_event,
3440 .ordered_events = true,
3441 .ordering_requires_timestamps = true,
3444 struct perf_data data = {
3445 .mode = PERF_DATA_MODE_READ,
3447 const struct option options[] = {
3448 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3449 "dump raw trace in ASCII"),
3450 OPT_INCR('v', "verbose", &verbose,
3451 "be more verbose (show symbol address, etc)"),
3452 OPT_BOOLEAN('L', "Latency", &latency_format,
3453 "show latency attributes (irqs/preemption disabled, etc)"),
3454 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3455 list_available_scripts),
3456 OPT_CALLBACK('s', "script", NULL, "name",
3457 "script file name (lang:script name, script name, or *)",
3459 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3460 "generate perf-script.xx script in specified language"),
3461 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3462 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3463 "do various checks like samples ordering and lost events"),
3464 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3465 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3466 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3467 "file", "vmlinux pathname"),
3468 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3469 "file", "kallsyms pathname"),
3470 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3471 "When printing symbols do not display call chain"),
3472 OPT_CALLBACK(0, "symfs", NULL, "directory",
3473 "Look for files with symbols relative to this directory",
3474 symbol__config_symfs),
3475 OPT_CALLBACK('F', "fields", NULL, "str",
3476 "comma separated output fields prepend with 'type:'. "
3477 "+field to add and -field to remove."
3478 "Valid types: hw,sw,trace,raw,synth. "
3479 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3480 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3481 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3482 "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc",
3483 parse_output_fields),
3484 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3485 "system-wide collection from all CPUs"),
3486 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3487 "only consider these symbols"),
3488 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3489 "Decode instructions from itrace", parse_insn_trace),
3490 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3491 "Run xed disassembler on output", parse_xed),
3492 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3493 "Decode calls from from itrace", parse_call_trace),
3494 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3495 "Decode calls and returns from itrace", parse_callret_trace),
3496 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3497 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3498 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3499 "Stop display of callgraph at these symbols"),
3500 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3501 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3502 "only display events for these comms"),
3503 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3504 "only consider symbols in these pids"),
3505 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3506 "only consider symbols in these tids"),
3507 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3508 "Set the maximum stack depth when parsing the callchain, "
3509 "anything beyond the specified depth will be ignored. "
3510 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3511 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3512 OPT_BOOLEAN('I', "show-info", &show_full_info,
3513 "display extended information from perf.data file"),
3514 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3515 "Show the path of [kernel.kallsyms]"),
3516 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3517 "Show the fork/comm/exit events"),
3518 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3519 "Show the mmap events"),
3520 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3521 "Show context switch events (if recorded)"),
3522 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3523 "Show namespace events (if recorded)"),
3524 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3525 "Show lost events (if recorded)"),
3526 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3527 "Show round events (if recorded)"),
3528 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3529 "Show bpf related events (if recorded)"),
3530 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3531 "Dump trace output to files named by the monitored events"),
3532 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3533 OPT_INTEGER(0, "max-blocks", &max_blocks,
3534 "Maximum number of code blocks to dump with brstackinsn"),
3535 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3536 "Use 9 decimal places when displaying time"),
3537 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3538 "Instruction Tracing options\n" ITRACE_HELP,
3539 itrace_parse_synth_opts),
3540 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3541 "Show full source file name path for source lines"),
3542 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3543 "Enable symbol demangling"),
3544 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3545 "Enable kernel symbol demangling"),
3546 OPT_STRING(0, "time", &script.time_str, "str",
3547 "Time span of interest (start,stop)"),
3548 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3549 "Show inline function"),
3550 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3551 "guest mount directory under which every guest os"
3552 " instance has a subdir"),
3553 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3554 "file", "file saving guest os vmlinux"),
3555 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3556 "file", "file saving guest os /proc/kallsyms"),
3557 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3558 "file", "file saving guest os /proc/modules"),
3559 OPTS_EVSWITCH(&script.evswitch),
3562 const char * const script_subcommands[] = { "record", "report", NULL };
3563 const char *script_usage[] = {
3564 "perf script [<options>]",
3565 "perf script [<options>] record <script> [<record-options>] <command>",
3566 "perf script [<options>] report <script> [script-args]",
3567 "perf script [<options>] <script> [<record-options>] <command>",
3568 "perf script [<options>] <top-script> [script-args]",
3572 perf_set_singlethreaded();
3576 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3577 PARSE_OPT_STOP_AT_NON_OPTION);
3579 if (symbol_conf.guestmount ||
3580 symbol_conf.default_guest_vmlinux_name ||
3581 symbol_conf.default_guest_kallsyms ||
3582 symbol_conf.default_guest_modules) {
3584 * Enable guest sample processing.
3589 data.path = input_name;
3590 data.force = symbol_conf.force;
3592 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3593 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3594 if (!rec_script_path)
3595 return cmd_record(argc, argv);
3598 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3599 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3600 if (!rep_script_path) {
3602 "Please specify a valid report script"
3603 "(see 'perf script -l' for listing)\n");
3608 if (script.time_str && reltime) {
3609 fprintf(stderr, "Don't combine --reltime with --time\n");
3613 if (itrace_synth_opts.callchain &&
3614 itrace_synth_opts.callchain_sz > scripting_max_stack)
3615 scripting_max_stack = itrace_synth_opts.callchain_sz;
3617 /* make sure PERF_EXEC_PATH is set for scripts */
3618 set_argv_exec_path(get_argv_exec_path());
3620 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3625 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3626 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3628 if (!rec_script_path && !rep_script_path) {
3629 usage_with_options_msg(script_usage, options,
3630 "Couldn't find script `%s'\n\n See perf"
3631 " script -l for available scripts.\n", argv[0]);
3634 if (is_top_script(argv[0])) {
3635 rep_args = argc - 1;
3639 rep_args = has_required_arg(rep_script_path);
3640 rec_args = (argc - 1) - rep_args;
3642 usage_with_options_msg(script_usage, options,
3643 "`%s' script requires options."
3644 "\n\n See perf script -l for available "
3645 "scripts and options.\n", argv[0]);
3649 if (pipe(live_pipe) < 0) {
3650 perror("failed to create pipe");
3656 perror("failed to fork");
3663 dup2(live_pipe[1], 1);
3664 close(live_pipe[0]);
3666 if (is_top_script(argv[0])) {
3668 } else if (!system_wide) {
3669 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3675 __argv = malloc((argc + 6) * sizeof(const char *));
3677 pr_err("malloc failed\n");
3682 __argv[j++] = "/bin/sh";
3683 __argv[j++] = rec_script_path;
3689 for (i = rep_args + 1; i < argc; i++)
3690 __argv[j++] = argv[i];
3693 execvp("/bin/sh", (char **)__argv);
3698 dup2(live_pipe[0], 0);
3699 close(live_pipe[1]);
3701 __argv = malloc((argc + 4) * sizeof(const char *));
3703 pr_err("malloc failed\n");
3709 __argv[j++] = "/bin/sh";
3710 __argv[j++] = rep_script_path;
3711 for (i = 1; i < rep_args + 1; i++)
3712 __argv[j++] = argv[i];
3717 execvp("/bin/sh", (char **)__argv);
3722 if (rec_script_path)
3723 script_path = rec_script_path;
3724 if (rep_script_path)
3725 script_path = rep_script_path;
3730 if (!rec_script_path)
3731 system_wide = false;
3732 else if (!system_wide) {
3733 if (have_cmd(argc - 1, &argv[1]) != 0) {
3739 __argv = malloc((argc + 2) * sizeof(const char *));
3741 pr_err("malloc failed\n");
3746 __argv[j++] = "/bin/sh";
3747 __argv[j++] = script_path;
3750 for (i = 2; i < argc; i++)
3751 __argv[j++] = argv[i];
3754 execvp("/bin/sh", (char **)__argv);
3764 session = perf_session__new(&data, false, &script.tool);
3765 if (IS_ERR(session))
3766 return PTR_ERR(session);
3768 if (header || header_only) {
3769 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3770 perf_session__fprintf_info(session, stdout, show_full_info);
3775 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3777 if (symbol__init(&session->header.env) < 0)
3781 if (data.is_pipe || /* assume pipe_mode indicates native_arch */
3782 !strcmp(uts.machine, session->header.env.arch) ||
3783 (!strcmp(uts.machine, "x86_64") &&
3784 !strcmp(session->header.env.arch, "i386")))
3787 script.session = session;
3788 script__setup_sample_type(&script);
3790 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3791 symbol_conf.graph_function)
3792 itrace_synth_opts.thread_stack = true;
3794 session->itrace_synth_opts = &itrace_synth_opts;
3797 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3800 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3804 symbol_conf.use_callchain = true;
3806 symbol_conf.use_callchain = false;
3808 if (session->tevent.pevent &&
3809 tep_set_function_resolver(session->tevent.pevent,
3810 machine__resolve_kernel_addr,
3811 &session->machines.host) < 0) {
3812 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3817 if (generate_script_lang) {
3818 struct stat perf_stat;
3821 if (output_set_by_user()) {
3823 "custom fields not supported for generated scripts");
3828 input = open(data.path, O_RDONLY); /* input_name */
3831 perror("failed to open file");
3835 err = fstat(input, &perf_stat);
3837 perror("failed to stat file");
3841 if (!perf_stat.st_size) {
3842 fprintf(stderr, "zero-sized file, nothing to do!\n");
3846 scripting_ops = script_spec__lookup(generate_script_lang);
3847 if (!scripting_ops) {
3848 fprintf(stderr, "invalid language specifier");
3853 err = scripting_ops->generate_script(session->tevent.pevent,
3859 err = scripting_ops->start_script(script_name, argc, argv);
3862 pr_debug("perf script started with script %s\n\n", script_name);
3863 script_started = true;
3867 err = perf_session__check_output_opt(session);
3871 if (script.time_str) {
3872 err = perf_time__parse_for_ranges(script.time_str, session,
3873 &script.ptime_range,
3879 itrace_synth_opts__set_time_range(&itrace_synth_opts,
3884 err = evswitch__init(&script.evswitch, session->evlist, stderr);
3888 err = __cmd_script(&script);
3893 if (script.ptime_range) {
3894 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3895 zfree(&script.ptime_range);
3898 perf_evlist__free_stats(session->evlist);
3899 perf_session__delete(session);
3902 cleanup_scripting();