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 */
71 } output
[PERF_TYPE_MAX
] = {
73 [PERF_TYPE_HARDWARE
] = {
76 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
77 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
78 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
79 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
81 .invalid_fields
= PERF_OUTPUT_TRACE
,
84 [PERF_TYPE_SOFTWARE
] = {
87 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
88 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
89 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
90 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
92 .invalid_fields
= PERF_OUTPUT_TRACE
,
95 [PERF_TYPE_TRACEPOINT
] = {
98 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
99 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
100 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_TRACE
,
106 .fields
= PERF_OUTPUT_COMM
| PERF_OUTPUT_TID
|
107 PERF_OUTPUT_CPU
| PERF_OUTPUT_TIME
|
108 PERF_OUTPUT_EVNAME
| PERF_OUTPUT_IP
|
109 PERF_OUTPUT_SYM
| PERF_OUTPUT_DSO
,
111 .invalid_fields
= PERF_OUTPUT_TRACE
,
115 static bool output_set_by_user(void)
118 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
119 if (output
[j
].user_set
)
125 static const char *output_field2str(enum perf_output_field field
)
127 int i
, imax
= ARRAY_SIZE(all_output_options
);
128 const char *str
= "";
130 for (i
= 0; i
< imax
; ++i
) {
131 if (all_output_options
[i
].field
== field
) {
132 str
= all_output_options
[i
].str
;
139 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
141 static int perf_evsel__check_stype(struct perf_evsel
*evsel
,
142 u64 sample_type
, const char *sample_msg
,
143 enum perf_output_field field
)
145 struct perf_event_attr
*attr
= &evsel
->attr
;
146 int type
= attr
->type
;
149 if (attr
->sample_type
& sample_type
)
152 if (output
[type
].user_set
) {
153 evname
= perf_evsel__name(evsel
);
154 pr_err("Samples for '%s' event do not have %s attribute set. "
155 "Cannot print '%s' field.\n",
156 evname
, sample_msg
, output_field2str(field
));
160 /* user did not ask for it explicitly so remove from the default list */
161 output
[type
].fields
&= ~field
;
162 evname
= perf_evsel__name(evsel
);
163 pr_debug("Samples for '%s' event do not have %s attribute set. "
164 "Skipping '%s' field.\n",
165 evname
, sample_msg
, output_field2str(field
));
170 static int perf_evsel__check_attr(struct perf_evsel
*evsel
,
171 struct perf_session
*session
)
173 struct perf_event_attr
*attr
= &evsel
->attr
;
175 if (PRINT_FIELD(TRACE
) &&
176 !perf_session__has_traces(session
, "record -R"))
179 if (PRINT_FIELD(IP
)) {
180 if (perf_evsel__check_stype(evsel
, PERF_SAMPLE_IP
, "IP",
185 !(attr
->sample_type
& PERF_SAMPLE_CALLCHAIN
))
186 symbol_conf
.use_callchain
= false;
189 if (PRINT_FIELD(ADDR
) &&
190 perf_evsel__check_stype(evsel
, PERF_SAMPLE_ADDR
, "ADDR",
194 if (PRINT_FIELD(SYM
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
195 pr_err("Display of symbols requested but neither sample IP nor "
196 "sample address\nis selected. Hence, no addresses to convert "
200 if (PRINT_FIELD(SYMOFFSET
) && !PRINT_FIELD(SYM
)) {
201 pr_err("Display of offsets requested but symbol is not"
205 if (PRINT_FIELD(DSO
) && !PRINT_FIELD(IP
) && !PRINT_FIELD(ADDR
)) {
206 pr_err("Display of DSO requested but neither sample IP nor "
207 "sample address\nis selected. Hence, no addresses to convert "
212 if ((PRINT_FIELD(PID
) || PRINT_FIELD(TID
)) &&
213 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TID
, "TID",
214 PERF_OUTPUT_TID
|PERF_OUTPUT_PID
))
217 if (PRINT_FIELD(TIME
) &&
218 perf_evsel__check_stype(evsel
, PERF_SAMPLE_TIME
, "TIME",
222 if (PRINT_FIELD(CPU
) &&
223 perf_evsel__check_stype(evsel
, PERF_SAMPLE_CPU
, "CPU",
231 * verify all user requested events exist and the samples
232 * have the expected data
234 static int perf_session__check_output_opt(struct perf_session
*session
)
237 struct perf_evsel
*evsel
;
239 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
240 evsel
= perf_session__find_first_evtype(session
, j
);
243 * even if fields is set to 0 (ie., show nothing) event must
244 * exist if user explicitly includes it on the command line
246 if (!evsel
&& output
[j
].user_set
&& !output
[j
].wildcard_set
) {
247 pr_err("%s events do not exist. "
248 "Remove corresponding -f option to proceed.\n",
253 if (evsel
&& output
[j
].fields
&&
254 perf_evsel__check_attr(evsel
, session
))
261 static void print_sample_start(struct perf_sample
*sample
,
262 struct thread
*thread
,
263 struct perf_evsel
*evsel
)
265 struct perf_event_attr
*attr
= &evsel
->attr
;
266 const char *evname
= NULL
;
269 unsigned long long nsecs
;
271 if (PRINT_FIELD(COMM
)) {
273 printf("%8.8s ", thread
->comm
);
274 else if (PRINT_FIELD(IP
) && symbol_conf
.use_callchain
)
275 printf("%s ", thread
->comm
);
277 printf("%16s ", thread
->comm
);
280 if (PRINT_FIELD(PID
) && PRINT_FIELD(TID
))
281 printf("%5d/%-5d ", sample
->pid
, sample
->tid
);
282 else if (PRINT_FIELD(PID
))
283 printf("%5d ", sample
->pid
);
284 else if (PRINT_FIELD(TID
))
285 printf("%5d ", sample
->tid
);
287 if (PRINT_FIELD(CPU
)) {
289 printf("%3d ", sample
->cpu
);
291 printf("[%03d] ", sample
->cpu
);
294 if (PRINT_FIELD(TIME
)) {
295 nsecs
= sample
->time
;
296 secs
= nsecs
/ NSECS_PER_SEC
;
297 nsecs
-= secs
* NSECS_PER_SEC
;
298 usecs
= nsecs
/ NSECS_PER_USEC
;
299 printf("%5lu.%06lu: ", secs
, usecs
);
302 if (PRINT_FIELD(EVNAME
)) {
303 evname
= perf_evsel__name(evsel
);
304 printf("%s: ", evname
? evname
: "[unknown]");
308 static bool is_bts_event(struct perf_event_attr
*attr
)
310 return ((attr
->type
== PERF_TYPE_HARDWARE
) &&
311 (attr
->config
& PERF_COUNT_HW_BRANCH_INSTRUCTIONS
) &&
312 (attr
->sample_period
== 1));
315 static bool sample_addr_correlates_sym(struct perf_event_attr
*attr
)
317 if ((attr
->type
== PERF_TYPE_SOFTWARE
) &&
318 ((attr
->config
== PERF_COUNT_SW_PAGE_FAULTS
) ||
319 (attr
->config
== PERF_COUNT_SW_PAGE_FAULTS_MIN
) ||
320 (attr
->config
== PERF_COUNT_SW_PAGE_FAULTS_MAJ
)))
323 if (is_bts_event(attr
))
329 static void print_sample_addr(union perf_event
*event
,
330 struct perf_sample
*sample
,
331 struct machine
*machine
,
332 struct thread
*thread
,
333 struct perf_event_attr
*attr
)
335 struct addr_location al
;
336 u8 cpumode
= event
->header
.misc
& PERF_RECORD_MISC_CPUMODE_MASK
;
338 printf("%16" PRIx64
, sample
->addr
);
340 if (!sample_addr_correlates_sym(attr
))
343 thread__find_addr_map(thread
, machine
, cpumode
, MAP__FUNCTION
,
346 thread__find_addr_map(thread
, machine
, cpumode
, MAP__VARIABLE
,
349 al
.cpu
= sample
->cpu
;
353 al
.sym
= map__find_symbol(al
.map
, al
.addr
, NULL
);
355 if (PRINT_FIELD(SYM
)) {
357 if (PRINT_FIELD(SYMOFFSET
))
358 symbol__fprintf_symname_offs(al
.sym
, &al
, stdout
);
360 symbol__fprintf_symname(al
.sym
, stdout
);
363 if (PRINT_FIELD(DSO
)) {
365 map__fprintf_dsoname(al
.map
, stdout
);
370 static void print_sample_bts(union perf_event
*event
,
371 struct perf_sample
*sample
,
372 struct perf_evsel
*evsel
,
373 struct machine
*machine
,
374 struct thread
*thread
)
376 struct perf_event_attr
*attr
= &evsel
->attr
;
378 /* print branch_from information */
379 if (PRINT_FIELD(IP
)) {
380 if (!symbol_conf
.use_callchain
)
384 perf_evsel__print_ip(evsel
, event
, sample
, machine
,
385 PRINT_FIELD(SYM
), PRINT_FIELD(DSO
),
386 PRINT_FIELD(SYMOFFSET
));
391 /* print branch_to information */
392 if (PRINT_FIELD(ADDR
))
393 print_sample_addr(event
, sample
, machine
, thread
, attr
);
398 static void process_event(union perf_event
*event
, struct perf_sample
*sample
,
399 struct perf_evsel
*evsel
, struct machine
*machine
,
400 struct addr_location
*al
)
402 struct perf_event_attr
*attr
= &evsel
->attr
;
403 struct thread
*thread
= al
->thread
;
405 if (output
[attr
->type
].fields
== 0)
408 print_sample_start(sample
, thread
, evsel
);
410 if (is_bts_event(attr
)) {
411 print_sample_bts(event
, sample
, evsel
, machine
, thread
);
415 if (PRINT_FIELD(TRACE
))
416 event_format__print(evsel
->tp_format
, sample
->cpu
,
417 sample
->raw_data
, sample
->raw_size
);
418 if (PRINT_FIELD(ADDR
))
419 print_sample_addr(event
, sample
, machine
, thread
, attr
);
421 if (PRINT_FIELD(IP
)) {
422 if (!symbol_conf
.use_callchain
)
426 perf_evsel__print_ip(evsel
, event
, sample
, machine
,
427 PRINT_FIELD(SYM
), PRINT_FIELD(DSO
),
428 PRINT_FIELD(SYMOFFSET
));
434 static int default_start_script(const char *script __maybe_unused
,
435 int argc __maybe_unused
,
436 const char **argv __maybe_unused
)
441 static int default_stop_script(void)
446 static int default_generate_script(struct pevent
*pevent __maybe_unused
,
447 const char *outfile __maybe_unused
)
452 static struct scripting_ops default_scripting_ops
= {
453 .start_script
= default_start_script
,
454 .stop_script
= default_stop_script
,
455 .process_event
= process_event
,
456 .generate_script
= default_generate_script
,
459 static struct scripting_ops
*scripting_ops
;
461 static void setup_scripting(void)
463 setup_perl_scripting();
464 setup_python_scripting();
466 scripting_ops
= &default_scripting_ops
;
469 static int cleanup_scripting(void)
471 pr_debug("\nperf script stopped\n");
473 return scripting_ops
->stop_script();
476 static int process_sample_event(struct perf_tool
*tool __maybe_unused
,
477 union perf_event
*event
,
478 struct perf_sample
*sample
,
479 struct perf_evsel
*evsel
,
480 struct machine
*machine
)
482 struct addr_location al
;
483 struct thread
*thread
= machine__findnew_thread(machine
, event
->ip
.tid
);
485 if (thread
== NULL
) {
486 pr_debug("problem processing %d event, skipping it.\n",
492 if (sample
->time
< last_timestamp
) {
493 pr_err("Samples misordered, previous: %" PRIu64
494 " this: %" PRIu64
"\n", last_timestamp
,
498 last_timestamp
= sample
->time
;
502 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
, 0) < 0) {
503 pr_err("problem processing %d event, skipping it.\n",
511 if (cpu_list
&& !test_bit(sample
->cpu
, cpu_bitmap
))
514 scripting_ops
->process_event(event
, sample
, evsel
, machine
, &al
);
516 evsel
->hists
.stats
.total_period
+= sample
->period
;
520 static struct perf_tool perf_script
= {
521 .sample
= process_sample_event
,
522 .mmap
= perf_event__process_mmap
,
523 .comm
= perf_event__process_comm
,
524 .exit
= perf_event__process_exit
,
525 .fork
= perf_event__process_fork
,
526 .attr
= perf_event__process_attr
,
527 .tracing_data
= perf_event__process_tracing_data
,
528 .build_id
= perf_event__process_build_id
,
529 .ordered_samples
= true,
530 .ordering_requires_timestamps
= true,
533 extern volatile int session_done
;
535 static void sig_handler(int sig __maybe_unused
)
540 static int __cmd_script(struct perf_session
*session
)
544 signal(SIGINT
, sig_handler
);
546 ret
= perf_session__process_events(session
, &perf_script
);
549 pr_err("Misordered timestamps: %" PRIu64
"\n", nr_unordered
);
555 struct list_head node
;
556 struct scripting_ops
*ops
;
560 static LIST_HEAD(script_specs
);
562 static struct script_spec
*script_spec__new(const char *spec
,
563 struct scripting_ops
*ops
)
565 struct script_spec
*s
= malloc(sizeof(*s
) + strlen(spec
) + 1);
568 strcpy(s
->spec
, spec
);
575 static void script_spec__add(struct script_spec
*s
)
577 list_add_tail(&s
->node
, &script_specs
);
580 static struct script_spec
*script_spec__find(const char *spec
)
582 struct script_spec
*s
;
584 list_for_each_entry(s
, &script_specs
, node
)
585 if (strcasecmp(s
->spec
, spec
) == 0)
590 static struct script_spec
*script_spec__findnew(const char *spec
,
591 struct scripting_ops
*ops
)
593 struct script_spec
*s
= script_spec__find(spec
);
598 s
= script_spec__new(spec
, ops
);
607 int script_spec_register(const char *spec
, struct scripting_ops
*ops
)
609 struct script_spec
*s
;
611 s
= script_spec__find(spec
);
615 s
= script_spec__findnew(spec
, ops
);
622 static struct scripting_ops
*script_spec__lookup(const char *spec
)
624 struct script_spec
*s
= script_spec__find(spec
);
631 static void list_available_languages(void)
633 struct script_spec
*s
;
635 fprintf(stderr
, "\n");
636 fprintf(stderr
, "Scripting language extensions (used in "
637 "perf script -s [spec:]script.[spec]):\n\n");
639 list_for_each_entry(s
, &script_specs
, node
)
640 fprintf(stderr
, " %-42s [%s]\n", s
->spec
, s
->ops
->name
);
642 fprintf(stderr
, "\n");
645 static int parse_scriptname(const struct option
*opt __maybe_unused
,
646 const char *str
, int unset __maybe_unused
)
649 const char *script
, *ext
;
652 if (strcmp(str
, "lang") == 0) {
653 list_available_languages();
657 script
= strchr(str
, ':');
660 if (len
>= PATH_MAX
) {
661 fprintf(stderr
, "invalid language specifier");
664 strncpy(spec
, str
, len
);
666 scripting_ops
= script_spec__lookup(spec
);
667 if (!scripting_ops
) {
668 fprintf(stderr
, "invalid language specifier");
674 ext
= strrchr(script
, '.');
676 fprintf(stderr
, "invalid script extension");
679 scripting_ops
= script_spec__lookup(++ext
);
680 if (!scripting_ops
) {
681 fprintf(stderr
, "invalid script extension");
686 script_name
= strdup(script
);
691 static int parse_output_fields(const struct option
*opt __maybe_unused
,
692 const char *arg
, int unset __maybe_unused
)
695 int i
, imax
= ARRAY_SIZE(all_output_options
);
698 char *str
= strdup(arg
);
704 /* first word can state for which event type the user is specifying
705 * the fields. If no type exists, the specified fields apply to all
706 * event types found in the file minus the invalid fields for a type.
708 tok
= strchr(str
, ':');
712 if (!strcmp(str
, "hw"))
713 type
= PERF_TYPE_HARDWARE
;
714 else if (!strcmp(str
, "sw"))
715 type
= PERF_TYPE_SOFTWARE
;
716 else if (!strcmp(str
, "trace"))
717 type
= PERF_TYPE_TRACEPOINT
;
718 else if (!strcmp(str
, "raw"))
719 type
= PERF_TYPE_RAW
;
721 fprintf(stderr
, "Invalid event type in field string.\n");
726 if (output
[type
].user_set
)
727 pr_warning("Overriding previous field request for %s events.\n",
730 output
[type
].fields
= 0;
731 output
[type
].user_set
= true;
732 output
[type
].wildcard_set
= false;
736 if (strlen(str
) == 0) {
738 "Cannot set fields to 'none' for all event types.\n");
743 if (output_set_by_user())
744 pr_warning("Overriding previous field request for all events.\n");
746 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
747 output
[j
].fields
= 0;
748 output
[j
].user_set
= true;
749 output
[j
].wildcard_set
= true;
753 tok
= strtok(tok
, ",");
755 for (i
= 0; i
< imax
; ++i
) {
756 if (strcmp(tok
, all_output_options
[i
].str
) == 0)
760 fprintf(stderr
, "Invalid field requested.\n");
766 /* add user option to all events types for
769 for (j
= 0; j
< PERF_TYPE_MAX
; ++j
) {
770 if (output
[j
].invalid_fields
& all_output_options
[i
].field
) {
771 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
772 all_output_options
[i
].str
, event_type(j
));
774 output
[j
].fields
|= all_output_options
[i
].field
;
777 if (output
[type
].invalid_fields
& all_output_options
[i
].field
) {
778 fprintf(stderr
, "\'%s\' not valid for %s events.\n",
779 all_output_options
[i
].str
, event_type(type
));
784 output
[type
].fields
|= all_output_options
[i
].field
;
787 tok
= strtok(NULL
, ",");
791 if (output
[type
].fields
== 0) {
792 pr_debug("No fields requested for %s type. "
793 "Events will not be displayed.\n", event_type(type
));
802 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
803 static int is_directory(const char *base_path
, const struct dirent
*dent
)
808 sprintf(path
, "%s/%s", base_path
, dent
->d_name
);
812 return S_ISDIR(st
.st_mode
);
815 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
816 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
818 if ((lang_dirent.d_type == DT_DIR || \
819 (lang_dirent.d_type == DT_UNKNOWN && \
820 is_directory(scripts_path, &lang_dirent))) && \
821 (strcmp(lang_dirent.d_name, ".")) && \
822 (strcmp(lang_dirent.d_name, "..")))
824 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
825 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
827 if (script_dirent.d_type != DT_DIR && \
828 (script_dirent.d_type != DT_UNKNOWN || \
829 !is_directory(lang_path, &script_dirent)))
832 #define RECORD_SUFFIX "-record"
833 #define REPORT_SUFFIX "-report"
836 struct list_head node
;
842 static LIST_HEAD(script_descs
);
844 static struct script_desc
*script_desc__new(const char *name
)
846 struct script_desc
*s
= zalloc(sizeof(*s
));
848 if (s
!= NULL
&& name
)
849 s
->name
= strdup(name
);
854 static void script_desc__delete(struct script_desc
*s
)
862 static void script_desc__add(struct script_desc
*s
)
864 list_add_tail(&s
->node
, &script_descs
);
867 static struct script_desc
*script_desc__find(const char *name
)
869 struct script_desc
*s
;
871 list_for_each_entry(s
, &script_descs
, node
)
872 if (strcasecmp(s
->name
, name
) == 0)
877 static struct script_desc
*script_desc__findnew(const char *name
)
879 struct script_desc
*s
= script_desc__find(name
);
884 s
= script_desc__new(name
);
886 goto out_delete_desc
;
893 script_desc__delete(s
);
898 static const char *ends_with(const char *str
, const char *suffix
)
900 size_t suffix_len
= strlen(suffix
);
903 if (strlen(str
) > suffix_len
) {
904 p
= str
+ strlen(str
) - suffix_len
;
905 if (!strncmp(p
, suffix
, suffix_len
))
912 static int read_script_info(struct script_desc
*desc
, const char *filename
)
914 char line
[BUFSIZ
], *p
;
917 fp
= fopen(filename
, "r");
921 while (fgets(line
, sizeof(line
), fp
)) {
928 if (strlen(p
) && *p
== '!')
932 if (strlen(p
) && p
[strlen(p
) - 1] == '\n')
933 p
[strlen(p
) - 1] = '\0';
935 if (!strncmp(p
, "description:", strlen("description:"))) {
936 p
+= strlen("description:");
937 desc
->half_liner
= strdup(ltrim(p
));
941 if (!strncmp(p
, "args:", strlen("args:"))) {
942 p
+= strlen("args:");
943 desc
->args
= strdup(ltrim(p
));
953 static char *get_script_root(struct dirent
*script_dirent
, const char *suffix
)
955 char *script_root
, *str
;
957 script_root
= strdup(script_dirent
->d_name
);
961 str
= (char *)ends_with(script_root
, suffix
);
971 static int list_available_scripts(const struct option
*opt __maybe_unused
,
972 const char *s __maybe_unused
,
973 int unset __maybe_unused
)
975 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
976 char scripts_path
[MAXPATHLEN
];
977 DIR *scripts_dir
, *lang_dir
;
978 char script_path
[MAXPATHLEN
];
979 char lang_path
[MAXPATHLEN
];
980 struct script_desc
*desc
;
981 char first_half
[BUFSIZ
];
984 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
986 scripts_dir
= opendir(scripts_path
);
990 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
991 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
993 lang_dir
= opendir(lang_path
);
997 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
998 script_root
= get_script_root(&script_dirent
, REPORT_SUFFIX
);
1000 desc
= script_desc__findnew(script_root
);
1001 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1002 lang_path
, script_dirent
.d_name
);
1003 read_script_info(desc
, script_path
);
1009 fprintf(stdout
, "List of available trace scripts:\n");
1010 list_for_each_entry(desc
, &script_descs
, node
) {
1011 sprintf(first_half
, "%s %s", desc
->name
,
1012 desc
->args
? desc
->args
: "");
1013 fprintf(stdout
, " %-36s %s\n", first_half
,
1014 desc
->half_liner
? desc
->half_liner
: "");
1021 * Some scripts specify the required events in their "xxx-record" file,
1022 * this function will check if the events in perf.data match those
1023 * mentioned in the "xxx-record".
1025 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1026 * which is covered well now. And new parsing code should be added to
1027 * cover the future complexing formats like event groups etc.
1029 static int check_ev_match(char *dir_name
, char *scriptname
,
1030 struct perf_session
*session
)
1032 char filename
[MAXPATHLEN
], evname
[128];
1033 char line
[BUFSIZ
], *p
;
1034 struct perf_evsel
*pos
;
1038 sprintf(filename
, "%s/bin/%s-record", dir_name
, scriptname
);
1040 fp
= fopen(filename
, "r");
1044 while (fgets(line
, sizeof(line
), fp
)) {
1050 p
= strstr(p
, "-e");
1056 len
= strcspn(p
, " \t");
1060 snprintf(evname
, len
+ 1, "%s", p
);
1063 list_for_each_entry(pos
,
1064 &session
->evlist
->entries
, node
) {
1065 if (!strcmp(perf_evsel__name(pos
), evname
)) {
1083 * Return -1 if none is found, otherwise the actual scripts number.
1085 * Currently the only user of this function is the script browser, which
1086 * will list all statically runnable scripts, select one, execute it and
1087 * show the output in a perf browser.
1089 int find_scripts(char **scripts_array
, char **scripts_path_array
)
1091 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1092 char scripts_path
[MAXPATHLEN
], lang_path
[MAXPATHLEN
];
1093 DIR *scripts_dir
, *lang_dir
;
1094 struct perf_session
*session
;
1098 session
= perf_session__new(input_name
, O_RDONLY
, 0, false, NULL
);
1102 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1104 scripts_dir
= opendir(scripts_path
);
1106 perf_session__delete(session
);
1110 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1111 snprintf(lang_path
, MAXPATHLEN
, "%s/%s", scripts_path
,
1112 lang_dirent
.d_name
);
1114 if (strstr(lang_path
, "perl"))
1118 if (strstr(lang_path
, "python"))
1122 lang_dir
= opendir(lang_path
);
1126 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1127 /* Skip those real time scripts: xxxtop.p[yl] */
1128 if (strstr(script_dirent
.d_name
, "top."))
1130 sprintf(scripts_path_array
[i
], "%s/%s", lang_path
,
1131 script_dirent
.d_name
);
1132 temp
= strchr(script_dirent
.d_name
, '.');
1133 snprintf(scripts_array
[i
],
1134 (temp
- script_dirent
.d_name
) + 1,
1135 "%s", script_dirent
.d_name
);
1137 if (check_ev_match(lang_path
,
1138 scripts_array
[i
], session
))
1146 closedir(scripts_dir
);
1147 perf_session__delete(session
);
1151 static char *get_script_path(const char *script_root
, const char *suffix
)
1153 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
1154 char scripts_path
[MAXPATHLEN
];
1155 char script_path
[MAXPATHLEN
];
1156 DIR *scripts_dir
, *lang_dir
;
1157 char lang_path
[MAXPATHLEN
];
1158 char *__script_root
;
1160 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
1162 scripts_dir
= opendir(scripts_path
);
1166 for_each_lang(scripts_path
, scripts_dir
, lang_dirent
, lang_next
) {
1167 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
1168 lang_dirent
.d_name
);
1169 lang_dir
= opendir(lang_path
);
1173 for_each_script(lang_path
, lang_dir
, script_dirent
, script_next
) {
1174 __script_root
= get_script_root(&script_dirent
, suffix
);
1175 if (__script_root
&& !strcmp(script_root
, __script_root
)) {
1176 free(__script_root
);
1178 closedir(scripts_dir
);
1179 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
1180 lang_path
, script_dirent
.d_name
);
1181 return strdup(script_path
);
1183 free(__script_root
);
1187 closedir(scripts_dir
);
1192 static bool is_top_script(const char *script_path
)
1194 return ends_with(script_path
, "top") == NULL
? false : true;
1197 static int has_required_arg(char *script_path
)
1199 struct script_desc
*desc
;
1203 desc
= script_desc__new(NULL
);
1205 if (read_script_info(desc
, script_path
))
1211 for (p
= desc
->args
; *p
; p
++)
1215 script_desc__delete(desc
);
1220 static int have_cmd(int argc
, const char **argv
)
1222 char **__argv
= malloc(sizeof(const char *) * argc
);
1225 pr_err("malloc failed\n");
1229 memcpy(__argv
, argv
, sizeof(const char *) * argc
);
1230 argc
= parse_options(argc
, (const char **)__argv
, record_options
,
1231 NULL
, PARSE_OPT_STOP_AT_NON_OPTION
);
1234 system_wide
= (argc
== 0);
1239 int cmd_script(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1241 bool show_full_info
= false;
1242 char *rec_script_path
= NULL
;
1243 char *rep_script_path
= NULL
;
1244 struct perf_session
*session
;
1245 char *script_path
= NULL
;
1246 const char **__argv
;
1248 const struct option options
[] = {
1249 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
1250 "dump raw trace in ASCII"),
1251 OPT_INCR('v', "verbose", &verbose
,
1252 "be more verbose (show symbol address, etc)"),
1253 OPT_BOOLEAN('L', "Latency", &latency_format
,
1254 "show latency attributes (irqs/preemption disabled, etc)"),
1255 OPT_CALLBACK_NOOPT('l', "list", NULL
, NULL
, "list available scripts",
1256 list_available_scripts
),
1257 OPT_CALLBACK('s', "script", NULL
, "name",
1258 "script file name (lang:script name, script name, or *)",
1260 OPT_STRING('g', "gen-script", &generate_script_lang
, "lang",
1261 "generate perf-script.xx script in specified language"),
1262 OPT_STRING('i', "input", &input_name
, "file", "input file name"),
1263 OPT_BOOLEAN('d', "debug-mode", &debug_mode
,
1264 "do various checks like samples ordering and lost events"),
1265 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
1266 "file", "vmlinux pathname"),
1267 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
1268 "file", "kallsyms pathname"),
1269 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain
,
1270 "When printing symbols do not display call chain"),
1271 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
1272 "Look for files with symbols relative to this directory"),
1273 OPT_CALLBACK('f', "fields", NULL
, "str",
1274 "comma separated output fields prepend with 'type:'. "
1275 "Valid types: hw,sw,trace,raw. "
1276 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1277 "addr,symoff", parse_output_fields
),
1278 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
1279 "system-wide collection from all CPUs"),
1280 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
1281 "only consider these symbols"),
1282 OPT_STRING('C', "cpu", &cpu_list
, "cpu", "list of cpus to profile"),
1283 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
1284 "only display events for these comms"),
1285 OPT_BOOLEAN('I', "show-info", &show_full_info
,
1286 "display extended information from perf.data file"),
1287 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf
.show_kernel_path
,
1288 "Show the path of [kernel.kallsyms]"),
1291 const char * const script_usage
[] = {
1292 "perf script [<options>]",
1293 "perf script [<options>] record <script> [<record-options>] <command>",
1294 "perf script [<options>] report <script> [script-args]",
1295 "perf script [<options>] <script> [<record-options>] <command>",
1296 "perf script [<options>] <top-script> [script-args]",
1302 argc
= parse_options(argc
, argv
, options
, script_usage
,
1303 PARSE_OPT_STOP_AT_NON_OPTION
);
1305 if (argc
> 1 && !strncmp(argv
[0], "rec", strlen("rec"))) {
1306 rec_script_path
= get_script_path(argv
[1], RECORD_SUFFIX
);
1307 if (!rec_script_path
)
1308 return cmd_record(argc
, argv
, NULL
);
1311 if (argc
> 1 && !strncmp(argv
[0], "rep", strlen("rep"))) {
1312 rep_script_path
= get_script_path(argv
[1], REPORT_SUFFIX
);
1313 if (!rep_script_path
) {
1315 "Please specify a valid report script"
1316 "(see 'perf script -l' for listing)\n");
1321 /* make sure PERF_EXEC_PATH is set for scripts */
1322 perf_set_argv_exec_path(perf_exec_path());
1324 if (argc
&& !script_name
&& !rec_script_path
&& !rep_script_path
) {
1329 rec_script_path
= get_script_path(argv
[0], RECORD_SUFFIX
);
1330 rep_script_path
= get_script_path(argv
[0], REPORT_SUFFIX
);
1332 if (!rec_script_path
&& !rep_script_path
) {
1333 fprintf(stderr
, " Couldn't find script %s\n\n See perf"
1334 " script -l for available scripts.\n", argv
[0]);
1335 usage_with_options(script_usage
, options
);
1338 if (is_top_script(argv
[0])) {
1339 rep_args
= argc
- 1;
1343 rep_args
= has_required_arg(rep_script_path
);
1344 rec_args
= (argc
- 1) - rep_args
;
1346 fprintf(stderr
, " %s script requires options."
1347 "\n\n See perf script -l for available "
1348 "scripts and options.\n", argv
[0]);
1349 usage_with_options(script_usage
, options
);
1353 if (pipe(live_pipe
) < 0) {
1354 perror("failed to create pipe");
1360 perror("failed to fork");
1367 dup2(live_pipe
[1], 1);
1368 close(live_pipe
[0]);
1370 if (is_top_script(argv
[0])) {
1372 } else if (!system_wide
) {
1373 if (have_cmd(argc
- rep_args
, &argv
[rep_args
]) != 0) {
1379 __argv
= malloc((argc
+ 6) * sizeof(const char *));
1381 pr_err("malloc failed\n");
1386 __argv
[j
++] = "/bin/sh";
1387 __argv
[j
++] = rec_script_path
;
1393 for (i
= rep_args
+ 1; i
< argc
; i
++)
1394 __argv
[j
++] = argv
[i
];
1397 execvp("/bin/sh", (char **)__argv
);
1402 dup2(live_pipe
[0], 0);
1403 close(live_pipe
[1]);
1405 __argv
= malloc((argc
+ 4) * sizeof(const char *));
1407 pr_err("malloc failed\n");
1413 __argv
[j
++] = "/bin/sh";
1414 __argv
[j
++] = rep_script_path
;
1415 for (i
= 1; i
< rep_args
+ 1; i
++)
1416 __argv
[j
++] = argv
[i
];
1421 execvp("/bin/sh", (char **)__argv
);
1426 if (rec_script_path
)
1427 script_path
= rec_script_path
;
1428 if (rep_script_path
)
1429 script_path
= rep_script_path
;
1434 if (!rec_script_path
)
1435 system_wide
= false;
1436 else if (!system_wide
) {
1437 if (have_cmd(argc
- 1, &argv
[1]) != 0) {
1443 __argv
= malloc((argc
+ 2) * sizeof(const char *));
1445 pr_err("malloc failed\n");
1450 __argv
[j
++] = "/bin/sh";
1451 __argv
[j
++] = script_path
;
1454 for (i
= 2; i
< argc
; i
++)
1455 __argv
[j
++] = argv
[i
];
1458 execvp("/bin/sh", (char **)__argv
);
1463 if (symbol__init() < 0)
1468 session
= perf_session__new(input_name
, O_RDONLY
, 0, false,
1470 if (session
== NULL
)
1474 if (perf_session__cpu_bitmap(session
, cpu_list
, cpu_bitmap
))
1478 if (!script_name
&& !generate_script_lang
)
1479 perf_session__fprintf_info(session
, stdout
, show_full_info
);
1482 symbol_conf
.use_callchain
= true;
1484 symbol_conf
.use_callchain
= false;
1486 if (generate_script_lang
) {
1487 struct stat perf_stat
;
1490 if (output_set_by_user()) {
1492 "custom fields not supported for generated scripts");
1496 input
= open(session
->filename
, O_RDONLY
); /* input_name */
1498 perror("failed to open file");
1502 err
= fstat(input
, &perf_stat
);
1504 perror("failed to stat file");
1508 if (!perf_stat
.st_size
) {
1509 fprintf(stderr
, "zero-sized file, nothing to do!\n");
1513 scripting_ops
= script_spec__lookup(generate_script_lang
);
1514 if (!scripting_ops
) {
1515 fprintf(stderr
, "invalid language specifier");
1519 err
= scripting_ops
->generate_script(session
->pevent
,
1525 err
= scripting_ops
->start_script(script_name
, argc
, argv
);
1528 pr_debug("perf script started with script %s\n\n", script_name
);
1532 err
= perf_session__check_output_opt(session
);
1536 err
= __cmd_script(session
);
1538 perf_session__delete(session
);
1539 cleanup_scripting();