1 // SPDX-License-Identifier: GPL-2.0
5 * Builtin report command: Analyze the perf.data input file,
6 * look up and read DSOs and symbol information and display
7 * a histogram of results, along various sorting keys.
11 #include "util/util.h"
12 #include "util/config.h"
14 #include "util/annotate.h"
15 #include "util/color.h"
16 #include <linux/list.h>
17 #include <linux/rbtree.h>
18 #include "util/symbol.h"
19 #include "util/callchain.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"
41 #include "util/units.h"
42 #include "util/branch.h"
49 #include <linux/bitmap.h>
50 #include <linux/stringify.h>
51 #include <sys/types.h>
56 struct perf_tool tool;
57 struct perf_session *session;
58 bool use_tui, use_gtk, use_stdio;
61 bool inverted_callchain;
65 bool nonany_branch_mode;
67 struct perf_read_values show_threads_values;
68 const char *pretty_printing_style;
70 const char *symbol_filter_str;
72 struct perf_time_interval ptime;
77 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
78 struct branch_type_stat brtype_stat;
81 static int report__config(const char *var, const char *value, void *cb)
83 struct report *rep = cb;
85 if (!strcmp(var, "report.group")) {
86 symbol_conf.event_group = perf_config_bool(var, value);
89 if (!strcmp(var, "report.percent-limit")) {
90 double pcnt = strtof(value, NULL);
92 rep->min_percent = pcnt;
93 callchain_param.min_percent = pcnt;
96 if (!strcmp(var, "report.children")) {
97 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
100 if (!strcmp(var, "report.queue-size"))
101 return perf_config_u64(&rep->queue_size, var, value);
103 if (!strcmp(var, "report.sort_order")) {
104 default_sort_order = strdup(value);
111 static int hist_iter__report_callback(struct hist_entry_iter *iter,
112 struct addr_location *al, bool single,
116 struct report *rep = arg;
117 struct hist_entry *he = iter->he;
118 struct perf_evsel *evsel = iter->evsel;
119 struct perf_sample *sample = iter->sample;
121 struct branch_info *bi;
123 if (!ui__has_annotation())
126 hist__account_cycles(sample->branch_stack, al, sample,
127 rep->nonany_branch_mode);
129 if (sort__mode == SORT_MODE__BRANCH) {
130 bi = he->branch_info;
131 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel->idx);
135 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel->idx);
137 } else if (rep->mem_mode) {
139 err = addr_map_symbol__inc_samples(&mi->daddr, sample, evsel->idx);
143 err = hist_entry__inc_addr_samples(he, sample, evsel->idx, al->addr);
145 } else if (symbol_conf.cumulate_callchain) {
147 err = hist_entry__inc_addr_samples(he, sample, evsel->idx,
150 err = hist_entry__inc_addr_samples(he, sample, evsel->idx, al->addr);
157 static int hist_iter__branch_callback(struct hist_entry_iter *iter,
158 struct addr_location *al __maybe_unused,
159 bool single __maybe_unused,
162 struct hist_entry *he = iter->he;
163 struct report *rep = arg;
164 struct branch_info *bi;
165 struct perf_sample *sample = iter->sample;
166 struct perf_evsel *evsel = iter->evsel;
169 if (!ui__has_annotation())
172 hist__account_cycles(sample->branch_stack, al, sample,
173 rep->nonany_branch_mode);
175 bi = he->branch_info;
176 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel->idx);
180 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel->idx);
182 branch_type_count(&rep->brtype_stat, &bi->flags,
183 bi->from.addr, bi->to.addr);
189 static int process_sample_event(struct perf_tool *tool,
190 union perf_event *event,
191 struct perf_sample *sample,
192 struct perf_evsel *evsel,
193 struct machine *machine)
195 struct report *rep = container_of(tool, struct report, tool);
196 struct addr_location al;
197 struct hist_entry_iter iter = {
200 .hide_unresolved = symbol_conf.hide_unresolved,
201 .add_entry_cb = hist_iter__report_callback,
205 if (perf_time__skip_sample(&rep->ptime, sample->time))
208 if (machine__resolve(machine, &al, sample) < 0) {
209 pr_debug("problem processing %d event, skipping it.\n",
214 if (symbol_conf.hide_unresolved && al.sym == NULL)
217 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
220 if (sort__mode == SORT_MODE__BRANCH) {
222 * A non-synthesized event might not have a branch stack if
223 * branch stacks have been synthesized (using itrace options).
225 if (!sample->branch_stack)
228 iter.add_entry_cb = hist_iter__branch_callback;
229 iter.ops = &hist_iter_branch;
230 } else if (rep->mem_mode) {
231 iter.ops = &hist_iter_mem;
232 } else if (symbol_conf.cumulate_callchain) {
233 iter.ops = &hist_iter_cumulative;
235 iter.ops = &hist_iter_normal;
239 al.map->dso->hit = 1;
241 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
243 pr_debug("problem adding hist entry, skipping event\n");
245 addr_location__put(&al);
249 static int process_read_event(struct perf_tool *tool,
250 union perf_event *event,
251 struct perf_sample *sample __maybe_unused,
252 struct perf_evsel *evsel,
253 struct machine *machine __maybe_unused)
255 struct report *rep = container_of(tool, struct report, tool);
257 if (rep->show_threads) {
258 const char *name = evsel ? perf_evsel__name(evsel) : "unknown";
259 int err = perf_read_values_add_value(&rep->show_threads_values,
260 event->read.pid, event->read.tid,
272 /* For pipe mode, sample_type is not currently set */
273 static int report__setup_sample_type(struct report *rep)
275 struct perf_session *session = rep->session;
276 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
277 bool is_pipe = perf_data_file__is_pipe(session->file);
279 if (session->itrace_synth_opts->callchain ||
281 perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
282 !session->itrace_synth_opts->set))
283 sample_type |= PERF_SAMPLE_CALLCHAIN;
285 if (session->itrace_synth_opts->last_branch)
286 sample_type |= PERF_SAMPLE_BRANCH_STACK;
288 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
289 if (perf_hpp_list.parent) {
290 ui__error("Selected --sort parent, but no "
291 "callchain data. Did you call "
292 "'perf record' without -g?\n");
295 if (symbol_conf.use_callchain &&
296 !symbol_conf.show_branchflag_count) {
297 ui__error("Selected -g or --branch-history.\n"
298 "But no callchain or branch data.\n"
299 "Did you call 'perf record' without -g or -b?\n");
302 } else if (!callchain_param.enabled &&
303 callchain_param.mode != CHAIN_NONE &&
304 !symbol_conf.use_callchain) {
305 symbol_conf.use_callchain = true;
306 if (callchain_register_param(&callchain_param) < 0) {
307 ui__error("Can't register callchain params.\n");
312 if (symbol_conf.cumulate_callchain) {
313 /* Silently ignore if callchain is missing */
314 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
315 symbol_conf.cumulate_callchain = false;
316 perf_hpp__cancel_cumulate();
320 if (sort__mode == SORT_MODE__BRANCH) {
322 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
323 ui__error("Selected -b but no branch data. "
324 "Did you call perf record without -b?\n");
329 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
330 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
331 (sample_type & PERF_SAMPLE_STACK_USER)) {
332 callchain_param.record_mode = CALLCHAIN_DWARF;
333 dwarf_callchain_users = true;
334 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
335 callchain_param.record_mode = CALLCHAIN_LBR;
337 callchain_param.record_mode = CALLCHAIN_FP;
340 /* ??? handle more cases than just ANY? */
341 if (!(perf_evlist__combined_branch_type(session->evlist) &
342 PERF_SAMPLE_BRANCH_ANY))
343 rep->nonany_branch_mode = true;
345 #if !defined(HAVE_LIBUNWIND_SUPPORT) && !defined(HAVE_DWARF_SUPPORT)
346 if (dwarf_callchain_users) {
347 ui__warning("Please install libunwind or libdw "
348 "development packages during the perf build.\n");
355 static void sig_handler(int sig __maybe_unused)
360 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
361 const char *evname, FILE *fp)
365 unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
366 u64 nr_events = hists->stats.total_period;
367 struct perf_evsel *evsel = hists_to_evsel(hists);
369 size_t size = sizeof(buf);
370 int socked_id = hists->socket_filter;
375 if (symbol_conf.filter_relative) {
376 nr_samples = hists->stats.nr_non_filtered_samples;
377 nr_events = hists->stats.total_non_filtered_period;
380 if (perf_evsel__is_group_event(evsel)) {
381 struct perf_evsel *pos;
383 perf_evsel__group_desc(evsel, buf, size);
386 for_each_group_member(pos, evsel) {
387 const struct hists *pos_hists = evsel__hists(pos);
389 if (symbol_conf.filter_relative) {
390 nr_samples += pos_hists->stats.nr_non_filtered_samples;
391 nr_events += pos_hists->stats.total_non_filtered_period;
393 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE];
394 nr_events += pos_hists->stats.total_period;
399 nr_samples = convert_unit(nr_samples, &unit);
400 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
402 ret += fprintf(fp, " of event '%s'", evname);
404 if (symbol_conf.show_ref_callgraph && evname && strstr(evname, "call-graph=no")) {
405 ret += fprintf(fp, ", show reference callgraph");
409 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
410 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order);
412 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
415 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
417 return ret + fprintf(fp, "\n#\n");
420 static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
424 struct perf_evsel *pos;
427 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n",
428 evlist->stats.total_lost_samples);
431 evlist__for_each_entry(evlist, pos) {
432 struct hists *hists = evsel__hists(pos);
433 const char *evname = perf_evsel__name(pos);
435 if (symbol_conf.event_group &&
436 !perf_evsel__is_group_leader(pos))
439 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
440 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout,
441 symbol_conf.use_callchain ||
442 symbol_conf.show_branchflag_count);
443 fprintf(stdout, "\n\n");
447 fprintf(stdout, "#\n# (%s)\n#\n", help);
449 if (rep->show_threads) {
450 bool style = !strcmp(rep->pretty_printing_style, "raw");
451 perf_read_values_display(stdout, &rep->show_threads_values,
453 perf_read_values_destroy(&rep->show_threads_values);
456 if (sort__mode == SORT_MODE__BRANCH)
457 branch_type_stat_display(stdout, &rep->brtype_stat);
462 static void report__warn_kptr_restrict(const struct report *rep)
464 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host);
465 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
467 if (kernel_map == NULL ||
468 (kernel_map->dso->hit &&
469 (kernel_kmap->ref_reloc_sym == NULL ||
470 kernel_kmap->ref_reloc_sym->addr == 0))) {
472 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
473 "can't be resolved.";
476 const struct dso *kdso = kernel_map->dso;
477 if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
478 desc = "If some relocation was applied (e.g. "
479 "kexec) symbols may be misresolved.";
484 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
485 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
486 "Samples in kernel modules can't be resolved as well.\n\n",
491 static int report__gtk_browse_hists(struct report *rep, const char *help)
493 int (*hist_browser)(struct perf_evlist *evlist, const char *help,
494 struct hist_browser_timer *timer, float min_pcnt);
496 hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
498 if (hist_browser == NULL) {
499 ui__error("GTK browser not found!\n");
503 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
506 static int report__browse_hists(struct report *rep)
509 struct perf_session *session = rep->session;
510 struct perf_evlist *evlist = session->evlist;
511 const char *help = perf_tip(system_path(TIPDIR));
514 /* fallback for people who don't install perf ;-) */
515 help = perf_tip(DOCDIR);
517 help = "Cannot load tips.txt file, please install perf!";
520 switch (use_browser) {
522 ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
524 &session->header.env);
526 * Usually "ret" is the last pressed key, and we only
527 * care if the key notifies us to switch data file.
529 if (ret != K_SWITCH_INPUT_DATA)
533 ret = report__gtk_browse_hists(rep, help);
536 ret = perf_evlist__tty_browse_hists(evlist, rep, help);
543 static int report__collapse_hists(struct report *rep)
545 struct ui_progress prog;
546 struct perf_evsel *pos;
549 ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
551 evlist__for_each_entry(rep->session->evlist, pos) {
552 struct hists *hists = evsel__hists(pos);
555 hists->symbol_filter_str = rep->symbol_filter_str;
557 hists->socket_filter = rep->socket_filter;
559 ret = hists__collapse_resort(hists, &prog);
563 /* Non-group events are considered as leader */
564 if (symbol_conf.event_group &&
565 !perf_evsel__is_group_leader(pos)) {
566 struct hists *leader_hists = evsel__hists(pos->leader);
568 hists__match(leader_hists, hists);
569 hists__link(leader_hists, hists);
573 ui_progress__finish();
577 static void report__output_resort(struct report *rep)
579 struct ui_progress prog;
580 struct perf_evsel *pos;
582 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
584 evlist__for_each_entry(rep->session->evlist, pos)
585 perf_evsel__output_resort(pos, &prog);
587 ui_progress__finish();
590 static int __cmd_report(struct report *rep)
593 struct perf_session *session = rep->session;
594 struct perf_evsel *pos;
595 struct perf_data_file *file = session->file;
597 signal(SIGINT, sig_handler);
600 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
603 ui__error("failed to set cpu bitmap\n");
606 session->itrace_synth_opts->cpu_bitmap = rep->cpu_bitmap;
609 if (rep->show_threads) {
610 ret = perf_read_values_init(&rep->show_threads_values);
615 ret = report__setup_sample_type(rep);
617 /* report__setup_sample_type() already showed error message */
621 ret = perf_session__process_events(session);
623 ui__error("failed to process sample\n");
627 report__warn_kptr_restrict(rep);
629 evlist__for_each_entry(session->evlist, pos)
630 rep->nr_entries += evsel__hists(pos)->nr_entries;
632 if (use_browser == 0) {
634 perf_session__fprintf(session, stdout);
637 perf_session__fprintf_dsos(session, stdout);
640 perf_session__fprintf_nr_events(session, stdout);
641 perf_evlist__fprintf_nr_events(session->evlist, stdout);
646 ret = report__collapse_hists(rep);
648 ui__error("failed to process hist entry\n");
656 * recalculate number of entries after collapsing since it
657 * might be changed during the collapse phase.
660 evlist__for_each_entry(session->evlist, pos)
661 rep->nr_entries += evsel__hists(pos)->nr_entries;
663 if (rep->nr_entries == 0) {
664 ui__error("The %s file has no samples!\n", file->path);
668 report__output_resort(rep);
670 return report__browse_hists(rep);
674 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
676 struct callchain_param *callchain = opt->value;
678 callchain->enabled = !unset;
683 symbol_conf.use_callchain = false;
684 callchain->mode = CHAIN_NONE;
688 return parse_callchain_report_opt(arg);
692 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
693 const char *arg, int unset __maybe_unused)
696 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
699 regerror(err, &ignore_callees_regex, buf, sizeof(buf));
700 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
703 have_ignore_callees = 1;
710 parse_branch_mode(const struct option *opt,
711 const char *str __maybe_unused, int unset)
713 int *branch_mode = opt->value;
715 *branch_mode = !unset;
720 parse_percent_limit(const struct option *opt, const char *str,
721 int unset __maybe_unused)
723 struct report *rep = opt->value;
724 double pcnt = strtof(str, NULL);
726 rep->min_percent = pcnt;
727 callchain_param.min_percent = pcnt;
731 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
733 const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n"
734 CALLCHAIN_REPORT_HELP
735 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT;
737 int cmd_report(int argc, const char **argv)
739 struct perf_session *session;
740 struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
742 bool has_br_stack = false;
743 int branch_mode = -1;
745 bool branch_call_mode = false;
746 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT;
747 const char * const report_usage[] = {
748 "perf report [<options>]",
751 struct report report = {
753 .sample = process_sample_event,
754 .mmap = perf_event__process_mmap,
755 .mmap2 = perf_event__process_mmap2,
756 .comm = perf_event__process_comm,
757 .namespaces = perf_event__process_namespaces,
758 .exit = perf_event__process_exit,
759 .fork = perf_event__process_fork,
760 .lost = perf_event__process_lost,
761 .read = process_read_event,
762 .attr = perf_event__process_attr,
763 .tracing_data = perf_event__process_tracing_data,
764 .build_id = perf_event__process_build_id,
765 .id_index = perf_event__process_id_index,
766 .auxtrace_info = perf_event__process_auxtrace_info,
767 .auxtrace = perf_event__process_auxtrace,
768 .feature = perf_event__process_feature,
769 .ordered_events = true,
770 .ordering_requires_timestamps = true,
772 .max_stack = PERF_MAX_STACK_DEPTH,
773 .pretty_printing_style = "normal",
776 const struct option options[] = {
777 OPT_STRING('i', "input", &input_name, "file",
779 OPT_INCR('v', "verbose", &verbose,
780 "be more verbose (show symbol address, etc)"),
781 OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any message"),
782 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
783 "dump raw trace in ASCII"),
784 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
785 "file", "vmlinux pathname"),
786 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
787 "file", "kallsyms pathname"),
788 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
789 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
790 "load module symbols - WARNING: use only with -k and LIVE kernel"),
791 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
792 "Show a column with the number of samples"),
793 OPT_BOOLEAN('T', "threads", &report.show_threads,
794 "Show per-thread event counters"),
795 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
796 "pretty printing style key: normal raw"),
797 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
798 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
799 OPT_BOOLEAN(0, "stdio", &report.use_stdio,
800 "Use the stdio interface"),
801 OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
802 OPT_BOOLEAN(0, "header-only", &report.header_only,
803 "Show only data header."),
804 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
805 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
806 " Please refer the man page for the complete list."),
807 OPT_STRING('F', "fields", &field_order, "key[,keys...]",
808 "output field(s): overhead, period, sample plus all of sort keys"),
809 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization,
810 "Show sample percentage for different cpu modes"),
811 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
812 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN),
813 OPT_STRING('p', "parent", &parent_pattern, "regex",
814 "regex filter to identify parent, see: '--sort parent'"),
815 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
816 "Only display entries with parent-match"),
817 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param,
818 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
819 report_callchain_help, &report_parse_callchain_opt,
820 callchain_default_opt),
821 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
822 "Accumulate callchains of children and show total overhead as well"),
823 OPT_INTEGER(0, "max-stack", &report.max_stack,
824 "Set the maximum stack depth when parsing the callchain, "
825 "anything beyond the specified depth will be ignored. "
826 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
827 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
828 "alias for inverted call graph"),
829 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
830 "ignore callees of these functions in call graphs",
831 report_parse_ignore_callees_opt),
832 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
833 "only consider symbols in these dsos"),
834 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
835 "only consider symbols in these comms"),
836 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
837 "only consider symbols in these pids"),
838 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
839 "only consider symbols in these tids"),
840 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
841 "only consider these symbols"),
842 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
843 "only show symbols that (partially) match with this filter"),
844 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
846 "don't try to adjust column width, use these fixed values"),
847 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
848 "separator for columns, no spaces will be added between "
849 "columns '.' is reserved."),
850 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved,
851 "Only display entries resolved to a symbol"),
852 OPT_CALLBACK(0, "symfs", NULL, "directory",
853 "Look for files with symbols relative to this directory",
854 symbol__config_symfs),
855 OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
856 "list of cpus to profile"),
857 OPT_BOOLEAN('I', "show-info", &report.show_full_info,
858 "Display extended information about perf.data file"),
859 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
860 "Interleave source code with assembly code (default)"),
861 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
862 "Display raw encoding of assembly instructions (default)"),
863 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
864 "Specify disassembler style (e.g. -M intel for intel syntax)"),
865 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
866 "Show a column with the sum of periods"),
867 OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
868 "Show event group information together"),
869 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
870 "use branch records for per branch histogram filling",
872 OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
873 "add last branch records to call history"),
874 OPT_STRING(0, "objdump", &objdump_path, "path",
875 "objdump binary to use for disassembly and annotations"),
876 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
877 "Disable symbol demangling"),
878 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
879 "Enable kernel symbol demangling"),
880 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
881 OPT_CALLBACK(0, "percent-limit", &report, "percent",
882 "Don't show entries under that percent", parse_percent_limit),
883 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
884 "how to display percentage of filtered entries", parse_filter_percentage),
885 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
886 "Instruction Tracing options",
887 itrace_parse_synth_opts),
888 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
889 "Show full source file name path for source lines"),
890 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
891 "Show callgraph from reference event"),
892 OPT_INTEGER(0, "socket-filter", &report.socket_filter,
893 "only show processor socket that match with this filter"),
894 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
895 "Show raw trace event output (do not use print fmt or plugins)"),
896 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
897 "Show entries in a hierarchy"),
898 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
899 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
900 stdio__config_color, "always"),
901 OPT_STRING(0, "time", &report.time_str, "str",
902 "Time span of interest (start,stop)"),
903 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
904 "Show inline function"),
907 struct perf_data_file file = {
908 .mode = PERF_DATA_MODE_READ,
910 int ret = hists__init();
915 ret = perf_config(report__config, &report);
919 argc = parse_options(argc, argv, options, report_usage, 0);
922 * Special case: if there's an argument left then assume that
923 * it's a symbol filter:
926 usage_with_options(report_usage, options);
928 report.symbol_filter_str = argv[0];
934 if (symbol_conf.vmlinux_name &&
935 access(symbol_conf.vmlinux_name, R_OK)) {
936 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
939 if (symbol_conf.kallsyms_name &&
940 access(symbol_conf.kallsyms_name, R_OK)) {
941 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);
945 if (report.use_stdio)
947 else if (report.use_tui)
949 else if (report.use_gtk)
952 if (report.inverted_callchain)
953 callchain_param.order = ORDER_CALLER;
954 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
955 callchain_param.order = ORDER_CALLER;
957 if (itrace_synth_opts.callchain &&
958 (int)itrace_synth_opts.callchain_sz > report.max_stack)
959 report.max_stack = itrace_synth_opts.callchain_sz;
961 if (!input_name || !strlen(input_name)) {
962 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
965 input_name = "perf.data";
968 file.path = input_name;
969 file.force = symbol_conf.force;
972 session = perf_session__new(&file, false, &report.tool);
976 if (report.queue_size) {
977 ordered_events__set_alloc_size(&session->ordered_events,
981 session->itrace_synth_opts = &itrace_synth_opts;
983 report.session = session;
985 has_br_stack = perf_header__has_feat(&session->header,
986 HEADER_BRANCH_STACK);
988 if (itrace_synth_opts.last_branch)
991 if (has_br_stack && branch_call_mode)
992 symbol_conf.show_branchflag_count = true;
994 memset(&report.brtype_stat, 0, sizeof(struct branch_type_stat));
997 * Branch mode is a tristate:
998 * -1 means default, so decide based on the file having branch data.
999 * 0/1 means the user chose a mode.
1001 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
1002 !branch_call_mode) {
1003 sort__mode = SORT_MODE__BRANCH;
1004 symbol_conf.cumulate_callchain = false;
1006 if (branch_call_mode) {
1007 callchain_param.key = CCKEY_ADDRESS;
1008 callchain_param.branch_callstack = 1;
1009 symbol_conf.use_callchain = true;
1010 callchain_register_param(&callchain_param);
1011 if (sort_order == NULL)
1012 sort_order = "srcline,symbol,dso";
1015 if (report.mem_mode) {
1016 if (sort__mode == SORT_MODE__BRANCH) {
1017 pr_err("branch and mem mode incompatible\n");
1020 sort__mode = SORT_MODE__MEMORY;
1021 symbol_conf.cumulate_callchain = false;
1024 if (symbol_conf.report_hierarchy) {
1025 /* disable incompatible options */
1026 symbol_conf.cumulate_callchain = false;
1029 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1030 parse_options_usage(report_usage, options, "F", 1);
1031 parse_options_usage(NULL, options, "hierarchy", 0);
1035 perf_hpp_list.need_collapse = true;
1038 /* Force tty output for header output and per-thread stat. */
1039 if (report.header || report.header_only || report.show_threads)
1041 if (report.header || report.header_only)
1042 report.tool.show_feat_hdr = SHOW_FEAT_HEADER;
1043 if (report.show_full_info)
1044 report.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
1046 if (strcmp(input_name, "-") != 0)
1047 setup_browser(true);
1051 if ((last_key != K_SWITCH_INPUT_DATA) &&
1052 (setup_sorting(session->evlist) < 0)) {
1054 parse_options_usage(report_usage, options, "s", 1);
1056 parse_options_usage(sort_order ? NULL : report_usage,
1061 if ((report.header || report.header_only) && !quiet) {
1062 perf_session__fprintf_info(session, stdout,
1063 report.show_full_info);
1064 if (report.header_only) {
1068 } else if (use_browser == 0 && !quiet) {
1069 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1074 * Only in the TUI browser we are doing integrated annotation,
1075 * so don't allocate extra space that won't be used in the stdio
1078 if (ui__has_annotation()) {
1079 ret = symbol__annotation_init();
1083 * For searching by name on the "Browse map details".
1084 * providing it only in verbose mode not to bloat too
1085 * much struct symbol.
1089 * XXX: Need to provide a less kludgy way to ask for
1090 * more space per symbol, the u32 is for the index on
1092 * See symbol__browser_index.
1094 symbol_conf.priv_size += sizeof(u32);
1095 symbol_conf.sort_by_name = true;
1099 if (symbol__init(&session->header.env) < 0)
1102 if (perf_time__parse_str(&report.ptime, report.time_str) != 0) {
1103 pr_err("Invalid time string\n");
1107 sort__setup_elide(stdout);
1109 ret = __cmd_report(&report);
1110 if (ret == K_SWITCH_INPUT_DATA) {
1111 perf_session__delete(session);
1112 last_key = K_SWITCH_INPUT_DATA;
1118 perf_session__delete(session);