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#include "builtin.h"
2
3#include "perf.h"
4#include "util/cache.h"
5#include "util/debug.h"
6#include "util/exec_cmd.h"
7#include "util/header.h"
8#include "util/parse-options.h"
9#include "util/session.h"
10#include "util/symbol.h"
11#include "util/thread.h"
12#include "util/trace-event.h"
13#include "util/util.h"
14#include "util/evlist.h"
15#include "util/evsel.h"
16#include <linux/bitmap.h>
17
18static char const *script_name;
19static char const *generate_script_lang;
20static bool debug_mode;
21static u64 last_timestamp;
22static u64 nr_unordered;
23extern const struct option record_options[];
24static bool no_callchain;
25static const char *cpu_list;
26static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
27
28enum perf_output_field {
29 PERF_OUTPUT_COMM = 1U << 0,
30 PERF_OUTPUT_TID = 1U << 1,
31 PERF_OUTPUT_PID = 1U << 2,
32 PERF_OUTPUT_TIME = 1U << 3,
33 PERF_OUTPUT_CPU = 1U << 4,
34 PERF_OUTPUT_EVNAME = 1U << 5,
35 PERF_OUTPUT_TRACE = 1U << 6,
36 PERF_OUTPUT_IP = 1U << 7,
37 PERF_OUTPUT_SYM = 1U << 8,
38 PERF_OUTPUT_DSO = 1U << 9,
39 PERF_OUTPUT_ADDR = 1U << 10,
40};
41
42struct output_option {
43 const char *str;
44 enum perf_output_field field;
45} all_output_options[] = {
46 {.str = "comm", .field = PERF_OUTPUT_COMM},
47 {.str = "tid", .field = PERF_OUTPUT_TID},
48 {.str = "pid", .field = PERF_OUTPUT_PID},
49 {.str = "time", .field = PERF_OUTPUT_TIME},
50 {.str = "cpu", .field = PERF_OUTPUT_CPU},
51 {.str = "event", .field = PERF_OUTPUT_EVNAME},
52 {.str = "trace", .field = PERF_OUTPUT_TRACE},
53 {.str = "ip", .field = PERF_OUTPUT_IP},
54 {.str = "sym", .field = PERF_OUTPUT_SYM},
55 {.str = "dso", .field = PERF_OUTPUT_DSO},
56 {.str = "addr", .field = PERF_OUTPUT_ADDR},
57};
58
59/* default set to maintain compatibility with current format */
60static struct {
61 bool user_set;
62 bool wildcard_set;
63 u64 fields;
64 u64 invalid_fields;
65} output[PERF_TYPE_MAX] = {
66
67 [PERF_TYPE_HARDWARE] = {
68 .user_set = false,
69
70 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
71 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
72 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
73 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
74
75 .invalid_fields = PERF_OUTPUT_TRACE,
76 },
77
78 [PERF_TYPE_SOFTWARE] = {
79 .user_set = false,
80
81 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
82 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
83 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
84 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
85
86 .invalid_fields = PERF_OUTPUT_TRACE,
87 },
88
89 [PERF_TYPE_TRACEPOINT] = {
90 .user_set = false,
91
92 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
93 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
94 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
95 },
96
97 [PERF_TYPE_RAW] = {
98 .user_set = false,
99
100 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
101 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
102 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
103 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
104
105 .invalid_fields = PERF_OUTPUT_TRACE,
106 },
107};
108
109static bool output_set_by_user(void)
110{
111 int j;
112 for (j = 0; j < PERF_TYPE_MAX; ++j) {
113 if (output[j].user_set)
114 return true;
115 }
116 return false;
117}
118
119static const char *output_field2str(enum perf_output_field field)
120{
121 int i, imax = ARRAY_SIZE(all_output_options);
122 const char *str = "";
123
124 for (i = 0; i < imax; ++i) {
125 if (all_output_options[i].field == field) {
126 str = all_output_options[i].str;
127 break;
128 }
129 }
130 return str;
131}
132
133#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
134
135static int perf_event_attr__check_stype(struct perf_event_attr *attr,
136 u64 sample_type, const char *sample_msg,
137 enum perf_output_field field)
138{
139 int type = attr->type;
140 const char *evname;
141
142 if (attr->sample_type & sample_type)
143 return 0;
144
145 if (output[type].user_set) {
146 evname = __event_name(attr->type, attr->config);
147 pr_err("Samples for '%s' event do not have %s attribute set. "
148 "Cannot print '%s' field.\n",
149 evname, sample_msg, output_field2str(field));
150 return -1;
151 }
152
153 /* user did not ask for it explicitly so remove from the default list */
154 output[type].fields &= ~field;
155 evname = __event_name(attr->type, attr->config);
156 pr_debug("Samples for '%s' event do not have %s attribute set. "
157 "Skipping '%s' field.\n",
158 evname, sample_msg, output_field2str(field));
159
160 return 0;
161}
162
163static int perf_evsel__check_attr(struct perf_evsel *evsel,
164 struct perf_session *session)
165{
166 struct perf_event_attr *attr = &evsel->attr;
167
168 if (PRINT_FIELD(TRACE) &&
169 !perf_session__has_traces(session, "record -R"))
170 return -EINVAL;
171
172 if (PRINT_FIELD(IP)) {
173 if (perf_event_attr__check_stype(attr, PERF_SAMPLE_IP, "IP",
174 PERF_OUTPUT_IP))
175 return -EINVAL;
176
177 if (!no_callchain &&
178 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
179 symbol_conf.use_callchain = false;
180 }
181
182 if (PRINT_FIELD(ADDR) &&
183 perf_event_attr__check_stype(attr, PERF_SAMPLE_ADDR, "ADDR",
184 PERF_OUTPUT_ADDR))
185 return -EINVAL;
186
187 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
188 pr_err("Display of symbols requested but neither sample IP nor "
189 "sample address\nis selected. Hence, no addresses to convert "
190 "to symbols.\n");
191 return -EINVAL;
192 }
193 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
194 pr_err("Display of DSO requested but neither sample IP nor "
195 "sample address\nis selected. Hence, no addresses to convert "
196 "to DSO.\n");
197 return -EINVAL;
198 }
199
200 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
201 perf_event_attr__check_stype(attr, PERF_SAMPLE_TID, "TID",
202 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
203 return -EINVAL;
204
205 if (PRINT_FIELD(TIME) &&
206 perf_event_attr__check_stype(attr, PERF_SAMPLE_TIME, "TIME",
207 PERF_OUTPUT_TIME))
208 return -EINVAL;
209
210 if (PRINT_FIELD(CPU) &&
211 perf_event_attr__check_stype(attr, PERF_SAMPLE_CPU, "CPU",
212 PERF_OUTPUT_CPU))
213 return -EINVAL;
214
215 return 0;
216}
217
218/*
219 * verify all user requested events exist and the samples
220 * have the expected data
221 */
222static int perf_session__check_output_opt(struct perf_session *session)
223{
224 int j;
225 struct perf_evsel *evsel;
226
227 for (j = 0; j < PERF_TYPE_MAX; ++j) {
228 evsel = perf_session__find_first_evtype(session, j);
229
230 /*
231 * even if fields is set to 0 (ie., show nothing) event must
232 * exist if user explicitly includes it on the command line
233 */
234 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
235 pr_err("%s events do not exist. "
236 "Remove corresponding -f option to proceed.\n",
237 event_type(j));
238 return -1;
239 }
240
241 if (evsel && output[j].fields &&
242 perf_evsel__check_attr(evsel, session))
243 return -1;
244 }
245
246 return 0;
247}
248
249static void print_sample_start(struct perf_sample *sample,
250 struct thread *thread,
251 struct perf_event_attr *attr)
252{
253 int type;
254 struct event *event;
255 const char *evname = NULL;
256 unsigned long secs;
257 unsigned long usecs;
258 unsigned long long nsecs;
259
260 if (PRINT_FIELD(COMM)) {
261 if (latency_format)
262 printf("%8.8s ", thread->comm);
263 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
264 printf("%s ", thread->comm);
265 else
266 printf("%16s ", thread->comm);
267 }
268
269 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
270 printf("%5d/%-5d ", sample->pid, sample->tid);
271 else if (PRINT_FIELD(PID))
272 printf("%5d ", sample->pid);
273 else if (PRINT_FIELD(TID))
274 printf("%5d ", sample->tid);
275
276 if (PRINT_FIELD(CPU)) {
277 if (latency_format)
278 printf("%3d ", sample->cpu);
279 else
280 printf("[%03d] ", sample->cpu);
281 }
282
283 if (PRINT_FIELD(TIME)) {
284 nsecs = sample->time;
285 secs = nsecs / NSECS_PER_SEC;
286 nsecs -= secs * NSECS_PER_SEC;
287 usecs = nsecs / NSECS_PER_USEC;
288 printf("%5lu.%06lu: ", secs, usecs);
289 }
290
291 if (PRINT_FIELD(EVNAME)) {
292 if (attr->type == PERF_TYPE_TRACEPOINT) {
293 type = trace_parse_common_type(sample->raw_data);
294 event = trace_find_event(type);
295 if (event)
296 evname = event->name;
297 } else
298 evname = __event_name(attr->type, attr->config);
299
300 printf("%s: ", evname ? evname : "(unknown)");
301 }
302}
303
304static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
305{
306 if ((attr->type == PERF_TYPE_SOFTWARE) &&
307 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
308 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
309 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
310 return true;
311
312 return false;
313}
314
315static void print_sample_addr(union perf_event *event,
316 struct perf_sample *sample,
317 struct perf_session *session,
318 struct thread *thread,
319 struct perf_event_attr *attr)
320{
321 struct addr_location al;
322 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
323 const char *symname, *dsoname;
324
325 printf("%16" PRIx64, sample->addr);
326
327 if (!sample_addr_correlates_sym(attr))
328 return;
329
330 thread__find_addr_map(thread, session, cpumode, MAP__FUNCTION,
331 event->ip.pid, sample->addr, &al);
332 if (!al.map)
333 thread__find_addr_map(thread, session, cpumode, MAP__VARIABLE,
334 event->ip.pid, sample->addr, &al);
335
336 al.cpu = sample->cpu;
337 al.sym = NULL;
338
339 if (al.map)
340 al.sym = map__find_symbol(al.map, al.addr, NULL);
341
342 if (PRINT_FIELD(SYM)) {
343 if (al.sym && al.sym->name)
344 symname = al.sym->name;
345 else
346 symname = "";
347
348 printf(" %16s", symname);
349 }
350
351 if (PRINT_FIELD(DSO)) {
352 if (al.map && al.map->dso && al.map->dso->name)
353 dsoname = al.map->dso->name;
354 else
355 dsoname = "";
356
357 printf(" (%s)", dsoname);
358 }
359}
360
361static void process_event(union perf_event *event __unused,
362 struct perf_sample *sample,
363 struct perf_evsel *evsel,
364 struct perf_session *session,
365 struct thread *thread)
366{
367 struct perf_event_attr *attr = &evsel->attr;
368
369 if (output[attr->type].fields == 0)
370 return;
371
372 print_sample_start(sample, thread, attr);
373
374 if (PRINT_FIELD(TRACE))
375 print_trace_event(sample->cpu, sample->raw_data,
376 sample->raw_size);
377
378 if (PRINT_FIELD(ADDR))
379 print_sample_addr(event, sample, session, thread, attr);
380
381 if (PRINT_FIELD(IP)) {
382 if (!symbol_conf.use_callchain)
383 printf(" ");
384 else
385 printf("\n");
386 perf_session__print_ip(event, sample, session,
387 PRINT_FIELD(SYM), PRINT_FIELD(DSO));
388 }
389
390 printf("\n");
391}
392
393static int default_start_script(const char *script __unused,
394 int argc __unused,
395 const char **argv __unused)
396{
397 return 0;
398}
399
400static int default_stop_script(void)
401{
402 return 0;
403}
404
405static int default_generate_script(const char *outfile __unused)
406{
407 return 0;
408}
409
410static struct scripting_ops default_scripting_ops = {
411 .start_script = default_start_script,
412 .stop_script = default_stop_script,
413 .process_event = process_event,
414 .generate_script = default_generate_script,
415};
416
417static struct scripting_ops *scripting_ops;
418
419static void setup_scripting(void)
420{
421 setup_perl_scripting();
422 setup_python_scripting();
423
424 scripting_ops = &default_scripting_ops;
425}
426
427static int cleanup_scripting(void)
428{
429 pr_debug("\nperf script stopped\n");
430
431 return scripting_ops->stop_script();
432}
433
434static char const *input_name = "perf.data";
435
436static int process_sample_event(union perf_event *event,
437 struct perf_sample *sample,
438 struct perf_evsel *evsel,
439 struct perf_session *session)
440{
441 struct thread *thread = perf_session__findnew(session, event->ip.pid);
442
443 if (thread == NULL) {
444 pr_debug("problem processing %d event, skipping it.\n",
445 event->header.type);
446 return -1;
447 }
448
449 if (debug_mode) {
450 if (sample->time < last_timestamp) {
451 pr_err("Samples misordered, previous: %" PRIu64
452 " this: %" PRIu64 "\n", last_timestamp,
453 sample->time);
454 nr_unordered++;
455 }
456 last_timestamp = sample->time;
457 return 0;
458 }
459
460 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
461 return 0;
462
463 scripting_ops->process_event(event, sample, evsel, session, thread);
464
465 session->hists.stats.total_period += sample->period;
466 return 0;
467}
468
469static struct perf_event_ops event_ops = {
470 .sample = process_sample_event,
471 .mmap = perf_event__process_mmap,
472 .comm = perf_event__process_comm,
473 .exit = perf_event__process_task,
474 .fork = perf_event__process_task,
475 .attr = perf_event__process_attr,
476 .event_type = perf_event__process_event_type,
477 .tracing_data = perf_event__process_tracing_data,
478 .build_id = perf_event__process_build_id,
479 .ordered_samples = true,
480 .ordering_requires_timestamps = true,
481};
482
483extern volatile int session_done;
484
485static void sig_handler(int sig __unused)
486{
487 session_done = 1;
488}
489
490static int __cmd_script(struct perf_session *session)
491{
492 int ret;
493
494 signal(SIGINT, sig_handler);
495
496 ret = perf_session__process_events(session, &event_ops);
497
498 if (debug_mode)
499 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
500
501 return ret;
502}
503
504struct script_spec {
505 struct list_head node;
506 struct scripting_ops *ops;
507 char spec[0];
508};
509
510static LIST_HEAD(script_specs);
511
512static struct script_spec *script_spec__new(const char *spec,
513 struct scripting_ops *ops)
514{
515 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
516
517 if (s != NULL) {
518 strcpy(s->spec, spec);
519 s->ops = ops;
520 }
521
522 return s;
523}
524
525static void script_spec__delete(struct script_spec *s)
526{
527 free(s->spec);
528 free(s);
529}
530
531static void script_spec__add(struct script_spec *s)
532{
533 list_add_tail(&s->node, &script_specs);
534}
535
536static struct script_spec *script_spec__find(const char *spec)
537{
538 struct script_spec *s;
539
540 list_for_each_entry(s, &script_specs, node)
541 if (strcasecmp(s->spec, spec) == 0)
542 return s;
543 return NULL;
544}
545
546static struct script_spec *script_spec__findnew(const char *spec,
547 struct scripting_ops *ops)
548{
549 struct script_spec *s = script_spec__find(spec);
550
551 if (s)
552 return s;
553
554 s = script_spec__new(spec, ops);
555 if (!s)
556 goto out_delete_spec;
557
558 script_spec__add(s);
559
560 return s;
561
562out_delete_spec:
563 script_spec__delete(s);
564
565 return NULL;
566}
567
568int script_spec_register(const char *spec, struct scripting_ops *ops)
569{
570 struct script_spec *s;
571
572 s = script_spec__find(spec);
573 if (s)
574 return -1;
575
576 s = script_spec__findnew(spec, ops);
577 if (!s)
578 return -1;
579
580 return 0;
581}
582
583static struct scripting_ops *script_spec__lookup(const char *spec)
584{
585 struct script_spec *s = script_spec__find(spec);
586 if (!s)
587 return NULL;
588
589 return s->ops;
590}
591
592static void list_available_languages(void)
593{
594 struct script_spec *s;
595
596 fprintf(stderr, "\n");
597 fprintf(stderr, "Scripting language extensions (used in "
598 "perf script -s [spec:]script.[spec]):\n\n");
599
600 list_for_each_entry(s, &script_specs, node)
601 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
602
603 fprintf(stderr, "\n");
604}
605
606static int parse_scriptname(const struct option *opt __used,
607 const char *str, int unset __used)
608{
609 char spec[PATH_MAX];
610 const char *script, *ext;
611 int len;
612
613 if (strcmp(str, "lang") == 0) {
614 list_available_languages();
615 exit(0);
616 }
617
618 script = strchr(str, ':');
619 if (script) {
620 len = script - str;
621 if (len >= PATH_MAX) {
622 fprintf(stderr, "invalid language specifier");
623 return -1;
624 }
625 strncpy(spec, str, len);
626 spec[len] = '\0';
627 scripting_ops = script_spec__lookup(spec);
628 if (!scripting_ops) {
629 fprintf(stderr, "invalid language specifier");
630 return -1;
631 }
632 script++;
633 } else {
634 script = str;
635 ext = strrchr(script, '.');
636 if (!ext) {
637 fprintf(stderr, "invalid script extension");
638 return -1;
639 }
640 scripting_ops = script_spec__lookup(++ext);
641 if (!scripting_ops) {
642 fprintf(stderr, "invalid script extension");
643 return -1;
644 }
645 }
646
647 script_name = strdup(script);
648
649 return 0;
650}
651
652static int parse_output_fields(const struct option *opt __used,
653 const char *arg, int unset __used)
654{
655 char *tok;
656 int i, imax = sizeof(all_output_options) / sizeof(struct output_option);
657 int j;
658 int rc = 0;
659 char *str = strdup(arg);
660 int type = -1;
661
662 if (!str)
663 return -ENOMEM;
664
665 /* first word can state for which event type the user is specifying
666 * the fields. If no type exists, the specified fields apply to all
667 * event types found in the file minus the invalid fields for a type.
668 */
669 tok = strchr(str, ':');
670 if (tok) {
671 *tok = '\0';
672 tok++;
673 if (!strcmp(str, "hw"))
674 type = PERF_TYPE_HARDWARE;
675 else if (!strcmp(str, "sw"))
676 type = PERF_TYPE_SOFTWARE;
677 else if (!strcmp(str, "trace"))
678 type = PERF_TYPE_TRACEPOINT;
679 else if (!strcmp(str, "raw"))
680 type = PERF_TYPE_RAW;
681 else {
682 fprintf(stderr, "Invalid event type in field string.\n");
683 return -EINVAL;
684 }
685
686 if (output[type].user_set)
687 pr_warning("Overriding previous field request for %s events.\n",
688 event_type(type));
689
690 output[type].fields = 0;
691 output[type].user_set = true;
692 output[type].wildcard_set = false;
693
694 } else {
695 tok = str;
696 if (strlen(str) == 0) {
697 fprintf(stderr,
698 "Cannot set fields to 'none' for all event types.\n");
699 rc = -EINVAL;
700 goto out;
701 }
702
703 if (output_set_by_user())
704 pr_warning("Overriding previous field request for all events.\n");
705
706 for (j = 0; j < PERF_TYPE_MAX; ++j) {
707 output[j].fields = 0;
708 output[j].user_set = true;
709 output[j].wildcard_set = true;
710 }
711 }
712
713 tok = strtok(tok, ",");
714 while (tok) {
715 for (i = 0; i < imax; ++i) {
716 if (strcmp(tok, all_output_options[i].str) == 0)
717 break;
718 }
719 if (i == imax) {
720 fprintf(stderr, "Invalid field requested.\n");
721 rc = -EINVAL;
722 goto out;
723 }
724
725 if (type == -1) {
726 /* add user option to all events types for
727 * which it is valid
728 */
729 for (j = 0; j < PERF_TYPE_MAX; ++j) {
730 if (output[j].invalid_fields & all_output_options[i].field) {
731 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
732 all_output_options[i].str, event_type(j));
733 } else
734 output[j].fields |= all_output_options[i].field;
735 }
736 } else {
737 if (output[type].invalid_fields & all_output_options[i].field) {
738 fprintf(stderr, "\'%s\' not valid for %s events.\n",
739 all_output_options[i].str, event_type(type));
740
741 rc = -EINVAL;
742 goto out;
743 }
744 output[type].fields |= all_output_options[i].field;
745 }
746
747 tok = strtok(NULL, ",");
748 }
749
750 if (type >= 0) {
751 if (output[type].fields == 0) {
752 pr_debug("No fields requested for %s type. "
753 "Events will not be displayed.\n", event_type(type));
754 }
755 }
756
757out:
758 free(str);
759 return rc;
760}
761
762/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
763static int is_directory(const char *base_path, const struct dirent *dent)
764{
765 char path[PATH_MAX];
766 struct stat st;
767
768 sprintf(path, "%s/%s", base_path, dent->d_name);
769 if (stat(path, &st))
770 return 0;
771
772 return S_ISDIR(st.st_mode);
773}
774
775#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
776 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
777 lang_next) \
778 if ((lang_dirent.d_type == DT_DIR || \
779 (lang_dirent.d_type == DT_UNKNOWN && \
780 is_directory(scripts_path, &lang_dirent))) && \
781 (strcmp(lang_dirent.d_name, ".")) && \
782 (strcmp(lang_dirent.d_name, "..")))
783
784#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
785 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
786 script_next) \
787 if (script_dirent.d_type != DT_DIR && \
788 (script_dirent.d_type != DT_UNKNOWN || \
789 !is_directory(lang_path, &script_dirent)))
790
791
792#define RECORD_SUFFIX "-record"
793#define REPORT_SUFFIX "-report"
794
795struct script_desc {
796 struct list_head node;
797 char *name;
798 char *half_liner;
799 char *args;
800};
801
802static LIST_HEAD(script_descs);
803
804static struct script_desc *script_desc__new(const char *name)
805{
806 struct script_desc *s = zalloc(sizeof(*s));
807
808 if (s != NULL && name)
809 s->name = strdup(name);
810
811 return s;
812}
813
814static void script_desc__delete(struct script_desc *s)
815{
816 free(s->name);
817 free(s->half_liner);
818 free(s->args);
819 free(s);
820}
821
822static void script_desc__add(struct script_desc *s)
823{
824 list_add_tail(&s->node, &script_descs);
825}
826
827static struct script_desc *script_desc__find(const char *name)
828{
829 struct script_desc *s;
830
831 list_for_each_entry(s, &script_descs, node)
832 if (strcasecmp(s->name, name) == 0)
833 return s;
834 return NULL;
835}
836
837static struct script_desc *script_desc__findnew(const char *name)
838{
839 struct script_desc *s = script_desc__find(name);
840
841 if (s)
842 return s;
843
844 s = script_desc__new(name);
845 if (!s)
846 goto out_delete_desc;
847
848 script_desc__add(s);
849
850 return s;
851
852out_delete_desc:
853 script_desc__delete(s);
854
855 return NULL;
856}
857
858static const char *ends_with(const char *str, const char *suffix)
859{
860 size_t suffix_len = strlen(suffix);
861 const char *p = str;
862
863 if (strlen(str) > suffix_len) {
864 p = str + strlen(str) - suffix_len;
865 if (!strncmp(p, suffix, suffix_len))
866 return p;
867 }
868
869 return NULL;
870}
871
872static char *ltrim(char *str)
873{
874 int len = strlen(str);
875
876 while (len && isspace(*str)) {
877 len--;
878 str++;
879 }
880
881 return str;
882}
883
884static int read_script_info(struct script_desc *desc, const char *filename)
885{
886 char line[BUFSIZ], *p;
887 FILE *fp;
888
889 fp = fopen(filename, "r");
890 if (!fp)
891 return -1;
892
893 while (fgets(line, sizeof(line), fp)) {
894 p = ltrim(line);
895 if (strlen(p) == 0)
896 continue;
897 if (*p != '#')
898 continue;
899 p++;
900 if (strlen(p) && *p == '!')
901 continue;
902
903 p = ltrim(p);
904 if (strlen(p) && p[strlen(p) - 1] == '\n')
905 p[strlen(p) - 1] = '\0';
906
907 if (!strncmp(p, "description:", strlen("description:"))) {
908 p += strlen("description:");
909 desc->half_liner = strdup(ltrim(p));
910 continue;
911 }
912
913 if (!strncmp(p, "args:", strlen("args:"))) {
914 p += strlen("args:");
915 desc->args = strdup(ltrim(p));
916 continue;
917 }
918 }
919
920 fclose(fp);
921
922 return 0;
923}
924
925static int list_available_scripts(const struct option *opt __used,
926 const char *s __used, int unset __used)
927{
928 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
929 char scripts_path[MAXPATHLEN];
930 DIR *scripts_dir, *lang_dir;
931 char script_path[MAXPATHLEN];
932 char lang_path[MAXPATHLEN];
933 struct script_desc *desc;
934 char first_half[BUFSIZ];
935 char *script_root;
936 char *str;
937
938 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
939
940 scripts_dir = opendir(scripts_path);
941 if (!scripts_dir)
942 return -1;
943
944 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
945 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
946 lang_dirent.d_name);
947 lang_dir = opendir(lang_path);
948 if (!lang_dir)
949 continue;
950
951 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
952 script_root = strdup(script_dirent.d_name);
953 str = (char *)ends_with(script_root, REPORT_SUFFIX);
954 if (str) {
955 *str = '\0';
956 desc = script_desc__findnew(script_root);
957 snprintf(script_path, MAXPATHLEN, "%s/%s",
958 lang_path, script_dirent.d_name);
959 read_script_info(desc, script_path);
960 }
961 free(script_root);
962 }
963 }
964
965 fprintf(stdout, "List of available trace scripts:\n");
966 list_for_each_entry(desc, &script_descs, node) {
967 sprintf(first_half, "%s %s", desc->name,
968 desc->args ? desc->args : "");
969 fprintf(stdout, " %-36s %s\n", first_half,
970 desc->half_liner ? desc->half_liner : "");
971 }
972
973 exit(0);
974}
975
976static char *get_script_path(const char *script_root, const char *suffix)
977{
978 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
979 char scripts_path[MAXPATHLEN];
980 char script_path[MAXPATHLEN];
981 DIR *scripts_dir, *lang_dir;
982 char lang_path[MAXPATHLEN];
983 char *str, *__script_root;
984 char *path = NULL;
985
986 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
987
988 scripts_dir = opendir(scripts_path);
989 if (!scripts_dir)
990 return NULL;
991
992 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
993 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
994 lang_dirent.d_name);
995 lang_dir = opendir(lang_path);
996 if (!lang_dir)
997 continue;
998
999 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1000 __script_root = strdup(script_dirent.d_name);
1001 str = (char *)ends_with(__script_root, suffix);
1002 if (str) {
1003 *str = '\0';
1004 if (strcmp(__script_root, script_root))
1005 continue;
1006 snprintf(script_path, MAXPATHLEN, "%s/%s",
1007 lang_path, script_dirent.d_name);
1008 path = strdup(script_path);
1009 free(__script_root);
1010 break;
1011 }
1012 free(__script_root);
1013 }
1014 }
1015
1016 return path;
1017}
1018
1019static bool is_top_script(const char *script_path)
1020{
1021 return ends_with(script_path, "top") == NULL ? false : true;
1022}
1023
1024static int has_required_arg(char *script_path)
1025{
1026 struct script_desc *desc;
1027 int n_args = 0;
1028 char *p;
1029
1030 desc = script_desc__new(NULL);
1031
1032 if (read_script_info(desc, script_path))
1033 goto out;
1034
1035 if (!desc->args)
1036 goto out;
1037
1038 for (p = desc->args; *p; p++)
1039 if (*p == '<')
1040 n_args++;
1041out:
1042 script_desc__delete(desc);
1043
1044 return n_args;
1045}
1046
1047static const char * const script_usage[] = {
1048 "perf script [<options>]",
1049 "perf script [<options>] record <script> [<record-options>] <command>",
1050 "perf script [<options>] report <script> [script-args]",
1051 "perf script [<options>] <script> [<record-options>] <command>",
1052 "perf script [<options>] <top-script> [script-args]",
1053 NULL
1054};
1055
1056static const struct option options[] = {
1057 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1058 "dump raw trace in ASCII"),
1059 OPT_INCR('v', "verbose", &verbose,
1060 "be more verbose (show symbol address, etc)"),
1061 OPT_BOOLEAN('L', "Latency", &latency_format,
1062 "show latency attributes (irqs/preemption disabled, etc)"),
1063 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1064 list_available_scripts),
1065 OPT_CALLBACK('s', "script", NULL, "name",
1066 "script file name (lang:script name, script name, or *)",
1067 parse_scriptname),
1068 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1069 "generate perf-script.xx script in specified language"),
1070 OPT_STRING('i', "input", &input_name, "file",
1071 "input file name"),
1072 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1073 "do various checks like samples ordering and lost events"),
1074 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1075 "file", "vmlinux pathname"),
1076 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1077 "file", "kallsyms pathname"),
1078 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1079 "When printing symbols do not display call chain"),
1080 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1081 "Look for files with symbols relative to this directory"),
1082 OPT_CALLBACK('f', "fields", NULL, "str",
1083 "comma separated output fields prepend with 'type:'. Valid types: hw,sw,trace,raw. Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,addr",
1084 parse_output_fields),
1085 OPT_STRING('c', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1086
1087 OPT_END()
1088};
1089
1090static bool have_cmd(int argc, const char **argv)
1091{
1092 char **__argv = malloc(sizeof(const char *) * argc);
1093
1094 if (!__argv)
1095 die("malloc");
1096 memcpy(__argv, argv, sizeof(const char *) * argc);
1097 argc = parse_options(argc, (const char **)__argv, record_options,
1098 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1099 free(__argv);
1100
1101 return argc != 0;
1102}
1103
1104int cmd_script(int argc, const char **argv, const char *prefix __used)
1105{
1106 char *rec_script_path = NULL;
1107 char *rep_script_path = NULL;
1108 struct perf_session *session;
1109 char *script_path = NULL;
1110 const char **__argv;
1111 bool system_wide;
1112 int i, j, err;
1113
1114 setup_scripting();
1115
1116 argc = parse_options(argc, argv, options, script_usage,
1117 PARSE_OPT_STOP_AT_NON_OPTION);
1118
1119 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1120 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1121 if (!rec_script_path)
1122 return cmd_record(argc, argv, NULL);
1123 }
1124
1125 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1126 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1127 if (!rep_script_path) {
1128 fprintf(stderr,
1129 "Please specify a valid report script"
1130 "(see 'perf script -l' for listing)\n");
1131 return -1;
1132 }
1133 }
1134
1135 /* make sure PERF_EXEC_PATH is set for scripts */
1136 perf_set_argv_exec_path(perf_exec_path());
1137
1138 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1139 int live_pipe[2];
1140 int rep_args;
1141 pid_t pid;
1142
1143 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1144 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1145
1146 if (!rec_script_path && !rep_script_path) {
1147 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1148 " script -l for available scripts.\n", argv[0]);
1149 usage_with_options(script_usage, options);
1150 }
1151
1152 if (is_top_script(argv[0])) {
1153 rep_args = argc - 1;
1154 } else {
1155 int rec_args;
1156
1157 rep_args = has_required_arg(rep_script_path);
1158 rec_args = (argc - 1) - rep_args;
1159 if (rec_args < 0) {
1160 fprintf(stderr, " %s script requires options."
1161 "\n\n See perf script -l for available "
1162 "scripts and options.\n", argv[0]);
1163 usage_with_options(script_usage, options);
1164 }
1165 }
1166
1167 if (pipe(live_pipe) < 0) {
1168 perror("failed to create pipe");
1169 exit(-1);
1170 }
1171
1172 pid = fork();
1173 if (pid < 0) {
1174 perror("failed to fork");
1175 exit(-1);
1176 }
1177
1178 if (!pid) {
1179 system_wide = true;
1180 j = 0;
1181
1182 dup2(live_pipe[1], 1);
1183 close(live_pipe[0]);
1184
1185 if (!is_top_script(argv[0]))
1186 system_wide = !have_cmd(argc - rep_args,
1187 &argv[rep_args]);
1188
1189 __argv = malloc((argc + 6) * sizeof(const char *));
1190 if (!__argv)
1191 die("malloc");
1192
1193 __argv[j++] = "/bin/sh";
1194 __argv[j++] = rec_script_path;
1195 if (system_wide)
1196 __argv[j++] = "-a";
1197 __argv[j++] = "-q";
1198 __argv[j++] = "-o";
1199 __argv[j++] = "-";
1200 for (i = rep_args + 1; i < argc; i++)
1201 __argv[j++] = argv[i];
1202 __argv[j++] = NULL;
1203
1204 execvp("/bin/sh", (char **)__argv);
1205 free(__argv);
1206 exit(-1);
1207 }
1208
1209 dup2(live_pipe[0], 0);
1210 close(live_pipe[1]);
1211
1212 __argv = malloc((argc + 4) * sizeof(const char *));
1213 if (!__argv)
1214 die("malloc");
1215 j = 0;
1216 __argv[j++] = "/bin/sh";
1217 __argv[j++] = rep_script_path;
1218 for (i = 1; i < rep_args + 1; i++)
1219 __argv[j++] = argv[i];
1220 __argv[j++] = "-i";
1221 __argv[j++] = "-";
1222 __argv[j++] = NULL;
1223
1224 execvp("/bin/sh", (char **)__argv);
1225 free(__argv);
1226 exit(-1);
1227 }
1228
1229 if (rec_script_path)
1230 script_path = rec_script_path;
1231 if (rep_script_path)
1232 script_path = rep_script_path;
1233
1234 if (script_path) {
1235 system_wide = false;
1236 j = 0;
1237
1238 if (rec_script_path)
1239 system_wide = !have_cmd(argc - 1, &argv[1]);
1240
1241 __argv = malloc((argc + 2) * sizeof(const char *));
1242 if (!__argv)
1243 die("malloc");
1244 __argv[j++] = "/bin/sh";
1245 __argv[j++] = script_path;
1246 if (system_wide)
1247 __argv[j++] = "-a";
1248 for (i = 2; i < argc; i++)
1249 __argv[j++] = argv[i];
1250 __argv[j++] = NULL;
1251
1252 execvp("/bin/sh", (char **)__argv);
1253 free(__argv);
1254 exit(-1);
1255 }
1256
1257 if (symbol__init() < 0)
1258 return -1;
1259 if (!script_name)
1260 setup_pager();
1261
1262 session = perf_session__new(input_name, O_RDONLY, 0, false, &event_ops);
1263 if (session == NULL)
1264 return -ENOMEM;
1265
1266 if (cpu_list) {
1267 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1268 return -1;
1269 }
1270
1271 if (!no_callchain)
1272 symbol_conf.use_callchain = true;
1273 else
1274 symbol_conf.use_callchain = false;
1275
1276 if (generate_script_lang) {
1277 struct stat perf_stat;
1278 int input;
1279
1280 if (output_set_by_user()) {
1281 fprintf(stderr,
1282 "custom fields not supported for generated scripts");
1283 return -1;
1284 }
1285
1286 input = open(input_name, O_RDONLY);
1287 if (input < 0) {
1288 perror("failed to open file");
1289 exit(-1);
1290 }
1291
1292 err = fstat(input, &perf_stat);
1293 if (err < 0) {
1294 perror("failed to stat file");
1295 exit(-1);
1296 }
1297
1298 if (!perf_stat.st_size) {
1299 fprintf(stderr, "zero-sized file, nothing to do!\n");
1300 exit(0);
1301 }
1302
1303 scripting_ops = script_spec__lookup(generate_script_lang);
1304 if (!scripting_ops) {
1305 fprintf(stderr, "invalid language specifier");
1306 return -1;
1307 }
1308
1309 err = scripting_ops->generate_script("perf-script");
1310 goto out;
1311 }
1312
1313 if (script_name) {
1314 err = scripting_ops->start_script(script_name, argc, argv);
1315 if (err)
1316 goto out;
1317 pr_debug("perf script started with script %s\n\n", script_name);
1318 }
1319
1320
1321 err = perf_session__check_output_opt(session);
1322 if (err < 0)
1323 goto out;
1324
1325 err = __cmd_script(session);
1326
1327 perf_session__delete(session);
1328 cleanup_scripting();
1329out:
1330 return err;
1331}