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 "bpf-utils.h"
32 #include "block-range.h"
34 #include "util/event.h"
35 #include "arch/common.h"
36 #include "namespaces.h"
39 #include <linux/bitops.h>
40 #include <linux/kernel.h>
41 #include <linux/string.h>
42 #include <subcmd/parse-options.h>
43 #include <subcmd/run-command.h>
45 /* FIXME: For the HE_COLORSET */
46 #include "ui/browser.h"
49 * FIXME: Using the same values as slang.h,
50 * but that header may not be available everywhere
52 #define LARROW_CHAR ((unsigned char)',')
53 #define RARROW_CHAR ((unsigned char)'+')
54 #define DARROW_CHAR ((unsigned char)'.')
55 #define UARROW_CHAR ((unsigned char)'-')
57 #include <linux/ctype.h>
59 struct annotation_options annotation__default_options = {
63 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
64 .percent_type = PERCENT_PERIOD_LOCAL,
67 static regex_t file_lineno;
69 static struct ins_ops *ins__find(struct arch *arch, const char *name);
70 static void ins__sort(struct arch *arch);
71 static int disasm_line__parse(char *line, const char **namep, char **rawp);
75 struct ins *instructions;
76 size_t nr_instructions;
77 size_t nr_instructions_allocated;
78 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
79 bool sorted_instructions;
84 int (*init)(struct arch *arch, char *cpuid);
85 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
89 char skip_functions_char;
93 static struct ins_ops call_ops;
94 static struct ins_ops dec_ops;
95 static struct ins_ops jump_ops;
96 static struct ins_ops mov_ops;
97 static struct ins_ops nop_ops;
98 static struct ins_ops lock_ops;
99 static struct ins_ops ret_ops;
101 static int arch__grow_instructions(struct arch *arch)
103 struct ins *new_instructions;
104 size_t new_nr_allocated;
106 if (arch->nr_instructions_allocated == 0 && arch->instructions)
107 goto grow_from_non_allocated_table;
109 new_nr_allocated = arch->nr_instructions_allocated + 128;
110 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
111 if (new_instructions == NULL)
114 out_update_instructions:
115 arch->instructions = new_instructions;
116 arch->nr_instructions_allocated = new_nr_allocated;
119 grow_from_non_allocated_table:
120 new_nr_allocated = arch->nr_instructions + 128;
121 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
122 if (new_instructions == NULL)
125 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
126 goto out_update_instructions;
129 static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
133 if (arch->nr_instructions == arch->nr_instructions_allocated &&
134 arch__grow_instructions(arch))
137 ins = &arch->instructions[arch->nr_instructions];
138 ins->name = strdup(name);
143 arch->nr_instructions++;
149 #include "arch/arc/annotate/instructions.c"
150 #include "arch/arm/annotate/instructions.c"
151 #include "arch/arm64/annotate/instructions.c"
152 #include "arch/csky/annotate/instructions.c"
153 #include "arch/mips/annotate/instructions.c"
154 #include "arch/x86/annotate/instructions.c"
155 #include "arch/powerpc/annotate/instructions.c"
156 #include "arch/riscv64/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 = mips__annotate_init,
186 .init = x86__annotate_init,
187 .instructions = x86__instructions,
188 .nr_instructions = ARRAY_SIZE(x86__instructions),
195 .init = powerpc__annotate_init,
199 .init = riscv64__annotate_init,
203 .init = s390__annotate_init,
210 .init = sparc__annotate_init,
217 static void ins__delete(struct ins_operands *ops)
221 zfree(&ops->source.raw);
222 zfree(&ops->source.name);
223 zfree(&ops->target.raw);
224 zfree(&ops->target.name);
227 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
228 struct ins_operands *ops, int max_ins_name)
230 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
233 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
234 struct ins_operands *ops, int max_ins_name)
236 if (ins->ops->scnprintf)
237 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
239 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
242 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
244 if (!arch || !arch->ins_is_fused)
247 return arch->ins_is_fused(arch, ins1, ins2);
250 static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
252 char *endptr, *tok, *name;
253 struct map *map = ms->map;
254 struct addr_map_symbol target = {
255 .ms = { .map = map, },
258 ops->target.addr = strtoull(ops->raw, &endptr, 16);
260 name = strchr(endptr, '<');
266 if (arch->objdump.skip_functions_char &&
267 strchr(name, arch->objdump.skip_functions_char))
270 tok = strchr(name, '>');
275 ops->target.name = strdup(name);
278 if (ops->target.name == NULL)
281 target.addr = map__objdump_2mem(map, ops->target.addr);
283 if (maps__find_ams(ms->maps, &target) == 0 &&
284 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
285 ops->target.sym = target.ms.sym;
290 tok = strchr(endptr, '*');
294 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
295 * Do not parse such instruction. */
296 if (strstr(endptr, "(%r") == NULL)
297 ops->target.addr = strtoull(endptr, NULL, 16);
302 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
303 struct ins_operands *ops, int max_ins_name)
306 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
308 if (ops->target.addr == 0)
309 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
311 if (ops->target.name)
312 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
314 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
317 static struct ins_ops call_ops = {
318 .parse = call__parse,
319 .scnprintf = call__scnprintf,
322 bool ins__is_call(const struct ins *ins)
324 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
328 * Prevents from matching commas in the comment section, e.g.:
329 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
331 * and skip comma as part of function arguments, e.g.:
332 * 1d8b4ac <linemap_lookup(line_maps const*, unsigned int)+0xcc>
334 static inline const char *validate_comma(const char *c, struct ins_operands *ops)
336 if (ops->raw_comment && c > ops->raw_comment)
339 if (ops->raw_func_start && c > ops->raw_func_start)
345 static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
347 struct map *map = ms->map;
348 struct symbol *sym = ms->sym;
349 struct addr_map_symbol target = {
350 .ms = { .map = map, },
352 const char *c = strchr(ops->raw, ',');
355 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
356 ops->raw_func_start = strchr(ops->raw, '<');
358 c = validate_comma(c, ops);
361 * Examples of lines to parse for the _cpp_lex_token@@Base
364 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
365 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
367 * The first is a jump to an offset inside the same function,
368 * the second is to another function, i.e. that 0xa72 is an
369 * offset in the cpp_named_operator2name@@base function.
372 * skip over possible up to 2 operands to get to address, e.g.:
373 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
376 ops->target.addr = strtoull(c, NULL, 16);
377 if (!ops->target.addr) {
379 c = validate_comma(c, ops);
381 ops->target.addr = strtoull(c, NULL, 16);
384 ops->target.addr = strtoull(ops->raw, NULL, 16);
387 target.addr = map__objdump_2mem(map, ops->target.addr);
388 start = map->unmap_ip(map, sym->start),
389 end = map->unmap_ip(map, sym->end);
391 ops->target.outside = target.addr < start || target.addr > end;
394 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
396 cpp_named_operator2name@@Base+0xa72
398 * Point to a place that is after the cpp_named_operator2name
399 * boundaries, i.e. in the ELF symbol table for cc1
400 * cpp_named_operator2name is marked as being 32-bytes long, but it in
401 * fact is much larger than that, so we seem to need a symbols__find()
402 * routine that looks for >= current->start and < next_symbol->start,
403 * possibly just for C++ objects?
405 * For now lets just make some progress by marking jumps to outside the
406 * current function as call like.
408 * Actual navigation will come next, with further understanding of how
409 * the symbol searching and disassembly should be done.
411 if (maps__find_ams(ms->maps, &target) == 0 &&
412 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
413 ops->target.sym = target.ms.sym;
415 if (!ops->target.outside) {
416 ops->target.offset = target.addr - start;
417 ops->target.offset_avail = true;
419 ops->target.offset_avail = false;
425 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
426 struct ins_operands *ops, int max_ins_name)
430 if (!ops->target.addr || ops->target.offset < 0)
431 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
433 if (ops->target.outside && ops->target.sym != NULL)
434 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
436 c = strchr(ops->raw, ',');
437 c = validate_comma(c, ops);
440 const char *c2 = strchr(c + 1, ',');
442 c2 = validate_comma(c2, ops);
443 /* check for 3-op insn */
448 /* mirror arch objdump's space-after-comma style */
453 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
454 ins->name, c ? c - ops->raw : 0, ops->raw,
458 static struct ins_ops jump_ops = {
459 .parse = jump__parse,
460 .scnprintf = jump__scnprintf,
463 bool ins__is_jump(const struct ins *ins)
465 return ins->ops == &jump_ops;
468 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
470 char *endptr, *name, *t;
472 if (strstr(raw, "(%rip)") == NULL)
475 *addrp = strtoull(comment, &endptr, 16);
476 if (endptr == comment)
478 name = strchr(endptr, '<');
484 t = strchr(name, '>');
489 *namep = strdup(name);
495 static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
497 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
498 if (ops->locked.ops == NULL)
501 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
504 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
506 if (ops->locked.ins.ops == NULL)
509 if (ops->locked.ins.ops->parse &&
510 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
516 zfree(&ops->locked.ops);
520 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
521 struct ins_operands *ops, int max_ins_name)
525 if (ops->locked.ins.ops == NULL)
526 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
528 printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
529 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
530 size - printed, ops->locked.ops, max_ins_name);
533 static void lock__delete(struct ins_operands *ops)
535 struct ins *ins = &ops->locked.ins;
537 if (ins->ops && ins->ops->free)
538 ins->ops->free(ops->locked.ops);
540 ins__delete(ops->locked.ops);
542 zfree(&ops->locked.ops);
543 zfree(&ops->target.raw);
544 zfree(&ops->target.name);
547 static struct ins_ops lock_ops = {
548 .free = lock__delete,
549 .parse = lock__parse,
550 .scnprintf = lock__scnprintf,
553 static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
555 char *s = strchr(ops->raw, ','), *target, *comment, prev;
561 ops->source.raw = strdup(ops->raw);
564 if (ops->source.raw == NULL)
568 comment = strchr(s, arch->objdump.comment_char);
573 s = strchr(s, '\0') - 1;
575 while (s > target && isspace(s[0]))
581 ops->target.raw = strdup(target);
584 if (ops->target.raw == NULL)
585 goto out_free_source;
590 comment = skip_spaces(comment);
591 comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
592 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
597 zfree(&ops->source.raw);
601 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
602 struct ins_operands *ops, int max_ins_name)
604 return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
605 ops->source.name ?: ops->source.raw,
606 ops->target.name ?: ops->target.raw);
609 static struct ins_ops mov_ops = {
611 .scnprintf = mov__scnprintf,
614 static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
616 char *target, *comment, *s, prev;
618 target = s = ops->raw;
620 while (s[0] != '\0' && !isspace(s[0]))
625 ops->target.raw = strdup(target);
628 if (ops->target.raw == NULL)
631 comment = strchr(s, arch->objdump.comment_char);
635 comment = skip_spaces(comment);
636 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
641 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
642 struct ins_operands *ops, int max_ins_name)
644 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
645 ops->target.name ?: ops->target.raw);
648 static struct ins_ops dec_ops = {
650 .scnprintf = dec__scnprintf,
653 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
654 struct ins_operands *ops __maybe_unused, int max_ins_name)
656 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
659 static struct ins_ops nop_ops = {
660 .scnprintf = nop__scnprintf,
663 static struct ins_ops ret_ops = {
664 .scnprintf = ins__raw_scnprintf,
667 bool ins__is_ret(const struct ins *ins)
669 return ins->ops == &ret_ops;
672 bool ins__is_lock(const struct ins *ins)
674 return ins->ops == &lock_ops;
677 static int ins__key_cmp(const void *name, const void *insp)
679 const struct ins *ins = insp;
681 return strcmp(name, ins->name);
684 static int ins__cmp(const void *a, const void *b)
686 const struct ins *ia = a;
687 const struct ins *ib = b;
689 return strcmp(ia->name, ib->name);
692 static void ins__sort(struct arch *arch)
694 const int nmemb = arch->nr_instructions;
696 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
699 static struct ins_ops *__ins__find(struct arch *arch, const char *name)
702 const int nmemb = arch->nr_instructions;
704 if (!arch->sorted_instructions) {
706 arch->sorted_instructions = true;
709 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
710 return ins ? ins->ops : NULL;
713 static struct ins_ops *ins__find(struct arch *arch, const char *name)
715 struct ins_ops *ops = __ins__find(arch, name);
717 if (!ops && arch->associate_instruction_ops)
718 ops = arch->associate_instruction_ops(arch, name);
723 static int arch__key_cmp(const void *name, const void *archp)
725 const struct arch *arch = archp;
727 return strcmp(name, arch->name);
730 static int arch__cmp(const void *a, const void *b)
732 const struct arch *aa = a;
733 const struct arch *ab = b;
735 return strcmp(aa->name, ab->name);
738 static void arch__sort(void)
740 const int nmemb = ARRAY_SIZE(architectures);
742 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
745 static struct arch *arch__find(const char *name)
747 const int nmemb = ARRAY_SIZE(architectures);
755 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
758 static struct annotated_source *annotated_source__new(void)
760 struct annotated_source *src = zalloc(sizeof(*src));
763 INIT_LIST_HEAD(&src->source);
768 static __maybe_unused void annotated_source__delete(struct annotated_source *src)
772 zfree(&src->histograms);
773 zfree(&src->cycles_hist);
777 static int annotated_source__alloc_histograms(struct annotated_source *src,
778 size_t size, int nr_hists)
780 size_t sizeof_sym_hist;
783 * Add buffer of one element for zero length symbol.
784 * When sample is taken from first instruction of
785 * zero length symbol, perf still resolves it and
786 * shows symbol name in perf report and allows to
792 /* Check for overflow when calculating sizeof_sym_hist */
793 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
796 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
798 /* Check for overflow in zalloc argument */
799 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
802 src->sizeof_sym_hist = sizeof_sym_hist;
803 src->nr_histograms = nr_hists;
804 src->histograms = calloc(nr_hists, sizeof_sym_hist) ;
805 return src->histograms ? 0 : -1;
808 /* The cycles histogram is lazily allocated. */
809 static int symbol__alloc_hist_cycles(struct symbol *sym)
811 struct annotation *notes = symbol__annotation(sym);
812 const size_t size = symbol__size(sym);
814 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
815 if (notes->src->cycles_hist == NULL)
820 void symbol__annotate_zero_histograms(struct symbol *sym)
822 struct annotation *notes = symbol__annotation(sym);
824 pthread_mutex_lock(¬es->lock);
825 if (notes->src != NULL) {
826 memset(notes->src->histograms, 0,
827 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
828 if (notes->src->cycles_hist)
829 memset(notes->src->cycles_hist, 0,
830 symbol__size(sym) * sizeof(struct cyc_hist));
832 pthread_mutex_unlock(¬es->lock);
835 static int __symbol__account_cycles(struct cyc_hist *ch,
837 unsigned offset, unsigned cycles,
841 * For now we can only account one basic block per
842 * final jump. But multiple could be overlapping.
843 * Always account the longest one. So when
844 * a shorter one has been already seen throw it away.
846 * We separately always account the full cycles.
848 ch[offset].num_aggr++;
849 ch[offset].cycles_aggr += cycles;
851 if (cycles > ch[offset].cycles_max)
852 ch[offset].cycles_max = cycles;
854 if (ch[offset].cycles_min) {
855 if (cycles && cycles < ch[offset].cycles_min)
856 ch[offset].cycles_min = cycles;
858 ch[offset].cycles_min = cycles;
860 if (!have_start && ch[offset].have_start)
862 if (ch[offset].num) {
863 if (have_start && (!ch[offset].have_start ||
864 ch[offset].start > start)) {
865 ch[offset].have_start = 0;
866 ch[offset].cycles = 0;
868 if (ch[offset].reset < 0xffff)
870 } else if (have_start &&
871 ch[offset].start < start)
875 if (ch[offset].num < NUM_SPARKS)
876 ch[offset].cycles_spark[ch[offset].num] = cycles;
878 ch[offset].have_start = have_start;
879 ch[offset].start = start;
880 ch[offset].cycles += cycles;
885 static int __symbol__inc_addr_samples(struct map_symbol *ms,
886 struct annotated_source *src, int evidx, u64 addr,
887 struct perf_sample *sample)
889 struct symbol *sym = ms->sym;
893 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, ms->map->unmap_ip(ms->map, addr));
895 if ((addr < sym->start || addr >= sym->end) &&
896 (addr != sym->end || sym->start != sym->end)) {
897 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
898 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
902 offset = addr - sym->start;
903 h = annotated_source__histogram(src, evidx);
905 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
906 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
910 h->addr[offset].nr_samples++;
911 h->period += sample->period;
912 h->addr[offset].period += sample->period;
914 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
915 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
916 sym->start, sym->name, addr, addr - sym->start, evidx,
917 h->addr[offset].nr_samples, h->addr[offset].period);
921 static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
923 struct annotation *notes = symbol__annotation(sym);
925 if (notes->src == NULL) {
926 notes->src = annotated_source__new();
927 if (notes->src == NULL)
929 goto alloc_cycles_hist;
932 if (!notes->src->cycles_hist) {
934 symbol__alloc_hist_cycles(sym);
937 return notes->src->cycles_hist;
940 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
942 struct annotation *notes = symbol__annotation(sym);
944 if (notes->src == NULL) {
945 notes->src = annotated_source__new();
946 if (notes->src == NULL)
948 goto alloc_histograms;
951 if (notes->src->histograms == NULL) {
953 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
960 static int symbol__inc_addr_samples(struct map_symbol *ms,
961 struct evsel *evsel, u64 addr,
962 struct perf_sample *sample)
964 struct symbol *sym = ms->sym;
965 struct annotated_source *src;
969 src = symbol__hists(sym, evsel->evlist->core.nr_entries);
970 return src ? __symbol__inc_addr_samples(ms, src, evsel->core.idx, addr, sample) : 0;
973 static int symbol__account_cycles(u64 addr, u64 start,
974 struct symbol *sym, unsigned cycles)
976 struct cyc_hist *cycles_hist;
981 cycles_hist = symbol__cycles_hist(sym);
982 if (cycles_hist == NULL)
984 if (addr < sym->start || addr >= sym->end)
988 if (start < sym->start || start >= sym->end)
993 offset = addr - sym->start;
994 return __symbol__account_cycles(cycles_hist,
995 start ? start - sym->start : 0,
1000 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
1001 struct addr_map_symbol *start,
1011 * Only set start when IPC can be computed. We can only
1012 * compute it when the basic block is completely in a single
1014 * Special case the case when the jump is elsewhere, but
1015 * it starts on the function start.
1018 (start->ms.sym == ams->ms.sym ||
1020 start->addr == ams->ms.sym->start + ams->ms.map->start)))
1021 saddr = start->al_addr;
1023 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
1025 start ? start->addr : 0,
1026 ams->ms.sym ? ams->ms.sym->start + ams->ms.map->start : 0,
1028 err = symbol__account_cycles(ams->al_addr, saddr, ams->ms.sym, cycles);
1030 pr_debug2("account_cycles failed %d\n", err);
1034 static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1036 unsigned n_insn = 0;
1039 for (offset = start; offset <= end; offset++) {
1040 if (notes->offsets[offset])
1046 static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1049 unsigned int cover_insn = 0;
1052 n_insn = annotation__count_insn(notes, start, end);
1053 if (n_insn && ch->num && ch->cycles) {
1054 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1056 /* Hide data when there are too many overlaps. */
1057 if (ch->reset >= 0x7fff)
1060 for (offset = start; offset <= end; offset++) {
1061 struct annotation_line *al = notes->offsets[offset];
1063 if (al && al->ipc == 0.0) {
1070 notes->hit_cycles += ch->cycles;
1071 notes->hit_insn += n_insn * ch->num;
1072 notes->cover_insn += cover_insn;
1077 void annotation__compute_ipc(struct annotation *notes, size_t size)
1081 if (!notes->src || !notes->src->cycles_hist)
1084 notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1085 notes->hit_cycles = 0;
1086 notes->hit_insn = 0;
1087 notes->cover_insn = 0;
1089 pthread_mutex_lock(¬es->lock);
1090 for (offset = size - 1; offset >= 0; --offset) {
1091 struct cyc_hist *ch;
1093 ch = ¬es->src->cycles_hist[offset];
1094 if (ch && ch->cycles) {
1095 struct annotation_line *al;
1098 annotation__count_and_fill(notes, ch->start, offset, ch);
1099 al = notes->offsets[offset];
1100 if (al && ch->num_aggr) {
1101 al->cycles = ch->cycles_aggr / ch->num_aggr;
1102 al->cycles_max = ch->cycles_max;
1103 al->cycles_min = ch->cycles_min;
1105 notes->have_cycles = true;
1108 pthread_mutex_unlock(¬es->lock);
1111 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1112 struct evsel *evsel)
1114 return symbol__inc_addr_samples(&ams->ms, evsel, ams->al_addr, sample);
1117 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1118 struct evsel *evsel, u64 ip)
1120 return symbol__inc_addr_samples(&he->ms, evsel, ip, sample);
1123 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1125 dl->ins.ops = ins__find(arch, dl->ins.name);
1130 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1134 static int disasm_line__parse(char *line, const char **namep, char **rawp)
1136 char tmp, *name = skip_spaces(line);
1138 if (name[0] == '\0')
1143 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1148 *namep = strdup(name);
1154 *rawp = strim(*rawp);
1162 struct annotate_args {
1164 struct map_symbol ms;
1165 struct evsel *evsel;
1166 struct annotation_options *options;
1173 static void annotation_line__init(struct annotation_line *al,
1174 struct annotate_args *args,
1177 al->offset = args->offset;
1178 al->line = strdup(args->line);
1179 al->line_nr = args->line_nr;
1180 al->fileloc = args->fileloc;
1184 static void annotation_line__exit(struct annotation_line *al)
1186 free_srcline(al->path);
1190 static size_t disasm_line_size(int nr)
1192 struct annotation_line *al;
1194 return (sizeof(struct disasm_line) + (sizeof(al->data[0]) * nr));
1198 * Allocating the disasm annotation line data with
1199 * following structure:
1201 * -------------------------------------------
1202 * struct disasm_line | struct annotation_line
1203 * -------------------------------------------
1205 * We have 'struct annotation_line' member as last member
1206 * 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;
1213 if (evsel__is_group_event(args->evsel))
1214 nr = args->evsel->core.nr_members;
1216 dl = zalloc(disasm_line_size(nr));
1220 annotation_line__init(&dl->al, args, nr);
1221 if (dl->al.line == NULL)
1224 if (args->offset != -1) {
1225 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1228 disasm_line__init_ins(dl, args->arch, &args->ms);
1234 zfree(&dl->al.line);
1240 void disasm_line__free(struct disasm_line *dl)
1242 if (dl->ins.ops && dl->ins.ops->free)
1243 dl->ins.ops->free(&dl->ops);
1245 ins__delete(&dl->ops);
1246 zfree(&dl->ins.name);
1247 annotation_line__exit(&dl->al);
1251 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1253 if (raw || !dl->ins.ops)
1254 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1256 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1259 void annotation__init(struct annotation *notes)
1261 pthread_mutex_init(¬es->lock, NULL);
1264 void annotation__exit(struct annotation *notes)
1266 annotated_source__delete(notes->src);
1267 pthread_mutex_destroy(¬es->lock);
1270 static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1272 list_add_tail(&al->node, head);
1275 struct annotation_line *
1276 annotation_line__next(struct annotation_line *pos, struct list_head *head)
1278 list_for_each_entry_continue(pos, head, node)
1279 if (pos->offset >= 0)
1285 static const char *annotate__address_color(struct block_range *br)
1287 double cov = block_range__coverage(br);
1290 /* mark red for >75% coverage */
1292 return PERF_COLOR_RED;
1294 /* mark dull for <1% coverage */
1296 return PERF_COLOR_NORMAL;
1299 return PERF_COLOR_MAGENTA;
1302 static const char *annotate__asm_color(struct block_range *br)
1304 double cov = block_range__coverage(br);
1307 /* mark dull for <1% coverage */
1309 return PERF_COLOR_NORMAL;
1312 return PERF_COLOR_BLUE;
1315 static void annotate__branch_printf(struct block_range *br, u64 addr)
1317 bool emit_comment = true;
1323 if (br->is_target && br->start == addr) {
1324 struct block_range *branch = br;
1328 * Find matching branch to our target.
1330 while (!branch->is_branch)
1331 branch = block_range__next(branch);
1333 p = 100 *(double)br->entry / branch->coverage;
1337 emit_comment = false;
1342 * The percentage of coverage joined at this target in relation
1343 * to the next branch.
1345 printf(" +%.2f%%", p);
1349 if (br->is_branch && br->end == addr) {
1350 double p = 100*(double)br->taken / br->coverage;
1354 emit_comment = false;
1359 * The percentage of coverage leaving at this branch, and
1360 * its prediction ratio.
1362 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1367 static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1369 s64 offset = dl->al.offset;
1370 const u64 addr = start + offset;
1371 struct block_range *br;
1373 br = block_range__find(addr);
1374 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
1375 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1376 annotate__branch_printf(br, addr);
1381 annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1382 struct evsel *evsel, u64 len, int min_pcnt, int printed,
1383 int max_lines, struct annotation_line *queue, int addr_fmt_width,
1386 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1387 static const char *prev_line;
1389 if (al->offset != -1) {
1390 double max_percent = 0.0;
1391 int i, nr_percent = 1;
1393 struct annotation *notes = symbol__annotation(sym);
1395 for (i = 0; i < al->data_nr; i++) {
1398 percent = annotation_data__percent(&al->data[i],
1401 if (percent > max_percent)
1402 max_percent = percent;
1405 if (al->data_nr > nr_percent)
1406 nr_percent = al->data_nr;
1408 if (max_percent < min_pcnt)
1411 if (max_lines && printed >= max_lines)
1414 if (queue != NULL) {
1415 list_for_each_entry_from(queue, ¬es->src->source, node) {
1418 annotation_line__print(queue, sym, start, evsel, len,
1419 0, 0, 1, NULL, addr_fmt_width,
1424 color = get_percent_color(max_percent);
1426 for (i = 0; i < nr_percent; i++) {
1427 struct annotation_data *data = &al->data[i];
1430 percent = annotation_data__percent(data, percent_type);
1431 color = get_percent_color(percent);
1433 if (symbol_conf.show_total_period)
1434 color_fprintf(stdout, color, " %11" PRIu64,
1436 else if (symbol_conf.show_nr_samples)
1437 color_fprintf(stdout, color, " %7" PRIu64,
1438 data->he.nr_samples);
1440 color_fprintf(stdout, color, " %7.2f", percent);
1445 disasm_line__print(dl, start, addr_fmt_width);
1448 * Also color the filename and line if needed, with
1449 * the same color than the percentage. Don't print it
1450 * twice for close colored addr with the same filename:line
1453 if (!prev_line || strcmp(prev_line, al->path)) {
1454 color_fprintf(stdout, color, " // %s", al->path);
1455 prev_line = al->path;
1460 } else if (max_lines && printed >= max_lines)
1463 int width = symbol_conf.show_total_period ? 12 : 8;
1468 if (evsel__is_group_event(evsel))
1469 width *= evsel->core.nr_members;
1472 printf(" %*s:\n", width, " ");
1474 printf(" %*s: %-*d %s\n", width, " ", addr_fmt_width, al->line_nr, al->line);
1481 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1482 * which looks like following
1484 * 0000000000415500 <_init>:
1485 * 415500: sub $0x8,%rsp
1486 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1487 * 41550b: test %rax,%rax
1488 * 41550e: je 415515 <_init+0x15>
1489 * 415510: callq 416e70 <__gmon_start__@plt>
1490 * 415515: add $0x8,%rsp
1493 * it will be parsed and saved into struct disasm_line as
1494 * <offset> <name> <ops.raw>
1496 * The offset will be a relative offset from the start of the symbol and -1
1497 * means that it's not a disassembly line so should be treated differently.
1498 * The ops.raw part will be parsed further according to type of the instruction.
1500 static int symbol__parse_objdump_line(struct symbol *sym,
1501 struct annotate_args *args,
1502 char *parsed_line, int *line_nr, char **fileloc)
1504 struct map *map = args->ms.map;
1505 struct annotation *notes = symbol__annotation(sym);
1506 struct disasm_line *dl;
1508 s64 line_ip, offset = -1;
1509 regmatch_t match[2];
1511 /* /filename:linenr ? Save line number and ignore. */
1512 if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1513 *line_nr = atoi(parsed_line + match[1].rm_so);
1514 *fileloc = strdup(parsed_line);
1518 /* Process hex address followed by ':'. */
1519 line_ip = strtoull(parsed_line, &tmp, 16);
1520 if (parsed_line != tmp && tmp[0] == ':' && tmp[1] != '\0') {
1521 u64 start = map__rip_2objdump(map, sym->start),
1522 end = map__rip_2objdump(map, sym->end);
1524 offset = line_ip - start;
1525 if ((u64)line_ip < start || (u64)line_ip >= end)
1528 parsed_line = tmp + 1;
1531 args->offset = offset;
1532 args->line = parsed_line;
1533 args->line_nr = *line_nr;
1534 args->fileloc = *fileloc;
1537 dl = disasm_line__new(args);
1543 if (!disasm_line__has_local_offset(dl)) {
1544 dl->ops.target.offset = dl->ops.target.addr -
1545 map__rip_2objdump(map, sym->start);
1546 dl->ops.target.offset_avail = true;
1549 /* kcore has no symbols, so add the call target symbol */
1550 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1551 struct addr_map_symbol target = {
1552 .addr = dl->ops.target.addr,
1553 .ms = { .map = map, },
1556 if (!maps__find_ams(args->ms.maps, &target) &&
1557 target.ms.sym->start == target.al_addr)
1558 dl->ops.target.sym = target.ms.sym;
1561 annotation_line__add(&dl->al, ¬es->src->source);
1566 static __attribute__((constructor)) void symbol__init_regexpr(void)
1568 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1571 static void delete_last_nop(struct symbol *sym)
1573 struct annotation *notes = symbol__annotation(sym);
1574 struct list_head *list = ¬es->src->source;
1575 struct disasm_line *dl;
1577 while (!list_empty(list)) {
1578 dl = list_entry(list->prev, struct disasm_line, al.node);
1581 if (dl->ins.ops != &nop_ops)
1584 if (!strstr(dl->al.line, " nop ") &&
1585 !strstr(dl->al.line, " nopl ") &&
1586 !strstr(dl->al.line, " nopw "))
1590 list_del_init(&dl->al.node);
1591 disasm_line__free(dl);
1595 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen)
1597 struct dso *dso = ms->map->dso;
1599 BUG_ON(buflen == 0);
1602 str_error_r(errnum, buf, buflen);
1607 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1608 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1609 char *build_id_msg = NULL;
1611 if (dso->has_build_id) {
1612 build_id__sprintf(&dso->bid, bf + 15);
1615 scnprintf(buf, buflen,
1616 "No vmlinux file%s\nwas found in the path.\n\n"
1617 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1619 " perf buildid-cache -vu vmlinux\n\n"
1621 " --vmlinux vmlinux\n", build_id_msg ?: "");
1624 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1625 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1627 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP:
1628 scnprintf(buf, buflen, "Problems with arch specific instruction name regular expressions.");
1630 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING:
1631 scnprintf(buf, buflen, "Problems while parsing the CPUID in the arch specific initialization.");
1633 case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE:
1634 scnprintf(buf, buflen, "Invalid BPF file: %s.", dso->long_name);
1636 case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF:
1637 scnprintf(buf, buflen, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1641 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1648 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1650 char linkname[PATH_MAX];
1651 char *build_id_filename;
1652 char *build_id_path = NULL;
1656 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1657 !dso__is_kcore(dso))
1658 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1660 build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1661 if (build_id_filename) {
1662 __symbol__join_symfs(filename, filename_size, build_id_filename);
1663 free(build_id_filename);
1665 if (dso->has_build_id)
1670 build_id_path = strdup(filename);
1675 * old style build-id cache has name of XX/XXXXXXX.. while
1676 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1677 * extract the build-id part of dirname in the new style only.
1679 pos = strrchr(build_id_path, '/');
1680 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1681 dirname(build_id_path);
1683 if (dso__is_kcore(dso))
1686 len = readlink(build_id_path, linkname, sizeof(linkname) - 1);
1690 linkname[len] = '\0';
1691 if (strstr(linkname, DSO__NAME_KALLSYMS) ||
1692 access(filename, R_OK)) {
1695 * If we don't have build-ids or the build-id file isn't in the
1696 * cache, or is just a kallsyms file, well, lets hope that this
1697 * DSO is the same as when 'perf record' ran.
1699 __symbol__join_symfs(filename, filename_size, dso->long_name);
1701 if (access(filename, R_OK) && errno == ENOENT && dso->nsinfo) {
1702 char *new_name = filename_with_chroot(dso->nsinfo->pid,
1705 strlcpy(filename, new_name, filename_size);
1711 free(build_id_path);
1715 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1716 #define PACKAGE "perf"
1718 #include <dis-asm.h>
1719 #include <bpf/bpf.h>
1720 #include <bpf/btf.h>
1721 #include <bpf/libbpf.h>
1722 #include <linux/btf.h>
1724 static int symbol__disassemble_bpf(struct symbol *sym,
1725 struct annotate_args *args)
1727 struct annotation *notes = symbol__annotation(sym);
1728 struct annotation_options *opts = args->options;
1729 struct bpf_prog_linfo *prog_linfo = NULL;
1730 struct bpf_prog_info_node *info_node;
1731 int len = sym->end - sym->start;
1732 disassembler_ftype disassemble;
1733 struct map *map = args->ms.map;
1734 struct perf_bpil *info_linear;
1735 struct disassemble_info info;
1736 struct dso *dso = map->dso;
1737 int pc = 0, count, sub_id;
1738 struct btf *btf = NULL;
1739 char tpath[PATH_MAX];
1747 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1748 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE;
1750 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1751 sym->name, sym->start, sym->end - sym->start);
1753 memset(tpath, 0, sizeof(tpath));
1754 perf_exe(tpath, sizeof(tpath));
1756 bfdf = bfd_openr(tpath, NULL);
1758 assert(bfd_check_format(bfdf, bfd_object));
1760 s = open_memstream(&buf, &buf_size);
1765 init_disassemble_info(&info, s,
1766 (fprintf_ftype) fprintf);
1768 info.arch = bfd_get_arch(bfdf);
1769 info.mach = bfd_get_mach(bfdf);
1771 info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1774 ret = SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF;
1777 info_linear = info_node->info_linear;
1778 sub_id = dso->bpf_prog.sub_id;
1780 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1781 info.buffer_length = info_linear->info.jited_prog_len;
1783 if (info_linear->info.nr_line_info)
1784 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1786 if (info_linear->info.btf_id) {
1787 struct btf_node *node;
1789 node = perf_env__find_btf(dso->bpf_prog.env,
1790 info_linear->info.btf_id);
1792 btf = btf__new((__u8 *)(node->data),
1796 disassemble_init_for_target(&info);
1798 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1799 disassemble = disassembler(info.arch,
1800 bfd_big_endian(bfdf),
1804 disassemble = disassembler(bfdf);
1806 assert(disassemble);
1810 const struct bpf_line_info *linfo = NULL;
1811 struct disasm_line *dl;
1812 size_t prev_buf_size;
1813 const char *srcline;
1816 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1817 count = disassemble(pc, &info);
1820 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1825 srcline = btf__name_by_offset(btf, linfo->line_off);
1831 prev_buf_size = buf_size;
1834 if (!opts->hide_src_code && srcline) {
1836 args->line = strdup(srcline);
1838 args->fileloc = NULL;
1840 dl = disasm_line__new(args);
1842 annotation_line__add(&dl->al,
1843 ¬es->src->source);
1848 args->line = buf + prev_buf_size;
1850 args->fileloc = NULL;
1852 dl = disasm_line__new(args);
1854 annotation_line__add(&dl->al, ¬es->src->source);
1857 } while (count > 0 && pc < len);
1867 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1868 static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1869 struct annotate_args *args __maybe_unused)
1871 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1873 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1876 symbol__disassemble_bpf_image(struct symbol *sym,
1877 struct annotate_args *args)
1879 struct annotation *notes = symbol__annotation(sym);
1880 struct disasm_line *dl;
1883 args->line = strdup("to be implemented");
1885 args->fileloc = NULL;
1886 dl = disasm_line__new(args);
1888 annotation_line__add(&dl->al, ¬es->src->source);
1895 * Possibly create a new version of line with tabs expanded. Returns the
1896 * existing or new line, storage is updated if a new line is allocated. If
1897 * allocation fails then NULL is returned.
1899 static char *expand_tabs(char *line, char **storage, size_t *storage_len)
1901 size_t i, src, dst, len, new_storage_len, num_tabs;
1903 size_t line_len = strlen(line);
1905 for (num_tabs = 0, i = 0; i < line_len; i++)
1906 if (line[i] == '\t')
1913 * Space for the line and '\0', less the leading and trailing
1914 * spaces. Each tab may introduce 7 additional spaces.
1916 new_storage_len = line_len + 1 + (num_tabs * 7);
1918 new_line = malloc(new_storage_len);
1919 if (new_line == NULL) {
1920 pr_err("Failure allocating memory for tab expansion\n");
1925 * Copy regions starting at src and expand tabs. If there are two
1926 * adjacent tabs then 'src == i', the memcpy is of size 0 and the spaces
1929 for (i = 0, src = 0, dst = 0; i < line_len && num_tabs; i++) {
1930 if (line[i] == '\t') {
1932 memcpy(&new_line[dst], &line[src], len);
1934 new_line[dst++] = ' ';
1935 while (dst % 8 != 0)
1936 new_line[dst++] = ' ';
1942 /* Expand the last region. */
1943 len = line_len - src;
1944 memcpy(&new_line[dst], &line[src], len);
1946 new_line[dst] = '\0';
1949 *storage = new_line;
1950 *storage_len = new_storage_len;
1955 static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1957 struct annotation_options *opts = args->options;
1958 struct map *map = args->ms.map;
1959 struct dso *dso = map->dso;
1962 char symfs_filename[PATH_MAX];
1963 struct kcore_extract kce;
1964 bool delete_extract = false;
1965 bool decomp = false;
1967 char *fileloc = NULL;
1971 const char *objdump_argv[] = {
1974 NULL, /* Will be the objdump command to run. */
1976 NULL, /* Will be the symfs path. */
1979 struct child_process objdump_process;
1980 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1985 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1986 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1987 map->unmap_ip(map, sym->end));
1989 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1990 dso, dso->long_name, sym, sym->name);
1992 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1993 return symbol__disassemble_bpf(sym, args);
1994 } else if (dso->binary_type == DSO_BINARY_TYPE__BPF_IMAGE) {
1995 return symbol__disassemble_bpf_image(sym, args);
1996 } else if (dso__is_kcore(dso)) {
1997 kce.kcore_filename = symfs_filename;
1998 kce.addr = map__rip_2objdump(map, sym->start);
1999 kce.offs = sym->start;
2000 kce.len = sym->end - sym->start;
2001 if (!kcore_extract__create(&kce)) {
2002 delete_extract = true;
2003 strlcpy(symfs_filename, kce.extract_filename,
2004 sizeof(symfs_filename));
2006 } else if (dso__needs_decompress(dso)) {
2007 char tmp[KMOD_DECOMP_LEN];
2009 if (dso__decompress_kmodule_path(dso, symfs_filename,
2010 tmp, sizeof(tmp)) < 0)
2014 strcpy(symfs_filename, tmp);
2017 err = asprintf(&command,
2018 "%s %s%s --start-address=0x%016" PRIx64
2019 " --stop-address=0x%016" PRIx64
2020 " -l -d %s %s %s %c%s%c %s%s -C \"$1\"",
2021 opts->objdump_path ?: "objdump",
2022 opts->disassembler_style ? "-M " : "",
2023 opts->disassembler_style ?: "",
2024 map__rip_2objdump(map, sym->start),
2025 map__rip_2objdump(map, sym->end),
2026 opts->show_asm_raw ? "" : "--no-show-raw-insn",
2027 opts->annotate_src ? "-S" : "",
2028 opts->prefix ? "--prefix " : "",
2029 opts->prefix ? '"' : ' ',
2031 opts->prefix ? '"' : ' ',
2032 opts->prefix_strip ? "--prefix-strip=" : "",
2033 opts->prefix_strip ?: "");
2036 pr_err("Failure allocating memory for the command to run\n");
2037 goto out_remove_tmp;
2040 pr_debug("Executing: %s\n", command);
2042 objdump_argv[2] = command;
2043 objdump_argv[4] = symfs_filename;
2045 /* Create a pipe to read from for stdout */
2046 memset(&objdump_process, 0, sizeof(objdump_process));
2047 objdump_process.argv = objdump_argv;
2048 objdump_process.out = -1;
2049 objdump_process.err = -1;
2050 if (start_command(&objdump_process)) {
2051 pr_err("Failure starting to run %s\n", command);
2053 goto out_free_command;
2056 file = fdopen(objdump_process.out, "r");
2058 pr_err("Failure creating FILE stream for %s\n", command);
2060 * If we were using debug info should retry with
2064 goto out_close_stdout;
2067 /* Storage for getline. */
2072 while (!feof(file)) {
2074 char *expanded_line;
2076 if (getline(&line, &line_len, file) < 0 || !line)
2079 /* Skip lines containing "filename:" */
2080 match = strstr(line, symfs_filename);
2081 if (match && match[strlen(symfs_filename)] == ':')
2084 expanded_line = strim(line);
2085 expanded_line = expand_tabs(expanded_line, &line, &line_len);
2090 * The source code line number (lineno) needs to be kept in
2091 * across calls to symbol__parse_objdump_line(), so that it
2092 * can associate it with the instructions till the next one.
2093 * See disasm_line__new() and struct disasm_line::line_nr.
2095 if (symbol__parse_objdump_line(sym, args, expanded_line,
2096 &lineno, &fileloc) < 0)
2102 err = finish_command(&objdump_process);
2104 pr_err("Error running %s\n", command);
2108 pr_err("No output from %s\n", command);
2112 * kallsyms does not have symbol sizes so there may a nop at the end.
2115 if (dso__is_kcore(dso))
2116 delete_last_nop(sym);
2121 close(objdump_process.out);
2128 unlink(symfs_filename);
2131 kcore_extract__delete(&kce);
2136 static void calc_percent(struct sym_hist *sym_hist,
2137 struct hists *hists,
2138 struct annotation_data *data,
2139 s64 offset, s64 end)
2141 unsigned int hits = 0;
2144 while (offset < end) {
2145 hits += sym_hist->addr[offset].nr_samples;
2146 period += sym_hist->addr[offset].period;
2150 if (sym_hist->nr_samples) {
2151 data->he.period = period;
2152 data->he.nr_samples = hits;
2153 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2156 if (hists->stats.nr_non_filtered_samples)
2157 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2159 if (sym_hist->period)
2160 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2162 if (hists->stats.total_period)
2163 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2166 static void annotation__calc_percent(struct annotation *notes,
2167 struct evsel *leader, s64 len)
2169 struct annotation_line *al, *next;
2170 struct evsel *evsel;
2172 list_for_each_entry(al, ¬es->src->source, node) {
2176 if (al->offset == -1)
2179 next = annotation_line__next(al, ¬es->src->source);
2180 end = next ? next->offset : len;
2182 for_each_group_evsel(evsel, leader) {
2183 struct hists *hists = evsel__hists(evsel);
2184 struct annotation_data *data;
2185 struct sym_hist *sym_hist;
2187 BUG_ON(i >= al->data_nr);
2189 sym_hist = annotation__histogram(notes, evsel->core.idx);
2190 data = &al->data[i++];
2192 calc_percent(sym_hist, hists, data, al->offset, end);
2197 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
2199 struct annotation *notes = symbol__annotation(sym);
2201 annotation__calc_percent(notes, evsel, symbol__size(sym));
2204 int symbol__annotate(struct map_symbol *ms, struct evsel *evsel,
2205 struct annotation_options *options, struct arch **parch)
2207 struct symbol *sym = ms->sym;
2208 struct annotation *notes = symbol__annotation(sym);
2209 struct annotate_args args = {
2213 struct perf_env *env = evsel__env(evsel);
2214 const char *arch_name = perf_env__arch(env);
2221 args.arch = arch = arch__find(arch_name);
2223 pr_err("%s: unsupported arch %s\n", __func__, arch_name);
2231 err = arch->init(arch, env ? env->cpuid : NULL);
2233 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2239 notes->start = map__rip_2objdump(ms->map, sym->start);
2241 return symbol__disassemble(sym, &args);
2244 static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2245 struct annotation_options *opts)
2247 struct annotation_line *iter;
2248 struct rb_node **p = &root->rb_node;
2249 struct rb_node *parent = NULL;
2252 while (*p != NULL) {
2254 iter = rb_entry(parent, struct annotation_line, rb_node);
2256 ret = strcmp(iter->path, al->path);
2258 for (i = 0; i < al->data_nr; i++) {
2259 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2260 opts->percent_type);
2268 p = &(*p)->rb_right;
2271 for (i = 0; i < al->data_nr; i++) {
2272 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2273 opts->percent_type);
2276 rb_link_node(&al->rb_node, parent, p);
2277 rb_insert_color(&al->rb_node, root);
2280 static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2284 for (i = 0; i < a->data_nr; i++) {
2285 if (a->data[i].percent_sum == b->data[i].percent_sum)
2287 return a->data[i].percent_sum > b->data[i].percent_sum;
2293 static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2295 struct annotation_line *iter;
2296 struct rb_node **p = &root->rb_node;
2297 struct rb_node *parent = NULL;
2299 while (*p != NULL) {
2301 iter = rb_entry(parent, struct annotation_line, rb_node);
2303 if (cmp_source_line(al, iter))
2306 p = &(*p)->rb_right;
2309 rb_link_node(&al->rb_node, parent, p);
2310 rb_insert_color(&al->rb_node, root);
2313 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2315 struct annotation_line *al;
2316 struct rb_node *node;
2318 node = rb_first(src_root);
2320 struct rb_node *next;
2322 al = rb_entry(node, struct annotation_line, rb_node);
2323 next = rb_next(node);
2324 rb_erase(node, src_root);
2326 __resort_source_line(dest_root, al);
2331 static void print_summary(struct rb_root *root, const char *filename)
2333 struct annotation_line *al;
2334 struct rb_node *node;
2336 printf("\nSorted summary for file %s\n", filename);
2337 printf("----------------------------------------------\n\n");
2339 if (RB_EMPTY_ROOT(root)) {
2340 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2344 node = rb_first(root);
2346 double percent, percent_max = 0.0;
2351 al = rb_entry(node, struct annotation_line, rb_node);
2352 for (i = 0; i < al->data_nr; i++) {
2353 percent = al->data[i].percent_sum;
2354 color = get_percent_color(percent);
2355 color_fprintf(stdout, color, " %7.2f", percent);
2357 if (percent > percent_max)
2358 percent_max = percent;
2362 color = get_percent_color(percent_max);
2363 color_fprintf(stdout, color, " %s\n", path);
2365 node = rb_next(node);
2369 static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
2371 struct annotation *notes = symbol__annotation(sym);
2372 struct sym_hist *h = annotation__histogram(notes, evsel->core.idx);
2373 u64 len = symbol__size(sym), offset;
2375 for (offset = 0; offset < len; ++offset)
2376 if (h->addr[offset].nr_samples != 0)
2377 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2378 sym->start + offset, h->addr[offset].nr_samples);
2379 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2382 static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2385 struct annotation_line *line;
2387 list_for_each_entry_reverse(line, lines, node) {
2388 if (line->offset != -1)
2389 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2395 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
2396 struct annotation_options *opts)
2398 struct map *map = ms->map;
2399 struct symbol *sym = ms->sym;
2400 struct dso *dso = map->dso;
2402 const char *d_filename;
2403 const char *evsel_name = evsel__name(evsel);
2404 struct annotation *notes = symbol__annotation(sym);
2405 struct sym_hist *h = annotation__histogram(notes, evsel->core.idx);
2406 struct annotation_line *pos, *queue = NULL;
2407 u64 start = map__rip_2objdump(map, sym->start);
2408 int printed = 2, queue_len = 0, addr_fmt_width;
2410 bool context = opts->context;
2412 int width = symbol_conf.show_total_period ? 12 : 8;
2413 int graph_dotted_len;
2416 filename = strdup(dso->long_name);
2420 if (opts->full_path)
2421 d_filename = filename;
2423 d_filename = basename(filename);
2425 len = symbol__size(sym);
2427 if (evsel__is_group_event(evsel)) {
2428 width *= evsel->core.nr_members;
2429 evsel__group_desc(evsel, buf, sizeof(buf));
2433 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2435 width, width, symbol_conf.show_total_period ? "Period" :
2436 symbol_conf.show_nr_samples ? "Samples" : "Percent",
2437 d_filename, evsel_name, h->nr_samples,
2438 percent_type_str(opts->percent_type));
2440 printf("%-*.*s----\n",
2441 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2444 symbol__annotate_hits(sym, evsel);
2446 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2448 list_for_each_entry(pos, ¬es->src->source, node) {
2451 if (context && queue == NULL) {
2456 err = annotation_line__print(pos, sym, start, evsel, len,
2457 opts->min_pcnt, printed, opts->max_lines,
2458 queue, addr_fmt_width, opts->percent_type);
2464 printed += queue_len;
2470 /* filtered by max_lines */
2476 * Filtered by min_pcnt or non IP lines when
2481 if (queue_len == context)
2482 queue = list_entry(queue->node.next, typeof(*queue), node);
2494 static void FILE__set_percent_color(void *fp __maybe_unused,
2495 double percent __maybe_unused,
2496 bool current __maybe_unused)
2500 static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2501 int nr __maybe_unused, bool current __maybe_unused)
2506 static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2511 static void FILE__printf(void *fp, const char *fmt, ...)
2515 va_start(args, fmt);
2516 vfprintf(fp, fmt, args);
2520 static void FILE__write_graph(void *fp, int graph)
2525 case DARROW_CHAR: s = "↓"; break;
2526 case UARROW_CHAR: s = "↑"; break;
2527 case LARROW_CHAR: s = "←"; break;
2528 case RARROW_CHAR: s = "→"; break;
2529 default: s = "?"; break;
2535 static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2536 struct annotation_options *opts)
2538 struct annotation *notes = symbol__annotation(sym);
2539 struct annotation_write_ops wops = {
2542 .set_color = FILE__set_color,
2543 .set_percent_color = FILE__set_percent_color,
2544 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2545 .printf = FILE__printf,
2546 .write_graph = FILE__write_graph,
2548 struct annotation_line *al;
2550 list_for_each_entry(al, ¬es->src->source, node) {
2551 if (annotation_line__filter(al, notes))
2553 annotation_line__write(al, notes, &wops, opts);
2555 wops.first_line = false;
2561 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
2562 struct annotation_options *opts)
2564 const char *ev_name = evsel__name(evsel);
2570 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2573 fp = fopen(filename, "w");
2575 goto out_free_filename;
2577 if (evsel__is_group_event(evsel)) {
2578 evsel__group_desc(evsel, buf, sizeof(buf));
2582 fprintf(fp, "%s() %s\nEvent: %s\n\n",
2583 ms->sym->name, ms->map->dso->long_name, ev_name);
2584 symbol__annotate_fprintf2(ms->sym, fp, opts);
2593 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2595 struct annotation *notes = symbol__annotation(sym);
2596 struct sym_hist *h = annotation__histogram(notes, evidx);
2598 memset(h, 0, notes->src->sizeof_sym_hist);
2601 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2603 struct annotation *notes = symbol__annotation(sym);
2604 struct sym_hist *h = annotation__histogram(notes, evidx);
2605 int len = symbol__size(sym), offset;
2608 for (offset = 0; offset < len; ++offset) {
2609 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2610 h->nr_samples += h->addr[offset].nr_samples;
2614 void annotated_source__purge(struct annotated_source *as)
2616 struct annotation_line *al, *n;
2618 list_for_each_entry_safe(al, n, &as->source, node) {
2619 list_del_init(&al->node);
2620 disasm_line__free(disasm_line(al));
2624 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2628 if (dl->al.offset == -1)
2629 return fprintf(fp, "%s\n", dl->al.line);
2631 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2633 if (dl->ops.raw[0] != '\0') {
2634 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2638 return printed + fprintf(fp, "\n");
2641 size_t disasm__fprintf(struct list_head *head, FILE *fp)
2643 struct disasm_line *pos;
2646 list_for_each_entry(pos, head, al.node)
2647 printed += disasm_line__fprintf(pos, fp);
2652 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2654 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2655 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2656 dl->ops.target.offset >= (s64)symbol__size(sym))
2662 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2664 u64 offset, size = symbol__size(sym);
2666 /* PLT symbols contain external offsets */
2667 if (strstr(sym->name, "@plt"))
2670 for (offset = 0; offset < size; ++offset) {
2671 struct annotation_line *al = notes->offsets[offset];
2672 struct disasm_line *dl;
2674 dl = disasm_line(al);
2676 if (!disasm_line__is_valid_local_jump(dl, sym))
2679 al = notes->offsets[dl->ops.target.offset];
2682 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2683 * have to adjust to the previous offset?
2688 if (++al->jump_sources > notes->max_jump_sources)
2689 notes->max_jump_sources = al->jump_sources;
2693 void annotation__set_offsets(struct annotation *notes, s64 size)
2695 struct annotation_line *al;
2697 notes->max_line_len = 0;
2698 notes->nr_entries = 0;
2699 notes->nr_asm_entries = 0;
2701 list_for_each_entry(al, ¬es->src->source, node) {
2702 size_t line_len = strlen(al->line);
2704 if (notes->max_line_len < line_len)
2705 notes->max_line_len = line_len;
2706 al->idx = notes->nr_entries++;
2707 if (al->offset != -1) {
2708 al->idx_asm = notes->nr_asm_entries++;
2710 * FIXME: short term bandaid to cope with assembly
2711 * routines that comes with labels in the same column
2712 * as the address in objdump, sigh.
2714 * E.g. copy_user_generic_unrolled
2716 if (al->offset < size)
2717 notes->offsets[al->offset] = al;
2723 static inline int width_jumps(int n)
2732 static int annotation__max_ins_name(struct annotation *notes)
2734 int max_name = 0, len;
2735 struct annotation_line *al;
2737 list_for_each_entry(al, ¬es->src->source, node) {
2738 if (al->offset == -1)
2741 len = strlen(disasm_line(al)->ins.name);
2749 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2751 notes->widths.addr = notes->widths.target =
2752 notes->widths.min_addr = hex_width(symbol__size(sym));
2753 notes->widths.max_addr = hex_width(sym->end);
2754 notes->widths.jumps = width_jumps(notes->max_jump_sources);
2755 notes->widths.max_ins_name = annotation__max_ins_name(notes);
2758 void annotation__update_column_widths(struct annotation *notes)
2760 if (notes->options->use_offset)
2761 notes->widths.target = notes->widths.min_addr;
2763 notes->widths.target = notes->widths.max_addr;
2765 notes->widths.addr = notes->widths.target;
2767 if (notes->options->show_nr_jumps)
2768 notes->widths.addr += notes->widths.jumps + 1;
2771 static void annotation__calc_lines(struct annotation *notes, struct map *map,
2772 struct rb_root *root,
2773 struct annotation_options *opts)
2775 struct annotation_line *al;
2776 struct rb_root tmp_root = RB_ROOT;
2778 list_for_each_entry(al, ¬es->src->source, node) {
2779 double percent_max = 0.0;
2782 for (i = 0; i < al->data_nr; i++) {
2785 percent = annotation_data__percent(&al->data[i],
2786 opts->percent_type);
2788 if (percent > percent_max)
2789 percent_max = percent;
2792 if (percent_max <= 0.5)
2795 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2796 false, true, notes->start + al->offset);
2797 insert_source_line(&tmp_root, al, opts);
2800 resort_source_line(root, &tmp_root);
2803 static void symbol__calc_lines(struct map_symbol *ms, struct rb_root *root,
2804 struct annotation_options *opts)
2806 struct annotation *notes = symbol__annotation(ms->sym);
2808 annotation__calc_lines(notes, ms->map, root, opts);
2811 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel,
2812 struct annotation_options *opts)
2814 struct dso *dso = ms->map->dso;
2815 struct symbol *sym = ms->sym;
2816 struct rb_root source_line = RB_ROOT;
2817 struct hists *hists = evsel__hists(evsel);
2821 err = symbol__annotate2(ms, evsel, opts, NULL);
2825 dso->annotate_warned = true;
2826 symbol__strerror_disassemble(ms, err, msg, sizeof(msg));
2827 ui__error("Couldn't annotate %s:\n%s", sym->name, msg);
2831 if (opts->print_lines) {
2832 srcline_full_filename = opts->full_path;
2833 symbol__calc_lines(ms, &source_line, opts);
2834 print_summary(&source_line, dso->long_name);
2837 hists__scnprintf_title(hists, buf, sizeof(buf));
2838 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2839 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2840 symbol__annotate_fprintf2(sym, stdout, opts);
2842 annotated_source__purge(symbol__annotation(sym)->src);
2847 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel,
2848 struct annotation_options *opts)
2850 struct dso *dso = ms->map->dso;
2851 struct symbol *sym = ms->sym;
2852 struct rb_root source_line = RB_ROOT;
2855 err = symbol__annotate(ms, evsel, opts, NULL);
2859 dso->annotate_warned = true;
2860 symbol__strerror_disassemble(ms, err, msg, sizeof(msg));
2861 ui__error("Couldn't annotate %s:\n%s", sym->name, msg);
2865 symbol__calc_percent(sym, evsel);
2867 if (opts->print_lines) {
2868 srcline_full_filename = opts->full_path;
2869 symbol__calc_lines(ms, &source_line, opts);
2870 print_summary(&source_line, dso->long_name);
2873 symbol__annotate_printf(ms, evsel, opts);
2875 annotated_source__purge(symbol__annotation(sym)->src);
2880 bool ui__has_annotation(void)
2882 return use_browser == 1 && perf_hpp_list.sym;
2886 static double annotation_line__max_percent(struct annotation_line *al,
2887 struct annotation *notes,
2888 unsigned int percent_type)
2890 double percent_max = 0.0;
2893 for (i = 0; i < notes->nr_events; i++) {
2896 percent = annotation_data__percent(&al->data[i],
2899 if (percent > percent_max)
2900 percent_max = percent;
2906 static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2907 void *obj, char *bf, size_t size,
2908 void (*obj__printf)(void *obj, const char *fmt, ...),
2909 void (*obj__write_graph)(void *obj, int graph))
2911 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2912 if (ins__is_jump(&dl->ins)) {
2915 if (dl->ops.target.outside)
2917 fwd = dl->ops.target.offset > dl->al.offset;
2918 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2919 obj__printf(obj, " ");
2920 } else if (ins__is_call(&dl->ins)) {
2922 obj__write_graph(obj, RARROW_CHAR);
2923 obj__printf(obj, " ");
2924 } else if (ins__is_ret(&dl->ins)) {
2925 obj__write_graph(obj, LARROW_CHAR);
2926 obj__printf(obj, " ");
2928 obj__printf(obj, " ");
2931 obj__printf(obj, " ");
2934 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2937 static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2939 double ipc = 0.0, coverage = 0.0;
2941 if (notes->hit_cycles)
2942 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2944 if (notes->total_insn) {
2945 coverage = notes->cover_insn * 100.0 /
2946 ((double)notes->total_insn);
2949 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2953 static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2954 bool first_line, bool current_entry, bool change_color, int width,
2955 void *obj, unsigned int percent_type,
2956 int (*obj__set_color)(void *obj, int color),
2957 void (*obj__set_percent_color)(void *obj, double percent, bool current),
2958 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2959 void (*obj__printf)(void *obj, const char *fmt, ...),
2960 void (*obj__write_graph)(void *obj, int graph))
2963 double percent_max = annotation_line__max_percent(al, notes, percent_type);
2964 int pcnt_width = annotation__pcnt_width(notes),
2965 cycles_width = annotation__cycles_width(notes);
2966 bool show_title = false;
2970 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2971 if (notes->have_cycles) {
2972 if (al->ipc == 0.0 && al->cycles == 0)
2978 if (al->offset != -1 && percent_max != 0.0) {
2981 for (i = 0; i < notes->nr_events; i++) {
2984 percent = annotation_data__percent(&al->data[i], percent_type);
2986 obj__set_percent_color(obj, percent, current_entry);
2987 if (symbol_conf.show_total_period) {
2988 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2989 } else if (symbol_conf.show_nr_samples) {
2990 obj__printf(obj, "%6" PRIu64 " ",
2991 al->data[i].he.nr_samples);
2993 obj__printf(obj, "%6.2f ", percent);
2997 obj__set_percent_color(obj, 0, current_entry);
3000 obj__printf(obj, "%-*s", pcnt_width, " ");
3002 obj__printf(obj, "%-*s", pcnt_width,
3003 symbol_conf.show_total_period ? "Period" :
3004 symbol_conf.show_nr_samples ? "Samples" : "Percent");
3008 if (notes->have_cycles) {
3010 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
3011 else if (!show_title)
3012 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
3014 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
3016 if (!notes->options->show_minmax_cycle) {
3018 obj__printf(obj, "%*" PRIu64 " ",
3019 ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
3020 else if (!show_title)
3021 obj__printf(obj, "%*s",
3022 ANNOTATION__CYCLES_WIDTH, " ");
3024 obj__printf(obj, "%*s ",
3025 ANNOTATION__CYCLES_WIDTH - 1,
3031 scnprintf(str, sizeof(str),
3032 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
3033 al->cycles, al->cycles_min,
3036 obj__printf(obj, "%*s ",
3037 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
3039 } else if (!show_title)
3040 obj__printf(obj, "%*s",
3041 ANNOTATION__MINMAX_CYCLES_WIDTH,
3044 obj__printf(obj, "%*s ",
3045 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
3049 if (show_title && !*al->line) {
3050 ipc_coverage_string(bf, sizeof(bf), notes);
3051 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
3055 obj__printf(obj, " ");
3058 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
3059 else if (al->offset == -1) {
3060 if (al->line_nr && notes->options->show_linenr)
3061 printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
3063 printed = scnprintf(bf, sizeof(bf), "%-*s ", notes->widths.addr, " ");
3064 obj__printf(obj, bf);
3065 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
3067 u64 addr = al->offset;
3070 if (!notes->options->use_offset)
3071 addr += notes->start;
3073 if (!notes->options->use_offset) {
3074 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
3076 if (al->jump_sources &&
3077 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
3078 if (notes->options->show_nr_jumps) {
3080 printed = scnprintf(bf, sizeof(bf), "%*d ",
3081 notes->widths.jumps,
3083 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
3085 obj__printf(obj, bf);
3086 obj__set_color(obj, prev);
3089 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
3090 notes->widths.target, addr);
3091 } else if (ins__is_call(&disasm_line(al)->ins) &&
3092 notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
3094 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
3097 printed = scnprintf(bf, sizeof(bf), "%-*s ",
3098 notes->widths.addr, " ");
3103 color = obj__set_color(obj, HE_COLORSET_ADDR);
3104 obj__printf(obj, bf);
3106 obj__set_color(obj, color);
3108 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
3110 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
3115 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
3116 struct annotation_write_ops *wops,
3117 struct annotation_options *opts)
3119 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
3120 wops->change_color, wops->width, wops->obj,
3122 wops->set_color, wops->set_percent_color,
3123 wops->set_jumps_percent_color, wops->printf,
3127 int symbol__annotate2(struct map_symbol *ms, struct evsel *evsel,
3128 struct annotation_options *options, struct arch **parch)
3130 struct symbol *sym = ms->sym;
3131 struct annotation *notes = symbol__annotation(sym);
3132 size_t size = symbol__size(sym);
3133 int nr_pcnt = 1, err;
3135 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
3136 if (notes->offsets == NULL)
3139 if (evsel__is_group_event(evsel))
3140 nr_pcnt = evsel->core.nr_members;
3142 err = symbol__annotate(ms, evsel, options, parch);
3144 goto out_free_offsets;
3146 notes->options = options;
3148 symbol__calc_percent(sym, evsel);
3150 annotation__set_offsets(notes, size);
3151 annotation__mark_jump_targets(notes, sym);
3152 annotation__compute_ipc(notes, size);
3153 annotation__init_column_widths(notes, sym);
3154 notes->nr_events = nr_pcnt;
3156 annotation__update_column_widths(notes);
3162 zfree(¬es->offsets);
3166 static int annotation__config(const char *var, const char *value, void *data)
3168 struct annotation_options *opt = data;
3170 if (!strstarts(var, "annotate."))
3173 if (!strcmp(var, "annotate.offset_level")) {
3174 perf_config_u8(&opt->offset_level, "offset_level", value);
3176 if (opt->offset_level > ANNOTATION__MAX_OFFSET_LEVEL)
3177 opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
3178 else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
3179 opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
3180 } else if (!strcmp(var, "annotate.hide_src_code")) {
3181 opt->hide_src_code = perf_config_bool("hide_src_code", value);
3182 } else if (!strcmp(var, "annotate.jump_arrows")) {
3183 opt->jump_arrows = perf_config_bool("jump_arrows", value);
3184 } else if (!strcmp(var, "annotate.show_linenr")) {
3185 opt->show_linenr = perf_config_bool("show_linenr", value);
3186 } else if (!strcmp(var, "annotate.show_nr_jumps")) {
3187 opt->show_nr_jumps = perf_config_bool("show_nr_jumps", value);
3188 } else if (!strcmp(var, "annotate.show_nr_samples")) {
3189 symbol_conf.show_nr_samples = perf_config_bool("show_nr_samples",
3191 } else if (!strcmp(var, "annotate.show_total_period")) {
3192 symbol_conf.show_total_period = perf_config_bool("show_total_period",
3194 } else if (!strcmp(var, "annotate.use_offset")) {
3195 opt->use_offset = perf_config_bool("use_offset", value);
3196 } else if (!strcmp(var, "annotate.disassembler_style")) {
3197 opt->disassembler_style = value;
3198 } else if (!strcmp(var, "annotate.demangle")) {
3199 symbol_conf.demangle = perf_config_bool("demangle", value);
3200 } else if (!strcmp(var, "annotate.demangle_kernel")) {
3201 symbol_conf.demangle_kernel = perf_config_bool("demangle_kernel", value);
3203 pr_debug("%s variable unknown, ignoring...", var);
3209 void annotation_config__init(struct annotation_options *opt)
3211 perf_config(annotation__config, opt);
3214 static unsigned int parse_percent_type(char *str1, char *str2)
3216 unsigned int type = (unsigned int) -1;
3218 if (!strcmp("period", str1)) {
3219 if (!strcmp("local", str2))
3220 type = PERCENT_PERIOD_LOCAL;
3221 else if (!strcmp("global", str2))
3222 type = PERCENT_PERIOD_GLOBAL;
3225 if (!strcmp("hits", str1)) {
3226 if (!strcmp("local", str2))
3227 type = PERCENT_HITS_LOCAL;
3228 else if (!strcmp("global", str2))
3229 type = PERCENT_HITS_GLOBAL;
3235 int annotate_parse_percent_type(const struct option *opt, const char *_str,
3236 int unset __maybe_unused)
3238 struct annotation_options *opts = opt->value;
3243 str1 = strdup(_str);
3247 str2 = strchr(str1, '-');
3253 type = parse_percent_type(str1, str2);
3254 if (type == (unsigned int) -1)
3255 type = parse_percent_type(str2, str1);
3256 if (type != (unsigned int) -1) {
3257 opts->percent_type = type;
3266 int annotate_check_args(struct annotation_options *args)
3268 if (args->prefix_strip && !args->prefix) {
3269 pr_err("--prefix-strip requires --prefix\n");