Loading...
1// SPDX-License-Identifier: GPL-2.0
2#include "builtin.h"
3
4#include "util/counts.h"
5#include "util/debug.h"
6#include "util/dso.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"
13#include "util/map.h"
14#include "util/srcline.h"
15#include "util/symbol.h"
16#include "util/thread.h"
17#include "util/trace-event.h"
18#include "util/env.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"
35#include "util/mem-info.h"
36#include "ui/ui.h"
37#include "print_binary.h"
38#include "print_insn.h"
39#include "archinsn.h"
40#include <linux/bitmap.h>
41#include <linux/kernel.h>
42#include <linux/stringify.h>
43#include <linux/time64.h>
44#include <linux/zalloc.h>
45#include <sys/utsname.h>
46#include "asm/bug.h"
47#include "util/mem-events.h"
48#include "util/dump-insn.h"
49#include <dirent.h>
50#include <errno.h>
51#include <inttypes.h>
52#include <signal.h>
53#include <sys/param.h>
54#include <sys/types.h>
55#include <sys/stat.h>
56#include <fcntl.h>
57#include <unistd.h>
58#include <subcmd/pager.h>
59#include <perf/evlist.h>
60#include <linux/err.h>
61#include "util/dlfilter.h"
62#include "util/record.h"
63#include "util/util.h"
64#include "util/cgroup.h"
65#include "util/annotate.h"
66#include "perf.h"
67
68#include <linux/ctype.h>
69#ifdef HAVE_LIBTRACEEVENT
70#include <event-parse.h>
71#endif
72
73static char const *script_name;
74static char const *generate_script_lang;
75static bool reltime;
76static bool deltatime;
77static u64 initial_time;
78static u64 previous_time;
79static bool debug_mode;
80static u64 last_timestamp;
81static u64 nr_unordered;
82static bool no_callchain;
83static bool latency_format;
84static bool system_wide;
85static bool print_flags;
86static const char *cpu_list;
87static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
88static struct perf_stat_config stat_config;
89static int max_blocks;
90static bool native_arch;
91static struct dlfilter *dlfilter;
92static int dlargc;
93static char **dlargv;
94
95unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
96
97enum perf_output_field {
98 PERF_OUTPUT_COMM = 1ULL << 0,
99 PERF_OUTPUT_TID = 1ULL << 1,
100 PERF_OUTPUT_PID = 1ULL << 2,
101 PERF_OUTPUT_TIME = 1ULL << 3,
102 PERF_OUTPUT_CPU = 1ULL << 4,
103 PERF_OUTPUT_EVNAME = 1ULL << 5,
104 PERF_OUTPUT_TRACE = 1ULL << 6,
105 PERF_OUTPUT_IP = 1ULL << 7,
106 PERF_OUTPUT_SYM = 1ULL << 8,
107 PERF_OUTPUT_DSO = 1ULL << 9,
108 PERF_OUTPUT_ADDR = 1ULL << 10,
109 PERF_OUTPUT_SYMOFFSET = 1ULL << 11,
110 PERF_OUTPUT_SRCLINE = 1ULL << 12,
111 PERF_OUTPUT_PERIOD = 1ULL << 13,
112 PERF_OUTPUT_IREGS = 1ULL << 14,
113 PERF_OUTPUT_BRSTACK = 1ULL << 15,
114 PERF_OUTPUT_BRSTACKSYM = 1ULL << 16,
115 PERF_OUTPUT_DATA_SRC = 1ULL << 17,
116 PERF_OUTPUT_WEIGHT = 1ULL << 18,
117 PERF_OUTPUT_BPF_OUTPUT = 1ULL << 19,
118 PERF_OUTPUT_CALLINDENT = 1ULL << 20,
119 PERF_OUTPUT_INSN = 1ULL << 21,
120 PERF_OUTPUT_INSNLEN = 1ULL << 22,
121 PERF_OUTPUT_BRSTACKINSN = 1ULL << 23,
122 PERF_OUTPUT_BRSTACKOFF = 1ULL << 24,
123 PERF_OUTPUT_SYNTH = 1ULL << 25,
124 PERF_OUTPUT_PHYS_ADDR = 1ULL << 26,
125 PERF_OUTPUT_UREGS = 1ULL << 27,
126 PERF_OUTPUT_METRIC = 1ULL << 28,
127 PERF_OUTPUT_MISC = 1ULL << 29,
128 PERF_OUTPUT_SRCCODE = 1ULL << 30,
129 PERF_OUTPUT_IPC = 1ULL << 31,
130 PERF_OUTPUT_TOD = 1ULL << 32,
131 PERF_OUTPUT_DATA_PAGE_SIZE = 1ULL << 33,
132 PERF_OUTPUT_CODE_PAGE_SIZE = 1ULL << 34,
133 PERF_OUTPUT_INS_LAT = 1ULL << 35,
134 PERF_OUTPUT_BRSTACKINSNLEN = 1ULL << 36,
135 PERF_OUTPUT_MACHINE_PID = 1ULL << 37,
136 PERF_OUTPUT_VCPU = 1ULL << 38,
137 PERF_OUTPUT_CGROUP = 1ULL << 39,
138 PERF_OUTPUT_RETIRE_LAT = 1ULL << 40,
139 PERF_OUTPUT_DSOFF = 1ULL << 41,
140 PERF_OUTPUT_DISASM = 1ULL << 42,
141 PERF_OUTPUT_BRSTACKDISASM = 1ULL << 43,
142 PERF_OUTPUT_BRCNTR = 1ULL << 44,
143};
144
145struct perf_script {
146 struct perf_tool tool;
147 struct perf_session *session;
148 bool show_task_events;
149 bool show_mmap_events;
150 bool show_switch_events;
151 bool show_namespace_events;
152 bool show_lost_events;
153 bool show_round_events;
154 bool show_bpf_events;
155 bool show_cgroup_events;
156 bool show_text_poke_events;
157 bool allocated;
158 bool per_event_dump;
159 bool stitch_lbr;
160 struct evswitch evswitch;
161 struct perf_cpu_map *cpus;
162 struct perf_thread_map *threads;
163 int name_width;
164 const char *time_str;
165 struct perf_time_interval *ptime_range;
166 int range_size;
167 int range_num;
168};
169
170struct output_option {
171 const char *str;
172 enum perf_output_field field;
173} all_output_options[] = {
174 {.str = "comm", .field = PERF_OUTPUT_COMM},
175 {.str = "tid", .field = PERF_OUTPUT_TID},
176 {.str = "pid", .field = PERF_OUTPUT_PID},
177 {.str = "time", .field = PERF_OUTPUT_TIME},
178 {.str = "cpu", .field = PERF_OUTPUT_CPU},
179 {.str = "event", .field = PERF_OUTPUT_EVNAME},
180 {.str = "trace", .field = PERF_OUTPUT_TRACE},
181 {.str = "ip", .field = PERF_OUTPUT_IP},
182 {.str = "sym", .field = PERF_OUTPUT_SYM},
183 {.str = "dso", .field = PERF_OUTPUT_DSO},
184 {.str = "dsoff", .field = PERF_OUTPUT_DSOFF},
185 {.str = "addr", .field = PERF_OUTPUT_ADDR},
186 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
187 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
188 {.str = "period", .field = PERF_OUTPUT_PERIOD},
189 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
190 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
191 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
192 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
193 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
194 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
195 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
196 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
197 {.str = "insn", .field = PERF_OUTPUT_INSN},
198 {.str = "disasm", .field = PERF_OUTPUT_DISASM},
199 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
200 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
201 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
202 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
203 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
204 {.str = "metric", .field = PERF_OUTPUT_METRIC},
205 {.str = "misc", .field = PERF_OUTPUT_MISC},
206 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
207 {.str = "ipc", .field = PERF_OUTPUT_IPC},
208 {.str = "tod", .field = PERF_OUTPUT_TOD},
209 {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
210 {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
211 {.str = "ins_lat", .field = PERF_OUTPUT_INS_LAT},
212 {.str = "brstackinsnlen", .field = PERF_OUTPUT_BRSTACKINSNLEN},
213 {.str = "machine_pid", .field = PERF_OUTPUT_MACHINE_PID},
214 {.str = "vcpu", .field = PERF_OUTPUT_VCPU},
215 {.str = "cgroup", .field = PERF_OUTPUT_CGROUP},
216 {.str = "retire_lat", .field = PERF_OUTPUT_RETIRE_LAT},
217 {.str = "brstackdisasm", .field = PERF_OUTPUT_BRSTACKDISASM},
218 {.str = "brcntr", .field = PERF_OUTPUT_BRCNTR},
219};
220
221enum {
222 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
223 OUTPUT_TYPE_OTHER,
224 OUTPUT_TYPE_MAX
225};
226
227/* default set to maintain compatibility with current format */
228static struct {
229 bool user_set;
230 bool wildcard_set;
231 unsigned int print_ip_opts;
232 u64 fields;
233 u64 invalid_fields;
234 u64 user_set_fields;
235 u64 user_unset_fields;
236} output[OUTPUT_TYPE_MAX] = {
237
238 [PERF_TYPE_HARDWARE] = {
239 .user_set = false,
240
241 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
242 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
243 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
244 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
245 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
246
247 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
248 },
249
250 [PERF_TYPE_SOFTWARE] = {
251 .user_set = false,
252
253 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
254 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
255 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
256 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
257 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
258 PERF_OUTPUT_BPF_OUTPUT,
259
260 .invalid_fields = PERF_OUTPUT_TRACE,
261 },
262
263 [PERF_TYPE_TRACEPOINT] = {
264 .user_set = false,
265
266 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
267 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
268 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
269 },
270
271 [PERF_TYPE_HW_CACHE] = {
272 .user_set = false,
273
274 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
275 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
276 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
277 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
278 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
279
280 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
281 },
282
283 [PERF_TYPE_RAW] = {
284 .user_set = false,
285
286 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
287 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
288 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
289 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
290 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
291 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
292 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
293 PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
294 PERF_OUTPUT_INS_LAT | PERF_OUTPUT_RETIRE_LAT,
295
296 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
297 },
298
299 [PERF_TYPE_BREAKPOINT] = {
300 .user_set = false,
301
302 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
303 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
304 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
305 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
306 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
307
308 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
309 },
310
311 [OUTPUT_TYPE_SYNTH] = {
312 .user_set = false,
313
314 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
315 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
316 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
317 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
318 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
319
320 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
321 },
322
323 [OUTPUT_TYPE_OTHER] = {
324 .user_set = false,
325
326 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
327 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
328 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
329 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
330 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
331
332 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
333 },
334};
335
336struct evsel_script {
337 char *filename;
338 FILE *fp;
339 u64 samples;
340 /* For metric output */
341 u64 val;
342 int gnum;
343};
344
345static inline struct evsel_script *evsel_script(struct evsel *evsel)
346{
347 return (struct evsel_script *)evsel->priv;
348}
349
350static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
351{
352 struct evsel_script *es = zalloc(sizeof(*es));
353
354 if (es != NULL) {
355 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
356 goto out_free;
357 es->fp = fopen(es->filename, "w");
358 if (es->fp == NULL)
359 goto out_free_filename;
360 }
361
362 return es;
363out_free_filename:
364 zfree(&es->filename);
365out_free:
366 free(es);
367 return NULL;
368}
369
370static void evsel_script__delete(struct evsel_script *es)
371{
372 zfree(&es->filename);
373 fclose(es->fp);
374 es->fp = NULL;
375 free(es);
376}
377
378static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
379{
380 struct stat st;
381
382 fstat(fileno(es->fp), &st);
383 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
384 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
385}
386
387static inline int output_type(unsigned int type)
388{
389 switch (type) {
390 case PERF_TYPE_SYNTH:
391 return OUTPUT_TYPE_SYNTH;
392 default:
393 if (type < PERF_TYPE_MAX)
394 return type;
395 }
396
397 return OUTPUT_TYPE_OTHER;
398}
399
400static bool output_set_by_user(void)
401{
402 int j;
403 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
404 if (output[j].user_set)
405 return true;
406 }
407 return false;
408}
409
410static const char *output_field2str(enum perf_output_field field)
411{
412 int i, imax = ARRAY_SIZE(all_output_options);
413 const char *str = "";
414
415 for (i = 0; i < imax; ++i) {
416 if (all_output_options[i].field == field) {
417 str = all_output_options[i].str;
418 break;
419 }
420 }
421 return str;
422}
423
424#define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
425
426static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
427 enum perf_output_field field, bool allow_user_set)
428{
429 struct perf_event_attr *attr = &evsel->core.attr;
430 int type = output_type(attr->type);
431 const char *evname;
432
433 if (attr->sample_type & sample_type)
434 return 0;
435
436 if (output[type].user_set_fields & field) {
437 if (allow_user_set)
438 return 0;
439 evname = evsel__name(evsel);
440 pr_err("Samples for '%s' event do not have %s attribute set. "
441 "Cannot print '%s' field.\n",
442 evname, sample_msg, output_field2str(field));
443 return -1;
444 }
445
446 /* user did not ask for it explicitly so remove from the default list */
447 output[type].fields &= ~field;
448 evname = evsel__name(evsel);
449 pr_debug("Samples for '%s' event do not have %s attribute set. "
450 "Skipping '%s' field.\n",
451 evname, sample_msg, output_field2str(field));
452
453 return 0;
454}
455
456static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
457 enum perf_output_field field)
458{
459 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
460}
461
462static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
463{
464 struct perf_event_attr *attr = &evsel->core.attr;
465 bool allow_user_set;
466
467 if (evsel__is_dummy_event(evsel))
468 return 0;
469
470 if (perf_header__has_feat(&session->header, HEADER_STAT))
471 return 0;
472
473 allow_user_set = perf_header__has_feat(&session->header,
474 HEADER_AUXTRACE);
475
476 if (PRINT_FIELD(TRACE) &&
477 !perf_session__has_traces(session, "record -R"))
478 return -EINVAL;
479
480 if (PRINT_FIELD(IP)) {
481 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
482 return -EINVAL;
483 }
484
485 if (PRINT_FIELD(ADDR) &&
486 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
487 return -EINVAL;
488
489 if (PRINT_FIELD(DATA_SRC) &&
490 evsel__do_check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC, allow_user_set))
491 return -EINVAL;
492
493 if (PRINT_FIELD(WEIGHT) &&
494 evsel__do_check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT, allow_user_set))
495 return -EINVAL;
496
497 if (PRINT_FIELD(SYM) &&
498 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
499 pr_err("Display of symbols requested but neither sample IP nor "
500 "sample address\navailable. Hence, no addresses to convert "
501 "to symbols.\n");
502 return -EINVAL;
503 }
504 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
505 pr_err("Display of offsets requested but symbol is not"
506 "selected.\n");
507 return -EINVAL;
508 }
509 if (PRINT_FIELD(DSO) &&
510 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
511 pr_err("Display of DSO requested but no address to convert.\n");
512 return -EINVAL;
513 }
514 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
515 pr_err("Display of source line number requested but sample IP is not\n"
516 "selected. Hence, no address to lookup the source line number.\n");
517 return -EINVAL;
518 }
519 if ((PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN) || PRINT_FIELD(BRSTACKDISASM))
520 && !allow_user_set &&
521 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
522 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
523 "Hint: run 'perf record -b ...'\n");
524 return -EINVAL;
525 }
526 if (PRINT_FIELD(BRCNTR) &&
527 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_COUNTERS)) {
528 pr_err("Display of branch counter requested but it's not enabled\n"
529 "Hint: run 'perf record -j any,counter ...'\n");
530 return -EINVAL;
531 }
532 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
533 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
534 return -EINVAL;
535
536 if (PRINT_FIELD(TIME) &&
537 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
538 return -EINVAL;
539
540 if (PRINT_FIELD(CPU) &&
541 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
542 return -EINVAL;
543
544 if (PRINT_FIELD(IREGS) &&
545 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
546 return -EINVAL;
547
548 if (PRINT_FIELD(UREGS) &&
549 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
550 return -EINVAL;
551
552 if (PRINT_FIELD(PHYS_ADDR) &&
553 evsel__do_check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR, allow_user_set))
554 return -EINVAL;
555
556 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
557 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
558 return -EINVAL;
559
560 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
561 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
562 return -EINVAL;
563
564 if (PRINT_FIELD(INS_LAT) &&
565 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
566 return -EINVAL;
567
568 if (PRINT_FIELD(CGROUP) &&
569 evsel__check_stype(evsel, PERF_SAMPLE_CGROUP, "CGROUP", PERF_OUTPUT_CGROUP)) {
570 pr_err("Hint: run 'perf record --all-cgroups ...'\n");
571 return -EINVAL;
572 }
573
574 if (PRINT_FIELD(RETIRE_LAT) &&
575 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_RETIRE_LAT))
576 return -EINVAL;
577
578 return 0;
579}
580
581static void set_print_ip_opts(struct perf_event_attr *attr)
582{
583 unsigned int type = output_type(attr->type);
584
585 output[type].print_ip_opts = 0;
586 if (PRINT_FIELD(IP))
587 output[type].print_ip_opts |= EVSEL__PRINT_IP;
588
589 if (PRINT_FIELD(SYM))
590 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
591
592 if (PRINT_FIELD(DSO))
593 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
594
595 if (PRINT_FIELD(DSOFF))
596 output[type].print_ip_opts |= EVSEL__PRINT_DSOFF;
597
598 if (PRINT_FIELD(SYMOFFSET))
599 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
600
601 if (PRINT_FIELD(SRCLINE))
602 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
603}
604
605static struct evsel *find_first_output_type(struct evlist *evlist,
606 unsigned int type)
607{
608 struct evsel *evsel;
609
610 evlist__for_each_entry(evlist, evsel) {
611 if (evsel__is_dummy_event(evsel))
612 continue;
613 if (output_type(evsel->core.attr.type) == (int)type)
614 return evsel;
615 }
616 return NULL;
617}
618
619/*
620 * verify all user requested events exist and the samples
621 * have the expected data
622 */
623static int perf_session__check_output_opt(struct perf_session *session)
624{
625 bool tod = false;
626 unsigned int j;
627 struct evsel *evsel;
628
629 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
630 evsel = find_first_output_type(session->evlist, j);
631
632 /*
633 * even if fields is set to 0 (ie., show nothing) event must
634 * exist if user explicitly includes it on the command line
635 */
636 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
637 j != OUTPUT_TYPE_SYNTH) {
638 pr_err("%s events do not exist. "
639 "Remove corresponding -F option to proceed.\n",
640 event_type(j));
641 return -1;
642 }
643
644 if (evsel && output[j].fields &&
645 evsel__check_attr(evsel, session))
646 return -1;
647
648 if (evsel == NULL)
649 continue;
650
651 /* 'dsoff' implys 'dso' field */
652 if (output[j].fields & PERF_OUTPUT_DSOFF)
653 output[j].fields |= PERF_OUTPUT_DSO;
654
655 set_print_ip_opts(&evsel->core.attr);
656 tod |= output[j].fields & PERF_OUTPUT_TOD;
657 }
658
659 if (!no_callchain) {
660 bool use_callchain = false;
661 bool not_pipe = false;
662
663 evlist__for_each_entry(session->evlist, evsel) {
664 not_pipe = true;
665 if (evsel__has_callchain(evsel)) {
666 use_callchain = true;
667 break;
668 }
669 }
670 if (not_pipe && !use_callchain)
671 symbol_conf.use_callchain = false;
672 }
673
674 /*
675 * set default for tracepoints to print symbols only
676 * if callchains are present
677 */
678 if (symbol_conf.use_callchain &&
679 !output[PERF_TYPE_TRACEPOINT].user_set) {
680 j = PERF_TYPE_TRACEPOINT;
681
682 evlist__for_each_entry(session->evlist, evsel) {
683 if (evsel->core.attr.type != j)
684 continue;
685
686 if (evsel__has_callchain(evsel)) {
687 output[j].fields |= PERF_OUTPUT_IP;
688 output[j].fields |= PERF_OUTPUT_SYM;
689 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
690 output[j].fields |= PERF_OUTPUT_DSO;
691 set_print_ip_opts(&evsel->core.attr);
692 goto out;
693 }
694 }
695 }
696
697 if (tod && !session->header.env.clock.enabled) {
698 pr_err("Can't provide 'tod' time, missing clock data. "
699 "Please record with -k/--clockid option.\n");
700 return -1;
701 }
702out:
703 return 0;
704}
705
706static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask, const char *arch,
707 FILE *fp)
708{
709 unsigned i = 0, r;
710 int printed = 0;
711
712 if (!regs || !regs->regs)
713 return 0;
714
715 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
716
717 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
718 u64 val = regs->regs[i++];
719 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r, arch), val);
720 }
721
722 return printed;
723}
724
725#define DEFAULT_TOD_FMT "%F %H:%M:%S"
726
727static char*
728tod_scnprintf(struct perf_script *script, char *buf, int buflen,
729 u64 timestamp)
730{
731 u64 tod_ns, clockid_ns;
732 struct perf_env *env;
733 unsigned long nsec;
734 struct tm ltime;
735 char date[64];
736 time_t sec;
737
738 buf[0] = '\0';
739 if (buflen < 64 || !script)
740 return buf;
741
742 env = &script->session->header.env;
743 if (!env->clock.enabled) {
744 scnprintf(buf, buflen, "disabled");
745 return buf;
746 }
747
748 clockid_ns = env->clock.clockid_ns;
749 tod_ns = env->clock.tod_ns;
750
751 if (timestamp > clockid_ns)
752 tod_ns += timestamp - clockid_ns;
753 else
754 tod_ns -= clockid_ns - timestamp;
755
756 sec = (time_t) (tod_ns / NSEC_PER_SEC);
757 nsec = tod_ns - sec * NSEC_PER_SEC;
758
759 if (localtime_r(&sec, <ime) == NULL) {
760 scnprintf(buf, buflen, "failed");
761 } else {
762 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
763
764 if (symbol_conf.nanosecs) {
765 snprintf(buf, buflen, "%s.%09lu", date, nsec);
766 } else {
767 snprintf(buf, buflen, "%s.%06lu",
768 date, nsec / NSEC_PER_USEC);
769 }
770 }
771
772 return buf;
773}
774
775static int perf_sample__fprintf_iregs(struct perf_sample *sample,
776 struct perf_event_attr *attr, const char *arch, FILE *fp)
777{
778 return perf_sample__fprintf_regs(&sample->intr_regs,
779 attr->sample_regs_intr, arch, fp);
780}
781
782static int perf_sample__fprintf_uregs(struct perf_sample *sample,
783 struct perf_event_attr *attr, const char *arch, FILE *fp)
784{
785 return perf_sample__fprintf_regs(&sample->user_regs,
786 attr->sample_regs_user, arch, fp);
787}
788
789static int perf_sample__fprintf_start(struct perf_script *script,
790 struct perf_sample *sample,
791 struct thread *thread,
792 struct evsel *evsel,
793 u32 type, FILE *fp)
794{
795 struct perf_event_attr *attr = &evsel->core.attr;
796 unsigned long secs;
797 unsigned long long nsecs;
798 int printed = 0;
799 char tstr[128];
800
801 /*
802 * Print the branch counter's abbreviation list,
803 * if the branch counter is available.
804 */
805 if (PRINT_FIELD(BRCNTR) && !verbose) {
806 char *buf;
807
808 if (!annotation_br_cntr_abbr_list(&buf, evsel, true)) {
809 printed += fprintf(stdout, "%s", buf);
810 free(buf);
811 }
812 }
813
814 if (PRINT_FIELD(MACHINE_PID) && sample->machine_pid)
815 printed += fprintf(fp, "VM:%5d ", sample->machine_pid);
816
817 /* Print VCPU only for guest events i.e. with machine_pid */
818 if (PRINT_FIELD(VCPU) && sample->machine_pid)
819 printed += fprintf(fp, "VCPU:%03d ", sample->vcpu);
820
821 if (PRINT_FIELD(COMM)) {
822 const char *comm = thread ? thread__comm_str(thread) : ":-1";
823
824 if (latency_format)
825 printed += fprintf(fp, "%8.8s ", comm);
826 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
827 printed += fprintf(fp, "%s ", comm);
828 else
829 printed += fprintf(fp, "%16s ", comm);
830 }
831
832 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
833 printed += fprintf(fp, "%7d/%-7d ", sample->pid, sample->tid);
834 else if (PRINT_FIELD(PID))
835 printed += fprintf(fp, "%7d ", sample->pid);
836 else if (PRINT_FIELD(TID))
837 printed += fprintf(fp, "%7d ", sample->tid);
838
839 if (PRINT_FIELD(CPU)) {
840 if (latency_format)
841 printed += fprintf(fp, "%3d ", sample->cpu);
842 else
843 printed += fprintf(fp, "[%03d] ", sample->cpu);
844 }
845
846 if (PRINT_FIELD(MISC)) {
847 int ret = 0;
848
849 #define has(m) \
850 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
851
852 if (has(KERNEL))
853 ret += fprintf(fp, "K");
854 if (has(USER))
855 ret += fprintf(fp, "U");
856 if (has(HYPERVISOR))
857 ret += fprintf(fp, "H");
858 if (has(GUEST_KERNEL))
859 ret += fprintf(fp, "G");
860 if (has(GUEST_USER))
861 ret += fprintf(fp, "g");
862
863 switch (type) {
864 case PERF_RECORD_MMAP:
865 case PERF_RECORD_MMAP2:
866 if (has(MMAP_DATA))
867 ret += fprintf(fp, "M");
868 break;
869 case PERF_RECORD_COMM:
870 if (has(COMM_EXEC))
871 ret += fprintf(fp, "E");
872 break;
873 case PERF_RECORD_SWITCH:
874 case PERF_RECORD_SWITCH_CPU_WIDE:
875 if (has(SWITCH_OUT)) {
876 ret += fprintf(fp, "S");
877 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
878 ret += fprintf(fp, "p");
879 }
880 default:
881 break;
882 }
883
884 #undef has
885
886 ret += fprintf(fp, "%*s", 6 - ret, " ");
887 printed += ret;
888 }
889
890 if (PRINT_FIELD(TOD)) {
891 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
892 printed += fprintf(fp, "%s ", tstr);
893 }
894
895 if (PRINT_FIELD(TIME)) {
896 u64 t = sample->time;
897 if (reltime) {
898 if (!initial_time)
899 initial_time = sample->time;
900 t = sample->time - initial_time;
901 } else if (deltatime) {
902 if (previous_time)
903 t = sample->time - previous_time;
904 else {
905 t = 0;
906 }
907 previous_time = sample->time;
908 }
909 nsecs = t;
910 secs = nsecs / NSEC_PER_SEC;
911 nsecs -= secs * NSEC_PER_SEC;
912
913 if (symbol_conf.nanosecs)
914 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
915 else {
916 char sample_time[32];
917 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
918 printed += fprintf(fp, "%12s: ", sample_time);
919 }
920 }
921
922 return printed;
923}
924
925static inline char
926mispred_str(struct branch_entry *br)
927{
928 if (!(br->flags.mispred || br->flags.predicted))
929 return '-';
930
931 return br->flags.predicted ? 'P' : 'M';
932}
933
934static int print_bstack_flags(FILE *fp, struct branch_entry *br)
935{
936 return fprintf(fp, "/%c/%c/%c/%d/%s/%s ",
937 mispred_str(br),
938 br->flags.in_tx ? 'X' : '-',
939 br->flags.abort ? 'A' : '-',
940 br->flags.cycles,
941 get_branch_type(br),
942 br->flags.spec ? branch_spec_desc(br->flags.spec) : "-");
943}
944
945static int perf_sample__fprintf_brstack(struct perf_sample *sample,
946 struct thread *thread,
947 struct perf_event_attr *attr, FILE *fp)
948{
949 struct branch_stack *br = sample->branch_stack;
950 struct branch_entry *entries = perf_sample__branch_entries(sample);
951 u64 i, from, to;
952 int printed = 0;
953
954 if (!(br && br->nr))
955 return 0;
956
957 for (i = 0; i < br->nr; i++) {
958 from = entries[i].from;
959 to = entries[i].to;
960
961 printed += fprintf(fp, " 0x%"PRIx64, from);
962 if (PRINT_FIELD(DSO)) {
963 struct addr_location alf, alt;
964
965 addr_location__init(&alf);
966 addr_location__init(&alt);
967 thread__find_map_fb(thread, sample->cpumode, from, &alf);
968 thread__find_map_fb(thread, sample->cpumode, to, &alt);
969
970 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
971 printed += fprintf(fp, "/0x%"PRIx64, to);
972 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
973 addr_location__exit(&alt);
974 addr_location__exit(&alf);
975 } else
976 printed += fprintf(fp, "/0x%"PRIx64, to);
977
978 printed += print_bstack_flags(fp, entries + i);
979 }
980
981 return printed;
982}
983
984static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
985 struct thread *thread,
986 struct perf_event_attr *attr, FILE *fp)
987{
988 struct branch_stack *br = sample->branch_stack;
989 struct branch_entry *entries = perf_sample__branch_entries(sample);
990 u64 i, from, to;
991 int printed = 0;
992
993 if (!(br && br->nr))
994 return 0;
995
996 for (i = 0; i < br->nr; i++) {
997 struct addr_location alf, alt;
998
999 addr_location__init(&alf);
1000 addr_location__init(&alt);
1001 from = entries[i].from;
1002 to = entries[i].to;
1003
1004 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
1005 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
1006
1007 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
1008 if (PRINT_FIELD(DSO))
1009 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
1010 printed += fprintf(fp, "%c", '/');
1011 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
1012 if (PRINT_FIELD(DSO))
1013 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
1014 printed += print_bstack_flags(fp, entries + i);
1015 addr_location__exit(&alt);
1016 addr_location__exit(&alf);
1017 }
1018
1019 return printed;
1020}
1021
1022static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
1023 struct thread *thread,
1024 struct perf_event_attr *attr, FILE *fp)
1025{
1026 struct branch_stack *br = sample->branch_stack;
1027 struct branch_entry *entries = perf_sample__branch_entries(sample);
1028 u64 i, from, to;
1029 int printed = 0;
1030
1031 if (!(br && br->nr))
1032 return 0;
1033
1034 for (i = 0; i < br->nr; i++) {
1035 struct addr_location alf, alt;
1036
1037 addr_location__init(&alf);
1038 addr_location__init(&alt);
1039 from = entries[i].from;
1040 to = entries[i].to;
1041
1042 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
1043 !dso__adjust_symbols(map__dso(alf.map)))
1044 from = map__dso_map_ip(alf.map, from);
1045
1046 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
1047 !dso__adjust_symbols(map__dso(alt.map)))
1048 to = map__dso_map_ip(alt.map, to);
1049
1050 printed += fprintf(fp, " 0x%"PRIx64, from);
1051 if (PRINT_FIELD(DSO))
1052 printed += map__fprintf_dsoname_dsoff(alf.map, PRINT_FIELD(DSOFF), alf.addr, fp);
1053 printed += fprintf(fp, "/0x%"PRIx64, to);
1054 if (PRINT_FIELD(DSO))
1055 printed += map__fprintf_dsoname_dsoff(alt.map, PRINT_FIELD(DSOFF), alt.addr, fp);
1056 printed += print_bstack_flags(fp, entries + i);
1057 addr_location__exit(&alt);
1058 addr_location__exit(&alf);
1059 }
1060
1061 return printed;
1062}
1063#define MAXBB 16384UL
1064
1065static int grab_bb(u8 *buffer, u64 start, u64 end,
1066 struct machine *machine, struct thread *thread,
1067 bool *is64bit, u8 *cpumode, bool last)
1068{
1069 long offset, len;
1070 struct addr_location al;
1071 bool kernel;
1072 struct dso *dso;
1073 int ret = 0;
1074
1075 if (!start || !end)
1076 return 0;
1077
1078 kernel = machine__kernel_ip(machine, start);
1079 if (kernel)
1080 *cpumode = PERF_RECORD_MISC_KERNEL;
1081 else
1082 *cpumode = PERF_RECORD_MISC_USER;
1083
1084 /*
1085 * Block overlaps between kernel and user.
1086 * This can happen due to ring filtering
1087 * On Intel CPUs the entry into the kernel is filtered,
1088 * but the exit is not. Let the caller patch it up.
1089 */
1090 if (kernel != machine__kernel_ip(machine, end)) {
1091 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1092 return -ENXIO;
1093 }
1094
1095 if (end - start > MAXBB - MAXINSN) {
1096 if (last)
1097 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1098 else
1099 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1100 return 0;
1101 }
1102
1103 addr_location__init(&al);
1104 if (!thread__find_map(thread, *cpumode, start, &al) || (dso = map__dso(al.map)) == NULL) {
1105 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1106 goto out;
1107 }
1108 if (dso__data(dso)->status == DSO_DATA_STATUS_ERROR) {
1109 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1110 goto out;
1111 }
1112
1113 /* Load maps to ensure dso->is_64_bit has been updated */
1114 map__load(al.map);
1115
1116 offset = map__map_ip(al.map, start);
1117 len = dso__data_read_offset(dso, machine, offset, (u8 *)buffer,
1118 end - start + MAXINSN);
1119
1120 *is64bit = dso__is_64_bit(dso);
1121 if (len <= 0)
1122 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1123 start, end);
1124 ret = len;
1125out:
1126 addr_location__exit(&al);
1127 return ret;
1128}
1129
1130static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1131{
1132 char *srcfile;
1133 int ret = 0;
1134 unsigned line;
1135 int len;
1136 char *srccode;
1137 struct dso *dso;
1138
1139 if (!map || (dso = map__dso(map)) == NULL)
1140 return 0;
1141 srcfile = get_srcline_split(dso,
1142 map__rip_2objdump(map, addr),
1143 &line);
1144 if (!srcfile)
1145 return 0;
1146
1147 /* Avoid redundant printing */
1148 if (state &&
1149 state->srcfile &&
1150 !strcmp(state->srcfile, srcfile) &&
1151 state->line == line) {
1152 free(srcfile);
1153 return 0;
1154 }
1155
1156 srccode = find_sourceline(srcfile, line, &len);
1157 if (!srccode)
1158 goto out_free_line;
1159
1160 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1161
1162 if (state) {
1163 state->srcfile = srcfile;
1164 state->line = line;
1165 }
1166 return ret;
1167
1168out_free_line:
1169 free(srcfile);
1170 return ret;
1171}
1172
1173static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1174{
1175 struct addr_location al;
1176 int ret = 0;
1177
1178 addr_location__init(&al);
1179 thread__find_map(thread, cpumode, addr, &al);
1180 if (!al.map)
1181 goto out;
1182 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1183 thread__srccode_state(thread));
1184 if (ret)
1185 ret += printf("\n");
1186out:
1187 addr_location__exit(&al);
1188 return ret;
1189}
1190
1191static int any_dump_insn(struct perf_event_attr *attr __maybe_unused,
1192 struct perf_insn *x, uint64_t ip,
1193 u8 *inbuf, int inlen, int *lenp,
1194 FILE *fp)
1195{
1196#ifdef HAVE_LIBCAPSTONE_SUPPORT
1197 if (PRINT_FIELD(BRSTACKDISASM)) {
1198 int printed = fprintf_insn_asm(x->machine, x->thread, x->cpumode, x->is64bit,
1199 (uint8_t *)inbuf, inlen, ip, lenp,
1200 PRINT_INSN_IMM_HEX, fp);
1201
1202 if (printed > 0)
1203 return printed;
1204 }
1205#endif
1206 return fprintf(fp, "%s", dump_insn(x, ip, inbuf, inlen, lenp));
1207}
1208
1209static int add_padding(FILE *fp, int printed, int padding)
1210{
1211 if (printed >= 0 && printed < padding)
1212 printed += fprintf(fp, "%*s", padding - printed, "");
1213 return printed;
1214}
1215
1216static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1217 struct perf_insn *x, u8 *inbuf, int len,
1218 int insn, FILE *fp, int *total_cycles,
1219 struct perf_event_attr *attr,
1220 struct thread *thread,
1221 struct evsel *evsel,
1222 u64 br_cntr)
1223{
1224 int ilen = 0;
1225 int printed = fprintf(fp, "\t%016" PRIx64 "\t", ip);
1226
1227 printed += add_padding(fp, any_dump_insn(attr, x, ip, inbuf, len, &ilen, fp), 30);
1228 printed += fprintf(fp, "\t");
1229
1230 if (PRINT_FIELD(BRSTACKINSNLEN))
1231 printed += fprintf(fp, "ilen: %d\t", ilen);
1232
1233 if (PRINT_FIELD(SRCLINE)) {
1234 struct addr_location al;
1235
1236 addr_location__init(&al);
1237 thread__find_map(thread, x->cpumode, ip, &al);
1238 printed += map__fprintf_srcline(al.map, al.addr, " srcline: ", fp);
1239 printed += fprintf(fp, "\t");
1240 addr_location__exit(&al);
1241 }
1242
1243 if (PRINT_FIELD(BRCNTR)) {
1244 struct evsel *pos = evsel__leader(evsel);
1245 unsigned int i = 0, j, num, mask, width;
1246
1247 perf_env__find_br_cntr_info(evsel__env(evsel), NULL, &width);
1248 mask = (1L << width) - 1;
1249 printed += fprintf(fp, "br_cntr: ");
1250 evlist__for_each_entry_from(evsel->evlist, pos) {
1251 if (!(pos->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_COUNTERS))
1252 continue;
1253 if (evsel__leader(pos) != evsel__leader(evsel))
1254 break;
1255
1256 num = (br_cntr >> (i++ * width)) & mask;
1257 if (!verbose) {
1258 for (j = 0; j < num; j++)
1259 printed += fprintf(fp, "%s", pos->abbr_name);
1260 } else
1261 printed += fprintf(fp, "%s %d ", pos->name, num);
1262 }
1263 printed += fprintf(fp, "\t");
1264 }
1265
1266 printed += fprintf(fp, "#%s%s%s%s",
1267 en->flags.predicted ? " PRED" : "",
1268 en->flags.mispred ? " MISPRED" : "",
1269 en->flags.in_tx ? " INTX" : "",
1270 en->flags.abort ? " ABORT" : "");
1271 if (en->flags.cycles) {
1272 *total_cycles += en->flags.cycles;
1273 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1274 if (insn)
1275 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1276 }
1277
1278 return printed + fprintf(fp, "\n");
1279}
1280
1281static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1282 u8 cpumode, int cpu, struct symbol **lastsym,
1283 struct perf_event_attr *attr, FILE *fp)
1284{
1285 struct addr_location al;
1286 int off, printed = 0, ret = 0;
1287
1288 addr_location__init(&al);
1289 thread__find_map(thread, cpumode, addr, &al);
1290
1291 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1292 goto out;
1293
1294 al.cpu = cpu;
1295 al.sym = NULL;
1296 if (al.map)
1297 al.sym = map__find_symbol(al.map, al.addr);
1298
1299 if (!al.sym)
1300 goto out;
1301
1302 if (al.addr < al.sym->end)
1303 off = al.addr - al.sym->start;
1304 else
1305 off = al.addr - map__start(al.map) - al.sym->start;
1306 printed += fprintf(fp, "\t%s", al.sym->name);
1307 if (off)
1308 printed += fprintf(fp, "%+d", off);
1309 printed += fprintf(fp, ":");
1310 if (PRINT_FIELD(SRCLINE))
1311 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1312 printed += fprintf(fp, "\n");
1313 *lastsym = al.sym;
1314
1315 ret = printed;
1316out:
1317 addr_location__exit(&al);
1318 return ret;
1319}
1320
1321static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1322 struct evsel *evsel,
1323 struct thread *thread,
1324 struct perf_event_attr *attr,
1325 struct machine *machine, FILE *fp)
1326{
1327 struct branch_stack *br = sample->branch_stack;
1328 struct branch_entry *entries = perf_sample__branch_entries(sample);
1329 u64 start, end;
1330 int i, insn, len, nr, ilen, printed = 0;
1331 struct perf_insn x;
1332 u8 buffer[MAXBB];
1333 unsigned off;
1334 struct symbol *lastsym = NULL;
1335 int total_cycles = 0;
1336 u64 br_cntr = 0;
1337
1338 if (!(br && br->nr))
1339 return 0;
1340 nr = br->nr;
1341 if (max_blocks && nr > max_blocks + 1)
1342 nr = max_blocks + 1;
1343
1344 x.thread = thread;
1345 x.machine = machine;
1346 x.cpu = sample->cpu;
1347
1348 if (PRINT_FIELD(BRCNTR) && sample->branch_stack_cntr)
1349 br_cntr = sample->branch_stack_cntr[nr - 1];
1350
1351 printed += fprintf(fp, "%c", '\n');
1352
1353 /* Handle first from jump, of which we don't know the entry. */
1354 len = grab_bb(buffer, entries[nr-1].from,
1355 entries[nr-1].from,
1356 machine, thread, &x.is64bit, &x.cpumode, false);
1357 if (len > 0) {
1358 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1359 x.cpumode, x.cpu, &lastsym, attr, fp);
1360 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1361 &x, buffer, len, 0, fp, &total_cycles,
1362 attr, thread, evsel, br_cntr);
1363 if (PRINT_FIELD(SRCCODE))
1364 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1365 }
1366
1367 /* Print all blocks */
1368 for (i = nr - 2; i >= 0; i--) {
1369 if (entries[i].from || entries[i].to)
1370 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1371 entries[i].from,
1372 entries[i].to);
1373 start = entries[i + 1].to;
1374 end = entries[i].from;
1375
1376 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1377 /* Patch up missing kernel transfers due to ring filters */
1378 if (len == -ENXIO && i > 0) {
1379 end = entries[--i].from;
1380 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1381 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1382 }
1383 if (len <= 0)
1384 continue;
1385
1386 insn = 0;
1387 for (off = 0; off < (unsigned)len; off += ilen) {
1388 uint64_t ip = start + off;
1389
1390 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1391 if (ip == end) {
1392 if (PRINT_FIELD(BRCNTR) && sample->branch_stack_cntr)
1393 br_cntr = sample->branch_stack_cntr[i];
1394 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1395 &total_cycles, attr, thread, evsel, br_cntr);
1396 if (PRINT_FIELD(SRCCODE))
1397 printed += print_srccode(thread, x.cpumode, ip);
1398 break;
1399 } else {
1400 ilen = 0;
1401 printed += fprintf(fp, "\t%016" PRIx64 "\t", ip);
1402 printed += any_dump_insn(attr, &x, ip, buffer + off, len - off, &ilen, fp);
1403 if (PRINT_FIELD(BRSTACKINSNLEN))
1404 printed += fprintf(fp, "\tilen: %d", ilen);
1405 printed += fprintf(fp, "\n");
1406 if (ilen == 0)
1407 break;
1408 if (PRINT_FIELD(SRCCODE))
1409 print_srccode(thread, x.cpumode, ip);
1410 insn++;
1411 }
1412 }
1413 if (off != end - start)
1414 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1415 }
1416
1417 /*
1418 * Hit the branch? In this case we are already done, and the target
1419 * has not been executed yet.
1420 */
1421 if (entries[0].from == sample->ip)
1422 goto out;
1423 if (entries[0].flags.abort)
1424 goto out;
1425
1426 /*
1427 * Print final block up to sample
1428 *
1429 * Due to pipeline delays the LBRs might be missing a branch
1430 * or two, which can result in very large or negative blocks
1431 * between final branch and sample. When this happens just
1432 * continue walking after the last TO.
1433 */
1434 start = entries[0].to;
1435 end = sample->ip;
1436 if (end < start) {
1437 /* Missing jump. Scan 128 bytes for the next branch */
1438 end = start + 128;
1439 }
1440 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1441 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1442 if (len <= 0) {
1443 /* Print at least last IP if basic block did not work */
1444 len = grab_bb(buffer, sample->ip, sample->ip,
1445 machine, thread, &x.is64bit, &x.cpumode, false);
1446 if (len <= 0)
1447 goto out;
1448 ilen = 0;
1449 printed += fprintf(fp, "\t%016" PRIx64 "\t", sample->ip);
1450 printed += any_dump_insn(attr, &x, sample->ip, buffer, len, &ilen, fp);
1451 if (PRINT_FIELD(BRSTACKINSNLEN))
1452 printed += fprintf(fp, "\tilen: %d", ilen);
1453 printed += fprintf(fp, "\n");
1454 if (PRINT_FIELD(SRCCODE))
1455 print_srccode(thread, x.cpumode, sample->ip);
1456 goto out;
1457 }
1458 for (off = 0; off <= end - start; off += ilen) {
1459 ilen = 0;
1460 printed += fprintf(fp, "\t%016" PRIx64 "\t", start + off);
1461 printed += any_dump_insn(attr, &x, start + off, buffer + off, len - off, &ilen, fp);
1462 if (PRINT_FIELD(BRSTACKINSNLEN))
1463 printed += fprintf(fp, "\tilen: %d", ilen);
1464 printed += fprintf(fp, "\n");
1465 if (ilen == 0)
1466 break;
1467 if ((attr->branch_sample_type == 0 || attr->branch_sample_type & PERF_SAMPLE_BRANCH_ANY)
1468 && arch_is_uncond_branch(buffer + off, len - off, x.is64bit)
1469 && start + off != sample->ip) {
1470 /*
1471 * Hit a missing branch. Just stop.
1472 */
1473 printed += fprintf(fp, "\t... not reaching sample ...\n");
1474 break;
1475 }
1476 if (PRINT_FIELD(SRCCODE))
1477 print_srccode(thread, x.cpumode, start + off);
1478 }
1479out:
1480 return printed;
1481}
1482
1483static int perf_sample__fprintf_addr(struct perf_sample *sample,
1484 struct thread *thread,
1485 struct perf_event_attr *attr, FILE *fp)
1486{
1487 struct addr_location al;
1488 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1489
1490 addr_location__init(&al);
1491 if (!sample_addr_correlates_sym(attr))
1492 goto out;
1493
1494 thread__resolve(thread, &al, sample);
1495
1496 if (PRINT_FIELD(SYM)) {
1497 printed += fprintf(fp, " ");
1498 if (PRINT_FIELD(SYMOFFSET))
1499 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1500 else
1501 printed += symbol__fprintf_symname(al.sym, fp);
1502 }
1503
1504 if (PRINT_FIELD(DSO))
1505 printed += map__fprintf_dsoname_dsoff(al.map, PRINT_FIELD(DSOFF), al.addr, fp);
1506out:
1507 addr_location__exit(&al);
1508 return printed;
1509}
1510
1511static const char *resolve_branch_sym(struct perf_sample *sample,
1512 struct evsel *evsel,
1513 struct thread *thread,
1514 struct addr_location *al,
1515 struct addr_location *addr_al,
1516 u64 *ip)
1517{
1518 struct perf_event_attr *attr = &evsel->core.attr;
1519 const char *name = NULL;
1520
1521 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1522 if (sample_addr_correlates_sym(attr)) {
1523 if (!addr_al->thread)
1524 thread__resolve(thread, addr_al, sample);
1525 if (addr_al->sym)
1526 name = addr_al->sym->name;
1527 else
1528 *ip = sample->addr;
1529 } else {
1530 *ip = sample->addr;
1531 }
1532 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1533 if (al->sym)
1534 name = al->sym->name;
1535 else
1536 *ip = sample->ip;
1537 }
1538 return name;
1539}
1540
1541static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1542 struct evsel *evsel,
1543 struct thread *thread,
1544 struct addr_location *al,
1545 struct addr_location *addr_al,
1546 FILE *fp)
1547{
1548 struct perf_event_attr *attr = &evsel->core.attr;
1549 size_t depth = thread_stack__depth(thread, sample->cpu);
1550 const char *name = NULL;
1551 static int spacing;
1552 int len = 0;
1553 int dlen = 0;
1554 u64 ip = 0;
1555
1556 /*
1557 * The 'return' has already been popped off the stack so the depth has
1558 * to be adjusted to match the 'call'.
1559 */
1560 if (thread__ts(thread) && sample->flags & PERF_IP_FLAG_RETURN)
1561 depth += 1;
1562
1563 name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1564
1565 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1566 dlen += fprintf(fp, "(");
1567 dlen += map__fprintf_dsoname(al->map, fp);
1568 dlen += fprintf(fp, ")\t");
1569 }
1570
1571 if (name)
1572 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1573 else if (ip)
1574 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1575
1576 if (len < 0)
1577 return len;
1578
1579 /*
1580 * Try to keep the output length from changing frequently so that the
1581 * output lines up more nicely.
1582 */
1583 if (len > spacing || (len && len < spacing - 52))
1584 spacing = round_up(len + 4, 32);
1585
1586 if (len < spacing)
1587 len += fprintf(fp, "%*s", spacing - len, "");
1588
1589 return len + dlen;
1590}
1591
1592__weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1593 struct thread *thread __maybe_unused,
1594 struct machine *machine __maybe_unused)
1595{
1596}
1597
1598void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1599 struct machine *machine)
1600{
1601 if (sample->insn_len == 0 && native_arch)
1602 arch_fetch_insn(sample, thread, machine);
1603}
1604
1605static int perf_sample__fprintf_insn(struct perf_sample *sample,
1606 struct evsel *evsel,
1607 struct perf_event_attr *attr,
1608 struct thread *thread,
1609 struct machine *machine, FILE *fp,
1610 struct addr_location *al)
1611{
1612 int printed = 0;
1613
1614 script_fetch_insn(sample, thread, machine);
1615
1616 if (PRINT_FIELD(INSNLEN))
1617 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1618 if (PRINT_FIELD(INSN) && sample->insn_len) {
1619 printed += fprintf(fp, " insn: ");
1620 printed += sample__fprintf_insn_raw(sample, fp);
1621 }
1622 if (PRINT_FIELD(DISASM) && sample->insn_len) {
1623 printed += fprintf(fp, "\t\t");
1624 printed += sample__fprintf_insn_asm(sample, thread, machine, fp, al);
1625 }
1626 if (PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN) || PRINT_FIELD(BRSTACKDISASM))
1627 printed += perf_sample__fprintf_brstackinsn(sample, evsel, thread, attr, machine, fp);
1628
1629 return printed;
1630}
1631
1632static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1633 struct perf_event_attr *attr, FILE *fp)
1634{
1635 unsigned int ipc;
1636
1637 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1638 return 0;
1639
1640 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1641
1642 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1643 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1644}
1645
1646static int perf_sample__fprintf_bts(struct perf_sample *sample,
1647 struct evsel *evsel,
1648 struct thread *thread,
1649 struct addr_location *al,
1650 struct addr_location *addr_al,
1651 struct machine *machine, FILE *fp)
1652{
1653 struct perf_event_attr *attr = &evsel->core.attr;
1654 unsigned int type = output_type(attr->type);
1655 bool print_srcline_last = false;
1656 int printed = 0;
1657
1658 if (PRINT_FIELD(CALLINDENT))
1659 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1660
1661 /* print branch_from information */
1662 if (PRINT_FIELD(IP)) {
1663 unsigned int print_opts = output[type].print_ip_opts;
1664 struct callchain_cursor *cursor = NULL;
1665
1666 if (symbol_conf.use_callchain && sample->callchain) {
1667 cursor = get_tls_callchain_cursor();
1668 if (thread__resolve_callchain(al->thread, cursor, evsel,
1669 sample, NULL, NULL,
1670 scripting_max_stack))
1671 cursor = NULL;
1672 }
1673 if (cursor == NULL) {
1674 printed += fprintf(fp, " ");
1675 if (print_opts & EVSEL__PRINT_SRCLINE) {
1676 print_srcline_last = true;
1677 print_opts &= ~EVSEL__PRINT_SRCLINE;
1678 }
1679 } else
1680 printed += fprintf(fp, "\n");
1681
1682 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1683 symbol_conf.bt_stop_list, fp);
1684 }
1685
1686 /* print branch_to information */
1687 if (PRINT_FIELD(ADDR) ||
1688 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1689 !output[type].user_set)) {
1690 printed += fprintf(fp, " => ");
1691 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1692 }
1693
1694 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1695
1696 if (print_srcline_last)
1697 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1698
1699 printed += perf_sample__fprintf_insn(sample, evsel, attr, thread, machine, fp, al);
1700 printed += fprintf(fp, "\n");
1701 if (PRINT_FIELD(SRCCODE)) {
1702 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1703 thread__srccode_state(thread));
1704 if (ret) {
1705 printed += ret;
1706 printed += printf("\n");
1707 }
1708 }
1709 return printed;
1710}
1711
1712static struct {
1713 u32 flags;
1714 const char *name;
1715} sample_flags[] = {
1716 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1717 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1718 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1719 {PERF_IP_FLAG_BRANCH, "jmp"},
1720 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1721 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1722 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1723 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1724 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1725 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1726 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1727 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1728 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1729 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1730 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1731 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_BRANCH_MISS, "br miss"},
1732 {0, NULL}
1733};
1734
1735static const char *sample_flags_to_name(u32 flags)
1736{
1737 int i;
1738
1739 for (i = 0; sample_flags[i].name ; i++) {
1740 if (sample_flags[i].flags == flags)
1741 return sample_flags[i].name;
1742 }
1743
1744 return NULL;
1745}
1746
1747int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1748{
1749 u32 xf = PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_INTR_DISABLE |
1750 PERF_IP_FLAG_INTR_TOGGLE;
1751 const char *chars = PERF_IP_FLAG_CHARS;
1752 const size_t n = strlen(PERF_IP_FLAG_CHARS);
1753 const char *name = NULL;
1754 size_t i, pos = 0;
1755 char xs[16] = {0};
1756
1757 if (flags & xf)
1758 snprintf(xs, sizeof(xs), "(%s%s%s)",
1759 flags & PERF_IP_FLAG_IN_TX ? "x" : "",
1760 flags & PERF_IP_FLAG_INTR_DISABLE ? "D" : "",
1761 flags & PERF_IP_FLAG_INTR_TOGGLE ? "t" : "");
1762
1763 name = sample_flags_to_name(flags & ~xf);
1764 if (name)
1765 return snprintf(str, sz, "%-15s%6s", name, xs);
1766
1767 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1768 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_BEGIN));
1769 if (name)
1770 return snprintf(str, sz, "tr strt %-7s%6s", name, xs);
1771 }
1772
1773 if (flags & PERF_IP_FLAG_TRACE_END) {
1774 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_END));
1775 if (name)
1776 return snprintf(str, sz, "tr end %-7s%6s", name, xs);
1777 }
1778
1779 for (i = 0; i < n; i++, flags >>= 1) {
1780 if ((flags & 1) && pos < sz)
1781 str[pos++] = chars[i];
1782 }
1783 for (; i < 32; i++, flags >>= 1) {
1784 if ((flags & 1) && pos < sz)
1785 str[pos++] = '?';
1786 }
1787 if (pos < sz)
1788 str[pos] = 0;
1789
1790 return pos;
1791}
1792
1793static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1794{
1795 char str[SAMPLE_FLAGS_BUF_SIZE];
1796
1797 perf_sample__sprintf_flags(flags, str, sizeof(str));
1798 return fprintf(fp, " %-21s ", str);
1799}
1800
1801struct printer_data {
1802 int line_no;
1803 bool hit_nul;
1804 bool is_printable;
1805};
1806
1807static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1808 unsigned int val,
1809 void *extra, FILE *fp)
1810{
1811 unsigned char ch = (unsigned char)val;
1812 struct printer_data *printer_data = extra;
1813 int printed = 0;
1814
1815 switch (op) {
1816 case BINARY_PRINT_DATA_BEGIN:
1817 printed += fprintf(fp, "\n");
1818 break;
1819 case BINARY_PRINT_LINE_BEGIN:
1820 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1821 " ");
1822 break;
1823 case BINARY_PRINT_ADDR:
1824 printed += fprintf(fp, " %04x:", val);
1825 break;
1826 case BINARY_PRINT_NUM_DATA:
1827 printed += fprintf(fp, " %02x", val);
1828 break;
1829 case BINARY_PRINT_NUM_PAD:
1830 printed += fprintf(fp, " ");
1831 break;
1832 case BINARY_PRINT_SEP:
1833 printed += fprintf(fp, " ");
1834 break;
1835 case BINARY_PRINT_CHAR_DATA:
1836 if (printer_data->hit_nul && ch)
1837 printer_data->is_printable = false;
1838
1839 if (!isprint(ch)) {
1840 printed += fprintf(fp, "%c", '.');
1841
1842 if (!printer_data->is_printable)
1843 break;
1844
1845 if (ch == '\0')
1846 printer_data->hit_nul = true;
1847 else
1848 printer_data->is_printable = false;
1849 } else {
1850 printed += fprintf(fp, "%c", ch);
1851 }
1852 break;
1853 case BINARY_PRINT_CHAR_PAD:
1854 printed += fprintf(fp, " ");
1855 break;
1856 case BINARY_PRINT_LINE_END:
1857 printed += fprintf(fp, "\n");
1858 printer_data->line_no++;
1859 break;
1860 case BINARY_PRINT_DATA_END:
1861 default:
1862 break;
1863 }
1864
1865 return printed;
1866}
1867
1868static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1869{
1870 unsigned int nr_bytes = sample->raw_size;
1871 struct printer_data printer_data = {0, false, true};
1872 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1873 sample__fprintf_bpf_output, &printer_data, fp);
1874
1875 if (printer_data.is_printable && printer_data.hit_nul)
1876 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1877
1878 return printed;
1879}
1880
1881static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1882{
1883 if (len > 0 && len < spacing)
1884 return fprintf(fp, "%*s", spacing - len, "");
1885
1886 return 0;
1887}
1888
1889static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1890{
1891 return perf_sample__fprintf_spacing(len, 34, fp);
1892}
1893
1894/* If a value contains only printable ASCII characters padded with NULLs */
1895static bool ptw_is_prt(u64 val)
1896{
1897 char c;
1898 u32 i;
1899
1900 for (i = 0; i < sizeof(val); i++) {
1901 c = ((char *)&val)[i];
1902 if (!c)
1903 break;
1904 if (!isprint(c) || !isascii(c))
1905 return false;
1906 }
1907 for (; i < sizeof(val); i++) {
1908 c = ((char *)&val)[i];
1909 if (c)
1910 return false;
1911 }
1912 return true;
1913}
1914
1915static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1916{
1917 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1918 char str[sizeof(u64) + 1] = "";
1919 int len;
1920 u64 val;
1921
1922 if (perf_sample__bad_synth_size(sample, *data))
1923 return 0;
1924
1925 val = le64_to_cpu(data->payload);
1926 if (ptw_is_prt(val)) {
1927 memcpy(str, &val, sizeof(val));
1928 str[sizeof(val)] = 0;
1929 }
1930 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " %s ",
1931 data->ip, val, str);
1932 return len + perf_sample__fprintf_pt_spacing(len, fp);
1933}
1934
1935static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1936{
1937 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1938 int len;
1939
1940 if (perf_sample__bad_synth_size(sample, *data))
1941 return 0;
1942
1943 len = fprintf(fp, " hints: %#x extensions: %#x ",
1944 data->hints, data->extensions);
1945 return len + perf_sample__fprintf_pt_spacing(len, fp);
1946}
1947
1948static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1949{
1950 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1951 int len;
1952
1953 if (perf_sample__bad_synth_size(sample, *data))
1954 return 0;
1955
1956 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1957 data->hw, data->cstate, data->subcstate);
1958 return len + perf_sample__fprintf_pt_spacing(len, fp);
1959}
1960
1961static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1962{
1963 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1964 int len;
1965
1966 if (perf_sample__bad_synth_size(sample, *data))
1967 return 0;
1968
1969 len = fprintf(fp, " IP: %u ", data->ip);
1970 return len + perf_sample__fprintf_pt_spacing(len, fp);
1971}
1972
1973static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1974{
1975 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1976 int len;
1977
1978 if (perf_sample__bad_synth_size(sample, *data))
1979 return 0;
1980
1981 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1982 data->deepest_cstate, data->last_cstate,
1983 data->wake_reason);
1984 return len + perf_sample__fprintf_pt_spacing(len, fp);
1985}
1986
1987static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1988{
1989 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1990 unsigned int percent, freq;
1991 int len;
1992
1993 if (perf_sample__bad_synth_size(sample, *data))
1994 return 0;
1995
1996 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1997 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1998 if (data->max_nonturbo) {
1999 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
2000 len += fprintf(fp, "(%3u%%) ", percent);
2001 }
2002 return len + perf_sample__fprintf_pt_spacing(len, fp);
2003}
2004
2005static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
2006{
2007 struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
2008 int len;
2009
2010 if (perf_sample__bad_synth_size(sample, *data))
2011 return 0;
2012
2013 len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
2014 return len + perf_sample__fprintf_pt_spacing(len, fp);
2015}
2016
2017/* Intel PT Event Trace */
2018static int perf_sample__fprintf_synth_evt(struct perf_sample *sample, FILE *fp)
2019{
2020 struct perf_synth_intel_evt *data = perf_sample__synth_ptr(sample);
2021 const char *cfe[32] = {NULL, "INTR", "IRET", "SMI", "RSM", "SIPI",
2022 "INIT", "VMENTRY", "VMEXIT", "VMEXIT_INTR",
2023 "SHUTDOWN", NULL, "UINTR", "UIRET"};
2024 const char *evd[64] = {"PFA", "VMXQ", "VMXR"};
2025 const char *s;
2026 int len, i;
2027
2028 if (perf_sample__bad_synth_size(sample, *data))
2029 return 0;
2030
2031 s = cfe[data->type];
2032 if (s) {
2033 len = fprintf(fp, " cfe: %s IP: %d vector: %u",
2034 s, data->ip, data->vector);
2035 } else {
2036 len = fprintf(fp, " cfe: %u IP: %d vector: %u",
2037 data->type, data->ip, data->vector);
2038 }
2039 for (i = 0; i < data->evd_cnt; i++) {
2040 unsigned int et = data->evd[i].evd_type & 0x3f;
2041
2042 s = evd[et];
2043 if (s) {
2044 len += fprintf(fp, " %s: %#" PRIx64,
2045 s, data->evd[i].payload);
2046 } else {
2047 len += fprintf(fp, " EVD_%u: %#" PRIx64,
2048 et, data->evd[i].payload);
2049 }
2050 }
2051 return len + perf_sample__fprintf_pt_spacing(len, fp);
2052}
2053
2054static int perf_sample__fprintf_synth_iflag_chg(struct perf_sample *sample, FILE *fp)
2055{
2056 struct perf_synth_intel_iflag_chg *data = perf_sample__synth_ptr(sample);
2057 int len;
2058
2059 if (perf_sample__bad_synth_size(sample, *data))
2060 return 0;
2061
2062 len = fprintf(fp, " IFLAG: %d->%d %s branch", !data->iflag, data->iflag,
2063 data->via_branch ? "via" : "non");
2064 return len + perf_sample__fprintf_pt_spacing(len, fp);
2065}
2066
2067static int perf_sample__fprintf_synth(struct perf_sample *sample,
2068 struct evsel *evsel, FILE *fp)
2069{
2070 switch (evsel->core.attr.config) {
2071 case PERF_SYNTH_INTEL_PTWRITE:
2072 return perf_sample__fprintf_synth_ptwrite(sample, fp);
2073 case PERF_SYNTH_INTEL_MWAIT:
2074 return perf_sample__fprintf_synth_mwait(sample, fp);
2075 case PERF_SYNTH_INTEL_PWRE:
2076 return perf_sample__fprintf_synth_pwre(sample, fp);
2077 case PERF_SYNTH_INTEL_EXSTOP:
2078 return perf_sample__fprintf_synth_exstop(sample, fp);
2079 case PERF_SYNTH_INTEL_PWRX:
2080 return perf_sample__fprintf_synth_pwrx(sample, fp);
2081 case PERF_SYNTH_INTEL_CBR:
2082 return perf_sample__fprintf_synth_cbr(sample, fp);
2083 case PERF_SYNTH_INTEL_PSB:
2084 return perf_sample__fprintf_synth_psb(sample, fp);
2085 case PERF_SYNTH_INTEL_EVT:
2086 return perf_sample__fprintf_synth_evt(sample, fp);
2087 case PERF_SYNTH_INTEL_IFLAG_CHG:
2088 return perf_sample__fprintf_synth_iflag_chg(sample, fp);
2089 default:
2090 break;
2091 }
2092
2093 return 0;
2094}
2095
2096static int evlist__max_name_len(struct evlist *evlist)
2097{
2098 struct evsel *evsel;
2099 int max = 0;
2100
2101 evlist__for_each_entry(evlist, evsel) {
2102 int len = strlen(evsel__name(evsel));
2103
2104 max = MAX(len, max);
2105 }
2106
2107 return max;
2108}
2109
2110static int data_src__fprintf(u64 data_src, FILE *fp)
2111{
2112 struct mem_info *mi = mem_info__new();
2113 char decode[100];
2114 char out[100];
2115 static int maxlen;
2116 int len;
2117
2118 if (!mi)
2119 return -ENOMEM;
2120
2121 mem_info__data_src(mi)->val = data_src;
2122 perf_script__meminfo_scnprintf(decode, 100, mi);
2123 mem_info__put(mi);
2124
2125 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
2126 if (maxlen < len)
2127 maxlen = len;
2128
2129 return fprintf(fp, "%-*s", maxlen, out);
2130}
2131
2132struct metric_ctx {
2133 struct perf_sample *sample;
2134 struct thread *thread;
2135 struct evsel *evsel;
2136 FILE *fp;
2137};
2138
2139static void script_print_metric(struct perf_stat_config *config __maybe_unused,
2140 void *ctx, enum metric_threshold_classify thresh,
2141 const char *fmt, const char *unit, double val)
2142{
2143 struct metric_ctx *mctx = ctx;
2144 const char *color = metric_threshold_classify__color(thresh);
2145
2146 if (!fmt)
2147 return;
2148 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2149 PERF_RECORD_SAMPLE, mctx->fp);
2150 fputs("\tmetric: ", mctx->fp);
2151 if (color)
2152 color_fprintf(mctx->fp, color, fmt, val);
2153 else
2154 printf(fmt, val);
2155 fprintf(mctx->fp, " %s\n", unit);
2156}
2157
2158static void script_new_line(struct perf_stat_config *config __maybe_unused,
2159 void *ctx)
2160{
2161 struct metric_ctx *mctx = ctx;
2162
2163 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2164 PERF_RECORD_SAMPLE, mctx->fp);
2165 fputs("\tmetric: ", mctx->fp);
2166}
2167
2168static void perf_sample__fprint_metric(struct perf_script *script,
2169 struct thread *thread,
2170 struct evsel *evsel,
2171 struct perf_sample *sample,
2172 FILE *fp)
2173{
2174 struct evsel *leader = evsel__leader(evsel);
2175 struct perf_stat_output_ctx ctx = {
2176 .print_metric = script_print_metric,
2177 .new_line = script_new_line,
2178 .ctx = &(struct metric_ctx) {
2179 .sample = sample,
2180 .thread = thread,
2181 .evsel = evsel,
2182 .fp = fp,
2183 },
2184 .force_header = false,
2185 };
2186 struct evsel *ev2;
2187 u64 val;
2188
2189 if (!evsel->stats)
2190 evlist__alloc_stats(&stat_config, script->session->evlist, /*alloc_raw=*/false);
2191 if (evsel_script(leader)->gnum++ == 0)
2192 perf_stat__reset_shadow_stats();
2193 val = sample->period * evsel->scale;
2194 evsel_script(evsel)->val = val;
2195 if (evsel_script(leader)->gnum == leader->core.nr_members) {
2196 for_each_group_member (ev2, leader) {
2197 perf_stat__print_shadow_stats(&stat_config, ev2,
2198 evsel_script(ev2)->val,
2199 sample->cpu,
2200 &ctx,
2201 NULL);
2202 }
2203 evsel_script(leader)->gnum = 0;
2204 }
2205}
2206
2207static bool show_event(struct perf_sample *sample,
2208 struct evsel *evsel,
2209 struct thread *thread,
2210 struct addr_location *al,
2211 struct addr_location *addr_al)
2212{
2213 int depth = thread_stack__depth(thread, sample->cpu);
2214
2215 if (!symbol_conf.graph_function)
2216 return true;
2217
2218 if (thread__filter(thread)) {
2219 if (depth <= thread__filter_entry_depth(thread)) {
2220 thread__set_filter(thread, false);
2221 return false;
2222 }
2223 return true;
2224 } else {
2225 const char *s = symbol_conf.graph_function;
2226 u64 ip;
2227 const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
2228 &ip);
2229 unsigned nlen;
2230
2231 if (!name)
2232 return false;
2233 nlen = strlen(name);
2234 while (*s) {
2235 unsigned len = strcspn(s, ",");
2236 if (nlen == len && !strncmp(name, s, len)) {
2237 thread__set_filter(thread, true);
2238 thread__set_filter_entry_depth(thread, depth);
2239 return true;
2240 }
2241 s += len;
2242 if (*s == ',')
2243 s++;
2244 }
2245 return false;
2246 }
2247}
2248
2249static void process_event(struct perf_script *script,
2250 struct perf_sample *sample, struct evsel *evsel,
2251 struct addr_location *al,
2252 struct addr_location *addr_al,
2253 struct machine *machine)
2254{
2255 struct thread *thread = al->thread;
2256 struct perf_event_attr *attr = &evsel->core.attr;
2257 unsigned int type = output_type(attr->type);
2258 struct evsel_script *es = evsel->priv;
2259 FILE *fp = es->fp;
2260 char str[PAGE_SIZE_NAME_LEN];
2261 const char *arch = perf_env__arch(machine->env);
2262
2263 if (output[type].fields == 0)
2264 return;
2265
2266 ++es->samples;
2267
2268 perf_sample__fprintf_start(script, sample, thread, evsel,
2269 PERF_RECORD_SAMPLE, fp);
2270
2271 if (PRINT_FIELD(PERIOD))
2272 fprintf(fp, "%10" PRIu64 " ", sample->period);
2273
2274 if (PRINT_FIELD(EVNAME)) {
2275 const char *evname = evsel__name(evsel);
2276
2277 if (!script->name_width)
2278 script->name_width = evlist__max_name_len(script->session->evlist);
2279
2280 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2281 }
2282
2283 if (print_flags)
2284 perf_sample__fprintf_flags(sample->flags, fp);
2285
2286 if (is_bts_event(attr)) {
2287 perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2288 return;
2289 }
2290#ifdef HAVE_LIBTRACEEVENT
2291 if (PRINT_FIELD(TRACE) && sample->raw_data) {
2292 event_format__fprintf(evsel->tp_format, sample->cpu,
2293 sample->raw_data, sample->raw_size, fp);
2294 }
2295#endif
2296 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2297 perf_sample__fprintf_synth(sample, evsel, fp);
2298
2299 if (PRINT_FIELD(ADDR))
2300 perf_sample__fprintf_addr(sample, thread, attr, fp);
2301
2302 if (PRINT_FIELD(DATA_SRC))
2303 data_src__fprintf(sample->data_src, fp);
2304
2305 if (PRINT_FIELD(WEIGHT))
2306 fprintf(fp, "%16" PRIu64, sample->weight);
2307
2308 if (PRINT_FIELD(INS_LAT))
2309 fprintf(fp, "%16" PRIu16, sample->ins_lat);
2310
2311 if (PRINT_FIELD(RETIRE_LAT))
2312 fprintf(fp, "%16" PRIu16, sample->retire_lat);
2313
2314 if (PRINT_FIELD(CGROUP)) {
2315 const char *cgrp_name;
2316 struct cgroup *cgrp = cgroup__find(machine->env,
2317 sample->cgroup);
2318 if (cgrp != NULL)
2319 cgrp_name = cgrp->name;
2320 else
2321 cgrp_name = "unknown";
2322 fprintf(fp, " %s", cgrp_name);
2323 }
2324
2325 if (PRINT_FIELD(IP)) {
2326 struct callchain_cursor *cursor = NULL;
2327
2328 if (script->stitch_lbr)
2329 thread__set_lbr_stitch_enable(al->thread, true);
2330
2331 if (symbol_conf.use_callchain && sample->callchain) {
2332 cursor = get_tls_callchain_cursor();
2333 if (thread__resolve_callchain(al->thread, cursor, evsel,
2334 sample, NULL, NULL,
2335 scripting_max_stack))
2336 cursor = NULL;
2337 }
2338 fputc(cursor ? '\n' : ' ', fp);
2339 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2340 symbol_conf.bt_stop_list, fp);
2341 }
2342
2343 if (PRINT_FIELD(IREGS))
2344 perf_sample__fprintf_iregs(sample, attr, arch, fp);
2345
2346 if (PRINT_FIELD(UREGS))
2347 perf_sample__fprintf_uregs(sample, attr, arch, fp);
2348
2349 if (PRINT_FIELD(BRSTACK))
2350 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2351 else if (PRINT_FIELD(BRSTACKSYM))
2352 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2353 else if (PRINT_FIELD(BRSTACKOFF))
2354 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2355
2356 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2357 perf_sample__fprintf_bpf_output(sample, fp);
2358 perf_sample__fprintf_insn(sample, evsel, attr, thread, machine, fp, al);
2359
2360 if (PRINT_FIELD(PHYS_ADDR))
2361 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2362
2363 if (PRINT_FIELD(DATA_PAGE_SIZE))
2364 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2365
2366 if (PRINT_FIELD(CODE_PAGE_SIZE))
2367 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2368
2369 perf_sample__fprintf_ipc(sample, attr, fp);
2370
2371 fprintf(fp, "\n");
2372
2373 if (PRINT_FIELD(SRCCODE)) {
2374 if (map__fprintf_srccode(al->map, al->addr, stdout,
2375 thread__srccode_state(thread)))
2376 printf("\n");
2377 }
2378
2379 if (PRINT_FIELD(METRIC))
2380 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2381
2382 if (verbose > 0)
2383 fflush(fp);
2384}
2385
2386static struct scripting_ops *scripting_ops;
2387
2388static void __process_stat(struct evsel *counter, u64 tstamp)
2389{
2390 int nthreads = perf_thread_map__nr(counter->core.threads);
2391 int idx, thread;
2392 struct perf_cpu cpu;
2393 static int header_printed;
2394
2395 if (!header_printed) {
2396 printf("%3s %8s %15s %15s %15s %15s %s\n",
2397 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2398 header_printed = 1;
2399 }
2400
2401 for (thread = 0; thread < nthreads; thread++) {
2402 perf_cpu_map__for_each_cpu(cpu, idx, evsel__cpus(counter)) {
2403 struct perf_counts_values *counts;
2404
2405 counts = perf_counts(counter->counts, idx, thread);
2406
2407 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2408 cpu.cpu,
2409 perf_thread_map__pid(counter->core.threads, thread),
2410 counts->val,
2411 counts->ena,
2412 counts->run,
2413 tstamp,
2414 evsel__name(counter));
2415 }
2416 }
2417}
2418
2419static void process_stat(struct evsel *counter, u64 tstamp)
2420{
2421 if (scripting_ops && scripting_ops->process_stat)
2422 scripting_ops->process_stat(&stat_config, counter, tstamp);
2423 else
2424 __process_stat(counter, tstamp);
2425}
2426
2427static void process_stat_interval(u64 tstamp)
2428{
2429 if (scripting_ops && scripting_ops->process_stat_interval)
2430 scripting_ops->process_stat_interval(tstamp);
2431}
2432
2433static void setup_scripting(void)
2434{
2435#ifdef HAVE_LIBTRACEEVENT
2436 setup_perl_scripting();
2437#endif
2438 setup_python_scripting();
2439}
2440
2441static int flush_scripting(void)
2442{
2443 return scripting_ops ? scripting_ops->flush_script() : 0;
2444}
2445
2446static int cleanup_scripting(void)
2447{
2448 pr_debug("\nperf script stopped\n");
2449
2450 return scripting_ops ? scripting_ops->stop_script() : 0;
2451}
2452
2453static bool filter_cpu(struct perf_sample *sample)
2454{
2455 if (cpu_list && sample->cpu != (u32)-1)
2456 return !test_bit(sample->cpu, cpu_bitmap);
2457 return false;
2458}
2459
2460static int process_sample_event(const struct perf_tool *tool,
2461 union perf_event *event,
2462 struct perf_sample *sample,
2463 struct evsel *evsel,
2464 struct machine *machine)
2465{
2466 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2467 struct addr_location al;
2468 struct addr_location addr_al;
2469 int ret = 0;
2470
2471 /* Set thread to NULL to indicate addr_al and al are not initialized */
2472 addr_location__init(&al);
2473 addr_location__init(&addr_al);
2474
2475 ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2476 if (ret) {
2477 if (ret > 0)
2478 ret = 0;
2479 goto out_put;
2480 }
2481
2482 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2483 sample->time)) {
2484 goto out_put;
2485 }
2486
2487 if (debug_mode) {
2488 if (sample->time < last_timestamp) {
2489 pr_err("Samples misordered, previous: %" PRIu64
2490 " this: %" PRIu64 "\n", last_timestamp,
2491 sample->time);
2492 nr_unordered++;
2493 }
2494 last_timestamp = sample->time;
2495 goto out_put;
2496 }
2497
2498 if (filter_cpu(sample))
2499 goto out_put;
2500
2501 if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2502 pr_err("problem processing %d event, skipping it.\n",
2503 event->header.type);
2504 ret = -1;
2505 goto out_put;
2506 }
2507
2508 if (al.filtered)
2509 goto out_put;
2510
2511 if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2512 goto out_put;
2513
2514 if (evswitch__discard(&scr->evswitch, evsel))
2515 goto out_put;
2516
2517 ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2518 if (ret) {
2519 if (ret > 0)
2520 ret = 0;
2521 goto out_put;
2522 }
2523
2524 if (scripting_ops) {
2525 struct addr_location *addr_al_ptr = NULL;
2526
2527 if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2528 sample_addr_correlates_sym(&evsel->core.attr)) {
2529 if (!addr_al.thread)
2530 thread__resolve(al.thread, &addr_al, sample);
2531 addr_al_ptr = &addr_al;
2532 }
2533 scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2534 } else {
2535 process_event(scr, sample, evsel, &al, &addr_al, machine);
2536 }
2537
2538out_put:
2539 addr_location__exit(&addr_al);
2540 addr_location__exit(&al);
2541 return ret;
2542}
2543
2544// Used when scr->per_event_dump is not set
2545static struct evsel_script es_stdout;
2546
2547static int process_attr(const struct perf_tool *tool, union perf_event *event,
2548 struct evlist **pevlist)
2549{
2550 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2551 struct evlist *evlist;
2552 struct evsel *evsel, *pos;
2553 u64 sample_type;
2554 int err;
2555
2556 err = perf_event__process_attr(tool, event, pevlist);
2557 if (err)
2558 return err;
2559
2560 evlist = *pevlist;
2561 evsel = evlist__last(*pevlist);
2562
2563 if (!evsel->priv) {
2564 if (scr->per_event_dump) {
2565 evsel->priv = evsel_script__new(evsel, scr->session->data);
2566 if (!evsel->priv)
2567 return -ENOMEM;
2568 } else { // Replicate what is done in perf_script__setup_per_event_dump()
2569 es_stdout.fp = stdout;
2570 evsel->priv = &es_stdout;
2571 }
2572 }
2573
2574 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2575 evsel->core.attr.type != PERF_TYPE_SYNTH)
2576 return 0;
2577
2578 evlist__for_each_entry(evlist, pos) {
2579 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2580 return 0;
2581 }
2582
2583 if (evsel->core.attr.sample_type) {
2584 err = evsel__check_attr(evsel, scr->session);
2585 if (err)
2586 return err;
2587 }
2588
2589 /*
2590 * Check if we need to enable callchains based
2591 * on events sample_type.
2592 */
2593 sample_type = evlist__combined_sample_type(evlist);
2594 callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
2595
2596 /* Enable fields for callchain entries */
2597 if (symbol_conf.use_callchain &&
2598 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2599 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2600 (sample_type & PERF_SAMPLE_REGS_USER &&
2601 sample_type & PERF_SAMPLE_STACK_USER))) {
2602 int type = output_type(evsel->core.attr.type);
2603
2604 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2605 output[type].fields |= PERF_OUTPUT_IP;
2606 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2607 output[type].fields |= PERF_OUTPUT_SYM;
2608 }
2609 set_print_ip_opts(&evsel->core.attr);
2610 return 0;
2611}
2612
2613static int print_event_with_time(const struct perf_tool *tool,
2614 union perf_event *event,
2615 struct perf_sample *sample,
2616 struct machine *machine,
2617 pid_t pid, pid_t tid, u64 timestamp)
2618{
2619 struct perf_script *script = container_of(tool, struct perf_script, tool);
2620 struct perf_session *session = script->session;
2621 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2622 struct thread *thread = NULL;
2623
2624 if (evsel && !evsel->core.attr.sample_id_all) {
2625 sample->cpu = 0;
2626 sample->time = timestamp;
2627 sample->pid = pid;
2628 sample->tid = tid;
2629 }
2630
2631 if (filter_cpu(sample))
2632 return 0;
2633
2634 if (tid != -1)
2635 thread = machine__findnew_thread(machine, pid, tid);
2636
2637 if (evsel) {
2638 perf_sample__fprintf_start(script, sample, thread, evsel,
2639 event->header.type, stdout);
2640 }
2641
2642 perf_event__fprintf(event, machine, stdout);
2643
2644 thread__put(thread);
2645
2646 return 0;
2647}
2648
2649static int print_event(const struct perf_tool *tool, union perf_event *event,
2650 struct perf_sample *sample, struct machine *machine,
2651 pid_t pid, pid_t tid)
2652{
2653 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2654}
2655
2656static int process_comm_event(const struct perf_tool *tool,
2657 union perf_event *event,
2658 struct perf_sample *sample,
2659 struct machine *machine)
2660{
2661 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2662 return -1;
2663
2664 return print_event(tool, event, sample, machine, event->comm.pid,
2665 event->comm.tid);
2666}
2667
2668static int process_namespaces_event(const struct perf_tool *tool,
2669 union perf_event *event,
2670 struct perf_sample *sample,
2671 struct machine *machine)
2672{
2673 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2674 return -1;
2675
2676 return print_event(tool, event, sample, machine, event->namespaces.pid,
2677 event->namespaces.tid);
2678}
2679
2680static int process_cgroup_event(const struct perf_tool *tool,
2681 union perf_event *event,
2682 struct perf_sample *sample,
2683 struct machine *machine)
2684{
2685 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2686 return -1;
2687
2688 return print_event(tool, event, sample, machine, sample->pid,
2689 sample->tid);
2690}
2691
2692static int process_fork_event(const struct perf_tool *tool,
2693 union perf_event *event,
2694 struct perf_sample *sample,
2695 struct machine *machine)
2696{
2697 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2698 return -1;
2699
2700 return print_event_with_time(tool, event, sample, machine,
2701 event->fork.pid, event->fork.tid,
2702 event->fork.time);
2703}
2704static int process_exit_event(const struct perf_tool *tool,
2705 union perf_event *event,
2706 struct perf_sample *sample,
2707 struct machine *machine)
2708{
2709 /* Print before 'exit' deletes anything */
2710 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2711 event->fork.tid, event->fork.time))
2712 return -1;
2713
2714 return perf_event__process_exit(tool, event, sample, machine);
2715}
2716
2717static int process_mmap_event(const struct perf_tool *tool,
2718 union perf_event *event,
2719 struct perf_sample *sample,
2720 struct machine *machine)
2721{
2722 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2723 return -1;
2724
2725 return print_event(tool, event, sample, machine, event->mmap.pid,
2726 event->mmap.tid);
2727}
2728
2729static int process_mmap2_event(const struct perf_tool *tool,
2730 union perf_event *event,
2731 struct perf_sample *sample,
2732 struct machine *machine)
2733{
2734 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2735 return -1;
2736
2737 return print_event(tool, event, sample, machine, event->mmap2.pid,
2738 event->mmap2.tid);
2739}
2740
2741static int process_switch_event(const struct perf_tool *tool,
2742 union perf_event *event,
2743 struct perf_sample *sample,
2744 struct machine *machine)
2745{
2746 struct perf_script *script = container_of(tool, struct perf_script, tool);
2747
2748 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2749 return -1;
2750
2751 if (scripting_ops && scripting_ops->process_switch && !filter_cpu(sample))
2752 scripting_ops->process_switch(event, sample, machine);
2753
2754 if (!script->show_switch_events)
2755 return 0;
2756
2757 return print_event(tool, event, sample, machine, sample->pid,
2758 sample->tid);
2759}
2760
2761static int process_auxtrace_error(struct perf_session *session,
2762 union perf_event *event)
2763{
2764 if (scripting_ops && scripting_ops->process_auxtrace_error) {
2765 scripting_ops->process_auxtrace_error(session, event);
2766 return 0;
2767 }
2768
2769 return perf_event__process_auxtrace_error(session, event);
2770}
2771
2772static int
2773process_lost_event(const struct perf_tool *tool,
2774 union perf_event *event,
2775 struct perf_sample *sample,
2776 struct machine *machine)
2777{
2778 return print_event(tool, event, sample, machine, sample->pid,
2779 sample->tid);
2780}
2781
2782static int
2783process_throttle_event(const struct perf_tool *tool __maybe_unused,
2784 union perf_event *event,
2785 struct perf_sample *sample,
2786 struct machine *machine)
2787{
2788 if (scripting_ops && scripting_ops->process_throttle)
2789 scripting_ops->process_throttle(event, sample, machine);
2790 return 0;
2791}
2792
2793static int
2794process_finished_round_event(const struct perf_tool *tool __maybe_unused,
2795 union perf_event *event,
2796 struct ordered_events *oe __maybe_unused)
2797
2798{
2799 perf_event__fprintf(event, NULL, stdout);
2800 return 0;
2801}
2802
2803static int
2804process_bpf_events(const struct perf_tool *tool __maybe_unused,
2805 union perf_event *event,
2806 struct perf_sample *sample,
2807 struct machine *machine)
2808{
2809 if (machine__process_ksymbol(machine, event, sample) < 0)
2810 return -1;
2811
2812 return print_event(tool, event, sample, machine, sample->pid,
2813 sample->tid);
2814}
2815
2816static int process_text_poke_events(const struct perf_tool *tool,
2817 union perf_event *event,
2818 struct perf_sample *sample,
2819 struct machine *machine)
2820{
2821 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2822 return -1;
2823
2824 return print_event(tool, event, sample, machine, sample->pid,
2825 sample->tid);
2826}
2827
2828static void sig_handler(int sig __maybe_unused)
2829{
2830 session_done = 1;
2831}
2832
2833static void perf_script__fclose_per_event_dump(struct perf_script *script)
2834{
2835 struct evlist *evlist = script->session->evlist;
2836 struct evsel *evsel;
2837
2838 evlist__for_each_entry(evlist, evsel) {
2839 if (!evsel->priv)
2840 break;
2841 evsel_script__delete(evsel->priv);
2842 evsel->priv = NULL;
2843 }
2844}
2845
2846static int perf_script__fopen_per_event_dump(struct perf_script *script)
2847{
2848 struct evsel *evsel;
2849
2850 evlist__for_each_entry(script->session->evlist, evsel) {
2851 /*
2852 * Already setup? I.e. we may be called twice in cases like
2853 * Intel PT, one for the intel_pt// and dummy events, then
2854 * for the evsels synthesized from the auxtrace info.
2855 *
2856 * Ses perf_script__process_auxtrace_info.
2857 */
2858 if (evsel->priv != NULL)
2859 continue;
2860
2861 evsel->priv = evsel_script__new(evsel, script->session->data);
2862 if (evsel->priv == NULL)
2863 goto out_err_fclose;
2864 }
2865
2866 return 0;
2867
2868out_err_fclose:
2869 perf_script__fclose_per_event_dump(script);
2870 return -1;
2871}
2872
2873static int perf_script__setup_per_event_dump(struct perf_script *script)
2874{
2875 struct evsel *evsel;
2876
2877 if (script->per_event_dump)
2878 return perf_script__fopen_per_event_dump(script);
2879
2880 es_stdout.fp = stdout;
2881
2882 evlist__for_each_entry(script->session->evlist, evsel)
2883 evsel->priv = &es_stdout;
2884
2885 return 0;
2886}
2887
2888static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2889{
2890 struct evsel *evsel;
2891
2892 evlist__for_each_entry(script->session->evlist, evsel) {
2893 struct evsel_script *es = evsel->priv;
2894
2895 evsel_script__fprintf(es, stdout);
2896 evsel_script__delete(es);
2897 evsel->priv = NULL;
2898 }
2899}
2900
2901static void perf_script__exit(struct perf_script *script)
2902{
2903 perf_thread_map__put(script->threads);
2904 perf_cpu_map__put(script->cpus);
2905}
2906
2907static int __cmd_script(struct perf_script *script)
2908{
2909 int ret;
2910
2911 signal(SIGINT, sig_handler);
2912
2913 /* override event processing functions */
2914 if (script->show_task_events) {
2915 script->tool.comm = process_comm_event;
2916 script->tool.fork = process_fork_event;
2917 script->tool.exit = process_exit_event;
2918 }
2919 if (script->show_mmap_events) {
2920 script->tool.mmap = process_mmap_event;
2921 script->tool.mmap2 = process_mmap2_event;
2922 }
2923 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2924 script->tool.context_switch = process_switch_event;
2925 if (scripting_ops && scripting_ops->process_auxtrace_error)
2926 script->tool.auxtrace_error = process_auxtrace_error;
2927 if (script->show_namespace_events)
2928 script->tool.namespaces = process_namespaces_event;
2929 if (script->show_cgroup_events)
2930 script->tool.cgroup = process_cgroup_event;
2931 if (script->show_lost_events)
2932 script->tool.lost = process_lost_event;
2933 if (script->show_round_events) {
2934 script->tool.ordered_events = false;
2935 script->tool.finished_round = process_finished_round_event;
2936 }
2937 if (script->show_bpf_events) {
2938 script->tool.ksymbol = process_bpf_events;
2939 script->tool.bpf = process_bpf_events;
2940 }
2941 if (script->show_text_poke_events) {
2942 script->tool.ksymbol = process_bpf_events;
2943 script->tool.text_poke = process_text_poke_events;
2944 }
2945
2946 if (perf_script__setup_per_event_dump(script)) {
2947 pr_err("Couldn't create the per event dump files\n");
2948 return -1;
2949 }
2950
2951 ret = perf_session__process_events(script->session);
2952
2953 if (script->per_event_dump)
2954 perf_script__exit_per_event_dump_stats(script);
2955
2956 if (debug_mode)
2957 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2958
2959 return ret;
2960}
2961
2962struct script_spec {
2963 struct list_head node;
2964 struct scripting_ops *ops;
2965 char spec[];
2966};
2967
2968static LIST_HEAD(script_specs);
2969
2970static struct script_spec *script_spec__new(const char *spec,
2971 struct scripting_ops *ops)
2972{
2973 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2974
2975 if (s != NULL) {
2976 strcpy(s->spec, spec);
2977 s->ops = ops;
2978 }
2979
2980 return s;
2981}
2982
2983static void script_spec__add(struct script_spec *s)
2984{
2985 list_add_tail(&s->node, &script_specs);
2986}
2987
2988static struct script_spec *script_spec__find(const char *spec)
2989{
2990 struct script_spec *s;
2991
2992 list_for_each_entry(s, &script_specs, node)
2993 if (strcasecmp(s->spec, spec) == 0)
2994 return s;
2995 return NULL;
2996}
2997
2998int script_spec_register(const char *spec, struct scripting_ops *ops)
2999{
3000 struct script_spec *s;
3001
3002 s = script_spec__find(spec);
3003 if (s)
3004 return -1;
3005
3006 s = script_spec__new(spec, ops);
3007 if (!s)
3008 return -1;
3009 else
3010 script_spec__add(s);
3011
3012 return 0;
3013}
3014
3015static struct scripting_ops *script_spec__lookup(const char *spec)
3016{
3017 struct script_spec *s = script_spec__find(spec);
3018 if (!s)
3019 return NULL;
3020
3021 return s->ops;
3022}
3023
3024static void list_available_languages(void)
3025{
3026 struct script_spec *s;
3027
3028 fprintf(stderr, "\n");
3029 fprintf(stderr, "Scripting language extensions (used in "
3030 "perf script -s [spec:]script.[spec]):\n\n");
3031
3032 list_for_each_entry(s, &script_specs, node)
3033 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
3034
3035 fprintf(stderr, "\n");
3036}
3037
3038/* Find script file relative to current directory or exec path */
3039static char *find_script(const char *script)
3040{
3041 char path[PATH_MAX];
3042
3043 if (!scripting_ops) {
3044 const char *ext = strrchr(script, '.');
3045
3046 if (!ext)
3047 return NULL;
3048
3049 scripting_ops = script_spec__lookup(++ext);
3050 if (!scripting_ops)
3051 return NULL;
3052 }
3053
3054 if (access(script, R_OK)) {
3055 char *exec_path = get_argv_exec_path();
3056
3057 if (!exec_path)
3058 return NULL;
3059 snprintf(path, sizeof(path), "%s/scripts/%s/%s",
3060 exec_path, scripting_ops->dirname, script);
3061 free(exec_path);
3062 script = path;
3063 if (access(script, R_OK))
3064 return NULL;
3065 }
3066 return strdup(script);
3067}
3068
3069static int parse_scriptname(const struct option *opt __maybe_unused,
3070 const char *str, int unset __maybe_unused)
3071{
3072 char spec[PATH_MAX];
3073 const char *script, *ext;
3074 int len;
3075
3076 if (strcmp(str, "lang") == 0) {
3077 list_available_languages();
3078 exit(0);
3079 }
3080
3081 script = strchr(str, ':');
3082 if (script) {
3083 len = script - str;
3084 if (len >= PATH_MAX) {
3085 fprintf(stderr, "invalid language specifier");
3086 return -1;
3087 }
3088 strncpy(spec, str, len);
3089 spec[len] = '\0';
3090 scripting_ops = script_spec__lookup(spec);
3091 if (!scripting_ops) {
3092 fprintf(stderr, "invalid language specifier");
3093 return -1;
3094 }
3095 script++;
3096 } else {
3097 script = str;
3098 ext = strrchr(script, '.');
3099 if (!ext) {
3100 fprintf(stderr, "invalid script extension");
3101 return -1;
3102 }
3103 scripting_ops = script_spec__lookup(++ext);
3104 if (!scripting_ops) {
3105 fprintf(stderr, "invalid script extension");
3106 return -1;
3107 }
3108 }
3109
3110 script_name = find_script(script);
3111 if (!script_name)
3112 script_name = strdup(script);
3113
3114 return 0;
3115}
3116
3117static int parse_output_fields(const struct option *opt __maybe_unused,
3118 const char *arg, int unset __maybe_unused)
3119{
3120 char *tok, *strtok_saveptr = NULL;
3121 int i, imax = ARRAY_SIZE(all_output_options);
3122 int j;
3123 int rc = 0;
3124 char *str = strdup(arg);
3125 int type = -1;
3126 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
3127
3128 if (!str)
3129 return -ENOMEM;
3130
3131 /* first word can state for which event type the user is specifying
3132 * the fields. If no type exists, the specified fields apply to all
3133 * event types found in the file minus the invalid fields for a type.
3134 */
3135 tok = strchr(str, ':');
3136 if (tok) {
3137 *tok = '\0';
3138 tok++;
3139 if (!strcmp(str, "hw"))
3140 type = PERF_TYPE_HARDWARE;
3141 else if (!strcmp(str, "sw"))
3142 type = PERF_TYPE_SOFTWARE;
3143 else if (!strcmp(str, "trace"))
3144 type = PERF_TYPE_TRACEPOINT;
3145 else if (!strcmp(str, "raw"))
3146 type = PERF_TYPE_RAW;
3147 else if (!strcmp(str, "break"))
3148 type = PERF_TYPE_BREAKPOINT;
3149 else if (!strcmp(str, "synth"))
3150 type = OUTPUT_TYPE_SYNTH;
3151 else {
3152 fprintf(stderr, "Invalid event type in field string.\n");
3153 rc = -EINVAL;
3154 goto out;
3155 }
3156
3157 if (output[type].user_set)
3158 pr_warning("Overriding previous field request for %s events.\n",
3159 event_type(type));
3160
3161 /* Don't override defaults for +- */
3162 if (strchr(tok, '+') || strchr(tok, '-'))
3163 goto parse;
3164
3165 output[type].fields = 0;
3166 output[type].user_set = true;
3167 output[type].wildcard_set = false;
3168
3169 } else {
3170 tok = str;
3171 if (strlen(str) == 0) {
3172 fprintf(stderr,
3173 "Cannot set fields to 'none' for all event types.\n");
3174 rc = -EINVAL;
3175 goto out;
3176 }
3177
3178 /* Don't override defaults for +- */
3179 if (strchr(str, '+') || strchr(str, '-'))
3180 goto parse;
3181
3182 if (output_set_by_user())
3183 pr_warning("Overriding previous field request for all events.\n");
3184
3185 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3186 output[j].fields = 0;
3187 output[j].user_set = true;
3188 output[j].wildcard_set = true;
3189 }
3190 }
3191
3192parse:
3193 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
3194 if (*tok == '+') {
3195 if (change == SET)
3196 goto out_badmix;
3197 change = ADD;
3198 tok++;
3199 } else if (*tok == '-') {
3200 if (change == SET)
3201 goto out_badmix;
3202 change = REMOVE;
3203 tok++;
3204 } else {
3205 if (change != SET && change != DEFAULT)
3206 goto out_badmix;
3207 change = SET;
3208 }
3209
3210 for (i = 0; i < imax; ++i) {
3211 if (strcmp(tok, all_output_options[i].str) == 0)
3212 break;
3213 }
3214 if (i == imax && strcmp(tok, "flags") == 0) {
3215 print_flags = change != REMOVE;
3216 continue;
3217 }
3218 if (i == imax) {
3219 fprintf(stderr, "Invalid field requested.\n");
3220 rc = -EINVAL;
3221 goto out;
3222 }
3223#ifndef HAVE_LIBCAPSTONE_SUPPORT
3224 if (change != REMOVE && strcmp(tok, "disasm") == 0) {
3225 fprintf(stderr, "Field \"disasm\" requires perf to be built with libcapstone support.\n");
3226 rc = -EINVAL;
3227 goto out;
3228 }
3229#endif
3230
3231 if (type == -1) {
3232 /* add user option to all events types for
3233 * which it is valid
3234 */
3235 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3236 if (output[j].invalid_fields & all_output_options[i].field) {
3237 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
3238 all_output_options[i].str, event_type(j));
3239 } else {
3240 if (change == REMOVE) {
3241 output[j].fields &= ~all_output_options[i].field;
3242 output[j].user_set_fields &= ~all_output_options[i].field;
3243 output[j].user_unset_fields |= all_output_options[i].field;
3244 } else {
3245 output[j].fields |= all_output_options[i].field;
3246 output[j].user_set_fields |= all_output_options[i].field;
3247 output[j].user_unset_fields &= ~all_output_options[i].field;
3248 }
3249 output[j].user_set = true;
3250 output[j].wildcard_set = true;
3251 }
3252 }
3253 } else {
3254 if (output[type].invalid_fields & all_output_options[i].field) {
3255 fprintf(stderr, "\'%s\' not valid for %s events.\n",
3256 all_output_options[i].str, event_type(type));
3257
3258 rc = -EINVAL;
3259 goto out;
3260 }
3261 if (change == REMOVE)
3262 output[type].fields &= ~all_output_options[i].field;
3263 else
3264 output[type].fields |= all_output_options[i].field;
3265 output[type].user_set = true;
3266 output[type].wildcard_set = true;
3267 }
3268 }
3269
3270 if (type >= 0) {
3271 if (output[type].fields == 0) {
3272 pr_debug("No fields requested for %s type. "
3273 "Events will not be displayed.\n", event_type(type));
3274 }
3275 }
3276 goto out;
3277
3278out_badmix:
3279 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
3280 rc = -EINVAL;
3281out:
3282 free(str);
3283 return rc;
3284}
3285
3286#define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
3287 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
3288 if ((lang_dirent->d_type == DT_DIR || \
3289 (lang_dirent->d_type == DT_UNKNOWN && \
3290 is_directory(scripts_path, lang_dirent))) && \
3291 (strcmp(lang_dirent->d_name, ".")) && \
3292 (strcmp(lang_dirent->d_name, "..")))
3293
3294#define for_each_script(lang_path, lang_dir, script_dirent) \
3295 while ((script_dirent = readdir(lang_dir)) != NULL) \
3296 if (script_dirent->d_type != DT_DIR && \
3297 (script_dirent->d_type != DT_UNKNOWN || \
3298 !is_directory(lang_path, script_dirent)))
3299
3300
3301#define RECORD_SUFFIX "-record"
3302#define REPORT_SUFFIX "-report"
3303
3304struct script_desc {
3305 struct list_head node;
3306 char *name;
3307 char *half_liner;
3308 char *args;
3309};
3310
3311static LIST_HEAD(script_descs);
3312
3313static struct script_desc *script_desc__new(const char *name)
3314{
3315 struct script_desc *s = zalloc(sizeof(*s));
3316
3317 if (s != NULL && name)
3318 s->name = strdup(name);
3319
3320 return s;
3321}
3322
3323static void script_desc__delete(struct script_desc *s)
3324{
3325 zfree(&s->name);
3326 zfree(&s->half_liner);
3327 zfree(&s->args);
3328 free(s);
3329}
3330
3331static void script_desc__add(struct script_desc *s)
3332{
3333 list_add_tail(&s->node, &script_descs);
3334}
3335
3336static struct script_desc *script_desc__find(const char *name)
3337{
3338 struct script_desc *s;
3339
3340 list_for_each_entry(s, &script_descs, node)
3341 if (strcasecmp(s->name, name) == 0)
3342 return s;
3343 return NULL;
3344}
3345
3346static struct script_desc *script_desc__findnew(const char *name)
3347{
3348 struct script_desc *s = script_desc__find(name);
3349
3350 if (s)
3351 return s;
3352
3353 s = script_desc__new(name);
3354 if (!s)
3355 return NULL;
3356
3357 script_desc__add(s);
3358
3359 return s;
3360}
3361
3362static const char *ends_with(const char *str, const char *suffix)
3363{
3364 size_t suffix_len = strlen(suffix);
3365 const char *p = str;
3366
3367 if (strlen(str) > suffix_len) {
3368 p = str + strlen(str) - suffix_len;
3369 if (!strncmp(p, suffix, suffix_len))
3370 return p;
3371 }
3372
3373 return NULL;
3374}
3375
3376static int read_script_info(struct script_desc *desc, const char *filename)
3377{
3378 char line[BUFSIZ], *p;
3379 FILE *fp;
3380
3381 fp = fopen(filename, "r");
3382 if (!fp)
3383 return -1;
3384
3385 while (fgets(line, sizeof(line), fp)) {
3386 p = skip_spaces(line);
3387 if (strlen(p) == 0)
3388 continue;
3389 if (*p != '#')
3390 continue;
3391 p++;
3392 if (strlen(p) && *p == '!')
3393 continue;
3394
3395 p = skip_spaces(p);
3396 if (strlen(p) && p[strlen(p) - 1] == '\n')
3397 p[strlen(p) - 1] = '\0';
3398
3399 if (!strncmp(p, "description:", strlen("description:"))) {
3400 p += strlen("description:");
3401 desc->half_liner = strdup(skip_spaces(p));
3402 continue;
3403 }
3404
3405 if (!strncmp(p, "args:", strlen("args:"))) {
3406 p += strlen("args:");
3407 desc->args = strdup(skip_spaces(p));
3408 continue;
3409 }
3410 }
3411
3412 fclose(fp);
3413
3414 return 0;
3415}
3416
3417static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3418{
3419 char *script_root, *str;
3420
3421 script_root = strdup(script_dirent->d_name);
3422 if (!script_root)
3423 return NULL;
3424
3425 str = (char *)ends_with(script_root, suffix);
3426 if (!str) {
3427 free(script_root);
3428 return NULL;
3429 }
3430
3431 *str = '\0';
3432 return script_root;
3433}
3434
3435static int list_available_scripts(const struct option *opt __maybe_unused,
3436 const char *s __maybe_unused,
3437 int unset __maybe_unused)
3438{
3439 struct dirent *script_dirent, *lang_dirent;
3440 char *buf, *scripts_path, *script_path, *lang_path, *first_half;
3441 DIR *scripts_dir, *lang_dir;
3442 struct script_desc *desc;
3443 char *script_root;
3444
3445 buf = malloc(3 * MAXPATHLEN + BUFSIZ);
3446 if (!buf) {
3447 pr_err("malloc failed\n");
3448 exit(-1);
3449 }
3450 scripts_path = buf;
3451 script_path = buf + MAXPATHLEN;
3452 lang_path = buf + 2 * MAXPATHLEN;
3453 first_half = buf + 3 * MAXPATHLEN;
3454
3455 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3456
3457 scripts_dir = opendir(scripts_path);
3458 if (!scripts_dir) {
3459 fprintf(stdout,
3460 "open(%s) failed.\n"
3461 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3462 scripts_path);
3463 free(buf);
3464 exit(-1);
3465 }
3466
3467 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3468 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3469 lang_dirent->d_name);
3470 lang_dir = opendir(lang_path);
3471 if (!lang_dir)
3472 continue;
3473
3474 for_each_script(lang_path, lang_dir, script_dirent) {
3475 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3476 if (script_root) {
3477 desc = script_desc__findnew(script_root);
3478 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3479 lang_path, script_dirent->d_name);
3480 read_script_info(desc, script_path);
3481 free(script_root);
3482 }
3483 }
3484 }
3485
3486 fprintf(stdout, "List of available trace scripts:\n");
3487 list_for_each_entry(desc, &script_descs, node) {
3488 sprintf(first_half, "%s %s", desc->name,
3489 desc->args ? desc->args : "");
3490 fprintf(stdout, " %-36s %s\n", first_half,
3491 desc->half_liner ? desc->half_liner : "");
3492 }
3493
3494 free(buf);
3495 exit(0);
3496}
3497
3498static int add_dlarg(const struct option *opt __maybe_unused,
3499 const char *s, int unset __maybe_unused)
3500{
3501 char *arg = strdup(s);
3502 void *a;
3503
3504 if (!arg)
3505 return -1;
3506
3507 a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
3508 if (!a) {
3509 free(arg);
3510 return -1;
3511 }
3512
3513 dlargv = a;
3514 dlargv[dlargc++] = arg;
3515
3516 return 0;
3517}
3518
3519static void free_dlarg(void)
3520{
3521 while (dlargc--)
3522 free(dlargv[dlargc]);
3523 free(dlargv);
3524}
3525
3526/*
3527 * Some scripts specify the required events in their "xxx-record" file,
3528 * this function will check if the events in perf.data match those
3529 * mentioned in the "xxx-record".
3530 *
3531 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3532 * which is covered well now. And new parsing code should be added to
3533 * cover the future complex formats like event groups etc.
3534 */
3535static int check_ev_match(char *dir_name, char *scriptname,
3536 struct perf_session *session)
3537{
3538 char filename[MAXPATHLEN], evname[128];
3539 char line[BUFSIZ], *p;
3540 struct evsel *pos;
3541 int match, len;
3542 FILE *fp;
3543
3544 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3545
3546 fp = fopen(filename, "r");
3547 if (!fp)
3548 return -1;
3549
3550 while (fgets(line, sizeof(line), fp)) {
3551 p = skip_spaces(line);
3552 if (*p == '#')
3553 continue;
3554
3555 while (strlen(p)) {
3556 p = strstr(p, "-e");
3557 if (!p)
3558 break;
3559
3560 p += 2;
3561 p = skip_spaces(p);
3562 len = strcspn(p, " \t");
3563 if (!len)
3564 break;
3565
3566 snprintf(evname, len + 1, "%s", p);
3567
3568 match = 0;
3569 evlist__for_each_entry(session->evlist, pos) {
3570 if (evsel__name_is(pos, evname)) {
3571 match = 1;
3572 break;
3573 }
3574 }
3575
3576 if (!match) {
3577 fclose(fp);
3578 return -1;
3579 }
3580 }
3581 }
3582
3583 fclose(fp);
3584 return 0;
3585}
3586
3587/*
3588 * Return -1 if none is found, otherwise the actual scripts number.
3589 *
3590 * Currently the only user of this function is the script browser, which
3591 * will list all statically runnable scripts, select one, execute it and
3592 * show the output in a perf browser.
3593 */
3594int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3595 int pathlen)
3596{
3597 struct dirent *script_dirent, *lang_dirent;
3598 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3599 DIR *scripts_dir, *lang_dir;
3600 struct perf_session *session;
3601 struct perf_data data = {
3602 .path = input_name,
3603 .mode = PERF_DATA_MODE_READ,
3604 };
3605 char *temp;
3606 int i = 0;
3607
3608 session = perf_session__new(&data, NULL);
3609 if (IS_ERR(session))
3610 return PTR_ERR(session);
3611
3612 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3613
3614 scripts_dir = opendir(scripts_path);
3615 if (!scripts_dir) {
3616 perf_session__delete(session);
3617 return -1;
3618 }
3619
3620 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3621 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3622 lang_dirent->d_name);
3623#ifndef HAVE_LIBPERL_SUPPORT
3624 if (strstr(lang_path, "perl"))
3625 continue;
3626#endif
3627#ifndef HAVE_LIBPYTHON_SUPPORT
3628 if (strstr(lang_path, "python"))
3629 continue;
3630#endif
3631
3632 lang_dir = opendir(lang_path);
3633 if (!lang_dir)
3634 continue;
3635
3636 for_each_script(lang_path, lang_dir, script_dirent) {
3637 /* Skip those real time scripts: xxxtop.p[yl] */
3638 if (strstr(script_dirent->d_name, "top."))
3639 continue;
3640 if (i >= num)
3641 break;
3642 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3643 lang_path,
3644 script_dirent->d_name);
3645 temp = strchr(script_dirent->d_name, '.');
3646 snprintf(scripts_array[i],
3647 (temp - script_dirent->d_name) + 1,
3648 "%s", script_dirent->d_name);
3649
3650 if (check_ev_match(lang_path,
3651 scripts_array[i], session))
3652 continue;
3653
3654 i++;
3655 }
3656 closedir(lang_dir);
3657 }
3658
3659 closedir(scripts_dir);
3660 perf_session__delete(session);
3661 return i;
3662}
3663
3664static char *get_script_path(const char *script_root, const char *suffix)
3665{
3666 struct dirent *script_dirent, *lang_dirent;
3667 char scripts_path[MAXPATHLEN];
3668 char script_path[MAXPATHLEN];
3669 DIR *scripts_dir, *lang_dir;
3670 char lang_path[MAXPATHLEN];
3671 char *__script_root;
3672
3673 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3674
3675 scripts_dir = opendir(scripts_path);
3676 if (!scripts_dir)
3677 return NULL;
3678
3679 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3680 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3681 lang_dirent->d_name);
3682 lang_dir = opendir(lang_path);
3683 if (!lang_dir)
3684 continue;
3685
3686 for_each_script(lang_path, lang_dir, script_dirent) {
3687 __script_root = get_script_root(script_dirent, suffix);
3688 if (__script_root && !strcmp(script_root, __script_root)) {
3689 free(__script_root);
3690 closedir(scripts_dir);
3691 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3692 lang_path, script_dirent->d_name);
3693 closedir(lang_dir);
3694 return strdup(script_path);
3695 }
3696 free(__script_root);
3697 }
3698 closedir(lang_dir);
3699 }
3700 closedir(scripts_dir);
3701
3702 return NULL;
3703}
3704
3705static bool is_top_script(const char *script_path)
3706{
3707 return ends_with(script_path, "top") != NULL;
3708}
3709
3710static int has_required_arg(char *script_path)
3711{
3712 struct script_desc *desc;
3713 int n_args = 0;
3714 char *p;
3715
3716 desc = script_desc__new(NULL);
3717
3718 if (read_script_info(desc, script_path))
3719 goto out;
3720
3721 if (!desc->args)
3722 goto out;
3723
3724 for (p = desc->args; *p; p++)
3725 if (*p == '<')
3726 n_args++;
3727out:
3728 script_desc__delete(desc);
3729
3730 return n_args;
3731}
3732
3733static int have_cmd(int argc, const char **argv)
3734{
3735 char **__argv = malloc(sizeof(const char *) * argc);
3736
3737 if (!__argv) {
3738 pr_err("malloc failed\n");
3739 return -1;
3740 }
3741
3742 memcpy(__argv, argv, sizeof(const char *) * argc);
3743 argc = parse_options(argc, (const char **)__argv, record_options,
3744 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3745 free(__argv);
3746
3747 system_wide = (argc == 0);
3748
3749 return 0;
3750}
3751
3752static void script__setup_sample_type(struct perf_script *script)
3753{
3754 struct perf_session *session = script->session;
3755 u64 sample_type = evlist__combined_sample_type(session->evlist);
3756
3757 callchain_param_setup(sample_type, perf_env__arch(session->machines.host.env));
3758
3759 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3760 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3761 "Please apply --call-graph lbr when recording.\n");
3762 script->stitch_lbr = false;
3763 }
3764}
3765
3766static int process_stat_round_event(struct perf_session *session,
3767 union perf_event *event)
3768{
3769 struct perf_record_stat_round *round = &event->stat_round;
3770 struct evsel *counter;
3771
3772 evlist__for_each_entry(session->evlist, counter) {
3773 perf_stat_process_counter(&stat_config, counter);
3774 process_stat(counter, round->time);
3775 }
3776
3777 process_stat_interval(round->time);
3778 return 0;
3779}
3780
3781static int process_stat_config_event(struct perf_session *session __maybe_unused,
3782 union perf_event *event)
3783{
3784 perf_event__read_stat_config(&stat_config, &event->stat_config);
3785
3786 /*
3787 * Aggregation modes are not used since post-processing scripts are
3788 * supposed to take care of such requirements
3789 */
3790 stat_config.aggr_mode = AGGR_NONE;
3791
3792 return 0;
3793}
3794
3795static int set_maps(struct perf_script *script)
3796{
3797 struct evlist *evlist = script->session->evlist;
3798
3799 if (!script->cpus || !script->threads)
3800 return 0;
3801
3802 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3803 return -EINVAL;
3804
3805 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3806
3807 if (evlist__alloc_stats(&stat_config, evlist, /*alloc_raw=*/true))
3808 return -ENOMEM;
3809
3810 script->allocated = true;
3811 return 0;
3812}
3813
3814static
3815int process_thread_map_event(struct perf_session *session,
3816 union perf_event *event)
3817{
3818 const struct perf_tool *tool = session->tool;
3819 struct perf_script *script = container_of(tool, struct perf_script, tool);
3820
3821 if (dump_trace)
3822 perf_event__fprintf_thread_map(event, stdout);
3823
3824 if (script->threads) {
3825 pr_warning("Extra thread map event, ignoring.\n");
3826 return 0;
3827 }
3828
3829 script->threads = thread_map__new_event(&event->thread_map);
3830 if (!script->threads)
3831 return -ENOMEM;
3832
3833 return set_maps(script);
3834}
3835
3836static
3837int process_cpu_map_event(struct perf_session *session,
3838 union perf_event *event)
3839{
3840 const struct perf_tool *tool = session->tool;
3841 struct perf_script *script = container_of(tool, struct perf_script, tool);
3842
3843 if (dump_trace)
3844 perf_event__fprintf_cpu_map(event, stdout);
3845
3846 if (script->cpus) {
3847 pr_warning("Extra cpu map event, ignoring.\n");
3848 return 0;
3849 }
3850
3851 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3852 if (!script->cpus)
3853 return -ENOMEM;
3854
3855 return set_maps(script);
3856}
3857
3858static int process_feature_event(struct perf_session *session,
3859 union perf_event *event)
3860{
3861 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3862 return perf_event__process_feature(session, event);
3863 return 0;
3864}
3865
3866#ifdef HAVE_AUXTRACE_SUPPORT
3867static int perf_script__process_auxtrace_info(struct perf_session *session,
3868 union perf_event *event)
3869{
3870 int ret = perf_event__process_auxtrace_info(session, event);
3871
3872 if (ret == 0) {
3873 const struct perf_tool *tool = session->tool;
3874 struct perf_script *script = container_of(tool, struct perf_script, tool);
3875
3876 ret = perf_script__setup_per_event_dump(script);
3877 }
3878
3879 return ret;
3880}
3881#else
3882#define perf_script__process_auxtrace_info 0
3883#endif
3884
3885static int parse_insn_trace(const struct option *opt __maybe_unused,
3886 const char *str, int unset __maybe_unused)
3887{
3888 const char *fields = "+insn,-event,-period";
3889 int ret;
3890
3891 if (str) {
3892 if (strcmp(str, "disasm") == 0)
3893 fields = "+disasm,-event,-period";
3894 else if (strlen(str) != 0 && strcmp(str, "raw") != 0) {
3895 fprintf(stderr, "Only accept raw|disasm\n");
3896 return -EINVAL;
3897 }
3898 }
3899
3900 ret = parse_output_fields(NULL, fields, 0);
3901 if (ret < 0)
3902 return ret;
3903
3904 itrace_parse_synth_opts(opt, "i0nse", 0);
3905 symbol_conf.nanosecs = true;
3906 return 0;
3907}
3908
3909static int parse_xed(const struct option *opt __maybe_unused,
3910 const char *str __maybe_unused,
3911 int unset __maybe_unused)
3912{
3913 if (isatty(1))
3914 force_pager("xed -F insn: -A -64 | less");
3915 else
3916 force_pager("xed -F insn: -A -64");
3917 return 0;
3918}
3919
3920static int parse_call_trace(const struct option *opt __maybe_unused,
3921 const char *str __maybe_unused,
3922 int unset __maybe_unused)
3923{
3924 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3925 itrace_parse_synth_opts(opt, "cewp", 0);
3926 symbol_conf.nanosecs = true;
3927 symbol_conf.pad_output_len_dso = 50;
3928 return 0;
3929}
3930
3931static int parse_callret_trace(const struct option *opt __maybe_unused,
3932 const char *str __maybe_unused,
3933 int unset __maybe_unused)
3934{
3935 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3936 itrace_parse_synth_opts(opt, "crewp", 0);
3937 symbol_conf.nanosecs = true;
3938 return 0;
3939}
3940
3941int cmd_script(int argc, const char **argv)
3942{
3943 bool show_full_info = false;
3944 bool header = false;
3945 bool header_only = false;
3946 bool script_started = false;
3947 bool unsorted_dump = false;
3948 char *rec_script_path = NULL;
3949 char *rep_script_path = NULL;
3950 struct perf_session *session;
3951 struct itrace_synth_opts itrace_synth_opts = {
3952 .set = false,
3953 .default_no_sample = true,
3954 };
3955 struct utsname uts;
3956 char *script_path = NULL;
3957 const char *dlfilter_file = NULL;
3958 const char **__argv;
3959 int i, j, err = 0;
3960 struct perf_script script = {};
3961 struct perf_data data = {
3962 .mode = PERF_DATA_MODE_READ,
3963 };
3964 const struct option options[] = {
3965 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3966 "dump raw trace in ASCII"),
3967 OPT_BOOLEAN(0, "dump-unsorted-raw-trace", &unsorted_dump,
3968 "dump unsorted raw trace in ASCII"),
3969 OPT_INCR('v', "verbose", &verbose,
3970 "be more verbose (show symbol address, etc)"),
3971 OPT_BOOLEAN('L', "Latency", &latency_format,
3972 "show latency attributes (irqs/preemption disabled, etc)"),
3973 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3974 list_available_scripts),
3975 OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
3976 list_available_dlfilters),
3977 OPT_CALLBACK('s', "script", NULL, "name",
3978 "script file name (lang:script name, script name, or *)",
3979 parse_scriptname),
3980 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3981 "generate perf-script.xx script in specified language"),
3982 OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3983 OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
3984 add_dlarg),
3985 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3986 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3987 "do various checks like samples ordering and lost events"),
3988 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3989 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3990 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3991 "file", "vmlinux pathname"),
3992 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3993 "file", "kallsyms pathname"),
3994 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3995 "When printing symbols do not display call chain"),
3996 OPT_CALLBACK(0, "symfs", NULL, "directory",
3997 "Look for files with symbols relative to this directory",
3998 symbol__config_symfs),
3999 OPT_CALLBACK('F', "fields", NULL, "str",
4000 "comma separated output fields prepend with 'type:'. "
4001 "+field to add and -field to remove."
4002 "Valid types: hw,sw,trace,raw,synth. "
4003 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,dsoff,"
4004 "addr,symoff,srcline,period,iregs,uregs,brstack,"
4005 "brstacksym,flags,data_src,weight,bpf-output,brstackinsn,"
4006 "brstackinsnlen,brstackdisasm,brstackoff,callindent,insn,disasm,insnlen,synth,"
4007 "phys_addr,metric,misc,srccode,ipc,tod,data_page_size,"
4008 "code_page_size,ins_lat,machine_pid,vcpu,cgroup,retire_lat,"
4009 "brcntr",
4010 parse_output_fields),
4011 OPT_BOOLEAN('a', "all-cpus", &system_wide,
4012 "system-wide collection from all CPUs"),
4013 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
4014 "only consider symbols in these DSOs"),
4015 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
4016 "only consider these symbols"),
4017 OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
4018 "Use with -S to list traced records within address range"),
4019 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, "raw|disasm",
4020 "Decode instructions from itrace", parse_insn_trace),
4021 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
4022 "Run xed disassembler on output", parse_xed),
4023 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
4024 "Decode calls from itrace", parse_call_trace),
4025 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
4026 "Decode calls and returns from itrace", parse_callret_trace),
4027 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
4028 "Only print symbols and callees with --call-trace/--call-ret-trace"),
4029 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
4030 "Stop display of callgraph at these symbols"),
4031 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
4032 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
4033 "only display events for these comms"),
4034 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
4035 "only consider symbols in these pids"),
4036 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
4037 "only consider symbols in these tids"),
4038 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
4039 "Set the maximum stack depth when parsing the callchain, "
4040 "anything beyond the specified depth will be ignored. "
4041 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
4042 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
4043 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
4044 OPT_BOOLEAN('I', "show-info", &show_full_info,
4045 "display extended information from perf.data file"),
4046 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
4047 "Show the path of [kernel.kallsyms]"),
4048 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
4049 "Show the fork/comm/exit events"),
4050 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
4051 "Show the mmap events"),
4052 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
4053 "Show context switch events (if recorded)"),
4054 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
4055 "Show namespace events (if recorded)"),
4056 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
4057 "Show cgroup events (if recorded)"),
4058 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
4059 "Show lost events (if recorded)"),
4060 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
4061 "Show round events (if recorded)"),
4062 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
4063 "Show bpf related events (if recorded)"),
4064 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
4065 "Show text poke related events (if recorded)"),
4066 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
4067 "Dump trace output to files named by the monitored events"),
4068 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
4069 OPT_INTEGER(0, "max-blocks", &max_blocks,
4070 "Maximum number of code blocks to dump with brstackinsn"),
4071 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
4072 "Use 9 decimal places when displaying time"),
4073 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
4074 "Instruction Tracing options\n" ITRACE_HELP,
4075 itrace_parse_synth_opts),
4076 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
4077 "Show full source file name path for source lines"),
4078 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
4079 "Enable symbol demangling"),
4080 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
4081 "Enable kernel symbol demangling"),
4082 OPT_STRING(0, "addr2line", &symbol_conf.addr2line_path, "path",
4083 "addr2line binary to use for line numbers"),
4084 OPT_STRING(0, "time", &script.time_str, "str",
4085 "Time span of interest (start,stop)"),
4086 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
4087 "Show inline function"),
4088 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
4089 "guest mount directory under which every guest os"
4090 " instance has a subdir"),
4091 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
4092 "file", "file saving guest os vmlinux"),
4093 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
4094 "file", "file saving guest os /proc/kallsyms"),
4095 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
4096 "file", "file saving guest os /proc/modules"),
4097 OPT_BOOLEAN(0, "guest-code", &symbol_conf.guest_code,
4098 "Guest code can be found in hypervisor process"),
4099 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
4100 "Enable LBR callgraph stitching approach"),
4101 OPTS_EVSWITCH(&script.evswitch),
4102 OPT_END()
4103 };
4104 const char * const script_subcommands[] = { "record", "report", NULL };
4105 const char *script_usage[] = {
4106 "perf script [<options>]",
4107 "perf script [<options>] record <script> [<record-options>] <command>",
4108 "perf script [<options>] report <script> [script-args]",
4109 "perf script [<options>] <script> [<record-options>] <command>",
4110 "perf script [<options>] <top-script> [script-args]",
4111 NULL
4112 };
4113
4114 perf_set_singlethreaded();
4115
4116 setup_scripting();
4117
4118 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
4119 PARSE_OPT_STOP_AT_NON_OPTION);
4120
4121 if (symbol_conf.guestmount ||
4122 symbol_conf.default_guest_vmlinux_name ||
4123 symbol_conf.default_guest_kallsyms ||
4124 symbol_conf.default_guest_modules ||
4125 symbol_conf.guest_code) {
4126 /*
4127 * Enable guest sample processing.
4128 */
4129 perf_guest = true;
4130 }
4131
4132 data.path = input_name;
4133 data.force = symbol_conf.force;
4134
4135 if (unsorted_dump)
4136 dump_trace = true;
4137
4138 if (symbol__validate_sym_arguments())
4139 return -1;
4140
4141 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
4142 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
4143 if (!rec_script_path)
4144 return cmd_record(argc, argv);
4145 }
4146
4147 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("report", argv[0])) {
4148 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
4149 if (!rep_script_path) {
4150 fprintf(stderr,
4151 "Please specify a valid report script"
4152 "(see 'perf script -l' for listing)\n");
4153 return -1;
4154 }
4155 }
4156
4157 if (reltime && deltatime) {
4158 fprintf(stderr,
4159 "reltime and deltatime - the two don't get along well. "
4160 "Please limit to --reltime or --deltatime.\n");
4161 return -1;
4162 }
4163
4164 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
4165 itrace_synth_opts.callchain_sz > scripting_max_stack)
4166 scripting_max_stack = itrace_synth_opts.callchain_sz;
4167
4168 /* make sure PERF_EXEC_PATH is set for scripts */
4169 set_argv_exec_path(get_argv_exec_path());
4170
4171 if (argc && !script_name && !rec_script_path && !rep_script_path) {
4172 int live_pipe[2];
4173 int rep_args;
4174 pid_t pid;
4175
4176 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
4177 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
4178
4179 if (!rec_script_path && !rep_script_path) {
4180 script_name = find_script(argv[0]);
4181 if (script_name) {
4182 argc -= 1;
4183 argv += 1;
4184 goto script_found;
4185 }
4186 usage_with_options_msg(script_usage, options,
4187 "Couldn't find script `%s'\n\n See perf"
4188 " script -l for available scripts.\n", argv[0]);
4189 }
4190
4191 if (is_top_script(argv[0])) {
4192 rep_args = argc - 1;
4193 } else {
4194 int rec_args;
4195
4196 rep_args = has_required_arg(rep_script_path);
4197 rec_args = (argc - 1) - rep_args;
4198 if (rec_args < 0) {
4199 usage_with_options_msg(script_usage, options,
4200 "`%s' script requires options."
4201 "\n\n See perf script -l for available "
4202 "scripts and options.\n", argv[0]);
4203 }
4204 }
4205
4206 if (pipe(live_pipe) < 0) {
4207 perror("failed to create pipe");
4208 return -1;
4209 }
4210
4211 pid = fork();
4212 if (pid < 0) {
4213 perror("failed to fork");
4214 return -1;
4215 }
4216
4217 if (!pid) {
4218 j = 0;
4219
4220 dup2(live_pipe[1], 1);
4221 close(live_pipe[0]);
4222
4223 if (is_top_script(argv[0])) {
4224 system_wide = true;
4225 } else if (!system_wide) {
4226 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
4227 err = -1;
4228 goto out;
4229 }
4230 }
4231
4232 __argv = malloc((argc + 6) * sizeof(const char *));
4233 if (!__argv) {
4234 pr_err("malloc failed\n");
4235 err = -ENOMEM;
4236 goto out;
4237 }
4238
4239 __argv[j++] = "/bin/sh";
4240 __argv[j++] = rec_script_path;
4241 if (system_wide)
4242 __argv[j++] = "-a";
4243 __argv[j++] = "-q";
4244 __argv[j++] = "-o";
4245 __argv[j++] = "-";
4246 for (i = rep_args + 1; i < argc; i++)
4247 __argv[j++] = argv[i];
4248 __argv[j++] = NULL;
4249
4250 execvp("/bin/sh", (char **)__argv);
4251 free(__argv);
4252 exit(-1);
4253 }
4254
4255 dup2(live_pipe[0], 0);
4256 close(live_pipe[1]);
4257
4258 __argv = malloc((argc + 4) * sizeof(const char *));
4259 if (!__argv) {
4260 pr_err("malloc failed\n");
4261 err = -ENOMEM;
4262 goto out;
4263 }
4264
4265 j = 0;
4266 __argv[j++] = "/bin/sh";
4267 __argv[j++] = rep_script_path;
4268 for (i = 1; i < rep_args + 1; i++)
4269 __argv[j++] = argv[i];
4270 __argv[j++] = "-i";
4271 __argv[j++] = "-";
4272 __argv[j++] = NULL;
4273
4274 execvp("/bin/sh", (char **)__argv);
4275 free(__argv);
4276 exit(-1);
4277 }
4278script_found:
4279 if (rec_script_path)
4280 script_path = rec_script_path;
4281 if (rep_script_path)
4282 script_path = rep_script_path;
4283
4284 if (script_path) {
4285 j = 0;
4286
4287 if (!rec_script_path)
4288 system_wide = false;
4289 else if (!system_wide) {
4290 if (have_cmd(argc - 1, &argv[1]) != 0) {
4291 err = -1;
4292 goto out;
4293 }
4294 }
4295
4296 __argv = malloc((argc + 2) * sizeof(const char *));
4297 if (!__argv) {
4298 pr_err("malloc failed\n");
4299 err = -ENOMEM;
4300 goto out;
4301 }
4302
4303 __argv[j++] = "/bin/sh";
4304 __argv[j++] = script_path;
4305 if (system_wide)
4306 __argv[j++] = "-a";
4307 for (i = 2; i < argc; i++)
4308 __argv[j++] = argv[i];
4309 __argv[j++] = NULL;
4310
4311 execvp("/bin/sh", (char **)__argv);
4312 free(__argv);
4313 exit(-1);
4314 }
4315
4316 if (dlfilter_file) {
4317 dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4318 if (!dlfilter)
4319 return -1;
4320 }
4321
4322 if (!script_name) {
4323 setup_pager();
4324 use_browser = 0;
4325 }
4326
4327 perf_tool__init(&script.tool, !unsorted_dump);
4328 script.tool.sample = process_sample_event;
4329 script.tool.mmap = perf_event__process_mmap;
4330 script.tool.mmap2 = perf_event__process_mmap2;
4331 script.tool.comm = perf_event__process_comm;
4332 script.tool.namespaces = perf_event__process_namespaces;
4333 script.tool.cgroup = perf_event__process_cgroup;
4334 script.tool.exit = perf_event__process_exit;
4335 script.tool.fork = perf_event__process_fork;
4336 script.tool.attr = process_attr;
4337 script.tool.event_update = perf_event__process_event_update;
4338#ifdef HAVE_LIBTRACEEVENT
4339 script.tool.tracing_data = perf_event__process_tracing_data;
4340#endif
4341 script.tool.feature = process_feature_event;
4342 script.tool.build_id = perf_event__process_build_id;
4343 script.tool.id_index = perf_event__process_id_index;
4344 script.tool.auxtrace_info = perf_script__process_auxtrace_info;
4345 script.tool.auxtrace = perf_event__process_auxtrace;
4346 script.tool.auxtrace_error = perf_event__process_auxtrace_error;
4347 script.tool.stat = perf_event__process_stat_event;
4348 script.tool.stat_round = process_stat_round_event;
4349 script.tool.stat_config = process_stat_config_event;
4350 script.tool.thread_map = process_thread_map_event;
4351 script.tool.cpu_map = process_cpu_map_event;
4352 script.tool.throttle = process_throttle_event;
4353 script.tool.unthrottle = process_throttle_event;
4354 script.tool.ordering_requires_timestamps = true;
4355 session = perf_session__new(&data, &script.tool);
4356 if (IS_ERR(session))
4357 return PTR_ERR(session);
4358
4359 if (header || header_only) {
4360 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4361 perf_session__fprintf_info(session, stdout, show_full_info);
4362 if (header_only)
4363 goto out_delete;
4364 }
4365 if (show_full_info)
4366 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4367
4368 if (symbol__init(&session->header.env) < 0)
4369 goto out_delete;
4370
4371 uname(&uts);
4372 if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4373 native_arch = true;
4374 } else if (session->header.env.arch) {
4375 if (!strcmp(uts.machine, session->header.env.arch))
4376 native_arch = true;
4377 else if (!strcmp(uts.machine, "x86_64") &&
4378 !strcmp(session->header.env.arch, "i386"))
4379 native_arch = true;
4380 }
4381
4382 script.session = session;
4383 script__setup_sample_type(&script);
4384
4385 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
4386 symbol_conf.graph_function)
4387 itrace_synth_opts.thread_stack = true;
4388
4389 session->itrace_synth_opts = &itrace_synth_opts;
4390
4391 if (cpu_list) {
4392 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4393 if (err < 0)
4394 goto out_delete;
4395 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4396 }
4397
4398 if (!no_callchain)
4399 symbol_conf.use_callchain = true;
4400 else
4401 symbol_conf.use_callchain = false;
4402
4403#ifdef HAVE_LIBTRACEEVENT
4404 if (session->tevent.pevent &&
4405 tep_set_function_resolver(session->tevent.pevent,
4406 machine__resolve_kernel_addr,
4407 &session->machines.host) < 0) {
4408 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4409 err = -1;
4410 goto out_delete;
4411 }
4412#endif
4413 if (generate_script_lang) {
4414 struct stat perf_stat;
4415 int input;
4416
4417 if (output_set_by_user()) {
4418 fprintf(stderr,
4419 "custom fields not supported for generated scripts");
4420 err = -EINVAL;
4421 goto out_delete;
4422 }
4423
4424 input = open(data.path, O_RDONLY); /* input_name */
4425 if (input < 0) {
4426 err = -errno;
4427 perror("failed to open file");
4428 goto out_delete;
4429 }
4430
4431 err = fstat(input, &perf_stat);
4432 if (err < 0) {
4433 perror("failed to stat file");
4434 goto out_delete;
4435 }
4436
4437 if (!perf_stat.st_size) {
4438 fprintf(stderr, "zero-sized file, nothing to do!\n");
4439 goto out_delete;
4440 }
4441
4442 scripting_ops = script_spec__lookup(generate_script_lang);
4443 if (!scripting_ops) {
4444 fprintf(stderr, "invalid language specifier");
4445 err = -ENOENT;
4446 goto out_delete;
4447 }
4448#ifdef HAVE_LIBTRACEEVENT
4449 err = scripting_ops->generate_script(session->tevent.pevent,
4450 "perf-script");
4451#else
4452 err = scripting_ops->generate_script(NULL, "perf-script");
4453#endif
4454 goto out_delete;
4455 }
4456
4457 err = dlfilter__start(dlfilter, session);
4458 if (err)
4459 goto out_delete;
4460
4461 if (script_name) {
4462 err = scripting_ops->start_script(script_name, argc, argv, session);
4463 if (err)
4464 goto out_delete;
4465 pr_debug("perf script started with script %s\n\n", script_name);
4466 script_started = true;
4467 }
4468
4469
4470 err = perf_session__check_output_opt(session);
4471 if (err < 0)
4472 goto out_delete;
4473
4474 if (script.time_str) {
4475 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4476 &script.ptime_range,
4477 &script.range_size,
4478 &script.range_num,
4479 reltime);
4480 if (err < 0)
4481 goto out_delete;
4482
4483 itrace_synth_opts__set_time_range(&itrace_synth_opts,
4484 script.ptime_range,
4485 script.range_num);
4486 }
4487
4488 err = evswitch__init(&script.evswitch, session->evlist, stderr);
4489 if (err)
4490 goto out_delete;
4491
4492 if (zstd_init(&(session->zstd_data), 0) < 0)
4493 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4494
4495 err = __cmd_script(&script);
4496
4497 flush_scripting();
4498
4499 if (verbose > 2 || debug_kmaps)
4500 perf_session__dump_kmaps(session);
4501
4502out_delete:
4503 if (script.ptime_range) {
4504 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4505 zfree(&script.ptime_range);
4506 }
4507
4508 zstd_fini(&(session->zstd_data));
4509 evlist__free_stats(session->evlist);
4510 perf_session__delete(session);
4511 perf_script__exit(&script);
4512
4513 if (script_started)
4514 cleanup_scripting();
4515 dlfilter__cleanup(dlfilter);
4516 free_dlarg();
4517out:
4518 return err;
4519}
1// SPDX-License-Identifier: GPL-2.0
2#include "builtin.h"
3
4#include "util/counts.h"
5#include "util/debug.h"
6#include "util/dso.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"
13#include "util/map.h"
14#include "util/srcline.h"
15#include "util/symbol.h"
16#include "util/thread.h"
17#include "util/trace-event.h"
18#include "util/evlist.h"
19#include "util/evsel.h"
20#include "util/evsel_fprintf.h"
21#include "util/evswitch.h"
22#include "util/sort.h"
23#include "util/data.h"
24#include "util/auxtrace.h"
25#include "util/cpumap.h"
26#include "util/thread_map.h"
27#include "util/stat.h"
28#include "util/color.h"
29#include "util/string2.h"
30#include "util/thread-stack.h"
31#include "util/time-utils.h"
32#include "util/path.h"
33#include "ui/ui.h"
34#include "print_binary.h"
35#include "archinsn.h"
36#include <linux/bitmap.h>
37#include <linux/kernel.h>
38#include <linux/stringify.h>
39#include <linux/time64.h>
40#include <linux/zalloc.h>
41#include <sys/utsname.h>
42#include "asm/bug.h"
43#include "util/mem-events.h"
44#include "util/dump-insn.h"
45#include <dirent.h>
46#include <errno.h>
47#include <inttypes.h>
48#include <signal.h>
49#include <sys/param.h>
50#include <sys/types.h>
51#include <sys/stat.h>
52#include <fcntl.h>
53#include <unistd.h>
54#include <subcmd/pager.h>
55#include <perf/evlist.h>
56#include <linux/err.h>
57#include "util/record.h"
58#include "util/util.h"
59#include "perf.h"
60
61#include <linux/ctype.h>
62
63static char const *script_name;
64static char const *generate_script_lang;
65static bool reltime;
66static bool deltatime;
67static u64 initial_time;
68static u64 previous_time;
69static bool debug_mode;
70static u64 last_timestamp;
71static u64 nr_unordered;
72static bool no_callchain;
73static bool latency_format;
74static bool system_wide;
75static bool print_flags;
76static const char *cpu_list;
77static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
78static struct perf_stat_config stat_config;
79static int max_blocks;
80static bool native_arch;
81
82unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
83
84enum perf_output_field {
85 PERF_OUTPUT_COMM = 1ULL << 0,
86 PERF_OUTPUT_TID = 1ULL << 1,
87 PERF_OUTPUT_PID = 1ULL << 2,
88 PERF_OUTPUT_TIME = 1ULL << 3,
89 PERF_OUTPUT_CPU = 1ULL << 4,
90 PERF_OUTPUT_EVNAME = 1ULL << 5,
91 PERF_OUTPUT_TRACE = 1ULL << 6,
92 PERF_OUTPUT_IP = 1ULL << 7,
93 PERF_OUTPUT_SYM = 1ULL << 8,
94 PERF_OUTPUT_DSO = 1ULL << 9,
95 PERF_OUTPUT_ADDR = 1ULL << 10,
96 PERF_OUTPUT_SYMOFFSET = 1ULL << 11,
97 PERF_OUTPUT_SRCLINE = 1ULL << 12,
98 PERF_OUTPUT_PERIOD = 1ULL << 13,
99 PERF_OUTPUT_IREGS = 1ULL << 14,
100 PERF_OUTPUT_BRSTACK = 1ULL << 15,
101 PERF_OUTPUT_BRSTACKSYM = 1ULL << 16,
102 PERF_OUTPUT_DATA_SRC = 1ULL << 17,
103 PERF_OUTPUT_WEIGHT = 1ULL << 18,
104 PERF_OUTPUT_BPF_OUTPUT = 1ULL << 19,
105 PERF_OUTPUT_CALLINDENT = 1ULL << 20,
106 PERF_OUTPUT_INSN = 1ULL << 21,
107 PERF_OUTPUT_INSNLEN = 1ULL << 22,
108 PERF_OUTPUT_BRSTACKINSN = 1ULL << 23,
109 PERF_OUTPUT_BRSTACKOFF = 1ULL << 24,
110 PERF_OUTPUT_SYNTH = 1ULL << 25,
111 PERF_OUTPUT_PHYS_ADDR = 1ULL << 26,
112 PERF_OUTPUT_UREGS = 1ULL << 27,
113 PERF_OUTPUT_METRIC = 1ULL << 28,
114 PERF_OUTPUT_MISC = 1ULL << 29,
115 PERF_OUTPUT_SRCCODE = 1ULL << 30,
116 PERF_OUTPUT_IPC = 1ULL << 31,
117 PERF_OUTPUT_TOD = 1ULL << 32,
118};
119
120struct perf_script {
121 struct perf_tool tool;
122 struct perf_session *session;
123 bool show_task_events;
124 bool show_mmap_events;
125 bool show_switch_events;
126 bool show_namespace_events;
127 bool show_lost_events;
128 bool show_round_events;
129 bool show_bpf_events;
130 bool show_cgroup_events;
131 bool show_text_poke_events;
132 bool allocated;
133 bool per_event_dump;
134 bool stitch_lbr;
135 struct evswitch evswitch;
136 struct perf_cpu_map *cpus;
137 struct perf_thread_map *threads;
138 int name_width;
139 const char *time_str;
140 struct perf_time_interval *ptime_range;
141 int range_size;
142 int range_num;
143};
144
145struct output_option {
146 const char *str;
147 enum perf_output_field field;
148} all_output_options[] = {
149 {.str = "comm", .field = PERF_OUTPUT_COMM},
150 {.str = "tid", .field = PERF_OUTPUT_TID},
151 {.str = "pid", .field = PERF_OUTPUT_PID},
152 {.str = "time", .field = PERF_OUTPUT_TIME},
153 {.str = "cpu", .field = PERF_OUTPUT_CPU},
154 {.str = "event", .field = PERF_OUTPUT_EVNAME},
155 {.str = "trace", .field = PERF_OUTPUT_TRACE},
156 {.str = "ip", .field = PERF_OUTPUT_IP},
157 {.str = "sym", .field = PERF_OUTPUT_SYM},
158 {.str = "dso", .field = PERF_OUTPUT_DSO},
159 {.str = "addr", .field = PERF_OUTPUT_ADDR},
160 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
161 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
162 {.str = "period", .field = PERF_OUTPUT_PERIOD},
163 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
164 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
165 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
166 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
167 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
168 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
169 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
170 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
171 {.str = "insn", .field = PERF_OUTPUT_INSN},
172 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
173 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
174 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
175 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
176 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
177 {.str = "metric", .field = PERF_OUTPUT_METRIC},
178 {.str = "misc", .field = PERF_OUTPUT_MISC},
179 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
180 {.str = "ipc", .field = PERF_OUTPUT_IPC},
181 {.str = "tod", .field = PERF_OUTPUT_TOD},
182};
183
184enum {
185 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
186 OUTPUT_TYPE_MAX
187};
188
189/* default set to maintain compatibility with current format */
190static struct {
191 bool user_set;
192 bool wildcard_set;
193 unsigned int print_ip_opts;
194 u64 fields;
195 u64 invalid_fields;
196 u64 user_set_fields;
197 u64 user_unset_fields;
198} output[OUTPUT_TYPE_MAX] = {
199
200 [PERF_TYPE_HARDWARE] = {
201 .user_set = false,
202
203 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
204 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
205 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
206 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
207 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
208
209 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
210 },
211
212 [PERF_TYPE_SOFTWARE] = {
213 .user_set = false,
214
215 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
216 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
217 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
218 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
219 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
220 PERF_OUTPUT_BPF_OUTPUT,
221
222 .invalid_fields = PERF_OUTPUT_TRACE,
223 },
224
225 [PERF_TYPE_TRACEPOINT] = {
226 .user_set = false,
227
228 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
229 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
230 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
231 },
232
233 [PERF_TYPE_HW_CACHE] = {
234 .user_set = false,
235
236 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
237 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
238 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
239 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
240 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
241
242 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
243 },
244
245 [PERF_TYPE_RAW] = {
246 .user_set = false,
247
248 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
249 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
250 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
251 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
252 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
253 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
254 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR,
255
256 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
257 },
258
259 [PERF_TYPE_BREAKPOINT] = {
260 .user_set = false,
261
262 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
263 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
264 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
265 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
266 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
267
268 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
269 },
270
271 [OUTPUT_TYPE_SYNTH] = {
272 .user_set = false,
273
274 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
275 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
276 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
277 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
278 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
279
280 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
281 },
282};
283
284struct evsel_script {
285 char *filename;
286 FILE *fp;
287 u64 samples;
288 /* For metric output */
289 u64 val;
290 int gnum;
291};
292
293static inline struct evsel_script *evsel_script(struct evsel *evsel)
294{
295 return (struct evsel_script *)evsel->priv;
296}
297
298static struct evsel_script *perf_evsel_script__new(struct evsel *evsel,
299 struct perf_data *data)
300{
301 struct evsel_script *es = zalloc(sizeof(*es));
302
303 if (es != NULL) {
304 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
305 goto out_free;
306 es->fp = fopen(es->filename, "w");
307 if (es->fp == NULL)
308 goto out_free_filename;
309 }
310
311 return es;
312out_free_filename:
313 zfree(&es->filename);
314out_free:
315 free(es);
316 return NULL;
317}
318
319static void perf_evsel_script__delete(struct evsel_script *es)
320{
321 zfree(&es->filename);
322 fclose(es->fp);
323 es->fp = NULL;
324 free(es);
325}
326
327static int perf_evsel_script__fprintf(struct evsel_script *es, FILE *fp)
328{
329 struct stat st;
330
331 fstat(fileno(es->fp), &st);
332 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
333 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
334}
335
336static inline int output_type(unsigned int type)
337{
338 switch (type) {
339 case PERF_TYPE_SYNTH:
340 return OUTPUT_TYPE_SYNTH;
341 default:
342 return type;
343 }
344}
345
346static inline unsigned int attr_type(unsigned int type)
347{
348 switch (type) {
349 case OUTPUT_TYPE_SYNTH:
350 return PERF_TYPE_SYNTH;
351 default:
352 return type;
353 }
354}
355
356static bool output_set_by_user(void)
357{
358 int j;
359 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
360 if (output[j].user_set)
361 return true;
362 }
363 return false;
364}
365
366static const char *output_field2str(enum perf_output_field field)
367{
368 int i, imax = ARRAY_SIZE(all_output_options);
369 const char *str = "";
370
371 for (i = 0; i < imax; ++i) {
372 if (all_output_options[i].field == field) {
373 str = all_output_options[i].str;
374 break;
375 }
376 }
377 return str;
378}
379
380#define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
381
382static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
383 enum perf_output_field field, bool allow_user_set)
384{
385 struct perf_event_attr *attr = &evsel->core.attr;
386 int type = output_type(attr->type);
387 const char *evname;
388
389 if (attr->sample_type & sample_type)
390 return 0;
391
392 if (output[type].user_set_fields & field) {
393 if (allow_user_set)
394 return 0;
395 evname = evsel__name(evsel);
396 pr_err("Samples for '%s' event do not have %s attribute set. "
397 "Cannot print '%s' field.\n",
398 evname, sample_msg, output_field2str(field));
399 return -1;
400 }
401
402 /* user did not ask for it explicitly so remove from the default list */
403 output[type].fields &= ~field;
404 evname = evsel__name(evsel);
405 pr_debug("Samples for '%s' event do not have %s attribute set. "
406 "Skipping '%s' field.\n",
407 evname, sample_msg, output_field2str(field));
408
409 return 0;
410}
411
412static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
413 enum perf_output_field field)
414{
415 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
416}
417
418static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
419{
420 struct perf_event_attr *attr = &evsel->core.attr;
421 bool allow_user_set;
422
423 if (perf_header__has_feat(&session->header, HEADER_STAT))
424 return 0;
425
426 allow_user_set = perf_header__has_feat(&session->header,
427 HEADER_AUXTRACE);
428
429 if (PRINT_FIELD(TRACE) &&
430 !perf_session__has_traces(session, "record -R"))
431 return -EINVAL;
432
433 if (PRINT_FIELD(IP)) {
434 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
435 return -EINVAL;
436 }
437
438 if (PRINT_FIELD(ADDR) &&
439 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
440 return -EINVAL;
441
442 if (PRINT_FIELD(DATA_SRC) &&
443 evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
444 return -EINVAL;
445
446 if (PRINT_FIELD(WEIGHT) &&
447 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
448 return -EINVAL;
449
450 if (PRINT_FIELD(SYM) &&
451 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
452 pr_err("Display of symbols requested but neither sample IP nor "
453 "sample address\navailable. Hence, no addresses to convert "
454 "to symbols.\n");
455 return -EINVAL;
456 }
457 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
458 pr_err("Display of offsets requested but symbol is not"
459 "selected.\n");
460 return -EINVAL;
461 }
462 if (PRINT_FIELD(DSO) &&
463 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
464 pr_err("Display of DSO requested but no address to convert.\n");
465 return -EINVAL;
466 }
467 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
468 pr_err("Display of source line number requested but sample IP is not\n"
469 "selected. Hence, no address to lookup the source line number.\n");
470 return -EINVAL;
471 }
472 if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
473 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
474 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
475 "Hint: run 'perf record -b ...'\n");
476 return -EINVAL;
477 }
478 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
479 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
480 return -EINVAL;
481
482 if (PRINT_FIELD(TIME) &&
483 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
484 return -EINVAL;
485
486 if (PRINT_FIELD(CPU) &&
487 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
488 return -EINVAL;
489
490 if (PRINT_FIELD(IREGS) &&
491 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
492 return -EINVAL;
493
494 if (PRINT_FIELD(UREGS) &&
495 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
496 return -EINVAL;
497
498 if (PRINT_FIELD(PHYS_ADDR) &&
499 evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
500 return -EINVAL;
501
502 return 0;
503}
504
505static void set_print_ip_opts(struct perf_event_attr *attr)
506{
507 unsigned int type = output_type(attr->type);
508
509 output[type].print_ip_opts = 0;
510 if (PRINT_FIELD(IP))
511 output[type].print_ip_opts |= EVSEL__PRINT_IP;
512
513 if (PRINT_FIELD(SYM))
514 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
515
516 if (PRINT_FIELD(DSO))
517 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
518
519 if (PRINT_FIELD(SYMOFFSET))
520 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
521
522 if (PRINT_FIELD(SRCLINE))
523 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
524}
525
526/*
527 * verify all user requested events exist and the samples
528 * have the expected data
529 */
530static int perf_session__check_output_opt(struct perf_session *session)
531{
532 bool tod = false;
533 unsigned int j;
534 struct evsel *evsel;
535
536 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
537 evsel = perf_session__find_first_evtype(session, attr_type(j));
538
539 /*
540 * even if fields is set to 0 (ie., show nothing) event must
541 * exist if user explicitly includes it on the command line
542 */
543 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
544 j != OUTPUT_TYPE_SYNTH) {
545 pr_err("%s events do not exist. "
546 "Remove corresponding -F option to proceed.\n",
547 event_type(j));
548 return -1;
549 }
550
551 if (evsel && output[j].fields &&
552 evsel__check_attr(evsel, session))
553 return -1;
554
555 if (evsel == NULL)
556 continue;
557
558 set_print_ip_opts(&evsel->core.attr);
559 tod |= output[j].fields & PERF_OUTPUT_TOD;
560 }
561
562 if (!no_callchain) {
563 bool use_callchain = false;
564 bool not_pipe = false;
565
566 evlist__for_each_entry(session->evlist, evsel) {
567 not_pipe = true;
568 if (evsel__has_callchain(evsel)) {
569 use_callchain = true;
570 break;
571 }
572 }
573 if (not_pipe && !use_callchain)
574 symbol_conf.use_callchain = false;
575 }
576
577 /*
578 * set default for tracepoints to print symbols only
579 * if callchains are present
580 */
581 if (symbol_conf.use_callchain &&
582 !output[PERF_TYPE_TRACEPOINT].user_set) {
583 j = PERF_TYPE_TRACEPOINT;
584
585 evlist__for_each_entry(session->evlist, evsel) {
586 if (evsel->core.attr.type != j)
587 continue;
588
589 if (evsel__has_callchain(evsel)) {
590 output[j].fields |= PERF_OUTPUT_IP;
591 output[j].fields |= PERF_OUTPUT_SYM;
592 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
593 output[j].fields |= PERF_OUTPUT_DSO;
594 set_print_ip_opts(&evsel->core.attr);
595 goto out;
596 }
597 }
598 }
599
600 if (tod && !session->header.env.clock.enabled) {
601 pr_err("Can't provide 'tod' time, missing clock data. "
602 "Please record with -k/--clockid option.\n");
603 return -1;
604 }
605out:
606 return 0;
607}
608
609static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
610 FILE *fp)
611{
612 unsigned i = 0, r;
613 int printed = 0;
614
615 if (!regs || !regs->regs)
616 return 0;
617
618 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
619
620 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
621 u64 val = regs->regs[i++];
622 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
623 }
624
625 return printed;
626}
627
628#define DEFAULT_TOD_FMT "%F %H:%M:%S"
629
630static char*
631tod_scnprintf(struct perf_script *script, char *buf, int buflen,
632 u64 timestamp)
633{
634 u64 tod_ns, clockid_ns;
635 struct perf_env *env;
636 unsigned long nsec;
637 struct tm ltime;
638 char date[64];
639 time_t sec;
640
641 buf[0] = '\0';
642 if (buflen < 64 || !script)
643 return buf;
644
645 env = &script->session->header.env;
646 if (!env->clock.enabled) {
647 scnprintf(buf, buflen, "disabled");
648 return buf;
649 }
650
651 clockid_ns = env->clock.clockid_ns;
652 tod_ns = env->clock.tod_ns;
653
654 if (timestamp > clockid_ns)
655 tod_ns += timestamp - clockid_ns;
656 else
657 tod_ns -= clockid_ns - timestamp;
658
659 sec = (time_t) (tod_ns / NSEC_PER_SEC);
660 nsec = tod_ns - sec * NSEC_PER_SEC;
661
662 if (localtime_r(&sec, <ime) == NULL) {
663 scnprintf(buf, buflen, "failed");
664 } else {
665 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
666
667 if (symbol_conf.nanosecs) {
668 snprintf(buf, buflen, "%s.%09lu", date, nsec);
669 } else {
670 snprintf(buf, buflen, "%s.%06lu",
671 date, nsec / NSEC_PER_USEC);
672 }
673 }
674
675 return buf;
676}
677
678static int perf_sample__fprintf_iregs(struct perf_sample *sample,
679 struct perf_event_attr *attr, FILE *fp)
680{
681 return perf_sample__fprintf_regs(&sample->intr_regs,
682 attr->sample_regs_intr, fp);
683}
684
685static int perf_sample__fprintf_uregs(struct perf_sample *sample,
686 struct perf_event_attr *attr, FILE *fp)
687{
688 return perf_sample__fprintf_regs(&sample->user_regs,
689 attr->sample_regs_user, fp);
690}
691
692static int perf_sample__fprintf_start(struct perf_script *script,
693 struct perf_sample *sample,
694 struct thread *thread,
695 struct evsel *evsel,
696 u32 type, FILE *fp)
697{
698 struct perf_event_attr *attr = &evsel->core.attr;
699 unsigned long secs;
700 unsigned long long nsecs;
701 int printed = 0;
702 char tstr[128];
703
704 if (PRINT_FIELD(COMM)) {
705 if (latency_format)
706 printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
707 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
708 printed += fprintf(fp, "%s ", thread__comm_str(thread));
709 else
710 printed += fprintf(fp, "%16s ", thread__comm_str(thread));
711 }
712
713 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
714 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
715 else if (PRINT_FIELD(PID))
716 printed += fprintf(fp, "%5d ", sample->pid);
717 else if (PRINT_FIELD(TID))
718 printed += fprintf(fp, "%5d ", sample->tid);
719
720 if (PRINT_FIELD(CPU)) {
721 if (latency_format)
722 printed += fprintf(fp, "%3d ", sample->cpu);
723 else
724 printed += fprintf(fp, "[%03d] ", sample->cpu);
725 }
726
727 if (PRINT_FIELD(MISC)) {
728 int ret = 0;
729
730 #define has(m) \
731 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
732
733 if (has(KERNEL))
734 ret += fprintf(fp, "K");
735 if (has(USER))
736 ret += fprintf(fp, "U");
737 if (has(HYPERVISOR))
738 ret += fprintf(fp, "H");
739 if (has(GUEST_KERNEL))
740 ret += fprintf(fp, "G");
741 if (has(GUEST_USER))
742 ret += fprintf(fp, "g");
743
744 switch (type) {
745 case PERF_RECORD_MMAP:
746 case PERF_RECORD_MMAP2:
747 if (has(MMAP_DATA))
748 ret += fprintf(fp, "M");
749 break;
750 case PERF_RECORD_COMM:
751 if (has(COMM_EXEC))
752 ret += fprintf(fp, "E");
753 break;
754 case PERF_RECORD_SWITCH:
755 case PERF_RECORD_SWITCH_CPU_WIDE:
756 if (has(SWITCH_OUT)) {
757 ret += fprintf(fp, "S");
758 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
759 ret += fprintf(fp, "p");
760 }
761 default:
762 break;
763 }
764
765 #undef has
766
767 ret += fprintf(fp, "%*s", 6 - ret, " ");
768 printed += ret;
769 }
770
771 if (PRINT_FIELD(TOD)) {
772 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
773 printed += fprintf(fp, "%s ", tstr);
774 }
775
776 if (PRINT_FIELD(TIME)) {
777 u64 t = sample->time;
778 if (reltime) {
779 if (!initial_time)
780 initial_time = sample->time;
781 t = sample->time - initial_time;
782 } else if (deltatime) {
783 if (previous_time)
784 t = sample->time - previous_time;
785 else {
786 t = 0;
787 }
788 previous_time = sample->time;
789 }
790 nsecs = t;
791 secs = nsecs / NSEC_PER_SEC;
792 nsecs -= secs * NSEC_PER_SEC;
793
794 if (symbol_conf.nanosecs)
795 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
796 else {
797 char sample_time[32];
798 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
799 printed += fprintf(fp, "%12s: ", sample_time);
800 }
801 }
802
803 return printed;
804}
805
806static inline char
807mispred_str(struct branch_entry *br)
808{
809 if (!(br->flags.mispred || br->flags.predicted))
810 return '-';
811
812 return br->flags.predicted ? 'P' : 'M';
813}
814
815static int perf_sample__fprintf_brstack(struct perf_sample *sample,
816 struct thread *thread,
817 struct perf_event_attr *attr, FILE *fp)
818{
819 struct branch_stack *br = sample->branch_stack;
820 struct branch_entry *entries = perf_sample__branch_entries(sample);
821 struct addr_location alf, alt;
822 u64 i, from, to;
823 int printed = 0;
824
825 if (!(br && br->nr))
826 return 0;
827
828 for (i = 0; i < br->nr; i++) {
829 from = entries[i].from;
830 to = entries[i].to;
831
832 if (PRINT_FIELD(DSO)) {
833 memset(&alf, 0, sizeof(alf));
834 memset(&alt, 0, sizeof(alt));
835 thread__find_map_fb(thread, sample->cpumode, from, &alf);
836 thread__find_map_fb(thread, sample->cpumode, to, &alt);
837 }
838
839 printed += fprintf(fp, " 0x%"PRIx64, from);
840 if (PRINT_FIELD(DSO)) {
841 printed += fprintf(fp, "(");
842 printed += map__fprintf_dsoname(alf.map, fp);
843 printed += fprintf(fp, ")");
844 }
845
846 printed += fprintf(fp, "/0x%"PRIx64, to);
847 if (PRINT_FIELD(DSO)) {
848 printed += fprintf(fp, "(");
849 printed += map__fprintf_dsoname(alt.map, fp);
850 printed += fprintf(fp, ")");
851 }
852
853 printed += fprintf(fp, "/%c/%c/%c/%d ",
854 mispred_str(entries + i),
855 entries[i].flags.in_tx ? 'X' : '-',
856 entries[i].flags.abort ? 'A' : '-',
857 entries[i].flags.cycles);
858 }
859
860 return printed;
861}
862
863static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
864 struct thread *thread,
865 struct perf_event_attr *attr, FILE *fp)
866{
867 struct branch_stack *br = sample->branch_stack;
868 struct branch_entry *entries = perf_sample__branch_entries(sample);
869 struct addr_location alf, alt;
870 u64 i, from, to;
871 int printed = 0;
872
873 if (!(br && br->nr))
874 return 0;
875
876 for (i = 0; i < br->nr; i++) {
877
878 memset(&alf, 0, sizeof(alf));
879 memset(&alt, 0, sizeof(alt));
880 from = entries[i].from;
881 to = entries[i].to;
882
883 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
884 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
885
886 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
887 if (PRINT_FIELD(DSO)) {
888 printed += fprintf(fp, "(");
889 printed += map__fprintf_dsoname(alf.map, fp);
890 printed += fprintf(fp, ")");
891 }
892 printed += fprintf(fp, "%c", '/');
893 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
894 if (PRINT_FIELD(DSO)) {
895 printed += fprintf(fp, "(");
896 printed += map__fprintf_dsoname(alt.map, fp);
897 printed += fprintf(fp, ")");
898 }
899 printed += fprintf(fp, "/%c/%c/%c/%d ",
900 mispred_str(entries + i),
901 entries[i].flags.in_tx ? 'X' : '-',
902 entries[i].flags.abort ? 'A' : '-',
903 entries[i].flags.cycles);
904 }
905
906 return printed;
907}
908
909static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
910 struct thread *thread,
911 struct perf_event_attr *attr, FILE *fp)
912{
913 struct branch_stack *br = sample->branch_stack;
914 struct branch_entry *entries = perf_sample__branch_entries(sample);
915 struct addr_location alf, alt;
916 u64 i, from, to;
917 int printed = 0;
918
919 if (!(br && br->nr))
920 return 0;
921
922 for (i = 0; i < br->nr; i++) {
923
924 memset(&alf, 0, sizeof(alf));
925 memset(&alt, 0, sizeof(alt));
926 from = entries[i].from;
927 to = entries[i].to;
928
929 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
930 !alf.map->dso->adjust_symbols)
931 from = map__map_ip(alf.map, from);
932
933 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
934 !alt.map->dso->adjust_symbols)
935 to = map__map_ip(alt.map, to);
936
937 printed += fprintf(fp, " 0x%"PRIx64, from);
938 if (PRINT_FIELD(DSO)) {
939 printed += fprintf(fp, "(");
940 printed += map__fprintf_dsoname(alf.map, fp);
941 printed += fprintf(fp, ")");
942 }
943 printed += fprintf(fp, "/0x%"PRIx64, to);
944 if (PRINT_FIELD(DSO)) {
945 printed += fprintf(fp, "(");
946 printed += map__fprintf_dsoname(alt.map, fp);
947 printed += fprintf(fp, ")");
948 }
949 printed += fprintf(fp, "/%c/%c/%c/%d ",
950 mispred_str(entries + i),
951 entries[i].flags.in_tx ? 'X' : '-',
952 entries[i].flags.abort ? 'A' : '-',
953 entries[i].flags.cycles);
954 }
955
956 return printed;
957}
958#define MAXBB 16384UL
959
960static int grab_bb(u8 *buffer, u64 start, u64 end,
961 struct machine *machine, struct thread *thread,
962 bool *is64bit, u8 *cpumode, bool last)
963{
964 long offset, len;
965 struct addr_location al;
966 bool kernel;
967
968 if (!start || !end)
969 return 0;
970
971 kernel = machine__kernel_ip(machine, start);
972 if (kernel)
973 *cpumode = PERF_RECORD_MISC_KERNEL;
974 else
975 *cpumode = PERF_RECORD_MISC_USER;
976
977 /*
978 * Block overlaps between kernel and user.
979 * This can happen due to ring filtering
980 * On Intel CPUs the entry into the kernel is filtered,
981 * but the exit is not. Let the caller patch it up.
982 */
983 if (kernel != machine__kernel_ip(machine, end)) {
984 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
985 return -ENXIO;
986 }
987
988 memset(&al, 0, sizeof(al));
989 if (end - start > MAXBB - MAXINSN) {
990 if (last)
991 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
992 else
993 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
994 return 0;
995 }
996
997 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
998 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
999 return 0;
1000 }
1001 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1002 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1003 return 0;
1004 }
1005
1006 /* Load maps to ensure dso->is_64_bit has been updated */
1007 map__load(al.map);
1008
1009 offset = al.map->map_ip(al.map, start);
1010 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1011 end - start + MAXINSN);
1012
1013 *is64bit = al.map->dso->is_64_bit;
1014 if (len <= 0)
1015 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1016 start, end);
1017 return len;
1018}
1019
1020static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1021{
1022 char *srcfile;
1023 int ret = 0;
1024 unsigned line;
1025 int len;
1026 char *srccode;
1027
1028 if (!map || !map->dso)
1029 return 0;
1030 srcfile = get_srcline_split(map->dso,
1031 map__rip_2objdump(map, addr),
1032 &line);
1033 if (!srcfile)
1034 return 0;
1035
1036 /* Avoid redundant printing */
1037 if (state &&
1038 state->srcfile &&
1039 !strcmp(state->srcfile, srcfile) &&
1040 state->line == line) {
1041 free(srcfile);
1042 return 0;
1043 }
1044
1045 srccode = find_sourceline(srcfile, line, &len);
1046 if (!srccode)
1047 goto out_free_line;
1048
1049 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1050
1051 if (state) {
1052 state->srcfile = srcfile;
1053 state->line = line;
1054 }
1055 return ret;
1056
1057out_free_line:
1058 free(srcfile);
1059 return ret;
1060}
1061
1062static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1063{
1064 struct addr_location al;
1065 int ret = 0;
1066
1067 memset(&al, 0, sizeof(al));
1068 thread__find_map(thread, cpumode, addr, &al);
1069 if (!al.map)
1070 return 0;
1071 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1072 &thread->srccode_state);
1073 if (ret)
1074 ret += printf("\n");
1075 return ret;
1076}
1077
1078static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1079 struct perf_insn *x, u8 *inbuf, int len,
1080 int insn, FILE *fp, int *total_cycles)
1081{
1082 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
1083 dump_insn(x, ip, inbuf, len, NULL),
1084 en->flags.predicted ? " PRED" : "",
1085 en->flags.mispred ? " MISPRED" : "",
1086 en->flags.in_tx ? " INTX" : "",
1087 en->flags.abort ? " ABORT" : "");
1088 if (en->flags.cycles) {
1089 *total_cycles += en->flags.cycles;
1090 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1091 if (insn)
1092 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1093 }
1094 return printed + fprintf(fp, "\n");
1095}
1096
1097static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1098 u8 cpumode, int cpu, struct symbol **lastsym,
1099 struct perf_event_attr *attr, FILE *fp)
1100{
1101 struct addr_location al;
1102 int off, printed = 0;
1103
1104 memset(&al, 0, sizeof(al));
1105
1106 thread__find_map(thread, cpumode, addr, &al);
1107
1108 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1109 return 0;
1110
1111 al.cpu = cpu;
1112 al.sym = NULL;
1113 if (al.map)
1114 al.sym = map__find_symbol(al.map, al.addr);
1115
1116 if (!al.sym)
1117 return 0;
1118
1119 if (al.addr < al.sym->end)
1120 off = al.addr - al.sym->start;
1121 else
1122 off = al.addr - al.map->start - al.sym->start;
1123 printed += fprintf(fp, "\t%s", al.sym->name);
1124 if (off)
1125 printed += fprintf(fp, "%+d", off);
1126 printed += fprintf(fp, ":");
1127 if (PRINT_FIELD(SRCLINE))
1128 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1129 printed += fprintf(fp, "\n");
1130 *lastsym = al.sym;
1131
1132 return printed;
1133}
1134
1135static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1136 struct thread *thread,
1137 struct perf_event_attr *attr,
1138 struct machine *machine, FILE *fp)
1139{
1140 struct branch_stack *br = sample->branch_stack;
1141 struct branch_entry *entries = perf_sample__branch_entries(sample);
1142 u64 start, end;
1143 int i, insn, len, nr, ilen, printed = 0;
1144 struct perf_insn x;
1145 u8 buffer[MAXBB];
1146 unsigned off;
1147 struct symbol *lastsym = NULL;
1148 int total_cycles = 0;
1149
1150 if (!(br && br->nr))
1151 return 0;
1152 nr = br->nr;
1153 if (max_blocks && nr > max_blocks + 1)
1154 nr = max_blocks + 1;
1155
1156 x.thread = thread;
1157 x.cpu = sample->cpu;
1158
1159 printed += fprintf(fp, "%c", '\n');
1160
1161 /* Handle first from jump, of which we don't know the entry. */
1162 len = grab_bb(buffer, entries[nr-1].from,
1163 entries[nr-1].from,
1164 machine, thread, &x.is64bit, &x.cpumode, false);
1165 if (len > 0) {
1166 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1167 x.cpumode, x.cpu, &lastsym, attr, fp);
1168 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1169 &x, buffer, len, 0, fp, &total_cycles);
1170 if (PRINT_FIELD(SRCCODE))
1171 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1172 }
1173
1174 /* Print all blocks */
1175 for (i = nr - 2; i >= 0; i--) {
1176 if (entries[i].from || entries[i].to)
1177 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1178 entries[i].from,
1179 entries[i].to);
1180 start = entries[i + 1].to;
1181 end = entries[i].from;
1182
1183 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1184 /* Patch up missing kernel transfers due to ring filters */
1185 if (len == -ENXIO && i > 0) {
1186 end = entries[--i].from;
1187 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1188 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1189 }
1190 if (len <= 0)
1191 continue;
1192
1193 insn = 0;
1194 for (off = 0; off < (unsigned)len; off += ilen) {
1195 uint64_t ip = start + off;
1196
1197 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1198 if (ip == end) {
1199 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1200 &total_cycles);
1201 if (PRINT_FIELD(SRCCODE))
1202 printed += print_srccode(thread, x.cpumode, ip);
1203 break;
1204 } else {
1205 ilen = 0;
1206 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1207 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1208 if (ilen == 0)
1209 break;
1210 if (PRINT_FIELD(SRCCODE))
1211 print_srccode(thread, x.cpumode, ip);
1212 insn++;
1213 }
1214 }
1215 if (off != end - start)
1216 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1217 }
1218
1219 /*
1220 * Hit the branch? In this case we are already done, and the target
1221 * has not been executed yet.
1222 */
1223 if (entries[0].from == sample->ip)
1224 goto out;
1225 if (entries[0].flags.abort)
1226 goto out;
1227
1228 /*
1229 * Print final block upto sample
1230 *
1231 * Due to pipeline delays the LBRs might be missing a branch
1232 * or two, which can result in very large or negative blocks
1233 * between final branch and sample. When this happens just
1234 * continue walking after the last TO until we hit a branch.
1235 */
1236 start = entries[0].to;
1237 end = sample->ip;
1238 if (end < start) {
1239 /* Missing jump. Scan 128 bytes for the next branch */
1240 end = start + 128;
1241 }
1242 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1243 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1244 if (len <= 0) {
1245 /* Print at least last IP if basic block did not work */
1246 len = grab_bb(buffer, sample->ip, sample->ip,
1247 machine, thread, &x.is64bit, &x.cpumode, false);
1248 if (len <= 0)
1249 goto out;
1250 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1251 dump_insn(&x, sample->ip, buffer, len, NULL));
1252 if (PRINT_FIELD(SRCCODE))
1253 print_srccode(thread, x.cpumode, sample->ip);
1254 goto out;
1255 }
1256 for (off = 0; off <= end - start; off += ilen) {
1257 ilen = 0;
1258 printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1259 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1260 if (ilen == 0)
1261 break;
1262 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1263 /*
1264 * Hit a missing branch. Just stop.
1265 */
1266 printed += fprintf(fp, "\t... not reaching sample ...\n");
1267 break;
1268 }
1269 if (PRINT_FIELD(SRCCODE))
1270 print_srccode(thread, x.cpumode, start + off);
1271 }
1272out:
1273 return printed;
1274}
1275
1276static int perf_sample__fprintf_addr(struct perf_sample *sample,
1277 struct thread *thread,
1278 struct perf_event_attr *attr, FILE *fp)
1279{
1280 struct addr_location al;
1281 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1282
1283 if (!sample_addr_correlates_sym(attr))
1284 goto out;
1285
1286 thread__resolve(thread, &al, sample);
1287
1288 if (PRINT_FIELD(SYM)) {
1289 printed += fprintf(fp, " ");
1290 if (PRINT_FIELD(SYMOFFSET))
1291 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1292 else
1293 printed += symbol__fprintf_symname(al.sym, fp);
1294 }
1295
1296 if (PRINT_FIELD(DSO)) {
1297 printed += fprintf(fp, " (");
1298 printed += map__fprintf_dsoname(al.map, fp);
1299 printed += fprintf(fp, ")");
1300 }
1301out:
1302 return printed;
1303}
1304
1305static const char *resolve_branch_sym(struct perf_sample *sample,
1306 struct evsel *evsel,
1307 struct thread *thread,
1308 struct addr_location *al,
1309 u64 *ip)
1310{
1311 struct addr_location addr_al;
1312 struct perf_event_attr *attr = &evsel->core.attr;
1313 const char *name = NULL;
1314
1315 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1316 if (sample_addr_correlates_sym(attr)) {
1317 thread__resolve(thread, &addr_al, sample);
1318 if (addr_al.sym)
1319 name = addr_al.sym->name;
1320 else
1321 *ip = sample->addr;
1322 } else {
1323 *ip = sample->addr;
1324 }
1325 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1326 if (al->sym)
1327 name = al->sym->name;
1328 else
1329 *ip = sample->ip;
1330 }
1331 return name;
1332}
1333
1334static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1335 struct evsel *evsel,
1336 struct thread *thread,
1337 struct addr_location *al, FILE *fp)
1338{
1339 struct perf_event_attr *attr = &evsel->core.attr;
1340 size_t depth = thread_stack__depth(thread, sample->cpu);
1341 const char *name = NULL;
1342 static int spacing;
1343 int len = 0;
1344 int dlen = 0;
1345 u64 ip = 0;
1346
1347 /*
1348 * The 'return' has already been popped off the stack so the depth has
1349 * to be adjusted to match the 'call'.
1350 */
1351 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1352 depth += 1;
1353
1354 name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1355
1356 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1357 dlen += fprintf(fp, "(");
1358 dlen += map__fprintf_dsoname(al->map, fp);
1359 dlen += fprintf(fp, ")\t");
1360 }
1361
1362 if (name)
1363 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1364 else if (ip)
1365 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1366
1367 if (len < 0)
1368 return len;
1369
1370 /*
1371 * Try to keep the output length from changing frequently so that the
1372 * output lines up more nicely.
1373 */
1374 if (len > spacing || (len && len < spacing - 52))
1375 spacing = round_up(len + 4, 32);
1376
1377 if (len < spacing)
1378 len += fprintf(fp, "%*s", spacing - len, "");
1379
1380 return len + dlen;
1381}
1382
1383__weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1384 struct thread *thread __maybe_unused,
1385 struct machine *machine __maybe_unused)
1386{
1387}
1388
1389static int perf_sample__fprintf_insn(struct perf_sample *sample,
1390 struct perf_event_attr *attr,
1391 struct thread *thread,
1392 struct machine *machine, FILE *fp)
1393{
1394 int printed = 0;
1395
1396 if (sample->insn_len == 0 && native_arch)
1397 arch_fetch_insn(sample, thread, machine);
1398
1399 if (PRINT_FIELD(INSNLEN))
1400 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1401 if (PRINT_FIELD(INSN) && sample->insn_len) {
1402 int i;
1403
1404 printed += fprintf(fp, " insn:");
1405 for (i = 0; i < sample->insn_len; i++)
1406 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1407 }
1408 if (PRINT_FIELD(BRSTACKINSN))
1409 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1410
1411 return printed;
1412}
1413
1414static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1415 struct perf_event_attr *attr, FILE *fp)
1416{
1417 unsigned int ipc;
1418
1419 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1420 return 0;
1421
1422 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1423
1424 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1425 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1426}
1427
1428static int perf_sample__fprintf_bts(struct perf_sample *sample,
1429 struct evsel *evsel,
1430 struct thread *thread,
1431 struct addr_location *al,
1432 struct machine *machine, FILE *fp)
1433{
1434 struct perf_event_attr *attr = &evsel->core.attr;
1435 unsigned int type = output_type(attr->type);
1436 bool print_srcline_last = false;
1437 int printed = 0;
1438
1439 if (PRINT_FIELD(CALLINDENT))
1440 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1441
1442 /* print branch_from information */
1443 if (PRINT_FIELD(IP)) {
1444 unsigned int print_opts = output[type].print_ip_opts;
1445 struct callchain_cursor *cursor = NULL;
1446
1447 if (symbol_conf.use_callchain && sample->callchain &&
1448 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1449 sample, NULL, NULL, scripting_max_stack) == 0)
1450 cursor = &callchain_cursor;
1451
1452 if (cursor == NULL) {
1453 printed += fprintf(fp, " ");
1454 if (print_opts & EVSEL__PRINT_SRCLINE) {
1455 print_srcline_last = true;
1456 print_opts &= ~EVSEL__PRINT_SRCLINE;
1457 }
1458 } else
1459 printed += fprintf(fp, "\n");
1460
1461 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1462 symbol_conf.bt_stop_list, fp);
1463 }
1464
1465 /* print branch_to information */
1466 if (PRINT_FIELD(ADDR) ||
1467 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1468 !output[type].user_set)) {
1469 printed += fprintf(fp, " => ");
1470 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1471 }
1472
1473 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1474
1475 if (print_srcline_last)
1476 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1477
1478 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1479 printed += fprintf(fp, "\n");
1480 if (PRINT_FIELD(SRCCODE)) {
1481 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1482 &thread->srccode_state);
1483 if (ret) {
1484 printed += ret;
1485 printed += printf("\n");
1486 }
1487 }
1488 return printed;
1489}
1490
1491static struct {
1492 u32 flags;
1493 const char *name;
1494} sample_flags[] = {
1495 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1496 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1497 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1498 {PERF_IP_FLAG_BRANCH, "jmp"},
1499 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1500 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1501 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1502 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1503 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1504 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1505 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1506 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1507 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1508 {0, NULL}
1509};
1510
1511static const char *sample_flags_to_name(u32 flags)
1512{
1513 int i;
1514
1515 for (i = 0; sample_flags[i].name ; i++) {
1516 if (sample_flags[i].flags == flags)
1517 return sample_flags[i].name;
1518 }
1519
1520 return NULL;
1521}
1522
1523static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1524{
1525 const char *chars = PERF_IP_FLAG_CHARS;
1526 const int n = strlen(PERF_IP_FLAG_CHARS);
1527 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1528 const char *name = NULL;
1529 char str[33];
1530 int i, pos = 0;
1531
1532 name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1533 if (name)
1534 return fprintf(fp, " %-15s%4s ", name, in_tx ? "(x)" : "");
1535
1536 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1537 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1538 if (name)
1539 return fprintf(fp, " tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1540 }
1541
1542 if (flags & PERF_IP_FLAG_TRACE_END) {
1543 name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1544 if (name)
1545 return fprintf(fp, " tr end %-7s%4s ", name, in_tx ? "(x)" : "");
1546 }
1547
1548 for (i = 0; i < n; i++, flags >>= 1) {
1549 if (flags & 1)
1550 str[pos++] = chars[i];
1551 }
1552 for (; i < 32; i++, flags >>= 1) {
1553 if (flags & 1)
1554 str[pos++] = '?';
1555 }
1556 str[pos] = 0;
1557
1558 return fprintf(fp, " %-19s ", str);
1559}
1560
1561struct printer_data {
1562 int line_no;
1563 bool hit_nul;
1564 bool is_printable;
1565};
1566
1567static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1568 unsigned int val,
1569 void *extra, FILE *fp)
1570{
1571 unsigned char ch = (unsigned char)val;
1572 struct printer_data *printer_data = extra;
1573 int printed = 0;
1574
1575 switch (op) {
1576 case BINARY_PRINT_DATA_BEGIN:
1577 printed += fprintf(fp, "\n");
1578 break;
1579 case BINARY_PRINT_LINE_BEGIN:
1580 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1581 " ");
1582 break;
1583 case BINARY_PRINT_ADDR:
1584 printed += fprintf(fp, " %04x:", val);
1585 break;
1586 case BINARY_PRINT_NUM_DATA:
1587 printed += fprintf(fp, " %02x", val);
1588 break;
1589 case BINARY_PRINT_NUM_PAD:
1590 printed += fprintf(fp, " ");
1591 break;
1592 case BINARY_PRINT_SEP:
1593 printed += fprintf(fp, " ");
1594 break;
1595 case BINARY_PRINT_CHAR_DATA:
1596 if (printer_data->hit_nul && ch)
1597 printer_data->is_printable = false;
1598
1599 if (!isprint(ch)) {
1600 printed += fprintf(fp, "%c", '.');
1601
1602 if (!printer_data->is_printable)
1603 break;
1604
1605 if (ch == '\0')
1606 printer_data->hit_nul = true;
1607 else
1608 printer_data->is_printable = false;
1609 } else {
1610 printed += fprintf(fp, "%c", ch);
1611 }
1612 break;
1613 case BINARY_PRINT_CHAR_PAD:
1614 printed += fprintf(fp, " ");
1615 break;
1616 case BINARY_PRINT_LINE_END:
1617 printed += fprintf(fp, "\n");
1618 printer_data->line_no++;
1619 break;
1620 case BINARY_PRINT_DATA_END:
1621 default:
1622 break;
1623 }
1624
1625 return printed;
1626}
1627
1628static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1629{
1630 unsigned int nr_bytes = sample->raw_size;
1631 struct printer_data printer_data = {0, false, true};
1632 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1633 sample__fprintf_bpf_output, &printer_data, fp);
1634
1635 if (printer_data.is_printable && printer_data.hit_nul)
1636 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1637
1638 return printed;
1639}
1640
1641static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1642{
1643 if (len > 0 && len < spacing)
1644 return fprintf(fp, "%*s", spacing - len, "");
1645
1646 return 0;
1647}
1648
1649static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1650{
1651 return perf_sample__fprintf_spacing(len, 34, fp);
1652}
1653
1654static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1655{
1656 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1657 int len;
1658
1659 if (perf_sample__bad_synth_size(sample, *data))
1660 return 0;
1661
1662 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1663 data->ip, le64_to_cpu(data->payload));
1664 return len + perf_sample__fprintf_pt_spacing(len, fp);
1665}
1666
1667static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1668{
1669 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1670 int len;
1671
1672 if (perf_sample__bad_synth_size(sample, *data))
1673 return 0;
1674
1675 len = fprintf(fp, " hints: %#x extensions: %#x ",
1676 data->hints, data->extensions);
1677 return len + perf_sample__fprintf_pt_spacing(len, fp);
1678}
1679
1680static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1681{
1682 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1683 int len;
1684
1685 if (perf_sample__bad_synth_size(sample, *data))
1686 return 0;
1687
1688 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1689 data->hw, data->cstate, data->subcstate);
1690 return len + perf_sample__fprintf_pt_spacing(len, fp);
1691}
1692
1693static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1694{
1695 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1696 int len;
1697
1698 if (perf_sample__bad_synth_size(sample, *data))
1699 return 0;
1700
1701 len = fprintf(fp, " IP: %u ", data->ip);
1702 return len + perf_sample__fprintf_pt_spacing(len, fp);
1703}
1704
1705static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1706{
1707 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1708 int len;
1709
1710 if (perf_sample__bad_synth_size(sample, *data))
1711 return 0;
1712
1713 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1714 data->deepest_cstate, data->last_cstate,
1715 data->wake_reason);
1716 return len + perf_sample__fprintf_pt_spacing(len, fp);
1717}
1718
1719static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1720{
1721 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1722 unsigned int percent, freq;
1723 int len;
1724
1725 if (perf_sample__bad_synth_size(sample, *data))
1726 return 0;
1727
1728 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1729 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1730 if (data->max_nonturbo) {
1731 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1732 len += fprintf(fp, "(%3u%%) ", percent);
1733 }
1734 return len + perf_sample__fprintf_pt_spacing(len, fp);
1735}
1736
1737static int perf_sample__fprintf_synth(struct perf_sample *sample,
1738 struct evsel *evsel, FILE *fp)
1739{
1740 switch (evsel->core.attr.config) {
1741 case PERF_SYNTH_INTEL_PTWRITE:
1742 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1743 case PERF_SYNTH_INTEL_MWAIT:
1744 return perf_sample__fprintf_synth_mwait(sample, fp);
1745 case PERF_SYNTH_INTEL_PWRE:
1746 return perf_sample__fprintf_synth_pwre(sample, fp);
1747 case PERF_SYNTH_INTEL_EXSTOP:
1748 return perf_sample__fprintf_synth_exstop(sample, fp);
1749 case PERF_SYNTH_INTEL_PWRX:
1750 return perf_sample__fprintf_synth_pwrx(sample, fp);
1751 case PERF_SYNTH_INTEL_CBR:
1752 return perf_sample__fprintf_synth_cbr(sample, fp);
1753 default:
1754 break;
1755 }
1756
1757 return 0;
1758}
1759
1760static int evlist__max_name_len(struct evlist *evlist)
1761{
1762 struct evsel *evsel;
1763 int max = 0;
1764
1765 evlist__for_each_entry(evlist, evsel) {
1766 int len = strlen(evsel__name(evsel));
1767
1768 max = MAX(len, max);
1769 }
1770
1771 return max;
1772}
1773
1774static int data_src__fprintf(u64 data_src, FILE *fp)
1775{
1776 struct mem_info mi = { .data_src.val = data_src };
1777 char decode[100];
1778 char out[100];
1779 static int maxlen;
1780 int len;
1781
1782 perf_script__meminfo_scnprintf(decode, 100, &mi);
1783
1784 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1785 if (maxlen < len)
1786 maxlen = len;
1787
1788 return fprintf(fp, "%-*s", maxlen, out);
1789}
1790
1791struct metric_ctx {
1792 struct perf_sample *sample;
1793 struct thread *thread;
1794 struct evsel *evsel;
1795 FILE *fp;
1796};
1797
1798static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1799 void *ctx, const char *color,
1800 const char *fmt,
1801 const char *unit, double val)
1802{
1803 struct metric_ctx *mctx = ctx;
1804
1805 if (!fmt)
1806 return;
1807 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1808 PERF_RECORD_SAMPLE, mctx->fp);
1809 fputs("\tmetric: ", mctx->fp);
1810 if (color)
1811 color_fprintf(mctx->fp, color, fmt, val);
1812 else
1813 printf(fmt, val);
1814 fprintf(mctx->fp, " %s\n", unit);
1815}
1816
1817static void script_new_line(struct perf_stat_config *config __maybe_unused,
1818 void *ctx)
1819{
1820 struct metric_ctx *mctx = ctx;
1821
1822 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1823 PERF_RECORD_SAMPLE, mctx->fp);
1824 fputs("\tmetric: ", mctx->fp);
1825}
1826
1827static void perf_sample__fprint_metric(struct perf_script *script,
1828 struct thread *thread,
1829 struct evsel *evsel,
1830 struct perf_sample *sample,
1831 FILE *fp)
1832{
1833 struct perf_stat_output_ctx ctx = {
1834 .print_metric = script_print_metric,
1835 .new_line = script_new_line,
1836 .ctx = &(struct metric_ctx) {
1837 .sample = sample,
1838 .thread = thread,
1839 .evsel = evsel,
1840 .fp = fp,
1841 },
1842 .force_header = false,
1843 };
1844 struct evsel *ev2;
1845 u64 val;
1846
1847 if (!evsel->stats)
1848 perf_evlist__alloc_stats(script->session->evlist, false);
1849 if (evsel_script(evsel->leader)->gnum++ == 0)
1850 perf_stat__reset_shadow_stats();
1851 val = sample->period * evsel->scale;
1852 perf_stat__update_shadow_stats(evsel,
1853 val,
1854 sample->cpu,
1855 &rt_stat);
1856 evsel_script(evsel)->val = val;
1857 if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1858 for_each_group_member (ev2, evsel->leader) {
1859 perf_stat__print_shadow_stats(&stat_config, ev2,
1860 evsel_script(ev2)->val,
1861 sample->cpu,
1862 &ctx,
1863 NULL,
1864 &rt_stat);
1865 }
1866 evsel_script(evsel->leader)->gnum = 0;
1867 }
1868}
1869
1870static bool show_event(struct perf_sample *sample,
1871 struct evsel *evsel,
1872 struct thread *thread,
1873 struct addr_location *al)
1874{
1875 int depth = thread_stack__depth(thread, sample->cpu);
1876
1877 if (!symbol_conf.graph_function)
1878 return true;
1879
1880 if (thread->filter) {
1881 if (depth <= thread->filter_entry_depth) {
1882 thread->filter = false;
1883 return false;
1884 }
1885 return true;
1886 } else {
1887 const char *s = symbol_conf.graph_function;
1888 u64 ip;
1889 const char *name = resolve_branch_sym(sample, evsel, thread, al,
1890 &ip);
1891 unsigned nlen;
1892
1893 if (!name)
1894 return false;
1895 nlen = strlen(name);
1896 while (*s) {
1897 unsigned len = strcspn(s, ",");
1898 if (nlen == len && !strncmp(name, s, len)) {
1899 thread->filter = true;
1900 thread->filter_entry_depth = depth;
1901 return true;
1902 }
1903 s += len;
1904 if (*s == ',')
1905 s++;
1906 }
1907 return false;
1908 }
1909}
1910
1911static void process_event(struct perf_script *script,
1912 struct perf_sample *sample, struct evsel *evsel,
1913 struct addr_location *al,
1914 struct machine *machine)
1915{
1916 struct thread *thread = al->thread;
1917 struct perf_event_attr *attr = &evsel->core.attr;
1918 unsigned int type = output_type(attr->type);
1919 struct evsel_script *es = evsel->priv;
1920 FILE *fp = es->fp;
1921
1922 if (output[type].fields == 0)
1923 return;
1924
1925 if (!show_event(sample, evsel, thread, al))
1926 return;
1927
1928 if (evswitch__discard(&script->evswitch, evsel))
1929 return;
1930
1931 ++es->samples;
1932
1933 perf_sample__fprintf_start(script, sample, thread, evsel,
1934 PERF_RECORD_SAMPLE, fp);
1935
1936 if (PRINT_FIELD(PERIOD))
1937 fprintf(fp, "%10" PRIu64 " ", sample->period);
1938
1939 if (PRINT_FIELD(EVNAME)) {
1940 const char *evname = evsel__name(evsel);
1941
1942 if (!script->name_width)
1943 script->name_width = evlist__max_name_len(script->session->evlist);
1944
1945 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1946 }
1947
1948 if (print_flags)
1949 perf_sample__fprintf_flags(sample->flags, fp);
1950
1951 if (is_bts_event(attr)) {
1952 perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1953 return;
1954 }
1955
1956 if (PRINT_FIELD(TRACE) && sample->raw_data) {
1957 event_format__fprintf(evsel->tp_format, sample->cpu,
1958 sample->raw_data, sample->raw_size, fp);
1959 }
1960
1961 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1962 perf_sample__fprintf_synth(sample, evsel, fp);
1963
1964 if (PRINT_FIELD(ADDR))
1965 perf_sample__fprintf_addr(sample, thread, attr, fp);
1966
1967 if (PRINT_FIELD(DATA_SRC))
1968 data_src__fprintf(sample->data_src, fp);
1969
1970 if (PRINT_FIELD(WEIGHT))
1971 fprintf(fp, "%16" PRIu64, sample->weight);
1972
1973 if (PRINT_FIELD(IP)) {
1974 struct callchain_cursor *cursor = NULL;
1975
1976 if (script->stitch_lbr)
1977 al->thread->lbr_stitch_enable = true;
1978
1979 if (symbol_conf.use_callchain && sample->callchain &&
1980 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1981 sample, NULL, NULL, scripting_max_stack) == 0)
1982 cursor = &callchain_cursor;
1983
1984 fputc(cursor ? '\n' : ' ', fp);
1985 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
1986 symbol_conf.bt_stop_list, fp);
1987 }
1988
1989 if (PRINT_FIELD(IREGS))
1990 perf_sample__fprintf_iregs(sample, attr, fp);
1991
1992 if (PRINT_FIELD(UREGS))
1993 perf_sample__fprintf_uregs(sample, attr, fp);
1994
1995 if (PRINT_FIELD(BRSTACK))
1996 perf_sample__fprintf_brstack(sample, thread, attr, fp);
1997 else if (PRINT_FIELD(BRSTACKSYM))
1998 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1999 else if (PRINT_FIELD(BRSTACKOFF))
2000 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2001
2002 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2003 perf_sample__fprintf_bpf_output(sample, fp);
2004 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2005
2006 if (PRINT_FIELD(PHYS_ADDR))
2007 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2008
2009 perf_sample__fprintf_ipc(sample, attr, fp);
2010
2011 fprintf(fp, "\n");
2012
2013 if (PRINT_FIELD(SRCCODE)) {
2014 if (map__fprintf_srccode(al->map, al->addr, stdout,
2015 &thread->srccode_state))
2016 printf("\n");
2017 }
2018
2019 if (PRINT_FIELD(METRIC))
2020 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2021
2022 if (verbose)
2023 fflush(fp);
2024}
2025
2026static struct scripting_ops *scripting_ops;
2027
2028static void __process_stat(struct evsel *counter, u64 tstamp)
2029{
2030 int nthreads = perf_thread_map__nr(counter->core.threads);
2031 int ncpus = evsel__nr_cpus(counter);
2032 int cpu, thread;
2033 static int header_printed;
2034
2035 if (counter->core.system_wide)
2036 nthreads = 1;
2037
2038 if (!header_printed) {
2039 printf("%3s %8s %15s %15s %15s %15s %s\n",
2040 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2041 header_printed = 1;
2042 }
2043
2044 for (thread = 0; thread < nthreads; thread++) {
2045 for (cpu = 0; cpu < ncpus; cpu++) {
2046 struct perf_counts_values *counts;
2047
2048 counts = perf_counts(counter->counts, cpu, thread);
2049
2050 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2051 counter->core.cpus->map[cpu],
2052 perf_thread_map__pid(counter->core.threads, thread),
2053 counts->val,
2054 counts->ena,
2055 counts->run,
2056 tstamp,
2057 evsel__name(counter));
2058 }
2059 }
2060}
2061
2062static void process_stat(struct evsel *counter, u64 tstamp)
2063{
2064 if (scripting_ops && scripting_ops->process_stat)
2065 scripting_ops->process_stat(&stat_config, counter, tstamp);
2066 else
2067 __process_stat(counter, tstamp);
2068}
2069
2070static void process_stat_interval(u64 tstamp)
2071{
2072 if (scripting_ops && scripting_ops->process_stat_interval)
2073 scripting_ops->process_stat_interval(tstamp);
2074}
2075
2076static void setup_scripting(void)
2077{
2078 setup_perl_scripting();
2079 setup_python_scripting();
2080}
2081
2082static int flush_scripting(void)
2083{
2084 return scripting_ops ? scripting_ops->flush_script() : 0;
2085}
2086
2087static int cleanup_scripting(void)
2088{
2089 pr_debug("\nperf script stopped\n");
2090
2091 return scripting_ops ? scripting_ops->stop_script() : 0;
2092}
2093
2094static bool filter_cpu(struct perf_sample *sample)
2095{
2096 if (cpu_list && sample->cpu != (u32)-1)
2097 return !test_bit(sample->cpu, cpu_bitmap);
2098 return false;
2099}
2100
2101static int process_sample_event(struct perf_tool *tool,
2102 union perf_event *event,
2103 struct perf_sample *sample,
2104 struct evsel *evsel,
2105 struct machine *machine)
2106{
2107 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2108 struct addr_location al;
2109
2110 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2111 sample->time)) {
2112 return 0;
2113 }
2114
2115 if (debug_mode) {
2116 if (sample->time < last_timestamp) {
2117 pr_err("Samples misordered, previous: %" PRIu64
2118 " this: %" PRIu64 "\n", last_timestamp,
2119 sample->time);
2120 nr_unordered++;
2121 }
2122 last_timestamp = sample->time;
2123 return 0;
2124 }
2125
2126 if (machine__resolve(machine, &al, sample) < 0) {
2127 pr_err("problem processing %d event, skipping it.\n",
2128 event->header.type);
2129 return -1;
2130 }
2131
2132 if (al.filtered)
2133 goto out_put;
2134
2135 if (filter_cpu(sample))
2136 goto out_put;
2137
2138 if (scripting_ops)
2139 scripting_ops->process_event(event, sample, evsel, &al);
2140 else
2141 process_event(scr, sample, evsel, &al, machine);
2142
2143out_put:
2144 addr_location__put(&al);
2145 return 0;
2146}
2147
2148static int process_attr(struct perf_tool *tool, union perf_event *event,
2149 struct evlist **pevlist)
2150{
2151 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2152 struct evlist *evlist;
2153 struct evsel *evsel, *pos;
2154 u64 sample_type;
2155 int err;
2156 static struct evsel_script *es;
2157
2158 err = perf_event__process_attr(tool, event, pevlist);
2159 if (err)
2160 return err;
2161
2162 evlist = *pevlist;
2163 evsel = evlist__last(*pevlist);
2164
2165 if (!evsel->priv) {
2166 if (scr->per_event_dump) {
2167 evsel->priv = perf_evsel_script__new(evsel,
2168 scr->session->data);
2169 } else {
2170 es = zalloc(sizeof(*es));
2171 if (!es)
2172 return -ENOMEM;
2173 es->fp = stdout;
2174 evsel->priv = es;
2175 }
2176 }
2177
2178 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2179 evsel->core.attr.type != PERF_TYPE_SYNTH)
2180 return 0;
2181
2182 evlist__for_each_entry(evlist, pos) {
2183 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2184 return 0;
2185 }
2186
2187 if (evsel->core.attr.sample_type) {
2188 err = evsel__check_attr(evsel, scr->session);
2189 if (err)
2190 return err;
2191 }
2192
2193 /*
2194 * Check if we need to enable callchains based
2195 * on events sample_type.
2196 */
2197 sample_type = evlist__combined_sample_type(evlist);
2198 callchain_param_setup(sample_type);
2199
2200 /* Enable fields for callchain entries */
2201 if (symbol_conf.use_callchain &&
2202 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2203 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2204 (sample_type & PERF_SAMPLE_REGS_USER &&
2205 sample_type & PERF_SAMPLE_STACK_USER))) {
2206 int type = output_type(evsel->core.attr.type);
2207
2208 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2209 output[type].fields |= PERF_OUTPUT_IP;
2210 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2211 output[type].fields |= PERF_OUTPUT_SYM;
2212 }
2213 set_print_ip_opts(&evsel->core.attr);
2214 return 0;
2215}
2216
2217static int print_event_with_time(struct perf_tool *tool,
2218 union perf_event *event,
2219 struct perf_sample *sample,
2220 struct machine *machine,
2221 pid_t pid, pid_t tid, u64 timestamp)
2222{
2223 struct perf_script *script = container_of(tool, struct perf_script, tool);
2224 struct perf_session *session = script->session;
2225 struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2226 struct thread *thread = NULL;
2227
2228 if (evsel && !evsel->core.attr.sample_id_all) {
2229 sample->cpu = 0;
2230 sample->time = timestamp;
2231 sample->pid = pid;
2232 sample->tid = tid;
2233 }
2234
2235 if (filter_cpu(sample))
2236 return 0;
2237
2238 if (tid != -1)
2239 thread = machine__findnew_thread(machine, pid, tid);
2240
2241 if (thread && evsel) {
2242 perf_sample__fprintf_start(script, sample, thread, evsel,
2243 event->header.type, stdout);
2244 }
2245
2246 perf_event__fprintf(event, machine, stdout);
2247
2248 thread__put(thread);
2249
2250 return 0;
2251}
2252
2253static int print_event(struct perf_tool *tool, union perf_event *event,
2254 struct perf_sample *sample, struct machine *machine,
2255 pid_t pid, pid_t tid)
2256{
2257 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2258}
2259
2260static int process_comm_event(struct perf_tool *tool,
2261 union perf_event *event,
2262 struct perf_sample *sample,
2263 struct machine *machine)
2264{
2265 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2266 return -1;
2267
2268 return print_event(tool, event, sample, machine, event->comm.pid,
2269 event->comm.tid);
2270}
2271
2272static int process_namespaces_event(struct perf_tool *tool,
2273 union perf_event *event,
2274 struct perf_sample *sample,
2275 struct machine *machine)
2276{
2277 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2278 return -1;
2279
2280 return print_event(tool, event, sample, machine, event->namespaces.pid,
2281 event->namespaces.tid);
2282}
2283
2284static int process_cgroup_event(struct perf_tool *tool,
2285 union perf_event *event,
2286 struct perf_sample *sample,
2287 struct machine *machine)
2288{
2289 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2290 return -1;
2291
2292 return print_event(tool, event, sample, machine, sample->pid,
2293 sample->tid);
2294}
2295
2296static int process_fork_event(struct perf_tool *tool,
2297 union perf_event *event,
2298 struct perf_sample *sample,
2299 struct machine *machine)
2300{
2301 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2302 return -1;
2303
2304 return print_event_with_time(tool, event, sample, machine,
2305 event->fork.pid, event->fork.tid,
2306 event->fork.time);
2307}
2308static int process_exit_event(struct perf_tool *tool,
2309 union perf_event *event,
2310 struct perf_sample *sample,
2311 struct machine *machine)
2312{
2313 /* Print before 'exit' deletes anything */
2314 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2315 event->fork.tid, event->fork.time))
2316 return -1;
2317
2318 return perf_event__process_exit(tool, event, sample, machine);
2319}
2320
2321static int process_mmap_event(struct perf_tool *tool,
2322 union perf_event *event,
2323 struct perf_sample *sample,
2324 struct machine *machine)
2325{
2326 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2327 return -1;
2328
2329 return print_event(tool, event, sample, machine, event->mmap.pid,
2330 event->mmap.tid);
2331}
2332
2333static int process_mmap2_event(struct perf_tool *tool,
2334 union perf_event *event,
2335 struct perf_sample *sample,
2336 struct machine *machine)
2337{
2338 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2339 return -1;
2340
2341 return print_event(tool, event, sample, machine, event->mmap2.pid,
2342 event->mmap2.tid);
2343}
2344
2345static int process_switch_event(struct perf_tool *tool,
2346 union perf_event *event,
2347 struct perf_sample *sample,
2348 struct machine *machine)
2349{
2350 struct perf_script *script = container_of(tool, struct perf_script, tool);
2351
2352 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2353 return -1;
2354
2355 if (scripting_ops && scripting_ops->process_switch)
2356 scripting_ops->process_switch(event, sample, machine);
2357
2358 if (!script->show_switch_events)
2359 return 0;
2360
2361 return print_event(tool, event, sample, machine, sample->pid,
2362 sample->tid);
2363}
2364
2365static int
2366process_lost_event(struct perf_tool *tool,
2367 union perf_event *event,
2368 struct perf_sample *sample,
2369 struct machine *machine)
2370{
2371 return print_event(tool, event, sample, machine, sample->pid,
2372 sample->tid);
2373}
2374
2375static int
2376process_finished_round_event(struct perf_tool *tool __maybe_unused,
2377 union perf_event *event,
2378 struct ordered_events *oe __maybe_unused)
2379
2380{
2381 perf_event__fprintf(event, NULL, stdout);
2382 return 0;
2383}
2384
2385static int
2386process_bpf_events(struct perf_tool *tool __maybe_unused,
2387 union perf_event *event,
2388 struct perf_sample *sample,
2389 struct machine *machine)
2390{
2391 if (machine__process_ksymbol(machine, event, sample) < 0)
2392 return -1;
2393
2394 return print_event(tool, event, sample, machine, sample->pid,
2395 sample->tid);
2396}
2397
2398static int process_text_poke_events(struct perf_tool *tool,
2399 union perf_event *event,
2400 struct perf_sample *sample,
2401 struct machine *machine)
2402{
2403 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2404 return -1;
2405
2406 return print_event(tool, event, sample, machine, sample->pid,
2407 sample->tid);
2408}
2409
2410static void sig_handler(int sig __maybe_unused)
2411{
2412 session_done = 1;
2413}
2414
2415static void perf_script__fclose_per_event_dump(struct perf_script *script)
2416{
2417 struct evlist *evlist = script->session->evlist;
2418 struct evsel *evsel;
2419
2420 evlist__for_each_entry(evlist, evsel) {
2421 if (!evsel->priv)
2422 break;
2423 perf_evsel_script__delete(evsel->priv);
2424 evsel->priv = NULL;
2425 }
2426}
2427
2428static int perf_script__fopen_per_event_dump(struct perf_script *script)
2429{
2430 struct evsel *evsel;
2431
2432 evlist__for_each_entry(script->session->evlist, evsel) {
2433 /*
2434 * Already setup? I.e. we may be called twice in cases like
2435 * Intel PT, one for the intel_pt// and dummy events, then
2436 * for the evsels syntheized from the auxtrace info.
2437 *
2438 * Ses perf_script__process_auxtrace_info.
2439 */
2440 if (evsel->priv != NULL)
2441 continue;
2442
2443 evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2444 if (evsel->priv == NULL)
2445 goto out_err_fclose;
2446 }
2447
2448 return 0;
2449
2450out_err_fclose:
2451 perf_script__fclose_per_event_dump(script);
2452 return -1;
2453}
2454
2455static int perf_script__setup_per_event_dump(struct perf_script *script)
2456{
2457 struct evsel *evsel;
2458 static struct evsel_script es_stdout;
2459
2460 if (script->per_event_dump)
2461 return perf_script__fopen_per_event_dump(script);
2462
2463 es_stdout.fp = stdout;
2464
2465 evlist__for_each_entry(script->session->evlist, evsel)
2466 evsel->priv = &es_stdout;
2467
2468 return 0;
2469}
2470
2471static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2472{
2473 struct evsel *evsel;
2474
2475 evlist__for_each_entry(script->session->evlist, evsel) {
2476 struct evsel_script *es = evsel->priv;
2477
2478 perf_evsel_script__fprintf(es, stdout);
2479 perf_evsel_script__delete(es);
2480 evsel->priv = NULL;
2481 }
2482}
2483
2484static int __cmd_script(struct perf_script *script)
2485{
2486 int ret;
2487
2488 signal(SIGINT, sig_handler);
2489
2490 perf_stat__init_shadow_stats();
2491
2492 /* override event processing functions */
2493 if (script->show_task_events) {
2494 script->tool.comm = process_comm_event;
2495 script->tool.fork = process_fork_event;
2496 script->tool.exit = process_exit_event;
2497 }
2498 if (script->show_mmap_events) {
2499 script->tool.mmap = process_mmap_event;
2500 script->tool.mmap2 = process_mmap2_event;
2501 }
2502 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2503 script->tool.context_switch = process_switch_event;
2504 if (script->show_namespace_events)
2505 script->tool.namespaces = process_namespaces_event;
2506 if (script->show_cgroup_events)
2507 script->tool.cgroup = process_cgroup_event;
2508 if (script->show_lost_events)
2509 script->tool.lost = process_lost_event;
2510 if (script->show_round_events) {
2511 script->tool.ordered_events = false;
2512 script->tool.finished_round = process_finished_round_event;
2513 }
2514 if (script->show_bpf_events) {
2515 script->tool.ksymbol = process_bpf_events;
2516 script->tool.bpf = process_bpf_events;
2517 }
2518 if (script->show_text_poke_events) {
2519 script->tool.ksymbol = process_bpf_events;
2520 script->tool.text_poke = process_text_poke_events;
2521 }
2522
2523 if (perf_script__setup_per_event_dump(script)) {
2524 pr_err("Couldn't create the per event dump files\n");
2525 return -1;
2526 }
2527
2528 ret = perf_session__process_events(script->session);
2529
2530 if (script->per_event_dump)
2531 perf_script__exit_per_event_dump_stats(script);
2532
2533 if (debug_mode)
2534 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2535
2536 return ret;
2537}
2538
2539struct script_spec {
2540 struct list_head node;
2541 struct scripting_ops *ops;
2542 char spec[];
2543};
2544
2545static LIST_HEAD(script_specs);
2546
2547static struct script_spec *script_spec__new(const char *spec,
2548 struct scripting_ops *ops)
2549{
2550 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2551
2552 if (s != NULL) {
2553 strcpy(s->spec, spec);
2554 s->ops = ops;
2555 }
2556
2557 return s;
2558}
2559
2560static void script_spec__add(struct script_spec *s)
2561{
2562 list_add_tail(&s->node, &script_specs);
2563}
2564
2565static struct script_spec *script_spec__find(const char *spec)
2566{
2567 struct script_spec *s;
2568
2569 list_for_each_entry(s, &script_specs, node)
2570 if (strcasecmp(s->spec, spec) == 0)
2571 return s;
2572 return NULL;
2573}
2574
2575int script_spec_register(const char *spec, struct scripting_ops *ops)
2576{
2577 struct script_spec *s;
2578
2579 s = script_spec__find(spec);
2580 if (s)
2581 return -1;
2582
2583 s = script_spec__new(spec, ops);
2584 if (!s)
2585 return -1;
2586 else
2587 script_spec__add(s);
2588
2589 return 0;
2590}
2591
2592static struct scripting_ops *script_spec__lookup(const char *spec)
2593{
2594 struct script_spec *s = script_spec__find(spec);
2595 if (!s)
2596 return NULL;
2597
2598 return s->ops;
2599}
2600
2601static void list_available_languages(void)
2602{
2603 struct script_spec *s;
2604
2605 fprintf(stderr, "\n");
2606 fprintf(stderr, "Scripting language extensions (used in "
2607 "perf script -s [spec:]script.[spec]):\n\n");
2608
2609 list_for_each_entry(s, &script_specs, node)
2610 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2611
2612 fprintf(stderr, "\n");
2613}
2614
2615static int parse_scriptname(const struct option *opt __maybe_unused,
2616 const char *str, int unset __maybe_unused)
2617{
2618 char spec[PATH_MAX];
2619 const char *script, *ext;
2620 int len;
2621
2622 if (strcmp(str, "lang") == 0) {
2623 list_available_languages();
2624 exit(0);
2625 }
2626
2627 script = strchr(str, ':');
2628 if (script) {
2629 len = script - str;
2630 if (len >= PATH_MAX) {
2631 fprintf(stderr, "invalid language specifier");
2632 return -1;
2633 }
2634 strncpy(spec, str, len);
2635 spec[len] = '\0';
2636 scripting_ops = script_spec__lookup(spec);
2637 if (!scripting_ops) {
2638 fprintf(stderr, "invalid language specifier");
2639 return -1;
2640 }
2641 script++;
2642 } else {
2643 script = str;
2644 ext = strrchr(script, '.');
2645 if (!ext) {
2646 fprintf(stderr, "invalid script extension");
2647 return -1;
2648 }
2649 scripting_ops = script_spec__lookup(++ext);
2650 if (!scripting_ops) {
2651 fprintf(stderr, "invalid script extension");
2652 return -1;
2653 }
2654 }
2655
2656 script_name = strdup(script);
2657
2658 return 0;
2659}
2660
2661static int parse_output_fields(const struct option *opt __maybe_unused,
2662 const char *arg, int unset __maybe_unused)
2663{
2664 char *tok, *strtok_saveptr = NULL;
2665 int i, imax = ARRAY_SIZE(all_output_options);
2666 int j;
2667 int rc = 0;
2668 char *str = strdup(arg);
2669 int type = -1;
2670 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2671
2672 if (!str)
2673 return -ENOMEM;
2674
2675 /* first word can state for which event type the user is specifying
2676 * the fields. If no type exists, the specified fields apply to all
2677 * event types found in the file minus the invalid fields for a type.
2678 */
2679 tok = strchr(str, ':');
2680 if (tok) {
2681 *tok = '\0';
2682 tok++;
2683 if (!strcmp(str, "hw"))
2684 type = PERF_TYPE_HARDWARE;
2685 else if (!strcmp(str, "sw"))
2686 type = PERF_TYPE_SOFTWARE;
2687 else if (!strcmp(str, "trace"))
2688 type = PERF_TYPE_TRACEPOINT;
2689 else if (!strcmp(str, "raw"))
2690 type = PERF_TYPE_RAW;
2691 else if (!strcmp(str, "break"))
2692 type = PERF_TYPE_BREAKPOINT;
2693 else if (!strcmp(str, "synth"))
2694 type = OUTPUT_TYPE_SYNTH;
2695 else {
2696 fprintf(stderr, "Invalid event type in field string.\n");
2697 rc = -EINVAL;
2698 goto out;
2699 }
2700
2701 if (output[type].user_set)
2702 pr_warning("Overriding previous field request for %s events.\n",
2703 event_type(type));
2704
2705 /* Don't override defaults for +- */
2706 if (strchr(tok, '+') || strchr(tok, '-'))
2707 goto parse;
2708
2709 output[type].fields = 0;
2710 output[type].user_set = true;
2711 output[type].wildcard_set = false;
2712
2713 } else {
2714 tok = str;
2715 if (strlen(str) == 0) {
2716 fprintf(stderr,
2717 "Cannot set fields to 'none' for all event types.\n");
2718 rc = -EINVAL;
2719 goto out;
2720 }
2721
2722 /* Don't override defaults for +- */
2723 if (strchr(str, '+') || strchr(str, '-'))
2724 goto parse;
2725
2726 if (output_set_by_user())
2727 pr_warning("Overriding previous field request for all events.\n");
2728
2729 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2730 output[j].fields = 0;
2731 output[j].user_set = true;
2732 output[j].wildcard_set = true;
2733 }
2734 }
2735
2736parse:
2737 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2738 if (*tok == '+') {
2739 if (change == SET)
2740 goto out_badmix;
2741 change = ADD;
2742 tok++;
2743 } else if (*tok == '-') {
2744 if (change == SET)
2745 goto out_badmix;
2746 change = REMOVE;
2747 tok++;
2748 } else {
2749 if (change != SET && change != DEFAULT)
2750 goto out_badmix;
2751 change = SET;
2752 }
2753
2754 for (i = 0; i < imax; ++i) {
2755 if (strcmp(tok, all_output_options[i].str) == 0)
2756 break;
2757 }
2758 if (i == imax && strcmp(tok, "flags") == 0) {
2759 print_flags = change == REMOVE ? false : true;
2760 continue;
2761 }
2762 if (i == imax) {
2763 fprintf(stderr, "Invalid field requested.\n");
2764 rc = -EINVAL;
2765 goto out;
2766 }
2767
2768 if (type == -1) {
2769 /* add user option to all events types for
2770 * which it is valid
2771 */
2772 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2773 if (output[j].invalid_fields & all_output_options[i].field) {
2774 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2775 all_output_options[i].str, event_type(j));
2776 } else {
2777 if (change == REMOVE) {
2778 output[j].fields &= ~all_output_options[i].field;
2779 output[j].user_set_fields &= ~all_output_options[i].field;
2780 output[j].user_unset_fields |= all_output_options[i].field;
2781 } else {
2782 output[j].fields |= all_output_options[i].field;
2783 output[j].user_set_fields |= all_output_options[i].field;
2784 output[j].user_unset_fields &= ~all_output_options[i].field;
2785 }
2786 output[j].user_set = true;
2787 output[j].wildcard_set = true;
2788 }
2789 }
2790 } else {
2791 if (output[type].invalid_fields & all_output_options[i].field) {
2792 fprintf(stderr, "\'%s\' not valid for %s events.\n",
2793 all_output_options[i].str, event_type(type));
2794
2795 rc = -EINVAL;
2796 goto out;
2797 }
2798 if (change == REMOVE)
2799 output[type].fields &= ~all_output_options[i].field;
2800 else
2801 output[type].fields |= all_output_options[i].field;
2802 output[type].user_set = true;
2803 output[type].wildcard_set = true;
2804 }
2805 }
2806
2807 if (type >= 0) {
2808 if (output[type].fields == 0) {
2809 pr_debug("No fields requested for %s type. "
2810 "Events will not be displayed.\n", event_type(type));
2811 }
2812 }
2813 goto out;
2814
2815out_badmix:
2816 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2817 rc = -EINVAL;
2818out:
2819 free(str);
2820 return rc;
2821}
2822
2823#define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
2824 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
2825 if ((lang_dirent->d_type == DT_DIR || \
2826 (lang_dirent->d_type == DT_UNKNOWN && \
2827 is_directory(scripts_path, lang_dirent))) && \
2828 (strcmp(lang_dirent->d_name, ".")) && \
2829 (strcmp(lang_dirent->d_name, "..")))
2830
2831#define for_each_script(lang_path, lang_dir, script_dirent) \
2832 while ((script_dirent = readdir(lang_dir)) != NULL) \
2833 if (script_dirent->d_type != DT_DIR && \
2834 (script_dirent->d_type != DT_UNKNOWN || \
2835 !is_directory(lang_path, script_dirent)))
2836
2837
2838#define RECORD_SUFFIX "-record"
2839#define REPORT_SUFFIX "-report"
2840
2841struct script_desc {
2842 struct list_head node;
2843 char *name;
2844 char *half_liner;
2845 char *args;
2846};
2847
2848static LIST_HEAD(script_descs);
2849
2850static struct script_desc *script_desc__new(const char *name)
2851{
2852 struct script_desc *s = zalloc(sizeof(*s));
2853
2854 if (s != NULL && name)
2855 s->name = strdup(name);
2856
2857 return s;
2858}
2859
2860static void script_desc__delete(struct script_desc *s)
2861{
2862 zfree(&s->name);
2863 zfree(&s->half_liner);
2864 zfree(&s->args);
2865 free(s);
2866}
2867
2868static void script_desc__add(struct script_desc *s)
2869{
2870 list_add_tail(&s->node, &script_descs);
2871}
2872
2873static struct script_desc *script_desc__find(const char *name)
2874{
2875 struct script_desc *s;
2876
2877 list_for_each_entry(s, &script_descs, node)
2878 if (strcasecmp(s->name, name) == 0)
2879 return s;
2880 return NULL;
2881}
2882
2883static struct script_desc *script_desc__findnew(const char *name)
2884{
2885 struct script_desc *s = script_desc__find(name);
2886
2887 if (s)
2888 return s;
2889
2890 s = script_desc__new(name);
2891 if (!s)
2892 return NULL;
2893
2894 script_desc__add(s);
2895
2896 return s;
2897}
2898
2899static const char *ends_with(const char *str, const char *suffix)
2900{
2901 size_t suffix_len = strlen(suffix);
2902 const char *p = str;
2903
2904 if (strlen(str) > suffix_len) {
2905 p = str + strlen(str) - suffix_len;
2906 if (!strncmp(p, suffix, suffix_len))
2907 return p;
2908 }
2909
2910 return NULL;
2911}
2912
2913static int read_script_info(struct script_desc *desc, const char *filename)
2914{
2915 char line[BUFSIZ], *p;
2916 FILE *fp;
2917
2918 fp = fopen(filename, "r");
2919 if (!fp)
2920 return -1;
2921
2922 while (fgets(line, sizeof(line), fp)) {
2923 p = skip_spaces(line);
2924 if (strlen(p) == 0)
2925 continue;
2926 if (*p != '#')
2927 continue;
2928 p++;
2929 if (strlen(p) && *p == '!')
2930 continue;
2931
2932 p = skip_spaces(p);
2933 if (strlen(p) && p[strlen(p) - 1] == '\n')
2934 p[strlen(p) - 1] = '\0';
2935
2936 if (!strncmp(p, "description:", strlen("description:"))) {
2937 p += strlen("description:");
2938 desc->half_liner = strdup(skip_spaces(p));
2939 continue;
2940 }
2941
2942 if (!strncmp(p, "args:", strlen("args:"))) {
2943 p += strlen("args:");
2944 desc->args = strdup(skip_spaces(p));
2945 continue;
2946 }
2947 }
2948
2949 fclose(fp);
2950
2951 return 0;
2952}
2953
2954static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2955{
2956 char *script_root, *str;
2957
2958 script_root = strdup(script_dirent->d_name);
2959 if (!script_root)
2960 return NULL;
2961
2962 str = (char *)ends_with(script_root, suffix);
2963 if (!str) {
2964 free(script_root);
2965 return NULL;
2966 }
2967
2968 *str = '\0';
2969 return script_root;
2970}
2971
2972static int list_available_scripts(const struct option *opt __maybe_unused,
2973 const char *s __maybe_unused,
2974 int unset __maybe_unused)
2975{
2976 struct dirent *script_dirent, *lang_dirent;
2977 char scripts_path[MAXPATHLEN];
2978 DIR *scripts_dir, *lang_dir;
2979 char script_path[MAXPATHLEN];
2980 char lang_path[MAXPATHLEN];
2981 struct script_desc *desc;
2982 char first_half[BUFSIZ];
2983 char *script_root;
2984
2985 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2986
2987 scripts_dir = opendir(scripts_path);
2988 if (!scripts_dir) {
2989 fprintf(stdout,
2990 "open(%s) failed.\n"
2991 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2992 scripts_path);
2993 exit(-1);
2994 }
2995
2996 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2997 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2998 lang_dirent->d_name);
2999 lang_dir = opendir(lang_path);
3000 if (!lang_dir)
3001 continue;
3002
3003 for_each_script(lang_path, lang_dir, script_dirent) {
3004 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3005 if (script_root) {
3006 desc = script_desc__findnew(script_root);
3007 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3008 lang_path, script_dirent->d_name);
3009 read_script_info(desc, script_path);
3010 free(script_root);
3011 }
3012 }
3013 }
3014
3015 fprintf(stdout, "List of available trace scripts:\n");
3016 list_for_each_entry(desc, &script_descs, node) {
3017 sprintf(first_half, "%s %s", desc->name,
3018 desc->args ? desc->args : "");
3019 fprintf(stdout, " %-36s %s\n", first_half,
3020 desc->half_liner ? desc->half_liner : "");
3021 }
3022
3023 exit(0);
3024}
3025
3026/*
3027 * Some scripts specify the required events in their "xxx-record" file,
3028 * this function will check if the events in perf.data match those
3029 * mentioned in the "xxx-record".
3030 *
3031 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3032 * which is covered well now. And new parsing code should be added to
3033 * cover the future complexing formats like event groups etc.
3034 */
3035static int check_ev_match(char *dir_name, char *scriptname,
3036 struct perf_session *session)
3037{
3038 char filename[MAXPATHLEN], evname[128];
3039 char line[BUFSIZ], *p;
3040 struct evsel *pos;
3041 int match, len;
3042 FILE *fp;
3043
3044 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3045
3046 fp = fopen(filename, "r");
3047 if (!fp)
3048 return -1;
3049
3050 while (fgets(line, sizeof(line), fp)) {
3051 p = skip_spaces(line);
3052 if (*p == '#')
3053 continue;
3054
3055 while (strlen(p)) {
3056 p = strstr(p, "-e");
3057 if (!p)
3058 break;
3059
3060 p += 2;
3061 p = skip_spaces(p);
3062 len = strcspn(p, " \t");
3063 if (!len)
3064 break;
3065
3066 snprintf(evname, len + 1, "%s", p);
3067
3068 match = 0;
3069 evlist__for_each_entry(session->evlist, pos) {
3070 if (!strcmp(evsel__name(pos), evname)) {
3071 match = 1;
3072 break;
3073 }
3074 }
3075
3076 if (!match) {
3077 fclose(fp);
3078 return -1;
3079 }
3080 }
3081 }
3082
3083 fclose(fp);
3084 return 0;
3085}
3086
3087/*
3088 * Return -1 if none is found, otherwise the actual scripts number.
3089 *
3090 * Currently the only user of this function is the script browser, which
3091 * will list all statically runnable scripts, select one, execute it and
3092 * show the output in a perf browser.
3093 */
3094int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3095 int pathlen)
3096{
3097 struct dirent *script_dirent, *lang_dirent;
3098 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3099 DIR *scripts_dir, *lang_dir;
3100 struct perf_session *session;
3101 struct perf_data data = {
3102 .path = input_name,
3103 .mode = PERF_DATA_MODE_READ,
3104 };
3105 char *temp;
3106 int i = 0;
3107
3108 session = perf_session__new(&data, false, NULL);
3109 if (IS_ERR(session))
3110 return PTR_ERR(session);
3111
3112 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3113
3114 scripts_dir = opendir(scripts_path);
3115 if (!scripts_dir) {
3116 perf_session__delete(session);
3117 return -1;
3118 }
3119
3120 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3121 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3122 lang_dirent->d_name);
3123#ifndef HAVE_LIBPERL_SUPPORT
3124 if (strstr(lang_path, "perl"))
3125 continue;
3126#endif
3127#ifndef HAVE_LIBPYTHON_SUPPORT
3128 if (strstr(lang_path, "python"))
3129 continue;
3130#endif
3131
3132 lang_dir = opendir(lang_path);
3133 if (!lang_dir)
3134 continue;
3135
3136 for_each_script(lang_path, lang_dir, script_dirent) {
3137 /* Skip those real time scripts: xxxtop.p[yl] */
3138 if (strstr(script_dirent->d_name, "top."))
3139 continue;
3140 if (i >= num)
3141 break;
3142 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3143 lang_path,
3144 script_dirent->d_name);
3145 temp = strchr(script_dirent->d_name, '.');
3146 snprintf(scripts_array[i],
3147 (temp - script_dirent->d_name) + 1,
3148 "%s", script_dirent->d_name);
3149
3150 if (check_ev_match(lang_path,
3151 scripts_array[i], session))
3152 continue;
3153
3154 i++;
3155 }
3156 closedir(lang_dir);
3157 }
3158
3159 closedir(scripts_dir);
3160 perf_session__delete(session);
3161 return i;
3162}
3163
3164static char *get_script_path(const char *script_root, const char *suffix)
3165{
3166 struct dirent *script_dirent, *lang_dirent;
3167 char scripts_path[MAXPATHLEN];
3168 char script_path[MAXPATHLEN];
3169 DIR *scripts_dir, *lang_dir;
3170 char lang_path[MAXPATHLEN];
3171 char *__script_root;
3172
3173 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3174
3175 scripts_dir = opendir(scripts_path);
3176 if (!scripts_dir)
3177 return NULL;
3178
3179 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3180 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3181 lang_dirent->d_name);
3182 lang_dir = opendir(lang_path);
3183 if (!lang_dir)
3184 continue;
3185
3186 for_each_script(lang_path, lang_dir, script_dirent) {
3187 __script_root = get_script_root(script_dirent, suffix);
3188 if (__script_root && !strcmp(script_root, __script_root)) {
3189 free(__script_root);
3190 closedir(scripts_dir);
3191 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3192 lang_path, script_dirent->d_name);
3193 closedir(lang_dir);
3194 return strdup(script_path);
3195 }
3196 free(__script_root);
3197 }
3198 closedir(lang_dir);
3199 }
3200 closedir(scripts_dir);
3201
3202 return NULL;
3203}
3204
3205static bool is_top_script(const char *script_path)
3206{
3207 return ends_with(script_path, "top") == NULL ? false : true;
3208}
3209
3210static int has_required_arg(char *script_path)
3211{
3212 struct script_desc *desc;
3213 int n_args = 0;
3214 char *p;
3215
3216 desc = script_desc__new(NULL);
3217
3218 if (read_script_info(desc, script_path))
3219 goto out;
3220
3221 if (!desc->args)
3222 goto out;
3223
3224 for (p = desc->args; *p; p++)
3225 if (*p == '<')
3226 n_args++;
3227out:
3228 script_desc__delete(desc);
3229
3230 return n_args;
3231}
3232
3233static int have_cmd(int argc, const char **argv)
3234{
3235 char **__argv = malloc(sizeof(const char *) * argc);
3236
3237 if (!__argv) {
3238 pr_err("malloc failed\n");
3239 return -1;
3240 }
3241
3242 memcpy(__argv, argv, sizeof(const char *) * argc);
3243 argc = parse_options(argc, (const char **)__argv, record_options,
3244 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3245 free(__argv);
3246
3247 system_wide = (argc == 0);
3248
3249 return 0;
3250}
3251
3252static void script__setup_sample_type(struct perf_script *script)
3253{
3254 struct perf_session *session = script->session;
3255 u64 sample_type = evlist__combined_sample_type(session->evlist);
3256
3257 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3258 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3259 (sample_type & PERF_SAMPLE_STACK_USER)) {
3260 callchain_param.record_mode = CALLCHAIN_DWARF;
3261 dwarf_callchain_users = true;
3262 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3263 callchain_param.record_mode = CALLCHAIN_LBR;
3264 else
3265 callchain_param.record_mode = CALLCHAIN_FP;
3266 }
3267
3268 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3269 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3270 "Please apply --call-graph lbr when recording.\n");
3271 script->stitch_lbr = false;
3272 }
3273}
3274
3275static int process_stat_round_event(struct perf_session *session,
3276 union perf_event *event)
3277{
3278 struct perf_record_stat_round *round = &event->stat_round;
3279 struct evsel *counter;
3280
3281 evlist__for_each_entry(session->evlist, counter) {
3282 perf_stat_process_counter(&stat_config, counter);
3283 process_stat(counter, round->time);
3284 }
3285
3286 process_stat_interval(round->time);
3287 return 0;
3288}
3289
3290static int process_stat_config_event(struct perf_session *session __maybe_unused,
3291 union perf_event *event)
3292{
3293 perf_event__read_stat_config(&stat_config, &event->stat_config);
3294 return 0;
3295}
3296
3297static int set_maps(struct perf_script *script)
3298{
3299 struct evlist *evlist = script->session->evlist;
3300
3301 if (!script->cpus || !script->threads)
3302 return 0;
3303
3304 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3305 return -EINVAL;
3306
3307 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3308
3309 if (perf_evlist__alloc_stats(evlist, true))
3310 return -ENOMEM;
3311
3312 script->allocated = true;
3313 return 0;
3314}
3315
3316static
3317int process_thread_map_event(struct perf_session *session,
3318 union perf_event *event)
3319{
3320 struct perf_tool *tool = session->tool;
3321 struct perf_script *script = container_of(tool, struct perf_script, tool);
3322
3323 if (script->threads) {
3324 pr_warning("Extra thread map event, ignoring.\n");
3325 return 0;
3326 }
3327
3328 script->threads = thread_map__new_event(&event->thread_map);
3329 if (!script->threads)
3330 return -ENOMEM;
3331
3332 return set_maps(script);
3333}
3334
3335static
3336int process_cpu_map_event(struct perf_session *session,
3337 union perf_event *event)
3338{
3339 struct perf_tool *tool = session->tool;
3340 struct perf_script *script = container_of(tool, struct perf_script, tool);
3341
3342 if (script->cpus) {
3343 pr_warning("Extra cpu map event, ignoring.\n");
3344 return 0;
3345 }
3346
3347 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3348 if (!script->cpus)
3349 return -ENOMEM;
3350
3351 return set_maps(script);
3352}
3353
3354static int process_feature_event(struct perf_session *session,
3355 union perf_event *event)
3356{
3357 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3358 return perf_event__process_feature(session, event);
3359 return 0;
3360}
3361
3362#ifdef HAVE_AUXTRACE_SUPPORT
3363static int perf_script__process_auxtrace_info(struct perf_session *session,
3364 union perf_event *event)
3365{
3366 struct perf_tool *tool = session->tool;
3367
3368 int ret = perf_event__process_auxtrace_info(session, event);
3369
3370 if (ret == 0) {
3371 struct perf_script *script = container_of(tool, struct perf_script, tool);
3372
3373 ret = perf_script__setup_per_event_dump(script);
3374 }
3375
3376 return ret;
3377}
3378#else
3379#define perf_script__process_auxtrace_info 0
3380#endif
3381
3382static int parse_insn_trace(const struct option *opt __maybe_unused,
3383 const char *str __maybe_unused,
3384 int unset __maybe_unused)
3385{
3386 parse_output_fields(NULL, "+insn,-event,-period", 0);
3387 itrace_parse_synth_opts(opt, "i0ns", 0);
3388 symbol_conf.nanosecs = true;
3389 return 0;
3390}
3391
3392static int parse_xed(const struct option *opt __maybe_unused,
3393 const char *str __maybe_unused,
3394 int unset __maybe_unused)
3395{
3396 if (isatty(1))
3397 force_pager("xed -F insn: -A -64 | less");
3398 else
3399 force_pager("xed -F insn: -A -64");
3400 return 0;
3401}
3402
3403static int parse_call_trace(const struct option *opt __maybe_unused,
3404 const char *str __maybe_unused,
3405 int unset __maybe_unused)
3406{
3407 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3408 itrace_parse_synth_opts(opt, "cewp", 0);
3409 symbol_conf.nanosecs = true;
3410 symbol_conf.pad_output_len_dso = 50;
3411 return 0;
3412}
3413
3414static int parse_callret_trace(const struct option *opt __maybe_unused,
3415 const char *str __maybe_unused,
3416 int unset __maybe_unused)
3417{
3418 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3419 itrace_parse_synth_opts(opt, "crewp", 0);
3420 symbol_conf.nanosecs = true;
3421 return 0;
3422}
3423
3424int cmd_script(int argc, const char **argv)
3425{
3426 bool show_full_info = false;
3427 bool header = false;
3428 bool header_only = false;
3429 bool script_started = false;
3430 char *rec_script_path = NULL;
3431 char *rep_script_path = NULL;
3432 struct perf_session *session;
3433 struct itrace_synth_opts itrace_synth_opts = {
3434 .set = false,
3435 .default_no_sample = true,
3436 };
3437 struct utsname uts;
3438 char *script_path = NULL;
3439 const char **__argv;
3440 int i, j, err = 0;
3441 struct perf_script script = {
3442 .tool = {
3443 .sample = process_sample_event,
3444 .mmap = perf_event__process_mmap,
3445 .mmap2 = perf_event__process_mmap2,
3446 .comm = perf_event__process_comm,
3447 .namespaces = perf_event__process_namespaces,
3448 .cgroup = perf_event__process_cgroup,
3449 .exit = perf_event__process_exit,
3450 .fork = perf_event__process_fork,
3451 .attr = process_attr,
3452 .event_update = perf_event__process_event_update,
3453 .tracing_data = perf_event__process_tracing_data,
3454 .feature = process_feature_event,
3455 .build_id = perf_event__process_build_id,
3456 .id_index = perf_event__process_id_index,
3457 .auxtrace_info = perf_script__process_auxtrace_info,
3458 .auxtrace = perf_event__process_auxtrace,
3459 .auxtrace_error = perf_event__process_auxtrace_error,
3460 .stat = perf_event__process_stat_event,
3461 .stat_round = process_stat_round_event,
3462 .stat_config = process_stat_config_event,
3463 .thread_map = process_thread_map_event,
3464 .cpu_map = process_cpu_map_event,
3465 .ordered_events = true,
3466 .ordering_requires_timestamps = true,
3467 },
3468 };
3469 struct perf_data data = {
3470 .mode = PERF_DATA_MODE_READ,
3471 };
3472 const struct option options[] = {
3473 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3474 "dump raw trace in ASCII"),
3475 OPT_INCR('v', "verbose", &verbose,
3476 "be more verbose (show symbol address, etc)"),
3477 OPT_BOOLEAN('L', "Latency", &latency_format,
3478 "show latency attributes (irqs/preemption disabled, etc)"),
3479 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3480 list_available_scripts),
3481 OPT_CALLBACK('s', "script", NULL, "name",
3482 "script file name (lang:script name, script name, or *)",
3483 parse_scriptname),
3484 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3485 "generate perf-script.xx script in specified language"),
3486 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3487 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3488 "do various checks like samples ordering and lost events"),
3489 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3490 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3491 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3492 "file", "vmlinux pathname"),
3493 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3494 "file", "kallsyms pathname"),
3495 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3496 "When printing symbols do not display call chain"),
3497 OPT_CALLBACK(0, "symfs", NULL, "directory",
3498 "Look for files with symbols relative to this directory",
3499 symbol__config_symfs),
3500 OPT_CALLBACK('F', "fields", NULL, "str",
3501 "comma separated output fields prepend with 'type:'. "
3502 "+field to add and -field to remove."
3503 "Valid types: hw,sw,trace,raw,synth. "
3504 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3505 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3506 "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3507 "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod",
3508 parse_output_fields),
3509 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3510 "system-wide collection from all CPUs"),
3511 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3512 "only consider these symbols"),
3513 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3514 "Decode instructions from itrace", parse_insn_trace),
3515 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3516 "Run xed disassembler on output", parse_xed),
3517 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3518 "Decode calls from from itrace", parse_call_trace),
3519 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3520 "Decode calls and returns from itrace", parse_callret_trace),
3521 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3522 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3523 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3524 "Stop display of callgraph at these symbols"),
3525 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3526 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3527 "only display events for these comms"),
3528 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3529 "only consider symbols in these pids"),
3530 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3531 "only consider symbols in these tids"),
3532 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3533 "Set the maximum stack depth when parsing the callchain, "
3534 "anything beyond the specified depth will be ignored. "
3535 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3536 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3537 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3538 OPT_BOOLEAN('I', "show-info", &show_full_info,
3539 "display extended information from perf.data file"),
3540 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3541 "Show the path of [kernel.kallsyms]"),
3542 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3543 "Show the fork/comm/exit events"),
3544 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3545 "Show the mmap events"),
3546 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3547 "Show context switch events (if recorded)"),
3548 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3549 "Show namespace events (if recorded)"),
3550 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3551 "Show cgroup events (if recorded)"),
3552 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3553 "Show lost events (if recorded)"),
3554 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3555 "Show round events (if recorded)"),
3556 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3557 "Show bpf related events (if recorded)"),
3558 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3559 "Show text poke related events (if recorded)"),
3560 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3561 "Dump trace output to files named by the monitored events"),
3562 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3563 OPT_INTEGER(0, "max-blocks", &max_blocks,
3564 "Maximum number of code blocks to dump with brstackinsn"),
3565 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3566 "Use 9 decimal places when displaying time"),
3567 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3568 "Instruction Tracing options\n" ITRACE_HELP,
3569 itrace_parse_synth_opts),
3570 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3571 "Show full source file name path for source lines"),
3572 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3573 "Enable symbol demangling"),
3574 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3575 "Enable kernel symbol demangling"),
3576 OPT_STRING(0, "time", &script.time_str, "str",
3577 "Time span of interest (start,stop)"),
3578 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3579 "Show inline function"),
3580 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3581 "guest mount directory under which every guest os"
3582 " instance has a subdir"),
3583 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3584 "file", "file saving guest os vmlinux"),
3585 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3586 "file", "file saving guest os /proc/kallsyms"),
3587 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3588 "file", "file saving guest os /proc/modules"),
3589 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3590 "Enable LBR callgraph stitching approach"),
3591 OPTS_EVSWITCH(&script.evswitch),
3592 OPT_END()
3593 };
3594 const char * const script_subcommands[] = { "record", "report", NULL };
3595 const char *script_usage[] = {
3596 "perf script [<options>]",
3597 "perf script [<options>] record <script> [<record-options>] <command>",
3598 "perf script [<options>] report <script> [script-args]",
3599 "perf script [<options>] <script> [<record-options>] <command>",
3600 "perf script [<options>] <top-script> [script-args]",
3601 NULL
3602 };
3603
3604 perf_set_singlethreaded();
3605
3606 setup_scripting();
3607
3608 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3609 PARSE_OPT_STOP_AT_NON_OPTION);
3610
3611 if (symbol_conf.guestmount ||
3612 symbol_conf.default_guest_vmlinux_name ||
3613 symbol_conf.default_guest_kallsyms ||
3614 symbol_conf.default_guest_modules) {
3615 /*
3616 * Enable guest sample processing.
3617 */
3618 perf_guest = true;
3619 }
3620
3621 data.path = input_name;
3622 data.force = symbol_conf.force;
3623
3624 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3625 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3626 if (!rec_script_path)
3627 return cmd_record(argc, argv);
3628 }
3629
3630 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3631 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3632 if (!rep_script_path) {
3633 fprintf(stderr,
3634 "Please specify a valid report script"
3635 "(see 'perf script -l' for listing)\n");
3636 return -1;
3637 }
3638 }
3639
3640 if (reltime && deltatime) {
3641 fprintf(stderr,
3642 "reltime and deltatime - the two don't get along well. "
3643 "Please limit to --reltime or --deltatime.\n");
3644 return -1;
3645 }
3646
3647 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3648 itrace_synth_opts.callchain_sz > scripting_max_stack)
3649 scripting_max_stack = itrace_synth_opts.callchain_sz;
3650
3651 /* make sure PERF_EXEC_PATH is set for scripts */
3652 set_argv_exec_path(get_argv_exec_path());
3653
3654 if (argc && !script_name && !rec_script_path && !rep_script_path) {
3655 int live_pipe[2];
3656 int rep_args;
3657 pid_t pid;
3658
3659 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3660 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3661
3662 if (!rec_script_path && !rep_script_path) {
3663 usage_with_options_msg(script_usage, options,
3664 "Couldn't find script `%s'\n\n See perf"
3665 " script -l for available scripts.\n", argv[0]);
3666 }
3667
3668 if (is_top_script(argv[0])) {
3669 rep_args = argc - 1;
3670 } else {
3671 int rec_args;
3672
3673 rep_args = has_required_arg(rep_script_path);
3674 rec_args = (argc - 1) - rep_args;
3675 if (rec_args < 0) {
3676 usage_with_options_msg(script_usage, options,
3677 "`%s' script requires options."
3678 "\n\n See perf script -l for available "
3679 "scripts and options.\n", argv[0]);
3680 }
3681 }
3682
3683 if (pipe(live_pipe) < 0) {
3684 perror("failed to create pipe");
3685 return -1;
3686 }
3687
3688 pid = fork();
3689 if (pid < 0) {
3690 perror("failed to fork");
3691 return -1;
3692 }
3693
3694 if (!pid) {
3695 j = 0;
3696
3697 dup2(live_pipe[1], 1);
3698 close(live_pipe[0]);
3699
3700 if (is_top_script(argv[0])) {
3701 system_wide = true;
3702 } else if (!system_wide) {
3703 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3704 err = -1;
3705 goto out;
3706 }
3707 }
3708
3709 __argv = malloc((argc + 6) * sizeof(const char *));
3710 if (!__argv) {
3711 pr_err("malloc failed\n");
3712 err = -ENOMEM;
3713 goto out;
3714 }
3715
3716 __argv[j++] = "/bin/sh";
3717 __argv[j++] = rec_script_path;
3718 if (system_wide)
3719 __argv[j++] = "-a";
3720 __argv[j++] = "-q";
3721 __argv[j++] = "-o";
3722 __argv[j++] = "-";
3723 for (i = rep_args + 1; i < argc; i++)
3724 __argv[j++] = argv[i];
3725 __argv[j++] = NULL;
3726
3727 execvp("/bin/sh", (char **)__argv);
3728 free(__argv);
3729 exit(-1);
3730 }
3731
3732 dup2(live_pipe[0], 0);
3733 close(live_pipe[1]);
3734
3735 __argv = malloc((argc + 4) * sizeof(const char *));
3736 if (!__argv) {
3737 pr_err("malloc failed\n");
3738 err = -ENOMEM;
3739 goto out;
3740 }
3741
3742 j = 0;
3743 __argv[j++] = "/bin/sh";
3744 __argv[j++] = rep_script_path;
3745 for (i = 1; i < rep_args + 1; i++)
3746 __argv[j++] = argv[i];
3747 __argv[j++] = "-i";
3748 __argv[j++] = "-";
3749 __argv[j++] = NULL;
3750
3751 execvp("/bin/sh", (char **)__argv);
3752 free(__argv);
3753 exit(-1);
3754 }
3755
3756 if (rec_script_path)
3757 script_path = rec_script_path;
3758 if (rep_script_path)
3759 script_path = rep_script_path;
3760
3761 if (script_path) {
3762 j = 0;
3763
3764 if (!rec_script_path)
3765 system_wide = false;
3766 else if (!system_wide) {
3767 if (have_cmd(argc - 1, &argv[1]) != 0) {
3768 err = -1;
3769 goto out;
3770 }
3771 }
3772
3773 __argv = malloc((argc + 2) * sizeof(const char *));
3774 if (!__argv) {
3775 pr_err("malloc failed\n");
3776 err = -ENOMEM;
3777 goto out;
3778 }
3779
3780 __argv[j++] = "/bin/sh";
3781 __argv[j++] = script_path;
3782 if (system_wide)
3783 __argv[j++] = "-a";
3784 for (i = 2; i < argc; i++)
3785 __argv[j++] = argv[i];
3786 __argv[j++] = NULL;
3787
3788 execvp("/bin/sh", (char **)__argv);
3789 free(__argv);
3790 exit(-1);
3791 }
3792
3793 if (!script_name) {
3794 setup_pager();
3795 use_browser = 0;
3796 }
3797
3798 session = perf_session__new(&data, false, &script.tool);
3799 if (IS_ERR(session))
3800 return PTR_ERR(session);
3801
3802 if (header || header_only) {
3803 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3804 perf_session__fprintf_info(session, stdout, show_full_info);
3805 if (header_only)
3806 goto out_delete;
3807 }
3808 if (show_full_info)
3809 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3810
3811 if (symbol__init(&session->header.env) < 0)
3812 goto out_delete;
3813
3814 uname(&uts);
3815 if (data.is_pipe || /* assume pipe_mode indicates native_arch */
3816 !strcmp(uts.machine, session->header.env.arch) ||
3817 (!strcmp(uts.machine, "x86_64") &&
3818 !strcmp(session->header.env.arch, "i386")))
3819 native_arch = true;
3820
3821 script.session = session;
3822 script__setup_sample_type(&script);
3823
3824 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3825 symbol_conf.graph_function)
3826 itrace_synth_opts.thread_stack = true;
3827
3828 session->itrace_synth_opts = &itrace_synth_opts;
3829
3830 if (cpu_list) {
3831 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3832 if (err < 0)
3833 goto out_delete;
3834 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3835 }
3836
3837 if (!no_callchain)
3838 symbol_conf.use_callchain = true;
3839 else
3840 symbol_conf.use_callchain = false;
3841
3842 if (session->tevent.pevent &&
3843 tep_set_function_resolver(session->tevent.pevent,
3844 machine__resolve_kernel_addr,
3845 &session->machines.host) < 0) {
3846 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3847 err = -1;
3848 goto out_delete;
3849 }
3850
3851 if (generate_script_lang) {
3852 struct stat perf_stat;
3853 int input;
3854
3855 if (output_set_by_user()) {
3856 fprintf(stderr,
3857 "custom fields not supported for generated scripts");
3858 err = -EINVAL;
3859 goto out_delete;
3860 }
3861
3862 input = open(data.path, O_RDONLY); /* input_name */
3863 if (input < 0) {
3864 err = -errno;
3865 perror("failed to open file");
3866 goto out_delete;
3867 }
3868
3869 err = fstat(input, &perf_stat);
3870 if (err < 0) {
3871 perror("failed to stat file");
3872 goto out_delete;
3873 }
3874
3875 if (!perf_stat.st_size) {
3876 fprintf(stderr, "zero-sized file, nothing to do!\n");
3877 goto out_delete;
3878 }
3879
3880 scripting_ops = script_spec__lookup(generate_script_lang);
3881 if (!scripting_ops) {
3882 fprintf(stderr, "invalid language specifier");
3883 err = -ENOENT;
3884 goto out_delete;
3885 }
3886
3887 err = scripting_ops->generate_script(session->tevent.pevent,
3888 "perf-script");
3889 goto out_delete;
3890 }
3891
3892 if (script_name) {
3893 err = scripting_ops->start_script(script_name, argc, argv);
3894 if (err)
3895 goto out_delete;
3896 pr_debug("perf script started with script %s\n\n", script_name);
3897 script_started = true;
3898 }
3899
3900
3901 err = perf_session__check_output_opt(session);
3902 if (err < 0)
3903 goto out_delete;
3904
3905 if (script.time_str) {
3906 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
3907 &script.ptime_range,
3908 &script.range_size,
3909 &script.range_num,
3910 reltime);
3911 if (err < 0)
3912 goto out_delete;
3913
3914 itrace_synth_opts__set_time_range(&itrace_synth_opts,
3915 script.ptime_range,
3916 script.range_num);
3917 }
3918
3919 err = evswitch__init(&script.evswitch, session->evlist, stderr);
3920 if (err)
3921 goto out_delete;
3922
3923 if (zstd_init(&(session->zstd_data), 0) < 0)
3924 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
3925
3926 err = __cmd_script(&script);
3927
3928 flush_scripting();
3929
3930out_delete:
3931 if (script.ptime_range) {
3932 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3933 zfree(&script.ptime_range);
3934 }
3935
3936 perf_evlist__free_stats(session->evlist);
3937 perf_session__delete(session);
3938
3939 if (script_started)
3940 cleanup_scripting();
3941out:
3942 return err;
3943}