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