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
;
73 struct perf_read_values show_threads_values
;
74 struct annotation_options annotation_opts
;
75 const char *pretty_printing_style
;
77 const char *symbol_filter_str
;
79 struct perf_time_interval
*ptime_range
;
86 DECLARE_BITMAP(cpu_bitmap
, MAX_NR_CPUS
);
87 struct branch_type_stat brtype_stat
;
90 static int report__config(const char *var
, const char *value
, void *cb
)
92 struct report
*rep
= cb
;
94 if (!strcmp(var
, "report.group")) {
95 symbol_conf
.event_group
= perf_config_bool(var
, value
);
98 if (!strcmp(var
, "report.percent-limit")) {
99 double pcnt
= strtof(value
, NULL
);
101 rep
->min_percent
= pcnt
;
102 callchain_param
.min_percent
= pcnt
;
105 if (!strcmp(var
, "report.children")) {
106 symbol_conf
.cumulate_callchain
= perf_config_bool(var
, value
);
109 if (!strcmp(var
, "report.queue-size"))
110 return perf_config_u64(&rep
->queue_size
, var
, value
);
112 if (!strcmp(var
, "report.sort_order")) {
113 default_sort_order
= strdup(value
);
120 static int hist_iter__report_callback(struct hist_entry_iter
*iter
,
121 struct addr_location
*al
, bool single
,
125 struct report
*rep
= arg
;
126 struct hist_entry
*he
= iter
->he
;
127 struct perf_evsel
*evsel
= iter
->evsel
;
128 struct perf_sample
*sample
= iter
->sample
;
130 struct branch_info
*bi
;
132 if (!ui__has_annotation())
135 hist__account_cycles(sample
->branch_stack
, al
, sample
,
136 rep
->nonany_branch_mode
);
138 if (sort__mode
== SORT_MODE__BRANCH
) {
139 bi
= he
->branch_info
;
140 err
= addr_map_symbol__inc_samples(&bi
->from
, sample
, evsel
);
144 err
= addr_map_symbol__inc_samples(&bi
->to
, sample
, evsel
);
146 } else if (rep
->mem_mode
) {
148 err
= addr_map_symbol__inc_samples(&mi
->daddr
, sample
, evsel
);
152 err
= hist_entry__inc_addr_samples(he
, sample
, evsel
, al
->addr
);
154 } else if (symbol_conf
.cumulate_callchain
) {
156 err
= hist_entry__inc_addr_samples(he
, sample
, evsel
, al
->addr
);
158 err
= hist_entry__inc_addr_samples(he
, sample
, evsel
, al
->addr
);
165 static int hist_iter__branch_callback(struct hist_entry_iter
*iter
,
166 struct addr_location
*al __maybe_unused
,
167 bool single __maybe_unused
,
170 struct hist_entry
*he
= iter
->he
;
171 struct report
*rep
= arg
;
172 struct branch_info
*bi
;
173 struct perf_sample
*sample
= iter
->sample
;
174 struct perf_evsel
*evsel
= iter
->evsel
;
177 if (!ui__has_annotation())
180 hist__account_cycles(sample
->branch_stack
, al
, sample
,
181 rep
->nonany_branch_mode
);
183 bi
= he
->branch_info
;
184 err
= addr_map_symbol__inc_samples(&bi
->from
, sample
, evsel
);
188 err
= addr_map_symbol__inc_samples(&bi
->to
, sample
, evsel
);
190 branch_type_count(&rep
->brtype_stat
, &bi
->flags
,
191 bi
->from
.addr
, bi
->to
.addr
);
197 static void setup_forced_leader(struct report
*report
,
198 struct perf_evlist
*evlist
)
200 if (report
->group_set
)
201 perf_evlist__force_leader(evlist
);
204 static int process_feature_event(struct perf_tool
*tool
,
205 union perf_event
*event
,
206 struct perf_session
*session __maybe_unused
)
208 struct report
*rep
= container_of(tool
, struct report
, tool
);
210 if (event
->feat
.feat_id
< HEADER_LAST_FEATURE
)
211 return perf_event__process_feature(tool
, event
, session
);
213 if (event
->feat
.feat_id
!= HEADER_LAST_FEATURE
) {
214 pr_err("failed: wrong feature ID: %" PRIu64
"\n",
215 event
->feat
.feat_id
);
220 * (feat_id = HEADER_LAST_FEATURE) is the end marker which
221 * means all features are received, now we can force the
224 setup_forced_leader(rep
, session
->evlist
);
228 static int process_sample_event(struct perf_tool
*tool
,
229 union perf_event
*event
,
230 struct perf_sample
*sample
,
231 struct perf_evsel
*evsel
,
232 struct machine
*machine
)
234 struct report
*rep
= container_of(tool
, struct report
, tool
);
235 struct addr_location al
;
236 struct hist_entry_iter iter
= {
239 .hide_unresolved
= symbol_conf
.hide_unresolved
,
240 .add_entry_cb
= hist_iter__report_callback
,
244 if (perf_time__ranges_skip_sample(rep
->ptime_range
, rep
->range_num
,
249 if (machine__resolve(machine
, &al
, sample
) < 0) {
250 pr_debug("problem processing %d event, skipping it.\n",
255 if (symbol_conf
.hide_unresolved
&& al
.sym
== NULL
)
258 if (rep
->cpu_list
&& !test_bit(sample
->cpu
, rep
->cpu_bitmap
))
261 if (sort__mode
== SORT_MODE__BRANCH
) {
263 * A non-synthesized event might not have a branch stack if
264 * branch stacks have been synthesized (using itrace options).
266 if (!sample
->branch_stack
)
269 iter
.add_entry_cb
= hist_iter__branch_callback
;
270 iter
.ops
= &hist_iter_branch
;
271 } else if (rep
->mem_mode
) {
272 iter
.ops
= &hist_iter_mem
;
273 } else if (symbol_conf
.cumulate_callchain
) {
274 iter
.ops
= &hist_iter_cumulative
;
276 iter
.ops
= &hist_iter_normal
;
280 al
.map
->dso
->hit
= 1;
282 ret
= hist_entry_iter__add(&iter
, &al
, rep
->max_stack
, rep
);
284 pr_debug("problem adding hist entry, skipping event\n");
286 addr_location__put(&al
);
290 static int process_read_event(struct perf_tool
*tool
,
291 union perf_event
*event
,
292 struct perf_sample
*sample __maybe_unused
,
293 struct perf_evsel
*evsel
,
294 struct machine
*machine __maybe_unused
)
296 struct report
*rep
= container_of(tool
, struct report
, tool
);
298 if (rep
->show_threads
) {
299 const char *name
= evsel
? perf_evsel__name(evsel
) : "unknown";
300 int err
= perf_read_values_add_value(&rep
->show_threads_values
,
301 event
->read
.pid
, event
->read
.tid
,
313 /* For pipe mode, sample_type is not currently set */
314 static int report__setup_sample_type(struct report
*rep
)
316 struct perf_session
*session
= rep
->session
;
317 u64 sample_type
= perf_evlist__combined_sample_type(session
->evlist
);
318 bool is_pipe
= perf_data__is_pipe(session
->data
);
320 if (session
->itrace_synth_opts
->callchain
||
322 perf_header__has_feat(&session
->header
, HEADER_AUXTRACE
) &&
323 !session
->itrace_synth_opts
->set
))
324 sample_type
|= PERF_SAMPLE_CALLCHAIN
;
326 if (session
->itrace_synth_opts
->last_branch
)
327 sample_type
|= PERF_SAMPLE_BRANCH_STACK
;
329 if (!is_pipe
&& !(sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
330 if (perf_hpp_list
.parent
) {
331 ui__error("Selected --sort parent, but no "
332 "callchain data. Did you call "
333 "'perf record' without -g?\n");
336 if (symbol_conf
.use_callchain
&&
337 !symbol_conf
.show_branchflag_count
) {
338 ui__error("Selected -g or --branch-history.\n"
339 "But no callchain or branch data.\n"
340 "Did you call 'perf record' without -g or -b?\n");
343 } else if (!callchain_param
.enabled
&&
344 callchain_param
.mode
!= CHAIN_NONE
&&
345 !symbol_conf
.use_callchain
) {
346 symbol_conf
.use_callchain
= true;
347 if (callchain_register_param(&callchain_param
) < 0) {
348 ui__error("Can't register callchain params.\n");
353 if (symbol_conf
.cumulate_callchain
) {
354 /* Silently ignore if callchain is missing */
355 if (!(sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
356 symbol_conf
.cumulate_callchain
= false;
357 perf_hpp__cancel_cumulate();
361 if (sort__mode
== SORT_MODE__BRANCH
) {
363 !(sample_type
& PERF_SAMPLE_BRANCH_STACK
)) {
364 ui__error("Selected -b but no branch data. "
365 "Did you call perf record without -b?\n");
370 if (symbol_conf
.use_callchain
|| symbol_conf
.cumulate_callchain
) {
371 if ((sample_type
& PERF_SAMPLE_REGS_USER
) &&
372 (sample_type
& PERF_SAMPLE_STACK_USER
)) {
373 callchain_param
.record_mode
= CALLCHAIN_DWARF
;
374 dwarf_callchain_users
= true;
375 } else if (sample_type
& PERF_SAMPLE_BRANCH_STACK
)
376 callchain_param
.record_mode
= CALLCHAIN_LBR
;
378 callchain_param
.record_mode
= CALLCHAIN_FP
;
381 /* ??? handle more cases than just ANY? */
382 if (!(perf_evlist__combined_branch_type(session
->evlist
) &
383 PERF_SAMPLE_BRANCH_ANY
))
384 rep
->nonany_branch_mode
= true;
389 static void sig_handler(int sig __maybe_unused
)
394 static size_t hists__fprintf_nr_sample_events(struct hists
*hists
, struct report
*rep
,
395 const char *evname
, FILE *fp
)
399 unsigned long nr_samples
= hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
400 u64 nr_events
= hists
->stats
.total_period
;
401 struct perf_evsel
*evsel
= hists_to_evsel(hists
);
403 size_t size
= sizeof(buf
);
404 int socked_id
= hists
->socket_filter
;
409 if (symbol_conf
.filter_relative
) {
410 nr_samples
= hists
->stats
.nr_non_filtered_samples
;
411 nr_events
= hists
->stats
.total_non_filtered_period
;
414 if (perf_evsel__is_group_event(evsel
)) {
415 struct perf_evsel
*pos
;
417 perf_evsel__group_desc(evsel
, buf
, size
);
420 for_each_group_member(pos
, evsel
) {
421 const struct hists
*pos_hists
= evsel__hists(pos
);
423 if (symbol_conf
.filter_relative
) {
424 nr_samples
+= pos_hists
->stats
.nr_non_filtered_samples
;
425 nr_events
+= pos_hists
->stats
.total_non_filtered_period
;
427 nr_samples
+= pos_hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
428 nr_events
+= pos_hists
->stats
.total_period
;
433 nr_samples
= convert_unit(nr_samples
, &unit
);
434 ret
= fprintf(fp
, "# Samples: %lu%c", nr_samples
, unit
);
435 if (evname
!= NULL
) {
436 ret
+= fprintf(fp
, " of event%s '%s'",
437 evsel
->nr_members
> 1 ? "s" : "", evname
);
441 ret
+= fprintf(fp
, " (time slices: %s)", rep
->time_str
);
443 if (symbol_conf
.show_ref_callgraph
&&
444 strstr(evname
, "call-graph=no")) {
445 ret
+= fprintf(fp
, ", show reference callgraph");
449 ret
+= fprintf(fp
, "\n# Total weight : %" PRIu64
, nr_events
);
450 ret
+= fprintf(fp
, "\n# Sort order : %s", sort_order
? : default_mem_sort_order
);
452 ret
+= fprintf(fp
, "\n# Event count (approx.): %" PRIu64
, nr_events
);
455 ret
+= fprintf(fp
, "\n# Processor Socket: %d", socked_id
);
457 return ret
+ fprintf(fp
, "\n#\n");
460 static int perf_evlist__tty_browse_hists(struct perf_evlist
*evlist
,
464 struct perf_evsel
*pos
;
467 fprintf(stdout
, "#\n# Total Lost Samples: %" PRIu64
"\n#\n",
468 evlist
->stats
.total_lost_samples
);
471 evlist__for_each_entry(evlist
, pos
) {
472 struct hists
*hists
= evsel__hists(pos
);
473 const char *evname
= perf_evsel__name(pos
);
475 if (symbol_conf
.event_group
&&
476 !perf_evsel__is_group_leader(pos
))
479 hists__fprintf_nr_sample_events(hists
, rep
, evname
, stdout
);
480 hists__fprintf(hists
, !quiet
, 0, 0, rep
->min_percent
, stdout
,
481 !(symbol_conf
.use_callchain
||
482 symbol_conf
.show_branchflag_count
));
483 fprintf(stdout
, "\n\n");
487 fprintf(stdout
, "#\n# (%s)\n#\n", help
);
489 if (rep
->show_threads
) {
490 bool style
= !strcmp(rep
->pretty_printing_style
, "raw");
491 perf_read_values_display(stdout
, &rep
->show_threads_values
,
493 perf_read_values_destroy(&rep
->show_threads_values
);
496 if (sort__mode
== SORT_MODE__BRANCH
)
497 branch_type_stat_display(stdout
, &rep
->brtype_stat
);
502 static void report__warn_kptr_restrict(const struct report
*rep
)
504 struct map
*kernel_map
= machine__kernel_map(&rep
->session
->machines
.host
);
505 struct kmap
*kernel_kmap
= kernel_map
? map__kmap(kernel_map
) : NULL
;
507 if (perf_evlist__exclude_kernel(rep
->session
->evlist
))
510 if (kernel_map
== NULL
||
511 (kernel_map
->dso
->hit
&&
512 (kernel_kmap
->ref_reloc_sym
== NULL
||
513 kernel_kmap
->ref_reloc_sym
->addr
== 0))) {
515 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
516 "can't be resolved.";
518 if (kernel_map
&& map__has_symbols(kernel_map
)) {
519 desc
= "If some relocation was applied (e.g. "
520 "kexec) symbols may be misresolved.";
524 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
525 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
526 "Samples in kernel modules can't be resolved as well.\n\n",
531 static int report__gtk_browse_hists(struct report
*rep
, const char *help
)
533 int (*hist_browser
)(struct perf_evlist
*evlist
, const char *help
,
534 struct hist_browser_timer
*timer
, float min_pcnt
);
536 hist_browser
= dlsym(perf_gtk_handle
, "perf_evlist__gtk_browse_hists");
538 if (hist_browser
== NULL
) {
539 ui__error("GTK browser not found!\n");
543 return hist_browser(rep
->session
->evlist
, help
, NULL
, rep
->min_percent
);
546 static int report__browse_hists(struct report
*rep
)
549 struct perf_session
*session
= rep
->session
;
550 struct perf_evlist
*evlist
= session
->evlist
;
551 const char *help
= perf_tip(system_path(TIPDIR
));
554 /* fallback for people who don't install perf ;-) */
555 help
= perf_tip(DOCDIR
);
557 help
= "Cannot load tips.txt file, please install perf!";
560 switch (use_browser
) {
562 ret
= perf_evlist__tui_browse_hists(evlist
, help
, NULL
,
564 &session
->header
.env
,
565 true, &rep
->annotation_opts
);
567 * Usually "ret" is the last pressed key, and we only
568 * care if the key notifies us to switch data file.
570 if (ret
!= K_SWITCH_INPUT_DATA
)
574 ret
= report__gtk_browse_hists(rep
, help
);
577 ret
= perf_evlist__tty_browse_hists(evlist
, rep
, help
);
584 static int report__collapse_hists(struct report
*rep
)
586 struct ui_progress prog
;
587 struct perf_evsel
*pos
;
590 ui_progress__init(&prog
, rep
->nr_entries
, "Merging related events...");
592 evlist__for_each_entry(rep
->session
->evlist
, pos
) {
593 struct hists
*hists
= evsel__hists(pos
);
596 hists
->symbol_filter_str
= rep
->symbol_filter_str
;
598 hists
->socket_filter
= rep
->socket_filter
;
600 ret
= hists__collapse_resort(hists
, &prog
);
604 /* Non-group events are considered as leader */
605 if (symbol_conf
.event_group
&&
606 !perf_evsel__is_group_leader(pos
)) {
607 struct hists
*leader_hists
= evsel__hists(pos
->leader
);
609 hists__match(leader_hists
, hists
);
610 hists__link(leader_hists
, hists
);
614 ui_progress__finish();
618 static void report__output_resort(struct report
*rep
)
620 struct ui_progress prog
;
621 struct perf_evsel
*pos
;
623 ui_progress__init(&prog
, rep
->nr_entries
, "Sorting events for output...");
625 evlist__for_each_entry(rep
->session
->evlist
, pos
)
626 perf_evsel__output_resort(pos
, &prog
);
628 ui_progress__finish();
631 static void stats_setup(struct report
*rep
)
633 memset(&rep
->tool
, 0, sizeof(rep
->tool
));
634 rep
->tool
.no_warn
= true;
637 static int stats_print(struct report
*rep
)
639 struct perf_session
*session
= rep
->session
;
641 perf_session__fprintf_nr_events(session
, stdout
);
645 static void tasks_setup(struct report
*rep
)
647 memset(&rep
->tool
, 0, sizeof(rep
->tool
));
648 rep
->tool
.ordered_events
= true;
649 if (rep
->mmaps_mode
) {
650 rep
->tool
.mmap
= perf_event__process_mmap
;
651 rep
->tool
.mmap2
= perf_event__process_mmap2
;
653 rep
->tool
.comm
= perf_event__process_comm
;
654 rep
->tool
.exit
= perf_event__process_exit
;
655 rep
->tool
.fork
= perf_event__process_fork
;
656 rep
->tool
.no_warn
= true;
660 struct thread
*thread
;
661 struct list_head list
;
662 struct list_head children
;
665 static struct task
*tasks_list(struct task
*task
, struct machine
*machine
)
667 struct thread
*parent_thread
, *thread
= task
->thread
;
668 struct task
*parent_task
;
670 /* Already listed. */
671 if (!list_empty(&task
->list
))
674 /* Last one in the chain. */
675 if (thread
->ppid
== -1)
678 parent_thread
= machine__find_thread(machine
, -1, thread
->ppid
);
680 return ERR_PTR(-ENOENT
);
682 parent_task
= thread__priv(parent_thread
);
683 list_add_tail(&task
->list
, &parent_task
->children
);
684 return tasks_list(parent_task
, machine
);
687 static size_t maps__fprintf_task(struct maps
*maps
, int indent
, FILE *fp
)
692 for (nd
= rb_first(&maps
->entries
); nd
; nd
= rb_next(nd
)) {
693 struct map
*map
= rb_entry(nd
, struct map
, rb_node
);
695 printed
+= fprintf(fp
, "%*s %" PRIx64
"-%" PRIx64
" %c%c%c%c %08" PRIx64
" %" PRIu64
" %s\n",
696 indent
, "", map
->start
, map
->end
,
697 map
->prot
& PROT_READ
? 'r' : '-',
698 map
->prot
& PROT_WRITE
? 'w' : '-',
699 map
->prot
& PROT_EXEC
? 'x' : '-',
700 map
->flags
& MAP_SHARED
? 's' : 'p',
702 map
->ino
, map
->dso
->name
);
708 static int map_groups__fprintf_task(struct map_groups
*mg
, int indent
, FILE *fp
)
710 return maps__fprintf_task(&mg
->maps
, indent
, fp
);
713 static void task__print_level(struct task
*task
, FILE *fp
, int level
)
715 struct thread
*thread
= task
->thread
;
717 int comm_indent
= fprintf(fp
, " %8d %8d %8d |%*s",
718 thread
->pid_
, thread
->tid
, thread
->ppid
,
721 fprintf(fp
, "%s\n", thread__comm_str(thread
));
723 map_groups__fprintf_task(thread
->mg
, comm_indent
, fp
);
725 if (!list_empty(&task
->children
)) {
726 list_for_each_entry(child
, &task
->children
, list
)
727 task__print_level(child
, fp
, level
+ 1);
731 static int tasks_print(struct report
*rep
, FILE *fp
)
733 struct perf_session
*session
= rep
->session
;
734 struct machine
*machine
= &session
->machines
.host
;
735 struct task
*tasks
, *task
;
736 unsigned int nr
= 0, itask
= 0, i
;
741 * No locking needed while accessing machine->threads,
742 * because --tasks is single threaded command.
745 /* Count all the threads. */
746 for (i
= 0; i
< THREADS__TABLE_SIZE
; i
++)
747 nr
+= machine
->threads
[i
].nr
;
749 tasks
= malloc(sizeof(*tasks
) * nr
);
753 for (i
= 0; i
< THREADS__TABLE_SIZE
; i
++) {
754 struct threads
*threads
= &machine
->threads
[i
];
756 for (nd
= rb_first(&threads
->entries
); nd
; nd
= rb_next(nd
)) {
757 task
= tasks
+ itask
++;
759 task
->thread
= rb_entry(nd
, struct thread
, rb_node
);
760 INIT_LIST_HEAD(&task
->children
);
761 INIT_LIST_HEAD(&task
->list
);
762 thread__set_priv(task
->thread
, task
);
767 * Iterate every task down to the unprocessed parent
768 * and link all in task children list. Task with no
769 * parent is added into 'list'.
771 for (itask
= 0; itask
< nr
; itask
++) {
772 task
= tasks
+ itask
;
774 if (!list_empty(&task
->list
))
777 task
= tasks_list(task
, machine
);
779 pr_err("Error: failed to process tasks\n");
781 return PTR_ERR(task
);
785 list_add_tail(&task
->list
, &list
);
788 fprintf(fp
, "# %8s %8s %8s %s\n", "pid", "tid", "ppid", "comm");
790 list_for_each_entry(task
, &list
, list
)
791 task__print_level(task
, fp
, 0);
797 static int __cmd_report(struct report
*rep
)
800 struct perf_session
*session
= rep
->session
;
801 struct perf_evsel
*pos
;
802 struct perf_data
*data
= session
->data
;
804 signal(SIGINT
, sig_handler
);
807 ret
= perf_session__cpu_bitmap(session
, rep
->cpu_list
,
810 ui__error("failed to set cpu bitmap\n");
813 session
->itrace_synth_opts
->cpu_bitmap
= rep
->cpu_bitmap
;
816 if (rep
->show_threads
) {
817 ret
= perf_read_values_init(&rep
->show_threads_values
);
822 ret
= report__setup_sample_type(rep
);
824 /* report__setup_sample_type() already showed error message */
834 ret
= perf_session__process_events(session
);
836 ui__error("failed to process sample\n");
841 return stats_print(rep
);
844 return tasks_print(rep
, stdout
);
846 report__warn_kptr_restrict(rep
);
848 evlist__for_each_entry(session
->evlist
, pos
)
849 rep
->nr_entries
+= evsel__hists(pos
)->nr_entries
;
851 if (use_browser
== 0) {
853 perf_session__fprintf(session
, stdout
);
856 perf_session__fprintf_dsos(session
, stdout
);
859 perf_session__fprintf_nr_events(session
, stdout
);
860 perf_evlist__fprintf_nr_events(session
->evlist
, stdout
);
865 ret
= report__collapse_hists(rep
);
867 ui__error("failed to process hist entry\n");
875 * recalculate number of entries after collapsing since it
876 * might be changed during the collapse phase.
879 evlist__for_each_entry(session
->evlist
, pos
)
880 rep
->nr_entries
+= evsel__hists(pos
)->nr_entries
;
882 if (rep
->nr_entries
== 0) {
883 ui__error("The %s file has no samples!\n", data
->file
.path
);
887 report__output_resort(rep
);
889 return report__browse_hists(rep
);
893 report_parse_callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
895 struct callchain_param
*callchain
= opt
->value
;
897 callchain
->enabled
= !unset
;
902 symbol_conf
.use_callchain
= false;
903 callchain
->mode
= CHAIN_NONE
;
907 return parse_callchain_report_opt(arg
);
911 report_parse_ignore_callees_opt(const struct option
*opt __maybe_unused
,
912 const char *arg
, int unset __maybe_unused
)
915 int err
= regcomp(&ignore_callees_regex
, arg
, REG_EXTENDED
);
918 regerror(err
, &ignore_callees_regex
, buf
, sizeof(buf
));
919 pr_err("Invalid --ignore-callees regex: %s\n%s", arg
, buf
);
922 have_ignore_callees
= 1;
929 parse_branch_mode(const struct option
*opt
,
930 const char *str __maybe_unused
, int unset
)
932 int *branch_mode
= opt
->value
;
934 *branch_mode
= !unset
;
939 parse_percent_limit(const struct option
*opt
, const char *str
,
940 int unset __maybe_unused
)
942 struct report
*rep
= opt
->value
;
943 double pcnt
= strtof(str
, NULL
);
945 rep
->min_percent
= pcnt
;
946 callchain_param
.min_percent
= pcnt
;
950 int cmd_report(int argc
, const char **argv
)
952 struct perf_session
*session
;
953 struct itrace_synth_opts itrace_synth_opts
= { .set
= 0, };
955 bool has_br_stack
= false;
956 int branch_mode
= -1;
957 bool branch_call_mode
= false;
958 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
959 const char report_callchain_help
[] = "Display call graph (stack chain/backtrace):\n\n"
960 CALLCHAIN_REPORT_HELP
961 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT
;
962 char callchain_default_opt
[] = CALLCHAIN_DEFAULT_OPT
;
963 const char * const report_usage
[] = {
964 "perf report [<options>]",
967 struct report report
= {
969 .sample
= process_sample_event
,
970 .mmap
= perf_event__process_mmap
,
971 .mmap2
= perf_event__process_mmap2
,
972 .comm
= perf_event__process_comm
,
973 .namespaces
= perf_event__process_namespaces
,
974 .exit
= perf_event__process_exit
,
975 .fork
= perf_event__process_fork
,
976 .lost
= perf_event__process_lost
,
977 .read
= process_read_event
,
978 .attr
= perf_event__process_attr
,
979 .tracing_data
= perf_event__process_tracing_data
,
980 .build_id
= perf_event__process_build_id
,
981 .id_index
= perf_event__process_id_index
,
982 .auxtrace_info
= perf_event__process_auxtrace_info
,
983 .auxtrace
= perf_event__process_auxtrace
,
984 .feature
= process_feature_event
,
985 .ordered_events
= true,
986 .ordering_requires_timestamps
= true,
988 .max_stack
= PERF_MAX_STACK_DEPTH
,
989 .pretty_printing_style
= "normal",
991 .annotation_opts
= annotation__default_options
,
993 const struct option options
[] = {
994 OPT_STRING('i', "input", &input_name
, "file",
996 OPT_INCR('v', "verbose", &verbose
,
997 "be more verbose (show symbol address, etc)"),
998 OPT_BOOLEAN('q', "quiet", &quiet
, "Do not show any message"),
999 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
1000 "dump raw trace in ASCII"),
1001 OPT_BOOLEAN(0, "stats", &report
.stats_mode
, "Display event stats"),
1002 OPT_BOOLEAN(0, "tasks", &report
.tasks_mode
, "Display recorded tasks"),
1003 OPT_BOOLEAN(0, "mmaps", &report
.mmaps_mode
, "Display recorded tasks memory maps"),
1004 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
1005 "file", "vmlinux pathname"),
1006 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf
.ignore_vmlinux
,
1007 "don't load vmlinux even if found"),
1008 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
,
1009 "file", "kallsyms pathname"),
1010 OPT_BOOLEAN('f', "force", &symbol_conf
.force
, "don't complain, do it"),
1011 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
1012 "load module symbols - WARNING: use only with -k and LIVE kernel"),
1013 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
1014 "Show a column with the number of samples"),
1015 OPT_BOOLEAN('T', "threads", &report
.show_threads
,
1016 "Show per-thread event counters"),
1017 OPT_STRING(0, "pretty", &report
.pretty_printing_style
, "key",
1018 "pretty printing style key: normal raw"),
1019 OPT_BOOLEAN(0, "tui", &report
.use_tui
, "Use the TUI interface"),
1020 OPT_BOOLEAN(0, "gtk", &report
.use_gtk
, "Use the GTK2 interface"),
1021 OPT_BOOLEAN(0, "stdio", &report
.use_stdio
,
1022 "Use the stdio interface"),
1023 OPT_BOOLEAN(0, "header", &report
.header
, "Show data header."),
1024 OPT_BOOLEAN(0, "header-only", &report
.header_only
,
1025 "Show only data header."),
1026 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
1027 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1028 " Please refer the man page for the complete list."),
1029 OPT_STRING('F', "fields", &field_order
, "key[,keys...]",
1030 "output field(s): overhead, period, sample plus all of sort keys"),
1031 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf
.show_cpu_utilization
,
1032 "Show sample percentage for different cpu modes"),
1033 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf
.show_cpu_utilization
,
1034 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN
),
1035 OPT_STRING('p', "parent", &parent_pattern
, "regex",
1036 "regex filter to identify parent, see: '--sort parent'"),
1037 OPT_BOOLEAN('x', "exclude-other", &symbol_conf
.exclude_other
,
1038 "Only display entries with parent-match"),
1039 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param
,
1040 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
1041 report_callchain_help
, &report_parse_callchain_opt
,
1042 callchain_default_opt
),
1043 OPT_BOOLEAN(0, "children", &symbol_conf
.cumulate_callchain
,
1044 "Accumulate callchains of children and show total overhead as well"),
1045 OPT_INTEGER(0, "max-stack", &report
.max_stack
,
1046 "Set the maximum stack depth when parsing the callchain, "
1047 "anything beyond the specified depth will be ignored. "
1048 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH
)),
1049 OPT_BOOLEAN('G', "inverted", &report
.inverted_callchain
,
1050 "alias for inverted call graph"),
1051 OPT_CALLBACK(0, "ignore-callees", NULL
, "regex",
1052 "ignore callees of these functions in call graphs",
1053 report_parse_ignore_callees_opt
),
1054 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
1055 "only consider symbols in these dsos"),
1056 OPT_STRING('c', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
1057 "only consider symbols in these comms"),
1058 OPT_STRING(0, "pid", &symbol_conf
.pid_list_str
, "pid[,pid...]",
1059 "only consider symbols in these pids"),
1060 OPT_STRING(0, "tid", &symbol_conf
.tid_list_str
, "tid[,tid...]",
1061 "only consider symbols in these tids"),
1062 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
1063 "only consider these symbols"),
1064 OPT_STRING(0, "symbol-filter", &report
.symbol_filter_str
, "filter",
1065 "only show symbols that (partially) match with this filter"),
1066 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
1068 "don't try to adjust column width, use these fixed values"),
1069 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf
.field_sep
, "separator",
1070 "separator for columns, no spaces will be added between "
1071 "columns '.' is reserved."),
1072 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf
.hide_unresolved
,
1073 "Only display entries resolved to a symbol"),
1074 OPT_CALLBACK(0, "symfs", NULL
, "directory",
1075 "Look for files with symbols relative to this directory",
1076 symbol__config_symfs
),
1077 OPT_STRING('C', "cpu", &report
.cpu_list
, "cpu",
1078 "list of cpus to profile"),
1079 OPT_BOOLEAN('I', "show-info", &report
.show_full_info
,
1080 "Display extended information about perf.data file"),
1081 OPT_BOOLEAN(0, "source", &report
.annotation_opts
.annotate_src
,
1082 "Interleave source code with assembly code (default)"),
1083 OPT_BOOLEAN(0, "asm-raw", &report
.annotation_opts
.show_asm_raw
,
1084 "Display raw encoding of assembly instructions (default)"),
1085 OPT_STRING('M', "disassembler-style", &report
.annotation_opts
.disassembler_style
, "disassembler style",
1086 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1087 OPT_BOOLEAN(0, "show-total-period", &symbol_conf
.show_total_period
,
1088 "Show a column with the sum of periods"),
1089 OPT_BOOLEAN_SET(0, "group", &symbol_conf
.event_group
, &report
.group_set
,
1090 "Show event group information together"),
1091 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode
, "",
1092 "use branch records for per branch histogram filling",
1094 OPT_BOOLEAN(0, "branch-history", &branch_call_mode
,
1095 "add last branch records to call history"),
1096 OPT_STRING(0, "objdump", &report
.annotation_opts
.objdump_path
, "path",
1097 "objdump binary to use for disassembly and annotations"),
1098 OPT_BOOLEAN(0, "demangle", &symbol_conf
.demangle
,
1099 "Disable symbol demangling"),
1100 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf
.demangle_kernel
,
1101 "Enable kernel symbol demangling"),
1102 OPT_BOOLEAN(0, "mem-mode", &report
.mem_mode
, "mem access profile"),
1103 OPT_CALLBACK(0, "percent-limit", &report
, "percent",
1104 "Don't show entries under that percent", parse_percent_limit
),
1105 OPT_CALLBACK(0, "percentage", NULL
, "relative|absolute",
1106 "how to display percentage of filtered entries", parse_filter_percentage
),
1107 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts
, NULL
, "opts",
1108 "Instruction Tracing options",
1109 itrace_parse_synth_opts
),
1110 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename
,
1111 "Show full source file name path for source lines"),
1112 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf
.show_ref_callgraph
,
1113 "Show callgraph from reference event"),
1114 OPT_INTEGER(0, "socket-filter", &report
.socket_filter
,
1115 "only show processor socket that match with this filter"),
1116 OPT_BOOLEAN(0, "raw-trace", &symbol_conf
.raw_trace
,
1117 "Show raw trace event output (do not use print fmt or plugins)"),
1118 OPT_BOOLEAN(0, "hierarchy", &symbol_conf
.report_hierarchy
,
1119 "Show entries in a hierarchy"),
1120 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL
, "mode",
1121 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
1122 stdio__config_color
, "always"),
1123 OPT_STRING(0, "time", &report
.time_str
, "str",
1124 "Time span of interest (start,stop)"),
1125 OPT_BOOLEAN(0, "inline", &symbol_conf
.inline_name
,
1126 "Show inline function"),
1127 OPT_CALLBACK(0, "percent-type", &report
.annotation_opts
, "local-period",
1128 "Set percent type local/global-period/hits",
1129 annotate_parse_percent_type
),
1132 struct perf_data data
= {
1133 .mode
= PERF_DATA_MODE_READ
,
1135 int ret
= hists__init();
1140 ret
= perf_config(report__config
, &report
);
1144 argc
= parse_options(argc
, argv
, options
, report_usage
, 0);
1147 * Special case: if there's an argument left then assume that
1148 * it's a symbol filter:
1151 usage_with_options(report_usage
, options
);
1153 report
.symbol_filter_str
= argv
[0];
1156 if (report
.mmaps_mode
)
1157 report
.tasks_mode
= true;
1160 perf_quiet_option();
1162 if (symbol_conf
.vmlinux_name
&&
1163 access(symbol_conf
.vmlinux_name
, R_OK
)) {
1164 pr_err("Invalid file: %s\n", symbol_conf
.vmlinux_name
);
1167 if (symbol_conf
.kallsyms_name
&&
1168 access(symbol_conf
.kallsyms_name
, R_OK
)) {
1169 pr_err("Invalid file: %s\n", symbol_conf
.kallsyms_name
);
1173 if (report
.inverted_callchain
)
1174 callchain_param
.order
= ORDER_CALLER
;
1175 if (symbol_conf
.cumulate_callchain
&& !callchain_param
.order_set
)
1176 callchain_param
.order
= ORDER_CALLER
;
1178 if (itrace_synth_opts
.callchain
&&
1179 (int)itrace_synth_opts
.callchain_sz
> report
.max_stack
)
1180 report
.max_stack
= itrace_synth_opts
.callchain_sz
;
1182 if (!input_name
|| !strlen(input_name
)) {
1183 if (!fstat(STDIN_FILENO
, &st
) && S_ISFIFO(st
.st_mode
))
1186 input_name
= "perf.data";
1189 data
.file
.path
= input_name
;
1190 data
.force
= symbol_conf
.force
;
1193 session
= perf_session__new(&data
, false, &report
.tool
);
1194 if (session
== NULL
)
1197 if (report
.queue_size
) {
1198 ordered_events__set_alloc_size(&session
->ordered_events
,
1202 session
->itrace_synth_opts
= &itrace_synth_opts
;
1204 report
.session
= session
;
1206 has_br_stack
= perf_header__has_feat(&session
->header
,
1207 HEADER_BRANCH_STACK
);
1209 setup_forced_leader(&report
, session
->evlist
);
1211 if (itrace_synth_opts
.last_branch
)
1212 has_br_stack
= true;
1214 if (has_br_stack
&& branch_call_mode
)
1215 symbol_conf
.show_branchflag_count
= true;
1217 memset(&report
.brtype_stat
, 0, sizeof(struct branch_type_stat
));
1220 * Branch mode is a tristate:
1221 * -1 means default, so decide based on the file having branch data.
1222 * 0/1 means the user chose a mode.
1224 if (((branch_mode
== -1 && has_br_stack
) || branch_mode
== 1) &&
1225 !branch_call_mode
) {
1226 sort__mode
= SORT_MODE__BRANCH
;
1227 symbol_conf
.cumulate_callchain
= false;
1229 if (branch_call_mode
) {
1230 callchain_param
.key
= CCKEY_ADDRESS
;
1231 callchain_param
.branch_callstack
= 1;
1232 symbol_conf
.use_callchain
= true;
1233 callchain_register_param(&callchain_param
);
1234 if (sort_order
== NULL
)
1235 sort_order
= "srcline,symbol,dso";
1238 if (report
.mem_mode
) {
1239 if (sort__mode
== SORT_MODE__BRANCH
) {
1240 pr_err("branch and mem mode incompatible\n");
1243 sort__mode
= SORT_MODE__MEMORY
;
1244 symbol_conf
.cumulate_callchain
= false;
1247 if (symbol_conf
.report_hierarchy
) {
1248 /* disable incompatible options */
1249 symbol_conf
.cumulate_callchain
= false;
1252 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1253 parse_options_usage(report_usage
, options
, "F", 1);
1254 parse_options_usage(NULL
, options
, "hierarchy", 0);
1258 perf_hpp_list
.need_collapse
= true;
1261 if (report
.use_stdio
)
1263 else if (report
.use_tui
)
1265 else if (report
.use_gtk
)
1268 /* Force tty output for header output and per-thread stat. */
1269 if (report
.header
|| report
.header_only
|| report
.show_threads
)
1271 if (report
.header
|| report
.header_only
)
1272 report
.tool
.show_feat_hdr
= SHOW_FEAT_HEADER
;
1273 if (report
.show_full_info
)
1274 report
.tool
.show_feat_hdr
= SHOW_FEAT_HEADER_FULL_INFO
;
1275 if (report
.stats_mode
|| report
.tasks_mode
)
1277 if (report
.stats_mode
&& report
.tasks_mode
) {
1278 pr_err("Error: --tasks and --mmaps can't be used together with --stats\n");
1282 if (strcmp(input_name
, "-") != 0)
1283 setup_browser(true);
1287 if (setup_sorting(session
->evlist
) < 0) {
1289 parse_options_usage(report_usage
, options
, "s", 1);
1291 parse_options_usage(sort_order
? NULL
: report_usage
,
1296 if ((report
.header
|| report
.header_only
) && !quiet
) {
1297 perf_session__fprintf_info(session
, stdout
,
1298 report
.show_full_info
);
1299 if (report
.header_only
) {
1303 } else if (use_browser
== 0 && !quiet
&&
1304 !report
.stats_mode
&& !report
.tasks_mode
) {
1305 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1310 * Only in the TUI browser we are doing integrated annotation,
1311 * so don't allocate extra space that won't be used in the stdio
1314 if (ui__has_annotation()) {
1315 ret
= symbol__annotation_init();
1319 * For searching by name on the "Browse map details".
1320 * providing it only in verbose mode not to bloat too
1321 * much struct symbol.
1325 * XXX: Need to provide a less kludgy way to ask for
1326 * more space per symbol, the u32 is for the index on
1328 * See symbol__browser_index.
1330 symbol_conf
.priv_size
+= sizeof(u32
);
1331 symbol_conf
.sort_by_name
= true;
1333 annotation_config__init();
1336 if (symbol__init(&session
->header
.env
) < 0)
1339 report
.ptime_range
= perf_time__range_alloc(report
.time_str
,
1340 &report
.range_size
);
1341 if (!report
.ptime_range
) {
1346 if (perf_time__parse_str(report
.ptime_range
, report
.time_str
) != 0) {
1347 if (session
->evlist
->first_sample_time
== 0 &&
1348 session
->evlist
->last_sample_time
== 0) {
1349 pr_err("HINT: no first/last sample time found in perf data.\n"
1350 "Please use latest perf binary to execute 'perf record'\n"
1351 "(if '--buildid-all' is enabled, please set '--timestamp-boundary').\n");
1356 report
.range_num
= perf_time__percent_parse_str(
1357 report
.ptime_range
, report
.range_size
,
1359 session
->evlist
->first_sample_time
,
1360 session
->evlist
->last_sample_time
);
1362 if (report
.range_num
< 0) {
1363 pr_err("Invalid time string\n");
1368 report
.range_num
= 1;
1371 if (session
->tevent
.pevent
&&
1372 tep_set_function_resolver(session
->tevent
.pevent
,
1373 machine__resolve_kernel_addr
,
1374 &session
->machines
.host
) < 0) {
1375 pr_err("%s: failed to set libtraceevent function resolver\n",
1380 sort__setup_elide(stdout
);
1382 ret
= __cmd_report(&report
);
1383 if (ret
== K_SWITCH_INPUT_DATA
) {
1384 perf_session__delete(session
);
1390 zfree(&report
.ptime_range
);
1392 perf_session__delete(session
);