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",
233 * verify all user requested events exist and the samples
234 * have the expected data
236 static int perf_session__check_output_opt(struct perf_session *session)
239 struct perf_evsel *evsel;
240 struct perf_event_attr *attr;
242 for (j = 0; j < PERF_TYPE_MAX; ++j) {
243 evsel = perf_session__find_first_evtype(session, j);
246 * even if fields is set to 0 (ie., show nothing) event must
247 * exist if user explicitly includes it on the command line
249 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
250 pr_err("%s events do not exist. "
251 "Remove corresponding -f option to proceed.\n",
256 if (evsel && output[j].fields &&
257 perf_evsel__check_attr(evsel, session))
265 output[j].print_ip_opts = 0;
267 output[j].print_ip_opts |= PRINT_IP_OPT_IP;
269 if (PRINT_FIELD(SYM))
270 output[j].print_ip_opts |= PRINT_IP_OPT_SYM;
272 if (PRINT_FIELD(DSO))
273 output[j].print_ip_opts |= PRINT_IP_OPT_DSO;
275 if (PRINT_FIELD(SYMOFFSET))
276 output[j].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
282 static void print_sample_start(struct perf_sample *sample,
283 struct thread *thread,
284 struct perf_evsel *evsel)
286 struct perf_event_attr *attr = &evsel->attr;
287 const char *evname = NULL;
290 unsigned long long nsecs;
292 if (PRINT_FIELD(COMM)) {
294 printf("%8.8s ", thread->comm);
295 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
296 printf("%s ", thread->comm);
298 printf("%16s ", thread->comm);
301 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
302 printf("%5d/%-5d ", sample->pid, sample->tid);
303 else if (PRINT_FIELD(PID))
304 printf("%5d ", sample->pid);
305 else if (PRINT_FIELD(TID))
306 printf("%5d ", sample->tid);
308 if (PRINT_FIELD(CPU)) {
310 printf("%3d ", sample->cpu);
312 printf("[%03d] ", sample->cpu);
315 if (PRINT_FIELD(TIME)) {
316 nsecs = sample->time;
317 secs = nsecs / NSECS_PER_SEC;
318 nsecs -= secs * NSECS_PER_SEC;
319 usecs = nsecs / NSECS_PER_USEC;
320 printf("%5lu.%06lu: ", secs, usecs);
323 if (PRINT_FIELD(EVNAME)) {
324 evname = perf_evsel__name(evsel);
325 printf("%s: ", evname ? evname : "[unknown]");
329 static bool is_bts_event(struct perf_event_attr *attr)
331 return ((attr->type == PERF_TYPE_HARDWARE) &&
332 (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
333 (attr->sample_period == 1));
336 static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
338 if ((attr->type == PERF_TYPE_SOFTWARE) &&
339 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
340 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
341 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
344 if (is_bts_event(attr))
350 static void print_sample_addr(union perf_event *event,
351 struct perf_sample *sample,
352 struct machine *machine,
353 struct thread *thread,
354 struct perf_event_attr *attr)
356 struct addr_location al;
357 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
359 printf("%16" PRIx64, sample->addr);
361 if (!sample_addr_correlates_sym(attr))
364 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
367 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
370 al.cpu = sample->cpu;
374 al.sym = map__find_symbol(al.map, al.addr, NULL);
376 if (PRINT_FIELD(SYM)) {
378 if (PRINT_FIELD(SYMOFFSET))
379 symbol__fprintf_symname_offs(al.sym, &al, stdout);
381 symbol__fprintf_symname(al.sym, stdout);
384 if (PRINT_FIELD(DSO)) {
386 map__fprintf_dsoname(al.map, stdout);
391 static void print_sample_bts(union perf_event *event,
392 struct perf_sample *sample,
393 struct perf_evsel *evsel,
394 struct machine *machine,
395 struct thread *thread)
397 struct perf_event_attr *attr = &evsel->attr;
399 /* print branch_from information */
400 if (PRINT_FIELD(IP)) {
401 if (!symbol_conf.use_callchain)
405 perf_evsel__print_ip(evsel, event, sample, machine,
406 output[attr->type].print_ip_opts,
407 PERF_MAX_STACK_DEPTH);
412 /* print branch_to information */
413 if (PRINT_FIELD(ADDR) ||
414 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
415 !output[attr->type].user_set))
416 print_sample_addr(event, sample, machine, thread, attr);
421 static void process_event(union perf_event *event, struct perf_sample *sample,
422 struct perf_evsel *evsel, struct machine *machine,
423 struct thread *thread,
424 struct addr_location *al __maybe_unused)
426 struct perf_event_attr *attr = &evsel->attr;
428 if (output[attr->type].fields == 0)
431 print_sample_start(sample, thread, evsel);
433 if (is_bts_event(attr)) {
434 print_sample_bts(event, sample, evsel, machine, thread);
438 if (PRINT_FIELD(TRACE))
439 event_format__print(evsel->tp_format, sample->cpu,
440 sample->raw_data, sample->raw_size);
441 if (PRINT_FIELD(ADDR))
442 print_sample_addr(event, sample, machine, thread, attr);
444 if (PRINT_FIELD(IP)) {
445 if (!symbol_conf.use_callchain)
450 perf_evsel__print_ip(evsel, event, sample, machine,
451 output[attr->type].print_ip_opts,
452 PERF_MAX_STACK_DEPTH);
458 static int default_start_script(const char *script __maybe_unused,
459 int argc __maybe_unused,
460 const char **argv __maybe_unused)
465 static int default_stop_script(void)
470 static int default_generate_script(struct pevent *pevent __maybe_unused,
471 const char *outfile __maybe_unused)
476 static struct scripting_ops default_scripting_ops = {
477 .start_script = default_start_script,
478 .stop_script = default_stop_script,
479 .process_event = process_event,
480 .generate_script = default_generate_script,
483 static struct scripting_ops *scripting_ops;
485 static void setup_scripting(void)
487 setup_perl_scripting();
488 setup_python_scripting();
490 scripting_ops = &default_scripting_ops;
493 static int cleanup_scripting(void)
495 pr_debug("\nperf script stopped\n");
497 return scripting_ops->stop_script();
500 static int process_sample_event(struct perf_tool *tool __maybe_unused,
501 union perf_event *event,
502 struct perf_sample *sample,
503 struct perf_evsel *evsel,
504 struct machine *machine)
506 struct addr_location al;
507 struct thread *thread = machine__findnew_thread(machine, sample->pid,
510 if (thread == NULL) {
511 pr_debug("problem processing %d event, skipping it.\n",
517 if (sample->time < last_timestamp) {
518 pr_err("Samples misordered, previous: %" PRIu64
519 " this: %" PRIu64 "\n", last_timestamp,
523 last_timestamp = sample->time;
527 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
528 pr_err("problem processing %d event, skipping it.\n",
536 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
539 scripting_ops->process_event(event, sample, evsel, machine, thread, &al);
541 evsel->hists.stats.total_period += sample->period;
545 static struct perf_tool perf_script = {
546 .sample = process_sample_event,
547 .mmap = perf_event__process_mmap,
548 .mmap2 = perf_event__process_mmap2,
549 .comm = perf_event__process_comm,
550 .exit = perf_event__process_exit,
551 .fork = perf_event__process_fork,
552 .attr = perf_event__process_attr,
553 .tracing_data = perf_event__process_tracing_data,
554 .build_id = perf_event__process_build_id,
555 .ordered_samples = true,
556 .ordering_requires_timestamps = true,
559 static void sig_handler(int sig __maybe_unused)
564 static int __cmd_script(struct perf_session *session)
568 signal(SIGINT, sig_handler);
570 ret = perf_session__process_events(session, &perf_script);
573 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
579 struct list_head node;
580 struct scripting_ops *ops;
584 static LIST_HEAD(script_specs);
586 static struct script_spec *script_spec__new(const char *spec,
587 struct scripting_ops *ops)
589 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
592 strcpy(s->spec, spec);
599 static void script_spec__add(struct script_spec *s)
601 list_add_tail(&s->node, &script_specs);
604 static struct script_spec *script_spec__find(const char *spec)
606 struct script_spec *s;
608 list_for_each_entry(s, &script_specs, node)
609 if (strcasecmp(s->spec, spec) == 0)
614 static struct script_spec *script_spec__findnew(const char *spec,
615 struct scripting_ops *ops)
617 struct script_spec *s = script_spec__find(spec);
622 s = script_spec__new(spec, ops);
631 int script_spec_register(const char *spec, struct scripting_ops *ops)
633 struct script_spec *s;
635 s = script_spec__find(spec);
639 s = script_spec__findnew(spec, ops);
646 static struct scripting_ops *script_spec__lookup(const char *spec)
648 struct script_spec *s = script_spec__find(spec);
655 static void list_available_languages(void)
657 struct script_spec *s;
659 fprintf(stderr, "\n");
660 fprintf(stderr, "Scripting language extensions (used in "
661 "perf script -s [spec:]script.[spec]):\n\n");
663 list_for_each_entry(s, &script_specs, node)
664 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
666 fprintf(stderr, "\n");
669 static int parse_scriptname(const struct option *opt __maybe_unused,
670 const char *str, int unset __maybe_unused)
673 const char *script, *ext;
676 if (strcmp(str, "lang") == 0) {
677 list_available_languages();
681 script = strchr(str, ':');
684 if (len >= PATH_MAX) {
685 fprintf(stderr, "invalid language specifier");
688 strncpy(spec, str, len);
690 scripting_ops = script_spec__lookup(spec);
691 if (!scripting_ops) {
692 fprintf(stderr, "invalid language specifier");
698 ext = strrchr(script, '.');
700 fprintf(stderr, "invalid script extension");
703 scripting_ops = script_spec__lookup(++ext);
704 if (!scripting_ops) {
705 fprintf(stderr, "invalid script extension");
710 script_name = strdup(script);
715 static int parse_output_fields(const struct option *opt __maybe_unused,
716 const char *arg, int unset __maybe_unused)
719 int i, imax = ARRAY_SIZE(all_output_options);
722 char *str = strdup(arg);
728 /* first word can state for which event type the user is specifying
729 * the fields. If no type exists, the specified fields apply to all
730 * event types found in the file minus the invalid fields for a type.
732 tok = strchr(str, ':');
736 if (!strcmp(str, "hw"))
737 type = PERF_TYPE_HARDWARE;
738 else if (!strcmp(str, "sw"))
739 type = PERF_TYPE_SOFTWARE;
740 else if (!strcmp(str, "trace"))
741 type = PERF_TYPE_TRACEPOINT;
742 else if (!strcmp(str, "raw"))
743 type = PERF_TYPE_RAW;
745 fprintf(stderr, "Invalid event type in field string.\n");
750 if (output[type].user_set)
751 pr_warning("Overriding previous field request for %s events.\n",
754 output[type].fields = 0;
755 output[type].user_set = true;
756 output[type].wildcard_set = false;
760 if (strlen(str) == 0) {
762 "Cannot set fields to 'none' for all event types.\n");
767 if (output_set_by_user())
768 pr_warning("Overriding previous field request for all events.\n");
770 for (j = 0; j < PERF_TYPE_MAX; ++j) {
771 output[j].fields = 0;
772 output[j].user_set = true;
773 output[j].wildcard_set = true;
777 tok = strtok(tok, ",");
779 for (i = 0; i < imax; ++i) {
780 if (strcmp(tok, all_output_options[i].str) == 0)
784 fprintf(stderr, "Invalid field requested.\n");
790 /* add user option to all events types for
793 for (j = 0; j < PERF_TYPE_MAX; ++j) {
794 if (output[j].invalid_fields & all_output_options[i].field) {
795 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
796 all_output_options[i].str, event_type(j));
798 output[j].fields |= all_output_options[i].field;
801 if (output[type].invalid_fields & all_output_options[i].field) {
802 fprintf(stderr, "\'%s\' not valid for %s events.\n",
803 all_output_options[i].str, event_type(type));
808 output[type].fields |= all_output_options[i].field;
811 tok = strtok(NULL, ",");
815 if (output[type].fields == 0) {
816 pr_debug("No fields requested for %s type. "
817 "Events will not be displayed.\n", event_type(type));
826 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
827 static int is_directory(const char *base_path, const struct dirent *dent)
832 sprintf(path, "%s/%s", base_path, dent->d_name);
836 return S_ISDIR(st.st_mode);
839 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
840 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
842 if ((lang_dirent.d_type == DT_DIR || \
843 (lang_dirent.d_type == DT_UNKNOWN && \
844 is_directory(scripts_path, &lang_dirent))) && \
845 (strcmp(lang_dirent.d_name, ".")) && \
846 (strcmp(lang_dirent.d_name, "..")))
848 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
849 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
851 if (script_dirent.d_type != DT_DIR && \
852 (script_dirent.d_type != DT_UNKNOWN || \
853 !is_directory(lang_path, &script_dirent)))
856 #define RECORD_SUFFIX "-record"
857 #define REPORT_SUFFIX "-report"
860 struct list_head node;
866 static LIST_HEAD(script_descs);
868 static struct script_desc *script_desc__new(const char *name)
870 struct script_desc *s = zalloc(sizeof(*s));
872 if (s != NULL && name)
873 s->name = strdup(name);
878 static void script_desc__delete(struct script_desc *s)
886 static void script_desc__add(struct script_desc *s)
888 list_add_tail(&s->node, &script_descs);
891 static struct script_desc *script_desc__find(const char *name)
893 struct script_desc *s;
895 list_for_each_entry(s, &script_descs, node)
896 if (strcasecmp(s->name, name) == 0)
901 static struct script_desc *script_desc__findnew(const char *name)
903 struct script_desc *s = script_desc__find(name);
908 s = script_desc__new(name);
910 goto out_delete_desc;
917 script_desc__delete(s);
922 static const char *ends_with(const char *str, const char *suffix)
924 size_t suffix_len = strlen(suffix);
927 if (strlen(str) > suffix_len) {
928 p = str + strlen(str) - suffix_len;
929 if (!strncmp(p, suffix, suffix_len))
936 static int read_script_info(struct script_desc *desc, const char *filename)
938 char line[BUFSIZ], *p;
941 fp = fopen(filename, "r");
945 while (fgets(line, sizeof(line), fp)) {
952 if (strlen(p) && *p == '!')
956 if (strlen(p) && p[strlen(p) - 1] == '\n')
957 p[strlen(p) - 1] = '\0';
959 if (!strncmp(p, "description:", strlen("description:"))) {
960 p += strlen("description:");
961 desc->half_liner = strdup(ltrim(p));
965 if (!strncmp(p, "args:", strlen("args:"))) {
966 p += strlen("args:");
967 desc->args = strdup(ltrim(p));
977 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
979 char *script_root, *str;
981 script_root = strdup(script_dirent->d_name);
985 str = (char *)ends_with(script_root, suffix);
995 static int list_available_scripts(const struct option *opt __maybe_unused,
996 const char *s __maybe_unused,
997 int unset __maybe_unused)
999 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1000 char scripts_path[MAXPATHLEN];
1001 DIR *scripts_dir, *lang_dir;
1002 char script_path[MAXPATHLEN];
1003 char lang_path[MAXPATHLEN];
1004 struct script_desc *desc;
1005 char first_half[BUFSIZ];
1008 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1010 scripts_dir = opendir(scripts_path);
1014 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1015 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1016 lang_dirent.d_name);
1017 lang_dir = opendir(lang_path);
1021 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1022 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1024 desc = script_desc__findnew(script_root);
1025 snprintf(script_path, MAXPATHLEN, "%s/%s",
1026 lang_path, script_dirent.d_name);
1027 read_script_info(desc, script_path);
1033 fprintf(stdout, "List of available trace scripts:\n");
1034 list_for_each_entry(desc, &script_descs, node) {
1035 sprintf(first_half, "%s %s", desc->name,
1036 desc->args ? desc->args : "");
1037 fprintf(stdout, " %-36s %s\n", first_half,
1038 desc->half_liner ? desc->half_liner : "");
1045 * Some scripts specify the required events in their "xxx-record" file,
1046 * this function will check if the events in perf.data match those
1047 * mentioned in the "xxx-record".
1049 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1050 * which is covered well now. And new parsing code should be added to
1051 * cover the future complexing formats like event groups etc.
1053 static int check_ev_match(char *dir_name, char *scriptname,
1054 struct perf_session *session)
1056 char filename[MAXPATHLEN], evname[128];
1057 char line[BUFSIZ], *p;
1058 struct perf_evsel *pos;
1062 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1064 fp = fopen(filename, "r");
1068 while (fgets(line, sizeof(line), fp)) {
1074 p = strstr(p, "-e");
1080 len = strcspn(p, " \t");
1084 snprintf(evname, len + 1, "%s", p);
1087 list_for_each_entry(pos,
1088 &session->evlist->entries, node) {
1089 if (!strcmp(perf_evsel__name(pos), evname)) {
1107 * Return -1 if none is found, otherwise the actual scripts number.
1109 * Currently the only user of this function is the script browser, which
1110 * will list all statically runnable scripts, select one, execute it and
1111 * show the output in a perf browser.
1113 int find_scripts(char **scripts_array, char **scripts_path_array)
1115 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1116 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1117 DIR *scripts_dir, *lang_dir;
1118 struct perf_session *session;
1119 struct perf_data_file file = {
1121 .mode = PERF_DATA_MODE_READ,
1126 session = perf_session__new(&file, false, NULL);
1130 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1132 scripts_dir = opendir(scripts_path);
1134 perf_session__delete(session);
1138 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1139 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1140 lang_dirent.d_name);
1142 if (strstr(lang_path, "perl"))
1146 if (strstr(lang_path, "python"))
1150 lang_dir = opendir(lang_path);
1154 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1155 /* Skip those real time scripts: xxxtop.p[yl] */
1156 if (strstr(script_dirent.d_name, "top."))
1158 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1159 script_dirent.d_name);
1160 temp = strchr(script_dirent.d_name, '.');
1161 snprintf(scripts_array[i],
1162 (temp - script_dirent.d_name) + 1,
1163 "%s", script_dirent.d_name);
1165 if (check_ev_match(lang_path,
1166 scripts_array[i], session))
1174 closedir(scripts_dir);
1175 perf_session__delete(session);
1179 static char *get_script_path(const char *script_root, const char *suffix)
1181 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1182 char scripts_path[MAXPATHLEN];
1183 char script_path[MAXPATHLEN];
1184 DIR *scripts_dir, *lang_dir;
1185 char lang_path[MAXPATHLEN];
1186 char *__script_root;
1188 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1190 scripts_dir = opendir(scripts_path);
1194 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1195 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1196 lang_dirent.d_name);
1197 lang_dir = opendir(lang_path);
1201 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1202 __script_root = get_script_root(&script_dirent, suffix);
1203 if (__script_root && !strcmp(script_root, __script_root)) {
1204 free(__script_root);
1206 closedir(scripts_dir);
1207 snprintf(script_path, MAXPATHLEN, "%s/%s",
1208 lang_path, script_dirent.d_name);
1209 return strdup(script_path);
1211 free(__script_root);
1215 closedir(scripts_dir);
1220 static bool is_top_script(const char *script_path)
1222 return ends_with(script_path, "top") == NULL ? false : true;
1225 static int has_required_arg(char *script_path)
1227 struct script_desc *desc;
1231 desc = script_desc__new(NULL);
1233 if (read_script_info(desc, script_path))
1239 for (p = desc->args; *p; p++)
1243 script_desc__delete(desc);
1248 static int have_cmd(int argc, const char **argv)
1250 char **__argv = malloc(sizeof(const char *) * argc);
1253 pr_err("malloc failed\n");
1257 memcpy(__argv, argv, sizeof(const char *) * argc);
1258 argc = parse_options(argc, (const char **)__argv, record_options,
1259 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1262 system_wide = (argc == 0);
1267 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1269 bool show_full_info = false;
1270 char *rec_script_path = NULL;
1271 char *rep_script_path = NULL;
1272 struct perf_session *session;
1273 char *script_path = NULL;
1274 const char **__argv;
1276 const struct option options[] = {
1277 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1278 "dump raw trace in ASCII"),
1279 OPT_INCR('v', "verbose", &verbose,
1280 "be more verbose (show symbol address, etc)"),
1281 OPT_BOOLEAN('L', "Latency", &latency_format,
1282 "show latency attributes (irqs/preemption disabled, etc)"),
1283 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1284 list_available_scripts),
1285 OPT_CALLBACK('s', "script", NULL, "name",
1286 "script file name (lang:script name, script name, or *)",
1288 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1289 "generate perf-script.xx script in specified language"),
1290 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1291 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1292 "do various checks like samples ordering and lost events"),
1293 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1294 "file", "vmlinux pathname"),
1295 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1296 "file", "kallsyms pathname"),
1297 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1298 "When printing symbols do not display call chain"),
1299 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1300 "Look for files with symbols relative to this directory"),
1301 OPT_CALLBACK('f', "fields", NULL, "str",
1302 "comma separated output fields prepend with 'type:'. "
1303 "Valid types: hw,sw,trace,raw. "
1304 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1305 "addr,symoff", parse_output_fields),
1306 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1307 "system-wide collection from all CPUs"),
1308 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1309 "only consider these symbols"),
1310 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1311 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1312 "only display events for these comms"),
1313 OPT_BOOLEAN('I', "show-info", &show_full_info,
1314 "display extended information from perf.data file"),
1315 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1316 "Show the path of [kernel.kallsyms]"),
1319 const char * const script_usage[] = {
1320 "perf script [<options>]",
1321 "perf script [<options>] record <script> [<record-options>] <command>",
1322 "perf script [<options>] report <script> [script-args]",
1323 "perf script [<options>] <script> [<record-options>] <command>",
1324 "perf script [<options>] <top-script> [script-args]",
1327 struct perf_data_file file = {
1328 .mode = PERF_DATA_MODE_READ,
1333 argc = parse_options(argc, argv, options, script_usage,
1334 PARSE_OPT_STOP_AT_NON_OPTION);
1336 file.path = input_name;
1338 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1339 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1340 if (!rec_script_path)
1341 return cmd_record(argc, argv, NULL);
1344 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1345 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1346 if (!rep_script_path) {
1348 "Please specify a valid report script"
1349 "(see 'perf script -l' for listing)\n");
1354 /* make sure PERF_EXEC_PATH is set for scripts */
1355 perf_set_argv_exec_path(perf_exec_path());
1357 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1362 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1363 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1365 if (!rec_script_path && !rep_script_path) {
1366 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1367 " script -l for available scripts.\n", argv[0]);
1368 usage_with_options(script_usage, options);
1371 if (is_top_script(argv[0])) {
1372 rep_args = argc - 1;
1376 rep_args = has_required_arg(rep_script_path);
1377 rec_args = (argc - 1) - rep_args;
1379 fprintf(stderr, " %s script requires options."
1380 "\n\n See perf script -l for available "
1381 "scripts and options.\n", argv[0]);
1382 usage_with_options(script_usage, options);
1386 if (pipe(live_pipe) < 0) {
1387 perror("failed to create pipe");
1393 perror("failed to fork");
1400 dup2(live_pipe[1], 1);
1401 close(live_pipe[0]);
1403 if (is_top_script(argv[0])) {
1405 } else if (!system_wide) {
1406 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1412 __argv = malloc((argc + 6) * sizeof(const char *));
1414 pr_err("malloc failed\n");
1419 __argv[j++] = "/bin/sh";
1420 __argv[j++] = rec_script_path;
1426 for (i = rep_args + 1; i < argc; i++)
1427 __argv[j++] = argv[i];
1430 execvp("/bin/sh", (char **)__argv);
1435 dup2(live_pipe[0], 0);
1436 close(live_pipe[1]);
1438 __argv = malloc((argc + 4) * sizeof(const char *));
1440 pr_err("malloc failed\n");
1446 __argv[j++] = "/bin/sh";
1447 __argv[j++] = rep_script_path;
1448 for (i = 1; i < rep_args + 1; i++)
1449 __argv[j++] = argv[i];
1454 execvp("/bin/sh", (char **)__argv);
1459 if (rec_script_path)
1460 script_path = rec_script_path;
1461 if (rep_script_path)
1462 script_path = rep_script_path;
1467 if (!rec_script_path)
1468 system_wide = false;
1469 else if (!system_wide) {
1470 if (have_cmd(argc - 1, &argv[1]) != 0) {
1476 __argv = malloc((argc + 2) * sizeof(const char *));
1478 pr_err("malloc failed\n");
1483 __argv[j++] = "/bin/sh";
1484 __argv[j++] = script_path;
1487 for (i = 2; i < argc; i++)
1488 __argv[j++] = argv[i];
1491 execvp("/bin/sh", (char **)__argv);
1496 if (symbol__init() < 0)
1501 session = perf_session__new(&file, false, &perf_script);
1502 if (session == NULL)
1506 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1510 if (!script_name && !generate_script_lang)
1511 perf_session__fprintf_info(session, stdout, show_full_info);
1514 symbol_conf.use_callchain = true;
1516 symbol_conf.use_callchain = false;
1518 if (generate_script_lang) {
1519 struct stat perf_stat;
1522 if (output_set_by_user()) {
1524 "custom fields not supported for generated scripts");
1528 input = open(file.path, O_RDONLY); /* input_name */
1530 perror("failed to open file");
1534 err = fstat(input, &perf_stat);
1536 perror("failed to stat file");
1540 if (!perf_stat.st_size) {
1541 fprintf(stderr, "zero-sized file, nothing to do!\n");
1545 scripting_ops = script_spec__lookup(generate_script_lang);
1546 if (!scripting_ops) {
1547 fprintf(stderr, "invalid language specifier");
1551 err = scripting_ops->generate_script(session->pevent,
1557 err = scripting_ops->start_script(script_name, argc, argv);
1560 pr_debug("perf script started with script %s\n\n", script_name);
1564 err = perf_session__check_output_opt(session);
1568 err = __cmd_script(session);
1570 perf_session__delete(session);
1571 cleanup_scripting();