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 struct symbol_conf symbol_conf = {
55 .priv_size = sizeof(struct sym_priv),
56 .try_vmlinux_path = true,
59 static const char *sym_hist_filter;
61 static int symbol_filter(struct map *map __used, struct symbol *sym)
63 if (sym_hist_filter == NULL ||
64 strcmp(sym->name, sym_hist_filter) == 0) {
65 struct sym_priv *priv = symbol__priv(sym);
66 const int size = (sizeof(*priv->hist) +
67 (sym->end - sym->start) * sizeof(u64));
69 priv->hist = malloc(size);
71 memset(priv->hist, 0, size);
75 * FIXME: We should really filter it out, as we don't want to go thru symbols
76 * we're not interested, and if a DSO ends up with no symbols, delete it too,
77 * but right now the kernel loading routines in symbol.c bail out if no symbols
78 * are found, fix it later.
84 * collect histogram counts
86 static void hist_hit(struct hist_entry *he, u64 ip)
88 unsigned int sym_size, offset;
89 struct symbol *sym = he->sym;
90 struct sym_priv *priv;
98 priv = symbol__priv(sym);
102 sym_size = sym->end - sym->start;
103 offset = ip - sym->start;
106 fprintf(stderr, "%s: ip=%Lx\n", __func__,
107 he->map->unmap_ip(he->map, ip));
109 if (offset >= sym_size)
117 printf("%p %s: count++ [ip: %p, %08Lx] => %Ld\n",
118 (void *)(unsigned long)he->sym->start,
120 (void *)(unsigned long)ip, ip - he->sym->start,
124 static int hist_entry__add(struct addr_location *al, u64 count)
127 struct hist_entry *he = __hist_entry__add(al, NULL, count, &hit);
130 hist_hit(he, al->addr);
134 static int process_sample_event(event_t *event, struct perf_session *session)
136 struct addr_location al;
138 dump_printf("(IP, %d): %d: %p\n", event->header.misc,
139 event->ip.pid, (void *)(long)event->ip.ip);
141 if (event__preprocess_sample(event, session, &al, symbol_filter) < 0) {
142 fprintf(stderr, "problem processing %d event, skipping it.\n",
147 if (hist_entry__add(&al, 1)) {
148 fprintf(stderr, "problem incrementing symbol count, "
156 static int parse_line(FILE *file, struct hist_entry *he, u64 len)
158 struct symbol *sym = he->sym;
159 char *line = NULL, *tmp, *tmp2;
160 static const char *prev_line;
161 static const char *prev_color;
169 if (getline(&line, &line_len, file) < 0)
174 c = strchr(line, '\n');
183 * Strip leading spaces:
194 * Parse hexa addresses followed by ':'
196 line_ip = strtoull(tmp, &tmp2, 16);
201 start = he->map->unmap_ip(he->map, sym->start);
204 const char *path = NULL;
205 unsigned int hits = 0;
206 double percent = 0.0;
208 struct sym_priv *priv = symbol__priv(sym);
209 struct sym_ext *sym_ext = priv->ext;
210 struct sym_hist *h = priv->hist;
212 offset = line_ip - start;
214 hits = h->ip[offset];
216 if (offset < len && sym_ext) {
217 path = sym_ext[offset].path;
218 percent = sym_ext[offset].percent;
220 percent = 100.0 * hits / h->sum;
222 color = get_percent_color(percent);
225 * Also color the filename and line if needed, with
226 * the same color than the percentage. Don't print it
227 * twice for close colored ip with the same filename:line
230 if (!prev_line || strcmp(prev_line, path)
231 || color != prev_color) {
232 color_fprintf(stdout, color, " %s", path);
238 color_fprintf(stdout, color, " %7.2f", percent);
240 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", line);
245 printf(" : %s\n", line);
251 static struct rb_root root_sym_ext;
253 static void insert_source_line(struct sym_ext *sym_ext)
255 struct sym_ext *iter;
256 struct rb_node **p = &root_sym_ext.rb_node;
257 struct rb_node *parent = NULL;
261 iter = rb_entry(parent, struct sym_ext, node);
263 if (sym_ext->percent > iter->percent)
269 rb_link_node(&sym_ext->node, parent, p);
270 rb_insert_color(&sym_ext->node, &root_sym_ext);
273 static void free_source_line(struct hist_entry *he, int len)
275 struct sym_priv *priv = symbol__priv(he->sym);
276 struct sym_ext *sym_ext = priv->ext;
282 for (i = 0; i < len; i++)
283 free(sym_ext[i].path);
287 root_sym_ext = RB_ROOT;
290 /* Get the filename:line for the colored entries */
292 get_source_line(struct hist_entry *he, int len, const char *filename)
294 struct symbol *sym = he->sym;
297 char cmd[PATH_MAX * 2];
298 struct sym_ext *sym_ext;
299 struct sym_priv *priv = symbol__priv(sym);
300 struct sym_hist *h = priv->hist;
305 sym_ext = priv->ext = calloc(len, sizeof(struct sym_ext));
309 start = he->map->unmap_ip(he->map, sym->start);
311 for (i = 0; i < len; i++) {
317 sym_ext[i].percent = 100.0 * h->ip[i] / h->sum;
318 if (sym_ext[i].percent <= 0.5)
322 sprintf(cmd, "addr2line -e %s %016llx", filename, offset);
323 fp = popen(cmd, "r");
327 if (getline(&path, &line_len, fp) < 0 || !line_len)
330 sym_ext[i].path = malloc(sizeof(char) * line_len + 1);
331 if (!sym_ext[i].path)
334 strcpy(sym_ext[i].path, path);
335 insert_source_line(&sym_ext[i]);
342 static void print_summary(const char *filename)
344 struct sym_ext *sym_ext;
345 struct rb_node *node;
347 printf("\nSorted summary for file %s\n", filename);
348 printf("----------------------------------------------\n\n");
350 if (RB_EMPTY_ROOT(&root_sym_ext)) {
351 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
355 node = rb_first(&root_sym_ext);
361 sym_ext = rb_entry(node, struct sym_ext, node);
362 percent = sym_ext->percent;
363 color = get_percent_color(percent);
364 path = sym_ext->path;
366 color_fprintf(stdout, color, " %7.2f %s", percent, path);
367 node = rb_next(node);
371 static void annotate_sym(struct hist_entry *he)
373 struct map *map = he->map;
374 struct dso *dso = map->dso;
375 struct symbol *sym = he->sym;
376 const char *filename = dso->long_name, *d_filename;
378 char command[PATH_MAX*2];
385 fprintf(stderr, "%s: filename=%s, sym=%s, start=%Lx, end=%Lx\n",
386 __func__, filename, sym->name,
387 map->unmap_ip(map, sym->start),
388 map->unmap_ip(map, sym->end));
391 d_filename = filename;
393 d_filename = basename(filename);
395 len = sym->end - sym->start;
398 get_source_line(he, len, filename);
399 print_summary(filename);
402 printf("\n\n------------------------------------------------\n");
403 printf(" Percent | Source code & Disassembly of %s\n", d_filename);
404 printf("------------------------------------------------\n");
407 printf("annotating [%p] %30s : [%p] %30s\n",
408 dso, dso->long_name, sym, sym->name);
410 sprintf(command, "objdump --start-address=0x%016Lx --stop-address=0x%016Lx -dS %s|grep -v %s",
411 map->unmap_ip(map, sym->start), map->unmap_ip(map, sym->end),
415 printf("doing: %s\n", command);
417 file = popen(command, "r");
421 while (!feof(file)) {
422 if (parse_line(file, he, len) < 0)
428 free_source_line(he, len);
431 static void find_annotations(void)
435 for (nd = rb_first(&output_hists); nd; nd = rb_next(nd)) {
436 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
437 struct sym_priv *priv;
442 priv = symbol__priv(he->sym);
443 if (priv->hist == NULL)
448 * Since we have a hist_entry per IP for the same symbol, free
449 * he->sym->hist to signal we already processed this symbol.
456 static struct perf_event_ops event_ops = {
457 .process_sample_event = process_sample_event,
458 .process_mmap_event = event__process_mmap,
459 .process_comm_event = event__process_comm,
460 .process_fork_event = event__process_task,
463 static int __cmd_annotate(void)
465 struct perf_session *session = perf_session__new(input_name, O_RDONLY,
466 force, &symbol_conf);
472 ret = perf_session__process_events(session, &event_ops);
477 event__print_totals();
482 perf_session__fprintf(session, stdout);
485 dsos__fprintf(stdout);
488 output__resort(event__total[0]);
492 perf_session__delete(session);
497 static const char * const annotate_usage[] = {
498 "perf annotate [<options>] <command>",
502 static const struct option options[] = {
503 OPT_STRING('i', "input", &input_name, "file",
505 OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
506 "symbol to annotate"),
507 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
508 OPT_BOOLEAN('v', "verbose", &verbose,
509 "be more verbose (show symbol address, etc)"),
510 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
511 "dump raw trace in ASCII"),
512 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
513 "file", "vmlinux pathname"),
514 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
515 "load module symbols - WARNING: use only with -k and LIVE kernel"),
516 OPT_BOOLEAN('l', "print-line", &print_line,
517 "print matching source lines (may be slow)"),
518 OPT_BOOLEAN('P', "full-paths", &full_paths,
519 "Don't shorten the displayed pathnames"),
523 static void setup_sorting(void)
525 char *tmp, *tok, *str = strdup(sort_order);
527 for (tok = strtok_r(str, ", ", &tmp);
528 tok; tok = strtok_r(NULL, ", ", &tmp)) {
529 if (sort_dimension__add(tok) < 0) {
530 error("Unknown --sort key: `%s'", tok);
531 usage_with_options(annotate_usage, options);
538 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
540 if (symbol__init(&symbol_conf) < 0)
543 argc = parse_options(argc, argv, options, annotate_usage, 0);
549 * Special case: if there's an argument left then assume tha
550 * it's a symbol filter:
553 usage_with_options(annotate_usage, options);
555 sym_hist_filter = argv[0];
560 if (field_sep && *field_sep == '.') {
561 fputs("'.' is the only non valid --field-separator argument\n",
566 return __cmd_annotate();