1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
5 * Parts came from builtin-annotate.c, see those files for further
15 #include <bpf/libbpf.h>
16 #include <linux/btf.h>
17 #include "util.h" // hex_width()
34 #include "bpf-event.h"
35 #include "block-range.h"
37 #include "util/event.h"
38 #include "arch/common.h"
41 #include <linux/bitops.h>
42 #include <linux/kernel.h>
43 #include <linux/string.h>
44 #include <subcmd/parse-options.h>
45 #include <subcmd/run-command.h>
47 /* FIXME: For the HE_COLORSET */
48 #include "ui/browser.h"
51 * FIXME: Using the same values as slang.h,
52 * but that header may not be available everywhere
54 #define LARROW_CHAR ((unsigned char)',')
55 #define RARROW_CHAR ((unsigned char)'+')
56 #define DARROW_CHAR ((unsigned char)'.')
57 #define UARROW_CHAR ((unsigned char)'-')
59 #include <linux/ctype.h>
61 struct annotation_options annotation__default_options
= {
65 .offset_level
= ANNOTATION__OFFSET_JUMP_TARGETS
,
66 .percent_type
= PERCENT_PERIOD_LOCAL
,
69 static regex_t file_lineno
;
71 static struct ins_ops
*ins__find(struct arch
*arch
, const char *name
);
72 static void ins__sort(struct arch
*arch
);
73 static int disasm_line__parse(char *line
, const char **namep
, char **rawp
);
77 struct ins
*instructions
;
78 size_t nr_instructions
;
79 size_t nr_instructions_allocated
;
80 struct ins_ops
*(*associate_instruction_ops
)(struct arch
*arch
, const char *name
);
81 bool sorted_instructions
;
86 int (*init
)(struct arch
*arch
, char *cpuid
);
87 bool (*ins_is_fused
)(struct arch
*arch
, const char *ins1
,
91 char skip_functions_char
;
95 static struct ins_ops call_ops
;
96 static struct ins_ops dec_ops
;
97 static struct ins_ops jump_ops
;
98 static struct ins_ops mov_ops
;
99 static struct ins_ops nop_ops
;
100 static struct ins_ops lock_ops
;
101 static struct ins_ops ret_ops
;
103 static int arch__grow_instructions(struct arch
*arch
)
105 struct ins
*new_instructions
;
106 size_t new_nr_allocated
;
108 if (arch
->nr_instructions_allocated
== 0 && arch
->instructions
)
109 goto grow_from_non_allocated_table
;
111 new_nr_allocated
= arch
->nr_instructions_allocated
+ 128;
112 new_instructions
= realloc(arch
->instructions
, new_nr_allocated
* sizeof(struct ins
));
113 if (new_instructions
== NULL
)
116 out_update_instructions
:
117 arch
->instructions
= new_instructions
;
118 arch
->nr_instructions_allocated
= new_nr_allocated
;
121 grow_from_non_allocated_table
:
122 new_nr_allocated
= arch
->nr_instructions
+ 128;
123 new_instructions
= calloc(new_nr_allocated
, sizeof(struct ins
));
124 if (new_instructions
== NULL
)
127 memcpy(new_instructions
, arch
->instructions
, arch
->nr_instructions
);
128 goto out_update_instructions
;
131 static int arch__associate_ins_ops(struct arch
* arch
, const char *name
, struct ins_ops
*ops
)
135 if (arch
->nr_instructions
== arch
->nr_instructions_allocated
&&
136 arch__grow_instructions(arch
))
139 ins
= &arch
->instructions
[arch
->nr_instructions
];
140 ins
->name
= strdup(name
);
145 arch
->nr_instructions
++;
151 #include "arch/arc/annotate/instructions.c"
152 #include "arch/arm/annotate/instructions.c"
153 #include "arch/arm64/annotate/instructions.c"
154 #include "arch/csky/annotate/instructions.c"
155 #include "arch/x86/annotate/instructions.c"
156 #include "arch/powerpc/annotate/instructions.c"
157 #include "arch/s390/annotate/instructions.c"
158 #include "arch/sparc/annotate/instructions.c"
160 static struct arch architectures
[] = {
163 .init
= arc__annotate_init
,
167 .init
= arm__annotate_init
,
171 .init
= arm64__annotate_init
,
175 .init
= csky__annotate_init
,
179 .init
= x86__annotate_init
,
180 .instructions
= x86__instructions
,
181 .nr_instructions
= ARRAY_SIZE(x86__instructions
),
182 .ins_is_fused
= x86__ins_is_fused
,
189 .init
= powerpc__annotate_init
,
193 .init
= s390__annotate_init
,
200 .init
= sparc__annotate_init
,
207 static void ins__delete(struct ins_operands
*ops
)
211 zfree(&ops
->source
.raw
);
212 zfree(&ops
->source
.name
);
213 zfree(&ops
->target
.raw
);
214 zfree(&ops
->target
.name
);
217 static int ins__raw_scnprintf(struct ins
*ins
, char *bf
, size_t size
,
218 struct ins_operands
*ops
, int max_ins_name
)
220 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->raw
);
223 int ins__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
224 struct ins_operands
*ops
, int max_ins_name
)
226 if (ins
->ops
->scnprintf
)
227 return ins
->ops
->scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
229 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
232 bool ins__is_fused(struct arch
*arch
, const char *ins1
, const char *ins2
)
234 if (!arch
|| !arch
->ins_is_fused
)
237 return arch
->ins_is_fused(arch
, ins1
, ins2
);
240 static int call__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms
)
242 char *endptr
, *tok
, *name
;
243 struct map
*map
= ms
->map
;
244 struct addr_map_symbol target
= {
245 .ms
= { .map
= map
, },
248 ops
->target
.addr
= strtoull(ops
->raw
, &endptr
, 16);
250 name
= strchr(endptr
, '<');
256 if (arch
->objdump
.skip_functions_char
&&
257 strchr(name
, arch
->objdump
.skip_functions_char
))
260 tok
= strchr(name
, '>');
265 ops
->target
.name
= strdup(name
);
268 if (ops
->target
.name
== NULL
)
271 target
.addr
= map__objdump_2mem(map
, ops
->target
.addr
);
273 if (maps__find_ams(ms
->maps
, &target
) == 0 &&
274 map__rip_2objdump(target
.ms
.map
, map
->map_ip(target
.ms
.map
, target
.addr
)) == ops
->target
.addr
)
275 ops
->target
.sym
= target
.ms
.sym
;
280 tok
= strchr(endptr
, '*');
284 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
285 * Do not parse such instruction. */
286 if (strstr(endptr
, "(%r") == NULL
)
287 ops
->target
.addr
= strtoull(endptr
, NULL
, 16);
292 static int call__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
293 struct ins_operands
*ops
, int max_ins_name
)
296 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->target
.sym
->name
);
298 if (ops
->target
.addr
== 0)
299 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
301 if (ops
->target
.name
)
302 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->target
.name
);
304 return scnprintf(bf
, size
, "%-*s *%" PRIx64
, max_ins_name
, ins
->name
, ops
->target
.addr
);
307 static struct ins_ops call_ops
= {
308 .parse
= call__parse
,
309 .scnprintf
= call__scnprintf
,
312 bool ins__is_call(const struct ins
*ins
)
314 return ins
->ops
== &call_ops
|| ins
->ops
== &s390_call_ops
;
318 * Prevents from matching commas in the comment section, e.g.:
319 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
321 static inline const char *validate_comma(const char *c
, struct ins_operands
*ops
)
323 if (ops
->raw_comment
&& c
> ops
->raw_comment
)
329 static int jump__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms
)
331 struct map
*map
= ms
->map
;
332 struct symbol
*sym
= ms
->sym
;
333 struct addr_map_symbol target
= {
334 .ms
= { .map
= map
, },
336 const char *c
= strchr(ops
->raw
, ',');
339 ops
->raw_comment
= strchr(ops
->raw
, arch
->objdump
.comment_char
);
340 c
= validate_comma(c
, ops
);
343 * Examples of lines to parse for the _cpp_lex_token@@Base
346 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
347 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
349 * The first is a jump to an offset inside the same function,
350 * the second is to another function, i.e. that 0xa72 is an
351 * offset in the cpp_named_operator2name@@base function.
354 * skip over possible up to 2 operands to get to address, e.g.:
355 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
358 ops
->target
.addr
= strtoull(c
, NULL
, 16);
359 if (!ops
->target
.addr
) {
361 c
= validate_comma(c
, ops
);
363 ops
->target
.addr
= strtoull(c
, NULL
, 16);
366 ops
->target
.addr
= strtoull(ops
->raw
, NULL
, 16);
369 target
.addr
= map__objdump_2mem(map
, ops
->target
.addr
);
370 start
= map
->unmap_ip(map
, sym
->start
),
371 end
= map
->unmap_ip(map
, sym
->end
);
373 ops
->target
.outside
= target
.addr
< start
|| target
.addr
> end
;
376 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
378 cpp_named_operator2name@@Base+0xa72
380 * Point to a place that is after the cpp_named_operator2name
381 * boundaries, i.e. in the ELF symbol table for cc1
382 * cpp_named_operator2name is marked as being 32-bytes long, but it in
383 * fact is much larger than that, so we seem to need a symbols__find()
384 * routine that looks for >= current->start and < next_symbol->start,
385 * possibly just for C++ objects?
387 * For now lets just make some progress by marking jumps to outside the
388 * current function as call like.
390 * Actual navigation will come next, with further understanding of how
391 * the symbol searching and disassembly should be done.
393 if (maps__find_ams(ms
->maps
, &target
) == 0 &&
394 map__rip_2objdump(target
.ms
.map
, map
->map_ip(target
.ms
.map
, target
.addr
)) == ops
->target
.addr
)
395 ops
->target
.sym
= target
.ms
.sym
;
397 if (!ops
->target
.outside
) {
398 ops
->target
.offset
= target
.addr
- start
;
399 ops
->target
.offset_avail
= true;
401 ops
->target
.offset_avail
= false;
407 static int jump__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
408 struct ins_operands
*ops
, int max_ins_name
)
412 if (!ops
->target
.addr
|| ops
->target
.offset
< 0)
413 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
415 if (ops
->target
.outside
&& ops
->target
.sym
!= NULL
)
416 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->target
.sym
->name
);
418 c
= strchr(ops
->raw
, ',');
419 c
= validate_comma(c
, ops
);
422 const char *c2
= strchr(c
+ 1, ',');
424 c2
= validate_comma(c2
, ops
);
425 /* check for 3-op insn */
430 /* mirror arch objdump's space-after-comma style */
435 return scnprintf(bf
, size
, "%-*s %.*s%" PRIx64
, max_ins_name
,
436 ins
->name
, c
? c
- ops
->raw
: 0, ops
->raw
,
440 static struct ins_ops jump_ops
= {
441 .parse
= jump__parse
,
442 .scnprintf
= jump__scnprintf
,
445 bool ins__is_jump(const struct ins
*ins
)
447 return ins
->ops
== &jump_ops
;
450 static int comment__symbol(char *raw
, char *comment
, u64
*addrp
, char **namep
)
452 char *endptr
, *name
, *t
;
454 if (strstr(raw
, "(%rip)") == NULL
)
457 *addrp
= strtoull(comment
, &endptr
, 16);
458 if (endptr
== comment
)
460 name
= strchr(endptr
, '<');
466 t
= strchr(name
, '>');
471 *namep
= strdup(name
);
477 static int lock__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms
)
479 ops
->locked
.ops
= zalloc(sizeof(*ops
->locked
.ops
));
480 if (ops
->locked
.ops
== NULL
)
483 if (disasm_line__parse(ops
->raw
, &ops
->locked
.ins
.name
, &ops
->locked
.ops
->raw
) < 0)
486 ops
->locked
.ins
.ops
= ins__find(arch
, ops
->locked
.ins
.name
);
488 if (ops
->locked
.ins
.ops
== NULL
)
491 if (ops
->locked
.ins
.ops
->parse
&&
492 ops
->locked
.ins
.ops
->parse(arch
, ops
->locked
.ops
, ms
) < 0)
498 zfree(&ops
->locked
.ops
);
502 static int lock__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
503 struct ins_operands
*ops
, int max_ins_name
)
507 if (ops
->locked
.ins
.ops
== NULL
)
508 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
510 printed
= scnprintf(bf
, size
, "%-*s ", max_ins_name
, ins
->name
);
511 return printed
+ ins__scnprintf(&ops
->locked
.ins
, bf
+ printed
,
512 size
- printed
, ops
->locked
.ops
, max_ins_name
);
515 static void lock__delete(struct ins_operands
*ops
)
517 struct ins
*ins
= &ops
->locked
.ins
;
519 if (ins
->ops
&& ins
->ops
->free
)
520 ins
->ops
->free(ops
->locked
.ops
);
522 ins__delete(ops
->locked
.ops
);
524 zfree(&ops
->locked
.ops
);
525 zfree(&ops
->target
.raw
);
526 zfree(&ops
->target
.name
);
529 static struct ins_ops lock_ops
= {
530 .free
= lock__delete
,
531 .parse
= lock__parse
,
532 .scnprintf
= lock__scnprintf
,
535 static int mov__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms __maybe_unused
)
537 char *s
= strchr(ops
->raw
, ','), *target
, *comment
, prev
;
543 ops
->source
.raw
= strdup(ops
->raw
);
546 if (ops
->source
.raw
== NULL
)
550 comment
= strchr(s
, arch
->objdump
.comment_char
);
555 s
= strchr(s
, '\0') - 1;
557 while (s
> target
&& isspace(s
[0]))
563 ops
->target
.raw
= strdup(target
);
566 if (ops
->target
.raw
== NULL
)
567 goto out_free_source
;
572 comment
= skip_spaces(comment
);
573 comment__symbol(ops
->source
.raw
, comment
+ 1, &ops
->source
.addr
, &ops
->source
.name
);
574 comment__symbol(ops
->target
.raw
, comment
+ 1, &ops
->target
.addr
, &ops
->target
.name
);
579 zfree(&ops
->source
.raw
);
583 static int mov__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
584 struct ins_operands
*ops
, int max_ins_name
)
586 return scnprintf(bf
, size
, "%-*s %s,%s", max_ins_name
, ins
->name
,
587 ops
->source
.name
?: ops
->source
.raw
,
588 ops
->target
.name
?: ops
->target
.raw
);
591 static struct ins_ops mov_ops
= {
593 .scnprintf
= mov__scnprintf
,
596 static int dec__parse(struct arch
*arch __maybe_unused
, struct ins_operands
*ops
, struct map_symbol
*ms __maybe_unused
)
598 char *target
, *comment
, *s
, prev
;
600 target
= s
= ops
->raw
;
602 while (s
[0] != '\0' && !isspace(s
[0]))
607 ops
->target
.raw
= strdup(target
);
610 if (ops
->target
.raw
== NULL
)
613 comment
= strchr(s
, arch
->objdump
.comment_char
);
617 comment
= skip_spaces(comment
);
618 comment__symbol(ops
->target
.raw
, comment
+ 1, &ops
->target
.addr
, &ops
->target
.name
);
623 static int dec__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
624 struct ins_operands
*ops
, int max_ins_name
)
626 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
,
627 ops
->target
.name
?: ops
->target
.raw
);
630 static struct ins_ops dec_ops
= {
632 .scnprintf
= dec__scnprintf
,
635 static int nop__scnprintf(struct ins
*ins __maybe_unused
, char *bf
, size_t size
,
636 struct ins_operands
*ops __maybe_unused
, int max_ins_name
)
638 return scnprintf(bf
, size
, "%-*s", max_ins_name
, "nop");
641 static struct ins_ops nop_ops
= {
642 .scnprintf
= nop__scnprintf
,
645 static struct ins_ops ret_ops
= {
646 .scnprintf
= ins__raw_scnprintf
,
649 bool ins__is_ret(const struct ins
*ins
)
651 return ins
->ops
== &ret_ops
;
654 bool ins__is_lock(const struct ins
*ins
)
656 return ins
->ops
== &lock_ops
;
659 static int ins__key_cmp(const void *name
, const void *insp
)
661 const struct ins
*ins
= insp
;
663 return strcmp(name
, ins
->name
);
666 static int ins__cmp(const void *a
, const void *b
)
668 const struct ins
*ia
= a
;
669 const struct ins
*ib
= b
;
671 return strcmp(ia
->name
, ib
->name
);
674 static void ins__sort(struct arch
*arch
)
676 const int nmemb
= arch
->nr_instructions
;
678 qsort(arch
->instructions
, nmemb
, sizeof(struct ins
), ins__cmp
);
681 static struct ins_ops
*__ins__find(struct arch
*arch
, const char *name
)
684 const int nmemb
= arch
->nr_instructions
;
686 if (!arch
->sorted_instructions
) {
688 arch
->sorted_instructions
= true;
691 ins
= bsearch(name
, arch
->instructions
, nmemb
, sizeof(struct ins
), ins__key_cmp
);
692 return ins
? ins
->ops
: NULL
;
695 static struct ins_ops
*ins__find(struct arch
*arch
, const char *name
)
697 struct ins_ops
*ops
= __ins__find(arch
, name
);
699 if (!ops
&& arch
->associate_instruction_ops
)
700 ops
= arch
->associate_instruction_ops(arch
, name
);
705 static int arch__key_cmp(const void *name
, const void *archp
)
707 const struct arch
*arch
= archp
;
709 return strcmp(name
, arch
->name
);
712 static int arch__cmp(const void *a
, const void *b
)
714 const struct arch
*aa
= a
;
715 const struct arch
*ab
= b
;
717 return strcmp(aa
->name
, ab
->name
);
720 static void arch__sort(void)
722 const int nmemb
= ARRAY_SIZE(architectures
);
724 qsort(architectures
, nmemb
, sizeof(struct arch
), arch__cmp
);
727 static struct arch
*arch__find(const char *name
)
729 const int nmemb
= ARRAY_SIZE(architectures
);
737 return bsearch(name
, architectures
, nmemb
, sizeof(struct arch
), arch__key_cmp
);
740 static struct annotated_source
*annotated_source__new(void)
742 struct annotated_source
*src
= zalloc(sizeof(*src
));
745 INIT_LIST_HEAD(&src
->source
);
750 static __maybe_unused
void annotated_source__delete(struct annotated_source
*src
)
754 zfree(&src
->histograms
);
755 zfree(&src
->cycles_hist
);
759 static int annotated_source__alloc_histograms(struct annotated_source
*src
,
760 size_t size
, int nr_hists
)
762 size_t sizeof_sym_hist
;
765 * Add buffer of one element for zero length symbol.
766 * When sample is taken from first instruction of
767 * zero length symbol, perf still resolves it and
768 * shows symbol name in perf report and allows to
774 /* Check for overflow when calculating sizeof_sym_hist */
775 if (size
> (SIZE_MAX
- sizeof(struct sym_hist
)) / sizeof(struct sym_hist_entry
))
778 sizeof_sym_hist
= (sizeof(struct sym_hist
) + size
* sizeof(struct sym_hist_entry
));
780 /* Check for overflow in zalloc argument */
781 if (sizeof_sym_hist
> SIZE_MAX
/ nr_hists
)
784 src
->sizeof_sym_hist
= sizeof_sym_hist
;
785 src
->nr_histograms
= nr_hists
;
786 src
->histograms
= calloc(nr_hists
, sizeof_sym_hist
) ;
787 return src
->histograms
? 0 : -1;
790 /* The cycles histogram is lazily allocated. */
791 static int symbol__alloc_hist_cycles(struct symbol
*sym
)
793 struct annotation
*notes
= symbol__annotation(sym
);
794 const size_t size
= symbol__size(sym
);
796 notes
->src
->cycles_hist
= calloc(size
, sizeof(struct cyc_hist
));
797 if (notes
->src
->cycles_hist
== NULL
)
802 void symbol__annotate_zero_histograms(struct symbol
*sym
)
804 struct annotation
*notes
= symbol__annotation(sym
);
806 pthread_mutex_lock(¬es
->lock
);
807 if (notes
->src
!= NULL
) {
808 memset(notes
->src
->histograms
, 0,
809 notes
->src
->nr_histograms
* notes
->src
->sizeof_sym_hist
);
810 if (notes
->src
->cycles_hist
)
811 memset(notes
->src
->cycles_hist
, 0,
812 symbol__size(sym
) * sizeof(struct cyc_hist
));
814 pthread_mutex_unlock(¬es
->lock
);
817 static int __symbol__account_cycles(struct cyc_hist
*ch
,
819 unsigned offset
, unsigned cycles
,
823 * For now we can only account one basic block per
824 * final jump. But multiple could be overlapping.
825 * Always account the longest one. So when
826 * a shorter one has been already seen throw it away.
828 * We separately always account the full cycles.
830 ch
[offset
].num_aggr
++;
831 ch
[offset
].cycles_aggr
+= cycles
;
833 if (cycles
> ch
[offset
].cycles_max
)
834 ch
[offset
].cycles_max
= cycles
;
836 if (ch
[offset
].cycles_min
) {
837 if (cycles
&& cycles
< ch
[offset
].cycles_min
)
838 ch
[offset
].cycles_min
= cycles
;
840 ch
[offset
].cycles_min
= cycles
;
842 if (!have_start
&& ch
[offset
].have_start
)
844 if (ch
[offset
].num
) {
845 if (have_start
&& (!ch
[offset
].have_start
||
846 ch
[offset
].start
> start
)) {
847 ch
[offset
].have_start
= 0;
848 ch
[offset
].cycles
= 0;
850 if (ch
[offset
].reset
< 0xffff)
852 } else if (have_start
&&
853 ch
[offset
].start
< start
)
857 if (ch
[offset
].num
< NUM_SPARKS
)
858 ch
[offset
].cycles_spark
[ch
[offset
].num
] = cycles
;
860 ch
[offset
].have_start
= have_start
;
861 ch
[offset
].start
= start
;
862 ch
[offset
].cycles
+= cycles
;
867 static int __symbol__inc_addr_samples(struct map_symbol
*ms
,
868 struct annotated_source
*src
, int evidx
, u64 addr
,
869 struct perf_sample
*sample
)
871 struct symbol
*sym
= ms
->sym
;
875 pr_debug3("%s: addr=%#" PRIx64
"\n", __func__
, ms
->map
->unmap_ip(ms
->map
, addr
));
877 if ((addr
< sym
->start
|| addr
>= sym
->end
) &&
878 (addr
!= sym
->end
|| sym
->start
!= sym
->end
)) {
879 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64
", addr=%#" PRIx64
", end=%#" PRIx64
"\n",
880 __func__
, __LINE__
, sym
->name
, sym
->start
, addr
, sym
->end
);
884 offset
= addr
- sym
->start
;
885 h
= annotated_source__histogram(src
, evidx
);
887 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64
", addr=%#" PRIx64
", end=%#" PRIx64
", func: %d\n",
888 __func__
, __LINE__
, sym
->name
, sym
->start
, addr
, sym
->end
, sym
->type
== STT_FUNC
);
892 h
->addr
[offset
].nr_samples
++;
893 h
->period
+= sample
->period
;
894 h
->addr
[offset
].period
+= sample
->period
;
896 pr_debug3("%#" PRIx64
" %s: period++ [addr: %#" PRIx64
", %#" PRIx64
897 ", evidx=%d] => nr_samples: %" PRIu64
", period: %" PRIu64
"\n",
898 sym
->start
, sym
->name
, addr
, addr
- sym
->start
, evidx
,
899 h
->addr
[offset
].nr_samples
, h
->addr
[offset
].period
);
903 static struct cyc_hist
*symbol__cycles_hist(struct symbol
*sym
)
905 struct annotation
*notes
= symbol__annotation(sym
);
907 if (notes
->src
== NULL
) {
908 notes
->src
= annotated_source__new();
909 if (notes
->src
== NULL
)
911 goto alloc_cycles_hist
;
914 if (!notes
->src
->cycles_hist
) {
916 symbol__alloc_hist_cycles(sym
);
919 return notes
->src
->cycles_hist
;
922 struct annotated_source
*symbol__hists(struct symbol
*sym
, int nr_hists
)
924 struct annotation
*notes
= symbol__annotation(sym
);
926 if (notes
->src
== NULL
) {
927 notes
->src
= annotated_source__new();
928 if (notes
->src
== NULL
)
930 goto alloc_histograms
;
933 if (notes
->src
->histograms
== NULL
) {
935 annotated_source__alloc_histograms(notes
->src
, symbol__size(sym
),
942 static int symbol__inc_addr_samples(struct map_symbol
*ms
,
943 struct evsel
*evsel
, u64 addr
,
944 struct perf_sample
*sample
)
946 struct symbol
*sym
= ms
->sym
;
947 struct annotated_source
*src
;
951 src
= symbol__hists(sym
, evsel
->evlist
->core
.nr_entries
);
952 return src
? __symbol__inc_addr_samples(ms
, src
, evsel
->idx
, addr
, sample
) : 0;
955 static int symbol__account_cycles(u64 addr
, u64 start
,
956 struct symbol
*sym
, unsigned cycles
)
958 struct cyc_hist
*cycles_hist
;
963 cycles_hist
= symbol__cycles_hist(sym
);
964 if (cycles_hist
== NULL
)
966 if (addr
< sym
->start
|| addr
>= sym
->end
)
970 if (start
< sym
->start
|| start
>= sym
->end
)
975 offset
= addr
- sym
->start
;
976 return __symbol__account_cycles(cycles_hist
,
977 start
? start
- sym
->start
: 0,
982 int addr_map_symbol__account_cycles(struct addr_map_symbol
*ams
,
983 struct addr_map_symbol
*start
,
993 * Only set start when IPC can be computed. We can only
994 * compute it when the basic block is completely in a single
996 * Special case the case when the jump is elsewhere, but
997 * it starts on the function start.
1000 (start
->ms
.sym
== ams
->ms
.sym
||
1002 start
->addr
== ams
->ms
.sym
->start
+ ams
->ms
.map
->start
)))
1003 saddr
= start
->al_addr
;
1005 pr_debug2("BB with bad start: addr %"PRIx64
" start %"PRIx64
" sym %"PRIx64
" saddr %"PRIx64
"\n",
1007 start
? start
->addr
: 0,
1008 ams
->ms
.sym
? ams
->ms
.sym
->start
+ ams
->ms
.map
->start
: 0,
1010 err
= symbol__account_cycles(ams
->al_addr
, saddr
, ams
->ms
.sym
, cycles
);
1012 pr_debug2("account_cycles failed %d\n", err
);
1016 static unsigned annotation__count_insn(struct annotation
*notes
, u64 start
, u64 end
)
1018 unsigned n_insn
= 0;
1021 for (offset
= start
; offset
<= end
; offset
++) {
1022 if (notes
->offsets
[offset
])
1028 static void annotation__count_and_fill(struct annotation
*notes
, u64 start
, u64 end
, struct cyc_hist
*ch
)
1031 unsigned int cover_insn
= 0;
1034 n_insn
= annotation__count_insn(notes
, start
, end
);
1035 if (n_insn
&& ch
->num
&& ch
->cycles
) {
1036 float ipc
= n_insn
/ ((double)ch
->cycles
/ (double)ch
->num
);
1038 /* Hide data when there are too many overlaps. */
1039 if (ch
->reset
>= 0x7fff)
1042 for (offset
= start
; offset
<= end
; offset
++) {
1043 struct annotation_line
*al
= notes
->offsets
[offset
];
1045 if (al
&& al
->ipc
== 0.0) {
1052 notes
->hit_cycles
+= ch
->cycles
;
1053 notes
->hit_insn
+= n_insn
* ch
->num
;
1054 notes
->cover_insn
+= cover_insn
;
1059 void annotation__compute_ipc(struct annotation
*notes
, size_t size
)
1063 if (!notes
->src
|| !notes
->src
->cycles_hist
)
1066 notes
->total_insn
= annotation__count_insn(notes
, 0, size
- 1);
1067 notes
->hit_cycles
= 0;
1068 notes
->hit_insn
= 0;
1069 notes
->cover_insn
= 0;
1071 pthread_mutex_lock(¬es
->lock
);
1072 for (offset
= size
- 1; offset
>= 0; --offset
) {
1073 struct cyc_hist
*ch
;
1075 ch
= ¬es
->src
->cycles_hist
[offset
];
1076 if (ch
&& ch
->cycles
) {
1077 struct annotation_line
*al
;
1080 annotation__count_and_fill(notes
, ch
->start
, offset
, ch
);
1081 al
= notes
->offsets
[offset
];
1082 if (al
&& ch
->num_aggr
) {
1083 al
->cycles
= ch
->cycles_aggr
/ ch
->num_aggr
;
1084 al
->cycles_max
= ch
->cycles_max
;
1085 al
->cycles_min
= ch
->cycles_min
;
1087 notes
->have_cycles
= true;
1090 pthread_mutex_unlock(¬es
->lock
);
1093 int addr_map_symbol__inc_samples(struct addr_map_symbol
*ams
, struct perf_sample
*sample
,
1094 struct evsel
*evsel
)
1096 return symbol__inc_addr_samples(&ams
->ms
, evsel
, ams
->al_addr
, sample
);
1099 int hist_entry__inc_addr_samples(struct hist_entry
*he
, struct perf_sample
*sample
,
1100 struct evsel
*evsel
, u64 ip
)
1102 return symbol__inc_addr_samples(&he
->ms
, evsel
, ip
, sample
);
1105 static void disasm_line__init_ins(struct disasm_line
*dl
, struct arch
*arch
, struct map_symbol
*ms
)
1107 dl
->ins
.ops
= ins__find(arch
, dl
->ins
.name
);
1112 if (dl
->ins
.ops
->parse
&& dl
->ins
.ops
->parse(arch
, &dl
->ops
, ms
) < 0)
1116 static int disasm_line__parse(char *line
, const char **namep
, char **rawp
)
1118 char tmp
, *name
= skip_spaces(line
);
1120 if (name
[0] == '\0')
1125 while ((*rawp
)[0] != '\0' && !isspace((*rawp
)[0]))
1130 *namep
= strdup(name
);
1136 *rawp
= strim(*rawp
);
1144 struct annotate_args
{
1146 struct map_symbol ms
;
1147 struct evsel
*evsel
;
1148 struct annotation_options
*options
;
1154 static void annotation_line__init(struct annotation_line
*al
,
1155 struct annotate_args
*args
,
1158 al
->offset
= args
->offset
;
1159 al
->line
= strdup(args
->line
);
1160 al
->line_nr
= args
->line_nr
;
1164 static void annotation_line__exit(struct annotation_line
*al
)
1166 free_srcline(al
->path
);
1170 static size_t disasm_line_size(int nr
)
1172 struct annotation_line
*al
;
1174 return (sizeof(struct disasm_line
) + (sizeof(al
->data
[0]) * nr
));
1178 * Allocating the disasm annotation line data with
1179 * following structure:
1181 * -------------------------------------------
1182 * struct disasm_line | struct annotation_line
1183 * -------------------------------------------
1185 * We have 'struct annotation_line' member as last member
1186 * of 'struct disasm_line' to have an easy access.
1188 static struct disasm_line
*disasm_line__new(struct annotate_args
*args
)
1190 struct disasm_line
*dl
= NULL
;
1193 if (evsel__is_group_event(args
->evsel
))
1194 nr
= args
->evsel
->core
.nr_members
;
1196 dl
= zalloc(disasm_line_size(nr
));
1200 annotation_line__init(&dl
->al
, args
, nr
);
1201 if (dl
->al
.line
== NULL
)
1204 if (args
->offset
!= -1) {
1205 if (disasm_line__parse(dl
->al
.line
, &dl
->ins
.name
, &dl
->ops
.raw
) < 0)
1208 disasm_line__init_ins(dl
, args
->arch
, &args
->ms
);
1214 zfree(&dl
->al
.line
);
1220 void disasm_line__free(struct disasm_line
*dl
)
1222 if (dl
->ins
.ops
&& dl
->ins
.ops
->free
)
1223 dl
->ins
.ops
->free(&dl
->ops
);
1225 ins__delete(&dl
->ops
);
1226 zfree(&dl
->ins
.name
);
1227 annotation_line__exit(&dl
->al
);
1231 int disasm_line__scnprintf(struct disasm_line
*dl
, char *bf
, size_t size
, bool raw
, int max_ins_name
)
1233 if (raw
|| !dl
->ins
.ops
)
1234 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, dl
->ins
.name
, dl
->ops
.raw
);
1236 return ins__scnprintf(&dl
->ins
, bf
, size
, &dl
->ops
, max_ins_name
);
1239 static void annotation_line__add(struct annotation_line
*al
, struct list_head
*head
)
1241 list_add_tail(&al
->node
, head
);
1244 struct annotation_line
*
1245 annotation_line__next(struct annotation_line
*pos
, struct list_head
*head
)
1247 list_for_each_entry_continue(pos
, head
, node
)
1248 if (pos
->offset
>= 0)
1254 static const char *annotate__address_color(struct block_range
*br
)
1256 double cov
= block_range__coverage(br
);
1259 /* mark red for >75% coverage */
1261 return PERF_COLOR_RED
;
1263 /* mark dull for <1% coverage */
1265 return PERF_COLOR_NORMAL
;
1268 return PERF_COLOR_MAGENTA
;
1271 static const char *annotate__asm_color(struct block_range
*br
)
1273 double cov
= block_range__coverage(br
);
1276 /* mark dull for <1% coverage */
1278 return PERF_COLOR_NORMAL
;
1281 return PERF_COLOR_BLUE
;
1284 static void annotate__branch_printf(struct block_range
*br
, u64 addr
)
1286 bool emit_comment
= true;
1292 if (br
->is_target
&& br
->start
== addr
) {
1293 struct block_range
*branch
= br
;
1297 * Find matching branch to our target.
1299 while (!branch
->is_branch
)
1300 branch
= block_range__next(branch
);
1302 p
= 100 *(double)br
->entry
/ branch
->coverage
;
1306 emit_comment
= false;
1311 * The percentage of coverage joined at this target in relation
1312 * to the next branch.
1314 printf(" +%.2f%%", p
);
1318 if (br
->is_branch
&& br
->end
== addr
) {
1319 double p
= 100*(double)br
->taken
/ br
->coverage
;
1323 emit_comment
= false;
1328 * The percentage of coverage leaving at this branch, and
1329 * its prediction ratio.
1331 printf(" -%.2f%% (p:%.2f%%)", p
, 100*(double)br
->pred
/ br
->taken
);
1336 static int disasm_line__print(struct disasm_line
*dl
, u64 start
, int addr_fmt_width
)
1338 s64 offset
= dl
->al
.offset
;
1339 const u64 addr
= start
+ offset
;
1340 struct block_range
*br
;
1342 br
= block_range__find(addr
);
1343 color_fprintf(stdout
, annotate__address_color(br
), " %*" PRIx64
":", addr_fmt_width
, addr
);
1344 color_fprintf(stdout
, annotate__asm_color(br
), "%s", dl
->al
.line
);
1345 annotate__branch_printf(br
, addr
);
1350 annotation_line__print(struct annotation_line
*al
, struct symbol
*sym
, u64 start
,
1351 struct evsel
*evsel
, u64 len
, int min_pcnt
, int printed
,
1352 int max_lines
, struct annotation_line
*queue
, int addr_fmt_width
,
1355 struct disasm_line
*dl
= container_of(al
, struct disasm_line
, al
);
1356 static const char *prev_line
;
1357 static const char *prev_color
;
1359 if (al
->offset
!= -1) {
1360 double max_percent
= 0.0;
1361 int i
, nr_percent
= 1;
1363 struct annotation
*notes
= symbol__annotation(sym
);
1365 for (i
= 0; i
< al
->data_nr
; i
++) {
1368 percent
= annotation_data__percent(&al
->data
[i
],
1371 if (percent
> max_percent
)
1372 max_percent
= percent
;
1375 if (al
->data_nr
> nr_percent
)
1376 nr_percent
= al
->data_nr
;
1378 if (max_percent
< min_pcnt
)
1381 if (max_lines
&& printed
>= max_lines
)
1384 if (queue
!= NULL
) {
1385 list_for_each_entry_from(queue
, ¬es
->src
->source
, node
) {
1388 annotation_line__print(queue
, sym
, start
, evsel
, len
,
1389 0, 0, 1, NULL
, addr_fmt_width
,
1394 color
= get_percent_color(max_percent
);
1397 * Also color the filename and line if needed, with
1398 * the same color than the percentage. Don't print it
1399 * twice for close colored addr with the same filename:line
1402 if (!prev_line
|| strcmp(prev_line
, al
->path
)
1403 || color
!= prev_color
) {
1404 color_fprintf(stdout
, color
, " %s", al
->path
);
1405 prev_line
= al
->path
;
1410 for (i
= 0; i
< nr_percent
; i
++) {
1411 struct annotation_data
*data
= &al
->data
[i
];
1414 percent
= annotation_data__percent(data
, percent_type
);
1415 color
= get_percent_color(percent
);
1417 if (symbol_conf
.show_total_period
)
1418 color_fprintf(stdout
, color
, " %11" PRIu64
,
1420 else if (symbol_conf
.show_nr_samples
)
1421 color_fprintf(stdout
, color
, " %7" PRIu64
,
1422 data
->he
.nr_samples
);
1424 color_fprintf(stdout
, color
, " %7.2f", percent
);
1429 disasm_line__print(dl
, start
, addr_fmt_width
);
1431 } else if (max_lines
&& printed
>= max_lines
)
1434 int width
= symbol_conf
.show_total_period
? 12 : 8;
1439 if (evsel__is_group_event(evsel
))
1440 width
*= evsel
->core
.nr_members
;
1443 printf(" %*s:\n", width
, " ");
1445 printf(" %*s: %*s %s\n", width
, " ", addr_fmt_width
, " ", al
->line
);
1452 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1453 * which looks like following
1455 * 0000000000415500 <_init>:
1456 * 415500: sub $0x8,%rsp
1457 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1458 * 41550b: test %rax,%rax
1459 * 41550e: je 415515 <_init+0x15>
1460 * 415510: callq 416e70 <__gmon_start__@plt>
1461 * 415515: add $0x8,%rsp
1464 * it will be parsed and saved into struct disasm_line as
1465 * <offset> <name> <ops.raw>
1467 * The offset will be a relative offset from the start of the symbol and -1
1468 * means that it's not a disassembly line so should be treated differently.
1469 * The ops.raw part will be parsed further according to type of the instruction.
1471 static int symbol__parse_objdump_line(struct symbol
*sym
,
1472 struct annotate_args
*args
,
1473 char *parsed_line
, int *line_nr
)
1475 struct map
*map
= args
->ms
.map
;
1476 struct annotation
*notes
= symbol__annotation(sym
);
1477 struct disasm_line
*dl
;
1479 s64 line_ip
, offset
= -1;
1480 regmatch_t match
[2];
1482 /* /filename:linenr ? Save line number and ignore. */
1483 if (regexec(&file_lineno
, parsed_line
, 2, match
, 0) == 0) {
1484 *line_nr
= atoi(parsed_line
+ match
[1].rm_so
);
1488 /* Process hex address followed by ':'. */
1489 line_ip
= strtoull(parsed_line
, &tmp
, 16);
1490 if (parsed_line
!= tmp
&& tmp
[0] == ':' && tmp
[1] != '\0') {
1491 u64 start
= map__rip_2objdump(map
, sym
->start
),
1492 end
= map__rip_2objdump(map
, sym
->end
);
1494 offset
= line_ip
- start
;
1495 if ((u64
)line_ip
< start
|| (u64
)line_ip
>= end
)
1498 parsed_line
= tmp
+ 1;
1501 args
->offset
= offset
;
1502 args
->line
= parsed_line
;
1503 args
->line_nr
= *line_nr
;
1506 dl
= disasm_line__new(args
);
1512 if (!disasm_line__has_local_offset(dl
)) {
1513 dl
->ops
.target
.offset
= dl
->ops
.target
.addr
-
1514 map__rip_2objdump(map
, sym
->start
);
1515 dl
->ops
.target
.offset_avail
= true;
1518 /* kcore has no symbols, so add the call target symbol */
1519 if (dl
->ins
.ops
&& ins__is_call(&dl
->ins
) && !dl
->ops
.target
.sym
) {
1520 struct addr_map_symbol target
= {
1521 .addr
= dl
->ops
.target
.addr
,
1522 .ms
= { .map
= map
, },
1525 if (!maps__find_ams(args
->ms
.maps
, &target
) &&
1526 target
.ms
.sym
->start
== target
.al_addr
)
1527 dl
->ops
.target
.sym
= target
.ms
.sym
;
1530 annotation_line__add(&dl
->al
, ¬es
->src
->source
);
1535 static __attribute__((constructor
)) void symbol__init_regexpr(void)
1537 regcomp(&file_lineno
, "^/[^:]+:([0-9]+)", REG_EXTENDED
);
1540 static void delete_last_nop(struct symbol
*sym
)
1542 struct annotation
*notes
= symbol__annotation(sym
);
1543 struct list_head
*list
= ¬es
->src
->source
;
1544 struct disasm_line
*dl
;
1546 while (!list_empty(list
)) {
1547 dl
= list_entry(list
->prev
, struct disasm_line
, al
.node
);
1550 if (dl
->ins
.ops
!= &nop_ops
)
1553 if (!strstr(dl
->al
.line
, " nop ") &&
1554 !strstr(dl
->al
.line
, " nopl ") &&
1555 !strstr(dl
->al
.line
, " nopw "))
1559 list_del_init(&dl
->al
.node
);
1560 disasm_line__free(dl
);
1564 int symbol__strerror_disassemble(struct map_symbol
*ms
, int errnum
, char *buf
, size_t buflen
)
1566 struct dso
*dso
= ms
->map
->dso
;
1568 BUG_ON(buflen
== 0);
1571 str_error_r(errnum
, buf
, buflen
);
1576 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX
: {
1577 char bf
[SBUILD_ID_SIZE
+ 15] = " with build id ";
1578 char *build_id_msg
= NULL
;
1580 if (dso
->has_build_id
) {
1581 build_id__sprintf(dso
->build_id
,
1582 sizeof(dso
->build_id
), bf
+ 15);
1585 scnprintf(buf
, buflen
,
1586 "No vmlinux file%s\nwas found in the path.\n\n"
1587 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1589 " perf buildid-cache -vu vmlinux\n\n"
1591 " --vmlinux vmlinux\n", build_id_msg
?: "");
1594 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF
:
1595 scnprintf(buf
, buflen
, "Please link with binutils's libopcode to enable BPF annotation");
1597 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP
:
1598 scnprintf(buf
, buflen
, "Problems with arch specific instruction name regular expressions.");
1600 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING
:
1601 scnprintf(buf
, buflen
, "Problems while parsing the CPUID in the arch specific initialization.");
1603 case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE
:
1604 scnprintf(buf
, buflen
, "Invalid BPF file: %s.", dso
->long_name
);
1606 case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF
:
1607 scnprintf(buf
, buflen
, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1611 scnprintf(buf
, buflen
, "Internal error: Invalid %d error code\n", errnum
);
1618 static int dso__disassemble_filename(struct dso
*dso
, char *filename
, size_t filename_size
)
1620 char linkname
[PATH_MAX
];
1621 char *build_id_filename
;
1622 char *build_id_path
= NULL
;
1626 if (dso
->symtab_type
== DSO_BINARY_TYPE__KALLSYMS
&&
1627 !dso__is_kcore(dso
))
1628 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX
;
1630 build_id_filename
= dso__build_id_filename(dso
, NULL
, 0, false);
1631 if (build_id_filename
) {
1632 __symbol__join_symfs(filename
, filename_size
, build_id_filename
);
1633 free(build_id_filename
);
1635 if (dso
->has_build_id
)
1640 build_id_path
= strdup(filename
);
1645 * old style build-id cache has name of XX/XXXXXXX.. while
1646 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1647 * extract the build-id part of dirname in the new style only.
1649 pos
= strrchr(build_id_path
, '/');
1650 if (pos
&& strlen(pos
) < SBUILD_ID_SIZE
- 2)
1651 dirname(build_id_path
);
1653 if (dso__is_kcore(dso
))
1656 len
= readlink(build_id_path
, linkname
, sizeof(linkname
) - 1);
1660 linkname
[len
] = '\0';
1661 if (strstr(linkname
, DSO__NAME_KALLSYMS
) ||
1662 access(filename
, R_OK
)) {
1665 * If we don't have build-ids or the build-id file isn't in the
1666 * cache, or is just a kallsyms file, well, lets hope that this
1667 * DSO is the same as when 'perf record' ran.
1669 __symbol__join_symfs(filename
, filename_size
, dso
->long_name
);
1672 free(build_id_path
);
1676 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1677 #define PACKAGE "perf"
1679 #include <dis-asm.h>
1681 static int symbol__disassemble_bpf(struct symbol
*sym
,
1682 struct annotate_args
*args
)
1684 struct annotation
*notes
= symbol__annotation(sym
);
1685 struct annotation_options
*opts
= args
->options
;
1686 struct bpf_prog_info_linear
*info_linear
;
1687 struct bpf_prog_linfo
*prog_linfo
= NULL
;
1688 struct bpf_prog_info_node
*info_node
;
1689 int len
= sym
->end
- sym
->start
;
1690 disassembler_ftype disassemble
;
1691 struct map
*map
= args
->ms
.map
;
1692 struct disassemble_info info
;
1693 struct dso
*dso
= map
->dso
;
1694 int pc
= 0, count
, sub_id
;
1695 struct btf
*btf
= NULL
;
1696 char tpath
[PATH_MAX
];
1704 if (dso
->binary_type
!= DSO_BINARY_TYPE__BPF_PROG_INFO
)
1705 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE
;
1707 pr_debug("%s: handling sym %s addr %" PRIx64
" len %" PRIx64
"\n", __func__
,
1708 sym
->name
, sym
->start
, sym
->end
- sym
->start
);
1710 memset(tpath
, 0, sizeof(tpath
));
1711 perf_exe(tpath
, sizeof(tpath
));
1713 bfdf
= bfd_openr(tpath
, NULL
);
1715 assert(bfd_check_format(bfdf
, bfd_object
));
1717 s
= open_memstream(&buf
, &buf_size
);
1722 init_disassemble_info(&info
, s
,
1723 (fprintf_ftype
) fprintf
);
1725 info
.arch
= bfd_get_arch(bfdf
);
1726 info
.mach
= bfd_get_mach(bfdf
);
1728 info_node
= perf_env__find_bpf_prog_info(dso
->bpf_prog
.env
,
1731 ret
= SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF
;
1734 info_linear
= info_node
->info_linear
;
1735 sub_id
= dso
->bpf_prog
.sub_id
;
1737 info
.buffer
= (void *)(uintptr_t)(info_linear
->info
.jited_prog_insns
);
1738 info
.buffer_length
= info_linear
->info
.jited_prog_len
;
1740 if (info_linear
->info
.nr_line_info
)
1741 prog_linfo
= bpf_prog_linfo__new(&info_linear
->info
);
1743 if (info_linear
->info
.btf_id
) {
1744 struct btf_node
*node
;
1746 node
= perf_env__find_btf(dso
->bpf_prog
.env
,
1747 info_linear
->info
.btf_id
);
1749 btf
= btf__new((__u8
*)(node
->data
),
1753 disassemble_init_for_target(&info
);
1755 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1756 disassemble
= disassembler(info
.arch
,
1757 bfd_big_endian(bfdf
),
1761 disassemble
= disassembler(bfdf
);
1763 assert(disassemble
);
1767 const struct bpf_line_info
*linfo
= NULL
;
1768 struct disasm_line
*dl
;
1769 size_t prev_buf_size
;
1770 const char *srcline
;
1773 addr
= pc
+ ((u64
*)(uintptr_t)(info_linear
->info
.jited_ksyms
))[sub_id
];
1774 count
= disassemble(pc
, &info
);
1777 linfo
= bpf_prog_linfo__lfind_addr_func(prog_linfo
,
1782 srcline
= btf__name_by_offset(btf
, linfo
->line_off
);
1788 prev_buf_size
= buf_size
;
1791 if (!opts
->hide_src_code
&& srcline
) {
1793 args
->line
= strdup(srcline
);
1796 dl
= disasm_line__new(args
);
1798 annotation_line__add(&dl
->al
,
1799 ¬es
->src
->source
);
1804 args
->line
= buf
+ prev_buf_size
;
1807 dl
= disasm_line__new(args
);
1809 annotation_line__add(&dl
->al
, ¬es
->src
->source
);
1812 } while (count
> 0 && pc
< len
);
1822 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1823 static int symbol__disassemble_bpf(struct symbol
*sym __maybe_unused
,
1824 struct annotate_args
*args __maybe_unused
)
1826 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF
;
1828 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1831 symbol__disassemble_bpf_image(struct symbol
*sym
,
1832 struct annotate_args
*args
)
1834 struct annotation
*notes
= symbol__annotation(sym
);
1835 struct disasm_line
*dl
;
1838 args
->line
= strdup("to be implemented");
1840 dl
= disasm_line__new(args
);
1842 annotation_line__add(&dl
->al
, ¬es
->src
->source
);
1849 * Possibly create a new version of line with tabs expanded. Returns the
1850 * existing or new line, storage is updated if a new line is allocated. If
1851 * allocation fails then NULL is returned.
1853 static char *expand_tabs(char *line
, char **storage
, size_t *storage_len
)
1855 size_t i
, src
, dst
, len
, new_storage_len
, num_tabs
;
1857 size_t line_len
= strlen(line
);
1859 for (num_tabs
= 0, i
= 0; i
< line_len
; i
++)
1860 if (line
[i
] == '\t')
1867 * Space for the line and '\0', less the leading and trailing
1868 * spaces. Each tab may introduce 7 additional spaces.
1870 new_storage_len
= line_len
+ 1 + (num_tabs
* 7);
1872 new_line
= malloc(new_storage_len
);
1873 if (new_line
== NULL
) {
1874 pr_err("Failure allocating memory for tab expansion\n");
1879 * Copy regions starting at src and expand tabs. If there are two
1880 * adjacent tabs then 'src == i', the memcpy is of size 0 and the spaces
1883 for (i
= 0, src
= 0, dst
= 0; i
< line_len
&& num_tabs
; i
++) {
1884 if (line
[i
] == '\t') {
1886 memcpy(&new_line
[dst
], &line
[src
], len
);
1888 new_line
[dst
++] = ' ';
1889 while (dst
% 8 != 0)
1890 new_line
[dst
++] = ' ';
1896 /* Expand the last region. */
1897 len
= line_len
- src
;
1898 memcpy(&new_line
[dst
], &line
[src
], len
);
1900 new_line
[dst
] = '\0';
1903 *storage
= new_line
;
1904 *storage_len
= new_storage_len
;
1909 static int symbol__disassemble(struct symbol
*sym
, struct annotate_args
*args
)
1911 struct annotation_options
*opts
= args
->options
;
1912 struct map
*map
= args
->ms
.map
;
1913 struct dso
*dso
= map
->dso
;
1916 char symfs_filename
[PATH_MAX
];
1917 struct kcore_extract kce
;
1918 bool delete_extract
= false;
1919 bool decomp
= false;
1924 const char *objdump_argv
[] = {
1927 NULL
, /* Will be the objdump command to run. */
1929 NULL
, /* Will be the symfs path. */
1932 struct child_process objdump_process
;
1933 int err
= dso__disassemble_filename(dso
, symfs_filename
, sizeof(symfs_filename
));
1938 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64
", end=%#" PRIx64
"\n", __func__
,
1939 symfs_filename
, sym
->name
, map
->unmap_ip(map
, sym
->start
),
1940 map
->unmap_ip(map
, sym
->end
));
1942 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1943 dso
, dso
->long_name
, sym
, sym
->name
);
1945 if (dso
->binary_type
== DSO_BINARY_TYPE__BPF_PROG_INFO
) {
1946 return symbol__disassemble_bpf(sym
, args
);
1947 } else if (dso
->binary_type
== DSO_BINARY_TYPE__BPF_IMAGE
) {
1948 return symbol__disassemble_bpf_image(sym
, args
);
1949 } else if (dso__is_kcore(dso
)) {
1950 kce
.kcore_filename
= symfs_filename
;
1951 kce
.addr
= map__rip_2objdump(map
, sym
->start
);
1952 kce
.offs
= sym
->start
;
1953 kce
.len
= sym
->end
- sym
->start
;
1954 if (!kcore_extract__create(&kce
)) {
1955 delete_extract
= true;
1956 strlcpy(symfs_filename
, kce
.extract_filename
,
1957 sizeof(symfs_filename
));
1959 } else if (dso__needs_decompress(dso
)) {
1960 char tmp
[KMOD_DECOMP_LEN
];
1962 if (dso__decompress_kmodule_path(dso
, symfs_filename
,
1963 tmp
, sizeof(tmp
)) < 0)
1967 strcpy(symfs_filename
, tmp
);
1970 err
= asprintf(&command
,
1971 "%s %s%s --start-address=0x%016" PRIx64
1972 " --stop-address=0x%016" PRIx64
1973 " -l -d %s %s %s %c%s%c %s%s -C \"$1\"",
1974 opts
->objdump_path
?: "objdump",
1975 opts
->disassembler_style
? "-M " : "",
1976 opts
->disassembler_style
?: "",
1977 map__rip_2objdump(map
, sym
->start
),
1978 map__rip_2objdump(map
, sym
->end
),
1979 opts
->show_asm_raw
? "" : "--no-show-raw-insn",
1980 opts
->annotate_src
? "-S" : "",
1981 opts
->prefix
? "--prefix " : "",
1982 opts
->prefix
? '"' : ' ',
1984 opts
->prefix
? '"' : ' ',
1985 opts
->prefix_strip
? "--prefix-strip=" : "",
1986 opts
->prefix_strip
?: "");
1989 pr_err("Failure allocating memory for the command to run\n");
1990 goto out_remove_tmp
;
1993 pr_debug("Executing: %s\n", command
);
1995 objdump_argv
[2] = command
;
1996 objdump_argv
[4] = symfs_filename
;
1998 /* Create a pipe to read from for stdout */
1999 memset(&objdump_process
, 0, sizeof(objdump_process
));
2000 objdump_process
.argv
= objdump_argv
;
2001 objdump_process
.out
= -1;
2002 if (start_command(&objdump_process
)) {
2003 pr_err("Failure starting to run %s\n", command
);
2005 goto out_free_command
;
2008 file
= fdopen(objdump_process
.out
, "r");
2010 pr_err("Failure creating FILE stream for %s\n", command
);
2012 * If we were using debug info should retry with
2016 goto out_close_stdout
;
2019 /* Storage for getline. */
2024 while (!feof(file
)) {
2026 char *expanded_line
;
2028 if (getline(&line
, &line_len
, file
) < 0 || !line
)
2031 /* Skip lines containing "filename:" */
2032 match
= strstr(line
, symfs_filename
);
2033 if (match
&& match
[strlen(symfs_filename
)] == ':')
2036 expanded_line
= strim(line
);
2037 expanded_line
= expand_tabs(expanded_line
, &line
, &line_len
);
2042 * The source code line number (lineno) needs to be kept in
2043 * across calls to symbol__parse_objdump_line(), so that it
2044 * can associate it with the instructions till the next one.
2045 * See disasm_line__new() and struct disasm_line::line_nr.
2047 if (symbol__parse_objdump_line(sym
, args
, expanded_line
,
2054 err
= finish_command(&objdump_process
);
2056 pr_err("Error running %s\n", command
);
2060 pr_err("No output from %s\n", command
);
2064 * kallsyms does not have symbol sizes so there may a nop at the end.
2067 if (dso__is_kcore(dso
))
2068 delete_last_nop(sym
);
2073 close(objdump_process
.out
);
2080 unlink(symfs_filename
);
2083 kcore_extract__delete(&kce
);
2088 static void calc_percent(struct sym_hist
*sym_hist
,
2089 struct hists
*hists
,
2090 struct annotation_data
*data
,
2091 s64 offset
, s64 end
)
2093 unsigned int hits
= 0;
2096 while (offset
< end
) {
2097 hits
+= sym_hist
->addr
[offset
].nr_samples
;
2098 period
+= sym_hist
->addr
[offset
].period
;
2102 if (sym_hist
->nr_samples
) {
2103 data
->he
.period
= period
;
2104 data
->he
.nr_samples
= hits
;
2105 data
->percent
[PERCENT_HITS_LOCAL
] = 100.0 * hits
/ sym_hist
->nr_samples
;
2108 if (hists
->stats
.nr_non_filtered_samples
)
2109 data
->percent
[PERCENT_HITS_GLOBAL
] = 100.0 * hits
/ hists
->stats
.nr_non_filtered_samples
;
2111 if (sym_hist
->period
)
2112 data
->percent
[PERCENT_PERIOD_LOCAL
] = 100.0 * period
/ sym_hist
->period
;
2114 if (hists
->stats
.total_period
)
2115 data
->percent
[PERCENT_PERIOD_GLOBAL
] = 100.0 * period
/ hists
->stats
.total_period
;
2118 static void annotation__calc_percent(struct annotation
*notes
,
2119 struct evsel
*leader
, s64 len
)
2121 struct annotation_line
*al
, *next
;
2122 struct evsel
*evsel
;
2124 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2128 if (al
->offset
== -1)
2131 next
= annotation_line__next(al
, ¬es
->src
->source
);
2132 end
= next
? next
->offset
: len
;
2134 for_each_group_evsel(evsel
, leader
) {
2135 struct hists
*hists
= evsel__hists(evsel
);
2136 struct annotation_data
*data
;
2137 struct sym_hist
*sym_hist
;
2139 BUG_ON(i
>= al
->data_nr
);
2141 sym_hist
= annotation__histogram(notes
, evsel
->idx
);
2142 data
= &al
->data
[i
++];
2144 calc_percent(sym_hist
, hists
, data
, al
->offset
, end
);
2149 void symbol__calc_percent(struct symbol
*sym
, struct evsel
*evsel
)
2151 struct annotation
*notes
= symbol__annotation(sym
);
2153 annotation__calc_percent(notes
, evsel
, symbol__size(sym
));
2156 int symbol__annotate(struct map_symbol
*ms
, struct evsel
*evsel
,
2157 struct annotation_options
*options
, struct arch
**parch
)
2159 struct symbol
*sym
= ms
->sym
;
2160 struct annotation
*notes
= symbol__annotation(sym
);
2161 struct annotate_args args
= {
2165 struct perf_env
*env
= evsel__env(evsel
);
2166 const char *arch_name
= perf_env__arch(env
);
2173 args
.arch
= arch
= arch__find(arch_name
);
2181 err
= arch
->init(arch
, env
? env
->cpuid
: NULL
);
2183 pr_err("%s: failed to initialize %s arch priv area\n", __func__
, arch
->name
);
2189 notes
->start
= map__rip_2objdump(ms
->map
, sym
->start
);
2191 return symbol__disassemble(sym
, &args
);
2194 static void insert_source_line(struct rb_root
*root
, struct annotation_line
*al
,
2195 struct annotation_options
*opts
)
2197 struct annotation_line
*iter
;
2198 struct rb_node
**p
= &root
->rb_node
;
2199 struct rb_node
*parent
= NULL
;
2202 while (*p
!= NULL
) {
2204 iter
= rb_entry(parent
, struct annotation_line
, rb_node
);
2206 ret
= strcmp(iter
->path
, al
->path
);
2208 for (i
= 0; i
< al
->data_nr
; i
++) {
2209 iter
->data
[i
].percent_sum
+= annotation_data__percent(&al
->data
[i
],
2210 opts
->percent_type
);
2218 p
= &(*p
)->rb_right
;
2221 for (i
= 0; i
< al
->data_nr
; i
++) {
2222 al
->data
[i
].percent_sum
= annotation_data__percent(&al
->data
[i
],
2223 opts
->percent_type
);
2226 rb_link_node(&al
->rb_node
, parent
, p
);
2227 rb_insert_color(&al
->rb_node
, root
);
2230 static int cmp_source_line(struct annotation_line
*a
, struct annotation_line
*b
)
2234 for (i
= 0; i
< a
->data_nr
; i
++) {
2235 if (a
->data
[i
].percent_sum
== b
->data
[i
].percent_sum
)
2237 return a
->data
[i
].percent_sum
> b
->data
[i
].percent_sum
;
2243 static void __resort_source_line(struct rb_root
*root
, struct annotation_line
*al
)
2245 struct annotation_line
*iter
;
2246 struct rb_node
**p
= &root
->rb_node
;
2247 struct rb_node
*parent
= NULL
;
2249 while (*p
!= NULL
) {
2251 iter
= rb_entry(parent
, struct annotation_line
, rb_node
);
2253 if (cmp_source_line(al
, iter
))
2256 p
= &(*p
)->rb_right
;
2259 rb_link_node(&al
->rb_node
, parent
, p
);
2260 rb_insert_color(&al
->rb_node
, root
);
2263 static void resort_source_line(struct rb_root
*dest_root
, struct rb_root
*src_root
)
2265 struct annotation_line
*al
;
2266 struct rb_node
*node
;
2268 node
= rb_first(src_root
);
2270 struct rb_node
*next
;
2272 al
= rb_entry(node
, struct annotation_line
, rb_node
);
2273 next
= rb_next(node
);
2274 rb_erase(node
, src_root
);
2276 __resort_source_line(dest_root
, al
);
2281 static void print_summary(struct rb_root
*root
, const char *filename
)
2283 struct annotation_line
*al
;
2284 struct rb_node
*node
;
2286 printf("\nSorted summary for file %s\n", filename
);
2287 printf("----------------------------------------------\n\n");
2289 if (RB_EMPTY_ROOT(root
)) {
2290 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN
);
2294 node
= rb_first(root
);
2296 double percent
, percent_max
= 0.0;
2301 al
= rb_entry(node
, struct annotation_line
, rb_node
);
2302 for (i
= 0; i
< al
->data_nr
; i
++) {
2303 percent
= al
->data
[i
].percent_sum
;
2304 color
= get_percent_color(percent
);
2305 color_fprintf(stdout
, color
, " %7.2f", percent
);
2307 if (percent
> percent_max
)
2308 percent_max
= percent
;
2312 color
= get_percent_color(percent_max
);
2313 color_fprintf(stdout
, color
, " %s\n", path
);
2315 node
= rb_next(node
);
2319 static void symbol__annotate_hits(struct symbol
*sym
, struct evsel
*evsel
)
2321 struct annotation
*notes
= symbol__annotation(sym
);
2322 struct sym_hist
*h
= annotation__histogram(notes
, evsel
->idx
);
2323 u64 len
= symbol__size(sym
), offset
;
2325 for (offset
= 0; offset
< len
; ++offset
)
2326 if (h
->addr
[offset
].nr_samples
!= 0)
2327 printf("%*" PRIx64
": %" PRIu64
"\n", BITS_PER_LONG
/ 2,
2328 sym
->start
+ offset
, h
->addr
[offset
].nr_samples
);
2329 printf("%*s: %" PRIu64
"\n", BITS_PER_LONG
/ 2, "h->nr_samples", h
->nr_samples
);
2332 static int annotated_source__addr_fmt_width(struct list_head
*lines
, u64 start
)
2335 struct annotation_line
*line
;
2337 list_for_each_entry_reverse(line
, lines
, node
) {
2338 if (line
->offset
!= -1)
2339 return scnprintf(bf
, sizeof(bf
), "%" PRIx64
, start
+ line
->offset
);
2345 int symbol__annotate_printf(struct map_symbol
*ms
, struct evsel
*evsel
,
2346 struct annotation_options
*opts
)
2348 struct map
*map
= ms
->map
;
2349 struct symbol
*sym
= ms
->sym
;
2350 struct dso
*dso
= map
->dso
;
2352 const char *d_filename
;
2353 const char *evsel_name
= evsel__name(evsel
);
2354 struct annotation
*notes
= symbol__annotation(sym
);
2355 struct sym_hist
*h
= annotation__histogram(notes
, evsel
->idx
);
2356 struct annotation_line
*pos
, *queue
= NULL
;
2357 u64 start
= map__rip_2objdump(map
, sym
->start
);
2358 int printed
= 2, queue_len
= 0, addr_fmt_width
;
2360 bool context
= opts
->context
;
2362 int width
= symbol_conf
.show_total_period
? 12 : 8;
2363 int graph_dotted_len
;
2366 filename
= strdup(dso
->long_name
);
2370 if (opts
->full_path
)
2371 d_filename
= filename
;
2373 d_filename
= basename(filename
);
2375 len
= symbol__size(sym
);
2377 if (evsel__is_group_event(evsel
)) {
2378 width
*= evsel
->core
.nr_members
;
2379 evsel__group_desc(evsel
, buf
, sizeof(buf
));
2383 graph_dotted_len
= printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64
" samples, "
2385 width
, width
, symbol_conf
.show_total_period
? "Period" :
2386 symbol_conf
.show_nr_samples
? "Samples" : "Percent",
2387 d_filename
, evsel_name
, h
->nr_samples
,
2388 percent_type_str(opts
->percent_type
));
2390 printf("%-*.*s----\n",
2391 graph_dotted_len
, graph_dotted_len
, graph_dotted_line
);
2394 symbol__annotate_hits(sym
, evsel
);
2396 addr_fmt_width
= annotated_source__addr_fmt_width(¬es
->src
->source
, start
);
2398 list_for_each_entry(pos
, ¬es
->src
->source
, node
) {
2401 if (context
&& queue
== NULL
) {
2406 err
= annotation_line__print(pos
, sym
, start
, evsel
, len
,
2407 opts
->min_pcnt
, printed
, opts
->max_lines
,
2408 queue
, addr_fmt_width
, opts
->percent_type
);
2414 printed
+= queue_len
;
2420 /* filtered by max_lines */
2426 * Filtered by min_pcnt or non IP lines when
2431 if (queue_len
== context
)
2432 queue
= list_entry(queue
->node
.next
, typeof(*queue
), node
);
2444 static void FILE__set_percent_color(void *fp __maybe_unused
,
2445 double percent __maybe_unused
,
2446 bool current __maybe_unused
)
2450 static int FILE__set_jumps_percent_color(void *fp __maybe_unused
,
2451 int nr __maybe_unused
, bool current __maybe_unused
)
2456 static int FILE__set_color(void *fp __maybe_unused
, int color __maybe_unused
)
2461 static void FILE__printf(void *fp
, const char *fmt
, ...)
2465 va_start(args
, fmt
);
2466 vfprintf(fp
, fmt
, args
);
2470 static void FILE__write_graph(void *fp
, int graph
)
2475 case DARROW_CHAR
: s
= "↓"; break;
2476 case UARROW_CHAR
: s
= "↑"; break;
2477 case LARROW_CHAR
: s
= "←"; break;
2478 case RARROW_CHAR
: s
= "→"; break;
2479 default: s
= "?"; break;
2485 static int symbol__annotate_fprintf2(struct symbol
*sym
, FILE *fp
,
2486 struct annotation_options
*opts
)
2488 struct annotation
*notes
= symbol__annotation(sym
);
2489 struct annotation_write_ops wops
= {
2492 .set_color
= FILE__set_color
,
2493 .set_percent_color
= FILE__set_percent_color
,
2494 .set_jumps_percent_color
= FILE__set_jumps_percent_color
,
2495 .printf
= FILE__printf
,
2496 .write_graph
= FILE__write_graph
,
2498 struct annotation_line
*al
;
2500 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2501 if (annotation_line__filter(al
, notes
))
2503 annotation_line__write(al
, notes
, &wops
, opts
);
2505 wops
.first_line
= false;
2511 int map_symbol__annotation_dump(struct map_symbol
*ms
, struct evsel
*evsel
,
2512 struct annotation_options
*opts
)
2514 const char *ev_name
= evsel__name(evsel
);
2520 if (asprintf(&filename
, "%s.annotation", ms
->sym
->name
) < 0)
2523 fp
= fopen(filename
, "w");
2525 goto out_free_filename
;
2527 if (evsel__is_group_event(evsel
)) {
2528 evsel__group_desc(evsel
, buf
, sizeof(buf
));
2532 fprintf(fp
, "%s() %s\nEvent: %s\n\n",
2533 ms
->sym
->name
, ms
->map
->dso
->long_name
, ev_name
);
2534 symbol__annotate_fprintf2(ms
->sym
, fp
, opts
);
2543 void symbol__annotate_zero_histogram(struct symbol
*sym
, int evidx
)
2545 struct annotation
*notes
= symbol__annotation(sym
);
2546 struct sym_hist
*h
= annotation__histogram(notes
, evidx
);
2548 memset(h
, 0, notes
->src
->sizeof_sym_hist
);
2551 void symbol__annotate_decay_histogram(struct symbol
*sym
, int evidx
)
2553 struct annotation
*notes
= symbol__annotation(sym
);
2554 struct sym_hist
*h
= annotation__histogram(notes
, evidx
);
2555 int len
= symbol__size(sym
), offset
;
2558 for (offset
= 0; offset
< len
; ++offset
) {
2559 h
->addr
[offset
].nr_samples
= h
->addr
[offset
].nr_samples
* 7 / 8;
2560 h
->nr_samples
+= h
->addr
[offset
].nr_samples
;
2564 void annotated_source__purge(struct annotated_source
*as
)
2566 struct annotation_line
*al
, *n
;
2568 list_for_each_entry_safe(al
, n
, &as
->source
, node
) {
2569 list_del_init(&al
->node
);
2570 disasm_line__free(disasm_line(al
));
2574 static size_t disasm_line__fprintf(struct disasm_line
*dl
, FILE *fp
)
2578 if (dl
->al
.offset
== -1)
2579 return fprintf(fp
, "%s\n", dl
->al
.line
);
2581 printed
= fprintf(fp
, "%#" PRIx64
" %s", dl
->al
.offset
, dl
->ins
.name
);
2583 if (dl
->ops
.raw
[0] != '\0') {
2584 printed
+= fprintf(fp
, "%.*s %s\n", 6 - (int)printed
, " ",
2588 return printed
+ fprintf(fp
, "\n");
2591 size_t disasm__fprintf(struct list_head
*head
, FILE *fp
)
2593 struct disasm_line
*pos
;
2596 list_for_each_entry(pos
, head
, al
.node
)
2597 printed
+= disasm_line__fprintf(pos
, fp
);
2602 bool disasm_line__is_valid_local_jump(struct disasm_line
*dl
, struct symbol
*sym
)
2604 if (!dl
|| !dl
->ins
.ops
|| !ins__is_jump(&dl
->ins
) ||
2605 !disasm_line__has_local_offset(dl
) || dl
->ops
.target
.offset
< 0 ||
2606 dl
->ops
.target
.offset
>= (s64
)symbol__size(sym
))
2612 void annotation__mark_jump_targets(struct annotation
*notes
, struct symbol
*sym
)
2614 u64 offset
, size
= symbol__size(sym
);
2616 /* PLT symbols contain external offsets */
2617 if (strstr(sym
->name
, "@plt"))
2620 for (offset
= 0; offset
< size
; ++offset
) {
2621 struct annotation_line
*al
= notes
->offsets
[offset
];
2622 struct disasm_line
*dl
;
2624 dl
= disasm_line(al
);
2626 if (!disasm_line__is_valid_local_jump(dl
, sym
))
2629 al
= notes
->offsets
[dl
->ops
.target
.offset
];
2632 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2633 * have to adjust to the previous offset?
2638 if (++al
->jump_sources
> notes
->max_jump_sources
)
2639 notes
->max_jump_sources
= al
->jump_sources
;
2643 void annotation__set_offsets(struct annotation
*notes
, s64 size
)
2645 struct annotation_line
*al
;
2647 notes
->max_line_len
= 0;
2648 notes
->nr_entries
= 0;
2649 notes
->nr_asm_entries
= 0;
2651 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2652 size_t line_len
= strlen(al
->line
);
2654 if (notes
->max_line_len
< line_len
)
2655 notes
->max_line_len
= line_len
;
2656 al
->idx
= notes
->nr_entries
++;
2657 if (al
->offset
!= -1) {
2658 al
->idx_asm
= notes
->nr_asm_entries
++;
2660 * FIXME: short term bandaid to cope with assembly
2661 * routines that comes with labels in the same column
2662 * as the address in objdump, sigh.
2664 * E.g. copy_user_generic_unrolled
2666 if (al
->offset
< size
)
2667 notes
->offsets
[al
->offset
] = al
;
2673 static inline int width_jumps(int n
)
2682 static int annotation__max_ins_name(struct annotation
*notes
)
2684 int max_name
= 0, len
;
2685 struct annotation_line
*al
;
2687 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2688 if (al
->offset
== -1)
2691 len
= strlen(disasm_line(al
)->ins
.name
);
2699 void annotation__init_column_widths(struct annotation
*notes
, struct symbol
*sym
)
2701 notes
->widths
.addr
= notes
->widths
.target
=
2702 notes
->widths
.min_addr
= hex_width(symbol__size(sym
));
2703 notes
->widths
.max_addr
= hex_width(sym
->end
);
2704 notes
->widths
.jumps
= width_jumps(notes
->max_jump_sources
);
2705 notes
->widths
.max_ins_name
= annotation__max_ins_name(notes
);
2708 void annotation__update_column_widths(struct annotation
*notes
)
2710 if (notes
->options
->use_offset
)
2711 notes
->widths
.target
= notes
->widths
.min_addr
;
2713 notes
->widths
.target
= notes
->widths
.max_addr
;
2715 notes
->widths
.addr
= notes
->widths
.target
;
2717 if (notes
->options
->show_nr_jumps
)
2718 notes
->widths
.addr
+= notes
->widths
.jumps
+ 1;
2721 static void annotation__calc_lines(struct annotation
*notes
, struct map
*map
,
2722 struct rb_root
*root
,
2723 struct annotation_options
*opts
)
2725 struct annotation_line
*al
;
2726 struct rb_root tmp_root
= RB_ROOT
;
2728 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2729 double percent_max
= 0.0;
2732 for (i
= 0; i
< al
->data_nr
; i
++) {
2735 percent
= annotation_data__percent(&al
->data
[i
],
2736 opts
->percent_type
);
2738 if (percent
> percent_max
)
2739 percent_max
= percent
;
2742 if (percent_max
<= 0.5)
2745 al
->path
= get_srcline(map
->dso
, notes
->start
+ al
->offset
, NULL
,
2746 false, true, notes
->start
+ al
->offset
);
2747 insert_source_line(&tmp_root
, al
, opts
);
2750 resort_source_line(root
, &tmp_root
);
2753 static void symbol__calc_lines(struct map_symbol
*ms
, struct rb_root
*root
,
2754 struct annotation_options
*opts
)
2756 struct annotation
*notes
= symbol__annotation(ms
->sym
);
2758 annotation__calc_lines(notes
, ms
->map
, root
, opts
);
2761 int symbol__tty_annotate2(struct map_symbol
*ms
, struct evsel
*evsel
,
2762 struct annotation_options
*opts
)
2764 struct dso
*dso
= ms
->map
->dso
;
2765 struct symbol
*sym
= ms
->sym
;
2766 struct rb_root source_line
= RB_ROOT
;
2767 struct hists
*hists
= evsel__hists(evsel
);
2770 if (symbol__annotate2(ms
, evsel
, opts
, NULL
) < 0)
2773 if (opts
->print_lines
) {
2774 srcline_full_filename
= opts
->full_path
;
2775 symbol__calc_lines(ms
, &source_line
, opts
);
2776 print_summary(&source_line
, dso
->long_name
);
2779 hists__scnprintf_title(hists
, buf
, sizeof(buf
));
2780 fprintf(stdout
, "%s, [percent: %s]\n%s() %s\n",
2781 buf
, percent_type_str(opts
->percent_type
), sym
->name
, dso
->long_name
);
2782 symbol__annotate_fprintf2(sym
, stdout
, opts
);
2784 annotated_source__purge(symbol__annotation(sym
)->src
);
2789 int symbol__tty_annotate(struct map_symbol
*ms
, struct evsel
*evsel
,
2790 struct annotation_options
*opts
)
2792 struct dso
*dso
= ms
->map
->dso
;
2793 struct symbol
*sym
= ms
->sym
;
2794 struct rb_root source_line
= RB_ROOT
;
2796 if (symbol__annotate(ms
, evsel
, opts
, NULL
) < 0)
2799 symbol__calc_percent(sym
, evsel
);
2801 if (opts
->print_lines
) {
2802 srcline_full_filename
= opts
->full_path
;
2803 symbol__calc_lines(ms
, &source_line
, opts
);
2804 print_summary(&source_line
, dso
->long_name
);
2807 symbol__annotate_printf(ms
, evsel
, opts
);
2809 annotated_source__purge(symbol__annotation(sym
)->src
);
2814 bool ui__has_annotation(void)
2816 return use_browser
== 1 && perf_hpp_list
.sym
;
2820 static double annotation_line__max_percent(struct annotation_line
*al
,
2821 struct annotation
*notes
,
2822 unsigned int percent_type
)
2824 double percent_max
= 0.0;
2827 for (i
= 0; i
< notes
->nr_events
; i
++) {
2830 percent
= annotation_data__percent(&al
->data
[i
],
2833 if (percent
> percent_max
)
2834 percent_max
= percent
;
2840 static void disasm_line__write(struct disasm_line
*dl
, struct annotation
*notes
,
2841 void *obj
, char *bf
, size_t size
,
2842 void (*obj__printf
)(void *obj
, const char *fmt
, ...),
2843 void (*obj__write_graph
)(void *obj
, int graph
))
2845 if (dl
->ins
.ops
&& dl
->ins
.ops
->scnprintf
) {
2846 if (ins__is_jump(&dl
->ins
)) {
2849 if (dl
->ops
.target
.outside
)
2851 fwd
= dl
->ops
.target
.offset
> dl
->al
.offset
;
2852 obj__write_graph(obj
, fwd
? DARROW_CHAR
: UARROW_CHAR
);
2853 obj__printf(obj
, " ");
2854 } else if (ins__is_call(&dl
->ins
)) {
2856 obj__write_graph(obj
, RARROW_CHAR
);
2857 obj__printf(obj
, " ");
2858 } else if (ins__is_ret(&dl
->ins
)) {
2859 obj__write_graph(obj
, LARROW_CHAR
);
2860 obj__printf(obj
, " ");
2862 obj__printf(obj
, " ");
2865 obj__printf(obj
, " ");
2868 disasm_line__scnprintf(dl
, bf
, size
, !notes
->options
->use_offset
, notes
->widths
.max_ins_name
);
2871 static void ipc_coverage_string(char *bf
, int size
, struct annotation
*notes
)
2873 double ipc
= 0.0, coverage
= 0.0;
2875 if (notes
->hit_cycles
)
2876 ipc
= notes
->hit_insn
/ ((double)notes
->hit_cycles
);
2878 if (notes
->total_insn
) {
2879 coverage
= notes
->cover_insn
* 100.0 /
2880 ((double)notes
->total_insn
);
2883 scnprintf(bf
, size
, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2887 static void __annotation_line__write(struct annotation_line
*al
, struct annotation
*notes
,
2888 bool first_line
, bool current_entry
, bool change_color
, int width
,
2889 void *obj
, unsigned int percent_type
,
2890 int (*obj__set_color
)(void *obj
, int color
),
2891 void (*obj__set_percent_color
)(void *obj
, double percent
, bool current
),
2892 int (*obj__set_jumps_percent_color
)(void *obj
, int nr
, bool current
),
2893 void (*obj__printf
)(void *obj
, const char *fmt
, ...),
2894 void (*obj__write_graph
)(void *obj
, int graph
))
2897 double percent_max
= annotation_line__max_percent(al
, notes
, percent_type
);
2898 int pcnt_width
= annotation__pcnt_width(notes
),
2899 cycles_width
= annotation__cycles_width(notes
);
2900 bool show_title
= false;
2904 if (first_line
&& (al
->offset
== -1 || percent_max
== 0.0)) {
2905 if (notes
->have_cycles
) {
2906 if (al
->ipc
== 0.0 && al
->cycles
== 0)
2912 if (al
->offset
!= -1 && percent_max
!= 0.0) {
2915 for (i
= 0; i
< notes
->nr_events
; i
++) {
2918 percent
= annotation_data__percent(&al
->data
[i
], percent_type
);
2920 obj__set_percent_color(obj
, percent
, current_entry
);
2921 if (symbol_conf
.show_total_period
) {
2922 obj__printf(obj
, "%11" PRIu64
" ", al
->data
[i
].he
.period
);
2923 } else if (symbol_conf
.show_nr_samples
) {
2924 obj__printf(obj
, "%6" PRIu64
" ",
2925 al
->data
[i
].he
.nr_samples
);
2927 obj__printf(obj
, "%6.2f ", percent
);
2931 obj__set_percent_color(obj
, 0, current_entry
);
2934 obj__printf(obj
, "%-*s", pcnt_width
, " ");
2936 obj__printf(obj
, "%-*s", pcnt_width
,
2937 symbol_conf
.show_total_period
? "Period" :
2938 symbol_conf
.show_nr_samples
? "Samples" : "Percent");
2942 if (notes
->have_cycles
) {
2944 obj__printf(obj
, "%*.2f ", ANNOTATION__IPC_WIDTH
- 1, al
->ipc
);
2945 else if (!show_title
)
2946 obj__printf(obj
, "%*s", ANNOTATION__IPC_WIDTH
, " ");
2948 obj__printf(obj
, "%*s ", ANNOTATION__IPC_WIDTH
- 1, "IPC");
2950 if (!notes
->options
->show_minmax_cycle
) {
2952 obj__printf(obj
, "%*" PRIu64
" ",
2953 ANNOTATION__CYCLES_WIDTH
- 1, al
->cycles
);
2954 else if (!show_title
)
2955 obj__printf(obj
, "%*s",
2956 ANNOTATION__CYCLES_WIDTH
, " ");
2958 obj__printf(obj
, "%*s ",
2959 ANNOTATION__CYCLES_WIDTH
- 1,
2965 scnprintf(str
, sizeof(str
),
2966 "%" PRIu64
"(%" PRIu64
"/%" PRIu64
")",
2967 al
->cycles
, al
->cycles_min
,
2970 obj__printf(obj
, "%*s ",
2971 ANNOTATION__MINMAX_CYCLES_WIDTH
- 1,
2973 } else if (!show_title
)
2974 obj__printf(obj
, "%*s",
2975 ANNOTATION__MINMAX_CYCLES_WIDTH
,
2978 obj__printf(obj
, "%*s ",
2979 ANNOTATION__MINMAX_CYCLES_WIDTH
- 1,
2983 if (show_title
&& !*al
->line
) {
2984 ipc_coverage_string(bf
, sizeof(bf
), notes
);
2985 obj__printf(obj
, "%*s", ANNOTATION__AVG_IPC_WIDTH
, bf
);
2989 obj__printf(obj
, " ");
2992 obj__printf(obj
, "%-*s", width
- pcnt_width
- cycles_width
, " ");
2993 else if (al
->offset
== -1) {
2994 if (al
->line_nr
&& notes
->options
->show_linenr
)
2995 printed
= scnprintf(bf
, sizeof(bf
), "%-*d ", notes
->widths
.addr
+ 1, al
->line_nr
);
2997 printed
= scnprintf(bf
, sizeof(bf
), "%-*s ", notes
->widths
.addr
, " ");
2998 obj__printf(obj
, bf
);
2999 obj__printf(obj
, "%-*s", width
- printed
- pcnt_width
- cycles_width
+ 1, al
->line
);
3001 u64 addr
= al
->offset
;
3004 if (!notes
->options
->use_offset
)
3005 addr
+= notes
->start
;
3007 if (!notes
->options
->use_offset
) {
3008 printed
= scnprintf(bf
, sizeof(bf
), "%" PRIx64
": ", addr
);
3010 if (al
->jump_sources
&&
3011 notes
->options
->offset_level
>= ANNOTATION__OFFSET_JUMP_TARGETS
) {
3012 if (notes
->options
->show_nr_jumps
) {
3014 printed
= scnprintf(bf
, sizeof(bf
), "%*d ",
3015 notes
->widths
.jumps
,
3017 prev
= obj__set_jumps_percent_color(obj
, al
->jump_sources
,
3019 obj__printf(obj
, bf
);
3020 obj__set_color(obj
, prev
);
3023 printed
= scnprintf(bf
, sizeof(bf
), "%*" PRIx64
": ",
3024 notes
->widths
.target
, addr
);
3025 } else if (ins__is_call(&disasm_line(al
)->ins
) &&
3026 notes
->options
->offset_level
>= ANNOTATION__OFFSET_CALL
) {
3028 } else if (notes
->options
->offset_level
== ANNOTATION__MAX_OFFSET_LEVEL
) {
3031 printed
= scnprintf(bf
, sizeof(bf
), "%-*s ",
3032 notes
->widths
.addr
, " ");
3037 color
= obj__set_color(obj
, HE_COLORSET_ADDR
);
3038 obj__printf(obj
, bf
);
3040 obj__set_color(obj
, color
);
3042 disasm_line__write(disasm_line(al
), notes
, obj
, bf
, sizeof(bf
), obj__printf
, obj__write_graph
);
3044 obj__printf(obj
, "%-*s", width
- pcnt_width
- cycles_width
- 3 - printed
, bf
);
3049 void annotation_line__write(struct annotation_line
*al
, struct annotation
*notes
,
3050 struct annotation_write_ops
*wops
,
3051 struct annotation_options
*opts
)
3053 __annotation_line__write(al
, notes
, wops
->first_line
, wops
->current_entry
,
3054 wops
->change_color
, wops
->width
, wops
->obj
,
3056 wops
->set_color
, wops
->set_percent_color
,
3057 wops
->set_jumps_percent_color
, wops
->printf
,
3061 int symbol__annotate2(struct map_symbol
*ms
, struct evsel
*evsel
,
3062 struct annotation_options
*options
, struct arch
**parch
)
3064 struct symbol
*sym
= ms
->sym
;
3065 struct annotation
*notes
= symbol__annotation(sym
);
3066 size_t size
= symbol__size(sym
);
3067 int nr_pcnt
= 1, err
;
3069 notes
->offsets
= zalloc(size
* sizeof(struct annotation_line
*));
3070 if (notes
->offsets
== NULL
)
3073 if (evsel__is_group_event(evsel
))
3074 nr_pcnt
= evsel
->core
.nr_members
;
3076 err
= symbol__annotate(ms
, evsel
, options
, parch
);
3078 goto out_free_offsets
;
3080 notes
->options
= options
;
3082 symbol__calc_percent(sym
, evsel
);
3084 annotation__set_offsets(notes
, size
);
3085 annotation__mark_jump_targets(notes
, sym
);
3086 annotation__compute_ipc(notes
, size
);
3087 annotation__init_column_widths(notes
, sym
);
3088 notes
->nr_events
= nr_pcnt
;
3090 annotation__update_column_widths(notes
);
3091 sym
->annotate2
= true;
3096 zfree(¬es
->offsets
);
3100 static int annotation__config(const char *var
, const char *value
, void *data
)
3102 struct annotation_options
*opt
= data
;
3104 if (!strstarts(var
, "annotate."))
3107 if (!strcmp(var
, "annotate.offset_level")) {
3108 perf_config_u8(&opt
->offset_level
, "offset_level", value
);
3110 if (opt
->offset_level
> ANNOTATION__MAX_OFFSET_LEVEL
)
3111 opt
->offset_level
= ANNOTATION__MAX_OFFSET_LEVEL
;
3112 else if (opt
->offset_level
< ANNOTATION__MIN_OFFSET_LEVEL
)
3113 opt
->offset_level
= ANNOTATION__MIN_OFFSET_LEVEL
;
3114 } else if (!strcmp(var
, "annotate.hide_src_code")) {
3115 opt
->hide_src_code
= perf_config_bool("hide_src_code", value
);
3116 } else if (!strcmp(var
, "annotate.jump_arrows")) {
3117 opt
->jump_arrows
= perf_config_bool("jump_arrows", value
);
3118 } else if (!strcmp(var
, "annotate.show_linenr")) {
3119 opt
->show_linenr
= perf_config_bool("show_linenr", value
);
3120 } else if (!strcmp(var
, "annotate.show_nr_jumps")) {
3121 opt
->show_nr_jumps
= perf_config_bool("show_nr_jumps", value
);
3122 } else if (!strcmp(var
, "annotate.show_nr_samples")) {
3123 symbol_conf
.show_nr_samples
= perf_config_bool("show_nr_samples",
3125 } else if (!strcmp(var
, "annotate.show_total_period")) {
3126 symbol_conf
.show_total_period
= perf_config_bool("show_total_period",
3128 } else if (!strcmp(var
, "annotate.use_offset")) {
3129 opt
->use_offset
= perf_config_bool("use_offset", value
);
3131 pr_debug("%s variable unknown, ignoring...", var
);
3137 void annotation_config__init(struct annotation_options
*opt
)
3139 perf_config(annotation__config
, opt
);
3142 static unsigned int parse_percent_type(char *str1
, char *str2
)
3144 unsigned int type
= (unsigned int) -1;
3146 if (!strcmp("period", str1
)) {
3147 if (!strcmp("local", str2
))
3148 type
= PERCENT_PERIOD_LOCAL
;
3149 else if (!strcmp("global", str2
))
3150 type
= PERCENT_PERIOD_GLOBAL
;
3153 if (!strcmp("hits", str1
)) {
3154 if (!strcmp("local", str2
))
3155 type
= PERCENT_HITS_LOCAL
;
3156 else if (!strcmp("global", str2
))
3157 type
= PERCENT_HITS_GLOBAL
;
3163 int annotate_parse_percent_type(const struct option
*opt
, const char *_str
,
3164 int unset __maybe_unused
)
3166 struct annotation_options
*opts
= opt
->value
;
3171 str1
= strdup(_str
);
3175 str2
= strchr(str1
, '-');
3181 type
= parse_percent_type(str1
, str2
);
3182 if (type
== (unsigned int) -1)
3183 type
= parse_percent_type(str2
, str1
);
3184 if (type
!= (unsigned int) -1) {
3185 opts
->percent_type
= type
;
3194 int annotate_check_args(struct annotation_options
*args
)
3196 if (args
->prefix_strip
&& !args
->prefix
) {
3197 pr_err("--prefix-strip requires --prefix\n");