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,
136 PERF_OUTPUT_DSOFF = 1ULL << 41,
140 struct perf_tool tool;
141 struct perf_session *session;
142 bool show_task_events;
143 bool show_mmap_events;
144 bool show_switch_events;
145 bool show_namespace_events;
146 bool show_lost_events;
147 bool show_round_events;
148 bool show_bpf_events;
149 bool show_cgroup_events;
150 bool show_text_poke_events;
154 struct evswitch evswitch;
155 struct perf_cpu_map *cpus;
156 struct perf_thread_map *threads;
158 const char *time_str;
159 struct perf_time_interval *ptime_range;
164 struct output_option {
166 enum perf_output_field field;
167 } all_output_options[] = {
168 {.str = "comm", .field = PERF_OUTPUT_COMM},
169 {.str = "tid", .field = PERF_OUTPUT_TID},
170 {.str = "pid", .field = PERF_OUTPUT_PID},
171 {.str = "time", .field = PERF_OUTPUT_TIME},
172 {.str = "cpu", .field = PERF_OUTPUT_CPU},
173 {.str = "event", .field = PERF_OUTPUT_EVNAME},
174 {.str = "trace", .field = PERF_OUTPUT_TRACE},
175 {.str = "ip", .field = PERF_OUTPUT_IP},
176 {.str = "sym", .field = PERF_OUTPUT_SYM},
177 {.str = "dso", .field = PERF_OUTPUT_DSO},
178 {.str = "dsoff", .field = PERF_OUTPUT_DSOFF},
179 {.str = "addr", .field = PERF_OUTPUT_ADDR},
180 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
181 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
182 {.str = "period", .field = PERF_OUTPUT_PERIOD},
183 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
184 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
185 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
186 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
187 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
188 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
189 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
190 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
191 {.str = "insn", .field = PERF_OUTPUT_INSN},
192 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
193 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
194 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
195 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
196 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
197 {.str = "metric", .field = PERF_OUTPUT_METRIC},
198 {.str = "misc", .field = PERF_OUTPUT_MISC},
199 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
200 {.str = "ipc", .field = PERF_OUTPUT_IPC},
201 {.str = "tod", .field = PERF_OUTPUT_TOD},
202 {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
203 {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
204 {.str = "ins_lat", .field = PERF_OUTPUT_INS_LAT},
205 {.str = "brstackinsnlen", .field = PERF_OUTPUT_BRSTACKINSNLEN},
206 {.str = "machine_pid", .field = PERF_OUTPUT_MACHINE_PID},
207 {.str = "vcpu", .field = PERF_OUTPUT_VCPU},
208 {.str = "cgroup", .field = PERF_OUTPUT_CGROUP},
209 {.str = "retire_lat", .field = PERF_OUTPUT_RETIRE_LAT},
213 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
218 /* default set to maintain compatibility with current format */
222 unsigned int print_ip_opts;
226 u64 user_unset_fields;
227 } output[OUTPUT_TYPE_MAX] = {
229 [PERF_TYPE_HARDWARE] = {
232 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
233 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
234 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
235 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
236 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
238 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
241 [PERF_TYPE_SOFTWARE] = {
244 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
245 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
246 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
247 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
248 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
249 PERF_OUTPUT_BPF_OUTPUT,
251 .invalid_fields = PERF_OUTPUT_TRACE,
254 [PERF_TYPE_TRACEPOINT] = {
257 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
258 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
259 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
262 [PERF_TYPE_HW_CACHE] = {
265 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
266 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
267 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
268 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
269 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
271 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
277 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
278 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
279 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
280 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
281 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
282 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
283 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
284 PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
285 PERF_OUTPUT_INS_LAT | PERF_OUTPUT_RETIRE_LAT,
287 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
290 [PERF_TYPE_BREAKPOINT] = {
293 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
294 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
295 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
296 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
297 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
299 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
302 [OUTPUT_TYPE_SYNTH] = {
305 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
306 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
307 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
308 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
309 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
311 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
314 [OUTPUT_TYPE_OTHER] = {
317 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
318 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
319 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
320 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
321 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
323 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
327 struct evsel_script {
331 /* For metric output */
336 static inline struct evsel_script *evsel_script(struct evsel *evsel)
338 return (struct evsel_script *)evsel->priv;
341 static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
343 struct evsel_script *es = zalloc(sizeof(*es));
346 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
348 es->fp = fopen(es->filename, "w");
350 goto out_free_filename;
355 zfree(&es->filename);
361 static void evsel_script__delete(struct evsel_script *es)
363 zfree(&es->filename);
369 static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
373 fstat(fileno(es->fp), &st);
374 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
375 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
378 static inline int output_type(unsigned int type)
381 case PERF_TYPE_SYNTH:
382 return OUTPUT_TYPE_SYNTH;
384 if (type < PERF_TYPE_MAX)
388 return OUTPUT_TYPE_OTHER;
391 static bool output_set_by_user(void)
394 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
395 if (output[j].user_set)
401 static const char *output_field2str(enum perf_output_field field)
403 int i, imax = ARRAY_SIZE(all_output_options);
404 const char *str = "";
406 for (i = 0; i < imax; ++i) {
407 if (all_output_options[i].field == field) {
408 str = all_output_options[i].str;
415 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
417 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
418 enum perf_output_field field, bool allow_user_set)
420 struct perf_event_attr *attr = &evsel->core.attr;
421 int type = output_type(attr->type);
424 if (attr->sample_type & sample_type)
427 if (output[type].user_set_fields & field) {
430 evname = evsel__name(evsel);
431 pr_err("Samples for '%s' event do not have %s attribute set. "
432 "Cannot print '%s' field.\n",
433 evname, sample_msg, output_field2str(field));
437 /* user did not ask for it explicitly so remove from the default list */
438 output[type].fields &= ~field;
439 evname = evsel__name(evsel);
440 pr_debug("Samples for '%s' event do not have %s attribute set. "
441 "Skipping '%s' field.\n",
442 evname, sample_msg, output_field2str(field));
447 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
448 enum perf_output_field field)
450 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
453 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
455 struct perf_event_attr *attr = &evsel->core.attr;
458 if (evsel__is_dummy_event(evsel))
461 if (perf_header__has_feat(&session->header, HEADER_STAT))
464 allow_user_set = perf_header__has_feat(&session->header,
467 if (PRINT_FIELD(TRACE) &&
468 !perf_session__has_traces(session, "record -R"))
471 if (PRINT_FIELD(IP)) {
472 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
476 if (PRINT_FIELD(ADDR) &&
477 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
480 if (PRINT_FIELD(DATA_SRC) &&
481 evsel__do_check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC, allow_user_set))
484 if (PRINT_FIELD(WEIGHT) &&
485 evsel__do_check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT, allow_user_set))
488 if (PRINT_FIELD(SYM) &&
489 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
490 pr_err("Display of symbols requested but neither sample IP nor "
491 "sample address\navailable. Hence, no addresses to convert "
495 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
496 pr_err("Display of offsets requested but symbol is not"
500 if (PRINT_FIELD(DSO) &&
501 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
502 pr_err("Display of DSO requested but no address to convert.\n");
505 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
506 pr_err("Display of source line number requested but sample IP is not\n"
507 "selected. Hence, no address to lookup the source line number.\n");
510 if ((PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN)) && !allow_user_set &&
511 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
512 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
513 "Hint: run 'perf record -b ...'\n");
516 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
517 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
520 if (PRINT_FIELD(TIME) &&
521 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
524 if (PRINT_FIELD(CPU) &&
525 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
528 if (PRINT_FIELD(IREGS) &&
529 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
532 if (PRINT_FIELD(UREGS) &&
533 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
536 if (PRINT_FIELD(PHYS_ADDR) &&
537 evsel__do_check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR, allow_user_set))
540 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
541 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
544 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
545 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
548 if (PRINT_FIELD(INS_LAT) &&
549 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
552 if (PRINT_FIELD(CGROUP) &&
553 evsel__check_stype(evsel, PERF_SAMPLE_CGROUP, "CGROUP", PERF_OUTPUT_CGROUP)) {
554 pr_err("Hint: run 'perf record --all-cgroups ...'\n");
558 if (PRINT_FIELD(RETIRE_LAT) &&
559 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_RETIRE_LAT))
565 static void set_print_ip_opts(struct perf_event_attr *attr)
567 unsigned int type = output_type(attr->type);
569 output[type].print_ip_opts = 0;
571 output[type].print_ip_opts |= EVSEL__PRINT_IP;
573 if (PRINT_FIELD(SYM))
574 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
576 if (PRINT_FIELD(DSO))
577 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
579 if (PRINT_FIELD(DSOFF))
580 output[type].print_ip_opts |= EVSEL__PRINT_DSOFF;
582 if (PRINT_FIELD(SYMOFFSET))
583 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
585 if (PRINT_FIELD(SRCLINE))
586 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
589 static struct evsel *find_first_output_type(struct evlist *evlist,
594 evlist__for_each_entry(evlist, evsel) {
595 if (evsel__is_dummy_event(evsel))
597 if (output_type(evsel->core.attr.type) == (int)type)
604 * verify all user requested events exist and the samples
605 * have the expected data
607 static int perf_session__check_output_opt(struct perf_session *session)
613 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
614 evsel = find_first_output_type(session->evlist, j);
617 * even if fields is set to 0 (ie., show nothing) event must
618 * exist if user explicitly includes it on the command line
620 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
621 j != OUTPUT_TYPE_SYNTH) {
622 pr_err("%s events do not exist. "
623 "Remove corresponding -F option to proceed.\n",
628 if (evsel && output[j].fields &&
629 evsel__check_attr(evsel, session))
635 /* 'dsoff' implys 'dso' field */
636 if (output[j].fields & PERF_OUTPUT_DSOFF)
637 output[j].fields |= PERF_OUTPUT_DSO;
639 set_print_ip_opts(&evsel->core.attr);
640 tod |= output[j].fields & PERF_OUTPUT_TOD;
644 bool use_callchain = false;
645 bool not_pipe = false;
647 evlist__for_each_entry(session->evlist, evsel) {
649 if (evsel__has_callchain(evsel)) {
650 use_callchain = true;
654 if (not_pipe && !use_callchain)
655 symbol_conf.use_callchain = false;
659 * set default for tracepoints to print symbols only
660 * if callchains are present
662 if (symbol_conf.use_callchain &&
663 !output[PERF_TYPE_TRACEPOINT].user_set) {
664 j = PERF_TYPE_TRACEPOINT;
666 evlist__for_each_entry(session->evlist, evsel) {
667 if (evsel->core.attr.type != j)
670 if (evsel__has_callchain(evsel)) {
671 output[j].fields |= PERF_OUTPUT_IP;
672 output[j].fields |= PERF_OUTPUT_SYM;
673 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
674 output[j].fields |= PERF_OUTPUT_DSO;
675 set_print_ip_opts(&evsel->core.attr);
681 if (tod && !session->header.env.clock.enabled) {
682 pr_err("Can't provide 'tod' time, missing clock data. "
683 "Please record with -k/--clockid option.\n");
690 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask, const char *arch,
696 if (!regs || !regs->regs)
699 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
701 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
702 u64 val = regs->regs[i++];
703 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r, arch), val);
709 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
712 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
715 u64 tod_ns, clockid_ns;
716 struct perf_env *env;
723 if (buflen < 64 || !script)
726 env = &script->session->header.env;
727 if (!env->clock.enabled) {
728 scnprintf(buf, buflen, "disabled");
732 clockid_ns = env->clock.clockid_ns;
733 tod_ns = env->clock.tod_ns;
735 if (timestamp > clockid_ns)
736 tod_ns += timestamp - clockid_ns;
738 tod_ns -= clockid_ns - timestamp;
740 sec = (time_t) (tod_ns / NSEC_PER_SEC);
741 nsec = tod_ns - sec * NSEC_PER_SEC;
743 if (localtime_r(&sec, <ime) == NULL) {
744 scnprintf(buf, buflen, "failed");
746 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
748 if (symbol_conf.nanosecs) {
749 snprintf(buf, buflen, "%s.%09lu", date, nsec);
751 snprintf(buf, buflen, "%s.%06lu",
752 date, nsec / NSEC_PER_USEC);
759 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
760 struct perf_event_attr *attr, const char *arch, FILE *fp)
762 return perf_sample__fprintf_regs(&sample->intr_regs,
763 attr->sample_regs_intr, arch, fp);
766 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
767 struct perf_event_attr *attr, const char *arch, FILE *fp)
769 return perf_sample__fprintf_regs(&sample->user_regs,
770 attr->sample_regs_user, arch, fp);
773 static int perf_sample__fprintf_start(struct perf_script *script,
774 struct perf_sample *sample,
775 struct thread *thread,
779 struct perf_event_attr *attr = &evsel->core.attr;
781 unsigned long long nsecs;
785 if (PRINT_FIELD(MACHINE_PID) && sample->machine_pid)
786 printed += fprintf(fp, "VM:%5d ", sample->machine_pid);
788 /* Print VCPU only for guest events i.e. with machine_pid */
789 if (PRINT_FIELD(VCPU) && sample->machine_pid)
790 printed += fprintf(fp, "VCPU:%03d ", sample->vcpu);
792 if (PRINT_FIELD(COMM)) {
793 const char *comm = thread ? thread__comm_str(thread) : ":-1";
796 printed += fprintf(fp, "%8.8s ", comm);
797 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
798 printed += fprintf(fp, "%s ", comm);
800 printed += fprintf(fp, "%16s ", comm);
803 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
804 printed += fprintf(fp, "%7d/%-7d ", sample->pid, sample->tid);
805 else if (PRINT_FIELD(PID))
806 printed += fprintf(fp, "%7d ", sample->pid);
807 else if (PRINT_FIELD(TID))
808 printed += fprintf(fp, "%7d ", sample->tid);
810 if (PRINT_FIELD(CPU)) {
812 printed += fprintf(fp, "%3d ", sample->cpu);
814 printed += fprintf(fp, "[%03d] ", sample->cpu);
817 if (PRINT_FIELD(MISC)) {
821 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
824 ret += fprintf(fp, "K");
826 ret += fprintf(fp, "U");
828 ret += fprintf(fp, "H");
829 if (has(GUEST_KERNEL))
830 ret += fprintf(fp, "G");
832 ret += fprintf(fp, "g");
835 case PERF_RECORD_MMAP:
836 case PERF_RECORD_MMAP2:
838 ret += fprintf(fp, "M");
840 case PERF_RECORD_COMM:
842 ret += fprintf(fp, "E");
844 case PERF_RECORD_SWITCH:
845 case PERF_RECORD_SWITCH_CPU_WIDE:
846 if (has(SWITCH_OUT)) {
847 ret += fprintf(fp, "S");
848 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
849 ret += fprintf(fp, "p");
857 ret += fprintf(fp, "%*s", 6 - ret, " ");
861 if (PRINT_FIELD(TOD)) {
862 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
863 printed += fprintf(fp, "%s ", tstr);
866 if (PRINT_FIELD(TIME)) {
867 u64 t = sample->time;
870 initial_time = sample->time;
871 t = sample->time - initial_time;
872 } else if (deltatime) {
874 t = sample->time - previous_time;
878 previous_time = sample->time;
881 secs = nsecs / NSEC_PER_SEC;
882 nsecs -= secs * NSEC_PER_SEC;
884 if (symbol_conf.nanosecs)
885 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
887 char sample_time[32];
888 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
889 printed += fprintf(fp, "%12s: ", sample_time);
897 mispred_str(struct branch_entry *br)
899 if (!(br->flags.mispred || br->flags.predicted))
902 return br->flags.predicted ? 'P' : 'M';
905 static int print_bstack_flags(FILE *fp, struct branch_entry *br)
907 return fprintf(fp, "/%c/%c/%c/%d/%s/%s ",
909 br->flags.in_tx ? 'X' : '-',
910 br->flags.abort ? 'A' : '-',
913 br->flags.spec ? branch_spec_desc(br->flags.spec) : "-");
916 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
917 struct thread *thread,
918 struct perf_event_attr *attr, FILE *fp)
920 struct branch_stack *br = sample->branch_stack;
921 struct branch_entry *entries = perf_sample__branch_entries(sample);
928 for (i = 0; i < br->nr; i++) {
929 from = entries[i].from;
932 printed += fprintf(fp, " 0x%"PRIx64, from);
933 if (PRINT_FIELD(DSO)) {
934 struct addr_location alf, alt;
936 addr_location__init(&alf);
937 addr_location__init(&alt);
938 thread__find_map_fb(thread, sample->cpumode, from, &alf);
939 thread__find_map_fb(thread, sample->cpumode, to, &alt);
941 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
942 printed += fprintf(fp, "/0x%"PRIx64, to);
943 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
944 addr_location__exit(&alt);
945 addr_location__exit(&alf);
947 printed += fprintf(fp, "/0x%"PRIx64, to);
949 printed += print_bstack_flags(fp, entries + i);
955 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
956 struct thread *thread,
957 struct perf_event_attr *attr, FILE *fp)
959 struct branch_stack *br = sample->branch_stack;
960 struct branch_entry *entries = perf_sample__branch_entries(sample);
967 for (i = 0; i < br->nr; i++) {
968 struct addr_location alf, alt;
970 addr_location__init(&alf);
971 addr_location__init(&alt);
972 from = entries[i].from;
975 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
976 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
978 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
979 if (PRINT_FIELD(DSO))
980 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
981 printed += fprintf(fp, "%c", '/');
982 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
983 if (PRINT_FIELD(DSO))
984 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
985 printed += print_bstack_flags(fp, entries + i);
986 addr_location__exit(&alt);
987 addr_location__exit(&alf);
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);
1002 if (!(br && br->nr))
1005 for (i = 0; i < br->nr; i++) {
1006 struct addr_location alf, alt;
1008 addr_location__init(&alf);
1009 addr_location__init(&alt);
1010 from = entries[i].from;
1013 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
1014 !map__dso(alf.map)->adjust_symbols)
1015 from = map__dso_map_ip(alf.map, from);
1017 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
1018 !map__dso(alt.map)->adjust_symbols)
1019 to = map__dso_map_ip(alt.map, to);
1021 printed += fprintf(fp, " 0x%"PRIx64, from);
1022 if (PRINT_FIELD(DSO))
1023 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
1024 printed += fprintf(fp, "/0x%"PRIx64, to);
1025 if (PRINT_FIELD(DSO))
1026 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
1027 printed += print_bstack_flags(fp, entries + i);
1028 addr_location__exit(&alt);
1029 addr_location__exit(&alf);
1034 #define MAXBB 16384UL
1036 static int grab_bb(u8 *buffer, u64 start, u64 end,
1037 struct machine *machine, struct thread *thread,
1038 bool *is64bit, u8 *cpumode, bool last)
1041 struct addr_location al;
1049 kernel = machine__kernel_ip(machine, start);
1051 *cpumode = PERF_RECORD_MISC_KERNEL;
1053 *cpumode = PERF_RECORD_MISC_USER;
1056 * Block overlaps between kernel and user.
1057 * This can happen due to ring filtering
1058 * On Intel CPUs the entry into the kernel is filtered,
1059 * but the exit is not. Let the caller patch it up.
1061 if (kernel != machine__kernel_ip(machine, end)) {
1062 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1066 if (end - start > MAXBB - MAXINSN) {
1068 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1070 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1074 addr_location__init(&al);
1075 if (!thread__find_map(thread, *cpumode, start, &al) || (dso = map__dso(al.map)) == NULL) {
1076 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1079 if (dso->data.status == DSO_DATA_STATUS_ERROR) {
1080 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1084 /* Load maps to ensure dso->is_64_bit has been updated */
1087 offset = map__map_ip(al.map, start);
1088 len = dso__data_read_offset(dso, machine, offset, (u8 *)buffer,
1089 end - start + MAXINSN);
1091 *is64bit = dso->is_64_bit;
1093 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1097 addr_location__exit(&al);
1101 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1110 if (!map || (dso = map__dso(map)) == NULL)
1112 srcfile = get_srcline_split(dso,
1113 map__rip_2objdump(map, addr),
1118 /* Avoid redundant printing */
1121 !strcmp(state->srcfile, srcfile) &&
1122 state->line == line) {
1127 srccode = find_sourceline(srcfile, line, &len);
1131 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1134 state->srcfile = srcfile;
1144 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1146 struct addr_location al;
1149 addr_location__init(&al);
1150 thread__find_map(thread, cpumode, addr, &al);
1153 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1154 thread__srccode_state(thread));
1156 ret += printf("\n");
1158 addr_location__exit(&al);
1162 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1163 struct perf_insn *x, u8 *inbuf, int len,
1164 int insn, FILE *fp, int *total_cycles,
1165 struct perf_event_attr *attr)
1168 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t", ip,
1169 dump_insn(x, ip, inbuf, len, &ilen));
1171 if (PRINT_FIELD(BRSTACKINSNLEN))
1172 printed += fprintf(fp, "ilen: %d\t", ilen);
1174 printed += fprintf(fp, "#%s%s%s%s",
1175 en->flags.predicted ? " PRED" : "",
1176 en->flags.mispred ? " MISPRED" : "",
1177 en->flags.in_tx ? " INTX" : "",
1178 en->flags.abort ? " ABORT" : "");
1179 if (en->flags.cycles) {
1180 *total_cycles += en->flags.cycles;
1181 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1183 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1185 return printed + fprintf(fp, "\n");
1188 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1189 u8 cpumode, int cpu, struct symbol **lastsym,
1190 struct perf_event_attr *attr, FILE *fp)
1192 struct addr_location al;
1193 int off, printed = 0, ret = 0;
1195 addr_location__init(&al);
1196 thread__find_map(thread, cpumode, addr, &al);
1198 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1204 al.sym = map__find_symbol(al.map, al.addr);
1209 if (al.addr < al.sym->end)
1210 off = al.addr - al.sym->start;
1212 off = al.addr - map__start(al.map) - al.sym->start;
1213 printed += fprintf(fp, "\t%s", al.sym->name);
1215 printed += fprintf(fp, "%+d", off);
1216 printed += fprintf(fp, ":");
1217 if (PRINT_FIELD(SRCLINE))
1218 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1219 printed += fprintf(fp, "\n");
1224 addr_location__exit(&al);
1228 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1229 struct thread *thread,
1230 struct perf_event_attr *attr,
1231 struct machine *machine, FILE *fp)
1233 struct branch_stack *br = sample->branch_stack;
1234 struct branch_entry *entries = perf_sample__branch_entries(sample);
1236 int i, insn, len, nr, ilen, printed = 0;
1240 struct symbol *lastsym = NULL;
1241 int total_cycles = 0;
1243 if (!(br && br->nr))
1246 if (max_blocks && nr > max_blocks + 1)
1247 nr = max_blocks + 1;
1250 x.cpu = sample->cpu;
1252 printed += fprintf(fp, "%c", '\n');
1254 /* Handle first from jump, of which we don't know the entry. */
1255 len = grab_bb(buffer, entries[nr-1].from,
1257 machine, thread, &x.is64bit, &x.cpumode, false);
1259 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1260 x.cpumode, x.cpu, &lastsym, attr, fp);
1261 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1262 &x, buffer, len, 0, fp, &total_cycles,
1264 if (PRINT_FIELD(SRCCODE))
1265 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1268 /* Print all blocks */
1269 for (i = nr - 2; i >= 0; i--) {
1270 if (entries[i].from || entries[i].to)
1271 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1274 start = entries[i + 1].to;
1275 end = entries[i].from;
1277 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1278 /* Patch up missing kernel transfers due to ring filters */
1279 if (len == -ENXIO && i > 0) {
1280 end = entries[--i].from;
1281 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1282 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1288 for (off = 0; off < (unsigned)len; off += ilen) {
1289 uint64_t ip = start + off;
1291 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1293 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1294 &total_cycles, attr);
1295 if (PRINT_FIELD(SRCCODE))
1296 printed += print_srccode(thread, x.cpumode, ip);
1300 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", ip,
1301 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1302 if (PRINT_FIELD(BRSTACKINSNLEN))
1303 printed += fprintf(fp, "\tilen: %d", ilen);
1304 printed += fprintf(fp, "\n");
1307 if (PRINT_FIELD(SRCCODE))
1308 print_srccode(thread, x.cpumode, ip);
1312 if (off != end - start)
1313 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1317 * Hit the branch? In this case we are already done, and the target
1318 * has not been executed yet.
1320 if (entries[0].from == sample->ip)
1322 if (entries[0].flags.abort)
1326 * Print final block up to sample
1328 * Due to pipeline delays the LBRs might be missing a branch
1329 * or two, which can result in very large or negative blocks
1330 * between final branch and sample. When this happens just
1331 * continue walking after the last TO until we hit a branch.
1333 start = entries[0].to;
1336 /* Missing jump. Scan 128 bytes for the next branch */
1339 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1340 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1342 /* Print at least last IP if basic block did not work */
1343 len = grab_bb(buffer, sample->ip, sample->ip,
1344 machine, thread, &x.is64bit, &x.cpumode, false);
1348 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", sample->ip,
1349 dump_insn(&x, sample->ip, buffer, len, &ilen));
1350 if (PRINT_FIELD(BRSTACKINSNLEN))
1351 printed += fprintf(fp, "\tilen: %d", ilen);
1352 printed += fprintf(fp, "\n");
1353 if (PRINT_FIELD(SRCCODE))
1354 print_srccode(thread, x.cpumode, sample->ip);
1357 for (off = 0; off <= end - start; off += ilen) {
1359 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", start + off,
1360 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1361 if (PRINT_FIELD(BRSTACKINSNLEN))
1362 printed += fprintf(fp, "\tilen: %d", ilen);
1363 printed += fprintf(fp, "\n");
1366 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1368 * Hit a missing branch. Just stop.
1370 printed += fprintf(fp, "\t... not reaching sample ...\n");
1373 if (PRINT_FIELD(SRCCODE))
1374 print_srccode(thread, x.cpumode, start + off);
1380 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1381 struct thread *thread,
1382 struct perf_event_attr *attr, FILE *fp)
1384 struct addr_location al;
1385 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1387 addr_location__init(&al);
1388 if (!sample_addr_correlates_sym(attr))
1391 thread__resolve(thread, &al, sample);
1393 if (PRINT_FIELD(SYM)) {
1394 printed += fprintf(fp, " ");
1395 if (PRINT_FIELD(SYMOFFSET))
1396 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1398 printed += symbol__fprintf_symname(al.sym, fp);
1401 if (PRINT_FIELD(DSO))
1402 printed += map__fprintf_dsoname_dsoff(al.map, PRINT_FIELD(DSOFF), al.addr, fp);
1404 addr_location__exit(&al);
1408 static const char *resolve_branch_sym(struct perf_sample *sample,
1409 struct evsel *evsel,
1410 struct thread *thread,
1411 struct addr_location *al,
1412 struct addr_location *addr_al,
1415 struct perf_event_attr *attr = &evsel->core.attr;
1416 const char *name = NULL;
1418 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1419 if (sample_addr_correlates_sym(attr)) {
1420 if (!addr_al->thread)
1421 thread__resolve(thread, addr_al, sample);
1423 name = addr_al->sym->name;
1429 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1431 name = al->sym->name;
1438 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1439 struct evsel *evsel,
1440 struct thread *thread,
1441 struct addr_location *al,
1442 struct addr_location *addr_al,
1445 struct perf_event_attr *attr = &evsel->core.attr;
1446 size_t depth = thread_stack__depth(thread, sample->cpu);
1447 const char *name = NULL;
1454 * The 'return' has already been popped off the stack so the depth has
1455 * to be adjusted to match the 'call'.
1457 if (thread__ts(thread) && sample->flags & PERF_IP_FLAG_RETURN)
1460 name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1462 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1463 dlen += fprintf(fp, "(");
1464 dlen += map__fprintf_dsoname(al->map, fp);
1465 dlen += fprintf(fp, ")\t");
1469 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1471 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1477 * Try to keep the output length from changing frequently so that the
1478 * output lines up more nicely.
1480 if (len > spacing || (len && len < spacing - 52))
1481 spacing = round_up(len + 4, 32);
1484 len += fprintf(fp, "%*s", spacing - len, "");
1489 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1490 struct thread *thread __maybe_unused,
1491 struct machine *machine __maybe_unused)
1495 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1496 struct machine *machine)
1498 if (sample->insn_len == 0 && native_arch)
1499 arch_fetch_insn(sample, thread, machine);
1502 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1503 struct perf_event_attr *attr,
1504 struct thread *thread,
1505 struct machine *machine, FILE *fp)
1509 script_fetch_insn(sample, thread, machine);
1511 if (PRINT_FIELD(INSNLEN))
1512 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1513 if (PRINT_FIELD(INSN) && sample->insn_len) {
1516 printed += fprintf(fp, " insn:");
1517 for (i = 0; i < sample->insn_len; i++)
1518 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1520 if (PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN))
1521 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1526 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1527 struct perf_event_attr *attr, FILE *fp)
1531 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1534 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1536 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1537 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1540 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1541 struct evsel *evsel,
1542 struct thread *thread,
1543 struct addr_location *al,
1544 struct addr_location *addr_al,
1545 struct machine *machine, FILE *fp)
1547 struct perf_event_attr *attr = &evsel->core.attr;
1548 unsigned int type = output_type(attr->type);
1549 bool print_srcline_last = false;
1552 if (PRINT_FIELD(CALLINDENT))
1553 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1555 /* print branch_from information */
1556 if (PRINT_FIELD(IP)) {
1557 unsigned int print_opts = output[type].print_ip_opts;
1558 struct callchain_cursor *cursor = NULL;
1560 if (symbol_conf.use_callchain && sample->callchain) {
1561 cursor = get_tls_callchain_cursor();
1562 if (thread__resolve_callchain(al->thread, cursor, evsel,
1564 scripting_max_stack))
1567 if (cursor == NULL) {
1568 printed += fprintf(fp, " ");
1569 if (print_opts & EVSEL__PRINT_SRCLINE) {
1570 print_srcline_last = true;
1571 print_opts &= ~EVSEL__PRINT_SRCLINE;
1574 printed += fprintf(fp, "\n");
1576 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1577 symbol_conf.bt_stop_list, fp);
1580 /* print branch_to information */
1581 if (PRINT_FIELD(ADDR) ||
1582 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1583 !output[type].user_set)) {
1584 printed += fprintf(fp, " => ");
1585 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1588 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1590 if (print_srcline_last)
1591 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1593 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1594 printed += fprintf(fp, "\n");
1595 if (PRINT_FIELD(SRCCODE)) {
1596 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1597 thread__srccode_state(thread));
1600 printed += printf("\n");
1609 } sample_flags[] = {
1610 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1611 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1612 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1613 {PERF_IP_FLAG_BRANCH, "jmp"},
1614 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1615 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1616 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1617 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1618 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1619 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1620 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1621 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1622 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1623 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1624 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1628 static const char *sample_flags_to_name(u32 flags)
1632 for (i = 0; sample_flags[i].name ; i++) {
1633 if (sample_flags[i].flags == flags)
1634 return sample_flags[i].name;
1640 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1642 u32 xf = PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_INTR_DISABLE |
1643 PERF_IP_FLAG_INTR_TOGGLE;
1644 const char *chars = PERF_IP_FLAG_CHARS;
1645 const size_t n = strlen(PERF_IP_FLAG_CHARS);
1646 const char *name = NULL;
1651 snprintf(xs, sizeof(xs), "(%s%s%s)",
1652 flags & PERF_IP_FLAG_IN_TX ? "x" : "",
1653 flags & PERF_IP_FLAG_INTR_DISABLE ? "D" : "",
1654 flags & PERF_IP_FLAG_INTR_TOGGLE ? "t" : "");
1656 name = sample_flags_to_name(flags & ~xf);
1658 return snprintf(str, sz, "%-15s%6s", name, xs);
1660 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1661 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_BEGIN));
1663 return snprintf(str, sz, "tr strt %-7s%6s", name, xs);
1666 if (flags & PERF_IP_FLAG_TRACE_END) {
1667 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_END));
1669 return snprintf(str, sz, "tr end %-7s%6s", name, xs);
1672 for (i = 0; i < n; i++, flags >>= 1) {
1673 if ((flags & 1) && pos < sz)
1674 str[pos++] = chars[i];
1676 for (; i < 32; i++, flags >>= 1) {
1677 if ((flags & 1) && pos < sz)
1686 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1688 char str[SAMPLE_FLAGS_BUF_SIZE];
1690 perf_sample__sprintf_flags(flags, str, sizeof(str));
1691 return fprintf(fp, " %-21s ", str);
1694 struct printer_data {
1700 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1702 void *extra, FILE *fp)
1704 unsigned char ch = (unsigned char)val;
1705 struct printer_data *printer_data = extra;
1709 case BINARY_PRINT_DATA_BEGIN:
1710 printed += fprintf(fp, "\n");
1712 case BINARY_PRINT_LINE_BEGIN:
1713 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1716 case BINARY_PRINT_ADDR:
1717 printed += fprintf(fp, " %04x:", val);
1719 case BINARY_PRINT_NUM_DATA:
1720 printed += fprintf(fp, " %02x", val);
1722 case BINARY_PRINT_NUM_PAD:
1723 printed += fprintf(fp, " ");
1725 case BINARY_PRINT_SEP:
1726 printed += fprintf(fp, " ");
1728 case BINARY_PRINT_CHAR_DATA:
1729 if (printer_data->hit_nul && ch)
1730 printer_data->is_printable = false;
1733 printed += fprintf(fp, "%c", '.');
1735 if (!printer_data->is_printable)
1739 printer_data->hit_nul = true;
1741 printer_data->is_printable = false;
1743 printed += fprintf(fp, "%c", ch);
1746 case BINARY_PRINT_CHAR_PAD:
1747 printed += fprintf(fp, " ");
1749 case BINARY_PRINT_LINE_END:
1750 printed += fprintf(fp, "\n");
1751 printer_data->line_no++;
1753 case BINARY_PRINT_DATA_END:
1761 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1763 unsigned int nr_bytes = sample->raw_size;
1764 struct printer_data printer_data = {0, false, true};
1765 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1766 sample__fprintf_bpf_output, &printer_data, fp);
1768 if (printer_data.is_printable && printer_data.hit_nul)
1769 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1774 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1776 if (len > 0 && len < spacing)
1777 return fprintf(fp, "%*s", spacing - len, "");
1782 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1784 return perf_sample__fprintf_spacing(len, 34, fp);
1787 /* If a value contains only printable ASCII characters padded with NULLs */
1788 static bool ptw_is_prt(u64 val)
1793 for (i = 0; i < sizeof(val); i++) {
1794 c = ((char *)&val)[i];
1797 if (!isprint(c) || !isascii(c))
1800 for (; i < sizeof(val); i++) {
1801 c = ((char *)&val)[i];
1808 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1810 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1811 char str[sizeof(u64) + 1] = "";
1815 if (perf_sample__bad_synth_size(sample, *data))
1818 val = le64_to_cpu(data->payload);
1819 if (ptw_is_prt(val)) {
1820 memcpy(str, &val, sizeof(val));
1821 str[sizeof(val)] = 0;
1823 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " %s ",
1824 data->ip, val, str);
1825 return len + perf_sample__fprintf_pt_spacing(len, fp);
1828 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1830 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1833 if (perf_sample__bad_synth_size(sample, *data))
1836 len = fprintf(fp, " hints: %#x extensions: %#x ",
1837 data->hints, data->extensions);
1838 return len + perf_sample__fprintf_pt_spacing(len, fp);
1841 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1843 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1846 if (perf_sample__bad_synth_size(sample, *data))
1849 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1850 data->hw, data->cstate, data->subcstate);
1851 return len + perf_sample__fprintf_pt_spacing(len, fp);
1854 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1856 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1859 if (perf_sample__bad_synth_size(sample, *data))
1862 len = fprintf(fp, " IP: %u ", data->ip);
1863 return len + perf_sample__fprintf_pt_spacing(len, fp);
1866 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1868 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1871 if (perf_sample__bad_synth_size(sample, *data))
1874 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1875 data->deepest_cstate, data->last_cstate,
1877 return len + perf_sample__fprintf_pt_spacing(len, fp);
1880 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1882 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1883 unsigned int percent, freq;
1886 if (perf_sample__bad_synth_size(sample, *data))
1889 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1890 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1891 if (data->max_nonturbo) {
1892 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1893 len += fprintf(fp, "(%3u%%) ", percent);
1895 return len + perf_sample__fprintf_pt_spacing(len, fp);
1898 static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1900 struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1903 if (perf_sample__bad_synth_size(sample, *data))
1906 len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1907 return len + perf_sample__fprintf_pt_spacing(len, fp);
1910 /* Intel PT Event Trace */
1911 static int perf_sample__fprintf_synth_evt(struct perf_sample *sample, FILE *fp)
1913 struct perf_synth_intel_evt *data = perf_sample__synth_ptr(sample);
1914 const char *cfe[32] = {NULL, "INTR", "IRET", "SMI", "RSM", "SIPI",
1915 "INIT", "VMENTRY", "VMEXIT", "VMEXIT_INTR",
1916 "SHUTDOWN", NULL, "UINTR", "UIRET"};
1917 const char *evd[64] = {"PFA", "VMXQ", "VMXR"};
1921 if (perf_sample__bad_synth_size(sample, *data))
1924 s = cfe[data->type];
1926 len = fprintf(fp, " cfe: %s IP: %d vector: %u",
1927 s, data->ip, data->vector);
1929 len = fprintf(fp, " cfe: %u IP: %d vector: %u",
1930 data->type, data->ip, data->vector);
1932 for (i = 0; i < data->evd_cnt; i++) {
1933 unsigned int et = data->evd[i].evd_type & 0x3f;
1937 len += fprintf(fp, " %s: %#" PRIx64,
1938 s, data->evd[i].payload);
1940 len += fprintf(fp, " EVD_%u: %#" PRIx64,
1941 et, data->evd[i].payload);
1944 return len + perf_sample__fprintf_pt_spacing(len, fp);
1947 static int perf_sample__fprintf_synth_iflag_chg(struct perf_sample *sample, FILE *fp)
1949 struct perf_synth_intel_iflag_chg *data = perf_sample__synth_ptr(sample);
1952 if (perf_sample__bad_synth_size(sample, *data))
1955 len = fprintf(fp, " IFLAG: %d->%d %s branch", !data->iflag, data->iflag,
1956 data->via_branch ? "via" : "non");
1957 return len + perf_sample__fprintf_pt_spacing(len, fp);
1960 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1961 struct evsel *evsel, FILE *fp)
1963 switch (evsel->core.attr.config) {
1964 case PERF_SYNTH_INTEL_PTWRITE:
1965 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1966 case PERF_SYNTH_INTEL_MWAIT:
1967 return perf_sample__fprintf_synth_mwait(sample, fp);
1968 case PERF_SYNTH_INTEL_PWRE:
1969 return perf_sample__fprintf_synth_pwre(sample, fp);
1970 case PERF_SYNTH_INTEL_EXSTOP:
1971 return perf_sample__fprintf_synth_exstop(sample, fp);
1972 case PERF_SYNTH_INTEL_PWRX:
1973 return perf_sample__fprintf_synth_pwrx(sample, fp);
1974 case PERF_SYNTH_INTEL_CBR:
1975 return perf_sample__fprintf_synth_cbr(sample, fp);
1976 case PERF_SYNTH_INTEL_PSB:
1977 return perf_sample__fprintf_synth_psb(sample, fp);
1978 case PERF_SYNTH_INTEL_EVT:
1979 return perf_sample__fprintf_synth_evt(sample, fp);
1980 case PERF_SYNTH_INTEL_IFLAG_CHG:
1981 return perf_sample__fprintf_synth_iflag_chg(sample, fp);
1989 static int evlist__max_name_len(struct evlist *evlist)
1991 struct evsel *evsel;
1994 evlist__for_each_entry(evlist, evsel) {
1995 int len = strlen(evsel__name(evsel));
1997 max = MAX(len, max);
2003 static int data_src__fprintf(u64 data_src, FILE *fp)
2005 struct mem_info mi = { .data_src.val = data_src };
2011 perf_script__meminfo_scnprintf(decode, 100, &mi);
2013 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
2017 return fprintf(fp, "%-*s", maxlen, out);
2021 struct perf_sample *sample;
2022 struct thread *thread;
2023 struct evsel *evsel;
2027 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
2028 void *ctx, const char *color,
2030 const char *unit, double val)
2032 struct metric_ctx *mctx = ctx;
2036 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2037 PERF_RECORD_SAMPLE, mctx->fp);
2038 fputs("\tmetric: ", mctx->fp);
2040 color_fprintf(mctx->fp, color, fmt, val);
2043 fprintf(mctx->fp, " %s\n", unit);
2046 static void script_new_line(struct perf_stat_config *config __maybe_unused,
2049 struct metric_ctx *mctx = ctx;
2051 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2052 PERF_RECORD_SAMPLE, mctx->fp);
2053 fputs("\tmetric: ", mctx->fp);
2056 static void perf_sample__fprint_metric(struct perf_script *script,
2057 struct thread *thread,
2058 struct evsel *evsel,
2059 struct perf_sample *sample,
2062 struct evsel *leader = evsel__leader(evsel);
2063 struct perf_stat_output_ctx ctx = {
2064 .print_metric = script_print_metric,
2065 .new_line = script_new_line,
2066 .ctx = &(struct metric_ctx) {
2072 .force_header = false,
2078 evlist__alloc_stats(&stat_config, script->session->evlist, /*alloc_raw=*/false);
2079 if (evsel_script(leader)->gnum++ == 0)
2080 perf_stat__reset_shadow_stats();
2081 val = sample->period * evsel->scale;
2082 evsel_script(evsel)->val = val;
2083 if (evsel_script(leader)->gnum == leader->core.nr_members) {
2084 for_each_group_member (ev2, leader) {
2085 perf_stat__print_shadow_stats(&stat_config, ev2,
2086 evsel_script(ev2)->val,
2091 evsel_script(leader)->gnum = 0;
2095 static bool show_event(struct perf_sample *sample,
2096 struct evsel *evsel,
2097 struct thread *thread,
2098 struct addr_location *al,
2099 struct addr_location *addr_al)
2101 int depth = thread_stack__depth(thread, sample->cpu);
2103 if (!symbol_conf.graph_function)
2106 if (thread__filter(thread)) {
2107 if (depth <= thread__filter_entry_depth(thread)) {
2108 thread__set_filter(thread, false);
2113 const char *s = symbol_conf.graph_function;
2115 const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
2121 nlen = strlen(name);
2123 unsigned len = strcspn(s, ",");
2124 if (nlen == len && !strncmp(name, s, len)) {
2125 thread__set_filter(thread, true);
2126 thread__set_filter_entry_depth(thread, depth);
2137 static void process_event(struct perf_script *script,
2138 struct perf_sample *sample, struct evsel *evsel,
2139 struct addr_location *al,
2140 struct addr_location *addr_al,
2141 struct machine *machine)
2143 struct thread *thread = al->thread;
2144 struct perf_event_attr *attr = &evsel->core.attr;
2145 unsigned int type = output_type(attr->type);
2146 struct evsel_script *es = evsel->priv;
2148 char str[PAGE_SIZE_NAME_LEN];
2149 const char *arch = perf_env__arch(machine->env);
2151 if (output[type].fields == 0)
2156 perf_sample__fprintf_start(script, sample, thread, evsel,
2157 PERF_RECORD_SAMPLE, fp);
2159 if (PRINT_FIELD(PERIOD))
2160 fprintf(fp, "%10" PRIu64 " ", sample->period);
2162 if (PRINT_FIELD(EVNAME)) {
2163 const char *evname = evsel__name(evsel);
2165 if (!script->name_width)
2166 script->name_width = evlist__max_name_len(script->session->evlist);
2168 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2172 perf_sample__fprintf_flags(sample->flags, fp);
2174 if (is_bts_event(attr)) {
2175 perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2178 #ifdef HAVE_LIBTRACEEVENT
2179 if (PRINT_FIELD(TRACE) && sample->raw_data) {
2180 event_format__fprintf(evsel->tp_format, sample->cpu,
2181 sample->raw_data, sample->raw_size, fp);
2184 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2185 perf_sample__fprintf_synth(sample, evsel, fp);
2187 if (PRINT_FIELD(ADDR))
2188 perf_sample__fprintf_addr(sample, thread, attr, fp);
2190 if (PRINT_FIELD(DATA_SRC))
2191 data_src__fprintf(sample->data_src, fp);
2193 if (PRINT_FIELD(WEIGHT))
2194 fprintf(fp, "%16" PRIu64, sample->weight);
2196 if (PRINT_FIELD(INS_LAT))
2197 fprintf(fp, "%16" PRIu16, sample->ins_lat);
2199 if (PRINT_FIELD(RETIRE_LAT))
2200 fprintf(fp, "%16" PRIu16, sample->retire_lat);
2202 if (PRINT_FIELD(CGROUP)) {
2203 const char *cgrp_name;
2204 struct cgroup *cgrp = cgroup__find(machine->env,
2207 cgrp_name = cgrp->name;
2209 cgrp_name = "unknown";
2210 fprintf(fp, " %s", cgrp_name);
2213 if (PRINT_FIELD(IP)) {
2214 struct callchain_cursor *cursor = NULL;
2216 if (script->stitch_lbr)
2217 thread__set_lbr_stitch_enable(al->thread, true);
2219 if (symbol_conf.use_callchain && sample->callchain) {
2220 cursor = get_tls_callchain_cursor();
2221 if (thread__resolve_callchain(al->thread, cursor, evsel,
2223 scripting_max_stack))
2226 fputc(cursor ? '\n' : ' ', fp);
2227 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2228 symbol_conf.bt_stop_list, fp);
2231 if (PRINT_FIELD(IREGS))
2232 perf_sample__fprintf_iregs(sample, attr, arch, fp);
2234 if (PRINT_FIELD(UREGS))
2235 perf_sample__fprintf_uregs(sample, attr, arch, fp);
2237 if (PRINT_FIELD(BRSTACK))
2238 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2239 else if (PRINT_FIELD(BRSTACKSYM))
2240 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2241 else if (PRINT_FIELD(BRSTACKOFF))
2242 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2244 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2245 perf_sample__fprintf_bpf_output(sample, fp);
2246 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2248 if (PRINT_FIELD(PHYS_ADDR))
2249 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2251 if (PRINT_FIELD(DATA_PAGE_SIZE))
2252 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2254 if (PRINT_FIELD(CODE_PAGE_SIZE))
2255 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2257 perf_sample__fprintf_ipc(sample, attr, fp);
2261 if (PRINT_FIELD(SRCCODE)) {
2262 if (map__fprintf_srccode(al->map, al->addr, stdout,
2263 thread__srccode_state(thread)))
2267 if (PRINT_FIELD(METRIC))
2268 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2274 static struct scripting_ops *scripting_ops;
2276 static void __process_stat(struct evsel *counter, u64 tstamp)
2278 int nthreads = perf_thread_map__nr(counter->core.threads);
2280 struct perf_cpu cpu;
2281 static int header_printed;
2283 if (!header_printed) {
2284 printf("%3s %8s %15s %15s %15s %15s %s\n",
2285 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2289 for (thread = 0; thread < nthreads; thread++) {
2290 perf_cpu_map__for_each_cpu(cpu, idx, evsel__cpus(counter)) {
2291 struct perf_counts_values *counts;
2293 counts = perf_counts(counter->counts, idx, thread);
2295 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2297 perf_thread_map__pid(counter->core.threads, thread),
2302 evsel__name(counter));
2307 static void process_stat(struct evsel *counter, u64 tstamp)
2309 if (scripting_ops && scripting_ops->process_stat)
2310 scripting_ops->process_stat(&stat_config, counter, tstamp);
2312 __process_stat(counter, tstamp);
2315 static void process_stat_interval(u64 tstamp)
2317 if (scripting_ops && scripting_ops->process_stat_interval)
2318 scripting_ops->process_stat_interval(tstamp);
2321 static void setup_scripting(void)
2323 #ifdef HAVE_LIBTRACEEVENT
2324 setup_perl_scripting();
2326 setup_python_scripting();
2329 static int flush_scripting(void)
2331 return scripting_ops ? scripting_ops->flush_script() : 0;
2334 static int cleanup_scripting(void)
2336 pr_debug("\nperf script stopped\n");
2338 return scripting_ops ? scripting_ops->stop_script() : 0;
2341 static bool filter_cpu(struct perf_sample *sample)
2343 if (cpu_list && sample->cpu != (u32)-1)
2344 return !test_bit(sample->cpu, cpu_bitmap);
2348 static int process_sample_event(struct perf_tool *tool,
2349 union perf_event *event,
2350 struct perf_sample *sample,
2351 struct evsel *evsel,
2352 struct machine *machine)
2354 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2355 struct addr_location al;
2356 struct addr_location addr_al;
2359 /* Set thread to NULL to indicate addr_al and al are not initialized */
2360 addr_location__init(&al);
2361 addr_location__init(&addr_al);
2363 ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2370 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2376 if (sample->time < last_timestamp) {
2377 pr_err("Samples misordered, previous: %" PRIu64
2378 " this: %" PRIu64 "\n", last_timestamp,
2382 last_timestamp = sample->time;
2386 if (filter_cpu(sample))
2389 if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2390 pr_err("problem processing %d event, skipping it.\n",
2391 event->header.type);
2399 if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2402 if (evswitch__discard(&scr->evswitch, evsel))
2405 ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2412 if (scripting_ops) {
2413 struct addr_location *addr_al_ptr = NULL;
2415 if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2416 sample_addr_correlates_sym(&evsel->core.attr)) {
2417 if (!addr_al.thread)
2418 thread__resolve(al.thread, &addr_al, sample);
2419 addr_al_ptr = &addr_al;
2421 scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2423 process_event(scr, sample, evsel, &al, &addr_al, machine);
2427 addr_location__exit(&addr_al);
2428 addr_location__exit(&al);
2432 // Used when scr->per_event_dump is not set
2433 static struct evsel_script es_stdout;
2435 static int process_attr(struct perf_tool *tool, union perf_event *event,
2436 struct evlist **pevlist)
2438 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2439 struct evlist *evlist;
2440 struct evsel *evsel, *pos;
2444 err = perf_event__process_attr(tool, event, pevlist);
2449 evsel = evlist__last(*pevlist);
2452 if (scr->per_event_dump) {
2453 evsel->priv = evsel_script__new(evsel, scr->session->data);
2456 } else { // Replicate what is done in perf_script__setup_per_event_dump()
2457 es_stdout.fp = stdout;
2458 evsel->priv = &es_stdout;
2462 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2463 evsel->core.attr.type != PERF_TYPE_SYNTH)
2466 evlist__for_each_entry(evlist, pos) {
2467 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2471 if (evsel->core.attr.sample_type) {
2472 err = evsel__check_attr(evsel, scr->session);
2478 * Check if we need to enable callchains based
2479 * on events sample_type.
2481 sample_type = evlist__combined_sample_type(evlist);
2482 callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
2484 /* Enable fields for callchain entries */
2485 if (symbol_conf.use_callchain &&
2486 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2487 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2488 (sample_type & PERF_SAMPLE_REGS_USER &&
2489 sample_type & PERF_SAMPLE_STACK_USER))) {
2490 int type = output_type(evsel->core.attr.type);
2492 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2493 output[type].fields |= PERF_OUTPUT_IP;
2494 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2495 output[type].fields |= PERF_OUTPUT_SYM;
2497 set_print_ip_opts(&evsel->core.attr);
2501 static int print_event_with_time(struct perf_tool *tool,
2502 union perf_event *event,
2503 struct perf_sample *sample,
2504 struct machine *machine,
2505 pid_t pid, pid_t tid, u64 timestamp)
2507 struct perf_script *script = container_of(tool, struct perf_script, tool);
2508 struct perf_session *session = script->session;
2509 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2510 struct thread *thread = NULL;
2512 if (evsel && !evsel->core.attr.sample_id_all) {
2514 sample->time = timestamp;
2519 if (filter_cpu(sample))
2523 thread = machine__findnew_thread(machine, pid, tid);
2526 perf_sample__fprintf_start(script, sample, thread, evsel,
2527 event->header.type, stdout);
2530 perf_event__fprintf(event, machine, stdout);
2532 thread__put(thread);
2537 static int print_event(struct perf_tool *tool, union perf_event *event,
2538 struct perf_sample *sample, struct machine *machine,
2539 pid_t pid, pid_t tid)
2541 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2544 static int process_comm_event(struct perf_tool *tool,
2545 union perf_event *event,
2546 struct perf_sample *sample,
2547 struct machine *machine)
2549 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2552 return print_event(tool, event, sample, machine, event->comm.pid,
2556 static int process_namespaces_event(struct perf_tool *tool,
2557 union perf_event *event,
2558 struct perf_sample *sample,
2559 struct machine *machine)
2561 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2564 return print_event(tool, event, sample, machine, event->namespaces.pid,
2565 event->namespaces.tid);
2568 static int process_cgroup_event(struct perf_tool *tool,
2569 union perf_event *event,
2570 struct perf_sample *sample,
2571 struct machine *machine)
2573 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2576 return print_event(tool, event, sample, machine, sample->pid,
2580 static int process_fork_event(struct perf_tool *tool,
2581 union perf_event *event,
2582 struct perf_sample *sample,
2583 struct machine *machine)
2585 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2588 return print_event_with_time(tool, event, sample, machine,
2589 event->fork.pid, event->fork.tid,
2592 static int process_exit_event(struct perf_tool *tool,
2593 union perf_event *event,
2594 struct perf_sample *sample,
2595 struct machine *machine)
2597 /* Print before 'exit' deletes anything */
2598 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2599 event->fork.tid, event->fork.time))
2602 return perf_event__process_exit(tool, event, sample, machine);
2605 static int process_mmap_event(struct perf_tool *tool,
2606 union perf_event *event,
2607 struct perf_sample *sample,
2608 struct machine *machine)
2610 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2613 return print_event(tool, event, sample, machine, event->mmap.pid,
2617 static int process_mmap2_event(struct perf_tool *tool,
2618 union perf_event *event,
2619 struct perf_sample *sample,
2620 struct machine *machine)
2622 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2625 return print_event(tool, event, sample, machine, event->mmap2.pid,
2629 static int process_switch_event(struct perf_tool *tool,
2630 union perf_event *event,
2631 struct perf_sample *sample,
2632 struct machine *machine)
2634 struct perf_script *script = container_of(tool, struct perf_script, tool);
2636 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2639 if (scripting_ops && scripting_ops->process_switch && !filter_cpu(sample))
2640 scripting_ops->process_switch(event, sample, machine);
2642 if (!script->show_switch_events)
2645 return print_event(tool, event, sample, machine, sample->pid,
2649 static int process_auxtrace_error(struct perf_session *session,
2650 union perf_event *event)
2652 if (scripting_ops && scripting_ops->process_auxtrace_error) {
2653 scripting_ops->process_auxtrace_error(session, event);
2657 return perf_event__process_auxtrace_error(session, event);
2661 process_lost_event(struct perf_tool *tool,
2662 union perf_event *event,
2663 struct perf_sample *sample,
2664 struct machine *machine)
2666 return print_event(tool, event, sample, machine, sample->pid,
2671 process_throttle_event(struct perf_tool *tool __maybe_unused,
2672 union perf_event *event,
2673 struct perf_sample *sample,
2674 struct machine *machine)
2676 if (scripting_ops && scripting_ops->process_throttle)
2677 scripting_ops->process_throttle(event, sample, machine);
2682 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2683 union perf_event *event,
2684 struct ordered_events *oe __maybe_unused)
2687 perf_event__fprintf(event, NULL, stdout);
2692 process_bpf_events(struct perf_tool *tool __maybe_unused,
2693 union perf_event *event,
2694 struct perf_sample *sample,
2695 struct machine *machine)
2697 if (machine__process_ksymbol(machine, event, sample) < 0)
2700 return print_event(tool, event, sample, machine, sample->pid,
2704 static int process_text_poke_events(struct perf_tool *tool,
2705 union perf_event *event,
2706 struct perf_sample *sample,
2707 struct machine *machine)
2709 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2712 return print_event(tool, event, sample, machine, sample->pid,
2716 static void sig_handler(int sig __maybe_unused)
2721 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2723 struct evlist *evlist = script->session->evlist;
2724 struct evsel *evsel;
2726 evlist__for_each_entry(evlist, evsel) {
2729 evsel_script__delete(evsel->priv);
2734 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2736 struct evsel *evsel;
2738 evlist__for_each_entry(script->session->evlist, evsel) {
2740 * Already setup? I.e. we may be called twice in cases like
2741 * Intel PT, one for the intel_pt// and dummy events, then
2742 * for the evsels synthesized from the auxtrace info.
2744 * Ses perf_script__process_auxtrace_info.
2746 if (evsel->priv != NULL)
2749 evsel->priv = evsel_script__new(evsel, script->session->data);
2750 if (evsel->priv == NULL)
2751 goto out_err_fclose;
2757 perf_script__fclose_per_event_dump(script);
2761 static int perf_script__setup_per_event_dump(struct perf_script *script)
2763 struct evsel *evsel;
2765 if (script->per_event_dump)
2766 return perf_script__fopen_per_event_dump(script);
2768 es_stdout.fp = stdout;
2770 evlist__for_each_entry(script->session->evlist, evsel)
2771 evsel->priv = &es_stdout;
2776 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2778 struct evsel *evsel;
2780 evlist__for_each_entry(script->session->evlist, evsel) {
2781 struct evsel_script *es = evsel->priv;
2783 evsel_script__fprintf(es, stdout);
2784 evsel_script__delete(es);
2789 static void perf_script__exit(struct perf_script *script)
2791 perf_thread_map__put(script->threads);
2792 perf_cpu_map__put(script->cpus);
2795 static int __cmd_script(struct perf_script *script)
2799 signal(SIGINT, sig_handler);
2801 /* override event processing functions */
2802 if (script->show_task_events) {
2803 script->tool.comm = process_comm_event;
2804 script->tool.fork = process_fork_event;
2805 script->tool.exit = process_exit_event;
2807 if (script->show_mmap_events) {
2808 script->tool.mmap = process_mmap_event;
2809 script->tool.mmap2 = process_mmap2_event;
2811 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2812 script->tool.context_switch = process_switch_event;
2813 if (scripting_ops && scripting_ops->process_auxtrace_error)
2814 script->tool.auxtrace_error = process_auxtrace_error;
2815 if (script->show_namespace_events)
2816 script->tool.namespaces = process_namespaces_event;
2817 if (script->show_cgroup_events)
2818 script->tool.cgroup = process_cgroup_event;
2819 if (script->show_lost_events)
2820 script->tool.lost = process_lost_event;
2821 if (script->show_round_events) {
2822 script->tool.ordered_events = false;
2823 script->tool.finished_round = process_finished_round_event;
2825 if (script->show_bpf_events) {
2826 script->tool.ksymbol = process_bpf_events;
2827 script->tool.bpf = process_bpf_events;
2829 if (script->show_text_poke_events) {
2830 script->tool.ksymbol = process_bpf_events;
2831 script->tool.text_poke = process_text_poke_events;
2834 if (perf_script__setup_per_event_dump(script)) {
2835 pr_err("Couldn't create the per event dump files\n");
2839 ret = perf_session__process_events(script->session);
2841 if (script->per_event_dump)
2842 perf_script__exit_per_event_dump_stats(script);
2845 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2850 struct script_spec {
2851 struct list_head node;
2852 struct scripting_ops *ops;
2856 static LIST_HEAD(script_specs);
2858 static struct script_spec *script_spec__new(const char *spec,
2859 struct scripting_ops *ops)
2861 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2864 strcpy(s->spec, spec);
2871 static void script_spec__add(struct script_spec *s)
2873 list_add_tail(&s->node, &script_specs);
2876 static struct script_spec *script_spec__find(const char *spec)
2878 struct script_spec *s;
2880 list_for_each_entry(s, &script_specs, node)
2881 if (strcasecmp(s->spec, spec) == 0)
2886 int script_spec_register(const char *spec, struct scripting_ops *ops)
2888 struct script_spec *s;
2890 s = script_spec__find(spec);
2894 s = script_spec__new(spec, ops);
2898 script_spec__add(s);
2903 static struct scripting_ops *script_spec__lookup(const char *spec)
2905 struct script_spec *s = script_spec__find(spec);
2912 static void list_available_languages(void)
2914 struct script_spec *s;
2916 fprintf(stderr, "\n");
2917 fprintf(stderr, "Scripting language extensions (used in "
2918 "perf script -s [spec:]script.[spec]):\n\n");
2920 list_for_each_entry(s, &script_specs, node)
2921 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2923 fprintf(stderr, "\n");
2926 /* Find script file relative to current directory or exec path */
2927 static char *find_script(const char *script)
2929 char path[PATH_MAX];
2931 if (!scripting_ops) {
2932 const char *ext = strrchr(script, '.');
2937 scripting_ops = script_spec__lookup(++ext);
2942 if (access(script, R_OK)) {
2943 char *exec_path = get_argv_exec_path();
2947 snprintf(path, sizeof(path), "%s/scripts/%s/%s",
2948 exec_path, scripting_ops->dirname, script);
2951 if (access(script, R_OK))
2954 return strdup(script);
2957 static int parse_scriptname(const struct option *opt __maybe_unused,
2958 const char *str, int unset __maybe_unused)
2960 char spec[PATH_MAX];
2961 const char *script, *ext;
2964 if (strcmp(str, "lang") == 0) {
2965 list_available_languages();
2969 script = strchr(str, ':');
2972 if (len >= PATH_MAX) {
2973 fprintf(stderr, "invalid language specifier");
2976 strncpy(spec, str, len);
2978 scripting_ops = script_spec__lookup(spec);
2979 if (!scripting_ops) {
2980 fprintf(stderr, "invalid language specifier");
2986 ext = strrchr(script, '.');
2988 fprintf(stderr, "invalid script extension");
2991 scripting_ops = script_spec__lookup(++ext);
2992 if (!scripting_ops) {
2993 fprintf(stderr, "invalid script extension");
2998 script_name = find_script(script);
3000 script_name = strdup(script);
3005 static int parse_output_fields(const struct option *opt __maybe_unused,
3006 const char *arg, int unset __maybe_unused)
3008 char *tok, *strtok_saveptr = NULL;
3009 int i, imax = ARRAY_SIZE(all_output_options);
3012 char *str = strdup(arg);
3014 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
3019 /* first word can state for which event type the user is specifying
3020 * the fields. If no type exists, the specified fields apply to all
3021 * event types found in the file minus the invalid fields for a type.
3023 tok = strchr(str, ':');
3027 if (!strcmp(str, "hw"))
3028 type = PERF_TYPE_HARDWARE;
3029 else if (!strcmp(str, "sw"))
3030 type = PERF_TYPE_SOFTWARE;
3031 else if (!strcmp(str, "trace"))
3032 type = PERF_TYPE_TRACEPOINT;
3033 else if (!strcmp(str, "raw"))
3034 type = PERF_TYPE_RAW;
3035 else if (!strcmp(str, "break"))
3036 type = PERF_TYPE_BREAKPOINT;
3037 else if (!strcmp(str, "synth"))
3038 type = OUTPUT_TYPE_SYNTH;
3040 fprintf(stderr, "Invalid event type in field string.\n");
3045 if (output[type].user_set)
3046 pr_warning("Overriding previous field request for %s events.\n",
3049 /* Don't override defaults for +- */
3050 if (strchr(tok, '+') || strchr(tok, '-'))
3053 output[type].fields = 0;
3054 output[type].user_set = true;
3055 output[type].wildcard_set = false;
3059 if (strlen(str) == 0) {
3061 "Cannot set fields to 'none' for all event types.\n");
3066 /* Don't override defaults for +- */
3067 if (strchr(str, '+') || strchr(str, '-'))
3070 if (output_set_by_user())
3071 pr_warning("Overriding previous field request for all events.\n");
3073 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3074 output[j].fields = 0;
3075 output[j].user_set = true;
3076 output[j].wildcard_set = true;
3081 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
3087 } else if (*tok == '-') {
3093 if (change != SET && change != DEFAULT)
3098 for (i = 0; i < imax; ++i) {
3099 if (strcmp(tok, all_output_options[i].str) == 0)
3102 if (i == imax && strcmp(tok, "flags") == 0) {
3103 print_flags = change != REMOVE;
3107 fprintf(stderr, "Invalid field requested.\n");
3113 /* add user option to all events types for
3116 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3117 if (output[j].invalid_fields & all_output_options[i].field) {
3118 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
3119 all_output_options[i].str, event_type(j));
3121 if (change == REMOVE) {
3122 output[j].fields &= ~all_output_options[i].field;
3123 output[j].user_set_fields &= ~all_output_options[i].field;
3124 output[j].user_unset_fields |= all_output_options[i].field;
3126 output[j].fields |= all_output_options[i].field;
3127 output[j].user_set_fields |= all_output_options[i].field;
3128 output[j].user_unset_fields &= ~all_output_options[i].field;
3130 output[j].user_set = true;
3131 output[j].wildcard_set = true;
3135 if (output[type].invalid_fields & all_output_options[i].field) {
3136 fprintf(stderr, "\'%s\' not valid for %s events.\n",
3137 all_output_options[i].str, event_type(type));
3142 if (change == REMOVE)
3143 output[type].fields &= ~all_output_options[i].field;
3145 output[type].fields |= all_output_options[i].field;
3146 output[type].user_set = true;
3147 output[type].wildcard_set = true;
3152 if (output[type].fields == 0) {
3153 pr_debug("No fields requested for %s type. "
3154 "Events will not be displayed.\n", event_type(type));
3160 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
3167 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
3168 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
3169 if ((lang_dirent->d_type == DT_DIR || \
3170 (lang_dirent->d_type == DT_UNKNOWN && \
3171 is_directory(scripts_path, lang_dirent))) && \
3172 (strcmp(lang_dirent->d_name, ".")) && \
3173 (strcmp(lang_dirent->d_name, "..")))
3175 #define for_each_script(lang_path, lang_dir, script_dirent) \
3176 while ((script_dirent = readdir(lang_dir)) != NULL) \
3177 if (script_dirent->d_type != DT_DIR && \
3178 (script_dirent->d_type != DT_UNKNOWN || \
3179 !is_directory(lang_path, script_dirent)))
3182 #define RECORD_SUFFIX "-record"
3183 #define REPORT_SUFFIX "-report"
3185 struct script_desc {
3186 struct list_head node;
3192 static LIST_HEAD(script_descs);
3194 static struct script_desc *script_desc__new(const char *name)
3196 struct script_desc *s = zalloc(sizeof(*s));
3198 if (s != NULL && name)
3199 s->name = strdup(name);
3204 static void script_desc__delete(struct script_desc *s)
3207 zfree(&s->half_liner);
3212 static void script_desc__add(struct script_desc *s)
3214 list_add_tail(&s->node, &script_descs);
3217 static struct script_desc *script_desc__find(const char *name)
3219 struct script_desc *s;
3221 list_for_each_entry(s, &script_descs, node)
3222 if (strcasecmp(s->name, name) == 0)
3227 static struct script_desc *script_desc__findnew(const char *name)
3229 struct script_desc *s = script_desc__find(name);
3234 s = script_desc__new(name);
3238 script_desc__add(s);
3243 static const char *ends_with(const char *str, const char *suffix)
3245 size_t suffix_len = strlen(suffix);
3246 const char *p = str;
3248 if (strlen(str) > suffix_len) {
3249 p = str + strlen(str) - suffix_len;
3250 if (!strncmp(p, suffix, suffix_len))
3257 static int read_script_info(struct script_desc *desc, const char *filename)
3259 char line[BUFSIZ], *p;
3262 fp = fopen(filename, "r");
3266 while (fgets(line, sizeof(line), fp)) {
3267 p = skip_spaces(line);
3273 if (strlen(p) && *p == '!')
3277 if (strlen(p) && p[strlen(p) - 1] == '\n')
3278 p[strlen(p) - 1] = '\0';
3280 if (!strncmp(p, "description:", strlen("description:"))) {
3281 p += strlen("description:");
3282 desc->half_liner = strdup(skip_spaces(p));
3286 if (!strncmp(p, "args:", strlen("args:"))) {
3287 p += strlen("args:");
3288 desc->args = strdup(skip_spaces(p));
3298 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3300 char *script_root, *str;
3302 script_root = strdup(script_dirent->d_name);
3306 str = (char *)ends_with(script_root, suffix);
3316 static int list_available_scripts(const struct option *opt __maybe_unused,
3317 const char *s __maybe_unused,
3318 int unset __maybe_unused)
3320 struct dirent *script_dirent, *lang_dirent;
3321 char *buf, *scripts_path, *script_path, *lang_path, *first_half;
3322 DIR *scripts_dir, *lang_dir;
3323 struct script_desc *desc;
3326 buf = malloc(3 * MAXPATHLEN + BUFSIZ);
3328 pr_err("malloc failed\n");
3332 script_path = buf + MAXPATHLEN;
3333 lang_path = buf + 2 * MAXPATHLEN;
3334 first_half = buf + 3 * MAXPATHLEN;
3336 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3338 scripts_dir = opendir(scripts_path);
3341 "open(%s) failed.\n"
3342 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3348 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3349 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3350 lang_dirent->d_name);
3351 lang_dir = opendir(lang_path);
3355 for_each_script(lang_path, lang_dir, script_dirent) {
3356 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3358 desc = script_desc__findnew(script_root);
3359 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3360 lang_path, script_dirent->d_name);
3361 read_script_info(desc, script_path);
3367 fprintf(stdout, "List of available trace scripts:\n");
3368 list_for_each_entry(desc, &script_descs, node) {
3369 sprintf(first_half, "%s %s", desc->name,
3370 desc->args ? desc->args : "");
3371 fprintf(stdout, " %-36s %s\n", first_half,
3372 desc->half_liner ? desc->half_liner : "");
3379 static int add_dlarg(const struct option *opt __maybe_unused,
3380 const char *s, int unset __maybe_unused)
3382 char *arg = strdup(s);
3388 a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
3395 dlargv[dlargc++] = arg;
3400 static void free_dlarg(void)
3403 free(dlargv[dlargc]);
3408 * Some scripts specify the required events in their "xxx-record" file,
3409 * this function will check if the events in perf.data match those
3410 * mentioned in the "xxx-record".
3412 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3413 * which is covered well now. And new parsing code should be added to
3414 * cover the future complex formats like event groups etc.
3416 static int check_ev_match(char *dir_name, char *scriptname,
3417 struct perf_session *session)
3419 char filename[MAXPATHLEN], evname[128];
3420 char line[BUFSIZ], *p;
3425 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3427 fp = fopen(filename, "r");
3431 while (fgets(line, sizeof(line), fp)) {
3432 p = skip_spaces(line);
3437 p = strstr(p, "-e");
3443 len = strcspn(p, " \t");
3447 snprintf(evname, len + 1, "%s", p);
3450 evlist__for_each_entry(session->evlist, pos) {
3451 if (!strcmp(evsel__name(pos), evname)) {
3469 * Return -1 if none is found, otherwise the actual scripts number.
3471 * Currently the only user of this function is the script browser, which
3472 * will list all statically runnable scripts, select one, execute it and
3473 * show the output in a perf browser.
3475 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3478 struct dirent *script_dirent, *lang_dirent;
3479 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3480 DIR *scripts_dir, *lang_dir;
3481 struct perf_session *session;
3482 struct perf_data data = {
3484 .mode = PERF_DATA_MODE_READ,
3489 session = perf_session__new(&data, NULL);
3490 if (IS_ERR(session))
3491 return PTR_ERR(session);
3493 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3495 scripts_dir = opendir(scripts_path);
3497 perf_session__delete(session);
3501 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3502 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3503 lang_dirent->d_name);
3504 #ifndef HAVE_LIBPERL_SUPPORT
3505 if (strstr(lang_path, "perl"))
3508 #ifndef HAVE_LIBPYTHON_SUPPORT
3509 if (strstr(lang_path, "python"))
3513 lang_dir = opendir(lang_path);
3517 for_each_script(lang_path, lang_dir, script_dirent) {
3518 /* Skip those real time scripts: xxxtop.p[yl] */
3519 if (strstr(script_dirent->d_name, "top."))
3523 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3525 script_dirent->d_name);
3526 temp = strchr(script_dirent->d_name, '.');
3527 snprintf(scripts_array[i],
3528 (temp - script_dirent->d_name) + 1,
3529 "%s", script_dirent->d_name);
3531 if (check_ev_match(lang_path,
3532 scripts_array[i], session))
3540 closedir(scripts_dir);
3541 perf_session__delete(session);
3545 static char *get_script_path(const char *script_root, const char *suffix)
3547 struct dirent *script_dirent, *lang_dirent;
3548 char scripts_path[MAXPATHLEN];
3549 char script_path[MAXPATHLEN];
3550 DIR *scripts_dir, *lang_dir;
3551 char lang_path[MAXPATHLEN];
3552 char *__script_root;
3554 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3556 scripts_dir = opendir(scripts_path);
3560 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3561 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3562 lang_dirent->d_name);
3563 lang_dir = opendir(lang_path);
3567 for_each_script(lang_path, lang_dir, script_dirent) {
3568 __script_root = get_script_root(script_dirent, suffix);
3569 if (__script_root && !strcmp(script_root, __script_root)) {
3570 free(__script_root);
3571 closedir(scripts_dir);
3572 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3573 lang_path, script_dirent->d_name);
3575 return strdup(script_path);
3577 free(__script_root);
3581 closedir(scripts_dir);
3586 static bool is_top_script(const char *script_path)
3588 return ends_with(script_path, "top") != NULL;
3591 static int has_required_arg(char *script_path)
3593 struct script_desc *desc;
3597 desc = script_desc__new(NULL);
3599 if (read_script_info(desc, script_path))
3605 for (p = desc->args; *p; p++)
3609 script_desc__delete(desc);
3614 static int have_cmd(int argc, const char **argv)
3616 char **__argv = malloc(sizeof(const char *) * argc);
3619 pr_err("malloc failed\n");
3623 memcpy(__argv, argv, sizeof(const char *) * argc);
3624 argc = parse_options(argc, (const char **)__argv, record_options,
3625 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3628 system_wide = (argc == 0);
3633 static void script__setup_sample_type(struct perf_script *script)
3635 struct perf_session *session = script->session;
3636 u64 sample_type = evlist__combined_sample_type(session->evlist);
3638 callchain_param_setup(sample_type, perf_env__arch(session->machines.host.env));
3640 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3641 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3642 "Please apply --call-graph lbr when recording.\n");
3643 script->stitch_lbr = false;
3647 static int process_stat_round_event(struct perf_session *session,
3648 union perf_event *event)
3650 struct perf_record_stat_round *round = &event->stat_round;
3651 struct evsel *counter;
3653 evlist__for_each_entry(session->evlist, counter) {
3654 perf_stat_process_counter(&stat_config, counter);
3655 process_stat(counter, round->time);
3658 process_stat_interval(round->time);
3662 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3663 union perf_event *event)
3665 perf_event__read_stat_config(&stat_config, &event->stat_config);
3668 * Aggregation modes are not used since post-processing scripts are
3669 * supposed to take care of such requirements
3671 stat_config.aggr_mode = AGGR_NONE;
3676 static int set_maps(struct perf_script *script)
3678 struct evlist *evlist = script->session->evlist;
3680 if (!script->cpus || !script->threads)
3683 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3686 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3688 if (evlist__alloc_stats(&stat_config, evlist, /*alloc_raw=*/true))
3691 script->allocated = true;
3696 int process_thread_map_event(struct perf_session *session,
3697 union perf_event *event)
3699 struct perf_tool *tool = session->tool;
3700 struct perf_script *script = container_of(tool, struct perf_script, tool);
3703 perf_event__fprintf_thread_map(event, stdout);
3705 if (script->threads) {
3706 pr_warning("Extra thread map event, ignoring.\n");
3710 script->threads = thread_map__new_event(&event->thread_map);
3711 if (!script->threads)
3714 return set_maps(script);
3718 int process_cpu_map_event(struct perf_session *session,
3719 union perf_event *event)
3721 struct perf_tool *tool = session->tool;
3722 struct perf_script *script = container_of(tool, struct perf_script, tool);
3725 perf_event__fprintf_cpu_map(event, stdout);
3728 pr_warning("Extra cpu map event, ignoring.\n");
3732 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3736 return set_maps(script);
3739 static int process_feature_event(struct perf_session *session,
3740 union perf_event *event)
3742 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3743 return perf_event__process_feature(session, event);
3747 #ifdef HAVE_AUXTRACE_SUPPORT
3748 static int perf_script__process_auxtrace_info(struct perf_session *session,
3749 union perf_event *event)
3751 struct perf_tool *tool = session->tool;
3753 int ret = perf_event__process_auxtrace_info(session, event);
3756 struct perf_script *script = container_of(tool, struct perf_script, tool);
3758 ret = perf_script__setup_per_event_dump(script);
3764 #define perf_script__process_auxtrace_info 0
3767 static int parse_insn_trace(const struct option *opt __maybe_unused,
3768 const char *str __maybe_unused,
3769 int unset __maybe_unused)
3771 parse_output_fields(NULL, "+insn,-event,-period", 0);
3772 itrace_parse_synth_opts(opt, "i0ns", 0);
3773 symbol_conf.nanosecs = true;
3777 static int parse_xed(const struct option *opt __maybe_unused,
3778 const char *str __maybe_unused,
3779 int unset __maybe_unused)
3782 force_pager("xed -F insn: -A -64 | less");
3784 force_pager("xed -F insn: -A -64");
3788 static int parse_call_trace(const struct option *opt __maybe_unused,
3789 const char *str __maybe_unused,
3790 int unset __maybe_unused)
3792 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3793 itrace_parse_synth_opts(opt, "cewp", 0);
3794 symbol_conf.nanosecs = true;
3795 symbol_conf.pad_output_len_dso = 50;
3799 static int parse_callret_trace(const struct option *opt __maybe_unused,
3800 const char *str __maybe_unused,
3801 int unset __maybe_unused)
3803 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3804 itrace_parse_synth_opts(opt, "crewp", 0);
3805 symbol_conf.nanosecs = true;
3809 int cmd_script(int argc, const char **argv)
3811 bool show_full_info = false;
3812 bool header = false;
3813 bool header_only = false;
3814 bool script_started = false;
3815 bool unsorted_dump = false;
3816 char *rec_script_path = NULL;
3817 char *rep_script_path = NULL;
3818 struct perf_session *session;
3819 struct itrace_synth_opts itrace_synth_opts = {
3821 .default_no_sample = true,
3824 char *script_path = NULL;
3825 const char *dlfilter_file = NULL;
3826 const char **__argv;
3828 struct perf_script script = {
3830 .sample = process_sample_event,
3831 .mmap = perf_event__process_mmap,
3832 .mmap2 = perf_event__process_mmap2,
3833 .comm = perf_event__process_comm,
3834 .namespaces = perf_event__process_namespaces,
3835 .cgroup = perf_event__process_cgroup,
3836 .exit = perf_event__process_exit,
3837 .fork = perf_event__process_fork,
3838 .attr = process_attr,
3839 .event_update = perf_event__process_event_update,
3840 #ifdef HAVE_LIBTRACEEVENT
3841 .tracing_data = perf_event__process_tracing_data,
3843 .feature = process_feature_event,
3844 .build_id = perf_event__process_build_id,
3845 .id_index = perf_event__process_id_index,
3846 .auxtrace_info = perf_script__process_auxtrace_info,
3847 .auxtrace = perf_event__process_auxtrace,
3848 .auxtrace_error = perf_event__process_auxtrace_error,
3849 .stat = perf_event__process_stat_event,
3850 .stat_round = process_stat_round_event,
3851 .stat_config = process_stat_config_event,
3852 .thread_map = process_thread_map_event,
3853 .cpu_map = process_cpu_map_event,
3854 .throttle = process_throttle_event,
3855 .unthrottle = process_throttle_event,
3856 .ordered_events = true,
3857 .ordering_requires_timestamps = true,
3860 struct perf_data data = {
3861 .mode = PERF_DATA_MODE_READ,
3863 const struct option options[] = {
3864 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3865 "dump raw trace in ASCII"),
3866 OPT_BOOLEAN(0, "dump-unsorted-raw-trace", &unsorted_dump,
3867 "dump unsorted raw trace in ASCII"),
3868 OPT_INCR('v', "verbose", &verbose,
3869 "be more verbose (show symbol address, etc)"),
3870 OPT_BOOLEAN('L', "Latency", &latency_format,
3871 "show latency attributes (irqs/preemption disabled, etc)"),
3872 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3873 list_available_scripts),
3874 OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
3875 list_available_dlfilters),
3876 OPT_CALLBACK('s', "script", NULL, "name",
3877 "script file name (lang:script name, script name, or *)",
3879 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3880 "generate perf-script.xx script in specified language"),
3881 OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3882 OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
3884 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3885 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3886 "do various checks like samples ordering and lost events"),
3887 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3888 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3889 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3890 "file", "vmlinux pathname"),
3891 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3892 "file", "kallsyms pathname"),
3893 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3894 "When printing symbols do not display call chain"),
3895 OPT_CALLBACK(0, "symfs", NULL, "directory",
3896 "Look for files with symbols relative to this directory",
3897 symbol__config_symfs),
3898 OPT_CALLBACK('F', "fields", NULL, "str",
3899 "comma separated output fields prepend with 'type:'. "
3900 "+field to add and -field to remove."
3901 "Valid types: hw,sw,trace,raw,synth. "
3902 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,dsoff"
3903 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3904 "brstacksym,flags,data_src,weight,bpf-output,brstackinsn,"
3905 "brstackinsnlen,brstackoff,callindent,insn,insnlen,synth,"
3906 "phys_addr,metric,misc,srccode,ipc,tod,data_page_size,"
3907 "code_page_size,ins_lat,machine_pid,vcpu,cgroup,retire_lat",
3908 parse_output_fields),
3909 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3910 "system-wide collection from all CPUs"),
3911 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3912 "only consider symbols in these DSOs"),
3913 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3914 "only consider these symbols"),
3915 OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3916 "Use with -S to list traced records within address range"),
3917 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3918 "Decode instructions from itrace", parse_insn_trace),
3919 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3920 "Run xed disassembler on output", parse_xed),
3921 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3922 "Decode calls from itrace", parse_call_trace),
3923 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3924 "Decode calls and returns from itrace", parse_callret_trace),
3925 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3926 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3927 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3928 "Stop display of callgraph at these symbols"),
3929 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3930 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3931 "only display events for these comms"),
3932 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3933 "only consider symbols in these pids"),
3934 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3935 "only consider symbols in these tids"),
3936 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3937 "Set the maximum stack depth when parsing the callchain, "
3938 "anything beyond the specified depth will be ignored. "
3939 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3940 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3941 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3942 OPT_BOOLEAN('I', "show-info", &show_full_info,
3943 "display extended information from perf.data file"),
3944 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3945 "Show the path of [kernel.kallsyms]"),
3946 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3947 "Show the fork/comm/exit events"),
3948 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3949 "Show the mmap events"),
3950 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3951 "Show context switch events (if recorded)"),
3952 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3953 "Show namespace events (if recorded)"),
3954 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3955 "Show cgroup events (if recorded)"),
3956 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3957 "Show lost events (if recorded)"),
3958 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3959 "Show round events (if recorded)"),
3960 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3961 "Show bpf related events (if recorded)"),
3962 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3963 "Show text poke related events (if recorded)"),
3964 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3965 "Dump trace output to files named by the monitored events"),
3966 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3967 OPT_INTEGER(0, "max-blocks", &max_blocks,
3968 "Maximum number of code blocks to dump with brstackinsn"),
3969 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3970 "Use 9 decimal places when displaying time"),
3971 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3972 "Instruction Tracing options\n" ITRACE_HELP,
3973 itrace_parse_synth_opts),
3974 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3975 "Show full source file name path for source lines"),
3976 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3977 "Enable symbol demangling"),
3978 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3979 "Enable kernel symbol demangling"),
3980 OPT_STRING(0, "time", &script.time_str, "str",
3981 "Time span of interest (start,stop)"),
3982 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3983 "Show inline function"),
3984 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3985 "guest mount directory under which every guest os"
3986 " instance has a subdir"),
3987 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3988 "file", "file saving guest os vmlinux"),
3989 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3990 "file", "file saving guest os /proc/kallsyms"),
3991 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3992 "file", "file saving guest os /proc/modules"),
3993 OPT_BOOLEAN(0, "guest-code", &symbol_conf.guest_code,
3994 "Guest code can be found in hypervisor process"),
3995 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3996 "Enable LBR callgraph stitching approach"),
3997 OPTS_EVSWITCH(&script.evswitch),
4000 const char * const script_subcommands[] = { "record", "report", NULL };
4001 const char *script_usage[] = {
4002 "perf script [<options>]",
4003 "perf script [<options>] record <script> [<record-options>] <command>",
4004 "perf script [<options>] report <script> [script-args]",
4005 "perf script [<options>] <script> [<record-options>] <command>",
4006 "perf script [<options>] <top-script> [script-args]",
4010 perf_set_singlethreaded();
4014 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
4015 PARSE_OPT_STOP_AT_NON_OPTION);
4017 if (symbol_conf.guestmount ||
4018 symbol_conf.default_guest_vmlinux_name ||
4019 symbol_conf.default_guest_kallsyms ||
4020 symbol_conf.default_guest_modules ||
4021 symbol_conf.guest_code) {
4023 * Enable guest sample processing.
4028 data.path = input_name;
4029 data.force = symbol_conf.force;
4031 if (unsorted_dump) {
4033 script.tool.ordered_events = false;
4036 if (symbol__validate_sym_arguments())
4039 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
4040 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
4041 if (!rec_script_path)
4042 return cmd_record(argc, argv);
4045 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("report", argv[0])) {
4046 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
4047 if (!rep_script_path) {
4049 "Please specify a valid report script"
4050 "(see 'perf script -l' for listing)\n");
4055 if (reltime && deltatime) {
4057 "reltime and deltatime - the two don't get along well. "
4058 "Please limit to --reltime or --deltatime.\n");
4062 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
4063 itrace_synth_opts.callchain_sz > scripting_max_stack)
4064 scripting_max_stack = itrace_synth_opts.callchain_sz;
4066 /* make sure PERF_EXEC_PATH is set for scripts */
4067 set_argv_exec_path(get_argv_exec_path());
4069 if (argc && !script_name && !rec_script_path && !rep_script_path) {
4074 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
4075 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
4077 if (!rec_script_path && !rep_script_path) {
4078 script_name = find_script(argv[0]);
4084 usage_with_options_msg(script_usage, options,
4085 "Couldn't find script `%s'\n\n See perf"
4086 " script -l for available scripts.\n", argv[0]);
4089 if (is_top_script(argv[0])) {
4090 rep_args = argc - 1;
4094 rep_args = has_required_arg(rep_script_path);
4095 rec_args = (argc - 1) - rep_args;
4097 usage_with_options_msg(script_usage, options,
4098 "`%s' script requires options."
4099 "\n\n See perf script -l for available "
4100 "scripts and options.\n", argv[0]);
4104 if (pipe(live_pipe) < 0) {
4105 perror("failed to create pipe");
4111 perror("failed to fork");
4118 dup2(live_pipe[1], 1);
4119 close(live_pipe[0]);
4121 if (is_top_script(argv[0])) {
4123 } else if (!system_wide) {
4124 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
4130 __argv = malloc((argc + 6) * sizeof(const char *));
4132 pr_err("malloc failed\n");
4137 __argv[j++] = "/bin/sh";
4138 __argv[j++] = rec_script_path;
4144 for (i = rep_args + 1; i < argc; i++)
4145 __argv[j++] = argv[i];
4148 execvp("/bin/sh", (char **)__argv);
4153 dup2(live_pipe[0], 0);
4154 close(live_pipe[1]);
4156 __argv = malloc((argc + 4) * sizeof(const char *));
4158 pr_err("malloc failed\n");
4164 __argv[j++] = "/bin/sh";
4165 __argv[j++] = rep_script_path;
4166 for (i = 1; i < rep_args + 1; i++)
4167 __argv[j++] = argv[i];
4172 execvp("/bin/sh", (char **)__argv);
4177 if (rec_script_path)
4178 script_path = rec_script_path;
4179 if (rep_script_path)
4180 script_path = rep_script_path;
4185 if (!rec_script_path)
4186 system_wide = false;
4187 else if (!system_wide) {
4188 if (have_cmd(argc - 1, &argv[1]) != 0) {
4194 __argv = malloc((argc + 2) * sizeof(const char *));
4196 pr_err("malloc failed\n");
4201 __argv[j++] = "/bin/sh";
4202 __argv[j++] = script_path;
4205 for (i = 2; i < argc; i++)
4206 __argv[j++] = argv[i];
4209 execvp("/bin/sh", (char **)__argv);
4214 if (dlfilter_file) {
4215 dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4225 session = perf_session__new(&data, &script.tool);
4226 if (IS_ERR(session))
4227 return PTR_ERR(session);
4229 if (header || header_only) {
4230 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4231 perf_session__fprintf_info(session, stdout, show_full_info);
4236 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4238 if (symbol__init(&session->header.env) < 0)
4242 if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4244 } else if (session->header.env.arch) {
4245 if (!strcmp(uts.machine, session->header.env.arch))
4247 else if (!strcmp(uts.machine, "x86_64") &&
4248 !strcmp(session->header.env.arch, "i386"))
4252 script.session = session;
4253 script__setup_sample_type(&script);
4255 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
4256 symbol_conf.graph_function)
4257 itrace_synth_opts.thread_stack = true;
4259 session->itrace_synth_opts = &itrace_synth_opts;
4262 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4265 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4269 symbol_conf.use_callchain = true;
4271 symbol_conf.use_callchain = false;
4273 #ifdef HAVE_LIBTRACEEVENT
4274 if (session->tevent.pevent &&
4275 tep_set_function_resolver(session->tevent.pevent,
4276 machine__resolve_kernel_addr,
4277 &session->machines.host) < 0) {
4278 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4283 if (generate_script_lang) {
4284 struct stat perf_stat;
4287 if (output_set_by_user()) {
4289 "custom fields not supported for generated scripts");
4294 input = open(data.path, O_RDONLY); /* input_name */
4297 perror("failed to open file");
4301 err = fstat(input, &perf_stat);
4303 perror("failed to stat file");
4307 if (!perf_stat.st_size) {
4308 fprintf(stderr, "zero-sized file, nothing to do!\n");
4312 scripting_ops = script_spec__lookup(generate_script_lang);
4313 if (!scripting_ops) {
4314 fprintf(stderr, "invalid language specifier");
4318 #ifdef HAVE_LIBTRACEEVENT
4319 err = scripting_ops->generate_script(session->tevent.pevent,
4322 err = scripting_ops->generate_script(NULL, "perf-script");
4327 err = dlfilter__start(dlfilter, session);
4332 err = scripting_ops->start_script(script_name, argc, argv, session);
4335 pr_debug("perf script started with script %s\n\n", script_name);
4336 script_started = true;
4340 err = perf_session__check_output_opt(session);
4344 if (script.time_str) {
4345 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4346 &script.ptime_range,
4353 itrace_synth_opts__set_time_range(&itrace_synth_opts,
4358 err = evswitch__init(&script.evswitch, session->evlist, stderr);
4362 if (zstd_init(&(session->zstd_data), 0) < 0)
4363 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4365 err = __cmd_script(&script);
4370 if (script.ptime_range) {
4371 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4372 zfree(&script.ptime_range);
4375 zstd_fini(&(session->zstd_data));
4376 evlist__free_stats(session->evlist);
4377 perf_session__delete(session);
4378 perf_script__exit(&script);
4381 cleanup_scripting();
4382 dlfilter__cleanup(dlfilter);