4 * Builtin report command: Analyze the perf.data input file,
5 * look up and read DSOs and symbol information and display
6 * a histogram of results, along various sorting keys.
10 #include "util/util.h"
12 #include "util/color.h"
13 #include <linux/list.h>
14 #include "util/cache.h"
15 #include <linux/rbtree.h>
16 #include "util/symbol.h"
17 #include "util/callchain.h"
18 #include "util/strlist.h"
19 #include "util/values.h"
22 #include "util/debug.h"
23 #include "util/header.h"
24 #include "util/session.h"
26 #include "util/parse-options.h"
27 #include "util/parse-events.h"
29 #include "util/thread.h"
30 #include "util/sort.h"
31 #include "util/hist.h"
33 static char const *input_name
= "perf.data";
36 static bool hide_unresolved
;
37 static bool dont_use_callchains
;
39 static bool show_threads
;
40 static struct perf_read_values show_threads_values
;
42 static char default_pretty_printing_style
[] = "normal";
43 static char *pretty_printing_style
= default_pretty_printing_style
;
45 static char callchain_default_opt
[] = "fractal,0.5";
47 static struct event_stat_id
*get_stats(struct perf_session
*self
,
48 u64 event_stream
, u32 type
, u64 config
)
50 struct rb_node
**p
= &self
->stats_by_id
.rb_node
;
51 struct rb_node
*parent
= NULL
;
52 struct event_stat_id
*iter
, *new;
56 iter
= rb_entry(parent
, struct event_stat_id
, rb_node
);
57 if (iter
->config
== config
)
61 if (config
> iter
->config
)
67 new = malloc(sizeof(struct event_stat_id
));
70 memset(new, 0, sizeof(struct event_stat_id
));
71 new->event_stream
= event_stream
;
74 rb_link_node(&new->rb_node
, parent
, p
);
75 rb_insert_color(&new->rb_node
, &self
->stats_by_id
);
79 static int perf_session__add_hist_entry(struct perf_session
*self
,
80 struct addr_location
*al
,
81 struct sample_data
*data
)
83 struct map_symbol
*syms
= NULL
;
84 struct symbol
*parent
= NULL
;
87 struct hist_entry
*he
;
88 struct event_stat_id
*stats
;
89 struct perf_event_attr
*attr
;
91 if ((sort__has_parent
|| symbol_conf
.use_callchain
) && data
->callchain
) {
92 syms
= perf_session__resolve_callchain(self
, al
->thread
,
93 data
->callchain
, &parent
);
98 attr
= perf_header__find_attr(data
->id
, &self
->header
);
100 stats
= get_stats(self
, data
->id
, attr
->type
, attr
->config
);
102 stats
= get_stats(self
, data
->id
, 0, 0);
105 he
= __perf_session__add_hist_entry(&stats
->hists
, al
, parent
,
111 __perf_session__add_count(he
, al
, data
->period
);
113 if (symbol_conf
.use_callchain
) {
115 callchain_init(he
->callchain
);
116 err
= append_chain(he
->callchain
, data
->callchain
, syms
);
126 static int validate_chain(struct ip_callchain
*chain
, event_t
*event
)
128 unsigned int chain_size
;
130 chain_size
= event
->header
.size
;
131 chain_size
-= (unsigned long)&event
->ip
.__more_data
- (unsigned long)event
;
133 if (chain
->nr
*sizeof(u64
) > chain_size
)
139 static int add_event_total(struct perf_session
*session
,
140 struct sample_data
*data
,
141 struct perf_event_attr
*attr
)
143 struct event_stat_id
*stats
;
146 stats
= get_stats(session
, data
->id
, attr
->type
, attr
->config
);
148 stats
= get_stats(session
, data
->id
, 0, 0);
153 stats
->stats
.total
+= data
->period
;
154 session
->events_stats
.total
+= data
->period
;
158 static int process_sample_event(event_t
*event
, struct perf_session
*session
)
160 struct sample_data data
= { .period
= 1, };
161 struct addr_location al
;
162 struct perf_event_attr
*attr
;
164 event__parse_sample(event
, session
->sample_type
, &data
);
166 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event
->header
.misc
,
167 data
.pid
, data
.tid
, data
.ip
, data
.period
);
169 if (session
->sample_type
& PERF_SAMPLE_CALLCHAIN
) {
172 dump_printf("... chain: nr:%Lu\n", data
.callchain
->nr
);
174 if (validate_chain(data
.callchain
, event
) < 0) {
175 pr_debug("call-chain problem with event, "
181 for (i
= 0; i
< data
.callchain
->nr
; i
++)
182 dump_printf("..... %2d: %016Lx\n",
183 i
, data
.callchain
->ips
[i
]);
187 if (event__preprocess_sample(event
, session
, &al
, NULL
) < 0) {
188 fprintf(stderr
, "problem processing %d event, skipping it.\n",
193 if (al
.filtered
|| (hide_unresolved
&& al
.sym
== NULL
))
196 if (perf_session__add_hist_entry(session
, &al
, &data
)) {
197 pr_debug("problem incrementing symbol count, skipping event\n");
201 attr
= perf_header__find_attr(data
.id
, &session
->header
);
203 if (add_event_total(session
, &data
, attr
)) {
204 pr_debug("problem adding event count\n");
211 static int process_read_event(event_t
*event
, struct perf_session
*session __used
)
213 struct perf_event_attr
*attr
;
215 attr
= perf_header__find_attr(event
->read
.id
, &session
->header
);
218 const char *name
= attr
? __event_name(attr
->type
, attr
->config
)
220 perf_read_values_add_value(&show_threads_values
,
221 event
->read
.pid
, event
->read
.tid
,
227 dump_printf(": %d %d %s %Lu\n", event
->read
.pid
, event
->read
.tid
,
228 attr
? __event_name(attr
->type
, attr
->config
) : "FAIL",
234 static int perf_session__setup_sample_type(struct perf_session
*self
)
236 if (!(self
->sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
237 if (sort__has_parent
) {
238 fprintf(stderr
, "selected --sort parent, but no"
239 " callchain data. Did you call"
240 " perf record without -g?\n");
243 if (symbol_conf
.use_callchain
) {
244 fprintf(stderr
, "selected -g but no callchain data."
245 " Did you call perf record without"
249 } else if (!dont_use_callchains
&& callchain_param
.mode
!= CHAIN_NONE
&&
250 !symbol_conf
.use_callchain
) {
251 symbol_conf
.use_callchain
= true;
252 if (register_callchain_param(&callchain_param
) < 0) {
253 fprintf(stderr
, "Can't register callchain"
262 static struct perf_event_ops event_ops
= {
263 .sample
= process_sample_event
,
264 .mmap
= event__process_mmap
,
265 .comm
= event__process_comm
,
266 .exit
= event__process_task
,
267 .fork
= event__process_task
,
268 .lost
= event__process_lost
,
269 .read
= process_read_event
,
270 .attr
= event__process_attr
,
271 .event_type
= event__process_event_type
,
272 .tracing_data
= event__process_tracing_data
,
273 .build_id
= event__process_build_id
,
276 extern volatile int session_done
;
278 static void sig_handler(int sig
__attribute__((__unused__
)))
283 static int __cmd_report(void)
286 struct perf_session
*session
;
287 struct rb_node
*next
;
288 const char *help
= "For a higher level overview, try: perf report --sort comm,dso";
290 signal(SIGINT
, sig_handler
);
292 session
= perf_session__new(input_name
, O_RDONLY
, force
, false);
297 perf_read_values_init(&show_threads_values
);
299 ret
= perf_session__setup_sample_type(session
);
303 ret
= perf_session__process_events(session
, &event_ops
);
308 event__print_totals();
313 perf_session__fprintf(session
, stdout
);
316 perf_session__fprintf_dsos(session
, stdout
);
318 next
= rb_first(&session
->stats_by_id
);
320 struct event_stat_id
*stats
;
323 stats
= rb_entry(next
, struct event_stat_id
, rb_node
);
324 perf_session__collapse_resort(&stats
->hists
);
325 nr_hists
= perf_session__output_resort(&stats
->hists
,
328 perf_session__browse_hists(&stats
->hists
, nr_hists
,
329 stats
->stats
.total
, help
,
332 if (rb_first(&session
->stats_by_id
) ==
333 rb_last(&session
->stats_by_id
))
334 fprintf(stdout
, "# Samples: %Ld\n#\n",
337 fprintf(stdout
, "# Samples: %Ld %s\n#\n",
339 __event_name(stats
->type
, stats
->config
));
341 perf_session__fprintf_hists(&stats
->hists
, NULL
, false, stdout
,
343 fprintf(stdout
, "\n\n");
346 next
= rb_next(&stats
->rb_node
);
349 if (!use_browser
&& sort_order
== default_sort_order
&&
350 parent_pattern
== default_parent_pattern
) {
351 fprintf(stdout
, "#\n# (%s)\n#\n", help
);
354 bool style
= !strcmp(pretty_printing_style
, "raw");
355 perf_read_values_display(stdout
, &show_threads_values
,
357 perf_read_values_destroy(&show_threads_values
);
361 perf_session__delete(session
);
366 parse_callchain_opt(const struct option
*opt __used
, const char *arg
,
376 dont_use_callchains
= true;
380 symbol_conf
.use_callchain
= true;
385 tok
= strtok((char *)arg
, ",");
389 /* get the output mode */
390 if (!strncmp(tok
, "graph", strlen(arg
)))
391 callchain_param
.mode
= CHAIN_GRAPH_ABS
;
393 else if (!strncmp(tok
, "flat", strlen(arg
)))
394 callchain_param
.mode
= CHAIN_FLAT
;
396 else if (!strncmp(tok
, "fractal", strlen(arg
)))
397 callchain_param
.mode
= CHAIN_GRAPH_REL
;
399 else if (!strncmp(tok
, "none", strlen(arg
))) {
400 callchain_param
.mode
= CHAIN_NONE
;
401 symbol_conf
.use_callchain
= false;
409 /* get the min percentage */
410 tok
= strtok(NULL
, ",");
414 callchain_param
.min_percent
= strtod(tok
, &endptr
);
419 if (register_callchain_param(&callchain_param
) < 0) {
420 fprintf(stderr
, "Can't register callchain params\n");
426 static const char * const report_usage
[] = {
427 "perf report [<options>] <command>",
431 static const struct option options
[] = {
432 OPT_STRING('i', "input", &input_name
, "file",
434 OPT_INCR('v', "verbose", &verbose
,
435 "be more verbose (show symbol address, etc)"),
436 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
437 "dump raw trace in ASCII"),
438 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
439 "file", "vmlinux pathname"),
440 OPT_BOOLEAN('f', "force", &force
, "don't complain, do it"),
441 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
442 "load module symbols - WARNING: use only with -k and LIVE kernel"),
443 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
444 "Show a column with the number of samples"),
445 OPT_BOOLEAN('T', "threads", &show_threads
,
446 "Show per-thread event counters"),
447 OPT_STRING(0, "pretty", &pretty_printing_style
, "key",
448 "pretty printing style key: normal raw"),
449 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
450 "sort by key(s): pid, comm, dso, symbol, parent"),
451 OPT_BOOLEAN('P', "full-paths", &symbol_conf
.full_paths
,
452 "Don't shorten the pathnames taking into account the cwd"),
453 OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf
.show_cpu_utilization
,
454 "Show sample percentage for different cpu modes"),
455 OPT_STRING('p', "parent", &parent_pattern
, "regex",
456 "regex filter to identify parent, see: '--sort parent'"),
457 OPT_BOOLEAN('x', "exclude-other", &symbol_conf
.exclude_other
,
458 "Only display entries with parent-match"),
459 OPT_CALLBACK_DEFAULT('g', "call-graph", NULL
, "output_type,min_percent",
460 "Display callchains using output_type (graph, flat, fractal, or none) and min percent threshold. "
461 "Default: fractal,0.5", &parse_callchain_opt
, callchain_default_opt
),
462 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
463 "only consider symbols in these dsos"),
464 OPT_STRING('C', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
465 "only consider symbols in these comms"),
466 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
467 "only consider these symbols"),
468 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
470 "don't try to adjust column width, use these fixed values"),
471 OPT_STRING('t', "field-separator", &symbol_conf
.field_sep
, "separator",
472 "separator for columns, no spaces will be added between "
473 "columns '.' is reserved."),
474 OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved
,
475 "Only display entries resolved to a symbol"),
479 int cmd_report(int argc
, const char **argv
, const char *prefix __used
)
481 argc
= parse_options(argc
, argv
, options
, report_usage
, 0);
483 if (strcmp(input_name
, "-") != 0)
486 if (symbol__init() < 0)
489 setup_sorting(report_usage
, options
);
491 if (parent_pattern
!= default_parent_pattern
) {
492 if (sort_dimension__add("parent") < 0)
494 sort_parent
.elide
= 1;
496 symbol_conf
.exclude_other
= false;
499 * Any (unrecognized) arguments left?
502 usage_with_options(report_usage
, options
);
504 sort_entry__setup_elide(&sort_dso
, symbol_conf
.dso_list
, "dso", stdout
);
505 sort_entry__setup_elide(&sort_comm
, symbol_conf
.comm_list
, "comm", stdout
);
506 sort_entry__setup_elide(&sort_sym
, symbol_conf
.sym_list
, "symbol", stdout
);
508 return __cmd_report();