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"
19 #include "util/evlist.h"
20 #include "util/evsel.h"
21 #include "util/evsel_fprintf.h"
22 #include "util/evswitch.h"
23 #include "util/sort.h"
24 #include "util/data.h"
25 #include "util/auxtrace.h"
26 #include "util/cpumap.h"
27 #include "util/thread_map.h"
28 #include "util/stat.h"
29 #include "util/color.h"
30 #include "util/string2.h"
31 #include "util/thread-stack.h"
32 #include "util/time-utils.h"
33 #include "util/path.h"
34 #include "util/event.h"
36 #include "print_binary.h"
38 #include <linux/bitmap.h>
39 #include <linux/kernel.h>
40 #include <linux/stringify.h>
41 #include <linux/time64.h>
42 #include <linux/zalloc.h>
43 #include <sys/utsname.h>
45 #include "util/mem-events.h"
46 #include "util/dump-insn.h"
51 #include <sys/param.h>
52 #include <sys/types.h>
56 #include <subcmd/pager.h>
57 #include <perf/evlist.h>
58 #include <linux/err.h>
59 #include "util/dlfilter.h"
60 #include "util/record.h"
61 #include "util/util.h"
62 #include "util/cgroup.h"
65 #include <linux/ctype.h>
66 #ifdef HAVE_LIBTRACEEVENT
67 #include <traceevent/event-parse.h>
70 static char const *script_name;
71 static char const *generate_script_lang;
73 static bool deltatime;
74 static u64 initial_time;
75 static u64 previous_time;
76 static bool debug_mode;
77 static u64 last_timestamp;
78 static u64 nr_unordered;
79 static bool no_callchain;
80 static bool latency_format;
81 static bool system_wide;
82 static bool print_flags;
83 static const char *cpu_list;
84 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
85 static struct perf_stat_config stat_config;
86 static int max_blocks;
87 static bool native_arch;
88 static struct dlfilter *dlfilter;
92 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
94 enum perf_output_field {
95 PERF_OUTPUT_COMM = 1ULL << 0,
96 PERF_OUTPUT_TID = 1ULL << 1,
97 PERF_OUTPUT_PID = 1ULL << 2,
98 PERF_OUTPUT_TIME = 1ULL << 3,
99 PERF_OUTPUT_CPU = 1ULL << 4,
100 PERF_OUTPUT_EVNAME = 1ULL << 5,
101 PERF_OUTPUT_TRACE = 1ULL << 6,
102 PERF_OUTPUT_IP = 1ULL << 7,
103 PERF_OUTPUT_SYM = 1ULL << 8,
104 PERF_OUTPUT_DSO = 1ULL << 9,
105 PERF_OUTPUT_ADDR = 1ULL << 10,
106 PERF_OUTPUT_SYMOFFSET = 1ULL << 11,
107 PERF_OUTPUT_SRCLINE = 1ULL << 12,
108 PERF_OUTPUT_PERIOD = 1ULL << 13,
109 PERF_OUTPUT_IREGS = 1ULL << 14,
110 PERF_OUTPUT_BRSTACK = 1ULL << 15,
111 PERF_OUTPUT_BRSTACKSYM = 1ULL << 16,
112 PERF_OUTPUT_DATA_SRC = 1ULL << 17,
113 PERF_OUTPUT_WEIGHT = 1ULL << 18,
114 PERF_OUTPUT_BPF_OUTPUT = 1ULL << 19,
115 PERF_OUTPUT_CALLINDENT = 1ULL << 20,
116 PERF_OUTPUT_INSN = 1ULL << 21,
117 PERF_OUTPUT_INSNLEN = 1ULL << 22,
118 PERF_OUTPUT_BRSTACKINSN = 1ULL << 23,
119 PERF_OUTPUT_BRSTACKOFF = 1ULL << 24,
120 PERF_OUTPUT_SYNTH = 1ULL << 25,
121 PERF_OUTPUT_PHYS_ADDR = 1ULL << 26,
122 PERF_OUTPUT_UREGS = 1ULL << 27,
123 PERF_OUTPUT_METRIC = 1ULL << 28,
124 PERF_OUTPUT_MISC = 1ULL << 29,
125 PERF_OUTPUT_SRCCODE = 1ULL << 30,
126 PERF_OUTPUT_IPC = 1ULL << 31,
127 PERF_OUTPUT_TOD = 1ULL << 32,
128 PERF_OUTPUT_DATA_PAGE_SIZE = 1ULL << 33,
129 PERF_OUTPUT_CODE_PAGE_SIZE = 1ULL << 34,
130 PERF_OUTPUT_INS_LAT = 1ULL << 35,
131 PERF_OUTPUT_BRSTACKINSNLEN = 1ULL << 36,
132 PERF_OUTPUT_MACHINE_PID = 1ULL << 37,
133 PERF_OUTPUT_VCPU = 1ULL << 38,
134 PERF_OUTPUT_CGROUP = 1ULL << 39,
135 PERF_OUTPUT_RETIRE_LAT = 1ULL << 40,
139 struct perf_tool tool;
140 struct perf_session *session;
141 bool show_task_events;
142 bool show_mmap_events;
143 bool show_switch_events;
144 bool show_namespace_events;
145 bool show_lost_events;
146 bool show_round_events;
147 bool show_bpf_events;
148 bool show_cgroup_events;
149 bool show_text_poke_events;
153 struct evswitch evswitch;
154 struct perf_cpu_map *cpus;
155 struct perf_thread_map *threads;
157 const char *time_str;
158 struct perf_time_interval *ptime_range;
163 struct output_option {
165 enum perf_output_field field;
166 } all_output_options[] = {
167 {.str = "comm", .field = PERF_OUTPUT_COMM},
168 {.str = "tid", .field = PERF_OUTPUT_TID},
169 {.str = "pid", .field = PERF_OUTPUT_PID},
170 {.str = "time", .field = PERF_OUTPUT_TIME},
171 {.str = "cpu", .field = PERF_OUTPUT_CPU},
172 {.str = "event", .field = PERF_OUTPUT_EVNAME},
173 {.str = "trace", .field = PERF_OUTPUT_TRACE},
174 {.str = "ip", .field = PERF_OUTPUT_IP},
175 {.str = "sym", .field = PERF_OUTPUT_SYM},
176 {.str = "dso", .field = PERF_OUTPUT_DSO},
177 {.str = "addr", .field = PERF_OUTPUT_ADDR},
178 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
179 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
180 {.str = "period", .field = PERF_OUTPUT_PERIOD},
181 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
182 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
183 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
184 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
185 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
186 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
187 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
188 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
189 {.str = "insn", .field = PERF_OUTPUT_INSN},
190 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
191 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
192 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
193 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
194 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
195 {.str = "metric", .field = PERF_OUTPUT_METRIC},
196 {.str = "misc", .field = PERF_OUTPUT_MISC},
197 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
198 {.str = "ipc", .field = PERF_OUTPUT_IPC},
199 {.str = "tod", .field = PERF_OUTPUT_TOD},
200 {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
201 {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
202 {.str = "ins_lat", .field = PERF_OUTPUT_INS_LAT},
203 {.str = "brstackinsnlen", .field = PERF_OUTPUT_BRSTACKINSNLEN},
204 {.str = "machine_pid", .field = PERF_OUTPUT_MACHINE_PID},
205 {.str = "vcpu", .field = PERF_OUTPUT_VCPU},
206 {.str = "cgroup", .field = PERF_OUTPUT_CGROUP},
207 {.str = "retire_lat", .field = PERF_OUTPUT_RETIRE_LAT},
211 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
216 /* default set to maintain compatibility with current format */
220 unsigned int print_ip_opts;
224 u64 user_unset_fields;
225 } output[OUTPUT_TYPE_MAX] = {
227 [PERF_TYPE_HARDWARE] = {
230 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
231 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
232 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
233 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
234 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
236 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
239 [PERF_TYPE_SOFTWARE] = {
242 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
243 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
244 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
245 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
246 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
247 PERF_OUTPUT_BPF_OUTPUT,
249 .invalid_fields = PERF_OUTPUT_TRACE,
252 [PERF_TYPE_TRACEPOINT] = {
255 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
256 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
257 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
260 [PERF_TYPE_HW_CACHE] = {
263 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
264 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
265 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
266 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
267 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
269 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
275 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
276 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
277 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
278 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
279 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
280 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
281 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
282 PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
283 PERF_OUTPUT_INS_LAT | PERF_OUTPUT_RETIRE_LAT,
285 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
288 [PERF_TYPE_BREAKPOINT] = {
291 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
292 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
293 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
294 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
295 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
297 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
300 [OUTPUT_TYPE_SYNTH] = {
303 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
304 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
305 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
306 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
307 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
309 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
312 [OUTPUT_TYPE_OTHER] = {
315 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
316 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
317 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
318 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
319 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
321 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
325 struct evsel_script {
329 /* For metric output */
334 static inline struct evsel_script *evsel_script(struct evsel *evsel)
336 return (struct evsel_script *)evsel->priv;
339 static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
341 struct evsel_script *es = zalloc(sizeof(*es));
344 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
346 es->fp = fopen(es->filename, "w");
348 goto out_free_filename;
353 zfree(&es->filename);
359 static void evsel_script__delete(struct evsel_script *es)
361 zfree(&es->filename);
367 static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
371 fstat(fileno(es->fp), &st);
372 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
373 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
376 static inline int output_type(unsigned int type)
379 case PERF_TYPE_SYNTH:
380 return OUTPUT_TYPE_SYNTH;
382 if (type < PERF_TYPE_MAX)
386 return OUTPUT_TYPE_OTHER;
389 static bool output_set_by_user(void)
392 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
393 if (output[j].user_set)
399 static const char *output_field2str(enum perf_output_field field)
401 int i, imax = ARRAY_SIZE(all_output_options);
402 const char *str = "";
404 for (i = 0; i < imax; ++i) {
405 if (all_output_options[i].field == field) {
406 str = all_output_options[i].str;
413 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
415 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
416 enum perf_output_field field, bool allow_user_set)
418 struct perf_event_attr *attr = &evsel->core.attr;
419 int type = output_type(attr->type);
422 if (attr->sample_type & sample_type)
425 if (output[type].user_set_fields & field) {
428 evname = evsel__name(evsel);
429 pr_err("Samples for '%s' event do not have %s attribute set. "
430 "Cannot print '%s' field.\n",
431 evname, sample_msg, output_field2str(field));
435 /* user did not ask for it explicitly so remove from the default list */
436 output[type].fields &= ~field;
437 evname = evsel__name(evsel);
438 pr_debug("Samples for '%s' event do not have %s attribute set. "
439 "Skipping '%s' field.\n",
440 evname, sample_msg, output_field2str(field));
445 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
446 enum perf_output_field field)
448 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
451 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
453 struct perf_event_attr *attr = &evsel->core.attr;
456 if (evsel__is_dummy_event(evsel))
459 if (perf_header__has_feat(&session->header, HEADER_STAT))
462 allow_user_set = perf_header__has_feat(&session->header,
465 if (PRINT_FIELD(TRACE) &&
466 !perf_session__has_traces(session, "record -R"))
469 if (PRINT_FIELD(IP)) {
470 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
474 if (PRINT_FIELD(ADDR) &&
475 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
478 if (PRINT_FIELD(DATA_SRC) &&
479 evsel__do_check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC, allow_user_set))
482 if (PRINT_FIELD(WEIGHT) &&
483 evsel__do_check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT, allow_user_set))
486 if (PRINT_FIELD(SYM) &&
487 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
488 pr_err("Display of symbols requested but neither sample IP nor "
489 "sample address\navailable. Hence, no addresses to convert "
493 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
494 pr_err("Display of offsets requested but symbol is not"
498 if (PRINT_FIELD(DSO) &&
499 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
500 pr_err("Display of DSO requested but no address to convert.\n");
503 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
504 pr_err("Display of source line number requested but sample IP is not\n"
505 "selected. Hence, no address to lookup the source line number.\n");
508 if ((PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN)) && !allow_user_set &&
509 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
510 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
511 "Hint: run 'perf record -b ...'\n");
514 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
515 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
518 if (PRINT_FIELD(TIME) &&
519 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
522 if (PRINT_FIELD(CPU) &&
523 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
526 if (PRINT_FIELD(IREGS) &&
527 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
530 if (PRINT_FIELD(UREGS) &&
531 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
534 if (PRINT_FIELD(PHYS_ADDR) &&
535 evsel__do_check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR, allow_user_set))
538 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
539 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
542 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
543 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
546 if (PRINT_FIELD(INS_LAT) &&
547 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
550 if (PRINT_FIELD(CGROUP) &&
551 evsel__check_stype(evsel, PERF_SAMPLE_CGROUP, "CGROUP", PERF_OUTPUT_CGROUP)) {
552 pr_err("Hint: run 'perf record --all-cgroups ...'\n");
556 if (PRINT_FIELD(RETIRE_LAT) &&
557 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_RETIRE_LAT))
563 static void set_print_ip_opts(struct perf_event_attr *attr)
565 unsigned int type = output_type(attr->type);
567 output[type].print_ip_opts = 0;
569 output[type].print_ip_opts |= EVSEL__PRINT_IP;
571 if (PRINT_FIELD(SYM))
572 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
574 if (PRINT_FIELD(DSO))
575 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
577 if (PRINT_FIELD(SYMOFFSET))
578 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
580 if (PRINT_FIELD(SRCLINE))
581 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
584 static struct evsel *find_first_output_type(struct evlist *evlist,
589 evlist__for_each_entry(evlist, evsel) {
590 if (evsel__is_dummy_event(evsel))
592 if (output_type(evsel->core.attr.type) == (int)type)
599 * verify all user requested events exist and the samples
600 * have the expected data
602 static int perf_session__check_output_opt(struct perf_session *session)
608 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
609 evsel = find_first_output_type(session->evlist, j);
612 * even if fields is set to 0 (ie., show nothing) event must
613 * exist if user explicitly includes it on the command line
615 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
616 j != OUTPUT_TYPE_SYNTH) {
617 pr_err("%s events do not exist. "
618 "Remove corresponding -F option to proceed.\n",
623 if (evsel && output[j].fields &&
624 evsel__check_attr(evsel, session))
630 set_print_ip_opts(&evsel->core.attr);
631 tod |= output[j].fields & PERF_OUTPUT_TOD;
635 bool use_callchain = false;
636 bool not_pipe = false;
638 evlist__for_each_entry(session->evlist, evsel) {
640 if (evsel__has_callchain(evsel)) {
641 use_callchain = true;
645 if (not_pipe && !use_callchain)
646 symbol_conf.use_callchain = false;
650 * set default for tracepoints to print symbols only
651 * if callchains are present
653 if (symbol_conf.use_callchain &&
654 !output[PERF_TYPE_TRACEPOINT].user_set) {
655 j = PERF_TYPE_TRACEPOINT;
657 evlist__for_each_entry(session->evlist, evsel) {
658 if (evsel->core.attr.type != j)
661 if (evsel__has_callchain(evsel)) {
662 output[j].fields |= PERF_OUTPUT_IP;
663 output[j].fields |= PERF_OUTPUT_SYM;
664 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
665 output[j].fields |= PERF_OUTPUT_DSO;
666 set_print_ip_opts(&evsel->core.attr);
672 if (tod && !session->header.env.clock.enabled) {
673 pr_err("Can't provide 'tod' time, missing clock data. "
674 "Please record with -k/--clockid option.\n");
681 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask, const char *arch,
687 if (!regs || !regs->regs)
690 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
692 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
693 u64 val = regs->regs[i++];
694 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r, arch), val);
700 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
703 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
706 u64 tod_ns, clockid_ns;
707 struct perf_env *env;
714 if (buflen < 64 || !script)
717 env = &script->session->header.env;
718 if (!env->clock.enabled) {
719 scnprintf(buf, buflen, "disabled");
723 clockid_ns = env->clock.clockid_ns;
724 tod_ns = env->clock.tod_ns;
726 if (timestamp > clockid_ns)
727 tod_ns += timestamp - clockid_ns;
729 tod_ns -= clockid_ns - timestamp;
731 sec = (time_t) (tod_ns / NSEC_PER_SEC);
732 nsec = tod_ns - sec * NSEC_PER_SEC;
734 if (localtime_r(&sec, <ime) == NULL) {
735 scnprintf(buf, buflen, "failed");
737 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
739 if (symbol_conf.nanosecs) {
740 snprintf(buf, buflen, "%s.%09lu", date, nsec);
742 snprintf(buf, buflen, "%s.%06lu",
743 date, nsec / NSEC_PER_USEC);
750 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
751 struct perf_event_attr *attr, const char *arch, FILE *fp)
753 return perf_sample__fprintf_regs(&sample->intr_regs,
754 attr->sample_regs_intr, arch, fp);
757 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
758 struct perf_event_attr *attr, const char *arch, FILE *fp)
760 return perf_sample__fprintf_regs(&sample->user_regs,
761 attr->sample_regs_user, arch, fp);
764 static int perf_sample__fprintf_start(struct perf_script *script,
765 struct perf_sample *sample,
766 struct thread *thread,
770 struct perf_event_attr *attr = &evsel->core.attr;
772 unsigned long long nsecs;
776 if (PRINT_FIELD(MACHINE_PID) && sample->machine_pid)
777 printed += fprintf(fp, "VM:%5d ", sample->machine_pid);
779 /* Print VCPU only for guest events i.e. with machine_pid */
780 if (PRINT_FIELD(VCPU) && sample->machine_pid)
781 printed += fprintf(fp, "VCPU:%03d ", sample->vcpu);
783 if (PRINT_FIELD(COMM)) {
784 const char *comm = thread ? thread__comm_str(thread) : ":-1";
787 printed += fprintf(fp, "%8.8s ", comm);
788 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
789 printed += fprintf(fp, "%s ", comm);
791 printed += fprintf(fp, "%16s ", comm);
794 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
795 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
796 else if (PRINT_FIELD(PID))
797 printed += fprintf(fp, "%5d ", sample->pid);
798 else if (PRINT_FIELD(TID))
799 printed += fprintf(fp, "%5d ", sample->tid);
801 if (PRINT_FIELD(CPU)) {
803 printed += fprintf(fp, "%3d ", sample->cpu);
805 printed += fprintf(fp, "[%03d] ", sample->cpu);
808 if (PRINT_FIELD(MISC)) {
812 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
815 ret += fprintf(fp, "K");
817 ret += fprintf(fp, "U");
819 ret += fprintf(fp, "H");
820 if (has(GUEST_KERNEL))
821 ret += fprintf(fp, "G");
823 ret += fprintf(fp, "g");
826 case PERF_RECORD_MMAP:
827 case PERF_RECORD_MMAP2:
829 ret += fprintf(fp, "M");
831 case PERF_RECORD_COMM:
833 ret += fprintf(fp, "E");
835 case PERF_RECORD_SWITCH:
836 case PERF_RECORD_SWITCH_CPU_WIDE:
837 if (has(SWITCH_OUT)) {
838 ret += fprintf(fp, "S");
839 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
840 ret += fprintf(fp, "p");
848 ret += fprintf(fp, "%*s", 6 - ret, " ");
852 if (PRINT_FIELD(TOD)) {
853 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
854 printed += fprintf(fp, "%s ", tstr);
857 if (PRINT_FIELD(TIME)) {
858 u64 t = sample->time;
861 initial_time = sample->time;
862 t = sample->time - initial_time;
863 } else if (deltatime) {
865 t = sample->time - previous_time;
869 previous_time = sample->time;
872 secs = nsecs / NSEC_PER_SEC;
873 nsecs -= secs * NSEC_PER_SEC;
875 if (symbol_conf.nanosecs)
876 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
878 char sample_time[32];
879 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
880 printed += fprintf(fp, "%12s: ", sample_time);
888 mispred_str(struct branch_entry *br)
890 if (!(br->flags.mispred || br->flags.predicted))
893 return br->flags.predicted ? 'P' : 'M';
896 static int print_bstack_flags(FILE *fp, struct branch_entry *br)
898 return fprintf(fp, "/%c/%c/%c/%d/%s/%s ",
900 br->flags.in_tx ? 'X' : '-',
901 br->flags.abort ? 'A' : '-',
904 br->flags.spec ? branch_spec_desc(br->flags.spec) : "-");
907 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
908 struct thread *thread,
909 struct perf_event_attr *attr, FILE *fp)
911 struct branch_stack *br = sample->branch_stack;
912 struct branch_entry *entries = perf_sample__branch_entries(sample);
913 struct addr_location alf, alt;
920 for (i = 0; i < br->nr; i++) {
921 from = entries[i].from;
924 if (PRINT_FIELD(DSO)) {
925 memset(&alf, 0, sizeof(alf));
926 memset(&alt, 0, sizeof(alt));
927 thread__find_map_fb(thread, sample->cpumode, from, &alf);
928 thread__find_map_fb(thread, sample->cpumode, to, &alt);
931 printed += fprintf(fp, " 0x%"PRIx64, from);
932 if (PRINT_FIELD(DSO)) {
933 printed += fprintf(fp, "(");
934 printed += map__fprintf_dsoname(alf.map, fp);
935 printed += fprintf(fp, ")");
938 printed += fprintf(fp, "/0x%"PRIx64, to);
939 if (PRINT_FIELD(DSO)) {
940 printed += fprintf(fp, "(");
941 printed += map__fprintf_dsoname(alt.map, fp);
942 printed += fprintf(fp, ")");
945 printed += print_bstack_flags(fp, entries + i);
951 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
952 struct thread *thread,
953 struct perf_event_attr *attr, FILE *fp)
955 struct branch_stack *br = sample->branch_stack;
956 struct branch_entry *entries = perf_sample__branch_entries(sample);
957 struct addr_location alf, alt;
964 for (i = 0; i < br->nr; i++) {
966 memset(&alf, 0, sizeof(alf));
967 memset(&alt, 0, sizeof(alt));
968 from = entries[i].from;
971 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
972 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
974 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
975 if (PRINT_FIELD(DSO)) {
976 printed += fprintf(fp, "(");
977 printed += map__fprintf_dsoname(alf.map, fp);
978 printed += fprintf(fp, ")");
980 printed += fprintf(fp, "%c", '/');
981 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
982 if (PRINT_FIELD(DSO)) {
983 printed += fprintf(fp, "(");
984 printed += map__fprintf_dsoname(alt.map, fp);
985 printed += fprintf(fp, ")");
987 printed += print_bstack_flags(fp, entries + i);
993 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
994 struct thread *thread,
995 struct perf_event_attr *attr, FILE *fp)
997 struct branch_stack *br = sample->branch_stack;
998 struct branch_entry *entries = perf_sample__branch_entries(sample);
999 struct addr_location alf, alt;
1003 if (!(br && br->nr))
1006 for (i = 0; i < br->nr; i++) {
1008 memset(&alf, 0, sizeof(alf));
1009 memset(&alt, 0, sizeof(alt));
1010 from = entries[i].from;
1013 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
1014 !alf.map->dso->adjust_symbols)
1015 from = map__map_ip(alf.map, from);
1017 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
1018 !alt.map->dso->adjust_symbols)
1019 to = map__map_ip(alt.map, to);
1021 printed += fprintf(fp, " 0x%"PRIx64, from);
1022 if (PRINT_FIELD(DSO)) {
1023 printed += fprintf(fp, "(");
1024 printed += map__fprintf_dsoname(alf.map, fp);
1025 printed += fprintf(fp, ")");
1027 printed += fprintf(fp, "/0x%"PRIx64, to);
1028 if (PRINT_FIELD(DSO)) {
1029 printed += fprintf(fp, "(");
1030 printed += map__fprintf_dsoname(alt.map, fp);
1031 printed += fprintf(fp, ")");
1033 printed += print_bstack_flags(fp, entries + i);
1038 #define MAXBB 16384UL
1040 static int grab_bb(u8 *buffer, u64 start, u64 end,
1041 struct machine *machine, struct thread *thread,
1042 bool *is64bit, u8 *cpumode, bool last)
1045 struct addr_location al;
1051 kernel = machine__kernel_ip(machine, start);
1053 *cpumode = PERF_RECORD_MISC_KERNEL;
1055 *cpumode = PERF_RECORD_MISC_USER;
1058 * Block overlaps between kernel and user.
1059 * This can happen due to ring filtering
1060 * On Intel CPUs the entry into the kernel is filtered,
1061 * but the exit is not. Let the caller patch it up.
1063 if (kernel != machine__kernel_ip(machine, end)) {
1064 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1068 memset(&al, 0, sizeof(al));
1069 if (end - start > MAXBB - MAXINSN) {
1071 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1073 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1077 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1078 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1081 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1082 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1086 /* Load maps to ensure dso->is_64_bit has been updated */
1089 offset = al.map->map_ip(al.map, start);
1090 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1091 end - start + MAXINSN);
1093 *is64bit = al.map->dso->is_64_bit;
1095 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1100 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1108 if (!map || !map->dso)
1110 srcfile = get_srcline_split(map->dso,
1111 map__rip_2objdump(map, addr),
1116 /* Avoid redundant printing */
1119 !strcmp(state->srcfile, srcfile) &&
1120 state->line == line) {
1125 srccode = find_sourceline(srcfile, line, &len);
1129 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1132 state->srcfile = srcfile;
1142 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1144 struct addr_location al;
1147 memset(&al, 0, sizeof(al));
1148 thread__find_map(thread, cpumode, addr, &al);
1151 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1152 &thread->srccode_state);
1154 ret += printf("\n");
1158 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1159 struct perf_insn *x, u8 *inbuf, int len,
1160 int insn, FILE *fp, int *total_cycles,
1161 struct perf_event_attr *attr)
1164 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t", ip,
1165 dump_insn(x, ip, inbuf, len, &ilen));
1167 if (PRINT_FIELD(BRSTACKINSNLEN))
1168 printed += fprintf(fp, "ilen: %d\t", ilen);
1170 printed += fprintf(fp, "#%s%s%s%s",
1171 en->flags.predicted ? " PRED" : "",
1172 en->flags.mispred ? " MISPRED" : "",
1173 en->flags.in_tx ? " INTX" : "",
1174 en->flags.abort ? " ABORT" : "");
1175 if (en->flags.cycles) {
1176 *total_cycles += en->flags.cycles;
1177 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1179 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1181 return printed + fprintf(fp, "\n");
1184 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1185 u8 cpumode, int cpu, struct symbol **lastsym,
1186 struct perf_event_attr *attr, FILE *fp)
1188 struct addr_location al;
1189 int off, printed = 0;
1191 memset(&al, 0, sizeof(al));
1193 thread__find_map(thread, cpumode, addr, &al);
1195 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1201 al.sym = map__find_symbol(al.map, al.addr);
1206 if (al.addr < al.sym->end)
1207 off = al.addr - al.sym->start;
1209 off = al.addr - al.map->start - al.sym->start;
1210 printed += fprintf(fp, "\t%s", al.sym->name);
1212 printed += fprintf(fp, "%+d", off);
1213 printed += fprintf(fp, ":");
1214 if (PRINT_FIELD(SRCLINE))
1215 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1216 printed += fprintf(fp, "\n");
1222 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1223 struct thread *thread,
1224 struct perf_event_attr *attr,
1225 struct machine *machine, FILE *fp)
1227 struct branch_stack *br = sample->branch_stack;
1228 struct branch_entry *entries = perf_sample__branch_entries(sample);
1230 int i, insn, len, nr, ilen, printed = 0;
1234 struct symbol *lastsym = NULL;
1235 int total_cycles = 0;
1237 if (!(br && br->nr))
1240 if (max_blocks && nr > max_blocks + 1)
1241 nr = max_blocks + 1;
1244 x.cpu = sample->cpu;
1246 printed += fprintf(fp, "%c", '\n');
1248 /* Handle first from jump, of which we don't know the entry. */
1249 len = grab_bb(buffer, entries[nr-1].from,
1251 machine, thread, &x.is64bit, &x.cpumode, false);
1253 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1254 x.cpumode, x.cpu, &lastsym, attr, fp);
1255 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1256 &x, buffer, len, 0, fp, &total_cycles,
1258 if (PRINT_FIELD(SRCCODE))
1259 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1262 /* Print all blocks */
1263 for (i = nr - 2; i >= 0; i--) {
1264 if (entries[i].from || entries[i].to)
1265 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1268 start = entries[i + 1].to;
1269 end = entries[i].from;
1271 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1272 /* Patch up missing kernel transfers due to ring filters */
1273 if (len == -ENXIO && i > 0) {
1274 end = entries[--i].from;
1275 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1276 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1282 for (off = 0; off < (unsigned)len; off += ilen) {
1283 uint64_t ip = start + off;
1285 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1287 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1288 &total_cycles, attr);
1289 if (PRINT_FIELD(SRCCODE))
1290 printed += print_srccode(thread, x.cpumode, ip);
1294 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", ip,
1295 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1296 if (PRINT_FIELD(BRSTACKINSNLEN))
1297 printed += fprintf(fp, "\tilen: %d", ilen);
1298 printed += fprintf(fp, "\n");
1301 if (PRINT_FIELD(SRCCODE))
1302 print_srccode(thread, x.cpumode, ip);
1306 if (off != end - start)
1307 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1311 * Hit the branch? In this case we are already done, and the target
1312 * has not been executed yet.
1314 if (entries[0].from == sample->ip)
1316 if (entries[0].flags.abort)
1320 * Print final block up to sample
1322 * Due to pipeline delays the LBRs might be missing a branch
1323 * or two, which can result in very large or negative blocks
1324 * between final branch and sample. When this happens just
1325 * continue walking after the last TO until we hit a branch.
1327 start = entries[0].to;
1330 /* Missing jump. Scan 128 bytes for the next branch */
1333 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1334 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1336 /* Print at least last IP if basic block did not work */
1337 len = grab_bb(buffer, sample->ip, sample->ip,
1338 machine, thread, &x.is64bit, &x.cpumode, false);
1342 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", sample->ip,
1343 dump_insn(&x, sample->ip, buffer, len, &ilen));
1344 if (PRINT_FIELD(BRSTACKINSNLEN))
1345 printed += fprintf(fp, "\tilen: %d", ilen);
1346 printed += fprintf(fp, "\n");
1347 if (PRINT_FIELD(SRCCODE))
1348 print_srccode(thread, x.cpumode, sample->ip);
1351 for (off = 0; off <= end - start; off += ilen) {
1353 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", start + off,
1354 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1355 if (PRINT_FIELD(BRSTACKINSNLEN))
1356 printed += fprintf(fp, "\tilen: %d", ilen);
1357 printed += fprintf(fp, "\n");
1360 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1362 * Hit a missing branch. Just stop.
1364 printed += fprintf(fp, "\t... not reaching sample ...\n");
1367 if (PRINT_FIELD(SRCCODE))
1368 print_srccode(thread, x.cpumode, start + off);
1374 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1375 struct thread *thread,
1376 struct perf_event_attr *attr, FILE *fp)
1378 struct addr_location al;
1379 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1381 if (!sample_addr_correlates_sym(attr))
1384 thread__resolve(thread, &al, sample);
1386 if (PRINT_FIELD(SYM)) {
1387 printed += fprintf(fp, " ");
1388 if (PRINT_FIELD(SYMOFFSET))
1389 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1391 printed += symbol__fprintf_symname(al.sym, fp);
1394 if (PRINT_FIELD(DSO)) {
1395 printed += fprintf(fp, " (");
1396 printed += map__fprintf_dsoname(al.map, fp);
1397 printed += fprintf(fp, ")");
1403 static const char *resolve_branch_sym(struct perf_sample *sample,
1404 struct evsel *evsel,
1405 struct thread *thread,
1406 struct addr_location *al,
1407 struct addr_location *addr_al,
1410 struct perf_event_attr *attr = &evsel->core.attr;
1411 const char *name = NULL;
1413 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1414 if (sample_addr_correlates_sym(attr)) {
1415 if (!addr_al->thread)
1416 thread__resolve(thread, addr_al, sample);
1418 name = addr_al->sym->name;
1424 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1426 name = al->sym->name;
1433 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1434 struct evsel *evsel,
1435 struct thread *thread,
1436 struct addr_location *al,
1437 struct addr_location *addr_al,
1440 struct perf_event_attr *attr = &evsel->core.attr;
1441 size_t depth = thread_stack__depth(thread, sample->cpu);
1442 const char *name = NULL;
1449 * The 'return' has already been popped off the stack so the depth has
1450 * to be adjusted to match the 'call'.
1452 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1455 name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1457 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1458 dlen += fprintf(fp, "(");
1459 dlen += map__fprintf_dsoname(al->map, fp);
1460 dlen += fprintf(fp, ")\t");
1464 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1466 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1472 * Try to keep the output length from changing frequently so that the
1473 * output lines up more nicely.
1475 if (len > spacing || (len && len < spacing - 52))
1476 spacing = round_up(len + 4, 32);
1479 len += fprintf(fp, "%*s", spacing - len, "");
1484 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1485 struct thread *thread __maybe_unused,
1486 struct machine *machine __maybe_unused)
1490 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1491 struct machine *machine)
1493 if (sample->insn_len == 0 && native_arch)
1494 arch_fetch_insn(sample, thread, machine);
1497 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1498 struct perf_event_attr *attr,
1499 struct thread *thread,
1500 struct machine *machine, FILE *fp)
1504 script_fetch_insn(sample, thread, machine);
1506 if (PRINT_FIELD(INSNLEN))
1507 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1508 if (PRINT_FIELD(INSN) && sample->insn_len) {
1511 printed += fprintf(fp, " insn:");
1512 for (i = 0; i < sample->insn_len; i++)
1513 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1515 if (PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN))
1516 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1521 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1522 struct perf_event_attr *attr, FILE *fp)
1526 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1529 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1531 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1532 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1535 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1536 struct evsel *evsel,
1537 struct thread *thread,
1538 struct addr_location *al,
1539 struct addr_location *addr_al,
1540 struct machine *machine, FILE *fp)
1542 struct perf_event_attr *attr = &evsel->core.attr;
1543 unsigned int type = output_type(attr->type);
1544 bool print_srcline_last = false;
1547 if (PRINT_FIELD(CALLINDENT))
1548 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1550 /* print branch_from information */
1551 if (PRINT_FIELD(IP)) {
1552 unsigned int print_opts = output[type].print_ip_opts;
1553 struct callchain_cursor *cursor = NULL;
1555 if (symbol_conf.use_callchain && sample->callchain &&
1556 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1557 sample, NULL, NULL, scripting_max_stack) == 0)
1558 cursor = &callchain_cursor;
1560 if (cursor == NULL) {
1561 printed += fprintf(fp, " ");
1562 if (print_opts & EVSEL__PRINT_SRCLINE) {
1563 print_srcline_last = true;
1564 print_opts &= ~EVSEL__PRINT_SRCLINE;
1567 printed += fprintf(fp, "\n");
1569 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1570 symbol_conf.bt_stop_list, fp);
1573 /* print branch_to information */
1574 if (PRINT_FIELD(ADDR) ||
1575 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1576 !output[type].user_set)) {
1577 printed += fprintf(fp, " => ");
1578 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1581 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1583 if (print_srcline_last)
1584 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1586 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1587 printed += fprintf(fp, "\n");
1588 if (PRINT_FIELD(SRCCODE)) {
1589 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1590 &thread->srccode_state);
1593 printed += printf("\n");
1602 } sample_flags[] = {
1603 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1604 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1605 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1606 {PERF_IP_FLAG_BRANCH, "jmp"},
1607 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1608 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1609 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1610 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1611 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1612 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1613 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1614 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1615 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1616 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1617 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1621 static const char *sample_flags_to_name(u32 flags)
1625 for (i = 0; sample_flags[i].name ; i++) {
1626 if (sample_flags[i].flags == flags)
1627 return sample_flags[i].name;
1633 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1635 u32 xf = PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_INTR_DISABLE |
1636 PERF_IP_FLAG_INTR_TOGGLE;
1637 const char *chars = PERF_IP_FLAG_CHARS;
1638 const size_t n = strlen(PERF_IP_FLAG_CHARS);
1639 const char *name = NULL;
1644 snprintf(xs, sizeof(xs), "(%s%s%s)",
1645 flags & PERF_IP_FLAG_IN_TX ? "x" : "",
1646 flags & PERF_IP_FLAG_INTR_DISABLE ? "D" : "",
1647 flags & PERF_IP_FLAG_INTR_TOGGLE ? "t" : "");
1649 name = sample_flags_to_name(flags & ~xf);
1651 return snprintf(str, sz, "%-15s%6s", name, xs);
1653 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1654 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_BEGIN));
1656 return snprintf(str, sz, "tr strt %-7s%6s", name, xs);
1659 if (flags & PERF_IP_FLAG_TRACE_END) {
1660 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_END));
1662 return snprintf(str, sz, "tr end %-7s%6s", name, xs);
1665 for (i = 0; i < n; i++, flags >>= 1) {
1666 if ((flags & 1) && pos < sz)
1667 str[pos++] = chars[i];
1669 for (; i < 32; i++, flags >>= 1) {
1670 if ((flags & 1) && pos < sz)
1679 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1681 char str[SAMPLE_FLAGS_BUF_SIZE];
1683 perf_sample__sprintf_flags(flags, str, sizeof(str));
1684 return fprintf(fp, " %-21s ", str);
1687 struct printer_data {
1693 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1695 void *extra, FILE *fp)
1697 unsigned char ch = (unsigned char)val;
1698 struct printer_data *printer_data = extra;
1702 case BINARY_PRINT_DATA_BEGIN:
1703 printed += fprintf(fp, "\n");
1705 case BINARY_PRINT_LINE_BEGIN:
1706 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1709 case BINARY_PRINT_ADDR:
1710 printed += fprintf(fp, " %04x:", val);
1712 case BINARY_PRINT_NUM_DATA:
1713 printed += fprintf(fp, " %02x", val);
1715 case BINARY_PRINT_NUM_PAD:
1716 printed += fprintf(fp, " ");
1718 case BINARY_PRINT_SEP:
1719 printed += fprintf(fp, " ");
1721 case BINARY_PRINT_CHAR_DATA:
1722 if (printer_data->hit_nul && ch)
1723 printer_data->is_printable = false;
1726 printed += fprintf(fp, "%c", '.');
1728 if (!printer_data->is_printable)
1732 printer_data->hit_nul = true;
1734 printer_data->is_printable = false;
1736 printed += fprintf(fp, "%c", ch);
1739 case BINARY_PRINT_CHAR_PAD:
1740 printed += fprintf(fp, " ");
1742 case BINARY_PRINT_LINE_END:
1743 printed += fprintf(fp, "\n");
1744 printer_data->line_no++;
1746 case BINARY_PRINT_DATA_END:
1754 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1756 unsigned int nr_bytes = sample->raw_size;
1757 struct printer_data printer_data = {0, false, true};
1758 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1759 sample__fprintf_bpf_output, &printer_data, fp);
1761 if (printer_data.is_printable && printer_data.hit_nul)
1762 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1767 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1769 if (len > 0 && len < spacing)
1770 return fprintf(fp, "%*s", spacing - len, "");
1775 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1777 return perf_sample__fprintf_spacing(len, 34, fp);
1780 /* If a value contains only printable ASCII characters padded with NULLs */
1781 static bool ptw_is_prt(u64 val)
1786 for (i = 0; i < sizeof(val); i++) {
1787 c = ((char *)&val)[i];
1790 if (!isprint(c) || !isascii(c))
1793 for (; i < sizeof(val); i++) {
1794 c = ((char *)&val)[i];
1801 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1803 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1804 char str[sizeof(u64) + 1] = "";
1808 if (perf_sample__bad_synth_size(sample, *data))
1811 val = le64_to_cpu(data->payload);
1812 if (ptw_is_prt(val)) {
1813 memcpy(str, &val, sizeof(val));
1814 str[sizeof(val)] = 0;
1816 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " %s ",
1817 data->ip, val, str);
1818 return len + perf_sample__fprintf_pt_spacing(len, fp);
1821 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1823 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1826 if (perf_sample__bad_synth_size(sample, *data))
1829 len = fprintf(fp, " hints: %#x extensions: %#x ",
1830 data->hints, data->extensions);
1831 return len + perf_sample__fprintf_pt_spacing(len, fp);
1834 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1836 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1839 if (perf_sample__bad_synth_size(sample, *data))
1842 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1843 data->hw, data->cstate, data->subcstate);
1844 return len + perf_sample__fprintf_pt_spacing(len, fp);
1847 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1849 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1852 if (perf_sample__bad_synth_size(sample, *data))
1855 len = fprintf(fp, " IP: %u ", data->ip);
1856 return len + perf_sample__fprintf_pt_spacing(len, fp);
1859 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1861 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1864 if (perf_sample__bad_synth_size(sample, *data))
1867 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1868 data->deepest_cstate, data->last_cstate,
1870 return len + perf_sample__fprintf_pt_spacing(len, fp);
1873 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1875 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1876 unsigned int percent, freq;
1879 if (perf_sample__bad_synth_size(sample, *data))
1882 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1883 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1884 if (data->max_nonturbo) {
1885 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1886 len += fprintf(fp, "(%3u%%) ", percent);
1888 return len + perf_sample__fprintf_pt_spacing(len, fp);
1891 static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1893 struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1896 if (perf_sample__bad_synth_size(sample, *data))
1899 len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1900 return len + perf_sample__fprintf_pt_spacing(len, fp);
1903 /* Intel PT Event Trace */
1904 static int perf_sample__fprintf_synth_evt(struct perf_sample *sample, FILE *fp)
1906 struct perf_synth_intel_evt *data = perf_sample__synth_ptr(sample);
1907 const char *cfe[32] = {NULL, "INTR", "IRET", "SMI", "RSM", "SIPI",
1908 "INIT", "VMENTRY", "VMEXIT", "VMEXIT_INTR",
1910 const char *evd[64] = {"PFA", "VMXQ", "VMXR"};
1914 if (perf_sample__bad_synth_size(sample, *data))
1917 s = cfe[data->type];
1919 len = fprintf(fp, " cfe: %s IP: %d vector: %u",
1920 s, data->ip, data->vector);
1922 len = fprintf(fp, " cfe: %u IP: %d vector: %u",
1923 data->type, data->ip, data->vector);
1925 for (i = 0; i < data->evd_cnt; i++) {
1926 unsigned int et = data->evd[i].evd_type & 0x3f;
1930 len += fprintf(fp, " %s: %#" PRIx64,
1931 s, data->evd[i].payload);
1933 len += fprintf(fp, " EVD_%u: %#" PRIx64,
1934 et, data->evd[i].payload);
1937 return len + perf_sample__fprintf_pt_spacing(len, fp);
1940 static int perf_sample__fprintf_synth_iflag_chg(struct perf_sample *sample, FILE *fp)
1942 struct perf_synth_intel_iflag_chg *data = perf_sample__synth_ptr(sample);
1945 if (perf_sample__bad_synth_size(sample, *data))
1948 len = fprintf(fp, " IFLAG: %d->%d %s branch", !data->iflag, data->iflag,
1949 data->via_branch ? "via" : "non");
1950 return len + perf_sample__fprintf_pt_spacing(len, fp);
1953 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1954 struct evsel *evsel, FILE *fp)
1956 switch (evsel->core.attr.config) {
1957 case PERF_SYNTH_INTEL_PTWRITE:
1958 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1959 case PERF_SYNTH_INTEL_MWAIT:
1960 return perf_sample__fprintf_synth_mwait(sample, fp);
1961 case PERF_SYNTH_INTEL_PWRE:
1962 return perf_sample__fprintf_synth_pwre(sample, fp);
1963 case PERF_SYNTH_INTEL_EXSTOP:
1964 return perf_sample__fprintf_synth_exstop(sample, fp);
1965 case PERF_SYNTH_INTEL_PWRX:
1966 return perf_sample__fprintf_synth_pwrx(sample, fp);
1967 case PERF_SYNTH_INTEL_CBR:
1968 return perf_sample__fprintf_synth_cbr(sample, fp);
1969 case PERF_SYNTH_INTEL_PSB:
1970 return perf_sample__fprintf_synth_psb(sample, fp);
1971 case PERF_SYNTH_INTEL_EVT:
1972 return perf_sample__fprintf_synth_evt(sample, fp);
1973 case PERF_SYNTH_INTEL_IFLAG_CHG:
1974 return perf_sample__fprintf_synth_iflag_chg(sample, fp);
1982 static int evlist__max_name_len(struct evlist *evlist)
1984 struct evsel *evsel;
1987 evlist__for_each_entry(evlist, evsel) {
1988 int len = strlen(evsel__name(evsel));
1990 max = MAX(len, max);
1996 static int data_src__fprintf(u64 data_src, FILE *fp)
1998 struct mem_info mi = { .data_src.val = data_src };
2004 perf_script__meminfo_scnprintf(decode, 100, &mi);
2006 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
2010 return fprintf(fp, "%-*s", maxlen, out);
2014 struct perf_sample *sample;
2015 struct thread *thread;
2016 struct evsel *evsel;
2020 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
2021 void *ctx, const char *color,
2023 const char *unit, double val)
2025 struct metric_ctx *mctx = ctx;
2029 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2030 PERF_RECORD_SAMPLE, mctx->fp);
2031 fputs("\tmetric: ", mctx->fp);
2033 color_fprintf(mctx->fp, color, fmt, val);
2036 fprintf(mctx->fp, " %s\n", unit);
2039 static void script_new_line(struct perf_stat_config *config __maybe_unused,
2042 struct metric_ctx *mctx = ctx;
2044 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2045 PERF_RECORD_SAMPLE, mctx->fp);
2046 fputs("\tmetric: ", mctx->fp);
2049 static void perf_sample__fprint_metric(struct perf_script *script,
2050 struct thread *thread,
2051 struct evsel *evsel,
2052 struct perf_sample *sample,
2055 struct evsel *leader = evsel__leader(evsel);
2056 struct perf_stat_output_ctx ctx = {
2057 .print_metric = script_print_metric,
2058 .new_line = script_new_line,
2059 .ctx = &(struct metric_ctx) {
2065 .force_header = false,
2071 evlist__alloc_stats(&stat_config, script->session->evlist, /*alloc_raw=*/false);
2072 if (evsel_script(leader)->gnum++ == 0)
2073 perf_stat__reset_shadow_stats();
2074 val = sample->period * evsel->scale;
2075 perf_stat__update_shadow_stats(evsel,
2079 evsel_script(evsel)->val = val;
2080 if (evsel_script(leader)->gnum == leader->core.nr_members) {
2081 for_each_group_member (ev2, leader) {
2082 perf_stat__print_shadow_stats(&stat_config, ev2,
2083 evsel_script(ev2)->val,
2089 evsel_script(leader)->gnum = 0;
2093 static bool show_event(struct perf_sample *sample,
2094 struct evsel *evsel,
2095 struct thread *thread,
2096 struct addr_location *al,
2097 struct addr_location *addr_al)
2099 int depth = thread_stack__depth(thread, sample->cpu);
2101 if (!symbol_conf.graph_function)
2104 if (thread->filter) {
2105 if (depth <= thread->filter_entry_depth) {
2106 thread->filter = false;
2111 const char *s = symbol_conf.graph_function;
2113 const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
2119 nlen = strlen(name);
2121 unsigned len = strcspn(s, ",");
2122 if (nlen == len && !strncmp(name, s, len)) {
2123 thread->filter = true;
2124 thread->filter_entry_depth = depth;
2135 static void process_event(struct perf_script *script,
2136 struct perf_sample *sample, struct evsel *evsel,
2137 struct addr_location *al,
2138 struct addr_location *addr_al,
2139 struct machine *machine)
2141 struct thread *thread = al->thread;
2142 struct perf_event_attr *attr = &evsel->core.attr;
2143 unsigned int type = output_type(attr->type);
2144 struct evsel_script *es = evsel->priv;
2146 char str[PAGE_SIZE_NAME_LEN];
2147 const char *arch = perf_env__arch(machine->env);
2149 if (output[type].fields == 0)
2154 perf_sample__fprintf_start(script, sample, thread, evsel,
2155 PERF_RECORD_SAMPLE, fp);
2157 if (PRINT_FIELD(PERIOD))
2158 fprintf(fp, "%10" PRIu64 " ", sample->period);
2160 if (PRINT_FIELD(EVNAME)) {
2161 const char *evname = evsel__name(evsel);
2163 if (!script->name_width)
2164 script->name_width = evlist__max_name_len(script->session->evlist);
2166 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2170 perf_sample__fprintf_flags(sample->flags, fp);
2172 if (is_bts_event(attr)) {
2173 perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2176 #ifdef HAVE_LIBTRACEEVENT
2177 if (PRINT_FIELD(TRACE) && sample->raw_data) {
2178 event_format__fprintf(evsel->tp_format, sample->cpu,
2179 sample->raw_data, sample->raw_size, fp);
2182 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2183 perf_sample__fprintf_synth(sample, evsel, fp);
2185 if (PRINT_FIELD(ADDR))
2186 perf_sample__fprintf_addr(sample, thread, attr, fp);
2188 if (PRINT_FIELD(DATA_SRC))
2189 data_src__fprintf(sample->data_src, fp);
2191 if (PRINT_FIELD(WEIGHT))
2192 fprintf(fp, "%16" PRIu64, sample->weight);
2194 if (PRINT_FIELD(INS_LAT))
2195 fprintf(fp, "%16" PRIu16, sample->ins_lat);
2197 if (PRINT_FIELD(RETIRE_LAT))
2198 fprintf(fp, "%16" PRIu16, sample->retire_lat);
2200 if (PRINT_FIELD(IP)) {
2201 struct callchain_cursor *cursor = NULL;
2203 if (script->stitch_lbr)
2204 al->thread->lbr_stitch_enable = true;
2206 if (symbol_conf.use_callchain && sample->callchain &&
2207 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2208 sample, NULL, NULL, scripting_max_stack) == 0)
2209 cursor = &callchain_cursor;
2211 fputc(cursor ? '\n' : ' ', fp);
2212 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2213 symbol_conf.bt_stop_list, fp);
2216 if (PRINT_FIELD(IREGS))
2217 perf_sample__fprintf_iregs(sample, attr, arch, fp);
2219 if (PRINT_FIELD(UREGS))
2220 perf_sample__fprintf_uregs(sample, attr, arch, fp);
2222 if (PRINT_FIELD(BRSTACK))
2223 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2224 else if (PRINT_FIELD(BRSTACKSYM))
2225 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2226 else if (PRINT_FIELD(BRSTACKOFF))
2227 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2229 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2230 perf_sample__fprintf_bpf_output(sample, fp);
2231 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2233 if (PRINT_FIELD(PHYS_ADDR))
2234 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2236 if (PRINT_FIELD(DATA_PAGE_SIZE))
2237 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2239 if (PRINT_FIELD(CODE_PAGE_SIZE))
2240 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2242 if (PRINT_FIELD(CGROUP)) {
2243 const char *cgrp_name;
2244 struct cgroup *cgrp = cgroup__find(machine->env,
2247 cgrp_name = cgrp->name;
2249 cgrp_name = "unknown";
2250 fprintf(fp, " %s", cgrp_name);
2253 perf_sample__fprintf_ipc(sample, attr, fp);
2257 if (PRINT_FIELD(SRCCODE)) {
2258 if (map__fprintf_srccode(al->map, al->addr, stdout,
2259 &thread->srccode_state))
2263 if (PRINT_FIELD(METRIC))
2264 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2270 static struct scripting_ops *scripting_ops;
2272 static void __process_stat(struct evsel *counter, u64 tstamp)
2274 int nthreads = perf_thread_map__nr(counter->core.threads);
2276 struct perf_cpu cpu;
2277 static int header_printed;
2279 if (!header_printed) {
2280 printf("%3s %8s %15s %15s %15s %15s %s\n",
2281 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2285 for (thread = 0; thread < nthreads; thread++) {
2286 perf_cpu_map__for_each_cpu(cpu, idx, evsel__cpus(counter)) {
2287 struct perf_counts_values *counts;
2289 counts = perf_counts(counter->counts, idx, thread);
2291 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2293 perf_thread_map__pid(counter->core.threads, thread),
2298 evsel__name(counter));
2303 static void process_stat(struct evsel *counter, u64 tstamp)
2305 if (scripting_ops && scripting_ops->process_stat)
2306 scripting_ops->process_stat(&stat_config, counter, tstamp);
2308 __process_stat(counter, tstamp);
2311 static void process_stat_interval(u64 tstamp)
2313 if (scripting_ops && scripting_ops->process_stat_interval)
2314 scripting_ops->process_stat_interval(tstamp);
2317 static void setup_scripting(void)
2319 #ifdef HAVE_LIBTRACEEVENT
2320 setup_perl_scripting();
2321 setup_python_scripting();
2325 static int flush_scripting(void)
2327 return scripting_ops ? scripting_ops->flush_script() : 0;
2330 static int cleanup_scripting(void)
2332 pr_debug("\nperf script stopped\n");
2334 return scripting_ops ? scripting_ops->stop_script() : 0;
2337 static bool filter_cpu(struct perf_sample *sample)
2339 if (cpu_list && sample->cpu != (u32)-1)
2340 return !test_bit(sample->cpu, cpu_bitmap);
2344 static int process_sample_event(struct perf_tool *tool,
2345 union perf_event *event,
2346 struct perf_sample *sample,
2347 struct evsel *evsel,
2348 struct machine *machine)
2350 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2351 struct addr_location al;
2352 struct addr_location addr_al;
2355 /* Set thread to NULL to indicate addr_al and al are not initialized */
2356 addr_al.thread = NULL;
2359 ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2366 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2372 if (sample->time < last_timestamp) {
2373 pr_err("Samples misordered, previous: %" PRIu64
2374 " this: %" PRIu64 "\n", last_timestamp,
2378 last_timestamp = sample->time;
2382 if (filter_cpu(sample))
2385 if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2386 pr_err("problem processing %d event, skipping it.\n",
2387 event->header.type);
2395 if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2398 if (evswitch__discard(&scr->evswitch, evsel))
2401 ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2408 if (scripting_ops) {
2409 struct addr_location *addr_al_ptr = NULL;
2411 if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2412 sample_addr_correlates_sym(&evsel->core.attr)) {
2413 if (!addr_al.thread)
2414 thread__resolve(al.thread, &addr_al, sample);
2415 addr_al_ptr = &addr_al;
2417 scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2419 process_event(scr, sample, evsel, &al, &addr_al, machine);
2424 addr_location__put(&al);
2428 static int process_attr(struct perf_tool *tool, union perf_event *event,
2429 struct evlist **pevlist)
2431 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2432 struct evlist *evlist;
2433 struct evsel *evsel, *pos;
2436 static struct evsel_script *es;
2438 err = perf_event__process_attr(tool, event, pevlist);
2443 evsel = evlist__last(*pevlist);
2446 if (scr->per_event_dump) {
2447 evsel->priv = evsel_script__new(evsel, scr->session->data);
2449 es = zalloc(sizeof(*es));
2457 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2458 evsel->core.attr.type != PERF_TYPE_SYNTH)
2461 evlist__for_each_entry(evlist, pos) {
2462 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2466 if (evsel->core.attr.sample_type) {
2467 err = evsel__check_attr(evsel, scr->session);
2473 * Check if we need to enable callchains based
2474 * on events sample_type.
2476 sample_type = evlist__combined_sample_type(evlist);
2477 callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
2479 /* Enable fields for callchain entries */
2480 if (symbol_conf.use_callchain &&
2481 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2482 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2483 (sample_type & PERF_SAMPLE_REGS_USER &&
2484 sample_type & PERF_SAMPLE_STACK_USER))) {
2485 int type = output_type(evsel->core.attr.type);
2487 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2488 output[type].fields |= PERF_OUTPUT_IP;
2489 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2490 output[type].fields |= PERF_OUTPUT_SYM;
2492 set_print_ip_opts(&evsel->core.attr);
2496 static int print_event_with_time(struct perf_tool *tool,
2497 union perf_event *event,
2498 struct perf_sample *sample,
2499 struct machine *machine,
2500 pid_t pid, pid_t tid, u64 timestamp)
2502 struct perf_script *script = container_of(tool, struct perf_script, tool);
2503 struct perf_session *session = script->session;
2504 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2505 struct thread *thread = NULL;
2507 if (evsel && !evsel->core.attr.sample_id_all) {
2509 sample->time = timestamp;
2514 if (filter_cpu(sample))
2518 thread = machine__findnew_thread(machine, pid, tid);
2521 perf_sample__fprintf_start(script, sample, thread, evsel,
2522 event->header.type, stdout);
2525 perf_event__fprintf(event, machine, stdout);
2527 thread__put(thread);
2532 static int print_event(struct perf_tool *tool, union perf_event *event,
2533 struct perf_sample *sample, struct machine *machine,
2534 pid_t pid, pid_t tid)
2536 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2539 static int process_comm_event(struct perf_tool *tool,
2540 union perf_event *event,
2541 struct perf_sample *sample,
2542 struct machine *machine)
2544 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2547 return print_event(tool, event, sample, machine, event->comm.pid,
2551 static int process_namespaces_event(struct perf_tool *tool,
2552 union perf_event *event,
2553 struct perf_sample *sample,
2554 struct machine *machine)
2556 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2559 return print_event(tool, event, sample, machine, event->namespaces.pid,
2560 event->namespaces.tid);
2563 static int process_cgroup_event(struct perf_tool *tool,
2564 union perf_event *event,
2565 struct perf_sample *sample,
2566 struct machine *machine)
2568 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2571 return print_event(tool, event, sample, machine, sample->pid,
2575 static int process_fork_event(struct perf_tool *tool,
2576 union perf_event *event,
2577 struct perf_sample *sample,
2578 struct machine *machine)
2580 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2583 return print_event_with_time(tool, event, sample, machine,
2584 event->fork.pid, event->fork.tid,
2587 static int process_exit_event(struct perf_tool *tool,
2588 union perf_event *event,
2589 struct perf_sample *sample,
2590 struct machine *machine)
2592 /* Print before 'exit' deletes anything */
2593 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2594 event->fork.tid, event->fork.time))
2597 return perf_event__process_exit(tool, event, sample, machine);
2600 static int process_mmap_event(struct perf_tool *tool,
2601 union perf_event *event,
2602 struct perf_sample *sample,
2603 struct machine *machine)
2605 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2608 return print_event(tool, event, sample, machine, event->mmap.pid,
2612 static int process_mmap2_event(struct perf_tool *tool,
2613 union perf_event *event,
2614 struct perf_sample *sample,
2615 struct machine *machine)
2617 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2620 return print_event(tool, event, sample, machine, event->mmap2.pid,
2624 static int process_switch_event(struct perf_tool *tool,
2625 union perf_event *event,
2626 struct perf_sample *sample,
2627 struct machine *machine)
2629 struct perf_script *script = container_of(tool, struct perf_script, tool);
2631 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2634 if (scripting_ops && scripting_ops->process_switch && !filter_cpu(sample))
2635 scripting_ops->process_switch(event, sample, machine);
2637 if (!script->show_switch_events)
2640 return print_event(tool, event, sample, machine, sample->pid,
2644 static int process_auxtrace_error(struct perf_session *session,
2645 union perf_event *event)
2647 if (scripting_ops && scripting_ops->process_auxtrace_error) {
2648 scripting_ops->process_auxtrace_error(session, event);
2652 return perf_event__process_auxtrace_error(session, event);
2656 process_lost_event(struct perf_tool *tool,
2657 union perf_event *event,
2658 struct perf_sample *sample,
2659 struct machine *machine)
2661 return print_event(tool, event, sample, machine, sample->pid,
2666 process_throttle_event(struct perf_tool *tool __maybe_unused,
2667 union perf_event *event,
2668 struct perf_sample *sample,
2669 struct machine *machine)
2671 if (scripting_ops && scripting_ops->process_throttle)
2672 scripting_ops->process_throttle(event, sample, machine);
2677 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2678 union perf_event *event,
2679 struct ordered_events *oe __maybe_unused)
2682 perf_event__fprintf(event, NULL, stdout);
2687 process_bpf_events(struct perf_tool *tool __maybe_unused,
2688 union perf_event *event,
2689 struct perf_sample *sample,
2690 struct machine *machine)
2692 if (machine__process_ksymbol(machine, event, sample) < 0)
2695 return print_event(tool, event, sample, machine, sample->pid,
2699 static int process_text_poke_events(struct perf_tool *tool,
2700 union perf_event *event,
2701 struct perf_sample *sample,
2702 struct machine *machine)
2704 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2707 return print_event(tool, event, sample, machine, sample->pid,
2711 static void sig_handler(int sig __maybe_unused)
2716 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2718 struct evlist *evlist = script->session->evlist;
2719 struct evsel *evsel;
2721 evlist__for_each_entry(evlist, evsel) {
2724 evsel_script__delete(evsel->priv);
2729 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2731 struct evsel *evsel;
2733 evlist__for_each_entry(script->session->evlist, evsel) {
2735 * Already setup? I.e. we may be called twice in cases like
2736 * Intel PT, one for the intel_pt// and dummy events, then
2737 * for the evsels synthesized from the auxtrace info.
2739 * Ses perf_script__process_auxtrace_info.
2741 if (evsel->priv != NULL)
2744 evsel->priv = evsel_script__new(evsel, script->session->data);
2745 if (evsel->priv == NULL)
2746 goto out_err_fclose;
2752 perf_script__fclose_per_event_dump(script);
2756 static int perf_script__setup_per_event_dump(struct perf_script *script)
2758 struct evsel *evsel;
2759 static struct evsel_script es_stdout;
2761 if (script->per_event_dump)
2762 return perf_script__fopen_per_event_dump(script);
2764 es_stdout.fp = stdout;
2766 evlist__for_each_entry(script->session->evlist, evsel)
2767 evsel->priv = &es_stdout;
2772 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2774 struct evsel *evsel;
2776 evlist__for_each_entry(script->session->evlist, evsel) {
2777 struct evsel_script *es = evsel->priv;
2779 evsel_script__fprintf(es, stdout);
2780 evsel_script__delete(es);
2785 static void perf_script__exit(struct perf_script *script)
2787 perf_thread_map__put(script->threads);
2788 perf_cpu_map__put(script->cpus);
2791 static int __cmd_script(struct perf_script *script)
2795 signal(SIGINT, sig_handler);
2797 perf_stat__init_shadow_stats();
2799 /* override event processing functions */
2800 if (script->show_task_events) {
2801 script->tool.comm = process_comm_event;
2802 script->tool.fork = process_fork_event;
2803 script->tool.exit = process_exit_event;
2805 if (script->show_mmap_events) {
2806 script->tool.mmap = process_mmap_event;
2807 script->tool.mmap2 = process_mmap2_event;
2809 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2810 script->tool.context_switch = process_switch_event;
2811 if (scripting_ops && scripting_ops->process_auxtrace_error)
2812 script->tool.auxtrace_error = process_auxtrace_error;
2813 if (script->show_namespace_events)
2814 script->tool.namespaces = process_namespaces_event;
2815 if (script->show_cgroup_events)
2816 script->tool.cgroup = process_cgroup_event;
2817 if (script->show_lost_events)
2818 script->tool.lost = process_lost_event;
2819 if (script->show_round_events) {
2820 script->tool.ordered_events = false;
2821 script->tool.finished_round = process_finished_round_event;
2823 if (script->show_bpf_events) {
2824 script->tool.ksymbol = process_bpf_events;
2825 script->tool.bpf = process_bpf_events;
2827 if (script->show_text_poke_events) {
2828 script->tool.ksymbol = process_bpf_events;
2829 script->tool.text_poke = process_text_poke_events;
2832 if (perf_script__setup_per_event_dump(script)) {
2833 pr_err("Couldn't create the per event dump files\n");
2837 ret = perf_session__process_events(script->session);
2839 if (script->per_event_dump)
2840 perf_script__exit_per_event_dump_stats(script);
2843 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2848 struct script_spec {
2849 struct list_head node;
2850 struct scripting_ops *ops;
2854 static LIST_HEAD(script_specs);
2856 static struct script_spec *script_spec__new(const char *spec,
2857 struct scripting_ops *ops)
2859 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2862 strcpy(s->spec, spec);
2869 static void script_spec__add(struct script_spec *s)
2871 list_add_tail(&s->node, &script_specs);
2874 static struct script_spec *script_spec__find(const char *spec)
2876 struct script_spec *s;
2878 list_for_each_entry(s, &script_specs, node)
2879 if (strcasecmp(s->spec, spec) == 0)
2884 int script_spec_register(const char *spec, struct scripting_ops *ops)
2886 struct script_spec *s;
2888 s = script_spec__find(spec);
2892 s = script_spec__new(spec, ops);
2896 script_spec__add(s);
2901 static struct scripting_ops *script_spec__lookup(const char *spec)
2903 struct script_spec *s = script_spec__find(spec);
2910 static void list_available_languages(void)
2912 struct script_spec *s;
2914 fprintf(stderr, "\n");
2915 fprintf(stderr, "Scripting language extensions (used in "
2916 "perf script -s [spec:]script.[spec]):\n\n");
2918 list_for_each_entry(s, &script_specs, node)
2919 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2921 fprintf(stderr, "\n");
2924 /* Find script file relative to current directory or exec path */
2925 static char *find_script(const char *script)
2927 char path[PATH_MAX];
2929 if (!scripting_ops) {
2930 const char *ext = strrchr(script, '.');
2935 scripting_ops = script_spec__lookup(++ext);
2940 if (access(script, R_OK)) {
2941 char *exec_path = get_argv_exec_path();
2945 snprintf(path, sizeof(path), "%s/scripts/%s/%s",
2946 exec_path, scripting_ops->dirname, script);
2949 if (access(script, R_OK))
2952 return strdup(script);
2955 static int parse_scriptname(const struct option *opt __maybe_unused,
2956 const char *str, int unset __maybe_unused)
2958 char spec[PATH_MAX];
2959 const char *script, *ext;
2962 if (strcmp(str, "lang") == 0) {
2963 list_available_languages();
2967 script = strchr(str, ':');
2970 if (len >= PATH_MAX) {
2971 fprintf(stderr, "invalid language specifier");
2974 strncpy(spec, str, len);
2976 scripting_ops = script_spec__lookup(spec);
2977 if (!scripting_ops) {
2978 fprintf(stderr, "invalid language specifier");
2984 ext = strrchr(script, '.');
2986 fprintf(stderr, "invalid script extension");
2989 scripting_ops = script_spec__lookup(++ext);
2990 if (!scripting_ops) {
2991 fprintf(stderr, "invalid script extension");
2996 script_name = find_script(script);
2998 script_name = strdup(script);
3003 static int parse_output_fields(const struct option *opt __maybe_unused,
3004 const char *arg, int unset __maybe_unused)
3006 char *tok, *strtok_saveptr = NULL;
3007 int i, imax = ARRAY_SIZE(all_output_options);
3010 char *str = strdup(arg);
3012 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
3017 /* first word can state for which event type the user is specifying
3018 * the fields. If no type exists, the specified fields apply to all
3019 * event types found in the file minus the invalid fields for a type.
3021 tok = strchr(str, ':');
3025 if (!strcmp(str, "hw"))
3026 type = PERF_TYPE_HARDWARE;
3027 else if (!strcmp(str, "sw"))
3028 type = PERF_TYPE_SOFTWARE;
3029 else if (!strcmp(str, "trace"))
3030 type = PERF_TYPE_TRACEPOINT;
3031 else if (!strcmp(str, "raw"))
3032 type = PERF_TYPE_RAW;
3033 else if (!strcmp(str, "break"))
3034 type = PERF_TYPE_BREAKPOINT;
3035 else if (!strcmp(str, "synth"))
3036 type = OUTPUT_TYPE_SYNTH;
3038 fprintf(stderr, "Invalid event type in field string.\n");
3043 if (output[type].user_set)
3044 pr_warning("Overriding previous field request for %s events.\n",
3047 /* Don't override defaults for +- */
3048 if (strchr(tok, '+') || strchr(tok, '-'))
3051 output[type].fields = 0;
3052 output[type].user_set = true;
3053 output[type].wildcard_set = false;
3057 if (strlen(str) == 0) {
3059 "Cannot set fields to 'none' for all event types.\n");
3064 /* Don't override defaults for +- */
3065 if (strchr(str, '+') || strchr(str, '-'))
3068 if (output_set_by_user())
3069 pr_warning("Overriding previous field request for all events.\n");
3071 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3072 output[j].fields = 0;
3073 output[j].user_set = true;
3074 output[j].wildcard_set = true;
3079 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
3085 } else if (*tok == '-') {
3091 if (change != SET && change != DEFAULT)
3096 for (i = 0; i < imax; ++i) {
3097 if (strcmp(tok, all_output_options[i].str) == 0)
3100 if (i == imax && strcmp(tok, "flags") == 0) {
3101 print_flags = change != REMOVE;
3105 fprintf(stderr, "Invalid field requested.\n");
3111 /* add user option to all events types for
3114 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3115 if (output[j].invalid_fields & all_output_options[i].field) {
3116 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
3117 all_output_options[i].str, event_type(j));
3119 if (change == REMOVE) {
3120 output[j].fields &= ~all_output_options[i].field;
3121 output[j].user_set_fields &= ~all_output_options[i].field;
3122 output[j].user_unset_fields |= all_output_options[i].field;
3124 output[j].fields |= all_output_options[i].field;
3125 output[j].user_set_fields |= all_output_options[i].field;
3126 output[j].user_unset_fields &= ~all_output_options[i].field;
3128 output[j].user_set = true;
3129 output[j].wildcard_set = true;
3133 if (output[type].invalid_fields & all_output_options[i].field) {
3134 fprintf(stderr, "\'%s\' not valid for %s events.\n",
3135 all_output_options[i].str, event_type(type));
3140 if (change == REMOVE)
3141 output[type].fields &= ~all_output_options[i].field;
3143 output[type].fields |= all_output_options[i].field;
3144 output[type].user_set = true;
3145 output[type].wildcard_set = true;
3150 if (output[type].fields == 0) {
3151 pr_debug("No fields requested for %s type. "
3152 "Events will not be displayed.\n", event_type(type));
3158 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
3165 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
3166 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
3167 if ((lang_dirent->d_type == DT_DIR || \
3168 (lang_dirent->d_type == DT_UNKNOWN && \
3169 is_directory(scripts_path, lang_dirent))) && \
3170 (strcmp(lang_dirent->d_name, ".")) && \
3171 (strcmp(lang_dirent->d_name, "..")))
3173 #define for_each_script(lang_path, lang_dir, script_dirent) \
3174 while ((script_dirent = readdir(lang_dir)) != NULL) \
3175 if (script_dirent->d_type != DT_DIR && \
3176 (script_dirent->d_type != DT_UNKNOWN || \
3177 !is_directory(lang_path, script_dirent)))
3180 #define RECORD_SUFFIX "-record"
3181 #define REPORT_SUFFIX "-report"
3183 struct script_desc {
3184 struct list_head node;
3190 static LIST_HEAD(script_descs);
3192 static struct script_desc *script_desc__new(const char *name)
3194 struct script_desc *s = zalloc(sizeof(*s));
3196 if (s != NULL && name)
3197 s->name = strdup(name);
3202 static void script_desc__delete(struct script_desc *s)
3205 zfree(&s->half_liner);
3210 static void script_desc__add(struct script_desc *s)
3212 list_add_tail(&s->node, &script_descs);
3215 static struct script_desc *script_desc__find(const char *name)
3217 struct script_desc *s;
3219 list_for_each_entry(s, &script_descs, node)
3220 if (strcasecmp(s->name, name) == 0)
3225 static struct script_desc *script_desc__findnew(const char *name)
3227 struct script_desc *s = script_desc__find(name);
3232 s = script_desc__new(name);
3236 script_desc__add(s);
3241 static const char *ends_with(const char *str, const char *suffix)
3243 size_t suffix_len = strlen(suffix);
3244 const char *p = str;
3246 if (strlen(str) > suffix_len) {
3247 p = str + strlen(str) - suffix_len;
3248 if (!strncmp(p, suffix, suffix_len))
3255 static int read_script_info(struct script_desc *desc, const char *filename)
3257 char line[BUFSIZ], *p;
3260 fp = fopen(filename, "r");
3264 while (fgets(line, sizeof(line), fp)) {
3265 p = skip_spaces(line);
3271 if (strlen(p) && *p == '!')
3275 if (strlen(p) && p[strlen(p) - 1] == '\n')
3276 p[strlen(p) - 1] = '\0';
3278 if (!strncmp(p, "description:", strlen("description:"))) {
3279 p += strlen("description:");
3280 desc->half_liner = strdup(skip_spaces(p));
3284 if (!strncmp(p, "args:", strlen("args:"))) {
3285 p += strlen("args:");
3286 desc->args = strdup(skip_spaces(p));
3296 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3298 char *script_root, *str;
3300 script_root = strdup(script_dirent->d_name);
3304 str = (char *)ends_with(script_root, suffix);
3314 static int list_available_scripts(const struct option *opt __maybe_unused,
3315 const char *s __maybe_unused,
3316 int unset __maybe_unused)
3318 struct dirent *script_dirent, *lang_dirent;
3319 char scripts_path[MAXPATHLEN];
3320 DIR *scripts_dir, *lang_dir;
3321 char script_path[MAXPATHLEN];
3322 char lang_path[MAXPATHLEN];
3323 struct script_desc *desc;
3324 char first_half[BUFSIZ];
3327 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3329 scripts_dir = opendir(scripts_path);
3332 "open(%s) failed.\n"
3333 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3338 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3339 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3340 lang_dirent->d_name);
3341 lang_dir = opendir(lang_path);
3345 for_each_script(lang_path, lang_dir, script_dirent) {
3346 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3348 desc = script_desc__findnew(script_root);
3349 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3350 lang_path, script_dirent->d_name);
3351 read_script_info(desc, script_path);
3357 fprintf(stdout, "List of available trace scripts:\n");
3358 list_for_each_entry(desc, &script_descs, node) {
3359 sprintf(first_half, "%s %s", desc->name,
3360 desc->args ? desc->args : "");
3361 fprintf(stdout, " %-36s %s\n", first_half,
3362 desc->half_liner ? desc->half_liner : "");
3368 static int add_dlarg(const struct option *opt __maybe_unused,
3369 const char *s, int unset __maybe_unused)
3371 char *arg = strdup(s);
3377 a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
3384 dlargv[dlargc++] = arg;
3389 static void free_dlarg(void)
3392 free(dlargv[dlargc]);
3397 * Some scripts specify the required events in their "xxx-record" file,
3398 * this function will check if the events in perf.data match those
3399 * mentioned in the "xxx-record".
3401 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3402 * which is covered well now. And new parsing code should be added to
3403 * cover the future complex formats like event groups etc.
3405 static int check_ev_match(char *dir_name, char *scriptname,
3406 struct perf_session *session)
3408 char filename[MAXPATHLEN], evname[128];
3409 char line[BUFSIZ], *p;
3414 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3416 fp = fopen(filename, "r");
3420 while (fgets(line, sizeof(line), fp)) {
3421 p = skip_spaces(line);
3426 p = strstr(p, "-e");
3432 len = strcspn(p, " \t");
3436 snprintf(evname, len + 1, "%s", p);
3439 evlist__for_each_entry(session->evlist, pos) {
3440 if (!strcmp(evsel__name(pos), evname)) {
3458 * Return -1 if none is found, otherwise the actual scripts number.
3460 * Currently the only user of this function is the script browser, which
3461 * will list all statically runnable scripts, select one, execute it and
3462 * show the output in a perf browser.
3464 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3467 struct dirent *script_dirent, *lang_dirent;
3468 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3469 DIR *scripts_dir, *lang_dir;
3470 struct perf_session *session;
3471 struct perf_data data = {
3473 .mode = PERF_DATA_MODE_READ,
3478 session = perf_session__new(&data, NULL);
3479 if (IS_ERR(session))
3480 return PTR_ERR(session);
3482 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3484 scripts_dir = opendir(scripts_path);
3486 perf_session__delete(session);
3490 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3491 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3492 lang_dirent->d_name);
3493 #ifndef HAVE_LIBPERL_SUPPORT
3494 if (strstr(lang_path, "perl"))
3497 #ifndef HAVE_LIBPYTHON_SUPPORT
3498 if (strstr(lang_path, "python"))
3502 lang_dir = opendir(lang_path);
3506 for_each_script(lang_path, lang_dir, script_dirent) {
3507 /* Skip those real time scripts: xxxtop.p[yl] */
3508 if (strstr(script_dirent->d_name, "top."))
3512 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3514 script_dirent->d_name);
3515 temp = strchr(script_dirent->d_name, '.');
3516 snprintf(scripts_array[i],
3517 (temp - script_dirent->d_name) + 1,
3518 "%s", script_dirent->d_name);
3520 if (check_ev_match(lang_path,
3521 scripts_array[i], session))
3529 closedir(scripts_dir);
3530 perf_session__delete(session);
3534 static char *get_script_path(const char *script_root, const char *suffix)
3536 struct dirent *script_dirent, *lang_dirent;
3537 char scripts_path[MAXPATHLEN];
3538 char script_path[MAXPATHLEN];
3539 DIR *scripts_dir, *lang_dir;
3540 char lang_path[MAXPATHLEN];
3541 char *__script_root;
3543 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3545 scripts_dir = opendir(scripts_path);
3549 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3550 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3551 lang_dirent->d_name);
3552 lang_dir = opendir(lang_path);
3556 for_each_script(lang_path, lang_dir, script_dirent) {
3557 __script_root = get_script_root(script_dirent, suffix);
3558 if (__script_root && !strcmp(script_root, __script_root)) {
3559 free(__script_root);
3560 closedir(scripts_dir);
3561 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3562 lang_path, script_dirent->d_name);
3564 return strdup(script_path);
3566 free(__script_root);
3570 closedir(scripts_dir);
3575 static bool is_top_script(const char *script_path)
3577 return ends_with(script_path, "top") != NULL;
3580 static int has_required_arg(char *script_path)
3582 struct script_desc *desc;
3586 desc = script_desc__new(NULL);
3588 if (read_script_info(desc, script_path))
3594 for (p = desc->args; *p; p++)
3598 script_desc__delete(desc);
3603 static int have_cmd(int argc, const char **argv)
3605 char **__argv = malloc(sizeof(const char *) * argc);
3608 pr_err("malloc failed\n");
3612 memcpy(__argv, argv, sizeof(const char *) * argc);
3613 argc = parse_options(argc, (const char **)__argv, record_options,
3614 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3617 system_wide = (argc == 0);
3622 static void script__setup_sample_type(struct perf_script *script)
3624 struct perf_session *session = script->session;
3625 u64 sample_type = evlist__combined_sample_type(session->evlist);
3627 callchain_param_setup(sample_type, perf_env__arch(session->machines.host.env));
3629 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3630 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3631 "Please apply --call-graph lbr when recording.\n");
3632 script->stitch_lbr = false;
3636 static int process_stat_round_event(struct perf_session *session,
3637 union perf_event *event)
3639 struct perf_record_stat_round *round = &event->stat_round;
3640 struct evsel *counter;
3642 evlist__for_each_entry(session->evlist, counter) {
3643 perf_stat_process_counter(&stat_config, counter);
3644 process_stat(counter, round->time);
3647 process_stat_interval(round->time);
3651 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3652 union perf_event *event)
3654 perf_event__read_stat_config(&stat_config, &event->stat_config);
3658 static int set_maps(struct perf_script *script)
3660 struct evlist *evlist = script->session->evlist;
3662 if (!script->cpus || !script->threads)
3665 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3668 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3670 if (evlist__alloc_stats(&stat_config, evlist, /*alloc_raw=*/true))
3673 script->allocated = true;
3678 int process_thread_map_event(struct perf_session *session,
3679 union perf_event *event)
3681 struct perf_tool *tool = session->tool;
3682 struct perf_script *script = container_of(tool, struct perf_script, tool);
3685 perf_event__fprintf_thread_map(event, stdout);
3687 if (script->threads) {
3688 pr_warning("Extra thread map event, ignoring.\n");
3692 script->threads = thread_map__new_event(&event->thread_map);
3693 if (!script->threads)
3696 return set_maps(script);
3700 int process_cpu_map_event(struct perf_session *session,
3701 union perf_event *event)
3703 struct perf_tool *tool = session->tool;
3704 struct perf_script *script = container_of(tool, struct perf_script, tool);
3707 perf_event__fprintf_cpu_map(event, stdout);
3710 pr_warning("Extra cpu map event, ignoring.\n");
3714 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3718 return set_maps(script);
3721 static int process_feature_event(struct perf_session *session,
3722 union perf_event *event)
3724 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3725 return perf_event__process_feature(session, event);
3729 #ifdef HAVE_AUXTRACE_SUPPORT
3730 static int perf_script__process_auxtrace_info(struct perf_session *session,
3731 union perf_event *event)
3733 struct perf_tool *tool = session->tool;
3735 int ret = perf_event__process_auxtrace_info(session, event);
3738 struct perf_script *script = container_of(tool, struct perf_script, tool);
3740 ret = perf_script__setup_per_event_dump(script);
3746 #define perf_script__process_auxtrace_info 0
3749 static int parse_insn_trace(const struct option *opt __maybe_unused,
3750 const char *str __maybe_unused,
3751 int unset __maybe_unused)
3753 parse_output_fields(NULL, "+insn,-event,-period", 0);
3754 itrace_parse_synth_opts(opt, "i0ns", 0);
3755 symbol_conf.nanosecs = true;
3759 static int parse_xed(const struct option *opt __maybe_unused,
3760 const char *str __maybe_unused,
3761 int unset __maybe_unused)
3764 force_pager("xed -F insn: -A -64 | less");
3766 force_pager("xed -F insn: -A -64");
3770 static int parse_call_trace(const struct option *opt __maybe_unused,
3771 const char *str __maybe_unused,
3772 int unset __maybe_unused)
3774 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3775 itrace_parse_synth_opts(opt, "cewp", 0);
3776 symbol_conf.nanosecs = true;
3777 symbol_conf.pad_output_len_dso = 50;
3781 static int parse_callret_trace(const struct option *opt __maybe_unused,
3782 const char *str __maybe_unused,
3783 int unset __maybe_unused)
3785 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3786 itrace_parse_synth_opts(opt, "crewp", 0);
3787 symbol_conf.nanosecs = true;
3791 int cmd_script(int argc, const char **argv)
3793 bool show_full_info = false;
3794 bool header = false;
3795 bool header_only = false;
3796 bool script_started = false;
3797 bool unsorted_dump = false;
3798 char *rec_script_path = NULL;
3799 char *rep_script_path = NULL;
3800 struct perf_session *session;
3801 struct itrace_synth_opts itrace_synth_opts = {
3803 .default_no_sample = true,
3806 char *script_path = NULL;
3807 const char *dlfilter_file = NULL;
3808 const char **__argv;
3810 struct perf_script script = {
3812 .sample = process_sample_event,
3813 .mmap = perf_event__process_mmap,
3814 .mmap2 = perf_event__process_mmap2,
3815 .comm = perf_event__process_comm,
3816 .namespaces = perf_event__process_namespaces,
3817 .cgroup = perf_event__process_cgroup,
3818 .exit = perf_event__process_exit,
3819 .fork = perf_event__process_fork,
3820 .attr = process_attr,
3821 .event_update = perf_event__process_event_update,
3822 #ifdef HAVE_LIBTRACEEVENT
3823 .tracing_data = perf_event__process_tracing_data,
3825 .feature = process_feature_event,
3826 .build_id = perf_event__process_build_id,
3827 .id_index = perf_event__process_id_index,
3828 .auxtrace_info = perf_script__process_auxtrace_info,
3829 .auxtrace = perf_event__process_auxtrace,
3830 .auxtrace_error = perf_event__process_auxtrace_error,
3831 .stat = perf_event__process_stat_event,
3832 .stat_round = process_stat_round_event,
3833 .stat_config = process_stat_config_event,
3834 .thread_map = process_thread_map_event,
3835 .cpu_map = process_cpu_map_event,
3836 .throttle = process_throttle_event,
3837 .unthrottle = process_throttle_event,
3838 .ordered_events = true,
3839 .ordering_requires_timestamps = true,
3842 struct perf_data data = {
3843 .mode = PERF_DATA_MODE_READ,
3845 const struct option options[] = {
3846 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3847 "dump raw trace in ASCII"),
3848 OPT_BOOLEAN(0, "dump-unsorted-raw-trace", &unsorted_dump,
3849 "dump unsorted raw trace in ASCII"),
3850 OPT_INCR('v', "verbose", &verbose,
3851 "be more verbose (show symbol address, etc)"),
3852 OPT_BOOLEAN('L', "Latency", &latency_format,
3853 "show latency attributes (irqs/preemption disabled, etc)"),
3854 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3855 list_available_scripts),
3856 OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
3857 list_available_dlfilters),
3858 OPT_CALLBACK('s', "script", NULL, "name",
3859 "script file name (lang:script name, script name, or *)",
3861 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3862 "generate perf-script.xx script in specified language"),
3863 OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3864 OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
3866 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3867 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3868 "do various checks like samples ordering and lost events"),
3869 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3870 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3871 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3872 "file", "vmlinux pathname"),
3873 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3874 "file", "kallsyms pathname"),
3875 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3876 "When printing symbols do not display call chain"),
3877 OPT_CALLBACK(0, "symfs", NULL, "directory",
3878 "Look for files with symbols relative to this directory",
3879 symbol__config_symfs),
3880 OPT_CALLBACK('F', "fields", NULL, "str",
3881 "comma separated output fields prepend with 'type:'. "
3882 "+field to add and -field to remove."
3883 "Valid types: hw,sw,trace,raw,synth. "
3884 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3885 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3886 "brstacksym,flags,data_src,weight,bpf-output,brstackinsn,"
3887 "brstackinsnlen,brstackoff,callindent,insn,insnlen,synth,"
3888 "phys_addr,metric,misc,srccode,ipc,tod,data_page_size,"
3889 "code_page_size,ins_lat,machine_pid,vcpu,cgroup,retire_lat",
3890 parse_output_fields),
3891 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3892 "system-wide collection from all CPUs"),
3893 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3894 "only consider symbols in these DSOs"),
3895 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3896 "only consider these symbols"),
3897 OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3898 "Use with -S to list traced records within address range"),
3899 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3900 "Decode instructions from itrace", parse_insn_trace),
3901 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3902 "Run xed disassembler on output", parse_xed),
3903 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3904 "Decode calls from itrace", parse_call_trace),
3905 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3906 "Decode calls and returns from itrace", parse_callret_trace),
3907 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3908 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3909 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3910 "Stop display of callgraph at these symbols"),
3911 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3912 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3913 "only display events for these comms"),
3914 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3915 "only consider symbols in these pids"),
3916 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3917 "only consider symbols in these tids"),
3918 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3919 "Set the maximum stack depth when parsing the callchain, "
3920 "anything beyond the specified depth will be ignored. "
3921 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3922 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3923 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3924 OPT_BOOLEAN('I', "show-info", &show_full_info,
3925 "display extended information from perf.data file"),
3926 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3927 "Show the path of [kernel.kallsyms]"),
3928 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3929 "Show the fork/comm/exit events"),
3930 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3931 "Show the mmap events"),
3932 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3933 "Show context switch events (if recorded)"),
3934 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3935 "Show namespace events (if recorded)"),
3936 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3937 "Show cgroup events (if recorded)"),
3938 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3939 "Show lost events (if recorded)"),
3940 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3941 "Show round events (if recorded)"),
3942 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3943 "Show bpf related events (if recorded)"),
3944 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3945 "Show text poke related events (if recorded)"),
3946 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3947 "Dump trace output to files named by the monitored events"),
3948 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3949 OPT_INTEGER(0, "max-blocks", &max_blocks,
3950 "Maximum number of code blocks to dump with brstackinsn"),
3951 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3952 "Use 9 decimal places when displaying time"),
3953 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3954 "Instruction Tracing options\n" ITRACE_HELP,
3955 itrace_parse_synth_opts),
3956 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3957 "Show full source file name path for source lines"),
3958 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3959 "Enable symbol demangling"),
3960 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3961 "Enable kernel symbol demangling"),
3962 OPT_STRING(0, "time", &script.time_str, "str",
3963 "Time span of interest (start,stop)"),
3964 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3965 "Show inline function"),
3966 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3967 "guest mount directory under which every guest os"
3968 " instance has a subdir"),
3969 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3970 "file", "file saving guest os vmlinux"),
3971 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3972 "file", "file saving guest os /proc/kallsyms"),
3973 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3974 "file", "file saving guest os /proc/modules"),
3975 OPT_BOOLEAN(0, "guest-code", &symbol_conf.guest_code,
3976 "Guest code can be found in hypervisor process"),
3977 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3978 "Enable LBR callgraph stitching approach"),
3979 OPTS_EVSWITCH(&script.evswitch),
3982 const char * const script_subcommands[] = { "record", "report", NULL };
3983 const char *script_usage[] = {
3984 "perf script [<options>]",
3985 "perf script [<options>] record <script> [<record-options>] <command>",
3986 "perf script [<options>] report <script> [script-args]",
3987 "perf script [<options>] <script> [<record-options>] <command>",
3988 "perf script [<options>] <top-script> [script-args]",
3992 perf_set_singlethreaded();
3996 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3997 PARSE_OPT_STOP_AT_NON_OPTION);
3999 if (symbol_conf.guestmount ||
4000 symbol_conf.default_guest_vmlinux_name ||
4001 symbol_conf.default_guest_kallsyms ||
4002 symbol_conf.default_guest_modules ||
4003 symbol_conf.guest_code) {
4005 * Enable guest sample processing.
4010 data.path = input_name;
4011 data.force = symbol_conf.force;
4013 if (unsorted_dump) {
4015 script.tool.ordered_events = false;
4018 if (symbol__validate_sym_arguments())
4021 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
4022 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
4023 if (!rec_script_path)
4024 return cmd_record(argc, argv);
4027 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("report", argv[0])) {
4028 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
4029 if (!rep_script_path) {
4031 "Please specify a valid report script"
4032 "(see 'perf script -l' for listing)\n");
4037 if (reltime && deltatime) {
4039 "reltime and deltatime - the two don't get along well. "
4040 "Please limit to --reltime or --deltatime.\n");
4044 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
4045 itrace_synth_opts.callchain_sz > scripting_max_stack)
4046 scripting_max_stack = itrace_synth_opts.callchain_sz;
4048 /* make sure PERF_EXEC_PATH is set for scripts */
4049 set_argv_exec_path(get_argv_exec_path());
4051 if (argc && !script_name && !rec_script_path && !rep_script_path) {
4056 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
4057 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
4059 if (!rec_script_path && !rep_script_path) {
4060 script_name = find_script(argv[0]);
4066 usage_with_options_msg(script_usage, options,
4067 "Couldn't find script `%s'\n\n See perf"
4068 " script -l for available scripts.\n", argv[0]);
4071 if (is_top_script(argv[0])) {
4072 rep_args = argc - 1;
4076 rep_args = has_required_arg(rep_script_path);
4077 rec_args = (argc - 1) - rep_args;
4079 usage_with_options_msg(script_usage, options,
4080 "`%s' script requires options."
4081 "\n\n See perf script -l for available "
4082 "scripts and options.\n", argv[0]);
4086 if (pipe(live_pipe) < 0) {
4087 perror("failed to create pipe");
4093 perror("failed to fork");
4100 dup2(live_pipe[1], 1);
4101 close(live_pipe[0]);
4103 if (is_top_script(argv[0])) {
4105 } else if (!system_wide) {
4106 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
4112 __argv = malloc((argc + 6) * sizeof(const char *));
4114 pr_err("malloc failed\n");
4119 __argv[j++] = "/bin/sh";
4120 __argv[j++] = rec_script_path;
4126 for (i = rep_args + 1; i < argc; i++)
4127 __argv[j++] = argv[i];
4130 execvp("/bin/sh", (char **)__argv);
4135 dup2(live_pipe[0], 0);
4136 close(live_pipe[1]);
4138 __argv = malloc((argc + 4) * sizeof(const char *));
4140 pr_err("malloc failed\n");
4146 __argv[j++] = "/bin/sh";
4147 __argv[j++] = rep_script_path;
4148 for (i = 1; i < rep_args + 1; i++)
4149 __argv[j++] = argv[i];
4154 execvp("/bin/sh", (char **)__argv);
4159 if (rec_script_path)
4160 script_path = rec_script_path;
4161 if (rep_script_path)
4162 script_path = rep_script_path;
4167 if (!rec_script_path)
4168 system_wide = false;
4169 else if (!system_wide) {
4170 if (have_cmd(argc - 1, &argv[1]) != 0) {
4176 __argv = malloc((argc + 2) * sizeof(const char *));
4178 pr_err("malloc failed\n");
4183 __argv[j++] = "/bin/sh";
4184 __argv[j++] = script_path;
4187 for (i = 2; i < argc; i++)
4188 __argv[j++] = argv[i];
4191 execvp("/bin/sh", (char **)__argv);
4196 if (dlfilter_file) {
4197 dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4207 session = perf_session__new(&data, &script.tool);
4208 if (IS_ERR(session))
4209 return PTR_ERR(session);
4211 if (header || header_only) {
4212 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4213 perf_session__fprintf_info(session, stdout, show_full_info);
4218 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4220 if (symbol__init(&session->header.env) < 0)
4224 if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4226 } else if (session->header.env.arch) {
4227 if (!strcmp(uts.machine, session->header.env.arch))
4229 else if (!strcmp(uts.machine, "x86_64") &&
4230 !strcmp(session->header.env.arch, "i386"))
4234 script.session = session;
4235 script__setup_sample_type(&script);
4237 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
4238 symbol_conf.graph_function)
4239 itrace_synth_opts.thread_stack = true;
4241 session->itrace_synth_opts = &itrace_synth_opts;
4244 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4247 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4251 symbol_conf.use_callchain = true;
4253 symbol_conf.use_callchain = false;
4255 #ifdef HAVE_LIBTRACEEVENT
4256 if (session->tevent.pevent &&
4257 tep_set_function_resolver(session->tevent.pevent,
4258 machine__resolve_kernel_addr,
4259 &session->machines.host) < 0) {
4260 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4265 if (generate_script_lang) {
4266 struct stat perf_stat;
4269 if (output_set_by_user()) {
4271 "custom fields not supported for generated scripts");
4276 input = open(data.path, O_RDONLY); /* input_name */
4279 perror("failed to open file");
4283 err = fstat(input, &perf_stat);
4285 perror("failed to stat file");
4289 if (!perf_stat.st_size) {
4290 fprintf(stderr, "zero-sized file, nothing to do!\n");
4294 scripting_ops = script_spec__lookup(generate_script_lang);
4295 if (!scripting_ops) {
4296 fprintf(stderr, "invalid language specifier");
4300 #ifdef HAVE_LIBTRACEEVENT
4301 err = scripting_ops->generate_script(session->tevent.pevent,
4304 err = scripting_ops->generate_script(NULL, "perf-script");
4309 err = dlfilter__start(dlfilter, session);
4314 err = scripting_ops->start_script(script_name, argc, argv, session);
4317 pr_debug("perf script started with script %s\n\n", script_name);
4318 script_started = true;
4322 err = perf_session__check_output_opt(session);
4326 if (script.time_str) {
4327 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4328 &script.ptime_range,
4335 itrace_synth_opts__set_time_range(&itrace_synth_opts,
4340 err = evswitch__init(&script.evswitch, session->evlist, stderr);
4344 if (zstd_init(&(session->zstd_data), 0) < 0)
4345 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4347 err = __cmd_script(&script);
4352 if (script.ptime_range) {
4353 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4354 zfree(&script.ptime_range);
4357 zstd_fini(&(session->zstd_data));
4358 evlist__free_stats(session->evlist);
4359 perf_session__delete(session);
4360 perf_script__exit(&script);
4363 cleanup_scripting();
4364 dlfilter__cleanup(dlfilter);