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/thread-stack.h"
25 #include "util/time-utils.h"
26 #include <linux/bitmap.h>
27 #include <linux/stringify.h>
28 #include <linux/time64.h>
30 #include "util/mem-events.h"
32 static char const *script_name;
33 static char const *generate_script_lang;
34 static bool debug_mode;
35 static u64 last_timestamp;
36 static u64 nr_unordered;
37 static bool no_callchain;
38 static bool latency_format;
39 static bool system_wide;
40 static bool print_flags;
42 static const char *cpu_list;
43 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
44 static struct perf_stat_config stat_config;
46 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
48 enum perf_output_field {
49 PERF_OUTPUT_COMM = 1U << 0,
50 PERF_OUTPUT_TID = 1U << 1,
51 PERF_OUTPUT_PID = 1U << 2,
52 PERF_OUTPUT_TIME = 1U << 3,
53 PERF_OUTPUT_CPU = 1U << 4,
54 PERF_OUTPUT_EVNAME = 1U << 5,
55 PERF_OUTPUT_TRACE = 1U << 6,
56 PERF_OUTPUT_IP = 1U << 7,
57 PERF_OUTPUT_SYM = 1U << 8,
58 PERF_OUTPUT_DSO = 1U << 9,
59 PERF_OUTPUT_ADDR = 1U << 10,
60 PERF_OUTPUT_SYMOFFSET = 1U << 11,
61 PERF_OUTPUT_SRCLINE = 1U << 12,
62 PERF_OUTPUT_PERIOD = 1U << 13,
63 PERF_OUTPUT_IREGS = 1U << 14,
64 PERF_OUTPUT_BRSTACK = 1U << 15,
65 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
66 PERF_OUTPUT_DATA_SRC = 1U << 17,
67 PERF_OUTPUT_WEIGHT = 1U << 18,
68 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
69 PERF_OUTPUT_CALLINDENT = 1U << 20,
70 PERF_OUTPUT_INSN = 1U << 21,
71 PERF_OUTPUT_INSNLEN = 1U << 22,
74 struct output_option {
76 enum perf_output_field field;
77 } all_output_options[] = {
78 {.str = "comm", .field = PERF_OUTPUT_COMM},
79 {.str = "tid", .field = PERF_OUTPUT_TID},
80 {.str = "pid", .field = PERF_OUTPUT_PID},
81 {.str = "time", .field = PERF_OUTPUT_TIME},
82 {.str = "cpu", .field = PERF_OUTPUT_CPU},
83 {.str = "event", .field = PERF_OUTPUT_EVNAME},
84 {.str = "trace", .field = PERF_OUTPUT_TRACE},
85 {.str = "ip", .field = PERF_OUTPUT_IP},
86 {.str = "sym", .field = PERF_OUTPUT_SYM},
87 {.str = "dso", .field = PERF_OUTPUT_DSO},
88 {.str = "addr", .field = PERF_OUTPUT_ADDR},
89 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
90 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
91 {.str = "period", .field = PERF_OUTPUT_PERIOD},
92 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
93 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
94 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
95 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
96 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
97 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
98 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
99 {.str = "insn", .field = PERF_OUTPUT_INSN},
100 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
103 /* default set to maintain compatibility with current format */
107 unsigned int print_ip_opts;
110 } output[PERF_TYPE_MAX] = {
112 [PERF_TYPE_HARDWARE] = {
115 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
116 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
117 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
118 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
121 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
124 [PERF_TYPE_SOFTWARE] = {
127 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
128 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
129 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
130 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
131 PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
133 .invalid_fields = PERF_OUTPUT_TRACE,
136 [PERF_TYPE_TRACEPOINT] = {
139 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
140 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
141 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
147 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
148 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
149 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
150 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
151 PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR |
152 PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
154 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
157 [PERF_TYPE_BREAKPOINT] = {
160 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
161 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
162 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
163 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
166 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
170 static bool output_set_by_user(void)
173 for (j = 0; j < PERF_TYPE_MAX; ++j) {
174 if (output[j].user_set)
180 static const char *output_field2str(enum perf_output_field field)
182 int i, imax = ARRAY_SIZE(all_output_options);
183 const char *str = "";
185 for (i = 0; i < imax; ++i) {
186 if (all_output_options[i].field == field) {
187 str = all_output_options[i].str;
194 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
196 static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
197 u64 sample_type, const char *sample_msg,
198 enum perf_output_field field,
201 struct perf_event_attr *attr = &evsel->attr;
202 int type = attr->type;
205 if (attr->sample_type & sample_type)
208 if (output[type].user_set) {
211 evname = perf_evsel__name(evsel);
212 pr_err("Samples for '%s' event do not have %s attribute set. "
213 "Cannot print '%s' field.\n",
214 evname, sample_msg, output_field2str(field));
218 /* user did not ask for it explicitly so remove from the default list */
219 output[type].fields &= ~field;
220 evname = perf_evsel__name(evsel);
221 pr_debug("Samples for '%s' event do not have %s attribute set. "
222 "Skipping '%s' field.\n",
223 evname, sample_msg, output_field2str(field));
228 static int perf_evsel__check_stype(struct perf_evsel *evsel,
229 u64 sample_type, const char *sample_msg,
230 enum perf_output_field field)
232 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
236 static int perf_evsel__check_attr(struct perf_evsel *evsel,
237 struct perf_session *session)
239 struct perf_event_attr *attr = &evsel->attr;
242 if (perf_header__has_feat(&session->header, HEADER_STAT))
245 allow_user_set = perf_header__has_feat(&session->header,
248 if (PRINT_FIELD(TRACE) &&
249 !perf_session__has_traces(session, "record -R"))
252 if (PRINT_FIELD(IP)) {
253 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
258 if (PRINT_FIELD(ADDR) &&
259 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
260 PERF_OUTPUT_ADDR, allow_user_set))
263 if (PRINT_FIELD(DATA_SRC) &&
264 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
265 PERF_OUTPUT_DATA_SRC))
268 if (PRINT_FIELD(WEIGHT) &&
269 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
273 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
274 pr_err("Display of symbols requested but neither sample IP nor "
275 "sample address\nis selected. Hence, no addresses to convert "
279 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
280 pr_err("Display of offsets requested but symbol is not"
284 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
285 pr_err("Display of DSO requested but neither sample IP nor "
286 "sample address\nis selected. Hence, no addresses to convert "
290 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
291 pr_err("Display of source line number requested but sample IP is not\n"
292 "selected. Hence, no address to lookup the source line number.\n");
296 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
297 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
298 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
301 if (PRINT_FIELD(TIME) &&
302 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
306 if (PRINT_FIELD(CPU) &&
307 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
308 PERF_OUTPUT_CPU, allow_user_set))
311 if (PRINT_FIELD(PERIOD) &&
312 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
316 if (PRINT_FIELD(IREGS) &&
317 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
324 static void set_print_ip_opts(struct perf_event_attr *attr)
326 unsigned int type = attr->type;
328 output[type].print_ip_opts = 0;
330 output[type].print_ip_opts |= EVSEL__PRINT_IP;
332 if (PRINT_FIELD(SYM))
333 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
335 if (PRINT_FIELD(DSO))
336 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
338 if (PRINT_FIELD(SYMOFFSET))
339 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
341 if (PRINT_FIELD(SRCLINE))
342 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
346 * verify all user requested events exist and the samples
347 * have the expected data
349 static int perf_session__check_output_opt(struct perf_session *session)
352 struct perf_evsel *evsel;
354 for (j = 0; j < PERF_TYPE_MAX; ++j) {
355 evsel = perf_session__find_first_evtype(session, j);
358 * even if fields is set to 0 (ie., show nothing) event must
359 * exist if user explicitly includes it on the command line
361 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
362 pr_err("%s events do not exist. "
363 "Remove corresponding -f option to proceed.\n",
368 if (evsel && output[j].fields &&
369 perf_evsel__check_attr(evsel, session))
375 set_print_ip_opts(&evsel->attr);
379 bool use_callchain = false;
380 bool not_pipe = false;
382 evlist__for_each_entry(session->evlist, evsel) {
384 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
385 use_callchain = true;
389 if (not_pipe && !use_callchain)
390 symbol_conf.use_callchain = false;
394 * set default for tracepoints to print symbols only
395 * if callchains are present
397 if (symbol_conf.use_callchain &&
398 !output[PERF_TYPE_TRACEPOINT].user_set) {
399 struct perf_event_attr *attr;
401 j = PERF_TYPE_TRACEPOINT;
403 evlist__for_each_entry(session->evlist, evsel) {
404 if (evsel->attr.type != j)
409 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
410 output[j].fields |= PERF_OUTPUT_IP;
411 output[j].fields |= PERF_OUTPUT_SYM;
412 output[j].fields |= PERF_OUTPUT_DSO;
413 set_print_ip_opts(attr);
423 static void print_sample_iregs(struct perf_sample *sample,
424 struct perf_event_attr *attr)
426 struct regs_dump *regs = &sample->intr_regs;
427 uint64_t mask = attr->sample_regs_intr;
433 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
434 u64 val = regs->regs[i++];
435 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
439 static void print_sample_start(struct perf_sample *sample,
440 struct thread *thread,
441 struct perf_evsel *evsel)
443 struct perf_event_attr *attr = &evsel->attr;
445 unsigned long long nsecs;
447 if (PRINT_FIELD(COMM)) {
449 printf("%8.8s ", thread__comm_str(thread));
450 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
451 printf("%s ", thread__comm_str(thread));
453 printf("%16s ", thread__comm_str(thread));
456 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
457 printf("%5d/%-5d ", sample->pid, sample->tid);
458 else if (PRINT_FIELD(PID))
459 printf("%5d ", sample->pid);
460 else if (PRINT_FIELD(TID))
461 printf("%5d ", sample->tid);
463 if (PRINT_FIELD(CPU)) {
465 printf("%3d ", sample->cpu);
467 printf("[%03d] ", sample->cpu);
470 if (PRINT_FIELD(TIME)) {
471 nsecs = sample->time;
472 secs = nsecs / NSEC_PER_SEC;
473 nsecs -= secs * NSEC_PER_SEC;
476 printf("%5lu.%09llu: ", secs, nsecs);
478 char sample_time[32];
479 timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time));
480 printf("%12s: ", sample_time);
486 mispred_str(struct branch_entry *br)
488 if (!(br->flags.mispred || br->flags.predicted))
491 return br->flags.predicted ? 'P' : 'M';
494 static void print_sample_brstack(struct perf_sample *sample)
496 struct branch_stack *br = sample->branch_stack;
502 for (i = 0; i < br->nr; i++) {
503 printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
506 mispred_str( br->entries + i),
507 br->entries[i].flags.in_tx? 'X' : '-',
508 br->entries[i].flags.abort? 'A' : '-',
509 br->entries[i].flags.cycles);
513 static void print_sample_brstacksym(struct perf_sample *sample,
514 struct thread *thread)
516 struct branch_stack *br = sample->branch_stack;
517 struct addr_location alf, alt;
523 for (i = 0; i < br->nr; i++) {
525 memset(&alf, 0, sizeof(alf));
526 memset(&alt, 0, sizeof(alt));
527 from = br->entries[i].from;
528 to = br->entries[i].to;
530 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
532 alf.sym = map__find_symbol(alf.map, alf.addr);
534 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
536 alt.sym = map__find_symbol(alt.map, alt.addr);
538 symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
540 symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
541 printf("/%c/%c/%c/%d ",
542 mispred_str( br->entries + i),
543 br->entries[i].flags.in_tx? 'X' : '-',
544 br->entries[i].flags.abort? 'A' : '-',
545 br->entries[i].flags.cycles);
550 static void print_sample_addr(struct perf_sample *sample,
551 struct thread *thread,
552 struct perf_event_attr *attr)
554 struct addr_location al;
556 printf("%16" PRIx64, sample->addr);
558 if (!sample_addr_correlates_sym(attr))
561 thread__resolve(thread, &al, sample);
563 if (PRINT_FIELD(SYM)) {
565 if (PRINT_FIELD(SYMOFFSET))
566 symbol__fprintf_symname_offs(al.sym, &al, stdout);
568 symbol__fprintf_symname(al.sym, stdout);
571 if (PRINT_FIELD(DSO)) {
573 map__fprintf_dsoname(al.map, stdout);
578 static void print_sample_callindent(struct perf_sample *sample,
579 struct perf_evsel *evsel,
580 struct thread *thread,
581 struct addr_location *al)
583 struct perf_event_attr *attr = &evsel->attr;
584 size_t depth = thread_stack__depth(thread);
585 struct addr_location addr_al;
586 const char *name = NULL;
592 * The 'return' has already been popped off the stack so the depth has
593 * to be adjusted to match the 'call'.
595 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
598 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
599 if (sample_addr_correlates_sym(attr)) {
600 thread__resolve(thread, &addr_al, sample);
602 name = addr_al.sym->name;
608 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
610 name = al->sym->name;
616 len = printf("%*s%s", (int)depth * 4, "", name);
618 len = printf("%*s%16" PRIx64, (int)depth * 4, "", ip);
624 * Try to keep the output length from changing frequently so that the
625 * output lines up more nicely.
627 if (len > spacing || (len && len < spacing - 52))
628 spacing = round_up(len + 4, 32);
631 printf("%*s", spacing - len, "");
634 static void print_insn(struct perf_sample *sample,
635 struct perf_event_attr *attr)
637 if (PRINT_FIELD(INSNLEN))
638 printf(" ilen: %d", sample->insn_len);
639 if (PRINT_FIELD(INSN)) {
643 for (i = 0; i < sample->insn_len; i++)
644 printf(" %02x", (unsigned char)sample->insn[i]);
648 static void print_sample_bts(struct perf_sample *sample,
649 struct perf_evsel *evsel,
650 struct thread *thread,
651 struct addr_location *al)
653 struct perf_event_attr *attr = &evsel->attr;
654 bool print_srcline_last = false;
656 if (PRINT_FIELD(CALLINDENT))
657 print_sample_callindent(sample, evsel, thread, al);
659 /* print branch_from information */
660 if (PRINT_FIELD(IP)) {
661 unsigned int print_opts = output[attr->type].print_ip_opts;
662 struct callchain_cursor *cursor = NULL;
664 if (symbol_conf.use_callchain && sample->callchain &&
665 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
666 sample, NULL, NULL, scripting_max_stack) == 0)
667 cursor = &callchain_cursor;
669 if (cursor == NULL) {
671 if (print_opts & EVSEL__PRINT_SRCLINE) {
672 print_srcline_last = true;
673 print_opts &= ~EVSEL__PRINT_SRCLINE;
678 sample__fprintf_sym(sample, al, 0, print_opts, cursor, stdout);
681 /* print branch_to information */
682 if (PRINT_FIELD(ADDR) ||
683 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
684 !output[attr->type].user_set)) {
686 print_sample_addr(sample, thread, attr);
689 if (print_srcline_last)
690 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
692 print_insn(sample, attr);
701 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
702 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
703 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
704 {PERF_IP_FLAG_BRANCH, "jmp"},
705 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
706 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
707 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
708 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
709 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
710 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
711 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
712 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
713 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
717 static void print_sample_flags(u32 flags)
719 const char *chars = PERF_IP_FLAG_CHARS;
720 const int n = strlen(PERF_IP_FLAG_CHARS);
721 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
722 const char *name = NULL;
726 for (i = 0; sample_flags[i].name ; i++) {
727 if (sample_flags[i].flags == (flags & ~PERF_IP_FLAG_IN_TX)) {
728 name = sample_flags[i].name;
733 for (i = 0; i < n; i++, flags >>= 1) {
735 str[pos++] = chars[i];
737 for (; i < 32; i++, flags >>= 1) {
744 printf(" %-7s%4s ", name, in_tx ? "(x)" : "");
746 printf(" %-11s ", str);
749 struct printer_data {
756 print_sample_bpf_output_printer(enum binary_printer_ops op,
760 unsigned char ch = (unsigned char)val;
761 struct printer_data *printer_data = extra;
764 case BINARY_PRINT_DATA_BEGIN:
767 case BINARY_PRINT_LINE_BEGIN:
768 printf("%17s", !printer_data->line_no ? "BPF output:" :
771 case BINARY_PRINT_ADDR:
772 printf(" %04x:", val);
774 case BINARY_PRINT_NUM_DATA:
775 printf(" %02x", val);
777 case BINARY_PRINT_NUM_PAD:
780 case BINARY_PRINT_SEP:
783 case BINARY_PRINT_CHAR_DATA:
784 if (printer_data->hit_nul && ch)
785 printer_data->is_printable = false;
790 if (!printer_data->is_printable)
794 printer_data->hit_nul = true;
796 printer_data->is_printable = false;
801 case BINARY_PRINT_CHAR_PAD:
804 case BINARY_PRINT_LINE_END:
806 printer_data->line_no++;
808 case BINARY_PRINT_DATA_END:
814 static void print_sample_bpf_output(struct perf_sample *sample)
816 unsigned int nr_bytes = sample->raw_size;
817 struct printer_data printer_data = {0, false, true};
819 print_binary(sample->raw_data, nr_bytes, 8,
820 print_sample_bpf_output_printer, &printer_data);
822 if (printer_data.is_printable && printer_data.hit_nul)
823 printf("%17s \"%s\"\n", "BPF string:",
824 (char *)(sample->raw_data));
828 struct perf_tool tool;
829 struct perf_session *session;
830 bool show_task_events;
831 bool show_mmap_events;
832 bool show_switch_events;
833 bool show_namespace_events;
835 struct cpu_map *cpus;
836 struct thread_map *threads;
838 const char *time_str;
839 struct perf_time_interval ptime;
842 static int perf_evlist__max_name_len(struct perf_evlist *evlist)
844 struct perf_evsel *evsel;
847 evlist__for_each_entry(evlist, evsel) {
848 int len = strlen(perf_evsel__name(evsel));
856 static size_t data_src__printf(u64 data_src)
858 struct mem_info mi = { .data_src.val = data_src };
864 perf_script__meminfo_scnprintf(decode, 100, &mi);
866 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
870 return printf("%-*s", maxlen, out);
873 static void process_event(struct perf_script *script,
874 struct perf_sample *sample, struct perf_evsel *evsel,
875 struct addr_location *al)
877 struct thread *thread = al->thread;
878 struct perf_event_attr *attr = &evsel->attr;
880 if (output[attr->type].fields == 0)
883 print_sample_start(sample, thread, evsel);
885 if (PRINT_FIELD(PERIOD))
886 printf("%10" PRIu64 " ", sample->period);
888 if (PRINT_FIELD(EVNAME)) {
889 const char *evname = perf_evsel__name(evsel);
891 if (!script->name_width)
892 script->name_width = perf_evlist__max_name_len(script->session->evlist);
894 printf("%*s: ", script->name_width,
895 evname ? evname : "[unknown]");
899 print_sample_flags(sample->flags);
901 if (is_bts_event(attr)) {
902 print_sample_bts(sample, evsel, thread, al);
906 if (PRINT_FIELD(TRACE))
907 event_format__print(evsel->tp_format, sample->cpu,
908 sample->raw_data, sample->raw_size);
909 if (PRINT_FIELD(ADDR))
910 print_sample_addr(sample, thread, attr);
912 if (PRINT_FIELD(DATA_SRC))
913 data_src__printf(sample->data_src);
915 if (PRINT_FIELD(WEIGHT))
916 printf("%16" PRIu64, sample->weight);
918 if (PRINT_FIELD(IP)) {
919 struct callchain_cursor *cursor = NULL;
921 if (symbol_conf.use_callchain && sample->callchain &&
922 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
923 sample, NULL, NULL, scripting_max_stack) == 0)
924 cursor = &callchain_cursor;
926 putchar(cursor ? '\n' : ' ');
927 sample__fprintf_sym(sample, al, 0, output[attr->type].print_ip_opts, cursor, stdout);
930 if (PRINT_FIELD(IREGS))
931 print_sample_iregs(sample, attr);
933 if (PRINT_FIELD(BRSTACK))
934 print_sample_brstack(sample);
935 else if (PRINT_FIELD(BRSTACKSYM))
936 print_sample_brstacksym(sample, thread);
938 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
939 print_sample_bpf_output(sample);
940 print_insn(sample, attr);
944 static struct scripting_ops *scripting_ops;
946 static void __process_stat(struct perf_evsel *counter, u64 tstamp)
948 int nthreads = thread_map__nr(counter->threads);
949 int ncpus = perf_evsel__nr_cpus(counter);
951 static int header_printed;
953 if (counter->system_wide)
956 if (!header_printed) {
957 printf("%3s %8s %15s %15s %15s %15s %s\n",
958 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
962 for (thread = 0; thread < nthreads; thread++) {
963 for (cpu = 0; cpu < ncpus; cpu++) {
964 struct perf_counts_values *counts;
966 counts = perf_counts(counter->counts, cpu, thread);
968 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
969 counter->cpus->map[cpu],
970 thread_map__pid(counter->threads, thread),
975 perf_evsel__name(counter));
980 static void process_stat(struct perf_evsel *counter, u64 tstamp)
982 if (scripting_ops && scripting_ops->process_stat)
983 scripting_ops->process_stat(&stat_config, counter, tstamp);
985 __process_stat(counter, tstamp);
988 static void process_stat_interval(u64 tstamp)
990 if (scripting_ops && scripting_ops->process_stat_interval)
991 scripting_ops->process_stat_interval(tstamp);
994 static void setup_scripting(void)
996 setup_perl_scripting();
997 setup_python_scripting();
1000 static int flush_scripting(void)
1002 return scripting_ops ? scripting_ops->flush_script() : 0;
1005 static int cleanup_scripting(void)
1007 pr_debug("\nperf script stopped\n");
1009 return scripting_ops ? scripting_ops->stop_script() : 0;
1012 static int process_sample_event(struct perf_tool *tool,
1013 union perf_event *event,
1014 struct perf_sample *sample,
1015 struct perf_evsel *evsel,
1016 struct machine *machine)
1018 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1019 struct addr_location al;
1021 if (perf_time__skip_sample(&scr->ptime, sample->time))
1025 if (sample->time < last_timestamp) {
1026 pr_err("Samples misordered, previous: %" PRIu64
1027 " this: %" PRIu64 "\n", last_timestamp,
1031 last_timestamp = sample->time;
1035 if (machine__resolve(machine, &al, sample) < 0) {
1036 pr_err("problem processing %d event, skipping it.\n",
1037 event->header.type);
1044 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
1048 scripting_ops->process_event(event, sample, evsel, &al);
1050 process_event(scr, sample, evsel, &al);
1053 addr_location__put(&al);
1057 static int process_attr(struct perf_tool *tool, union perf_event *event,
1058 struct perf_evlist **pevlist)
1060 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1061 struct perf_evlist *evlist;
1062 struct perf_evsel *evsel, *pos;
1065 err = perf_event__process_attr(tool, event, pevlist);
1070 evsel = perf_evlist__last(*pevlist);
1072 if (evsel->attr.type >= PERF_TYPE_MAX)
1075 evlist__for_each_entry(evlist, pos) {
1076 if (pos->attr.type == evsel->attr.type && pos != evsel)
1080 set_print_ip_opts(&evsel->attr);
1082 if (evsel->attr.sample_type)
1083 err = perf_evsel__check_attr(evsel, scr->session);
1088 static int process_comm_event(struct perf_tool *tool,
1089 union perf_event *event,
1090 struct perf_sample *sample,
1091 struct machine *machine)
1093 struct thread *thread;
1094 struct perf_script *script = container_of(tool, struct perf_script, tool);
1095 struct perf_session *session = script->session;
1096 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1099 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
1100 if (thread == NULL) {
1101 pr_debug("problem processing COMM event, skipping it.\n");
1105 if (perf_event__process_comm(tool, event, sample, machine) < 0)
1108 if (!evsel->attr.sample_id_all) {
1111 sample->tid = event->comm.tid;
1112 sample->pid = event->comm.pid;
1114 print_sample_start(sample, thread, evsel);
1115 perf_event__fprintf(event, stdout);
1118 thread__put(thread);
1122 static int process_namespaces_event(struct perf_tool *tool,
1123 union perf_event *event,
1124 struct perf_sample *sample,
1125 struct machine *machine)
1127 struct thread *thread;
1128 struct perf_script *script = container_of(tool, struct perf_script, tool);
1129 struct perf_session *session = script->session;
1130 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1133 thread = machine__findnew_thread(machine, event->namespaces.pid,
1134 event->namespaces.tid);
1135 if (thread == NULL) {
1136 pr_debug("problem processing NAMESPACES event, skipping it.\n");
1140 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
1143 if (!evsel->attr.sample_id_all) {
1146 sample->tid = event->namespaces.tid;
1147 sample->pid = event->namespaces.pid;
1149 print_sample_start(sample, thread, evsel);
1150 perf_event__fprintf(event, stdout);
1153 thread__put(thread);
1157 static int process_fork_event(struct perf_tool *tool,
1158 union perf_event *event,
1159 struct perf_sample *sample,
1160 struct machine *machine)
1162 struct thread *thread;
1163 struct perf_script *script = container_of(tool, struct perf_script, tool);
1164 struct perf_session *session = script->session;
1165 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1167 if (perf_event__process_fork(tool, event, sample, machine) < 0)
1170 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1171 if (thread == NULL) {
1172 pr_debug("problem processing FORK event, skipping it.\n");
1176 if (!evsel->attr.sample_id_all) {
1178 sample->time = event->fork.time;
1179 sample->tid = event->fork.tid;
1180 sample->pid = event->fork.pid;
1182 print_sample_start(sample, thread, evsel);
1183 perf_event__fprintf(event, stdout);
1184 thread__put(thread);
1188 static int process_exit_event(struct perf_tool *tool,
1189 union perf_event *event,
1190 struct perf_sample *sample,
1191 struct machine *machine)
1194 struct thread *thread;
1195 struct perf_script *script = container_of(tool, struct perf_script, tool);
1196 struct perf_session *session = script->session;
1197 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1199 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1200 if (thread == NULL) {
1201 pr_debug("problem processing EXIT event, skipping it.\n");
1205 if (!evsel->attr.sample_id_all) {
1208 sample->tid = event->fork.tid;
1209 sample->pid = event->fork.pid;
1211 print_sample_start(sample, thread, evsel);
1212 perf_event__fprintf(event, stdout);
1214 if (perf_event__process_exit(tool, event, sample, machine) < 0)
1217 thread__put(thread);
1221 static int process_mmap_event(struct perf_tool *tool,
1222 union perf_event *event,
1223 struct perf_sample *sample,
1224 struct machine *machine)
1226 struct thread *thread;
1227 struct perf_script *script = container_of(tool, struct perf_script, tool);
1228 struct perf_session *session = script->session;
1229 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1231 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
1234 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
1235 if (thread == NULL) {
1236 pr_debug("problem processing MMAP event, skipping it.\n");
1240 if (!evsel->attr.sample_id_all) {
1243 sample->tid = event->mmap.tid;
1244 sample->pid = event->mmap.pid;
1246 print_sample_start(sample, thread, evsel);
1247 perf_event__fprintf(event, stdout);
1248 thread__put(thread);
1252 static int process_mmap2_event(struct perf_tool *tool,
1253 union perf_event *event,
1254 struct perf_sample *sample,
1255 struct machine *machine)
1257 struct thread *thread;
1258 struct perf_script *script = container_of(tool, struct perf_script, tool);
1259 struct perf_session *session = script->session;
1260 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1262 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
1265 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
1266 if (thread == NULL) {
1267 pr_debug("problem processing MMAP2 event, skipping it.\n");
1271 if (!evsel->attr.sample_id_all) {
1274 sample->tid = event->mmap2.tid;
1275 sample->pid = event->mmap2.pid;
1277 print_sample_start(sample, thread, evsel);
1278 perf_event__fprintf(event, stdout);
1279 thread__put(thread);
1283 static int process_switch_event(struct perf_tool *tool,
1284 union perf_event *event,
1285 struct perf_sample *sample,
1286 struct machine *machine)
1288 struct thread *thread;
1289 struct perf_script *script = container_of(tool, struct perf_script, tool);
1290 struct perf_session *session = script->session;
1291 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1293 if (perf_event__process_switch(tool, event, sample, machine) < 0)
1296 thread = machine__findnew_thread(machine, sample->pid,
1298 if (thread == NULL) {
1299 pr_debug("problem processing SWITCH event, skipping it.\n");
1303 print_sample_start(sample, thread, evsel);
1304 perf_event__fprintf(event, stdout);
1305 thread__put(thread);
1309 static void sig_handler(int sig __maybe_unused)
1314 static int __cmd_script(struct perf_script *script)
1318 signal(SIGINT, sig_handler);
1320 /* override event processing functions */
1321 if (script->show_task_events) {
1322 script->tool.comm = process_comm_event;
1323 script->tool.fork = process_fork_event;
1324 script->tool.exit = process_exit_event;
1326 if (script->show_mmap_events) {
1327 script->tool.mmap = process_mmap_event;
1328 script->tool.mmap2 = process_mmap2_event;
1330 if (script->show_switch_events)
1331 script->tool.context_switch = process_switch_event;
1332 if (script->show_namespace_events)
1333 script->tool.namespaces = process_namespaces_event;
1335 ret = perf_session__process_events(script->session);
1338 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1343 struct script_spec {
1344 struct list_head node;
1345 struct scripting_ops *ops;
1349 static LIST_HEAD(script_specs);
1351 static struct script_spec *script_spec__new(const char *spec,
1352 struct scripting_ops *ops)
1354 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
1357 strcpy(s->spec, spec);
1364 static void script_spec__add(struct script_spec *s)
1366 list_add_tail(&s->node, &script_specs);
1369 static struct script_spec *script_spec__find(const char *spec)
1371 struct script_spec *s;
1373 list_for_each_entry(s, &script_specs, node)
1374 if (strcasecmp(s->spec, spec) == 0)
1379 int script_spec_register(const char *spec, struct scripting_ops *ops)
1381 struct script_spec *s;
1383 s = script_spec__find(spec);
1387 s = script_spec__new(spec, ops);
1391 script_spec__add(s);
1396 static struct scripting_ops *script_spec__lookup(const char *spec)
1398 struct script_spec *s = script_spec__find(spec);
1405 static void list_available_languages(void)
1407 struct script_spec *s;
1409 fprintf(stderr, "\n");
1410 fprintf(stderr, "Scripting language extensions (used in "
1411 "perf script -s [spec:]script.[spec]):\n\n");
1413 list_for_each_entry(s, &script_specs, node)
1414 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
1416 fprintf(stderr, "\n");
1419 static int parse_scriptname(const struct option *opt __maybe_unused,
1420 const char *str, int unset __maybe_unused)
1422 char spec[PATH_MAX];
1423 const char *script, *ext;
1426 if (strcmp(str, "lang") == 0) {
1427 list_available_languages();
1431 script = strchr(str, ':');
1434 if (len >= PATH_MAX) {
1435 fprintf(stderr, "invalid language specifier");
1438 strncpy(spec, str, len);
1440 scripting_ops = script_spec__lookup(spec);
1441 if (!scripting_ops) {
1442 fprintf(stderr, "invalid language specifier");
1448 ext = strrchr(script, '.');
1450 fprintf(stderr, "invalid script extension");
1453 scripting_ops = script_spec__lookup(++ext);
1454 if (!scripting_ops) {
1455 fprintf(stderr, "invalid script extension");
1460 script_name = strdup(script);
1465 static int parse_output_fields(const struct option *opt __maybe_unused,
1466 const char *arg, int unset __maybe_unused)
1469 int i, imax = ARRAY_SIZE(all_output_options);
1472 char *str = strdup(arg);
1478 /* first word can state for which event type the user is specifying
1479 * the fields. If no type exists, the specified fields apply to all
1480 * event types found in the file minus the invalid fields for a type.
1482 tok = strchr(str, ':');
1486 if (!strcmp(str, "hw"))
1487 type = PERF_TYPE_HARDWARE;
1488 else if (!strcmp(str, "sw"))
1489 type = PERF_TYPE_SOFTWARE;
1490 else if (!strcmp(str, "trace"))
1491 type = PERF_TYPE_TRACEPOINT;
1492 else if (!strcmp(str, "raw"))
1493 type = PERF_TYPE_RAW;
1494 else if (!strcmp(str, "break"))
1495 type = PERF_TYPE_BREAKPOINT;
1497 fprintf(stderr, "Invalid event type in field string.\n");
1502 if (output[type].user_set)
1503 pr_warning("Overriding previous field request for %s events.\n",
1506 output[type].fields = 0;
1507 output[type].user_set = true;
1508 output[type].wildcard_set = false;
1512 if (strlen(str) == 0) {
1514 "Cannot set fields to 'none' for all event types.\n");
1519 if (output_set_by_user())
1520 pr_warning("Overriding previous field request for all events.\n");
1522 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1523 output[j].fields = 0;
1524 output[j].user_set = true;
1525 output[j].wildcard_set = true;
1529 for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
1530 for (i = 0; i < imax; ++i) {
1531 if (strcmp(tok, all_output_options[i].str) == 0)
1534 if (i == imax && strcmp(tok, "flags") == 0) {
1539 fprintf(stderr, "Invalid field requested.\n");
1545 /* add user option to all events types for
1548 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1549 if (output[j].invalid_fields & all_output_options[i].field) {
1550 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1551 all_output_options[i].str, event_type(j));
1553 output[j].fields |= all_output_options[i].field;
1556 if (output[type].invalid_fields & all_output_options[i].field) {
1557 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1558 all_output_options[i].str, event_type(type));
1563 output[type].fields |= all_output_options[i].field;
1568 if (output[type].fields == 0) {
1569 pr_debug("No fields requested for %s type. "
1570 "Events will not be displayed.\n", event_type(type));
1579 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1580 static int is_directory(const char *base_path, const struct dirent *dent)
1582 char path[PATH_MAX];
1585 sprintf(path, "%s/%s", base_path, dent->d_name);
1586 if (stat(path, &st))
1589 return S_ISDIR(st.st_mode);
1592 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
1593 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
1594 if ((lang_dirent->d_type == DT_DIR || \
1595 (lang_dirent->d_type == DT_UNKNOWN && \
1596 is_directory(scripts_path, lang_dirent))) && \
1597 (strcmp(lang_dirent->d_name, ".")) && \
1598 (strcmp(lang_dirent->d_name, "..")))
1600 #define for_each_script(lang_path, lang_dir, script_dirent) \
1601 while ((script_dirent = readdir(lang_dir)) != NULL) \
1602 if (script_dirent->d_type != DT_DIR && \
1603 (script_dirent->d_type != DT_UNKNOWN || \
1604 !is_directory(lang_path, script_dirent)))
1607 #define RECORD_SUFFIX "-record"
1608 #define REPORT_SUFFIX "-report"
1610 struct script_desc {
1611 struct list_head node;
1617 static LIST_HEAD(script_descs);
1619 static struct script_desc *script_desc__new(const char *name)
1621 struct script_desc *s = zalloc(sizeof(*s));
1623 if (s != NULL && name)
1624 s->name = strdup(name);
1629 static void script_desc__delete(struct script_desc *s)
1632 zfree(&s->half_liner);
1637 static void script_desc__add(struct script_desc *s)
1639 list_add_tail(&s->node, &script_descs);
1642 static struct script_desc *script_desc__find(const char *name)
1644 struct script_desc *s;
1646 list_for_each_entry(s, &script_descs, node)
1647 if (strcasecmp(s->name, name) == 0)
1652 static struct script_desc *script_desc__findnew(const char *name)
1654 struct script_desc *s = script_desc__find(name);
1659 s = script_desc__new(name);
1661 goto out_delete_desc;
1663 script_desc__add(s);
1668 script_desc__delete(s);
1673 static const char *ends_with(const char *str, const char *suffix)
1675 size_t suffix_len = strlen(suffix);
1676 const char *p = str;
1678 if (strlen(str) > suffix_len) {
1679 p = str + strlen(str) - suffix_len;
1680 if (!strncmp(p, suffix, suffix_len))
1687 static int read_script_info(struct script_desc *desc, const char *filename)
1689 char line[BUFSIZ], *p;
1692 fp = fopen(filename, "r");
1696 while (fgets(line, sizeof(line), fp)) {
1703 if (strlen(p) && *p == '!')
1707 if (strlen(p) && p[strlen(p) - 1] == '\n')
1708 p[strlen(p) - 1] = '\0';
1710 if (!strncmp(p, "description:", strlen("description:"))) {
1711 p += strlen("description:");
1712 desc->half_liner = strdup(ltrim(p));
1716 if (!strncmp(p, "args:", strlen("args:"))) {
1717 p += strlen("args:");
1718 desc->args = strdup(ltrim(p));
1728 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1730 char *script_root, *str;
1732 script_root = strdup(script_dirent->d_name);
1736 str = (char *)ends_with(script_root, suffix);
1746 static int list_available_scripts(const struct option *opt __maybe_unused,
1747 const char *s __maybe_unused,
1748 int unset __maybe_unused)
1750 struct dirent *script_dirent, *lang_dirent;
1751 char scripts_path[MAXPATHLEN];
1752 DIR *scripts_dir, *lang_dir;
1753 char script_path[MAXPATHLEN];
1754 char lang_path[MAXPATHLEN];
1755 struct script_desc *desc;
1756 char first_half[BUFSIZ];
1759 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1761 scripts_dir = opendir(scripts_path);
1764 "open(%s) failed.\n"
1765 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
1770 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1771 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1772 lang_dirent->d_name);
1773 lang_dir = opendir(lang_path);
1777 for_each_script(lang_path, lang_dir, script_dirent) {
1778 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
1780 desc = script_desc__findnew(script_root);
1781 snprintf(script_path, MAXPATHLEN, "%s/%s",
1782 lang_path, script_dirent->d_name);
1783 read_script_info(desc, script_path);
1789 fprintf(stdout, "List of available trace scripts:\n");
1790 list_for_each_entry(desc, &script_descs, node) {
1791 sprintf(first_half, "%s %s", desc->name,
1792 desc->args ? desc->args : "");
1793 fprintf(stdout, " %-36s %s\n", first_half,
1794 desc->half_liner ? desc->half_liner : "");
1801 * Some scripts specify the required events in their "xxx-record" file,
1802 * this function will check if the events in perf.data match those
1803 * mentioned in the "xxx-record".
1805 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1806 * which is covered well now. And new parsing code should be added to
1807 * cover the future complexing formats like event groups etc.
1809 static int check_ev_match(char *dir_name, char *scriptname,
1810 struct perf_session *session)
1812 char filename[MAXPATHLEN], evname[128];
1813 char line[BUFSIZ], *p;
1814 struct perf_evsel *pos;
1818 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1820 fp = fopen(filename, "r");
1824 while (fgets(line, sizeof(line), fp)) {
1830 p = strstr(p, "-e");
1836 len = strcspn(p, " \t");
1840 snprintf(evname, len + 1, "%s", p);
1843 evlist__for_each_entry(session->evlist, pos) {
1844 if (!strcmp(perf_evsel__name(pos), evname)) {
1862 * Return -1 if none is found, otherwise the actual scripts number.
1864 * Currently the only user of this function is the script browser, which
1865 * will list all statically runnable scripts, select one, execute it and
1866 * show the output in a perf browser.
1868 int find_scripts(char **scripts_array, char **scripts_path_array)
1870 struct dirent *script_dirent, *lang_dirent;
1871 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1872 DIR *scripts_dir, *lang_dir;
1873 struct perf_session *session;
1874 struct perf_data_file file = {
1876 .mode = PERF_DATA_MODE_READ,
1881 session = perf_session__new(&file, false, NULL);
1885 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1887 scripts_dir = opendir(scripts_path);
1889 perf_session__delete(session);
1893 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1894 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1895 lang_dirent->d_name);
1897 if (strstr(lang_path, "perl"))
1901 if (strstr(lang_path, "python"))
1905 lang_dir = opendir(lang_path);
1909 for_each_script(lang_path, lang_dir, script_dirent) {
1910 /* Skip those real time scripts: xxxtop.p[yl] */
1911 if (strstr(script_dirent->d_name, "top."))
1913 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1914 script_dirent->d_name);
1915 temp = strchr(script_dirent->d_name, '.');
1916 snprintf(scripts_array[i],
1917 (temp - script_dirent->d_name) + 1,
1918 "%s", script_dirent->d_name);
1920 if (check_ev_match(lang_path,
1921 scripts_array[i], session))
1929 closedir(scripts_dir);
1930 perf_session__delete(session);
1934 static char *get_script_path(const char *script_root, const char *suffix)
1936 struct dirent *script_dirent, *lang_dirent;
1937 char scripts_path[MAXPATHLEN];
1938 char script_path[MAXPATHLEN];
1939 DIR *scripts_dir, *lang_dir;
1940 char lang_path[MAXPATHLEN];
1941 char *__script_root;
1943 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1945 scripts_dir = opendir(scripts_path);
1949 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1950 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1951 lang_dirent->d_name);
1952 lang_dir = opendir(lang_path);
1956 for_each_script(lang_path, lang_dir, script_dirent) {
1957 __script_root = get_script_root(script_dirent, suffix);
1958 if (__script_root && !strcmp(script_root, __script_root)) {
1959 free(__script_root);
1961 closedir(scripts_dir);
1962 snprintf(script_path, MAXPATHLEN, "%s/%s",
1963 lang_path, script_dirent->d_name);
1964 return strdup(script_path);
1966 free(__script_root);
1970 closedir(scripts_dir);
1975 static bool is_top_script(const char *script_path)
1977 return ends_with(script_path, "top") == NULL ? false : true;
1980 static int has_required_arg(char *script_path)
1982 struct script_desc *desc;
1986 desc = script_desc__new(NULL);
1988 if (read_script_info(desc, script_path))
1994 for (p = desc->args; *p; p++)
1998 script_desc__delete(desc);
2003 static int have_cmd(int argc, const char **argv)
2005 char **__argv = malloc(sizeof(const char *) * argc);
2008 pr_err("malloc failed\n");
2012 memcpy(__argv, argv, sizeof(const char *) * argc);
2013 argc = parse_options(argc, (const char **)__argv, record_options,
2014 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
2017 system_wide = (argc == 0);
2022 static void script__setup_sample_type(struct perf_script *script)
2024 struct perf_session *session = script->session;
2025 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
2027 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
2028 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
2029 (sample_type & PERF_SAMPLE_STACK_USER))
2030 callchain_param.record_mode = CALLCHAIN_DWARF;
2031 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
2032 callchain_param.record_mode = CALLCHAIN_LBR;
2034 callchain_param.record_mode = CALLCHAIN_FP;
2038 static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
2039 union perf_event *event,
2040 struct perf_session *session)
2042 struct stat_round_event *round = &event->stat_round;
2043 struct perf_evsel *counter;
2045 evlist__for_each_entry(session->evlist, counter) {
2046 perf_stat_process_counter(&stat_config, counter);
2047 process_stat(counter, round->time);
2050 process_stat_interval(round->time);
2054 static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
2055 union perf_event *event,
2056 struct perf_session *session __maybe_unused)
2058 perf_event__read_stat_config(&stat_config, &event->stat_config);
2062 static int set_maps(struct perf_script *script)
2064 struct perf_evlist *evlist = script->session->evlist;
2066 if (!script->cpus || !script->threads)
2069 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
2072 perf_evlist__set_maps(evlist, script->cpus, script->threads);
2074 if (perf_evlist__alloc_stats(evlist, true))
2077 script->allocated = true;
2082 int process_thread_map_event(struct perf_tool *tool,
2083 union perf_event *event,
2084 struct perf_session *session __maybe_unused)
2086 struct perf_script *script = container_of(tool, struct perf_script, tool);
2088 if (script->threads) {
2089 pr_warning("Extra thread map event, ignoring.\n");
2093 script->threads = thread_map__new_event(&event->thread_map);
2094 if (!script->threads)
2097 return set_maps(script);
2101 int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
2102 union perf_event *event,
2103 struct perf_session *session __maybe_unused)
2105 struct perf_script *script = container_of(tool, struct perf_script, tool);
2108 pr_warning("Extra cpu map event, ignoring.\n");
2112 script->cpus = cpu_map__new_data(&event->cpu_map.data);
2116 return set_maps(script);
2119 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
2121 bool show_full_info = false;
2122 bool header = false;
2123 bool header_only = false;
2124 bool script_started = false;
2125 char *rec_script_path = NULL;
2126 char *rep_script_path = NULL;
2127 struct perf_session *session;
2128 struct itrace_synth_opts itrace_synth_opts = { .set = false, };
2129 char *script_path = NULL;
2130 const char **__argv;
2132 struct perf_script script = {
2134 .sample = process_sample_event,
2135 .mmap = perf_event__process_mmap,
2136 .mmap2 = perf_event__process_mmap2,
2137 .comm = perf_event__process_comm,
2138 .namespaces = perf_event__process_namespaces,
2139 .exit = perf_event__process_exit,
2140 .fork = perf_event__process_fork,
2141 .attr = process_attr,
2142 .event_update = perf_event__process_event_update,
2143 .tracing_data = perf_event__process_tracing_data,
2144 .build_id = perf_event__process_build_id,
2145 .id_index = perf_event__process_id_index,
2146 .auxtrace_info = perf_event__process_auxtrace_info,
2147 .auxtrace = perf_event__process_auxtrace,
2148 .auxtrace_error = perf_event__process_auxtrace_error,
2149 .stat = perf_event__process_stat_event,
2150 .stat_round = process_stat_round_event,
2151 .stat_config = process_stat_config_event,
2152 .thread_map = process_thread_map_event,
2153 .cpu_map = process_cpu_map_event,
2154 .ordered_events = true,
2155 .ordering_requires_timestamps = true,
2158 struct perf_data_file file = {
2159 .mode = PERF_DATA_MODE_READ,
2161 const struct option options[] = {
2162 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
2163 "dump raw trace in ASCII"),
2164 OPT_INCR('v', "verbose", &verbose,
2165 "be more verbose (show symbol address, etc)"),
2166 OPT_BOOLEAN('L', "Latency", &latency_format,
2167 "show latency attributes (irqs/preemption disabled, etc)"),
2168 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
2169 list_available_scripts),
2170 OPT_CALLBACK('s', "script", NULL, "name",
2171 "script file name (lang:script name, script name, or *)",
2173 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
2174 "generate perf-script.xx script in specified language"),
2175 OPT_STRING('i', "input", &input_name, "file", "input file name"),
2176 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
2177 "do various checks like samples ordering and lost events"),
2178 OPT_BOOLEAN(0, "header", &header, "Show data header."),
2179 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
2180 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2181 "file", "vmlinux pathname"),
2182 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
2183 "file", "kallsyms pathname"),
2184 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
2185 "When printing symbols do not display call chain"),
2186 OPT_CALLBACK(0, "symfs", NULL, "directory",
2187 "Look for files with symbols relative to this directory",
2188 symbol__config_symfs),
2189 OPT_CALLBACK('F', "fields", NULL, "str",
2190 "comma separated output fields prepend with 'type:'. "
2191 "Valid types: hw,sw,trace,raw. "
2192 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2193 "addr,symoff,period,iregs,brstack,brstacksym,flags,"
2194 "bpf-output,callindent,insn,insnlen", parse_output_fields),
2195 OPT_BOOLEAN('a', "all-cpus", &system_wide,
2196 "system-wide collection from all CPUs"),
2197 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
2198 "only consider these symbols"),
2199 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
2200 "Stop display of callgraph at these symbols"),
2201 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
2202 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
2203 "only display events for these comms"),
2204 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
2205 "only consider symbols in these pids"),
2206 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
2207 "only consider symbols in these tids"),
2208 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
2209 "Set the maximum stack depth when parsing the callchain, "
2210 "anything beyond the specified depth will be ignored. "
2211 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
2212 OPT_BOOLEAN('I', "show-info", &show_full_info,
2213 "display extended information from perf.data file"),
2214 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
2215 "Show the path of [kernel.kallsyms]"),
2216 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
2217 "Show the fork/comm/exit events"),
2218 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
2219 "Show the mmap events"),
2220 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
2221 "Show context switch events (if recorded)"),
2222 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
2223 "Show namespace events (if recorded)"),
2224 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
2225 OPT_BOOLEAN(0, "ns", &nanosecs,
2226 "Use 9 decimal places when displaying time"),
2227 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
2228 "Instruction Tracing options",
2229 itrace_parse_synth_opts),
2230 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
2231 "Show full source file name path for source lines"),
2232 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
2233 "Enable symbol demangling"),
2234 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
2235 "Enable kernel symbol demangling"),
2236 OPT_STRING(0, "time", &script.time_str, "str",
2237 "Time span of interest (start,stop)"),
2240 const char * const script_subcommands[] = { "record", "report", NULL };
2241 const char *script_usage[] = {
2242 "perf script [<options>]",
2243 "perf script [<options>] record <script> [<record-options>] <command>",
2244 "perf script [<options>] report <script> [script-args]",
2245 "perf script [<options>] <script> [<record-options>] <command>",
2246 "perf script [<options>] <top-script> [script-args]",
2252 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
2253 PARSE_OPT_STOP_AT_NON_OPTION);
2255 file.path = input_name;
2256 file.force = symbol_conf.force;
2258 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
2259 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
2260 if (!rec_script_path)
2261 return cmd_record(argc, argv, NULL);
2264 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
2265 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
2266 if (!rep_script_path) {
2268 "Please specify a valid report script"
2269 "(see 'perf script -l' for listing)\n");
2274 if (itrace_synth_opts.callchain &&
2275 itrace_synth_opts.callchain_sz > scripting_max_stack)
2276 scripting_max_stack = itrace_synth_opts.callchain_sz;
2278 /* make sure PERF_EXEC_PATH is set for scripts */
2279 set_argv_exec_path(get_argv_exec_path());
2281 if (argc && !script_name && !rec_script_path && !rep_script_path) {
2286 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
2287 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
2289 if (!rec_script_path && !rep_script_path) {
2290 usage_with_options_msg(script_usage, options,
2291 "Couldn't find script `%s'\n\n See perf"
2292 " script -l for available scripts.\n", argv[0]);
2295 if (is_top_script(argv[0])) {
2296 rep_args = argc - 1;
2300 rep_args = has_required_arg(rep_script_path);
2301 rec_args = (argc - 1) - rep_args;
2303 usage_with_options_msg(script_usage, options,
2304 "`%s' script requires options."
2305 "\n\n See perf script -l for available "
2306 "scripts and options.\n", argv[0]);
2310 if (pipe(live_pipe) < 0) {
2311 perror("failed to create pipe");
2317 perror("failed to fork");
2324 dup2(live_pipe[1], 1);
2325 close(live_pipe[0]);
2327 if (is_top_script(argv[0])) {
2329 } else if (!system_wide) {
2330 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
2336 __argv = malloc((argc + 6) * sizeof(const char *));
2338 pr_err("malloc failed\n");
2343 __argv[j++] = "/bin/sh";
2344 __argv[j++] = rec_script_path;
2350 for (i = rep_args + 1; i < argc; i++)
2351 __argv[j++] = argv[i];
2354 execvp("/bin/sh", (char **)__argv);
2359 dup2(live_pipe[0], 0);
2360 close(live_pipe[1]);
2362 __argv = malloc((argc + 4) * sizeof(const char *));
2364 pr_err("malloc failed\n");
2370 __argv[j++] = "/bin/sh";
2371 __argv[j++] = rep_script_path;
2372 for (i = 1; i < rep_args + 1; i++)
2373 __argv[j++] = argv[i];
2378 execvp("/bin/sh", (char **)__argv);
2383 if (rec_script_path)
2384 script_path = rec_script_path;
2385 if (rep_script_path)
2386 script_path = rep_script_path;
2391 if (!rec_script_path)
2392 system_wide = false;
2393 else if (!system_wide) {
2394 if (have_cmd(argc - 1, &argv[1]) != 0) {
2400 __argv = malloc((argc + 2) * sizeof(const char *));
2402 pr_err("malloc failed\n");
2407 __argv[j++] = "/bin/sh";
2408 __argv[j++] = script_path;
2411 for (i = 2; i < argc; i++)
2412 __argv[j++] = argv[i];
2415 execvp("/bin/sh", (char **)__argv);
2423 session = perf_session__new(&file, false, &script.tool);
2424 if (session == NULL)
2427 if (header || header_only) {
2428 perf_session__fprintf_info(session, stdout, show_full_info);
2433 if (symbol__init(&session->header.env) < 0)
2436 script.session = session;
2437 script__setup_sample_type(&script);
2439 if (output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT)
2440 itrace_synth_opts.thread_stack = true;
2442 session->itrace_synth_opts = &itrace_synth_opts;
2445 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
2451 symbol_conf.use_callchain = true;
2453 symbol_conf.use_callchain = false;
2455 if (session->tevent.pevent &&
2456 pevent_set_function_resolver(session->tevent.pevent,
2457 machine__resolve_kernel_addr,
2458 &session->machines.host) < 0) {
2459 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
2463 if (generate_script_lang) {
2464 struct stat perf_stat;
2467 if (output_set_by_user()) {
2469 "custom fields not supported for generated scripts");
2474 input = open(file.path, O_RDONLY); /* input_name */
2477 perror("failed to open file");
2481 err = fstat(input, &perf_stat);
2483 perror("failed to stat file");
2487 if (!perf_stat.st_size) {
2488 fprintf(stderr, "zero-sized file, nothing to do!\n");
2492 scripting_ops = script_spec__lookup(generate_script_lang);
2493 if (!scripting_ops) {
2494 fprintf(stderr, "invalid language specifier");
2499 err = scripting_ops->generate_script(session->tevent.pevent,
2505 err = scripting_ops->start_script(script_name, argc, argv);
2508 pr_debug("perf script started with script %s\n\n", script_name);
2509 script_started = true;
2513 err = perf_session__check_output_opt(session);
2517 /* needs to be parsed after looking up reference time */
2518 if (perf_time__parse_str(&script.ptime, script.time_str) != 0) {
2519 pr_err("Invalid time string\n");
2523 err = __cmd_script(&script);
2528 perf_evlist__free_stats(session->evlist);
2529 perf_session__delete(session);
2532 cleanup_scripting();