4 #include "util/cache.h"
5 #include "util/debug.h"
6 #include <subcmd/exec-cmd.h>
7 #include "util/header.h"
8 #include <subcmd/parse-options.h>
9 #include "util/perf_regs.h"
10 #include "util/session.h"
11 #include "util/tool.h"
12 #include "util/symbol.h"
13 #include "util/thread.h"
14 #include "util/trace-event.h"
15 #include "util/util.h"
16 #include "util/evlist.h"
17 #include "util/evsel.h"
18 #include "util/sort.h"
19 #include "util/data.h"
20 #include "util/auxtrace.h"
21 #include "util/cpumap.h"
22 #include "util/thread_map.h"
23 #include "util/stat.h"
24 #include "util/string2.h"
25 #include "util/thread-stack.h"
26 #include "util/time-utils.h"
27 #include "print_binary.h"
28 #include <linux/bitmap.h>
29 #include <linux/kernel.h>
30 #include <linux/stringify.h>
31 #include <linux/time64.h>
33 #include "util/mem-events.h"
34 #include "util/dump-insn.h"
39 #include <sys/param.h>
40 #include <sys/types.h>
44 #include "sane_ctype.h"
46 static char const *script_name;
47 static char const *generate_script_lang;
48 static bool debug_mode;
49 static u64 last_timestamp;
50 static u64 nr_unordered;
51 static bool no_callchain;
52 static bool latency_format;
53 static bool system_wide;
54 static bool print_flags;
56 static const char *cpu_list;
57 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
58 static struct perf_stat_config stat_config;
59 static int max_blocks;
61 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
63 enum perf_output_field {
64 PERF_OUTPUT_COMM = 1U << 0,
65 PERF_OUTPUT_TID = 1U << 1,
66 PERF_OUTPUT_PID = 1U << 2,
67 PERF_OUTPUT_TIME = 1U << 3,
68 PERF_OUTPUT_CPU = 1U << 4,
69 PERF_OUTPUT_EVNAME = 1U << 5,
70 PERF_OUTPUT_TRACE = 1U << 6,
71 PERF_OUTPUT_IP = 1U << 7,
72 PERF_OUTPUT_SYM = 1U << 8,
73 PERF_OUTPUT_DSO = 1U << 9,
74 PERF_OUTPUT_ADDR = 1U << 10,
75 PERF_OUTPUT_SYMOFFSET = 1U << 11,
76 PERF_OUTPUT_SRCLINE = 1U << 12,
77 PERF_OUTPUT_PERIOD = 1U << 13,
78 PERF_OUTPUT_IREGS = 1U << 14,
79 PERF_OUTPUT_BRSTACK = 1U << 15,
80 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
81 PERF_OUTPUT_DATA_SRC = 1U << 17,
82 PERF_OUTPUT_WEIGHT = 1U << 18,
83 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
84 PERF_OUTPUT_CALLINDENT = 1U << 20,
85 PERF_OUTPUT_INSN = 1U << 21,
86 PERF_OUTPUT_INSNLEN = 1U << 22,
87 PERF_OUTPUT_BRSTACKINSN = 1U << 23,
88 PERF_OUTPUT_BRSTACKOFF = 1U << 24,
91 struct output_option {
93 enum perf_output_field field;
94 } all_output_options[] = {
95 {.str = "comm", .field = PERF_OUTPUT_COMM},
96 {.str = "tid", .field = PERF_OUTPUT_TID},
97 {.str = "pid", .field = PERF_OUTPUT_PID},
98 {.str = "time", .field = PERF_OUTPUT_TIME},
99 {.str = "cpu", .field = PERF_OUTPUT_CPU},
100 {.str = "event", .field = PERF_OUTPUT_EVNAME},
101 {.str = "trace", .field = PERF_OUTPUT_TRACE},
102 {.str = "ip", .field = PERF_OUTPUT_IP},
103 {.str = "sym", .field = PERF_OUTPUT_SYM},
104 {.str = "dso", .field = PERF_OUTPUT_DSO},
105 {.str = "addr", .field = PERF_OUTPUT_ADDR},
106 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
107 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
108 {.str = "period", .field = PERF_OUTPUT_PERIOD},
109 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
110 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
111 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
112 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
113 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
114 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
115 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
116 {.str = "insn", .field = PERF_OUTPUT_INSN},
117 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
118 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
119 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
123 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
127 /* default set to maintain compatibility with current format */
131 unsigned int print_ip_opts;
134 } output[OUTPUT_TYPE_MAX] = {
136 [PERF_TYPE_HARDWARE] = {
139 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
140 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
141 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
142 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
145 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
148 [PERF_TYPE_SOFTWARE] = {
151 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
152 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
153 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
154 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
155 PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
157 .invalid_fields = PERF_OUTPUT_TRACE,
160 [PERF_TYPE_TRACEPOINT] = {
163 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
164 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
165 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
171 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
172 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
173 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
174 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
175 PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR |
176 PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
178 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
181 [PERF_TYPE_BREAKPOINT] = {
184 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
185 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
186 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
187 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
190 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
193 [OUTPUT_TYPE_SYNTH] = {
196 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
197 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
198 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
199 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
201 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
205 static inline int output_type(unsigned int type)
208 case PERF_TYPE_SYNTH:
209 return OUTPUT_TYPE_SYNTH;
215 static inline unsigned int attr_type(unsigned int type)
218 case OUTPUT_TYPE_SYNTH:
219 return PERF_TYPE_SYNTH;
225 static bool output_set_by_user(void)
228 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
229 if (output[j].user_set)
235 static const char *output_field2str(enum perf_output_field field)
237 int i, imax = ARRAY_SIZE(all_output_options);
238 const char *str = "";
240 for (i = 0; i < imax; ++i) {
241 if (all_output_options[i].field == field) {
242 str = all_output_options[i].str;
249 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
251 static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
252 u64 sample_type, const char *sample_msg,
253 enum perf_output_field field,
256 struct perf_event_attr *attr = &evsel->attr;
257 int type = output_type(attr->type);
260 if (attr->sample_type & sample_type)
263 if (output[type].user_set) {
266 evname = perf_evsel__name(evsel);
267 pr_err("Samples for '%s' event do not have %s attribute set. "
268 "Cannot print '%s' field.\n",
269 evname, sample_msg, output_field2str(field));
273 /* user did not ask for it explicitly so remove from the default list */
274 output[type].fields &= ~field;
275 evname = perf_evsel__name(evsel);
276 pr_debug("Samples for '%s' event do not have %s attribute set. "
277 "Skipping '%s' field.\n",
278 evname, sample_msg, output_field2str(field));
283 static int perf_evsel__check_stype(struct perf_evsel *evsel,
284 u64 sample_type, const char *sample_msg,
285 enum perf_output_field field)
287 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
291 static int perf_evsel__check_attr(struct perf_evsel *evsel,
292 struct perf_session *session)
294 struct perf_event_attr *attr = &evsel->attr;
297 if (perf_header__has_feat(&session->header, HEADER_STAT))
300 allow_user_set = perf_header__has_feat(&session->header,
303 if (PRINT_FIELD(TRACE) &&
304 !perf_session__has_traces(session, "record -R"))
307 if (PRINT_FIELD(IP)) {
308 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
313 if (PRINT_FIELD(ADDR) &&
314 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
315 PERF_OUTPUT_ADDR, allow_user_set))
318 if (PRINT_FIELD(DATA_SRC) &&
319 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
320 PERF_OUTPUT_DATA_SRC))
323 if (PRINT_FIELD(WEIGHT) &&
324 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
328 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
329 pr_err("Display of symbols requested but neither sample IP nor "
330 "sample address\nis selected. Hence, no addresses to convert "
334 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
335 pr_err("Display of offsets requested but symbol is not"
339 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR) &&
340 !PRINT_FIELD(BRSTACK) && !PRINT_FIELD(BRSTACKSYM) && !PRINT_FIELD(BRSTACKOFF)) {
341 pr_err("Display of DSO requested but no address to convert. Select\n"
342 "sample IP, sample address, brstack, brstacksym, or brstackoff.\n");
345 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
346 pr_err("Display of source line number requested but sample IP is not\n"
347 "selected. Hence, no address to lookup the source line number.\n");
350 if (PRINT_FIELD(BRSTACKINSN) &&
351 !(perf_evlist__combined_branch_type(session->evlist) &
352 PERF_SAMPLE_BRANCH_ANY)) {
353 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
354 "Hint: run 'perf record -b ...'\n");
357 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
358 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
359 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
362 if (PRINT_FIELD(TIME) &&
363 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
367 if (PRINT_FIELD(CPU) &&
368 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
369 PERF_OUTPUT_CPU, allow_user_set))
372 if (PRINT_FIELD(PERIOD) &&
373 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
377 if (PRINT_FIELD(IREGS) &&
378 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
385 static void set_print_ip_opts(struct perf_event_attr *attr)
387 unsigned int type = output_type(attr->type);
389 output[type].print_ip_opts = 0;
391 output[type].print_ip_opts |= EVSEL__PRINT_IP;
393 if (PRINT_FIELD(SYM))
394 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
396 if (PRINT_FIELD(DSO))
397 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
399 if (PRINT_FIELD(SYMOFFSET))
400 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
402 if (PRINT_FIELD(SRCLINE))
403 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
407 * verify all user requested events exist and the samples
408 * have the expected data
410 static int perf_session__check_output_opt(struct perf_session *session)
413 struct perf_evsel *evsel;
415 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
416 evsel = perf_session__find_first_evtype(session, attr_type(j));
419 * even if fields is set to 0 (ie., show nothing) event must
420 * exist if user explicitly includes it on the command line
422 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
423 j != OUTPUT_TYPE_SYNTH) {
424 pr_err("%s events do not exist. "
425 "Remove corresponding -F option to proceed.\n",
430 if (evsel && output[j].fields &&
431 perf_evsel__check_attr(evsel, session))
437 set_print_ip_opts(&evsel->attr);
441 bool use_callchain = false;
442 bool not_pipe = false;
444 evlist__for_each_entry(session->evlist, evsel) {
446 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
447 use_callchain = true;
451 if (not_pipe && !use_callchain)
452 symbol_conf.use_callchain = false;
456 * set default for tracepoints to print symbols only
457 * if callchains are present
459 if (symbol_conf.use_callchain &&
460 !output[PERF_TYPE_TRACEPOINT].user_set) {
461 struct perf_event_attr *attr;
463 j = PERF_TYPE_TRACEPOINT;
465 evlist__for_each_entry(session->evlist, evsel) {
466 if (evsel->attr.type != j)
471 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
472 output[j].fields |= PERF_OUTPUT_IP;
473 output[j].fields |= PERF_OUTPUT_SYM;
474 output[j].fields |= PERF_OUTPUT_DSO;
475 set_print_ip_opts(attr);
485 static void print_sample_iregs(struct perf_sample *sample,
486 struct perf_event_attr *attr)
488 struct regs_dump *regs = &sample->intr_regs;
489 uint64_t mask = attr->sample_regs_intr;
495 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
496 u64 val = regs->regs[i++];
497 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
501 static void print_sample_start(struct perf_sample *sample,
502 struct thread *thread,
503 struct perf_evsel *evsel)
505 struct perf_event_attr *attr = &evsel->attr;
507 unsigned long long nsecs;
509 if (PRINT_FIELD(COMM)) {
511 printf("%8.8s ", thread__comm_str(thread));
512 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
513 printf("%s ", thread__comm_str(thread));
515 printf("%16s ", thread__comm_str(thread));
518 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
519 printf("%5d/%-5d ", sample->pid, sample->tid);
520 else if (PRINT_FIELD(PID))
521 printf("%5d ", sample->pid);
522 else if (PRINT_FIELD(TID))
523 printf("%5d ", sample->tid);
525 if (PRINT_FIELD(CPU)) {
527 printf("%3d ", sample->cpu);
529 printf("[%03d] ", sample->cpu);
532 if (PRINT_FIELD(TIME)) {
533 nsecs = sample->time;
534 secs = nsecs / NSEC_PER_SEC;
535 nsecs -= secs * NSEC_PER_SEC;
538 printf("%5lu.%09llu: ", secs, nsecs);
540 char sample_time[32];
541 timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time));
542 printf("%12s: ", sample_time);
548 mispred_str(struct branch_entry *br)
550 if (!(br->flags.mispred || br->flags.predicted))
553 return br->flags.predicted ? 'P' : 'M';
556 static void print_sample_brstack(struct perf_sample *sample,
557 struct thread *thread,
558 struct perf_event_attr *attr)
560 struct branch_stack *br = sample->branch_stack;
561 struct addr_location alf, alt;
567 for (i = 0; i < br->nr; i++) {
568 from = br->entries[i].from;
569 to = br->entries[i].to;
571 if (PRINT_FIELD(DSO)) {
572 memset(&alf, 0, sizeof(alf));
573 memset(&alt, 0, sizeof(alt));
574 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
575 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
578 printf("0x%"PRIx64, from);
579 if (PRINT_FIELD(DSO)) {
581 map__fprintf_dsoname(alf.map, stdout);
585 printf("/0x%"PRIx64, to);
586 if (PRINT_FIELD(DSO)) {
588 map__fprintf_dsoname(alt.map, stdout);
592 printf("/%c/%c/%c/%d ",
593 mispred_str( br->entries + i),
594 br->entries[i].flags.in_tx? 'X' : '-',
595 br->entries[i].flags.abort? 'A' : '-',
596 br->entries[i].flags.cycles);
600 static void print_sample_brstacksym(struct perf_sample *sample,
601 struct thread *thread,
602 struct perf_event_attr *attr)
604 struct branch_stack *br = sample->branch_stack;
605 struct addr_location alf, alt;
611 for (i = 0; i < br->nr; i++) {
613 memset(&alf, 0, sizeof(alf));
614 memset(&alt, 0, sizeof(alt));
615 from = br->entries[i].from;
616 to = br->entries[i].to;
618 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
620 alf.sym = map__find_symbol(alf.map, alf.addr);
622 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
624 alt.sym = map__find_symbol(alt.map, alt.addr);
626 symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
627 if (PRINT_FIELD(DSO)) {
629 map__fprintf_dsoname(alf.map, stdout);
633 symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
634 if (PRINT_FIELD(DSO)) {
636 map__fprintf_dsoname(alt.map, stdout);
639 printf("/%c/%c/%c/%d ",
640 mispred_str( br->entries + i),
641 br->entries[i].flags.in_tx? 'X' : '-',
642 br->entries[i].flags.abort? 'A' : '-',
643 br->entries[i].flags.cycles);
647 static void print_sample_brstackoff(struct perf_sample *sample,
648 struct thread *thread,
649 struct perf_event_attr *attr)
651 struct branch_stack *br = sample->branch_stack;
652 struct addr_location alf, alt;
658 for (i = 0; i < br->nr; i++) {
660 memset(&alf, 0, sizeof(alf));
661 memset(&alt, 0, sizeof(alt));
662 from = br->entries[i].from;
663 to = br->entries[i].to;
665 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
666 if (alf.map && !alf.map->dso->adjust_symbols)
667 from = map__map_ip(alf.map, from);
669 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
670 if (alt.map && !alt.map->dso->adjust_symbols)
671 to = map__map_ip(alt.map, to);
673 printf("0x%"PRIx64, from);
674 if (PRINT_FIELD(DSO)) {
676 map__fprintf_dsoname(alf.map, stdout);
679 printf("/0x%"PRIx64, to);
680 if (PRINT_FIELD(DSO)) {
682 map__fprintf_dsoname(alt.map, stdout);
685 printf("/%c/%c/%c/%d ",
686 mispred_str(br->entries + i),
687 br->entries[i].flags.in_tx ? 'X' : '-',
688 br->entries[i].flags.abort ? 'A' : '-',
689 br->entries[i].flags.cycles);
692 #define MAXBB 16384UL
694 static int grab_bb(u8 *buffer, u64 start, u64 end,
695 struct machine *machine, struct thread *thread,
696 bool *is64bit, u8 *cpumode, bool last)
699 struct addr_location al;
705 kernel = machine__kernel_ip(machine, start);
707 *cpumode = PERF_RECORD_MISC_KERNEL;
709 *cpumode = PERF_RECORD_MISC_USER;
712 * Block overlaps between kernel and user.
713 * This can happen due to ring filtering
714 * On Intel CPUs the entry into the kernel is filtered,
715 * but the exit is not. Let the caller patch it up.
717 if (kernel != machine__kernel_ip(machine, end)) {
718 printf("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n",
723 memset(&al, 0, sizeof(al));
724 if (end - start > MAXBB - MAXINSN) {
726 printf("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
728 printf("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
732 thread__find_addr_map(thread, *cpumode, MAP__FUNCTION, start, &al);
733 if (!al.map || !al.map->dso) {
734 printf("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
737 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
738 printf("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
742 /* Load maps to ensure dso->is_64_bit has been updated */
745 offset = al.map->map_ip(al.map, start);
746 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
747 end - start + MAXINSN);
749 *is64bit = al.map->dso->is_64_bit;
751 printf("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
756 static void print_jump(uint64_t ip, struct branch_entry *en,
757 struct perf_insn *x, u8 *inbuf, int len,
760 printf("\t%016" PRIx64 "\t%-30s\t#%s%s%s%s",
762 dump_insn(x, ip, inbuf, len, NULL),
763 en->flags.predicted ? " PRED" : "",
764 en->flags.mispred ? " MISPRED" : "",
765 en->flags.in_tx ? " INTX" : "",
766 en->flags.abort ? " ABORT" : "");
767 if (en->flags.cycles) {
768 printf(" %d cycles", en->flags.cycles);
770 printf(" %.2f IPC", (float)insn / en->flags.cycles);
775 static void print_ip_sym(struct thread *thread, u8 cpumode, int cpu,
776 uint64_t addr, struct symbol **lastsym,
777 struct perf_event_attr *attr)
779 struct addr_location al;
782 memset(&al, 0, sizeof(al));
784 thread__find_addr_map(thread, cpumode, MAP__FUNCTION, addr, &al);
786 thread__find_addr_map(thread, cpumode, MAP__VARIABLE,
788 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
794 al.sym = map__find_symbol(al.map, al.addr);
799 if (al.addr < al.sym->end)
800 off = al.addr - al.sym->start;
802 off = al.addr - al.map->start - al.sym->start;
803 printf("\t%s", al.sym->name);
807 if (PRINT_FIELD(SRCLINE))
808 map__fprintf_srcline(al.map, al.addr, "\t", stdout);
813 static void print_sample_brstackinsn(struct perf_sample *sample,
814 struct thread *thread,
815 struct perf_event_attr *attr,
816 struct machine *machine)
818 struct branch_stack *br = sample->branch_stack;
820 int i, insn, len, nr, ilen;
824 struct symbol *lastsym = NULL;
829 if (max_blocks && nr > max_blocks + 1)
837 /* Handle first from jump, of which we don't know the entry. */
838 len = grab_bb(buffer, br->entries[nr-1].from,
839 br->entries[nr-1].from,
840 machine, thread, &x.is64bit, &x.cpumode, false);
842 print_ip_sym(thread, x.cpumode, x.cpu,
843 br->entries[nr - 1].from, &lastsym, attr);
844 print_jump(br->entries[nr - 1].from, &br->entries[nr - 1],
848 /* Print all blocks */
849 for (i = nr - 2; i >= 0; i--) {
850 if (br->entries[i].from || br->entries[i].to)
851 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
854 start = br->entries[i + 1].to;
855 end = br->entries[i].from;
857 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
858 /* Patch up missing kernel transfers due to ring filters */
859 if (len == -ENXIO && i > 0) {
860 end = br->entries[--i].from;
861 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
862 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
868 for (off = 0;; off += ilen) {
869 uint64_t ip = start + off;
871 print_ip_sym(thread, x.cpumode, x.cpu, ip, &lastsym, attr);
873 print_jump(ip, &br->entries[i], &x, buffer + off, len - off, insn);
876 printf("\t%016" PRIx64 "\t%s\n", ip,
877 dump_insn(&x, ip, buffer + off, len - off, &ilen));
886 * Hit the branch? In this case we are already done, and the target
887 * has not been executed yet.
889 if (br->entries[0].from == sample->ip)
891 if (br->entries[0].flags.abort)
895 * Print final block upto sample
897 start = br->entries[0].to;
899 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
900 print_ip_sym(thread, x.cpumode, x.cpu, start, &lastsym, attr);
902 /* Print at least last IP if basic block did not work */
903 len = grab_bb(buffer, sample->ip, sample->ip,
904 machine, thread, &x.is64bit, &x.cpumode, false);
908 printf("\t%016" PRIx64 "\t%s\n", sample->ip,
909 dump_insn(&x, sample->ip, buffer, len, NULL));
912 for (off = 0; off <= end - start; off += ilen) {
913 printf("\t%016" PRIx64 "\t%s\n", start + off,
914 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
920 static void print_sample_addr(struct perf_sample *sample,
921 struct thread *thread,
922 struct perf_event_attr *attr)
924 struct addr_location al;
926 printf("%16" PRIx64, sample->addr);
928 if (!sample_addr_correlates_sym(attr))
931 thread__resolve(thread, &al, sample);
933 if (PRINT_FIELD(SYM)) {
935 if (PRINT_FIELD(SYMOFFSET))
936 symbol__fprintf_symname_offs(al.sym, &al, stdout);
938 symbol__fprintf_symname(al.sym, stdout);
941 if (PRINT_FIELD(DSO)) {
943 map__fprintf_dsoname(al.map, stdout);
948 static void print_sample_callindent(struct perf_sample *sample,
949 struct perf_evsel *evsel,
950 struct thread *thread,
951 struct addr_location *al)
953 struct perf_event_attr *attr = &evsel->attr;
954 size_t depth = thread_stack__depth(thread);
955 struct addr_location addr_al;
956 const char *name = NULL;
962 * The 'return' has already been popped off the stack so the depth has
963 * to be adjusted to match the 'call'.
965 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
968 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
969 if (sample_addr_correlates_sym(attr)) {
970 thread__resolve(thread, &addr_al, sample);
972 name = addr_al.sym->name;
978 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
980 name = al->sym->name;
986 len = printf("%*s%s", (int)depth * 4, "", name);
988 len = printf("%*s%16" PRIx64, (int)depth * 4, "", ip);
994 * Try to keep the output length from changing frequently so that the
995 * output lines up more nicely.
997 if (len > spacing || (len && len < spacing - 52))
998 spacing = round_up(len + 4, 32);
1001 printf("%*s", spacing - len, "");
1004 static void print_insn(struct perf_sample *sample,
1005 struct perf_event_attr *attr,
1006 struct thread *thread,
1007 struct machine *machine)
1009 if (PRINT_FIELD(INSNLEN))
1010 printf(" ilen: %d", sample->insn_len);
1011 if (PRINT_FIELD(INSN)) {
1015 for (i = 0; i < sample->insn_len; i++)
1016 printf(" %02x", (unsigned char)sample->insn[i]);
1018 if (PRINT_FIELD(BRSTACKINSN))
1019 print_sample_brstackinsn(sample, thread, attr, machine);
1022 static void print_sample_bts(struct perf_sample *sample,
1023 struct perf_evsel *evsel,
1024 struct thread *thread,
1025 struct addr_location *al,
1026 struct machine *machine)
1028 struct perf_event_attr *attr = &evsel->attr;
1029 unsigned int type = output_type(attr->type);
1030 bool print_srcline_last = false;
1032 if (PRINT_FIELD(CALLINDENT))
1033 print_sample_callindent(sample, evsel, thread, al);
1035 /* print branch_from information */
1036 if (PRINT_FIELD(IP)) {
1037 unsigned int print_opts = output[type].print_ip_opts;
1038 struct callchain_cursor *cursor = NULL;
1040 if (symbol_conf.use_callchain && sample->callchain &&
1041 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1042 sample, NULL, NULL, scripting_max_stack) == 0)
1043 cursor = &callchain_cursor;
1045 if (cursor == NULL) {
1047 if (print_opts & EVSEL__PRINT_SRCLINE) {
1048 print_srcline_last = true;
1049 print_opts &= ~EVSEL__PRINT_SRCLINE;
1054 sample__fprintf_sym(sample, al, 0, print_opts, cursor, stdout);
1057 /* print branch_to information */
1058 if (PRINT_FIELD(ADDR) ||
1059 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
1060 !output[type].user_set)) {
1062 print_sample_addr(sample, thread, attr);
1065 if (print_srcline_last)
1066 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
1068 print_insn(sample, attr, thread, machine);
1076 } sample_flags[] = {
1077 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1078 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1079 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1080 {PERF_IP_FLAG_BRANCH, "jmp"},
1081 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1082 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1083 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1084 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1085 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1086 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1087 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1088 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1089 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1093 static void print_sample_flags(u32 flags)
1095 const char *chars = PERF_IP_FLAG_CHARS;
1096 const int n = strlen(PERF_IP_FLAG_CHARS);
1097 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1098 const char *name = NULL;
1102 for (i = 0; sample_flags[i].name ; i++) {
1103 if (sample_flags[i].flags == (flags & ~PERF_IP_FLAG_IN_TX)) {
1104 name = sample_flags[i].name;
1109 for (i = 0; i < n; i++, flags >>= 1) {
1111 str[pos++] = chars[i];
1113 for (; i < 32; i++, flags >>= 1) {
1120 printf(" %-7s%4s ", name, in_tx ? "(x)" : "");
1122 printf(" %-11s ", str);
1125 struct printer_data {
1132 print_sample_bpf_output_printer(enum binary_printer_ops op,
1136 unsigned char ch = (unsigned char)val;
1137 struct printer_data *printer_data = extra;
1140 case BINARY_PRINT_DATA_BEGIN:
1143 case BINARY_PRINT_LINE_BEGIN:
1144 printf("%17s", !printer_data->line_no ? "BPF output:" :
1147 case BINARY_PRINT_ADDR:
1148 printf(" %04x:", val);
1150 case BINARY_PRINT_NUM_DATA:
1151 printf(" %02x", val);
1153 case BINARY_PRINT_NUM_PAD:
1156 case BINARY_PRINT_SEP:
1159 case BINARY_PRINT_CHAR_DATA:
1160 if (printer_data->hit_nul && ch)
1161 printer_data->is_printable = false;
1166 if (!printer_data->is_printable)
1170 printer_data->hit_nul = true;
1172 printer_data->is_printable = false;
1177 case BINARY_PRINT_CHAR_PAD:
1180 case BINARY_PRINT_LINE_END:
1182 printer_data->line_no++;
1184 case BINARY_PRINT_DATA_END:
1190 static void print_sample_bpf_output(struct perf_sample *sample)
1192 unsigned int nr_bytes = sample->raw_size;
1193 struct printer_data printer_data = {0, false, true};
1195 print_binary(sample->raw_data, nr_bytes, 8,
1196 print_sample_bpf_output_printer, &printer_data);
1198 if (printer_data.is_printable && printer_data.hit_nul)
1199 printf("%17s \"%s\"\n", "BPF string:",
1200 (char *)(sample->raw_data));
1203 struct perf_script {
1204 struct perf_tool tool;
1205 struct perf_session *session;
1206 bool show_task_events;
1207 bool show_mmap_events;
1208 bool show_switch_events;
1209 bool show_namespace_events;
1211 struct cpu_map *cpus;
1212 struct thread_map *threads;
1214 const char *time_str;
1215 struct perf_time_interval ptime;
1218 static int perf_evlist__max_name_len(struct perf_evlist *evlist)
1220 struct perf_evsel *evsel;
1223 evlist__for_each_entry(evlist, evsel) {
1224 int len = strlen(perf_evsel__name(evsel));
1226 max = MAX(len, max);
1232 static size_t data_src__printf(u64 data_src)
1234 struct mem_info mi = { .data_src.val = data_src };
1240 perf_script__meminfo_scnprintf(decode, 100, &mi);
1242 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1246 return printf("%-*s", maxlen, out);
1249 static void process_event(struct perf_script *script,
1250 struct perf_sample *sample, struct perf_evsel *evsel,
1251 struct addr_location *al,
1252 struct machine *machine)
1254 struct thread *thread = al->thread;
1255 struct perf_event_attr *attr = &evsel->attr;
1256 unsigned int type = output_type(attr->type);
1258 if (output[type].fields == 0)
1261 print_sample_start(sample, thread, evsel);
1263 if (PRINT_FIELD(PERIOD))
1264 printf("%10" PRIu64 " ", sample->period);
1266 if (PRINT_FIELD(EVNAME)) {
1267 const char *evname = perf_evsel__name(evsel);
1269 if (!script->name_width)
1270 script->name_width = perf_evlist__max_name_len(script->session->evlist);
1272 printf("%*s: ", script->name_width,
1273 evname ? evname : "[unknown]");
1277 print_sample_flags(sample->flags);
1279 if (is_bts_event(attr)) {
1280 print_sample_bts(sample, evsel, thread, al, machine);
1284 if (PRINT_FIELD(TRACE))
1285 event_format__print(evsel->tp_format, sample->cpu,
1286 sample->raw_data, sample->raw_size);
1287 if (PRINT_FIELD(ADDR))
1288 print_sample_addr(sample, thread, attr);
1290 if (PRINT_FIELD(DATA_SRC))
1291 data_src__printf(sample->data_src);
1293 if (PRINT_FIELD(WEIGHT))
1294 printf("%16" PRIu64, sample->weight);
1296 if (PRINT_FIELD(IP)) {
1297 struct callchain_cursor *cursor = NULL;
1299 if (symbol_conf.use_callchain && sample->callchain &&
1300 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1301 sample, NULL, NULL, scripting_max_stack) == 0)
1302 cursor = &callchain_cursor;
1304 putchar(cursor ? '\n' : ' ');
1305 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor, stdout);
1308 if (PRINT_FIELD(IREGS))
1309 print_sample_iregs(sample, attr);
1311 if (PRINT_FIELD(BRSTACK))
1312 print_sample_brstack(sample, thread, attr);
1313 else if (PRINT_FIELD(BRSTACKSYM))
1314 print_sample_brstacksym(sample, thread, attr);
1315 else if (PRINT_FIELD(BRSTACKOFF))
1316 print_sample_brstackoff(sample, thread, attr);
1318 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1319 print_sample_bpf_output(sample);
1320 print_insn(sample, attr, thread, machine);
1324 static struct scripting_ops *scripting_ops;
1326 static void __process_stat(struct perf_evsel *counter, u64 tstamp)
1328 int nthreads = thread_map__nr(counter->threads);
1329 int ncpus = perf_evsel__nr_cpus(counter);
1331 static int header_printed;
1333 if (counter->system_wide)
1336 if (!header_printed) {
1337 printf("%3s %8s %15s %15s %15s %15s %s\n",
1338 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
1342 for (thread = 0; thread < nthreads; thread++) {
1343 for (cpu = 0; cpu < ncpus; cpu++) {
1344 struct perf_counts_values *counts;
1346 counts = perf_counts(counter->counts, cpu, thread);
1348 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
1349 counter->cpus->map[cpu],
1350 thread_map__pid(counter->threads, thread),
1355 perf_evsel__name(counter));
1360 static void process_stat(struct perf_evsel *counter, u64 tstamp)
1362 if (scripting_ops && scripting_ops->process_stat)
1363 scripting_ops->process_stat(&stat_config, counter, tstamp);
1365 __process_stat(counter, tstamp);
1368 static void process_stat_interval(u64 tstamp)
1370 if (scripting_ops && scripting_ops->process_stat_interval)
1371 scripting_ops->process_stat_interval(tstamp);
1374 static void setup_scripting(void)
1376 setup_perl_scripting();
1377 setup_python_scripting();
1380 static int flush_scripting(void)
1382 return scripting_ops ? scripting_ops->flush_script() : 0;
1385 static int cleanup_scripting(void)
1387 pr_debug("\nperf script stopped\n");
1389 return scripting_ops ? scripting_ops->stop_script() : 0;
1392 static int process_sample_event(struct perf_tool *tool,
1393 union perf_event *event,
1394 struct perf_sample *sample,
1395 struct perf_evsel *evsel,
1396 struct machine *machine)
1398 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1399 struct addr_location al;
1401 if (perf_time__skip_sample(&scr->ptime, sample->time))
1405 if (sample->time < last_timestamp) {
1406 pr_err("Samples misordered, previous: %" PRIu64
1407 " this: %" PRIu64 "\n", last_timestamp,
1411 last_timestamp = sample->time;
1415 if (machine__resolve(machine, &al, sample) < 0) {
1416 pr_err("problem processing %d event, skipping it.\n",
1417 event->header.type);
1424 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
1428 scripting_ops->process_event(event, sample, evsel, &al);
1430 process_event(scr, sample, evsel, &al, machine);
1433 addr_location__put(&al);
1437 static int process_attr(struct perf_tool *tool, union perf_event *event,
1438 struct perf_evlist **pevlist)
1440 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1441 struct perf_evlist *evlist;
1442 struct perf_evsel *evsel, *pos;
1445 err = perf_event__process_attr(tool, event, pevlist);
1450 evsel = perf_evlist__last(*pevlist);
1452 if (evsel->attr.type >= PERF_TYPE_MAX &&
1453 evsel->attr.type != PERF_TYPE_SYNTH)
1456 evlist__for_each_entry(evlist, pos) {
1457 if (pos->attr.type == evsel->attr.type && pos != evsel)
1461 set_print_ip_opts(&evsel->attr);
1463 if (evsel->attr.sample_type)
1464 err = perf_evsel__check_attr(evsel, scr->session);
1469 static int process_comm_event(struct perf_tool *tool,
1470 union perf_event *event,
1471 struct perf_sample *sample,
1472 struct machine *machine)
1474 struct thread *thread;
1475 struct perf_script *script = container_of(tool, struct perf_script, tool);
1476 struct perf_session *session = script->session;
1477 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1480 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
1481 if (thread == NULL) {
1482 pr_debug("problem processing COMM event, skipping it.\n");
1486 if (perf_event__process_comm(tool, event, sample, machine) < 0)
1489 if (!evsel->attr.sample_id_all) {
1492 sample->tid = event->comm.tid;
1493 sample->pid = event->comm.pid;
1495 print_sample_start(sample, thread, evsel);
1496 perf_event__fprintf(event, stdout);
1499 thread__put(thread);
1503 static int process_namespaces_event(struct perf_tool *tool,
1504 union perf_event *event,
1505 struct perf_sample *sample,
1506 struct machine *machine)
1508 struct thread *thread;
1509 struct perf_script *script = container_of(tool, struct perf_script, tool);
1510 struct perf_session *session = script->session;
1511 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1514 thread = machine__findnew_thread(machine, event->namespaces.pid,
1515 event->namespaces.tid);
1516 if (thread == NULL) {
1517 pr_debug("problem processing NAMESPACES event, skipping it.\n");
1521 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
1524 if (!evsel->attr.sample_id_all) {
1527 sample->tid = event->namespaces.tid;
1528 sample->pid = event->namespaces.pid;
1530 print_sample_start(sample, thread, evsel);
1531 perf_event__fprintf(event, stdout);
1534 thread__put(thread);
1538 static int process_fork_event(struct perf_tool *tool,
1539 union perf_event *event,
1540 struct perf_sample *sample,
1541 struct machine *machine)
1543 struct thread *thread;
1544 struct perf_script *script = container_of(tool, struct perf_script, tool);
1545 struct perf_session *session = script->session;
1546 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1548 if (perf_event__process_fork(tool, event, sample, machine) < 0)
1551 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1552 if (thread == NULL) {
1553 pr_debug("problem processing FORK event, skipping it.\n");
1557 if (!evsel->attr.sample_id_all) {
1559 sample->time = event->fork.time;
1560 sample->tid = event->fork.tid;
1561 sample->pid = event->fork.pid;
1563 print_sample_start(sample, thread, evsel);
1564 perf_event__fprintf(event, stdout);
1565 thread__put(thread);
1569 static int process_exit_event(struct perf_tool *tool,
1570 union perf_event *event,
1571 struct perf_sample *sample,
1572 struct machine *machine)
1575 struct thread *thread;
1576 struct perf_script *script = container_of(tool, struct perf_script, tool);
1577 struct perf_session *session = script->session;
1578 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1580 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1581 if (thread == NULL) {
1582 pr_debug("problem processing EXIT event, skipping it.\n");
1586 if (!evsel->attr.sample_id_all) {
1589 sample->tid = event->fork.tid;
1590 sample->pid = event->fork.pid;
1592 print_sample_start(sample, thread, evsel);
1593 perf_event__fprintf(event, stdout);
1595 if (perf_event__process_exit(tool, event, sample, machine) < 0)
1598 thread__put(thread);
1602 static int process_mmap_event(struct perf_tool *tool,
1603 union perf_event *event,
1604 struct perf_sample *sample,
1605 struct machine *machine)
1607 struct thread *thread;
1608 struct perf_script *script = container_of(tool, struct perf_script, tool);
1609 struct perf_session *session = script->session;
1610 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1612 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
1615 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
1616 if (thread == NULL) {
1617 pr_debug("problem processing MMAP event, skipping it.\n");
1621 if (!evsel->attr.sample_id_all) {
1624 sample->tid = event->mmap.tid;
1625 sample->pid = event->mmap.pid;
1627 print_sample_start(sample, thread, evsel);
1628 perf_event__fprintf(event, stdout);
1629 thread__put(thread);
1633 static int process_mmap2_event(struct perf_tool *tool,
1634 union perf_event *event,
1635 struct perf_sample *sample,
1636 struct machine *machine)
1638 struct thread *thread;
1639 struct perf_script *script = container_of(tool, struct perf_script, tool);
1640 struct perf_session *session = script->session;
1641 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1643 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
1646 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
1647 if (thread == NULL) {
1648 pr_debug("problem processing MMAP2 event, skipping it.\n");
1652 if (!evsel->attr.sample_id_all) {
1655 sample->tid = event->mmap2.tid;
1656 sample->pid = event->mmap2.pid;
1658 print_sample_start(sample, thread, evsel);
1659 perf_event__fprintf(event, stdout);
1660 thread__put(thread);
1664 static int process_switch_event(struct perf_tool *tool,
1665 union perf_event *event,
1666 struct perf_sample *sample,
1667 struct machine *machine)
1669 struct thread *thread;
1670 struct perf_script *script = container_of(tool, struct perf_script, tool);
1671 struct perf_session *session = script->session;
1672 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1674 if (perf_event__process_switch(tool, event, sample, machine) < 0)
1677 thread = machine__findnew_thread(machine, sample->pid,
1679 if (thread == NULL) {
1680 pr_debug("problem processing SWITCH event, skipping it.\n");
1684 print_sample_start(sample, thread, evsel);
1685 perf_event__fprintf(event, stdout);
1686 thread__put(thread);
1690 static void sig_handler(int sig __maybe_unused)
1695 static int __cmd_script(struct perf_script *script)
1699 signal(SIGINT, sig_handler);
1701 /* override event processing functions */
1702 if (script->show_task_events) {
1703 script->tool.comm = process_comm_event;
1704 script->tool.fork = process_fork_event;
1705 script->tool.exit = process_exit_event;
1707 if (script->show_mmap_events) {
1708 script->tool.mmap = process_mmap_event;
1709 script->tool.mmap2 = process_mmap2_event;
1711 if (script->show_switch_events)
1712 script->tool.context_switch = process_switch_event;
1713 if (script->show_namespace_events)
1714 script->tool.namespaces = process_namespaces_event;
1716 ret = perf_session__process_events(script->session);
1719 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1724 struct script_spec {
1725 struct list_head node;
1726 struct scripting_ops *ops;
1730 static LIST_HEAD(script_specs);
1732 static struct script_spec *script_spec__new(const char *spec,
1733 struct scripting_ops *ops)
1735 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
1738 strcpy(s->spec, spec);
1745 static void script_spec__add(struct script_spec *s)
1747 list_add_tail(&s->node, &script_specs);
1750 static struct script_spec *script_spec__find(const char *spec)
1752 struct script_spec *s;
1754 list_for_each_entry(s, &script_specs, node)
1755 if (strcasecmp(s->spec, spec) == 0)
1760 int script_spec_register(const char *spec, struct scripting_ops *ops)
1762 struct script_spec *s;
1764 s = script_spec__find(spec);
1768 s = script_spec__new(spec, ops);
1772 script_spec__add(s);
1777 static struct scripting_ops *script_spec__lookup(const char *spec)
1779 struct script_spec *s = script_spec__find(spec);
1786 static void list_available_languages(void)
1788 struct script_spec *s;
1790 fprintf(stderr, "\n");
1791 fprintf(stderr, "Scripting language extensions (used in "
1792 "perf script -s [spec:]script.[spec]):\n\n");
1794 list_for_each_entry(s, &script_specs, node)
1795 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
1797 fprintf(stderr, "\n");
1800 static int parse_scriptname(const struct option *opt __maybe_unused,
1801 const char *str, int unset __maybe_unused)
1803 char spec[PATH_MAX];
1804 const char *script, *ext;
1807 if (strcmp(str, "lang") == 0) {
1808 list_available_languages();
1812 script = strchr(str, ':');
1815 if (len >= PATH_MAX) {
1816 fprintf(stderr, "invalid language specifier");
1819 strncpy(spec, str, len);
1821 scripting_ops = script_spec__lookup(spec);
1822 if (!scripting_ops) {
1823 fprintf(stderr, "invalid language specifier");
1829 ext = strrchr(script, '.');
1831 fprintf(stderr, "invalid script extension");
1834 scripting_ops = script_spec__lookup(++ext);
1835 if (!scripting_ops) {
1836 fprintf(stderr, "invalid script extension");
1841 script_name = strdup(script);
1846 static int parse_output_fields(const struct option *opt __maybe_unused,
1847 const char *arg, int unset __maybe_unused)
1849 char *tok, *strtok_saveptr = NULL;
1850 int i, imax = ARRAY_SIZE(all_output_options);
1853 char *str = strdup(arg);
1855 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
1860 /* first word can state for which event type the user is specifying
1861 * the fields. If no type exists, the specified fields apply to all
1862 * event types found in the file minus the invalid fields for a type.
1864 tok = strchr(str, ':');
1868 if (!strcmp(str, "hw"))
1869 type = PERF_TYPE_HARDWARE;
1870 else if (!strcmp(str, "sw"))
1871 type = PERF_TYPE_SOFTWARE;
1872 else if (!strcmp(str, "trace"))
1873 type = PERF_TYPE_TRACEPOINT;
1874 else if (!strcmp(str, "raw"))
1875 type = PERF_TYPE_RAW;
1876 else if (!strcmp(str, "break"))
1877 type = PERF_TYPE_BREAKPOINT;
1878 else if (!strcmp(str, "synth"))
1879 type = OUTPUT_TYPE_SYNTH;
1881 fprintf(stderr, "Invalid event type in field string.\n");
1886 if (output[type].user_set)
1887 pr_warning("Overriding previous field request for %s events.\n",
1890 output[type].fields = 0;
1891 output[type].user_set = true;
1892 output[type].wildcard_set = false;
1896 if (strlen(str) == 0) {
1898 "Cannot set fields to 'none' for all event types.\n");
1903 /* Don't override defaults for +- */
1904 if (strchr(str, '+') || strchr(str, '-'))
1907 if (output_set_by_user())
1908 pr_warning("Overriding previous field request for all events.\n");
1910 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
1911 output[j].fields = 0;
1912 output[j].user_set = true;
1913 output[j].wildcard_set = true;
1918 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
1924 } else if (*tok == '-') {
1930 if (change != SET && change != DEFAULT)
1935 for (i = 0; i < imax; ++i) {
1936 if (strcmp(tok, all_output_options[i].str) == 0)
1939 if (i == imax && strcmp(tok, "flags") == 0) {
1940 print_flags = change == REMOVE ? false : true;
1944 fprintf(stderr, "Invalid field requested.\n");
1950 /* add user option to all events types for
1953 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
1954 if (output[j].invalid_fields & all_output_options[i].field) {
1955 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1956 all_output_options[i].str, event_type(j));
1958 if (change == REMOVE)
1959 output[j].fields &= ~all_output_options[i].field;
1961 output[j].fields |= all_output_options[i].field;
1965 if (output[type].invalid_fields & all_output_options[i].field) {
1966 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1967 all_output_options[i].str, event_type(type));
1972 output[type].fields |= all_output_options[i].field;
1977 if (output[type].fields == 0) {
1978 pr_debug("No fields requested for %s type. "
1979 "Events will not be displayed.\n", event_type(type));
1985 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
1992 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1993 static int is_directory(const char *base_path, const struct dirent *dent)
1995 char path[PATH_MAX];
1998 sprintf(path, "%s/%s", base_path, dent->d_name);
1999 if (stat(path, &st))
2002 return S_ISDIR(st.st_mode);
2005 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2006 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2007 if ((lang_dirent->d_type == DT_DIR || \
2008 (lang_dirent->d_type == DT_UNKNOWN && \
2009 is_directory(scripts_path, lang_dirent))) && \
2010 (strcmp(lang_dirent->d_name, ".")) && \
2011 (strcmp(lang_dirent->d_name, "..")))
2013 #define for_each_script(lang_path, lang_dir, script_dirent) \
2014 while ((script_dirent = readdir(lang_dir)) != NULL) \
2015 if (script_dirent->d_type != DT_DIR && \
2016 (script_dirent->d_type != DT_UNKNOWN || \
2017 !is_directory(lang_path, script_dirent)))
2020 #define RECORD_SUFFIX "-record"
2021 #define REPORT_SUFFIX "-report"
2023 struct script_desc {
2024 struct list_head node;
2030 static LIST_HEAD(script_descs);
2032 static struct script_desc *script_desc__new(const char *name)
2034 struct script_desc *s = zalloc(sizeof(*s));
2036 if (s != NULL && name)
2037 s->name = strdup(name);
2042 static void script_desc__delete(struct script_desc *s)
2045 zfree(&s->half_liner);
2050 static void script_desc__add(struct script_desc *s)
2052 list_add_tail(&s->node, &script_descs);
2055 static struct script_desc *script_desc__find(const char *name)
2057 struct script_desc *s;
2059 list_for_each_entry(s, &script_descs, node)
2060 if (strcasecmp(s->name, name) == 0)
2065 static struct script_desc *script_desc__findnew(const char *name)
2067 struct script_desc *s = script_desc__find(name);
2072 s = script_desc__new(name);
2074 goto out_delete_desc;
2076 script_desc__add(s);
2081 script_desc__delete(s);
2086 static const char *ends_with(const char *str, const char *suffix)
2088 size_t suffix_len = strlen(suffix);
2089 const char *p = str;
2091 if (strlen(str) > suffix_len) {
2092 p = str + strlen(str) - suffix_len;
2093 if (!strncmp(p, suffix, suffix_len))
2100 static int read_script_info(struct script_desc *desc, const char *filename)
2102 char line[BUFSIZ], *p;
2105 fp = fopen(filename, "r");
2109 while (fgets(line, sizeof(line), fp)) {
2116 if (strlen(p) && *p == '!')
2120 if (strlen(p) && p[strlen(p) - 1] == '\n')
2121 p[strlen(p) - 1] = '\0';
2123 if (!strncmp(p, "description:", strlen("description:"))) {
2124 p += strlen("description:");
2125 desc->half_liner = strdup(ltrim(p));
2129 if (!strncmp(p, "args:", strlen("args:"))) {
2130 p += strlen("args:");
2131 desc->args = strdup(ltrim(p));
2141 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2143 char *script_root, *str;
2145 script_root = strdup(script_dirent->d_name);
2149 str = (char *)ends_with(script_root, suffix);
2159 static int list_available_scripts(const struct option *opt __maybe_unused,
2160 const char *s __maybe_unused,
2161 int unset __maybe_unused)
2163 struct dirent *script_dirent, *lang_dirent;
2164 char scripts_path[MAXPATHLEN];
2165 DIR *scripts_dir, *lang_dir;
2166 char script_path[MAXPATHLEN];
2167 char lang_path[MAXPATHLEN];
2168 struct script_desc *desc;
2169 char first_half[BUFSIZ];
2172 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2174 scripts_dir = opendir(scripts_path);
2177 "open(%s) failed.\n"
2178 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2183 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2184 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2185 lang_dirent->d_name);
2186 lang_dir = opendir(lang_path);
2190 for_each_script(lang_path, lang_dir, script_dirent) {
2191 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
2193 desc = script_desc__findnew(script_root);
2194 snprintf(script_path, MAXPATHLEN, "%s/%s",
2195 lang_path, script_dirent->d_name);
2196 read_script_info(desc, script_path);
2202 fprintf(stdout, "List of available trace scripts:\n");
2203 list_for_each_entry(desc, &script_descs, node) {
2204 sprintf(first_half, "%s %s", desc->name,
2205 desc->args ? desc->args : "");
2206 fprintf(stdout, " %-36s %s\n", first_half,
2207 desc->half_liner ? desc->half_liner : "");
2214 * Some scripts specify the required events in their "xxx-record" file,
2215 * this function will check if the events in perf.data match those
2216 * mentioned in the "xxx-record".
2218 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
2219 * which is covered well now. And new parsing code should be added to
2220 * cover the future complexing formats like event groups etc.
2222 static int check_ev_match(char *dir_name, char *scriptname,
2223 struct perf_session *session)
2225 char filename[MAXPATHLEN], evname[128];
2226 char line[BUFSIZ], *p;
2227 struct perf_evsel *pos;
2231 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
2233 fp = fopen(filename, "r");
2237 while (fgets(line, sizeof(line), fp)) {
2243 p = strstr(p, "-e");
2249 len = strcspn(p, " \t");
2253 snprintf(evname, len + 1, "%s", p);
2256 evlist__for_each_entry(session->evlist, pos) {
2257 if (!strcmp(perf_evsel__name(pos), evname)) {
2275 * Return -1 if none is found, otherwise the actual scripts number.
2277 * Currently the only user of this function is the script browser, which
2278 * will list all statically runnable scripts, select one, execute it and
2279 * show the output in a perf browser.
2281 int find_scripts(char **scripts_array, char **scripts_path_array)
2283 struct dirent *script_dirent, *lang_dirent;
2284 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
2285 DIR *scripts_dir, *lang_dir;
2286 struct perf_session *session;
2287 struct perf_data_file file = {
2289 .mode = PERF_DATA_MODE_READ,
2294 session = perf_session__new(&file, false, NULL);
2298 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2300 scripts_dir = opendir(scripts_path);
2302 perf_session__delete(session);
2306 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2307 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
2308 lang_dirent->d_name);
2310 if (strstr(lang_path, "perl"))
2314 if (strstr(lang_path, "python"))
2318 lang_dir = opendir(lang_path);
2322 for_each_script(lang_path, lang_dir, script_dirent) {
2323 /* Skip those real time scripts: xxxtop.p[yl] */
2324 if (strstr(script_dirent->d_name, "top."))
2326 sprintf(scripts_path_array[i], "%s/%s", lang_path,
2327 script_dirent->d_name);
2328 temp = strchr(script_dirent->d_name, '.');
2329 snprintf(scripts_array[i],
2330 (temp - script_dirent->d_name) + 1,
2331 "%s", script_dirent->d_name);
2333 if (check_ev_match(lang_path,
2334 scripts_array[i], session))
2342 closedir(scripts_dir);
2343 perf_session__delete(session);
2347 static char *get_script_path(const char *script_root, const char *suffix)
2349 struct dirent *script_dirent, *lang_dirent;
2350 char scripts_path[MAXPATHLEN];
2351 char script_path[MAXPATHLEN];
2352 DIR *scripts_dir, *lang_dir;
2353 char lang_path[MAXPATHLEN];
2354 char *__script_root;
2356 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2358 scripts_dir = opendir(scripts_path);
2362 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2363 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2364 lang_dirent->d_name);
2365 lang_dir = opendir(lang_path);
2369 for_each_script(lang_path, lang_dir, script_dirent) {
2370 __script_root = get_script_root(script_dirent, suffix);
2371 if (__script_root && !strcmp(script_root, __script_root)) {
2372 free(__script_root);
2374 closedir(scripts_dir);
2375 snprintf(script_path, MAXPATHLEN, "%s/%s",
2376 lang_path, script_dirent->d_name);
2377 return strdup(script_path);
2379 free(__script_root);
2383 closedir(scripts_dir);
2388 static bool is_top_script(const char *script_path)
2390 return ends_with(script_path, "top") == NULL ? false : true;
2393 static int has_required_arg(char *script_path)
2395 struct script_desc *desc;
2399 desc = script_desc__new(NULL);
2401 if (read_script_info(desc, script_path))
2407 for (p = desc->args; *p; p++)
2411 script_desc__delete(desc);
2416 static int have_cmd(int argc, const char **argv)
2418 char **__argv = malloc(sizeof(const char *) * argc);
2421 pr_err("malloc failed\n");
2425 memcpy(__argv, argv, sizeof(const char *) * argc);
2426 argc = parse_options(argc, (const char **)__argv, record_options,
2427 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
2430 system_wide = (argc == 0);
2435 static void script__setup_sample_type(struct perf_script *script)
2437 struct perf_session *session = script->session;
2438 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
2440 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
2441 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
2442 (sample_type & PERF_SAMPLE_STACK_USER))
2443 callchain_param.record_mode = CALLCHAIN_DWARF;
2444 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
2445 callchain_param.record_mode = CALLCHAIN_LBR;
2447 callchain_param.record_mode = CALLCHAIN_FP;
2451 static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
2452 union perf_event *event,
2453 struct perf_session *session)
2455 struct stat_round_event *round = &event->stat_round;
2456 struct perf_evsel *counter;
2458 evlist__for_each_entry(session->evlist, counter) {
2459 perf_stat_process_counter(&stat_config, counter);
2460 process_stat(counter, round->time);
2463 process_stat_interval(round->time);
2467 static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
2468 union perf_event *event,
2469 struct perf_session *session __maybe_unused)
2471 perf_event__read_stat_config(&stat_config, &event->stat_config);
2475 static int set_maps(struct perf_script *script)
2477 struct perf_evlist *evlist = script->session->evlist;
2479 if (!script->cpus || !script->threads)
2482 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
2485 perf_evlist__set_maps(evlist, script->cpus, script->threads);
2487 if (perf_evlist__alloc_stats(evlist, true))
2490 script->allocated = true;
2495 int process_thread_map_event(struct perf_tool *tool,
2496 union perf_event *event,
2497 struct perf_session *session __maybe_unused)
2499 struct perf_script *script = container_of(tool, struct perf_script, tool);
2501 if (script->threads) {
2502 pr_warning("Extra thread map event, ignoring.\n");
2506 script->threads = thread_map__new_event(&event->thread_map);
2507 if (!script->threads)
2510 return set_maps(script);
2514 int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
2515 union perf_event *event,
2516 struct perf_session *session __maybe_unused)
2518 struct perf_script *script = container_of(tool, struct perf_script, tool);
2521 pr_warning("Extra cpu map event, ignoring.\n");
2525 script->cpus = cpu_map__new_data(&event->cpu_map.data);
2529 return set_maps(script);
2532 int cmd_script(int argc, const char **argv)
2534 bool show_full_info = false;
2535 bool header = false;
2536 bool header_only = false;
2537 bool script_started = false;
2538 char *rec_script_path = NULL;
2539 char *rep_script_path = NULL;
2540 struct perf_session *session;
2541 struct itrace_synth_opts itrace_synth_opts = { .set = false, };
2542 char *script_path = NULL;
2543 const char **__argv;
2545 struct perf_script script = {
2547 .sample = process_sample_event,
2548 .mmap = perf_event__process_mmap,
2549 .mmap2 = perf_event__process_mmap2,
2550 .comm = perf_event__process_comm,
2551 .namespaces = perf_event__process_namespaces,
2552 .exit = perf_event__process_exit,
2553 .fork = perf_event__process_fork,
2554 .attr = process_attr,
2555 .event_update = perf_event__process_event_update,
2556 .tracing_data = perf_event__process_tracing_data,
2557 .build_id = perf_event__process_build_id,
2558 .id_index = perf_event__process_id_index,
2559 .auxtrace_info = perf_event__process_auxtrace_info,
2560 .auxtrace = perf_event__process_auxtrace,
2561 .auxtrace_error = perf_event__process_auxtrace_error,
2562 .stat = perf_event__process_stat_event,
2563 .stat_round = process_stat_round_event,
2564 .stat_config = process_stat_config_event,
2565 .thread_map = process_thread_map_event,
2566 .cpu_map = process_cpu_map_event,
2567 .ordered_events = true,
2568 .ordering_requires_timestamps = true,
2571 struct perf_data_file file = {
2572 .mode = PERF_DATA_MODE_READ,
2574 const struct option options[] = {
2575 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
2576 "dump raw trace in ASCII"),
2577 OPT_INCR('v', "verbose", &verbose,
2578 "be more verbose (show symbol address, etc)"),
2579 OPT_BOOLEAN('L', "Latency", &latency_format,
2580 "show latency attributes (irqs/preemption disabled, etc)"),
2581 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
2582 list_available_scripts),
2583 OPT_CALLBACK('s', "script", NULL, "name",
2584 "script file name (lang:script name, script name, or *)",
2586 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
2587 "generate perf-script.xx script in specified language"),
2588 OPT_STRING('i', "input", &input_name, "file", "input file name"),
2589 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
2590 "do various checks like samples ordering and lost events"),
2591 OPT_BOOLEAN(0, "header", &header, "Show data header."),
2592 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
2593 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2594 "file", "vmlinux pathname"),
2595 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
2596 "file", "kallsyms pathname"),
2597 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
2598 "When printing symbols do not display call chain"),
2599 OPT_CALLBACK(0, "symfs", NULL, "directory",
2600 "Look for files with symbols relative to this directory",
2601 symbol__config_symfs),
2602 OPT_CALLBACK('F', "fields", NULL, "str",
2603 "comma separated output fields prepend with 'type:'. "
2604 "+field to add and -field to remove."
2605 "Valid types: hw,sw,trace,raw,synth. "
2606 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2607 "addr,symoff,period,iregs,brstack,brstacksym,flags,"
2608 "bpf-output,callindent,insn,insnlen,brstackinsn",
2609 parse_output_fields),
2610 OPT_BOOLEAN('a', "all-cpus", &system_wide,
2611 "system-wide collection from all CPUs"),
2612 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
2613 "only consider these symbols"),
2614 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
2615 "Stop display of callgraph at these symbols"),
2616 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
2617 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
2618 "only display events for these comms"),
2619 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
2620 "only consider symbols in these pids"),
2621 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
2622 "only consider symbols in these tids"),
2623 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
2624 "Set the maximum stack depth when parsing the callchain, "
2625 "anything beyond the specified depth will be ignored. "
2626 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
2627 OPT_BOOLEAN('I', "show-info", &show_full_info,
2628 "display extended information from perf.data file"),
2629 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
2630 "Show the path of [kernel.kallsyms]"),
2631 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
2632 "Show the fork/comm/exit events"),
2633 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
2634 "Show the mmap events"),
2635 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
2636 "Show context switch events (if recorded)"),
2637 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
2638 "Show namespace events (if recorded)"),
2639 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
2640 OPT_INTEGER(0, "max-blocks", &max_blocks,
2641 "Maximum number of code blocks to dump with brstackinsn"),
2642 OPT_BOOLEAN(0, "ns", &nanosecs,
2643 "Use 9 decimal places when displaying time"),
2644 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
2645 "Instruction Tracing options",
2646 itrace_parse_synth_opts),
2647 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
2648 "Show full source file name path for source lines"),
2649 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
2650 "Enable symbol demangling"),
2651 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
2652 "Enable kernel symbol demangling"),
2653 OPT_STRING(0, "time", &script.time_str, "str",
2654 "Time span of interest (start,stop)"),
2655 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
2656 "Show inline function"),
2659 const char * const script_subcommands[] = { "record", "report", NULL };
2660 const char *script_usage[] = {
2661 "perf script [<options>]",
2662 "perf script [<options>] record <script> [<record-options>] <command>",
2663 "perf script [<options>] report <script> [script-args]",
2664 "perf script [<options>] <script> [<record-options>] <command>",
2665 "perf script [<options>] <top-script> [script-args]",
2671 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
2672 PARSE_OPT_STOP_AT_NON_OPTION);
2674 file.path = input_name;
2675 file.force = symbol_conf.force;
2677 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
2678 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
2679 if (!rec_script_path)
2680 return cmd_record(argc, argv);
2683 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
2684 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
2685 if (!rep_script_path) {
2687 "Please specify a valid report script"
2688 "(see 'perf script -l' for listing)\n");
2693 if (itrace_synth_opts.callchain &&
2694 itrace_synth_opts.callchain_sz > scripting_max_stack)
2695 scripting_max_stack = itrace_synth_opts.callchain_sz;
2697 /* make sure PERF_EXEC_PATH is set for scripts */
2698 set_argv_exec_path(get_argv_exec_path());
2700 if (argc && !script_name && !rec_script_path && !rep_script_path) {
2705 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
2706 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
2708 if (!rec_script_path && !rep_script_path) {
2709 usage_with_options_msg(script_usage, options,
2710 "Couldn't find script `%s'\n\n See perf"
2711 " script -l for available scripts.\n", argv[0]);
2714 if (is_top_script(argv[0])) {
2715 rep_args = argc - 1;
2719 rep_args = has_required_arg(rep_script_path);
2720 rec_args = (argc - 1) - rep_args;
2722 usage_with_options_msg(script_usage, options,
2723 "`%s' script requires options."
2724 "\n\n See perf script -l for available "
2725 "scripts and options.\n", argv[0]);
2729 if (pipe(live_pipe) < 0) {
2730 perror("failed to create pipe");
2736 perror("failed to fork");
2743 dup2(live_pipe[1], 1);
2744 close(live_pipe[0]);
2746 if (is_top_script(argv[0])) {
2748 } else if (!system_wide) {
2749 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
2755 __argv = malloc((argc + 6) * sizeof(const char *));
2757 pr_err("malloc failed\n");
2762 __argv[j++] = "/bin/sh";
2763 __argv[j++] = rec_script_path;
2769 for (i = rep_args + 1; i < argc; i++)
2770 __argv[j++] = argv[i];
2773 execvp("/bin/sh", (char **)__argv);
2778 dup2(live_pipe[0], 0);
2779 close(live_pipe[1]);
2781 __argv = malloc((argc + 4) * sizeof(const char *));
2783 pr_err("malloc failed\n");
2789 __argv[j++] = "/bin/sh";
2790 __argv[j++] = rep_script_path;
2791 for (i = 1; i < rep_args + 1; i++)
2792 __argv[j++] = argv[i];
2797 execvp("/bin/sh", (char **)__argv);
2802 if (rec_script_path)
2803 script_path = rec_script_path;
2804 if (rep_script_path)
2805 script_path = rep_script_path;
2810 if (!rec_script_path)
2811 system_wide = false;
2812 else if (!system_wide) {
2813 if (have_cmd(argc - 1, &argv[1]) != 0) {
2819 __argv = malloc((argc + 2) * sizeof(const char *));
2821 pr_err("malloc failed\n");
2826 __argv[j++] = "/bin/sh";
2827 __argv[j++] = script_path;
2830 for (i = 2; i < argc; i++)
2831 __argv[j++] = argv[i];
2834 execvp("/bin/sh", (char **)__argv);
2842 session = perf_session__new(&file, false, &script.tool);
2843 if (session == NULL)
2846 if (header || header_only) {
2847 perf_session__fprintf_info(session, stdout, show_full_info);
2852 if (symbol__init(&session->header.env) < 0)
2855 script.session = session;
2856 script__setup_sample_type(&script);
2858 if (output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT)
2859 itrace_synth_opts.thread_stack = true;
2861 session->itrace_synth_opts = &itrace_synth_opts;
2864 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
2870 symbol_conf.use_callchain = true;
2872 symbol_conf.use_callchain = false;
2874 if (session->tevent.pevent &&
2875 pevent_set_function_resolver(session->tevent.pevent,
2876 machine__resolve_kernel_addr,
2877 &session->machines.host) < 0) {
2878 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
2882 if (generate_script_lang) {
2883 struct stat perf_stat;
2886 if (output_set_by_user()) {
2888 "custom fields not supported for generated scripts");
2893 input = open(file.path, O_RDONLY); /* input_name */
2896 perror("failed to open file");
2900 err = fstat(input, &perf_stat);
2902 perror("failed to stat file");
2906 if (!perf_stat.st_size) {
2907 fprintf(stderr, "zero-sized file, nothing to do!\n");
2911 scripting_ops = script_spec__lookup(generate_script_lang);
2912 if (!scripting_ops) {
2913 fprintf(stderr, "invalid language specifier");
2918 err = scripting_ops->generate_script(session->tevent.pevent,
2924 err = scripting_ops->start_script(script_name, argc, argv);
2927 pr_debug("perf script started with script %s\n\n", script_name);
2928 script_started = true;
2932 err = perf_session__check_output_opt(session);
2936 /* needs to be parsed after looking up reference time */
2937 if (perf_time__parse_str(&script.ptime, script.time_str) != 0) {
2938 pr_err("Invalid time string\n");
2942 err = __cmd_script(&script);
2947 perf_evlist__free_stats(session->evlist);
2948 perf_session__delete(session);
2951 cleanup_scripting();