1 // SPDX-License-Identifier: GPL-2.0
4 #include "util/counts.h"
5 #include "util/debug.h"
7 #include <subcmd/exec-cmd.h>
8 #include "util/header.h"
9 #include <subcmd/parse-options.h>
10 #include "util/perf_regs.h"
11 #include "util/session.h"
12 #include "util/tool.h"
14 #include "util/srcline.h"
15 #include "util/symbol.h"
16 #include "util/thread.h"
17 #include "util/trace-event.h"
18 #include "util/evlist.h"
19 #include "util/evsel.h"
20 #include "util/evsel_fprintf.h"
21 #include "util/evswitch.h"
22 #include "util/sort.h"
23 #include "util/data.h"
24 #include "util/auxtrace.h"
25 #include "util/cpumap.h"
26 #include "util/thread_map.h"
27 #include "util/stat.h"
28 #include "util/color.h"
29 #include "util/string2.h"
30 #include "util/thread-stack.h"
31 #include "util/time-utils.h"
32 #include "util/path.h"
33 #include "util/event.h"
35 #include "print_binary.h"
37 #include <linux/bitmap.h>
38 #include <linux/kernel.h>
39 #include <linux/stringify.h>
40 #include <linux/time64.h>
41 #include <linux/zalloc.h>
42 #include <sys/utsname.h>
44 #include "util/mem-events.h"
45 #include "util/dump-insn.h"
50 #include <sys/param.h>
51 #include <sys/types.h>
55 #include <subcmd/pager.h>
56 #include <perf/evlist.h>
57 #include <linux/err.h>
58 #include "util/record.h"
59 #include "util/util.h"
62 #include <linux/ctype.h>
64 static char const *script_name;
65 static char const *generate_script_lang;
67 static bool deltatime;
68 static u64 initial_time;
69 static u64 previous_time;
70 static bool debug_mode;
71 static u64 last_timestamp;
72 static u64 nr_unordered;
73 static bool no_callchain;
74 static bool latency_format;
75 static bool system_wide;
76 static bool print_flags;
77 static const char *cpu_list;
78 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
79 static struct perf_stat_config stat_config;
80 static int max_blocks;
81 static bool native_arch;
83 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
85 enum perf_output_field {
86 PERF_OUTPUT_COMM = 1ULL << 0,
87 PERF_OUTPUT_TID = 1ULL << 1,
88 PERF_OUTPUT_PID = 1ULL << 2,
89 PERF_OUTPUT_TIME = 1ULL << 3,
90 PERF_OUTPUT_CPU = 1ULL << 4,
91 PERF_OUTPUT_EVNAME = 1ULL << 5,
92 PERF_OUTPUT_TRACE = 1ULL << 6,
93 PERF_OUTPUT_IP = 1ULL << 7,
94 PERF_OUTPUT_SYM = 1ULL << 8,
95 PERF_OUTPUT_DSO = 1ULL << 9,
96 PERF_OUTPUT_ADDR = 1ULL << 10,
97 PERF_OUTPUT_SYMOFFSET = 1ULL << 11,
98 PERF_OUTPUT_SRCLINE = 1ULL << 12,
99 PERF_OUTPUT_PERIOD = 1ULL << 13,
100 PERF_OUTPUT_IREGS = 1ULL << 14,
101 PERF_OUTPUT_BRSTACK = 1ULL << 15,
102 PERF_OUTPUT_BRSTACKSYM = 1ULL << 16,
103 PERF_OUTPUT_DATA_SRC = 1ULL << 17,
104 PERF_OUTPUT_WEIGHT = 1ULL << 18,
105 PERF_OUTPUT_BPF_OUTPUT = 1ULL << 19,
106 PERF_OUTPUT_CALLINDENT = 1ULL << 20,
107 PERF_OUTPUT_INSN = 1ULL << 21,
108 PERF_OUTPUT_INSNLEN = 1ULL << 22,
109 PERF_OUTPUT_BRSTACKINSN = 1ULL << 23,
110 PERF_OUTPUT_BRSTACKOFF = 1ULL << 24,
111 PERF_OUTPUT_SYNTH = 1ULL << 25,
112 PERF_OUTPUT_PHYS_ADDR = 1ULL << 26,
113 PERF_OUTPUT_UREGS = 1ULL << 27,
114 PERF_OUTPUT_METRIC = 1ULL << 28,
115 PERF_OUTPUT_MISC = 1ULL << 29,
116 PERF_OUTPUT_SRCCODE = 1ULL << 30,
117 PERF_OUTPUT_IPC = 1ULL << 31,
118 PERF_OUTPUT_TOD = 1ULL << 32,
119 PERF_OUTPUT_DATA_PAGE_SIZE = 1ULL << 33,
120 PERF_OUTPUT_CODE_PAGE_SIZE = 1ULL << 34,
124 struct perf_tool tool;
125 struct perf_session *session;
126 bool show_task_events;
127 bool show_mmap_events;
128 bool show_switch_events;
129 bool show_namespace_events;
130 bool show_lost_events;
131 bool show_round_events;
132 bool show_bpf_events;
133 bool show_cgroup_events;
134 bool show_text_poke_events;
138 struct evswitch evswitch;
139 struct perf_cpu_map *cpus;
140 struct perf_thread_map *threads;
142 const char *time_str;
143 struct perf_time_interval *ptime_range;
148 struct output_option {
150 enum perf_output_field field;
151 } all_output_options[] = {
152 {.str = "comm", .field = PERF_OUTPUT_COMM},
153 {.str = "tid", .field = PERF_OUTPUT_TID},
154 {.str = "pid", .field = PERF_OUTPUT_PID},
155 {.str = "time", .field = PERF_OUTPUT_TIME},
156 {.str = "cpu", .field = PERF_OUTPUT_CPU},
157 {.str = "event", .field = PERF_OUTPUT_EVNAME},
158 {.str = "trace", .field = PERF_OUTPUT_TRACE},
159 {.str = "ip", .field = PERF_OUTPUT_IP},
160 {.str = "sym", .field = PERF_OUTPUT_SYM},
161 {.str = "dso", .field = PERF_OUTPUT_DSO},
162 {.str = "addr", .field = PERF_OUTPUT_ADDR},
163 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
164 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
165 {.str = "period", .field = PERF_OUTPUT_PERIOD},
166 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
167 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
168 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
169 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
170 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
171 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
172 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
173 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
174 {.str = "insn", .field = PERF_OUTPUT_INSN},
175 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
176 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
177 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
178 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
179 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
180 {.str = "metric", .field = PERF_OUTPUT_METRIC},
181 {.str = "misc", .field = PERF_OUTPUT_MISC},
182 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
183 {.str = "ipc", .field = PERF_OUTPUT_IPC},
184 {.str = "tod", .field = PERF_OUTPUT_TOD},
185 {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
186 {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
190 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
195 /* default set to maintain compatibility with current format */
199 unsigned int print_ip_opts;
203 u64 user_unset_fields;
204 } output[OUTPUT_TYPE_MAX] = {
206 [PERF_TYPE_HARDWARE] = {
209 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
210 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
211 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
212 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
213 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
215 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
218 [PERF_TYPE_SOFTWARE] = {
221 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
222 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
223 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
224 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
225 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
226 PERF_OUTPUT_BPF_OUTPUT,
228 .invalid_fields = PERF_OUTPUT_TRACE,
231 [PERF_TYPE_TRACEPOINT] = {
234 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
235 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
236 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
239 [PERF_TYPE_HW_CACHE] = {
242 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
243 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
244 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
245 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
246 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
248 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
254 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
255 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
256 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
257 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
258 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
259 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
260 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
261 PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE,
263 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
266 [PERF_TYPE_BREAKPOINT] = {
269 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
270 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
271 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
272 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
273 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
275 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
278 [OUTPUT_TYPE_SYNTH] = {
281 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
282 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
283 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
284 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
285 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
287 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
290 [OUTPUT_TYPE_OTHER] = {
293 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
294 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
295 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
296 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
297 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
299 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
303 struct evsel_script {
307 /* For metric output */
312 static inline struct evsel_script *evsel_script(struct evsel *evsel)
314 return (struct evsel_script *)evsel->priv;
317 static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
319 struct evsel_script *es = zalloc(sizeof(*es));
322 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
324 es->fp = fopen(es->filename, "w");
326 goto out_free_filename;
331 zfree(&es->filename);
337 static void evsel_script__delete(struct evsel_script *es)
339 zfree(&es->filename);
345 static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
349 fstat(fileno(es->fp), &st);
350 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
351 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
354 static inline int output_type(unsigned int type)
357 case PERF_TYPE_SYNTH:
358 return OUTPUT_TYPE_SYNTH;
360 if (type < PERF_TYPE_MAX)
364 return OUTPUT_TYPE_OTHER;
367 static inline unsigned int attr_type(unsigned int type)
370 case OUTPUT_TYPE_SYNTH:
371 return PERF_TYPE_SYNTH;
377 static bool output_set_by_user(void)
380 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
381 if (output[j].user_set)
387 static const char *output_field2str(enum perf_output_field field)
389 int i, imax = ARRAY_SIZE(all_output_options);
390 const char *str = "";
392 for (i = 0; i < imax; ++i) {
393 if (all_output_options[i].field == field) {
394 str = all_output_options[i].str;
401 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
403 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
404 enum perf_output_field field, bool allow_user_set)
406 struct perf_event_attr *attr = &evsel->core.attr;
407 int type = output_type(attr->type);
410 if (attr->sample_type & sample_type)
413 if (output[type].user_set_fields & field) {
416 evname = evsel__name(evsel);
417 pr_err("Samples for '%s' event do not have %s attribute set. "
418 "Cannot print '%s' field.\n",
419 evname, sample_msg, output_field2str(field));
423 /* user did not ask for it explicitly so remove from the default list */
424 output[type].fields &= ~field;
425 evname = evsel__name(evsel);
426 pr_debug("Samples for '%s' event do not have %s attribute set. "
427 "Skipping '%s' field.\n",
428 evname, sample_msg, output_field2str(field));
433 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
434 enum perf_output_field field)
436 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
439 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
441 struct perf_event_attr *attr = &evsel->core.attr;
444 if (perf_header__has_feat(&session->header, HEADER_STAT))
447 allow_user_set = perf_header__has_feat(&session->header,
450 if (PRINT_FIELD(TRACE) &&
451 !perf_session__has_traces(session, "record -R"))
454 if (PRINT_FIELD(IP)) {
455 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
459 if (PRINT_FIELD(ADDR) &&
460 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
463 if (PRINT_FIELD(DATA_SRC) &&
464 evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
467 if (PRINT_FIELD(WEIGHT) &&
468 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
471 if (PRINT_FIELD(SYM) &&
472 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
473 pr_err("Display of symbols requested but neither sample IP nor "
474 "sample address\navailable. Hence, no addresses to convert "
478 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
479 pr_err("Display of offsets requested but symbol is not"
483 if (PRINT_FIELD(DSO) &&
484 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
485 pr_err("Display of DSO requested but no address to convert.\n");
488 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
489 pr_err("Display of source line number requested but sample IP is not\n"
490 "selected. Hence, no address to lookup the source line number.\n");
493 if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
494 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
495 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
496 "Hint: run 'perf record -b ...'\n");
499 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
500 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
503 if (PRINT_FIELD(TIME) &&
504 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
507 if (PRINT_FIELD(CPU) &&
508 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
511 if (PRINT_FIELD(IREGS) &&
512 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
515 if (PRINT_FIELD(UREGS) &&
516 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
519 if (PRINT_FIELD(PHYS_ADDR) &&
520 evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
523 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
524 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
527 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
528 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
534 static void set_print_ip_opts(struct perf_event_attr *attr)
536 unsigned int type = output_type(attr->type);
538 output[type].print_ip_opts = 0;
540 output[type].print_ip_opts |= EVSEL__PRINT_IP;
542 if (PRINT_FIELD(SYM))
543 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
545 if (PRINT_FIELD(DSO))
546 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
548 if (PRINT_FIELD(SYMOFFSET))
549 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
551 if (PRINT_FIELD(SRCLINE))
552 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
556 * verify all user requested events exist and the samples
557 * have the expected data
559 static int perf_session__check_output_opt(struct perf_session *session)
565 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
566 evsel = perf_session__find_first_evtype(session, attr_type(j));
569 * even if fields is set to 0 (ie., show nothing) event must
570 * exist if user explicitly includes it on the command line
572 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
573 j != OUTPUT_TYPE_SYNTH) {
574 pr_err("%s events do not exist. "
575 "Remove corresponding -F option to proceed.\n",
580 if (evsel && output[j].fields &&
581 evsel__check_attr(evsel, session))
587 set_print_ip_opts(&evsel->core.attr);
588 tod |= output[j].fields & PERF_OUTPUT_TOD;
592 bool use_callchain = false;
593 bool not_pipe = false;
595 evlist__for_each_entry(session->evlist, evsel) {
597 if (evsel__has_callchain(evsel)) {
598 use_callchain = true;
602 if (not_pipe && !use_callchain)
603 symbol_conf.use_callchain = false;
607 * set default for tracepoints to print symbols only
608 * if callchains are present
610 if (symbol_conf.use_callchain &&
611 !output[PERF_TYPE_TRACEPOINT].user_set) {
612 j = PERF_TYPE_TRACEPOINT;
614 evlist__for_each_entry(session->evlist, evsel) {
615 if (evsel->core.attr.type != j)
618 if (evsel__has_callchain(evsel)) {
619 output[j].fields |= PERF_OUTPUT_IP;
620 output[j].fields |= PERF_OUTPUT_SYM;
621 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
622 output[j].fields |= PERF_OUTPUT_DSO;
623 set_print_ip_opts(&evsel->core.attr);
629 if (tod && !session->header.env.clock.enabled) {
630 pr_err("Can't provide 'tod' time, missing clock data. "
631 "Please record with -k/--clockid option.\n");
638 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
644 if (!regs || !regs->regs)
647 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
649 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
650 u64 val = regs->regs[i++];
651 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
657 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
660 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
663 u64 tod_ns, clockid_ns;
664 struct perf_env *env;
671 if (buflen < 64 || !script)
674 env = &script->session->header.env;
675 if (!env->clock.enabled) {
676 scnprintf(buf, buflen, "disabled");
680 clockid_ns = env->clock.clockid_ns;
681 tod_ns = env->clock.tod_ns;
683 if (timestamp > clockid_ns)
684 tod_ns += timestamp - clockid_ns;
686 tod_ns -= clockid_ns - timestamp;
688 sec = (time_t) (tod_ns / NSEC_PER_SEC);
689 nsec = tod_ns - sec * NSEC_PER_SEC;
691 if (localtime_r(&sec, <ime) == NULL) {
692 scnprintf(buf, buflen, "failed");
694 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
696 if (symbol_conf.nanosecs) {
697 snprintf(buf, buflen, "%s.%09lu", date, nsec);
699 snprintf(buf, buflen, "%s.%06lu",
700 date, nsec / NSEC_PER_USEC);
707 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
708 struct perf_event_attr *attr, FILE *fp)
710 return perf_sample__fprintf_regs(&sample->intr_regs,
711 attr->sample_regs_intr, fp);
714 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
715 struct perf_event_attr *attr, FILE *fp)
717 return perf_sample__fprintf_regs(&sample->user_regs,
718 attr->sample_regs_user, fp);
721 static int perf_sample__fprintf_start(struct perf_script *script,
722 struct perf_sample *sample,
723 struct thread *thread,
727 struct perf_event_attr *attr = &evsel->core.attr;
729 unsigned long long nsecs;
733 if (PRINT_FIELD(COMM)) {
734 const char *comm = thread ? thread__comm_str(thread) : ":-1";
737 printed += fprintf(fp, "%8.8s ", comm);
738 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
739 printed += fprintf(fp, "%s ", comm);
741 printed += fprintf(fp, "%16s ", comm);
744 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
745 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
746 else if (PRINT_FIELD(PID))
747 printed += fprintf(fp, "%5d ", sample->pid);
748 else if (PRINT_FIELD(TID))
749 printed += fprintf(fp, "%5d ", sample->tid);
751 if (PRINT_FIELD(CPU)) {
753 printed += fprintf(fp, "%3d ", sample->cpu);
755 printed += fprintf(fp, "[%03d] ", sample->cpu);
758 if (PRINT_FIELD(MISC)) {
762 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
765 ret += fprintf(fp, "K");
767 ret += fprintf(fp, "U");
769 ret += fprintf(fp, "H");
770 if (has(GUEST_KERNEL))
771 ret += fprintf(fp, "G");
773 ret += fprintf(fp, "g");
776 case PERF_RECORD_MMAP:
777 case PERF_RECORD_MMAP2:
779 ret += fprintf(fp, "M");
781 case PERF_RECORD_COMM:
783 ret += fprintf(fp, "E");
785 case PERF_RECORD_SWITCH:
786 case PERF_RECORD_SWITCH_CPU_WIDE:
787 if (has(SWITCH_OUT)) {
788 ret += fprintf(fp, "S");
789 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
790 ret += fprintf(fp, "p");
798 ret += fprintf(fp, "%*s", 6 - ret, " ");
802 if (PRINT_FIELD(TOD)) {
803 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
804 printed += fprintf(fp, "%s ", tstr);
807 if (PRINT_FIELD(TIME)) {
808 u64 t = sample->time;
811 initial_time = sample->time;
812 t = sample->time - initial_time;
813 } else if (deltatime) {
815 t = sample->time - previous_time;
819 previous_time = sample->time;
822 secs = nsecs / NSEC_PER_SEC;
823 nsecs -= secs * NSEC_PER_SEC;
825 if (symbol_conf.nanosecs)
826 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
828 char sample_time[32];
829 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
830 printed += fprintf(fp, "%12s: ", sample_time);
838 mispred_str(struct branch_entry *br)
840 if (!(br->flags.mispred || br->flags.predicted))
843 return br->flags.predicted ? 'P' : 'M';
846 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
847 struct thread *thread,
848 struct perf_event_attr *attr, FILE *fp)
850 struct branch_stack *br = sample->branch_stack;
851 struct branch_entry *entries = perf_sample__branch_entries(sample);
852 struct addr_location alf, alt;
859 for (i = 0; i < br->nr; i++) {
860 from = entries[i].from;
863 if (PRINT_FIELD(DSO)) {
864 memset(&alf, 0, sizeof(alf));
865 memset(&alt, 0, sizeof(alt));
866 thread__find_map_fb(thread, sample->cpumode, from, &alf);
867 thread__find_map_fb(thread, sample->cpumode, to, &alt);
870 printed += fprintf(fp, " 0x%"PRIx64, from);
871 if (PRINT_FIELD(DSO)) {
872 printed += fprintf(fp, "(");
873 printed += map__fprintf_dsoname(alf.map, fp);
874 printed += fprintf(fp, ")");
877 printed += fprintf(fp, "/0x%"PRIx64, to);
878 if (PRINT_FIELD(DSO)) {
879 printed += fprintf(fp, "(");
880 printed += map__fprintf_dsoname(alt.map, fp);
881 printed += fprintf(fp, ")");
884 printed += fprintf(fp, "/%c/%c/%c/%d ",
885 mispred_str(entries + i),
886 entries[i].flags.in_tx ? 'X' : '-',
887 entries[i].flags.abort ? 'A' : '-',
888 entries[i].flags.cycles);
894 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
895 struct thread *thread,
896 struct perf_event_attr *attr, FILE *fp)
898 struct branch_stack *br = sample->branch_stack;
899 struct branch_entry *entries = perf_sample__branch_entries(sample);
900 struct addr_location alf, alt;
907 for (i = 0; i < br->nr; i++) {
909 memset(&alf, 0, sizeof(alf));
910 memset(&alt, 0, sizeof(alt));
911 from = entries[i].from;
914 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
915 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
917 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
918 if (PRINT_FIELD(DSO)) {
919 printed += fprintf(fp, "(");
920 printed += map__fprintf_dsoname(alf.map, fp);
921 printed += fprintf(fp, ")");
923 printed += fprintf(fp, "%c", '/');
924 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
925 if (PRINT_FIELD(DSO)) {
926 printed += fprintf(fp, "(");
927 printed += map__fprintf_dsoname(alt.map, fp);
928 printed += fprintf(fp, ")");
930 printed += fprintf(fp, "/%c/%c/%c/%d ",
931 mispred_str(entries + i),
932 entries[i].flags.in_tx ? 'X' : '-',
933 entries[i].flags.abort ? 'A' : '-',
934 entries[i].flags.cycles);
940 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
941 struct thread *thread,
942 struct perf_event_attr *attr, FILE *fp)
944 struct branch_stack *br = sample->branch_stack;
945 struct branch_entry *entries = perf_sample__branch_entries(sample);
946 struct addr_location alf, alt;
953 for (i = 0; i < br->nr; i++) {
955 memset(&alf, 0, sizeof(alf));
956 memset(&alt, 0, sizeof(alt));
957 from = entries[i].from;
960 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
961 !alf.map->dso->adjust_symbols)
962 from = map__map_ip(alf.map, from);
964 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
965 !alt.map->dso->adjust_symbols)
966 to = map__map_ip(alt.map, to);
968 printed += fprintf(fp, " 0x%"PRIx64, from);
969 if (PRINT_FIELD(DSO)) {
970 printed += fprintf(fp, "(");
971 printed += map__fprintf_dsoname(alf.map, fp);
972 printed += fprintf(fp, ")");
974 printed += fprintf(fp, "/0x%"PRIx64, to);
975 if (PRINT_FIELD(DSO)) {
976 printed += fprintf(fp, "(");
977 printed += map__fprintf_dsoname(alt.map, fp);
978 printed += fprintf(fp, ")");
980 printed += fprintf(fp, "/%c/%c/%c/%d ",
981 mispred_str(entries + i),
982 entries[i].flags.in_tx ? 'X' : '-',
983 entries[i].flags.abort ? 'A' : '-',
984 entries[i].flags.cycles);
989 #define MAXBB 16384UL
991 static int grab_bb(u8 *buffer, u64 start, u64 end,
992 struct machine *machine, struct thread *thread,
993 bool *is64bit, u8 *cpumode, bool last)
996 struct addr_location al;
1002 kernel = machine__kernel_ip(machine, start);
1004 *cpumode = PERF_RECORD_MISC_KERNEL;
1006 *cpumode = PERF_RECORD_MISC_USER;
1009 * Block overlaps between kernel and user.
1010 * This can happen due to ring filtering
1011 * On Intel CPUs the entry into the kernel is filtered,
1012 * but the exit is not. Let the caller patch it up.
1014 if (kernel != machine__kernel_ip(machine, end)) {
1015 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1019 memset(&al, 0, sizeof(al));
1020 if (end - start > MAXBB - MAXINSN) {
1022 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1024 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1028 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1029 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1032 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1033 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1037 /* Load maps to ensure dso->is_64_bit has been updated */
1040 offset = al.map->map_ip(al.map, start);
1041 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1042 end - start + MAXINSN);
1044 *is64bit = al.map->dso->is_64_bit;
1046 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1051 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1059 if (!map || !map->dso)
1061 srcfile = get_srcline_split(map->dso,
1062 map__rip_2objdump(map, addr),
1067 /* Avoid redundant printing */
1070 !strcmp(state->srcfile, srcfile) &&
1071 state->line == line) {
1076 srccode = find_sourceline(srcfile, line, &len);
1080 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1083 state->srcfile = srcfile;
1093 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1095 struct addr_location al;
1098 memset(&al, 0, sizeof(al));
1099 thread__find_map(thread, cpumode, addr, &al);
1102 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1103 &thread->srccode_state);
1105 ret += printf("\n");
1109 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1110 struct perf_insn *x, u8 *inbuf, int len,
1111 int insn, FILE *fp, int *total_cycles)
1113 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
1114 dump_insn(x, ip, inbuf, len, NULL),
1115 en->flags.predicted ? " PRED" : "",
1116 en->flags.mispred ? " MISPRED" : "",
1117 en->flags.in_tx ? " INTX" : "",
1118 en->flags.abort ? " ABORT" : "");
1119 if (en->flags.cycles) {
1120 *total_cycles += en->flags.cycles;
1121 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1123 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1125 return printed + fprintf(fp, "\n");
1128 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1129 u8 cpumode, int cpu, struct symbol **lastsym,
1130 struct perf_event_attr *attr, FILE *fp)
1132 struct addr_location al;
1133 int off, printed = 0;
1135 memset(&al, 0, sizeof(al));
1137 thread__find_map(thread, cpumode, addr, &al);
1139 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1145 al.sym = map__find_symbol(al.map, al.addr);
1150 if (al.addr < al.sym->end)
1151 off = al.addr - al.sym->start;
1153 off = al.addr - al.map->start - al.sym->start;
1154 printed += fprintf(fp, "\t%s", al.sym->name);
1156 printed += fprintf(fp, "%+d", off);
1157 printed += fprintf(fp, ":");
1158 if (PRINT_FIELD(SRCLINE))
1159 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1160 printed += fprintf(fp, "\n");
1166 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1167 struct thread *thread,
1168 struct perf_event_attr *attr,
1169 struct machine *machine, FILE *fp)
1171 struct branch_stack *br = sample->branch_stack;
1172 struct branch_entry *entries = perf_sample__branch_entries(sample);
1174 int i, insn, len, nr, ilen, printed = 0;
1178 struct symbol *lastsym = NULL;
1179 int total_cycles = 0;
1181 if (!(br && br->nr))
1184 if (max_blocks && nr > max_blocks + 1)
1185 nr = max_blocks + 1;
1188 x.cpu = sample->cpu;
1190 printed += fprintf(fp, "%c", '\n');
1192 /* Handle first from jump, of which we don't know the entry. */
1193 len = grab_bb(buffer, entries[nr-1].from,
1195 machine, thread, &x.is64bit, &x.cpumode, false);
1197 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1198 x.cpumode, x.cpu, &lastsym, attr, fp);
1199 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1200 &x, buffer, len, 0, fp, &total_cycles);
1201 if (PRINT_FIELD(SRCCODE))
1202 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1205 /* Print all blocks */
1206 for (i = nr - 2; i >= 0; i--) {
1207 if (entries[i].from || entries[i].to)
1208 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1211 start = entries[i + 1].to;
1212 end = entries[i].from;
1214 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1215 /* Patch up missing kernel transfers due to ring filters */
1216 if (len == -ENXIO && i > 0) {
1217 end = entries[--i].from;
1218 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1219 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1225 for (off = 0; off < (unsigned)len; off += ilen) {
1226 uint64_t ip = start + off;
1228 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1230 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1232 if (PRINT_FIELD(SRCCODE))
1233 printed += print_srccode(thread, x.cpumode, ip);
1237 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1238 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1241 if (PRINT_FIELD(SRCCODE))
1242 print_srccode(thread, x.cpumode, ip);
1246 if (off != end - start)
1247 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1251 * Hit the branch? In this case we are already done, and the target
1252 * has not been executed yet.
1254 if (entries[0].from == sample->ip)
1256 if (entries[0].flags.abort)
1260 * Print final block upto sample
1262 * Due to pipeline delays the LBRs might be missing a branch
1263 * or two, which can result in very large or negative blocks
1264 * between final branch and sample. When this happens just
1265 * continue walking after the last TO until we hit a branch.
1267 start = entries[0].to;
1270 /* Missing jump. Scan 128 bytes for the next branch */
1273 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1274 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1276 /* Print at least last IP if basic block did not work */
1277 len = grab_bb(buffer, sample->ip, sample->ip,
1278 machine, thread, &x.is64bit, &x.cpumode, false);
1281 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1282 dump_insn(&x, sample->ip, buffer, len, NULL));
1283 if (PRINT_FIELD(SRCCODE))
1284 print_srccode(thread, x.cpumode, sample->ip);
1287 for (off = 0; off <= end - start; off += ilen) {
1289 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1290 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1293 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1295 * Hit a missing branch. Just stop.
1297 printed += fprintf(fp, "\t... not reaching sample ...\n");
1300 if (PRINT_FIELD(SRCCODE))
1301 print_srccode(thread, x.cpumode, start + off);
1307 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1308 struct thread *thread,
1309 struct perf_event_attr *attr, FILE *fp)
1311 struct addr_location al;
1312 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1314 if (!sample_addr_correlates_sym(attr))
1317 thread__resolve(thread, &al, sample);
1319 if (PRINT_FIELD(SYM)) {
1320 printed += fprintf(fp, " ");
1321 if (PRINT_FIELD(SYMOFFSET))
1322 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1324 printed += symbol__fprintf_symname(al.sym, fp);
1327 if (PRINT_FIELD(DSO)) {
1328 printed += fprintf(fp, " (");
1329 printed += map__fprintf_dsoname(al.map, fp);
1330 printed += fprintf(fp, ")");
1336 static const char *resolve_branch_sym(struct perf_sample *sample,
1337 struct evsel *evsel,
1338 struct thread *thread,
1339 struct addr_location *al,
1342 struct addr_location addr_al;
1343 struct perf_event_attr *attr = &evsel->core.attr;
1344 const char *name = NULL;
1346 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1347 if (sample_addr_correlates_sym(attr)) {
1348 thread__resolve(thread, &addr_al, sample);
1350 name = addr_al.sym->name;
1356 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1358 name = al->sym->name;
1365 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1366 struct evsel *evsel,
1367 struct thread *thread,
1368 struct addr_location *al, FILE *fp)
1370 struct perf_event_attr *attr = &evsel->core.attr;
1371 size_t depth = thread_stack__depth(thread, sample->cpu);
1372 const char *name = NULL;
1379 * The 'return' has already been popped off the stack so the depth has
1380 * to be adjusted to match the 'call'.
1382 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1385 name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1387 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1388 dlen += fprintf(fp, "(");
1389 dlen += map__fprintf_dsoname(al->map, fp);
1390 dlen += fprintf(fp, ")\t");
1394 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1396 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1402 * Try to keep the output length from changing frequently so that the
1403 * output lines up more nicely.
1405 if (len > spacing || (len && len < spacing - 52))
1406 spacing = round_up(len + 4, 32);
1409 len += fprintf(fp, "%*s", spacing - len, "");
1414 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1415 struct thread *thread __maybe_unused,
1416 struct machine *machine __maybe_unused)
1420 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1421 struct perf_event_attr *attr,
1422 struct thread *thread,
1423 struct machine *machine, FILE *fp)
1427 if (sample->insn_len == 0 && native_arch)
1428 arch_fetch_insn(sample, thread, machine);
1430 if (PRINT_FIELD(INSNLEN))
1431 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1432 if (PRINT_FIELD(INSN) && sample->insn_len) {
1435 printed += fprintf(fp, " insn:");
1436 for (i = 0; i < sample->insn_len; i++)
1437 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1439 if (PRINT_FIELD(BRSTACKINSN))
1440 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1445 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1446 struct perf_event_attr *attr, FILE *fp)
1450 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1453 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1455 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1456 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1459 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1460 struct evsel *evsel,
1461 struct thread *thread,
1462 struct addr_location *al,
1463 struct machine *machine, FILE *fp)
1465 struct perf_event_attr *attr = &evsel->core.attr;
1466 unsigned int type = output_type(attr->type);
1467 bool print_srcline_last = false;
1470 if (PRINT_FIELD(CALLINDENT))
1471 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1473 /* print branch_from information */
1474 if (PRINT_FIELD(IP)) {
1475 unsigned int print_opts = output[type].print_ip_opts;
1476 struct callchain_cursor *cursor = NULL;
1478 if (symbol_conf.use_callchain && sample->callchain &&
1479 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1480 sample, NULL, NULL, scripting_max_stack) == 0)
1481 cursor = &callchain_cursor;
1483 if (cursor == NULL) {
1484 printed += fprintf(fp, " ");
1485 if (print_opts & EVSEL__PRINT_SRCLINE) {
1486 print_srcline_last = true;
1487 print_opts &= ~EVSEL__PRINT_SRCLINE;
1490 printed += fprintf(fp, "\n");
1492 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1493 symbol_conf.bt_stop_list, fp);
1496 /* print branch_to information */
1497 if (PRINT_FIELD(ADDR) ||
1498 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1499 !output[type].user_set)) {
1500 printed += fprintf(fp, " => ");
1501 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1504 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1506 if (print_srcline_last)
1507 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1509 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1510 printed += fprintf(fp, "\n");
1511 if (PRINT_FIELD(SRCCODE)) {
1512 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1513 &thread->srccode_state);
1516 printed += printf("\n");
1525 } sample_flags[] = {
1526 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1527 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1528 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1529 {PERF_IP_FLAG_BRANCH, "jmp"},
1530 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1531 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1532 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1533 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1534 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1535 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1536 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1537 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1538 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1539 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1540 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1544 static const char *sample_flags_to_name(u32 flags)
1548 for (i = 0; sample_flags[i].name ; i++) {
1549 if (sample_flags[i].flags == flags)
1550 return sample_flags[i].name;
1556 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1558 const char *chars = PERF_IP_FLAG_CHARS;
1559 const int n = strlen(PERF_IP_FLAG_CHARS);
1560 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1561 const char *name = NULL;
1565 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1567 return fprintf(fp, " %-15s%4s ", name, in_tx ? "(x)" : "");
1569 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1570 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1572 return fprintf(fp, " tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1575 if (flags & PERF_IP_FLAG_TRACE_END) {
1576 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1578 return fprintf(fp, " tr end %-7s%4s ", name, in_tx ? "(x)" : "");
1581 for (i = 0; i < n; i++, flags >>= 1) {
1583 str[pos++] = chars[i];
1585 for (; i < 32; i++, flags >>= 1) {
1591 return fprintf(fp, " %-19s ", str);
1594 struct printer_data {
1600 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1602 void *extra, FILE *fp)
1604 unsigned char ch = (unsigned char)val;
1605 struct printer_data *printer_data = extra;
1609 case BINARY_PRINT_DATA_BEGIN:
1610 printed += fprintf(fp, "\n");
1612 case BINARY_PRINT_LINE_BEGIN:
1613 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1616 case BINARY_PRINT_ADDR:
1617 printed += fprintf(fp, " %04x:", val);
1619 case BINARY_PRINT_NUM_DATA:
1620 printed += fprintf(fp, " %02x", val);
1622 case BINARY_PRINT_NUM_PAD:
1623 printed += fprintf(fp, " ");
1625 case BINARY_PRINT_SEP:
1626 printed += fprintf(fp, " ");
1628 case BINARY_PRINT_CHAR_DATA:
1629 if (printer_data->hit_nul && ch)
1630 printer_data->is_printable = false;
1633 printed += fprintf(fp, "%c", '.');
1635 if (!printer_data->is_printable)
1639 printer_data->hit_nul = true;
1641 printer_data->is_printable = false;
1643 printed += fprintf(fp, "%c", ch);
1646 case BINARY_PRINT_CHAR_PAD:
1647 printed += fprintf(fp, " ");
1649 case BINARY_PRINT_LINE_END:
1650 printed += fprintf(fp, "\n");
1651 printer_data->line_no++;
1653 case BINARY_PRINT_DATA_END:
1661 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1663 unsigned int nr_bytes = sample->raw_size;
1664 struct printer_data printer_data = {0, false, true};
1665 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1666 sample__fprintf_bpf_output, &printer_data, fp);
1668 if (printer_data.is_printable && printer_data.hit_nul)
1669 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1674 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1676 if (len > 0 && len < spacing)
1677 return fprintf(fp, "%*s", spacing - len, "");
1682 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1684 return perf_sample__fprintf_spacing(len, 34, fp);
1687 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1689 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1692 if (perf_sample__bad_synth_size(sample, *data))
1695 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1696 data->ip, le64_to_cpu(data->payload));
1697 return len + perf_sample__fprintf_pt_spacing(len, fp);
1700 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1702 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1705 if (perf_sample__bad_synth_size(sample, *data))
1708 len = fprintf(fp, " hints: %#x extensions: %#x ",
1709 data->hints, data->extensions);
1710 return len + perf_sample__fprintf_pt_spacing(len, fp);
1713 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1715 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1718 if (perf_sample__bad_synth_size(sample, *data))
1721 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1722 data->hw, data->cstate, data->subcstate);
1723 return len + perf_sample__fprintf_pt_spacing(len, fp);
1726 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1728 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1731 if (perf_sample__bad_synth_size(sample, *data))
1734 len = fprintf(fp, " IP: %u ", data->ip);
1735 return len + perf_sample__fprintf_pt_spacing(len, fp);
1738 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1740 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1743 if (perf_sample__bad_synth_size(sample, *data))
1746 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1747 data->deepest_cstate, data->last_cstate,
1749 return len + perf_sample__fprintf_pt_spacing(len, fp);
1752 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1754 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1755 unsigned int percent, freq;
1758 if (perf_sample__bad_synth_size(sample, *data))
1761 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1762 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1763 if (data->max_nonturbo) {
1764 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1765 len += fprintf(fp, "(%3u%%) ", percent);
1767 return len + perf_sample__fprintf_pt_spacing(len, fp);
1770 static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1772 struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1775 if (perf_sample__bad_synth_size(sample, *data))
1778 len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1779 return len + perf_sample__fprintf_pt_spacing(len, fp);
1782 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1783 struct evsel *evsel, FILE *fp)
1785 switch (evsel->core.attr.config) {
1786 case PERF_SYNTH_INTEL_PTWRITE:
1787 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1788 case PERF_SYNTH_INTEL_MWAIT:
1789 return perf_sample__fprintf_synth_mwait(sample, fp);
1790 case PERF_SYNTH_INTEL_PWRE:
1791 return perf_sample__fprintf_synth_pwre(sample, fp);
1792 case PERF_SYNTH_INTEL_EXSTOP:
1793 return perf_sample__fprintf_synth_exstop(sample, fp);
1794 case PERF_SYNTH_INTEL_PWRX:
1795 return perf_sample__fprintf_synth_pwrx(sample, fp);
1796 case PERF_SYNTH_INTEL_CBR:
1797 return perf_sample__fprintf_synth_cbr(sample, fp);
1798 case PERF_SYNTH_INTEL_PSB:
1799 return perf_sample__fprintf_synth_psb(sample, fp);
1807 static int evlist__max_name_len(struct evlist *evlist)
1809 struct evsel *evsel;
1812 evlist__for_each_entry(evlist, evsel) {
1813 int len = strlen(evsel__name(evsel));
1815 max = MAX(len, max);
1821 static int data_src__fprintf(u64 data_src, FILE *fp)
1823 struct mem_info mi = { .data_src.val = data_src };
1829 perf_script__meminfo_scnprintf(decode, 100, &mi);
1831 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1835 return fprintf(fp, "%-*s", maxlen, out);
1839 struct perf_sample *sample;
1840 struct thread *thread;
1841 struct evsel *evsel;
1845 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1846 void *ctx, const char *color,
1848 const char *unit, double val)
1850 struct metric_ctx *mctx = ctx;
1854 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1855 PERF_RECORD_SAMPLE, mctx->fp);
1856 fputs("\tmetric: ", mctx->fp);
1858 color_fprintf(mctx->fp, color, fmt, val);
1861 fprintf(mctx->fp, " %s\n", unit);
1864 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1867 struct metric_ctx *mctx = ctx;
1869 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1870 PERF_RECORD_SAMPLE, mctx->fp);
1871 fputs("\tmetric: ", mctx->fp);
1874 static void perf_sample__fprint_metric(struct perf_script *script,
1875 struct thread *thread,
1876 struct evsel *evsel,
1877 struct perf_sample *sample,
1880 struct perf_stat_output_ctx ctx = {
1881 .print_metric = script_print_metric,
1882 .new_line = script_new_line,
1883 .ctx = &(struct metric_ctx) {
1889 .force_header = false,
1895 evlist__alloc_stats(script->session->evlist, false);
1896 if (evsel_script(evsel->leader)->gnum++ == 0)
1897 perf_stat__reset_shadow_stats();
1898 val = sample->period * evsel->scale;
1899 perf_stat__update_shadow_stats(evsel,
1903 evsel_script(evsel)->val = val;
1904 if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1905 for_each_group_member (ev2, evsel->leader) {
1906 perf_stat__print_shadow_stats(&stat_config, ev2,
1907 evsel_script(ev2)->val,
1913 evsel_script(evsel->leader)->gnum = 0;
1917 static bool show_event(struct perf_sample *sample,
1918 struct evsel *evsel,
1919 struct thread *thread,
1920 struct addr_location *al)
1922 int depth = thread_stack__depth(thread, sample->cpu);
1924 if (!symbol_conf.graph_function)
1927 if (thread->filter) {
1928 if (depth <= thread->filter_entry_depth) {
1929 thread->filter = false;
1934 const char *s = symbol_conf.graph_function;
1936 const char *name = resolve_branch_sym(sample, evsel, thread, al,
1942 nlen = strlen(name);
1944 unsigned len = strcspn(s, ",");
1945 if (nlen == len && !strncmp(name, s, len)) {
1946 thread->filter = true;
1947 thread->filter_entry_depth = depth;
1958 static void process_event(struct perf_script *script,
1959 struct perf_sample *sample, struct evsel *evsel,
1960 struct addr_location *al,
1961 struct machine *machine)
1963 struct thread *thread = al->thread;
1964 struct perf_event_attr *attr = &evsel->core.attr;
1965 unsigned int type = output_type(attr->type);
1966 struct evsel_script *es = evsel->priv;
1968 char str[PAGE_SIZE_NAME_LEN];
1970 if (output[type].fields == 0)
1973 if (!show_event(sample, evsel, thread, al))
1976 if (evswitch__discard(&script->evswitch, evsel))
1981 perf_sample__fprintf_start(script, sample, thread, evsel,
1982 PERF_RECORD_SAMPLE, fp);
1984 if (PRINT_FIELD(PERIOD))
1985 fprintf(fp, "%10" PRIu64 " ", sample->period);
1987 if (PRINT_FIELD(EVNAME)) {
1988 const char *evname = evsel__name(evsel);
1990 if (!script->name_width)
1991 script->name_width = evlist__max_name_len(script->session->evlist);
1993 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1997 perf_sample__fprintf_flags(sample->flags, fp);
1999 if (is_bts_event(attr)) {
2000 perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
2004 if (PRINT_FIELD(TRACE) && sample->raw_data) {
2005 event_format__fprintf(evsel->tp_format, sample->cpu,
2006 sample->raw_data, sample->raw_size, fp);
2009 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2010 perf_sample__fprintf_synth(sample, evsel, fp);
2012 if (PRINT_FIELD(ADDR))
2013 perf_sample__fprintf_addr(sample, thread, attr, fp);
2015 if (PRINT_FIELD(DATA_SRC))
2016 data_src__fprintf(sample->data_src, fp);
2018 if (PRINT_FIELD(WEIGHT))
2019 fprintf(fp, "%16" PRIu64, sample->weight);
2021 if (PRINT_FIELD(IP)) {
2022 struct callchain_cursor *cursor = NULL;
2024 if (script->stitch_lbr)
2025 al->thread->lbr_stitch_enable = true;
2027 if (symbol_conf.use_callchain && sample->callchain &&
2028 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2029 sample, NULL, NULL, scripting_max_stack) == 0)
2030 cursor = &callchain_cursor;
2032 fputc(cursor ? '\n' : ' ', fp);
2033 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2034 symbol_conf.bt_stop_list, fp);
2037 if (PRINT_FIELD(IREGS))
2038 perf_sample__fprintf_iregs(sample, attr, fp);
2040 if (PRINT_FIELD(UREGS))
2041 perf_sample__fprintf_uregs(sample, attr, fp);
2043 if (PRINT_FIELD(BRSTACK))
2044 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2045 else if (PRINT_FIELD(BRSTACKSYM))
2046 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2047 else if (PRINT_FIELD(BRSTACKOFF))
2048 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2050 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2051 perf_sample__fprintf_bpf_output(sample, fp);
2052 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2054 if (PRINT_FIELD(PHYS_ADDR))
2055 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2057 if (PRINT_FIELD(DATA_PAGE_SIZE))
2058 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2060 if (PRINT_FIELD(CODE_PAGE_SIZE))
2061 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2063 perf_sample__fprintf_ipc(sample, attr, fp);
2067 if (PRINT_FIELD(SRCCODE)) {
2068 if (map__fprintf_srccode(al->map, al->addr, stdout,
2069 &thread->srccode_state))
2073 if (PRINT_FIELD(METRIC))
2074 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2080 static struct scripting_ops *scripting_ops;
2082 static void __process_stat(struct evsel *counter, u64 tstamp)
2084 int nthreads = perf_thread_map__nr(counter->core.threads);
2085 int ncpus = evsel__nr_cpus(counter);
2087 static int header_printed;
2089 if (counter->core.system_wide)
2092 if (!header_printed) {
2093 printf("%3s %8s %15s %15s %15s %15s %s\n",
2094 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2098 for (thread = 0; thread < nthreads; thread++) {
2099 for (cpu = 0; cpu < ncpus; cpu++) {
2100 struct perf_counts_values *counts;
2102 counts = perf_counts(counter->counts, cpu, thread);
2104 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2105 counter->core.cpus->map[cpu],
2106 perf_thread_map__pid(counter->core.threads, thread),
2111 evsel__name(counter));
2116 static void process_stat(struct evsel *counter, u64 tstamp)
2118 if (scripting_ops && scripting_ops->process_stat)
2119 scripting_ops->process_stat(&stat_config, counter, tstamp);
2121 __process_stat(counter, tstamp);
2124 static void process_stat_interval(u64 tstamp)
2126 if (scripting_ops && scripting_ops->process_stat_interval)
2127 scripting_ops->process_stat_interval(tstamp);
2130 static void setup_scripting(void)
2132 setup_perl_scripting();
2133 setup_python_scripting();
2136 static int flush_scripting(void)
2138 return scripting_ops ? scripting_ops->flush_script() : 0;
2141 static int cleanup_scripting(void)
2143 pr_debug("\nperf script stopped\n");
2145 return scripting_ops ? scripting_ops->stop_script() : 0;
2148 static bool filter_cpu(struct perf_sample *sample)
2150 if (cpu_list && sample->cpu != (u32)-1)
2151 return !test_bit(sample->cpu, cpu_bitmap);
2155 static int process_sample_event(struct perf_tool *tool,
2156 union perf_event *event,
2157 struct perf_sample *sample,
2158 struct evsel *evsel,
2159 struct machine *machine)
2161 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2162 struct addr_location al;
2164 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2170 if (sample->time < last_timestamp) {
2171 pr_err("Samples misordered, previous: %" PRIu64
2172 " this: %" PRIu64 "\n", last_timestamp,
2176 last_timestamp = sample->time;
2180 if (machine__resolve(machine, &al, sample) < 0) {
2181 pr_err("problem processing %d event, skipping it.\n",
2182 event->header.type);
2189 if (filter_cpu(sample))
2193 scripting_ops->process_event(event, sample, evsel, &al);
2195 process_event(scr, sample, evsel, &al, machine);
2198 addr_location__put(&al);
2202 static int process_attr(struct perf_tool *tool, union perf_event *event,
2203 struct evlist **pevlist)
2205 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2206 struct evlist *evlist;
2207 struct evsel *evsel, *pos;
2210 static struct evsel_script *es;
2212 err = perf_event__process_attr(tool, event, pevlist);
2217 evsel = evlist__last(*pevlist);
2220 if (scr->per_event_dump) {
2221 evsel->priv = evsel_script__new(evsel, scr->session->data);
2223 es = zalloc(sizeof(*es));
2231 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2232 evsel->core.attr.type != PERF_TYPE_SYNTH)
2235 evlist__for_each_entry(evlist, pos) {
2236 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2240 if (evsel->core.attr.sample_type) {
2241 err = evsel__check_attr(evsel, scr->session);
2247 * Check if we need to enable callchains based
2248 * on events sample_type.
2250 sample_type = evlist__combined_sample_type(evlist);
2251 callchain_param_setup(sample_type);
2253 /* Enable fields for callchain entries */
2254 if (symbol_conf.use_callchain &&
2255 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2256 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2257 (sample_type & PERF_SAMPLE_REGS_USER &&
2258 sample_type & PERF_SAMPLE_STACK_USER))) {
2259 int type = output_type(evsel->core.attr.type);
2261 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2262 output[type].fields |= PERF_OUTPUT_IP;
2263 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2264 output[type].fields |= PERF_OUTPUT_SYM;
2266 set_print_ip_opts(&evsel->core.attr);
2270 static int print_event_with_time(struct perf_tool *tool,
2271 union perf_event *event,
2272 struct perf_sample *sample,
2273 struct machine *machine,
2274 pid_t pid, pid_t tid, u64 timestamp)
2276 struct perf_script *script = container_of(tool, struct perf_script, tool);
2277 struct perf_session *session = script->session;
2278 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2279 struct thread *thread = NULL;
2281 if (evsel && !evsel->core.attr.sample_id_all) {
2283 sample->time = timestamp;
2288 if (filter_cpu(sample))
2292 thread = machine__findnew_thread(machine, pid, tid);
2295 perf_sample__fprintf_start(script, sample, thread, evsel,
2296 event->header.type, stdout);
2299 perf_event__fprintf(event, machine, stdout);
2301 thread__put(thread);
2306 static int print_event(struct perf_tool *tool, union perf_event *event,
2307 struct perf_sample *sample, struct machine *machine,
2308 pid_t pid, pid_t tid)
2310 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2313 static int process_comm_event(struct perf_tool *tool,
2314 union perf_event *event,
2315 struct perf_sample *sample,
2316 struct machine *machine)
2318 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2321 return print_event(tool, event, sample, machine, event->comm.pid,
2325 static int process_namespaces_event(struct perf_tool *tool,
2326 union perf_event *event,
2327 struct perf_sample *sample,
2328 struct machine *machine)
2330 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2333 return print_event(tool, event, sample, machine, event->namespaces.pid,
2334 event->namespaces.tid);
2337 static int process_cgroup_event(struct perf_tool *tool,
2338 union perf_event *event,
2339 struct perf_sample *sample,
2340 struct machine *machine)
2342 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2345 return print_event(tool, event, sample, machine, sample->pid,
2349 static int process_fork_event(struct perf_tool *tool,
2350 union perf_event *event,
2351 struct perf_sample *sample,
2352 struct machine *machine)
2354 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2357 return print_event_with_time(tool, event, sample, machine,
2358 event->fork.pid, event->fork.tid,
2361 static int process_exit_event(struct perf_tool *tool,
2362 union perf_event *event,
2363 struct perf_sample *sample,
2364 struct machine *machine)
2366 /* Print before 'exit' deletes anything */
2367 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2368 event->fork.tid, event->fork.time))
2371 return perf_event__process_exit(tool, event, sample, machine);
2374 static int process_mmap_event(struct perf_tool *tool,
2375 union perf_event *event,
2376 struct perf_sample *sample,
2377 struct machine *machine)
2379 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2382 return print_event(tool, event, sample, machine, event->mmap.pid,
2386 static int process_mmap2_event(struct perf_tool *tool,
2387 union perf_event *event,
2388 struct perf_sample *sample,
2389 struct machine *machine)
2391 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2394 return print_event(tool, event, sample, machine, event->mmap2.pid,
2398 static int process_switch_event(struct perf_tool *tool,
2399 union perf_event *event,
2400 struct perf_sample *sample,
2401 struct machine *machine)
2403 struct perf_script *script = container_of(tool, struct perf_script, tool);
2405 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2408 if (scripting_ops && scripting_ops->process_switch)
2409 scripting_ops->process_switch(event, sample, machine);
2411 if (!script->show_switch_events)
2414 return print_event(tool, event, sample, machine, sample->pid,
2419 process_lost_event(struct perf_tool *tool,
2420 union perf_event *event,
2421 struct perf_sample *sample,
2422 struct machine *machine)
2424 return print_event(tool, event, sample, machine, sample->pid,
2429 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2430 union perf_event *event,
2431 struct ordered_events *oe __maybe_unused)
2434 perf_event__fprintf(event, NULL, stdout);
2439 process_bpf_events(struct perf_tool *tool __maybe_unused,
2440 union perf_event *event,
2441 struct perf_sample *sample,
2442 struct machine *machine)
2444 if (machine__process_ksymbol(machine, event, sample) < 0)
2447 return print_event(tool, event, sample, machine, sample->pid,
2451 static int process_text_poke_events(struct perf_tool *tool,
2452 union perf_event *event,
2453 struct perf_sample *sample,
2454 struct machine *machine)
2456 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2459 return print_event(tool, event, sample, machine, sample->pid,
2463 static void sig_handler(int sig __maybe_unused)
2468 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2470 struct evlist *evlist = script->session->evlist;
2471 struct evsel *evsel;
2473 evlist__for_each_entry(evlist, evsel) {
2476 evsel_script__delete(evsel->priv);
2481 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2483 struct evsel *evsel;
2485 evlist__for_each_entry(script->session->evlist, evsel) {
2487 * Already setup? I.e. we may be called twice in cases like
2488 * Intel PT, one for the intel_pt// and dummy events, then
2489 * for the evsels synthesized from the auxtrace info.
2491 * Ses perf_script__process_auxtrace_info.
2493 if (evsel->priv != NULL)
2496 evsel->priv = evsel_script__new(evsel, script->session->data);
2497 if (evsel->priv == NULL)
2498 goto out_err_fclose;
2504 perf_script__fclose_per_event_dump(script);
2508 static int perf_script__setup_per_event_dump(struct perf_script *script)
2510 struct evsel *evsel;
2511 static struct evsel_script es_stdout;
2513 if (script->per_event_dump)
2514 return perf_script__fopen_per_event_dump(script);
2516 es_stdout.fp = stdout;
2518 evlist__for_each_entry(script->session->evlist, evsel)
2519 evsel->priv = &es_stdout;
2524 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2526 struct evsel *evsel;
2528 evlist__for_each_entry(script->session->evlist, evsel) {
2529 struct evsel_script *es = evsel->priv;
2531 evsel_script__fprintf(es, stdout);
2532 evsel_script__delete(es);
2537 static void perf_script__exit(struct perf_script *script)
2539 perf_thread_map__put(script->threads);
2540 perf_cpu_map__put(script->cpus);
2543 static int __cmd_script(struct perf_script *script)
2547 signal(SIGINT, sig_handler);
2549 perf_stat__init_shadow_stats();
2551 /* override event processing functions */
2552 if (script->show_task_events) {
2553 script->tool.comm = process_comm_event;
2554 script->tool.fork = process_fork_event;
2555 script->tool.exit = process_exit_event;
2557 if (script->show_mmap_events) {
2558 script->tool.mmap = process_mmap_event;
2559 script->tool.mmap2 = process_mmap2_event;
2561 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2562 script->tool.context_switch = process_switch_event;
2563 if (script->show_namespace_events)
2564 script->tool.namespaces = process_namespaces_event;
2565 if (script->show_cgroup_events)
2566 script->tool.cgroup = process_cgroup_event;
2567 if (script->show_lost_events)
2568 script->tool.lost = process_lost_event;
2569 if (script->show_round_events) {
2570 script->tool.ordered_events = false;
2571 script->tool.finished_round = process_finished_round_event;
2573 if (script->show_bpf_events) {
2574 script->tool.ksymbol = process_bpf_events;
2575 script->tool.bpf = process_bpf_events;
2577 if (script->show_text_poke_events) {
2578 script->tool.ksymbol = process_bpf_events;
2579 script->tool.text_poke = process_text_poke_events;
2582 if (perf_script__setup_per_event_dump(script)) {
2583 pr_err("Couldn't create the per event dump files\n");
2587 ret = perf_session__process_events(script->session);
2589 if (script->per_event_dump)
2590 perf_script__exit_per_event_dump_stats(script);
2593 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2598 struct script_spec {
2599 struct list_head node;
2600 struct scripting_ops *ops;
2604 static LIST_HEAD(script_specs);
2606 static struct script_spec *script_spec__new(const char *spec,
2607 struct scripting_ops *ops)
2609 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2612 strcpy(s->spec, spec);
2619 static void script_spec__add(struct script_spec *s)
2621 list_add_tail(&s->node, &script_specs);
2624 static struct script_spec *script_spec__find(const char *spec)
2626 struct script_spec *s;
2628 list_for_each_entry(s, &script_specs, node)
2629 if (strcasecmp(s->spec, spec) == 0)
2634 int script_spec_register(const char *spec, struct scripting_ops *ops)
2636 struct script_spec *s;
2638 s = script_spec__find(spec);
2642 s = script_spec__new(spec, ops);
2646 script_spec__add(s);
2651 static struct scripting_ops *script_spec__lookup(const char *spec)
2653 struct script_spec *s = script_spec__find(spec);
2660 static void list_available_languages(void)
2662 struct script_spec *s;
2664 fprintf(stderr, "\n");
2665 fprintf(stderr, "Scripting language extensions (used in "
2666 "perf script -s [spec:]script.[spec]):\n\n");
2668 list_for_each_entry(s, &script_specs, node)
2669 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2671 fprintf(stderr, "\n");
2674 static int parse_scriptname(const struct option *opt __maybe_unused,
2675 const char *str, int unset __maybe_unused)
2677 char spec[PATH_MAX];
2678 const char *script, *ext;
2681 if (strcmp(str, "lang") == 0) {
2682 list_available_languages();
2686 script = strchr(str, ':');
2689 if (len >= PATH_MAX) {
2690 fprintf(stderr, "invalid language specifier");
2693 strncpy(spec, str, len);
2695 scripting_ops = script_spec__lookup(spec);
2696 if (!scripting_ops) {
2697 fprintf(stderr, "invalid language specifier");
2703 ext = strrchr(script, '.');
2705 fprintf(stderr, "invalid script extension");
2708 scripting_ops = script_spec__lookup(++ext);
2709 if (!scripting_ops) {
2710 fprintf(stderr, "invalid script extension");
2715 script_name = strdup(script);
2720 static int parse_output_fields(const struct option *opt __maybe_unused,
2721 const char *arg, int unset __maybe_unused)
2723 char *tok, *strtok_saveptr = NULL;
2724 int i, imax = ARRAY_SIZE(all_output_options);
2727 char *str = strdup(arg);
2729 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2734 /* first word can state for which event type the user is specifying
2735 * the fields. If no type exists, the specified fields apply to all
2736 * event types found in the file minus the invalid fields for a type.
2738 tok = strchr(str, ':');
2742 if (!strcmp(str, "hw"))
2743 type = PERF_TYPE_HARDWARE;
2744 else if (!strcmp(str, "sw"))
2745 type = PERF_TYPE_SOFTWARE;
2746 else if (!strcmp(str, "trace"))
2747 type = PERF_TYPE_TRACEPOINT;
2748 else if (!strcmp(str, "raw"))
2749 type = PERF_TYPE_RAW;
2750 else if (!strcmp(str, "break"))
2751 type = PERF_TYPE_BREAKPOINT;
2752 else if (!strcmp(str, "synth"))
2753 type = OUTPUT_TYPE_SYNTH;
2755 fprintf(stderr, "Invalid event type in field string.\n");
2760 if (output[type].user_set)
2761 pr_warning("Overriding previous field request for %s events.\n",
2764 /* Don't override defaults for +- */
2765 if (strchr(tok, '+') || strchr(tok, '-'))
2768 output[type].fields = 0;
2769 output[type].user_set = true;
2770 output[type].wildcard_set = false;
2774 if (strlen(str) == 0) {
2776 "Cannot set fields to 'none' for all event types.\n");
2781 /* Don't override defaults for +- */
2782 if (strchr(str, '+') || strchr(str, '-'))
2785 if (output_set_by_user())
2786 pr_warning("Overriding previous field request for all events.\n");
2788 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2789 output[j].fields = 0;
2790 output[j].user_set = true;
2791 output[j].wildcard_set = true;
2796 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2802 } else if (*tok == '-') {
2808 if (change != SET && change != DEFAULT)
2813 for (i = 0; i < imax; ++i) {
2814 if (strcmp(tok, all_output_options[i].str) == 0)
2817 if (i == imax && strcmp(tok, "flags") == 0) {
2818 print_flags = change != REMOVE;
2822 fprintf(stderr, "Invalid field requested.\n");
2828 /* add user option to all events types for
2831 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2832 if (output[j].invalid_fields & all_output_options[i].field) {
2833 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2834 all_output_options[i].str, event_type(j));
2836 if (change == REMOVE) {
2837 output[j].fields &= ~all_output_options[i].field;
2838 output[j].user_set_fields &= ~all_output_options[i].field;
2839 output[j].user_unset_fields |= all_output_options[i].field;
2841 output[j].fields |= all_output_options[i].field;
2842 output[j].user_set_fields |= all_output_options[i].field;
2843 output[j].user_unset_fields &= ~all_output_options[i].field;
2845 output[j].user_set = true;
2846 output[j].wildcard_set = true;
2850 if (output[type].invalid_fields & all_output_options[i].field) {
2851 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2852 all_output_options[i].str, event_type(type));
2857 if (change == REMOVE)
2858 output[type].fields &= ~all_output_options[i].field;
2860 output[type].fields |= all_output_options[i].field;
2861 output[type].user_set = true;
2862 output[type].wildcard_set = true;
2867 if (output[type].fields == 0) {
2868 pr_debug("No fields requested for %s type. "
2869 "Events will not be displayed.\n", event_type(type));
2875 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2882 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2883 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2884 if ((lang_dirent->d_type == DT_DIR || \
2885 (lang_dirent->d_type == DT_UNKNOWN && \
2886 is_directory(scripts_path, lang_dirent))) && \
2887 (strcmp(lang_dirent->d_name, ".")) && \
2888 (strcmp(lang_dirent->d_name, "..")))
2890 #define for_each_script(lang_path, lang_dir, script_dirent) \
2891 while ((script_dirent = readdir(lang_dir)) != NULL) \
2892 if (script_dirent->d_type != DT_DIR && \
2893 (script_dirent->d_type != DT_UNKNOWN || \
2894 !is_directory(lang_path, script_dirent)))
2897 #define RECORD_SUFFIX "-record"
2898 #define REPORT_SUFFIX "-report"
2900 struct script_desc {
2901 struct list_head node;
2907 static LIST_HEAD(script_descs);
2909 static struct script_desc *script_desc__new(const char *name)
2911 struct script_desc *s = zalloc(sizeof(*s));
2913 if (s != NULL && name)
2914 s->name = strdup(name);
2919 static void script_desc__delete(struct script_desc *s)
2922 zfree(&s->half_liner);
2927 static void script_desc__add(struct script_desc *s)
2929 list_add_tail(&s->node, &script_descs);
2932 static struct script_desc *script_desc__find(const char *name)
2934 struct script_desc *s;
2936 list_for_each_entry(s, &script_descs, node)
2937 if (strcasecmp(s->name, name) == 0)
2942 static struct script_desc *script_desc__findnew(const char *name)
2944 struct script_desc *s = script_desc__find(name);
2949 s = script_desc__new(name);
2953 script_desc__add(s);
2958 static const char *ends_with(const char *str, const char *suffix)
2960 size_t suffix_len = strlen(suffix);
2961 const char *p = str;
2963 if (strlen(str) > suffix_len) {
2964 p = str + strlen(str) - suffix_len;
2965 if (!strncmp(p, suffix, suffix_len))
2972 static int read_script_info(struct script_desc *desc, const char *filename)
2974 char line[BUFSIZ], *p;
2977 fp = fopen(filename, "r");
2981 while (fgets(line, sizeof(line), fp)) {
2982 p = skip_spaces(line);
2988 if (strlen(p) && *p == '!')
2992 if (strlen(p) && p[strlen(p) - 1] == '\n')
2993 p[strlen(p) - 1] = '\0';
2995 if (!strncmp(p, "description:", strlen("description:"))) {
2996 p += strlen("description:");
2997 desc->half_liner = strdup(skip_spaces(p));
3001 if (!strncmp(p, "args:", strlen("args:"))) {
3002 p += strlen("args:");
3003 desc->args = strdup(skip_spaces(p));
3013 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3015 char *script_root, *str;
3017 script_root = strdup(script_dirent->d_name);
3021 str = (char *)ends_with(script_root, suffix);
3031 static int list_available_scripts(const struct option *opt __maybe_unused,
3032 const char *s __maybe_unused,
3033 int unset __maybe_unused)
3035 struct dirent *script_dirent, *lang_dirent;
3036 char scripts_path[MAXPATHLEN];
3037 DIR *scripts_dir, *lang_dir;
3038 char script_path[MAXPATHLEN];
3039 char lang_path[MAXPATHLEN];
3040 struct script_desc *desc;
3041 char first_half[BUFSIZ];
3044 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3046 scripts_dir = opendir(scripts_path);
3049 "open(%s) failed.\n"
3050 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3055 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3056 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3057 lang_dirent->d_name);
3058 lang_dir = opendir(lang_path);
3062 for_each_script(lang_path, lang_dir, script_dirent) {
3063 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3065 desc = script_desc__findnew(script_root);
3066 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3067 lang_path, script_dirent->d_name);
3068 read_script_info(desc, script_path);
3074 fprintf(stdout, "List of available trace scripts:\n");
3075 list_for_each_entry(desc, &script_descs, node) {
3076 sprintf(first_half, "%s %s", desc->name,
3077 desc->args ? desc->args : "");
3078 fprintf(stdout, " %-36s %s\n", first_half,
3079 desc->half_liner ? desc->half_liner : "");
3086 * Some scripts specify the required events in their "xxx-record" file,
3087 * this function will check if the events in perf.data match those
3088 * mentioned in the "xxx-record".
3090 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3091 * which is covered well now. And new parsing code should be added to
3092 * cover the future complex formats like event groups etc.
3094 static int check_ev_match(char *dir_name, char *scriptname,
3095 struct perf_session *session)
3097 char filename[MAXPATHLEN], evname[128];
3098 char line[BUFSIZ], *p;
3103 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3105 fp = fopen(filename, "r");
3109 while (fgets(line, sizeof(line), fp)) {
3110 p = skip_spaces(line);
3115 p = strstr(p, "-e");
3121 len = strcspn(p, " \t");
3125 snprintf(evname, len + 1, "%s", p);
3128 evlist__for_each_entry(session->evlist, pos) {
3129 if (!strcmp(evsel__name(pos), evname)) {
3147 * Return -1 if none is found, otherwise the actual scripts number.
3149 * Currently the only user of this function is the script browser, which
3150 * will list all statically runnable scripts, select one, execute it and
3151 * show the output in a perf browser.
3153 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3156 struct dirent *script_dirent, *lang_dirent;
3157 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3158 DIR *scripts_dir, *lang_dir;
3159 struct perf_session *session;
3160 struct perf_data data = {
3162 .mode = PERF_DATA_MODE_READ,
3167 session = perf_session__new(&data, false, NULL);
3168 if (IS_ERR(session))
3169 return PTR_ERR(session);
3171 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3173 scripts_dir = opendir(scripts_path);
3175 perf_session__delete(session);
3179 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3180 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3181 lang_dirent->d_name);
3182 #ifndef HAVE_LIBPERL_SUPPORT
3183 if (strstr(lang_path, "perl"))
3186 #ifndef HAVE_LIBPYTHON_SUPPORT
3187 if (strstr(lang_path, "python"))
3191 lang_dir = opendir(lang_path);
3195 for_each_script(lang_path, lang_dir, script_dirent) {
3196 /* Skip those real time scripts: xxxtop.p[yl] */
3197 if (strstr(script_dirent->d_name, "top."))
3201 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3203 script_dirent->d_name);
3204 temp = strchr(script_dirent->d_name, '.');
3205 snprintf(scripts_array[i],
3206 (temp - script_dirent->d_name) + 1,
3207 "%s", script_dirent->d_name);
3209 if (check_ev_match(lang_path,
3210 scripts_array[i], session))
3218 closedir(scripts_dir);
3219 perf_session__delete(session);
3223 static char *get_script_path(const char *script_root, const char *suffix)
3225 struct dirent *script_dirent, *lang_dirent;
3226 char scripts_path[MAXPATHLEN];
3227 char script_path[MAXPATHLEN];
3228 DIR *scripts_dir, *lang_dir;
3229 char lang_path[MAXPATHLEN];
3230 char *__script_root;
3232 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3234 scripts_dir = opendir(scripts_path);
3238 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3239 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3240 lang_dirent->d_name);
3241 lang_dir = opendir(lang_path);
3245 for_each_script(lang_path, lang_dir, script_dirent) {
3246 __script_root = get_script_root(script_dirent, suffix);
3247 if (__script_root && !strcmp(script_root, __script_root)) {
3248 free(__script_root);
3249 closedir(scripts_dir);
3250 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3251 lang_path, script_dirent->d_name);
3253 return strdup(script_path);
3255 free(__script_root);
3259 closedir(scripts_dir);
3264 static bool is_top_script(const char *script_path)
3266 return ends_with(script_path, "top") != NULL;
3269 static int has_required_arg(char *script_path)
3271 struct script_desc *desc;
3275 desc = script_desc__new(NULL);
3277 if (read_script_info(desc, script_path))
3283 for (p = desc->args; *p; p++)
3287 script_desc__delete(desc);
3292 static int have_cmd(int argc, const char **argv)
3294 char **__argv = malloc(sizeof(const char *) * argc);
3297 pr_err("malloc failed\n");
3301 memcpy(__argv, argv, sizeof(const char *) * argc);
3302 argc = parse_options(argc, (const char **)__argv, record_options,
3303 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3306 system_wide = (argc == 0);
3311 static void script__setup_sample_type(struct perf_script *script)
3313 struct perf_session *session = script->session;
3314 u64 sample_type = evlist__combined_sample_type(session->evlist);
3316 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3317 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3318 (sample_type & PERF_SAMPLE_STACK_USER)) {
3319 callchain_param.record_mode = CALLCHAIN_DWARF;
3320 dwarf_callchain_users = true;
3321 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3322 callchain_param.record_mode = CALLCHAIN_LBR;
3324 callchain_param.record_mode = CALLCHAIN_FP;
3327 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3328 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3329 "Please apply --call-graph lbr when recording.\n");
3330 script->stitch_lbr = false;
3334 static int process_stat_round_event(struct perf_session *session,
3335 union perf_event *event)
3337 struct perf_record_stat_round *round = &event->stat_round;
3338 struct evsel *counter;
3340 evlist__for_each_entry(session->evlist, counter) {
3341 perf_stat_process_counter(&stat_config, counter);
3342 process_stat(counter, round->time);
3345 process_stat_interval(round->time);
3349 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3350 union perf_event *event)
3352 perf_event__read_stat_config(&stat_config, &event->stat_config);
3356 static int set_maps(struct perf_script *script)
3358 struct evlist *evlist = script->session->evlist;
3360 if (!script->cpus || !script->threads)
3363 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3366 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3368 if (evlist__alloc_stats(evlist, true))
3371 script->allocated = true;
3376 int process_thread_map_event(struct perf_session *session,
3377 union perf_event *event)
3379 struct perf_tool *tool = session->tool;
3380 struct perf_script *script = container_of(tool, struct perf_script, tool);
3382 if (script->threads) {
3383 pr_warning("Extra thread map event, ignoring.\n");
3387 script->threads = thread_map__new_event(&event->thread_map);
3388 if (!script->threads)
3391 return set_maps(script);
3395 int process_cpu_map_event(struct perf_session *session,
3396 union perf_event *event)
3398 struct perf_tool *tool = session->tool;
3399 struct perf_script *script = container_of(tool, struct perf_script, tool);
3402 pr_warning("Extra cpu map event, ignoring.\n");
3406 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3410 return set_maps(script);
3413 static int process_feature_event(struct perf_session *session,
3414 union perf_event *event)
3416 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3417 return perf_event__process_feature(session, event);
3421 #ifdef HAVE_AUXTRACE_SUPPORT
3422 static int perf_script__process_auxtrace_info(struct perf_session *session,
3423 union perf_event *event)
3425 struct perf_tool *tool = session->tool;
3427 int ret = perf_event__process_auxtrace_info(session, event);
3430 struct perf_script *script = container_of(tool, struct perf_script, tool);
3432 ret = perf_script__setup_per_event_dump(script);
3438 #define perf_script__process_auxtrace_info 0
3441 static int parse_insn_trace(const struct option *opt __maybe_unused,
3442 const char *str __maybe_unused,
3443 int unset __maybe_unused)
3445 parse_output_fields(NULL, "+insn,-event,-period", 0);
3446 itrace_parse_synth_opts(opt, "i0ns", 0);
3447 symbol_conf.nanosecs = true;
3451 static int parse_xed(const struct option *opt __maybe_unused,
3452 const char *str __maybe_unused,
3453 int unset __maybe_unused)
3456 force_pager("xed -F insn: -A -64 | less");
3458 force_pager("xed -F insn: -A -64");
3462 static int parse_call_trace(const struct option *opt __maybe_unused,
3463 const char *str __maybe_unused,
3464 int unset __maybe_unused)
3466 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3467 itrace_parse_synth_opts(opt, "cewp", 0);
3468 symbol_conf.nanosecs = true;
3469 symbol_conf.pad_output_len_dso = 50;
3473 static int parse_callret_trace(const struct option *opt __maybe_unused,
3474 const char *str __maybe_unused,
3475 int unset __maybe_unused)
3477 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3478 itrace_parse_synth_opts(opt, "crewp", 0);
3479 symbol_conf.nanosecs = true;
3483 int cmd_script(int argc, const char **argv)
3485 bool show_full_info = false;
3486 bool header = false;
3487 bool header_only = false;
3488 bool script_started = false;
3489 char *rec_script_path = NULL;
3490 char *rep_script_path = NULL;
3491 struct perf_session *session;
3492 struct itrace_synth_opts itrace_synth_opts = {
3494 .default_no_sample = true,
3497 char *script_path = NULL;
3498 const char **__argv;
3500 struct perf_script script = {
3502 .sample = process_sample_event,
3503 .mmap = perf_event__process_mmap,
3504 .mmap2 = perf_event__process_mmap2,
3505 .comm = perf_event__process_comm,
3506 .namespaces = perf_event__process_namespaces,
3507 .cgroup = perf_event__process_cgroup,
3508 .exit = perf_event__process_exit,
3509 .fork = perf_event__process_fork,
3510 .attr = process_attr,
3511 .event_update = perf_event__process_event_update,
3512 .tracing_data = perf_event__process_tracing_data,
3513 .feature = process_feature_event,
3514 .build_id = perf_event__process_build_id,
3515 .id_index = perf_event__process_id_index,
3516 .auxtrace_info = perf_script__process_auxtrace_info,
3517 .auxtrace = perf_event__process_auxtrace,
3518 .auxtrace_error = perf_event__process_auxtrace_error,
3519 .stat = perf_event__process_stat_event,
3520 .stat_round = process_stat_round_event,
3521 .stat_config = process_stat_config_event,
3522 .thread_map = process_thread_map_event,
3523 .cpu_map = process_cpu_map_event,
3524 .ordered_events = true,
3525 .ordering_requires_timestamps = true,
3528 struct perf_data data = {
3529 .mode = PERF_DATA_MODE_READ,
3531 const struct option options[] = {
3532 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3533 "dump raw trace in ASCII"),
3534 OPT_INCR('v', "verbose", &verbose,
3535 "be more verbose (show symbol address, etc)"),
3536 OPT_BOOLEAN('L', "Latency", &latency_format,
3537 "show latency attributes (irqs/preemption disabled, etc)"),
3538 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3539 list_available_scripts),
3540 OPT_CALLBACK('s', "script", NULL, "name",
3541 "script file name (lang:script name, script name, or *)",
3543 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3544 "generate perf-script.xx script in specified language"),
3545 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3546 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3547 "do various checks like samples ordering and lost events"),
3548 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3549 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3550 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3551 "file", "vmlinux pathname"),
3552 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3553 "file", "kallsyms pathname"),
3554 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3555 "When printing symbols do not display call chain"),
3556 OPT_CALLBACK(0, "symfs", NULL, "directory",
3557 "Look for files with symbols relative to this directory",
3558 symbol__config_symfs),
3559 OPT_CALLBACK('F', "fields", NULL, "str",
3560 "comma separated output fields prepend with 'type:'. "
3561 "+field to add and -field to remove."
3562 "Valid types: hw,sw,trace,raw,synth. "
3563 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3564 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3565 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3566 "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod,"
3567 "data_page_size,code_page_size",
3568 parse_output_fields),
3569 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3570 "system-wide collection from all CPUs"),
3571 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3572 "only consider symbols in these DSOs"),
3573 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3574 "only consider these symbols"),
3575 OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3576 "Use with -S to list traced records within address range"),
3577 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3578 "Decode instructions from itrace", parse_insn_trace),
3579 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3580 "Run xed disassembler on output", parse_xed),
3581 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3582 "Decode calls from from itrace", parse_call_trace),
3583 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3584 "Decode calls and returns from itrace", parse_callret_trace),
3585 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3586 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3587 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3588 "Stop display of callgraph at these symbols"),
3589 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3590 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3591 "only display events for these comms"),
3592 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3593 "only consider symbols in these pids"),
3594 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3595 "only consider symbols in these tids"),
3596 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3597 "Set the maximum stack depth when parsing the callchain, "
3598 "anything beyond the specified depth will be ignored. "
3599 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3600 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3601 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3602 OPT_BOOLEAN('I', "show-info", &show_full_info,
3603 "display extended information from perf.data file"),
3604 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3605 "Show the path of [kernel.kallsyms]"),
3606 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3607 "Show the fork/comm/exit events"),
3608 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3609 "Show the mmap events"),
3610 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3611 "Show context switch events (if recorded)"),
3612 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3613 "Show namespace events (if recorded)"),
3614 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3615 "Show cgroup events (if recorded)"),
3616 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3617 "Show lost events (if recorded)"),
3618 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3619 "Show round events (if recorded)"),
3620 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3621 "Show bpf related events (if recorded)"),
3622 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3623 "Show text poke related events (if recorded)"),
3624 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3625 "Dump trace output to files named by the monitored events"),
3626 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3627 OPT_INTEGER(0, "max-blocks", &max_blocks,
3628 "Maximum number of code blocks to dump with brstackinsn"),
3629 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3630 "Use 9 decimal places when displaying time"),
3631 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3632 "Instruction Tracing options\n" ITRACE_HELP,
3633 itrace_parse_synth_opts),
3634 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3635 "Show full source file name path for source lines"),
3636 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3637 "Enable symbol demangling"),
3638 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3639 "Enable kernel symbol demangling"),
3640 OPT_STRING(0, "time", &script.time_str, "str",
3641 "Time span of interest (start,stop)"),
3642 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3643 "Show inline function"),
3644 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3645 "guest mount directory under which every guest os"
3646 " instance has a subdir"),
3647 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3648 "file", "file saving guest os vmlinux"),
3649 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3650 "file", "file saving guest os /proc/kallsyms"),
3651 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3652 "file", "file saving guest os /proc/modules"),
3653 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3654 "Enable LBR callgraph stitching approach"),
3655 OPTS_EVSWITCH(&script.evswitch),
3658 const char * const script_subcommands[] = { "record", "report", NULL };
3659 const char *script_usage[] = {
3660 "perf script [<options>]",
3661 "perf script [<options>] record <script> [<record-options>] <command>",
3662 "perf script [<options>] report <script> [script-args]",
3663 "perf script [<options>] <script> [<record-options>] <command>",
3664 "perf script [<options>] <top-script> [script-args]",
3668 perf_set_singlethreaded();
3672 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3673 PARSE_OPT_STOP_AT_NON_OPTION);
3675 if (symbol_conf.guestmount ||
3676 symbol_conf.default_guest_vmlinux_name ||
3677 symbol_conf.default_guest_kallsyms ||
3678 symbol_conf.default_guest_modules) {
3680 * Enable guest sample processing.
3685 data.path = input_name;
3686 data.force = symbol_conf.force;
3688 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3689 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3690 if (!rec_script_path)
3691 return cmd_record(argc, argv);
3694 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3695 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3696 if (!rep_script_path) {
3698 "Please specify a valid report script"
3699 "(see 'perf script -l' for listing)\n");
3704 if (reltime && deltatime) {
3706 "reltime and deltatime - the two don't get along well. "
3707 "Please limit to --reltime or --deltatime.\n");
3711 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3712 itrace_synth_opts.callchain_sz > scripting_max_stack)
3713 scripting_max_stack = itrace_synth_opts.callchain_sz;
3715 /* make sure PERF_EXEC_PATH is set for scripts */
3716 set_argv_exec_path(get_argv_exec_path());
3718 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3723 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3724 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3726 if (!rec_script_path && !rep_script_path) {
3727 usage_with_options_msg(script_usage, options,
3728 "Couldn't find script `%s'\n\n See perf"
3729 " script -l for available scripts.\n", argv[0]);
3732 if (is_top_script(argv[0])) {
3733 rep_args = argc - 1;
3737 rep_args = has_required_arg(rep_script_path);
3738 rec_args = (argc - 1) - rep_args;
3740 usage_with_options_msg(script_usage, options,
3741 "`%s' script requires options."
3742 "\n\n See perf script -l for available "
3743 "scripts and options.\n", argv[0]);
3747 if (pipe(live_pipe) < 0) {
3748 perror("failed to create pipe");
3754 perror("failed to fork");
3761 dup2(live_pipe[1], 1);
3762 close(live_pipe[0]);
3764 if (is_top_script(argv[0])) {
3766 } else if (!system_wide) {
3767 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3773 __argv = malloc((argc + 6) * sizeof(const char *));
3775 pr_err("malloc failed\n");
3780 __argv[j++] = "/bin/sh";
3781 __argv[j++] = rec_script_path;
3787 for (i = rep_args + 1; i < argc; i++)
3788 __argv[j++] = argv[i];
3791 execvp("/bin/sh", (char **)__argv);
3796 dup2(live_pipe[0], 0);
3797 close(live_pipe[1]);
3799 __argv = malloc((argc + 4) * sizeof(const char *));
3801 pr_err("malloc failed\n");
3807 __argv[j++] = "/bin/sh";
3808 __argv[j++] = rep_script_path;
3809 for (i = 1; i < rep_args + 1; i++)
3810 __argv[j++] = argv[i];
3815 execvp("/bin/sh", (char **)__argv);
3820 if (rec_script_path)
3821 script_path = rec_script_path;
3822 if (rep_script_path)
3823 script_path = rep_script_path;
3828 if (!rec_script_path)
3829 system_wide = false;
3830 else if (!system_wide) {
3831 if (have_cmd(argc - 1, &argv[1]) != 0) {
3837 __argv = malloc((argc + 2) * sizeof(const char *));
3839 pr_err("malloc failed\n");
3844 __argv[j++] = "/bin/sh";
3845 __argv[j++] = script_path;
3848 for (i = 2; i < argc; i++)
3849 __argv[j++] = argv[i];
3852 execvp("/bin/sh", (char **)__argv);
3862 session = perf_session__new(&data, false, &script.tool);
3863 if (IS_ERR(session))
3864 return PTR_ERR(session);
3866 if (header || header_only) {
3867 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3868 perf_session__fprintf_info(session, stdout, show_full_info);
3873 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3875 if (symbol__init(&session->header.env) < 0)
3879 if (data.is_pipe || /* assume pipe_mode indicates native_arch */
3880 !strcmp(uts.machine, session->header.env.arch) ||
3881 (!strcmp(uts.machine, "x86_64") &&
3882 !strcmp(session->header.env.arch, "i386")))
3885 script.session = session;
3886 script__setup_sample_type(&script);
3888 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3889 symbol_conf.graph_function)
3890 itrace_synth_opts.thread_stack = true;
3892 session->itrace_synth_opts = &itrace_synth_opts;
3895 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3898 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3902 symbol_conf.use_callchain = true;
3904 symbol_conf.use_callchain = false;
3906 if (session->tevent.pevent &&
3907 tep_set_function_resolver(session->tevent.pevent,
3908 machine__resolve_kernel_addr,
3909 &session->machines.host) < 0) {
3910 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3915 if (generate_script_lang) {
3916 struct stat perf_stat;
3919 if (output_set_by_user()) {
3921 "custom fields not supported for generated scripts");
3926 input = open(data.path, O_RDONLY); /* input_name */
3929 perror("failed to open file");
3933 err = fstat(input, &perf_stat);
3935 perror("failed to stat file");
3939 if (!perf_stat.st_size) {
3940 fprintf(stderr, "zero-sized file, nothing to do!\n");
3944 scripting_ops = script_spec__lookup(generate_script_lang);
3945 if (!scripting_ops) {
3946 fprintf(stderr, "invalid language specifier");
3951 err = scripting_ops->generate_script(session->tevent.pevent,
3957 err = scripting_ops->start_script(script_name, argc, argv);
3960 pr_debug("perf script started with script %s\n\n", script_name);
3961 script_started = true;
3965 err = perf_session__check_output_opt(session);
3969 if (script.time_str) {
3970 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
3971 &script.ptime_range,
3978 itrace_synth_opts__set_time_range(&itrace_synth_opts,
3983 err = evswitch__init(&script.evswitch, session->evlist, stderr);
3987 if (zstd_init(&(session->zstd_data), 0) < 0)
3988 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
3990 err = __cmd_script(&script);
3995 if (script.ptime_range) {
3996 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3997 zfree(&script.ptime_range);
4000 zstd_fini(&(session->zstd_data));
4001 evlist__free_stats(session->evlist);
4002 perf_session__delete(session);
4003 perf_script__exit(&script);
4006 cleanup_scripting();