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 *perf_evsel_script__new(struct evsel *evsel,
318 struct perf_data *data)
320 struct evsel_script *es = zalloc(sizeof(*es));
323 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
325 es->fp = fopen(es->filename, "w");
327 goto out_free_filename;
332 zfree(&es->filename);
338 static void perf_evsel_script__delete(struct evsel_script *es)
340 zfree(&es->filename);
346 static int perf_evsel_script__fprintf(struct evsel_script *es, FILE *fp)
350 fstat(fileno(es->fp), &st);
351 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
352 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
355 static inline int output_type(unsigned int type)
358 case PERF_TYPE_SYNTH:
359 return OUTPUT_TYPE_SYNTH;
361 if (type < PERF_TYPE_MAX)
365 return OUTPUT_TYPE_OTHER;
368 static inline unsigned int attr_type(unsigned int type)
371 case OUTPUT_TYPE_SYNTH:
372 return PERF_TYPE_SYNTH;
378 static bool output_set_by_user(void)
381 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
382 if (output[j].user_set)
388 static const char *output_field2str(enum perf_output_field field)
390 int i, imax = ARRAY_SIZE(all_output_options);
391 const char *str = "";
393 for (i = 0; i < imax; ++i) {
394 if (all_output_options[i].field == field) {
395 str = all_output_options[i].str;
402 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
404 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
405 enum perf_output_field field, bool allow_user_set)
407 struct perf_event_attr *attr = &evsel->core.attr;
408 int type = output_type(attr->type);
411 if (attr->sample_type & sample_type)
414 if (output[type].user_set_fields & field) {
417 evname = evsel__name(evsel);
418 pr_err("Samples for '%s' event do not have %s attribute set. "
419 "Cannot print '%s' field.\n",
420 evname, sample_msg, output_field2str(field));
424 /* user did not ask for it explicitly so remove from the default list */
425 output[type].fields &= ~field;
426 evname = evsel__name(evsel);
427 pr_debug("Samples for '%s' event do not have %s attribute set. "
428 "Skipping '%s' field.\n",
429 evname, sample_msg, output_field2str(field));
434 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
435 enum perf_output_field field)
437 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
440 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
442 struct perf_event_attr *attr = &evsel->core.attr;
445 if (perf_header__has_feat(&session->header, HEADER_STAT))
448 allow_user_set = perf_header__has_feat(&session->header,
451 if (PRINT_FIELD(TRACE) &&
452 !perf_session__has_traces(session, "record -R"))
455 if (PRINT_FIELD(IP)) {
456 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
460 if (PRINT_FIELD(ADDR) &&
461 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
464 if (PRINT_FIELD(DATA_SRC) &&
465 evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
468 if (PRINT_FIELD(WEIGHT) &&
469 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
472 if (PRINT_FIELD(SYM) &&
473 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
474 pr_err("Display of symbols requested but neither sample IP nor "
475 "sample address\navailable. Hence, no addresses to convert "
479 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
480 pr_err("Display of offsets requested but symbol is not"
484 if (PRINT_FIELD(DSO) &&
485 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
486 pr_err("Display of DSO requested but no address to convert.\n");
489 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
490 pr_err("Display of source line number requested but sample IP is not\n"
491 "selected. Hence, no address to lookup the source line number.\n");
494 if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
495 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
496 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
497 "Hint: run 'perf record -b ...'\n");
500 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
501 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
504 if (PRINT_FIELD(TIME) &&
505 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
508 if (PRINT_FIELD(CPU) &&
509 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
512 if (PRINT_FIELD(IREGS) &&
513 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
516 if (PRINT_FIELD(UREGS) &&
517 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
520 if (PRINT_FIELD(PHYS_ADDR) &&
521 evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
524 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
525 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
528 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
529 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
535 static void set_print_ip_opts(struct perf_event_attr *attr)
537 unsigned int type = output_type(attr->type);
539 output[type].print_ip_opts = 0;
541 output[type].print_ip_opts |= EVSEL__PRINT_IP;
543 if (PRINT_FIELD(SYM))
544 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
546 if (PRINT_FIELD(DSO))
547 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
549 if (PRINT_FIELD(SYMOFFSET))
550 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
552 if (PRINT_FIELD(SRCLINE))
553 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
557 * verify all user requested events exist and the samples
558 * have the expected data
560 static int perf_session__check_output_opt(struct perf_session *session)
566 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
567 evsel = perf_session__find_first_evtype(session, attr_type(j));
570 * even if fields is set to 0 (ie., show nothing) event must
571 * exist if user explicitly includes it on the command line
573 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
574 j != OUTPUT_TYPE_SYNTH) {
575 pr_err("%s events do not exist. "
576 "Remove corresponding -F option to proceed.\n",
581 if (evsel && output[j].fields &&
582 evsel__check_attr(evsel, session))
588 set_print_ip_opts(&evsel->core.attr);
589 tod |= output[j].fields & PERF_OUTPUT_TOD;
593 bool use_callchain = false;
594 bool not_pipe = false;
596 evlist__for_each_entry(session->evlist, evsel) {
598 if (evsel__has_callchain(evsel)) {
599 use_callchain = true;
603 if (not_pipe && !use_callchain)
604 symbol_conf.use_callchain = false;
608 * set default for tracepoints to print symbols only
609 * if callchains are present
611 if (symbol_conf.use_callchain &&
612 !output[PERF_TYPE_TRACEPOINT].user_set) {
613 j = PERF_TYPE_TRACEPOINT;
615 evlist__for_each_entry(session->evlist, evsel) {
616 if (evsel->core.attr.type != j)
619 if (evsel__has_callchain(evsel)) {
620 output[j].fields |= PERF_OUTPUT_IP;
621 output[j].fields |= PERF_OUTPUT_SYM;
622 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
623 output[j].fields |= PERF_OUTPUT_DSO;
624 set_print_ip_opts(&evsel->core.attr);
630 if (tod && !session->header.env.clock.enabled) {
631 pr_err("Can't provide 'tod' time, missing clock data. "
632 "Please record with -k/--clockid option.\n");
639 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
645 if (!regs || !regs->regs)
648 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
650 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
651 u64 val = regs->regs[i++];
652 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
658 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
661 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
664 u64 tod_ns, clockid_ns;
665 struct perf_env *env;
672 if (buflen < 64 || !script)
675 env = &script->session->header.env;
676 if (!env->clock.enabled) {
677 scnprintf(buf, buflen, "disabled");
681 clockid_ns = env->clock.clockid_ns;
682 tod_ns = env->clock.tod_ns;
684 if (timestamp > clockid_ns)
685 tod_ns += timestamp - clockid_ns;
687 tod_ns -= clockid_ns - timestamp;
689 sec = (time_t) (tod_ns / NSEC_PER_SEC);
690 nsec = tod_ns - sec * NSEC_PER_SEC;
692 if (localtime_r(&sec, <ime) == NULL) {
693 scnprintf(buf, buflen, "failed");
695 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
697 if (symbol_conf.nanosecs) {
698 snprintf(buf, buflen, "%s.%09lu", date, nsec);
700 snprintf(buf, buflen, "%s.%06lu",
701 date, nsec / NSEC_PER_USEC);
708 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
709 struct perf_event_attr *attr, FILE *fp)
711 return perf_sample__fprintf_regs(&sample->intr_regs,
712 attr->sample_regs_intr, fp);
715 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
716 struct perf_event_attr *attr, FILE *fp)
718 return perf_sample__fprintf_regs(&sample->user_regs,
719 attr->sample_regs_user, fp);
722 static int perf_sample__fprintf_start(struct perf_script *script,
723 struct perf_sample *sample,
724 struct thread *thread,
728 struct perf_event_attr *attr = &evsel->core.attr;
730 unsigned long long nsecs;
734 if (PRINT_FIELD(COMM)) {
735 const char *comm = thread ? thread__comm_str(thread) : ":-1";
738 printed += fprintf(fp, "%8.8s ", comm);
739 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
740 printed += fprintf(fp, "%s ", comm);
742 printed += fprintf(fp, "%16s ", comm);
745 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
746 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
747 else if (PRINT_FIELD(PID))
748 printed += fprintf(fp, "%5d ", sample->pid);
749 else if (PRINT_FIELD(TID))
750 printed += fprintf(fp, "%5d ", sample->tid);
752 if (PRINT_FIELD(CPU)) {
754 printed += fprintf(fp, "%3d ", sample->cpu);
756 printed += fprintf(fp, "[%03d] ", sample->cpu);
759 if (PRINT_FIELD(MISC)) {
763 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
766 ret += fprintf(fp, "K");
768 ret += fprintf(fp, "U");
770 ret += fprintf(fp, "H");
771 if (has(GUEST_KERNEL))
772 ret += fprintf(fp, "G");
774 ret += fprintf(fp, "g");
777 case PERF_RECORD_MMAP:
778 case PERF_RECORD_MMAP2:
780 ret += fprintf(fp, "M");
782 case PERF_RECORD_COMM:
784 ret += fprintf(fp, "E");
786 case PERF_RECORD_SWITCH:
787 case PERF_RECORD_SWITCH_CPU_WIDE:
788 if (has(SWITCH_OUT)) {
789 ret += fprintf(fp, "S");
790 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
791 ret += fprintf(fp, "p");
799 ret += fprintf(fp, "%*s", 6 - ret, " ");
803 if (PRINT_FIELD(TOD)) {
804 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
805 printed += fprintf(fp, "%s ", tstr);
808 if (PRINT_FIELD(TIME)) {
809 u64 t = sample->time;
812 initial_time = sample->time;
813 t = sample->time - initial_time;
814 } else if (deltatime) {
816 t = sample->time - previous_time;
820 previous_time = sample->time;
823 secs = nsecs / NSEC_PER_SEC;
824 nsecs -= secs * NSEC_PER_SEC;
826 if (symbol_conf.nanosecs)
827 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
829 char sample_time[32];
830 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
831 printed += fprintf(fp, "%12s: ", sample_time);
839 mispred_str(struct branch_entry *br)
841 if (!(br->flags.mispred || br->flags.predicted))
844 return br->flags.predicted ? 'P' : 'M';
847 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
848 struct thread *thread,
849 struct perf_event_attr *attr, FILE *fp)
851 struct branch_stack *br = sample->branch_stack;
852 struct branch_entry *entries = perf_sample__branch_entries(sample);
853 struct addr_location alf, alt;
860 for (i = 0; i < br->nr; i++) {
861 from = entries[i].from;
864 if (PRINT_FIELD(DSO)) {
865 memset(&alf, 0, sizeof(alf));
866 memset(&alt, 0, sizeof(alt));
867 thread__find_map_fb(thread, sample->cpumode, from, &alf);
868 thread__find_map_fb(thread, sample->cpumode, to, &alt);
871 printed += fprintf(fp, " 0x%"PRIx64, from);
872 if (PRINT_FIELD(DSO)) {
873 printed += fprintf(fp, "(");
874 printed += map__fprintf_dsoname(alf.map, fp);
875 printed += fprintf(fp, ")");
878 printed += fprintf(fp, "/0x%"PRIx64, to);
879 if (PRINT_FIELD(DSO)) {
880 printed += fprintf(fp, "(");
881 printed += map__fprintf_dsoname(alt.map, fp);
882 printed += fprintf(fp, ")");
885 printed += fprintf(fp, "/%c/%c/%c/%d ",
886 mispred_str(entries + i),
887 entries[i].flags.in_tx ? 'X' : '-',
888 entries[i].flags.abort ? 'A' : '-',
889 entries[i].flags.cycles);
895 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
896 struct thread *thread,
897 struct perf_event_attr *attr, FILE *fp)
899 struct branch_stack *br = sample->branch_stack;
900 struct branch_entry *entries = perf_sample__branch_entries(sample);
901 struct addr_location alf, alt;
908 for (i = 0; i < br->nr; i++) {
910 memset(&alf, 0, sizeof(alf));
911 memset(&alt, 0, sizeof(alt));
912 from = entries[i].from;
915 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
916 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
918 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
919 if (PRINT_FIELD(DSO)) {
920 printed += fprintf(fp, "(");
921 printed += map__fprintf_dsoname(alf.map, fp);
922 printed += fprintf(fp, ")");
924 printed += fprintf(fp, "%c", '/');
925 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
926 if (PRINT_FIELD(DSO)) {
927 printed += fprintf(fp, "(");
928 printed += map__fprintf_dsoname(alt.map, fp);
929 printed += fprintf(fp, ")");
931 printed += fprintf(fp, "/%c/%c/%c/%d ",
932 mispred_str(entries + i),
933 entries[i].flags.in_tx ? 'X' : '-',
934 entries[i].flags.abort ? 'A' : '-',
935 entries[i].flags.cycles);
941 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
942 struct thread *thread,
943 struct perf_event_attr *attr, FILE *fp)
945 struct branch_stack *br = sample->branch_stack;
946 struct branch_entry *entries = perf_sample__branch_entries(sample);
947 struct addr_location alf, alt;
954 for (i = 0; i < br->nr; i++) {
956 memset(&alf, 0, sizeof(alf));
957 memset(&alt, 0, sizeof(alt));
958 from = entries[i].from;
961 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
962 !alf.map->dso->adjust_symbols)
963 from = map__map_ip(alf.map, from);
965 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
966 !alt.map->dso->adjust_symbols)
967 to = map__map_ip(alt.map, to);
969 printed += fprintf(fp, " 0x%"PRIx64, from);
970 if (PRINT_FIELD(DSO)) {
971 printed += fprintf(fp, "(");
972 printed += map__fprintf_dsoname(alf.map, fp);
973 printed += fprintf(fp, ")");
975 printed += fprintf(fp, "/0x%"PRIx64, to);
976 if (PRINT_FIELD(DSO)) {
977 printed += fprintf(fp, "(");
978 printed += map__fprintf_dsoname(alt.map, fp);
979 printed += fprintf(fp, ")");
981 printed += fprintf(fp, "/%c/%c/%c/%d ",
982 mispred_str(entries + i),
983 entries[i].flags.in_tx ? 'X' : '-',
984 entries[i].flags.abort ? 'A' : '-',
985 entries[i].flags.cycles);
990 #define MAXBB 16384UL
992 static int grab_bb(u8 *buffer, u64 start, u64 end,
993 struct machine *machine, struct thread *thread,
994 bool *is64bit, u8 *cpumode, bool last)
997 struct addr_location al;
1003 kernel = machine__kernel_ip(machine, start);
1005 *cpumode = PERF_RECORD_MISC_KERNEL;
1007 *cpumode = PERF_RECORD_MISC_USER;
1010 * Block overlaps between kernel and user.
1011 * This can happen due to ring filtering
1012 * On Intel CPUs the entry into the kernel is filtered,
1013 * but the exit is not. Let the caller patch it up.
1015 if (kernel != machine__kernel_ip(machine, end)) {
1016 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1020 memset(&al, 0, sizeof(al));
1021 if (end - start > MAXBB - MAXINSN) {
1023 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1025 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1029 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1030 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1033 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1034 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1038 /* Load maps to ensure dso->is_64_bit has been updated */
1041 offset = al.map->map_ip(al.map, start);
1042 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1043 end - start + MAXINSN);
1045 *is64bit = al.map->dso->is_64_bit;
1047 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1052 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1060 if (!map || !map->dso)
1062 srcfile = get_srcline_split(map->dso,
1063 map__rip_2objdump(map, addr),
1068 /* Avoid redundant printing */
1071 !strcmp(state->srcfile, srcfile) &&
1072 state->line == line) {
1077 srccode = find_sourceline(srcfile, line, &len);
1081 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1084 state->srcfile = srcfile;
1094 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1096 struct addr_location al;
1099 memset(&al, 0, sizeof(al));
1100 thread__find_map(thread, cpumode, addr, &al);
1103 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1104 &thread->srccode_state);
1106 ret += printf("\n");
1110 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1111 struct perf_insn *x, u8 *inbuf, int len,
1112 int insn, FILE *fp, int *total_cycles)
1114 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
1115 dump_insn(x, ip, inbuf, len, NULL),
1116 en->flags.predicted ? " PRED" : "",
1117 en->flags.mispred ? " MISPRED" : "",
1118 en->flags.in_tx ? " INTX" : "",
1119 en->flags.abort ? " ABORT" : "");
1120 if (en->flags.cycles) {
1121 *total_cycles += en->flags.cycles;
1122 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1124 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1126 return printed + fprintf(fp, "\n");
1129 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1130 u8 cpumode, int cpu, struct symbol **lastsym,
1131 struct perf_event_attr *attr, FILE *fp)
1133 struct addr_location al;
1134 int off, printed = 0;
1136 memset(&al, 0, sizeof(al));
1138 thread__find_map(thread, cpumode, addr, &al);
1140 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1146 al.sym = map__find_symbol(al.map, al.addr);
1151 if (al.addr < al.sym->end)
1152 off = al.addr - al.sym->start;
1154 off = al.addr - al.map->start - al.sym->start;
1155 printed += fprintf(fp, "\t%s", al.sym->name);
1157 printed += fprintf(fp, "%+d", off);
1158 printed += fprintf(fp, ":");
1159 if (PRINT_FIELD(SRCLINE))
1160 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1161 printed += fprintf(fp, "\n");
1167 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1168 struct thread *thread,
1169 struct perf_event_attr *attr,
1170 struct machine *machine, FILE *fp)
1172 struct branch_stack *br = sample->branch_stack;
1173 struct branch_entry *entries = perf_sample__branch_entries(sample);
1175 int i, insn, len, nr, ilen, printed = 0;
1179 struct symbol *lastsym = NULL;
1180 int total_cycles = 0;
1182 if (!(br && br->nr))
1185 if (max_blocks && nr > max_blocks + 1)
1186 nr = max_blocks + 1;
1189 x.cpu = sample->cpu;
1191 printed += fprintf(fp, "%c", '\n');
1193 /* Handle first from jump, of which we don't know the entry. */
1194 len = grab_bb(buffer, entries[nr-1].from,
1196 machine, thread, &x.is64bit, &x.cpumode, false);
1198 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1199 x.cpumode, x.cpu, &lastsym, attr, fp);
1200 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1201 &x, buffer, len, 0, fp, &total_cycles);
1202 if (PRINT_FIELD(SRCCODE))
1203 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1206 /* Print all blocks */
1207 for (i = nr - 2; i >= 0; i--) {
1208 if (entries[i].from || entries[i].to)
1209 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1212 start = entries[i + 1].to;
1213 end = entries[i].from;
1215 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1216 /* Patch up missing kernel transfers due to ring filters */
1217 if (len == -ENXIO && i > 0) {
1218 end = entries[--i].from;
1219 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1220 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1226 for (off = 0; off < (unsigned)len; off += ilen) {
1227 uint64_t ip = start + off;
1229 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1231 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1233 if (PRINT_FIELD(SRCCODE))
1234 printed += print_srccode(thread, x.cpumode, ip);
1238 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1239 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1242 if (PRINT_FIELD(SRCCODE))
1243 print_srccode(thread, x.cpumode, ip);
1247 if (off != end - start)
1248 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1252 * Hit the branch? In this case we are already done, and the target
1253 * has not been executed yet.
1255 if (entries[0].from == sample->ip)
1257 if (entries[0].flags.abort)
1261 * Print final block upto sample
1263 * Due to pipeline delays the LBRs might be missing a branch
1264 * or two, which can result in very large or negative blocks
1265 * between final branch and sample. When this happens just
1266 * continue walking after the last TO until we hit a branch.
1268 start = entries[0].to;
1271 /* Missing jump. Scan 128 bytes for the next branch */
1274 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1275 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1277 /* Print at least last IP if basic block did not work */
1278 len = grab_bb(buffer, sample->ip, sample->ip,
1279 machine, thread, &x.is64bit, &x.cpumode, false);
1282 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1283 dump_insn(&x, sample->ip, buffer, len, NULL));
1284 if (PRINT_FIELD(SRCCODE))
1285 print_srccode(thread, x.cpumode, sample->ip);
1288 for (off = 0; off <= end - start; off += ilen) {
1290 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1291 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1294 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1296 * Hit a missing branch. Just stop.
1298 printed += fprintf(fp, "\t... not reaching sample ...\n");
1301 if (PRINT_FIELD(SRCCODE))
1302 print_srccode(thread, x.cpumode, start + off);
1308 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1309 struct thread *thread,
1310 struct perf_event_attr *attr, FILE *fp)
1312 struct addr_location al;
1313 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1315 if (!sample_addr_correlates_sym(attr))
1318 thread__resolve(thread, &al, sample);
1320 if (PRINT_FIELD(SYM)) {
1321 printed += fprintf(fp, " ");
1322 if (PRINT_FIELD(SYMOFFSET))
1323 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1325 printed += symbol__fprintf_symname(al.sym, fp);
1328 if (PRINT_FIELD(DSO)) {
1329 printed += fprintf(fp, " (");
1330 printed += map__fprintf_dsoname(al.map, fp);
1331 printed += fprintf(fp, ")");
1337 static const char *resolve_branch_sym(struct perf_sample *sample,
1338 struct evsel *evsel,
1339 struct thread *thread,
1340 struct addr_location *al,
1343 struct addr_location addr_al;
1344 struct perf_event_attr *attr = &evsel->core.attr;
1345 const char *name = NULL;
1347 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1348 if (sample_addr_correlates_sym(attr)) {
1349 thread__resolve(thread, &addr_al, sample);
1351 name = addr_al.sym->name;
1357 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1359 name = al->sym->name;
1366 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1367 struct evsel *evsel,
1368 struct thread *thread,
1369 struct addr_location *al, FILE *fp)
1371 struct perf_event_attr *attr = &evsel->core.attr;
1372 size_t depth = thread_stack__depth(thread, sample->cpu);
1373 const char *name = NULL;
1380 * The 'return' has already been popped off the stack so the depth has
1381 * to be adjusted to match the 'call'.
1383 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1386 name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1388 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1389 dlen += fprintf(fp, "(");
1390 dlen += map__fprintf_dsoname(al->map, fp);
1391 dlen += fprintf(fp, ")\t");
1395 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1397 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1403 * Try to keep the output length from changing frequently so that the
1404 * output lines up more nicely.
1406 if (len > spacing || (len && len < spacing - 52))
1407 spacing = round_up(len + 4, 32);
1410 len += fprintf(fp, "%*s", spacing - len, "");
1415 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1416 struct thread *thread __maybe_unused,
1417 struct machine *machine __maybe_unused)
1421 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1422 struct perf_event_attr *attr,
1423 struct thread *thread,
1424 struct machine *machine, FILE *fp)
1428 if (sample->insn_len == 0 && native_arch)
1429 arch_fetch_insn(sample, thread, machine);
1431 if (PRINT_FIELD(INSNLEN))
1432 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1433 if (PRINT_FIELD(INSN) && sample->insn_len) {
1436 printed += fprintf(fp, " insn:");
1437 for (i = 0; i < sample->insn_len; i++)
1438 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1440 if (PRINT_FIELD(BRSTACKINSN))
1441 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1446 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1447 struct perf_event_attr *attr, FILE *fp)
1451 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1454 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1456 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1457 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1460 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1461 struct evsel *evsel,
1462 struct thread *thread,
1463 struct addr_location *al,
1464 struct machine *machine, FILE *fp)
1466 struct perf_event_attr *attr = &evsel->core.attr;
1467 unsigned int type = output_type(attr->type);
1468 bool print_srcline_last = false;
1471 if (PRINT_FIELD(CALLINDENT))
1472 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1474 /* print branch_from information */
1475 if (PRINT_FIELD(IP)) {
1476 unsigned int print_opts = output[type].print_ip_opts;
1477 struct callchain_cursor *cursor = NULL;
1479 if (symbol_conf.use_callchain && sample->callchain &&
1480 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1481 sample, NULL, NULL, scripting_max_stack) == 0)
1482 cursor = &callchain_cursor;
1484 if (cursor == NULL) {
1485 printed += fprintf(fp, " ");
1486 if (print_opts & EVSEL__PRINT_SRCLINE) {
1487 print_srcline_last = true;
1488 print_opts &= ~EVSEL__PRINT_SRCLINE;
1491 printed += fprintf(fp, "\n");
1493 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1494 symbol_conf.bt_stop_list, fp);
1497 /* print branch_to information */
1498 if (PRINT_FIELD(ADDR) ||
1499 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1500 !output[type].user_set)) {
1501 printed += fprintf(fp, " => ");
1502 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1505 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1507 if (print_srcline_last)
1508 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1510 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1511 printed += fprintf(fp, "\n");
1512 if (PRINT_FIELD(SRCCODE)) {
1513 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1514 &thread->srccode_state);
1517 printed += printf("\n");
1526 } sample_flags[] = {
1527 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1528 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1529 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1530 {PERF_IP_FLAG_BRANCH, "jmp"},
1531 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1532 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1533 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1534 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1535 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1536 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1537 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1538 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1539 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1543 static const char *sample_flags_to_name(u32 flags)
1547 for (i = 0; sample_flags[i].name ; i++) {
1548 if (sample_flags[i].flags == flags)
1549 return sample_flags[i].name;
1555 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1557 const char *chars = PERF_IP_FLAG_CHARS;
1558 const int n = strlen(PERF_IP_FLAG_CHARS);
1559 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1560 const char *name = NULL;
1564 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1566 return fprintf(fp, " %-15s%4s ", name, in_tx ? "(x)" : "");
1568 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1569 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1571 return fprintf(fp, " tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1574 if (flags & PERF_IP_FLAG_TRACE_END) {
1575 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1577 return fprintf(fp, " tr end %-7s%4s ", name, in_tx ? "(x)" : "");
1580 for (i = 0; i < n; i++, flags >>= 1) {
1582 str[pos++] = chars[i];
1584 for (; i < 32; i++, flags >>= 1) {
1590 return fprintf(fp, " %-19s ", str);
1593 struct printer_data {
1599 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1601 void *extra, FILE *fp)
1603 unsigned char ch = (unsigned char)val;
1604 struct printer_data *printer_data = extra;
1608 case BINARY_PRINT_DATA_BEGIN:
1609 printed += fprintf(fp, "\n");
1611 case BINARY_PRINT_LINE_BEGIN:
1612 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1615 case BINARY_PRINT_ADDR:
1616 printed += fprintf(fp, " %04x:", val);
1618 case BINARY_PRINT_NUM_DATA:
1619 printed += fprintf(fp, " %02x", val);
1621 case BINARY_PRINT_NUM_PAD:
1622 printed += fprintf(fp, " ");
1624 case BINARY_PRINT_SEP:
1625 printed += fprintf(fp, " ");
1627 case BINARY_PRINT_CHAR_DATA:
1628 if (printer_data->hit_nul && ch)
1629 printer_data->is_printable = false;
1632 printed += fprintf(fp, "%c", '.');
1634 if (!printer_data->is_printable)
1638 printer_data->hit_nul = true;
1640 printer_data->is_printable = false;
1642 printed += fprintf(fp, "%c", ch);
1645 case BINARY_PRINT_CHAR_PAD:
1646 printed += fprintf(fp, " ");
1648 case BINARY_PRINT_LINE_END:
1649 printed += fprintf(fp, "\n");
1650 printer_data->line_no++;
1652 case BINARY_PRINT_DATA_END:
1660 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1662 unsigned int nr_bytes = sample->raw_size;
1663 struct printer_data printer_data = {0, false, true};
1664 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1665 sample__fprintf_bpf_output, &printer_data, fp);
1667 if (printer_data.is_printable && printer_data.hit_nul)
1668 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1673 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1675 if (len > 0 && len < spacing)
1676 return fprintf(fp, "%*s", spacing - len, "");
1681 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1683 return perf_sample__fprintf_spacing(len, 34, fp);
1686 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1688 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1691 if (perf_sample__bad_synth_size(sample, *data))
1694 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1695 data->ip, le64_to_cpu(data->payload));
1696 return len + perf_sample__fprintf_pt_spacing(len, fp);
1699 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1701 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1704 if (perf_sample__bad_synth_size(sample, *data))
1707 len = fprintf(fp, " hints: %#x extensions: %#x ",
1708 data->hints, data->extensions);
1709 return len + perf_sample__fprintf_pt_spacing(len, fp);
1712 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1714 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1717 if (perf_sample__bad_synth_size(sample, *data))
1720 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1721 data->hw, data->cstate, data->subcstate);
1722 return len + perf_sample__fprintf_pt_spacing(len, fp);
1725 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1727 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1730 if (perf_sample__bad_synth_size(sample, *data))
1733 len = fprintf(fp, " IP: %u ", data->ip);
1734 return len + perf_sample__fprintf_pt_spacing(len, fp);
1737 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1739 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1742 if (perf_sample__bad_synth_size(sample, *data))
1745 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1746 data->deepest_cstate, data->last_cstate,
1748 return len + perf_sample__fprintf_pt_spacing(len, fp);
1751 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1753 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1754 unsigned int percent, freq;
1757 if (perf_sample__bad_synth_size(sample, *data))
1760 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1761 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1762 if (data->max_nonturbo) {
1763 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1764 len += fprintf(fp, "(%3u%%) ", percent);
1766 return len + perf_sample__fprintf_pt_spacing(len, fp);
1769 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1770 struct evsel *evsel, FILE *fp)
1772 switch (evsel->core.attr.config) {
1773 case PERF_SYNTH_INTEL_PTWRITE:
1774 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1775 case PERF_SYNTH_INTEL_MWAIT:
1776 return perf_sample__fprintf_synth_mwait(sample, fp);
1777 case PERF_SYNTH_INTEL_PWRE:
1778 return perf_sample__fprintf_synth_pwre(sample, fp);
1779 case PERF_SYNTH_INTEL_EXSTOP:
1780 return perf_sample__fprintf_synth_exstop(sample, fp);
1781 case PERF_SYNTH_INTEL_PWRX:
1782 return perf_sample__fprintf_synth_pwrx(sample, fp);
1783 case PERF_SYNTH_INTEL_CBR:
1784 return perf_sample__fprintf_synth_cbr(sample, fp);
1792 static int evlist__max_name_len(struct evlist *evlist)
1794 struct evsel *evsel;
1797 evlist__for_each_entry(evlist, evsel) {
1798 int len = strlen(evsel__name(evsel));
1800 max = MAX(len, max);
1806 static int data_src__fprintf(u64 data_src, FILE *fp)
1808 struct mem_info mi = { .data_src.val = data_src };
1814 perf_script__meminfo_scnprintf(decode, 100, &mi);
1816 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1820 return fprintf(fp, "%-*s", maxlen, out);
1824 struct perf_sample *sample;
1825 struct thread *thread;
1826 struct evsel *evsel;
1830 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1831 void *ctx, const char *color,
1833 const char *unit, double val)
1835 struct metric_ctx *mctx = ctx;
1839 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1840 PERF_RECORD_SAMPLE, mctx->fp);
1841 fputs("\tmetric: ", mctx->fp);
1843 color_fprintf(mctx->fp, color, fmt, val);
1846 fprintf(mctx->fp, " %s\n", unit);
1849 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1852 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);
1859 static void perf_sample__fprint_metric(struct perf_script *script,
1860 struct thread *thread,
1861 struct evsel *evsel,
1862 struct perf_sample *sample,
1865 struct perf_stat_output_ctx ctx = {
1866 .print_metric = script_print_metric,
1867 .new_line = script_new_line,
1868 .ctx = &(struct metric_ctx) {
1874 .force_header = false,
1880 evlist__alloc_stats(script->session->evlist, false);
1881 if (evsel_script(evsel->leader)->gnum++ == 0)
1882 perf_stat__reset_shadow_stats();
1883 val = sample->period * evsel->scale;
1884 perf_stat__update_shadow_stats(evsel,
1888 evsel_script(evsel)->val = val;
1889 if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1890 for_each_group_member (ev2, evsel->leader) {
1891 perf_stat__print_shadow_stats(&stat_config, ev2,
1892 evsel_script(ev2)->val,
1898 evsel_script(evsel->leader)->gnum = 0;
1902 static bool show_event(struct perf_sample *sample,
1903 struct evsel *evsel,
1904 struct thread *thread,
1905 struct addr_location *al)
1907 int depth = thread_stack__depth(thread, sample->cpu);
1909 if (!symbol_conf.graph_function)
1912 if (thread->filter) {
1913 if (depth <= thread->filter_entry_depth) {
1914 thread->filter = false;
1919 const char *s = symbol_conf.graph_function;
1921 const char *name = resolve_branch_sym(sample, evsel, thread, al,
1927 nlen = strlen(name);
1929 unsigned len = strcspn(s, ",");
1930 if (nlen == len && !strncmp(name, s, len)) {
1931 thread->filter = true;
1932 thread->filter_entry_depth = depth;
1943 static void process_event(struct perf_script *script,
1944 struct perf_sample *sample, struct evsel *evsel,
1945 struct addr_location *al,
1946 struct machine *machine)
1948 struct thread *thread = al->thread;
1949 struct perf_event_attr *attr = &evsel->core.attr;
1950 unsigned int type = output_type(attr->type);
1951 struct evsel_script *es = evsel->priv;
1953 char str[PAGE_SIZE_NAME_LEN];
1955 if (output[type].fields == 0)
1958 if (!show_event(sample, evsel, thread, al))
1961 if (evswitch__discard(&script->evswitch, evsel))
1966 perf_sample__fprintf_start(script, sample, thread, evsel,
1967 PERF_RECORD_SAMPLE, fp);
1969 if (PRINT_FIELD(PERIOD))
1970 fprintf(fp, "%10" PRIu64 " ", sample->period);
1972 if (PRINT_FIELD(EVNAME)) {
1973 const char *evname = evsel__name(evsel);
1975 if (!script->name_width)
1976 script->name_width = evlist__max_name_len(script->session->evlist);
1978 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1982 perf_sample__fprintf_flags(sample->flags, fp);
1984 if (is_bts_event(attr)) {
1985 perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1989 if (PRINT_FIELD(TRACE) && sample->raw_data) {
1990 event_format__fprintf(evsel->tp_format, sample->cpu,
1991 sample->raw_data, sample->raw_size, fp);
1994 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1995 perf_sample__fprintf_synth(sample, evsel, fp);
1997 if (PRINT_FIELD(ADDR))
1998 perf_sample__fprintf_addr(sample, thread, attr, fp);
2000 if (PRINT_FIELD(DATA_SRC))
2001 data_src__fprintf(sample->data_src, fp);
2003 if (PRINT_FIELD(WEIGHT))
2004 fprintf(fp, "%16" PRIu64, sample->weight);
2006 if (PRINT_FIELD(IP)) {
2007 struct callchain_cursor *cursor = NULL;
2009 if (script->stitch_lbr)
2010 al->thread->lbr_stitch_enable = true;
2012 if (symbol_conf.use_callchain && sample->callchain &&
2013 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2014 sample, NULL, NULL, scripting_max_stack) == 0)
2015 cursor = &callchain_cursor;
2017 fputc(cursor ? '\n' : ' ', fp);
2018 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2019 symbol_conf.bt_stop_list, fp);
2022 if (PRINT_FIELD(IREGS))
2023 perf_sample__fprintf_iregs(sample, attr, fp);
2025 if (PRINT_FIELD(UREGS))
2026 perf_sample__fprintf_uregs(sample, attr, fp);
2028 if (PRINT_FIELD(BRSTACK))
2029 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2030 else if (PRINT_FIELD(BRSTACKSYM))
2031 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2032 else if (PRINT_FIELD(BRSTACKOFF))
2033 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2035 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2036 perf_sample__fprintf_bpf_output(sample, fp);
2037 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2039 if (PRINT_FIELD(PHYS_ADDR))
2040 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2042 if (PRINT_FIELD(DATA_PAGE_SIZE))
2043 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2045 if (PRINT_FIELD(CODE_PAGE_SIZE))
2046 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2048 perf_sample__fprintf_ipc(sample, attr, fp);
2052 if (PRINT_FIELD(SRCCODE)) {
2053 if (map__fprintf_srccode(al->map, al->addr, stdout,
2054 &thread->srccode_state))
2058 if (PRINT_FIELD(METRIC))
2059 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2065 static struct scripting_ops *scripting_ops;
2067 static void __process_stat(struct evsel *counter, u64 tstamp)
2069 int nthreads = perf_thread_map__nr(counter->core.threads);
2070 int ncpus = evsel__nr_cpus(counter);
2072 static int header_printed;
2074 if (counter->core.system_wide)
2077 if (!header_printed) {
2078 printf("%3s %8s %15s %15s %15s %15s %s\n",
2079 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2083 for (thread = 0; thread < nthreads; thread++) {
2084 for (cpu = 0; cpu < ncpus; cpu++) {
2085 struct perf_counts_values *counts;
2087 counts = perf_counts(counter->counts, cpu, thread);
2089 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2090 counter->core.cpus->map[cpu],
2091 perf_thread_map__pid(counter->core.threads, thread),
2096 evsel__name(counter));
2101 static void process_stat(struct evsel *counter, u64 tstamp)
2103 if (scripting_ops && scripting_ops->process_stat)
2104 scripting_ops->process_stat(&stat_config, counter, tstamp);
2106 __process_stat(counter, tstamp);
2109 static void process_stat_interval(u64 tstamp)
2111 if (scripting_ops && scripting_ops->process_stat_interval)
2112 scripting_ops->process_stat_interval(tstamp);
2115 static void setup_scripting(void)
2117 setup_perl_scripting();
2118 setup_python_scripting();
2121 static int flush_scripting(void)
2123 return scripting_ops ? scripting_ops->flush_script() : 0;
2126 static int cleanup_scripting(void)
2128 pr_debug("\nperf script stopped\n");
2130 return scripting_ops ? scripting_ops->stop_script() : 0;
2133 static bool filter_cpu(struct perf_sample *sample)
2135 if (cpu_list && sample->cpu != (u32)-1)
2136 return !test_bit(sample->cpu, cpu_bitmap);
2140 static int process_sample_event(struct perf_tool *tool,
2141 union perf_event *event,
2142 struct perf_sample *sample,
2143 struct evsel *evsel,
2144 struct machine *machine)
2146 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2147 struct addr_location al;
2149 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2155 if (sample->time < last_timestamp) {
2156 pr_err("Samples misordered, previous: %" PRIu64
2157 " this: %" PRIu64 "\n", last_timestamp,
2161 last_timestamp = sample->time;
2165 if (machine__resolve(machine, &al, sample) < 0) {
2166 pr_err("problem processing %d event, skipping it.\n",
2167 event->header.type);
2174 if (filter_cpu(sample))
2178 scripting_ops->process_event(event, sample, evsel, &al);
2180 process_event(scr, sample, evsel, &al, machine);
2183 addr_location__put(&al);
2187 static int process_attr(struct perf_tool *tool, union perf_event *event,
2188 struct evlist **pevlist)
2190 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2191 struct evlist *evlist;
2192 struct evsel *evsel, *pos;
2195 static struct evsel_script *es;
2197 err = perf_event__process_attr(tool, event, pevlist);
2202 evsel = evlist__last(*pevlist);
2205 if (scr->per_event_dump) {
2206 evsel->priv = perf_evsel_script__new(evsel,
2207 scr->session->data);
2209 es = zalloc(sizeof(*es));
2217 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2218 evsel->core.attr.type != PERF_TYPE_SYNTH)
2221 evlist__for_each_entry(evlist, pos) {
2222 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2226 if (evsel->core.attr.sample_type) {
2227 err = evsel__check_attr(evsel, scr->session);
2233 * Check if we need to enable callchains based
2234 * on events sample_type.
2236 sample_type = evlist__combined_sample_type(evlist);
2237 callchain_param_setup(sample_type);
2239 /* Enable fields for callchain entries */
2240 if (symbol_conf.use_callchain &&
2241 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2242 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2243 (sample_type & PERF_SAMPLE_REGS_USER &&
2244 sample_type & PERF_SAMPLE_STACK_USER))) {
2245 int type = output_type(evsel->core.attr.type);
2247 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2248 output[type].fields |= PERF_OUTPUT_IP;
2249 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2250 output[type].fields |= PERF_OUTPUT_SYM;
2252 set_print_ip_opts(&evsel->core.attr);
2256 static int print_event_with_time(struct perf_tool *tool,
2257 union perf_event *event,
2258 struct perf_sample *sample,
2259 struct machine *machine,
2260 pid_t pid, pid_t tid, u64 timestamp)
2262 struct perf_script *script = container_of(tool, struct perf_script, tool);
2263 struct perf_session *session = script->session;
2264 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2265 struct thread *thread = NULL;
2267 if (evsel && !evsel->core.attr.sample_id_all) {
2269 sample->time = timestamp;
2274 if (filter_cpu(sample))
2278 thread = machine__findnew_thread(machine, pid, tid);
2281 perf_sample__fprintf_start(script, sample, thread, evsel,
2282 event->header.type, stdout);
2285 perf_event__fprintf(event, machine, stdout);
2287 thread__put(thread);
2292 static int print_event(struct perf_tool *tool, union perf_event *event,
2293 struct perf_sample *sample, struct machine *machine,
2294 pid_t pid, pid_t tid)
2296 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2299 static int process_comm_event(struct perf_tool *tool,
2300 union perf_event *event,
2301 struct perf_sample *sample,
2302 struct machine *machine)
2304 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2307 return print_event(tool, event, sample, machine, event->comm.pid,
2311 static int process_namespaces_event(struct perf_tool *tool,
2312 union perf_event *event,
2313 struct perf_sample *sample,
2314 struct machine *machine)
2316 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2319 return print_event(tool, event, sample, machine, event->namespaces.pid,
2320 event->namespaces.tid);
2323 static int process_cgroup_event(struct perf_tool *tool,
2324 union perf_event *event,
2325 struct perf_sample *sample,
2326 struct machine *machine)
2328 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2331 return print_event(tool, event, sample, machine, sample->pid,
2335 static int process_fork_event(struct perf_tool *tool,
2336 union perf_event *event,
2337 struct perf_sample *sample,
2338 struct machine *machine)
2340 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2343 return print_event_with_time(tool, event, sample, machine,
2344 event->fork.pid, event->fork.tid,
2347 static int process_exit_event(struct perf_tool *tool,
2348 union perf_event *event,
2349 struct perf_sample *sample,
2350 struct machine *machine)
2352 /* Print before 'exit' deletes anything */
2353 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2354 event->fork.tid, event->fork.time))
2357 return perf_event__process_exit(tool, event, sample, machine);
2360 static int process_mmap_event(struct perf_tool *tool,
2361 union perf_event *event,
2362 struct perf_sample *sample,
2363 struct machine *machine)
2365 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2368 return print_event(tool, event, sample, machine, event->mmap.pid,
2372 static int process_mmap2_event(struct perf_tool *tool,
2373 union perf_event *event,
2374 struct perf_sample *sample,
2375 struct machine *machine)
2377 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2380 return print_event(tool, event, sample, machine, event->mmap2.pid,
2384 static int process_switch_event(struct perf_tool *tool,
2385 union perf_event *event,
2386 struct perf_sample *sample,
2387 struct machine *machine)
2389 struct perf_script *script = container_of(tool, struct perf_script, tool);
2391 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2394 if (scripting_ops && scripting_ops->process_switch)
2395 scripting_ops->process_switch(event, sample, machine);
2397 if (!script->show_switch_events)
2400 return print_event(tool, event, sample, machine, sample->pid,
2405 process_lost_event(struct perf_tool *tool,
2406 union perf_event *event,
2407 struct perf_sample *sample,
2408 struct machine *machine)
2410 return print_event(tool, event, sample, machine, sample->pid,
2415 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2416 union perf_event *event,
2417 struct ordered_events *oe __maybe_unused)
2420 perf_event__fprintf(event, NULL, stdout);
2425 process_bpf_events(struct perf_tool *tool __maybe_unused,
2426 union perf_event *event,
2427 struct perf_sample *sample,
2428 struct machine *machine)
2430 if (machine__process_ksymbol(machine, event, sample) < 0)
2433 return print_event(tool, event, sample, machine, sample->pid,
2437 static int process_text_poke_events(struct perf_tool *tool,
2438 union perf_event *event,
2439 struct perf_sample *sample,
2440 struct machine *machine)
2442 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2445 return print_event(tool, event, sample, machine, sample->pid,
2449 static void sig_handler(int sig __maybe_unused)
2454 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2456 struct evlist *evlist = script->session->evlist;
2457 struct evsel *evsel;
2459 evlist__for_each_entry(evlist, evsel) {
2462 perf_evsel_script__delete(evsel->priv);
2467 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2469 struct evsel *evsel;
2471 evlist__for_each_entry(script->session->evlist, evsel) {
2473 * Already setup? I.e. we may be called twice in cases like
2474 * Intel PT, one for the intel_pt// and dummy events, then
2475 * for the evsels syntheized from the auxtrace info.
2477 * Ses perf_script__process_auxtrace_info.
2479 if (evsel->priv != NULL)
2482 evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2483 if (evsel->priv == NULL)
2484 goto out_err_fclose;
2490 perf_script__fclose_per_event_dump(script);
2494 static int perf_script__setup_per_event_dump(struct perf_script *script)
2496 struct evsel *evsel;
2497 static struct evsel_script es_stdout;
2499 if (script->per_event_dump)
2500 return perf_script__fopen_per_event_dump(script);
2502 es_stdout.fp = stdout;
2504 evlist__for_each_entry(script->session->evlist, evsel)
2505 evsel->priv = &es_stdout;
2510 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2512 struct evsel *evsel;
2514 evlist__for_each_entry(script->session->evlist, evsel) {
2515 struct evsel_script *es = evsel->priv;
2517 perf_evsel_script__fprintf(es, stdout);
2518 perf_evsel_script__delete(es);
2523 static int __cmd_script(struct perf_script *script)
2527 signal(SIGINT, sig_handler);
2529 perf_stat__init_shadow_stats();
2531 /* override event processing functions */
2532 if (script->show_task_events) {
2533 script->tool.comm = process_comm_event;
2534 script->tool.fork = process_fork_event;
2535 script->tool.exit = process_exit_event;
2537 if (script->show_mmap_events) {
2538 script->tool.mmap = process_mmap_event;
2539 script->tool.mmap2 = process_mmap2_event;
2541 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2542 script->tool.context_switch = process_switch_event;
2543 if (script->show_namespace_events)
2544 script->tool.namespaces = process_namespaces_event;
2545 if (script->show_cgroup_events)
2546 script->tool.cgroup = process_cgroup_event;
2547 if (script->show_lost_events)
2548 script->tool.lost = process_lost_event;
2549 if (script->show_round_events) {
2550 script->tool.ordered_events = false;
2551 script->tool.finished_round = process_finished_round_event;
2553 if (script->show_bpf_events) {
2554 script->tool.ksymbol = process_bpf_events;
2555 script->tool.bpf = process_bpf_events;
2557 if (script->show_text_poke_events) {
2558 script->tool.ksymbol = process_bpf_events;
2559 script->tool.text_poke = process_text_poke_events;
2562 if (perf_script__setup_per_event_dump(script)) {
2563 pr_err("Couldn't create the per event dump files\n");
2567 ret = perf_session__process_events(script->session);
2569 if (script->per_event_dump)
2570 perf_script__exit_per_event_dump_stats(script);
2573 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2578 struct script_spec {
2579 struct list_head node;
2580 struct scripting_ops *ops;
2584 static LIST_HEAD(script_specs);
2586 static struct script_spec *script_spec__new(const char *spec,
2587 struct scripting_ops *ops)
2589 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2592 strcpy(s->spec, spec);
2599 static void script_spec__add(struct script_spec *s)
2601 list_add_tail(&s->node, &script_specs);
2604 static struct script_spec *script_spec__find(const char *spec)
2606 struct script_spec *s;
2608 list_for_each_entry(s, &script_specs, node)
2609 if (strcasecmp(s->spec, spec) == 0)
2614 int script_spec_register(const char *spec, struct scripting_ops *ops)
2616 struct script_spec *s;
2618 s = script_spec__find(spec);
2622 s = script_spec__new(spec, ops);
2626 script_spec__add(s);
2631 static struct scripting_ops *script_spec__lookup(const char *spec)
2633 struct script_spec *s = script_spec__find(spec);
2640 static void list_available_languages(void)
2642 struct script_spec *s;
2644 fprintf(stderr, "\n");
2645 fprintf(stderr, "Scripting language extensions (used in "
2646 "perf script -s [spec:]script.[spec]):\n\n");
2648 list_for_each_entry(s, &script_specs, node)
2649 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2651 fprintf(stderr, "\n");
2654 static int parse_scriptname(const struct option *opt __maybe_unused,
2655 const char *str, int unset __maybe_unused)
2657 char spec[PATH_MAX];
2658 const char *script, *ext;
2661 if (strcmp(str, "lang") == 0) {
2662 list_available_languages();
2666 script = strchr(str, ':');
2669 if (len >= PATH_MAX) {
2670 fprintf(stderr, "invalid language specifier");
2673 strncpy(spec, str, len);
2675 scripting_ops = script_spec__lookup(spec);
2676 if (!scripting_ops) {
2677 fprintf(stderr, "invalid language specifier");
2683 ext = strrchr(script, '.');
2685 fprintf(stderr, "invalid script extension");
2688 scripting_ops = script_spec__lookup(++ext);
2689 if (!scripting_ops) {
2690 fprintf(stderr, "invalid script extension");
2695 script_name = strdup(script);
2700 static int parse_output_fields(const struct option *opt __maybe_unused,
2701 const char *arg, int unset __maybe_unused)
2703 char *tok, *strtok_saveptr = NULL;
2704 int i, imax = ARRAY_SIZE(all_output_options);
2707 char *str = strdup(arg);
2709 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2714 /* first word can state for which event type the user is specifying
2715 * the fields. If no type exists, the specified fields apply to all
2716 * event types found in the file minus the invalid fields for a type.
2718 tok = strchr(str, ':');
2722 if (!strcmp(str, "hw"))
2723 type = PERF_TYPE_HARDWARE;
2724 else if (!strcmp(str, "sw"))
2725 type = PERF_TYPE_SOFTWARE;
2726 else if (!strcmp(str, "trace"))
2727 type = PERF_TYPE_TRACEPOINT;
2728 else if (!strcmp(str, "raw"))
2729 type = PERF_TYPE_RAW;
2730 else if (!strcmp(str, "break"))
2731 type = PERF_TYPE_BREAKPOINT;
2732 else if (!strcmp(str, "synth"))
2733 type = OUTPUT_TYPE_SYNTH;
2735 fprintf(stderr, "Invalid event type in field string.\n");
2740 if (output[type].user_set)
2741 pr_warning("Overriding previous field request for %s events.\n",
2744 /* Don't override defaults for +- */
2745 if (strchr(tok, '+') || strchr(tok, '-'))
2748 output[type].fields = 0;
2749 output[type].user_set = true;
2750 output[type].wildcard_set = false;
2754 if (strlen(str) == 0) {
2756 "Cannot set fields to 'none' for all event types.\n");
2761 /* Don't override defaults for +- */
2762 if (strchr(str, '+') || strchr(str, '-'))
2765 if (output_set_by_user())
2766 pr_warning("Overriding previous field request for all events.\n");
2768 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2769 output[j].fields = 0;
2770 output[j].user_set = true;
2771 output[j].wildcard_set = true;
2776 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2782 } else if (*tok == '-') {
2788 if (change != SET && change != DEFAULT)
2793 for (i = 0; i < imax; ++i) {
2794 if (strcmp(tok, all_output_options[i].str) == 0)
2797 if (i == imax && strcmp(tok, "flags") == 0) {
2798 print_flags = change == REMOVE ? false : true;
2802 fprintf(stderr, "Invalid field requested.\n");
2808 /* add user option to all events types for
2811 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2812 if (output[j].invalid_fields & all_output_options[i].field) {
2813 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2814 all_output_options[i].str, event_type(j));
2816 if (change == REMOVE) {
2817 output[j].fields &= ~all_output_options[i].field;
2818 output[j].user_set_fields &= ~all_output_options[i].field;
2819 output[j].user_unset_fields |= all_output_options[i].field;
2821 output[j].fields |= all_output_options[i].field;
2822 output[j].user_set_fields |= all_output_options[i].field;
2823 output[j].user_unset_fields &= ~all_output_options[i].field;
2825 output[j].user_set = true;
2826 output[j].wildcard_set = true;
2830 if (output[type].invalid_fields & all_output_options[i].field) {
2831 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2832 all_output_options[i].str, event_type(type));
2837 if (change == REMOVE)
2838 output[type].fields &= ~all_output_options[i].field;
2840 output[type].fields |= all_output_options[i].field;
2841 output[type].user_set = true;
2842 output[type].wildcard_set = true;
2847 if (output[type].fields == 0) {
2848 pr_debug("No fields requested for %s type. "
2849 "Events will not be displayed.\n", event_type(type));
2855 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2862 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2863 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2864 if ((lang_dirent->d_type == DT_DIR || \
2865 (lang_dirent->d_type == DT_UNKNOWN && \
2866 is_directory(scripts_path, lang_dirent))) && \
2867 (strcmp(lang_dirent->d_name, ".")) && \
2868 (strcmp(lang_dirent->d_name, "..")))
2870 #define for_each_script(lang_path, lang_dir, script_dirent) \
2871 while ((script_dirent = readdir(lang_dir)) != NULL) \
2872 if (script_dirent->d_type != DT_DIR && \
2873 (script_dirent->d_type != DT_UNKNOWN || \
2874 !is_directory(lang_path, script_dirent)))
2877 #define RECORD_SUFFIX "-record"
2878 #define REPORT_SUFFIX "-report"
2880 struct script_desc {
2881 struct list_head node;
2887 static LIST_HEAD(script_descs);
2889 static struct script_desc *script_desc__new(const char *name)
2891 struct script_desc *s = zalloc(sizeof(*s));
2893 if (s != NULL && name)
2894 s->name = strdup(name);
2899 static void script_desc__delete(struct script_desc *s)
2902 zfree(&s->half_liner);
2907 static void script_desc__add(struct script_desc *s)
2909 list_add_tail(&s->node, &script_descs);
2912 static struct script_desc *script_desc__find(const char *name)
2914 struct script_desc *s;
2916 list_for_each_entry(s, &script_descs, node)
2917 if (strcasecmp(s->name, name) == 0)
2922 static struct script_desc *script_desc__findnew(const char *name)
2924 struct script_desc *s = script_desc__find(name);
2929 s = script_desc__new(name);
2933 script_desc__add(s);
2938 static const char *ends_with(const char *str, const char *suffix)
2940 size_t suffix_len = strlen(suffix);
2941 const char *p = str;
2943 if (strlen(str) > suffix_len) {
2944 p = str + strlen(str) - suffix_len;
2945 if (!strncmp(p, suffix, suffix_len))
2952 static int read_script_info(struct script_desc *desc, const char *filename)
2954 char line[BUFSIZ], *p;
2957 fp = fopen(filename, "r");
2961 while (fgets(line, sizeof(line), fp)) {
2962 p = skip_spaces(line);
2968 if (strlen(p) && *p == '!')
2972 if (strlen(p) && p[strlen(p) - 1] == '\n')
2973 p[strlen(p) - 1] = '\0';
2975 if (!strncmp(p, "description:", strlen("description:"))) {
2976 p += strlen("description:");
2977 desc->half_liner = strdup(skip_spaces(p));
2981 if (!strncmp(p, "args:", strlen("args:"))) {
2982 p += strlen("args:");
2983 desc->args = strdup(skip_spaces(p));
2993 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2995 char *script_root, *str;
2997 script_root = strdup(script_dirent->d_name);
3001 str = (char *)ends_with(script_root, suffix);
3011 static int list_available_scripts(const struct option *opt __maybe_unused,
3012 const char *s __maybe_unused,
3013 int unset __maybe_unused)
3015 struct dirent *script_dirent, *lang_dirent;
3016 char scripts_path[MAXPATHLEN];
3017 DIR *scripts_dir, *lang_dir;
3018 char script_path[MAXPATHLEN];
3019 char lang_path[MAXPATHLEN];
3020 struct script_desc *desc;
3021 char first_half[BUFSIZ];
3024 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3026 scripts_dir = opendir(scripts_path);
3029 "open(%s) failed.\n"
3030 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3035 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3036 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3037 lang_dirent->d_name);
3038 lang_dir = opendir(lang_path);
3042 for_each_script(lang_path, lang_dir, script_dirent) {
3043 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3045 desc = script_desc__findnew(script_root);
3046 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3047 lang_path, script_dirent->d_name);
3048 read_script_info(desc, script_path);
3054 fprintf(stdout, "List of available trace scripts:\n");
3055 list_for_each_entry(desc, &script_descs, node) {
3056 sprintf(first_half, "%s %s", desc->name,
3057 desc->args ? desc->args : "");
3058 fprintf(stdout, " %-36s %s\n", first_half,
3059 desc->half_liner ? desc->half_liner : "");
3066 * Some scripts specify the required events in their "xxx-record" file,
3067 * this function will check if the events in perf.data match those
3068 * mentioned in the "xxx-record".
3070 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3071 * which is covered well now. And new parsing code should be added to
3072 * cover the future complexing formats like event groups etc.
3074 static int check_ev_match(char *dir_name, char *scriptname,
3075 struct perf_session *session)
3077 char filename[MAXPATHLEN], evname[128];
3078 char line[BUFSIZ], *p;
3083 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3085 fp = fopen(filename, "r");
3089 while (fgets(line, sizeof(line), fp)) {
3090 p = skip_spaces(line);
3095 p = strstr(p, "-e");
3101 len = strcspn(p, " \t");
3105 snprintf(evname, len + 1, "%s", p);
3108 evlist__for_each_entry(session->evlist, pos) {
3109 if (!strcmp(evsel__name(pos), evname)) {
3127 * Return -1 if none is found, otherwise the actual scripts number.
3129 * Currently the only user of this function is the script browser, which
3130 * will list all statically runnable scripts, select one, execute it and
3131 * show the output in a perf browser.
3133 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3136 struct dirent *script_dirent, *lang_dirent;
3137 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3138 DIR *scripts_dir, *lang_dir;
3139 struct perf_session *session;
3140 struct perf_data data = {
3142 .mode = PERF_DATA_MODE_READ,
3147 session = perf_session__new(&data, false, NULL);
3148 if (IS_ERR(session))
3149 return PTR_ERR(session);
3151 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3153 scripts_dir = opendir(scripts_path);
3155 perf_session__delete(session);
3159 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3160 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3161 lang_dirent->d_name);
3162 #ifndef HAVE_LIBPERL_SUPPORT
3163 if (strstr(lang_path, "perl"))
3166 #ifndef HAVE_LIBPYTHON_SUPPORT
3167 if (strstr(lang_path, "python"))
3171 lang_dir = opendir(lang_path);
3175 for_each_script(lang_path, lang_dir, script_dirent) {
3176 /* Skip those real time scripts: xxxtop.p[yl] */
3177 if (strstr(script_dirent->d_name, "top."))
3181 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3183 script_dirent->d_name);
3184 temp = strchr(script_dirent->d_name, '.');
3185 snprintf(scripts_array[i],
3186 (temp - script_dirent->d_name) + 1,
3187 "%s", script_dirent->d_name);
3189 if (check_ev_match(lang_path,
3190 scripts_array[i], session))
3198 closedir(scripts_dir);
3199 perf_session__delete(session);
3203 static char *get_script_path(const char *script_root, const char *suffix)
3205 struct dirent *script_dirent, *lang_dirent;
3206 char scripts_path[MAXPATHLEN];
3207 char script_path[MAXPATHLEN];
3208 DIR *scripts_dir, *lang_dir;
3209 char lang_path[MAXPATHLEN];
3210 char *__script_root;
3212 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3214 scripts_dir = opendir(scripts_path);
3218 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3219 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3220 lang_dirent->d_name);
3221 lang_dir = opendir(lang_path);
3225 for_each_script(lang_path, lang_dir, script_dirent) {
3226 __script_root = get_script_root(script_dirent, suffix);
3227 if (__script_root && !strcmp(script_root, __script_root)) {
3228 free(__script_root);
3229 closedir(scripts_dir);
3230 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3231 lang_path, script_dirent->d_name);
3233 return strdup(script_path);
3235 free(__script_root);
3239 closedir(scripts_dir);
3244 static bool is_top_script(const char *script_path)
3246 return ends_with(script_path, "top") == NULL ? false : true;
3249 static int has_required_arg(char *script_path)
3251 struct script_desc *desc;
3255 desc = script_desc__new(NULL);
3257 if (read_script_info(desc, script_path))
3263 for (p = desc->args; *p; p++)
3267 script_desc__delete(desc);
3272 static int have_cmd(int argc, const char **argv)
3274 char **__argv = malloc(sizeof(const char *) * argc);
3277 pr_err("malloc failed\n");
3281 memcpy(__argv, argv, sizeof(const char *) * argc);
3282 argc = parse_options(argc, (const char **)__argv, record_options,
3283 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3286 system_wide = (argc == 0);
3291 static void script__setup_sample_type(struct perf_script *script)
3293 struct perf_session *session = script->session;
3294 u64 sample_type = evlist__combined_sample_type(session->evlist);
3296 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3297 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3298 (sample_type & PERF_SAMPLE_STACK_USER)) {
3299 callchain_param.record_mode = CALLCHAIN_DWARF;
3300 dwarf_callchain_users = true;
3301 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3302 callchain_param.record_mode = CALLCHAIN_LBR;
3304 callchain_param.record_mode = CALLCHAIN_FP;
3307 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3308 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3309 "Please apply --call-graph lbr when recording.\n");
3310 script->stitch_lbr = false;
3314 static int process_stat_round_event(struct perf_session *session,
3315 union perf_event *event)
3317 struct perf_record_stat_round *round = &event->stat_round;
3318 struct evsel *counter;
3320 evlist__for_each_entry(session->evlist, counter) {
3321 perf_stat_process_counter(&stat_config, counter);
3322 process_stat(counter, round->time);
3325 process_stat_interval(round->time);
3329 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3330 union perf_event *event)
3332 perf_event__read_stat_config(&stat_config, &event->stat_config);
3336 static int set_maps(struct perf_script *script)
3338 struct evlist *evlist = script->session->evlist;
3340 if (!script->cpus || !script->threads)
3343 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3346 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3348 if (evlist__alloc_stats(evlist, true))
3351 script->allocated = true;
3356 int process_thread_map_event(struct perf_session *session,
3357 union perf_event *event)
3359 struct perf_tool *tool = session->tool;
3360 struct perf_script *script = container_of(tool, struct perf_script, tool);
3362 if (script->threads) {
3363 pr_warning("Extra thread map event, ignoring.\n");
3367 script->threads = thread_map__new_event(&event->thread_map);
3368 if (!script->threads)
3371 return set_maps(script);
3375 int process_cpu_map_event(struct perf_session *session,
3376 union perf_event *event)
3378 struct perf_tool *tool = session->tool;
3379 struct perf_script *script = container_of(tool, struct perf_script, tool);
3382 pr_warning("Extra cpu map event, ignoring.\n");
3386 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3390 return set_maps(script);
3393 static int process_feature_event(struct perf_session *session,
3394 union perf_event *event)
3396 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3397 return perf_event__process_feature(session, event);
3401 #ifdef HAVE_AUXTRACE_SUPPORT
3402 static int perf_script__process_auxtrace_info(struct perf_session *session,
3403 union perf_event *event)
3405 struct perf_tool *tool = session->tool;
3407 int ret = perf_event__process_auxtrace_info(session, event);
3410 struct perf_script *script = container_of(tool, struct perf_script, tool);
3412 ret = perf_script__setup_per_event_dump(script);
3418 #define perf_script__process_auxtrace_info 0
3421 static int parse_insn_trace(const struct option *opt __maybe_unused,
3422 const char *str __maybe_unused,
3423 int unset __maybe_unused)
3425 parse_output_fields(NULL, "+insn,-event,-period", 0);
3426 itrace_parse_synth_opts(opt, "i0ns", 0);
3427 symbol_conf.nanosecs = true;
3431 static int parse_xed(const struct option *opt __maybe_unused,
3432 const char *str __maybe_unused,
3433 int unset __maybe_unused)
3436 force_pager("xed -F insn: -A -64 | less");
3438 force_pager("xed -F insn: -A -64");
3442 static int parse_call_trace(const struct option *opt __maybe_unused,
3443 const char *str __maybe_unused,
3444 int unset __maybe_unused)
3446 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3447 itrace_parse_synth_opts(opt, "cewp", 0);
3448 symbol_conf.nanosecs = true;
3449 symbol_conf.pad_output_len_dso = 50;
3453 static int parse_callret_trace(const struct option *opt __maybe_unused,
3454 const char *str __maybe_unused,
3455 int unset __maybe_unused)
3457 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3458 itrace_parse_synth_opts(opt, "crewp", 0);
3459 symbol_conf.nanosecs = true;
3463 int cmd_script(int argc, const char **argv)
3465 bool show_full_info = false;
3466 bool header = false;
3467 bool header_only = false;
3468 bool script_started = false;
3469 char *rec_script_path = NULL;
3470 char *rep_script_path = NULL;
3471 struct perf_session *session;
3472 struct itrace_synth_opts itrace_synth_opts = {
3474 .default_no_sample = true,
3477 char *script_path = NULL;
3478 const char **__argv;
3480 struct perf_script script = {
3482 .sample = process_sample_event,
3483 .mmap = perf_event__process_mmap,
3484 .mmap2 = perf_event__process_mmap2,
3485 .comm = perf_event__process_comm,
3486 .namespaces = perf_event__process_namespaces,
3487 .cgroup = perf_event__process_cgroup,
3488 .exit = perf_event__process_exit,
3489 .fork = perf_event__process_fork,
3490 .attr = process_attr,
3491 .event_update = perf_event__process_event_update,
3492 .tracing_data = perf_event__process_tracing_data,
3493 .feature = process_feature_event,
3494 .build_id = perf_event__process_build_id,
3495 .id_index = perf_event__process_id_index,
3496 .auxtrace_info = perf_script__process_auxtrace_info,
3497 .auxtrace = perf_event__process_auxtrace,
3498 .auxtrace_error = perf_event__process_auxtrace_error,
3499 .stat = perf_event__process_stat_event,
3500 .stat_round = process_stat_round_event,
3501 .stat_config = process_stat_config_event,
3502 .thread_map = process_thread_map_event,
3503 .cpu_map = process_cpu_map_event,
3504 .ordered_events = true,
3505 .ordering_requires_timestamps = true,
3508 struct perf_data data = {
3509 .mode = PERF_DATA_MODE_READ,
3511 const struct option options[] = {
3512 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3513 "dump raw trace in ASCII"),
3514 OPT_INCR('v', "verbose", &verbose,
3515 "be more verbose (show symbol address, etc)"),
3516 OPT_BOOLEAN('L', "Latency", &latency_format,
3517 "show latency attributes (irqs/preemption disabled, etc)"),
3518 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3519 list_available_scripts),
3520 OPT_CALLBACK('s', "script", NULL, "name",
3521 "script file name (lang:script name, script name, or *)",
3523 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3524 "generate perf-script.xx script in specified language"),
3525 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3526 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3527 "do various checks like samples ordering and lost events"),
3528 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3529 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3530 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3531 "file", "vmlinux pathname"),
3532 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3533 "file", "kallsyms pathname"),
3534 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3535 "When printing symbols do not display call chain"),
3536 OPT_CALLBACK(0, "symfs", NULL, "directory",
3537 "Look for files with symbols relative to this directory",
3538 symbol__config_symfs),
3539 OPT_CALLBACK('F', "fields", NULL, "str",
3540 "comma separated output fields prepend with 'type:'. "
3541 "+field to add and -field to remove."
3542 "Valid types: hw,sw,trace,raw,synth. "
3543 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3544 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3545 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3546 "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod,"
3547 "data_page_size,code_page_size",
3548 parse_output_fields),
3549 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3550 "system-wide collection from all CPUs"),
3551 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3552 "only consider symbols in these DSOs"),
3553 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3554 "only consider these symbols"),
3555 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3556 "Decode instructions from itrace", parse_insn_trace),
3557 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3558 "Run xed disassembler on output", parse_xed),
3559 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3560 "Decode calls from from itrace", parse_call_trace),
3561 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3562 "Decode calls and returns from itrace", parse_callret_trace),
3563 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3564 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3565 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3566 "Stop display of callgraph at these symbols"),
3567 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3568 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3569 "only display events for these comms"),
3570 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3571 "only consider symbols in these pids"),
3572 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3573 "only consider symbols in these tids"),
3574 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3575 "Set the maximum stack depth when parsing the callchain, "
3576 "anything beyond the specified depth will be ignored. "
3577 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3578 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3579 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3580 OPT_BOOLEAN('I', "show-info", &show_full_info,
3581 "display extended information from perf.data file"),
3582 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3583 "Show the path of [kernel.kallsyms]"),
3584 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3585 "Show the fork/comm/exit events"),
3586 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3587 "Show the mmap events"),
3588 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3589 "Show context switch events (if recorded)"),
3590 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3591 "Show namespace events (if recorded)"),
3592 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3593 "Show cgroup events (if recorded)"),
3594 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3595 "Show lost events (if recorded)"),
3596 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3597 "Show round events (if recorded)"),
3598 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3599 "Show bpf related events (if recorded)"),
3600 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3601 "Show text poke related events (if recorded)"),
3602 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3603 "Dump trace output to files named by the monitored events"),
3604 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3605 OPT_INTEGER(0, "max-blocks", &max_blocks,
3606 "Maximum number of code blocks to dump with brstackinsn"),
3607 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3608 "Use 9 decimal places when displaying time"),
3609 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3610 "Instruction Tracing options\n" ITRACE_HELP,
3611 itrace_parse_synth_opts),
3612 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3613 "Show full source file name path for source lines"),
3614 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3615 "Enable symbol demangling"),
3616 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3617 "Enable kernel symbol demangling"),
3618 OPT_STRING(0, "time", &script.time_str, "str",
3619 "Time span of interest (start,stop)"),
3620 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3621 "Show inline function"),
3622 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3623 "guest mount directory under which every guest os"
3624 " instance has a subdir"),
3625 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3626 "file", "file saving guest os vmlinux"),
3627 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3628 "file", "file saving guest os /proc/kallsyms"),
3629 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3630 "file", "file saving guest os /proc/modules"),
3631 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3632 "Enable LBR callgraph stitching approach"),
3633 OPTS_EVSWITCH(&script.evswitch),
3636 const char * const script_subcommands[] = { "record", "report", NULL };
3637 const char *script_usage[] = {
3638 "perf script [<options>]",
3639 "perf script [<options>] record <script> [<record-options>] <command>",
3640 "perf script [<options>] report <script> [script-args]",
3641 "perf script [<options>] <script> [<record-options>] <command>",
3642 "perf script [<options>] <top-script> [script-args]",
3646 perf_set_singlethreaded();
3650 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3651 PARSE_OPT_STOP_AT_NON_OPTION);
3653 if (symbol_conf.guestmount ||
3654 symbol_conf.default_guest_vmlinux_name ||
3655 symbol_conf.default_guest_kallsyms ||
3656 symbol_conf.default_guest_modules) {
3658 * Enable guest sample processing.
3663 data.path = input_name;
3664 data.force = symbol_conf.force;
3666 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3667 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3668 if (!rec_script_path)
3669 return cmd_record(argc, argv);
3672 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3673 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3674 if (!rep_script_path) {
3676 "Please specify a valid report script"
3677 "(see 'perf script -l' for listing)\n");
3682 if (reltime && deltatime) {
3684 "reltime and deltatime - the two don't get along well. "
3685 "Please limit to --reltime or --deltatime.\n");
3689 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3690 itrace_synth_opts.callchain_sz > scripting_max_stack)
3691 scripting_max_stack = itrace_synth_opts.callchain_sz;
3693 /* make sure PERF_EXEC_PATH is set for scripts */
3694 set_argv_exec_path(get_argv_exec_path());
3696 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3701 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3702 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3704 if (!rec_script_path && !rep_script_path) {
3705 usage_with_options_msg(script_usage, options,
3706 "Couldn't find script `%s'\n\n See perf"
3707 " script -l for available scripts.\n", argv[0]);
3710 if (is_top_script(argv[0])) {
3711 rep_args = argc - 1;
3715 rep_args = has_required_arg(rep_script_path);
3716 rec_args = (argc - 1) - rep_args;
3718 usage_with_options_msg(script_usage, options,
3719 "`%s' script requires options."
3720 "\n\n See perf script -l for available "
3721 "scripts and options.\n", argv[0]);
3725 if (pipe(live_pipe) < 0) {
3726 perror("failed to create pipe");
3732 perror("failed to fork");
3739 dup2(live_pipe[1], 1);
3740 close(live_pipe[0]);
3742 if (is_top_script(argv[0])) {
3744 } else if (!system_wide) {
3745 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3751 __argv = malloc((argc + 6) * sizeof(const char *));
3753 pr_err("malloc failed\n");
3758 __argv[j++] = "/bin/sh";
3759 __argv[j++] = rec_script_path;
3765 for (i = rep_args + 1; i < argc; i++)
3766 __argv[j++] = argv[i];
3769 execvp("/bin/sh", (char **)__argv);
3774 dup2(live_pipe[0], 0);
3775 close(live_pipe[1]);
3777 __argv = malloc((argc + 4) * sizeof(const char *));
3779 pr_err("malloc failed\n");
3785 __argv[j++] = "/bin/sh";
3786 __argv[j++] = rep_script_path;
3787 for (i = 1; i < rep_args + 1; i++)
3788 __argv[j++] = argv[i];
3793 execvp("/bin/sh", (char **)__argv);
3798 if (rec_script_path)
3799 script_path = rec_script_path;
3800 if (rep_script_path)
3801 script_path = rep_script_path;
3806 if (!rec_script_path)
3807 system_wide = false;
3808 else if (!system_wide) {
3809 if (have_cmd(argc - 1, &argv[1]) != 0) {
3815 __argv = malloc((argc + 2) * sizeof(const char *));
3817 pr_err("malloc failed\n");
3822 __argv[j++] = "/bin/sh";
3823 __argv[j++] = script_path;
3826 for (i = 2; i < argc; i++)
3827 __argv[j++] = argv[i];
3830 execvp("/bin/sh", (char **)__argv);
3840 session = perf_session__new(&data, false, &script.tool);
3841 if (IS_ERR(session))
3842 return PTR_ERR(session);
3844 if (header || header_only) {
3845 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3846 perf_session__fprintf_info(session, stdout, show_full_info);
3851 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3853 if (symbol__init(&session->header.env) < 0)
3857 if (data.is_pipe || /* assume pipe_mode indicates native_arch */
3858 !strcmp(uts.machine, session->header.env.arch) ||
3859 (!strcmp(uts.machine, "x86_64") &&
3860 !strcmp(session->header.env.arch, "i386")))
3863 script.session = session;
3864 script__setup_sample_type(&script);
3866 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3867 symbol_conf.graph_function)
3868 itrace_synth_opts.thread_stack = true;
3870 session->itrace_synth_opts = &itrace_synth_opts;
3873 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3876 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3880 symbol_conf.use_callchain = true;
3882 symbol_conf.use_callchain = false;
3884 if (session->tevent.pevent &&
3885 tep_set_function_resolver(session->tevent.pevent,
3886 machine__resolve_kernel_addr,
3887 &session->machines.host) < 0) {
3888 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3893 if (generate_script_lang) {
3894 struct stat perf_stat;
3897 if (output_set_by_user()) {
3899 "custom fields not supported for generated scripts");
3904 input = open(data.path, O_RDONLY); /* input_name */
3907 perror("failed to open file");
3911 err = fstat(input, &perf_stat);
3913 perror("failed to stat file");
3917 if (!perf_stat.st_size) {
3918 fprintf(stderr, "zero-sized file, nothing to do!\n");
3922 scripting_ops = script_spec__lookup(generate_script_lang);
3923 if (!scripting_ops) {
3924 fprintf(stderr, "invalid language specifier");
3929 err = scripting_ops->generate_script(session->tevent.pevent,
3935 err = scripting_ops->start_script(script_name, argc, argv);
3938 pr_debug("perf script started with script %s\n\n", script_name);
3939 script_started = true;
3943 err = perf_session__check_output_opt(session);
3947 if (script.time_str) {
3948 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
3949 &script.ptime_range,
3956 itrace_synth_opts__set_time_range(&itrace_synth_opts,
3961 err = evswitch__init(&script.evswitch, session->evlist, stderr);
3965 if (zstd_init(&(session->zstd_data), 0) < 0)
3966 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
3968 err = __cmd_script(&script);
3973 if (script.ptime_range) {
3974 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3975 zfree(&script.ptime_range);
3978 evlist__free_stats(session->evlist);
3979 perf_session__delete(session);
3982 cleanup_scripting();