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";
36 static char *dso_list_str, *comm_list_str, *sym_list_str,
38 static struct strlist *dso_list, *comm_list, *sym_list;
41 static bool use_callchain;
43 static int show_nr_samples;
45 static int show_threads;
46 static struct perf_read_values show_threads_values;
48 static char default_pretty_printing_style[] = "normal";
49 static char *pretty_printing_style = default_pretty_printing_style;
51 static int exclude_other = 1;
53 static char callchain_default_opt[] = "fractal,0.5";
55 static u64 sample_type;
57 struct symbol_conf symbol_conf;
61 callchain__fprintf_left_margin(FILE *fp, int left_margin)
66 ret = fprintf(fp, " ");
68 for (i = 0; i < left_margin; i++)
69 ret += fprintf(fp, " ");
74 static size_t ipchain__fprintf_graph_line(FILE *fp, int depth, int depth_mask,
80 ret += callchain__fprintf_left_margin(fp, left_margin);
82 for (i = 0; i < depth; i++)
83 if (depth_mask & (1 << i))
84 ret += fprintf(fp, "| ");
86 ret += fprintf(fp, " ");
88 ret += fprintf(fp, "\n");
93 ipchain__fprintf_graph(FILE *fp, struct callchain_list *chain, int depth,
94 int depth_mask, int count, u64 total_samples,
95 int hits, int left_margin)
100 ret += callchain__fprintf_left_margin(fp, left_margin);
101 for (i = 0; i < depth; i++) {
102 if (depth_mask & (1 << i))
103 ret += fprintf(fp, "|");
105 ret += fprintf(fp, " ");
106 if (!count && i == depth - 1) {
109 percent = hits * 100.0 / total_samples;
110 ret += percent_color_fprintf(fp, "--%2.2f%%-- ", percent);
112 ret += fprintf(fp, "%s", " ");
115 ret += fprintf(fp, "%s\n", chain->sym->name);
117 ret += fprintf(fp, "%p\n", (void *)(long)chain->ip);
122 static struct symbol *rem_sq_bracket;
123 static struct callchain_list rem_hits;
125 static void init_rem_hits(void)
127 rem_sq_bracket = malloc(sizeof(*rem_sq_bracket) + 6);
128 if (!rem_sq_bracket) {
129 fprintf(stderr, "Not enough memory to display remaining hits\n");
133 strcpy(rem_sq_bracket->name, "[...]");
134 rem_hits.sym = rem_sq_bracket;
138 __callchain__fprintf_graph(FILE *fp, struct callchain_node *self,
139 u64 total_samples, int depth, int depth_mask,
142 struct rb_node *node, *next;
143 struct callchain_node *child;
144 struct callchain_list *chain;
145 int new_depth_mask = depth_mask;
151 if (callchain_param.mode == CHAIN_GRAPH_REL)
152 new_total = self->children_hit;
154 new_total = total_samples;
156 remaining = new_total;
158 node = rb_first(&self->rb_root);
162 child = rb_entry(node, struct callchain_node, rb_node);
163 cumul = cumul_hits(child);
167 * The depth mask manages the output of pipes that show
168 * the depth. We don't want to keep the pipes of the current
169 * level for the last child of this depth.
170 * Except if we have remaining filtered hits. They will
171 * supersede the last child
173 next = rb_next(node);
174 if (!next && (callchain_param.mode != CHAIN_GRAPH_REL || !remaining))
175 new_depth_mask &= ~(1 << (depth - 1));
178 * But we keep the older depth mask for the line seperator
179 * to keep the level link until we reach the last child
181 ret += ipchain__fprintf_graph_line(fp, depth, depth_mask,
184 list_for_each_entry(chain, &child->val, list) {
185 if (chain->ip >= PERF_CONTEXT_MAX)
187 ret += ipchain__fprintf_graph(fp, chain, depth,
193 ret += __callchain__fprintf_graph(fp, child, new_total,
195 new_depth_mask | (1 << depth),
200 if (callchain_param.mode == CHAIN_GRAPH_REL &&
201 remaining && remaining != new_total) {
206 new_depth_mask &= ~(1 << (depth - 1));
208 ret += ipchain__fprintf_graph(fp, &rem_hits, depth,
209 new_depth_mask, 0, new_total,
210 remaining, left_margin);
218 callchain__fprintf_graph(FILE *fp, struct callchain_node *self,
219 u64 total_samples, int left_margin)
221 struct callchain_list *chain;
222 bool printed = false;
226 list_for_each_entry(chain, &self->val, list) {
227 if (chain->ip >= PERF_CONTEXT_MAX)
230 if (!i++ && sort__first_dimension == SORT_SYM)
234 ret += callchain__fprintf_left_margin(fp, left_margin);
235 ret += fprintf(fp, "|\n");
236 ret += callchain__fprintf_left_margin(fp, left_margin);
237 ret += fprintf(fp, "---");
242 ret += callchain__fprintf_left_margin(fp, left_margin);
245 ret += fprintf(fp, " %s\n", chain->sym->name);
247 ret += fprintf(fp, " %p\n", (void *)(long)chain->ip);
250 ret += __callchain__fprintf_graph(fp, self, total_samples, 1, 1, left_margin);
256 callchain__fprintf_flat(FILE *fp, struct callchain_node *self,
259 struct callchain_list *chain;
265 ret += callchain__fprintf_flat(fp, self->parent, total_samples);
268 list_for_each_entry(chain, &self->val, list) {
269 if (chain->ip >= PERF_CONTEXT_MAX)
272 ret += fprintf(fp, " %s\n", chain->sym->name);
274 ret += fprintf(fp, " %p\n",
275 (void *)(long)chain->ip);
282 hist_entry_callchain__fprintf(FILE *fp, struct hist_entry *self,
283 u64 total_samples, int left_margin)
285 struct rb_node *rb_node;
286 struct callchain_node *chain;
289 rb_node = rb_first(&self->sorted_chain);
293 chain = rb_entry(rb_node, struct callchain_node, rb_node);
294 percent = chain->hit * 100.0 / total_samples;
295 switch (callchain_param.mode) {
297 ret += percent_color_fprintf(fp, " %6.2f%%\n",
299 ret += callchain__fprintf_flat(fp, chain, total_samples);
301 case CHAIN_GRAPH_ABS: /* Falldown */
302 case CHAIN_GRAPH_REL:
303 ret += callchain__fprintf_graph(fp, chain, total_samples,
309 ret += fprintf(fp, "\n");
310 rb_node = rb_next(rb_node);
316 static size_t hist_entry__fprintf(FILE *fp, struct hist_entry *self,
317 struct perf_session *session,
320 struct sort_entry *se;
323 if (exclude_other && !self->parent)
327 ret = percent_color_fprintf(fp,
328 field_sep ? "%.2f" : " %6.2f%%",
329 (self->count * 100.0) / total_samples);
331 ret = fprintf(fp, field_sep ? "%lld" : "%12lld ", self->count);
333 if (show_nr_samples) {
335 fprintf(fp, "%c%lld", *field_sep, self->count);
337 fprintf(fp, "%11lld", self->count);
340 list_for_each_entry(se, &hist_entry__sort_list, list) {
344 fprintf(fp, "%s", field_sep ?: " ");
345 ret += se->print(fp, self, se->width ? *se->width : 0);
348 ret += fprintf(fp, "\n");
350 if (session->use_callchain) {
353 if (sort__first_dimension == SORT_COMM) {
354 se = list_first_entry(&hist_entry__sort_list, typeof(*se),
356 left_margin = se->width ? *se->width : 0;
357 left_margin -= thread__comm_len(self->thread);
360 hist_entry_callchain__fprintf(fp, self, total_samples,
371 static void dso__calc_col_width(struct dso *self)
373 if (!col_width_list_str && !field_sep &&
374 (!dso_list || strlist__has_entry(dso_list, self->name))) {
375 unsigned int slen = strlen(self->name);
376 if (slen > dsos__col_width)
377 dsos__col_width = slen;
380 self->slen_calculated = 1;
383 static void thread__comm_adjust(struct thread *self)
385 char *comm = self->comm;
387 if (!col_width_list_str && !field_sep &&
388 (!comm_list || strlist__has_entry(comm_list, comm))) {
389 unsigned int slen = strlen(comm);
391 if (slen > comms__col_width) {
392 comms__col_width = slen;
393 threads__col_width = slen + 6;
398 static int thread__set_comm_adjust(struct thread *self, const char *comm)
400 int ret = thread__set_comm(self, comm);
405 thread__comm_adjust(self);
410 static int call__match(struct symbol *sym)
412 if (sym->name && !regexec(&parent_regex, sym->name, 0, NULL, 0))
418 static struct symbol **resolve_callchain(struct thread *thread,
419 struct perf_session *session,
420 struct ip_callchain *chain,
421 struct symbol **parent)
423 u8 cpumode = PERF_RECORD_MISC_USER;
424 struct symbol **syms = NULL;
427 if (session->use_callchain) {
428 syms = calloc(chain->nr, sizeof(*syms));
430 fprintf(stderr, "Can't allocate memory for symbols\n");
435 for (i = 0; i < chain->nr; i++) {
436 u64 ip = chain->ips[i];
437 struct addr_location al;
439 if (ip >= PERF_CONTEXT_MAX) {
441 case PERF_CONTEXT_HV:
442 cpumode = PERF_RECORD_MISC_HYPERVISOR; break;
443 case PERF_CONTEXT_KERNEL:
444 cpumode = PERF_RECORD_MISC_KERNEL; break;
445 case PERF_CONTEXT_USER:
446 cpumode = PERF_RECORD_MISC_USER; break;
453 thread__find_addr_location(thread, session, cpumode,
454 MAP__FUNCTION, ip, &al, NULL);
455 if (al.sym != NULL) {
456 if (sort__has_parent && !*parent &&
459 if (!session->use_callchain)
469 * collect histogram counts
472 static int perf_session__add_hist_entry(struct perf_session *self,
473 struct addr_location *al,
474 struct ip_callchain *chain, u64 count)
476 struct symbol **syms = NULL, *parent = NULL;
478 struct hist_entry *he;
480 if ((sort__has_parent || self->use_callchain) && chain)
481 syms = resolve_callchain(al->thread, self, chain, &parent);
483 he = __perf_session__add_hist_entry(self, al, parent, count, &hit);
490 if (self->use_callchain) {
492 callchain_init(&he->callchain);
493 append_chain(&he->callchain, chain, syms);
500 static size_t perf_session__fprintf_hist_entries(struct perf_session *self,
501 u64 total_samples, FILE *fp)
503 struct hist_entry *pos;
504 struct sort_entry *se;
508 char *col_width = col_width_list_str;
509 int raw_printing_style;
511 raw_printing_style = !strcmp(pretty_printing_style, "raw");
515 fprintf(fp, "# Samples: %Ld\n", (u64)total_samples);
518 fprintf(fp, "# Overhead");
519 if (show_nr_samples) {
521 fprintf(fp, "%cSamples", *field_sep);
523 fputs(" Samples ", fp);
525 list_for_each_entry(se, &hist_entry__sort_list, list) {
529 fprintf(fp, "%c%s", *field_sep, se->header);
532 width = strlen(se->header);
534 if (col_width_list_str) {
536 *se->width = atoi(col_width);
537 col_width = strchr(col_width, ',');
542 width = *se->width = max(*se->width, width);
544 fprintf(fp, " %*s", width, se->header);
551 fprintf(fp, "# ........");
553 fprintf(fp, " ..........");
554 list_for_each_entry(se, &hist_entry__sort_list, list) {
564 width = strlen(se->header);
565 for (i = 0; i < width; i++)
573 for (nd = rb_first(&self->hists); nd; nd = rb_next(nd)) {
574 pos = rb_entry(nd, struct hist_entry, rb_node);
575 ret += hist_entry__fprintf(fp, pos, self, total_samples);
578 if (sort_order == default_sort_order &&
579 parent_pattern == default_parent_pattern) {
581 fprintf(fp, "# (For a higher level overview, try: perf report --sort comm,dso)\n");
586 free(rem_sq_bracket);
589 perf_read_values_display(fp, &show_threads_values,
595 static int validate_chain(struct ip_callchain *chain, event_t *event)
597 unsigned int chain_size;
599 chain_size = event->header.size;
600 chain_size -= (unsigned long)&event->ip.__more_data - (unsigned long)event;
602 if (chain->nr*sizeof(u64) > chain_size)
608 static int process_sample_event(event_t *event, struct perf_session *session)
610 struct sample_data data;
612 struct addr_location al;
613 struct thread *thread;
615 memset(&data, 0, sizeof(data));
618 event__parse_sample(event, sample_type, &data);
620 dump_printf("(IP, %d): %d/%d: %p period: %Ld\n",
623 (void *)(long)data.ip,
624 (long long)data.period);
626 if (sample_type & PERF_SAMPLE_CALLCHAIN) {
629 dump_printf("... chain: nr:%Lu\n", data.callchain->nr);
631 if (validate_chain(data.callchain, event) < 0) {
632 pr_debug("call-chain problem with event, "
638 for (i = 0; i < data.callchain->nr; i++)
639 dump_printf("..... %2d: %016Lx\n",
640 i, data.callchain->ips[i]);
644 thread = perf_session__findnew(session, data.pid);
645 if (thread == NULL) {
646 pr_debug("problem processing %d event, skipping it.\n",
651 dump_printf(" ... thread: %s:%d\n", thread->comm, thread->pid);
653 if (comm_list && !strlist__has_entry(comm_list, thread->comm))
656 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
658 thread__find_addr_location(thread, session, cpumode,
659 MAP__FUNCTION, data.ip, &al, NULL);
661 * We have to do this here as we may have a dso with no symbol hit that
662 * has a name longer than the ones with symbols sampled.
664 if (al.map && !sort_dso.elide && !al.map->dso->slen_calculated)
665 dso__calc_col_width(al.map->dso);
668 (!al.map || !al.map->dso ||
669 !(strlist__has_entry(dso_list, al.map->dso->short_name) ||
670 (al.map->dso->short_name != al.map->dso->long_name &&
671 strlist__has_entry(dso_list, al.map->dso->long_name)))))
674 if (sym_list && al.sym && !strlist__has_entry(sym_list, al.sym->name))
677 if (perf_session__add_hist_entry(session, &al, data.callchain, data.period)) {
678 pr_debug("problem incrementing symbol count, skipping event\n");
682 event__stats.total += data.period;
687 static int process_comm_event(event_t *event, struct perf_session *session)
689 struct thread *thread = perf_session__findnew(session, event->comm.pid);
691 dump_printf(": %s:%d\n", event->comm.comm, event->comm.pid);
693 if (thread == NULL ||
694 thread__set_comm_adjust(thread, event->comm.comm)) {
695 dump_printf("problem processing PERF_RECORD_COMM, skipping event.\n");
702 static int process_read_event(event_t *event, struct perf_session *session __used)
704 struct perf_event_attr *attr;
706 attr = perf_header__find_attr(event->read.id, &session->header);
709 const char *name = attr ? __event_name(attr->type, attr->config)
711 perf_read_values_add_value(&show_threads_values,
712 event->read.pid, event->read.tid,
718 dump_printf(": %d %d %s %Lu\n", event->read.pid, event->read.tid,
719 attr ? __event_name(attr->type, attr->config) : "FAIL",
725 static int sample_type_check(u64 type, struct perf_session *session)
729 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
730 if (sort__has_parent) {
731 fprintf(stderr, "selected --sort parent, but no"
732 " callchain data. Did you call"
733 " perf record without -g?\n");
736 if (session->use_callchain) {
737 fprintf(stderr, "selected -g but no callchain data."
738 " Did you call perf record without"
742 } else if (callchain_param.mode != CHAIN_NONE && !session->use_callchain) {
743 session->use_callchain = true;
744 if (register_callchain_param(&callchain_param) < 0) {
745 fprintf(stderr, "Can't register callchain"
754 static struct perf_event_ops event_ops = {
755 .process_sample_event = process_sample_event,
756 .process_mmap_event = event__process_mmap,
757 .process_comm_event = process_comm_event,
758 .process_exit_event = event__process_task,
759 .process_fork_event = event__process_task,
760 .process_lost_event = event__process_lost,
761 .process_read_event = process_read_event,
762 .sample_type_check = sample_type_check,
766 static int __cmd_report(void)
769 struct perf_session *session;
771 session = perf_session__new(input_name, O_RDONLY, force, &symbol_conf);
775 session->use_callchain = use_callchain;
778 perf_read_values_init(&show_threads_values);
780 ret = perf_session__process_events(session, &event_ops);
785 event__print_totals();
790 perf_session__fprintf(session, stdout);
793 dsos__fprintf(stdout);
795 perf_session__collapse_resort(session);
796 perf_session__output_resort(session, event__stats.total);
797 perf_session__fprintf_hist_entries(session, event__stats.total, stdout);
800 perf_read_values_destroy(&show_threads_values);
802 perf_session__delete(session);
807 parse_callchain_opt(const struct option *opt __used, const char *arg,
813 use_callchain = true;
818 tok = strtok((char *)arg, ",");
822 /* get the output mode */
823 if (!strncmp(tok, "graph", strlen(arg)))
824 callchain_param.mode = CHAIN_GRAPH_ABS;
826 else if (!strncmp(tok, "flat", strlen(arg)))
827 callchain_param.mode = CHAIN_FLAT;
829 else if (!strncmp(tok, "fractal", strlen(arg)))
830 callchain_param.mode = CHAIN_GRAPH_REL;
832 else if (!strncmp(tok, "none", strlen(arg))) {
833 callchain_param.mode = CHAIN_NONE;
834 use_callchain = true;
842 /* get the min percentage */
843 tok = strtok(NULL, ",");
847 callchain_param.min_percent = strtod(tok, &endptr);
852 if (register_callchain_param(&callchain_param) < 0) {
853 fprintf(stderr, "Can't register callchain params\n");
859 //static const char * const report_usage[] = {
860 const char * const report_usage[] = {
861 "perf report [<options>] <command>",
865 static const struct option options[] = {
866 OPT_STRING('i', "input", &input_name, "file",
868 OPT_BOOLEAN('v', "verbose", &verbose,
869 "be more verbose (show symbol address, etc)"),
870 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
871 "dump raw trace in ASCII"),
872 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
873 "file", "vmlinux pathname"),
874 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
875 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
876 "load module symbols - WARNING: use only with -k and LIVE kernel"),
877 OPT_BOOLEAN('n', "show-nr-samples", &show_nr_samples,
878 "Show a column with the number of samples"),
879 OPT_BOOLEAN('T', "threads", &show_threads,
880 "Show per-thread event counters"),
881 OPT_STRING(0, "pretty", &pretty_printing_style, "key",
882 "pretty printing style key: normal raw"),
883 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
884 "sort by key(s): pid, comm, dso, symbol, parent"),
885 OPT_BOOLEAN('P', "full-paths", &event_ops.full_paths,
886 "Don't shorten the pathnames taking into account the cwd"),
887 OPT_STRING('p', "parent", &parent_pattern, "regex",
888 "regex filter to identify parent, see: '--sort parent'"),
889 OPT_BOOLEAN('x', "exclude-other", &exclude_other,
890 "Only display entries with parent-match"),
891 OPT_CALLBACK_DEFAULT('g', "call-graph", NULL, "output_type,min_percent",
892 "Display callchains using output_type and min percent threshold. "
893 "Default: fractal,0.5", &parse_callchain_opt, callchain_default_opt),
894 OPT_STRING('d', "dsos", &dso_list_str, "dso[,dso...]",
895 "only consider symbols in these dsos"),
896 OPT_STRING('C', "comms", &comm_list_str, "comm[,comm...]",
897 "only consider symbols in these comms"),
898 OPT_STRING('S', "symbols", &sym_list_str, "symbol[,symbol...]",
899 "only consider these symbols"),
900 OPT_STRING('w', "column-widths", &col_width_list_str,
902 "don't try to adjust column width, use these fixed values"),
903 OPT_STRING('t', "field-separator", &field_sep, "separator",
904 "separator for columns, no spaces will be added between "
905 "columns '.' is reserved."),
909 static void setup_sorting(void)
911 char *tmp, *tok, *str = strdup(sort_order);
913 for (tok = strtok_r(str, ", ", &tmp);
914 tok; tok = strtok_r(NULL, ", ", &tmp)) {
915 if (sort_dimension__add(tok) < 0) {
916 error("Unknown --sort key: `%s'", tok);
917 usage_with_options(report_usage, options);
924 static void setup_list(struct strlist **list, const char *list_str,
925 struct sort_entry *se, const char *list_name,
929 *list = strlist__new(true, list_str);
931 fprintf(stderr, "problems parsing %s list\n",
935 if (strlist__nr_entries(*list) == 1) {
936 fprintf(fp, "# %s: %s\n", list_name,
937 strlist__entry(*list, 0)->s);
943 int cmd_report(int argc, const char **argv, const char *prefix __used)
945 if (symbol__init(&symbol_conf) < 0)
948 argc = parse_options(argc, argv, options, report_usage, 0);
952 if (parent_pattern != default_parent_pattern) {
953 sort_dimension__add("parent");
954 sort_parent.elide = 1;
959 * Any (unrecognized) arguments left?
962 usage_with_options(report_usage, options);
966 setup_list(&dso_list, dso_list_str, &sort_dso, "dso", stdout);
967 setup_list(&comm_list, comm_list_str, &sort_comm, "comm", stdout);
968 setup_list(&sym_list, sym_list_str, &sort_sym, "symbol", stdout);
970 if (field_sep && *field_sep == '.') {
971 fputs("'.' is the only non valid --field-separator argument\n",
976 return __cmd_report();