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