1 // SPDX-License-Identifier: GPL-2.0
5 #include "util/cache.h"
6 #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/symbol.h"
15 #include "util/thread.h"
16 #include "util/trace-event.h"
17 #include "util/util.h"
18 #include "util/evlist.h"
19 #include "util/evsel.h"
20 #include "util/sort.h"
21 #include "util/data.h"
22 #include "util/auxtrace.h"
23 #include "util/cpumap.h"
24 #include "util/thread_map.h"
25 #include "util/stat.h"
26 #include "util/color.h"
27 #include "util/string2.h"
28 #include "util/thread-stack.h"
29 #include "util/time-utils.h"
30 #include "util/path.h"
31 #include "print_binary.h"
33 #include <linux/bitmap.h>
34 #include <linux/kernel.h>
35 #include <linux/stringify.h>
36 #include <linux/time64.h>
37 #include <sys/utsname.h>
39 #include "util/mem-events.h"
40 #include "util/dump-insn.h"
45 #include <sys/param.h>
46 #include <sys/types.h>
50 #include <subcmd/pager.h>
52 #include "sane_ctype.h"
54 static char const *script_name;
55 static char const *generate_script_lang;
57 static u64 initial_time;
58 static bool debug_mode;
59 static u64 last_timestamp;
60 static u64 nr_unordered;
61 static bool no_callchain;
62 static bool latency_format;
63 static bool system_wide;
64 static bool print_flags;
65 static const char *cpu_list;
66 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
67 static struct perf_stat_config stat_config;
68 static int max_blocks;
69 static bool native_arch;
71 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
73 enum perf_output_field {
74 PERF_OUTPUT_COMM = 1U << 0,
75 PERF_OUTPUT_TID = 1U << 1,
76 PERF_OUTPUT_PID = 1U << 2,
77 PERF_OUTPUT_TIME = 1U << 3,
78 PERF_OUTPUT_CPU = 1U << 4,
79 PERF_OUTPUT_EVNAME = 1U << 5,
80 PERF_OUTPUT_TRACE = 1U << 6,
81 PERF_OUTPUT_IP = 1U << 7,
82 PERF_OUTPUT_SYM = 1U << 8,
83 PERF_OUTPUT_DSO = 1U << 9,
84 PERF_OUTPUT_ADDR = 1U << 10,
85 PERF_OUTPUT_SYMOFFSET = 1U << 11,
86 PERF_OUTPUT_SRCLINE = 1U << 12,
87 PERF_OUTPUT_PERIOD = 1U << 13,
88 PERF_OUTPUT_IREGS = 1U << 14,
89 PERF_OUTPUT_BRSTACK = 1U << 15,
90 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
91 PERF_OUTPUT_DATA_SRC = 1U << 17,
92 PERF_OUTPUT_WEIGHT = 1U << 18,
93 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
94 PERF_OUTPUT_CALLINDENT = 1U << 20,
95 PERF_OUTPUT_INSN = 1U << 21,
96 PERF_OUTPUT_INSNLEN = 1U << 22,
97 PERF_OUTPUT_BRSTACKINSN = 1U << 23,
98 PERF_OUTPUT_BRSTACKOFF = 1U << 24,
99 PERF_OUTPUT_SYNTH = 1U << 25,
100 PERF_OUTPUT_PHYS_ADDR = 1U << 26,
101 PERF_OUTPUT_UREGS = 1U << 27,
102 PERF_OUTPUT_METRIC = 1U << 28,
103 PERF_OUTPUT_MISC = 1U << 29,
104 PERF_OUTPUT_SRCCODE = 1U << 30,
107 struct output_option {
109 enum perf_output_field field;
110 } all_output_options[] = {
111 {.str = "comm", .field = PERF_OUTPUT_COMM},
112 {.str = "tid", .field = PERF_OUTPUT_TID},
113 {.str = "pid", .field = PERF_OUTPUT_PID},
114 {.str = "time", .field = PERF_OUTPUT_TIME},
115 {.str = "cpu", .field = PERF_OUTPUT_CPU},
116 {.str = "event", .field = PERF_OUTPUT_EVNAME},
117 {.str = "trace", .field = PERF_OUTPUT_TRACE},
118 {.str = "ip", .field = PERF_OUTPUT_IP},
119 {.str = "sym", .field = PERF_OUTPUT_SYM},
120 {.str = "dso", .field = PERF_OUTPUT_DSO},
121 {.str = "addr", .field = PERF_OUTPUT_ADDR},
122 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
123 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
124 {.str = "period", .field = PERF_OUTPUT_PERIOD},
125 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
126 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
127 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
128 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
129 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
130 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
131 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
132 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
133 {.str = "insn", .field = PERF_OUTPUT_INSN},
134 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
135 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
136 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
137 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
138 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
139 {.str = "metric", .field = PERF_OUTPUT_METRIC},
140 {.str = "misc", .field = PERF_OUTPUT_MISC},
141 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
145 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
149 /* default set to maintain compatibility with current format */
153 unsigned int print_ip_opts;
157 } output[OUTPUT_TYPE_MAX] = {
159 [PERF_TYPE_HARDWARE] = {
162 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
163 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
164 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
165 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
166 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
168 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
171 [PERF_TYPE_SOFTWARE] = {
174 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
175 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
176 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
177 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
178 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
179 PERF_OUTPUT_BPF_OUTPUT,
181 .invalid_fields = PERF_OUTPUT_TRACE,
184 [PERF_TYPE_TRACEPOINT] = {
187 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
188 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
189 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
192 [PERF_TYPE_HW_CACHE] = {
195 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
196 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
197 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
198 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
199 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
201 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
207 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
208 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
209 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
210 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
211 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
212 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
213 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR,
215 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
218 [PERF_TYPE_BREAKPOINT] = {
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,
227 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
230 [OUTPUT_TYPE_SYNTH] = {
233 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
234 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
235 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
236 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
237 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
239 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
243 struct perf_evsel_script {
247 /* For metric output */
252 static inline struct perf_evsel_script *evsel_script(struct perf_evsel *evsel)
254 return (struct perf_evsel_script *)evsel->priv;
257 static struct perf_evsel_script *perf_evsel_script__new(struct perf_evsel *evsel,
258 struct perf_data *data)
260 struct perf_evsel_script *es = zalloc(sizeof(*es));
263 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, perf_evsel__name(evsel)) < 0)
265 es->fp = fopen(es->filename, "w");
267 goto out_free_filename;
272 zfree(&es->filename);
278 static void perf_evsel_script__delete(struct perf_evsel_script *es)
280 zfree(&es->filename);
286 static int perf_evsel_script__fprintf(struct perf_evsel_script *es, FILE *fp)
290 fstat(fileno(es->fp), &st);
291 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
292 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
295 static inline int output_type(unsigned int type)
298 case PERF_TYPE_SYNTH:
299 return OUTPUT_TYPE_SYNTH;
305 static inline unsigned int attr_type(unsigned int type)
308 case OUTPUT_TYPE_SYNTH:
309 return PERF_TYPE_SYNTH;
315 static bool output_set_by_user(void)
318 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
319 if (output[j].user_set)
325 static const char *output_field2str(enum perf_output_field field)
327 int i, imax = ARRAY_SIZE(all_output_options);
328 const char *str = "";
330 for (i = 0; i < imax; ++i) {
331 if (all_output_options[i].field == field) {
332 str = all_output_options[i].str;
339 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
341 static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
342 u64 sample_type, const char *sample_msg,
343 enum perf_output_field field,
346 struct perf_event_attr *attr = &evsel->attr;
347 int type = output_type(attr->type);
350 if (attr->sample_type & sample_type)
353 if (output[type].user_set_fields & field) {
356 evname = perf_evsel__name(evsel);
357 pr_err("Samples for '%s' event do not have %s attribute set. "
358 "Cannot print '%s' field.\n",
359 evname, sample_msg, output_field2str(field));
363 /* user did not ask for it explicitly so remove from the default list */
364 output[type].fields &= ~field;
365 evname = perf_evsel__name(evsel);
366 pr_debug("Samples for '%s' event do not have %s attribute set. "
367 "Skipping '%s' field.\n",
368 evname, sample_msg, output_field2str(field));
373 static int perf_evsel__check_stype(struct perf_evsel *evsel,
374 u64 sample_type, const char *sample_msg,
375 enum perf_output_field field)
377 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
381 static int perf_evsel__check_attr(struct perf_evsel *evsel,
382 struct perf_session *session)
384 struct perf_event_attr *attr = &evsel->attr;
387 if (perf_header__has_feat(&session->header, HEADER_STAT))
390 allow_user_set = perf_header__has_feat(&session->header,
393 if (PRINT_FIELD(TRACE) &&
394 !perf_session__has_traces(session, "record -R"))
397 if (PRINT_FIELD(IP)) {
398 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
403 if (PRINT_FIELD(ADDR) &&
404 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
405 PERF_OUTPUT_ADDR, allow_user_set))
408 if (PRINT_FIELD(DATA_SRC) &&
409 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
410 PERF_OUTPUT_DATA_SRC))
413 if (PRINT_FIELD(WEIGHT) &&
414 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
418 if (PRINT_FIELD(SYM) &&
419 !(evsel->attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
420 pr_err("Display of symbols requested but neither sample IP nor "
421 "sample address\navailable. Hence, no addresses to convert "
425 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
426 pr_err("Display of offsets requested but symbol is not"
430 if (PRINT_FIELD(DSO) &&
431 !(evsel->attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
432 pr_err("Display of DSO requested but no address to convert.\n");
435 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
436 pr_err("Display of source line number requested but sample IP is not\n"
437 "selected. Hence, no address to lookup the source line number.\n");
440 if (PRINT_FIELD(BRSTACKINSN) &&
441 !(perf_evlist__combined_branch_type(session->evlist) &
442 PERF_SAMPLE_BRANCH_ANY)) {
443 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
444 "Hint: run 'perf record -b ...'\n");
447 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
448 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
449 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
452 if (PRINT_FIELD(TIME) &&
453 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
457 if (PRINT_FIELD(CPU) &&
458 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
459 PERF_OUTPUT_CPU, allow_user_set))
462 if (PRINT_FIELD(IREGS) &&
463 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
467 if (PRINT_FIELD(UREGS) &&
468 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS",
472 if (PRINT_FIELD(PHYS_ADDR) &&
473 perf_evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR",
474 PERF_OUTPUT_PHYS_ADDR))
480 static void set_print_ip_opts(struct perf_event_attr *attr)
482 unsigned int type = output_type(attr->type);
484 output[type].print_ip_opts = 0;
486 output[type].print_ip_opts |= EVSEL__PRINT_IP;
488 if (PRINT_FIELD(SYM))
489 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
491 if (PRINT_FIELD(DSO))
492 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
494 if (PRINT_FIELD(SYMOFFSET))
495 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
497 if (PRINT_FIELD(SRCLINE))
498 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
502 * verify all user requested events exist and the samples
503 * have the expected data
505 static int perf_session__check_output_opt(struct perf_session *session)
508 struct perf_evsel *evsel;
510 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
511 evsel = perf_session__find_first_evtype(session, attr_type(j));
514 * even if fields is set to 0 (ie., show nothing) event must
515 * exist if user explicitly includes it on the command line
517 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
518 j != OUTPUT_TYPE_SYNTH) {
519 pr_err("%s events do not exist. "
520 "Remove corresponding -F option to proceed.\n",
525 if (evsel && output[j].fields &&
526 perf_evsel__check_attr(evsel, session))
532 set_print_ip_opts(&evsel->attr);
536 bool use_callchain = false;
537 bool not_pipe = false;
539 evlist__for_each_entry(session->evlist, evsel) {
541 if (evsel__has_callchain(evsel)) {
542 use_callchain = true;
546 if (not_pipe && !use_callchain)
547 symbol_conf.use_callchain = false;
551 * set default for tracepoints to print symbols only
552 * if callchains are present
554 if (symbol_conf.use_callchain &&
555 !output[PERF_TYPE_TRACEPOINT].user_set) {
556 j = PERF_TYPE_TRACEPOINT;
558 evlist__for_each_entry(session->evlist, evsel) {
559 if (evsel->attr.type != j)
562 if (evsel__has_callchain(evsel)) {
563 output[j].fields |= PERF_OUTPUT_IP;
564 output[j].fields |= PERF_OUTPUT_SYM;
565 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
566 output[j].fields |= PERF_OUTPUT_DSO;
567 set_print_ip_opts(&evsel->attr);
577 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
584 if (!regs || !regs->regs)
587 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
589 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
590 u64 val = regs->regs[i++];
591 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
599 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
600 struct perf_event_attr *attr, FILE *fp)
602 return perf_sample__fprintf_regs(&sample->intr_regs,
603 attr->sample_regs_intr, fp);
606 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
607 struct perf_event_attr *attr, FILE *fp)
609 return perf_sample__fprintf_regs(&sample->user_regs,
610 attr->sample_regs_user, fp);
613 static int perf_sample__fprintf_start(struct perf_sample *sample,
614 struct thread *thread,
615 struct perf_evsel *evsel,
618 struct perf_event_attr *attr = &evsel->attr;
620 unsigned long long nsecs;
623 if (PRINT_FIELD(COMM)) {
625 printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
626 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
627 printed += fprintf(fp, "%s ", thread__comm_str(thread));
629 printed += fprintf(fp, "%16s ", thread__comm_str(thread));
632 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
633 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
634 else if (PRINT_FIELD(PID))
635 printed += fprintf(fp, "%5d ", sample->pid);
636 else if (PRINT_FIELD(TID))
637 printed += fprintf(fp, "%5d ", sample->tid);
639 if (PRINT_FIELD(CPU)) {
641 printed += fprintf(fp, "%3d ", sample->cpu);
643 printed += fprintf(fp, "[%03d] ", sample->cpu);
646 if (PRINT_FIELD(MISC)) {
650 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
653 ret += fprintf(fp, "K");
655 ret += fprintf(fp, "U");
657 ret += fprintf(fp, "H");
658 if (has(GUEST_KERNEL))
659 ret += fprintf(fp, "G");
661 ret += fprintf(fp, "g");
664 case PERF_RECORD_MMAP:
665 case PERF_RECORD_MMAP2:
667 ret += fprintf(fp, "M");
669 case PERF_RECORD_COMM:
671 ret += fprintf(fp, "E");
673 case PERF_RECORD_SWITCH:
674 case PERF_RECORD_SWITCH_CPU_WIDE:
675 if (has(SWITCH_OUT)) {
676 ret += fprintf(fp, "S");
677 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
678 ret += fprintf(fp, "p");
686 ret += fprintf(fp, "%*s", 6 - ret, " ");
690 if (PRINT_FIELD(TIME)) {
691 u64 t = sample->time;
694 initial_time = sample->time;
695 t = sample->time - initial_time;
698 secs = nsecs / NSEC_PER_SEC;
699 nsecs -= secs * NSEC_PER_SEC;
701 if (symbol_conf.nanosecs)
702 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
704 char sample_time[32];
705 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
706 printed += fprintf(fp, "%12s: ", sample_time);
714 mispred_str(struct branch_entry *br)
716 if (!(br->flags.mispred || br->flags.predicted))
719 return br->flags.predicted ? 'P' : 'M';
722 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
723 struct thread *thread,
724 struct perf_event_attr *attr, FILE *fp)
726 struct branch_stack *br = sample->branch_stack;
727 struct addr_location alf, alt;
734 for (i = 0; i < br->nr; i++) {
735 from = br->entries[i].from;
736 to = br->entries[i].to;
738 if (PRINT_FIELD(DSO)) {
739 memset(&alf, 0, sizeof(alf));
740 memset(&alt, 0, sizeof(alt));
741 thread__find_map_fb(thread, sample->cpumode, from, &alf);
742 thread__find_map_fb(thread, sample->cpumode, to, &alt);
745 printed += fprintf(fp, " 0x%"PRIx64, from);
746 if (PRINT_FIELD(DSO)) {
747 printed += fprintf(fp, "(");
748 printed += map__fprintf_dsoname(alf.map, fp);
749 printed += fprintf(fp, ")");
752 printed += fprintf(fp, "/0x%"PRIx64, to);
753 if (PRINT_FIELD(DSO)) {
754 printed += fprintf(fp, "(");
755 printed += map__fprintf_dsoname(alt.map, fp);
756 printed += fprintf(fp, ")");
759 printed += fprintf(fp, "/%c/%c/%c/%d ",
760 mispred_str( br->entries + i),
761 br->entries[i].flags.in_tx? 'X' : '-',
762 br->entries[i].flags.abort? 'A' : '-',
763 br->entries[i].flags.cycles);
769 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
770 struct thread *thread,
771 struct perf_event_attr *attr, FILE *fp)
773 struct branch_stack *br = sample->branch_stack;
774 struct addr_location alf, alt;
781 for (i = 0; i < br->nr; i++) {
783 memset(&alf, 0, sizeof(alf));
784 memset(&alt, 0, sizeof(alt));
785 from = br->entries[i].from;
786 to = br->entries[i].to;
788 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
789 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
791 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
792 if (PRINT_FIELD(DSO)) {
793 printed += fprintf(fp, "(");
794 printed += map__fprintf_dsoname(alf.map, fp);
795 printed += fprintf(fp, ")");
797 printed += fprintf(fp, "%c", '/');
798 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
799 if (PRINT_FIELD(DSO)) {
800 printed += fprintf(fp, "(");
801 printed += map__fprintf_dsoname(alt.map, fp);
802 printed += fprintf(fp, ")");
804 printed += fprintf(fp, "/%c/%c/%c/%d ",
805 mispred_str( br->entries + i),
806 br->entries[i].flags.in_tx? 'X' : '-',
807 br->entries[i].flags.abort? 'A' : '-',
808 br->entries[i].flags.cycles);
814 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
815 struct thread *thread,
816 struct perf_event_attr *attr, FILE *fp)
818 struct branch_stack *br = sample->branch_stack;
819 struct addr_location alf, alt;
826 for (i = 0; i < br->nr; i++) {
828 memset(&alf, 0, sizeof(alf));
829 memset(&alt, 0, sizeof(alt));
830 from = br->entries[i].from;
831 to = br->entries[i].to;
833 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
834 !alf.map->dso->adjust_symbols)
835 from = map__map_ip(alf.map, from);
837 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
838 !alt.map->dso->adjust_symbols)
839 to = map__map_ip(alt.map, to);
841 printed += fprintf(fp, " 0x%"PRIx64, from);
842 if (PRINT_FIELD(DSO)) {
843 printed += fprintf(fp, "(");
844 printed += map__fprintf_dsoname(alf.map, fp);
845 printed += fprintf(fp, ")");
847 printed += fprintf(fp, "/0x%"PRIx64, to);
848 if (PRINT_FIELD(DSO)) {
849 printed += fprintf(fp, "(");
850 printed += map__fprintf_dsoname(alt.map, fp);
851 printed += fprintf(fp, ")");
853 printed += fprintf(fp, "/%c/%c/%c/%d ",
854 mispred_str(br->entries + i),
855 br->entries[i].flags.in_tx ? 'X' : '-',
856 br->entries[i].flags.abort ? 'A' : '-',
857 br->entries[i].flags.cycles);
862 #define MAXBB 16384UL
864 static int grab_bb(u8 *buffer, u64 start, u64 end,
865 struct machine *machine, struct thread *thread,
866 bool *is64bit, u8 *cpumode, bool last)
869 struct addr_location al;
875 kernel = machine__kernel_ip(machine, start);
877 *cpumode = PERF_RECORD_MISC_KERNEL;
879 *cpumode = PERF_RECORD_MISC_USER;
882 * Block overlaps between kernel and user.
883 * This can happen due to ring filtering
884 * On Intel CPUs the entry into the kernel is filtered,
885 * but the exit is not. Let the caller patch it up.
887 if (kernel != machine__kernel_ip(machine, end)) {
888 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
892 memset(&al, 0, sizeof(al));
893 if (end - start > MAXBB - MAXINSN) {
895 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
897 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
901 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
902 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
905 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
906 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
910 /* Load maps to ensure dso->is_64_bit has been updated */
913 offset = al.map->map_ip(al.map, start);
914 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
915 end - start + MAXINSN);
917 *is64bit = al.map->dso->is_64_bit;
919 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
924 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
926 struct addr_location al;
929 memset(&al, 0, sizeof(al));
930 thread__find_map(thread, cpumode, addr, &al);
933 ret = map__fprintf_srccode(al.map, al.addr, stdout,
934 &thread->srccode_state);
940 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
941 struct perf_insn *x, u8 *inbuf, int len,
942 int insn, FILE *fp, int *total_cycles)
944 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
945 dump_insn(x, ip, inbuf, len, NULL),
946 en->flags.predicted ? " PRED" : "",
947 en->flags.mispred ? " MISPRED" : "",
948 en->flags.in_tx ? " INTX" : "",
949 en->flags.abort ? " ABORT" : "");
950 if (en->flags.cycles) {
951 *total_cycles += en->flags.cycles;
952 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
954 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
956 return printed + fprintf(fp, "\n");
959 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
960 u8 cpumode, int cpu, struct symbol **lastsym,
961 struct perf_event_attr *attr, FILE *fp)
963 struct addr_location al;
964 int off, printed = 0;
966 memset(&al, 0, sizeof(al));
968 thread__find_map(thread, cpumode, addr, &al);
970 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
976 al.sym = map__find_symbol(al.map, al.addr);
981 if (al.addr < al.sym->end)
982 off = al.addr - al.sym->start;
984 off = al.addr - al.map->start - al.sym->start;
985 printed += fprintf(fp, "\t%s", al.sym->name);
987 printed += fprintf(fp, "%+d", off);
988 printed += fprintf(fp, ":");
989 if (PRINT_FIELD(SRCLINE))
990 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
991 printed += fprintf(fp, "\n");
997 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
998 struct thread *thread,
999 struct perf_event_attr *attr,
1000 struct machine *machine, FILE *fp)
1002 struct branch_stack *br = sample->branch_stack;
1004 int i, insn, len, nr, ilen, printed = 0;
1008 struct symbol *lastsym = NULL;
1009 int total_cycles = 0;
1011 if (!(br && br->nr))
1014 if (max_blocks && nr > max_blocks + 1)
1015 nr = max_blocks + 1;
1018 x.cpu = sample->cpu;
1020 printed += fprintf(fp, "%c", '\n');
1022 /* Handle first from jump, of which we don't know the entry. */
1023 len = grab_bb(buffer, br->entries[nr-1].from,
1024 br->entries[nr-1].from,
1025 machine, thread, &x.is64bit, &x.cpumode, false);
1027 printed += ip__fprintf_sym(br->entries[nr - 1].from, thread,
1028 x.cpumode, x.cpu, &lastsym, attr, fp);
1029 printed += ip__fprintf_jump(br->entries[nr - 1].from, &br->entries[nr - 1],
1030 &x, buffer, len, 0, fp, &total_cycles);
1031 if (PRINT_FIELD(SRCCODE))
1032 printed += print_srccode(thread, x.cpumode, br->entries[nr - 1].from);
1035 /* Print all blocks */
1036 for (i = nr - 2; i >= 0; i--) {
1037 if (br->entries[i].from || br->entries[i].to)
1038 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1039 br->entries[i].from,
1041 start = br->entries[i + 1].to;
1042 end = br->entries[i].from;
1044 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1045 /* Patch up missing kernel transfers due to ring filters */
1046 if (len == -ENXIO && i > 0) {
1047 end = br->entries[--i].from;
1048 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1049 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1055 for (off = 0;; off += ilen) {
1056 uint64_t ip = start + off;
1058 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1060 printed += ip__fprintf_jump(ip, &br->entries[i], &x, buffer + off, len - off, insn, fp,
1062 if (PRINT_FIELD(SRCCODE))
1063 printed += print_srccode(thread, x.cpumode, ip);
1066 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1067 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1070 if (PRINT_FIELD(SRCCODE))
1071 print_srccode(thread, x.cpumode, ip);
1078 * Hit the branch? In this case we are already done, and the target
1079 * has not been executed yet.
1081 if (br->entries[0].from == sample->ip)
1083 if (br->entries[0].flags.abort)
1087 * Print final block upto sample
1089 * Due to pipeline delays the LBRs might be missing a branch
1090 * or two, which can result in very large or negative blocks
1091 * between final branch and sample. When this happens just
1092 * continue walking after the last TO until we hit a branch.
1094 start = br->entries[0].to;
1097 /* Missing jump. Scan 128 bytes for the next branch */
1100 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1101 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1103 /* Print at least last IP if basic block did not work */
1104 len = grab_bb(buffer, sample->ip, sample->ip,
1105 machine, thread, &x.is64bit, &x.cpumode, false);
1108 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1109 dump_insn(&x, sample->ip, buffer, len, NULL));
1110 if (PRINT_FIELD(SRCCODE))
1111 print_srccode(thread, x.cpumode, sample->ip);
1114 for (off = 0; off <= end - start; off += ilen) {
1115 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1116 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1119 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1121 * Hit a missing branch. Just stop.
1123 printed += fprintf(fp, "\t... not reaching sample ...\n");
1126 if (PRINT_FIELD(SRCCODE))
1127 print_srccode(thread, x.cpumode, start + off);
1133 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1134 struct thread *thread,
1135 struct perf_event_attr *attr, FILE *fp)
1137 struct addr_location al;
1138 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1140 if (!sample_addr_correlates_sym(attr))
1143 thread__resolve(thread, &al, sample);
1145 if (PRINT_FIELD(SYM)) {
1146 printed += fprintf(fp, " ");
1147 if (PRINT_FIELD(SYMOFFSET))
1148 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1150 printed += symbol__fprintf_symname(al.sym, fp);
1153 if (PRINT_FIELD(DSO)) {
1154 printed += fprintf(fp, " (");
1155 printed += map__fprintf_dsoname(al.map, fp);
1156 printed += fprintf(fp, ")");
1162 static const char *resolve_branch_sym(struct perf_sample *sample,
1163 struct perf_evsel *evsel,
1164 struct thread *thread,
1165 struct addr_location *al,
1168 struct addr_location addr_al;
1169 struct perf_event_attr *attr = &evsel->attr;
1170 const char *name = NULL;
1172 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1173 if (sample_addr_correlates_sym(attr)) {
1174 thread__resolve(thread, &addr_al, sample);
1176 name = addr_al.sym->name;
1182 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1184 name = al->sym->name;
1191 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1192 struct perf_evsel *evsel,
1193 struct thread *thread,
1194 struct addr_location *al, FILE *fp)
1196 struct perf_event_attr *attr = &evsel->attr;
1197 size_t depth = thread_stack__depth(thread, sample->cpu);
1198 const char *name = NULL;
1205 * The 'return' has already been popped off the stack so the depth has
1206 * to be adjusted to match the 'call'.
1208 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1211 name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1213 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1214 dlen += fprintf(fp, "(");
1215 dlen += map__fprintf_dsoname(al->map, fp);
1216 dlen += fprintf(fp, ")\t");
1220 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1222 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1228 * Try to keep the output length from changing frequently so that the
1229 * output lines up more nicely.
1231 if (len > spacing || (len && len < spacing - 52))
1232 spacing = round_up(len + 4, 32);
1235 len += fprintf(fp, "%*s", spacing - len, "");
1240 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1241 struct thread *thread __maybe_unused,
1242 struct machine *machine __maybe_unused)
1246 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1247 struct perf_event_attr *attr,
1248 struct thread *thread,
1249 struct machine *machine, FILE *fp)
1253 if (sample->insn_len == 0 && native_arch)
1254 arch_fetch_insn(sample, thread, machine);
1256 if (PRINT_FIELD(INSNLEN))
1257 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1258 if (PRINT_FIELD(INSN) && sample->insn_len) {
1261 printed += fprintf(fp, " insn:");
1262 for (i = 0; i < sample->insn_len; i++)
1263 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1265 if (PRINT_FIELD(BRSTACKINSN))
1266 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1271 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1272 struct perf_evsel *evsel,
1273 struct thread *thread,
1274 struct addr_location *al,
1275 struct machine *machine, FILE *fp)
1277 struct perf_event_attr *attr = &evsel->attr;
1278 unsigned int type = output_type(attr->type);
1279 bool print_srcline_last = false;
1282 if (PRINT_FIELD(CALLINDENT))
1283 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1285 /* print branch_from information */
1286 if (PRINT_FIELD(IP)) {
1287 unsigned int print_opts = output[type].print_ip_opts;
1288 struct callchain_cursor *cursor = NULL;
1290 if (symbol_conf.use_callchain && sample->callchain &&
1291 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1292 sample, NULL, NULL, scripting_max_stack) == 0)
1293 cursor = &callchain_cursor;
1295 if (cursor == NULL) {
1296 printed += fprintf(fp, " ");
1297 if (print_opts & EVSEL__PRINT_SRCLINE) {
1298 print_srcline_last = true;
1299 print_opts &= ~EVSEL__PRINT_SRCLINE;
1302 printed += fprintf(fp, "\n");
1304 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor, fp);
1307 /* print branch_to information */
1308 if (PRINT_FIELD(ADDR) ||
1309 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
1310 !output[type].user_set)) {
1311 printed += fprintf(fp, " => ");
1312 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1315 if (print_srcline_last)
1316 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1318 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1319 printed += fprintf(fp, "\n");
1320 if (PRINT_FIELD(SRCCODE)) {
1321 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1322 &thread->srccode_state);
1325 printed += printf("\n");
1334 } sample_flags[] = {
1335 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1336 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1337 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1338 {PERF_IP_FLAG_BRANCH, "jmp"},
1339 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1340 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1341 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1342 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1343 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1344 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1345 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1346 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1347 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1351 static const char *sample_flags_to_name(u32 flags)
1355 for (i = 0; sample_flags[i].name ; i++) {
1356 if (sample_flags[i].flags == flags)
1357 return sample_flags[i].name;
1363 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1365 const char *chars = PERF_IP_FLAG_CHARS;
1366 const int n = strlen(PERF_IP_FLAG_CHARS);
1367 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1368 const char *name = NULL;
1372 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1374 return fprintf(fp, " %-15s%4s ", name, in_tx ? "(x)" : "");
1376 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1377 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1379 return fprintf(fp, " tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1382 if (flags & PERF_IP_FLAG_TRACE_END) {
1383 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1385 return fprintf(fp, " tr end %-7s%4s ", name, in_tx ? "(x)" : "");
1388 for (i = 0; i < n; i++, flags >>= 1) {
1390 str[pos++] = chars[i];
1392 for (; i < 32; i++, flags >>= 1) {
1398 return fprintf(fp, " %-19s ", str);
1401 struct printer_data {
1407 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1409 void *extra, FILE *fp)
1411 unsigned char ch = (unsigned char)val;
1412 struct printer_data *printer_data = extra;
1416 case BINARY_PRINT_DATA_BEGIN:
1417 printed += fprintf(fp, "\n");
1419 case BINARY_PRINT_LINE_BEGIN:
1420 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1423 case BINARY_PRINT_ADDR:
1424 printed += fprintf(fp, " %04x:", val);
1426 case BINARY_PRINT_NUM_DATA:
1427 printed += fprintf(fp, " %02x", val);
1429 case BINARY_PRINT_NUM_PAD:
1430 printed += fprintf(fp, " ");
1432 case BINARY_PRINT_SEP:
1433 printed += fprintf(fp, " ");
1435 case BINARY_PRINT_CHAR_DATA:
1436 if (printer_data->hit_nul && ch)
1437 printer_data->is_printable = false;
1440 printed += fprintf(fp, "%c", '.');
1442 if (!printer_data->is_printable)
1446 printer_data->hit_nul = true;
1448 printer_data->is_printable = false;
1450 printed += fprintf(fp, "%c", ch);
1453 case BINARY_PRINT_CHAR_PAD:
1454 printed += fprintf(fp, " ");
1456 case BINARY_PRINT_LINE_END:
1457 printed += fprintf(fp, "\n");
1458 printer_data->line_no++;
1460 case BINARY_PRINT_DATA_END:
1468 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1470 unsigned int nr_bytes = sample->raw_size;
1471 struct printer_data printer_data = {0, false, true};
1472 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1473 sample__fprintf_bpf_output, &printer_data, fp);
1475 if (printer_data.is_printable && printer_data.hit_nul)
1476 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1481 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1483 if (len > 0 && len < spacing)
1484 return fprintf(fp, "%*s", spacing - len, "");
1489 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1491 return perf_sample__fprintf_spacing(len, 34, fp);
1494 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1496 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1499 if (perf_sample__bad_synth_size(sample, *data))
1502 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1503 data->ip, le64_to_cpu(data->payload));
1504 return len + perf_sample__fprintf_pt_spacing(len, fp);
1507 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1509 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1512 if (perf_sample__bad_synth_size(sample, *data))
1515 len = fprintf(fp, " hints: %#x extensions: %#x ",
1516 data->hints, data->extensions);
1517 return len + perf_sample__fprintf_pt_spacing(len, fp);
1520 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1522 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1525 if (perf_sample__bad_synth_size(sample, *data))
1528 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1529 data->hw, data->cstate, data->subcstate);
1530 return len + perf_sample__fprintf_pt_spacing(len, fp);
1533 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1535 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1538 if (perf_sample__bad_synth_size(sample, *data))
1541 len = fprintf(fp, " IP: %u ", data->ip);
1542 return len + perf_sample__fprintf_pt_spacing(len, fp);
1545 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1547 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1550 if (perf_sample__bad_synth_size(sample, *data))
1553 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1554 data->deepest_cstate, data->last_cstate,
1556 return len + perf_sample__fprintf_pt_spacing(len, fp);
1559 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1561 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1562 unsigned int percent, freq;
1565 if (perf_sample__bad_synth_size(sample, *data))
1568 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1569 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1570 if (data->max_nonturbo) {
1571 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1572 len += fprintf(fp, "(%3u%%) ", percent);
1574 return len + perf_sample__fprintf_pt_spacing(len, fp);
1577 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1578 struct perf_evsel *evsel, FILE *fp)
1580 switch (evsel->attr.config) {
1581 case PERF_SYNTH_INTEL_PTWRITE:
1582 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1583 case PERF_SYNTH_INTEL_MWAIT:
1584 return perf_sample__fprintf_synth_mwait(sample, fp);
1585 case PERF_SYNTH_INTEL_PWRE:
1586 return perf_sample__fprintf_synth_pwre(sample, fp);
1587 case PERF_SYNTH_INTEL_EXSTOP:
1588 return perf_sample__fprintf_synth_exstop(sample, fp);
1589 case PERF_SYNTH_INTEL_PWRX:
1590 return perf_sample__fprintf_synth_pwrx(sample, fp);
1591 case PERF_SYNTH_INTEL_CBR:
1592 return perf_sample__fprintf_synth_cbr(sample, fp);
1600 struct perf_script {
1601 struct perf_tool tool;
1602 struct perf_session *session;
1603 bool show_task_events;
1604 bool show_mmap_events;
1605 bool show_switch_events;
1606 bool show_namespace_events;
1607 bool show_lost_events;
1608 bool show_round_events;
1610 bool per_event_dump;
1611 struct cpu_map *cpus;
1612 struct thread_map *threads;
1614 const char *time_str;
1615 struct perf_time_interval *ptime_range;
1620 static int perf_evlist__max_name_len(struct perf_evlist *evlist)
1622 struct perf_evsel *evsel;
1625 evlist__for_each_entry(evlist, evsel) {
1626 int len = strlen(perf_evsel__name(evsel));
1628 max = MAX(len, max);
1634 static int data_src__fprintf(u64 data_src, FILE *fp)
1636 struct mem_info mi = { .data_src.val = data_src };
1642 perf_script__meminfo_scnprintf(decode, 100, &mi);
1644 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1648 return fprintf(fp, "%-*s", maxlen, out);
1652 struct perf_sample *sample;
1653 struct thread *thread;
1654 struct perf_evsel *evsel;
1658 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1659 void *ctx, const char *color,
1661 const char *unit, double val)
1663 struct metric_ctx *mctx = ctx;
1667 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1668 PERF_RECORD_SAMPLE, mctx->fp);
1669 fputs("\tmetric: ", mctx->fp);
1671 color_fprintf(mctx->fp, color, fmt, val);
1674 fprintf(mctx->fp, " %s\n", unit);
1677 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1680 struct metric_ctx *mctx = ctx;
1682 perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
1683 PERF_RECORD_SAMPLE, mctx->fp);
1684 fputs("\tmetric: ", mctx->fp);
1687 static void perf_sample__fprint_metric(struct perf_script *script,
1688 struct thread *thread,
1689 struct perf_evsel *evsel,
1690 struct perf_sample *sample,
1693 struct perf_stat_output_ctx ctx = {
1694 .print_metric = script_print_metric,
1695 .new_line = script_new_line,
1696 .ctx = &(struct metric_ctx) {
1702 .force_header = false,
1704 struct perf_evsel *ev2;
1708 perf_evlist__alloc_stats(script->session->evlist, false);
1709 if (evsel_script(evsel->leader)->gnum++ == 0)
1710 perf_stat__reset_shadow_stats();
1711 val = sample->period * evsel->scale;
1712 perf_stat__update_shadow_stats(evsel,
1716 evsel_script(evsel)->val = val;
1717 if (evsel_script(evsel->leader)->gnum == evsel->leader->nr_members) {
1718 for_each_group_member (ev2, evsel->leader) {
1719 perf_stat__print_shadow_stats(&stat_config, ev2,
1720 evsel_script(ev2)->val,
1726 evsel_script(evsel->leader)->gnum = 0;
1730 static bool show_event(struct perf_sample *sample,
1731 struct perf_evsel *evsel,
1732 struct thread *thread,
1733 struct addr_location *al)
1735 int depth = thread_stack__depth(thread, sample->cpu);
1737 if (!symbol_conf.graph_function)
1740 if (thread->filter) {
1741 if (depth <= thread->filter_entry_depth) {
1742 thread->filter = false;
1747 const char *s = symbol_conf.graph_function;
1749 const char *name = resolve_branch_sym(sample, evsel, thread, al,
1755 nlen = strlen(name);
1757 unsigned len = strcspn(s, ",");
1758 if (nlen == len && !strncmp(name, s, len)) {
1759 thread->filter = true;
1760 thread->filter_entry_depth = depth;
1771 static void process_event(struct perf_script *script,
1772 struct perf_sample *sample, struct perf_evsel *evsel,
1773 struct addr_location *al,
1774 struct machine *machine)
1776 struct thread *thread = al->thread;
1777 struct perf_event_attr *attr = &evsel->attr;
1778 unsigned int type = output_type(attr->type);
1779 struct perf_evsel_script *es = evsel->priv;
1782 if (output[type].fields == 0)
1785 if (!show_event(sample, evsel, thread, al))
1790 perf_sample__fprintf_start(sample, thread, evsel,
1791 PERF_RECORD_SAMPLE, fp);
1793 if (PRINT_FIELD(PERIOD))
1794 fprintf(fp, "%10" PRIu64 " ", sample->period);
1796 if (PRINT_FIELD(EVNAME)) {
1797 const char *evname = perf_evsel__name(evsel);
1799 if (!script->name_width)
1800 script->name_width = perf_evlist__max_name_len(script->session->evlist);
1802 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1806 perf_sample__fprintf_flags(sample->flags, fp);
1808 if (is_bts_event(attr)) {
1809 perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1813 if (PRINT_FIELD(TRACE) && sample->raw_data) {
1814 event_format__fprintf(evsel->tp_format, sample->cpu,
1815 sample->raw_data, sample->raw_size, fp);
1818 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1819 perf_sample__fprintf_synth(sample, evsel, fp);
1821 if (PRINT_FIELD(ADDR))
1822 perf_sample__fprintf_addr(sample, thread, attr, fp);
1824 if (PRINT_FIELD(DATA_SRC))
1825 data_src__fprintf(sample->data_src, fp);
1827 if (PRINT_FIELD(WEIGHT))
1828 fprintf(fp, "%16" PRIu64, sample->weight);
1830 if (PRINT_FIELD(IP)) {
1831 struct callchain_cursor *cursor = NULL;
1833 if (symbol_conf.use_callchain && sample->callchain &&
1834 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1835 sample, NULL, NULL, scripting_max_stack) == 0)
1836 cursor = &callchain_cursor;
1838 fputc(cursor ? '\n' : ' ', fp);
1839 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor, fp);
1842 if (PRINT_FIELD(IREGS))
1843 perf_sample__fprintf_iregs(sample, attr, fp);
1845 if (PRINT_FIELD(UREGS))
1846 perf_sample__fprintf_uregs(sample, attr, fp);
1848 if (PRINT_FIELD(BRSTACK))
1849 perf_sample__fprintf_brstack(sample, thread, attr, fp);
1850 else if (PRINT_FIELD(BRSTACKSYM))
1851 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1852 else if (PRINT_FIELD(BRSTACKOFF))
1853 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
1855 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1856 perf_sample__fprintf_bpf_output(sample, fp);
1857 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1859 if (PRINT_FIELD(PHYS_ADDR))
1860 fprintf(fp, "%16" PRIx64, sample->phys_addr);
1863 if (PRINT_FIELD(SRCCODE)) {
1864 if (map__fprintf_srccode(al->map, al->addr, stdout,
1865 &thread->srccode_state))
1869 if (PRINT_FIELD(METRIC))
1870 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
1876 static struct scripting_ops *scripting_ops;
1878 static void __process_stat(struct perf_evsel *counter, u64 tstamp)
1880 int nthreads = thread_map__nr(counter->threads);
1881 int ncpus = perf_evsel__nr_cpus(counter);
1883 static int header_printed;
1885 if (counter->system_wide)
1888 if (!header_printed) {
1889 printf("%3s %8s %15s %15s %15s %15s %s\n",
1890 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
1894 for (thread = 0; thread < nthreads; thread++) {
1895 for (cpu = 0; cpu < ncpus; cpu++) {
1896 struct perf_counts_values *counts;
1898 counts = perf_counts(counter->counts, cpu, thread);
1900 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
1901 counter->cpus->map[cpu],
1902 thread_map__pid(counter->threads, thread),
1907 perf_evsel__name(counter));
1912 static void process_stat(struct perf_evsel *counter, u64 tstamp)
1914 if (scripting_ops && scripting_ops->process_stat)
1915 scripting_ops->process_stat(&stat_config, counter, tstamp);
1917 __process_stat(counter, tstamp);
1920 static void process_stat_interval(u64 tstamp)
1922 if (scripting_ops && scripting_ops->process_stat_interval)
1923 scripting_ops->process_stat_interval(tstamp);
1926 static void setup_scripting(void)
1928 setup_perl_scripting();
1929 setup_python_scripting();
1932 static int flush_scripting(void)
1934 return scripting_ops ? scripting_ops->flush_script() : 0;
1937 static int cleanup_scripting(void)
1939 pr_debug("\nperf script stopped\n");
1941 return scripting_ops ? scripting_ops->stop_script() : 0;
1944 static bool filter_cpu(struct perf_sample *sample)
1947 return !test_bit(sample->cpu, cpu_bitmap);
1951 static int process_sample_event(struct perf_tool *tool,
1952 union perf_event *event,
1953 struct perf_sample *sample,
1954 struct perf_evsel *evsel,
1955 struct machine *machine)
1957 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1958 struct addr_location al;
1960 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
1966 if (sample->time < last_timestamp) {
1967 pr_err("Samples misordered, previous: %" PRIu64
1968 " this: %" PRIu64 "\n", last_timestamp,
1972 last_timestamp = sample->time;
1976 if (machine__resolve(machine, &al, sample) < 0) {
1977 pr_err("problem processing %d event, skipping it.\n",
1978 event->header.type);
1985 if (filter_cpu(sample))
1989 scripting_ops->process_event(event, sample, evsel, &al);
1991 process_event(scr, sample, evsel, &al, machine);
1994 addr_location__put(&al);
1998 static int process_attr(struct perf_tool *tool, union perf_event *event,
1999 struct perf_evlist **pevlist)
2001 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2002 struct perf_evlist *evlist;
2003 struct perf_evsel *evsel, *pos;
2005 static struct perf_evsel_script *es;
2007 err = perf_event__process_attr(tool, event, pevlist);
2012 evsel = perf_evlist__last(*pevlist);
2015 if (scr->per_event_dump) {
2016 evsel->priv = perf_evsel_script__new(evsel,
2017 scr->session->data);
2019 es = zalloc(sizeof(*es));
2027 if (evsel->attr.type >= PERF_TYPE_MAX &&
2028 evsel->attr.type != PERF_TYPE_SYNTH)
2031 evlist__for_each_entry(evlist, pos) {
2032 if (pos->attr.type == evsel->attr.type && pos != evsel)
2036 set_print_ip_opts(&evsel->attr);
2038 if (evsel->attr.sample_type)
2039 err = perf_evsel__check_attr(evsel, scr->session);
2044 static int process_comm_event(struct perf_tool *tool,
2045 union perf_event *event,
2046 struct perf_sample *sample,
2047 struct machine *machine)
2049 struct thread *thread;
2050 struct perf_script *script = container_of(tool, struct perf_script, tool);
2051 struct perf_session *session = script->session;
2052 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2055 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
2056 if (thread == NULL) {
2057 pr_debug("problem processing COMM event, skipping it.\n");
2061 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2064 if (!evsel->attr.sample_id_all) {
2067 sample->tid = event->comm.tid;
2068 sample->pid = event->comm.pid;
2070 if (!filter_cpu(sample)) {
2071 perf_sample__fprintf_start(sample, thread, evsel,
2072 PERF_RECORD_COMM, stdout);
2073 perf_event__fprintf(event, stdout);
2077 thread__put(thread);
2081 static int process_namespaces_event(struct perf_tool *tool,
2082 union perf_event *event,
2083 struct perf_sample *sample,
2084 struct machine *machine)
2086 struct thread *thread;
2087 struct perf_script *script = container_of(tool, struct perf_script, tool);
2088 struct perf_session *session = script->session;
2089 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2092 thread = machine__findnew_thread(machine, event->namespaces.pid,
2093 event->namespaces.tid);
2094 if (thread == NULL) {
2095 pr_debug("problem processing NAMESPACES event, skipping it.\n");
2099 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2102 if (!evsel->attr.sample_id_all) {
2105 sample->tid = event->namespaces.tid;
2106 sample->pid = event->namespaces.pid;
2108 if (!filter_cpu(sample)) {
2109 perf_sample__fprintf_start(sample, thread, evsel,
2110 PERF_RECORD_NAMESPACES, stdout);
2111 perf_event__fprintf(event, stdout);
2115 thread__put(thread);
2119 static int process_fork_event(struct perf_tool *tool,
2120 union perf_event *event,
2121 struct perf_sample *sample,
2122 struct machine *machine)
2124 struct thread *thread;
2125 struct perf_script *script = container_of(tool, struct perf_script, tool);
2126 struct perf_session *session = script->session;
2127 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2129 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2132 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
2133 if (thread == NULL) {
2134 pr_debug("problem processing FORK event, skipping it.\n");
2138 if (!evsel->attr.sample_id_all) {
2140 sample->time = event->fork.time;
2141 sample->tid = event->fork.tid;
2142 sample->pid = event->fork.pid;
2144 if (!filter_cpu(sample)) {
2145 perf_sample__fprintf_start(sample, thread, evsel,
2146 PERF_RECORD_FORK, stdout);
2147 perf_event__fprintf(event, stdout);
2149 thread__put(thread);
2153 static int process_exit_event(struct perf_tool *tool,
2154 union perf_event *event,
2155 struct perf_sample *sample,
2156 struct machine *machine)
2159 struct thread *thread;
2160 struct perf_script *script = container_of(tool, struct perf_script, tool);
2161 struct perf_session *session = script->session;
2162 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2164 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
2165 if (thread == NULL) {
2166 pr_debug("problem processing EXIT event, skipping it.\n");
2170 if (!evsel->attr.sample_id_all) {
2173 sample->tid = event->fork.tid;
2174 sample->pid = event->fork.pid;
2176 if (!filter_cpu(sample)) {
2177 perf_sample__fprintf_start(sample, thread, evsel,
2178 PERF_RECORD_EXIT, stdout);
2179 perf_event__fprintf(event, stdout);
2182 if (perf_event__process_exit(tool, event, sample, machine) < 0)
2185 thread__put(thread);
2189 static int process_mmap_event(struct perf_tool *tool,
2190 union perf_event *event,
2191 struct perf_sample *sample,
2192 struct machine *machine)
2194 struct thread *thread;
2195 struct perf_script *script = container_of(tool, struct perf_script, tool);
2196 struct perf_session *session = script->session;
2197 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2199 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2202 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
2203 if (thread == NULL) {
2204 pr_debug("problem processing MMAP event, skipping it.\n");
2208 if (!evsel->attr.sample_id_all) {
2211 sample->tid = event->mmap.tid;
2212 sample->pid = event->mmap.pid;
2214 if (!filter_cpu(sample)) {
2215 perf_sample__fprintf_start(sample, thread, evsel,
2216 PERF_RECORD_MMAP, stdout);
2217 perf_event__fprintf(event, stdout);
2219 thread__put(thread);
2223 static int process_mmap2_event(struct perf_tool *tool,
2224 union perf_event *event,
2225 struct perf_sample *sample,
2226 struct machine *machine)
2228 struct thread *thread;
2229 struct perf_script *script = container_of(tool, struct perf_script, tool);
2230 struct perf_session *session = script->session;
2231 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2233 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2236 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
2237 if (thread == NULL) {
2238 pr_debug("problem processing MMAP2 event, skipping it.\n");
2242 if (!evsel->attr.sample_id_all) {
2245 sample->tid = event->mmap2.tid;
2246 sample->pid = event->mmap2.pid;
2248 if (!filter_cpu(sample)) {
2249 perf_sample__fprintf_start(sample, thread, evsel,
2250 PERF_RECORD_MMAP2, stdout);
2251 perf_event__fprintf(event, stdout);
2253 thread__put(thread);
2257 static int process_switch_event(struct perf_tool *tool,
2258 union perf_event *event,
2259 struct perf_sample *sample,
2260 struct machine *machine)
2262 struct thread *thread;
2263 struct perf_script *script = container_of(tool, struct perf_script, tool);
2264 struct perf_session *session = script->session;
2265 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2267 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2270 thread = machine__findnew_thread(machine, sample->pid,
2272 if (thread == NULL) {
2273 pr_debug("problem processing SWITCH event, skipping it.\n");
2277 if (!filter_cpu(sample)) {
2278 perf_sample__fprintf_start(sample, thread, evsel,
2279 PERF_RECORD_SWITCH, stdout);
2280 perf_event__fprintf(event, stdout);
2282 thread__put(thread);
2287 process_lost_event(struct perf_tool *tool,
2288 union perf_event *event,
2289 struct perf_sample *sample,
2290 struct machine *machine)
2292 struct perf_script *script = container_of(tool, struct perf_script, tool);
2293 struct perf_session *session = script->session;
2294 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2295 struct thread *thread;
2297 thread = machine__findnew_thread(machine, sample->pid,
2302 if (!filter_cpu(sample)) {
2303 perf_sample__fprintf_start(sample, thread, evsel,
2304 PERF_RECORD_LOST, stdout);
2305 perf_event__fprintf(event, stdout);
2307 thread__put(thread);
2312 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2313 union perf_event *event,
2314 struct ordered_events *oe __maybe_unused)
2317 perf_event__fprintf(event, stdout);
2321 static void sig_handler(int sig __maybe_unused)
2326 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2328 struct perf_evlist *evlist = script->session->evlist;
2329 struct perf_evsel *evsel;
2331 evlist__for_each_entry(evlist, evsel) {
2334 perf_evsel_script__delete(evsel->priv);
2339 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2341 struct perf_evsel *evsel;
2343 evlist__for_each_entry(script->session->evlist, evsel) {
2345 * Already setup? I.e. we may be called twice in cases like
2346 * Intel PT, one for the intel_pt// and dummy events, then
2347 * for the evsels syntheized from the auxtrace info.
2349 * Ses perf_script__process_auxtrace_info.
2351 if (evsel->priv != NULL)
2354 evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2355 if (evsel->priv == NULL)
2356 goto out_err_fclose;
2362 perf_script__fclose_per_event_dump(script);
2366 static int perf_script__setup_per_event_dump(struct perf_script *script)
2368 struct perf_evsel *evsel;
2369 static struct perf_evsel_script es_stdout;
2371 if (script->per_event_dump)
2372 return perf_script__fopen_per_event_dump(script);
2374 es_stdout.fp = stdout;
2376 evlist__for_each_entry(script->session->evlist, evsel)
2377 evsel->priv = &es_stdout;
2382 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2384 struct perf_evsel *evsel;
2386 evlist__for_each_entry(script->session->evlist, evsel) {
2387 struct perf_evsel_script *es = evsel->priv;
2389 perf_evsel_script__fprintf(es, stdout);
2390 perf_evsel_script__delete(es);
2395 static int __cmd_script(struct perf_script *script)
2399 signal(SIGINT, sig_handler);
2401 perf_stat__init_shadow_stats();
2403 /* override event processing functions */
2404 if (script->show_task_events) {
2405 script->tool.comm = process_comm_event;
2406 script->tool.fork = process_fork_event;
2407 script->tool.exit = process_exit_event;
2409 if (script->show_mmap_events) {
2410 script->tool.mmap = process_mmap_event;
2411 script->tool.mmap2 = process_mmap2_event;
2413 if (script->show_switch_events)
2414 script->tool.context_switch = process_switch_event;
2415 if (script->show_namespace_events)
2416 script->tool.namespaces = process_namespaces_event;
2417 if (script->show_lost_events)
2418 script->tool.lost = process_lost_event;
2419 if (script->show_round_events) {
2420 script->tool.ordered_events = false;
2421 script->tool.finished_round = process_finished_round_event;
2424 if (perf_script__setup_per_event_dump(script)) {
2425 pr_err("Couldn't create the per event dump files\n");
2429 ret = perf_session__process_events(script->session);
2431 if (script->per_event_dump)
2432 perf_script__exit_per_event_dump_stats(script);
2435 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2440 struct script_spec {
2441 struct list_head node;
2442 struct scripting_ops *ops;
2446 static LIST_HEAD(script_specs);
2448 static struct script_spec *script_spec__new(const char *spec,
2449 struct scripting_ops *ops)
2451 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2454 strcpy(s->spec, spec);
2461 static void script_spec__add(struct script_spec *s)
2463 list_add_tail(&s->node, &script_specs);
2466 static struct script_spec *script_spec__find(const char *spec)
2468 struct script_spec *s;
2470 list_for_each_entry(s, &script_specs, node)
2471 if (strcasecmp(s->spec, spec) == 0)
2476 int script_spec_register(const char *spec, struct scripting_ops *ops)
2478 struct script_spec *s;
2480 s = script_spec__find(spec);
2484 s = script_spec__new(spec, ops);
2488 script_spec__add(s);
2493 static struct scripting_ops *script_spec__lookup(const char *spec)
2495 struct script_spec *s = script_spec__find(spec);
2502 static void list_available_languages(void)
2504 struct script_spec *s;
2506 fprintf(stderr, "\n");
2507 fprintf(stderr, "Scripting language extensions (used in "
2508 "perf script -s [spec:]script.[spec]):\n\n");
2510 list_for_each_entry(s, &script_specs, node)
2511 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2513 fprintf(stderr, "\n");
2516 static int parse_scriptname(const struct option *opt __maybe_unused,
2517 const char *str, int unset __maybe_unused)
2519 char spec[PATH_MAX];
2520 const char *script, *ext;
2523 if (strcmp(str, "lang") == 0) {
2524 list_available_languages();
2528 script = strchr(str, ':');
2531 if (len >= PATH_MAX) {
2532 fprintf(stderr, "invalid language specifier");
2535 strncpy(spec, str, len);
2537 scripting_ops = script_spec__lookup(spec);
2538 if (!scripting_ops) {
2539 fprintf(stderr, "invalid language specifier");
2545 ext = strrchr(script, '.');
2547 fprintf(stderr, "invalid script extension");
2550 scripting_ops = script_spec__lookup(++ext);
2551 if (!scripting_ops) {
2552 fprintf(stderr, "invalid script extension");
2557 script_name = strdup(script);
2562 static int parse_output_fields(const struct option *opt __maybe_unused,
2563 const char *arg, int unset __maybe_unused)
2565 char *tok, *strtok_saveptr = NULL;
2566 int i, imax = ARRAY_SIZE(all_output_options);
2569 char *str = strdup(arg);
2571 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2576 /* first word can state for which event type the user is specifying
2577 * the fields. If no type exists, the specified fields apply to all
2578 * event types found in the file minus the invalid fields for a type.
2580 tok = strchr(str, ':');
2584 if (!strcmp(str, "hw"))
2585 type = PERF_TYPE_HARDWARE;
2586 else if (!strcmp(str, "sw"))
2587 type = PERF_TYPE_SOFTWARE;
2588 else if (!strcmp(str, "trace"))
2589 type = PERF_TYPE_TRACEPOINT;
2590 else if (!strcmp(str, "raw"))
2591 type = PERF_TYPE_RAW;
2592 else if (!strcmp(str, "break"))
2593 type = PERF_TYPE_BREAKPOINT;
2594 else if (!strcmp(str, "synth"))
2595 type = OUTPUT_TYPE_SYNTH;
2597 fprintf(stderr, "Invalid event type in field string.\n");
2602 if (output[type].user_set)
2603 pr_warning("Overriding previous field request for %s events.\n",
2606 /* Don't override defaults for +- */
2607 if (strchr(tok, '+') || strchr(tok, '-'))
2610 output[type].fields = 0;
2611 output[type].user_set = true;
2612 output[type].wildcard_set = false;
2616 if (strlen(str) == 0) {
2618 "Cannot set fields to 'none' for all event types.\n");
2623 /* Don't override defaults for +- */
2624 if (strchr(str, '+') || strchr(str, '-'))
2627 if (output_set_by_user())
2628 pr_warning("Overriding previous field request for all events.\n");
2630 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2631 output[j].fields = 0;
2632 output[j].user_set = true;
2633 output[j].wildcard_set = true;
2638 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2644 } else if (*tok == '-') {
2650 if (change != SET && change != DEFAULT)
2655 for (i = 0; i < imax; ++i) {
2656 if (strcmp(tok, all_output_options[i].str) == 0)
2659 if (i == imax && strcmp(tok, "flags") == 0) {
2660 print_flags = change == REMOVE ? false : true;
2664 fprintf(stderr, "Invalid field requested.\n");
2670 /* add user option to all events types for
2673 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2674 if (output[j].invalid_fields & all_output_options[i].field) {
2675 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2676 all_output_options[i].str, event_type(j));
2678 if (change == REMOVE) {
2679 output[j].fields &= ~all_output_options[i].field;
2680 output[j].user_set_fields &= ~all_output_options[i].field;
2682 output[j].fields |= all_output_options[i].field;
2683 output[j].user_set_fields |= all_output_options[i].field;
2685 output[j].user_set = true;
2686 output[j].wildcard_set = true;
2690 if (output[type].invalid_fields & all_output_options[i].field) {
2691 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2692 all_output_options[i].str, event_type(type));
2697 if (change == REMOVE)
2698 output[type].fields &= ~all_output_options[i].field;
2700 output[type].fields |= all_output_options[i].field;
2701 output[type].user_set = true;
2702 output[type].wildcard_set = true;
2707 if (output[type].fields == 0) {
2708 pr_debug("No fields requested for %s type. "
2709 "Events will not be displayed.\n", event_type(type));
2715 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2722 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2723 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2724 if ((lang_dirent->d_type == DT_DIR || \
2725 (lang_dirent->d_type == DT_UNKNOWN && \
2726 is_directory(scripts_path, lang_dirent))) && \
2727 (strcmp(lang_dirent->d_name, ".")) && \
2728 (strcmp(lang_dirent->d_name, "..")))
2730 #define for_each_script(lang_path, lang_dir, script_dirent) \
2731 while ((script_dirent = readdir(lang_dir)) != NULL) \
2732 if (script_dirent->d_type != DT_DIR && \
2733 (script_dirent->d_type != DT_UNKNOWN || \
2734 !is_directory(lang_path, script_dirent)))
2737 #define RECORD_SUFFIX "-record"
2738 #define REPORT_SUFFIX "-report"
2740 struct script_desc {
2741 struct list_head node;
2747 static LIST_HEAD(script_descs);
2749 static struct script_desc *script_desc__new(const char *name)
2751 struct script_desc *s = zalloc(sizeof(*s));
2753 if (s != NULL && name)
2754 s->name = strdup(name);
2759 static void script_desc__delete(struct script_desc *s)
2762 zfree(&s->half_liner);
2767 static void script_desc__add(struct script_desc *s)
2769 list_add_tail(&s->node, &script_descs);
2772 static struct script_desc *script_desc__find(const char *name)
2774 struct script_desc *s;
2776 list_for_each_entry(s, &script_descs, node)
2777 if (strcasecmp(s->name, name) == 0)
2782 static struct script_desc *script_desc__findnew(const char *name)
2784 struct script_desc *s = script_desc__find(name);
2789 s = script_desc__new(name);
2793 script_desc__add(s);
2798 static const char *ends_with(const char *str, const char *suffix)
2800 size_t suffix_len = strlen(suffix);
2801 const char *p = str;
2803 if (strlen(str) > suffix_len) {
2804 p = str + strlen(str) - suffix_len;
2805 if (!strncmp(p, suffix, suffix_len))
2812 static int read_script_info(struct script_desc *desc, const char *filename)
2814 char line[BUFSIZ], *p;
2817 fp = fopen(filename, "r");
2821 while (fgets(line, sizeof(line), fp)) {
2828 if (strlen(p) && *p == '!')
2832 if (strlen(p) && p[strlen(p) - 1] == '\n')
2833 p[strlen(p) - 1] = '\0';
2835 if (!strncmp(p, "description:", strlen("description:"))) {
2836 p += strlen("description:");
2837 desc->half_liner = strdup(ltrim(p));
2841 if (!strncmp(p, "args:", strlen("args:"))) {
2842 p += strlen("args:");
2843 desc->args = strdup(ltrim(p));
2853 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2855 char *script_root, *str;
2857 script_root = strdup(script_dirent->d_name);
2861 str = (char *)ends_with(script_root, suffix);
2871 static int list_available_scripts(const struct option *opt __maybe_unused,
2872 const char *s __maybe_unused,
2873 int unset __maybe_unused)
2875 struct dirent *script_dirent, *lang_dirent;
2876 char scripts_path[MAXPATHLEN];
2877 DIR *scripts_dir, *lang_dir;
2878 char script_path[MAXPATHLEN];
2879 char lang_path[MAXPATHLEN];
2880 struct script_desc *desc;
2881 char first_half[BUFSIZ];
2884 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2886 scripts_dir = opendir(scripts_path);
2889 "open(%s) failed.\n"
2890 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2895 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2896 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2897 lang_dirent->d_name);
2898 lang_dir = opendir(lang_path);
2902 for_each_script(lang_path, lang_dir, script_dirent) {
2903 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
2905 desc = script_desc__findnew(script_root);
2906 scnprintf(script_path, MAXPATHLEN, "%s/%s",
2907 lang_path, script_dirent->d_name);
2908 read_script_info(desc, script_path);
2914 fprintf(stdout, "List of available trace scripts:\n");
2915 list_for_each_entry(desc, &script_descs, node) {
2916 sprintf(first_half, "%s %s", desc->name,
2917 desc->args ? desc->args : "");
2918 fprintf(stdout, " %-36s %s\n", first_half,
2919 desc->half_liner ? desc->half_liner : "");
2926 * Some scripts specify the required events in their "xxx-record" file,
2927 * this function will check if the events in perf.data match those
2928 * mentioned in the "xxx-record".
2930 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
2931 * which is covered well now. And new parsing code should be added to
2932 * cover the future complexing formats like event groups etc.
2934 static int check_ev_match(char *dir_name, char *scriptname,
2935 struct perf_session *session)
2937 char filename[MAXPATHLEN], evname[128];
2938 char line[BUFSIZ], *p;
2939 struct perf_evsel *pos;
2943 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
2945 fp = fopen(filename, "r");
2949 while (fgets(line, sizeof(line), fp)) {
2955 p = strstr(p, "-e");
2961 len = strcspn(p, " \t");
2965 snprintf(evname, len + 1, "%s", p);
2968 evlist__for_each_entry(session->evlist, pos) {
2969 if (!strcmp(perf_evsel__name(pos), evname)) {
2987 * Return -1 if none is found, otherwise the actual scripts number.
2989 * Currently the only user of this function is the script browser, which
2990 * will list all statically runnable scripts, select one, execute it and
2991 * show the output in a perf browser.
2993 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
2996 struct dirent *script_dirent, *lang_dirent;
2997 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
2998 DIR *scripts_dir, *lang_dir;
2999 struct perf_session *session;
3000 struct perf_data data = {
3002 .mode = PERF_DATA_MODE_READ,
3007 session = perf_session__new(&data, false, NULL);
3011 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3013 scripts_dir = opendir(scripts_path);
3015 perf_session__delete(session);
3019 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3020 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3021 lang_dirent->d_name);
3022 #ifndef HAVE_LIBPERL_SUPPORT
3023 if (strstr(lang_path, "perl"))
3026 #ifndef HAVE_LIBPYTHON_SUPPORT
3027 if (strstr(lang_path, "python"))
3031 lang_dir = opendir(lang_path);
3035 for_each_script(lang_path, lang_dir, script_dirent) {
3036 /* Skip those real time scripts: xxxtop.p[yl] */
3037 if (strstr(script_dirent->d_name, "top."))
3041 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3043 script_dirent->d_name);
3044 temp = strchr(script_dirent->d_name, '.');
3045 snprintf(scripts_array[i],
3046 (temp - script_dirent->d_name) + 1,
3047 "%s", script_dirent->d_name);
3049 if (check_ev_match(lang_path,
3050 scripts_array[i], session))
3058 closedir(scripts_dir);
3059 perf_session__delete(session);
3063 static char *get_script_path(const char *script_root, const char *suffix)
3065 struct dirent *script_dirent, *lang_dirent;
3066 char scripts_path[MAXPATHLEN];
3067 char script_path[MAXPATHLEN];
3068 DIR *scripts_dir, *lang_dir;
3069 char lang_path[MAXPATHLEN];
3070 char *__script_root;
3072 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3074 scripts_dir = opendir(scripts_path);
3078 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3079 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3080 lang_dirent->d_name);
3081 lang_dir = opendir(lang_path);
3085 for_each_script(lang_path, lang_dir, script_dirent) {
3086 __script_root = get_script_root(script_dirent, suffix);
3087 if (__script_root && !strcmp(script_root, __script_root)) {
3088 free(__script_root);
3090 closedir(scripts_dir);
3091 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3092 lang_path, script_dirent->d_name);
3093 return strdup(script_path);
3095 free(__script_root);
3099 closedir(scripts_dir);
3104 static bool is_top_script(const char *script_path)
3106 return ends_with(script_path, "top") == NULL ? false : true;
3109 static int has_required_arg(char *script_path)
3111 struct script_desc *desc;
3115 desc = script_desc__new(NULL);
3117 if (read_script_info(desc, script_path))
3123 for (p = desc->args; *p; p++)
3127 script_desc__delete(desc);
3132 static int have_cmd(int argc, const char **argv)
3134 char **__argv = malloc(sizeof(const char *) * argc);
3137 pr_err("malloc failed\n");
3141 memcpy(__argv, argv, sizeof(const char *) * argc);
3142 argc = parse_options(argc, (const char **)__argv, record_options,
3143 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3146 system_wide = (argc == 0);
3151 static void script__setup_sample_type(struct perf_script *script)
3153 struct perf_session *session = script->session;
3154 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
3156 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3157 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3158 (sample_type & PERF_SAMPLE_STACK_USER)) {
3159 callchain_param.record_mode = CALLCHAIN_DWARF;
3160 dwarf_callchain_users = true;
3161 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3162 callchain_param.record_mode = CALLCHAIN_LBR;
3164 callchain_param.record_mode = CALLCHAIN_FP;
3168 static int process_stat_round_event(struct perf_session *session,
3169 union perf_event *event)
3171 struct stat_round_event *round = &event->stat_round;
3172 struct perf_evsel *counter;
3174 evlist__for_each_entry(session->evlist, counter) {
3175 perf_stat_process_counter(&stat_config, counter);
3176 process_stat(counter, round->time);
3179 process_stat_interval(round->time);
3183 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3184 union perf_event *event)
3186 perf_event__read_stat_config(&stat_config, &event->stat_config);
3190 static int set_maps(struct perf_script *script)
3192 struct perf_evlist *evlist = script->session->evlist;
3194 if (!script->cpus || !script->threads)
3197 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3200 perf_evlist__set_maps(evlist, script->cpus, script->threads);
3202 if (perf_evlist__alloc_stats(evlist, true))
3205 script->allocated = true;
3210 int process_thread_map_event(struct perf_session *session,
3211 union perf_event *event)
3213 struct perf_tool *tool = session->tool;
3214 struct perf_script *script = container_of(tool, struct perf_script, tool);
3216 if (script->threads) {
3217 pr_warning("Extra thread map event, ignoring.\n");
3221 script->threads = thread_map__new_event(&event->thread_map);
3222 if (!script->threads)
3225 return set_maps(script);
3229 int process_cpu_map_event(struct perf_session *session,
3230 union perf_event *event)
3232 struct perf_tool *tool = session->tool;
3233 struct perf_script *script = container_of(tool, struct perf_script, tool);
3236 pr_warning("Extra cpu map event, ignoring.\n");
3240 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3244 return set_maps(script);
3247 static int process_feature_event(struct perf_session *session,
3248 union perf_event *event)
3250 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3251 return perf_event__process_feature(session, event);
3255 #ifdef HAVE_AUXTRACE_SUPPORT
3256 static int perf_script__process_auxtrace_info(struct perf_session *session,
3257 union perf_event *event)
3259 struct perf_tool *tool = session->tool;
3261 int ret = perf_event__process_auxtrace_info(session, event);
3264 struct perf_script *script = container_of(tool, struct perf_script, tool);
3266 ret = perf_script__setup_per_event_dump(script);
3272 #define perf_script__process_auxtrace_info 0
3275 static int parse_insn_trace(const struct option *opt __maybe_unused,
3276 const char *str __maybe_unused,
3277 int unset __maybe_unused)
3279 parse_output_fields(NULL, "+insn,-event,-period", 0);
3280 itrace_parse_synth_opts(opt, "i0ns", 0);
3281 symbol_conf.nanosecs = true;
3285 static int parse_xed(const struct option *opt __maybe_unused,
3286 const char *str __maybe_unused,
3287 int unset __maybe_unused)
3289 force_pager("xed -F insn: -A -64 | less");
3293 static int parse_call_trace(const struct option *opt __maybe_unused,
3294 const char *str __maybe_unused,
3295 int unset __maybe_unused)
3297 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3298 itrace_parse_synth_opts(opt, "cewp", 0);
3299 symbol_conf.nanosecs = true;
3300 symbol_conf.pad_output_len_dso = 50;
3304 static int parse_callret_trace(const struct option *opt __maybe_unused,
3305 const char *str __maybe_unused,
3306 int unset __maybe_unused)
3308 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3309 itrace_parse_synth_opts(opt, "crewp", 0);
3310 symbol_conf.nanosecs = true;
3314 int cmd_script(int argc, const char **argv)
3316 bool show_full_info = false;
3317 bool header = false;
3318 bool header_only = false;
3319 bool script_started = false;
3320 char *rec_script_path = NULL;
3321 char *rep_script_path = NULL;
3322 struct perf_session *session;
3323 struct itrace_synth_opts itrace_synth_opts = {
3325 .default_no_sample = true,
3328 char *script_path = NULL;
3329 const char **__argv;
3331 struct perf_script script = {
3333 .sample = process_sample_event,
3334 .mmap = perf_event__process_mmap,
3335 .mmap2 = perf_event__process_mmap2,
3336 .comm = perf_event__process_comm,
3337 .namespaces = perf_event__process_namespaces,
3338 .exit = perf_event__process_exit,
3339 .fork = perf_event__process_fork,
3340 .attr = process_attr,
3341 .event_update = perf_event__process_event_update,
3342 .tracing_data = perf_event__process_tracing_data,
3343 .feature = process_feature_event,
3344 .build_id = perf_event__process_build_id,
3345 .id_index = perf_event__process_id_index,
3346 .auxtrace_info = perf_script__process_auxtrace_info,
3347 .auxtrace = perf_event__process_auxtrace,
3348 .auxtrace_error = perf_event__process_auxtrace_error,
3349 .stat = perf_event__process_stat_event,
3350 .stat_round = process_stat_round_event,
3351 .stat_config = process_stat_config_event,
3352 .thread_map = process_thread_map_event,
3353 .cpu_map = process_cpu_map_event,
3354 .ordered_events = true,
3355 .ordering_requires_timestamps = true,
3358 struct perf_data data = {
3359 .mode = PERF_DATA_MODE_READ,
3361 const struct option options[] = {
3362 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3363 "dump raw trace in ASCII"),
3364 OPT_INCR('v', "verbose", &verbose,
3365 "be more verbose (show symbol address, etc)"),
3366 OPT_BOOLEAN('L', "Latency", &latency_format,
3367 "show latency attributes (irqs/preemption disabled, etc)"),
3368 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3369 list_available_scripts),
3370 OPT_CALLBACK('s', "script", NULL, "name",
3371 "script file name (lang:script name, script name, or *)",
3373 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3374 "generate perf-script.xx script in specified language"),
3375 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3376 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3377 "do various checks like samples ordering and lost events"),
3378 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3379 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3380 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3381 "file", "vmlinux pathname"),
3382 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3383 "file", "kallsyms pathname"),
3384 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3385 "When printing symbols do not display call chain"),
3386 OPT_CALLBACK(0, "symfs", NULL, "directory",
3387 "Look for files with symbols relative to this directory",
3388 symbol__config_symfs),
3389 OPT_CALLBACK('F', "fields", NULL, "str",
3390 "comma separated output fields prepend with 'type:'. "
3391 "+field to add and -field to remove."
3392 "Valid types: hw,sw,trace,raw,synth. "
3393 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3394 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3395 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3396 "callindent,insn,insnlen,synth,phys_addr,metric,misc",
3397 parse_output_fields),
3398 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3399 "system-wide collection from all CPUs"),
3400 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3401 "only consider these symbols"),
3402 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3403 "Decode instructions from itrace", parse_insn_trace),
3404 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3405 "Run xed disassembler on output", parse_xed),
3406 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3407 "Decode calls from from itrace", parse_call_trace),
3408 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3409 "Decode calls and returns from itrace", parse_callret_trace),
3410 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3411 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3412 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3413 "Stop display of callgraph at these symbols"),
3414 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3415 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3416 "only display events for these comms"),
3417 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3418 "only consider symbols in these pids"),
3419 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3420 "only consider symbols in these tids"),
3421 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3422 "Set the maximum stack depth when parsing the callchain, "
3423 "anything beyond the specified depth will be ignored. "
3424 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3425 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3426 OPT_BOOLEAN('I', "show-info", &show_full_info,
3427 "display extended information from perf.data file"),
3428 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3429 "Show the path of [kernel.kallsyms]"),
3430 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3431 "Show the fork/comm/exit events"),
3432 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3433 "Show the mmap events"),
3434 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3435 "Show context switch events (if recorded)"),
3436 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3437 "Show namespace events (if recorded)"),
3438 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3439 "Show lost events (if recorded)"),
3440 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3441 "Show round events (if recorded)"),
3442 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3443 "Dump trace output to files named by the monitored events"),
3444 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3445 OPT_INTEGER(0, "max-blocks", &max_blocks,
3446 "Maximum number of code blocks to dump with brstackinsn"),
3447 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3448 "Use 9 decimal places when displaying time"),
3449 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3450 "Instruction Tracing options\n" ITRACE_HELP,
3451 itrace_parse_synth_opts),
3452 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3453 "Show full source file name path for source lines"),
3454 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3455 "Enable symbol demangling"),
3456 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3457 "Enable kernel symbol demangling"),
3458 OPT_STRING(0, "time", &script.time_str, "str",
3459 "Time span of interest (start,stop)"),
3460 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3461 "Show inline function"),
3464 const char * const script_subcommands[] = { "record", "report", NULL };
3465 const char *script_usage[] = {
3466 "perf script [<options>]",
3467 "perf script [<options>] record <script> [<record-options>] <command>",
3468 "perf script [<options>] report <script> [script-args]",
3469 "perf script [<options>] <script> [<record-options>] <command>",
3470 "perf script [<options>] <top-script> [script-args]",
3474 perf_set_singlethreaded();
3478 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3479 PARSE_OPT_STOP_AT_NON_OPTION);
3481 data.path = input_name;
3482 data.force = symbol_conf.force;
3484 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3485 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3486 if (!rec_script_path)
3487 return cmd_record(argc, argv);
3490 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3491 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3492 if (!rep_script_path) {
3494 "Please specify a valid report script"
3495 "(see 'perf script -l' for listing)\n");
3500 if (script.time_str && reltime) {
3501 fprintf(stderr, "Don't combine --reltime with --time\n");
3505 if (itrace_synth_opts.callchain &&
3506 itrace_synth_opts.callchain_sz > scripting_max_stack)
3507 scripting_max_stack = itrace_synth_opts.callchain_sz;
3509 /* make sure PERF_EXEC_PATH is set for scripts */
3510 set_argv_exec_path(get_argv_exec_path());
3512 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3517 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3518 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3520 if (!rec_script_path && !rep_script_path) {
3521 usage_with_options_msg(script_usage, options,
3522 "Couldn't find script `%s'\n\n See perf"
3523 " script -l for available scripts.\n", argv[0]);
3526 if (is_top_script(argv[0])) {
3527 rep_args = argc - 1;
3531 rep_args = has_required_arg(rep_script_path);
3532 rec_args = (argc - 1) - rep_args;
3534 usage_with_options_msg(script_usage, options,
3535 "`%s' script requires options."
3536 "\n\n See perf script -l for available "
3537 "scripts and options.\n", argv[0]);
3541 if (pipe(live_pipe) < 0) {
3542 perror("failed to create pipe");
3548 perror("failed to fork");
3555 dup2(live_pipe[1], 1);
3556 close(live_pipe[0]);
3558 if (is_top_script(argv[0])) {
3560 } else if (!system_wide) {
3561 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3567 __argv = malloc((argc + 6) * sizeof(const char *));
3569 pr_err("malloc failed\n");
3574 __argv[j++] = "/bin/sh";
3575 __argv[j++] = rec_script_path;
3581 for (i = rep_args + 1; i < argc; i++)
3582 __argv[j++] = argv[i];
3585 execvp("/bin/sh", (char **)__argv);
3590 dup2(live_pipe[0], 0);
3591 close(live_pipe[1]);
3593 __argv = malloc((argc + 4) * sizeof(const char *));
3595 pr_err("malloc failed\n");
3601 __argv[j++] = "/bin/sh";
3602 __argv[j++] = rep_script_path;
3603 for (i = 1; i < rep_args + 1; i++)
3604 __argv[j++] = argv[i];
3609 execvp("/bin/sh", (char **)__argv);
3614 if (rec_script_path)
3615 script_path = rec_script_path;
3616 if (rep_script_path)
3617 script_path = rep_script_path;
3622 if (!rec_script_path)
3623 system_wide = false;
3624 else if (!system_wide) {
3625 if (have_cmd(argc - 1, &argv[1]) != 0) {
3631 __argv = malloc((argc + 2) * sizeof(const char *));
3633 pr_err("malloc failed\n");
3638 __argv[j++] = "/bin/sh";
3639 __argv[j++] = script_path;
3642 for (i = 2; i < argc; i++)
3643 __argv[j++] = argv[i];
3646 execvp("/bin/sh", (char **)__argv);
3656 session = perf_session__new(&data, false, &script.tool);
3657 if (session == NULL)
3660 if (header || header_only) {
3661 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3662 perf_session__fprintf_info(session, stdout, show_full_info);
3667 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3669 if (symbol__init(&session->header.env) < 0)
3673 if (!strcmp(uts.machine, session->header.env.arch) ||
3674 (!strcmp(uts.machine, "x86_64") &&
3675 !strcmp(session->header.env.arch, "i386")))
3678 script.session = session;
3679 script__setup_sample_type(&script);
3681 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3682 symbol_conf.graph_function)
3683 itrace_synth_opts.thread_stack = true;
3685 session->itrace_synth_opts = &itrace_synth_opts;
3688 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3691 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3695 symbol_conf.use_callchain = true;
3697 symbol_conf.use_callchain = false;
3699 if (session->tevent.pevent &&
3700 tep_set_function_resolver(session->tevent.pevent,
3701 machine__resolve_kernel_addr,
3702 &session->machines.host) < 0) {
3703 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3708 if (generate_script_lang) {
3709 struct stat perf_stat;
3712 if (output_set_by_user()) {
3714 "custom fields not supported for generated scripts");
3719 input = open(data.path, O_RDONLY); /* input_name */
3722 perror("failed to open file");
3726 err = fstat(input, &perf_stat);
3728 perror("failed to stat file");
3732 if (!perf_stat.st_size) {
3733 fprintf(stderr, "zero-sized file, nothing to do!\n");
3737 scripting_ops = script_spec__lookup(generate_script_lang);
3738 if (!scripting_ops) {
3739 fprintf(stderr, "invalid language specifier");
3744 err = scripting_ops->generate_script(session->tevent.pevent,
3750 err = scripting_ops->start_script(script_name, argc, argv);
3753 pr_debug("perf script started with script %s\n\n", script_name);
3754 script_started = true;
3758 err = perf_session__check_output_opt(session);
3762 if (script.time_str) {
3763 err = perf_time__parse_for_ranges(script.time_str, session,
3764 &script.ptime_range,
3771 err = __cmd_script(&script);
3776 if (script.ptime_range)
3777 zfree(&script.ptime_range);
3779 perf_evlist__free_stats(session->evlist);
3780 perf_session__delete(session);
3783 cleanup_scripting();