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 <linux/bitmap.h>
26 #include "util/mem-events.h"
28 static char const *script_name;
29 static char const *generate_script_lang;
30 static bool debug_mode;
31 static u64 last_timestamp;
32 static u64 nr_unordered;
33 static bool no_callchain;
34 static bool latency_format;
35 static bool system_wide;
36 static bool print_flags;
38 static const char *cpu_list;
39 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
40 static struct perf_stat_config stat_config;
42 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
44 enum perf_output_field {
45 PERF_OUTPUT_COMM = 1U << 0,
46 PERF_OUTPUT_TID = 1U << 1,
47 PERF_OUTPUT_PID = 1U << 2,
48 PERF_OUTPUT_TIME = 1U << 3,
49 PERF_OUTPUT_CPU = 1U << 4,
50 PERF_OUTPUT_EVNAME = 1U << 5,
51 PERF_OUTPUT_TRACE = 1U << 6,
52 PERF_OUTPUT_IP = 1U << 7,
53 PERF_OUTPUT_SYM = 1U << 8,
54 PERF_OUTPUT_DSO = 1U << 9,
55 PERF_OUTPUT_ADDR = 1U << 10,
56 PERF_OUTPUT_SYMOFFSET = 1U << 11,
57 PERF_OUTPUT_SRCLINE = 1U << 12,
58 PERF_OUTPUT_PERIOD = 1U << 13,
59 PERF_OUTPUT_IREGS = 1U << 14,
60 PERF_OUTPUT_BRSTACK = 1U << 15,
61 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
62 PERF_OUTPUT_DATA_SRC = 1U << 17,
63 PERF_OUTPUT_WEIGHT = 1U << 18,
64 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
67 struct output_option {
69 enum perf_output_field field;
70 } all_output_options[] = {
71 {.str = "comm", .field = PERF_OUTPUT_COMM},
72 {.str = "tid", .field = PERF_OUTPUT_TID},
73 {.str = "pid", .field = PERF_OUTPUT_PID},
74 {.str = "time", .field = PERF_OUTPUT_TIME},
75 {.str = "cpu", .field = PERF_OUTPUT_CPU},
76 {.str = "event", .field = PERF_OUTPUT_EVNAME},
77 {.str = "trace", .field = PERF_OUTPUT_TRACE},
78 {.str = "ip", .field = PERF_OUTPUT_IP},
79 {.str = "sym", .field = PERF_OUTPUT_SYM},
80 {.str = "dso", .field = PERF_OUTPUT_DSO},
81 {.str = "addr", .field = PERF_OUTPUT_ADDR},
82 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
83 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
84 {.str = "period", .field = PERF_OUTPUT_PERIOD},
85 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
86 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
87 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
88 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
89 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
90 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
93 /* default set to maintain compatibility with current format */
97 unsigned int print_ip_opts;
100 } output[PERF_TYPE_MAX] = {
102 [PERF_TYPE_HARDWARE] = {
105 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
106 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
107 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
108 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
111 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
114 [PERF_TYPE_SOFTWARE] = {
117 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
118 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
119 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
120 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
121 PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
123 .invalid_fields = PERF_OUTPUT_TRACE,
126 [PERF_TYPE_TRACEPOINT] = {
129 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
130 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
131 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
137 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
138 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
139 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
140 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
141 PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR |
142 PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
144 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
147 [PERF_TYPE_BREAKPOINT] = {
150 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
151 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
152 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
153 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
156 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
160 static bool output_set_by_user(void)
163 for (j = 0; j < PERF_TYPE_MAX; ++j) {
164 if (output[j].user_set)
170 static const char *output_field2str(enum perf_output_field field)
172 int i, imax = ARRAY_SIZE(all_output_options);
173 const char *str = "";
175 for (i = 0; i < imax; ++i) {
176 if (all_output_options[i].field == field) {
177 str = all_output_options[i].str;
184 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
186 static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
187 u64 sample_type, const char *sample_msg,
188 enum perf_output_field field,
191 struct perf_event_attr *attr = &evsel->attr;
192 int type = attr->type;
195 if (attr->sample_type & sample_type)
198 if (output[type].user_set) {
201 evname = perf_evsel__name(evsel);
202 pr_err("Samples for '%s' event do not have %s attribute set. "
203 "Cannot print '%s' field.\n",
204 evname, sample_msg, output_field2str(field));
208 /* user did not ask for it explicitly so remove from the default list */
209 output[type].fields &= ~field;
210 evname = perf_evsel__name(evsel);
211 pr_debug("Samples for '%s' event do not have %s attribute set. "
212 "Skipping '%s' field.\n",
213 evname, sample_msg, output_field2str(field));
218 static int perf_evsel__check_stype(struct perf_evsel *evsel,
219 u64 sample_type, const char *sample_msg,
220 enum perf_output_field field)
222 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
226 static int perf_evsel__check_attr(struct perf_evsel *evsel,
227 struct perf_session *session)
229 struct perf_event_attr *attr = &evsel->attr;
232 if (perf_header__has_feat(&session->header, HEADER_STAT))
235 allow_user_set = perf_header__has_feat(&session->header,
238 if (PRINT_FIELD(TRACE) &&
239 !perf_session__has_traces(session, "record -R"))
242 if (PRINT_FIELD(IP)) {
243 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
248 if (PRINT_FIELD(ADDR) &&
249 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
250 PERF_OUTPUT_ADDR, allow_user_set))
253 if (PRINT_FIELD(DATA_SRC) &&
254 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
255 PERF_OUTPUT_DATA_SRC))
258 if (PRINT_FIELD(WEIGHT) &&
259 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
263 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
264 pr_err("Display of symbols requested but neither sample IP nor "
265 "sample address\nis selected. Hence, no addresses to convert "
269 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
270 pr_err("Display of offsets requested but symbol is not"
274 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
275 pr_err("Display of DSO requested but neither sample IP nor "
276 "sample address\nis selected. Hence, no addresses to convert "
280 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
281 pr_err("Display of source line number requested but sample IP is not\n"
282 "selected. Hence, no address to lookup the source line number.\n");
286 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
287 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
288 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
291 if (PRINT_FIELD(TIME) &&
292 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
296 if (PRINT_FIELD(CPU) &&
297 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
298 PERF_OUTPUT_CPU, allow_user_set))
301 if (PRINT_FIELD(PERIOD) &&
302 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
306 if (PRINT_FIELD(IREGS) &&
307 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
314 static void set_print_ip_opts(struct perf_event_attr *attr)
316 unsigned int type = attr->type;
318 output[type].print_ip_opts = 0;
320 output[type].print_ip_opts |= PRINT_IP_OPT_IP;
322 if (PRINT_FIELD(SYM))
323 output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
325 if (PRINT_FIELD(DSO))
326 output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
328 if (PRINT_FIELD(SYMOFFSET))
329 output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
331 if (PRINT_FIELD(SRCLINE))
332 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
336 * verify all user requested events exist and the samples
337 * have the expected data
339 static int perf_session__check_output_opt(struct perf_session *session)
342 struct perf_evsel *evsel;
344 for (j = 0; j < PERF_TYPE_MAX; ++j) {
345 evsel = perf_session__find_first_evtype(session, j);
348 * even if fields is set to 0 (ie., show nothing) event must
349 * exist if user explicitly includes it on the command line
351 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
352 pr_err("%s events do not exist. "
353 "Remove corresponding -f option to proceed.\n",
358 if (evsel && output[j].fields &&
359 perf_evsel__check_attr(evsel, session))
365 set_print_ip_opts(&evsel->attr);
369 bool use_callchain = false;
371 evlist__for_each(session->evlist, evsel) {
372 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
373 use_callchain = true;
378 symbol_conf.use_callchain = false;
382 * set default for tracepoints to print symbols only
383 * if callchains are present
385 if (symbol_conf.use_callchain &&
386 !output[PERF_TYPE_TRACEPOINT].user_set) {
387 struct perf_event_attr *attr;
389 j = PERF_TYPE_TRACEPOINT;
390 evsel = perf_session__find_first_evtype(session, j);
396 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
397 output[j].fields |= PERF_OUTPUT_IP;
398 output[j].fields |= PERF_OUTPUT_SYM;
399 output[j].fields |= PERF_OUTPUT_DSO;
400 set_print_ip_opts(attr);
408 static void print_sample_iregs(union perf_event *event __maybe_unused,
409 struct perf_sample *sample,
410 struct thread *thread __maybe_unused,
411 struct perf_event_attr *attr)
413 struct regs_dump *regs = &sample->intr_regs;
414 uint64_t mask = attr->sample_regs_intr;
420 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
421 u64 val = regs->regs[i++];
422 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
426 static void print_sample_start(struct perf_sample *sample,
427 struct thread *thread,
428 struct perf_evsel *evsel)
430 struct perf_event_attr *attr = &evsel->attr;
433 unsigned long long nsecs;
435 if (PRINT_FIELD(COMM)) {
437 printf("%8.8s ", thread__comm_str(thread));
438 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
439 printf("%s ", thread__comm_str(thread));
441 printf("%16s ", thread__comm_str(thread));
444 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
445 printf("%5d/%-5d ", sample->pid, sample->tid);
446 else if (PRINT_FIELD(PID))
447 printf("%5d ", sample->pid);
448 else if (PRINT_FIELD(TID))
449 printf("%5d ", sample->tid);
451 if (PRINT_FIELD(CPU)) {
453 printf("%3d ", sample->cpu);
455 printf("[%03d] ", sample->cpu);
458 if (PRINT_FIELD(TIME)) {
459 nsecs = sample->time;
460 secs = nsecs / NSECS_PER_SEC;
461 nsecs -= secs * NSECS_PER_SEC;
462 usecs = nsecs / NSECS_PER_USEC;
464 printf("%5lu.%09llu: ", secs, nsecs);
466 printf("%5lu.%06lu: ", secs, usecs);
471 mispred_str(struct branch_entry *br)
473 if (!(br->flags.mispred || br->flags.predicted))
476 return br->flags.predicted ? 'P' : 'M';
479 static void print_sample_brstack(union perf_event *event __maybe_unused,
480 struct perf_sample *sample,
481 struct thread *thread __maybe_unused,
482 struct perf_event_attr *attr __maybe_unused)
484 struct branch_stack *br = sample->branch_stack;
490 for (i = 0; i < br->nr; i++) {
491 printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
494 mispred_str( br->entries + i),
495 br->entries[i].flags.in_tx? 'X' : '-',
496 br->entries[i].flags.abort? 'A' : '-',
497 br->entries[i].flags.cycles);
501 static void print_sample_brstacksym(union perf_event *event __maybe_unused,
502 struct perf_sample *sample,
503 struct thread *thread __maybe_unused,
504 struct perf_event_attr *attr __maybe_unused)
506 struct branch_stack *br = sample->branch_stack;
507 struct addr_location alf, alt;
508 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
514 for (i = 0; i < br->nr; i++) {
516 memset(&alf, 0, sizeof(alf));
517 memset(&alt, 0, sizeof(alt));
518 from = br->entries[i].from;
519 to = br->entries[i].to;
521 thread__find_addr_map(thread, cpumode, MAP__FUNCTION, from, &alf);
523 alf.sym = map__find_symbol(alf.map, alf.addr, NULL);
525 thread__find_addr_map(thread, cpumode, MAP__FUNCTION, to, &alt);
527 alt.sym = map__find_symbol(alt.map, alt.addr, NULL);
529 symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
531 symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
532 printf("/%c/%c/%c/%d ",
533 mispred_str( br->entries + i),
534 br->entries[i].flags.in_tx? 'X' : '-',
535 br->entries[i].flags.abort? 'A' : '-',
536 br->entries[i].flags.cycles);
541 static void print_sample_addr(union perf_event *event,
542 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 perf_event__preprocess_sample_addr(event, sample, thread, &al);
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_bts(union perf_event *event,
571 struct perf_sample *sample,
572 struct perf_evsel *evsel,
573 struct thread *thread,
574 struct addr_location *al)
576 struct perf_event_attr *attr = &evsel->attr;
577 bool print_srcline_last = false;
579 /* print branch_from information */
580 if (PRINT_FIELD(IP)) {
581 unsigned int print_opts = output[attr->type].print_ip_opts;
583 if (symbol_conf.use_callchain && sample->callchain) {
587 if (print_opts & PRINT_IP_OPT_SRCLINE) {
588 print_srcline_last = true;
589 print_opts &= ~PRINT_IP_OPT_SRCLINE;
592 perf_evsel__print_ip(evsel, sample, al, print_opts,
593 scripting_max_stack);
596 /* print branch_to information */
597 if (PRINT_FIELD(ADDR) ||
598 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
599 !output[attr->type].user_set)) {
601 print_sample_addr(event, sample, thread, attr);
604 if (print_srcline_last)
605 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
610 static void print_sample_flags(u32 flags)
612 const char *chars = PERF_IP_FLAG_CHARS;
613 const int n = strlen(PERF_IP_FLAG_CHARS);
617 for (i = 0; i < n; i++, flags >>= 1) {
619 str[pos++] = chars[i];
621 for (; i < 32; i++, flags >>= 1) {
626 printf(" %-4s ", str);
629 struct printer_data {
636 print_sample_bpf_output_printer(enum binary_printer_ops op,
640 unsigned char ch = (unsigned char)val;
641 struct printer_data *printer_data = extra;
644 case BINARY_PRINT_DATA_BEGIN:
647 case BINARY_PRINT_LINE_BEGIN:
648 printf("%17s", !printer_data->line_no ? "BPF output:" :
651 case BINARY_PRINT_ADDR:
652 printf(" %04x:", val);
654 case BINARY_PRINT_NUM_DATA:
655 printf(" %02x", val);
657 case BINARY_PRINT_NUM_PAD:
660 case BINARY_PRINT_SEP:
663 case BINARY_PRINT_CHAR_DATA:
664 if (printer_data->hit_nul && ch)
665 printer_data->is_printable = false;
670 if (!printer_data->is_printable)
674 printer_data->hit_nul = true;
676 printer_data->is_printable = false;
681 case BINARY_PRINT_CHAR_PAD:
684 case BINARY_PRINT_LINE_END:
686 printer_data->line_no++;
688 case BINARY_PRINT_DATA_END:
694 static void print_sample_bpf_output(struct perf_sample *sample)
696 unsigned int nr_bytes = sample->raw_size;
697 struct printer_data printer_data = {0, false, true};
699 print_binary(sample->raw_data, nr_bytes, 8,
700 print_sample_bpf_output_printer, &printer_data);
702 if (printer_data.is_printable && printer_data.hit_nul)
703 printf("%17s \"%s\"\n", "BPF string:",
704 (char *)(sample->raw_data));
708 struct perf_tool tool;
709 struct perf_session *session;
710 bool show_task_events;
711 bool show_mmap_events;
712 bool show_switch_events;
714 struct cpu_map *cpus;
715 struct thread_map *threads;
719 static int perf_evlist__max_name_len(struct perf_evlist *evlist)
721 struct perf_evsel *evsel;
724 evlist__for_each(evlist, evsel) {
725 int len = strlen(perf_evsel__name(evsel));
733 static size_t data_src__printf(u64 data_src)
735 struct mem_info mi = { .data_src.val = data_src };
741 perf_script__meminfo_scnprintf(decode, 100, &mi);
743 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
747 return printf("%-*s", maxlen, out);
750 static void process_event(struct perf_script *script, union perf_event *event,
751 struct perf_sample *sample, struct perf_evsel *evsel,
752 struct addr_location *al)
754 struct thread *thread = al->thread;
755 struct perf_event_attr *attr = &evsel->attr;
757 if (output[attr->type].fields == 0)
760 print_sample_start(sample, thread, evsel);
762 if (PRINT_FIELD(PERIOD))
763 printf("%10" PRIu64 " ", sample->period);
765 if (PRINT_FIELD(EVNAME)) {
766 const char *evname = perf_evsel__name(evsel);
768 if (!script->name_width)
769 script->name_width = perf_evlist__max_name_len(script->session->evlist);
771 printf("%*s: ", script->name_width,
772 evname ? evname : "[unknown]");
776 print_sample_flags(sample->flags);
778 if (is_bts_event(attr)) {
779 print_sample_bts(event, sample, evsel, thread, al);
783 if (PRINT_FIELD(TRACE))
784 event_format__print(evsel->tp_format, sample->cpu,
785 sample->raw_data, sample->raw_size);
786 if (PRINT_FIELD(ADDR))
787 print_sample_addr(event, sample, thread, attr);
789 if (PRINT_FIELD(DATA_SRC))
790 data_src__printf(sample->data_src);
792 if (PRINT_FIELD(WEIGHT))
793 printf("%16" PRIu64, sample->weight);
795 if (PRINT_FIELD(IP)) {
796 if (!symbol_conf.use_callchain)
801 perf_evsel__print_ip(evsel, sample, al,
802 output[attr->type].print_ip_opts,
803 scripting_max_stack);
806 if (PRINT_FIELD(IREGS))
807 print_sample_iregs(event, sample, thread, attr);
809 if (PRINT_FIELD(BRSTACK))
810 print_sample_brstack(event, sample, thread, attr);
811 else if (PRINT_FIELD(BRSTACKSYM))
812 print_sample_brstacksym(event, sample, thread, attr);
814 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
815 print_sample_bpf_output(sample);
820 static struct scripting_ops *scripting_ops;
822 static void __process_stat(struct perf_evsel *counter, u64 tstamp)
824 int nthreads = thread_map__nr(counter->threads);
825 int ncpus = perf_evsel__nr_cpus(counter);
827 static int header_printed;
829 if (counter->system_wide)
832 if (!header_printed) {
833 printf("%3s %8s %15s %15s %15s %15s %s\n",
834 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
838 for (thread = 0; thread < nthreads; thread++) {
839 for (cpu = 0; cpu < ncpus; cpu++) {
840 struct perf_counts_values *counts;
842 counts = perf_counts(counter->counts, cpu, thread);
844 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
845 counter->cpus->map[cpu],
846 thread_map__pid(counter->threads, thread),
851 perf_evsel__name(counter));
856 static void process_stat(struct perf_evsel *counter, u64 tstamp)
858 if (scripting_ops && scripting_ops->process_stat)
859 scripting_ops->process_stat(&stat_config, counter, tstamp);
861 __process_stat(counter, tstamp);
864 static void process_stat_interval(u64 tstamp)
866 if (scripting_ops && scripting_ops->process_stat_interval)
867 scripting_ops->process_stat_interval(tstamp);
870 static void setup_scripting(void)
872 setup_perl_scripting();
873 setup_python_scripting();
876 static int flush_scripting(void)
878 return scripting_ops ? scripting_ops->flush_script() : 0;
881 static int cleanup_scripting(void)
883 pr_debug("\nperf script stopped\n");
885 return scripting_ops ? scripting_ops->stop_script() : 0;
888 static int process_sample_event(struct perf_tool *tool,
889 union perf_event *event,
890 struct perf_sample *sample,
891 struct perf_evsel *evsel,
892 struct machine *machine)
894 struct perf_script *scr = container_of(tool, struct perf_script, tool);
895 struct addr_location al;
898 if (sample->time < last_timestamp) {
899 pr_err("Samples misordered, previous: %" PRIu64
900 " this: %" PRIu64 "\n", last_timestamp,
904 last_timestamp = sample->time;
908 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
909 pr_err("problem processing %d event, skipping it.\n",
917 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
921 scripting_ops->process_event(event, sample, evsel, &al);
923 process_event(scr, event, sample, evsel, &al);
926 addr_location__put(&al);
930 static int process_attr(struct perf_tool *tool, union perf_event *event,
931 struct perf_evlist **pevlist)
933 struct perf_script *scr = container_of(tool, struct perf_script, tool);
934 struct perf_evlist *evlist;
935 struct perf_evsel *evsel, *pos;
938 err = perf_event__process_attr(tool, event, pevlist);
943 evsel = perf_evlist__last(*pevlist);
945 if (evsel->attr.type >= PERF_TYPE_MAX)
948 evlist__for_each(evlist, pos) {
949 if (pos->attr.type == evsel->attr.type && pos != evsel)
953 set_print_ip_opts(&evsel->attr);
955 if (evsel->attr.sample_type)
956 err = perf_evsel__check_attr(evsel, scr->session);
961 static int process_comm_event(struct perf_tool *tool,
962 union perf_event *event,
963 struct perf_sample *sample,
964 struct machine *machine)
966 struct thread *thread;
967 struct perf_script *script = container_of(tool, struct perf_script, tool);
968 struct perf_session *session = script->session;
969 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
972 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
973 if (thread == NULL) {
974 pr_debug("problem processing COMM event, skipping it.\n");
978 if (perf_event__process_comm(tool, event, sample, machine) < 0)
981 if (!evsel->attr.sample_id_all) {
984 sample->tid = event->comm.tid;
985 sample->pid = event->comm.pid;
987 print_sample_start(sample, thread, evsel);
988 perf_event__fprintf(event, stdout);
995 static int process_fork_event(struct perf_tool *tool,
996 union perf_event *event,
997 struct perf_sample *sample,
998 struct machine *machine)
1000 struct thread *thread;
1001 struct perf_script *script = container_of(tool, struct perf_script, tool);
1002 struct perf_session *session = script->session;
1003 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1005 if (perf_event__process_fork(tool, event, sample, machine) < 0)
1008 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1009 if (thread == NULL) {
1010 pr_debug("problem processing FORK event, skipping it.\n");
1014 if (!evsel->attr.sample_id_all) {
1016 sample->time = event->fork.time;
1017 sample->tid = event->fork.tid;
1018 sample->pid = event->fork.pid;
1020 print_sample_start(sample, thread, evsel);
1021 perf_event__fprintf(event, stdout);
1022 thread__put(thread);
1026 static int process_exit_event(struct perf_tool *tool,
1027 union perf_event *event,
1028 struct perf_sample *sample,
1029 struct machine *machine)
1032 struct thread *thread;
1033 struct perf_script *script = container_of(tool, struct perf_script, tool);
1034 struct perf_session *session = script->session;
1035 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1037 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1038 if (thread == NULL) {
1039 pr_debug("problem processing EXIT event, skipping it.\n");
1043 if (!evsel->attr.sample_id_all) {
1046 sample->tid = event->fork.tid;
1047 sample->pid = event->fork.pid;
1049 print_sample_start(sample, thread, evsel);
1050 perf_event__fprintf(event, stdout);
1052 if (perf_event__process_exit(tool, event, sample, machine) < 0)
1055 thread__put(thread);
1059 static int process_mmap_event(struct perf_tool *tool,
1060 union perf_event *event,
1061 struct perf_sample *sample,
1062 struct machine *machine)
1064 struct thread *thread;
1065 struct perf_script *script = container_of(tool, struct perf_script, tool);
1066 struct perf_session *session = script->session;
1067 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1069 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
1072 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
1073 if (thread == NULL) {
1074 pr_debug("problem processing MMAP event, skipping it.\n");
1078 if (!evsel->attr.sample_id_all) {
1081 sample->tid = event->mmap.tid;
1082 sample->pid = event->mmap.pid;
1084 print_sample_start(sample, thread, evsel);
1085 perf_event__fprintf(event, stdout);
1086 thread__put(thread);
1090 static int process_mmap2_event(struct perf_tool *tool,
1091 union perf_event *event,
1092 struct perf_sample *sample,
1093 struct machine *machine)
1095 struct thread *thread;
1096 struct perf_script *script = container_of(tool, struct perf_script, tool);
1097 struct perf_session *session = script->session;
1098 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1100 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
1103 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
1104 if (thread == NULL) {
1105 pr_debug("problem processing MMAP2 event, skipping it.\n");
1109 if (!evsel->attr.sample_id_all) {
1112 sample->tid = event->mmap2.tid;
1113 sample->pid = event->mmap2.pid;
1115 print_sample_start(sample, thread, evsel);
1116 perf_event__fprintf(event, stdout);
1117 thread__put(thread);
1121 static int process_switch_event(struct perf_tool *tool,
1122 union perf_event *event,
1123 struct perf_sample *sample,
1124 struct machine *machine)
1126 struct thread *thread;
1127 struct perf_script *script = container_of(tool, struct perf_script, tool);
1128 struct perf_session *session = script->session;
1129 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1131 if (perf_event__process_switch(tool, event, sample, machine) < 0)
1134 thread = machine__findnew_thread(machine, sample->pid,
1136 if (thread == NULL) {
1137 pr_debug("problem processing SWITCH event, skipping it.\n");
1141 print_sample_start(sample, thread, evsel);
1142 perf_event__fprintf(event, stdout);
1143 thread__put(thread);
1147 static void sig_handler(int sig __maybe_unused)
1152 static int __cmd_script(struct perf_script *script)
1156 signal(SIGINT, sig_handler);
1158 /* override event processing functions */
1159 if (script->show_task_events) {
1160 script->tool.comm = process_comm_event;
1161 script->tool.fork = process_fork_event;
1162 script->tool.exit = process_exit_event;
1164 if (script->show_mmap_events) {
1165 script->tool.mmap = process_mmap_event;
1166 script->tool.mmap2 = process_mmap2_event;
1168 if (script->show_switch_events)
1169 script->tool.context_switch = process_switch_event;
1171 ret = perf_session__process_events(script->session);
1174 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1179 struct script_spec {
1180 struct list_head node;
1181 struct scripting_ops *ops;
1185 static LIST_HEAD(script_specs);
1187 static struct script_spec *script_spec__new(const char *spec,
1188 struct scripting_ops *ops)
1190 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
1193 strcpy(s->spec, spec);
1200 static void script_spec__add(struct script_spec *s)
1202 list_add_tail(&s->node, &script_specs);
1205 static struct script_spec *script_spec__find(const char *spec)
1207 struct script_spec *s;
1209 list_for_each_entry(s, &script_specs, node)
1210 if (strcasecmp(s->spec, spec) == 0)
1215 int script_spec_register(const char *spec, struct scripting_ops *ops)
1217 struct script_spec *s;
1219 s = script_spec__find(spec);
1223 s = script_spec__new(spec, ops);
1227 script_spec__add(s);
1232 static struct scripting_ops *script_spec__lookup(const char *spec)
1234 struct script_spec *s = script_spec__find(spec);
1241 static void list_available_languages(void)
1243 struct script_spec *s;
1245 fprintf(stderr, "\n");
1246 fprintf(stderr, "Scripting language extensions (used in "
1247 "perf script -s [spec:]script.[spec]):\n\n");
1249 list_for_each_entry(s, &script_specs, node)
1250 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
1252 fprintf(stderr, "\n");
1255 static int parse_scriptname(const struct option *opt __maybe_unused,
1256 const char *str, int unset __maybe_unused)
1258 char spec[PATH_MAX];
1259 const char *script, *ext;
1262 if (strcmp(str, "lang") == 0) {
1263 list_available_languages();
1267 script = strchr(str, ':');
1270 if (len >= PATH_MAX) {
1271 fprintf(stderr, "invalid language specifier");
1274 strncpy(spec, str, len);
1276 scripting_ops = script_spec__lookup(spec);
1277 if (!scripting_ops) {
1278 fprintf(stderr, "invalid language specifier");
1284 ext = strrchr(script, '.');
1286 fprintf(stderr, "invalid script extension");
1289 scripting_ops = script_spec__lookup(++ext);
1290 if (!scripting_ops) {
1291 fprintf(stderr, "invalid script extension");
1296 script_name = strdup(script);
1301 static int parse_output_fields(const struct option *opt __maybe_unused,
1302 const char *arg, int unset __maybe_unused)
1305 int i, imax = ARRAY_SIZE(all_output_options);
1308 char *str = strdup(arg);
1314 /* first word can state for which event type the user is specifying
1315 * the fields. If no type exists, the specified fields apply to all
1316 * event types found in the file minus the invalid fields for a type.
1318 tok = strchr(str, ':');
1322 if (!strcmp(str, "hw"))
1323 type = PERF_TYPE_HARDWARE;
1324 else if (!strcmp(str, "sw"))
1325 type = PERF_TYPE_SOFTWARE;
1326 else if (!strcmp(str, "trace"))
1327 type = PERF_TYPE_TRACEPOINT;
1328 else if (!strcmp(str, "raw"))
1329 type = PERF_TYPE_RAW;
1330 else if (!strcmp(str, "break"))
1331 type = PERF_TYPE_BREAKPOINT;
1333 fprintf(stderr, "Invalid event type in field string.\n");
1338 if (output[type].user_set)
1339 pr_warning("Overriding previous field request for %s events.\n",
1342 output[type].fields = 0;
1343 output[type].user_set = true;
1344 output[type].wildcard_set = false;
1348 if (strlen(str) == 0) {
1350 "Cannot set fields to 'none' for all event types.\n");
1355 if (output_set_by_user())
1356 pr_warning("Overriding previous field request for all events.\n");
1358 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1359 output[j].fields = 0;
1360 output[j].user_set = true;
1361 output[j].wildcard_set = true;
1365 for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
1366 for (i = 0; i < imax; ++i) {
1367 if (strcmp(tok, all_output_options[i].str) == 0)
1370 if (i == imax && strcmp(tok, "flags") == 0) {
1375 fprintf(stderr, "Invalid field requested.\n");
1381 /* add user option to all events types for
1384 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1385 if (output[j].invalid_fields & all_output_options[i].field) {
1386 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1387 all_output_options[i].str, event_type(j));
1389 output[j].fields |= all_output_options[i].field;
1392 if (output[type].invalid_fields & all_output_options[i].field) {
1393 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1394 all_output_options[i].str, event_type(type));
1399 output[type].fields |= all_output_options[i].field;
1404 if (output[type].fields == 0) {
1405 pr_debug("No fields requested for %s type. "
1406 "Events will not be displayed.\n", event_type(type));
1415 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1416 static int is_directory(const char *base_path, const struct dirent *dent)
1418 char path[PATH_MAX];
1421 sprintf(path, "%s/%s", base_path, dent->d_name);
1422 if (stat(path, &st))
1425 return S_ISDIR(st.st_mode);
1428 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
1429 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
1431 if ((lang_dirent.d_type == DT_DIR || \
1432 (lang_dirent.d_type == DT_UNKNOWN && \
1433 is_directory(scripts_path, &lang_dirent))) && \
1434 (strcmp(lang_dirent.d_name, ".")) && \
1435 (strcmp(lang_dirent.d_name, "..")))
1437 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1438 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
1440 if (script_dirent.d_type != DT_DIR && \
1441 (script_dirent.d_type != DT_UNKNOWN || \
1442 !is_directory(lang_path, &script_dirent)))
1445 #define RECORD_SUFFIX "-record"
1446 #define REPORT_SUFFIX "-report"
1448 struct script_desc {
1449 struct list_head node;
1455 static LIST_HEAD(script_descs);
1457 static struct script_desc *script_desc__new(const char *name)
1459 struct script_desc *s = zalloc(sizeof(*s));
1461 if (s != NULL && name)
1462 s->name = strdup(name);
1467 static void script_desc__delete(struct script_desc *s)
1470 zfree(&s->half_liner);
1475 static void script_desc__add(struct script_desc *s)
1477 list_add_tail(&s->node, &script_descs);
1480 static struct script_desc *script_desc__find(const char *name)
1482 struct script_desc *s;
1484 list_for_each_entry(s, &script_descs, node)
1485 if (strcasecmp(s->name, name) == 0)
1490 static struct script_desc *script_desc__findnew(const char *name)
1492 struct script_desc *s = script_desc__find(name);
1497 s = script_desc__new(name);
1499 goto out_delete_desc;
1501 script_desc__add(s);
1506 script_desc__delete(s);
1511 static const char *ends_with(const char *str, const char *suffix)
1513 size_t suffix_len = strlen(suffix);
1514 const char *p = str;
1516 if (strlen(str) > suffix_len) {
1517 p = str + strlen(str) - suffix_len;
1518 if (!strncmp(p, suffix, suffix_len))
1525 static int read_script_info(struct script_desc *desc, const char *filename)
1527 char line[BUFSIZ], *p;
1530 fp = fopen(filename, "r");
1534 while (fgets(line, sizeof(line), fp)) {
1541 if (strlen(p) && *p == '!')
1545 if (strlen(p) && p[strlen(p) - 1] == '\n')
1546 p[strlen(p) - 1] = '\0';
1548 if (!strncmp(p, "description:", strlen("description:"))) {
1549 p += strlen("description:");
1550 desc->half_liner = strdup(ltrim(p));
1554 if (!strncmp(p, "args:", strlen("args:"))) {
1555 p += strlen("args:");
1556 desc->args = strdup(ltrim(p));
1566 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1568 char *script_root, *str;
1570 script_root = strdup(script_dirent->d_name);
1574 str = (char *)ends_with(script_root, suffix);
1584 static int list_available_scripts(const struct option *opt __maybe_unused,
1585 const char *s __maybe_unused,
1586 int unset __maybe_unused)
1588 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1589 char scripts_path[MAXPATHLEN];
1590 DIR *scripts_dir, *lang_dir;
1591 char script_path[MAXPATHLEN];
1592 char lang_path[MAXPATHLEN];
1593 struct script_desc *desc;
1594 char first_half[BUFSIZ];
1597 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1599 scripts_dir = opendir(scripts_path);
1603 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1604 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1605 lang_dirent.d_name);
1606 lang_dir = opendir(lang_path);
1610 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1611 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1613 desc = script_desc__findnew(script_root);
1614 snprintf(script_path, MAXPATHLEN, "%s/%s",
1615 lang_path, script_dirent.d_name);
1616 read_script_info(desc, script_path);
1622 fprintf(stdout, "List of available trace scripts:\n");
1623 list_for_each_entry(desc, &script_descs, node) {
1624 sprintf(first_half, "%s %s", desc->name,
1625 desc->args ? desc->args : "");
1626 fprintf(stdout, " %-36s %s\n", first_half,
1627 desc->half_liner ? desc->half_liner : "");
1634 * Some scripts specify the required events in their "xxx-record" file,
1635 * this function will check if the events in perf.data match those
1636 * mentioned in the "xxx-record".
1638 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1639 * which is covered well now. And new parsing code should be added to
1640 * cover the future complexing formats like event groups etc.
1642 static int check_ev_match(char *dir_name, char *scriptname,
1643 struct perf_session *session)
1645 char filename[MAXPATHLEN], evname[128];
1646 char line[BUFSIZ], *p;
1647 struct perf_evsel *pos;
1651 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1653 fp = fopen(filename, "r");
1657 while (fgets(line, sizeof(line), fp)) {
1663 p = strstr(p, "-e");
1669 len = strcspn(p, " \t");
1673 snprintf(evname, len + 1, "%s", p);
1676 evlist__for_each(session->evlist, pos) {
1677 if (!strcmp(perf_evsel__name(pos), evname)) {
1695 * Return -1 if none is found, otherwise the actual scripts number.
1697 * Currently the only user of this function is the script browser, which
1698 * will list all statically runnable scripts, select one, execute it and
1699 * show the output in a perf browser.
1701 int find_scripts(char **scripts_array, char **scripts_path_array)
1703 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1704 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1705 DIR *scripts_dir, *lang_dir;
1706 struct perf_session *session;
1707 struct perf_data_file file = {
1709 .mode = PERF_DATA_MODE_READ,
1714 session = perf_session__new(&file, false, NULL);
1718 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1720 scripts_dir = opendir(scripts_path);
1722 perf_session__delete(session);
1726 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1727 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1728 lang_dirent.d_name);
1730 if (strstr(lang_path, "perl"))
1734 if (strstr(lang_path, "python"))
1738 lang_dir = opendir(lang_path);
1742 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1743 /* Skip those real time scripts: xxxtop.p[yl] */
1744 if (strstr(script_dirent.d_name, "top."))
1746 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1747 script_dirent.d_name);
1748 temp = strchr(script_dirent.d_name, '.');
1749 snprintf(scripts_array[i],
1750 (temp - script_dirent.d_name) + 1,
1751 "%s", script_dirent.d_name);
1753 if (check_ev_match(lang_path,
1754 scripts_array[i], session))
1762 closedir(scripts_dir);
1763 perf_session__delete(session);
1767 static char *get_script_path(const char *script_root, const char *suffix)
1769 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1770 char scripts_path[MAXPATHLEN];
1771 char script_path[MAXPATHLEN];
1772 DIR *scripts_dir, *lang_dir;
1773 char lang_path[MAXPATHLEN];
1774 char *__script_root;
1776 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1778 scripts_dir = opendir(scripts_path);
1782 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1783 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1784 lang_dirent.d_name);
1785 lang_dir = opendir(lang_path);
1789 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1790 __script_root = get_script_root(&script_dirent, suffix);
1791 if (__script_root && !strcmp(script_root, __script_root)) {
1792 free(__script_root);
1794 closedir(scripts_dir);
1795 snprintf(script_path, MAXPATHLEN, "%s/%s",
1796 lang_path, script_dirent.d_name);
1797 return strdup(script_path);
1799 free(__script_root);
1803 closedir(scripts_dir);
1808 static bool is_top_script(const char *script_path)
1810 return ends_with(script_path, "top") == NULL ? false : true;
1813 static int has_required_arg(char *script_path)
1815 struct script_desc *desc;
1819 desc = script_desc__new(NULL);
1821 if (read_script_info(desc, script_path))
1827 for (p = desc->args; *p; p++)
1831 script_desc__delete(desc);
1836 static int have_cmd(int argc, const char **argv)
1838 char **__argv = malloc(sizeof(const char *) * argc);
1841 pr_err("malloc failed\n");
1845 memcpy(__argv, argv, sizeof(const char *) * argc);
1846 argc = parse_options(argc, (const char **)__argv, record_options,
1847 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1850 system_wide = (argc == 0);
1855 static void script__setup_sample_type(struct perf_script *script)
1857 struct perf_session *session = script->session;
1858 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
1860 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
1861 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
1862 (sample_type & PERF_SAMPLE_STACK_USER))
1863 callchain_param.record_mode = CALLCHAIN_DWARF;
1864 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
1865 callchain_param.record_mode = CALLCHAIN_LBR;
1867 callchain_param.record_mode = CALLCHAIN_FP;
1871 static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
1872 union perf_event *event,
1873 struct perf_session *session)
1875 struct stat_round_event *round = &event->stat_round;
1876 struct perf_evsel *counter;
1878 evlist__for_each(session->evlist, counter) {
1879 perf_stat_process_counter(&stat_config, counter);
1880 process_stat(counter, round->time);
1883 process_stat_interval(round->time);
1887 static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
1888 union perf_event *event,
1889 struct perf_session *session __maybe_unused)
1891 perf_event__read_stat_config(&stat_config, &event->stat_config);
1895 static int set_maps(struct perf_script *script)
1897 struct perf_evlist *evlist = script->session->evlist;
1899 if (!script->cpus || !script->threads)
1902 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
1905 perf_evlist__set_maps(evlist, script->cpus, script->threads);
1907 if (perf_evlist__alloc_stats(evlist, true))
1910 script->allocated = true;
1915 int process_thread_map_event(struct perf_tool *tool,
1916 union perf_event *event,
1917 struct perf_session *session __maybe_unused)
1919 struct perf_script *script = container_of(tool, struct perf_script, tool);
1921 if (script->threads) {
1922 pr_warning("Extra thread map event, ignoring.\n");
1926 script->threads = thread_map__new_event(&event->thread_map);
1927 if (!script->threads)
1930 return set_maps(script);
1934 int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
1935 union perf_event *event,
1936 struct perf_session *session __maybe_unused)
1938 struct perf_script *script = container_of(tool, struct perf_script, tool);
1941 pr_warning("Extra cpu map event, ignoring.\n");
1945 script->cpus = cpu_map__new_data(&event->cpu_map.data);
1949 return set_maps(script);
1952 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1954 bool show_full_info = false;
1955 bool header = false;
1956 bool header_only = false;
1957 bool script_started = false;
1958 char *rec_script_path = NULL;
1959 char *rep_script_path = NULL;
1960 struct perf_session *session;
1961 struct itrace_synth_opts itrace_synth_opts = { .set = false, };
1962 char *script_path = NULL;
1963 const char **__argv;
1965 struct perf_script script = {
1967 .sample = process_sample_event,
1968 .mmap = perf_event__process_mmap,
1969 .mmap2 = perf_event__process_mmap2,
1970 .comm = perf_event__process_comm,
1971 .exit = perf_event__process_exit,
1972 .fork = perf_event__process_fork,
1973 .attr = process_attr,
1974 .tracing_data = perf_event__process_tracing_data,
1975 .build_id = perf_event__process_build_id,
1976 .id_index = perf_event__process_id_index,
1977 .auxtrace_info = perf_event__process_auxtrace_info,
1978 .auxtrace = perf_event__process_auxtrace,
1979 .auxtrace_error = perf_event__process_auxtrace_error,
1980 .stat = perf_event__process_stat_event,
1981 .stat_round = process_stat_round_event,
1982 .stat_config = process_stat_config_event,
1983 .thread_map = process_thread_map_event,
1984 .cpu_map = process_cpu_map_event,
1985 .ordered_events = true,
1986 .ordering_requires_timestamps = true,
1989 struct perf_data_file file = {
1990 .mode = PERF_DATA_MODE_READ,
1992 const struct option options[] = {
1993 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1994 "dump raw trace in ASCII"),
1995 OPT_INCR('v', "verbose", &verbose,
1996 "be more verbose (show symbol address, etc)"),
1997 OPT_BOOLEAN('L', "Latency", &latency_format,
1998 "show latency attributes (irqs/preemption disabled, etc)"),
1999 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
2000 list_available_scripts),
2001 OPT_CALLBACK('s', "script", NULL, "name",
2002 "script file name (lang:script name, script name, or *)",
2004 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
2005 "generate perf-script.xx script in specified language"),
2006 OPT_STRING('i', "input", &input_name, "file", "input file name"),
2007 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
2008 "do various checks like samples ordering and lost events"),
2009 OPT_BOOLEAN(0, "header", &header, "Show data header."),
2010 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
2011 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2012 "file", "vmlinux pathname"),
2013 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
2014 "file", "kallsyms pathname"),
2015 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
2016 "When printing symbols do not display call chain"),
2017 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
2018 "Look for files with symbols relative to this directory"),
2019 OPT_CALLBACK('F', "fields", NULL, "str",
2020 "comma separated output fields prepend with 'type:'. "
2021 "Valid types: hw,sw,trace,raw. "
2022 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2023 "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields),
2024 OPT_BOOLEAN('a', "all-cpus", &system_wide,
2025 "system-wide collection from all CPUs"),
2026 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
2027 "only consider these symbols"),
2028 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
2029 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
2030 "only display events for these comms"),
2031 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
2032 "only consider symbols in these pids"),
2033 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
2034 "only consider symbols in these tids"),
2035 OPT_BOOLEAN('I', "show-info", &show_full_info,
2036 "display extended information from perf.data file"),
2037 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
2038 "Show the path of [kernel.kallsyms]"),
2039 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
2040 "Show the fork/comm/exit events"),
2041 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
2042 "Show the mmap events"),
2043 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
2044 "Show context switch events (if recorded)"),
2045 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
2046 OPT_BOOLEAN(0, "ns", &nanosecs,
2047 "Use 9 decimal places when displaying time"),
2048 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
2049 "Instruction Tracing options",
2050 itrace_parse_synth_opts),
2051 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
2052 "Show full source file name path for source lines"),
2053 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
2054 "Enable symbol demangling"),
2055 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
2056 "Enable kernel symbol demangling"),
2060 const char * const script_subcommands[] = { "record", "report", NULL };
2061 const char *script_usage[] = {
2062 "perf script [<options>]",
2063 "perf script [<options>] record <script> [<record-options>] <command>",
2064 "perf script [<options>] report <script> [script-args]",
2065 "perf script [<options>] <script> [<record-options>] <command>",
2066 "perf script [<options>] <top-script> [script-args]",
2072 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
2073 PARSE_OPT_STOP_AT_NON_OPTION);
2075 file.path = input_name;
2077 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
2078 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
2079 if (!rec_script_path)
2080 return cmd_record(argc, argv, NULL);
2083 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
2084 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
2085 if (!rep_script_path) {
2087 "Please specify a valid report script"
2088 "(see 'perf script -l' for listing)\n");
2093 if (itrace_synth_opts.callchain &&
2094 itrace_synth_opts.callchain_sz > scripting_max_stack)
2095 scripting_max_stack = itrace_synth_opts.callchain_sz;
2097 /* make sure PERF_EXEC_PATH is set for scripts */
2098 set_argv_exec_path(get_argv_exec_path());
2100 if (argc && !script_name && !rec_script_path && !rep_script_path) {
2105 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
2106 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
2108 if (!rec_script_path && !rep_script_path) {
2109 usage_with_options_msg(script_usage, options,
2110 "Couldn't find script `%s'\n\n See perf"
2111 " script -l for available scripts.\n", argv[0]);
2114 if (is_top_script(argv[0])) {
2115 rep_args = argc - 1;
2119 rep_args = has_required_arg(rep_script_path);
2120 rec_args = (argc - 1) - rep_args;
2122 usage_with_options_msg(script_usage, options,
2123 "`%s' script requires options."
2124 "\n\n See perf script -l for available "
2125 "scripts and options.\n", argv[0]);
2129 if (pipe(live_pipe) < 0) {
2130 perror("failed to create pipe");
2136 perror("failed to fork");
2143 dup2(live_pipe[1], 1);
2144 close(live_pipe[0]);
2146 if (is_top_script(argv[0])) {
2148 } else if (!system_wide) {
2149 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
2155 __argv = malloc((argc + 6) * sizeof(const char *));
2157 pr_err("malloc failed\n");
2162 __argv[j++] = "/bin/sh";
2163 __argv[j++] = rec_script_path;
2169 for (i = rep_args + 1; i < argc; i++)
2170 __argv[j++] = argv[i];
2173 execvp("/bin/sh", (char **)__argv);
2178 dup2(live_pipe[0], 0);
2179 close(live_pipe[1]);
2181 __argv = malloc((argc + 4) * sizeof(const char *));
2183 pr_err("malloc failed\n");
2189 __argv[j++] = "/bin/sh";
2190 __argv[j++] = rep_script_path;
2191 for (i = 1; i < rep_args + 1; i++)
2192 __argv[j++] = argv[i];
2197 execvp("/bin/sh", (char **)__argv);
2202 if (rec_script_path)
2203 script_path = rec_script_path;
2204 if (rep_script_path)
2205 script_path = rep_script_path;
2210 if (!rec_script_path)
2211 system_wide = false;
2212 else if (!system_wide) {
2213 if (have_cmd(argc - 1, &argv[1]) != 0) {
2219 __argv = malloc((argc + 2) * sizeof(const char *));
2221 pr_err("malloc failed\n");
2226 __argv[j++] = "/bin/sh";
2227 __argv[j++] = script_path;
2230 for (i = 2; i < argc; i++)
2231 __argv[j++] = argv[i];
2234 execvp("/bin/sh", (char **)__argv);
2242 session = perf_session__new(&file, false, &script.tool);
2243 if (session == NULL)
2246 if (header || header_only) {
2247 perf_session__fprintf_info(session, stdout, show_full_info);
2252 if (symbol__init(&session->header.env) < 0)
2255 script.session = session;
2256 script__setup_sample_type(&script);
2258 session->itrace_synth_opts = &itrace_synth_opts;
2261 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
2267 symbol_conf.use_callchain = true;
2269 symbol_conf.use_callchain = false;
2271 if (session->tevent.pevent &&
2272 pevent_set_function_resolver(session->tevent.pevent,
2273 machine__resolve_kernel_addr,
2274 &session->machines.host) < 0) {
2275 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
2279 if (generate_script_lang) {
2280 struct stat perf_stat;
2283 if (output_set_by_user()) {
2285 "custom fields not supported for generated scripts");
2290 input = open(file.path, O_RDONLY); /* input_name */
2293 perror("failed to open file");
2297 err = fstat(input, &perf_stat);
2299 perror("failed to stat file");
2303 if (!perf_stat.st_size) {
2304 fprintf(stderr, "zero-sized file, nothing to do!\n");
2308 scripting_ops = script_spec__lookup(generate_script_lang);
2309 if (!scripting_ops) {
2310 fprintf(stderr, "invalid language specifier");
2315 err = scripting_ops->generate_script(session->tevent.pevent,
2321 err = scripting_ops->start_script(script_name, argc, argv);
2324 pr_debug("perf script started with script %s\n\n", script_name);
2325 script_started = true;
2329 err = perf_session__check_output_opt(session);
2333 err = __cmd_script(&script);
2338 perf_evlist__free_stats(session->evlist);
2339 perf_session__delete(session);
2342 cleanup_scripting();