1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
5 * Parts came from builtin-annotate.c, see those files for further
13 #include "util.h" // hex_width()
30 #include "bpf-event.h"
31 #include "block-range.h"
33 #include "util/event.h"
34 #include "arch/common.h"
37 #include <linux/bitops.h>
38 #include <linux/kernel.h>
39 #include <linux/string.h>
40 #include <subcmd/parse-options.h>
41 #include <subcmd/run-command.h>
43 /* FIXME: For the HE_COLORSET */
44 #include "ui/browser.h"
47 * FIXME: Using the same values as slang.h,
48 * but that header may not be available everywhere
50 #define LARROW_CHAR ((unsigned char)',')
51 #define RARROW_CHAR ((unsigned char)'+')
52 #define DARROW_CHAR ((unsigned char)'.')
53 #define UARROW_CHAR ((unsigned char)'-')
55 #include <linux/ctype.h>
57 struct annotation_options annotation__default_options
= {
61 .offset_level
= ANNOTATION__OFFSET_JUMP_TARGETS
,
62 .percent_type
= PERCENT_PERIOD_LOCAL
,
65 static regex_t file_lineno
;
67 static struct ins_ops
*ins__find(struct arch
*arch
, const char *name
);
68 static void ins__sort(struct arch
*arch
);
69 static int disasm_line__parse(char *line
, const char **namep
, char **rawp
);
73 struct ins
*instructions
;
74 size_t nr_instructions
;
75 size_t nr_instructions_allocated
;
76 struct ins_ops
*(*associate_instruction_ops
)(struct arch
*arch
, const char *name
);
77 bool sorted_instructions
;
82 int (*init
)(struct arch
*arch
, char *cpuid
);
83 bool (*ins_is_fused
)(struct arch
*arch
, const char *ins1
,
87 char skip_functions_char
;
91 static struct ins_ops call_ops
;
92 static struct ins_ops dec_ops
;
93 static struct ins_ops jump_ops
;
94 static struct ins_ops mov_ops
;
95 static struct ins_ops nop_ops
;
96 static struct ins_ops lock_ops
;
97 static struct ins_ops ret_ops
;
99 static int arch__grow_instructions(struct arch
*arch
)
101 struct ins
*new_instructions
;
102 size_t new_nr_allocated
;
104 if (arch
->nr_instructions_allocated
== 0 && arch
->instructions
)
105 goto grow_from_non_allocated_table
;
107 new_nr_allocated
= arch
->nr_instructions_allocated
+ 128;
108 new_instructions
= realloc(arch
->instructions
, new_nr_allocated
* sizeof(struct ins
));
109 if (new_instructions
== NULL
)
112 out_update_instructions
:
113 arch
->instructions
= new_instructions
;
114 arch
->nr_instructions_allocated
= new_nr_allocated
;
117 grow_from_non_allocated_table
:
118 new_nr_allocated
= arch
->nr_instructions
+ 128;
119 new_instructions
= calloc(new_nr_allocated
, sizeof(struct ins
));
120 if (new_instructions
== NULL
)
123 memcpy(new_instructions
, arch
->instructions
, arch
->nr_instructions
);
124 goto out_update_instructions
;
127 static int arch__associate_ins_ops(struct arch
* arch
, const char *name
, struct ins_ops
*ops
)
131 if (arch
->nr_instructions
== arch
->nr_instructions_allocated
&&
132 arch__grow_instructions(arch
))
135 ins
= &arch
->instructions
[arch
->nr_instructions
];
136 ins
->name
= strdup(name
);
141 arch
->nr_instructions
++;
147 #include "arch/arc/annotate/instructions.c"
148 #include "arch/arm/annotate/instructions.c"
149 #include "arch/arm64/annotate/instructions.c"
150 #include "arch/csky/annotate/instructions.c"
151 #include "arch/mips/annotate/instructions.c"
152 #include "arch/x86/annotate/instructions.c"
153 #include "arch/powerpc/annotate/instructions.c"
154 #include "arch/s390/annotate/instructions.c"
155 #include "arch/sparc/annotate/instructions.c"
157 static struct arch architectures
[] = {
160 .init
= arc__annotate_init
,
164 .init
= arm__annotate_init
,
168 .init
= arm64__annotate_init
,
172 .init
= csky__annotate_init
,
176 .init
= mips__annotate_init
,
183 .init
= x86__annotate_init
,
184 .instructions
= x86__instructions
,
185 .nr_instructions
= ARRAY_SIZE(x86__instructions
),
186 .ins_is_fused
= x86__ins_is_fused
,
193 .init
= powerpc__annotate_init
,
197 .init
= s390__annotate_init
,
204 .init
= sparc__annotate_init
,
211 static void ins__delete(struct ins_operands
*ops
)
215 zfree(&ops
->source
.raw
);
216 zfree(&ops
->source
.name
);
217 zfree(&ops
->target
.raw
);
218 zfree(&ops
->target
.name
);
221 static int ins__raw_scnprintf(struct ins
*ins
, char *bf
, size_t size
,
222 struct ins_operands
*ops
, int max_ins_name
)
224 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->raw
);
227 int ins__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
228 struct ins_operands
*ops
, int max_ins_name
)
230 if (ins
->ops
->scnprintf
)
231 return ins
->ops
->scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
233 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
236 bool ins__is_fused(struct arch
*arch
, const char *ins1
, const char *ins2
)
238 if (!arch
|| !arch
->ins_is_fused
)
241 return arch
->ins_is_fused(arch
, ins1
, ins2
);
244 static int call__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms
)
246 char *endptr
, *tok
, *name
;
247 struct map
*map
= ms
->map
;
248 struct addr_map_symbol target
= {
249 .ms
= { .map
= map
, },
252 ops
->target
.addr
= strtoull(ops
->raw
, &endptr
, 16);
254 name
= strchr(endptr
, '<');
260 if (arch
->objdump
.skip_functions_char
&&
261 strchr(name
, arch
->objdump
.skip_functions_char
))
264 tok
= strchr(name
, '>');
269 ops
->target
.name
= strdup(name
);
272 if (ops
->target
.name
== NULL
)
275 target
.addr
= map__objdump_2mem(map
, ops
->target
.addr
);
277 if (maps__find_ams(ms
->maps
, &target
) == 0 &&
278 map__rip_2objdump(target
.ms
.map
, map
->map_ip(target
.ms
.map
, target
.addr
)) == ops
->target
.addr
)
279 ops
->target
.sym
= target
.ms
.sym
;
284 tok
= strchr(endptr
, '*');
288 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
289 * Do not parse such instruction. */
290 if (strstr(endptr
, "(%r") == NULL
)
291 ops
->target
.addr
= strtoull(endptr
, NULL
, 16);
296 static int call__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
297 struct ins_operands
*ops
, int max_ins_name
)
300 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->target
.sym
->name
);
302 if (ops
->target
.addr
== 0)
303 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
305 if (ops
->target
.name
)
306 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->target
.name
);
308 return scnprintf(bf
, size
, "%-*s *%" PRIx64
, max_ins_name
, ins
->name
, ops
->target
.addr
);
311 static struct ins_ops call_ops
= {
312 .parse
= call__parse
,
313 .scnprintf
= call__scnprintf
,
316 bool ins__is_call(const struct ins
*ins
)
318 return ins
->ops
== &call_ops
|| ins
->ops
== &s390_call_ops
;
322 * Prevents from matching commas in the comment section, e.g.:
323 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
325 static inline const char *validate_comma(const char *c
, struct ins_operands
*ops
)
327 if (ops
->raw_comment
&& c
> ops
->raw_comment
)
333 static int jump__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms
)
335 struct map
*map
= ms
->map
;
336 struct symbol
*sym
= ms
->sym
;
337 struct addr_map_symbol target
= {
338 .ms
= { .map
= map
, },
340 const char *c
= strchr(ops
->raw
, ',');
343 ops
->raw_comment
= strchr(ops
->raw
, arch
->objdump
.comment_char
);
344 c
= validate_comma(c
, ops
);
347 * Examples of lines to parse for the _cpp_lex_token@@Base
350 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
351 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
353 * The first is a jump to an offset inside the same function,
354 * the second is to another function, i.e. that 0xa72 is an
355 * offset in the cpp_named_operator2name@@base function.
358 * skip over possible up to 2 operands to get to address, e.g.:
359 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
362 ops
->target
.addr
= strtoull(c
, NULL
, 16);
363 if (!ops
->target
.addr
) {
365 c
= validate_comma(c
, ops
);
367 ops
->target
.addr
= strtoull(c
, NULL
, 16);
370 ops
->target
.addr
= strtoull(ops
->raw
, NULL
, 16);
373 target
.addr
= map__objdump_2mem(map
, ops
->target
.addr
);
374 start
= map
->unmap_ip(map
, sym
->start
),
375 end
= map
->unmap_ip(map
, sym
->end
);
377 ops
->target
.outside
= target
.addr
< start
|| target
.addr
> end
;
380 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
382 cpp_named_operator2name@@Base+0xa72
384 * Point to a place that is after the cpp_named_operator2name
385 * boundaries, i.e. in the ELF symbol table for cc1
386 * cpp_named_operator2name is marked as being 32-bytes long, but it in
387 * fact is much larger than that, so we seem to need a symbols__find()
388 * routine that looks for >= current->start and < next_symbol->start,
389 * possibly just for C++ objects?
391 * For now lets just make some progress by marking jumps to outside the
392 * current function as call like.
394 * Actual navigation will come next, with further understanding of how
395 * the symbol searching and disassembly should be done.
397 if (maps__find_ams(ms
->maps
, &target
) == 0 &&
398 map__rip_2objdump(target
.ms
.map
, map
->map_ip(target
.ms
.map
, target
.addr
)) == ops
->target
.addr
)
399 ops
->target
.sym
= target
.ms
.sym
;
401 if (!ops
->target
.outside
) {
402 ops
->target
.offset
= target
.addr
- start
;
403 ops
->target
.offset_avail
= true;
405 ops
->target
.offset_avail
= false;
411 static int jump__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
412 struct ins_operands
*ops
, int max_ins_name
)
416 if (!ops
->target
.addr
|| ops
->target
.offset
< 0)
417 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
419 if (ops
->target
.outside
&& ops
->target
.sym
!= NULL
)
420 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
, ops
->target
.sym
->name
);
422 c
= strchr(ops
->raw
, ',');
423 c
= validate_comma(c
, ops
);
426 const char *c2
= strchr(c
+ 1, ',');
428 c2
= validate_comma(c2
, ops
);
429 /* check for 3-op insn */
434 /* mirror arch objdump's space-after-comma style */
439 return scnprintf(bf
, size
, "%-*s %.*s%" PRIx64
, max_ins_name
,
440 ins
->name
, c
? c
- ops
->raw
: 0, ops
->raw
,
444 static struct ins_ops jump_ops
= {
445 .parse
= jump__parse
,
446 .scnprintf
= jump__scnprintf
,
449 bool ins__is_jump(const struct ins
*ins
)
451 return ins
->ops
== &jump_ops
;
454 static int comment__symbol(char *raw
, char *comment
, u64
*addrp
, char **namep
)
456 char *endptr
, *name
, *t
;
458 if (strstr(raw
, "(%rip)") == NULL
)
461 *addrp
= strtoull(comment
, &endptr
, 16);
462 if (endptr
== comment
)
464 name
= strchr(endptr
, '<');
470 t
= strchr(name
, '>');
475 *namep
= strdup(name
);
481 static int lock__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms
)
483 ops
->locked
.ops
= zalloc(sizeof(*ops
->locked
.ops
));
484 if (ops
->locked
.ops
== NULL
)
487 if (disasm_line__parse(ops
->raw
, &ops
->locked
.ins
.name
, &ops
->locked
.ops
->raw
) < 0)
490 ops
->locked
.ins
.ops
= ins__find(arch
, ops
->locked
.ins
.name
);
492 if (ops
->locked
.ins
.ops
== NULL
)
495 if (ops
->locked
.ins
.ops
->parse
&&
496 ops
->locked
.ins
.ops
->parse(arch
, ops
->locked
.ops
, ms
) < 0)
502 zfree(&ops
->locked
.ops
);
506 static int lock__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
507 struct ins_operands
*ops
, int max_ins_name
)
511 if (ops
->locked
.ins
.ops
== NULL
)
512 return ins__raw_scnprintf(ins
, bf
, size
, ops
, max_ins_name
);
514 printed
= scnprintf(bf
, size
, "%-*s ", max_ins_name
, ins
->name
);
515 return printed
+ ins__scnprintf(&ops
->locked
.ins
, bf
+ printed
,
516 size
- printed
, ops
->locked
.ops
, max_ins_name
);
519 static void lock__delete(struct ins_operands
*ops
)
521 struct ins
*ins
= &ops
->locked
.ins
;
523 if (ins
->ops
&& ins
->ops
->free
)
524 ins
->ops
->free(ops
->locked
.ops
);
526 ins__delete(ops
->locked
.ops
);
528 zfree(&ops
->locked
.ops
);
529 zfree(&ops
->target
.raw
);
530 zfree(&ops
->target
.name
);
533 static struct ins_ops lock_ops
= {
534 .free
= lock__delete
,
535 .parse
= lock__parse
,
536 .scnprintf
= lock__scnprintf
,
539 static int mov__parse(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms __maybe_unused
)
541 char *s
= strchr(ops
->raw
, ','), *target
, *comment
, prev
;
547 ops
->source
.raw
= strdup(ops
->raw
);
550 if (ops
->source
.raw
== NULL
)
554 comment
= strchr(s
, arch
->objdump
.comment_char
);
559 s
= strchr(s
, '\0') - 1;
561 while (s
> target
&& isspace(s
[0]))
567 ops
->target
.raw
= strdup(target
);
570 if (ops
->target
.raw
== NULL
)
571 goto out_free_source
;
576 comment
= skip_spaces(comment
);
577 comment__symbol(ops
->source
.raw
, comment
+ 1, &ops
->source
.addr
, &ops
->source
.name
);
578 comment__symbol(ops
->target
.raw
, comment
+ 1, &ops
->target
.addr
, &ops
->target
.name
);
583 zfree(&ops
->source
.raw
);
587 static int mov__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
588 struct ins_operands
*ops
, int max_ins_name
)
590 return scnprintf(bf
, size
, "%-*s %s,%s", max_ins_name
, ins
->name
,
591 ops
->source
.name
?: ops
->source
.raw
,
592 ops
->target
.name
?: ops
->target
.raw
);
595 static struct ins_ops mov_ops
= {
597 .scnprintf
= mov__scnprintf
,
600 static int dec__parse(struct arch
*arch __maybe_unused
, struct ins_operands
*ops
, struct map_symbol
*ms __maybe_unused
)
602 char *target
, *comment
, *s
, prev
;
604 target
= s
= ops
->raw
;
606 while (s
[0] != '\0' && !isspace(s
[0]))
611 ops
->target
.raw
= strdup(target
);
614 if (ops
->target
.raw
== NULL
)
617 comment
= strchr(s
, arch
->objdump
.comment_char
);
621 comment
= skip_spaces(comment
);
622 comment__symbol(ops
->target
.raw
, comment
+ 1, &ops
->target
.addr
, &ops
->target
.name
);
627 static int dec__scnprintf(struct ins
*ins
, char *bf
, size_t size
,
628 struct ins_operands
*ops
, int max_ins_name
)
630 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, ins
->name
,
631 ops
->target
.name
?: ops
->target
.raw
);
634 static struct ins_ops dec_ops
= {
636 .scnprintf
= dec__scnprintf
,
639 static int nop__scnprintf(struct ins
*ins __maybe_unused
, char *bf
, size_t size
,
640 struct ins_operands
*ops __maybe_unused
, int max_ins_name
)
642 return scnprintf(bf
, size
, "%-*s", max_ins_name
, "nop");
645 static struct ins_ops nop_ops
= {
646 .scnprintf
= nop__scnprintf
,
649 static struct ins_ops ret_ops
= {
650 .scnprintf
= ins__raw_scnprintf
,
653 bool ins__is_ret(const struct ins
*ins
)
655 return ins
->ops
== &ret_ops
;
658 bool ins__is_lock(const struct ins
*ins
)
660 return ins
->ops
== &lock_ops
;
663 static int ins__key_cmp(const void *name
, const void *insp
)
665 const struct ins
*ins
= insp
;
667 return strcmp(name
, ins
->name
);
670 static int ins__cmp(const void *a
, const void *b
)
672 const struct ins
*ia
= a
;
673 const struct ins
*ib
= b
;
675 return strcmp(ia
->name
, ib
->name
);
678 static void ins__sort(struct arch
*arch
)
680 const int nmemb
= arch
->nr_instructions
;
682 qsort(arch
->instructions
, nmemb
, sizeof(struct ins
), ins__cmp
);
685 static struct ins_ops
*__ins__find(struct arch
*arch
, const char *name
)
688 const int nmemb
= arch
->nr_instructions
;
690 if (!arch
->sorted_instructions
) {
692 arch
->sorted_instructions
= true;
695 ins
= bsearch(name
, arch
->instructions
, nmemb
, sizeof(struct ins
), ins__key_cmp
);
696 return ins
? ins
->ops
: NULL
;
699 static struct ins_ops
*ins__find(struct arch
*arch
, const char *name
)
701 struct ins_ops
*ops
= __ins__find(arch
, name
);
703 if (!ops
&& arch
->associate_instruction_ops
)
704 ops
= arch
->associate_instruction_ops(arch
, name
);
709 static int arch__key_cmp(const void *name
, const void *archp
)
711 const struct arch
*arch
= archp
;
713 return strcmp(name
, arch
->name
);
716 static int arch__cmp(const void *a
, const void *b
)
718 const struct arch
*aa
= a
;
719 const struct arch
*ab
= b
;
721 return strcmp(aa
->name
, ab
->name
);
724 static void arch__sort(void)
726 const int nmemb
= ARRAY_SIZE(architectures
);
728 qsort(architectures
, nmemb
, sizeof(struct arch
), arch__cmp
);
731 static struct arch
*arch__find(const char *name
)
733 const int nmemb
= ARRAY_SIZE(architectures
);
741 return bsearch(name
, architectures
, nmemb
, sizeof(struct arch
), arch__key_cmp
);
744 static struct annotated_source
*annotated_source__new(void)
746 struct annotated_source
*src
= zalloc(sizeof(*src
));
749 INIT_LIST_HEAD(&src
->source
);
754 static __maybe_unused
void annotated_source__delete(struct annotated_source
*src
)
758 zfree(&src
->histograms
);
759 zfree(&src
->cycles_hist
);
763 static int annotated_source__alloc_histograms(struct annotated_source
*src
,
764 size_t size
, int nr_hists
)
766 size_t sizeof_sym_hist
;
769 * Add buffer of one element for zero length symbol.
770 * When sample is taken from first instruction of
771 * zero length symbol, perf still resolves it and
772 * shows symbol name in perf report and allows to
778 /* Check for overflow when calculating sizeof_sym_hist */
779 if (size
> (SIZE_MAX
- sizeof(struct sym_hist
)) / sizeof(struct sym_hist_entry
))
782 sizeof_sym_hist
= (sizeof(struct sym_hist
) + size
* sizeof(struct sym_hist_entry
));
784 /* Check for overflow in zalloc argument */
785 if (sizeof_sym_hist
> SIZE_MAX
/ nr_hists
)
788 src
->sizeof_sym_hist
= sizeof_sym_hist
;
789 src
->nr_histograms
= nr_hists
;
790 src
->histograms
= calloc(nr_hists
, sizeof_sym_hist
) ;
791 return src
->histograms
? 0 : -1;
794 /* The cycles histogram is lazily allocated. */
795 static int symbol__alloc_hist_cycles(struct symbol
*sym
)
797 struct annotation
*notes
= symbol__annotation(sym
);
798 const size_t size
= symbol__size(sym
);
800 notes
->src
->cycles_hist
= calloc(size
, sizeof(struct cyc_hist
));
801 if (notes
->src
->cycles_hist
== NULL
)
806 void symbol__annotate_zero_histograms(struct symbol
*sym
)
808 struct annotation
*notes
= symbol__annotation(sym
);
810 pthread_mutex_lock(¬es
->lock
);
811 if (notes
->src
!= NULL
) {
812 memset(notes
->src
->histograms
, 0,
813 notes
->src
->nr_histograms
* notes
->src
->sizeof_sym_hist
);
814 if (notes
->src
->cycles_hist
)
815 memset(notes
->src
->cycles_hist
, 0,
816 symbol__size(sym
) * sizeof(struct cyc_hist
));
818 pthread_mutex_unlock(¬es
->lock
);
821 static int __symbol__account_cycles(struct cyc_hist
*ch
,
823 unsigned offset
, unsigned cycles
,
827 * For now we can only account one basic block per
828 * final jump. But multiple could be overlapping.
829 * Always account the longest one. So when
830 * a shorter one has been already seen throw it away.
832 * We separately always account the full cycles.
834 ch
[offset
].num_aggr
++;
835 ch
[offset
].cycles_aggr
+= cycles
;
837 if (cycles
> ch
[offset
].cycles_max
)
838 ch
[offset
].cycles_max
= cycles
;
840 if (ch
[offset
].cycles_min
) {
841 if (cycles
&& cycles
< ch
[offset
].cycles_min
)
842 ch
[offset
].cycles_min
= cycles
;
844 ch
[offset
].cycles_min
= cycles
;
846 if (!have_start
&& ch
[offset
].have_start
)
848 if (ch
[offset
].num
) {
849 if (have_start
&& (!ch
[offset
].have_start
||
850 ch
[offset
].start
> start
)) {
851 ch
[offset
].have_start
= 0;
852 ch
[offset
].cycles
= 0;
854 if (ch
[offset
].reset
< 0xffff)
856 } else if (have_start
&&
857 ch
[offset
].start
< start
)
861 if (ch
[offset
].num
< NUM_SPARKS
)
862 ch
[offset
].cycles_spark
[ch
[offset
].num
] = cycles
;
864 ch
[offset
].have_start
= have_start
;
865 ch
[offset
].start
= start
;
866 ch
[offset
].cycles
+= cycles
;
871 static int __symbol__inc_addr_samples(struct map_symbol
*ms
,
872 struct annotated_source
*src
, int evidx
, u64 addr
,
873 struct perf_sample
*sample
)
875 struct symbol
*sym
= ms
->sym
;
879 pr_debug3("%s: addr=%#" PRIx64
"\n", __func__
, ms
->map
->unmap_ip(ms
->map
, addr
));
881 if ((addr
< sym
->start
|| addr
>= sym
->end
) &&
882 (addr
!= sym
->end
|| sym
->start
!= sym
->end
)) {
883 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64
", addr=%#" PRIx64
", end=%#" PRIx64
"\n",
884 __func__
, __LINE__
, sym
->name
, sym
->start
, addr
, sym
->end
);
888 offset
= addr
- sym
->start
;
889 h
= annotated_source__histogram(src
, evidx
);
891 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64
", addr=%#" PRIx64
", end=%#" PRIx64
", func: %d\n",
892 __func__
, __LINE__
, sym
->name
, sym
->start
, addr
, sym
->end
, sym
->type
== STT_FUNC
);
896 h
->addr
[offset
].nr_samples
++;
897 h
->period
+= sample
->period
;
898 h
->addr
[offset
].period
+= sample
->period
;
900 pr_debug3("%#" PRIx64
" %s: period++ [addr: %#" PRIx64
", %#" PRIx64
901 ", evidx=%d] => nr_samples: %" PRIu64
", period: %" PRIu64
"\n",
902 sym
->start
, sym
->name
, addr
, addr
- sym
->start
, evidx
,
903 h
->addr
[offset
].nr_samples
, h
->addr
[offset
].period
);
907 static struct cyc_hist
*symbol__cycles_hist(struct symbol
*sym
)
909 struct annotation
*notes
= symbol__annotation(sym
);
911 if (notes
->src
== NULL
) {
912 notes
->src
= annotated_source__new();
913 if (notes
->src
== NULL
)
915 goto alloc_cycles_hist
;
918 if (!notes
->src
->cycles_hist
) {
920 symbol__alloc_hist_cycles(sym
);
923 return notes
->src
->cycles_hist
;
926 struct annotated_source
*symbol__hists(struct symbol
*sym
, int nr_hists
)
928 struct annotation
*notes
= symbol__annotation(sym
);
930 if (notes
->src
== NULL
) {
931 notes
->src
= annotated_source__new();
932 if (notes
->src
== NULL
)
934 goto alloc_histograms
;
937 if (notes
->src
->histograms
== NULL
) {
939 annotated_source__alloc_histograms(notes
->src
, symbol__size(sym
),
946 static int symbol__inc_addr_samples(struct map_symbol
*ms
,
947 struct evsel
*evsel
, u64 addr
,
948 struct perf_sample
*sample
)
950 struct symbol
*sym
= ms
->sym
;
951 struct annotated_source
*src
;
955 src
= symbol__hists(sym
, evsel
->evlist
->core
.nr_entries
);
956 return src
? __symbol__inc_addr_samples(ms
, src
, evsel
->idx
, addr
, sample
) : 0;
959 static int symbol__account_cycles(u64 addr
, u64 start
,
960 struct symbol
*sym
, unsigned cycles
)
962 struct cyc_hist
*cycles_hist
;
967 cycles_hist
= symbol__cycles_hist(sym
);
968 if (cycles_hist
== NULL
)
970 if (addr
< sym
->start
|| addr
>= sym
->end
)
974 if (start
< sym
->start
|| start
>= sym
->end
)
979 offset
= addr
- sym
->start
;
980 return __symbol__account_cycles(cycles_hist
,
981 start
? start
- sym
->start
: 0,
986 int addr_map_symbol__account_cycles(struct addr_map_symbol
*ams
,
987 struct addr_map_symbol
*start
,
997 * Only set start when IPC can be computed. We can only
998 * compute it when the basic block is completely in a single
1000 * Special case the case when the jump is elsewhere, but
1001 * it starts on the function start.
1004 (start
->ms
.sym
== ams
->ms
.sym
||
1006 start
->addr
== ams
->ms
.sym
->start
+ ams
->ms
.map
->start
)))
1007 saddr
= start
->al_addr
;
1009 pr_debug2("BB with bad start: addr %"PRIx64
" start %"PRIx64
" sym %"PRIx64
" saddr %"PRIx64
"\n",
1011 start
? start
->addr
: 0,
1012 ams
->ms
.sym
? ams
->ms
.sym
->start
+ ams
->ms
.map
->start
: 0,
1014 err
= symbol__account_cycles(ams
->al_addr
, saddr
, ams
->ms
.sym
, cycles
);
1016 pr_debug2("account_cycles failed %d\n", err
);
1020 static unsigned annotation__count_insn(struct annotation
*notes
, u64 start
, u64 end
)
1022 unsigned n_insn
= 0;
1025 for (offset
= start
; offset
<= end
; offset
++) {
1026 if (notes
->offsets
[offset
])
1032 static void annotation__count_and_fill(struct annotation
*notes
, u64 start
, u64 end
, struct cyc_hist
*ch
)
1035 unsigned int cover_insn
= 0;
1038 n_insn
= annotation__count_insn(notes
, start
, end
);
1039 if (n_insn
&& ch
->num
&& ch
->cycles
) {
1040 float ipc
= n_insn
/ ((double)ch
->cycles
/ (double)ch
->num
);
1042 /* Hide data when there are too many overlaps. */
1043 if (ch
->reset
>= 0x7fff)
1046 for (offset
= start
; offset
<= end
; offset
++) {
1047 struct annotation_line
*al
= notes
->offsets
[offset
];
1049 if (al
&& al
->ipc
== 0.0) {
1056 notes
->hit_cycles
+= ch
->cycles
;
1057 notes
->hit_insn
+= n_insn
* ch
->num
;
1058 notes
->cover_insn
+= cover_insn
;
1063 void annotation__compute_ipc(struct annotation
*notes
, size_t size
)
1067 if (!notes
->src
|| !notes
->src
->cycles_hist
)
1070 notes
->total_insn
= annotation__count_insn(notes
, 0, size
- 1);
1071 notes
->hit_cycles
= 0;
1072 notes
->hit_insn
= 0;
1073 notes
->cover_insn
= 0;
1075 pthread_mutex_lock(¬es
->lock
);
1076 for (offset
= size
- 1; offset
>= 0; --offset
) {
1077 struct cyc_hist
*ch
;
1079 ch
= ¬es
->src
->cycles_hist
[offset
];
1080 if (ch
&& ch
->cycles
) {
1081 struct annotation_line
*al
;
1084 annotation__count_and_fill(notes
, ch
->start
, offset
, ch
);
1085 al
= notes
->offsets
[offset
];
1086 if (al
&& ch
->num_aggr
) {
1087 al
->cycles
= ch
->cycles_aggr
/ ch
->num_aggr
;
1088 al
->cycles_max
= ch
->cycles_max
;
1089 al
->cycles_min
= ch
->cycles_min
;
1091 notes
->have_cycles
= true;
1094 pthread_mutex_unlock(¬es
->lock
);
1097 int addr_map_symbol__inc_samples(struct addr_map_symbol
*ams
, struct perf_sample
*sample
,
1098 struct evsel
*evsel
)
1100 return symbol__inc_addr_samples(&ams
->ms
, evsel
, ams
->al_addr
, sample
);
1103 int hist_entry__inc_addr_samples(struct hist_entry
*he
, struct perf_sample
*sample
,
1104 struct evsel
*evsel
, u64 ip
)
1106 return symbol__inc_addr_samples(&he
->ms
, evsel
, ip
, sample
);
1109 static void disasm_line__init_ins(struct disasm_line
*dl
, struct arch
*arch
, struct map_symbol
*ms
)
1111 dl
->ins
.ops
= ins__find(arch
, dl
->ins
.name
);
1116 if (dl
->ins
.ops
->parse
&& dl
->ins
.ops
->parse(arch
, &dl
->ops
, ms
) < 0)
1120 static int disasm_line__parse(char *line
, const char **namep
, char **rawp
)
1122 char tmp
, *name
= skip_spaces(line
);
1124 if (name
[0] == '\0')
1129 while ((*rawp
)[0] != '\0' && !isspace((*rawp
)[0]))
1134 *namep
= strdup(name
);
1140 *rawp
= strim(*rawp
);
1148 struct annotate_args
{
1150 struct map_symbol ms
;
1151 struct evsel
*evsel
;
1152 struct annotation_options
*options
;
1158 static void annotation_line__init(struct annotation_line
*al
,
1159 struct annotate_args
*args
,
1162 al
->offset
= args
->offset
;
1163 al
->line
= strdup(args
->line
);
1164 al
->line_nr
= args
->line_nr
;
1168 static void annotation_line__exit(struct annotation_line
*al
)
1170 free_srcline(al
->path
);
1174 static size_t disasm_line_size(int nr
)
1176 struct annotation_line
*al
;
1178 return (sizeof(struct disasm_line
) + (sizeof(al
->data
[0]) * nr
));
1182 * Allocating the disasm annotation line data with
1183 * following structure:
1185 * -------------------------------------------
1186 * struct disasm_line | struct annotation_line
1187 * -------------------------------------------
1189 * We have 'struct annotation_line' member as last member
1190 * of 'struct disasm_line' to have an easy access.
1192 static struct disasm_line
*disasm_line__new(struct annotate_args
*args
)
1194 struct disasm_line
*dl
= NULL
;
1197 if (evsel__is_group_event(args
->evsel
))
1198 nr
= args
->evsel
->core
.nr_members
;
1200 dl
= zalloc(disasm_line_size(nr
));
1204 annotation_line__init(&dl
->al
, args
, nr
);
1205 if (dl
->al
.line
== NULL
)
1208 if (args
->offset
!= -1) {
1209 if (disasm_line__parse(dl
->al
.line
, &dl
->ins
.name
, &dl
->ops
.raw
) < 0)
1212 disasm_line__init_ins(dl
, args
->arch
, &args
->ms
);
1218 zfree(&dl
->al
.line
);
1224 void disasm_line__free(struct disasm_line
*dl
)
1226 if (dl
->ins
.ops
&& dl
->ins
.ops
->free
)
1227 dl
->ins
.ops
->free(&dl
->ops
);
1229 ins__delete(&dl
->ops
);
1230 zfree(&dl
->ins
.name
);
1231 annotation_line__exit(&dl
->al
);
1235 int disasm_line__scnprintf(struct disasm_line
*dl
, char *bf
, size_t size
, bool raw
, int max_ins_name
)
1237 if (raw
|| !dl
->ins
.ops
)
1238 return scnprintf(bf
, size
, "%-*s %s", max_ins_name
, dl
->ins
.name
, dl
->ops
.raw
);
1240 return ins__scnprintf(&dl
->ins
, bf
, size
, &dl
->ops
, max_ins_name
);
1243 static void annotation_line__add(struct annotation_line
*al
, struct list_head
*head
)
1245 list_add_tail(&al
->node
, head
);
1248 struct annotation_line
*
1249 annotation_line__next(struct annotation_line
*pos
, struct list_head
*head
)
1251 list_for_each_entry_continue(pos
, head
, node
)
1252 if (pos
->offset
>= 0)
1258 static const char *annotate__address_color(struct block_range
*br
)
1260 double cov
= block_range__coverage(br
);
1263 /* mark red for >75% coverage */
1265 return PERF_COLOR_RED
;
1267 /* mark dull for <1% coverage */
1269 return PERF_COLOR_NORMAL
;
1272 return PERF_COLOR_MAGENTA
;
1275 static const char *annotate__asm_color(struct block_range
*br
)
1277 double cov
= block_range__coverage(br
);
1280 /* mark dull for <1% coverage */
1282 return PERF_COLOR_NORMAL
;
1285 return PERF_COLOR_BLUE
;
1288 static void annotate__branch_printf(struct block_range
*br
, u64 addr
)
1290 bool emit_comment
= true;
1296 if (br
->is_target
&& br
->start
== addr
) {
1297 struct block_range
*branch
= br
;
1301 * Find matching branch to our target.
1303 while (!branch
->is_branch
)
1304 branch
= block_range__next(branch
);
1306 p
= 100 *(double)br
->entry
/ branch
->coverage
;
1310 emit_comment
= false;
1315 * The percentage of coverage joined at this target in relation
1316 * to the next branch.
1318 printf(" +%.2f%%", p
);
1322 if (br
->is_branch
&& br
->end
== addr
) {
1323 double p
= 100*(double)br
->taken
/ br
->coverage
;
1327 emit_comment
= false;
1332 * The percentage of coverage leaving at this branch, and
1333 * its prediction ratio.
1335 printf(" -%.2f%% (p:%.2f%%)", p
, 100*(double)br
->pred
/ br
->taken
);
1340 static int disasm_line__print(struct disasm_line
*dl
, u64 start
, int addr_fmt_width
)
1342 s64 offset
= dl
->al
.offset
;
1343 const u64 addr
= start
+ offset
;
1344 struct block_range
*br
;
1346 br
= block_range__find(addr
);
1347 color_fprintf(stdout
, annotate__address_color(br
), " %*" PRIx64
":", addr_fmt_width
, addr
);
1348 color_fprintf(stdout
, annotate__asm_color(br
), "%s", dl
->al
.line
);
1349 annotate__branch_printf(br
, addr
);
1354 annotation_line__print(struct annotation_line
*al
, struct symbol
*sym
, u64 start
,
1355 struct evsel
*evsel
, u64 len
, int min_pcnt
, int printed
,
1356 int max_lines
, struct annotation_line
*queue
, int addr_fmt_width
,
1359 struct disasm_line
*dl
= container_of(al
, struct disasm_line
, al
);
1360 static const char *prev_line
;
1361 static const char *prev_color
;
1363 if (al
->offset
!= -1) {
1364 double max_percent
= 0.0;
1365 int i
, nr_percent
= 1;
1367 struct annotation
*notes
= symbol__annotation(sym
);
1369 for (i
= 0; i
< al
->data_nr
; i
++) {
1372 percent
= annotation_data__percent(&al
->data
[i
],
1375 if (percent
> max_percent
)
1376 max_percent
= percent
;
1379 if (al
->data_nr
> nr_percent
)
1380 nr_percent
= al
->data_nr
;
1382 if (max_percent
< min_pcnt
)
1385 if (max_lines
&& printed
>= max_lines
)
1388 if (queue
!= NULL
) {
1389 list_for_each_entry_from(queue
, ¬es
->src
->source
, node
) {
1392 annotation_line__print(queue
, sym
, start
, evsel
, len
,
1393 0, 0, 1, NULL
, addr_fmt_width
,
1398 color
= get_percent_color(max_percent
);
1401 * Also color the filename and line if needed, with
1402 * the same color than the percentage. Don't print it
1403 * twice for close colored addr with the same filename:line
1406 if (!prev_line
|| strcmp(prev_line
, al
->path
)
1407 || color
!= prev_color
) {
1408 color_fprintf(stdout
, color
, " %s", al
->path
);
1409 prev_line
= al
->path
;
1414 for (i
= 0; i
< nr_percent
; i
++) {
1415 struct annotation_data
*data
= &al
->data
[i
];
1418 percent
= annotation_data__percent(data
, percent_type
);
1419 color
= get_percent_color(percent
);
1421 if (symbol_conf
.show_total_period
)
1422 color_fprintf(stdout
, color
, " %11" PRIu64
,
1424 else if (symbol_conf
.show_nr_samples
)
1425 color_fprintf(stdout
, color
, " %7" PRIu64
,
1426 data
->he
.nr_samples
);
1428 color_fprintf(stdout
, color
, " %7.2f", percent
);
1433 disasm_line__print(dl
, start
, addr_fmt_width
);
1435 } else if (max_lines
&& printed
>= max_lines
)
1438 int width
= symbol_conf
.show_total_period
? 12 : 8;
1443 if (evsel__is_group_event(evsel
))
1444 width
*= evsel
->core
.nr_members
;
1447 printf(" %*s:\n", width
, " ");
1449 printf(" %*s: %*s %s\n", width
, " ", addr_fmt_width
, " ", al
->line
);
1456 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1457 * which looks like following
1459 * 0000000000415500 <_init>:
1460 * 415500: sub $0x8,%rsp
1461 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1462 * 41550b: test %rax,%rax
1463 * 41550e: je 415515 <_init+0x15>
1464 * 415510: callq 416e70 <__gmon_start__@plt>
1465 * 415515: add $0x8,%rsp
1468 * it will be parsed and saved into struct disasm_line as
1469 * <offset> <name> <ops.raw>
1471 * The offset will be a relative offset from the start of the symbol and -1
1472 * means that it's not a disassembly line so should be treated differently.
1473 * The ops.raw part will be parsed further according to type of the instruction.
1475 static int symbol__parse_objdump_line(struct symbol
*sym
,
1476 struct annotate_args
*args
,
1477 char *parsed_line
, int *line_nr
)
1479 struct map
*map
= args
->ms
.map
;
1480 struct annotation
*notes
= symbol__annotation(sym
);
1481 struct disasm_line
*dl
;
1483 s64 line_ip
, offset
= -1;
1484 regmatch_t match
[2];
1486 /* /filename:linenr ? Save line number and ignore. */
1487 if (regexec(&file_lineno
, parsed_line
, 2, match
, 0) == 0) {
1488 *line_nr
= atoi(parsed_line
+ match
[1].rm_so
);
1492 /* Process hex address followed by ':'. */
1493 line_ip
= strtoull(parsed_line
, &tmp
, 16);
1494 if (parsed_line
!= tmp
&& tmp
[0] == ':' && tmp
[1] != '\0') {
1495 u64 start
= map__rip_2objdump(map
, sym
->start
),
1496 end
= map__rip_2objdump(map
, sym
->end
);
1498 offset
= line_ip
- start
;
1499 if ((u64
)line_ip
< start
|| (u64
)line_ip
>= end
)
1502 parsed_line
= tmp
+ 1;
1505 args
->offset
= offset
;
1506 args
->line
= parsed_line
;
1507 args
->line_nr
= *line_nr
;
1510 dl
= disasm_line__new(args
);
1516 if (!disasm_line__has_local_offset(dl
)) {
1517 dl
->ops
.target
.offset
= dl
->ops
.target
.addr
-
1518 map__rip_2objdump(map
, sym
->start
);
1519 dl
->ops
.target
.offset_avail
= true;
1522 /* kcore has no symbols, so add the call target symbol */
1523 if (dl
->ins
.ops
&& ins__is_call(&dl
->ins
) && !dl
->ops
.target
.sym
) {
1524 struct addr_map_symbol target
= {
1525 .addr
= dl
->ops
.target
.addr
,
1526 .ms
= { .map
= map
, },
1529 if (!maps__find_ams(args
->ms
.maps
, &target
) &&
1530 target
.ms
.sym
->start
== target
.al_addr
)
1531 dl
->ops
.target
.sym
= target
.ms
.sym
;
1534 annotation_line__add(&dl
->al
, ¬es
->src
->source
);
1539 static __attribute__((constructor
)) void symbol__init_regexpr(void)
1541 regcomp(&file_lineno
, "^/[^:]+:([0-9]+)", REG_EXTENDED
);
1544 static void delete_last_nop(struct symbol
*sym
)
1546 struct annotation
*notes
= symbol__annotation(sym
);
1547 struct list_head
*list
= ¬es
->src
->source
;
1548 struct disasm_line
*dl
;
1550 while (!list_empty(list
)) {
1551 dl
= list_entry(list
->prev
, struct disasm_line
, al
.node
);
1554 if (dl
->ins
.ops
!= &nop_ops
)
1557 if (!strstr(dl
->al
.line
, " nop ") &&
1558 !strstr(dl
->al
.line
, " nopl ") &&
1559 !strstr(dl
->al
.line
, " nopw "))
1563 list_del_init(&dl
->al
.node
);
1564 disasm_line__free(dl
);
1568 int symbol__strerror_disassemble(struct map_symbol
*ms
, int errnum
, char *buf
, size_t buflen
)
1570 struct dso
*dso
= ms
->map
->dso
;
1572 BUG_ON(buflen
== 0);
1575 str_error_r(errnum
, buf
, buflen
);
1580 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX
: {
1581 char bf
[SBUILD_ID_SIZE
+ 15] = " with build id ";
1582 char *build_id_msg
= NULL
;
1584 if (dso
->has_build_id
) {
1585 build_id__sprintf(&dso
->bid
, bf
+ 15);
1588 scnprintf(buf
, buflen
,
1589 "No vmlinux file%s\nwas found in the path.\n\n"
1590 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1592 " perf buildid-cache -vu vmlinux\n\n"
1594 " --vmlinux vmlinux\n", build_id_msg
?: "");
1597 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF
:
1598 scnprintf(buf
, buflen
, "Please link with binutils's libopcode to enable BPF annotation");
1600 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP
:
1601 scnprintf(buf
, buflen
, "Problems with arch specific instruction name regular expressions.");
1603 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING
:
1604 scnprintf(buf
, buflen
, "Problems while parsing the CPUID in the arch specific initialization.");
1606 case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE
:
1607 scnprintf(buf
, buflen
, "Invalid BPF file: %s.", dso
->long_name
);
1609 case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF
:
1610 scnprintf(buf
, buflen
, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1614 scnprintf(buf
, buflen
, "Internal error: Invalid %d error code\n", errnum
);
1621 static int dso__disassemble_filename(struct dso
*dso
, char *filename
, size_t filename_size
)
1623 char linkname
[PATH_MAX
];
1624 char *build_id_filename
;
1625 char *build_id_path
= NULL
;
1629 if (dso
->symtab_type
== DSO_BINARY_TYPE__KALLSYMS
&&
1630 !dso__is_kcore(dso
))
1631 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX
;
1633 build_id_filename
= dso__build_id_filename(dso
, NULL
, 0, false);
1634 if (build_id_filename
) {
1635 __symbol__join_symfs(filename
, filename_size
, build_id_filename
);
1636 free(build_id_filename
);
1638 if (dso
->has_build_id
)
1643 build_id_path
= strdup(filename
);
1648 * old style build-id cache has name of XX/XXXXXXX.. while
1649 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1650 * extract the build-id part of dirname in the new style only.
1652 pos
= strrchr(build_id_path
, '/');
1653 if (pos
&& strlen(pos
) < SBUILD_ID_SIZE
- 2)
1654 dirname(build_id_path
);
1656 if (dso__is_kcore(dso
))
1659 len
= readlink(build_id_path
, linkname
, sizeof(linkname
) - 1);
1663 linkname
[len
] = '\0';
1664 if (strstr(linkname
, DSO__NAME_KALLSYMS
) ||
1665 access(filename
, R_OK
)) {
1668 * If we don't have build-ids or the build-id file isn't in the
1669 * cache, or is just a kallsyms file, well, lets hope that this
1670 * DSO is the same as when 'perf record' ran.
1672 __symbol__join_symfs(filename
, filename_size
, dso
->long_name
);
1675 free(build_id_path
);
1679 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1680 #define PACKAGE "perf"
1682 #include <dis-asm.h>
1683 #include <bpf/bpf.h>
1684 #include <bpf/btf.h>
1685 #include <bpf/libbpf.h>
1686 #include <linux/btf.h>
1688 static int symbol__disassemble_bpf(struct symbol
*sym
,
1689 struct annotate_args
*args
)
1691 struct annotation
*notes
= symbol__annotation(sym
);
1692 struct annotation_options
*opts
= args
->options
;
1693 struct bpf_prog_info_linear
*info_linear
;
1694 struct bpf_prog_linfo
*prog_linfo
= NULL
;
1695 struct bpf_prog_info_node
*info_node
;
1696 int len
= sym
->end
- sym
->start
;
1697 disassembler_ftype disassemble
;
1698 struct map
*map
= args
->ms
.map
;
1699 struct disassemble_info info
;
1700 struct dso
*dso
= map
->dso
;
1701 int pc
= 0, count
, sub_id
;
1702 struct btf
*btf
= NULL
;
1703 char tpath
[PATH_MAX
];
1711 if (dso
->binary_type
!= DSO_BINARY_TYPE__BPF_PROG_INFO
)
1712 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE
;
1714 pr_debug("%s: handling sym %s addr %" PRIx64
" len %" PRIx64
"\n", __func__
,
1715 sym
->name
, sym
->start
, sym
->end
- sym
->start
);
1717 memset(tpath
, 0, sizeof(tpath
));
1718 perf_exe(tpath
, sizeof(tpath
));
1720 bfdf
= bfd_openr(tpath
, NULL
);
1722 assert(bfd_check_format(bfdf
, bfd_object
));
1724 s
= open_memstream(&buf
, &buf_size
);
1729 init_disassemble_info(&info
, s
,
1730 (fprintf_ftype
) fprintf
);
1732 info
.arch
= bfd_get_arch(bfdf
);
1733 info
.mach
= bfd_get_mach(bfdf
);
1735 info_node
= perf_env__find_bpf_prog_info(dso
->bpf_prog
.env
,
1738 ret
= SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF
;
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)
1838 symbol__disassemble_bpf_image(struct symbol
*sym
,
1839 struct annotate_args
*args
)
1841 struct annotation
*notes
= symbol__annotation(sym
);
1842 struct disasm_line
*dl
;
1845 args
->line
= strdup("to be implemented");
1847 dl
= disasm_line__new(args
);
1849 annotation_line__add(&dl
->al
, ¬es
->src
->source
);
1856 * Possibly create a new version of line with tabs expanded. Returns the
1857 * existing or new line, storage is updated if a new line is allocated. If
1858 * allocation fails then NULL is returned.
1860 static char *expand_tabs(char *line
, char **storage
, size_t *storage_len
)
1862 size_t i
, src
, dst
, len
, new_storage_len
, num_tabs
;
1864 size_t line_len
= strlen(line
);
1866 for (num_tabs
= 0, i
= 0; i
< line_len
; i
++)
1867 if (line
[i
] == '\t')
1874 * Space for the line and '\0', less the leading and trailing
1875 * spaces. Each tab may introduce 7 additional spaces.
1877 new_storage_len
= line_len
+ 1 + (num_tabs
* 7);
1879 new_line
= malloc(new_storage_len
);
1880 if (new_line
== NULL
) {
1881 pr_err("Failure allocating memory for tab expansion\n");
1886 * Copy regions starting at src and expand tabs. If there are two
1887 * adjacent tabs then 'src == i', the memcpy is of size 0 and the spaces
1890 for (i
= 0, src
= 0, dst
= 0; i
< line_len
&& num_tabs
; i
++) {
1891 if (line
[i
] == '\t') {
1893 memcpy(&new_line
[dst
], &line
[src
], len
);
1895 new_line
[dst
++] = ' ';
1896 while (dst
% 8 != 0)
1897 new_line
[dst
++] = ' ';
1903 /* Expand the last region. */
1904 len
= line_len
- src
;
1905 memcpy(&new_line
[dst
], &line
[src
], len
);
1907 new_line
[dst
] = '\0';
1910 *storage
= new_line
;
1911 *storage_len
= new_storage_len
;
1916 static int symbol__disassemble(struct symbol
*sym
, struct annotate_args
*args
)
1918 struct annotation_options
*opts
= args
->options
;
1919 struct map
*map
= args
->ms
.map
;
1920 struct dso
*dso
= map
->dso
;
1923 char symfs_filename
[PATH_MAX
];
1924 struct kcore_extract kce
;
1925 bool delete_extract
= false;
1926 bool decomp
= false;
1931 const char *objdump_argv
[] = {
1934 NULL
, /* Will be the objdump command to run. */
1936 NULL
, /* Will be the symfs path. */
1939 struct child_process objdump_process
;
1940 int err
= dso__disassemble_filename(dso
, symfs_filename
, sizeof(symfs_filename
));
1945 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64
", end=%#" PRIx64
"\n", __func__
,
1946 symfs_filename
, sym
->name
, map
->unmap_ip(map
, sym
->start
),
1947 map
->unmap_ip(map
, sym
->end
));
1949 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1950 dso
, dso
->long_name
, sym
, sym
->name
);
1952 if (dso
->binary_type
== DSO_BINARY_TYPE__BPF_PROG_INFO
) {
1953 return symbol__disassemble_bpf(sym
, args
);
1954 } else if (dso
->binary_type
== DSO_BINARY_TYPE__BPF_IMAGE
) {
1955 return symbol__disassemble_bpf_image(sym
, args
);
1956 } else if (dso__is_kcore(dso
)) {
1957 kce
.kcore_filename
= symfs_filename
;
1958 kce
.addr
= map__rip_2objdump(map
, sym
->start
);
1959 kce
.offs
= sym
->start
;
1960 kce
.len
= sym
->end
- sym
->start
;
1961 if (!kcore_extract__create(&kce
)) {
1962 delete_extract
= true;
1963 strlcpy(symfs_filename
, kce
.extract_filename
,
1964 sizeof(symfs_filename
));
1966 } else if (dso__needs_decompress(dso
)) {
1967 char tmp
[KMOD_DECOMP_LEN
];
1969 if (dso__decompress_kmodule_path(dso
, symfs_filename
,
1970 tmp
, sizeof(tmp
)) < 0)
1974 strcpy(symfs_filename
, tmp
);
1977 err
= asprintf(&command
,
1978 "%s %s%s --start-address=0x%016" PRIx64
1979 " --stop-address=0x%016" PRIx64
1980 " -l -d %s %s %s %c%s%c %s%s -C \"$1\"",
1981 opts
->objdump_path
?: "objdump",
1982 opts
->disassembler_style
? "-M " : "",
1983 opts
->disassembler_style
?: "",
1984 map__rip_2objdump(map
, sym
->start
),
1985 map__rip_2objdump(map
, sym
->end
),
1986 opts
->show_asm_raw
? "" : "--no-show-raw-insn",
1987 opts
->annotate_src
? "-S" : "",
1988 opts
->prefix
? "--prefix " : "",
1989 opts
->prefix
? '"' : ' ',
1991 opts
->prefix
? '"' : ' ',
1992 opts
->prefix_strip
? "--prefix-strip=" : "",
1993 opts
->prefix_strip
?: "");
1996 pr_err("Failure allocating memory for the command to run\n");
1997 goto out_remove_tmp
;
2000 pr_debug("Executing: %s\n", command
);
2002 objdump_argv
[2] = command
;
2003 objdump_argv
[4] = symfs_filename
;
2005 /* Create a pipe to read from for stdout */
2006 memset(&objdump_process
, 0, sizeof(objdump_process
));
2007 objdump_process
.argv
= objdump_argv
;
2008 objdump_process
.out
= -1;
2009 if (start_command(&objdump_process
)) {
2010 pr_err("Failure starting to run %s\n", command
);
2012 goto out_free_command
;
2015 file
= fdopen(objdump_process
.out
, "r");
2017 pr_err("Failure creating FILE stream for %s\n", command
);
2019 * If we were using debug info should retry with
2023 goto out_close_stdout
;
2026 /* Storage for getline. */
2031 while (!feof(file
)) {
2033 char *expanded_line
;
2035 if (getline(&line
, &line_len
, file
) < 0 || !line
)
2038 /* Skip lines containing "filename:" */
2039 match
= strstr(line
, symfs_filename
);
2040 if (match
&& match
[strlen(symfs_filename
)] == ':')
2043 expanded_line
= strim(line
);
2044 expanded_line
= expand_tabs(expanded_line
, &line
, &line_len
);
2049 * The source code line number (lineno) needs to be kept in
2050 * across calls to symbol__parse_objdump_line(), so that it
2051 * can associate it with the instructions till the next one.
2052 * See disasm_line__new() and struct disasm_line::line_nr.
2054 if (symbol__parse_objdump_line(sym
, args
, expanded_line
,
2061 err
= finish_command(&objdump_process
);
2063 pr_err("Error running %s\n", command
);
2067 pr_err("No output from %s\n", command
);
2071 * kallsyms does not have symbol sizes so there may a nop at the end.
2074 if (dso__is_kcore(dso
))
2075 delete_last_nop(sym
);
2080 close(objdump_process
.out
);
2087 unlink(symfs_filename
);
2090 kcore_extract__delete(&kce
);
2095 static void calc_percent(struct sym_hist
*sym_hist
,
2096 struct hists
*hists
,
2097 struct annotation_data
*data
,
2098 s64 offset
, s64 end
)
2100 unsigned int hits
= 0;
2103 while (offset
< end
) {
2104 hits
+= sym_hist
->addr
[offset
].nr_samples
;
2105 period
+= sym_hist
->addr
[offset
].period
;
2109 if (sym_hist
->nr_samples
) {
2110 data
->he
.period
= period
;
2111 data
->he
.nr_samples
= hits
;
2112 data
->percent
[PERCENT_HITS_LOCAL
] = 100.0 * hits
/ sym_hist
->nr_samples
;
2115 if (hists
->stats
.nr_non_filtered_samples
)
2116 data
->percent
[PERCENT_HITS_GLOBAL
] = 100.0 * hits
/ hists
->stats
.nr_non_filtered_samples
;
2118 if (sym_hist
->period
)
2119 data
->percent
[PERCENT_PERIOD_LOCAL
] = 100.0 * period
/ sym_hist
->period
;
2121 if (hists
->stats
.total_period
)
2122 data
->percent
[PERCENT_PERIOD_GLOBAL
] = 100.0 * period
/ hists
->stats
.total_period
;
2125 static void annotation__calc_percent(struct annotation
*notes
,
2126 struct evsel
*leader
, s64 len
)
2128 struct annotation_line
*al
, *next
;
2129 struct evsel
*evsel
;
2131 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2135 if (al
->offset
== -1)
2138 next
= annotation_line__next(al
, ¬es
->src
->source
);
2139 end
= next
? next
->offset
: len
;
2141 for_each_group_evsel(evsel
, leader
) {
2142 struct hists
*hists
= evsel__hists(evsel
);
2143 struct annotation_data
*data
;
2144 struct sym_hist
*sym_hist
;
2146 BUG_ON(i
>= al
->data_nr
);
2148 sym_hist
= annotation__histogram(notes
, evsel
->idx
);
2149 data
= &al
->data
[i
++];
2151 calc_percent(sym_hist
, hists
, data
, al
->offset
, end
);
2156 void symbol__calc_percent(struct symbol
*sym
, struct evsel
*evsel
)
2158 struct annotation
*notes
= symbol__annotation(sym
);
2160 annotation__calc_percent(notes
, evsel
, symbol__size(sym
));
2163 int symbol__annotate(struct map_symbol
*ms
, struct evsel
*evsel
,
2164 struct annotation_options
*options
, struct arch
**parch
)
2166 struct symbol
*sym
= ms
->sym
;
2167 struct annotation
*notes
= symbol__annotation(sym
);
2168 struct annotate_args args
= {
2172 struct perf_env
*env
= evsel__env(evsel
);
2173 const char *arch_name
= perf_env__arch(env
);
2180 args
.arch
= arch
= arch__find(arch_name
);
2188 err
= arch
->init(arch
, env
? env
->cpuid
: NULL
);
2190 pr_err("%s: failed to initialize %s arch priv area\n", __func__
, arch
->name
);
2196 notes
->start
= map__rip_2objdump(ms
->map
, sym
->start
);
2198 return symbol__disassemble(sym
, &args
);
2201 static void insert_source_line(struct rb_root
*root
, struct annotation_line
*al
,
2202 struct annotation_options
*opts
)
2204 struct annotation_line
*iter
;
2205 struct rb_node
**p
= &root
->rb_node
;
2206 struct rb_node
*parent
= NULL
;
2209 while (*p
!= NULL
) {
2211 iter
= rb_entry(parent
, struct annotation_line
, rb_node
);
2213 ret
= strcmp(iter
->path
, al
->path
);
2215 for (i
= 0; i
< al
->data_nr
; i
++) {
2216 iter
->data
[i
].percent_sum
+= annotation_data__percent(&al
->data
[i
],
2217 opts
->percent_type
);
2225 p
= &(*p
)->rb_right
;
2228 for (i
= 0; i
< al
->data_nr
; i
++) {
2229 al
->data
[i
].percent_sum
= annotation_data__percent(&al
->data
[i
],
2230 opts
->percent_type
);
2233 rb_link_node(&al
->rb_node
, parent
, p
);
2234 rb_insert_color(&al
->rb_node
, root
);
2237 static int cmp_source_line(struct annotation_line
*a
, struct annotation_line
*b
)
2241 for (i
= 0; i
< a
->data_nr
; i
++) {
2242 if (a
->data
[i
].percent_sum
== b
->data
[i
].percent_sum
)
2244 return a
->data
[i
].percent_sum
> b
->data
[i
].percent_sum
;
2250 static void __resort_source_line(struct rb_root
*root
, struct annotation_line
*al
)
2252 struct annotation_line
*iter
;
2253 struct rb_node
**p
= &root
->rb_node
;
2254 struct rb_node
*parent
= NULL
;
2256 while (*p
!= NULL
) {
2258 iter
= rb_entry(parent
, struct annotation_line
, rb_node
);
2260 if (cmp_source_line(al
, iter
))
2263 p
= &(*p
)->rb_right
;
2266 rb_link_node(&al
->rb_node
, parent
, p
);
2267 rb_insert_color(&al
->rb_node
, root
);
2270 static void resort_source_line(struct rb_root
*dest_root
, struct rb_root
*src_root
)
2272 struct annotation_line
*al
;
2273 struct rb_node
*node
;
2275 node
= rb_first(src_root
);
2277 struct rb_node
*next
;
2279 al
= rb_entry(node
, struct annotation_line
, rb_node
);
2280 next
= rb_next(node
);
2281 rb_erase(node
, src_root
);
2283 __resort_source_line(dest_root
, al
);
2288 static void print_summary(struct rb_root
*root
, const char *filename
)
2290 struct annotation_line
*al
;
2291 struct rb_node
*node
;
2293 printf("\nSorted summary for file %s\n", filename
);
2294 printf("----------------------------------------------\n\n");
2296 if (RB_EMPTY_ROOT(root
)) {
2297 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN
);
2301 node
= rb_first(root
);
2303 double percent
, percent_max
= 0.0;
2308 al
= rb_entry(node
, struct annotation_line
, rb_node
);
2309 for (i
= 0; i
< al
->data_nr
; i
++) {
2310 percent
= al
->data
[i
].percent_sum
;
2311 color
= get_percent_color(percent
);
2312 color_fprintf(stdout
, color
, " %7.2f", percent
);
2314 if (percent
> percent_max
)
2315 percent_max
= percent
;
2319 color
= get_percent_color(percent_max
);
2320 color_fprintf(stdout
, color
, " %s\n", path
);
2322 node
= rb_next(node
);
2326 static void symbol__annotate_hits(struct symbol
*sym
, struct evsel
*evsel
)
2328 struct annotation
*notes
= symbol__annotation(sym
);
2329 struct sym_hist
*h
= annotation__histogram(notes
, evsel
->idx
);
2330 u64 len
= symbol__size(sym
), offset
;
2332 for (offset
= 0; offset
< len
; ++offset
)
2333 if (h
->addr
[offset
].nr_samples
!= 0)
2334 printf("%*" PRIx64
": %" PRIu64
"\n", BITS_PER_LONG
/ 2,
2335 sym
->start
+ offset
, h
->addr
[offset
].nr_samples
);
2336 printf("%*s: %" PRIu64
"\n", BITS_PER_LONG
/ 2, "h->nr_samples", h
->nr_samples
);
2339 static int annotated_source__addr_fmt_width(struct list_head
*lines
, u64 start
)
2342 struct annotation_line
*line
;
2344 list_for_each_entry_reverse(line
, lines
, node
) {
2345 if (line
->offset
!= -1)
2346 return scnprintf(bf
, sizeof(bf
), "%" PRIx64
, start
+ line
->offset
);
2352 int symbol__annotate_printf(struct map_symbol
*ms
, struct evsel
*evsel
,
2353 struct annotation_options
*opts
)
2355 struct map
*map
= ms
->map
;
2356 struct symbol
*sym
= ms
->sym
;
2357 struct dso
*dso
= map
->dso
;
2359 const char *d_filename
;
2360 const char *evsel_name
= evsel__name(evsel
);
2361 struct annotation
*notes
= symbol__annotation(sym
);
2362 struct sym_hist
*h
= annotation__histogram(notes
, evsel
->idx
);
2363 struct annotation_line
*pos
, *queue
= NULL
;
2364 u64 start
= map__rip_2objdump(map
, sym
->start
);
2365 int printed
= 2, queue_len
= 0, addr_fmt_width
;
2367 bool context
= opts
->context
;
2369 int width
= symbol_conf
.show_total_period
? 12 : 8;
2370 int graph_dotted_len
;
2373 filename
= strdup(dso
->long_name
);
2377 if (opts
->full_path
)
2378 d_filename
= filename
;
2380 d_filename
= basename(filename
);
2382 len
= symbol__size(sym
);
2384 if (evsel__is_group_event(evsel
)) {
2385 width
*= evsel
->core
.nr_members
;
2386 evsel__group_desc(evsel
, buf
, sizeof(buf
));
2390 graph_dotted_len
= printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64
" samples, "
2392 width
, width
, symbol_conf
.show_total_period
? "Period" :
2393 symbol_conf
.show_nr_samples
? "Samples" : "Percent",
2394 d_filename
, evsel_name
, h
->nr_samples
,
2395 percent_type_str(opts
->percent_type
));
2397 printf("%-*.*s----\n",
2398 graph_dotted_len
, graph_dotted_len
, graph_dotted_line
);
2401 symbol__annotate_hits(sym
, evsel
);
2403 addr_fmt_width
= annotated_source__addr_fmt_width(¬es
->src
->source
, start
);
2405 list_for_each_entry(pos
, ¬es
->src
->source
, node
) {
2408 if (context
&& queue
== NULL
) {
2413 err
= annotation_line__print(pos
, sym
, start
, evsel
, len
,
2414 opts
->min_pcnt
, printed
, opts
->max_lines
,
2415 queue
, addr_fmt_width
, opts
->percent_type
);
2421 printed
+= queue_len
;
2427 /* filtered by max_lines */
2433 * Filtered by min_pcnt or non IP lines when
2438 if (queue_len
== context
)
2439 queue
= list_entry(queue
->node
.next
, typeof(*queue
), node
);
2451 static void FILE__set_percent_color(void *fp __maybe_unused
,
2452 double percent __maybe_unused
,
2453 bool current __maybe_unused
)
2457 static int FILE__set_jumps_percent_color(void *fp __maybe_unused
,
2458 int nr __maybe_unused
, bool current __maybe_unused
)
2463 static int FILE__set_color(void *fp __maybe_unused
, int color __maybe_unused
)
2468 static void FILE__printf(void *fp
, const char *fmt
, ...)
2472 va_start(args
, fmt
);
2473 vfprintf(fp
, fmt
, args
);
2477 static void FILE__write_graph(void *fp
, int graph
)
2482 case DARROW_CHAR
: s
= "↓"; break;
2483 case UARROW_CHAR
: s
= "↑"; break;
2484 case LARROW_CHAR
: s
= "←"; break;
2485 case RARROW_CHAR
: s
= "→"; break;
2486 default: s
= "?"; break;
2492 static int symbol__annotate_fprintf2(struct symbol
*sym
, FILE *fp
,
2493 struct annotation_options
*opts
)
2495 struct annotation
*notes
= symbol__annotation(sym
);
2496 struct annotation_write_ops wops
= {
2499 .set_color
= FILE__set_color
,
2500 .set_percent_color
= FILE__set_percent_color
,
2501 .set_jumps_percent_color
= FILE__set_jumps_percent_color
,
2502 .printf
= FILE__printf
,
2503 .write_graph
= FILE__write_graph
,
2505 struct annotation_line
*al
;
2507 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2508 if (annotation_line__filter(al
, notes
))
2510 annotation_line__write(al
, notes
, &wops
, opts
);
2512 wops
.first_line
= false;
2518 int map_symbol__annotation_dump(struct map_symbol
*ms
, struct evsel
*evsel
,
2519 struct annotation_options
*opts
)
2521 const char *ev_name
= evsel__name(evsel
);
2527 if (asprintf(&filename
, "%s.annotation", ms
->sym
->name
) < 0)
2530 fp
= fopen(filename
, "w");
2532 goto out_free_filename
;
2534 if (evsel__is_group_event(evsel
)) {
2535 evsel__group_desc(evsel
, buf
, sizeof(buf
));
2539 fprintf(fp
, "%s() %s\nEvent: %s\n\n",
2540 ms
->sym
->name
, ms
->map
->dso
->long_name
, ev_name
);
2541 symbol__annotate_fprintf2(ms
->sym
, fp
, opts
);
2550 void symbol__annotate_zero_histogram(struct symbol
*sym
, int evidx
)
2552 struct annotation
*notes
= symbol__annotation(sym
);
2553 struct sym_hist
*h
= annotation__histogram(notes
, evidx
);
2555 memset(h
, 0, notes
->src
->sizeof_sym_hist
);
2558 void symbol__annotate_decay_histogram(struct symbol
*sym
, int evidx
)
2560 struct annotation
*notes
= symbol__annotation(sym
);
2561 struct sym_hist
*h
= annotation__histogram(notes
, evidx
);
2562 int len
= symbol__size(sym
), offset
;
2565 for (offset
= 0; offset
< len
; ++offset
) {
2566 h
->addr
[offset
].nr_samples
= h
->addr
[offset
].nr_samples
* 7 / 8;
2567 h
->nr_samples
+= h
->addr
[offset
].nr_samples
;
2571 void annotated_source__purge(struct annotated_source
*as
)
2573 struct annotation_line
*al
, *n
;
2575 list_for_each_entry_safe(al
, n
, &as
->source
, node
) {
2576 list_del_init(&al
->node
);
2577 disasm_line__free(disasm_line(al
));
2581 static size_t disasm_line__fprintf(struct disasm_line
*dl
, FILE *fp
)
2585 if (dl
->al
.offset
== -1)
2586 return fprintf(fp
, "%s\n", dl
->al
.line
);
2588 printed
= fprintf(fp
, "%#" PRIx64
" %s", dl
->al
.offset
, dl
->ins
.name
);
2590 if (dl
->ops
.raw
[0] != '\0') {
2591 printed
+= fprintf(fp
, "%.*s %s\n", 6 - (int)printed
, " ",
2595 return printed
+ fprintf(fp
, "\n");
2598 size_t disasm__fprintf(struct list_head
*head
, FILE *fp
)
2600 struct disasm_line
*pos
;
2603 list_for_each_entry(pos
, head
, al
.node
)
2604 printed
+= disasm_line__fprintf(pos
, fp
);
2609 bool disasm_line__is_valid_local_jump(struct disasm_line
*dl
, struct symbol
*sym
)
2611 if (!dl
|| !dl
->ins
.ops
|| !ins__is_jump(&dl
->ins
) ||
2612 !disasm_line__has_local_offset(dl
) || dl
->ops
.target
.offset
< 0 ||
2613 dl
->ops
.target
.offset
>= (s64
)symbol__size(sym
))
2619 void annotation__mark_jump_targets(struct annotation
*notes
, struct symbol
*sym
)
2621 u64 offset
, size
= symbol__size(sym
);
2623 /* PLT symbols contain external offsets */
2624 if (strstr(sym
->name
, "@plt"))
2627 for (offset
= 0; offset
< size
; ++offset
) {
2628 struct annotation_line
*al
= notes
->offsets
[offset
];
2629 struct disasm_line
*dl
;
2631 dl
= disasm_line(al
);
2633 if (!disasm_line__is_valid_local_jump(dl
, sym
))
2636 al
= notes
->offsets
[dl
->ops
.target
.offset
];
2639 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2640 * have to adjust to the previous offset?
2645 if (++al
->jump_sources
> notes
->max_jump_sources
)
2646 notes
->max_jump_sources
= al
->jump_sources
;
2650 void annotation__set_offsets(struct annotation
*notes
, s64 size
)
2652 struct annotation_line
*al
;
2654 notes
->max_line_len
= 0;
2655 notes
->nr_entries
= 0;
2656 notes
->nr_asm_entries
= 0;
2658 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2659 size_t line_len
= strlen(al
->line
);
2661 if (notes
->max_line_len
< line_len
)
2662 notes
->max_line_len
= line_len
;
2663 al
->idx
= notes
->nr_entries
++;
2664 if (al
->offset
!= -1) {
2665 al
->idx_asm
= notes
->nr_asm_entries
++;
2667 * FIXME: short term bandaid to cope with assembly
2668 * routines that comes with labels in the same column
2669 * as the address in objdump, sigh.
2671 * E.g. copy_user_generic_unrolled
2673 if (al
->offset
< size
)
2674 notes
->offsets
[al
->offset
] = al
;
2680 static inline int width_jumps(int n
)
2689 static int annotation__max_ins_name(struct annotation
*notes
)
2691 int max_name
= 0, len
;
2692 struct annotation_line
*al
;
2694 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2695 if (al
->offset
== -1)
2698 len
= strlen(disasm_line(al
)->ins
.name
);
2706 void annotation__init_column_widths(struct annotation
*notes
, struct symbol
*sym
)
2708 notes
->widths
.addr
= notes
->widths
.target
=
2709 notes
->widths
.min_addr
= hex_width(symbol__size(sym
));
2710 notes
->widths
.max_addr
= hex_width(sym
->end
);
2711 notes
->widths
.jumps
= width_jumps(notes
->max_jump_sources
);
2712 notes
->widths
.max_ins_name
= annotation__max_ins_name(notes
);
2715 void annotation__update_column_widths(struct annotation
*notes
)
2717 if (notes
->options
->use_offset
)
2718 notes
->widths
.target
= notes
->widths
.min_addr
;
2720 notes
->widths
.target
= notes
->widths
.max_addr
;
2722 notes
->widths
.addr
= notes
->widths
.target
;
2724 if (notes
->options
->show_nr_jumps
)
2725 notes
->widths
.addr
+= notes
->widths
.jumps
+ 1;
2728 static void annotation__calc_lines(struct annotation
*notes
, struct map
*map
,
2729 struct rb_root
*root
,
2730 struct annotation_options
*opts
)
2732 struct annotation_line
*al
;
2733 struct rb_root tmp_root
= RB_ROOT
;
2735 list_for_each_entry(al
, ¬es
->src
->source
, node
) {
2736 double percent_max
= 0.0;
2739 for (i
= 0; i
< al
->data_nr
; i
++) {
2742 percent
= annotation_data__percent(&al
->data
[i
],
2743 opts
->percent_type
);
2745 if (percent
> percent_max
)
2746 percent_max
= percent
;
2749 if (percent_max
<= 0.5)
2752 al
->path
= get_srcline(map
->dso
, notes
->start
+ al
->offset
, NULL
,
2753 false, true, notes
->start
+ al
->offset
);
2754 insert_source_line(&tmp_root
, al
, opts
);
2757 resort_source_line(root
, &tmp_root
);
2760 static void symbol__calc_lines(struct map_symbol
*ms
, struct rb_root
*root
,
2761 struct annotation_options
*opts
)
2763 struct annotation
*notes
= symbol__annotation(ms
->sym
);
2765 annotation__calc_lines(notes
, ms
->map
, root
, opts
);
2768 int symbol__tty_annotate2(struct map_symbol
*ms
, struct evsel
*evsel
,
2769 struct annotation_options
*opts
)
2771 struct dso
*dso
= ms
->map
->dso
;
2772 struct symbol
*sym
= ms
->sym
;
2773 struct rb_root source_line
= RB_ROOT
;
2774 struct hists
*hists
= evsel__hists(evsel
);
2777 if (symbol__annotate2(ms
, evsel
, opts
, NULL
) < 0)
2780 if (opts
->print_lines
) {
2781 srcline_full_filename
= opts
->full_path
;
2782 symbol__calc_lines(ms
, &source_line
, opts
);
2783 print_summary(&source_line
, dso
->long_name
);
2786 hists__scnprintf_title(hists
, buf
, sizeof(buf
));
2787 fprintf(stdout
, "%s, [percent: %s]\n%s() %s\n",
2788 buf
, percent_type_str(opts
->percent_type
), sym
->name
, dso
->long_name
);
2789 symbol__annotate_fprintf2(sym
, stdout
, opts
);
2791 annotated_source__purge(symbol__annotation(sym
)->src
);
2796 int symbol__tty_annotate(struct map_symbol
*ms
, struct evsel
*evsel
,
2797 struct annotation_options
*opts
)
2799 struct dso
*dso
= ms
->map
->dso
;
2800 struct symbol
*sym
= ms
->sym
;
2801 struct rb_root source_line
= RB_ROOT
;
2803 if (symbol__annotate(ms
, evsel
, opts
, NULL
) < 0)
2806 symbol__calc_percent(sym
, evsel
);
2808 if (opts
->print_lines
) {
2809 srcline_full_filename
= opts
->full_path
;
2810 symbol__calc_lines(ms
, &source_line
, opts
);
2811 print_summary(&source_line
, dso
->long_name
);
2814 symbol__annotate_printf(ms
, evsel
, opts
);
2816 annotated_source__purge(symbol__annotation(sym
)->src
);
2821 bool ui__has_annotation(void)
2823 return use_browser
== 1 && perf_hpp_list
.sym
;
2827 static double annotation_line__max_percent(struct annotation_line
*al
,
2828 struct annotation
*notes
,
2829 unsigned int percent_type
)
2831 double percent_max
= 0.0;
2834 for (i
= 0; i
< notes
->nr_events
; i
++) {
2837 percent
= annotation_data__percent(&al
->data
[i
],
2840 if (percent
> percent_max
)
2841 percent_max
= percent
;
2847 static void disasm_line__write(struct disasm_line
*dl
, struct annotation
*notes
,
2848 void *obj
, char *bf
, size_t size
,
2849 void (*obj__printf
)(void *obj
, const char *fmt
, ...),
2850 void (*obj__write_graph
)(void *obj
, int graph
))
2852 if (dl
->ins
.ops
&& dl
->ins
.ops
->scnprintf
) {
2853 if (ins__is_jump(&dl
->ins
)) {
2856 if (dl
->ops
.target
.outside
)
2858 fwd
= dl
->ops
.target
.offset
> dl
->al
.offset
;
2859 obj__write_graph(obj
, fwd
? DARROW_CHAR
: UARROW_CHAR
);
2860 obj__printf(obj
, " ");
2861 } else if (ins__is_call(&dl
->ins
)) {
2863 obj__write_graph(obj
, RARROW_CHAR
);
2864 obj__printf(obj
, " ");
2865 } else if (ins__is_ret(&dl
->ins
)) {
2866 obj__write_graph(obj
, LARROW_CHAR
);
2867 obj__printf(obj
, " ");
2869 obj__printf(obj
, " ");
2872 obj__printf(obj
, " ");
2875 disasm_line__scnprintf(dl
, bf
, size
, !notes
->options
->use_offset
, notes
->widths
.max_ins_name
);
2878 static void ipc_coverage_string(char *bf
, int size
, struct annotation
*notes
)
2880 double ipc
= 0.0, coverage
= 0.0;
2882 if (notes
->hit_cycles
)
2883 ipc
= notes
->hit_insn
/ ((double)notes
->hit_cycles
);
2885 if (notes
->total_insn
) {
2886 coverage
= notes
->cover_insn
* 100.0 /
2887 ((double)notes
->total_insn
);
2890 scnprintf(bf
, size
, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2894 static void __annotation_line__write(struct annotation_line
*al
, struct annotation
*notes
,
2895 bool first_line
, bool current_entry
, bool change_color
, int width
,
2896 void *obj
, unsigned int percent_type
,
2897 int (*obj__set_color
)(void *obj
, int color
),
2898 void (*obj__set_percent_color
)(void *obj
, double percent
, bool current
),
2899 int (*obj__set_jumps_percent_color
)(void *obj
, int nr
, bool current
),
2900 void (*obj__printf
)(void *obj
, const char *fmt
, ...),
2901 void (*obj__write_graph
)(void *obj
, int graph
))
2904 double percent_max
= annotation_line__max_percent(al
, notes
, percent_type
);
2905 int pcnt_width
= annotation__pcnt_width(notes
),
2906 cycles_width
= annotation__cycles_width(notes
);
2907 bool show_title
= false;
2911 if (first_line
&& (al
->offset
== -1 || percent_max
== 0.0)) {
2912 if (notes
->have_cycles
) {
2913 if (al
->ipc
== 0.0 && al
->cycles
== 0)
2919 if (al
->offset
!= -1 && percent_max
!= 0.0) {
2922 for (i
= 0; i
< notes
->nr_events
; i
++) {
2925 percent
= annotation_data__percent(&al
->data
[i
], percent_type
);
2927 obj__set_percent_color(obj
, percent
, current_entry
);
2928 if (symbol_conf
.show_total_period
) {
2929 obj__printf(obj
, "%11" PRIu64
" ", al
->data
[i
].he
.period
);
2930 } else if (symbol_conf
.show_nr_samples
) {
2931 obj__printf(obj
, "%6" PRIu64
" ",
2932 al
->data
[i
].he
.nr_samples
);
2934 obj__printf(obj
, "%6.2f ", percent
);
2938 obj__set_percent_color(obj
, 0, current_entry
);
2941 obj__printf(obj
, "%-*s", pcnt_width
, " ");
2943 obj__printf(obj
, "%-*s", pcnt_width
,
2944 symbol_conf
.show_total_period
? "Period" :
2945 symbol_conf
.show_nr_samples
? "Samples" : "Percent");
2949 if (notes
->have_cycles
) {
2951 obj__printf(obj
, "%*.2f ", ANNOTATION__IPC_WIDTH
- 1, al
->ipc
);
2952 else if (!show_title
)
2953 obj__printf(obj
, "%*s", ANNOTATION__IPC_WIDTH
, " ");
2955 obj__printf(obj
, "%*s ", ANNOTATION__IPC_WIDTH
- 1, "IPC");
2957 if (!notes
->options
->show_minmax_cycle
) {
2959 obj__printf(obj
, "%*" PRIu64
" ",
2960 ANNOTATION__CYCLES_WIDTH
- 1, al
->cycles
);
2961 else if (!show_title
)
2962 obj__printf(obj
, "%*s",
2963 ANNOTATION__CYCLES_WIDTH
, " ");
2965 obj__printf(obj
, "%*s ",
2966 ANNOTATION__CYCLES_WIDTH
- 1,
2972 scnprintf(str
, sizeof(str
),
2973 "%" PRIu64
"(%" PRIu64
"/%" PRIu64
")",
2974 al
->cycles
, al
->cycles_min
,
2977 obj__printf(obj
, "%*s ",
2978 ANNOTATION__MINMAX_CYCLES_WIDTH
- 1,
2980 } else if (!show_title
)
2981 obj__printf(obj
, "%*s",
2982 ANNOTATION__MINMAX_CYCLES_WIDTH
,
2985 obj__printf(obj
, "%*s ",
2986 ANNOTATION__MINMAX_CYCLES_WIDTH
- 1,
2990 if (show_title
&& !*al
->line
) {
2991 ipc_coverage_string(bf
, sizeof(bf
), notes
);
2992 obj__printf(obj
, "%*s", ANNOTATION__AVG_IPC_WIDTH
, bf
);
2996 obj__printf(obj
, " ");
2999 obj__printf(obj
, "%-*s", width
- pcnt_width
- cycles_width
, " ");
3000 else if (al
->offset
== -1) {
3001 if (al
->line_nr
&& notes
->options
->show_linenr
)
3002 printed
= scnprintf(bf
, sizeof(bf
), "%-*d ", notes
->widths
.addr
+ 1, al
->line_nr
);
3004 printed
= scnprintf(bf
, sizeof(bf
), "%-*s ", notes
->widths
.addr
, " ");
3005 obj__printf(obj
, bf
);
3006 obj__printf(obj
, "%-*s", width
- printed
- pcnt_width
- cycles_width
+ 1, al
->line
);
3008 u64 addr
= al
->offset
;
3011 if (!notes
->options
->use_offset
)
3012 addr
+= notes
->start
;
3014 if (!notes
->options
->use_offset
) {
3015 printed
= scnprintf(bf
, sizeof(bf
), "%" PRIx64
": ", addr
);
3017 if (al
->jump_sources
&&
3018 notes
->options
->offset_level
>= ANNOTATION__OFFSET_JUMP_TARGETS
) {
3019 if (notes
->options
->show_nr_jumps
) {
3021 printed
= scnprintf(bf
, sizeof(bf
), "%*d ",
3022 notes
->widths
.jumps
,
3024 prev
= obj__set_jumps_percent_color(obj
, al
->jump_sources
,
3026 obj__printf(obj
, bf
);
3027 obj__set_color(obj
, prev
);
3030 printed
= scnprintf(bf
, sizeof(bf
), "%*" PRIx64
": ",
3031 notes
->widths
.target
, addr
);
3032 } else if (ins__is_call(&disasm_line(al
)->ins
) &&
3033 notes
->options
->offset_level
>= ANNOTATION__OFFSET_CALL
) {
3035 } else if (notes
->options
->offset_level
== ANNOTATION__MAX_OFFSET_LEVEL
) {
3038 printed
= scnprintf(bf
, sizeof(bf
), "%-*s ",
3039 notes
->widths
.addr
, " ");
3044 color
= obj__set_color(obj
, HE_COLORSET_ADDR
);
3045 obj__printf(obj
, bf
);
3047 obj__set_color(obj
, color
);
3049 disasm_line__write(disasm_line(al
), notes
, obj
, bf
, sizeof(bf
), obj__printf
, obj__write_graph
);
3051 obj__printf(obj
, "%-*s", width
- pcnt_width
- cycles_width
- 3 - printed
, bf
);
3056 void annotation_line__write(struct annotation_line
*al
, struct annotation
*notes
,
3057 struct annotation_write_ops
*wops
,
3058 struct annotation_options
*opts
)
3060 __annotation_line__write(al
, notes
, wops
->first_line
, wops
->current_entry
,
3061 wops
->change_color
, wops
->width
, wops
->obj
,
3063 wops
->set_color
, wops
->set_percent_color
,
3064 wops
->set_jumps_percent_color
, wops
->printf
,
3068 int symbol__annotate2(struct map_symbol
*ms
, struct evsel
*evsel
,
3069 struct annotation_options
*options
, struct arch
**parch
)
3071 struct symbol
*sym
= ms
->sym
;
3072 struct annotation
*notes
= symbol__annotation(sym
);
3073 size_t size
= symbol__size(sym
);
3074 int nr_pcnt
= 1, err
;
3076 notes
->offsets
= zalloc(size
* sizeof(struct annotation_line
*));
3077 if (notes
->offsets
== NULL
)
3080 if (evsel__is_group_event(evsel
))
3081 nr_pcnt
= evsel
->core
.nr_members
;
3083 err
= symbol__annotate(ms
, evsel
, options
, parch
);
3085 goto out_free_offsets
;
3087 notes
->options
= options
;
3089 symbol__calc_percent(sym
, evsel
);
3091 annotation__set_offsets(notes
, size
);
3092 annotation__mark_jump_targets(notes
, sym
);
3093 annotation__compute_ipc(notes
, size
);
3094 annotation__init_column_widths(notes
, sym
);
3095 notes
->nr_events
= nr_pcnt
;
3097 annotation__update_column_widths(notes
);
3098 sym
->annotate2
= true;
3103 zfree(¬es
->offsets
);
3107 static int annotation__config(const char *var
, const char *value
, void *data
)
3109 struct annotation_options
*opt
= data
;
3111 if (!strstarts(var
, "annotate."))
3114 if (!strcmp(var
, "annotate.offset_level")) {
3115 perf_config_u8(&opt
->offset_level
, "offset_level", value
);
3117 if (opt
->offset_level
> ANNOTATION__MAX_OFFSET_LEVEL
)
3118 opt
->offset_level
= ANNOTATION__MAX_OFFSET_LEVEL
;
3119 else if (opt
->offset_level
< ANNOTATION__MIN_OFFSET_LEVEL
)
3120 opt
->offset_level
= ANNOTATION__MIN_OFFSET_LEVEL
;
3121 } else if (!strcmp(var
, "annotate.hide_src_code")) {
3122 opt
->hide_src_code
= perf_config_bool("hide_src_code", value
);
3123 } else if (!strcmp(var
, "annotate.jump_arrows")) {
3124 opt
->jump_arrows
= perf_config_bool("jump_arrows", value
);
3125 } else if (!strcmp(var
, "annotate.show_linenr")) {
3126 opt
->show_linenr
= perf_config_bool("show_linenr", value
);
3127 } else if (!strcmp(var
, "annotate.show_nr_jumps")) {
3128 opt
->show_nr_jumps
= perf_config_bool("show_nr_jumps", value
);
3129 } else if (!strcmp(var
, "annotate.show_nr_samples")) {
3130 symbol_conf
.show_nr_samples
= perf_config_bool("show_nr_samples",
3132 } else if (!strcmp(var
, "annotate.show_total_period")) {
3133 symbol_conf
.show_total_period
= perf_config_bool("show_total_period",
3135 } else if (!strcmp(var
, "annotate.use_offset")) {
3136 opt
->use_offset
= perf_config_bool("use_offset", value
);
3137 } else if (!strcmp(var
, "annotate.disassembler_style")) {
3138 opt
->disassembler_style
= value
;
3140 pr_debug("%s variable unknown, ignoring...", var
);
3146 void annotation_config__init(struct annotation_options
*opt
)
3148 perf_config(annotation__config
, opt
);
3151 static unsigned int parse_percent_type(char *str1
, char *str2
)
3153 unsigned int type
= (unsigned int) -1;
3155 if (!strcmp("period", str1
)) {
3156 if (!strcmp("local", str2
))
3157 type
= PERCENT_PERIOD_LOCAL
;
3158 else if (!strcmp("global", str2
))
3159 type
= PERCENT_PERIOD_GLOBAL
;
3162 if (!strcmp("hits", str1
)) {
3163 if (!strcmp("local", str2
))
3164 type
= PERCENT_HITS_LOCAL
;
3165 else if (!strcmp("global", str2
))
3166 type
= PERCENT_HITS_GLOBAL
;
3172 int annotate_parse_percent_type(const struct option
*opt
, const char *_str
,
3173 int unset __maybe_unused
)
3175 struct annotation_options
*opts
= opt
->value
;
3180 str1
= strdup(_str
);
3184 str2
= strchr(str1
, '-');
3190 type
= parse_percent_type(str1
, str2
);
3191 if (type
== (unsigned int) -1)
3192 type
= parse_percent_type(str2
, str1
);
3193 if (type
!= (unsigned int) -1) {
3194 opts
->percent_type
= type
;
3203 int annotate_check_args(struct annotation_options
*args
)
3205 if (args
->prefix_strip
&& !args
->prefix
) {
3206 pr_err("--prefix-strip requires --prefix\n");