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/config.h"
13 #include "util/annotate.h"
14 #include "util/color.h"
16 #include <linux/list.h>
17 #include <linux/rbtree.h>
18 #include <linux/err.h>
19 #include <linux/zalloc.h>
21 #include "util/symbol.h"
22 #include "util/map_symbol.h"
23 #include "util/mem-events.h"
24 #include "util/branch.h"
25 #include "util/callchain.h"
26 #include "util/values.h"
29 #include "util/debug.h"
30 #include "util/evlist.h"
31 #include "util/evsel.h"
32 #include "util/evswitch.h"
33 #include "util/header.h"
34 #include "util/session.h"
35 #include "util/srcline.h"
36 #include "util/tool.h"
38 #include <subcmd/parse-options.h>
39 #include <subcmd/exec-cmd.h>
40 #include "util/parse-events.h"
42 #include "util/thread.h"
43 #include "util/sort.h"
44 #include "util/hist.h"
45 #include "util/data.h"
46 #include "arch/common.h"
47 #include "util/time-utils.h"
48 #include "util/auxtrace.h"
49 #include "util/units.h"
50 #include "util/branch.h"
51 #include "util/util.h" // perf_tip()
53 #include "ui/progress.h"
54 #include "util/block-info.h"
60 #include <linux/ctype.h>
62 #include <linux/bitmap.h>
63 #include <linux/string.h>
64 #include <linux/stringify.h>
65 #include <linux/time64.h>
66 #include <sys/types.h>
69 #include <linux/mman.h>
72 struct perf_tool tool;
73 struct perf_session *session;
74 struct evswitch evswitch;
75 bool use_tui, use_gtk, use_stdio;
78 bool inverted_callchain;
85 bool nonany_branch_mode;
88 struct perf_read_values show_threads_values;
89 struct annotation_options annotation_opts;
90 const char *pretty_printing_style;
92 const char *symbol_filter_str;
94 struct perf_time_interval *ptime_range;
102 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
103 struct branch_type_stat brtype_stat;
105 bool total_cycles_mode;
106 struct block_report *block_reports;
109 static int report__config(const char *var, const char *value, void *cb)
111 struct report *rep = cb;
113 if (!strcmp(var, "report.group")) {
114 symbol_conf.event_group = perf_config_bool(var, value);
117 if (!strcmp(var, "report.percent-limit")) {
118 double pcnt = strtof(value, NULL);
120 rep->min_percent = pcnt;
121 callchain_param.min_percent = pcnt;
124 if (!strcmp(var, "report.children")) {
125 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
128 if (!strcmp(var, "report.queue-size"))
129 return perf_config_u64(&rep->queue_size, var, value);
131 if (!strcmp(var, "report.sort_order")) {
132 default_sort_order = strdup(value);
139 static int hist_iter__report_callback(struct hist_entry_iter *iter,
140 struct addr_location *al, bool single,
144 struct report *rep = arg;
145 struct hist_entry *he = iter->he;
146 struct evsel *evsel = iter->evsel;
147 struct perf_sample *sample = iter->sample;
149 struct branch_info *bi;
151 if (!ui__has_annotation() && !rep->symbol_ipc)
154 if (sort__mode == SORT_MODE__BRANCH) {
155 bi = he->branch_info;
156 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
160 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
162 } else if (rep->mem_mode) {
164 err = addr_map_symbol__inc_samples(&mi->daddr, sample, evsel);
168 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
170 } else if (symbol_conf.cumulate_callchain) {
172 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
174 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
181 static int hist_iter__branch_callback(struct hist_entry_iter *iter,
182 struct addr_location *al __maybe_unused,
183 bool single __maybe_unused,
186 struct hist_entry *he = iter->he;
187 struct report *rep = arg;
188 struct branch_info *bi;
189 struct perf_sample *sample = iter->sample;
190 struct evsel *evsel = iter->evsel;
193 if (!ui__has_annotation() && !rep->symbol_ipc)
196 bi = he->branch_info;
197 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
201 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
203 branch_type_count(&rep->brtype_stat, &bi->flags,
204 bi->from.addr, bi->to.addr);
210 static void setup_forced_leader(struct report *report,
211 struct evlist *evlist)
213 if (report->group_set)
214 perf_evlist__force_leader(evlist);
217 static int process_feature_event(struct perf_session *session,
218 union perf_event *event)
220 struct report *rep = container_of(session->tool, struct report, tool);
222 if (event->feat.feat_id < HEADER_LAST_FEATURE)
223 return perf_event__process_feature(session, event);
225 if (event->feat.feat_id != HEADER_LAST_FEATURE) {
226 pr_err("failed: wrong feature ID: %" PRI_lu64 "\n",
227 event->feat.feat_id);
232 * (feat_id = HEADER_LAST_FEATURE) is the end marker which
233 * means all features are received, now we can force the
236 setup_forced_leader(rep, session->evlist);
240 static int process_sample_event(struct perf_tool *tool,
241 union perf_event *event,
242 struct perf_sample *sample,
244 struct machine *machine)
246 struct report *rep = container_of(tool, struct report, tool);
247 struct addr_location al;
248 struct hist_entry_iter iter = {
251 .hide_unresolved = symbol_conf.hide_unresolved,
252 .add_entry_cb = hist_iter__report_callback,
256 if (perf_time__ranges_skip_sample(rep->ptime_range, rep->range_num,
261 if (evswitch__discard(&rep->evswitch, evsel))
264 if (machine__resolve(machine, &al, sample) < 0) {
265 pr_debug("problem processing %d event, skipping it.\n",
270 if (symbol_conf.hide_unresolved && al.sym == NULL)
273 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
276 if (sort__mode == SORT_MODE__BRANCH) {
278 * A non-synthesized event might not have a branch stack if
279 * branch stacks have been synthesized (using itrace options).
281 if (!sample->branch_stack)
284 iter.add_entry_cb = hist_iter__branch_callback;
285 iter.ops = &hist_iter_branch;
286 } else if (rep->mem_mode) {
287 iter.ops = &hist_iter_mem;
288 } else if (symbol_conf.cumulate_callchain) {
289 iter.ops = &hist_iter_cumulative;
291 iter.ops = &hist_iter_normal;
295 al.map->dso->hit = 1;
297 if (ui__has_annotation() || rep->symbol_ipc || rep->total_cycles_mode) {
298 hist__account_cycles(sample->branch_stack, &al, sample,
299 rep->nonany_branch_mode,
303 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
305 pr_debug("problem adding hist entry, skipping event\n");
307 addr_location__put(&al);
311 static int process_read_event(struct perf_tool *tool,
312 union perf_event *event,
313 struct perf_sample *sample __maybe_unused,
315 struct machine *machine __maybe_unused)
317 struct report *rep = container_of(tool, struct report, tool);
319 if (rep->show_threads) {
320 const char *name = perf_evsel__name(evsel);
321 int err = perf_read_values_add_value(&rep->show_threads_values,
322 event->read.pid, event->read.tid,
334 /* For pipe mode, sample_type is not currently set */
335 static int report__setup_sample_type(struct report *rep)
337 struct perf_session *session = rep->session;
338 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
339 bool is_pipe = perf_data__is_pipe(session->data);
341 if (session->itrace_synth_opts->callchain ||
343 perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
344 !session->itrace_synth_opts->set))
345 sample_type |= PERF_SAMPLE_CALLCHAIN;
347 if (session->itrace_synth_opts->last_branch)
348 sample_type |= PERF_SAMPLE_BRANCH_STACK;
350 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
351 if (perf_hpp_list.parent) {
352 ui__error("Selected --sort parent, but no "
353 "callchain data. Did you call "
354 "'perf record' without -g?\n");
357 if (symbol_conf.use_callchain &&
358 !symbol_conf.show_branchflag_count) {
359 ui__error("Selected -g or --branch-history.\n"
360 "But no callchain or branch data.\n"
361 "Did you call 'perf record' without -g or -b?\n");
364 } else if (!callchain_param.enabled &&
365 callchain_param.mode != CHAIN_NONE &&
366 !symbol_conf.use_callchain) {
367 symbol_conf.use_callchain = true;
368 if (callchain_register_param(&callchain_param) < 0) {
369 ui__error("Can't register callchain params.\n");
374 if (symbol_conf.cumulate_callchain) {
375 /* Silently ignore if callchain is missing */
376 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
377 symbol_conf.cumulate_callchain = false;
378 perf_hpp__cancel_cumulate();
382 if (sort__mode == SORT_MODE__BRANCH) {
384 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
385 ui__error("Selected -b but no branch data. "
386 "Did you call perf record without -b?\n");
391 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
392 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
393 (sample_type & PERF_SAMPLE_STACK_USER)) {
394 callchain_param.record_mode = CALLCHAIN_DWARF;
395 dwarf_callchain_users = true;
396 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
397 callchain_param.record_mode = CALLCHAIN_LBR;
399 callchain_param.record_mode = CALLCHAIN_FP;
402 /* ??? handle more cases than just ANY? */
403 if (!(perf_evlist__combined_branch_type(session->evlist) &
404 PERF_SAMPLE_BRANCH_ANY))
405 rep->nonany_branch_mode = true;
407 #ifndef HAVE_LIBUNWIND_SUPPORT
408 if (dwarf_callchain_users) {
409 ui__warning("Please install libunwind development packages "
410 "during the perf build.\n");
417 static void sig_handler(int sig __maybe_unused)
422 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
423 const char *evname, FILE *fp)
427 unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
428 u64 nr_events = hists->stats.total_period;
429 struct evsel *evsel = hists_to_evsel(hists);
431 size_t size = sizeof(buf);
432 int socked_id = hists->socket_filter;
437 if (symbol_conf.filter_relative) {
438 nr_samples = hists->stats.nr_non_filtered_samples;
439 nr_events = hists->stats.total_non_filtered_period;
442 if (perf_evsel__is_group_event(evsel)) {
445 perf_evsel__group_desc(evsel, buf, size);
448 for_each_group_member(pos, evsel) {
449 const struct hists *pos_hists = evsel__hists(pos);
451 if (symbol_conf.filter_relative) {
452 nr_samples += pos_hists->stats.nr_non_filtered_samples;
453 nr_events += pos_hists->stats.total_non_filtered_period;
455 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE];
456 nr_events += pos_hists->stats.total_period;
461 nr_samples = convert_unit(nr_samples, &unit);
462 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
463 if (evname != NULL) {
464 ret += fprintf(fp, " of event%s '%s'",
465 evsel->core.nr_members > 1 ? "s" : "", evname);
469 ret += fprintf(fp, " (time slices: %s)", rep->time_str);
471 if (symbol_conf.show_ref_callgraph &&
472 strstr(evname, "call-graph=no")) {
473 ret += fprintf(fp, ", show reference callgraph");
477 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
478 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order);
480 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
483 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
485 return ret + fprintf(fp, "\n#\n");
488 static int perf_evlist__tui_block_hists_browse(struct evlist *evlist,
494 evlist__for_each_entry(evlist, pos) {
495 ret = report__browse_block_hists(&rep->block_reports[i++].hist,
496 rep->min_percent, pos,
497 &rep->session->header.env,
498 &rep->annotation_opts);
506 static int perf_evlist__tty_browse_hists(struct evlist *evlist,
514 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n",
515 evlist->stats.total_lost_samples);
518 evlist__for_each_entry(evlist, pos) {
519 struct hists *hists = evsel__hists(pos);
520 const char *evname = perf_evsel__name(pos);
522 if (symbol_conf.event_group &&
523 !perf_evsel__is_group_leader(pos))
526 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
528 if (rep->total_cycles_mode) {
529 report__browse_block_hists(&rep->block_reports[i++].hist,
530 rep->min_percent, pos,
535 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout,
536 !(symbol_conf.use_callchain ||
537 symbol_conf.show_branchflag_count));
538 fprintf(stdout, "\n\n");
542 fprintf(stdout, "#\n# (%s)\n#\n", help);
544 if (rep->show_threads) {
545 bool style = !strcmp(rep->pretty_printing_style, "raw");
546 perf_read_values_display(stdout, &rep->show_threads_values,
548 perf_read_values_destroy(&rep->show_threads_values);
551 if (sort__mode == SORT_MODE__BRANCH)
552 branch_type_stat_display(stdout, &rep->brtype_stat);
557 static void report__warn_kptr_restrict(const struct report *rep)
559 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host);
560 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
562 if (perf_evlist__exclude_kernel(rep->session->evlist))
565 if (kernel_map == NULL ||
566 (kernel_map->dso->hit &&
567 (kernel_kmap->ref_reloc_sym == NULL ||
568 kernel_kmap->ref_reloc_sym->addr == 0))) {
570 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
571 "can't be resolved.";
573 if (kernel_map && map__has_symbols(kernel_map)) {
574 desc = "If some relocation was applied (e.g. "
575 "kexec) symbols may be misresolved.";
579 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
580 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
581 "Samples in kernel modules can't be resolved as well.\n\n",
586 static int report__gtk_browse_hists(struct report *rep, const char *help)
588 int (*hist_browser)(struct evlist *evlist, const char *help,
589 struct hist_browser_timer *timer, float min_pcnt);
591 hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
593 if (hist_browser == NULL) {
594 ui__error("GTK browser not found!\n");
598 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
601 static int report__browse_hists(struct report *rep)
604 struct perf_session *session = rep->session;
605 struct evlist *evlist = session->evlist;
606 const char *help = perf_tip(system_path(TIPDIR));
609 /* fallback for people who don't install perf ;-) */
610 help = perf_tip(DOCDIR);
612 help = "Cannot load tips.txt file, please install perf!";
615 switch (use_browser) {
617 if (rep->total_cycles_mode) {
618 ret = perf_evlist__tui_block_hists_browse(evlist, rep);
622 ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
624 &session->header.env,
625 true, &rep->annotation_opts);
627 * Usually "ret" is the last pressed key, and we only
628 * care if the key notifies us to switch data file.
630 if (ret != K_SWITCH_INPUT_DATA)
634 ret = report__gtk_browse_hists(rep, help);
637 ret = perf_evlist__tty_browse_hists(evlist, rep, help);
644 static int report__collapse_hists(struct report *rep)
646 struct ui_progress prog;
650 ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
652 evlist__for_each_entry(rep->session->evlist, pos) {
653 struct hists *hists = evsel__hists(pos);
656 hists->symbol_filter_str = rep->symbol_filter_str;
658 hists->socket_filter = rep->socket_filter;
660 ret = hists__collapse_resort(hists, &prog);
664 /* Non-group events are considered as leader */
665 if (symbol_conf.event_group &&
666 !perf_evsel__is_group_leader(pos)) {
667 struct hists *leader_hists = evsel__hists(pos->leader);
669 hists__match(leader_hists, hists);
670 hists__link(leader_hists, hists);
674 ui_progress__finish();
678 static int hists__resort_cb(struct hist_entry *he, void *arg)
680 struct report *rep = arg;
681 struct symbol *sym = he->ms.sym;
683 if (rep->symbol_ipc && sym && !sym->annotate2) {
684 struct evsel *evsel = hists_to_evsel(he->hists);
686 symbol__annotate2(&he->ms, evsel,
687 &annotation__default_options, NULL);
693 static void report__output_resort(struct report *rep)
695 struct ui_progress prog;
698 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
700 evlist__for_each_entry(rep->session->evlist, pos) {
701 perf_evsel__output_resort_cb(pos, &prog,
702 hists__resort_cb, rep);
705 ui_progress__finish();
708 static void stats_setup(struct report *rep)
710 memset(&rep->tool, 0, sizeof(rep->tool));
711 rep->tool.no_warn = true;
714 static int stats_print(struct report *rep)
716 struct perf_session *session = rep->session;
718 perf_session__fprintf_nr_events(session, stdout);
722 static void tasks_setup(struct report *rep)
724 memset(&rep->tool, 0, sizeof(rep->tool));
725 rep->tool.ordered_events = true;
726 if (rep->mmaps_mode) {
727 rep->tool.mmap = perf_event__process_mmap;
728 rep->tool.mmap2 = perf_event__process_mmap2;
730 rep->tool.comm = perf_event__process_comm;
731 rep->tool.exit = perf_event__process_exit;
732 rep->tool.fork = perf_event__process_fork;
733 rep->tool.no_warn = true;
737 struct thread *thread;
738 struct list_head list;
739 struct list_head children;
742 static struct task *tasks_list(struct task *task, struct machine *machine)
744 struct thread *parent_thread, *thread = task->thread;
745 struct task *parent_task;
747 /* Already listed. */
748 if (!list_empty(&task->list))
751 /* Last one in the chain. */
752 if (thread->ppid == -1)
755 parent_thread = machine__find_thread(machine, -1, thread->ppid);
757 return ERR_PTR(-ENOENT);
759 parent_task = thread__priv(parent_thread);
760 list_add_tail(&task->list, &parent_task->children);
761 return tasks_list(parent_task, machine);
764 static size_t maps__fprintf_task(struct maps *maps, int indent, FILE *fp)
769 maps__for_each_entry(maps, map) {
770 printed += fprintf(fp, "%*s %" PRIx64 "-%" PRIx64 " %c%c%c%c %08" PRIx64 " %" PRIu64 " %s\n",
771 indent, "", map->start, map->end,
772 map->prot & PROT_READ ? 'r' : '-',
773 map->prot & PROT_WRITE ? 'w' : '-',
774 map->prot & PROT_EXEC ? 'x' : '-',
775 map->flags & MAP_SHARED ? 's' : 'p',
777 map->dso->id.ino, map->dso->name);
783 static int map_groups__fprintf_task(struct map_groups *mg, int indent, FILE *fp)
785 return maps__fprintf_task(&mg->maps, indent, fp);
788 static void task__print_level(struct task *task, FILE *fp, int level)
790 struct thread *thread = task->thread;
792 int comm_indent = fprintf(fp, " %8d %8d %8d |%*s",
793 thread->pid_, thread->tid, thread->ppid,
796 fprintf(fp, "%s\n", thread__comm_str(thread));
798 map_groups__fprintf_task(thread->mg, comm_indent, fp);
800 if (!list_empty(&task->children)) {
801 list_for_each_entry(child, &task->children, list)
802 task__print_level(child, fp, level + 1);
806 static int tasks_print(struct report *rep, FILE *fp)
808 struct perf_session *session = rep->session;
809 struct machine *machine = &session->machines.host;
810 struct task *tasks, *task;
811 unsigned int nr = 0, itask = 0, i;
816 * No locking needed while accessing machine->threads,
817 * because --tasks is single threaded command.
820 /* Count all the threads. */
821 for (i = 0; i < THREADS__TABLE_SIZE; i++)
822 nr += machine->threads[i].nr;
824 tasks = malloc(sizeof(*tasks) * nr);
828 for (i = 0; i < THREADS__TABLE_SIZE; i++) {
829 struct threads *threads = &machine->threads[i];
831 for (nd = rb_first_cached(&threads->entries); nd;
833 task = tasks + itask++;
835 task->thread = rb_entry(nd, struct thread, rb_node);
836 INIT_LIST_HEAD(&task->children);
837 INIT_LIST_HEAD(&task->list);
838 thread__set_priv(task->thread, task);
843 * Iterate every task down to the unprocessed parent
844 * and link all in task children list. Task with no
845 * parent is added into 'list'.
847 for (itask = 0; itask < nr; itask++) {
848 task = tasks + itask;
850 if (!list_empty(&task->list))
853 task = tasks_list(task, machine);
855 pr_err("Error: failed to process tasks\n");
857 return PTR_ERR(task);
861 list_add_tail(&task->list, &list);
864 fprintf(fp, "# %8s %8s %8s %s\n", "pid", "tid", "ppid", "comm");
866 list_for_each_entry(task, &list, list)
867 task__print_level(task, fp, 0);
873 static int __cmd_report(struct report *rep)
876 struct perf_session *session = rep->session;
878 struct perf_data *data = session->data;
880 signal(SIGINT, sig_handler);
883 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
886 ui__error("failed to set cpu bitmap\n");
889 session->itrace_synth_opts->cpu_bitmap = rep->cpu_bitmap;
892 if (rep->show_threads) {
893 ret = perf_read_values_init(&rep->show_threads_values);
898 ret = report__setup_sample_type(rep);
900 /* report__setup_sample_type() already showed error message */
910 ret = perf_session__process_events(session);
912 ui__error("failed to process sample\n");
917 return stats_print(rep);
920 return tasks_print(rep, stdout);
922 report__warn_kptr_restrict(rep);
924 evlist__for_each_entry(session->evlist, pos)
925 rep->nr_entries += evsel__hists(pos)->nr_entries;
927 if (use_browser == 0) {
929 perf_session__fprintf(session, stdout);
932 perf_session__fprintf_dsos(session, stdout);
935 perf_session__fprintf_nr_events(session, stdout);
936 perf_evlist__fprintf_nr_events(session->evlist, stdout);
941 ret = report__collapse_hists(rep);
943 ui__error("failed to process hist entry\n");
951 * recalculate number of entries after collapsing since it
952 * might be changed during the collapse phase.
955 evlist__for_each_entry(session->evlist, pos)
956 rep->nr_entries += evsel__hists(pos)->nr_entries;
958 if (rep->nr_entries == 0) {
959 ui__error("The %s data has no samples!\n", data->path);
963 report__output_resort(rep);
965 if (rep->total_cycles_mode) {
966 rep->block_reports = block_info__create_report(session->evlist,
968 if (!rep->block_reports)
972 return report__browse_hists(rep);
976 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
978 struct callchain_param *callchain = opt->value;
980 callchain->enabled = !unset;
985 symbol_conf.use_callchain = false;
986 callchain->mode = CHAIN_NONE;
990 return parse_callchain_report_opt(arg);
994 parse_time_quantum(const struct option *opt, const char *arg,
995 int unset __maybe_unused)
997 unsigned long *time_q = opt->value;
1000 *time_q = strtoul(arg, &end, 0);
1004 pr_err("time quantum cannot be 0");
1007 end = skip_spaces(end);
1010 if (!strcmp(end, "s")) {
1011 *time_q *= NSEC_PER_SEC;
1014 if (!strcmp(end, "ms")) {
1015 *time_q *= NSEC_PER_MSEC;
1018 if (!strcmp(end, "us")) {
1019 *time_q *= NSEC_PER_USEC;
1022 if (!strcmp(end, "ns"))
1025 pr_err("Cannot parse time quantum `%s'\n", arg);
1030 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
1031 const char *arg, int unset __maybe_unused)
1034 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
1037 regerror(err, &ignore_callees_regex, buf, sizeof(buf));
1038 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
1041 have_ignore_callees = 1;
1048 parse_branch_mode(const struct option *opt,
1049 const char *str __maybe_unused, int unset)
1051 int *branch_mode = opt->value;
1053 *branch_mode = !unset;
1058 parse_percent_limit(const struct option *opt, const char *str,
1059 int unset __maybe_unused)
1061 struct report *rep = opt->value;
1062 double pcnt = strtof(str, NULL);
1064 rep->min_percent = pcnt;
1065 callchain_param.min_percent = pcnt;
1069 int cmd_report(int argc, const char **argv)
1071 struct perf_session *session;
1072 struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
1074 bool has_br_stack = false;
1075 int branch_mode = -1;
1076 bool branch_call_mode = false;
1077 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
1078 static const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n"
1079 CALLCHAIN_REPORT_HELP
1080 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT;
1081 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT;
1082 const char * const report_usage[] = {
1083 "perf report [<options>]",
1086 struct report report = {
1088 .sample = process_sample_event,
1089 .mmap = perf_event__process_mmap,
1090 .mmap2 = perf_event__process_mmap2,
1091 .comm = perf_event__process_comm,
1092 .namespaces = perf_event__process_namespaces,
1093 .exit = perf_event__process_exit,
1094 .fork = perf_event__process_fork,
1095 .lost = perf_event__process_lost,
1096 .read = process_read_event,
1097 .attr = perf_event__process_attr,
1098 .tracing_data = perf_event__process_tracing_data,
1099 .build_id = perf_event__process_build_id,
1100 .id_index = perf_event__process_id_index,
1101 .auxtrace_info = perf_event__process_auxtrace_info,
1102 .auxtrace = perf_event__process_auxtrace,
1103 .event_update = perf_event__process_event_update,
1104 .feature = process_feature_event,
1105 .ordered_events = true,
1106 .ordering_requires_timestamps = true,
1108 .max_stack = PERF_MAX_STACK_DEPTH,
1109 .pretty_printing_style = "normal",
1110 .socket_filter = -1,
1111 .annotation_opts = annotation__default_options,
1113 const struct option options[] = {
1114 OPT_STRING('i', "input", &input_name, "file",
1116 OPT_INCR('v', "verbose", &verbose,
1117 "be more verbose (show symbol address, etc)"),
1118 OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any message"),
1119 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1120 "dump raw trace in ASCII"),
1121 OPT_BOOLEAN(0, "stats", &report.stats_mode, "Display event stats"),
1122 OPT_BOOLEAN(0, "tasks", &report.tasks_mode, "Display recorded tasks"),
1123 OPT_BOOLEAN(0, "mmaps", &report.mmaps_mode, "Display recorded tasks memory maps"),
1124 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1125 "file", "vmlinux pathname"),
1126 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1127 "don't load vmlinux even if found"),
1128 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1129 "file", "kallsyms pathname"),
1130 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
1131 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
1132 "load module symbols - WARNING: use only with -k and LIVE kernel"),
1133 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1134 "Show a column with the number of samples"),
1135 OPT_BOOLEAN('T', "threads", &report.show_threads,
1136 "Show per-thread event counters"),
1137 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
1138 "pretty printing style key: normal raw"),
1139 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
1140 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
1141 OPT_BOOLEAN(0, "stdio", &report.use_stdio,
1142 "Use the stdio interface"),
1143 OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
1144 OPT_BOOLEAN(0, "header-only", &report.header_only,
1145 "Show only data header."),
1146 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1147 sort_help("sort by key(s):")),
1148 OPT_STRING('F', "fields", &field_order, "key[,keys...]",
1149 sort_help("output field(s): overhead period sample ")),
1150 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization,
1151 "Show sample percentage for different cpu modes"),
1152 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
1153 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN),
1154 OPT_STRING('p', "parent", &parent_pattern, "regex",
1155 "regex filter to identify parent, see: '--sort parent'"),
1156 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
1157 "Only display entries with parent-match"),
1158 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param,
1159 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
1160 report_callchain_help, &report_parse_callchain_opt,
1161 callchain_default_opt),
1162 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1163 "Accumulate callchains of children and show total overhead as well"),
1164 OPT_INTEGER(0, "max-stack", &report.max_stack,
1165 "Set the maximum stack depth when parsing the callchain, "
1166 "anything beyond the specified depth will be ignored. "
1167 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
1168 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
1169 "alias for inverted call graph"),
1170 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1171 "ignore callees of these functions in call graphs",
1172 report_parse_ignore_callees_opt),
1173 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1174 "only consider symbols in these dsos"),
1175 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1176 "only consider symbols in these comms"),
1177 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
1178 "only consider symbols in these pids"),
1179 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
1180 "only consider symbols in these tids"),
1181 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1182 "only consider these symbols"),
1183 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
1184 "only show symbols that (partially) match with this filter"),
1185 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
1187 "don't try to adjust column width, use these fixed values"),
1188 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
1189 "separator for columns, no spaces will be added between "
1190 "columns '.' is reserved."),
1191 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved,
1192 "Only display entries resolved to a symbol"),
1193 OPT_CALLBACK(0, "symfs", NULL, "directory",
1194 "Look for files with symbols relative to this directory",
1195 symbol__config_symfs),
1196 OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
1197 "list of cpus to profile"),
1198 OPT_BOOLEAN('I', "show-info", &report.show_full_info,
1199 "Display extended information about perf.data file"),
1200 OPT_BOOLEAN(0, "source", &report.annotation_opts.annotate_src,
1201 "Interleave source code with assembly code (default)"),
1202 OPT_BOOLEAN(0, "asm-raw", &report.annotation_opts.show_asm_raw,
1203 "Display raw encoding of assembly instructions (default)"),
1204 OPT_STRING('M', "disassembler-style", &report.annotation_opts.disassembler_style, "disassembler style",
1205 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1206 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1207 "Show a column with the sum of periods"),
1208 OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, &report.group_set,
1209 "Show event group information together"),
1210 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
1211 "use branch records for per branch histogram filling",
1213 OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
1214 "add last branch records to call history"),
1215 OPT_STRING(0, "objdump", &report.annotation_opts.objdump_path, "path",
1216 "objdump binary to use for disassembly and annotations"),
1217 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
1218 "Disable symbol demangling"),
1219 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
1220 "Enable kernel symbol demangling"),
1221 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
1222 OPT_INTEGER(0, "samples", &symbol_conf.res_sample,
1223 "Number of samples to save per histogram entry for individual browsing"),
1224 OPT_CALLBACK(0, "percent-limit", &report, "percent",
1225 "Don't show entries under that percent", parse_percent_limit),
1226 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1227 "how to display percentage of filtered entries", parse_filter_percentage),
1228 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
1229 "Instruction Tracing options\n" ITRACE_HELP,
1230 itrace_parse_synth_opts),
1231 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
1232 "Show full source file name path for source lines"),
1233 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
1234 "Show callgraph from reference event"),
1235 OPT_INTEGER(0, "socket-filter", &report.socket_filter,
1236 "only show processor socket that match with this filter"),
1237 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
1238 "Show raw trace event output (do not use print fmt or plugins)"),
1239 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
1240 "Show entries in a hierarchy"),
1241 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
1242 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
1243 stdio__config_color, "always"),
1244 OPT_STRING(0, "time", &report.time_str, "str",
1245 "Time span of interest (start,stop)"),
1246 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
1247 "Show inline function"),
1248 OPT_CALLBACK(0, "percent-type", &report.annotation_opts, "local-period",
1249 "Set percent type local/global-period/hits",
1250 annotate_parse_percent_type),
1251 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs, "Show times in nanosecs"),
1252 OPT_CALLBACK(0, "time-quantum", &symbol_conf.time_quantum, "time (ms|us|ns|s)",
1253 "Set time quantum for time sort key (default 100ms)",
1254 parse_time_quantum),
1255 OPTS_EVSWITCH(&report.evswitch),
1256 OPT_BOOLEAN(0, "total-cycles", &report.total_cycles_mode,
1257 "Sort all blocks by 'Sampled Cycles%'"),
1260 struct perf_data data = {
1261 .mode = PERF_DATA_MODE_READ,
1263 int ret = hists__init();
1269 ret = perf_config(report__config, &report);
1273 argc = parse_options(argc, argv, options, report_usage, 0);
1276 * Special case: if there's an argument left then assume that
1277 * it's a symbol filter:
1280 usage_with_options(report_usage, options);
1282 report.symbol_filter_str = argv[0];
1285 if (report.mmaps_mode)
1286 report.tasks_mode = true;
1289 perf_quiet_option();
1291 if (symbol_conf.vmlinux_name &&
1292 access(symbol_conf.vmlinux_name, R_OK)) {
1293 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
1296 if (symbol_conf.kallsyms_name &&
1297 access(symbol_conf.kallsyms_name, R_OK)) {
1298 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);
1302 if (report.inverted_callchain)
1303 callchain_param.order = ORDER_CALLER;
1304 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
1305 callchain_param.order = ORDER_CALLER;
1307 if (itrace_synth_opts.callchain &&
1308 (int)itrace_synth_opts.callchain_sz > report.max_stack)
1309 report.max_stack = itrace_synth_opts.callchain_sz;
1311 if (!input_name || !strlen(input_name)) {
1312 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
1315 input_name = "perf.data";
1318 data.path = input_name;
1319 data.force = symbol_conf.force;
1322 session = perf_session__new(&data, false, &report.tool);
1323 if (IS_ERR(session))
1324 return PTR_ERR(session);
1326 ret = evswitch__init(&report.evswitch, session->evlist, stderr);
1330 if (zstd_init(&(session->zstd_data), 0) < 0)
1331 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
1333 if (report.queue_size) {
1334 ordered_events__set_alloc_size(&session->ordered_events,
1338 session->itrace_synth_opts = &itrace_synth_opts;
1340 report.session = session;
1342 has_br_stack = perf_header__has_feat(&session->header,
1343 HEADER_BRANCH_STACK);
1344 if (perf_evlist__combined_sample_type(session->evlist) & PERF_SAMPLE_STACK_USER)
1345 has_br_stack = false;
1347 setup_forced_leader(&report, session->evlist);
1349 if (itrace_synth_opts.last_branch)
1350 has_br_stack = true;
1352 if (has_br_stack && branch_call_mode)
1353 symbol_conf.show_branchflag_count = true;
1355 memset(&report.brtype_stat, 0, sizeof(struct branch_type_stat));
1358 * Branch mode is a tristate:
1359 * -1 means default, so decide based on the file having branch data.
1360 * 0/1 means the user chose a mode.
1362 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
1363 !branch_call_mode) {
1364 sort__mode = SORT_MODE__BRANCH;
1365 symbol_conf.cumulate_callchain = false;
1367 if (branch_call_mode) {
1368 callchain_param.key = CCKEY_ADDRESS;
1369 callchain_param.branch_callstack = 1;
1370 symbol_conf.use_callchain = true;
1371 callchain_register_param(&callchain_param);
1372 if (sort_order == NULL)
1373 sort_order = "srcline,symbol,dso";
1376 if (report.mem_mode) {
1377 if (sort__mode == SORT_MODE__BRANCH) {
1378 pr_err("branch and mem mode incompatible\n");
1381 sort__mode = SORT_MODE__MEMORY;
1382 symbol_conf.cumulate_callchain = false;
1385 if (symbol_conf.report_hierarchy) {
1386 /* disable incompatible options */
1387 symbol_conf.cumulate_callchain = false;
1390 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1391 parse_options_usage(report_usage, options, "F", 1);
1392 parse_options_usage(NULL, options, "hierarchy", 0);
1396 perf_hpp_list.need_collapse = true;
1399 if (report.use_stdio)
1401 else if (report.use_tui)
1403 else if (report.use_gtk)
1406 /* Force tty output for header output and per-thread stat. */
1407 if (report.header || report.header_only || report.show_threads)
1409 if (report.header || report.header_only)
1410 report.tool.show_feat_hdr = SHOW_FEAT_HEADER;
1411 if (report.show_full_info)
1412 report.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
1413 if (report.stats_mode || report.tasks_mode)
1415 if (report.stats_mode && report.tasks_mode) {
1416 pr_err("Error: --tasks and --mmaps can't be used together with --stats\n");
1420 if (report.total_cycles_mode) {
1421 if (sort__mode != SORT_MODE__BRANCH)
1422 report.total_cycles_mode = false;
1427 if (strcmp(input_name, "-") != 0)
1428 setup_browser(true);
1432 if (sort_order && strstr(sort_order, "ipc")) {
1433 parse_options_usage(report_usage, options, "s", 1);
1437 if (sort_order && strstr(sort_order, "symbol")) {
1438 if (sort__mode == SORT_MODE__BRANCH) {
1439 snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s",
1440 sort_order, "ipc_lbr");
1441 report.symbol_ipc = true;
1443 snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s",
1444 sort_order, "ipc_null");
1447 sort_order = sort_tmp;
1450 if (setup_sorting(session->evlist) < 0) {
1452 parse_options_usage(report_usage, options, "s", 1);
1454 parse_options_usage(sort_order ? NULL : report_usage,
1459 if ((report.header || report.header_only) && !quiet) {
1460 perf_session__fprintf_info(session, stdout,
1461 report.show_full_info);
1462 if (report.header_only) {
1466 } else if (use_browser == 0 && !quiet &&
1467 !report.stats_mode && !report.tasks_mode) {
1468 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1473 * Only in the TUI browser we are doing integrated annotation,
1474 * so don't allocate extra space that won't be used in the stdio
1477 if (ui__has_annotation() || report.symbol_ipc ||
1478 report.total_cycles_mode) {
1479 ret = symbol__annotation_init();
1483 * For searching by name on the "Browse map details".
1484 * providing it only in verbose mode not to bloat too
1485 * much struct symbol.
1489 * XXX: Need to provide a less kludgy way to ask for
1490 * more space per symbol, the u32 is for the index on
1492 * See symbol__browser_index.
1494 symbol_conf.priv_size += sizeof(u32);
1495 symbol_conf.sort_by_name = true;
1497 annotation_config__init();
1500 if (symbol__init(&session->header.env) < 0)
1503 if (report.time_str) {
1504 ret = perf_time__parse_for_ranges(report.time_str, session,
1505 &report.ptime_range,
1511 itrace_synth_opts__set_time_range(&itrace_synth_opts,
1516 if (session->tevent.pevent &&
1517 tep_set_function_resolver(session->tevent.pevent,
1518 machine__resolve_kernel_addr,
1519 &session->machines.host) < 0) {
1520 pr_err("%s: failed to set libtraceevent function resolver\n",
1525 sort__setup_elide(stdout);
1527 ret = __cmd_report(&report);
1528 if (ret == K_SWITCH_INPUT_DATA) {
1529 perf_session__delete(session);
1535 if (report.ptime_range) {
1536 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
1537 zfree(&report.ptime_range);
1540 if (report.block_reports)
1541 zfree(&report.block_reports);
1543 zstd_fini(&(session->zstd_data));
1544 perf_session__delete(session);