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