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>
26 #include "util/mem-events.h"
28 static char const *script_name
;
29 static char const *generate_script_lang
;
30 static bool debug_mode
;
31 static u64 last_timestamp
;
32 static u64 nr_unordered
;
33 static bool no_callchain
;
34 static bool latency_format
;
35 static bool system_wide
;
36 static bool print_flags
;
38 static const char *cpu_list
;
39 static DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
40 static struct perf_stat_config stat_config
;
42 unsigned int scripting_max_stack
= PERF_MAX_STACK_DEPTH
;
44 enum 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,
67 struct output_option
{
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
},
93 /* default set to maintain compatibility with current format */
97 unsigned int print_ip_opts
;
100 } output
[PERF_TYPE_MAX
] = {
102 [PERF_TYPE_HARDWARE
] = {
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
|
111 .invalid_fields
= PERF_OUTPUT_TRACE
| PERF_OUTPUT_BPF_OUTPUT
,
114 [PERF_TYPE_SOFTWARE
] = {
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
,
123 .invalid_fields
= PERF_OUTPUT_TRACE
,
126 [PERF_TYPE_TRACEPOINT
] = {
129 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
130 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
131 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_TRACE
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
,
144 .invalid_fields
= PERF_OUTPUT_TRACE
| PERF_OUTPUT_BPF_OUTPUT
,
147 [PERF_TYPE_BREAKPOINT
] = {
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
|
156 .invalid_fields
= PERF_OUTPUT_TRACE
| PERF_OUTPUT_BPF_OUTPUT
,
160 static bool output_set_by_user(void)
163 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
164 if (output
[j
].user_set
)
170 static const char *output_field2str(enum perf_output_field field
)
172 int i
, imax
= ARRAY_SIZE(all_output_options
);
173 const char *str
= "";
175 for (i
= 0; i
< imax
; ++i
) {
176 if (all_output_options
[i
].field
== field
) {
177 str
= all_output_options
[i
].str
;
184 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
186 static int perf_evsel__do_check_stype(struct perf_evsel
*evsel
,
187 u64 sample_type
, const char *sample_msg
,
188 enum perf_output_field field
,
191 struct perf_event_attr
*attr
= &evsel
->attr
;
192 int type
= attr
->type
;
195 if (attr
->sample_type
& sample_type
)
198 if (output
[type
].user_set
) {
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
));
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
));
218 static int perf_evsel__check_stype(struct perf_evsel
*evsel
,
219 u64 sample_type
, const char *sample_msg
,
220 enum perf_output_field field
)
222 return perf_evsel__do_check_stype(evsel
, sample_type
, sample_msg
, field
,
226 static int perf_evsel__check_attr(struct perf_evsel
*evsel
,
227 struct perf_session
*session
)
229 struct perf_event_attr
*attr
= &evsel
->attr
;
232 if (perf_header__has_feat(&session
->header
, HEADER_STAT
))
235 allow_user_set
= perf_header__has_feat(&session
->header
,
238 if (PRINT_FIELD(TRACE
) &&
239 !perf_session__has_traces(session
, "record -R"))
242 if (PRINT_FIELD(IP
)) {
243 if (perf_evsel__check_stype(evsel
, PERF_SAMPLE_IP
, "IP",
248 if (PRINT_FIELD(ADDR
) &&
249 perf_evsel__do_check_stype(evsel
, PERF_SAMPLE_ADDR
, "ADDR",
250 PERF_OUTPUT_ADDR
, allow_user_set
))
253 if (PRINT_FIELD(DATA_SRC
) &&
254 perf_evsel__check_stype(evsel
, PERF_SAMPLE_DATA_SRC
, "DATA_SRC",
255 PERF_OUTPUT_DATA_SRC
))
258 if (PRINT_FIELD(WEIGHT
) &&
259 perf_evsel__check_stype(evsel
, PERF_SAMPLE_WEIGHT
, "WEIGHT",
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 "
269 if (PRINT_FIELD(SYMOFFSET
) && !PRINT_FIELD(SYM
)) {
270 pr_err("Display of offsets requested but symbol is not"
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 "
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");
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
))
291 if (PRINT_FIELD(TIME
) &&
292 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TIME
, "TIME",
296 if (PRINT_FIELD(CPU
) &&
297 perf_evsel__do_check_stype(evsel
, PERF_SAMPLE_CPU
, "CPU",
298 PERF_OUTPUT_CPU
, allow_user_set
))
301 if (PRINT_FIELD(PERIOD
) &&
302 perf_evsel__check_stype(evsel
, PERF_SAMPLE_PERIOD
, "PERIOD",
306 if (PRINT_FIELD(IREGS
) &&
307 perf_evsel__check_stype(evsel
, PERF_SAMPLE_REGS_INTR
, "IREGS",
314 static void set_print_ip_opts(struct perf_event_attr
*attr
)
316 unsigned int type
= attr
->type
;
318 output
[type
].print_ip_opts
= 0;
320 output
[type
].print_ip_opts
|= PRINT_IP_OPT_IP
;
322 if (PRINT_FIELD(SYM
))
323 output
[type
].print_ip_opts
|= PRINT_IP_OPT_SYM
;
325 if (PRINT_FIELD(DSO
))
326 output
[type
].print_ip_opts
|= PRINT_IP_OPT_DSO
;
328 if (PRINT_FIELD(SYMOFFSET
))
329 output
[type
].print_ip_opts
|= PRINT_IP_OPT_SYMOFFSET
;
331 if (PRINT_FIELD(SRCLINE
))
332 output
[type
].print_ip_opts
|= PRINT_IP_OPT_SRCLINE
;
336 * verify all user requested events exist and the samples
337 * have the expected data
339 static int perf_session__check_output_opt(struct perf_session
*session
)
342 struct perf_evsel
*evsel
;
344 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
345 evsel
= perf_session__find_first_evtype(session
, j
);
348 * even if fields is set to 0 (ie., show nothing) event must
349 * exist if user explicitly includes it on the command line
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",
358 if (evsel
&& output
[j
].fields
&&
359 perf_evsel__check_attr(evsel
, session
))
365 set_print_ip_opts(&evsel
->attr
);
369 bool use_callchain
= false;
371 evlist__for_each(session
->evlist
, evsel
) {
372 if (evsel
->attr
.sample_type
& PERF_SAMPLE_CALLCHAIN
) {
373 use_callchain
= true;
378 symbol_conf
.use_callchain
= false;
382 * set default for tracepoints to print symbols only
383 * if callchains are present
385 if (symbol_conf
.use_callchain
&&
386 !output
[PERF_TYPE_TRACEPOINT
].user_set
) {
387 struct perf_event_attr
*attr
;
389 j
= PERF_TYPE_TRACEPOINT
;
390 evsel
= perf_session__find_first_evtype(session
, j
);
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
);
408 static void print_sample_iregs(struct perf_sample
*sample
,
409 struct perf_event_attr
*attr
)
411 struct regs_dump
*regs
= &sample
->intr_regs
;
412 uint64_t mask
= attr
->sample_regs_intr
;
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
);
424 static void print_sample_start(struct perf_sample
*sample
,
425 struct thread
*thread
,
426 struct perf_evsel
*evsel
)
428 struct perf_event_attr
*attr
= &evsel
->attr
;
431 unsigned long long nsecs
;
433 if (PRINT_FIELD(COMM
)) {
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
));
439 printf("%16s ", thread__comm_str(thread
));
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
);
449 if (PRINT_FIELD(CPU
)) {
451 printf("%3d ", sample
->cpu
);
453 printf("[%03d] ", sample
->cpu
);
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
;
462 printf("%5lu.%09llu: ", secs
, nsecs
);
464 printf("%5lu.%06lu: ", secs
, usecs
);
469 mispred_str(struct branch_entry
*br
)
471 if (!(br
->flags
.mispred
|| br
->flags
.predicted
))
474 return br
->flags
.predicted
? 'P' : 'M';
477 static void print_sample_brstack(struct perf_sample
*sample
)
479 struct branch_stack
*br
= sample
->branch_stack
;
485 for (i
= 0; i
< br
->nr
; i
++) {
486 printf(" 0x%"PRIx64
"/0x%"PRIx64
"/%c/%c/%c/%d ",
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
);
496 static void print_sample_brstacksym(struct perf_sample
*sample
,
497 struct thread
*thread
)
499 struct branch_stack
*br
= sample
->branch_stack
;
500 struct addr_location alf
, alt
;
506 for (i
= 0; i
< br
->nr
; i
++) {
508 memset(&alf
, 0, sizeof(alf
));
509 memset(&alt
, 0, sizeof(alt
));
510 from
= br
->entries
[i
].from
;
511 to
= br
->entries
[i
].to
;
513 thread__find_addr_map(thread
, sample
->cpumode
, MAP__FUNCTION
, from
, &alf
);
515 alf
.sym
= map__find_symbol(alf
.map
, alf
.addr
, NULL
);
517 thread__find_addr_map(thread
, sample
->cpumode
, MAP__FUNCTION
, to
, &alt
);
519 alt
.sym
= map__find_symbol(alt
.map
, alt
.addr
, NULL
);
521 symbol__fprintf_symname_offs(alf
.sym
, &alf
, stdout
);
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
);
533 static void print_sample_addr(struct perf_sample
*sample
,
534 struct thread
*thread
,
535 struct perf_event_attr
*attr
)
537 struct addr_location al
;
539 printf("%16" PRIx64
, sample
->addr
);
541 if (!sample_addr_correlates_sym(attr
))
544 thread__resolve(thread
, &al
, sample
);
546 if (PRINT_FIELD(SYM
)) {
548 if (PRINT_FIELD(SYMOFFSET
))
549 symbol__fprintf_symname_offs(al
.sym
, &al
, stdout
);
551 symbol__fprintf_symname(al
.sym
, stdout
);
554 if (PRINT_FIELD(DSO
)) {
556 map__fprintf_dsoname(al
.map
, stdout
);
561 static void print_sample_bts(struct perf_sample
*sample
,
562 struct perf_evsel
*evsel
,
563 struct thread
*thread
,
564 struct addr_location
*al
)
566 struct perf_event_attr
*attr
= &evsel
->attr
;
567 bool print_srcline_last
= false;
569 /* print branch_from information */
570 if (PRINT_FIELD(IP
)) {
571 unsigned int print_opts
= output
[attr
->type
].print_ip_opts
;
573 if (symbol_conf
.use_callchain
&& sample
->callchain
) {
577 if (print_opts
& PRINT_IP_OPT_SRCLINE
) {
578 print_srcline_last
= true;
579 print_opts
&= ~PRINT_IP_OPT_SRCLINE
;
582 perf_evsel__print_ip(evsel
, sample
, al
, print_opts
,
583 scripting_max_stack
);
586 /* print branch_to information */
587 if (PRINT_FIELD(ADDR
) ||
588 ((evsel
->attr
.sample_type
& PERF_SAMPLE_ADDR
) &&
589 !output
[attr
->type
].user_set
)) {
591 print_sample_addr(sample
, thread
, attr
);
594 if (print_srcline_last
)
595 map__fprintf_srcline(al
->map
, al
->addr
, "\n ", stdout
);
600 static void print_sample_flags(u32 flags
)
602 const char *chars
= PERF_IP_FLAG_CHARS
;
603 const int n
= strlen(PERF_IP_FLAG_CHARS
);
607 for (i
= 0; i
< n
; i
++, flags
>>= 1) {
609 str
[pos
++] = chars
[i
];
611 for (; i
< 32; i
++, flags
>>= 1) {
616 printf(" %-4s ", str
);
619 struct printer_data
{
626 print_sample_bpf_output_printer(enum binary_printer_ops op
,
630 unsigned char ch
= (unsigned char)val
;
631 struct printer_data
*printer_data
= extra
;
634 case BINARY_PRINT_DATA_BEGIN
:
637 case BINARY_PRINT_LINE_BEGIN
:
638 printf("%17s", !printer_data
->line_no
? "BPF output:" :
641 case BINARY_PRINT_ADDR
:
642 printf(" %04x:", val
);
644 case BINARY_PRINT_NUM_DATA
:
645 printf(" %02x", val
);
647 case BINARY_PRINT_NUM_PAD
:
650 case BINARY_PRINT_SEP
:
653 case BINARY_PRINT_CHAR_DATA
:
654 if (printer_data
->hit_nul
&& ch
)
655 printer_data
->is_printable
= false;
660 if (!printer_data
->is_printable
)
664 printer_data
->hit_nul
= true;
666 printer_data
->is_printable
= false;
671 case BINARY_PRINT_CHAR_PAD
:
674 case BINARY_PRINT_LINE_END
:
676 printer_data
->line_no
++;
678 case BINARY_PRINT_DATA_END
:
684 static void print_sample_bpf_output(struct perf_sample
*sample
)
686 unsigned int nr_bytes
= sample
->raw_size
;
687 struct printer_data printer_data
= {0, false, true};
689 print_binary(sample
->raw_data
, nr_bytes
, 8,
690 print_sample_bpf_output_printer
, &printer_data
);
692 if (printer_data
.is_printable
&& printer_data
.hit_nul
)
693 printf("%17s \"%s\"\n", "BPF string:",
694 (char *)(sample
->raw_data
));
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
;
704 struct cpu_map
*cpus
;
705 struct thread_map
*threads
;
709 static int perf_evlist__max_name_len(struct perf_evlist
*evlist
)
711 struct perf_evsel
*evsel
;
714 evlist__for_each(evlist
, evsel
) {
715 int len
= strlen(perf_evsel__name(evsel
));
723 static size_t data_src__printf(u64 data_src
)
725 struct mem_info mi
= { .data_src
.val
= data_src
};
731 perf_script__meminfo_scnprintf(decode
, 100, &mi
);
733 len
= scnprintf(out
, 100, "%16" PRIx64
" %s", data_src
, decode
);
737 return printf("%-*s", maxlen
, out
);
740 static void process_event(struct perf_script
*script
,
741 struct perf_sample
*sample
, struct perf_evsel
*evsel
,
742 struct addr_location
*al
)
744 struct thread
*thread
= al
->thread
;
745 struct perf_event_attr
*attr
= &evsel
->attr
;
747 if (output
[attr
->type
].fields
== 0)
750 print_sample_start(sample
, thread
, evsel
);
752 if (PRINT_FIELD(PERIOD
))
753 printf("%10" PRIu64
" ", sample
->period
);
755 if (PRINT_FIELD(EVNAME
)) {
756 const char *evname
= perf_evsel__name(evsel
);
758 if (!script
->name_width
)
759 script
->name_width
= perf_evlist__max_name_len(script
->session
->evlist
);
761 printf("%*s: ", script
->name_width
,
762 evname
? evname
: "[unknown]");
766 print_sample_flags(sample
->flags
);
768 if (is_bts_event(attr
)) {
769 print_sample_bts(sample
, evsel
, thread
, al
);
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
);
779 if (PRINT_FIELD(DATA_SRC
))
780 data_src__printf(sample
->data_src
);
782 if (PRINT_FIELD(WEIGHT
))
783 printf("%16" PRIu64
, sample
->weight
);
785 if (PRINT_FIELD(IP
)) {
786 if (!symbol_conf
.use_callchain
)
791 perf_evsel__print_ip(evsel
, sample
, al
,
792 output
[attr
->type
].print_ip_opts
,
793 scripting_max_stack
);
796 if (PRINT_FIELD(IREGS
))
797 print_sample_iregs(sample
, attr
);
799 if (PRINT_FIELD(BRSTACK
))
800 print_sample_brstack(sample
);
801 else if (PRINT_FIELD(BRSTACKSYM
))
802 print_sample_brstacksym(sample
, thread
);
804 if (perf_evsel__is_bpf_output(evsel
) && PRINT_FIELD(BPF_OUTPUT
))
805 print_sample_bpf_output(sample
);
810 static struct scripting_ops
*scripting_ops
;
812 static void __process_stat(struct perf_evsel
*counter
, u64 tstamp
)
814 int nthreads
= thread_map__nr(counter
->threads
);
815 int ncpus
= perf_evsel__nr_cpus(counter
);
817 static int header_printed
;
819 if (counter
->system_wide
)
822 if (!header_printed
) {
823 printf("%3s %8s %15s %15s %15s %15s %s\n",
824 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
828 for (thread
= 0; thread
< nthreads
; thread
++) {
829 for (cpu
= 0; cpu
< ncpus
; cpu
++) {
830 struct perf_counts_values
*counts
;
832 counts
= perf_counts(counter
->counts
, cpu
, thread
);
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
),
841 perf_evsel__name(counter
));
846 static void process_stat(struct perf_evsel
*counter
, u64 tstamp
)
848 if (scripting_ops
&& scripting_ops
->process_stat
)
849 scripting_ops
->process_stat(&stat_config
, counter
, tstamp
);
851 __process_stat(counter
, tstamp
);
854 static void process_stat_interval(u64 tstamp
)
856 if (scripting_ops
&& scripting_ops
->process_stat_interval
)
857 scripting_ops
->process_stat_interval(tstamp
);
860 static void setup_scripting(void)
862 setup_perl_scripting();
863 setup_python_scripting();
866 static int flush_scripting(void)
868 return scripting_ops
? scripting_ops
->flush_script() : 0;
871 static int cleanup_scripting(void)
873 pr_debug("\nperf script stopped\n");
875 return scripting_ops
? scripting_ops
->stop_script() : 0;
878 static 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
)
884 struct perf_script
*scr
= container_of(tool
, struct perf_script
, tool
);
885 struct addr_location al
;
888 if (sample
->time
< last_timestamp
) {
889 pr_err("Samples misordered, previous: %" PRIu64
890 " this: %" PRIu64
"\n", last_timestamp
,
894 last_timestamp
= sample
->time
;
898 if (machine__resolve(machine
, &al
, sample
) < 0) {
899 pr_err("problem processing %d event, skipping it.\n",
907 if (cpu_list
&& !test_bit(sample
->cpu
, cpu_bitmap
))
911 scripting_ops
->process_event(event
, sample
, evsel
, &al
);
913 process_event(scr
, sample
, evsel
, &al
);
916 addr_location__put(&al
);
920 static int process_attr(struct perf_tool
*tool
, union perf_event
*event
,
921 struct perf_evlist
**pevlist
)
923 struct perf_script
*scr
= container_of(tool
, struct perf_script
, tool
);
924 struct perf_evlist
*evlist
;
925 struct perf_evsel
*evsel
, *pos
;
928 err
= perf_event__process_attr(tool
, event
, pevlist
);
933 evsel
= perf_evlist__last(*pevlist
);
935 if (evsel
->attr
.type
>= PERF_TYPE_MAX
)
938 evlist__for_each(evlist
, pos
) {
939 if (pos
->attr
.type
== evsel
->attr
.type
&& pos
!= evsel
)
943 set_print_ip_opts(&evsel
->attr
);
945 if (evsel
->attr
.sample_type
)
946 err
= perf_evsel__check_attr(evsel
, scr
->session
);
951 static int process_comm_event(struct perf_tool
*tool
,
952 union perf_event
*event
,
953 struct perf_sample
*sample
,
954 struct machine
*machine
)
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
);
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");
968 if (perf_event__process_comm(tool
, event
, sample
, machine
) < 0)
971 if (!evsel
->attr
.sample_id_all
) {
974 sample
->tid
= event
->comm
.tid
;
975 sample
->pid
= event
->comm
.pid
;
977 print_sample_start(sample
, thread
, evsel
);
978 perf_event__fprintf(event
, stdout
);
985 static int process_fork_event(struct perf_tool
*tool
,
986 union perf_event
*event
,
987 struct perf_sample
*sample
,
988 struct machine
*machine
)
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
);
995 if (perf_event__process_fork(tool
, event
, sample
, machine
) < 0)
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");
1004 if (!evsel
->attr
.sample_id_all
) {
1006 sample
->time
= event
->fork
.time
;
1007 sample
->tid
= event
->fork
.tid
;
1008 sample
->pid
= event
->fork
.pid
;
1010 print_sample_start(sample
, thread
, evsel
);
1011 perf_event__fprintf(event
, stdout
);
1012 thread__put(thread
);
1016 static int process_exit_event(struct perf_tool
*tool
,
1017 union perf_event
*event
,
1018 struct perf_sample
*sample
,
1019 struct machine
*machine
)
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
);
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");
1033 if (!evsel
->attr
.sample_id_all
) {
1036 sample
->tid
= event
->fork
.tid
;
1037 sample
->pid
= event
->fork
.pid
;
1039 print_sample_start(sample
, thread
, evsel
);
1040 perf_event__fprintf(event
, stdout
);
1042 if (perf_event__process_exit(tool
, event
, sample
, machine
) < 0)
1045 thread__put(thread
);
1049 static int process_mmap_event(struct perf_tool
*tool
,
1050 union perf_event
*event
,
1051 struct perf_sample
*sample
,
1052 struct machine
*machine
)
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
);
1059 if (perf_event__process_mmap(tool
, event
, sample
, machine
) < 0)
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");
1068 if (!evsel
->attr
.sample_id_all
) {
1071 sample
->tid
= event
->mmap
.tid
;
1072 sample
->pid
= event
->mmap
.pid
;
1074 print_sample_start(sample
, thread
, evsel
);
1075 perf_event__fprintf(event
, stdout
);
1076 thread__put(thread
);
1080 static int process_mmap2_event(struct perf_tool
*tool
,
1081 union perf_event
*event
,
1082 struct perf_sample
*sample
,
1083 struct machine
*machine
)
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
);
1090 if (perf_event__process_mmap2(tool
, event
, sample
, machine
) < 0)
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");
1099 if (!evsel
->attr
.sample_id_all
) {
1102 sample
->tid
= event
->mmap2
.tid
;
1103 sample
->pid
= event
->mmap2
.pid
;
1105 print_sample_start(sample
, thread
, evsel
);
1106 perf_event__fprintf(event
, stdout
);
1107 thread__put(thread
);
1111 static int process_switch_event(struct perf_tool
*tool
,
1112 union perf_event
*event
,
1113 struct perf_sample
*sample
,
1114 struct machine
*machine
)
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
);
1121 if (perf_event__process_switch(tool
, event
, sample
, machine
) < 0)
1124 thread
= machine__findnew_thread(machine
, sample
->pid
,
1126 if (thread
== NULL
) {
1127 pr_debug("problem processing SWITCH event, skipping it.\n");
1131 print_sample_start(sample
, thread
, evsel
);
1132 perf_event__fprintf(event
, stdout
);
1133 thread__put(thread
);
1137 static void sig_handler(int sig __maybe_unused
)
1142 static int __cmd_script(struct perf_script
*script
)
1146 signal(SIGINT
, sig_handler
);
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
;
1154 if (script
->show_mmap_events
) {
1155 script
->tool
.mmap
= process_mmap_event
;
1156 script
->tool
.mmap2
= process_mmap2_event
;
1158 if (script
->show_switch_events
)
1159 script
->tool
.context_switch
= process_switch_event
;
1161 ret
= perf_session__process_events(script
->session
);
1164 pr_err("Misordered timestamps: %" PRIu64
"\n", nr_unordered
);
1169 struct script_spec
{
1170 struct list_head node
;
1171 struct scripting_ops
*ops
;
1175 static LIST_HEAD(script_specs
);
1177 static struct script_spec
*script_spec__new(const char *spec
,
1178 struct scripting_ops
*ops
)
1180 struct script_spec
*s
= malloc(sizeof(*s
) + strlen(spec
) + 1);
1183 strcpy(s
->spec
, spec
);
1190 static void script_spec__add(struct script_spec
*s
)
1192 list_add_tail(&s
->node
, &script_specs
);
1195 static struct script_spec
*script_spec__find(const char *spec
)
1197 struct script_spec
*s
;
1199 list_for_each_entry(s
, &script_specs
, node
)
1200 if (strcasecmp(s
->spec
, spec
) == 0)
1205 int script_spec_register(const char *spec
, struct scripting_ops
*ops
)
1207 struct script_spec
*s
;
1209 s
= script_spec__find(spec
);
1213 s
= script_spec__new(spec
, ops
);
1217 script_spec__add(s
);
1222 static struct scripting_ops
*script_spec__lookup(const char *spec
)
1224 struct script_spec
*s
= script_spec__find(spec
);
1231 static void list_available_languages(void)
1233 struct script_spec
*s
;
1235 fprintf(stderr
, "\n");
1236 fprintf(stderr
, "Scripting language extensions (used in "
1237 "perf script -s [spec:]script.[spec]):\n\n");
1239 list_for_each_entry(s
, &script_specs
, node
)
1240 fprintf(stderr
, " %-42s [%s]\n", s
->spec
, s
->ops
->name
);
1242 fprintf(stderr
, "\n");
1245 static int parse_scriptname(const struct option
*opt __maybe_unused
,
1246 const char *str
, int unset __maybe_unused
)
1248 char spec
[PATH_MAX
];
1249 const char *script
, *ext
;
1252 if (strcmp(str
, "lang") == 0) {
1253 list_available_languages();
1257 script
= strchr(str
, ':');
1260 if (len
>= PATH_MAX
) {
1261 fprintf(stderr
, "invalid language specifier");
1264 strncpy(spec
, str
, len
);
1266 scripting_ops
= script_spec__lookup(spec
);
1267 if (!scripting_ops
) {
1268 fprintf(stderr
, "invalid language specifier");
1274 ext
= strrchr(script
, '.');
1276 fprintf(stderr
, "invalid script extension");
1279 scripting_ops
= script_spec__lookup(++ext
);
1280 if (!scripting_ops
) {
1281 fprintf(stderr
, "invalid script extension");
1286 script_name
= strdup(script
);
1291 static int parse_output_fields(const struct option
*opt __maybe_unused
,
1292 const char *arg
, int unset __maybe_unused
)
1295 int i
, imax
= ARRAY_SIZE(all_output_options
);
1298 char *str
= strdup(arg
);
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.
1308 tok
= strchr(str
, ':');
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
;
1323 fprintf(stderr
, "Invalid event type in field string.\n");
1328 if (output
[type
].user_set
)
1329 pr_warning("Overriding previous field request for %s events.\n",
1332 output
[type
].fields
= 0;
1333 output
[type
].user_set
= true;
1334 output
[type
].wildcard_set
= false;
1338 if (strlen(str
) == 0) {
1340 "Cannot set fields to 'none' for all event types.\n");
1345 if (output_set_by_user())
1346 pr_warning("Overriding previous field request for all events.\n");
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;
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)
1360 if (i
== imax
&& strcmp(tok
, "flags") == 0) {
1365 fprintf(stderr
, "Invalid field requested.\n");
1371 /* add user option to all events types for
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
));
1379 output
[j
].fields
|= all_output_options
[i
].field
;
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
));
1389 output
[type
].fields
|= all_output_options
[i
].field
;
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
));
1405 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1406 static int is_directory(const char *base_path
, const struct dirent
*dent
)
1408 char path
[PATH_MAX
];
1411 sprintf(path
, "%s/%s", base_path
, dent
->d_name
);
1412 if (stat(path
, &st
))
1415 return S_ISDIR(st
.st_mode
);
1418 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
1419 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
1421 if ((lang_dirent.d_type == DT_DIR || \
1422 (lang_dirent.d_type == DT_UNKNOWN && \
1423 is_directory(scripts_path, &lang_dirent))) && \
1424 (strcmp(lang_dirent.d_name, ".")) && \
1425 (strcmp(lang_dirent.d_name, "..")))
1427 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1428 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
1430 if (script_dirent.d_type != DT_DIR && \
1431 (script_dirent.d_type != DT_UNKNOWN || \
1432 !is_directory(lang_path, &script_dirent)))
1435 #define RECORD_SUFFIX "-record"
1436 #define REPORT_SUFFIX "-report"
1438 struct script_desc
{
1439 struct list_head node
;
1445 static LIST_HEAD(script_descs
);
1447 static struct script_desc
*script_desc__new(const char *name
)
1449 struct script_desc
*s
= zalloc(sizeof(*s
));
1451 if (s
!= NULL
&& name
)
1452 s
->name
= strdup(name
);
1457 static void script_desc__delete(struct script_desc
*s
)
1460 zfree(&s
->half_liner
);
1465 static void script_desc__add(struct script_desc
*s
)
1467 list_add_tail(&s
->node
, &script_descs
);
1470 static struct script_desc
*script_desc__find(const char *name
)
1472 struct script_desc
*s
;
1474 list_for_each_entry(s
, &script_descs
, node
)
1475 if (strcasecmp(s
->name
, name
) == 0)
1480 static struct script_desc
*script_desc__findnew(const char *name
)
1482 struct script_desc
*s
= script_desc__find(name
);
1487 s
= script_desc__new(name
);
1489 goto out_delete_desc
;
1491 script_desc__add(s
);
1496 script_desc__delete(s
);
1501 static const char *ends_with(const char *str
, const char *suffix
)
1503 size_t suffix_len
= strlen(suffix
);
1504 const char *p
= str
;
1506 if (strlen(str
) > suffix_len
) {
1507 p
= str
+ strlen(str
) - suffix_len
;
1508 if (!strncmp(p
, suffix
, suffix_len
))
1515 static int read_script_info(struct script_desc
*desc
, const char *filename
)
1517 char line
[BUFSIZ
], *p
;
1520 fp
= fopen(filename
, "r");
1524 while (fgets(line
, sizeof(line
), fp
)) {
1531 if (strlen(p
) && *p
== '!')
1535 if (strlen(p
) && p
[strlen(p
) - 1] == '\n')
1536 p
[strlen(p
) - 1] = '\0';
1538 if (!strncmp(p
, "description:", strlen("description:"))) {
1539 p
+= strlen("description:");
1540 desc
->half_liner
= strdup(ltrim(p
));
1544 if (!strncmp(p
, "args:", strlen("args:"))) {
1545 p
+= strlen("args:");
1546 desc
->args
= strdup(ltrim(p
));
1556 static char *get_script_root(struct dirent
*script_dirent
, const char *suffix
)
1558 char *script_root
, *str
;
1560 script_root
= strdup(script_dirent
->d_name
);
1564 str
= (char *)ends_with(script_root
, suffix
);
1574 static int list_available_scripts(const struct option
*opt __maybe_unused
,
1575 const char *s __maybe_unused
,
1576 int unset __maybe_unused
)
1578 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1579 char scripts_path
[MAXPATHLEN
];
1580 DIR *scripts_dir
, *lang_dir
;
1581 char script_path
[MAXPATHLEN
];
1582 char lang_path
[MAXPATHLEN
];
1583 struct script_desc
*desc
;
1584 char first_half
[BUFSIZ
];
1587 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", get_argv_exec_path());
1589 scripts_dir
= opendir(scripts_path
);
1593 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1594 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1595 lang_dirent
.d_name
);
1596 lang_dir
= opendir(lang_path
);
1600 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1601 script_root
= get_script_root(&script_dirent
, REPORT_SUFFIX
);
1603 desc
= script_desc__findnew(script_root
);
1604 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1605 lang_path
, script_dirent
.d_name
);
1606 read_script_info(desc
, script_path
);
1612 fprintf(stdout
, "List of available trace scripts:\n");
1613 list_for_each_entry(desc
, &script_descs
, node
) {
1614 sprintf(first_half
, "%s %s", desc
->name
,
1615 desc
->args
? desc
->args
: "");
1616 fprintf(stdout
, " %-36s %s\n", first_half
,
1617 desc
->half_liner
? desc
->half_liner
: "");
1624 * Some scripts specify the required events in their "xxx-record" file,
1625 * this function will check if the events in perf.data match those
1626 * mentioned in the "xxx-record".
1628 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1629 * which is covered well now. And new parsing code should be added to
1630 * cover the future complexing formats like event groups etc.
1632 static int check_ev_match(char *dir_name
, char *scriptname
,
1633 struct perf_session
*session
)
1635 char filename
[MAXPATHLEN
], evname
[128];
1636 char line
[BUFSIZ
], *p
;
1637 struct perf_evsel
*pos
;
1641 sprintf(filename
, "%s/bin/%s-record", dir_name
, scriptname
);
1643 fp
= fopen(filename
, "r");
1647 while (fgets(line
, sizeof(line
), fp
)) {
1653 p
= strstr(p
, "-e");
1659 len
= strcspn(p
, " \t");
1663 snprintf(evname
, len
+ 1, "%s", p
);
1666 evlist__for_each(session
->evlist
, pos
) {
1667 if (!strcmp(perf_evsel__name(pos
), evname
)) {
1685 * Return -1 if none is found, otherwise the actual scripts number.
1687 * Currently the only user of this function is the script browser, which
1688 * will list all statically runnable scripts, select one, execute it and
1689 * show the output in a perf browser.
1691 int find_scripts(char **scripts_array
, char **scripts_path_array
)
1693 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1694 char scripts_path
[MAXPATHLEN
], lang_path
[MAXPATHLEN
];
1695 DIR *scripts_dir
, *lang_dir
;
1696 struct perf_session
*session
;
1697 struct perf_data_file file
= {
1699 .mode
= PERF_DATA_MODE_READ
,
1704 session
= perf_session__new(&file
, false, NULL
);
1708 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", get_argv_exec_path());
1710 scripts_dir
= opendir(scripts_path
);
1712 perf_session__delete(session
);
1716 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1717 snprintf(lang_path
, MAXPATHLEN
, "%s/%s", scripts_path
,
1718 lang_dirent
.d_name
);
1720 if (strstr(lang_path
, "perl"))
1724 if (strstr(lang_path
, "python"))
1728 lang_dir
= opendir(lang_path
);
1732 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1733 /* Skip those real time scripts: xxxtop.p[yl] */
1734 if (strstr(script_dirent
.d_name
, "top."))
1736 sprintf(scripts_path_array
[i
], "%s/%s", lang_path
,
1737 script_dirent
.d_name
);
1738 temp
= strchr(script_dirent
.d_name
, '.');
1739 snprintf(scripts_array
[i
],
1740 (temp
- script_dirent
.d_name
) + 1,
1741 "%s", script_dirent
.d_name
);
1743 if (check_ev_match(lang_path
,
1744 scripts_array
[i
], session
))
1752 closedir(scripts_dir
);
1753 perf_session__delete(session
);
1757 static char *get_script_path(const char *script_root
, const char *suffix
)
1759 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1760 char scripts_path
[MAXPATHLEN
];
1761 char script_path
[MAXPATHLEN
];
1762 DIR *scripts_dir
, *lang_dir
;
1763 char lang_path
[MAXPATHLEN
];
1764 char *__script_root
;
1766 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", get_argv_exec_path());
1768 scripts_dir
= opendir(scripts_path
);
1772 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1773 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1774 lang_dirent
.d_name
);
1775 lang_dir
= opendir(lang_path
);
1779 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1780 __script_root
= get_script_root(&script_dirent
, suffix
);
1781 if (__script_root
&& !strcmp(script_root
, __script_root
)) {
1782 free(__script_root
);
1784 closedir(scripts_dir
);
1785 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1786 lang_path
, script_dirent
.d_name
);
1787 return strdup(script_path
);
1789 free(__script_root
);
1793 closedir(scripts_dir
);
1798 static bool is_top_script(const char *script_path
)
1800 return ends_with(script_path
, "top") == NULL
? false : true;
1803 static int has_required_arg(char *script_path
)
1805 struct script_desc
*desc
;
1809 desc
= script_desc__new(NULL
);
1811 if (read_script_info(desc
, script_path
))
1817 for (p
= desc
->args
; *p
; p
++)
1821 script_desc__delete(desc
);
1826 static int have_cmd(int argc
, const char **argv
)
1828 char **__argv
= malloc(sizeof(const char *) * argc
);
1831 pr_err("malloc failed\n");
1835 memcpy(__argv
, argv
, sizeof(const char *) * argc
);
1836 argc
= parse_options(argc
, (const char **)__argv
, record_options
,
1837 NULL
, PARSE_OPT_STOP_AT_NON_OPTION
);
1840 system_wide
= (argc
== 0);
1845 static void script__setup_sample_type(struct perf_script
*script
)
1847 struct perf_session
*session
= script
->session
;
1848 u64 sample_type
= perf_evlist__combined_sample_type(session
->evlist
);
1850 if (symbol_conf
.use_callchain
|| symbol_conf
.cumulate_callchain
) {
1851 if ((sample_type
& PERF_SAMPLE_REGS_USER
) &&
1852 (sample_type
& PERF_SAMPLE_STACK_USER
))
1853 callchain_param
.record_mode
= CALLCHAIN_DWARF
;
1854 else if (sample_type
& PERF_SAMPLE_BRANCH_STACK
)
1855 callchain_param
.record_mode
= CALLCHAIN_LBR
;
1857 callchain_param
.record_mode
= CALLCHAIN_FP
;
1861 static int process_stat_round_event(struct perf_tool
*tool __maybe_unused
,
1862 union perf_event
*event
,
1863 struct perf_session
*session
)
1865 struct stat_round_event
*round
= &event
->stat_round
;
1866 struct perf_evsel
*counter
;
1868 evlist__for_each(session
->evlist
, counter
) {
1869 perf_stat_process_counter(&stat_config
, counter
);
1870 process_stat(counter
, round
->time
);
1873 process_stat_interval(round
->time
);
1877 static int process_stat_config_event(struct perf_tool
*tool __maybe_unused
,
1878 union perf_event
*event
,
1879 struct perf_session
*session __maybe_unused
)
1881 perf_event__read_stat_config(&stat_config
, &event
->stat_config
);
1885 static int set_maps(struct perf_script
*script
)
1887 struct perf_evlist
*evlist
= script
->session
->evlist
;
1889 if (!script
->cpus
|| !script
->threads
)
1892 if (WARN_ONCE(script
->allocated
, "stats double allocation\n"))
1895 perf_evlist__set_maps(evlist
, script
->cpus
, script
->threads
);
1897 if (perf_evlist__alloc_stats(evlist
, true))
1900 script
->allocated
= true;
1905 int process_thread_map_event(struct perf_tool
*tool
,
1906 union perf_event
*event
,
1907 struct perf_session
*session __maybe_unused
)
1909 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1911 if (script
->threads
) {
1912 pr_warning("Extra thread map event, ignoring.\n");
1916 script
->threads
= thread_map__new_event(&event
->thread_map
);
1917 if (!script
->threads
)
1920 return set_maps(script
);
1924 int process_cpu_map_event(struct perf_tool
*tool __maybe_unused
,
1925 union perf_event
*event
,
1926 struct perf_session
*session __maybe_unused
)
1928 struct perf_script
*script
= container_of(tool
, struct perf_script
, tool
);
1931 pr_warning("Extra cpu map event, ignoring.\n");
1935 script
->cpus
= cpu_map__new_data(&event
->cpu_map
.data
);
1939 return set_maps(script
);
1942 int cmd_script(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1944 bool show_full_info
= false;
1945 bool header
= false;
1946 bool header_only
= false;
1947 bool script_started
= false;
1948 char *rec_script_path
= NULL
;
1949 char *rep_script_path
= NULL
;
1950 struct perf_session
*session
;
1951 struct itrace_synth_opts itrace_synth_opts
= { .set
= false, };
1952 char *script_path
= NULL
;
1953 const char **__argv
;
1955 struct perf_script script
= {
1957 .sample
= process_sample_event
,
1958 .mmap
= perf_event__process_mmap
,
1959 .mmap2
= perf_event__process_mmap2
,
1960 .comm
= perf_event__process_comm
,
1961 .exit
= perf_event__process_exit
,
1962 .fork
= perf_event__process_fork
,
1963 .attr
= process_attr
,
1964 .tracing_data
= perf_event__process_tracing_data
,
1965 .build_id
= perf_event__process_build_id
,
1966 .id_index
= perf_event__process_id_index
,
1967 .auxtrace_info
= perf_event__process_auxtrace_info
,
1968 .auxtrace
= perf_event__process_auxtrace
,
1969 .auxtrace_error
= perf_event__process_auxtrace_error
,
1970 .stat
= perf_event__process_stat_event
,
1971 .stat_round
= process_stat_round_event
,
1972 .stat_config
= process_stat_config_event
,
1973 .thread_map
= process_thread_map_event
,
1974 .cpu_map
= process_cpu_map_event
,
1975 .ordered_events
= true,
1976 .ordering_requires_timestamps
= true,
1979 struct perf_data_file file
= {
1980 .mode
= PERF_DATA_MODE_READ
,
1982 const struct option options
[] = {
1983 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
1984 "dump raw trace in ASCII"),
1985 OPT_INCR('v', "verbose", &verbose
,
1986 "be more verbose (show symbol address, etc)"),
1987 OPT_BOOLEAN('L', "Latency", &latency_format
,
1988 "show latency attributes (irqs/preemption disabled, etc)"),
1989 OPT_CALLBACK_NOOPT('l', "list", NULL
, NULL
, "list available scripts",
1990 list_available_scripts
),
1991 OPT_CALLBACK('s', "script", NULL
, "name",
1992 "script file name (lang:script name, script name, or *)",
1994 OPT_STRING('g', "gen-script", &generate_script_lang
, "lang",
1995 "generate perf-script.xx script in specified language"),
1996 OPT_STRING('i', "input", &input_name
, "file", "input file name"),
1997 OPT_BOOLEAN('d', "debug-mode", &debug_mode
,
1998 "do various checks like samples ordering and lost events"),
1999 OPT_BOOLEAN(0, "header", &header
, "Show data header."),
2000 OPT_BOOLEAN(0, "header-only", &header_only
, "Show only data header."),
2001 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
2002 "file", "vmlinux pathname"),
2003 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
2004 "file", "kallsyms pathname"),
2005 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain
,
2006 "When printing symbols do not display call chain"),
2007 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
2008 "Look for files with symbols relative to this directory"),
2009 OPT_CALLBACK('F', "fields", NULL
, "str",
2010 "comma separated output fields prepend with 'type:'. "
2011 "Valid types: hw,sw,trace,raw. "
2012 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2013 "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields
),
2014 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
2015 "system-wide collection from all CPUs"),
2016 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
2017 "only consider these symbols"),
2018 OPT_STRING('C', "cpu", &cpu_list
, "cpu", "list of cpus to profile"),
2019 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
2020 "only display events for these comms"),
2021 OPT_STRING(0, "pid", &symbol_conf
.pid_list_str
, "pid[,pid...]",
2022 "only consider symbols in these pids"),
2023 OPT_STRING(0, "tid", &symbol_conf
.tid_list_str
, "tid[,tid...]",
2024 "only consider symbols in these tids"),
2025 OPT_BOOLEAN('I', "show-info", &show_full_info
,
2026 "display extended information from perf.data file"),
2027 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf
.show_kernel_path
,
2028 "Show the path of [kernel.kallsyms]"),
2029 OPT_BOOLEAN('\0', "show-task-events", &script
.show_task_events
,
2030 "Show the fork/comm/exit events"),
2031 OPT_BOOLEAN('\0', "show-mmap-events", &script
.show_mmap_events
,
2032 "Show the mmap events"),
2033 OPT_BOOLEAN('\0', "show-switch-events", &script
.show_switch_events
,
2034 "Show context switch events (if recorded)"),
2035 OPT_BOOLEAN('f', "force", &file
.force
, "don't complain, do it"),
2036 OPT_BOOLEAN(0, "ns", &nanosecs
,
2037 "Use 9 decimal places when displaying time"),
2038 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts
, NULL
, "opts",
2039 "Instruction Tracing options",
2040 itrace_parse_synth_opts
),
2041 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename
,
2042 "Show full source file name path for source lines"),
2043 OPT_BOOLEAN(0, "demangle", &symbol_conf
.demangle
,
2044 "Enable symbol demangling"),
2045 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf
.demangle_kernel
,
2046 "Enable kernel symbol demangling"),
2050 const char * const script_subcommands
[] = { "record", "report", NULL
};
2051 const char *script_usage
[] = {
2052 "perf script [<options>]",
2053 "perf script [<options>] record <script> [<record-options>] <command>",
2054 "perf script [<options>] report <script> [script-args]",
2055 "perf script [<options>] <script> [<record-options>] <command>",
2056 "perf script [<options>] <top-script> [script-args]",
2062 argc
= parse_options_subcommand(argc
, argv
, options
, script_subcommands
, script_usage
,
2063 PARSE_OPT_STOP_AT_NON_OPTION
);
2065 file
.path
= input_name
;
2067 if (argc
> 1 && !strncmp(argv
[0], "rec", strlen("rec"))) {
2068 rec_script_path
= get_script_path(argv
[1], RECORD_SUFFIX
);
2069 if (!rec_script_path
)
2070 return cmd_record(argc
, argv
, NULL
);
2073 if (argc
> 1 && !strncmp(argv
[0], "rep", strlen("rep"))) {
2074 rep_script_path
= get_script_path(argv
[1], REPORT_SUFFIX
);
2075 if (!rep_script_path
) {
2077 "Please specify a valid report script"
2078 "(see 'perf script -l' for listing)\n");
2083 if (itrace_synth_opts
.callchain
&&
2084 itrace_synth_opts
.callchain_sz
> scripting_max_stack
)
2085 scripting_max_stack
= itrace_synth_opts
.callchain_sz
;
2087 /* make sure PERF_EXEC_PATH is set for scripts */
2088 set_argv_exec_path(get_argv_exec_path());
2090 if (argc
&& !script_name
&& !rec_script_path
&& !rep_script_path
) {
2095 rec_script_path
= get_script_path(argv
[0], RECORD_SUFFIX
);
2096 rep_script_path
= get_script_path(argv
[0], REPORT_SUFFIX
);
2098 if (!rec_script_path
&& !rep_script_path
) {
2099 usage_with_options_msg(script_usage
, options
,
2100 "Couldn't find script `%s'\n\n See perf"
2101 " script -l for available scripts.\n", argv
[0]);
2104 if (is_top_script(argv
[0])) {
2105 rep_args
= argc
- 1;
2109 rep_args
= has_required_arg(rep_script_path
);
2110 rec_args
= (argc
- 1) - rep_args
;
2112 usage_with_options_msg(script_usage
, options
,
2113 "`%s' script requires options."
2114 "\n\n See perf script -l for available "
2115 "scripts and options.\n", argv
[0]);
2119 if (pipe(live_pipe
) < 0) {
2120 perror("failed to create pipe");
2126 perror("failed to fork");
2133 dup2(live_pipe
[1], 1);
2134 close(live_pipe
[0]);
2136 if (is_top_script(argv
[0])) {
2138 } else if (!system_wide
) {
2139 if (have_cmd(argc
- rep_args
, &argv
[rep_args
]) != 0) {
2145 __argv
= malloc((argc
+ 6) * sizeof(const char *));
2147 pr_err("malloc failed\n");
2152 __argv
[j
++] = "/bin/sh";
2153 __argv
[j
++] = rec_script_path
;
2159 for (i
= rep_args
+ 1; i
< argc
; i
++)
2160 __argv
[j
++] = argv
[i
];
2163 execvp("/bin/sh", (char **)__argv
);
2168 dup2(live_pipe
[0], 0);
2169 close(live_pipe
[1]);
2171 __argv
= malloc((argc
+ 4) * sizeof(const char *));
2173 pr_err("malloc failed\n");
2179 __argv
[j
++] = "/bin/sh";
2180 __argv
[j
++] = rep_script_path
;
2181 for (i
= 1; i
< rep_args
+ 1; i
++)
2182 __argv
[j
++] = argv
[i
];
2187 execvp("/bin/sh", (char **)__argv
);
2192 if (rec_script_path
)
2193 script_path
= rec_script_path
;
2194 if (rep_script_path
)
2195 script_path
= rep_script_path
;
2200 if (!rec_script_path
)
2201 system_wide
= false;
2202 else if (!system_wide
) {
2203 if (have_cmd(argc
- 1, &argv
[1]) != 0) {
2209 __argv
= malloc((argc
+ 2) * sizeof(const char *));
2211 pr_err("malloc failed\n");
2216 __argv
[j
++] = "/bin/sh";
2217 __argv
[j
++] = script_path
;
2220 for (i
= 2; i
< argc
; i
++)
2221 __argv
[j
++] = argv
[i
];
2224 execvp("/bin/sh", (char **)__argv
);
2232 session
= perf_session__new(&file
, false, &script
.tool
);
2233 if (session
== NULL
)
2236 if (header
|| header_only
) {
2237 perf_session__fprintf_info(session
, stdout
, show_full_info
);
2242 if (symbol__init(&session
->header
.env
) < 0)
2245 script
.session
= session
;
2246 script__setup_sample_type(&script
);
2248 session
->itrace_synth_opts
= &itrace_synth_opts
;
2251 err
= perf_session__cpu_bitmap(session
, cpu_list
, cpu_bitmap
);
2257 symbol_conf
.use_callchain
= true;
2259 symbol_conf
.use_callchain
= false;
2261 if (session
->tevent
.pevent
&&
2262 pevent_set_function_resolver(session
->tevent
.pevent
,
2263 machine__resolve_kernel_addr
,
2264 &session
->machines
.host
) < 0) {
2265 pr_err("%s: failed to set libtraceevent function resolver\n", __func__
);
2269 if (generate_script_lang
) {
2270 struct stat perf_stat
;
2273 if (output_set_by_user()) {
2275 "custom fields not supported for generated scripts");
2280 input
= open(file
.path
, O_RDONLY
); /* input_name */
2283 perror("failed to open file");
2287 err
= fstat(input
, &perf_stat
);
2289 perror("failed to stat file");
2293 if (!perf_stat
.st_size
) {
2294 fprintf(stderr
, "zero-sized file, nothing to do!\n");
2298 scripting_ops
= script_spec__lookup(generate_script_lang
);
2299 if (!scripting_ops
) {
2300 fprintf(stderr
, "invalid language specifier");
2305 err
= scripting_ops
->generate_script(session
->tevent
.pevent
,
2311 err
= scripting_ops
->start_script(script_name
, argc
, argv
);
2314 pr_debug("perf script started with script %s\n\n", script_name
);
2315 script_started
= true;
2319 err
= perf_session__check_output_opt(session
);
2323 err
= __cmd_script(&script
);
2328 perf_evlist__free_stats(session
->evlist
);
2329 perf_session__delete(session
);
2332 cleanup_scripting();