2 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
4 * Parts came from builtin-annotate.c, see those files for further
7 * Released under the GPL v2. (and only v2, not any later version)
19 const char *disassembler_style;
21 int symbol__annotate_init(struct map *map __used, struct symbol *sym)
23 struct annotation *notes = symbol__annotation(sym);
24 pthread_mutex_init(¬es->lock, NULL);
28 int symbol__alloc_hist(struct symbol *sym)
30 struct annotation *notes = symbol__annotation(sym);
31 size_t sizeof_sym_hist = (sizeof(struct sym_hist) +
32 (sym->end - sym->start) * sizeof(u64));
34 notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
35 if (notes->src == NULL)
37 notes->src->sizeof_sym_hist = sizeof_sym_hist;
38 notes->src->nr_histograms = symbol_conf.nr_events;
39 INIT_LIST_HEAD(¬es->src->source);
43 void symbol__annotate_zero_histograms(struct symbol *sym)
45 struct annotation *notes = symbol__annotation(sym);
47 pthread_mutex_lock(¬es->lock);
48 if (notes->src != NULL)
49 memset(notes->src->histograms, 0,
50 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
51 pthread_mutex_unlock(¬es->lock);
54 int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
58 struct annotation *notes;
61 notes = symbol__annotation(sym);
62 if (notes->src == NULL)
65 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
70 offset = addr - sym->start;
71 h = annotation__histogram(notes, evidx);
75 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
76 ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
77 addr, addr - sym->start, evidx, h->addr[offset]);
81 static struct objdump_line *objdump_line__new(s64 offset, char *line, size_t privsize)
83 struct objdump_line *self = malloc(sizeof(*self) + privsize);
86 self->offset = offset;
93 void objdump_line__free(struct objdump_line *self)
99 static void objdump__add_line(struct list_head *head, struct objdump_line *line)
101 list_add_tail(&line->node, head);
104 struct objdump_line *objdump__get_next_ip_line(struct list_head *head,
105 struct objdump_line *pos)
107 list_for_each_entry_continue(pos, head, node)
108 if (pos->offset >= 0)
114 static int objdump_line__print(struct objdump_line *oline, struct symbol *sym,
115 int evidx, u64 len, int min_pcnt,
116 int printed, int max_lines,
117 struct objdump_line *queue)
119 static const char *prev_line;
120 static const char *prev_color;
122 if (oline->offset != -1) {
123 const char *path = NULL;
124 unsigned int hits = 0;
125 double percent = 0.0;
127 struct annotation *notes = symbol__annotation(sym);
128 struct source_line *src_line = notes->src->lines;
129 struct sym_hist *h = annotation__histogram(notes, evidx);
130 s64 offset = oline->offset;
131 struct objdump_line *next;
133 next = objdump__get_next_ip_line(¬es->src->source, oline);
135 while (offset < (s64)len &&
136 (next == NULL || offset < next->offset)) {
139 path = src_line[offset].path;
140 percent += src_line[offset].percent;
142 hits += h->addr[offset];
147 if (src_line == NULL && h->sum)
148 percent = 100.0 * hits / h->sum;
150 if (percent < min_pcnt)
153 if (max_lines && printed >= max_lines)
157 list_for_each_entry_from(queue, ¬es->src->source, node) {
160 objdump_line__print(queue, sym, evidx, len,
165 color = get_percent_color(percent);
168 * Also color the filename and line if needed, with
169 * the same color than the percentage. Don't print it
170 * twice for close colored addr with the same filename:line
173 if (!prev_line || strcmp(prev_line, path)
174 || color != prev_color) {
175 color_fprintf(stdout, color, " %s", path);
181 color_fprintf(stdout, color, " %7.2f", percent);
183 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", oline->line);
184 } else if (max_lines && printed >= max_lines)
193 printf(" : %s\n", oline->line);
199 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
200 FILE *file, size_t privsize)
202 struct annotation *notes = symbol__annotation(sym);
203 struct objdump_line *objdump_line;
204 char *line = NULL, *tmp, *tmp2, *c;
206 s64 line_ip, offset = -1;
208 if (getline(&line, &line_len, file) < 0)
214 while (line_len != 0 && isspace(line[line_len - 1]))
215 line[--line_len] = '\0';
217 c = strchr(line, '\n');
224 * Strip leading spaces:
235 * Parse hexa addresses followed by ':'
237 line_ip = strtoull(tmp, &tmp2, 16);
238 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
243 u64 start = map__rip_2objdump(map, sym->start),
244 end = map__rip_2objdump(map, sym->end);
246 offset = line_ip - start;
247 if (offset < 0 || (u64)line_ip > end)
251 objdump_line = objdump_line__new(offset, line, privsize);
252 if (objdump_line == NULL) {
256 objdump__add_line(¬es->src->source, objdump_line);
261 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize)
263 struct dso *dso = map->dso;
264 char *filename = dso__build_id_filename(dso, NULL, 0);
265 bool free_filename = true;
266 char command[PATH_MAX * 2];
269 char symfs_filename[PATH_MAX];
272 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
273 symbol_conf.symfs, filename);
276 if (filename == NULL) {
277 if (dso->has_build_id) {
278 pr_err("Can't annotate %s: not enough memory\n",
283 } else if (readlink(symfs_filename, command, sizeof(command)) < 0 ||
284 strstr(command, "[kernel.kallsyms]") ||
285 access(symfs_filename, R_OK)) {
289 * If we don't have build-ids or the build-id file isn't in the
290 * cache, or is just a kallsyms file, well, lets hope that this
291 * DSO is the same as when 'perf record' ran.
293 filename = dso->long_name;
294 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
295 symbol_conf.symfs, filename);
296 free_filename = false;
299 if (dso->symtab_type == SYMTAB__KALLSYMS) {
300 char bf[BUILD_ID_SIZE * 2 + 16] = " with build id ";
301 char *build_id_msg = NULL;
303 if (dso->annotate_warned)
304 goto out_free_filename;
306 if (dso->has_build_id) {
307 build_id__sprintf(dso->build_id,
308 sizeof(dso->build_id), bf + 15);
312 dso->annotate_warned = 1;
313 pr_err("Can't annotate %s:\n\n"
314 "No vmlinux file%s\nwas found in the path.\n\n"
316 " perf buildid-cache -av vmlinux\n\n"
318 " --vmlinux vmlinux\n",
319 sym->name, build_id_msg ?: "");
320 goto out_free_filename;
323 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
324 filename, sym->name, map->unmap_ip(map, sym->start),
325 map->unmap_ip(map, sym->end));
327 pr_debug("annotating [%p] %30s : [%p] %30s\n",
328 dso, dso->long_name, sym, sym->name);
330 snprintf(command, sizeof(command),
331 "objdump %s%s --start-address=0x%016" PRIx64
332 " --stop-address=0x%016" PRIx64
333 " -d %s %s -C %s|grep -v %s|expand",
334 disassembler_style ? "-M " : "",
335 disassembler_style ? disassembler_style : "",
336 map__rip_2objdump(map, sym->start),
337 map__rip_2objdump(map, sym->end+1),
338 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
339 symbol_conf.annotate_src ? "-S" : "",
340 symfs_filename, filename);
342 pr_debug("Executing: %s\n", command);
344 file = popen(command, "r");
346 goto out_free_filename;
349 if (symbol__parse_objdump_line(sym, map, file, privsize) < 0)
359 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
361 struct source_line *iter;
362 struct rb_node **p = &root->rb_node;
363 struct rb_node *parent = NULL;
367 iter = rb_entry(parent, struct source_line, node);
369 if (src_line->percent > iter->percent)
375 rb_link_node(&src_line->node, parent, p);
376 rb_insert_color(&src_line->node, root);
379 static void symbol__free_source_line(struct symbol *sym, int len)
381 struct annotation *notes = symbol__annotation(sym);
382 struct source_line *src_line = notes->src->lines;
385 for (i = 0; i < len; i++)
386 free(src_line[i].path);
389 notes->src->lines = NULL;
392 /* Get the filename:line for the colored entries */
393 static int symbol__get_source_line(struct symbol *sym, struct map *map,
394 int evidx, struct rb_root *root, int len,
395 const char *filename)
399 char cmd[PATH_MAX * 2];
400 struct source_line *src_line;
401 struct annotation *notes = symbol__annotation(sym);
402 struct sym_hist *h = annotation__histogram(notes, evidx);
407 src_line = notes->src->lines = calloc(len, sizeof(struct source_line));
408 if (!notes->src->lines)
411 start = map->unmap_ip(map, sym->start);
413 for (i = 0; i < len; i++) {
419 src_line[i].percent = 100.0 * h->addr[i] / h->sum;
420 if (src_line[i].percent <= 0.5)
424 sprintf(cmd, "addr2line -e %s %016" PRIx64, filename, offset);
425 fp = popen(cmd, "r");
429 if (getline(&path, &line_len, fp) < 0 || !line_len)
432 src_line[i].path = malloc(sizeof(char) * line_len + 1);
433 if (!src_line[i].path)
436 strcpy(src_line[i].path, path);
437 insert_source_line(root, &src_line[i]);
446 static void print_summary(struct rb_root *root, const char *filename)
448 struct source_line *src_line;
449 struct rb_node *node;
451 printf("\nSorted summary for file %s\n", filename);
452 printf("----------------------------------------------\n\n");
454 if (RB_EMPTY_ROOT(root)) {
455 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
459 node = rb_first(root);
465 src_line = rb_entry(node, struct source_line, node);
466 percent = src_line->percent;
467 color = get_percent_color(percent);
468 path = src_line->path;
470 color_fprintf(stdout, color, " %7.2f %s", percent, path);
471 node = rb_next(node);
475 static void symbol__annotate_hits(struct symbol *sym, int evidx)
477 struct annotation *notes = symbol__annotation(sym);
478 struct sym_hist *h = annotation__histogram(notes, evidx);
479 u64 len = sym->end - sym->start, offset;
481 for (offset = 0; offset < len; ++offset)
482 if (h->addr[offset] != 0)
483 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
484 sym->start + offset, h->addr[offset]);
485 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
488 int symbol__annotate_printf(struct symbol *sym, struct map *map, int evidx,
489 bool full_paths, int min_pcnt, int max_lines,
492 struct dso *dso = map->dso;
493 const char *filename = dso->long_name, *d_filename;
494 struct annotation *notes = symbol__annotation(sym);
495 struct objdump_line *pos, *queue = NULL;
496 int printed = 2, queue_len = 0;
501 d_filename = filename;
503 d_filename = basename(filename);
505 len = sym->end - sym->start;
507 printf(" Percent | Source code & Disassembly of %s\n", d_filename);
508 printf("------------------------------------------------\n");
511 symbol__annotate_hits(sym, evidx);
513 list_for_each_entry(pos, ¬es->src->source, node) {
514 if (context && queue == NULL) {
519 switch (objdump_line__print(pos, sym, evidx, len, min_pcnt,
520 printed, max_lines, queue)) {
524 printed += queue_len;
530 /* filtered by max_lines */
536 * Filtered by min_pcnt or non IP lines when
541 if (queue_len == context)
542 queue = list_entry(queue->node.next, typeof(*queue), node);
552 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
554 struct annotation *notes = symbol__annotation(sym);
555 struct sym_hist *h = annotation__histogram(notes, evidx);
557 memset(h, 0, notes->src->sizeof_sym_hist);
560 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
562 struct annotation *notes = symbol__annotation(sym);
563 struct sym_hist *h = annotation__histogram(notes, evidx);
564 struct objdump_line *pos;
565 int len = sym->end - sym->start;
569 list_for_each_entry(pos, ¬es->src->source, node) {
570 if (pos->offset != -1 && pos->offset < len) {
571 h->addr[pos->offset] = h->addr[pos->offset] * 7 / 8;
572 h->sum += h->addr[pos->offset];
577 void objdump_line_list__purge(struct list_head *head)
579 struct objdump_line *pos, *n;
581 list_for_each_entry_safe(pos, n, head, node) {
582 list_del(&pos->node);
583 objdump_line__free(pos);
587 int symbol__tty_annotate(struct symbol *sym, struct map *map, int evidx,
588 bool print_lines, bool full_paths, int min_pcnt,
591 struct dso *dso = map->dso;
592 const char *filename = dso->long_name;
593 struct rb_root source_line = RB_ROOT;
596 if (symbol__annotate(sym, map, 0) < 0)
599 len = sym->end - sym->start;
602 symbol__get_source_line(sym, map, evidx, &source_line,
604 print_summary(&source_line, filename);
607 symbol__annotate_printf(sym, map, evidx, full_paths,
608 min_pcnt, max_lines, 0);
610 symbol__free_source_line(sym, len);
612 objdump_line_list__purge(&symbol__annotation(sym)->src->source);