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 } output[OUTPUT_TYPE_MAX] = {
172 [PERF_TYPE_HARDWARE] = {
175 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
176 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
177 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
178 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
179 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
181 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
184 [PERF_TYPE_SOFTWARE] = {
187 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
188 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
189 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
190 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
191 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
192 PERF_OUTPUT_BPF_OUTPUT,
194 .invalid_fields = PERF_OUTPUT_TRACE,
197 [PERF_TYPE_TRACEPOINT] = {
200 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
201 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
202 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
205 [PERF_TYPE_HW_CACHE] = {
208 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
209 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
210 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
211 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
212 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
214 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
220 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
221 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
222 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
223 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
224 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
225 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
226 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR,
228 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
231 [PERF_TYPE_BREAKPOINT] = {
234 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
235 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
236 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
237 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
238 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
240 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
243 [OUTPUT_TYPE_SYNTH] = {
246 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
247 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
248 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
249 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
250 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
252 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
256 struct evsel_script {
260 /* For metric output */
265 static inline struct evsel_script *evsel_script(struct evsel *evsel)
267 return (struct evsel_script *)evsel->priv;
270 static struct evsel_script *perf_evsel_script__new(struct evsel *evsel,
271 struct perf_data *data)
273 struct evsel_script *es = zalloc(sizeof(*es));
276 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, perf_evsel__name(evsel)) < 0)
278 es->fp = fopen(es->filename, "w");
280 goto out_free_filename;
285 zfree(&es->filename);
291 static void perf_evsel_script__delete(struct evsel_script *es)
293 zfree(&es->filename);
299 static int perf_evsel_script__fprintf(struct evsel_script *es, FILE *fp)
303 fstat(fileno(es->fp), &st);
304 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
305 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
308 static inline int output_type(unsigned int type)
311 case PERF_TYPE_SYNTH:
312 return OUTPUT_TYPE_SYNTH;
318 static inline unsigned int attr_type(unsigned int type)
321 case OUTPUT_TYPE_SYNTH:
322 return PERF_TYPE_SYNTH;
328 static bool output_set_by_user(void)
331 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
332 if (output[j].user_set)
338 static const char *output_field2str(enum perf_output_field field)
340 int i, imax = ARRAY_SIZE(all_output_options);
341 const char *str = "";
343 for (i = 0; i < imax; ++i) {
344 if (all_output_options[i].field == field) {
345 str = all_output_options[i].str;
352 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
354 static int perf_evsel__do_check_stype(struct evsel *evsel,
355 u64 sample_type, const char *sample_msg,
356 enum perf_output_field field,
359 struct perf_event_attr *attr = &evsel->core.attr;
360 int type = output_type(attr->type);
363 if (attr->sample_type & sample_type)
366 if (output[type].user_set_fields & field) {
369 evname = perf_evsel__name(evsel);
370 pr_err("Samples for '%s' event do not have %s attribute set. "
371 "Cannot print '%s' field.\n",
372 evname, sample_msg, output_field2str(field));
376 /* user did not ask for it explicitly so remove from the default list */
377 output[type].fields &= ~field;
378 evname = perf_evsel__name(evsel);
379 pr_debug("Samples for '%s' event do not have %s attribute set. "
380 "Skipping '%s' field.\n",
381 evname, sample_msg, output_field2str(field));
386 static int perf_evsel__check_stype(struct evsel *evsel,
387 u64 sample_type, const char *sample_msg,
388 enum perf_output_field field)
390 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
394 static int perf_evsel__check_attr(struct evsel *evsel,
395 struct perf_session *session)
397 struct perf_event_attr *attr = &evsel->core.attr;
400 if (perf_header__has_feat(&session->header, HEADER_STAT))
403 allow_user_set = perf_header__has_feat(&session->header,
406 if (PRINT_FIELD(TRACE) &&
407 !perf_session__has_traces(session, "record -R"))
410 if (PRINT_FIELD(IP)) {
411 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
416 if (PRINT_FIELD(ADDR) &&
417 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
418 PERF_OUTPUT_ADDR, allow_user_set))
421 if (PRINT_FIELD(DATA_SRC) &&
422 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
423 PERF_OUTPUT_DATA_SRC))
426 if (PRINT_FIELD(WEIGHT) &&
427 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
431 if (PRINT_FIELD(SYM) &&
432 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
433 pr_err("Display of symbols requested but neither sample IP nor "
434 "sample address\navailable. Hence, no addresses to convert "
438 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
439 pr_err("Display of offsets requested but symbol is not"
443 if (PRINT_FIELD(DSO) &&
444 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
445 pr_err("Display of DSO requested but no address to convert.\n");
448 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
449 pr_err("Display of source line number requested but sample IP is not\n"
450 "selected. Hence, no address to lookup the source line number.\n");
453 if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
454 !(perf_evlist__combined_branch_type(session->evlist) &
455 PERF_SAMPLE_BRANCH_ANY)) {
456 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
457 "Hint: run 'perf record -b ...'\n");
460 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
461 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
462 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
465 if (PRINT_FIELD(TIME) &&
466 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
470 if (PRINT_FIELD(CPU) &&
471 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
472 PERF_OUTPUT_CPU, allow_user_set))
475 if (PRINT_FIELD(IREGS) &&
476 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
480 if (PRINT_FIELD(UREGS) &&
481 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS",
485 if (PRINT_FIELD(PHYS_ADDR) &&
486 perf_evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR",
487 PERF_OUTPUT_PHYS_ADDR))
493 static void set_print_ip_opts(struct perf_event_attr *attr)
495 unsigned int type = output_type(attr->type);
497 output[type].print_ip_opts = 0;
499 output[type].print_ip_opts |= EVSEL__PRINT_IP;
501 if (PRINT_FIELD(SYM))
502 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
504 if (PRINT_FIELD(DSO))
505 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
507 if (PRINT_FIELD(SYMOFFSET))
508 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
510 if (PRINT_FIELD(SRCLINE))
511 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
515 * verify all user requested events exist and the samples
516 * have the expected data
518 static int perf_session__check_output_opt(struct perf_session *session)
523 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
524 evsel = perf_session__find_first_evtype(session, attr_type(j));
527 * even if fields is set to 0 (ie., show nothing) event must
528 * exist if user explicitly includes it on the command line
530 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
531 j != OUTPUT_TYPE_SYNTH) {
532 pr_err("%s events do not exist. "
533 "Remove corresponding -F option to proceed.\n",
538 if (evsel && output[j].fields &&
539 perf_evsel__check_attr(evsel, session))
545 set_print_ip_opts(&evsel->core.attr);
549 bool use_callchain = false;
550 bool not_pipe = false;
552 evlist__for_each_entry(session->evlist, evsel) {
554 if (evsel__has_callchain(evsel)) {
555 use_callchain = true;
559 if (not_pipe && !use_callchain)
560 symbol_conf.use_callchain = false;
564 * set default for tracepoints to print symbols only
565 * if callchains are present
567 if (symbol_conf.use_callchain &&
568 !output[PERF_TYPE_TRACEPOINT].user_set) {
569 j = PERF_TYPE_TRACEPOINT;
571 evlist__for_each_entry(session->evlist, evsel) {
572 if (evsel->core.attr.type != j)
575 if (evsel__has_callchain(evsel)) {
576 output[j].fields |= PERF_OUTPUT_IP;
577 output[j].fields |= PERF_OUTPUT_SYM;
578 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
579 output[j].fields |= PERF_OUTPUT_DSO;
580 set_print_ip_opts(&evsel->core.attr);
590 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
597 if (!regs || !regs->regs)
600 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
602 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
603 u64 val = regs->regs[i++];
604 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
610 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
611 struct perf_event_attr *attr, FILE *fp)
613 return perf_sample__fprintf_regs(&sample->intr_regs,
614 attr->sample_regs_intr, fp);
617 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
618 struct perf_event_attr *attr, FILE *fp)
620 return perf_sample__fprintf_regs(&sample->user_regs,
621 attr->sample_regs_user, fp);
624 static int perf_sample__fprintf_start(struct perf_sample *sample,
625 struct thread *thread,
629 struct perf_event_attr *attr = &evsel->core.attr;
631 unsigned long long nsecs;
634 if (PRINT_FIELD(COMM)) {
636 printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
637 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
638 printed += fprintf(fp, "%s ", thread__comm_str(thread));
640 printed += fprintf(fp, "%16s ", thread__comm_str(thread));
643 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
644 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
645 else if (PRINT_FIELD(PID))
646 printed += fprintf(fp, "%5d ", sample->pid);
647 else if (PRINT_FIELD(TID))
648 printed += fprintf(fp, "%5d ", sample->tid);
650 if (PRINT_FIELD(CPU)) {
652 printed += fprintf(fp, "%3d ", sample->cpu);
654 printed += fprintf(fp, "[%03d] ", sample->cpu);
657 if (PRINT_FIELD(MISC)) {
661 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
664 ret += fprintf(fp, "K");
666 ret += fprintf(fp, "U");
668 ret += fprintf(fp, "H");
669 if (has(GUEST_KERNEL))
670 ret += fprintf(fp, "G");
672 ret += fprintf(fp, "g");
675 case PERF_RECORD_MMAP:
676 case PERF_RECORD_MMAP2:
678 ret += fprintf(fp, "M");
680 case PERF_RECORD_COMM:
682 ret += fprintf(fp, "E");
684 case PERF_RECORD_SWITCH:
685 case PERF_RECORD_SWITCH_CPU_WIDE:
686 if (has(SWITCH_OUT)) {
687 ret += fprintf(fp, "S");
688 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
689 ret += fprintf(fp, "p");
697 ret += fprintf(fp, "%*s", 6 - ret, " ");
701 if (PRINT_FIELD(TIME)) {
702 u64 t = sample->time;
705 initial_time = sample->time;
706 t = sample->time - initial_time;
707 } else if (deltatime) {
709 t = sample->time - previous_time;
713 previous_time = sample->time;
716 secs = nsecs / NSEC_PER_SEC;
717 nsecs -= secs * NSEC_PER_SEC;
719 if (symbol_conf.nanosecs)
720 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
722 char sample_time[32];
723 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
724 printed += fprintf(fp, "%12s: ", sample_time);
732 mispred_str(struct branch_entry *br)
734 if (!(br->flags.mispred || br->flags.predicted))
737 return br->flags.predicted ? 'P' : 'M';
740 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
741 struct thread *thread,
742 struct perf_event_attr *attr, FILE *fp)
744 struct branch_stack *br = sample->branch_stack;
745 struct branch_entry *entries = perf_sample__branch_entries(sample);
746 struct addr_location alf, alt;
753 for (i = 0; i < br->nr; i++) {
754 from = entries[i].from;
757 if (PRINT_FIELD(DSO)) {
758 memset(&alf, 0, sizeof(alf));
759 memset(&alt, 0, sizeof(alt));
760 thread__find_map_fb(thread, sample->cpumode, from, &alf);
761 thread__find_map_fb(thread, sample->cpumode, to, &alt);
764 printed += fprintf(fp, " 0x%"PRIx64, from);
765 if (PRINT_FIELD(DSO)) {
766 printed += fprintf(fp, "(");
767 printed += map__fprintf_dsoname(alf.map, fp);
768 printed += fprintf(fp, ")");
771 printed += fprintf(fp, "/0x%"PRIx64, to);
772 if (PRINT_FIELD(DSO)) {
773 printed += fprintf(fp, "(");
774 printed += map__fprintf_dsoname(alt.map, fp);
775 printed += fprintf(fp, ")");
778 printed += fprintf(fp, "/%c/%c/%c/%d ",
779 mispred_str(entries + i),
780 entries[i].flags.in_tx ? 'X' : '-',
781 entries[i].flags.abort ? 'A' : '-',
782 entries[i].flags.cycles);
788 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
789 struct thread *thread,
790 struct perf_event_attr *attr, FILE *fp)
792 struct branch_stack *br = sample->branch_stack;
793 struct branch_entry *entries = perf_sample__branch_entries(sample);
794 struct addr_location alf, alt;
801 for (i = 0; i < br->nr; i++) {
803 memset(&alf, 0, sizeof(alf));
804 memset(&alt, 0, sizeof(alt));
805 from = entries[i].from;
808 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
809 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
811 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
812 if (PRINT_FIELD(DSO)) {
813 printed += fprintf(fp, "(");
814 printed += map__fprintf_dsoname(alf.map, fp);
815 printed += fprintf(fp, ")");
817 printed += fprintf(fp, "%c", '/');
818 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
819 if (PRINT_FIELD(DSO)) {
820 printed += fprintf(fp, "(");
821 printed += map__fprintf_dsoname(alt.map, fp);
822 printed += fprintf(fp, ")");
824 printed += fprintf(fp, "/%c/%c/%c/%d ",
825 mispred_str(entries + i),
826 entries[i].flags.in_tx ? 'X' : '-',
827 entries[i].flags.abort ? 'A' : '-',
828 entries[i].flags.cycles);
834 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
835 struct thread *thread,
836 struct perf_event_attr *attr, FILE *fp)
838 struct branch_stack *br = sample->branch_stack;
839 struct branch_entry *entries = perf_sample__branch_entries(sample);
840 struct addr_location alf, alt;
847 for (i = 0; i < br->nr; i++) {
849 memset(&alf, 0, sizeof(alf));
850 memset(&alt, 0, sizeof(alt));
851 from = entries[i].from;
854 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
855 !alf.map->dso->adjust_symbols)
856 from = map__map_ip(alf.map, from);
858 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
859 !alt.map->dso->adjust_symbols)
860 to = map__map_ip(alt.map, to);
862 printed += fprintf(fp, " 0x%"PRIx64, from);
863 if (PRINT_FIELD(DSO)) {
864 printed += fprintf(fp, "(");
865 printed += map__fprintf_dsoname(alf.map, fp);
866 printed += fprintf(fp, ")");
868 printed += fprintf(fp, "/0x%"PRIx64, to);
869 if (PRINT_FIELD(DSO)) {
870 printed += fprintf(fp, "(");
871 printed += map__fprintf_dsoname(alt.map, fp);
872 printed += fprintf(fp, ")");
874 printed += fprintf(fp, "/%c/%c/%c/%d ",
875 mispred_str(entries + i),
876 entries[i].flags.in_tx ? 'X' : '-',
877 entries[i].flags.abort ? 'A' : '-',
878 entries[i].flags.cycles);
883 #define MAXBB 16384UL
885 static int grab_bb(u8 *buffer, u64 start, u64 end,
886 struct machine *machine, struct thread *thread,
887 bool *is64bit, u8 *cpumode, bool last)
890 struct addr_location al;
896 kernel = machine__kernel_ip(machine, start);
898 *cpumode = PERF_RECORD_MISC_KERNEL;
900 *cpumode = PERF_RECORD_MISC_USER;
903 * Block overlaps between kernel and user.
904 * This can happen due to ring filtering
905 * On Intel CPUs the entry into the kernel is filtered,
906 * but the exit is not. Let the caller patch it up.
908 if (kernel != machine__kernel_ip(machine, end)) {
909 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
913 memset(&al, 0, sizeof(al));
914 if (end - start > MAXBB - MAXINSN) {
916 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
918 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
922 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
923 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
926 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
927 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
931 /* Load maps to ensure dso->is_64_bit has been updated */
934 offset = al.map->map_ip(al.map, start);
935 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
936 end - start + MAXINSN);
938 *is64bit = al.map->dso->is_64_bit;
940 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
945 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
953 if (!map || !map->dso)
955 srcfile = get_srcline_split(map->dso,
956 map__rip_2objdump(map, addr),
961 /* Avoid redundant printing */
964 !strcmp(state->srcfile, srcfile) &&
965 state->line == line) {
970 srccode = find_sourceline(srcfile, line, &len);
974 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
977 state->srcfile = srcfile;
987 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
989 struct addr_location al;
992 memset(&al, 0, sizeof(al));
993 thread__find_map(thread, cpumode, addr, &al);
996 ret = map__fprintf_srccode(al.map, al.addr, stdout,
997 &thread->srccode_state);
1003 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1004 struct perf_insn *x, u8 *inbuf, int len,
1005 int insn, FILE *fp, int *total_cycles)
1007 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
1008 dump_insn(x, ip, inbuf, len, NULL),
1009 en->flags.predicted ? " PRED" : "",
1010 en->flags.mispred ? " MISPRED" : "",
1011 en->flags.in_tx ? " INTX" : "",
1012 en->flags.abort ? " ABORT" : "");
1013 if (en->flags.cycles) {
1014 *total_cycles += en->flags.cycles;
1015 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1017 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1019 return printed + fprintf(fp, "\n");
1022 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1023 u8 cpumode, int cpu, struct symbol **lastsym,
1024 struct perf_event_attr *attr, FILE *fp)
1026 struct addr_location al;
1027 int off, printed = 0;
1029 memset(&al, 0, sizeof(al));
1031 thread__find_map(thread, cpumode, addr, &al);
1033 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1039 al.sym = map__find_symbol(al.map, al.addr);
1044 if (al.addr < al.sym->end)
1045 off = al.addr - al.sym->start;
1047 off = al.addr - al.map->start - al.sym->start;
1048 printed += fprintf(fp, "\t%s", al.sym->name);
1050 printed += fprintf(fp, "%+d", off);
1051 printed += fprintf(fp, ":");
1052 if (PRINT_FIELD(SRCLINE))
1053 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1054 printed += fprintf(fp, "\n");
1060 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1061 struct thread *thread,
1062 struct perf_event_attr *attr,
1063 struct machine *machine, FILE *fp)
1065 struct branch_stack *br = sample->branch_stack;
1066 struct branch_entry *entries = perf_sample__branch_entries(sample);
1068 int i, insn, len, nr, ilen, printed = 0;
1072 struct symbol *lastsym = NULL;
1073 int total_cycles = 0;
1075 if (!(br && br->nr))
1078 if (max_blocks && nr > max_blocks + 1)
1079 nr = max_blocks + 1;
1082 x.cpu = sample->cpu;
1084 printed += fprintf(fp, "%c", '\n');
1086 /* Handle first from jump, of which we don't know the entry. */
1087 len = grab_bb(buffer, entries[nr-1].from,
1089 machine, thread, &x.is64bit, &x.cpumode, false);
1091 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1092 x.cpumode, x.cpu, &lastsym, attr, fp);
1093 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1094 &x, buffer, len, 0, fp, &total_cycles);
1095 if (PRINT_FIELD(SRCCODE))
1096 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1099 /* Print all blocks */
1100 for (i = nr - 2; i >= 0; i--) {
1101 if (entries[i].from || entries[i].to)
1102 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1105 start = entries[i + 1].to;
1106 end = entries[i].from;
1108 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1109 /* Patch up missing kernel transfers due to ring filters */
1110 if (len == -ENXIO && i > 0) {
1111 end = entries[--i].from;
1112 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1113 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1119 for (off = 0; off < (unsigned)len; off += ilen) {
1120 uint64_t ip = start + off;
1122 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1124 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1126 if (PRINT_FIELD(SRCCODE))
1127 printed += print_srccode(thread, x.cpumode, ip);
1131 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1132 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1135 if (PRINT_FIELD(SRCCODE))
1136 print_srccode(thread, x.cpumode, ip);
1140 if (off != end - start)
1141 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1145 * Hit the branch? In this case we are already done, and the target
1146 * has not been executed yet.
1148 if (entries[0].from == sample->ip)
1150 if (entries[0].flags.abort)
1154 * Print final block upto sample
1156 * Due to pipeline delays the LBRs might be missing a branch
1157 * or two, which can result in very large or negative blocks
1158 * between final branch and sample. When this happens just
1159 * continue walking after the last TO until we hit a branch.
1161 start = entries[0].to;
1164 /* Missing jump. Scan 128 bytes for the next branch */
1167 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1168 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1170 /* Print at least last IP if basic block did not work */
1171 len = grab_bb(buffer, sample->ip, sample->ip,
1172 machine, thread, &x.is64bit, &x.cpumode, false);
1175 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1176 dump_insn(&x, sample->ip, buffer, len, NULL));
1177 if (PRINT_FIELD(SRCCODE))
1178 print_srccode(thread, x.cpumode, sample->ip);
1181 for (off = 0; off <= end - start; off += ilen) {
1183 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1184 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1187 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1189 * Hit a missing branch. Just stop.
1191 printed += fprintf(fp, "\t... not reaching sample ...\n");
1194 if (PRINT_FIELD(SRCCODE))
1195 print_srccode(thread, x.cpumode, start + off);
1201 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1202 struct thread *thread,
1203 struct perf_event_attr *attr, FILE *fp)
1205 struct addr_location al;
1206 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1208 if (!sample_addr_correlates_sym(attr))
1211 thread__resolve(thread, &al, sample);
1213 if (PRINT_FIELD(SYM)) {
1214 printed += fprintf(fp, " ");
1215 if (PRINT_FIELD(SYMOFFSET))
1216 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1218 printed += symbol__fprintf_symname(al.sym, fp);
1221 if (PRINT_FIELD(DSO)) {
1222 printed += fprintf(fp, " (");
1223 printed += map__fprintf_dsoname(al.map, fp);
1224 printed += fprintf(fp, ")");
1230 static const char *resolve_branch_sym(struct perf_sample *sample,
1231 struct evsel *evsel,
1232 struct thread *thread,
1233 struct addr_location *al,
1236 struct addr_location addr_al;
1237 struct perf_event_attr *attr = &evsel->core.attr;
1238 const char *name = NULL;
1240 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1241 if (sample_addr_correlates_sym(attr)) {
1242 thread__resolve(thread, &addr_al, sample);
1244 name = addr_al.sym->name;
1250 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1252 name = al->sym->name;
1259 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1260 struct evsel *evsel,
1261 struct thread *thread,
1262 struct addr_location *al, FILE *fp)
1264 struct perf_event_attr *attr = &evsel->core.attr;
1265 size_t depth = thread_stack__depth(thread, sample->cpu);
1266 const char *name = NULL;
1273 * The 'return' has already been popped off the stack so the depth has
1274 * to be adjusted to match the 'call'.
1276 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1279 name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1281 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1282 dlen += fprintf(fp, "(");
1283 dlen += map__fprintf_dsoname(al->map, fp);
1284 dlen += fprintf(fp, ")\t");
1288 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1290 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1296 * Try to keep the output length from changing frequently so that the
1297 * output lines up more nicely.
1299 if (len > spacing || (len && len < spacing - 52))
1300 spacing = round_up(len + 4, 32);
1303 len += fprintf(fp, "%*s", spacing - len, "");
1308 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1309 struct thread *thread __maybe_unused,
1310 struct machine *machine __maybe_unused)
1314 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1315 struct perf_event_attr *attr,
1316 struct thread *thread,
1317 struct machine *machine, FILE *fp)
1321 if (sample->insn_len == 0 && native_arch)
1322 arch_fetch_insn(sample, thread, machine);
1324 if (PRINT_FIELD(INSNLEN))
1325 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1326 if (PRINT_FIELD(INSN) && sample->insn_len) {
1329 printed += fprintf(fp, " insn:");
1330 for (i = 0; i < sample->insn_len; i++)
1331 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1333 if (PRINT_FIELD(BRSTACKINSN))
1334 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1339 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1340 struct perf_event_attr *attr, FILE *fp)
1344 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1347 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1349 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1350 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1353 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1354 struct evsel *evsel,
1355 struct thread *thread,
1356 struct addr_location *al,
1357 struct machine *machine, FILE *fp)
1359 struct perf_event_attr *attr = &evsel->core.attr;
1360 unsigned int type = output_type(attr->type);
1361 bool print_srcline_last = false;
1364 if (PRINT_FIELD(CALLINDENT))
1365 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1367 /* print branch_from information */
1368 if (PRINT_FIELD(IP)) {
1369 unsigned int print_opts = output[type].print_ip_opts;
1370 struct callchain_cursor *cursor = NULL;
1372 if (symbol_conf.use_callchain && sample->callchain &&
1373 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1374 sample, NULL, NULL, scripting_max_stack) == 0)
1375 cursor = &callchain_cursor;
1377 if (cursor == NULL) {
1378 printed += fprintf(fp, " ");
1379 if (print_opts & EVSEL__PRINT_SRCLINE) {
1380 print_srcline_last = true;
1381 print_opts &= ~EVSEL__PRINT_SRCLINE;
1384 printed += fprintf(fp, "\n");
1386 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1387 symbol_conf.bt_stop_list, fp);
1390 /* print branch_to information */
1391 if (PRINT_FIELD(ADDR) ||
1392 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1393 !output[type].user_set)) {
1394 printed += fprintf(fp, " => ");
1395 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1398 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1400 if (print_srcline_last)
1401 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1403 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1404 printed += fprintf(fp, "\n");
1405 if (PRINT_FIELD(SRCCODE)) {
1406 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1407 &thread->srccode_state);
1410 printed += printf("\n");
1419 } sample_flags[] = {
1420 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1421 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1422 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1423 {PERF_IP_FLAG_BRANCH, "jmp"},
1424 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1425 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1426 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1427 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1428 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1429 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1430 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1431 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1432 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1436 static const char *sample_flags_to_name(u32 flags)
1440 for (i = 0; sample_flags[i].name ; i++) {
1441 if (sample_flags[i].flags == flags)
1442 return sample_flags[i].name;
1448 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1450 const char *chars = PERF_IP_FLAG_CHARS;
1451 const int n = strlen(PERF_IP_FLAG_CHARS);
1452 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1453 const char *name = NULL;
1457 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1459 return fprintf(fp, " %-15s%4s ", name, in_tx ? "(x)" : "");
1461 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1462 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1464 return fprintf(fp, " tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1467 if (flags & PERF_IP_FLAG_TRACE_END) {
1468 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1470 return fprintf(fp, " tr end %-7s%4s ", name, in_tx ? "(x)" : "");
1473 for (i = 0; i < n; i++, flags >>= 1) {
1475 str[pos++] = chars[i];
1477 for (; i < 32; i++, flags >>= 1) {
1483 return fprintf(fp, " %-19s ", str);
1486 struct printer_data {
1492 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1494 void *extra, FILE *fp)
1496 unsigned char ch = (unsigned char)val;
1497 struct printer_data *printer_data = extra;
1501 case BINARY_PRINT_DATA_BEGIN:
1502 printed += fprintf(fp, "\n");
1504 case BINARY_PRINT_LINE_BEGIN:
1505 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1508 case BINARY_PRINT_ADDR:
1509 printed += fprintf(fp, " %04x:", val);
1511 case BINARY_PRINT_NUM_DATA:
1512 printed += fprintf(fp, " %02x", val);
1514 case BINARY_PRINT_NUM_PAD:
1515 printed += fprintf(fp, " ");
1517 case BINARY_PRINT_SEP:
1518 printed += fprintf(fp, " ");
1520 case BINARY_PRINT_CHAR_DATA:
1521 if (printer_data->hit_nul && ch)
1522 printer_data->is_printable = false;
1525 printed += fprintf(fp, "%c", '.');
1527 if (!printer_data->is_printable)
1531 printer_data->hit_nul = true;
1533 printer_data->is_printable = false;
1535 printed += fprintf(fp, "%c", ch);
1538 case BINARY_PRINT_CHAR_PAD:
1539 printed += fprintf(fp, " ");
1541 case BINARY_PRINT_LINE_END:
1542 printed += fprintf(fp, "\n");
1543 printer_data->line_no++;
1545 case BINARY_PRINT_DATA_END:
1553 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1555 unsigned int nr_bytes = sample->raw_size;
1556 struct printer_data printer_data = {0, false, true};
1557 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1558 sample__fprintf_bpf_output, &printer_data, fp);
1560 if (printer_data.is_printable && printer_data.hit_nul)
1561 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1566 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1568 if (len > 0 && len < spacing)
1569 return fprintf(fp, "%*s", spacing - len, "");
1574 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1576 return perf_sample__fprintf_spacing(len, 34, fp);
1579 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1581 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1584 if (perf_sample__bad_synth_size(sample, *data))
1587 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1588 data->ip, le64_to_cpu(data->payload));
1589 return len + perf_sample__fprintf_pt_spacing(len, fp);
1592 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1594 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1597 if (perf_sample__bad_synth_size(sample, *data))
1600 len = fprintf(fp, " hints: %#x extensions: %#x ",
1601 data->hints, data->extensions);
1602 return len + perf_sample__fprintf_pt_spacing(len, fp);
1605 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1607 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1610 if (perf_sample__bad_synth_size(sample, *data))
1613 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1614 data->hw, data->cstate, data->subcstate);
1615 return len + perf_sample__fprintf_pt_spacing(len, fp);
1618 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1620 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1623 if (perf_sample__bad_synth_size(sample, *data))
1626 len = fprintf(fp, " IP: %u ", data->ip);
1627 return len + perf_sample__fprintf_pt_spacing(len, fp);
1630 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1632 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1635 if (perf_sample__bad_synth_size(sample, *data))
1638 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1639 data->deepest_cstate, data->last_cstate,
1641 return len + perf_sample__fprintf_pt_spacing(len, fp);
1644 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1646 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1647 unsigned int percent, freq;
1650 if (perf_sample__bad_synth_size(sample, *data))
1653 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1654 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1655 if (data->max_nonturbo) {
1656 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1657 len += fprintf(fp, "(%3u%%) ", percent);
1659 return len + perf_sample__fprintf_pt_spacing(len, fp);
1662 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1663 struct evsel *evsel, FILE *fp)
1665 switch (evsel->core.attr.config) {
1666 case PERF_SYNTH_INTEL_PTWRITE:
1667 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1668 case PERF_SYNTH_INTEL_MWAIT:
1669 return perf_sample__fprintf_synth_mwait(sample, fp);
1670 case PERF_SYNTH_INTEL_PWRE:
1671 return perf_sample__fprintf_synth_pwre(sample, fp);
1672 case PERF_SYNTH_INTEL_EXSTOP:
1673 return perf_sample__fprintf_synth_exstop(sample, fp);
1674 case PERF_SYNTH_INTEL_PWRX:
1675 return perf_sample__fprintf_synth_pwrx(sample, fp);
1676 case PERF_SYNTH_INTEL_CBR:
1677 return perf_sample__fprintf_synth_cbr(sample, fp);
1685 struct perf_script {
1686 struct perf_tool tool;
1687 struct perf_session *session;
1688 bool show_task_events;
1689 bool show_mmap_events;
1690 bool show_switch_events;
1691 bool show_namespace_events;
1692 bool show_lost_events;
1693 bool show_round_events;
1694 bool show_bpf_events;
1695 bool show_cgroup_events;
1697 bool per_event_dump;
1699 struct evswitch evswitch;
1700 struct perf_cpu_map *cpus;
1701 struct perf_thread_map *threads;
1703 const char *time_str;
1704 struct perf_time_interval *ptime_range;
1709 static int perf_evlist__max_name_len(struct evlist *evlist)
1711 struct evsel *evsel;
1714 evlist__for_each_entry(evlist, evsel) {
1715 int len = strlen(perf_evsel__name(evsel));
1717 max = MAX(len, max);
1723 static int data_src__fprintf(u64 data_src, FILE *fp)
1725 struct mem_info mi = { .data_src.val = data_src };
1731 perf_script__meminfo_scnprintf(decode, 100, &mi);
1733 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1737 return fprintf(fp, "%-*s", maxlen, out);
1741 struct perf_sample *sample;
1742 struct thread *thread;
1743 struct evsel *evsel;
1747 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1748 void *ctx, const char *color,
1750 const char *unit, double val)
1752 struct metric_ctx *mctx = ctx;
1756 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1757 PERF_RECORD_SAMPLE, mctx->fp);
1758 fputs("\tmetric: ", mctx->fp);
1760 color_fprintf(mctx->fp, color, fmt, val);
1763 fprintf(mctx->fp, " %s\n", unit);
1766 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1769 struct metric_ctx *mctx = ctx;
1771 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1772 PERF_RECORD_SAMPLE, mctx->fp);
1773 fputs("\tmetric: ", mctx->fp);
1776 static void perf_sample__fprint_metric(struct perf_script *script,
1777 struct thread *thread,
1778 struct evsel *evsel,
1779 struct perf_sample *sample,
1782 struct perf_stat_output_ctx ctx = {
1783 .print_metric = script_print_metric,
1784 .new_line = script_new_line,
1785 .ctx = &(struct metric_ctx) {
1791 .force_header = false,
1797 perf_evlist__alloc_stats(script->session->evlist, false);
1798 if (evsel_script(evsel->leader)->gnum++ == 0)
1799 perf_stat__reset_shadow_stats();
1800 val = sample->period * evsel->scale;
1801 perf_stat__update_shadow_stats(evsel,
1805 evsel_script(evsel)->val = val;
1806 if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1807 for_each_group_member (ev2, evsel->leader) {
1808 perf_stat__print_shadow_stats(&stat_config, ev2,
1809 evsel_script(ev2)->val,
1815 evsel_script(evsel->leader)->gnum = 0;
1819 static bool show_event(struct perf_sample *sample,
1820 struct evsel *evsel,
1821 struct thread *thread,
1822 struct addr_location *al)
1824 int depth = thread_stack__depth(thread, sample->cpu);
1826 if (!symbol_conf.graph_function)
1829 if (thread->filter) {
1830 if (depth <= thread->filter_entry_depth) {
1831 thread->filter = false;
1836 const char *s = symbol_conf.graph_function;
1838 const char *name = resolve_branch_sym(sample, evsel, thread, al,
1844 nlen = strlen(name);
1846 unsigned len = strcspn(s, ",");
1847 if (nlen == len && !strncmp(name, s, len)) {
1848 thread->filter = true;
1849 thread->filter_entry_depth = depth;
1860 static void process_event(struct perf_script *script,
1861 struct perf_sample *sample, struct evsel *evsel,
1862 struct addr_location *al,
1863 struct machine *machine)
1865 struct thread *thread = al->thread;
1866 struct perf_event_attr *attr = &evsel->core.attr;
1867 unsigned int type = output_type(attr->type);
1868 struct evsel_script *es = evsel->priv;
1871 if (output[type].fields == 0)
1874 if (!show_event(sample, evsel, thread, al))
1877 if (evswitch__discard(&script->evswitch, evsel))
1882 perf_sample__fprintf_start(sample, thread, evsel,
1883 PERF_RECORD_SAMPLE, fp);
1885 if (PRINT_FIELD(PERIOD))
1886 fprintf(fp, "%10" PRIu64 " ", sample->period);
1888 if (PRINT_FIELD(EVNAME)) {
1889 const char *evname = perf_evsel__name(evsel);
1891 if (!script->name_width)
1892 script->name_width = perf_evlist__max_name_len(script->session->evlist);
1894 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1898 perf_sample__fprintf_flags(sample->flags, fp);
1900 if (is_bts_event(attr)) {
1901 perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1905 if (PRINT_FIELD(TRACE) && sample->raw_data) {
1906 event_format__fprintf(evsel->tp_format, sample->cpu,
1907 sample->raw_data, sample->raw_size, fp);
1910 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1911 perf_sample__fprintf_synth(sample, evsel, fp);
1913 if (PRINT_FIELD(ADDR))
1914 perf_sample__fprintf_addr(sample, thread, attr, fp);
1916 if (PRINT_FIELD(DATA_SRC))
1917 data_src__fprintf(sample->data_src, fp);
1919 if (PRINT_FIELD(WEIGHT))
1920 fprintf(fp, "%16" PRIu64, sample->weight);
1922 if (PRINT_FIELD(IP)) {
1923 struct callchain_cursor *cursor = NULL;
1925 if (script->stitch_lbr)
1926 al->thread->lbr_stitch_enable = true;
1928 if (symbol_conf.use_callchain && sample->callchain &&
1929 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1930 sample, NULL, NULL, scripting_max_stack) == 0)
1931 cursor = &callchain_cursor;
1933 fputc(cursor ? '\n' : ' ', fp);
1934 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
1935 symbol_conf.bt_stop_list, fp);
1938 if (PRINT_FIELD(IREGS))
1939 perf_sample__fprintf_iregs(sample, attr, fp);
1941 if (PRINT_FIELD(UREGS))
1942 perf_sample__fprintf_uregs(sample, attr, fp);
1944 if (PRINT_FIELD(BRSTACK))
1945 perf_sample__fprintf_brstack(sample, thread, attr, fp);
1946 else if (PRINT_FIELD(BRSTACKSYM))
1947 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1948 else if (PRINT_FIELD(BRSTACKOFF))
1949 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
1951 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1952 perf_sample__fprintf_bpf_output(sample, fp);
1953 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1955 if (PRINT_FIELD(PHYS_ADDR))
1956 fprintf(fp, "%16" PRIx64, sample->phys_addr);
1958 perf_sample__fprintf_ipc(sample, attr, fp);
1962 if (PRINT_FIELD(SRCCODE)) {
1963 if (map__fprintf_srccode(al->map, al->addr, stdout,
1964 &thread->srccode_state))
1968 if (PRINT_FIELD(METRIC))
1969 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
1975 static struct scripting_ops *scripting_ops;
1977 static void __process_stat(struct evsel *counter, u64 tstamp)
1979 int nthreads = perf_thread_map__nr(counter->core.threads);
1980 int ncpus = evsel__nr_cpus(counter);
1982 static int header_printed;
1984 if (counter->core.system_wide)
1987 if (!header_printed) {
1988 printf("%3s %8s %15s %15s %15s %15s %s\n",
1989 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
1993 for (thread = 0; thread < nthreads; thread++) {
1994 for (cpu = 0; cpu < ncpus; cpu++) {
1995 struct perf_counts_values *counts;
1997 counts = perf_counts(counter->counts, cpu, thread);
1999 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2000 counter->core.cpus->map[cpu],
2001 perf_thread_map__pid(counter->core.threads, thread),
2006 perf_evsel__name(counter));
2011 static void process_stat(struct evsel *counter, u64 tstamp)
2013 if (scripting_ops && scripting_ops->process_stat)
2014 scripting_ops->process_stat(&stat_config, counter, tstamp);
2016 __process_stat(counter, tstamp);
2019 static void process_stat_interval(u64 tstamp)
2021 if (scripting_ops && scripting_ops->process_stat_interval)
2022 scripting_ops->process_stat_interval(tstamp);
2025 static void setup_scripting(void)
2027 setup_perl_scripting();
2028 setup_python_scripting();
2031 static int flush_scripting(void)
2033 return scripting_ops ? scripting_ops->flush_script() : 0;
2036 static int cleanup_scripting(void)
2038 pr_debug("\nperf script stopped\n");
2040 return scripting_ops ? scripting_ops->stop_script() : 0;
2043 static bool filter_cpu(struct perf_sample *sample)
2045 if (cpu_list && sample->cpu != (u32)-1)
2046 return !test_bit(sample->cpu, cpu_bitmap);
2050 static int process_sample_event(struct perf_tool *tool,
2051 union perf_event *event,
2052 struct perf_sample *sample,
2053 struct evsel *evsel,
2054 struct machine *machine)
2056 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2057 struct addr_location al;
2059 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2065 if (sample->time < last_timestamp) {
2066 pr_err("Samples misordered, previous: %" PRIu64
2067 " this: %" PRIu64 "\n", last_timestamp,
2071 last_timestamp = sample->time;
2075 if (machine__resolve(machine, &al, sample) < 0) {
2076 pr_err("problem processing %d event, skipping it.\n",
2077 event->header.type);
2084 if (filter_cpu(sample))
2088 scripting_ops->process_event(event, sample, evsel, &al);
2090 process_event(scr, sample, evsel, &al, machine);
2093 addr_location__put(&al);
2097 static int process_attr(struct perf_tool *tool, union perf_event *event,
2098 struct evlist **pevlist)
2100 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2101 struct evlist *evlist;
2102 struct evsel *evsel, *pos;
2104 static struct evsel_script *es;
2106 err = perf_event__process_attr(tool, event, pevlist);
2111 evsel = evlist__last(*pevlist);
2114 if (scr->per_event_dump) {
2115 evsel->priv = perf_evsel_script__new(evsel,
2116 scr->session->data);
2118 es = zalloc(sizeof(*es));
2126 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2127 evsel->core.attr.type != PERF_TYPE_SYNTH)
2130 evlist__for_each_entry(evlist, pos) {
2131 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2135 set_print_ip_opts(&evsel->core.attr);
2137 if (evsel->core.attr.sample_type)
2138 err = perf_evsel__check_attr(evsel, scr->session);
2143 static int print_event_with_time(struct perf_tool *tool,
2144 union perf_event *event,
2145 struct perf_sample *sample,
2146 struct machine *machine,
2147 pid_t pid, pid_t tid, u64 timestamp)
2149 struct perf_script *script = container_of(tool, struct perf_script, tool);
2150 struct perf_session *session = script->session;
2151 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2152 struct thread *thread = NULL;
2154 if (evsel && !evsel->core.attr.sample_id_all) {
2156 sample->time = timestamp;
2161 if (filter_cpu(sample))
2165 thread = machine__findnew_thread(machine, pid, tid);
2167 if (thread && evsel) {
2168 perf_sample__fprintf_start(sample, thread, evsel,
2169 event->header.type, stdout);
2172 perf_event__fprintf(event, stdout);
2174 thread__put(thread);
2179 static int print_event(struct perf_tool *tool, union perf_event *event,
2180 struct perf_sample *sample, struct machine *machine,
2181 pid_t pid, pid_t tid)
2183 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2186 static int process_comm_event(struct perf_tool *tool,
2187 union perf_event *event,
2188 struct perf_sample *sample,
2189 struct machine *machine)
2191 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2194 return print_event(tool, event, sample, machine, event->comm.pid,
2198 static int process_namespaces_event(struct perf_tool *tool,
2199 union perf_event *event,
2200 struct perf_sample *sample,
2201 struct machine *machine)
2203 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2206 return print_event(tool, event, sample, machine, event->namespaces.pid,
2207 event->namespaces.tid);
2210 static int process_cgroup_event(struct perf_tool *tool,
2211 union perf_event *event,
2212 struct perf_sample *sample,
2213 struct machine *machine)
2215 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2218 return print_event(tool, event, sample, machine, sample->pid,
2222 static int process_fork_event(struct perf_tool *tool,
2223 union perf_event *event,
2224 struct perf_sample *sample,
2225 struct machine *machine)
2227 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2230 return print_event_with_time(tool, event, sample, machine,
2231 event->fork.pid, event->fork.tid,
2234 static int process_exit_event(struct perf_tool *tool,
2235 union perf_event *event,
2236 struct perf_sample *sample,
2237 struct machine *machine)
2239 /* Print before 'exit' deletes anything */
2240 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2241 event->fork.tid, event->fork.time))
2244 return perf_event__process_exit(tool, event, sample, machine);
2247 static int process_mmap_event(struct perf_tool *tool,
2248 union perf_event *event,
2249 struct perf_sample *sample,
2250 struct machine *machine)
2252 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2255 return print_event(tool, event, sample, machine, event->mmap.pid,
2259 static int process_mmap2_event(struct perf_tool *tool,
2260 union perf_event *event,
2261 struct perf_sample *sample,
2262 struct machine *machine)
2264 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2267 return print_event(tool, event, sample, machine, event->mmap2.pid,
2271 static int process_switch_event(struct perf_tool *tool,
2272 union perf_event *event,
2273 struct perf_sample *sample,
2274 struct machine *machine)
2276 struct perf_script *script = container_of(tool, struct perf_script, tool);
2278 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2281 if (scripting_ops && scripting_ops->process_switch)
2282 scripting_ops->process_switch(event, sample, machine);
2284 if (!script->show_switch_events)
2287 return print_event(tool, event, sample, machine, sample->pid,
2292 process_lost_event(struct perf_tool *tool,
2293 union perf_event *event,
2294 struct perf_sample *sample,
2295 struct machine *machine)
2297 return print_event(tool, event, sample, machine, sample->pid,
2302 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2303 union perf_event *event,
2304 struct ordered_events *oe __maybe_unused)
2307 perf_event__fprintf(event, stdout);
2312 process_bpf_events(struct perf_tool *tool __maybe_unused,
2313 union perf_event *event,
2314 struct perf_sample *sample,
2315 struct machine *machine)
2317 if (machine__process_ksymbol(machine, event, sample) < 0)
2320 return print_event(tool, event, sample, machine, sample->pid,
2324 static void sig_handler(int sig __maybe_unused)
2329 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2331 struct evlist *evlist = script->session->evlist;
2332 struct evsel *evsel;
2334 evlist__for_each_entry(evlist, evsel) {
2337 perf_evsel_script__delete(evsel->priv);
2342 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2344 struct evsel *evsel;
2346 evlist__for_each_entry(script->session->evlist, evsel) {
2348 * Already setup? I.e. we may be called twice in cases like
2349 * Intel PT, one for the intel_pt// and dummy events, then
2350 * for the evsels syntheized from the auxtrace info.
2352 * Ses perf_script__process_auxtrace_info.
2354 if (evsel->priv != NULL)
2357 evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2358 if (evsel->priv == NULL)
2359 goto out_err_fclose;
2365 perf_script__fclose_per_event_dump(script);
2369 static int perf_script__setup_per_event_dump(struct perf_script *script)
2371 struct evsel *evsel;
2372 static struct evsel_script es_stdout;
2374 if (script->per_event_dump)
2375 return perf_script__fopen_per_event_dump(script);
2377 es_stdout.fp = stdout;
2379 evlist__for_each_entry(script->session->evlist, evsel)
2380 evsel->priv = &es_stdout;
2385 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2387 struct evsel *evsel;
2389 evlist__for_each_entry(script->session->evlist, evsel) {
2390 struct evsel_script *es = evsel->priv;
2392 perf_evsel_script__fprintf(es, stdout);
2393 perf_evsel_script__delete(es);
2398 static int __cmd_script(struct perf_script *script)
2402 signal(SIGINT, sig_handler);
2404 perf_stat__init_shadow_stats();
2406 /* override event processing functions */
2407 if (script->show_task_events) {
2408 script->tool.comm = process_comm_event;
2409 script->tool.fork = process_fork_event;
2410 script->tool.exit = process_exit_event;
2412 if (script->show_mmap_events) {
2413 script->tool.mmap = process_mmap_event;
2414 script->tool.mmap2 = process_mmap2_event;
2416 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2417 script->tool.context_switch = process_switch_event;
2418 if (script->show_namespace_events)
2419 script->tool.namespaces = process_namespaces_event;
2420 if (script->show_cgroup_events)
2421 script->tool.cgroup = process_cgroup_event;
2422 if (script->show_lost_events)
2423 script->tool.lost = process_lost_event;
2424 if (script->show_round_events) {
2425 script->tool.ordered_events = false;
2426 script->tool.finished_round = process_finished_round_event;
2428 if (script->show_bpf_events) {
2429 script->tool.ksymbol = process_bpf_events;
2430 script->tool.bpf = process_bpf_events;
2433 if (perf_script__setup_per_event_dump(script)) {
2434 pr_err("Couldn't create the per event dump files\n");
2438 ret = perf_session__process_events(script->session);
2440 if (script->per_event_dump)
2441 perf_script__exit_per_event_dump_stats(script);
2444 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2449 struct script_spec {
2450 struct list_head node;
2451 struct scripting_ops *ops;
2455 static LIST_HEAD(script_specs);
2457 static struct script_spec *script_spec__new(const char *spec,
2458 struct scripting_ops *ops)
2460 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2463 strcpy(s->spec, spec);
2470 static void script_spec__add(struct script_spec *s)
2472 list_add_tail(&s->node, &script_specs);
2475 static struct script_spec *script_spec__find(const char *spec)
2477 struct script_spec *s;
2479 list_for_each_entry(s, &script_specs, node)
2480 if (strcasecmp(s->spec, spec) == 0)
2485 int script_spec_register(const char *spec, struct scripting_ops *ops)
2487 struct script_spec *s;
2489 s = script_spec__find(spec);
2493 s = script_spec__new(spec, ops);
2497 script_spec__add(s);
2502 static struct scripting_ops *script_spec__lookup(const char *spec)
2504 struct script_spec *s = script_spec__find(spec);
2511 static void list_available_languages(void)
2513 struct script_spec *s;
2515 fprintf(stderr, "\n");
2516 fprintf(stderr, "Scripting language extensions (used in "
2517 "perf script -s [spec:]script.[spec]):\n\n");
2519 list_for_each_entry(s, &script_specs, node)
2520 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2522 fprintf(stderr, "\n");
2525 static int parse_scriptname(const struct option *opt __maybe_unused,
2526 const char *str, int unset __maybe_unused)
2528 char spec[PATH_MAX];
2529 const char *script, *ext;
2532 if (strcmp(str, "lang") == 0) {
2533 list_available_languages();
2537 script = strchr(str, ':');
2540 if (len >= PATH_MAX) {
2541 fprintf(stderr, "invalid language specifier");
2544 strncpy(spec, str, len);
2546 scripting_ops = script_spec__lookup(spec);
2547 if (!scripting_ops) {
2548 fprintf(stderr, "invalid language specifier");
2554 ext = strrchr(script, '.');
2556 fprintf(stderr, "invalid script extension");
2559 scripting_ops = script_spec__lookup(++ext);
2560 if (!scripting_ops) {
2561 fprintf(stderr, "invalid script extension");
2566 script_name = strdup(script);
2571 static int parse_output_fields(const struct option *opt __maybe_unused,
2572 const char *arg, int unset __maybe_unused)
2574 char *tok, *strtok_saveptr = NULL;
2575 int i, imax = ARRAY_SIZE(all_output_options);
2578 char *str = strdup(arg);
2580 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2585 /* first word can state for which event type the user is specifying
2586 * the fields. If no type exists, the specified fields apply to all
2587 * event types found in the file minus the invalid fields for a type.
2589 tok = strchr(str, ':');
2593 if (!strcmp(str, "hw"))
2594 type = PERF_TYPE_HARDWARE;
2595 else if (!strcmp(str, "sw"))
2596 type = PERF_TYPE_SOFTWARE;
2597 else if (!strcmp(str, "trace"))
2598 type = PERF_TYPE_TRACEPOINT;
2599 else if (!strcmp(str, "raw"))
2600 type = PERF_TYPE_RAW;
2601 else if (!strcmp(str, "break"))
2602 type = PERF_TYPE_BREAKPOINT;
2603 else if (!strcmp(str, "synth"))
2604 type = OUTPUT_TYPE_SYNTH;
2606 fprintf(stderr, "Invalid event type in field string.\n");
2611 if (output[type].user_set)
2612 pr_warning("Overriding previous field request for %s events.\n",
2615 /* Don't override defaults for +- */
2616 if (strchr(tok, '+') || strchr(tok, '-'))
2619 output[type].fields = 0;
2620 output[type].user_set = true;
2621 output[type].wildcard_set = false;
2625 if (strlen(str) == 0) {
2627 "Cannot set fields to 'none' for all event types.\n");
2632 /* Don't override defaults for +- */
2633 if (strchr(str, '+') || strchr(str, '-'))
2636 if (output_set_by_user())
2637 pr_warning("Overriding previous field request for all events.\n");
2639 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2640 output[j].fields = 0;
2641 output[j].user_set = true;
2642 output[j].wildcard_set = true;
2647 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2653 } else if (*tok == '-') {
2659 if (change != SET && change != DEFAULT)
2664 for (i = 0; i < imax; ++i) {
2665 if (strcmp(tok, all_output_options[i].str) == 0)
2668 if (i == imax && strcmp(tok, "flags") == 0) {
2669 print_flags = change == REMOVE ? false : true;
2673 fprintf(stderr, "Invalid field requested.\n");
2679 /* add user option to all events types for
2682 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2683 if (output[j].invalid_fields & all_output_options[i].field) {
2684 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2685 all_output_options[i].str, event_type(j));
2687 if (change == REMOVE) {
2688 output[j].fields &= ~all_output_options[i].field;
2689 output[j].user_set_fields &= ~all_output_options[i].field;
2691 output[j].fields |= all_output_options[i].field;
2692 output[j].user_set_fields |= all_output_options[i].field;
2694 output[j].user_set = true;
2695 output[j].wildcard_set = true;
2699 if (output[type].invalid_fields & all_output_options[i].field) {
2700 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2701 all_output_options[i].str, event_type(type));
2706 if (change == REMOVE)
2707 output[type].fields &= ~all_output_options[i].field;
2709 output[type].fields |= all_output_options[i].field;
2710 output[type].user_set = true;
2711 output[type].wildcard_set = true;
2716 if (output[type].fields == 0) {
2717 pr_debug("No fields requested for %s type. "
2718 "Events will not be displayed.\n", event_type(type));
2724 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2731 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2732 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2733 if ((lang_dirent->d_type == DT_DIR || \
2734 (lang_dirent->d_type == DT_UNKNOWN && \
2735 is_directory(scripts_path, lang_dirent))) && \
2736 (strcmp(lang_dirent->d_name, ".")) && \
2737 (strcmp(lang_dirent->d_name, "..")))
2739 #define for_each_script(lang_path, lang_dir, script_dirent) \
2740 while ((script_dirent = readdir(lang_dir)) != NULL) \
2741 if (script_dirent->d_type != DT_DIR && \
2742 (script_dirent->d_type != DT_UNKNOWN || \
2743 !is_directory(lang_path, script_dirent)))
2746 #define RECORD_SUFFIX "-record"
2747 #define REPORT_SUFFIX "-report"
2749 struct script_desc {
2750 struct list_head node;
2756 static LIST_HEAD(script_descs);
2758 static struct script_desc *script_desc__new(const char *name)
2760 struct script_desc *s = zalloc(sizeof(*s));
2762 if (s != NULL && name)
2763 s->name = strdup(name);
2768 static void script_desc__delete(struct script_desc *s)
2771 zfree(&s->half_liner);
2776 static void script_desc__add(struct script_desc *s)
2778 list_add_tail(&s->node, &script_descs);
2781 static struct script_desc *script_desc__find(const char *name)
2783 struct script_desc *s;
2785 list_for_each_entry(s, &script_descs, node)
2786 if (strcasecmp(s->name, name) == 0)
2791 static struct script_desc *script_desc__findnew(const char *name)
2793 struct script_desc *s = script_desc__find(name);
2798 s = script_desc__new(name);
2802 script_desc__add(s);
2807 static const char *ends_with(const char *str, const char *suffix)
2809 size_t suffix_len = strlen(suffix);
2810 const char *p = str;
2812 if (strlen(str) > suffix_len) {
2813 p = str + strlen(str) - suffix_len;
2814 if (!strncmp(p, suffix, suffix_len))
2821 static int read_script_info(struct script_desc *desc, const char *filename)
2823 char line[BUFSIZ], *p;
2826 fp = fopen(filename, "r");
2830 while (fgets(line, sizeof(line), fp)) {
2831 p = skip_spaces(line);
2837 if (strlen(p) && *p == '!')
2841 if (strlen(p) && p[strlen(p) - 1] == '\n')
2842 p[strlen(p) - 1] = '\0';
2844 if (!strncmp(p, "description:", strlen("description:"))) {
2845 p += strlen("description:");
2846 desc->half_liner = strdup(skip_spaces(p));
2850 if (!strncmp(p, "args:", strlen("args:"))) {
2851 p += strlen("args:");
2852 desc->args = strdup(skip_spaces(p));
2862 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2864 char *script_root, *str;
2866 script_root = strdup(script_dirent->d_name);
2870 str = (char *)ends_with(script_root, suffix);
2880 static int list_available_scripts(const struct option *opt __maybe_unused,
2881 const char *s __maybe_unused,
2882 int unset __maybe_unused)
2884 struct dirent *script_dirent, *lang_dirent;
2885 char scripts_path[MAXPATHLEN];
2886 DIR *scripts_dir, *lang_dir;
2887 char script_path[MAXPATHLEN];
2888 char lang_path[MAXPATHLEN];
2889 struct script_desc *desc;
2890 char first_half[BUFSIZ];
2893 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2895 scripts_dir = opendir(scripts_path);
2898 "open(%s) failed.\n"
2899 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2904 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2905 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2906 lang_dirent->d_name);
2907 lang_dir = opendir(lang_path);
2911 for_each_script(lang_path, lang_dir, script_dirent) {
2912 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
2914 desc = script_desc__findnew(script_root);
2915 scnprintf(script_path, MAXPATHLEN, "%s/%s",
2916 lang_path, script_dirent->d_name);
2917 read_script_info(desc, script_path);
2923 fprintf(stdout, "List of available trace scripts:\n");
2924 list_for_each_entry(desc, &script_descs, node) {
2925 sprintf(first_half, "%s %s", desc->name,
2926 desc->args ? desc->args : "");
2927 fprintf(stdout, " %-36s %s\n", first_half,
2928 desc->half_liner ? desc->half_liner : "");
2935 * Some scripts specify the required events in their "xxx-record" file,
2936 * this function will check if the events in perf.data match those
2937 * mentioned in the "xxx-record".
2939 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
2940 * which is covered well now. And new parsing code should be added to
2941 * cover the future complexing formats like event groups etc.
2943 static int check_ev_match(char *dir_name, char *scriptname,
2944 struct perf_session *session)
2946 char filename[MAXPATHLEN], evname[128];
2947 char line[BUFSIZ], *p;
2952 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
2954 fp = fopen(filename, "r");
2958 while (fgets(line, sizeof(line), fp)) {
2959 p = skip_spaces(line);
2964 p = strstr(p, "-e");
2970 len = strcspn(p, " \t");
2974 snprintf(evname, len + 1, "%s", p);
2977 evlist__for_each_entry(session->evlist, pos) {
2978 if (!strcmp(perf_evsel__name(pos), evname)) {
2996 * Return -1 if none is found, otherwise the actual scripts number.
2998 * Currently the only user of this function is the script browser, which
2999 * will list all statically runnable scripts, select one, execute it and
3000 * show the output in a perf browser.
3002 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3005 struct dirent *script_dirent, *lang_dirent;
3006 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3007 DIR *scripts_dir, *lang_dir;
3008 struct perf_session *session;
3009 struct perf_data data = {
3011 .mode = PERF_DATA_MODE_READ,
3016 session = perf_session__new(&data, false, NULL);
3017 if (IS_ERR(session))
3018 return PTR_ERR(session);
3020 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3022 scripts_dir = opendir(scripts_path);
3024 perf_session__delete(session);
3028 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3029 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3030 lang_dirent->d_name);
3031 #ifndef HAVE_LIBPERL_SUPPORT
3032 if (strstr(lang_path, "perl"))
3035 #ifndef HAVE_LIBPYTHON_SUPPORT
3036 if (strstr(lang_path, "python"))
3040 lang_dir = opendir(lang_path);
3044 for_each_script(lang_path, lang_dir, script_dirent) {
3045 /* Skip those real time scripts: xxxtop.p[yl] */
3046 if (strstr(script_dirent->d_name, "top."))
3050 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3052 script_dirent->d_name);
3053 temp = strchr(script_dirent->d_name, '.');
3054 snprintf(scripts_array[i],
3055 (temp - script_dirent->d_name) + 1,
3056 "%s", script_dirent->d_name);
3058 if (check_ev_match(lang_path,
3059 scripts_array[i], session))
3067 closedir(scripts_dir);
3068 perf_session__delete(session);
3072 static char *get_script_path(const char *script_root, const char *suffix)
3074 struct dirent *script_dirent, *lang_dirent;
3075 char scripts_path[MAXPATHLEN];
3076 char script_path[MAXPATHLEN];
3077 DIR *scripts_dir, *lang_dir;
3078 char lang_path[MAXPATHLEN];
3079 char *__script_root;
3081 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3083 scripts_dir = opendir(scripts_path);
3087 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3088 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3089 lang_dirent->d_name);
3090 lang_dir = opendir(lang_path);
3094 for_each_script(lang_path, lang_dir, script_dirent) {
3095 __script_root = get_script_root(script_dirent, suffix);
3096 if (__script_root && !strcmp(script_root, __script_root)) {
3097 free(__script_root);
3098 closedir(scripts_dir);
3099 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3100 lang_path, script_dirent->d_name);
3102 return strdup(script_path);
3104 free(__script_root);
3108 closedir(scripts_dir);
3113 static bool is_top_script(const char *script_path)
3115 return ends_with(script_path, "top") == NULL ? false : true;
3118 static int has_required_arg(char *script_path)
3120 struct script_desc *desc;
3124 desc = script_desc__new(NULL);
3126 if (read_script_info(desc, script_path))
3132 for (p = desc->args; *p; p++)
3136 script_desc__delete(desc);
3141 static int have_cmd(int argc, const char **argv)
3143 char **__argv = malloc(sizeof(const char *) * argc);
3146 pr_err("malloc failed\n");
3150 memcpy(__argv, argv, sizeof(const char *) * argc);
3151 argc = parse_options(argc, (const char **)__argv, record_options,
3152 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3155 system_wide = (argc == 0);
3160 static void script__setup_sample_type(struct perf_script *script)
3162 struct perf_session *session = script->session;
3163 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
3165 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3166 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3167 (sample_type & PERF_SAMPLE_STACK_USER)) {
3168 callchain_param.record_mode = CALLCHAIN_DWARF;
3169 dwarf_callchain_users = true;
3170 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3171 callchain_param.record_mode = CALLCHAIN_LBR;
3173 callchain_param.record_mode = CALLCHAIN_FP;
3176 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3177 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3178 "Please apply --call-graph lbr when recording.\n");
3179 script->stitch_lbr = false;
3183 static int process_stat_round_event(struct perf_session *session,
3184 union perf_event *event)
3186 struct perf_record_stat_round *round = &event->stat_round;
3187 struct evsel *counter;
3189 evlist__for_each_entry(session->evlist, counter) {
3190 perf_stat_process_counter(&stat_config, counter);
3191 process_stat(counter, round->time);
3194 process_stat_interval(round->time);
3198 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3199 union perf_event *event)
3201 perf_event__read_stat_config(&stat_config, &event->stat_config);
3205 static int set_maps(struct perf_script *script)
3207 struct evlist *evlist = script->session->evlist;
3209 if (!script->cpus || !script->threads)
3212 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3215 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3217 if (perf_evlist__alloc_stats(evlist, true))
3220 script->allocated = true;
3225 int process_thread_map_event(struct perf_session *session,
3226 union perf_event *event)
3228 struct perf_tool *tool = session->tool;
3229 struct perf_script *script = container_of(tool, struct perf_script, tool);
3231 if (script->threads) {
3232 pr_warning("Extra thread map event, ignoring.\n");
3236 script->threads = thread_map__new_event(&event->thread_map);
3237 if (!script->threads)
3240 return set_maps(script);
3244 int process_cpu_map_event(struct perf_session *session,
3245 union perf_event *event)
3247 struct perf_tool *tool = session->tool;
3248 struct perf_script *script = container_of(tool, struct perf_script, tool);
3251 pr_warning("Extra cpu map event, ignoring.\n");
3255 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3259 return set_maps(script);
3262 static int process_feature_event(struct perf_session *session,
3263 union perf_event *event)
3265 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3266 return perf_event__process_feature(session, event);
3270 #ifdef HAVE_AUXTRACE_SUPPORT
3271 static int perf_script__process_auxtrace_info(struct perf_session *session,
3272 union perf_event *event)
3274 struct perf_tool *tool = session->tool;
3276 int ret = perf_event__process_auxtrace_info(session, event);
3279 struct perf_script *script = container_of(tool, struct perf_script, tool);
3281 ret = perf_script__setup_per_event_dump(script);
3287 #define perf_script__process_auxtrace_info 0
3290 static int parse_insn_trace(const struct option *opt __maybe_unused,
3291 const char *str __maybe_unused,
3292 int unset __maybe_unused)
3294 parse_output_fields(NULL, "+insn,-event,-period", 0);
3295 itrace_parse_synth_opts(opt, "i0ns", 0);
3296 symbol_conf.nanosecs = true;
3300 static int parse_xed(const struct option *opt __maybe_unused,
3301 const char *str __maybe_unused,
3302 int unset __maybe_unused)
3304 force_pager("xed -F insn: -A -64 | less");
3308 static int parse_call_trace(const struct option *opt __maybe_unused,
3309 const char *str __maybe_unused,
3310 int unset __maybe_unused)
3312 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3313 itrace_parse_synth_opts(opt, "cewp", 0);
3314 symbol_conf.nanosecs = true;
3315 symbol_conf.pad_output_len_dso = 50;
3319 static int parse_callret_trace(const struct option *opt __maybe_unused,
3320 const char *str __maybe_unused,
3321 int unset __maybe_unused)
3323 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3324 itrace_parse_synth_opts(opt, "crewp", 0);
3325 symbol_conf.nanosecs = true;
3329 int cmd_script(int argc, const char **argv)
3331 bool show_full_info = false;
3332 bool header = false;
3333 bool header_only = false;
3334 bool script_started = false;
3335 char *rec_script_path = NULL;
3336 char *rep_script_path = NULL;
3337 struct perf_session *session;
3338 struct itrace_synth_opts itrace_synth_opts = {
3340 .default_no_sample = true,
3343 char *script_path = NULL;
3344 const char **__argv;
3346 struct perf_script script = {
3348 .sample = process_sample_event,
3349 .mmap = perf_event__process_mmap,
3350 .mmap2 = perf_event__process_mmap2,
3351 .comm = perf_event__process_comm,
3352 .namespaces = perf_event__process_namespaces,
3353 .cgroup = perf_event__process_cgroup,
3354 .exit = perf_event__process_exit,
3355 .fork = perf_event__process_fork,
3356 .attr = process_attr,
3357 .event_update = perf_event__process_event_update,
3358 .tracing_data = perf_event__process_tracing_data,
3359 .feature = process_feature_event,
3360 .build_id = perf_event__process_build_id,
3361 .id_index = perf_event__process_id_index,
3362 .auxtrace_info = perf_script__process_auxtrace_info,
3363 .auxtrace = perf_event__process_auxtrace,
3364 .auxtrace_error = perf_event__process_auxtrace_error,
3365 .stat = perf_event__process_stat_event,
3366 .stat_round = process_stat_round_event,
3367 .stat_config = process_stat_config_event,
3368 .thread_map = process_thread_map_event,
3369 .cpu_map = process_cpu_map_event,
3370 .ordered_events = true,
3371 .ordering_requires_timestamps = true,
3374 struct perf_data data = {
3375 .mode = PERF_DATA_MODE_READ,
3377 const struct option options[] = {
3378 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3379 "dump raw trace in ASCII"),
3380 OPT_INCR('v', "verbose", &verbose,
3381 "be more verbose (show symbol address, etc)"),
3382 OPT_BOOLEAN('L', "Latency", &latency_format,
3383 "show latency attributes (irqs/preemption disabled, etc)"),
3384 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3385 list_available_scripts),
3386 OPT_CALLBACK('s', "script", NULL, "name",
3387 "script file name (lang:script name, script name, or *)",
3389 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3390 "generate perf-script.xx script in specified language"),
3391 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3392 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3393 "do various checks like samples ordering and lost events"),
3394 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3395 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3396 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3397 "file", "vmlinux pathname"),
3398 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3399 "file", "kallsyms pathname"),
3400 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3401 "When printing symbols do not display call chain"),
3402 OPT_CALLBACK(0, "symfs", NULL, "directory",
3403 "Look for files with symbols relative to this directory",
3404 symbol__config_symfs),
3405 OPT_CALLBACK('F', "fields", NULL, "str",
3406 "comma separated output fields prepend with 'type:'. "
3407 "+field to add and -field to remove."
3408 "Valid types: hw,sw,trace,raw,synth. "
3409 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3410 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3411 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3412 "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc",
3413 parse_output_fields),
3414 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3415 "system-wide collection from all CPUs"),
3416 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3417 "only consider these symbols"),
3418 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3419 "Decode instructions from itrace", parse_insn_trace),
3420 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3421 "Run xed disassembler on output", parse_xed),
3422 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3423 "Decode calls from from itrace", parse_call_trace),
3424 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3425 "Decode calls and returns from itrace", parse_callret_trace),
3426 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3427 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3428 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3429 "Stop display of callgraph at these symbols"),
3430 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3431 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3432 "only display events for these comms"),
3433 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3434 "only consider symbols in these pids"),
3435 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3436 "only consider symbols in these tids"),
3437 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3438 "Set the maximum stack depth when parsing the callchain, "
3439 "anything beyond the specified depth will be ignored. "
3440 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3441 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3442 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3443 OPT_BOOLEAN('I', "show-info", &show_full_info,
3444 "display extended information from perf.data file"),
3445 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3446 "Show the path of [kernel.kallsyms]"),
3447 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3448 "Show the fork/comm/exit events"),
3449 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3450 "Show the mmap events"),
3451 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3452 "Show context switch events (if recorded)"),
3453 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3454 "Show namespace events (if recorded)"),
3455 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3456 "Show cgroup events (if recorded)"),
3457 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3458 "Show lost events (if recorded)"),
3459 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3460 "Show round events (if recorded)"),
3461 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3462 "Show bpf related events (if recorded)"),
3463 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3464 "Dump trace output to files named by the monitored events"),
3465 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3466 OPT_INTEGER(0, "max-blocks", &max_blocks,
3467 "Maximum number of code blocks to dump with brstackinsn"),
3468 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3469 "Use 9 decimal places when displaying time"),
3470 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3471 "Instruction Tracing options\n" ITRACE_HELP,
3472 itrace_parse_synth_opts),
3473 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3474 "Show full source file name path for source lines"),
3475 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3476 "Enable symbol demangling"),
3477 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3478 "Enable kernel symbol demangling"),
3479 OPT_STRING(0, "time", &script.time_str, "str",
3480 "Time span of interest (start,stop)"),
3481 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3482 "Show inline function"),
3483 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3484 "guest mount directory under which every guest os"
3485 " instance has a subdir"),
3486 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3487 "file", "file saving guest os vmlinux"),
3488 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3489 "file", "file saving guest os /proc/kallsyms"),
3490 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3491 "file", "file saving guest os /proc/modules"),
3492 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3493 "Enable LBR callgraph stitching approach"),
3494 OPTS_EVSWITCH(&script.evswitch),
3497 const char * const script_subcommands[] = { "record", "report", NULL };
3498 const char *script_usage[] = {
3499 "perf script [<options>]",
3500 "perf script [<options>] record <script> [<record-options>] <command>",
3501 "perf script [<options>] report <script> [script-args]",
3502 "perf script [<options>] <script> [<record-options>] <command>",
3503 "perf script [<options>] <top-script> [script-args]",
3507 perf_set_singlethreaded();
3511 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3512 PARSE_OPT_STOP_AT_NON_OPTION);
3514 if (symbol_conf.guestmount ||
3515 symbol_conf.default_guest_vmlinux_name ||
3516 symbol_conf.default_guest_kallsyms ||
3517 symbol_conf.default_guest_modules) {
3519 * Enable guest sample processing.
3524 data.path = input_name;
3525 data.force = symbol_conf.force;
3527 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3528 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3529 if (!rec_script_path)
3530 return cmd_record(argc, argv);
3533 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3534 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3535 if (!rep_script_path) {
3537 "Please specify a valid report script"
3538 "(see 'perf script -l' for listing)\n");
3543 if (reltime && deltatime) {
3545 "reltime and deltatime - the two don't get along well. "
3546 "Please limit to --reltime or --deltatime.\n");
3550 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3551 itrace_synth_opts.callchain_sz > scripting_max_stack)
3552 scripting_max_stack = itrace_synth_opts.callchain_sz;
3554 /* make sure PERF_EXEC_PATH is set for scripts */
3555 set_argv_exec_path(get_argv_exec_path());
3557 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3562 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3563 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3565 if (!rec_script_path && !rep_script_path) {
3566 usage_with_options_msg(script_usage, options,
3567 "Couldn't find script `%s'\n\n See perf"
3568 " script -l for available scripts.\n", argv[0]);
3571 if (is_top_script(argv[0])) {
3572 rep_args = argc - 1;
3576 rep_args = has_required_arg(rep_script_path);
3577 rec_args = (argc - 1) - rep_args;
3579 usage_with_options_msg(script_usage, options,
3580 "`%s' script requires options."
3581 "\n\n See perf script -l for available "
3582 "scripts and options.\n", argv[0]);
3586 if (pipe(live_pipe) < 0) {
3587 perror("failed to create pipe");
3593 perror("failed to fork");
3600 dup2(live_pipe[1], 1);
3601 close(live_pipe[0]);
3603 if (is_top_script(argv[0])) {
3605 } else if (!system_wide) {
3606 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3612 __argv = malloc((argc + 6) * sizeof(const char *));
3614 pr_err("malloc failed\n");
3619 __argv[j++] = "/bin/sh";
3620 __argv[j++] = rec_script_path;
3626 for (i = rep_args + 1; i < argc; i++)
3627 __argv[j++] = argv[i];
3630 execvp("/bin/sh", (char **)__argv);
3635 dup2(live_pipe[0], 0);
3636 close(live_pipe[1]);
3638 __argv = malloc((argc + 4) * sizeof(const char *));
3640 pr_err("malloc failed\n");
3646 __argv[j++] = "/bin/sh";
3647 __argv[j++] = rep_script_path;
3648 for (i = 1; i < rep_args + 1; i++)
3649 __argv[j++] = argv[i];
3654 execvp("/bin/sh", (char **)__argv);
3659 if (rec_script_path)
3660 script_path = rec_script_path;
3661 if (rep_script_path)
3662 script_path = rep_script_path;
3667 if (!rec_script_path)
3668 system_wide = false;
3669 else if (!system_wide) {
3670 if (have_cmd(argc - 1, &argv[1]) != 0) {
3676 __argv = malloc((argc + 2) * sizeof(const char *));
3678 pr_err("malloc failed\n");
3683 __argv[j++] = "/bin/sh";
3684 __argv[j++] = script_path;
3687 for (i = 2; i < argc; i++)
3688 __argv[j++] = argv[i];
3691 execvp("/bin/sh", (char **)__argv);
3701 session = perf_session__new(&data, false, &script.tool);
3702 if (IS_ERR(session))
3703 return PTR_ERR(session);
3705 if (header || header_only) {
3706 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3707 perf_session__fprintf_info(session, stdout, show_full_info);
3712 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3714 if (symbol__init(&session->header.env) < 0)
3718 if (data.is_pipe || /* assume pipe_mode indicates native_arch */
3719 !strcmp(uts.machine, session->header.env.arch) ||
3720 (!strcmp(uts.machine, "x86_64") &&
3721 !strcmp(session->header.env.arch, "i386")))
3724 script.session = session;
3725 script__setup_sample_type(&script);
3727 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3728 symbol_conf.graph_function)
3729 itrace_synth_opts.thread_stack = true;
3731 session->itrace_synth_opts = &itrace_synth_opts;
3734 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3737 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3741 symbol_conf.use_callchain = true;
3743 symbol_conf.use_callchain = false;
3745 if (session->tevent.pevent &&
3746 tep_set_function_resolver(session->tevent.pevent,
3747 machine__resolve_kernel_addr,
3748 &session->machines.host) < 0) {
3749 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3754 if (generate_script_lang) {
3755 struct stat perf_stat;
3758 if (output_set_by_user()) {
3760 "custom fields not supported for generated scripts");
3765 input = open(data.path, O_RDONLY); /* input_name */
3768 perror("failed to open file");
3772 err = fstat(input, &perf_stat);
3774 perror("failed to stat file");
3778 if (!perf_stat.st_size) {
3779 fprintf(stderr, "zero-sized file, nothing to do!\n");
3783 scripting_ops = script_spec__lookup(generate_script_lang);
3784 if (!scripting_ops) {
3785 fprintf(stderr, "invalid language specifier");
3790 err = scripting_ops->generate_script(session->tevent.pevent,
3796 err = scripting_ops->start_script(script_name, argc, argv);
3799 pr_debug("perf script started with script %s\n\n", script_name);
3800 script_started = true;
3804 err = perf_session__check_output_opt(session);
3808 if (script.time_str) {
3809 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
3810 &script.ptime_range,
3817 itrace_synth_opts__set_time_range(&itrace_synth_opts,
3822 err = evswitch__init(&script.evswitch, session->evlist, stderr);
3826 err = __cmd_script(&script);
3831 if (script.ptime_range) {
3832 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3833 zfree(&script.ptime_range);
3836 perf_evlist__free_stats(session->evlist);
3837 perf_session__delete(session);
3840 cleanup_scripting();