4 * Builtin report command: Analyze the perf.data input file,
5 * look up and read DSOs and symbol information and display
6 * a histogram of results, along various sorting keys.
10 #include "util/util.h"
12 #include "util/annotate.h"
13 #include "util/color.h"
14 #include <linux/list.h>
15 #include "util/cache.h"
16 #include <linux/rbtree.h>
17 #include "util/symbol.h"
18 #include "util/callchain.h"
19 #include "util/strlist.h"
20 #include "util/values.h"
23 #include "util/debug.h"
24 #include "util/evlist.h"
25 #include "util/evsel.h"
26 #include "util/header.h"
27 #include "util/session.h"
28 #include "util/tool.h"
30 #include "util/parse-options.h"
31 #include "util/parse-events.h"
33 #include "util/thread.h"
34 #include "util/sort.h"
35 #include "util/hist.h"
37 #include <linux/bitmap.h>
40 struct perf_tool tool
;
41 struct perf_session
*session
;
42 char const *input_name
;
43 bool force
, use_tui
, use_gtk
, use_stdio
;
45 bool dont_use_callchains
;
48 bool inverted_callchain
;
49 struct perf_read_values show_threads_values
;
50 const char *pretty_printing_style
;
51 symbol_filter_t annotate_init
;
53 const char *symbol_filter_str
;
54 DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
57 static int perf_report__add_branch_hist_entry(struct perf_tool
*tool
,
58 struct addr_location
*al
,
59 struct perf_sample
*sample
,
60 struct perf_evsel
*evsel
,
61 struct machine
*machine
)
63 struct perf_report
*rep
= container_of(tool
, struct perf_report
, tool
);
64 struct symbol
*parent
= NULL
;
67 struct hist_entry
*he
;
68 struct branch_info
*bi
, *bx
;
70 if ((sort__has_parent
|| symbol_conf
.use_callchain
)
71 && sample
->callchain
) {
72 err
= machine__resolve_callchain(machine
, al
->thread
,
73 sample
->callchain
, &parent
);
78 bi
= machine__resolve_bstack(machine
, al
->thread
,
79 sample
->branch_stack
);
83 for (i
= 0; i
< sample
->branch_stack
->nr
; i
++) {
84 if (rep
->hide_unresolved
&& !(bi
[i
].from
.sym
&& bi
[i
].to
.sym
))
87 * The report shows the percentage of total branches captured
88 * and not events sampled. Thus we use a pseudo period of 1.
90 he
= __hists__add_branch_entry(&evsel
->hists
, al
, parent
,
93 struct annotation
*notes
;
96 if (bx
->from
.sym
&& use_browser
> 0) {
97 notes
= symbol__annotation(bx
->from
.sym
);
99 && symbol__alloc_hist(bx
->from
.sym
) < 0)
102 err
= symbol__inc_addr_samples(bx
->from
.sym
,
110 if (bx
->to
.sym
&& use_browser
> 0) {
111 notes
= symbol__annotation(bx
->to
.sym
);
113 && symbol__alloc_hist(bx
->to
.sym
) < 0)
116 err
= symbol__inc_addr_samples(bx
->to
.sym
,
123 evsel
->hists
.stats
.total_period
+= 1;
124 hists__inc_nr_events(&evsel
->hists
, PERF_RECORD_SAMPLE
);
133 static int perf_evsel__add_hist_entry(struct perf_evsel
*evsel
,
134 struct addr_location
*al
,
135 struct perf_sample
*sample
,
136 struct machine
*machine
)
138 struct symbol
*parent
= NULL
;
140 struct hist_entry
*he
;
142 if ((sort__has_parent
|| symbol_conf
.use_callchain
) && sample
->callchain
) {
143 err
= machine__resolve_callchain(machine
, al
->thread
,
144 sample
->callchain
, &parent
);
149 he
= __hists__add_entry(&evsel
->hists
, al
, parent
, sample
->period
);
153 if (symbol_conf
.use_callchain
) {
154 err
= callchain_append(he
->callchain
,
161 * Only in the newt browser we are doing integrated annotation,
162 * so we don't allocated the extra space needed because the stdio
163 * code will not use it.
165 if (he
->ms
.sym
!= NULL
&& use_browser
> 0) {
166 struct annotation
*notes
= symbol__annotation(he
->ms
.sym
);
168 assert(evsel
!= NULL
);
171 if (notes
->src
== NULL
&& symbol__alloc_hist(he
->ms
.sym
) < 0)
174 err
= hist_entry__inc_addr_samples(he
, evsel
->idx
, al
->addr
);
177 evsel
->hists
.stats
.total_period
+= sample
->period
;
178 hists__inc_nr_events(&evsel
->hists
, PERF_RECORD_SAMPLE
);
184 static int process_sample_event(struct perf_tool
*tool
,
185 union perf_event
*event
,
186 struct perf_sample
*sample
,
187 struct perf_evsel
*evsel
,
188 struct machine
*machine
)
190 struct perf_report
*rep
= container_of(tool
, struct perf_report
, tool
);
191 struct addr_location al
;
193 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
,
194 rep
->annotate_init
) < 0) {
195 fprintf(stderr
, "problem processing %d event, skipping it.\n",
200 if (al
.filtered
|| (rep
->hide_unresolved
&& al
.sym
== NULL
))
203 if (rep
->cpu_list
&& !test_bit(sample
->cpu
, rep
->cpu_bitmap
))
206 if (sort__branch_mode
== 1) {
207 if (perf_report__add_branch_hist_entry(tool
, &al
, sample
,
209 pr_debug("problem adding lbr entry, skipping event\n");
214 al
.map
->dso
->hit
= 1;
216 if (perf_evsel__add_hist_entry(evsel
, &al
, sample
, machine
)) {
217 pr_debug("problem incrementing symbol period, skipping event\n");
224 static int process_read_event(struct perf_tool
*tool
,
225 union perf_event
*event
,
226 struct perf_sample
*sample __used
,
227 struct perf_evsel
*evsel
,
228 struct machine
*machine __used
)
230 struct perf_report
*rep
= container_of(tool
, struct perf_report
, tool
);
232 if (rep
->show_threads
) {
233 const char *name
= evsel
? perf_evsel__name(evsel
) : "unknown";
234 perf_read_values_add_value(&rep
->show_threads_values
,
235 event
->read
.pid
, event
->read
.tid
,
241 dump_printf(": %d %d %s %" PRIu64
"\n", event
->read
.pid
, event
->read
.tid
,
242 evsel
? perf_evsel__name(evsel
) : "FAIL",
248 /* For pipe mode, sample_type is not currently set */
249 static int perf_report__setup_sample_type(struct perf_report
*rep
)
251 struct perf_session
*self
= rep
->session
;
253 if (!self
->fd_pipe
&& !(self
->sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
254 if (sort__has_parent
) {
255 ui__error("Selected --sort parent, but no "
256 "callchain data. Did you call "
257 "'perf record' without -g?\n");
260 if (symbol_conf
.use_callchain
) {
261 ui__error("Selected -g but no callchain data. Did "
262 "you call 'perf record' without -g?\n");
265 } else if (!rep
->dont_use_callchains
&&
266 callchain_param
.mode
!= CHAIN_NONE
&&
267 !symbol_conf
.use_callchain
) {
268 symbol_conf
.use_callchain
= true;
269 if (callchain_register_param(&callchain_param
) < 0) {
270 ui__error("Can't register callchain params.\n");
275 if (sort__branch_mode
== 1) {
276 if (!self
->fd_pipe
&&
277 !(self
->sample_type
& PERF_SAMPLE_BRANCH_STACK
)) {
278 ui__error("Selected -b but no branch data. "
279 "Did you call perf record without -b?\n");
287 extern volatile int session_done
;
289 static void sig_handler(int sig __used
)
294 static size_t hists__fprintf_nr_sample_events(struct hists
*self
,
295 const char *evname
, FILE *fp
)
299 unsigned long nr_samples
= self
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
300 u64 nr_events
= self
->stats
.total_period
;
302 nr_samples
= convert_unit(nr_samples
, &unit
);
303 ret
= fprintf(fp
, "# Samples: %lu%c", nr_samples
, unit
);
305 ret
+= fprintf(fp
, " of event '%s'", evname
);
307 ret
+= fprintf(fp
, "\n# Event count (approx.): %" PRIu64
, nr_events
);
308 return ret
+ fprintf(fp
, "\n#\n");
311 static int perf_evlist__tty_browse_hists(struct perf_evlist
*evlist
,
312 struct perf_report
*rep
,
315 struct perf_evsel
*pos
;
317 list_for_each_entry(pos
, &evlist
->entries
, node
) {
318 struct hists
*hists
= &pos
->hists
;
319 const char *evname
= perf_evsel__name(pos
);
321 hists__fprintf_nr_sample_events(hists
, evname
, stdout
);
322 hists__fprintf(hists
, NULL
, false, true, 0, 0, stdout
);
323 fprintf(stdout
, "\n\n");
326 if (sort_order
== default_sort_order
&&
327 parent_pattern
== default_parent_pattern
) {
328 fprintf(stdout
, "#\n# (%s)\n#\n", help
);
330 if (rep
->show_threads
) {
331 bool style
= !strcmp(rep
->pretty_printing_style
, "raw");
332 perf_read_values_display(stdout
, &rep
->show_threads_values
,
334 perf_read_values_destroy(&rep
->show_threads_values
);
341 static int __cmd_report(struct perf_report
*rep
)
345 struct perf_session
*session
= rep
->session
;
346 struct perf_evsel
*pos
;
347 struct map
*kernel_map
;
348 struct kmap
*kernel_kmap
;
349 const char *help
= "For a higher level overview, try: perf report --sort comm,dso";
351 signal(SIGINT
, sig_handler
);
354 ret
= perf_session__cpu_bitmap(session
, rep
->cpu_list
,
360 if (use_browser
<= 0)
361 perf_session__fprintf_info(session
, stdout
, rep
->show_full_info
);
363 if (rep
->show_threads
)
364 perf_read_values_init(&rep
->show_threads_values
);
366 ret
= perf_report__setup_sample_type(rep
);
370 ret
= perf_session__process_events(session
, &rep
->tool
);
374 kernel_map
= session
->host_machine
.vmlinux_maps
[MAP__FUNCTION
];
375 kernel_kmap
= map__kmap(kernel_map
);
376 if (kernel_map
== NULL
||
377 (kernel_map
->dso
->hit
&&
378 (kernel_kmap
->ref_reloc_sym
== NULL
||
379 kernel_kmap
->ref_reloc_sym
->addr
== 0))) {
381 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
382 "can't be resolved.";
385 const struct dso
*kdso
= kernel_map
->dso
;
386 if (!RB_EMPTY_ROOT(&kdso
->symbols
[MAP__FUNCTION
])) {
387 desc
= "If some relocation was applied (e.g. "
388 "kexec) symbols may be misresolved.";
393 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
394 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
395 "Samples in kernel modules can't be resolved as well.\n\n",
400 perf_session__fprintf_nr_events(session
, stdout
);
405 perf_session__fprintf(session
, stdout
);
408 perf_session__fprintf_dsos(session
, stdout
);
411 list_for_each_entry(pos
, &session
->evlist
->entries
, node
) {
412 struct hists
*hists
= &pos
->hists
;
415 hists
->symbol_filter_str
= rep
->symbol_filter_str
;
417 hists__collapse_resort(hists
);
418 hists__output_resort(hists
);
419 nr_samples
+= hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
422 if (nr_samples
== 0) {
423 ui__error("The %s file has no samples!\n", session
->filename
);
427 if (use_browser
> 0) {
428 if (use_browser
== 1) {
429 perf_evlist__tui_browse_hists(session
->evlist
, help
,
431 } else if (use_browser
== 2) {
432 perf_evlist__gtk_browse_hists(session
->evlist
, help
,
436 perf_evlist__tty_browse_hists(session
->evlist
, rep
, help
);
440 * Speed up the exit process, for large files this can
441 * take quite a while.
443 * XXX Enable this when using valgrind or if we ever
444 * librarize this command.
446 * Also experiment with obstacks to see how much speed
449 * perf_session__delete(session);
455 parse_callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
457 struct perf_report
*rep
= (struct perf_report
*)opt
->value
;
465 rep
->dont_use_callchains
= true;
469 symbol_conf
.use_callchain
= true;
474 tok
= strtok((char *)arg
, ",");
478 /* get the output mode */
479 if (!strncmp(tok
, "graph", strlen(arg
)))
480 callchain_param
.mode
= CHAIN_GRAPH_ABS
;
482 else if (!strncmp(tok
, "flat", strlen(arg
)))
483 callchain_param
.mode
= CHAIN_FLAT
;
485 else if (!strncmp(tok
, "fractal", strlen(arg
)))
486 callchain_param
.mode
= CHAIN_GRAPH_REL
;
488 else if (!strncmp(tok
, "none", strlen(arg
))) {
489 callchain_param
.mode
= CHAIN_NONE
;
490 symbol_conf
.use_callchain
= false;
498 /* get the min percentage */
499 tok
= strtok(NULL
, ",");
503 callchain_param
.min_percent
= strtod(tok
, &endptr
);
507 /* get the print limit */
508 tok2
= strtok(NULL
, ",");
512 if (tok2
[0] != 'c') {
513 callchain_param
.print_limit
= strtoul(tok2
, &endptr
, 0);
514 tok2
= strtok(NULL
, ",");
519 /* get the call chain order */
520 if (!strcmp(tok2
, "caller"))
521 callchain_param
.order
= ORDER_CALLER
;
522 else if (!strcmp(tok2
, "callee"))
523 callchain_param
.order
= ORDER_CALLEE
;
527 if (callchain_register_param(&callchain_param
) < 0) {
528 fprintf(stderr
, "Can't register callchain params\n");
535 parse_branch_mode(const struct option
*opt __used
, const char *str __used
, int unset
)
537 sort__branch_mode
= !unset
;
541 int cmd_report(int argc
, const char **argv
, const char *prefix __used
)
543 struct perf_session
*session
;
545 bool has_br_stack
= false;
547 char callchain_default_opt
[] = "fractal,0.5,callee";
548 const char * const report_usage
[] = {
549 "perf report [<options>]",
552 struct perf_report report
= {
554 .sample
= process_sample_event
,
555 .mmap
= perf_event__process_mmap
,
556 .comm
= perf_event__process_comm
,
557 .exit
= perf_event__process_task
,
558 .fork
= perf_event__process_task
,
559 .lost
= perf_event__process_lost
,
560 .read
= process_read_event
,
561 .attr
= perf_event__process_attr
,
562 .event_type
= perf_event__process_event_type
,
563 .tracing_data
= perf_event__process_tracing_data
,
564 .build_id
= perf_event__process_build_id
,
565 .ordered_samples
= true,
566 .ordering_requires_timestamps
= true,
568 .pretty_printing_style
= "normal",
570 const struct option options
[] = {
571 OPT_STRING('i', "input", &report
.input_name
, "file",
573 OPT_INCR('v', "verbose", &verbose
,
574 "be more verbose (show symbol address, etc)"),
575 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
576 "dump raw trace in ASCII"),
577 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
578 "file", "vmlinux pathname"),
579 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
580 "file", "kallsyms pathname"),
581 OPT_BOOLEAN('f', "force", &report
.force
, "don't complain, do it"),
582 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
583 "load module symbols - WARNING: use only with -k and LIVE kernel"),
584 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
585 "Show a column with the number of samples"),
586 OPT_BOOLEAN('T', "threads", &report
.show_threads
,
587 "Show per-thread event counters"),
588 OPT_STRING(0, "pretty", &report
.pretty_printing_style
, "key",
589 "pretty printing style key: normal raw"),
590 OPT_BOOLEAN(0, "tui", &report
.use_tui
, "Use the TUI interface"),
591 OPT_BOOLEAN(0, "gtk", &report
.use_gtk
, "Use the GTK2 interface"),
592 OPT_BOOLEAN(0, "stdio", &report
.use_stdio
,
593 "Use the stdio interface"),
594 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
595 "sort by key(s): pid, comm, dso, symbol, parent, dso_to,"
596 " dso_from, symbol_to, symbol_from, mispredict"),
597 OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf
.show_cpu_utilization
,
598 "Show sample percentage for different cpu modes"),
599 OPT_STRING('p', "parent", &parent_pattern
, "regex",
600 "regex filter to identify parent, see: '--sort parent'"),
601 OPT_BOOLEAN('x', "exclude-other", &symbol_conf
.exclude_other
,
602 "Only display entries with parent-match"),
603 OPT_CALLBACK_DEFAULT('g', "call-graph", &report
, "output_type,min_percent[,print_limit],call_order",
604 "Display callchains using output_type (graph, flat, fractal, or none) , min percent threshold, optional print limit and callchain order. "
605 "Default: fractal,0.5,callee", &parse_callchain_opt
, callchain_default_opt
),
606 OPT_BOOLEAN('G', "inverted", &report
.inverted_callchain
,
607 "alias for inverted call graph"),
608 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
609 "only consider symbols in these dsos"),
610 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
611 "only consider symbols in these comms"),
612 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
613 "only consider these symbols"),
614 OPT_STRING(0, "symbol-filter", &report
.symbol_filter_str
, "filter",
615 "only show symbols that (partially) match with this filter"),
616 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
618 "don't try to adjust column width, use these fixed values"),
619 OPT_STRING('t', "field-separator", &symbol_conf
.field_sep
, "separator",
620 "separator for columns, no spaces will be added between "
621 "columns '.' is reserved."),
622 OPT_BOOLEAN('U', "hide-unresolved", &report
.hide_unresolved
,
623 "Only display entries resolved to a symbol"),
624 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
625 "Look for files with symbols relative to this directory"),
626 OPT_STRING('C', "cpu", &report
.cpu_list
, "cpu",
627 "list of cpus to profile"),
628 OPT_BOOLEAN('I', "show-info", &report
.show_full_info
,
629 "Display extended information about perf.data file"),
630 OPT_BOOLEAN(0, "source", &symbol_conf
.annotate_src
,
631 "Interleave source code with assembly code (default)"),
632 OPT_BOOLEAN(0, "asm-raw", &symbol_conf
.annotate_asm_raw
,
633 "Display raw encoding of assembly instructions (default)"),
634 OPT_STRING('M', "disassembler-style", &disassembler_style
, "disassembler style",
635 "Specify disassembler style (e.g. -M intel for intel syntax)"),
636 OPT_BOOLEAN(0, "show-total-period", &symbol_conf
.show_total_period
,
637 "Show a column with the sum of periods"),
638 OPT_CALLBACK_NOOPT('b', "branch-stack", &sort__branch_mode
, "",
639 "use branch records for histogram filling", parse_branch_mode
),
643 argc
= parse_options(argc
, argv
, options
, report_usage
, 0);
645 if (report
.use_stdio
)
647 else if (report
.use_tui
)
649 else if (report
.use_gtk
)
652 if (report
.inverted_callchain
)
653 callchain_param
.order
= ORDER_CALLER
;
655 if (!report
.input_name
|| !strlen(report
.input_name
)) {
656 if (!fstat(STDIN_FILENO
, &st
) && S_ISFIFO(st
.st_mode
))
657 report
.input_name
= "-";
659 report
.input_name
= "perf.data";
661 session
= perf_session__new(report
.input_name
, O_RDONLY
,
662 report
.force
, false, &report
.tool
);
666 report
.session
= session
;
668 has_br_stack
= perf_header__has_feat(&session
->header
,
669 HEADER_BRANCH_STACK
);
671 if (sort__branch_mode
== -1 && has_br_stack
)
672 sort__branch_mode
= 1;
674 /* sort__branch_mode could be 0 if --no-branch-stack */
675 if (sort__branch_mode
== 1) {
677 * if no sort_order is provided, then specify
678 * branch-mode specific order
680 if (sort_order
== default_sort_order
)
681 sort_order
= "comm,dso_from,symbol_from,"
686 if (strcmp(report
.input_name
, "-") != 0)
692 * Only in the newt browser we are doing integrated annotation,
693 * so don't allocate extra space that won't be used in the stdio
696 if (use_browser
> 0) {
697 symbol_conf
.priv_size
= sizeof(struct annotation
);
698 report
.annotate_init
= symbol__annotate_init
;
700 * For searching by name on the "Browse map details".
701 * providing it only in verbose mode not to bloat too
702 * much struct symbol.
706 * XXX: Need to provide a less kludgy way to ask for
707 * more space per symbol, the u32 is for the index on
709 * See symbol__browser_index.
711 symbol_conf
.priv_size
+= sizeof(u32
);
712 symbol_conf
.sort_by_name
= true;
716 if (symbol__init() < 0)
719 setup_sorting(report_usage
, options
);
721 if (parent_pattern
!= default_parent_pattern
) {
722 if (sort_dimension__add("parent") < 0)
726 * Only show the parent fields if we explicitly
727 * sort that way. If we only use parent machinery
728 * for filtering, we don't want it.
730 if (!strstr(sort_order
, "parent"))
731 sort_parent
.elide
= 1;
733 symbol_conf
.exclude_other
= false;
737 * Special case: if there's an argument left then assume that
738 * it's a symbol filter:
741 usage_with_options(report_usage
, options
);
743 report
.symbol_filter_str
= argv
[0];
746 sort_entry__setup_elide(&sort_comm
, symbol_conf
.comm_list
, "comm", stdout
);
748 if (sort__branch_mode
== 1) {
749 sort_entry__setup_elide(&sort_dso_from
, symbol_conf
.dso_from_list
, "dso_from", stdout
);
750 sort_entry__setup_elide(&sort_dso_to
, symbol_conf
.dso_to_list
, "dso_to", stdout
);
751 sort_entry__setup_elide(&sort_sym_from
, symbol_conf
.sym_from_list
, "sym_from", stdout
);
752 sort_entry__setup_elide(&sort_sym_to
, symbol_conf
.sym_to_list
, "sym_to", stdout
);
754 sort_entry__setup_elide(&sort_dso
, symbol_conf
.dso_list
, "dso", stdout
);
755 sort_entry__setup_elide(&sort_sym
, symbol_conf
.sym_list
, "symbol", stdout
);
758 ret
= __cmd_report(&report
);
760 perf_session__delete(session
);