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"
23 #include <linux/bitops.h>
25 const char *disassembler_style;
26 const char *objdump_path;
27 static regex_t file_lineno;
29 static struct ins *ins__find(const char *name);
30 static int disasm_line__parse(char *line, char **namep, char **rawp);
32 static void ins__delete(struct ins_operands *ops)
36 zfree(&ops->source.raw);
37 zfree(&ops->source.name);
38 zfree(&ops->target.raw);
39 zfree(&ops->target.name);
42 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
43 struct ins_operands *ops)
45 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->raw);
48 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
49 struct ins_operands *ops)
51 if (ins->ops->scnprintf)
52 return ins->ops->scnprintf(ins, bf, size, ops);
54 return ins__raw_scnprintf(ins, bf, size, ops);
57 static int call__parse(struct ins_operands *ops, struct map *map)
59 char *endptr, *tok, *name;
61 ops->target.addr = strtoull(ops->raw, &endptr, 16);
63 name = strchr(endptr, '<');
70 if (strchr(name, '+'))
74 tok = strchr(name, '>');
79 ops->target.name = strdup(name);
82 return ops->target.name == NULL ? -1 : 0;
85 tok = strchr(endptr, '*');
87 struct symbol *sym = map__find_symbol(map, map->map_ip(map, ops->target.addr));
89 ops->target.name = strdup(sym->name);
95 ops->target.addr = strtoull(tok + 1, NULL, 16);
99 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
100 struct ins_operands *ops)
102 if (ops->target.name)
103 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
105 if (ops->target.addr == 0)
106 return ins__raw_scnprintf(ins, bf, size, ops);
108 return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
111 static struct ins_ops call_ops = {
112 .parse = call__parse,
113 .scnprintf = call__scnprintf,
116 bool ins__is_call(const struct ins *ins)
118 return ins->ops == &call_ops;
121 static int jump__parse(struct ins_operands *ops, struct map *map __maybe_unused)
123 const char *s = strchr(ops->raw, '+');
125 ops->target.addr = strtoull(ops->raw, NULL, 16);
128 ops->target.offset = strtoull(s, NULL, 16);
130 ops->target.offset = UINT64_MAX;
135 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
136 struct ins_operands *ops)
138 return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
141 static struct ins_ops jump_ops = {
142 .parse = jump__parse,
143 .scnprintf = jump__scnprintf,
146 bool ins__is_jump(const struct ins *ins)
148 return ins->ops == &jump_ops;
151 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
153 char *endptr, *name, *t;
155 if (strstr(raw, "(%rip)") == NULL)
158 *addrp = strtoull(comment, &endptr, 16);
159 name = strchr(endptr, '<');
165 t = strchr(name, '>');
170 *namep = strdup(name);
176 static int lock__parse(struct ins_operands *ops, struct map *map)
180 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
181 if (ops->locked.ops == NULL)
184 if (disasm_line__parse(ops->raw, &name, &ops->locked.ops->raw) < 0)
187 ops->locked.ins = ins__find(name);
190 if (ops->locked.ins == NULL)
193 if (!ops->locked.ins->ops)
196 if (ops->locked.ins->ops->parse &&
197 ops->locked.ins->ops->parse(ops->locked.ops, map) < 0)
203 zfree(&ops->locked.ops);
207 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
208 struct ins_operands *ops)
212 if (ops->locked.ins == NULL)
213 return ins__raw_scnprintf(ins, bf, size, ops);
215 printed = scnprintf(bf, size, "%-6.6s ", ins->name);
216 return printed + ins__scnprintf(ops->locked.ins, bf + printed,
217 size - printed, ops->locked.ops);
220 static void lock__delete(struct ins_operands *ops)
222 struct ins *ins = ops->locked.ins;
224 if (ins && ins->ops->free)
225 ins->ops->free(ops->locked.ops);
227 ins__delete(ops->locked.ops);
229 zfree(&ops->locked.ops);
230 zfree(&ops->target.raw);
231 zfree(&ops->target.name);
234 static struct ins_ops lock_ops = {
235 .free = lock__delete,
236 .parse = lock__parse,
237 .scnprintf = lock__scnprintf,
240 static int mov__parse(struct ins_operands *ops, struct map *map __maybe_unused)
242 char *s = strchr(ops->raw, ','), *target, *comment, prev;
248 ops->source.raw = strdup(ops->raw);
251 if (ops->source.raw == NULL)
256 comment = strchr(s, ';');
258 comment = strchr(s, '#');
264 s = strchr(s, '\0') - 1;
266 while (s > target && isspace(s[0]))
272 ops->target.raw = strdup(target);
275 if (ops->target.raw == NULL)
276 goto out_free_source;
281 while (comment[0] != '\0' && isspace(comment[0]))
284 comment__symbol(ops->source.raw, comment, &ops->source.addr, &ops->source.name);
285 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
290 zfree(&ops->source.raw);
294 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
295 struct ins_operands *ops)
297 return scnprintf(bf, size, "%-6.6s %s,%s", ins->name,
298 ops->source.name ?: ops->source.raw,
299 ops->target.name ?: ops->target.raw);
302 static struct ins_ops mov_ops = {
304 .scnprintf = mov__scnprintf,
307 static int dec__parse(struct ins_operands *ops, struct map *map __maybe_unused)
309 char *target, *comment, *s, prev;
311 target = s = ops->raw;
313 while (s[0] != '\0' && !isspace(s[0]))
318 ops->target.raw = strdup(target);
321 if (ops->target.raw == NULL)
324 comment = strchr(s, '#');
328 while (comment[0] != '\0' && isspace(comment[0]))
331 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
336 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
337 struct ins_operands *ops)
339 return scnprintf(bf, size, "%-6.6s %s", ins->name,
340 ops->target.name ?: ops->target.raw);
343 static struct ins_ops dec_ops = {
345 .scnprintf = dec__scnprintf,
348 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
349 struct ins_operands *ops __maybe_unused)
351 return scnprintf(bf, size, "%-6.6s", "nop");
354 static struct ins_ops nop_ops = {
355 .scnprintf = nop__scnprintf,
358 static struct ins_ops ret_ops = {
359 .scnprintf = ins__raw_scnprintf,
362 bool ins__is_ret(const struct ins *ins)
364 return ins->ops == &ret_ops;
367 static struct ins instructions[] = {
368 { .name = "add", .ops = &mov_ops, },
369 { .name = "addl", .ops = &mov_ops, },
370 { .name = "addq", .ops = &mov_ops, },
371 { .name = "addw", .ops = &mov_ops, },
372 { .name = "and", .ops = &mov_ops, },
374 { .name = "b", .ops = &jump_ops, }, // might also be a call
375 { .name = "bcc", .ops = &jump_ops, },
376 { .name = "bcs", .ops = &jump_ops, },
377 { .name = "beq", .ops = &jump_ops, },
378 { .name = "bge", .ops = &jump_ops, },
379 { .name = "bgt", .ops = &jump_ops, },
380 { .name = "bhi", .ops = &jump_ops, },
381 { .name = "bl", .ops = &call_ops, },
382 { .name = "bls", .ops = &jump_ops, },
383 { .name = "blt", .ops = &jump_ops, },
384 { .name = "blx", .ops = &call_ops, },
385 { .name = "bne", .ops = &jump_ops, },
387 { .name = "bts", .ops = &mov_ops, },
388 { .name = "call", .ops = &call_ops, },
389 { .name = "callq", .ops = &call_ops, },
390 { .name = "cmp", .ops = &mov_ops, },
391 { .name = "cmpb", .ops = &mov_ops, },
392 { .name = "cmpl", .ops = &mov_ops, },
393 { .name = "cmpq", .ops = &mov_ops, },
394 { .name = "cmpw", .ops = &mov_ops, },
395 { .name = "cmpxch", .ops = &mov_ops, },
396 { .name = "dec", .ops = &dec_ops, },
397 { .name = "decl", .ops = &dec_ops, },
398 { .name = "imul", .ops = &mov_ops, },
399 { .name = "inc", .ops = &dec_ops, },
400 { .name = "incl", .ops = &dec_ops, },
401 { .name = "ja", .ops = &jump_ops, },
402 { .name = "jae", .ops = &jump_ops, },
403 { .name = "jb", .ops = &jump_ops, },
404 { .name = "jbe", .ops = &jump_ops, },
405 { .name = "jc", .ops = &jump_ops, },
406 { .name = "jcxz", .ops = &jump_ops, },
407 { .name = "je", .ops = &jump_ops, },
408 { .name = "jecxz", .ops = &jump_ops, },
409 { .name = "jg", .ops = &jump_ops, },
410 { .name = "jge", .ops = &jump_ops, },
411 { .name = "jl", .ops = &jump_ops, },
412 { .name = "jle", .ops = &jump_ops, },
413 { .name = "jmp", .ops = &jump_ops, },
414 { .name = "jmpq", .ops = &jump_ops, },
415 { .name = "jna", .ops = &jump_ops, },
416 { .name = "jnae", .ops = &jump_ops, },
417 { .name = "jnb", .ops = &jump_ops, },
418 { .name = "jnbe", .ops = &jump_ops, },
419 { .name = "jnc", .ops = &jump_ops, },
420 { .name = "jne", .ops = &jump_ops, },
421 { .name = "jng", .ops = &jump_ops, },
422 { .name = "jnge", .ops = &jump_ops, },
423 { .name = "jnl", .ops = &jump_ops, },
424 { .name = "jnle", .ops = &jump_ops, },
425 { .name = "jno", .ops = &jump_ops, },
426 { .name = "jnp", .ops = &jump_ops, },
427 { .name = "jns", .ops = &jump_ops, },
428 { .name = "jnz", .ops = &jump_ops, },
429 { .name = "jo", .ops = &jump_ops, },
430 { .name = "jp", .ops = &jump_ops, },
431 { .name = "jpe", .ops = &jump_ops, },
432 { .name = "jpo", .ops = &jump_ops, },
433 { .name = "jrcxz", .ops = &jump_ops, },
434 { .name = "js", .ops = &jump_ops, },
435 { .name = "jz", .ops = &jump_ops, },
436 { .name = "lea", .ops = &mov_ops, },
437 { .name = "lock", .ops = &lock_ops, },
438 { .name = "mov", .ops = &mov_ops, },
439 { .name = "movb", .ops = &mov_ops, },
440 { .name = "movdqa",.ops = &mov_ops, },
441 { .name = "movl", .ops = &mov_ops, },
442 { .name = "movq", .ops = &mov_ops, },
443 { .name = "movslq", .ops = &mov_ops, },
444 { .name = "movzbl", .ops = &mov_ops, },
445 { .name = "movzwl", .ops = &mov_ops, },
446 { .name = "nop", .ops = &nop_ops, },
447 { .name = "nopl", .ops = &nop_ops, },
448 { .name = "nopw", .ops = &nop_ops, },
449 { .name = "or", .ops = &mov_ops, },
450 { .name = "orl", .ops = &mov_ops, },
451 { .name = "test", .ops = &mov_ops, },
452 { .name = "testb", .ops = &mov_ops, },
453 { .name = "testl", .ops = &mov_ops, },
454 { .name = "xadd", .ops = &mov_ops, },
455 { .name = "xbeginl", .ops = &jump_ops, },
456 { .name = "xbeginq", .ops = &jump_ops, },
457 { .name = "retq", .ops = &ret_ops, },
460 static int ins__key_cmp(const void *name, const void *insp)
462 const struct ins *ins = insp;
464 return strcmp(name, ins->name);
467 static int ins__cmp(const void *a, const void *b)
469 const struct ins *ia = a;
470 const struct ins *ib = b;
472 return strcmp(ia->name, ib->name);
475 static void ins__sort(void)
477 const int nmemb = ARRAY_SIZE(instructions);
479 qsort(instructions, nmemb, sizeof(struct ins), ins__cmp);
482 static struct ins *ins__find(const char *name)
484 const int nmemb = ARRAY_SIZE(instructions);
492 return bsearch(name, instructions, nmemb, sizeof(struct ins), ins__key_cmp);
495 int symbol__alloc_hist(struct symbol *sym)
497 struct annotation *notes = symbol__annotation(sym);
498 size_t size = symbol__size(sym);
499 size_t sizeof_sym_hist;
502 * Add buffer of one element for zero length symbol.
503 * When sample is taken from first instruction of
504 * zero length symbol, perf still resolves it and
505 * shows symbol name in perf report and allows to
511 /* Check for overflow when calculating sizeof_sym_hist */
512 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(u64))
515 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(u64));
517 /* Check for overflow in zalloc argument */
518 if (sizeof_sym_hist > (SIZE_MAX - sizeof(*notes->src))
519 / symbol_conf.nr_events)
522 notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
523 if (notes->src == NULL)
525 notes->src->sizeof_sym_hist = sizeof_sym_hist;
526 notes->src->nr_histograms = symbol_conf.nr_events;
527 INIT_LIST_HEAD(¬es->src->source);
531 /* The cycles histogram is lazily allocated. */
532 static int symbol__alloc_hist_cycles(struct symbol *sym)
534 struct annotation *notes = symbol__annotation(sym);
535 const size_t size = symbol__size(sym);
537 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
538 if (notes->src->cycles_hist == NULL)
543 void symbol__annotate_zero_histograms(struct symbol *sym)
545 struct annotation *notes = symbol__annotation(sym);
547 pthread_mutex_lock(¬es->lock);
548 if (notes->src != NULL) {
549 memset(notes->src->histograms, 0,
550 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
551 if (notes->src->cycles_hist)
552 memset(notes->src->cycles_hist, 0,
553 symbol__size(sym) * sizeof(struct cyc_hist));
555 pthread_mutex_unlock(¬es->lock);
558 static int __symbol__account_cycles(struct annotation *notes,
560 unsigned offset, unsigned cycles,
565 ch = notes->src->cycles_hist;
567 * For now we can only account one basic block per
568 * final jump. But multiple could be overlapping.
569 * Always account the longest one. So when
570 * a shorter one has been already seen throw it away.
572 * We separately always account the full cycles.
574 ch[offset].num_aggr++;
575 ch[offset].cycles_aggr += cycles;
577 if (!have_start && ch[offset].have_start)
579 if (ch[offset].num) {
580 if (have_start && (!ch[offset].have_start ||
581 ch[offset].start > start)) {
582 ch[offset].have_start = 0;
583 ch[offset].cycles = 0;
585 if (ch[offset].reset < 0xffff)
587 } else if (have_start &&
588 ch[offset].start < start)
591 ch[offset].have_start = have_start;
592 ch[offset].start = start;
593 ch[offset].cycles += cycles;
598 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
599 struct annotation *notes, int evidx, u64 addr)
604 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
606 if ((addr < sym->start || addr >= sym->end) &&
607 (addr != sym->end || sym->start != sym->end)) {
608 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
609 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
613 offset = addr - sym->start;
614 h = annotation__histogram(notes, evidx);
618 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
619 ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
620 addr, addr - sym->start, evidx, h->addr[offset]);
624 static struct annotation *symbol__get_annotation(struct symbol *sym, bool cycles)
626 struct annotation *notes = symbol__annotation(sym);
628 if (notes->src == NULL) {
629 if (symbol__alloc_hist(sym) < 0)
632 if (!notes->src->cycles_hist && cycles) {
633 if (symbol__alloc_hist_cycles(sym) < 0)
639 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
642 struct annotation *notes;
646 notes = symbol__get_annotation(sym, false);
649 return __symbol__inc_addr_samples(sym, map, notes, evidx, addr);
652 static int symbol__account_cycles(u64 addr, u64 start,
653 struct symbol *sym, unsigned cycles)
655 struct annotation *notes;
660 notes = symbol__get_annotation(sym, true);
663 if (addr < sym->start || addr >= sym->end)
667 if (start < sym->start || start >= sym->end)
672 offset = addr - sym->start;
673 return __symbol__account_cycles(notes,
674 start ? start - sym->start : 0,
679 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
680 struct addr_map_symbol *start,
690 * Only set start when IPC can be computed. We can only
691 * compute it when the basic block is completely in a single
693 * Special case the case when the jump is elsewhere, but
694 * it starts on the function start.
697 (start->sym == ams->sym ||
699 start->addr == ams->sym->start + ams->map->start)))
700 saddr = start->al_addr;
702 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
704 start ? start->addr : 0,
705 ams->sym ? ams->sym->start + ams->map->start : 0,
707 err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
709 pr_debug2("account_cycles failed %d\n", err);
713 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx)
715 return symbol__inc_addr_samples(ams->sym, ams->map, evidx, ams->al_addr);
718 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 ip)
720 return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evidx, ip);
723 static void disasm_line__init_ins(struct disasm_line *dl, struct map *map)
725 dl->ins = ins__find(dl->name);
733 if (dl->ins->ops->parse && dl->ins->ops->parse(&dl->ops, map) < 0)
737 static int disasm_line__parse(char *line, char **namep, char **rawp)
739 char *name = line, tmp;
741 while (isspace(name[0]))
749 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
754 *namep = strdup(name);
761 if ((*rawp)[0] != '\0') {
763 while (isspace((*rawp)[0]))
774 static struct disasm_line *disasm_line__new(s64 offset, char *line,
775 size_t privsize, int line_nr,
778 struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
782 dl->line = strdup(line);
783 dl->line_nr = line_nr;
784 if (dl->line == NULL)
788 if (disasm_line__parse(dl->line, &dl->name, &dl->ops.raw) < 0)
791 disasm_line__init_ins(dl, map);
804 void disasm_line__free(struct disasm_line *dl)
808 if (dl->ins && dl->ins->ops->free)
809 dl->ins->ops->free(&dl->ops);
811 ins__delete(&dl->ops);
815 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
818 return scnprintf(bf, size, "%-6.6s %s", dl->name, dl->ops.raw);
820 return ins__scnprintf(dl->ins, bf, size, &dl->ops);
823 static void disasm__add(struct list_head *head, struct disasm_line *line)
825 list_add_tail(&line->node, head);
828 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
830 list_for_each_entry_continue(pos, head, node)
831 if (pos->offset >= 0)
837 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
838 s64 end, const char **path, u64 *nr_samples)
840 struct source_line *src_line = notes->src->lines;
841 double percent = 0.0;
845 size_t sizeof_src_line = sizeof(*src_line) +
846 sizeof(src_line->samples) * (src_line->nr_pcnt - 1);
848 while (offset < end) {
849 src_line = (void *)notes->src->lines +
850 (sizeof_src_line * offset);
853 *path = src_line->path;
855 percent += src_line->samples[evidx].percent;
856 *nr_samples += src_line->samples[evidx].nr;
860 struct sym_hist *h = annotation__histogram(notes, evidx);
861 unsigned int hits = 0;
864 hits += h->addr[offset++];
868 percent = 100.0 * hits / h->sum;
875 static const char *annotate__address_color(struct block_range *br)
877 double cov = block_range__coverage(br);
880 /* mark red for >75% coverage */
882 return PERF_COLOR_RED;
884 /* mark dull for <1% coverage */
886 return PERF_COLOR_NORMAL;
889 return PERF_COLOR_MAGENTA;
892 static const char *annotate__asm_color(struct block_range *br)
894 double cov = block_range__coverage(br);
897 /* mark dull for <1% coverage */
899 return PERF_COLOR_NORMAL;
902 return PERF_COLOR_BLUE;
905 static void annotate__branch_printf(struct block_range *br, u64 addr)
907 bool emit_comment = true;
913 if (br->is_target && br->start == addr) {
914 struct block_range *branch = br;
918 * Find matching branch to our target.
920 while (!branch->is_branch)
921 branch = block_range__next(branch);
923 p = 100 *(double)br->entry / branch->coverage;
927 emit_comment = false;
932 * The percentage of coverage joined at this target in relation
933 * to the next branch.
935 printf(" +%.2f%%", p);
939 if (br->is_branch && br->end == addr) {
940 double p = 100*(double)br->taken / br->coverage;
944 emit_comment = false;
949 * The percentage of coverage leaving at this branch, and
950 * its prediction ratio.
952 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
958 static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
959 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
960 int max_lines, struct disasm_line *queue)
962 static const char *prev_line;
963 static const char *prev_color;
965 if (dl->offset != -1) {
966 const char *path = NULL;
968 double percent, max_percent = 0.0;
969 double *ppercents = &percent;
970 u64 *psamples = &nr_samples;
971 int i, nr_percent = 1;
973 struct annotation *notes = symbol__annotation(sym);
974 s64 offset = dl->offset;
975 const u64 addr = start + offset;
976 struct disasm_line *next;
977 struct block_range *br;
979 next = disasm__get_next_ip_line(¬es->src->source, dl);
981 if (perf_evsel__is_group_event(evsel)) {
982 nr_percent = evsel->nr_members;
983 ppercents = calloc(nr_percent, sizeof(double));
984 psamples = calloc(nr_percent, sizeof(u64));
985 if (ppercents == NULL || psamples == NULL) {
990 for (i = 0; i < nr_percent; i++) {
991 percent = disasm__calc_percent(notes,
992 notes->src->lines ? i : evsel->idx + i,
994 next ? next->offset : (s64) len,
997 ppercents[i] = percent;
998 psamples[i] = nr_samples;
999 if (percent > max_percent)
1000 max_percent = percent;
1003 if (max_percent < min_pcnt)
1006 if (max_lines && printed >= max_lines)
1009 if (queue != NULL) {
1010 list_for_each_entry_from(queue, ¬es->src->source, node) {
1013 disasm_line__print(queue, sym, start, evsel, len,
1018 color = get_percent_color(max_percent);
1021 * Also color the filename and line if needed, with
1022 * the same color than the percentage. Don't print it
1023 * twice for close colored addr with the same filename:line
1026 if (!prev_line || strcmp(prev_line, path)
1027 || color != prev_color) {
1028 color_fprintf(stdout, color, " %s", path);
1034 for (i = 0; i < nr_percent; i++) {
1035 percent = ppercents[i];
1036 nr_samples = psamples[i];
1037 color = get_percent_color(percent);
1039 if (symbol_conf.show_total_period)
1040 color_fprintf(stdout, color, " %7" PRIu64,
1043 color_fprintf(stdout, color, " %7.2f", percent);
1048 br = block_range__find(addr);
1049 color_fprintf(stdout, annotate__address_color(br), " %" PRIx64 ":", addr);
1050 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->line);
1051 annotate__branch_printf(br, addr);
1054 if (ppercents != &percent)
1057 if (psamples != &nr_samples)
1060 } else if (max_lines && printed >= max_lines)
1068 if (perf_evsel__is_group_event(evsel))
1069 width *= evsel->nr_members;
1072 printf(" %*s:\n", width, " ");
1074 printf(" %*s: %s\n", width, " ", dl->line);
1081 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1082 * which looks like following
1084 * 0000000000415500 <_init>:
1085 * 415500: sub $0x8,%rsp
1086 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1087 * 41550b: test %rax,%rax
1088 * 41550e: je 415515 <_init+0x15>
1089 * 415510: callq 416e70 <__gmon_start__@plt>
1090 * 415515: add $0x8,%rsp
1093 * it will be parsed and saved into struct disasm_line as
1094 * <offset> <name> <ops.raw>
1096 * The offset will be a relative offset from the start of the symbol and -1
1097 * means that it's not a disassembly line so should be treated differently.
1098 * The ops.raw part will be parsed further according to type of the instruction.
1100 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
1101 FILE *file, size_t privsize,
1104 struct annotation *notes = symbol__annotation(sym);
1105 struct disasm_line *dl;
1106 char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
1108 s64 line_ip, offset = -1;
1109 regmatch_t match[2];
1111 if (getline(&line, &line_len, file) < 0)
1117 while (line_len != 0 && isspace(line[line_len - 1]))
1118 line[--line_len] = '\0';
1120 c = strchr(line, '\n');
1127 /* /filename:linenr ? Save line number and ignore. */
1128 if (regexec(&file_lineno, line, 2, match, 0) == 0) {
1129 *line_nr = atoi(line + match[1].rm_so);
1134 * Strip leading spaces:
1145 * Parse hexa addresses followed by ':'
1147 line_ip = strtoull(tmp, &tmp2, 16);
1148 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1152 if (line_ip != -1) {
1153 u64 start = map__rip_2objdump(map, sym->start),
1154 end = map__rip_2objdump(map, sym->end);
1156 offset = line_ip - start;
1157 if ((u64)line_ip < start || (u64)line_ip >= end)
1160 parsed_line = tmp2 + 1;
1163 dl = disasm_line__new(offset, parsed_line, privsize, *line_nr, map);
1170 if (dl->ops.target.offset == UINT64_MAX)
1171 dl->ops.target.offset = dl->ops.target.addr -
1172 map__rip_2objdump(map, sym->start);
1174 /* kcore has no symbols, so add the call target name */
1175 if (dl->ins && ins__is_call(dl->ins) && !dl->ops.target.name) {
1176 struct addr_map_symbol target = {
1178 .addr = dl->ops.target.addr,
1181 if (!map_groups__find_ams(&target) &&
1182 target.sym->start == target.al_addr)
1183 dl->ops.target.name = strdup(target.sym->name);
1186 disasm__add(¬es->src->source, dl);
1191 static __attribute__((constructor)) void symbol__init_regexpr(void)
1193 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1196 static void delete_last_nop(struct symbol *sym)
1198 struct annotation *notes = symbol__annotation(sym);
1199 struct list_head *list = ¬es->src->source;
1200 struct disasm_line *dl;
1202 while (!list_empty(list)) {
1203 dl = list_entry(list->prev, struct disasm_line, node);
1205 if (dl->ins && dl->ins->ops) {
1206 if (dl->ins->ops != &nop_ops)
1209 if (!strstr(dl->line, " nop ") &&
1210 !strstr(dl->line, " nopl ") &&
1211 !strstr(dl->line, " nopw "))
1215 list_del(&dl->node);
1216 disasm_line__free(dl);
1220 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1221 int errnum, char *buf, size_t buflen)
1223 struct dso *dso = map->dso;
1225 BUG_ON(buflen == 0);
1228 str_error_r(errnum, buf, buflen);
1233 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1234 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1235 char *build_id_msg = NULL;
1237 if (dso->has_build_id) {
1238 build_id__sprintf(dso->build_id,
1239 sizeof(dso->build_id), bf + 15);
1242 scnprintf(buf, buflen,
1243 "No vmlinux file%s\nwas found in the path.\n\n"
1244 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1246 " perf buildid-cache -vu vmlinux\n\n"
1248 " --vmlinux vmlinux\n", build_id_msg ?: "");
1252 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1259 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1261 char linkname[PATH_MAX];
1262 char *build_id_filename;
1263 char *build_id_path = NULL;
1265 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1266 !dso__is_kcore(dso))
1267 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1269 build_id_filename = dso__build_id_filename(dso, NULL, 0);
1270 if (build_id_filename) {
1271 __symbol__join_symfs(filename, filename_size, build_id_filename);
1272 free(build_id_filename);
1274 if (dso->has_build_id)
1279 build_id_path = strdup(filename);
1283 dirname(build_id_path);
1285 if (dso__is_kcore(dso) ||
1286 readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1287 strstr(linkname, DSO__NAME_KALLSYMS) ||
1288 access(filename, R_OK)) {
1291 * If we don't have build-ids or the build-id file isn't in the
1292 * cache, or is just a kallsyms file, well, lets hope that this
1293 * DSO is the same as when 'perf record' ran.
1295 __symbol__join_symfs(filename, filename_size, dso->long_name);
1298 free(build_id_path);
1302 int symbol__disassemble(struct symbol *sym, struct map *map, size_t privsize)
1304 struct dso *dso = map->dso;
1307 char symfs_filename[PATH_MAX];
1308 struct kcore_extract kce;
1309 bool delete_extract = false;
1314 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1319 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1320 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1321 map->unmap_ip(map, sym->end));
1323 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1324 dso, dso->long_name, sym, sym->name);
1326 if (dso__is_kcore(dso)) {
1327 kce.kcore_filename = symfs_filename;
1328 kce.addr = map__rip_2objdump(map, sym->start);
1329 kce.offs = sym->start;
1330 kce.len = sym->end - sym->start;
1331 if (!kcore_extract__create(&kce)) {
1332 delete_extract = true;
1333 strlcpy(symfs_filename, kce.extract_filename,
1334 sizeof(symfs_filename));
1336 } else if (dso__needs_decompress(dso)) {
1342 if (kmod_path__parse_ext(&m, symfs_filename))
1345 snprintf(tmp, PATH_MAX, "/tmp/perf-kmod-XXXXXX");
1353 ret = decompress_to_file(m.ext, symfs_filename, fd);
1356 pr_err("Cannot decompress %s %s\n", m.ext, symfs_filename);
1364 strcpy(symfs_filename, tmp);
1367 err = asprintf(&command,
1368 "%s %s%s --start-address=0x%016" PRIx64
1369 " --stop-address=0x%016" PRIx64
1370 " -l -d %s %s -C %s 2>/dev/null|grep -v %s|expand",
1371 objdump_path ? objdump_path : "objdump",
1372 disassembler_style ? "-M " : "",
1373 disassembler_style ? disassembler_style : "",
1374 map__rip_2objdump(map, sym->start),
1375 map__rip_2objdump(map, sym->end),
1376 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
1377 symbol_conf.annotate_src ? "-S" : "",
1378 symfs_filename, symfs_filename);
1381 pr_err("Failure allocating memory for the command to run\n");
1382 goto out_remove_tmp;
1385 pr_debug("Executing: %s\n", command);
1388 if (pipe(stdout_fd) < 0) {
1389 pr_err("Failure creating the pipe to run %s\n", command);
1390 goto out_free_command;
1395 pr_err("Failure forking to run %s\n", command);
1396 goto out_close_stdout;
1400 close(stdout_fd[0]);
1401 dup2(stdout_fd[1], 1);
1402 close(stdout_fd[1]);
1403 execl("/bin/sh", "sh", "-c", command, NULL);
1408 close(stdout_fd[1]);
1410 file = fdopen(stdout_fd[0], "r");
1412 pr_err("Failure creating FILE stream for %s\n", command);
1414 * If we were using debug info should retry with
1417 goto out_free_command;
1421 while (!feof(file)) {
1422 if (symbol__parse_objdump_line(sym, map, file, privsize,
1429 pr_err("No output from %s\n", command);
1432 * kallsyms does not have symbol sizes so there may a nop at the end.
1435 if (dso__is_kcore(dso))
1436 delete_last_nop(sym);
1443 close(stdout_fd[0]);
1445 if (dso__needs_decompress(dso))
1446 unlink(symfs_filename);
1449 kcore_extract__delete(&kce);
1454 close(stdout_fd[1]);
1455 goto out_free_command;
1458 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
1460 struct source_line *iter;
1461 struct rb_node **p = &root->rb_node;
1462 struct rb_node *parent = NULL;
1465 while (*p != NULL) {
1467 iter = rb_entry(parent, struct source_line, node);
1469 ret = strcmp(iter->path, src_line->path);
1471 for (i = 0; i < src_line->nr_pcnt; i++)
1472 iter->samples[i].percent_sum += src_line->samples[i].percent;
1479 p = &(*p)->rb_right;
1482 for (i = 0; i < src_line->nr_pcnt; i++)
1483 src_line->samples[i].percent_sum = src_line->samples[i].percent;
1485 rb_link_node(&src_line->node, parent, p);
1486 rb_insert_color(&src_line->node, root);
1489 static int cmp_source_line(struct source_line *a, struct source_line *b)
1493 for (i = 0; i < a->nr_pcnt; i++) {
1494 if (a->samples[i].percent_sum == b->samples[i].percent_sum)
1496 return a->samples[i].percent_sum > b->samples[i].percent_sum;
1502 static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
1504 struct source_line *iter;
1505 struct rb_node **p = &root->rb_node;
1506 struct rb_node *parent = NULL;
1508 while (*p != NULL) {
1510 iter = rb_entry(parent, struct source_line, node);
1512 if (cmp_source_line(src_line, iter))
1515 p = &(*p)->rb_right;
1518 rb_link_node(&src_line->node, parent, p);
1519 rb_insert_color(&src_line->node, root);
1522 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1524 struct source_line *src_line;
1525 struct rb_node *node;
1527 node = rb_first(src_root);
1529 struct rb_node *next;
1531 src_line = rb_entry(node, struct source_line, node);
1532 next = rb_next(node);
1533 rb_erase(node, src_root);
1535 __resort_source_line(dest_root, src_line);
1540 static void symbol__free_source_line(struct symbol *sym, int len)
1542 struct annotation *notes = symbol__annotation(sym);
1543 struct source_line *src_line = notes->src->lines;
1544 size_t sizeof_src_line;
1547 sizeof_src_line = sizeof(*src_line) +
1548 (sizeof(src_line->samples) * (src_line->nr_pcnt - 1));
1550 for (i = 0; i < len; i++) {
1551 free_srcline(src_line->path);
1552 src_line = (void *)src_line + sizeof_src_line;
1555 zfree(¬es->src->lines);
1558 /* Get the filename:line for the colored entries */
1559 static int symbol__get_source_line(struct symbol *sym, struct map *map,
1560 struct perf_evsel *evsel,
1561 struct rb_root *root, int len)
1565 int evidx = evsel->idx;
1566 struct source_line *src_line;
1567 struct annotation *notes = symbol__annotation(sym);
1568 struct sym_hist *h = annotation__histogram(notes, evidx);
1569 struct rb_root tmp_root = RB_ROOT;
1572 size_t sizeof_src_line = sizeof(struct source_line);
1574 if (perf_evsel__is_group_event(evsel)) {
1575 for (i = 1; i < evsel->nr_members; i++) {
1576 h = annotation__histogram(notes, evidx + i);
1579 nr_pcnt = evsel->nr_members;
1580 sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->samples);
1586 src_line = notes->src->lines = calloc(len, sizeof_src_line);
1587 if (!notes->src->lines)
1590 start = map__rip_2objdump(map, sym->start);
1592 for (i = 0; i < len; i++) {
1594 double percent_max = 0.0;
1596 src_line->nr_pcnt = nr_pcnt;
1598 for (k = 0; k < nr_pcnt; k++) {
1599 h = annotation__histogram(notes, evidx + k);
1600 src_line->samples[k].percent = 100.0 * h->addr[i] / h->sum;
1602 if (src_line->samples[k].percent > percent_max)
1603 percent_max = src_line->samples[k].percent;
1606 if (percent_max <= 0.5)
1610 src_line->path = get_srcline(map->dso, offset, NULL, false);
1611 insert_source_line(&tmp_root, src_line);
1614 src_line = (void *)src_line + sizeof_src_line;
1617 resort_source_line(root, &tmp_root);
1621 static void print_summary(struct rb_root *root, const char *filename)
1623 struct source_line *src_line;
1624 struct rb_node *node;
1626 printf("\nSorted summary for file %s\n", filename);
1627 printf("----------------------------------------------\n\n");
1629 if (RB_EMPTY_ROOT(root)) {
1630 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1634 node = rb_first(root);
1636 double percent, percent_max = 0.0;
1641 src_line = rb_entry(node, struct source_line, node);
1642 for (i = 0; i < src_line->nr_pcnt; i++) {
1643 percent = src_line->samples[i].percent_sum;
1644 color = get_percent_color(percent);
1645 color_fprintf(stdout, color, " %7.2f", percent);
1647 if (percent > percent_max)
1648 percent_max = percent;
1651 path = src_line->path;
1652 color = get_percent_color(percent_max);
1653 color_fprintf(stdout, color, " %s\n", path);
1655 node = rb_next(node);
1659 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1661 struct annotation *notes = symbol__annotation(sym);
1662 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1663 u64 len = symbol__size(sym), offset;
1665 for (offset = 0; offset < len; ++offset)
1666 if (h->addr[offset] != 0)
1667 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1668 sym->start + offset, h->addr[offset]);
1669 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1672 int symbol__annotate_printf(struct symbol *sym, struct map *map,
1673 struct perf_evsel *evsel, bool full_paths,
1674 int min_pcnt, int max_lines, int context)
1676 struct dso *dso = map->dso;
1678 const char *d_filename;
1679 const char *evsel_name = perf_evsel__name(evsel);
1680 struct annotation *notes = symbol__annotation(sym);
1681 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1682 struct disasm_line *pos, *queue = NULL;
1683 u64 start = map__rip_2objdump(map, sym->start);
1684 int printed = 2, queue_len = 0;
1688 int graph_dotted_len;
1690 filename = strdup(dso->long_name);
1695 d_filename = filename;
1697 d_filename = basename(filename);
1699 len = symbol__size(sym);
1701 if (perf_evsel__is_group_event(evsel))
1702 width *= evsel->nr_members;
1704 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples)\n",
1705 width, width, "Percent", d_filename, evsel_name, h->sum);
1707 printf("%-*.*s----\n",
1708 graph_dotted_len, graph_dotted_len, graph_dotted_line);
1711 symbol__annotate_hits(sym, evsel);
1713 list_for_each_entry(pos, ¬es->src->source, node) {
1714 if (context && queue == NULL) {
1719 switch (disasm_line__print(pos, sym, start, evsel, len,
1720 min_pcnt, printed, max_lines,
1725 printed += queue_len;
1731 /* filtered by max_lines */
1737 * Filtered by min_pcnt or non IP lines when
1742 if (queue_len == context)
1743 queue = list_entry(queue->node.next, typeof(*queue), node);
1755 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1757 struct annotation *notes = symbol__annotation(sym);
1758 struct sym_hist *h = annotation__histogram(notes, evidx);
1760 memset(h, 0, notes->src->sizeof_sym_hist);
1763 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1765 struct annotation *notes = symbol__annotation(sym);
1766 struct sym_hist *h = annotation__histogram(notes, evidx);
1767 int len = symbol__size(sym), offset;
1770 for (offset = 0; offset < len; ++offset) {
1771 h->addr[offset] = h->addr[offset] * 7 / 8;
1772 h->sum += h->addr[offset];
1776 void disasm__purge(struct list_head *head)
1778 struct disasm_line *pos, *n;
1780 list_for_each_entry_safe(pos, n, head, node) {
1781 list_del(&pos->node);
1782 disasm_line__free(pos);
1786 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1790 if (dl->offset == -1)
1791 return fprintf(fp, "%s\n", dl->line);
1793 printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->name);
1795 if (dl->ops.raw[0] != '\0') {
1796 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1800 return printed + fprintf(fp, "\n");
1803 size_t disasm__fprintf(struct list_head *head, FILE *fp)
1805 struct disasm_line *pos;
1808 list_for_each_entry(pos, head, node)
1809 printed += disasm_line__fprintf(pos, fp);
1814 int symbol__tty_annotate(struct symbol *sym, struct map *map,
1815 struct perf_evsel *evsel, bool print_lines,
1816 bool full_paths, int min_pcnt, int max_lines)
1818 struct dso *dso = map->dso;
1819 struct rb_root source_line = RB_ROOT;
1822 if (symbol__disassemble(sym, map, 0) < 0)
1825 len = symbol__size(sym);
1828 srcline_full_filename = full_paths;
1829 symbol__get_source_line(sym, map, evsel, &source_line, len);
1830 print_summary(&source_line, dso->long_name);
1833 symbol__annotate_printf(sym, map, evsel, full_paths,
1834 min_pcnt, max_lines, 0);
1836 symbol__free_source_line(sym, len);
1838 disasm__purge(&symbol__annotation(sym)->src->source);
1843 bool ui__has_annotation(void)
1845 return use_browser == 1 && perf_hpp_list.sym;