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 <linux/stringify.h>
27 #include "util/mem-events.h"
29 static char const *script_name
;
30 static char const *generate_script_lang
;
31 static bool debug_mode
;
32 static u64 last_timestamp
;
33 static u64 nr_unordered
;
34 static bool no_callchain
;
35 static bool latency_format
;
36 static bool system_wide
;
37 static bool print_flags
;
39 static const char *cpu_list
;
40 static DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
41 static struct perf_stat_config stat_config
;
43 unsigned int scripting_max_stack
= PERF_MAX_STACK_DEPTH
;
45 enum perf_output_field
{
46 PERF_OUTPUT_COMM
= 1U << 0,
47 PERF_OUTPUT_TID
= 1U << 1,
48 PERF_OUTPUT_PID
= 1U << 2,
49 PERF_OUTPUT_TIME
= 1U << 3,
50 PERF_OUTPUT_CPU
= 1U << 4,
51 PERF_OUTPUT_EVNAME
= 1U << 5,
52 PERF_OUTPUT_TRACE
= 1U << 6,
53 PERF_OUTPUT_IP
= 1U << 7,
54 PERF_OUTPUT_SYM
= 1U << 8,
55 PERF_OUTPUT_DSO
= 1U << 9,
56 PERF_OUTPUT_ADDR
= 1U << 10,
57 PERF_OUTPUT_SYMOFFSET
= 1U << 11,
58 PERF_OUTPUT_SRCLINE
= 1U << 12,
59 PERF_OUTPUT_PERIOD
= 1U << 13,
60 PERF_OUTPUT_IREGS
= 1U << 14,
61 PERF_OUTPUT_BRSTACK
= 1U << 15,
62 PERF_OUTPUT_BRSTACKSYM
= 1U << 16,
63 PERF_OUTPUT_DATA_SRC
= 1U << 17,
64 PERF_OUTPUT_WEIGHT
= 1U << 18,
65 PERF_OUTPUT_BPF_OUTPUT
= 1U << 19,
68 struct output_option
{
70 enum perf_output_field field
;
71 } all_output_options
[] = {
72 {.str
= "comm", .field
= PERF_OUTPUT_COMM
},
73 {.str
= "tid", .field
= PERF_OUTPUT_TID
},
74 {.str
= "pid", .field
= PERF_OUTPUT_PID
},
75 {.str
= "time", .field
= PERF_OUTPUT_TIME
},
76 {.str
= "cpu", .field
= PERF_OUTPUT_CPU
},
77 {.str
= "event", .field
= PERF_OUTPUT_EVNAME
},
78 {.str
= "trace", .field
= PERF_OUTPUT_TRACE
},
79 {.str
= "ip", .field
= PERF_OUTPUT_IP
},
80 {.str
= "sym", .field
= PERF_OUTPUT_SYM
},
81 {.str
= "dso", .field
= PERF_OUTPUT_DSO
},
82 {.str
= "addr", .field
= PERF_OUTPUT_ADDR
},
83 {.str
= "symoff", .field
= PERF_OUTPUT_SYMOFFSET
},
84 {.str
= "srcline", .field
= PERF_OUTPUT_SRCLINE
},
85 {.str
= "period", .field
= PERF_OUTPUT_PERIOD
},
86 {.str
= "iregs", .field
= PERF_OUTPUT_IREGS
},
87 {.str
= "brstack", .field
= PERF_OUTPUT_BRSTACK
},
88 {.str
= "brstacksym", .field
= PERF_OUTPUT_BRSTACKSYM
},
89 {.str
= "data_src", .field
= PERF_OUTPUT_DATA_SRC
},
90 {.str
= "weight", .field
= PERF_OUTPUT_WEIGHT
},
91 {.str
= "bpf-output", .field
= PERF_OUTPUT_BPF_OUTPUT
},
94 /* default set to maintain compatibility with current format */
98 unsigned int print_ip_opts
;
101 } output
[PERF_TYPE_MAX
] = {
103 [PERF_TYPE_HARDWARE
] = {
106 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
107 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
108 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
109 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
|
112 .invalid_fields
= PERF_OUTPUT_TRACE
| PERF_OUTPUT_BPF_OUTPUT
,
115 [PERF_TYPE_SOFTWARE
] = {
118 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
119 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
120 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
121 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
|
122 PERF_OUTPUT_PERIOD
| PERF_OUTPUT_BPF_OUTPUT
,
124 .invalid_fields
= PERF_OUTPUT_TRACE
,
127 [PERF_TYPE_TRACEPOINT
] = {
130 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
131 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
132 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_TRACE
138 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
139 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
140 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
141 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
|
142 PERF_OUTPUT_PERIOD
| PERF_OUTPUT_ADDR
|
143 PERF_OUTPUT_DATA_SRC
| PERF_OUTPUT_WEIGHT
,
145 .invalid_fields
= PERF_OUTPUT_TRACE
| PERF_OUTPUT_BPF_OUTPUT
,
148 [PERF_TYPE_BREAKPOINT
] = {
151 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
152 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
153 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
154 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
|
157 .invalid_fields
= PERF_OUTPUT_TRACE
| PERF_OUTPUT_BPF_OUTPUT
,
161 static bool output_set_by_user(void)
164 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
165 if (output
[j
].user_set
)
171 static const char *output_field2str(enum perf_output_field field
)
173 int i
, imax
= ARRAY_SIZE(all_output_options
);
174 const char *str
= "";
176 for (i
= 0; i
< imax
; ++i
) {
177 if (all_output_options
[i
].field
== field
) {
178 str
= all_output_options
[i
].str
;
185 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
187 static int perf_evsel__do_check_stype(struct perf_evsel
*evsel
,
188 u64 sample_type
, const char *sample_msg
,
189 enum perf_output_field field
,
192 struct perf_event_attr
*attr
= &evsel
->attr
;
193 int type
= attr
->type
;
196 if (attr
->sample_type
& sample_type
)
199 if (output
[type
].user_set
) {
202 evname
= perf_evsel__name(evsel
);
203 pr_err("Samples for '%s' event do not have %s attribute set. "
204 "Cannot print '%s' field.\n",
205 evname
, sample_msg
, output_field2str(field
));
209 /* user did not ask for it explicitly so remove from the default list */
210 output
[type
].fields
&= ~field
;
211 evname
= perf_evsel__name(evsel
);
212 pr_debug("Samples for '%s' event do not have %s attribute set. "
213 "Skipping '%s' field.\n",
214 evname
, sample_msg
, output_field2str(field
));
219 static int perf_evsel__check_stype(struct perf_evsel
*evsel
,
220 u64 sample_type
, const char *sample_msg
,
221 enum perf_output_field field
)
223 return perf_evsel__do_check_stype(evsel
, sample_type
, sample_msg
, field
,
227 static int perf_evsel__check_attr(struct perf_evsel
*evsel
,
228 struct perf_session
*session
)
230 struct perf_event_attr
*attr
= &evsel
->attr
;
233 if (perf_header__has_feat(&session
->header
, HEADER_STAT
))
236 allow_user_set
= perf_header__has_feat(&session
->header
,
239 if (PRINT_FIELD(TRACE
) &&
240 !perf_session__has_traces(session
, "record -R"))
243 if (PRINT_FIELD(IP
)) {
244 if (perf_evsel__check_stype(evsel
, PERF_SAMPLE_IP
, "IP",
249 if (PRINT_FIELD(ADDR
) &&
250 perf_evsel__do_check_stype(evsel
, PERF_SAMPLE_ADDR
, "ADDR",
251 PERF_OUTPUT_ADDR
, allow_user_set
))
254 if (PRINT_FIELD(DATA_SRC
) &&
255 perf_evsel__check_stype(evsel
, PERF_SAMPLE_DATA_SRC
, "DATA_SRC",
256 PERF_OUTPUT_DATA_SRC
))
259 if (PRINT_FIELD(WEIGHT
) &&
260 perf_evsel__check_stype(evsel
, PERF_SAMPLE_WEIGHT
, "WEIGHT",
264 if (PRINT_FIELD(SYM
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
265 pr_err("Display of symbols requested but neither sample IP nor "
266 "sample address\nis selected. Hence, no addresses to convert "
270 if (PRINT_FIELD(SYMOFFSET
) && !PRINT_FIELD(SYM
)) {
271 pr_err("Display of offsets requested but symbol is not"
275 if (PRINT_FIELD(DSO
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
276 pr_err("Display of DSO requested but neither sample IP nor "
277 "sample address\nis selected. Hence, no addresses to convert "
281 if (PRINT_FIELD(SRCLINE
) && !PRINT_FIELD(IP
)) {
282 pr_err("Display of source line number requested but sample IP is not\n"
283 "selected. Hence, no address to lookup the source line number.\n");
287 if ((PRINT_FIELD(PID
) || PRINT_FIELD(TID
)) &&
288 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TID
, "TID",
289 PERF_OUTPUT_TID
|PERF_OUTPUT_PID
))
292 if (PRINT_FIELD(TIME
) &&
293 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TIME
, "TIME",
297 if (PRINT_FIELD(CPU
) &&
298 perf_evsel__do_check_stype(evsel
, PERF_SAMPLE_CPU
, "CPU",
299 PERF_OUTPUT_CPU
, allow_user_set
))
302 if (PRINT_FIELD(PERIOD
) &&
303 perf_evsel__check_stype(evsel
, PERF_SAMPLE_PERIOD
, "PERIOD",
307 if (PRINT_FIELD(IREGS
) &&
308 perf_evsel__check_stype(evsel
, PERF_SAMPLE_REGS_INTR
, "IREGS",
315 static void set_print_ip_opts(struct perf_event_attr
*attr
)
317 unsigned int type
= attr
->type
;
319 output
[type
].print_ip_opts
= 0;
321 output
[type
].print_ip_opts
|= EVSEL__PRINT_IP
;
323 if (PRINT_FIELD(SYM
))
324 output
[type
].print_ip_opts
|= EVSEL__PRINT_SYM
;
326 if (PRINT_FIELD(DSO
))
327 output
[type
].print_ip_opts
|= EVSEL__PRINT_DSO
;
329 if (PRINT_FIELD(SYMOFFSET
))
330 output
[type
].print_ip_opts
|= EVSEL__PRINT_SYMOFFSET
;
332 if (PRINT_FIELD(SRCLINE
))
333 output
[type
].print_ip_opts
|= EVSEL__PRINT_SRCLINE
;
337 * verify all user requested events exist and the samples
338 * have the expected data
340 static int perf_session__check_output_opt(struct perf_session
*session
)
343 struct perf_evsel
*evsel
;
345 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
346 evsel
= perf_session__find_first_evtype(session
, j
);
349 * even if fields is set to 0 (ie., show nothing) event must
350 * exist if user explicitly includes it on the command line
352 if (!evsel
&& output
[j
].user_set
&& !output
[j
].wildcard_set
) {
353 pr_err("%s events do not exist. "
354 "Remove corresponding -f option to proceed.\n",
359 if (evsel
&& output
[j
].fields
&&
360 perf_evsel__check_attr(evsel
, session
))
366 set_print_ip_opts(&evsel
->attr
);
370 bool use_callchain
= false;
372 evlist__for_each(session
->evlist
, evsel
) {
373 if (evsel
->attr
.sample_type
& PERF_SAMPLE_CALLCHAIN
) {
374 use_callchain
= true;
379 symbol_conf
.use_callchain
= false;
383 * set default for tracepoints to print symbols only
384 * if callchains are present
386 if (symbol_conf
.use_callchain
&&
387 !output
[PERF_TYPE_TRACEPOINT
].user_set
) {
388 struct perf_event_attr
*attr
;
390 j
= PERF_TYPE_TRACEPOINT
;
392 evlist__for_each(session
->evlist
, evsel
) {
393 if (evsel
->attr
.type
!= j
)
398 if (attr
->sample_type
& PERF_SAMPLE_CALLCHAIN
) {
399 output
[j
].fields
|= PERF_OUTPUT_IP
;
400 output
[j
].fields
|= PERF_OUTPUT_SYM
;
401 output
[j
].fields
|= PERF_OUTPUT_DSO
;
402 set_print_ip_opts(attr
);
412 static void print_sample_iregs(struct perf_sample
*sample
,
413 struct perf_event_attr
*attr
)
415 struct regs_dump
*regs
= &sample
->intr_regs
;
416 uint64_t mask
= attr
->sample_regs_intr
;
422 for_each_set_bit(r
, (unsigned long *) &mask
, sizeof(mask
) * 8) {
423 u64 val
= regs
->regs
[i
++];
424 printf("%5s:0x%"PRIx64
" ", perf_reg_name(r
), val
);
428 static void print_sample_start(struct perf_sample
*sample
,
429 struct thread
*thread
,
430 struct perf_evsel
*evsel
)
432 struct perf_event_attr
*attr
= &evsel
->attr
;
435 unsigned long long nsecs
;
437 if (PRINT_FIELD(COMM
)) {
439 printf("%8.8s ", thread__comm_str(thread
));
440 else if (PRINT_FIELD(IP
) && symbol_conf
.use_callchain
)
441 printf("%s ", thread__comm_str(thread
));
443 printf("%16s ", thread__comm_str(thread
));
446 if (PRINT_FIELD(PID
) && PRINT_FIELD(TID
))
447 printf("%5d/%-5d ", sample
->pid
, sample
->tid
);
448 else if (PRINT_FIELD(PID
))
449 printf("%5d ", sample
->pid
);
450 else if (PRINT_FIELD(TID
))
451 printf("%5d ", sample
->tid
);
453 if (PRINT_FIELD(CPU
)) {
455 printf("%3d ", sample
->cpu
);
457 printf("[%03d] ", sample
->cpu
);
460 if (PRINT_FIELD(TIME
)) {
461 nsecs
= sample
->time
;
462 secs
= nsecs
/ NSECS_PER_SEC
;
463 nsecs
-= secs
* NSECS_PER_SEC
;
464 usecs
= nsecs
/ NSECS_PER_USEC
;
466 printf("%5lu.%09llu: ", secs
, nsecs
);
468 printf("%5lu.%06lu: ", secs
, usecs
);
473 mispred_str(struct branch_entry
*br
)
475 if (!(br
->flags
.mispred
|| br
->flags
.predicted
))
478 return br
->flags
.predicted
? 'P' : 'M';
481 static void print_sample_brstack(struct perf_sample
*sample
)
483 struct branch_stack
*br
= sample
->branch_stack
;
489 for (i
= 0; i
< br
->nr
; i
++) {
490 printf(" 0x%"PRIx64
"/0x%"PRIx64
"/%c/%c/%c/%d ",
493 mispred_str( br
->entries
+ i
),
494 br
->entries
[i
].flags
.in_tx
? 'X' : '-',
495 br
->entries
[i
].flags
.abort
? 'A' : '-',
496 br
->entries
[i
].flags
.cycles
);
500 static void print_sample_brstacksym(struct perf_sample
*sample
,
501 struct thread
*thread
)
503 struct branch_stack
*br
= sample
->branch_stack
;
504 struct addr_location alf
, alt
;
510 for (i
= 0; i
< br
->nr
; i
++) {
512 memset(&alf
, 0, sizeof(alf
));
513 memset(&alt
, 0, sizeof(alt
));
514 from
= br
->entries
[i
].from
;
515 to
= br
->entries
[i
].to
;
517 thread__find_addr_map(thread
, sample
->cpumode
, MAP__FUNCTION
, from
, &alf
);
519 alf
.sym
= map__find_symbol(alf
.map
, alf
.addr
, NULL
);
521 thread__find_addr_map(thread
, sample
->cpumode
, MAP__FUNCTION
, to
, &alt
);
523 alt
.sym
= map__find_symbol(alt
.map
, alt
.addr
, NULL
);
525 symbol__fprintf_symname_offs(alf
.sym
, &alf
, stdout
);
527 symbol__fprintf_symname_offs(alt
.sym
, &alt
, stdout
);
528 printf("/%c/%c/%c/%d ",
529 mispred_str( br
->entries
+ i
),
530 br
->entries
[i
].flags
.in_tx
? 'X' : '-',
531 br
->entries
[i
].flags
.abort
? 'A' : '-',
532 br
->entries
[i
].flags
.cycles
);
537 static void print_sample_addr(struct perf_sample
*sample
,
538 struct thread
*thread
,
539 struct perf_event_attr
*attr
)
541 struct addr_location al
;
543 printf("%16" PRIx64
, sample
->addr
);
545 if (!sample_addr_correlates_sym(attr
))
548 thread__resolve(thread
, &al
, sample
);
550 if (PRINT_FIELD(SYM
)) {
552 if (PRINT_FIELD(SYMOFFSET
))
553 symbol__fprintf_symname_offs(al
.sym
, &al
, stdout
);
555 symbol__fprintf_symname(al
.sym
, stdout
);
558 if (PRINT_FIELD(DSO
)) {
560 map__fprintf_dsoname(al
.map
, stdout
);
565 static void print_sample_bts(struct perf_sample
*sample
,
566 struct perf_evsel
*evsel
,
567 struct thread
*thread
,
568 struct addr_location
*al
)
570 struct perf_event_attr
*attr
= &evsel
->attr
;
571 bool print_srcline_last
= false;
573 /* print branch_from information */
574 if (PRINT_FIELD(IP
)) {
575 unsigned int print_opts
= output
[attr
->type
].print_ip_opts
;
576 struct callchain_cursor
*cursor
= NULL
;
578 if (symbol_conf
.use_callchain
&& sample
->callchain
&&
579 thread__resolve_callchain(al
->thread
, &callchain_cursor
, evsel
,
580 sample
, NULL
, NULL
, scripting_max_stack
) == 0)
581 cursor
= &callchain_cursor
;
583 if (cursor
== NULL
) {
585 if (print_opts
& EVSEL__PRINT_SRCLINE
) {
586 print_srcline_last
= true;
587 print_opts
&= ~EVSEL__PRINT_SRCLINE
;
592 sample__fprintf_sym(sample
, al
, 0, print_opts
, cursor
, stdout
);
595 /* print branch_to information */
596 if (PRINT_FIELD(ADDR
) ||
597 ((evsel
->attr
.sample_type
& PERF_SAMPLE_ADDR
) &&
598 !output
[attr
->type
].user_set
)) {
600 print_sample_addr(sample
, thread
, attr
);
603 if (print_srcline_last
)
604 map__fprintf_srcline(al
->map
, al
->addr
, "\n ", stdout
);
609 static void print_sample_flags(u32 flags
)
611 const char *chars
= PERF_IP_FLAG_CHARS
;
612 const int n
= strlen(PERF_IP_FLAG_CHARS
);
616 for (i
= 0; i
< n
; i
++, flags
>>= 1) {
618 str
[pos
++] = chars
[i
];
620 for (; i
< 32; i
++, flags
>>= 1) {
625 printf(" %-4s ", str
);
628 struct printer_data
{
635 print_sample_bpf_output_printer(enum binary_printer_ops op
,
639 unsigned char ch
= (unsigned char)val
;
640 struct printer_data
*printer_data
= extra
;
643 case BINARY_PRINT_DATA_BEGIN
:
646 case BINARY_PRINT_LINE_BEGIN
:
647 printf("%17s", !printer_data
->line_no
? "BPF output:" :
650 case BINARY_PRINT_ADDR
:
651 printf(" %04x:", val
);
653 case BINARY_PRINT_NUM_DATA
:
654 printf(" %02x", val
);
656 case BINARY_PRINT_NUM_PAD
:
659 case BINARY_PRINT_SEP
:
662 case BINARY_PRINT_CHAR_DATA
:
663 if (printer_data
->hit_nul
&& ch
)
664 printer_data
->is_printable
= false;
669 if (!printer_data
->is_printable
)
673 printer_data
->hit_nul
= true;
675 printer_data
->is_printable
= false;
680 case BINARY_PRINT_CHAR_PAD
:
683 case BINARY_PRINT_LINE_END
:
685 printer_data
->line_no
++;
687 case BINARY_PRINT_DATA_END
:
693 static void print_sample_bpf_output(struct perf_sample
*sample
)
695 unsigned int nr_bytes
= sample
->raw_size
;
696 struct printer_data printer_data
= {0, false, true};
698 print_binary(sample
->raw_data
, nr_bytes
, 8,
699 print_sample_bpf_output_printer
, &printer_data
);
701 if (printer_data
.is_printable
&& printer_data
.hit_nul
)
702 printf("%17s \"%s\"\n", "BPF string:",
703 (char *)(sample
->raw_data
));
707 struct perf_tool tool
;
708 struct perf_session
*session
;
709 bool show_task_events
;
710 bool show_mmap_events
;
711 bool show_switch_events
;
713 struct cpu_map
*cpus
;
714 struct thread_map
*threads
;
718 static int perf_evlist__max_name_len(struct perf_evlist
*evlist
)
720 struct perf_evsel
*evsel
;
723 evlist__for_each(evlist
, evsel
) {
724 int len
= strlen(perf_evsel__name(evsel
));
732 static size_t data_src__printf(u64 data_src
)
734 struct mem_info mi
= { .data_src
.val
= data_src
};
740 perf_script__meminfo_scnprintf(decode
, 100, &mi
);
742 len
= scnprintf(out
, 100, "%16" PRIx64
" %s", data_src
, decode
);
746 return printf("%-*s", maxlen
, out
);
749 static void process_event(struct perf_script
*script
,
750 struct perf_sample
*sample
, struct perf_evsel
*evsel
,
751 struct addr_location
*al
)
753 struct thread
*thread
= al
->thread
;
754 struct perf_event_attr
*attr
= &evsel
->attr
;
756 if (output
[attr
->type
].fields
== 0)
759 print_sample_start(sample
, thread
, evsel
);
761 if (PRINT_FIELD(PERIOD
))
762 printf("%10" PRIu64
" ", sample
->period
);
764 if (PRINT_FIELD(EVNAME
)) {
765 const char *evname
= perf_evsel__name(evsel
);
767 if (!script
->name_width
)
768 script
->name_width
= perf_evlist__max_name_len(script
->session
->evlist
);
770 printf("%*s: ", script
->name_width
,
771 evname
? evname
: "[unknown]");
775 print_sample_flags(sample
->flags
);
777 if (is_bts_event(attr
)) {
778 print_sample_bts(sample
, evsel
, thread
, al
);
782 if (PRINT_FIELD(TRACE
))
783 event_format__print(evsel
->tp_format
, sample
->cpu
,
784 sample
->raw_data
, sample
->raw_size
);
785 if (PRINT_FIELD(ADDR
))
786 print_sample_addr(sample
, thread
, attr
);
788 if (PRINT_FIELD(DATA_SRC
))
789 data_src__printf(sample
->data_src
);
791 if (PRINT_FIELD(WEIGHT
))
792 printf("%16" PRIu64
, sample
->weight
);
794 if (PRINT_FIELD(IP
)) {
795 struct callchain_cursor
*cursor
= NULL
;
797 if (symbol_conf
.use_callchain
&& sample
->callchain
&&
798 thread__resolve_callchain(al
->thread
, &callchain_cursor
, evsel
,
799 sample
, NULL
, NULL
, scripting_max_stack
) == 0)
800 cursor
= &callchain_cursor
;
802 putchar(cursor
? '\n' : ' ');
803 sample__fprintf_sym(sample
, al
, 0, output
[attr
->type
].print_ip_opts
, cursor
, stdout
);
806 if (PRINT_FIELD(IREGS
))
807 print_sample_iregs(sample
, attr
);
809 if (PRINT_FIELD(BRSTACK
))
810 print_sample_brstack(sample
);
811 else if (PRINT_FIELD(BRSTACKSYM
))
812 print_sample_brstacksym(sample
, thread
);
814 if (perf_evsel__is_bpf_output(evsel
) && PRINT_FIELD(BPF_OUTPUT
))
815 print_sample_bpf_output(sample
);
820 static struct scripting_ops
*scripting_ops
;
822 static void __process_stat(struct perf_evsel
*counter
, u64 tstamp
)
824 int nthreads
= thread_map__nr(counter
->threads
);
825 int ncpus
= perf_evsel__nr_cpus(counter
);
827 static int header_printed
;
829 if (counter
->system_wide
)
832 if (!header_printed
) {
833 printf("%3s %8s %15s %15s %15s %15s %s\n",
834 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
838 for (thread
= 0; thread
< nthreads
; thread
++) {
839 for (cpu
= 0; cpu
< ncpus
; cpu
++) {
840 struct perf_counts_values
*counts
;
842 counts
= perf_counts(counter
->counts
, cpu
, thread
);
844 printf("%3d %8d %15" PRIu64
" %15" PRIu64
" %15" PRIu64
" %15" PRIu64
" %s\n",
845 counter
->cpus
->map
[cpu
],
846 thread_map__pid(counter
->threads
, thread
),
851 perf_evsel__name(counter
));
856 static void process_stat(struct perf_evsel
*counter
, u64 tstamp
)
858 if (scripting_ops
&& scripting_ops
->process_stat
)
859 scripting_ops
->process_stat(&stat_config
, counter
, tstamp
);
861 __process_stat(counter
, tstamp
);
864 static void process_stat_interval(u64 tstamp
)
866 if (scripting_ops
&& scripting_ops
->process_stat_interval
)
867 scripting_ops
->process_stat_interval(tstamp
);
870 static void setup_scripting(void)
872 setup_perl_scripting();
873 setup_python_scripting();
876 static int flush_scripting(void)
878 return scripting_ops
? scripting_ops
->flush_script() : 0;
881 static int cleanup_scripting(void)
883 pr_debug("\nperf script stopped\n");
885 return scripting_ops
? scripting_ops
->stop_script() : 0;
888 static int process_sample_event(struct perf_tool
*tool
,
889 union perf_event
*event
,
890 struct perf_sample
*sample
,
891 struct perf_evsel
*evsel
,
892 struct machine
*machine
)
894 struct perf_script
*scr
= container_of(tool
, struct perf_script
, tool
);
895 struct addr_location al
;
898 if (sample
->time
< last_timestamp
) {
899 pr_err("Samples misordered, previous: %" PRIu64
900 " this: %" PRIu64
"\n", last_timestamp
,
904 last_timestamp
= sample
->time
;
908 if (machine__resolve(machine
, &al
, sample
) < 0) {
909 pr_err("problem processing %d event, skipping it.\n",
917 if (cpu_list
&& !test_bit(sample
->cpu
, cpu_bitmap
))
921 scripting_ops
->process_event(event
, sample
, evsel
, &al
);
923 process_event(scr
, sample
, evsel
, &al
);
926 addr_location__put(&al
);
930 static int process_attr(struct perf_tool
*tool
, union perf_event
*event
,
931 struct perf_evlist
**pevlist
)
933 struct perf_script
*scr
= container_of(tool
, struct perf_script
, tool
);
934 struct perf_evlist
*evlist
;
935 struct perf_evsel
*evsel
, *pos
;
938 err
= perf_event__process_attr(tool
, event
, pevlist
);
943 evsel
= perf_evlist__last(*pevlist
);
945 if (evsel
->attr
.type
>= PERF_TYPE_MAX
)
948 evlist__for_each(evlist
, pos
) {
949 if (pos
->attr
.type
== evsel
->attr
.type
&& pos
!= evsel
)
953 set_print_ip_opts(&evsel
->attr
);
955 if (evsel
->attr
.sample_type
)
956 err
= perf_evsel__check_attr(evsel
, scr
->session
);
961 static int process_comm_event(struct perf_tool
*tool
,
962 union perf_event
*event
,
963 struct perf_sample
*sample
,
964 struct machine
*machine
)
966 struct thread
*thread
;
967 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
968 struct perf_session
*session
= script
->session
;
969 struct perf_evsel
*evsel
= perf_evlist__id2evsel(session
->evlist
, sample
->id
);
972 thread
= machine__findnew_thread(machine
, event
->comm
.pid
, event
->comm
.tid
);
973 if (thread
== NULL
) {
974 pr_debug("problem processing COMM event, skipping it.\n");
978 if (perf_event__process_comm(tool
, event
, sample
, machine
) < 0)
981 if (!evsel
->attr
.sample_id_all
) {
984 sample
->tid
= event
->comm
.tid
;
985 sample
->pid
= event
->comm
.pid
;
987 print_sample_start(sample
, thread
, evsel
);
988 perf_event__fprintf(event
, stdout
);
995 static int process_fork_event(struct perf_tool
*tool
,
996 union perf_event
*event
,
997 struct perf_sample
*sample
,
998 struct machine
*machine
)
1000 struct thread
*thread
;
1001 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1002 struct perf_session
*session
= script
->session
;
1003 struct perf_evsel
*evsel
= perf_evlist__id2evsel(session
->evlist
, sample
->id
);
1005 if (perf_event__process_fork(tool
, event
, sample
, machine
) < 0)
1008 thread
= machine__findnew_thread(machine
, event
->fork
.pid
, event
->fork
.tid
);
1009 if (thread
== NULL
) {
1010 pr_debug("problem processing FORK event, skipping it.\n");
1014 if (!evsel
->attr
.sample_id_all
) {
1016 sample
->time
= event
->fork
.time
;
1017 sample
->tid
= event
->fork
.tid
;
1018 sample
->pid
= event
->fork
.pid
;
1020 print_sample_start(sample
, thread
, evsel
);
1021 perf_event__fprintf(event
, stdout
);
1022 thread__put(thread
);
1026 static int process_exit_event(struct perf_tool
*tool
,
1027 union perf_event
*event
,
1028 struct perf_sample
*sample
,
1029 struct machine
*machine
)
1032 struct thread
*thread
;
1033 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1034 struct perf_session
*session
= script
->session
;
1035 struct perf_evsel
*evsel
= perf_evlist__id2evsel(session
->evlist
, sample
->id
);
1037 thread
= machine__findnew_thread(machine
, event
->fork
.pid
, event
->fork
.tid
);
1038 if (thread
== NULL
) {
1039 pr_debug("problem processing EXIT event, skipping it.\n");
1043 if (!evsel
->attr
.sample_id_all
) {
1046 sample
->tid
= event
->fork
.tid
;
1047 sample
->pid
= event
->fork
.pid
;
1049 print_sample_start(sample
, thread
, evsel
);
1050 perf_event__fprintf(event
, stdout
);
1052 if (perf_event__process_exit(tool
, event
, sample
, machine
) < 0)
1055 thread__put(thread
);
1059 static int process_mmap_event(struct perf_tool
*tool
,
1060 union perf_event
*event
,
1061 struct perf_sample
*sample
,
1062 struct machine
*machine
)
1064 struct thread
*thread
;
1065 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1066 struct perf_session
*session
= script
->session
;
1067 struct perf_evsel
*evsel
= perf_evlist__id2evsel(session
->evlist
, sample
->id
);
1069 if (perf_event__process_mmap(tool
, event
, sample
, machine
) < 0)
1072 thread
= machine__findnew_thread(machine
, event
->mmap
.pid
, event
->mmap
.tid
);
1073 if (thread
== NULL
) {
1074 pr_debug("problem processing MMAP event, skipping it.\n");
1078 if (!evsel
->attr
.sample_id_all
) {
1081 sample
->tid
= event
->mmap
.tid
;
1082 sample
->pid
= event
->mmap
.pid
;
1084 print_sample_start(sample
, thread
, evsel
);
1085 perf_event__fprintf(event
, stdout
);
1086 thread__put(thread
);
1090 static int process_mmap2_event(struct perf_tool
*tool
,
1091 union perf_event
*event
,
1092 struct perf_sample
*sample
,
1093 struct machine
*machine
)
1095 struct thread
*thread
;
1096 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1097 struct perf_session
*session
= script
->session
;
1098 struct perf_evsel
*evsel
= perf_evlist__id2evsel(session
->evlist
, sample
->id
);
1100 if (perf_event__process_mmap2(tool
, event
, sample
, machine
) < 0)
1103 thread
= machine__findnew_thread(machine
, event
->mmap2
.pid
, event
->mmap2
.tid
);
1104 if (thread
== NULL
) {
1105 pr_debug("problem processing MMAP2 event, skipping it.\n");
1109 if (!evsel
->attr
.sample_id_all
) {
1112 sample
->tid
= event
->mmap2
.tid
;
1113 sample
->pid
= event
->mmap2
.pid
;
1115 print_sample_start(sample
, thread
, evsel
);
1116 perf_event__fprintf(event
, stdout
);
1117 thread__put(thread
);
1121 static int process_switch_event(struct perf_tool
*tool
,
1122 union perf_event
*event
,
1123 struct perf_sample
*sample
,
1124 struct machine
*machine
)
1126 struct thread
*thread
;
1127 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1128 struct perf_session
*session
= script
->session
;
1129 struct perf_evsel
*evsel
= perf_evlist__id2evsel(session
->evlist
, sample
->id
);
1131 if (perf_event__process_switch(tool
, event
, sample
, machine
) < 0)
1134 thread
= machine__findnew_thread(machine
, sample
->pid
,
1136 if (thread
== NULL
) {
1137 pr_debug("problem processing SWITCH event, skipping it.\n");
1141 print_sample_start(sample
, thread
, evsel
);
1142 perf_event__fprintf(event
, stdout
);
1143 thread__put(thread
);
1147 static void sig_handler(int sig __maybe_unused
)
1152 static int __cmd_script(struct perf_script
*script
)
1156 signal(SIGINT
, sig_handler
);
1158 /* override event processing functions */
1159 if (script
->show_task_events
) {
1160 script
->tool
.comm
= process_comm_event
;
1161 script
->tool
.fork
= process_fork_event
;
1162 script
->tool
.exit
= process_exit_event
;
1164 if (script
->show_mmap_events
) {
1165 script
->tool
.mmap
= process_mmap_event
;
1166 script
->tool
.mmap2
= process_mmap2_event
;
1168 if (script
->show_switch_events
)
1169 script
->tool
.context_switch
= process_switch_event
;
1171 ret
= perf_session__process_events(script
->session
);
1174 pr_err("Misordered timestamps: %" PRIu64
"\n", nr_unordered
);
1179 struct script_spec
{
1180 struct list_head node
;
1181 struct scripting_ops
*ops
;
1185 static LIST_HEAD(script_specs
);
1187 static struct script_spec
*script_spec__new(const char *spec
,
1188 struct scripting_ops
*ops
)
1190 struct script_spec
*s
= malloc(sizeof(*s
) + strlen(spec
) + 1);
1193 strcpy(s
->spec
, spec
);
1200 static void script_spec__add(struct script_spec
*s
)
1202 list_add_tail(&s
->node
, &script_specs
);
1205 static struct script_spec
*script_spec__find(const char *spec
)
1207 struct script_spec
*s
;
1209 list_for_each_entry(s
, &script_specs
, node
)
1210 if (strcasecmp(s
->spec
, spec
) == 0)
1215 int script_spec_register(const char *spec
, struct scripting_ops
*ops
)
1217 struct script_spec
*s
;
1219 s
= script_spec__find(spec
);
1223 s
= script_spec__new(spec
, ops
);
1227 script_spec__add(s
);
1232 static struct scripting_ops
*script_spec__lookup(const char *spec
)
1234 struct script_spec
*s
= script_spec__find(spec
);
1241 static void list_available_languages(void)
1243 struct script_spec
*s
;
1245 fprintf(stderr
, "\n");
1246 fprintf(stderr
, "Scripting language extensions (used in "
1247 "perf script -s [spec:]script.[spec]):\n\n");
1249 list_for_each_entry(s
, &script_specs
, node
)
1250 fprintf(stderr
, " %-42s [%s]\n", s
->spec
, s
->ops
->name
);
1252 fprintf(stderr
, "\n");
1255 static int parse_scriptname(const struct option
*opt __maybe_unused
,
1256 const char *str
, int unset __maybe_unused
)
1258 char spec
[PATH_MAX
];
1259 const char *script
, *ext
;
1262 if (strcmp(str
, "lang") == 0) {
1263 list_available_languages();
1267 script
= strchr(str
, ':');
1270 if (len
>= PATH_MAX
) {
1271 fprintf(stderr
, "invalid language specifier");
1274 strncpy(spec
, str
, len
);
1276 scripting_ops
= script_spec__lookup(spec
);
1277 if (!scripting_ops
) {
1278 fprintf(stderr
, "invalid language specifier");
1284 ext
= strrchr(script
, '.');
1286 fprintf(stderr
, "invalid script extension");
1289 scripting_ops
= script_spec__lookup(++ext
);
1290 if (!scripting_ops
) {
1291 fprintf(stderr
, "invalid script extension");
1296 script_name
= strdup(script
);
1301 static int parse_output_fields(const struct option
*opt __maybe_unused
,
1302 const char *arg
, int unset __maybe_unused
)
1305 int i
, imax
= ARRAY_SIZE(all_output_options
);
1308 char *str
= strdup(arg
);
1314 /* first word can state for which event type the user is specifying
1315 * the fields. If no type exists, the specified fields apply to all
1316 * event types found in the file minus the invalid fields for a type.
1318 tok
= strchr(str
, ':');
1322 if (!strcmp(str
, "hw"))
1323 type
= PERF_TYPE_HARDWARE
;
1324 else if (!strcmp(str
, "sw"))
1325 type
= PERF_TYPE_SOFTWARE
;
1326 else if (!strcmp(str
, "trace"))
1327 type
= PERF_TYPE_TRACEPOINT
;
1328 else if (!strcmp(str
, "raw"))
1329 type
= PERF_TYPE_RAW
;
1330 else if (!strcmp(str
, "break"))
1331 type
= PERF_TYPE_BREAKPOINT
;
1333 fprintf(stderr
, "Invalid event type in field string.\n");
1338 if (output
[type
].user_set
)
1339 pr_warning("Overriding previous field request for %s events.\n",
1342 output
[type
].fields
= 0;
1343 output
[type
].user_set
= true;
1344 output
[type
].wildcard_set
= false;
1348 if (strlen(str
) == 0) {
1350 "Cannot set fields to 'none' for all event types.\n");
1355 if (output_set_by_user())
1356 pr_warning("Overriding previous field request for all events.\n");
1358 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
1359 output
[j
].fields
= 0;
1360 output
[j
].user_set
= true;
1361 output
[j
].wildcard_set
= true;
1365 for (tok
= strtok(tok
, ","); tok
; tok
= strtok(NULL
, ",")) {
1366 for (i
= 0; i
< imax
; ++i
) {
1367 if (strcmp(tok
, all_output_options
[i
].str
) == 0)
1370 if (i
== imax
&& strcmp(tok
, "flags") == 0) {
1375 fprintf(stderr
, "Invalid field requested.\n");
1381 /* add user option to all events types for
1384 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
1385 if (output
[j
].invalid_fields
& all_output_options
[i
].field
) {
1386 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1387 all_output_options
[i
].str
, event_type(j
));
1389 output
[j
].fields
|= all_output_options
[i
].field
;
1392 if (output
[type
].invalid_fields
& all_output_options
[i
].field
) {
1393 fprintf(stderr
, "\'%s\' not valid for %s events.\n",
1394 all_output_options
[i
].str
, event_type(type
));
1399 output
[type
].fields
|= all_output_options
[i
].field
;
1404 if (output
[type
].fields
== 0) {
1405 pr_debug("No fields requested for %s type. "
1406 "Events will not be displayed.\n", event_type(type
));
1415 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1416 static int is_directory(const char *base_path
, const struct dirent
*dent
)
1418 char path
[PATH_MAX
];
1421 sprintf(path
, "%s/%s", base_path
, dent
->d_name
);
1422 if (stat(path
, &st
))
1425 return S_ISDIR(st
.st_mode
);
1428 #define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
1429 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
1430 if ((lang_dirent->d_type == DT_DIR || \
1431 (lang_dirent->d_type == DT_UNKNOWN && \
1432 is_directory(scripts_path, lang_dirent))) && \
1433 (strcmp(lang_dirent->d_name, ".")) && \
1434 (strcmp(lang_dirent->d_name, "..")))
1436 #define for_each_script(lang_path, lang_dir, script_dirent) \
1437 while ((script_dirent = readdir(lang_dir)) != NULL) \
1438 if (script_dirent->d_type != DT_DIR && \
1439 (script_dirent->d_type != DT_UNKNOWN || \
1440 !is_directory(lang_path, script_dirent)))
1443 #define RECORD_SUFFIX "-record"
1444 #define REPORT_SUFFIX "-report"
1446 struct script_desc
{
1447 struct list_head node
;
1453 static LIST_HEAD(script_descs
);
1455 static struct script_desc
*script_desc__new(const char *name
)
1457 struct script_desc
*s
= zalloc(sizeof(*s
));
1459 if (s
!= NULL
&& name
)
1460 s
->name
= strdup(name
);
1465 static void script_desc__delete(struct script_desc
*s
)
1468 zfree(&s
->half_liner
);
1473 static void script_desc__add(struct script_desc
*s
)
1475 list_add_tail(&s
->node
, &script_descs
);
1478 static struct script_desc
*script_desc__find(const char *name
)
1480 struct script_desc
*s
;
1482 list_for_each_entry(s
, &script_descs
, node
)
1483 if (strcasecmp(s
->name
, name
) == 0)
1488 static struct script_desc
*script_desc__findnew(const char *name
)
1490 struct script_desc
*s
= script_desc__find(name
);
1495 s
= script_desc__new(name
);
1497 goto out_delete_desc
;
1499 script_desc__add(s
);
1504 script_desc__delete(s
);
1509 static const char *ends_with(const char *str
, const char *suffix
)
1511 size_t suffix_len
= strlen(suffix
);
1512 const char *p
= str
;
1514 if (strlen(str
) > suffix_len
) {
1515 p
= str
+ strlen(str
) - suffix_len
;
1516 if (!strncmp(p
, suffix
, suffix_len
))
1523 static int read_script_info(struct script_desc
*desc
, const char *filename
)
1525 char line
[BUFSIZ
], *p
;
1528 fp
= fopen(filename
, "r");
1532 while (fgets(line
, sizeof(line
), fp
)) {
1539 if (strlen(p
) && *p
== '!')
1543 if (strlen(p
) && p
[strlen(p
) - 1] == '\n')
1544 p
[strlen(p
) - 1] = '\0';
1546 if (!strncmp(p
, "description:", strlen("description:"))) {
1547 p
+= strlen("description:");
1548 desc
->half_liner
= strdup(ltrim(p
));
1552 if (!strncmp(p
, "args:", strlen("args:"))) {
1553 p
+= strlen("args:");
1554 desc
->args
= strdup(ltrim(p
));
1564 static char *get_script_root(struct dirent
*script_dirent
, const char *suffix
)
1566 char *script_root
, *str
;
1568 script_root
= strdup(script_dirent
->d_name
);
1572 str
= (char *)ends_with(script_root
, suffix
);
1582 static int list_available_scripts(const struct option
*opt __maybe_unused
,
1583 const char *s __maybe_unused
,
1584 int unset __maybe_unused
)
1586 struct dirent
*script_dirent
, *lang_dirent
;
1587 char scripts_path
[MAXPATHLEN
];
1588 DIR *scripts_dir
, *lang_dir
;
1589 char script_path
[MAXPATHLEN
];
1590 char lang_path
[MAXPATHLEN
];
1591 struct script_desc
*desc
;
1592 char first_half
[BUFSIZ
];
1595 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", get_argv_exec_path());
1597 scripts_dir
= opendir(scripts_path
);
1601 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
) {
1602 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1603 lang_dirent
->d_name
);
1604 lang_dir
= opendir(lang_path
);
1608 for_each_script(lang_path
, lang_dir
, script_dirent
) {
1609 script_root
= get_script_root(script_dirent
, REPORT_SUFFIX
);
1611 desc
= script_desc__findnew(script_root
);
1612 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1613 lang_path
, script_dirent
->d_name
);
1614 read_script_info(desc
, script_path
);
1620 fprintf(stdout
, "List of available trace scripts:\n");
1621 list_for_each_entry(desc
, &script_descs
, node
) {
1622 sprintf(first_half
, "%s %s", desc
->name
,
1623 desc
->args
? desc
->args
: "");
1624 fprintf(stdout
, " %-36s %s\n", first_half
,
1625 desc
->half_liner
? desc
->half_liner
: "");
1632 * Some scripts specify the required events in their "xxx-record" file,
1633 * this function will check if the events in perf.data match those
1634 * mentioned in the "xxx-record".
1636 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1637 * which is covered well now. And new parsing code should be added to
1638 * cover the future complexing formats like event groups etc.
1640 static int check_ev_match(char *dir_name
, char *scriptname
,
1641 struct perf_session
*session
)
1643 char filename
[MAXPATHLEN
], evname
[128];
1644 char line
[BUFSIZ
], *p
;
1645 struct perf_evsel
*pos
;
1649 sprintf(filename
, "%s/bin/%s-record", dir_name
, scriptname
);
1651 fp
= fopen(filename
, "r");
1655 while (fgets(line
, sizeof(line
), fp
)) {
1661 p
= strstr(p
, "-e");
1667 len
= strcspn(p
, " \t");
1671 snprintf(evname
, len
+ 1, "%s", p
);
1674 evlist__for_each(session
->evlist
, pos
) {
1675 if (!strcmp(perf_evsel__name(pos
), evname
)) {
1693 * Return -1 if none is found, otherwise the actual scripts number.
1695 * Currently the only user of this function is the script browser, which
1696 * will list all statically runnable scripts, select one, execute it and
1697 * show the output in a perf browser.
1699 int find_scripts(char **scripts_array
, char **scripts_path_array
)
1701 struct dirent
*script_dirent
, *lang_dirent
;
1702 char scripts_path
[MAXPATHLEN
], lang_path
[MAXPATHLEN
];
1703 DIR *scripts_dir
, *lang_dir
;
1704 struct perf_session
*session
;
1705 struct perf_data_file file
= {
1707 .mode
= PERF_DATA_MODE_READ
,
1712 session
= perf_session__new(&file
, false, NULL
);
1716 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", get_argv_exec_path());
1718 scripts_dir
= opendir(scripts_path
);
1720 perf_session__delete(session
);
1724 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
) {
1725 snprintf(lang_path
, MAXPATHLEN
, "%s/%s", scripts_path
,
1726 lang_dirent
->d_name
);
1728 if (strstr(lang_path
, "perl"))
1732 if (strstr(lang_path
, "python"))
1736 lang_dir
= opendir(lang_path
);
1740 for_each_script(lang_path
, lang_dir
, script_dirent
) {
1741 /* Skip those real time scripts: xxxtop.p[yl] */
1742 if (strstr(script_dirent
->d_name
, "top."))
1744 sprintf(scripts_path_array
[i
], "%s/%s", lang_path
,
1745 script_dirent
->d_name
);
1746 temp
= strchr(script_dirent
->d_name
, '.');
1747 snprintf(scripts_array
[i
],
1748 (temp
- script_dirent
->d_name
) + 1,
1749 "%s", script_dirent
->d_name
);
1751 if (check_ev_match(lang_path
,
1752 scripts_array
[i
], session
))
1760 closedir(scripts_dir
);
1761 perf_session__delete(session
);
1765 static char *get_script_path(const char *script_root
, const char *suffix
)
1767 struct dirent
*script_dirent
, *lang_dirent
;
1768 char scripts_path
[MAXPATHLEN
];
1769 char script_path
[MAXPATHLEN
];
1770 DIR *scripts_dir
, *lang_dir
;
1771 char lang_path
[MAXPATHLEN
];
1772 char *__script_root
;
1774 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", get_argv_exec_path());
1776 scripts_dir
= opendir(scripts_path
);
1780 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
) {
1781 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1782 lang_dirent
->d_name
);
1783 lang_dir
= opendir(lang_path
);
1787 for_each_script(lang_path
, lang_dir
, script_dirent
) {
1788 __script_root
= get_script_root(script_dirent
, suffix
);
1789 if (__script_root
&& !strcmp(script_root
, __script_root
)) {
1790 free(__script_root
);
1792 closedir(scripts_dir
);
1793 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1794 lang_path
, script_dirent
->d_name
);
1795 return strdup(script_path
);
1797 free(__script_root
);
1801 closedir(scripts_dir
);
1806 static bool is_top_script(const char *script_path
)
1808 return ends_with(script_path
, "top") == NULL
? false : true;
1811 static int has_required_arg(char *script_path
)
1813 struct script_desc
*desc
;
1817 desc
= script_desc__new(NULL
);
1819 if (read_script_info(desc
, script_path
))
1825 for (p
= desc
->args
; *p
; p
++)
1829 script_desc__delete(desc
);
1834 static int have_cmd(int argc
, const char **argv
)
1836 char **__argv
= malloc(sizeof(const char *) * argc
);
1839 pr_err("malloc failed\n");
1843 memcpy(__argv
, argv
, sizeof(const char *) * argc
);
1844 argc
= parse_options(argc
, (const char **)__argv
, record_options
,
1845 NULL
, PARSE_OPT_STOP_AT_NON_OPTION
);
1848 system_wide
= (argc
== 0);
1853 static void script__setup_sample_type(struct perf_script
*script
)
1855 struct perf_session
*session
= script
->session
;
1856 u64 sample_type
= perf_evlist__combined_sample_type(session
->evlist
);
1858 if (symbol_conf
.use_callchain
|| symbol_conf
.cumulate_callchain
) {
1859 if ((sample_type
& PERF_SAMPLE_REGS_USER
) &&
1860 (sample_type
& PERF_SAMPLE_STACK_USER
))
1861 callchain_param
.record_mode
= CALLCHAIN_DWARF
;
1862 else if (sample_type
& PERF_SAMPLE_BRANCH_STACK
)
1863 callchain_param
.record_mode
= CALLCHAIN_LBR
;
1865 callchain_param
.record_mode
= CALLCHAIN_FP
;
1869 static int process_stat_round_event(struct perf_tool
*tool __maybe_unused
,
1870 union perf_event
*event
,
1871 struct perf_session
*session
)
1873 struct stat_round_event
*round
= &event
->stat_round
;
1874 struct perf_evsel
*counter
;
1876 evlist__for_each(session
->evlist
, counter
) {
1877 perf_stat_process_counter(&stat_config
, counter
);
1878 process_stat(counter
, round
->time
);
1881 process_stat_interval(round
->time
);
1885 static int process_stat_config_event(struct perf_tool
*tool __maybe_unused
,
1886 union perf_event
*event
,
1887 struct perf_session
*session __maybe_unused
)
1889 perf_event__read_stat_config(&stat_config
, &event
->stat_config
);
1893 static int set_maps(struct perf_script
*script
)
1895 struct perf_evlist
*evlist
= script
->session
->evlist
;
1897 if (!script
->cpus
|| !script
->threads
)
1900 if (WARN_ONCE(script
->allocated
, "stats double allocation\n"))
1903 perf_evlist__set_maps(evlist
, script
->cpus
, script
->threads
);
1905 if (perf_evlist__alloc_stats(evlist
, true))
1908 script
->allocated
= true;
1913 int process_thread_map_event(struct perf_tool
*tool
,
1914 union perf_event
*event
,
1915 struct perf_session
*session __maybe_unused
)
1917 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1919 if (script
->threads
) {
1920 pr_warning("Extra thread map event, ignoring.\n");
1924 script
->threads
= thread_map__new_event(&event
->thread_map
);
1925 if (!script
->threads
)
1928 return set_maps(script
);
1932 int process_cpu_map_event(struct perf_tool
*tool __maybe_unused
,
1933 union perf_event
*event
,
1934 struct perf_session
*session __maybe_unused
)
1936 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1939 pr_warning("Extra cpu map event, ignoring.\n");
1943 script
->cpus
= cpu_map__new_data(&event
->cpu_map
.data
);
1947 return set_maps(script
);
1950 int cmd_script(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1952 bool show_full_info
= false;
1953 bool header
= false;
1954 bool header_only
= false;
1955 bool script_started
= false;
1956 char *rec_script_path
= NULL
;
1957 char *rep_script_path
= NULL
;
1958 struct perf_session
*session
;
1959 struct itrace_synth_opts itrace_synth_opts
= { .set
= false, };
1960 char *script_path
= NULL
;
1961 const char **__argv
;
1963 struct perf_script script
= {
1965 .sample
= process_sample_event
,
1966 .mmap
= perf_event__process_mmap
,
1967 .mmap2
= perf_event__process_mmap2
,
1968 .comm
= perf_event__process_comm
,
1969 .exit
= perf_event__process_exit
,
1970 .fork
= perf_event__process_fork
,
1971 .attr
= process_attr
,
1972 .event_update
= perf_event__process_event_update
,
1973 .tracing_data
= perf_event__process_tracing_data
,
1974 .build_id
= perf_event__process_build_id
,
1975 .id_index
= perf_event__process_id_index
,
1976 .auxtrace_info
= perf_event__process_auxtrace_info
,
1977 .auxtrace
= perf_event__process_auxtrace
,
1978 .auxtrace_error
= perf_event__process_auxtrace_error
,
1979 .stat
= perf_event__process_stat_event
,
1980 .stat_round
= process_stat_round_event
,
1981 .stat_config
= process_stat_config_event
,
1982 .thread_map
= process_thread_map_event
,
1983 .cpu_map
= process_cpu_map_event
,
1984 .ordered_events
= true,
1985 .ordering_requires_timestamps
= true,
1988 struct perf_data_file file
= {
1989 .mode
= PERF_DATA_MODE_READ
,
1991 const struct option options
[] = {
1992 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
1993 "dump raw trace in ASCII"),
1994 OPT_INCR('v', "verbose", &verbose
,
1995 "be more verbose (show symbol address, etc)"),
1996 OPT_BOOLEAN('L', "Latency", &latency_format
,
1997 "show latency attributes (irqs/preemption disabled, etc)"),
1998 OPT_CALLBACK_NOOPT('l', "list", NULL
, NULL
, "list available scripts",
1999 list_available_scripts
),
2000 OPT_CALLBACK('s', "script", NULL
, "name",
2001 "script file name (lang:script name, script name, or *)",
2003 OPT_STRING('g', "gen-script", &generate_script_lang
, "lang",
2004 "generate perf-script.xx script in specified language"),
2005 OPT_STRING('i', "input", &input_name
, "file", "input file name"),
2006 OPT_BOOLEAN('d', "debug-mode", &debug_mode
,
2007 "do various checks like samples ordering and lost events"),
2008 OPT_BOOLEAN(0, "header", &header
, "Show data header."),
2009 OPT_BOOLEAN(0, "header-only", &header_only
, "Show only data header."),
2010 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
2011 "file", "vmlinux pathname"),
2012 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
2013 "file", "kallsyms pathname"),
2014 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain
,
2015 "When printing symbols do not display call chain"),
2016 OPT_CALLBACK(0, "symfs", NULL
, "directory",
2017 "Look for files with symbols relative to this directory",
2018 symbol__config_symfs
),
2019 OPT_CALLBACK('F', "fields", NULL
, "str",
2020 "comma separated output fields prepend with 'type:'. "
2021 "Valid types: hw,sw,trace,raw. "
2022 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2023 "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields
),
2024 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
2025 "system-wide collection from all CPUs"),
2026 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
2027 "only consider these symbols"),
2028 OPT_STRING('C', "cpu", &cpu_list
, "cpu", "list of cpus to profile"),
2029 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
2030 "only display events for these comms"),
2031 OPT_STRING(0, "pid", &symbol_conf
.pid_list_str
, "pid[,pid...]",
2032 "only consider symbols in these pids"),
2033 OPT_STRING(0, "tid", &symbol_conf
.tid_list_str
, "tid[,tid...]",
2034 "only consider symbols in these tids"),
2035 OPT_UINTEGER(0, "max-stack", &scripting_max_stack
,
2036 "Set the maximum stack depth when parsing the callchain, "
2037 "anything beyond the specified depth will be ignored. "
2038 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH
)),
2039 OPT_BOOLEAN('I', "show-info", &show_full_info
,
2040 "display extended information from perf.data file"),
2041 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf
.show_kernel_path
,
2042 "Show the path of [kernel.kallsyms]"),
2043 OPT_BOOLEAN('\0', "show-task-events", &script
.show_task_events
,
2044 "Show the fork/comm/exit events"),
2045 OPT_BOOLEAN('\0', "show-mmap-events", &script
.show_mmap_events
,
2046 "Show the mmap events"),
2047 OPT_BOOLEAN('\0', "show-switch-events", &script
.show_switch_events
,
2048 "Show context switch events (if recorded)"),
2049 OPT_BOOLEAN('f', "force", &file
.force
, "don't complain, do it"),
2050 OPT_BOOLEAN(0, "ns", &nanosecs
,
2051 "Use 9 decimal places when displaying time"),
2052 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts
, NULL
, "opts",
2053 "Instruction Tracing options",
2054 itrace_parse_synth_opts
),
2055 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename
,
2056 "Show full source file name path for source lines"),
2057 OPT_BOOLEAN(0, "demangle", &symbol_conf
.demangle
,
2058 "Enable symbol demangling"),
2059 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf
.demangle_kernel
,
2060 "Enable kernel symbol demangling"),
2064 const char * const script_subcommands
[] = { "record", "report", NULL
};
2065 const char *script_usage
[] = {
2066 "perf script [<options>]",
2067 "perf script [<options>] record <script> [<record-options>] <command>",
2068 "perf script [<options>] report <script> [script-args]",
2069 "perf script [<options>] <script> [<record-options>] <command>",
2070 "perf script [<options>] <top-script> [script-args]",
2076 argc
= parse_options_subcommand(argc
, argv
, options
, script_subcommands
, script_usage
,
2077 PARSE_OPT_STOP_AT_NON_OPTION
);
2079 file
.path
= input_name
;
2081 if (argc
> 1 && !strncmp(argv
[0], "rec", strlen("rec"))) {
2082 rec_script_path
= get_script_path(argv
[1], RECORD_SUFFIX
);
2083 if (!rec_script_path
)
2084 return cmd_record(argc
, argv
, NULL
);
2087 if (argc
> 1 && !strncmp(argv
[0], "rep", strlen("rep"))) {
2088 rep_script_path
= get_script_path(argv
[1], REPORT_SUFFIX
);
2089 if (!rep_script_path
) {
2091 "Please specify a valid report script"
2092 "(see 'perf script -l' for listing)\n");
2097 if (itrace_synth_opts
.callchain
&&
2098 itrace_synth_opts
.callchain_sz
> scripting_max_stack
)
2099 scripting_max_stack
= itrace_synth_opts
.callchain_sz
;
2101 /* make sure PERF_EXEC_PATH is set for scripts */
2102 set_argv_exec_path(get_argv_exec_path());
2104 if (argc
&& !script_name
&& !rec_script_path
&& !rep_script_path
) {
2109 rec_script_path
= get_script_path(argv
[0], RECORD_SUFFIX
);
2110 rep_script_path
= get_script_path(argv
[0], REPORT_SUFFIX
);
2112 if (!rec_script_path
&& !rep_script_path
) {
2113 usage_with_options_msg(script_usage
, options
,
2114 "Couldn't find script `%s'\n\n See perf"
2115 " script -l for available scripts.\n", argv
[0]);
2118 if (is_top_script(argv
[0])) {
2119 rep_args
= argc
- 1;
2123 rep_args
= has_required_arg(rep_script_path
);
2124 rec_args
= (argc
- 1) - rep_args
;
2126 usage_with_options_msg(script_usage
, options
,
2127 "`%s' script requires options."
2128 "\n\n See perf script -l for available "
2129 "scripts and options.\n", argv
[0]);
2133 if (pipe(live_pipe
) < 0) {
2134 perror("failed to create pipe");
2140 perror("failed to fork");
2147 dup2(live_pipe
[1], 1);
2148 close(live_pipe
[0]);
2150 if (is_top_script(argv
[0])) {
2152 } else if (!system_wide
) {
2153 if (have_cmd(argc
- rep_args
, &argv
[rep_args
]) != 0) {
2159 __argv
= malloc((argc
+ 6) * sizeof(const char *));
2161 pr_err("malloc failed\n");
2166 __argv
[j
++] = "/bin/sh";
2167 __argv
[j
++] = rec_script_path
;
2173 for (i
= rep_args
+ 1; i
< argc
; i
++)
2174 __argv
[j
++] = argv
[i
];
2177 execvp("/bin/sh", (char **)__argv
);
2182 dup2(live_pipe
[0], 0);
2183 close(live_pipe
[1]);
2185 __argv
= malloc((argc
+ 4) * sizeof(const char *));
2187 pr_err("malloc failed\n");
2193 __argv
[j
++] = "/bin/sh";
2194 __argv
[j
++] = rep_script_path
;
2195 for (i
= 1; i
< rep_args
+ 1; i
++)
2196 __argv
[j
++] = argv
[i
];
2201 execvp("/bin/sh", (char **)__argv
);
2206 if (rec_script_path
)
2207 script_path
= rec_script_path
;
2208 if (rep_script_path
)
2209 script_path
= rep_script_path
;
2214 if (!rec_script_path
)
2215 system_wide
= false;
2216 else if (!system_wide
) {
2217 if (have_cmd(argc
- 1, &argv
[1]) != 0) {
2223 __argv
= malloc((argc
+ 2) * sizeof(const char *));
2225 pr_err("malloc failed\n");
2230 __argv
[j
++] = "/bin/sh";
2231 __argv
[j
++] = script_path
;
2234 for (i
= 2; i
< argc
; i
++)
2235 __argv
[j
++] = argv
[i
];
2238 execvp("/bin/sh", (char **)__argv
);
2246 session
= perf_session__new(&file
, false, &script
.tool
);
2247 if (session
== NULL
)
2250 if (header
|| header_only
) {
2251 perf_session__fprintf_info(session
, stdout
, show_full_info
);
2256 if (symbol__init(&session
->header
.env
) < 0)
2259 script
.session
= session
;
2260 script__setup_sample_type(&script
);
2262 session
->itrace_synth_opts
= &itrace_synth_opts
;
2265 err
= perf_session__cpu_bitmap(session
, cpu_list
, cpu_bitmap
);
2271 symbol_conf
.use_callchain
= true;
2273 symbol_conf
.use_callchain
= false;
2275 if (session
->tevent
.pevent
&&
2276 pevent_set_function_resolver(session
->tevent
.pevent
,
2277 machine__resolve_kernel_addr
,
2278 &session
->machines
.host
) < 0) {
2279 pr_err("%s: failed to set libtraceevent function resolver\n", __func__
);
2283 if (generate_script_lang
) {
2284 struct stat perf_stat
;
2287 if (output_set_by_user()) {
2289 "custom fields not supported for generated scripts");
2294 input
= open(file
.path
, O_RDONLY
); /* input_name */
2297 perror("failed to open file");
2301 err
= fstat(input
, &perf_stat
);
2303 perror("failed to stat file");
2307 if (!perf_stat
.st_size
) {
2308 fprintf(stderr
, "zero-sized file, nothing to do!\n");
2312 scripting_ops
= script_spec__lookup(generate_script_lang
);
2313 if (!scripting_ops
) {
2314 fprintf(stderr
, "invalid language specifier");
2319 err
= scripting_ops
->generate_script(session
->tevent
.pevent
,
2325 err
= scripting_ops
->start_script(script_name
, argc
, argv
);
2328 pr_debug("perf script started with script %s\n\n", script_name
);
2329 script_started
= true;
2333 err
= perf_session__check_output_opt(session
);
2337 err
= __cmd_script(&script
);
2342 perf_evlist__free_stats(session
->evlist
);
2343 perf_session__delete(session
);
2346 cleanup_scripting();