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 <linux/bitmap.h>
26 #include <linux/stringify.h>
28 #include "util/mem-events.h"
30 static char const *script_name;
31 static char const *generate_script_lang;
32 static bool debug_mode;
33 static u64 last_timestamp;
34 static u64 nr_unordered;
35 static bool no_callchain;
36 static bool latency_format;
37 static bool system_wide;
38 static bool print_flags;
40 static const char *cpu_list;
41 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
42 static struct perf_stat_config stat_config;
44 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
46 enum perf_output_field {
47 PERF_OUTPUT_COMM = 1U << 0,
48 PERF_OUTPUT_TID = 1U << 1,
49 PERF_OUTPUT_PID = 1U << 2,
50 PERF_OUTPUT_TIME = 1U << 3,
51 PERF_OUTPUT_CPU = 1U << 4,
52 PERF_OUTPUT_EVNAME = 1U << 5,
53 PERF_OUTPUT_TRACE = 1U << 6,
54 PERF_OUTPUT_IP = 1U << 7,
55 PERF_OUTPUT_SYM = 1U << 8,
56 PERF_OUTPUT_DSO = 1U << 9,
57 PERF_OUTPUT_ADDR = 1U << 10,
58 PERF_OUTPUT_SYMOFFSET = 1U << 11,
59 PERF_OUTPUT_SRCLINE = 1U << 12,
60 PERF_OUTPUT_PERIOD = 1U << 13,
61 PERF_OUTPUT_IREGS = 1U << 14,
62 PERF_OUTPUT_BRSTACK = 1U << 15,
63 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
64 PERF_OUTPUT_DATA_SRC = 1U << 17,
65 PERF_OUTPUT_WEIGHT = 1U << 18,
66 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
67 PERF_OUTPUT_CALLINDENT = 1U << 20,
70 struct output_option {
72 enum perf_output_field field;
73 } all_output_options[] = {
74 {.str = "comm", .field = PERF_OUTPUT_COMM},
75 {.str = "tid", .field = PERF_OUTPUT_TID},
76 {.str = "pid", .field = PERF_OUTPUT_PID},
77 {.str = "time", .field = PERF_OUTPUT_TIME},
78 {.str = "cpu", .field = PERF_OUTPUT_CPU},
79 {.str = "event", .field = PERF_OUTPUT_EVNAME},
80 {.str = "trace", .field = PERF_OUTPUT_TRACE},
81 {.str = "ip", .field = PERF_OUTPUT_IP},
82 {.str = "sym", .field = PERF_OUTPUT_SYM},
83 {.str = "dso", .field = PERF_OUTPUT_DSO},
84 {.str = "addr", .field = PERF_OUTPUT_ADDR},
85 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
86 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
87 {.str = "period", .field = PERF_OUTPUT_PERIOD},
88 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
89 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
90 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
91 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
92 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
93 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
94 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
97 /* default set to maintain compatibility with current format */
101 unsigned int print_ip_opts;
104 } output[PERF_TYPE_MAX] = {
106 [PERF_TYPE_HARDWARE] = {
109 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
110 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
111 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
112 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
115 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
118 [PERF_TYPE_SOFTWARE] = {
121 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
122 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
123 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
124 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
125 PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
127 .invalid_fields = PERF_OUTPUT_TRACE,
130 [PERF_TYPE_TRACEPOINT] = {
133 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
134 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
135 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
141 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
142 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
143 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
144 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
145 PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR |
146 PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
148 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
151 [PERF_TYPE_BREAKPOINT] = {
154 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
155 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
156 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
157 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
160 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
164 static bool output_set_by_user(void)
167 for (j = 0; j < PERF_TYPE_MAX; ++j) {
168 if (output[j].user_set)
174 static const char *output_field2str(enum perf_output_field field)
176 int i, imax = ARRAY_SIZE(all_output_options);
177 const char *str = "";
179 for (i = 0; i < imax; ++i) {
180 if (all_output_options[i].field == field) {
181 str = all_output_options[i].str;
188 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
190 static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
191 u64 sample_type, const char *sample_msg,
192 enum perf_output_field field,
195 struct perf_event_attr *attr = &evsel->attr;
196 int type = attr->type;
199 if (attr->sample_type & sample_type)
202 if (output[type].user_set) {
205 evname = perf_evsel__name(evsel);
206 pr_err("Samples for '%s' event do not have %s attribute set. "
207 "Cannot print '%s' field.\n",
208 evname, sample_msg, output_field2str(field));
212 /* user did not ask for it explicitly so remove from the default list */
213 output[type].fields &= ~field;
214 evname = perf_evsel__name(evsel);
215 pr_debug("Samples for '%s' event do not have %s attribute set. "
216 "Skipping '%s' field.\n",
217 evname, sample_msg, output_field2str(field));
222 static int perf_evsel__check_stype(struct perf_evsel *evsel,
223 u64 sample_type, const char *sample_msg,
224 enum perf_output_field field)
226 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
230 static int perf_evsel__check_attr(struct perf_evsel *evsel,
231 struct perf_session *session)
233 struct perf_event_attr *attr = &evsel->attr;
236 if (perf_header__has_feat(&session->header, HEADER_STAT))
239 allow_user_set = perf_header__has_feat(&session->header,
242 if (PRINT_FIELD(TRACE) &&
243 !perf_session__has_traces(session, "record -R"))
246 if (PRINT_FIELD(IP)) {
247 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
252 if (PRINT_FIELD(ADDR) &&
253 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
254 PERF_OUTPUT_ADDR, allow_user_set))
257 if (PRINT_FIELD(DATA_SRC) &&
258 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
259 PERF_OUTPUT_DATA_SRC))
262 if (PRINT_FIELD(WEIGHT) &&
263 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
267 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
268 pr_err("Display of symbols requested but neither sample IP nor "
269 "sample address\nis selected. Hence, no addresses to convert "
273 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
274 pr_err("Display of offsets requested but symbol is not"
278 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
279 pr_err("Display of DSO requested but neither sample IP nor "
280 "sample address\nis selected. Hence, no addresses to convert "
284 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
285 pr_err("Display of source line number requested but sample IP is not\n"
286 "selected. Hence, no address to lookup the source line number.\n");
290 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
291 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
292 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
295 if (PRINT_FIELD(TIME) &&
296 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
300 if (PRINT_FIELD(CPU) &&
301 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
302 PERF_OUTPUT_CPU, allow_user_set))
305 if (PRINT_FIELD(PERIOD) &&
306 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
310 if (PRINT_FIELD(IREGS) &&
311 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
318 static void set_print_ip_opts(struct perf_event_attr *attr)
320 unsigned int type = attr->type;
322 output[type].print_ip_opts = 0;
324 output[type].print_ip_opts |= EVSEL__PRINT_IP;
326 if (PRINT_FIELD(SYM))
327 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
329 if (PRINT_FIELD(DSO))
330 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
332 if (PRINT_FIELD(SYMOFFSET))
333 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
335 if (PRINT_FIELD(SRCLINE))
336 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
340 * verify all user requested events exist and the samples
341 * have the expected data
343 static int perf_session__check_output_opt(struct perf_session *session)
346 struct perf_evsel *evsel;
348 for (j = 0; j < PERF_TYPE_MAX; ++j) {
349 evsel = perf_session__find_first_evtype(session, j);
352 * even if fields is set to 0 (ie., show nothing) event must
353 * exist if user explicitly includes it on the command line
355 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
356 pr_err("%s events do not exist. "
357 "Remove corresponding -f option to proceed.\n",
362 if (evsel && output[j].fields &&
363 perf_evsel__check_attr(evsel, session))
369 set_print_ip_opts(&evsel->attr);
373 bool use_callchain = false;
374 bool not_pipe = false;
376 evlist__for_each_entry(session->evlist, evsel) {
378 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
379 use_callchain = true;
383 if (not_pipe && !use_callchain)
384 symbol_conf.use_callchain = false;
388 * set default for tracepoints to print symbols only
389 * if callchains are present
391 if (symbol_conf.use_callchain &&
392 !output[PERF_TYPE_TRACEPOINT].user_set) {
393 struct perf_event_attr *attr;
395 j = PERF_TYPE_TRACEPOINT;
397 evlist__for_each_entry(session->evlist, evsel) {
398 if (evsel->attr.type != j)
403 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
404 output[j].fields |= PERF_OUTPUT_IP;
405 output[j].fields |= PERF_OUTPUT_SYM;
406 output[j].fields |= PERF_OUTPUT_DSO;
407 set_print_ip_opts(attr);
417 static void print_sample_iregs(struct perf_sample *sample,
418 struct perf_event_attr *attr)
420 struct regs_dump *regs = &sample->intr_regs;
421 uint64_t mask = attr->sample_regs_intr;
427 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
428 u64 val = regs->regs[i++];
429 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
433 static void print_sample_start(struct perf_sample *sample,
434 struct thread *thread,
435 struct perf_evsel *evsel)
437 struct perf_event_attr *attr = &evsel->attr;
440 unsigned long long nsecs;
442 if (PRINT_FIELD(COMM)) {
444 printf("%8.8s ", thread__comm_str(thread));
445 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
446 printf("%s ", thread__comm_str(thread));
448 printf("%16s ", thread__comm_str(thread));
451 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
452 printf("%5d/%-5d ", sample->pid, sample->tid);
453 else if (PRINT_FIELD(PID))
454 printf("%5d ", sample->pid);
455 else if (PRINT_FIELD(TID))
456 printf("%5d ", sample->tid);
458 if (PRINT_FIELD(CPU)) {
460 printf("%3d ", sample->cpu);
462 printf("[%03d] ", sample->cpu);
465 if (PRINT_FIELD(TIME)) {
466 nsecs = sample->time;
467 secs = nsecs / NSECS_PER_SEC;
468 nsecs -= secs * NSECS_PER_SEC;
469 usecs = nsecs / NSECS_PER_USEC;
471 printf("%5lu.%09llu: ", secs, nsecs);
473 printf("%5lu.%06lu: ", secs, usecs);
478 mispred_str(struct branch_entry *br)
480 if (!(br->flags.mispred || br->flags.predicted))
483 return br->flags.predicted ? 'P' : 'M';
486 static void print_sample_brstack(struct perf_sample *sample)
488 struct branch_stack *br = sample->branch_stack;
494 for (i = 0; i < br->nr; i++) {
495 printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
498 mispred_str( br->entries + i),
499 br->entries[i].flags.in_tx? 'X' : '-',
500 br->entries[i].flags.abort? 'A' : '-',
501 br->entries[i].flags.cycles);
505 static void print_sample_brstacksym(struct perf_sample *sample,
506 struct thread *thread)
508 struct branch_stack *br = sample->branch_stack;
509 struct addr_location alf, alt;
515 for (i = 0; i < br->nr; i++) {
517 memset(&alf, 0, sizeof(alf));
518 memset(&alt, 0, sizeof(alt));
519 from = br->entries[i].from;
520 to = br->entries[i].to;
522 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
524 alf.sym = map__find_symbol(alf.map, alf.addr, NULL);
526 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
528 alt.sym = map__find_symbol(alt.map, alt.addr, NULL);
530 symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
532 symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
533 printf("/%c/%c/%c/%d ",
534 mispred_str( br->entries + i),
535 br->entries[i].flags.in_tx? 'X' : '-',
536 br->entries[i].flags.abort? 'A' : '-',
537 br->entries[i].flags.cycles);
542 static void print_sample_addr(struct perf_sample *sample,
543 struct thread *thread,
544 struct perf_event_attr *attr)
546 struct addr_location al;
548 printf("%16" PRIx64, sample->addr);
550 if (!sample_addr_correlates_sym(attr))
553 thread__resolve(thread, &al, sample);
555 if (PRINT_FIELD(SYM)) {
557 if (PRINT_FIELD(SYMOFFSET))
558 symbol__fprintf_symname_offs(al.sym, &al, stdout);
560 symbol__fprintf_symname(al.sym, stdout);
563 if (PRINT_FIELD(DSO)) {
565 map__fprintf_dsoname(al.map, stdout);
570 static void print_sample_callindent(struct perf_sample *sample,
571 struct perf_evsel *evsel,
572 struct thread *thread,
573 struct addr_location *al)
575 struct perf_event_attr *attr = &evsel->attr;
576 size_t depth = thread_stack__depth(thread);
577 struct addr_location addr_al;
578 const char *name = NULL;
584 * The 'return' has already been popped off the stack so the depth has
585 * to be adjusted to match the 'call'.
587 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
590 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
591 if (sample_addr_correlates_sym(attr)) {
592 thread__resolve(thread, &addr_al, sample);
594 name = addr_al.sym->name;
600 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
602 name = al->sym->name;
608 len = printf("%*s%s", (int)depth * 4, "", name);
610 len = printf("%*s%16" PRIx64, (int)depth * 4, "", ip);
616 * Try to keep the output length from changing frequently so that the
617 * output lines up more nicely.
619 if (len > spacing || (len && len < spacing - 52))
620 spacing = round_up(len + 4, 32);
623 printf("%*s", spacing - len, "");
626 static void print_sample_bts(struct perf_sample *sample,
627 struct perf_evsel *evsel,
628 struct thread *thread,
629 struct addr_location *al)
631 struct perf_event_attr *attr = &evsel->attr;
632 bool print_srcline_last = false;
634 if (PRINT_FIELD(CALLINDENT))
635 print_sample_callindent(sample, evsel, thread, al);
637 /* print branch_from information */
638 if (PRINT_FIELD(IP)) {
639 unsigned int print_opts = output[attr->type].print_ip_opts;
640 struct callchain_cursor *cursor = NULL;
642 if (symbol_conf.use_callchain && sample->callchain &&
643 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
644 sample, NULL, NULL, scripting_max_stack) == 0)
645 cursor = &callchain_cursor;
647 if (cursor == NULL) {
649 if (print_opts & EVSEL__PRINT_SRCLINE) {
650 print_srcline_last = true;
651 print_opts &= ~EVSEL__PRINT_SRCLINE;
656 sample__fprintf_sym(sample, al, 0, print_opts, cursor, stdout);
659 /* print branch_to information */
660 if (PRINT_FIELD(ADDR) ||
661 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
662 !output[attr->type].user_set)) {
664 print_sample_addr(sample, thread, attr);
667 if (print_srcline_last)
668 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
677 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
678 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
679 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
680 {PERF_IP_FLAG_BRANCH, "jmp"},
681 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
682 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
683 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
684 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
685 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
686 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
687 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
688 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
689 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
693 static void print_sample_flags(u32 flags)
695 const char *chars = PERF_IP_FLAG_CHARS;
696 const int n = strlen(PERF_IP_FLAG_CHARS);
697 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
698 const char *name = NULL;
702 for (i = 0; sample_flags[i].name ; i++) {
703 if (sample_flags[i].flags == (flags & ~PERF_IP_FLAG_IN_TX)) {
704 name = sample_flags[i].name;
709 for (i = 0; i < n; i++, flags >>= 1) {
711 str[pos++] = chars[i];
713 for (; i < 32; i++, flags >>= 1) {
720 printf(" %-7s%4s ", name, in_tx ? "(x)" : "");
722 printf(" %-11s ", str);
725 struct printer_data {
732 print_sample_bpf_output_printer(enum binary_printer_ops op,
736 unsigned char ch = (unsigned char)val;
737 struct printer_data *printer_data = extra;
740 case BINARY_PRINT_DATA_BEGIN:
743 case BINARY_PRINT_LINE_BEGIN:
744 printf("%17s", !printer_data->line_no ? "BPF output:" :
747 case BINARY_PRINT_ADDR:
748 printf(" %04x:", val);
750 case BINARY_PRINT_NUM_DATA:
751 printf(" %02x", val);
753 case BINARY_PRINT_NUM_PAD:
756 case BINARY_PRINT_SEP:
759 case BINARY_PRINT_CHAR_DATA:
760 if (printer_data->hit_nul && ch)
761 printer_data->is_printable = false;
766 if (!printer_data->is_printable)
770 printer_data->hit_nul = true;
772 printer_data->is_printable = false;
777 case BINARY_PRINT_CHAR_PAD:
780 case BINARY_PRINT_LINE_END:
782 printer_data->line_no++;
784 case BINARY_PRINT_DATA_END:
790 static void print_sample_bpf_output(struct perf_sample *sample)
792 unsigned int nr_bytes = sample->raw_size;
793 struct printer_data printer_data = {0, false, true};
795 print_binary(sample->raw_data, nr_bytes, 8,
796 print_sample_bpf_output_printer, &printer_data);
798 if (printer_data.is_printable && printer_data.hit_nul)
799 printf("%17s \"%s\"\n", "BPF string:",
800 (char *)(sample->raw_data));
804 struct perf_tool tool;
805 struct perf_session *session;
806 bool show_task_events;
807 bool show_mmap_events;
808 bool show_switch_events;
810 struct cpu_map *cpus;
811 struct thread_map *threads;
815 static int perf_evlist__max_name_len(struct perf_evlist *evlist)
817 struct perf_evsel *evsel;
820 evlist__for_each_entry(evlist, evsel) {
821 int len = strlen(perf_evsel__name(evsel));
829 static size_t data_src__printf(u64 data_src)
831 struct mem_info mi = { .data_src.val = data_src };
837 perf_script__meminfo_scnprintf(decode, 100, &mi);
839 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
843 return printf("%-*s", maxlen, out);
846 static void process_event(struct perf_script *script,
847 struct perf_sample *sample, struct perf_evsel *evsel,
848 struct addr_location *al)
850 struct thread *thread = al->thread;
851 struct perf_event_attr *attr = &evsel->attr;
853 if (output[attr->type].fields == 0)
856 print_sample_start(sample, thread, evsel);
858 if (PRINT_FIELD(PERIOD))
859 printf("%10" PRIu64 " ", sample->period);
861 if (PRINT_FIELD(EVNAME)) {
862 const char *evname = perf_evsel__name(evsel);
864 if (!script->name_width)
865 script->name_width = perf_evlist__max_name_len(script->session->evlist);
867 printf("%*s: ", script->name_width,
868 evname ? evname : "[unknown]");
872 print_sample_flags(sample->flags);
874 if (is_bts_event(attr)) {
875 print_sample_bts(sample, evsel, thread, al);
879 if (PRINT_FIELD(TRACE))
880 event_format__print(evsel->tp_format, sample->cpu,
881 sample->raw_data, sample->raw_size);
882 if (PRINT_FIELD(ADDR))
883 print_sample_addr(sample, thread, attr);
885 if (PRINT_FIELD(DATA_SRC))
886 data_src__printf(sample->data_src);
888 if (PRINT_FIELD(WEIGHT))
889 printf("%16" PRIu64, sample->weight);
891 if (PRINT_FIELD(IP)) {
892 struct callchain_cursor *cursor = NULL;
894 if (symbol_conf.use_callchain && sample->callchain &&
895 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
896 sample, NULL, NULL, scripting_max_stack) == 0)
897 cursor = &callchain_cursor;
899 putchar(cursor ? '\n' : ' ');
900 sample__fprintf_sym(sample, al, 0, output[attr->type].print_ip_opts, cursor, stdout);
903 if (PRINT_FIELD(IREGS))
904 print_sample_iregs(sample, attr);
906 if (PRINT_FIELD(BRSTACK))
907 print_sample_brstack(sample);
908 else if (PRINT_FIELD(BRSTACKSYM))
909 print_sample_brstacksym(sample, thread);
911 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
912 print_sample_bpf_output(sample);
917 static struct scripting_ops *scripting_ops;
919 static void __process_stat(struct perf_evsel *counter, u64 tstamp)
921 int nthreads = thread_map__nr(counter->threads);
922 int ncpus = perf_evsel__nr_cpus(counter);
924 static int header_printed;
926 if (counter->system_wide)
929 if (!header_printed) {
930 printf("%3s %8s %15s %15s %15s %15s %s\n",
931 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
935 for (thread = 0; thread < nthreads; thread++) {
936 for (cpu = 0; cpu < ncpus; cpu++) {
937 struct perf_counts_values *counts;
939 counts = perf_counts(counter->counts, cpu, thread);
941 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
942 counter->cpus->map[cpu],
943 thread_map__pid(counter->threads, thread),
948 perf_evsel__name(counter));
953 static void process_stat(struct perf_evsel *counter, u64 tstamp)
955 if (scripting_ops && scripting_ops->process_stat)
956 scripting_ops->process_stat(&stat_config, counter, tstamp);
958 __process_stat(counter, tstamp);
961 static void process_stat_interval(u64 tstamp)
963 if (scripting_ops && scripting_ops->process_stat_interval)
964 scripting_ops->process_stat_interval(tstamp);
967 static void setup_scripting(void)
969 setup_perl_scripting();
970 setup_python_scripting();
973 static int flush_scripting(void)
975 return scripting_ops ? scripting_ops->flush_script() : 0;
978 static int cleanup_scripting(void)
980 pr_debug("\nperf script stopped\n");
982 return scripting_ops ? scripting_ops->stop_script() : 0;
985 static int process_sample_event(struct perf_tool *tool,
986 union perf_event *event,
987 struct perf_sample *sample,
988 struct perf_evsel *evsel,
989 struct machine *machine)
991 struct perf_script *scr = container_of(tool, struct perf_script, tool);
992 struct addr_location al;
995 if (sample->time < last_timestamp) {
996 pr_err("Samples misordered, previous: %" PRIu64
997 " this: %" PRIu64 "\n", last_timestamp,
1001 last_timestamp = sample->time;
1005 if (machine__resolve(machine, &al, sample) < 0) {
1006 pr_err("problem processing %d event, skipping it.\n",
1007 event->header.type);
1014 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
1018 scripting_ops->process_event(event, sample, evsel, &al);
1020 process_event(scr, sample, evsel, &al);
1023 addr_location__put(&al);
1027 static int process_attr(struct perf_tool *tool, union perf_event *event,
1028 struct perf_evlist **pevlist)
1030 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1031 struct perf_evlist *evlist;
1032 struct perf_evsel *evsel, *pos;
1035 err = perf_event__process_attr(tool, event, pevlist);
1040 evsel = perf_evlist__last(*pevlist);
1042 if (evsel->attr.type >= PERF_TYPE_MAX)
1045 evlist__for_each_entry(evlist, pos) {
1046 if (pos->attr.type == evsel->attr.type && pos != evsel)
1050 set_print_ip_opts(&evsel->attr);
1052 if (evsel->attr.sample_type)
1053 err = perf_evsel__check_attr(evsel, scr->session);
1058 static int process_comm_event(struct perf_tool *tool,
1059 union perf_event *event,
1060 struct perf_sample *sample,
1061 struct machine *machine)
1063 struct thread *thread;
1064 struct perf_script *script = container_of(tool, struct perf_script, tool);
1065 struct perf_session *session = script->session;
1066 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1069 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
1070 if (thread == NULL) {
1071 pr_debug("problem processing COMM event, skipping it.\n");
1075 if (perf_event__process_comm(tool, event, sample, machine) < 0)
1078 if (!evsel->attr.sample_id_all) {
1081 sample->tid = event->comm.tid;
1082 sample->pid = event->comm.pid;
1084 print_sample_start(sample, thread, evsel);
1085 perf_event__fprintf(event, stdout);
1088 thread__put(thread);
1092 static int process_fork_event(struct perf_tool *tool,
1093 union perf_event *event,
1094 struct perf_sample *sample,
1095 struct machine *machine)
1097 struct thread *thread;
1098 struct perf_script *script = container_of(tool, struct perf_script, tool);
1099 struct perf_session *session = script->session;
1100 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1102 if (perf_event__process_fork(tool, event, sample, machine) < 0)
1105 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1106 if (thread == NULL) {
1107 pr_debug("problem processing FORK event, skipping it.\n");
1111 if (!evsel->attr.sample_id_all) {
1113 sample->time = event->fork.time;
1114 sample->tid = event->fork.tid;
1115 sample->pid = event->fork.pid;
1117 print_sample_start(sample, thread, evsel);
1118 perf_event__fprintf(event, stdout);
1119 thread__put(thread);
1123 static int process_exit_event(struct perf_tool *tool,
1124 union perf_event *event,
1125 struct perf_sample *sample,
1126 struct machine *machine)
1129 struct thread *thread;
1130 struct perf_script *script = container_of(tool, struct perf_script, tool);
1131 struct perf_session *session = script->session;
1132 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1134 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1135 if (thread == NULL) {
1136 pr_debug("problem processing EXIT event, skipping it.\n");
1140 if (!evsel->attr.sample_id_all) {
1143 sample->tid = event->fork.tid;
1144 sample->pid = event->fork.pid;
1146 print_sample_start(sample, thread, evsel);
1147 perf_event__fprintf(event, stdout);
1149 if (perf_event__process_exit(tool, event, sample, machine) < 0)
1152 thread__put(thread);
1156 static int process_mmap_event(struct perf_tool *tool,
1157 union perf_event *event,
1158 struct perf_sample *sample,
1159 struct machine *machine)
1161 struct thread *thread;
1162 struct perf_script *script = container_of(tool, struct perf_script, tool);
1163 struct perf_session *session = script->session;
1164 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1166 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
1169 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
1170 if (thread == NULL) {
1171 pr_debug("problem processing MMAP event, skipping it.\n");
1175 if (!evsel->attr.sample_id_all) {
1178 sample->tid = event->mmap.tid;
1179 sample->pid = event->mmap.pid;
1181 print_sample_start(sample, thread, evsel);
1182 perf_event__fprintf(event, stdout);
1183 thread__put(thread);
1187 static int process_mmap2_event(struct perf_tool *tool,
1188 union perf_event *event,
1189 struct perf_sample *sample,
1190 struct machine *machine)
1192 struct thread *thread;
1193 struct perf_script *script = container_of(tool, struct perf_script, tool);
1194 struct perf_session *session = script->session;
1195 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1197 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
1200 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
1201 if (thread == NULL) {
1202 pr_debug("problem processing MMAP2 event, skipping it.\n");
1206 if (!evsel->attr.sample_id_all) {
1209 sample->tid = event->mmap2.tid;
1210 sample->pid = event->mmap2.pid;
1212 print_sample_start(sample, thread, evsel);
1213 perf_event__fprintf(event, stdout);
1214 thread__put(thread);
1218 static int process_switch_event(struct perf_tool *tool,
1219 union perf_event *event,
1220 struct perf_sample *sample,
1221 struct machine *machine)
1223 struct thread *thread;
1224 struct perf_script *script = container_of(tool, struct perf_script, tool);
1225 struct perf_session *session = script->session;
1226 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1228 if (perf_event__process_switch(tool, event, sample, machine) < 0)
1231 thread = machine__findnew_thread(machine, sample->pid,
1233 if (thread == NULL) {
1234 pr_debug("problem processing SWITCH event, skipping it.\n");
1238 print_sample_start(sample, thread, evsel);
1239 perf_event__fprintf(event, stdout);
1240 thread__put(thread);
1244 static void sig_handler(int sig __maybe_unused)
1249 static int __cmd_script(struct perf_script *script)
1253 signal(SIGINT, sig_handler);
1255 /* override event processing functions */
1256 if (script->show_task_events) {
1257 script->tool.comm = process_comm_event;
1258 script->tool.fork = process_fork_event;
1259 script->tool.exit = process_exit_event;
1261 if (script->show_mmap_events) {
1262 script->tool.mmap = process_mmap_event;
1263 script->tool.mmap2 = process_mmap2_event;
1265 if (script->show_switch_events)
1266 script->tool.context_switch = process_switch_event;
1268 ret = perf_session__process_events(script->session);
1271 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1276 struct script_spec {
1277 struct list_head node;
1278 struct scripting_ops *ops;
1282 static LIST_HEAD(script_specs);
1284 static struct script_spec *script_spec__new(const char *spec,
1285 struct scripting_ops *ops)
1287 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
1290 strcpy(s->spec, spec);
1297 static void script_spec__add(struct script_spec *s)
1299 list_add_tail(&s->node, &script_specs);
1302 static struct script_spec *script_spec__find(const char *spec)
1304 struct script_spec *s;
1306 list_for_each_entry(s, &script_specs, node)
1307 if (strcasecmp(s->spec, spec) == 0)
1312 int script_spec_register(const char *spec, struct scripting_ops *ops)
1314 struct script_spec *s;
1316 s = script_spec__find(spec);
1320 s = script_spec__new(spec, ops);
1324 script_spec__add(s);
1329 static struct scripting_ops *script_spec__lookup(const char *spec)
1331 struct script_spec *s = script_spec__find(spec);
1338 static void list_available_languages(void)
1340 struct script_spec *s;
1342 fprintf(stderr, "\n");
1343 fprintf(stderr, "Scripting language extensions (used in "
1344 "perf script -s [spec:]script.[spec]):\n\n");
1346 list_for_each_entry(s, &script_specs, node)
1347 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
1349 fprintf(stderr, "\n");
1352 static int parse_scriptname(const struct option *opt __maybe_unused,
1353 const char *str, int unset __maybe_unused)
1355 char spec[PATH_MAX];
1356 const char *script, *ext;
1359 if (strcmp(str, "lang") == 0) {
1360 list_available_languages();
1364 script = strchr(str, ':');
1367 if (len >= PATH_MAX) {
1368 fprintf(stderr, "invalid language specifier");
1371 strncpy(spec, str, len);
1373 scripting_ops = script_spec__lookup(spec);
1374 if (!scripting_ops) {
1375 fprintf(stderr, "invalid language specifier");
1381 ext = strrchr(script, '.');
1383 fprintf(stderr, "invalid script extension");
1386 scripting_ops = script_spec__lookup(++ext);
1387 if (!scripting_ops) {
1388 fprintf(stderr, "invalid script extension");
1393 script_name = strdup(script);
1398 static int parse_output_fields(const struct option *opt __maybe_unused,
1399 const char *arg, int unset __maybe_unused)
1402 int i, imax = ARRAY_SIZE(all_output_options);
1405 char *str = strdup(arg);
1411 /* first word can state for which event type the user is specifying
1412 * the fields. If no type exists, the specified fields apply to all
1413 * event types found in the file minus the invalid fields for a type.
1415 tok = strchr(str, ':');
1419 if (!strcmp(str, "hw"))
1420 type = PERF_TYPE_HARDWARE;
1421 else if (!strcmp(str, "sw"))
1422 type = PERF_TYPE_SOFTWARE;
1423 else if (!strcmp(str, "trace"))
1424 type = PERF_TYPE_TRACEPOINT;
1425 else if (!strcmp(str, "raw"))
1426 type = PERF_TYPE_RAW;
1427 else if (!strcmp(str, "break"))
1428 type = PERF_TYPE_BREAKPOINT;
1430 fprintf(stderr, "Invalid event type in field string.\n");
1435 if (output[type].user_set)
1436 pr_warning("Overriding previous field request for %s events.\n",
1439 output[type].fields = 0;
1440 output[type].user_set = true;
1441 output[type].wildcard_set = false;
1445 if (strlen(str) == 0) {
1447 "Cannot set fields to 'none' for all event types.\n");
1452 if (output_set_by_user())
1453 pr_warning("Overriding previous field request for all events.\n");
1455 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1456 output[j].fields = 0;
1457 output[j].user_set = true;
1458 output[j].wildcard_set = true;
1462 for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
1463 for (i = 0; i < imax; ++i) {
1464 if (strcmp(tok, all_output_options[i].str) == 0)
1467 if (i == imax && strcmp(tok, "flags") == 0) {
1472 fprintf(stderr, "Invalid field requested.\n");
1478 /* add user option to all events types for
1481 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1482 if (output[j].invalid_fields & all_output_options[i].field) {
1483 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1484 all_output_options[i].str, event_type(j));
1486 output[j].fields |= all_output_options[i].field;
1489 if (output[type].invalid_fields & all_output_options[i].field) {
1490 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1491 all_output_options[i].str, event_type(type));
1496 output[type].fields |= all_output_options[i].field;
1501 if (output[type].fields == 0) {
1502 pr_debug("No fields requested for %s type. "
1503 "Events will not be displayed.\n", event_type(type));
1512 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1513 static int is_directory(const char *base_path, const struct dirent *dent)
1515 char path[PATH_MAX];
1518 sprintf(path, "%s/%s", base_path, dent->d_name);
1519 if (stat(path, &st))
1522 return S_ISDIR(st.st_mode);
1525 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
1526 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
1527 if ((lang_dirent->d_type == DT_DIR || \
1528 (lang_dirent->d_type == DT_UNKNOWN && \
1529 is_directory(scripts_path, lang_dirent))) && \
1530 (strcmp(lang_dirent->d_name, ".")) && \
1531 (strcmp(lang_dirent->d_name, "..")))
1533 #define for_each_script(lang_path, lang_dir, script_dirent) \
1534 while ((script_dirent = readdir(lang_dir)) != NULL) \
1535 if (script_dirent->d_type != DT_DIR && \
1536 (script_dirent->d_type != DT_UNKNOWN || \
1537 !is_directory(lang_path, script_dirent)))
1540 #define RECORD_SUFFIX "-record"
1541 #define REPORT_SUFFIX "-report"
1543 struct script_desc {
1544 struct list_head node;
1550 static LIST_HEAD(script_descs);
1552 static struct script_desc *script_desc__new(const char *name)
1554 struct script_desc *s = zalloc(sizeof(*s));
1556 if (s != NULL && name)
1557 s->name = strdup(name);
1562 static void script_desc__delete(struct script_desc *s)
1565 zfree(&s->half_liner);
1570 static void script_desc__add(struct script_desc *s)
1572 list_add_tail(&s->node, &script_descs);
1575 static struct script_desc *script_desc__find(const char *name)
1577 struct script_desc *s;
1579 list_for_each_entry(s, &script_descs, node)
1580 if (strcasecmp(s->name, name) == 0)
1585 static struct script_desc *script_desc__findnew(const char *name)
1587 struct script_desc *s = script_desc__find(name);
1592 s = script_desc__new(name);
1594 goto out_delete_desc;
1596 script_desc__add(s);
1601 script_desc__delete(s);
1606 static const char *ends_with(const char *str, const char *suffix)
1608 size_t suffix_len = strlen(suffix);
1609 const char *p = str;
1611 if (strlen(str) > suffix_len) {
1612 p = str + strlen(str) - suffix_len;
1613 if (!strncmp(p, suffix, suffix_len))
1620 static int read_script_info(struct script_desc *desc, const char *filename)
1622 char line[BUFSIZ], *p;
1625 fp = fopen(filename, "r");
1629 while (fgets(line, sizeof(line), fp)) {
1636 if (strlen(p) && *p == '!')
1640 if (strlen(p) && p[strlen(p) - 1] == '\n')
1641 p[strlen(p) - 1] = '\0';
1643 if (!strncmp(p, "description:", strlen("description:"))) {
1644 p += strlen("description:");
1645 desc->half_liner = strdup(ltrim(p));
1649 if (!strncmp(p, "args:", strlen("args:"))) {
1650 p += strlen("args:");
1651 desc->args = strdup(ltrim(p));
1661 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1663 char *script_root, *str;
1665 script_root = strdup(script_dirent->d_name);
1669 str = (char *)ends_with(script_root, suffix);
1679 static int list_available_scripts(const struct option *opt __maybe_unused,
1680 const char *s __maybe_unused,
1681 int unset __maybe_unused)
1683 struct dirent *script_dirent, *lang_dirent;
1684 char scripts_path[MAXPATHLEN];
1685 DIR *scripts_dir, *lang_dir;
1686 char script_path[MAXPATHLEN];
1687 char lang_path[MAXPATHLEN];
1688 struct script_desc *desc;
1689 char first_half[BUFSIZ];
1692 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1694 scripts_dir = opendir(scripts_path);
1697 "open(%s) failed.\n"
1698 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
1703 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1704 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1705 lang_dirent->d_name);
1706 lang_dir = opendir(lang_path);
1710 for_each_script(lang_path, lang_dir, script_dirent) {
1711 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
1713 desc = script_desc__findnew(script_root);
1714 snprintf(script_path, MAXPATHLEN, "%s/%s",
1715 lang_path, script_dirent->d_name);
1716 read_script_info(desc, script_path);
1722 fprintf(stdout, "List of available trace scripts:\n");
1723 list_for_each_entry(desc, &script_descs, node) {
1724 sprintf(first_half, "%s %s", desc->name,
1725 desc->args ? desc->args : "");
1726 fprintf(stdout, " %-36s %s\n", first_half,
1727 desc->half_liner ? desc->half_liner : "");
1734 * Some scripts specify the required events in their "xxx-record" file,
1735 * this function will check if the events in perf.data match those
1736 * mentioned in the "xxx-record".
1738 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1739 * which is covered well now. And new parsing code should be added to
1740 * cover the future complexing formats like event groups etc.
1742 static int check_ev_match(char *dir_name, char *scriptname,
1743 struct perf_session *session)
1745 char filename[MAXPATHLEN], evname[128];
1746 char line[BUFSIZ], *p;
1747 struct perf_evsel *pos;
1751 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1753 fp = fopen(filename, "r");
1757 while (fgets(line, sizeof(line), fp)) {
1763 p = strstr(p, "-e");
1769 len = strcspn(p, " \t");
1773 snprintf(evname, len + 1, "%s", p);
1776 evlist__for_each_entry(session->evlist, pos) {
1777 if (!strcmp(perf_evsel__name(pos), evname)) {
1795 * Return -1 if none is found, otherwise the actual scripts number.
1797 * Currently the only user of this function is the script browser, which
1798 * will list all statically runnable scripts, select one, execute it and
1799 * show the output in a perf browser.
1801 int find_scripts(char **scripts_array, char **scripts_path_array)
1803 struct dirent *script_dirent, *lang_dirent;
1804 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1805 DIR *scripts_dir, *lang_dir;
1806 struct perf_session *session;
1807 struct perf_data_file file = {
1809 .mode = PERF_DATA_MODE_READ,
1814 session = perf_session__new(&file, false, NULL);
1818 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1820 scripts_dir = opendir(scripts_path);
1822 perf_session__delete(session);
1826 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1827 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1828 lang_dirent->d_name);
1830 if (strstr(lang_path, "perl"))
1834 if (strstr(lang_path, "python"))
1838 lang_dir = opendir(lang_path);
1842 for_each_script(lang_path, lang_dir, script_dirent) {
1843 /* Skip those real time scripts: xxxtop.p[yl] */
1844 if (strstr(script_dirent->d_name, "top."))
1846 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1847 script_dirent->d_name);
1848 temp = strchr(script_dirent->d_name, '.');
1849 snprintf(scripts_array[i],
1850 (temp - script_dirent->d_name) + 1,
1851 "%s", script_dirent->d_name);
1853 if (check_ev_match(lang_path,
1854 scripts_array[i], session))
1862 closedir(scripts_dir);
1863 perf_session__delete(session);
1867 static char *get_script_path(const char *script_root, const char *suffix)
1869 struct dirent *script_dirent, *lang_dirent;
1870 char scripts_path[MAXPATHLEN];
1871 char script_path[MAXPATHLEN];
1872 DIR *scripts_dir, *lang_dir;
1873 char lang_path[MAXPATHLEN];
1874 char *__script_root;
1876 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1878 scripts_dir = opendir(scripts_path);
1882 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1883 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1884 lang_dirent->d_name);
1885 lang_dir = opendir(lang_path);
1889 for_each_script(lang_path, lang_dir, script_dirent) {
1890 __script_root = get_script_root(script_dirent, suffix);
1891 if (__script_root && !strcmp(script_root, __script_root)) {
1892 free(__script_root);
1894 closedir(scripts_dir);
1895 snprintf(script_path, MAXPATHLEN, "%s/%s",
1896 lang_path, script_dirent->d_name);
1897 return strdup(script_path);
1899 free(__script_root);
1903 closedir(scripts_dir);
1908 static bool is_top_script(const char *script_path)
1910 return ends_with(script_path, "top") == NULL ? false : true;
1913 static int has_required_arg(char *script_path)
1915 struct script_desc *desc;
1919 desc = script_desc__new(NULL);
1921 if (read_script_info(desc, script_path))
1927 for (p = desc->args; *p; p++)
1931 script_desc__delete(desc);
1936 static int have_cmd(int argc, const char **argv)
1938 char **__argv = malloc(sizeof(const char *) * argc);
1941 pr_err("malloc failed\n");
1945 memcpy(__argv, argv, sizeof(const char *) * argc);
1946 argc = parse_options(argc, (const char **)__argv, record_options,
1947 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1950 system_wide = (argc == 0);
1955 static void script__setup_sample_type(struct perf_script *script)
1957 struct perf_session *session = script->session;
1958 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
1960 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
1961 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
1962 (sample_type & PERF_SAMPLE_STACK_USER))
1963 callchain_param.record_mode = CALLCHAIN_DWARF;
1964 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
1965 callchain_param.record_mode = CALLCHAIN_LBR;
1967 callchain_param.record_mode = CALLCHAIN_FP;
1971 static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
1972 union perf_event *event,
1973 struct perf_session *session)
1975 struct stat_round_event *round = &event->stat_round;
1976 struct perf_evsel *counter;
1978 evlist__for_each_entry(session->evlist, counter) {
1979 perf_stat_process_counter(&stat_config, counter);
1980 process_stat(counter, round->time);
1983 process_stat_interval(round->time);
1987 static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
1988 union perf_event *event,
1989 struct perf_session *session __maybe_unused)
1991 perf_event__read_stat_config(&stat_config, &event->stat_config);
1995 static int set_maps(struct perf_script *script)
1997 struct perf_evlist *evlist = script->session->evlist;
1999 if (!script->cpus || !script->threads)
2002 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
2005 perf_evlist__set_maps(evlist, script->cpus, script->threads);
2007 if (perf_evlist__alloc_stats(evlist, true))
2010 script->allocated = true;
2015 int process_thread_map_event(struct perf_tool *tool,
2016 union perf_event *event,
2017 struct perf_session *session __maybe_unused)
2019 struct perf_script *script = container_of(tool, struct perf_script, tool);
2021 if (script->threads) {
2022 pr_warning("Extra thread map event, ignoring.\n");
2026 script->threads = thread_map__new_event(&event->thread_map);
2027 if (!script->threads)
2030 return set_maps(script);
2034 int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
2035 union perf_event *event,
2036 struct perf_session *session __maybe_unused)
2038 struct perf_script *script = container_of(tool, struct perf_script, tool);
2041 pr_warning("Extra cpu map event, ignoring.\n");
2045 script->cpus = cpu_map__new_data(&event->cpu_map.data);
2049 return set_maps(script);
2052 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
2054 bool show_full_info = false;
2055 bool header = false;
2056 bool header_only = false;
2057 bool script_started = false;
2058 char *rec_script_path = NULL;
2059 char *rep_script_path = NULL;
2060 struct perf_session *session;
2061 struct itrace_synth_opts itrace_synth_opts = { .set = false, };
2062 char *script_path = NULL;
2063 const char **__argv;
2065 struct perf_script script = {
2067 .sample = process_sample_event,
2068 .mmap = perf_event__process_mmap,
2069 .mmap2 = perf_event__process_mmap2,
2070 .comm = perf_event__process_comm,
2071 .exit = perf_event__process_exit,
2072 .fork = perf_event__process_fork,
2073 .attr = process_attr,
2074 .event_update = perf_event__process_event_update,
2075 .tracing_data = perf_event__process_tracing_data,
2076 .build_id = perf_event__process_build_id,
2077 .id_index = perf_event__process_id_index,
2078 .auxtrace_info = perf_event__process_auxtrace_info,
2079 .auxtrace = perf_event__process_auxtrace,
2080 .auxtrace_error = perf_event__process_auxtrace_error,
2081 .stat = perf_event__process_stat_event,
2082 .stat_round = process_stat_round_event,
2083 .stat_config = process_stat_config_event,
2084 .thread_map = process_thread_map_event,
2085 .cpu_map = process_cpu_map_event,
2086 .ordered_events = true,
2087 .ordering_requires_timestamps = true,
2090 struct perf_data_file file = {
2091 .mode = PERF_DATA_MODE_READ,
2093 const struct option options[] = {
2094 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
2095 "dump raw trace in ASCII"),
2096 OPT_INCR('v', "verbose", &verbose,
2097 "be more verbose (show symbol address, etc)"),
2098 OPT_BOOLEAN('L', "Latency", &latency_format,
2099 "show latency attributes (irqs/preemption disabled, etc)"),
2100 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
2101 list_available_scripts),
2102 OPT_CALLBACK('s', "script", NULL, "name",
2103 "script file name (lang:script name, script name, or *)",
2105 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
2106 "generate perf-script.xx script in specified language"),
2107 OPT_STRING('i', "input", &input_name, "file", "input file name"),
2108 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
2109 "do various checks like samples ordering and lost events"),
2110 OPT_BOOLEAN(0, "header", &header, "Show data header."),
2111 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
2112 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2113 "file", "vmlinux pathname"),
2114 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
2115 "file", "kallsyms pathname"),
2116 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
2117 "When printing symbols do not display call chain"),
2118 OPT_CALLBACK(0, "symfs", NULL, "directory",
2119 "Look for files with symbols relative to this directory",
2120 symbol__config_symfs),
2121 OPT_CALLBACK('F', "fields", NULL, "str",
2122 "comma separated output fields prepend with 'type:'. "
2123 "Valid types: hw,sw,trace,raw. "
2124 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2125 "addr,symoff,period,iregs,brstack,brstacksym,flags,"
2126 "bpf-output,callindent", parse_output_fields),
2127 OPT_BOOLEAN('a', "all-cpus", &system_wide,
2128 "system-wide collection from all CPUs"),
2129 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
2130 "only consider these symbols"),
2131 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
2132 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
2133 "only display events for these comms"),
2134 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
2135 "only consider symbols in these pids"),
2136 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
2137 "only consider symbols in these tids"),
2138 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
2139 "Set the maximum stack depth when parsing the callchain, "
2140 "anything beyond the specified depth will be ignored. "
2141 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
2142 OPT_BOOLEAN('I', "show-info", &show_full_info,
2143 "display extended information from perf.data file"),
2144 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
2145 "Show the path of [kernel.kallsyms]"),
2146 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
2147 "Show the fork/comm/exit events"),
2148 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
2149 "Show the mmap events"),
2150 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
2151 "Show context switch events (if recorded)"),
2152 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
2153 OPT_BOOLEAN(0, "ns", &nanosecs,
2154 "Use 9 decimal places when displaying time"),
2155 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
2156 "Instruction Tracing options",
2157 itrace_parse_synth_opts),
2158 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
2159 "Show full source file name path for source lines"),
2160 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
2161 "Enable symbol demangling"),
2162 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
2163 "Enable kernel symbol demangling"),
2167 const char * const script_subcommands[] = { "record", "report", NULL };
2168 const char *script_usage[] = {
2169 "perf script [<options>]",
2170 "perf script [<options>] record <script> [<record-options>] <command>",
2171 "perf script [<options>] report <script> [script-args]",
2172 "perf script [<options>] <script> [<record-options>] <command>",
2173 "perf script [<options>] <top-script> [script-args]",
2179 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
2180 PARSE_OPT_STOP_AT_NON_OPTION);
2182 file.path = input_name;
2184 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
2185 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
2186 if (!rec_script_path)
2187 return cmd_record(argc, argv, NULL);
2190 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
2191 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
2192 if (!rep_script_path) {
2194 "Please specify a valid report script"
2195 "(see 'perf script -l' for listing)\n");
2200 if (itrace_synth_opts.callchain &&
2201 itrace_synth_opts.callchain_sz > scripting_max_stack)
2202 scripting_max_stack = itrace_synth_opts.callchain_sz;
2204 /* make sure PERF_EXEC_PATH is set for scripts */
2205 set_argv_exec_path(get_argv_exec_path());
2207 if (argc && !script_name && !rec_script_path && !rep_script_path) {
2212 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
2213 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
2215 if (!rec_script_path && !rep_script_path) {
2216 usage_with_options_msg(script_usage, options,
2217 "Couldn't find script `%s'\n\n See perf"
2218 " script -l for available scripts.\n", argv[0]);
2221 if (is_top_script(argv[0])) {
2222 rep_args = argc - 1;
2226 rep_args = has_required_arg(rep_script_path);
2227 rec_args = (argc - 1) - rep_args;
2229 usage_with_options_msg(script_usage, options,
2230 "`%s' script requires options."
2231 "\n\n See perf script -l for available "
2232 "scripts and options.\n", argv[0]);
2236 if (pipe(live_pipe) < 0) {
2237 perror("failed to create pipe");
2243 perror("failed to fork");
2250 dup2(live_pipe[1], 1);
2251 close(live_pipe[0]);
2253 if (is_top_script(argv[0])) {
2255 } else if (!system_wide) {
2256 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
2262 __argv = malloc((argc + 6) * sizeof(const char *));
2264 pr_err("malloc failed\n");
2269 __argv[j++] = "/bin/sh";
2270 __argv[j++] = rec_script_path;
2276 for (i = rep_args + 1; i < argc; i++)
2277 __argv[j++] = argv[i];
2280 execvp("/bin/sh", (char **)__argv);
2285 dup2(live_pipe[0], 0);
2286 close(live_pipe[1]);
2288 __argv = malloc((argc + 4) * sizeof(const char *));
2290 pr_err("malloc failed\n");
2296 __argv[j++] = "/bin/sh";
2297 __argv[j++] = rep_script_path;
2298 for (i = 1; i < rep_args + 1; i++)
2299 __argv[j++] = argv[i];
2304 execvp("/bin/sh", (char **)__argv);
2309 if (rec_script_path)
2310 script_path = rec_script_path;
2311 if (rep_script_path)
2312 script_path = rep_script_path;
2317 if (!rec_script_path)
2318 system_wide = false;
2319 else if (!system_wide) {
2320 if (have_cmd(argc - 1, &argv[1]) != 0) {
2326 __argv = malloc((argc + 2) * sizeof(const char *));
2328 pr_err("malloc failed\n");
2333 __argv[j++] = "/bin/sh";
2334 __argv[j++] = script_path;
2337 for (i = 2; i < argc; i++)
2338 __argv[j++] = argv[i];
2341 execvp("/bin/sh", (char **)__argv);
2349 session = perf_session__new(&file, false, &script.tool);
2350 if (session == NULL)
2353 if (header || header_only) {
2354 perf_session__fprintf_info(session, stdout, show_full_info);
2359 if (symbol__init(&session->header.env) < 0)
2362 script.session = session;
2363 script__setup_sample_type(&script);
2365 if (output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT)
2366 itrace_synth_opts.thread_stack = true;
2368 session->itrace_synth_opts = &itrace_synth_opts;
2371 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
2377 symbol_conf.use_callchain = true;
2379 symbol_conf.use_callchain = false;
2381 if (session->tevent.pevent &&
2382 pevent_set_function_resolver(session->tevent.pevent,
2383 machine__resolve_kernel_addr,
2384 &session->machines.host) < 0) {
2385 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
2389 if (generate_script_lang) {
2390 struct stat perf_stat;
2393 if (output_set_by_user()) {
2395 "custom fields not supported for generated scripts");
2400 input = open(file.path, O_RDONLY); /* input_name */
2403 perror("failed to open file");
2407 err = fstat(input, &perf_stat);
2409 perror("failed to stat file");
2413 if (!perf_stat.st_size) {
2414 fprintf(stderr, "zero-sized file, nothing to do!\n");
2418 scripting_ops = script_spec__lookup(generate_script_lang);
2419 if (!scripting_ops) {
2420 fprintf(stderr, "invalid language specifier");
2425 err = scripting_ops->generate_script(session->tevent.pevent,
2431 err = scripting_ops->start_script(script_name, argc, argv);
2434 pr_debug("perf script started with script %s\n\n", script_name);
2435 script_started = true;
2439 err = perf_session__check_output_opt(session);
2443 err = __cmd_script(&script);
2448 perf_evlist__free_stats(session->evlist);
2449 perf_session__delete(session);
2452 cleanup_scripting();