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