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 .event_type = perf_event__process_event_type,
528 .tracing_data = perf_event__process_tracing_data,
529 .build_id = perf_event__process_build_id,
530 .ordered_samples = true,
531 .ordering_requires_timestamps = true,
534 extern volatile int session_done;
536 static void sig_handler(int sig __maybe_unused)
541 static int __cmd_script(struct perf_session *session)
545 signal(SIGINT, sig_handler);
547 ret = perf_session__process_events(session, &perf_script);
550 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
556 struct list_head node;
557 struct scripting_ops *ops;
561 static LIST_HEAD(script_specs);
563 static struct script_spec *script_spec__new(const char *spec,
564 struct scripting_ops *ops)
566 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
569 strcpy(s->spec, spec);
576 static void script_spec__add(struct script_spec *s)
578 list_add_tail(&s->node, &script_specs);
581 static struct script_spec *script_spec__find(const char *spec)
583 struct script_spec *s;
585 list_for_each_entry(s, &script_specs, node)
586 if (strcasecmp(s->spec, spec) == 0)
591 static struct script_spec *script_spec__findnew(const char *spec,
592 struct scripting_ops *ops)
594 struct script_spec *s = script_spec__find(spec);
599 s = script_spec__new(spec, ops);
608 int script_spec_register(const char *spec, struct scripting_ops *ops)
610 struct script_spec *s;
612 s = script_spec__find(spec);
616 s = script_spec__findnew(spec, ops);
623 static struct scripting_ops *script_spec__lookup(const char *spec)
625 struct script_spec *s = script_spec__find(spec);
632 static void list_available_languages(void)
634 struct script_spec *s;
636 fprintf(stderr, "\n");
637 fprintf(stderr, "Scripting language extensions (used in "
638 "perf script -s [spec:]script.[spec]):\n\n");
640 list_for_each_entry(s, &script_specs, node)
641 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
643 fprintf(stderr, "\n");
646 static int parse_scriptname(const struct option *opt __maybe_unused,
647 const char *str, int unset __maybe_unused)
650 const char *script, *ext;
653 if (strcmp(str, "lang") == 0) {
654 list_available_languages();
658 script = strchr(str, ':');
661 if (len >= PATH_MAX) {
662 fprintf(stderr, "invalid language specifier");
665 strncpy(spec, str, len);
667 scripting_ops = script_spec__lookup(spec);
668 if (!scripting_ops) {
669 fprintf(stderr, "invalid language specifier");
675 ext = strrchr(script, '.');
677 fprintf(stderr, "invalid script extension");
680 scripting_ops = script_spec__lookup(++ext);
681 if (!scripting_ops) {
682 fprintf(stderr, "invalid script extension");
687 script_name = strdup(script);
692 static int parse_output_fields(const struct option *opt __maybe_unused,
693 const char *arg, int unset __maybe_unused)
696 int i, imax = ARRAY_SIZE(all_output_options);
699 char *str = strdup(arg);
705 /* first word can state for which event type the user is specifying
706 * the fields. If no type exists, the specified fields apply to all
707 * event types found in the file minus the invalid fields for a type.
709 tok = strchr(str, ':');
713 if (!strcmp(str, "hw"))
714 type = PERF_TYPE_HARDWARE;
715 else if (!strcmp(str, "sw"))
716 type = PERF_TYPE_SOFTWARE;
717 else if (!strcmp(str, "trace"))
718 type = PERF_TYPE_TRACEPOINT;
719 else if (!strcmp(str, "raw"))
720 type = PERF_TYPE_RAW;
722 fprintf(stderr, "Invalid event type in field string.\n");
727 if (output[type].user_set)
728 pr_warning("Overriding previous field request for %s events.\n",
731 output[type].fields = 0;
732 output[type].user_set = true;
733 output[type].wildcard_set = false;
737 if (strlen(str) == 0) {
739 "Cannot set fields to 'none' for all event types.\n");
744 if (output_set_by_user())
745 pr_warning("Overriding previous field request for all events.\n");
747 for (j = 0; j < PERF_TYPE_MAX; ++j) {
748 output[j].fields = 0;
749 output[j].user_set = true;
750 output[j].wildcard_set = true;
754 tok = strtok(tok, ",");
756 for (i = 0; i < imax; ++i) {
757 if (strcmp(tok, all_output_options[i].str) == 0)
761 fprintf(stderr, "Invalid field requested.\n");
767 /* add user option to all events types for
770 for (j = 0; j < PERF_TYPE_MAX; ++j) {
771 if (output[j].invalid_fields & all_output_options[i].field) {
772 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
773 all_output_options[i].str, event_type(j));
775 output[j].fields |= all_output_options[i].field;
778 if (output[type].invalid_fields & all_output_options[i].field) {
779 fprintf(stderr, "\'%s\' not valid for %s events.\n",
780 all_output_options[i].str, event_type(type));
785 output[type].fields |= all_output_options[i].field;
788 tok = strtok(NULL, ",");
792 if (output[type].fields == 0) {
793 pr_debug("No fields requested for %s type. "
794 "Events will not be displayed.\n", event_type(type));
803 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
804 static int is_directory(const char *base_path, const struct dirent *dent)
809 sprintf(path, "%s/%s", base_path, dent->d_name);
813 return S_ISDIR(st.st_mode);
816 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
817 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
819 if ((lang_dirent.d_type == DT_DIR || \
820 (lang_dirent.d_type == DT_UNKNOWN && \
821 is_directory(scripts_path, &lang_dirent))) && \
822 (strcmp(lang_dirent.d_name, ".")) && \
823 (strcmp(lang_dirent.d_name, "..")))
825 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
826 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
828 if (script_dirent.d_type != DT_DIR && \
829 (script_dirent.d_type != DT_UNKNOWN || \
830 !is_directory(lang_path, &script_dirent)))
833 #define RECORD_SUFFIX "-record"
834 #define REPORT_SUFFIX "-report"
837 struct list_head node;
843 static LIST_HEAD(script_descs);
845 static struct script_desc *script_desc__new(const char *name)
847 struct script_desc *s = zalloc(sizeof(*s));
849 if (s != NULL && name)
850 s->name = strdup(name);
855 static void script_desc__delete(struct script_desc *s)
863 static void script_desc__add(struct script_desc *s)
865 list_add_tail(&s->node, &script_descs);
868 static struct script_desc *script_desc__find(const char *name)
870 struct script_desc *s;
872 list_for_each_entry(s, &script_descs, node)
873 if (strcasecmp(s->name, name) == 0)
878 static struct script_desc *script_desc__findnew(const char *name)
880 struct script_desc *s = script_desc__find(name);
885 s = script_desc__new(name);
887 goto out_delete_desc;
894 script_desc__delete(s);
899 static const char *ends_with(const char *str, const char *suffix)
901 size_t suffix_len = strlen(suffix);
904 if (strlen(str) > suffix_len) {
905 p = str + strlen(str) - suffix_len;
906 if (!strncmp(p, suffix, suffix_len))
913 static int read_script_info(struct script_desc *desc, const char *filename)
915 char line[BUFSIZ], *p;
918 fp = fopen(filename, "r");
922 while (fgets(line, sizeof(line), fp)) {
929 if (strlen(p) && *p == '!')
933 if (strlen(p) && p[strlen(p) - 1] == '\n')
934 p[strlen(p) - 1] = '\0';
936 if (!strncmp(p, "description:", strlen("description:"))) {
937 p += strlen("description:");
938 desc->half_liner = strdup(ltrim(p));
942 if (!strncmp(p, "args:", strlen("args:"))) {
943 p += strlen("args:");
944 desc->args = strdup(ltrim(p));
954 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
956 char *script_root, *str;
958 script_root = strdup(script_dirent->d_name);
962 str = (char *)ends_with(script_root, suffix);
972 static int list_available_scripts(const struct option *opt __maybe_unused,
973 const char *s __maybe_unused,
974 int unset __maybe_unused)
976 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
977 char scripts_path[MAXPATHLEN];
978 DIR *scripts_dir, *lang_dir;
979 char script_path[MAXPATHLEN];
980 char lang_path[MAXPATHLEN];
981 struct script_desc *desc;
982 char first_half[BUFSIZ];
985 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
987 scripts_dir = opendir(scripts_path);
991 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
992 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
994 lang_dir = opendir(lang_path);
998 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
999 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1001 desc = script_desc__findnew(script_root);
1002 snprintf(script_path, MAXPATHLEN, "%s/%s",
1003 lang_path, script_dirent.d_name);
1004 read_script_info(desc, script_path);
1010 fprintf(stdout, "List of available trace scripts:\n");
1011 list_for_each_entry(desc, &script_descs, node) {
1012 sprintf(first_half, "%s %s", desc->name,
1013 desc->args ? desc->args : "");
1014 fprintf(stdout, " %-36s %s\n", first_half,
1015 desc->half_liner ? desc->half_liner : "");
1022 * Some scripts specify the required events in their "xxx-record" file,
1023 * this function will check if the events in perf.data match those
1024 * mentioned in the "xxx-record".
1026 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1027 * which is covered well now. And new parsing code should be added to
1028 * cover the future complexing formats like event groups etc.
1030 static int check_ev_match(char *dir_name, char *scriptname,
1031 struct perf_session *session)
1033 char filename[MAXPATHLEN], evname[128];
1034 char line[BUFSIZ], *p;
1035 struct perf_evsel *pos;
1039 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1041 fp = fopen(filename, "r");
1045 while (fgets(line, sizeof(line), fp)) {
1051 p = strstr(p, "-e");
1057 len = strcspn(p, " \t");
1061 snprintf(evname, len + 1, "%s", p);
1064 list_for_each_entry(pos,
1065 &session->evlist->entries, node) {
1066 if (!strcmp(perf_evsel__name(pos), evname)) {
1084 * Return -1 if none is found, otherwise the actual scripts number.
1086 * Currently the only user of this function is the script browser, which
1087 * will list all statically runnable scripts, select one, execute it and
1088 * show the output in a perf browser.
1090 int find_scripts(char **scripts_array, char **scripts_path_array)
1092 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1093 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1094 DIR *scripts_dir, *lang_dir;
1095 struct perf_session *session;
1099 session = perf_session__new(input_name, O_RDONLY, 0, false, NULL);
1103 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1105 scripts_dir = opendir(scripts_path);
1107 perf_session__delete(session);
1111 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1112 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1113 lang_dirent.d_name);
1115 if (strstr(lang_path, "perl"))
1119 if (strstr(lang_path, "python"))
1123 lang_dir = opendir(lang_path);
1127 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1128 /* Skip those real time scripts: xxxtop.p[yl] */
1129 if (strstr(script_dirent.d_name, "top."))
1131 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1132 script_dirent.d_name);
1133 temp = strchr(script_dirent.d_name, '.');
1134 snprintf(scripts_array[i],
1135 (temp - script_dirent.d_name) + 1,
1136 "%s", script_dirent.d_name);
1138 if (check_ev_match(lang_path,
1139 scripts_array[i], session))
1147 closedir(scripts_dir);
1148 perf_session__delete(session);
1152 static char *get_script_path(const char *script_root, const char *suffix)
1154 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1155 char scripts_path[MAXPATHLEN];
1156 char script_path[MAXPATHLEN];
1157 DIR *scripts_dir, *lang_dir;
1158 char lang_path[MAXPATHLEN];
1159 char *__script_root;
1161 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1163 scripts_dir = opendir(scripts_path);
1167 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1168 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1169 lang_dirent.d_name);
1170 lang_dir = opendir(lang_path);
1174 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1175 __script_root = get_script_root(&script_dirent, suffix);
1176 if (__script_root && !strcmp(script_root, __script_root)) {
1177 free(__script_root);
1179 closedir(scripts_dir);
1180 snprintf(script_path, MAXPATHLEN, "%s/%s",
1181 lang_path, script_dirent.d_name);
1182 return strdup(script_path);
1184 free(__script_root);
1188 closedir(scripts_dir);
1193 static bool is_top_script(const char *script_path)
1195 return ends_with(script_path, "top") == NULL ? false : true;
1198 static int has_required_arg(char *script_path)
1200 struct script_desc *desc;
1204 desc = script_desc__new(NULL);
1206 if (read_script_info(desc, script_path))
1212 for (p = desc->args; *p; p++)
1216 script_desc__delete(desc);
1221 static int have_cmd(int argc, const char **argv)
1223 char **__argv = malloc(sizeof(const char *) * argc);
1226 pr_err("malloc failed\n");
1230 memcpy(__argv, argv, sizeof(const char *) * argc);
1231 argc = parse_options(argc, (const char **)__argv, record_options,
1232 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1235 system_wide = (argc == 0);
1240 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1242 bool show_full_info = false;
1243 char *rec_script_path = NULL;
1244 char *rep_script_path = NULL;
1245 struct perf_session *session;
1246 char *script_path = NULL;
1247 const char **__argv;
1249 const struct option options[] = {
1250 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1251 "dump raw trace in ASCII"),
1252 OPT_INCR('v', "verbose", &verbose,
1253 "be more verbose (show symbol address, etc)"),
1254 OPT_BOOLEAN('L', "Latency", &latency_format,
1255 "show latency attributes (irqs/preemption disabled, etc)"),
1256 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1257 list_available_scripts),
1258 OPT_CALLBACK('s', "script", NULL, "name",
1259 "script file name (lang:script name, script name, or *)",
1261 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1262 "generate perf-script.xx script in specified language"),
1263 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1264 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1265 "do various checks like samples ordering and lost events"),
1266 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1267 "file", "vmlinux pathname"),
1268 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1269 "file", "kallsyms pathname"),
1270 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1271 "When printing symbols do not display call chain"),
1272 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1273 "Look for files with symbols relative to this directory"),
1274 OPT_CALLBACK('f', "fields", NULL, "str",
1275 "comma separated output fields prepend with 'type:'. "
1276 "Valid types: hw,sw,trace,raw. "
1277 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1278 "addr,symoff", parse_output_fields),
1279 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1280 "system-wide collection from all CPUs"),
1281 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1282 "only consider these symbols"),
1283 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1284 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1285 "only display events for these comms"),
1286 OPT_BOOLEAN('I', "show-info", &show_full_info,
1287 "display extended information from perf.data file"),
1288 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1289 "Show the path of [kernel.kallsyms]"),
1292 const char * const script_usage[] = {
1293 "perf script [<options>]",
1294 "perf script [<options>] record <script> [<record-options>] <command>",
1295 "perf script [<options>] report <script> [script-args]",
1296 "perf script [<options>] <script> [<record-options>] <command>",
1297 "perf script [<options>] <top-script> [script-args]",
1303 argc = parse_options(argc, argv, options, script_usage,
1304 PARSE_OPT_STOP_AT_NON_OPTION);
1306 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1307 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1308 if (!rec_script_path)
1309 return cmd_record(argc, argv, NULL);
1312 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1313 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1314 if (!rep_script_path) {
1316 "Please specify a valid report script"
1317 "(see 'perf script -l' for listing)\n");
1322 /* make sure PERF_EXEC_PATH is set for scripts */
1323 perf_set_argv_exec_path(perf_exec_path());
1325 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1330 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1331 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1333 if (!rec_script_path && !rep_script_path) {
1334 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1335 " script -l for available scripts.\n", argv[0]);
1336 usage_with_options(script_usage, options);
1339 if (is_top_script(argv[0])) {
1340 rep_args = argc - 1;
1344 rep_args = has_required_arg(rep_script_path);
1345 rec_args = (argc - 1) - rep_args;
1347 fprintf(stderr, " %s script requires options."
1348 "\n\n See perf script -l for available "
1349 "scripts and options.\n", argv[0]);
1350 usage_with_options(script_usage, options);
1354 if (pipe(live_pipe) < 0) {
1355 perror("failed to create pipe");
1361 perror("failed to fork");
1368 dup2(live_pipe[1], 1);
1369 close(live_pipe[0]);
1371 if (is_top_script(argv[0])) {
1373 } else if (!system_wide) {
1374 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1380 __argv = malloc((argc + 6) * sizeof(const char *));
1382 pr_err("malloc failed\n");
1387 __argv[j++] = "/bin/sh";
1388 __argv[j++] = rec_script_path;
1394 for (i = rep_args + 1; i < argc; i++)
1395 __argv[j++] = argv[i];
1398 execvp("/bin/sh", (char **)__argv);
1403 dup2(live_pipe[0], 0);
1404 close(live_pipe[1]);
1406 __argv = malloc((argc + 4) * sizeof(const char *));
1408 pr_err("malloc failed\n");
1414 __argv[j++] = "/bin/sh";
1415 __argv[j++] = rep_script_path;
1416 for (i = 1; i < rep_args + 1; i++)
1417 __argv[j++] = argv[i];
1422 execvp("/bin/sh", (char **)__argv);
1427 if (rec_script_path)
1428 script_path = rec_script_path;
1429 if (rep_script_path)
1430 script_path = rep_script_path;
1435 if (!rec_script_path)
1436 system_wide = false;
1437 else if (!system_wide) {
1438 if (have_cmd(argc - 1, &argv[1]) != 0) {
1444 __argv = malloc((argc + 2) * sizeof(const char *));
1446 pr_err("malloc failed\n");
1451 __argv[j++] = "/bin/sh";
1452 __argv[j++] = script_path;
1455 for (i = 2; i < argc; i++)
1456 __argv[j++] = argv[i];
1459 execvp("/bin/sh", (char **)__argv);
1464 if (symbol__init() < 0)
1469 session = perf_session__new(input_name, O_RDONLY, 0, false,
1471 if (session == NULL)
1475 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1479 if (!script_name && !generate_script_lang)
1480 perf_session__fprintf_info(session, stdout, show_full_info);
1483 symbol_conf.use_callchain = true;
1485 symbol_conf.use_callchain = false;
1487 if (generate_script_lang) {
1488 struct stat perf_stat;
1491 if (output_set_by_user()) {
1493 "custom fields not supported for generated scripts");
1497 input = open(session->filename, O_RDONLY); /* input_name */
1499 perror("failed to open file");
1503 err = fstat(input, &perf_stat);
1505 perror("failed to stat file");
1509 if (!perf_stat.st_size) {
1510 fprintf(stderr, "zero-sized file, nothing to do!\n");
1514 scripting_ops = script_spec__lookup(generate_script_lang);
1515 if (!scripting_ops) {
1516 fprintf(stderr, "invalid language specifier");
1520 err = scripting_ops->generate_script(session->pevent,
1526 err = scripting_ops->start_script(script_name, argc, argv);
1529 pr_debug("perf script started with script %s\n\n", script_name);
1533 err = perf_session__check_output_opt(session);
1537 err = __cmd_script(session);
1539 perf_session__delete(session);
1540 cleanup_scripting();