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/symbol.h"
11 #include "util/thread.h"
12 #include "util/trace-event.h"
13 #include "util/util.h"
14 #include "util/evlist.h"
15 #include "util/evsel.h"
16 #include <linux/bitmap.h>
18 static char const *script_name;
19 static char const *generate_script_lang;
20 static bool debug_mode;
21 static u64 last_timestamp;
22 static u64 nr_unordered;
23 extern const struct option record_options[];
24 static bool no_callchain;
25 static bool show_full_info;
26 static const char *cpu_list;
27 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
29 enum perf_output_field {
30 PERF_OUTPUT_COMM = 1U << 0,
31 PERF_OUTPUT_TID = 1U << 1,
32 PERF_OUTPUT_PID = 1U << 2,
33 PERF_OUTPUT_TIME = 1U << 3,
34 PERF_OUTPUT_CPU = 1U << 4,
35 PERF_OUTPUT_EVNAME = 1U << 5,
36 PERF_OUTPUT_TRACE = 1U << 6,
37 PERF_OUTPUT_IP = 1U << 7,
38 PERF_OUTPUT_SYM = 1U << 8,
39 PERF_OUTPUT_DSO = 1U << 9,
40 PERF_OUTPUT_ADDR = 1U << 10,
43 struct output_option {
45 enum perf_output_field field;
46 } all_output_options[] = {
47 {.str = "comm", .field = PERF_OUTPUT_COMM},
48 {.str = "tid", .field = PERF_OUTPUT_TID},
49 {.str = "pid", .field = PERF_OUTPUT_PID},
50 {.str = "time", .field = PERF_OUTPUT_TIME},
51 {.str = "cpu", .field = PERF_OUTPUT_CPU},
52 {.str = "event", .field = PERF_OUTPUT_EVNAME},
53 {.str = "trace", .field = PERF_OUTPUT_TRACE},
54 {.str = "ip", .field = PERF_OUTPUT_IP},
55 {.str = "sym", .field = PERF_OUTPUT_SYM},
56 {.str = "dso", .field = PERF_OUTPUT_DSO},
57 {.str = "addr", .field = PERF_OUTPUT_ADDR},
60 /* default set to maintain compatibility with current format */
66 } output[PERF_TYPE_MAX] = {
68 [PERF_TYPE_HARDWARE] = {
71 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
72 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
73 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
74 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
76 .invalid_fields = PERF_OUTPUT_TRACE,
79 [PERF_TYPE_SOFTWARE] = {
82 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
83 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
84 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
85 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
87 .invalid_fields = PERF_OUTPUT_TRACE,
90 [PERF_TYPE_TRACEPOINT] = {
93 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
94 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
95 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
101 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
102 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
103 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
104 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
106 .invalid_fields = PERF_OUTPUT_TRACE,
110 static bool output_set_by_user(void)
113 for (j = 0; j < PERF_TYPE_MAX; ++j) {
114 if (output[j].user_set)
120 static const char *output_field2str(enum perf_output_field field)
122 int i, imax = ARRAY_SIZE(all_output_options);
123 const char *str = "";
125 for (i = 0; i < imax; ++i) {
126 if (all_output_options[i].field == field) {
127 str = all_output_options[i].str;
134 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
136 static int perf_event_attr__check_stype(struct perf_event_attr *attr,
137 u64 sample_type, const char *sample_msg,
138 enum perf_output_field field)
140 int type = attr->type;
143 if (attr->sample_type & sample_type)
146 if (output[type].user_set) {
147 evname = __event_name(attr->type, attr->config);
148 pr_err("Samples for '%s' event do not have %s attribute set. "
149 "Cannot print '%s' field.\n",
150 evname, sample_msg, output_field2str(field));
154 /* user did not ask for it explicitly so remove from the default list */
155 output[type].fields &= ~field;
156 evname = __event_name(attr->type, attr->config);
157 pr_debug("Samples for '%s' event do not have %s attribute set. "
158 "Skipping '%s' field.\n",
159 evname, sample_msg, output_field2str(field));
164 static int perf_evsel__check_attr(struct perf_evsel *evsel,
165 struct perf_session *session)
167 struct perf_event_attr *attr = &evsel->attr;
169 if (PRINT_FIELD(TRACE) &&
170 !perf_session__has_traces(session, "record -R"))
173 if (PRINT_FIELD(IP)) {
174 if (perf_event_attr__check_stype(attr, PERF_SAMPLE_IP, "IP",
179 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
180 symbol_conf.use_callchain = false;
183 if (PRINT_FIELD(ADDR) &&
184 perf_event_attr__check_stype(attr, PERF_SAMPLE_ADDR, "ADDR",
188 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
189 pr_err("Display of symbols requested but neither sample IP nor "
190 "sample address\nis selected. Hence, no addresses to convert "
194 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
195 pr_err("Display of DSO requested but neither sample IP nor "
196 "sample address\nis selected. Hence, no addresses to convert "
201 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
202 perf_event_attr__check_stype(attr, PERF_SAMPLE_TID, "TID",
203 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
206 if (PRINT_FIELD(TIME) &&
207 perf_event_attr__check_stype(attr, PERF_SAMPLE_TIME, "TIME",
211 if (PRINT_FIELD(CPU) &&
212 perf_event_attr__check_stype(attr, PERF_SAMPLE_CPU, "CPU",
220 * verify all user requested events exist and the samples
221 * have the expected data
223 static int perf_session__check_output_opt(struct perf_session *session)
226 struct perf_evsel *evsel;
228 for (j = 0; j < PERF_TYPE_MAX; ++j) {
229 evsel = perf_session__find_first_evtype(session, j);
232 * even if fields is set to 0 (ie., show nothing) event must
233 * exist if user explicitly includes it on the command line
235 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
236 pr_err("%s events do not exist. "
237 "Remove corresponding -f option to proceed.\n",
242 if (evsel && output[j].fields &&
243 perf_evsel__check_attr(evsel, session))
250 static void print_sample_start(struct perf_sample *sample,
251 struct thread *thread,
252 struct perf_event_attr *attr)
256 const char *evname = NULL;
259 unsigned long long nsecs;
261 if (PRINT_FIELD(COMM)) {
263 printf("%8.8s ", thread->comm);
264 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
265 printf("%s ", thread->comm);
267 printf("%16s ", thread->comm);
270 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
271 printf("%5d/%-5d ", sample->pid, sample->tid);
272 else if (PRINT_FIELD(PID))
273 printf("%5d ", sample->pid);
274 else if (PRINT_FIELD(TID))
275 printf("%5d ", sample->tid);
277 if (PRINT_FIELD(CPU)) {
279 printf("%3d ", sample->cpu);
281 printf("[%03d] ", sample->cpu);
284 if (PRINT_FIELD(TIME)) {
285 nsecs = sample->time;
286 secs = nsecs / NSECS_PER_SEC;
287 nsecs -= secs * NSECS_PER_SEC;
288 usecs = nsecs / NSECS_PER_USEC;
289 printf("%5lu.%06lu: ", secs, usecs);
292 if (PRINT_FIELD(EVNAME)) {
293 if (attr->type == PERF_TYPE_TRACEPOINT) {
294 type = trace_parse_common_type(sample->raw_data);
295 event = trace_find_event(type);
297 evname = event->name;
299 evname = __event_name(attr->type, attr->config);
301 printf("%s: ", evname ? evname : "(unknown)");
305 static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
307 if ((attr->type == PERF_TYPE_SOFTWARE) &&
308 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
309 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
310 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
316 static void print_sample_addr(union perf_event *event,
317 struct perf_sample *sample,
318 struct machine *machine,
319 struct thread *thread,
320 struct perf_event_attr *attr)
322 struct addr_location al;
323 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
324 const char *symname, *dsoname;
326 printf("%16" PRIx64, sample->addr);
328 if (!sample_addr_correlates_sym(attr))
331 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
334 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
337 al.cpu = sample->cpu;
341 al.sym = map__find_symbol(al.map, al.addr, NULL);
343 if (PRINT_FIELD(SYM)) {
344 if (al.sym && al.sym->name)
345 symname = al.sym->name;
349 printf(" %16s", symname);
352 if (PRINT_FIELD(DSO)) {
353 if (al.map && al.map->dso && al.map->dso->name)
354 dsoname = al.map->dso->name;
358 printf(" (%s)", dsoname);
362 static void process_event(union perf_event *event __unused,
363 struct perf_sample *sample,
364 struct perf_evsel *evsel,
365 struct machine *machine,
366 struct thread *thread)
368 struct perf_event_attr *attr = &evsel->attr;
370 if (output[attr->type].fields == 0)
373 print_sample_start(sample, thread, attr);
375 if (PRINT_FIELD(TRACE))
376 print_trace_event(sample->cpu, sample->raw_data,
379 if (PRINT_FIELD(ADDR))
380 print_sample_addr(event, sample, machine, thread, attr);
382 if (PRINT_FIELD(IP)) {
383 if (!symbol_conf.use_callchain)
387 perf_event__print_ip(event, sample, machine, evsel,
388 PRINT_FIELD(SYM), PRINT_FIELD(DSO));
394 static int default_start_script(const char *script __unused,
396 const char **argv __unused)
401 static int default_stop_script(void)
406 static int default_generate_script(const char *outfile __unused)
411 static struct scripting_ops default_scripting_ops = {
412 .start_script = default_start_script,
413 .stop_script = default_stop_script,
414 .process_event = process_event,
415 .generate_script = default_generate_script,
418 static struct scripting_ops *scripting_ops;
420 static void setup_scripting(void)
422 setup_perl_scripting();
423 setup_python_scripting();
425 scripting_ops = &default_scripting_ops;
428 static int cleanup_scripting(void)
430 pr_debug("\nperf script stopped\n");
432 return scripting_ops->stop_script();
435 static char const *input_name = "perf.data";
437 static int process_sample_event(struct perf_event_ops *ops __used,
438 union perf_event *event,
439 struct perf_sample *sample,
440 struct perf_evsel *evsel,
441 struct machine *machine)
443 struct thread *thread = machine__findnew_thread(machine, event->ip.pid);
445 if (thread == NULL) {
446 pr_debug("problem processing %d event, skipping it.\n",
452 if (sample->time < last_timestamp) {
453 pr_err("Samples misordered, previous: %" PRIu64
454 " this: %" PRIu64 "\n", last_timestamp,
458 last_timestamp = sample->time;
462 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
465 scripting_ops->process_event(event, sample, evsel, machine, thread);
467 evsel->hists.stats.total_period += sample->period;
471 static struct perf_event_ops event_ops = {
472 .sample = process_sample_event,
473 .mmap = perf_event__process_mmap,
474 .comm = perf_event__process_comm,
475 .exit = perf_event__process_task,
476 .fork = perf_event__process_task,
477 .attr = perf_event__process_attr,
478 .event_type = perf_event__process_event_type,
479 .tracing_data = perf_event__process_tracing_data,
480 .build_id = perf_event__process_build_id,
481 .ordered_samples = true,
482 .ordering_requires_timestamps = true,
485 extern volatile int session_done;
487 static void sig_handler(int sig __unused)
492 static int __cmd_script(struct perf_session *session)
496 signal(SIGINT, sig_handler);
498 ret = perf_session__process_events(session, &event_ops);
501 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
507 struct list_head node;
508 struct scripting_ops *ops;
512 static LIST_HEAD(script_specs);
514 static struct script_spec *script_spec__new(const char *spec,
515 struct scripting_ops *ops)
517 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
520 strcpy(s->spec, spec);
527 static void script_spec__delete(struct script_spec *s)
533 static void script_spec__add(struct script_spec *s)
535 list_add_tail(&s->node, &script_specs);
538 static struct script_spec *script_spec__find(const char *spec)
540 struct script_spec *s;
542 list_for_each_entry(s, &script_specs, node)
543 if (strcasecmp(s->spec, spec) == 0)
548 static struct script_spec *script_spec__findnew(const char *spec,
549 struct scripting_ops *ops)
551 struct script_spec *s = script_spec__find(spec);
556 s = script_spec__new(spec, ops);
558 goto out_delete_spec;
565 script_spec__delete(s);
570 int script_spec_register(const char *spec, struct scripting_ops *ops)
572 struct script_spec *s;
574 s = script_spec__find(spec);
578 s = script_spec__findnew(spec, ops);
585 static struct scripting_ops *script_spec__lookup(const char *spec)
587 struct script_spec *s = script_spec__find(spec);
594 static void list_available_languages(void)
596 struct script_spec *s;
598 fprintf(stderr, "\n");
599 fprintf(stderr, "Scripting language extensions (used in "
600 "perf script -s [spec:]script.[spec]):\n\n");
602 list_for_each_entry(s, &script_specs, node)
603 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
605 fprintf(stderr, "\n");
608 static int parse_scriptname(const struct option *opt __used,
609 const char *str, int unset __used)
612 const char *script, *ext;
615 if (strcmp(str, "lang") == 0) {
616 list_available_languages();
620 script = strchr(str, ':');
623 if (len >= PATH_MAX) {
624 fprintf(stderr, "invalid language specifier");
627 strncpy(spec, str, len);
629 scripting_ops = script_spec__lookup(spec);
630 if (!scripting_ops) {
631 fprintf(stderr, "invalid language specifier");
637 ext = strrchr(script, '.');
639 fprintf(stderr, "invalid script extension");
642 scripting_ops = script_spec__lookup(++ext);
643 if (!scripting_ops) {
644 fprintf(stderr, "invalid script extension");
649 script_name = strdup(script);
654 static int parse_output_fields(const struct option *opt __used,
655 const char *arg, int unset __used)
658 int i, imax = sizeof(all_output_options) / sizeof(struct output_option);
661 char *str = strdup(arg);
667 /* first word can state for which event type the user is specifying
668 * the fields. If no type exists, the specified fields apply to all
669 * event types found in the file minus the invalid fields for a type.
671 tok = strchr(str, ':');
675 if (!strcmp(str, "hw"))
676 type = PERF_TYPE_HARDWARE;
677 else if (!strcmp(str, "sw"))
678 type = PERF_TYPE_SOFTWARE;
679 else if (!strcmp(str, "trace"))
680 type = PERF_TYPE_TRACEPOINT;
681 else if (!strcmp(str, "raw"))
682 type = PERF_TYPE_RAW;
684 fprintf(stderr, "Invalid event type in field string.\n");
688 if (output[type].user_set)
689 pr_warning("Overriding previous field request for %s events.\n",
692 output[type].fields = 0;
693 output[type].user_set = true;
694 output[type].wildcard_set = false;
698 if (strlen(str) == 0) {
700 "Cannot set fields to 'none' for all event types.\n");
705 if (output_set_by_user())
706 pr_warning("Overriding previous field request for all events.\n");
708 for (j = 0; j < PERF_TYPE_MAX; ++j) {
709 output[j].fields = 0;
710 output[j].user_set = true;
711 output[j].wildcard_set = true;
715 tok = strtok(tok, ",");
717 for (i = 0; i < imax; ++i) {
718 if (strcmp(tok, all_output_options[i].str) == 0)
722 fprintf(stderr, "Invalid field requested.\n");
728 /* add user option to all events types for
731 for (j = 0; j < PERF_TYPE_MAX; ++j) {
732 if (output[j].invalid_fields & all_output_options[i].field) {
733 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
734 all_output_options[i].str, event_type(j));
736 output[j].fields |= all_output_options[i].field;
739 if (output[type].invalid_fields & all_output_options[i].field) {
740 fprintf(stderr, "\'%s\' not valid for %s events.\n",
741 all_output_options[i].str, event_type(type));
746 output[type].fields |= all_output_options[i].field;
749 tok = strtok(NULL, ",");
753 if (output[type].fields == 0) {
754 pr_debug("No fields requested for %s type. "
755 "Events will not be displayed.\n", event_type(type));
764 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
765 static int is_directory(const char *base_path, const struct dirent *dent)
770 sprintf(path, "%s/%s", base_path, dent->d_name);
774 return S_ISDIR(st.st_mode);
777 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
778 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
780 if ((lang_dirent.d_type == DT_DIR || \
781 (lang_dirent.d_type == DT_UNKNOWN && \
782 is_directory(scripts_path, &lang_dirent))) && \
783 (strcmp(lang_dirent.d_name, ".")) && \
784 (strcmp(lang_dirent.d_name, "..")))
786 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
787 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
789 if (script_dirent.d_type != DT_DIR && \
790 (script_dirent.d_type != DT_UNKNOWN || \
791 !is_directory(lang_path, &script_dirent)))
794 #define RECORD_SUFFIX "-record"
795 #define REPORT_SUFFIX "-report"
798 struct list_head node;
804 static LIST_HEAD(script_descs);
806 static struct script_desc *script_desc__new(const char *name)
808 struct script_desc *s = zalloc(sizeof(*s));
810 if (s != NULL && name)
811 s->name = strdup(name);
816 static void script_desc__delete(struct script_desc *s)
824 static void script_desc__add(struct script_desc *s)
826 list_add_tail(&s->node, &script_descs);
829 static struct script_desc *script_desc__find(const char *name)
831 struct script_desc *s;
833 list_for_each_entry(s, &script_descs, node)
834 if (strcasecmp(s->name, name) == 0)
839 static struct script_desc *script_desc__findnew(const char *name)
841 struct script_desc *s = script_desc__find(name);
846 s = script_desc__new(name);
848 goto out_delete_desc;
855 script_desc__delete(s);
860 static const char *ends_with(const char *str, const char *suffix)
862 size_t suffix_len = strlen(suffix);
865 if (strlen(str) > suffix_len) {
866 p = str + strlen(str) - suffix_len;
867 if (!strncmp(p, suffix, suffix_len))
874 static char *ltrim(char *str)
876 int len = strlen(str);
878 while (len && isspace(*str)) {
886 static int read_script_info(struct script_desc *desc, const char *filename)
888 char line[BUFSIZ], *p;
891 fp = fopen(filename, "r");
895 while (fgets(line, sizeof(line), fp)) {
902 if (strlen(p) && *p == '!')
906 if (strlen(p) && p[strlen(p) - 1] == '\n')
907 p[strlen(p) - 1] = '\0';
909 if (!strncmp(p, "description:", strlen("description:"))) {
910 p += strlen("description:");
911 desc->half_liner = strdup(ltrim(p));
915 if (!strncmp(p, "args:", strlen("args:"))) {
916 p += strlen("args:");
917 desc->args = strdup(ltrim(p));
927 static int list_available_scripts(const struct option *opt __used,
928 const char *s __used, int unset __used)
930 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
931 char scripts_path[MAXPATHLEN];
932 DIR *scripts_dir, *lang_dir;
933 char script_path[MAXPATHLEN];
934 char lang_path[MAXPATHLEN];
935 struct script_desc *desc;
936 char first_half[BUFSIZ];
940 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
942 scripts_dir = opendir(scripts_path);
946 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
947 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
949 lang_dir = opendir(lang_path);
953 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
954 script_root = strdup(script_dirent.d_name);
955 str = (char *)ends_with(script_root, REPORT_SUFFIX);
958 desc = script_desc__findnew(script_root);
959 snprintf(script_path, MAXPATHLEN, "%s/%s",
960 lang_path, script_dirent.d_name);
961 read_script_info(desc, script_path);
967 fprintf(stdout, "List of available trace scripts:\n");
968 list_for_each_entry(desc, &script_descs, node) {
969 sprintf(first_half, "%s %s", desc->name,
970 desc->args ? desc->args : "");
971 fprintf(stdout, " %-36s %s\n", first_half,
972 desc->half_liner ? desc->half_liner : "");
978 static char *get_script_path(const char *script_root, const char *suffix)
980 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
981 char scripts_path[MAXPATHLEN];
982 char script_path[MAXPATHLEN];
983 DIR *scripts_dir, *lang_dir;
984 char lang_path[MAXPATHLEN];
985 char *str, *__script_root;
988 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
990 scripts_dir = opendir(scripts_path);
994 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
995 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
997 lang_dir = opendir(lang_path);
1001 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1002 __script_root = strdup(script_dirent.d_name);
1003 str = (char *)ends_with(__script_root, suffix);
1006 if (strcmp(__script_root, script_root))
1008 snprintf(script_path, MAXPATHLEN, "%s/%s",
1009 lang_path, script_dirent.d_name);
1010 path = strdup(script_path);
1011 free(__script_root);
1014 free(__script_root);
1021 static bool is_top_script(const char *script_path)
1023 return ends_with(script_path, "top") == NULL ? false : true;
1026 static int has_required_arg(char *script_path)
1028 struct script_desc *desc;
1032 desc = script_desc__new(NULL);
1034 if (read_script_info(desc, script_path))
1040 for (p = desc->args; *p; p++)
1044 script_desc__delete(desc);
1049 static const char * const script_usage[] = {
1050 "perf script [<options>]",
1051 "perf script [<options>] record <script> [<record-options>] <command>",
1052 "perf script [<options>] report <script> [script-args]",
1053 "perf script [<options>] <script> [<record-options>] <command>",
1054 "perf script [<options>] <top-script> [script-args]",
1058 static const struct option options[] = {
1059 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1060 "dump raw trace in ASCII"),
1061 OPT_INCR('v', "verbose", &verbose,
1062 "be more verbose (show symbol address, etc)"),
1063 OPT_BOOLEAN('L', "Latency", &latency_format,
1064 "show latency attributes (irqs/preemption disabled, etc)"),
1065 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1066 list_available_scripts),
1067 OPT_CALLBACK('s', "script", NULL, "name",
1068 "script file name (lang:script name, script name, or *)",
1070 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1071 "generate perf-script.xx script in specified language"),
1072 OPT_STRING('i', "input", &input_name, "file",
1074 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1075 "do various checks like samples ordering and lost events"),
1076 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1077 "file", "vmlinux pathname"),
1078 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1079 "file", "kallsyms pathname"),
1080 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1081 "When printing symbols do not display call chain"),
1082 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1083 "Look for files with symbols relative to this directory"),
1084 OPT_CALLBACK('f', "fields", NULL, "str",
1085 "comma separated output fields prepend with 'type:'. Valid types: hw,sw,trace,raw. Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,addr",
1086 parse_output_fields),
1087 OPT_STRING('c', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1088 OPT_BOOLEAN('I', "show-info", &show_full_info,
1089 "display extended information from perf.data file"),
1093 static bool have_cmd(int argc, const char **argv)
1095 char **__argv = malloc(sizeof(const char *) * argc);
1099 memcpy(__argv, argv, sizeof(const char *) * argc);
1100 argc = parse_options(argc, (const char **)__argv, record_options,
1101 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1107 int cmd_script(int argc, const char **argv, const char *prefix __used)
1109 char *rec_script_path = NULL;
1110 char *rep_script_path = NULL;
1111 struct perf_session *session;
1112 char *script_path = NULL;
1113 const char **__argv;
1119 argc = parse_options(argc, argv, options, script_usage,
1120 PARSE_OPT_STOP_AT_NON_OPTION);
1122 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1123 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1124 if (!rec_script_path)
1125 return cmd_record(argc, argv, NULL);
1128 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1129 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1130 if (!rep_script_path) {
1132 "Please specify a valid report script"
1133 "(see 'perf script -l' for listing)\n");
1138 /* make sure PERF_EXEC_PATH is set for scripts */
1139 perf_set_argv_exec_path(perf_exec_path());
1141 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1146 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1147 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1149 if (!rec_script_path && !rep_script_path) {
1150 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1151 " script -l for available scripts.\n", argv[0]);
1152 usage_with_options(script_usage, options);
1155 if (is_top_script(argv[0])) {
1156 rep_args = argc - 1;
1160 rep_args = has_required_arg(rep_script_path);
1161 rec_args = (argc - 1) - rep_args;
1163 fprintf(stderr, " %s script requires options."
1164 "\n\n See perf script -l for available "
1165 "scripts and options.\n", argv[0]);
1166 usage_with_options(script_usage, options);
1170 if (pipe(live_pipe) < 0) {
1171 perror("failed to create pipe");
1177 perror("failed to fork");
1185 dup2(live_pipe[1], 1);
1186 close(live_pipe[0]);
1188 if (!is_top_script(argv[0]))
1189 system_wide = !have_cmd(argc - rep_args,
1192 __argv = malloc((argc + 6) * sizeof(const char *));
1196 __argv[j++] = "/bin/sh";
1197 __argv[j++] = rec_script_path;
1203 for (i = rep_args + 1; i < argc; i++)
1204 __argv[j++] = argv[i];
1207 execvp("/bin/sh", (char **)__argv);
1212 dup2(live_pipe[0], 0);
1213 close(live_pipe[1]);
1215 __argv = malloc((argc + 4) * sizeof(const char *));
1219 __argv[j++] = "/bin/sh";
1220 __argv[j++] = rep_script_path;
1221 for (i = 1; i < rep_args + 1; i++)
1222 __argv[j++] = argv[i];
1227 execvp("/bin/sh", (char **)__argv);
1232 if (rec_script_path)
1233 script_path = rec_script_path;
1234 if (rep_script_path)
1235 script_path = rep_script_path;
1238 system_wide = false;
1241 if (rec_script_path)
1242 system_wide = !have_cmd(argc - 1, &argv[1]);
1244 __argv = malloc((argc + 2) * sizeof(const char *));
1247 __argv[j++] = "/bin/sh";
1248 __argv[j++] = script_path;
1251 for (i = 2; i < argc; i++)
1252 __argv[j++] = argv[i];
1255 execvp("/bin/sh", (char **)__argv);
1260 if (symbol__init() < 0)
1265 session = perf_session__new(input_name, O_RDONLY, 0, false, &event_ops);
1266 if (session == NULL)
1270 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1274 perf_session__fprintf_info(session, stdout, show_full_info);
1277 symbol_conf.use_callchain = true;
1279 symbol_conf.use_callchain = false;
1281 if (generate_script_lang) {
1282 struct stat perf_stat;
1285 if (output_set_by_user()) {
1287 "custom fields not supported for generated scripts");
1291 input = open(input_name, O_RDONLY);
1293 perror("failed to open file");
1297 err = fstat(input, &perf_stat);
1299 perror("failed to stat file");
1303 if (!perf_stat.st_size) {
1304 fprintf(stderr, "zero-sized file, nothing to do!\n");
1308 scripting_ops = script_spec__lookup(generate_script_lang);
1309 if (!scripting_ops) {
1310 fprintf(stderr, "invalid language specifier");
1314 err = scripting_ops->generate_script("perf-script");
1319 err = scripting_ops->start_script(script_name, argc, argv);
1322 pr_debug("perf script started with script %s\n\n", script_name);
1326 err = perf_session__check_output_opt(session);
1330 err = __cmd_script(session);
1332 perf_session__delete(session);
1333 cleanup_scripting();