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 <linux/bitmap.h>
19 static char const *script_name;
20 static char const *generate_script_lang;
21 static bool debug_mode;
22 static u64 last_timestamp;
23 static u64 nr_unordered;
24 extern const struct option record_options[];
25 static bool no_callchain;
26 static bool show_full_info;
27 static bool system_wide;
28 static const char *cpu_list;
29 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
31 enum perf_output_field {
32 PERF_OUTPUT_COMM = 1U << 0,
33 PERF_OUTPUT_TID = 1U << 1,
34 PERF_OUTPUT_PID = 1U << 2,
35 PERF_OUTPUT_TIME = 1U << 3,
36 PERF_OUTPUT_CPU = 1U << 4,
37 PERF_OUTPUT_EVNAME = 1U << 5,
38 PERF_OUTPUT_TRACE = 1U << 6,
39 PERF_OUTPUT_IP = 1U << 7,
40 PERF_OUTPUT_SYM = 1U << 8,
41 PERF_OUTPUT_DSO = 1U << 9,
42 PERF_OUTPUT_ADDR = 1U << 10,
43 PERF_OUTPUT_SYMOFFSET = 1U << 11,
46 struct output_option {
48 enum perf_output_field field;
49 } all_output_options[] = {
50 {.str = "comm", .field = PERF_OUTPUT_COMM},
51 {.str = "tid", .field = PERF_OUTPUT_TID},
52 {.str = "pid", .field = PERF_OUTPUT_PID},
53 {.str = "time", .field = PERF_OUTPUT_TIME},
54 {.str = "cpu", .field = PERF_OUTPUT_CPU},
55 {.str = "event", .field = PERF_OUTPUT_EVNAME},
56 {.str = "trace", .field = PERF_OUTPUT_TRACE},
57 {.str = "ip", .field = PERF_OUTPUT_IP},
58 {.str = "sym", .field = PERF_OUTPUT_SYM},
59 {.str = "dso", .field = PERF_OUTPUT_DSO},
60 {.str = "addr", .field = PERF_OUTPUT_ADDR},
61 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
64 /* default set to maintain compatibility with current format */
70 } output[PERF_TYPE_MAX] = {
72 [PERF_TYPE_HARDWARE] = {
75 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
76 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
77 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
78 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
80 .invalid_fields = PERF_OUTPUT_TRACE,
83 [PERF_TYPE_SOFTWARE] = {
86 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
87 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
88 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
89 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
91 .invalid_fields = PERF_OUTPUT_TRACE,
94 [PERF_TYPE_TRACEPOINT] = {
97 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
98 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
99 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
105 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
106 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
107 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
108 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
110 .invalid_fields = PERF_OUTPUT_TRACE,
114 static bool output_set_by_user(void)
117 for (j = 0; j < PERF_TYPE_MAX; ++j) {
118 if (output[j].user_set)
124 static const char *output_field2str(enum perf_output_field field)
126 int i, imax = ARRAY_SIZE(all_output_options);
127 const char *str = "";
129 for (i = 0; i < imax; ++i) {
130 if (all_output_options[i].field == field) {
131 str = all_output_options[i].str;
138 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
140 static int perf_event_attr__check_stype(struct perf_event_attr *attr,
141 u64 sample_type, const char *sample_msg,
142 enum perf_output_field field)
144 int type = attr->type;
147 if (attr->sample_type & sample_type)
150 if (output[type].user_set) {
151 evname = __event_name(attr->type, attr->config);
152 pr_err("Samples for '%s' event do not have %s attribute set. "
153 "Cannot print '%s' field.\n",
154 evname, sample_msg, output_field2str(field));
158 /* user did not ask for it explicitly so remove from the default list */
159 output[type].fields &= ~field;
160 evname = __event_name(attr->type, attr->config);
161 pr_debug("Samples for '%s' event do not have %s attribute set. "
162 "Skipping '%s' field.\n",
163 evname, sample_msg, output_field2str(field));
168 static int perf_evsel__check_attr(struct perf_evsel *evsel,
169 struct perf_session *session)
171 struct perf_event_attr *attr = &evsel->attr;
173 if (PRINT_FIELD(TRACE) &&
174 !perf_session__has_traces(session, "record -R"))
177 if (PRINT_FIELD(IP)) {
178 if (perf_event_attr__check_stype(attr, PERF_SAMPLE_IP, "IP",
183 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
184 symbol_conf.use_callchain = false;
187 if (PRINT_FIELD(ADDR) &&
188 perf_event_attr__check_stype(attr, PERF_SAMPLE_ADDR, "ADDR",
192 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
193 pr_err("Display of symbols requested but neither sample IP nor "
194 "sample address\nis selected. Hence, no addresses to convert "
198 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
199 pr_err("Display of offsets requested but symbol is not"
203 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
204 pr_err("Display of DSO requested but neither sample IP nor "
205 "sample address\nis selected. Hence, no addresses to convert "
210 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
211 perf_event_attr__check_stype(attr, PERF_SAMPLE_TID, "TID",
212 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
215 if (PRINT_FIELD(TIME) &&
216 perf_event_attr__check_stype(attr, PERF_SAMPLE_TIME, "TIME",
220 if (PRINT_FIELD(CPU) &&
221 perf_event_attr__check_stype(attr, PERF_SAMPLE_CPU, "CPU",
229 * verify all user requested events exist and the samples
230 * have the expected data
232 static int perf_session__check_output_opt(struct perf_session *session)
235 struct perf_evsel *evsel;
237 for (j = 0; j < PERF_TYPE_MAX; ++j) {
238 evsel = perf_session__find_first_evtype(session, j);
241 * even if fields is set to 0 (ie., show nothing) event must
242 * exist if user explicitly includes it on the command line
244 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
245 pr_err("%s events do not exist. "
246 "Remove corresponding -f option to proceed.\n",
251 if (evsel && output[j].fields &&
252 perf_evsel__check_attr(evsel, session))
259 static void print_sample_start(struct perf_sample *sample,
260 struct thread *thread,
261 struct perf_event_attr *attr)
264 struct event_format *event;
265 const char *evname = NULL;
268 unsigned long long nsecs;
270 if (PRINT_FIELD(COMM)) {
272 printf("%8.8s ", thread->comm);
273 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
274 printf("%s ", thread->comm);
276 printf("%16s ", thread->comm);
279 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
280 printf("%5d/%-5d ", sample->pid, sample->tid);
281 else if (PRINT_FIELD(PID))
282 printf("%5d ", sample->pid);
283 else if (PRINT_FIELD(TID))
284 printf("%5d ", sample->tid);
286 if (PRINT_FIELD(CPU)) {
288 printf("%3d ", sample->cpu);
290 printf("[%03d] ", sample->cpu);
293 if (PRINT_FIELD(TIME)) {
294 nsecs = sample->time;
295 secs = nsecs / NSECS_PER_SEC;
296 nsecs -= secs * NSECS_PER_SEC;
297 usecs = nsecs / NSECS_PER_USEC;
298 printf("%5lu.%06lu: ", secs, usecs);
301 if (PRINT_FIELD(EVNAME)) {
302 if (attr->type == PERF_TYPE_TRACEPOINT) {
303 type = trace_parse_common_type(sample->raw_data);
304 event = trace_find_event(type);
306 evname = event->name;
308 evname = __event_name(attr->type, attr->config);
310 printf("%s: ", evname ? evname : "[unknown]");
314 static bool is_bts_event(struct perf_event_attr *attr)
316 return ((attr->type == PERF_TYPE_HARDWARE) &&
317 (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
318 (attr->sample_period == 1));
321 static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
323 if ((attr->type == PERF_TYPE_SOFTWARE) &&
324 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
325 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
326 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
329 if (is_bts_event(attr))
335 static void print_sample_addr(union perf_event *event,
336 struct perf_sample *sample,
337 struct machine *machine,
338 struct thread *thread,
339 struct perf_event_attr *attr)
341 struct addr_location al;
342 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
344 printf("%16" PRIx64, sample->addr);
346 if (!sample_addr_correlates_sym(attr))
349 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
352 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
355 al.cpu = sample->cpu;
359 al.sym = map__find_symbol(al.map, al.addr, NULL);
361 if (PRINT_FIELD(SYM)) {
363 if (PRINT_FIELD(SYMOFFSET))
364 symbol__fprintf_symname_offs(al.sym, &al, stdout);
366 symbol__fprintf_symname(al.sym, stdout);
369 if (PRINT_FIELD(DSO)) {
371 map__fprintf_dsoname(al.map, stdout);
376 static void print_sample_bts(union perf_event *event,
377 struct perf_sample *sample,
378 struct perf_evsel *evsel,
379 struct machine *machine,
380 struct thread *thread)
382 struct perf_event_attr *attr = &evsel->attr;
384 /* print branch_from information */
385 if (PRINT_FIELD(IP)) {
386 if (!symbol_conf.use_callchain)
390 perf_event__print_ip(event, sample, machine, evsel,
391 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
392 PRINT_FIELD(SYMOFFSET));
397 /* print branch_to information */
398 if (PRINT_FIELD(ADDR))
399 print_sample_addr(event, sample, machine, thread, attr);
404 static void process_event(union perf_event *event __unused,
405 struct perf_sample *sample,
406 struct perf_evsel *evsel,
407 struct machine *machine,
408 struct thread *thread)
410 struct perf_event_attr *attr = &evsel->attr;
412 if (output[attr->type].fields == 0)
415 print_sample_start(sample, thread, attr);
417 if (is_bts_event(attr)) {
418 print_sample_bts(event, sample, evsel, machine, thread);
422 if (PRINT_FIELD(TRACE))
423 print_trace_event(sample->cpu, sample->raw_data,
426 if (PRINT_FIELD(ADDR))
427 print_sample_addr(event, sample, machine, thread, attr);
429 if (PRINT_FIELD(IP)) {
430 if (!symbol_conf.use_callchain)
434 perf_event__print_ip(event, sample, machine, evsel,
435 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
436 PRINT_FIELD(SYMOFFSET));
442 static int default_start_script(const char *script __unused,
444 const char **argv __unused)
449 static int default_stop_script(void)
454 static int default_generate_script(const char *outfile __unused)
459 static struct scripting_ops default_scripting_ops = {
460 .start_script = default_start_script,
461 .stop_script = default_stop_script,
462 .process_event = process_event,
463 .generate_script = default_generate_script,
466 static struct scripting_ops *scripting_ops;
468 static void setup_scripting(void)
470 setup_perl_scripting();
471 setup_python_scripting();
473 scripting_ops = &default_scripting_ops;
476 static int cleanup_scripting(void)
478 pr_debug("\nperf script stopped\n");
480 return scripting_ops->stop_script();
483 static const char *input_name;
485 static int process_sample_event(struct perf_tool *tool __used,
486 union perf_event *event,
487 struct perf_sample *sample,
488 struct perf_evsel *evsel,
489 struct machine *machine)
491 struct addr_location al;
492 struct thread *thread = machine__findnew_thread(machine, event->ip.tid);
494 if (thread == NULL) {
495 pr_debug("problem processing %d event, skipping it.\n",
501 if (sample->time < last_timestamp) {
502 pr_err("Samples misordered, previous: %" PRIu64
503 " this: %" PRIu64 "\n", last_timestamp,
507 last_timestamp = sample->time;
511 if (perf_event__preprocess_sample(event, machine, &al, sample, 0) < 0) {
512 pr_err("problem processing %d event, skipping it.\n",
520 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
523 scripting_ops->process_event(event, sample, evsel, machine, thread);
525 evsel->hists.stats.total_period += sample->period;
529 static struct perf_tool perf_script = {
530 .sample = process_sample_event,
531 .mmap = perf_event__process_mmap,
532 .comm = perf_event__process_comm,
533 .exit = perf_event__process_task,
534 .fork = perf_event__process_task,
535 .attr = perf_event__process_attr,
536 .event_type = perf_event__process_event_type,
537 .tracing_data = perf_event__process_tracing_data,
538 .build_id = perf_event__process_build_id,
539 .ordered_samples = true,
540 .ordering_requires_timestamps = true,
543 extern volatile int session_done;
545 static void sig_handler(int sig __unused)
550 static int __cmd_script(struct perf_session *session)
554 signal(SIGINT, sig_handler);
556 ret = perf_session__process_events(session, &perf_script);
559 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
565 struct list_head node;
566 struct scripting_ops *ops;
570 static LIST_HEAD(script_specs);
572 static struct script_spec *script_spec__new(const char *spec,
573 struct scripting_ops *ops)
575 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
578 strcpy(s->spec, spec);
585 static void script_spec__add(struct script_spec *s)
587 list_add_tail(&s->node, &script_specs);
590 static struct script_spec *script_spec__find(const char *spec)
592 struct script_spec *s;
594 list_for_each_entry(s, &script_specs, node)
595 if (strcasecmp(s->spec, spec) == 0)
600 static struct script_spec *script_spec__findnew(const char *spec,
601 struct scripting_ops *ops)
603 struct script_spec *s = script_spec__find(spec);
608 s = script_spec__new(spec, ops);
617 int script_spec_register(const char *spec, struct scripting_ops *ops)
619 struct script_spec *s;
621 s = script_spec__find(spec);
625 s = script_spec__findnew(spec, ops);
632 static struct scripting_ops *script_spec__lookup(const char *spec)
634 struct script_spec *s = script_spec__find(spec);
641 static void list_available_languages(void)
643 struct script_spec *s;
645 fprintf(stderr, "\n");
646 fprintf(stderr, "Scripting language extensions (used in "
647 "perf script -s [spec:]script.[spec]):\n\n");
649 list_for_each_entry(s, &script_specs, node)
650 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
652 fprintf(stderr, "\n");
655 static int parse_scriptname(const struct option *opt __used,
656 const char *str, int unset __used)
659 const char *script, *ext;
662 if (strcmp(str, "lang") == 0) {
663 list_available_languages();
667 script = strchr(str, ':');
670 if (len >= PATH_MAX) {
671 fprintf(stderr, "invalid language specifier");
674 strncpy(spec, str, len);
676 scripting_ops = script_spec__lookup(spec);
677 if (!scripting_ops) {
678 fprintf(stderr, "invalid language specifier");
684 ext = strrchr(script, '.');
686 fprintf(stderr, "invalid script extension");
689 scripting_ops = script_spec__lookup(++ext);
690 if (!scripting_ops) {
691 fprintf(stderr, "invalid script extension");
696 script_name = strdup(script);
701 static int parse_output_fields(const struct option *opt __used,
702 const char *arg, int unset __used)
705 int i, imax = sizeof(all_output_options) / sizeof(struct output_option);
708 char *str = strdup(arg);
714 /* first word can state for which event type the user is specifying
715 * the fields. If no type exists, the specified fields apply to all
716 * event types found in the file minus the invalid fields for a type.
718 tok = strchr(str, ':');
722 if (!strcmp(str, "hw"))
723 type = PERF_TYPE_HARDWARE;
724 else if (!strcmp(str, "sw"))
725 type = PERF_TYPE_SOFTWARE;
726 else if (!strcmp(str, "trace"))
727 type = PERF_TYPE_TRACEPOINT;
728 else if (!strcmp(str, "raw"))
729 type = PERF_TYPE_RAW;
731 fprintf(stderr, "Invalid event type in field string.\n");
736 if (output[type].user_set)
737 pr_warning("Overriding previous field request for %s events.\n",
740 output[type].fields = 0;
741 output[type].user_set = true;
742 output[type].wildcard_set = false;
746 if (strlen(str) == 0) {
748 "Cannot set fields to 'none' for all event types.\n");
753 if (output_set_by_user())
754 pr_warning("Overriding previous field request for all events.\n");
756 for (j = 0; j < PERF_TYPE_MAX; ++j) {
757 output[j].fields = 0;
758 output[j].user_set = true;
759 output[j].wildcard_set = true;
763 tok = strtok(tok, ",");
765 for (i = 0; i < imax; ++i) {
766 if (strcmp(tok, all_output_options[i].str) == 0)
770 fprintf(stderr, "Invalid field requested.\n");
776 /* add user option to all events types for
779 for (j = 0; j < PERF_TYPE_MAX; ++j) {
780 if (output[j].invalid_fields & all_output_options[i].field) {
781 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
782 all_output_options[i].str, event_type(j));
784 output[j].fields |= all_output_options[i].field;
787 if (output[type].invalid_fields & all_output_options[i].field) {
788 fprintf(stderr, "\'%s\' not valid for %s events.\n",
789 all_output_options[i].str, event_type(type));
794 output[type].fields |= all_output_options[i].field;
797 tok = strtok(NULL, ",");
801 if (output[type].fields == 0) {
802 pr_debug("No fields requested for %s type. "
803 "Events will not be displayed.\n", event_type(type));
812 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
813 static int is_directory(const char *base_path, const struct dirent *dent)
818 sprintf(path, "%s/%s", base_path, dent->d_name);
822 return S_ISDIR(st.st_mode);
825 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
826 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
828 if ((lang_dirent.d_type == DT_DIR || \
829 (lang_dirent.d_type == DT_UNKNOWN && \
830 is_directory(scripts_path, &lang_dirent))) && \
831 (strcmp(lang_dirent.d_name, ".")) && \
832 (strcmp(lang_dirent.d_name, "..")))
834 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
835 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
837 if (script_dirent.d_type != DT_DIR && \
838 (script_dirent.d_type != DT_UNKNOWN || \
839 !is_directory(lang_path, &script_dirent)))
842 #define RECORD_SUFFIX "-record"
843 #define REPORT_SUFFIX "-report"
846 struct list_head node;
852 static LIST_HEAD(script_descs);
854 static struct script_desc *script_desc__new(const char *name)
856 struct script_desc *s = zalloc(sizeof(*s));
858 if (s != NULL && name)
859 s->name = strdup(name);
864 static void script_desc__delete(struct script_desc *s)
872 static void script_desc__add(struct script_desc *s)
874 list_add_tail(&s->node, &script_descs);
877 static struct script_desc *script_desc__find(const char *name)
879 struct script_desc *s;
881 list_for_each_entry(s, &script_descs, node)
882 if (strcasecmp(s->name, name) == 0)
887 static struct script_desc *script_desc__findnew(const char *name)
889 struct script_desc *s = script_desc__find(name);
894 s = script_desc__new(name);
896 goto out_delete_desc;
903 script_desc__delete(s);
908 static const char *ends_with(const char *str, const char *suffix)
910 size_t suffix_len = strlen(suffix);
913 if (strlen(str) > suffix_len) {
914 p = str + strlen(str) - suffix_len;
915 if (!strncmp(p, suffix, suffix_len))
922 static char *ltrim(char *str)
924 int len = strlen(str);
926 while (len && isspace(*str)) {
934 static int read_script_info(struct script_desc *desc, const char *filename)
936 char line[BUFSIZ], *p;
939 fp = fopen(filename, "r");
943 while (fgets(line, sizeof(line), fp)) {
950 if (strlen(p) && *p == '!')
954 if (strlen(p) && p[strlen(p) - 1] == '\n')
955 p[strlen(p) - 1] = '\0';
957 if (!strncmp(p, "description:", strlen("description:"))) {
958 p += strlen("description:");
959 desc->half_liner = strdup(ltrim(p));
963 if (!strncmp(p, "args:", strlen("args:"))) {
964 p += strlen("args:");
965 desc->args = strdup(ltrim(p));
975 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
977 char *script_root, *str;
979 script_root = strdup(script_dirent->d_name);
983 str = (char *)ends_with(script_root, suffix);
993 static int list_available_scripts(const struct option *opt __used,
994 const char *s __used, int unset __used)
996 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
997 char scripts_path[MAXPATHLEN];
998 DIR *scripts_dir, *lang_dir;
999 char script_path[MAXPATHLEN];
1000 char lang_path[MAXPATHLEN];
1001 struct script_desc *desc;
1002 char first_half[BUFSIZ];
1005 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1007 scripts_dir = opendir(scripts_path);
1011 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1012 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1013 lang_dirent.d_name);
1014 lang_dir = opendir(lang_path);
1018 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1019 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1021 desc = script_desc__findnew(script_root);
1022 snprintf(script_path, MAXPATHLEN, "%s/%s",
1023 lang_path, script_dirent.d_name);
1024 read_script_info(desc, script_path);
1030 fprintf(stdout, "List of available trace scripts:\n");
1031 list_for_each_entry(desc, &script_descs, node) {
1032 sprintf(first_half, "%s %s", desc->name,
1033 desc->args ? desc->args : "");
1034 fprintf(stdout, " %-36s %s\n", first_half,
1035 desc->half_liner ? desc->half_liner : "");
1041 static char *get_script_path(const char *script_root, const char *suffix)
1043 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1044 char scripts_path[MAXPATHLEN];
1045 char script_path[MAXPATHLEN];
1046 DIR *scripts_dir, *lang_dir;
1047 char lang_path[MAXPATHLEN];
1048 char *__script_root;
1050 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1052 scripts_dir = opendir(scripts_path);
1056 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1057 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1058 lang_dirent.d_name);
1059 lang_dir = opendir(lang_path);
1063 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1064 __script_root = get_script_root(&script_dirent, suffix);
1065 if (__script_root && !strcmp(script_root, __script_root)) {
1066 free(__script_root);
1068 closedir(scripts_dir);
1069 snprintf(script_path, MAXPATHLEN, "%s/%s",
1070 lang_path, script_dirent.d_name);
1071 return strdup(script_path);
1073 free(__script_root);
1077 closedir(scripts_dir);
1082 static bool is_top_script(const char *script_path)
1084 return ends_with(script_path, "top") == NULL ? false : true;
1087 static int has_required_arg(char *script_path)
1089 struct script_desc *desc;
1093 desc = script_desc__new(NULL);
1095 if (read_script_info(desc, script_path))
1101 for (p = desc->args; *p; p++)
1105 script_desc__delete(desc);
1110 static const char * const script_usage[] = {
1111 "perf script [<options>]",
1112 "perf script [<options>] record <script> [<record-options>] <command>",
1113 "perf script [<options>] report <script> [script-args]",
1114 "perf script [<options>] <script> [<record-options>] <command>",
1115 "perf script [<options>] <top-script> [script-args]",
1119 static const struct option options[] = {
1120 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1121 "dump raw trace in ASCII"),
1122 OPT_INCR('v', "verbose", &verbose,
1123 "be more verbose (show symbol address, etc)"),
1124 OPT_BOOLEAN('L', "Latency", &latency_format,
1125 "show latency attributes (irqs/preemption disabled, etc)"),
1126 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1127 list_available_scripts),
1128 OPT_CALLBACK('s', "script", NULL, "name",
1129 "script file name (lang:script name, script name, or *)",
1131 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1132 "generate perf-script.xx script in specified language"),
1133 OPT_STRING('i', "input", &input_name, "file",
1135 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1136 "do various checks like samples ordering and lost events"),
1137 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1138 "file", "vmlinux pathname"),
1139 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1140 "file", "kallsyms pathname"),
1141 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1142 "When printing symbols do not display call chain"),
1143 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1144 "Look for files with symbols relative to this directory"),
1145 OPT_CALLBACK('f', "fields", NULL, "str",
1146 "comma separated output fields prepend with 'type:'. "
1147 "Valid types: hw,sw,trace,raw. "
1148 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1150 parse_output_fields),
1151 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1152 "system-wide collection from all CPUs"),
1153 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1154 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1155 "only display events for these comms"),
1156 OPT_BOOLEAN('I', "show-info", &show_full_info,
1157 "display extended information from perf.data file"),
1158 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1159 "Show the path of [kernel.kallsyms]"),
1164 static bool have_cmd(int argc, const char **argv)
1166 char **__argv = malloc(sizeof(const char *) * argc);
1170 memcpy(__argv, argv, sizeof(const char *) * argc);
1171 argc = parse_options(argc, (const char **)__argv, record_options,
1172 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1178 int cmd_script(int argc, const char **argv, const char *prefix __used)
1180 char *rec_script_path = NULL;
1181 char *rep_script_path = NULL;
1182 struct perf_session *session;
1183 char *script_path = NULL;
1184 const char **__argv;
1189 argc = parse_options(argc, argv, options, script_usage,
1190 PARSE_OPT_STOP_AT_NON_OPTION);
1192 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1193 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1194 if (!rec_script_path)
1195 return cmd_record(argc, argv, NULL);
1198 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1199 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1200 if (!rep_script_path) {
1202 "Please specify a valid report script"
1203 "(see 'perf script -l' for listing)\n");
1208 /* make sure PERF_EXEC_PATH is set for scripts */
1209 perf_set_argv_exec_path(perf_exec_path());
1211 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1216 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1217 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1219 if (!rec_script_path && !rep_script_path) {
1220 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1221 " script -l for available scripts.\n", argv[0]);
1222 usage_with_options(script_usage, options);
1225 if (is_top_script(argv[0])) {
1226 rep_args = argc - 1;
1230 rep_args = has_required_arg(rep_script_path);
1231 rec_args = (argc - 1) - rep_args;
1233 fprintf(stderr, " %s script requires options."
1234 "\n\n See perf script -l for available "
1235 "scripts and options.\n", argv[0]);
1236 usage_with_options(script_usage, options);
1240 if (pipe(live_pipe) < 0) {
1241 perror("failed to create pipe");
1247 perror("failed to fork");
1254 dup2(live_pipe[1], 1);
1255 close(live_pipe[0]);
1257 if (is_top_script(argv[0])) {
1259 } else if (!system_wide) {
1260 system_wide = !have_cmd(argc - rep_args,
1264 __argv = malloc((argc + 6) * sizeof(const char *));
1268 __argv[j++] = "/bin/sh";
1269 __argv[j++] = rec_script_path;
1275 for (i = rep_args + 1; i < argc; i++)
1276 __argv[j++] = argv[i];
1279 execvp("/bin/sh", (char **)__argv);
1284 dup2(live_pipe[0], 0);
1285 close(live_pipe[1]);
1287 __argv = malloc((argc + 4) * sizeof(const char *));
1291 __argv[j++] = "/bin/sh";
1292 __argv[j++] = rep_script_path;
1293 for (i = 1; i < rep_args + 1; i++)
1294 __argv[j++] = argv[i];
1299 execvp("/bin/sh", (char **)__argv);
1304 if (rec_script_path)
1305 script_path = rec_script_path;
1306 if (rep_script_path)
1307 script_path = rep_script_path;
1312 if (!rec_script_path)
1313 system_wide = false;
1314 else if (!system_wide)
1315 system_wide = !have_cmd(argc - 1, &argv[1]);
1317 __argv = malloc((argc + 2) * sizeof(const char *));
1320 __argv[j++] = "/bin/sh";
1321 __argv[j++] = script_path;
1324 for (i = 2; i < argc; i++)
1325 __argv[j++] = argv[i];
1328 execvp("/bin/sh", (char **)__argv);
1333 if (symbol__init() < 0)
1338 session = perf_session__new(input_name, O_RDONLY, 0, false, &perf_script);
1339 if (session == NULL)
1343 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1347 perf_session__fprintf_info(session, stdout, show_full_info);
1350 symbol_conf.use_callchain = true;
1352 symbol_conf.use_callchain = false;
1354 if (generate_script_lang) {
1355 struct stat perf_stat;
1358 if (output_set_by_user()) {
1360 "custom fields not supported for generated scripts");
1364 input = open(session->filename, O_RDONLY); /* input_name */
1366 perror("failed to open file");
1370 err = fstat(input, &perf_stat);
1372 perror("failed to stat file");
1376 if (!perf_stat.st_size) {
1377 fprintf(stderr, "zero-sized file, nothing to do!\n");
1381 scripting_ops = script_spec__lookup(generate_script_lang);
1382 if (!scripting_ops) {
1383 fprintf(stderr, "invalid language specifier");
1387 err = scripting_ops->generate_script("perf-script");
1392 err = scripting_ops->start_script(script_name, argc, argv);
1395 pr_debug("perf script started with script %s\n\n", script_name);
1399 err = perf_session__check_output_opt(session);
1403 err = __cmd_script(session);
1405 perf_session__delete(session);
1406 cleanup_scripting();