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"
11 #include "util/cache.h"
13 #include "util/annotate.h"
14 #include "util/color.h"
15 #include <linux/list.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 <subcmd/parse-options.h>
31 #include <subcmd/exec-cmd.h>
32 #include "util/parse-events.h"
34 #include "util/thread.h"
35 #include "util/sort.h"
36 #include "util/hist.h"
37 #include "util/data.h"
38 #include "arch/common.h"
40 #include "util/auxtrace.h"
43 #include <linux/bitmap.h>
46 struct perf_tool tool
;
47 struct perf_session
*session
;
48 bool use_tui
, use_gtk
, use_stdio
;
49 bool dont_use_callchains
;
52 bool inverted_callchain
;
56 bool nonany_branch_mode
;
58 struct perf_read_values show_threads_values
;
59 const char *pretty_printing_style
;
61 const char *symbol_filter_str
;
66 DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
69 static int report__config(const char *var
, const char *value
, void *cb
)
71 struct report
*rep
= cb
;
73 if (!strcmp(var
, "report.group")) {
74 symbol_conf
.event_group
= perf_config_bool(var
, value
);
77 if (!strcmp(var
, "report.percent-limit")) {
78 double pcnt
= strtof(value
, NULL
);
80 rep
->min_percent
= pcnt
;
81 callchain_param
.min_percent
= pcnt
;
84 if (!strcmp(var
, "report.children")) {
85 symbol_conf
.cumulate_callchain
= perf_config_bool(var
, value
);
88 if (!strcmp(var
, "report.queue-size")) {
89 rep
->queue_size
= perf_config_u64(var
, value
);
96 static int hist_iter__report_callback(struct hist_entry_iter
*iter
,
97 struct addr_location
*al
, bool single
,
101 struct report
*rep
= arg
;
102 struct hist_entry
*he
= iter
->he
;
103 struct perf_evsel
*evsel
= iter
->evsel
;
105 struct branch_info
*bi
;
107 if (!ui__has_annotation())
110 hist__account_cycles(iter
->sample
->branch_stack
, al
, iter
->sample
,
111 rep
->nonany_branch_mode
);
113 if (sort__mode
== SORT_MODE__BRANCH
) {
114 bi
= he
->branch_info
;
115 err
= addr_map_symbol__inc_samples(&bi
->from
, evsel
->idx
);
119 err
= addr_map_symbol__inc_samples(&bi
->to
, evsel
->idx
);
121 } else if (rep
->mem_mode
) {
123 err
= addr_map_symbol__inc_samples(&mi
->daddr
, evsel
->idx
);
127 err
= hist_entry__inc_addr_samples(he
, evsel
->idx
, al
->addr
);
129 } else if (symbol_conf
.cumulate_callchain
) {
131 err
= hist_entry__inc_addr_samples(he
, evsel
->idx
,
134 err
= hist_entry__inc_addr_samples(he
, evsel
->idx
, al
->addr
);
141 static int process_sample_event(struct perf_tool
*tool
,
142 union perf_event
*event
,
143 struct perf_sample
*sample
,
144 struct perf_evsel
*evsel
,
145 struct machine
*machine
)
147 struct report
*rep
= container_of(tool
, struct report
, tool
);
148 struct addr_location al
;
149 struct hist_entry_iter iter
= {
152 .hide_unresolved
= symbol_conf
.hide_unresolved
,
153 .add_entry_cb
= hist_iter__report_callback
,
157 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
) < 0) {
158 pr_debug("problem processing %d event, skipping it.\n",
163 if (symbol_conf
.hide_unresolved
&& al
.sym
== NULL
)
166 if (rep
->cpu_list
&& !test_bit(sample
->cpu
, rep
->cpu_bitmap
))
169 if (sort__mode
== SORT_MODE__BRANCH
) {
171 * A non-synthesized event might not have a branch stack if
172 * branch stacks have been synthesized (using itrace options).
174 if (!sample
->branch_stack
)
176 iter
.ops
= &hist_iter_branch
;
177 } else if (rep
->mem_mode
) {
178 iter
.ops
= &hist_iter_mem
;
179 } else if (symbol_conf
.cumulate_callchain
) {
180 iter
.ops
= &hist_iter_cumulative
;
182 iter
.ops
= &hist_iter_normal
;
186 al
.map
->dso
->hit
= 1;
188 ret
= hist_entry_iter__add(&iter
, &al
, rep
->max_stack
, rep
);
190 pr_debug("problem adding hist entry, skipping event\n");
192 addr_location__put(&al
);
196 static int process_read_event(struct perf_tool
*tool
,
197 union perf_event
*event
,
198 struct perf_sample
*sample __maybe_unused
,
199 struct perf_evsel
*evsel
,
200 struct machine
*machine __maybe_unused
)
202 struct report
*rep
= container_of(tool
, struct report
, tool
);
204 if (rep
->show_threads
) {
205 const char *name
= evsel
? perf_evsel__name(evsel
) : "unknown";
206 perf_read_values_add_value(&rep
->show_threads_values
,
207 event
->read
.pid
, event
->read
.tid
,
213 dump_printf(": %d %d %s %" PRIu64
"\n", event
->read
.pid
, event
->read
.tid
,
214 evsel
? perf_evsel__name(evsel
) : "FAIL",
220 /* For pipe mode, sample_type is not currently set */
221 static int report__setup_sample_type(struct report
*rep
)
223 struct perf_session
*session
= rep
->session
;
224 u64 sample_type
= perf_evlist__combined_sample_type(session
->evlist
);
225 bool is_pipe
= perf_data_file__is_pipe(session
->file
);
227 if (session
->itrace_synth_opts
->callchain
||
229 perf_header__has_feat(&session
->header
, HEADER_AUXTRACE
) &&
230 !session
->itrace_synth_opts
->set
))
231 sample_type
|= PERF_SAMPLE_CALLCHAIN
;
233 if (session
->itrace_synth_opts
->last_branch
)
234 sample_type
|= PERF_SAMPLE_BRANCH_STACK
;
236 if (!is_pipe
&& !(sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
237 if (sort__has_parent
) {
238 ui__error("Selected --sort parent, but no "
239 "callchain data. Did you call "
240 "'perf record' without -g?\n");
243 if (symbol_conf
.use_callchain
) {
244 ui__error("Selected -g or --branch-history but no "
245 "callchain data. Did\n"
246 "you call 'perf record' without -g?\n");
249 } else if (!rep
->dont_use_callchains
&&
250 callchain_param
.mode
!= CHAIN_NONE
&&
251 !symbol_conf
.use_callchain
) {
252 symbol_conf
.use_callchain
= true;
253 if (callchain_register_param(&callchain_param
) < 0) {
254 ui__error("Can't register callchain params.\n");
259 if (symbol_conf
.cumulate_callchain
) {
260 /* Silently ignore if callchain is missing */
261 if (!(sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
262 symbol_conf
.cumulate_callchain
= false;
263 perf_hpp__cancel_cumulate();
267 if (sort__mode
== SORT_MODE__BRANCH
) {
269 !(sample_type
& PERF_SAMPLE_BRANCH_STACK
)) {
270 ui__error("Selected -b but no branch data. "
271 "Did you call perf record without -b?\n");
276 if (symbol_conf
.use_callchain
|| symbol_conf
.cumulate_callchain
) {
277 if ((sample_type
& PERF_SAMPLE_REGS_USER
) &&
278 (sample_type
& PERF_SAMPLE_STACK_USER
))
279 callchain_param
.record_mode
= CALLCHAIN_DWARF
;
280 else if (sample_type
& PERF_SAMPLE_BRANCH_STACK
)
281 callchain_param
.record_mode
= CALLCHAIN_LBR
;
283 callchain_param
.record_mode
= CALLCHAIN_FP
;
286 /* ??? handle more cases than just ANY? */
287 if (!(perf_evlist__combined_branch_type(session
->evlist
) &
288 PERF_SAMPLE_BRANCH_ANY
))
289 rep
->nonany_branch_mode
= true;
294 static void sig_handler(int sig __maybe_unused
)
299 static size_t hists__fprintf_nr_sample_events(struct hists
*hists
, struct report
*rep
,
300 const char *evname
, FILE *fp
)
304 unsigned long nr_samples
= hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
305 u64 nr_events
= hists
->stats
.total_period
;
306 struct perf_evsel
*evsel
= hists_to_evsel(hists
);
308 size_t size
= sizeof(buf
);
309 int socked_id
= hists
->socket_filter
;
311 if (symbol_conf
.filter_relative
) {
312 nr_samples
= hists
->stats
.nr_non_filtered_samples
;
313 nr_events
= hists
->stats
.total_non_filtered_period
;
316 if (perf_evsel__is_group_event(evsel
)) {
317 struct perf_evsel
*pos
;
319 perf_evsel__group_desc(evsel
, buf
, size
);
322 for_each_group_member(pos
, evsel
) {
323 const struct hists
*pos_hists
= evsel__hists(pos
);
325 if (symbol_conf
.filter_relative
) {
326 nr_samples
+= pos_hists
->stats
.nr_non_filtered_samples
;
327 nr_events
+= pos_hists
->stats
.total_non_filtered_period
;
329 nr_samples
+= pos_hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
330 nr_events
+= pos_hists
->stats
.total_period
;
335 nr_samples
= convert_unit(nr_samples
, &unit
);
336 ret
= fprintf(fp
, "# Samples: %lu%c", nr_samples
, unit
);
338 ret
+= fprintf(fp
, " of event '%s'", evname
);
340 if (symbol_conf
.show_ref_callgraph
&&
341 strstr(evname
, "call-graph=no")) {
342 ret
+= fprintf(fp
, ", show reference callgraph");
346 ret
+= fprintf(fp
, "\n# Total weight : %" PRIu64
, nr_events
);
347 ret
+= fprintf(fp
, "\n# Sort order : %s", sort_order
? : default_mem_sort_order
);
349 ret
+= fprintf(fp
, "\n# Event count (approx.): %" PRIu64
, nr_events
);
352 ret
+= fprintf(fp
, "\n# Processor Socket: %d", socked_id
);
354 return ret
+ fprintf(fp
, "\n#\n");
357 static int perf_evlist__tty_browse_hists(struct perf_evlist
*evlist
,
361 struct perf_evsel
*pos
;
363 fprintf(stdout
, "#\n# Total Lost Samples: %" PRIu64
"\n#\n", evlist
->stats
.total_lost_samples
);
364 evlist__for_each(evlist
, pos
) {
365 struct hists
*hists
= evsel__hists(pos
);
366 const char *evname
= perf_evsel__name(pos
);
368 if (symbol_conf
.event_group
&&
369 !perf_evsel__is_group_leader(pos
))
372 hists__fprintf_nr_sample_events(hists
, rep
, evname
, stdout
);
373 hists__fprintf(hists
, true, 0, 0, rep
->min_percent
, stdout
);
374 fprintf(stdout
, "\n\n");
377 if (sort_order
== NULL
&&
378 parent_pattern
== default_parent_pattern
)
379 fprintf(stdout
, "#\n# (%s)\n#\n", help
);
381 if (rep
->show_threads
) {
382 bool style
= !strcmp(rep
->pretty_printing_style
, "raw");
383 perf_read_values_display(stdout
, &rep
->show_threads_values
,
385 perf_read_values_destroy(&rep
->show_threads_values
);
391 static void report__warn_kptr_restrict(const struct report
*rep
)
393 struct map
*kernel_map
= machine__kernel_map(&rep
->session
->machines
.host
);
394 struct kmap
*kernel_kmap
= kernel_map
? map__kmap(kernel_map
) : NULL
;
396 if (kernel_map
== NULL
||
397 (kernel_map
->dso
->hit
&&
398 (kernel_kmap
->ref_reloc_sym
== NULL
||
399 kernel_kmap
->ref_reloc_sym
->addr
== 0))) {
401 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
402 "can't be resolved.";
405 const struct dso
*kdso
= kernel_map
->dso
;
406 if (!RB_EMPTY_ROOT(&kdso
->symbols
[MAP__FUNCTION
])) {
407 desc
= "If some relocation was applied (e.g. "
408 "kexec) symbols may be misresolved.";
413 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
414 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
415 "Samples in kernel modules can't be resolved as well.\n\n",
420 static int report__gtk_browse_hists(struct report
*rep
, const char *help
)
422 int (*hist_browser
)(struct perf_evlist
*evlist
, const char *help
,
423 struct hist_browser_timer
*timer
, float min_pcnt
);
425 hist_browser
= dlsym(perf_gtk_handle
, "perf_evlist__gtk_browse_hists");
427 if (hist_browser
== NULL
) {
428 ui__error("GTK browser not found!\n");
432 return hist_browser(rep
->session
->evlist
, help
, NULL
, rep
->min_percent
);
435 static int report__browse_hists(struct report
*rep
)
438 struct perf_session
*session
= rep
->session
;
439 struct perf_evlist
*evlist
= session
->evlist
;
440 const char *help
= perf_tip(system_path(TIPDIR
));
443 /* fallback for people who don't install perf ;-) */
444 help
= perf_tip(DOCDIR
);
446 help
= "Cannot load tips.txt file, please install perf!";
449 switch (use_browser
) {
451 ret
= perf_evlist__tui_browse_hists(evlist
, help
, NULL
,
453 &session
->header
.env
);
455 * Usually "ret" is the last pressed key, and we only
456 * care if the key notifies us to switch data file.
458 if (ret
!= K_SWITCH_INPUT_DATA
)
462 ret
= report__gtk_browse_hists(rep
, help
);
465 ret
= perf_evlist__tty_browse_hists(evlist
, rep
, help
);
472 static int report__collapse_hists(struct report
*rep
)
474 struct ui_progress prog
;
475 struct perf_evsel
*pos
;
478 ui_progress__init(&prog
, rep
->nr_entries
, "Merging related events...");
480 evlist__for_each(rep
->session
->evlist
, pos
) {
481 struct hists
*hists
= evsel__hists(pos
);
484 hists
->symbol_filter_str
= rep
->symbol_filter_str
;
486 hists
->socket_filter
= rep
->socket_filter
;
488 ret
= hists__collapse_resort(hists
, &prog
);
492 /* Non-group events are considered as leader */
493 if (symbol_conf
.event_group
&&
494 !perf_evsel__is_group_leader(pos
)) {
495 struct hists
*leader_hists
= evsel__hists(pos
->leader
);
497 hists__match(leader_hists
, hists
);
498 hists__link(leader_hists
, hists
);
502 ui_progress__finish();
506 static void report__output_resort(struct report
*rep
)
508 struct ui_progress prog
;
509 struct perf_evsel
*pos
;
511 ui_progress__init(&prog
, rep
->nr_entries
, "Sorting events for output...");
513 evlist__for_each(rep
->session
->evlist
, pos
)
514 perf_evsel__output_resort(pos
, &prog
);
516 ui_progress__finish();
519 static int __cmd_report(struct report
*rep
)
522 struct perf_session
*session
= rep
->session
;
523 struct perf_evsel
*pos
;
524 struct perf_data_file
*file
= session
->file
;
526 signal(SIGINT
, sig_handler
);
529 ret
= perf_session__cpu_bitmap(session
, rep
->cpu_list
,
532 ui__error("failed to set cpu bitmap\n");
537 if (rep
->show_threads
)
538 perf_read_values_init(&rep
->show_threads_values
);
540 ret
= report__setup_sample_type(rep
);
542 /* report__setup_sample_type() already showed error message */
546 ret
= perf_session__process_events(session
);
548 ui__error("failed to process sample\n");
552 report__warn_kptr_restrict(rep
);
554 evlist__for_each(session
->evlist
, pos
)
555 rep
->nr_entries
+= evsel__hists(pos
)->nr_entries
;
557 if (use_browser
== 0) {
559 perf_session__fprintf(session
, stdout
);
562 perf_session__fprintf_dsos(session
, stdout
);
565 perf_session__fprintf_nr_events(session
, stdout
);
566 perf_evlist__fprintf_nr_events(session
->evlist
, stdout
);
571 ret
= report__collapse_hists(rep
);
573 ui__error("failed to process hist entry\n");
581 * recalculate number of entries after collapsing since it
582 * might be changed during the collapse phase.
585 evlist__for_each(session
->evlist
, pos
)
586 rep
->nr_entries
+= evsel__hists(pos
)->nr_entries
;
588 if (rep
->nr_entries
== 0) {
589 ui__error("The %s file has no samples!\n", file
->path
);
593 report__output_resort(rep
);
595 return report__browse_hists(rep
);
599 report_parse_callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
601 struct report
*rep
= (struct report
*)opt
->value
;
607 rep
->dont_use_callchains
= true;
611 return parse_callchain_report_opt(arg
);
615 report_parse_ignore_callees_opt(const struct option
*opt __maybe_unused
,
616 const char *arg
, int unset __maybe_unused
)
619 int err
= regcomp(&ignore_callees_regex
, arg
, REG_EXTENDED
);
622 regerror(err
, &ignore_callees_regex
, buf
, sizeof(buf
));
623 pr_err("Invalid --ignore-callees regex: %s\n%s", arg
, buf
);
626 have_ignore_callees
= 1;
633 parse_branch_mode(const struct option
*opt __maybe_unused
,
634 const char *str __maybe_unused
, int unset
)
636 int *branch_mode
= opt
->value
;
638 *branch_mode
= !unset
;
643 parse_percent_limit(const struct option
*opt
, const char *str
,
644 int unset __maybe_unused
)
646 struct report
*rep
= opt
->value
;
647 double pcnt
= strtof(str
, NULL
);
649 rep
->min_percent
= pcnt
;
650 callchain_param
.min_percent
= pcnt
;
654 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
656 const char report_callchain_help
[] = "Display call graph (stack chain/backtrace):\n\n"
657 CALLCHAIN_REPORT_HELP
658 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT
;
660 int cmd_report(int argc
, const char **argv
, const char *prefix __maybe_unused
)
662 struct perf_session
*session
;
663 struct itrace_synth_opts itrace_synth_opts
= { .set
= 0, };
665 bool has_br_stack
= false;
666 int branch_mode
= -1;
667 bool branch_call_mode
= false;
668 char callchain_default_opt
[] = CALLCHAIN_DEFAULT_OPT
;
669 const char * const report_usage
[] = {
670 "perf report [<options>]",
673 struct report report
= {
675 .sample
= process_sample_event
,
676 .mmap
= perf_event__process_mmap
,
677 .mmap2
= perf_event__process_mmap2
,
678 .comm
= perf_event__process_comm
,
679 .exit
= perf_event__process_exit
,
680 .fork
= perf_event__process_fork
,
681 .lost
= perf_event__process_lost
,
682 .read
= process_read_event
,
683 .attr
= perf_event__process_attr
,
684 .tracing_data
= perf_event__process_tracing_data
,
685 .build_id
= perf_event__process_build_id
,
686 .id_index
= perf_event__process_id_index
,
687 .auxtrace_info
= perf_event__process_auxtrace_info
,
688 .auxtrace
= perf_event__process_auxtrace
,
689 .ordered_events
= true,
690 .ordering_requires_timestamps
= true,
692 .max_stack
= PERF_MAX_STACK_DEPTH
,
693 .pretty_printing_style
= "normal",
696 const struct option options
[] = {
697 OPT_STRING('i', "input", &input_name
, "file",
699 OPT_INCR('v', "verbose", &verbose
,
700 "be more verbose (show symbol address, etc)"),
701 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
702 "dump raw trace in ASCII"),
703 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
704 "file", "vmlinux pathname"),
705 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
706 "file", "kallsyms pathname"),
707 OPT_BOOLEAN('f', "force", &symbol_conf
.force
, "don't complain, do it"),
708 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
709 "load module symbols - WARNING: use only with -k and LIVE kernel"),
710 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
711 "Show a column with the number of samples"),
712 OPT_BOOLEAN('T', "threads", &report
.show_threads
,
713 "Show per-thread event counters"),
714 OPT_STRING(0, "pretty", &report
.pretty_printing_style
, "key",
715 "pretty printing style key: normal raw"),
716 OPT_BOOLEAN(0, "tui", &report
.use_tui
, "Use the TUI interface"),
717 OPT_BOOLEAN(0, "gtk", &report
.use_gtk
, "Use the GTK2 interface"),
718 OPT_BOOLEAN(0, "stdio", &report
.use_stdio
,
719 "Use the stdio interface"),
720 OPT_BOOLEAN(0, "header", &report
.header
, "Show data header."),
721 OPT_BOOLEAN(0, "header-only", &report
.header_only
,
722 "Show only data header."),
723 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
724 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
725 " Please refer the man page for the complete list."),
726 OPT_STRING('F', "fields", &field_order
, "key[,keys...]",
727 "output field(s): overhead, period, sample plus all of sort keys"),
728 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf
.show_cpu_utilization
,
729 "Show sample percentage for different cpu modes"),
730 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf
.show_cpu_utilization
,
731 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN
),
732 OPT_STRING('p', "parent", &parent_pattern
, "regex",
733 "regex filter to identify parent, see: '--sort parent'"),
734 OPT_BOOLEAN('x', "exclude-other", &symbol_conf
.exclude_other
,
735 "Only display entries with parent-match"),
736 OPT_CALLBACK_DEFAULT('g', "call-graph", &report
,
737 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
738 report_callchain_help
, &report_parse_callchain_opt
,
739 callchain_default_opt
),
740 OPT_BOOLEAN(0, "children", &symbol_conf
.cumulate_callchain
,
741 "Accumulate callchains of children and show total overhead as well"),
742 OPT_INTEGER(0, "max-stack", &report
.max_stack
,
743 "Set the maximum stack depth when parsing the callchain, "
744 "anything beyond the specified depth will be ignored. "
745 "Default: " __stringify(PERF_MAX_STACK_DEPTH
)),
746 OPT_BOOLEAN('G', "inverted", &report
.inverted_callchain
,
747 "alias for inverted call graph"),
748 OPT_CALLBACK(0, "ignore-callees", NULL
, "regex",
749 "ignore callees of these functions in call graphs",
750 report_parse_ignore_callees_opt
),
751 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
752 "only consider symbols in these dsos"),
753 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
754 "only consider symbols in these comms"),
755 OPT_STRING(0, "pid", &symbol_conf
.pid_list_str
, "pid[,pid...]",
756 "only consider symbols in these pids"),
757 OPT_STRING(0, "tid", &symbol_conf
.tid_list_str
, "tid[,tid...]",
758 "only consider symbols in these tids"),
759 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
760 "only consider these symbols"),
761 OPT_STRING(0, "symbol-filter", &report
.symbol_filter_str
, "filter",
762 "only show symbols that (partially) match with this filter"),
763 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
765 "don't try to adjust column width, use these fixed values"),
766 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf
.field_sep
, "separator",
767 "separator for columns, no spaces will be added between "
768 "columns '.' is reserved."),
769 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf
.hide_unresolved
,
770 "Only display entries resolved to a symbol"),
771 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
772 "Look for files with symbols relative to this directory"),
773 OPT_STRING('C', "cpu", &report
.cpu_list
, "cpu",
774 "list of cpus to profile"),
775 OPT_BOOLEAN('I', "show-info", &report
.show_full_info
,
776 "Display extended information about perf.data file"),
777 OPT_BOOLEAN(0, "source", &symbol_conf
.annotate_src
,
778 "Interleave source code with assembly code (default)"),
779 OPT_BOOLEAN(0, "asm-raw", &symbol_conf
.annotate_asm_raw
,
780 "Display raw encoding of assembly instructions (default)"),
781 OPT_STRING('M', "disassembler-style", &disassembler_style
, "disassembler style",
782 "Specify disassembler style (e.g. -M intel for intel syntax)"),
783 OPT_BOOLEAN(0, "show-total-period", &symbol_conf
.show_total_period
,
784 "Show a column with the sum of periods"),
785 OPT_BOOLEAN(0, "group", &symbol_conf
.event_group
,
786 "Show event group information together"),
787 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode
, "",
788 "use branch records for per branch histogram filling",
790 OPT_BOOLEAN(0, "branch-history", &branch_call_mode
,
791 "add last branch records to call history"),
792 OPT_STRING(0, "objdump", &objdump_path
, "path",
793 "objdump binary to use for disassembly and annotations"),
794 OPT_BOOLEAN(0, "demangle", &symbol_conf
.demangle
,
795 "Disable symbol demangling"),
796 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf
.demangle_kernel
,
797 "Enable kernel symbol demangling"),
798 OPT_BOOLEAN(0, "mem-mode", &report
.mem_mode
, "mem access profile"),
799 OPT_CALLBACK(0, "percent-limit", &report
, "percent",
800 "Don't show entries under that percent", parse_percent_limit
),
801 OPT_CALLBACK(0, "percentage", NULL
, "relative|absolute",
802 "how to display percentage of filtered entries", parse_filter_percentage
),
803 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts
, NULL
, "opts",
804 "Instruction Tracing options",
805 itrace_parse_synth_opts
),
806 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename
,
807 "Show full source file name path for source lines"),
808 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf
.show_ref_callgraph
,
809 "Show callgraph from reference event"),
810 OPT_INTEGER(0, "socket-filter", &report
.socket_filter
,
811 "only show processor socket that match with this filter"),
812 OPT_BOOLEAN(0, "raw-trace", &symbol_conf
.raw_trace
,
813 "Show raw trace event output (do not use print fmt or plugins)"),
814 OPT_BOOLEAN(0, "hierarchy", &symbol_conf
.report_hierarchy
,
815 "Show entries in a hierarchy"),
818 struct perf_data_file file
= {
819 .mode
= PERF_DATA_MODE_READ
,
821 int ret
= hists__init();
826 perf_config(report__config
, &report
);
828 argc
= parse_options(argc
, argv
, options
, report_usage
, 0);
831 * Special case: if there's an argument left then assume that
832 * it's a symbol filter:
835 usage_with_options(report_usage
, options
);
837 report
.symbol_filter_str
= argv
[0];
840 if (symbol_conf
.vmlinux_name
&&
841 access(symbol_conf
.vmlinux_name
, R_OK
)) {
842 pr_err("Invalid file: %s\n", symbol_conf
.vmlinux_name
);
845 if (symbol_conf
.kallsyms_name
&&
846 access(symbol_conf
.kallsyms_name
, R_OK
)) {
847 pr_err("Invalid file: %s\n", symbol_conf
.kallsyms_name
);
851 if (report
.use_stdio
)
853 else if (report
.use_tui
)
855 else if (report
.use_gtk
)
858 if (report
.inverted_callchain
)
859 callchain_param
.order
= ORDER_CALLER
;
860 if (symbol_conf
.cumulate_callchain
&& !callchain_param
.order_set
)
861 callchain_param
.order
= ORDER_CALLER
;
863 if (itrace_synth_opts
.callchain
&&
864 (int)itrace_synth_opts
.callchain_sz
> report
.max_stack
)
865 report
.max_stack
= itrace_synth_opts
.callchain_sz
;
867 if (!input_name
|| !strlen(input_name
)) {
868 if (!fstat(STDIN_FILENO
, &st
) && S_ISFIFO(st
.st_mode
))
871 input_name
= "perf.data";
874 file
.path
= input_name
;
875 file
.force
= symbol_conf
.force
;
878 session
= perf_session__new(&file
, false, &report
.tool
);
882 if (report
.queue_size
) {
883 ordered_events__set_alloc_size(&session
->ordered_events
,
887 session
->itrace_synth_opts
= &itrace_synth_opts
;
889 report
.session
= session
;
891 has_br_stack
= perf_header__has_feat(&session
->header
,
892 HEADER_BRANCH_STACK
);
894 if (itrace_synth_opts
.last_branch
)
898 * Branch mode is a tristate:
899 * -1 means default, so decide based on the file having branch data.
900 * 0/1 means the user chose a mode.
902 if (((branch_mode
== -1 && has_br_stack
) || branch_mode
== 1) &&
904 sort__mode
= SORT_MODE__BRANCH
;
905 symbol_conf
.cumulate_callchain
= false;
907 if (branch_call_mode
) {
908 callchain_param
.key
= CCKEY_ADDRESS
;
909 callchain_param
.branch_callstack
= 1;
910 symbol_conf
.use_callchain
= true;
911 callchain_register_param(&callchain_param
);
912 if (sort_order
== NULL
)
913 sort_order
= "srcline,symbol,dso";
916 if (report
.mem_mode
) {
917 if (sort__mode
== SORT_MODE__BRANCH
) {
918 pr_err("branch and mem mode incompatible\n");
921 sort__mode
= SORT_MODE__MEMORY
;
922 symbol_conf
.cumulate_callchain
= false;
925 if (symbol_conf
.report_hierarchy
) {
926 /* disable incompatible options */
927 symbol_conf
.event_group
= false;
928 symbol_conf
.cumulate_callchain
= false;
931 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
932 parse_options_usage(report_usage
, options
, "F", 1);
933 parse_options_usage(NULL
, options
, "hierarchy", 0);
937 sort__need_collapse
= true;
940 /* Force tty output for header output and per-thread stat. */
941 if (report
.header
|| report
.header_only
|| report
.show_threads
)
944 if (strcmp(input_name
, "-") != 0)
949 if (setup_sorting(session
->evlist
) < 0) {
951 parse_options_usage(report_usage
, options
, "s", 1);
953 parse_options_usage(sort_order
? NULL
: report_usage
,
958 if (report
.header
|| report
.header_only
) {
959 perf_session__fprintf_info(session
, stdout
,
960 report
.show_full_info
);
961 if (report
.header_only
) {
965 } else if (use_browser
== 0) {
966 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
971 * Only in the TUI browser we are doing integrated annotation,
972 * so don't allocate extra space that won't be used in the stdio
975 if (ui__has_annotation()) {
976 symbol_conf
.priv_size
= sizeof(struct annotation
);
977 machines__set_symbol_filter(&session
->machines
,
978 symbol__annotate_init
);
980 * For searching by name on the "Browse map details".
981 * providing it only in verbose mode not to bloat too
982 * much struct symbol.
986 * XXX: Need to provide a less kludgy way to ask for
987 * more space per symbol, the u32 is for the index on
989 * See symbol__browser_index.
991 symbol_conf
.priv_size
+= sizeof(u32
);
992 symbol_conf
.sort_by_name
= true;
996 if (symbol__init(&session
->header
.env
) < 0)
999 sort__setup_elide(stdout
);
1001 ret
= __cmd_report(&report
);
1002 if (ret
== K_SWITCH_INPUT_DATA
) {
1003 perf_session__delete(session
);
1009 perf_session__delete(session
);