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"
37 #include "print_insn.h"
39 #include <linux/bitmap.h>
40 #include <linux/kernel.h>
41 #include <linux/stringify.h>
42 #include <linux/time64.h>
43 #include <linux/zalloc.h>
44 #include <sys/utsname.h>
46 #include "util/mem-events.h"
47 #include "util/dump-insn.h"
52 #include <sys/param.h>
53 #include <sys/types.h>
57 #include <subcmd/pager.h>
58 #include <perf/evlist.h>
59 #include <linux/err.h>
60 #include "util/dlfilter.h"
61 #include "util/record.h"
62 #include "util/util.h"
63 #include "util/cgroup.h"
66 #include <linux/ctype.h>
67 #ifdef HAVE_LIBTRACEEVENT
68 #include <traceevent/event-parse.h>
71 static char const *script_name;
72 static char const *generate_script_lang;
74 static bool deltatime;
75 static u64 initial_time;
76 static u64 previous_time;
77 static bool debug_mode;
78 static u64 last_timestamp;
79 static u64 nr_unordered;
80 static bool no_callchain;
81 static bool latency_format;
82 static bool system_wide;
83 static bool print_flags;
84 static const char *cpu_list;
85 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
86 static struct perf_stat_config stat_config;
87 static int max_blocks;
88 static bool native_arch;
89 static struct dlfilter *dlfilter;
93 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
95 enum perf_output_field {
96 PERF_OUTPUT_COMM = 1ULL << 0,
97 PERF_OUTPUT_TID = 1ULL << 1,
98 PERF_OUTPUT_PID = 1ULL << 2,
99 PERF_OUTPUT_TIME = 1ULL << 3,
100 PERF_OUTPUT_CPU = 1ULL << 4,
101 PERF_OUTPUT_EVNAME = 1ULL << 5,
102 PERF_OUTPUT_TRACE = 1ULL << 6,
103 PERF_OUTPUT_IP = 1ULL << 7,
104 PERF_OUTPUT_SYM = 1ULL << 8,
105 PERF_OUTPUT_DSO = 1ULL << 9,
106 PERF_OUTPUT_ADDR = 1ULL << 10,
107 PERF_OUTPUT_SYMOFFSET = 1ULL << 11,
108 PERF_OUTPUT_SRCLINE = 1ULL << 12,
109 PERF_OUTPUT_PERIOD = 1ULL << 13,
110 PERF_OUTPUT_IREGS = 1ULL << 14,
111 PERF_OUTPUT_BRSTACK = 1ULL << 15,
112 PERF_OUTPUT_BRSTACKSYM = 1ULL << 16,
113 PERF_OUTPUT_DATA_SRC = 1ULL << 17,
114 PERF_OUTPUT_WEIGHT = 1ULL << 18,
115 PERF_OUTPUT_BPF_OUTPUT = 1ULL << 19,
116 PERF_OUTPUT_CALLINDENT = 1ULL << 20,
117 PERF_OUTPUT_INSN = 1ULL << 21,
118 PERF_OUTPUT_INSNLEN = 1ULL << 22,
119 PERF_OUTPUT_BRSTACKINSN = 1ULL << 23,
120 PERF_OUTPUT_BRSTACKOFF = 1ULL << 24,
121 PERF_OUTPUT_SYNTH = 1ULL << 25,
122 PERF_OUTPUT_PHYS_ADDR = 1ULL << 26,
123 PERF_OUTPUT_UREGS = 1ULL << 27,
124 PERF_OUTPUT_METRIC = 1ULL << 28,
125 PERF_OUTPUT_MISC = 1ULL << 29,
126 PERF_OUTPUT_SRCCODE = 1ULL << 30,
127 PERF_OUTPUT_IPC = 1ULL << 31,
128 PERF_OUTPUT_TOD = 1ULL << 32,
129 PERF_OUTPUT_DATA_PAGE_SIZE = 1ULL << 33,
130 PERF_OUTPUT_CODE_PAGE_SIZE = 1ULL << 34,
131 PERF_OUTPUT_INS_LAT = 1ULL << 35,
132 PERF_OUTPUT_BRSTACKINSNLEN = 1ULL << 36,
133 PERF_OUTPUT_MACHINE_PID = 1ULL << 37,
134 PERF_OUTPUT_VCPU = 1ULL << 38,
135 PERF_OUTPUT_CGROUP = 1ULL << 39,
136 PERF_OUTPUT_RETIRE_LAT = 1ULL << 40,
137 PERF_OUTPUT_DSOFF = 1ULL << 41,
138 PERF_OUTPUT_DISASM = 1ULL << 42,
142 struct perf_tool tool;
143 struct perf_session *session;
144 bool show_task_events;
145 bool show_mmap_events;
146 bool show_switch_events;
147 bool show_namespace_events;
148 bool show_lost_events;
149 bool show_round_events;
150 bool show_bpf_events;
151 bool show_cgroup_events;
152 bool show_text_poke_events;
156 struct evswitch evswitch;
157 struct perf_cpu_map *cpus;
158 struct perf_thread_map *threads;
160 const char *time_str;
161 struct perf_time_interval *ptime_range;
166 struct output_option {
168 enum perf_output_field field;
169 } all_output_options[] = {
170 {.str = "comm", .field = PERF_OUTPUT_COMM},
171 {.str = "tid", .field = PERF_OUTPUT_TID},
172 {.str = "pid", .field = PERF_OUTPUT_PID},
173 {.str = "time", .field = PERF_OUTPUT_TIME},
174 {.str = "cpu", .field = PERF_OUTPUT_CPU},
175 {.str = "event", .field = PERF_OUTPUT_EVNAME},
176 {.str = "trace", .field = PERF_OUTPUT_TRACE},
177 {.str = "ip", .field = PERF_OUTPUT_IP},
178 {.str = "sym", .field = PERF_OUTPUT_SYM},
179 {.str = "dso", .field = PERF_OUTPUT_DSO},
180 {.str = "dsoff", .field = PERF_OUTPUT_DSOFF},
181 {.str = "addr", .field = PERF_OUTPUT_ADDR},
182 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
183 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
184 {.str = "period", .field = PERF_OUTPUT_PERIOD},
185 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
186 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
187 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
188 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
189 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
190 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
191 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
192 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
193 {.str = "insn", .field = PERF_OUTPUT_INSN},
194 {.str = "disasm", .field = PERF_OUTPUT_DISASM},
195 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
196 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
197 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
198 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
199 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
200 {.str = "metric", .field = PERF_OUTPUT_METRIC},
201 {.str = "misc", .field = PERF_OUTPUT_MISC},
202 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
203 {.str = "ipc", .field = PERF_OUTPUT_IPC},
204 {.str = "tod", .field = PERF_OUTPUT_TOD},
205 {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
206 {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
207 {.str = "ins_lat", .field = PERF_OUTPUT_INS_LAT},
208 {.str = "brstackinsnlen", .field = PERF_OUTPUT_BRSTACKINSNLEN},
209 {.str = "machine_pid", .field = PERF_OUTPUT_MACHINE_PID},
210 {.str = "vcpu", .field = PERF_OUTPUT_VCPU},
211 {.str = "cgroup", .field = PERF_OUTPUT_CGROUP},
212 {.str = "retire_lat", .field = PERF_OUTPUT_RETIRE_LAT},
216 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
221 /* default set to maintain compatibility with current format */
225 unsigned int print_ip_opts;
229 u64 user_unset_fields;
230 } output[OUTPUT_TYPE_MAX] = {
232 [PERF_TYPE_HARDWARE] = {
235 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
236 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
237 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
238 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
239 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
241 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
244 [PERF_TYPE_SOFTWARE] = {
247 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
248 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
249 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
250 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
251 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
252 PERF_OUTPUT_BPF_OUTPUT,
254 .invalid_fields = PERF_OUTPUT_TRACE,
257 [PERF_TYPE_TRACEPOINT] = {
260 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
261 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
262 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
265 [PERF_TYPE_HW_CACHE] = {
268 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
269 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
270 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
271 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
272 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
274 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
280 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
281 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
282 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
283 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
284 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
285 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
286 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
287 PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
288 PERF_OUTPUT_INS_LAT | PERF_OUTPUT_RETIRE_LAT,
290 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
293 [PERF_TYPE_BREAKPOINT] = {
296 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
297 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
298 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
299 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
300 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
302 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
305 [OUTPUT_TYPE_SYNTH] = {
308 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
309 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
310 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
311 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
312 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
314 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
317 [OUTPUT_TYPE_OTHER] = {
320 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
321 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
322 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
323 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
324 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
326 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
330 struct evsel_script {
334 /* For metric output */
339 static inline struct evsel_script *evsel_script(struct evsel *evsel)
341 return (struct evsel_script *)evsel->priv;
344 static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
346 struct evsel_script *es = zalloc(sizeof(*es));
349 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
351 es->fp = fopen(es->filename, "w");
353 goto out_free_filename;
358 zfree(&es->filename);
364 static void evsel_script__delete(struct evsel_script *es)
366 zfree(&es->filename);
372 static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
376 fstat(fileno(es->fp), &st);
377 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
378 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
381 static inline int output_type(unsigned int type)
384 case PERF_TYPE_SYNTH:
385 return OUTPUT_TYPE_SYNTH;
387 if (type < PERF_TYPE_MAX)
391 return OUTPUT_TYPE_OTHER;
394 static bool output_set_by_user(void)
397 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
398 if (output[j].user_set)
404 static const char *output_field2str(enum perf_output_field field)
406 int i, imax = ARRAY_SIZE(all_output_options);
407 const char *str = "";
409 for (i = 0; i < imax; ++i) {
410 if (all_output_options[i].field == field) {
411 str = all_output_options[i].str;
418 #define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
420 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
421 enum perf_output_field field, bool allow_user_set)
423 struct perf_event_attr *attr = &evsel->core.attr;
424 int type = output_type(attr->type);
427 if (attr->sample_type & sample_type)
430 if (output[type].user_set_fields & field) {
433 evname = evsel__name(evsel);
434 pr_err("Samples for '%s' event do not have %s attribute set. "
435 "Cannot print '%s' field.\n",
436 evname, sample_msg, output_field2str(field));
440 /* user did not ask for it explicitly so remove from the default list */
441 output[type].fields &= ~field;
442 evname = evsel__name(evsel);
443 pr_debug("Samples for '%s' event do not have %s attribute set. "
444 "Skipping '%s' field.\n",
445 evname, sample_msg, output_field2str(field));
450 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
451 enum perf_output_field field)
453 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
456 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
458 struct perf_event_attr *attr = &evsel->core.attr;
461 if (evsel__is_dummy_event(evsel))
464 if (perf_header__has_feat(&session->header, HEADER_STAT))
467 allow_user_set = perf_header__has_feat(&session->header,
470 if (PRINT_FIELD(TRACE) &&
471 !perf_session__has_traces(session, "record -R"))
474 if (PRINT_FIELD(IP)) {
475 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
479 if (PRINT_FIELD(ADDR) &&
480 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
483 if (PRINT_FIELD(DATA_SRC) &&
484 evsel__do_check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC, allow_user_set))
487 if (PRINT_FIELD(WEIGHT) &&
488 evsel__do_check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT, allow_user_set))
491 if (PRINT_FIELD(SYM) &&
492 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
493 pr_err("Display of symbols requested but neither sample IP nor "
494 "sample address\navailable. Hence, no addresses to convert "
498 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
499 pr_err("Display of offsets requested but symbol is not"
503 if (PRINT_FIELD(DSO) &&
504 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
505 pr_err("Display of DSO requested but no address to convert.\n");
508 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
509 pr_err("Display of source line number requested but sample IP is not\n"
510 "selected. Hence, no address to lookup the source line number.\n");
513 if ((PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN)) && !allow_user_set &&
514 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
515 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
516 "Hint: run 'perf record -b ...'\n");
519 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
520 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
523 if (PRINT_FIELD(TIME) &&
524 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
527 if (PRINT_FIELD(CPU) &&
528 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
531 if (PRINT_FIELD(IREGS) &&
532 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
535 if (PRINT_FIELD(UREGS) &&
536 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
539 if (PRINT_FIELD(PHYS_ADDR) &&
540 evsel__do_check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR, allow_user_set))
543 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
544 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
547 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
548 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
551 if (PRINT_FIELD(INS_LAT) &&
552 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
555 if (PRINT_FIELD(CGROUP) &&
556 evsel__check_stype(evsel, PERF_SAMPLE_CGROUP, "CGROUP", PERF_OUTPUT_CGROUP)) {
557 pr_err("Hint: run 'perf record --all-cgroups ...'\n");
561 if (PRINT_FIELD(RETIRE_LAT) &&
562 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_RETIRE_LAT))
568 static void set_print_ip_opts(struct perf_event_attr *attr)
570 unsigned int type = output_type(attr->type);
572 output[type].print_ip_opts = 0;
574 output[type].print_ip_opts |= EVSEL__PRINT_IP;
576 if (PRINT_FIELD(SYM))
577 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
579 if (PRINT_FIELD(DSO))
580 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
582 if (PRINT_FIELD(DSOFF))
583 output[type].print_ip_opts |= EVSEL__PRINT_DSOFF;
585 if (PRINT_FIELD(SYMOFFSET))
586 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
588 if (PRINT_FIELD(SRCLINE))
589 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
592 static struct evsel *find_first_output_type(struct evlist *evlist,
597 evlist__for_each_entry(evlist, evsel) {
598 if (evsel__is_dummy_event(evsel))
600 if (output_type(evsel->core.attr.type) == (int)type)
607 * verify all user requested events exist and the samples
608 * have the expected data
610 static int perf_session__check_output_opt(struct perf_session *session)
616 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
617 evsel = find_first_output_type(session->evlist, j);
620 * even if fields is set to 0 (ie., show nothing) event must
621 * exist if user explicitly includes it on the command line
623 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
624 j != OUTPUT_TYPE_SYNTH) {
625 pr_err("%s events do not exist. "
626 "Remove corresponding -F option to proceed.\n",
631 if (evsel && output[j].fields &&
632 evsel__check_attr(evsel, session))
638 /* 'dsoff' implys 'dso' field */
639 if (output[j].fields & PERF_OUTPUT_DSOFF)
640 output[j].fields |= PERF_OUTPUT_DSO;
642 set_print_ip_opts(&evsel->core.attr);
643 tod |= output[j].fields & PERF_OUTPUT_TOD;
647 bool use_callchain = false;
648 bool not_pipe = false;
650 evlist__for_each_entry(session->evlist, evsel) {
652 if (evsel__has_callchain(evsel)) {
653 use_callchain = true;
657 if (not_pipe && !use_callchain)
658 symbol_conf.use_callchain = false;
662 * set default for tracepoints to print symbols only
663 * if callchains are present
665 if (symbol_conf.use_callchain &&
666 !output[PERF_TYPE_TRACEPOINT].user_set) {
667 j = PERF_TYPE_TRACEPOINT;
669 evlist__for_each_entry(session->evlist, evsel) {
670 if (evsel->core.attr.type != j)
673 if (evsel__has_callchain(evsel)) {
674 output[j].fields |= PERF_OUTPUT_IP;
675 output[j].fields |= PERF_OUTPUT_SYM;
676 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
677 output[j].fields |= PERF_OUTPUT_DSO;
678 set_print_ip_opts(&evsel->core.attr);
684 if (tod && !session->header.env.clock.enabled) {
685 pr_err("Can't provide 'tod' time, missing clock data. "
686 "Please record with -k/--clockid option.\n");
693 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask, const char *arch,
699 if (!regs || !regs->regs)
702 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
704 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
705 u64 val = regs->regs[i++];
706 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r, arch), val);
712 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
715 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
718 u64 tod_ns, clockid_ns;
719 struct perf_env *env;
726 if (buflen < 64 || !script)
729 env = &script->session->header.env;
730 if (!env->clock.enabled) {
731 scnprintf(buf, buflen, "disabled");
735 clockid_ns = env->clock.clockid_ns;
736 tod_ns = env->clock.tod_ns;
738 if (timestamp > clockid_ns)
739 tod_ns += timestamp - clockid_ns;
741 tod_ns -= clockid_ns - timestamp;
743 sec = (time_t) (tod_ns / NSEC_PER_SEC);
744 nsec = tod_ns - sec * NSEC_PER_SEC;
746 if (localtime_r(&sec, <ime) == NULL) {
747 scnprintf(buf, buflen, "failed");
749 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
751 if (symbol_conf.nanosecs) {
752 snprintf(buf, buflen, "%s.%09lu", date, nsec);
754 snprintf(buf, buflen, "%s.%06lu",
755 date, nsec / NSEC_PER_USEC);
762 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
763 struct perf_event_attr *attr, const char *arch, FILE *fp)
765 return perf_sample__fprintf_regs(&sample->intr_regs,
766 attr->sample_regs_intr, arch, fp);
769 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
770 struct perf_event_attr *attr, const char *arch, FILE *fp)
772 return perf_sample__fprintf_regs(&sample->user_regs,
773 attr->sample_regs_user, arch, fp);
776 static int perf_sample__fprintf_start(struct perf_script *script,
777 struct perf_sample *sample,
778 struct thread *thread,
782 struct perf_event_attr *attr = &evsel->core.attr;
784 unsigned long long nsecs;
788 if (PRINT_FIELD(MACHINE_PID) && sample->machine_pid)
789 printed += fprintf(fp, "VM:%5d ", sample->machine_pid);
791 /* Print VCPU only for guest events i.e. with machine_pid */
792 if (PRINT_FIELD(VCPU) && sample->machine_pid)
793 printed += fprintf(fp, "VCPU:%03d ", sample->vcpu);
795 if (PRINT_FIELD(COMM)) {
796 const char *comm = thread ? thread__comm_str(thread) : ":-1";
799 printed += fprintf(fp, "%8.8s ", comm);
800 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
801 printed += fprintf(fp, "%s ", comm);
803 printed += fprintf(fp, "%16s ", comm);
806 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
807 printed += fprintf(fp, "%7d/%-7d ", sample->pid, sample->tid);
808 else if (PRINT_FIELD(PID))
809 printed += fprintf(fp, "%7d ", sample->pid);
810 else if (PRINT_FIELD(TID))
811 printed += fprintf(fp, "%7d ", sample->tid);
813 if (PRINT_FIELD(CPU)) {
815 printed += fprintf(fp, "%3d ", sample->cpu);
817 printed += fprintf(fp, "[%03d] ", sample->cpu);
820 if (PRINT_FIELD(MISC)) {
824 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
827 ret += fprintf(fp, "K");
829 ret += fprintf(fp, "U");
831 ret += fprintf(fp, "H");
832 if (has(GUEST_KERNEL))
833 ret += fprintf(fp, "G");
835 ret += fprintf(fp, "g");
838 case PERF_RECORD_MMAP:
839 case PERF_RECORD_MMAP2:
841 ret += fprintf(fp, "M");
843 case PERF_RECORD_COMM:
845 ret += fprintf(fp, "E");
847 case PERF_RECORD_SWITCH:
848 case PERF_RECORD_SWITCH_CPU_WIDE:
849 if (has(SWITCH_OUT)) {
850 ret += fprintf(fp, "S");
851 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
852 ret += fprintf(fp, "p");
860 ret += fprintf(fp, "%*s", 6 - ret, " ");
864 if (PRINT_FIELD(TOD)) {
865 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
866 printed += fprintf(fp, "%s ", tstr);
869 if (PRINT_FIELD(TIME)) {
870 u64 t = sample->time;
873 initial_time = sample->time;
874 t = sample->time - initial_time;
875 } else if (deltatime) {
877 t = sample->time - previous_time;
881 previous_time = sample->time;
884 secs = nsecs / NSEC_PER_SEC;
885 nsecs -= secs * NSEC_PER_SEC;
887 if (symbol_conf.nanosecs)
888 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
890 char sample_time[32];
891 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
892 printed += fprintf(fp, "%12s: ", sample_time);
900 mispred_str(struct branch_entry *br)
902 if (!(br->flags.mispred || br->flags.predicted))
905 return br->flags.predicted ? 'P' : 'M';
908 static int print_bstack_flags(FILE *fp, struct branch_entry *br)
910 return fprintf(fp, "/%c/%c/%c/%d/%s/%s ",
912 br->flags.in_tx ? 'X' : '-',
913 br->flags.abort ? 'A' : '-',
916 br->flags.spec ? branch_spec_desc(br->flags.spec) : "-");
919 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
920 struct thread *thread,
921 struct perf_event_attr *attr, FILE *fp)
923 struct branch_stack *br = sample->branch_stack;
924 struct branch_entry *entries = perf_sample__branch_entries(sample);
931 for (i = 0; i < br->nr; i++) {
932 from = entries[i].from;
935 printed += fprintf(fp, " 0x%"PRIx64, from);
936 if (PRINT_FIELD(DSO)) {
937 struct addr_location alf, alt;
939 addr_location__init(&alf);
940 addr_location__init(&alt);
941 thread__find_map_fb(thread, sample->cpumode, from, &alf);
942 thread__find_map_fb(thread, sample->cpumode, to, &alt);
944 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
945 printed += fprintf(fp, "/0x%"PRIx64, to);
946 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
947 addr_location__exit(&alt);
948 addr_location__exit(&alf);
950 printed += fprintf(fp, "/0x%"PRIx64, to);
952 printed += print_bstack_flags(fp, entries + i);
958 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
959 struct thread *thread,
960 struct perf_event_attr *attr, FILE *fp)
962 struct branch_stack *br = sample->branch_stack;
963 struct branch_entry *entries = perf_sample__branch_entries(sample);
970 for (i = 0; i < br->nr; i++) {
971 struct addr_location alf, alt;
973 addr_location__init(&alf);
974 addr_location__init(&alt);
975 from = entries[i].from;
978 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
979 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
981 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
982 if (PRINT_FIELD(DSO))
983 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
984 printed += fprintf(fp, "%c", '/');
985 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
986 if (PRINT_FIELD(DSO))
987 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
988 printed += print_bstack_flags(fp, entries + i);
989 addr_location__exit(&alt);
990 addr_location__exit(&alf);
996 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
997 struct thread *thread,
998 struct perf_event_attr *attr, FILE *fp)
1000 struct branch_stack *br = sample->branch_stack;
1001 struct branch_entry *entries = perf_sample__branch_entries(sample);
1005 if (!(br && br->nr))
1008 for (i = 0; i < br->nr; i++) {
1009 struct addr_location alf, alt;
1011 addr_location__init(&alf);
1012 addr_location__init(&alt);
1013 from = entries[i].from;
1016 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
1017 !map__dso(alf.map)->adjust_symbols)
1018 from = map__dso_map_ip(alf.map, from);
1020 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
1021 !map__dso(alt.map)->adjust_symbols)
1022 to = map__dso_map_ip(alt.map, to);
1024 printed += fprintf(fp, " 0x%"PRIx64, from);
1025 if (PRINT_FIELD(DSO))
1026 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
1027 printed += fprintf(fp, "/0x%"PRIx64, to);
1028 if (PRINT_FIELD(DSO))
1029 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
1030 printed += print_bstack_flags(fp, entries + i);
1031 addr_location__exit(&alt);
1032 addr_location__exit(&alf);
1037 #define MAXBB 16384UL
1039 static int grab_bb(u8 *buffer, u64 start, u64 end,
1040 struct machine *machine, struct thread *thread,
1041 bool *is64bit, u8 *cpumode, bool last)
1044 struct addr_location al;
1052 kernel = machine__kernel_ip(machine, start);
1054 *cpumode = PERF_RECORD_MISC_KERNEL;
1056 *cpumode = PERF_RECORD_MISC_USER;
1059 * Block overlaps between kernel and user.
1060 * This can happen due to ring filtering
1061 * On Intel CPUs the entry into the kernel is filtered,
1062 * but the exit is not. Let the caller patch it up.
1064 if (kernel != machine__kernel_ip(machine, end)) {
1065 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1069 if (end - start > MAXBB - MAXINSN) {
1071 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1073 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1077 addr_location__init(&al);
1078 if (!thread__find_map(thread, *cpumode, start, &al) || (dso = map__dso(al.map)) == NULL) {
1079 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1082 if (dso->data.status == DSO_DATA_STATUS_ERROR) {
1083 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1087 /* Load maps to ensure dso->is_64_bit has been updated */
1090 offset = map__map_ip(al.map, start);
1091 len = dso__data_read_offset(dso, machine, offset, (u8 *)buffer,
1092 end - start + MAXINSN);
1094 *is64bit = dso->is_64_bit;
1096 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1100 addr_location__exit(&al);
1104 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1113 if (!map || (dso = map__dso(map)) == NULL)
1115 srcfile = get_srcline_split(dso,
1116 map__rip_2objdump(map, addr),
1121 /* Avoid redundant printing */
1124 !strcmp(state->srcfile, srcfile) &&
1125 state->line == line) {
1130 srccode = find_sourceline(srcfile, line, &len);
1134 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1137 state->srcfile = srcfile;
1147 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1149 struct addr_location al;
1152 addr_location__init(&al);
1153 thread__find_map(thread, cpumode, addr, &al);
1156 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1157 thread__srccode_state(thread));
1159 ret += printf("\n");
1161 addr_location__exit(&al);
1165 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1166 struct perf_insn *x, u8 *inbuf, int len,
1167 int insn, FILE *fp, int *total_cycles,
1168 struct perf_event_attr *attr,
1169 struct thread *thread)
1172 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t", ip,
1173 dump_insn(x, ip, inbuf, len, &ilen));
1175 if (PRINT_FIELD(BRSTACKINSNLEN))
1176 printed += fprintf(fp, "ilen: %d\t", ilen);
1178 if (PRINT_FIELD(SRCLINE)) {
1179 struct addr_location al;
1181 addr_location__init(&al);
1182 thread__find_map(thread, x->cpumode, ip, &al);
1183 printed += map__fprintf_srcline(al.map, al.addr, " srcline: ", fp);
1184 printed += fprintf(fp, "\t");
1185 addr_location__exit(&al);
1188 printed += fprintf(fp, "#%s%s%s%s",
1189 en->flags.predicted ? " PRED" : "",
1190 en->flags.mispred ? " MISPRED" : "",
1191 en->flags.in_tx ? " INTX" : "",
1192 en->flags.abort ? " ABORT" : "");
1193 if (en->flags.cycles) {
1194 *total_cycles += en->flags.cycles;
1195 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1197 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1200 return printed + fprintf(fp, "\n");
1203 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1204 u8 cpumode, int cpu, struct symbol **lastsym,
1205 struct perf_event_attr *attr, FILE *fp)
1207 struct addr_location al;
1208 int off, printed = 0, ret = 0;
1210 addr_location__init(&al);
1211 thread__find_map(thread, cpumode, addr, &al);
1213 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1219 al.sym = map__find_symbol(al.map, al.addr);
1224 if (al.addr < al.sym->end)
1225 off = al.addr - al.sym->start;
1227 off = al.addr - map__start(al.map) - al.sym->start;
1228 printed += fprintf(fp, "\t%s", al.sym->name);
1230 printed += fprintf(fp, "%+d", off);
1231 printed += fprintf(fp, ":");
1232 if (PRINT_FIELD(SRCLINE))
1233 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1234 printed += fprintf(fp, "\n");
1239 addr_location__exit(&al);
1243 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1244 struct thread *thread,
1245 struct perf_event_attr *attr,
1246 struct machine *machine, FILE *fp)
1248 struct branch_stack *br = sample->branch_stack;
1249 struct branch_entry *entries = perf_sample__branch_entries(sample);
1251 int i, insn, len, nr, ilen, printed = 0;
1255 struct symbol *lastsym = NULL;
1256 int total_cycles = 0;
1258 if (!(br && br->nr))
1261 if (max_blocks && nr > max_blocks + 1)
1262 nr = max_blocks + 1;
1265 x.cpu = sample->cpu;
1267 printed += fprintf(fp, "%c", '\n');
1269 /* Handle first from jump, of which we don't know the entry. */
1270 len = grab_bb(buffer, entries[nr-1].from,
1272 machine, thread, &x.is64bit, &x.cpumode, false);
1274 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1275 x.cpumode, x.cpu, &lastsym, attr, fp);
1276 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1277 &x, buffer, len, 0, fp, &total_cycles,
1279 if (PRINT_FIELD(SRCCODE))
1280 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1283 /* Print all blocks */
1284 for (i = nr - 2; i >= 0; i--) {
1285 if (entries[i].from || entries[i].to)
1286 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1289 start = entries[i + 1].to;
1290 end = entries[i].from;
1292 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1293 /* Patch up missing kernel transfers due to ring filters */
1294 if (len == -ENXIO && i > 0) {
1295 end = entries[--i].from;
1296 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1297 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1303 for (off = 0; off < (unsigned)len; off += ilen) {
1304 uint64_t ip = start + off;
1306 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1308 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1309 &total_cycles, attr, thread);
1310 if (PRINT_FIELD(SRCCODE))
1311 printed += print_srccode(thread, x.cpumode, ip);
1315 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", ip,
1316 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1317 if (PRINT_FIELD(BRSTACKINSNLEN))
1318 printed += fprintf(fp, "\tilen: %d", ilen);
1319 printed += fprintf(fp, "\n");
1322 if (PRINT_FIELD(SRCCODE))
1323 print_srccode(thread, x.cpumode, ip);
1327 if (off != end - start)
1328 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1332 * Hit the branch? In this case we are already done, and the target
1333 * has not been executed yet.
1335 if (entries[0].from == sample->ip)
1337 if (entries[0].flags.abort)
1341 * Print final block up to sample
1343 * Due to pipeline delays the LBRs might be missing a branch
1344 * or two, which can result in very large or negative blocks
1345 * between final branch and sample. When this happens just
1346 * continue walking after the last TO until we hit a branch.
1348 start = entries[0].to;
1351 /* Missing jump. Scan 128 bytes for the next branch */
1354 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1355 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1357 /* Print at least last IP if basic block did not work */
1358 len = grab_bb(buffer, sample->ip, sample->ip,
1359 machine, thread, &x.is64bit, &x.cpumode, false);
1363 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", sample->ip,
1364 dump_insn(&x, sample->ip, buffer, len, &ilen));
1365 if (PRINT_FIELD(BRSTACKINSNLEN))
1366 printed += fprintf(fp, "\tilen: %d", ilen);
1367 printed += fprintf(fp, "\n");
1368 if (PRINT_FIELD(SRCCODE))
1369 print_srccode(thread, x.cpumode, sample->ip);
1372 for (off = 0; off <= end - start; off += ilen) {
1374 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", start + off,
1375 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1376 if (PRINT_FIELD(BRSTACKINSNLEN))
1377 printed += fprintf(fp, "\tilen: %d", ilen);
1378 printed += fprintf(fp, "\n");
1381 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1383 * Hit a missing branch. Just stop.
1385 printed += fprintf(fp, "\t... not reaching sample ...\n");
1388 if (PRINT_FIELD(SRCCODE))
1389 print_srccode(thread, x.cpumode, start + off);
1395 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1396 struct thread *thread,
1397 struct perf_event_attr *attr, FILE *fp)
1399 struct addr_location al;
1400 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1402 addr_location__init(&al);
1403 if (!sample_addr_correlates_sym(attr))
1406 thread__resolve(thread, &al, sample);
1408 if (PRINT_FIELD(SYM)) {
1409 printed += fprintf(fp, " ");
1410 if (PRINT_FIELD(SYMOFFSET))
1411 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1413 printed += symbol__fprintf_symname(al.sym, fp);
1416 if (PRINT_FIELD(DSO))
1417 printed += map__fprintf_dsoname_dsoff(al.map, PRINT_FIELD(DSOFF), al.addr, fp);
1419 addr_location__exit(&al);
1423 static const char *resolve_branch_sym(struct perf_sample *sample,
1424 struct evsel *evsel,
1425 struct thread *thread,
1426 struct addr_location *al,
1427 struct addr_location *addr_al,
1430 struct perf_event_attr *attr = &evsel->core.attr;
1431 const char *name = NULL;
1433 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1434 if (sample_addr_correlates_sym(attr)) {
1435 if (!addr_al->thread)
1436 thread__resolve(thread, addr_al, sample);
1438 name = addr_al->sym->name;
1444 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1446 name = al->sym->name;
1453 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1454 struct evsel *evsel,
1455 struct thread *thread,
1456 struct addr_location *al,
1457 struct addr_location *addr_al,
1460 struct perf_event_attr *attr = &evsel->core.attr;
1461 size_t depth = thread_stack__depth(thread, sample->cpu);
1462 const char *name = NULL;
1469 * The 'return' has already been popped off the stack so the depth has
1470 * to be adjusted to match the 'call'.
1472 if (thread__ts(thread) && sample->flags & PERF_IP_FLAG_RETURN)
1475 name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1477 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1478 dlen += fprintf(fp, "(");
1479 dlen += map__fprintf_dsoname(al->map, fp);
1480 dlen += fprintf(fp, ")\t");
1484 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1486 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1492 * Try to keep the output length from changing frequently so that the
1493 * output lines up more nicely.
1495 if (len > spacing || (len && len < spacing - 52))
1496 spacing = round_up(len + 4, 32);
1499 len += fprintf(fp, "%*s", spacing - len, "");
1504 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1505 struct thread *thread __maybe_unused,
1506 struct machine *machine __maybe_unused)
1510 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1511 struct machine *machine)
1513 if (sample->insn_len == 0 && native_arch)
1514 arch_fetch_insn(sample, thread, machine);
1517 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1518 struct perf_event_attr *attr,
1519 struct thread *thread,
1520 struct machine *machine, FILE *fp)
1524 script_fetch_insn(sample, thread, machine);
1526 if (PRINT_FIELD(INSNLEN))
1527 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1528 if (PRINT_FIELD(INSN) && sample->insn_len) {
1529 printed += fprintf(fp, " insn: ");
1530 printed += sample__fprintf_insn_raw(sample, fp);
1532 if (PRINT_FIELD(DISASM) && sample->insn_len) {
1533 printed += fprintf(fp, "\t\t");
1534 printed += sample__fprintf_insn_asm(sample, thread, machine, fp);
1536 if (PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN))
1537 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1542 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1543 struct perf_event_attr *attr, FILE *fp)
1547 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1550 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1552 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1553 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1556 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1557 struct evsel *evsel,
1558 struct thread *thread,
1559 struct addr_location *al,
1560 struct addr_location *addr_al,
1561 struct machine *machine, FILE *fp)
1563 struct perf_event_attr *attr = &evsel->core.attr;
1564 unsigned int type = output_type(attr->type);
1565 bool print_srcline_last = false;
1568 if (PRINT_FIELD(CALLINDENT))
1569 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1571 /* print branch_from information */
1572 if (PRINT_FIELD(IP)) {
1573 unsigned int print_opts = output[type].print_ip_opts;
1574 struct callchain_cursor *cursor = NULL;
1576 if (symbol_conf.use_callchain && sample->callchain) {
1577 cursor = get_tls_callchain_cursor();
1578 if (thread__resolve_callchain(al->thread, cursor, evsel,
1580 scripting_max_stack))
1583 if (cursor == NULL) {
1584 printed += fprintf(fp, " ");
1585 if (print_opts & EVSEL__PRINT_SRCLINE) {
1586 print_srcline_last = true;
1587 print_opts &= ~EVSEL__PRINT_SRCLINE;
1590 printed += fprintf(fp, "\n");
1592 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1593 symbol_conf.bt_stop_list, fp);
1596 /* print branch_to information */
1597 if (PRINT_FIELD(ADDR) ||
1598 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1599 !output[type].user_set)) {
1600 printed += fprintf(fp, " => ");
1601 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1604 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1606 if (print_srcline_last)
1607 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1609 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1610 printed += fprintf(fp, "\n");
1611 if (PRINT_FIELD(SRCCODE)) {
1612 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1613 thread__srccode_state(thread));
1616 printed += printf("\n");
1625 } sample_flags[] = {
1626 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1627 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1628 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1629 {PERF_IP_FLAG_BRANCH, "jmp"},
1630 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1631 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1632 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1633 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1634 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1635 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1636 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1637 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1638 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1639 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1640 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1644 static const char *sample_flags_to_name(u32 flags)
1648 for (i = 0; sample_flags[i].name ; i++) {
1649 if (sample_flags[i].flags == flags)
1650 return sample_flags[i].name;
1656 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1658 u32 xf = PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_INTR_DISABLE |
1659 PERF_IP_FLAG_INTR_TOGGLE;
1660 const char *chars = PERF_IP_FLAG_CHARS;
1661 const size_t n = strlen(PERF_IP_FLAG_CHARS);
1662 const char *name = NULL;
1667 snprintf(xs, sizeof(xs), "(%s%s%s)",
1668 flags & PERF_IP_FLAG_IN_TX ? "x" : "",
1669 flags & PERF_IP_FLAG_INTR_DISABLE ? "D" : "",
1670 flags & PERF_IP_FLAG_INTR_TOGGLE ? "t" : "");
1672 name = sample_flags_to_name(flags & ~xf);
1674 return snprintf(str, sz, "%-15s%6s", name, xs);
1676 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1677 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_BEGIN));
1679 return snprintf(str, sz, "tr strt %-7s%6s", name, xs);
1682 if (flags & PERF_IP_FLAG_TRACE_END) {
1683 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_END));
1685 return snprintf(str, sz, "tr end %-7s%6s", name, xs);
1688 for (i = 0; i < n; i++, flags >>= 1) {
1689 if ((flags & 1) && pos < sz)
1690 str[pos++] = chars[i];
1692 for (; i < 32; i++, flags >>= 1) {
1693 if ((flags & 1) && pos < sz)
1702 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1704 char str[SAMPLE_FLAGS_BUF_SIZE];
1706 perf_sample__sprintf_flags(flags, str, sizeof(str));
1707 return fprintf(fp, " %-21s ", str);
1710 struct printer_data {
1716 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1718 void *extra, FILE *fp)
1720 unsigned char ch = (unsigned char)val;
1721 struct printer_data *printer_data = extra;
1725 case BINARY_PRINT_DATA_BEGIN:
1726 printed += fprintf(fp, "\n");
1728 case BINARY_PRINT_LINE_BEGIN:
1729 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1732 case BINARY_PRINT_ADDR:
1733 printed += fprintf(fp, " %04x:", val);
1735 case BINARY_PRINT_NUM_DATA:
1736 printed += fprintf(fp, " %02x", val);
1738 case BINARY_PRINT_NUM_PAD:
1739 printed += fprintf(fp, " ");
1741 case BINARY_PRINT_SEP:
1742 printed += fprintf(fp, " ");
1744 case BINARY_PRINT_CHAR_DATA:
1745 if (printer_data->hit_nul && ch)
1746 printer_data->is_printable = false;
1749 printed += fprintf(fp, "%c", '.');
1751 if (!printer_data->is_printable)
1755 printer_data->hit_nul = true;
1757 printer_data->is_printable = false;
1759 printed += fprintf(fp, "%c", ch);
1762 case BINARY_PRINT_CHAR_PAD:
1763 printed += fprintf(fp, " ");
1765 case BINARY_PRINT_LINE_END:
1766 printed += fprintf(fp, "\n");
1767 printer_data->line_no++;
1769 case BINARY_PRINT_DATA_END:
1777 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1779 unsigned int nr_bytes = sample->raw_size;
1780 struct printer_data printer_data = {0, false, true};
1781 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1782 sample__fprintf_bpf_output, &printer_data, fp);
1784 if (printer_data.is_printable && printer_data.hit_nul)
1785 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1790 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1792 if (len > 0 && len < spacing)
1793 return fprintf(fp, "%*s", spacing - len, "");
1798 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1800 return perf_sample__fprintf_spacing(len, 34, fp);
1803 /* If a value contains only printable ASCII characters padded with NULLs */
1804 static bool ptw_is_prt(u64 val)
1809 for (i = 0; i < sizeof(val); i++) {
1810 c = ((char *)&val)[i];
1813 if (!isprint(c) || !isascii(c))
1816 for (; i < sizeof(val); i++) {
1817 c = ((char *)&val)[i];
1824 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1826 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1827 char str[sizeof(u64) + 1] = "";
1831 if (perf_sample__bad_synth_size(sample, *data))
1834 val = le64_to_cpu(data->payload);
1835 if (ptw_is_prt(val)) {
1836 memcpy(str, &val, sizeof(val));
1837 str[sizeof(val)] = 0;
1839 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " %s ",
1840 data->ip, val, str);
1841 return len + perf_sample__fprintf_pt_spacing(len, fp);
1844 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1846 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1849 if (perf_sample__bad_synth_size(sample, *data))
1852 len = fprintf(fp, " hints: %#x extensions: %#x ",
1853 data->hints, data->extensions);
1854 return len + perf_sample__fprintf_pt_spacing(len, fp);
1857 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1859 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1862 if (perf_sample__bad_synth_size(sample, *data))
1865 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1866 data->hw, data->cstate, data->subcstate);
1867 return len + perf_sample__fprintf_pt_spacing(len, fp);
1870 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1872 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1875 if (perf_sample__bad_synth_size(sample, *data))
1878 len = fprintf(fp, " IP: %u ", data->ip);
1879 return len + perf_sample__fprintf_pt_spacing(len, fp);
1882 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1884 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1887 if (perf_sample__bad_synth_size(sample, *data))
1890 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1891 data->deepest_cstate, data->last_cstate,
1893 return len + perf_sample__fprintf_pt_spacing(len, fp);
1896 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1898 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1899 unsigned int percent, freq;
1902 if (perf_sample__bad_synth_size(sample, *data))
1905 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1906 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1907 if (data->max_nonturbo) {
1908 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1909 len += fprintf(fp, "(%3u%%) ", percent);
1911 return len + perf_sample__fprintf_pt_spacing(len, fp);
1914 static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1916 struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1919 if (perf_sample__bad_synth_size(sample, *data))
1922 len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1923 return len + perf_sample__fprintf_pt_spacing(len, fp);
1926 /* Intel PT Event Trace */
1927 static int perf_sample__fprintf_synth_evt(struct perf_sample *sample, FILE *fp)
1929 struct perf_synth_intel_evt *data = perf_sample__synth_ptr(sample);
1930 const char *cfe[32] = {NULL, "INTR", "IRET", "SMI", "RSM", "SIPI",
1931 "INIT", "VMENTRY", "VMEXIT", "VMEXIT_INTR",
1932 "SHUTDOWN", NULL, "UINTR", "UIRET"};
1933 const char *evd[64] = {"PFA", "VMXQ", "VMXR"};
1937 if (perf_sample__bad_synth_size(sample, *data))
1940 s = cfe[data->type];
1942 len = fprintf(fp, " cfe: %s IP: %d vector: %u",
1943 s, data->ip, data->vector);
1945 len = fprintf(fp, " cfe: %u IP: %d vector: %u",
1946 data->type, data->ip, data->vector);
1948 for (i = 0; i < data->evd_cnt; i++) {
1949 unsigned int et = data->evd[i].evd_type & 0x3f;
1953 len += fprintf(fp, " %s: %#" PRIx64,
1954 s, data->evd[i].payload);
1956 len += fprintf(fp, " EVD_%u: %#" PRIx64,
1957 et, data->evd[i].payload);
1960 return len + perf_sample__fprintf_pt_spacing(len, fp);
1963 static int perf_sample__fprintf_synth_iflag_chg(struct perf_sample *sample, FILE *fp)
1965 struct perf_synth_intel_iflag_chg *data = perf_sample__synth_ptr(sample);
1968 if (perf_sample__bad_synth_size(sample, *data))
1971 len = fprintf(fp, " IFLAG: %d->%d %s branch", !data->iflag, data->iflag,
1972 data->via_branch ? "via" : "non");
1973 return len + perf_sample__fprintf_pt_spacing(len, fp);
1976 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1977 struct evsel *evsel, FILE *fp)
1979 switch (evsel->core.attr.config) {
1980 case PERF_SYNTH_INTEL_PTWRITE:
1981 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1982 case PERF_SYNTH_INTEL_MWAIT:
1983 return perf_sample__fprintf_synth_mwait(sample, fp);
1984 case PERF_SYNTH_INTEL_PWRE:
1985 return perf_sample__fprintf_synth_pwre(sample, fp);
1986 case PERF_SYNTH_INTEL_EXSTOP:
1987 return perf_sample__fprintf_synth_exstop(sample, fp);
1988 case PERF_SYNTH_INTEL_PWRX:
1989 return perf_sample__fprintf_synth_pwrx(sample, fp);
1990 case PERF_SYNTH_INTEL_CBR:
1991 return perf_sample__fprintf_synth_cbr(sample, fp);
1992 case PERF_SYNTH_INTEL_PSB:
1993 return perf_sample__fprintf_synth_psb(sample, fp);
1994 case PERF_SYNTH_INTEL_EVT:
1995 return perf_sample__fprintf_synth_evt(sample, fp);
1996 case PERF_SYNTH_INTEL_IFLAG_CHG:
1997 return perf_sample__fprintf_synth_iflag_chg(sample, fp);
2005 static int evlist__max_name_len(struct evlist *evlist)
2007 struct evsel *evsel;
2010 evlist__for_each_entry(evlist, evsel) {
2011 int len = strlen(evsel__name(evsel));
2013 max = MAX(len, max);
2019 static int data_src__fprintf(u64 data_src, FILE *fp)
2021 struct mem_info mi = { .data_src.val = data_src };
2027 perf_script__meminfo_scnprintf(decode, 100, &mi);
2029 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
2033 return fprintf(fp, "%-*s", maxlen, out);
2037 struct perf_sample *sample;
2038 struct thread *thread;
2039 struct evsel *evsel;
2043 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
2044 void *ctx, const char *color,
2046 const char *unit, double val)
2048 struct metric_ctx *mctx = ctx;
2052 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2053 PERF_RECORD_SAMPLE, mctx->fp);
2054 fputs("\tmetric: ", mctx->fp);
2056 color_fprintf(mctx->fp, color, fmt, val);
2059 fprintf(mctx->fp, " %s\n", unit);
2062 static void script_new_line(struct perf_stat_config *config __maybe_unused,
2065 struct metric_ctx *mctx = ctx;
2067 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2068 PERF_RECORD_SAMPLE, mctx->fp);
2069 fputs("\tmetric: ", mctx->fp);
2072 static void perf_sample__fprint_metric(struct perf_script *script,
2073 struct thread *thread,
2074 struct evsel *evsel,
2075 struct perf_sample *sample,
2078 struct evsel *leader = evsel__leader(evsel);
2079 struct perf_stat_output_ctx ctx = {
2080 .print_metric = script_print_metric,
2081 .new_line = script_new_line,
2082 .ctx = &(struct metric_ctx) {
2088 .force_header = false,
2094 evlist__alloc_stats(&stat_config, script->session->evlist, /*alloc_raw=*/false);
2095 if (evsel_script(leader)->gnum++ == 0)
2096 perf_stat__reset_shadow_stats();
2097 val = sample->period * evsel->scale;
2098 evsel_script(evsel)->val = val;
2099 if (evsel_script(leader)->gnum == leader->core.nr_members) {
2100 for_each_group_member (ev2, leader) {
2101 perf_stat__print_shadow_stats(&stat_config, ev2,
2102 evsel_script(ev2)->val,
2107 evsel_script(leader)->gnum = 0;
2111 static bool show_event(struct perf_sample *sample,
2112 struct evsel *evsel,
2113 struct thread *thread,
2114 struct addr_location *al,
2115 struct addr_location *addr_al)
2117 int depth = thread_stack__depth(thread, sample->cpu);
2119 if (!symbol_conf.graph_function)
2122 if (thread__filter(thread)) {
2123 if (depth <= thread__filter_entry_depth(thread)) {
2124 thread__set_filter(thread, false);
2129 const char *s = symbol_conf.graph_function;
2131 const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
2137 nlen = strlen(name);
2139 unsigned len = strcspn(s, ",");
2140 if (nlen == len && !strncmp(name, s, len)) {
2141 thread__set_filter(thread, true);
2142 thread__set_filter_entry_depth(thread, depth);
2153 static void process_event(struct perf_script *script,
2154 struct perf_sample *sample, struct evsel *evsel,
2155 struct addr_location *al,
2156 struct addr_location *addr_al,
2157 struct machine *machine)
2159 struct thread *thread = al->thread;
2160 struct perf_event_attr *attr = &evsel->core.attr;
2161 unsigned int type = output_type(attr->type);
2162 struct evsel_script *es = evsel->priv;
2164 char str[PAGE_SIZE_NAME_LEN];
2165 const char *arch = perf_env__arch(machine->env);
2167 if (output[type].fields == 0)
2172 perf_sample__fprintf_start(script, sample, thread, evsel,
2173 PERF_RECORD_SAMPLE, fp);
2175 if (PRINT_FIELD(PERIOD))
2176 fprintf(fp, "%10" PRIu64 " ", sample->period);
2178 if (PRINT_FIELD(EVNAME)) {
2179 const char *evname = evsel__name(evsel);
2181 if (!script->name_width)
2182 script->name_width = evlist__max_name_len(script->session->evlist);
2184 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2188 perf_sample__fprintf_flags(sample->flags, fp);
2190 if (is_bts_event(attr)) {
2191 perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2194 #ifdef HAVE_LIBTRACEEVENT
2195 if (PRINT_FIELD(TRACE) && sample->raw_data) {
2196 event_format__fprintf(evsel->tp_format, sample->cpu,
2197 sample->raw_data, sample->raw_size, fp);
2200 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2201 perf_sample__fprintf_synth(sample, evsel, fp);
2203 if (PRINT_FIELD(ADDR))
2204 perf_sample__fprintf_addr(sample, thread, attr, fp);
2206 if (PRINT_FIELD(DATA_SRC))
2207 data_src__fprintf(sample->data_src, fp);
2209 if (PRINT_FIELD(WEIGHT))
2210 fprintf(fp, "%16" PRIu64, sample->weight);
2212 if (PRINT_FIELD(INS_LAT))
2213 fprintf(fp, "%16" PRIu16, sample->ins_lat);
2215 if (PRINT_FIELD(RETIRE_LAT))
2216 fprintf(fp, "%16" PRIu16, sample->retire_lat);
2218 if (PRINT_FIELD(CGROUP)) {
2219 const char *cgrp_name;
2220 struct cgroup *cgrp = cgroup__find(machine->env,
2223 cgrp_name = cgrp->name;
2225 cgrp_name = "unknown";
2226 fprintf(fp, " %s", cgrp_name);
2229 if (PRINT_FIELD(IP)) {
2230 struct callchain_cursor *cursor = NULL;
2232 if (script->stitch_lbr)
2233 thread__set_lbr_stitch_enable(al->thread, true);
2235 if (symbol_conf.use_callchain && sample->callchain) {
2236 cursor = get_tls_callchain_cursor();
2237 if (thread__resolve_callchain(al->thread, cursor, evsel,
2239 scripting_max_stack))
2242 fputc(cursor ? '\n' : ' ', fp);
2243 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2244 symbol_conf.bt_stop_list, fp);
2247 if (PRINT_FIELD(IREGS))
2248 perf_sample__fprintf_iregs(sample, attr, arch, fp);
2250 if (PRINT_FIELD(UREGS))
2251 perf_sample__fprintf_uregs(sample, attr, arch, fp);
2253 if (PRINT_FIELD(BRSTACK))
2254 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2255 else if (PRINT_FIELD(BRSTACKSYM))
2256 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2257 else if (PRINT_FIELD(BRSTACKOFF))
2258 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2260 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2261 perf_sample__fprintf_bpf_output(sample, fp);
2262 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2264 if (PRINT_FIELD(PHYS_ADDR))
2265 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2267 if (PRINT_FIELD(DATA_PAGE_SIZE))
2268 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2270 if (PRINT_FIELD(CODE_PAGE_SIZE))
2271 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2273 perf_sample__fprintf_ipc(sample, attr, fp);
2277 if (PRINT_FIELD(SRCCODE)) {
2278 if (map__fprintf_srccode(al->map, al->addr, stdout,
2279 thread__srccode_state(thread)))
2283 if (PRINT_FIELD(METRIC))
2284 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2290 static struct scripting_ops *scripting_ops;
2292 static void __process_stat(struct evsel *counter, u64 tstamp)
2294 int nthreads = perf_thread_map__nr(counter->core.threads);
2296 struct perf_cpu cpu;
2297 static int header_printed;
2299 if (!header_printed) {
2300 printf("%3s %8s %15s %15s %15s %15s %s\n",
2301 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2305 for (thread = 0; thread < nthreads; thread++) {
2306 perf_cpu_map__for_each_cpu(cpu, idx, evsel__cpus(counter)) {
2307 struct perf_counts_values *counts;
2309 counts = perf_counts(counter->counts, idx, thread);
2311 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2313 perf_thread_map__pid(counter->core.threads, thread),
2318 evsel__name(counter));
2323 static void process_stat(struct evsel *counter, u64 tstamp)
2325 if (scripting_ops && scripting_ops->process_stat)
2326 scripting_ops->process_stat(&stat_config, counter, tstamp);
2328 __process_stat(counter, tstamp);
2331 static void process_stat_interval(u64 tstamp)
2333 if (scripting_ops && scripting_ops->process_stat_interval)
2334 scripting_ops->process_stat_interval(tstamp);
2337 static void setup_scripting(void)
2339 #ifdef HAVE_LIBTRACEEVENT
2340 setup_perl_scripting();
2342 setup_python_scripting();
2345 static int flush_scripting(void)
2347 return scripting_ops ? scripting_ops->flush_script() : 0;
2350 static int cleanup_scripting(void)
2352 pr_debug("\nperf script stopped\n");
2354 return scripting_ops ? scripting_ops->stop_script() : 0;
2357 static bool filter_cpu(struct perf_sample *sample)
2359 if (cpu_list && sample->cpu != (u32)-1)
2360 return !test_bit(sample->cpu, cpu_bitmap);
2364 static int process_sample_event(struct perf_tool *tool,
2365 union perf_event *event,
2366 struct perf_sample *sample,
2367 struct evsel *evsel,
2368 struct machine *machine)
2370 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2371 struct addr_location al;
2372 struct addr_location addr_al;
2375 /* Set thread to NULL to indicate addr_al and al are not initialized */
2376 addr_location__init(&al);
2377 addr_location__init(&addr_al);
2379 ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2386 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2392 if (sample->time < last_timestamp) {
2393 pr_err("Samples misordered, previous: %" PRIu64
2394 " this: %" PRIu64 "\n", last_timestamp,
2398 last_timestamp = sample->time;
2402 if (filter_cpu(sample))
2405 if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2406 pr_err("problem processing %d event, skipping it.\n",
2407 event->header.type);
2415 if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2418 if (evswitch__discard(&scr->evswitch, evsel))
2421 ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2428 if (scripting_ops) {
2429 struct addr_location *addr_al_ptr = NULL;
2431 if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2432 sample_addr_correlates_sym(&evsel->core.attr)) {
2433 if (!addr_al.thread)
2434 thread__resolve(al.thread, &addr_al, sample);
2435 addr_al_ptr = &addr_al;
2437 scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2439 process_event(scr, sample, evsel, &al, &addr_al, machine);
2443 addr_location__exit(&addr_al);
2444 addr_location__exit(&al);
2448 // Used when scr->per_event_dump is not set
2449 static struct evsel_script es_stdout;
2451 static int process_attr(struct perf_tool *tool, union perf_event *event,
2452 struct evlist **pevlist)
2454 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2455 struct evlist *evlist;
2456 struct evsel *evsel, *pos;
2460 err = perf_event__process_attr(tool, event, pevlist);
2465 evsel = evlist__last(*pevlist);
2468 if (scr->per_event_dump) {
2469 evsel->priv = evsel_script__new(evsel, scr->session->data);
2472 } else { // Replicate what is done in perf_script__setup_per_event_dump()
2473 es_stdout.fp = stdout;
2474 evsel->priv = &es_stdout;
2478 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2479 evsel->core.attr.type != PERF_TYPE_SYNTH)
2482 evlist__for_each_entry(evlist, pos) {
2483 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2487 if (evsel->core.attr.sample_type) {
2488 err = evsel__check_attr(evsel, scr->session);
2494 * Check if we need to enable callchains based
2495 * on events sample_type.
2497 sample_type = evlist__combined_sample_type(evlist);
2498 callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
2500 /* Enable fields for callchain entries */
2501 if (symbol_conf.use_callchain &&
2502 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2503 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2504 (sample_type & PERF_SAMPLE_REGS_USER &&
2505 sample_type & PERF_SAMPLE_STACK_USER))) {
2506 int type = output_type(evsel->core.attr.type);
2508 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2509 output[type].fields |= PERF_OUTPUT_IP;
2510 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2511 output[type].fields |= PERF_OUTPUT_SYM;
2513 set_print_ip_opts(&evsel->core.attr);
2517 static int print_event_with_time(struct perf_tool *tool,
2518 union perf_event *event,
2519 struct perf_sample *sample,
2520 struct machine *machine,
2521 pid_t pid, pid_t tid, u64 timestamp)
2523 struct perf_script *script = container_of(tool, struct perf_script, tool);
2524 struct perf_session *session = script->session;
2525 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2526 struct thread *thread = NULL;
2528 if (evsel && !evsel->core.attr.sample_id_all) {
2530 sample->time = timestamp;
2535 if (filter_cpu(sample))
2539 thread = machine__findnew_thread(machine, pid, tid);
2542 perf_sample__fprintf_start(script, sample, thread, evsel,
2543 event->header.type, stdout);
2546 perf_event__fprintf(event, machine, stdout);
2548 thread__put(thread);
2553 static int print_event(struct perf_tool *tool, union perf_event *event,
2554 struct perf_sample *sample, struct machine *machine,
2555 pid_t pid, pid_t tid)
2557 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2560 static int process_comm_event(struct perf_tool *tool,
2561 union perf_event *event,
2562 struct perf_sample *sample,
2563 struct machine *machine)
2565 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2568 return print_event(tool, event, sample, machine, event->comm.pid,
2572 static int process_namespaces_event(struct perf_tool *tool,
2573 union perf_event *event,
2574 struct perf_sample *sample,
2575 struct machine *machine)
2577 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2580 return print_event(tool, event, sample, machine, event->namespaces.pid,
2581 event->namespaces.tid);
2584 static int process_cgroup_event(struct perf_tool *tool,
2585 union perf_event *event,
2586 struct perf_sample *sample,
2587 struct machine *machine)
2589 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2592 return print_event(tool, event, sample, machine, sample->pid,
2596 static int process_fork_event(struct perf_tool *tool,
2597 union perf_event *event,
2598 struct perf_sample *sample,
2599 struct machine *machine)
2601 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2604 return print_event_with_time(tool, event, sample, machine,
2605 event->fork.pid, event->fork.tid,
2608 static int process_exit_event(struct perf_tool *tool,
2609 union perf_event *event,
2610 struct perf_sample *sample,
2611 struct machine *machine)
2613 /* Print before 'exit' deletes anything */
2614 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2615 event->fork.tid, event->fork.time))
2618 return perf_event__process_exit(tool, event, sample, machine);
2621 static int process_mmap_event(struct perf_tool *tool,
2622 union perf_event *event,
2623 struct perf_sample *sample,
2624 struct machine *machine)
2626 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2629 return print_event(tool, event, sample, machine, event->mmap.pid,
2633 static int process_mmap2_event(struct perf_tool *tool,
2634 union perf_event *event,
2635 struct perf_sample *sample,
2636 struct machine *machine)
2638 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2641 return print_event(tool, event, sample, machine, event->mmap2.pid,
2645 static int process_switch_event(struct perf_tool *tool,
2646 union perf_event *event,
2647 struct perf_sample *sample,
2648 struct machine *machine)
2650 struct perf_script *script = container_of(tool, struct perf_script, tool);
2652 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2655 if (scripting_ops && scripting_ops->process_switch && !filter_cpu(sample))
2656 scripting_ops->process_switch(event, sample, machine);
2658 if (!script->show_switch_events)
2661 return print_event(tool, event, sample, machine, sample->pid,
2665 static int process_auxtrace_error(struct perf_session *session,
2666 union perf_event *event)
2668 if (scripting_ops && scripting_ops->process_auxtrace_error) {
2669 scripting_ops->process_auxtrace_error(session, event);
2673 return perf_event__process_auxtrace_error(session, event);
2677 process_lost_event(struct perf_tool *tool,
2678 union perf_event *event,
2679 struct perf_sample *sample,
2680 struct machine *machine)
2682 return print_event(tool, event, sample, machine, sample->pid,
2687 process_throttle_event(struct perf_tool *tool __maybe_unused,
2688 union perf_event *event,
2689 struct perf_sample *sample,
2690 struct machine *machine)
2692 if (scripting_ops && scripting_ops->process_throttle)
2693 scripting_ops->process_throttle(event, sample, machine);
2698 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2699 union perf_event *event,
2700 struct ordered_events *oe __maybe_unused)
2703 perf_event__fprintf(event, NULL, stdout);
2708 process_bpf_events(struct perf_tool *tool __maybe_unused,
2709 union perf_event *event,
2710 struct perf_sample *sample,
2711 struct machine *machine)
2713 if (machine__process_ksymbol(machine, event, sample) < 0)
2716 return print_event(tool, event, sample, machine, sample->pid,
2720 static int process_text_poke_events(struct perf_tool *tool,
2721 union perf_event *event,
2722 struct perf_sample *sample,
2723 struct machine *machine)
2725 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2728 return print_event(tool, event, sample, machine, sample->pid,
2732 static void sig_handler(int sig __maybe_unused)
2737 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2739 struct evlist *evlist = script->session->evlist;
2740 struct evsel *evsel;
2742 evlist__for_each_entry(evlist, evsel) {
2745 evsel_script__delete(evsel->priv);
2750 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2752 struct evsel *evsel;
2754 evlist__for_each_entry(script->session->evlist, evsel) {
2756 * Already setup? I.e. we may be called twice in cases like
2757 * Intel PT, one for the intel_pt// and dummy events, then
2758 * for the evsels synthesized from the auxtrace info.
2760 * Ses perf_script__process_auxtrace_info.
2762 if (evsel->priv != NULL)
2765 evsel->priv = evsel_script__new(evsel, script->session->data);
2766 if (evsel->priv == NULL)
2767 goto out_err_fclose;
2773 perf_script__fclose_per_event_dump(script);
2777 static int perf_script__setup_per_event_dump(struct perf_script *script)
2779 struct evsel *evsel;
2781 if (script->per_event_dump)
2782 return perf_script__fopen_per_event_dump(script);
2784 es_stdout.fp = stdout;
2786 evlist__for_each_entry(script->session->evlist, evsel)
2787 evsel->priv = &es_stdout;
2792 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2794 struct evsel *evsel;
2796 evlist__for_each_entry(script->session->evlist, evsel) {
2797 struct evsel_script *es = evsel->priv;
2799 evsel_script__fprintf(es, stdout);
2800 evsel_script__delete(es);
2805 static void perf_script__exit(struct perf_script *script)
2807 perf_thread_map__put(script->threads);
2808 perf_cpu_map__put(script->cpus);
2811 static int __cmd_script(struct perf_script *script)
2815 signal(SIGINT, sig_handler);
2817 /* override event processing functions */
2818 if (script->show_task_events) {
2819 script->tool.comm = process_comm_event;
2820 script->tool.fork = process_fork_event;
2821 script->tool.exit = process_exit_event;
2823 if (script->show_mmap_events) {
2824 script->tool.mmap = process_mmap_event;
2825 script->tool.mmap2 = process_mmap2_event;
2827 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2828 script->tool.context_switch = process_switch_event;
2829 if (scripting_ops && scripting_ops->process_auxtrace_error)
2830 script->tool.auxtrace_error = process_auxtrace_error;
2831 if (script->show_namespace_events)
2832 script->tool.namespaces = process_namespaces_event;
2833 if (script->show_cgroup_events)
2834 script->tool.cgroup = process_cgroup_event;
2835 if (script->show_lost_events)
2836 script->tool.lost = process_lost_event;
2837 if (script->show_round_events) {
2838 script->tool.ordered_events = false;
2839 script->tool.finished_round = process_finished_round_event;
2841 if (script->show_bpf_events) {
2842 script->tool.ksymbol = process_bpf_events;
2843 script->tool.bpf = process_bpf_events;
2845 if (script->show_text_poke_events) {
2846 script->tool.ksymbol = process_bpf_events;
2847 script->tool.text_poke = process_text_poke_events;
2850 if (perf_script__setup_per_event_dump(script)) {
2851 pr_err("Couldn't create the per event dump files\n");
2855 ret = perf_session__process_events(script->session);
2857 if (script->per_event_dump)
2858 perf_script__exit_per_event_dump_stats(script);
2861 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2866 struct script_spec {
2867 struct list_head node;
2868 struct scripting_ops *ops;
2872 static LIST_HEAD(script_specs);
2874 static struct script_spec *script_spec__new(const char *spec,
2875 struct scripting_ops *ops)
2877 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2880 strcpy(s->spec, spec);
2887 static void script_spec__add(struct script_spec *s)
2889 list_add_tail(&s->node, &script_specs);
2892 static struct script_spec *script_spec__find(const char *spec)
2894 struct script_spec *s;
2896 list_for_each_entry(s, &script_specs, node)
2897 if (strcasecmp(s->spec, spec) == 0)
2902 int script_spec_register(const char *spec, struct scripting_ops *ops)
2904 struct script_spec *s;
2906 s = script_spec__find(spec);
2910 s = script_spec__new(spec, ops);
2914 script_spec__add(s);
2919 static struct scripting_ops *script_spec__lookup(const char *spec)
2921 struct script_spec *s = script_spec__find(spec);
2928 static void list_available_languages(void)
2930 struct script_spec *s;
2932 fprintf(stderr, "\n");
2933 fprintf(stderr, "Scripting language extensions (used in "
2934 "perf script -s [spec:]script.[spec]):\n\n");
2936 list_for_each_entry(s, &script_specs, node)
2937 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2939 fprintf(stderr, "\n");
2942 /* Find script file relative to current directory or exec path */
2943 static char *find_script(const char *script)
2945 char path[PATH_MAX];
2947 if (!scripting_ops) {
2948 const char *ext = strrchr(script, '.');
2953 scripting_ops = script_spec__lookup(++ext);
2958 if (access(script, R_OK)) {
2959 char *exec_path = get_argv_exec_path();
2963 snprintf(path, sizeof(path), "%s/scripts/%s/%s",
2964 exec_path, scripting_ops->dirname, script);
2967 if (access(script, R_OK))
2970 return strdup(script);
2973 static int parse_scriptname(const struct option *opt __maybe_unused,
2974 const char *str, int unset __maybe_unused)
2976 char spec[PATH_MAX];
2977 const char *script, *ext;
2980 if (strcmp(str, "lang") == 0) {
2981 list_available_languages();
2985 script = strchr(str, ':');
2988 if (len >= PATH_MAX) {
2989 fprintf(stderr, "invalid language specifier");
2992 strncpy(spec, str, len);
2994 scripting_ops = script_spec__lookup(spec);
2995 if (!scripting_ops) {
2996 fprintf(stderr, "invalid language specifier");
3002 ext = strrchr(script, '.');
3004 fprintf(stderr, "invalid script extension");
3007 scripting_ops = script_spec__lookup(++ext);
3008 if (!scripting_ops) {
3009 fprintf(stderr, "invalid script extension");
3014 script_name = find_script(script);
3016 script_name = strdup(script);
3021 static int parse_output_fields(const struct option *opt __maybe_unused,
3022 const char *arg, int unset __maybe_unused)
3024 char *tok, *strtok_saveptr = NULL;
3025 int i, imax = ARRAY_SIZE(all_output_options);
3028 char *str = strdup(arg);
3030 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
3035 /* first word can state for which event type the user is specifying
3036 * the fields. If no type exists, the specified fields apply to all
3037 * event types found in the file minus the invalid fields for a type.
3039 tok = strchr(str, ':');
3043 if (!strcmp(str, "hw"))
3044 type = PERF_TYPE_HARDWARE;
3045 else if (!strcmp(str, "sw"))
3046 type = PERF_TYPE_SOFTWARE;
3047 else if (!strcmp(str, "trace"))
3048 type = PERF_TYPE_TRACEPOINT;
3049 else if (!strcmp(str, "raw"))
3050 type = PERF_TYPE_RAW;
3051 else if (!strcmp(str, "break"))
3052 type = PERF_TYPE_BREAKPOINT;
3053 else if (!strcmp(str, "synth"))
3054 type = OUTPUT_TYPE_SYNTH;
3056 fprintf(stderr, "Invalid event type in field string.\n");
3061 if (output[type].user_set)
3062 pr_warning("Overriding previous field request for %s events.\n",
3065 /* Don't override defaults for +- */
3066 if (strchr(tok, '+') || strchr(tok, '-'))
3069 output[type].fields = 0;
3070 output[type].user_set = true;
3071 output[type].wildcard_set = false;
3075 if (strlen(str) == 0) {
3077 "Cannot set fields to 'none' for all event types.\n");
3082 /* Don't override defaults for +- */
3083 if (strchr(str, '+') || strchr(str, '-'))
3086 if (output_set_by_user())
3087 pr_warning("Overriding previous field request for all events.\n");
3089 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3090 output[j].fields = 0;
3091 output[j].user_set = true;
3092 output[j].wildcard_set = true;
3097 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
3103 } else if (*tok == '-') {
3109 if (change != SET && change != DEFAULT)
3114 for (i = 0; i < imax; ++i) {
3115 if (strcmp(tok, all_output_options[i].str) == 0)
3118 if (i == imax && strcmp(tok, "flags") == 0) {
3119 print_flags = change != REMOVE;
3123 fprintf(stderr, "Invalid field requested.\n");
3127 #ifndef HAVE_LIBCAPSTONE_SUPPORT
3128 if (change != REMOVE && strcmp(tok, "disasm") == 0) {
3129 fprintf(stderr, "Field \"disasm\" requires perf to be built with libcapstone support.\n");
3136 /* add user option to all events types for
3139 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3140 if (output[j].invalid_fields & all_output_options[i].field) {
3141 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
3142 all_output_options[i].str, event_type(j));
3144 if (change == REMOVE) {
3145 output[j].fields &= ~all_output_options[i].field;
3146 output[j].user_set_fields &= ~all_output_options[i].field;
3147 output[j].user_unset_fields |= all_output_options[i].field;
3149 output[j].fields |= all_output_options[i].field;
3150 output[j].user_set_fields |= all_output_options[i].field;
3151 output[j].user_unset_fields &= ~all_output_options[i].field;
3153 output[j].user_set = true;
3154 output[j].wildcard_set = true;
3158 if (output[type].invalid_fields & all_output_options[i].field) {
3159 fprintf(stderr, "\'%s\' not valid for %s events.\n",
3160 all_output_options[i].str, event_type(type));
3165 if (change == REMOVE)
3166 output[type].fields &= ~all_output_options[i].field;
3168 output[type].fields |= all_output_options[i].field;
3169 output[type].user_set = true;
3170 output[type].wildcard_set = true;
3175 if (output[type].fields == 0) {
3176 pr_debug("No fields requested for %s type. "
3177 "Events will not be displayed.\n", event_type(type));
3183 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
3190 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
3191 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
3192 if ((lang_dirent->d_type == DT_DIR || \
3193 (lang_dirent->d_type == DT_UNKNOWN && \
3194 is_directory(scripts_path, lang_dirent))) && \
3195 (strcmp(lang_dirent->d_name, ".")) && \
3196 (strcmp(lang_dirent->d_name, "..")))
3198 #define for_each_script(lang_path, lang_dir, script_dirent) \
3199 while ((script_dirent = readdir(lang_dir)) != NULL) \
3200 if (script_dirent->d_type != DT_DIR && \
3201 (script_dirent->d_type != DT_UNKNOWN || \
3202 !is_directory(lang_path, script_dirent)))
3205 #define RECORD_SUFFIX "-record"
3206 #define REPORT_SUFFIX "-report"
3208 struct script_desc {
3209 struct list_head node;
3215 static LIST_HEAD(script_descs);
3217 static struct script_desc *script_desc__new(const char *name)
3219 struct script_desc *s = zalloc(sizeof(*s));
3221 if (s != NULL && name)
3222 s->name = strdup(name);
3227 static void script_desc__delete(struct script_desc *s)
3230 zfree(&s->half_liner);
3235 static void script_desc__add(struct script_desc *s)
3237 list_add_tail(&s->node, &script_descs);
3240 static struct script_desc *script_desc__find(const char *name)
3242 struct script_desc *s;
3244 list_for_each_entry(s, &script_descs, node)
3245 if (strcasecmp(s->name, name) == 0)
3250 static struct script_desc *script_desc__findnew(const char *name)
3252 struct script_desc *s = script_desc__find(name);
3257 s = script_desc__new(name);
3261 script_desc__add(s);
3266 static const char *ends_with(const char *str, const char *suffix)
3268 size_t suffix_len = strlen(suffix);
3269 const char *p = str;
3271 if (strlen(str) > suffix_len) {
3272 p = str + strlen(str) - suffix_len;
3273 if (!strncmp(p, suffix, suffix_len))
3280 static int read_script_info(struct script_desc *desc, const char *filename)
3282 char line[BUFSIZ], *p;
3285 fp = fopen(filename, "r");
3289 while (fgets(line, sizeof(line), fp)) {
3290 p = skip_spaces(line);
3296 if (strlen(p) && *p == '!')
3300 if (strlen(p) && p[strlen(p) - 1] == '\n')
3301 p[strlen(p) - 1] = '\0';
3303 if (!strncmp(p, "description:", strlen("description:"))) {
3304 p += strlen("description:");
3305 desc->half_liner = strdup(skip_spaces(p));
3309 if (!strncmp(p, "args:", strlen("args:"))) {
3310 p += strlen("args:");
3311 desc->args = strdup(skip_spaces(p));
3321 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3323 char *script_root, *str;
3325 script_root = strdup(script_dirent->d_name);
3329 str = (char *)ends_with(script_root, suffix);
3339 static int list_available_scripts(const struct option *opt __maybe_unused,
3340 const char *s __maybe_unused,
3341 int unset __maybe_unused)
3343 struct dirent *script_dirent, *lang_dirent;
3344 char *buf, *scripts_path, *script_path, *lang_path, *first_half;
3345 DIR *scripts_dir, *lang_dir;
3346 struct script_desc *desc;
3349 buf = malloc(3 * MAXPATHLEN + BUFSIZ);
3351 pr_err("malloc failed\n");
3355 script_path = buf + MAXPATHLEN;
3356 lang_path = buf + 2 * MAXPATHLEN;
3357 first_half = buf + 3 * MAXPATHLEN;
3359 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3361 scripts_dir = opendir(scripts_path);
3364 "open(%s) failed.\n"
3365 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3371 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3372 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3373 lang_dirent->d_name);
3374 lang_dir = opendir(lang_path);
3378 for_each_script(lang_path, lang_dir, script_dirent) {
3379 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3381 desc = script_desc__findnew(script_root);
3382 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3383 lang_path, script_dirent->d_name);
3384 read_script_info(desc, script_path);
3390 fprintf(stdout, "List of available trace scripts:\n");
3391 list_for_each_entry(desc, &script_descs, node) {
3392 sprintf(first_half, "%s %s", desc->name,
3393 desc->args ? desc->args : "");
3394 fprintf(stdout, " %-36s %s\n", first_half,
3395 desc->half_liner ? desc->half_liner : "");
3402 static int add_dlarg(const struct option *opt __maybe_unused,
3403 const char *s, int unset __maybe_unused)
3405 char *arg = strdup(s);
3411 a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
3418 dlargv[dlargc++] = arg;
3423 static void free_dlarg(void)
3426 free(dlargv[dlargc]);
3431 * Some scripts specify the required events in their "xxx-record" file,
3432 * this function will check if the events in perf.data match those
3433 * mentioned in the "xxx-record".
3435 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3436 * which is covered well now. And new parsing code should be added to
3437 * cover the future complex formats like event groups etc.
3439 static int check_ev_match(char *dir_name, char *scriptname,
3440 struct perf_session *session)
3442 char filename[MAXPATHLEN], evname[128];
3443 char line[BUFSIZ], *p;
3448 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3450 fp = fopen(filename, "r");
3454 while (fgets(line, sizeof(line), fp)) {
3455 p = skip_spaces(line);
3460 p = strstr(p, "-e");
3466 len = strcspn(p, " \t");
3470 snprintf(evname, len + 1, "%s", p);
3473 evlist__for_each_entry(session->evlist, pos) {
3474 if (!strcmp(evsel__name(pos), evname)) {
3492 * Return -1 if none is found, otherwise the actual scripts number.
3494 * Currently the only user of this function is the script browser, which
3495 * will list all statically runnable scripts, select one, execute it and
3496 * show the output in a perf browser.
3498 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3501 struct dirent *script_dirent, *lang_dirent;
3502 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3503 DIR *scripts_dir, *lang_dir;
3504 struct perf_session *session;
3505 struct perf_data data = {
3507 .mode = PERF_DATA_MODE_READ,
3512 session = perf_session__new(&data, NULL);
3513 if (IS_ERR(session))
3514 return PTR_ERR(session);
3516 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3518 scripts_dir = opendir(scripts_path);
3520 perf_session__delete(session);
3524 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3525 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3526 lang_dirent->d_name);
3527 #ifndef HAVE_LIBPERL_SUPPORT
3528 if (strstr(lang_path, "perl"))
3531 #ifndef HAVE_LIBPYTHON_SUPPORT
3532 if (strstr(lang_path, "python"))
3536 lang_dir = opendir(lang_path);
3540 for_each_script(lang_path, lang_dir, script_dirent) {
3541 /* Skip those real time scripts: xxxtop.p[yl] */
3542 if (strstr(script_dirent->d_name, "top."))
3546 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3548 script_dirent->d_name);
3549 temp = strchr(script_dirent->d_name, '.');
3550 snprintf(scripts_array[i],
3551 (temp - script_dirent->d_name) + 1,
3552 "%s", script_dirent->d_name);
3554 if (check_ev_match(lang_path,
3555 scripts_array[i], session))
3563 closedir(scripts_dir);
3564 perf_session__delete(session);
3568 static char *get_script_path(const char *script_root, const char *suffix)
3570 struct dirent *script_dirent, *lang_dirent;
3571 char scripts_path[MAXPATHLEN];
3572 char script_path[MAXPATHLEN];
3573 DIR *scripts_dir, *lang_dir;
3574 char lang_path[MAXPATHLEN];
3575 char *__script_root;
3577 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3579 scripts_dir = opendir(scripts_path);
3583 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3584 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3585 lang_dirent->d_name);
3586 lang_dir = opendir(lang_path);
3590 for_each_script(lang_path, lang_dir, script_dirent) {
3591 __script_root = get_script_root(script_dirent, suffix);
3592 if (__script_root && !strcmp(script_root, __script_root)) {
3593 free(__script_root);
3594 closedir(scripts_dir);
3595 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3596 lang_path, script_dirent->d_name);
3598 return strdup(script_path);
3600 free(__script_root);
3604 closedir(scripts_dir);
3609 static bool is_top_script(const char *script_path)
3611 return ends_with(script_path, "top") != NULL;
3614 static int has_required_arg(char *script_path)
3616 struct script_desc *desc;
3620 desc = script_desc__new(NULL);
3622 if (read_script_info(desc, script_path))
3628 for (p = desc->args; *p; p++)
3632 script_desc__delete(desc);
3637 static int have_cmd(int argc, const char **argv)
3639 char **__argv = malloc(sizeof(const char *) * argc);
3642 pr_err("malloc failed\n");
3646 memcpy(__argv, argv, sizeof(const char *) * argc);
3647 argc = parse_options(argc, (const char **)__argv, record_options,
3648 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3651 system_wide = (argc == 0);
3656 static void script__setup_sample_type(struct perf_script *script)
3658 struct perf_session *session = script->session;
3659 u64 sample_type = evlist__combined_sample_type(session->evlist);
3661 callchain_param_setup(sample_type, perf_env__arch(session->machines.host.env));
3663 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3664 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3665 "Please apply --call-graph lbr when recording.\n");
3666 script->stitch_lbr = false;
3670 static int process_stat_round_event(struct perf_session *session,
3671 union perf_event *event)
3673 struct perf_record_stat_round *round = &event->stat_round;
3674 struct evsel *counter;
3676 evlist__for_each_entry(session->evlist, counter) {
3677 perf_stat_process_counter(&stat_config, counter);
3678 process_stat(counter, round->time);
3681 process_stat_interval(round->time);
3685 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3686 union perf_event *event)
3688 perf_event__read_stat_config(&stat_config, &event->stat_config);
3691 * Aggregation modes are not used since post-processing scripts are
3692 * supposed to take care of such requirements
3694 stat_config.aggr_mode = AGGR_NONE;
3699 static int set_maps(struct perf_script *script)
3701 struct evlist *evlist = script->session->evlist;
3703 if (!script->cpus || !script->threads)
3706 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3709 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3711 if (evlist__alloc_stats(&stat_config, evlist, /*alloc_raw=*/true))
3714 script->allocated = true;
3719 int process_thread_map_event(struct perf_session *session,
3720 union perf_event *event)
3722 struct perf_tool *tool = session->tool;
3723 struct perf_script *script = container_of(tool, struct perf_script, tool);
3726 perf_event__fprintf_thread_map(event, stdout);
3728 if (script->threads) {
3729 pr_warning("Extra thread map event, ignoring.\n");
3733 script->threads = thread_map__new_event(&event->thread_map);
3734 if (!script->threads)
3737 return set_maps(script);
3741 int process_cpu_map_event(struct perf_session *session,
3742 union perf_event *event)
3744 struct perf_tool *tool = session->tool;
3745 struct perf_script *script = container_of(tool, struct perf_script, tool);
3748 perf_event__fprintf_cpu_map(event, stdout);
3751 pr_warning("Extra cpu map event, ignoring.\n");
3755 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3759 return set_maps(script);
3762 static int process_feature_event(struct perf_session *session,
3763 union perf_event *event)
3765 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3766 return perf_event__process_feature(session, event);
3770 #ifdef HAVE_AUXTRACE_SUPPORT
3771 static int perf_script__process_auxtrace_info(struct perf_session *session,
3772 union perf_event *event)
3774 struct perf_tool *tool = session->tool;
3776 int ret = perf_event__process_auxtrace_info(session, event);
3779 struct perf_script *script = container_of(tool, struct perf_script, tool);
3781 ret = perf_script__setup_per_event_dump(script);
3787 #define perf_script__process_auxtrace_info 0
3790 static int parse_insn_trace(const struct option *opt __maybe_unused,
3791 const char *str, int unset __maybe_unused)
3793 const char *fields = "+insn,-event,-period";
3797 if (strcmp(str, "disasm") == 0)
3798 fields = "+disasm,-event,-period";
3799 else if (strlen(str) != 0 && strcmp(str, "raw") != 0) {
3800 fprintf(stderr, "Only accept raw|disasm\n");
3805 ret = parse_output_fields(NULL, fields, 0);
3809 itrace_parse_synth_opts(opt, "i0ns", 0);
3810 symbol_conf.nanosecs = true;
3814 static int parse_xed(const struct option *opt __maybe_unused,
3815 const char *str __maybe_unused,
3816 int unset __maybe_unused)
3819 force_pager("xed -F insn: -A -64 | less");
3821 force_pager("xed -F insn: -A -64");
3825 static int parse_call_trace(const struct option *opt __maybe_unused,
3826 const char *str __maybe_unused,
3827 int unset __maybe_unused)
3829 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3830 itrace_parse_synth_opts(opt, "cewp", 0);
3831 symbol_conf.nanosecs = true;
3832 symbol_conf.pad_output_len_dso = 50;
3836 static int parse_callret_trace(const struct option *opt __maybe_unused,
3837 const char *str __maybe_unused,
3838 int unset __maybe_unused)
3840 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3841 itrace_parse_synth_opts(opt, "crewp", 0);
3842 symbol_conf.nanosecs = true;
3846 int cmd_script(int argc, const char **argv)
3848 bool show_full_info = false;
3849 bool header = false;
3850 bool header_only = false;
3851 bool script_started = false;
3852 bool unsorted_dump = false;
3853 char *rec_script_path = NULL;
3854 char *rep_script_path = NULL;
3855 struct perf_session *session;
3856 struct itrace_synth_opts itrace_synth_opts = {
3858 .default_no_sample = true,
3861 char *script_path = NULL;
3862 const char *dlfilter_file = NULL;
3863 const char **__argv;
3865 struct perf_script script = {
3867 .sample = process_sample_event,
3868 .mmap = perf_event__process_mmap,
3869 .mmap2 = perf_event__process_mmap2,
3870 .comm = perf_event__process_comm,
3871 .namespaces = perf_event__process_namespaces,
3872 .cgroup = perf_event__process_cgroup,
3873 .exit = perf_event__process_exit,
3874 .fork = perf_event__process_fork,
3875 .attr = process_attr,
3876 .event_update = perf_event__process_event_update,
3877 #ifdef HAVE_LIBTRACEEVENT
3878 .tracing_data = perf_event__process_tracing_data,
3880 .feature = process_feature_event,
3881 .build_id = perf_event__process_build_id,
3882 .id_index = perf_event__process_id_index,
3883 .auxtrace_info = perf_script__process_auxtrace_info,
3884 .auxtrace = perf_event__process_auxtrace,
3885 .auxtrace_error = perf_event__process_auxtrace_error,
3886 .stat = perf_event__process_stat_event,
3887 .stat_round = process_stat_round_event,
3888 .stat_config = process_stat_config_event,
3889 .thread_map = process_thread_map_event,
3890 .cpu_map = process_cpu_map_event,
3891 .throttle = process_throttle_event,
3892 .unthrottle = process_throttle_event,
3893 .ordered_events = true,
3894 .ordering_requires_timestamps = true,
3897 struct perf_data data = {
3898 .mode = PERF_DATA_MODE_READ,
3900 const struct option options[] = {
3901 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3902 "dump raw trace in ASCII"),
3903 OPT_BOOLEAN(0, "dump-unsorted-raw-trace", &unsorted_dump,
3904 "dump unsorted raw trace in ASCII"),
3905 OPT_INCR('v', "verbose", &verbose,
3906 "be more verbose (show symbol address, etc)"),
3907 OPT_BOOLEAN('L', "Latency", &latency_format,
3908 "show latency attributes (irqs/preemption disabled, etc)"),
3909 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3910 list_available_scripts),
3911 OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
3912 list_available_dlfilters),
3913 OPT_CALLBACK('s', "script", NULL, "name",
3914 "script file name (lang:script name, script name, or *)",
3916 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3917 "generate perf-script.xx script in specified language"),
3918 OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3919 OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
3921 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3922 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3923 "do various checks like samples ordering and lost events"),
3924 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3925 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3926 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3927 "file", "vmlinux pathname"),
3928 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3929 "file", "kallsyms pathname"),
3930 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3931 "When printing symbols do not display call chain"),
3932 OPT_CALLBACK(0, "symfs", NULL, "directory",
3933 "Look for files with symbols relative to this directory",
3934 symbol__config_symfs),
3935 OPT_CALLBACK('F', "fields", NULL, "str",
3936 "comma separated output fields prepend with 'type:'. "
3937 "+field to add and -field to remove."
3938 "Valid types: hw,sw,trace,raw,synth. "
3939 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,dsoff,"
3940 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3941 "brstacksym,flags,data_src,weight,bpf-output,brstackinsn,"
3942 "brstackinsnlen,brstackoff,callindent,insn,disasm,insnlen,synth,"
3943 "phys_addr,metric,misc,srccode,ipc,tod,data_page_size,"
3944 "code_page_size,ins_lat,machine_pid,vcpu,cgroup,retire_lat",
3945 parse_output_fields),
3946 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3947 "system-wide collection from all CPUs"),
3948 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3949 "only consider symbols in these DSOs"),
3950 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3951 "only consider these symbols"),
3952 OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3953 "Use with -S to list traced records within address range"),
3954 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, "raw|disasm",
3955 "Decode instructions from itrace", parse_insn_trace),
3956 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3957 "Run xed disassembler on output", parse_xed),
3958 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3959 "Decode calls from itrace", parse_call_trace),
3960 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3961 "Decode calls and returns from itrace", parse_callret_trace),
3962 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3963 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3964 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3965 "Stop display of callgraph at these symbols"),
3966 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3967 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3968 "only display events for these comms"),
3969 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3970 "only consider symbols in these pids"),
3971 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3972 "only consider symbols in these tids"),
3973 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3974 "Set the maximum stack depth when parsing the callchain, "
3975 "anything beyond the specified depth will be ignored. "
3976 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3977 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3978 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3979 OPT_BOOLEAN('I', "show-info", &show_full_info,
3980 "display extended information from perf.data file"),
3981 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3982 "Show the path of [kernel.kallsyms]"),
3983 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3984 "Show the fork/comm/exit events"),
3985 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3986 "Show the mmap events"),
3987 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3988 "Show context switch events (if recorded)"),
3989 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3990 "Show namespace events (if recorded)"),
3991 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3992 "Show cgroup events (if recorded)"),
3993 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3994 "Show lost events (if recorded)"),
3995 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3996 "Show round events (if recorded)"),
3997 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3998 "Show bpf related events (if recorded)"),
3999 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
4000 "Show text poke related events (if recorded)"),
4001 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
4002 "Dump trace output to files named by the monitored events"),
4003 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
4004 OPT_INTEGER(0, "max-blocks", &max_blocks,
4005 "Maximum number of code blocks to dump with brstackinsn"),
4006 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
4007 "Use 9 decimal places when displaying time"),
4008 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
4009 "Instruction Tracing options\n" ITRACE_HELP,
4010 itrace_parse_synth_opts),
4011 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
4012 "Show full source file name path for source lines"),
4013 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
4014 "Enable symbol demangling"),
4015 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
4016 "Enable kernel symbol demangling"),
4017 OPT_STRING(0, "time", &script.time_str, "str",
4018 "Time span of interest (start,stop)"),
4019 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
4020 "Show inline function"),
4021 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
4022 "guest mount directory under which every guest os"
4023 " instance has a subdir"),
4024 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
4025 "file", "file saving guest os vmlinux"),
4026 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
4027 "file", "file saving guest os /proc/kallsyms"),
4028 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
4029 "file", "file saving guest os /proc/modules"),
4030 OPT_BOOLEAN(0, "guest-code", &symbol_conf.guest_code,
4031 "Guest code can be found in hypervisor process"),
4032 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
4033 "Enable LBR callgraph stitching approach"),
4034 OPTS_EVSWITCH(&script.evswitch),
4037 const char * const script_subcommands[] = { "record", "report", NULL };
4038 const char *script_usage[] = {
4039 "perf script [<options>]",
4040 "perf script [<options>] record <script> [<record-options>] <command>",
4041 "perf script [<options>] report <script> [script-args]",
4042 "perf script [<options>] <script> [<record-options>] <command>",
4043 "perf script [<options>] <top-script> [script-args]",
4047 perf_set_singlethreaded();
4051 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
4052 PARSE_OPT_STOP_AT_NON_OPTION);
4054 if (symbol_conf.guestmount ||
4055 symbol_conf.default_guest_vmlinux_name ||
4056 symbol_conf.default_guest_kallsyms ||
4057 symbol_conf.default_guest_modules ||
4058 symbol_conf.guest_code) {
4060 * Enable guest sample processing.
4065 data.path = input_name;
4066 data.force = symbol_conf.force;
4068 if (unsorted_dump) {
4070 script.tool.ordered_events = false;
4073 if (symbol__validate_sym_arguments())
4076 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
4077 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
4078 if (!rec_script_path)
4079 return cmd_record(argc, argv);
4082 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("report", argv[0])) {
4083 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
4084 if (!rep_script_path) {
4086 "Please specify a valid report script"
4087 "(see 'perf script -l' for listing)\n");
4092 if (reltime && deltatime) {
4094 "reltime and deltatime - the two don't get along well. "
4095 "Please limit to --reltime or --deltatime.\n");
4099 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
4100 itrace_synth_opts.callchain_sz > scripting_max_stack)
4101 scripting_max_stack = itrace_synth_opts.callchain_sz;
4103 /* make sure PERF_EXEC_PATH is set for scripts */
4104 set_argv_exec_path(get_argv_exec_path());
4106 if (argc && !script_name && !rec_script_path && !rep_script_path) {
4111 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
4112 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
4114 if (!rec_script_path && !rep_script_path) {
4115 script_name = find_script(argv[0]);
4121 usage_with_options_msg(script_usage, options,
4122 "Couldn't find script `%s'\n\n See perf"
4123 " script -l for available scripts.\n", argv[0]);
4126 if (is_top_script(argv[0])) {
4127 rep_args = argc - 1;
4131 rep_args = has_required_arg(rep_script_path);
4132 rec_args = (argc - 1) - rep_args;
4134 usage_with_options_msg(script_usage, options,
4135 "`%s' script requires options."
4136 "\n\n See perf script -l for available "
4137 "scripts and options.\n", argv[0]);
4141 if (pipe(live_pipe) < 0) {
4142 perror("failed to create pipe");
4148 perror("failed to fork");
4155 dup2(live_pipe[1], 1);
4156 close(live_pipe[0]);
4158 if (is_top_script(argv[0])) {
4160 } else if (!system_wide) {
4161 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
4167 __argv = malloc((argc + 6) * sizeof(const char *));
4169 pr_err("malloc failed\n");
4174 __argv[j++] = "/bin/sh";
4175 __argv[j++] = rec_script_path;
4181 for (i = rep_args + 1; i < argc; i++)
4182 __argv[j++] = argv[i];
4185 execvp("/bin/sh", (char **)__argv);
4190 dup2(live_pipe[0], 0);
4191 close(live_pipe[1]);
4193 __argv = malloc((argc + 4) * sizeof(const char *));
4195 pr_err("malloc failed\n");
4201 __argv[j++] = "/bin/sh";
4202 __argv[j++] = rep_script_path;
4203 for (i = 1; i < rep_args + 1; i++)
4204 __argv[j++] = argv[i];
4209 execvp("/bin/sh", (char **)__argv);
4214 if (rec_script_path)
4215 script_path = rec_script_path;
4216 if (rep_script_path)
4217 script_path = rep_script_path;
4222 if (!rec_script_path)
4223 system_wide = false;
4224 else if (!system_wide) {
4225 if (have_cmd(argc - 1, &argv[1]) != 0) {
4231 __argv = malloc((argc + 2) * sizeof(const char *));
4233 pr_err("malloc failed\n");
4238 __argv[j++] = "/bin/sh";
4239 __argv[j++] = script_path;
4242 for (i = 2; i < argc; i++)
4243 __argv[j++] = argv[i];
4246 execvp("/bin/sh", (char **)__argv);
4251 if (dlfilter_file) {
4252 dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4262 session = perf_session__new(&data, &script.tool);
4263 if (IS_ERR(session))
4264 return PTR_ERR(session);
4266 if (header || header_only) {
4267 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4268 perf_session__fprintf_info(session, stdout, show_full_info);
4273 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4275 if (symbol__init(&session->header.env) < 0)
4279 if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4281 } else if (session->header.env.arch) {
4282 if (!strcmp(uts.machine, session->header.env.arch))
4284 else if (!strcmp(uts.machine, "x86_64") &&
4285 !strcmp(session->header.env.arch, "i386"))
4289 script.session = session;
4290 script__setup_sample_type(&script);
4292 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
4293 symbol_conf.graph_function)
4294 itrace_synth_opts.thread_stack = true;
4296 session->itrace_synth_opts = &itrace_synth_opts;
4299 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4302 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4306 symbol_conf.use_callchain = true;
4308 symbol_conf.use_callchain = false;
4310 #ifdef HAVE_LIBTRACEEVENT
4311 if (session->tevent.pevent &&
4312 tep_set_function_resolver(session->tevent.pevent,
4313 machine__resolve_kernel_addr,
4314 &session->machines.host) < 0) {
4315 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4320 if (generate_script_lang) {
4321 struct stat perf_stat;
4324 if (output_set_by_user()) {
4326 "custom fields not supported for generated scripts");
4331 input = open(data.path, O_RDONLY); /* input_name */
4334 perror("failed to open file");
4338 err = fstat(input, &perf_stat);
4340 perror("failed to stat file");
4344 if (!perf_stat.st_size) {
4345 fprintf(stderr, "zero-sized file, nothing to do!\n");
4349 scripting_ops = script_spec__lookup(generate_script_lang);
4350 if (!scripting_ops) {
4351 fprintf(stderr, "invalid language specifier");
4355 #ifdef HAVE_LIBTRACEEVENT
4356 err = scripting_ops->generate_script(session->tevent.pevent,
4359 err = scripting_ops->generate_script(NULL, "perf-script");
4364 err = dlfilter__start(dlfilter, session);
4369 err = scripting_ops->start_script(script_name, argc, argv, session);
4372 pr_debug("perf script started with script %s\n\n", script_name);
4373 script_started = true;
4377 err = perf_session__check_output_opt(session);
4381 if (script.time_str) {
4382 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4383 &script.ptime_range,
4390 itrace_synth_opts__set_time_range(&itrace_synth_opts,
4395 err = evswitch__init(&script.evswitch, session->evlist, stderr);
4399 if (zstd_init(&(session->zstd_data), 0) < 0)
4400 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4402 err = __cmd_script(&script);
4406 if (verbose > 2 || debug_kmaps)
4407 perf_session__dump_kmaps(session);
4410 if (script.ptime_range) {
4411 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4412 zfree(&script.ptime_range);
4415 zstd_fini(&(session->zstd_data));
4416 evlist__free_stats(session->evlist);
4417 perf_session__delete(session);
4418 perf_script__exit(&script);
4421 cleanup_scripting();
4422 dlfilter__cleanup(dlfilter);