1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
5 * Parts came from builtin-annotate.c, see those files for further
14 #include <bpf/libbpf.h>
15 #include <linux/btf.h>
30 #include "bpf-event.h"
31 #include "block-range.h"
33 #include "arch/common.h"
36 #include <linux/bitops.h>
37 #include <linux/kernel.h>
38 #include <linux/string.h>
39 #include <bpf/libbpf.h>
41 /* FIXME: For the HE_COLORSET */
42 #include "ui/browser.h"
45 * FIXME: Using the same values as slang.h,
46 * but that header may not be available everywhere
48 #define LARROW_CHAR ((unsigned char)',')
49 #define RARROW_CHAR ((unsigned char)'+')
50 #define DARROW_CHAR ((unsigned char)'.')
51 #define UARROW_CHAR ((unsigned char)'-')
53 #include <linux/ctype.h>
55 struct annotation_options annotation__default_options = {
59 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
60 .percent_type = PERCENT_PERIOD_LOCAL,
63 static regex_t file_lineno;
65 static struct ins_ops *ins__find(struct arch *arch, const char *name);
66 static void ins__sort(struct arch *arch);
67 static int disasm_line__parse(char *line, const char **namep, char **rawp);
71 struct ins *instructions;
72 size_t nr_instructions;
73 size_t nr_instructions_allocated;
74 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
75 bool sorted_instructions;
80 int (*init)(struct arch *arch, char *cpuid);
81 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
85 char skip_functions_char;
89 static struct ins_ops call_ops;
90 static struct ins_ops dec_ops;
91 static struct ins_ops jump_ops;
92 static struct ins_ops mov_ops;
93 static struct ins_ops nop_ops;
94 static struct ins_ops lock_ops;
95 static struct ins_ops ret_ops;
97 static int arch__grow_instructions(struct arch *arch)
99 struct ins *new_instructions;
100 size_t new_nr_allocated;
102 if (arch->nr_instructions_allocated == 0 && arch->instructions)
103 goto grow_from_non_allocated_table;
105 new_nr_allocated = arch->nr_instructions_allocated + 128;
106 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
107 if (new_instructions == NULL)
110 out_update_instructions:
111 arch->instructions = new_instructions;
112 arch->nr_instructions_allocated = new_nr_allocated;
115 grow_from_non_allocated_table:
116 new_nr_allocated = arch->nr_instructions + 128;
117 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
118 if (new_instructions == NULL)
121 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
122 goto out_update_instructions;
125 static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
129 if (arch->nr_instructions == arch->nr_instructions_allocated &&
130 arch__grow_instructions(arch))
133 ins = &arch->instructions[arch->nr_instructions];
134 ins->name = strdup(name);
139 arch->nr_instructions++;
145 #include "arch/arc/annotate/instructions.c"
146 #include "arch/arm/annotate/instructions.c"
147 #include "arch/arm64/annotate/instructions.c"
148 #include "arch/csky/annotate/instructions.c"
149 #include "arch/x86/annotate/instructions.c"
150 #include "arch/powerpc/annotate/instructions.c"
151 #include "arch/s390/annotate/instructions.c"
152 #include "arch/sparc/annotate/instructions.c"
154 static struct arch architectures[] = {
157 .init = arc__annotate_init,
161 .init = arm__annotate_init,
165 .init = arm64__annotate_init,
169 .init = csky__annotate_init,
173 .init = x86__annotate_init,
174 .instructions = x86__instructions,
175 .nr_instructions = ARRAY_SIZE(x86__instructions),
176 .ins_is_fused = x86__ins_is_fused,
183 .init = powerpc__annotate_init,
187 .init = s390__annotate_init,
194 .init = sparc__annotate_init,
201 static void ins__delete(struct ins_operands *ops)
205 zfree(&ops->source.raw);
206 zfree(&ops->source.name);
207 zfree(&ops->target.raw);
208 zfree(&ops->target.name);
211 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
212 struct ins_operands *ops, int max_ins_name)
214 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
217 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
218 struct ins_operands *ops, int max_ins_name)
220 if (ins->ops->scnprintf)
221 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
223 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
226 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
228 if (!arch || !arch->ins_is_fused)
231 return arch->ins_is_fused(arch, ins1, ins2);
234 static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
236 char *endptr, *tok, *name;
237 struct map *map = ms->map;
238 struct addr_map_symbol target = {
242 ops->target.addr = strtoull(ops->raw, &endptr, 16);
244 name = strchr(endptr, '<');
250 if (arch->objdump.skip_functions_char &&
251 strchr(name, arch->objdump.skip_functions_char))
254 tok = strchr(name, '>');
259 ops->target.name = strdup(name);
262 if (ops->target.name == NULL)
265 target.addr = map__objdump_2mem(map, ops->target.addr);
267 if (map_groups__find_ams(&target) == 0 &&
268 map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
269 ops->target.sym = target.sym;
274 tok = strchr(endptr, '*');
278 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
279 * Do not parse such instruction. */
280 if (strstr(endptr, "(%r") == NULL)
281 ops->target.addr = strtoull(endptr, NULL, 16);
286 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
287 struct ins_operands *ops, int max_ins_name)
290 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
292 if (ops->target.addr == 0)
293 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
295 if (ops->target.name)
296 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
298 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
301 static struct ins_ops call_ops = {
302 .parse = call__parse,
303 .scnprintf = call__scnprintf,
306 bool ins__is_call(const struct ins *ins)
308 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
312 * Prevents from matching commas in the comment section, e.g.:
313 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
315 static inline const char *validate_comma(const char *c, struct ins_operands *ops)
317 if (ops->raw_comment && c > ops->raw_comment)
323 static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
325 struct map *map = ms->map;
326 struct symbol *sym = ms->sym;
327 struct addr_map_symbol target = {
330 const char *c = strchr(ops->raw, ',');
333 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
334 c = validate_comma(c, ops);
337 * Examples of lines to parse for the _cpp_lex_token@@Base
340 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
341 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
343 * The first is a jump to an offset inside the same function,
344 * the second is to another function, i.e. that 0xa72 is an
345 * offset in the cpp_named_operator2name@@base function.
348 * skip over possible up to 2 operands to get to address, e.g.:
349 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
352 ops->target.addr = strtoull(c, NULL, 16);
353 if (!ops->target.addr) {
355 c = validate_comma(c, ops);
357 ops->target.addr = strtoull(c, NULL, 16);
360 ops->target.addr = strtoull(ops->raw, NULL, 16);
363 target.addr = map__objdump_2mem(map, ops->target.addr);
364 start = map->unmap_ip(map, sym->start),
365 end = map->unmap_ip(map, sym->end);
367 ops->target.outside = target.addr < start || target.addr > end;
370 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
372 cpp_named_operator2name@@Base+0xa72
374 * Point to a place that is after the cpp_named_operator2name
375 * boundaries, i.e. in the ELF symbol table for cc1
376 * cpp_named_operator2name is marked as being 32-bytes long, but it in
377 * fact is much larger than that, so we seem to need a symbols__find()
378 * routine that looks for >= current->start and < next_symbol->start,
379 * possibly just for C++ objects?
381 * For now lets just make some progress by marking jumps to outside the
382 * current function as call like.
384 * Actual navigation will come next, with further understanding of how
385 * the symbol searching and disassembly should be done.
387 if (map_groups__find_ams(&target) == 0 &&
388 map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
389 ops->target.sym = target.sym;
391 if (!ops->target.outside) {
392 ops->target.offset = target.addr - start;
393 ops->target.offset_avail = true;
395 ops->target.offset_avail = false;
401 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
402 struct ins_operands *ops, int max_ins_name)
406 if (!ops->target.addr || ops->target.offset < 0)
407 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
409 if (ops->target.outside && ops->target.sym != NULL)
410 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
412 c = strchr(ops->raw, ',');
413 c = validate_comma(c, ops);
416 const char *c2 = strchr(c + 1, ',');
418 c2 = validate_comma(c2, ops);
419 /* check for 3-op insn */
424 /* mirror arch objdump's space-after-comma style */
429 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
430 ins->name, c ? c - ops->raw : 0, ops->raw,
434 static struct ins_ops jump_ops = {
435 .parse = jump__parse,
436 .scnprintf = jump__scnprintf,
439 bool ins__is_jump(const struct ins *ins)
441 return ins->ops == &jump_ops;
444 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
446 char *endptr, *name, *t;
448 if (strstr(raw, "(%rip)") == NULL)
451 *addrp = strtoull(comment, &endptr, 16);
452 if (endptr == comment)
454 name = strchr(endptr, '<');
460 t = strchr(name, '>');
465 *namep = strdup(name);
471 static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
473 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
474 if (ops->locked.ops == NULL)
477 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
480 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
482 if (ops->locked.ins.ops == NULL)
485 if (ops->locked.ins.ops->parse &&
486 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
492 zfree(&ops->locked.ops);
496 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
497 struct ins_operands *ops, int max_ins_name)
501 if (ops->locked.ins.ops == NULL)
502 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
504 printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
505 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
506 size - printed, ops->locked.ops, max_ins_name);
509 static void lock__delete(struct ins_operands *ops)
511 struct ins *ins = &ops->locked.ins;
513 if (ins->ops && ins->ops->free)
514 ins->ops->free(ops->locked.ops);
516 ins__delete(ops->locked.ops);
518 zfree(&ops->locked.ops);
519 zfree(&ops->target.raw);
520 zfree(&ops->target.name);
523 static struct ins_ops lock_ops = {
524 .free = lock__delete,
525 .parse = lock__parse,
526 .scnprintf = lock__scnprintf,
529 static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
531 char *s = strchr(ops->raw, ','), *target, *comment, prev;
537 ops->source.raw = strdup(ops->raw);
540 if (ops->source.raw == NULL)
544 comment = strchr(s, arch->objdump.comment_char);
549 s = strchr(s, '\0') - 1;
551 while (s > target && isspace(s[0]))
557 ops->target.raw = strdup(target);
560 if (ops->target.raw == NULL)
561 goto out_free_source;
566 comment = skip_spaces(comment);
567 comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
568 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
573 zfree(&ops->source.raw);
577 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
578 struct ins_operands *ops, int max_ins_name)
580 return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
581 ops->source.name ?: ops->source.raw,
582 ops->target.name ?: ops->target.raw);
585 static struct ins_ops mov_ops = {
587 .scnprintf = mov__scnprintf,
590 static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
592 char *target, *comment, *s, prev;
594 target = s = ops->raw;
596 while (s[0] != '\0' && !isspace(s[0]))
601 ops->target.raw = strdup(target);
604 if (ops->target.raw == NULL)
607 comment = strchr(s, arch->objdump.comment_char);
611 comment = skip_spaces(comment);
612 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
617 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
618 struct ins_operands *ops, int max_ins_name)
620 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
621 ops->target.name ?: ops->target.raw);
624 static struct ins_ops dec_ops = {
626 .scnprintf = dec__scnprintf,
629 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
630 struct ins_operands *ops __maybe_unused, int max_ins_name)
632 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
635 static struct ins_ops nop_ops = {
636 .scnprintf = nop__scnprintf,
639 static struct ins_ops ret_ops = {
640 .scnprintf = ins__raw_scnprintf,
643 bool ins__is_ret(const struct ins *ins)
645 return ins->ops == &ret_ops;
648 bool ins__is_lock(const struct ins *ins)
650 return ins->ops == &lock_ops;
653 static int ins__key_cmp(const void *name, const void *insp)
655 const struct ins *ins = insp;
657 return strcmp(name, ins->name);
660 static int ins__cmp(const void *a, const void *b)
662 const struct ins *ia = a;
663 const struct ins *ib = b;
665 return strcmp(ia->name, ib->name);
668 static void ins__sort(struct arch *arch)
670 const int nmemb = arch->nr_instructions;
672 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
675 static struct ins_ops *__ins__find(struct arch *arch, const char *name)
678 const int nmemb = arch->nr_instructions;
680 if (!arch->sorted_instructions) {
682 arch->sorted_instructions = true;
685 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
686 return ins ? ins->ops : NULL;
689 static struct ins_ops *ins__find(struct arch *arch, const char *name)
691 struct ins_ops *ops = __ins__find(arch, name);
693 if (!ops && arch->associate_instruction_ops)
694 ops = arch->associate_instruction_ops(arch, name);
699 static int arch__key_cmp(const void *name, const void *archp)
701 const struct arch *arch = archp;
703 return strcmp(name, arch->name);
706 static int arch__cmp(const void *a, const void *b)
708 const struct arch *aa = a;
709 const struct arch *ab = b;
711 return strcmp(aa->name, ab->name);
714 static void arch__sort(void)
716 const int nmemb = ARRAY_SIZE(architectures);
718 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
721 static struct arch *arch__find(const char *name)
723 const int nmemb = ARRAY_SIZE(architectures);
731 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
734 static struct annotated_source *annotated_source__new(void)
736 struct annotated_source *src = zalloc(sizeof(*src));
739 INIT_LIST_HEAD(&src->source);
744 static __maybe_unused void annotated_source__delete(struct annotated_source *src)
748 zfree(&src->histograms);
749 zfree(&src->cycles_hist);
753 static int annotated_source__alloc_histograms(struct annotated_source *src,
754 size_t size, int nr_hists)
756 size_t sizeof_sym_hist;
759 * Add buffer of one element for zero length symbol.
760 * When sample is taken from first instruction of
761 * zero length symbol, perf still resolves it and
762 * shows symbol name in perf report and allows to
768 /* Check for overflow when calculating sizeof_sym_hist */
769 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
772 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
774 /* Check for overflow in zalloc argument */
775 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
778 src->sizeof_sym_hist = sizeof_sym_hist;
779 src->nr_histograms = nr_hists;
780 src->histograms = calloc(nr_hists, sizeof_sym_hist) ;
781 return src->histograms ? 0 : -1;
784 /* The cycles histogram is lazily allocated. */
785 static int symbol__alloc_hist_cycles(struct symbol *sym)
787 struct annotation *notes = symbol__annotation(sym);
788 const size_t size = symbol__size(sym);
790 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
791 if (notes->src->cycles_hist == NULL)
796 void symbol__annotate_zero_histograms(struct symbol *sym)
798 struct annotation *notes = symbol__annotation(sym);
800 pthread_mutex_lock(¬es->lock);
801 if (notes->src != NULL) {
802 memset(notes->src->histograms, 0,
803 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
804 if (notes->src->cycles_hist)
805 memset(notes->src->cycles_hist, 0,
806 symbol__size(sym) * sizeof(struct cyc_hist));
808 pthread_mutex_unlock(¬es->lock);
811 static int __symbol__account_cycles(struct cyc_hist *ch,
813 unsigned offset, unsigned cycles,
817 * For now we can only account one basic block per
818 * final jump. But multiple could be overlapping.
819 * Always account the longest one. So when
820 * a shorter one has been already seen throw it away.
822 * We separately always account the full cycles.
824 ch[offset].num_aggr++;
825 ch[offset].cycles_aggr += cycles;
827 if (cycles > ch[offset].cycles_max)
828 ch[offset].cycles_max = cycles;
830 if (ch[offset].cycles_min) {
831 if (cycles && cycles < ch[offset].cycles_min)
832 ch[offset].cycles_min = cycles;
834 ch[offset].cycles_min = cycles;
836 if (!have_start && ch[offset].have_start)
838 if (ch[offset].num) {
839 if (have_start && (!ch[offset].have_start ||
840 ch[offset].start > start)) {
841 ch[offset].have_start = 0;
842 ch[offset].cycles = 0;
844 if (ch[offset].reset < 0xffff)
846 } else if (have_start &&
847 ch[offset].start < start)
850 ch[offset].have_start = have_start;
851 ch[offset].start = start;
852 ch[offset].cycles += cycles;
857 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
858 struct annotated_source *src, int evidx, u64 addr,
859 struct perf_sample *sample)
864 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
866 if ((addr < sym->start || addr >= sym->end) &&
867 (addr != sym->end || sym->start != sym->end)) {
868 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
869 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
873 offset = addr - sym->start;
874 h = annotated_source__histogram(src, evidx);
876 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
877 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
881 h->addr[offset].nr_samples++;
882 h->period += sample->period;
883 h->addr[offset].period += sample->period;
885 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
886 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
887 sym->start, sym->name, addr, addr - sym->start, evidx,
888 h->addr[offset].nr_samples, h->addr[offset].period);
892 static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
894 struct annotation *notes = symbol__annotation(sym);
896 if (notes->src == NULL) {
897 notes->src = annotated_source__new();
898 if (notes->src == NULL)
900 goto alloc_cycles_hist;
903 if (!notes->src->cycles_hist) {
905 symbol__alloc_hist_cycles(sym);
908 return notes->src->cycles_hist;
911 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
913 struct annotation *notes = symbol__annotation(sym);
915 if (notes->src == NULL) {
916 notes->src = annotated_source__new();
917 if (notes->src == NULL)
919 goto alloc_histograms;
922 if (notes->src->histograms == NULL) {
924 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
931 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
932 struct perf_evsel *evsel, u64 addr,
933 struct perf_sample *sample)
935 struct annotated_source *src;
939 src = symbol__hists(sym, evsel->evlist->nr_entries);
940 return (src) ? __symbol__inc_addr_samples(sym, map, src, evsel->idx,
944 static int symbol__account_cycles(u64 addr, u64 start,
945 struct symbol *sym, unsigned cycles)
947 struct cyc_hist *cycles_hist;
952 cycles_hist = symbol__cycles_hist(sym);
953 if (cycles_hist == NULL)
955 if (addr < sym->start || addr >= sym->end)
959 if (start < sym->start || start >= sym->end)
964 offset = addr - sym->start;
965 return __symbol__account_cycles(cycles_hist,
966 start ? start - sym->start : 0,
971 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
972 struct addr_map_symbol *start,
982 * Only set start when IPC can be computed. We can only
983 * compute it when the basic block is completely in a single
985 * Special case the case when the jump is elsewhere, but
986 * it starts on the function start.
989 (start->sym == ams->sym ||
991 start->addr == ams->sym->start + ams->map->start)))
992 saddr = start->al_addr;
994 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
996 start ? start->addr : 0,
997 ams->sym ? ams->sym->start + ams->map->start : 0,
999 err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
1001 pr_debug2("account_cycles failed %d\n", err);
1005 static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1007 unsigned n_insn = 0;
1010 for (offset = start; offset <= end; offset++) {
1011 if (notes->offsets[offset])
1017 static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1020 unsigned int cover_insn = 0;
1023 n_insn = annotation__count_insn(notes, start, end);
1024 if (n_insn && ch->num && ch->cycles) {
1025 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1027 /* Hide data when there are too many overlaps. */
1028 if (ch->reset >= 0x7fff)
1031 for (offset = start; offset <= end; offset++) {
1032 struct annotation_line *al = notes->offsets[offset];
1034 if (al && al->ipc == 0.0) {
1041 notes->hit_cycles += ch->cycles;
1042 notes->hit_insn += n_insn * ch->num;
1043 notes->cover_insn += cover_insn;
1048 void annotation__compute_ipc(struct annotation *notes, size_t size)
1052 if (!notes->src || !notes->src->cycles_hist)
1055 notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1056 notes->hit_cycles = 0;
1057 notes->hit_insn = 0;
1058 notes->cover_insn = 0;
1060 pthread_mutex_lock(¬es->lock);
1061 for (offset = size - 1; offset >= 0; --offset) {
1062 struct cyc_hist *ch;
1064 ch = ¬es->src->cycles_hist[offset];
1065 if (ch && ch->cycles) {
1066 struct annotation_line *al;
1069 annotation__count_and_fill(notes, ch->start, offset, ch);
1070 al = notes->offsets[offset];
1071 if (al && ch->num_aggr) {
1072 al->cycles = ch->cycles_aggr / ch->num_aggr;
1073 al->cycles_max = ch->cycles_max;
1074 al->cycles_min = ch->cycles_min;
1076 notes->have_cycles = true;
1079 pthread_mutex_unlock(¬es->lock);
1082 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1083 struct perf_evsel *evsel)
1085 return symbol__inc_addr_samples(ams->sym, ams->map, evsel, ams->al_addr, sample);
1088 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1089 struct perf_evsel *evsel, u64 ip)
1091 return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evsel, ip, sample);
1094 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1096 dl->ins.ops = ins__find(arch, dl->ins.name);
1101 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1105 static int disasm_line__parse(char *line, const char **namep, char **rawp)
1107 char tmp, *name = skip_spaces(line);
1109 if (name[0] == '\0')
1114 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1119 *namep = strdup(name);
1125 *rawp = strim(*rawp);
1133 struct annotate_args {
1136 struct map_symbol ms;
1137 struct perf_evsel *evsel;
1138 struct annotation_options *options;
1144 static void annotation_line__delete(struct annotation_line *al)
1146 void *ptr = (void *) al - al->privsize;
1148 free_srcline(al->path);
1154 * Allocating the annotation line data with following
1157 * --------------------------------------
1158 * private space | struct annotation_line
1159 * --------------------------------------
1161 * Size of the private space is stored in 'struct annotation_line'.
1164 static struct annotation_line *
1165 annotation_line__new(struct annotate_args *args, size_t privsize)
1167 struct annotation_line *al;
1168 struct perf_evsel *evsel = args->evsel;
1169 size_t size = privsize + sizeof(*al);
1172 if (perf_evsel__is_group_event(evsel))
1173 nr = evsel->nr_members;
1175 size += sizeof(al->data[0]) * nr;
1179 al = (void *) al + privsize;
1180 al->privsize = privsize;
1181 al->offset = args->offset;
1182 al->line = strdup(args->line);
1183 al->line_nr = args->line_nr;
1191 * Allocating the disasm annotation line data with
1192 * following structure:
1194 * ------------------------------------------------------------
1195 * privsize space | struct disasm_line | struct annotation_line
1196 * ------------------------------------------------------------
1198 * We have 'struct annotation_line' member as last member
1199 * of 'struct disasm_line' to have an easy access.
1202 static struct disasm_line *disasm_line__new(struct annotate_args *args)
1204 struct disasm_line *dl = NULL;
1205 struct annotation_line *al;
1206 size_t privsize = args->privsize + offsetof(struct disasm_line, al);
1208 al = annotation_line__new(args, privsize);
1210 dl = disasm_line(al);
1212 if (dl->al.line == NULL)
1215 if (args->offset != -1) {
1216 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1219 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__delete(&dl->al);
1242 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1244 if (raw || !dl->ins.ops)
1245 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1247 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1250 static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1252 list_add_tail(&al->node, head);
1255 struct annotation_line *
1256 annotation_line__next(struct annotation_line *pos, struct list_head *head)
1258 list_for_each_entry_continue(pos, head, node)
1259 if (pos->offset >= 0)
1265 static const char *annotate__address_color(struct block_range *br)
1267 double cov = block_range__coverage(br);
1270 /* mark red for >75% coverage */
1272 return PERF_COLOR_RED;
1274 /* mark dull for <1% coverage */
1276 return PERF_COLOR_NORMAL;
1279 return PERF_COLOR_MAGENTA;
1282 static const char *annotate__asm_color(struct block_range *br)
1284 double cov = block_range__coverage(br);
1287 /* mark dull for <1% coverage */
1289 return PERF_COLOR_NORMAL;
1292 return PERF_COLOR_BLUE;
1295 static void annotate__branch_printf(struct block_range *br, u64 addr)
1297 bool emit_comment = true;
1303 if (br->is_target && br->start == addr) {
1304 struct block_range *branch = br;
1308 * Find matching branch to our target.
1310 while (!branch->is_branch)
1311 branch = block_range__next(branch);
1313 p = 100 *(double)br->entry / branch->coverage;
1317 emit_comment = false;
1322 * The percentage of coverage joined at this target in relation
1323 * to the next branch.
1325 printf(" +%.2f%%", p);
1329 if (br->is_branch && br->end == addr) {
1330 double p = 100*(double)br->taken / br->coverage;
1334 emit_comment = false;
1339 * The percentage of coverage leaving at this branch, and
1340 * its prediction ratio.
1342 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1347 static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1349 s64 offset = dl->al.offset;
1350 const u64 addr = start + offset;
1351 struct block_range *br;
1353 br = block_range__find(addr);
1354 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
1355 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1356 annotate__branch_printf(br, addr);
1361 annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1362 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
1363 int max_lines, struct annotation_line *queue, int addr_fmt_width,
1366 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1367 static const char *prev_line;
1368 static const char *prev_color;
1370 if (al->offset != -1) {
1371 double max_percent = 0.0;
1372 int i, nr_percent = 1;
1374 struct annotation *notes = symbol__annotation(sym);
1376 for (i = 0; i < al->data_nr; i++) {
1379 percent = annotation_data__percent(&al->data[i],
1382 if (percent > max_percent)
1383 max_percent = percent;
1386 if (al->data_nr > nr_percent)
1387 nr_percent = al->data_nr;
1389 if (max_percent < min_pcnt)
1392 if (max_lines && printed >= max_lines)
1395 if (queue != NULL) {
1396 list_for_each_entry_from(queue, ¬es->src->source, node) {
1399 annotation_line__print(queue, sym, start, evsel, len,
1400 0, 0, 1, NULL, addr_fmt_width,
1405 color = get_percent_color(max_percent);
1408 * Also color the filename and line if needed, with
1409 * the same color than the percentage. Don't print it
1410 * twice for close colored addr with the same filename:line
1413 if (!prev_line || strcmp(prev_line, al->path)
1414 || color != prev_color) {
1415 color_fprintf(stdout, color, " %s", al->path);
1416 prev_line = al->path;
1421 for (i = 0; i < nr_percent; i++) {
1422 struct annotation_data *data = &al->data[i];
1425 percent = annotation_data__percent(data, percent_type);
1426 color = get_percent_color(percent);
1428 if (symbol_conf.show_total_period)
1429 color_fprintf(stdout, color, " %11" PRIu64,
1431 else if (symbol_conf.show_nr_samples)
1432 color_fprintf(stdout, color, " %7" PRIu64,
1433 data->he.nr_samples);
1435 color_fprintf(stdout, color, " %7.2f", percent);
1440 disasm_line__print(dl, start, addr_fmt_width);
1442 } else if (max_lines && printed >= max_lines)
1445 int width = symbol_conf.show_total_period ? 12 : 8;
1450 if (perf_evsel__is_group_event(evsel))
1451 width *= evsel->nr_members;
1454 printf(" %*s:\n", width, " ");
1456 printf(" %*s: %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1463 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1464 * which looks like following
1466 * 0000000000415500 <_init>:
1467 * 415500: sub $0x8,%rsp
1468 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1469 * 41550b: test %rax,%rax
1470 * 41550e: je 415515 <_init+0x15>
1471 * 415510: callq 416e70 <__gmon_start__@plt>
1472 * 415515: add $0x8,%rsp
1475 * it will be parsed and saved into struct disasm_line as
1476 * <offset> <name> <ops.raw>
1478 * The offset will be a relative offset from the start of the symbol and -1
1479 * means that it's not a disassembly line so should be treated differently.
1480 * The ops.raw part will be parsed further according to type of the instruction.
1482 static int symbol__parse_objdump_line(struct symbol *sym, FILE *file,
1483 struct annotate_args *args,
1486 struct map *map = args->ms.map;
1487 struct annotation *notes = symbol__annotation(sym);
1488 struct disasm_line *dl;
1489 char *line = NULL, *parsed_line, *tmp, *tmp2;
1491 s64 line_ip, offset = -1;
1492 regmatch_t match[2];
1494 if (getline(&line, &line_len, file) < 0)
1501 parsed_line = strim(line);
1503 /* /filename:linenr ? Save line number and ignore. */
1504 if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1505 *line_nr = atoi(parsed_line + match[1].rm_so);
1509 tmp = skip_spaces(parsed_line);
1512 * Parse hexa addresses followed by ':'
1514 line_ip = strtoull(tmp, &tmp2, 16);
1515 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1519 if (line_ip != -1) {
1520 u64 start = map__rip_2objdump(map, sym->start),
1521 end = map__rip_2objdump(map, sym->end);
1523 offset = line_ip - start;
1524 if ((u64)line_ip < start || (u64)line_ip >= end)
1527 parsed_line = tmp2 + 1;
1530 args->offset = offset;
1531 args->line = parsed_line;
1532 args->line_nr = *line_nr;
1535 dl = disasm_line__new(args);
1542 if (!disasm_line__has_local_offset(dl)) {
1543 dl->ops.target.offset = dl->ops.target.addr -
1544 map__rip_2objdump(map, sym->start);
1545 dl->ops.target.offset_avail = true;
1548 /* kcore has no symbols, so add the call target symbol */
1549 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1550 struct addr_map_symbol target = {
1552 .addr = dl->ops.target.addr,
1555 if (!map_groups__find_ams(&target) &&
1556 target.sym->start == target.al_addr)
1557 dl->ops.target.sym = target.sym;
1560 annotation_line__add(&dl->al, ¬es->src->source);
1565 static __attribute__((constructor)) void symbol__init_regexpr(void)
1567 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1570 static void delete_last_nop(struct symbol *sym)
1572 struct annotation *notes = symbol__annotation(sym);
1573 struct list_head *list = ¬es->src->source;
1574 struct disasm_line *dl;
1576 while (!list_empty(list)) {
1577 dl = list_entry(list->prev, struct disasm_line, al.node);
1580 if (dl->ins.ops != &nop_ops)
1583 if (!strstr(dl->al.line, " nop ") &&
1584 !strstr(dl->al.line, " nopl ") &&
1585 !strstr(dl->al.line, " nopw "))
1589 list_del_init(&dl->al.node);
1590 disasm_line__free(dl);
1594 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1595 int errnum, char *buf, size_t buflen)
1597 struct dso *dso = 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->build_id,
1613 sizeof(dso->build_id), bf + 15);
1616 scnprintf(buf, buflen,
1617 "No vmlinux file%s\nwas found in the path.\n\n"
1618 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1620 " perf buildid-cache -vu vmlinux\n\n"
1622 " --vmlinux vmlinux\n", build_id_msg ?: "");
1625 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1626 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1629 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1636 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1638 char linkname[PATH_MAX];
1639 char *build_id_filename;
1640 char *build_id_path = NULL;
1643 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1644 !dso__is_kcore(dso))
1645 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1647 build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1648 if (build_id_filename) {
1649 __symbol__join_symfs(filename, filename_size, build_id_filename);
1650 free(build_id_filename);
1652 if (dso->has_build_id)
1657 build_id_path = strdup(filename);
1662 * old style build-id cache has name of XX/XXXXXXX.. while
1663 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1664 * extract the build-id part of dirname in the new style only.
1666 pos = strrchr(build_id_path, '/');
1667 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1668 dirname(build_id_path);
1670 if (dso__is_kcore(dso) ||
1671 readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1672 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>
1692 static int symbol__disassemble_bpf(struct symbol *sym,
1693 struct annotate_args *args)
1695 struct annotation *notes = symbol__annotation(sym);
1696 struct annotation_options *opts = args->options;
1697 struct bpf_prog_info_linear *info_linear;
1698 struct bpf_prog_linfo *prog_linfo = NULL;
1699 struct bpf_prog_info_node *info_node;
1700 int len = sym->end - sym->start;
1701 disassembler_ftype disassemble;
1702 struct map *map = args->ms.map;
1703 struct disassemble_info info;
1704 struct dso *dso = map->dso;
1705 int pc = 0, count, sub_id;
1706 struct btf *btf = NULL;
1707 char tpath[PATH_MAX];
1715 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1718 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1719 sym->name, sym->start, sym->end - sym->start);
1721 memset(tpath, 0, sizeof(tpath));
1722 perf_exe(tpath, sizeof(tpath));
1724 bfdf = bfd_openr(tpath, NULL);
1726 assert(bfd_check_format(bfdf, bfd_object));
1728 s = open_memstream(&buf, &buf_size);
1731 init_disassemble_info(&info, s,
1732 (fprintf_ftype) fprintf);
1734 info.arch = bfd_get_arch(bfdf);
1735 info.mach = bfd_get_mach(bfdf);
1737 info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1741 info_linear = info_node->info_linear;
1742 sub_id = dso->bpf_prog.sub_id;
1744 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1745 info.buffer_length = info_linear->info.jited_prog_len;
1747 if (info_linear->info.nr_line_info)
1748 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1750 if (info_linear->info.btf_id) {
1751 struct btf_node *node;
1753 node = perf_env__find_btf(dso->bpf_prog.env,
1754 info_linear->info.btf_id);
1756 btf = btf__new((__u8 *)(node->data),
1760 disassemble_init_for_target(&info);
1762 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1763 disassemble = disassembler(info.arch,
1764 bfd_big_endian(bfdf),
1768 disassemble = disassembler(bfdf);
1770 assert(disassemble);
1774 const struct bpf_line_info *linfo = NULL;
1775 struct disasm_line *dl;
1776 size_t prev_buf_size;
1777 const char *srcline;
1780 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1781 count = disassemble(pc, &info);
1784 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1789 srcline = btf__name_by_offset(btf, linfo->line_off);
1795 prev_buf_size = buf_size;
1798 if (!opts->hide_src_code && srcline) {
1800 args->line = strdup(srcline);
1803 dl = disasm_line__new(args);
1805 annotation_line__add(&dl->al,
1806 ¬es->src->source);
1811 args->line = buf + prev_buf_size;
1814 dl = disasm_line__new(args);
1816 annotation_line__add(&dl->al, ¬es->src->source);
1819 } while (count > 0 && pc < len);
1829 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1830 static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1831 struct annotate_args *args __maybe_unused)
1833 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1835 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1837 static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1839 struct annotation_options *opts = args->options;
1840 struct map *map = args->ms.map;
1841 struct dso *dso = map->dso;
1844 char symfs_filename[PATH_MAX];
1845 struct kcore_extract kce;
1846 bool delete_extract = false;
1847 bool decomp = false;
1852 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1857 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1858 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1859 map->unmap_ip(map, sym->end));
1861 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1862 dso, dso->long_name, sym, sym->name);
1864 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1865 return symbol__disassemble_bpf(sym, args);
1866 } else if (dso__is_kcore(dso)) {
1867 kce.kcore_filename = symfs_filename;
1868 kce.addr = map__rip_2objdump(map, sym->start);
1869 kce.offs = sym->start;
1870 kce.len = sym->end - sym->start;
1871 if (!kcore_extract__create(&kce)) {
1872 delete_extract = true;
1873 strlcpy(symfs_filename, kce.extract_filename,
1874 sizeof(symfs_filename));
1876 } else if (dso__needs_decompress(dso)) {
1877 char tmp[KMOD_DECOMP_LEN];
1879 if (dso__decompress_kmodule_path(dso, symfs_filename,
1880 tmp, sizeof(tmp)) < 0)
1884 strcpy(symfs_filename, tmp);
1887 err = asprintf(&command,
1888 "%s %s%s --start-address=0x%016" PRIx64
1889 " --stop-address=0x%016" PRIx64
1890 " -l -d %s %s -C \"$1\" 2>/dev/null|grep -v \"$1:\"|expand",
1891 opts->objdump_path ?: "objdump",
1892 opts->disassembler_style ? "-M " : "",
1893 opts->disassembler_style ?: "",
1894 map__rip_2objdump(map, sym->start),
1895 map__rip_2objdump(map, sym->end),
1896 opts->show_asm_raw ? "" : "--no-show-raw",
1897 opts->annotate_src ? "-S" : "");
1900 pr_err("Failure allocating memory for the command to run\n");
1901 goto out_remove_tmp;
1904 pr_debug("Executing: %s\n", command);
1907 if (pipe(stdout_fd) < 0) {
1908 pr_err("Failure creating the pipe to run %s\n", command);
1909 goto out_free_command;
1914 pr_err("Failure forking to run %s\n", command);
1915 goto out_close_stdout;
1919 close(stdout_fd[0]);
1920 dup2(stdout_fd[1], 1);
1921 close(stdout_fd[1]);
1922 execl("/bin/sh", "sh", "-c", command, "--", symfs_filename,
1928 close(stdout_fd[1]);
1930 file = fdopen(stdout_fd[0], "r");
1932 pr_err("Failure creating FILE stream for %s\n", command);
1934 * If we were using debug info should retry with
1937 goto out_free_command;
1941 while (!feof(file)) {
1943 * The source code line number (lineno) needs to be kept in
1944 * across calls to symbol__parse_objdump_line(), so that it
1945 * can associate it with the instructions till the next one.
1946 * See disasm_line__new() and struct disasm_line::line_nr.
1948 if (symbol__parse_objdump_line(sym, file, args, &lineno) < 0)
1954 pr_err("No output from %s\n", command);
1957 * kallsyms does not have symbol sizes so there may a nop at the end.
1960 if (dso__is_kcore(dso))
1961 delete_last_nop(sym);
1968 close(stdout_fd[0]);
1971 unlink(symfs_filename);
1974 kcore_extract__delete(&kce);
1979 close(stdout_fd[1]);
1980 goto out_free_command;
1983 static void calc_percent(struct sym_hist *sym_hist,
1984 struct hists *hists,
1985 struct annotation_data *data,
1986 s64 offset, s64 end)
1988 unsigned int hits = 0;
1991 while (offset < end) {
1992 hits += sym_hist->addr[offset].nr_samples;
1993 period += sym_hist->addr[offset].period;
1997 if (sym_hist->nr_samples) {
1998 data->he.period = period;
1999 data->he.nr_samples = hits;
2000 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2003 if (hists->stats.nr_non_filtered_samples)
2004 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2006 if (sym_hist->period)
2007 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2009 if (hists->stats.total_period)
2010 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2013 static void annotation__calc_percent(struct annotation *notes,
2014 struct perf_evsel *leader, s64 len)
2016 struct annotation_line *al, *next;
2017 struct perf_evsel *evsel;
2019 list_for_each_entry(al, ¬es->src->source, node) {
2023 if (al->offset == -1)
2026 next = annotation_line__next(al, ¬es->src->source);
2027 end = next ? next->offset : len;
2029 for_each_group_evsel(evsel, leader) {
2030 struct hists *hists = evsel__hists(evsel);
2031 struct annotation_data *data;
2032 struct sym_hist *sym_hist;
2034 BUG_ON(i >= al->data_nr);
2036 sym_hist = annotation__histogram(notes, evsel->idx);
2037 data = &al->data[i++];
2039 calc_percent(sym_hist, hists, data, al->offset, end);
2044 void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel)
2046 struct annotation *notes = symbol__annotation(sym);
2048 annotation__calc_percent(notes, evsel, symbol__size(sym));
2051 int symbol__annotate(struct symbol *sym, struct map *map,
2052 struct perf_evsel *evsel, size_t privsize,
2053 struct annotation_options *options,
2054 struct arch **parch)
2056 struct annotation *notes = symbol__annotation(sym);
2057 struct annotate_args args = {
2058 .privsize = privsize,
2062 struct perf_env *env = perf_evsel__env(evsel);
2063 const char *arch_name = perf_env__arch(env);
2070 args.arch = arch = arch__find(arch_name);
2078 err = arch->init(arch, env ? env->cpuid : NULL);
2080 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2087 notes->start = map__rip_2objdump(map, sym->start);
2089 return symbol__disassemble(sym, &args);
2092 static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2093 struct annotation_options *opts)
2095 struct annotation_line *iter;
2096 struct rb_node **p = &root->rb_node;
2097 struct rb_node *parent = NULL;
2100 while (*p != NULL) {
2102 iter = rb_entry(parent, struct annotation_line, rb_node);
2104 ret = strcmp(iter->path, al->path);
2106 for (i = 0; i < al->data_nr; i++) {
2107 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2108 opts->percent_type);
2116 p = &(*p)->rb_right;
2119 for (i = 0; i < al->data_nr; i++) {
2120 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2121 opts->percent_type);
2124 rb_link_node(&al->rb_node, parent, p);
2125 rb_insert_color(&al->rb_node, root);
2128 static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2132 for (i = 0; i < a->data_nr; i++) {
2133 if (a->data[i].percent_sum == b->data[i].percent_sum)
2135 return a->data[i].percent_sum > b->data[i].percent_sum;
2141 static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2143 struct annotation_line *iter;
2144 struct rb_node **p = &root->rb_node;
2145 struct rb_node *parent = NULL;
2147 while (*p != NULL) {
2149 iter = rb_entry(parent, struct annotation_line, rb_node);
2151 if (cmp_source_line(al, iter))
2154 p = &(*p)->rb_right;
2157 rb_link_node(&al->rb_node, parent, p);
2158 rb_insert_color(&al->rb_node, root);
2161 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2163 struct annotation_line *al;
2164 struct rb_node *node;
2166 node = rb_first(src_root);
2168 struct rb_node *next;
2170 al = rb_entry(node, struct annotation_line, rb_node);
2171 next = rb_next(node);
2172 rb_erase(node, src_root);
2174 __resort_source_line(dest_root, al);
2179 static void print_summary(struct rb_root *root, const char *filename)
2181 struct annotation_line *al;
2182 struct rb_node *node;
2184 printf("\nSorted summary for file %s\n", filename);
2185 printf("----------------------------------------------\n\n");
2187 if (RB_EMPTY_ROOT(root)) {
2188 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2192 node = rb_first(root);
2194 double percent, percent_max = 0.0;
2199 al = rb_entry(node, struct annotation_line, rb_node);
2200 for (i = 0; i < al->data_nr; i++) {
2201 percent = al->data[i].percent_sum;
2202 color = get_percent_color(percent);
2203 color_fprintf(stdout, color, " %7.2f", percent);
2205 if (percent > percent_max)
2206 percent_max = percent;
2210 color = get_percent_color(percent_max);
2211 color_fprintf(stdout, color, " %s\n", path);
2213 node = rb_next(node);
2217 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
2219 struct annotation *notes = symbol__annotation(sym);
2220 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2221 u64 len = symbol__size(sym), offset;
2223 for (offset = 0; offset < len; ++offset)
2224 if (h->addr[offset].nr_samples != 0)
2225 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2226 sym->start + offset, h->addr[offset].nr_samples);
2227 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2230 static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2233 struct annotation_line *line;
2235 list_for_each_entry_reverse(line, lines, node) {
2236 if (line->offset != -1)
2237 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2243 int symbol__annotate_printf(struct symbol *sym, struct map *map,
2244 struct perf_evsel *evsel,
2245 struct annotation_options *opts)
2247 struct dso *dso = map->dso;
2249 const char *d_filename;
2250 const char *evsel_name = perf_evsel__name(evsel);
2251 struct annotation *notes = symbol__annotation(sym);
2252 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2253 struct annotation_line *pos, *queue = NULL;
2254 u64 start = map__rip_2objdump(map, sym->start);
2255 int printed = 2, queue_len = 0, addr_fmt_width;
2257 bool context = opts->context;
2259 int width = symbol_conf.show_total_period ? 12 : 8;
2260 int graph_dotted_len;
2263 filename = strdup(dso->long_name);
2267 if (opts->full_path)
2268 d_filename = filename;
2270 d_filename = basename(filename);
2272 len = symbol__size(sym);
2274 if (perf_evsel__is_group_event(evsel)) {
2275 width *= evsel->nr_members;
2276 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2280 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2282 width, width, symbol_conf.show_total_period ? "Period" :
2283 symbol_conf.show_nr_samples ? "Samples" : "Percent",
2284 d_filename, evsel_name, h->nr_samples,
2285 percent_type_str(opts->percent_type));
2287 printf("%-*.*s----\n",
2288 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2291 symbol__annotate_hits(sym, evsel);
2293 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2295 list_for_each_entry(pos, ¬es->src->source, node) {
2298 if (context && queue == NULL) {
2303 err = annotation_line__print(pos, sym, start, evsel, len,
2304 opts->min_pcnt, printed, opts->max_lines,
2305 queue, addr_fmt_width, opts->percent_type);
2311 printed += queue_len;
2317 /* filtered by max_lines */
2323 * Filtered by min_pcnt or non IP lines when
2328 if (queue_len == context)
2329 queue = list_entry(queue->node.next, typeof(*queue), node);
2341 static void FILE__set_percent_color(void *fp __maybe_unused,
2342 double percent __maybe_unused,
2343 bool current __maybe_unused)
2347 static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2348 int nr __maybe_unused, bool current __maybe_unused)
2353 static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2358 static void FILE__printf(void *fp, const char *fmt, ...)
2362 va_start(args, fmt);
2363 vfprintf(fp, fmt, args);
2367 static void FILE__write_graph(void *fp, int graph)
2372 case DARROW_CHAR: s = "↓"; break;
2373 case UARROW_CHAR: s = "↑"; break;
2374 case LARROW_CHAR: s = "←"; break;
2375 case RARROW_CHAR: s = "→"; break;
2376 default: s = "?"; break;
2382 static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2383 struct annotation_options *opts)
2385 struct annotation *notes = symbol__annotation(sym);
2386 struct annotation_write_ops wops = {
2389 .set_color = FILE__set_color,
2390 .set_percent_color = FILE__set_percent_color,
2391 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2392 .printf = FILE__printf,
2393 .write_graph = FILE__write_graph,
2395 struct annotation_line *al;
2397 list_for_each_entry(al, ¬es->src->source, node) {
2398 if (annotation_line__filter(al, notes))
2400 annotation_line__write(al, notes, &wops, opts);
2402 wops.first_line = false;
2408 int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel,
2409 struct annotation_options *opts)
2411 const char *ev_name = perf_evsel__name(evsel);
2417 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2420 fp = fopen(filename, "w");
2422 goto out_free_filename;
2424 if (perf_evsel__is_group_event(evsel)) {
2425 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2429 fprintf(fp, "%s() %s\nEvent: %s\n\n",
2430 ms->sym->name, ms->map->dso->long_name, ev_name);
2431 symbol__annotate_fprintf2(ms->sym, fp, opts);
2440 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2442 struct annotation *notes = symbol__annotation(sym);
2443 struct sym_hist *h = annotation__histogram(notes, evidx);
2445 memset(h, 0, notes->src->sizeof_sym_hist);
2448 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2450 struct annotation *notes = symbol__annotation(sym);
2451 struct sym_hist *h = annotation__histogram(notes, evidx);
2452 int len = symbol__size(sym), offset;
2455 for (offset = 0; offset < len; ++offset) {
2456 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2457 h->nr_samples += h->addr[offset].nr_samples;
2461 void annotated_source__purge(struct annotated_source *as)
2463 struct annotation_line *al, *n;
2465 list_for_each_entry_safe(al, n, &as->source, node) {
2466 list_del_init(&al->node);
2467 disasm_line__free(disasm_line(al));
2471 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2475 if (dl->al.offset == -1)
2476 return fprintf(fp, "%s\n", dl->al.line);
2478 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2480 if (dl->ops.raw[0] != '\0') {
2481 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2485 return printed + fprintf(fp, "\n");
2488 size_t disasm__fprintf(struct list_head *head, FILE *fp)
2490 struct disasm_line *pos;
2493 list_for_each_entry(pos, head, al.node)
2494 printed += disasm_line__fprintf(pos, fp);
2499 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2501 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2502 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2503 dl->ops.target.offset >= (s64)symbol__size(sym))
2509 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2511 u64 offset, size = symbol__size(sym);
2513 /* PLT symbols contain external offsets */
2514 if (strstr(sym->name, "@plt"))
2517 for (offset = 0; offset < size; ++offset) {
2518 struct annotation_line *al = notes->offsets[offset];
2519 struct disasm_line *dl;
2521 dl = disasm_line(al);
2523 if (!disasm_line__is_valid_local_jump(dl, sym))
2526 al = notes->offsets[dl->ops.target.offset];
2529 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2530 * have to adjust to the previous offset?
2535 if (++al->jump_sources > notes->max_jump_sources)
2536 notes->max_jump_sources = al->jump_sources;
2542 void annotation__set_offsets(struct annotation *notes, s64 size)
2544 struct annotation_line *al;
2546 notes->max_line_len = 0;
2548 list_for_each_entry(al, ¬es->src->source, node) {
2549 size_t line_len = strlen(al->line);
2551 if (notes->max_line_len < line_len)
2552 notes->max_line_len = line_len;
2553 al->idx = notes->nr_entries++;
2554 if (al->offset != -1) {
2555 al->idx_asm = notes->nr_asm_entries++;
2557 * FIXME: short term bandaid to cope with assembly
2558 * routines that comes with labels in the same column
2559 * as the address in objdump, sigh.
2561 * E.g. copy_user_generic_unrolled
2563 if (al->offset < size)
2564 notes->offsets[al->offset] = al;
2570 static inline int width_jumps(int n)
2579 static int annotation__max_ins_name(struct annotation *notes)
2581 int max_name = 0, len;
2582 struct annotation_line *al;
2584 list_for_each_entry(al, ¬es->src->source, node) {
2585 if (al->offset == -1)
2588 len = strlen(disasm_line(al)->ins.name);
2596 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2598 notes->widths.addr = notes->widths.target =
2599 notes->widths.min_addr = hex_width(symbol__size(sym));
2600 notes->widths.max_addr = hex_width(sym->end);
2601 notes->widths.jumps = width_jumps(notes->max_jump_sources);
2602 notes->widths.max_ins_name = annotation__max_ins_name(notes);
2605 void annotation__update_column_widths(struct annotation *notes)
2607 if (notes->options->use_offset)
2608 notes->widths.target = notes->widths.min_addr;
2610 notes->widths.target = notes->widths.max_addr;
2612 notes->widths.addr = notes->widths.target;
2614 if (notes->options->show_nr_jumps)
2615 notes->widths.addr += notes->widths.jumps + 1;
2618 static void annotation__calc_lines(struct annotation *notes, struct map *map,
2619 struct rb_root *root,
2620 struct annotation_options *opts)
2622 struct annotation_line *al;
2623 struct rb_root tmp_root = RB_ROOT;
2625 list_for_each_entry(al, ¬es->src->source, node) {
2626 double percent_max = 0.0;
2629 for (i = 0; i < al->data_nr; i++) {
2632 percent = annotation_data__percent(&al->data[i],
2633 opts->percent_type);
2635 if (percent > percent_max)
2636 percent_max = percent;
2639 if (percent_max <= 0.5)
2642 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2643 false, true, notes->start + al->offset);
2644 insert_source_line(&tmp_root, al, opts);
2647 resort_source_line(root, &tmp_root);
2650 static void symbol__calc_lines(struct symbol *sym, struct map *map,
2651 struct rb_root *root,
2652 struct annotation_options *opts)
2654 struct annotation *notes = symbol__annotation(sym);
2656 annotation__calc_lines(notes, map, root, opts);
2659 int symbol__tty_annotate2(struct symbol *sym, struct map *map,
2660 struct perf_evsel *evsel,
2661 struct annotation_options *opts)
2663 struct dso *dso = map->dso;
2664 struct rb_root source_line = RB_ROOT;
2665 struct hists *hists = evsel__hists(evsel);
2668 if (symbol__annotate2(sym, map, evsel, opts, NULL) < 0)
2671 if (opts->print_lines) {
2672 srcline_full_filename = opts->full_path;
2673 symbol__calc_lines(sym, map, &source_line, opts);
2674 print_summary(&source_line, dso->long_name);
2677 hists__scnprintf_title(hists, buf, sizeof(buf));
2678 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2679 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2680 symbol__annotate_fprintf2(sym, stdout, opts);
2682 annotated_source__purge(symbol__annotation(sym)->src);
2687 int symbol__tty_annotate(struct symbol *sym, struct map *map,
2688 struct perf_evsel *evsel,
2689 struct annotation_options *opts)
2691 struct dso *dso = map->dso;
2692 struct rb_root source_line = RB_ROOT;
2694 if (symbol__annotate(sym, map, evsel, 0, opts, NULL) < 0)
2697 symbol__calc_percent(sym, evsel);
2699 if (opts->print_lines) {
2700 srcline_full_filename = opts->full_path;
2701 symbol__calc_lines(sym, map, &source_line, opts);
2702 print_summary(&source_line, dso->long_name);
2705 symbol__annotate_printf(sym, map, evsel, opts);
2707 annotated_source__purge(symbol__annotation(sym)->src);
2712 bool ui__has_annotation(void)
2714 return use_browser == 1 && perf_hpp_list.sym;
2718 static double annotation_line__max_percent(struct annotation_line *al,
2719 struct annotation *notes,
2720 unsigned int percent_type)
2722 double percent_max = 0.0;
2725 for (i = 0; i < notes->nr_events; i++) {
2728 percent = annotation_data__percent(&al->data[i],
2731 if (percent > percent_max)
2732 percent_max = percent;
2738 static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2739 void *obj, char *bf, size_t size,
2740 void (*obj__printf)(void *obj, const char *fmt, ...),
2741 void (*obj__write_graph)(void *obj, int graph))
2743 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2744 if (ins__is_jump(&dl->ins)) {
2747 if (dl->ops.target.outside)
2749 fwd = dl->ops.target.offset > dl->al.offset;
2750 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2751 obj__printf(obj, " ");
2752 } else if (ins__is_call(&dl->ins)) {
2754 obj__write_graph(obj, RARROW_CHAR);
2755 obj__printf(obj, " ");
2756 } else if (ins__is_ret(&dl->ins)) {
2757 obj__write_graph(obj, LARROW_CHAR);
2758 obj__printf(obj, " ");
2760 obj__printf(obj, " ");
2763 obj__printf(obj, " ");
2766 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2769 static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2771 double ipc = 0.0, coverage = 0.0;
2773 if (notes->hit_cycles)
2774 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2776 if (notes->total_insn) {
2777 coverage = notes->cover_insn * 100.0 /
2778 ((double)notes->total_insn);
2781 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2785 static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2786 bool first_line, bool current_entry, bool change_color, int width,
2787 void *obj, unsigned int percent_type,
2788 int (*obj__set_color)(void *obj, int color),
2789 void (*obj__set_percent_color)(void *obj, double percent, bool current),
2790 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2791 void (*obj__printf)(void *obj, const char *fmt, ...),
2792 void (*obj__write_graph)(void *obj, int graph))
2795 double percent_max = annotation_line__max_percent(al, notes, percent_type);
2796 int pcnt_width = annotation__pcnt_width(notes),
2797 cycles_width = annotation__cycles_width(notes);
2798 bool show_title = false;
2802 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2803 if (notes->have_cycles) {
2804 if (al->ipc == 0.0 && al->cycles == 0)
2810 if (al->offset != -1 && percent_max != 0.0) {
2813 for (i = 0; i < notes->nr_events; i++) {
2816 percent = annotation_data__percent(&al->data[i], percent_type);
2818 obj__set_percent_color(obj, percent, current_entry);
2819 if (notes->options->show_total_period) {
2820 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2821 } else if (notes->options->show_nr_samples) {
2822 obj__printf(obj, "%6" PRIu64 " ",
2823 al->data[i].he.nr_samples);
2825 obj__printf(obj, "%6.2f ", percent);
2829 obj__set_percent_color(obj, 0, current_entry);
2832 obj__printf(obj, "%-*s", pcnt_width, " ");
2834 obj__printf(obj, "%-*s", pcnt_width,
2835 notes->options->show_total_period ? "Period" :
2836 notes->options->show_nr_samples ? "Samples" : "Percent");
2840 if (notes->have_cycles) {
2842 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2843 else if (!show_title)
2844 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2846 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2848 if (!notes->options->show_minmax_cycle) {
2850 obj__printf(obj, "%*" PRIu64 " ",
2851 ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2852 else if (!show_title)
2853 obj__printf(obj, "%*s",
2854 ANNOTATION__CYCLES_WIDTH, " ");
2856 obj__printf(obj, "%*s ",
2857 ANNOTATION__CYCLES_WIDTH - 1,
2863 scnprintf(str, sizeof(str),
2864 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2865 al->cycles, al->cycles_min,
2868 obj__printf(obj, "%*s ",
2869 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2871 } else if (!show_title)
2872 obj__printf(obj, "%*s",
2873 ANNOTATION__MINMAX_CYCLES_WIDTH,
2876 obj__printf(obj, "%*s ",
2877 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2881 if (show_title && !*al->line) {
2882 ipc_coverage_string(bf, sizeof(bf), notes);
2883 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2887 obj__printf(obj, " ");
2890 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
2891 else if (al->offset == -1) {
2892 if (al->line_nr && notes->options->show_linenr)
2893 printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
2895 printed = scnprintf(bf, sizeof(bf), "%-*s ", notes->widths.addr, " ");
2896 obj__printf(obj, bf);
2897 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
2899 u64 addr = al->offset;
2902 if (!notes->options->use_offset)
2903 addr += notes->start;
2905 if (!notes->options->use_offset) {
2906 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
2908 if (al->jump_sources &&
2909 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
2910 if (notes->options->show_nr_jumps) {
2912 printed = scnprintf(bf, sizeof(bf), "%*d ",
2913 notes->widths.jumps,
2915 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
2917 obj__printf(obj, bf);
2918 obj__set_color(obj, prev);
2921 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
2922 notes->widths.target, addr);
2923 } else if (ins__is_call(&disasm_line(al)->ins) &&
2924 notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
2926 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
2929 printed = scnprintf(bf, sizeof(bf), "%-*s ",
2930 notes->widths.addr, " ");
2935 color = obj__set_color(obj, HE_COLORSET_ADDR);
2936 obj__printf(obj, bf);
2938 obj__set_color(obj, color);
2940 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
2942 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
2947 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
2948 struct annotation_write_ops *wops,
2949 struct annotation_options *opts)
2951 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
2952 wops->change_color, wops->width, wops->obj,
2954 wops->set_color, wops->set_percent_color,
2955 wops->set_jumps_percent_color, wops->printf,
2959 int symbol__annotate2(struct symbol *sym, struct map *map, struct perf_evsel *evsel,
2960 struct annotation_options *options, struct arch **parch)
2962 struct annotation *notes = symbol__annotation(sym);
2963 size_t size = symbol__size(sym);
2964 int nr_pcnt = 1, err;
2966 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
2967 if (notes->offsets == NULL)
2970 if (perf_evsel__is_group_event(evsel))
2971 nr_pcnt = evsel->nr_members;
2973 err = symbol__annotate(sym, map, evsel, 0, options, parch);
2975 goto out_free_offsets;
2977 notes->options = options;
2979 symbol__calc_percent(sym, evsel);
2981 annotation__set_offsets(notes, size);
2982 annotation__mark_jump_targets(notes, sym);
2983 annotation__compute_ipc(notes, size);
2984 annotation__init_column_widths(notes, sym);
2985 notes->nr_events = nr_pcnt;
2987 annotation__update_column_widths(notes);
2988 sym->annotate2 = true;
2993 zfree(¬es->offsets);
2997 #define ANNOTATION__CFG(n) \
2998 { .name = #n, .value = &annotation__default_options.n, }
3001 * Keep the entries sorted, they are bsearch'ed
3003 static struct annotation_config {
3006 } annotation__configs[] = {
3007 ANNOTATION__CFG(hide_src_code),
3008 ANNOTATION__CFG(jump_arrows),
3009 ANNOTATION__CFG(offset_level),
3010 ANNOTATION__CFG(show_linenr),
3011 ANNOTATION__CFG(show_nr_jumps),
3012 ANNOTATION__CFG(show_nr_samples),
3013 ANNOTATION__CFG(show_total_period),
3014 ANNOTATION__CFG(use_offset),
3017 #undef ANNOTATION__CFG
3019 static int annotation_config__cmp(const void *name, const void *cfgp)
3021 const struct annotation_config *cfg = cfgp;
3023 return strcmp(name, cfg->name);
3026 static int annotation__config(const char *var, const char *value,
3027 void *data __maybe_unused)
3029 struct annotation_config *cfg;
3032 if (!strstarts(var, "annotate."))
3036 cfg = bsearch(name, annotation__configs, ARRAY_SIZE(annotation__configs),
3037 sizeof(struct annotation_config), annotation_config__cmp);
3040 pr_debug("%s variable unknown, ignoring...", var);
3041 else if (strcmp(var, "annotate.offset_level") == 0) {
3042 perf_config_int(cfg->value, name, value);
3044 if (*(int *)cfg->value > ANNOTATION__MAX_OFFSET_LEVEL)
3045 *(int *)cfg->value = ANNOTATION__MAX_OFFSET_LEVEL;
3046 else if (*(int *)cfg->value < ANNOTATION__MIN_OFFSET_LEVEL)
3047 *(int *)cfg->value = ANNOTATION__MIN_OFFSET_LEVEL;
3049 *(bool *)cfg->value = perf_config_bool(name, value);
3054 void annotation_config__init(void)
3056 perf_config(annotation__config, NULL);
3058 annotation__default_options.show_total_period = symbol_conf.show_total_period;
3059 annotation__default_options.show_nr_samples = symbol_conf.show_nr_samples;
3062 static unsigned int parse_percent_type(char *str1, char *str2)
3064 unsigned int type = (unsigned int) -1;
3066 if (!strcmp("period", str1)) {
3067 if (!strcmp("local", str2))
3068 type = PERCENT_PERIOD_LOCAL;
3069 else if (!strcmp("global", str2))
3070 type = PERCENT_PERIOD_GLOBAL;
3073 if (!strcmp("hits", str1)) {
3074 if (!strcmp("local", str2))
3075 type = PERCENT_HITS_LOCAL;
3076 else if (!strcmp("global", str2))
3077 type = PERCENT_HITS_GLOBAL;
3083 int annotate_parse_percent_type(const struct option *opt, const char *_str,
3084 int unset __maybe_unused)
3086 struct annotation_options *opts = opt->value;
3091 str1 = strdup(_str);
3095 str2 = strchr(str1, '-');
3101 type = parse_percent_type(str1, str2);
3102 if (type == (unsigned int) -1)
3103 type = parse_percent_type(str2, str1);
3104 if (type != (unsigned int) -1) {
3105 opts->percent_type = type;