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 hists
*perf_session__hists_findnew(struct perf_session
*self
,
48 u64 event_stream
, u32 type
,
51 struct rb_node
**p
= &self
->hists_tree
.rb_node
;
52 struct rb_node
*parent
= NULL
;
53 struct hists
*iter
, *new;
57 iter
= rb_entry(parent
, struct hists
, rb_node
);
58 if (iter
->config
== config
)
62 if (config
> iter
->config
)
68 new = malloc(sizeof(struct hists
));
71 memset(new, 0, sizeof(struct hists
));
72 new->event_stream
= event_stream
;
75 rb_link_node(&new->rb_node
, parent
, p
);
76 rb_insert_color(&new->rb_node
, &self
->hists_tree
);
80 static int perf_session__add_hist_entry(struct perf_session
*self
,
81 struct addr_location
*al
,
82 struct sample_data
*data
)
84 struct map_symbol
*syms
= NULL
;
85 struct symbol
*parent
= NULL
;
87 struct hist_entry
*he
;
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 hists
= perf_session__hists_findnew(self
, data
->id
, attr
->type
, attr
->config
);
102 hists
= perf_session__hists_findnew(self
, data
->id
, 0, 0);
105 he
= __hists__add_entry(hists
, al
, parent
, data
->period
);
109 if (symbol_conf
.use_callchain
)
110 err
= append_chain(he
->callchain
, data
->callchain
, syms
);
116 static int add_event_total(struct perf_session
*session
,
117 struct sample_data
*data
,
118 struct perf_event_attr
*attr
)
123 hists
= perf_session__hists_findnew(session
, data
->id
,
124 attr
->type
, attr
->config
);
126 hists
= perf_session__hists_findnew(session
, data
->id
, 0, 0);
131 hists
->stats
.total
+= data
->period
;
132 session
->hists
.stats
.total
+= data
->period
;
136 static int process_sample_event(event_t
*event
, struct perf_session
*session
)
138 struct sample_data data
= { .period
= 1, };
139 struct addr_location al
;
140 struct perf_event_attr
*attr
;
142 event__parse_sample(event
, session
->sample_type
, &data
);
144 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event
->header
.misc
,
145 data
.pid
, data
.tid
, data
.ip
, data
.period
);
147 if (session
->sample_type
& PERF_SAMPLE_CALLCHAIN
) {
150 dump_printf("... chain: nr:%Lu\n", data
.callchain
->nr
);
152 if (!ip_callchain__valid(data
.callchain
, event
)) {
153 pr_debug("call-chain problem with event, "
159 for (i
= 0; i
< data
.callchain
->nr
; i
++)
160 dump_printf("..... %2d: %016Lx\n",
161 i
, data
.callchain
->ips
[i
]);
165 if (event__preprocess_sample(event
, session
, &al
, NULL
) < 0) {
166 fprintf(stderr
, "problem processing %d event, skipping it.\n",
171 if (al
.filtered
|| (hide_unresolved
&& al
.sym
== NULL
))
174 if (perf_session__add_hist_entry(session
, &al
, &data
)) {
175 pr_debug("problem incrementing symbol count, skipping event\n");
179 attr
= perf_header__find_attr(data
.id
, &session
->header
);
181 if (add_event_total(session
, &data
, attr
)) {
182 pr_debug("problem adding event count\n");
189 static int process_read_event(event_t
*event
, struct perf_session
*session __used
)
191 struct perf_event_attr
*attr
;
193 attr
= perf_header__find_attr(event
->read
.id
, &session
->header
);
196 const char *name
= attr
? __event_name(attr
->type
, attr
->config
)
198 perf_read_values_add_value(&show_threads_values
,
199 event
->read
.pid
, event
->read
.tid
,
205 dump_printf(": %d %d %s %Lu\n", event
->read
.pid
, event
->read
.tid
,
206 attr
? __event_name(attr
->type
, attr
->config
) : "FAIL",
212 static int perf_session__setup_sample_type(struct perf_session
*self
)
214 if (!(self
->sample_type
& PERF_SAMPLE_CALLCHAIN
)) {
215 if (sort__has_parent
) {
216 fprintf(stderr
, "selected --sort parent, but no"
217 " callchain data. Did you call"
218 " perf record without -g?\n");
221 if (symbol_conf
.use_callchain
) {
222 fprintf(stderr
, "selected -g but no callchain data."
223 " Did you call perf record without"
227 } else if (!dont_use_callchains
&& callchain_param
.mode
!= CHAIN_NONE
&&
228 !symbol_conf
.use_callchain
) {
229 symbol_conf
.use_callchain
= true;
230 if (register_callchain_param(&callchain_param
) < 0) {
231 fprintf(stderr
, "Can't register callchain"
240 static struct perf_event_ops event_ops
= {
241 .sample
= process_sample_event
,
242 .mmap
= event__process_mmap
,
243 .comm
= event__process_comm
,
244 .exit
= event__process_task
,
245 .fork
= event__process_task
,
246 .lost
= event__process_lost
,
247 .read
= process_read_event
,
248 .attr
= event__process_attr
,
249 .event_type
= event__process_event_type
,
250 .tracing_data
= event__process_tracing_data
,
251 .build_id
= event__process_build_id
,
254 extern volatile int session_done
;
256 static void sig_handler(int sig
__attribute__((__unused__
)))
261 static int __cmd_report(void)
264 struct perf_session
*session
;
265 struct rb_node
*next
;
266 const char *help
= "For a higher level overview, try: perf report --sort comm,dso";
268 signal(SIGINT
, sig_handler
);
270 session
= perf_session__new(input_name
, O_RDONLY
, force
, false);
275 perf_read_values_init(&show_threads_values
);
277 ret
= perf_session__setup_sample_type(session
);
281 ret
= perf_session__process_events(session
, &event_ops
);
286 event__print_totals();
291 perf_session__fprintf(session
, stdout
);
294 perf_session__fprintf_dsos(session
, stdout
);
296 next
= rb_first(&session
->hists_tree
);
301 hists
= rb_entry(next
, struct hists
, rb_node
);
302 hists__collapse_resort(hists
);
303 nr_hists
= hists__output_resort(hists
);
305 perf_session__browse_hists(&hists
->entries
, nr_hists
,
306 hists
->stats
.total
, help
,
309 if (rb_first(&session
->hists
.entries
) ==
310 rb_last(&session
->hists
.entries
))
311 fprintf(stdout
, "# Samples: %Ld\n#\n",
314 fprintf(stdout
, "# Samples: %Ld %s\n#\n",
316 __event_name(hists
->type
, hists
->config
));
318 hists__fprintf(hists
, NULL
, false, stdout
);
319 fprintf(stdout
, "\n\n");
322 next
= rb_next(&hists
->rb_node
);
325 if (!use_browser
&& sort_order
== default_sort_order
&&
326 parent_pattern
== default_parent_pattern
) {
327 fprintf(stdout
, "#\n# (%s)\n#\n", help
);
330 bool style
= !strcmp(pretty_printing_style
, "raw");
331 perf_read_values_display(stdout
, &show_threads_values
,
333 perf_read_values_destroy(&show_threads_values
);
337 perf_session__delete(session
);
342 parse_callchain_opt(const struct option
*opt __used
, const char *arg
,
352 dont_use_callchains
= true;
356 symbol_conf
.use_callchain
= true;
361 tok
= strtok((char *)arg
, ",");
365 /* get the output mode */
366 if (!strncmp(tok
, "graph", strlen(arg
)))
367 callchain_param
.mode
= CHAIN_GRAPH_ABS
;
369 else if (!strncmp(tok
, "flat", strlen(arg
)))
370 callchain_param
.mode
= CHAIN_FLAT
;
372 else if (!strncmp(tok
, "fractal", strlen(arg
)))
373 callchain_param
.mode
= CHAIN_GRAPH_REL
;
375 else if (!strncmp(tok
, "none", strlen(arg
))) {
376 callchain_param
.mode
= CHAIN_NONE
;
377 symbol_conf
.use_callchain
= false;
385 /* get the min percentage */
386 tok
= strtok(NULL
, ",");
390 tok2
= strtok(NULL
, ",");
391 callchain_param
.min_percent
= strtod(tok
, &endptr
);
396 callchain_param
.print_limit
= strtod(tok2
, &endptr
);
398 if (register_callchain_param(&callchain_param
) < 0) {
399 fprintf(stderr
, "Can't register callchain params\n");
405 static const char * const report_usage
[] = {
406 "perf report [<options>] <command>",
410 static const struct option options
[] = {
411 OPT_STRING('i', "input", &input_name
, "file",
413 OPT_INCR('v', "verbose", &verbose
,
414 "be more verbose (show symbol address, etc)"),
415 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
416 "dump raw trace in ASCII"),
417 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
418 "file", "vmlinux pathname"),
419 OPT_BOOLEAN('f', "force", &force
, "don't complain, do it"),
420 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
421 "load module symbols - WARNING: use only with -k and LIVE kernel"),
422 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
423 "Show a column with the number of samples"),
424 OPT_BOOLEAN('T', "threads", &show_threads
,
425 "Show per-thread event counters"),
426 OPT_STRING(0, "pretty", &pretty_printing_style
, "key",
427 "pretty printing style key: normal raw"),
428 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
429 "sort by key(s): pid, comm, dso, symbol, parent"),
430 OPT_BOOLEAN('P', "full-paths", &symbol_conf
.full_paths
,
431 "Don't shorten the pathnames taking into account the cwd"),
432 OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf
.show_cpu_utilization
,
433 "Show sample percentage for different cpu modes"),
434 OPT_STRING('p', "parent", &parent_pattern
, "regex",
435 "regex filter to identify parent, see: '--sort parent'"),
436 OPT_BOOLEAN('x', "exclude-other", &symbol_conf
.exclude_other
,
437 "Only display entries with parent-match"),
438 OPT_CALLBACK_DEFAULT('g', "call-graph", NULL
, "output_type,min_percent",
439 "Display callchains using output_type (graph, flat, fractal, or none) and min percent threshold. "
440 "Default: fractal,0.5", &parse_callchain_opt
, callchain_default_opt
),
441 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
442 "only consider symbols in these dsos"),
443 OPT_STRING('C', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
444 "only consider symbols in these comms"),
445 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
446 "only consider these symbols"),
447 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
449 "don't try to adjust column width, use these fixed values"),
450 OPT_STRING('t', "field-separator", &symbol_conf
.field_sep
, "separator",
451 "separator for columns, no spaces will be added between "
452 "columns '.' is reserved."),
453 OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved
,
454 "Only display entries resolved to a symbol"),
458 int cmd_report(int argc
, const char **argv
, const char *prefix __used
)
460 argc
= parse_options(argc
, argv
, options
, report_usage
, 0);
462 if (strcmp(input_name
, "-") != 0)
465 if (symbol__init() < 0)
468 setup_sorting(report_usage
, options
);
470 if (parent_pattern
!= default_parent_pattern
) {
471 if (sort_dimension__add("parent") < 0)
473 sort_parent
.elide
= 1;
475 symbol_conf
.exclude_other
= false;
478 * Any (unrecognized) arguments left?
481 usage_with_options(report_usage
, options
);
483 sort_entry__setup_elide(&sort_dso
, symbol_conf
.dso_list
, "dso", stdout
);
484 sort_entry__setup_elide(&sort_comm
, symbol_conf
.comm_list
, "comm", stdout
);
485 sort_entry__setup_elide(&sort_sym
, symbol_conf
.sym_list
, "symbol", stdout
);
487 return __cmd_report();