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