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/dlfilter.h"
59 #include "util/record.h"
60 #include "util/util.h"
63 #include <linux/ctype.h>
65 static char const *script_name;
66 static char const *generate_script_lang;
68 static bool deltatime;
69 static u64 initial_time;
70 static u64 previous_time;
71 static bool debug_mode;
72 static u64 last_timestamp;
73 static u64 nr_unordered;
74 static bool no_callchain;
75 static bool latency_format;
76 static bool system_wide;
77 static bool print_flags;
78 static const char *cpu_list;
79 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
80 static struct perf_stat_config stat_config;
81 static int max_blocks;
82 static bool native_arch;
83 static struct dlfilter *dlfilter;
85 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
87 enum perf_output_field {
88 PERF_OUTPUT_COMM = 1ULL << 0,
89 PERF_OUTPUT_TID = 1ULL << 1,
90 PERF_OUTPUT_PID = 1ULL << 2,
91 PERF_OUTPUT_TIME = 1ULL << 3,
92 PERF_OUTPUT_CPU = 1ULL << 4,
93 PERF_OUTPUT_EVNAME = 1ULL << 5,
94 PERF_OUTPUT_TRACE = 1ULL << 6,
95 PERF_OUTPUT_IP = 1ULL << 7,
96 PERF_OUTPUT_SYM = 1ULL << 8,
97 PERF_OUTPUT_DSO = 1ULL << 9,
98 PERF_OUTPUT_ADDR = 1ULL << 10,
99 PERF_OUTPUT_SYMOFFSET = 1ULL << 11,
100 PERF_OUTPUT_SRCLINE = 1ULL << 12,
101 PERF_OUTPUT_PERIOD = 1ULL << 13,
102 PERF_OUTPUT_IREGS = 1ULL << 14,
103 PERF_OUTPUT_BRSTACK = 1ULL << 15,
104 PERF_OUTPUT_BRSTACKSYM = 1ULL << 16,
105 PERF_OUTPUT_DATA_SRC = 1ULL << 17,
106 PERF_OUTPUT_WEIGHT = 1ULL << 18,
107 PERF_OUTPUT_BPF_OUTPUT = 1ULL << 19,
108 PERF_OUTPUT_CALLINDENT = 1ULL << 20,
109 PERF_OUTPUT_INSN = 1ULL << 21,
110 PERF_OUTPUT_INSNLEN = 1ULL << 22,
111 PERF_OUTPUT_BRSTACKINSN = 1ULL << 23,
112 PERF_OUTPUT_BRSTACKOFF = 1ULL << 24,
113 PERF_OUTPUT_SYNTH = 1ULL << 25,
114 PERF_OUTPUT_PHYS_ADDR = 1ULL << 26,
115 PERF_OUTPUT_UREGS = 1ULL << 27,
116 PERF_OUTPUT_METRIC = 1ULL << 28,
117 PERF_OUTPUT_MISC = 1ULL << 29,
118 PERF_OUTPUT_SRCCODE = 1ULL << 30,
119 PERF_OUTPUT_IPC = 1ULL << 31,
120 PERF_OUTPUT_TOD = 1ULL << 32,
121 PERF_OUTPUT_DATA_PAGE_SIZE = 1ULL << 33,
122 PERF_OUTPUT_CODE_PAGE_SIZE = 1ULL << 34,
126 struct perf_tool tool;
127 struct perf_session *session;
128 bool show_task_events;
129 bool show_mmap_events;
130 bool show_switch_events;
131 bool show_namespace_events;
132 bool show_lost_events;
133 bool show_round_events;
134 bool show_bpf_events;
135 bool show_cgroup_events;
136 bool show_text_poke_events;
140 struct evswitch evswitch;
141 struct perf_cpu_map *cpus;
142 struct perf_thread_map *threads;
144 const char *time_str;
145 struct perf_time_interval *ptime_range;
150 struct output_option {
152 enum perf_output_field field;
153 } all_output_options[] = {
154 {.str = "comm", .field = PERF_OUTPUT_COMM},
155 {.str = "tid", .field = PERF_OUTPUT_TID},
156 {.str = "pid", .field = PERF_OUTPUT_PID},
157 {.str = "time", .field = PERF_OUTPUT_TIME},
158 {.str = "cpu", .field = PERF_OUTPUT_CPU},
159 {.str = "event", .field = PERF_OUTPUT_EVNAME},
160 {.str = "trace", .field = PERF_OUTPUT_TRACE},
161 {.str = "ip", .field = PERF_OUTPUT_IP},
162 {.str = "sym", .field = PERF_OUTPUT_SYM},
163 {.str = "dso", .field = PERF_OUTPUT_DSO},
164 {.str = "addr", .field = PERF_OUTPUT_ADDR},
165 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
166 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
167 {.str = "period", .field = PERF_OUTPUT_PERIOD},
168 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
169 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
170 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
171 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
172 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
173 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
174 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
175 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
176 {.str = "insn", .field = PERF_OUTPUT_INSN},
177 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
178 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
179 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
180 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
181 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
182 {.str = "metric", .field = PERF_OUTPUT_METRIC},
183 {.str = "misc", .field = PERF_OUTPUT_MISC},
184 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
185 {.str = "ipc", .field = PERF_OUTPUT_IPC},
186 {.str = "tod", .field = PERF_OUTPUT_TOD},
187 {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
188 {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
192 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
197 /* default set to maintain compatibility with current format */
201 unsigned int print_ip_opts;
205 u64 user_unset_fields;
206 } output[OUTPUT_TYPE_MAX] = {
208 [PERF_TYPE_HARDWARE] = {
211 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
212 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
213 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
214 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
215 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
217 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
220 [PERF_TYPE_SOFTWARE] = {
223 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
224 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
225 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
226 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
227 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
228 PERF_OUTPUT_BPF_OUTPUT,
230 .invalid_fields = PERF_OUTPUT_TRACE,
233 [PERF_TYPE_TRACEPOINT] = {
236 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
237 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
238 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
241 [PERF_TYPE_HW_CACHE] = {
244 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
245 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
246 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
247 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
248 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
250 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
256 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
257 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
258 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
259 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
260 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
261 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
262 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
263 PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE,
265 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
268 [PERF_TYPE_BREAKPOINT] = {
271 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
272 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
273 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
274 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
275 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
277 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
280 [OUTPUT_TYPE_SYNTH] = {
283 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
284 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
285 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
286 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
287 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
289 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
292 [OUTPUT_TYPE_OTHER] = {
295 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
296 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
297 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
298 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
299 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
301 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
305 struct evsel_script {
309 /* For metric output */
314 static inline struct evsel_script *evsel_script(struct evsel *evsel)
316 return (struct evsel_script *)evsel->priv;
319 static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
321 struct evsel_script *es = zalloc(sizeof(*es));
324 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
326 es->fp = fopen(es->filename, "w");
328 goto out_free_filename;
333 zfree(&es->filename);
339 static void evsel_script__delete(struct evsel_script *es)
341 zfree(&es->filename);
347 static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
351 fstat(fileno(es->fp), &st);
352 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
353 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
356 static inline int output_type(unsigned int type)
359 case PERF_TYPE_SYNTH:
360 return OUTPUT_TYPE_SYNTH;
362 if (type < PERF_TYPE_MAX)
366 return OUTPUT_TYPE_OTHER;
369 static inline unsigned int attr_type(unsigned int type)
372 case OUTPUT_TYPE_SYNTH:
373 return PERF_TYPE_SYNTH;
379 static bool output_set_by_user(void)
382 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
383 if (output[j].user_set)
389 static const char *output_field2str(enum perf_output_field field)
391 int i, imax = ARRAY_SIZE(all_output_options);
392 const char *str = "";
394 for (i = 0; i < imax; ++i) {
395 if (all_output_options[i].field == field) {
396 str = all_output_options[i].str;
403 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
405 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
406 enum perf_output_field field, bool allow_user_set)
408 struct perf_event_attr *attr = &evsel->core.attr;
409 int type = output_type(attr->type);
412 if (attr->sample_type & sample_type)
415 if (output[type].user_set_fields & field) {
418 evname = evsel__name(evsel);
419 pr_err("Samples for '%s' event do not have %s attribute set. "
420 "Cannot print '%s' field.\n",
421 evname, sample_msg, output_field2str(field));
425 /* user did not ask for it explicitly so remove from the default list */
426 output[type].fields &= ~field;
427 evname = evsel__name(evsel);
428 pr_debug("Samples for '%s' event do not have %s attribute set. "
429 "Skipping '%s' field.\n",
430 evname, sample_msg, output_field2str(field));
435 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
436 enum perf_output_field field)
438 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
441 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
443 struct perf_event_attr *attr = &evsel->core.attr;
446 if (perf_header__has_feat(&session->header, HEADER_STAT))
449 allow_user_set = perf_header__has_feat(&session->header,
452 if (PRINT_FIELD(TRACE) &&
453 !perf_session__has_traces(session, "record -R"))
456 if (PRINT_FIELD(IP)) {
457 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
461 if (PRINT_FIELD(ADDR) &&
462 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
465 if (PRINT_FIELD(DATA_SRC) &&
466 evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
469 if (PRINT_FIELD(WEIGHT) &&
470 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
473 if (PRINT_FIELD(SYM) &&
474 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
475 pr_err("Display of symbols requested but neither sample IP nor "
476 "sample address\navailable. Hence, no addresses to convert "
480 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
481 pr_err("Display of offsets requested but symbol is not"
485 if (PRINT_FIELD(DSO) &&
486 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
487 pr_err("Display of DSO requested but no address to convert.\n");
490 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
491 pr_err("Display of source line number requested but sample IP is not\n"
492 "selected. Hence, no address to lookup the source line number.\n");
495 if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
496 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
497 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
498 "Hint: run 'perf record -b ...'\n");
501 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
502 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
505 if (PRINT_FIELD(TIME) &&
506 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
509 if (PRINT_FIELD(CPU) &&
510 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
513 if (PRINT_FIELD(IREGS) &&
514 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
517 if (PRINT_FIELD(UREGS) &&
518 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
521 if (PRINT_FIELD(PHYS_ADDR) &&
522 evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
525 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
526 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
529 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
530 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
536 static void set_print_ip_opts(struct perf_event_attr *attr)
538 unsigned int type = output_type(attr->type);
540 output[type].print_ip_opts = 0;
542 output[type].print_ip_opts |= EVSEL__PRINT_IP;
544 if (PRINT_FIELD(SYM))
545 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
547 if (PRINT_FIELD(DSO))
548 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
550 if (PRINT_FIELD(SYMOFFSET))
551 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
553 if (PRINT_FIELD(SRCLINE))
554 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
558 * verify all user requested events exist and the samples
559 * have the expected data
561 static int perf_session__check_output_opt(struct perf_session *session)
567 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
568 evsel = perf_session__find_first_evtype(session, attr_type(j));
571 * even if fields is set to 0 (ie., show nothing) event must
572 * exist if user explicitly includes it on the command line
574 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
575 j != OUTPUT_TYPE_SYNTH) {
576 pr_err("%s events do not exist. "
577 "Remove corresponding -F option to proceed.\n",
582 if (evsel && output[j].fields &&
583 evsel__check_attr(evsel, session))
589 set_print_ip_opts(&evsel->core.attr);
590 tod |= output[j].fields & PERF_OUTPUT_TOD;
594 bool use_callchain = false;
595 bool not_pipe = false;
597 evlist__for_each_entry(session->evlist, evsel) {
599 if (evsel__has_callchain(evsel)) {
600 use_callchain = true;
604 if (not_pipe && !use_callchain)
605 symbol_conf.use_callchain = false;
609 * set default for tracepoints to print symbols only
610 * if callchains are present
612 if (symbol_conf.use_callchain &&
613 !output[PERF_TYPE_TRACEPOINT].user_set) {
614 j = PERF_TYPE_TRACEPOINT;
616 evlist__for_each_entry(session->evlist, evsel) {
617 if (evsel->core.attr.type != j)
620 if (evsel__has_callchain(evsel)) {
621 output[j].fields |= PERF_OUTPUT_IP;
622 output[j].fields |= PERF_OUTPUT_SYM;
623 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
624 output[j].fields |= PERF_OUTPUT_DSO;
625 set_print_ip_opts(&evsel->core.attr);
631 if (tod && !session->header.env.clock.enabled) {
632 pr_err("Can't provide 'tod' time, missing clock data. "
633 "Please record with -k/--clockid option.\n");
640 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
646 if (!regs || !regs->regs)
649 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
651 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
652 u64 val = regs->regs[i++];
653 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
659 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
662 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
665 u64 tod_ns, clockid_ns;
666 struct perf_env *env;
673 if (buflen < 64 || !script)
676 env = &script->session->header.env;
677 if (!env->clock.enabled) {
678 scnprintf(buf, buflen, "disabled");
682 clockid_ns = env->clock.clockid_ns;
683 tod_ns = env->clock.tod_ns;
685 if (timestamp > clockid_ns)
686 tod_ns += timestamp - clockid_ns;
688 tod_ns -= clockid_ns - timestamp;
690 sec = (time_t) (tod_ns / NSEC_PER_SEC);
691 nsec = tod_ns - sec * NSEC_PER_SEC;
693 if (localtime_r(&sec, <ime) == NULL) {
694 scnprintf(buf, buflen, "failed");
696 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
698 if (symbol_conf.nanosecs) {
699 snprintf(buf, buflen, "%s.%09lu", date, nsec);
701 snprintf(buf, buflen, "%s.%06lu",
702 date, nsec / NSEC_PER_USEC);
709 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
710 struct perf_event_attr *attr, FILE *fp)
712 return perf_sample__fprintf_regs(&sample->intr_regs,
713 attr->sample_regs_intr, fp);
716 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
717 struct perf_event_attr *attr, FILE *fp)
719 return perf_sample__fprintf_regs(&sample->user_regs,
720 attr->sample_regs_user, fp);
723 static int perf_sample__fprintf_start(struct perf_script *script,
724 struct perf_sample *sample,
725 struct thread *thread,
729 struct perf_event_attr *attr = &evsel->core.attr;
731 unsigned long long nsecs;
735 if (PRINT_FIELD(COMM)) {
736 const char *comm = thread ? thread__comm_str(thread) : ":-1";
739 printed += fprintf(fp, "%8.8s ", comm);
740 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
741 printed += fprintf(fp, "%s ", comm);
743 printed += fprintf(fp, "%16s ", comm);
746 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
747 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
748 else if (PRINT_FIELD(PID))
749 printed += fprintf(fp, "%5d ", sample->pid);
750 else if (PRINT_FIELD(TID))
751 printed += fprintf(fp, "%5d ", sample->tid);
753 if (PRINT_FIELD(CPU)) {
755 printed += fprintf(fp, "%3d ", sample->cpu);
757 printed += fprintf(fp, "[%03d] ", sample->cpu);
760 if (PRINT_FIELD(MISC)) {
764 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
767 ret += fprintf(fp, "K");
769 ret += fprintf(fp, "U");
771 ret += fprintf(fp, "H");
772 if (has(GUEST_KERNEL))
773 ret += fprintf(fp, "G");
775 ret += fprintf(fp, "g");
778 case PERF_RECORD_MMAP:
779 case PERF_RECORD_MMAP2:
781 ret += fprintf(fp, "M");
783 case PERF_RECORD_COMM:
785 ret += fprintf(fp, "E");
787 case PERF_RECORD_SWITCH:
788 case PERF_RECORD_SWITCH_CPU_WIDE:
789 if (has(SWITCH_OUT)) {
790 ret += fprintf(fp, "S");
791 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
792 ret += fprintf(fp, "p");
800 ret += fprintf(fp, "%*s", 6 - ret, " ");
804 if (PRINT_FIELD(TOD)) {
805 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
806 printed += fprintf(fp, "%s ", tstr);
809 if (PRINT_FIELD(TIME)) {
810 u64 t = sample->time;
813 initial_time = sample->time;
814 t = sample->time - initial_time;
815 } else if (deltatime) {
817 t = sample->time - previous_time;
821 previous_time = sample->time;
824 secs = nsecs / NSEC_PER_SEC;
825 nsecs -= secs * NSEC_PER_SEC;
827 if (symbol_conf.nanosecs)
828 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
830 char sample_time[32];
831 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
832 printed += fprintf(fp, "%12s: ", sample_time);
840 mispred_str(struct branch_entry *br)
842 if (!(br->flags.mispred || br->flags.predicted))
845 return br->flags.predicted ? 'P' : 'M';
848 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
849 struct thread *thread,
850 struct perf_event_attr *attr, FILE *fp)
852 struct branch_stack *br = sample->branch_stack;
853 struct branch_entry *entries = perf_sample__branch_entries(sample);
854 struct addr_location alf, alt;
861 for (i = 0; i < br->nr; i++) {
862 from = entries[i].from;
865 if (PRINT_FIELD(DSO)) {
866 memset(&alf, 0, sizeof(alf));
867 memset(&alt, 0, sizeof(alt));
868 thread__find_map_fb(thread, sample->cpumode, from, &alf);
869 thread__find_map_fb(thread, sample->cpumode, to, &alt);
872 printed += fprintf(fp, " 0x%"PRIx64, from);
873 if (PRINT_FIELD(DSO)) {
874 printed += fprintf(fp, "(");
875 printed += map__fprintf_dsoname(alf.map, fp);
876 printed += fprintf(fp, ")");
879 printed += fprintf(fp, "/0x%"PRIx64, to);
880 if (PRINT_FIELD(DSO)) {
881 printed += fprintf(fp, "(");
882 printed += map__fprintf_dsoname(alt.map, fp);
883 printed += fprintf(fp, ")");
886 printed += fprintf(fp, "/%c/%c/%c/%d ",
887 mispred_str(entries + i),
888 entries[i].flags.in_tx ? 'X' : '-',
889 entries[i].flags.abort ? 'A' : '-',
890 entries[i].flags.cycles);
896 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
897 struct thread *thread,
898 struct perf_event_attr *attr, FILE *fp)
900 struct branch_stack *br = sample->branch_stack;
901 struct branch_entry *entries = perf_sample__branch_entries(sample);
902 struct addr_location alf, alt;
909 for (i = 0; i < br->nr; i++) {
911 memset(&alf, 0, sizeof(alf));
912 memset(&alt, 0, sizeof(alt));
913 from = entries[i].from;
916 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
917 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
919 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
920 if (PRINT_FIELD(DSO)) {
921 printed += fprintf(fp, "(");
922 printed += map__fprintf_dsoname(alf.map, fp);
923 printed += fprintf(fp, ")");
925 printed += fprintf(fp, "%c", '/');
926 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
927 if (PRINT_FIELD(DSO)) {
928 printed += fprintf(fp, "(");
929 printed += map__fprintf_dsoname(alt.map, fp);
930 printed += fprintf(fp, ")");
932 printed += fprintf(fp, "/%c/%c/%c/%d ",
933 mispred_str(entries + i),
934 entries[i].flags.in_tx ? 'X' : '-',
935 entries[i].flags.abort ? 'A' : '-',
936 entries[i].flags.cycles);
942 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
943 struct thread *thread,
944 struct perf_event_attr *attr, FILE *fp)
946 struct branch_stack *br = sample->branch_stack;
947 struct branch_entry *entries = perf_sample__branch_entries(sample);
948 struct addr_location alf, alt;
955 for (i = 0; i < br->nr; i++) {
957 memset(&alf, 0, sizeof(alf));
958 memset(&alt, 0, sizeof(alt));
959 from = entries[i].from;
962 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
963 !alf.map->dso->adjust_symbols)
964 from = map__map_ip(alf.map, from);
966 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
967 !alt.map->dso->adjust_symbols)
968 to = map__map_ip(alt.map, to);
970 printed += fprintf(fp, " 0x%"PRIx64, from);
971 if (PRINT_FIELD(DSO)) {
972 printed += fprintf(fp, "(");
973 printed += map__fprintf_dsoname(alf.map, fp);
974 printed += fprintf(fp, ")");
976 printed += fprintf(fp, "/0x%"PRIx64, to);
977 if (PRINT_FIELD(DSO)) {
978 printed += fprintf(fp, "(");
979 printed += map__fprintf_dsoname(alt.map, fp);
980 printed += fprintf(fp, ")");
982 printed += fprintf(fp, "/%c/%c/%c/%d ",
983 mispred_str(entries + i),
984 entries[i].flags.in_tx ? 'X' : '-',
985 entries[i].flags.abort ? 'A' : '-',
986 entries[i].flags.cycles);
991 #define MAXBB 16384UL
993 static int grab_bb(u8 *buffer, u64 start, u64 end,
994 struct machine *machine, struct thread *thread,
995 bool *is64bit, u8 *cpumode, bool last)
998 struct addr_location al;
1004 kernel = machine__kernel_ip(machine, start);
1006 *cpumode = PERF_RECORD_MISC_KERNEL;
1008 *cpumode = PERF_RECORD_MISC_USER;
1011 * Block overlaps between kernel and user.
1012 * This can happen due to ring filtering
1013 * On Intel CPUs the entry into the kernel is filtered,
1014 * but the exit is not. Let the caller patch it up.
1016 if (kernel != machine__kernel_ip(machine, end)) {
1017 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1021 memset(&al, 0, sizeof(al));
1022 if (end - start > MAXBB - MAXINSN) {
1024 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1026 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1030 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1031 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1034 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1035 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1039 /* Load maps to ensure dso->is_64_bit has been updated */
1042 offset = al.map->map_ip(al.map, start);
1043 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1044 end - start + MAXINSN);
1046 *is64bit = al.map->dso->is_64_bit;
1048 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1053 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1061 if (!map || !map->dso)
1063 srcfile = get_srcline_split(map->dso,
1064 map__rip_2objdump(map, addr),
1069 /* Avoid redundant printing */
1072 !strcmp(state->srcfile, srcfile) &&
1073 state->line == line) {
1078 srccode = find_sourceline(srcfile, line, &len);
1082 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1085 state->srcfile = srcfile;
1095 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1097 struct addr_location al;
1100 memset(&al, 0, sizeof(al));
1101 thread__find_map(thread, cpumode, addr, &al);
1104 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1105 &thread->srccode_state);
1107 ret += printf("\n");
1111 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1112 struct perf_insn *x, u8 *inbuf, int len,
1113 int insn, FILE *fp, int *total_cycles)
1115 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
1116 dump_insn(x, ip, inbuf, len, NULL),
1117 en->flags.predicted ? " PRED" : "",
1118 en->flags.mispred ? " MISPRED" : "",
1119 en->flags.in_tx ? " INTX" : "",
1120 en->flags.abort ? " ABORT" : "");
1121 if (en->flags.cycles) {
1122 *total_cycles += en->flags.cycles;
1123 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1125 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1127 return printed + fprintf(fp, "\n");
1130 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1131 u8 cpumode, int cpu, struct symbol **lastsym,
1132 struct perf_event_attr *attr, FILE *fp)
1134 struct addr_location al;
1135 int off, printed = 0;
1137 memset(&al, 0, sizeof(al));
1139 thread__find_map(thread, cpumode, addr, &al);
1141 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1147 al.sym = map__find_symbol(al.map, al.addr);
1152 if (al.addr < al.sym->end)
1153 off = al.addr - al.sym->start;
1155 off = al.addr - al.map->start - al.sym->start;
1156 printed += fprintf(fp, "\t%s", al.sym->name);
1158 printed += fprintf(fp, "%+d", off);
1159 printed += fprintf(fp, ":");
1160 if (PRINT_FIELD(SRCLINE))
1161 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1162 printed += fprintf(fp, "\n");
1168 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1169 struct thread *thread,
1170 struct perf_event_attr *attr,
1171 struct machine *machine, FILE *fp)
1173 struct branch_stack *br = sample->branch_stack;
1174 struct branch_entry *entries = perf_sample__branch_entries(sample);
1176 int i, insn, len, nr, ilen, printed = 0;
1180 struct symbol *lastsym = NULL;
1181 int total_cycles = 0;
1183 if (!(br && br->nr))
1186 if (max_blocks && nr > max_blocks + 1)
1187 nr = max_blocks + 1;
1190 x.cpu = sample->cpu;
1192 printed += fprintf(fp, "%c", '\n');
1194 /* Handle first from jump, of which we don't know the entry. */
1195 len = grab_bb(buffer, entries[nr-1].from,
1197 machine, thread, &x.is64bit, &x.cpumode, false);
1199 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1200 x.cpumode, x.cpu, &lastsym, attr, fp);
1201 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1202 &x, buffer, len, 0, fp, &total_cycles);
1203 if (PRINT_FIELD(SRCCODE))
1204 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1207 /* Print all blocks */
1208 for (i = nr - 2; i >= 0; i--) {
1209 if (entries[i].from || entries[i].to)
1210 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1213 start = entries[i + 1].to;
1214 end = entries[i].from;
1216 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1217 /* Patch up missing kernel transfers due to ring filters */
1218 if (len == -ENXIO && i > 0) {
1219 end = entries[--i].from;
1220 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1221 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1227 for (off = 0; off < (unsigned)len; off += ilen) {
1228 uint64_t ip = start + off;
1230 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1232 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1234 if (PRINT_FIELD(SRCCODE))
1235 printed += print_srccode(thread, x.cpumode, ip);
1239 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1240 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1243 if (PRINT_FIELD(SRCCODE))
1244 print_srccode(thread, x.cpumode, ip);
1248 if (off != end - start)
1249 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1253 * Hit the branch? In this case we are already done, and the target
1254 * has not been executed yet.
1256 if (entries[0].from == sample->ip)
1258 if (entries[0].flags.abort)
1262 * Print final block upto sample
1264 * Due to pipeline delays the LBRs might be missing a branch
1265 * or two, which can result in very large or negative blocks
1266 * between final branch and sample. When this happens just
1267 * continue walking after the last TO until we hit a branch.
1269 start = entries[0].to;
1272 /* Missing jump. Scan 128 bytes for the next branch */
1275 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1276 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1278 /* Print at least last IP if basic block did not work */
1279 len = grab_bb(buffer, sample->ip, sample->ip,
1280 machine, thread, &x.is64bit, &x.cpumode, false);
1283 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1284 dump_insn(&x, sample->ip, buffer, len, NULL));
1285 if (PRINT_FIELD(SRCCODE))
1286 print_srccode(thread, x.cpumode, sample->ip);
1289 for (off = 0; off <= end - start; off += ilen) {
1291 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1292 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1295 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1297 * Hit a missing branch. Just stop.
1299 printed += fprintf(fp, "\t... not reaching sample ...\n");
1302 if (PRINT_FIELD(SRCCODE))
1303 print_srccode(thread, x.cpumode, start + off);
1309 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1310 struct thread *thread,
1311 struct perf_event_attr *attr, FILE *fp)
1313 struct addr_location al;
1314 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1316 if (!sample_addr_correlates_sym(attr))
1319 thread__resolve(thread, &al, sample);
1321 if (PRINT_FIELD(SYM)) {
1322 printed += fprintf(fp, " ");
1323 if (PRINT_FIELD(SYMOFFSET))
1324 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1326 printed += symbol__fprintf_symname(al.sym, fp);
1329 if (PRINT_FIELD(DSO)) {
1330 printed += fprintf(fp, " (");
1331 printed += map__fprintf_dsoname(al.map, fp);
1332 printed += fprintf(fp, ")");
1338 static const char *resolve_branch_sym(struct perf_sample *sample,
1339 struct evsel *evsel,
1340 struct thread *thread,
1341 struct addr_location *al,
1342 struct addr_location *addr_al,
1345 struct perf_event_attr *attr = &evsel->core.attr;
1346 const char *name = NULL;
1348 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1349 if (sample_addr_correlates_sym(attr)) {
1350 if (!addr_al->thread)
1351 thread__resolve(thread, addr_al, sample);
1353 name = addr_al->sym->name;
1359 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1361 name = al->sym->name;
1368 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1369 struct evsel *evsel,
1370 struct thread *thread,
1371 struct addr_location *al,
1372 struct addr_location *addr_al,
1375 struct perf_event_attr *attr = &evsel->core.attr;
1376 size_t depth = thread_stack__depth(thread, sample->cpu);
1377 const char *name = NULL;
1384 * The 'return' has already been popped off the stack so the depth has
1385 * to be adjusted to match the 'call'.
1387 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1390 name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1392 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1393 dlen += fprintf(fp, "(");
1394 dlen += map__fprintf_dsoname(al->map, fp);
1395 dlen += fprintf(fp, ")\t");
1399 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1401 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1407 * Try to keep the output length from changing frequently so that the
1408 * output lines up more nicely.
1410 if (len > spacing || (len && len < spacing - 52))
1411 spacing = round_up(len + 4, 32);
1414 len += fprintf(fp, "%*s", spacing - len, "");
1419 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1420 struct thread *thread __maybe_unused,
1421 struct machine *machine __maybe_unused)
1425 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1426 struct machine *machine)
1428 if (sample->insn_len == 0 && native_arch)
1429 arch_fetch_insn(sample, thread, machine);
1432 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1433 struct perf_event_attr *attr,
1434 struct thread *thread,
1435 struct machine *machine, FILE *fp)
1439 script_fetch_insn(sample, thread, machine);
1441 if (PRINT_FIELD(INSNLEN))
1442 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1443 if (PRINT_FIELD(INSN) && sample->insn_len) {
1446 printed += fprintf(fp, " insn:");
1447 for (i = 0; i < sample->insn_len; i++)
1448 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1450 if (PRINT_FIELD(BRSTACKINSN))
1451 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1456 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1457 struct perf_event_attr *attr, FILE *fp)
1461 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1464 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1466 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1467 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1470 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1471 struct evsel *evsel,
1472 struct thread *thread,
1473 struct addr_location *al,
1474 struct addr_location *addr_al,
1475 struct machine *machine, FILE *fp)
1477 struct perf_event_attr *attr = &evsel->core.attr;
1478 unsigned int type = output_type(attr->type);
1479 bool print_srcline_last = false;
1482 if (PRINT_FIELD(CALLINDENT))
1483 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1485 /* print branch_from information */
1486 if (PRINT_FIELD(IP)) {
1487 unsigned int print_opts = output[type].print_ip_opts;
1488 struct callchain_cursor *cursor = NULL;
1490 if (symbol_conf.use_callchain && sample->callchain &&
1491 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1492 sample, NULL, NULL, scripting_max_stack) == 0)
1493 cursor = &callchain_cursor;
1495 if (cursor == NULL) {
1496 printed += fprintf(fp, " ");
1497 if (print_opts & EVSEL__PRINT_SRCLINE) {
1498 print_srcline_last = true;
1499 print_opts &= ~EVSEL__PRINT_SRCLINE;
1502 printed += fprintf(fp, "\n");
1504 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1505 symbol_conf.bt_stop_list, fp);
1508 /* print branch_to information */
1509 if (PRINT_FIELD(ADDR) ||
1510 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1511 !output[type].user_set)) {
1512 printed += fprintf(fp, " => ");
1513 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1516 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1518 if (print_srcline_last)
1519 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1521 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1522 printed += fprintf(fp, "\n");
1523 if (PRINT_FIELD(SRCCODE)) {
1524 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1525 &thread->srccode_state);
1528 printed += printf("\n");
1537 } sample_flags[] = {
1538 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1539 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1540 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1541 {PERF_IP_FLAG_BRANCH, "jmp"},
1542 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1543 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1544 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1545 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1546 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1547 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1548 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1549 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1550 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1551 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1552 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1556 static const char *sample_flags_to_name(u32 flags)
1560 for (i = 0; sample_flags[i].name ; i++) {
1561 if (sample_flags[i].flags == flags)
1562 return sample_flags[i].name;
1568 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1570 const char *chars = PERF_IP_FLAG_CHARS;
1571 const size_t n = strlen(PERF_IP_FLAG_CHARS);
1572 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1573 const char *name = NULL;
1576 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1578 return snprintf(str, sz, "%-15s%4s", name, in_tx ? "(x)" : "");
1580 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1581 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1583 return snprintf(str, sz, "tr strt %-7s%4s", name, in_tx ? "(x)" : "");
1586 if (flags & PERF_IP_FLAG_TRACE_END) {
1587 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1589 return snprintf(str, sz, "tr end %-7s%4s", name, in_tx ? "(x)" : "");
1592 for (i = 0; i < n; i++, flags >>= 1) {
1593 if ((flags & 1) && pos < sz)
1594 str[pos++] = chars[i];
1596 for (; i < 32; i++, flags >>= 1) {
1597 if ((flags & 1) && pos < sz)
1606 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1608 char str[SAMPLE_FLAGS_BUF_SIZE];
1610 perf_sample__sprintf_flags(flags, str, sizeof(str));
1611 return fprintf(fp, " %-19s ", str);
1614 struct printer_data {
1620 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1622 void *extra, FILE *fp)
1624 unsigned char ch = (unsigned char)val;
1625 struct printer_data *printer_data = extra;
1629 case BINARY_PRINT_DATA_BEGIN:
1630 printed += fprintf(fp, "\n");
1632 case BINARY_PRINT_LINE_BEGIN:
1633 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1636 case BINARY_PRINT_ADDR:
1637 printed += fprintf(fp, " %04x:", val);
1639 case BINARY_PRINT_NUM_DATA:
1640 printed += fprintf(fp, " %02x", val);
1642 case BINARY_PRINT_NUM_PAD:
1643 printed += fprintf(fp, " ");
1645 case BINARY_PRINT_SEP:
1646 printed += fprintf(fp, " ");
1648 case BINARY_PRINT_CHAR_DATA:
1649 if (printer_data->hit_nul && ch)
1650 printer_data->is_printable = false;
1653 printed += fprintf(fp, "%c", '.');
1655 if (!printer_data->is_printable)
1659 printer_data->hit_nul = true;
1661 printer_data->is_printable = false;
1663 printed += fprintf(fp, "%c", ch);
1666 case BINARY_PRINT_CHAR_PAD:
1667 printed += fprintf(fp, " ");
1669 case BINARY_PRINT_LINE_END:
1670 printed += fprintf(fp, "\n");
1671 printer_data->line_no++;
1673 case BINARY_PRINT_DATA_END:
1681 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1683 unsigned int nr_bytes = sample->raw_size;
1684 struct printer_data printer_data = {0, false, true};
1685 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1686 sample__fprintf_bpf_output, &printer_data, fp);
1688 if (printer_data.is_printable && printer_data.hit_nul)
1689 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1694 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1696 if (len > 0 && len < spacing)
1697 return fprintf(fp, "%*s", spacing - len, "");
1702 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1704 return perf_sample__fprintf_spacing(len, 34, fp);
1707 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1709 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1712 if (perf_sample__bad_synth_size(sample, *data))
1715 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1716 data->ip, le64_to_cpu(data->payload));
1717 return len + perf_sample__fprintf_pt_spacing(len, fp);
1720 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1722 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1725 if (perf_sample__bad_synth_size(sample, *data))
1728 len = fprintf(fp, " hints: %#x extensions: %#x ",
1729 data->hints, data->extensions);
1730 return len + perf_sample__fprintf_pt_spacing(len, fp);
1733 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1735 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1738 if (perf_sample__bad_synth_size(sample, *data))
1741 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1742 data->hw, data->cstate, data->subcstate);
1743 return len + perf_sample__fprintf_pt_spacing(len, fp);
1746 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1748 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1751 if (perf_sample__bad_synth_size(sample, *data))
1754 len = fprintf(fp, " IP: %u ", data->ip);
1755 return len + perf_sample__fprintf_pt_spacing(len, fp);
1758 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1760 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1763 if (perf_sample__bad_synth_size(sample, *data))
1766 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1767 data->deepest_cstate, data->last_cstate,
1769 return len + perf_sample__fprintf_pt_spacing(len, fp);
1772 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1774 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1775 unsigned int percent, freq;
1778 if (perf_sample__bad_synth_size(sample, *data))
1781 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1782 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1783 if (data->max_nonturbo) {
1784 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1785 len += fprintf(fp, "(%3u%%) ", percent);
1787 return len + perf_sample__fprintf_pt_spacing(len, fp);
1790 static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1792 struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1795 if (perf_sample__bad_synth_size(sample, *data))
1798 len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1799 return len + perf_sample__fprintf_pt_spacing(len, fp);
1802 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1803 struct evsel *evsel, FILE *fp)
1805 switch (evsel->core.attr.config) {
1806 case PERF_SYNTH_INTEL_PTWRITE:
1807 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1808 case PERF_SYNTH_INTEL_MWAIT:
1809 return perf_sample__fprintf_synth_mwait(sample, fp);
1810 case PERF_SYNTH_INTEL_PWRE:
1811 return perf_sample__fprintf_synth_pwre(sample, fp);
1812 case PERF_SYNTH_INTEL_EXSTOP:
1813 return perf_sample__fprintf_synth_exstop(sample, fp);
1814 case PERF_SYNTH_INTEL_PWRX:
1815 return perf_sample__fprintf_synth_pwrx(sample, fp);
1816 case PERF_SYNTH_INTEL_CBR:
1817 return perf_sample__fprintf_synth_cbr(sample, fp);
1818 case PERF_SYNTH_INTEL_PSB:
1819 return perf_sample__fprintf_synth_psb(sample, fp);
1827 static int evlist__max_name_len(struct evlist *evlist)
1829 struct evsel *evsel;
1832 evlist__for_each_entry(evlist, evsel) {
1833 int len = strlen(evsel__name(evsel));
1835 max = MAX(len, max);
1841 static int data_src__fprintf(u64 data_src, FILE *fp)
1843 struct mem_info mi = { .data_src.val = data_src };
1849 perf_script__meminfo_scnprintf(decode, 100, &mi);
1851 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1855 return fprintf(fp, "%-*s", maxlen, out);
1859 struct perf_sample *sample;
1860 struct thread *thread;
1861 struct evsel *evsel;
1865 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1866 void *ctx, const char *color,
1868 const char *unit, double val)
1870 struct metric_ctx *mctx = ctx;
1874 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1875 PERF_RECORD_SAMPLE, mctx->fp);
1876 fputs("\tmetric: ", mctx->fp);
1878 color_fprintf(mctx->fp, color, fmt, val);
1881 fprintf(mctx->fp, " %s\n", unit);
1884 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1887 struct metric_ctx *mctx = ctx;
1889 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1890 PERF_RECORD_SAMPLE, mctx->fp);
1891 fputs("\tmetric: ", mctx->fp);
1894 static void perf_sample__fprint_metric(struct perf_script *script,
1895 struct thread *thread,
1896 struct evsel *evsel,
1897 struct perf_sample *sample,
1900 struct perf_stat_output_ctx ctx = {
1901 .print_metric = script_print_metric,
1902 .new_line = script_new_line,
1903 .ctx = &(struct metric_ctx) {
1909 .force_header = false,
1915 evlist__alloc_stats(script->session->evlist, false);
1916 if (evsel_script(evsel->leader)->gnum++ == 0)
1917 perf_stat__reset_shadow_stats();
1918 val = sample->period * evsel->scale;
1919 perf_stat__update_shadow_stats(evsel,
1923 evsel_script(evsel)->val = val;
1924 if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1925 for_each_group_member (ev2, evsel->leader) {
1926 perf_stat__print_shadow_stats(&stat_config, ev2,
1927 evsel_script(ev2)->val,
1933 evsel_script(evsel->leader)->gnum = 0;
1937 static bool show_event(struct perf_sample *sample,
1938 struct evsel *evsel,
1939 struct thread *thread,
1940 struct addr_location *al,
1941 struct addr_location *addr_al)
1943 int depth = thread_stack__depth(thread, sample->cpu);
1945 if (!symbol_conf.graph_function)
1948 if (thread->filter) {
1949 if (depth <= thread->filter_entry_depth) {
1950 thread->filter = false;
1955 const char *s = symbol_conf.graph_function;
1957 const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
1963 nlen = strlen(name);
1965 unsigned len = strcspn(s, ",");
1966 if (nlen == len && !strncmp(name, s, len)) {
1967 thread->filter = true;
1968 thread->filter_entry_depth = depth;
1979 static void process_event(struct perf_script *script,
1980 struct perf_sample *sample, struct evsel *evsel,
1981 struct addr_location *al,
1982 struct addr_location *addr_al,
1983 struct machine *machine)
1985 struct thread *thread = al->thread;
1986 struct perf_event_attr *attr = &evsel->core.attr;
1987 unsigned int type = output_type(attr->type);
1988 struct evsel_script *es = evsel->priv;
1990 char str[PAGE_SIZE_NAME_LEN];
1992 if (output[type].fields == 0)
1997 perf_sample__fprintf_start(script, sample, thread, evsel,
1998 PERF_RECORD_SAMPLE, fp);
2000 if (PRINT_FIELD(PERIOD))
2001 fprintf(fp, "%10" PRIu64 " ", sample->period);
2003 if (PRINT_FIELD(EVNAME)) {
2004 const char *evname = evsel__name(evsel);
2006 if (!script->name_width)
2007 script->name_width = evlist__max_name_len(script->session->evlist);
2009 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2013 perf_sample__fprintf_flags(sample->flags, fp);
2015 if (is_bts_event(attr)) {
2016 perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2020 if (PRINT_FIELD(TRACE) && sample->raw_data) {
2021 event_format__fprintf(evsel->tp_format, sample->cpu,
2022 sample->raw_data, sample->raw_size, fp);
2025 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2026 perf_sample__fprintf_synth(sample, evsel, fp);
2028 if (PRINT_FIELD(ADDR))
2029 perf_sample__fprintf_addr(sample, thread, attr, fp);
2031 if (PRINT_FIELD(DATA_SRC))
2032 data_src__fprintf(sample->data_src, fp);
2034 if (PRINT_FIELD(WEIGHT))
2035 fprintf(fp, "%16" PRIu64, sample->weight);
2037 if (PRINT_FIELD(IP)) {
2038 struct callchain_cursor *cursor = NULL;
2040 if (script->stitch_lbr)
2041 al->thread->lbr_stitch_enable = true;
2043 if (symbol_conf.use_callchain && sample->callchain &&
2044 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2045 sample, NULL, NULL, scripting_max_stack) == 0)
2046 cursor = &callchain_cursor;
2048 fputc(cursor ? '\n' : ' ', fp);
2049 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2050 symbol_conf.bt_stop_list, fp);
2053 if (PRINT_FIELD(IREGS))
2054 perf_sample__fprintf_iregs(sample, attr, fp);
2056 if (PRINT_FIELD(UREGS))
2057 perf_sample__fprintf_uregs(sample, attr, fp);
2059 if (PRINT_FIELD(BRSTACK))
2060 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2061 else if (PRINT_FIELD(BRSTACKSYM))
2062 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2063 else if (PRINT_FIELD(BRSTACKOFF))
2064 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2066 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2067 perf_sample__fprintf_bpf_output(sample, fp);
2068 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2070 if (PRINT_FIELD(PHYS_ADDR))
2071 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2073 if (PRINT_FIELD(DATA_PAGE_SIZE))
2074 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2076 if (PRINT_FIELD(CODE_PAGE_SIZE))
2077 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2079 perf_sample__fprintf_ipc(sample, attr, fp);
2083 if (PRINT_FIELD(SRCCODE)) {
2084 if (map__fprintf_srccode(al->map, al->addr, stdout,
2085 &thread->srccode_state))
2089 if (PRINT_FIELD(METRIC))
2090 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2096 static struct scripting_ops *scripting_ops;
2098 static void __process_stat(struct evsel *counter, u64 tstamp)
2100 int nthreads = perf_thread_map__nr(counter->core.threads);
2101 int ncpus = evsel__nr_cpus(counter);
2103 static int header_printed;
2105 if (counter->core.system_wide)
2108 if (!header_printed) {
2109 printf("%3s %8s %15s %15s %15s %15s %s\n",
2110 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2114 for (thread = 0; thread < nthreads; thread++) {
2115 for (cpu = 0; cpu < ncpus; cpu++) {
2116 struct perf_counts_values *counts;
2118 counts = perf_counts(counter->counts, cpu, thread);
2120 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2121 counter->core.cpus->map[cpu],
2122 perf_thread_map__pid(counter->core.threads, thread),
2127 evsel__name(counter));
2132 static void process_stat(struct evsel *counter, u64 tstamp)
2134 if (scripting_ops && scripting_ops->process_stat)
2135 scripting_ops->process_stat(&stat_config, counter, tstamp);
2137 __process_stat(counter, tstamp);
2140 static void process_stat_interval(u64 tstamp)
2142 if (scripting_ops && scripting_ops->process_stat_interval)
2143 scripting_ops->process_stat_interval(tstamp);
2146 static void setup_scripting(void)
2148 setup_perl_scripting();
2149 setup_python_scripting();
2152 static int flush_scripting(void)
2154 return scripting_ops ? scripting_ops->flush_script() : 0;
2157 static int cleanup_scripting(void)
2159 pr_debug("\nperf script stopped\n");
2161 return scripting_ops ? scripting_ops->stop_script() : 0;
2164 static bool filter_cpu(struct perf_sample *sample)
2166 if (cpu_list && sample->cpu != (u32)-1)
2167 return !test_bit(sample->cpu, cpu_bitmap);
2171 static int process_sample_event(struct perf_tool *tool,
2172 union perf_event *event,
2173 struct perf_sample *sample,
2174 struct evsel *evsel,
2175 struct machine *machine)
2177 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2178 struct addr_location al;
2179 struct addr_location addr_al;
2182 /* Set thread to NULL to indicate addr_al and al are not initialized */
2183 addr_al.thread = NULL;
2186 ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2193 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2199 if (sample->time < last_timestamp) {
2200 pr_err("Samples misordered, previous: %" PRIu64
2201 " this: %" PRIu64 "\n", last_timestamp,
2205 last_timestamp = sample->time;
2209 if (filter_cpu(sample))
2212 if (machine__resolve(machine, &al, sample) < 0) {
2213 pr_err("problem processing %d event, skipping it.\n",
2214 event->header.type);
2222 if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2225 if (evswitch__discard(&scr->evswitch, evsel))
2228 ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2235 if (scripting_ops) {
2236 struct addr_location *addr_al_ptr = NULL;
2238 if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2239 sample_addr_correlates_sym(&evsel->core.attr)) {
2240 if (!addr_al.thread)
2241 thread__resolve(al.thread, &addr_al, sample);
2242 addr_al_ptr = &addr_al;
2244 scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2246 process_event(scr, sample, evsel, &al, &addr_al, machine);
2251 addr_location__put(&al);
2255 static int process_attr(struct perf_tool *tool, union perf_event *event,
2256 struct evlist **pevlist)
2258 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2259 struct evlist *evlist;
2260 struct evsel *evsel, *pos;
2263 static struct evsel_script *es;
2265 err = perf_event__process_attr(tool, event, pevlist);
2270 evsel = evlist__last(*pevlist);
2273 if (scr->per_event_dump) {
2274 evsel->priv = evsel_script__new(evsel, scr->session->data);
2276 es = zalloc(sizeof(*es));
2284 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2285 evsel->core.attr.type != PERF_TYPE_SYNTH)
2288 evlist__for_each_entry(evlist, pos) {
2289 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2293 if (evsel->core.attr.sample_type) {
2294 err = evsel__check_attr(evsel, scr->session);
2300 * Check if we need to enable callchains based
2301 * on events sample_type.
2303 sample_type = evlist__combined_sample_type(evlist);
2304 callchain_param_setup(sample_type);
2306 /* Enable fields for callchain entries */
2307 if (symbol_conf.use_callchain &&
2308 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2309 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2310 (sample_type & PERF_SAMPLE_REGS_USER &&
2311 sample_type & PERF_SAMPLE_STACK_USER))) {
2312 int type = output_type(evsel->core.attr.type);
2314 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2315 output[type].fields |= PERF_OUTPUT_IP;
2316 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2317 output[type].fields |= PERF_OUTPUT_SYM;
2319 set_print_ip_opts(&evsel->core.attr);
2323 static int print_event_with_time(struct perf_tool *tool,
2324 union perf_event *event,
2325 struct perf_sample *sample,
2326 struct machine *machine,
2327 pid_t pid, pid_t tid, u64 timestamp)
2329 struct perf_script *script = container_of(tool, struct perf_script, tool);
2330 struct perf_session *session = script->session;
2331 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2332 struct thread *thread = NULL;
2334 if (evsel && !evsel->core.attr.sample_id_all) {
2336 sample->time = timestamp;
2341 if (filter_cpu(sample))
2345 thread = machine__findnew_thread(machine, pid, tid);
2348 perf_sample__fprintf_start(script, sample, thread, evsel,
2349 event->header.type, stdout);
2352 perf_event__fprintf(event, machine, stdout);
2354 thread__put(thread);
2359 static int print_event(struct perf_tool *tool, union perf_event *event,
2360 struct perf_sample *sample, struct machine *machine,
2361 pid_t pid, pid_t tid)
2363 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2366 static int process_comm_event(struct perf_tool *tool,
2367 union perf_event *event,
2368 struct perf_sample *sample,
2369 struct machine *machine)
2371 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2374 return print_event(tool, event, sample, machine, event->comm.pid,
2378 static int process_namespaces_event(struct perf_tool *tool,
2379 union perf_event *event,
2380 struct perf_sample *sample,
2381 struct machine *machine)
2383 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2386 return print_event(tool, event, sample, machine, event->namespaces.pid,
2387 event->namespaces.tid);
2390 static int process_cgroup_event(struct perf_tool *tool,
2391 union perf_event *event,
2392 struct perf_sample *sample,
2393 struct machine *machine)
2395 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2398 return print_event(tool, event, sample, machine, sample->pid,
2402 static int process_fork_event(struct perf_tool *tool,
2403 union perf_event *event,
2404 struct perf_sample *sample,
2405 struct machine *machine)
2407 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2410 return print_event_with_time(tool, event, sample, machine,
2411 event->fork.pid, event->fork.tid,
2414 static int process_exit_event(struct perf_tool *tool,
2415 union perf_event *event,
2416 struct perf_sample *sample,
2417 struct machine *machine)
2419 /* Print before 'exit' deletes anything */
2420 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2421 event->fork.tid, event->fork.time))
2424 return perf_event__process_exit(tool, event, sample, machine);
2427 static int process_mmap_event(struct perf_tool *tool,
2428 union perf_event *event,
2429 struct perf_sample *sample,
2430 struct machine *machine)
2432 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2435 return print_event(tool, event, sample, machine, event->mmap.pid,
2439 static int process_mmap2_event(struct perf_tool *tool,
2440 union perf_event *event,
2441 struct perf_sample *sample,
2442 struct machine *machine)
2444 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2447 return print_event(tool, event, sample, machine, event->mmap2.pid,
2451 static int process_switch_event(struct perf_tool *tool,
2452 union perf_event *event,
2453 struct perf_sample *sample,
2454 struct machine *machine)
2456 struct perf_script *script = container_of(tool, struct perf_script, tool);
2458 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2461 if (scripting_ops && scripting_ops->process_switch)
2462 scripting_ops->process_switch(event, sample, machine);
2464 if (!script->show_switch_events)
2467 return print_event(tool, event, sample, machine, sample->pid,
2471 static int process_auxtrace_error(struct perf_session *session,
2472 union perf_event *event)
2474 if (scripting_ops && scripting_ops->process_auxtrace_error) {
2475 scripting_ops->process_auxtrace_error(session, event);
2479 return perf_event__process_auxtrace_error(session, event);
2483 process_lost_event(struct perf_tool *tool,
2484 union perf_event *event,
2485 struct perf_sample *sample,
2486 struct machine *machine)
2488 return print_event(tool, event, sample, machine, sample->pid,
2493 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2494 union perf_event *event,
2495 struct ordered_events *oe __maybe_unused)
2498 perf_event__fprintf(event, NULL, stdout);
2503 process_bpf_events(struct perf_tool *tool __maybe_unused,
2504 union perf_event *event,
2505 struct perf_sample *sample,
2506 struct machine *machine)
2508 if (machine__process_ksymbol(machine, event, sample) < 0)
2511 return print_event(tool, event, sample, machine, sample->pid,
2515 static int process_text_poke_events(struct perf_tool *tool,
2516 union perf_event *event,
2517 struct perf_sample *sample,
2518 struct machine *machine)
2520 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2523 return print_event(tool, event, sample, machine, sample->pid,
2527 static void sig_handler(int sig __maybe_unused)
2532 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2534 struct evlist *evlist = script->session->evlist;
2535 struct evsel *evsel;
2537 evlist__for_each_entry(evlist, evsel) {
2540 evsel_script__delete(evsel->priv);
2545 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2547 struct evsel *evsel;
2549 evlist__for_each_entry(script->session->evlist, evsel) {
2551 * Already setup? I.e. we may be called twice in cases like
2552 * Intel PT, one for the intel_pt// and dummy events, then
2553 * for the evsels synthesized from the auxtrace info.
2555 * Ses perf_script__process_auxtrace_info.
2557 if (evsel->priv != NULL)
2560 evsel->priv = evsel_script__new(evsel, script->session->data);
2561 if (evsel->priv == NULL)
2562 goto out_err_fclose;
2568 perf_script__fclose_per_event_dump(script);
2572 static int perf_script__setup_per_event_dump(struct perf_script *script)
2574 struct evsel *evsel;
2575 static struct evsel_script es_stdout;
2577 if (script->per_event_dump)
2578 return perf_script__fopen_per_event_dump(script);
2580 es_stdout.fp = stdout;
2582 evlist__for_each_entry(script->session->evlist, evsel)
2583 evsel->priv = &es_stdout;
2588 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2590 struct evsel *evsel;
2592 evlist__for_each_entry(script->session->evlist, evsel) {
2593 struct evsel_script *es = evsel->priv;
2595 evsel_script__fprintf(es, stdout);
2596 evsel_script__delete(es);
2601 static int __cmd_script(struct perf_script *script)
2605 signal(SIGINT, sig_handler);
2607 perf_stat__init_shadow_stats();
2609 /* override event processing functions */
2610 if (script->show_task_events) {
2611 script->tool.comm = process_comm_event;
2612 script->tool.fork = process_fork_event;
2613 script->tool.exit = process_exit_event;
2615 if (script->show_mmap_events) {
2616 script->tool.mmap = process_mmap_event;
2617 script->tool.mmap2 = process_mmap2_event;
2619 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2620 script->tool.context_switch = process_switch_event;
2621 if (scripting_ops && scripting_ops->process_auxtrace_error)
2622 script->tool.auxtrace_error = process_auxtrace_error;
2623 if (script->show_namespace_events)
2624 script->tool.namespaces = process_namespaces_event;
2625 if (script->show_cgroup_events)
2626 script->tool.cgroup = process_cgroup_event;
2627 if (script->show_lost_events)
2628 script->tool.lost = process_lost_event;
2629 if (script->show_round_events) {
2630 script->tool.ordered_events = false;
2631 script->tool.finished_round = process_finished_round_event;
2633 if (script->show_bpf_events) {
2634 script->tool.ksymbol = process_bpf_events;
2635 script->tool.bpf = process_bpf_events;
2637 if (script->show_text_poke_events) {
2638 script->tool.ksymbol = process_bpf_events;
2639 script->tool.text_poke = process_text_poke_events;
2642 if (perf_script__setup_per_event_dump(script)) {
2643 pr_err("Couldn't create the per event dump files\n");
2647 ret = perf_session__process_events(script->session);
2649 if (script->per_event_dump)
2650 perf_script__exit_per_event_dump_stats(script);
2653 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2658 struct script_spec {
2659 struct list_head node;
2660 struct scripting_ops *ops;
2664 static LIST_HEAD(script_specs);
2666 static struct script_spec *script_spec__new(const char *spec,
2667 struct scripting_ops *ops)
2669 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2672 strcpy(s->spec, spec);
2679 static void script_spec__add(struct script_spec *s)
2681 list_add_tail(&s->node, &script_specs);
2684 static struct script_spec *script_spec__find(const char *spec)
2686 struct script_spec *s;
2688 list_for_each_entry(s, &script_specs, node)
2689 if (strcasecmp(s->spec, spec) == 0)
2694 int script_spec_register(const char *spec, struct scripting_ops *ops)
2696 struct script_spec *s;
2698 s = script_spec__find(spec);
2702 s = script_spec__new(spec, ops);
2706 script_spec__add(s);
2711 static struct scripting_ops *script_spec__lookup(const char *spec)
2713 struct script_spec *s = script_spec__find(spec);
2720 static void list_available_languages(void)
2722 struct script_spec *s;
2724 fprintf(stderr, "\n");
2725 fprintf(stderr, "Scripting language extensions (used in "
2726 "perf script -s [spec:]script.[spec]):\n\n");
2728 list_for_each_entry(s, &script_specs, node)
2729 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2731 fprintf(stderr, "\n");
2734 /* Find script file relative to current directory or exec path */
2735 static char *find_script(const char *script)
2737 char path[PATH_MAX];
2739 if (!scripting_ops) {
2740 const char *ext = strrchr(script, '.');
2745 scripting_ops = script_spec__lookup(++ext);
2750 if (access(script, R_OK)) {
2751 char *exec_path = get_argv_exec_path();
2755 snprintf(path, sizeof(path), "%s/scripts/%s/%s",
2756 exec_path, scripting_ops->dirname, script);
2759 if (access(script, R_OK))
2762 return strdup(script);
2765 static int parse_scriptname(const struct option *opt __maybe_unused,
2766 const char *str, int unset __maybe_unused)
2768 char spec[PATH_MAX];
2769 const char *script, *ext;
2772 if (strcmp(str, "lang") == 0) {
2773 list_available_languages();
2777 script = strchr(str, ':');
2780 if (len >= PATH_MAX) {
2781 fprintf(stderr, "invalid language specifier");
2784 strncpy(spec, str, len);
2786 scripting_ops = script_spec__lookup(spec);
2787 if (!scripting_ops) {
2788 fprintf(stderr, "invalid language specifier");
2794 ext = strrchr(script, '.');
2796 fprintf(stderr, "invalid script extension");
2799 scripting_ops = script_spec__lookup(++ext);
2800 if (!scripting_ops) {
2801 fprintf(stderr, "invalid script extension");
2806 script_name = find_script(script);
2808 script_name = strdup(script);
2813 static int parse_output_fields(const struct option *opt __maybe_unused,
2814 const char *arg, int unset __maybe_unused)
2816 char *tok, *strtok_saveptr = NULL;
2817 int i, imax = ARRAY_SIZE(all_output_options);
2820 char *str = strdup(arg);
2822 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2827 /* first word can state for which event type the user is specifying
2828 * the fields. If no type exists, the specified fields apply to all
2829 * event types found in the file minus the invalid fields for a type.
2831 tok = strchr(str, ':');
2835 if (!strcmp(str, "hw"))
2836 type = PERF_TYPE_HARDWARE;
2837 else if (!strcmp(str, "sw"))
2838 type = PERF_TYPE_SOFTWARE;
2839 else if (!strcmp(str, "trace"))
2840 type = PERF_TYPE_TRACEPOINT;
2841 else if (!strcmp(str, "raw"))
2842 type = PERF_TYPE_RAW;
2843 else if (!strcmp(str, "break"))
2844 type = PERF_TYPE_BREAKPOINT;
2845 else if (!strcmp(str, "synth"))
2846 type = OUTPUT_TYPE_SYNTH;
2848 fprintf(stderr, "Invalid event type in field string.\n");
2853 if (output[type].user_set)
2854 pr_warning("Overriding previous field request for %s events.\n",
2857 /* Don't override defaults for +- */
2858 if (strchr(tok, '+') || strchr(tok, '-'))
2861 output[type].fields = 0;
2862 output[type].user_set = true;
2863 output[type].wildcard_set = false;
2867 if (strlen(str) == 0) {
2869 "Cannot set fields to 'none' for all event types.\n");
2874 /* Don't override defaults for +- */
2875 if (strchr(str, '+') || strchr(str, '-'))
2878 if (output_set_by_user())
2879 pr_warning("Overriding previous field request for all events.\n");
2881 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2882 output[j].fields = 0;
2883 output[j].user_set = true;
2884 output[j].wildcard_set = true;
2889 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2895 } else if (*tok == '-') {
2901 if (change != SET && change != DEFAULT)
2906 for (i = 0; i < imax; ++i) {
2907 if (strcmp(tok, all_output_options[i].str) == 0)
2910 if (i == imax && strcmp(tok, "flags") == 0) {
2911 print_flags = change != REMOVE;
2915 fprintf(stderr, "Invalid field requested.\n");
2921 /* add user option to all events types for
2924 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2925 if (output[j].invalid_fields & all_output_options[i].field) {
2926 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2927 all_output_options[i].str, event_type(j));
2929 if (change == REMOVE) {
2930 output[j].fields &= ~all_output_options[i].field;
2931 output[j].user_set_fields &= ~all_output_options[i].field;
2932 output[j].user_unset_fields |= all_output_options[i].field;
2934 output[j].fields |= all_output_options[i].field;
2935 output[j].user_set_fields |= all_output_options[i].field;
2936 output[j].user_unset_fields &= ~all_output_options[i].field;
2938 output[j].user_set = true;
2939 output[j].wildcard_set = true;
2943 if (output[type].invalid_fields & all_output_options[i].field) {
2944 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2945 all_output_options[i].str, event_type(type));
2950 if (change == REMOVE)
2951 output[type].fields &= ~all_output_options[i].field;
2953 output[type].fields |= all_output_options[i].field;
2954 output[type].user_set = true;
2955 output[type].wildcard_set = true;
2960 if (output[type].fields == 0) {
2961 pr_debug("No fields requested for %s type. "
2962 "Events will not be displayed.\n", event_type(type));
2968 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2975 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2976 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2977 if ((lang_dirent->d_type == DT_DIR || \
2978 (lang_dirent->d_type == DT_UNKNOWN && \
2979 is_directory(scripts_path, lang_dirent))) && \
2980 (strcmp(lang_dirent->d_name, ".")) && \
2981 (strcmp(lang_dirent->d_name, "..")))
2983 #define for_each_script(lang_path, lang_dir, script_dirent) \
2984 while ((script_dirent = readdir(lang_dir)) != NULL) \
2985 if (script_dirent->d_type != DT_DIR && \
2986 (script_dirent->d_type != DT_UNKNOWN || \
2987 !is_directory(lang_path, script_dirent)))
2990 #define RECORD_SUFFIX "-record"
2991 #define REPORT_SUFFIX "-report"
2993 struct script_desc {
2994 struct list_head node;
3000 static LIST_HEAD(script_descs);
3002 static struct script_desc *script_desc__new(const char *name)
3004 struct script_desc *s = zalloc(sizeof(*s));
3006 if (s != NULL && name)
3007 s->name = strdup(name);
3012 static void script_desc__delete(struct script_desc *s)
3015 zfree(&s->half_liner);
3020 static void script_desc__add(struct script_desc *s)
3022 list_add_tail(&s->node, &script_descs);
3025 static struct script_desc *script_desc__find(const char *name)
3027 struct script_desc *s;
3029 list_for_each_entry(s, &script_descs, node)
3030 if (strcasecmp(s->name, name) == 0)
3035 static struct script_desc *script_desc__findnew(const char *name)
3037 struct script_desc *s = script_desc__find(name);
3042 s = script_desc__new(name);
3046 script_desc__add(s);
3051 static const char *ends_with(const char *str, const char *suffix)
3053 size_t suffix_len = strlen(suffix);
3054 const char *p = str;
3056 if (strlen(str) > suffix_len) {
3057 p = str + strlen(str) - suffix_len;
3058 if (!strncmp(p, suffix, suffix_len))
3065 static int read_script_info(struct script_desc *desc, const char *filename)
3067 char line[BUFSIZ], *p;
3070 fp = fopen(filename, "r");
3074 while (fgets(line, sizeof(line), fp)) {
3075 p = skip_spaces(line);
3081 if (strlen(p) && *p == '!')
3085 if (strlen(p) && p[strlen(p) - 1] == '\n')
3086 p[strlen(p) - 1] = '\0';
3088 if (!strncmp(p, "description:", strlen("description:"))) {
3089 p += strlen("description:");
3090 desc->half_liner = strdup(skip_spaces(p));
3094 if (!strncmp(p, "args:", strlen("args:"))) {
3095 p += strlen("args:");
3096 desc->args = strdup(skip_spaces(p));
3106 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3108 char *script_root, *str;
3110 script_root = strdup(script_dirent->d_name);
3114 str = (char *)ends_with(script_root, suffix);
3124 static int list_available_scripts(const struct option *opt __maybe_unused,
3125 const char *s __maybe_unused,
3126 int unset __maybe_unused)
3128 struct dirent *script_dirent, *lang_dirent;
3129 char scripts_path[MAXPATHLEN];
3130 DIR *scripts_dir, *lang_dir;
3131 char script_path[MAXPATHLEN];
3132 char lang_path[MAXPATHLEN];
3133 struct script_desc *desc;
3134 char first_half[BUFSIZ];
3137 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3139 scripts_dir = opendir(scripts_path);
3142 "open(%s) failed.\n"
3143 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3148 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3149 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3150 lang_dirent->d_name);
3151 lang_dir = opendir(lang_path);
3155 for_each_script(lang_path, lang_dir, script_dirent) {
3156 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3158 desc = script_desc__findnew(script_root);
3159 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3160 lang_path, script_dirent->d_name);
3161 read_script_info(desc, script_path);
3167 fprintf(stdout, "List of available trace scripts:\n");
3168 list_for_each_entry(desc, &script_descs, node) {
3169 sprintf(first_half, "%s %s", desc->name,
3170 desc->args ? desc->args : "");
3171 fprintf(stdout, " %-36s %s\n", first_half,
3172 desc->half_liner ? desc->half_liner : "");
3179 * Some scripts specify the required events in their "xxx-record" file,
3180 * this function will check if the events in perf.data match those
3181 * mentioned in the "xxx-record".
3183 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3184 * which is covered well now. And new parsing code should be added to
3185 * cover the future complex formats like event groups etc.
3187 static int check_ev_match(char *dir_name, char *scriptname,
3188 struct perf_session *session)
3190 char filename[MAXPATHLEN], evname[128];
3191 char line[BUFSIZ], *p;
3196 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3198 fp = fopen(filename, "r");
3202 while (fgets(line, sizeof(line), fp)) {
3203 p = skip_spaces(line);
3208 p = strstr(p, "-e");
3214 len = strcspn(p, " \t");
3218 snprintf(evname, len + 1, "%s", p);
3221 evlist__for_each_entry(session->evlist, pos) {
3222 if (!strcmp(evsel__name(pos), evname)) {
3240 * Return -1 if none is found, otherwise the actual scripts number.
3242 * Currently the only user of this function is the script browser, which
3243 * will list all statically runnable scripts, select one, execute it and
3244 * show the output in a perf browser.
3246 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3249 struct dirent *script_dirent, *lang_dirent;
3250 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3251 DIR *scripts_dir, *lang_dir;
3252 struct perf_session *session;
3253 struct perf_data data = {
3255 .mode = PERF_DATA_MODE_READ,
3260 session = perf_session__new(&data, false, NULL);
3261 if (IS_ERR(session))
3262 return PTR_ERR(session);
3264 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3266 scripts_dir = opendir(scripts_path);
3268 perf_session__delete(session);
3272 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3273 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3274 lang_dirent->d_name);
3275 #ifndef HAVE_LIBPERL_SUPPORT
3276 if (strstr(lang_path, "perl"))
3279 #ifndef HAVE_LIBPYTHON_SUPPORT
3280 if (strstr(lang_path, "python"))
3284 lang_dir = opendir(lang_path);
3288 for_each_script(lang_path, lang_dir, script_dirent) {
3289 /* Skip those real time scripts: xxxtop.p[yl] */
3290 if (strstr(script_dirent->d_name, "top."))
3294 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3296 script_dirent->d_name);
3297 temp = strchr(script_dirent->d_name, '.');
3298 snprintf(scripts_array[i],
3299 (temp - script_dirent->d_name) + 1,
3300 "%s", script_dirent->d_name);
3302 if (check_ev_match(lang_path,
3303 scripts_array[i], session))
3311 closedir(scripts_dir);
3312 perf_session__delete(session);
3316 static char *get_script_path(const char *script_root, const char *suffix)
3318 struct dirent *script_dirent, *lang_dirent;
3319 char scripts_path[MAXPATHLEN];
3320 char script_path[MAXPATHLEN];
3321 DIR *scripts_dir, *lang_dir;
3322 char lang_path[MAXPATHLEN];
3323 char *__script_root;
3325 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3327 scripts_dir = opendir(scripts_path);
3331 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3332 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3333 lang_dirent->d_name);
3334 lang_dir = opendir(lang_path);
3338 for_each_script(lang_path, lang_dir, script_dirent) {
3339 __script_root = get_script_root(script_dirent, suffix);
3340 if (__script_root && !strcmp(script_root, __script_root)) {
3341 free(__script_root);
3342 closedir(scripts_dir);
3343 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3344 lang_path, script_dirent->d_name);
3346 return strdup(script_path);
3348 free(__script_root);
3352 closedir(scripts_dir);
3357 static bool is_top_script(const char *script_path)
3359 return ends_with(script_path, "top") != NULL;
3362 static int has_required_arg(char *script_path)
3364 struct script_desc *desc;
3368 desc = script_desc__new(NULL);
3370 if (read_script_info(desc, script_path))
3376 for (p = desc->args; *p; p++)
3380 script_desc__delete(desc);
3385 static int have_cmd(int argc, const char **argv)
3387 char **__argv = malloc(sizeof(const char *) * argc);
3390 pr_err("malloc failed\n");
3394 memcpy(__argv, argv, sizeof(const char *) * argc);
3395 argc = parse_options(argc, (const char **)__argv, record_options,
3396 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3399 system_wide = (argc == 0);
3404 static void script__setup_sample_type(struct perf_script *script)
3406 struct perf_session *session = script->session;
3407 u64 sample_type = evlist__combined_sample_type(session->evlist);
3409 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3410 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3411 (sample_type & PERF_SAMPLE_STACK_USER)) {
3412 callchain_param.record_mode = CALLCHAIN_DWARF;
3413 dwarf_callchain_users = true;
3414 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3415 callchain_param.record_mode = CALLCHAIN_LBR;
3417 callchain_param.record_mode = CALLCHAIN_FP;
3420 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3421 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3422 "Please apply --call-graph lbr when recording.\n");
3423 script->stitch_lbr = false;
3427 static int process_stat_round_event(struct perf_session *session,
3428 union perf_event *event)
3430 struct perf_record_stat_round *round = &event->stat_round;
3431 struct evsel *counter;
3433 evlist__for_each_entry(session->evlist, counter) {
3434 perf_stat_process_counter(&stat_config, counter);
3435 process_stat(counter, round->time);
3438 process_stat_interval(round->time);
3442 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3443 union perf_event *event)
3445 perf_event__read_stat_config(&stat_config, &event->stat_config);
3449 static int set_maps(struct perf_script *script)
3451 struct evlist *evlist = script->session->evlist;
3453 if (!script->cpus || !script->threads)
3456 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3459 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3461 if (evlist__alloc_stats(evlist, true))
3464 script->allocated = true;
3469 int process_thread_map_event(struct perf_session *session,
3470 union perf_event *event)
3472 struct perf_tool *tool = session->tool;
3473 struct perf_script *script = container_of(tool, struct perf_script, tool);
3475 if (script->threads) {
3476 pr_warning("Extra thread map event, ignoring.\n");
3480 script->threads = thread_map__new_event(&event->thread_map);
3481 if (!script->threads)
3484 return set_maps(script);
3488 int process_cpu_map_event(struct perf_session *session,
3489 union perf_event *event)
3491 struct perf_tool *tool = session->tool;
3492 struct perf_script *script = container_of(tool, struct perf_script, tool);
3495 pr_warning("Extra cpu map event, ignoring.\n");
3499 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3503 return set_maps(script);
3506 static int process_feature_event(struct perf_session *session,
3507 union perf_event *event)
3509 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3510 return perf_event__process_feature(session, event);
3514 #ifdef HAVE_AUXTRACE_SUPPORT
3515 static int perf_script__process_auxtrace_info(struct perf_session *session,
3516 union perf_event *event)
3518 struct perf_tool *tool = session->tool;
3520 int ret = perf_event__process_auxtrace_info(session, event);
3523 struct perf_script *script = container_of(tool, struct perf_script, tool);
3525 ret = perf_script__setup_per_event_dump(script);
3531 #define perf_script__process_auxtrace_info 0
3534 static int parse_insn_trace(const struct option *opt __maybe_unused,
3535 const char *str __maybe_unused,
3536 int unset __maybe_unused)
3538 parse_output_fields(NULL, "+insn,-event,-period", 0);
3539 itrace_parse_synth_opts(opt, "i0ns", 0);
3540 symbol_conf.nanosecs = true;
3544 static int parse_xed(const struct option *opt __maybe_unused,
3545 const char *str __maybe_unused,
3546 int unset __maybe_unused)
3549 force_pager("xed -F insn: -A -64 | less");
3551 force_pager("xed -F insn: -A -64");
3555 static int parse_call_trace(const struct option *opt __maybe_unused,
3556 const char *str __maybe_unused,
3557 int unset __maybe_unused)
3559 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3560 itrace_parse_synth_opts(opt, "cewp", 0);
3561 symbol_conf.nanosecs = true;
3562 symbol_conf.pad_output_len_dso = 50;
3566 static int parse_callret_trace(const struct option *opt __maybe_unused,
3567 const char *str __maybe_unused,
3568 int unset __maybe_unused)
3570 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3571 itrace_parse_synth_opts(opt, "crewp", 0);
3572 symbol_conf.nanosecs = true;
3576 int cmd_script(int argc, const char **argv)
3578 bool show_full_info = false;
3579 bool header = false;
3580 bool header_only = false;
3581 bool script_started = false;
3582 char *rec_script_path = NULL;
3583 char *rep_script_path = NULL;
3584 struct perf_session *session;
3585 struct itrace_synth_opts itrace_synth_opts = {
3587 .default_no_sample = true,
3590 char *script_path = NULL;
3591 const char *dlfilter_file = NULL;
3592 const char **__argv;
3594 struct perf_script script = {
3596 .sample = process_sample_event,
3597 .mmap = perf_event__process_mmap,
3598 .mmap2 = perf_event__process_mmap2,
3599 .comm = perf_event__process_comm,
3600 .namespaces = perf_event__process_namespaces,
3601 .cgroup = perf_event__process_cgroup,
3602 .exit = perf_event__process_exit,
3603 .fork = perf_event__process_fork,
3604 .attr = process_attr,
3605 .event_update = perf_event__process_event_update,
3606 .tracing_data = perf_event__process_tracing_data,
3607 .feature = process_feature_event,
3608 .build_id = perf_event__process_build_id,
3609 .id_index = perf_event__process_id_index,
3610 .auxtrace_info = perf_script__process_auxtrace_info,
3611 .auxtrace = perf_event__process_auxtrace,
3612 .auxtrace_error = perf_event__process_auxtrace_error,
3613 .stat = perf_event__process_stat_event,
3614 .stat_round = process_stat_round_event,
3615 .stat_config = process_stat_config_event,
3616 .thread_map = process_thread_map_event,
3617 .cpu_map = process_cpu_map_event,
3618 .ordered_events = true,
3619 .ordering_requires_timestamps = true,
3622 struct perf_data data = {
3623 .mode = PERF_DATA_MODE_READ,
3625 const struct option options[] = {
3626 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3627 "dump raw trace in ASCII"),
3628 OPT_INCR('v', "verbose", &verbose,
3629 "be more verbose (show symbol address, etc)"),
3630 OPT_BOOLEAN('L', "Latency", &latency_format,
3631 "show latency attributes (irqs/preemption disabled, etc)"),
3632 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3633 list_available_scripts),
3634 OPT_CALLBACK('s', "script", NULL, "name",
3635 "script file name (lang:script name, script name, or *)",
3637 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3638 "generate perf-script.xx script in specified language"),
3639 OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3640 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3641 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3642 "do various checks like samples ordering and lost events"),
3643 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3644 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3645 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3646 "file", "vmlinux pathname"),
3647 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3648 "file", "kallsyms pathname"),
3649 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3650 "When printing symbols do not display call chain"),
3651 OPT_CALLBACK(0, "symfs", NULL, "directory",
3652 "Look for files with symbols relative to this directory",
3653 symbol__config_symfs),
3654 OPT_CALLBACK('F', "fields", NULL, "str",
3655 "comma separated output fields prepend with 'type:'. "
3656 "+field to add and -field to remove."
3657 "Valid types: hw,sw,trace,raw,synth. "
3658 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3659 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3660 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3661 "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod,"
3662 "data_page_size,code_page_size",
3663 parse_output_fields),
3664 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3665 "system-wide collection from all CPUs"),
3666 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3667 "only consider symbols in these DSOs"),
3668 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3669 "only consider these symbols"),
3670 OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3671 "Use with -S to list traced records within address range"),
3672 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3673 "Decode instructions from itrace", parse_insn_trace),
3674 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3675 "Run xed disassembler on output", parse_xed),
3676 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3677 "Decode calls from from itrace", parse_call_trace),
3678 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3679 "Decode calls and returns from itrace", parse_callret_trace),
3680 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3681 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3682 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3683 "Stop display of callgraph at these symbols"),
3684 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3685 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3686 "only display events for these comms"),
3687 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3688 "only consider symbols in these pids"),
3689 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3690 "only consider symbols in these tids"),
3691 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3692 "Set the maximum stack depth when parsing the callchain, "
3693 "anything beyond the specified depth will be ignored. "
3694 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3695 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3696 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3697 OPT_BOOLEAN('I', "show-info", &show_full_info,
3698 "display extended information from perf.data file"),
3699 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3700 "Show the path of [kernel.kallsyms]"),
3701 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3702 "Show the fork/comm/exit events"),
3703 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3704 "Show the mmap events"),
3705 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3706 "Show context switch events (if recorded)"),
3707 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3708 "Show namespace events (if recorded)"),
3709 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3710 "Show cgroup events (if recorded)"),
3711 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3712 "Show lost events (if recorded)"),
3713 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3714 "Show round events (if recorded)"),
3715 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3716 "Show bpf related events (if recorded)"),
3717 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3718 "Show text poke related events (if recorded)"),
3719 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3720 "Dump trace output to files named by the monitored events"),
3721 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3722 OPT_INTEGER(0, "max-blocks", &max_blocks,
3723 "Maximum number of code blocks to dump with brstackinsn"),
3724 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3725 "Use 9 decimal places when displaying time"),
3726 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3727 "Instruction Tracing options\n" ITRACE_HELP,
3728 itrace_parse_synth_opts),
3729 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3730 "Show full source file name path for source lines"),
3731 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3732 "Enable symbol demangling"),
3733 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3734 "Enable kernel symbol demangling"),
3735 OPT_STRING(0, "time", &script.time_str, "str",
3736 "Time span of interest (start,stop)"),
3737 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3738 "Show inline function"),
3739 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3740 "guest mount directory under which every guest os"
3741 " instance has a subdir"),
3742 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3743 "file", "file saving guest os vmlinux"),
3744 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3745 "file", "file saving guest os /proc/kallsyms"),
3746 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3747 "file", "file saving guest os /proc/modules"),
3748 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3749 "Enable LBR callgraph stitching approach"),
3750 OPTS_EVSWITCH(&script.evswitch),
3753 const char * const script_subcommands[] = { "record", "report", NULL };
3754 const char *script_usage[] = {
3755 "perf script [<options>]",
3756 "perf script [<options>] record <script> [<record-options>] <command>",
3757 "perf script [<options>] report <script> [script-args]",
3758 "perf script [<options>] <script> [<record-options>] <command>",
3759 "perf script [<options>] <top-script> [script-args]",
3763 perf_set_singlethreaded();
3767 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3768 PARSE_OPT_STOP_AT_NON_OPTION);
3770 if (symbol_conf.guestmount ||
3771 symbol_conf.default_guest_vmlinux_name ||
3772 symbol_conf.default_guest_kallsyms ||
3773 symbol_conf.default_guest_modules) {
3775 * Enable guest sample processing.
3780 data.path = input_name;
3781 data.force = symbol_conf.force;
3783 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3784 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3785 if (!rec_script_path)
3786 return cmd_record(argc, argv);
3789 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3790 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3791 if (!rep_script_path) {
3793 "Please specify a valid report script"
3794 "(see 'perf script -l' for listing)\n");
3799 if (reltime && deltatime) {
3801 "reltime and deltatime - the two don't get along well. "
3802 "Please limit to --reltime or --deltatime.\n");
3806 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3807 itrace_synth_opts.callchain_sz > scripting_max_stack)
3808 scripting_max_stack = itrace_synth_opts.callchain_sz;
3810 /* make sure PERF_EXEC_PATH is set for scripts */
3811 set_argv_exec_path(get_argv_exec_path());
3813 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3818 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3819 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3821 if (!rec_script_path && !rep_script_path) {
3822 script_name = find_script(argv[0]);
3828 usage_with_options_msg(script_usage, options,
3829 "Couldn't find script `%s'\n\n See perf"
3830 " script -l for available scripts.\n", argv[0]);
3833 if (is_top_script(argv[0])) {
3834 rep_args = argc - 1;
3838 rep_args = has_required_arg(rep_script_path);
3839 rec_args = (argc - 1) - rep_args;
3841 usage_with_options_msg(script_usage, options,
3842 "`%s' script requires options."
3843 "\n\n See perf script -l for available "
3844 "scripts and options.\n", argv[0]);
3848 if (pipe(live_pipe) < 0) {
3849 perror("failed to create pipe");
3855 perror("failed to fork");
3862 dup2(live_pipe[1], 1);
3863 close(live_pipe[0]);
3865 if (is_top_script(argv[0])) {
3867 } else if (!system_wide) {
3868 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3874 __argv = malloc((argc + 6) * sizeof(const char *));
3876 pr_err("malloc failed\n");
3881 __argv[j++] = "/bin/sh";
3882 __argv[j++] = rec_script_path;
3888 for (i = rep_args + 1; i < argc; i++)
3889 __argv[j++] = argv[i];
3892 execvp("/bin/sh", (char **)__argv);
3897 dup2(live_pipe[0], 0);
3898 close(live_pipe[1]);
3900 __argv = malloc((argc + 4) * sizeof(const char *));
3902 pr_err("malloc failed\n");
3908 __argv[j++] = "/bin/sh";
3909 __argv[j++] = rep_script_path;
3910 for (i = 1; i < rep_args + 1; i++)
3911 __argv[j++] = argv[i];
3916 execvp("/bin/sh", (char **)__argv);
3921 if (rec_script_path)
3922 script_path = rec_script_path;
3923 if (rep_script_path)
3924 script_path = rep_script_path;
3929 if (!rec_script_path)
3930 system_wide = false;
3931 else if (!system_wide) {
3932 if (have_cmd(argc - 1, &argv[1]) != 0) {
3938 __argv = malloc((argc + 2) * sizeof(const char *));
3940 pr_err("malloc failed\n");
3945 __argv[j++] = "/bin/sh";
3946 __argv[j++] = script_path;
3949 for (i = 2; i < argc; i++)
3950 __argv[j++] = argv[i];
3953 execvp("/bin/sh", (char **)__argv);
3958 if (dlfilter_file) {
3959 dlfilter = dlfilter__new(dlfilter_file);
3969 session = perf_session__new(&data, false, &script.tool);
3970 if (IS_ERR(session))
3971 return PTR_ERR(session);
3973 if (header || header_only) {
3974 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3975 perf_session__fprintf_info(session, stdout, show_full_info);
3980 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3982 if (symbol__init(&session->header.env) < 0)
3986 if (data.is_pipe || /* assume pipe_mode indicates native_arch */
3987 !strcmp(uts.machine, session->header.env.arch) ||
3988 (!strcmp(uts.machine, "x86_64") &&
3989 !strcmp(session->header.env.arch, "i386")))
3992 script.session = session;
3993 script__setup_sample_type(&script);
3995 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3996 symbol_conf.graph_function)
3997 itrace_synth_opts.thread_stack = true;
3999 session->itrace_synth_opts = &itrace_synth_opts;
4002 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4005 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4009 symbol_conf.use_callchain = true;
4011 symbol_conf.use_callchain = false;
4013 if (session->tevent.pevent &&
4014 tep_set_function_resolver(session->tevent.pevent,
4015 machine__resolve_kernel_addr,
4016 &session->machines.host) < 0) {
4017 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4022 if (generate_script_lang) {
4023 struct stat perf_stat;
4026 if (output_set_by_user()) {
4028 "custom fields not supported for generated scripts");
4033 input = open(data.path, O_RDONLY); /* input_name */
4036 perror("failed to open file");
4040 err = fstat(input, &perf_stat);
4042 perror("failed to stat file");
4046 if (!perf_stat.st_size) {
4047 fprintf(stderr, "zero-sized file, nothing to do!\n");
4051 scripting_ops = script_spec__lookup(generate_script_lang);
4052 if (!scripting_ops) {
4053 fprintf(stderr, "invalid language specifier");
4058 err = scripting_ops->generate_script(session->tevent.pevent,
4063 err = dlfilter__start(dlfilter, session);
4068 err = scripting_ops->start_script(script_name, argc, argv, session);
4071 pr_debug("perf script started with script %s\n\n", script_name);
4072 script_started = true;
4076 err = perf_session__check_output_opt(session);
4080 if (script.time_str) {
4081 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4082 &script.ptime_range,
4089 itrace_synth_opts__set_time_range(&itrace_synth_opts,
4094 err = evswitch__init(&script.evswitch, session->evlist, stderr);
4098 if (zstd_init(&(session->zstd_data), 0) < 0)
4099 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4101 err = __cmd_script(&script);
4106 if (script.ptime_range) {
4107 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4108 zfree(&script.ptime_range);
4111 evlist__free_stats(session->evlist);
4112 perf_session__delete(session);
4115 cleanup_scripting();
4116 dlfilter__cleanup(dlfilter);