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 <linux/bitmap.h>
20 static char const *script_name
;
21 static char const *generate_script_lang
;
22 static bool debug_mode
;
23 static u64 last_timestamp
;
24 static u64 nr_unordered
;
25 extern const struct option record_options
[];
26 static bool no_callchain
;
27 static bool latency_format
;
28 static bool system_wide
;
29 static const char *cpu_list
;
30 static DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
32 enum perf_output_field
{
33 PERF_OUTPUT_COMM
= 1U << 0,
34 PERF_OUTPUT_TID
= 1U << 1,
35 PERF_OUTPUT_PID
= 1U << 2,
36 PERF_OUTPUT_TIME
= 1U << 3,
37 PERF_OUTPUT_CPU
= 1U << 4,
38 PERF_OUTPUT_EVNAME
= 1U << 5,
39 PERF_OUTPUT_TRACE
= 1U << 6,
40 PERF_OUTPUT_IP
= 1U << 7,
41 PERF_OUTPUT_SYM
= 1U << 8,
42 PERF_OUTPUT_DSO
= 1U << 9,
43 PERF_OUTPUT_ADDR
= 1U << 10,
44 PERF_OUTPUT_SYMOFFSET
= 1U << 11,
47 struct output_option
{
49 enum perf_output_field field
;
50 } all_output_options
[] = {
51 {.str
= "comm", .field
= PERF_OUTPUT_COMM
},
52 {.str
= "tid", .field
= PERF_OUTPUT_TID
},
53 {.str
= "pid", .field
= PERF_OUTPUT_PID
},
54 {.str
= "time", .field
= PERF_OUTPUT_TIME
},
55 {.str
= "cpu", .field
= PERF_OUTPUT_CPU
},
56 {.str
= "event", .field
= PERF_OUTPUT_EVNAME
},
57 {.str
= "trace", .field
= PERF_OUTPUT_TRACE
},
58 {.str
= "ip", .field
= PERF_OUTPUT_IP
},
59 {.str
= "sym", .field
= PERF_OUTPUT_SYM
},
60 {.str
= "dso", .field
= PERF_OUTPUT_DSO
},
61 {.str
= "addr", .field
= PERF_OUTPUT_ADDR
},
62 {.str
= "symoff", .field
= PERF_OUTPUT_SYMOFFSET
},
65 /* default set to maintain compatibility with current format */
69 unsigned int print_ip_opts
;
72 } output
[PERF_TYPE_MAX
] = {
74 [PERF_TYPE_HARDWARE
] = {
77 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
78 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
79 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
80 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
82 .invalid_fields
= PERF_OUTPUT_TRACE
,
85 [PERF_TYPE_SOFTWARE
] = {
88 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
89 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
90 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
91 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
93 .invalid_fields
= PERF_OUTPUT_TRACE
,
96 [PERF_TYPE_TRACEPOINT
] = {
99 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
100 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
101 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_TRACE
,
107 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
108 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
109 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
110 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
112 .invalid_fields
= PERF_OUTPUT_TRACE
,
116 static bool output_set_by_user(void)
119 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
120 if (output
[j
].user_set
)
126 static const char *output_field2str(enum perf_output_field field
)
128 int i
, imax
= ARRAY_SIZE(all_output_options
);
129 const char *str
= "";
131 for (i
= 0; i
< imax
; ++i
) {
132 if (all_output_options
[i
].field
== field
) {
133 str
= all_output_options
[i
].str
;
140 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
142 static int perf_evsel__check_stype(struct perf_evsel
*evsel
,
143 u64 sample_type
, const char *sample_msg
,
144 enum perf_output_field field
)
146 struct perf_event_attr
*attr
= &evsel
->attr
;
147 int type
= attr
->type
;
150 if (attr
->sample_type
& sample_type
)
153 if (output
[type
].user_set
) {
154 evname
= perf_evsel__name(evsel
);
155 pr_err("Samples for '%s' event do not have %s attribute set. "
156 "Cannot print '%s' field.\n",
157 evname
, sample_msg
, output_field2str(field
));
161 /* user did not ask for it explicitly so remove from the default list */
162 output
[type
].fields
&= ~field
;
163 evname
= perf_evsel__name(evsel
);
164 pr_debug("Samples for '%s' event do not have %s attribute set. "
165 "Skipping '%s' field.\n",
166 evname
, sample_msg
, output_field2str(field
));
171 static int perf_evsel__check_attr(struct perf_evsel
*evsel
,
172 struct perf_session
*session
)
174 struct perf_event_attr
*attr
= &evsel
->attr
;
176 if (PRINT_FIELD(TRACE
) &&
177 !perf_session__has_traces(session
, "record -R"))
180 if (PRINT_FIELD(IP
)) {
181 if (perf_evsel__check_stype(evsel
, PERF_SAMPLE_IP
, "IP",
186 !(attr
->sample_type
& PERF_SAMPLE_CALLCHAIN
))
187 symbol_conf
.use_callchain
= false;
190 if (PRINT_FIELD(ADDR
) &&
191 perf_evsel__check_stype(evsel
, PERF_SAMPLE_ADDR
, "ADDR",
195 if (PRINT_FIELD(SYM
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
196 pr_err("Display of symbols requested but neither sample IP nor "
197 "sample address\nis selected. Hence, no addresses to convert "
201 if (PRINT_FIELD(SYMOFFSET
) && !PRINT_FIELD(SYM
)) {
202 pr_err("Display of offsets requested but symbol is not"
206 if (PRINT_FIELD(DSO
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
207 pr_err("Display of DSO requested but neither sample IP nor "
208 "sample address\nis selected. Hence, no addresses to convert "
213 if ((PRINT_FIELD(PID
) || PRINT_FIELD(TID
)) &&
214 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TID
, "TID",
215 PERF_OUTPUT_TID
|PERF_OUTPUT_PID
))
218 if (PRINT_FIELD(TIME
) &&
219 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TIME
, "TIME",
223 if (PRINT_FIELD(CPU
) &&
224 perf_evsel__check_stype(evsel
, PERF_SAMPLE_CPU
, "CPU",
232 * verify all user requested events exist and the samples
233 * have the expected data
235 static int perf_session__check_output_opt(struct perf_session
*session
)
238 struct perf_evsel
*evsel
;
239 struct perf_event_attr
*attr
;
241 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
242 evsel
= perf_session__find_first_evtype(session
, j
);
245 * even if fields is set to 0 (ie., show nothing) event must
246 * exist if user explicitly includes it on the command line
248 if (!evsel
&& output
[j
].user_set
&& !output
[j
].wildcard_set
) {
249 pr_err("%s events do not exist. "
250 "Remove corresponding -f option to proceed.\n",
255 if (evsel
&& output
[j
].fields
&&
256 perf_evsel__check_attr(evsel
, session
))
264 output
[j
].print_ip_opts
= 0;
266 output
[j
].print_ip_opts
|= PRINT_IP_OPT_IP
;
268 if (PRINT_FIELD(SYM
))
269 output
[j
].print_ip_opts
|= PRINT_IP_OPT_SYM
;
271 if (PRINT_FIELD(DSO
))
272 output
[j
].print_ip_opts
|= PRINT_IP_OPT_DSO
;
274 if (PRINT_FIELD(SYMOFFSET
))
275 output
[j
].print_ip_opts
|= PRINT_IP_OPT_SYMOFFSET
;
281 static void print_sample_start(struct perf_sample
*sample
,
282 struct thread
*thread
,
283 struct perf_evsel
*evsel
)
285 struct perf_event_attr
*attr
= &evsel
->attr
;
286 const char *evname
= NULL
;
289 unsigned long long nsecs
;
291 if (PRINT_FIELD(COMM
)) {
293 printf("%8.8s ", thread
->comm
);
294 else if (PRINT_FIELD(IP
) && symbol_conf
.use_callchain
)
295 printf("%s ", thread
->comm
);
297 printf("%16s ", thread
->comm
);
300 if (PRINT_FIELD(PID
) && PRINT_FIELD(TID
))
301 printf("%5d/%-5d ", sample
->pid
, sample
->tid
);
302 else if (PRINT_FIELD(PID
))
303 printf("%5d ", sample
->pid
);
304 else if (PRINT_FIELD(TID
))
305 printf("%5d ", sample
->tid
);
307 if (PRINT_FIELD(CPU
)) {
309 printf("%3d ", sample
->cpu
);
311 printf("[%03d] ", sample
->cpu
);
314 if (PRINT_FIELD(TIME
)) {
315 nsecs
= sample
->time
;
316 secs
= nsecs
/ NSECS_PER_SEC
;
317 nsecs
-= secs
* NSECS_PER_SEC
;
318 usecs
= nsecs
/ NSECS_PER_USEC
;
319 printf("%5lu.%06lu: ", secs
, usecs
);
322 if (PRINT_FIELD(EVNAME
)) {
323 evname
= perf_evsel__name(evsel
);
324 printf("%s: ", evname
? evname
: "[unknown]");
328 static bool is_bts_event(struct perf_event_attr
*attr
)
330 return ((attr
->type
== PERF_TYPE_HARDWARE
) &&
331 (attr
->config
& PERF_COUNT_HW_BRANCH_INSTRUCTIONS
) &&
332 (attr
->sample_period
== 1));
335 static bool sample_addr_correlates_sym(struct perf_event_attr
*attr
)
337 if ((attr
->type
== PERF_TYPE_SOFTWARE
) &&
338 ((attr
->config
== PERF_COUNT_SW_PAGE_FAULTS
) ||
339 (attr
->config
== PERF_COUNT_SW_PAGE_FAULTS_MIN
) ||
340 (attr
->config
== PERF_COUNT_SW_PAGE_FAULTS_MAJ
)))
343 if (is_bts_event(attr
))
349 static void print_sample_addr(union perf_event
*event
,
350 struct perf_sample
*sample
,
351 struct machine
*machine
,
352 struct thread
*thread
,
353 struct perf_event_attr
*attr
)
355 struct addr_location al
;
356 u8 cpumode
= event
->header
.misc
& PERF_RECORD_MISC_CPUMODE_MASK
;
358 printf("%16" PRIx64
, sample
->addr
);
360 if (!sample_addr_correlates_sym(attr
))
363 thread__find_addr_map(thread
, machine
, cpumode
, MAP__FUNCTION
,
366 thread__find_addr_map(thread
, machine
, cpumode
, MAP__VARIABLE
,
369 al
.cpu
= sample
->cpu
;
373 al
.sym
= map__find_symbol(al
.map
, al
.addr
, NULL
);
375 if (PRINT_FIELD(SYM
)) {
377 if (PRINT_FIELD(SYMOFFSET
))
378 symbol__fprintf_symname_offs(al
.sym
, &al
, stdout
);
380 symbol__fprintf_symname(al
.sym
, stdout
);
383 if (PRINT_FIELD(DSO
)) {
385 map__fprintf_dsoname(al
.map
, stdout
);
390 static void print_sample_bts(union perf_event
*event
,
391 struct perf_sample
*sample
,
392 struct perf_evsel
*evsel
,
393 struct machine
*machine
,
394 struct thread
*thread
)
396 struct perf_event_attr
*attr
= &evsel
->attr
;
398 /* print branch_from information */
399 if (PRINT_FIELD(IP
)) {
400 if (!symbol_conf
.use_callchain
)
404 perf_evsel__print_ip(evsel
, event
, sample
, machine
,
405 output
[attr
->type
].print_ip_opts
,
406 PERF_MAX_STACK_DEPTH
);
411 /* print branch_to information */
412 if (PRINT_FIELD(ADDR
))
413 print_sample_addr(event
, sample
, machine
, thread
, attr
);
418 static void process_event(union perf_event
*event
, struct perf_sample
*sample
,
419 struct perf_evsel
*evsel
, struct machine
*machine
,
420 struct thread
*thread
,
421 struct addr_location
*al __maybe_unused
)
423 struct perf_event_attr
*attr
= &evsel
->attr
;
425 if (output
[attr
->type
].fields
== 0)
428 print_sample_start(sample
, thread
, evsel
);
430 if (is_bts_event(attr
)) {
431 print_sample_bts(event
, sample
, evsel
, machine
, thread
);
435 if (PRINT_FIELD(TRACE
))
436 event_format__print(evsel
->tp_format
, sample
->cpu
,
437 sample
->raw_data
, sample
->raw_size
);
438 if (PRINT_FIELD(ADDR
))
439 print_sample_addr(event
, sample
, machine
, thread
, attr
);
441 if (PRINT_FIELD(IP
)) {
442 if (!symbol_conf
.use_callchain
)
447 perf_evsel__print_ip(evsel
, event
, sample
, machine
,
448 output
[attr
->type
].print_ip_opts
,
449 PERF_MAX_STACK_DEPTH
);
455 static int default_start_script(const char *script __maybe_unused
,
456 int argc __maybe_unused
,
457 const char **argv __maybe_unused
)
462 static int default_stop_script(void)
467 static int default_generate_script(struct pevent
*pevent __maybe_unused
,
468 const char *outfile __maybe_unused
)
473 static struct scripting_ops default_scripting_ops
= {
474 .start_script
= default_start_script
,
475 .stop_script
= default_stop_script
,
476 .process_event
= process_event
,
477 .generate_script
= default_generate_script
,
480 static struct scripting_ops
*scripting_ops
;
482 static void setup_scripting(void)
484 setup_perl_scripting();
485 setup_python_scripting();
487 scripting_ops
= &default_scripting_ops
;
490 static int cleanup_scripting(void)
492 pr_debug("\nperf script stopped\n");
494 return scripting_ops
->stop_script();
497 static int process_sample_event(struct perf_tool
*tool __maybe_unused
,
498 union perf_event
*event
,
499 struct perf_sample
*sample
,
500 struct perf_evsel
*evsel
,
501 struct machine
*machine
)
503 struct addr_location al
;
504 struct thread
*thread
= machine__findnew_thread(machine
, event
->ip
.pid
,
507 if (thread
== NULL
) {
508 pr_debug("problem processing %d event, skipping it.\n",
514 if (sample
->time
< last_timestamp
) {
515 pr_err("Samples misordered, previous: %" PRIu64
516 " this: %" PRIu64
"\n", last_timestamp
,
520 last_timestamp
= sample
->time
;
524 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
) < 0) {
525 pr_err("problem processing %d event, skipping it.\n",
533 if (cpu_list
&& !test_bit(sample
->cpu
, cpu_bitmap
))
536 scripting_ops
->process_event(event
, sample
, evsel
, machine
, thread
, &al
);
538 evsel
->hists
.stats
.total_period
+= sample
->period
;
542 static struct perf_tool perf_script
= {
543 .sample
= process_sample_event
,
544 .mmap
= perf_event__process_mmap
,
545 .comm
= perf_event__process_comm
,
546 .exit
= perf_event__process_exit
,
547 .fork
= perf_event__process_fork
,
548 .attr
= perf_event__process_attr
,
549 .tracing_data
= perf_event__process_tracing_data
,
550 .build_id
= perf_event__process_build_id
,
551 .ordered_samples
= true,
552 .ordering_requires_timestamps
= true,
555 extern volatile int session_done
;
557 static void sig_handler(int sig __maybe_unused
)
562 static int __cmd_script(struct perf_session
*session
)
566 signal(SIGINT
, sig_handler
);
568 ret
= perf_session__process_events(session
, &perf_script
);
571 pr_err("Misordered timestamps: %" PRIu64
"\n", nr_unordered
);
577 struct list_head node
;
578 struct scripting_ops
*ops
;
582 static LIST_HEAD(script_specs
);
584 static struct script_spec
*script_spec__new(const char *spec
,
585 struct scripting_ops
*ops
)
587 struct script_spec
*s
= malloc(sizeof(*s
) + strlen(spec
) + 1);
590 strcpy(s
->spec
, spec
);
597 static void script_spec__add(struct script_spec
*s
)
599 list_add_tail(&s
->node
, &script_specs
);
602 static struct script_spec
*script_spec__find(const char *spec
)
604 struct script_spec
*s
;
606 list_for_each_entry(s
, &script_specs
, node
)
607 if (strcasecmp(s
->spec
, spec
) == 0)
612 static struct script_spec
*script_spec__findnew(const char *spec
,
613 struct scripting_ops
*ops
)
615 struct script_spec
*s
= script_spec__find(spec
);
620 s
= script_spec__new(spec
, ops
);
629 int script_spec_register(const char *spec
, struct scripting_ops
*ops
)
631 struct script_spec
*s
;
633 s
= script_spec__find(spec
);
637 s
= script_spec__findnew(spec
, ops
);
644 static struct scripting_ops
*script_spec__lookup(const char *spec
)
646 struct script_spec
*s
= script_spec__find(spec
);
653 static void list_available_languages(void)
655 struct script_spec
*s
;
657 fprintf(stderr
, "\n");
658 fprintf(stderr
, "Scripting language extensions (used in "
659 "perf script -s [spec:]script.[spec]):\n\n");
661 list_for_each_entry(s
, &script_specs
, node
)
662 fprintf(stderr
, " %-42s [%s]\n", s
->spec
, s
->ops
->name
);
664 fprintf(stderr
, "\n");
667 static int parse_scriptname(const struct option
*opt __maybe_unused
,
668 const char *str
, int unset __maybe_unused
)
671 const char *script
, *ext
;
674 if (strcmp(str
, "lang") == 0) {
675 list_available_languages();
679 script
= strchr(str
, ':');
682 if (len
>= PATH_MAX
) {
683 fprintf(stderr
, "invalid language specifier");
686 strncpy(spec
, str
, len
);
688 scripting_ops
= script_spec__lookup(spec
);
689 if (!scripting_ops
) {
690 fprintf(stderr
, "invalid language specifier");
696 ext
= strrchr(script
, '.');
698 fprintf(stderr
, "invalid script extension");
701 scripting_ops
= script_spec__lookup(++ext
);
702 if (!scripting_ops
) {
703 fprintf(stderr
, "invalid script extension");
708 script_name
= strdup(script
);
713 static int parse_output_fields(const struct option
*opt __maybe_unused
,
714 const char *arg
, int unset __maybe_unused
)
717 int i
, imax
= ARRAY_SIZE(all_output_options
);
720 char *str
= strdup(arg
);
726 /* first word can state for which event type the user is specifying
727 * the fields. If no type exists, the specified fields apply to all
728 * event types found in the file minus the invalid fields for a type.
730 tok
= strchr(str
, ':');
734 if (!strcmp(str
, "hw"))
735 type
= PERF_TYPE_HARDWARE
;
736 else if (!strcmp(str
, "sw"))
737 type
= PERF_TYPE_SOFTWARE
;
738 else if (!strcmp(str
, "trace"))
739 type
= PERF_TYPE_TRACEPOINT
;
740 else if (!strcmp(str
, "raw"))
741 type
= PERF_TYPE_RAW
;
743 fprintf(stderr
, "Invalid event type in field string.\n");
748 if (output
[type
].user_set
)
749 pr_warning("Overriding previous field request for %s events.\n",
752 output
[type
].fields
= 0;
753 output
[type
].user_set
= true;
754 output
[type
].wildcard_set
= false;
758 if (strlen(str
) == 0) {
760 "Cannot set fields to 'none' for all event types.\n");
765 if (output_set_by_user())
766 pr_warning("Overriding previous field request for all events.\n");
768 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
769 output
[j
].fields
= 0;
770 output
[j
].user_set
= true;
771 output
[j
].wildcard_set
= true;
775 tok
= strtok(tok
, ",");
777 for (i
= 0; i
< imax
; ++i
) {
778 if (strcmp(tok
, all_output_options
[i
].str
) == 0)
782 fprintf(stderr
, "Invalid field requested.\n");
788 /* add user option to all events types for
791 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
792 if (output
[j
].invalid_fields
& all_output_options
[i
].field
) {
793 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
794 all_output_options
[i
].str
, event_type(j
));
796 output
[j
].fields
|= all_output_options
[i
].field
;
799 if (output
[type
].invalid_fields
& all_output_options
[i
].field
) {
800 fprintf(stderr
, "\'%s\' not valid for %s events.\n",
801 all_output_options
[i
].str
, event_type(type
));
806 output
[type
].fields
|= all_output_options
[i
].field
;
809 tok
= strtok(NULL
, ",");
813 if (output
[type
].fields
== 0) {
814 pr_debug("No fields requested for %s type. "
815 "Events will not be displayed.\n", event_type(type
));
824 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
825 static int is_directory(const char *base_path
, const struct dirent
*dent
)
830 sprintf(path
, "%s/%s", base_path
, dent
->d_name
);
834 return S_ISDIR(st
.st_mode
);
837 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
838 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
840 if ((lang_dirent.d_type == DT_DIR || \
841 (lang_dirent.d_type == DT_UNKNOWN && \
842 is_directory(scripts_path, &lang_dirent))) && \
843 (strcmp(lang_dirent.d_name, ".")) && \
844 (strcmp(lang_dirent.d_name, "..")))
846 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
847 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
849 if (script_dirent.d_type != DT_DIR && \
850 (script_dirent.d_type != DT_UNKNOWN || \
851 !is_directory(lang_path, &script_dirent)))
854 #define RECORD_SUFFIX "-record"
855 #define REPORT_SUFFIX "-report"
858 struct list_head node
;
864 static LIST_HEAD(script_descs
);
866 static struct script_desc
*script_desc__new(const char *name
)
868 struct script_desc
*s
= zalloc(sizeof(*s
));
870 if (s
!= NULL
&& name
)
871 s
->name
= strdup(name
);
876 static void script_desc__delete(struct script_desc
*s
)
884 static void script_desc__add(struct script_desc
*s
)
886 list_add_tail(&s
->node
, &script_descs
);
889 static struct script_desc
*script_desc__find(const char *name
)
891 struct script_desc
*s
;
893 list_for_each_entry(s
, &script_descs
, node
)
894 if (strcasecmp(s
->name
, name
) == 0)
899 static struct script_desc
*script_desc__findnew(const char *name
)
901 struct script_desc
*s
= script_desc__find(name
);
906 s
= script_desc__new(name
);
908 goto out_delete_desc
;
915 script_desc__delete(s
);
920 static const char *ends_with(const char *str
, const char *suffix
)
922 size_t suffix_len
= strlen(suffix
);
925 if (strlen(str
) > suffix_len
) {
926 p
= str
+ strlen(str
) - suffix_len
;
927 if (!strncmp(p
, suffix
, suffix_len
))
934 static int read_script_info(struct script_desc
*desc
, const char *filename
)
936 char line
[BUFSIZ
], *p
;
939 fp
= fopen(filename
, "r");
943 while (fgets(line
, sizeof(line
), fp
)) {
950 if (strlen(p
) && *p
== '!')
954 if (strlen(p
) && p
[strlen(p
) - 1] == '\n')
955 p
[strlen(p
) - 1] = '\0';
957 if (!strncmp(p
, "description:", strlen("description:"))) {
958 p
+= strlen("description:");
959 desc
->half_liner
= strdup(ltrim(p
));
963 if (!strncmp(p
, "args:", strlen("args:"))) {
964 p
+= strlen("args:");
965 desc
->args
= strdup(ltrim(p
));
975 static char *get_script_root(struct dirent
*script_dirent
, const char *suffix
)
977 char *script_root
, *str
;
979 script_root
= strdup(script_dirent
->d_name
);
983 str
= (char *)ends_with(script_root
, suffix
);
993 static int list_available_scripts(const struct option
*opt __maybe_unused
,
994 const char *s __maybe_unused
,
995 int unset __maybe_unused
)
997 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
998 char scripts_path
[MAXPATHLEN
];
999 DIR *scripts_dir
, *lang_dir
;
1000 char script_path
[MAXPATHLEN
];
1001 char lang_path
[MAXPATHLEN
];
1002 struct script_desc
*desc
;
1003 char first_half
[BUFSIZ
];
1006 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1008 scripts_dir
= opendir(scripts_path
);
1012 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1013 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1014 lang_dirent
.d_name
);
1015 lang_dir
= opendir(lang_path
);
1019 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1020 script_root
= get_script_root(&script_dirent
, REPORT_SUFFIX
);
1022 desc
= script_desc__findnew(script_root
);
1023 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1024 lang_path
, script_dirent
.d_name
);
1025 read_script_info(desc
, script_path
);
1031 fprintf(stdout
, "List of available trace scripts:\n");
1032 list_for_each_entry(desc
, &script_descs
, node
) {
1033 sprintf(first_half
, "%s %s", desc
->name
,
1034 desc
->args
? desc
->args
: "");
1035 fprintf(stdout
, " %-36s %s\n", first_half
,
1036 desc
->half_liner
? desc
->half_liner
: "");
1043 * Some scripts specify the required events in their "xxx-record" file,
1044 * this function will check if the events in perf.data match those
1045 * mentioned in the "xxx-record".
1047 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1048 * which is covered well now. And new parsing code should be added to
1049 * cover the future complexing formats like event groups etc.
1051 static int check_ev_match(char *dir_name
, char *scriptname
,
1052 struct perf_session
*session
)
1054 char filename
[MAXPATHLEN
], evname
[128];
1055 char line
[BUFSIZ
], *p
;
1056 struct perf_evsel
*pos
;
1060 sprintf(filename
, "%s/bin/%s-record", dir_name
, scriptname
);
1062 fp
= fopen(filename
, "r");
1066 while (fgets(line
, sizeof(line
), fp
)) {
1072 p
= strstr(p
, "-e");
1078 len
= strcspn(p
, " \t");
1082 snprintf(evname
, len
+ 1, "%s", p
);
1085 list_for_each_entry(pos
,
1086 &session
->evlist
->entries
, node
) {
1087 if (!strcmp(perf_evsel__name(pos
), evname
)) {
1105 * Return -1 if none is found, otherwise the actual scripts number.
1107 * Currently the only user of this function is the script browser, which
1108 * will list all statically runnable scripts, select one, execute it and
1109 * show the output in a perf browser.
1111 int find_scripts(char **scripts_array
, char **scripts_path_array
)
1113 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1114 char scripts_path
[MAXPATHLEN
], lang_path
[MAXPATHLEN
];
1115 DIR *scripts_dir
, *lang_dir
;
1116 struct perf_session
*session
;
1120 session
= perf_session__new(input_name
, O_RDONLY
, 0, false, NULL
);
1124 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1126 scripts_dir
= opendir(scripts_path
);
1128 perf_session__delete(session
);
1132 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1133 snprintf(lang_path
, MAXPATHLEN
, "%s/%s", scripts_path
,
1134 lang_dirent
.d_name
);
1136 if (strstr(lang_path
, "perl"))
1140 if (strstr(lang_path
, "python"))
1144 lang_dir
= opendir(lang_path
);
1148 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1149 /* Skip those real time scripts: xxxtop.p[yl] */
1150 if (strstr(script_dirent
.d_name
, "top."))
1152 sprintf(scripts_path_array
[i
], "%s/%s", lang_path
,
1153 script_dirent
.d_name
);
1154 temp
= strchr(script_dirent
.d_name
, '.');
1155 snprintf(scripts_array
[i
],
1156 (temp
- script_dirent
.d_name
) + 1,
1157 "%s", script_dirent
.d_name
);
1159 if (check_ev_match(lang_path
,
1160 scripts_array
[i
], session
))
1168 closedir(scripts_dir
);
1169 perf_session__delete(session
);
1173 static char *get_script_path(const char *script_root
, const char *suffix
)
1175 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1176 char scripts_path
[MAXPATHLEN
];
1177 char script_path
[MAXPATHLEN
];
1178 DIR *scripts_dir
, *lang_dir
;
1179 char lang_path
[MAXPATHLEN
];
1180 char *__script_root
;
1182 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1184 scripts_dir
= opendir(scripts_path
);
1188 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1189 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1190 lang_dirent
.d_name
);
1191 lang_dir
= opendir(lang_path
);
1195 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1196 __script_root
= get_script_root(&script_dirent
, suffix
);
1197 if (__script_root
&& !strcmp(script_root
, __script_root
)) {
1198 free(__script_root
);
1200 closedir(scripts_dir
);
1201 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1202 lang_path
, script_dirent
.d_name
);
1203 return strdup(script_path
);
1205 free(__script_root
);
1209 closedir(scripts_dir
);
1214 static bool is_top_script(const char *script_path
)
1216 return ends_with(script_path
, "top") == NULL
? false : true;
1219 static int has_required_arg(char *script_path
)
1221 struct script_desc
*desc
;
1225 desc
= script_desc__new(NULL
);
1227 if (read_script_info(desc
, script_path
))
1233 for (p
= desc
->args
; *p
; p
++)
1237 script_desc__delete(desc
);
1242 static int have_cmd(int argc
, const char **argv
)
1244 char **__argv
= malloc(sizeof(const char *) * argc
);
1247 pr_err("malloc failed\n");
1251 memcpy(__argv
, argv
, sizeof(const char *) * argc
);
1252 argc
= parse_options(argc
, (const char **)__argv
, record_options
,
1253 NULL
, PARSE_OPT_STOP_AT_NON_OPTION
);
1256 system_wide
= (argc
== 0);
1261 int cmd_script(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1263 bool show_full_info
= false;
1264 char *rec_script_path
= NULL
;
1265 char *rep_script_path
= NULL
;
1266 struct perf_session
*session
;
1267 char *script_path
= NULL
;
1268 const char **__argv
;
1270 const struct option options
[] = {
1271 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
1272 "dump raw trace in ASCII"),
1273 OPT_INCR('v', "verbose", &verbose
,
1274 "be more verbose (show symbol address, etc)"),
1275 OPT_BOOLEAN('L', "Latency", &latency_format
,
1276 "show latency attributes (irqs/preemption disabled, etc)"),
1277 OPT_CALLBACK_NOOPT('l', "list", NULL
, NULL
, "list available scripts",
1278 list_available_scripts
),
1279 OPT_CALLBACK('s', "script", NULL
, "name",
1280 "script file name (lang:script name, script name, or *)",
1282 OPT_STRING('g', "gen-script", &generate_script_lang
, "lang",
1283 "generate perf-script.xx script in specified language"),
1284 OPT_STRING('i', "input", &input_name
, "file", "input file name"),
1285 OPT_BOOLEAN('d', "debug-mode", &debug_mode
,
1286 "do various checks like samples ordering and lost events"),
1287 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
1288 "file", "vmlinux pathname"),
1289 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
1290 "file", "kallsyms pathname"),
1291 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain
,
1292 "When printing symbols do not display call chain"),
1293 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
1294 "Look for files with symbols relative to this directory"),
1295 OPT_CALLBACK('f', "fields", NULL
, "str",
1296 "comma separated output fields prepend with 'type:'. "
1297 "Valid types: hw,sw,trace,raw. "
1298 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1299 "addr,symoff", parse_output_fields
),
1300 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
1301 "system-wide collection from all CPUs"),
1302 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
1303 "only consider these symbols"),
1304 OPT_STRING('C', "cpu", &cpu_list
, "cpu", "list of cpus to profile"),
1305 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
1306 "only display events for these comms"),
1307 OPT_BOOLEAN('I', "show-info", &show_full_info
,
1308 "display extended information from perf.data file"),
1309 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf
.show_kernel_path
,
1310 "Show the path of [kernel.kallsyms]"),
1313 const char * const script_usage
[] = {
1314 "perf script [<options>]",
1315 "perf script [<options>] record <script> [<record-options>] <command>",
1316 "perf script [<options>] report <script> [script-args]",
1317 "perf script [<options>] <script> [<record-options>] <command>",
1318 "perf script [<options>] <top-script> [script-args]",
1324 argc
= parse_options(argc
, argv
, options
, script_usage
,
1325 PARSE_OPT_STOP_AT_NON_OPTION
);
1327 if (argc
> 1 && !strncmp(argv
[0], "rec", strlen("rec"))) {
1328 rec_script_path
= get_script_path(argv
[1], RECORD_SUFFIX
);
1329 if (!rec_script_path
)
1330 return cmd_record(argc
, argv
, NULL
);
1333 if (argc
> 1 && !strncmp(argv
[0], "rep", strlen("rep"))) {
1334 rep_script_path
= get_script_path(argv
[1], REPORT_SUFFIX
);
1335 if (!rep_script_path
) {
1337 "Please specify a valid report script"
1338 "(see 'perf script -l' for listing)\n");
1343 /* make sure PERF_EXEC_PATH is set for scripts */
1344 perf_set_argv_exec_path(perf_exec_path());
1346 if (argc
&& !script_name
&& !rec_script_path
&& !rep_script_path
) {
1351 rec_script_path
= get_script_path(argv
[0], RECORD_SUFFIX
);
1352 rep_script_path
= get_script_path(argv
[0], REPORT_SUFFIX
);
1354 if (!rec_script_path
&& !rep_script_path
) {
1355 fprintf(stderr
, " Couldn't find script %s\n\n See perf"
1356 " script -l for available scripts.\n", argv
[0]);
1357 usage_with_options(script_usage
, options
);
1360 if (is_top_script(argv
[0])) {
1361 rep_args
= argc
- 1;
1365 rep_args
= has_required_arg(rep_script_path
);
1366 rec_args
= (argc
- 1) - rep_args
;
1368 fprintf(stderr
, " %s script requires options."
1369 "\n\n See perf script -l for available "
1370 "scripts and options.\n", argv
[0]);
1371 usage_with_options(script_usage
, options
);
1375 if (pipe(live_pipe
) < 0) {
1376 perror("failed to create pipe");
1382 perror("failed to fork");
1389 dup2(live_pipe
[1], 1);
1390 close(live_pipe
[0]);
1392 if (is_top_script(argv
[0])) {
1394 } else if (!system_wide
) {
1395 if (have_cmd(argc
- rep_args
, &argv
[rep_args
]) != 0) {
1401 __argv
= malloc((argc
+ 6) * sizeof(const char *));
1403 pr_err("malloc failed\n");
1408 __argv
[j
++] = "/bin/sh";
1409 __argv
[j
++] = rec_script_path
;
1415 for (i
= rep_args
+ 1; i
< argc
; i
++)
1416 __argv
[j
++] = argv
[i
];
1419 execvp("/bin/sh", (char **)__argv
);
1424 dup2(live_pipe
[0], 0);
1425 close(live_pipe
[1]);
1427 __argv
= malloc((argc
+ 4) * sizeof(const char *));
1429 pr_err("malloc failed\n");
1435 __argv
[j
++] = "/bin/sh";
1436 __argv
[j
++] = rep_script_path
;
1437 for (i
= 1; i
< rep_args
+ 1; i
++)
1438 __argv
[j
++] = argv
[i
];
1443 execvp("/bin/sh", (char **)__argv
);
1448 if (rec_script_path
)
1449 script_path
= rec_script_path
;
1450 if (rep_script_path
)
1451 script_path
= rep_script_path
;
1456 if (!rec_script_path
)
1457 system_wide
= false;
1458 else if (!system_wide
) {
1459 if (have_cmd(argc
- 1, &argv
[1]) != 0) {
1465 __argv
= malloc((argc
+ 2) * sizeof(const char *));
1467 pr_err("malloc failed\n");
1472 __argv
[j
++] = "/bin/sh";
1473 __argv
[j
++] = script_path
;
1476 for (i
= 2; i
< argc
; i
++)
1477 __argv
[j
++] = argv
[i
];
1480 execvp("/bin/sh", (char **)__argv
);
1485 if (symbol__init() < 0)
1490 session
= perf_session__new(input_name
, O_RDONLY
, 0, false,
1492 if (session
== NULL
)
1496 if (perf_session__cpu_bitmap(session
, cpu_list
, cpu_bitmap
))
1500 if (!script_name
&& !generate_script_lang
)
1501 perf_session__fprintf_info(session
, stdout
, show_full_info
);
1504 symbol_conf
.use_callchain
= true;
1506 symbol_conf
.use_callchain
= false;
1508 if (generate_script_lang
) {
1509 struct stat perf_stat
;
1512 if (output_set_by_user()) {
1514 "custom fields not supported for generated scripts");
1518 input
= open(session
->filename
, O_RDONLY
); /* input_name */
1520 perror("failed to open file");
1524 err
= fstat(input
, &perf_stat
);
1526 perror("failed to stat file");
1530 if (!perf_stat
.st_size
) {
1531 fprintf(stderr
, "zero-sized file, nothing to do!\n");
1535 scripting_ops
= script_spec__lookup(generate_script_lang
);
1536 if (!scripting_ops
) {
1537 fprintf(stderr
, "invalid language specifier");
1541 err
= scripting_ops
->generate_script(session
->pevent
,
1547 err
= scripting_ops
->start_script(script_name
, argc
, argv
);
1550 pr_debug("perf script started with script %s\n\n", script_name
);
1554 err
= perf_session__check_output_opt(session
);
1558 err
= __cmd_script(session
);
1560 perf_session__delete(session
);
1561 cleanup_scripting();