Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
4 *
5 * Parts came from builtin-annotate.c, see those files for further
6 * copyright notes.
7 */
8
9#include <errno.h>
10#include <inttypes.h>
11#include <libgen.h>
12#include <stdlib.h>
13#include "util.h" // hex_width()
14#include "ui/ui.h"
15#include "sort.h"
16#include "build-id.h"
17#include "color.h"
18#include "config.h"
19#include "dso.h"
20#include "env.h"
21#include "map.h"
22#include "maps.h"
23#include "symbol.h"
24#include "srcline.h"
25#include "units.h"
26#include "debug.h"
27#include "annotate.h"
28#include "evsel.h"
29#include "evlist.h"
30#include "bpf-event.h"
31#include "bpf-utils.h"
32#include "block-range.h"
33#include "string2.h"
34#include "util/event.h"
35#include "arch/common.h"
36#include "namespaces.h"
37#include <regex.h>
38#include <linux/bitops.h>
39#include <linux/kernel.h>
40#include <linux/string.h>
41#include <subcmd/parse-options.h>
42#include <subcmd/run-command.h>
43
44/* FIXME: For the HE_COLORSET */
45#include "ui/browser.h"
46
47/*
48 * FIXME: Using the same values as slang.h,
49 * but that header may not be available everywhere
50 */
51#define LARROW_CHAR ((unsigned char)',')
52#define RARROW_CHAR ((unsigned char)'+')
53#define DARROW_CHAR ((unsigned char)'.')
54#define UARROW_CHAR ((unsigned char)'-')
55
56#include <linux/ctype.h>
57
58struct annotation_options annotation__default_options = {
59 .use_offset = true,
60 .jump_arrows = true,
61 .annotate_src = true,
62 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
63 .percent_type = PERCENT_PERIOD_LOCAL,
64};
65
66static regex_t file_lineno;
67
68static struct ins_ops *ins__find(struct arch *arch, const char *name);
69static void ins__sort(struct arch *arch);
70static int disasm_line__parse(char *line, const char **namep, char **rawp);
71
72struct arch {
73 const char *name;
74 struct ins *instructions;
75 size_t nr_instructions;
76 size_t nr_instructions_allocated;
77 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
78 bool sorted_instructions;
79 bool initialized;
80 void *priv;
81 unsigned int model;
82 unsigned int family;
83 int (*init)(struct arch *arch, char *cpuid);
84 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
85 const char *ins2);
86 struct {
87 char comment_char;
88 char skip_functions_char;
89 } objdump;
90};
91
92static struct ins_ops call_ops;
93static struct ins_ops dec_ops;
94static struct ins_ops jump_ops;
95static struct ins_ops mov_ops;
96static struct ins_ops nop_ops;
97static struct ins_ops lock_ops;
98static struct ins_ops ret_ops;
99
100static int arch__grow_instructions(struct arch *arch)
101{
102 struct ins *new_instructions;
103 size_t new_nr_allocated;
104
105 if (arch->nr_instructions_allocated == 0 && arch->instructions)
106 goto grow_from_non_allocated_table;
107
108 new_nr_allocated = arch->nr_instructions_allocated + 128;
109 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
110 if (new_instructions == NULL)
111 return -1;
112
113out_update_instructions:
114 arch->instructions = new_instructions;
115 arch->nr_instructions_allocated = new_nr_allocated;
116 return 0;
117
118grow_from_non_allocated_table:
119 new_nr_allocated = arch->nr_instructions + 128;
120 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
121 if (new_instructions == NULL)
122 return -1;
123
124 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
125 goto out_update_instructions;
126}
127
128static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
129{
130 struct ins *ins;
131
132 if (arch->nr_instructions == arch->nr_instructions_allocated &&
133 arch__grow_instructions(arch))
134 return -1;
135
136 ins = &arch->instructions[arch->nr_instructions];
137 ins->name = strdup(name);
138 if (!ins->name)
139 return -1;
140
141 ins->ops = ops;
142 arch->nr_instructions++;
143
144 ins__sort(arch);
145 return 0;
146}
147
148#include "arch/arc/annotate/instructions.c"
149#include "arch/arm/annotate/instructions.c"
150#include "arch/arm64/annotate/instructions.c"
151#include "arch/csky/annotate/instructions.c"
152#include "arch/mips/annotate/instructions.c"
153#include "arch/x86/annotate/instructions.c"
154#include "arch/powerpc/annotate/instructions.c"
155#include "arch/riscv64/annotate/instructions.c"
156#include "arch/s390/annotate/instructions.c"
157#include "arch/sparc/annotate/instructions.c"
158
159static struct arch architectures[] = {
160 {
161 .name = "arc",
162 .init = arc__annotate_init,
163 },
164 {
165 .name = "arm",
166 .init = arm__annotate_init,
167 },
168 {
169 .name = "arm64",
170 .init = arm64__annotate_init,
171 },
172 {
173 .name = "csky",
174 .init = csky__annotate_init,
175 },
176 {
177 .name = "mips",
178 .init = mips__annotate_init,
179 .objdump = {
180 .comment_char = '#',
181 },
182 },
183 {
184 .name = "x86",
185 .init = x86__annotate_init,
186 .instructions = x86__instructions,
187 .nr_instructions = ARRAY_SIZE(x86__instructions),
188 .objdump = {
189 .comment_char = '#',
190 },
191 },
192 {
193 .name = "powerpc",
194 .init = powerpc__annotate_init,
195 },
196 {
197 .name = "riscv64",
198 .init = riscv64__annotate_init,
199 },
200 {
201 .name = "s390",
202 .init = s390__annotate_init,
203 .objdump = {
204 .comment_char = '#',
205 },
206 },
207 {
208 .name = "sparc",
209 .init = sparc__annotate_init,
210 .objdump = {
211 .comment_char = '#',
212 },
213 },
214};
215
216static void ins__delete(struct ins_operands *ops)
217{
218 if (ops == NULL)
219 return;
220 zfree(&ops->source.raw);
221 zfree(&ops->source.name);
222 zfree(&ops->target.raw);
223 zfree(&ops->target.name);
224}
225
226static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
227 struct ins_operands *ops, int max_ins_name)
228{
229 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
230}
231
232int ins__scnprintf(struct ins *ins, char *bf, size_t size,
233 struct ins_operands *ops, int max_ins_name)
234{
235 if (ins->ops->scnprintf)
236 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
237
238 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
239}
240
241bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
242{
243 if (!arch || !arch->ins_is_fused)
244 return false;
245
246 return arch->ins_is_fused(arch, ins1, ins2);
247}
248
249static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
250{
251 char *endptr, *tok, *name;
252 struct map *map = ms->map;
253 struct addr_map_symbol target = {
254 .ms = { .map = map, },
255 };
256
257 ops->target.addr = strtoull(ops->raw, &endptr, 16);
258
259 name = strchr(endptr, '<');
260 if (name == NULL)
261 goto indirect_call;
262
263 name++;
264
265 if (arch->objdump.skip_functions_char &&
266 strchr(name, arch->objdump.skip_functions_char))
267 return -1;
268
269 tok = strchr(name, '>');
270 if (tok == NULL)
271 return -1;
272
273 *tok = '\0';
274 ops->target.name = strdup(name);
275 *tok = '>';
276
277 if (ops->target.name == NULL)
278 return -1;
279find_target:
280 target.addr = map__objdump_2mem(map, ops->target.addr);
281
282 if (maps__find_ams(ms->maps, &target) == 0 &&
283 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
284 ops->target.sym = target.ms.sym;
285
286 return 0;
287
288indirect_call:
289 tok = strchr(endptr, '*');
290 if (tok != NULL) {
291 endptr++;
292
293 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
294 * Do not parse such instruction. */
295 if (strstr(endptr, "(%r") == NULL)
296 ops->target.addr = strtoull(endptr, NULL, 16);
297 }
298 goto find_target;
299}
300
301static int call__scnprintf(struct ins *ins, char *bf, size_t size,
302 struct ins_operands *ops, int max_ins_name)
303{
304 if (ops->target.sym)
305 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
306
307 if (ops->target.addr == 0)
308 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
309
310 if (ops->target.name)
311 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
312
313 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
314}
315
316static struct ins_ops call_ops = {
317 .parse = call__parse,
318 .scnprintf = call__scnprintf,
319};
320
321bool ins__is_call(const struct ins *ins)
322{
323 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
324}
325
326/*
327 * Prevents from matching commas in the comment section, e.g.:
328 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
329 *
330 * and skip comma as part of function arguments, e.g.:
331 * 1d8b4ac <linemap_lookup(line_maps const*, unsigned int)+0xcc>
332 */
333static inline const char *validate_comma(const char *c, struct ins_operands *ops)
334{
335 if (ops->raw_comment && c > ops->raw_comment)
336 return NULL;
337
338 if (ops->raw_func_start && c > ops->raw_func_start)
339 return NULL;
340
341 return c;
342}
343
344static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
345{
346 struct map *map = ms->map;
347 struct symbol *sym = ms->sym;
348 struct addr_map_symbol target = {
349 .ms = { .map = map, },
350 };
351 const char *c = strchr(ops->raw, ',');
352 u64 start, end;
353
354 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
355 ops->raw_func_start = strchr(ops->raw, '<');
356
357 c = validate_comma(c, ops);
358
359 /*
360 * Examples of lines to parse for the _cpp_lex_token@@Base
361 * function:
362 *
363 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
364 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
365 *
366 * The first is a jump to an offset inside the same function,
367 * the second is to another function, i.e. that 0xa72 is an
368 * offset in the cpp_named_operator2name@@base function.
369 */
370 /*
371 * skip over possible up to 2 operands to get to address, e.g.:
372 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
373 */
374 if (c++ != NULL) {
375 ops->target.addr = strtoull(c, NULL, 16);
376 if (!ops->target.addr) {
377 c = strchr(c, ',');
378 c = validate_comma(c, ops);
379 if (c++ != NULL)
380 ops->target.addr = strtoull(c, NULL, 16);
381 }
382 } else {
383 ops->target.addr = strtoull(ops->raw, NULL, 16);
384 }
385
386 target.addr = map__objdump_2mem(map, ops->target.addr);
387 start = map->unmap_ip(map, sym->start),
388 end = map->unmap_ip(map, sym->end);
389
390 ops->target.outside = target.addr < start || target.addr > end;
391
392 /*
393 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
394
395 cpp_named_operator2name@@Base+0xa72
396
397 * Point to a place that is after the cpp_named_operator2name
398 * boundaries, i.e. in the ELF symbol table for cc1
399 * cpp_named_operator2name is marked as being 32-bytes long, but it in
400 * fact is much larger than that, so we seem to need a symbols__find()
401 * routine that looks for >= current->start and < next_symbol->start,
402 * possibly just for C++ objects?
403 *
404 * For now lets just make some progress by marking jumps to outside the
405 * current function as call like.
406 *
407 * Actual navigation will come next, with further understanding of how
408 * the symbol searching and disassembly should be done.
409 */
410 if (maps__find_ams(ms->maps, &target) == 0 &&
411 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
412 ops->target.sym = target.ms.sym;
413
414 if (!ops->target.outside) {
415 ops->target.offset = target.addr - start;
416 ops->target.offset_avail = true;
417 } else {
418 ops->target.offset_avail = false;
419 }
420
421 return 0;
422}
423
424static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
425 struct ins_operands *ops, int max_ins_name)
426{
427 const char *c;
428
429 if (!ops->target.addr || ops->target.offset < 0)
430 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
431
432 if (ops->target.outside && ops->target.sym != NULL)
433 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
434
435 c = strchr(ops->raw, ',');
436 c = validate_comma(c, ops);
437
438 if (c != NULL) {
439 const char *c2 = strchr(c + 1, ',');
440
441 c2 = validate_comma(c2, ops);
442 /* check for 3-op insn */
443 if (c2 != NULL)
444 c = c2;
445 c++;
446
447 /* mirror arch objdump's space-after-comma style */
448 if (*c == ' ')
449 c++;
450 }
451
452 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
453 ins->name, c ? c - ops->raw : 0, ops->raw,
454 ops->target.offset);
455}
456
457static struct ins_ops jump_ops = {
458 .parse = jump__parse,
459 .scnprintf = jump__scnprintf,
460};
461
462bool ins__is_jump(const struct ins *ins)
463{
464 return ins->ops == &jump_ops;
465}
466
467static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
468{
469 char *endptr, *name, *t;
470
471 if (strstr(raw, "(%rip)") == NULL)
472 return 0;
473
474 *addrp = strtoull(comment, &endptr, 16);
475 if (endptr == comment)
476 return 0;
477 name = strchr(endptr, '<');
478 if (name == NULL)
479 return -1;
480
481 name++;
482
483 t = strchr(name, '>');
484 if (t == NULL)
485 return 0;
486
487 *t = '\0';
488 *namep = strdup(name);
489 *t = '>';
490
491 return 0;
492}
493
494static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
495{
496 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
497 if (ops->locked.ops == NULL)
498 return 0;
499
500 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
501 goto out_free_ops;
502
503 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
504
505 if (ops->locked.ins.ops == NULL)
506 goto out_free_ops;
507
508 if (ops->locked.ins.ops->parse &&
509 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
510 goto out_free_ops;
511
512 return 0;
513
514out_free_ops:
515 zfree(&ops->locked.ops);
516 return 0;
517}
518
519static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
520 struct ins_operands *ops, int max_ins_name)
521{
522 int printed;
523
524 if (ops->locked.ins.ops == NULL)
525 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
526
527 printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
528 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
529 size - printed, ops->locked.ops, max_ins_name);
530}
531
532static void lock__delete(struct ins_operands *ops)
533{
534 struct ins *ins = &ops->locked.ins;
535
536 if (ins->ops && ins->ops->free)
537 ins->ops->free(ops->locked.ops);
538 else
539 ins__delete(ops->locked.ops);
540
541 zfree(&ops->locked.ops);
542 zfree(&ops->target.raw);
543 zfree(&ops->target.name);
544}
545
546static struct ins_ops lock_ops = {
547 .free = lock__delete,
548 .parse = lock__parse,
549 .scnprintf = lock__scnprintf,
550};
551
552static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
553{
554 char *s = strchr(ops->raw, ','), *target, *comment, prev;
555
556 if (s == NULL)
557 return -1;
558
559 *s = '\0';
560 ops->source.raw = strdup(ops->raw);
561 *s = ',';
562
563 if (ops->source.raw == NULL)
564 return -1;
565
566 target = ++s;
567 comment = strchr(s, arch->objdump.comment_char);
568
569 if (comment != NULL)
570 s = comment - 1;
571 else
572 s = strchr(s, '\0') - 1;
573
574 while (s > target && isspace(s[0]))
575 --s;
576 s++;
577 prev = *s;
578 *s = '\0';
579
580 ops->target.raw = strdup(target);
581 *s = prev;
582
583 if (ops->target.raw == NULL)
584 goto out_free_source;
585
586 if (comment == NULL)
587 return 0;
588
589 comment = skip_spaces(comment);
590 comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
591 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
592
593 return 0;
594
595out_free_source:
596 zfree(&ops->source.raw);
597 return -1;
598}
599
600static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
601 struct ins_operands *ops, int max_ins_name)
602{
603 return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
604 ops->source.name ?: ops->source.raw,
605 ops->target.name ?: ops->target.raw);
606}
607
608static struct ins_ops mov_ops = {
609 .parse = mov__parse,
610 .scnprintf = mov__scnprintf,
611};
612
613static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
614{
615 char *target, *comment, *s, prev;
616
617 target = s = ops->raw;
618
619 while (s[0] != '\0' && !isspace(s[0]))
620 ++s;
621 prev = *s;
622 *s = '\0';
623
624 ops->target.raw = strdup(target);
625 *s = prev;
626
627 if (ops->target.raw == NULL)
628 return -1;
629
630 comment = strchr(s, arch->objdump.comment_char);
631 if (comment == NULL)
632 return 0;
633
634 comment = skip_spaces(comment);
635 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
636
637 return 0;
638}
639
640static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
641 struct ins_operands *ops, int max_ins_name)
642{
643 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
644 ops->target.name ?: ops->target.raw);
645}
646
647static struct ins_ops dec_ops = {
648 .parse = dec__parse,
649 .scnprintf = dec__scnprintf,
650};
651
652static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
653 struct ins_operands *ops __maybe_unused, int max_ins_name)
654{
655 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
656}
657
658static struct ins_ops nop_ops = {
659 .scnprintf = nop__scnprintf,
660};
661
662static struct ins_ops ret_ops = {
663 .scnprintf = ins__raw_scnprintf,
664};
665
666bool ins__is_ret(const struct ins *ins)
667{
668 return ins->ops == &ret_ops;
669}
670
671bool ins__is_lock(const struct ins *ins)
672{
673 return ins->ops == &lock_ops;
674}
675
676static int ins__key_cmp(const void *name, const void *insp)
677{
678 const struct ins *ins = insp;
679
680 return strcmp(name, ins->name);
681}
682
683static int ins__cmp(const void *a, const void *b)
684{
685 const struct ins *ia = a;
686 const struct ins *ib = b;
687
688 return strcmp(ia->name, ib->name);
689}
690
691static void ins__sort(struct arch *arch)
692{
693 const int nmemb = arch->nr_instructions;
694
695 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
696}
697
698static struct ins_ops *__ins__find(struct arch *arch, const char *name)
699{
700 struct ins *ins;
701 const int nmemb = arch->nr_instructions;
702
703 if (!arch->sorted_instructions) {
704 ins__sort(arch);
705 arch->sorted_instructions = true;
706 }
707
708 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
709 return ins ? ins->ops : NULL;
710}
711
712static struct ins_ops *ins__find(struct arch *arch, const char *name)
713{
714 struct ins_ops *ops = __ins__find(arch, name);
715
716 if (!ops && arch->associate_instruction_ops)
717 ops = arch->associate_instruction_ops(arch, name);
718
719 return ops;
720}
721
722static int arch__key_cmp(const void *name, const void *archp)
723{
724 const struct arch *arch = archp;
725
726 return strcmp(name, arch->name);
727}
728
729static int arch__cmp(const void *a, const void *b)
730{
731 const struct arch *aa = a;
732 const struct arch *ab = b;
733
734 return strcmp(aa->name, ab->name);
735}
736
737static void arch__sort(void)
738{
739 const int nmemb = ARRAY_SIZE(architectures);
740
741 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
742}
743
744static struct arch *arch__find(const char *name)
745{
746 const int nmemb = ARRAY_SIZE(architectures);
747 static bool sorted;
748
749 if (!sorted) {
750 arch__sort();
751 sorted = true;
752 }
753
754 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
755}
756
757static struct annotated_source *annotated_source__new(void)
758{
759 struct annotated_source *src = zalloc(sizeof(*src));
760
761 if (src != NULL)
762 INIT_LIST_HEAD(&src->source);
763
764 return src;
765}
766
767static __maybe_unused void annotated_source__delete(struct annotated_source *src)
768{
769 if (src == NULL)
770 return;
771 zfree(&src->histograms);
772 zfree(&src->cycles_hist);
773 free(src);
774}
775
776static int annotated_source__alloc_histograms(struct annotated_source *src,
777 size_t size, int nr_hists)
778{
779 size_t sizeof_sym_hist;
780
781 /*
782 * Add buffer of one element for zero length symbol.
783 * When sample is taken from first instruction of
784 * zero length symbol, perf still resolves it and
785 * shows symbol name in perf report and allows to
786 * annotate it.
787 */
788 if (size == 0)
789 size = 1;
790
791 /* Check for overflow when calculating sizeof_sym_hist */
792 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
793 return -1;
794
795 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
796
797 /* Check for overflow in zalloc argument */
798 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
799 return -1;
800
801 src->sizeof_sym_hist = sizeof_sym_hist;
802 src->nr_histograms = nr_hists;
803 src->histograms = calloc(nr_hists, sizeof_sym_hist) ;
804 return src->histograms ? 0 : -1;
805}
806
807/* The cycles histogram is lazily allocated. */
808static int symbol__alloc_hist_cycles(struct symbol *sym)
809{
810 struct annotation *notes = symbol__annotation(sym);
811 const size_t size = symbol__size(sym);
812
813 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
814 if (notes->src->cycles_hist == NULL)
815 return -1;
816 return 0;
817}
818
819void symbol__annotate_zero_histograms(struct symbol *sym)
820{
821 struct annotation *notes = symbol__annotation(sym);
822
823 mutex_lock(¬es->lock);
824 if (notes->src != NULL) {
825 memset(notes->src->histograms, 0,
826 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
827 if (notes->src->cycles_hist)
828 memset(notes->src->cycles_hist, 0,
829 symbol__size(sym) * sizeof(struct cyc_hist));
830 }
831 mutex_unlock(¬es->lock);
832}
833
834static int __symbol__account_cycles(struct cyc_hist *ch,
835 u64 start,
836 unsigned offset, unsigned cycles,
837 unsigned have_start)
838{
839 /*
840 * For now we can only account one basic block per
841 * final jump. But multiple could be overlapping.
842 * Always account the longest one. So when
843 * a shorter one has been already seen throw it away.
844 *
845 * We separately always account the full cycles.
846 */
847 ch[offset].num_aggr++;
848 ch[offset].cycles_aggr += cycles;
849
850 if (cycles > ch[offset].cycles_max)
851 ch[offset].cycles_max = cycles;
852
853 if (ch[offset].cycles_min) {
854 if (cycles && cycles < ch[offset].cycles_min)
855 ch[offset].cycles_min = cycles;
856 } else
857 ch[offset].cycles_min = cycles;
858
859 if (!have_start && ch[offset].have_start)
860 return 0;
861 if (ch[offset].num) {
862 if (have_start && (!ch[offset].have_start ||
863 ch[offset].start > start)) {
864 ch[offset].have_start = 0;
865 ch[offset].cycles = 0;
866 ch[offset].num = 0;
867 if (ch[offset].reset < 0xffff)
868 ch[offset].reset++;
869 } else if (have_start &&
870 ch[offset].start < start)
871 return 0;
872 }
873
874 if (ch[offset].num < NUM_SPARKS)
875 ch[offset].cycles_spark[ch[offset].num] = cycles;
876
877 ch[offset].have_start = have_start;
878 ch[offset].start = start;
879 ch[offset].cycles += cycles;
880 ch[offset].num++;
881 return 0;
882}
883
884static int __symbol__inc_addr_samples(struct map_symbol *ms,
885 struct annotated_source *src, int evidx, u64 addr,
886 struct perf_sample *sample)
887{
888 struct symbol *sym = ms->sym;
889 unsigned offset;
890 struct sym_hist *h;
891
892 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, ms->map->unmap_ip(ms->map, addr));
893
894 if ((addr < sym->start || addr >= sym->end) &&
895 (addr != sym->end || sym->start != sym->end)) {
896 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
897 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
898 return -ERANGE;
899 }
900
901 offset = addr - sym->start;
902 h = annotated_source__histogram(src, evidx);
903 if (h == NULL) {
904 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
905 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
906 return -ENOMEM;
907 }
908 h->nr_samples++;
909 h->addr[offset].nr_samples++;
910 h->period += sample->period;
911 h->addr[offset].period += sample->period;
912
913 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
914 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
915 sym->start, sym->name, addr, addr - sym->start, evidx,
916 h->addr[offset].nr_samples, h->addr[offset].period);
917 return 0;
918}
919
920static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
921{
922 struct annotation *notes = symbol__annotation(sym);
923
924 if (notes->src == NULL) {
925 notes->src = annotated_source__new();
926 if (notes->src == NULL)
927 return NULL;
928 goto alloc_cycles_hist;
929 }
930
931 if (!notes->src->cycles_hist) {
932alloc_cycles_hist:
933 symbol__alloc_hist_cycles(sym);
934 }
935
936 return notes->src->cycles_hist;
937}
938
939struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
940{
941 struct annotation *notes = symbol__annotation(sym);
942
943 if (notes->src == NULL) {
944 notes->src = annotated_source__new();
945 if (notes->src == NULL)
946 return NULL;
947 goto alloc_histograms;
948 }
949
950 if (notes->src->histograms == NULL) {
951alloc_histograms:
952 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
953 nr_hists);
954 }
955
956 return notes->src;
957}
958
959static int symbol__inc_addr_samples(struct map_symbol *ms,
960 struct evsel *evsel, u64 addr,
961 struct perf_sample *sample)
962{
963 struct symbol *sym = ms->sym;
964 struct annotated_source *src;
965
966 if (sym == NULL)
967 return 0;
968 src = symbol__hists(sym, evsel->evlist->core.nr_entries);
969 return src ? __symbol__inc_addr_samples(ms, src, evsel->core.idx, addr, sample) : 0;
970}
971
972static int symbol__account_cycles(u64 addr, u64 start,
973 struct symbol *sym, unsigned cycles)
974{
975 struct cyc_hist *cycles_hist;
976 unsigned offset;
977
978 if (sym == NULL)
979 return 0;
980 cycles_hist = symbol__cycles_hist(sym);
981 if (cycles_hist == NULL)
982 return -ENOMEM;
983 if (addr < sym->start || addr >= sym->end)
984 return -ERANGE;
985
986 if (start) {
987 if (start < sym->start || start >= sym->end)
988 return -ERANGE;
989 if (start >= addr)
990 start = 0;
991 }
992 offset = addr - sym->start;
993 return __symbol__account_cycles(cycles_hist,
994 start ? start - sym->start : 0,
995 offset, cycles,
996 !!start);
997}
998
999int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
1000 struct addr_map_symbol *start,
1001 unsigned cycles)
1002{
1003 u64 saddr = 0;
1004 int err;
1005
1006 if (!cycles)
1007 return 0;
1008
1009 /*
1010 * Only set start when IPC can be computed. We can only
1011 * compute it when the basic block is completely in a single
1012 * function.
1013 * Special case the case when the jump is elsewhere, but
1014 * it starts on the function start.
1015 */
1016 if (start &&
1017 (start->ms.sym == ams->ms.sym ||
1018 (ams->ms.sym &&
1019 start->addr == ams->ms.sym->start + ams->ms.map->start)))
1020 saddr = start->al_addr;
1021 if (saddr == 0)
1022 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
1023 ams->addr,
1024 start ? start->addr : 0,
1025 ams->ms.sym ? ams->ms.sym->start + ams->ms.map->start : 0,
1026 saddr);
1027 err = symbol__account_cycles(ams->al_addr, saddr, ams->ms.sym, cycles);
1028 if (err)
1029 pr_debug2("account_cycles failed %d\n", err);
1030 return err;
1031}
1032
1033static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1034{
1035 unsigned n_insn = 0;
1036 u64 offset;
1037
1038 for (offset = start; offset <= end; offset++) {
1039 if (notes->offsets[offset])
1040 n_insn++;
1041 }
1042 return n_insn;
1043}
1044
1045static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1046{
1047 unsigned n_insn;
1048 unsigned int cover_insn = 0;
1049 u64 offset;
1050
1051 n_insn = annotation__count_insn(notes, start, end);
1052 if (n_insn && ch->num && ch->cycles) {
1053 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1054
1055 /* Hide data when there are too many overlaps. */
1056 if (ch->reset >= 0x7fff)
1057 return;
1058
1059 for (offset = start; offset <= end; offset++) {
1060 struct annotation_line *al = notes->offsets[offset];
1061
1062 if (al && al->ipc == 0.0) {
1063 al->ipc = ipc;
1064 cover_insn++;
1065 }
1066 }
1067
1068 if (cover_insn) {
1069 notes->hit_cycles += ch->cycles;
1070 notes->hit_insn += n_insn * ch->num;
1071 notes->cover_insn += cover_insn;
1072 }
1073 }
1074}
1075
1076void annotation__compute_ipc(struct annotation *notes, size_t size)
1077{
1078 s64 offset;
1079
1080 if (!notes->src || !notes->src->cycles_hist)
1081 return;
1082
1083 notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1084 notes->hit_cycles = 0;
1085 notes->hit_insn = 0;
1086 notes->cover_insn = 0;
1087
1088 mutex_lock(¬es->lock);
1089 for (offset = size - 1; offset >= 0; --offset) {
1090 struct cyc_hist *ch;
1091
1092 ch = ¬es->src->cycles_hist[offset];
1093 if (ch && ch->cycles) {
1094 struct annotation_line *al;
1095
1096 if (ch->have_start)
1097 annotation__count_and_fill(notes, ch->start, offset, ch);
1098 al = notes->offsets[offset];
1099 if (al && ch->num_aggr) {
1100 al->cycles = ch->cycles_aggr / ch->num_aggr;
1101 al->cycles_max = ch->cycles_max;
1102 al->cycles_min = ch->cycles_min;
1103 }
1104 notes->have_cycles = true;
1105 }
1106 }
1107 mutex_unlock(¬es->lock);
1108}
1109
1110int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1111 struct evsel *evsel)
1112{
1113 return symbol__inc_addr_samples(&ams->ms, evsel, ams->al_addr, sample);
1114}
1115
1116int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1117 struct evsel *evsel, u64 ip)
1118{
1119 return symbol__inc_addr_samples(&he->ms, evsel, ip, sample);
1120}
1121
1122static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1123{
1124 dl->ins.ops = ins__find(arch, dl->ins.name);
1125
1126 if (!dl->ins.ops)
1127 return;
1128
1129 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1130 dl->ins.ops = NULL;
1131}
1132
1133static int disasm_line__parse(char *line, const char **namep, char **rawp)
1134{
1135 char tmp, *name = skip_spaces(line);
1136
1137 if (name[0] == '\0')
1138 return -1;
1139
1140 *rawp = name + 1;
1141
1142 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1143 ++*rawp;
1144
1145 tmp = (*rawp)[0];
1146 (*rawp)[0] = '\0';
1147 *namep = strdup(name);
1148
1149 if (*namep == NULL)
1150 goto out;
1151
1152 (*rawp)[0] = tmp;
1153 *rawp = strim(*rawp);
1154
1155 return 0;
1156
1157out:
1158 return -1;
1159}
1160
1161struct annotate_args {
1162 struct arch *arch;
1163 struct map_symbol ms;
1164 struct evsel *evsel;
1165 struct annotation_options *options;
1166 s64 offset;
1167 char *line;
1168 int line_nr;
1169 char *fileloc;
1170};
1171
1172static void annotation_line__init(struct annotation_line *al,
1173 struct annotate_args *args,
1174 int nr)
1175{
1176 al->offset = args->offset;
1177 al->line = strdup(args->line);
1178 al->line_nr = args->line_nr;
1179 al->fileloc = args->fileloc;
1180 al->data_nr = nr;
1181}
1182
1183static void annotation_line__exit(struct annotation_line *al)
1184{
1185 free_srcline(al->path);
1186 zfree(&al->line);
1187}
1188
1189static size_t disasm_line_size(int nr)
1190{
1191 struct annotation_line *al;
1192
1193 return (sizeof(struct disasm_line) + (sizeof(al->data[0]) * nr));
1194}
1195
1196/*
1197 * Allocating the disasm annotation line data with
1198 * following structure:
1199 *
1200 * -------------------------------------------
1201 * struct disasm_line | struct annotation_line
1202 * -------------------------------------------
1203 *
1204 * We have 'struct annotation_line' member as last member
1205 * of 'struct disasm_line' to have an easy access.
1206 */
1207static struct disasm_line *disasm_line__new(struct annotate_args *args)
1208{
1209 struct disasm_line *dl = NULL;
1210 int nr = 1;
1211
1212 if (evsel__is_group_event(args->evsel))
1213 nr = args->evsel->core.nr_members;
1214
1215 dl = zalloc(disasm_line_size(nr));
1216 if (!dl)
1217 return NULL;
1218
1219 annotation_line__init(&dl->al, args, nr);
1220 if (dl->al.line == NULL)
1221 goto out_delete;
1222
1223 if (args->offset != -1) {
1224 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1225 goto out_free_line;
1226
1227 disasm_line__init_ins(dl, args->arch, &args->ms);
1228 }
1229
1230 return dl;
1231
1232out_free_line:
1233 zfree(&dl->al.line);
1234out_delete:
1235 free(dl);
1236 return NULL;
1237}
1238
1239void disasm_line__free(struct disasm_line *dl)
1240{
1241 if (dl->ins.ops && dl->ins.ops->free)
1242 dl->ins.ops->free(&dl->ops);
1243 else
1244 ins__delete(&dl->ops);
1245 zfree(&dl->ins.name);
1246 annotation_line__exit(&dl->al);
1247 free(dl);
1248}
1249
1250int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1251{
1252 if (raw || !dl->ins.ops)
1253 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1254
1255 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1256}
1257
1258void annotation__init(struct annotation *notes)
1259{
1260 mutex_init(¬es->lock);
1261}
1262
1263void annotation__exit(struct annotation *notes)
1264{
1265 annotated_source__delete(notes->src);
1266 mutex_destroy(¬es->lock);
1267}
1268
1269static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1270{
1271 list_add_tail(&al->node, head);
1272}
1273
1274struct annotation_line *
1275annotation_line__next(struct annotation_line *pos, struct list_head *head)
1276{
1277 list_for_each_entry_continue(pos, head, node)
1278 if (pos->offset >= 0)
1279 return pos;
1280
1281 return NULL;
1282}
1283
1284static const char *annotate__address_color(struct block_range *br)
1285{
1286 double cov = block_range__coverage(br);
1287
1288 if (cov >= 0) {
1289 /* mark red for >75% coverage */
1290 if (cov > 0.75)
1291 return PERF_COLOR_RED;
1292
1293 /* mark dull for <1% coverage */
1294 if (cov < 0.01)
1295 return PERF_COLOR_NORMAL;
1296 }
1297
1298 return PERF_COLOR_MAGENTA;
1299}
1300
1301static const char *annotate__asm_color(struct block_range *br)
1302{
1303 double cov = block_range__coverage(br);
1304
1305 if (cov >= 0) {
1306 /* mark dull for <1% coverage */
1307 if (cov < 0.01)
1308 return PERF_COLOR_NORMAL;
1309 }
1310
1311 return PERF_COLOR_BLUE;
1312}
1313
1314static void annotate__branch_printf(struct block_range *br, u64 addr)
1315{
1316 bool emit_comment = true;
1317
1318 if (!br)
1319 return;
1320
1321#if 1
1322 if (br->is_target && br->start == addr) {
1323 struct block_range *branch = br;
1324 double p;
1325
1326 /*
1327 * Find matching branch to our target.
1328 */
1329 while (!branch->is_branch)
1330 branch = block_range__next(branch);
1331
1332 p = 100 *(double)br->entry / branch->coverage;
1333
1334 if (p > 0.1) {
1335 if (emit_comment) {
1336 emit_comment = false;
1337 printf("\t#");
1338 }
1339
1340 /*
1341 * The percentage of coverage joined at this target in relation
1342 * to the next branch.
1343 */
1344 printf(" +%.2f%%", p);
1345 }
1346 }
1347#endif
1348 if (br->is_branch && br->end == addr) {
1349 double p = 100*(double)br->taken / br->coverage;
1350
1351 if (p > 0.1) {
1352 if (emit_comment) {
1353 emit_comment = false;
1354 printf("\t#");
1355 }
1356
1357 /*
1358 * The percentage of coverage leaving at this branch, and
1359 * its prediction ratio.
1360 */
1361 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1362 }
1363 }
1364}
1365
1366static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1367{
1368 s64 offset = dl->al.offset;
1369 const u64 addr = start + offset;
1370 struct block_range *br;
1371
1372 br = block_range__find(addr);
1373 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
1374 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1375 annotate__branch_printf(br, addr);
1376 return 0;
1377}
1378
1379static int
1380annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1381 struct evsel *evsel, u64 len, int min_pcnt, int printed,
1382 int max_lines, struct annotation_line *queue, int addr_fmt_width,
1383 int percent_type)
1384{
1385 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1386 static const char *prev_line;
1387
1388 if (al->offset != -1) {
1389 double max_percent = 0.0;
1390 int i, nr_percent = 1;
1391 const char *color;
1392 struct annotation *notes = symbol__annotation(sym);
1393
1394 for (i = 0; i < al->data_nr; i++) {
1395 double percent;
1396
1397 percent = annotation_data__percent(&al->data[i],
1398 percent_type);
1399
1400 if (percent > max_percent)
1401 max_percent = percent;
1402 }
1403
1404 if (al->data_nr > nr_percent)
1405 nr_percent = al->data_nr;
1406
1407 if (max_percent < min_pcnt)
1408 return -1;
1409
1410 if (max_lines && printed >= max_lines)
1411 return 1;
1412
1413 if (queue != NULL) {
1414 list_for_each_entry_from(queue, ¬es->src->source, node) {
1415 if (queue == al)
1416 break;
1417 annotation_line__print(queue, sym, start, evsel, len,
1418 0, 0, 1, NULL, addr_fmt_width,
1419 percent_type);
1420 }
1421 }
1422
1423 color = get_percent_color(max_percent);
1424
1425 for (i = 0; i < nr_percent; i++) {
1426 struct annotation_data *data = &al->data[i];
1427 double percent;
1428
1429 percent = annotation_data__percent(data, percent_type);
1430 color = get_percent_color(percent);
1431
1432 if (symbol_conf.show_total_period)
1433 color_fprintf(stdout, color, " %11" PRIu64,
1434 data->he.period);
1435 else if (symbol_conf.show_nr_samples)
1436 color_fprintf(stdout, color, " %7" PRIu64,
1437 data->he.nr_samples);
1438 else
1439 color_fprintf(stdout, color, " %7.2f", percent);
1440 }
1441
1442 printf(" : ");
1443
1444 disasm_line__print(dl, start, addr_fmt_width);
1445
1446 /*
1447 * Also color the filename and line if needed, with
1448 * the same color than the percentage. Don't print it
1449 * twice for close colored addr with the same filename:line
1450 */
1451 if (al->path) {
1452 if (!prev_line || strcmp(prev_line, al->path)) {
1453 color_fprintf(stdout, color, " // %s", al->path);
1454 prev_line = al->path;
1455 }
1456 }
1457
1458 printf("\n");
1459 } else if (max_lines && printed >= max_lines)
1460 return 1;
1461 else {
1462 int width = symbol_conf.show_total_period ? 12 : 8;
1463
1464 if (queue)
1465 return -1;
1466
1467 if (evsel__is_group_event(evsel))
1468 width *= evsel->core.nr_members;
1469
1470 if (!*al->line)
1471 printf(" %*s:\n", width, " ");
1472 else
1473 printf(" %*s: %-*d %s\n", width, " ", addr_fmt_width, al->line_nr, al->line);
1474 }
1475
1476 return 0;
1477}
1478
1479/*
1480 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1481 * which looks like following
1482 *
1483 * 0000000000415500 <_init>:
1484 * 415500: sub $0x8,%rsp
1485 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1486 * 41550b: test %rax,%rax
1487 * 41550e: je 415515 <_init+0x15>
1488 * 415510: callq 416e70 <__gmon_start__@plt>
1489 * 415515: add $0x8,%rsp
1490 * 415519: retq
1491 *
1492 * it will be parsed and saved into struct disasm_line as
1493 * <offset> <name> <ops.raw>
1494 *
1495 * The offset will be a relative offset from the start of the symbol and -1
1496 * means that it's not a disassembly line so should be treated differently.
1497 * The ops.raw part will be parsed further according to type of the instruction.
1498 */
1499static int symbol__parse_objdump_line(struct symbol *sym,
1500 struct annotate_args *args,
1501 char *parsed_line, int *line_nr, char **fileloc)
1502{
1503 struct map *map = args->ms.map;
1504 struct annotation *notes = symbol__annotation(sym);
1505 struct disasm_line *dl;
1506 char *tmp;
1507 s64 line_ip, offset = -1;
1508 regmatch_t match[2];
1509
1510 /* /filename:linenr ? Save line number and ignore. */
1511 if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1512 *line_nr = atoi(parsed_line + match[1].rm_so);
1513 *fileloc = strdup(parsed_line);
1514 return 0;
1515 }
1516
1517 /* Process hex address followed by ':'. */
1518 line_ip = strtoull(parsed_line, &tmp, 16);
1519 if (parsed_line != tmp && tmp[0] == ':' && tmp[1] != '\0') {
1520 u64 start = map__rip_2objdump(map, sym->start),
1521 end = map__rip_2objdump(map, sym->end);
1522
1523 offset = line_ip - start;
1524 if ((u64)line_ip < start || (u64)line_ip >= end)
1525 offset = -1;
1526 else
1527 parsed_line = tmp + 1;
1528 }
1529
1530 args->offset = offset;
1531 args->line = parsed_line;
1532 args->line_nr = *line_nr;
1533 args->fileloc = *fileloc;
1534 args->ms.sym = sym;
1535
1536 dl = disasm_line__new(args);
1537 (*line_nr)++;
1538
1539 if (dl == NULL)
1540 return -1;
1541
1542 if (!disasm_line__has_local_offset(dl)) {
1543 dl->ops.target.offset = dl->ops.target.addr -
1544 map__rip_2objdump(map, sym->start);
1545 dl->ops.target.offset_avail = true;
1546 }
1547
1548 /* kcore has no symbols, so add the call target symbol */
1549 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1550 struct addr_map_symbol target = {
1551 .addr = dl->ops.target.addr,
1552 .ms = { .map = map, },
1553 };
1554
1555 if (!maps__find_ams(args->ms.maps, &target) &&
1556 target.ms.sym->start == target.al_addr)
1557 dl->ops.target.sym = target.ms.sym;
1558 }
1559
1560 annotation_line__add(&dl->al, ¬es->src->source);
1561
1562 return 0;
1563}
1564
1565static __attribute__((constructor)) void symbol__init_regexpr(void)
1566{
1567 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1568}
1569
1570static void delete_last_nop(struct symbol *sym)
1571{
1572 struct annotation *notes = symbol__annotation(sym);
1573 struct list_head *list = ¬es->src->source;
1574 struct disasm_line *dl;
1575
1576 while (!list_empty(list)) {
1577 dl = list_entry(list->prev, struct disasm_line, al.node);
1578
1579 if (dl->ins.ops) {
1580 if (dl->ins.ops != &nop_ops)
1581 return;
1582 } else {
1583 if (!strstr(dl->al.line, " nop ") &&
1584 !strstr(dl->al.line, " nopl ") &&
1585 !strstr(dl->al.line, " nopw "))
1586 return;
1587 }
1588
1589 list_del_init(&dl->al.node);
1590 disasm_line__free(dl);
1591 }
1592}
1593
1594int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen)
1595{
1596 struct dso *dso = ms->map->dso;
1597
1598 BUG_ON(buflen == 0);
1599
1600 if (errnum >= 0) {
1601 str_error_r(errnum, buf, buflen);
1602 return 0;
1603 }
1604
1605 switch (errnum) {
1606 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1607 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1608 char *build_id_msg = NULL;
1609
1610 if (dso->has_build_id) {
1611 build_id__sprintf(&dso->bid, bf + 15);
1612 build_id_msg = bf;
1613 }
1614 scnprintf(buf, buflen,
1615 "No vmlinux file%s\nwas found in the path.\n\n"
1616 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1617 "Please use:\n\n"
1618 " perf buildid-cache -vu vmlinux\n\n"
1619 "or:\n\n"
1620 " --vmlinux vmlinux\n", build_id_msg ?: "");
1621 }
1622 break;
1623 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1624 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1625 break;
1626 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP:
1627 scnprintf(buf, buflen, "Problems with arch specific instruction name regular expressions.");
1628 break;
1629 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING:
1630 scnprintf(buf, buflen, "Problems while parsing the CPUID in the arch specific initialization.");
1631 break;
1632 case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE:
1633 scnprintf(buf, buflen, "Invalid BPF file: %s.", dso->long_name);
1634 break;
1635 case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF:
1636 scnprintf(buf, buflen, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1637 dso->long_name);
1638 break;
1639 default:
1640 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1641 break;
1642 }
1643
1644 return 0;
1645}
1646
1647static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1648{
1649 char linkname[PATH_MAX];
1650 char *build_id_filename;
1651 char *build_id_path = NULL;
1652 char *pos;
1653 int len;
1654
1655 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1656 !dso__is_kcore(dso))
1657 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1658
1659 build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1660 if (build_id_filename) {
1661 __symbol__join_symfs(filename, filename_size, build_id_filename);
1662 free(build_id_filename);
1663 } else {
1664 if (dso->has_build_id)
1665 return ENOMEM;
1666 goto fallback;
1667 }
1668
1669 build_id_path = strdup(filename);
1670 if (!build_id_path)
1671 return ENOMEM;
1672
1673 /*
1674 * old style build-id cache has name of XX/XXXXXXX.. while
1675 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1676 * extract the build-id part of dirname in the new style only.
1677 */
1678 pos = strrchr(build_id_path, '/');
1679 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1680 dirname(build_id_path);
1681
1682 if (dso__is_kcore(dso))
1683 goto fallback;
1684
1685 len = readlink(build_id_path, linkname, sizeof(linkname) - 1);
1686 if (len < 0)
1687 goto fallback;
1688
1689 linkname[len] = '\0';
1690 if (strstr(linkname, DSO__NAME_KALLSYMS) ||
1691 access(filename, R_OK)) {
1692fallback:
1693 /*
1694 * If we don't have build-ids or the build-id file isn't in the
1695 * cache, or is just a kallsyms file, well, lets hope that this
1696 * DSO is the same as when 'perf record' ran.
1697 */
1698 __symbol__join_symfs(filename, filename_size, dso->long_name);
1699
1700 mutex_lock(&dso->lock);
1701 if (access(filename, R_OK) && errno == ENOENT && dso->nsinfo) {
1702 char *new_name = filename_with_chroot(dso->nsinfo->pid,
1703 filename);
1704 if (new_name) {
1705 strlcpy(filename, new_name, filename_size);
1706 free(new_name);
1707 }
1708 }
1709 mutex_unlock(&dso->lock);
1710 }
1711
1712 free(build_id_path);
1713 return 0;
1714}
1715
1716#if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1717#define PACKAGE "perf"
1718#include <bfd.h>
1719#include <dis-asm.h>
1720#include <bpf/bpf.h>
1721#include <bpf/btf.h>
1722#include <bpf/libbpf.h>
1723#include <linux/btf.h>
1724#include <tools/dis-asm-compat.h>
1725
1726static int symbol__disassemble_bpf(struct symbol *sym,
1727 struct annotate_args *args)
1728{
1729 struct annotation *notes = symbol__annotation(sym);
1730 struct annotation_options *opts = args->options;
1731 struct bpf_prog_linfo *prog_linfo = NULL;
1732 struct bpf_prog_info_node *info_node;
1733 int len = sym->end - sym->start;
1734 disassembler_ftype disassemble;
1735 struct map *map = args->ms.map;
1736 struct perf_bpil *info_linear;
1737 struct disassemble_info info;
1738 struct dso *dso = map->dso;
1739 int pc = 0, count, sub_id;
1740 struct btf *btf = NULL;
1741 char tpath[PATH_MAX];
1742 size_t buf_size;
1743 int nr_skip = 0;
1744 char *buf;
1745 bfd *bfdf;
1746 int ret;
1747 FILE *s;
1748
1749 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1750 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE;
1751
1752 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1753 sym->name, sym->start, sym->end - sym->start);
1754
1755 memset(tpath, 0, sizeof(tpath));
1756 perf_exe(tpath, sizeof(tpath));
1757
1758 bfdf = bfd_openr(tpath, NULL);
1759 assert(bfdf);
1760 assert(bfd_check_format(bfdf, bfd_object));
1761
1762 s = open_memstream(&buf, &buf_size);
1763 if (!s) {
1764 ret = errno;
1765 goto out;
1766 }
1767 init_disassemble_info_compat(&info, s,
1768 (fprintf_ftype) fprintf,
1769 fprintf_styled);
1770 info.arch = bfd_get_arch(bfdf);
1771 info.mach = bfd_get_mach(bfdf);
1772
1773 info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1774 dso->bpf_prog.id);
1775 if (!info_node) {
1776 ret = SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF;
1777 goto out;
1778 }
1779 info_linear = info_node->info_linear;
1780 sub_id = dso->bpf_prog.sub_id;
1781
1782 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1783 info.buffer_length = info_linear->info.jited_prog_len;
1784
1785 if (info_linear->info.nr_line_info)
1786 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1787
1788 if (info_linear->info.btf_id) {
1789 struct btf_node *node;
1790
1791 node = perf_env__find_btf(dso->bpf_prog.env,
1792 info_linear->info.btf_id);
1793 if (node)
1794 btf = btf__new((__u8 *)(node->data),
1795 node->data_size);
1796 }
1797
1798 disassemble_init_for_target(&info);
1799
1800#ifdef DISASM_FOUR_ARGS_SIGNATURE
1801 disassemble = disassembler(info.arch,
1802 bfd_big_endian(bfdf),
1803 info.mach,
1804 bfdf);
1805#else
1806 disassemble = disassembler(bfdf);
1807#endif
1808 assert(disassemble);
1809
1810 fflush(s);
1811 do {
1812 const struct bpf_line_info *linfo = NULL;
1813 struct disasm_line *dl;
1814 size_t prev_buf_size;
1815 const char *srcline;
1816 u64 addr;
1817
1818 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1819 count = disassemble(pc, &info);
1820
1821 if (prog_linfo)
1822 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1823 addr, sub_id,
1824 nr_skip);
1825
1826 if (linfo && btf) {
1827 srcline = btf__name_by_offset(btf, linfo->line_off);
1828 nr_skip++;
1829 } else
1830 srcline = NULL;
1831
1832 fprintf(s, "\n");
1833 prev_buf_size = buf_size;
1834 fflush(s);
1835
1836 if (!opts->hide_src_code && srcline) {
1837 args->offset = -1;
1838 args->line = strdup(srcline);
1839 args->line_nr = 0;
1840 args->fileloc = NULL;
1841 args->ms.sym = sym;
1842 dl = disasm_line__new(args);
1843 if (dl) {
1844 annotation_line__add(&dl->al,
1845 ¬es->src->source);
1846 }
1847 }
1848
1849 args->offset = pc;
1850 args->line = buf + prev_buf_size;
1851 args->line_nr = 0;
1852 args->fileloc = NULL;
1853 args->ms.sym = sym;
1854 dl = disasm_line__new(args);
1855 if (dl)
1856 annotation_line__add(&dl->al, ¬es->src->source);
1857
1858 pc += count;
1859 } while (count > 0 && pc < len);
1860
1861 ret = 0;
1862out:
1863 free(prog_linfo);
1864 btf__free(btf);
1865 fclose(s);
1866 bfd_close(bfdf);
1867 return ret;
1868}
1869#else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1870static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1871 struct annotate_args *args __maybe_unused)
1872{
1873 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1874}
1875#endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1876
1877static int
1878symbol__disassemble_bpf_image(struct symbol *sym,
1879 struct annotate_args *args)
1880{
1881 struct annotation *notes = symbol__annotation(sym);
1882 struct disasm_line *dl;
1883
1884 args->offset = -1;
1885 args->line = strdup("to be implemented");
1886 args->line_nr = 0;
1887 args->fileloc = NULL;
1888 dl = disasm_line__new(args);
1889 if (dl)
1890 annotation_line__add(&dl->al, ¬es->src->source);
1891
1892 free(args->line);
1893 return 0;
1894}
1895
1896/*
1897 * Possibly create a new version of line with tabs expanded. Returns the
1898 * existing or new line, storage is updated if a new line is allocated. If
1899 * allocation fails then NULL is returned.
1900 */
1901static char *expand_tabs(char *line, char **storage, size_t *storage_len)
1902{
1903 size_t i, src, dst, len, new_storage_len, num_tabs;
1904 char *new_line;
1905 size_t line_len = strlen(line);
1906
1907 for (num_tabs = 0, i = 0; i < line_len; i++)
1908 if (line[i] == '\t')
1909 num_tabs++;
1910
1911 if (num_tabs == 0)
1912 return line;
1913
1914 /*
1915 * Space for the line and '\0', less the leading and trailing
1916 * spaces. Each tab may introduce 7 additional spaces.
1917 */
1918 new_storage_len = line_len + 1 + (num_tabs * 7);
1919
1920 new_line = malloc(new_storage_len);
1921 if (new_line == NULL) {
1922 pr_err("Failure allocating memory for tab expansion\n");
1923 return NULL;
1924 }
1925
1926 /*
1927 * Copy regions starting at src and expand tabs. If there are two
1928 * adjacent tabs then 'src == i', the memcpy is of size 0 and the spaces
1929 * are inserted.
1930 */
1931 for (i = 0, src = 0, dst = 0; i < line_len && num_tabs; i++) {
1932 if (line[i] == '\t') {
1933 len = i - src;
1934 memcpy(&new_line[dst], &line[src], len);
1935 dst += len;
1936 new_line[dst++] = ' ';
1937 while (dst % 8 != 0)
1938 new_line[dst++] = ' ';
1939 src = i + 1;
1940 num_tabs--;
1941 }
1942 }
1943
1944 /* Expand the last region. */
1945 len = line_len - src;
1946 memcpy(&new_line[dst], &line[src], len);
1947 dst += len;
1948 new_line[dst] = '\0';
1949
1950 free(*storage);
1951 *storage = new_line;
1952 *storage_len = new_storage_len;
1953 return new_line;
1954
1955}
1956
1957static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1958{
1959 struct annotation_options *opts = args->options;
1960 struct map *map = args->ms.map;
1961 struct dso *dso = map->dso;
1962 char *command;
1963 FILE *file;
1964 char symfs_filename[PATH_MAX];
1965 struct kcore_extract kce;
1966 bool delete_extract = false;
1967 bool decomp = false;
1968 int lineno = 0;
1969 char *fileloc = NULL;
1970 int nline;
1971 char *line;
1972 size_t line_len;
1973 const char *objdump_argv[] = {
1974 "/bin/sh",
1975 "-c",
1976 NULL, /* Will be the objdump command to run. */
1977 "--",
1978 NULL, /* Will be the symfs path. */
1979 NULL,
1980 };
1981 struct child_process objdump_process;
1982 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1983
1984 if (err)
1985 return err;
1986
1987 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1988 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1989 map->unmap_ip(map, sym->end));
1990
1991 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1992 dso, dso->long_name, sym, sym->name);
1993
1994 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1995 return symbol__disassemble_bpf(sym, args);
1996 } else if (dso->binary_type == DSO_BINARY_TYPE__BPF_IMAGE) {
1997 return symbol__disassemble_bpf_image(sym, args);
1998 } else if (dso__is_kcore(dso)) {
1999 kce.kcore_filename = symfs_filename;
2000 kce.addr = map__rip_2objdump(map, sym->start);
2001 kce.offs = sym->start;
2002 kce.len = sym->end - sym->start;
2003 if (!kcore_extract__create(&kce)) {
2004 delete_extract = true;
2005 strlcpy(symfs_filename, kce.extract_filename,
2006 sizeof(symfs_filename));
2007 }
2008 } else if (dso__needs_decompress(dso)) {
2009 char tmp[KMOD_DECOMP_LEN];
2010
2011 if (dso__decompress_kmodule_path(dso, symfs_filename,
2012 tmp, sizeof(tmp)) < 0)
2013 return -1;
2014
2015 decomp = true;
2016 strcpy(symfs_filename, tmp);
2017 }
2018
2019 err = asprintf(&command,
2020 "%s %s%s --start-address=0x%016" PRIx64
2021 " --stop-address=0x%016" PRIx64
2022 " -l -d %s %s %s %c%s%c %s%s -C \"$1\"",
2023 opts->objdump_path ?: "objdump",
2024 opts->disassembler_style ? "-M " : "",
2025 opts->disassembler_style ?: "",
2026 map__rip_2objdump(map, sym->start),
2027 map__rip_2objdump(map, sym->end),
2028 opts->show_asm_raw ? "" : "--no-show-raw-insn",
2029 opts->annotate_src ? "-S" : "",
2030 opts->prefix ? "--prefix " : "",
2031 opts->prefix ? '"' : ' ',
2032 opts->prefix ?: "",
2033 opts->prefix ? '"' : ' ',
2034 opts->prefix_strip ? "--prefix-strip=" : "",
2035 opts->prefix_strip ?: "");
2036
2037 if (err < 0) {
2038 pr_err("Failure allocating memory for the command to run\n");
2039 goto out_remove_tmp;
2040 }
2041
2042 pr_debug("Executing: %s\n", command);
2043
2044 objdump_argv[2] = command;
2045 objdump_argv[4] = symfs_filename;
2046
2047 /* Create a pipe to read from for stdout */
2048 memset(&objdump_process, 0, sizeof(objdump_process));
2049 objdump_process.argv = objdump_argv;
2050 objdump_process.out = -1;
2051 objdump_process.err = -1;
2052 objdump_process.no_stderr = 1;
2053 if (start_command(&objdump_process)) {
2054 pr_err("Failure starting to run %s\n", command);
2055 err = -1;
2056 goto out_free_command;
2057 }
2058
2059 file = fdopen(objdump_process.out, "r");
2060 if (!file) {
2061 pr_err("Failure creating FILE stream for %s\n", command);
2062 /*
2063 * If we were using debug info should retry with
2064 * original binary.
2065 */
2066 err = -1;
2067 goto out_close_stdout;
2068 }
2069
2070 /* Storage for getline. */
2071 line = NULL;
2072 line_len = 0;
2073
2074 nline = 0;
2075 while (!feof(file)) {
2076 const char *match;
2077 char *expanded_line;
2078
2079 if (getline(&line, &line_len, file) < 0 || !line)
2080 break;
2081
2082 /* Skip lines containing "filename:" */
2083 match = strstr(line, symfs_filename);
2084 if (match && match[strlen(symfs_filename)] == ':')
2085 continue;
2086
2087 expanded_line = strim(line);
2088 expanded_line = expand_tabs(expanded_line, &line, &line_len);
2089 if (!expanded_line)
2090 break;
2091
2092 /*
2093 * The source code line number (lineno) needs to be kept in
2094 * across calls to symbol__parse_objdump_line(), so that it
2095 * can associate it with the instructions till the next one.
2096 * See disasm_line__new() and struct disasm_line::line_nr.
2097 */
2098 if (symbol__parse_objdump_line(sym, args, expanded_line,
2099 &lineno, &fileloc) < 0)
2100 break;
2101 nline++;
2102 }
2103 free(line);
2104
2105 err = finish_command(&objdump_process);
2106 if (err)
2107 pr_err("Error running %s\n", command);
2108
2109 if (nline == 0) {
2110 err = -1;
2111 pr_err("No output from %s\n", command);
2112 }
2113
2114 /*
2115 * kallsyms does not have symbol sizes so there may a nop at the end.
2116 * Remove it.
2117 */
2118 if (dso__is_kcore(dso))
2119 delete_last_nop(sym);
2120
2121 fclose(file);
2122
2123out_close_stdout:
2124 close(objdump_process.out);
2125
2126out_free_command:
2127 free(command);
2128
2129out_remove_tmp:
2130 if (decomp)
2131 unlink(symfs_filename);
2132
2133 if (delete_extract)
2134 kcore_extract__delete(&kce);
2135
2136 return err;
2137}
2138
2139static void calc_percent(struct sym_hist *sym_hist,
2140 struct hists *hists,
2141 struct annotation_data *data,
2142 s64 offset, s64 end)
2143{
2144 unsigned int hits = 0;
2145 u64 period = 0;
2146
2147 while (offset < end) {
2148 hits += sym_hist->addr[offset].nr_samples;
2149 period += sym_hist->addr[offset].period;
2150 ++offset;
2151 }
2152
2153 if (sym_hist->nr_samples) {
2154 data->he.period = period;
2155 data->he.nr_samples = hits;
2156 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2157 }
2158
2159 if (hists->stats.nr_non_filtered_samples)
2160 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2161
2162 if (sym_hist->period)
2163 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2164
2165 if (hists->stats.total_period)
2166 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2167}
2168
2169static void annotation__calc_percent(struct annotation *notes,
2170 struct evsel *leader, s64 len)
2171{
2172 struct annotation_line *al, *next;
2173 struct evsel *evsel;
2174
2175 list_for_each_entry(al, ¬es->src->source, node) {
2176 s64 end;
2177 int i = 0;
2178
2179 if (al->offset == -1)
2180 continue;
2181
2182 next = annotation_line__next(al, ¬es->src->source);
2183 end = next ? next->offset : len;
2184
2185 for_each_group_evsel(evsel, leader) {
2186 struct hists *hists = evsel__hists(evsel);
2187 struct annotation_data *data;
2188 struct sym_hist *sym_hist;
2189
2190 BUG_ON(i >= al->data_nr);
2191
2192 sym_hist = annotation__histogram(notes, evsel->core.idx);
2193 data = &al->data[i++];
2194
2195 calc_percent(sym_hist, hists, data, al->offset, end);
2196 }
2197 }
2198}
2199
2200void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
2201{
2202 struct annotation *notes = symbol__annotation(sym);
2203
2204 annotation__calc_percent(notes, evsel, symbol__size(sym));
2205}
2206
2207int symbol__annotate(struct map_symbol *ms, struct evsel *evsel,
2208 struct annotation_options *options, struct arch **parch)
2209{
2210 struct symbol *sym = ms->sym;
2211 struct annotation *notes = symbol__annotation(sym);
2212 struct annotate_args args = {
2213 .evsel = evsel,
2214 .options = options,
2215 };
2216 struct perf_env *env = evsel__env(evsel);
2217 const char *arch_name = perf_env__arch(env);
2218 struct arch *arch;
2219 int err;
2220
2221 if (!arch_name)
2222 return errno;
2223
2224 args.arch = arch = arch__find(arch_name);
2225 if (arch == NULL) {
2226 pr_err("%s: unsupported arch %s\n", __func__, arch_name);
2227 return ENOTSUP;
2228 }
2229
2230 if (parch)
2231 *parch = arch;
2232
2233 if (arch->init) {
2234 err = arch->init(arch, env ? env->cpuid : NULL);
2235 if (err) {
2236 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2237 return err;
2238 }
2239 }
2240
2241 args.ms = *ms;
2242 if (notes->options && notes->options->full_addr)
2243 notes->start = map__objdump_2mem(ms->map, ms->sym->start);
2244 else
2245 notes->start = map__rip_2objdump(ms->map, ms->sym->start);
2246
2247 return symbol__disassemble(sym, &args);
2248}
2249
2250static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2251 struct annotation_options *opts)
2252{
2253 struct annotation_line *iter;
2254 struct rb_node **p = &root->rb_node;
2255 struct rb_node *parent = NULL;
2256 int i, ret;
2257
2258 while (*p != NULL) {
2259 parent = *p;
2260 iter = rb_entry(parent, struct annotation_line, rb_node);
2261
2262 ret = strcmp(iter->path, al->path);
2263 if (ret == 0) {
2264 for (i = 0; i < al->data_nr; i++) {
2265 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2266 opts->percent_type);
2267 }
2268 return;
2269 }
2270
2271 if (ret < 0)
2272 p = &(*p)->rb_left;
2273 else
2274 p = &(*p)->rb_right;
2275 }
2276
2277 for (i = 0; i < al->data_nr; i++) {
2278 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2279 opts->percent_type);
2280 }
2281
2282 rb_link_node(&al->rb_node, parent, p);
2283 rb_insert_color(&al->rb_node, root);
2284}
2285
2286static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2287{
2288 int i;
2289
2290 for (i = 0; i < a->data_nr; i++) {
2291 if (a->data[i].percent_sum == b->data[i].percent_sum)
2292 continue;
2293 return a->data[i].percent_sum > b->data[i].percent_sum;
2294 }
2295
2296 return 0;
2297}
2298
2299static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2300{
2301 struct annotation_line *iter;
2302 struct rb_node **p = &root->rb_node;
2303 struct rb_node *parent = NULL;
2304
2305 while (*p != NULL) {
2306 parent = *p;
2307 iter = rb_entry(parent, struct annotation_line, rb_node);
2308
2309 if (cmp_source_line(al, iter))
2310 p = &(*p)->rb_left;
2311 else
2312 p = &(*p)->rb_right;
2313 }
2314
2315 rb_link_node(&al->rb_node, parent, p);
2316 rb_insert_color(&al->rb_node, root);
2317}
2318
2319static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2320{
2321 struct annotation_line *al;
2322 struct rb_node *node;
2323
2324 node = rb_first(src_root);
2325 while (node) {
2326 struct rb_node *next;
2327
2328 al = rb_entry(node, struct annotation_line, rb_node);
2329 next = rb_next(node);
2330 rb_erase(node, src_root);
2331
2332 __resort_source_line(dest_root, al);
2333 node = next;
2334 }
2335}
2336
2337static void print_summary(struct rb_root *root, const char *filename)
2338{
2339 struct annotation_line *al;
2340 struct rb_node *node;
2341
2342 printf("\nSorted summary for file %s\n", filename);
2343 printf("----------------------------------------------\n\n");
2344
2345 if (RB_EMPTY_ROOT(root)) {
2346 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2347 return;
2348 }
2349
2350 node = rb_first(root);
2351 while (node) {
2352 double percent, percent_max = 0.0;
2353 const char *color;
2354 char *path;
2355 int i;
2356
2357 al = rb_entry(node, struct annotation_line, rb_node);
2358 for (i = 0; i < al->data_nr; i++) {
2359 percent = al->data[i].percent_sum;
2360 color = get_percent_color(percent);
2361 color_fprintf(stdout, color, " %7.2f", percent);
2362
2363 if (percent > percent_max)
2364 percent_max = percent;
2365 }
2366
2367 path = al->path;
2368 color = get_percent_color(percent_max);
2369 color_fprintf(stdout, color, " %s\n", path);
2370
2371 node = rb_next(node);
2372 }
2373}
2374
2375static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
2376{
2377 struct annotation *notes = symbol__annotation(sym);
2378 struct sym_hist *h = annotation__histogram(notes, evsel->core.idx);
2379 u64 len = symbol__size(sym), offset;
2380
2381 for (offset = 0; offset < len; ++offset)
2382 if (h->addr[offset].nr_samples != 0)
2383 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2384 sym->start + offset, h->addr[offset].nr_samples);
2385 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2386}
2387
2388static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2389{
2390 char bf[32];
2391 struct annotation_line *line;
2392
2393 list_for_each_entry_reverse(line, lines, node) {
2394 if (line->offset != -1)
2395 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2396 }
2397
2398 return 0;
2399}
2400
2401int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
2402 struct annotation_options *opts)
2403{
2404 struct map *map = ms->map;
2405 struct symbol *sym = ms->sym;
2406 struct dso *dso = map->dso;
2407 char *filename;
2408 const char *d_filename;
2409 const char *evsel_name = evsel__name(evsel);
2410 struct annotation *notes = symbol__annotation(sym);
2411 struct sym_hist *h = annotation__histogram(notes, evsel->core.idx);
2412 struct annotation_line *pos, *queue = NULL;
2413 u64 start = map__rip_2objdump(map, sym->start);
2414 int printed = 2, queue_len = 0, addr_fmt_width;
2415 int more = 0;
2416 bool context = opts->context;
2417 u64 len;
2418 int width = symbol_conf.show_total_period ? 12 : 8;
2419 int graph_dotted_len;
2420 char buf[512];
2421
2422 filename = strdup(dso->long_name);
2423 if (!filename)
2424 return -ENOMEM;
2425
2426 if (opts->full_path)
2427 d_filename = filename;
2428 else
2429 d_filename = basename(filename);
2430
2431 len = symbol__size(sym);
2432
2433 if (evsel__is_group_event(evsel)) {
2434 width *= evsel->core.nr_members;
2435 evsel__group_desc(evsel, buf, sizeof(buf));
2436 evsel_name = buf;
2437 }
2438
2439 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2440 "percent: %s)\n",
2441 width, width, symbol_conf.show_total_period ? "Period" :
2442 symbol_conf.show_nr_samples ? "Samples" : "Percent",
2443 d_filename, evsel_name, h->nr_samples,
2444 percent_type_str(opts->percent_type));
2445
2446 printf("%-*.*s----\n",
2447 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2448
2449 if (verbose > 0)
2450 symbol__annotate_hits(sym, evsel);
2451
2452 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2453
2454 list_for_each_entry(pos, ¬es->src->source, node) {
2455 int err;
2456
2457 if (context && queue == NULL) {
2458 queue = pos;
2459 queue_len = 0;
2460 }
2461
2462 err = annotation_line__print(pos, sym, start, evsel, len,
2463 opts->min_pcnt, printed, opts->max_lines,
2464 queue, addr_fmt_width, opts->percent_type);
2465
2466 switch (err) {
2467 case 0:
2468 ++printed;
2469 if (context) {
2470 printed += queue_len;
2471 queue = NULL;
2472 queue_len = 0;
2473 }
2474 break;
2475 case 1:
2476 /* filtered by max_lines */
2477 ++more;
2478 break;
2479 case -1:
2480 default:
2481 /*
2482 * Filtered by min_pcnt or non IP lines when
2483 * context != 0
2484 */
2485 if (!context)
2486 break;
2487 if (queue_len == context)
2488 queue = list_entry(queue->node.next, typeof(*queue), node);
2489 else
2490 ++queue_len;
2491 break;
2492 }
2493 }
2494
2495 free(filename);
2496
2497 return more;
2498}
2499
2500static void FILE__set_percent_color(void *fp __maybe_unused,
2501 double percent __maybe_unused,
2502 bool current __maybe_unused)
2503{
2504}
2505
2506static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2507 int nr __maybe_unused, bool current __maybe_unused)
2508{
2509 return 0;
2510}
2511
2512static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2513{
2514 return 0;
2515}
2516
2517static void FILE__printf(void *fp, const char *fmt, ...)
2518{
2519 va_list args;
2520
2521 va_start(args, fmt);
2522 vfprintf(fp, fmt, args);
2523 va_end(args);
2524}
2525
2526static void FILE__write_graph(void *fp, int graph)
2527{
2528 const char *s;
2529 switch (graph) {
2530
2531 case DARROW_CHAR: s = "↓"; break;
2532 case UARROW_CHAR: s = "↑"; break;
2533 case LARROW_CHAR: s = "←"; break;
2534 case RARROW_CHAR: s = "→"; break;
2535 default: s = "?"; break;
2536 }
2537
2538 fputs(s, fp);
2539}
2540
2541static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2542 struct annotation_options *opts)
2543{
2544 struct annotation *notes = symbol__annotation(sym);
2545 struct annotation_write_ops wops = {
2546 .first_line = true,
2547 .obj = fp,
2548 .set_color = FILE__set_color,
2549 .set_percent_color = FILE__set_percent_color,
2550 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2551 .printf = FILE__printf,
2552 .write_graph = FILE__write_graph,
2553 };
2554 struct annotation_line *al;
2555
2556 list_for_each_entry(al, ¬es->src->source, node) {
2557 if (annotation_line__filter(al, notes))
2558 continue;
2559 annotation_line__write(al, notes, &wops, opts);
2560 fputc('\n', fp);
2561 wops.first_line = false;
2562 }
2563
2564 return 0;
2565}
2566
2567int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
2568 struct annotation_options *opts)
2569{
2570 const char *ev_name = evsel__name(evsel);
2571 char buf[1024];
2572 char *filename;
2573 int err = -1;
2574 FILE *fp;
2575
2576 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2577 return -1;
2578
2579 fp = fopen(filename, "w");
2580 if (fp == NULL)
2581 goto out_free_filename;
2582
2583 if (evsel__is_group_event(evsel)) {
2584 evsel__group_desc(evsel, buf, sizeof(buf));
2585 ev_name = buf;
2586 }
2587
2588 fprintf(fp, "%s() %s\nEvent: %s\n\n",
2589 ms->sym->name, ms->map->dso->long_name, ev_name);
2590 symbol__annotate_fprintf2(ms->sym, fp, opts);
2591
2592 fclose(fp);
2593 err = 0;
2594out_free_filename:
2595 free(filename);
2596 return err;
2597}
2598
2599void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2600{
2601 struct annotation *notes = symbol__annotation(sym);
2602 struct sym_hist *h = annotation__histogram(notes, evidx);
2603
2604 memset(h, 0, notes->src->sizeof_sym_hist);
2605}
2606
2607void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2608{
2609 struct annotation *notes = symbol__annotation(sym);
2610 struct sym_hist *h = annotation__histogram(notes, evidx);
2611 int len = symbol__size(sym), offset;
2612
2613 h->nr_samples = 0;
2614 for (offset = 0; offset < len; ++offset) {
2615 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2616 h->nr_samples += h->addr[offset].nr_samples;
2617 }
2618}
2619
2620void annotated_source__purge(struct annotated_source *as)
2621{
2622 struct annotation_line *al, *n;
2623
2624 list_for_each_entry_safe(al, n, &as->source, node) {
2625 list_del_init(&al->node);
2626 disasm_line__free(disasm_line(al));
2627 }
2628}
2629
2630static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2631{
2632 size_t printed;
2633
2634 if (dl->al.offset == -1)
2635 return fprintf(fp, "%s\n", dl->al.line);
2636
2637 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2638
2639 if (dl->ops.raw[0] != '\0') {
2640 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2641 dl->ops.raw);
2642 }
2643
2644 return printed + fprintf(fp, "\n");
2645}
2646
2647size_t disasm__fprintf(struct list_head *head, FILE *fp)
2648{
2649 struct disasm_line *pos;
2650 size_t printed = 0;
2651
2652 list_for_each_entry(pos, head, al.node)
2653 printed += disasm_line__fprintf(pos, fp);
2654
2655 return printed;
2656}
2657
2658bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2659{
2660 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2661 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2662 dl->ops.target.offset >= (s64)symbol__size(sym))
2663 return false;
2664
2665 return true;
2666}
2667
2668void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2669{
2670 u64 offset, size = symbol__size(sym);
2671
2672 /* PLT symbols contain external offsets */
2673 if (strstr(sym->name, "@plt"))
2674 return;
2675
2676 for (offset = 0; offset < size; ++offset) {
2677 struct annotation_line *al = notes->offsets[offset];
2678 struct disasm_line *dl;
2679
2680 dl = disasm_line(al);
2681
2682 if (!disasm_line__is_valid_local_jump(dl, sym))
2683 continue;
2684
2685 al = notes->offsets[dl->ops.target.offset];
2686
2687 /*
2688 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2689 * have to adjust to the previous offset?
2690 */
2691 if (al == NULL)
2692 continue;
2693
2694 if (++al->jump_sources > notes->max_jump_sources)
2695 notes->max_jump_sources = al->jump_sources;
2696 }
2697}
2698
2699void annotation__set_offsets(struct annotation *notes, s64 size)
2700{
2701 struct annotation_line *al;
2702
2703 notes->max_line_len = 0;
2704 notes->nr_entries = 0;
2705 notes->nr_asm_entries = 0;
2706
2707 list_for_each_entry(al, ¬es->src->source, node) {
2708 size_t line_len = strlen(al->line);
2709
2710 if (notes->max_line_len < line_len)
2711 notes->max_line_len = line_len;
2712 al->idx = notes->nr_entries++;
2713 if (al->offset != -1) {
2714 al->idx_asm = notes->nr_asm_entries++;
2715 /*
2716 * FIXME: short term bandaid to cope with assembly
2717 * routines that comes with labels in the same column
2718 * as the address in objdump, sigh.
2719 *
2720 * E.g. copy_user_generic_unrolled
2721 */
2722 if (al->offset < size)
2723 notes->offsets[al->offset] = al;
2724 } else
2725 al->idx_asm = -1;
2726 }
2727}
2728
2729static inline int width_jumps(int n)
2730{
2731 if (n >= 100)
2732 return 5;
2733 if (n / 10)
2734 return 2;
2735 return 1;
2736}
2737
2738static int annotation__max_ins_name(struct annotation *notes)
2739{
2740 int max_name = 0, len;
2741 struct annotation_line *al;
2742
2743 list_for_each_entry(al, ¬es->src->source, node) {
2744 if (al->offset == -1)
2745 continue;
2746
2747 len = strlen(disasm_line(al)->ins.name);
2748 if (max_name < len)
2749 max_name = len;
2750 }
2751
2752 return max_name;
2753}
2754
2755void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2756{
2757 notes->widths.addr = notes->widths.target =
2758 notes->widths.min_addr = hex_width(symbol__size(sym));
2759 notes->widths.max_addr = hex_width(sym->end);
2760 notes->widths.jumps = width_jumps(notes->max_jump_sources);
2761 notes->widths.max_ins_name = annotation__max_ins_name(notes);
2762}
2763
2764void annotation__update_column_widths(struct annotation *notes)
2765{
2766 if (notes->options->use_offset)
2767 notes->widths.target = notes->widths.min_addr;
2768 else if (notes->options->full_addr)
2769 notes->widths.target = BITS_PER_LONG / 4;
2770 else
2771 notes->widths.target = notes->widths.max_addr;
2772
2773 notes->widths.addr = notes->widths.target;
2774
2775 if (notes->options->show_nr_jumps)
2776 notes->widths.addr += notes->widths.jumps + 1;
2777}
2778
2779void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms)
2780{
2781 notes->options->full_addr = !notes->options->full_addr;
2782
2783 if (notes->options->full_addr)
2784 notes->start = map__objdump_2mem(ms->map, ms->sym->start);
2785 else
2786 notes->start = map__rip_2objdump(ms->map, ms->sym->start);
2787
2788 annotation__update_column_widths(notes);
2789}
2790
2791static void annotation__calc_lines(struct annotation *notes, struct map *map,
2792 struct rb_root *root,
2793 struct annotation_options *opts)
2794{
2795 struct annotation_line *al;
2796 struct rb_root tmp_root = RB_ROOT;
2797
2798 list_for_each_entry(al, ¬es->src->source, node) {
2799 double percent_max = 0.0;
2800 int i;
2801
2802 for (i = 0; i < al->data_nr; i++) {
2803 double percent;
2804
2805 percent = annotation_data__percent(&al->data[i],
2806 opts->percent_type);
2807
2808 if (percent > percent_max)
2809 percent_max = percent;
2810 }
2811
2812 if (percent_max <= 0.5)
2813 continue;
2814
2815 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2816 false, true, notes->start + al->offset);
2817 insert_source_line(&tmp_root, al, opts);
2818 }
2819
2820 resort_source_line(root, &tmp_root);
2821}
2822
2823static void symbol__calc_lines(struct map_symbol *ms, struct rb_root *root,
2824 struct annotation_options *opts)
2825{
2826 struct annotation *notes = symbol__annotation(ms->sym);
2827
2828 annotation__calc_lines(notes, ms->map, root, opts);
2829}
2830
2831int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel,
2832 struct annotation_options *opts)
2833{
2834 struct dso *dso = ms->map->dso;
2835 struct symbol *sym = ms->sym;
2836 struct rb_root source_line = RB_ROOT;
2837 struct hists *hists = evsel__hists(evsel);
2838 char buf[1024];
2839 int err;
2840
2841 err = symbol__annotate2(ms, evsel, opts, NULL);
2842 if (err) {
2843 char msg[BUFSIZ];
2844
2845 dso->annotate_warned = true;
2846 symbol__strerror_disassemble(ms, err, msg, sizeof(msg));
2847 ui__error("Couldn't annotate %s:\n%s", sym->name, msg);
2848 return -1;
2849 }
2850
2851 if (opts->print_lines) {
2852 srcline_full_filename = opts->full_path;
2853 symbol__calc_lines(ms, &source_line, opts);
2854 print_summary(&source_line, dso->long_name);
2855 }
2856
2857 hists__scnprintf_title(hists, buf, sizeof(buf));
2858 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2859 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2860 symbol__annotate_fprintf2(sym, stdout, opts);
2861
2862 annotated_source__purge(symbol__annotation(sym)->src);
2863
2864 return 0;
2865}
2866
2867int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel,
2868 struct annotation_options *opts)
2869{
2870 struct dso *dso = ms->map->dso;
2871 struct symbol *sym = ms->sym;
2872 struct rb_root source_line = RB_ROOT;
2873 int err;
2874
2875 err = symbol__annotate(ms, evsel, opts, NULL);
2876 if (err) {
2877 char msg[BUFSIZ];
2878
2879 dso->annotate_warned = true;
2880 symbol__strerror_disassemble(ms, err, msg, sizeof(msg));
2881 ui__error("Couldn't annotate %s:\n%s", sym->name, msg);
2882 return -1;
2883 }
2884
2885 symbol__calc_percent(sym, evsel);
2886
2887 if (opts->print_lines) {
2888 srcline_full_filename = opts->full_path;
2889 symbol__calc_lines(ms, &source_line, opts);
2890 print_summary(&source_line, dso->long_name);
2891 }
2892
2893 symbol__annotate_printf(ms, evsel, opts);
2894
2895 annotated_source__purge(symbol__annotation(sym)->src);
2896
2897 return 0;
2898}
2899
2900bool ui__has_annotation(void)
2901{
2902 return use_browser == 1 && perf_hpp_list.sym;
2903}
2904
2905
2906static double annotation_line__max_percent(struct annotation_line *al,
2907 struct annotation *notes,
2908 unsigned int percent_type)
2909{
2910 double percent_max = 0.0;
2911 int i;
2912
2913 for (i = 0; i < notes->nr_events; i++) {
2914 double percent;
2915
2916 percent = annotation_data__percent(&al->data[i],
2917 percent_type);
2918
2919 if (percent > percent_max)
2920 percent_max = percent;
2921 }
2922
2923 return percent_max;
2924}
2925
2926static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2927 void *obj, char *bf, size_t size,
2928 void (*obj__printf)(void *obj, const char *fmt, ...),
2929 void (*obj__write_graph)(void *obj, int graph))
2930{
2931 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2932 if (ins__is_jump(&dl->ins)) {
2933 bool fwd;
2934
2935 if (dl->ops.target.outside)
2936 goto call_like;
2937 fwd = dl->ops.target.offset > dl->al.offset;
2938 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2939 obj__printf(obj, " ");
2940 } else if (ins__is_call(&dl->ins)) {
2941call_like:
2942 obj__write_graph(obj, RARROW_CHAR);
2943 obj__printf(obj, " ");
2944 } else if (ins__is_ret(&dl->ins)) {
2945 obj__write_graph(obj, LARROW_CHAR);
2946 obj__printf(obj, " ");
2947 } else {
2948 obj__printf(obj, " ");
2949 }
2950 } else {
2951 obj__printf(obj, " ");
2952 }
2953
2954 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2955}
2956
2957static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2958{
2959 double ipc = 0.0, coverage = 0.0;
2960
2961 if (notes->hit_cycles)
2962 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2963
2964 if (notes->total_insn) {
2965 coverage = notes->cover_insn * 100.0 /
2966 ((double)notes->total_insn);
2967 }
2968
2969 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2970 ipc, coverage);
2971}
2972
2973static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2974 bool first_line, bool current_entry, bool change_color, int width,
2975 void *obj, unsigned int percent_type,
2976 int (*obj__set_color)(void *obj, int color),
2977 void (*obj__set_percent_color)(void *obj, double percent, bool current),
2978 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2979 void (*obj__printf)(void *obj, const char *fmt, ...),
2980 void (*obj__write_graph)(void *obj, int graph))
2981
2982{
2983 double percent_max = annotation_line__max_percent(al, notes, percent_type);
2984 int pcnt_width = annotation__pcnt_width(notes),
2985 cycles_width = annotation__cycles_width(notes);
2986 bool show_title = false;
2987 char bf[256];
2988 int printed;
2989
2990 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2991 if (notes->have_cycles) {
2992 if (al->ipc == 0.0 && al->cycles == 0)
2993 show_title = true;
2994 } else
2995 show_title = true;
2996 }
2997
2998 if (al->offset != -1 && percent_max != 0.0) {
2999 int i;
3000
3001 for (i = 0; i < notes->nr_events; i++) {
3002 double percent;
3003
3004 percent = annotation_data__percent(&al->data[i], percent_type);
3005
3006 obj__set_percent_color(obj, percent, current_entry);
3007 if (symbol_conf.show_total_period) {
3008 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
3009 } else if (symbol_conf.show_nr_samples) {
3010 obj__printf(obj, "%6" PRIu64 " ",
3011 al->data[i].he.nr_samples);
3012 } else {
3013 obj__printf(obj, "%6.2f ", percent);
3014 }
3015 }
3016 } else {
3017 obj__set_percent_color(obj, 0, current_entry);
3018
3019 if (!show_title)
3020 obj__printf(obj, "%-*s", pcnt_width, " ");
3021 else {
3022 obj__printf(obj, "%-*s", pcnt_width,
3023 symbol_conf.show_total_period ? "Period" :
3024 symbol_conf.show_nr_samples ? "Samples" : "Percent");
3025 }
3026 }
3027
3028 if (notes->have_cycles) {
3029 if (al->ipc)
3030 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
3031 else if (!show_title)
3032 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
3033 else
3034 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
3035
3036 if (!notes->options->show_minmax_cycle) {
3037 if (al->cycles)
3038 obj__printf(obj, "%*" PRIu64 " ",
3039 ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
3040 else if (!show_title)
3041 obj__printf(obj, "%*s",
3042 ANNOTATION__CYCLES_WIDTH, " ");
3043 else
3044 obj__printf(obj, "%*s ",
3045 ANNOTATION__CYCLES_WIDTH - 1,
3046 "Cycle");
3047 } else {
3048 if (al->cycles) {
3049 char str[32];
3050
3051 scnprintf(str, sizeof(str),
3052 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
3053 al->cycles, al->cycles_min,
3054 al->cycles_max);
3055
3056 obj__printf(obj, "%*s ",
3057 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
3058 str);
3059 } else if (!show_title)
3060 obj__printf(obj, "%*s",
3061 ANNOTATION__MINMAX_CYCLES_WIDTH,
3062 " ");
3063 else
3064 obj__printf(obj, "%*s ",
3065 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
3066 "Cycle(min/max)");
3067 }
3068
3069 if (show_title && !*al->line) {
3070 ipc_coverage_string(bf, sizeof(bf), notes);
3071 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
3072 }
3073 }
3074
3075 obj__printf(obj, " ");
3076
3077 if (!*al->line)
3078 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
3079 else if (al->offset == -1) {
3080 if (al->line_nr && notes->options->show_linenr)
3081 printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
3082 else
3083 printed = scnprintf(bf, sizeof(bf), "%-*s ", notes->widths.addr, " ");
3084 obj__printf(obj, bf);
3085 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
3086 } else {
3087 u64 addr = al->offset;
3088 int color = -1;
3089
3090 if (!notes->options->use_offset)
3091 addr += notes->start;
3092
3093 if (!notes->options->use_offset) {
3094 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
3095 } else {
3096 if (al->jump_sources &&
3097 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
3098 if (notes->options->show_nr_jumps) {
3099 int prev;
3100 printed = scnprintf(bf, sizeof(bf), "%*d ",
3101 notes->widths.jumps,
3102 al->jump_sources);
3103 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
3104 current_entry);
3105 obj__printf(obj, bf);
3106 obj__set_color(obj, prev);
3107 }
3108print_addr:
3109 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
3110 notes->widths.target, addr);
3111 } else if (ins__is_call(&disasm_line(al)->ins) &&
3112 notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
3113 goto print_addr;
3114 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
3115 goto print_addr;
3116 } else {
3117 printed = scnprintf(bf, sizeof(bf), "%-*s ",
3118 notes->widths.addr, " ");
3119 }
3120 }
3121
3122 if (change_color)
3123 color = obj__set_color(obj, HE_COLORSET_ADDR);
3124 obj__printf(obj, bf);
3125 if (change_color)
3126 obj__set_color(obj, color);
3127
3128 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
3129
3130 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
3131 }
3132
3133}
3134
3135void annotation_line__write(struct annotation_line *al, struct annotation *notes,
3136 struct annotation_write_ops *wops,
3137 struct annotation_options *opts)
3138{
3139 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
3140 wops->change_color, wops->width, wops->obj,
3141 opts->percent_type,
3142 wops->set_color, wops->set_percent_color,
3143 wops->set_jumps_percent_color, wops->printf,
3144 wops->write_graph);
3145}
3146
3147int symbol__annotate2(struct map_symbol *ms, struct evsel *evsel,
3148 struct annotation_options *options, struct arch **parch)
3149{
3150 struct symbol *sym = ms->sym;
3151 struct annotation *notes = symbol__annotation(sym);
3152 size_t size = symbol__size(sym);
3153 int nr_pcnt = 1, err;
3154
3155 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
3156 if (notes->offsets == NULL)
3157 return ENOMEM;
3158
3159 if (evsel__is_group_event(evsel))
3160 nr_pcnt = evsel->core.nr_members;
3161
3162 err = symbol__annotate(ms, evsel, options, parch);
3163 if (err)
3164 goto out_free_offsets;
3165
3166 notes->options = options;
3167
3168 symbol__calc_percent(sym, evsel);
3169
3170 annotation__set_offsets(notes, size);
3171 annotation__mark_jump_targets(notes, sym);
3172 annotation__compute_ipc(notes, size);
3173 annotation__init_column_widths(notes, sym);
3174 notes->nr_events = nr_pcnt;
3175
3176 annotation__update_column_widths(notes);
3177 sym->annotate2 = 1;
3178
3179 return 0;
3180
3181out_free_offsets:
3182 zfree(¬es->offsets);
3183 return err;
3184}
3185
3186static int annotation__config(const char *var, const char *value, void *data)
3187{
3188 struct annotation_options *opt = data;
3189
3190 if (!strstarts(var, "annotate."))
3191 return 0;
3192
3193 if (!strcmp(var, "annotate.offset_level")) {
3194 perf_config_u8(&opt->offset_level, "offset_level", value);
3195
3196 if (opt->offset_level > ANNOTATION__MAX_OFFSET_LEVEL)
3197 opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
3198 else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
3199 opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
3200 } else if (!strcmp(var, "annotate.hide_src_code")) {
3201 opt->hide_src_code = perf_config_bool("hide_src_code", value);
3202 } else if (!strcmp(var, "annotate.jump_arrows")) {
3203 opt->jump_arrows = perf_config_bool("jump_arrows", value);
3204 } else if (!strcmp(var, "annotate.show_linenr")) {
3205 opt->show_linenr = perf_config_bool("show_linenr", value);
3206 } else if (!strcmp(var, "annotate.show_nr_jumps")) {
3207 opt->show_nr_jumps = perf_config_bool("show_nr_jumps", value);
3208 } else if (!strcmp(var, "annotate.show_nr_samples")) {
3209 symbol_conf.show_nr_samples = perf_config_bool("show_nr_samples",
3210 value);
3211 } else if (!strcmp(var, "annotate.show_total_period")) {
3212 symbol_conf.show_total_period = perf_config_bool("show_total_period",
3213 value);
3214 } else if (!strcmp(var, "annotate.use_offset")) {
3215 opt->use_offset = perf_config_bool("use_offset", value);
3216 } else if (!strcmp(var, "annotate.disassembler_style")) {
3217 opt->disassembler_style = value;
3218 } else if (!strcmp(var, "annotate.demangle")) {
3219 symbol_conf.demangle = perf_config_bool("demangle", value);
3220 } else if (!strcmp(var, "annotate.demangle_kernel")) {
3221 symbol_conf.demangle_kernel = perf_config_bool("demangle_kernel", value);
3222 } else {
3223 pr_debug("%s variable unknown, ignoring...", var);
3224 }
3225
3226 return 0;
3227}
3228
3229void annotation_config__init(struct annotation_options *opt)
3230{
3231 perf_config(annotation__config, opt);
3232}
3233
3234static unsigned int parse_percent_type(char *str1, char *str2)
3235{
3236 unsigned int type = (unsigned int) -1;
3237
3238 if (!strcmp("period", str1)) {
3239 if (!strcmp("local", str2))
3240 type = PERCENT_PERIOD_LOCAL;
3241 else if (!strcmp("global", str2))
3242 type = PERCENT_PERIOD_GLOBAL;
3243 }
3244
3245 if (!strcmp("hits", str1)) {
3246 if (!strcmp("local", str2))
3247 type = PERCENT_HITS_LOCAL;
3248 else if (!strcmp("global", str2))
3249 type = PERCENT_HITS_GLOBAL;
3250 }
3251
3252 return type;
3253}
3254
3255int annotate_parse_percent_type(const struct option *opt, const char *_str,
3256 int unset __maybe_unused)
3257{
3258 struct annotation_options *opts = opt->value;
3259 unsigned int type;
3260 char *str1, *str2;
3261 int err = -1;
3262
3263 str1 = strdup(_str);
3264 if (!str1)
3265 return -ENOMEM;
3266
3267 str2 = strchr(str1, '-');
3268 if (!str2)
3269 goto out;
3270
3271 *str2++ = 0;
3272
3273 type = parse_percent_type(str1, str2);
3274 if (type == (unsigned int) -1)
3275 type = parse_percent_type(str2, str1);
3276 if (type != (unsigned int) -1) {
3277 opts->percent_type = type;
3278 err = 0;
3279 }
3280
3281out:
3282 free(str1);
3283 return err;
3284}
3285
3286int annotate_check_args(struct annotation_options *args)
3287{
3288 if (args->prefix_strip && !args->prefix) {
3289 pr_err("--prefix-strip requires --prefix\n");
3290 return -1;
3291 }
3292 return 0;
3293}
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
4 *
5 * Parts came from builtin-annotate.c, see those files for further
6 * copyright notes.
7 */
8
9#include <errno.h>
10#include <inttypes.h>
11#include <libgen.h>
12#include <stdlib.h>
13#include <bpf/bpf.h>
14#include <bpf/btf.h>
15#include <bpf/libbpf.h>
16#include <linux/btf.h>
17#include "util.h" // hex_width()
18#include "ui/ui.h"
19#include "sort.h"
20#include "build-id.h"
21#include "color.h"
22#include "config.h"
23#include "dso.h"
24#include "env.h"
25#include "map.h"
26#include "maps.h"
27#include "symbol.h"
28#include "srcline.h"
29#include "units.h"
30#include "debug.h"
31#include "annotate.h"
32#include "evsel.h"
33#include "evlist.h"
34#include "bpf-event.h"
35#include "block-range.h"
36#include "string2.h"
37#include "util/event.h"
38#include "arch/common.h"
39#include <regex.h>
40#include <pthread.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>
46
47/* FIXME: For the HE_COLORSET */
48#include "ui/browser.h"
49
50/*
51 * FIXME: Using the same values as slang.h,
52 * but that header may not be available everywhere
53 */
54#define LARROW_CHAR ((unsigned char)',')
55#define RARROW_CHAR ((unsigned char)'+')
56#define DARROW_CHAR ((unsigned char)'.')
57#define UARROW_CHAR ((unsigned char)'-')
58
59#include <linux/ctype.h>
60
61struct annotation_options annotation__default_options = {
62 .use_offset = true,
63 .jump_arrows = true,
64 .annotate_src = true,
65 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
66 .percent_type = PERCENT_PERIOD_LOCAL,
67};
68
69static regex_t file_lineno;
70
71static struct ins_ops *ins__find(struct arch *arch, const char *name);
72static void ins__sort(struct arch *arch);
73static int disasm_line__parse(char *line, const char **namep, char **rawp);
74
75struct arch {
76 const char *name;
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;
82 bool initialized;
83 void *priv;
84 unsigned int model;
85 unsigned int family;
86 int (*init)(struct arch *arch, char *cpuid);
87 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
88 const char *ins2);
89 struct {
90 char comment_char;
91 char skip_functions_char;
92 } objdump;
93};
94
95static struct ins_ops call_ops;
96static struct ins_ops dec_ops;
97static struct ins_ops jump_ops;
98static struct ins_ops mov_ops;
99static struct ins_ops nop_ops;
100static struct ins_ops lock_ops;
101static struct ins_ops ret_ops;
102
103static int arch__grow_instructions(struct arch *arch)
104{
105 struct ins *new_instructions;
106 size_t new_nr_allocated;
107
108 if (arch->nr_instructions_allocated == 0 && arch->instructions)
109 goto grow_from_non_allocated_table;
110
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)
114 return -1;
115
116out_update_instructions:
117 arch->instructions = new_instructions;
118 arch->nr_instructions_allocated = new_nr_allocated;
119 return 0;
120
121grow_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)
125 return -1;
126
127 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
128 goto out_update_instructions;
129}
130
131static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
132{
133 struct ins *ins;
134
135 if (arch->nr_instructions == arch->nr_instructions_allocated &&
136 arch__grow_instructions(arch))
137 return -1;
138
139 ins = &arch->instructions[arch->nr_instructions];
140 ins->name = strdup(name);
141 if (!ins->name)
142 return -1;
143
144 ins->ops = ops;
145 arch->nr_instructions++;
146
147 ins__sort(arch);
148 return 0;
149}
150
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"
159
160static struct arch architectures[] = {
161 {
162 .name = "arc",
163 .init = arc__annotate_init,
164 },
165 {
166 .name = "arm",
167 .init = arm__annotate_init,
168 },
169 {
170 .name = "arm64",
171 .init = arm64__annotate_init,
172 },
173 {
174 .name = "csky",
175 .init = csky__annotate_init,
176 },
177 {
178 .name = "x86",
179 .init = x86__annotate_init,
180 .instructions = x86__instructions,
181 .nr_instructions = ARRAY_SIZE(x86__instructions),
182 .ins_is_fused = x86__ins_is_fused,
183 .objdump = {
184 .comment_char = '#',
185 },
186 },
187 {
188 .name = "powerpc",
189 .init = powerpc__annotate_init,
190 },
191 {
192 .name = "s390",
193 .init = s390__annotate_init,
194 .objdump = {
195 .comment_char = '#',
196 },
197 },
198 {
199 .name = "sparc",
200 .init = sparc__annotate_init,
201 .objdump = {
202 .comment_char = '#',
203 },
204 },
205};
206
207static void ins__delete(struct ins_operands *ops)
208{
209 if (ops == NULL)
210 return;
211 zfree(&ops->source.raw);
212 zfree(&ops->source.name);
213 zfree(&ops->target.raw);
214 zfree(&ops->target.name);
215}
216
217static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
218 struct ins_operands *ops, int max_ins_name)
219{
220 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
221}
222
223int ins__scnprintf(struct ins *ins, char *bf, size_t size,
224 struct ins_operands *ops, int max_ins_name)
225{
226 if (ins->ops->scnprintf)
227 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
228
229 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
230}
231
232bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
233{
234 if (!arch || !arch->ins_is_fused)
235 return false;
236
237 return arch->ins_is_fused(arch, ins1, ins2);
238}
239
240static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
241{
242 char *endptr, *tok, *name;
243 struct map *map = ms->map;
244 struct addr_map_symbol target = {
245 .ms = { .map = map, },
246 };
247
248 ops->target.addr = strtoull(ops->raw, &endptr, 16);
249
250 name = strchr(endptr, '<');
251 if (name == NULL)
252 goto indirect_call;
253
254 name++;
255
256 if (arch->objdump.skip_functions_char &&
257 strchr(name, arch->objdump.skip_functions_char))
258 return -1;
259
260 tok = strchr(name, '>');
261 if (tok == NULL)
262 return -1;
263
264 *tok = '\0';
265 ops->target.name = strdup(name);
266 *tok = '>';
267
268 if (ops->target.name == NULL)
269 return -1;
270find_target:
271 target.addr = map__objdump_2mem(map, ops->target.addr);
272
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;
276
277 return 0;
278
279indirect_call:
280 tok = strchr(endptr, '*');
281 if (tok != NULL) {
282 endptr++;
283
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);
288 }
289 goto find_target;
290}
291
292static int call__scnprintf(struct ins *ins, char *bf, size_t size,
293 struct ins_operands *ops, int max_ins_name)
294{
295 if (ops->target.sym)
296 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
297
298 if (ops->target.addr == 0)
299 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
300
301 if (ops->target.name)
302 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
303
304 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
305}
306
307static struct ins_ops call_ops = {
308 .parse = call__parse,
309 .scnprintf = call__scnprintf,
310};
311
312bool ins__is_call(const struct ins *ins)
313{
314 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
315}
316
317/*
318 * Prevents from matching commas in the comment section, e.g.:
319 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
320 */
321static inline const char *validate_comma(const char *c, struct ins_operands *ops)
322{
323 if (ops->raw_comment && c > ops->raw_comment)
324 return NULL;
325
326 return c;
327}
328
329static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
330{
331 struct map *map = ms->map;
332 struct symbol *sym = ms->sym;
333 struct addr_map_symbol target = {
334 .ms = { .map = map, },
335 };
336 const char *c = strchr(ops->raw, ',');
337 u64 start, end;
338
339 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
340 c = validate_comma(c, ops);
341
342 /*
343 * Examples of lines to parse for the _cpp_lex_token@@Base
344 * function:
345 *
346 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
347 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
348 *
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.
352 */
353 /*
354 * skip over possible up to 2 operands to get to address, e.g.:
355 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
356 */
357 if (c++ != NULL) {
358 ops->target.addr = strtoull(c, NULL, 16);
359 if (!ops->target.addr) {
360 c = strchr(c, ',');
361 c = validate_comma(c, ops);
362 if (c++ != NULL)
363 ops->target.addr = strtoull(c, NULL, 16);
364 }
365 } else {
366 ops->target.addr = strtoull(ops->raw, NULL, 16);
367 }
368
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);
372
373 ops->target.outside = target.addr < start || target.addr > end;
374
375 /*
376 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
377
378 cpp_named_operator2name@@Base+0xa72
379
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?
386 *
387 * For now lets just make some progress by marking jumps to outside the
388 * current function as call like.
389 *
390 * Actual navigation will come next, with further understanding of how
391 * the symbol searching and disassembly should be done.
392 */
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;
396
397 if (!ops->target.outside) {
398 ops->target.offset = target.addr - start;
399 ops->target.offset_avail = true;
400 } else {
401 ops->target.offset_avail = false;
402 }
403
404 return 0;
405}
406
407static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
408 struct ins_operands *ops, int max_ins_name)
409{
410 const char *c;
411
412 if (!ops->target.addr || ops->target.offset < 0)
413 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
414
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);
417
418 c = strchr(ops->raw, ',');
419 c = validate_comma(c, ops);
420
421 if (c != NULL) {
422 const char *c2 = strchr(c + 1, ',');
423
424 c2 = validate_comma(c2, ops);
425 /* check for 3-op insn */
426 if (c2 != NULL)
427 c = c2;
428 c++;
429
430 /* mirror arch objdump's space-after-comma style */
431 if (*c == ' ')
432 c++;
433 }
434
435 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
436 ins->name, c ? c - ops->raw : 0, ops->raw,
437 ops->target.offset);
438}
439
440static struct ins_ops jump_ops = {
441 .parse = jump__parse,
442 .scnprintf = jump__scnprintf,
443};
444
445bool ins__is_jump(const struct ins *ins)
446{
447 return ins->ops == &jump_ops;
448}
449
450static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
451{
452 char *endptr, *name, *t;
453
454 if (strstr(raw, "(%rip)") == NULL)
455 return 0;
456
457 *addrp = strtoull(comment, &endptr, 16);
458 if (endptr == comment)
459 return 0;
460 name = strchr(endptr, '<');
461 if (name == NULL)
462 return -1;
463
464 name++;
465
466 t = strchr(name, '>');
467 if (t == NULL)
468 return 0;
469
470 *t = '\0';
471 *namep = strdup(name);
472 *t = '>';
473
474 return 0;
475}
476
477static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
478{
479 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
480 if (ops->locked.ops == NULL)
481 return 0;
482
483 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
484 goto out_free_ops;
485
486 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
487
488 if (ops->locked.ins.ops == NULL)
489 goto out_free_ops;
490
491 if (ops->locked.ins.ops->parse &&
492 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
493 goto out_free_ops;
494
495 return 0;
496
497out_free_ops:
498 zfree(&ops->locked.ops);
499 return 0;
500}
501
502static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
503 struct ins_operands *ops, int max_ins_name)
504{
505 int printed;
506
507 if (ops->locked.ins.ops == NULL)
508 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
509
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);
513}
514
515static void lock__delete(struct ins_operands *ops)
516{
517 struct ins *ins = &ops->locked.ins;
518
519 if (ins->ops && ins->ops->free)
520 ins->ops->free(ops->locked.ops);
521 else
522 ins__delete(ops->locked.ops);
523
524 zfree(&ops->locked.ops);
525 zfree(&ops->target.raw);
526 zfree(&ops->target.name);
527}
528
529static struct ins_ops lock_ops = {
530 .free = lock__delete,
531 .parse = lock__parse,
532 .scnprintf = lock__scnprintf,
533};
534
535static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
536{
537 char *s = strchr(ops->raw, ','), *target, *comment, prev;
538
539 if (s == NULL)
540 return -1;
541
542 *s = '\0';
543 ops->source.raw = strdup(ops->raw);
544 *s = ',';
545
546 if (ops->source.raw == NULL)
547 return -1;
548
549 target = ++s;
550 comment = strchr(s, arch->objdump.comment_char);
551
552 if (comment != NULL)
553 s = comment - 1;
554 else
555 s = strchr(s, '\0') - 1;
556
557 while (s > target && isspace(s[0]))
558 --s;
559 s++;
560 prev = *s;
561 *s = '\0';
562
563 ops->target.raw = strdup(target);
564 *s = prev;
565
566 if (ops->target.raw == NULL)
567 goto out_free_source;
568
569 if (comment == NULL)
570 return 0;
571
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);
575
576 return 0;
577
578out_free_source:
579 zfree(&ops->source.raw);
580 return -1;
581}
582
583static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
584 struct ins_operands *ops, int max_ins_name)
585{
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);
589}
590
591static struct ins_ops mov_ops = {
592 .parse = mov__parse,
593 .scnprintf = mov__scnprintf,
594};
595
596static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
597{
598 char *target, *comment, *s, prev;
599
600 target = s = ops->raw;
601
602 while (s[0] != '\0' && !isspace(s[0]))
603 ++s;
604 prev = *s;
605 *s = '\0';
606
607 ops->target.raw = strdup(target);
608 *s = prev;
609
610 if (ops->target.raw == NULL)
611 return -1;
612
613 comment = strchr(s, arch->objdump.comment_char);
614 if (comment == NULL)
615 return 0;
616
617 comment = skip_spaces(comment);
618 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
619
620 return 0;
621}
622
623static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
624 struct ins_operands *ops, int max_ins_name)
625{
626 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
627 ops->target.name ?: ops->target.raw);
628}
629
630static struct ins_ops dec_ops = {
631 .parse = dec__parse,
632 .scnprintf = dec__scnprintf,
633};
634
635static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
636 struct ins_operands *ops __maybe_unused, int max_ins_name)
637{
638 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
639}
640
641static struct ins_ops nop_ops = {
642 .scnprintf = nop__scnprintf,
643};
644
645static struct ins_ops ret_ops = {
646 .scnprintf = ins__raw_scnprintf,
647};
648
649bool ins__is_ret(const struct ins *ins)
650{
651 return ins->ops == &ret_ops;
652}
653
654bool ins__is_lock(const struct ins *ins)
655{
656 return ins->ops == &lock_ops;
657}
658
659static int ins__key_cmp(const void *name, const void *insp)
660{
661 const struct ins *ins = insp;
662
663 return strcmp(name, ins->name);
664}
665
666static int ins__cmp(const void *a, const void *b)
667{
668 const struct ins *ia = a;
669 const struct ins *ib = b;
670
671 return strcmp(ia->name, ib->name);
672}
673
674static void ins__sort(struct arch *arch)
675{
676 const int nmemb = arch->nr_instructions;
677
678 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
679}
680
681static struct ins_ops *__ins__find(struct arch *arch, const char *name)
682{
683 struct ins *ins;
684 const int nmemb = arch->nr_instructions;
685
686 if (!arch->sorted_instructions) {
687 ins__sort(arch);
688 arch->sorted_instructions = true;
689 }
690
691 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
692 return ins ? ins->ops : NULL;
693}
694
695static struct ins_ops *ins__find(struct arch *arch, const char *name)
696{
697 struct ins_ops *ops = __ins__find(arch, name);
698
699 if (!ops && arch->associate_instruction_ops)
700 ops = arch->associate_instruction_ops(arch, name);
701
702 return ops;
703}
704
705static int arch__key_cmp(const void *name, const void *archp)
706{
707 const struct arch *arch = archp;
708
709 return strcmp(name, arch->name);
710}
711
712static int arch__cmp(const void *a, const void *b)
713{
714 const struct arch *aa = a;
715 const struct arch *ab = b;
716
717 return strcmp(aa->name, ab->name);
718}
719
720static void arch__sort(void)
721{
722 const int nmemb = ARRAY_SIZE(architectures);
723
724 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
725}
726
727static struct arch *arch__find(const char *name)
728{
729 const int nmemb = ARRAY_SIZE(architectures);
730 static bool sorted;
731
732 if (!sorted) {
733 arch__sort();
734 sorted = true;
735 }
736
737 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
738}
739
740static struct annotated_source *annotated_source__new(void)
741{
742 struct annotated_source *src = zalloc(sizeof(*src));
743
744 if (src != NULL)
745 INIT_LIST_HEAD(&src->source);
746
747 return src;
748}
749
750static __maybe_unused void annotated_source__delete(struct annotated_source *src)
751{
752 if (src == NULL)
753 return;
754 zfree(&src->histograms);
755 zfree(&src->cycles_hist);
756 free(src);
757}
758
759static int annotated_source__alloc_histograms(struct annotated_source *src,
760 size_t size, int nr_hists)
761{
762 size_t sizeof_sym_hist;
763
764 /*
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
769 * annotate it.
770 */
771 if (size == 0)
772 size = 1;
773
774 /* Check for overflow when calculating sizeof_sym_hist */
775 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
776 return -1;
777
778 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
779
780 /* Check for overflow in zalloc argument */
781 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
782 return -1;
783
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;
788}
789
790/* The cycles histogram is lazily allocated. */
791static int symbol__alloc_hist_cycles(struct symbol *sym)
792{
793 struct annotation *notes = symbol__annotation(sym);
794 const size_t size = symbol__size(sym);
795
796 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
797 if (notes->src->cycles_hist == NULL)
798 return -1;
799 return 0;
800}
801
802void symbol__annotate_zero_histograms(struct symbol *sym)
803{
804 struct annotation *notes = symbol__annotation(sym);
805
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));
813 }
814 pthread_mutex_unlock(¬es->lock);
815}
816
817static int __symbol__account_cycles(struct cyc_hist *ch,
818 u64 start,
819 unsigned offset, unsigned cycles,
820 unsigned have_start)
821{
822 /*
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.
827 *
828 * We separately always account the full cycles.
829 */
830 ch[offset].num_aggr++;
831 ch[offset].cycles_aggr += cycles;
832
833 if (cycles > ch[offset].cycles_max)
834 ch[offset].cycles_max = cycles;
835
836 if (ch[offset].cycles_min) {
837 if (cycles && cycles < ch[offset].cycles_min)
838 ch[offset].cycles_min = cycles;
839 } else
840 ch[offset].cycles_min = cycles;
841
842 if (!have_start && ch[offset].have_start)
843 return 0;
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;
849 ch[offset].num = 0;
850 if (ch[offset].reset < 0xffff)
851 ch[offset].reset++;
852 } else if (have_start &&
853 ch[offset].start < start)
854 return 0;
855 }
856
857 if (ch[offset].num < NUM_SPARKS)
858 ch[offset].cycles_spark[ch[offset].num] = cycles;
859
860 ch[offset].have_start = have_start;
861 ch[offset].start = start;
862 ch[offset].cycles += cycles;
863 ch[offset].num++;
864 return 0;
865}
866
867static int __symbol__inc_addr_samples(struct map_symbol *ms,
868 struct annotated_source *src, int evidx, u64 addr,
869 struct perf_sample *sample)
870{
871 struct symbol *sym = ms->sym;
872 unsigned offset;
873 struct sym_hist *h;
874
875 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, ms->map->unmap_ip(ms->map, addr));
876
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);
881 return -ERANGE;
882 }
883
884 offset = addr - sym->start;
885 h = annotated_source__histogram(src, evidx);
886 if (h == NULL) {
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);
889 return -ENOMEM;
890 }
891 h->nr_samples++;
892 h->addr[offset].nr_samples++;
893 h->period += sample->period;
894 h->addr[offset].period += sample->period;
895
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);
900 return 0;
901}
902
903static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
904{
905 struct annotation *notes = symbol__annotation(sym);
906
907 if (notes->src == NULL) {
908 notes->src = annotated_source__new();
909 if (notes->src == NULL)
910 return NULL;
911 goto alloc_cycles_hist;
912 }
913
914 if (!notes->src->cycles_hist) {
915alloc_cycles_hist:
916 symbol__alloc_hist_cycles(sym);
917 }
918
919 return notes->src->cycles_hist;
920}
921
922struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
923{
924 struct annotation *notes = symbol__annotation(sym);
925
926 if (notes->src == NULL) {
927 notes->src = annotated_source__new();
928 if (notes->src == NULL)
929 return NULL;
930 goto alloc_histograms;
931 }
932
933 if (notes->src->histograms == NULL) {
934alloc_histograms:
935 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
936 nr_hists);
937 }
938
939 return notes->src;
940}
941
942static int symbol__inc_addr_samples(struct map_symbol *ms,
943 struct evsel *evsel, u64 addr,
944 struct perf_sample *sample)
945{
946 struct symbol *sym = ms->sym;
947 struct annotated_source *src;
948
949 if (sym == NULL)
950 return 0;
951 src = symbol__hists(sym, evsel->evlist->core.nr_entries);
952 return src ? __symbol__inc_addr_samples(ms, src, evsel->idx, addr, sample) : 0;
953}
954
955static int symbol__account_cycles(u64 addr, u64 start,
956 struct symbol *sym, unsigned cycles)
957{
958 struct cyc_hist *cycles_hist;
959 unsigned offset;
960
961 if (sym == NULL)
962 return 0;
963 cycles_hist = symbol__cycles_hist(sym);
964 if (cycles_hist == NULL)
965 return -ENOMEM;
966 if (addr < sym->start || addr >= sym->end)
967 return -ERANGE;
968
969 if (start) {
970 if (start < sym->start || start >= sym->end)
971 return -ERANGE;
972 if (start >= addr)
973 start = 0;
974 }
975 offset = addr - sym->start;
976 return __symbol__account_cycles(cycles_hist,
977 start ? start - sym->start : 0,
978 offset, cycles,
979 !!start);
980}
981
982int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
983 struct addr_map_symbol *start,
984 unsigned cycles)
985{
986 u64 saddr = 0;
987 int err;
988
989 if (!cycles)
990 return 0;
991
992 /*
993 * Only set start when IPC can be computed. We can only
994 * compute it when the basic block is completely in a single
995 * function.
996 * Special case the case when the jump is elsewhere, but
997 * it starts on the function start.
998 */
999 if (start &&
1000 (start->ms.sym == ams->ms.sym ||
1001 (ams->ms.sym &&
1002 start->addr == ams->ms.sym->start + ams->ms.map->start)))
1003 saddr = start->al_addr;
1004 if (saddr == 0)
1005 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
1006 ams->addr,
1007 start ? start->addr : 0,
1008 ams->ms.sym ? ams->ms.sym->start + ams->ms.map->start : 0,
1009 saddr);
1010 err = symbol__account_cycles(ams->al_addr, saddr, ams->ms.sym, cycles);
1011 if (err)
1012 pr_debug2("account_cycles failed %d\n", err);
1013 return err;
1014}
1015
1016static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1017{
1018 unsigned n_insn = 0;
1019 u64 offset;
1020
1021 for (offset = start; offset <= end; offset++) {
1022 if (notes->offsets[offset])
1023 n_insn++;
1024 }
1025 return n_insn;
1026}
1027
1028static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1029{
1030 unsigned n_insn;
1031 unsigned int cover_insn = 0;
1032 u64 offset;
1033
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);
1037
1038 /* Hide data when there are too many overlaps. */
1039 if (ch->reset >= 0x7fff)
1040 return;
1041
1042 for (offset = start; offset <= end; offset++) {
1043 struct annotation_line *al = notes->offsets[offset];
1044
1045 if (al && al->ipc == 0.0) {
1046 al->ipc = ipc;
1047 cover_insn++;
1048 }
1049 }
1050
1051 if (cover_insn) {
1052 notes->hit_cycles += ch->cycles;
1053 notes->hit_insn += n_insn * ch->num;
1054 notes->cover_insn += cover_insn;
1055 }
1056 }
1057}
1058
1059void annotation__compute_ipc(struct annotation *notes, size_t size)
1060{
1061 s64 offset;
1062
1063 if (!notes->src || !notes->src->cycles_hist)
1064 return;
1065
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;
1070
1071 pthread_mutex_lock(¬es->lock);
1072 for (offset = size - 1; offset >= 0; --offset) {
1073 struct cyc_hist *ch;
1074
1075 ch = ¬es->src->cycles_hist[offset];
1076 if (ch && ch->cycles) {
1077 struct annotation_line *al;
1078
1079 if (ch->have_start)
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;
1086 }
1087 notes->have_cycles = true;
1088 }
1089 }
1090 pthread_mutex_unlock(¬es->lock);
1091}
1092
1093int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1094 struct evsel *evsel)
1095{
1096 return symbol__inc_addr_samples(&ams->ms, evsel, ams->al_addr, sample);
1097}
1098
1099int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1100 struct evsel *evsel, u64 ip)
1101{
1102 return symbol__inc_addr_samples(&he->ms, evsel, ip, sample);
1103}
1104
1105static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1106{
1107 dl->ins.ops = ins__find(arch, dl->ins.name);
1108
1109 if (!dl->ins.ops)
1110 return;
1111
1112 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1113 dl->ins.ops = NULL;
1114}
1115
1116static int disasm_line__parse(char *line, const char **namep, char **rawp)
1117{
1118 char tmp, *name = skip_spaces(line);
1119
1120 if (name[0] == '\0')
1121 return -1;
1122
1123 *rawp = name + 1;
1124
1125 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1126 ++*rawp;
1127
1128 tmp = (*rawp)[0];
1129 (*rawp)[0] = '\0';
1130 *namep = strdup(name);
1131
1132 if (*namep == NULL)
1133 goto out;
1134
1135 (*rawp)[0] = tmp;
1136 *rawp = strim(*rawp);
1137
1138 return 0;
1139
1140out:
1141 return -1;
1142}
1143
1144struct annotate_args {
1145 struct arch *arch;
1146 struct map_symbol ms;
1147 struct evsel *evsel;
1148 struct annotation_options *options;
1149 s64 offset;
1150 char *line;
1151 int line_nr;
1152};
1153
1154static void annotation_line__init(struct annotation_line *al,
1155 struct annotate_args *args,
1156 int nr)
1157{
1158 al->offset = args->offset;
1159 al->line = strdup(args->line);
1160 al->line_nr = args->line_nr;
1161 al->data_nr = nr;
1162}
1163
1164static void annotation_line__exit(struct annotation_line *al)
1165{
1166 free_srcline(al->path);
1167 zfree(&al->line);
1168}
1169
1170static size_t disasm_line_size(int nr)
1171{
1172 struct annotation_line *al;
1173
1174 return (sizeof(struct disasm_line) + (sizeof(al->data[0]) * nr));
1175}
1176
1177/*
1178 * Allocating the disasm annotation line data with
1179 * following structure:
1180 *
1181 * -------------------------------------------
1182 * struct disasm_line | struct annotation_line
1183 * -------------------------------------------
1184 *
1185 * We have 'struct annotation_line' member as last member
1186 * of 'struct disasm_line' to have an easy access.
1187 */
1188static struct disasm_line *disasm_line__new(struct annotate_args *args)
1189{
1190 struct disasm_line *dl = NULL;
1191 int nr = 1;
1192
1193 if (evsel__is_group_event(args->evsel))
1194 nr = args->evsel->core.nr_members;
1195
1196 dl = zalloc(disasm_line_size(nr));
1197 if (!dl)
1198 return NULL;
1199
1200 annotation_line__init(&dl->al, args, nr);
1201 if (dl->al.line == NULL)
1202 goto out_delete;
1203
1204 if (args->offset != -1) {
1205 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1206 goto out_free_line;
1207
1208 disasm_line__init_ins(dl, args->arch, &args->ms);
1209 }
1210
1211 return dl;
1212
1213out_free_line:
1214 zfree(&dl->al.line);
1215out_delete:
1216 free(dl);
1217 return NULL;
1218}
1219
1220void disasm_line__free(struct disasm_line *dl)
1221{
1222 if (dl->ins.ops && dl->ins.ops->free)
1223 dl->ins.ops->free(&dl->ops);
1224 else
1225 ins__delete(&dl->ops);
1226 zfree(&dl->ins.name);
1227 annotation_line__exit(&dl->al);
1228 free(dl);
1229}
1230
1231int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1232{
1233 if (raw || !dl->ins.ops)
1234 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1235
1236 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1237}
1238
1239static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1240{
1241 list_add_tail(&al->node, head);
1242}
1243
1244struct annotation_line *
1245annotation_line__next(struct annotation_line *pos, struct list_head *head)
1246{
1247 list_for_each_entry_continue(pos, head, node)
1248 if (pos->offset >= 0)
1249 return pos;
1250
1251 return NULL;
1252}
1253
1254static const char *annotate__address_color(struct block_range *br)
1255{
1256 double cov = block_range__coverage(br);
1257
1258 if (cov >= 0) {
1259 /* mark red for >75% coverage */
1260 if (cov > 0.75)
1261 return PERF_COLOR_RED;
1262
1263 /* mark dull for <1% coverage */
1264 if (cov < 0.01)
1265 return PERF_COLOR_NORMAL;
1266 }
1267
1268 return PERF_COLOR_MAGENTA;
1269}
1270
1271static const char *annotate__asm_color(struct block_range *br)
1272{
1273 double cov = block_range__coverage(br);
1274
1275 if (cov >= 0) {
1276 /* mark dull for <1% coverage */
1277 if (cov < 0.01)
1278 return PERF_COLOR_NORMAL;
1279 }
1280
1281 return PERF_COLOR_BLUE;
1282}
1283
1284static void annotate__branch_printf(struct block_range *br, u64 addr)
1285{
1286 bool emit_comment = true;
1287
1288 if (!br)
1289 return;
1290
1291#if 1
1292 if (br->is_target && br->start == addr) {
1293 struct block_range *branch = br;
1294 double p;
1295
1296 /*
1297 * Find matching branch to our target.
1298 */
1299 while (!branch->is_branch)
1300 branch = block_range__next(branch);
1301
1302 p = 100 *(double)br->entry / branch->coverage;
1303
1304 if (p > 0.1) {
1305 if (emit_comment) {
1306 emit_comment = false;
1307 printf("\t#");
1308 }
1309
1310 /*
1311 * The percentage of coverage joined at this target in relation
1312 * to the next branch.
1313 */
1314 printf(" +%.2f%%", p);
1315 }
1316 }
1317#endif
1318 if (br->is_branch && br->end == addr) {
1319 double p = 100*(double)br->taken / br->coverage;
1320
1321 if (p > 0.1) {
1322 if (emit_comment) {
1323 emit_comment = false;
1324 printf("\t#");
1325 }
1326
1327 /*
1328 * The percentage of coverage leaving at this branch, and
1329 * its prediction ratio.
1330 */
1331 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1332 }
1333 }
1334}
1335
1336static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1337{
1338 s64 offset = dl->al.offset;
1339 const u64 addr = start + offset;
1340 struct block_range *br;
1341
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);
1346 return 0;
1347}
1348
1349static int
1350annotation_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,
1353 int percent_type)
1354{
1355 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1356 static const char *prev_line;
1357 static const char *prev_color;
1358
1359 if (al->offset != -1) {
1360 double max_percent = 0.0;
1361 int i, nr_percent = 1;
1362 const char *color;
1363 struct annotation *notes = symbol__annotation(sym);
1364
1365 for (i = 0; i < al->data_nr; i++) {
1366 double percent;
1367
1368 percent = annotation_data__percent(&al->data[i],
1369 percent_type);
1370
1371 if (percent > max_percent)
1372 max_percent = percent;
1373 }
1374
1375 if (al->data_nr > nr_percent)
1376 nr_percent = al->data_nr;
1377
1378 if (max_percent < min_pcnt)
1379 return -1;
1380
1381 if (max_lines && printed >= max_lines)
1382 return 1;
1383
1384 if (queue != NULL) {
1385 list_for_each_entry_from(queue, ¬es->src->source, node) {
1386 if (queue == al)
1387 break;
1388 annotation_line__print(queue, sym, start, evsel, len,
1389 0, 0, 1, NULL, addr_fmt_width,
1390 percent_type);
1391 }
1392 }
1393
1394 color = get_percent_color(max_percent);
1395
1396 /*
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
1400 */
1401 if (al->path) {
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;
1406 prev_color = color;
1407 }
1408 }
1409
1410 for (i = 0; i < nr_percent; i++) {
1411 struct annotation_data *data = &al->data[i];
1412 double percent;
1413
1414 percent = annotation_data__percent(data, percent_type);
1415 color = get_percent_color(percent);
1416
1417 if (symbol_conf.show_total_period)
1418 color_fprintf(stdout, color, " %11" PRIu64,
1419 data->he.period);
1420 else if (symbol_conf.show_nr_samples)
1421 color_fprintf(stdout, color, " %7" PRIu64,
1422 data->he.nr_samples);
1423 else
1424 color_fprintf(stdout, color, " %7.2f", percent);
1425 }
1426
1427 printf(" : ");
1428
1429 disasm_line__print(dl, start, addr_fmt_width);
1430 printf("\n");
1431 } else if (max_lines && printed >= max_lines)
1432 return 1;
1433 else {
1434 int width = symbol_conf.show_total_period ? 12 : 8;
1435
1436 if (queue)
1437 return -1;
1438
1439 if (evsel__is_group_event(evsel))
1440 width *= evsel->core.nr_members;
1441
1442 if (!*al->line)
1443 printf(" %*s:\n", width, " ");
1444 else
1445 printf(" %*s: %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1446 }
1447
1448 return 0;
1449}
1450
1451/*
1452 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1453 * which looks like following
1454 *
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
1462 * 415519: retq
1463 *
1464 * it will be parsed and saved into struct disasm_line as
1465 * <offset> <name> <ops.raw>
1466 *
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.
1470 */
1471static int symbol__parse_objdump_line(struct symbol *sym,
1472 struct annotate_args *args,
1473 char *parsed_line, int *line_nr)
1474{
1475 struct map *map = args->ms.map;
1476 struct annotation *notes = symbol__annotation(sym);
1477 struct disasm_line *dl;
1478 char *tmp;
1479 s64 line_ip, offset = -1;
1480 regmatch_t match[2];
1481
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);
1485 return 0;
1486 }
1487
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);
1493
1494 offset = line_ip - start;
1495 if ((u64)line_ip < start || (u64)line_ip >= end)
1496 offset = -1;
1497 else
1498 parsed_line = tmp + 1;
1499 }
1500
1501 args->offset = offset;
1502 args->line = parsed_line;
1503 args->line_nr = *line_nr;
1504 args->ms.sym = sym;
1505
1506 dl = disasm_line__new(args);
1507 (*line_nr)++;
1508
1509 if (dl == NULL)
1510 return -1;
1511
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;
1516 }
1517
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, },
1523 };
1524
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;
1528 }
1529
1530 annotation_line__add(&dl->al, ¬es->src->source);
1531
1532 return 0;
1533}
1534
1535static __attribute__((constructor)) void symbol__init_regexpr(void)
1536{
1537 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1538}
1539
1540static void delete_last_nop(struct symbol *sym)
1541{
1542 struct annotation *notes = symbol__annotation(sym);
1543 struct list_head *list = ¬es->src->source;
1544 struct disasm_line *dl;
1545
1546 while (!list_empty(list)) {
1547 dl = list_entry(list->prev, struct disasm_line, al.node);
1548
1549 if (dl->ins.ops) {
1550 if (dl->ins.ops != &nop_ops)
1551 return;
1552 } else {
1553 if (!strstr(dl->al.line, " nop ") &&
1554 !strstr(dl->al.line, " nopl ") &&
1555 !strstr(dl->al.line, " nopw "))
1556 return;
1557 }
1558
1559 list_del_init(&dl->al.node);
1560 disasm_line__free(dl);
1561 }
1562}
1563
1564int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen)
1565{
1566 struct dso *dso = ms->map->dso;
1567
1568 BUG_ON(buflen == 0);
1569
1570 if (errnum >= 0) {
1571 str_error_r(errnum, buf, buflen);
1572 return 0;
1573 }
1574
1575 switch (errnum) {
1576 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1577 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1578 char *build_id_msg = NULL;
1579
1580 if (dso->has_build_id) {
1581 build_id__sprintf(dso->build_id,
1582 sizeof(dso->build_id), bf + 15);
1583 build_id_msg = bf;
1584 }
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"
1588 "Please use:\n\n"
1589 " perf buildid-cache -vu vmlinux\n\n"
1590 "or:\n\n"
1591 " --vmlinux vmlinux\n", build_id_msg ?: "");
1592 }
1593 break;
1594 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1595 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1596 break;
1597 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP:
1598 scnprintf(buf, buflen, "Problems with arch specific instruction name regular expressions.");
1599 break;
1600 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING:
1601 scnprintf(buf, buflen, "Problems while parsing the CPUID in the arch specific initialization.");
1602 break;
1603 case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE:
1604 scnprintf(buf, buflen, "Invalid BPF file: %s.", dso->long_name);
1605 break;
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.",
1608 dso->long_name);
1609 break;
1610 default:
1611 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1612 break;
1613 }
1614
1615 return 0;
1616}
1617
1618static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1619{
1620 char linkname[PATH_MAX];
1621 char *build_id_filename;
1622 char *build_id_path = NULL;
1623 char *pos;
1624 int len;
1625
1626 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1627 !dso__is_kcore(dso))
1628 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1629
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);
1634 } else {
1635 if (dso->has_build_id)
1636 return ENOMEM;
1637 goto fallback;
1638 }
1639
1640 build_id_path = strdup(filename);
1641 if (!build_id_path)
1642 return ENOMEM;
1643
1644 /*
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.
1648 */
1649 pos = strrchr(build_id_path, '/');
1650 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1651 dirname(build_id_path);
1652
1653 if (dso__is_kcore(dso))
1654 goto fallback;
1655
1656 len = readlink(build_id_path, linkname, sizeof(linkname) - 1);
1657 if (len < 0)
1658 goto fallback;
1659
1660 linkname[len] = '\0';
1661 if (strstr(linkname, DSO__NAME_KALLSYMS) ||
1662 access(filename, R_OK)) {
1663fallback:
1664 /*
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.
1668 */
1669 __symbol__join_symfs(filename, filename_size, dso->long_name);
1670 }
1671
1672 free(build_id_path);
1673 return 0;
1674}
1675
1676#if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1677#define PACKAGE "perf"
1678#include <bfd.h>
1679#include <dis-asm.h>
1680
1681static int symbol__disassemble_bpf(struct symbol *sym,
1682 struct annotate_args *args)
1683{
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];
1697 size_t buf_size;
1698 int nr_skip = 0;
1699 char *buf;
1700 bfd *bfdf;
1701 int ret;
1702 FILE *s;
1703
1704 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1705 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE;
1706
1707 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1708 sym->name, sym->start, sym->end - sym->start);
1709
1710 memset(tpath, 0, sizeof(tpath));
1711 perf_exe(tpath, sizeof(tpath));
1712
1713 bfdf = bfd_openr(tpath, NULL);
1714 assert(bfdf);
1715 assert(bfd_check_format(bfdf, bfd_object));
1716
1717 s = open_memstream(&buf, &buf_size);
1718 if (!s) {
1719 ret = errno;
1720 goto out;
1721 }
1722 init_disassemble_info(&info, s,
1723 (fprintf_ftype) fprintf);
1724
1725 info.arch = bfd_get_arch(bfdf);
1726 info.mach = bfd_get_mach(bfdf);
1727
1728 info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1729 dso->bpf_prog.id);
1730 if (!info_node) {
1731 ret = SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF;
1732 goto out;
1733 }
1734 info_linear = info_node->info_linear;
1735 sub_id = dso->bpf_prog.sub_id;
1736
1737 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1738 info.buffer_length = info_linear->info.jited_prog_len;
1739
1740 if (info_linear->info.nr_line_info)
1741 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1742
1743 if (info_linear->info.btf_id) {
1744 struct btf_node *node;
1745
1746 node = perf_env__find_btf(dso->bpf_prog.env,
1747 info_linear->info.btf_id);
1748 if (node)
1749 btf = btf__new((__u8 *)(node->data),
1750 node->data_size);
1751 }
1752
1753 disassemble_init_for_target(&info);
1754
1755#ifdef DISASM_FOUR_ARGS_SIGNATURE
1756 disassemble = disassembler(info.arch,
1757 bfd_big_endian(bfdf),
1758 info.mach,
1759 bfdf);
1760#else
1761 disassemble = disassembler(bfdf);
1762#endif
1763 assert(disassemble);
1764
1765 fflush(s);
1766 do {
1767 const struct bpf_line_info *linfo = NULL;
1768 struct disasm_line *dl;
1769 size_t prev_buf_size;
1770 const char *srcline;
1771 u64 addr;
1772
1773 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1774 count = disassemble(pc, &info);
1775
1776 if (prog_linfo)
1777 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1778 addr, sub_id,
1779 nr_skip);
1780
1781 if (linfo && btf) {
1782 srcline = btf__name_by_offset(btf, linfo->line_off);
1783 nr_skip++;
1784 } else
1785 srcline = NULL;
1786
1787 fprintf(s, "\n");
1788 prev_buf_size = buf_size;
1789 fflush(s);
1790
1791 if (!opts->hide_src_code && srcline) {
1792 args->offset = -1;
1793 args->line = strdup(srcline);
1794 args->line_nr = 0;
1795 args->ms.sym = sym;
1796 dl = disasm_line__new(args);
1797 if (dl) {
1798 annotation_line__add(&dl->al,
1799 ¬es->src->source);
1800 }
1801 }
1802
1803 args->offset = pc;
1804 args->line = buf + prev_buf_size;
1805 args->line_nr = 0;
1806 args->ms.sym = sym;
1807 dl = disasm_line__new(args);
1808 if (dl)
1809 annotation_line__add(&dl->al, ¬es->src->source);
1810
1811 pc += count;
1812 } while (count > 0 && pc < len);
1813
1814 ret = 0;
1815out:
1816 free(prog_linfo);
1817 free(btf);
1818 fclose(s);
1819 bfd_close(bfdf);
1820 return ret;
1821}
1822#else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1823static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1824 struct annotate_args *args __maybe_unused)
1825{
1826 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1827}
1828#endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1829
1830static int
1831symbol__disassemble_bpf_image(struct symbol *sym,
1832 struct annotate_args *args)
1833{
1834 struct annotation *notes = symbol__annotation(sym);
1835 struct disasm_line *dl;
1836
1837 args->offset = -1;
1838 args->line = strdup("to be implemented");
1839 args->line_nr = 0;
1840 dl = disasm_line__new(args);
1841 if (dl)
1842 annotation_line__add(&dl->al, ¬es->src->source);
1843
1844 free(args->line);
1845 return 0;
1846}
1847
1848/*
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.
1852 */
1853static char *expand_tabs(char *line, char **storage, size_t *storage_len)
1854{
1855 size_t i, src, dst, len, new_storage_len, num_tabs;
1856 char *new_line;
1857 size_t line_len = strlen(line);
1858
1859 for (num_tabs = 0, i = 0; i < line_len; i++)
1860 if (line[i] == '\t')
1861 num_tabs++;
1862
1863 if (num_tabs == 0)
1864 return line;
1865
1866 /*
1867 * Space for the line and '\0', less the leading and trailing
1868 * spaces. Each tab may introduce 7 additional spaces.
1869 */
1870 new_storage_len = line_len + 1 + (num_tabs * 7);
1871
1872 new_line = malloc(new_storage_len);
1873 if (new_line == NULL) {
1874 pr_err("Failure allocating memory for tab expansion\n");
1875 return NULL;
1876 }
1877
1878 /*
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
1881 * are inserted.
1882 */
1883 for (i = 0, src = 0, dst = 0; i < line_len && num_tabs; i++) {
1884 if (line[i] == '\t') {
1885 len = i - src;
1886 memcpy(&new_line[dst], &line[src], len);
1887 dst += len;
1888 new_line[dst++] = ' ';
1889 while (dst % 8 != 0)
1890 new_line[dst++] = ' ';
1891 src = i + 1;
1892 num_tabs--;
1893 }
1894 }
1895
1896 /* Expand the last region. */
1897 len = line_len - src;
1898 memcpy(&new_line[dst], &line[src], len);
1899 dst += len;
1900 new_line[dst] = '\0';
1901
1902 free(*storage);
1903 *storage = new_line;
1904 *storage_len = new_storage_len;
1905 return new_line;
1906
1907}
1908
1909static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1910{
1911 struct annotation_options *opts = args->options;
1912 struct map *map = args->ms.map;
1913 struct dso *dso = map->dso;
1914 char *command;
1915 FILE *file;
1916 char symfs_filename[PATH_MAX];
1917 struct kcore_extract kce;
1918 bool delete_extract = false;
1919 bool decomp = false;
1920 int lineno = 0;
1921 int nline;
1922 char *line;
1923 size_t line_len;
1924 const char *objdump_argv[] = {
1925 "/bin/sh",
1926 "-c",
1927 NULL, /* Will be the objdump command to run. */
1928 "--",
1929 NULL, /* Will be the symfs path. */
1930 NULL,
1931 };
1932 struct child_process objdump_process;
1933 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1934
1935 if (err)
1936 return err;
1937
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));
1941
1942 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1943 dso, dso->long_name, sym, sym->name);
1944
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));
1958 }
1959 } else if (dso__needs_decompress(dso)) {
1960 char tmp[KMOD_DECOMP_LEN];
1961
1962 if (dso__decompress_kmodule_path(dso, symfs_filename,
1963 tmp, sizeof(tmp)) < 0)
1964 return -1;
1965
1966 decomp = true;
1967 strcpy(symfs_filename, tmp);
1968 }
1969
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 ? '"' : ' ',
1983 opts->prefix ?: "",
1984 opts->prefix ? '"' : ' ',
1985 opts->prefix_strip ? "--prefix-strip=" : "",
1986 opts->prefix_strip ?: "");
1987
1988 if (err < 0) {
1989 pr_err("Failure allocating memory for the command to run\n");
1990 goto out_remove_tmp;
1991 }
1992
1993 pr_debug("Executing: %s\n", command);
1994
1995 objdump_argv[2] = command;
1996 objdump_argv[4] = symfs_filename;
1997
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);
2004 err = -1;
2005 goto out_free_command;
2006 }
2007
2008 file = fdopen(objdump_process.out, "r");
2009 if (!file) {
2010 pr_err("Failure creating FILE stream for %s\n", command);
2011 /*
2012 * If we were using debug info should retry with
2013 * original binary.
2014 */
2015 err = -1;
2016 goto out_close_stdout;
2017 }
2018
2019 /* Storage for getline. */
2020 line = NULL;
2021 line_len = 0;
2022
2023 nline = 0;
2024 while (!feof(file)) {
2025 const char *match;
2026 char *expanded_line;
2027
2028 if (getline(&line, &line_len, file) < 0 || !line)
2029 break;
2030
2031 /* Skip lines containing "filename:" */
2032 match = strstr(line, symfs_filename);
2033 if (match && match[strlen(symfs_filename)] == ':')
2034 continue;
2035
2036 expanded_line = strim(line);
2037 expanded_line = expand_tabs(expanded_line, &line, &line_len);
2038 if (!expanded_line)
2039 break;
2040
2041 /*
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.
2046 */
2047 if (symbol__parse_objdump_line(sym, args, expanded_line,
2048 &lineno) < 0)
2049 break;
2050 nline++;
2051 }
2052 free(line);
2053
2054 err = finish_command(&objdump_process);
2055 if (err)
2056 pr_err("Error running %s\n", command);
2057
2058 if (nline == 0) {
2059 err = -1;
2060 pr_err("No output from %s\n", command);
2061 }
2062
2063 /*
2064 * kallsyms does not have symbol sizes so there may a nop at the end.
2065 * Remove it.
2066 */
2067 if (dso__is_kcore(dso))
2068 delete_last_nop(sym);
2069
2070 fclose(file);
2071
2072out_close_stdout:
2073 close(objdump_process.out);
2074
2075out_free_command:
2076 free(command);
2077
2078out_remove_tmp:
2079 if (decomp)
2080 unlink(symfs_filename);
2081
2082 if (delete_extract)
2083 kcore_extract__delete(&kce);
2084
2085 return err;
2086}
2087
2088static void calc_percent(struct sym_hist *sym_hist,
2089 struct hists *hists,
2090 struct annotation_data *data,
2091 s64 offset, s64 end)
2092{
2093 unsigned int hits = 0;
2094 u64 period = 0;
2095
2096 while (offset < end) {
2097 hits += sym_hist->addr[offset].nr_samples;
2098 period += sym_hist->addr[offset].period;
2099 ++offset;
2100 }
2101
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;
2106 }
2107
2108 if (hists->stats.nr_non_filtered_samples)
2109 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2110
2111 if (sym_hist->period)
2112 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2113
2114 if (hists->stats.total_period)
2115 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2116}
2117
2118static void annotation__calc_percent(struct annotation *notes,
2119 struct evsel *leader, s64 len)
2120{
2121 struct annotation_line *al, *next;
2122 struct evsel *evsel;
2123
2124 list_for_each_entry(al, ¬es->src->source, node) {
2125 s64 end;
2126 int i = 0;
2127
2128 if (al->offset == -1)
2129 continue;
2130
2131 next = annotation_line__next(al, ¬es->src->source);
2132 end = next ? next->offset : len;
2133
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;
2138
2139 BUG_ON(i >= al->data_nr);
2140
2141 sym_hist = annotation__histogram(notes, evsel->idx);
2142 data = &al->data[i++];
2143
2144 calc_percent(sym_hist, hists, data, al->offset, end);
2145 }
2146 }
2147}
2148
2149void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
2150{
2151 struct annotation *notes = symbol__annotation(sym);
2152
2153 annotation__calc_percent(notes, evsel, symbol__size(sym));
2154}
2155
2156int symbol__annotate(struct map_symbol *ms, struct evsel *evsel,
2157 struct annotation_options *options, struct arch **parch)
2158{
2159 struct symbol *sym = ms->sym;
2160 struct annotation *notes = symbol__annotation(sym);
2161 struct annotate_args args = {
2162 .evsel = evsel,
2163 .options = options,
2164 };
2165 struct perf_env *env = evsel__env(evsel);
2166 const char *arch_name = perf_env__arch(env);
2167 struct arch *arch;
2168 int err;
2169
2170 if (!arch_name)
2171 return errno;
2172
2173 args.arch = arch = arch__find(arch_name);
2174 if (arch == NULL)
2175 return ENOTSUP;
2176
2177 if (parch)
2178 *parch = arch;
2179
2180 if (arch->init) {
2181 err = arch->init(arch, env ? env->cpuid : NULL);
2182 if (err) {
2183 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2184 return err;
2185 }
2186 }
2187
2188 args.ms = *ms;
2189 notes->start = map__rip_2objdump(ms->map, sym->start);
2190
2191 return symbol__disassemble(sym, &args);
2192}
2193
2194static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2195 struct annotation_options *opts)
2196{
2197 struct annotation_line *iter;
2198 struct rb_node **p = &root->rb_node;
2199 struct rb_node *parent = NULL;
2200 int i, ret;
2201
2202 while (*p != NULL) {
2203 parent = *p;
2204 iter = rb_entry(parent, struct annotation_line, rb_node);
2205
2206 ret = strcmp(iter->path, al->path);
2207 if (ret == 0) {
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);
2211 }
2212 return;
2213 }
2214
2215 if (ret < 0)
2216 p = &(*p)->rb_left;
2217 else
2218 p = &(*p)->rb_right;
2219 }
2220
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);
2224 }
2225
2226 rb_link_node(&al->rb_node, parent, p);
2227 rb_insert_color(&al->rb_node, root);
2228}
2229
2230static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2231{
2232 int i;
2233
2234 for (i = 0; i < a->data_nr; i++) {
2235 if (a->data[i].percent_sum == b->data[i].percent_sum)
2236 continue;
2237 return a->data[i].percent_sum > b->data[i].percent_sum;
2238 }
2239
2240 return 0;
2241}
2242
2243static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2244{
2245 struct annotation_line *iter;
2246 struct rb_node **p = &root->rb_node;
2247 struct rb_node *parent = NULL;
2248
2249 while (*p != NULL) {
2250 parent = *p;
2251 iter = rb_entry(parent, struct annotation_line, rb_node);
2252
2253 if (cmp_source_line(al, iter))
2254 p = &(*p)->rb_left;
2255 else
2256 p = &(*p)->rb_right;
2257 }
2258
2259 rb_link_node(&al->rb_node, parent, p);
2260 rb_insert_color(&al->rb_node, root);
2261}
2262
2263static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2264{
2265 struct annotation_line *al;
2266 struct rb_node *node;
2267
2268 node = rb_first(src_root);
2269 while (node) {
2270 struct rb_node *next;
2271
2272 al = rb_entry(node, struct annotation_line, rb_node);
2273 next = rb_next(node);
2274 rb_erase(node, src_root);
2275
2276 __resort_source_line(dest_root, al);
2277 node = next;
2278 }
2279}
2280
2281static void print_summary(struct rb_root *root, const char *filename)
2282{
2283 struct annotation_line *al;
2284 struct rb_node *node;
2285
2286 printf("\nSorted summary for file %s\n", filename);
2287 printf("----------------------------------------------\n\n");
2288
2289 if (RB_EMPTY_ROOT(root)) {
2290 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2291 return;
2292 }
2293
2294 node = rb_first(root);
2295 while (node) {
2296 double percent, percent_max = 0.0;
2297 const char *color;
2298 char *path;
2299 int i;
2300
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);
2306
2307 if (percent > percent_max)
2308 percent_max = percent;
2309 }
2310
2311 path = al->path;
2312 color = get_percent_color(percent_max);
2313 color_fprintf(stdout, color, " %s\n", path);
2314
2315 node = rb_next(node);
2316 }
2317}
2318
2319static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
2320{
2321 struct annotation *notes = symbol__annotation(sym);
2322 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2323 u64 len = symbol__size(sym), offset;
2324
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);
2330}
2331
2332static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2333{
2334 char bf[32];
2335 struct annotation_line *line;
2336
2337 list_for_each_entry_reverse(line, lines, node) {
2338 if (line->offset != -1)
2339 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2340 }
2341
2342 return 0;
2343}
2344
2345int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
2346 struct annotation_options *opts)
2347{
2348 struct map *map = ms->map;
2349 struct symbol *sym = ms->sym;
2350 struct dso *dso = map->dso;
2351 char *filename;
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;
2359 int more = 0;
2360 bool context = opts->context;
2361 u64 len;
2362 int width = symbol_conf.show_total_period ? 12 : 8;
2363 int graph_dotted_len;
2364 char buf[512];
2365
2366 filename = strdup(dso->long_name);
2367 if (!filename)
2368 return -ENOMEM;
2369
2370 if (opts->full_path)
2371 d_filename = filename;
2372 else
2373 d_filename = basename(filename);
2374
2375 len = symbol__size(sym);
2376
2377 if (evsel__is_group_event(evsel)) {
2378 width *= evsel->core.nr_members;
2379 evsel__group_desc(evsel, buf, sizeof(buf));
2380 evsel_name = buf;
2381 }
2382
2383 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2384 "percent: %s)\n",
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));
2389
2390 printf("%-*.*s----\n",
2391 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2392
2393 if (verbose > 0)
2394 symbol__annotate_hits(sym, evsel);
2395
2396 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2397
2398 list_for_each_entry(pos, ¬es->src->source, node) {
2399 int err;
2400
2401 if (context && queue == NULL) {
2402 queue = pos;
2403 queue_len = 0;
2404 }
2405
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);
2409
2410 switch (err) {
2411 case 0:
2412 ++printed;
2413 if (context) {
2414 printed += queue_len;
2415 queue = NULL;
2416 queue_len = 0;
2417 }
2418 break;
2419 case 1:
2420 /* filtered by max_lines */
2421 ++more;
2422 break;
2423 case -1:
2424 default:
2425 /*
2426 * Filtered by min_pcnt or non IP lines when
2427 * context != 0
2428 */
2429 if (!context)
2430 break;
2431 if (queue_len == context)
2432 queue = list_entry(queue->node.next, typeof(*queue), node);
2433 else
2434 ++queue_len;
2435 break;
2436 }
2437 }
2438
2439 free(filename);
2440
2441 return more;
2442}
2443
2444static void FILE__set_percent_color(void *fp __maybe_unused,
2445 double percent __maybe_unused,
2446 bool current __maybe_unused)
2447{
2448}
2449
2450static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2451 int nr __maybe_unused, bool current __maybe_unused)
2452{
2453 return 0;
2454}
2455
2456static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2457{
2458 return 0;
2459}
2460
2461static void FILE__printf(void *fp, const char *fmt, ...)
2462{
2463 va_list args;
2464
2465 va_start(args, fmt);
2466 vfprintf(fp, fmt, args);
2467 va_end(args);
2468}
2469
2470static void FILE__write_graph(void *fp, int graph)
2471{
2472 const char *s;
2473 switch (graph) {
2474
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;
2480 }
2481
2482 fputs(s, fp);
2483}
2484
2485static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2486 struct annotation_options *opts)
2487{
2488 struct annotation *notes = symbol__annotation(sym);
2489 struct annotation_write_ops wops = {
2490 .first_line = true,
2491 .obj = fp,
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,
2497 };
2498 struct annotation_line *al;
2499
2500 list_for_each_entry(al, ¬es->src->source, node) {
2501 if (annotation_line__filter(al, notes))
2502 continue;
2503 annotation_line__write(al, notes, &wops, opts);
2504 fputc('\n', fp);
2505 wops.first_line = false;
2506 }
2507
2508 return 0;
2509}
2510
2511int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
2512 struct annotation_options *opts)
2513{
2514 const char *ev_name = evsel__name(evsel);
2515 char buf[1024];
2516 char *filename;
2517 int err = -1;
2518 FILE *fp;
2519
2520 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2521 return -1;
2522
2523 fp = fopen(filename, "w");
2524 if (fp == NULL)
2525 goto out_free_filename;
2526
2527 if (evsel__is_group_event(evsel)) {
2528 evsel__group_desc(evsel, buf, sizeof(buf));
2529 ev_name = buf;
2530 }
2531
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);
2535
2536 fclose(fp);
2537 err = 0;
2538out_free_filename:
2539 free(filename);
2540 return err;
2541}
2542
2543void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2544{
2545 struct annotation *notes = symbol__annotation(sym);
2546 struct sym_hist *h = annotation__histogram(notes, evidx);
2547
2548 memset(h, 0, notes->src->sizeof_sym_hist);
2549}
2550
2551void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2552{
2553 struct annotation *notes = symbol__annotation(sym);
2554 struct sym_hist *h = annotation__histogram(notes, evidx);
2555 int len = symbol__size(sym), offset;
2556
2557 h->nr_samples = 0;
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;
2561 }
2562}
2563
2564void annotated_source__purge(struct annotated_source *as)
2565{
2566 struct annotation_line *al, *n;
2567
2568 list_for_each_entry_safe(al, n, &as->source, node) {
2569 list_del_init(&al->node);
2570 disasm_line__free(disasm_line(al));
2571 }
2572}
2573
2574static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2575{
2576 size_t printed;
2577
2578 if (dl->al.offset == -1)
2579 return fprintf(fp, "%s\n", dl->al.line);
2580
2581 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2582
2583 if (dl->ops.raw[0] != '\0') {
2584 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2585 dl->ops.raw);
2586 }
2587
2588 return printed + fprintf(fp, "\n");
2589}
2590
2591size_t disasm__fprintf(struct list_head *head, FILE *fp)
2592{
2593 struct disasm_line *pos;
2594 size_t printed = 0;
2595
2596 list_for_each_entry(pos, head, al.node)
2597 printed += disasm_line__fprintf(pos, fp);
2598
2599 return printed;
2600}
2601
2602bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2603{
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))
2607 return false;
2608
2609 return true;
2610}
2611
2612void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2613{
2614 u64 offset, size = symbol__size(sym);
2615
2616 /* PLT symbols contain external offsets */
2617 if (strstr(sym->name, "@plt"))
2618 return;
2619
2620 for (offset = 0; offset < size; ++offset) {
2621 struct annotation_line *al = notes->offsets[offset];
2622 struct disasm_line *dl;
2623
2624 dl = disasm_line(al);
2625
2626 if (!disasm_line__is_valid_local_jump(dl, sym))
2627 continue;
2628
2629 al = notes->offsets[dl->ops.target.offset];
2630
2631 /*
2632 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2633 * have to adjust to the previous offset?
2634 */
2635 if (al == NULL)
2636 continue;
2637
2638 if (++al->jump_sources > notes->max_jump_sources)
2639 notes->max_jump_sources = al->jump_sources;
2640 }
2641}
2642
2643void annotation__set_offsets(struct annotation *notes, s64 size)
2644{
2645 struct annotation_line *al;
2646
2647 notes->max_line_len = 0;
2648 notes->nr_entries = 0;
2649 notes->nr_asm_entries = 0;
2650
2651 list_for_each_entry(al, ¬es->src->source, node) {
2652 size_t line_len = strlen(al->line);
2653
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++;
2659 /*
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.
2663 *
2664 * E.g. copy_user_generic_unrolled
2665 */
2666 if (al->offset < size)
2667 notes->offsets[al->offset] = al;
2668 } else
2669 al->idx_asm = -1;
2670 }
2671}
2672
2673static inline int width_jumps(int n)
2674{
2675 if (n >= 100)
2676 return 5;
2677 if (n / 10)
2678 return 2;
2679 return 1;
2680}
2681
2682static int annotation__max_ins_name(struct annotation *notes)
2683{
2684 int max_name = 0, len;
2685 struct annotation_line *al;
2686
2687 list_for_each_entry(al, ¬es->src->source, node) {
2688 if (al->offset == -1)
2689 continue;
2690
2691 len = strlen(disasm_line(al)->ins.name);
2692 if (max_name < len)
2693 max_name = len;
2694 }
2695
2696 return max_name;
2697}
2698
2699void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2700{
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);
2706}
2707
2708void annotation__update_column_widths(struct annotation *notes)
2709{
2710 if (notes->options->use_offset)
2711 notes->widths.target = notes->widths.min_addr;
2712 else
2713 notes->widths.target = notes->widths.max_addr;
2714
2715 notes->widths.addr = notes->widths.target;
2716
2717 if (notes->options->show_nr_jumps)
2718 notes->widths.addr += notes->widths.jumps + 1;
2719}
2720
2721static void annotation__calc_lines(struct annotation *notes, struct map *map,
2722 struct rb_root *root,
2723 struct annotation_options *opts)
2724{
2725 struct annotation_line *al;
2726 struct rb_root tmp_root = RB_ROOT;
2727
2728 list_for_each_entry(al, ¬es->src->source, node) {
2729 double percent_max = 0.0;
2730 int i;
2731
2732 for (i = 0; i < al->data_nr; i++) {
2733 double percent;
2734
2735 percent = annotation_data__percent(&al->data[i],
2736 opts->percent_type);
2737
2738 if (percent > percent_max)
2739 percent_max = percent;
2740 }
2741
2742 if (percent_max <= 0.5)
2743 continue;
2744
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);
2748 }
2749
2750 resort_source_line(root, &tmp_root);
2751}
2752
2753static void symbol__calc_lines(struct map_symbol *ms, struct rb_root *root,
2754 struct annotation_options *opts)
2755{
2756 struct annotation *notes = symbol__annotation(ms->sym);
2757
2758 annotation__calc_lines(notes, ms->map, root, opts);
2759}
2760
2761int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel,
2762 struct annotation_options *opts)
2763{
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);
2768 char buf[1024];
2769
2770 if (symbol__annotate2(ms, evsel, opts, NULL) < 0)
2771 return -1;
2772
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);
2777 }
2778
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);
2783
2784 annotated_source__purge(symbol__annotation(sym)->src);
2785
2786 return 0;
2787}
2788
2789int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel,
2790 struct annotation_options *opts)
2791{
2792 struct dso *dso = ms->map->dso;
2793 struct symbol *sym = ms->sym;
2794 struct rb_root source_line = RB_ROOT;
2795
2796 if (symbol__annotate(ms, evsel, opts, NULL) < 0)
2797 return -1;
2798
2799 symbol__calc_percent(sym, evsel);
2800
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);
2805 }
2806
2807 symbol__annotate_printf(ms, evsel, opts);
2808
2809 annotated_source__purge(symbol__annotation(sym)->src);
2810
2811 return 0;
2812}
2813
2814bool ui__has_annotation(void)
2815{
2816 return use_browser == 1 && perf_hpp_list.sym;
2817}
2818
2819
2820static double annotation_line__max_percent(struct annotation_line *al,
2821 struct annotation *notes,
2822 unsigned int percent_type)
2823{
2824 double percent_max = 0.0;
2825 int i;
2826
2827 for (i = 0; i < notes->nr_events; i++) {
2828 double percent;
2829
2830 percent = annotation_data__percent(&al->data[i],
2831 percent_type);
2832
2833 if (percent > percent_max)
2834 percent_max = percent;
2835 }
2836
2837 return percent_max;
2838}
2839
2840static 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))
2844{
2845 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2846 if (ins__is_jump(&dl->ins)) {
2847 bool fwd;
2848
2849 if (dl->ops.target.outside)
2850 goto call_like;
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)) {
2855call_like:
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, " ");
2861 } else {
2862 obj__printf(obj, " ");
2863 }
2864 } else {
2865 obj__printf(obj, " ");
2866 }
2867
2868 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2869}
2870
2871static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2872{
2873 double ipc = 0.0, coverage = 0.0;
2874
2875 if (notes->hit_cycles)
2876 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2877
2878 if (notes->total_insn) {
2879 coverage = notes->cover_insn * 100.0 /
2880 ((double)notes->total_insn);
2881 }
2882
2883 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2884 ipc, coverage);
2885}
2886
2887static 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))
2895
2896{
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;
2901 char bf[256];
2902 int printed;
2903
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)
2907 show_title = true;
2908 } else
2909 show_title = true;
2910 }
2911
2912 if (al->offset != -1 && percent_max != 0.0) {
2913 int i;
2914
2915 for (i = 0; i < notes->nr_events; i++) {
2916 double percent;
2917
2918 percent = annotation_data__percent(&al->data[i], percent_type);
2919
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);
2926 } else {
2927 obj__printf(obj, "%6.2f ", percent);
2928 }
2929 }
2930 } else {
2931 obj__set_percent_color(obj, 0, current_entry);
2932
2933 if (!show_title)
2934 obj__printf(obj, "%-*s", pcnt_width, " ");
2935 else {
2936 obj__printf(obj, "%-*s", pcnt_width,
2937 symbol_conf.show_total_period ? "Period" :
2938 symbol_conf.show_nr_samples ? "Samples" : "Percent");
2939 }
2940 }
2941
2942 if (notes->have_cycles) {
2943 if (al->ipc)
2944 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2945 else if (!show_title)
2946 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2947 else
2948 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2949
2950 if (!notes->options->show_minmax_cycle) {
2951 if (al->cycles)
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, " ");
2957 else
2958 obj__printf(obj, "%*s ",
2959 ANNOTATION__CYCLES_WIDTH - 1,
2960 "Cycle");
2961 } else {
2962 if (al->cycles) {
2963 char str[32];
2964
2965 scnprintf(str, sizeof(str),
2966 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2967 al->cycles, al->cycles_min,
2968 al->cycles_max);
2969
2970 obj__printf(obj, "%*s ",
2971 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2972 str);
2973 } else if (!show_title)
2974 obj__printf(obj, "%*s",
2975 ANNOTATION__MINMAX_CYCLES_WIDTH,
2976 " ");
2977 else
2978 obj__printf(obj, "%*s ",
2979 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2980 "Cycle(min/max)");
2981 }
2982
2983 if (show_title && !*al->line) {
2984 ipc_coverage_string(bf, sizeof(bf), notes);
2985 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2986 }
2987 }
2988
2989 obj__printf(obj, " ");
2990
2991 if (!*al->line)
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);
2996 else
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);
3000 } else {
3001 u64 addr = al->offset;
3002 int color = -1;
3003
3004 if (!notes->options->use_offset)
3005 addr += notes->start;
3006
3007 if (!notes->options->use_offset) {
3008 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
3009 } else {
3010 if (al->jump_sources &&
3011 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
3012 if (notes->options->show_nr_jumps) {
3013 int prev;
3014 printed = scnprintf(bf, sizeof(bf), "%*d ",
3015 notes->widths.jumps,
3016 al->jump_sources);
3017 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
3018 current_entry);
3019 obj__printf(obj, bf);
3020 obj__set_color(obj, prev);
3021 }
3022print_addr:
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) {
3027 goto print_addr;
3028 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
3029 goto print_addr;
3030 } else {
3031 printed = scnprintf(bf, sizeof(bf), "%-*s ",
3032 notes->widths.addr, " ");
3033 }
3034 }
3035
3036 if (change_color)
3037 color = obj__set_color(obj, HE_COLORSET_ADDR);
3038 obj__printf(obj, bf);
3039 if (change_color)
3040 obj__set_color(obj, color);
3041
3042 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
3043
3044 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
3045 }
3046
3047}
3048
3049void annotation_line__write(struct annotation_line *al, struct annotation *notes,
3050 struct annotation_write_ops *wops,
3051 struct annotation_options *opts)
3052{
3053 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
3054 wops->change_color, wops->width, wops->obj,
3055 opts->percent_type,
3056 wops->set_color, wops->set_percent_color,
3057 wops->set_jumps_percent_color, wops->printf,
3058 wops->write_graph);
3059}
3060
3061int symbol__annotate2(struct map_symbol *ms, struct evsel *evsel,
3062 struct annotation_options *options, struct arch **parch)
3063{
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;
3068
3069 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
3070 if (notes->offsets == NULL)
3071 return ENOMEM;
3072
3073 if (evsel__is_group_event(evsel))
3074 nr_pcnt = evsel->core.nr_members;
3075
3076 err = symbol__annotate(ms, evsel, options, parch);
3077 if (err)
3078 goto out_free_offsets;
3079
3080 notes->options = options;
3081
3082 symbol__calc_percent(sym, evsel);
3083
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;
3089
3090 annotation__update_column_widths(notes);
3091 sym->annotate2 = true;
3092
3093 return 0;
3094
3095out_free_offsets:
3096 zfree(¬es->offsets);
3097 return err;
3098}
3099
3100static int annotation__config(const char *var, const char *value, void *data)
3101{
3102 struct annotation_options *opt = data;
3103
3104 if (!strstarts(var, "annotate."))
3105 return 0;
3106
3107 if (!strcmp(var, "annotate.offset_level")) {
3108 perf_config_u8(&opt->offset_level, "offset_level", value);
3109
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",
3124 value);
3125 } else if (!strcmp(var, "annotate.show_total_period")) {
3126 symbol_conf.show_total_period = perf_config_bool("show_total_period",
3127 value);
3128 } else if (!strcmp(var, "annotate.use_offset")) {
3129 opt->use_offset = perf_config_bool("use_offset", value);
3130 } else {
3131 pr_debug("%s variable unknown, ignoring...", var);
3132 }
3133
3134 return 0;
3135}
3136
3137void annotation_config__init(struct annotation_options *opt)
3138{
3139 perf_config(annotation__config, opt);
3140}
3141
3142static unsigned int parse_percent_type(char *str1, char *str2)
3143{
3144 unsigned int type = (unsigned int) -1;
3145
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;
3151 }
3152
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;
3158 }
3159
3160 return type;
3161}
3162
3163int annotate_parse_percent_type(const struct option *opt, const char *_str,
3164 int unset __maybe_unused)
3165{
3166 struct annotation_options *opts = opt->value;
3167 unsigned int type;
3168 char *str1, *str2;
3169 int err = -1;
3170
3171 str1 = strdup(_str);
3172 if (!str1)
3173 return -ENOMEM;
3174
3175 str2 = strchr(str1, '-');
3176 if (!str2)
3177 goto out;
3178
3179 *str2++ = 0;
3180
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;
3186 err = 0;
3187 }
3188
3189out:
3190 free(str1);
3191 return err;
3192}
3193
3194int annotate_check_args(struct annotation_options *args)
3195{
3196 if (args->prefix_strip && !args->prefix) {
3197 pr_err("--prefix-strip requires --prefix\n");
3198 return -1;
3199 }
3200 return 0;
3201}