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 bool deltatime;
67 static u64 initial_time;
68 static u64 previous_time;
69 static bool debug_mode;
70 static u64 last_timestamp;
71 static u64 nr_unordered;
72 static bool no_callchain;
73 static bool latency_format;
74 static bool system_wide;
75 static bool print_flags;
76 static const char *cpu_list;
77 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
78 static struct perf_stat_config stat_config;
79 static int max_blocks;
80 static bool native_arch;
82 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
84 enum perf_output_field {
85 PERF_OUTPUT_COMM = 1U << 0,
86 PERF_OUTPUT_TID = 1U << 1,
87 PERF_OUTPUT_PID = 1U << 2,
88 PERF_OUTPUT_TIME = 1U << 3,
89 PERF_OUTPUT_CPU = 1U << 4,
90 PERF_OUTPUT_EVNAME = 1U << 5,
91 PERF_OUTPUT_TRACE = 1U << 6,
92 PERF_OUTPUT_IP = 1U << 7,
93 PERF_OUTPUT_SYM = 1U << 8,
94 PERF_OUTPUT_DSO = 1U << 9,
95 PERF_OUTPUT_ADDR = 1U << 10,
96 PERF_OUTPUT_SYMOFFSET = 1U << 11,
97 PERF_OUTPUT_SRCLINE = 1U << 12,
98 PERF_OUTPUT_PERIOD = 1U << 13,
99 PERF_OUTPUT_IREGS = 1U << 14,
100 PERF_OUTPUT_BRSTACK = 1U << 15,
101 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
102 PERF_OUTPUT_DATA_SRC = 1U << 17,
103 PERF_OUTPUT_WEIGHT = 1U << 18,
104 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
105 PERF_OUTPUT_CALLINDENT = 1U << 20,
106 PERF_OUTPUT_INSN = 1U << 21,
107 PERF_OUTPUT_INSNLEN = 1U << 22,
108 PERF_OUTPUT_BRSTACKINSN = 1U << 23,
109 PERF_OUTPUT_BRSTACKOFF = 1U << 24,
110 PERF_OUTPUT_SYNTH = 1U << 25,
111 PERF_OUTPUT_PHYS_ADDR = 1U << 26,
112 PERF_OUTPUT_UREGS = 1U << 27,
113 PERF_OUTPUT_METRIC = 1U << 28,
114 PERF_OUTPUT_MISC = 1U << 29,
115 PERF_OUTPUT_SRCCODE = 1U << 30,
116 PERF_OUTPUT_IPC = 1U << 31,
119 struct output_option {
121 enum perf_output_field field;
122 } all_output_options[] = {
123 {.str = "comm", .field = PERF_OUTPUT_COMM},
124 {.str = "tid", .field = PERF_OUTPUT_TID},
125 {.str = "pid", .field = PERF_OUTPUT_PID},
126 {.str = "time", .field = PERF_OUTPUT_TIME},
127 {.str = "cpu", .field = PERF_OUTPUT_CPU},
128 {.str = "event", .field = PERF_OUTPUT_EVNAME},
129 {.str = "trace", .field = PERF_OUTPUT_TRACE},
130 {.str = "ip", .field = PERF_OUTPUT_IP},
131 {.str = "sym", .field = PERF_OUTPUT_SYM},
132 {.str = "dso", .field = PERF_OUTPUT_DSO},
133 {.str = "addr", .field = PERF_OUTPUT_ADDR},
134 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
135 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
136 {.str = "period", .field = PERF_OUTPUT_PERIOD},
137 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
138 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
139 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
140 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
141 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
142 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
143 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
144 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
145 {.str = "insn", .field = PERF_OUTPUT_INSN},
146 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
147 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
148 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
149 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
150 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
151 {.str = "metric", .field = PERF_OUTPUT_METRIC},
152 {.str = "misc", .field = PERF_OUTPUT_MISC},
153 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
154 {.str = "ipc", .field = PERF_OUTPUT_IPC},
158 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
162 /* default set to maintain compatibility with current format */
166 unsigned int print_ip_opts;
170 u64 user_unset_fields;
171 } output[OUTPUT_TYPE_MAX] = {
173 [PERF_TYPE_HARDWARE] = {
176 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
177 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
178 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
179 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
180 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
182 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
185 [PERF_TYPE_SOFTWARE] = {
188 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
189 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
190 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
191 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
192 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
193 PERF_OUTPUT_BPF_OUTPUT,
195 .invalid_fields = PERF_OUTPUT_TRACE,
198 [PERF_TYPE_TRACEPOINT] = {
201 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
202 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
203 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
206 [PERF_TYPE_HW_CACHE] = {
209 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
210 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
211 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
212 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
213 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
215 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
221 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
222 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
223 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
224 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
225 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
226 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
227 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR,
229 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
232 [PERF_TYPE_BREAKPOINT] = {
235 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
236 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
237 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
238 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
239 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
241 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
244 [OUTPUT_TYPE_SYNTH] = {
247 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
248 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
249 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
250 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
251 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
253 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
257 struct evsel_script {
261 /* For metric output */
266 static inline struct evsel_script *evsel_script(struct evsel *evsel)
268 return (struct evsel_script *)evsel->priv;
271 static struct evsel_script *perf_evsel_script__new(struct evsel *evsel,
272 struct perf_data *data)
274 struct evsel_script *es = zalloc(sizeof(*es));
277 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
279 es->fp = fopen(es->filename, "w");
281 goto out_free_filename;
286 zfree(&es->filename);
292 static void perf_evsel_script__delete(struct evsel_script *es)
294 zfree(&es->filename);
300 static int perf_evsel_script__fprintf(struct evsel_script *es, FILE *fp)
304 fstat(fileno(es->fp), &st);
305 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
306 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
309 static inline int output_type(unsigned int type)
312 case PERF_TYPE_SYNTH:
313 return OUTPUT_TYPE_SYNTH;
319 static inline unsigned int attr_type(unsigned int type)
322 case OUTPUT_TYPE_SYNTH:
323 return PERF_TYPE_SYNTH;
329 static bool output_set_by_user(void)
332 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
333 if (output[j].user_set)
339 static const char *output_field2str(enum perf_output_field field)
341 int i, imax = ARRAY_SIZE(all_output_options);
342 const char *str = "";
344 for (i = 0; i < imax; ++i) {
345 if (all_output_options[i].field == field) {
346 str = all_output_options[i].str;
353 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
355 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
356 enum perf_output_field field, bool allow_user_set)
358 struct perf_event_attr *attr = &evsel->core.attr;
359 int type = output_type(attr->type);
362 if (attr->sample_type & sample_type)
365 if (output[type].user_set_fields & field) {
368 evname = evsel__name(evsel);
369 pr_err("Samples for '%s' event do not have %s attribute set. "
370 "Cannot print '%s' field.\n",
371 evname, sample_msg, output_field2str(field));
375 /* user did not ask for it explicitly so remove from the default list */
376 output[type].fields &= ~field;
377 evname = evsel__name(evsel);
378 pr_debug("Samples for '%s' event do not have %s attribute set. "
379 "Skipping '%s' field.\n",
380 evname, sample_msg, output_field2str(field));
385 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
386 enum perf_output_field field)
388 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
391 static int perf_evsel__check_attr(struct evsel *evsel, struct perf_session *session)
393 struct perf_event_attr *attr = &evsel->core.attr;
396 if (perf_header__has_feat(&session->header, HEADER_STAT))
399 allow_user_set = perf_header__has_feat(&session->header,
402 if (PRINT_FIELD(TRACE) &&
403 !perf_session__has_traces(session, "record -R"))
406 if (PRINT_FIELD(IP)) {
407 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
411 if (PRINT_FIELD(ADDR) &&
412 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
415 if (PRINT_FIELD(DATA_SRC) &&
416 evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
419 if (PRINT_FIELD(WEIGHT) &&
420 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
423 if (PRINT_FIELD(SYM) &&
424 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
425 pr_err("Display of symbols requested but neither sample IP nor "
426 "sample address\navailable. Hence, no addresses to convert "
430 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
431 pr_err("Display of offsets requested but symbol is not"
435 if (PRINT_FIELD(DSO) &&
436 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
437 pr_err("Display of DSO requested but no address to convert.\n");
440 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
441 pr_err("Display of source line number requested but sample IP is not\n"
442 "selected. Hence, no address to lookup the source line number.\n");
445 if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
446 !(perf_evlist__combined_branch_type(session->evlist) &
447 PERF_SAMPLE_BRANCH_ANY)) {
448 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
449 "Hint: run 'perf record -b ...'\n");
452 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
453 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
456 if (PRINT_FIELD(TIME) &&
457 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
460 if (PRINT_FIELD(CPU) &&
461 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
464 if (PRINT_FIELD(IREGS) &&
465 evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS))
468 if (PRINT_FIELD(UREGS) &&
469 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
472 if (PRINT_FIELD(PHYS_ADDR) &&
473 evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
479 static void set_print_ip_opts(struct perf_event_attr *attr)
481 unsigned int type = output_type(attr->type);
483 output[type].print_ip_opts = 0;
485 output[type].print_ip_opts |= EVSEL__PRINT_IP;
487 if (PRINT_FIELD(SYM))
488 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
490 if (PRINT_FIELD(DSO))
491 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
493 if (PRINT_FIELD(SYMOFFSET))
494 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
496 if (PRINT_FIELD(SRCLINE))
497 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
501 * verify all user requested events exist and the samples
502 * have the expected data
504 static int perf_session__check_output_opt(struct perf_session *session)
509 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
510 evsel = perf_session__find_first_evtype(session, attr_type(j));
513 * even if fields is set to 0 (ie., show nothing) event must
514 * exist if user explicitly includes it on the command line
516 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
517 j != OUTPUT_TYPE_SYNTH) {
518 pr_err("%s events do not exist. "
519 "Remove corresponding -F option to proceed.\n",
524 if (evsel && output[j].fields &&
525 perf_evsel__check_attr(evsel, session))
531 set_print_ip_opts(&evsel->core.attr);
535 bool use_callchain = false;
536 bool not_pipe = false;
538 evlist__for_each_entry(session->evlist, evsel) {
540 if (evsel__has_callchain(evsel)) {
541 use_callchain = true;
545 if (not_pipe && !use_callchain)
546 symbol_conf.use_callchain = false;
550 * set default for tracepoints to print symbols only
551 * if callchains are present
553 if (symbol_conf.use_callchain &&
554 !output[PERF_TYPE_TRACEPOINT].user_set) {
555 j = PERF_TYPE_TRACEPOINT;
557 evlist__for_each_entry(session->evlist, evsel) {
558 if (evsel->core.attr.type != j)
561 if (evsel__has_callchain(evsel)) {
562 output[j].fields |= PERF_OUTPUT_IP;
563 output[j].fields |= PERF_OUTPUT_SYM;
564 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
565 output[j].fields |= PERF_OUTPUT_DSO;
566 set_print_ip_opts(&evsel->core.attr);
576 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
583 if (!regs || !regs->regs)
586 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
588 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
589 u64 val = regs->regs[i++];
590 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
596 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
597 struct perf_event_attr *attr, FILE *fp)
599 return perf_sample__fprintf_regs(&sample->intr_regs,
600 attr->sample_regs_intr, fp);
603 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
604 struct perf_event_attr *attr, FILE *fp)
606 return perf_sample__fprintf_regs(&sample->user_regs,
607 attr->sample_regs_user, fp);
610 static int perf_sample__fprintf_start(struct perf_sample *sample,
611 struct thread *thread,
615 struct perf_event_attr *attr = &evsel->core.attr;
617 unsigned long long nsecs;
620 if (PRINT_FIELD(COMM)) {
622 printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
623 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
624 printed += fprintf(fp, "%s ", thread__comm_str(thread));
626 printed += fprintf(fp, "%16s ", thread__comm_str(thread));
629 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
630 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
631 else if (PRINT_FIELD(PID))
632 printed += fprintf(fp, "%5d ", sample->pid);
633 else if (PRINT_FIELD(TID))
634 printed += fprintf(fp, "%5d ", sample->tid);
636 if (PRINT_FIELD(CPU)) {
638 printed += fprintf(fp, "%3d ", sample->cpu);
640 printed += fprintf(fp, "[%03d] ", sample->cpu);
643 if (PRINT_FIELD(MISC)) {
647 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
650 ret += fprintf(fp, "K");
652 ret += fprintf(fp, "U");
654 ret += fprintf(fp, "H");
655 if (has(GUEST_KERNEL))
656 ret += fprintf(fp, "G");
658 ret += fprintf(fp, "g");
661 case PERF_RECORD_MMAP:
662 case PERF_RECORD_MMAP2:
664 ret += fprintf(fp, "M");
666 case PERF_RECORD_COMM:
668 ret += fprintf(fp, "E");
670 case PERF_RECORD_SWITCH:
671 case PERF_RECORD_SWITCH_CPU_WIDE:
672 if (has(SWITCH_OUT)) {
673 ret += fprintf(fp, "S");
674 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
675 ret += fprintf(fp, "p");
683 ret += fprintf(fp, "%*s", 6 - ret, " ");
687 if (PRINT_FIELD(TIME)) {
688 u64 t = sample->time;
691 initial_time = sample->time;
692 t = sample->time - initial_time;
693 } else if (deltatime) {
695 t = sample->time - previous_time;
699 previous_time = sample->time;
702 secs = nsecs / NSEC_PER_SEC;
703 nsecs -= secs * NSEC_PER_SEC;
705 if (symbol_conf.nanosecs)
706 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
708 char sample_time[32];
709 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
710 printed += fprintf(fp, "%12s: ", sample_time);
718 mispred_str(struct branch_entry *br)
720 if (!(br->flags.mispred || br->flags.predicted))
723 return br->flags.predicted ? 'P' : 'M';
726 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
727 struct thread *thread,
728 struct perf_event_attr *attr, FILE *fp)
730 struct branch_stack *br = sample->branch_stack;
731 struct branch_entry *entries = perf_sample__branch_entries(sample);
732 struct addr_location alf, alt;
739 for (i = 0; i < br->nr; i++) {
740 from = entries[i].from;
743 if (PRINT_FIELD(DSO)) {
744 memset(&alf, 0, sizeof(alf));
745 memset(&alt, 0, sizeof(alt));
746 thread__find_map_fb(thread, sample->cpumode, from, &alf);
747 thread__find_map_fb(thread, sample->cpumode, to, &alt);
750 printed += fprintf(fp, " 0x%"PRIx64, from);
751 if (PRINT_FIELD(DSO)) {
752 printed += fprintf(fp, "(");
753 printed += map__fprintf_dsoname(alf.map, fp);
754 printed += fprintf(fp, ")");
757 printed += fprintf(fp, "/0x%"PRIx64, to);
758 if (PRINT_FIELD(DSO)) {
759 printed += fprintf(fp, "(");
760 printed += map__fprintf_dsoname(alt.map, fp);
761 printed += fprintf(fp, ")");
764 printed += fprintf(fp, "/%c/%c/%c/%d ",
765 mispred_str(entries + i),
766 entries[i].flags.in_tx ? 'X' : '-',
767 entries[i].flags.abort ? 'A' : '-',
768 entries[i].flags.cycles);
774 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
775 struct thread *thread,
776 struct perf_event_attr *attr, FILE *fp)
778 struct branch_stack *br = sample->branch_stack;
779 struct branch_entry *entries = perf_sample__branch_entries(sample);
780 struct addr_location alf, alt;
787 for (i = 0; i < br->nr; i++) {
789 memset(&alf, 0, sizeof(alf));
790 memset(&alt, 0, sizeof(alt));
791 from = entries[i].from;
794 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
795 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
797 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
798 if (PRINT_FIELD(DSO)) {
799 printed += fprintf(fp, "(");
800 printed += map__fprintf_dsoname(alf.map, fp);
801 printed += fprintf(fp, ")");
803 printed += fprintf(fp, "%c", '/');
804 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
805 if (PRINT_FIELD(DSO)) {
806 printed += fprintf(fp, "(");
807 printed += map__fprintf_dsoname(alt.map, fp);
808 printed += fprintf(fp, ")");
810 printed += fprintf(fp, "/%c/%c/%c/%d ",
811 mispred_str(entries + i),
812 entries[i].flags.in_tx ? 'X' : '-',
813 entries[i].flags.abort ? 'A' : '-',
814 entries[i].flags.cycles);
820 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
821 struct thread *thread,
822 struct perf_event_attr *attr, FILE *fp)
824 struct branch_stack *br = sample->branch_stack;
825 struct branch_entry *entries = perf_sample__branch_entries(sample);
826 struct addr_location alf, alt;
833 for (i = 0; i < br->nr; i++) {
835 memset(&alf, 0, sizeof(alf));
836 memset(&alt, 0, sizeof(alt));
837 from = entries[i].from;
840 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
841 !alf.map->dso->adjust_symbols)
842 from = map__map_ip(alf.map, from);
844 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
845 !alt.map->dso->adjust_symbols)
846 to = map__map_ip(alt.map, to);
848 printed += fprintf(fp, " 0x%"PRIx64, from);
849 if (PRINT_FIELD(DSO)) {
850 printed += fprintf(fp, "(");
851 printed += map__fprintf_dsoname(alf.map, fp);
852 printed += fprintf(fp, ")");
854 printed += fprintf(fp, "/0x%"PRIx64, to);
855 if (PRINT_FIELD(DSO)) {
856 printed += fprintf(fp, "(");
857 printed += map__fprintf_dsoname(alt.map, fp);
858 printed += fprintf(fp, ")");
860 printed += fprintf(fp, "/%c/%c/%c/%d ",
861 mispred_str(entries + i),
862 entries[i].flags.in_tx ? 'X' : '-',
863 entries[i].flags.abort ? 'A' : '-',
864 entries[i].flags.cycles);
869 #define MAXBB 16384UL
871 static int grab_bb(u8 *buffer, u64 start, u64 end,
872 struct machine *machine, struct thread *thread,
873 bool *is64bit, u8 *cpumode, bool last)
876 struct addr_location al;
882 kernel = machine__kernel_ip(machine, start);
884 *cpumode = PERF_RECORD_MISC_KERNEL;
886 *cpumode = PERF_RECORD_MISC_USER;
889 * Block overlaps between kernel and user.
890 * This can happen due to ring filtering
891 * On Intel CPUs the entry into the kernel is filtered,
892 * but the exit is not. Let the caller patch it up.
894 if (kernel != machine__kernel_ip(machine, end)) {
895 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
899 memset(&al, 0, sizeof(al));
900 if (end - start > MAXBB - MAXINSN) {
902 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
904 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
908 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
909 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
912 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
913 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
917 /* Load maps to ensure dso->is_64_bit has been updated */
920 offset = al.map->map_ip(al.map, start);
921 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
922 end - start + MAXINSN);
924 *is64bit = al.map->dso->is_64_bit;
926 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
931 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
939 if (!map || !map->dso)
941 srcfile = get_srcline_split(map->dso,
942 map__rip_2objdump(map, addr),
947 /* Avoid redundant printing */
950 !strcmp(state->srcfile, srcfile) &&
951 state->line == line) {
956 srccode = find_sourceline(srcfile, line, &len);
960 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
963 state->srcfile = srcfile;
973 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
975 struct addr_location al;
978 memset(&al, 0, sizeof(al));
979 thread__find_map(thread, cpumode, addr, &al);
982 ret = map__fprintf_srccode(al.map, al.addr, stdout,
983 &thread->srccode_state);
989 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
990 struct perf_insn *x, u8 *inbuf, int len,
991 int insn, FILE *fp, int *total_cycles)
993 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
994 dump_insn(x, ip, inbuf, len, NULL),
995 en->flags.predicted ? " PRED" : "",
996 en->flags.mispred ? " MISPRED" : "",
997 en->flags.in_tx ? " INTX" : "",
998 en->flags.abort ? " ABORT" : "");
999 if (en->flags.cycles) {
1000 *total_cycles += en->flags.cycles;
1001 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1003 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1005 return printed + fprintf(fp, "\n");
1008 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1009 u8 cpumode, int cpu, struct symbol **lastsym,
1010 struct perf_event_attr *attr, FILE *fp)
1012 struct addr_location al;
1013 int off, printed = 0;
1015 memset(&al, 0, sizeof(al));
1017 thread__find_map(thread, cpumode, addr, &al);
1019 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1025 al.sym = map__find_symbol(al.map, al.addr);
1030 if (al.addr < al.sym->end)
1031 off = al.addr - al.sym->start;
1033 off = al.addr - al.map->start - al.sym->start;
1034 printed += fprintf(fp, "\t%s", al.sym->name);
1036 printed += fprintf(fp, "%+d", off);
1037 printed += fprintf(fp, ":");
1038 if (PRINT_FIELD(SRCLINE))
1039 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1040 printed += fprintf(fp, "\n");
1046 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1047 struct thread *thread,
1048 struct perf_event_attr *attr,
1049 struct machine *machine, FILE *fp)
1051 struct branch_stack *br = sample->branch_stack;
1052 struct branch_entry *entries = perf_sample__branch_entries(sample);
1054 int i, insn, len, nr, ilen, printed = 0;
1058 struct symbol *lastsym = NULL;
1059 int total_cycles = 0;
1061 if (!(br && br->nr))
1064 if (max_blocks && nr > max_blocks + 1)
1065 nr = max_blocks + 1;
1068 x.cpu = sample->cpu;
1070 printed += fprintf(fp, "%c", '\n');
1072 /* Handle first from jump, of which we don't know the entry. */
1073 len = grab_bb(buffer, entries[nr-1].from,
1075 machine, thread, &x.is64bit, &x.cpumode, false);
1077 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1078 x.cpumode, x.cpu, &lastsym, attr, fp);
1079 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1080 &x, buffer, len, 0, fp, &total_cycles);
1081 if (PRINT_FIELD(SRCCODE))
1082 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1085 /* Print all blocks */
1086 for (i = nr - 2; i >= 0; i--) {
1087 if (entries[i].from || entries[i].to)
1088 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1091 start = entries[i + 1].to;
1092 end = entries[i].from;
1094 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1095 /* Patch up missing kernel transfers due to ring filters */
1096 if (len == -ENXIO && i > 0) {
1097 end = entries[--i].from;
1098 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1099 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1105 for (off = 0; off < (unsigned)len; off += ilen) {
1106 uint64_t ip = start + off;
1108 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1110 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1112 if (PRINT_FIELD(SRCCODE))
1113 printed += print_srccode(thread, x.cpumode, ip);
1117 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1118 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1121 if (PRINT_FIELD(SRCCODE))
1122 print_srccode(thread, x.cpumode, ip);
1126 if (off != end - start)
1127 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1131 * Hit the branch? In this case we are already done, and the target
1132 * has not been executed yet.
1134 if (entries[0].from == sample->ip)
1136 if (entries[0].flags.abort)
1140 * Print final block upto sample
1142 * Due to pipeline delays the LBRs might be missing a branch
1143 * or two, which can result in very large or negative blocks
1144 * between final branch and sample. When this happens just
1145 * continue walking after the last TO until we hit a branch.
1147 start = entries[0].to;
1150 /* Missing jump. Scan 128 bytes for the next branch */
1153 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1154 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1156 /* Print at least last IP if basic block did not work */
1157 len = grab_bb(buffer, sample->ip, sample->ip,
1158 machine, thread, &x.is64bit, &x.cpumode, false);
1161 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1162 dump_insn(&x, sample->ip, buffer, len, NULL));
1163 if (PRINT_FIELD(SRCCODE))
1164 print_srccode(thread, x.cpumode, sample->ip);
1167 for (off = 0; off <= end - start; off += ilen) {
1169 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1170 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1173 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1175 * Hit a missing branch. Just stop.
1177 printed += fprintf(fp, "\t... not reaching sample ...\n");
1180 if (PRINT_FIELD(SRCCODE))
1181 print_srccode(thread, x.cpumode, start + off);
1187 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1188 struct thread *thread,
1189 struct perf_event_attr *attr, FILE *fp)
1191 struct addr_location al;
1192 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1194 if (!sample_addr_correlates_sym(attr))
1197 thread__resolve(thread, &al, sample);
1199 if (PRINT_FIELD(SYM)) {
1200 printed += fprintf(fp, " ");
1201 if (PRINT_FIELD(SYMOFFSET))
1202 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1204 printed += symbol__fprintf_symname(al.sym, fp);
1207 if (PRINT_FIELD(DSO)) {
1208 printed += fprintf(fp, " (");
1209 printed += map__fprintf_dsoname(al.map, fp);
1210 printed += fprintf(fp, ")");
1216 static const char *resolve_branch_sym(struct perf_sample *sample,
1217 struct evsel *evsel,
1218 struct thread *thread,
1219 struct addr_location *al,
1222 struct addr_location addr_al;
1223 struct perf_event_attr *attr = &evsel->core.attr;
1224 const char *name = NULL;
1226 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1227 if (sample_addr_correlates_sym(attr)) {
1228 thread__resolve(thread, &addr_al, sample);
1230 name = addr_al.sym->name;
1236 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1238 name = al->sym->name;
1245 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1246 struct evsel *evsel,
1247 struct thread *thread,
1248 struct addr_location *al, FILE *fp)
1250 struct perf_event_attr *attr = &evsel->core.attr;
1251 size_t depth = thread_stack__depth(thread, sample->cpu);
1252 const char *name = NULL;
1259 * The 'return' has already been popped off the stack so the depth has
1260 * to be adjusted to match the 'call'.
1262 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1265 name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1267 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1268 dlen += fprintf(fp, "(");
1269 dlen += map__fprintf_dsoname(al->map, fp);
1270 dlen += fprintf(fp, ")\t");
1274 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1276 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1282 * Try to keep the output length from changing frequently so that the
1283 * output lines up more nicely.
1285 if (len > spacing || (len && len < spacing - 52))
1286 spacing = round_up(len + 4, 32);
1289 len += fprintf(fp, "%*s", spacing - len, "");
1294 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1295 struct thread *thread __maybe_unused,
1296 struct machine *machine __maybe_unused)
1300 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1301 struct perf_event_attr *attr,
1302 struct thread *thread,
1303 struct machine *machine, FILE *fp)
1307 if (sample->insn_len == 0 && native_arch)
1308 arch_fetch_insn(sample, thread, machine);
1310 if (PRINT_FIELD(INSNLEN))
1311 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1312 if (PRINT_FIELD(INSN) && sample->insn_len) {
1315 printed += fprintf(fp, " insn:");
1316 for (i = 0; i < sample->insn_len; i++)
1317 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1319 if (PRINT_FIELD(BRSTACKINSN))
1320 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1325 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1326 struct perf_event_attr *attr, FILE *fp)
1330 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1333 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1335 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1336 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1339 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1340 struct evsel *evsel,
1341 struct thread *thread,
1342 struct addr_location *al,
1343 struct machine *machine, FILE *fp)
1345 struct perf_event_attr *attr = &evsel->core.attr;
1346 unsigned int type = output_type(attr->type);
1347 bool print_srcline_last = false;
1350 if (PRINT_FIELD(CALLINDENT))
1351 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1353 /* print branch_from information */
1354 if (PRINT_FIELD(IP)) {
1355 unsigned int print_opts = output[type].print_ip_opts;
1356 struct callchain_cursor *cursor = NULL;
1358 if (symbol_conf.use_callchain && sample->callchain &&
1359 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1360 sample, NULL, NULL, scripting_max_stack) == 0)
1361 cursor = &callchain_cursor;
1363 if (cursor == NULL) {
1364 printed += fprintf(fp, " ");
1365 if (print_opts & EVSEL__PRINT_SRCLINE) {
1366 print_srcline_last = true;
1367 print_opts &= ~EVSEL__PRINT_SRCLINE;
1370 printed += fprintf(fp, "\n");
1372 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1373 symbol_conf.bt_stop_list, fp);
1376 /* print branch_to information */
1377 if (PRINT_FIELD(ADDR) ||
1378 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1379 !output[type].user_set)) {
1380 printed += fprintf(fp, " => ");
1381 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1384 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1386 if (print_srcline_last)
1387 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1389 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1390 printed += fprintf(fp, "\n");
1391 if (PRINT_FIELD(SRCCODE)) {
1392 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1393 &thread->srccode_state);
1396 printed += printf("\n");
1405 } sample_flags[] = {
1406 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1407 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1408 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1409 {PERF_IP_FLAG_BRANCH, "jmp"},
1410 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1411 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1412 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1413 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1414 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1415 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1416 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1417 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1418 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1422 static const char *sample_flags_to_name(u32 flags)
1426 for (i = 0; sample_flags[i].name ; i++) {
1427 if (sample_flags[i].flags == flags)
1428 return sample_flags[i].name;
1434 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1436 const char *chars = PERF_IP_FLAG_CHARS;
1437 const int n = strlen(PERF_IP_FLAG_CHARS);
1438 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1439 const char *name = NULL;
1443 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1445 return fprintf(fp, " %-15s%4s ", name, in_tx ? "(x)" : "");
1447 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1448 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1450 return fprintf(fp, " tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1453 if (flags & PERF_IP_FLAG_TRACE_END) {
1454 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1456 return fprintf(fp, " tr end %-7s%4s ", name, in_tx ? "(x)" : "");
1459 for (i = 0; i < n; i++, flags >>= 1) {
1461 str[pos++] = chars[i];
1463 for (; i < 32; i++, flags >>= 1) {
1469 return fprintf(fp, " %-19s ", str);
1472 struct printer_data {
1478 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1480 void *extra, FILE *fp)
1482 unsigned char ch = (unsigned char)val;
1483 struct printer_data *printer_data = extra;
1487 case BINARY_PRINT_DATA_BEGIN:
1488 printed += fprintf(fp, "\n");
1490 case BINARY_PRINT_LINE_BEGIN:
1491 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1494 case BINARY_PRINT_ADDR:
1495 printed += fprintf(fp, " %04x:", val);
1497 case BINARY_PRINT_NUM_DATA:
1498 printed += fprintf(fp, " %02x", val);
1500 case BINARY_PRINT_NUM_PAD:
1501 printed += fprintf(fp, " ");
1503 case BINARY_PRINT_SEP:
1504 printed += fprintf(fp, " ");
1506 case BINARY_PRINT_CHAR_DATA:
1507 if (printer_data->hit_nul && ch)
1508 printer_data->is_printable = false;
1511 printed += fprintf(fp, "%c", '.');
1513 if (!printer_data->is_printable)
1517 printer_data->hit_nul = true;
1519 printer_data->is_printable = false;
1521 printed += fprintf(fp, "%c", ch);
1524 case BINARY_PRINT_CHAR_PAD:
1525 printed += fprintf(fp, " ");
1527 case BINARY_PRINT_LINE_END:
1528 printed += fprintf(fp, "\n");
1529 printer_data->line_no++;
1531 case BINARY_PRINT_DATA_END:
1539 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1541 unsigned int nr_bytes = sample->raw_size;
1542 struct printer_data printer_data = {0, false, true};
1543 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1544 sample__fprintf_bpf_output, &printer_data, fp);
1546 if (printer_data.is_printable && printer_data.hit_nul)
1547 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1552 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1554 if (len > 0 && len < spacing)
1555 return fprintf(fp, "%*s", spacing - len, "");
1560 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1562 return perf_sample__fprintf_spacing(len, 34, fp);
1565 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1567 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1570 if (perf_sample__bad_synth_size(sample, *data))
1573 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1574 data->ip, le64_to_cpu(data->payload));
1575 return len + perf_sample__fprintf_pt_spacing(len, fp);
1578 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1580 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1583 if (perf_sample__bad_synth_size(sample, *data))
1586 len = fprintf(fp, " hints: %#x extensions: %#x ",
1587 data->hints, data->extensions);
1588 return len + perf_sample__fprintf_pt_spacing(len, fp);
1591 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1593 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1596 if (perf_sample__bad_synth_size(sample, *data))
1599 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1600 data->hw, data->cstate, data->subcstate);
1601 return len + perf_sample__fprintf_pt_spacing(len, fp);
1604 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1606 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1609 if (perf_sample__bad_synth_size(sample, *data))
1612 len = fprintf(fp, " IP: %u ", data->ip);
1613 return len + perf_sample__fprintf_pt_spacing(len, fp);
1616 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1618 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1621 if (perf_sample__bad_synth_size(sample, *data))
1624 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1625 data->deepest_cstate, data->last_cstate,
1627 return len + perf_sample__fprintf_pt_spacing(len, fp);
1630 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1632 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1633 unsigned int percent, freq;
1636 if (perf_sample__bad_synth_size(sample, *data))
1639 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1640 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1641 if (data->max_nonturbo) {
1642 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1643 len += fprintf(fp, "(%3u%%) ", percent);
1645 return len + perf_sample__fprintf_pt_spacing(len, fp);
1648 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1649 struct evsel *evsel, FILE *fp)
1651 switch (evsel->core.attr.config) {
1652 case PERF_SYNTH_INTEL_PTWRITE:
1653 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1654 case PERF_SYNTH_INTEL_MWAIT:
1655 return perf_sample__fprintf_synth_mwait(sample, fp);
1656 case PERF_SYNTH_INTEL_PWRE:
1657 return perf_sample__fprintf_synth_pwre(sample, fp);
1658 case PERF_SYNTH_INTEL_EXSTOP:
1659 return perf_sample__fprintf_synth_exstop(sample, fp);
1660 case PERF_SYNTH_INTEL_PWRX:
1661 return perf_sample__fprintf_synth_pwrx(sample, fp);
1662 case PERF_SYNTH_INTEL_CBR:
1663 return perf_sample__fprintf_synth_cbr(sample, fp);
1671 struct perf_script {
1672 struct perf_tool tool;
1673 struct perf_session *session;
1674 bool show_task_events;
1675 bool show_mmap_events;
1676 bool show_switch_events;
1677 bool show_namespace_events;
1678 bool show_lost_events;
1679 bool show_round_events;
1680 bool show_bpf_events;
1681 bool show_cgroup_events;
1683 bool per_event_dump;
1685 struct evswitch evswitch;
1686 struct perf_cpu_map *cpus;
1687 struct perf_thread_map *threads;
1689 const char *time_str;
1690 struct perf_time_interval *ptime_range;
1695 static int perf_evlist__max_name_len(struct evlist *evlist)
1697 struct evsel *evsel;
1700 evlist__for_each_entry(evlist, evsel) {
1701 int len = strlen(evsel__name(evsel));
1703 max = MAX(len, max);
1709 static int data_src__fprintf(u64 data_src, FILE *fp)
1711 struct mem_info mi = { .data_src.val = data_src };
1717 perf_script__meminfo_scnprintf(decode, 100, &mi);
1719 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1723 return fprintf(fp, "%-*s", maxlen, out);
1727 struct perf_sample *sample;
1728 struct thread *thread;
1729 struct evsel *evsel;
1733 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1734 void *ctx, const char *color,
1736 const char *unit, double val)
1738 struct metric_ctx *mctx = ctx;
1742 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1743 PERF_RECORD_SAMPLE, mctx->fp);
1744 fputs("\tmetric: ", mctx->fp);
1746 color_fprintf(mctx->fp, color, fmt, val);
1749 fprintf(mctx->fp, " %s\n", unit);
1752 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1755 struct metric_ctx *mctx = ctx;
1757 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1758 PERF_RECORD_SAMPLE, mctx->fp);
1759 fputs("\tmetric: ", mctx->fp);
1762 static void perf_sample__fprint_metric(struct perf_script *script,
1763 struct thread *thread,
1764 struct evsel *evsel,
1765 struct perf_sample *sample,
1768 struct perf_stat_output_ctx ctx = {
1769 .print_metric = script_print_metric,
1770 .new_line = script_new_line,
1771 .ctx = &(struct metric_ctx) {
1777 .force_header = false,
1783 perf_evlist__alloc_stats(script->session->evlist, false);
1784 if (evsel_script(evsel->leader)->gnum++ == 0)
1785 perf_stat__reset_shadow_stats();
1786 val = sample->period * evsel->scale;
1787 perf_stat__update_shadow_stats(evsel,
1791 evsel_script(evsel)->val = val;
1792 if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1793 for_each_group_member (ev2, evsel->leader) {
1794 perf_stat__print_shadow_stats(&stat_config, ev2,
1795 evsel_script(ev2)->val,
1801 evsel_script(evsel->leader)->gnum = 0;
1805 static bool show_event(struct perf_sample *sample,
1806 struct evsel *evsel,
1807 struct thread *thread,
1808 struct addr_location *al)
1810 int depth = thread_stack__depth(thread, sample->cpu);
1812 if (!symbol_conf.graph_function)
1815 if (thread->filter) {
1816 if (depth <= thread->filter_entry_depth) {
1817 thread->filter = false;
1822 const char *s = symbol_conf.graph_function;
1824 const char *name = resolve_branch_sym(sample, evsel, thread, al,
1830 nlen = strlen(name);
1832 unsigned len = strcspn(s, ",");
1833 if (nlen == len && !strncmp(name, s, len)) {
1834 thread->filter = true;
1835 thread->filter_entry_depth = depth;
1846 static void process_event(struct perf_script *script,
1847 struct perf_sample *sample, struct evsel *evsel,
1848 struct addr_location *al,
1849 struct machine *machine)
1851 struct thread *thread = al->thread;
1852 struct perf_event_attr *attr = &evsel->core.attr;
1853 unsigned int type = output_type(attr->type);
1854 struct evsel_script *es = evsel->priv;
1857 if (output[type].fields == 0)
1860 if (!show_event(sample, evsel, thread, al))
1863 if (evswitch__discard(&script->evswitch, evsel))
1868 perf_sample__fprintf_start(sample, thread, evsel,
1869 PERF_RECORD_SAMPLE, fp);
1871 if (PRINT_FIELD(PERIOD))
1872 fprintf(fp, "%10" PRIu64 " ", sample->period);
1874 if (PRINT_FIELD(EVNAME)) {
1875 const char *evname = evsel__name(evsel);
1877 if (!script->name_width)
1878 script->name_width = perf_evlist__max_name_len(script->session->evlist);
1880 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1884 perf_sample__fprintf_flags(sample->flags, fp);
1886 if (is_bts_event(attr)) {
1887 perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1891 if (PRINT_FIELD(TRACE) && sample->raw_data) {
1892 event_format__fprintf(evsel->tp_format, sample->cpu,
1893 sample->raw_data, sample->raw_size, fp);
1896 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1897 perf_sample__fprintf_synth(sample, evsel, fp);
1899 if (PRINT_FIELD(ADDR))
1900 perf_sample__fprintf_addr(sample, thread, attr, fp);
1902 if (PRINT_FIELD(DATA_SRC))
1903 data_src__fprintf(sample->data_src, fp);
1905 if (PRINT_FIELD(WEIGHT))
1906 fprintf(fp, "%16" PRIu64, sample->weight);
1908 if (PRINT_FIELD(IP)) {
1909 struct callchain_cursor *cursor = NULL;
1911 if (script->stitch_lbr)
1912 al->thread->lbr_stitch_enable = true;
1914 if (symbol_conf.use_callchain && sample->callchain &&
1915 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1916 sample, NULL, NULL, scripting_max_stack) == 0)
1917 cursor = &callchain_cursor;
1919 fputc(cursor ? '\n' : ' ', fp);
1920 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
1921 symbol_conf.bt_stop_list, fp);
1924 if (PRINT_FIELD(IREGS))
1925 perf_sample__fprintf_iregs(sample, attr, fp);
1927 if (PRINT_FIELD(UREGS))
1928 perf_sample__fprintf_uregs(sample, attr, fp);
1930 if (PRINT_FIELD(BRSTACK))
1931 perf_sample__fprintf_brstack(sample, thread, attr, fp);
1932 else if (PRINT_FIELD(BRSTACKSYM))
1933 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1934 else if (PRINT_FIELD(BRSTACKOFF))
1935 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
1937 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1938 perf_sample__fprintf_bpf_output(sample, fp);
1939 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1941 if (PRINT_FIELD(PHYS_ADDR))
1942 fprintf(fp, "%16" PRIx64, sample->phys_addr);
1944 perf_sample__fprintf_ipc(sample, attr, fp);
1948 if (PRINT_FIELD(SRCCODE)) {
1949 if (map__fprintf_srccode(al->map, al->addr, stdout,
1950 &thread->srccode_state))
1954 if (PRINT_FIELD(METRIC))
1955 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
1961 static struct scripting_ops *scripting_ops;
1963 static void __process_stat(struct evsel *counter, u64 tstamp)
1965 int nthreads = perf_thread_map__nr(counter->core.threads);
1966 int ncpus = evsel__nr_cpus(counter);
1968 static int header_printed;
1970 if (counter->core.system_wide)
1973 if (!header_printed) {
1974 printf("%3s %8s %15s %15s %15s %15s %s\n",
1975 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
1979 for (thread = 0; thread < nthreads; thread++) {
1980 for (cpu = 0; cpu < ncpus; cpu++) {
1981 struct perf_counts_values *counts;
1983 counts = perf_counts(counter->counts, cpu, thread);
1985 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
1986 counter->core.cpus->map[cpu],
1987 perf_thread_map__pid(counter->core.threads, thread),
1992 evsel__name(counter));
1997 static void process_stat(struct evsel *counter, u64 tstamp)
1999 if (scripting_ops && scripting_ops->process_stat)
2000 scripting_ops->process_stat(&stat_config, counter, tstamp);
2002 __process_stat(counter, tstamp);
2005 static void process_stat_interval(u64 tstamp)
2007 if (scripting_ops && scripting_ops->process_stat_interval)
2008 scripting_ops->process_stat_interval(tstamp);
2011 static void setup_scripting(void)
2013 setup_perl_scripting();
2014 setup_python_scripting();
2017 static int flush_scripting(void)
2019 return scripting_ops ? scripting_ops->flush_script() : 0;
2022 static int cleanup_scripting(void)
2024 pr_debug("\nperf script stopped\n");
2026 return scripting_ops ? scripting_ops->stop_script() : 0;
2029 static bool filter_cpu(struct perf_sample *sample)
2031 if (cpu_list && sample->cpu != (u32)-1)
2032 return !test_bit(sample->cpu, cpu_bitmap);
2036 static int process_sample_event(struct perf_tool *tool,
2037 union perf_event *event,
2038 struct perf_sample *sample,
2039 struct evsel *evsel,
2040 struct machine *machine)
2042 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2043 struct addr_location al;
2045 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2051 if (sample->time < last_timestamp) {
2052 pr_err("Samples misordered, previous: %" PRIu64
2053 " this: %" PRIu64 "\n", last_timestamp,
2057 last_timestamp = sample->time;
2061 if (machine__resolve(machine, &al, sample) < 0) {
2062 pr_err("problem processing %d event, skipping it.\n",
2063 event->header.type);
2070 if (filter_cpu(sample))
2074 scripting_ops->process_event(event, sample, evsel, &al);
2076 process_event(scr, sample, evsel, &al, machine);
2079 addr_location__put(&al);
2083 static int process_attr(struct perf_tool *tool, union perf_event *event,
2084 struct evlist **pevlist)
2086 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2087 struct evlist *evlist;
2088 struct evsel *evsel, *pos;
2091 static struct evsel_script *es;
2093 err = perf_event__process_attr(tool, event, pevlist);
2098 evsel = evlist__last(*pevlist);
2101 if (scr->per_event_dump) {
2102 evsel->priv = perf_evsel_script__new(evsel,
2103 scr->session->data);
2105 es = zalloc(sizeof(*es));
2113 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2114 evsel->core.attr.type != PERF_TYPE_SYNTH)
2117 evlist__for_each_entry(evlist, pos) {
2118 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2122 if (evsel->core.attr.sample_type) {
2123 err = perf_evsel__check_attr(evsel, scr->session);
2129 * Check if we need to enable callchains based
2130 * on events sample_type.
2132 sample_type = perf_evlist__combined_sample_type(evlist);
2133 callchain_param_setup(sample_type);
2135 /* Enable fields for callchain entries */
2136 if (symbol_conf.use_callchain &&
2137 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2138 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2139 (sample_type & PERF_SAMPLE_REGS_USER &&
2140 sample_type & PERF_SAMPLE_STACK_USER))) {
2141 int type = output_type(evsel->core.attr.type);
2143 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2144 output[type].fields |= PERF_OUTPUT_IP;
2145 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2146 output[type].fields |= PERF_OUTPUT_SYM;
2148 set_print_ip_opts(&evsel->core.attr);
2152 static int print_event_with_time(struct perf_tool *tool,
2153 union perf_event *event,
2154 struct perf_sample *sample,
2155 struct machine *machine,
2156 pid_t pid, pid_t tid, u64 timestamp)
2158 struct perf_script *script = container_of(tool, struct perf_script, tool);
2159 struct perf_session *session = script->session;
2160 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2161 struct thread *thread = NULL;
2163 if (evsel && !evsel->core.attr.sample_id_all) {
2165 sample->time = timestamp;
2170 if (filter_cpu(sample))
2174 thread = machine__findnew_thread(machine, pid, tid);
2176 if (thread && evsel) {
2177 perf_sample__fprintf_start(sample, thread, evsel,
2178 event->header.type, stdout);
2181 perf_event__fprintf(event, stdout);
2183 thread__put(thread);
2188 static int print_event(struct perf_tool *tool, union perf_event *event,
2189 struct perf_sample *sample, struct machine *machine,
2190 pid_t pid, pid_t tid)
2192 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2195 static int process_comm_event(struct perf_tool *tool,
2196 union perf_event *event,
2197 struct perf_sample *sample,
2198 struct machine *machine)
2200 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2203 return print_event(tool, event, sample, machine, event->comm.pid,
2207 static int process_namespaces_event(struct perf_tool *tool,
2208 union perf_event *event,
2209 struct perf_sample *sample,
2210 struct machine *machine)
2212 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2215 return print_event(tool, event, sample, machine, event->namespaces.pid,
2216 event->namespaces.tid);
2219 static int process_cgroup_event(struct perf_tool *tool,
2220 union perf_event *event,
2221 struct perf_sample *sample,
2222 struct machine *machine)
2224 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2227 return print_event(tool, event, sample, machine, sample->pid,
2231 static int process_fork_event(struct perf_tool *tool,
2232 union perf_event *event,
2233 struct perf_sample *sample,
2234 struct machine *machine)
2236 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2239 return print_event_with_time(tool, event, sample, machine,
2240 event->fork.pid, event->fork.tid,
2243 static int process_exit_event(struct perf_tool *tool,
2244 union perf_event *event,
2245 struct perf_sample *sample,
2246 struct machine *machine)
2248 /* Print before 'exit' deletes anything */
2249 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2250 event->fork.tid, event->fork.time))
2253 return perf_event__process_exit(tool, event, sample, machine);
2256 static int process_mmap_event(struct perf_tool *tool,
2257 union perf_event *event,
2258 struct perf_sample *sample,
2259 struct machine *machine)
2261 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2264 return print_event(tool, event, sample, machine, event->mmap.pid,
2268 static int process_mmap2_event(struct perf_tool *tool,
2269 union perf_event *event,
2270 struct perf_sample *sample,
2271 struct machine *machine)
2273 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2276 return print_event(tool, event, sample, machine, event->mmap2.pid,
2280 static int process_switch_event(struct perf_tool *tool,
2281 union perf_event *event,
2282 struct perf_sample *sample,
2283 struct machine *machine)
2285 struct perf_script *script = container_of(tool, struct perf_script, tool);
2287 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2290 if (scripting_ops && scripting_ops->process_switch)
2291 scripting_ops->process_switch(event, sample, machine);
2293 if (!script->show_switch_events)
2296 return print_event(tool, event, sample, machine, sample->pid,
2301 process_lost_event(struct perf_tool *tool,
2302 union perf_event *event,
2303 struct perf_sample *sample,
2304 struct machine *machine)
2306 return print_event(tool, event, sample, machine, sample->pid,
2311 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2312 union perf_event *event,
2313 struct ordered_events *oe __maybe_unused)
2316 perf_event__fprintf(event, stdout);
2321 process_bpf_events(struct perf_tool *tool __maybe_unused,
2322 union perf_event *event,
2323 struct perf_sample *sample,
2324 struct machine *machine)
2326 if (machine__process_ksymbol(machine, event, sample) < 0)
2329 return print_event(tool, event, sample, machine, sample->pid,
2333 static void sig_handler(int sig __maybe_unused)
2338 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2340 struct evlist *evlist = script->session->evlist;
2341 struct evsel *evsel;
2343 evlist__for_each_entry(evlist, evsel) {
2346 perf_evsel_script__delete(evsel->priv);
2351 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2353 struct evsel *evsel;
2355 evlist__for_each_entry(script->session->evlist, evsel) {
2357 * Already setup? I.e. we may be called twice in cases like
2358 * Intel PT, one for the intel_pt// and dummy events, then
2359 * for the evsels syntheized from the auxtrace info.
2361 * Ses perf_script__process_auxtrace_info.
2363 if (evsel->priv != NULL)
2366 evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2367 if (evsel->priv == NULL)
2368 goto out_err_fclose;
2374 perf_script__fclose_per_event_dump(script);
2378 static int perf_script__setup_per_event_dump(struct perf_script *script)
2380 struct evsel *evsel;
2381 static struct evsel_script es_stdout;
2383 if (script->per_event_dump)
2384 return perf_script__fopen_per_event_dump(script);
2386 es_stdout.fp = stdout;
2388 evlist__for_each_entry(script->session->evlist, evsel)
2389 evsel->priv = &es_stdout;
2394 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2396 struct evsel *evsel;
2398 evlist__for_each_entry(script->session->evlist, evsel) {
2399 struct evsel_script *es = evsel->priv;
2401 perf_evsel_script__fprintf(es, stdout);
2402 perf_evsel_script__delete(es);
2407 static int __cmd_script(struct perf_script *script)
2411 signal(SIGINT, sig_handler);
2413 perf_stat__init_shadow_stats();
2415 /* override event processing functions */
2416 if (script->show_task_events) {
2417 script->tool.comm = process_comm_event;
2418 script->tool.fork = process_fork_event;
2419 script->tool.exit = process_exit_event;
2421 if (script->show_mmap_events) {
2422 script->tool.mmap = process_mmap_event;
2423 script->tool.mmap2 = process_mmap2_event;
2425 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2426 script->tool.context_switch = process_switch_event;
2427 if (script->show_namespace_events)
2428 script->tool.namespaces = process_namespaces_event;
2429 if (script->show_cgroup_events)
2430 script->tool.cgroup = process_cgroup_event;
2431 if (script->show_lost_events)
2432 script->tool.lost = process_lost_event;
2433 if (script->show_round_events) {
2434 script->tool.ordered_events = false;
2435 script->tool.finished_round = process_finished_round_event;
2437 if (script->show_bpf_events) {
2438 script->tool.ksymbol = process_bpf_events;
2439 script->tool.bpf = process_bpf_events;
2442 if (perf_script__setup_per_event_dump(script)) {
2443 pr_err("Couldn't create the per event dump files\n");
2447 ret = perf_session__process_events(script->session);
2449 if (script->per_event_dump)
2450 perf_script__exit_per_event_dump_stats(script);
2453 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2458 struct script_spec {
2459 struct list_head node;
2460 struct scripting_ops *ops;
2464 static LIST_HEAD(script_specs);
2466 static struct script_spec *script_spec__new(const char *spec,
2467 struct scripting_ops *ops)
2469 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2472 strcpy(s->spec, spec);
2479 static void script_spec__add(struct script_spec *s)
2481 list_add_tail(&s->node, &script_specs);
2484 static struct script_spec *script_spec__find(const char *spec)
2486 struct script_spec *s;
2488 list_for_each_entry(s, &script_specs, node)
2489 if (strcasecmp(s->spec, spec) == 0)
2494 int script_spec_register(const char *spec, struct scripting_ops *ops)
2496 struct script_spec *s;
2498 s = script_spec__find(spec);
2502 s = script_spec__new(spec, ops);
2506 script_spec__add(s);
2511 static struct scripting_ops *script_spec__lookup(const char *spec)
2513 struct script_spec *s = script_spec__find(spec);
2520 static void list_available_languages(void)
2522 struct script_spec *s;
2524 fprintf(stderr, "\n");
2525 fprintf(stderr, "Scripting language extensions (used in "
2526 "perf script -s [spec:]script.[spec]):\n\n");
2528 list_for_each_entry(s, &script_specs, node)
2529 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2531 fprintf(stderr, "\n");
2534 static int parse_scriptname(const struct option *opt __maybe_unused,
2535 const char *str, int unset __maybe_unused)
2537 char spec[PATH_MAX];
2538 const char *script, *ext;
2541 if (strcmp(str, "lang") == 0) {
2542 list_available_languages();
2546 script = strchr(str, ':');
2549 if (len >= PATH_MAX) {
2550 fprintf(stderr, "invalid language specifier");
2553 strncpy(spec, str, len);
2555 scripting_ops = script_spec__lookup(spec);
2556 if (!scripting_ops) {
2557 fprintf(stderr, "invalid language specifier");
2563 ext = strrchr(script, '.');
2565 fprintf(stderr, "invalid script extension");
2568 scripting_ops = script_spec__lookup(++ext);
2569 if (!scripting_ops) {
2570 fprintf(stderr, "invalid script extension");
2575 script_name = strdup(script);
2580 static int parse_output_fields(const struct option *opt __maybe_unused,
2581 const char *arg, int unset __maybe_unused)
2583 char *tok, *strtok_saveptr = NULL;
2584 int i, imax = ARRAY_SIZE(all_output_options);
2587 char *str = strdup(arg);
2589 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2594 /* first word can state for which event type the user is specifying
2595 * the fields. If no type exists, the specified fields apply to all
2596 * event types found in the file minus the invalid fields for a type.
2598 tok = strchr(str, ':');
2602 if (!strcmp(str, "hw"))
2603 type = PERF_TYPE_HARDWARE;
2604 else if (!strcmp(str, "sw"))
2605 type = PERF_TYPE_SOFTWARE;
2606 else if (!strcmp(str, "trace"))
2607 type = PERF_TYPE_TRACEPOINT;
2608 else if (!strcmp(str, "raw"))
2609 type = PERF_TYPE_RAW;
2610 else if (!strcmp(str, "break"))
2611 type = PERF_TYPE_BREAKPOINT;
2612 else if (!strcmp(str, "synth"))
2613 type = OUTPUT_TYPE_SYNTH;
2615 fprintf(stderr, "Invalid event type in field string.\n");
2620 if (output[type].user_set)
2621 pr_warning("Overriding previous field request for %s events.\n",
2624 /* Don't override defaults for +- */
2625 if (strchr(tok, '+') || strchr(tok, '-'))
2628 output[type].fields = 0;
2629 output[type].user_set = true;
2630 output[type].wildcard_set = false;
2634 if (strlen(str) == 0) {
2636 "Cannot set fields to 'none' for all event types.\n");
2641 /* Don't override defaults for +- */
2642 if (strchr(str, '+') || strchr(str, '-'))
2645 if (output_set_by_user())
2646 pr_warning("Overriding previous field request for all events.\n");
2648 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2649 output[j].fields = 0;
2650 output[j].user_set = true;
2651 output[j].wildcard_set = true;
2656 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2662 } else if (*tok == '-') {
2668 if (change != SET && change != DEFAULT)
2673 for (i = 0; i < imax; ++i) {
2674 if (strcmp(tok, all_output_options[i].str) == 0)
2677 if (i == imax && strcmp(tok, "flags") == 0) {
2678 print_flags = change == REMOVE ? false : true;
2682 fprintf(stderr, "Invalid field requested.\n");
2688 /* add user option to all events types for
2691 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2692 if (output[j].invalid_fields & all_output_options[i].field) {
2693 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2694 all_output_options[i].str, event_type(j));
2696 if (change == REMOVE) {
2697 output[j].fields &= ~all_output_options[i].field;
2698 output[j].user_set_fields &= ~all_output_options[i].field;
2699 output[j].user_unset_fields |= all_output_options[i].field;
2701 output[j].fields |= all_output_options[i].field;
2702 output[j].user_set_fields |= all_output_options[i].field;
2703 output[j].user_unset_fields &= ~all_output_options[i].field;
2705 output[j].user_set = true;
2706 output[j].wildcard_set = true;
2710 if (output[type].invalid_fields & all_output_options[i].field) {
2711 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2712 all_output_options[i].str, event_type(type));
2717 if (change == REMOVE)
2718 output[type].fields &= ~all_output_options[i].field;
2720 output[type].fields |= all_output_options[i].field;
2721 output[type].user_set = true;
2722 output[type].wildcard_set = true;
2727 if (output[type].fields == 0) {
2728 pr_debug("No fields requested for %s type. "
2729 "Events will not be displayed.\n", event_type(type));
2735 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2742 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2743 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2744 if ((lang_dirent->d_type == DT_DIR || \
2745 (lang_dirent->d_type == DT_UNKNOWN && \
2746 is_directory(scripts_path, lang_dirent))) && \
2747 (strcmp(lang_dirent->d_name, ".")) && \
2748 (strcmp(lang_dirent->d_name, "..")))
2750 #define for_each_script(lang_path, lang_dir, script_dirent) \
2751 while ((script_dirent = readdir(lang_dir)) != NULL) \
2752 if (script_dirent->d_type != DT_DIR && \
2753 (script_dirent->d_type != DT_UNKNOWN || \
2754 !is_directory(lang_path, script_dirent)))
2757 #define RECORD_SUFFIX "-record"
2758 #define REPORT_SUFFIX "-report"
2760 struct script_desc {
2761 struct list_head node;
2767 static LIST_HEAD(script_descs);
2769 static struct script_desc *script_desc__new(const char *name)
2771 struct script_desc *s = zalloc(sizeof(*s));
2773 if (s != NULL && name)
2774 s->name = strdup(name);
2779 static void script_desc__delete(struct script_desc *s)
2782 zfree(&s->half_liner);
2787 static void script_desc__add(struct script_desc *s)
2789 list_add_tail(&s->node, &script_descs);
2792 static struct script_desc *script_desc__find(const char *name)
2794 struct script_desc *s;
2796 list_for_each_entry(s, &script_descs, node)
2797 if (strcasecmp(s->name, name) == 0)
2802 static struct script_desc *script_desc__findnew(const char *name)
2804 struct script_desc *s = script_desc__find(name);
2809 s = script_desc__new(name);
2813 script_desc__add(s);
2818 static const char *ends_with(const char *str, const char *suffix)
2820 size_t suffix_len = strlen(suffix);
2821 const char *p = str;
2823 if (strlen(str) > suffix_len) {
2824 p = str + strlen(str) - suffix_len;
2825 if (!strncmp(p, suffix, suffix_len))
2832 static int read_script_info(struct script_desc *desc, const char *filename)
2834 char line[BUFSIZ], *p;
2837 fp = fopen(filename, "r");
2841 while (fgets(line, sizeof(line), fp)) {
2842 p = skip_spaces(line);
2848 if (strlen(p) && *p == '!')
2852 if (strlen(p) && p[strlen(p) - 1] == '\n')
2853 p[strlen(p) - 1] = '\0';
2855 if (!strncmp(p, "description:", strlen("description:"))) {
2856 p += strlen("description:");
2857 desc->half_liner = strdup(skip_spaces(p));
2861 if (!strncmp(p, "args:", strlen("args:"))) {
2862 p += strlen("args:");
2863 desc->args = strdup(skip_spaces(p));
2873 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2875 char *script_root, *str;
2877 script_root = strdup(script_dirent->d_name);
2881 str = (char *)ends_with(script_root, suffix);
2891 static int list_available_scripts(const struct option *opt __maybe_unused,
2892 const char *s __maybe_unused,
2893 int unset __maybe_unused)
2895 struct dirent *script_dirent, *lang_dirent;
2896 char scripts_path[MAXPATHLEN];
2897 DIR *scripts_dir, *lang_dir;
2898 char script_path[MAXPATHLEN];
2899 char lang_path[MAXPATHLEN];
2900 struct script_desc *desc;
2901 char first_half[BUFSIZ];
2904 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2906 scripts_dir = opendir(scripts_path);
2909 "open(%s) failed.\n"
2910 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2915 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2916 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2917 lang_dirent->d_name);
2918 lang_dir = opendir(lang_path);
2922 for_each_script(lang_path, lang_dir, script_dirent) {
2923 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
2925 desc = script_desc__findnew(script_root);
2926 scnprintf(script_path, MAXPATHLEN, "%s/%s",
2927 lang_path, script_dirent->d_name);
2928 read_script_info(desc, script_path);
2934 fprintf(stdout, "List of available trace scripts:\n");
2935 list_for_each_entry(desc, &script_descs, node) {
2936 sprintf(first_half, "%s %s", desc->name,
2937 desc->args ? desc->args : "");
2938 fprintf(stdout, " %-36s %s\n", first_half,
2939 desc->half_liner ? desc->half_liner : "");
2946 * Some scripts specify the required events in their "xxx-record" file,
2947 * this function will check if the events in perf.data match those
2948 * mentioned in the "xxx-record".
2950 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
2951 * which is covered well now. And new parsing code should be added to
2952 * cover the future complexing formats like event groups etc.
2954 static int check_ev_match(char *dir_name, char *scriptname,
2955 struct perf_session *session)
2957 char filename[MAXPATHLEN], evname[128];
2958 char line[BUFSIZ], *p;
2963 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
2965 fp = fopen(filename, "r");
2969 while (fgets(line, sizeof(line), fp)) {
2970 p = skip_spaces(line);
2975 p = strstr(p, "-e");
2981 len = strcspn(p, " \t");
2985 snprintf(evname, len + 1, "%s", p);
2988 evlist__for_each_entry(session->evlist, pos) {
2989 if (!strcmp(evsel__name(pos), evname)) {
3007 * Return -1 if none is found, otherwise the actual scripts number.
3009 * Currently the only user of this function is the script browser, which
3010 * will list all statically runnable scripts, select one, execute it and
3011 * show the output in a perf browser.
3013 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3016 struct dirent *script_dirent, *lang_dirent;
3017 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3018 DIR *scripts_dir, *lang_dir;
3019 struct perf_session *session;
3020 struct perf_data data = {
3022 .mode = PERF_DATA_MODE_READ,
3027 session = perf_session__new(&data, false, NULL);
3028 if (IS_ERR(session))
3029 return PTR_ERR(session);
3031 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3033 scripts_dir = opendir(scripts_path);
3035 perf_session__delete(session);
3039 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3040 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3041 lang_dirent->d_name);
3042 #ifndef HAVE_LIBPERL_SUPPORT
3043 if (strstr(lang_path, "perl"))
3046 #ifndef HAVE_LIBPYTHON_SUPPORT
3047 if (strstr(lang_path, "python"))
3051 lang_dir = opendir(lang_path);
3055 for_each_script(lang_path, lang_dir, script_dirent) {
3056 /* Skip those real time scripts: xxxtop.p[yl] */
3057 if (strstr(script_dirent->d_name, "top."))
3061 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3063 script_dirent->d_name);
3064 temp = strchr(script_dirent->d_name, '.');
3065 snprintf(scripts_array[i],
3066 (temp - script_dirent->d_name) + 1,
3067 "%s", script_dirent->d_name);
3069 if (check_ev_match(lang_path,
3070 scripts_array[i], session))
3078 closedir(scripts_dir);
3079 perf_session__delete(session);
3083 static char *get_script_path(const char *script_root, const char *suffix)
3085 struct dirent *script_dirent, *lang_dirent;
3086 char scripts_path[MAXPATHLEN];
3087 char script_path[MAXPATHLEN];
3088 DIR *scripts_dir, *lang_dir;
3089 char lang_path[MAXPATHLEN];
3090 char *__script_root;
3092 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3094 scripts_dir = opendir(scripts_path);
3098 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3099 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3100 lang_dirent->d_name);
3101 lang_dir = opendir(lang_path);
3105 for_each_script(lang_path, lang_dir, script_dirent) {
3106 __script_root = get_script_root(script_dirent, suffix);
3107 if (__script_root && !strcmp(script_root, __script_root)) {
3108 free(__script_root);
3109 closedir(scripts_dir);
3110 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3111 lang_path, script_dirent->d_name);
3113 return strdup(script_path);
3115 free(__script_root);
3119 closedir(scripts_dir);
3124 static bool is_top_script(const char *script_path)
3126 return ends_with(script_path, "top") == NULL ? false : true;
3129 static int has_required_arg(char *script_path)
3131 struct script_desc *desc;
3135 desc = script_desc__new(NULL);
3137 if (read_script_info(desc, script_path))
3143 for (p = desc->args; *p; p++)
3147 script_desc__delete(desc);
3152 static int have_cmd(int argc, const char **argv)
3154 char **__argv = malloc(sizeof(const char *) * argc);
3157 pr_err("malloc failed\n");
3161 memcpy(__argv, argv, sizeof(const char *) * argc);
3162 argc = parse_options(argc, (const char **)__argv, record_options,
3163 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3166 system_wide = (argc == 0);
3171 static void script__setup_sample_type(struct perf_script *script)
3173 struct perf_session *session = script->session;
3174 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
3176 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3177 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3178 (sample_type & PERF_SAMPLE_STACK_USER)) {
3179 callchain_param.record_mode = CALLCHAIN_DWARF;
3180 dwarf_callchain_users = true;
3181 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3182 callchain_param.record_mode = CALLCHAIN_LBR;
3184 callchain_param.record_mode = CALLCHAIN_FP;
3187 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3188 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3189 "Please apply --call-graph lbr when recording.\n");
3190 script->stitch_lbr = false;
3194 static int process_stat_round_event(struct perf_session *session,
3195 union perf_event *event)
3197 struct perf_record_stat_round *round = &event->stat_round;
3198 struct evsel *counter;
3200 evlist__for_each_entry(session->evlist, counter) {
3201 perf_stat_process_counter(&stat_config, counter);
3202 process_stat(counter, round->time);
3205 process_stat_interval(round->time);
3209 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3210 union perf_event *event)
3212 perf_event__read_stat_config(&stat_config, &event->stat_config);
3216 static int set_maps(struct perf_script *script)
3218 struct evlist *evlist = script->session->evlist;
3220 if (!script->cpus || !script->threads)
3223 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3226 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3228 if (perf_evlist__alloc_stats(evlist, true))
3231 script->allocated = true;
3236 int process_thread_map_event(struct perf_session *session,
3237 union perf_event *event)
3239 struct perf_tool *tool = session->tool;
3240 struct perf_script *script = container_of(tool, struct perf_script, tool);
3242 if (script->threads) {
3243 pr_warning("Extra thread map event, ignoring.\n");
3247 script->threads = thread_map__new_event(&event->thread_map);
3248 if (!script->threads)
3251 return set_maps(script);
3255 int process_cpu_map_event(struct perf_session *session,
3256 union perf_event *event)
3258 struct perf_tool *tool = session->tool;
3259 struct perf_script *script = container_of(tool, struct perf_script, tool);
3262 pr_warning("Extra cpu map event, ignoring.\n");
3266 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3270 return set_maps(script);
3273 static int process_feature_event(struct perf_session *session,
3274 union perf_event *event)
3276 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3277 return perf_event__process_feature(session, event);
3281 #ifdef HAVE_AUXTRACE_SUPPORT
3282 static int perf_script__process_auxtrace_info(struct perf_session *session,
3283 union perf_event *event)
3285 struct perf_tool *tool = session->tool;
3287 int ret = perf_event__process_auxtrace_info(session, event);
3290 struct perf_script *script = container_of(tool, struct perf_script, tool);
3292 ret = perf_script__setup_per_event_dump(script);
3298 #define perf_script__process_auxtrace_info 0
3301 static int parse_insn_trace(const struct option *opt __maybe_unused,
3302 const char *str __maybe_unused,
3303 int unset __maybe_unused)
3305 parse_output_fields(NULL, "+insn,-event,-period", 0);
3306 itrace_parse_synth_opts(opt, "i0ns", 0);
3307 symbol_conf.nanosecs = true;
3311 static int parse_xed(const struct option *opt __maybe_unused,
3312 const char *str __maybe_unused,
3313 int unset __maybe_unused)
3316 force_pager("xed -F insn: -A -64 | less");
3318 force_pager("xed -F insn: -A -64");
3322 static int parse_call_trace(const struct option *opt __maybe_unused,
3323 const char *str __maybe_unused,
3324 int unset __maybe_unused)
3326 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3327 itrace_parse_synth_opts(opt, "cewp", 0);
3328 symbol_conf.nanosecs = true;
3329 symbol_conf.pad_output_len_dso = 50;
3333 static int parse_callret_trace(const struct option *opt __maybe_unused,
3334 const char *str __maybe_unused,
3335 int unset __maybe_unused)
3337 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3338 itrace_parse_synth_opts(opt, "crewp", 0);
3339 symbol_conf.nanosecs = true;
3343 int cmd_script(int argc, const char **argv)
3345 bool show_full_info = false;
3346 bool header = false;
3347 bool header_only = false;
3348 bool script_started = false;
3349 char *rec_script_path = NULL;
3350 char *rep_script_path = NULL;
3351 struct perf_session *session;
3352 struct itrace_synth_opts itrace_synth_opts = {
3354 .default_no_sample = true,
3357 char *script_path = NULL;
3358 const char **__argv;
3360 struct perf_script script = {
3362 .sample = process_sample_event,
3363 .mmap = perf_event__process_mmap,
3364 .mmap2 = perf_event__process_mmap2,
3365 .comm = perf_event__process_comm,
3366 .namespaces = perf_event__process_namespaces,
3367 .cgroup = perf_event__process_cgroup,
3368 .exit = perf_event__process_exit,
3369 .fork = perf_event__process_fork,
3370 .attr = process_attr,
3371 .event_update = perf_event__process_event_update,
3372 .tracing_data = perf_event__process_tracing_data,
3373 .feature = process_feature_event,
3374 .build_id = perf_event__process_build_id,
3375 .id_index = perf_event__process_id_index,
3376 .auxtrace_info = perf_script__process_auxtrace_info,
3377 .auxtrace = perf_event__process_auxtrace,
3378 .auxtrace_error = perf_event__process_auxtrace_error,
3379 .stat = perf_event__process_stat_event,
3380 .stat_round = process_stat_round_event,
3381 .stat_config = process_stat_config_event,
3382 .thread_map = process_thread_map_event,
3383 .cpu_map = process_cpu_map_event,
3384 .ordered_events = true,
3385 .ordering_requires_timestamps = true,
3388 struct perf_data data = {
3389 .mode = PERF_DATA_MODE_READ,
3391 const struct option options[] = {
3392 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3393 "dump raw trace in ASCII"),
3394 OPT_INCR('v', "verbose", &verbose,
3395 "be more verbose (show symbol address, etc)"),
3396 OPT_BOOLEAN('L', "Latency", &latency_format,
3397 "show latency attributes (irqs/preemption disabled, etc)"),
3398 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3399 list_available_scripts),
3400 OPT_CALLBACK('s', "script", NULL, "name",
3401 "script file name (lang:script name, script name, or *)",
3403 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3404 "generate perf-script.xx script in specified language"),
3405 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3406 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3407 "do various checks like samples ordering and lost events"),
3408 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3409 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3410 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3411 "file", "vmlinux pathname"),
3412 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3413 "file", "kallsyms pathname"),
3414 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3415 "When printing symbols do not display call chain"),
3416 OPT_CALLBACK(0, "symfs", NULL, "directory",
3417 "Look for files with symbols relative to this directory",
3418 symbol__config_symfs),
3419 OPT_CALLBACK('F', "fields", NULL, "str",
3420 "comma separated output fields prepend with 'type:'. "
3421 "+field to add and -field to remove."
3422 "Valid types: hw,sw,trace,raw,synth. "
3423 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3424 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3425 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3426 "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc",
3427 parse_output_fields),
3428 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3429 "system-wide collection from all CPUs"),
3430 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3431 "only consider these symbols"),
3432 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3433 "Decode instructions from itrace", parse_insn_trace),
3434 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3435 "Run xed disassembler on output", parse_xed),
3436 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3437 "Decode calls from from itrace", parse_call_trace),
3438 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3439 "Decode calls and returns from itrace", parse_callret_trace),
3440 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3441 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3442 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3443 "Stop display of callgraph at these symbols"),
3444 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3445 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3446 "only display events for these comms"),
3447 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3448 "only consider symbols in these pids"),
3449 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3450 "only consider symbols in these tids"),
3451 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3452 "Set the maximum stack depth when parsing the callchain, "
3453 "anything beyond the specified depth will be ignored. "
3454 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3455 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3456 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3457 OPT_BOOLEAN('I', "show-info", &show_full_info,
3458 "display extended information from perf.data file"),
3459 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3460 "Show the path of [kernel.kallsyms]"),
3461 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3462 "Show the fork/comm/exit events"),
3463 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3464 "Show the mmap events"),
3465 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3466 "Show context switch events (if recorded)"),
3467 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3468 "Show namespace events (if recorded)"),
3469 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3470 "Show cgroup events (if recorded)"),
3471 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3472 "Show lost events (if recorded)"),
3473 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3474 "Show round events (if recorded)"),
3475 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3476 "Show bpf related events (if recorded)"),
3477 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3478 "Dump trace output to files named by the monitored events"),
3479 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3480 OPT_INTEGER(0, "max-blocks", &max_blocks,
3481 "Maximum number of code blocks to dump with brstackinsn"),
3482 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3483 "Use 9 decimal places when displaying time"),
3484 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3485 "Instruction Tracing options\n" ITRACE_HELP,
3486 itrace_parse_synth_opts),
3487 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3488 "Show full source file name path for source lines"),
3489 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3490 "Enable symbol demangling"),
3491 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3492 "Enable kernel symbol demangling"),
3493 OPT_STRING(0, "time", &script.time_str, "str",
3494 "Time span of interest (start,stop)"),
3495 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3496 "Show inline function"),
3497 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3498 "guest mount directory under which every guest os"
3499 " instance has a subdir"),
3500 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3501 "file", "file saving guest os vmlinux"),
3502 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3503 "file", "file saving guest os /proc/kallsyms"),
3504 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3505 "file", "file saving guest os /proc/modules"),
3506 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3507 "Enable LBR callgraph stitching approach"),
3508 OPTS_EVSWITCH(&script.evswitch),
3511 const char * const script_subcommands[] = { "record", "report", NULL };
3512 const char *script_usage[] = {
3513 "perf script [<options>]",
3514 "perf script [<options>] record <script> [<record-options>] <command>",
3515 "perf script [<options>] report <script> [script-args]",
3516 "perf script [<options>] <script> [<record-options>] <command>",
3517 "perf script [<options>] <top-script> [script-args]",
3521 perf_set_singlethreaded();
3525 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3526 PARSE_OPT_STOP_AT_NON_OPTION);
3528 if (symbol_conf.guestmount ||
3529 symbol_conf.default_guest_vmlinux_name ||
3530 symbol_conf.default_guest_kallsyms ||
3531 symbol_conf.default_guest_modules) {
3533 * Enable guest sample processing.
3538 data.path = input_name;
3539 data.force = symbol_conf.force;
3541 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3542 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3543 if (!rec_script_path)
3544 return cmd_record(argc, argv);
3547 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3548 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3549 if (!rep_script_path) {
3551 "Please specify a valid report script"
3552 "(see 'perf script -l' for listing)\n");
3557 if (reltime && deltatime) {
3559 "reltime and deltatime - the two don't get along well. "
3560 "Please limit to --reltime or --deltatime.\n");
3564 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3565 itrace_synth_opts.callchain_sz > scripting_max_stack)
3566 scripting_max_stack = itrace_synth_opts.callchain_sz;
3568 /* make sure PERF_EXEC_PATH is set for scripts */
3569 set_argv_exec_path(get_argv_exec_path());
3571 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3576 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3577 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3579 if (!rec_script_path && !rep_script_path) {
3580 usage_with_options_msg(script_usage, options,
3581 "Couldn't find script `%s'\n\n See perf"
3582 " script -l for available scripts.\n", argv[0]);
3585 if (is_top_script(argv[0])) {
3586 rep_args = argc - 1;
3590 rep_args = has_required_arg(rep_script_path);
3591 rec_args = (argc - 1) - rep_args;
3593 usage_with_options_msg(script_usage, options,
3594 "`%s' script requires options."
3595 "\n\n See perf script -l for available "
3596 "scripts and options.\n", argv[0]);
3600 if (pipe(live_pipe) < 0) {
3601 perror("failed to create pipe");
3607 perror("failed to fork");
3614 dup2(live_pipe[1], 1);
3615 close(live_pipe[0]);
3617 if (is_top_script(argv[0])) {
3619 } else if (!system_wide) {
3620 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3626 __argv = malloc((argc + 6) * sizeof(const char *));
3628 pr_err("malloc failed\n");
3633 __argv[j++] = "/bin/sh";
3634 __argv[j++] = rec_script_path;
3640 for (i = rep_args + 1; i < argc; i++)
3641 __argv[j++] = argv[i];
3644 execvp("/bin/sh", (char **)__argv);
3649 dup2(live_pipe[0], 0);
3650 close(live_pipe[1]);
3652 __argv = malloc((argc + 4) * sizeof(const char *));
3654 pr_err("malloc failed\n");
3660 __argv[j++] = "/bin/sh";
3661 __argv[j++] = rep_script_path;
3662 for (i = 1; i < rep_args + 1; i++)
3663 __argv[j++] = argv[i];
3668 execvp("/bin/sh", (char **)__argv);
3673 if (rec_script_path)
3674 script_path = rec_script_path;
3675 if (rep_script_path)
3676 script_path = rep_script_path;
3681 if (!rec_script_path)
3682 system_wide = false;
3683 else if (!system_wide) {
3684 if (have_cmd(argc - 1, &argv[1]) != 0) {
3690 __argv = malloc((argc + 2) * sizeof(const char *));
3692 pr_err("malloc failed\n");
3697 __argv[j++] = "/bin/sh";
3698 __argv[j++] = script_path;
3701 for (i = 2; i < argc; i++)
3702 __argv[j++] = argv[i];
3705 execvp("/bin/sh", (char **)__argv);
3715 session = perf_session__new(&data, false, &script.tool);
3716 if (IS_ERR(session))
3717 return PTR_ERR(session);
3719 if (header || header_only) {
3720 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3721 perf_session__fprintf_info(session, stdout, show_full_info);
3726 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3728 if (symbol__init(&session->header.env) < 0)
3732 if (data.is_pipe || /* assume pipe_mode indicates native_arch */
3733 !strcmp(uts.machine, session->header.env.arch) ||
3734 (!strcmp(uts.machine, "x86_64") &&
3735 !strcmp(session->header.env.arch, "i386")))
3738 script.session = session;
3739 script__setup_sample_type(&script);
3741 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3742 symbol_conf.graph_function)
3743 itrace_synth_opts.thread_stack = true;
3745 session->itrace_synth_opts = &itrace_synth_opts;
3748 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3751 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3755 symbol_conf.use_callchain = true;
3757 symbol_conf.use_callchain = false;
3759 if (session->tevent.pevent &&
3760 tep_set_function_resolver(session->tevent.pevent,
3761 machine__resolve_kernel_addr,
3762 &session->machines.host) < 0) {
3763 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3768 if (generate_script_lang) {
3769 struct stat perf_stat;
3772 if (output_set_by_user()) {
3774 "custom fields not supported for generated scripts");
3779 input = open(data.path, O_RDONLY); /* input_name */
3782 perror("failed to open file");
3786 err = fstat(input, &perf_stat);
3788 perror("failed to stat file");
3792 if (!perf_stat.st_size) {
3793 fprintf(stderr, "zero-sized file, nothing to do!\n");
3797 scripting_ops = script_spec__lookup(generate_script_lang);
3798 if (!scripting_ops) {
3799 fprintf(stderr, "invalid language specifier");
3804 err = scripting_ops->generate_script(session->tevent.pevent,
3810 err = scripting_ops->start_script(script_name, argc, argv);
3813 pr_debug("perf script started with script %s\n\n", script_name);
3814 script_started = true;
3818 err = perf_session__check_output_opt(session);
3822 if (script.time_str) {
3823 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
3824 &script.ptime_range,
3831 itrace_synth_opts__set_time_range(&itrace_synth_opts,
3836 err = evswitch__init(&script.evswitch, session->evlist, stderr);
3840 if (zstd_init(&(session->zstd_data), 0) < 0)
3841 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
3843 err = __cmd_script(&script);
3848 if (script.ptime_range) {
3849 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3850 zfree(&script.ptime_range);
3853 perf_evlist__free_stats(session->evlist);
3854 perf_session__delete(session);
3857 cleanup_scripting();