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
15 #include <bpf/libbpf.h>
16 #include <linux/btf.h>
17 #include "util.h" // hex_width()
26 #include "map_groups.h"
34 #include "bpf-event.h"
35 #include "block-range.h"
37 #include "util/event.h"
38 #include "arch/common.h"
41 #include <linux/bitops.h>
42 #include <linux/kernel.h>
43 #include <linux/string.h>
44 #include <bpf/libbpf.h>
45 #include <subcmd/parse-options.h>
47 /* FIXME: For the HE_COLORSET */
48 #include "ui/browser.h"
51 * FIXME: Using the same values as slang.h,
52 * but that header may not be available everywhere
54 #define LARROW_CHAR ((unsigned char)',')
55 #define RARROW_CHAR ((unsigned char)'+')
56 #define DARROW_CHAR ((unsigned char)'.')
57 #define UARROW_CHAR ((unsigned char)'-')
59 #include <linux/ctype.h>
61 struct annotation_options annotation__default_options = {
65 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
66 .percent_type = PERCENT_PERIOD_LOCAL,
69 static regex_t file_lineno;
71 static struct ins_ops *ins__find(struct arch *arch, const char *name);
72 static void ins__sort(struct arch *arch);
73 static int disasm_line__parse(char *line, const char **namep, char **rawp);
77 struct ins *instructions;
78 size_t nr_instructions;
79 size_t nr_instructions_allocated;
80 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
81 bool sorted_instructions;
86 int (*init)(struct arch *arch, char *cpuid);
87 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
91 char skip_functions_char;
95 static struct ins_ops call_ops;
96 static struct ins_ops dec_ops;
97 static struct ins_ops jump_ops;
98 static struct ins_ops mov_ops;
99 static struct ins_ops nop_ops;
100 static struct ins_ops lock_ops;
101 static struct ins_ops ret_ops;
103 static int arch__grow_instructions(struct arch *arch)
105 struct ins *new_instructions;
106 size_t new_nr_allocated;
108 if (arch->nr_instructions_allocated == 0 && arch->instructions)
109 goto grow_from_non_allocated_table;
111 new_nr_allocated = arch->nr_instructions_allocated + 128;
112 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
113 if (new_instructions == NULL)
116 out_update_instructions:
117 arch->instructions = new_instructions;
118 arch->nr_instructions_allocated = new_nr_allocated;
121 grow_from_non_allocated_table:
122 new_nr_allocated = arch->nr_instructions + 128;
123 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
124 if (new_instructions == NULL)
127 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
128 goto out_update_instructions;
131 static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
135 if (arch->nr_instructions == arch->nr_instructions_allocated &&
136 arch__grow_instructions(arch))
139 ins = &arch->instructions[arch->nr_instructions];
140 ins->name = strdup(name);
145 arch->nr_instructions++;
151 #include "arch/arc/annotate/instructions.c"
152 #include "arch/arm/annotate/instructions.c"
153 #include "arch/arm64/annotate/instructions.c"
154 #include "arch/csky/annotate/instructions.c"
155 #include "arch/x86/annotate/instructions.c"
156 #include "arch/powerpc/annotate/instructions.c"
157 #include "arch/s390/annotate/instructions.c"
158 #include "arch/sparc/annotate/instructions.c"
160 static struct arch architectures[] = {
163 .init = arc__annotate_init,
167 .init = arm__annotate_init,
171 .init = arm64__annotate_init,
175 .init = csky__annotate_init,
179 .init = x86__annotate_init,
180 .instructions = x86__instructions,
181 .nr_instructions = ARRAY_SIZE(x86__instructions),
182 .ins_is_fused = x86__ins_is_fused,
189 .init = powerpc__annotate_init,
193 .init = s390__annotate_init,
200 .init = sparc__annotate_init,
207 static void ins__delete(struct ins_operands *ops)
211 zfree(&ops->source.raw);
212 zfree(&ops->source.name);
213 zfree(&ops->target.raw);
214 zfree(&ops->target.name);
217 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
218 struct ins_operands *ops, int max_ins_name)
220 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
223 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
224 struct ins_operands *ops, int max_ins_name)
226 if (ins->ops->scnprintf)
227 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
229 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
232 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
234 if (!arch || !arch->ins_is_fused)
237 return arch->ins_is_fused(arch, ins1, ins2);
240 static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
242 char *endptr, *tok, *name;
243 struct map *map = ms->map;
244 struct addr_map_symbol target = {
248 ops->target.addr = strtoull(ops->raw, &endptr, 16);
250 name = strchr(endptr, '<');
256 if (arch->objdump.skip_functions_char &&
257 strchr(name, arch->objdump.skip_functions_char))
260 tok = strchr(name, '>');
265 ops->target.name = strdup(name);
268 if (ops->target.name == NULL)
271 target.addr = map__objdump_2mem(map, ops->target.addr);
273 if (map_groups__find_ams(&target) == 0 &&
274 map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
275 ops->target.sym = target.sym;
280 tok = strchr(endptr, '*');
284 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
285 * Do not parse such instruction. */
286 if (strstr(endptr, "(%r") == NULL)
287 ops->target.addr = strtoull(endptr, NULL, 16);
292 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
293 struct ins_operands *ops, int max_ins_name)
296 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
298 if (ops->target.addr == 0)
299 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
301 if (ops->target.name)
302 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
304 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
307 static struct ins_ops call_ops = {
308 .parse = call__parse,
309 .scnprintf = call__scnprintf,
312 bool ins__is_call(const struct ins *ins)
314 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
318 * Prevents from matching commas in the comment section, e.g.:
319 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
321 static inline const char *validate_comma(const char *c, struct ins_operands *ops)
323 if (ops->raw_comment && c > ops->raw_comment)
329 static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
331 struct map *map = ms->map;
332 struct symbol *sym = ms->sym;
333 struct addr_map_symbol target = {
336 const char *c = strchr(ops->raw, ',');
339 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
340 c = validate_comma(c, ops);
343 * Examples of lines to parse for the _cpp_lex_token@@Base
346 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
347 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
349 * The first is a jump to an offset inside the same function,
350 * the second is to another function, i.e. that 0xa72 is an
351 * offset in the cpp_named_operator2name@@base function.
354 * skip over possible up to 2 operands to get to address, e.g.:
355 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
358 ops->target.addr = strtoull(c, NULL, 16);
359 if (!ops->target.addr) {
361 c = validate_comma(c, ops);
363 ops->target.addr = strtoull(c, NULL, 16);
366 ops->target.addr = strtoull(ops->raw, NULL, 16);
369 target.addr = map__objdump_2mem(map, ops->target.addr);
370 start = map->unmap_ip(map, sym->start),
371 end = map->unmap_ip(map, sym->end);
373 ops->target.outside = target.addr < start || target.addr > end;
376 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
378 cpp_named_operator2name@@Base+0xa72
380 * Point to a place that is after the cpp_named_operator2name
381 * boundaries, i.e. in the ELF symbol table for cc1
382 * cpp_named_operator2name is marked as being 32-bytes long, but it in
383 * fact is much larger than that, so we seem to need a symbols__find()
384 * routine that looks for >= current->start and < next_symbol->start,
385 * possibly just for C++ objects?
387 * For now lets just make some progress by marking jumps to outside the
388 * current function as call like.
390 * Actual navigation will come next, with further understanding of how
391 * the symbol searching and disassembly should be done.
393 if (map_groups__find_ams(&target) == 0 &&
394 map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
395 ops->target.sym = target.sym;
397 if (!ops->target.outside) {
398 ops->target.offset = target.addr - start;
399 ops->target.offset_avail = true;
401 ops->target.offset_avail = false;
407 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
408 struct ins_operands *ops, int max_ins_name)
412 if (!ops->target.addr || ops->target.offset < 0)
413 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
415 if (ops->target.outside && ops->target.sym != NULL)
416 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
418 c = strchr(ops->raw, ',');
419 c = validate_comma(c, ops);
422 const char *c2 = strchr(c + 1, ',');
424 c2 = validate_comma(c2, ops);
425 /* check for 3-op insn */
430 /* mirror arch objdump's space-after-comma style */
435 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
436 ins->name, c ? c - ops->raw : 0, ops->raw,
440 static struct ins_ops jump_ops = {
441 .parse = jump__parse,
442 .scnprintf = jump__scnprintf,
445 bool ins__is_jump(const struct ins *ins)
447 return ins->ops == &jump_ops;
450 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
452 char *endptr, *name, *t;
454 if (strstr(raw, "(%rip)") == NULL)
457 *addrp = strtoull(comment, &endptr, 16);
458 if (endptr == comment)
460 name = strchr(endptr, '<');
466 t = strchr(name, '>');
471 *namep = strdup(name);
477 static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
479 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
480 if (ops->locked.ops == NULL)
483 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
486 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
488 if (ops->locked.ins.ops == NULL)
491 if (ops->locked.ins.ops->parse &&
492 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
498 zfree(&ops->locked.ops);
502 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
503 struct ins_operands *ops, int max_ins_name)
507 if (ops->locked.ins.ops == NULL)
508 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
510 printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
511 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
512 size - printed, ops->locked.ops, max_ins_name);
515 static void lock__delete(struct ins_operands *ops)
517 struct ins *ins = &ops->locked.ins;
519 if (ins->ops && ins->ops->free)
520 ins->ops->free(ops->locked.ops);
522 ins__delete(ops->locked.ops);
524 zfree(&ops->locked.ops);
525 zfree(&ops->target.raw);
526 zfree(&ops->target.name);
529 static struct ins_ops lock_ops = {
530 .free = lock__delete,
531 .parse = lock__parse,
532 .scnprintf = lock__scnprintf,
535 static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
537 char *s = strchr(ops->raw, ','), *target, *comment, prev;
543 ops->source.raw = strdup(ops->raw);
546 if (ops->source.raw == NULL)
550 comment = strchr(s, arch->objdump.comment_char);
555 s = strchr(s, '\0') - 1;
557 while (s > target && isspace(s[0]))
563 ops->target.raw = strdup(target);
566 if (ops->target.raw == NULL)
567 goto out_free_source;
572 comment = skip_spaces(comment);
573 comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
574 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
579 zfree(&ops->source.raw);
583 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
584 struct ins_operands *ops, int max_ins_name)
586 return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
587 ops->source.name ?: ops->source.raw,
588 ops->target.name ?: ops->target.raw);
591 static struct ins_ops mov_ops = {
593 .scnprintf = mov__scnprintf,
596 static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
598 char *target, *comment, *s, prev;
600 target = s = ops->raw;
602 while (s[0] != '\0' && !isspace(s[0]))
607 ops->target.raw = strdup(target);
610 if (ops->target.raw == NULL)
613 comment = strchr(s, arch->objdump.comment_char);
617 comment = skip_spaces(comment);
618 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
623 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
624 struct ins_operands *ops, int max_ins_name)
626 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
627 ops->target.name ?: ops->target.raw);
630 static struct ins_ops dec_ops = {
632 .scnprintf = dec__scnprintf,
635 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
636 struct ins_operands *ops __maybe_unused, int max_ins_name)
638 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
641 static struct ins_ops nop_ops = {
642 .scnprintf = nop__scnprintf,
645 static struct ins_ops ret_ops = {
646 .scnprintf = ins__raw_scnprintf,
649 bool ins__is_ret(const struct ins *ins)
651 return ins->ops == &ret_ops;
654 bool ins__is_lock(const struct ins *ins)
656 return ins->ops == &lock_ops;
659 static int ins__key_cmp(const void *name, const void *insp)
661 const struct ins *ins = insp;
663 return strcmp(name, ins->name);
666 static int ins__cmp(const void *a, const void *b)
668 const struct ins *ia = a;
669 const struct ins *ib = b;
671 return strcmp(ia->name, ib->name);
674 static void ins__sort(struct arch *arch)
676 const int nmemb = arch->nr_instructions;
678 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
681 static struct ins_ops *__ins__find(struct arch *arch, const char *name)
684 const int nmemb = arch->nr_instructions;
686 if (!arch->sorted_instructions) {
688 arch->sorted_instructions = true;
691 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
692 return ins ? ins->ops : NULL;
695 static struct ins_ops *ins__find(struct arch *arch, const char *name)
697 struct ins_ops *ops = __ins__find(arch, name);
699 if (!ops && arch->associate_instruction_ops)
700 ops = arch->associate_instruction_ops(arch, name);
705 static int arch__key_cmp(const void *name, const void *archp)
707 const struct arch *arch = archp;
709 return strcmp(name, arch->name);
712 static int arch__cmp(const void *a, const void *b)
714 const struct arch *aa = a;
715 const struct arch *ab = b;
717 return strcmp(aa->name, ab->name);
720 static void arch__sort(void)
722 const int nmemb = ARRAY_SIZE(architectures);
724 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
727 static struct arch *arch__find(const char *name)
729 const int nmemb = ARRAY_SIZE(architectures);
737 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
740 static struct annotated_source *annotated_source__new(void)
742 struct annotated_source *src = zalloc(sizeof(*src));
745 INIT_LIST_HEAD(&src->source);
750 static __maybe_unused void annotated_source__delete(struct annotated_source *src)
754 zfree(&src->histograms);
755 zfree(&src->cycles_hist);
759 static int annotated_source__alloc_histograms(struct annotated_source *src,
760 size_t size, int nr_hists)
762 size_t sizeof_sym_hist;
765 * Add buffer of one element for zero length symbol.
766 * When sample is taken from first instruction of
767 * zero length symbol, perf still resolves it and
768 * shows symbol name in perf report and allows to
774 /* Check for overflow when calculating sizeof_sym_hist */
775 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
778 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
780 /* Check for overflow in zalloc argument */
781 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
784 src->sizeof_sym_hist = sizeof_sym_hist;
785 src->nr_histograms = nr_hists;
786 src->histograms = calloc(nr_hists, sizeof_sym_hist) ;
787 return src->histograms ? 0 : -1;
790 /* The cycles histogram is lazily allocated. */
791 static int symbol__alloc_hist_cycles(struct symbol *sym)
793 struct annotation *notes = symbol__annotation(sym);
794 const size_t size = symbol__size(sym);
796 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
797 if (notes->src->cycles_hist == NULL)
802 void symbol__annotate_zero_histograms(struct symbol *sym)
804 struct annotation *notes = symbol__annotation(sym);
806 pthread_mutex_lock(¬es->lock);
807 if (notes->src != NULL) {
808 memset(notes->src->histograms, 0,
809 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
810 if (notes->src->cycles_hist)
811 memset(notes->src->cycles_hist, 0,
812 symbol__size(sym) * sizeof(struct cyc_hist));
814 pthread_mutex_unlock(¬es->lock);
817 static int __symbol__account_cycles(struct cyc_hist *ch,
819 unsigned offset, unsigned cycles,
823 * For now we can only account one basic block per
824 * final jump. But multiple could be overlapping.
825 * Always account the longest one. So when
826 * a shorter one has been already seen throw it away.
828 * We separately always account the full cycles.
830 ch[offset].num_aggr++;
831 ch[offset].cycles_aggr += cycles;
833 if (cycles > ch[offset].cycles_max)
834 ch[offset].cycles_max = cycles;
836 if (ch[offset].cycles_min) {
837 if (cycles && cycles < ch[offset].cycles_min)
838 ch[offset].cycles_min = cycles;
840 ch[offset].cycles_min = cycles;
842 if (!have_start && ch[offset].have_start)
844 if (ch[offset].num) {
845 if (have_start && (!ch[offset].have_start ||
846 ch[offset].start > start)) {
847 ch[offset].have_start = 0;
848 ch[offset].cycles = 0;
850 if (ch[offset].reset < 0xffff)
852 } else if (have_start &&
853 ch[offset].start < start)
856 ch[offset].have_start = have_start;
857 ch[offset].start = start;
858 ch[offset].cycles += cycles;
863 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
864 struct annotated_source *src, int evidx, u64 addr,
865 struct perf_sample *sample)
870 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
872 if ((addr < sym->start || addr >= sym->end) &&
873 (addr != sym->end || sym->start != sym->end)) {
874 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
875 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
879 offset = addr - sym->start;
880 h = annotated_source__histogram(src, evidx);
882 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
883 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
887 h->addr[offset].nr_samples++;
888 h->period += sample->period;
889 h->addr[offset].period += sample->period;
891 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
892 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
893 sym->start, sym->name, addr, addr - sym->start, evidx,
894 h->addr[offset].nr_samples, h->addr[offset].period);
898 static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
900 struct annotation *notes = symbol__annotation(sym);
902 if (notes->src == NULL) {
903 notes->src = annotated_source__new();
904 if (notes->src == NULL)
906 goto alloc_cycles_hist;
909 if (!notes->src->cycles_hist) {
911 symbol__alloc_hist_cycles(sym);
914 return notes->src->cycles_hist;
917 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
919 struct annotation *notes = symbol__annotation(sym);
921 if (notes->src == NULL) {
922 notes->src = annotated_source__new();
923 if (notes->src == NULL)
925 goto alloc_histograms;
928 if (notes->src->histograms == NULL) {
930 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
937 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
938 struct evsel *evsel, u64 addr,
939 struct perf_sample *sample)
941 struct annotated_source *src;
945 src = symbol__hists(sym, evsel->evlist->core.nr_entries);
946 return (src) ? __symbol__inc_addr_samples(sym, map, src, evsel->idx,
950 static int symbol__account_cycles(u64 addr, u64 start,
951 struct symbol *sym, unsigned cycles)
953 struct cyc_hist *cycles_hist;
958 cycles_hist = symbol__cycles_hist(sym);
959 if (cycles_hist == NULL)
961 if (addr < sym->start || addr >= sym->end)
965 if (start < sym->start || start >= sym->end)
970 offset = addr - sym->start;
971 return __symbol__account_cycles(cycles_hist,
972 start ? start - sym->start : 0,
977 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
978 struct addr_map_symbol *start,
988 * Only set start when IPC can be computed. We can only
989 * compute it when the basic block is completely in a single
991 * Special case the case when the jump is elsewhere, but
992 * it starts on the function start.
995 (start->sym == ams->sym ||
997 start->addr == ams->sym->start + ams->map->start)))
998 saddr = start->al_addr;
1000 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
1002 start ? start->addr : 0,
1003 ams->sym ? ams->sym->start + ams->map->start : 0,
1005 err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
1007 pr_debug2("account_cycles failed %d\n", err);
1011 static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1013 unsigned n_insn = 0;
1016 for (offset = start; offset <= end; offset++) {
1017 if (notes->offsets[offset])
1023 static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1026 unsigned int cover_insn = 0;
1029 n_insn = annotation__count_insn(notes, start, end);
1030 if (n_insn && ch->num && ch->cycles) {
1031 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1033 /* Hide data when there are too many overlaps. */
1034 if (ch->reset >= 0x7fff)
1037 for (offset = start; offset <= end; offset++) {
1038 struct annotation_line *al = notes->offsets[offset];
1040 if (al && al->ipc == 0.0) {
1047 notes->hit_cycles += ch->cycles;
1048 notes->hit_insn += n_insn * ch->num;
1049 notes->cover_insn += cover_insn;
1054 void annotation__compute_ipc(struct annotation *notes, size_t size)
1058 if (!notes->src || !notes->src->cycles_hist)
1061 notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1062 notes->hit_cycles = 0;
1063 notes->hit_insn = 0;
1064 notes->cover_insn = 0;
1066 pthread_mutex_lock(¬es->lock);
1067 for (offset = size - 1; offset >= 0; --offset) {
1068 struct cyc_hist *ch;
1070 ch = ¬es->src->cycles_hist[offset];
1071 if (ch && ch->cycles) {
1072 struct annotation_line *al;
1075 annotation__count_and_fill(notes, ch->start, offset, ch);
1076 al = notes->offsets[offset];
1077 if (al && ch->num_aggr) {
1078 al->cycles = ch->cycles_aggr / ch->num_aggr;
1079 al->cycles_max = ch->cycles_max;
1080 al->cycles_min = ch->cycles_min;
1082 notes->have_cycles = true;
1085 pthread_mutex_unlock(¬es->lock);
1088 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1089 struct evsel *evsel)
1091 return symbol__inc_addr_samples(ams->sym, ams->map, evsel, ams->al_addr, sample);
1094 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1095 struct evsel *evsel, u64 ip)
1097 return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evsel, ip, sample);
1100 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1102 dl->ins.ops = ins__find(arch, dl->ins.name);
1107 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1111 static int disasm_line__parse(char *line, const char **namep, char **rawp)
1113 char tmp, *name = skip_spaces(line);
1115 if (name[0] == '\0')
1120 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1125 *namep = strdup(name);
1131 *rawp = strim(*rawp);
1139 struct annotate_args {
1142 struct map_symbol ms;
1143 struct evsel *evsel;
1144 struct annotation_options *options;
1150 static void annotation_line__delete(struct annotation_line *al)
1152 void *ptr = (void *) al - al->privsize;
1154 free_srcline(al->path);
1160 * Allocating the annotation line data with following
1163 * --------------------------------------
1164 * private space | struct annotation_line
1165 * --------------------------------------
1167 * Size of the private space is stored in 'struct annotation_line'.
1170 static struct annotation_line *
1171 annotation_line__new(struct annotate_args *args, size_t privsize)
1173 struct annotation_line *al;
1174 struct evsel *evsel = args->evsel;
1175 size_t size = privsize + sizeof(*al);
1178 if (perf_evsel__is_group_event(evsel))
1179 nr = evsel->core.nr_members;
1181 size += sizeof(al->data[0]) * nr;
1185 al = (void *) al + privsize;
1186 al->privsize = privsize;
1187 al->offset = args->offset;
1188 al->line = strdup(args->line);
1189 al->line_nr = args->line_nr;
1197 * Allocating the disasm annotation line data with
1198 * following structure:
1200 * ------------------------------------------------------------
1201 * privsize space | struct disasm_line | struct annotation_line
1202 * ------------------------------------------------------------
1204 * We have 'struct annotation_line' member as last member
1205 * of 'struct disasm_line' to have an easy access.
1208 static struct disasm_line *disasm_line__new(struct annotate_args *args)
1210 struct disasm_line *dl = NULL;
1211 struct annotation_line *al;
1212 size_t privsize = args->privsize + offsetof(struct disasm_line, al);
1214 al = annotation_line__new(args, privsize);
1216 dl = disasm_line(al);
1218 if (dl->al.line == NULL)
1221 if (args->offset != -1) {
1222 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1225 disasm_line__init_ins(dl, args->arch, &args->ms);
1232 zfree(&dl->al.line);
1238 void disasm_line__free(struct disasm_line *dl)
1240 if (dl->ins.ops && dl->ins.ops->free)
1241 dl->ins.ops->free(&dl->ops);
1243 ins__delete(&dl->ops);
1244 zfree(&dl->ins.name);
1245 annotation_line__delete(&dl->al);
1248 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1250 if (raw || !dl->ins.ops)
1251 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1253 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1256 static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1258 list_add_tail(&al->node, head);
1261 struct annotation_line *
1262 annotation_line__next(struct annotation_line *pos, struct list_head *head)
1264 list_for_each_entry_continue(pos, head, node)
1265 if (pos->offset >= 0)
1271 static const char *annotate__address_color(struct block_range *br)
1273 double cov = block_range__coverage(br);
1276 /* mark red for >75% coverage */
1278 return PERF_COLOR_RED;
1280 /* mark dull for <1% coverage */
1282 return PERF_COLOR_NORMAL;
1285 return PERF_COLOR_MAGENTA;
1288 static const char *annotate__asm_color(struct block_range *br)
1290 double cov = block_range__coverage(br);
1293 /* mark dull for <1% coverage */
1295 return PERF_COLOR_NORMAL;
1298 return PERF_COLOR_BLUE;
1301 static void annotate__branch_printf(struct block_range *br, u64 addr)
1303 bool emit_comment = true;
1309 if (br->is_target && br->start == addr) {
1310 struct block_range *branch = br;
1314 * Find matching branch to our target.
1316 while (!branch->is_branch)
1317 branch = block_range__next(branch);
1319 p = 100 *(double)br->entry / branch->coverage;
1323 emit_comment = false;
1328 * The percentage of coverage joined at this target in relation
1329 * to the next branch.
1331 printf(" +%.2f%%", p);
1335 if (br->is_branch && br->end == addr) {
1336 double p = 100*(double)br->taken / br->coverage;
1340 emit_comment = false;
1345 * The percentage of coverage leaving at this branch, and
1346 * its prediction ratio.
1348 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1353 static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1355 s64 offset = dl->al.offset;
1356 const u64 addr = start + offset;
1357 struct block_range *br;
1359 br = block_range__find(addr);
1360 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
1361 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1362 annotate__branch_printf(br, addr);
1367 annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1368 struct evsel *evsel, u64 len, int min_pcnt, int printed,
1369 int max_lines, struct annotation_line *queue, int addr_fmt_width,
1372 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1373 static const char *prev_line;
1374 static const char *prev_color;
1376 if (al->offset != -1) {
1377 double max_percent = 0.0;
1378 int i, nr_percent = 1;
1380 struct annotation *notes = symbol__annotation(sym);
1382 for (i = 0; i < al->data_nr; i++) {
1385 percent = annotation_data__percent(&al->data[i],
1388 if (percent > max_percent)
1389 max_percent = percent;
1392 if (al->data_nr > nr_percent)
1393 nr_percent = al->data_nr;
1395 if (max_percent < min_pcnt)
1398 if (max_lines && printed >= max_lines)
1401 if (queue != NULL) {
1402 list_for_each_entry_from(queue, ¬es->src->source, node) {
1405 annotation_line__print(queue, sym, start, evsel, len,
1406 0, 0, 1, NULL, addr_fmt_width,
1411 color = get_percent_color(max_percent);
1414 * Also color the filename and line if needed, with
1415 * the same color than the percentage. Don't print it
1416 * twice for close colored addr with the same filename:line
1419 if (!prev_line || strcmp(prev_line, al->path)
1420 || color != prev_color) {
1421 color_fprintf(stdout, color, " %s", al->path);
1422 prev_line = al->path;
1427 for (i = 0; i < nr_percent; i++) {
1428 struct annotation_data *data = &al->data[i];
1431 percent = annotation_data__percent(data, percent_type);
1432 color = get_percent_color(percent);
1434 if (symbol_conf.show_total_period)
1435 color_fprintf(stdout, color, " %11" PRIu64,
1437 else if (symbol_conf.show_nr_samples)
1438 color_fprintf(stdout, color, " %7" PRIu64,
1439 data->he.nr_samples);
1441 color_fprintf(stdout, color, " %7.2f", percent);
1446 disasm_line__print(dl, start, addr_fmt_width);
1448 } else if (max_lines && printed >= max_lines)
1451 int width = symbol_conf.show_total_period ? 12 : 8;
1456 if (perf_evsel__is_group_event(evsel))
1457 width *= evsel->core.nr_members;
1460 printf(" %*s:\n", width, " ");
1462 printf(" %*s: %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1469 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1470 * which looks like following
1472 * 0000000000415500 <_init>:
1473 * 415500: sub $0x8,%rsp
1474 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1475 * 41550b: test %rax,%rax
1476 * 41550e: je 415515 <_init+0x15>
1477 * 415510: callq 416e70 <__gmon_start__@plt>
1478 * 415515: add $0x8,%rsp
1481 * it will be parsed and saved into struct disasm_line as
1482 * <offset> <name> <ops.raw>
1484 * The offset will be a relative offset from the start of the symbol and -1
1485 * means that it's not a disassembly line so should be treated differently.
1486 * The ops.raw part will be parsed further according to type of the instruction.
1488 static int symbol__parse_objdump_line(struct symbol *sym, FILE *file,
1489 struct annotate_args *args,
1492 struct map *map = args->ms.map;
1493 struct annotation *notes = symbol__annotation(sym);
1494 struct disasm_line *dl;
1495 char *line = NULL, *parsed_line, *tmp, *tmp2;
1497 s64 line_ip, offset = -1;
1498 regmatch_t match[2];
1500 if (getline(&line, &line_len, file) < 0)
1507 parsed_line = strim(line);
1509 /* /filename:linenr ? Save line number and ignore. */
1510 if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1511 *line_nr = atoi(parsed_line + match[1].rm_so);
1515 tmp = skip_spaces(parsed_line);
1518 * Parse hexa addresses followed by ':'
1520 line_ip = strtoull(tmp, &tmp2, 16);
1521 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1525 if (line_ip != -1) {
1526 u64 start = map__rip_2objdump(map, sym->start),
1527 end = map__rip_2objdump(map, sym->end);
1529 offset = line_ip - start;
1530 if ((u64)line_ip < start || (u64)line_ip >= end)
1533 parsed_line = tmp2 + 1;
1536 args->offset = offset;
1537 args->line = parsed_line;
1538 args->line_nr = *line_nr;
1541 dl = disasm_line__new(args);
1548 if (!disasm_line__has_local_offset(dl)) {
1549 dl->ops.target.offset = dl->ops.target.addr -
1550 map__rip_2objdump(map, sym->start);
1551 dl->ops.target.offset_avail = true;
1554 /* kcore has no symbols, so add the call target symbol */
1555 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1556 struct addr_map_symbol target = {
1558 .addr = dl->ops.target.addr,
1561 if (!map_groups__find_ams(&target) &&
1562 target.sym->start == target.al_addr)
1563 dl->ops.target.sym = target.sym;
1566 annotation_line__add(&dl->al, ¬es->src->source);
1571 static __attribute__((constructor)) void symbol__init_regexpr(void)
1573 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1576 static void delete_last_nop(struct symbol *sym)
1578 struct annotation *notes = symbol__annotation(sym);
1579 struct list_head *list = ¬es->src->source;
1580 struct disasm_line *dl;
1582 while (!list_empty(list)) {
1583 dl = list_entry(list->prev, struct disasm_line, al.node);
1586 if (dl->ins.ops != &nop_ops)
1589 if (!strstr(dl->al.line, " nop ") &&
1590 !strstr(dl->al.line, " nopl ") &&
1591 !strstr(dl->al.line, " nopw "))
1595 list_del_init(&dl->al.node);
1596 disasm_line__free(dl);
1600 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1601 int errnum, char *buf, size_t buflen)
1603 struct dso *dso = map->dso;
1605 BUG_ON(buflen == 0);
1608 str_error_r(errnum, buf, buflen);
1613 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1614 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1615 char *build_id_msg = NULL;
1617 if (dso->has_build_id) {
1618 build_id__sprintf(dso->build_id,
1619 sizeof(dso->build_id), bf + 15);
1622 scnprintf(buf, buflen,
1623 "No vmlinux file%s\nwas found in the path.\n\n"
1624 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1626 " perf buildid-cache -vu vmlinux\n\n"
1628 " --vmlinux vmlinux\n", build_id_msg ?: "");
1631 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1632 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1635 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1642 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1644 char linkname[PATH_MAX];
1645 char *build_id_filename;
1646 char *build_id_path = NULL;
1649 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1650 !dso__is_kcore(dso))
1651 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1653 build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1654 if (build_id_filename) {
1655 __symbol__join_symfs(filename, filename_size, build_id_filename);
1656 free(build_id_filename);
1658 if (dso->has_build_id)
1663 build_id_path = strdup(filename);
1668 * old style build-id cache has name of XX/XXXXXXX.. while
1669 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1670 * extract the build-id part of dirname in the new style only.
1672 pos = strrchr(build_id_path, '/');
1673 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1674 dirname(build_id_path);
1676 if (dso__is_kcore(dso) ||
1677 readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1678 strstr(linkname, DSO__NAME_KALLSYMS) ||
1679 access(filename, R_OK)) {
1682 * If we don't have build-ids or the build-id file isn't in the
1683 * cache, or is just a kallsyms file, well, lets hope that this
1684 * DSO is the same as when 'perf record' ran.
1686 __symbol__join_symfs(filename, filename_size, dso->long_name);
1689 free(build_id_path);
1693 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1694 #define PACKAGE "perf"
1696 #include <dis-asm.h>
1698 static int symbol__disassemble_bpf(struct symbol *sym,
1699 struct annotate_args *args)
1701 struct annotation *notes = symbol__annotation(sym);
1702 struct annotation_options *opts = args->options;
1703 struct bpf_prog_info_linear *info_linear;
1704 struct bpf_prog_linfo *prog_linfo = NULL;
1705 struct bpf_prog_info_node *info_node;
1706 int len = sym->end - sym->start;
1707 disassembler_ftype disassemble;
1708 struct map *map = args->ms.map;
1709 struct disassemble_info info;
1710 struct dso *dso = map->dso;
1711 int pc = 0, count, sub_id;
1712 struct btf *btf = NULL;
1713 char tpath[PATH_MAX];
1721 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1724 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1725 sym->name, sym->start, sym->end - sym->start);
1727 memset(tpath, 0, sizeof(tpath));
1728 perf_exe(tpath, sizeof(tpath));
1730 bfdf = bfd_openr(tpath, NULL);
1732 assert(bfd_check_format(bfdf, bfd_object));
1734 s = open_memstream(&buf, &buf_size);
1737 init_disassemble_info(&info, s,
1738 (fprintf_ftype) fprintf);
1740 info.arch = bfd_get_arch(bfdf);
1741 info.mach = bfd_get_mach(bfdf);
1743 info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1747 info_linear = info_node->info_linear;
1748 sub_id = dso->bpf_prog.sub_id;
1750 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1751 info.buffer_length = info_linear->info.jited_prog_len;
1753 if (info_linear->info.nr_line_info)
1754 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1756 if (info_linear->info.btf_id) {
1757 struct btf_node *node;
1759 node = perf_env__find_btf(dso->bpf_prog.env,
1760 info_linear->info.btf_id);
1762 btf = btf__new((__u8 *)(node->data),
1766 disassemble_init_for_target(&info);
1768 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1769 disassemble = disassembler(info.arch,
1770 bfd_big_endian(bfdf),
1774 disassemble = disassembler(bfdf);
1776 assert(disassemble);
1780 const struct bpf_line_info *linfo = NULL;
1781 struct disasm_line *dl;
1782 size_t prev_buf_size;
1783 const char *srcline;
1786 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1787 count = disassemble(pc, &info);
1790 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1795 srcline = btf__name_by_offset(btf, linfo->line_off);
1801 prev_buf_size = buf_size;
1804 if (!opts->hide_src_code && srcline) {
1806 args->line = strdup(srcline);
1809 dl = disasm_line__new(args);
1811 annotation_line__add(&dl->al,
1812 ¬es->src->source);
1817 args->line = buf + prev_buf_size;
1820 dl = disasm_line__new(args);
1822 annotation_line__add(&dl->al, ¬es->src->source);
1825 } while (count > 0 && pc < len);
1835 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1836 static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1837 struct annotate_args *args __maybe_unused)
1839 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1841 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1843 static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1845 struct annotation_options *opts = args->options;
1846 struct map *map = args->ms.map;
1847 struct dso *dso = map->dso;
1850 char symfs_filename[PATH_MAX];
1851 struct kcore_extract kce;
1852 bool delete_extract = false;
1853 bool decomp = false;
1858 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1863 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1864 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1865 map->unmap_ip(map, sym->end));
1867 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1868 dso, dso->long_name, sym, sym->name);
1870 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1871 return symbol__disassemble_bpf(sym, args);
1872 } else if (dso__is_kcore(dso)) {
1873 kce.kcore_filename = symfs_filename;
1874 kce.addr = map__rip_2objdump(map, sym->start);
1875 kce.offs = sym->start;
1876 kce.len = sym->end - sym->start;
1877 if (!kcore_extract__create(&kce)) {
1878 delete_extract = true;
1879 strlcpy(symfs_filename, kce.extract_filename,
1880 sizeof(symfs_filename));
1882 } else if (dso__needs_decompress(dso)) {
1883 char tmp[KMOD_DECOMP_LEN];
1885 if (dso__decompress_kmodule_path(dso, symfs_filename,
1886 tmp, sizeof(tmp)) < 0)
1890 strcpy(symfs_filename, tmp);
1893 err = asprintf(&command,
1894 "%s %s%s --start-address=0x%016" PRIx64
1895 " --stop-address=0x%016" PRIx64
1896 " -l -d %s %s -C \"$1\" 2>/dev/null|grep -v \"$1:\"|expand",
1897 opts->objdump_path ?: "objdump",
1898 opts->disassembler_style ? "-M " : "",
1899 opts->disassembler_style ?: "",
1900 map__rip_2objdump(map, sym->start),
1901 map__rip_2objdump(map, sym->end),
1902 opts->show_asm_raw ? "" : "--no-show-raw",
1903 opts->annotate_src ? "-S" : "");
1906 pr_err("Failure allocating memory for the command to run\n");
1907 goto out_remove_tmp;
1910 pr_debug("Executing: %s\n", command);
1913 if (pipe(stdout_fd) < 0) {
1914 pr_err("Failure creating the pipe to run %s\n", command);
1915 goto out_free_command;
1920 pr_err("Failure forking to run %s\n", command);
1921 goto out_close_stdout;
1925 close(stdout_fd[0]);
1926 dup2(stdout_fd[1], 1);
1927 close(stdout_fd[1]);
1928 execl("/bin/sh", "sh", "-c", command, "--", symfs_filename,
1934 close(stdout_fd[1]);
1936 file = fdopen(stdout_fd[0], "r");
1938 pr_err("Failure creating FILE stream for %s\n", command);
1940 * If we were using debug info should retry with
1943 goto out_free_command;
1947 while (!feof(file)) {
1949 * The source code line number (lineno) needs to be kept in
1950 * across calls to symbol__parse_objdump_line(), so that it
1951 * can associate it with the instructions till the next one.
1952 * See disasm_line__new() and struct disasm_line::line_nr.
1954 if (symbol__parse_objdump_line(sym, file, args, &lineno) < 0)
1960 pr_err("No output from %s\n", command);
1963 * kallsyms does not have symbol sizes so there may a nop at the end.
1966 if (dso__is_kcore(dso))
1967 delete_last_nop(sym);
1974 close(stdout_fd[0]);
1977 unlink(symfs_filename);
1980 kcore_extract__delete(&kce);
1985 close(stdout_fd[1]);
1986 goto out_free_command;
1989 static void calc_percent(struct sym_hist *sym_hist,
1990 struct hists *hists,
1991 struct annotation_data *data,
1992 s64 offset, s64 end)
1994 unsigned int hits = 0;
1997 while (offset < end) {
1998 hits += sym_hist->addr[offset].nr_samples;
1999 period += sym_hist->addr[offset].period;
2003 if (sym_hist->nr_samples) {
2004 data->he.period = period;
2005 data->he.nr_samples = hits;
2006 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2009 if (hists->stats.nr_non_filtered_samples)
2010 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2012 if (sym_hist->period)
2013 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2015 if (hists->stats.total_period)
2016 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2019 static void annotation__calc_percent(struct annotation *notes,
2020 struct evsel *leader, s64 len)
2022 struct annotation_line *al, *next;
2023 struct evsel *evsel;
2025 list_for_each_entry(al, ¬es->src->source, node) {
2029 if (al->offset == -1)
2032 next = annotation_line__next(al, ¬es->src->source);
2033 end = next ? next->offset : len;
2035 for_each_group_evsel(evsel, leader) {
2036 struct hists *hists = evsel__hists(evsel);
2037 struct annotation_data *data;
2038 struct sym_hist *sym_hist;
2040 BUG_ON(i >= al->data_nr);
2042 sym_hist = annotation__histogram(notes, evsel->idx);
2043 data = &al->data[i++];
2045 calc_percent(sym_hist, hists, data, al->offset, end);
2050 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
2052 struct annotation *notes = symbol__annotation(sym);
2054 annotation__calc_percent(notes, evsel, symbol__size(sym));
2057 int symbol__annotate(struct symbol *sym, struct map *map,
2058 struct evsel *evsel, size_t privsize,
2059 struct annotation_options *options,
2060 struct arch **parch)
2062 struct annotation *notes = symbol__annotation(sym);
2063 struct annotate_args args = {
2064 .privsize = privsize,
2068 struct perf_env *env = perf_evsel__env(evsel);
2069 const char *arch_name = perf_env__arch(env);
2076 args.arch = arch = arch__find(arch_name);
2084 err = arch->init(arch, env ? env->cpuid : NULL);
2086 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2093 notes->start = map__rip_2objdump(map, sym->start);
2095 return symbol__disassemble(sym, &args);
2098 static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2099 struct annotation_options *opts)
2101 struct annotation_line *iter;
2102 struct rb_node **p = &root->rb_node;
2103 struct rb_node *parent = NULL;
2106 while (*p != NULL) {
2108 iter = rb_entry(parent, struct annotation_line, rb_node);
2110 ret = strcmp(iter->path, al->path);
2112 for (i = 0; i < al->data_nr; i++) {
2113 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2114 opts->percent_type);
2122 p = &(*p)->rb_right;
2125 for (i = 0; i < al->data_nr; i++) {
2126 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2127 opts->percent_type);
2130 rb_link_node(&al->rb_node, parent, p);
2131 rb_insert_color(&al->rb_node, root);
2134 static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2138 for (i = 0; i < a->data_nr; i++) {
2139 if (a->data[i].percent_sum == b->data[i].percent_sum)
2141 return a->data[i].percent_sum > b->data[i].percent_sum;
2147 static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2149 struct annotation_line *iter;
2150 struct rb_node **p = &root->rb_node;
2151 struct rb_node *parent = NULL;
2153 while (*p != NULL) {
2155 iter = rb_entry(parent, struct annotation_line, rb_node);
2157 if (cmp_source_line(al, iter))
2160 p = &(*p)->rb_right;
2163 rb_link_node(&al->rb_node, parent, p);
2164 rb_insert_color(&al->rb_node, root);
2167 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2169 struct annotation_line *al;
2170 struct rb_node *node;
2172 node = rb_first(src_root);
2174 struct rb_node *next;
2176 al = rb_entry(node, struct annotation_line, rb_node);
2177 next = rb_next(node);
2178 rb_erase(node, src_root);
2180 __resort_source_line(dest_root, al);
2185 static void print_summary(struct rb_root *root, const char *filename)
2187 struct annotation_line *al;
2188 struct rb_node *node;
2190 printf("\nSorted summary for file %s\n", filename);
2191 printf("----------------------------------------------\n\n");
2193 if (RB_EMPTY_ROOT(root)) {
2194 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2198 node = rb_first(root);
2200 double percent, percent_max = 0.0;
2205 al = rb_entry(node, struct annotation_line, rb_node);
2206 for (i = 0; i < al->data_nr; i++) {
2207 percent = al->data[i].percent_sum;
2208 color = get_percent_color(percent);
2209 color_fprintf(stdout, color, " %7.2f", percent);
2211 if (percent > percent_max)
2212 percent_max = percent;
2216 color = get_percent_color(percent_max);
2217 color_fprintf(stdout, color, " %s\n", path);
2219 node = rb_next(node);
2223 static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
2225 struct annotation *notes = symbol__annotation(sym);
2226 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2227 u64 len = symbol__size(sym), offset;
2229 for (offset = 0; offset < len; ++offset)
2230 if (h->addr[offset].nr_samples != 0)
2231 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2232 sym->start + offset, h->addr[offset].nr_samples);
2233 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2236 static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2239 struct annotation_line *line;
2241 list_for_each_entry_reverse(line, lines, node) {
2242 if (line->offset != -1)
2243 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2249 int symbol__annotate_printf(struct symbol *sym, struct map *map,
2250 struct evsel *evsel,
2251 struct annotation_options *opts)
2253 struct dso *dso = map->dso;
2255 const char *d_filename;
2256 const char *evsel_name = perf_evsel__name(evsel);
2257 struct annotation *notes = symbol__annotation(sym);
2258 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2259 struct annotation_line *pos, *queue = NULL;
2260 u64 start = map__rip_2objdump(map, sym->start);
2261 int printed = 2, queue_len = 0, addr_fmt_width;
2263 bool context = opts->context;
2265 int width = symbol_conf.show_total_period ? 12 : 8;
2266 int graph_dotted_len;
2269 filename = strdup(dso->long_name);
2273 if (opts->full_path)
2274 d_filename = filename;
2276 d_filename = basename(filename);
2278 len = symbol__size(sym);
2280 if (perf_evsel__is_group_event(evsel)) {
2281 width *= evsel->core.nr_members;
2282 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2286 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2288 width, width, symbol_conf.show_total_period ? "Period" :
2289 symbol_conf.show_nr_samples ? "Samples" : "Percent",
2290 d_filename, evsel_name, h->nr_samples,
2291 percent_type_str(opts->percent_type));
2293 printf("%-*.*s----\n",
2294 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2297 symbol__annotate_hits(sym, evsel);
2299 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2301 list_for_each_entry(pos, ¬es->src->source, node) {
2304 if (context && queue == NULL) {
2309 err = annotation_line__print(pos, sym, start, evsel, len,
2310 opts->min_pcnt, printed, opts->max_lines,
2311 queue, addr_fmt_width, opts->percent_type);
2317 printed += queue_len;
2323 /* filtered by max_lines */
2329 * Filtered by min_pcnt or non IP lines when
2334 if (queue_len == context)
2335 queue = list_entry(queue->node.next, typeof(*queue), node);
2347 static void FILE__set_percent_color(void *fp __maybe_unused,
2348 double percent __maybe_unused,
2349 bool current __maybe_unused)
2353 static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2354 int nr __maybe_unused, bool current __maybe_unused)
2359 static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2364 static void FILE__printf(void *fp, const char *fmt, ...)
2368 va_start(args, fmt);
2369 vfprintf(fp, fmt, args);
2373 static void FILE__write_graph(void *fp, int graph)
2378 case DARROW_CHAR: s = "↓"; break;
2379 case UARROW_CHAR: s = "↑"; break;
2380 case LARROW_CHAR: s = "←"; break;
2381 case RARROW_CHAR: s = "→"; break;
2382 default: s = "?"; break;
2388 static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2389 struct annotation_options *opts)
2391 struct annotation *notes = symbol__annotation(sym);
2392 struct annotation_write_ops wops = {
2395 .set_color = FILE__set_color,
2396 .set_percent_color = FILE__set_percent_color,
2397 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2398 .printf = FILE__printf,
2399 .write_graph = FILE__write_graph,
2401 struct annotation_line *al;
2403 list_for_each_entry(al, ¬es->src->source, node) {
2404 if (annotation_line__filter(al, notes))
2406 annotation_line__write(al, notes, &wops, opts);
2408 wops.first_line = false;
2414 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
2415 struct annotation_options *opts)
2417 const char *ev_name = perf_evsel__name(evsel);
2423 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2426 fp = fopen(filename, "w");
2428 goto out_free_filename;
2430 if (perf_evsel__is_group_event(evsel)) {
2431 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2435 fprintf(fp, "%s() %s\nEvent: %s\n\n",
2436 ms->sym->name, ms->map->dso->long_name, ev_name);
2437 symbol__annotate_fprintf2(ms->sym, fp, opts);
2446 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2448 struct annotation *notes = symbol__annotation(sym);
2449 struct sym_hist *h = annotation__histogram(notes, evidx);
2451 memset(h, 0, notes->src->sizeof_sym_hist);
2454 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2456 struct annotation *notes = symbol__annotation(sym);
2457 struct sym_hist *h = annotation__histogram(notes, evidx);
2458 int len = symbol__size(sym), offset;
2461 for (offset = 0; offset < len; ++offset) {
2462 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2463 h->nr_samples += h->addr[offset].nr_samples;
2467 void annotated_source__purge(struct annotated_source *as)
2469 struct annotation_line *al, *n;
2471 list_for_each_entry_safe(al, n, &as->source, node) {
2472 list_del_init(&al->node);
2473 disasm_line__free(disasm_line(al));
2477 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2481 if (dl->al.offset == -1)
2482 return fprintf(fp, "%s\n", dl->al.line);
2484 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2486 if (dl->ops.raw[0] != '\0') {
2487 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2491 return printed + fprintf(fp, "\n");
2494 size_t disasm__fprintf(struct list_head *head, FILE *fp)
2496 struct disasm_line *pos;
2499 list_for_each_entry(pos, head, al.node)
2500 printed += disasm_line__fprintf(pos, fp);
2505 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2507 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2508 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2509 dl->ops.target.offset >= (s64)symbol__size(sym))
2515 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2517 u64 offset, size = symbol__size(sym);
2519 /* PLT symbols contain external offsets */
2520 if (strstr(sym->name, "@plt"))
2523 for (offset = 0; offset < size; ++offset) {
2524 struct annotation_line *al = notes->offsets[offset];
2525 struct disasm_line *dl;
2527 dl = disasm_line(al);
2529 if (!disasm_line__is_valid_local_jump(dl, sym))
2532 al = notes->offsets[dl->ops.target.offset];
2535 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2536 * have to adjust to the previous offset?
2541 if (++al->jump_sources > notes->max_jump_sources)
2542 notes->max_jump_sources = al->jump_sources;
2548 void annotation__set_offsets(struct annotation *notes, s64 size)
2550 struct annotation_line *al;
2552 notes->max_line_len = 0;
2554 list_for_each_entry(al, ¬es->src->source, node) {
2555 size_t line_len = strlen(al->line);
2557 if (notes->max_line_len < line_len)
2558 notes->max_line_len = line_len;
2559 al->idx = notes->nr_entries++;
2560 if (al->offset != -1) {
2561 al->idx_asm = notes->nr_asm_entries++;
2563 * FIXME: short term bandaid to cope with assembly
2564 * routines that comes with labels in the same column
2565 * as the address in objdump, sigh.
2567 * E.g. copy_user_generic_unrolled
2569 if (al->offset < size)
2570 notes->offsets[al->offset] = al;
2576 static inline int width_jumps(int n)
2585 static int annotation__max_ins_name(struct annotation *notes)
2587 int max_name = 0, len;
2588 struct annotation_line *al;
2590 list_for_each_entry(al, ¬es->src->source, node) {
2591 if (al->offset == -1)
2594 len = strlen(disasm_line(al)->ins.name);
2602 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2604 notes->widths.addr = notes->widths.target =
2605 notes->widths.min_addr = hex_width(symbol__size(sym));
2606 notes->widths.max_addr = hex_width(sym->end);
2607 notes->widths.jumps = width_jumps(notes->max_jump_sources);
2608 notes->widths.max_ins_name = annotation__max_ins_name(notes);
2611 void annotation__update_column_widths(struct annotation *notes)
2613 if (notes->options->use_offset)
2614 notes->widths.target = notes->widths.min_addr;
2616 notes->widths.target = notes->widths.max_addr;
2618 notes->widths.addr = notes->widths.target;
2620 if (notes->options->show_nr_jumps)
2621 notes->widths.addr += notes->widths.jumps + 1;
2624 static void annotation__calc_lines(struct annotation *notes, struct map *map,
2625 struct rb_root *root,
2626 struct annotation_options *opts)
2628 struct annotation_line *al;
2629 struct rb_root tmp_root = RB_ROOT;
2631 list_for_each_entry(al, ¬es->src->source, node) {
2632 double percent_max = 0.0;
2635 for (i = 0; i < al->data_nr; i++) {
2638 percent = annotation_data__percent(&al->data[i],
2639 opts->percent_type);
2641 if (percent > percent_max)
2642 percent_max = percent;
2645 if (percent_max <= 0.5)
2648 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2649 false, true, notes->start + al->offset);
2650 insert_source_line(&tmp_root, al, opts);
2653 resort_source_line(root, &tmp_root);
2656 static void symbol__calc_lines(struct symbol *sym, struct map *map,
2657 struct rb_root *root,
2658 struct annotation_options *opts)
2660 struct annotation *notes = symbol__annotation(sym);
2662 annotation__calc_lines(notes, map, root, opts);
2665 int symbol__tty_annotate2(struct symbol *sym, struct map *map,
2666 struct evsel *evsel,
2667 struct annotation_options *opts)
2669 struct dso *dso = map->dso;
2670 struct rb_root source_line = RB_ROOT;
2671 struct hists *hists = evsel__hists(evsel);
2674 if (symbol__annotate2(sym, map, evsel, opts, NULL) < 0)
2677 if (opts->print_lines) {
2678 srcline_full_filename = opts->full_path;
2679 symbol__calc_lines(sym, map, &source_line, opts);
2680 print_summary(&source_line, dso->long_name);
2683 hists__scnprintf_title(hists, buf, sizeof(buf));
2684 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2685 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2686 symbol__annotate_fprintf2(sym, stdout, opts);
2688 annotated_source__purge(symbol__annotation(sym)->src);
2693 int symbol__tty_annotate(struct symbol *sym, struct map *map,
2694 struct evsel *evsel,
2695 struct annotation_options *opts)
2697 struct dso *dso = map->dso;
2698 struct rb_root source_line = RB_ROOT;
2700 if (symbol__annotate(sym, map, evsel, 0, opts, NULL) < 0)
2703 symbol__calc_percent(sym, evsel);
2705 if (opts->print_lines) {
2706 srcline_full_filename = opts->full_path;
2707 symbol__calc_lines(sym, map, &source_line, opts);
2708 print_summary(&source_line, dso->long_name);
2711 symbol__annotate_printf(sym, map, evsel, opts);
2713 annotated_source__purge(symbol__annotation(sym)->src);
2718 bool ui__has_annotation(void)
2720 return use_browser == 1 && perf_hpp_list.sym;
2724 static double annotation_line__max_percent(struct annotation_line *al,
2725 struct annotation *notes,
2726 unsigned int percent_type)
2728 double percent_max = 0.0;
2731 for (i = 0; i < notes->nr_events; i++) {
2734 percent = annotation_data__percent(&al->data[i],
2737 if (percent > percent_max)
2738 percent_max = percent;
2744 static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2745 void *obj, char *bf, size_t size,
2746 void (*obj__printf)(void *obj, const char *fmt, ...),
2747 void (*obj__write_graph)(void *obj, int graph))
2749 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2750 if (ins__is_jump(&dl->ins)) {
2753 if (dl->ops.target.outside)
2755 fwd = dl->ops.target.offset > dl->al.offset;
2756 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2757 obj__printf(obj, " ");
2758 } else if (ins__is_call(&dl->ins)) {
2760 obj__write_graph(obj, RARROW_CHAR);
2761 obj__printf(obj, " ");
2762 } else if (ins__is_ret(&dl->ins)) {
2763 obj__write_graph(obj, LARROW_CHAR);
2764 obj__printf(obj, " ");
2766 obj__printf(obj, " ");
2769 obj__printf(obj, " ");
2772 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2775 static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2777 double ipc = 0.0, coverage = 0.0;
2779 if (notes->hit_cycles)
2780 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2782 if (notes->total_insn) {
2783 coverage = notes->cover_insn * 100.0 /
2784 ((double)notes->total_insn);
2787 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2791 static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2792 bool first_line, bool current_entry, bool change_color, int width,
2793 void *obj, unsigned int percent_type,
2794 int (*obj__set_color)(void *obj, int color),
2795 void (*obj__set_percent_color)(void *obj, double percent, bool current),
2796 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2797 void (*obj__printf)(void *obj, const char *fmt, ...),
2798 void (*obj__write_graph)(void *obj, int graph))
2801 double percent_max = annotation_line__max_percent(al, notes, percent_type);
2802 int pcnt_width = annotation__pcnt_width(notes),
2803 cycles_width = annotation__cycles_width(notes);
2804 bool show_title = false;
2808 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2809 if (notes->have_cycles) {
2810 if (al->ipc == 0.0 && al->cycles == 0)
2816 if (al->offset != -1 && percent_max != 0.0) {
2819 for (i = 0; i < notes->nr_events; i++) {
2822 percent = annotation_data__percent(&al->data[i], percent_type);
2824 obj__set_percent_color(obj, percent, current_entry);
2825 if (notes->options->show_total_period) {
2826 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2827 } else if (notes->options->show_nr_samples) {
2828 obj__printf(obj, "%6" PRIu64 " ",
2829 al->data[i].he.nr_samples);
2831 obj__printf(obj, "%6.2f ", percent);
2835 obj__set_percent_color(obj, 0, current_entry);
2838 obj__printf(obj, "%-*s", pcnt_width, " ");
2840 obj__printf(obj, "%-*s", pcnt_width,
2841 notes->options->show_total_period ? "Period" :
2842 notes->options->show_nr_samples ? "Samples" : "Percent");
2846 if (notes->have_cycles) {
2848 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2849 else if (!show_title)
2850 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2852 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2854 if (!notes->options->show_minmax_cycle) {
2856 obj__printf(obj, "%*" PRIu64 " ",
2857 ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2858 else if (!show_title)
2859 obj__printf(obj, "%*s",
2860 ANNOTATION__CYCLES_WIDTH, " ");
2862 obj__printf(obj, "%*s ",
2863 ANNOTATION__CYCLES_WIDTH - 1,
2869 scnprintf(str, sizeof(str),
2870 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2871 al->cycles, al->cycles_min,
2874 obj__printf(obj, "%*s ",
2875 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2877 } else if (!show_title)
2878 obj__printf(obj, "%*s",
2879 ANNOTATION__MINMAX_CYCLES_WIDTH,
2882 obj__printf(obj, "%*s ",
2883 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2887 if (show_title && !*al->line) {
2888 ipc_coverage_string(bf, sizeof(bf), notes);
2889 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2893 obj__printf(obj, " ");
2896 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
2897 else if (al->offset == -1) {
2898 if (al->line_nr && notes->options->show_linenr)
2899 printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
2901 printed = scnprintf(bf, sizeof(bf), "%-*s ", notes->widths.addr, " ");
2902 obj__printf(obj, bf);
2903 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
2905 u64 addr = al->offset;
2908 if (!notes->options->use_offset)
2909 addr += notes->start;
2911 if (!notes->options->use_offset) {
2912 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
2914 if (al->jump_sources &&
2915 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
2916 if (notes->options->show_nr_jumps) {
2918 printed = scnprintf(bf, sizeof(bf), "%*d ",
2919 notes->widths.jumps,
2921 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
2923 obj__printf(obj, bf);
2924 obj__set_color(obj, prev);
2927 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
2928 notes->widths.target, addr);
2929 } else if (ins__is_call(&disasm_line(al)->ins) &&
2930 notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
2932 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
2935 printed = scnprintf(bf, sizeof(bf), "%-*s ",
2936 notes->widths.addr, " ");
2941 color = obj__set_color(obj, HE_COLORSET_ADDR);
2942 obj__printf(obj, bf);
2944 obj__set_color(obj, color);
2946 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
2948 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
2953 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
2954 struct annotation_write_ops *wops,
2955 struct annotation_options *opts)
2957 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
2958 wops->change_color, wops->width, wops->obj,
2960 wops->set_color, wops->set_percent_color,
2961 wops->set_jumps_percent_color, wops->printf,
2965 int symbol__annotate2(struct symbol *sym, struct map *map, struct evsel *evsel,
2966 struct annotation_options *options, struct arch **parch)
2968 struct annotation *notes = symbol__annotation(sym);
2969 size_t size = symbol__size(sym);
2970 int nr_pcnt = 1, err;
2972 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
2973 if (notes->offsets == NULL)
2976 if (perf_evsel__is_group_event(evsel))
2977 nr_pcnt = evsel->core.nr_members;
2979 err = symbol__annotate(sym, map, evsel, 0, options, parch);
2981 goto out_free_offsets;
2983 notes->options = options;
2985 symbol__calc_percent(sym, evsel);
2987 annotation__set_offsets(notes, size);
2988 annotation__mark_jump_targets(notes, sym);
2989 annotation__compute_ipc(notes, size);
2990 annotation__init_column_widths(notes, sym);
2991 notes->nr_events = nr_pcnt;
2993 annotation__update_column_widths(notes);
2994 sym->annotate2 = true;
2999 zfree(¬es->offsets);
3003 #define ANNOTATION__CFG(n) \
3004 { .name = #n, .value = &annotation__default_options.n, }
3007 * Keep the entries sorted, they are bsearch'ed
3009 static struct annotation_config {
3012 } annotation__configs[] = {
3013 ANNOTATION__CFG(hide_src_code),
3014 ANNOTATION__CFG(jump_arrows),
3015 ANNOTATION__CFG(offset_level),
3016 ANNOTATION__CFG(show_linenr),
3017 ANNOTATION__CFG(show_nr_jumps),
3018 ANNOTATION__CFG(show_nr_samples),
3019 ANNOTATION__CFG(show_total_period),
3020 ANNOTATION__CFG(use_offset),
3023 #undef ANNOTATION__CFG
3025 static int annotation_config__cmp(const void *name, const void *cfgp)
3027 const struct annotation_config *cfg = cfgp;
3029 return strcmp(name, cfg->name);
3032 static int annotation__config(const char *var, const char *value,
3033 void *data __maybe_unused)
3035 struct annotation_config *cfg;
3038 if (!strstarts(var, "annotate."))
3042 cfg = bsearch(name, annotation__configs, ARRAY_SIZE(annotation__configs),
3043 sizeof(struct annotation_config), annotation_config__cmp);
3046 pr_debug("%s variable unknown, ignoring...", var);
3047 else if (strcmp(var, "annotate.offset_level") == 0) {
3048 perf_config_int(cfg->value, name, value);
3050 if (*(int *)cfg->value > ANNOTATION__MAX_OFFSET_LEVEL)
3051 *(int *)cfg->value = ANNOTATION__MAX_OFFSET_LEVEL;
3052 else if (*(int *)cfg->value < ANNOTATION__MIN_OFFSET_LEVEL)
3053 *(int *)cfg->value = ANNOTATION__MIN_OFFSET_LEVEL;
3055 *(bool *)cfg->value = perf_config_bool(name, value);
3060 void annotation_config__init(void)
3062 perf_config(annotation__config, NULL);
3064 annotation__default_options.show_total_period = symbol_conf.show_total_period;
3065 annotation__default_options.show_nr_samples = symbol_conf.show_nr_samples;
3068 static unsigned int parse_percent_type(char *str1, char *str2)
3070 unsigned int type = (unsigned int) -1;
3072 if (!strcmp("period", str1)) {
3073 if (!strcmp("local", str2))
3074 type = PERCENT_PERIOD_LOCAL;
3075 else if (!strcmp("global", str2))
3076 type = PERCENT_PERIOD_GLOBAL;
3079 if (!strcmp("hits", str1)) {
3080 if (!strcmp("local", str2))
3081 type = PERCENT_HITS_LOCAL;
3082 else if (!strcmp("global", str2))
3083 type = PERCENT_HITS_GLOBAL;
3089 int annotate_parse_percent_type(const struct option *opt, const char *_str,
3090 int unset __maybe_unused)
3092 struct annotation_options *opts = opt->value;
3097 str1 = strdup(_str);
3101 str2 = strchr(str1, '-');
3107 type = parse_percent_type(str1, str2);
3108 if (type == (unsigned int) -1)
3109 type = parse_percent_type(str2, str1);
3110 if (type != (unsigned int) -1) {
3111 opts->percent_type = type;