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