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/string.h"
18 #include "util/callchain.h"
19 #include "util/strlist.h"
20 #include "util/values.h"
23 #include "util/debug.h"
24 #include "util/header.h"
25 #include "util/session.h"
27 #include "util/parse-options.h"
28 #include "util/parse-events.h"
30 #include "util/thread.h"
31 #include "util/sort.h"
32 #include "util/hist.h"
34 static char const *input_name
= "perf.data";
37 static bool hide_unresolved
;
38 static bool dont_use_callchains
;
40 static int show_threads
;
41 static struct perf_read_values show_threads_values
;
43 static char default_pretty_printing_style
[] = "normal";
44 static char *pretty_printing_style
= default_pretty_printing_style
;
46 static char callchain_default_opt
[] = "fractal,0.5";
48 static struct event_stat_id
*get_stats(struct perf_session
*self
,
49 u64 event_stream
, u32 type
, u64 config
)
51 struct rb_node
**p
= &self
->stats_by_id
.rb_node
;
52 struct rb_node
*parent
= NULL
;
53 struct event_stat_id
*iter
, *new;
57 iter
= rb_entry(parent
, struct event_stat_id
, rb_node
);
58 if (iter
->config
== config
)
62 if (config
> iter
->config
)
68 new = malloc(sizeof(struct event_stat_id
));
71 memset(new, 0, sizeof(struct event_stat_id
));
72 new->event_stream
= event_stream
;
75 rb_link_node(&new->rb_node
, parent
, p
);
76 rb_insert_color(&new->rb_node
, &self
->stats_by_id
);
80 static int perf_session__add_hist_entry(struct perf_session
*self
,
81 struct addr_location
*al
,
82 struct sample_data
*data
)
84 struct symbol
**syms
= NULL
, *parent
= NULL
;
86 struct hist_entry
*he
;
87 struct event_stat_id
*stats
;
88 struct perf_event_attr
*attr
;
90 if ((sort__has_parent
|| symbol_conf
.use_callchain
) && data
->callchain
)
91 syms
= perf_session__resolve_callchain(self
, al
->thread
,
92 data
->callchain
, &parent
);
94 attr
= perf_header__find_attr(data
->id
, &self
->header
);
96 stats
= get_stats(self
, data
->id
, attr
->type
, attr
->config
);
98 stats
= get_stats(self
, data
->id
, 0, 0);
101 he
= __perf_session__add_hist_entry(&stats
->hists
, al
, parent
,
107 he
->count
+= data
->period
;
109 if (symbol_conf
.use_callchain
) {
111 callchain_init(&he
->callchain
);
112 append_chain(&he
->callchain
, data
->callchain
, syms
);
119 static int validate_chain(struct ip_callchain
*chain
, event_t
*event
)
121 unsigned int chain_size
;
123 chain_size
= event
->header
.size
;
124 chain_size
-= (unsigned long)&event
->ip
.__more_data
- (unsigned long)event
;
126 if (chain
->nr
*sizeof(u64
) > chain_size
)
132 static int add_event_total(struct perf_session
*session
,
133 struct sample_data
*data
,
134 struct perf_event_attr
*attr
)
136 struct event_stat_id
*stats
;
139 stats
= get_stats(session
, data
->id
, attr
->type
, attr
->config
);
141 stats
= get_stats(session
, data
->id
, 0, 0);
146 stats
->stats
.total
+= data
->period
;
147 session
->events_stats
.total
+= data
->period
;
151 static int process_sample_event(event_t
*event
, struct perf_session
*session
)
153 struct sample_data data
= { .period
= 1, };
154 struct addr_location al
;
155 struct perf_event_attr
*attr
;
157 event__parse_sample(event
, session
->sample_type
, &data
);
159 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event
->header
.misc
,
160 data
.pid
, data
.tid
, data
.ip
, data
.period
);
162 if (session
->sample_type
& PERF_SAMPLE_CALLCHAIN
) {
165 dump_printf("... chain: nr:%Lu\n", data
.callchain
->nr
);
167 if (validate_chain(data
.callchain
, event
) < 0) {
168 pr_debug("call-chain problem with event, "
174 for (i
= 0; i
< data
.callchain
->nr
; i
++)
175 dump_printf("..... %2d: %016Lx\n",
176 i
, data
.callchain
->ips
[i
]);
180 if (event__preprocess_sample(event
, session
, &al
, NULL
) < 0) {
181 fprintf(stderr
, "problem processing %d event, skipping it.\n",
186 if (al
.filtered
|| (hide_unresolved
&& al
.sym
== NULL
))
189 if (perf_session__add_hist_entry(session
, &al
, &data
)) {
190 pr_debug("problem incrementing symbol count, skipping event\n");
194 attr
= perf_header__find_attr(data
.id
, &session
->header
);
196 if (add_event_total(session
, &data
, attr
)) {
197 pr_debug("problem adding event count\n");
204 static int process_read_event(event_t
*event
, struct perf_session
*session __used
)
206 struct perf_event_attr
*attr
;
208 attr
= perf_header__find_attr(event
->read
.id
, &session
->header
);
211 const char *name
= attr
? __event_name(attr
->type
, attr
->config
)
213 perf_read_values_add_value(&show_threads_values
,
214 event
->read
.pid
, event
->read
.tid
,
220 dump_printf(": %d %d %s %Lu\n", event
->read
.pid
, event
->read
.tid
,
221 attr
? __event_name(attr
->type
, attr
->config
) : "FAIL",
227 static int perf_session__setup_sample_type(struct perf_session
*self
)
229 if (!(self
->sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
230 if (sort__has_parent
) {
231 fprintf(stderr
, "selected --sort parent, but no"
232 " callchain data. Did you call"
233 " perf record without -g?\n");
236 if (symbol_conf
.use_callchain
) {
237 fprintf(stderr
, "selected -g but no callchain data."
238 " Did you call perf record without"
242 } else if (!dont_use_callchains
&& callchain_param
.mode
!= CHAIN_NONE
&&
243 !symbol_conf
.use_callchain
) {
244 symbol_conf
.use_callchain
= true;
245 if (register_callchain_param(&callchain_param
) < 0) {
246 fprintf(stderr
, "Can't register callchain"
255 static struct perf_event_ops event_ops
= {
256 .sample
= process_sample_event
,
257 .mmap
= event__process_mmap
,
258 .comm
= event__process_comm
,
259 .exit
= event__process_task
,
260 .fork
= event__process_task
,
261 .lost
= event__process_lost
,
262 .read
= process_read_event
,
265 static int __cmd_report(void)
268 struct perf_session
*session
;
269 struct rb_node
*next
;
271 session
= perf_session__new(input_name
, O_RDONLY
, force
);
276 perf_read_values_init(&show_threads_values
);
278 ret
= perf_session__setup_sample_type(session
);
282 ret
= perf_session__process_events(session
, &event_ops
);
287 event__print_totals();
292 perf_session__fprintf(session
, stdout
);
295 dsos__fprintf(stdout
);
297 next
= rb_first(&session
->stats_by_id
);
299 struct event_stat_id
*stats
;
301 stats
= rb_entry(next
, struct event_stat_id
, rb_node
);
302 perf_session__collapse_resort(&stats
->hists
);
303 perf_session__output_resort(&stats
->hists
, stats
->stats
.total
);
304 if (rb_first(&session
->stats_by_id
) ==
305 rb_last(&session
->stats_by_id
))
306 fprintf(stdout
, "# Samples: %Ld\n#\n",
309 fprintf(stdout
, "# Samples: %Ld %s\n#\n",
311 __event_name(stats
->type
, stats
->config
));
313 perf_session__fprintf_hists(&stats
->hists
, NULL
, false, stdout
,
315 fprintf(stdout
, "\n\n");
316 next
= rb_next(&stats
->rb_node
);
319 if (sort_order
== default_sort_order
&&
320 parent_pattern
== default_parent_pattern
)
321 fprintf(stdout
, "#\n# (For a higher level overview, try: perf report --sort comm,dso)\n#\n");
324 bool raw_printing_style
= !strcmp(pretty_printing_style
, "raw");
325 perf_read_values_display(stdout
, &show_threads_values
,
327 perf_read_values_destroy(&show_threads_values
);
330 perf_session__delete(session
);
335 parse_callchain_opt(const struct option
*opt __used
, const char *arg
,
345 dont_use_callchains
= true;
349 symbol_conf
.use_callchain
= true;
354 tok
= strtok((char *)arg
, ",");
358 /* get the output mode */
359 if (!strncmp(tok
, "graph", strlen(arg
)))
360 callchain_param
.mode
= CHAIN_GRAPH_ABS
;
362 else if (!strncmp(tok
, "flat", strlen(arg
)))
363 callchain_param
.mode
= CHAIN_FLAT
;
365 else if (!strncmp(tok
, "fractal", strlen(arg
)))
366 callchain_param
.mode
= CHAIN_GRAPH_REL
;
368 else if (!strncmp(tok
, "none", strlen(arg
))) {
369 callchain_param
.mode
= CHAIN_NONE
;
370 symbol_conf
.use_callchain
= false;
378 /* get the min percentage */
379 tok
= strtok(NULL
, ",");
383 callchain_param
.min_percent
= strtod(tok
, &endptr
);
388 if (register_callchain_param(&callchain_param
) < 0) {
389 fprintf(stderr
, "Can't register callchain params\n");
395 static const char * const report_usage
[] = {
396 "perf report [<options>] <command>",
400 static const struct option options
[] = {
401 OPT_STRING('i', "input", &input_name
, "file",
403 OPT_BOOLEAN('v', "verbose", &verbose
,
404 "be more verbose (show symbol address, etc)"),
405 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
406 "dump raw trace in ASCII"),
407 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
408 "file", "vmlinux pathname"),
409 OPT_BOOLEAN('f', "force", &force
, "don't complain, do it"),
410 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
411 "load module symbols - WARNING: use only with -k and LIVE kernel"),
412 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
413 "Show a column with the number of samples"),
414 OPT_BOOLEAN('T', "threads", &show_threads
,
415 "Show per-thread event counters"),
416 OPT_STRING(0, "pretty", &pretty_printing_style
, "key",
417 "pretty printing style key: normal raw"),
418 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
419 "sort by key(s): pid, comm, dso, symbol, parent"),
420 OPT_BOOLEAN('P', "full-paths", &symbol_conf
.full_paths
,
421 "Don't shorten the pathnames taking into account the cwd"),
422 OPT_STRING('p', "parent", &parent_pattern
, "regex",
423 "regex filter to identify parent, see: '--sort parent'"),
424 OPT_BOOLEAN('x', "exclude-other", &symbol_conf
.exclude_other
,
425 "Only display entries with parent-match"),
426 OPT_CALLBACK_DEFAULT('g', "call-graph", NULL
, "output_type,min_percent",
427 "Display callchains using output_type and min percent threshold. "
428 "Default: fractal,0.5", &parse_callchain_opt
, callchain_default_opt
),
429 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
430 "only consider symbols in these dsos"),
431 OPT_STRING('C', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
432 "only consider symbols in these comms"),
433 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
434 "only consider these symbols"),
435 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
437 "don't try to adjust column width, use these fixed values"),
438 OPT_STRING('t', "field-separator", &symbol_conf
.field_sep
, "separator",
439 "separator for columns, no spaces will be added between "
440 "columns '.' is reserved."),
441 OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved
,
442 "Only display entries resolved to a symbol"),
446 int cmd_report(int argc
, const char **argv
, const char *prefix __used
)
448 argc
= parse_options(argc
, argv
, options
, report_usage
, 0);
452 if (symbol__init() < 0)
455 setup_sorting(report_usage
, options
);
457 if (parent_pattern
!= default_parent_pattern
) {
458 sort_dimension__add("parent");
459 sort_parent
.elide
= 1;
461 symbol_conf
.exclude_other
= false;
464 * Any (unrecognized) arguments left?
467 usage_with_options(report_usage
, options
);
469 sort_entry__setup_elide(&sort_dso
, symbol_conf
.dso_list
, "dso", stdout
);
470 sort_entry__setup_elide(&sort_comm
, symbol_conf
.comm_list
, "comm", stdout
);
471 sort_entry__setup_elide(&sort_sym
, symbol_conf
.sym_list
, "symbol", stdout
);
473 return __cmd_report();