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