1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
5 * Parts came from builtin-annotate.c, see those files for further
14 #include <bpf/libbpf.h>
15 #include <linux/btf.h>
30 #include "bpf-event.h"
31 #include "block-range.h"
33 #include "arch/common.h"
36 #include <linux/bitops.h>
37 #include <linux/kernel.h>
38 #include <bpf/libbpf.h>
40 /* FIXME: For the HE_COLORSET */
41 #include "ui/browser.h"
44 * FIXME: Using the same values as slang.h,
45 * but that header may not be available everywhere
47 #define LARROW_CHAR ((unsigned char)',')
48 #define RARROW_CHAR ((unsigned char)'+')
49 #define DARROW_CHAR ((unsigned char)'.')
50 #define UARROW_CHAR ((unsigned char)'-')
52 #include <linux/ctype.h>
54 struct annotation_options annotation__default_options = {
58 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
59 .percent_type = PERCENT_PERIOD_LOCAL,
62 static regex_t file_lineno;
64 static struct ins_ops *ins__find(struct arch *arch, const char *name);
65 static void ins__sort(struct arch *arch);
66 static int disasm_line__parse(char *line, const char **namep, char **rawp);
70 struct ins *instructions;
71 size_t nr_instructions;
72 size_t nr_instructions_allocated;
73 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
74 bool sorted_instructions;
79 int (*init)(struct arch *arch, char *cpuid);
80 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
84 char skip_functions_char;
88 static struct ins_ops call_ops;
89 static struct ins_ops dec_ops;
90 static struct ins_ops jump_ops;
91 static struct ins_ops mov_ops;
92 static struct ins_ops nop_ops;
93 static struct ins_ops lock_ops;
94 static struct ins_ops ret_ops;
96 static int arch__grow_instructions(struct arch *arch)
98 struct ins *new_instructions;
99 size_t new_nr_allocated;
101 if (arch->nr_instructions_allocated == 0 && arch->instructions)
102 goto grow_from_non_allocated_table;
104 new_nr_allocated = arch->nr_instructions_allocated + 128;
105 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
106 if (new_instructions == NULL)
109 out_update_instructions:
110 arch->instructions = new_instructions;
111 arch->nr_instructions_allocated = new_nr_allocated;
114 grow_from_non_allocated_table:
115 new_nr_allocated = arch->nr_instructions + 128;
116 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
117 if (new_instructions == NULL)
120 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
121 goto out_update_instructions;
124 static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
128 if (arch->nr_instructions == arch->nr_instructions_allocated &&
129 arch__grow_instructions(arch))
132 ins = &arch->instructions[arch->nr_instructions];
133 ins->name = strdup(name);
138 arch->nr_instructions++;
144 #include "arch/arc/annotate/instructions.c"
145 #include "arch/arm/annotate/instructions.c"
146 #include "arch/arm64/annotate/instructions.c"
147 #include "arch/x86/annotate/instructions.c"
148 #include "arch/powerpc/annotate/instructions.c"
149 #include "arch/s390/annotate/instructions.c"
150 #include "arch/sparc/annotate/instructions.c"
152 static struct arch architectures[] = {
155 .init = arc__annotate_init,
159 .init = arm__annotate_init,
163 .init = arm64__annotate_init,
167 .init = x86__annotate_init,
168 .instructions = x86__instructions,
169 .nr_instructions = ARRAY_SIZE(x86__instructions),
170 .ins_is_fused = x86__ins_is_fused,
177 .init = powerpc__annotate_init,
181 .init = s390__annotate_init,
188 .init = sparc__annotate_init,
195 static void ins__delete(struct ins_operands *ops)
199 zfree(&ops->source.raw);
200 zfree(&ops->source.name);
201 zfree(&ops->target.raw);
202 zfree(&ops->target.name);
205 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
206 struct ins_operands *ops, int max_ins_name)
208 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
211 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
212 struct ins_operands *ops, int max_ins_name)
214 if (ins->ops->scnprintf)
215 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
217 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
220 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
222 if (!arch || !arch->ins_is_fused)
225 return arch->ins_is_fused(arch, ins1, ins2);
228 static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
230 char *endptr, *tok, *name;
231 struct map *map = ms->map;
232 struct addr_map_symbol target = {
236 ops->target.addr = strtoull(ops->raw, &endptr, 16);
238 name = strchr(endptr, '<');
244 if (arch->objdump.skip_functions_char &&
245 strchr(name, arch->objdump.skip_functions_char))
248 tok = strchr(name, '>');
253 ops->target.name = strdup(name);
256 if (ops->target.name == NULL)
259 target.addr = map__objdump_2mem(map, ops->target.addr);
261 if (map_groups__find_ams(&target) == 0 &&
262 map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
263 ops->target.sym = target.sym;
268 tok = strchr(endptr, '*');
272 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
273 * Do not parse such instruction. */
274 if (strstr(endptr, "(%r") == NULL)
275 ops->target.addr = strtoull(endptr, NULL, 16);
280 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
281 struct ins_operands *ops, int max_ins_name)
284 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
286 if (ops->target.addr == 0)
287 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
289 if (ops->target.name)
290 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
292 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
295 static struct ins_ops call_ops = {
296 .parse = call__parse,
297 .scnprintf = call__scnprintf,
300 bool ins__is_call(const struct ins *ins)
302 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
306 * Prevents from matching commas in the comment section, e.g.:
307 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
309 static inline const char *validate_comma(const char *c, struct ins_operands *ops)
311 if (ops->raw_comment && c > ops->raw_comment)
317 static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
319 struct map *map = ms->map;
320 struct symbol *sym = ms->sym;
321 struct addr_map_symbol target = {
324 const char *c = strchr(ops->raw, ',');
327 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
328 c = validate_comma(c, ops);
331 * Examples of lines to parse for the _cpp_lex_token@@Base
334 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
335 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
337 * The first is a jump to an offset inside the same function,
338 * the second is to another function, i.e. that 0xa72 is an
339 * offset in the cpp_named_operator2name@@base function.
342 * skip over possible up to 2 operands to get to address, e.g.:
343 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
346 ops->target.addr = strtoull(c, NULL, 16);
347 if (!ops->target.addr) {
349 c = validate_comma(c, ops);
351 ops->target.addr = strtoull(c, NULL, 16);
354 ops->target.addr = strtoull(ops->raw, NULL, 16);
357 target.addr = map__objdump_2mem(map, ops->target.addr);
358 start = map->unmap_ip(map, sym->start),
359 end = map->unmap_ip(map, sym->end);
361 ops->target.outside = target.addr < start || target.addr > end;
364 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
366 cpp_named_operator2name@@Base+0xa72
368 * Point to a place that is after the cpp_named_operator2name
369 * boundaries, i.e. in the ELF symbol table for cc1
370 * cpp_named_operator2name is marked as being 32-bytes long, but it in
371 * fact is much larger than that, so we seem to need a symbols__find()
372 * routine that looks for >= current->start and < next_symbol->start,
373 * possibly just for C++ objects?
375 * For now lets just make some progress by marking jumps to outside the
376 * current function as call like.
378 * Actual navigation will come next, with further understanding of how
379 * the symbol searching and disassembly should be done.
381 if (map_groups__find_ams(&target) == 0 &&
382 map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
383 ops->target.sym = target.sym;
385 if (!ops->target.outside) {
386 ops->target.offset = target.addr - start;
387 ops->target.offset_avail = true;
389 ops->target.offset_avail = false;
395 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
396 struct ins_operands *ops, int max_ins_name)
400 if (!ops->target.addr || ops->target.offset < 0)
401 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
403 if (ops->target.outside && ops->target.sym != NULL)
404 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
406 c = strchr(ops->raw, ',');
407 c = validate_comma(c, ops);
410 const char *c2 = strchr(c + 1, ',');
412 c2 = validate_comma(c2, ops);
413 /* check for 3-op insn */
418 /* mirror arch objdump's space-after-comma style */
423 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
424 ins->name, c ? c - ops->raw : 0, ops->raw,
428 static struct ins_ops jump_ops = {
429 .parse = jump__parse,
430 .scnprintf = jump__scnprintf,
433 bool ins__is_jump(const struct ins *ins)
435 return ins->ops == &jump_ops;
438 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
440 char *endptr, *name, *t;
442 if (strstr(raw, "(%rip)") == NULL)
445 *addrp = strtoull(comment, &endptr, 16);
446 if (endptr == comment)
448 name = strchr(endptr, '<');
454 t = strchr(name, '>');
459 *namep = strdup(name);
465 static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
467 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
468 if (ops->locked.ops == NULL)
471 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
474 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
476 if (ops->locked.ins.ops == NULL)
479 if (ops->locked.ins.ops->parse &&
480 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
486 zfree(&ops->locked.ops);
490 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
491 struct ins_operands *ops, int max_ins_name)
495 if (ops->locked.ins.ops == NULL)
496 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
498 printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
499 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
500 size - printed, ops->locked.ops, max_ins_name);
503 static void lock__delete(struct ins_operands *ops)
505 struct ins *ins = &ops->locked.ins;
507 if (ins->ops && ins->ops->free)
508 ins->ops->free(ops->locked.ops);
510 ins__delete(ops->locked.ops);
512 zfree(&ops->locked.ops);
513 zfree(&ops->target.raw);
514 zfree(&ops->target.name);
517 static struct ins_ops lock_ops = {
518 .free = lock__delete,
519 .parse = lock__parse,
520 .scnprintf = lock__scnprintf,
523 static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
525 char *s = strchr(ops->raw, ','), *target, *comment, prev;
531 ops->source.raw = strdup(ops->raw);
534 if (ops->source.raw == NULL)
538 comment = strchr(s, arch->objdump.comment_char);
543 s = strchr(s, '\0') - 1;
545 while (s > target && isspace(s[0]))
551 ops->target.raw = strdup(target);
554 if (ops->target.raw == NULL)
555 goto out_free_source;
560 comment = skip_spaces(comment);
561 comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
562 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
567 zfree(&ops->source.raw);
571 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
572 struct ins_operands *ops, int max_ins_name)
574 return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
575 ops->source.name ?: ops->source.raw,
576 ops->target.name ?: ops->target.raw);
579 static struct ins_ops mov_ops = {
581 .scnprintf = mov__scnprintf,
584 static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
586 char *target, *comment, *s, prev;
588 target = s = ops->raw;
590 while (s[0] != '\0' && !isspace(s[0]))
595 ops->target.raw = strdup(target);
598 if (ops->target.raw == NULL)
601 comment = strchr(s, arch->objdump.comment_char);
605 comment = skip_spaces(comment);
606 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
611 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
612 struct ins_operands *ops, int max_ins_name)
614 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
615 ops->target.name ?: ops->target.raw);
618 static struct ins_ops dec_ops = {
620 .scnprintf = dec__scnprintf,
623 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
624 struct ins_operands *ops __maybe_unused, int max_ins_name)
626 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
629 static struct ins_ops nop_ops = {
630 .scnprintf = nop__scnprintf,
633 static struct ins_ops ret_ops = {
634 .scnprintf = ins__raw_scnprintf,
637 bool ins__is_ret(const struct ins *ins)
639 return ins->ops == &ret_ops;
642 bool ins__is_lock(const struct ins *ins)
644 return ins->ops == &lock_ops;
647 static int ins__key_cmp(const void *name, const void *insp)
649 const struct ins *ins = insp;
651 return strcmp(name, ins->name);
654 static int ins__cmp(const void *a, const void *b)
656 const struct ins *ia = a;
657 const struct ins *ib = b;
659 return strcmp(ia->name, ib->name);
662 static void ins__sort(struct arch *arch)
664 const int nmemb = arch->nr_instructions;
666 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
669 static struct ins_ops *__ins__find(struct arch *arch, const char *name)
672 const int nmemb = arch->nr_instructions;
674 if (!arch->sorted_instructions) {
676 arch->sorted_instructions = true;
679 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
680 return ins ? ins->ops : NULL;
683 static struct ins_ops *ins__find(struct arch *arch, const char *name)
685 struct ins_ops *ops = __ins__find(arch, name);
687 if (!ops && arch->associate_instruction_ops)
688 ops = arch->associate_instruction_ops(arch, name);
693 static int arch__key_cmp(const void *name, const void *archp)
695 const struct arch *arch = archp;
697 return strcmp(name, arch->name);
700 static int arch__cmp(const void *a, const void *b)
702 const struct arch *aa = a;
703 const struct arch *ab = b;
705 return strcmp(aa->name, ab->name);
708 static void arch__sort(void)
710 const int nmemb = ARRAY_SIZE(architectures);
712 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
715 static struct arch *arch__find(const char *name)
717 const int nmemb = ARRAY_SIZE(architectures);
725 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
728 static struct annotated_source *annotated_source__new(void)
730 struct annotated_source *src = zalloc(sizeof(*src));
733 INIT_LIST_HEAD(&src->source);
738 static __maybe_unused void annotated_source__delete(struct annotated_source *src)
742 zfree(&src->histograms);
743 zfree(&src->cycles_hist);
747 static int annotated_source__alloc_histograms(struct annotated_source *src,
748 size_t size, int nr_hists)
750 size_t sizeof_sym_hist;
753 * Add buffer of one element for zero length symbol.
754 * When sample is taken from first instruction of
755 * zero length symbol, perf still resolves it and
756 * shows symbol name in perf report and allows to
762 /* Check for overflow when calculating sizeof_sym_hist */
763 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
766 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
768 /* Check for overflow in zalloc argument */
769 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
772 src->sizeof_sym_hist = sizeof_sym_hist;
773 src->nr_histograms = nr_hists;
774 src->histograms = calloc(nr_hists, sizeof_sym_hist) ;
775 return src->histograms ? 0 : -1;
778 /* The cycles histogram is lazily allocated. */
779 static int symbol__alloc_hist_cycles(struct symbol *sym)
781 struct annotation *notes = symbol__annotation(sym);
782 const size_t size = symbol__size(sym);
784 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
785 if (notes->src->cycles_hist == NULL)
790 void symbol__annotate_zero_histograms(struct symbol *sym)
792 struct annotation *notes = symbol__annotation(sym);
794 pthread_mutex_lock(¬es->lock);
795 if (notes->src != NULL) {
796 memset(notes->src->histograms, 0,
797 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
798 if (notes->src->cycles_hist)
799 memset(notes->src->cycles_hist, 0,
800 symbol__size(sym) * sizeof(struct cyc_hist));
802 pthread_mutex_unlock(¬es->lock);
805 static int __symbol__account_cycles(struct cyc_hist *ch,
807 unsigned offset, unsigned cycles,
811 * For now we can only account one basic block per
812 * final jump. But multiple could be overlapping.
813 * Always account the longest one. So when
814 * a shorter one has been already seen throw it away.
816 * We separately always account the full cycles.
818 ch[offset].num_aggr++;
819 ch[offset].cycles_aggr += cycles;
821 if (cycles > ch[offset].cycles_max)
822 ch[offset].cycles_max = cycles;
824 if (ch[offset].cycles_min) {
825 if (cycles && cycles < ch[offset].cycles_min)
826 ch[offset].cycles_min = cycles;
828 ch[offset].cycles_min = cycles;
830 if (!have_start && ch[offset].have_start)
832 if (ch[offset].num) {
833 if (have_start && (!ch[offset].have_start ||
834 ch[offset].start > start)) {
835 ch[offset].have_start = 0;
836 ch[offset].cycles = 0;
838 if (ch[offset].reset < 0xffff)
840 } else if (have_start &&
841 ch[offset].start < start)
844 ch[offset].have_start = have_start;
845 ch[offset].start = start;
846 ch[offset].cycles += cycles;
851 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
852 struct annotated_source *src, int evidx, u64 addr,
853 struct perf_sample *sample)
858 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
860 if ((addr < sym->start || addr >= sym->end) &&
861 (addr != sym->end || sym->start != sym->end)) {
862 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
863 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
867 offset = addr - sym->start;
868 h = annotated_source__histogram(src, evidx);
870 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
871 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
875 h->addr[offset].nr_samples++;
876 h->period += sample->period;
877 h->addr[offset].period += sample->period;
879 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
880 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
881 sym->start, sym->name, addr, addr - sym->start, evidx,
882 h->addr[offset].nr_samples, h->addr[offset].period);
886 static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
888 struct annotation *notes = symbol__annotation(sym);
890 if (notes->src == NULL) {
891 notes->src = annotated_source__new();
892 if (notes->src == NULL)
894 goto alloc_cycles_hist;
897 if (!notes->src->cycles_hist) {
899 symbol__alloc_hist_cycles(sym);
902 return notes->src->cycles_hist;
905 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
907 struct annotation *notes = symbol__annotation(sym);
909 if (notes->src == NULL) {
910 notes->src = annotated_source__new();
911 if (notes->src == NULL)
913 goto alloc_histograms;
916 if (notes->src->histograms == NULL) {
918 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
925 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
926 struct perf_evsel *evsel, u64 addr,
927 struct perf_sample *sample)
929 struct annotated_source *src;
933 src = symbol__hists(sym, evsel->evlist->nr_entries);
934 return (src) ? __symbol__inc_addr_samples(sym, map, src, evsel->idx,
938 static int symbol__account_cycles(u64 addr, u64 start,
939 struct symbol *sym, unsigned cycles)
941 struct cyc_hist *cycles_hist;
946 cycles_hist = symbol__cycles_hist(sym);
947 if (cycles_hist == NULL)
949 if (addr < sym->start || addr >= sym->end)
953 if (start < sym->start || start >= sym->end)
958 offset = addr - sym->start;
959 return __symbol__account_cycles(cycles_hist,
960 start ? start - sym->start : 0,
965 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
966 struct addr_map_symbol *start,
976 * Only set start when IPC can be computed. We can only
977 * compute it when the basic block is completely in a single
979 * Special case the case when the jump is elsewhere, but
980 * it starts on the function start.
983 (start->sym == ams->sym ||
985 start->addr == ams->sym->start + ams->map->start)))
986 saddr = start->al_addr;
988 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
990 start ? start->addr : 0,
991 ams->sym ? ams->sym->start + ams->map->start : 0,
993 err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
995 pr_debug2("account_cycles failed %d\n", err);
999 static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1001 unsigned n_insn = 0;
1004 for (offset = start; offset <= end; offset++) {
1005 if (notes->offsets[offset])
1011 static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1014 unsigned int cover_insn = 0;
1017 n_insn = annotation__count_insn(notes, start, end);
1018 if (n_insn && ch->num && ch->cycles) {
1019 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1021 /* Hide data when there are too many overlaps. */
1022 if (ch->reset >= 0x7fff)
1025 for (offset = start; offset <= end; offset++) {
1026 struct annotation_line *al = notes->offsets[offset];
1028 if (al && al->ipc == 0.0) {
1035 notes->hit_cycles += ch->cycles;
1036 notes->hit_insn += n_insn * ch->num;
1037 notes->cover_insn += cover_insn;
1042 void annotation__compute_ipc(struct annotation *notes, size_t size)
1046 if (!notes->src || !notes->src->cycles_hist)
1049 notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1050 notes->hit_cycles = 0;
1051 notes->hit_insn = 0;
1052 notes->cover_insn = 0;
1054 pthread_mutex_lock(¬es->lock);
1055 for (offset = size - 1; offset >= 0; --offset) {
1056 struct cyc_hist *ch;
1058 ch = ¬es->src->cycles_hist[offset];
1059 if (ch && ch->cycles) {
1060 struct annotation_line *al;
1063 annotation__count_and_fill(notes, ch->start, offset, ch);
1064 al = notes->offsets[offset];
1065 if (al && ch->num_aggr) {
1066 al->cycles = ch->cycles_aggr / ch->num_aggr;
1067 al->cycles_max = ch->cycles_max;
1068 al->cycles_min = ch->cycles_min;
1070 notes->have_cycles = true;
1073 pthread_mutex_unlock(¬es->lock);
1076 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1077 struct perf_evsel *evsel)
1079 return symbol__inc_addr_samples(ams->sym, ams->map, evsel, ams->al_addr, sample);
1082 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1083 struct perf_evsel *evsel, u64 ip)
1085 return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evsel, ip, sample);
1088 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1090 dl->ins.ops = ins__find(arch, dl->ins.name);
1095 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1099 static int disasm_line__parse(char *line, const char **namep, char **rawp)
1101 char tmp, *name = skip_spaces(line);
1103 if (name[0] == '\0')
1108 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1113 *namep = strdup(name);
1119 *rawp = skip_spaces(*rawp);
1124 free((void *)namep);
1129 struct annotate_args {
1132 struct map_symbol ms;
1133 struct perf_evsel *evsel;
1134 struct annotation_options *options;
1140 static void annotation_line__delete(struct annotation_line *al)
1142 void *ptr = (void *) al - al->privsize;
1144 free_srcline(al->path);
1150 * Allocating the annotation line data with following
1153 * --------------------------------------
1154 * private space | struct annotation_line
1155 * --------------------------------------
1157 * Size of the private space is stored in 'struct annotation_line'.
1160 static struct annotation_line *
1161 annotation_line__new(struct annotate_args *args, size_t privsize)
1163 struct annotation_line *al;
1164 struct perf_evsel *evsel = args->evsel;
1165 size_t size = privsize + sizeof(*al);
1168 if (perf_evsel__is_group_event(evsel))
1169 nr = evsel->nr_members;
1171 size += sizeof(al->data[0]) * nr;
1175 al = (void *) al + privsize;
1176 al->privsize = privsize;
1177 al->offset = args->offset;
1178 al->line = strdup(args->line);
1179 al->line_nr = args->line_nr;
1187 * Allocating the disasm annotation line data with
1188 * following structure:
1190 * ------------------------------------------------------------
1191 * privsize space | struct disasm_line | struct annotation_line
1192 * ------------------------------------------------------------
1194 * We have 'struct annotation_line' member as last member
1195 * of 'struct disasm_line' to have an easy access.
1198 static struct disasm_line *disasm_line__new(struct annotate_args *args)
1200 struct disasm_line *dl = NULL;
1201 struct annotation_line *al;
1202 size_t privsize = args->privsize + offsetof(struct disasm_line, al);
1204 al = annotation_line__new(args, privsize);
1206 dl = disasm_line(al);
1208 if (dl->al.line == NULL)
1211 if (args->offset != -1) {
1212 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1215 disasm_line__init_ins(dl, args->arch, &args->ms);
1222 zfree(&dl->al.line);
1228 void disasm_line__free(struct disasm_line *dl)
1230 if (dl->ins.ops && dl->ins.ops->free)
1231 dl->ins.ops->free(&dl->ops);
1233 ins__delete(&dl->ops);
1234 free((void *)dl->ins.name);
1235 dl->ins.name = NULL;
1236 annotation_line__delete(&dl->al);
1239 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1241 if (raw || !dl->ins.ops)
1242 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1244 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1247 static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1249 list_add_tail(&al->node, head);
1252 struct annotation_line *
1253 annotation_line__next(struct annotation_line *pos, struct list_head *head)
1255 list_for_each_entry_continue(pos, head, node)
1256 if (pos->offset >= 0)
1262 static const char *annotate__address_color(struct block_range *br)
1264 double cov = block_range__coverage(br);
1267 /* mark red for >75% coverage */
1269 return PERF_COLOR_RED;
1271 /* mark dull for <1% coverage */
1273 return PERF_COLOR_NORMAL;
1276 return PERF_COLOR_MAGENTA;
1279 static const char *annotate__asm_color(struct block_range *br)
1281 double cov = block_range__coverage(br);
1284 /* mark dull for <1% coverage */
1286 return PERF_COLOR_NORMAL;
1289 return PERF_COLOR_BLUE;
1292 static void annotate__branch_printf(struct block_range *br, u64 addr)
1294 bool emit_comment = true;
1300 if (br->is_target && br->start == addr) {
1301 struct block_range *branch = br;
1305 * Find matching branch to our target.
1307 while (!branch->is_branch)
1308 branch = block_range__next(branch);
1310 p = 100 *(double)br->entry / branch->coverage;
1314 emit_comment = false;
1319 * The percentage of coverage joined at this target in relation
1320 * to the next branch.
1322 printf(" +%.2f%%", p);
1326 if (br->is_branch && br->end == addr) {
1327 double p = 100*(double)br->taken / br->coverage;
1331 emit_comment = false;
1336 * The percentage of coverage leaving at this branch, and
1337 * its prediction ratio.
1339 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1344 static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1346 s64 offset = dl->al.offset;
1347 const u64 addr = start + offset;
1348 struct block_range *br;
1350 br = block_range__find(addr);
1351 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
1352 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1353 annotate__branch_printf(br, addr);
1358 annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1359 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
1360 int max_lines, struct annotation_line *queue, int addr_fmt_width,
1363 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1364 static const char *prev_line;
1365 static const char *prev_color;
1367 if (al->offset != -1) {
1368 double max_percent = 0.0;
1369 int i, nr_percent = 1;
1371 struct annotation *notes = symbol__annotation(sym);
1373 for (i = 0; i < al->data_nr; i++) {
1376 percent = annotation_data__percent(&al->data[i],
1379 if (percent > max_percent)
1380 max_percent = percent;
1383 if (al->data_nr > nr_percent)
1384 nr_percent = al->data_nr;
1386 if (max_percent < min_pcnt)
1389 if (max_lines && printed >= max_lines)
1392 if (queue != NULL) {
1393 list_for_each_entry_from(queue, ¬es->src->source, node) {
1396 annotation_line__print(queue, sym, start, evsel, len,
1397 0, 0, 1, NULL, addr_fmt_width,
1402 color = get_percent_color(max_percent);
1405 * Also color the filename and line if needed, with
1406 * the same color than the percentage. Don't print it
1407 * twice for close colored addr with the same filename:line
1410 if (!prev_line || strcmp(prev_line, al->path)
1411 || color != prev_color) {
1412 color_fprintf(stdout, color, " %s", al->path);
1413 prev_line = al->path;
1418 for (i = 0; i < nr_percent; i++) {
1419 struct annotation_data *data = &al->data[i];
1422 percent = annotation_data__percent(data, percent_type);
1423 color = get_percent_color(percent);
1425 if (symbol_conf.show_total_period)
1426 color_fprintf(stdout, color, " %11" PRIu64,
1428 else if (symbol_conf.show_nr_samples)
1429 color_fprintf(stdout, color, " %7" PRIu64,
1430 data->he.nr_samples);
1432 color_fprintf(stdout, color, " %7.2f", percent);
1437 disasm_line__print(dl, start, addr_fmt_width);
1439 } else if (max_lines && printed >= max_lines)
1442 int width = symbol_conf.show_total_period ? 12 : 8;
1447 if (perf_evsel__is_group_event(evsel))
1448 width *= evsel->nr_members;
1451 printf(" %*s:\n", width, " ");
1453 printf(" %*s: %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1460 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1461 * which looks like following
1463 * 0000000000415500 <_init>:
1464 * 415500: sub $0x8,%rsp
1465 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1466 * 41550b: test %rax,%rax
1467 * 41550e: je 415515 <_init+0x15>
1468 * 415510: callq 416e70 <__gmon_start__@plt>
1469 * 415515: add $0x8,%rsp
1472 * it will be parsed and saved into struct disasm_line as
1473 * <offset> <name> <ops.raw>
1475 * The offset will be a relative offset from the start of the symbol and -1
1476 * means that it's not a disassembly line so should be treated differently.
1477 * The ops.raw part will be parsed further according to type of the instruction.
1479 static int symbol__parse_objdump_line(struct symbol *sym, FILE *file,
1480 struct annotate_args *args,
1483 struct map *map = args->ms.map;
1484 struct annotation *notes = symbol__annotation(sym);
1485 struct disasm_line *dl;
1486 char *line = NULL, *parsed_line, *tmp, *tmp2;
1488 s64 line_ip, offset = -1;
1489 regmatch_t match[2];
1491 if (getline(&line, &line_len, file) < 0)
1498 parsed_line = rtrim(line);
1500 /* /filename:linenr ? Save line number and ignore. */
1501 if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1502 *line_nr = atoi(parsed_line + match[1].rm_so);
1506 tmp = skip_spaces(parsed_line);
1509 * Parse hexa addresses followed by ':'
1511 line_ip = strtoull(tmp, &tmp2, 16);
1512 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1516 if (line_ip != -1) {
1517 u64 start = map__rip_2objdump(map, sym->start),
1518 end = map__rip_2objdump(map, sym->end);
1520 offset = line_ip - start;
1521 if ((u64)line_ip < start || (u64)line_ip >= end)
1524 parsed_line = tmp2 + 1;
1527 args->offset = offset;
1528 args->line = parsed_line;
1529 args->line_nr = *line_nr;
1532 dl = disasm_line__new(args);
1539 if (!disasm_line__has_local_offset(dl)) {
1540 dl->ops.target.offset = dl->ops.target.addr -
1541 map__rip_2objdump(map, sym->start);
1542 dl->ops.target.offset_avail = true;
1545 /* kcore has no symbols, so add the call target symbol */
1546 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1547 struct addr_map_symbol target = {
1549 .addr = dl->ops.target.addr,
1552 if (!map_groups__find_ams(&target) &&
1553 target.sym->start == target.al_addr)
1554 dl->ops.target.sym = target.sym;
1557 annotation_line__add(&dl->al, ¬es->src->source);
1562 static __attribute__((constructor)) void symbol__init_regexpr(void)
1564 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1567 static void delete_last_nop(struct symbol *sym)
1569 struct annotation *notes = symbol__annotation(sym);
1570 struct list_head *list = ¬es->src->source;
1571 struct disasm_line *dl;
1573 while (!list_empty(list)) {
1574 dl = list_entry(list->prev, struct disasm_line, al.node);
1577 if (dl->ins.ops != &nop_ops)
1580 if (!strstr(dl->al.line, " nop ") &&
1581 !strstr(dl->al.line, " nopl ") &&
1582 !strstr(dl->al.line, " nopw "))
1586 list_del(&dl->al.node);
1587 disasm_line__free(dl);
1591 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1592 int errnum, char *buf, size_t buflen)
1594 struct dso *dso = map->dso;
1596 BUG_ON(buflen == 0);
1599 str_error_r(errnum, buf, buflen);
1604 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1605 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1606 char *build_id_msg = NULL;
1608 if (dso->has_build_id) {
1609 build_id__sprintf(dso->build_id,
1610 sizeof(dso->build_id), bf + 15);
1613 scnprintf(buf, buflen,
1614 "No vmlinux file%s\nwas found in the path.\n\n"
1615 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1617 " perf buildid-cache -vu vmlinux\n\n"
1619 " --vmlinux vmlinux\n", build_id_msg ?: "");
1622 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1623 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1626 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1633 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1635 char linkname[PATH_MAX];
1636 char *build_id_filename;
1637 char *build_id_path = NULL;
1640 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1641 !dso__is_kcore(dso))
1642 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1644 build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1645 if (build_id_filename) {
1646 __symbol__join_symfs(filename, filename_size, build_id_filename);
1647 free(build_id_filename);
1649 if (dso->has_build_id)
1654 build_id_path = strdup(filename);
1659 * old style build-id cache has name of XX/XXXXXXX.. while
1660 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1661 * extract the build-id part of dirname in the new style only.
1663 pos = strrchr(build_id_path, '/');
1664 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1665 dirname(build_id_path);
1667 if (dso__is_kcore(dso) ||
1668 readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1669 strstr(linkname, DSO__NAME_KALLSYMS) ||
1670 access(filename, R_OK)) {
1673 * If we don't have build-ids or the build-id file isn't in the
1674 * cache, or is just a kallsyms file, well, lets hope that this
1675 * DSO is the same as when 'perf record' ran.
1677 __symbol__join_symfs(filename, filename_size, dso->long_name);
1680 free(build_id_path);
1684 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1685 #define PACKAGE "perf"
1687 #include <dis-asm.h>
1689 static int symbol__disassemble_bpf(struct symbol *sym,
1690 struct annotate_args *args)
1692 struct annotation *notes = symbol__annotation(sym);
1693 struct annotation_options *opts = args->options;
1694 struct bpf_prog_info_linear *info_linear;
1695 struct bpf_prog_linfo *prog_linfo = NULL;
1696 struct bpf_prog_info_node *info_node;
1697 int len = sym->end - sym->start;
1698 disassembler_ftype disassemble;
1699 struct map *map = args->ms.map;
1700 struct disassemble_info info;
1701 struct dso *dso = map->dso;
1702 int pc = 0, count, sub_id;
1703 struct btf *btf = NULL;
1704 char tpath[PATH_MAX];
1712 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1715 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1716 sym->name, sym->start, sym->end - sym->start);
1718 memset(tpath, 0, sizeof(tpath));
1719 perf_exe(tpath, sizeof(tpath));
1721 bfdf = bfd_openr(tpath, NULL);
1723 assert(bfd_check_format(bfdf, bfd_object));
1725 s = open_memstream(&buf, &buf_size);
1728 init_disassemble_info(&info, s,
1729 (fprintf_ftype) fprintf);
1731 info.arch = bfd_get_arch(bfdf);
1732 info.mach = bfd_get_mach(bfdf);
1734 info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1738 info_linear = info_node->info_linear;
1739 sub_id = dso->bpf_prog.sub_id;
1741 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1742 info.buffer_length = info_linear->info.jited_prog_len;
1744 if (info_linear->info.nr_line_info)
1745 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1747 if (info_linear->info.btf_id) {
1748 struct btf_node *node;
1750 node = perf_env__find_btf(dso->bpf_prog.env,
1751 info_linear->info.btf_id);
1753 btf = btf__new((__u8 *)(node->data),
1757 disassemble_init_for_target(&info);
1759 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1760 disassemble = disassembler(info.arch,
1761 bfd_big_endian(bfdf),
1765 disassemble = disassembler(bfdf);
1767 assert(disassemble);
1771 const struct bpf_line_info *linfo = NULL;
1772 struct disasm_line *dl;
1773 size_t prev_buf_size;
1774 const char *srcline;
1777 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1778 count = disassemble(pc, &info);
1781 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1786 srcline = btf__name_by_offset(btf, linfo->line_off);
1792 prev_buf_size = buf_size;
1795 if (!opts->hide_src_code && srcline) {
1797 args->line = strdup(srcline);
1800 dl = disasm_line__new(args);
1802 annotation_line__add(&dl->al,
1803 ¬es->src->source);
1808 args->line = buf + prev_buf_size;
1811 dl = disasm_line__new(args);
1813 annotation_line__add(&dl->al, ¬es->src->source);
1816 } while (count > 0 && pc < len);
1826 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1827 static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1828 struct annotate_args *args __maybe_unused)
1830 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1832 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1834 static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1836 struct annotation_options *opts = args->options;
1837 struct map *map = args->ms.map;
1838 struct dso *dso = map->dso;
1841 char symfs_filename[PATH_MAX];
1842 struct kcore_extract kce;
1843 bool delete_extract = false;
1844 bool decomp = false;
1849 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1854 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1855 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1856 map->unmap_ip(map, sym->end));
1858 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1859 dso, dso->long_name, sym, sym->name);
1861 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1862 return symbol__disassemble_bpf(sym, args);
1863 } else if (dso__is_kcore(dso)) {
1864 kce.kcore_filename = symfs_filename;
1865 kce.addr = map__rip_2objdump(map, sym->start);
1866 kce.offs = sym->start;
1867 kce.len = sym->end - sym->start;
1868 if (!kcore_extract__create(&kce)) {
1869 delete_extract = true;
1870 strlcpy(symfs_filename, kce.extract_filename,
1871 sizeof(symfs_filename));
1873 } else if (dso__needs_decompress(dso)) {
1874 char tmp[KMOD_DECOMP_LEN];
1876 if (dso__decompress_kmodule_path(dso, symfs_filename,
1877 tmp, sizeof(tmp)) < 0)
1881 strcpy(symfs_filename, tmp);
1884 err = asprintf(&command,
1885 "%s %s%s --start-address=0x%016" PRIx64
1886 " --stop-address=0x%016" PRIx64
1887 " -l -d %s %s -C \"$1\" 2>/dev/null|grep -v \"$1:\"|expand",
1888 opts->objdump_path ?: "objdump",
1889 opts->disassembler_style ? "-M " : "",
1890 opts->disassembler_style ?: "",
1891 map__rip_2objdump(map, sym->start),
1892 map__rip_2objdump(map, sym->end),
1893 opts->show_asm_raw ? "" : "--no-show-raw",
1894 opts->annotate_src ? "-S" : "");
1897 pr_err("Failure allocating memory for the command to run\n");
1898 goto out_remove_tmp;
1901 pr_debug("Executing: %s\n", command);
1904 if (pipe(stdout_fd) < 0) {
1905 pr_err("Failure creating the pipe to run %s\n", command);
1906 goto out_free_command;
1911 pr_err("Failure forking to run %s\n", command);
1912 goto out_close_stdout;
1916 close(stdout_fd[0]);
1917 dup2(stdout_fd[1], 1);
1918 close(stdout_fd[1]);
1919 execl("/bin/sh", "sh", "-c", command, "--", symfs_filename,
1925 close(stdout_fd[1]);
1927 file = fdopen(stdout_fd[0], "r");
1929 pr_err("Failure creating FILE stream for %s\n", command);
1931 * If we were using debug info should retry with
1934 goto out_free_command;
1938 while (!feof(file)) {
1940 * The source code line number (lineno) needs to be kept in
1941 * across calls to symbol__parse_objdump_line(), so that it
1942 * can associate it with the instructions till the next one.
1943 * See disasm_line__new() and struct disasm_line::line_nr.
1945 if (symbol__parse_objdump_line(sym, file, args, &lineno) < 0)
1951 pr_err("No output from %s\n", command);
1954 * kallsyms does not have symbol sizes so there may a nop at the end.
1957 if (dso__is_kcore(dso))
1958 delete_last_nop(sym);
1965 close(stdout_fd[0]);
1968 unlink(symfs_filename);
1971 kcore_extract__delete(&kce);
1976 close(stdout_fd[1]);
1977 goto out_free_command;
1980 static void calc_percent(struct sym_hist *sym_hist,
1981 struct hists *hists,
1982 struct annotation_data *data,
1983 s64 offset, s64 end)
1985 unsigned int hits = 0;
1988 while (offset < end) {
1989 hits += sym_hist->addr[offset].nr_samples;
1990 period += sym_hist->addr[offset].period;
1994 if (sym_hist->nr_samples) {
1995 data->he.period = period;
1996 data->he.nr_samples = hits;
1997 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2000 if (hists->stats.nr_non_filtered_samples)
2001 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2003 if (sym_hist->period)
2004 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2006 if (hists->stats.total_period)
2007 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2010 static void annotation__calc_percent(struct annotation *notes,
2011 struct perf_evsel *leader, s64 len)
2013 struct annotation_line *al, *next;
2014 struct perf_evsel *evsel;
2016 list_for_each_entry(al, ¬es->src->source, node) {
2020 if (al->offset == -1)
2023 next = annotation_line__next(al, ¬es->src->source);
2024 end = next ? next->offset : len;
2026 for_each_group_evsel(evsel, leader) {
2027 struct hists *hists = evsel__hists(evsel);
2028 struct annotation_data *data;
2029 struct sym_hist *sym_hist;
2031 BUG_ON(i >= al->data_nr);
2033 sym_hist = annotation__histogram(notes, evsel->idx);
2034 data = &al->data[i++];
2036 calc_percent(sym_hist, hists, data, al->offset, end);
2041 void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel)
2043 struct annotation *notes = symbol__annotation(sym);
2045 annotation__calc_percent(notes, evsel, symbol__size(sym));
2048 int symbol__annotate(struct symbol *sym, struct map *map,
2049 struct perf_evsel *evsel, size_t privsize,
2050 struct annotation_options *options,
2051 struct arch **parch)
2053 struct annotation *notes = symbol__annotation(sym);
2054 struct annotate_args args = {
2055 .privsize = privsize,
2059 struct perf_env *env = perf_evsel__env(evsel);
2060 const char *arch_name = perf_env__arch(env);
2067 args.arch = arch = arch__find(arch_name);
2075 err = arch->init(arch, env ? env->cpuid : NULL);
2077 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2084 notes->start = map__rip_2objdump(map, sym->start);
2086 return symbol__disassemble(sym, &args);
2089 static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2090 struct annotation_options *opts)
2092 struct annotation_line *iter;
2093 struct rb_node **p = &root->rb_node;
2094 struct rb_node *parent = NULL;
2097 while (*p != NULL) {
2099 iter = rb_entry(parent, struct annotation_line, rb_node);
2101 ret = strcmp(iter->path, al->path);
2103 for (i = 0; i < al->data_nr; i++) {
2104 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2105 opts->percent_type);
2113 p = &(*p)->rb_right;
2116 for (i = 0; i < al->data_nr; i++) {
2117 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2118 opts->percent_type);
2121 rb_link_node(&al->rb_node, parent, p);
2122 rb_insert_color(&al->rb_node, root);
2125 static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2129 for (i = 0; i < a->data_nr; i++) {
2130 if (a->data[i].percent_sum == b->data[i].percent_sum)
2132 return a->data[i].percent_sum > b->data[i].percent_sum;
2138 static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2140 struct annotation_line *iter;
2141 struct rb_node **p = &root->rb_node;
2142 struct rb_node *parent = NULL;
2144 while (*p != NULL) {
2146 iter = rb_entry(parent, struct annotation_line, rb_node);
2148 if (cmp_source_line(al, iter))
2151 p = &(*p)->rb_right;
2154 rb_link_node(&al->rb_node, parent, p);
2155 rb_insert_color(&al->rb_node, root);
2158 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2160 struct annotation_line *al;
2161 struct rb_node *node;
2163 node = rb_first(src_root);
2165 struct rb_node *next;
2167 al = rb_entry(node, struct annotation_line, rb_node);
2168 next = rb_next(node);
2169 rb_erase(node, src_root);
2171 __resort_source_line(dest_root, al);
2176 static void print_summary(struct rb_root *root, const char *filename)
2178 struct annotation_line *al;
2179 struct rb_node *node;
2181 printf("\nSorted summary for file %s\n", filename);
2182 printf("----------------------------------------------\n\n");
2184 if (RB_EMPTY_ROOT(root)) {
2185 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2189 node = rb_first(root);
2191 double percent, percent_max = 0.0;
2196 al = rb_entry(node, struct annotation_line, rb_node);
2197 for (i = 0; i < al->data_nr; i++) {
2198 percent = al->data[i].percent_sum;
2199 color = get_percent_color(percent);
2200 color_fprintf(stdout, color, " %7.2f", percent);
2202 if (percent > percent_max)
2203 percent_max = percent;
2207 color = get_percent_color(percent_max);
2208 color_fprintf(stdout, color, " %s\n", path);
2210 node = rb_next(node);
2214 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
2216 struct annotation *notes = symbol__annotation(sym);
2217 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2218 u64 len = symbol__size(sym), offset;
2220 for (offset = 0; offset < len; ++offset)
2221 if (h->addr[offset].nr_samples != 0)
2222 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2223 sym->start + offset, h->addr[offset].nr_samples);
2224 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2227 static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2230 struct annotation_line *line;
2232 list_for_each_entry_reverse(line, lines, node) {
2233 if (line->offset != -1)
2234 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2240 int symbol__annotate_printf(struct symbol *sym, struct map *map,
2241 struct perf_evsel *evsel,
2242 struct annotation_options *opts)
2244 struct dso *dso = map->dso;
2246 const char *d_filename;
2247 const char *evsel_name = perf_evsel__name(evsel);
2248 struct annotation *notes = symbol__annotation(sym);
2249 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2250 struct annotation_line *pos, *queue = NULL;
2251 u64 start = map__rip_2objdump(map, sym->start);
2252 int printed = 2, queue_len = 0, addr_fmt_width;
2254 bool context = opts->context;
2256 int width = symbol_conf.show_total_period ? 12 : 8;
2257 int graph_dotted_len;
2260 filename = strdup(dso->long_name);
2264 if (opts->full_path)
2265 d_filename = filename;
2267 d_filename = basename(filename);
2269 len = symbol__size(sym);
2271 if (perf_evsel__is_group_event(evsel)) {
2272 width *= evsel->nr_members;
2273 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2277 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2279 width, width, symbol_conf.show_total_period ? "Period" :
2280 symbol_conf.show_nr_samples ? "Samples" : "Percent",
2281 d_filename, evsel_name, h->nr_samples,
2282 percent_type_str(opts->percent_type));
2284 printf("%-*.*s----\n",
2285 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2288 symbol__annotate_hits(sym, evsel);
2290 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2292 list_for_each_entry(pos, ¬es->src->source, node) {
2295 if (context && queue == NULL) {
2300 err = annotation_line__print(pos, sym, start, evsel, len,
2301 opts->min_pcnt, printed, opts->max_lines,
2302 queue, addr_fmt_width, opts->percent_type);
2308 printed += queue_len;
2314 /* filtered by max_lines */
2320 * Filtered by min_pcnt or non IP lines when
2325 if (queue_len == context)
2326 queue = list_entry(queue->node.next, typeof(*queue), node);
2338 static void FILE__set_percent_color(void *fp __maybe_unused,
2339 double percent __maybe_unused,
2340 bool current __maybe_unused)
2344 static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2345 int nr __maybe_unused, bool current __maybe_unused)
2350 static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2355 static void FILE__printf(void *fp, const char *fmt, ...)
2359 va_start(args, fmt);
2360 vfprintf(fp, fmt, args);
2364 static void FILE__write_graph(void *fp, int graph)
2369 case DARROW_CHAR: s = "↓"; break;
2370 case UARROW_CHAR: s = "↑"; break;
2371 case LARROW_CHAR: s = "←"; break;
2372 case RARROW_CHAR: s = "→"; break;
2373 default: s = "?"; break;
2379 static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2380 struct annotation_options *opts)
2382 struct annotation *notes = symbol__annotation(sym);
2383 struct annotation_write_ops wops = {
2386 .set_color = FILE__set_color,
2387 .set_percent_color = FILE__set_percent_color,
2388 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2389 .printf = FILE__printf,
2390 .write_graph = FILE__write_graph,
2392 struct annotation_line *al;
2394 list_for_each_entry(al, ¬es->src->source, node) {
2395 if (annotation_line__filter(al, notes))
2397 annotation_line__write(al, notes, &wops, opts);
2399 wops.first_line = false;
2405 int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel,
2406 struct annotation_options *opts)
2408 const char *ev_name = perf_evsel__name(evsel);
2414 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2417 fp = fopen(filename, "w");
2419 goto out_free_filename;
2421 if (perf_evsel__is_group_event(evsel)) {
2422 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2426 fprintf(fp, "%s() %s\nEvent: %s\n\n",
2427 ms->sym->name, ms->map->dso->long_name, ev_name);
2428 symbol__annotate_fprintf2(ms->sym, fp, opts);
2437 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2439 struct annotation *notes = symbol__annotation(sym);
2440 struct sym_hist *h = annotation__histogram(notes, evidx);
2442 memset(h, 0, notes->src->sizeof_sym_hist);
2445 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2447 struct annotation *notes = symbol__annotation(sym);
2448 struct sym_hist *h = annotation__histogram(notes, evidx);
2449 int len = symbol__size(sym), offset;
2452 for (offset = 0; offset < len; ++offset) {
2453 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2454 h->nr_samples += h->addr[offset].nr_samples;
2458 void annotated_source__purge(struct annotated_source *as)
2460 struct annotation_line *al, *n;
2462 list_for_each_entry_safe(al, n, &as->source, node) {
2463 list_del(&al->node);
2464 disasm_line__free(disasm_line(al));
2468 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2472 if (dl->al.offset == -1)
2473 return fprintf(fp, "%s\n", dl->al.line);
2475 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2477 if (dl->ops.raw[0] != '\0') {
2478 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2482 return printed + fprintf(fp, "\n");
2485 size_t disasm__fprintf(struct list_head *head, FILE *fp)
2487 struct disasm_line *pos;
2490 list_for_each_entry(pos, head, al.node)
2491 printed += disasm_line__fprintf(pos, fp);
2496 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2498 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2499 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2500 dl->ops.target.offset >= (s64)symbol__size(sym))
2506 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2508 u64 offset, size = symbol__size(sym);
2510 /* PLT symbols contain external offsets */
2511 if (strstr(sym->name, "@plt"))
2514 for (offset = 0; offset < size; ++offset) {
2515 struct annotation_line *al = notes->offsets[offset];
2516 struct disasm_line *dl;
2518 dl = disasm_line(al);
2520 if (!disasm_line__is_valid_local_jump(dl, sym))
2523 al = notes->offsets[dl->ops.target.offset];
2526 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2527 * have to adjust to the previous offset?
2532 if (++al->jump_sources > notes->max_jump_sources)
2533 notes->max_jump_sources = al->jump_sources;
2539 void annotation__set_offsets(struct annotation *notes, s64 size)
2541 struct annotation_line *al;
2543 notes->max_line_len = 0;
2545 list_for_each_entry(al, ¬es->src->source, node) {
2546 size_t line_len = strlen(al->line);
2548 if (notes->max_line_len < line_len)
2549 notes->max_line_len = line_len;
2550 al->idx = notes->nr_entries++;
2551 if (al->offset != -1) {
2552 al->idx_asm = notes->nr_asm_entries++;
2554 * FIXME: short term bandaid to cope with assembly
2555 * routines that comes with labels in the same column
2556 * as the address in objdump, sigh.
2558 * E.g. copy_user_generic_unrolled
2560 if (al->offset < size)
2561 notes->offsets[al->offset] = al;
2567 static inline int width_jumps(int n)
2576 static int annotation__max_ins_name(struct annotation *notes)
2578 int max_name = 0, len;
2579 struct annotation_line *al;
2581 list_for_each_entry(al, ¬es->src->source, node) {
2582 if (al->offset == -1)
2585 len = strlen(disasm_line(al)->ins.name);
2593 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2595 notes->widths.addr = notes->widths.target =
2596 notes->widths.min_addr = hex_width(symbol__size(sym));
2597 notes->widths.max_addr = hex_width(sym->end);
2598 notes->widths.jumps = width_jumps(notes->max_jump_sources);
2599 notes->widths.max_ins_name = annotation__max_ins_name(notes);
2602 void annotation__update_column_widths(struct annotation *notes)
2604 if (notes->options->use_offset)
2605 notes->widths.target = notes->widths.min_addr;
2607 notes->widths.target = notes->widths.max_addr;
2609 notes->widths.addr = notes->widths.target;
2611 if (notes->options->show_nr_jumps)
2612 notes->widths.addr += notes->widths.jumps + 1;
2615 static void annotation__calc_lines(struct annotation *notes, struct map *map,
2616 struct rb_root *root,
2617 struct annotation_options *opts)
2619 struct annotation_line *al;
2620 struct rb_root tmp_root = RB_ROOT;
2622 list_for_each_entry(al, ¬es->src->source, node) {
2623 double percent_max = 0.0;
2626 for (i = 0; i < al->data_nr; i++) {
2629 percent = annotation_data__percent(&al->data[i],
2630 opts->percent_type);
2632 if (percent > percent_max)
2633 percent_max = percent;
2636 if (percent_max <= 0.5)
2639 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2640 false, true, notes->start + al->offset);
2641 insert_source_line(&tmp_root, al, opts);
2644 resort_source_line(root, &tmp_root);
2647 static void symbol__calc_lines(struct symbol *sym, struct map *map,
2648 struct rb_root *root,
2649 struct annotation_options *opts)
2651 struct annotation *notes = symbol__annotation(sym);
2653 annotation__calc_lines(notes, map, root, opts);
2656 int symbol__tty_annotate2(struct symbol *sym, struct map *map,
2657 struct perf_evsel *evsel,
2658 struct annotation_options *opts)
2660 struct dso *dso = map->dso;
2661 struct rb_root source_line = RB_ROOT;
2662 struct hists *hists = evsel__hists(evsel);
2665 if (symbol__annotate2(sym, map, evsel, opts, NULL) < 0)
2668 if (opts->print_lines) {
2669 srcline_full_filename = opts->full_path;
2670 symbol__calc_lines(sym, map, &source_line, opts);
2671 print_summary(&source_line, dso->long_name);
2674 hists__scnprintf_title(hists, buf, sizeof(buf));
2675 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2676 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2677 symbol__annotate_fprintf2(sym, stdout, opts);
2679 annotated_source__purge(symbol__annotation(sym)->src);
2684 int symbol__tty_annotate(struct symbol *sym, struct map *map,
2685 struct perf_evsel *evsel,
2686 struct annotation_options *opts)
2688 struct dso *dso = map->dso;
2689 struct rb_root source_line = RB_ROOT;
2691 if (symbol__annotate(sym, map, evsel, 0, opts, NULL) < 0)
2694 symbol__calc_percent(sym, evsel);
2696 if (opts->print_lines) {
2697 srcline_full_filename = opts->full_path;
2698 symbol__calc_lines(sym, map, &source_line, opts);
2699 print_summary(&source_line, dso->long_name);
2702 symbol__annotate_printf(sym, map, evsel, opts);
2704 annotated_source__purge(symbol__annotation(sym)->src);
2709 bool ui__has_annotation(void)
2711 return use_browser == 1 && perf_hpp_list.sym;
2715 static double annotation_line__max_percent(struct annotation_line *al,
2716 struct annotation *notes,
2717 unsigned int percent_type)
2719 double percent_max = 0.0;
2722 for (i = 0; i < notes->nr_events; i++) {
2725 percent = annotation_data__percent(&al->data[i],
2728 if (percent > percent_max)
2729 percent_max = percent;
2735 static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2736 void *obj, char *bf, size_t size,
2737 void (*obj__printf)(void *obj, const char *fmt, ...),
2738 void (*obj__write_graph)(void *obj, int graph))
2740 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2741 if (ins__is_jump(&dl->ins)) {
2744 if (dl->ops.target.outside)
2746 fwd = dl->ops.target.offset > dl->al.offset;
2747 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2748 obj__printf(obj, " ");
2749 } else if (ins__is_call(&dl->ins)) {
2751 obj__write_graph(obj, RARROW_CHAR);
2752 obj__printf(obj, " ");
2753 } else if (ins__is_ret(&dl->ins)) {
2754 obj__write_graph(obj, LARROW_CHAR);
2755 obj__printf(obj, " ");
2757 obj__printf(obj, " ");
2760 obj__printf(obj, " ");
2763 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2766 static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2768 double ipc = 0.0, coverage = 0.0;
2770 if (notes->hit_cycles)
2771 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2773 if (notes->total_insn) {
2774 coverage = notes->cover_insn * 100.0 /
2775 ((double)notes->total_insn);
2778 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2782 static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2783 bool first_line, bool current_entry, bool change_color, int width,
2784 void *obj, unsigned int percent_type,
2785 int (*obj__set_color)(void *obj, int color),
2786 void (*obj__set_percent_color)(void *obj, double percent, bool current),
2787 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2788 void (*obj__printf)(void *obj, const char *fmt, ...),
2789 void (*obj__write_graph)(void *obj, int graph))
2792 double percent_max = annotation_line__max_percent(al, notes, percent_type);
2793 int pcnt_width = annotation__pcnt_width(notes),
2794 cycles_width = annotation__cycles_width(notes);
2795 bool show_title = false;
2799 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2800 if (notes->have_cycles) {
2801 if (al->ipc == 0.0 && al->cycles == 0)
2807 if (al->offset != -1 && percent_max != 0.0) {
2810 for (i = 0; i < notes->nr_events; i++) {
2813 percent = annotation_data__percent(&al->data[i], percent_type);
2815 obj__set_percent_color(obj, percent, current_entry);
2816 if (notes->options->show_total_period) {
2817 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2818 } else if (notes->options->show_nr_samples) {
2819 obj__printf(obj, "%6" PRIu64 " ",
2820 al->data[i].he.nr_samples);
2822 obj__printf(obj, "%6.2f ", percent);
2826 obj__set_percent_color(obj, 0, current_entry);
2829 obj__printf(obj, "%-*s", pcnt_width, " ");
2831 obj__printf(obj, "%-*s", pcnt_width,
2832 notes->options->show_total_period ? "Period" :
2833 notes->options->show_nr_samples ? "Samples" : "Percent");
2837 if (notes->have_cycles) {
2839 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2840 else if (!show_title)
2841 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2843 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2845 if (!notes->options->show_minmax_cycle) {
2847 obj__printf(obj, "%*" PRIu64 " ",
2848 ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2849 else if (!show_title)
2850 obj__printf(obj, "%*s",
2851 ANNOTATION__CYCLES_WIDTH, " ");
2853 obj__printf(obj, "%*s ",
2854 ANNOTATION__CYCLES_WIDTH - 1,
2860 scnprintf(str, sizeof(str),
2861 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2862 al->cycles, al->cycles_min,
2865 obj__printf(obj, "%*s ",
2866 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2868 } else if (!show_title)
2869 obj__printf(obj, "%*s",
2870 ANNOTATION__MINMAX_CYCLES_WIDTH,
2873 obj__printf(obj, "%*s ",
2874 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2878 if (show_title && !*al->line) {
2879 ipc_coverage_string(bf, sizeof(bf), notes);
2880 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2884 obj__printf(obj, " ");
2887 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
2888 else if (al->offset == -1) {
2889 if (al->line_nr && notes->options->show_linenr)
2890 printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
2892 printed = scnprintf(bf, sizeof(bf), "%-*s ", notes->widths.addr, " ");
2893 obj__printf(obj, bf);
2894 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
2896 u64 addr = al->offset;
2899 if (!notes->options->use_offset)
2900 addr += notes->start;
2902 if (!notes->options->use_offset) {
2903 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
2905 if (al->jump_sources &&
2906 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
2907 if (notes->options->show_nr_jumps) {
2909 printed = scnprintf(bf, sizeof(bf), "%*d ",
2910 notes->widths.jumps,
2912 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
2914 obj__printf(obj, bf);
2915 obj__set_color(obj, prev);
2918 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
2919 notes->widths.target, addr);
2920 } else if (ins__is_call(&disasm_line(al)->ins) &&
2921 notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
2923 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
2926 printed = scnprintf(bf, sizeof(bf), "%-*s ",
2927 notes->widths.addr, " ");
2932 color = obj__set_color(obj, HE_COLORSET_ADDR);
2933 obj__printf(obj, bf);
2935 obj__set_color(obj, color);
2937 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
2939 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
2944 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
2945 struct annotation_write_ops *wops,
2946 struct annotation_options *opts)
2948 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
2949 wops->change_color, wops->width, wops->obj,
2951 wops->set_color, wops->set_percent_color,
2952 wops->set_jumps_percent_color, wops->printf,
2956 int symbol__annotate2(struct symbol *sym, struct map *map, struct perf_evsel *evsel,
2957 struct annotation_options *options, struct arch **parch)
2959 struct annotation *notes = symbol__annotation(sym);
2960 size_t size = symbol__size(sym);
2961 int nr_pcnt = 1, err;
2963 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
2964 if (notes->offsets == NULL)
2967 if (perf_evsel__is_group_event(evsel))
2968 nr_pcnt = evsel->nr_members;
2970 err = symbol__annotate(sym, map, evsel, 0, options, parch);
2972 goto out_free_offsets;
2974 notes->options = options;
2976 symbol__calc_percent(sym, evsel);
2978 annotation__set_offsets(notes, size);
2979 annotation__mark_jump_targets(notes, sym);
2980 annotation__compute_ipc(notes, size);
2981 annotation__init_column_widths(notes, sym);
2982 notes->nr_events = nr_pcnt;
2984 annotation__update_column_widths(notes);
2985 sym->annotate2 = true;
2990 zfree(¬es->offsets);
2994 #define ANNOTATION__CFG(n) \
2995 { .name = #n, .value = &annotation__default_options.n, }
2998 * Keep the entries sorted, they are bsearch'ed
3000 static struct annotation_config {
3003 } annotation__configs[] = {
3004 ANNOTATION__CFG(hide_src_code),
3005 ANNOTATION__CFG(jump_arrows),
3006 ANNOTATION__CFG(offset_level),
3007 ANNOTATION__CFG(show_linenr),
3008 ANNOTATION__CFG(show_nr_jumps),
3009 ANNOTATION__CFG(show_nr_samples),
3010 ANNOTATION__CFG(show_total_period),
3011 ANNOTATION__CFG(use_offset),
3014 #undef ANNOTATION__CFG
3016 static int annotation_config__cmp(const void *name, const void *cfgp)
3018 const struct annotation_config *cfg = cfgp;
3020 return strcmp(name, cfg->name);
3023 static int annotation__config(const char *var, const char *value,
3024 void *data __maybe_unused)
3026 struct annotation_config *cfg;
3029 if (!strstarts(var, "annotate."))
3033 cfg = bsearch(name, annotation__configs, ARRAY_SIZE(annotation__configs),
3034 sizeof(struct annotation_config), annotation_config__cmp);
3037 pr_debug("%s variable unknown, ignoring...", var);
3038 else if (strcmp(var, "annotate.offset_level") == 0) {
3039 perf_config_int(cfg->value, name, value);
3041 if (*(int *)cfg->value > ANNOTATION__MAX_OFFSET_LEVEL)
3042 *(int *)cfg->value = ANNOTATION__MAX_OFFSET_LEVEL;
3043 else if (*(int *)cfg->value < ANNOTATION__MIN_OFFSET_LEVEL)
3044 *(int *)cfg->value = ANNOTATION__MIN_OFFSET_LEVEL;
3046 *(bool *)cfg->value = perf_config_bool(name, value);
3051 void annotation_config__init(void)
3053 perf_config(annotation__config, NULL);
3055 annotation__default_options.show_total_period = symbol_conf.show_total_period;
3056 annotation__default_options.show_nr_samples = symbol_conf.show_nr_samples;
3059 static unsigned int parse_percent_type(char *str1, char *str2)
3061 unsigned int type = (unsigned int) -1;
3063 if (!strcmp("period", str1)) {
3064 if (!strcmp("local", str2))
3065 type = PERCENT_PERIOD_LOCAL;
3066 else if (!strcmp("global", str2))
3067 type = PERCENT_PERIOD_GLOBAL;
3070 if (!strcmp("hits", str1)) {
3071 if (!strcmp("local", str2))
3072 type = PERCENT_HITS_LOCAL;
3073 else if (!strcmp("global", str2))
3074 type = PERCENT_HITS_GLOBAL;
3080 int annotate_parse_percent_type(const struct option *opt, const char *_str,
3081 int unset __maybe_unused)
3083 struct annotation_options *opts = opt->value;
3088 str1 = strdup(_str);
3092 str2 = strchr(str1, '-');
3098 type = parse_percent_type(str1, str2);
3099 if (type == (unsigned int) -1)
3100 type = parse_percent_type(str2, str1);
3101 if (type != (unsigned int) -1) {
3102 opts->percent_type = type;