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,
46 PERF_OUTPUT_SRCLINE = 1U << 12,
49 struct output_option {
51 enum perf_output_field field;
52 } all_output_options[] = {
53 {.str = "comm", .field = PERF_OUTPUT_COMM},
54 {.str = "tid", .field = PERF_OUTPUT_TID},
55 {.str = "pid", .field = PERF_OUTPUT_PID},
56 {.str = "time", .field = PERF_OUTPUT_TIME},
57 {.str = "cpu", .field = PERF_OUTPUT_CPU},
58 {.str = "event", .field = PERF_OUTPUT_EVNAME},
59 {.str = "trace", .field = PERF_OUTPUT_TRACE},
60 {.str = "ip", .field = PERF_OUTPUT_IP},
61 {.str = "sym", .field = PERF_OUTPUT_SYM},
62 {.str = "dso", .field = PERF_OUTPUT_DSO},
63 {.str = "addr", .field = PERF_OUTPUT_ADDR},
64 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
65 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
68 /* default set to maintain compatibility with current format */
72 unsigned int print_ip_opts;
75 } output[PERF_TYPE_MAX] = {
77 [PERF_TYPE_HARDWARE] = {
80 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
81 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
82 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
83 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
85 .invalid_fields = PERF_OUTPUT_TRACE,
88 [PERF_TYPE_SOFTWARE] = {
91 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
92 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
93 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
94 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
96 .invalid_fields = PERF_OUTPUT_TRACE,
99 [PERF_TYPE_TRACEPOINT] = {
102 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
103 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
104 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
110 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
111 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
112 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
113 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
115 .invalid_fields = PERF_OUTPUT_TRACE,
119 static bool output_set_by_user(void)
122 for (j = 0; j < PERF_TYPE_MAX; ++j) {
123 if (output[j].user_set)
129 static const char *output_field2str(enum perf_output_field field)
131 int i, imax = ARRAY_SIZE(all_output_options);
132 const char *str = "";
134 for (i = 0; i < imax; ++i) {
135 if (all_output_options[i].field == field) {
136 str = all_output_options[i].str;
143 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
145 static int perf_evsel__check_stype(struct perf_evsel *evsel,
146 u64 sample_type, const char *sample_msg,
147 enum perf_output_field field)
149 struct perf_event_attr *attr = &evsel->attr;
150 int type = attr->type;
153 if (attr->sample_type & sample_type)
156 if (output[type].user_set) {
157 evname = perf_evsel__name(evsel);
158 pr_err("Samples for '%s' event do not have %s attribute set. "
159 "Cannot print '%s' field.\n",
160 evname, sample_msg, output_field2str(field));
164 /* user did not ask for it explicitly so remove from the default list */
165 output[type].fields &= ~field;
166 evname = perf_evsel__name(evsel);
167 pr_debug("Samples for '%s' event do not have %s attribute set. "
168 "Skipping '%s' field.\n",
169 evname, sample_msg, output_field2str(field));
174 static int perf_evsel__check_attr(struct perf_evsel *evsel,
175 struct perf_session *session)
177 struct perf_event_attr *attr = &evsel->attr;
179 if (PRINT_FIELD(TRACE) &&
180 !perf_session__has_traces(session, "record -R"))
183 if (PRINT_FIELD(IP)) {
184 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
189 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
190 symbol_conf.use_callchain = false;
193 if (PRINT_FIELD(ADDR) &&
194 perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
198 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
199 pr_err("Display of symbols requested but neither sample IP nor "
200 "sample address\nis selected. Hence, no addresses to convert "
204 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
205 pr_err("Display of offsets requested but symbol is not"
209 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
210 pr_err("Display of DSO requested but neither sample IP nor "
211 "sample address\nis selected. Hence, no addresses to convert "
215 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
216 pr_err("Display of source line number requested but sample IP is not\n"
217 "selected. Hence, no address to lookup the source line number.\n");
221 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
222 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
223 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
226 if (PRINT_FIELD(TIME) &&
227 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
231 if (PRINT_FIELD(CPU) &&
232 perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
239 static void set_print_ip_opts(struct perf_event_attr *attr)
241 unsigned int type = attr->type;
243 output[type].print_ip_opts = 0;
245 output[type].print_ip_opts |= PRINT_IP_OPT_IP;
247 if (PRINT_FIELD(SYM))
248 output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
250 if (PRINT_FIELD(DSO))
251 output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
253 if (PRINT_FIELD(SYMOFFSET))
254 output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
256 if (PRINT_FIELD(SRCLINE))
257 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
261 * verify all user requested events exist and the samples
262 * have the expected data
264 static int perf_session__check_output_opt(struct perf_session *session)
267 struct perf_evsel *evsel;
269 for (j = 0; j < PERF_TYPE_MAX; ++j) {
270 evsel = perf_session__find_first_evtype(session, j);
273 * even if fields is set to 0 (ie., show nothing) event must
274 * exist if user explicitly includes it on the command line
276 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
277 pr_err("%s events do not exist. "
278 "Remove corresponding -f option to proceed.\n",
283 if (evsel && output[j].fields &&
284 perf_evsel__check_attr(evsel, session))
290 set_print_ip_opts(&evsel->attr);
294 * set default for tracepoints to print symbols only
295 * if callchains are present
297 if (symbol_conf.use_callchain &&
298 !output[PERF_TYPE_TRACEPOINT].user_set) {
299 struct perf_event_attr *attr;
301 j = PERF_TYPE_TRACEPOINT;
302 evsel = perf_session__find_first_evtype(session, j);
308 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
309 output[j].fields |= PERF_OUTPUT_IP;
310 output[j].fields |= PERF_OUTPUT_SYM;
311 output[j].fields |= PERF_OUTPUT_DSO;
312 set_print_ip_opts(attr);
320 static void print_sample_start(struct perf_sample *sample,
321 struct thread *thread,
322 struct perf_evsel *evsel)
324 struct perf_event_attr *attr = &evsel->attr;
327 unsigned long long nsecs;
329 if (PRINT_FIELD(COMM)) {
331 printf("%8.8s ", thread__comm_str(thread));
332 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
333 printf("%s ", thread__comm_str(thread));
335 printf("%16s ", thread__comm_str(thread));
338 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
339 printf("%5d/%-5d ", sample->pid, sample->tid);
340 else if (PRINT_FIELD(PID))
341 printf("%5d ", sample->pid);
342 else if (PRINT_FIELD(TID))
343 printf("%5d ", sample->tid);
345 if (PRINT_FIELD(CPU)) {
347 printf("%3d ", sample->cpu);
349 printf("[%03d] ", sample->cpu);
352 if (PRINT_FIELD(TIME)) {
353 nsecs = sample->time;
354 secs = nsecs / NSECS_PER_SEC;
355 nsecs -= secs * NSECS_PER_SEC;
356 usecs = nsecs / NSECS_PER_USEC;
357 printf("%5lu.%06lu: ", secs, usecs);
361 static bool is_bts_event(struct perf_event_attr *attr)
363 return ((attr->type == PERF_TYPE_HARDWARE) &&
364 (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
365 (attr->sample_period == 1));
368 static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
370 if ((attr->type == PERF_TYPE_SOFTWARE) &&
371 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
372 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
373 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
376 if (is_bts_event(attr))
382 static void print_sample_addr(union perf_event *event,
383 struct perf_sample *sample,
384 struct machine *machine,
385 struct thread *thread,
386 struct perf_event_attr *attr)
388 struct addr_location al;
389 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
391 printf("%16" PRIx64, sample->addr);
393 if (!sample_addr_correlates_sym(attr))
396 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
399 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
402 al.cpu = sample->cpu;
406 al.sym = map__find_symbol(al.map, al.addr, NULL);
408 if (PRINT_FIELD(SYM)) {
410 if (PRINT_FIELD(SYMOFFSET))
411 symbol__fprintf_symname_offs(al.sym, &al, stdout);
413 symbol__fprintf_symname(al.sym, stdout);
416 if (PRINT_FIELD(DSO)) {
418 map__fprintf_dsoname(al.map, stdout);
423 static void print_sample_bts(union perf_event *event,
424 struct perf_sample *sample,
425 struct perf_evsel *evsel,
426 struct machine *machine,
427 struct thread *thread,
428 struct addr_location *al)
430 struct perf_event_attr *attr = &evsel->attr;
432 /* print branch_from information */
433 if (PRINT_FIELD(IP)) {
434 if (!symbol_conf.use_callchain)
438 perf_evsel__print_ip(evsel, sample, machine, al,
439 output[attr->type].print_ip_opts,
440 PERF_MAX_STACK_DEPTH);
445 /* print branch_to information */
446 if (PRINT_FIELD(ADDR) ||
447 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
448 !output[attr->type].user_set))
449 print_sample_addr(event, sample, machine, thread, attr);
454 static void process_event(union perf_event *event, struct perf_sample *sample,
455 struct perf_evsel *evsel, struct machine *machine,
456 struct thread *thread,
457 struct addr_location *al)
459 struct perf_event_attr *attr = &evsel->attr;
461 if (output[attr->type].fields == 0)
464 print_sample_start(sample, thread, evsel);
466 if (PRINT_FIELD(EVNAME)) {
467 const char *evname = perf_evsel__name(evsel);
468 printf("%s: ", evname ? evname : "[unknown]");
471 if (is_bts_event(attr)) {
472 print_sample_bts(event, sample, evsel, machine, thread, al);
476 if (PRINT_FIELD(TRACE))
477 event_format__print(evsel->tp_format, sample->cpu,
478 sample->raw_data, sample->raw_size);
479 if (PRINT_FIELD(ADDR))
480 print_sample_addr(event, sample, machine, thread, attr);
482 if (PRINT_FIELD(IP)) {
483 if (!symbol_conf.use_callchain)
488 perf_evsel__print_ip(evsel, sample, machine, al,
489 output[attr->type].print_ip_opts,
490 PERF_MAX_STACK_DEPTH);
496 static int default_start_script(const char *script __maybe_unused,
497 int argc __maybe_unused,
498 const char **argv __maybe_unused)
503 static int default_stop_script(void)
508 static int default_generate_script(struct pevent *pevent __maybe_unused,
509 const char *outfile __maybe_unused)
514 static struct scripting_ops default_scripting_ops = {
515 .start_script = default_start_script,
516 .stop_script = default_stop_script,
517 .process_event = process_event,
518 .generate_script = default_generate_script,
521 static struct scripting_ops *scripting_ops;
523 static void setup_scripting(void)
525 setup_perl_scripting();
526 setup_python_scripting();
528 scripting_ops = &default_scripting_ops;
531 static int cleanup_scripting(void)
533 pr_debug("\nperf script stopped\n");
535 return scripting_ops->stop_script();
538 static int process_sample_event(struct perf_tool *tool __maybe_unused,
539 union perf_event *event,
540 struct perf_sample *sample,
541 struct perf_evsel *evsel,
542 struct machine *machine)
544 struct addr_location al;
545 struct thread *thread = machine__findnew_thread(machine, sample->pid,
548 if (thread == NULL) {
549 pr_debug("problem processing %d event, skipping it.\n",
555 if (sample->time < last_timestamp) {
556 pr_err("Samples misordered, previous: %" PRIu64
557 " this: %" PRIu64 "\n", last_timestamp,
561 last_timestamp = sample->time;
565 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
566 pr_err("problem processing %d event, skipping it.\n",
574 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
577 scripting_ops->process_event(event, sample, evsel, machine, thread, &al);
579 evsel->hists.stats.total_period += sample->period;
584 struct perf_tool tool;
585 struct perf_session *session;
586 bool show_task_events;
587 bool show_mmap_events;
590 static int process_attr(struct perf_tool *tool, union perf_event *event,
591 struct perf_evlist **pevlist)
593 struct perf_script *scr = container_of(tool, struct perf_script, tool);
594 struct perf_evlist *evlist;
595 struct perf_evsel *evsel, *pos;
598 err = perf_event__process_attr(tool, event, pevlist);
603 evsel = perf_evlist__last(*pevlist);
605 if (evsel->attr.type >= PERF_TYPE_MAX)
608 list_for_each_entry(pos, &evlist->entries, node) {
609 if (pos->attr.type == evsel->attr.type && pos != evsel)
613 set_print_ip_opts(&evsel->attr);
615 return perf_evsel__check_attr(evsel, scr->session);
618 static int process_comm_event(struct perf_tool *tool,
619 union perf_event *event,
620 struct perf_sample *sample,
621 struct machine *machine)
623 struct thread *thread;
624 struct perf_script *script = container_of(tool, struct perf_script, tool);
625 struct perf_session *session = script->session;
626 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
629 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
630 if (thread == NULL) {
631 pr_debug("problem processing COMM event, skipping it.\n");
635 if (perf_event__process_comm(tool, event, sample, machine) < 0)
638 if (!evsel->attr.sample_id_all) {
641 sample->tid = event->comm.tid;
642 sample->pid = event->comm.pid;
644 print_sample_start(sample, thread, evsel);
645 perf_event__fprintf(event, stdout);
652 static int process_fork_event(struct perf_tool *tool,
653 union perf_event *event,
654 struct perf_sample *sample,
655 struct machine *machine)
657 struct thread *thread;
658 struct perf_script *script = container_of(tool, struct perf_script, tool);
659 struct perf_session *session = script->session;
660 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
662 if (perf_event__process_fork(tool, event, sample, machine) < 0)
665 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
666 if (thread == NULL) {
667 pr_debug("problem processing FORK event, skipping it.\n");
671 if (!evsel->attr.sample_id_all) {
673 sample->time = event->fork.time;
674 sample->tid = event->fork.tid;
675 sample->pid = event->fork.pid;
677 print_sample_start(sample, thread, evsel);
678 perf_event__fprintf(event, stdout);
682 static int process_exit_event(struct perf_tool *tool,
683 union perf_event *event,
684 struct perf_sample *sample,
685 struct machine *machine)
687 struct thread *thread;
688 struct perf_script *script = container_of(tool, struct perf_script, tool);
689 struct perf_session *session = script->session;
690 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
692 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
693 if (thread == NULL) {
694 pr_debug("problem processing EXIT event, skipping it.\n");
698 if (!evsel->attr.sample_id_all) {
701 sample->tid = event->comm.tid;
702 sample->pid = event->comm.pid;
704 print_sample_start(sample, thread, evsel);
705 perf_event__fprintf(event, stdout);
707 if (perf_event__process_exit(tool, event, sample, machine) < 0)
713 static int process_mmap_event(struct perf_tool *tool,
714 union perf_event *event,
715 struct perf_sample *sample,
716 struct machine *machine)
718 struct thread *thread;
719 struct perf_script *script = container_of(tool, struct perf_script, tool);
720 struct perf_session *session = script->session;
721 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
723 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
726 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
727 if (thread == NULL) {
728 pr_debug("problem processing MMAP event, skipping it.\n");
732 if (!evsel->attr.sample_id_all) {
735 sample->tid = event->mmap.tid;
736 sample->pid = event->mmap.pid;
738 print_sample_start(sample, thread, evsel);
739 perf_event__fprintf(event, stdout);
744 static int process_mmap2_event(struct perf_tool *tool,
745 union perf_event *event,
746 struct perf_sample *sample,
747 struct machine *machine)
749 struct thread *thread;
750 struct perf_script *script = container_of(tool, struct perf_script, tool);
751 struct perf_session *session = script->session;
752 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
754 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
757 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
758 if (thread == NULL) {
759 pr_debug("problem processing MMAP2 event, skipping it.\n");
763 if (!evsel->attr.sample_id_all) {
766 sample->tid = event->mmap2.tid;
767 sample->pid = event->mmap2.pid;
769 print_sample_start(sample, thread, evsel);
770 perf_event__fprintf(event, stdout);
775 static void sig_handler(int sig __maybe_unused)
780 static int __cmd_script(struct perf_script *script)
784 signal(SIGINT, sig_handler);
786 /* override event processing functions */
787 if (script->show_task_events) {
788 script->tool.comm = process_comm_event;
789 script->tool.fork = process_fork_event;
790 script->tool.exit = process_exit_event;
792 if (script->show_mmap_events) {
793 script->tool.mmap = process_mmap_event;
794 script->tool.mmap2 = process_mmap2_event;
797 ret = perf_session__process_events(script->session, &script->tool);
800 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
806 struct list_head node;
807 struct scripting_ops *ops;
811 static LIST_HEAD(script_specs);
813 static struct script_spec *script_spec__new(const char *spec,
814 struct scripting_ops *ops)
816 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
819 strcpy(s->spec, spec);
826 static void script_spec__add(struct script_spec *s)
828 list_add_tail(&s->node, &script_specs);
831 static struct script_spec *script_spec__find(const char *spec)
833 struct script_spec *s;
835 list_for_each_entry(s, &script_specs, node)
836 if (strcasecmp(s->spec, spec) == 0)
841 static struct script_spec *script_spec__findnew(const char *spec,
842 struct scripting_ops *ops)
844 struct script_spec *s = script_spec__find(spec);
849 s = script_spec__new(spec, ops);
858 int script_spec_register(const char *spec, struct scripting_ops *ops)
860 struct script_spec *s;
862 s = script_spec__find(spec);
866 s = script_spec__findnew(spec, ops);
873 static struct scripting_ops *script_spec__lookup(const char *spec)
875 struct script_spec *s = script_spec__find(spec);
882 static void list_available_languages(void)
884 struct script_spec *s;
886 fprintf(stderr, "\n");
887 fprintf(stderr, "Scripting language extensions (used in "
888 "perf script -s [spec:]script.[spec]):\n\n");
890 list_for_each_entry(s, &script_specs, node)
891 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
893 fprintf(stderr, "\n");
896 static int parse_scriptname(const struct option *opt __maybe_unused,
897 const char *str, int unset __maybe_unused)
900 const char *script, *ext;
903 if (strcmp(str, "lang") == 0) {
904 list_available_languages();
908 script = strchr(str, ':');
911 if (len >= PATH_MAX) {
912 fprintf(stderr, "invalid language specifier");
915 strncpy(spec, str, len);
917 scripting_ops = script_spec__lookup(spec);
918 if (!scripting_ops) {
919 fprintf(stderr, "invalid language specifier");
925 ext = strrchr(script, '.');
927 fprintf(stderr, "invalid script extension");
930 scripting_ops = script_spec__lookup(++ext);
931 if (!scripting_ops) {
932 fprintf(stderr, "invalid script extension");
937 script_name = strdup(script);
942 static int parse_output_fields(const struct option *opt __maybe_unused,
943 const char *arg, int unset __maybe_unused)
946 int i, imax = ARRAY_SIZE(all_output_options);
949 char *str = strdup(arg);
955 /* first word can state for which event type the user is specifying
956 * the fields. If no type exists, the specified fields apply to all
957 * event types found in the file minus the invalid fields for a type.
959 tok = strchr(str, ':');
963 if (!strcmp(str, "hw"))
964 type = PERF_TYPE_HARDWARE;
965 else if (!strcmp(str, "sw"))
966 type = PERF_TYPE_SOFTWARE;
967 else if (!strcmp(str, "trace"))
968 type = PERF_TYPE_TRACEPOINT;
969 else if (!strcmp(str, "raw"))
970 type = PERF_TYPE_RAW;
972 fprintf(stderr, "Invalid event type in field string.\n");
977 if (output[type].user_set)
978 pr_warning("Overriding previous field request for %s events.\n",
981 output[type].fields = 0;
982 output[type].user_set = true;
983 output[type].wildcard_set = false;
987 if (strlen(str) == 0) {
989 "Cannot set fields to 'none' for all event types.\n");
994 if (output_set_by_user())
995 pr_warning("Overriding previous field request for all events.\n");
997 for (j = 0; j < PERF_TYPE_MAX; ++j) {
998 output[j].fields = 0;
999 output[j].user_set = true;
1000 output[j].wildcard_set = true;
1004 tok = strtok(tok, ",");
1006 for (i = 0; i < imax; ++i) {
1007 if (strcmp(tok, all_output_options[i].str) == 0)
1011 fprintf(stderr, "Invalid field requested.\n");
1017 /* add user option to all events types for
1020 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1021 if (output[j].invalid_fields & all_output_options[i].field) {
1022 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1023 all_output_options[i].str, event_type(j));
1025 output[j].fields |= all_output_options[i].field;
1028 if (output[type].invalid_fields & all_output_options[i].field) {
1029 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1030 all_output_options[i].str, event_type(type));
1035 output[type].fields |= all_output_options[i].field;
1038 tok = strtok(NULL, ",");
1042 if (output[type].fields == 0) {
1043 pr_debug("No fields requested for %s type. "
1044 "Events will not be displayed.\n", event_type(type));
1053 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1054 static int is_directory(const char *base_path, const struct dirent *dent)
1056 char path[PATH_MAX];
1059 sprintf(path, "%s/%s", base_path, dent->d_name);
1060 if (stat(path, &st))
1063 return S_ISDIR(st.st_mode);
1066 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
1067 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
1069 if ((lang_dirent.d_type == DT_DIR || \
1070 (lang_dirent.d_type == DT_UNKNOWN && \
1071 is_directory(scripts_path, &lang_dirent))) && \
1072 (strcmp(lang_dirent.d_name, ".")) && \
1073 (strcmp(lang_dirent.d_name, "..")))
1075 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1076 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
1078 if (script_dirent.d_type != DT_DIR && \
1079 (script_dirent.d_type != DT_UNKNOWN || \
1080 !is_directory(lang_path, &script_dirent)))
1083 #define RECORD_SUFFIX "-record"
1084 #define REPORT_SUFFIX "-report"
1086 struct script_desc {
1087 struct list_head node;
1093 static LIST_HEAD(script_descs);
1095 static struct script_desc *script_desc__new(const char *name)
1097 struct script_desc *s = zalloc(sizeof(*s));
1099 if (s != NULL && name)
1100 s->name = strdup(name);
1105 static void script_desc__delete(struct script_desc *s)
1108 free(s->half_liner);
1113 static void script_desc__add(struct script_desc *s)
1115 list_add_tail(&s->node, &script_descs);
1118 static struct script_desc *script_desc__find(const char *name)
1120 struct script_desc *s;
1122 list_for_each_entry(s, &script_descs, node)
1123 if (strcasecmp(s->name, name) == 0)
1128 static struct script_desc *script_desc__findnew(const char *name)
1130 struct script_desc *s = script_desc__find(name);
1135 s = script_desc__new(name);
1137 goto out_delete_desc;
1139 script_desc__add(s);
1144 script_desc__delete(s);
1149 static const char *ends_with(const char *str, const char *suffix)
1151 size_t suffix_len = strlen(suffix);
1152 const char *p = str;
1154 if (strlen(str) > suffix_len) {
1155 p = str + strlen(str) - suffix_len;
1156 if (!strncmp(p, suffix, suffix_len))
1163 static int read_script_info(struct script_desc *desc, const char *filename)
1165 char line[BUFSIZ], *p;
1168 fp = fopen(filename, "r");
1172 while (fgets(line, sizeof(line), fp)) {
1179 if (strlen(p) && *p == '!')
1183 if (strlen(p) && p[strlen(p) - 1] == '\n')
1184 p[strlen(p) - 1] = '\0';
1186 if (!strncmp(p, "description:", strlen("description:"))) {
1187 p += strlen("description:");
1188 desc->half_liner = strdup(ltrim(p));
1192 if (!strncmp(p, "args:", strlen("args:"))) {
1193 p += strlen("args:");
1194 desc->args = strdup(ltrim(p));
1204 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1206 char *script_root, *str;
1208 script_root = strdup(script_dirent->d_name);
1212 str = (char *)ends_with(script_root, suffix);
1222 static int list_available_scripts(const struct option *opt __maybe_unused,
1223 const char *s __maybe_unused,
1224 int unset __maybe_unused)
1226 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1227 char scripts_path[MAXPATHLEN];
1228 DIR *scripts_dir, *lang_dir;
1229 char script_path[MAXPATHLEN];
1230 char lang_path[MAXPATHLEN];
1231 struct script_desc *desc;
1232 char first_half[BUFSIZ];
1235 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1237 scripts_dir = opendir(scripts_path);
1241 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1242 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1243 lang_dirent.d_name);
1244 lang_dir = opendir(lang_path);
1248 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1249 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1251 desc = script_desc__findnew(script_root);
1252 snprintf(script_path, MAXPATHLEN, "%s/%s",
1253 lang_path, script_dirent.d_name);
1254 read_script_info(desc, script_path);
1260 fprintf(stdout, "List of available trace scripts:\n");
1261 list_for_each_entry(desc, &script_descs, node) {
1262 sprintf(first_half, "%s %s", desc->name,
1263 desc->args ? desc->args : "");
1264 fprintf(stdout, " %-36s %s\n", first_half,
1265 desc->half_liner ? desc->half_liner : "");
1272 * Some scripts specify the required events in their "xxx-record" file,
1273 * this function will check if the events in perf.data match those
1274 * mentioned in the "xxx-record".
1276 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1277 * which is covered well now. And new parsing code should be added to
1278 * cover the future complexing formats like event groups etc.
1280 static int check_ev_match(char *dir_name, char *scriptname,
1281 struct perf_session *session)
1283 char filename[MAXPATHLEN], evname[128];
1284 char line[BUFSIZ], *p;
1285 struct perf_evsel *pos;
1289 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1291 fp = fopen(filename, "r");
1295 while (fgets(line, sizeof(line), fp)) {
1301 p = strstr(p, "-e");
1307 len = strcspn(p, " \t");
1311 snprintf(evname, len + 1, "%s", p);
1314 list_for_each_entry(pos,
1315 &session->evlist->entries, node) {
1316 if (!strcmp(perf_evsel__name(pos), evname)) {
1334 * Return -1 if none is found, otherwise the actual scripts number.
1336 * Currently the only user of this function is the script browser, which
1337 * will list all statically runnable scripts, select one, execute it and
1338 * show the output in a perf browser.
1340 int find_scripts(char **scripts_array, char **scripts_path_array)
1342 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1343 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1344 DIR *scripts_dir, *lang_dir;
1345 struct perf_session *session;
1346 struct perf_data_file file = {
1348 .mode = PERF_DATA_MODE_READ,
1353 session = perf_session__new(&file, false, NULL);
1357 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1359 scripts_dir = opendir(scripts_path);
1361 perf_session__delete(session);
1365 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1366 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1367 lang_dirent.d_name);
1369 if (strstr(lang_path, "perl"))
1373 if (strstr(lang_path, "python"))
1377 lang_dir = opendir(lang_path);
1381 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1382 /* Skip those real time scripts: xxxtop.p[yl] */
1383 if (strstr(script_dirent.d_name, "top."))
1385 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1386 script_dirent.d_name);
1387 temp = strchr(script_dirent.d_name, '.');
1388 snprintf(scripts_array[i],
1389 (temp - script_dirent.d_name) + 1,
1390 "%s", script_dirent.d_name);
1392 if (check_ev_match(lang_path,
1393 scripts_array[i], session))
1401 closedir(scripts_dir);
1402 perf_session__delete(session);
1406 static char *get_script_path(const char *script_root, const char *suffix)
1408 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1409 char scripts_path[MAXPATHLEN];
1410 char script_path[MAXPATHLEN];
1411 DIR *scripts_dir, *lang_dir;
1412 char lang_path[MAXPATHLEN];
1413 char *__script_root;
1415 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1417 scripts_dir = opendir(scripts_path);
1421 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1422 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1423 lang_dirent.d_name);
1424 lang_dir = opendir(lang_path);
1428 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1429 __script_root = get_script_root(&script_dirent, suffix);
1430 if (__script_root && !strcmp(script_root, __script_root)) {
1431 free(__script_root);
1433 closedir(scripts_dir);
1434 snprintf(script_path, MAXPATHLEN, "%s/%s",
1435 lang_path, script_dirent.d_name);
1436 return strdup(script_path);
1438 free(__script_root);
1442 closedir(scripts_dir);
1447 static bool is_top_script(const char *script_path)
1449 return ends_with(script_path, "top") == NULL ? false : true;
1452 static int has_required_arg(char *script_path)
1454 struct script_desc *desc;
1458 desc = script_desc__new(NULL);
1460 if (read_script_info(desc, script_path))
1466 for (p = desc->args; *p; p++)
1470 script_desc__delete(desc);
1475 static int have_cmd(int argc, const char **argv)
1477 char **__argv = malloc(sizeof(const char *) * argc);
1480 pr_err("malloc failed\n");
1484 memcpy(__argv, argv, sizeof(const char *) * argc);
1485 argc = parse_options(argc, (const char **)__argv, record_options,
1486 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1489 system_wide = (argc == 0);
1494 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1496 bool show_full_info = false;
1497 bool header = false;
1498 bool header_only = false;
1499 char *rec_script_path = NULL;
1500 char *rep_script_path = NULL;
1501 struct perf_session *session;
1502 char *script_path = NULL;
1503 const char **__argv;
1505 struct perf_script script = {
1507 .sample = process_sample_event,
1508 .mmap = perf_event__process_mmap,
1509 .mmap2 = perf_event__process_mmap2,
1510 .comm = perf_event__process_comm,
1511 .exit = perf_event__process_exit,
1512 .fork = perf_event__process_fork,
1513 .attr = process_attr,
1514 .tracing_data = perf_event__process_tracing_data,
1515 .build_id = perf_event__process_build_id,
1516 .ordered_samples = true,
1517 .ordering_requires_timestamps = true,
1520 const struct option options[] = {
1521 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1522 "dump raw trace in ASCII"),
1523 OPT_INCR('v', "verbose", &verbose,
1524 "be more verbose (show symbol address, etc)"),
1525 OPT_BOOLEAN('L', "Latency", &latency_format,
1526 "show latency attributes (irqs/preemption disabled, etc)"),
1527 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1528 list_available_scripts),
1529 OPT_CALLBACK('s', "script", NULL, "name",
1530 "script file name (lang:script name, script name, or *)",
1532 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1533 "generate perf-script.xx script in specified language"),
1534 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1535 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1536 "do various checks like samples ordering and lost events"),
1537 OPT_BOOLEAN(0, "header", &header, "Show data header."),
1538 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1539 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1540 "file", "vmlinux pathname"),
1541 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1542 "file", "kallsyms pathname"),
1543 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1544 "When printing symbols do not display call chain"),
1545 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1546 "Look for files with symbols relative to this directory"),
1547 OPT_CALLBACK('f', "fields", NULL, "str",
1548 "comma separated output fields prepend with 'type:'. "
1549 "Valid types: hw,sw,trace,raw. "
1550 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1551 "addr,symoff", parse_output_fields),
1552 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1553 "system-wide collection from all CPUs"),
1554 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1555 "only consider these symbols"),
1556 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1557 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1558 "only display events for these comms"),
1559 OPT_BOOLEAN('I', "show-info", &show_full_info,
1560 "display extended information from perf.data file"),
1561 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1562 "Show the path of [kernel.kallsyms]"),
1563 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
1564 "Show the fork/comm/exit events"),
1565 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
1566 "Show the mmap events"),
1569 const char * const script_usage[] = {
1570 "perf script [<options>]",
1571 "perf script [<options>] record <script> [<record-options>] <command>",
1572 "perf script [<options>] report <script> [script-args]",
1573 "perf script [<options>] <script> [<record-options>] <command>",
1574 "perf script [<options>] <top-script> [script-args]",
1577 struct perf_data_file file = {
1578 .mode = PERF_DATA_MODE_READ,
1583 argc = parse_options(argc, argv, options, script_usage,
1584 PARSE_OPT_STOP_AT_NON_OPTION);
1586 file.path = input_name;
1588 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1589 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1590 if (!rec_script_path)
1591 return cmd_record(argc, argv, NULL);
1594 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1595 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1596 if (!rep_script_path) {
1598 "Please specify a valid report script"
1599 "(see 'perf script -l' for listing)\n");
1604 /* make sure PERF_EXEC_PATH is set for scripts */
1605 perf_set_argv_exec_path(perf_exec_path());
1607 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1612 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1613 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1615 if (!rec_script_path && !rep_script_path) {
1616 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1617 " script -l for available scripts.\n", argv[0]);
1618 usage_with_options(script_usage, options);
1621 if (is_top_script(argv[0])) {
1622 rep_args = argc - 1;
1626 rep_args = has_required_arg(rep_script_path);
1627 rec_args = (argc - 1) - rep_args;
1629 fprintf(stderr, " %s script requires options."
1630 "\n\n See perf script -l for available "
1631 "scripts and options.\n", argv[0]);
1632 usage_with_options(script_usage, options);
1636 if (pipe(live_pipe) < 0) {
1637 perror("failed to create pipe");
1643 perror("failed to fork");
1650 dup2(live_pipe[1], 1);
1651 close(live_pipe[0]);
1653 if (is_top_script(argv[0])) {
1655 } else if (!system_wide) {
1656 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1662 __argv = malloc((argc + 6) * sizeof(const char *));
1664 pr_err("malloc failed\n");
1669 __argv[j++] = "/bin/sh";
1670 __argv[j++] = rec_script_path;
1676 for (i = rep_args + 1; i < argc; i++)
1677 __argv[j++] = argv[i];
1680 execvp("/bin/sh", (char **)__argv);
1685 dup2(live_pipe[0], 0);
1686 close(live_pipe[1]);
1688 __argv = malloc((argc + 4) * sizeof(const char *));
1690 pr_err("malloc failed\n");
1696 __argv[j++] = "/bin/sh";
1697 __argv[j++] = rep_script_path;
1698 for (i = 1; i < rep_args + 1; i++)
1699 __argv[j++] = argv[i];
1704 execvp("/bin/sh", (char **)__argv);
1709 if (rec_script_path)
1710 script_path = rec_script_path;
1711 if (rep_script_path)
1712 script_path = rep_script_path;
1717 if (!rec_script_path)
1718 system_wide = false;
1719 else if (!system_wide) {
1720 if (have_cmd(argc - 1, &argv[1]) != 0) {
1726 __argv = malloc((argc + 2) * sizeof(const char *));
1728 pr_err("malloc failed\n");
1733 __argv[j++] = "/bin/sh";
1734 __argv[j++] = script_path;
1737 for (i = 2; i < argc; i++)
1738 __argv[j++] = argv[i];
1741 execvp("/bin/sh", (char **)__argv);
1746 if (symbol__init() < 0)
1751 session = perf_session__new(&file, false, &script.tool);
1752 if (session == NULL)
1755 if (header || header_only) {
1756 perf_session__fprintf_info(session, stdout, show_full_info);
1761 script.session = session;
1764 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1769 symbol_conf.use_callchain = true;
1771 symbol_conf.use_callchain = false;
1773 if (generate_script_lang) {
1774 struct stat perf_stat;
1777 if (output_set_by_user()) {
1779 "custom fields not supported for generated scripts");
1783 input = open(file.path, O_RDONLY); /* input_name */
1785 perror("failed to open file");
1789 err = fstat(input, &perf_stat);
1791 perror("failed to stat file");
1795 if (!perf_stat.st_size) {
1796 fprintf(stderr, "zero-sized file, nothing to do!\n");
1800 scripting_ops = script_spec__lookup(generate_script_lang);
1801 if (!scripting_ops) {
1802 fprintf(stderr, "invalid language specifier");
1806 err = scripting_ops->generate_script(session->tevent.pevent,
1812 err = scripting_ops->start_script(script_name, argc, argv);
1815 pr_debug("perf script started with script %s\n\n", script_name);
1819 err = perf_session__check_output_opt(session);
1823 err = __cmd_script(&script);
1825 perf_session__delete(session);
1826 cleanup_scripting();