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/config.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"
39 #include "util/time-utils.h"
40 #include "util/auxtrace.h"
43 #include <linux/bitmap.h>
44 #include <linux/stringify.h>
47 struct perf_tool tool
;
48 struct perf_session
*session
;
49 bool use_tui
, use_gtk
, use_stdio
;
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
;
63 struct perf_time_interval ptime
;
68 DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
71 static int report__config(const char *var
, const char *value
, void *cb
)
73 struct report
*rep
= cb
;
75 if (!strcmp(var
, "report.group")) {
76 symbol_conf
.event_group
= perf_config_bool(var
, value
);
79 if (!strcmp(var
, "report.percent-limit")) {
80 double pcnt
= strtof(value
, NULL
);
82 rep
->min_percent
= pcnt
;
83 callchain_param
.min_percent
= pcnt
;
86 if (!strcmp(var
, "report.children")) {
87 symbol_conf
.cumulate_callchain
= perf_config_bool(var
, value
);
90 if (!strcmp(var
, "report.queue-size")) {
91 rep
->queue_size
= perf_config_u64(var
, value
);
94 if (!strcmp(var
, "report.sort_order")) {
95 default_sort_order
= strdup(value
);
102 static int hist_iter__report_callback(struct hist_entry_iter
*iter
,
103 struct addr_location
*al
, bool single
,
107 struct report
*rep
= arg
;
108 struct hist_entry
*he
= iter
->he
;
109 struct perf_evsel
*evsel
= iter
->evsel
;
111 struct branch_info
*bi
;
113 if (!ui__has_annotation())
116 hist__account_cycles(iter
->sample
->branch_stack
, al
, iter
->sample
,
117 rep
->nonany_branch_mode
);
119 if (sort__mode
== SORT_MODE__BRANCH
) {
120 bi
= he
->branch_info
;
121 err
= addr_map_symbol__inc_samples(&bi
->from
, evsel
->idx
);
125 err
= addr_map_symbol__inc_samples(&bi
->to
, evsel
->idx
);
127 } else if (rep
->mem_mode
) {
129 err
= addr_map_symbol__inc_samples(&mi
->daddr
, evsel
->idx
);
133 err
= hist_entry__inc_addr_samples(he
, evsel
->idx
, al
->addr
);
135 } else if (symbol_conf
.cumulate_callchain
) {
137 err
= hist_entry__inc_addr_samples(he
, evsel
->idx
,
140 err
= hist_entry__inc_addr_samples(he
, evsel
->idx
, al
->addr
);
147 static int process_sample_event(struct perf_tool
*tool
,
148 union perf_event
*event
,
149 struct perf_sample
*sample
,
150 struct perf_evsel
*evsel
,
151 struct machine
*machine
)
153 struct report
*rep
= container_of(tool
, struct report
, tool
);
154 struct addr_location al
;
155 struct hist_entry_iter iter
= {
158 .hide_unresolved
= symbol_conf
.hide_unresolved
,
159 .add_entry_cb
= hist_iter__report_callback
,
163 if (perf_time__skip_sample(&rep
->ptime
, sample
->time
))
166 if (machine__resolve(machine
, &al
, sample
) < 0) {
167 pr_debug("problem processing %d event, skipping it.\n",
172 if (symbol_conf
.hide_unresolved
&& al
.sym
== NULL
)
175 if (rep
->cpu_list
&& !test_bit(sample
->cpu
, rep
->cpu_bitmap
))
178 if (sort__mode
== SORT_MODE__BRANCH
) {
180 * A non-synthesized event might not have a branch stack if
181 * branch stacks have been synthesized (using itrace options).
183 if (!sample
->branch_stack
)
185 iter
.ops
= &hist_iter_branch
;
186 } else if (rep
->mem_mode
) {
187 iter
.ops
= &hist_iter_mem
;
188 } else if (symbol_conf
.cumulate_callchain
) {
189 iter
.ops
= &hist_iter_cumulative
;
191 iter
.ops
= &hist_iter_normal
;
195 al
.map
->dso
->hit
= 1;
197 ret
= hist_entry_iter__add(&iter
, &al
, rep
->max_stack
, rep
);
199 pr_debug("problem adding hist entry, skipping event\n");
201 addr_location__put(&al
);
205 static int process_read_event(struct perf_tool
*tool
,
206 union perf_event
*event
,
207 struct perf_sample
*sample __maybe_unused
,
208 struct perf_evsel
*evsel
,
209 struct machine
*machine __maybe_unused
)
211 struct report
*rep
= container_of(tool
, struct report
, tool
);
213 if (rep
->show_threads
) {
214 const char *name
= evsel
? perf_evsel__name(evsel
) : "unknown";
215 int err
= perf_read_values_add_value(&rep
->show_threads_values
,
216 event
->read
.pid
, event
->read
.tid
,
225 dump_printf(": %d %d %s %" PRIu64
"\n", event
->read
.pid
, event
->read
.tid
,
226 evsel
? perf_evsel__name(evsel
) : "FAIL",
232 /* For pipe mode, sample_type is not currently set */
233 static int report__setup_sample_type(struct report
*rep
)
235 struct perf_session
*session
= rep
->session
;
236 u64 sample_type
= perf_evlist__combined_sample_type(session
->evlist
);
237 bool is_pipe
= perf_data_file__is_pipe(session
->file
);
239 if (session
->itrace_synth_opts
->callchain
||
241 perf_header__has_feat(&session
->header
, HEADER_AUXTRACE
) &&
242 !session
->itrace_synth_opts
->set
))
243 sample_type
|= PERF_SAMPLE_CALLCHAIN
;
245 if (session
->itrace_synth_opts
->last_branch
)
246 sample_type
|= PERF_SAMPLE_BRANCH_STACK
;
248 if (!is_pipe
&& !(sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
249 if (perf_hpp_list
.parent
) {
250 ui__error("Selected --sort parent, but no "
251 "callchain data. Did you call "
252 "'perf record' without -g?\n");
255 if (symbol_conf
.use_callchain
) {
256 ui__error("Selected -g or --branch-history but no "
257 "callchain data. Did\n"
258 "you call 'perf record' without -g?\n");
261 } else if (!callchain_param
.enabled
&&
262 callchain_param
.mode
!= CHAIN_NONE
&&
263 !symbol_conf
.use_callchain
) {
264 symbol_conf
.use_callchain
= true;
265 if (callchain_register_param(&callchain_param
) < 0) {
266 ui__error("Can't register callchain params.\n");
271 if (symbol_conf
.cumulate_callchain
) {
272 /* Silently ignore if callchain is missing */
273 if (!(sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
274 symbol_conf
.cumulate_callchain
= false;
275 perf_hpp__cancel_cumulate();
279 if (sort__mode
== SORT_MODE__BRANCH
) {
281 !(sample_type
& PERF_SAMPLE_BRANCH_STACK
)) {
282 ui__error("Selected -b but no branch data. "
283 "Did you call perf record without -b?\n");
288 if (symbol_conf
.use_callchain
|| symbol_conf
.cumulate_callchain
) {
289 if ((sample_type
& PERF_SAMPLE_REGS_USER
) &&
290 (sample_type
& PERF_SAMPLE_STACK_USER
))
291 callchain_param
.record_mode
= CALLCHAIN_DWARF
;
292 else if (sample_type
& PERF_SAMPLE_BRANCH_STACK
)
293 callchain_param
.record_mode
= CALLCHAIN_LBR
;
295 callchain_param
.record_mode
= CALLCHAIN_FP
;
298 /* ??? handle more cases than just ANY? */
299 if (!(perf_evlist__combined_branch_type(session
->evlist
) &
300 PERF_SAMPLE_BRANCH_ANY
))
301 rep
->nonany_branch_mode
= true;
306 static void sig_handler(int sig __maybe_unused
)
311 static size_t hists__fprintf_nr_sample_events(struct hists
*hists
, struct report
*rep
,
312 const char *evname
, FILE *fp
)
316 unsigned long nr_samples
= hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
317 u64 nr_events
= hists
->stats
.total_period
;
318 struct perf_evsel
*evsel
= hists_to_evsel(hists
);
320 size_t size
= sizeof(buf
);
321 int socked_id
= hists
->socket_filter
;
326 if (symbol_conf
.filter_relative
) {
327 nr_samples
= hists
->stats
.nr_non_filtered_samples
;
328 nr_events
= hists
->stats
.total_non_filtered_period
;
331 if (perf_evsel__is_group_event(evsel
)) {
332 struct perf_evsel
*pos
;
334 perf_evsel__group_desc(evsel
, buf
, size
);
337 for_each_group_member(pos
, evsel
) {
338 const struct hists
*pos_hists
= evsel__hists(pos
);
340 if (symbol_conf
.filter_relative
) {
341 nr_samples
+= pos_hists
->stats
.nr_non_filtered_samples
;
342 nr_events
+= pos_hists
->stats
.total_non_filtered_period
;
344 nr_samples
+= pos_hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
345 nr_events
+= pos_hists
->stats
.total_period
;
350 nr_samples
= convert_unit(nr_samples
, &unit
);
351 ret
= fprintf(fp
, "# Samples: %lu%c", nr_samples
, unit
);
353 ret
+= fprintf(fp
, " of event '%s'", evname
);
355 if (symbol_conf
.show_ref_callgraph
&&
356 strstr(evname
, "call-graph=no")) {
357 ret
+= fprintf(fp
, ", show reference callgraph");
361 ret
+= fprintf(fp
, "\n# Total weight : %" PRIu64
, nr_events
);
362 ret
+= fprintf(fp
, "\n# Sort order : %s", sort_order
? : default_mem_sort_order
);
364 ret
+= fprintf(fp
, "\n# Event count (approx.): %" PRIu64
, nr_events
);
367 ret
+= fprintf(fp
, "\n# Processor Socket: %d", socked_id
);
369 return ret
+ fprintf(fp
, "\n#\n");
372 static int perf_evlist__tty_browse_hists(struct perf_evlist
*evlist
,
376 struct perf_evsel
*pos
;
379 fprintf(stdout
, "#\n# Total Lost Samples: %" PRIu64
"\n#\n",
380 evlist
->stats
.total_lost_samples
);
383 evlist__for_each_entry(evlist
, pos
) {
384 struct hists
*hists
= evsel__hists(pos
);
385 const char *evname
= perf_evsel__name(pos
);
387 if (symbol_conf
.event_group
&&
388 !perf_evsel__is_group_leader(pos
))
391 hists__fprintf_nr_sample_events(hists
, rep
, evname
, stdout
);
392 hists__fprintf(hists
, !quiet
, 0, 0, rep
->min_percent
, stdout
,
393 symbol_conf
.use_callchain
);
394 fprintf(stdout
, "\n\n");
398 fprintf(stdout
, "#\n# (%s)\n#\n", help
);
400 if (rep
->show_threads
) {
401 bool style
= !strcmp(rep
->pretty_printing_style
, "raw");
402 perf_read_values_display(stdout
, &rep
->show_threads_values
,
404 perf_read_values_destroy(&rep
->show_threads_values
);
410 static void report__warn_kptr_restrict(const struct report
*rep
)
412 struct map
*kernel_map
= machine__kernel_map(&rep
->session
->machines
.host
);
413 struct kmap
*kernel_kmap
= kernel_map
? map__kmap(kernel_map
) : NULL
;
415 if (kernel_map
== NULL
||
416 (kernel_map
->dso
->hit
&&
417 (kernel_kmap
->ref_reloc_sym
== NULL
||
418 kernel_kmap
->ref_reloc_sym
->addr
== 0))) {
420 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
421 "can't be resolved.";
424 const struct dso
*kdso
= kernel_map
->dso
;
425 if (!RB_EMPTY_ROOT(&kdso
->symbols
[MAP__FUNCTION
])) {
426 desc
= "If some relocation was applied (e.g. "
427 "kexec) symbols may be misresolved.";
432 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
433 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
434 "Samples in kernel modules can't be resolved as well.\n\n",
439 static int report__gtk_browse_hists(struct report
*rep
, const char *help
)
441 int (*hist_browser
)(struct perf_evlist
*evlist
, const char *help
,
442 struct hist_browser_timer
*timer
, float min_pcnt
);
444 hist_browser
= dlsym(perf_gtk_handle
, "perf_evlist__gtk_browse_hists");
446 if (hist_browser
== NULL
) {
447 ui__error("GTK browser not found!\n");
451 return hist_browser(rep
->session
->evlist
, help
, NULL
, rep
->min_percent
);
454 static int report__browse_hists(struct report
*rep
)
457 struct perf_session
*session
= rep
->session
;
458 struct perf_evlist
*evlist
= session
->evlist
;
459 const char *help
= perf_tip(system_path(TIPDIR
));
462 /* fallback for people who don't install perf ;-) */
463 help
= perf_tip(DOCDIR
);
465 help
= "Cannot load tips.txt file, please install perf!";
468 switch (use_browser
) {
470 ret
= perf_evlist__tui_browse_hists(evlist
, help
, NULL
,
472 &session
->header
.env
);
474 * Usually "ret" is the last pressed key, and we only
475 * care if the key notifies us to switch data file.
477 if (ret
!= K_SWITCH_INPUT_DATA
)
481 ret
= report__gtk_browse_hists(rep
, help
);
484 ret
= perf_evlist__tty_browse_hists(evlist
, rep
, help
);
491 static int report__collapse_hists(struct report
*rep
)
493 struct ui_progress prog
;
494 struct perf_evsel
*pos
;
497 ui_progress__init(&prog
, rep
->nr_entries
, "Merging related events...");
499 evlist__for_each_entry(rep
->session
->evlist
, pos
) {
500 struct hists
*hists
= evsel__hists(pos
);
503 hists
->symbol_filter_str
= rep
->symbol_filter_str
;
505 hists
->socket_filter
= rep
->socket_filter
;
507 ret
= hists__collapse_resort(hists
, &prog
);
511 /* Non-group events are considered as leader */
512 if (symbol_conf
.event_group
&&
513 !perf_evsel__is_group_leader(pos
)) {
514 struct hists
*leader_hists
= evsel__hists(pos
->leader
);
516 hists__match(leader_hists
, hists
);
517 hists__link(leader_hists
, hists
);
521 ui_progress__finish();
525 static void report__output_resort(struct report
*rep
)
527 struct ui_progress prog
;
528 struct perf_evsel
*pos
;
530 ui_progress__init(&prog
, rep
->nr_entries
, "Sorting events for output...");
532 evlist__for_each_entry(rep
->session
->evlist
, pos
)
533 perf_evsel__output_resort(pos
, &prog
);
535 ui_progress__finish();
538 static int __cmd_report(struct report
*rep
)
541 struct perf_session
*session
= rep
->session
;
542 struct perf_evsel
*pos
;
543 struct perf_data_file
*file
= session
->file
;
545 signal(SIGINT
, sig_handler
);
548 ret
= perf_session__cpu_bitmap(session
, rep
->cpu_list
,
551 ui__error("failed to set cpu bitmap\n");
556 if (rep
->show_threads
) {
557 ret
= perf_read_values_init(&rep
->show_threads_values
);
562 ret
= report__setup_sample_type(rep
);
564 /* report__setup_sample_type() already showed error message */
568 ret
= perf_session__process_events(session
);
570 ui__error("failed to process sample\n");
574 report__warn_kptr_restrict(rep
);
576 evlist__for_each_entry(session
->evlist
, pos
)
577 rep
->nr_entries
+= evsel__hists(pos
)->nr_entries
;
579 if (use_browser
== 0) {
581 perf_session__fprintf(session
, stdout
);
584 perf_session__fprintf_dsos(session
, stdout
);
587 perf_session__fprintf_nr_events(session
, stdout
);
588 perf_evlist__fprintf_nr_events(session
->evlist
, stdout
);
593 ret
= report__collapse_hists(rep
);
595 ui__error("failed to process hist entry\n");
603 * recalculate number of entries after collapsing since it
604 * might be changed during the collapse phase.
607 evlist__for_each_entry(session
->evlist
, pos
)
608 rep
->nr_entries
+= evsel__hists(pos
)->nr_entries
;
610 if (rep
->nr_entries
== 0) {
611 ui__error("The %s file has no samples!\n", file
->path
);
615 report__output_resort(rep
);
617 return report__browse_hists(rep
);
621 report_parse_callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
623 struct callchain_param
*callchain
= opt
->value
;
625 callchain
->enabled
= !unset
;
630 symbol_conf
.use_callchain
= false;
631 callchain
->mode
= CHAIN_NONE
;
635 return parse_callchain_report_opt(arg
);
639 report_parse_ignore_callees_opt(const struct option
*opt __maybe_unused
,
640 const char *arg
, int unset __maybe_unused
)
643 int err
= regcomp(&ignore_callees_regex
, arg
, REG_EXTENDED
);
646 regerror(err
, &ignore_callees_regex
, buf
, sizeof(buf
));
647 pr_err("Invalid --ignore-callees regex: %s\n%s", arg
, buf
);
650 have_ignore_callees
= 1;
657 parse_branch_mode(const struct option
*opt
,
658 const char *str __maybe_unused
, int unset
)
660 int *branch_mode
= opt
->value
;
662 *branch_mode
= !unset
;
667 parse_percent_limit(const struct option
*opt
, const char *str
,
668 int unset __maybe_unused
)
670 struct report
*rep
= opt
->value
;
671 double pcnt
= strtof(str
, NULL
);
673 rep
->min_percent
= pcnt
;
674 callchain_param
.min_percent
= pcnt
;
678 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
680 const char report_callchain_help
[] = "Display call graph (stack chain/backtrace):\n\n"
681 CALLCHAIN_REPORT_HELP
682 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT
;
684 int cmd_report(int argc
, const char **argv
)
686 struct perf_session
*session
;
687 struct itrace_synth_opts itrace_synth_opts
= { .set
= 0, };
689 bool has_br_stack
= false;
690 int branch_mode
= -1;
691 bool branch_call_mode
= false;
692 char callchain_default_opt
[] = CALLCHAIN_DEFAULT_OPT
;
693 const char * const report_usage
[] = {
694 "perf report [<options>]",
697 struct report report
= {
699 .sample
= process_sample_event
,
700 .mmap
= perf_event__process_mmap
,
701 .mmap2
= perf_event__process_mmap2
,
702 .comm
= perf_event__process_comm
,
703 .namespaces
= perf_event__process_namespaces
,
704 .exit
= perf_event__process_exit
,
705 .fork
= perf_event__process_fork
,
706 .lost
= perf_event__process_lost
,
707 .read
= process_read_event
,
708 .attr
= perf_event__process_attr
,
709 .tracing_data
= perf_event__process_tracing_data
,
710 .build_id
= perf_event__process_build_id
,
711 .id_index
= perf_event__process_id_index
,
712 .auxtrace_info
= perf_event__process_auxtrace_info
,
713 .auxtrace
= perf_event__process_auxtrace
,
714 .ordered_events
= true,
715 .ordering_requires_timestamps
= true,
717 .max_stack
= PERF_MAX_STACK_DEPTH
,
718 .pretty_printing_style
= "normal",
721 const struct option options
[] = {
722 OPT_STRING('i', "input", &input_name
, "file",
724 OPT_INCR('v', "verbose", &verbose
,
725 "be more verbose (show symbol address, etc)"),
726 OPT_BOOLEAN('q', "quiet", &quiet
, "Do not show any message"),
727 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
728 "dump raw trace in ASCII"),
729 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
730 "file", "vmlinux pathname"),
731 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
732 "file", "kallsyms pathname"),
733 OPT_BOOLEAN('f', "force", &symbol_conf
.force
, "don't complain, do it"),
734 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
735 "load module symbols - WARNING: use only with -k and LIVE kernel"),
736 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
737 "Show a column with the number of samples"),
738 OPT_BOOLEAN('T', "threads", &report
.show_threads
,
739 "Show per-thread event counters"),
740 OPT_STRING(0, "pretty", &report
.pretty_printing_style
, "key",
741 "pretty printing style key: normal raw"),
742 OPT_BOOLEAN(0, "tui", &report
.use_tui
, "Use the TUI interface"),
743 OPT_BOOLEAN(0, "gtk", &report
.use_gtk
, "Use the GTK2 interface"),
744 OPT_BOOLEAN(0, "stdio", &report
.use_stdio
,
745 "Use the stdio interface"),
746 OPT_BOOLEAN(0, "header", &report
.header
, "Show data header."),
747 OPT_BOOLEAN(0, "header-only", &report
.header_only
,
748 "Show only data header."),
749 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
750 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
751 " Please refer the man page for the complete list."),
752 OPT_STRING('F', "fields", &field_order
, "key[,keys...]",
753 "output field(s): overhead, period, sample plus all of sort keys"),
754 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf
.show_cpu_utilization
,
755 "Show sample percentage for different cpu modes"),
756 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf
.show_cpu_utilization
,
757 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN
),
758 OPT_STRING('p', "parent", &parent_pattern
, "regex",
759 "regex filter to identify parent, see: '--sort parent'"),
760 OPT_BOOLEAN('x', "exclude-other", &symbol_conf
.exclude_other
,
761 "Only display entries with parent-match"),
762 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param
,
763 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
764 report_callchain_help
, &report_parse_callchain_opt
,
765 callchain_default_opt
),
766 OPT_BOOLEAN(0, "children", &symbol_conf
.cumulate_callchain
,
767 "Accumulate callchains of children and show total overhead as well"),
768 OPT_INTEGER(0, "max-stack", &report
.max_stack
,
769 "Set the maximum stack depth when parsing the callchain, "
770 "anything beyond the specified depth will be ignored. "
771 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH
)),
772 OPT_BOOLEAN('G', "inverted", &report
.inverted_callchain
,
773 "alias for inverted call graph"),
774 OPT_CALLBACK(0, "ignore-callees", NULL
, "regex",
775 "ignore callees of these functions in call graphs",
776 report_parse_ignore_callees_opt
),
777 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
778 "only consider symbols in these dsos"),
779 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
780 "only consider symbols in these comms"),
781 OPT_STRING(0, "pid", &symbol_conf
.pid_list_str
, "pid[,pid...]",
782 "only consider symbols in these pids"),
783 OPT_STRING(0, "tid", &symbol_conf
.tid_list_str
, "tid[,tid...]",
784 "only consider symbols in these tids"),
785 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
786 "only consider these symbols"),
787 OPT_STRING(0, "symbol-filter", &report
.symbol_filter_str
, "filter",
788 "only show symbols that (partially) match with this filter"),
789 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
791 "don't try to adjust column width, use these fixed values"),
792 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf
.field_sep
, "separator",
793 "separator for columns, no spaces will be added between "
794 "columns '.' is reserved."),
795 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf
.hide_unresolved
,
796 "Only display entries resolved to a symbol"),
797 OPT_CALLBACK(0, "symfs", NULL
, "directory",
798 "Look for files with symbols relative to this directory",
799 symbol__config_symfs
),
800 OPT_STRING('C', "cpu", &report
.cpu_list
, "cpu",
801 "list of cpus to profile"),
802 OPT_BOOLEAN('I', "show-info", &report
.show_full_info
,
803 "Display extended information about perf.data file"),
804 OPT_BOOLEAN(0, "source", &symbol_conf
.annotate_src
,
805 "Interleave source code with assembly code (default)"),
806 OPT_BOOLEAN(0, "asm-raw", &symbol_conf
.annotate_asm_raw
,
807 "Display raw encoding of assembly instructions (default)"),
808 OPT_STRING('M', "disassembler-style", &disassembler_style
, "disassembler style",
809 "Specify disassembler style (e.g. -M intel for intel syntax)"),
810 OPT_BOOLEAN(0, "show-total-period", &symbol_conf
.show_total_period
,
811 "Show a column with the sum of periods"),
812 OPT_BOOLEAN(0, "group", &symbol_conf
.event_group
,
813 "Show event group information together"),
814 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode
, "",
815 "use branch records for per branch histogram filling",
817 OPT_BOOLEAN(0, "branch-history", &branch_call_mode
,
818 "add last branch records to call history"),
819 OPT_STRING(0, "objdump", &objdump_path
, "path",
820 "objdump binary to use for disassembly and annotations"),
821 OPT_BOOLEAN(0, "demangle", &symbol_conf
.demangle
,
822 "Disable symbol demangling"),
823 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf
.demangle_kernel
,
824 "Enable kernel symbol demangling"),
825 OPT_BOOLEAN(0, "mem-mode", &report
.mem_mode
, "mem access profile"),
826 OPT_CALLBACK(0, "percent-limit", &report
, "percent",
827 "Don't show entries under that percent", parse_percent_limit
),
828 OPT_CALLBACK(0, "percentage", NULL
, "relative|absolute",
829 "how to display percentage of filtered entries", parse_filter_percentage
),
830 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts
, NULL
, "opts",
831 "Instruction Tracing options",
832 itrace_parse_synth_opts
),
833 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename
,
834 "Show full source file name path for source lines"),
835 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf
.show_ref_callgraph
,
836 "Show callgraph from reference event"),
837 OPT_INTEGER(0, "socket-filter", &report
.socket_filter
,
838 "only show processor socket that match with this filter"),
839 OPT_BOOLEAN(0, "raw-trace", &symbol_conf
.raw_trace
,
840 "Show raw trace event output (do not use print fmt or plugins)"),
841 OPT_BOOLEAN(0, "hierarchy", &symbol_conf
.report_hierarchy
,
842 "Show entries in a hierarchy"),
843 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL
, "mode",
844 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
845 stdio__config_color
, "always"),
846 OPT_STRING(0, "time", &report
.time_str
, "str",
847 "Time span of interest (start,stop)"),
850 struct perf_data_file file
= {
851 .mode
= PERF_DATA_MODE_READ
,
853 int ret
= hists__init();
858 ret
= perf_config(report__config
, &report
);
862 argc
= parse_options(argc
, argv
, options
, report_usage
, 0);
865 * Special case: if there's an argument left then assume that
866 * it's a symbol filter:
869 usage_with_options(report_usage
, options
);
871 report
.symbol_filter_str
= argv
[0];
877 if (symbol_conf
.vmlinux_name
&&
878 access(symbol_conf
.vmlinux_name
, R_OK
)) {
879 pr_err("Invalid file: %s\n", symbol_conf
.vmlinux_name
);
882 if (symbol_conf
.kallsyms_name
&&
883 access(symbol_conf
.kallsyms_name
, R_OK
)) {
884 pr_err("Invalid file: %s\n", symbol_conf
.kallsyms_name
);
888 if (report
.use_stdio
)
890 else if (report
.use_tui
)
892 else if (report
.use_gtk
)
895 if (report
.inverted_callchain
)
896 callchain_param
.order
= ORDER_CALLER
;
897 if (symbol_conf
.cumulate_callchain
&& !callchain_param
.order_set
)
898 callchain_param
.order
= ORDER_CALLER
;
900 if (itrace_synth_opts
.callchain
&&
901 (int)itrace_synth_opts
.callchain_sz
> report
.max_stack
)
902 report
.max_stack
= itrace_synth_opts
.callchain_sz
;
904 if (!input_name
|| !strlen(input_name
)) {
905 if (!fstat(STDIN_FILENO
, &st
) && S_ISFIFO(st
.st_mode
))
908 input_name
= "perf.data";
911 file
.path
= input_name
;
912 file
.force
= symbol_conf
.force
;
915 session
= perf_session__new(&file
, false, &report
.tool
);
919 if (report
.queue_size
) {
920 ordered_events__set_alloc_size(&session
->ordered_events
,
924 session
->itrace_synth_opts
= &itrace_synth_opts
;
926 report
.session
= session
;
928 has_br_stack
= perf_header__has_feat(&session
->header
,
929 HEADER_BRANCH_STACK
);
931 if (itrace_synth_opts
.last_branch
)
934 if (has_br_stack
&& branch_call_mode
)
935 symbol_conf
.show_branchflag_count
= true;
938 * Branch mode is a tristate:
939 * -1 means default, so decide based on the file having branch data.
940 * 0/1 means the user chose a mode.
942 if (((branch_mode
== -1 && has_br_stack
) || branch_mode
== 1) &&
944 sort__mode
= SORT_MODE__BRANCH
;
945 symbol_conf
.cumulate_callchain
= false;
947 if (branch_call_mode
) {
948 callchain_param
.key
= CCKEY_ADDRESS
;
949 callchain_param
.branch_callstack
= 1;
950 symbol_conf
.use_callchain
= true;
951 callchain_register_param(&callchain_param
);
952 if (sort_order
== NULL
)
953 sort_order
= "srcline,symbol,dso";
956 if (report
.mem_mode
) {
957 if (sort__mode
== SORT_MODE__BRANCH
) {
958 pr_err("branch and mem mode incompatible\n");
961 sort__mode
= SORT_MODE__MEMORY
;
962 symbol_conf
.cumulate_callchain
= false;
965 if (symbol_conf
.report_hierarchy
) {
966 /* disable incompatible options */
967 symbol_conf
.cumulate_callchain
= false;
970 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
971 parse_options_usage(report_usage
, options
, "F", 1);
972 parse_options_usage(NULL
, options
, "hierarchy", 0);
976 perf_hpp_list
.need_collapse
= true;
979 /* Force tty output for header output and per-thread stat. */
980 if (report
.header
|| report
.header_only
|| report
.show_threads
)
983 if (strcmp(input_name
, "-") != 0)
988 if (setup_sorting(session
->evlist
) < 0) {
990 parse_options_usage(report_usage
, options
, "s", 1);
992 parse_options_usage(sort_order
? NULL
: report_usage
,
997 if ((report
.header
|| report
.header_only
) && !quiet
) {
998 perf_session__fprintf_info(session
, stdout
,
999 report
.show_full_info
);
1000 if (report
.header_only
) {
1004 } else if (use_browser
== 0 && !quiet
) {
1005 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1010 * Only in the TUI browser we are doing integrated annotation,
1011 * so don't allocate extra space that won't be used in the stdio
1014 if (ui__has_annotation()) {
1015 ret
= symbol__annotation_init();
1019 * For searching by name on the "Browse map details".
1020 * providing it only in verbose mode not to bloat too
1021 * much struct symbol.
1025 * XXX: Need to provide a less kludgy way to ask for
1026 * more space per symbol, the u32 is for the index on
1028 * See symbol__browser_index.
1030 symbol_conf
.priv_size
+= sizeof(u32
);
1031 symbol_conf
.sort_by_name
= true;
1035 if (symbol__init(&session
->header
.env
) < 0)
1038 if (perf_time__parse_str(&report
.ptime
, report
.time_str
) != 0) {
1039 pr_err("Invalid time string\n");
1043 sort__setup_elide(stdout
);
1045 ret
= __cmd_report(&report
);
1046 if (ret
== K_SWITCH_INPUT_DATA
) {
1047 perf_session__delete(session
);
1053 perf_session__delete(session
);