4 * Builtin annotate 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"
20 #include "util/debug.h"
22 #include "util/event.h"
23 #include "util/parse-options.h"
24 #include "util/parse-events.h"
25 #include "util/thread.h"
26 #include "util/sort.h"
27 #include "util/hist.h"
28 #include "util/session.h"
30 static char const *input_name = "perf.data";
34 static int full_paths;
36 static int print_line;
50 struct sym_hist *hist;
54 static const char *sym_hist_filter;
56 static int symbol_filter(struct map *map __used, struct symbol *sym)
58 if (sym_hist_filter == NULL ||
59 strcmp(sym->name, sym_hist_filter) == 0) {
60 struct sym_priv *priv = symbol__priv(sym);
61 const int size = (sizeof(*priv->hist) +
62 (sym->end - sym->start) * sizeof(u64));
64 priv->hist = malloc(size);
66 memset(priv->hist, 0, size);
70 * FIXME: We should really filter it out, as we don't want to go thru symbols
71 * we're not interested, and if a DSO ends up with no symbols, delete it too,
72 * but right now the kernel loading routines in symbol.c bail out if no symbols
73 * are found, fix it later.
79 * collect histogram counts
81 static void hist_hit(struct hist_entry *he, u64 ip)
83 unsigned int sym_size, offset;
84 struct symbol *sym = he->sym;
85 struct sym_priv *priv;
93 priv = symbol__priv(sym);
97 sym_size = sym->end - sym->start;
98 offset = ip - sym->start;
100 pr_debug3("%s: ip=%#Lx\n", __func__, he->map->unmap_ip(he->map, ip));
102 if (offset >= sym_size)
109 pr_debug3("%#Lx %s: count++ [ip: %#Lx, %#Lx] => %Ld\n", he->sym->start,
110 he->sym->name, ip, ip - he->sym->start, h->ip[offset]);
113 static int perf_session__add_hist_entry(struct perf_session *self,
114 struct addr_location *al, u64 count)
117 struct hist_entry *he = __perf_session__add_hist_entry(self, al, NULL,
121 hist_hit(he, al->addr);
125 static int process_sample_event(event_t *event, struct perf_session *session)
127 struct addr_location al;
129 dump_printf("(IP, %d): %d: %#Lx\n", event->header.misc,
130 event->ip.pid, event->ip.ip);
132 if (event__preprocess_sample(event, session, &al, symbol_filter) < 0) {
133 pr_warning("problem processing %d event, skipping it.\n",
138 if (!al.filtered && perf_session__add_hist_entry(session, &al, 1)) {
139 pr_warning("problem incrementing symbol count, "
147 static int parse_line(FILE *file, struct hist_entry *he, u64 len)
149 struct symbol *sym = he->sym;
150 char *line = NULL, *tmp, *tmp2;
151 static const char *prev_line;
152 static const char *prev_color;
160 if (getline(&line, &line_len, file) < 0)
165 c = strchr(line, '\n');
174 * Strip leading spaces:
185 * Parse hexa addresses followed by ':'
187 line_ip = strtoull(tmp, &tmp2, 16);
192 start = map__rip_2objdump(he->map, sym->start);
195 const char *path = NULL;
196 unsigned int hits = 0;
197 double percent = 0.0;
199 struct sym_priv *priv = symbol__priv(sym);
200 struct sym_ext *sym_ext = priv->ext;
201 struct sym_hist *h = priv->hist;
203 offset = line_ip - start;
205 hits = h->ip[offset];
207 if (offset < len && sym_ext) {
208 path = sym_ext[offset].path;
209 percent = sym_ext[offset].percent;
211 percent = 100.0 * hits / h->sum;
213 color = get_percent_color(percent);
216 * Also color the filename and line if needed, with
217 * the same color than the percentage. Don't print it
218 * twice for close colored ip with the same filename:line
221 if (!prev_line || strcmp(prev_line, path)
222 || color != prev_color) {
223 color_fprintf(stdout, color, " %s", path);
229 color_fprintf(stdout, color, " %7.2f", percent);
231 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", line);
236 printf(" : %s\n", line);
242 static struct rb_root root_sym_ext;
244 static void insert_source_line(struct sym_ext *sym_ext)
246 struct sym_ext *iter;
247 struct rb_node **p = &root_sym_ext.rb_node;
248 struct rb_node *parent = NULL;
252 iter = rb_entry(parent, struct sym_ext, node);
254 if (sym_ext->percent > iter->percent)
260 rb_link_node(&sym_ext->node, parent, p);
261 rb_insert_color(&sym_ext->node, &root_sym_ext);
264 static void free_source_line(struct hist_entry *he, int len)
266 struct sym_priv *priv = symbol__priv(he->sym);
267 struct sym_ext *sym_ext = priv->ext;
273 for (i = 0; i < len; i++)
274 free(sym_ext[i].path);
278 root_sym_ext = RB_ROOT;
281 /* Get the filename:line for the colored entries */
283 get_source_line(struct hist_entry *he, int len, const char *filename)
285 struct symbol *sym = he->sym;
288 char cmd[PATH_MAX * 2];
289 struct sym_ext *sym_ext;
290 struct sym_priv *priv = symbol__priv(sym);
291 struct sym_hist *h = priv->hist;
296 sym_ext = priv->ext = calloc(len, sizeof(struct sym_ext));
300 start = he->map->unmap_ip(he->map, sym->start);
302 for (i = 0; i < len; i++) {
308 sym_ext[i].percent = 100.0 * h->ip[i] / h->sum;
309 if (sym_ext[i].percent <= 0.5)
313 sprintf(cmd, "addr2line -e %s %016llx", filename, offset);
314 fp = popen(cmd, "r");
318 if (getline(&path, &line_len, fp) < 0 || !line_len)
321 sym_ext[i].path = malloc(sizeof(char) * line_len + 1);
322 if (!sym_ext[i].path)
325 strcpy(sym_ext[i].path, path);
326 insert_source_line(&sym_ext[i]);
333 static void print_summary(const char *filename)
335 struct sym_ext *sym_ext;
336 struct rb_node *node;
338 printf("\nSorted summary for file %s\n", filename);
339 printf("----------------------------------------------\n\n");
341 if (RB_EMPTY_ROOT(&root_sym_ext)) {
342 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
346 node = rb_first(&root_sym_ext);
352 sym_ext = rb_entry(node, struct sym_ext, node);
353 percent = sym_ext->percent;
354 color = get_percent_color(percent);
355 path = sym_ext->path;
357 color_fprintf(stdout, color, " %7.2f %s", percent, path);
358 node = rb_next(node);
362 static void annotate_sym(struct hist_entry *he)
364 struct map *map = he->map;
365 struct dso *dso = map->dso;
366 struct symbol *sym = he->sym;
367 const char *filename = dso->long_name, *d_filename;
369 char command[PATH_MAX*2];
375 pr_debug("%s: filename=%s, sym=%s, start=%#Lx, end=%#Lx\n", __func__,
376 filename, sym->name, map->unmap_ip(map, sym->start),
377 map->unmap_ip(map, sym->end));
380 d_filename = filename;
382 d_filename = basename(filename);
384 len = sym->end - sym->start;
387 get_source_line(he, len, filename);
388 print_summary(filename);
391 printf("\n\n------------------------------------------------\n");
392 printf(" Percent | Source code & Disassembly of %s\n", d_filename);
393 printf("------------------------------------------------\n");
396 printf("annotating [%p] %30s : [%p] %30s\n",
397 dso, dso->long_name, sym, sym->name);
399 sprintf(command, "objdump --start-address=0x%016Lx --stop-address=0x%016Lx -dS %s|grep -v %s",
400 map__rip_2objdump(map, sym->start),
401 map__rip_2objdump(map, sym->end),
405 printf("doing: %s\n", command);
407 file = popen(command, "r");
411 while (!feof(file)) {
412 if (parse_line(file, he, len) < 0)
418 free_source_line(he, len);
421 static void perf_session__find_annotations(struct perf_session *self)
425 for (nd = rb_first(&self->hists); nd; nd = rb_next(nd)) {
426 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
427 struct sym_priv *priv;
432 priv = symbol__priv(he->sym);
433 if (priv->hist == NULL)
438 * Since we have a hist_entry per IP for the same symbol, free
439 * he->sym->hist to signal we already processed this symbol.
446 static struct perf_event_ops event_ops = {
447 .sample = process_sample_event,
448 .mmap = event__process_mmap,
449 .comm = event__process_comm,
450 .fork = event__process_task,
453 static int __cmd_annotate(void)
456 struct perf_session *session;
458 session = perf_session__new(input_name, O_RDONLY, force);
462 ret = perf_session__process_events(session, &event_ops);
467 event__print_totals();
472 perf_session__fprintf(session, stdout);
475 dsos__fprintf(stdout);
477 perf_session__collapse_resort(session);
478 perf_session__output_resort(session, session->event_total[0]);
479 perf_session__find_annotations(session);
481 perf_session__delete(session);
486 static const char * const annotate_usage[] = {
487 "perf annotate [<options>] <command>",
491 static const struct option options[] = {
492 OPT_STRING('i', "input", &input_name, "file",
494 OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
495 "symbol to annotate"),
496 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
497 OPT_BOOLEAN('v', "verbose", &verbose,
498 "be more verbose (show symbol address, etc)"),
499 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
500 "dump raw trace in ASCII"),
501 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
502 "file", "vmlinux pathname"),
503 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
504 "load module symbols - WARNING: use only with -k and LIVE kernel"),
505 OPT_BOOLEAN('l', "print-line", &print_line,
506 "print matching source lines (may be slow)"),
507 OPT_BOOLEAN('P', "full-paths", &full_paths,
508 "Don't shorten the displayed pathnames"),
512 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
514 argc = parse_options(argc, argv, options, annotate_usage, 0);
516 symbol_conf.priv_size = sizeof(struct sym_priv);
517 symbol_conf.try_vmlinux_path = true;
519 if (symbol__init() < 0)
522 setup_sorting(annotate_usage, options);
526 * Special case: if there's an argument left then assume tha
527 * it's a symbol filter:
530 usage_with_options(annotate_usage, options);
532 sym_hist_filter = argv[0];
537 if (field_sep && *field_sep == '.') {
538 pr_err("'.' is the only non valid --field-separator argument\n");
542 return __cmd_annotate();