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);
114 if (symbol_conf.use_callchain) {
116 callchain_init(he->callchain);
117 err = append_chain(he->callchain, data->callchain, syms);
124 static int add_event_total(struct perf_session *session,
125 struct sample_data *data,
126 struct perf_event_attr *attr)
128 struct event_stat_id *stats;
131 stats = get_stats(session, data->id, attr->type, attr->config);
133 stats = get_stats(session, data->id, 0, 0);
138 stats->stats.total += data->period;
139 session->events_stats.total += data->period;
143 static int process_sample_event(event_t *event, struct perf_session *session)
145 struct sample_data data = { .period = 1, };
146 struct addr_location al;
147 struct perf_event_attr *attr;
149 event__parse_sample(event, session->sample_type, &data);
151 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
152 data.pid, data.tid, data.ip, data.period);
154 if (session->sample_type & PERF_SAMPLE_CALLCHAIN) {
157 dump_printf("... chain: nr:%Lu\n", data.callchain->nr);
159 if (!ip_callchain__valid(data.callchain, event)) {
160 pr_debug("call-chain problem with event, "
166 for (i = 0; i < data.callchain->nr; i++)
167 dump_printf("..... %2d: %016Lx\n",
168 i, data.callchain->ips[i]);
172 if (event__preprocess_sample(event, session, &al, NULL) < 0) {
173 fprintf(stderr, "problem processing %d event, skipping it.\n",
178 if (al.filtered || (hide_unresolved && al.sym == NULL))
181 if (perf_session__add_hist_entry(session, &al, &data)) {
182 pr_debug("problem incrementing symbol count, skipping event\n");
186 attr = perf_header__find_attr(data.id, &session->header);
188 if (add_event_total(session, &data, attr)) {
189 pr_debug("problem adding event count\n");
196 static int process_read_event(event_t *event, struct perf_session *session __used)
198 struct perf_event_attr *attr;
200 attr = perf_header__find_attr(event->read.id, &session->header);
203 const char *name = attr ? __event_name(attr->type, attr->config)
205 perf_read_values_add_value(&show_threads_values,
206 event->read.pid, event->read.tid,
212 dump_printf(": %d %d %s %Lu\n", event->read.pid, event->read.tid,
213 attr ? __event_name(attr->type, attr->config) : "FAIL",
219 static int perf_session__setup_sample_type(struct perf_session *self)
221 if (!(self->sample_type & PERF_SAMPLE_CALLCHAIN)) {
222 if (sort__has_parent) {
223 fprintf(stderr, "selected --sort parent, but no"
224 " callchain data. Did you call"
225 " perf record without -g?\n");
228 if (symbol_conf.use_callchain) {
229 fprintf(stderr, "selected -g but no callchain data."
230 " Did you call perf record without"
234 } else if (!dont_use_callchains && callchain_param.mode != CHAIN_NONE &&
235 !symbol_conf.use_callchain) {
236 symbol_conf.use_callchain = true;
237 if (register_callchain_param(&callchain_param) < 0) {
238 fprintf(stderr, "Can't register callchain"
247 static struct perf_event_ops event_ops = {
248 .sample = process_sample_event,
249 .mmap = event__process_mmap,
250 .comm = event__process_comm,
251 .exit = event__process_task,
252 .fork = event__process_task,
253 .lost = event__process_lost,
254 .read = process_read_event,
255 .attr = event__process_attr,
256 .event_type = event__process_event_type,
257 .tracing_data = event__process_tracing_data,
258 .build_id = event__process_build_id,
261 extern volatile int session_done;
263 static void sig_handler(int sig __attribute__((__unused__)))
268 static int __cmd_report(void)
271 struct perf_session *session;
272 struct rb_node *next;
273 const char *help = "For a higher level overview, try: perf report --sort comm,dso";
275 signal(SIGINT, sig_handler);
277 session = perf_session__new(input_name, O_RDONLY, force, false);
282 perf_read_values_init(&show_threads_values);
284 ret = perf_session__setup_sample_type(session);
288 ret = perf_session__process_events(session, &event_ops);
293 event__print_totals();
298 perf_session__fprintf(session, stdout);
301 perf_session__fprintf_dsos(session, stdout);
303 next = rb_first(&session->stats_by_id);
305 struct event_stat_id *stats;
308 stats = rb_entry(next, struct event_stat_id, rb_node);
309 perf_session__collapse_resort(&stats->hists);
310 nr_hists = perf_session__output_resort(&stats->hists,
313 perf_session__browse_hists(&stats->hists, nr_hists,
314 stats->stats.total, help,
317 if (rb_first(&session->stats_by_id) ==
318 rb_last(&session->stats_by_id))
319 fprintf(stdout, "# Samples: %Ld\n#\n",
322 fprintf(stdout, "# Samples: %Ld %s\n#\n",
324 __event_name(stats->type, stats->config));
326 perf_session__fprintf_hists(&stats->hists, NULL, false, stdout,
328 fprintf(stdout, "\n\n");
331 next = rb_next(&stats->rb_node);
334 if (!use_browser && sort_order == default_sort_order &&
335 parent_pattern == default_parent_pattern) {
336 fprintf(stdout, "#\n# (%s)\n#\n", help);
339 bool style = !strcmp(pretty_printing_style, "raw");
340 perf_read_values_display(stdout, &show_threads_values,
342 perf_read_values_destroy(&show_threads_values);
346 perf_session__delete(session);
351 parse_callchain_opt(const struct option *opt __used, const char *arg,
361 dont_use_callchains = true;
365 symbol_conf.use_callchain = true;
370 tok = strtok((char *)arg, ",");
374 /* get the output mode */
375 if (!strncmp(tok, "graph", strlen(arg)))
376 callchain_param.mode = CHAIN_GRAPH_ABS;
378 else if (!strncmp(tok, "flat", strlen(arg)))
379 callchain_param.mode = CHAIN_FLAT;
381 else if (!strncmp(tok, "fractal", strlen(arg)))
382 callchain_param.mode = CHAIN_GRAPH_REL;
384 else if (!strncmp(tok, "none", strlen(arg))) {
385 callchain_param.mode = CHAIN_NONE;
386 symbol_conf.use_callchain = false;
394 /* get the min percentage */
395 tok = strtok(NULL, ",");
399 callchain_param.min_percent = strtod(tok, &endptr);
404 if (register_callchain_param(&callchain_param) < 0) {
405 fprintf(stderr, "Can't register callchain params\n");
411 static const char * const report_usage[] = {
412 "perf report [<options>] <command>",
416 static const struct option options[] = {
417 OPT_STRING('i', "input", &input_name, "file",
419 OPT_INCR('v', "verbose", &verbose,
420 "be more verbose (show symbol address, etc)"),
421 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
422 "dump raw trace in ASCII"),
423 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
424 "file", "vmlinux pathname"),
425 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
426 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
427 "load module symbols - WARNING: use only with -k and LIVE kernel"),
428 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
429 "Show a column with the number of samples"),
430 OPT_BOOLEAN('T', "threads", &show_threads,
431 "Show per-thread event counters"),
432 OPT_STRING(0, "pretty", &pretty_printing_style, "key",
433 "pretty printing style key: normal raw"),
434 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
435 "sort by key(s): pid, comm, dso, symbol, parent"),
436 OPT_BOOLEAN('P', "full-paths", &symbol_conf.full_paths,
437 "Don't shorten the pathnames taking into account the cwd"),
438 OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
439 "Show sample percentage for different cpu modes"),
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 (graph, flat, fractal, or none) 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);
468 if (strcmp(input_name, "-") != 0)
471 if (symbol__init() < 0)
474 setup_sorting(report_usage, options);
476 if (parent_pattern != default_parent_pattern) {
477 if (sort_dimension__add("parent") < 0)
479 sort_parent.elide = 1;
481 symbol_conf.exclude_other = false;
484 * Any (unrecognized) arguments left?
487 usage_with_options(report_usage, options);
489 sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
490 sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
491 sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
493 return __cmd_report();