annotate.c 66.8 KB
Newer Older
1 2 3 4 5 6 7 8 9
/*
 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
 *
 * Parts came from builtin-annotate.c, see those files for further
 * copyright notes.
 *
 * Released under the GPL v2. (and only v2, not any later version)
 */

10
#include <errno.h>
11
#include <inttypes.h>
12
#include "util.h"
13 14
#include "ui/ui.h"
#include "sort.h"
15 16
#include "build-id.h"
#include "color.h"
17
#include "config.h"
18 19
#include "cache.h"
#include "symbol.h"
20
#include "units.h"
21 22
#include "debug.h"
#include "annotate.h"
23
#include "evsel.h"
24
#include "evlist.h"
25
#include "block-range.h"
26
#include "string2.h"
27
#include "arch/common.h"
28
#include <regex.h>
29
#include <pthread.h>
30
#include <linux/bitops.h>
31
#include <linux/kernel.h>
32

33 34 35 36 37 38 39
/* FIXME: For the HE_COLORSET */
#include "ui/browser.h"

/*
 * FIXME: Using the same values as slang.h,
 * but that header may not be available everywhere
 */
40 41 42 43
#define LARROW_CHAR	((unsigned char)',')
#define RARROW_CHAR	((unsigned char)'+')
#define DARROW_CHAR	((unsigned char)'.')
#define UARROW_CHAR	((unsigned char)'-')
44

45 46
#include "sane_ctype.h"

47 48 49
struct annotation_options annotation__default_options = {
	.use_offset     = true,
	.jump_arrows    = true,
50
	.annotate_src	= true,
51
	.offset_level	= ANNOTATION__OFFSET_JUMP_TARGETS,
52 53
};

54
static regex_t	 file_lineno;
55

56
static struct ins_ops *ins__find(struct arch *arch, const char *name);
57
static void ins__sort(struct arch *arch);
58
static int disasm_line__parse(char *line, const char **namep, char **rawp);
59

60 61
struct arch {
	const char	*name;
62 63
	struct ins	*instructions;
	size_t		nr_instructions;
64 65
	size_t		nr_instructions_allocated;
	struct ins_ops  *(*associate_instruction_ops)(struct arch *arch, const char *name);
66
	bool		sorted_instructions;
67 68
	bool		initialized;
	void		*priv;
69 70
	unsigned int	model;
	unsigned int	family;
71
	int		(*init)(struct arch *arch, char *cpuid);
72 73
	bool		(*ins_is_fused)(struct arch *arch, const char *ins1,
					const char *ins2);
74 75
	struct		{
		char comment_char;
76
		char skip_functions_char;
77 78 79
	} objdump;
};

80 81 82 83 84 85 86 87
static struct ins_ops call_ops;
static struct ins_ops dec_ops;
static struct ins_ops jump_ops;
static struct ins_ops mov_ops;
static struct ins_ops nop_ops;
static struct ins_ops lock_ops;
static struct ins_ops ret_ops;

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
static int arch__grow_instructions(struct arch *arch)
{
	struct ins *new_instructions;
	size_t new_nr_allocated;

	if (arch->nr_instructions_allocated == 0 && arch->instructions)
		goto grow_from_non_allocated_table;

	new_nr_allocated = arch->nr_instructions_allocated + 128;
	new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
	if (new_instructions == NULL)
		return -1;

out_update_instructions:
	arch->instructions = new_instructions;
	arch->nr_instructions_allocated = new_nr_allocated;
	return 0;

grow_from_non_allocated_table:
	new_nr_allocated = arch->nr_instructions + 128;
	new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
	if (new_instructions == NULL)
		return -1;

	memcpy(new_instructions, arch->instructions, arch->nr_instructions);
	goto out_update_instructions;
}

116
static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
{
	struct ins *ins;

	if (arch->nr_instructions == arch->nr_instructions_allocated &&
	    arch__grow_instructions(arch))
		return -1;

	ins = &arch->instructions[arch->nr_instructions];
	ins->name = strdup(name);
	if (!ins->name)
		return -1;

	ins->ops  = ops;
	arch->nr_instructions++;

	ins__sort(arch);
	return 0;
}

136
#include "arch/arm/annotate/instructions.c"
K
Kim Phillips 已提交
137
#include "arch/arm64/annotate/instructions.c"
138
#include "arch/x86/annotate/instructions.c"
139
#include "arch/powerpc/annotate/instructions.c"
140
#include "arch/s390/annotate/instructions.c"
141

142 143 144
static struct arch architectures[] = {
	{
		.name = "arm",
145
		.init = arm__annotate_init,
146
	},
K
Kim Phillips 已提交
147 148 149 150
	{
		.name = "arm64",
		.init = arm64__annotate_init,
	},
151 152
	{
		.name = "x86",
153
		.init = x86__annotate_init,
154 155
		.instructions = x86__instructions,
		.nr_instructions = ARRAY_SIZE(x86__instructions),
156
		.ins_is_fused = x86__ins_is_fused,
157 158 159 160
		.objdump =  {
			.comment_char = '#',
		},
	},
161 162 163 164
	{
		.name = "powerpc",
		.init = powerpc__annotate_init,
	},
165 166
	{
		.name = "s390",
167
		.init = s390__annotate_init,
168 169 170 171
		.objdump =  {
			.comment_char = '#',
		},
	},
172 173
};

174 175
static void ins__delete(struct ins_operands *ops)
{
176 177
	if (ops == NULL)
		return;
178 179 180 181
	zfree(&ops->source.raw);
	zfree(&ops->source.name);
	zfree(&ops->target.raw);
	zfree(&ops->target.name);
182 183
}

184 185 186
static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
			      struct ins_operands *ops)
{
187
	return scnprintf(bf, size, "%-6s %s", ins->name, ops->raw);
188 189 190 191 192 193 194 195 196 197 198
}

int ins__scnprintf(struct ins *ins, char *bf, size_t size,
		  struct ins_operands *ops)
{
	if (ins->ops->scnprintf)
		return ins->ops->scnprintf(ins, bf, size, ops);

	return ins__raw_scnprintf(ins, bf, size, ops);
}

199 200 201 202 203 204 205 206
bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
{
	if (!arch || !arch->ins_is_fused)
		return false;

	return arch->ins_is_fused(arch, ins1, ins2);
}

207
static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
208
{
209
	char *endptr, *tok, *name;
210
	struct map *map = ms->map;
211 212 213
	struct addr_map_symbol target = {
		.map = map,
	};
214

215
	ops->target.addr = strtoull(ops->raw, &endptr, 16);
216 217 218 219 220 221 222

	name = strchr(endptr, '<');
	if (name == NULL)
		goto indirect_call;

	name++;

223 224
	if (arch->objdump.skip_functions_char &&
	    strchr(name, arch->objdump.skip_functions_char))
R
Russell King 已提交
225 226
		return -1;

227 228 229 230 231
	tok = strchr(name, '>');
	if (tok == NULL)
		return -1;

	*tok = '\0';
232
	ops->target.name = strdup(name);
233 234
	*tok = '>';

235 236 237 238
	if (ops->target.name == NULL)
		return -1;
find_target:
	target.addr = map__objdump_2mem(map, ops->target.addr);
239

240 241 242
	if (map_groups__find_ams(&target) == 0 &&
	    map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
		ops->target.sym = target.sym;
243

244
	return 0;
245 246 247 248 249 250

indirect_call:
	tok = strchr(endptr, '*');
	if (tok != NULL)
		ops->target.addr = strtoull(tok + 1, NULL, 16);
	goto find_target;
251 252
}

253
static int call__scnprintf(struct ins *ins, char *bf, size_t size,
254
			   struct ins_operands *ops)
255
{
256 257
	if (ops->target.sym)
		return scnprintf(bf, size, "%-6s %s", ins->name, ops->target.sym->name);
258

259 260 261
	if (ops->target.addr == 0)
		return ins__raw_scnprintf(ins, bf, size, ops);

262 263 264
	if (ops->target.name)
		return scnprintf(bf, size, "%-6s %s", ins->name, ops->target.name);

265
	return scnprintf(bf, size, "%-6s *%" PRIx64, ins->name, ops->target.addr);
266 267
}

268
static struct ins_ops call_ops = {
269 270
	.parse	   = call__parse,
	.scnprintf = call__scnprintf,
271 272 273 274
};

bool ins__is_call(const struct ins *ins)
{
275
	return ins->ops == &call_ops || ins->ops == &s390_call_ops;
276 277
}

278
static int jump__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms)
279
{
280 281 282 283 284
	struct map *map = ms->map;
	struct symbol *sym = ms->sym;
	struct addr_map_symbol target = {
		.map = map,
	};
285
	const char *c = strchr(ops->raw, ',');
286 287 288 289 290 291 292 293 294 295 296 297
	u64 start, end;
	/*
	 * Examples of lines to parse for the _cpp_lex_token@@Base
	 * function:
	 *
	 * 1159e6c: jne    115aa32 <_cpp_lex_token@@Base+0xf92>
	 * 1159e8b: jne    c469be <cpp_named_operator2name@@Base+0xa72>
	 *
	 * The first is a jump to an offset inside the same function,
	 * the second is to another function, i.e. that 0xa72 is an
	 * offset in the cpp_named_operator2name@@base function.
	 */
298 299 300 301 302
	/*
	 * skip over possible up to 2 operands to get to address, e.g.:
	 * tbnz	 w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
	 */
	if (c++ != NULL) {
303
		ops->target.addr = strtoull(c, NULL, 16);
304 305 306 307 308 309
		if (!ops->target.addr) {
			c = strchr(c, ',');
			if (c++ != NULL)
				ops->target.addr = strtoull(c, NULL, 16);
		}
	} else {
310
		ops->target.addr = strtoull(ops->raw, NULL, 16);
311
	}
312

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
	target.addr = map__objdump_2mem(map, ops->target.addr);
	start = map->unmap_ip(map, sym->start),
	end = map->unmap_ip(map, sym->end);

	ops->target.outside = target.addr < start || target.addr > end;

	/*
	 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):

		cpp_named_operator2name@@Base+0xa72

	 * Point to a place that is after the cpp_named_operator2name
	 * boundaries, i.e.  in the ELF symbol table for cc1
	 * cpp_named_operator2name is marked as being 32-bytes long, but it in
	 * fact is much larger than that, so we seem to need a symbols__find()
	 * routine that looks for >= current->start and  < next_symbol->start,
	 * possibly just for C++ objects?
	 *
	 * For now lets just make some progress by marking jumps to outside the
	 * current function as call like.
	 *
	 * Actual navigation will come next, with further understanding of how
	 * the symbol searching and disassembly should be done.
336
	 */
337 338 339 340
	if (map_groups__find_ams(&target) == 0 &&
	    map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
		ops->target.sym = target.sym;

341 342
	if (!ops->target.outside) {
		ops->target.offset = target.addr - start;
343 344 345 346
		ops->target.offset_avail = true;
	} else {
		ops->target.offset_avail = false;
	}
347 348 349 350

	return 0;
}

351
static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
352
			   struct ins_operands *ops)
353
{
354
	const char *c;
355

356
	if (!ops->target.addr || ops->target.offset < 0)
357 358
		return ins__raw_scnprintf(ins, bf, size, ops);

359 360 361
	if (ops->target.outside && ops->target.sym != NULL)
		return scnprintf(bf, size, "%-6s %s", ins->name, ops->target.sym->name);

362
	c = strchr(ops->raw, ',');
363 364 365 366 367 368 369 370 371 372 373 374 375
	if (c != NULL) {
		const char *c2 = strchr(c + 1, ',');

		/* check for 3-op insn */
		if (c2 != NULL)
			c = c2;
		c++;

		/* mirror arch objdump's space-after-comma style */
		if (*c == ' ')
			c++;
	}

376
	return scnprintf(bf, size, "%-6s %.*s%" PRIx64,
377 378
			 ins->name, c ? c - ops->raw : 0, ops->raw,
			 ops->target.offset);
379 380
}

381
static struct ins_ops jump_ops = {
382 383
	.parse	   = jump__parse,
	.scnprintf = jump__scnprintf,
384 385 386 387 388 389 390
};

bool ins__is_jump(const struct ins *ins)
{
	return ins->ops == &jump_ops;
}

391 392 393 394 395 396 397 398
static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
{
	char *endptr, *name, *t;

	if (strstr(raw, "(%rip)") == NULL)
		return 0;

	*addrp = strtoull(comment, &endptr, 16);
399 400
	if (endptr == comment)
		return 0;
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
	name = strchr(endptr, '<');
	if (name == NULL)
		return -1;

	name++;

	t = strchr(name, '>');
	if (t == NULL)
		return 0;

	*t = '\0';
	*namep = strdup(name);
	*t = '>';

	return 0;
}

418
static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
419 420 421 422 423
{
	ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
	if (ops->locked.ops == NULL)
		return 0;

424
	if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
425 426
		goto out_free_ops;

427
	ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
428

429
	if (ops->locked.ins.ops == NULL)
N
Namhyung Kim 已提交
430
		goto out_free_ops;
431

432
	if (ops->locked.ins.ops->parse &&
433
	    ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
434
		goto out_free_ops;
435 436 437 438

	return 0;

out_free_ops:
439
	zfree(&ops->locked.ops);
440 441 442 443 444 445 446 447
	return 0;
}

static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
			   struct ins_operands *ops)
{
	int printed;

448
	if (ops->locked.ins.ops == NULL)
449 450
		return ins__raw_scnprintf(ins, bf, size, ops);

451
	printed = scnprintf(bf, size, "%-6s ", ins->name);
452
	return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
453 454 455
					size - printed, ops->locked.ops);
}

456 457
static void lock__delete(struct ins_operands *ops)
{
458
	struct ins *ins = &ops->locked.ins;
459

460
	if (ins->ops && ins->ops->free)
461 462 463 464
		ins->ops->free(ops->locked.ops);
	else
		ins__delete(ops->locked.ops);

465 466 467
	zfree(&ops->locked.ops);
	zfree(&ops->target.raw);
	zfree(&ops->target.name);
468 469
}

470
static struct ins_ops lock_ops = {
471
	.free	   = lock__delete,
472 473 474 475
	.parse	   = lock__parse,
	.scnprintf = lock__scnprintf,
};

476
static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
477 478 479 480 481 482 483 484 485
{
	char *s = strchr(ops->raw, ','), *target, *comment, prev;

	if (s == NULL)
		return -1;

	*s = '\0';
	ops->source.raw = strdup(ops->raw);
	*s = ',';
486

487 488 489 490
	if (ops->source.raw == NULL)
		return -1;

	target = ++s;
491
	comment = strchr(s, arch->objdump.comment_char);
492 493 494 495 496

	if (comment != NULL)
		s = comment - 1;
	else
		s = strchr(s, '\0') - 1;
497

498 499 500
	while (s > target && isspace(s[0]))
		--s;
	s++;
501 502 503 504 505 506 507 508 509 510 511 512
	prev = *s;
	*s = '\0';

	ops->target.raw = strdup(target);
	*s = prev;

	if (ops->target.raw == NULL)
		goto out_free_source;

	if (comment == NULL)
		return 0;

513
	comment = ltrim(comment);
514 515
	comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
	comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
516 517 518 519

	return 0;

out_free_source:
520
	zfree(&ops->source.raw);
521 522 523 524 525 526
	return -1;
}

static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
			   struct ins_operands *ops)
{
527
	return scnprintf(bf, size, "%-6s %s,%s", ins->name,
528 529 530 531 532 533 534 535 536
			 ops->source.name ?: ops->source.raw,
			 ops->target.name ?: ops->target.raw);
}

static struct ins_ops mov_ops = {
	.parse	   = mov__parse,
	.scnprintf = mov__scnprintf,
};

537
static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
{
	char *target, *comment, *s, prev;

	target = s = ops->raw;

	while (s[0] != '\0' && !isspace(s[0]))
		++s;
	prev = *s;
	*s = '\0';

	ops->target.raw = strdup(target);
	*s = prev;

	if (ops->target.raw == NULL)
		return -1;

554
	comment = strchr(s, arch->objdump.comment_char);
555 556 557
	if (comment == NULL)
		return 0;

558
	comment = ltrim(comment);
559
	comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
560 561 562 563 564 565 566

	return 0;
}

static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
			   struct ins_operands *ops)
{
567
	return scnprintf(bf, size, "%-6s %s", ins->name,
568 569 570 571 572 573 574 575
			 ops->target.name ?: ops->target.raw);
}

static struct ins_ops dec_ops = {
	.parse	   = dec__parse,
	.scnprintf = dec__scnprintf,
};

576 577
static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
			  struct ins_operands *ops __maybe_unused)
578
{
579
	return scnprintf(bf, size, "%-6s", "nop");
580 581 582 583 584 585
}

static struct ins_ops nop_ops = {
	.scnprintf = nop__scnprintf,
};

586 587 588 589 590 591 592 593 594
static struct ins_ops ret_ops = {
	.scnprintf = ins__raw_scnprintf,
};

bool ins__is_ret(const struct ins *ins)
{
	return ins->ops == &ret_ops;
}

595 596 597 598 599
bool ins__is_lock(const struct ins *ins)
{
	return ins->ops == &lock_ops;
}

600
static int ins__key_cmp(const void *name, const void *insp)
601 602 603 604 605 606
{
	const struct ins *ins = insp;

	return strcmp(name, ins->name);
}

607 608 609 610 611 612 613 614
static int ins__cmp(const void *a, const void *b)
{
	const struct ins *ia = a;
	const struct ins *ib = b;

	return strcmp(ia->name, ib->name);
}

615
static void ins__sort(struct arch *arch)
616
{
617
	const int nmemb = arch->nr_instructions;
618

619
	qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
620 621
}

622
static struct ins_ops *__ins__find(struct arch *arch, const char *name)
623
{
624
	struct ins *ins;
625
	const int nmemb = arch->nr_instructions;
626

627 628 629
	if (!arch->sorted_instructions) {
		ins__sort(arch);
		arch->sorted_instructions = true;
630
	}
631

632 633
	ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
	return ins ? ins->ops : NULL;
634 635
}

636 637 638 639 640 641 642 643 644 645
static struct ins_ops *ins__find(struct arch *arch, const char *name)
{
	struct ins_ops *ops = __ins__find(arch, name);

	if (!ops && arch->associate_instruction_ops)
		ops = arch->associate_instruction_ops(arch, name);

	return ops;
}

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
static int arch__key_cmp(const void *name, const void *archp)
{
	const struct arch *arch = archp;

	return strcmp(name, arch->name);
}

static int arch__cmp(const void *a, const void *b)
{
	const struct arch *aa = a;
	const struct arch *ab = b;

	return strcmp(aa->name, ab->name);
}

static void arch__sort(void)
{
	const int nmemb = ARRAY_SIZE(architectures);

	qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
}

static struct arch *arch__find(const char *name)
{
	const int nmemb = ARRAY_SIZE(architectures);
	static bool sorted;

	if (!sorted) {
		arch__sort();
		sorted = true;
	}

	return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
}

681 682 683 684 685 686 687 688 689 690
static struct annotated_source *annotated_source__new(void)
{
	struct annotated_source *src = zalloc(sizeof(*src));

	if (src != NULL)
		INIT_LIST_HEAD(&src->source);

	return src;
}

691
static __maybe_unused void annotated_source__delete(struct annotated_source *src)
692 693 694 695 696 697 698 699
{
	if (src == NULL)
		return;
	zfree(&src->histograms);
	zfree(&src->cycles_hist);
	free(src);
}

700 701
static int annotated_source__alloc_histograms(struct annotated_source *src,
					      size_t size, int nr_hists)
702
{
703 704
	size_t sizeof_sym_hist;

705 706 707 708 709 710 711 712 713 714
	/*
	 * Add buffer of one element for zero length symbol.
	 * When sample is taken from first instruction of
	 * zero length symbol, perf still resolves it and
	 * shows symbol name in perf report and allows to
	 * annotate it.
	 */
	if (size == 0)
		size = 1;

715
	/* Check for overflow when calculating sizeof_sym_hist */
716
	if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
717 718
		return -1;

719
	sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
720 721

	/* Check for overflow in zalloc argument */
722
	if (sizeof_sym_hist > SIZE_MAX / nr_hists)
723
		return -1;
724

725 726 727 728 729 730
	src->sizeof_sym_hist = sizeof_sym_hist;
	src->nr_histograms   = nr_hists;
	src->histograms	     = calloc(nr_hists, sizeof_sym_hist) ;
	return src->histograms ? 0 : -1;
}

731 732 733 734 735 736 737 738 739 740 741 742
/* The cycles histogram is lazily allocated. */
static int symbol__alloc_hist_cycles(struct symbol *sym)
{
	struct annotation *notes = symbol__annotation(sym);
	const size_t size = symbol__size(sym);

	notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
	if (notes->src->cycles_hist == NULL)
		return -1;
	return 0;
}

743 744 745 746
void symbol__annotate_zero_histograms(struct symbol *sym)
{
	struct annotation *notes = symbol__annotation(sym);

747
	pthread_mutex_lock(&notes->lock);
748
	if (notes->src != NULL) {
749 750
		memset(notes->src->histograms, 0,
		       notes->src->nr_histograms * notes->src->sizeof_sym_hist);
751 752 753 754
		if (notes->src->cycles_hist)
			memset(notes->src->cycles_hist, 0,
				symbol__size(sym) * sizeof(struct cyc_hist));
	}
755
	pthread_mutex_unlock(&notes->lock);
756 757
}

758
static int __symbol__account_cycles(struct cyc_hist *ch,
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
				    u64 start,
				    unsigned offset, unsigned cycles,
				    unsigned have_start)
{
	/*
	 * For now we can only account one basic block per
	 * final jump. But multiple could be overlapping.
	 * Always account the longest one. So when
	 * a shorter one has been already seen throw it away.
	 *
	 * We separately always account the full cycles.
	 */
	ch[offset].num_aggr++;
	ch[offset].cycles_aggr += cycles;

774 775 776 777 778 779 780 781 782
	if (cycles > ch[offset].cycles_max)
		ch[offset].cycles_max = cycles;

	if (ch[offset].cycles_min) {
		if (cycles && cycles < ch[offset].cycles_min)
			ch[offset].cycles_min = cycles;
	} else
		ch[offset].cycles_min = cycles;

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
	if (!have_start && ch[offset].have_start)
		return 0;
	if (ch[offset].num) {
		if (have_start && (!ch[offset].have_start ||
				   ch[offset].start > start)) {
			ch[offset].have_start = 0;
			ch[offset].cycles = 0;
			ch[offset].num = 0;
			if (ch[offset].reset < 0xffff)
				ch[offset].reset++;
		} else if (have_start &&
			   ch[offset].start < start)
			return 0;
	}
	ch[offset].have_start = have_start;
	ch[offset].start = start;
	ch[offset].cycles += cycles;
	ch[offset].num++;
	return 0;
}

804
static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
805
				      struct annotated_source *src, int evidx, u64 addr,
806
				      struct perf_sample *sample)
807
{
808
	unsigned offset;
809 810 811 812
	struct sym_hist *h;

	pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));

813 814
	if ((addr < sym->start || addr >= sym->end) &&
	    (addr != sym->end || sym->start != sym->end)) {
815 816
		pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
		       __func__, __LINE__, sym->name, sym->start, addr, sym->end);
817
		return -ERANGE;
818
	}
819

820
	offset = addr - sym->start;
821
	h = annotated_source__histogram(src, evidx);
822 823 824 825 826
	if (h == NULL) {
		pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
			 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
		return -ENOMEM;
	}
827
	h->nr_samples++;
828
	h->addr[offset].nr_samples++;
829 830
	h->period += sample->period;
	h->addr[offset].period += sample->period;
831 832

	pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
833 834 835
		  ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
		  sym->start, sym->name, addr, addr - sym->start, evidx,
		  h->addr[offset].nr_samples, h->addr[offset].period);
836 837 838
	return 0;
}

839
static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
840 841 842 843
{
	struct annotation *notes = symbol__annotation(sym);

	if (notes->src == NULL) {
844 845
		notes->src = annotated_source__new();
		if (notes->src == NULL)
846
			return NULL;
847
		goto alloc_cycles_hist;
848
	}
849 850 851 852

	if (!notes->src->cycles_hist) {
alloc_cycles_hist:
		symbol__alloc_hist_cycles(sym);
853
	}
854 855

	return notes->src->cycles_hist;
856 857
}

858
struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
859 860 861 862 863 864 865 866 867 868 869 870 871
{
	struct annotation *notes = symbol__annotation(sym);

	if (notes->src == NULL) {
		notes->src = annotated_source__new();
		if (notes->src == NULL)
			return NULL;
		goto alloc_histograms;
	}

	if (notes->src->histograms == NULL) {
alloc_histograms:
		annotated_source__alloc_histograms(notes->src, symbol__size(sym),
872
						   nr_hists);
873 874 875 876 877
	}

	return notes->src;
}

878
static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
879
				    struct perf_evsel *evsel, u64 addr,
880
				    struct perf_sample *sample)
881
{
882
	struct annotated_source *src;
883

884
	if (sym == NULL)
885
		return 0;
886
	src = symbol__hists(sym, evsel->evlist->nr_entries);
887
	if (src == NULL)
888
		return -ENOMEM;
889
	return __symbol__inc_addr_samples(sym, map, src, evsel->idx, addr, sample);
890 891
}

892 893 894
static int symbol__account_cycles(u64 addr, u64 start,
				  struct symbol *sym, unsigned cycles)
{
895
	struct cyc_hist *cycles_hist;
896 897 898 899
	unsigned offset;

	if (sym == NULL)
		return 0;
900 901
	cycles_hist = symbol__cycles_hist(sym);
	if (cycles_hist == NULL)
902 903 904 905 906 907 908 909 910 911 912
		return -ENOMEM;
	if (addr < sym->start || addr >= sym->end)
		return -ERANGE;

	if (start) {
		if (start < sym->start || start >= sym->end)
			return -ERANGE;
		if (start >= addr)
			start = 0;
	}
	offset = addr - sym->start;
913
	return __symbol__account_cycles(cycles_hist,
914 915 916 917 918 919 920 921 922
					start ? start - sym->start : 0,
					offset, cycles,
					!!start);
}

int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
				    struct addr_map_symbol *start,
				    unsigned cycles)
{
923
	u64 saddr = 0;
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
	int err;

	if (!cycles)
		return 0;

	/*
	 * Only set start when IPC can be computed. We can only
	 * compute it when the basic block is completely in a single
	 * function.
	 * Special case the case when the jump is elsewhere, but
	 * it starts on the function start.
	 */
	if (start &&
		(start->sym == ams->sym ||
		 (ams->sym &&
		   start->addr == ams->sym->start + ams->map->start)))
		saddr = start->al_addr;
	if (saddr == 0)
942
		pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
943 944 945 946 947 948 949 950 951 952
			ams->addr,
			start ? start->addr : 0,
			ams->sym ? ams->sym->start + ams->map->start : 0,
			saddr);
	err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
	if (err)
		pr_debug2("account_cycles failed %d\n", err);
	return err;
}

953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
{
	unsigned n_insn = 0;
	u64 offset;

	for (offset = start; offset <= end; offset++) {
		if (notes->offsets[offset])
			n_insn++;
	}
	return n_insn;
}

static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
{
	unsigned n_insn;
	u64 offset;

	n_insn = annotation__count_insn(notes, start, end);
	if (n_insn && ch->num && ch->cycles) {
		float ipc = n_insn / ((double)ch->cycles / (double)ch->num);

		/* Hide data when there are too many overlaps. */
		if (ch->reset >= 0x7fff || ch->reset >= ch->num / 2)
			return;

		for (offset = start; offset <= end; offset++) {
			struct annotation_line *al = notes->offsets[offset];

			if (al)
				al->ipc = ipc;
		}
	}
}

void annotation__compute_ipc(struct annotation *notes, size_t size)
{
	u64 offset;

	if (!notes->src || !notes->src->cycles_hist)
		return;

	pthread_mutex_lock(&notes->lock);
	for (offset = 0; offset < size; ++offset) {
		struct cyc_hist *ch;

		ch = &notes->src->cycles_hist[offset];
		if (ch && ch->cycles) {
			struct annotation_line *al;

			if (ch->have_start)
				annotation__count_and_fill(notes, ch->start, offset, ch);
			al = notes->offsets[offset];
1005
			if (al && ch->num_aggr) {
1006
				al->cycles = ch->cycles_aggr / ch->num_aggr;
1007 1008 1009
				al->cycles_max = ch->cycles_max;
				al->cycles_min = ch->cycles_min;
			}
1010 1011 1012 1013 1014 1015
			notes->have_cycles = true;
		}
	}
	pthread_mutex_unlock(&notes->lock);
}

1016
int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1017
				 struct perf_evsel *evsel)
1018
{
1019
	return symbol__inc_addr_samples(ams->sym, ams->map, evsel, ams->al_addr, sample);
1020 1021
}

1022
int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1023
				 struct perf_evsel *evsel, u64 ip)
1024
{
1025
	return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evsel, ip, sample);
1026 1027
}

1028
static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1029
{
1030
	dl->ins.ops = ins__find(arch, dl->ins.name);
1031

1032
	if (!dl->ins.ops)
1033 1034
		return;

1035
	if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1036
		dl->ins.ops = NULL;
1037 1038
}

1039
static int disasm_line__parse(char *line, const char **namep, char **rawp)
1040
{
1041
	char tmp, *name = ltrim(line);
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

	if (name[0] == '\0')
		return -1;

	*rawp = name + 1;

	while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
		++*rawp;

	tmp = (*rawp)[0];
	(*rawp)[0] = '\0';
	*namep = strdup(name);

	if (*namep == NULL)
		goto out_free_name;

	(*rawp)[0] = tmp;
1059
	*rawp = ltrim(*rawp);
1060 1061 1062 1063

	return 0;

out_free_name:
1064 1065
	free((void *)namep);
	*namep = NULL;
1066 1067 1068
	return -1;
}

1069 1070
struct annotate_args {
	size_t			 privsize;
1071
	struct arch		*arch;
1072
	struct map_symbol	 ms;
1073
	struct perf_evsel	*evsel;
1074
	struct annotation_options *options;
1075 1076 1077
	s64			 offset;
	char			*line;
	int			 line_nr;
1078 1079
};

1080 1081 1082 1083
static void annotation_line__delete(struct annotation_line *al)
{
	void *ptr = (void *) al - al->privsize;

1084
	free_srcline(al->path);
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
	zfree(&al->line);
	free(ptr);
}

/*
 * Allocating the annotation line data with following
 * structure:
 *
 *    --------------------------------------
 *    private space | struct annotation_line
 *    --------------------------------------
 *
 * Size of the private space is stored in 'struct annotation_line'.
 *
 */
static struct annotation_line *
annotation_line__new(struct annotate_args *args, size_t privsize)
{
	struct annotation_line *al;
1104
	struct perf_evsel *evsel = args->evsel;
1105
	size_t size = privsize + sizeof(*al);
1106 1107 1108 1109 1110
	int nr = 1;

	if (perf_evsel__is_group_event(evsel))
		nr = evsel->nr_members;

1111
	size += sizeof(al->data[0]) * nr;
1112 1113 1114 1115 1116 1117 1118 1119

	al = zalloc(size);
	if (al) {
		al = (void *) al + privsize;
		al->privsize   = privsize;
		al->offset     = args->offset;
		al->line       = strdup(args->line);
		al->line_nr    = args->line_nr;
1120
		al->data_nr    = nr;
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
	}

	return al;
}

/*
 * Allocating the disasm annotation line data with
 * following structure:
 *
 *    ------------------------------------------------------------
 *    privsize space | struct disasm_line | struct annotation_line
 *    ------------------------------------------------------------
 *
 * We have 'struct annotation_line' member as last member
 * of 'struct disasm_line' to have an easy access.
 *
 */
1138
static struct disasm_line *disasm_line__new(struct annotate_args *args)
1139
{
1140 1141 1142
	struct disasm_line *dl = NULL;
	struct annotation_line *al;
	size_t privsize = args->privsize + offsetof(struct disasm_line, al);
1143

1144 1145 1146
	al = annotation_line__new(args, privsize);
	if (al != NULL) {
		dl = disasm_line(al);
1147 1148

		if (dl->al.line == NULL)
1149
			goto out_delete;
1150

1151
		if (args->offset != -1) {
1152
			if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1153 1154
				goto out_free_line;

1155
			disasm_line__init_ins(dl, args->arch, &args->ms);
1156
		}
1157 1158
	}

1159
	return dl;
1160 1161

out_free_line:
1162
	zfree(&dl->al.line);
1163
out_delete:
1164
	free(dl);
1165
	return NULL;
1166 1167
}

1168
void disasm_line__free(struct disasm_line *dl)
1169
{
1170 1171
	if (dl->ins.ops && dl->ins.ops->free)
		dl->ins.ops->free(&dl->ops);
1172 1173
	else
		ins__delete(&dl->ops);
1174 1175
	free((void *)dl->ins.name);
	dl->ins.name = NULL;
1176
	annotation_line__delete(&dl->al);
1177 1178
}

1179 1180
int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
{
1181
	if (raw || !dl->ins.ops)
1182
		return scnprintf(bf, size, "%-6s %s", dl->ins.name, dl->ops.raw);
1183

1184
	return ins__scnprintf(&dl->ins, bf, size, &dl->ops);
1185 1186
}

1187
static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1188
{
1189
	list_add_tail(&al->node, head);
1190 1191
}

1192 1193
struct annotation_line *
annotation_line__next(struct annotation_line *pos, struct list_head *head)
1194
{
1195 1196
	list_for_each_entry_continue(pos, head, node)
		if (pos->offset >= 0)
1197 1198 1199 1200 1201
			return pos;

	return NULL;
}

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
static const char *annotate__address_color(struct block_range *br)
{
	double cov = block_range__coverage(br);

	if (cov >= 0) {
		/* mark red for >75% coverage */
		if (cov > 0.75)
			return PERF_COLOR_RED;

		/* mark dull for <1% coverage */
		if (cov < 0.01)
			return PERF_COLOR_NORMAL;
	}

	return PERF_COLOR_MAGENTA;
}

static const char *annotate__asm_color(struct block_range *br)
{
	double cov = block_range__coverage(br);

	if (cov >= 0) {
		/* mark dull for <1% coverage */
		if (cov < 0.01)
			return PERF_COLOR_NORMAL;
	}

	return PERF_COLOR_BLUE;
}

static void annotate__branch_printf(struct block_range *br, u64 addr)
{
	bool emit_comment = true;

	if (!br)
		return;

#if 1
	if (br->is_target && br->start == addr) {
		struct block_range *branch = br;
		double p;

		/*
		 * Find matching branch to our target.
		 */
		while (!branch->is_branch)
			branch = block_range__next(branch);

		p = 100 *(double)br->entry / branch->coverage;

		if (p > 0.1) {
			if (emit_comment) {
				emit_comment = false;
				printf("\t#");
			}

			/*
			 * The percentage of coverage joined at this target in relation
			 * to the next branch.
			 */
			printf(" +%.2f%%", p);
		}
	}
#endif
	if (br->is_branch && br->end == addr) {
		double p = 100*(double)br->taken / br->coverage;

		if (p > 0.1) {
			if (emit_comment) {
				emit_comment = false;
				printf("\t#");
			}

			/*
			 * The percentage of coverage leaving at this branch, and
			 * its prediction ratio.
			 */
			printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred  / br->taken);
		}
	}
}

1284
static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1285
{
1286 1287 1288 1289 1290
	s64 offset = dl->al.offset;
	const u64 addr = start + offset;
	struct block_range *br;

	br = block_range__find(addr);
1291
	color_fprintf(stdout, annotate__address_color(br), "  %*" PRIx64 ":", addr_fmt_width, addr);
1292 1293 1294 1295 1296 1297 1298 1299
	color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
	annotate__branch_printf(br, addr);
	return 0;
}

static int
annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
		       struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
1300
		       int max_lines, struct annotation_line *queue, int addr_fmt_width)
1301 1302
{
	struct disasm_line *dl = container_of(al, struct disasm_line, al);
1303 1304 1305
	static const char *prev_line;
	static const char *prev_color;

1306
	if (al->offset != -1) {
1307
		double max_percent = 0.0;
1308
		int i, nr_percent = 1;
1309 1310
		const char *color;
		struct annotation *notes = symbol__annotation(sym);
1311

1312
		for (i = 0; i < al->data_nr; i++) {
1313 1314 1315 1316
			double percent;

			percent = annotation_data__percent(&al->data[i],
							   PERCENT_HITS_LOCAL);
1317

1318 1319
			if (percent > max_percent)
				max_percent = percent;
1320 1321
		}

1322 1323
		if (al->data_nr > nr_percent)
			nr_percent = al->data_nr;
1324

1325
		if (max_percent < min_pcnt)
1326 1327
			return -1;

1328
		if (max_lines && printed >= max_lines)
1329
			return 1;
1330

1331
		if (queue != NULL) {
1332 1333
			list_for_each_entry_from(queue, &notes->src->source, node) {
				if (queue == al)
1334
					break;
1335
				annotation_line__print(queue, sym, start, evsel, len,
1336
						       0, 0, 1, NULL, addr_fmt_width);
1337 1338 1339
			}
		}

1340
		color = get_percent_color(max_percent);
1341 1342 1343 1344 1345 1346

		/*
		 * Also color the filename and line if needed, with
		 * the same color than the percentage. Don't print it
		 * twice for close colored addr with the same filename:line
		 */
1347 1348
		if (al->path) {
			if (!prev_line || strcmp(prev_line, al->path)
1349
				       || color != prev_color) {
1350 1351
				color_fprintf(stdout, color, " %s", al->path);
				prev_line = al->path;
1352 1353 1354 1355
				prev_color = color;
			}
		}

1356
		for (i = 0; i < nr_percent; i++) {
1357
			struct annotation_data *data = &al->data[i];
1358
			double percent;
1359

1360 1361
			percent = annotation_data__percent(data, PERCENT_HITS_LOCAL);
			color = get_percent_color(percent);
1362 1363

			if (symbol_conf.show_total_period)
1364
				color_fprintf(stdout, color, " %11" PRIu64,
1365
					      data->he.period);
1366 1367
			else if (symbol_conf.show_nr_samples)
				color_fprintf(stdout, color, " %7" PRIu64,
1368
					      data->he.nr_samples);
1369
			else
1370
				color_fprintf(stdout, color, " %7.2f", percent);
1371 1372
		}

1373
		printf(" : ");
1374

1375
		disasm_line__print(dl, start, addr_fmt_width);
1376
		printf("\n");
1377
	} else if (max_lines && printed >= max_lines)
1378 1379
		return 1;
	else {
1380
		int width = symbol_conf.show_total_period ? 12 : 8;
1381

1382 1383 1384
		if (queue)
			return -1;

1385
		if (perf_evsel__is_group_event(evsel))
1386 1387
			width *= evsel->nr_members;

1388
		if (!*al->line)
1389
			printf(" %*s:\n", width, " ");
1390
		else
1391
			printf(" %*s:     %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1392
	}
1393 1394

	return 0;
1395 1396
}

1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
/*
 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
 * which looks like following
 *
 *  0000000000415500 <_init>:
 *    415500:       sub    $0x8,%rsp
 *    415504:       mov    0x2f5ad5(%rip),%rax        # 70afe0 <_DYNAMIC+0x2f8>
 *    41550b:       test   %rax,%rax
 *    41550e:       je     415515 <_init+0x15>
 *    415510:       callq  416e70 <__gmon_start__@plt>
 *    415515:       add    $0x8,%rsp
 *    415519:       retq
 *
 * it will be parsed and saved into struct disasm_line as
 *  <offset>       <name>  <ops.raw>
 *
 * The offset will be a relative offset from the start of the symbol and -1
 * means that it's not a disassembly line so should be treated differently.
 * The ops.raw part will be parsed further according to type of the instruction.
 */
1417
static int symbol__parse_objdump_line(struct symbol *sym, FILE *file,
1418
				      struct annotate_args *args,
1419
				      int *line_nr)
1420
{
1421
	struct map *map = args->ms.map;
1422
	struct annotation *notes = symbol__annotation(sym);
1423
	struct disasm_line *dl;
1424
	char *line = NULL, *parsed_line, *tmp, *tmp2;
1425 1426
	size_t line_len;
	s64 line_ip, offset = -1;
1427
	regmatch_t match[2];
1428 1429 1430 1431 1432 1433 1434 1435

	if (getline(&line, &line_len, file) < 0)
		return -1;

	if (!line)
		return -1;

	line_ip = -1;
1436
	parsed_line = rtrim(line);
1437

1438
	/* /filename:linenr ? Save line number and ignore. */
1439 1440
	if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
		*line_nr = atoi(parsed_line + match[1].rm_so);
1441 1442 1443
		return 0;
	}

1444
	tmp = ltrim(parsed_line);
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
	if (*tmp) {
		/*
		 * Parse hexa addresses followed by ':'
		 */
		line_ip = strtoull(tmp, &tmp2, 16);
		if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
			line_ip = -1;
	}

	if (line_ip != -1) {
		u64 start = map__rip_2objdump(map, sym->start),
		    end = map__rip_2objdump(map, sym->end);

		offset = line_ip - start;
1459
		if ((u64)line_ip < start || (u64)line_ip >= end)
1460
			offset = -1;
1461 1462
		else
			parsed_line = tmp2 + 1;
N
Namhyung Kim 已提交
1463
	}
1464

1465 1466 1467
	args->offset  = offset;
	args->line    = parsed_line;
	args->line_nr = *line_nr;
1468
	args->ms.sym  = sym;
1469 1470

	dl = disasm_line__new(args);
1471
	free(line);
1472
	(*line_nr)++;
1473

1474
	if (dl == NULL)
1475
		return -1;
1476

1477
	if (!disasm_line__has_local_offset(dl)) {
1478 1479
		dl->ops.target.offset = dl->ops.target.addr -
					map__rip_2objdump(map, sym->start);
1480 1481
		dl->ops.target.offset_avail = true;
	}
1482

1483 1484
	/* kcore has no symbols, so add the call target symbol */
	if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1485 1486 1487 1488 1489
		struct addr_map_symbol target = {
			.map = map,
			.addr = dl->ops.target.addr,
		};

1490
		if (!map_groups__find_ams(&target) &&
1491
		    target.sym->start == target.al_addr)
1492
			dl->ops.target.sym = target.sym;
1493 1494
	}

1495
	annotation_line__add(&dl->al, &notes->src->source);
1496 1497 1498 1499

	return 0;
}

1500 1501 1502 1503 1504
static __attribute__((constructor)) void symbol__init_regexpr(void)
{
	regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
}

1505 1506 1507 1508 1509 1510 1511
static void delete_last_nop(struct symbol *sym)
{
	struct annotation *notes = symbol__annotation(sym);
	struct list_head *list = &notes->src->source;
	struct disasm_line *dl;

	while (!list_empty(list)) {
1512
		dl = list_entry(list->prev, struct disasm_line, al.node);
1513

1514 1515
		if (dl->ins.ops) {
			if (dl->ins.ops != &nop_ops)
1516 1517
				return;
		} else {
1518 1519 1520
			if (!strstr(dl->al.line, " nop ") &&
			    !strstr(dl->al.line, " nopl ") &&
			    !strstr(dl->al.line, " nopw "))
1521 1522 1523
				return;
		}

1524
		list_del(&dl->al.node);
1525 1526 1527 1528
		disasm_line__free(dl);
	}
}

1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
			      int errnum, char *buf, size_t buflen)
{
	struct dso *dso = map->dso;

	BUG_ON(buflen == 0);

	if (errnum >= 0) {
		str_error_r(errnum, buf, buflen);
		return 0;
	}

	switch (errnum) {
	case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
		char bf[SBUILD_ID_SIZE + 15] = " with build id ";
		char *build_id_msg = NULL;

		if (dso->has_build_id) {
			build_id__sprintf(dso->build_id,
					  sizeof(dso->build_id), bf + 15);
			build_id_msg = bf;
		}
		scnprintf(buf, buflen,
			  "No vmlinux file%s\nwas found in the path.\n\n"
			  "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
			  "Please use:\n\n"
			  "  perf buildid-cache -vu vmlinux\n\n"
			  "or:\n\n"
			  "  --vmlinux vmlinux\n", build_id_msg ?: "");
	}
		break;
	default:
		scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
		break;
	}

	return 0;
}

1568
static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1569
{
1570 1571
	char linkname[PATH_MAX];
	char *build_id_filename;
1572
	char *build_id_path = NULL;
1573
	char *pos;
1574

1575 1576
	if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
	    !dso__is_kcore(dso))
1577
		return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1578

1579
	build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1580 1581 1582
	if (build_id_filename) {
		__symbol__join_symfs(filename, filename_size, build_id_filename);
		free(build_id_filename);
1583
	} else {
1584 1585
		if (dso->has_build_id)
			return ENOMEM;
1586
		goto fallback;
1587 1588
	}

1589 1590 1591 1592
	build_id_path = strdup(filename);
	if (!build_id_path)
		return -1;

1593 1594 1595 1596 1597 1598 1599 1600
	/*
	 * old style build-id cache has name of XX/XXXXXXX.. while
	 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
	 * extract the build-id part of dirname in the new style only.
	 */
	pos = strrchr(build_id_path, '/');
	if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
		dirname(build_id_path);
1601

1602
	if (dso__is_kcore(dso) ||
1603
	    readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1604 1605
	    strstr(linkname, DSO__NAME_KALLSYMS) ||
	    access(filename, R_OK)) {
1606 1607 1608 1609 1610 1611
fallback:
		/*
		 * If we don't have build-ids or the build-id file isn't in the
		 * cache, or is just a kallsyms file, well, lets hope that this
		 * DSO is the same as when 'perf record' ran.
		 */
1612
		__symbol__join_symfs(filename, filename_size, dso->long_name);
1613 1614
	}

1615
	free(build_id_path);
1616 1617 1618
	return 0;
}

1619
static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1620
{
1621
	struct annotation_options *opts = args->options;
1622
	struct map *map = args->ms.map;
1623
	struct dso *dso = map->dso;
1624
	char *command;
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
	FILE *file;
	char symfs_filename[PATH_MAX];
	struct kcore_extract kce;
	bool delete_extract = false;
	int stdout_fd[2];
	int lineno = 0;
	int nline;
	pid_t pid;
	int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));

	if (err)
		return err;

1638
	pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1639
		 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1640 1641 1642 1643 1644
		 map->unmap_ip(map, sym->end));

	pr_debug("annotating [%p] %30s : [%p] %30s\n",
		 dso, dso->long_name, sym, sym->name);

1645 1646 1647 1648
	if (dso__is_kcore(dso)) {
		kce.kcore_filename = symfs_filename;
		kce.addr = map__rip_2objdump(map, sym->start);
		kce.offs = sym->start;
1649
		kce.len = sym->end - sym->start;
1650 1651 1652 1653 1654
		if (!kcore_extract__create(&kce)) {
			delete_extract = true;
			strlcpy(symfs_filename, kce.extract_filename,
				sizeof(symfs_filename));
		}
1655
	} else if (dso__needs_decompress(dso)) {
1656
		char tmp[KMOD_DECOMP_LEN];
1657

1658 1659
		if (dso__decompress_kmodule_path(dso, symfs_filename,
						 tmp, sizeof(tmp)) < 0)
1660
			goto out;
1661 1662

		strcpy(symfs_filename, tmp);
1663 1664
	}

1665
	err = asprintf(&command,
1666
		 "%s %s%s --start-address=0x%016" PRIx64
1667
		 " --stop-address=0x%016" PRIx64
1668
		 " -l -d %s %s -C \"%s\" 2>/dev/null|grep -v \"%s:\"|expand",
1669
		 opts->objdump_path ?: "objdump",
1670 1671
		 opts->disassembler_style ? "-M " : "",
		 opts->disassembler_style ?: "",
1672
		 map__rip_2objdump(map, sym->start),
1673
		 map__rip_2objdump(map, sym->end),
1674 1675
		 opts->show_asm_raw ? "" : "--no-show-raw",
		 opts->annotate_src ? "-S" : "",
1676
		 symfs_filename, symfs_filename);
1677

1678 1679 1680 1681 1682
	if (err < 0) {
		pr_err("Failure allocating memory for the command to run\n");
		goto out_remove_tmp;
	}

1683 1684
	pr_debug("Executing: %s\n", command);

1685 1686 1687
	err = -1;
	if (pipe(stdout_fd) < 0) {
		pr_err("Failure creating the pipe to run %s\n", command);
1688
		goto out_free_command;
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
	}

	pid = fork();
	if (pid < 0) {
		pr_err("Failure forking to run %s\n", command);
		goto out_close_stdout;
	}

	if (pid == 0) {
		close(stdout_fd[0]);
		dup2(stdout_fd[1], 1);
		close(stdout_fd[1]);
		execl("/bin/sh", "sh", "-c", command, NULL);
		perror(command);
		exit(-1);
	}

	close(stdout_fd[1]);

	file = fdopen(stdout_fd[0], "r");
1709
	if (!file) {
1710
		pr_err("Failure creating FILE stream for %s\n", command);
1711 1712 1713 1714
		/*
		 * If we were using debug info should retry with
		 * original binary.
		 */
1715
		goto out_free_command;
1716
	}
1717

1718 1719
	nline = 0;
	while (!feof(file)) {
1720 1721 1722 1723 1724 1725
		/*
		 * The source code line number (lineno) needs to be kept in
		 * accross calls to symbol__parse_objdump_line(), so that it
		 * can associate it with the instructions till the next one.
		 * See disasm_line__new() and struct disasm_line::line_nr.
		 */
1726
		if (symbol__parse_objdump_line(sym, file, args, &lineno) < 0)
1727
			break;
1728 1729 1730 1731 1732
		nline++;
	}

	if (nline == 0)
		pr_err("No output from %s\n", command);
1733

1734 1735 1736 1737 1738 1739 1740
	/*
	 * kallsyms does not have symbol sizes so there may a nop at the end.
	 * Remove it.
	 */
	if (dso__is_kcore(dso))
		delete_last_nop(sym);

1741 1742
	fclose(file);
	err = 0;
1743 1744
out_free_command:
	free(command);
1745
out_remove_tmp:
1746 1747
	close(stdout_fd[0]);

1748 1749
	if (dso__needs_decompress(dso))
		unlink(symfs_filename);
1750

1751 1752
	if (delete_extract)
		kcore_extract__delete(&kce);
1753
out:
1754
	return err;
1755 1756 1757

out_close_stdout:
	close(stdout_fd[1]);
1758
	goto out_free_command;
1759 1760
}

1761
static void calc_percent(struct sym_hist *sym_hist,
1762
			 struct hists *hists,
1763
			 struct annotation_data *data,
1764 1765 1766 1767 1768 1769
			 s64 offset, s64 end)
{
	unsigned int hits = 0;
	u64 period = 0;

	while (offset < end) {
1770 1771
		hits   += sym_hist->addr[offset].nr_samples;
		period += sym_hist->addr[offset].period;
1772 1773 1774
		++offset;
	}

1775
	if (sym_hist->nr_samples) {
1776 1777
		data->he.period     = period;
		data->he.nr_samples = hits;
1778
		data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
1779
	}
1780 1781 1782 1783

	if (hists->stats.nr_non_filtered_samples)
		data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;

1784 1785
}

1786
static void annotation__calc_percent(struct annotation *notes,
1787
				     struct perf_evsel *leader, s64 len)
1788 1789
{
	struct annotation_line *al, *next;
1790
	struct perf_evsel *evsel;
1791 1792 1793

	list_for_each_entry(al, &notes->src->source, node) {
		s64 end;
1794
		int i = 0;
1795 1796 1797 1798 1799 1800 1801

		if (al->offset == -1)
			continue;

		next = annotation_line__next(al, &notes->src->source);
		end  = next ? next->offset : len;

1802
		for_each_group_evsel(evsel, leader) {
1803
			struct hists *hists = evsel__hists(evsel);
1804
			struct annotation_data *data;
1805
			struct sym_hist *sym_hist;
1806

1807 1808 1809 1810
			BUG_ON(i >= al->data_nr);

			sym_hist = annotation__histogram(notes, evsel->idx);
			data = &al->data[i++];
1811

1812
			calc_percent(sym_hist, hists, data, al->offset, end);
1813 1814 1815 1816
		}
	}
}

1817
void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel)
1818 1819 1820
{
	struct annotation *notes = symbol__annotation(sym);

1821
	annotation__calc_percent(notes, evsel, symbol__size(sym));
1822 1823
}

1824
int symbol__annotate(struct symbol *sym, struct map *map,
1825
		     struct perf_evsel *evsel, size_t privsize,
1826
		     struct annotation_options *options,
1827
		     struct arch **parch)
1828
{
1829 1830
	struct annotate_args args = {
		.privsize	= privsize,
1831
		.evsel		= evsel,
1832
		.options	= options,
1833
	};
1834
	struct perf_env *env = perf_evsel__env(evsel);
1835
	const char *arch_name = perf_env__arch(env);
1836 1837 1838 1839 1840 1841
	struct arch *arch;
	int err;

	if (!arch_name)
		return -1;

1842
	args.arch = arch = arch__find(arch_name);
1843 1844 1845 1846 1847 1848 1849
	if (arch == NULL)
		return -ENOTSUP;

	if (parch)
		*parch = arch;

	if (arch->init) {
1850
		err = arch->init(arch, env ? env->cpuid : NULL);
1851 1852 1853 1854 1855 1856
		if (err) {
			pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
			return err;
		}
	}

1857 1858 1859
	args.ms.map = map;
	args.ms.sym = sym;

1860
	return symbol__disassemble(sym, &args);
1861 1862
}

1863
static void insert_source_line(struct rb_root *root, struct annotation_line *al)
1864
{
1865
	struct annotation_line *iter;
1866 1867
	struct rb_node **p = &root->rb_node;
	struct rb_node *parent = NULL;
1868
	int i, ret;
1869 1870 1871

	while (*p != NULL) {
		parent = *p;
1872
		iter = rb_entry(parent, struct annotation_line, rb_node);
1873

1874
		ret = strcmp(iter->path, al->path);
1875
		if (ret == 0) {
1876 1877 1878 1879
			for (i = 0; i < al->data_nr; i++) {
				iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
										      PERCENT_HITS_LOCAL);
			}
1880 1881 1882 1883 1884 1885 1886 1887 1888
			return;
		}

		if (ret < 0)
			p = &(*p)->rb_left;
		else
			p = &(*p)->rb_right;
	}

1889 1890 1891 1892
	for (i = 0; i < al->data_nr; i++) {
		al->data[i].percent_sum = annotation_data__percent(&al->data[i],
								   PERCENT_HITS_LOCAL);
	}
1893

1894 1895
	rb_link_node(&al->rb_node, parent, p);
	rb_insert_color(&al->rb_node, root);
1896 1897
}

1898
static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
1899 1900 1901
{
	int i;

1902 1903
	for (i = 0; i < a->data_nr; i++) {
		if (a->data[i].percent_sum == b->data[i].percent_sum)
1904
			continue;
1905
		return a->data[i].percent_sum > b->data[i].percent_sum;
1906 1907 1908 1909 1910
	}

	return 0;
}

1911
static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
1912
{
1913
	struct annotation_line *iter;
1914 1915 1916 1917 1918
	struct rb_node **p = &root->rb_node;
	struct rb_node *parent = NULL;

	while (*p != NULL) {
		parent = *p;
1919
		iter = rb_entry(parent, struct annotation_line, rb_node);
1920

1921
		if (cmp_source_line(al, iter))
1922 1923 1924 1925 1926
			p = &(*p)->rb_left;
		else
			p = &(*p)->rb_right;
	}

1927 1928
	rb_link_node(&al->rb_node, parent, p);
	rb_insert_color(&al->rb_node, root);
1929 1930
}

1931 1932
static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
{
1933
	struct annotation_line *al;
1934 1935 1936 1937 1938 1939
	struct rb_node *node;

	node = rb_first(src_root);
	while (node) {
		struct rb_node *next;

1940
		al = rb_entry(node, struct annotation_line, rb_node);
1941 1942 1943
		next = rb_next(node);
		rb_erase(node, src_root);

1944
		__resort_source_line(dest_root, al);
1945 1946 1947 1948
		node = next;
	}
}

1949 1950
static void print_summary(struct rb_root *root, const char *filename)
{
1951
	struct annotation_line *al;
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
	struct rb_node *node;

	printf("\nSorted summary for file %s\n", filename);
	printf("----------------------------------------------\n\n");

	if (RB_EMPTY_ROOT(root)) {
		printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
		return;
	}

	node = rb_first(root);
	while (node) {
1964
		double percent, percent_max = 0.0;
1965 1966
		const char *color;
		char *path;
1967
		int i;
1968

1969
		al = rb_entry(node, struct annotation_line, rb_node);
1970 1971
		for (i = 0; i < al->data_nr; i++) {
			percent = al->data[i].percent_sum;
1972 1973 1974 1975 1976 1977 1978
			color = get_percent_color(percent);
			color_fprintf(stdout, color, " %7.2f", percent);

			if (percent > percent_max)
				percent_max = percent;
		}

1979
		path = al->path;
1980
		color = get_percent_color(percent_max);
1981
		color_fprintf(stdout, color, " %s\n", path);
1982 1983 1984 1985 1986

		node = rb_next(node);
	}
}

1987
static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1988 1989
{
	struct annotation *notes = symbol__annotation(sym);
1990
	struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1991
	u64 len = symbol__size(sym), offset;
1992 1993

	for (offset = 0; offset < len; ++offset)
1994
		if (h->addr[offset].nr_samples != 0)
1995
			printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1996
			       sym->start + offset, h->addr[offset].nr_samples);
1997
	printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
1998 1999
}

2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
{
	char bf[32];
	struct annotation_line *line;

	list_for_each_entry_reverse(line, lines, node) {
		if (line->offset != -1)
			return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
	}

	return 0;
}

2013
int symbol__annotate_printf(struct symbol *sym, struct map *map,
2014 2015
			    struct perf_evsel *evsel,
			    struct annotation_options *opts)
2016 2017
{
	struct dso *dso = map->dso;
2018 2019
	char *filename;
	const char *d_filename;
2020
	const char *evsel_name = perf_evsel__name(evsel);
2021
	struct annotation *notes = symbol__annotation(sym);
2022
	struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2023
	struct annotation_line *pos, *queue = NULL;
2024
	u64 start = map__rip_2objdump(map, sym->start);
2025
	int printed = 2, queue_len = 0, addr_fmt_width;
2026
	int more = 0;
2027
	bool context = opts->context;
2028
	u64 len;
2029
	int width = symbol_conf.show_total_period ? 12 : 8;
2030
	int graph_dotted_len;
2031
	char buf[512];
2032

2033 2034 2035 2036
	filename = strdup(dso->long_name);
	if (!filename)
		return -ENOMEM;

2037
	if (opts->full_path)
2038 2039 2040 2041
		d_filename = filename;
	else
		d_filename = basename(filename);

2042
	len = symbol__size(sym);
2043

2044
	if (perf_evsel__is_group_event(evsel)) {
2045
		width *= evsel->nr_members;
2046 2047 2048
		perf_evsel__group_desc(evsel, buf, sizeof(buf));
		evsel_name = buf;
	}
2049

2050
	graph_dotted_len = printf(" %-*.*s|	Source code & Disassembly of %s for %s (%" PRIu64 " samples)\n",
2051 2052
				  width, width, symbol_conf.show_total_period ? "Period" :
				  symbol_conf.show_nr_samples ? "Samples" : "Percent",
2053
				  d_filename, evsel_name, h->nr_samples);
2054

2055
	printf("%-*.*s----\n",
2056
	       graph_dotted_len, graph_dotted_len, graph_dotted_line);
2057

2058
	if (verbose > 0)
2059
		symbol__annotate_hits(sym, evsel);
2060

2061 2062
	addr_fmt_width = annotated_source__addr_fmt_width(&notes->src->source, start);

2063 2064 2065
	list_for_each_entry(pos, &notes->src->source, node) {
		int err;

2066 2067 2068 2069 2070
		if (context && queue == NULL) {
			queue = pos;
			queue_len = 0;
		}

2071
		err = annotation_line__print(pos, sym, start, evsel, len,
2072
					     opts->min_pcnt, printed, opts->max_lines,
2073
					     queue, addr_fmt_width);
2074 2075

		switch (err) {
2076 2077
		case 0:
			++printed;
2078 2079 2080 2081 2082
			if (context) {
				printed += queue_len;
				queue = NULL;
				queue_len = 0;
			}
2083 2084 2085 2086
			break;
		case 1:
			/* filtered by max_lines */
			++more;
2087
			break;
2088 2089
		case -1:
		default:
2090 2091 2092 2093 2094 2095 2096
			/*
			 * Filtered by min_pcnt or non IP lines when
			 * context != 0
			 */
			if (!context)
				break;
			if (queue_len == context)
2097
				queue = list_entry(queue->node.next, typeof(*queue), node);
2098 2099
			else
				++queue_len;
2100 2101 2102 2103
			break;
		}
	}

2104 2105
	free(filename);

2106 2107
	return more;
}
2108

2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149
static void FILE__set_percent_color(void *fp __maybe_unused,
				    double percent __maybe_unused,
				    bool current __maybe_unused)
{
}

static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
					 int nr __maybe_unused, bool current __maybe_unused)
{
	return 0;
}

static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
{
	return 0;
}

static void FILE__printf(void *fp, const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	vfprintf(fp, fmt, args);
	va_end(args);
}

static void FILE__write_graph(void *fp, int graph)
{
	const char *s;
	switch (graph) {

	case DARROW_CHAR: s = "↓"; break;
	case UARROW_CHAR: s = "↑"; break;
	case LARROW_CHAR: s = "←"; break;
	case RARROW_CHAR: s = "→"; break;
	default:		s = "?"; break;
	}

	fputs(s, fp);
}

2150
static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp)
2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
{
	struct annotation *notes = symbol__annotation(sym);
	struct annotation_write_ops ops = {
		.first_line		 = true,
		.obj			 = fp,
		.set_color		 = FILE__set_color,
		.set_percent_color	 = FILE__set_percent_color,
		.set_jumps_percent_color = FILE__set_jumps_percent_color,
		.printf			 = FILE__printf,
		.write_graph		 = FILE__write_graph,
	};
	struct annotation_line *al;

	list_for_each_entry(al, &notes->src->source, node) {
		if (annotation_line__filter(al, notes))
			continue;
		annotation_line__write(al, notes, &ops);
		fputc('\n', fp);
		ops.first_line = false;
	}

	return 0;
}

2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel)
{
	const char *ev_name = perf_evsel__name(evsel);
	char buf[1024];
	char *filename;
	int err = -1;
	FILE *fp;

	if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
		return -1;

	fp = fopen(filename, "w");
	if (fp == NULL)
		goto out_free_filename;

	if (perf_evsel__is_group_event(evsel)) {
		perf_evsel__group_desc(evsel, buf, sizeof(buf));
		ev_name = buf;
	}

	fprintf(fp, "%s() %s\nEvent: %s\n\n",
		ms->sym->name, ms->map->dso->long_name, ev_name);
	symbol__annotate_fprintf2(ms->sym, fp);

	fclose(fp);
	err = 0;
out_free_filename:
	free(filename);
	return err;
}

2206 2207 2208 2209 2210
void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
{
	struct annotation *notes = symbol__annotation(sym);
	struct sym_hist *h = annotation__histogram(notes, evidx);

2211
	memset(h, 0, notes->src->sizeof_sym_hist);
2212 2213
}

2214
void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2215 2216 2217
{
	struct annotation *notes = symbol__annotation(sym);
	struct sym_hist *h = annotation__histogram(notes, evidx);
2218
	int len = symbol__size(sym), offset;
2219

2220
	h->nr_samples = 0;
2221
	for (offset = 0; offset < len; ++offset) {
2222
		h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2223
		h->nr_samples += h->addr[offset].nr_samples;
2224 2225 2226
	}
}

2227
void annotated_source__purge(struct annotated_source *as)
2228
{
2229
	struct annotation_line *al, *n;
2230

2231 2232 2233
	list_for_each_entry_safe(al, n, &as->source, node) {
		list_del(&al->node);
		disasm_line__free(disasm_line(al));
2234 2235 2236
	}
}

2237 2238 2239 2240
static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
{
	size_t printed;

2241 2242
	if (dl->al.offset == -1)
		return fprintf(fp, "%s\n", dl->al.line);
2243

2244
	printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2245

2246
	if (dl->ops.raw[0] != '\0') {
2247
		printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2248
				   dl->ops.raw);
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
	}

	return printed + fprintf(fp, "\n");
}

size_t disasm__fprintf(struct list_head *head, FILE *fp)
{
	struct disasm_line *pos;
	size_t printed = 0;

2259
	list_for_each_entry(pos, head, al.node)
2260 2261 2262 2263 2264
		printed += disasm_line__fprintf(pos, fp);

	return printed;
}

2265
bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2266 2267
{
	if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2268
	    !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288
	    dl->ops.target.offset >= (s64)symbol__size(sym))
		return false;

	return true;
}

void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
{
	u64 offset, size = symbol__size(sym);

	/* PLT symbols contain external offsets */
	if (strstr(sym->name, "@plt"))
		return;

	for (offset = 0; offset < size; ++offset) {
		struct annotation_line *al = notes->offsets[offset];
		struct disasm_line *dl;

		dl = disasm_line(al);

2289
		if (!disasm_line__is_valid_local_jump(dl, sym))
2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
			continue;

		al = notes->offsets[dl->ops.target.offset];

		/*
		 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
		 * have to adjust to the previous offset?
		 */
		if (al == NULL)
			continue;

		if (++al->jump_sources > notes->max_jump_sources)
			notes->max_jump_sources = al->jump_sources;

		++notes->nr_jumps;
	}
}

2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335
void annotation__set_offsets(struct annotation *notes, s64 size)
{
	struct annotation_line *al;

	notes->max_line_len = 0;

	list_for_each_entry(al, &notes->src->source, node) {
		size_t line_len = strlen(al->line);

		if (notes->max_line_len < line_len)
			notes->max_line_len = line_len;
		al->idx = notes->nr_entries++;
		if (al->offset != -1) {
			al->idx_asm = notes->nr_asm_entries++;
			/*
			 * FIXME: short term bandaid to cope with assembly
			 * routines that comes with labels in the same column
			 * as the address in objdump, sigh.
			 *
			 * E.g. copy_user_generic_unrolled
 			 */
			if (al->offset < size)
				notes->offsets[al->offset] = al;
		} else
			al->idx_asm = -1;
	}
}

2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
static inline int width_jumps(int n)
{
	if (n >= 100)
		return 5;
	if (n / 10)
		return 2;
	return 1;
}

void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
{
	notes->widths.addr = notes->widths.target =
		notes->widths.min_addr = hex_width(symbol__size(sym));
	notes->widths.max_addr = hex_width(sym->end);
	notes->widths.jumps = width_jumps(notes->max_jump_sources);
}

2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365
void annotation__update_column_widths(struct annotation *notes)
{
	if (notes->options->use_offset)
		notes->widths.target = notes->widths.min_addr;
	else
		notes->widths.target = notes->widths.max_addr;

	notes->widths.addr = notes->widths.target;

	if (notes->options->show_nr_jumps)
		notes->widths.addr += notes->widths.jumps + 1;
}

2366
static void annotation__calc_lines(struct annotation *notes, struct map *map,
2367
				  struct rb_root *root)
2368 2369 2370 2371 2372 2373 2374 2375
{
	struct annotation_line *al;
	struct rb_root tmp_root = RB_ROOT;

	list_for_each_entry(al, &notes->src->source, node) {
		double percent_max = 0.0;
		int i;

2376
		for (i = 0; i < al->data_nr; i++) {
2377
			double percent;
2378

2379 2380
			percent = annotation_data__percent(&al->data[i],
							   PERCENT_HITS_LOCAL);
2381

2382 2383
			if (percent > percent_max)
				percent_max = percent;
2384 2385 2386 2387 2388
		}

		if (percent_max <= 0.5)
			continue;

2389 2390
		al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
				       false, true, notes->start + al->offset);
2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401
		insert_source_line(&tmp_root, al);
	}

	resort_source_line(root, &tmp_root);
}

static void symbol__calc_lines(struct symbol *sym, struct map *map,
			      struct rb_root *root)
{
	struct annotation *notes = symbol__annotation(sym);

2402
	annotation__calc_lines(notes, map, root);
2403 2404
}

2405
int symbol__tty_annotate2(struct symbol *sym, struct map *map,
2406 2407
			  struct perf_evsel *evsel,
			  struct annotation_options *opts)
2408 2409 2410
{
	struct dso *dso = map->dso;
	struct rb_root source_line = RB_ROOT;
2411
	struct hists *hists = evsel__hists(evsel);
2412
	char buf[1024];
2413

2414
	if (symbol__annotate2(sym, map, evsel, opts, NULL) < 0)
2415 2416
		return -1;

2417 2418
	if (opts->print_lines) {
		srcline_full_filename = opts->full_path;
2419 2420 2421 2422
		symbol__calc_lines(sym, map, &source_line);
		print_summary(&source_line, dso->long_name);
	}

2423
	hists__scnprintf_title(hists, buf, sizeof(buf));
2424
	fprintf(stdout, "%s\n%s() %s\n", buf, sym->name, dso->long_name);
2425 2426 2427 2428 2429 2430 2431
	symbol__annotate_fprintf2(sym, stdout);

	annotated_source__purge(symbol__annotation(sym)->src);

	return 0;
}

2432
int symbol__tty_annotate(struct symbol *sym, struct map *map,
2433 2434
			 struct perf_evsel *evsel,
			 struct annotation_options *opts)
2435 2436 2437 2438
{
	struct dso *dso = map->dso;
	struct rb_root source_line = RB_ROOT;

2439
	if (symbol__annotate(sym, map, evsel, 0, opts, NULL) < 0)
2440 2441
		return -1;

2442 2443
	symbol__calc_percent(sym, evsel);

2444 2445
	if (opts->print_lines) {
		srcline_full_filename = opts->full_path;
2446
		symbol__calc_lines(sym, map, &source_line);
2447
		print_summary(&source_line, dso->long_name);
2448 2449
	}

2450
	symbol__annotate_printf(sym, map, evsel, opts);
2451

2452
	annotated_source__purge(symbol__annotation(sym)->src);
2453

2454 2455
	return 0;
}
2456

2457 2458
bool ui__has_annotation(void)
{
2459
	return use_browser == 1 && perf_hpp_list.sym;
2460
}
2461

2462

2463 2464
static double annotation_line__max_percent(struct annotation_line *al,
					   struct annotation *notes)
2465 2466 2467 2468 2469
{
	double percent_max = 0.0;
	int i;

	for (i = 0; i < notes->nr_events; i++) {
2470 2471 2472 2473 2474 2475 2476
		double percent;

		percent = annotation_data__percent(&al->data[i],
						   PERCENT_HITS_LOCAL);

		if (percent > percent_max)
			percent_max = percent;
2477 2478 2479 2480 2481
	}

	return percent_max;
}

2482 2483 2484 2485 2486 2487 2488
static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
			       void *obj, char *bf, size_t size,
			       void (*obj__printf)(void *obj, const char *fmt, ...),
			       void (*obj__write_graph)(void *obj, int graph))
{
	if (dl->ins.ops && dl->ins.ops->scnprintf) {
		if (ins__is_jump(&dl->ins)) {
2489
			bool fwd;
2490

2491 2492 2493
			if (dl->ops.target.outside)
				goto call_like;
			fwd = dl->ops.target.offset > dl->al.offset;
2494 2495 2496
			obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
			obj__printf(obj, " ");
		} else if (ins__is_call(&dl->ins)) {
2497
call_like:
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
			obj__write_graph(obj, RARROW_CHAR);
			obj__printf(obj, " ");
		} else if (ins__is_ret(&dl->ins)) {
			obj__write_graph(obj, LARROW_CHAR);
			obj__printf(obj, " ");
		} else {
			obj__printf(obj, "  ");
		}
	} else {
		obj__printf(obj, "  ");
	}

	disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset);
}

2513 2514 2515 2516 2517 2518 2519 2520 2521
static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
				     bool first_line, bool current_entry, bool change_color, int width,
				     void *obj,
				     int  (*obj__set_color)(void *obj, int color),
				     void (*obj__set_percent_color)(void *obj, double percent, bool current),
				     int  (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
				     void (*obj__printf)(void *obj, const char *fmt, ...),
				     void (*obj__write_graph)(void *obj, int graph))

2522 2523
{
	double percent_max = annotation_line__max_percent(al, notes);
2524 2525
	int pcnt_width = annotation__pcnt_width(notes),
	    cycles_width = annotation__cycles_width(notes);
2526
	bool show_title = false;
2527 2528
	char bf[256];
	int printed;
2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541

	if (first_line && (al->offset == -1 || percent_max == 0.0)) {
		if (notes->have_cycles) {
			if (al->ipc == 0.0 && al->cycles == 0)
				show_title = true;
		} else
			show_title = true;
	}

	if (al->offset != -1 && percent_max != 0.0) {
		int i;

		for (i = 0; i < notes->nr_events; i++) {
2542 2543 2544 2545 2546 2547
			double percent;

			percent = annotation_data__percent(&al->data[i],
							   PERCENT_HITS_LOCAL);

			obj__set_percent_color(obj, percent, current_entry);
2548
			if (notes->options->show_total_period) {
2549
				obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2550 2551
			} else if (notes->options->show_nr_samples) {
				obj__printf(obj, "%6" PRIu64 " ",
2552
						   al->data[i].he.nr_samples);
2553
			} else {
2554
				obj__printf(obj, "%6.2f ", percent);
2555 2556 2557 2558 2559 2560
			}
		}
	} else {
		obj__set_percent_color(obj, 0, current_entry);

		if (!show_title)
2561
			obj__printf(obj, "%-*s", pcnt_width, " ");
2562
		else {
2563
			obj__printf(obj, "%-*s", pcnt_width,
2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
					   notes->options->show_total_period ? "Period" :
					   notes->options->show_nr_samples ? "Samples" : "Percent");
		}
	}

	if (notes->have_cycles) {
		if (al->ipc)
			obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
		else if (!show_title)
			obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
		else
			obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");

2577 2578 2579
		if (!notes->options->show_minmax_cycle) {
			if (al->cycles)
				obj__printf(obj, "%*" PRIu64 " ",
2580
					   ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
			else if (!show_title)
				obj__printf(obj, "%*s",
					    ANNOTATION__CYCLES_WIDTH, " ");
			else
				obj__printf(obj, "%*s ",
					    ANNOTATION__CYCLES_WIDTH - 1,
					    "Cycle");
		} else {
			if (al->cycles) {
				char str[32];

				scnprintf(str, sizeof(str),
					"%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
					al->cycles, al->cycles_min,
					al->cycles_max);

				obj__printf(obj, "%*s ",
					    ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
					    str);
			} else if (!show_title)
				obj__printf(obj, "%*s",
					    ANNOTATION__MINMAX_CYCLES_WIDTH,
					    " ");
			else
				obj__printf(obj, "%*s ",
					    ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
					    "Cycle(min/max)");
		}
2609 2610 2611
	}

	obj__printf(obj, " ");
2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631

	if (!*al->line)
		obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
	else if (al->offset == -1) {
		if (al->line_nr && notes->options->show_linenr)
			printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
		else
			printed = scnprintf(bf, sizeof(bf), "%-*s  ", notes->widths.addr, " ");
		obj__printf(obj, bf);
		obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
	} else {
		u64 addr = al->offset;
		int color = -1;

		if (!notes->options->use_offset)
			addr += notes->start;

		if (!notes->options->use_offset) {
			printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
		} else {
2632 2633
			if (al->jump_sources &&
			    notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643
				if (notes->options->show_nr_jumps) {
					int prev;
					printed = scnprintf(bf, sizeof(bf), "%*d ",
							    notes->widths.jumps,
							    al->jump_sources);
					prev = obj__set_jumps_percent_color(obj, al->jump_sources,
									    current_entry);
					obj__printf(obj, bf);
					obj__set_color(obj, prev);
				}
2644
print_addr:
2645 2646
				printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
						    notes->widths.target, addr);
2647 2648 2649 2650 2651
			} else if (ins__is_call(&disasm_line(al)->ins) &&
				   notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
				goto print_addr;
			} else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
				goto print_addr;
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668
			} else {
				printed = scnprintf(bf, sizeof(bf), "%-*s  ",
						    notes->widths.addr, " ");
			}
		}

		if (change_color)
			color = obj__set_color(obj, HE_COLORSET_ADDR);
		obj__printf(obj, bf);
		if (change_color)
			obj__set_color(obj, color);

		disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);

		obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
	}

2669 2670
}

2671 2672 2673 2674 2675 2676 2677 2678 2679 2680
void annotation_line__write(struct annotation_line *al, struct annotation *notes,
			    struct annotation_write_ops *ops)
{
	__annotation_line__write(al, notes, ops->first_line, ops->current_entry,
				 ops->change_color, ops->width, ops->obj,
				 ops->set_color, ops->set_percent_color,
				 ops->set_jumps_percent_color, ops->printf,
				 ops->write_graph);
}

2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694
int symbol__annotate2(struct symbol *sym, struct map *map, struct perf_evsel *evsel,
		      struct annotation_options *options, struct arch **parch)
{
	struct annotation *notes = symbol__annotation(sym);
	size_t size = symbol__size(sym);
	int nr_pcnt = 1, err;

	notes->offsets = zalloc(size * sizeof(struct annotation_line *));
	if (notes->offsets == NULL)
		return -1;

	if (perf_evsel__is_group_event(evsel))
		nr_pcnt = evsel->nr_members;

2695
	err = symbol__annotate(sym, map, evsel, 0, options, parch);
2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718
	if (err)
		goto out_free_offsets;

	notes->options = options;

	symbol__calc_percent(sym, evsel);

	notes->start = map__rip_2objdump(map, sym->start);

	annotation__set_offsets(notes, size);
	annotation__mark_jump_targets(notes, sym);
	annotation__compute_ipc(notes, size);
	annotation__init_column_widths(notes, sym);
	notes->nr_events = nr_pcnt;

	annotation__update_column_widths(notes);

	return 0;

out_free_offsets:
	zfree(&notes->offsets);
	return -1;
}
2719 2720 2721 2722 2723 2724 2725 2726 2727

#define ANNOTATION__CFG(n) \
	{ .name = #n, .value = &annotation__default_options.n, }

/*
 * Keep the entries sorted, they are bsearch'ed
 */
static struct annotation_config {
	const char *name;
2728
	void *value;
2729 2730 2731
} annotation__configs[] = {
	ANNOTATION__CFG(hide_src_code),
	ANNOTATION__CFG(jump_arrows),
2732
	ANNOTATION__CFG(offset_level),
2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763
	ANNOTATION__CFG(show_linenr),
	ANNOTATION__CFG(show_nr_jumps),
	ANNOTATION__CFG(show_nr_samples),
	ANNOTATION__CFG(show_total_period),
	ANNOTATION__CFG(use_offset),
};

#undef ANNOTATION__CFG

static int annotation_config__cmp(const void *name, const void *cfgp)
{
	const struct annotation_config *cfg = cfgp;

	return strcmp(name, cfg->name);
}

static int annotation__config(const char *var, const char *value,
			    void *data __maybe_unused)
{
	struct annotation_config *cfg;
	const char *name;

	if (!strstarts(var, "annotate."))
		return 0;

	name = var + 9;
	cfg = bsearch(name, annotation__configs, ARRAY_SIZE(annotation__configs),
		      sizeof(struct annotation_config), annotation_config__cmp);

	if (cfg == NULL)
		pr_debug("%s variable unknown, ignoring...", var);
2764 2765 2766 2767 2768 2769 2770 2771 2772 2773
	else if (strcmp(var, "annotate.offset_level") == 0) {
		perf_config_int(cfg->value, name, value);

		if (*(int *)cfg->value > ANNOTATION__MAX_OFFSET_LEVEL)
			*(int *)cfg->value = ANNOTATION__MAX_OFFSET_LEVEL;
		else if (*(int *)cfg->value < ANNOTATION__MIN_OFFSET_LEVEL)
			*(int *)cfg->value = ANNOTATION__MIN_OFFSET_LEVEL;
	} else {
		*(bool *)cfg->value = perf_config_bool(name, value);
	}
2774 2775 2776 2777 2778 2779 2780 2781 2782 2783
	return 0;
}

void annotation_config__init(void)
{
	perf_config(annotation__config, NULL);

	annotation__default_options.show_total_period = symbol_conf.show_total_period;
	annotation__default_options.show_nr_samples   = symbol_conf.show_nr_samples;
}