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 <linux/err.h>
19 #include "util/symbol.h"
20 #include "util/callchain.h"
21 #include "util/values.h"
24 #include "util/debug.h"
25 #include "util/evlist.h"
26 #include "util/evsel.h"
27 #include "util/header.h"
28 #include "util/session.h"
29 #include "util/tool.h"
31 #include <subcmd/parse-options.h>
32 #include <subcmd/exec-cmd.h>
33 #include "util/parse-events.h"
35 #include "util/thread.h"
36 #include "util/sort.h"
37 #include "util/hist.h"
38 #include "util/data.h"
39 #include "arch/common.h"
40 #include "util/time-utils.h"
41 #include "util/auxtrace.h"
42 #include "util/units.h"
43 #include "util/branch.h"
50 #include <linux/bitmap.h>
51 #include <linux/stringify.h>
52 #include <sys/types.h>
55 #include <linux/mman.h>
58 struct perf_tool tool;
59 struct perf_session *session;
60 bool use_tui, use_gtk, use_stdio;
63 bool inverted_callchain;
70 bool nonany_branch_mode;
72 struct perf_read_values show_threads_values;
73 const char *pretty_printing_style;
75 const char *symbol_filter_str;
77 struct perf_time_interval *ptime_range;
84 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
85 struct branch_type_stat brtype_stat;
88 static int report__config(const char *var, const char *value, void *cb)
90 struct report *rep = cb;
92 if (!strcmp(var, "report.group")) {
93 symbol_conf.event_group = perf_config_bool(var, value);
96 if (!strcmp(var, "report.percent-limit")) {
97 double pcnt = strtof(value, NULL);
99 rep->min_percent = pcnt;
100 callchain_param.min_percent = pcnt;
103 if (!strcmp(var, "report.children")) {
104 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
107 if (!strcmp(var, "report.queue-size"))
108 return perf_config_u64(&rep->queue_size, var, value);
110 if (!strcmp(var, "report.sort_order")) {
111 default_sort_order = strdup(value);
118 static int hist_iter__report_callback(struct hist_entry_iter *iter,
119 struct addr_location *al, bool single,
123 struct report *rep = arg;
124 struct hist_entry *he = iter->he;
125 struct perf_evsel *evsel = iter->evsel;
126 struct perf_sample *sample = iter->sample;
128 struct branch_info *bi;
130 if (!ui__has_annotation())
133 hist__account_cycles(sample->branch_stack, al, sample,
134 rep->nonany_branch_mode);
136 if (sort__mode == SORT_MODE__BRANCH) {
137 bi = he->branch_info;
138 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel->idx);
142 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel->idx);
144 } else if (rep->mem_mode) {
146 err = addr_map_symbol__inc_samples(&mi->daddr, sample, evsel->idx);
150 err = hist_entry__inc_addr_samples(he, sample, evsel->idx, al->addr);
152 } else if (symbol_conf.cumulate_callchain) {
154 err = hist_entry__inc_addr_samples(he, sample, evsel->idx,
157 err = hist_entry__inc_addr_samples(he, sample, evsel->idx, al->addr);
164 static int hist_iter__branch_callback(struct hist_entry_iter *iter,
165 struct addr_location *al __maybe_unused,
166 bool single __maybe_unused,
169 struct hist_entry *he = iter->he;
170 struct report *rep = arg;
171 struct branch_info *bi;
172 struct perf_sample *sample = iter->sample;
173 struct perf_evsel *evsel = iter->evsel;
176 if (!ui__has_annotation())
179 hist__account_cycles(sample->branch_stack, al, sample,
180 rep->nonany_branch_mode);
182 bi = he->branch_info;
183 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel->idx);
187 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel->idx);
189 branch_type_count(&rep->brtype_stat, &bi->flags,
190 bi->from.addr, bi->to.addr);
196 static int process_sample_event(struct perf_tool *tool,
197 union perf_event *event,
198 struct perf_sample *sample,
199 struct perf_evsel *evsel,
200 struct machine *machine)
202 struct report *rep = container_of(tool, struct report, tool);
203 struct addr_location al;
204 struct hist_entry_iter iter = {
207 .hide_unresolved = symbol_conf.hide_unresolved,
208 .add_entry_cb = hist_iter__report_callback,
212 if (perf_time__ranges_skip_sample(rep->ptime_range, rep->range_num,
217 if (machine__resolve(machine, &al, sample) < 0) {
218 pr_debug("problem processing %d event, skipping it.\n",
223 if (symbol_conf.hide_unresolved && al.sym == NULL)
226 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
229 if (sort__mode == SORT_MODE__BRANCH) {
231 * A non-synthesized event might not have a branch stack if
232 * branch stacks have been synthesized (using itrace options).
234 if (!sample->branch_stack)
237 iter.add_entry_cb = hist_iter__branch_callback;
238 iter.ops = &hist_iter_branch;
239 } else if (rep->mem_mode) {
240 iter.ops = &hist_iter_mem;
241 } else if (symbol_conf.cumulate_callchain) {
242 iter.ops = &hist_iter_cumulative;
244 iter.ops = &hist_iter_normal;
248 al.map->dso->hit = 1;
250 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
252 pr_debug("problem adding hist entry, skipping event\n");
254 addr_location__put(&al);
258 static int process_read_event(struct perf_tool *tool,
259 union perf_event *event,
260 struct perf_sample *sample __maybe_unused,
261 struct perf_evsel *evsel,
262 struct machine *machine __maybe_unused)
264 struct report *rep = container_of(tool, struct report, tool);
266 if (rep->show_threads) {
267 const char *name = evsel ? perf_evsel__name(evsel) : "unknown";
268 int err = perf_read_values_add_value(&rep->show_threads_values,
269 event->read.pid, event->read.tid,
281 /* For pipe mode, sample_type is not currently set */
282 static int report__setup_sample_type(struct report *rep)
284 struct perf_session *session = rep->session;
285 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
286 bool is_pipe = perf_data__is_pipe(session->data);
288 if (session->itrace_synth_opts->callchain ||
290 perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
291 !session->itrace_synth_opts->set))
292 sample_type |= PERF_SAMPLE_CALLCHAIN;
294 if (session->itrace_synth_opts->last_branch)
295 sample_type |= PERF_SAMPLE_BRANCH_STACK;
297 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
298 if (perf_hpp_list.parent) {
299 ui__error("Selected --sort parent, but no "
300 "callchain data. Did you call "
301 "'perf record' without -g?\n");
304 if (symbol_conf.use_callchain &&
305 !symbol_conf.show_branchflag_count) {
306 ui__error("Selected -g or --branch-history.\n"
307 "But no callchain or branch data.\n"
308 "Did you call 'perf record' without -g or -b?\n");
311 } else if (!callchain_param.enabled &&
312 callchain_param.mode != CHAIN_NONE &&
313 !symbol_conf.use_callchain) {
314 symbol_conf.use_callchain = true;
315 if (callchain_register_param(&callchain_param) < 0) {
316 ui__error("Can't register callchain params.\n");
321 if (symbol_conf.cumulate_callchain) {
322 /* Silently ignore if callchain is missing */
323 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
324 symbol_conf.cumulate_callchain = false;
325 perf_hpp__cancel_cumulate();
329 if (sort__mode == SORT_MODE__BRANCH) {
331 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
332 ui__error("Selected -b but no branch data. "
333 "Did you call perf record without -b?\n");
338 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
339 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
340 (sample_type & PERF_SAMPLE_STACK_USER)) {
341 callchain_param.record_mode = CALLCHAIN_DWARF;
342 dwarf_callchain_users = true;
343 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
344 callchain_param.record_mode = CALLCHAIN_LBR;
346 callchain_param.record_mode = CALLCHAIN_FP;
349 /* ??? handle more cases than just ANY? */
350 if (!(perf_evlist__combined_branch_type(session->evlist) &
351 PERF_SAMPLE_BRANCH_ANY))
352 rep->nonany_branch_mode = true;
357 static void sig_handler(int sig __maybe_unused)
362 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
363 const char *evname, FILE *fp)
367 unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
368 u64 nr_events = hists->stats.total_period;
369 struct perf_evsel *evsel = hists_to_evsel(hists);
371 size_t size = sizeof(buf);
372 int socked_id = hists->socket_filter;
377 if (symbol_conf.filter_relative) {
378 nr_samples = hists->stats.nr_non_filtered_samples;
379 nr_events = hists->stats.total_non_filtered_period;
382 if (perf_evsel__is_group_event(evsel)) {
383 struct perf_evsel *pos;
385 perf_evsel__group_desc(evsel, buf, size);
388 for_each_group_member(pos, evsel) {
389 const struct hists *pos_hists = evsel__hists(pos);
391 if (symbol_conf.filter_relative) {
392 nr_samples += pos_hists->stats.nr_non_filtered_samples;
393 nr_events += pos_hists->stats.total_non_filtered_period;
395 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE];
396 nr_events += pos_hists->stats.total_period;
401 nr_samples = convert_unit(nr_samples, &unit);
402 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
403 if (evname != NULL) {
404 ret += fprintf(fp, " of event%s '%s'",
405 evsel->nr_members > 1 ? "s" : "", evname);
409 ret += fprintf(fp, " (time slices: %s)", rep->time_str);
411 if (symbol_conf.show_ref_callgraph &&
412 strstr(evname, "call-graph=no")) {
413 ret += fprintf(fp, ", show reference callgraph");
417 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
418 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order);
420 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
423 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
425 return ret + fprintf(fp, "\n#\n");
428 static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
432 struct perf_evsel *pos;
435 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n",
436 evlist->stats.total_lost_samples);
439 evlist__for_each_entry(evlist, pos) {
440 struct hists *hists = evsel__hists(pos);
441 const char *evname = perf_evsel__name(pos);
443 if (symbol_conf.event_group &&
444 !perf_evsel__is_group_leader(pos))
447 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
448 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout,
449 symbol_conf.use_callchain ||
450 symbol_conf.show_branchflag_count);
451 fprintf(stdout, "\n\n");
455 fprintf(stdout, "#\n# (%s)\n#\n", help);
457 if (rep->show_threads) {
458 bool style = !strcmp(rep->pretty_printing_style, "raw");
459 perf_read_values_display(stdout, &rep->show_threads_values,
461 perf_read_values_destroy(&rep->show_threads_values);
464 if (sort__mode == SORT_MODE__BRANCH)
465 branch_type_stat_display(stdout, &rep->brtype_stat);
470 static void report__warn_kptr_restrict(const struct report *rep)
472 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host);
473 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
475 if (perf_evlist__exclude_kernel(rep->session->evlist))
478 if (kernel_map == NULL ||
479 (kernel_map->dso->hit &&
480 (kernel_kmap->ref_reloc_sym == NULL ||
481 kernel_kmap->ref_reloc_sym->addr == 0))) {
483 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
484 "can't be resolved.";
487 const struct dso *kdso = kernel_map->dso;
488 if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
489 desc = "If some relocation was applied (e.g. "
490 "kexec) symbols may be misresolved.";
495 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
496 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
497 "Samples in kernel modules can't be resolved as well.\n\n",
502 static int report__gtk_browse_hists(struct report *rep, const char *help)
504 int (*hist_browser)(struct perf_evlist *evlist, const char *help,
505 struct hist_browser_timer *timer, float min_pcnt);
507 hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
509 if (hist_browser == NULL) {
510 ui__error("GTK browser not found!\n");
514 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
517 static int report__browse_hists(struct report *rep)
520 struct perf_session *session = rep->session;
521 struct perf_evlist *evlist = session->evlist;
522 const char *help = perf_tip(system_path(TIPDIR));
525 /* fallback for people who don't install perf ;-) */
526 help = perf_tip(DOCDIR);
528 help = "Cannot load tips.txt file, please install perf!";
531 switch (use_browser) {
533 ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
535 &session->header.env,
538 * Usually "ret" is the last pressed key, and we only
539 * care if the key notifies us to switch data file.
541 if (ret != K_SWITCH_INPUT_DATA)
545 ret = report__gtk_browse_hists(rep, help);
548 ret = perf_evlist__tty_browse_hists(evlist, rep, help);
555 static int report__collapse_hists(struct report *rep)
557 struct ui_progress prog;
558 struct perf_evsel *pos;
561 ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
563 evlist__for_each_entry(rep->session->evlist, pos) {
564 struct hists *hists = evsel__hists(pos);
567 hists->symbol_filter_str = rep->symbol_filter_str;
569 hists->socket_filter = rep->socket_filter;
571 ret = hists__collapse_resort(hists, &prog);
575 /* Non-group events are considered as leader */
576 if (symbol_conf.event_group &&
577 !perf_evsel__is_group_leader(pos)) {
578 struct hists *leader_hists = evsel__hists(pos->leader);
580 hists__match(leader_hists, hists);
581 hists__link(leader_hists, hists);
585 ui_progress__finish();
589 static void report__output_resort(struct report *rep)
591 struct ui_progress prog;
592 struct perf_evsel *pos;
594 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
596 evlist__for_each_entry(rep->session->evlist, pos)
597 perf_evsel__output_resort(pos, &prog);
599 ui_progress__finish();
602 static void stats_setup(struct report *rep)
604 memset(&rep->tool, 0, sizeof(rep->tool));
605 rep->tool.no_warn = true;
608 static int stats_print(struct report *rep)
610 struct perf_session *session = rep->session;
612 perf_session__fprintf_nr_events(session, stdout);
616 static void tasks_setup(struct report *rep)
618 memset(&rep->tool, 0, sizeof(rep->tool));
619 rep->tool.ordered_events = true;
620 if (rep->mmaps_mode) {
621 rep->tool.mmap = perf_event__process_mmap;
622 rep->tool.mmap2 = perf_event__process_mmap2;
624 rep->tool.comm = perf_event__process_comm;
625 rep->tool.exit = perf_event__process_exit;
626 rep->tool.fork = perf_event__process_fork;
627 rep->tool.no_warn = true;
631 struct thread *thread;
632 struct list_head list;
633 struct list_head children;
636 static struct task *tasks_list(struct task *task, struct machine *machine)
638 struct thread *parent_thread, *thread = task->thread;
639 struct task *parent_task;
641 /* Already listed. */
642 if (!list_empty(&task->list))
645 /* Last one in the chain. */
646 if (thread->ppid == -1)
649 parent_thread = machine__find_thread(machine, -1, thread->ppid);
651 return ERR_PTR(-ENOENT);
653 parent_task = thread__priv(parent_thread);
654 list_add_tail(&task->list, &parent_task->children);
655 return tasks_list(parent_task, machine);
658 static size_t maps__fprintf_task(struct maps *maps, int indent, FILE *fp)
663 for (nd = rb_first(&maps->entries); nd; nd = rb_next(nd)) {
664 struct map *map = rb_entry(nd, struct map, rb_node);
666 printed += fprintf(fp, "%*s %" PRIx64 "-%" PRIx64 " %c%c%c%c %08" PRIx64 " %" PRIu64 " %s\n",
667 indent, "", map->start, map->end,
668 map->prot & PROT_READ ? 'r' : '-',
669 map->prot & PROT_WRITE ? 'w' : '-',
670 map->prot & PROT_EXEC ? 'x' : '-',
671 map->flags & MAP_SHARED ? 's' : 'p',
673 map->ino, map->dso->name);
679 static int map_groups__fprintf_task(struct map_groups *mg, int indent, FILE *fp)
682 for (i = 0; i < MAP__NR_TYPES; ++i)
683 printed += maps__fprintf_task(&mg->maps[i], indent, fp);
687 static void task__print_level(struct task *task, FILE *fp, int level)
689 struct thread *thread = task->thread;
691 int comm_indent = fprintf(fp, " %8d %8d %8d |%*s",
692 thread->pid_, thread->tid, thread->ppid,
695 fprintf(fp, "%s\n", thread__comm_str(thread));
697 map_groups__fprintf_task(thread->mg, comm_indent, fp);
699 if (!list_empty(&task->children)) {
700 list_for_each_entry(child, &task->children, list)
701 task__print_level(child, fp, level + 1);
705 static int tasks_print(struct report *rep, FILE *fp)
707 struct perf_session *session = rep->session;
708 struct machine *machine = &session->machines.host;
709 struct task *tasks, *task;
710 unsigned int nr = 0, itask = 0, i;
715 * No locking needed while accessing machine->threads,
716 * because --tasks is single threaded command.
719 /* Count all the threads. */
720 for (i = 0; i < THREADS__TABLE_SIZE; i++)
721 nr += machine->threads[i].nr;
723 tasks = malloc(sizeof(*tasks) * nr);
727 for (i = 0; i < THREADS__TABLE_SIZE; i++) {
728 struct threads *threads = &machine->threads[i];
730 for (nd = rb_first(&threads->entries); nd; nd = rb_next(nd)) {
731 task = tasks + itask++;
733 task->thread = rb_entry(nd, struct thread, rb_node);
734 INIT_LIST_HEAD(&task->children);
735 INIT_LIST_HEAD(&task->list);
736 thread__set_priv(task->thread, task);
741 * Iterate every task down to the unprocessed parent
742 * and link all in task children list. Task with no
743 * parent is added into 'list'.
745 for (itask = 0; itask < nr; itask++) {
746 task = tasks + itask;
748 if (!list_empty(&task->list))
751 task = tasks_list(task, machine);
753 pr_err("Error: failed to process tasks\n");
755 return PTR_ERR(task);
759 list_add_tail(&task->list, &list);
762 fprintf(fp, "# %8s %8s %8s %s\n", "pid", "tid", "ppid", "comm");
764 list_for_each_entry(task, &list, list)
765 task__print_level(task, fp, 0);
771 static int __cmd_report(struct report *rep)
774 struct perf_session *session = rep->session;
775 struct perf_evsel *pos;
776 struct perf_data *data = session->data;
778 signal(SIGINT, sig_handler);
781 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
784 ui__error("failed to set cpu bitmap\n");
787 session->itrace_synth_opts->cpu_bitmap = rep->cpu_bitmap;
790 if (rep->show_threads) {
791 ret = perf_read_values_init(&rep->show_threads_values);
796 ret = report__setup_sample_type(rep);
798 /* report__setup_sample_type() already showed error message */
808 ret = perf_session__process_events(session);
810 ui__error("failed to process sample\n");
815 return stats_print(rep);
818 return tasks_print(rep, stdout);
820 report__warn_kptr_restrict(rep);
822 evlist__for_each_entry(session->evlist, pos)
823 rep->nr_entries += evsel__hists(pos)->nr_entries;
825 if (use_browser == 0) {
827 perf_session__fprintf(session, stdout);
830 perf_session__fprintf_dsos(session, stdout);
833 perf_session__fprintf_nr_events(session, stdout);
834 perf_evlist__fprintf_nr_events(session->evlist, stdout);
839 ret = report__collapse_hists(rep);
841 ui__error("failed to process hist entry\n");
849 * recalculate number of entries after collapsing since it
850 * might be changed during the collapse phase.
853 evlist__for_each_entry(session->evlist, pos)
854 rep->nr_entries += evsel__hists(pos)->nr_entries;
856 if (rep->nr_entries == 0) {
857 ui__error("The %s file has no samples!\n", data->file.path);
861 report__output_resort(rep);
863 return report__browse_hists(rep);
867 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
869 struct callchain_param *callchain = opt->value;
871 callchain->enabled = !unset;
876 symbol_conf.use_callchain = false;
877 callchain->mode = CHAIN_NONE;
881 return parse_callchain_report_opt(arg);
885 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
886 const char *arg, int unset __maybe_unused)
889 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
892 regerror(err, &ignore_callees_regex, buf, sizeof(buf));
893 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
896 have_ignore_callees = 1;
903 parse_branch_mode(const struct option *opt,
904 const char *str __maybe_unused, int unset)
906 int *branch_mode = opt->value;
908 *branch_mode = !unset;
913 parse_percent_limit(const struct option *opt, const char *str,
914 int unset __maybe_unused)
916 struct report *rep = opt->value;
917 double pcnt = strtof(str, NULL);
919 rep->min_percent = pcnt;
920 callchain_param.min_percent = pcnt;
924 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
926 const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n"
927 CALLCHAIN_REPORT_HELP
928 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT;
930 int cmd_report(int argc, const char **argv)
932 struct perf_session *session;
933 struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
935 bool has_br_stack = false;
936 int branch_mode = -1;
937 bool branch_call_mode = false;
938 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT;
939 const char * const report_usage[] = {
940 "perf report [<options>]",
943 bool group_set = false;
944 struct report report = {
946 .sample = process_sample_event,
947 .mmap = perf_event__process_mmap,
948 .mmap2 = perf_event__process_mmap2,
949 .comm = perf_event__process_comm,
950 .namespaces = perf_event__process_namespaces,
951 .exit = perf_event__process_exit,
952 .fork = perf_event__process_fork,
953 .lost = perf_event__process_lost,
954 .read = process_read_event,
955 .attr = perf_event__process_attr,
956 .tracing_data = perf_event__process_tracing_data,
957 .build_id = perf_event__process_build_id,
958 .id_index = perf_event__process_id_index,
959 .auxtrace_info = perf_event__process_auxtrace_info,
960 .auxtrace = perf_event__process_auxtrace,
961 .feature = perf_event__process_feature,
962 .ordered_events = true,
963 .ordering_requires_timestamps = true,
965 .max_stack = PERF_MAX_STACK_DEPTH,
966 .pretty_printing_style = "normal",
969 const struct option options[] = {
970 OPT_STRING('i', "input", &input_name, "file",
972 OPT_INCR('v', "verbose", &verbose,
973 "be more verbose (show symbol address, etc)"),
974 OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any message"),
975 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
976 "dump raw trace in ASCII"),
977 OPT_BOOLEAN(0, "stats", &report.stats_mode, "Display event stats"),
978 OPT_BOOLEAN(0, "tasks", &report.tasks_mode, "Display recorded tasks"),
979 OPT_BOOLEAN(0, "mmaps", &report.mmaps_mode, "Display recorded tasks memory maps"),
980 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
981 "file", "vmlinux pathname"),
982 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
983 "file", "kallsyms pathname"),
984 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
985 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
986 "load module symbols - WARNING: use only with -k and LIVE kernel"),
987 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
988 "Show a column with the number of samples"),
989 OPT_BOOLEAN('T', "threads", &report.show_threads,
990 "Show per-thread event counters"),
991 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
992 "pretty printing style key: normal raw"),
993 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
994 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
995 OPT_BOOLEAN(0, "stdio", &report.use_stdio,
996 "Use the stdio interface"),
997 OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
998 OPT_BOOLEAN(0, "header-only", &report.header_only,
999 "Show only data header."),
1000 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1001 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1002 " Please refer the man page for the complete list."),
1003 OPT_STRING('F', "fields", &field_order, "key[,keys...]",
1004 "output field(s): overhead, period, sample plus all of sort keys"),
1005 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization,
1006 "Show sample percentage for different cpu modes"),
1007 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
1008 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN),
1009 OPT_STRING('p', "parent", &parent_pattern, "regex",
1010 "regex filter to identify parent, see: '--sort parent'"),
1011 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
1012 "Only display entries with parent-match"),
1013 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param,
1014 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
1015 report_callchain_help, &report_parse_callchain_opt,
1016 callchain_default_opt),
1017 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1018 "Accumulate callchains of children and show total overhead as well"),
1019 OPT_INTEGER(0, "max-stack", &report.max_stack,
1020 "Set the maximum stack depth when parsing the callchain, "
1021 "anything beyond the specified depth will be ignored. "
1022 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
1023 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
1024 "alias for inverted call graph"),
1025 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1026 "ignore callees of these functions in call graphs",
1027 report_parse_ignore_callees_opt),
1028 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1029 "only consider symbols in these dsos"),
1030 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1031 "only consider symbols in these comms"),
1032 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
1033 "only consider symbols in these pids"),
1034 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
1035 "only consider symbols in these tids"),
1036 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1037 "only consider these symbols"),
1038 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
1039 "only show symbols that (partially) match with this filter"),
1040 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
1042 "don't try to adjust column width, use these fixed values"),
1043 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
1044 "separator for columns, no spaces will be added between "
1045 "columns '.' is reserved."),
1046 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved,
1047 "Only display entries resolved to a symbol"),
1048 OPT_CALLBACK(0, "symfs", NULL, "directory",
1049 "Look for files with symbols relative to this directory",
1050 symbol__config_symfs),
1051 OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
1052 "list of cpus to profile"),
1053 OPT_BOOLEAN('I', "show-info", &report.show_full_info,
1054 "Display extended information about perf.data file"),
1055 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
1056 "Interleave source code with assembly code (default)"),
1057 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
1058 "Display raw encoding of assembly instructions (default)"),
1059 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1060 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1061 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1062 "Show a column with the sum of periods"),
1063 OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, &group_set,
1064 "Show event group information together"),
1065 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
1066 "use branch records for per branch histogram filling",
1068 OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
1069 "add last branch records to call history"),
1070 OPT_STRING(0, "objdump", &objdump_path, "path",
1071 "objdump binary to use for disassembly and annotations"),
1072 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
1073 "Disable symbol demangling"),
1074 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
1075 "Enable kernel symbol demangling"),
1076 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
1077 OPT_CALLBACK(0, "percent-limit", &report, "percent",
1078 "Don't show entries under that percent", parse_percent_limit),
1079 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1080 "how to display percentage of filtered entries", parse_filter_percentage),
1081 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
1082 "Instruction Tracing options",
1083 itrace_parse_synth_opts),
1084 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
1085 "Show full source file name path for source lines"),
1086 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
1087 "Show callgraph from reference event"),
1088 OPT_INTEGER(0, "socket-filter", &report.socket_filter,
1089 "only show processor socket that match with this filter"),
1090 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
1091 "Show raw trace event output (do not use print fmt or plugins)"),
1092 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
1093 "Show entries in a hierarchy"),
1094 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
1095 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
1096 stdio__config_color, "always"),
1097 OPT_STRING(0, "time", &report.time_str, "str",
1098 "Time span of interest (start,stop)"),
1099 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
1100 "Show inline function"),
1103 struct perf_data data = {
1104 .mode = PERF_DATA_MODE_READ,
1106 int ret = hists__init();
1111 ret = perf_config(report__config, &report);
1115 argc = parse_options(argc, argv, options, report_usage, 0);
1118 * Special case: if there's an argument left then assume that
1119 * it's a symbol filter:
1122 usage_with_options(report_usage, options);
1124 report.symbol_filter_str = argv[0];
1127 if (report.mmaps_mode)
1128 report.tasks_mode = true;
1131 perf_quiet_option();
1133 if (symbol_conf.vmlinux_name &&
1134 access(symbol_conf.vmlinux_name, R_OK)) {
1135 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
1138 if (symbol_conf.kallsyms_name &&
1139 access(symbol_conf.kallsyms_name, R_OK)) {
1140 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);
1144 if (report.inverted_callchain)
1145 callchain_param.order = ORDER_CALLER;
1146 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
1147 callchain_param.order = ORDER_CALLER;
1149 if (itrace_synth_opts.callchain &&
1150 (int)itrace_synth_opts.callchain_sz > report.max_stack)
1151 report.max_stack = itrace_synth_opts.callchain_sz;
1153 if (!input_name || !strlen(input_name)) {
1154 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
1157 input_name = "perf.data";
1160 data.file.path = input_name;
1161 data.force = symbol_conf.force;
1164 session = perf_session__new(&data, false, &report.tool);
1165 if (session == NULL)
1168 if (report.queue_size) {
1169 ordered_events__set_alloc_size(&session->ordered_events,
1173 session->itrace_synth_opts = &itrace_synth_opts;
1175 report.session = session;
1177 has_br_stack = perf_header__has_feat(&session->header,
1178 HEADER_BRANCH_STACK);
1181 * Events in data file are not collect in groups, but we still want
1182 * the group display. Set the artificial group and set the leader's
1183 * forced_leader flag to notify the display code.
1185 if (group_set && !session->evlist->nr_groups) {
1186 struct perf_evsel *leader = perf_evlist__first(session->evlist);
1188 perf_evlist__set_leader(session->evlist);
1189 leader->forced_leader = true;
1192 if (itrace_synth_opts.last_branch)
1193 has_br_stack = true;
1195 if (has_br_stack && branch_call_mode)
1196 symbol_conf.show_branchflag_count = true;
1198 memset(&report.brtype_stat, 0, sizeof(struct branch_type_stat));
1201 * Branch mode is a tristate:
1202 * -1 means default, so decide based on the file having branch data.
1203 * 0/1 means the user chose a mode.
1205 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
1206 !branch_call_mode) {
1207 sort__mode = SORT_MODE__BRANCH;
1208 symbol_conf.cumulate_callchain = false;
1210 if (branch_call_mode) {
1211 callchain_param.key = CCKEY_ADDRESS;
1212 callchain_param.branch_callstack = 1;
1213 symbol_conf.use_callchain = true;
1214 callchain_register_param(&callchain_param);
1215 if (sort_order == NULL)
1216 sort_order = "srcline,symbol,dso";
1219 if (report.mem_mode) {
1220 if (sort__mode == SORT_MODE__BRANCH) {
1221 pr_err("branch and mem mode incompatible\n");
1224 sort__mode = SORT_MODE__MEMORY;
1225 symbol_conf.cumulate_callchain = false;
1228 if (symbol_conf.report_hierarchy) {
1229 /* disable incompatible options */
1230 symbol_conf.cumulate_callchain = false;
1233 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1234 parse_options_usage(report_usage, options, "F", 1);
1235 parse_options_usage(NULL, options, "hierarchy", 0);
1239 perf_hpp_list.need_collapse = true;
1242 if (report.use_stdio)
1244 else if (report.use_tui)
1246 else if (report.use_gtk)
1249 /* Force tty output for header output and per-thread stat. */
1250 if (report.header || report.header_only || report.show_threads)
1252 if (report.header || report.header_only)
1253 report.tool.show_feat_hdr = SHOW_FEAT_HEADER;
1254 if (report.show_full_info)
1255 report.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
1256 if (report.stats_mode || report.tasks_mode)
1258 if (report.stats_mode && report.tasks_mode) {
1259 pr_err("Error: --tasks and --mmaps can't be used together with --stats\n");
1263 if (strcmp(input_name, "-") != 0)
1264 setup_browser(true);
1268 if (setup_sorting(session->evlist) < 0) {
1270 parse_options_usage(report_usage, options, "s", 1);
1272 parse_options_usage(sort_order ? NULL : report_usage,
1277 if ((report.header || report.header_only) && !quiet) {
1278 perf_session__fprintf_info(session, stdout,
1279 report.show_full_info);
1280 if (report.header_only) {
1284 } else if (use_browser == 0 && !quiet &&
1285 !report.stats_mode && !report.tasks_mode) {
1286 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1291 * Only in the TUI browser we are doing integrated annotation,
1292 * so don't allocate extra space that won't be used in the stdio
1295 if (ui__has_annotation()) {
1296 ret = symbol__annotation_init();
1300 * For searching by name on the "Browse map details".
1301 * providing it only in verbose mode not to bloat too
1302 * much struct symbol.
1306 * XXX: Need to provide a less kludgy way to ask for
1307 * more space per symbol, the u32 is for the index on
1309 * See symbol__browser_index.
1311 symbol_conf.priv_size += sizeof(u32);
1312 symbol_conf.sort_by_name = true;
1316 if (symbol__init(&session->header.env) < 0)
1319 report.ptime_range = perf_time__range_alloc(report.time_str,
1320 &report.range_size);
1321 if (!report.ptime_range) {
1326 if (perf_time__parse_str(report.ptime_range, report.time_str) != 0) {
1327 if (session->evlist->first_sample_time == 0 &&
1328 session->evlist->last_sample_time == 0) {
1329 pr_err("HINT: no first/last sample time found in perf data.\n"
1330 "Please use latest perf binary to execute 'perf record'\n"
1331 "(if '--buildid-all' is enabled, please set '--timestamp-boundary').\n");
1336 report.range_num = perf_time__percent_parse_str(
1337 report.ptime_range, report.range_size,
1339 session->evlist->first_sample_time,
1340 session->evlist->last_sample_time);
1342 if (report.range_num < 0) {
1343 pr_err("Invalid time string\n");
1348 report.range_num = 1;
1351 if (session->tevent.pevent &&
1352 pevent_set_function_resolver(session->tevent.pevent,
1353 machine__resolve_kernel_addr,
1354 &session->machines.host) < 0) {
1355 pr_err("%s: failed to set libtraceevent function resolver\n",
1360 sort__setup_elide(stdout);
1362 ret = __cmd_report(&report);
1363 if (ret == K_SWITCH_INPUT_DATA) {
1364 perf_session__delete(session);
1370 zfree(&report.ptime_range);
1372 perf_session__delete(session);