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
13 #include "util.h" // hex_width()
30 #include "bpf-event.h"
31 #include "block-range.h"
33 #include "util/event.h"
34 #include "arch/common.h"
37 #include <linux/bitops.h>
38 #include <linux/kernel.h>
39 #include <linux/string.h>
40 #include <subcmd/parse-options.h>
41 #include <subcmd/run-command.h>
43 /* FIXME: For the HE_COLORSET */
44 #include "ui/browser.h"
47 * FIXME: Using the same values as slang.h,
48 * but that header may not be available everywhere
50 #define LARROW_CHAR ((unsigned char)',')
51 #define RARROW_CHAR ((unsigned char)'+')
52 #define DARROW_CHAR ((unsigned char)'.')
53 #define UARROW_CHAR ((unsigned char)'-')
55 #include <linux/ctype.h>
57 struct annotation_options annotation__default_options = {
61 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
62 .percent_type = PERCENT_PERIOD_LOCAL,
65 static regex_t file_lineno;
67 static struct ins_ops *ins__find(struct arch *arch, const char *name);
68 static void ins__sort(struct arch *arch);
69 static int disasm_line__parse(char *line, const char **namep, char **rawp);
73 struct ins *instructions;
74 size_t nr_instructions;
75 size_t nr_instructions_allocated;
76 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
77 bool sorted_instructions;
82 int (*init)(struct arch *arch, char *cpuid);
83 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
87 char skip_functions_char;
91 static struct ins_ops call_ops;
92 static struct ins_ops dec_ops;
93 static struct ins_ops jump_ops;
94 static struct ins_ops mov_ops;
95 static struct ins_ops nop_ops;
96 static struct ins_ops lock_ops;
97 static struct ins_ops ret_ops;
99 static int arch__grow_instructions(struct arch *arch)
101 struct ins *new_instructions;
102 size_t new_nr_allocated;
104 if (arch->nr_instructions_allocated == 0 && arch->instructions)
105 goto grow_from_non_allocated_table;
107 new_nr_allocated = arch->nr_instructions_allocated + 128;
108 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
109 if (new_instructions == NULL)
112 out_update_instructions:
113 arch->instructions = new_instructions;
114 arch->nr_instructions_allocated = new_nr_allocated;
117 grow_from_non_allocated_table:
118 new_nr_allocated = arch->nr_instructions + 128;
119 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
120 if (new_instructions == NULL)
123 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
124 goto out_update_instructions;
127 static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
131 if (arch->nr_instructions == arch->nr_instructions_allocated &&
132 arch__grow_instructions(arch))
135 ins = &arch->instructions[arch->nr_instructions];
136 ins->name = strdup(name);
141 arch->nr_instructions++;
147 #include "arch/arc/annotate/instructions.c"
148 #include "arch/arm/annotate/instructions.c"
149 #include "arch/arm64/annotate/instructions.c"
150 #include "arch/csky/annotate/instructions.c"
151 #include "arch/mips/annotate/instructions.c"
152 #include "arch/x86/annotate/instructions.c"
153 #include "arch/powerpc/annotate/instructions.c"
154 #include "arch/s390/annotate/instructions.c"
155 #include "arch/sparc/annotate/instructions.c"
157 static struct arch architectures[] = {
160 .init = arc__annotate_init,
164 .init = arm__annotate_init,
168 .init = arm64__annotate_init,
172 .init = csky__annotate_init,
176 .init = mips__annotate_init,
183 .init = x86__annotate_init,
184 .instructions = x86__instructions,
185 .nr_instructions = ARRAY_SIZE(x86__instructions),
186 .ins_is_fused = x86__ins_is_fused,
193 .init = powerpc__annotate_init,
197 .init = s390__annotate_init,
204 .init = sparc__annotate_init,
211 static void ins__delete(struct ins_operands *ops)
215 zfree(&ops->source.raw);
216 zfree(&ops->source.name);
217 zfree(&ops->target.raw);
218 zfree(&ops->target.name);
221 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
222 struct ins_operands *ops, int max_ins_name)
224 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
227 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
228 struct ins_operands *ops, int max_ins_name)
230 if (ins->ops->scnprintf)
231 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
233 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
236 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
238 if (!arch || !arch->ins_is_fused)
241 return arch->ins_is_fused(arch, ins1, ins2);
244 static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
246 char *endptr, *tok, *name;
247 struct map *map = ms->map;
248 struct addr_map_symbol target = {
249 .ms = { .map = map, },
252 ops->target.addr = strtoull(ops->raw, &endptr, 16);
254 name = strchr(endptr, '<');
260 if (arch->objdump.skip_functions_char &&
261 strchr(name, arch->objdump.skip_functions_char))
264 tok = strchr(name, '>');
269 ops->target.name = strdup(name);
272 if (ops->target.name == NULL)
275 target.addr = map__objdump_2mem(map, ops->target.addr);
277 if (maps__find_ams(ms->maps, &target) == 0 &&
278 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
279 ops->target.sym = target.ms.sym;
284 tok = strchr(endptr, '*');
288 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
289 * Do not parse such instruction. */
290 if (strstr(endptr, "(%r") == NULL)
291 ops->target.addr = strtoull(endptr, NULL, 16);
296 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
297 struct ins_operands *ops, int max_ins_name)
300 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
302 if (ops->target.addr == 0)
303 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
305 if (ops->target.name)
306 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
308 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
311 static struct ins_ops call_ops = {
312 .parse = call__parse,
313 .scnprintf = call__scnprintf,
316 bool ins__is_call(const struct ins *ins)
318 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
322 * Prevents from matching commas in the comment section, e.g.:
323 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
325 * and skip comma as part of function arguments, e.g.:
326 * 1d8b4ac <linemap_lookup(line_maps const*, unsigned int)+0xcc>
328 static inline const char *validate_comma(const char *c, struct ins_operands *ops)
330 if (ops->raw_comment && c > ops->raw_comment)
333 if (ops->raw_func_start && c > ops->raw_func_start)
339 static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
341 struct map *map = ms->map;
342 struct symbol *sym = ms->sym;
343 struct addr_map_symbol target = {
344 .ms = { .map = map, },
346 const char *c = strchr(ops->raw, ',');
349 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
350 ops->raw_func_start = strchr(ops->raw, '<');
352 c = validate_comma(c, ops);
355 * Examples of lines to parse for the _cpp_lex_token@@Base
358 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
359 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
361 * The first is a jump to an offset inside the same function,
362 * the second is to another function, i.e. that 0xa72 is an
363 * offset in the cpp_named_operator2name@@base function.
366 * skip over possible up to 2 operands to get to address, e.g.:
367 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
370 ops->target.addr = strtoull(c, NULL, 16);
371 if (!ops->target.addr) {
373 c = validate_comma(c, ops);
375 ops->target.addr = strtoull(c, NULL, 16);
378 ops->target.addr = strtoull(ops->raw, NULL, 16);
381 target.addr = map__objdump_2mem(map, ops->target.addr);
382 start = map->unmap_ip(map, sym->start),
383 end = map->unmap_ip(map, sym->end);
385 ops->target.outside = target.addr < start || target.addr > end;
388 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
390 cpp_named_operator2name@@Base+0xa72
392 * Point to a place that is after the cpp_named_operator2name
393 * boundaries, i.e. in the ELF symbol table for cc1
394 * cpp_named_operator2name is marked as being 32-bytes long, but it in
395 * fact is much larger than that, so we seem to need a symbols__find()
396 * routine that looks for >= current->start and < next_symbol->start,
397 * possibly just for C++ objects?
399 * For now lets just make some progress by marking jumps to outside the
400 * current function as call like.
402 * Actual navigation will come next, with further understanding of how
403 * the symbol searching and disassembly should be done.
405 if (maps__find_ams(ms->maps, &target) == 0 &&
406 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
407 ops->target.sym = target.ms.sym;
409 if (!ops->target.outside) {
410 ops->target.offset = target.addr - start;
411 ops->target.offset_avail = true;
413 ops->target.offset_avail = false;
419 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
420 struct ins_operands *ops, int max_ins_name)
424 if (!ops->target.addr || ops->target.offset < 0)
425 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
427 if (ops->target.outside && ops->target.sym != NULL)
428 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
430 c = strchr(ops->raw, ',');
431 c = validate_comma(c, ops);
434 const char *c2 = strchr(c + 1, ',');
436 c2 = validate_comma(c2, ops);
437 /* check for 3-op insn */
442 /* mirror arch objdump's space-after-comma style */
447 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
448 ins->name, c ? c - ops->raw : 0, ops->raw,
452 static struct ins_ops jump_ops = {
453 .parse = jump__parse,
454 .scnprintf = jump__scnprintf,
457 bool ins__is_jump(const struct ins *ins)
459 return ins->ops == &jump_ops;
462 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
464 char *endptr, *name, *t;
466 if (strstr(raw, "(%rip)") == NULL)
469 *addrp = strtoull(comment, &endptr, 16);
470 if (endptr == comment)
472 name = strchr(endptr, '<');
478 t = strchr(name, '>');
483 *namep = strdup(name);
489 static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
491 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
492 if (ops->locked.ops == NULL)
495 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
498 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
500 if (ops->locked.ins.ops == NULL)
503 if (ops->locked.ins.ops->parse &&
504 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
510 zfree(&ops->locked.ops);
514 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
515 struct ins_operands *ops, int max_ins_name)
519 if (ops->locked.ins.ops == NULL)
520 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
522 printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
523 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
524 size - printed, ops->locked.ops, max_ins_name);
527 static void lock__delete(struct ins_operands *ops)
529 struct ins *ins = &ops->locked.ins;
531 if (ins->ops && ins->ops->free)
532 ins->ops->free(ops->locked.ops);
534 ins__delete(ops->locked.ops);
536 zfree(&ops->locked.ops);
537 zfree(&ops->target.raw);
538 zfree(&ops->target.name);
541 static struct ins_ops lock_ops = {
542 .free = lock__delete,
543 .parse = lock__parse,
544 .scnprintf = lock__scnprintf,
547 static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
549 char *s = strchr(ops->raw, ','), *target, *comment, prev;
555 ops->source.raw = strdup(ops->raw);
558 if (ops->source.raw == NULL)
562 comment = strchr(s, arch->objdump.comment_char);
567 s = strchr(s, '\0') - 1;
569 while (s > target && isspace(s[0]))
575 ops->target.raw = strdup(target);
578 if (ops->target.raw == NULL)
579 goto out_free_source;
584 comment = skip_spaces(comment);
585 comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
586 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
591 zfree(&ops->source.raw);
595 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
596 struct ins_operands *ops, int max_ins_name)
598 return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
599 ops->source.name ?: ops->source.raw,
600 ops->target.name ?: ops->target.raw);
603 static struct ins_ops mov_ops = {
605 .scnprintf = mov__scnprintf,
608 static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
610 char *target, *comment, *s, prev;
612 target = s = ops->raw;
614 while (s[0] != '\0' && !isspace(s[0]))
619 ops->target.raw = strdup(target);
622 if (ops->target.raw == NULL)
625 comment = strchr(s, arch->objdump.comment_char);
629 comment = skip_spaces(comment);
630 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
635 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
636 struct ins_operands *ops, int max_ins_name)
638 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
639 ops->target.name ?: ops->target.raw);
642 static struct ins_ops dec_ops = {
644 .scnprintf = dec__scnprintf,
647 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
648 struct ins_operands *ops __maybe_unused, int max_ins_name)
650 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
653 static struct ins_ops nop_ops = {
654 .scnprintf = nop__scnprintf,
657 static struct ins_ops ret_ops = {
658 .scnprintf = ins__raw_scnprintf,
661 bool ins__is_ret(const struct ins *ins)
663 return ins->ops == &ret_ops;
666 bool ins__is_lock(const struct ins *ins)
668 return ins->ops == &lock_ops;
671 static int ins__key_cmp(const void *name, const void *insp)
673 const struct ins *ins = insp;
675 return strcmp(name, ins->name);
678 static int ins__cmp(const void *a, const void *b)
680 const struct ins *ia = a;
681 const struct ins *ib = b;
683 return strcmp(ia->name, ib->name);
686 static void ins__sort(struct arch *arch)
688 const int nmemb = arch->nr_instructions;
690 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
693 static struct ins_ops *__ins__find(struct arch *arch, const char *name)
696 const int nmemb = arch->nr_instructions;
698 if (!arch->sorted_instructions) {
700 arch->sorted_instructions = true;
703 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
704 return ins ? ins->ops : NULL;
707 static struct ins_ops *ins__find(struct arch *arch, const char *name)
709 struct ins_ops *ops = __ins__find(arch, name);
711 if (!ops && arch->associate_instruction_ops)
712 ops = arch->associate_instruction_ops(arch, name);
717 static int arch__key_cmp(const void *name, const void *archp)
719 const struct arch *arch = archp;
721 return strcmp(name, arch->name);
724 static int arch__cmp(const void *a, const void *b)
726 const struct arch *aa = a;
727 const struct arch *ab = b;
729 return strcmp(aa->name, ab->name);
732 static void arch__sort(void)
734 const int nmemb = ARRAY_SIZE(architectures);
736 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
739 static struct arch *arch__find(const char *name)
741 const int nmemb = ARRAY_SIZE(architectures);
749 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
752 static struct annotated_source *annotated_source__new(void)
754 struct annotated_source *src = zalloc(sizeof(*src));
757 INIT_LIST_HEAD(&src->source);
762 static __maybe_unused void annotated_source__delete(struct annotated_source *src)
766 zfree(&src->histograms);
767 zfree(&src->cycles_hist);
771 static int annotated_source__alloc_histograms(struct annotated_source *src,
772 size_t size, int nr_hists)
774 size_t sizeof_sym_hist;
777 * Add buffer of one element for zero length symbol.
778 * When sample is taken from first instruction of
779 * zero length symbol, perf still resolves it and
780 * shows symbol name in perf report and allows to
786 /* Check for overflow when calculating sizeof_sym_hist */
787 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
790 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
792 /* Check for overflow in zalloc argument */
793 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
796 src->sizeof_sym_hist = sizeof_sym_hist;
797 src->nr_histograms = nr_hists;
798 src->histograms = calloc(nr_hists, sizeof_sym_hist) ;
799 return src->histograms ? 0 : -1;
802 /* The cycles histogram is lazily allocated. */
803 static int symbol__alloc_hist_cycles(struct symbol *sym)
805 struct annotation *notes = symbol__annotation(sym);
806 const size_t size = symbol__size(sym);
808 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
809 if (notes->src->cycles_hist == NULL)
814 void symbol__annotate_zero_histograms(struct symbol *sym)
816 struct annotation *notes = symbol__annotation(sym);
818 pthread_mutex_lock(¬es->lock);
819 if (notes->src != NULL) {
820 memset(notes->src->histograms, 0,
821 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
822 if (notes->src->cycles_hist)
823 memset(notes->src->cycles_hist, 0,
824 symbol__size(sym) * sizeof(struct cyc_hist));
826 pthread_mutex_unlock(¬es->lock);
829 static int __symbol__account_cycles(struct cyc_hist *ch,
831 unsigned offset, unsigned cycles,
835 * For now we can only account one basic block per
836 * final jump. But multiple could be overlapping.
837 * Always account the longest one. So when
838 * a shorter one has been already seen throw it away.
840 * We separately always account the full cycles.
842 ch[offset].num_aggr++;
843 ch[offset].cycles_aggr += cycles;
845 if (cycles > ch[offset].cycles_max)
846 ch[offset].cycles_max = cycles;
848 if (ch[offset].cycles_min) {
849 if (cycles && cycles < ch[offset].cycles_min)
850 ch[offset].cycles_min = cycles;
852 ch[offset].cycles_min = cycles;
854 if (!have_start && ch[offset].have_start)
856 if (ch[offset].num) {
857 if (have_start && (!ch[offset].have_start ||
858 ch[offset].start > start)) {
859 ch[offset].have_start = 0;
860 ch[offset].cycles = 0;
862 if (ch[offset].reset < 0xffff)
864 } else if (have_start &&
865 ch[offset].start < start)
869 if (ch[offset].num < NUM_SPARKS)
870 ch[offset].cycles_spark[ch[offset].num] = cycles;
872 ch[offset].have_start = have_start;
873 ch[offset].start = start;
874 ch[offset].cycles += cycles;
879 static int __symbol__inc_addr_samples(struct map_symbol *ms,
880 struct annotated_source *src, int evidx, u64 addr,
881 struct perf_sample *sample)
883 struct symbol *sym = ms->sym;
887 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, ms->map->unmap_ip(ms->map, addr));
889 if ((addr < sym->start || addr >= sym->end) &&
890 (addr != sym->end || sym->start != sym->end)) {
891 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
892 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
896 offset = addr - sym->start;
897 h = annotated_source__histogram(src, evidx);
899 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
900 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
904 h->addr[offset].nr_samples++;
905 h->period += sample->period;
906 h->addr[offset].period += sample->period;
908 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
909 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
910 sym->start, sym->name, addr, addr - sym->start, evidx,
911 h->addr[offset].nr_samples, h->addr[offset].period);
915 static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
917 struct annotation *notes = symbol__annotation(sym);
919 if (notes->src == NULL) {
920 notes->src = annotated_source__new();
921 if (notes->src == NULL)
923 goto alloc_cycles_hist;
926 if (!notes->src->cycles_hist) {
928 symbol__alloc_hist_cycles(sym);
931 return notes->src->cycles_hist;
934 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
936 struct annotation *notes = symbol__annotation(sym);
938 if (notes->src == NULL) {
939 notes->src = annotated_source__new();
940 if (notes->src == NULL)
942 goto alloc_histograms;
945 if (notes->src->histograms == NULL) {
947 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
954 static int symbol__inc_addr_samples(struct map_symbol *ms,
955 struct evsel *evsel, u64 addr,
956 struct perf_sample *sample)
958 struct symbol *sym = ms->sym;
959 struct annotated_source *src;
963 src = symbol__hists(sym, evsel->evlist->core.nr_entries);
964 return src ? __symbol__inc_addr_samples(ms, src, evsel->idx, addr, sample) : 0;
967 static int symbol__account_cycles(u64 addr, u64 start,
968 struct symbol *sym, unsigned cycles)
970 struct cyc_hist *cycles_hist;
975 cycles_hist = symbol__cycles_hist(sym);
976 if (cycles_hist == NULL)
978 if (addr < sym->start || addr >= sym->end)
982 if (start < sym->start || start >= sym->end)
987 offset = addr - sym->start;
988 return __symbol__account_cycles(cycles_hist,
989 start ? start - sym->start : 0,
994 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
995 struct addr_map_symbol *start,
1005 * Only set start when IPC can be computed. We can only
1006 * compute it when the basic block is completely in a single
1008 * Special case the case when the jump is elsewhere, but
1009 * it starts on the function start.
1012 (start->ms.sym == ams->ms.sym ||
1014 start->addr == ams->ms.sym->start + ams->ms.map->start)))
1015 saddr = start->al_addr;
1017 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
1019 start ? start->addr : 0,
1020 ams->ms.sym ? ams->ms.sym->start + ams->ms.map->start : 0,
1022 err = symbol__account_cycles(ams->al_addr, saddr, ams->ms.sym, cycles);
1024 pr_debug2("account_cycles failed %d\n", err);
1028 static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1030 unsigned n_insn = 0;
1033 for (offset = start; offset <= end; offset++) {
1034 if (notes->offsets[offset])
1040 static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1043 unsigned int cover_insn = 0;
1046 n_insn = annotation__count_insn(notes, start, end);
1047 if (n_insn && ch->num && ch->cycles) {
1048 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1050 /* Hide data when there are too many overlaps. */
1051 if (ch->reset >= 0x7fff)
1054 for (offset = start; offset <= end; offset++) {
1055 struct annotation_line *al = notes->offsets[offset];
1057 if (al && al->ipc == 0.0) {
1064 notes->hit_cycles += ch->cycles;
1065 notes->hit_insn += n_insn * ch->num;
1066 notes->cover_insn += cover_insn;
1071 void annotation__compute_ipc(struct annotation *notes, size_t size)
1075 if (!notes->src || !notes->src->cycles_hist)
1078 notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1079 notes->hit_cycles = 0;
1080 notes->hit_insn = 0;
1081 notes->cover_insn = 0;
1083 pthread_mutex_lock(¬es->lock);
1084 for (offset = size - 1; offset >= 0; --offset) {
1085 struct cyc_hist *ch;
1087 ch = ¬es->src->cycles_hist[offset];
1088 if (ch && ch->cycles) {
1089 struct annotation_line *al;
1092 annotation__count_and_fill(notes, ch->start, offset, ch);
1093 al = notes->offsets[offset];
1094 if (al && ch->num_aggr) {
1095 al->cycles = ch->cycles_aggr / ch->num_aggr;
1096 al->cycles_max = ch->cycles_max;
1097 al->cycles_min = ch->cycles_min;
1099 notes->have_cycles = true;
1102 pthread_mutex_unlock(¬es->lock);
1105 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1106 struct evsel *evsel)
1108 return symbol__inc_addr_samples(&ams->ms, evsel, ams->al_addr, sample);
1111 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1112 struct evsel *evsel, u64 ip)
1114 return symbol__inc_addr_samples(&he->ms, evsel, ip, sample);
1117 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1119 dl->ins.ops = ins__find(arch, dl->ins.name);
1124 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1128 static int disasm_line__parse(char *line, const char **namep, char **rawp)
1130 char tmp, *name = skip_spaces(line);
1132 if (name[0] == '\0')
1137 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1142 *namep = strdup(name);
1148 *rawp = strim(*rawp);
1156 struct annotate_args {
1158 struct map_symbol ms;
1159 struct evsel *evsel;
1160 struct annotation_options *options;
1166 static void annotation_line__init(struct annotation_line *al,
1167 struct annotate_args *args,
1170 al->offset = args->offset;
1171 al->line = strdup(args->line);
1172 al->line_nr = args->line_nr;
1176 static void annotation_line__exit(struct annotation_line *al)
1178 free_srcline(al->path);
1182 static size_t disasm_line_size(int nr)
1184 struct annotation_line *al;
1186 return (sizeof(struct disasm_line) + (sizeof(al->data[0]) * nr));
1190 * Allocating the disasm annotation line data with
1191 * following structure:
1193 * -------------------------------------------
1194 * struct disasm_line | struct annotation_line
1195 * -------------------------------------------
1197 * We have 'struct annotation_line' member as last member
1198 * of 'struct disasm_line' to have an easy access.
1200 static struct disasm_line *disasm_line__new(struct annotate_args *args)
1202 struct disasm_line *dl = NULL;
1205 if (evsel__is_group_event(args->evsel))
1206 nr = args->evsel->core.nr_members;
1208 dl = zalloc(disasm_line_size(nr));
1212 annotation_line__init(&dl->al, args, nr);
1213 if (dl->al.line == NULL)
1216 if (args->offset != -1) {
1217 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1220 disasm_line__init_ins(dl, args->arch, &args->ms);
1226 zfree(&dl->al.line);
1232 void disasm_line__free(struct disasm_line *dl)
1234 if (dl->ins.ops && dl->ins.ops->free)
1235 dl->ins.ops->free(&dl->ops);
1237 ins__delete(&dl->ops);
1238 zfree(&dl->ins.name);
1239 annotation_line__exit(&dl->al);
1243 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1245 if (raw || !dl->ins.ops)
1246 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1248 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1251 static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1253 list_add_tail(&al->node, head);
1256 struct annotation_line *
1257 annotation_line__next(struct annotation_line *pos, struct list_head *head)
1259 list_for_each_entry_continue(pos, head, node)
1260 if (pos->offset >= 0)
1266 static const char *annotate__address_color(struct block_range *br)
1268 double cov = block_range__coverage(br);
1271 /* mark red for >75% coverage */
1273 return PERF_COLOR_RED;
1275 /* mark dull for <1% coverage */
1277 return PERF_COLOR_NORMAL;
1280 return PERF_COLOR_MAGENTA;
1283 static const char *annotate__asm_color(struct block_range *br)
1285 double cov = block_range__coverage(br);
1288 /* mark dull for <1% coverage */
1290 return PERF_COLOR_NORMAL;
1293 return PERF_COLOR_BLUE;
1296 static void annotate__branch_printf(struct block_range *br, u64 addr)
1298 bool emit_comment = true;
1304 if (br->is_target && br->start == addr) {
1305 struct block_range *branch = br;
1309 * Find matching branch to our target.
1311 while (!branch->is_branch)
1312 branch = block_range__next(branch);
1314 p = 100 *(double)br->entry / branch->coverage;
1318 emit_comment = false;
1323 * The percentage of coverage joined at this target in relation
1324 * to the next branch.
1326 printf(" +%.2f%%", p);
1330 if (br->is_branch && br->end == addr) {
1331 double p = 100*(double)br->taken / br->coverage;
1335 emit_comment = false;
1340 * The percentage of coverage leaving at this branch, and
1341 * its prediction ratio.
1343 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1348 static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1350 s64 offset = dl->al.offset;
1351 const u64 addr = start + offset;
1352 struct block_range *br;
1354 br = block_range__find(addr);
1355 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
1356 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1357 annotate__branch_printf(br, addr);
1362 annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1363 struct evsel *evsel, u64 len, int min_pcnt, int printed,
1364 int max_lines, struct annotation_line *queue, int addr_fmt_width,
1367 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1368 static const char *prev_line;
1369 static const char *prev_color;
1371 if (al->offset != -1) {
1372 double max_percent = 0.0;
1373 int i, nr_percent = 1;
1375 struct annotation *notes = symbol__annotation(sym);
1377 for (i = 0; i < al->data_nr; i++) {
1380 percent = annotation_data__percent(&al->data[i],
1383 if (percent > max_percent)
1384 max_percent = percent;
1387 if (al->data_nr > nr_percent)
1388 nr_percent = al->data_nr;
1390 if (max_percent < min_pcnt)
1393 if (max_lines && printed >= max_lines)
1396 if (queue != NULL) {
1397 list_for_each_entry_from(queue, ¬es->src->source, node) {
1400 annotation_line__print(queue, sym, start, evsel, len,
1401 0, 0, 1, NULL, addr_fmt_width,
1406 color = get_percent_color(max_percent);
1409 * Also color the filename and line if needed, with
1410 * the same color than the percentage. Don't print it
1411 * twice for close colored addr with the same filename:line
1414 if (!prev_line || strcmp(prev_line, al->path)
1415 || color != prev_color) {
1416 color_fprintf(stdout, color, " %s", al->path);
1417 prev_line = al->path;
1422 for (i = 0; i < nr_percent; i++) {
1423 struct annotation_data *data = &al->data[i];
1426 percent = annotation_data__percent(data, percent_type);
1427 color = get_percent_color(percent);
1429 if (symbol_conf.show_total_period)
1430 color_fprintf(stdout, color, " %11" PRIu64,
1432 else if (symbol_conf.show_nr_samples)
1433 color_fprintf(stdout, color, " %7" PRIu64,
1434 data->he.nr_samples);
1436 color_fprintf(stdout, color, " %7.2f", percent);
1441 disasm_line__print(dl, start, addr_fmt_width);
1443 } else if (max_lines && printed >= max_lines)
1446 int width = symbol_conf.show_total_period ? 12 : 8;
1451 if (evsel__is_group_event(evsel))
1452 width *= evsel->core.nr_members;
1455 printf(" %*s:\n", width, " ");
1457 printf(" %*s: %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1464 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1465 * which looks like following
1467 * 0000000000415500 <_init>:
1468 * 415500: sub $0x8,%rsp
1469 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1470 * 41550b: test %rax,%rax
1471 * 41550e: je 415515 <_init+0x15>
1472 * 415510: callq 416e70 <__gmon_start__@plt>
1473 * 415515: add $0x8,%rsp
1476 * it will be parsed and saved into struct disasm_line as
1477 * <offset> <name> <ops.raw>
1479 * The offset will be a relative offset from the start of the symbol and -1
1480 * means that it's not a disassembly line so should be treated differently.
1481 * The ops.raw part will be parsed further according to type of the instruction.
1483 static int symbol__parse_objdump_line(struct symbol *sym,
1484 struct annotate_args *args,
1485 char *parsed_line, int *line_nr)
1487 struct map *map = args->ms.map;
1488 struct annotation *notes = symbol__annotation(sym);
1489 struct disasm_line *dl;
1491 s64 line_ip, offset = -1;
1492 regmatch_t match[2];
1494 /* /filename:linenr ? Save line number and ignore. */
1495 if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1496 *line_nr = atoi(parsed_line + match[1].rm_so);
1500 /* Process hex address followed by ':'. */
1501 line_ip = strtoull(parsed_line, &tmp, 16);
1502 if (parsed_line != tmp && tmp[0] == ':' && tmp[1] != '\0') {
1503 u64 start = map__rip_2objdump(map, sym->start),
1504 end = map__rip_2objdump(map, sym->end);
1506 offset = line_ip - start;
1507 if ((u64)line_ip < start || (u64)line_ip >= end)
1510 parsed_line = tmp + 1;
1513 args->offset = offset;
1514 args->line = parsed_line;
1515 args->line_nr = *line_nr;
1518 dl = disasm_line__new(args);
1524 if (!disasm_line__has_local_offset(dl)) {
1525 dl->ops.target.offset = dl->ops.target.addr -
1526 map__rip_2objdump(map, sym->start);
1527 dl->ops.target.offset_avail = true;
1530 /* kcore has no symbols, so add the call target symbol */
1531 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1532 struct addr_map_symbol target = {
1533 .addr = dl->ops.target.addr,
1534 .ms = { .map = map, },
1537 if (!maps__find_ams(args->ms.maps, &target) &&
1538 target.ms.sym->start == target.al_addr)
1539 dl->ops.target.sym = target.ms.sym;
1542 annotation_line__add(&dl->al, ¬es->src->source);
1547 static __attribute__((constructor)) void symbol__init_regexpr(void)
1549 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1552 static void delete_last_nop(struct symbol *sym)
1554 struct annotation *notes = symbol__annotation(sym);
1555 struct list_head *list = ¬es->src->source;
1556 struct disasm_line *dl;
1558 while (!list_empty(list)) {
1559 dl = list_entry(list->prev, struct disasm_line, al.node);
1562 if (dl->ins.ops != &nop_ops)
1565 if (!strstr(dl->al.line, " nop ") &&
1566 !strstr(dl->al.line, " nopl ") &&
1567 !strstr(dl->al.line, " nopw "))
1571 list_del_init(&dl->al.node);
1572 disasm_line__free(dl);
1576 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen)
1578 struct dso *dso = ms->map->dso;
1580 BUG_ON(buflen == 0);
1583 str_error_r(errnum, buf, buflen);
1588 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1589 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1590 char *build_id_msg = NULL;
1592 if (dso->has_build_id) {
1593 build_id__sprintf(&dso->bid, bf + 15);
1596 scnprintf(buf, buflen,
1597 "No vmlinux file%s\nwas found in the path.\n\n"
1598 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1600 " perf buildid-cache -vu vmlinux\n\n"
1602 " --vmlinux vmlinux\n", build_id_msg ?: "");
1605 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1606 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1608 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP:
1609 scnprintf(buf, buflen, "Problems with arch specific instruction name regular expressions.");
1611 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING:
1612 scnprintf(buf, buflen, "Problems while parsing the CPUID in the arch specific initialization.");
1614 case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE:
1615 scnprintf(buf, buflen, "Invalid BPF file: %s.", dso->long_name);
1617 case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF:
1618 scnprintf(buf, buflen, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1622 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1629 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1631 char linkname[PATH_MAX];
1632 char *build_id_filename;
1633 char *build_id_path = NULL;
1637 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1638 !dso__is_kcore(dso))
1639 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1641 build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1642 if (build_id_filename) {
1643 __symbol__join_symfs(filename, filename_size, build_id_filename);
1644 free(build_id_filename);
1646 if (dso->has_build_id)
1651 build_id_path = strdup(filename);
1656 * old style build-id cache has name of XX/XXXXXXX.. while
1657 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1658 * extract the build-id part of dirname in the new style only.
1660 pos = strrchr(build_id_path, '/');
1661 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1662 dirname(build_id_path);
1664 if (dso__is_kcore(dso))
1667 len = readlink(build_id_path, linkname, sizeof(linkname) - 1);
1671 linkname[len] = '\0';
1672 if (strstr(linkname, DSO__NAME_KALLSYMS) ||
1673 access(filename, R_OK)) {
1676 * If we don't have build-ids or the build-id file isn't in the
1677 * cache, or is just a kallsyms file, well, lets hope that this
1678 * DSO is the same as when 'perf record' ran.
1680 __symbol__join_symfs(filename, filename_size, dso->long_name);
1683 free(build_id_path);
1687 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1688 #define PACKAGE "perf"
1690 #include <dis-asm.h>
1691 #include <bpf/bpf.h>
1692 #include <bpf/btf.h>
1693 #include <bpf/libbpf.h>
1694 #include <linux/btf.h>
1696 static int symbol__disassemble_bpf(struct symbol *sym,
1697 struct annotate_args *args)
1699 struct annotation *notes = symbol__annotation(sym);
1700 struct annotation_options *opts = args->options;
1701 struct bpf_prog_info_linear *info_linear;
1702 struct bpf_prog_linfo *prog_linfo = NULL;
1703 struct bpf_prog_info_node *info_node;
1704 int len = sym->end - sym->start;
1705 disassembler_ftype disassemble;
1706 struct map *map = args->ms.map;
1707 struct disassemble_info info;
1708 struct dso *dso = map->dso;
1709 int pc = 0, count, sub_id;
1710 struct btf *btf = NULL;
1711 char tpath[PATH_MAX];
1719 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1720 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE;
1722 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1723 sym->name, sym->start, sym->end - sym->start);
1725 memset(tpath, 0, sizeof(tpath));
1726 perf_exe(tpath, sizeof(tpath));
1728 bfdf = bfd_openr(tpath, NULL);
1730 assert(bfd_check_format(bfdf, bfd_object));
1732 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,
1746 ret = SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF;
1749 info_linear = info_node->info_linear;
1750 sub_id = dso->bpf_prog.sub_id;
1752 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1753 info.buffer_length = info_linear->info.jited_prog_len;
1755 if (info_linear->info.nr_line_info)
1756 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1758 if (info_linear->info.btf_id) {
1759 struct btf_node *node;
1761 node = perf_env__find_btf(dso->bpf_prog.env,
1762 info_linear->info.btf_id);
1764 btf = btf__new((__u8 *)(node->data),
1768 disassemble_init_for_target(&info);
1770 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1771 disassemble = disassembler(info.arch,
1772 bfd_big_endian(bfdf),
1776 disassemble = disassembler(bfdf);
1778 assert(disassemble);
1782 const struct bpf_line_info *linfo = NULL;
1783 struct disasm_line *dl;
1784 size_t prev_buf_size;
1785 const char *srcline;
1788 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1789 count = disassemble(pc, &info);
1792 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1797 srcline = btf__name_by_offset(btf, linfo->line_off);
1803 prev_buf_size = buf_size;
1806 if (!opts->hide_src_code && srcline) {
1808 args->line = strdup(srcline);
1811 dl = disasm_line__new(args);
1813 annotation_line__add(&dl->al,
1814 ¬es->src->source);
1819 args->line = buf + prev_buf_size;
1822 dl = disasm_line__new(args);
1824 annotation_line__add(&dl->al, ¬es->src->source);
1827 } while (count > 0 && pc < len);
1837 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1838 static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1839 struct annotate_args *args __maybe_unused)
1841 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1843 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1846 symbol__disassemble_bpf_image(struct symbol *sym,
1847 struct annotate_args *args)
1849 struct annotation *notes = symbol__annotation(sym);
1850 struct disasm_line *dl;
1853 args->line = strdup("to be implemented");
1855 dl = disasm_line__new(args);
1857 annotation_line__add(&dl->al, ¬es->src->source);
1864 * Possibly create a new version of line with tabs expanded. Returns the
1865 * existing or new line, storage is updated if a new line is allocated. If
1866 * allocation fails then NULL is returned.
1868 static char *expand_tabs(char *line, char **storage, size_t *storage_len)
1870 size_t i, src, dst, len, new_storage_len, num_tabs;
1872 size_t line_len = strlen(line);
1874 for (num_tabs = 0, i = 0; i < line_len; i++)
1875 if (line[i] == '\t')
1882 * Space for the line and '\0', less the leading and trailing
1883 * spaces. Each tab may introduce 7 additional spaces.
1885 new_storage_len = line_len + 1 + (num_tabs * 7);
1887 new_line = malloc(new_storage_len);
1888 if (new_line == NULL) {
1889 pr_err("Failure allocating memory for tab expansion\n");
1894 * Copy regions starting at src and expand tabs. If there are two
1895 * adjacent tabs then 'src == i', the memcpy is of size 0 and the spaces
1898 for (i = 0, src = 0, dst = 0; i < line_len && num_tabs; i++) {
1899 if (line[i] == '\t') {
1901 memcpy(&new_line[dst], &line[src], len);
1903 new_line[dst++] = ' ';
1904 while (dst % 8 != 0)
1905 new_line[dst++] = ' ';
1911 /* Expand the last region. */
1912 len = line_len - src;
1913 memcpy(&new_line[dst], &line[src], len);
1915 new_line[dst] = '\0';
1918 *storage = new_line;
1919 *storage_len = new_storage_len;
1924 static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1926 struct annotation_options *opts = args->options;
1927 struct map *map = args->ms.map;
1928 struct dso *dso = map->dso;
1931 char symfs_filename[PATH_MAX];
1932 struct kcore_extract kce;
1933 bool delete_extract = false;
1934 bool decomp = false;
1939 const char *objdump_argv[] = {
1942 NULL, /* Will be the objdump command to run. */
1944 NULL, /* Will be the symfs path. */
1947 struct child_process objdump_process;
1948 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1953 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1954 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1955 map->unmap_ip(map, sym->end));
1957 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1958 dso, dso->long_name, sym, sym->name);
1960 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1961 return symbol__disassemble_bpf(sym, args);
1962 } else if (dso->binary_type == DSO_BINARY_TYPE__BPF_IMAGE) {
1963 return symbol__disassemble_bpf_image(sym, args);
1964 } else if (dso__is_kcore(dso)) {
1965 kce.kcore_filename = symfs_filename;
1966 kce.addr = map__rip_2objdump(map, sym->start);
1967 kce.offs = sym->start;
1968 kce.len = sym->end - sym->start;
1969 if (!kcore_extract__create(&kce)) {
1970 delete_extract = true;
1971 strlcpy(symfs_filename, kce.extract_filename,
1972 sizeof(symfs_filename));
1974 } else if (dso__needs_decompress(dso)) {
1975 char tmp[KMOD_DECOMP_LEN];
1977 if (dso__decompress_kmodule_path(dso, symfs_filename,
1978 tmp, sizeof(tmp)) < 0)
1982 strcpy(symfs_filename, tmp);
1985 err = asprintf(&command,
1986 "%s %s%s --start-address=0x%016" PRIx64
1987 " --stop-address=0x%016" PRIx64
1988 " -l -d %s %s %s %c%s%c %s%s -C \"$1\"",
1989 opts->objdump_path ?: "objdump",
1990 opts->disassembler_style ? "-M " : "",
1991 opts->disassembler_style ?: "",
1992 map__rip_2objdump(map, sym->start),
1993 map__rip_2objdump(map, sym->end),
1994 opts->show_asm_raw ? "" : "--no-show-raw-insn",
1995 opts->annotate_src ? "-S" : "",
1996 opts->prefix ? "--prefix " : "",
1997 opts->prefix ? '"' : ' ',
1999 opts->prefix ? '"' : ' ',
2000 opts->prefix_strip ? "--prefix-strip=" : "",
2001 opts->prefix_strip ?: "");
2004 pr_err("Failure allocating memory for the command to run\n");
2005 goto out_remove_tmp;
2008 pr_debug("Executing: %s\n", command);
2010 objdump_argv[2] = command;
2011 objdump_argv[4] = symfs_filename;
2013 /* Create a pipe to read from for stdout */
2014 memset(&objdump_process, 0, sizeof(objdump_process));
2015 objdump_process.argv = objdump_argv;
2016 objdump_process.out = -1;
2017 if (start_command(&objdump_process)) {
2018 pr_err("Failure starting to run %s\n", command);
2020 goto out_free_command;
2023 file = fdopen(objdump_process.out, "r");
2025 pr_err("Failure creating FILE stream for %s\n", command);
2027 * If we were using debug info should retry with
2031 goto out_close_stdout;
2034 /* Storage for getline. */
2039 while (!feof(file)) {
2041 char *expanded_line;
2043 if (getline(&line, &line_len, file) < 0 || !line)
2046 /* Skip lines containing "filename:" */
2047 match = strstr(line, symfs_filename);
2048 if (match && match[strlen(symfs_filename)] == ':')
2051 expanded_line = strim(line);
2052 expanded_line = expand_tabs(expanded_line, &line, &line_len);
2057 * The source code line number (lineno) needs to be kept in
2058 * across calls to symbol__parse_objdump_line(), so that it
2059 * can associate it with the instructions till the next one.
2060 * See disasm_line__new() and struct disasm_line::line_nr.
2062 if (symbol__parse_objdump_line(sym, args, expanded_line,
2069 err = finish_command(&objdump_process);
2071 pr_err("Error running %s\n", command);
2075 pr_err("No output from %s\n", command);
2079 * kallsyms does not have symbol sizes so there may a nop at the end.
2082 if (dso__is_kcore(dso))
2083 delete_last_nop(sym);
2088 close(objdump_process.out);
2095 unlink(symfs_filename);
2098 kcore_extract__delete(&kce);
2103 static void calc_percent(struct sym_hist *sym_hist,
2104 struct hists *hists,
2105 struct annotation_data *data,
2106 s64 offset, s64 end)
2108 unsigned int hits = 0;
2111 while (offset < end) {
2112 hits += sym_hist->addr[offset].nr_samples;
2113 period += sym_hist->addr[offset].period;
2117 if (sym_hist->nr_samples) {
2118 data->he.period = period;
2119 data->he.nr_samples = hits;
2120 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2123 if (hists->stats.nr_non_filtered_samples)
2124 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2126 if (sym_hist->period)
2127 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2129 if (hists->stats.total_period)
2130 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2133 static void annotation__calc_percent(struct annotation *notes,
2134 struct evsel *leader, s64 len)
2136 struct annotation_line *al, *next;
2137 struct evsel *evsel;
2139 list_for_each_entry(al, ¬es->src->source, node) {
2143 if (al->offset == -1)
2146 next = annotation_line__next(al, ¬es->src->source);
2147 end = next ? next->offset : len;
2149 for_each_group_evsel(evsel, leader) {
2150 struct hists *hists = evsel__hists(evsel);
2151 struct annotation_data *data;
2152 struct sym_hist *sym_hist;
2154 BUG_ON(i >= al->data_nr);
2156 sym_hist = annotation__histogram(notes, evsel->idx);
2157 data = &al->data[i++];
2159 calc_percent(sym_hist, hists, data, al->offset, end);
2164 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
2166 struct annotation *notes = symbol__annotation(sym);
2168 annotation__calc_percent(notes, evsel, symbol__size(sym));
2171 int symbol__annotate(struct map_symbol *ms, struct evsel *evsel,
2172 struct annotation_options *options, struct arch **parch)
2174 struct symbol *sym = ms->sym;
2175 struct annotation *notes = symbol__annotation(sym);
2176 struct annotate_args args = {
2180 struct perf_env *env = evsel__env(evsel);
2181 const char *arch_name = perf_env__arch(env);
2188 args.arch = arch = arch__find(arch_name);
2196 err = arch->init(arch, env ? env->cpuid : NULL);
2198 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2204 notes->start = map__rip_2objdump(ms->map, sym->start);
2206 return symbol__disassemble(sym, &args);
2209 static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2210 struct annotation_options *opts)
2212 struct annotation_line *iter;
2213 struct rb_node **p = &root->rb_node;
2214 struct rb_node *parent = NULL;
2217 while (*p != NULL) {
2219 iter = rb_entry(parent, struct annotation_line, rb_node);
2221 ret = strcmp(iter->path, al->path);
2223 for (i = 0; i < al->data_nr; i++) {
2224 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2225 opts->percent_type);
2233 p = &(*p)->rb_right;
2236 for (i = 0; i < al->data_nr; i++) {
2237 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2238 opts->percent_type);
2241 rb_link_node(&al->rb_node, parent, p);
2242 rb_insert_color(&al->rb_node, root);
2245 static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2249 for (i = 0; i < a->data_nr; i++) {
2250 if (a->data[i].percent_sum == b->data[i].percent_sum)
2252 return a->data[i].percent_sum > b->data[i].percent_sum;
2258 static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2260 struct annotation_line *iter;
2261 struct rb_node **p = &root->rb_node;
2262 struct rb_node *parent = NULL;
2264 while (*p != NULL) {
2266 iter = rb_entry(parent, struct annotation_line, rb_node);
2268 if (cmp_source_line(al, iter))
2271 p = &(*p)->rb_right;
2274 rb_link_node(&al->rb_node, parent, p);
2275 rb_insert_color(&al->rb_node, root);
2278 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2280 struct annotation_line *al;
2281 struct rb_node *node;
2283 node = rb_first(src_root);
2285 struct rb_node *next;
2287 al = rb_entry(node, struct annotation_line, rb_node);
2288 next = rb_next(node);
2289 rb_erase(node, src_root);
2291 __resort_source_line(dest_root, al);
2296 static void print_summary(struct rb_root *root, const char *filename)
2298 struct annotation_line *al;
2299 struct rb_node *node;
2301 printf("\nSorted summary for file %s\n", filename);
2302 printf("----------------------------------------------\n\n");
2304 if (RB_EMPTY_ROOT(root)) {
2305 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2309 node = rb_first(root);
2311 double percent, percent_max = 0.0;
2316 al = rb_entry(node, struct annotation_line, rb_node);
2317 for (i = 0; i < al->data_nr; i++) {
2318 percent = al->data[i].percent_sum;
2319 color = get_percent_color(percent);
2320 color_fprintf(stdout, color, " %7.2f", percent);
2322 if (percent > percent_max)
2323 percent_max = percent;
2327 color = get_percent_color(percent_max);
2328 color_fprintf(stdout, color, " %s\n", path);
2330 node = rb_next(node);
2334 static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
2336 struct annotation *notes = symbol__annotation(sym);
2337 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2338 u64 len = symbol__size(sym), offset;
2340 for (offset = 0; offset < len; ++offset)
2341 if (h->addr[offset].nr_samples != 0)
2342 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2343 sym->start + offset, h->addr[offset].nr_samples);
2344 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2347 static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2350 struct annotation_line *line;
2352 list_for_each_entry_reverse(line, lines, node) {
2353 if (line->offset != -1)
2354 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2360 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
2361 struct annotation_options *opts)
2363 struct map *map = ms->map;
2364 struct symbol *sym = ms->sym;
2365 struct dso *dso = map->dso;
2367 const char *d_filename;
2368 const char *evsel_name = evsel__name(evsel);
2369 struct annotation *notes = symbol__annotation(sym);
2370 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2371 struct annotation_line *pos, *queue = NULL;
2372 u64 start = map__rip_2objdump(map, sym->start);
2373 int printed = 2, queue_len = 0, addr_fmt_width;
2375 bool context = opts->context;
2377 int width = symbol_conf.show_total_period ? 12 : 8;
2378 int graph_dotted_len;
2381 filename = strdup(dso->long_name);
2385 if (opts->full_path)
2386 d_filename = filename;
2388 d_filename = basename(filename);
2390 len = symbol__size(sym);
2392 if (evsel__is_group_event(evsel)) {
2393 width *= evsel->core.nr_members;
2394 evsel__group_desc(evsel, buf, sizeof(buf));
2398 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2400 width, width, symbol_conf.show_total_period ? "Period" :
2401 symbol_conf.show_nr_samples ? "Samples" : "Percent",
2402 d_filename, evsel_name, h->nr_samples,
2403 percent_type_str(opts->percent_type));
2405 printf("%-*.*s----\n",
2406 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2409 symbol__annotate_hits(sym, evsel);
2411 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2413 list_for_each_entry(pos, ¬es->src->source, node) {
2416 if (context && queue == NULL) {
2421 err = annotation_line__print(pos, sym, start, evsel, len,
2422 opts->min_pcnt, printed, opts->max_lines,
2423 queue, addr_fmt_width, opts->percent_type);
2429 printed += queue_len;
2435 /* filtered by max_lines */
2441 * Filtered by min_pcnt or non IP lines when
2446 if (queue_len == context)
2447 queue = list_entry(queue->node.next, typeof(*queue), node);
2459 static void FILE__set_percent_color(void *fp __maybe_unused,
2460 double percent __maybe_unused,
2461 bool current __maybe_unused)
2465 static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2466 int nr __maybe_unused, bool current __maybe_unused)
2471 static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2476 static void FILE__printf(void *fp, const char *fmt, ...)
2480 va_start(args, fmt);
2481 vfprintf(fp, fmt, args);
2485 static void FILE__write_graph(void *fp, int graph)
2490 case DARROW_CHAR: s = "↓"; break;
2491 case UARROW_CHAR: s = "↑"; break;
2492 case LARROW_CHAR: s = "←"; break;
2493 case RARROW_CHAR: s = "→"; break;
2494 default: s = "?"; break;
2500 static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2501 struct annotation_options *opts)
2503 struct annotation *notes = symbol__annotation(sym);
2504 struct annotation_write_ops wops = {
2507 .set_color = FILE__set_color,
2508 .set_percent_color = FILE__set_percent_color,
2509 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2510 .printf = FILE__printf,
2511 .write_graph = FILE__write_graph,
2513 struct annotation_line *al;
2515 list_for_each_entry(al, ¬es->src->source, node) {
2516 if (annotation_line__filter(al, notes))
2518 annotation_line__write(al, notes, &wops, opts);
2520 wops.first_line = false;
2526 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
2527 struct annotation_options *opts)
2529 const char *ev_name = evsel__name(evsel);
2535 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2538 fp = fopen(filename, "w");
2540 goto out_free_filename;
2542 if (evsel__is_group_event(evsel)) {
2543 evsel__group_desc(evsel, buf, sizeof(buf));
2547 fprintf(fp, "%s() %s\nEvent: %s\n\n",
2548 ms->sym->name, ms->map->dso->long_name, ev_name);
2549 symbol__annotate_fprintf2(ms->sym, fp, opts);
2558 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2560 struct annotation *notes = symbol__annotation(sym);
2561 struct sym_hist *h = annotation__histogram(notes, evidx);
2563 memset(h, 0, notes->src->sizeof_sym_hist);
2566 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2568 struct annotation *notes = symbol__annotation(sym);
2569 struct sym_hist *h = annotation__histogram(notes, evidx);
2570 int len = symbol__size(sym), offset;
2573 for (offset = 0; offset < len; ++offset) {
2574 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2575 h->nr_samples += h->addr[offset].nr_samples;
2579 void annotated_source__purge(struct annotated_source *as)
2581 struct annotation_line *al, *n;
2583 list_for_each_entry_safe(al, n, &as->source, node) {
2584 list_del_init(&al->node);
2585 disasm_line__free(disasm_line(al));
2589 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2593 if (dl->al.offset == -1)
2594 return fprintf(fp, "%s\n", dl->al.line);
2596 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2598 if (dl->ops.raw[0] != '\0') {
2599 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2603 return printed + fprintf(fp, "\n");
2606 size_t disasm__fprintf(struct list_head *head, FILE *fp)
2608 struct disasm_line *pos;
2611 list_for_each_entry(pos, head, al.node)
2612 printed += disasm_line__fprintf(pos, fp);
2617 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2619 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2620 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2621 dl->ops.target.offset >= (s64)symbol__size(sym))
2627 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2629 u64 offset, size = symbol__size(sym);
2631 /* PLT symbols contain external offsets */
2632 if (strstr(sym->name, "@plt"))
2635 for (offset = 0; offset < size; ++offset) {
2636 struct annotation_line *al = notes->offsets[offset];
2637 struct disasm_line *dl;
2639 dl = disasm_line(al);
2641 if (!disasm_line__is_valid_local_jump(dl, sym))
2644 al = notes->offsets[dl->ops.target.offset];
2647 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2648 * have to adjust to the previous offset?
2653 if (++al->jump_sources > notes->max_jump_sources)
2654 notes->max_jump_sources = al->jump_sources;
2658 void annotation__set_offsets(struct annotation *notes, s64 size)
2660 struct annotation_line *al;
2662 notes->max_line_len = 0;
2663 notes->nr_entries = 0;
2664 notes->nr_asm_entries = 0;
2666 list_for_each_entry(al, ¬es->src->source, node) {
2667 size_t line_len = strlen(al->line);
2669 if (notes->max_line_len < line_len)
2670 notes->max_line_len = line_len;
2671 al->idx = notes->nr_entries++;
2672 if (al->offset != -1) {
2673 al->idx_asm = notes->nr_asm_entries++;
2675 * FIXME: short term bandaid to cope with assembly
2676 * routines that comes with labels in the same column
2677 * as the address in objdump, sigh.
2679 * E.g. copy_user_generic_unrolled
2681 if (al->offset < size)
2682 notes->offsets[al->offset] = al;
2688 static inline int width_jumps(int n)
2697 static int annotation__max_ins_name(struct annotation *notes)
2699 int max_name = 0, len;
2700 struct annotation_line *al;
2702 list_for_each_entry(al, ¬es->src->source, node) {
2703 if (al->offset == -1)
2706 len = strlen(disasm_line(al)->ins.name);
2714 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2716 notes->widths.addr = notes->widths.target =
2717 notes->widths.min_addr = hex_width(symbol__size(sym));
2718 notes->widths.max_addr = hex_width(sym->end);
2719 notes->widths.jumps = width_jumps(notes->max_jump_sources);
2720 notes->widths.max_ins_name = annotation__max_ins_name(notes);
2723 void annotation__update_column_widths(struct annotation *notes)
2725 if (notes->options->use_offset)
2726 notes->widths.target = notes->widths.min_addr;
2728 notes->widths.target = notes->widths.max_addr;
2730 notes->widths.addr = notes->widths.target;
2732 if (notes->options->show_nr_jumps)
2733 notes->widths.addr += notes->widths.jumps + 1;
2736 static void annotation__calc_lines(struct annotation *notes, struct map *map,
2737 struct rb_root *root,
2738 struct annotation_options *opts)
2740 struct annotation_line *al;
2741 struct rb_root tmp_root = RB_ROOT;
2743 list_for_each_entry(al, ¬es->src->source, node) {
2744 double percent_max = 0.0;
2747 for (i = 0; i < al->data_nr; i++) {
2750 percent = annotation_data__percent(&al->data[i],
2751 opts->percent_type);
2753 if (percent > percent_max)
2754 percent_max = percent;
2757 if (percent_max <= 0.5)
2760 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2761 false, true, notes->start + al->offset);
2762 insert_source_line(&tmp_root, al, opts);
2765 resort_source_line(root, &tmp_root);
2768 static void symbol__calc_lines(struct map_symbol *ms, struct rb_root *root,
2769 struct annotation_options *opts)
2771 struct annotation *notes = symbol__annotation(ms->sym);
2773 annotation__calc_lines(notes, ms->map, root, opts);
2776 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel,
2777 struct annotation_options *opts)
2779 struct dso *dso = ms->map->dso;
2780 struct symbol *sym = ms->sym;
2781 struct rb_root source_line = RB_ROOT;
2782 struct hists *hists = evsel__hists(evsel);
2785 if (symbol__annotate2(ms, evsel, opts, NULL) < 0)
2788 if (opts->print_lines) {
2789 srcline_full_filename = opts->full_path;
2790 symbol__calc_lines(ms, &source_line, opts);
2791 print_summary(&source_line, dso->long_name);
2794 hists__scnprintf_title(hists, buf, sizeof(buf));
2795 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2796 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2797 symbol__annotate_fprintf2(sym, stdout, opts);
2799 annotated_source__purge(symbol__annotation(sym)->src);
2804 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel,
2805 struct annotation_options *opts)
2807 struct dso *dso = ms->map->dso;
2808 struct symbol *sym = ms->sym;
2809 struct rb_root source_line = RB_ROOT;
2811 if (symbol__annotate(ms, evsel, opts, NULL) < 0)
2814 symbol__calc_percent(sym, evsel);
2816 if (opts->print_lines) {
2817 srcline_full_filename = opts->full_path;
2818 symbol__calc_lines(ms, &source_line, opts);
2819 print_summary(&source_line, dso->long_name);
2822 symbol__annotate_printf(ms, evsel, opts);
2824 annotated_source__purge(symbol__annotation(sym)->src);
2829 bool ui__has_annotation(void)
2831 return use_browser == 1 && perf_hpp_list.sym;
2835 static double annotation_line__max_percent(struct annotation_line *al,
2836 struct annotation *notes,
2837 unsigned int percent_type)
2839 double percent_max = 0.0;
2842 for (i = 0; i < notes->nr_events; i++) {
2845 percent = annotation_data__percent(&al->data[i],
2848 if (percent > percent_max)
2849 percent_max = percent;
2855 static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2856 void *obj, char *bf, size_t size,
2857 void (*obj__printf)(void *obj, const char *fmt, ...),
2858 void (*obj__write_graph)(void *obj, int graph))
2860 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2861 if (ins__is_jump(&dl->ins)) {
2864 if (dl->ops.target.outside)
2866 fwd = dl->ops.target.offset > dl->al.offset;
2867 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2868 obj__printf(obj, " ");
2869 } else if (ins__is_call(&dl->ins)) {
2871 obj__write_graph(obj, RARROW_CHAR);
2872 obj__printf(obj, " ");
2873 } else if (ins__is_ret(&dl->ins)) {
2874 obj__write_graph(obj, LARROW_CHAR);
2875 obj__printf(obj, " ");
2877 obj__printf(obj, " ");
2880 obj__printf(obj, " ");
2883 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2886 static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2888 double ipc = 0.0, coverage = 0.0;
2890 if (notes->hit_cycles)
2891 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2893 if (notes->total_insn) {
2894 coverage = notes->cover_insn * 100.0 /
2895 ((double)notes->total_insn);
2898 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2902 static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2903 bool first_line, bool current_entry, bool change_color, int width,
2904 void *obj, unsigned int percent_type,
2905 int (*obj__set_color)(void *obj, int color),
2906 void (*obj__set_percent_color)(void *obj, double percent, bool current),
2907 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2908 void (*obj__printf)(void *obj, const char *fmt, ...),
2909 void (*obj__write_graph)(void *obj, int graph))
2912 double percent_max = annotation_line__max_percent(al, notes, percent_type);
2913 int pcnt_width = annotation__pcnt_width(notes),
2914 cycles_width = annotation__cycles_width(notes);
2915 bool show_title = false;
2919 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2920 if (notes->have_cycles) {
2921 if (al->ipc == 0.0 && al->cycles == 0)
2927 if (al->offset != -1 && percent_max != 0.0) {
2930 for (i = 0; i < notes->nr_events; i++) {
2933 percent = annotation_data__percent(&al->data[i], percent_type);
2935 obj__set_percent_color(obj, percent, current_entry);
2936 if (symbol_conf.show_total_period) {
2937 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2938 } else if (symbol_conf.show_nr_samples) {
2939 obj__printf(obj, "%6" PRIu64 " ",
2940 al->data[i].he.nr_samples);
2942 obj__printf(obj, "%6.2f ", percent);
2946 obj__set_percent_color(obj, 0, current_entry);
2949 obj__printf(obj, "%-*s", pcnt_width, " ");
2951 obj__printf(obj, "%-*s", pcnt_width,
2952 symbol_conf.show_total_period ? "Period" :
2953 symbol_conf.show_nr_samples ? "Samples" : "Percent");
2957 if (notes->have_cycles) {
2959 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2960 else if (!show_title)
2961 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2963 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2965 if (!notes->options->show_minmax_cycle) {
2967 obj__printf(obj, "%*" PRIu64 " ",
2968 ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2969 else if (!show_title)
2970 obj__printf(obj, "%*s",
2971 ANNOTATION__CYCLES_WIDTH, " ");
2973 obj__printf(obj, "%*s ",
2974 ANNOTATION__CYCLES_WIDTH - 1,
2980 scnprintf(str, sizeof(str),
2981 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2982 al->cycles, al->cycles_min,
2985 obj__printf(obj, "%*s ",
2986 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2988 } else if (!show_title)
2989 obj__printf(obj, "%*s",
2990 ANNOTATION__MINMAX_CYCLES_WIDTH,
2993 obj__printf(obj, "%*s ",
2994 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2998 if (show_title && !*al->line) {
2999 ipc_coverage_string(bf, sizeof(bf), notes);
3000 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
3004 obj__printf(obj, " ");
3007 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
3008 else if (al->offset == -1) {
3009 if (al->line_nr && notes->options->show_linenr)
3010 printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
3012 printed = scnprintf(bf, sizeof(bf), "%-*s ", notes->widths.addr, " ");
3013 obj__printf(obj, bf);
3014 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
3016 u64 addr = al->offset;
3019 if (!notes->options->use_offset)
3020 addr += notes->start;
3022 if (!notes->options->use_offset) {
3023 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
3025 if (al->jump_sources &&
3026 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
3027 if (notes->options->show_nr_jumps) {
3029 printed = scnprintf(bf, sizeof(bf), "%*d ",
3030 notes->widths.jumps,
3032 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
3034 obj__printf(obj, bf);
3035 obj__set_color(obj, prev);
3038 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
3039 notes->widths.target, addr);
3040 } else if (ins__is_call(&disasm_line(al)->ins) &&
3041 notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
3043 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
3046 printed = scnprintf(bf, sizeof(bf), "%-*s ",
3047 notes->widths.addr, " ");
3052 color = obj__set_color(obj, HE_COLORSET_ADDR);
3053 obj__printf(obj, bf);
3055 obj__set_color(obj, color);
3057 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
3059 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
3064 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
3065 struct annotation_write_ops *wops,
3066 struct annotation_options *opts)
3068 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
3069 wops->change_color, wops->width, wops->obj,
3071 wops->set_color, wops->set_percent_color,
3072 wops->set_jumps_percent_color, wops->printf,
3076 int symbol__annotate2(struct map_symbol *ms, struct evsel *evsel,
3077 struct annotation_options *options, struct arch **parch)
3079 struct symbol *sym = ms->sym;
3080 struct annotation *notes = symbol__annotation(sym);
3081 size_t size = symbol__size(sym);
3082 int nr_pcnt = 1, err;
3084 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
3085 if (notes->offsets == NULL)
3088 if (evsel__is_group_event(evsel))
3089 nr_pcnt = evsel->core.nr_members;
3091 err = symbol__annotate(ms, evsel, options, parch);
3093 goto out_free_offsets;
3095 notes->options = options;
3097 symbol__calc_percent(sym, evsel);
3099 annotation__set_offsets(notes, size);
3100 annotation__mark_jump_targets(notes, sym);
3101 annotation__compute_ipc(notes, size);
3102 annotation__init_column_widths(notes, sym);
3103 notes->nr_events = nr_pcnt;
3105 annotation__update_column_widths(notes);
3106 sym->annotate2 = true;
3111 zfree(¬es->offsets);
3115 static int annotation__config(const char *var, const char *value, void *data)
3117 struct annotation_options *opt = data;
3119 if (!strstarts(var, "annotate."))
3122 if (!strcmp(var, "annotate.offset_level")) {
3123 perf_config_u8(&opt->offset_level, "offset_level", value);
3125 if (opt->offset_level > ANNOTATION__MAX_OFFSET_LEVEL)
3126 opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
3127 else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
3128 opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
3129 } else if (!strcmp(var, "annotate.hide_src_code")) {
3130 opt->hide_src_code = perf_config_bool("hide_src_code", value);
3131 } else if (!strcmp(var, "annotate.jump_arrows")) {
3132 opt->jump_arrows = perf_config_bool("jump_arrows", value);
3133 } else if (!strcmp(var, "annotate.show_linenr")) {
3134 opt->show_linenr = perf_config_bool("show_linenr", value);
3135 } else if (!strcmp(var, "annotate.show_nr_jumps")) {
3136 opt->show_nr_jumps = perf_config_bool("show_nr_jumps", value);
3137 } else if (!strcmp(var, "annotate.show_nr_samples")) {
3138 symbol_conf.show_nr_samples = perf_config_bool("show_nr_samples",
3140 } else if (!strcmp(var, "annotate.show_total_period")) {
3141 symbol_conf.show_total_period = perf_config_bool("show_total_period",
3143 } else if (!strcmp(var, "annotate.use_offset")) {
3144 opt->use_offset = perf_config_bool("use_offset", value);
3145 } else if (!strcmp(var, "annotate.disassembler_style")) {
3146 opt->disassembler_style = value;
3148 pr_debug("%s variable unknown, ignoring...", var);
3154 void annotation_config__init(struct annotation_options *opt)
3156 perf_config(annotation__config, opt);
3159 static unsigned int parse_percent_type(char *str1, char *str2)
3161 unsigned int type = (unsigned int) -1;
3163 if (!strcmp("period", str1)) {
3164 if (!strcmp("local", str2))
3165 type = PERCENT_PERIOD_LOCAL;
3166 else if (!strcmp("global", str2))
3167 type = PERCENT_PERIOD_GLOBAL;
3170 if (!strcmp("hits", str1)) {
3171 if (!strcmp("local", str2))
3172 type = PERCENT_HITS_LOCAL;
3173 else if (!strcmp("global", str2))
3174 type = PERCENT_HITS_GLOBAL;
3180 int annotate_parse_percent_type(const struct option *opt, const char *_str,
3181 int unset __maybe_unused)
3183 struct annotation_options *opts = opt->value;
3188 str1 = strdup(_str);
3192 str2 = strchr(str1, '-');
3198 type = parse_percent_type(str1, str2);
3199 if (type == (unsigned int) -1)
3200 type = parse_percent_type(str2, str1);
3201 if (type != (unsigned int) -1) {
3202 opts->percent_type = type;
3211 int annotate_check_args(struct annotation_options *args)
3213 if (args->prefix_strip && !args->prefix) {
3214 pr_err("--prefix-strip requires --prefix\n");