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)
20 #include "block-range.h"
21 #include "arch/common.h"
24 #include <linux/bitops.h>
25 #include <sys/utsname.h>
27 const char *disassembler_style;
28 const char *objdump_path;
29 static regex_t file_lineno;
31 static struct ins_ops *ins__find(struct arch *arch, const char *name);
32 static void ins__sort(struct arch *arch);
33 static int disasm_line__parse(char *line, const char **namep, char **rawp);
37 struct ins *instructions;
38 size_t nr_instructions;
39 size_t nr_instructions_allocated;
40 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
41 bool sorted_instructions;
44 int (*init)(struct arch *arch);
47 char skip_functions_char;
51 static struct ins_ops call_ops;
52 static struct ins_ops dec_ops;
53 static struct ins_ops jump_ops;
54 static struct ins_ops mov_ops;
55 static struct ins_ops nop_ops;
56 static struct ins_ops lock_ops;
57 static struct ins_ops ret_ops;
59 static int arch__grow_instructions(struct arch *arch)
61 struct ins *new_instructions;
62 size_t new_nr_allocated;
64 if (arch->nr_instructions_allocated == 0 && arch->instructions)
65 goto grow_from_non_allocated_table;
67 new_nr_allocated = arch->nr_instructions_allocated + 128;
68 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
69 if (new_instructions == NULL)
72 out_update_instructions:
73 arch->instructions = new_instructions;
74 arch->nr_instructions_allocated = new_nr_allocated;
77 grow_from_non_allocated_table:
78 new_nr_allocated = arch->nr_instructions + 128;
79 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
80 if (new_instructions == NULL)
83 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
84 goto out_update_instructions;
87 static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
91 if (arch->nr_instructions == arch->nr_instructions_allocated &&
92 arch__grow_instructions(arch))
95 ins = &arch->instructions[arch->nr_instructions];
96 ins->name = strdup(name);
101 arch->nr_instructions++;
107 #include "arch/arm/annotate/instructions.c"
108 #include "arch/arm64/annotate/instructions.c"
109 #include "arch/x86/annotate/instructions.c"
110 #include "arch/powerpc/annotate/instructions.c"
112 static struct arch architectures[] = {
115 .init = arm__annotate_init,
119 .init = arm64__annotate_init,
123 .instructions = x86__instructions,
124 .nr_instructions = ARRAY_SIZE(x86__instructions),
131 .init = powerpc__annotate_init,
141 static void ins__delete(struct ins_operands *ops)
145 zfree(&ops->source.raw);
146 zfree(&ops->source.name);
147 zfree(&ops->target.raw);
148 zfree(&ops->target.name);
151 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
152 struct ins_operands *ops)
154 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->raw);
157 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
158 struct ins_operands *ops)
160 if (ins->ops->scnprintf)
161 return ins->ops->scnprintf(ins, bf, size, ops);
163 return ins__raw_scnprintf(ins, bf, size, ops);
166 static int call__parse(struct arch *arch, struct ins_operands *ops, struct map *map)
168 char *endptr, *tok, *name;
170 ops->target.addr = strtoull(ops->raw, &endptr, 16);
172 name = strchr(endptr, '<');
178 if (arch->objdump.skip_functions_char &&
179 strchr(name, arch->objdump.skip_functions_char))
182 tok = strchr(name, '>');
187 ops->target.name = strdup(name);
190 return ops->target.name == NULL ? -1 : 0;
193 tok = strchr(endptr, '*');
195 struct symbol *sym = map__find_symbol(map, map->map_ip(map, ops->target.addr));
197 ops->target.name = strdup(sym->name);
199 ops->target.addr = 0;
203 ops->target.addr = strtoull(tok + 1, NULL, 16);
207 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
208 struct ins_operands *ops)
210 if (ops->target.name)
211 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
213 if (ops->target.addr == 0)
214 return ins__raw_scnprintf(ins, bf, size, ops);
216 return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
219 static struct ins_ops call_ops = {
220 .parse = call__parse,
221 .scnprintf = call__scnprintf,
224 bool ins__is_call(const struct ins *ins)
226 return ins->ops == &call_ops;
229 static int jump__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map *map __maybe_unused)
231 const char *s = strchr(ops->raw, '+');
232 const char *c = strchr(ops->raw, ',');
235 ops->target.addr = strtoull(c, NULL, 16);
237 ops->target.addr = strtoull(ops->raw, NULL, 16);
240 ops->target.offset = strtoull(s, NULL, 16);
241 ops->target.offset_avail = true;
243 ops->target.offset_avail = false;
249 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
250 struct ins_operands *ops)
252 if (!ops->target.addr || ops->target.offset < 0)
253 return ins__raw_scnprintf(ins, bf, size, ops);
255 return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
258 static struct ins_ops jump_ops = {
259 .parse = jump__parse,
260 .scnprintf = jump__scnprintf,
263 bool ins__is_jump(const struct ins *ins)
265 return ins->ops == &jump_ops;
268 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
270 char *endptr, *name, *t;
272 if (strstr(raw, "(%rip)") == NULL)
275 *addrp = strtoull(comment, &endptr, 16);
276 name = strchr(endptr, '<');
282 t = strchr(name, '>');
287 *namep = strdup(name);
293 static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map *map)
295 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
296 if (ops->locked.ops == NULL)
299 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
302 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
304 if (ops->locked.ins.ops == NULL)
307 if (ops->locked.ins.ops->parse &&
308 ops->locked.ins.ops->parse(arch, ops->locked.ops, map) < 0)
314 zfree(&ops->locked.ops);
318 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
319 struct ins_operands *ops)
323 if (ops->locked.ins.ops == NULL)
324 return ins__raw_scnprintf(ins, bf, size, ops);
326 printed = scnprintf(bf, size, "%-6.6s ", ins->name);
327 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
328 size - printed, ops->locked.ops);
331 static void lock__delete(struct ins_operands *ops)
333 struct ins *ins = &ops->locked.ins;
335 if (ins->ops && ins->ops->free)
336 ins->ops->free(ops->locked.ops);
338 ins__delete(ops->locked.ops);
340 zfree(&ops->locked.ops);
341 zfree(&ops->target.raw);
342 zfree(&ops->target.name);
345 static struct ins_ops lock_ops = {
346 .free = lock__delete,
347 .parse = lock__parse,
348 .scnprintf = lock__scnprintf,
351 static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map *map __maybe_unused)
353 char *s = strchr(ops->raw, ','), *target, *comment, prev;
359 ops->source.raw = strdup(ops->raw);
362 if (ops->source.raw == NULL)
366 comment = strchr(s, arch->objdump.comment_char);
371 s = strchr(s, '\0') - 1;
373 while (s > target && isspace(s[0]))
379 ops->target.raw = strdup(target);
382 if (ops->target.raw == NULL)
383 goto out_free_source;
388 while (comment[0] != '\0' && isspace(comment[0]))
391 comment__symbol(ops->source.raw, comment, &ops->source.addr, &ops->source.name);
392 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
397 zfree(&ops->source.raw);
401 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
402 struct ins_operands *ops)
404 return scnprintf(bf, size, "%-6.6s %s,%s", ins->name,
405 ops->source.name ?: ops->source.raw,
406 ops->target.name ?: ops->target.raw);
409 static struct ins_ops mov_ops = {
411 .scnprintf = mov__scnprintf,
414 static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map *map __maybe_unused)
416 char *target, *comment, *s, prev;
418 target = s = ops->raw;
420 while (s[0] != '\0' && !isspace(s[0]))
425 ops->target.raw = strdup(target);
428 if (ops->target.raw == NULL)
431 comment = strchr(s, arch->objdump.comment_char);
435 while (comment[0] != '\0' && isspace(comment[0]))
438 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
443 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
444 struct ins_operands *ops)
446 return scnprintf(bf, size, "%-6.6s %s", ins->name,
447 ops->target.name ?: ops->target.raw);
450 static struct ins_ops dec_ops = {
452 .scnprintf = dec__scnprintf,
455 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
456 struct ins_operands *ops __maybe_unused)
458 return scnprintf(bf, size, "%-6.6s", "nop");
461 static struct ins_ops nop_ops = {
462 .scnprintf = nop__scnprintf,
465 static struct ins_ops ret_ops = {
466 .scnprintf = ins__raw_scnprintf,
469 bool ins__is_ret(const struct ins *ins)
471 return ins->ops == &ret_ops;
474 static int ins__key_cmp(const void *name, const void *insp)
476 const struct ins *ins = insp;
478 return strcmp(name, ins->name);
481 static int ins__cmp(const void *a, const void *b)
483 const struct ins *ia = a;
484 const struct ins *ib = b;
486 return strcmp(ia->name, ib->name);
489 static void ins__sort(struct arch *arch)
491 const int nmemb = arch->nr_instructions;
493 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
496 static struct ins_ops *__ins__find(struct arch *arch, const char *name)
499 const int nmemb = arch->nr_instructions;
501 if (!arch->sorted_instructions) {
503 arch->sorted_instructions = true;
506 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
507 return ins ? ins->ops : NULL;
510 static struct ins_ops *ins__find(struct arch *arch, const char *name)
512 struct ins_ops *ops = __ins__find(arch, name);
514 if (!ops && arch->associate_instruction_ops)
515 ops = arch->associate_instruction_ops(arch, name);
520 static int arch__key_cmp(const void *name, const void *archp)
522 const struct arch *arch = archp;
524 return strcmp(name, arch->name);
527 static int arch__cmp(const void *a, const void *b)
529 const struct arch *aa = a;
530 const struct arch *ab = b;
532 return strcmp(aa->name, ab->name);
535 static void arch__sort(void)
537 const int nmemb = ARRAY_SIZE(architectures);
539 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
542 static struct arch *arch__find(const char *name)
544 const int nmemb = ARRAY_SIZE(architectures);
552 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
555 int symbol__alloc_hist(struct symbol *sym)
557 struct annotation *notes = symbol__annotation(sym);
558 const size_t size = symbol__size(sym);
559 size_t sizeof_sym_hist;
561 /* Check for overflow when calculating sizeof_sym_hist */
562 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(u64))
565 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(u64));
567 /* Check for overflow in zalloc argument */
568 if (sizeof_sym_hist > (SIZE_MAX - sizeof(*notes->src))
569 / symbol_conf.nr_events)
572 notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
573 if (notes->src == NULL)
575 notes->src->sizeof_sym_hist = sizeof_sym_hist;
576 notes->src->nr_histograms = symbol_conf.nr_events;
577 INIT_LIST_HEAD(¬es->src->source);
581 /* The cycles histogram is lazily allocated. */
582 static int symbol__alloc_hist_cycles(struct symbol *sym)
584 struct annotation *notes = symbol__annotation(sym);
585 const size_t size = symbol__size(sym);
587 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
588 if (notes->src->cycles_hist == NULL)
593 void symbol__annotate_zero_histograms(struct symbol *sym)
595 struct annotation *notes = symbol__annotation(sym);
597 pthread_mutex_lock(¬es->lock);
598 if (notes->src != NULL) {
599 memset(notes->src->histograms, 0,
600 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
601 if (notes->src->cycles_hist)
602 memset(notes->src->cycles_hist, 0,
603 symbol__size(sym) * sizeof(struct cyc_hist));
605 pthread_mutex_unlock(¬es->lock);
608 static int __symbol__account_cycles(struct annotation *notes,
610 unsigned offset, unsigned cycles,
615 ch = notes->src->cycles_hist;
617 * For now we can only account one basic block per
618 * final jump. But multiple could be overlapping.
619 * Always account the longest one. So when
620 * a shorter one has been already seen throw it away.
622 * We separately always account the full cycles.
624 ch[offset].num_aggr++;
625 ch[offset].cycles_aggr += cycles;
627 if (!have_start && ch[offset].have_start)
629 if (ch[offset].num) {
630 if (have_start && (!ch[offset].have_start ||
631 ch[offset].start > start)) {
632 ch[offset].have_start = 0;
633 ch[offset].cycles = 0;
635 if (ch[offset].reset < 0xffff)
637 } else if (have_start &&
638 ch[offset].start < start)
641 ch[offset].have_start = have_start;
642 ch[offset].start = start;
643 ch[offset].cycles += cycles;
648 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
649 struct annotation *notes, int evidx, u64 addr)
654 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
656 if ((addr < sym->start || addr >= sym->end) &&
657 (addr != sym->end || sym->start != sym->end)) {
658 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
659 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
663 offset = addr - sym->start;
664 h = annotation__histogram(notes, evidx);
668 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
669 ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
670 addr, addr - sym->start, evidx, h->addr[offset]);
674 static struct annotation *symbol__get_annotation(struct symbol *sym, bool cycles)
676 struct annotation *notes = symbol__annotation(sym);
678 if (notes->src == NULL) {
679 if (symbol__alloc_hist(sym) < 0)
682 if (!notes->src->cycles_hist && cycles) {
683 if (symbol__alloc_hist_cycles(sym) < 0)
689 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
692 struct annotation *notes;
696 notes = symbol__get_annotation(sym, false);
699 return __symbol__inc_addr_samples(sym, map, notes, evidx, addr);
702 static int symbol__account_cycles(u64 addr, u64 start,
703 struct symbol *sym, unsigned cycles)
705 struct annotation *notes;
710 notes = symbol__get_annotation(sym, true);
713 if (addr < sym->start || addr >= sym->end)
717 if (start < sym->start || start >= sym->end)
722 offset = addr - sym->start;
723 return __symbol__account_cycles(notes,
724 start ? start - sym->start : 0,
729 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
730 struct addr_map_symbol *start,
740 * Only set start when IPC can be computed. We can only
741 * compute it when the basic block is completely in a single
743 * Special case the case when the jump is elsewhere, but
744 * it starts on the function start.
747 (start->sym == ams->sym ||
749 start->addr == ams->sym->start + ams->map->start)))
750 saddr = start->al_addr;
752 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
754 start ? start->addr : 0,
755 ams->sym ? ams->sym->start + ams->map->start : 0,
757 err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
759 pr_debug2("account_cycles failed %d\n", err);
763 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx)
765 return symbol__inc_addr_samples(ams->sym, ams->map, evidx, ams->al_addr);
768 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 ip)
770 return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evidx, ip);
773 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map *map)
775 dl->ins.ops = ins__find(arch, dl->ins.name);
780 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, map) < 0)
784 static int disasm_line__parse(char *line, const char **namep, char **rawp)
786 char *name = line, tmp;
788 while (isspace(name[0]))
796 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
801 *namep = strdup(name);
808 if ((*rawp)[0] != '\0') {
810 while (isspace((*rawp)[0]))
822 static struct disasm_line *disasm_line__new(s64 offset, char *line,
823 size_t privsize, int line_nr,
827 struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
831 dl->line = strdup(line);
832 dl->line_nr = line_nr;
833 if (dl->line == NULL)
837 if (disasm_line__parse(dl->line, &dl->ins.name, &dl->ops.raw) < 0)
840 disasm_line__init_ins(dl, arch, map);
853 void disasm_line__free(struct disasm_line *dl)
856 if (dl->ins.ops && dl->ins.ops->free)
857 dl->ins.ops->free(&dl->ops);
859 ins__delete(&dl->ops);
860 free((void *)dl->ins.name);
865 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
867 if (raw || !dl->ins.ops)
868 return scnprintf(bf, size, "%-6.6s %s", dl->ins.name, dl->ops.raw);
870 return ins__scnprintf(&dl->ins, bf, size, &dl->ops);
873 static void disasm__add(struct list_head *head, struct disasm_line *line)
875 list_add_tail(&line->node, head);
878 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
880 list_for_each_entry_continue(pos, head, node)
881 if (pos->offset >= 0)
887 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
888 s64 end, const char **path, u64 *nr_samples)
890 struct source_line *src_line = notes->src->lines;
891 double percent = 0.0;
895 size_t sizeof_src_line = sizeof(*src_line) +
896 sizeof(src_line->samples) * (src_line->nr_pcnt - 1);
898 while (offset < end) {
899 src_line = (void *)notes->src->lines +
900 (sizeof_src_line * offset);
903 *path = src_line->path;
905 percent += src_line->samples[evidx].percent;
906 *nr_samples += src_line->samples[evidx].nr;
910 struct sym_hist *h = annotation__histogram(notes, evidx);
911 unsigned int hits = 0;
914 hits += h->addr[offset++];
918 percent = 100.0 * hits / h->sum;
925 static const char *annotate__address_color(struct block_range *br)
927 double cov = block_range__coverage(br);
930 /* mark red for >75% coverage */
932 return PERF_COLOR_RED;
934 /* mark dull for <1% coverage */
936 return PERF_COLOR_NORMAL;
939 return PERF_COLOR_MAGENTA;
942 static const char *annotate__asm_color(struct block_range *br)
944 double cov = block_range__coverage(br);
947 /* mark dull for <1% coverage */
949 return PERF_COLOR_NORMAL;
952 return PERF_COLOR_BLUE;
955 static void annotate__branch_printf(struct block_range *br, u64 addr)
957 bool emit_comment = true;
963 if (br->is_target && br->start == addr) {
964 struct block_range *branch = br;
968 * Find matching branch to our target.
970 while (!branch->is_branch)
971 branch = block_range__next(branch);
973 p = 100 *(double)br->entry / branch->coverage;
977 emit_comment = false;
982 * The percentage of coverage joined at this target in relation
983 * to the next branch.
985 printf(" +%.2f%%", p);
989 if (br->is_branch && br->end == addr) {
990 double p = 100*(double)br->taken / br->coverage;
994 emit_comment = false;
999 * The percentage of coverage leaving at this branch, and
1000 * its prediction ratio.
1002 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1008 static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
1009 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
1010 int max_lines, struct disasm_line *queue)
1012 static const char *prev_line;
1013 static const char *prev_color;
1015 if (dl->offset != -1) {
1016 const char *path = NULL;
1018 double percent, max_percent = 0.0;
1019 double *ppercents = &percent;
1020 u64 *psamples = &nr_samples;
1021 int i, nr_percent = 1;
1023 struct annotation *notes = symbol__annotation(sym);
1024 s64 offset = dl->offset;
1025 const u64 addr = start + offset;
1026 struct disasm_line *next;
1027 struct block_range *br;
1029 next = disasm__get_next_ip_line(¬es->src->source, dl);
1031 if (perf_evsel__is_group_event(evsel)) {
1032 nr_percent = evsel->nr_members;
1033 ppercents = calloc(nr_percent, sizeof(double));
1034 psamples = calloc(nr_percent, sizeof(u64));
1035 if (ppercents == NULL || psamples == NULL) {
1040 for (i = 0; i < nr_percent; i++) {
1041 percent = disasm__calc_percent(notes,
1042 notes->src->lines ? i : evsel->idx + i,
1044 next ? next->offset : (s64) len,
1045 &path, &nr_samples);
1047 ppercents[i] = percent;
1048 psamples[i] = nr_samples;
1049 if (percent > max_percent)
1050 max_percent = percent;
1053 if (max_percent < min_pcnt)
1056 if (max_lines && printed >= max_lines)
1059 if (queue != NULL) {
1060 list_for_each_entry_from(queue, ¬es->src->source, node) {
1063 disasm_line__print(queue, sym, start, evsel, len,
1068 color = get_percent_color(max_percent);
1071 * Also color the filename and line if needed, with
1072 * the same color than the percentage. Don't print it
1073 * twice for close colored addr with the same filename:line
1076 if (!prev_line || strcmp(prev_line, path)
1077 || color != prev_color) {
1078 color_fprintf(stdout, color, " %s", path);
1084 for (i = 0; i < nr_percent; i++) {
1085 percent = ppercents[i];
1086 nr_samples = psamples[i];
1087 color = get_percent_color(percent);
1089 if (symbol_conf.show_total_period)
1090 color_fprintf(stdout, color, " %7" PRIu64,
1093 color_fprintf(stdout, color, " %7.2f", percent);
1098 br = block_range__find(addr);
1099 color_fprintf(stdout, annotate__address_color(br), " %" PRIx64 ":", addr);
1100 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->line);
1101 annotate__branch_printf(br, addr);
1104 if (ppercents != &percent)
1107 if (psamples != &nr_samples)
1110 } else if (max_lines && printed >= max_lines)
1118 if (perf_evsel__is_group_event(evsel))
1119 width *= evsel->nr_members;
1122 printf(" %*s:\n", width, " ");
1124 printf(" %*s: %s\n", width, " ", dl->line);
1131 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1132 * which looks like following
1134 * 0000000000415500 <_init>:
1135 * 415500: sub $0x8,%rsp
1136 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1137 * 41550b: test %rax,%rax
1138 * 41550e: je 415515 <_init+0x15>
1139 * 415510: callq 416e70 <__gmon_start__@plt>
1140 * 415515: add $0x8,%rsp
1143 * it will be parsed and saved into struct disasm_line as
1144 * <offset> <name> <ops.raw>
1146 * The offset will be a relative offset from the start of the symbol and -1
1147 * means that it's not a disassembly line so should be treated differently.
1148 * The ops.raw part will be parsed further according to type of the instruction.
1150 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
1152 FILE *file, size_t privsize,
1155 struct annotation *notes = symbol__annotation(sym);
1156 struct disasm_line *dl;
1157 char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
1159 s64 line_ip, offset = -1;
1160 regmatch_t match[2];
1162 if (getline(&line, &line_len, file) < 0)
1168 while (line_len != 0 && isspace(line[line_len - 1]))
1169 line[--line_len] = '\0';
1171 c = strchr(line, '\n');
1178 /* /filename:linenr ? Save line number and ignore. */
1179 if (regexec(&file_lineno, line, 2, match, 0) == 0) {
1180 *line_nr = atoi(line + match[1].rm_so);
1185 * Strip leading spaces:
1196 * Parse hexa addresses followed by ':'
1198 line_ip = strtoull(tmp, &tmp2, 16);
1199 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1203 if (line_ip != -1) {
1204 u64 start = map__rip_2objdump(map, sym->start),
1205 end = map__rip_2objdump(map, sym->end);
1207 offset = line_ip - start;
1208 if ((u64)line_ip < start || (u64)line_ip >= end)
1211 parsed_line = tmp2 + 1;
1214 dl = disasm_line__new(offset, parsed_line, privsize, *line_nr, arch, map);
1221 if (!disasm_line__has_offset(dl)) {
1222 dl->ops.target.offset = dl->ops.target.addr -
1223 map__rip_2objdump(map, sym->start);
1224 dl->ops.target.offset_avail = true;
1227 /* kcore has no symbols, so add the call target name */
1228 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.name) {
1229 struct addr_map_symbol target = {
1231 .addr = dl->ops.target.addr,
1234 if (!map_groups__find_ams(&target) &&
1235 target.sym->start == target.al_addr)
1236 dl->ops.target.name = strdup(target.sym->name);
1239 disasm__add(¬es->src->source, dl);
1244 static __attribute__((constructor)) void symbol__init_regexpr(void)
1246 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1249 static void delete_last_nop(struct symbol *sym)
1251 struct annotation *notes = symbol__annotation(sym);
1252 struct list_head *list = ¬es->src->source;
1253 struct disasm_line *dl;
1255 while (!list_empty(list)) {
1256 dl = list_entry(list->prev, struct disasm_line, node);
1259 if (dl->ins.ops != &nop_ops)
1262 if (!strstr(dl->line, " nop ") &&
1263 !strstr(dl->line, " nopl ") &&
1264 !strstr(dl->line, " nopw "))
1268 list_del(&dl->node);
1269 disasm_line__free(dl);
1273 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1274 int errnum, char *buf, size_t buflen)
1276 struct dso *dso = map->dso;
1278 BUG_ON(buflen == 0);
1281 str_error_r(errnum, buf, buflen);
1286 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1287 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1288 char *build_id_msg = NULL;
1290 if (dso->has_build_id) {
1291 build_id__sprintf(dso->build_id,
1292 sizeof(dso->build_id), bf + 15);
1295 scnprintf(buf, buflen,
1296 "No vmlinux file%s\nwas found in the path.\n\n"
1297 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1299 " perf buildid-cache -vu vmlinux\n\n"
1301 " --vmlinux vmlinux\n", build_id_msg ?: "");
1305 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1312 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1314 char linkname[PATH_MAX];
1315 char *build_id_filename;
1316 char *build_id_path = NULL;
1318 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1319 !dso__is_kcore(dso))
1320 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1322 build_id_filename = dso__build_id_filename(dso, NULL, 0);
1323 if (build_id_filename) {
1324 __symbol__join_symfs(filename, filename_size, build_id_filename);
1325 free(build_id_filename);
1327 if (dso->has_build_id)
1332 build_id_path = strdup(filename);
1336 dirname(build_id_path);
1338 if (dso__is_kcore(dso) ||
1339 readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1340 strstr(linkname, DSO__NAME_KALLSYMS) ||
1341 access(filename, R_OK)) {
1344 * If we don't have build-ids or the build-id file isn't in the
1345 * cache, or is just a kallsyms file, well, lets hope that this
1346 * DSO is the same as when 'perf record' ran.
1348 __symbol__join_symfs(filename, filename_size, dso->long_name);
1351 free(build_id_path);
1355 static const char *annotate__norm_arch(const char *arch_name)
1359 if (!arch_name) { /* Assume we are annotating locally. */
1360 if (uname(&uts) < 0)
1362 arch_name = uts.machine;
1364 return normalize_arch((char *)arch_name);
1367 int symbol__disassemble(struct symbol *sym, struct map *map, const char *arch_name, size_t privsize)
1369 struct dso *dso = map->dso;
1370 char command[PATH_MAX * 2];
1371 struct arch *arch = NULL;
1373 char symfs_filename[PATH_MAX];
1374 struct kcore_extract kce;
1375 bool delete_extract = false;
1380 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1385 arch_name = annotate__norm_arch(arch_name);
1389 arch = arch__find(arch_name);
1394 err = arch->init(arch);
1396 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
1401 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1402 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1403 map->unmap_ip(map, sym->end));
1405 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1406 dso, dso->long_name, sym, sym->name);
1408 if (dso__is_kcore(dso)) {
1409 kce.kcore_filename = symfs_filename;
1410 kce.addr = map__rip_2objdump(map, sym->start);
1411 kce.offs = sym->start;
1412 kce.len = sym->end - sym->start;
1413 if (!kcore_extract__create(&kce)) {
1414 delete_extract = true;
1415 strlcpy(symfs_filename, kce.extract_filename,
1416 sizeof(symfs_filename));
1418 } else if (dso__needs_decompress(dso)) {
1424 if (kmod_path__parse_ext(&m, symfs_filename))
1427 snprintf(tmp, PATH_MAX, "/tmp/perf-kmod-XXXXXX");
1435 ret = decompress_to_file(m.ext, symfs_filename, fd);
1438 pr_err("Cannot decompress %s %s\n", m.ext, symfs_filename);
1446 strcpy(symfs_filename, tmp);
1449 snprintf(command, sizeof(command),
1450 "%s %s%s --start-address=0x%016" PRIx64
1451 " --stop-address=0x%016" PRIx64
1452 " -l -d %s %s -C %s 2>/dev/null|grep -v %s:|expand",
1453 objdump_path ? objdump_path : "objdump",
1454 disassembler_style ? "-M " : "",
1455 disassembler_style ? disassembler_style : "",
1456 map__rip_2objdump(map, sym->start),
1457 map__rip_2objdump(map, sym->end),
1458 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
1459 symbol_conf.annotate_src ? "-S" : "",
1460 symfs_filename, symfs_filename);
1462 pr_debug("Executing: %s\n", command);
1465 if (pipe(stdout_fd) < 0) {
1466 pr_err("Failure creating the pipe to run %s\n", command);
1467 goto out_remove_tmp;
1472 pr_err("Failure forking to run %s\n", command);
1473 goto out_close_stdout;
1477 close(stdout_fd[0]);
1478 dup2(stdout_fd[1], 1);
1479 close(stdout_fd[1]);
1480 execl("/bin/sh", "sh", "-c", command, NULL);
1485 close(stdout_fd[1]);
1487 file = fdopen(stdout_fd[0], "r");
1489 pr_err("Failure creating FILE stream for %s\n", command);
1491 * If we were using debug info should retry with
1494 goto out_remove_tmp;
1498 while (!feof(file)) {
1500 * The source code line number (lineno) needs to be kept in
1501 * accross calls to symbol__parse_objdump_line(), so that it
1502 * can associate it with the instructions till the next one.
1503 * See disasm_line__new() and struct disasm_line::line_nr.
1505 if (symbol__parse_objdump_line(sym, map, arch, file, privsize,
1512 pr_err("No output from %s\n", command);
1515 * kallsyms does not have symbol sizes so there may a nop at the end.
1518 if (dso__is_kcore(dso))
1519 delete_last_nop(sym);
1524 close(stdout_fd[0]);
1526 if (dso__needs_decompress(dso))
1527 unlink(symfs_filename);
1530 kcore_extract__delete(&kce);
1535 close(stdout_fd[1]);
1536 goto out_remove_tmp;
1539 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
1541 struct source_line *iter;
1542 struct rb_node **p = &root->rb_node;
1543 struct rb_node *parent = NULL;
1546 while (*p != NULL) {
1548 iter = rb_entry(parent, struct source_line, node);
1550 ret = strcmp(iter->path, src_line->path);
1552 for (i = 0; i < src_line->nr_pcnt; i++)
1553 iter->samples[i].percent_sum += src_line->samples[i].percent;
1560 p = &(*p)->rb_right;
1563 for (i = 0; i < src_line->nr_pcnt; i++)
1564 src_line->samples[i].percent_sum = src_line->samples[i].percent;
1566 rb_link_node(&src_line->node, parent, p);
1567 rb_insert_color(&src_line->node, root);
1570 static int cmp_source_line(struct source_line *a, struct source_line *b)
1574 for (i = 0; i < a->nr_pcnt; i++) {
1575 if (a->samples[i].percent_sum == b->samples[i].percent_sum)
1577 return a->samples[i].percent_sum > b->samples[i].percent_sum;
1583 static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
1585 struct source_line *iter;
1586 struct rb_node **p = &root->rb_node;
1587 struct rb_node *parent = NULL;
1589 while (*p != NULL) {
1591 iter = rb_entry(parent, struct source_line, node);
1593 if (cmp_source_line(src_line, iter))
1596 p = &(*p)->rb_right;
1599 rb_link_node(&src_line->node, parent, p);
1600 rb_insert_color(&src_line->node, root);
1603 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1605 struct source_line *src_line;
1606 struct rb_node *node;
1608 node = rb_first(src_root);
1610 struct rb_node *next;
1612 src_line = rb_entry(node, struct source_line, node);
1613 next = rb_next(node);
1614 rb_erase(node, src_root);
1616 __resort_source_line(dest_root, src_line);
1621 static void symbol__free_source_line(struct symbol *sym, int len)
1623 struct annotation *notes = symbol__annotation(sym);
1624 struct source_line *src_line = notes->src->lines;
1625 size_t sizeof_src_line;
1628 sizeof_src_line = sizeof(*src_line) +
1629 (sizeof(src_line->samples) * (src_line->nr_pcnt - 1));
1631 for (i = 0; i < len; i++) {
1632 free_srcline(src_line->path);
1633 src_line = (void *)src_line + sizeof_src_line;
1636 zfree(¬es->src->lines);
1639 /* Get the filename:line for the colored entries */
1640 static int symbol__get_source_line(struct symbol *sym, struct map *map,
1641 struct perf_evsel *evsel,
1642 struct rb_root *root, int len)
1646 int evidx = evsel->idx;
1647 struct source_line *src_line;
1648 struct annotation *notes = symbol__annotation(sym);
1649 struct sym_hist *h = annotation__histogram(notes, evidx);
1650 struct rb_root tmp_root = RB_ROOT;
1653 size_t sizeof_src_line = sizeof(struct source_line);
1655 if (perf_evsel__is_group_event(evsel)) {
1656 for (i = 1; i < evsel->nr_members; i++) {
1657 h = annotation__histogram(notes, evidx + i);
1660 nr_pcnt = evsel->nr_members;
1661 sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->samples);
1667 src_line = notes->src->lines = calloc(len, sizeof_src_line);
1668 if (!notes->src->lines)
1671 start = map__rip_2objdump(map, sym->start);
1673 for (i = 0; i < len; i++) {
1674 u64 offset, nr_samples;
1675 double percent_max = 0.0;
1677 src_line->nr_pcnt = nr_pcnt;
1679 for (k = 0; k < nr_pcnt; k++) {
1680 double percent = 0.0;
1682 h = annotation__histogram(notes, evidx + k);
1683 nr_samples = h->addr[i];
1685 percent = 100.0 * nr_samples / h->sum;
1687 if (percent > percent_max)
1688 percent_max = percent;
1689 src_line->samples[k].percent = percent;
1690 src_line->samples[k].nr = nr_samples;
1693 if (percent_max <= 0.5)
1697 src_line->path = get_srcline(map->dso, offset, NULL,
1699 insert_source_line(&tmp_root, src_line);
1702 src_line = (void *)src_line + sizeof_src_line;
1705 resort_source_line(root, &tmp_root);
1709 static void print_summary(struct rb_root *root, const char *filename)
1711 struct source_line *src_line;
1712 struct rb_node *node;
1714 printf("\nSorted summary for file %s\n", filename);
1715 printf("----------------------------------------------\n\n");
1717 if (RB_EMPTY_ROOT(root)) {
1718 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1722 node = rb_first(root);
1724 double percent, percent_max = 0.0;
1729 src_line = rb_entry(node, struct source_line, node);
1730 for (i = 0; i < src_line->nr_pcnt; i++) {
1731 percent = src_line->samples[i].percent_sum;
1732 color = get_percent_color(percent);
1733 color_fprintf(stdout, color, " %7.2f", percent);
1735 if (percent > percent_max)
1736 percent_max = percent;
1739 path = src_line->path;
1740 color = get_percent_color(percent_max);
1741 color_fprintf(stdout, color, " %s\n", path);
1743 node = rb_next(node);
1747 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1749 struct annotation *notes = symbol__annotation(sym);
1750 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1751 u64 len = symbol__size(sym), offset;
1753 for (offset = 0; offset < len; ++offset)
1754 if (h->addr[offset] != 0)
1755 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1756 sym->start + offset, h->addr[offset]);
1757 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1760 int symbol__annotate_printf(struct symbol *sym, struct map *map,
1761 struct perf_evsel *evsel, bool full_paths,
1762 int min_pcnt, int max_lines, int context)
1764 struct dso *dso = map->dso;
1766 const char *d_filename;
1767 const char *evsel_name = perf_evsel__name(evsel);
1768 struct annotation *notes = symbol__annotation(sym);
1769 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1770 struct disasm_line *pos, *queue = NULL;
1771 u64 start = map__rip_2objdump(map, sym->start);
1772 int printed = 2, queue_len = 0;
1776 int graph_dotted_len;
1778 filename = strdup(dso->long_name);
1783 d_filename = filename;
1785 d_filename = basename(filename);
1787 len = symbol__size(sym);
1789 if (perf_evsel__is_group_event(evsel))
1790 width *= evsel->nr_members;
1792 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples)\n",
1793 width, width, "Percent", d_filename, evsel_name, h->sum);
1795 printf("%-*.*s----\n",
1796 graph_dotted_len, graph_dotted_len, graph_dotted_line);
1799 symbol__annotate_hits(sym, evsel);
1801 list_for_each_entry(pos, ¬es->src->source, node) {
1802 if (context && queue == NULL) {
1807 switch (disasm_line__print(pos, sym, start, evsel, len,
1808 min_pcnt, printed, max_lines,
1813 printed += queue_len;
1819 /* filtered by max_lines */
1825 * Filtered by min_pcnt or non IP lines when
1830 if (queue_len == context)
1831 queue = list_entry(queue->node.next, typeof(*queue), node);
1843 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1845 struct annotation *notes = symbol__annotation(sym);
1846 struct sym_hist *h = annotation__histogram(notes, evidx);
1848 memset(h, 0, notes->src->sizeof_sym_hist);
1851 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1853 struct annotation *notes = symbol__annotation(sym);
1854 struct sym_hist *h = annotation__histogram(notes, evidx);
1855 int len = symbol__size(sym), offset;
1858 for (offset = 0; offset < len; ++offset) {
1859 h->addr[offset] = h->addr[offset] * 7 / 8;
1860 h->sum += h->addr[offset];
1864 void disasm__purge(struct list_head *head)
1866 struct disasm_line *pos, *n;
1868 list_for_each_entry_safe(pos, n, head, node) {
1869 list_del(&pos->node);
1870 disasm_line__free(pos);
1874 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1878 if (dl->offset == -1)
1879 return fprintf(fp, "%s\n", dl->line);
1881 printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->ins.name);
1883 if (dl->ops.raw[0] != '\0') {
1884 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1888 return printed + fprintf(fp, "\n");
1891 size_t disasm__fprintf(struct list_head *head, FILE *fp)
1893 struct disasm_line *pos;
1896 list_for_each_entry(pos, head, node)
1897 printed += disasm_line__fprintf(pos, fp);
1902 int symbol__tty_annotate(struct symbol *sym, struct map *map,
1903 struct perf_evsel *evsel, bool print_lines,
1904 bool full_paths, int min_pcnt, int max_lines)
1906 struct dso *dso = map->dso;
1907 struct rb_root source_line = RB_ROOT;
1910 if (symbol__disassemble(sym, map, perf_evsel__env_arch(evsel), 0) < 0)
1913 len = symbol__size(sym);
1916 srcline_full_filename = full_paths;
1917 symbol__get_source_line(sym, map, evsel, &source_line, len);
1918 print_summary(&source_line, dso->long_name);
1921 symbol__annotate_printf(sym, map, evsel, full_paths,
1922 min_pcnt, max_lines, 0);
1924 symbol__free_source_line(sym, len);
1926 disasm__purge(&symbol__annotation(sym)->src->source);
1931 bool ui__has_annotation(void)
1933 return use_browser == 1 && perf_hpp_list.sym;