4 #include "util/cache.h"
5 #include "util/debug.h"
6 #include "util/exec_cmd.h"
7 #include "util/header.h"
8 #include "util/parse-options.h"
9 #include "util/session.h"
10 #include "util/tool.h"
11 #include "util/symbol.h"
12 #include "util/thread.h"
13 #include "util/trace-event.h"
14 #include "util/util.h"
15 #include "util/evlist.h"
16 #include "util/evsel.h"
17 #include "util/sort.h"
18 #include "util/data.h"
19 #include <linux/bitmap.h>
21 static char const *script_name
;
22 static char const *generate_script_lang
;
23 static bool debug_mode
;
24 static u64 last_timestamp
;
25 static u64 nr_unordered
;
26 extern const struct option record_options
[];
27 static bool no_callchain
;
28 static bool latency_format
;
29 static bool system_wide
;
30 static const char *cpu_list
;
31 static DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
33 enum perf_output_field
{
34 PERF_OUTPUT_COMM
= 1U << 0,
35 PERF_OUTPUT_TID
= 1U << 1,
36 PERF_OUTPUT_PID
= 1U << 2,
37 PERF_OUTPUT_TIME
= 1U << 3,
38 PERF_OUTPUT_CPU
= 1U << 4,
39 PERF_OUTPUT_EVNAME
= 1U << 5,
40 PERF_OUTPUT_TRACE
= 1U << 6,
41 PERF_OUTPUT_IP
= 1U << 7,
42 PERF_OUTPUT_SYM
= 1U << 8,
43 PERF_OUTPUT_DSO
= 1U << 9,
44 PERF_OUTPUT_ADDR
= 1U << 10,
45 PERF_OUTPUT_SYMOFFSET
= 1U << 11,
48 struct output_option
{
50 enum perf_output_field field
;
51 } all_output_options
[] = {
52 {.str
= "comm", .field
= PERF_OUTPUT_COMM
},
53 {.str
= "tid", .field
= PERF_OUTPUT_TID
},
54 {.str
= "pid", .field
= PERF_OUTPUT_PID
},
55 {.str
= "time", .field
= PERF_OUTPUT_TIME
},
56 {.str
= "cpu", .field
= PERF_OUTPUT_CPU
},
57 {.str
= "event", .field
= PERF_OUTPUT_EVNAME
},
58 {.str
= "trace", .field
= PERF_OUTPUT_TRACE
},
59 {.str
= "ip", .field
= PERF_OUTPUT_IP
},
60 {.str
= "sym", .field
= PERF_OUTPUT_SYM
},
61 {.str
= "dso", .field
= PERF_OUTPUT_DSO
},
62 {.str
= "addr", .field
= PERF_OUTPUT_ADDR
},
63 {.str
= "symoff", .field
= PERF_OUTPUT_SYMOFFSET
},
66 /* default set to maintain compatibility with current format */
70 unsigned int print_ip_opts
;
73 } output
[PERF_TYPE_MAX
] = {
75 [PERF_TYPE_HARDWARE
] = {
78 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
79 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
80 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
81 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
83 .invalid_fields
= PERF_OUTPUT_TRACE
,
86 [PERF_TYPE_SOFTWARE
] = {
89 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
90 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
91 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
92 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
94 .invalid_fields
= PERF_OUTPUT_TRACE
,
97 [PERF_TYPE_TRACEPOINT
] = {
100 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
101 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
102 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_TRACE
,
108 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
109 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
110 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
111 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
113 .invalid_fields
= PERF_OUTPUT_TRACE
,
117 static bool output_set_by_user(void)
120 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
121 if (output
[j
].user_set
)
127 static const char *output_field2str(enum perf_output_field field
)
129 int i
, imax
= ARRAY_SIZE(all_output_options
);
130 const char *str
= "";
132 for (i
= 0; i
< imax
; ++i
) {
133 if (all_output_options
[i
].field
== field
) {
134 str
= all_output_options
[i
].str
;
141 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
143 static int perf_evsel__check_stype(struct perf_evsel
*evsel
,
144 u64 sample_type
, const char *sample_msg
,
145 enum perf_output_field field
)
147 struct perf_event_attr
*attr
= &evsel
->attr
;
148 int type
= attr
->type
;
151 if (attr
->sample_type
& sample_type
)
154 if (output
[type
].user_set
) {
155 evname
= perf_evsel__name(evsel
);
156 pr_err("Samples for '%s' event do not have %s attribute set. "
157 "Cannot print '%s' field.\n",
158 evname
, sample_msg
, output_field2str(field
));
162 /* user did not ask for it explicitly so remove from the default list */
163 output
[type
].fields
&= ~field
;
164 evname
= perf_evsel__name(evsel
);
165 pr_debug("Samples for '%s' event do not have %s attribute set. "
166 "Skipping '%s' field.\n",
167 evname
, sample_msg
, output_field2str(field
));
172 static int perf_evsel__check_attr(struct perf_evsel
*evsel
,
173 struct perf_session
*session
)
175 struct perf_event_attr
*attr
= &evsel
->attr
;
177 if (PRINT_FIELD(TRACE
) &&
178 !perf_session__has_traces(session
, "record -R"))
181 if (PRINT_FIELD(IP
)) {
182 if (perf_evsel__check_stype(evsel
, PERF_SAMPLE_IP
, "IP",
187 !(attr
->sample_type
& PERF_SAMPLE_CALLCHAIN
))
188 symbol_conf
.use_callchain
= false;
191 if (PRINT_FIELD(ADDR
) &&
192 perf_evsel__check_stype(evsel
, PERF_SAMPLE_ADDR
, "ADDR",
196 if (PRINT_FIELD(SYM
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
197 pr_err("Display of symbols requested but neither sample IP nor "
198 "sample address\nis selected. Hence, no addresses to convert "
202 if (PRINT_FIELD(SYMOFFSET
) && !PRINT_FIELD(SYM
)) {
203 pr_err("Display of offsets requested but symbol is not"
207 if (PRINT_FIELD(DSO
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
208 pr_err("Display of DSO requested but neither sample IP nor "
209 "sample address\nis selected. Hence, no addresses to convert "
214 if ((PRINT_FIELD(PID
) || PRINT_FIELD(TID
)) &&
215 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TID
, "TID",
216 PERF_OUTPUT_TID
|PERF_OUTPUT_PID
))
219 if (PRINT_FIELD(TIME
) &&
220 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TIME
, "TIME",
224 if (PRINT_FIELD(CPU
) &&
225 perf_evsel__check_stype(evsel
, PERF_SAMPLE_CPU
, "CPU",
232 static void set_print_ip_opts(struct perf_event_attr
*attr
)
234 unsigned int type
= attr
->type
;
236 output
[type
].print_ip_opts
= 0;
238 output
[type
].print_ip_opts
|= PRINT_IP_OPT_IP
;
240 if (PRINT_FIELD(SYM
))
241 output
[type
].print_ip_opts
|= PRINT_IP_OPT_SYM
;
243 if (PRINT_FIELD(DSO
))
244 output
[type
].print_ip_opts
|= PRINT_IP_OPT_DSO
;
246 if (PRINT_FIELD(SYMOFFSET
))
247 output
[type
].print_ip_opts
|= PRINT_IP_OPT_SYMOFFSET
;
251 * verify all user requested events exist and the samples
252 * have the expected data
254 static int perf_session__check_output_opt(struct perf_session
*session
)
257 struct perf_evsel
*evsel
;
259 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
260 evsel
= perf_session__find_first_evtype(session
, j
);
263 * even if fields is set to 0 (ie., show nothing) event must
264 * exist if user explicitly includes it on the command line
266 if (!evsel
&& output
[j
].user_set
&& !output
[j
].wildcard_set
) {
267 pr_err("%s events do not exist. "
268 "Remove corresponding -f option to proceed.\n",
273 if (evsel
&& output
[j
].fields
&&
274 perf_evsel__check_attr(evsel
, session
))
280 set_print_ip_opts(&evsel
->attr
);
286 static void print_sample_start(struct perf_sample
*sample
,
287 struct thread
*thread
,
288 struct perf_evsel
*evsel
)
290 struct perf_event_attr
*attr
= &evsel
->attr
;
291 const char *evname
= NULL
;
294 unsigned long long nsecs
;
296 if (PRINT_FIELD(COMM
)) {
298 printf("%8.8s ", thread__comm_str(thread
));
299 else if (PRINT_FIELD(IP
) && symbol_conf
.use_callchain
)
300 printf("%s ", thread__comm_str(thread
));
302 printf("%16s ", thread__comm_str(thread
));
305 if (PRINT_FIELD(PID
) && PRINT_FIELD(TID
))
306 printf("%5d/%-5d ", sample
->pid
, sample
->tid
);
307 else if (PRINT_FIELD(PID
))
308 printf("%5d ", sample
->pid
);
309 else if (PRINT_FIELD(TID
))
310 printf("%5d ", sample
->tid
);
312 if (PRINT_FIELD(CPU
)) {
314 printf("%3d ", sample
->cpu
);
316 printf("[%03d] ", sample
->cpu
);
319 if (PRINT_FIELD(TIME
)) {
320 nsecs
= sample
->time
;
321 secs
= nsecs
/ NSECS_PER_SEC
;
322 nsecs
-= secs
* NSECS_PER_SEC
;
323 usecs
= nsecs
/ NSECS_PER_USEC
;
324 printf("%5lu.%06lu: ", secs
, usecs
);
327 if (PRINT_FIELD(EVNAME
)) {
328 evname
= perf_evsel__name(evsel
);
329 printf("%s: ", evname
? evname
: "[unknown]");
333 static bool is_bts_event(struct perf_event_attr
*attr
)
335 return ((attr
->type
== PERF_TYPE_HARDWARE
) &&
336 (attr
->config
& PERF_COUNT_HW_BRANCH_INSTRUCTIONS
) &&
337 (attr
->sample_period
== 1));
340 static bool sample_addr_correlates_sym(struct perf_event_attr
*attr
)
342 if ((attr
->type
== PERF_TYPE_SOFTWARE
) &&
343 ((attr
->config
== PERF_COUNT_SW_PAGE_FAULTS
) ||
344 (attr
->config
== PERF_COUNT_SW_PAGE_FAULTS_MIN
) ||
345 (attr
->config
== PERF_COUNT_SW_PAGE_FAULTS_MAJ
)))
348 if (is_bts_event(attr
))
354 static void print_sample_addr(union perf_event
*event
,
355 struct perf_sample
*sample
,
356 struct machine
*machine
,
357 struct thread
*thread
,
358 struct perf_event_attr
*attr
)
360 struct addr_location al
;
361 u8 cpumode
= event
->header
.misc
& PERF_RECORD_MISC_CPUMODE_MASK
;
363 printf("%16" PRIx64
, sample
->addr
);
365 if (!sample_addr_correlates_sym(attr
))
368 thread__find_addr_map(thread
, machine
, cpumode
, MAP__FUNCTION
,
371 thread__find_addr_map(thread
, machine
, cpumode
, MAP__VARIABLE
,
374 al
.cpu
= sample
->cpu
;
378 al
.sym
= map__find_symbol(al
.map
, al
.addr
, NULL
);
380 if (PRINT_FIELD(SYM
)) {
382 if (PRINT_FIELD(SYMOFFSET
))
383 symbol__fprintf_symname_offs(al
.sym
, &al
, stdout
);
385 symbol__fprintf_symname(al
.sym
, stdout
);
388 if (PRINT_FIELD(DSO
)) {
390 map__fprintf_dsoname(al
.map
, stdout
);
395 static void print_sample_bts(union perf_event
*event
,
396 struct perf_sample
*sample
,
397 struct perf_evsel
*evsel
,
398 struct machine
*machine
,
399 struct thread
*thread
)
401 struct perf_event_attr
*attr
= &evsel
->attr
;
403 /* print branch_from information */
404 if (PRINT_FIELD(IP
)) {
405 if (!symbol_conf
.use_callchain
)
409 perf_evsel__print_ip(evsel
, event
, sample
, machine
,
410 output
[attr
->type
].print_ip_opts
,
411 PERF_MAX_STACK_DEPTH
);
416 /* print branch_to information */
417 if (PRINT_FIELD(ADDR
) ||
418 ((evsel
->attr
.sample_type
& PERF_SAMPLE_ADDR
) &&
419 !output
[attr
->type
].user_set
))
420 print_sample_addr(event
, sample
, machine
, thread
, attr
);
425 static void process_event(union perf_event
*event
, struct perf_sample
*sample
,
426 struct perf_evsel
*evsel
, struct machine
*machine
,
427 struct thread
*thread
,
428 struct addr_location
*al __maybe_unused
)
430 struct perf_event_attr
*attr
= &evsel
->attr
;
432 if (output
[attr
->type
].fields
== 0)
435 print_sample_start(sample
, thread
, evsel
);
437 if (is_bts_event(attr
)) {
438 print_sample_bts(event
, sample
, evsel
, machine
, thread
);
442 if (PRINT_FIELD(TRACE
))
443 event_format__print(evsel
->tp_format
, sample
->cpu
,
444 sample
->raw_data
, sample
->raw_size
);
445 if (PRINT_FIELD(ADDR
))
446 print_sample_addr(event
, sample
, machine
, thread
, attr
);
448 if (PRINT_FIELD(IP
)) {
449 if (!symbol_conf
.use_callchain
)
454 perf_evsel__print_ip(evsel
, event
, sample
, machine
,
455 output
[attr
->type
].print_ip_opts
,
456 PERF_MAX_STACK_DEPTH
);
462 static int default_start_script(const char *script __maybe_unused
,
463 int argc __maybe_unused
,
464 const char **argv __maybe_unused
)
469 static int default_stop_script(void)
474 static int default_generate_script(struct pevent
*pevent __maybe_unused
,
475 const char *outfile __maybe_unused
)
480 static struct scripting_ops default_scripting_ops
= {
481 .start_script
= default_start_script
,
482 .stop_script
= default_stop_script
,
483 .process_event
= process_event
,
484 .generate_script
= default_generate_script
,
487 static struct scripting_ops
*scripting_ops
;
489 static void setup_scripting(void)
491 setup_perl_scripting();
492 setup_python_scripting();
494 scripting_ops
= &default_scripting_ops
;
497 static int cleanup_scripting(void)
499 pr_debug("\nperf script stopped\n");
501 return scripting_ops
->stop_script();
504 static int process_sample_event(struct perf_tool
*tool __maybe_unused
,
505 union perf_event
*event
,
506 struct perf_sample
*sample
,
507 struct perf_evsel
*evsel
,
508 struct machine
*machine
)
510 struct addr_location al
;
511 struct thread
*thread
= machine__findnew_thread(machine
, sample
->pid
,
514 if (thread
== NULL
) {
515 pr_debug("problem processing %d event, skipping it.\n",
521 if (sample
->time
< last_timestamp
) {
522 pr_err("Samples misordered, previous: %" PRIu64
523 " this: %" PRIu64
"\n", last_timestamp
,
527 last_timestamp
= sample
->time
;
531 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
) < 0) {
532 pr_err("problem processing %d event, skipping it.\n",
540 if (cpu_list
&& !test_bit(sample
->cpu
, cpu_bitmap
))
543 scripting_ops
->process_event(event
, sample
, evsel
, machine
, thread
, &al
);
545 evsel
->hists
.stats
.total_period
+= sample
->period
;
550 struct perf_tool tool
;
551 struct perf_session
*session
;
554 static int process_attr(struct perf_tool
*tool
, union perf_event
*event
,
555 struct perf_evlist
**pevlist
)
557 struct perf_script
*scr
= container_of(tool
, struct perf_script
, tool
);
558 struct perf_evlist
*evlist
;
559 struct perf_evsel
*evsel
, *pos
;
562 err
= perf_event__process_attr(tool
, event
, pevlist
);
567 evsel
= perf_evlist__last(*pevlist
);
569 if (evsel
->attr
.type
>= PERF_TYPE_MAX
)
572 list_for_each_entry(pos
, &evlist
->entries
, node
) {
573 if (pos
->attr
.type
== evsel
->attr
.type
&& pos
!= evsel
)
577 set_print_ip_opts(&evsel
->attr
);
579 return perf_evsel__check_attr(evsel
, scr
->session
);
582 static void sig_handler(int sig __maybe_unused
)
587 static int __cmd_script(struct perf_script
*script
)
591 signal(SIGINT
, sig_handler
);
593 ret
= perf_session__process_events(script
->session
, &script
->tool
);
596 pr_err("Misordered timestamps: %" PRIu64
"\n", nr_unordered
);
602 struct list_head node
;
603 struct scripting_ops
*ops
;
607 static LIST_HEAD(script_specs
);
609 static struct script_spec
*script_spec__new(const char *spec
,
610 struct scripting_ops
*ops
)
612 struct script_spec
*s
= malloc(sizeof(*s
) + strlen(spec
) + 1);
615 strcpy(s
->spec
, spec
);
622 static void script_spec__add(struct script_spec
*s
)
624 list_add_tail(&s
->node
, &script_specs
);
627 static struct script_spec
*script_spec__find(const char *spec
)
629 struct script_spec
*s
;
631 list_for_each_entry(s
, &script_specs
, node
)
632 if (strcasecmp(s
->spec
, spec
) == 0)
637 static struct script_spec
*script_spec__findnew(const char *spec
,
638 struct scripting_ops
*ops
)
640 struct script_spec
*s
= script_spec__find(spec
);
645 s
= script_spec__new(spec
, ops
);
654 int script_spec_register(const char *spec
, struct scripting_ops
*ops
)
656 struct script_spec
*s
;
658 s
= script_spec__find(spec
);
662 s
= script_spec__findnew(spec
, ops
);
669 static struct scripting_ops
*script_spec__lookup(const char *spec
)
671 struct script_spec
*s
= script_spec__find(spec
);
678 static void list_available_languages(void)
680 struct script_spec
*s
;
682 fprintf(stderr
, "\n");
683 fprintf(stderr
, "Scripting language extensions (used in "
684 "perf script -s [spec:]script.[spec]):\n\n");
686 list_for_each_entry(s
, &script_specs
, node
)
687 fprintf(stderr
, " %-42s [%s]\n", s
->spec
, s
->ops
->name
);
689 fprintf(stderr
, "\n");
692 static int parse_scriptname(const struct option
*opt __maybe_unused
,
693 const char *str
, int unset __maybe_unused
)
696 const char *script
, *ext
;
699 if (strcmp(str
, "lang") == 0) {
700 list_available_languages();
704 script
= strchr(str
, ':');
707 if (len
>= PATH_MAX
) {
708 fprintf(stderr
, "invalid language specifier");
711 strncpy(spec
, str
, len
);
713 scripting_ops
= script_spec__lookup(spec
);
714 if (!scripting_ops
) {
715 fprintf(stderr
, "invalid language specifier");
721 ext
= strrchr(script
, '.');
723 fprintf(stderr
, "invalid script extension");
726 scripting_ops
= script_spec__lookup(++ext
);
727 if (!scripting_ops
) {
728 fprintf(stderr
, "invalid script extension");
733 script_name
= strdup(script
);
738 static int parse_output_fields(const struct option
*opt __maybe_unused
,
739 const char *arg
, int unset __maybe_unused
)
742 int i
, imax
= ARRAY_SIZE(all_output_options
);
745 char *str
= strdup(arg
);
751 /* first word can state for which event type the user is specifying
752 * the fields. If no type exists, the specified fields apply to all
753 * event types found in the file minus the invalid fields for a type.
755 tok
= strchr(str
, ':');
759 if (!strcmp(str
, "hw"))
760 type
= PERF_TYPE_HARDWARE
;
761 else if (!strcmp(str
, "sw"))
762 type
= PERF_TYPE_SOFTWARE
;
763 else if (!strcmp(str
, "trace"))
764 type
= PERF_TYPE_TRACEPOINT
;
765 else if (!strcmp(str
, "raw"))
766 type
= PERF_TYPE_RAW
;
768 fprintf(stderr
, "Invalid event type in field string.\n");
773 if (output
[type
].user_set
)
774 pr_warning("Overriding previous field request for %s events.\n",
777 output
[type
].fields
= 0;
778 output
[type
].user_set
= true;
779 output
[type
].wildcard_set
= false;
783 if (strlen(str
) == 0) {
785 "Cannot set fields to 'none' for all event types.\n");
790 if (output_set_by_user())
791 pr_warning("Overriding previous field request for all events.\n");
793 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
794 output
[j
].fields
= 0;
795 output
[j
].user_set
= true;
796 output
[j
].wildcard_set
= true;
800 tok
= strtok(tok
, ",");
802 for (i
= 0; i
< imax
; ++i
) {
803 if (strcmp(tok
, all_output_options
[i
].str
) == 0)
807 fprintf(stderr
, "Invalid field requested.\n");
813 /* add user option to all events types for
816 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
817 if (output
[j
].invalid_fields
& all_output_options
[i
].field
) {
818 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
819 all_output_options
[i
].str
, event_type(j
));
821 output
[j
].fields
|= all_output_options
[i
].field
;
824 if (output
[type
].invalid_fields
& all_output_options
[i
].field
) {
825 fprintf(stderr
, "\'%s\' not valid for %s events.\n",
826 all_output_options
[i
].str
, event_type(type
));
831 output
[type
].fields
|= all_output_options
[i
].field
;
834 tok
= strtok(NULL
, ",");
838 if (output
[type
].fields
== 0) {
839 pr_debug("No fields requested for %s type. "
840 "Events will not be displayed.\n", event_type(type
));
849 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
850 static int is_directory(const char *base_path
, const struct dirent
*dent
)
855 sprintf(path
, "%s/%s", base_path
, dent
->d_name
);
859 return S_ISDIR(st
.st_mode
);
862 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
863 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
865 if ((lang_dirent.d_type == DT_DIR || \
866 (lang_dirent.d_type == DT_UNKNOWN && \
867 is_directory(scripts_path, &lang_dirent))) && \
868 (strcmp(lang_dirent.d_name, ".")) && \
869 (strcmp(lang_dirent.d_name, "..")))
871 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
872 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
874 if (script_dirent.d_type != DT_DIR && \
875 (script_dirent.d_type != DT_UNKNOWN || \
876 !is_directory(lang_path, &script_dirent)))
879 #define RECORD_SUFFIX "-record"
880 #define REPORT_SUFFIX "-report"
883 struct list_head node
;
889 static LIST_HEAD(script_descs
);
891 static struct script_desc
*script_desc__new(const char *name
)
893 struct script_desc
*s
= zalloc(sizeof(*s
));
895 if (s
!= NULL
&& name
)
896 s
->name
= strdup(name
);
901 static void script_desc__delete(struct script_desc
*s
)
909 static void script_desc__add(struct script_desc
*s
)
911 list_add_tail(&s
->node
, &script_descs
);
914 static struct script_desc
*script_desc__find(const char *name
)
916 struct script_desc
*s
;
918 list_for_each_entry(s
, &script_descs
, node
)
919 if (strcasecmp(s
->name
, name
) == 0)
924 static struct script_desc
*script_desc__findnew(const char *name
)
926 struct script_desc
*s
= script_desc__find(name
);
931 s
= script_desc__new(name
);
933 goto out_delete_desc
;
940 script_desc__delete(s
);
945 static const char *ends_with(const char *str
, const char *suffix
)
947 size_t suffix_len
= strlen(suffix
);
950 if (strlen(str
) > suffix_len
) {
951 p
= str
+ strlen(str
) - suffix_len
;
952 if (!strncmp(p
, suffix
, suffix_len
))
959 static int read_script_info(struct script_desc
*desc
, const char *filename
)
961 char line
[BUFSIZ
], *p
;
964 fp
= fopen(filename
, "r");
968 while (fgets(line
, sizeof(line
), fp
)) {
975 if (strlen(p
) && *p
== '!')
979 if (strlen(p
) && p
[strlen(p
) - 1] == '\n')
980 p
[strlen(p
) - 1] = '\0';
982 if (!strncmp(p
, "description:", strlen("description:"))) {
983 p
+= strlen("description:");
984 desc
->half_liner
= strdup(ltrim(p
));
988 if (!strncmp(p
, "args:", strlen("args:"))) {
989 p
+= strlen("args:");
990 desc
->args
= strdup(ltrim(p
));
1000 static char *get_script_root(struct dirent
*script_dirent
, const char *suffix
)
1002 char *script_root
, *str
;
1004 script_root
= strdup(script_dirent
->d_name
);
1008 str
= (char *)ends_with(script_root
, suffix
);
1018 static int list_available_scripts(const struct option
*opt __maybe_unused
,
1019 const char *s __maybe_unused
,
1020 int unset __maybe_unused
)
1022 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1023 char scripts_path
[MAXPATHLEN
];
1024 DIR *scripts_dir
, *lang_dir
;
1025 char script_path
[MAXPATHLEN
];
1026 char lang_path
[MAXPATHLEN
];
1027 struct script_desc
*desc
;
1028 char first_half
[BUFSIZ
];
1031 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1033 scripts_dir
= opendir(scripts_path
);
1037 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1038 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1039 lang_dirent
.d_name
);
1040 lang_dir
= opendir(lang_path
);
1044 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1045 script_root
= get_script_root(&script_dirent
, REPORT_SUFFIX
);
1047 desc
= script_desc__findnew(script_root
);
1048 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1049 lang_path
, script_dirent
.d_name
);
1050 read_script_info(desc
, script_path
);
1056 fprintf(stdout
, "List of available trace scripts:\n");
1057 list_for_each_entry(desc
, &script_descs
, node
) {
1058 sprintf(first_half
, "%s %s", desc
->name
,
1059 desc
->args
? desc
->args
: "");
1060 fprintf(stdout
, " %-36s %s\n", first_half
,
1061 desc
->half_liner
? desc
->half_liner
: "");
1068 * Some scripts specify the required events in their "xxx-record" file,
1069 * this function will check if the events in perf.data match those
1070 * mentioned in the "xxx-record".
1072 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1073 * which is covered well now. And new parsing code should be added to
1074 * cover the future complexing formats like event groups etc.
1076 static int check_ev_match(char *dir_name
, char *scriptname
,
1077 struct perf_session
*session
)
1079 char filename
[MAXPATHLEN
], evname
[128];
1080 char line
[BUFSIZ
], *p
;
1081 struct perf_evsel
*pos
;
1085 sprintf(filename
, "%s/bin/%s-record", dir_name
, scriptname
);
1087 fp
= fopen(filename
, "r");
1091 while (fgets(line
, sizeof(line
), fp
)) {
1097 p
= strstr(p
, "-e");
1103 len
= strcspn(p
, " \t");
1107 snprintf(evname
, len
+ 1, "%s", p
);
1110 list_for_each_entry(pos
,
1111 &session
->evlist
->entries
, node
) {
1112 if (!strcmp(perf_evsel__name(pos
), evname
)) {
1130 * Return -1 if none is found, otherwise the actual scripts number.
1132 * Currently the only user of this function is the script browser, which
1133 * will list all statically runnable scripts, select one, execute it and
1134 * show the output in a perf browser.
1136 int find_scripts(char **scripts_array
, char **scripts_path_array
)
1138 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1139 char scripts_path
[MAXPATHLEN
], lang_path
[MAXPATHLEN
];
1140 DIR *scripts_dir
, *lang_dir
;
1141 struct perf_session
*session
;
1142 struct perf_data_file file
= {
1144 .mode
= PERF_DATA_MODE_READ
,
1149 session
= perf_session__new(&file
, false, NULL
);
1153 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1155 scripts_dir
= opendir(scripts_path
);
1157 perf_session__delete(session
);
1161 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1162 snprintf(lang_path
, MAXPATHLEN
, "%s/%s", scripts_path
,
1163 lang_dirent
.d_name
);
1165 if (strstr(lang_path
, "perl"))
1169 if (strstr(lang_path
, "python"))
1173 lang_dir
= opendir(lang_path
);
1177 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1178 /* Skip those real time scripts: xxxtop.p[yl] */
1179 if (strstr(script_dirent
.d_name
, "top."))
1181 sprintf(scripts_path_array
[i
], "%s/%s", lang_path
,
1182 script_dirent
.d_name
);
1183 temp
= strchr(script_dirent
.d_name
, '.');
1184 snprintf(scripts_array
[i
],
1185 (temp
- script_dirent
.d_name
) + 1,
1186 "%s", script_dirent
.d_name
);
1188 if (check_ev_match(lang_path
,
1189 scripts_array
[i
], session
))
1197 closedir(scripts_dir
);
1198 perf_session__delete(session
);
1202 static char *get_script_path(const char *script_root
, const char *suffix
)
1204 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1205 char scripts_path
[MAXPATHLEN
];
1206 char script_path
[MAXPATHLEN
];
1207 DIR *scripts_dir
, *lang_dir
;
1208 char lang_path
[MAXPATHLEN
];
1209 char *__script_root
;
1211 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1213 scripts_dir
= opendir(scripts_path
);
1217 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1218 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1219 lang_dirent
.d_name
);
1220 lang_dir
= opendir(lang_path
);
1224 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1225 __script_root
= get_script_root(&script_dirent
, suffix
);
1226 if (__script_root
&& !strcmp(script_root
, __script_root
)) {
1227 free(__script_root
);
1229 closedir(scripts_dir
);
1230 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1231 lang_path
, script_dirent
.d_name
);
1232 return strdup(script_path
);
1234 free(__script_root
);
1238 closedir(scripts_dir
);
1243 static bool is_top_script(const char *script_path
)
1245 return ends_with(script_path
, "top") == NULL
? false : true;
1248 static int has_required_arg(char *script_path
)
1250 struct script_desc
*desc
;
1254 desc
= script_desc__new(NULL
);
1256 if (read_script_info(desc
, script_path
))
1262 for (p
= desc
->args
; *p
; p
++)
1266 script_desc__delete(desc
);
1271 static int have_cmd(int argc
, const char **argv
)
1273 char **__argv
= malloc(sizeof(const char *) * argc
);
1276 pr_err("malloc failed\n");
1280 memcpy(__argv
, argv
, sizeof(const char *) * argc
);
1281 argc
= parse_options(argc
, (const char **)__argv
, record_options
,
1282 NULL
, PARSE_OPT_STOP_AT_NON_OPTION
);
1285 system_wide
= (argc
== 0);
1290 int cmd_script(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1292 bool show_full_info
= false;
1293 char *rec_script_path
= NULL
;
1294 char *rep_script_path
= NULL
;
1295 struct perf_session
*session
;
1296 char *script_path
= NULL
;
1297 const char **__argv
;
1299 struct perf_script script
= {
1301 .sample
= process_sample_event
,
1302 .mmap
= perf_event__process_mmap
,
1303 .mmap2
= perf_event__process_mmap2
,
1304 .comm
= perf_event__process_comm
,
1305 .exit
= perf_event__process_exit
,
1306 .fork
= perf_event__process_fork
,
1307 .attr
= process_attr
,
1308 .tracing_data
= perf_event__process_tracing_data
,
1309 .build_id
= perf_event__process_build_id
,
1310 .ordered_samples
= true,
1311 .ordering_requires_timestamps
= true,
1314 const struct option options
[] = {
1315 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
1316 "dump raw trace in ASCII"),
1317 OPT_INCR('v', "verbose", &verbose
,
1318 "be more verbose (show symbol address, etc)"),
1319 OPT_BOOLEAN('L', "Latency", &latency_format
,
1320 "show latency attributes (irqs/preemption disabled, etc)"),
1321 OPT_CALLBACK_NOOPT('l', "list", NULL
, NULL
, "list available scripts",
1322 list_available_scripts
),
1323 OPT_CALLBACK('s', "script", NULL
, "name",
1324 "script file name (lang:script name, script name, or *)",
1326 OPT_STRING('g', "gen-script", &generate_script_lang
, "lang",
1327 "generate perf-script.xx script in specified language"),
1328 OPT_STRING('i', "input", &input_name
, "file", "input file name"),
1329 OPT_BOOLEAN('d', "debug-mode", &debug_mode
,
1330 "do various checks like samples ordering and lost events"),
1331 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
1332 "file", "vmlinux pathname"),
1333 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
1334 "file", "kallsyms pathname"),
1335 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain
,
1336 "When printing symbols do not display call chain"),
1337 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
1338 "Look for files with symbols relative to this directory"),
1339 OPT_CALLBACK('f', "fields", NULL
, "str",
1340 "comma separated output fields prepend with 'type:'. "
1341 "Valid types: hw,sw,trace,raw. "
1342 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1343 "addr,symoff", parse_output_fields
),
1344 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
1345 "system-wide collection from all CPUs"),
1346 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
1347 "only consider these symbols"),
1348 OPT_STRING('C', "cpu", &cpu_list
, "cpu", "list of cpus to profile"),
1349 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
1350 "only display events for these comms"),
1351 OPT_BOOLEAN('I', "show-info", &show_full_info
,
1352 "display extended information from perf.data file"),
1353 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf
.show_kernel_path
,
1354 "Show the path of [kernel.kallsyms]"),
1357 const char * const script_usage
[] = {
1358 "perf script [<options>]",
1359 "perf script [<options>] record <script> [<record-options>] <command>",
1360 "perf script [<options>] report <script> [script-args]",
1361 "perf script [<options>] <script> [<record-options>] <command>",
1362 "perf script [<options>] <top-script> [script-args]",
1365 struct perf_data_file file
= {
1366 .mode
= PERF_DATA_MODE_READ
,
1371 argc
= parse_options(argc
, argv
, options
, script_usage
,
1372 PARSE_OPT_STOP_AT_NON_OPTION
);
1374 file
.path
= input_name
;
1376 if (argc
> 1 && !strncmp(argv
[0], "rec", strlen("rec"))) {
1377 rec_script_path
= get_script_path(argv
[1], RECORD_SUFFIX
);
1378 if (!rec_script_path
)
1379 return cmd_record(argc
, argv
, NULL
);
1382 if (argc
> 1 && !strncmp(argv
[0], "rep", strlen("rep"))) {
1383 rep_script_path
= get_script_path(argv
[1], REPORT_SUFFIX
);
1384 if (!rep_script_path
) {
1386 "Please specify a valid report script"
1387 "(see 'perf script -l' for listing)\n");
1392 /* make sure PERF_EXEC_PATH is set for scripts */
1393 perf_set_argv_exec_path(perf_exec_path());
1395 if (argc
&& !script_name
&& !rec_script_path
&& !rep_script_path
) {
1400 rec_script_path
= get_script_path(argv
[0], RECORD_SUFFIX
);
1401 rep_script_path
= get_script_path(argv
[0], REPORT_SUFFIX
);
1403 if (!rec_script_path
&& !rep_script_path
) {
1404 fprintf(stderr
, " Couldn't find script %s\n\n See perf"
1405 " script -l for available scripts.\n", argv
[0]);
1406 usage_with_options(script_usage
, options
);
1409 if (is_top_script(argv
[0])) {
1410 rep_args
= argc
- 1;
1414 rep_args
= has_required_arg(rep_script_path
);
1415 rec_args
= (argc
- 1) - rep_args
;
1417 fprintf(stderr
, " %s script requires options."
1418 "\n\n See perf script -l for available "
1419 "scripts and options.\n", argv
[0]);
1420 usage_with_options(script_usage
, options
);
1424 if (pipe(live_pipe
) < 0) {
1425 perror("failed to create pipe");
1431 perror("failed to fork");
1438 dup2(live_pipe
[1], 1);
1439 close(live_pipe
[0]);
1441 if (is_top_script(argv
[0])) {
1443 } else if (!system_wide
) {
1444 if (have_cmd(argc
- rep_args
, &argv
[rep_args
]) != 0) {
1450 __argv
= malloc((argc
+ 6) * sizeof(const char *));
1452 pr_err("malloc failed\n");
1457 __argv
[j
++] = "/bin/sh";
1458 __argv
[j
++] = rec_script_path
;
1464 for (i
= rep_args
+ 1; i
< argc
; i
++)
1465 __argv
[j
++] = argv
[i
];
1468 execvp("/bin/sh", (char **)__argv
);
1473 dup2(live_pipe
[0], 0);
1474 close(live_pipe
[1]);
1476 __argv
= malloc((argc
+ 4) * sizeof(const char *));
1478 pr_err("malloc failed\n");
1484 __argv
[j
++] = "/bin/sh";
1485 __argv
[j
++] = rep_script_path
;
1486 for (i
= 1; i
< rep_args
+ 1; i
++)
1487 __argv
[j
++] = argv
[i
];
1492 execvp("/bin/sh", (char **)__argv
);
1497 if (rec_script_path
)
1498 script_path
= rec_script_path
;
1499 if (rep_script_path
)
1500 script_path
= rep_script_path
;
1505 if (!rec_script_path
)
1506 system_wide
= false;
1507 else if (!system_wide
) {
1508 if (have_cmd(argc
- 1, &argv
[1]) != 0) {
1514 __argv
= malloc((argc
+ 2) * sizeof(const char *));
1516 pr_err("malloc failed\n");
1521 __argv
[j
++] = "/bin/sh";
1522 __argv
[j
++] = script_path
;
1525 for (i
= 2; i
< argc
; i
++)
1526 __argv
[j
++] = argv
[i
];
1529 execvp("/bin/sh", (char **)__argv
);
1534 if (symbol__init() < 0)
1539 session
= perf_session__new(&file
, false, &script
.tool
);
1540 if (session
== NULL
)
1543 script
.session
= session
;
1546 if (perf_session__cpu_bitmap(session
, cpu_list
, cpu_bitmap
))
1550 if (!script_name
&& !generate_script_lang
)
1551 perf_session__fprintf_info(session
, stdout
, show_full_info
);
1554 symbol_conf
.use_callchain
= true;
1556 symbol_conf
.use_callchain
= false;
1558 if (generate_script_lang
) {
1559 struct stat perf_stat
;
1562 if (output_set_by_user()) {
1564 "custom fields not supported for generated scripts");
1568 input
= open(file
.path
, O_RDONLY
); /* input_name */
1570 perror("failed to open file");
1574 err
= fstat(input
, &perf_stat
);
1576 perror("failed to stat file");
1580 if (!perf_stat
.st_size
) {
1581 fprintf(stderr
, "zero-sized file, nothing to do!\n");
1585 scripting_ops
= script_spec__lookup(generate_script_lang
);
1586 if (!scripting_ops
) {
1587 fprintf(stderr
, "invalid language specifier");
1591 err
= scripting_ops
->generate_script(session
->pevent
,
1597 err
= scripting_ops
->start_script(script_name
, argc
, argv
);
1600 pr_debug("perf script started with script %s\n\n", script_name
);
1604 err
= perf_session__check_output_opt(session
);
1608 err
= __cmd_script(&script
);
1610 perf_session__delete(session
);
1611 cleanup_scripting();