Loading...
1#include "builtin.h"
2
3#include "perf.h"
4#include "util/cache.h"
5#include "util/debug.h"
6#include <subcmd/exec-cmd.h>
7#include "util/header.h"
8#include <subcmd/parse-options.h>
9#include "util/perf_regs.h"
10#include "util/session.h"
11#include "util/tool.h"
12#include "util/symbol.h"
13#include "util/thread.h"
14#include "util/trace-event.h"
15#include "util/util.h"
16#include "util/evlist.h"
17#include "util/evsel.h"
18#include "util/sort.h"
19#include "util/data.h"
20#include "util/auxtrace.h"
21#include "util/cpumap.h"
22#include "util/thread_map.h"
23#include "util/stat.h"
24#include <linux/bitmap.h>
25#include "asm/bug.h"
26#include "util/mem-events.h"
27
28static char const *script_name;
29static char const *generate_script_lang;
30static bool debug_mode;
31static u64 last_timestamp;
32static u64 nr_unordered;
33static bool no_callchain;
34static bool latency_format;
35static bool system_wide;
36static bool print_flags;
37static bool nanosecs;
38static const char *cpu_list;
39static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
40static struct perf_stat_config stat_config;
41
42unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
43
44enum perf_output_field {
45 PERF_OUTPUT_COMM = 1U << 0,
46 PERF_OUTPUT_TID = 1U << 1,
47 PERF_OUTPUT_PID = 1U << 2,
48 PERF_OUTPUT_TIME = 1U << 3,
49 PERF_OUTPUT_CPU = 1U << 4,
50 PERF_OUTPUT_EVNAME = 1U << 5,
51 PERF_OUTPUT_TRACE = 1U << 6,
52 PERF_OUTPUT_IP = 1U << 7,
53 PERF_OUTPUT_SYM = 1U << 8,
54 PERF_OUTPUT_DSO = 1U << 9,
55 PERF_OUTPUT_ADDR = 1U << 10,
56 PERF_OUTPUT_SYMOFFSET = 1U << 11,
57 PERF_OUTPUT_SRCLINE = 1U << 12,
58 PERF_OUTPUT_PERIOD = 1U << 13,
59 PERF_OUTPUT_IREGS = 1U << 14,
60 PERF_OUTPUT_BRSTACK = 1U << 15,
61 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
62 PERF_OUTPUT_DATA_SRC = 1U << 17,
63 PERF_OUTPUT_WEIGHT = 1U << 18,
64 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
65};
66
67struct output_option {
68 const char *str;
69 enum perf_output_field field;
70} all_output_options[] = {
71 {.str = "comm", .field = PERF_OUTPUT_COMM},
72 {.str = "tid", .field = PERF_OUTPUT_TID},
73 {.str = "pid", .field = PERF_OUTPUT_PID},
74 {.str = "time", .field = PERF_OUTPUT_TIME},
75 {.str = "cpu", .field = PERF_OUTPUT_CPU},
76 {.str = "event", .field = PERF_OUTPUT_EVNAME},
77 {.str = "trace", .field = PERF_OUTPUT_TRACE},
78 {.str = "ip", .field = PERF_OUTPUT_IP},
79 {.str = "sym", .field = PERF_OUTPUT_SYM},
80 {.str = "dso", .field = PERF_OUTPUT_DSO},
81 {.str = "addr", .field = PERF_OUTPUT_ADDR},
82 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
83 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
84 {.str = "period", .field = PERF_OUTPUT_PERIOD},
85 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
86 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
87 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
88 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
89 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
90 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
91};
92
93/* default set to maintain compatibility with current format */
94static struct {
95 bool user_set;
96 bool wildcard_set;
97 unsigned int print_ip_opts;
98 u64 fields;
99 u64 invalid_fields;
100} output[PERF_TYPE_MAX] = {
101
102 [PERF_TYPE_HARDWARE] = {
103 .user_set = false,
104
105 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
106 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
107 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
108 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
109 PERF_OUTPUT_PERIOD,
110
111 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
112 },
113
114 [PERF_TYPE_SOFTWARE] = {
115 .user_set = false,
116
117 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
118 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
119 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
120 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
121 PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
122
123 .invalid_fields = PERF_OUTPUT_TRACE,
124 },
125
126 [PERF_TYPE_TRACEPOINT] = {
127 .user_set = false,
128
129 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
130 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
131 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
132 },
133
134 [PERF_TYPE_RAW] = {
135 .user_set = false,
136
137 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
138 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
139 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
140 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
141 PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR |
142 PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
143
144 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
145 },
146
147 [PERF_TYPE_BREAKPOINT] = {
148 .user_set = false,
149
150 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
151 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
152 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
153 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
154 PERF_OUTPUT_PERIOD,
155
156 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
157 },
158};
159
160static bool output_set_by_user(void)
161{
162 int j;
163 for (j = 0; j < PERF_TYPE_MAX; ++j) {
164 if (output[j].user_set)
165 return true;
166 }
167 return false;
168}
169
170static const char *output_field2str(enum perf_output_field field)
171{
172 int i, imax = ARRAY_SIZE(all_output_options);
173 const char *str = "";
174
175 for (i = 0; i < imax; ++i) {
176 if (all_output_options[i].field == field) {
177 str = all_output_options[i].str;
178 break;
179 }
180 }
181 return str;
182}
183
184#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
185
186static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
187 u64 sample_type, const char *sample_msg,
188 enum perf_output_field field,
189 bool allow_user_set)
190{
191 struct perf_event_attr *attr = &evsel->attr;
192 int type = attr->type;
193 const char *evname;
194
195 if (attr->sample_type & sample_type)
196 return 0;
197
198 if (output[type].user_set) {
199 if (allow_user_set)
200 return 0;
201 evname = perf_evsel__name(evsel);
202 pr_err("Samples for '%s' event do not have %s attribute set. "
203 "Cannot print '%s' field.\n",
204 evname, sample_msg, output_field2str(field));
205 return -1;
206 }
207
208 /* user did not ask for it explicitly so remove from the default list */
209 output[type].fields &= ~field;
210 evname = perf_evsel__name(evsel);
211 pr_debug("Samples for '%s' event do not have %s attribute set. "
212 "Skipping '%s' field.\n",
213 evname, sample_msg, output_field2str(field));
214
215 return 0;
216}
217
218static int perf_evsel__check_stype(struct perf_evsel *evsel,
219 u64 sample_type, const char *sample_msg,
220 enum perf_output_field field)
221{
222 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
223 false);
224}
225
226static int perf_evsel__check_attr(struct perf_evsel *evsel,
227 struct perf_session *session)
228{
229 struct perf_event_attr *attr = &evsel->attr;
230 bool allow_user_set;
231
232 if (perf_header__has_feat(&session->header, HEADER_STAT))
233 return 0;
234
235 allow_user_set = perf_header__has_feat(&session->header,
236 HEADER_AUXTRACE);
237
238 if (PRINT_FIELD(TRACE) &&
239 !perf_session__has_traces(session, "record -R"))
240 return -EINVAL;
241
242 if (PRINT_FIELD(IP)) {
243 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
244 PERF_OUTPUT_IP))
245 return -EINVAL;
246 }
247
248 if (PRINT_FIELD(ADDR) &&
249 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
250 PERF_OUTPUT_ADDR, allow_user_set))
251 return -EINVAL;
252
253 if (PRINT_FIELD(DATA_SRC) &&
254 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
255 PERF_OUTPUT_DATA_SRC))
256 return -EINVAL;
257
258 if (PRINT_FIELD(WEIGHT) &&
259 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
260 PERF_OUTPUT_WEIGHT))
261 return -EINVAL;
262
263 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
264 pr_err("Display of symbols requested but neither sample IP nor "
265 "sample address\nis selected. Hence, no addresses to convert "
266 "to symbols.\n");
267 return -EINVAL;
268 }
269 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
270 pr_err("Display of offsets requested but symbol is not"
271 "selected.\n");
272 return -EINVAL;
273 }
274 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
275 pr_err("Display of DSO requested but neither sample IP nor "
276 "sample address\nis selected. Hence, no addresses to convert "
277 "to DSO.\n");
278 return -EINVAL;
279 }
280 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
281 pr_err("Display of source line number requested but sample IP is not\n"
282 "selected. Hence, no address to lookup the source line number.\n");
283 return -EINVAL;
284 }
285
286 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
287 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
288 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
289 return -EINVAL;
290
291 if (PRINT_FIELD(TIME) &&
292 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
293 PERF_OUTPUT_TIME))
294 return -EINVAL;
295
296 if (PRINT_FIELD(CPU) &&
297 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
298 PERF_OUTPUT_CPU, allow_user_set))
299 return -EINVAL;
300
301 if (PRINT_FIELD(PERIOD) &&
302 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
303 PERF_OUTPUT_PERIOD))
304 return -EINVAL;
305
306 if (PRINT_FIELD(IREGS) &&
307 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
308 PERF_OUTPUT_IREGS))
309 return -EINVAL;
310
311 return 0;
312}
313
314static void set_print_ip_opts(struct perf_event_attr *attr)
315{
316 unsigned int type = attr->type;
317
318 output[type].print_ip_opts = 0;
319 if (PRINT_FIELD(IP))
320 output[type].print_ip_opts |= PRINT_IP_OPT_IP;
321
322 if (PRINT_FIELD(SYM))
323 output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
324
325 if (PRINT_FIELD(DSO))
326 output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
327
328 if (PRINT_FIELD(SYMOFFSET))
329 output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
330
331 if (PRINT_FIELD(SRCLINE))
332 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
333}
334
335/*
336 * verify all user requested events exist and the samples
337 * have the expected data
338 */
339static int perf_session__check_output_opt(struct perf_session *session)
340{
341 int j;
342 struct perf_evsel *evsel;
343
344 for (j = 0; j < PERF_TYPE_MAX; ++j) {
345 evsel = perf_session__find_first_evtype(session, j);
346
347 /*
348 * even if fields is set to 0 (ie., show nothing) event must
349 * exist if user explicitly includes it on the command line
350 */
351 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
352 pr_err("%s events do not exist. "
353 "Remove corresponding -f option to proceed.\n",
354 event_type(j));
355 return -1;
356 }
357
358 if (evsel && output[j].fields &&
359 perf_evsel__check_attr(evsel, session))
360 return -1;
361
362 if (evsel == NULL)
363 continue;
364
365 set_print_ip_opts(&evsel->attr);
366 }
367
368 if (!no_callchain) {
369 bool use_callchain = false;
370
371 evlist__for_each(session->evlist, evsel) {
372 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
373 use_callchain = true;
374 break;
375 }
376 }
377 if (!use_callchain)
378 symbol_conf.use_callchain = false;
379 }
380
381 /*
382 * set default for tracepoints to print symbols only
383 * if callchains are present
384 */
385 if (symbol_conf.use_callchain &&
386 !output[PERF_TYPE_TRACEPOINT].user_set) {
387 struct perf_event_attr *attr;
388
389 j = PERF_TYPE_TRACEPOINT;
390 evsel = perf_session__find_first_evtype(session, j);
391 if (evsel == NULL)
392 goto out;
393
394 attr = &evsel->attr;
395
396 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
397 output[j].fields |= PERF_OUTPUT_IP;
398 output[j].fields |= PERF_OUTPUT_SYM;
399 output[j].fields |= PERF_OUTPUT_DSO;
400 set_print_ip_opts(attr);
401 }
402 }
403
404out:
405 return 0;
406}
407
408static void print_sample_iregs(struct perf_sample *sample,
409 struct perf_event_attr *attr)
410{
411 struct regs_dump *regs = &sample->intr_regs;
412 uint64_t mask = attr->sample_regs_intr;
413 unsigned i = 0, r;
414
415 if (!regs)
416 return;
417
418 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
419 u64 val = regs->regs[i++];
420 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
421 }
422}
423
424static void print_sample_start(struct perf_sample *sample,
425 struct thread *thread,
426 struct perf_evsel *evsel)
427{
428 struct perf_event_attr *attr = &evsel->attr;
429 unsigned long secs;
430 unsigned long usecs;
431 unsigned long long nsecs;
432
433 if (PRINT_FIELD(COMM)) {
434 if (latency_format)
435 printf("%8.8s ", thread__comm_str(thread));
436 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
437 printf("%s ", thread__comm_str(thread));
438 else
439 printf("%16s ", thread__comm_str(thread));
440 }
441
442 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
443 printf("%5d/%-5d ", sample->pid, sample->tid);
444 else if (PRINT_FIELD(PID))
445 printf("%5d ", sample->pid);
446 else if (PRINT_FIELD(TID))
447 printf("%5d ", sample->tid);
448
449 if (PRINT_FIELD(CPU)) {
450 if (latency_format)
451 printf("%3d ", sample->cpu);
452 else
453 printf("[%03d] ", sample->cpu);
454 }
455
456 if (PRINT_FIELD(TIME)) {
457 nsecs = sample->time;
458 secs = nsecs / NSECS_PER_SEC;
459 nsecs -= secs * NSECS_PER_SEC;
460 usecs = nsecs / NSECS_PER_USEC;
461 if (nanosecs)
462 printf("%5lu.%09llu: ", secs, nsecs);
463 else
464 printf("%5lu.%06lu: ", secs, usecs);
465 }
466}
467
468static inline char
469mispred_str(struct branch_entry *br)
470{
471 if (!(br->flags.mispred || br->flags.predicted))
472 return '-';
473
474 return br->flags.predicted ? 'P' : 'M';
475}
476
477static void print_sample_brstack(struct perf_sample *sample)
478{
479 struct branch_stack *br = sample->branch_stack;
480 u64 i;
481
482 if (!(br && br->nr))
483 return;
484
485 for (i = 0; i < br->nr; i++) {
486 printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
487 br->entries[i].from,
488 br->entries[i].to,
489 mispred_str( br->entries + i),
490 br->entries[i].flags.in_tx? 'X' : '-',
491 br->entries[i].flags.abort? 'A' : '-',
492 br->entries[i].flags.cycles);
493 }
494}
495
496static void print_sample_brstacksym(struct perf_sample *sample,
497 struct thread *thread)
498{
499 struct branch_stack *br = sample->branch_stack;
500 struct addr_location alf, alt;
501 u64 i, from, to;
502
503 if (!(br && br->nr))
504 return;
505
506 for (i = 0; i < br->nr; i++) {
507
508 memset(&alf, 0, sizeof(alf));
509 memset(&alt, 0, sizeof(alt));
510 from = br->entries[i].from;
511 to = br->entries[i].to;
512
513 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
514 if (alf.map)
515 alf.sym = map__find_symbol(alf.map, alf.addr, NULL);
516
517 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
518 if (alt.map)
519 alt.sym = map__find_symbol(alt.map, alt.addr, NULL);
520
521 symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
522 putchar('/');
523 symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
524 printf("/%c/%c/%c/%d ",
525 mispred_str( br->entries + i),
526 br->entries[i].flags.in_tx? 'X' : '-',
527 br->entries[i].flags.abort? 'A' : '-',
528 br->entries[i].flags.cycles);
529 }
530}
531
532
533static void print_sample_addr(struct perf_sample *sample,
534 struct thread *thread,
535 struct perf_event_attr *attr)
536{
537 struct addr_location al;
538
539 printf("%16" PRIx64, sample->addr);
540
541 if (!sample_addr_correlates_sym(attr))
542 return;
543
544 thread__resolve(thread, &al, sample);
545
546 if (PRINT_FIELD(SYM)) {
547 printf(" ");
548 if (PRINT_FIELD(SYMOFFSET))
549 symbol__fprintf_symname_offs(al.sym, &al, stdout);
550 else
551 symbol__fprintf_symname(al.sym, stdout);
552 }
553
554 if (PRINT_FIELD(DSO)) {
555 printf(" (");
556 map__fprintf_dsoname(al.map, stdout);
557 printf(")");
558 }
559}
560
561static void print_sample_bts(struct perf_sample *sample,
562 struct perf_evsel *evsel,
563 struct thread *thread,
564 struct addr_location *al)
565{
566 struct perf_event_attr *attr = &evsel->attr;
567 bool print_srcline_last = false;
568
569 /* print branch_from information */
570 if (PRINT_FIELD(IP)) {
571 unsigned int print_opts = output[attr->type].print_ip_opts;
572
573 if (symbol_conf.use_callchain && sample->callchain) {
574 printf("\n");
575 } else {
576 printf(" ");
577 if (print_opts & PRINT_IP_OPT_SRCLINE) {
578 print_srcline_last = true;
579 print_opts &= ~PRINT_IP_OPT_SRCLINE;
580 }
581 }
582 perf_evsel__print_ip(evsel, sample, al, print_opts,
583 scripting_max_stack);
584 }
585
586 /* print branch_to information */
587 if (PRINT_FIELD(ADDR) ||
588 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
589 !output[attr->type].user_set)) {
590 printf(" => ");
591 print_sample_addr(sample, thread, attr);
592 }
593
594 if (print_srcline_last)
595 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
596
597 printf("\n");
598}
599
600static void print_sample_flags(u32 flags)
601{
602 const char *chars = PERF_IP_FLAG_CHARS;
603 const int n = strlen(PERF_IP_FLAG_CHARS);
604 char str[33];
605 int i, pos = 0;
606
607 for (i = 0; i < n; i++, flags >>= 1) {
608 if (flags & 1)
609 str[pos++] = chars[i];
610 }
611 for (; i < 32; i++, flags >>= 1) {
612 if (flags & 1)
613 str[pos++] = '?';
614 }
615 str[pos] = 0;
616 printf(" %-4s ", str);
617}
618
619struct printer_data {
620 int line_no;
621 bool hit_nul;
622 bool is_printable;
623};
624
625static void
626print_sample_bpf_output_printer(enum binary_printer_ops op,
627 unsigned int val,
628 void *extra)
629{
630 unsigned char ch = (unsigned char)val;
631 struct printer_data *printer_data = extra;
632
633 switch (op) {
634 case BINARY_PRINT_DATA_BEGIN:
635 printf("\n");
636 break;
637 case BINARY_PRINT_LINE_BEGIN:
638 printf("%17s", !printer_data->line_no ? "BPF output:" :
639 " ");
640 break;
641 case BINARY_PRINT_ADDR:
642 printf(" %04x:", val);
643 break;
644 case BINARY_PRINT_NUM_DATA:
645 printf(" %02x", val);
646 break;
647 case BINARY_PRINT_NUM_PAD:
648 printf(" ");
649 break;
650 case BINARY_PRINT_SEP:
651 printf(" ");
652 break;
653 case BINARY_PRINT_CHAR_DATA:
654 if (printer_data->hit_nul && ch)
655 printer_data->is_printable = false;
656
657 if (!isprint(ch)) {
658 printf("%c", '.');
659
660 if (!printer_data->is_printable)
661 break;
662
663 if (ch == '\0')
664 printer_data->hit_nul = true;
665 else
666 printer_data->is_printable = false;
667 } else {
668 printf("%c", ch);
669 }
670 break;
671 case BINARY_PRINT_CHAR_PAD:
672 printf(" ");
673 break;
674 case BINARY_PRINT_LINE_END:
675 printf("\n");
676 printer_data->line_no++;
677 break;
678 case BINARY_PRINT_DATA_END:
679 default:
680 break;
681 }
682}
683
684static void print_sample_bpf_output(struct perf_sample *sample)
685{
686 unsigned int nr_bytes = sample->raw_size;
687 struct printer_data printer_data = {0, false, true};
688
689 print_binary(sample->raw_data, nr_bytes, 8,
690 print_sample_bpf_output_printer, &printer_data);
691
692 if (printer_data.is_printable && printer_data.hit_nul)
693 printf("%17s \"%s\"\n", "BPF string:",
694 (char *)(sample->raw_data));
695}
696
697struct perf_script {
698 struct perf_tool tool;
699 struct perf_session *session;
700 bool show_task_events;
701 bool show_mmap_events;
702 bool show_switch_events;
703 bool allocated;
704 struct cpu_map *cpus;
705 struct thread_map *threads;
706 int name_width;
707};
708
709static int perf_evlist__max_name_len(struct perf_evlist *evlist)
710{
711 struct perf_evsel *evsel;
712 int max = 0;
713
714 evlist__for_each(evlist, evsel) {
715 int len = strlen(perf_evsel__name(evsel));
716
717 max = MAX(len, max);
718 }
719
720 return max;
721}
722
723static size_t data_src__printf(u64 data_src)
724{
725 struct mem_info mi = { .data_src.val = data_src };
726 char decode[100];
727 char out[100];
728 static int maxlen;
729 int len;
730
731 perf_script__meminfo_scnprintf(decode, 100, &mi);
732
733 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
734 if (maxlen < len)
735 maxlen = len;
736
737 return printf("%-*s", maxlen, out);
738}
739
740static void process_event(struct perf_script *script,
741 struct perf_sample *sample, struct perf_evsel *evsel,
742 struct addr_location *al)
743{
744 struct thread *thread = al->thread;
745 struct perf_event_attr *attr = &evsel->attr;
746
747 if (output[attr->type].fields == 0)
748 return;
749
750 print_sample_start(sample, thread, evsel);
751
752 if (PRINT_FIELD(PERIOD))
753 printf("%10" PRIu64 " ", sample->period);
754
755 if (PRINT_FIELD(EVNAME)) {
756 const char *evname = perf_evsel__name(evsel);
757
758 if (!script->name_width)
759 script->name_width = perf_evlist__max_name_len(script->session->evlist);
760
761 printf("%*s: ", script->name_width,
762 evname ? evname : "[unknown]");
763 }
764
765 if (print_flags)
766 print_sample_flags(sample->flags);
767
768 if (is_bts_event(attr)) {
769 print_sample_bts(sample, evsel, thread, al);
770 return;
771 }
772
773 if (PRINT_FIELD(TRACE))
774 event_format__print(evsel->tp_format, sample->cpu,
775 sample->raw_data, sample->raw_size);
776 if (PRINT_FIELD(ADDR))
777 print_sample_addr(sample, thread, attr);
778
779 if (PRINT_FIELD(DATA_SRC))
780 data_src__printf(sample->data_src);
781
782 if (PRINT_FIELD(WEIGHT))
783 printf("%16" PRIu64, sample->weight);
784
785 if (PRINT_FIELD(IP)) {
786 if (!symbol_conf.use_callchain)
787 printf(" ");
788 else
789 printf("\n");
790
791 perf_evsel__print_ip(evsel, sample, al,
792 output[attr->type].print_ip_opts,
793 scripting_max_stack);
794 }
795
796 if (PRINT_FIELD(IREGS))
797 print_sample_iregs(sample, attr);
798
799 if (PRINT_FIELD(BRSTACK))
800 print_sample_brstack(sample);
801 else if (PRINT_FIELD(BRSTACKSYM))
802 print_sample_brstacksym(sample, thread);
803
804 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
805 print_sample_bpf_output(sample);
806
807 printf("\n");
808}
809
810static struct scripting_ops *scripting_ops;
811
812static void __process_stat(struct perf_evsel *counter, u64 tstamp)
813{
814 int nthreads = thread_map__nr(counter->threads);
815 int ncpus = perf_evsel__nr_cpus(counter);
816 int cpu, thread;
817 static int header_printed;
818
819 if (counter->system_wide)
820 nthreads = 1;
821
822 if (!header_printed) {
823 printf("%3s %8s %15s %15s %15s %15s %s\n",
824 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
825 header_printed = 1;
826 }
827
828 for (thread = 0; thread < nthreads; thread++) {
829 for (cpu = 0; cpu < ncpus; cpu++) {
830 struct perf_counts_values *counts;
831
832 counts = perf_counts(counter->counts, cpu, thread);
833
834 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
835 counter->cpus->map[cpu],
836 thread_map__pid(counter->threads, thread),
837 counts->val,
838 counts->ena,
839 counts->run,
840 tstamp,
841 perf_evsel__name(counter));
842 }
843 }
844}
845
846static void process_stat(struct perf_evsel *counter, u64 tstamp)
847{
848 if (scripting_ops && scripting_ops->process_stat)
849 scripting_ops->process_stat(&stat_config, counter, tstamp);
850 else
851 __process_stat(counter, tstamp);
852}
853
854static void process_stat_interval(u64 tstamp)
855{
856 if (scripting_ops && scripting_ops->process_stat_interval)
857 scripting_ops->process_stat_interval(tstamp);
858}
859
860static void setup_scripting(void)
861{
862 setup_perl_scripting();
863 setup_python_scripting();
864}
865
866static int flush_scripting(void)
867{
868 return scripting_ops ? scripting_ops->flush_script() : 0;
869}
870
871static int cleanup_scripting(void)
872{
873 pr_debug("\nperf script stopped\n");
874
875 return scripting_ops ? scripting_ops->stop_script() : 0;
876}
877
878static int process_sample_event(struct perf_tool *tool,
879 union perf_event *event,
880 struct perf_sample *sample,
881 struct perf_evsel *evsel,
882 struct machine *machine)
883{
884 struct perf_script *scr = container_of(tool, struct perf_script, tool);
885 struct addr_location al;
886
887 if (debug_mode) {
888 if (sample->time < last_timestamp) {
889 pr_err("Samples misordered, previous: %" PRIu64
890 " this: %" PRIu64 "\n", last_timestamp,
891 sample->time);
892 nr_unordered++;
893 }
894 last_timestamp = sample->time;
895 return 0;
896 }
897
898 if (machine__resolve(machine, &al, sample) < 0) {
899 pr_err("problem processing %d event, skipping it.\n",
900 event->header.type);
901 return -1;
902 }
903
904 if (al.filtered)
905 goto out_put;
906
907 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
908 goto out_put;
909
910 if (scripting_ops)
911 scripting_ops->process_event(event, sample, evsel, &al);
912 else
913 process_event(scr, sample, evsel, &al);
914
915out_put:
916 addr_location__put(&al);
917 return 0;
918}
919
920static int process_attr(struct perf_tool *tool, union perf_event *event,
921 struct perf_evlist **pevlist)
922{
923 struct perf_script *scr = container_of(tool, struct perf_script, tool);
924 struct perf_evlist *evlist;
925 struct perf_evsel *evsel, *pos;
926 int err;
927
928 err = perf_event__process_attr(tool, event, pevlist);
929 if (err)
930 return err;
931
932 evlist = *pevlist;
933 evsel = perf_evlist__last(*pevlist);
934
935 if (evsel->attr.type >= PERF_TYPE_MAX)
936 return 0;
937
938 evlist__for_each(evlist, pos) {
939 if (pos->attr.type == evsel->attr.type && pos != evsel)
940 return 0;
941 }
942
943 set_print_ip_opts(&evsel->attr);
944
945 if (evsel->attr.sample_type)
946 err = perf_evsel__check_attr(evsel, scr->session);
947
948 return err;
949}
950
951static int process_comm_event(struct perf_tool *tool,
952 union perf_event *event,
953 struct perf_sample *sample,
954 struct machine *machine)
955{
956 struct thread *thread;
957 struct perf_script *script = container_of(tool, struct perf_script, tool);
958 struct perf_session *session = script->session;
959 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
960 int ret = -1;
961
962 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
963 if (thread == NULL) {
964 pr_debug("problem processing COMM event, skipping it.\n");
965 return -1;
966 }
967
968 if (perf_event__process_comm(tool, event, sample, machine) < 0)
969 goto out;
970
971 if (!evsel->attr.sample_id_all) {
972 sample->cpu = 0;
973 sample->time = 0;
974 sample->tid = event->comm.tid;
975 sample->pid = event->comm.pid;
976 }
977 print_sample_start(sample, thread, evsel);
978 perf_event__fprintf(event, stdout);
979 ret = 0;
980out:
981 thread__put(thread);
982 return ret;
983}
984
985static int process_fork_event(struct perf_tool *tool,
986 union perf_event *event,
987 struct perf_sample *sample,
988 struct machine *machine)
989{
990 struct thread *thread;
991 struct perf_script *script = container_of(tool, struct perf_script, tool);
992 struct perf_session *session = script->session;
993 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
994
995 if (perf_event__process_fork(tool, event, sample, machine) < 0)
996 return -1;
997
998 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
999 if (thread == NULL) {
1000 pr_debug("problem processing FORK event, skipping it.\n");
1001 return -1;
1002 }
1003
1004 if (!evsel->attr.sample_id_all) {
1005 sample->cpu = 0;
1006 sample->time = event->fork.time;
1007 sample->tid = event->fork.tid;
1008 sample->pid = event->fork.pid;
1009 }
1010 print_sample_start(sample, thread, evsel);
1011 perf_event__fprintf(event, stdout);
1012 thread__put(thread);
1013
1014 return 0;
1015}
1016static int process_exit_event(struct perf_tool *tool,
1017 union perf_event *event,
1018 struct perf_sample *sample,
1019 struct machine *machine)
1020{
1021 int err = 0;
1022 struct thread *thread;
1023 struct perf_script *script = container_of(tool, struct perf_script, tool);
1024 struct perf_session *session = script->session;
1025 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1026
1027 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1028 if (thread == NULL) {
1029 pr_debug("problem processing EXIT event, skipping it.\n");
1030 return -1;
1031 }
1032
1033 if (!evsel->attr.sample_id_all) {
1034 sample->cpu = 0;
1035 sample->time = 0;
1036 sample->tid = event->fork.tid;
1037 sample->pid = event->fork.pid;
1038 }
1039 print_sample_start(sample, thread, evsel);
1040 perf_event__fprintf(event, stdout);
1041
1042 if (perf_event__process_exit(tool, event, sample, machine) < 0)
1043 err = -1;
1044
1045 thread__put(thread);
1046 return err;
1047}
1048
1049static int process_mmap_event(struct perf_tool *tool,
1050 union perf_event *event,
1051 struct perf_sample *sample,
1052 struct machine *machine)
1053{
1054 struct thread *thread;
1055 struct perf_script *script = container_of(tool, struct perf_script, tool);
1056 struct perf_session *session = script->session;
1057 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1058
1059 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
1060 return -1;
1061
1062 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
1063 if (thread == NULL) {
1064 pr_debug("problem processing MMAP event, skipping it.\n");
1065 return -1;
1066 }
1067
1068 if (!evsel->attr.sample_id_all) {
1069 sample->cpu = 0;
1070 sample->time = 0;
1071 sample->tid = event->mmap.tid;
1072 sample->pid = event->mmap.pid;
1073 }
1074 print_sample_start(sample, thread, evsel);
1075 perf_event__fprintf(event, stdout);
1076 thread__put(thread);
1077 return 0;
1078}
1079
1080static int process_mmap2_event(struct perf_tool *tool,
1081 union perf_event *event,
1082 struct perf_sample *sample,
1083 struct machine *machine)
1084{
1085 struct thread *thread;
1086 struct perf_script *script = container_of(tool, struct perf_script, tool);
1087 struct perf_session *session = script->session;
1088 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1089
1090 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
1091 return -1;
1092
1093 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
1094 if (thread == NULL) {
1095 pr_debug("problem processing MMAP2 event, skipping it.\n");
1096 return -1;
1097 }
1098
1099 if (!evsel->attr.sample_id_all) {
1100 sample->cpu = 0;
1101 sample->time = 0;
1102 sample->tid = event->mmap2.tid;
1103 sample->pid = event->mmap2.pid;
1104 }
1105 print_sample_start(sample, thread, evsel);
1106 perf_event__fprintf(event, stdout);
1107 thread__put(thread);
1108 return 0;
1109}
1110
1111static int process_switch_event(struct perf_tool *tool,
1112 union perf_event *event,
1113 struct perf_sample *sample,
1114 struct machine *machine)
1115{
1116 struct thread *thread;
1117 struct perf_script *script = container_of(tool, struct perf_script, tool);
1118 struct perf_session *session = script->session;
1119 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1120
1121 if (perf_event__process_switch(tool, event, sample, machine) < 0)
1122 return -1;
1123
1124 thread = machine__findnew_thread(machine, sample->pid,
1125 sample->tid);
1126 if (thread == NULL) {
1127 pr_debug("problem processing SWITCH event, skipping it.\n");
1128 return -1;
1129 }
1130
1131 print_sample_start(sample, thread, evsel);
1132 perf_event__fprintf(event, stdout);
1133 thread__put(thread);
1134 return 0;
1135}
1136
1137static void sig_handler(int sig __maybe_unused)
1138{
1139 session_done = 1;
1140}
1141
1142static int __cmd_script(struct perf_script *script)
1143{
1144 int ret;
1145
1146 signal(SIGINT, sig_handler);
1147
1148 /* override event processing functions */
1149 if (script->show_task_events) {
1150 script->tool.comm = process_comm_event;
1151 script->tool.fork = process_fork_event;
1152 script->tool.exit = process_exit_event;
1153 }
1154 if (script->show_mmap_events) {
1155 script->tool.mmap = process_mmap_event;
1156 script->tool.mmap2 = process_mmap2_event;
1157 }
1158 if (script->show_switch_events)
1159 script->tool.context_switch = process_switch_event;
1160
1161 ret = perf_session__process_events(script->session);
1162
1163 if (debug_mode)
1164 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1165
1166 return ret;
1167}
1168
1169struct script_spec {
1170 struct list_head node;
1171 struct scripting_ops *ops;
1172 char spec[0];
1173};
1174
1175static LIST_HEAD(script_specs);
1176
1177static struct script_spec *script_spec__new(const char *spec,
1178 struct scripting_ops *ops)
1179{
1180 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
1181
1182 if (s != NULL) {
1183 strcpy(s->spec, spec);
1184 s->ops = ops;
1185 }
1186
1187 return s;
1188}
1189
1190static void script_spec__add(struct script_spec *s)
1191{
1192 list_add_tail(&s->node, &script_specs);
1193}
1194
1195static struct script_spec *script_spec__find(const char *spec)
1196{
1197 struct script_spec *s;
1198
1199 list_for_each_entry(s, &script_specs, node)
1200 if (strcasecmp(s->spec, spec) == 0)
1201 return s;
1202 return NULL;
1203}
1204
1205int script_spec_register(const char *spec, struct scripting_ops *ops)
1206{
1207 struct script_spec *s;
1208
1209 s = script_spec__find(spec);
1210 if (s)
1211 return -1;
1212
1213 s = script_spec__new(spec, ops);
1214 if (!s)
1215 return -1;
1216 else
1217 script_spec__add(s);
1218
1219 return 0;
1220}
1221
1222static struct scripting_ops *script_spec__lookup(const char *spec)
1223{
1224 struct script_spec *s = script_spec__find(spec);
1225 if (!s)
1226 return NULL;
1227
1228 return s->ops;
1229}
1230
1231static void list_available_languages(void)
1232{
1233 struct script_spec *s;
1234
1235 fprintf(stderr, "\n");
1236 fprintf(stderr, "Scripting language extensions (used in "
1237 "perf script -s [spec:]script.[spec]):\n\n");
1238
1239 list_for_each_entry(s, &script_specs, node)
1240 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
1241
1242 fprintf(stderr, "\n");
1243}
1244
1245static int parse_scriptname(const struct option *opt __maybe_unused,
1246 const char *str, int unset __maybe_unused)
1247{
1248 char spec[PATH_MAX];
1249 const char *script, *ext;
1250 int len;
1251
1252 if (strcmp(str, "lang") == 0) {
1253 list_available_languages();
1254 exit(0);
1255 }
1256
1257 script = strchr(str, ':');
1258 if (script) {
1259 len = script - str;
1260 if (len >= PATH_MAX) {
1261 fprintf(stderr, "invalid language specifier");
1262 return -1;
1263 }
1264 strncpy(spec, str, len);
1265 spec[len] = '\0';
1266 scripting_ops = script_spec__lookup(spec);
1267 if (!scripting_ops) {
1268 fprintf(stderr, "invalid language specifier");
1269 return -1;
1270 }
1271 script++;
1272 } else {
1273 script = str;
1274 ext = strrchr(script, '.');
1275 if (!ext) {
1276 fprintf(stderr, "invalid script extension");
1277 return -1;
1278 }
1279 scripting_ops = script_spec__lookup(++ext);
1280 if (!scripting_ops) {
1281 fprintf(stderr, "invalid script extension");
1282 return -1;
1283 }
1284 }
1285
1286 script_name = strdup(script);
1287
1288 return 0;
1289}
1290
1291static int parse_output_fields(const struct option *opt __maybe_unused,
1292 const char *arg, int unset __maybe_unused)
1293{
1294 char *tok;
1295 int i, imax = ARRAY_SIZE(all_output_options);
1296 int j;
1297 int rc = 0;
1298 char *str = strdup(arg);
1299 int type = -1;
1300
1301 if (!str)
1302 return -ENOMEM;
1303
1304 /* first word can state for which event type the user is specifying
1305 * the fields. If no type exists, the specified fields apply to all
1306 * event types found in the file minus the invalid fields for a type.
1307 */
1308 tok = strchr(str, ':');
1309 if (tok) {
1310 *tok = '\0';
1311 tok++;
1312 if (!strcmp(str, "hw"))
1313 type = PERF_TYPE_HARDWARE;
1314 else if (!strcmp(str, "sw"))
1315 type = PERF_TYPE_SOFTWARE;
1316 else if (!strcmp(str, "trace"))
1317 type = PERF_TYPE_TRACEPOINT;
1318 else if (!strcmp(str, "raw"))
1319 type = PERF_TYPE_RAW;
1320 else if (!strcmp(str, "break"))
1321 type = PERF_TYPE_BREAKPOINT;
1322 else {
1323 fprintf(stderr, "Invalid event type in field string.\n");
1324 rc = -EINVAL;
1325 goto out;
1326 }
1327
1328 if (output[type].user_set)
1329 pr_warning("Overriding previous field request for %s events.\n",
1330 event_type(type));
1331
1332 output[type].fields = 0;
1333 output[type].user_set = true;
1334 output[type].wildcard_set = false;
1335
1336 } else {
1337 tok = str;
1338 if (strlen(str) == 0) {
1339 fprintf(stderr,
1340 "Cannot set fields to 'none' for all event types.\n");
1341 rc = -EINVAL;
1342 goto out;
1343 }
1344
1345 if (output_set_by_user())
1346 pr_warning("Overriding previous field request for all events.\n");
1347
1348 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1349 output[j].fields = 0;
1350 output[j].user_set = true;
1351 output[j].wildcard_set = true;
1352 }
1353 }
1354
1355 for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
1356 for (i = 0; i < imax; ++i) {
1357 if (strcmp(tok, all_output_options[i].str) == 0)
1358 break;
1359 }
1360 if (i == imax && strcmp(tok, "flags") == 0) {
1361 print_flags = true;
1362 continue;
1363 }
1364 if (i == imax) {
1365 fprintf(stderr, "Invalid field requested.\n");
1366 rc = -EINVAL;
1367 goto out;
1368 }
1369
1370 if (type == -1) {
1371 /* add user option to all events types for
1372 * which it is valid
1373 */
1374 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1375 if (output[j].invalid_fields & all_output_options[i].field) {
1376 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1377 all_output_options[i].str, event_type(j));
1378 } else
1379 output[j].fields |= all_output_options[i].field;
1380 }
1381 } else {
1382 if (output[type].invalid_fields & all_output_options[i].field) {
1383 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1384 all_output_options[i].str, event_type(type));
1385
1386 rc = -EINVAL;
1387 goto out;
1388 }
1389 output[type].fields |= all_output_options[i].field;
1390 }
1391 }
1392
1393 if (type >= 0) {
1394 if (output[type].fields == 0) {
1395 pr_debug("No fields requested for %s type. "
1396 "Events will not be displayed.\n", event_type(type));
1397 }
1398 }
1399
1400out:
1401 free(str);
1402 return rc;
1403}
1404
1405/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1406static int is_directory(const char *base_path, const struct dirent *dent)
1407{
1408 char path[PATH_MAX];
1409 struct stat st;
1410
1411 sprintf(path, "%s/%s", base_path, dent->d_name);
1412 if (stat(path, &st))
1413 return 0;
1414
1415 return S_ISDIR(st.st_mode);
1416}
1417
1418#define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
1419 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
1420 if ((lang_dirent->d_type == DT_DIR || \
1421 (lang_dirent->d_type == DT_UNKNOWN && \
1422 is_directory(scripts_path, lang_dirent))) && \
1423 (strcmp(lang_dirent->d_name, ".")) && \
1424 (strcmp(lang_dirent->d_name, "..")))
1425
1426#define for_each_script(lang_path, lang_dir, script_dirent) \
1427 while ((script_dirent = readdir(lang_dir)) != NULL) \
1428 if (script_dirent->d_type != DT_DIR && \
1429 (script_dirent->d_type != DT_UNKNOWN || \
1430 !is_directory(lang_path, script_dirent)))
1431
1432
1433#define RECORD_SUFFIX "-record"
1434#define REPORT_SUFFIX "-report"
1435
1436struct script_desc {
1437 struct list_head node;
1438 char *name;
1439 char *half_liner;
1440 char *args;
1441};
1442
1443static LIST_HEAD(script_descs);
1444
1445static struct script_desc *script_desc__new(const char *name)
1446{
1447 struct script_desc *s = zalloc(sizeof(*s));
1448
1449 if (s != NULL && name)
1450 s->name = strdup(name);
1451
1452 return s;
1453}
1454
1455static void script_desc__delete(struct script_desc *s)
1456{
1457 zfree(&s->name);
1458 zfree(&s->half_liner);
1459 zfree(&s->args);
1460 free(s);
1461}
1462
1463static void script_desc__add(struct script_desc *s)
1464{
1465 list_add_tail(&s->node, &script_descs);
1466}
1467
1468static struct script_desc *script_desc__find(const char *name)
1469{
1470 struct script_desc *s;
1471
1472 list_for_each_entry(s, &script_descs, node)
1473 if (strcasecmp(s->name, name) == 0)
1474 return s;
1475 return NULL;
1476}
1477
1478static struct script_desc *script_desc__findnew(const char *name)
1479{
1480 struct script_desc *s = script_desc__find(name);
1481
1482 if (s)
1483 return s;
1484
1485 s = script_desc__new(name);
1486 if (!s)
1487 goto out_delete_desc;
1488
1489 script_desc__add(s);
1490
1491 return s;
1492
1493out_delete_desc:
1494 script_desc__delete(s);
1495
1496 return NULL;
1497}
1498
1499static const char *ends_with(const char *str, const char *suffix)
1500{
1501 size_t suffix_len = strlen(suffix);
1502 const char *p = str;
1503
1504 if (strlen(str) > suffix_len) {
1505 p = str + strlen(str) - suffix_len;
1506 if (!strncmp(p, suffix, suffix_len))
1507 return p;
1508 }
1509
1510 return NULL;
1511}
1512
1513static int read_script_info(struct script_desc *desc, const char *filename)
1514{
1515 char line[BUFSIZ], *p;
1516 FILE *fp;
1517
1518 fp = fopen(filename, "r");
1519 if (!fp)
1520 return -1;
1521
1522 while (fgets(line, sizeof(line), fp)) {
1523 p = ltrim(line);
1524 if (strlen(p) == 0)
1525 continue;
1526 if (*p != '#')
1527 continue;
1528 p++;
1529 if (strlen(p) && *p == '!')
1530 continue;
1531
1532 p = ltrim(p);
1533 if (strlen(p) && p[strlen(p) - 1] == '\n')
1534 p[strlen(p) - 1] = '\0';
1535
1536 if (!strncmp(p, "description:", strlen("description:"))) {
1537 p += strlen("description:");
1538 desc->half_liner = strdup(ltrim(p));
1539 continue;
1540 }
1541
1542 if (!strncmp(p, "args:", strlen("args:"))) {
1543 p += strlen("args:");
1544 desc->args = strdup(ltrim(p));
1545 continue;
1546 }
1547 }
1548
1549 fclose(fp);
1550
1551 return 0;
1552}
1553
1554static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1555{
1556 char *script_root, *str;
1557
1558 script_root = strdup(script_dirent->d_name);
1559 if (!script_root)
1560 return NULL;
1561
1562 str = (char *)ends_with(script_root, suffix);
1563 if (!str) {
1564 free(script_root);
1565 return NULL;
1566 }
1567
1568 *str = '\0';
1569 return script_root;
1570}
1571
1572static int list_available_scripts(const struct option *opt __maybe_unused,
1573 const char *s __maybe_unused,
1574 int unset __maybe_unused)
1575{
1576 struct dirent *script_dirent, *lang_dirent;
1577 char scripts_path[MAXPATHLEN];
1578 DIR *scripts_dir, *lang_dir;
1579 char script_path[MAXPATHLEN];
1580 char lang_path[MAXPATHLEN];
1581 struct script_desc *desc;
1582 char first_half[BUFSIZ];
1583 char *script_root;
1584
1585 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1586
1587 scripts_dir = opendir(scripts_path);
1588 if (!scripts_dir)
1589 return -1;
1590
1591 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1592 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1593 lang_dirent->d_name);
1594 lang_dir = opendir(lang_path);
1595 if (!lang_dir)
1596 continue;
1597
1598 for_each_script(lang_path, lang_dir, script_dirent) {
1599 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
1600 if (script_root) {
1601 desc = script_desc__findnew(script_root);
1602 snprintf(script_path, MAXPATHLEN, "%s/%s",
1603 lang_path, script_dirent->d_name);
1604 read_script_info(desc, script_path);
1605 free(script_root);
1606 }
1607 }
1608 }
1609
1610 fprintf(stdout, "List of available trace scripts:\n");
1611 list_for_each_entry(desc, &script_descs, node) {
1612 sprintf(first_half, "%s %s", desc->name,
1613 desc->args ? desc->args : "");
1614 fprintf(stdout, " %-36s %s\n", first_half,
1615 desc->half_liner ? desc->half_liner : "");
1616 }
1617
1618 exit(0);
1619}
1620
1621/*
1622 * Some scripts specify the required events in their "xxx-record" file,
1623 * this function will check if the events in perf.data match those
1624 * mentioned in the "xxx-record".
1625 *
1626 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1627 * which is covered well now. And new parsing code should be added to
1628 * cover the future complexing formats like event groups etc.
1629 */
1630static int check_ev_match(char *dir_name, char *scriptname,
1631 struct perf_session *session)
1632{
1633 char filename[MAXPATHLEN], evname[128];
1634 char line[BUFSIZ], *p;
1635 struct perf_evsel *pos;
1636 int match, len;
1637 FILE *fp;
1638
1639 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1640
1641 fp = fopen(filename, "r");
1642 if (!fp)
1643 return -1;
1644
1645 while (fgets(line, sizeof(line), fp)) {
1646 p = ltrim(line);
1647 if (*p == '#')
1648 continue;
1649
1650 while (strlen(p)) {
1651 p = strstr(p, "-e");
1652 if (!p)
1653 break;
1654
1655 p += 2;
1656 p = ltrim(p);
1657 len = strcspn(p, " \t");
1658 if (!len)
1659 break;
1660
1661 snprintf(evname, len + 1, "%s", p);
1662
1663 match = 0;
1664 evlist__for_each(session->evlist, pos) {
1665 if (!strcmp(perf_evsel__name(pos), evname)) {
1666 match = 1;
1667 break;
1668 }
1669 }
1670
1671 if (!match) {
1672 fclose(fp);
1673 return -1;
1674 }
1675 }
1676 }
1677
1678 fclose(fp);
1679 return 0;
1680}
1681
1682/*
1683 * Return -1 if none is found, otherwise the actual scripts number.
1684 *
1685 * Currently the only user of this function is the script browser, which
1686 * will list all statically runnable scripts, select one, execute it and
1687 * show the output in a perf browser.
1688 */
1689int find_scripts(char **scripts_array, char **scripts_path_array)
1690{
1691 struct dirent *script_dirent, *lang_dirent;
1692 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1693 DIR *scripts_dir, *lang_dir;
1694 struct perf_session *session;
1695 struct perf_data_file file = {
1696 .path = input_name,
1697 .mode = PERF_DATA_MODE_READ,
1698 };
1699 char *temp;
1700 int i = 0;
1701
1702 session = perf_session__new(&file, false, NULL);
1703 if (!session)
1704 return -1;
1705
1706 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1707
1708 scripts_dir = opendir(scripts_path);
1709 if (!scripts_dir) {
1710 perf_session__delete(session);
1711 return -1;
1712 }
1713
1714 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1715 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1716 lang_dirent->d_name);
1717#ifdef NO_LIBPERL
1718 if (strstr(lang_path, "perl"))
1719 continue;
1720#endif
1721#ifdef NO_LIBPYTHON
1722 if (strstr(lang_path, "python"))
1723 continue;
1724#endif
1725
1726 lang_dir = opendir(lang_path);
1727 if (!lang_dir)
1728 continue;
1729
1730 for_each_script(lang_path, lang_dir, script_dirent) {
1731 /* Skip those real time scripts: xxxtop.p[yl] */
1732 if (strstr(script_dirent->d_name, "top."))
1733 continue;
1734 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1735 script_dirent->d_name);
1736 temp = strchr(script_dirent->d_name, '.');
1737 snprintf(scripts_array[i],
1738 (temp - script_dirent->d_name) + 1,
1739 "%s", script_dirent->d_name);
1740
1741 if (check_ev_match(lang_path,
1742 scripts_array[i], session))
1743 continue;
1744
1745 i++;
1746 }
1747 closedir(lang_dir);
1748 }
1749
1750 closedir(scripts_dir);
1751 perf_session__delete(session);
1752 return i;
1753}
1754
1755static char *get_script_path(const char *script_root, const char *suffix)
1756{
1757 struct dirent *script_dirent, *lang_dirent;
1758 char scripts_path[MAXPATHLEN];
1759 char script_path[MAXPATHLEN];
1760 DIR *scripts_dir, *lang_dir;
1761 char lang_path[MAXPATHLEN];
1762 char *__script_root;
1763
1764 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1765
1766 scripts_dir = opendir(scripts_path);
1767 if (!scripts_dir)
1768 return NULL;
1769
1770 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1771 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1772 lang_dirent->d_name);
1773 lang_dir = opendir(lang_path);
1774 if (!lang_dir)
1775 continue;
1776
1777 for_each_script(lang_path, lang_dir, script_dirent) {
1778 __script_root = get_script_root(script_dirent, suffix);
1779 if (__script_root && !strcmp(script_root, __script_root)) {
1780 free(__script_root);
1781 closedir(lang_dir);
1782 closedir(scripts_dir);
1783 snprintf(script_path, MAXPATHLEN, "%s/%s",
1784 lang_path, script_dirent->d_name);
1785 return strdup(script_path);
1786 }
1787 free(__script_root);
1788 }
1789 closedir(lang_dir);
1790 }
1791 closedir(scripts_dir);
1792
1793 return NULL;
1794}
1795
1796static bool is_top_script(const char *script_path)
1797{
1798 return ends_with(script_path, "top") == NULL ? false : true;
1799}
1800
1801static int has_required_arg(char *script_path)
1802{
1803 struct script_desc *desc;
1804 int n_args = 0;
1805 char *p;
1806
1807 desc = script_desc__new(NULL);
1808
1809 if (read_script_info(desc, script_path))
1810 goto out;
1811
1812 if (!desc->args)
1813 goto out;
1814
1815 for (p = desc->args; *p; p++)
1816 if (*p == '<')
1817 n_args++;
1818out:
1819 script_desc__delete(desc);
1820
1821 return n_args;
1822}
1823
1824static int have_cmd(int argc, const char **argv)
1825{
1826 char **__argv = malloc(sizeof(const char *) * argc);
1827
1828 if (!__argv) {
1829 pr_err("malloc failed\n");
1830 return -1;
1831 }
1832
1833 memcpy(__argv, argv, sizeof(const char *) * argc);
1834 argc = parse_options(argc, (const char **)__argv, record_options,
1835 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1836 free(__argv);
1837
1838 system_wide = (argc == 0);
1839
1840 return 0;
1841}
1842
1843static void script__setup_sample_type(struct perf_script *script)
1844{
1845 struct perf_session *session = script->session;
1846 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
1847
1848 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
1849 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
1850 (sample_type & PERF_SAMPLE_STACK_USER))
1851 callchain_param.record_mode = CALLCHAIN_DWARF;
1852 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
1853 callchain_param.record_mode = CALLCHAIN_LBR;
1854 else
1855 callchain_param.record_mode = CALLCHAIN_FP;
1856 }
1857}
1858
1859static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
1860 union perf_event *event,
1861 struct perf_session *session)
1862{
1863 struct stat_round_event *round = &event->stat_round;
1864 struct perf_evsel *counter;
1865
1866 evlist__for_each(session->evlist, counter) {
1867 perf_stat_process_counter(&stat_config, counter);
1868 process_stat(counter, round->time);
1869 }
1870
1871 process_stat_interval(round->time);
1872 return 0;
1873}
1874
1875static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
1876 union perf_event *event,
1877 struct perf_session *session __maybe_unused)
1878{
1879 perf_event__read_stat_config(&stat_config, &event->stat_config);
1880 return 0;
1881}
1882
1883static int set_maps(struct perf_script *script)
1884{
1885 struct perf_evlist *evlist = script->session->evlist;
1886
1887 if (!script->cpus || !script->threads)
1888 return 0;
1889
1890 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
1891 return -EINVAL;
1892
1893 perf_evlist__set_maps(evlist, script->cpus, script->threads);
1894
1895 if (perf_evlist__alloc_stats(evlist, true))
1896 return -ENOMEM;
1897
1898 script->allocated = true;
1899 return 0;
1900}
1901
1902static
1903int process_thread_map_event(struct perf_tool *tool,
1904 union perf_event *event,
1905 struct perf_session *session __maybe_unused)
1906{
1907 struct perf_script *script = container_of(tool, struct perf_script, tool);
1908
1909 if (script->threads) {
1910 pr_warning("Extra thread map event, ignoring.\n");
1911 return 0;
1912 }
1913
1914 script->threads = thread_map__new_event(&event->thread_map);
1915 if (!script->threads)
1916 return -ENOMEM;
1917
1918 return set_maps(script);
1919}
1920
1921static
1922int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
1923 union perf_event *event,
1924 struct perf_session *session __maybe_unused)
1925{
1926 struct perf_script *script = container_of(tool, struct perf_script, tool);
1927
1928 if (script->cpus) {
1929 pr_warning("Extra cpu map event, ignoring.\n");
1930 return 0;
1931 }
1932
1933 script->cpus = cpu_map__new_data(&event->cpu_map.data);
1934 if (!script->cpus)
1935 return -ENOMEM;
1936
1937 return set_maps(script);
1938}
1939
1940int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1941{
1942 bool show_full_info = false;
1943 bool header = false;
1944 bool header_only = false;
1945 bool script_started = false;
1946 char *rec_script_path = NULL;
1947 char *rep_script_path = NULL;
1948 struct perf_session *session;
1949 struct itrace_synth_opts itrace_synth_opts = { .set = false, };
1950 char *script_path = NULL;
1951 const char **__argv;
1952 int i, j, err = 0;
1953 struct perf_script script = {
1954 .tool = {
1955 .sample = process_sample_event,
1956 .mmap = perf_event__process_mmap,
1957 .mmap2 = perf_event__process_mmap2,
1958 .comm = perf_event__process_comm,
1959 .exit = perf_event__process_exit,
1960 .fork = perf_event__process_fork,
1961 .attr = process_attr,
1962 .tracing_data = perf_event__process_tracing_data,
1963 .build_id = perf_event__process_build_id,
1964 .id_index = perf_event__process_id_index,
1965 .auxtrace_info = perf_event__process_auxtrace_info,
1966 .auxtrace = perf_event__process_auxtrace,
1967 .auxtrace_error = perf_event__process_auxtrace_error,
1968 .stat = perf_event__process_stat_event,
1969 .stat_round = process_stat_round_event,
1970 .stat_config = process_stat_config_event,
1971 .thread_map = process_thread_map_event,
1972 .cpu_map = process_cpu_map_event,
1973 .ordered_events = true,
1974 .ordering_requires_timestamps = true,
1975 },
1976 };
1977 struct perf_data_file file = {
1978 .mode = PERF_DATA_MODE_READ,
1979 };
1980 const struct option options[] = {
1981 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1982 "dump raw trace in ASCII"),
1983 OPT_INCR('v', "verbose", &verbose,
1984 "be more verbose (show symbol address, etc)"),
1985 OPT_BOOLEAN('L', "Latency", &latency_format,
1986 "show latency attributes (irqs/preemption disabled, etc)"),
1987 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1988 list_available_scripts),
1989 OPT_CALLBACK('s', "script", NULL, "name",
1990 "script file name (lang:script name, script name, or *)",
1991 parse_scriptname),
1992 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1993 "generate perf-script.xx script in specified language"),
1994 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1995 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1996 "do various checks like samples ordering and lost events"),
1997 OPT_BOOLEAN(0, "header", &header, "Show data header."),
1998 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1999 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2000 "file", "vmlinux pathname"),
2001 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
2002 "file", "kallsyms pathname"),
2003 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
2004 "When printing symbols do not display call chain"),
2005 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
2006 "Look for files with symbols relative to this directory"),
2007 OPT_CALLBACK('F', "fields", NULL, "str",
2008 "comma separated output fields prepend with 'type:'. "
2009 "Valid types: hw,sw,trace,raw. "
2010 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2011 "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields),
2012 OPT_BOOLEAN('a', "all-cpus", &system_wide,
2013 "system-wide collection from all CPUs"),
2014 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
2015 "only consider these symbols"),
2016 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
2017 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
2018 "only display events for these comms"),
2019 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
2020 "only consider symbols in these pids"),
2021 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
2022 "only consider symbols in these tids"),
2023 OPT_BOOLEAN('I', "show-info", &show_full_info,
2024 "display extended information from perf.data file"),
2025 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
2026 "Show the path of [kernel.kallsyms]"),
2027 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
2028 "Show the fork/comm/exit events"),
2029 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
2030 "Show the mmap events"),
2031 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
2032 "Show context switch events (if recorded)"),
2033 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
2034 OPT_BOOLEAN(0, "ns", &nanosecs,
2035 "Use 9 decimal places when displaying time"),
2036 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
2037 "Instruction Tracing options",
2038 itrace_parse_synth_opts),
2039 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
2040 "Show full source file name path for source lines"),
2041 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
2042 "Enable symbol demangling"),
2043 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
2044 "Enable kernel symbol demangling"),
2045
2046 OPT_END()
2047 };
2048 const char * const script_subcommands[] = { "record", "report", NULL };
2049 const char *script_usage[] = {
2050 "perf script [<options>]",
2051 "perf script [<options>] record <script> [<record-options>] <command>",
2052 "perf script [<options>] report <script> [script-args]",
2053 "perf script [<options>] <script> [<record-options>] <command>",
2054 "perf script [<options>] <top-script> [script-args]",
2055 NULL
2056 };
2057
2058 setup_scripting();
2059
2060 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
2061 PARSE_OPT_STOP_AT_NON_OPTION);
2062
2063 file.path = input_name;
2064
2065 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
2066 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
2067 if (!rec_script_path)
2068 return cmd_record(argc, argv, NULL);
2069 }
2070
2071 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
2072 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
2073 if (!rep_script_path) {
2074 fprintf(stderr,
2075 "Please specify a valid report script"
2076 "(see 'perf script -l' for listing)\n");
2077 return -1;
2078 }
2079 }
2080
2081 if (itrace_synth_opts.callchain &&
2082 itrace_synth_opts.callchain_sz > scripting_max_stack)
2083 scripting_max_stack = itrace_synth_opts.callchain_sz;
2084
2085 /* make sure PERF_EXEC_PATH is set for scripts */
2086 set_argv_exec_path(get_argv_exec_path());
2087
2088 if (argc && !script_name && !rec_script_path && !rep_script_path) {
2089 int live_pipe[2];
2090 int rep_args;
2091 pid_t pid;
2092
2093 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
2094 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
2095
2096 if (!rec_script_path && !rep_script_path) {
2097 usage_with_options_msg(script_usage, options,
2098 "Couldn't find script `%s'\n\n See perf"
2099 " script -l for available scripts.\n", argv[0]);
2100 }
2101
2102 if (is_top_script(argv[0])) {
2103 rep_args = argc - 1;
2104 } else {
2105 int rec_args;
2106
2107 rep_args = has_required_arg(rep_script_path);
2108 rec_args = (argc - 1) - rep_args;
2109 if (rec_args < 0) {
2110 usage_with_options_msg(script_usage, options,
2111 "`%s' script requires options."
2112 "\n\n See perf script -l for available "
2113 "scripts and options.\n", argv[0]);
2114 }
2115 }
2116
2117 if (pipe(live_pipe) < 0) {
2118 perror("failed to create pipe");
2119 return -1;
2120 }
2121
2122 pid = fork();
2123 if (pid < 0) {
2124 perror("failed to fork");
2125 return -1;
2126 }
2127
2128 if (!pid) {
2129 j = 0;
2130
2131 dup2(live_pipe[1], 1);
2132 close(live_pipe[0]);
2133
2134 if (is_top_script(argv[0])) {
2135 system_wide = true;
2136 } else if (!system_wide) {
2137 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
2138 err = -1;
2139 goto out;
2140 }
2141 }
2142
2143 __argv = malloc((argc + 6) * sizeof(const char *));
2144 if (!__argv) {
2145 pr_err("malloc failed\n");
2146 err = -ENOMEM;
2147 goto out;
2148 }
2149
2150 __argv[j++] = "/bin/sh";
2151 __argv[j++] = rec_script_path;
2152 if (system_wide)
2153 __argv[j++] = "-a";
2154 __argv[j++] = "-q";
2155 __argv[j++] = "-o";
2156 __argv[j++] = "-";
2157 for (i = rep_args + 1; i < argc; i++)
2158 __argv[j++] = argv[i];
2159 __argv[j++] = NULL;
2160
2161 execvp("/bin/sh", (char **)__argv);
2162 free(__argv);
2163 exit(-1);
2164 }
2165
2166 dup2(live_pipe[0], 0);
2167 close(live_pipe[1]);
2168
2169 __argv = malloc((argc + 4) * sizeof(const char *));
2170 if (!__argv) {
2171 pr_err("malloc failed\n");
2172 err = -ENOMEM;
2173 goto out;
2174 }
2175
2176 j = 0;
2177 __argv[j++] = "/bin/sh";
2178 __argv[j++] = rep_script_path;
2179 for (i = 1; i < rep_args + 1; i++)
2180 __argv[j++] = argv[i];
2181 __argv[j++] = "-i";
2182 __argv[j++] = "-";
2183 __argv[j++] = NULL;
2184
2185 execvp("/bin/sh", (char **)__argv);
2186 free(__argv);
2187 exit(-1);
2188 }
2189
2190 if (rec_script_path)
2191 script_path = rec_script_path;
2192 if (rep_script_path)
2193 script_path = rep_script_path;
2194
2195 if (script_path) {
2196 j = 0;
2197
2198 if (!rec_script_path)
2199 system_wide = false;
2200 else if (!system_wide) {
2201 if (have_cmd(argc - 1, &argv[1]) != 0) {
2202 err = -1;
2203 goto out;
2204 }
2205 }
2206
2207 __argv = malloc((argc + 2) * sizeof(const char *));
2208 if (!__argv) {
2209 pr_err("malloc failed\n");
2210 err = -ENOMEM;
2211 goto out;
2212 }
2213
2214 __argv[j++] = "/bin/sh";
2215 __argv[j++] = script_path;
2216 if (system_wide)
2217 __argv[j++] = "-a";
2218 for (i = 2; i < argc; i++)
2219 __argv[j++] = argv[i];
2220 __argv[j++] = NULL;
2221
2222 execvp("/bin/sh", (char **)__argv);
2223 free(__argv);
2224 exit(-1);
2225 }
2226
2227 if (!script_name)
2228 setup_pager();
2229
2230 session = perf_session__new(&file, false, &script.tool);
2231 if (session == NULL)
2232 return -1;
2233
2234 if (header || header_only) {
2235 perf_session__fprintf_info(session, stdout, show_full_info);
2236 if (header_only)
2237 goto out_delete;
2238 }
2239
2240 if (symbol__init(&session->header.env) < 0)
2241 goto out_delete;
2242
2243 script.session = session;
2244 script__setup_sample_type(&script);
2245
2246 session->itrace_synth_opts = &itrace_synth_opts;
2247
2248 if (cpu_list) {
2249 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
2250 if (err < 0)
2251 goto out_delete;
2252 }
2253
2254 if (!no_callchain)
2255 symbol_conf.use_callchain = true;
2256 else
2257 symbol_conf.use_callchain = false;
2258
2259 if (session->tevent.pevent &&
2260 pevent_set_function_resolver(session->tevent.pevent,
2261 machine__resolve_kernel_addr,
2262 &session->machines.host) < 0) {
2263 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
2264 return -1;
2265 }
2266
2267 if (generate_script_lang) {
2268 struct stat perf_stat;
2269 int input;
2270
2271 if (output_set_by_user()) {
2272 fprintf(stderr,
2273 "custom fields not supported for generated scripts");
2274 err = -EINVAL;
2275 goto out_delete;
2276 }
2277
2278 input = open(file.path, O_RDONLY); /* input_name */
2279 if (input < 0) {
2280 err = -errno;
2281 perror("failed to open file");
2282 goto out_delete;
2283 }
2284
2285 err = fstat(input, &perf_stat);
2286 if (err < 0) {
2287 perror("failed to stat file");
2288 goto out_delete;
2289 }
2290
2291 if (!perf_stat.st_size) {
2292 fprintf(stderr, "zero-sized file, nothing to do!\n");
2293 goto out_delete;
2294 }
2295
2296 scripting_ops = script_spec__lookup(generate_script_lang);
2297 if (!scripting_ops) {
2298 fprintf(stderr, "invalid language specifier");
2299 err = -ENOENT;
2300 goto out_delete;
2301 }
2302
2303 err = scripting_ops->generate_script(session->tevent.pevent,
2304 "perf-script");
2305 goto out_delete;
2306 }
2307
2308 if (script_name) {
2309 err = scripting_ops->start_script(script_name, argc, argv);
2310 if (err)
2311 goto out_delete;
2312 pr_debug("perf script started with script %s\n\n", script_name);
2313 script_started = true;
2314 }
2315
2316
2317 err = perf_session__check_output_opt(session);
2318 if (err < 0)
2319 goto out_delete;
2320
2321 err = __cmd_script(&script);
2322
2323 flush_scripting();
2324
2325out_delete:
2326 perf_evlist__free_stats(session->evlist);
2327 perf_session__delete(session);
2328
2329 if (script_started)
2330 cleanup_scripting();
2331out:
2332 return err;
2333}
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/tool.h"
11#include "util/symbol.h"
12#include "util/thread.h"
13#include "util/trace-event.h"
14#include "util/util.h"
15#include "util/evlist.h"
16#include "util/evsel.h"
17#include <linux/bitmap.h>
18
19static char const *script_name;
20static char const *generate_script_lang;
21static bool debug_mode;
22static u64 last_timestamp;
23static u64 nr_unordered;
24extern const struct option record_options[];
25static bool no_callchain;
26static bool show_full_info;
27static bool system_wide;
28static const char *cpu_list;
29static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
30
31enum perf_output_field {
32 PERF_OUTPUT_COMM = 1U << 0,
33 PERF_OUTPUT_TID = 1U << 1,
34 PERF_OUTPUT_PID = 1U << 2,
35 PERF_OUTPUT_TIME = 1U << 3,
36 PERF_OUTPUT_CPU = 1U << 4,
37 PERF_OUTPUT_EVNAME = 1U << 5,
38 PERF_OUTPUT_TRACE = 1U << 6,
39 PERF_OUTPUT_IP = 1U << 7,
40 PERF_OUTPUT_SYM = 1U << 8,
41 PERF_OUTPUT_DSO = 1U << 9,
42 PERF_OUTPUT_ADDR = 1U << 10,
43 PERF_OUTPUT_SYMOFFSET = 1U << 11,
44};
45
46struct output_option {
47 const char *str;
48 enum perf_output_field field;
49} all_output_options[] = {
50 {.str = "comm", .field = PERF_OUTPUT_COMM},
51 {.str = "tid", .field = PERF_OUTPUT_TID},
52 {.str = "pid", .field = PERF_OUTPUT_PID},
53 {.str = "time", .field = PERF_OUTPUT_TIME},
54 {.str = "cpu", .field = PERF_OUTPUT_CPU},
55 {.str = "event", .field = PERF_OUTPUT_EVNAME},
56 {.str = "trace", .field = PERF_OUTPUT_TRACE},
57 {.str = "ip", .field = PERF_OUTPUT_IP},
58 {.str = "sym", .field = PERF_OUTPUT_SYM},
59 {.str = "dso", .field = PERF_OUTPUT_DSO},
60 {.str = "addr", .field = PERF_OUTPUT_ADDR},
61 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
62};
63
64/* default set to maintain compatibility with current format */
65static struct {
66 bool user_set;
67 bool wildcard_set;
68 u64 fields;
69 u64 invalid_fields;
70} output[PERF_TYPE_MAX] = {
71
72 [PERF_TYPE_HARDWARE] = {
73 .user_set = false,
74
75 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
76 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
77 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
78 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
79
80 .invalid_fields = PERF_OUTPUT_TRACE,
81 },
82
83 [PERF_TYPE_SOFTWARE] = {
84 .user_set = false,
85
86 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
87 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
88 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
89 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
90
91 .invalid_fields = PERF_OUTPUT_TRACE,
92 },
93
94 [PERF_TYPE_TRACEPOINT] = {
95 .user_set = false,
96
97 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
98 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
99 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
100 },
101
102 [PERF_TYPE_RAW] = {
103 .user_set = false,
104
105 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
106 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
107 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
108 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
109
110 .invalid_fields = PERF_OUTPUT_TRACE,
111 },
112};
113
114static bool output_set_by_user(void)
115{
116 int j;
117 for (j = 0; j < PERF_TYPE_MAX; ++j) {
118 if (output[j].user_set)
119 return true;
120 }
121 return false;
122}
123
124static const char *output_field2str(enum perf_output_field field)
125{
126 int i, imax = ARRAY_SIZE(all_output_options);
127 const char *str = "";
128
129 for (i = 0; i < imax; ++i) {
130 if (all_output_options[i].field == field) {
131 str = all_output_options[i].str;
132 break;
133 }
134 }
135 return str;
136}
137
138#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
139
140static int perf_event_attr__check_stype(struct perf_event_attr *attr,
141 u64 sample_type, const char *sample_msg,
142 enum perf_output_field field)
143{
144 int type = attr->type;
145 const char *evname;
146
147 if (attr->sample_type & sample_type)
148 return 0;
149
150 if (output[type].user_set) {
151 evname = __event_name(attr->type, attr->config);
152 pr_err("Samples for '%s' event do not have %s attribute set. "
153 "Cannot print '%s' field.\n",
154 evname, sample_msg, output_field2str(field));
155 return -1;
156 }
157
158 /* user did not ask for it explicitly so remove from the default list */
159 output[type].fields &= ~field;
160 evname = __event_name(attr->type, attr->config);
161 pr_debug("Samples for '%s' event do not have %s attribute set. "
162 "Skipping '%s' field.\n",
163 evname, sample_msg, output_field2str(field));
164
165 return 0;
166}
167
168static int perf_evsel__check_attr(struct perf_evsel *evsel,
169 struct perf_session *session)
170{
171 struct perf_event_attr *attr = &evsel->attr;
172
173 if (PRINT_FIELD(TRACE) &&
174 !perf_session__has_traces(session, "record -R"))
175 return -EINVAL;
176
177 if (PRINT_FIELD(IP)) {
178 if (perf_event_attr__check_stype(attr, PERF_SAMPLE_IP, "IP",
179 PERF_OUTPUT_IP))
180 return -EINVAL;
181
182 if (!no_callchain &&
183 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
184 symbol_conf.use_callchain = false;
185 }
186
187 if (PRINT_FIELD(ADDR) &&
188 perf_event_attr__check_stype(attr, PERF_SAMPLE_ADDR, "ADDR",
189 PERF_OUTPUT_ADDR))
190 return -EINVAL;
191
192 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
193 pr_err("Display of symbols requested but neither sample IP nor "
194 "sample address\nis selected. Hence, no addresses to convert "
195 "to symbols.\n");
196 return -EINVAL;
197 }
198 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
199 pr_err("Display of offsets requested but symbol is not"
200 "selected.\n");
201 return -EINVAL;
202 }
203 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
204 pr_err("Display of DSO requested but neither sample IP nor "
205 "sample address\nis selected. Hence, no addresses to convert "
206 "to DSO.\n");
207 return -EINVAL;
208 }
209
210 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
211 perf_event_attr__check_stype(attr, PERF_SAMPLE_TID, "TID",
212 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
213 return -EINVAL;
214
215 if (PRINT_FIELD(TIME) &&
216 perf_event_attr__check_stype(attr, PERF_SAMPLE_TIME, "TIME",
217 PERF_OUTPUT_TIME))
218 return -EINVAL;
219
220 if (PRINT_FIELD(CPU) &&
221 perf_event_attr__check_stype(attr, PERF_SAMPLE_CPU, "CPU",
222 PERF_OUTPUT_CPU))
223 return -EINVAL;
224
225 return 0;
226}
227
228/*
229 * verify all user requested events exist and the samples
230 * have the expected data
231 */
232static int perf_session__check_output_opt(struct perf_session *session)
233{
234 int j;
235 struct perf_evsel *evsel;
236
237 for (j = 0; j < PERF_TYPE_MAX; ++j) {
238 evsel = perf_session__find_first_evtype(session, j);
239
240 /*
241 * even if fields is set to 0 (ie., show nothing) event must
242 * exist if user explicitly includes it on the command line
243 */
244 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
245 pr_err("%s events do not exist. "
246 "Remove corresponding -f option to proceed.\n",
247 event_type(j));
248 return -1;
249 }
250
251 if (evsel && output[j].fields &&
252 perf_evsel__check_attr(evsel, session))
253 return -1;
254 }
255
256 return 0;
257}
258
259static void print_sample_start(struct perf_sample *sample,
260 struct thread *thread,
261 struct perf_event_attr *attr)
262{
263 int type;
264 struct event_format *event;
265 const char *evname = NULL;
266 unsigned long secs;
267 unsigned long usecs;
268 unsigned long long nsecs;
269
270 if (PRINT_FIELD(COMM)) {
271 if (latency_format)
272 printf("%8.8s ", thread->comm);
273 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
274 printf("%s ", thread->comm);
275 else
276 printf("%16s ", thread->comm);
277 }
278
279 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
280 printf("%5d/%-5d ", sample->pid, sample->tid);
281 else if (PRINT_FIELD(PID))
282 printf("%5d ", sample->pid);
283 else if (PRINT_FIELD(TID))
284 printf("%5d ", sample->tid);
285
286 if (PRINT_FIELD(CPU)) {
287 if (latency_format)
288 printf("%3d ", sample->cpu);
289 else
290 printf("[%03d] ", sample->cpu);
291 }
292
293 if (PRINT_FIELD(TIME)) {
294 nsecs = sample->time;
295 secs = nsecs / NSECS_PER_SEC;
296 nsecs -= secs * NSECS_PER_SEC;
297 usecs = nsecs / NSECS_PER_USEC;
298 printf("%5lu.%06lu: ", secs, usecs);
299 }
300
301 if (PRINT_FIELD(EVNAME)) {
302 if (attr->type == PERF_TYPE_TRACEPOINT) {
303 type = trace_parse_common_type(sample->raw_data);
304 event = trace_find_event(type);
305 if (event)
306 evname = event->name;
307 } else
308 evname = __event_name(attr->type, attr->config);
309
310 printf("%s: ", evname ? evname : "[unknown]");
311 }
312}
313
314static bool is_bts_event(struct perf_event_attr *attr)
315{
316 return ((attr->type == PERF_TYPE_HARDWARE) &&
317 (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
318 (attr->sample_period == 1));
319}
320
321static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
322{
323 if ((attr->type == PERF_TYPE_SOFTWARE) &&
324 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
325 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
326 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
327 return true;
328
329 if (is_bts_event(attr))
330 return true;
331
332 return false;
333}
334
335static void print_sample_addr(union perf_event *event,
336 struct perf_sample *sample,
337 struct machine *machine,
338 struct thread *thread,
339 struct perf_event_attr *attr)
340{
341 struct addr_location al;
342 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
343
344 printf("%16" PRIx64, sample->addr);
345
346 if (!sample_addr_correlates_sym(attr))
347 return;
348
349 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
350 sample->addr, &al);
351 if (!al.map)
352 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
353 sample->addr, &al);
354
355 al.cpu = sample->cpu;
356 al.sym = NULL;
357
358 if (al.map)
359 al.sym = map__find_symbol(al.map, al.addr, NULL);
360
361 if (PRINT_FIELD(SYM)) {
362 printf(" ");
363 if (PRINT_FIELD(SYMOFFSET))
364 symbol__fprintf_symname_offs(al.sym, &al, stdout);
365 else
366 symbol__fprintf_symname(al.sym, stdout);
367 }
368
369 if (PRINT_FIELD(DSO)) {
370 printf(" (");
371 map__fprintf_dsoname(al.map, stdout);
372 printf(")");
373 }
374}
375
376static void print_sample_bts(union perf_event *event,
377 struct perf_sample *sample,
378 struct perf_evsel *evsel,
379 struct machine *machine,
380 struct thread *thread)
381{
382 struct perf_event_attr *attr = &evsel->attr;
383
384 /* print branch_from information */
385 if (PRINT_FIELD(IP)) {
386 if (!symbol_conf.use_callchain)
387 printf(" ");
388 else
389 printf("\n");
390 perf_event__print_ip(event, sample, machine, evsel,
391 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
392 PRINT_FIELD(SYMOFFSET));
393 }
394
395 printf(" => ");
396
397 /* print branch_to information */
398 if (PRINT_FIELD(ADDR))
399 print_sample_addr(event, sample, machine, thread, attr);
400
401 printf("\n");
402}
403
404static void process_event(union perf_event *event __unused,
405 struct perf_sample *sample,
406 struct perf_evsel *evsel,
407 struct machine *machine,
408 struct thread *thread)
409{
410 struct perf_event_attr *attr = &evsel->attr;
411
412 if (output[attr->type].fields == 0)
413 return;
414
415 print_sample_start(sample, thread, attr);
416
417 if (is_bts_event(attr)) {
418 print_sample_bts(event, sample, evsel, machine, thread);
419 return;
420 }
421
422 if (PRINT_FIELD(TRACE))
423 print_trace_event(sample->cpu, sample->raw_data,
424 sample->raw_size);
425
426 if (PRINT_FIELD(ADDR))
427 print_sample_addr(event, sample, machine, thread, attr);
428
429 if (PRINT_FIELD(IP)) {
430 if (!symbol_conf.use_callchain)
431 printf(" ");
432 else
433 printf("\n");
434 perf_event__print_ip(event, sample, machine, evsel,
435 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
436 PRINT_FIELD(SYMOFFSET));
437 }
438
439 printf("\n");
440}
441
442static int default_start_script(const char *script __unused,
443 int argc __unused,
444 const char **argv __unused)
445{
446 return 0;
447}
448
449static int default_stop_script(void)
450{
451 return 0;
452}
453
454static int default_generate_script(const char *outfile __unused)
455{
456 return 0;
457}
458
459static struct scripting_ops default_scripting_ops = {
460 .start_script = default_start_script,
461 .stop_script = default_stop_script,
462 .process_event = process_event,
463 .generate_script = default_generate_script,
464};
465
466static struct scripting_ops *scripting_ops;
467
468static void setup_scripting(void)
469{
470 setup_perl_scripting();
471 setup_python_scripting();
472
473 scripting_ops = &default_scripting_ops;
474}
475
476static int cleanup_scripting(void)
477{
478 pr_debug("\nperf script stopped\n");
479
480 return scripting_ops->stop_script();
481}
482
483static const char *input_name;
484
485static int process_sample_event(struct perf_tool *tool __used,
486 union perf_event *event,
487 struct perf_sample *sample,
488 struct perf_evsel *evsel,
489 struct machine *machine)
490{
491 struct addr_location al;
492 struct thread *thread = machine__findnew_thread(machine, event->ip.tid);
493
494 if (thread == NULL) {
495 pr_debug("problem processing %d event, skipping it.\n",
496 event->header.type);
497 return -1;
498 }
499
500 if (debug_mode) {
501 if (sample->time < last_timestamp) {
502 pr_err("Samples misordered, previous: %" PRIu64
503 " this: %" PRIu64 "\n", last_timestamp,
504 sample->time);
505 nr_unordered++;
506 }
507 last_timestamp = sample->time;
508 return 0;
509 }
510
511 if (perf_event__preprocess_sample(event, machine, &al, sample, 0) < 0) {
512 pr_err("problem processing %d event, skipping it.\n",
513 event->header.type);
514 return -1;
515 }
516
517 if (al.filtered)
518 return 0;
519
520 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
521 return 0;
522
523 scripting_ops->process_event(event, sample, evsel, machine, thread);
524
525 evsel->hists.stats.total_period += sample->period;
526 return 0;
527}
528
529static struct perf_tool perf_script = {
530 .sample = process_sample_event,
531 .mmap = perf_event__process_mmap,
532 .comm = perf_event__process_comm,
533 .exit = perf_event__process_task,
534 .fork = perf_event__process_task,
535 .attr = perf_event__process_attr,
536 .event_type = perf_event__process_event_type,
537 .tracing_data = perf_event__process_tracing_data,
538 .build_id = perf_event__process_build_id,
539 .ordered_samples = true,
540 .ordering_requires_timestamps = true,
541};
542
543extern volatile int session_done;
544
545static void sig_handler(int sig __unused)
546{
547 session_done = 1;
548}
549
550static int __cmd_script(struct perf_session *session)
551{
552 int ret;
553
554 signal(SIGINT, sig_handler);
555
556 ret = perf_session__process_events(session, &perf_script);
557
558 if (debug_mode)
559 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
560
561 return ret;
562}
563
564struct script_spec {
565 struct list_head node;
566 struct scripting_ops *ops;
567 char spec[0];
568};
569
570static LIST_HEAD(script_specs);
571
572static struct script_spec *script_spec__new(const char *spec,
573 struct scripting_ops *ops)
574{
575 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
576
577 if (s != NULL) {
578 strcpy(s->spec, spec);
579 s->ops = ops;
580 }
581
582 return s;
583}
584
585static void script_spec__add(struct script_spec *s)
586{
587 list_add_tail(&s->node, &script_specs);
588}
589
590static struct script_spec *script_spec__find(const char *spec)
591{
592 struct script_spec *s;
593
594 list_for_each_entry(s, &script_specs, node)
595 if (strcasecmp(s->spec, spec) == 0)
596 return s;
597 return NULL;
598}
599
600static struct script_spec *script_spec__findnew(const char *spec,
601 struct scripting_ops *ops)
602{
603 struct script_spec *s = script_spec__find(spec);
604
605 if (s)
606 return s;
607
608 s = script_spec__new(spec, ops);
609 if (!s)
610 return NULL;
611
612 script_spec__add(s);
613
614 return s;
615}
616
617int script_spec_register(const char *spec, struct scripting_ops *ops)
618{
619 struct script_spec *s;
620
621 s = script_spec__find(spec);
622 if (s)
623 return -1;
624
625 s = script_spec__findnew(spec, ops);
626 if (!s)
627 return -1;
628
629 return 0;
630}
631
632static struct scripting_ops *script_spec__lookup(const char *spec)
633{
634 struct script_spec *s = script_spec__find(spec);
635 if (!s)
636 return NULL;
637
638 return s->ops;
639}
640
641static void list_available_languages(void)
642{
643 struct script_spec *s;
644
645 fprintf(stderr, "\n");
646 fprintf(stderr, "Scripting language extensions (used in "
647 "perf script -s [spec:]script.[spec]):\n\n");
648
649 list_for_each_entry(s, &script_specs, node)
650 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
651
652 fprintf(stderr, "\n");
653}
654
655static int parse_scriptname(const struct option *opt __used,
656 const char *str, int unset __used)
657{
658 char spec[PATH_MAX];
659 const char *script, *ext;
660 int len;
661
662 if (strcmp(str, "lang") == 0) {
663 list_available_languages();
664 exit(0);
665 }
666
667 script = strchr(str, ':');
668 if (script) {
669 len = script - str;
670 if (len >= PATH_MAX) {
671 fprintf(stderr, "invalid language specifier");
672 return -1;
673 }
674 strncpy(spec, str, len);
675 spec[len] = '\0';
676 scripting_ops = script_spec__lookup(spec);
677 if (!scripting_ops) {
678 fprintf(stderr, "invalid language specifier");
679 return -1;
680 }
681 script++;
682 } else {
683 script = str;
684 ext = strrchr(script, '.');
685 if (!ext) {
686 fprintf(stderr, "invalid script extension");
687 return -1;
688 }
689 scripting_ops = script_spec__lookup(++ext);
690 if (!scripting_ops) {
691 fprintf(stderr, "invalid script extension");
692 return -1;
693 }
694 }
695
696 script_name = strdup(script);
697
698 return 0;
699}
700
701static int parse_output_fields(const struct option *opt __used,
702 const char *arg, int unset __used)
703{
704 char *tok;
705 int i, imax = sizeof(all_output_options) / sizeof(struct output_option);
706 int j;
707 int rc = 0;
708 char *str = strdup(arg);
709 int type = -1;
710
711 if (!str)
712 return -ENOMEM;
713
714 /* first word can state for which event type the user is specifying
715 * the fields. If no type exists, the specified fields apply to all
716 * event types found in the file minus the invalid fields for a type.
717 */
718 tok = strchr(str, ':');
719 if (tok) {
720 *tok = '\0';
721 tok++;
722 if (!strcmp(str, "hw"))
723 type = PERF_TYPE_HARDWARE;
724 else if (!strcmp(str, "sw"))
725 type = PERF_TYPE_SOFTWARE;
726 else if (!strcmp(str, "trace"))
727 type = PERF_TYPE_TRACEPOINT;
728 else if (!strcmp(str, "raw"))
729 type = PERF_TYPE_RAW;
730 else {
731 fprintf(stderr, "Invalid event type in field string.\n");
732 rc = -EINVAL;
733 goto out;
734 }
735
736 if (output[type].user_set)
737 pr_warning("Overriding previous field request for %s events.\n",
738 event_type(type));
739
740 output[type].fields = 0;
741 output[type].user_set = true;
742 output[type].wildcard_set = false;
743
744 } else {
745 tok = str;
746 if (strlen(str) == 0) {
747 fprintf(stderr,
748 "Cannot set fields to 'none' for all event types.\n");
749 rc = -EINVAL;
750 goto out;
751 }
752
753 if (output_set_by_user())
754 pr_warning("Overriding previous field request for all events.\n");
755
756 for (j = 0; j < PERF_TYPE_MAX; ++j) {
757 output[j].fields = 0;
758 output[j].user_set = true;
759 output[j].wildcard_set = true;
760 }
761 }
762
763 tok = strtok(tok, ",");
764 while (tok) {
765 for (i = 0; i < imax; ++i) {
766 if (strcmp(tok, all_output_options[i].str) == 0)
767 break;
768 }
769 if (i == imax) {
770 fprintf(stderr, "Invalid field requested.\n");
771 rc = -EINVAL;
772 goto out;
773 }
774
775 if (type == -1) {
776 /* add user option to all events types for
777 * which it is valid
778 */
779 for (j = 0; j < PERF_TYPE_MAX; ++j) {
780 if (output[j].invalid_fields & all_output_options[i].field) {
781 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
782 all_output_options[i].str, event_type(j));
783 } else
784 output[j].fields |= all_output_options[i].field;
785 }
786 } else {
787 if (output[type].invalid_fields & all_output_options[i].field) {
788 fprintf(stderr, "\'%s\' not valid for %s events.\n",
789 all_output_options[i].str, event_type(type));
790
791 rc = -EINVAL;
792 goto out;
793 }
794 output[type].fields |= all_output_options[i].field;
795 }
796
797 tok = strtok(NULL, ",");
798 }
799
800 if (type >= 0) {
801 if (output[type].fields == 0) {
802 pr_debug("No fields requested for %s type. "
803 "Events will not be displayed.\n", event_type(type));
804 }
805 }
806
807out:
808 free(str);
809 return rc;
810}
811
812/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
813static int is_directory(const char *base_path, const struct dirent *dent)
814{
815 char path[PATH_MAX];
816 struct stat st;
817
818 sprintf(path, "%s/%s", base_path, dent->d_name);
819 if (stat(path, &st))
820 return 0;
821
822 return S_ISDIR(st.st_mode);
823}
824
825#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
826 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
827 lang_next) \
828 if ((lang_dirent.d_type == DT_DIR || \
829 (lang_dirent.d_type == DT_UNKNOWN && \
830 is_directory(scripts_path, &lang_dirent))) && \
831 (strcmp(lang_dirent.d_name, ".")) && \
832 (strcmp(lang_dirent.d_name, "..")))
833
834#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
835 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
836 script_next) \
837 if (script_dirent.d_type != DT_DIR && \
838 (script_dirent.d_type != DT_UNKNOWN || \
839 !is_directory(lang_path, &script_dirent)))
840
841
842#define RECORD_SUFFIX "-record"
843#define REPORT_SUFFIX "-report"
844
845struct script_desc {
846 struct list_head node;
847 char *name;
848 char *half_liner;
849 char *args;
850};
851
852static LIST_HEAD(script_descs);
853
854static struct script_desc *script_desc__new(const char *name)
855{
856 struct script_desc *s = zalloc(sizeof(*s));
857
858 if (s != NULL && name)
859 s->name = strdup(name);
860
861 return s;
862}
863
864static void script_desc__delete(struct script_desc *s)
865{
866 free(s->name);
867 free(s->half_liner);
868 free(s->args);
869 free(s);
870}
871
872static void script_desc__add(struct script_desc *s)
873{
874 list_add_tail(&s->node, &script_descs);
875}
876
877static struct script_desc *script_desc__find(const char *name)
878{
879 struct script_desc *s;
880
881 list_for_each_entry(s, &script_descs, node)
882 if (strcasecmp(s->name, name) == 0)
883 return s;
884 return NULL;
885}
886
887static struct script_desc *script_desc__findnew(const char *name)
888{
889 struct script_desc *s = script_desc__find(name);
890
891 if (s)
892 return s;
893
894 s = script_desc__new(name);
895 if (!s)
896 goto out_delete_desc;
897
898 script_desc__add(s);
899
900 return s;
901
902out_delete_desc:
903 script_desc__delete(s);
904
905 return NULL;
906}
907
908static const char *ends_with(const char *str, const char *suffix)
909{
910 size_t suffix_len = strlen(suffix);
911 const char *p = str;
912
913 if (strlen(str) > suffix_len) {
914 p = str + strlen(str) - suffix_len;
915 if (!strncmp(p, suffix, suffix_len))
916 return p;
917 }
918
919 return NULL;
920}
921
922static char *ltrim(char *str)
923{
924 int len = strlen(str);
925
926 while (len && isspace(*str)) {
927 len--;
928 str++;
929 }
930
931 return str;
932}
933
934static int read_script_info(struct script_desc *desc, const char *filename)
935{
936 char line[BUFSIZ], *p;
937 FILE *fp;
938
939 fp = fopen(filename, "r");
940 if (!fp)
941 return -1;
942
943 while (fgets(line, sizeof(line), fp)) {
944 p = ltrim(line);
945 if (strlen(p) == 0)
946 continue;
947 if (*p != '#')
948 continue;
949 p++;
950 if (strlen(p) && *p == '!')
951 continue;
952
953 p = ltrim(p);
954 if (strlen(p) && p[strlen(p) - 1] == '\n')
955 p[strlen(p) - 1] = '\0';
956
957 if (!strncmp(p, "description:", strlen("description:"))) {
958 p += strlen("description:");
959 desc->half_liner = strdup(ltrim(p));
960 continue;
961 }
962
963 if (!strncmp(p, "args:", strlen("args:"))) {
964 p += strlen("args:");
965 desc->args = strdup(ltrim(p));
966 continue;
967 }
968 }
969
970 fclose(fp);
971
972 return 0;
973}
974
975static char *get_script_root(struct dirent *script_dirent, const char *suffix)
976{
977 char *script_root, *str;
978
979 script_root = strdup(script_dirent->d_name);
980 if (!script_root)
981 return NULL;
982
983 str = (char *)ends_with(script_root, suffix);
984 if (!str) {
985 free(script_root);
986 return NULL;
987 }
988
989 *str = '\0';
990 return script_root;
991}
992
993static int list_available_scripts(const struct option *opt __used,
994 const char *s __used, int unset __used)
995{
996 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
997 char scripts_path[MAXPATHLEN];
998 DIR *scripts_dir, *lang_dir;
999 char script_path[MAXPATHLEN];
1000 char lang_path[MAXPATHLEN];
1001 struct script_desc *desc;
1002 char first_half[BUFSIZ];
1003 char *script_root;
1004
1005 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1006
1007 scripts_dir = opendir(scripts_path);
1008 if (!scripts_dir)
1009 return -1;
1010
1011 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1012 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1013 lang_dirent.d_name);
1014 lang_dir = opendir(lang_path);
1015 if (!lang_dir)
1016 continue;
1017
1018 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1019 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1020 if (script_root) {
1021 desc = script_desc__findnew(script_root);
1022 snprintf(script_path, MAXPATHLEN, "%s/%s",
1023 lang_path, script_dirent.d_name);
1024 read_script_info(desc, script_path);
1025 free(script_root);
1026 }
1027 }
1028 }
1029
1030 fprintf(stdout, "List of available trace scripts:\n");
1031 list_for_each_entry(desc, &script_descs, node) {
1032 sprintf(first_half, "%s %s", desc->name,
1033 desc->args ? desc->args : "");
1034 fprintf(stdout, " %-36s %s\n", first_half,
1035 desc->half_liner ? desc->half_liner : "");
1036 }
1037
1038 exit(0);
1039}
1040
1041static char *get_script_path(const char *script_root, const char *suffix)
1042{
1043 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1044 char scripts_path[MAXPATHLEN];
1045 char script_path[MAXPATHLEN];
1046 DIR *scripts_dir, *lang_dir;
1047 char lang_path[MAXPATHLEN];
1048 char *__script_root;
1049
1050 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1051
1052 scripts_dir = opendir(scripts_path);
1053 if (!scripts_dir)
1054 return NULL;
1055
1056 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1057 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1058 lang_dirent.d_name);
1059 lang_dir = opendir(lang_path);
1060 if (!lang_dir)
1061 continue;
1062
1063 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1064 __script_root = get_script_root(&script_dirent, suffix);
1065 if (__script_root && !strcmp(script_root, __script_root)) {
1066 free(__script_root);
1067 closedir(lang_dir);
1068 closedir(scripts_dir);
1069 snprintf(script_path, MAXPATHLEN, "%s/%s",
1070 lang_path, script_dirent.d_name);
1071 return strdup(script_path);
1072 }
1073 free(__script_root);
1074 }
1075 closedir(lang_dir);
1076 }
1077 closedir(scripts_dir);
1078
1079 return NULL;
1080}
1081
1082static bool is_top_script(const char *script_path)
1083{
1084 return ends_with(script_path, "top") == NULL ? false : true;
1085}
1086
1087static int has_required_arg(char *script_path)
1088{
1089 struct script_desc *desc;
1090 int n_args = 0;
1091 char *p;
1092
1093 desc = script_desc__new(NULL);
1094
1095 if (read_script_info(desc, script_path))
1096 goto out;
1097
1098 if (!desc->args)
1099 goto out;
1100
1101 for (p = desc->args; *p; p++)
1102 if (*p == '<')
1103 n_args++;
1104out:
1105 script_desc__delete(desc);
1106
1107 return n_args;
1108}
1109
1110static const char * const script_usage[] = {
1111 "perf script [<options>]",
1112 "perf script [<options>] record <script> [<record-options>] <command>",
1113 "perf script [<options>] report <script> [script-args]",
1114 "perf script [<options>] <script> [<record-options>] <command>",
1115 "perf script [<options>] <top-script> [script-args]",
1116 NULL
1117};
1118
1119static const struct option options[] = {
1120 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1121 "dump raw trace in ASCII"),
1122 OPT_INCR('v', "verbose", &verbose,
1123 "be more verbose (show symbol address, etc)"),
1124 OPT_BOOLEAN('L', "Latency", &latency_format,
1125 "show latency attributes (irqs/preemption disabled, etc)"),
1126 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1127 list_available_scripts),
1128 OPT_CALLBACK('s', "script", NULL, "name",
1129 "script file name (lang:script name, script name, or *)",
1130 parse_scriptname),
1131 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1132 "generate perf-script.xx script in specified language"),
1133 OPT_STRING('i', "input", &input_name, "file",
1134 "input file name"),
1135 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1136 "do various checks like samples ordering and lost events"),
1137 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1138 "file", "vmlinux pathname"),
1139 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1140 "file", "kallsyms pathname"),
1141 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1142 "When printing symbols do not display call chain"),
1143 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1144 "Look for files with symbols relative to this directory"),
1145 OPT_CALLBACK('f', "fields", NULL, "str",
1146 "comma separated output fields prepend with 'type:'. "
1147 "Valid types: hw,sw,trace,raw. "
1148 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1149 "addr,symoff",
1150 parse_output_fields),
1151 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1152 "system-wide collection from all CPUs"),
1153 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1154 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1155 "only display events for these comms"),
1156 OPT_BOOLEAN('I', "show-info", &show_full_info,
1157 "display extended information from perf.data file"),
1158 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1159 "Show the path of [kernel.kallsyms]"),
1160
1161 OPT_END()
1162};
1163
1164static bool have_cmd(int argc, const char **argv)
1165{
1166 char **__argv = malloc(sizeof(const char *) * argc);
1167
1168 if (!__argv)
1169 die("malloc");
1170 memcpy(__argv, argv, sizeof(const char *) * argc);
1171 argc = parse_options(argc, (const char **)__argv, record_options,
1172 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1173 free(__argv);
1174
1175 return argc != 0;
1176}
1177
1178int cmd_script(int argc, const char **argv, const char *prefix __used)
1179{
1180 char *rec_script_path = NULL;
1181 char *rep_script_path = NULL;
1182 struct perf_session *session;
1183 char *script_path = NULL;
1184 const char **__argv;
1185 int i, j, err;
1186
1187 setup_scripting();
1188
1189 argc = parse_options(argc, argv, options, script_usage,
1190 PARSE_OPT_STOP_AT_NON_OPTION);
1191
1192 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1193 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1194 if (!rec_script_path)
1195 return cmd_record(argc, argv, NULL);
1196 }
1197
1198 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1199 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1200 if (!rep_script_path) {
1201 fprintf(stderr,
1202 "Please specify a valid report script"
1203 "(see 'perf script -l' for listing)\n");
1204 return -1;
1205 }
1206 }
1207
1208 /* make sure PERF_EXEC_PATH is set for scripts */
1209 perf_set_argv_exec_path(perf_exec_path());
1210
1211 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1212 int live_pipe[2];
1213 int rep_args;
1214 pid_t pid;
1215
1216 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1217 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1218
1219 if (!rec_script_path && !rep_script_path) {
1220 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1221 " script -l for available scripts.\n", argv[0]);
1222 usage_with_options(script_usage, options);
1223 }
1224
1225 if (is_top_script(argv[0])) {
1226 rep_args = argc - 1;
1227 } else {
1228 int rec_args;
1229
1230 rep_args = has_required_arg(rep_script_path);
1231 rec_args = (argc - 1) - rep_args;
1232 if (rec_args < 0) {
1233 fprintf(stderr, " %s script requires options."
1234 "\n\n See perf script -l for available "
1235 "scripts and options.\n", argv[0]);
1236 usage_with_options(script_usage, options);
1237 }
1238 }
1239
1240 if (pipe(live_pipe) < 0) {
1241 perror("failed to create pipe");
1242 exit(-1);
1243 }
1244
1245 pid = fork();
1246 if (pid < 0) {
1247 perror("failed to fork");
1248 exit(-1);
1249 }
1250
1251 if (!pid) {
1252 j = 0;
1253
1254 dup2(live_pipe[1], 1);
1255 close(live_pipe[0]);
1256
1257 if (is_top_script(argv[0])) {
1258 system_wide = true;
1259 } else if (!system_wide) {
1260 system_wide = !have_cmd(argc - rep_args,
1261 &argv[rep_args]);
1262 }
1263
1264 __argv = malloc((argc + 6) * sizeof(const char *));
1265 if (!__argv)
1266 die("malloc");
1267
1268 __argv[j++] = "/bin/sh";
1269 __argv[j++] = rec_script_path;
1270 if (system_wide)
1271 __argv[j++] = "-a";
1272 __argv[j++] = "-q";
1273 __argv[j++] = "-o";
1274 __argv[j++] = "-";
1275 for (i = rep_args + 1; i < argc; i++)
1276 __argv[j++] = argv[i];
1277 __argv[j++] = NULL;
1278
1279 execvp("/bin/sh", (char **)__argv);
1280 free(__argv);
1281 exit(-1);
1282 }
1283
1284 dup2(live_pipe[0], 0);
1285 close(live_pipe[1]);
1286
1287 __argv = malloc((argc + 4) * sizeof(const char *));
1288 if (!__argv)
1289 die("malloc");
1290 j = 0;
1291 __argv[j++] = "/bin/sh";
1292 __argv[j++] = rep_script_path;
1293 for (i = 1; i < rep_args + 1; i++)
1294 __argv[j++] = argv[i];
1295 __argv[j++] = "-i";
1296 __argv[j++] = "-";
1297 __argv[j++] = NULL;
1298
1299 execvp("/bin/sh", (char **)__argv);
1300 free(__argv);
1301 exit(-1);
1302 }
1303
1304 if (rec_script_path)
1305 script_path = rec_script_path;
1306 if (rep_script_path)
1307 script_path = rep_script_path;
1308
1309 if (script_path) {
1310 j = 0;
1311
1312 if (!rec_script_path)
1313 system_wide = false;
1314 else if (!system_wide)
1315 system_wide = !have_cmd(argc - 1, &argv[1]);
1316
1317 __argv = malloc((argc + 2) * sizeof(const char *));
1318 if (!__argv)
1319 die("malloc");
1320 __argv[j++] = "/bin/sh";
1321 __argv[j++] = script_path;
1322 if (system_wide)
1323 __argv[j++] = "-a";
1324 for (i = 2; i < argc; i++)
1325 __argv[j++] = argv[i];
1326 __argv[j++] = NULL;
1327
1328 execvp("/bin/sh", (char **)__argv);
1329 free(__argv);
1330 exit(-1);
1331 }
1332
1333 if (symbol__init() < 0)
1334 return -1;
1335 if (!script_name)
1336 setup_pager();
1337
1338 session = perf_session__new(input_name, O_RDONLY, 0, false, &perf_script);
1339 if (session == NULL)
1340 return -ENOMEM;
1341
1342 if (cpu_list) {
1343 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1344 return -1;
1345 }
1346
1347 perf_session__fprintf_info(session, stdout, show_full_info);
1348
1349 if (!no_callchain)
1350 symbol_conf.use_callchain = true;
1351 else
1352 symbol_conf.use_callchain = false;
1353
1354 if (generate_script_lang) {
1355 struct stat perf_stat;
1356 int input;
1357
1358 if (output_set_by_user()) {
1359 fprintf(stderr,
1360 "custom fields not supported for generated scripts");
1361 return -1;
1362 }
1363
1364 input = open(session->filename, O_RDONLY); /* input_name */
1365 if (input < 0) {
1366 perror("failed to open file");
1367 exit(-1);
1368 }
1369
1370 err = fstat(input, &perf_stat);
1371 if (err < 0) {
1372 perror("failed to stat file");
1373 exit(-1);
1374 }
1375
1376 if (!perf_stat.st_size) {
1377 fprintf(stderr, "zero-sized file, nothing to do!\n");
1378 exit(0);
1379 }
1380
1381 scripting_ops = script_spec__lookup(generate_script_lang);
1382 if (!scripting_ops) {
1383 fprintf(stderr, "invalid language specifier");
1384 return -1;
1385 }
1386
1387 err = scripting_ops->generate_script("perf-script");
1388 goto out;
1389 }
1390
1391 if (script_name) {
1392 err = scripting_ops->start_script(script_name, argc, argv);
1393 if (err)
1394 goto out;
1395 pr_debug("perf script started with script %s\n\n", script_name);
1396 }
1397
1398
1399 err = perf_session__check_output_opt(session);
1400 if (err < 0)
1401 goto out;
1402
1403 err = __cmd_script(session);
1404
1405 perf_session__delete(session);
1406 cleanup_scripting();
1407out:
1408 return err;
1409}