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