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/values.h"
22 #include "util/debug.h"
23 #include "util/evlist.h"
24 #include "util/evsel.h"
25 #include "util/header.h"
26 #include "util/session.h"
27 #include "util/tool.h"
29 #include <subcmd/parse-options.h>
30 #include <subcmd/exec-cmd.h>
31 #include "util/parse-events.h"
33 #include "util/thread.h"
34 #include "util/sort.h"
35 #include "util/hist.h"
36 #include "util/data.h"
37 #include "arch/common.h"
38 #include "util/time-utils.h"
39 #include "util/auxtrace.h"
40 #include "util/units.h"
47 #include <linux/bitmap.h>
48 #include <linux/stringify.h>
49 #include <sys/types.h>
54 struct perf_tool tool;
55 struct perf_session *session;
56 bool use_tui, use_gtk, use_stdio;
59 bool inverted_callchain;
63 bool nonany_branch_mode;
65 struct perf_read_values show_threads_values;
66 const char *pretty_printing_style;
68 const char *symbol_filter_str;
70 struct perf_time_interval ptime;
75 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
78 static int report__config(const char *var, const char *value, void *cb)
80 struct report *rep = cb;
82 if (!strcmp(var, "report.group")) {
83 symbol_conf.event_group = perf_config_bool(var, value);
86 if (!strcmp(var, "report.percent-limit")) {
87 double pcnt = strtof(value, NULL);
89 rep->min_percent = pcnt;
90 callchain_param.min_percent = pcnt;
93 if (!strcmp(var, "report.children")) {
94 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
97 if (!strcmp(var, "report.queue-size"))
98 return perf_config_u64(&rep->queue_size, var, value);
100 if (!strcmp(var, "report.sort_order")) {
101 default_sort_order = strdup(value);
108 static int hist_iter__report_callback(struct hist_entry_iter *iter,
109 struct addr_location *al, bool single,
113 struct report *rep = arg;
114 struct hist_entry *he = iter->he;
115 struct perf_evsel *evsel = iter->evsel;
117 struct branch_info *bi;
119 if (!ui__has_annotation())
122 hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
123 rep->nonany_branch_mode);
125 if (sort__mode == SORT_MODE__BRANCH) {
126 bi = he->branch_info;
127 err = addr_map_symbol__inc_samples(&bi->from, evsel->idx);
131 err = addr_map_symbol__inc_samples(&bi->to, evsel->idx);
133 } else if (rep->mem_mode) {
135 err = addr_map_symbol__inc_samples(&mi->daddr, evsel->idx);
139 err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
141 } else if (symbol_conf.cumulate_callchain) {
143 err = hist_entry__inc_addr_samples(he, evsel->idx,
146 err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
153 static int process_sample_event(struct perf_tool *tool,
154 union perf_event *event,
155 struct perf_sample *sample,
156 struct perf_evsel *evsel,
157 struct machine *machine)
159 struct report *rep = container_of(tool, struct report, tool);
160 struct addr_location al;
161 struct hist_entry_iter iter = {
164 .hide_unresolved = symbol_conf.hide_unresolved,
165 .add_entry_cb = hist_iter__report_callback,
169 if (perf_time__skip_sample(&rep->ptime, sample->time))
172 if (machine__resolve(machine, &al, sample) < 0) {
173 pr_debug("problem processing %d event, skipping it.\n",
178 if (symbol_conf.hide_unresolved && al.sym == NULL)
181 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
184 if (sort__mode == SORT_MODE__BRANCH) {
186 * A non-synthesized event might not have a branch stack if
187 * branch stacks have been synthesized (using itrace options).
189 if (!sample->branch_stack)
191 iter.ops = &hist_iter_branch;
192 } else if (rep->mem_mode) {
193 iter.ops = &hist_iter_mem;
194 } else if (symbol_conf.cumulate_callchain) {
195 iter.ops = &hist_iter_cumulative;
197 iter.ops = &hist_iter_normal;
201 al.map->dso->hit = 1;
203 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
205 pr_debug("problem adding hist entry, skipping event\n");
207 addr_location__put(&al);
211 static int process_read_event(struct perf_tool *tool,
212 union perf_event *event,
213 struct perf_sample *sample __maybe_unused,
214 struct perf_evsel *evsel,
215 struct machine *machine __maybe_unused)
217 struct report *rep = container_of(tool, struct report, tool);
219 if (rep->show_threads) {
220 const char *name = evsel ? perf_evsel__name(evsel) : "unknown";
221 int err = perf_read_values_add_value(&rep->show_threads_values,
222 event->read.pid, event->read.tid,
231 dump_printf(": %d %d %s %" PRIu64 "\n", event->read.pid, event->read.tid,
232 evsel ? perf_evsel__name(evsel) : "FAIL",
238 /* For pipe mode, sample_type is not currently set */
239 static int report__setup_sample_type(struct report *rep)
241 struct perf_session *session = rep->session;
242 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
243 bool is_pipe = perf_data_file__is_pipe(session->file);
245 if (session->itrace_synth_opts->callchain ||
247 perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
248 !session->itrace_synth_opts->set))
249 sample_type |= PERF_SAMPLE_CALLCHAIN;
251 if (session->itrace_synth_opts->last_branch)
252 sample_type |= PERF_SAMPLE_BRANCH_STACK;
254 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
255 if (perf_hpp_list.parent) {
256 ui__error("Selected --sort parent, but no "
257 "callchain data. Did you call "
258 "'perf record' without -g?\n");
261 if (symbol_conf.use_callchain) {
262 ui__error("Selected -g or --branch-history but no "
263 "callchain data. Did\n"
264 "you call 'perf record' without -g?\n");
267 } else if (!callchain_param.enabled &&
268 callchain_param.mode != CHAIN_NONE &&
269 !symbol_conf.use_callchain) {
270 symbol_conf.use_callchain = true;
271 if (callchain_register_param(&callchain_param) < 0) {
272 ui__error("Can't register callchain params.\n");
277 if (symbol_conf.cumulate_callchain) {
278 /* Silently ignore if callchain is missing */
279 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
280 symbol_conf.cumulate_callchain = false;
281 perf_hpp__cancel_cumulate();
285 if (sort__mode == SORT_MODE__BRANCH) {
287 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
288 ui__error("Selected -b but no branch data. "
289 "Did you call perf record without -b?\n");
294 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
295 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
296 (sample_type & PERF_SAMPLE_STACK_USER))
297 callchain_param.record_mode = CALLCHAIN_DWARF;
298 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
299 callchain_param.record_mode = CALLCHAIN_LBR;
301 callchain_param.record_mode = CALLCHAIN_FP;
304 /* ??? handle more cases than just ANY? */
305 if (!(perf_evlist__combined_branch_type(session->evlist) &
306 PERF_SAMPLE_BRANCH_ANY))
307 rep->nonany_branch_mode = true;
312 static void sig_handler(int sig __maybe_unused)
317 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
318 const char *evname, FILE *fp)
322 unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
323 u64 nr_events = hists->stats.total_period;
324 struct perf_evsel *evsel = hists_to_evsel(hists);
326 size_t size = sizeof(buf);
327 int socked_id = hists->socket_filter;
332 if (symbol_conf.filter_relative) {
333 nr_samples = hists->stats.nr_non_filtered_samples;
334 nr_events = hists->stats.total_non_filtered_period;
337 if (perf_evsel__is_group_event(evsel)) {
338 struct perf_evsel *pos;
340 perf_evsel__group_desc(evsel, buf, size);
343 for_each_group_member(pos, evsel) {
344 const struct hists *pos_hists = evsel__hists(pos);
346 if (symbol_conf.filter_relative) {
347 nr_samples += pos_hists->stats.nr_non_filtered_samples;
348 nr_events += pos_hists->stats.total_non_filtered_period;
350 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE];
351 nr_events += pos_hists->stats.total_period;
356 nr_samples = convert_unit(nr_samples, &unit);
357 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
359 ret += fprintf(fp, " of event '%s'", evname);
361 if (symbol_conf.show_ref_callgraph &&
362 strstr(evname, "call-graph=no")) {
363 ret += fprintf(fp, ", show reference callgraph");
367 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
368 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order);
370 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
373 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
375 return ret + fprintf(fp, "\n#\n");
378 static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
382 struct perf_evsel *pos;
385 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n",
386 evlist->stats.total_lost_samples);
389 evlist__for_each_entry(evlist, pos) {
390 struct hists *hists = evsel__hists(pos);
391 const char *evname = perf_evsel__name(pos);
393 if (symbol_conf.event_group &&
394 !perf_evsel__is_group_leader(pos))
397 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
398 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout,
399 symbol_conf.use_callchain);
400 fprintf(stdout, "\n\n");
404 fprintf(stdout, "#\n# (%s)\n#\n", help);
406 if (rep->show_threads) {
407 bool style = !strcmp(rep->pretty_printing_style, "raw");
408 perf_read_values_display(stdout, &rep->show_threads_values,
410 perf_read_values_destroy(&rep->show_threads_values);
416 static void report__warn_kptr_restrict(const struct report *rep)
418 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host);
419 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
421 if (kernel_map == NULL ||
422 (kernel_map->dso->hit &&
423 (kernel_kmap->ref_reloc_sym == NULL ||
424 kernel_kmap->ref_reloc_sym->addr == 0))) {
426 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
427 "can't be resolved.";
430 const struct dso *kdso = kernel_map->dso;
431 if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
432 desc = "If some relocation was applied (e.g. "
433 "kexec) symbols may be misresolved.";
438 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
439 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
440 "Samples in kernel modules can't be resolved as well.\n\n",
445 static int report__gtk_browse_hists(struct report *rep, const char *help)
447 int (*hist_browser)(struct perf_evlist *evlist, const char *help,
448 struct hist_browser_timer *timer, float min_pcnt);
450 hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
452 if (hist_browser == NULL) {
453 ui__error("GTK browser not found!\n");
457 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
460 static int report__browse_hists(struct report *rep)
463 struct perf_session *session = rep->session;
464 struct perf_evlist *evlist = session->evlist;
465 const char *help = perf_tip(system_path(TIPDIR));
468 /* fallback for people who don't install perf ;-) */
469 help = perf_tip(DOCDIR);
471 help = "Cannot load tips.txt file, please install perf!";
474 switch (use_browser) {
476 ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
478 &session->header.env);
480 * Usually "ret" is the last pressed key, and we only
481 * care if the key notifies us to switch data file.
483 if (ret != K_SWITCH_INPUT_DATA)
487 ret = report__gtk_browse_hists(rep, help);
490 ret = perf_evlist__tty_browse_hists(evlist, rep, help);
497 static int report__collapse_hists(struct report *rep)
499 struct ui_progress prog;
500 struct perf_evsel *pos;
503 ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
505 evlist__for_each_entry(rep->session->evlist, pos) {
506 struct hists *hists = evsel__hists(pos);
509 hists->symbol_filter_str = rep->symbol_filter_str;
511 hists->socket_filter = rep->socket_filter;
513 ret = hists__collapse_resort(hists, &prog);
517 /* Non-group events are considered as leader */
518 if (symbol_conf.event_group &&
519 !perf_evsel__is_group_leader(pos)) {
520 struct hists *leader_hists = evsel__hists(pos->leader);
522 hists__match(leader_hists, hists);
523 hists__link(leader_hists, hists);
527 ui_progress__finish();
531 static void report__output_resort(struct report *rep)
533 struct ui_progress prog;
534 struct perf_evsel *pos;
536 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
538 evlist__for_each_entry(rep->session->evlist, pos)
539 perf_evsel__output_resort(pos, &prog);
541 ui_progress__finish();
544 static int __cmd_report(struct report *rep)
547 struct perf_session *session = rep->session;
548 struct perf_evsel *pos;
549 struct perf_data_file *file = session->file;
551 signal(SIGINT, sig_handler);
554 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
557 ui__error("failed to set cpu bitmap\n");
562 if (rep->show_threads) {
563 ret = perf_read_values_init(&rep->show_threads_values);
568 ret = report__setup_sample_type(rep);
570 /* report__setup_sample_type() already showed error message */
574 ret = perf_session__process_events(session);
576 ui__error("failed to process sample\n");
580 report__warn_kptr_restrict(rep);
582 evlist__for_each_entry(session->evlist, pos)
583 rep->nr_entries += evsel__hists(pos)->nr_entries;
585 if (use_browser == 0) {
587 perf_session__fprintf(session, stdout);
590 perf_session__fprintf_dsos(session, stdout);
593 perf_session__fprintf_nr_events(session, stdout);
594 perf_evlist__fprintf_nr_events(session->evlist, stdout);
599 ret = report__collapse_hists(rep);
601 ui__error("failed to process hist entry\n");
609 * recalculate number of entries after collapsing since it
610 * might be changed during the collapse phase.
613 evlist__for_each_entry(session->evlist, pos)
614 rep->nr_entries += evsel__hists(pos)->nr_entries;
616 if (rep->nr_entries == 0) {
617 ui__error("The %s file has no samples!\n", file->path);
621 report__output_resort(rep);
623 return report__browse_hists(rep);
627 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
629 struct callchain_param *callchain = opt->value;
631 callchain->enabled = !unset;
636 symbol_conf.use_callchain = false;
637 callchain->mode = CHAIN_NONE;
641 return parse_callchain_report_opt(arg);
645 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
646 const char *arg, int unset __maybe_unused)
649 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
652 regerror(err, &ignore_callees_regex, buf, sizeof(buf));
653 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
656 have_ignore_callees = 1;
663 parse_branch_mode(const struct option *opt,
664 const char *str __maybe_unused, int unset)
666 int *branch_mode = opt->value;
668 *branch_mode = !unset;
673 parse_percent_limit(const struct option *opt, const char *str,
674 int unset __maybe_unused)
676 struct report *rep = opt->value;
677 double pcnt = strtof(str, NULL);
679 rep->min_percent = pcnt;
680 callchain_param.min_percent = pcnt;
684 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
686 const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n"
687 CALLCHAIN_REPORT_HELP
688 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT;
690 int cmd_report(int argc, const char **argv)
692 struct perf_session *session;
693 struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
695 bool has_br_stack = false;
696 int branch_mode = -1;
697 bool branch_call_mode = false;
698 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT;
699 const char * const report_usage[] = {
700 "perf report [<options>]",
703 struct report report = {
705 .sample = process_sample_event,
706 .mmap = perf_event__process_mmap,
707 .mmap2 = perf_event__process_mmap2,
708 .comm = perf_event__process_comm,
709 .namespaces = perf_event__process_namespaces,
710 .exit = perf_event__process_exit,
711 .fork = perf_event__process_fork,
712 .lost = perf_event__process_lost,
713 .read = process_read_event,
714 .attr = perf_event__process_attr,
715 .tracing_data = perf_event__process_tracing_data,
716 .build_id = perf_event__process_build_id,
717 .id_index = perf_event__process_id_index,
718 .auxtrace_info = perf_event__process_auxtrace_info,
719 .auxtrace = perf_event__process_auxtrace,
720 .ordered_events = true,
721 .ordering_requires_timestamps = true,
723 .max_stack = PERF_MAX_STACK_DEPTH,
724 .pretty_printing_style = "normal",
727 const struct option options[] = {
728 OPT_STRING('i', "input", &input_name, "file",
730 OPT_INCR('v', "verbose", &verbose,
731 "be more verbose (show symbol address, etc)"),
732 OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any message"),
733 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
734 "dump raw trace in ASCII"),
735 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
736 "file", "vmlinux pathname"),
737 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
738 "file", "kallsyms pathname"),
739 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
740 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
741 "load module symbols - WARNING: use only with -k and LIVE kernel"),
742 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
743 "Show a column with the number of samples"),
744 OPT_BOOLEAN('T', "threads", &report.show_threads,
745 "Show per-thread event counters"),
746 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
747 "pretty printing style key: normal raw"),
748 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
749 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
750 OPT_BOOLEAN(0, "stdio", &report.use_stdio,
751 "Use the stdio interface"),
752 OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
753 OPT_BOOLEAN(0, "header-only", &report.header_only,
754 "Show only data header."),
755 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
756 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
757 " Please refer the man page for the complete list."),
758 OPT_STRING('F', "fields", &field_order, "key[,keys...]",
759 "output field(s): overhead, period, sample plus all of sort keys"),
760 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization,
761 "Show sample percentage for different cpu modes"),
762 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
763 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN),
764 OPT_STRING('p', "parent", &parent_pattern, "regex",
765 "regex filter to identify parent, see: '--sort parent'"),
766 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
767 "Only display entries with parent-match"),
768 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param,
769 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
770 report_callchain_help, &report_parse_callchain_opt,
771 callchain_default_opt),
772 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
773 "Accumulate callchains of children and show total overhead as well"),
774 OPT_INTEGER(0, "max-stack", &report.max_stack,
775 "Set the maximum stack depth when parsing the callchain, "
776 "anything beyond the specified depth will be ignored. "
777 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
778 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
779 "alias for inverted call graph"),
780 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
781 "ignore callees of these functions in call graphs",
782 report_parse_ignore_callees_opt),
783 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
784 "only consider symbols in these dsos"),
785 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
786 "only consider symbols in these comms"),
787 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
788 "only consider symbols in these pids"),
789 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
790 "only consider symbols in these tids"),
791 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
792 "only consider these symbols"),
793 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
794 "only show symbols that (partially) match with this filter"),
795 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
797 "don't try to adjust column width, use these fixed values"),
798 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
799 "separator for columns, no spaces will be added between "
800 "columns '.' is reserved."),
801 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved,
802 "Only display entries resolved to a symbol"),
803 OPT_CALLBACK(0, "symfs", NULL, "directory",
804 "Look for files with symbols relative to this directory",
805 symbol__config_symfs),
806 OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
807 "list of cpus to profile"),
808 OPT_BOOLEAN('I', "show-info", &report.show_full_info,
809 "Display extended information about perf.data file"),
810 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
811 "Interleave source code with assembly code (default)"),
812 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
813 "Display raw encoding of assembly instructions (default)"),
814 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
815 "Specify disassembler style (e.g. -M intel for intel syntax)"),
816 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
817 "Show a column with the sum of periods"),
818 OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
819 "Show event group information together"),
820 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
821 "use branch records for per branch histogram filling",
823 OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
824 "add last branch records to call history"),
825 OPT_STRING(0, "objdump", &objdump_path, "path",
826 "objdump binary to use for disassembly and annotations"),
827 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
828 "Disable symbol demangling"),
829 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
830 "Enable kernel symbol demangling"),
831 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
832 OPT_CALLBACK(0, "percent-limit", &report, "percent",
833 "Don't show entries under that percent", parse_percent_limit),
834 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
835 "how to display percentage of filtered entries", parse_filter_percentage),
836 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
837 "Instruction Tracing options",
838 itrace_parse_synth_opts),
839 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
840 "Show full source file name path for source lines"),
841 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
842 "Show callgraph from reference event"),
843 OPT_INTEGER(0, "socket-filter", &report.socket_filter,
844 "only show processor socket that match with this filter"),
845 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
846 "Show raw trace event output (do not use print fmt or plugins)"),
847 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
848 "Show entries in a hierarchy"),
849 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
850 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
851 stdio__config_color, "always"),
852 OPT_STRING(0, "time", &report.time_str, "str",
853 "Time span of interest (start,stop)"),
854 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
855 "Show inline function"),
858 struct perf_data_file file = {
859 .mode = PERF_DATA_MODE_READ,
861 int ret = hists__init();
866 ret = perf_config(report__config, &report);
870 argc = parse_options(argc, argv, options, report_usage, 0);
873 * Special case: if there's an argument left then assume that
874 * it's a symbol filter:
877 usage_with_options(report_usage, options);
879 report.symbol_filter_str = argv[0];
885 if (symbol_conf.vmlinux_name &&
886 access(symbol_conf.vmlinux_name, R_OK)) {
887 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
890 if (symbol_conf.kallsyms_name &&
891 access(symbol_conf.kallsyms_name, R_OK)) {
892 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);
896 if (report.use_stdio)
898 else if (report.use_tui)
900 else if (report.use_gtk)
903 if (report.inverted_callchain)
904 callchain_param.order = ORDER_CALLER;
905 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
906 callchain_param.order = ORDER_CALLER;
908 if (itrace_synth_opts.callchain &&
909 (int)itrace_synth_opts.callchain_sz > report.max_stack)
910 report.max_stack = itrace_synth_opts.callchain_sz;
912 if (!input_name || !strlen(input_name)) {
913 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
916 input_name = "perf.data";
919 file.path = input_name;
920 file.force = symbol_conf.force;
923 session = perf_session__new(&file, false, &report.tool);
927 if (report.queue_size) {
928 ordered_events__set_alloc_size(&session->ordered_events,
932 session->itrace_synth_opts = &itrace_synth_opts;
934 report.session = session;
936 has_br_stack = perf_header__has_feat(&session->header,
937 HEADER_BRANCH_STACK);
939 if (itrace_synth_opts.last_branch)
942 if (has_br_stack && branch_call_mode)
943 symbol_conf.show_branchflag_count = true;
946 * Branch mode is a tristate:
947 * -1 means default, so decide based on the file having branch data.
948 * 0/1 means the user chose a mode.
950 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
952 sort__mode = SORT_MODE__BRANCH;
953 symbol_conf.cumulate_callchain = false;
955 if (branch_call_mode) {
956 callchain_param.key = CCKEY_ADDRESS;
957 callchain_param.branch_callstack = 1;
958 symbol_conf.use_callchain = true;
959 callchain_register_param(&callchain_param);
960 if (sort_order == NULL)
961 sort_order = "srcline,symbol,dso";
964 if (report.mem_mode) {
965 if (sort__mode == SORT_MODE__BRANCH) {
966 pr_err("branch and mem mode incompatible\n");
969 sort__mode = SORT_MODE__MEMORY;
970 symbol_conf.cumulate_callchain = false;
973 if (symbol_conf.report_hierarchy) {
974 /* disable incompatible options */
975 symbol_conf.cumulate_callchain = false;
978 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
979 parse_options_usage(report_usage, options, "F", 1);
980 parse_options_usage(NULL, options, "hierarchy", 0);
984 perf_hpp_list.need_collapse = true;
987 /* Force tty output for header output and per-thread stat. */
988 if (report.header || report.header_only || report.show_threads)
991 if (strcmp(input_name, "-") != 0)
996 if (setup_sorting(session->evlist) < 0) {
998 parse_options_usage(report_usage, options, "s", 1);
1000 parse_options_usage(sort_order ? NULL : report_usage,
1005 if ((report.header || report.header_only) && !quiet) {
1006 perf_session__fprintf_info(session, stdout,
1007 report.show_full_info);
1008 if (report.header_only) {
1012 } else if (use_browser == 0 && !quiet) {
1013 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1018 * Only in the TUI browser we are doing integrated annotation,
1019 * so don't allocate extra space that won't be used in the stdio
1022 if (ui__has_annotation()) {
1023 ret = symbol__annotation_init();
1027 * For searching by name on the "Browse map details".
1028 * providing it only in verbose mode not to bloat too
1029 * much struct symbol.
1033 * XXX: Need to provide a less kludgy way to ask for
1034 * more space per symbol, the u32 is for the index on
1036 * See symbol__browser_index.
1038 symbol_conf.priv_size += sizeof(u32);
1039 symbol_conf.sort_by_name = true;
1043 if (symbol__init(&session->header.env) < 0)
1046 if (perf_time__parse_str(&report.ptime, report.time_str) != 0) {
1047 pr_err("Invalid time string\n");
1051 sort__setup_elide(stdout);
1053 ret = __cmd_report(&report);
1054 if (ret == K_SWITCH_INPUT_DATA) {
1055 perf_session__delete(session);
1061 perf_session__delete(session);