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 map_symbol *syms = NULL;
85 struct symbol *parent = NULL;
88 struct hist_entry *he;
89 struct event_stat_id *stats;
90 struct perf_event_attr *attr;
92 if ((sort__has_parent || symbol_conf.use_callchain) && data->callchain) {
93 syms = perf_session__resolve_callchain(self, al->thread,
94 data->callchain, &parent);
99 attr = perf_header__find_attr(data->id, &self->header);
101 stats = get_stats(self, data->id, attr->type, attr->config);
103 stats = get_stats(self, data->id, 0, 0);
106 he = __perf_session__add_hist_entry(&stats->hists, al, parent,
112 he->count += data->period;
114 if (symbol_conf.use_callchain) {
116 callchain_init(he->callchain);
117 err = append_chain(he->callchain, data->callchain, syms);
127 static int validate_chain(struct ip_callchain *chain, event_t *event)
129 unsigned int chain_size;
131 chain_size = event->header.size;
132 chain_size -= (unsigned long)&event->ip.__more_data - (unsigned long)event;
134 if (chain->nr*sizeof(u64) > chain_size)
140 static int add_event_total(struct perf_session *session,
141 struct sample_data *data,
142 struct perf_event_attr *attr)
144 struct event_stat_id *stats;
147 stats = get_stats(session, data->id, attr->type, attr->config);
149 stats = get_stats(session, data->id, 0, 0);
154 stats->stats.total += data->period;
155 session->events_stats.total += data->period;
159 static int process_sample_event(event_t *event, struct perf_session *session)
161 struct sample_data data = { .period = 1, };
162 struct addr_location al;
163 struct perf_event_attr *attr;
165 event__parse_sample(event, session->sample_type, &data);
167 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
168 data.pid, data.tid, data.ip, data.period);
170 if (session->sample_type & PERF_SAMPLE_CALLCHAIN) {
173 dump_printf("... chain: nr:%Lu\n", data.callchain->nr);
175 if (validate_chain(data.callchain, event) < 0) {
176 pr_debug("call-chain problem with event, "
182 for (i = 0; i < data.callchain->nr; i++)
183 dump_printf("..... %2d: %016Lx\n",
184 i, data.callchain->ips[i]);
188 if (event__preprocess_sample(event, session, &al, NULL) < 0) {
189 fprintf(stderr, "problem processing %d event, skipping it.\n",
194 if (al.filtered || (hide_unresolved && al.sym == NULL))
197 if (perf_session__add_hist_entry(session, &al, &data)) {
198 pr_debug("problem incrementing symbol count, skipping event\n");
202 attr = perf_header__find_attr(data.id, &session->header);
204 if (add_event_total(session, &data, attr)) {
205 pr_debug("problem adding event count\n");
212 static int process_read_event(event_t *event, struct perf_session *session __used)
214 struct perf_event_attr *attr;
216 attr = perf_header__find_attr(event->read.id, &session->header);
219 const char *name = attr ? __event_name(attr->type, attr->config)
221 perf_read_values_add_value(&show_threads_values,
222 event->read.pid, event->read.tid,
228 dump_printf(": %d %d %s %Lu\n", event->read.pid, event->read.tid,
229 attr ? __event_name(attr->type, attr->config) : "FAIL",
235 static int perf_session__setup_sample_type(struct perf_session *self)
237 if (!(self->sample_type & PERF_SAMPLE_CALLCHAIN)) {
238 if (sort__has_parent) {
239 fprintf(stderr, "selected --sort parent, but no"
240 " callchain data. Did you call"
241 " perf record without -g?\n");
244 if (symbol_conf.use_callchain) {
245 fprintf(stderr, "selected -g but no callchain data."
246 " Did you call perf record without"
250 } else if (!dont_use_callchains && callchain_param.mode != CHAIN_NONE &&
251 !symbol_conf.use_callchain) {
252 symbol_conf.use_callchain = true;
253 if (register_callchain_param(&callchain_param) < 0) {
254 fprintf(stderr, "Can't register callchain"
263 static struct perf_event_ops event_ops = {
264 .sample = process_sample_event,
265 .mmap = event__process_mmap,
266 .comm = event__process_comm,
267 .exit = event__process_task,
268 .fork = event__process_task,
269 .lost = event__process_lost,
270 .read = process_read_event,
273 static int __cmd_report(void)
276 struct perf_session *session;
277 struct rb_node *next;
278 const char *help = "For a higher level overview, try: perf report --sort comm,dso";
280 session = perf_session__new(input_name, O_RDONLY, force);
285 perf_read_values_init(&show_threads_values);
287 ret = perf_session__setup_sample_type(session);
291 ret = perf_session__process_events(session, &event_ops);
296 event__print_totals();
301 perf_session__fprintf(session, stdout);
304 dsos__fprintf(stdout);
306 next = rb_first(&session->stats_by_id);
308 struct event_stat_id *stats;
311 stats = rb_entry(next, struct event_stat_id, rb_node);
312 perf_session__collapse_resort(&stats->hists);
313 nr_hists = perf_session__output_resort(&stats->hists,
316 perf_session__browse_hists(&stats->hists, nr_hists,
317 stats->stats.total, help);
319 if (rb_first(&session->stats_by_id) ==
320 rb_last(&session->stats_by_id))
321 fprintf(stdout, "# Samples: %Ld\n#\n",
324 fprintf(stdout, "# Samples: %Ld %s\n#\n",
326 __event_name(stats->type, stats->config));
328 perf_session__fprintf_hists(&stats->hists, NULL, false, stdout,
330 fprintf(stdout, "\n\n");
333 next = rb_next(&stats->rb_node);
336 if (!use_browser && sort_order == default_sort_order &&
337 parent_pattern == default_parent_pattern) {
338 fprintf(stdout, "#\n# (%s)\n#\n", help);
341 bool style = !strcmp(pretty_printing_style, "raw");
342 perf_read_values_display(stdout, &show_threads_values,
344 perf_read_values_destroy(&show_threads_values);
348 perf_session__delete(session);
353 parse_callchain_opt(const struct option *opt __used, const char *arg,
363 dont_use_callchains = true;
367 symbol_conf.use_callchain = true;
372 tok = strtok((char *)arg, ",");
376 /* get the output mode */
377 if (!strncmp(tok, "graph", strlen(arg)))
378 callchain_param.mode = CHAIN_GRAPH_ABS;
380 else if (!strncmp(tok, "flat", strlen(arg)))
381 callchain_param.mode = CHAIN_FLAT;
383 else if (!strncmp(tok, "fractal", strlen(arg)))
384 callchain_param.mode = CHAIN_GRAPH_REL;
386 else if (!strncmp(tok, "none", strlen(arg))) {
387 callchain_param.mode = CHAIN_NONE;
388 symbol_conf.use_callchain = false;
396 /* get the min percentage */
397 tok = strtok(NULL, ",");
401 callchain_param.min_percent = strtod(tok, &endptr);
406 if (register_callchain_param(&callchain_param) < 0) {
407 fprintf(stderr, "Can't register callchain params\n");
413 static const char * const report_usage[] = {
414 "perf report [<options>] <command>",
418 static const struct option options[] = {
419 OPT_STRING('i', "input", &input_name, "file",
421 OPT_BOOLEAN('v', "verbose", &verbose,
422 "be more verbose (show symbol address, etc)"),
423 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
424 "dump raw trace in ASCII"),
425 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
426 "file", "vmlinux pathname"),
427 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
428 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
429 "load module symbols - WARNING: use only with -k and LIVE kernel"),
430 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
431 "Show a column with the number of samples"),
432 OPT_BOOLEAN('T', "threads", &show_threads,
433 "Show per-thread event counters"),
434 OPT_STRING(0, "pretty", &pretty_printing_style, "key",
435 "pretty printing style key: normal raw"),
436 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
437 "sort by key(s): pid, comm, dso, symbol, parent"),
438 OPT_BOOLEAN('P', "full-paths", &symbol_conf.full_paths,
439 "Don't shorten the pathnames taking into account the cwd"),
440 OPT_STRING('p', "parent", &parent_pattern, "regex",
441 "regex filter to identify parent, see: '--sort parent'"),
442 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
443 "Only display entries with parent-match"),
444 OPT_CALLBACK_DEFAULT('g', "call-graph", NULL, "output_type,min_percent",
445 "Display callchains using output_type and min percent threshold. "
446 "Default: fractal,0.5", &parse_callchain_opt, callchain_default_opt),
447 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
448 "only consider symbols in these dsos"),
449 OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
450 "only consider symbols in these comms"),
451 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
452 "only consider these symbols"),
453 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
455 "don't try to adjust column width, use these fixed values"),
456 OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
457 "separator for columns, no spaces will be added between "
458 "columns '.' is reserved."),
459 OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved,
460 "Only display entries resolved to a symbol"),
464 int cmd_report(int argc, const char **argv, const char *prefix __used)
466 argc = parse_options(argc, argv, options, report_usage, 0);
470 if (symbol__init() < 0)
473 setup_sorting(report_usage, options);
475 if (parent_pattern != default_parent_pattern) {
476 sort_dimension__add("parent");
477 sort_parent.elide = 1;
479 symbol_conf.exclude_other = false;
482 * Any (unrecognized) arguments left?
485 usage_with_options(report_usage, options);
487 sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
488 sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
489 sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
491 return __cmd_report();