annotate.c 43.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/*
 * 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)
 */

#include "util.h"
11 12
#include "ui/ui.h"
#include "sort.h"
13 14 15 16 17 18
#include "build-id.h"
#include "color.h"
#include "cache.h"
#include "symbol.h"
#include "debug.h"
#include "annotate.h"
19
#include "evsel.h"
20
#include "block-range.h"
21
#include "arch/common.h"
22
#include <regex.h>
23
#include <pthread.h>
24
#include <linux/bitops.h>
25
#include <sys/utsname.h>
26

27
const char 	*disassembler_style;
28
const char	*objdump_path;
29
static regex_t	 file_lineno;
30

31
static struct ins_ops *ins__find(struct arch *arch, const char *name);
32
static void ins__sort(struct arch *arch);
33
static int disasm_line__parse(char *line, const char **namep, char **rawp);
34

35 36
struct arch {
	const char	*name;
37 38
	struct ins	*instructions;
	size_t		nr_instructions;
39 40
	size_t		nr_instructions_allocated;
	struct ins_ops  *(*associate_instruction_ops)(struct arch *arch, const char *name);
41
	bool		sorted_instructions;
42 43 44
	bool		initialized;
	void		*priv;
	int		(*init)(struct arch *arch);
45 46
	struct		{
		char comment_char;
47
		char skip_functions_char;
48 49 50
	} objdump;
};

51 52 53 54 55 56 57 58
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;

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
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;
}

87
static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
{
	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;
}

107
#include "arch/arm/annotate/instructions.c"
K
Kim Phillips 已提交
108
#include "arch/arm64/annotate/instructions.c"
109
#include "arch/x86/annotate/instructions.c"
110
#include "arch/powerpc/annotate/instructions.c"
111

112 113 114
static struct arch architectures[] = {
	{
		.name = "arm",
115
		.init = arm__annotate_init,
116
	},
K
Kim Phillips 已提交
117 118 119 120
	{
		.name = "arm64",
		.init = arm64__annotate_init,
	},
121 122
	{
		.name = "x86",
123 124
		.instructions = x86__instructions,
		.nr_instructions = ARRAY_SIZE(x86__instructions),
125 126 127 128
		.objdump =  {
			.comment_char = '#',
		},
	},
129 130 131 132
	{
		.name = "powerpc",
		.init = powerpc__annotate_init,
	},
133 134
};

135 136
static void ins__delete(struct ins_operands *ops)
{
137 138
	if (ops == NULL)
		return;
139 140 141 142
	zfree(&ops->source.raw);
	zfree(&ops->source.name);
	zfree(&ops->target.raw);
	zfree(&ops->target.name);
143 144
}

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
			      struct ins_operands *ops)
{
	return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->raw);
}

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);
}

160
static int call__parse(struct arch *arch, struct ins_operands *ops, struct map *map)
161
{
162 163
	char *endptr, *tok, *name;

164
	ops->target.addr = strtoull(ops->raw, &endptr, 16);
165 166 167 168 169 170 171

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

	name++;

172 173
	if (arch->objdump.skip_functions_char &&
	    strchr(name, arch->objdump.skip_functions_char))
R
Russell King 已提交
174 175
		return -1;

176 177 178 179 180
	tok = strchr(name, '>');
	if (tok == NULL)
		return -1;

	*tok = '\0';
181
	ops->target.name = strdup(name);
182 183
	*tok = '>';

184
	return ops->target.name == NULL ? -1 : 0;
185 186

indirect_call:
187 188
	tok = strchr(endptr, '*');
	if (tok == NULL) {
189 190 191 192 193
		struct symbol *sym = map__find_symbol(map, map->map_ip(map, ops->target.addr));
		if (sym != NULL)
			ops->target.name = strdup(sym->name);
		else
			ops->target.addr = 0;
194 195 196
		return 0;
	}

197
	ops->target.addr = strtoull(tok + 1, NULL, 16);
198 199 200
	return 0;
}

201
static int call__scnprintf(struct ins *ins, char *bf, size_t size,
202
			   struct ins_operands *ops)
203
{
204 205
	if (ops->target.name)
		return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
206

207 208 209
	if (ops->target.addr == 0)
		return ins__raw_scnprintf(ins, bf, size, ops);

210
	return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
211 212
}

213
static struct ins_ops call_ops = {
214 215
	.parse	   = call__parse,
	.scnprintf = call__scnprintf,
216 217 218 219 220 221 222
};

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

223
static int jump__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map *map __maybe_unused)
224
{
225
	const char *s = strchr(ops->raw, '+');
226

227
	ops->target.addr = strtoull(ops->raw, NULL, 16);
228 229

	if (s++ != NULL)
230
		ops->target.offset = strtoull(s, NULL, 16);
231 232
	else
		ops->target.offset = UINT64_MAX;
233 234 235 236

	return 0;
}

237
static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
238
			   struct ins_operands *ops)
239
{
240
	return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
241 242
}

243
static struct ins_ops jump_ops = {
244 245
	.parse	   = jump__parse,
	.scnprintf = jump__scnprintf,
246 247 248 249 250 251 252
};

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

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
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);
	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;
}

278
static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map *map)
279 280 281 282 283
{
	ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
	if (ops->locked.ops == NULL)
		return 0;

284
	if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
285 286
		goto out_free_ops;

287
	ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
288

289
	if (ops->locked.ins.ops == NULL)
N
Namhyung Kim 已提交
290
		goto out_free_ops;
291

292 293
	if (ops->locked.ins.ops->parse &&
	    ops->locked.ins.ops->parse(arch, ops->locked.ops, map) < 0)
294
		goto out_free_ops;
295 296 297 298

	return 0;

out_free_ops:
299
	zfree(&ops->locked.ops);
300 301 302 303 304 305 306 307
	return 0;
}

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

308
	if (ops->locked.ins.ops == NULL)
309 310 311
		return ins__raw_scnprintf(ins, bf, size, ops);

	printed = scnprintf(bf, size, "%-6.6s ", ins->name);
312
	return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
313 314 315
					size - printed, ops->locked.ops);
}

316 317
static void lock__delete(struct ins_operands *ops)
{
318
	struct ins *ins = &ops->locked.ins;
319

320
	if (ins->ops && ins->ops->free)
321 322 323 324
		ins->ops->free(ops->locked.ops);
	else
		ins__delete(ops->locked.ops);

325 326 327
	zfree(&ops->locked.ops);
	zfree(&ops->target.raw);
	zfree(&ops->target.name);
328 329
}

330
static struct ins_ops lock_ops = {
331
	.free	   = lock__delete,
332 333 334 335
	.parse	   = lock__parse,
	.scnprintf = lock__scnprintf,
};

336
static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map *map __maybe_unused)
337 338 339 340 341 342 343 344 345
{
	char *s = strchr(ops->raw, ','), *target, *comment, prev;

	if (s == NULL)
		return -1;

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

347 348 349 350
	if (ops->source.raw == NULL)
		return -1;

	target = ++s;
351
	comment = strchr(s, arch->objdump.comment_char);
352 353 354 355 356

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

358 359 360
	while (s > target && isspace(s[0]))
		--s;
	s++;
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
	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;

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

	comment__symbol(ops->source.raw, comment, &ops->source.addr, &ops->source.name);
	comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);

	return 0;

out_free_source:
382
	zfree(&ops->source.raw);
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
	return -1;
}

static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
			   struct ins_operands *ops)
{
	return scnprintf(bf, size, "%-6.6s %s,%s", ins->name,
			 ops->source.name ?: ops->source.raw,
			 ops->target.name ?: ops->target.raw);
}

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

399
static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map *map __maybe_unused)
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
{
	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;

416
	comment = strchr(s, arch->objdump.comment_char);
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
	if (comment == NULL)
		return 0;

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

	comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);

	return 0;
}

static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
			   struct ins_operands *ops)
{
	return scnprintf(bf, size, "%-6.6s %s", ins->name,
			 ops->target.name ?: ops->target.raw);
}

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

440 441
static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
			  struct ins_operands *ops __maybe_unused)
442 443 444 445 446 447 448 449
{
	return scnprintf(bf, size, "%-6.6s", "nop");
}

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

450 451 452 453 454 455 456 457 458
static struct ins_ops ret_ops = {
	.scnprintf = ins__raw_scnprintf,
};

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

459
static int ins__key_cmp(const void *name, const void *insp)
460 461 462 463 464 465
{
	const struct ins *ins = insp;

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

466 467 468 469 470 471 472 473
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);
}

474
static void ins__sort(struct arch *arch)
475
{
476
	const int nmemb = arch->nr_instructions;
477

478
	qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
479 480
}

481
static struct ins_ops *__ins__find(struct arch *arch, const char *name)
482
{
483
	struct ins *ins;
484
	const int nmemb = arch->nr_instructions;
485

486 487 488
	if (!arch->sorted_instructions) {
		ins__sort(arch);
		arch->sorted_instructions = true;
489
	}
490

491 492
	ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
	return ins ? ins->ops : NULL;
493 494
}

495 496 497 498 499 500 501 502 503 504
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;
}

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
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);
}

540
int symbol__alloc_hist(struct symbol *sym)
541 542
{
	struct annotation *notes = symbol__annotation(sym);
543
	const size_t size = symbol__size(sym);
544 545 546 547 548 549 550 551 552 553 554 555
	size_t sizeof_sym_hist;

	/* Check for overflow when calculating sizeof_sym_hist */
	if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(u64))
		return -1;

	sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(u64));

	/* Check for overflow in zalloc argument */
	if (sizeof_sym_hist > (SIZE_MAX - sizeof(*notes->src))
				/ symbol_conf.nr_events)
		return -1;
556

557
	notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
558 559 560
	if (notes->src == NULL)
		return -1;
	notes->src->sizeof_sym_hist = sizeof_sym_hist;
561
	notes->src->nr_histograms   = symbol_conf.nr_events;
562 563
	INIT_LIST_HEAD(&notes->src->source);
	return 0;
564 565
}

566 567 568 569 570 571 572 573 574 575 576 577
/* 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;
}

578 579 580 581
void symbol__annotate_zero_histograms(struct symbol *sym)
{
	struct annotation *notes = symbol__annotation(sym);

582
	pthread_mutex_lock(&notes->lock);
583
	if (notes->src != NULL) {
584 585
		memset(notes->src->histograms, 0,
		       notes->src->nr_histograms * notes->src->sizeof_sym_hist);
586 587 588 589
		if (notes->src->cycles_hist)
			memset(notes->src->cycles_hist, 0,
				symbol__size(sym) * sizeof(struct cyc_hist));
	}
590
	pthread_mutex_unlock(&notes->lock);
591 592
}

593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
static int __symbol__account_cycles(struct annotation *notes,
				    u64 start,
				    unsigned offset, unsigned cycles,
				    unsigned have_start)
{
	struct cyc_hist *ch;

	ch = notes->src->cycles_hist;
	/*
	 * 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;

	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;
}

633 634
static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
				      struct annotation *notes, int evidx, u64 addr)
635
{
636
	unsigned offset;
637 638 639 640
	struct sym_hist *h;

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

641 642 643
	if (addr < sym->start || addr >= sym->end) {
		pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
		       __func__, __LINE__, sym->name, sym->start, addr, sym->end);
644
		return -ERANGE;
645
	}
646

647 648
	offset = addr - sym->start;
	h = annotation__histogram(notes, evidx);
649 650 651 652
	h->sum++;
	h->addr[offset]++;

	pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
653 654
		  ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
		  addr, addr - sym->start, evidx, h->addr[offset]);
655 656 657
	return 0;
}

658
static struct annotation *symbol__get_annotation(struct symbol *sym, bool cycles)
659 660 661 662 663 664 665
{
	struct annotation *notes = symbol__annotation(sym);

	if (notes->src == NULL) {
		if (symbol__alloc_hist(sym) < 0)
			return NULL;
	}
666 667 668 669
	if (!notes->src->cycles_hist && cycles) {
		if (symbol__alloc_hist_cycles(sym) < 0)
			return NULL;
	}
670 671 672
	return notes;
}

673 674
static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
				    int evidx, u64 addr)
675 676 677
{
	struct annotation *notes;

678
	if (sym == NULL)
679
		return 0;
680
	notes = symbol__get_annotation(sym, false);
681 682
	if (notes == NULL)
		return -ENOMEM;
683 684 685
	return __symbol__inc_addr_samples(sym, map, notes, evidx, addr);
}

686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
static int symbol__account_cycles(u64 addr, u64 start,
				  struct symbol *sym, unsigned cycles)
{
	struct annotation *notes;
	unsigned offset;

	if (sym == NULL)
		return 0;
	notes = symbol__get_annotation(sym, true);
	if (notes == NULL)
		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;
	return __symbol__account_cycles(notes,
					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)
{
717
	u64 saddr = 0;
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
	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)
736
		pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
737 738 739 740 741 742 743 744 745 746
			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;
}

747 748 749 750 751
int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx)
{
	return symbol__inc_addr_samples(ams->sym, ams->map, evidx, ams->al_addr);
}

752 753 754 755 756
int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 ip)
{
	return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evidx, ip);
}

757
static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map *map)
758
{
759
	dl->ins.ops = ins__find(arch, dl->ins.name);
760

761
	if (!dl->ins.ops)
762 763
		return;

764 765
	if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, map) < 0)
		dl->ins.ops = NULL;
766 767
}

768
static int disasm_line__parse(char *line, const char **namep, char **rawp)
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
{
	char *name = line, tmp;

	while (isspace(name[0]))
		++name;

	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;

	if ((*rawp)[0] != '\0') {
		(*rawp)++;
		while (isspace((*rawp)[0]))
			++(*rawp);
	}

	return 0;

out_free_name:
801 802
	free((void *)namep);
	*namep = NULL;
803 804 805
	return -1;
}

806
static struct disasm_line *disasm_line__new(s64 offset, char *line,
807
					    size_t privsize, int line_nr,
808
					    struct arch *arch,
809
					    struct map *map)
810
{
811
	struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
812

813 814 815
	if (dl != NULL) {
		dl->offset = offset;
		dl->line = strdup(line);
816
		dl->line_nr = line_nr;
817
		if (dl->line == NULL)
818
			goto out_delete;
819 820

		if (offset != -1) {
821
			if (disasm_line__parse(dl->line, &dl->ins.name, &dl->ops.raw) < 0)
822 823
				goto out_free_line;

824
			disasm_line__init_ins(dl, arch, map);
825
		}
826 827
	}

828
	return dl;
829 830

out_free_line:
831
	zfree(&dl->line);
832
out_delete:
833
	free(dl);
834
	return NULL;
835 836
}

837
void disasm_line__free(struct disasm_line *dl)
838
{
839
	zfree(&dl->line);
840 841
	if (dl->ins.ops && dl->ins.ops->free)
		dl->ins.ops->free(&dl->ops);
842 843
	else
		ins__delete(&dl->ops);
844 845
	free((void *)dl->ins.name);
	dl->ins.name = NULL;
846
	free(dl);
847 848
}

849 850
int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
{
851 852
	if (raw || !dl->ins.ops)
		return scnprintf(bf, size, "%-6.6s %s", dl->ins.name, dl->ops.raw);
853

854
	return ins__scnprintf(&dl->ins, bf, size, &dl->ops);
855 856
}

857
static void disasm__add(struct list_head *head, struct disasm_line *line)
858 859 860 861
{
	list_add_tail(&line->node, head);
}

862
struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
863 864 865 866 867 868 869 870
{
	list_for_each_entry_continue(pos, head, node)
		if (pos->offset >= 0)
			return pos;

	return NULL;
}

871
double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
872
			    s64 end, const char **path, u64 *nr_samples)
873 874 875
{
	struct source_line *src_line = notes->src->lines;
	double percent = 0.0;
876
	*nr_samples = 0;
877

878
	if (src_line) {
879
		size_t sizeof_src_line = sizeof(*src_line) +
880
				sizeof(src_line->samples) * (src_line->nr_pcnt - 1);
881

882
		while (offset < end) {
883 884 885
			src_line = (void *)notes->src->lines +
					(sizeof_src_line * offset);

886
			if (*path == NULL)
887
				*path = src_line->path;
888

889 890
			percent += src_line->samples[evidx].percent;
			*nr_samples += src_line->samples[evidx].nr;
891
			offset++;
892 893
		}
	} else {
894 895 896
		struct sym_hist *h = annotation__histogram(notes, evidx);
		unsigned int hits = 0;

897 898
		while (offset < end)
			hits += h->addr[offset++];
899

900 901
		if (h->sum) {
			*nr_samples = hits;
902
			percent = 100.0 * hits / h->sum;
903
		}
904
	}
905 906 907 908

	return percent;
}

909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 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
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);
		}
	}
}


992
static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
993
		      struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
994
		      int max_lines, struct disasm_line *queue)
995 996 997 998
{
	static const char *prev_line;
	static const char *prev_color;

999
	if (dl->offset != -1) {
1000
		const char *path = NULL;
1001
		u64 nr_samples;
1002 1003
		double percent, max_percent = 0.0;
		double *ppercents = &percent;
1004
		u64 *psamples = &nr_samples;
1005
		int i, nr_percent = 1;
1006 1007
		const char *color;
		struct annotation *notes = symbol__annotation(sym);
1008
		s64 offset = dl->offset;
1009
		const u64 addr = start + offset;
1010
		struct disasm_line *next;
1011
		struct block_range *br;
1012

1013
		next = disasm__get_next_ip_line(&notes->src->source, dl);
1014

1015
		if (perf_evsel__is_group_event(evsel)) {
1016 1017
			nr_percent = evsel->nr_members;
			ppercents = calloc(nr_percent, sizeof(double));
1018 1019
			psamples = calloc(nr_percent, sizeof(u64));
			if (ppercents == NULL || psamples == NULL) {
1020
				return -1;
1021
			}
1022 1023 1024 1025
		}

		for (i = 0; i < nr_percent; i++) {
			percent = disasm__calc_percent(notes,
1026 1027 1028
					notes->src->lines ? i : evsel->idx + i,
					offset,
					next ? next->offset : (s64) len,
1029
					&path, &nr_samples);
1030 1031

			ppercents[i] = percent;
1032
			psamples[i] = nr_samples;
1033 1034 1035 1036 1037
			if (percent > max_percent)
				max_percent = percent;
		}

		if (max_percent < min_pcnt)
1038 1039
			return -1;

1040
		if (max_lines && printed >= max_lines)
1041
			return 1;
1042

1043 1044
		if (queue != NULL) {
			list_for_each_entry_from(queue, &notes->src->source, node) {
1045
				if (queue == dl)
1046
					break;
1047
				disasm_line__print(queue, sym, start, evsel, len,
1048 1049 1050 1051
						    0, 0, 1, NULL);
			}
		}

1052
		color = get_percent_color(max_percent);
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067

		/*
		 * 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
		 */
		if (path) {
			if (!prev_line || strcmp(prev_line, path)
				       || color != prev_color) {
				color_fprintf(stdout, color, " %s", path);
				prev_line = path;
				prev_color = color;
			}
		}

1068 1069
		for (i = 0; i < nr_percent; i++) {
			percent = ppercents[i];
1070
			nr_samples = psamples[i];
1071
			color = get_percent_color(percent);
1072 1073 1074 1075 1076 1077

			if (symbol_conf.show_total_period)
				color_fprintf(stdout, color, " %7" PRIu64,
					      nr_samples);
			else
				color_fprintf(stdout, color, " %7.2f", percent);
1078 1079
		}

1080
		printf(" :	");
1081 1082 1083 1084 1085 1086

		br = block_range__find(addr);
		color_fprintf(stdout, annotate__address_color(br), "  %" PRIx64 ":", addr);
		color_fprintf(stdout, annotate__asm_color(br), "%s", dl->line);
		annotate__branch_printf(br, addr);
		printf("\n");
1087 1088 1089 1090

		if (ppercents != &percent)
			free(ppercents);

1091 1092 1093
		if (psamples != &nr_samples)
			free(psamples);

1094
	} else if (max_lines && printed >= max_lines)
1095 1096
		return 1;
	else {
1097 1098
		int width = 8;

1099 1100 1101
		if (queue)
			return -1;

1102
		if (perf_evsel__is_group_event(evsel))
1103 1104
			width *= evsel->nr_members;

1105
		if (!*dl->line)
1106
			printf(" %*s:\n", width, " ");
1107
		else
1108
			printf(" %*s:	%s\n", width, " ", dl->line);
1109
	}
1110 1111

	return 0;
1112 1113
}

1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
/*
 * 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.
 */
1134
static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
1135
				      struct arch *arch,
1136 1137
				      FILE *file, size_t privsize,
				      int *line_nr)
1138
{
1139
	struct annotation *notes = symbol__annotation(sym);
1140
	struct disasm_line *dl;
1141
	char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
1142 1143
	size_t line_len;
	s64 line_ip, offset = -1;
1144
	regmatch_t match[2];
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

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

	if (!line)
		return -1;

	while (line_len != 0 && isspace(line[line_len - 1]))
		line[--line_len] = '\0';

	c = strchr(line, '\n');
	if (c)
		*c = 0;

	line_ip = -1;
N
Namhyung Kim 已提交
1160
	parsed_line = line;
1161

1162 1163 1164 1165 1166 1167
	/* /filename:linenr ? Save line number and ignore. */
	if (regexec(&file_lineno, line, 2, match, 0) == 0) {
		*line_nr = atoi(line + match[1].rm_so);
		return 0;
	}

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
	/*
	 * Strip leading spaces:
	 */
	tmp = line;
	while (*tmp) {
		if (*tmp != ' ')
			break;
		tmp++;
	}

	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;
1192
		if ((u64)line_ip < start || (u64)line_ip >= end)
1193
			offset = -1;
1194 1195
		else
			parsed_line = tmp2 + 1;
N
Namhyung Kim 已提交
1196
	}
1197

1198
	dl = disasm_line__new(offset, parsed_line, privsize, *line_nr, arch, map);
1199
	free(line);
1200
	(*line_nr)++;
1201

1202
	if (dl == NULL)
1203
		return -1;
1204

1205 1206 1207 1208
	if (dl->ops.target.offset == UINT64_MAX)
		dl->ops.target.offset = dl->ops.target.addr -
					map__rip_2objdump(map, sym->start);

1209
	/* kcore has no symbols, so add the call target name */
1210
	if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.name) {
1211 1212 1213 1214 1215
		struct addr_map_symbol target = {
			.map = map,
			.addr = dl->ops.target.addr,
		};

1216
		if (!map_groups__find_ams(&target) &&
1217 1218
		    target.sym->start == target.al_addr)
			dl->ops.target.name = strdup(target.sym->name);
1219 1220
	}

1221
	disasm__add(&notes->src->source, dl);
1222 1223 1224 1225

	return 0;
}

1226 1227 1228 1229 1230
static __attribute__((constructor)) void symbol__init_regexpr(void)
{
	regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
}

1231 1232 1233 1234 1235 1236 1237 1238 1239
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)) {
		dl = list_entry(list->prev, struct disasm_line, node);

1240 1241
		if (dl->ins.ops) {
			if (dl->ins.ops != &nop_ops)
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
				return;
		} else {
			if (!strstr(dl->line, " nop ") &&
			    !strstr(dl->line, " nopl ") &&
			    !strstr(dl->line, " nopw "))
				return;
		}

		list_del(&dl->node);
		disasm_line__free(dl);
	}
}

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 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
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;
}

1294
static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1295
{
1296 1297
	char linkname[PATH_MAX];
	char *build_id_filename;
1298

1299 1300
	if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
	    !dso__is_kcore(dso))
1301
		return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1302

1303 1304 1305 1306
	build_id_filename = dso__build_id_filename(dso, NULL, 0);
	if (build_id_filename) {
		__symbol__join_symfs(filename, filename_size, build_id_filename);
		free(build_id_filename);
1307
	} else {
1308 1309
		if (dso->has_build_id)
			return ENOMEM;
1310
		goto fallback;
1311 1312 1313
	}

	if (dso__is_kcore(dso) ||
1314 1315 1316
	    readlink(filename, linkname, sizeof(linkname)) < 0 ||
	    strstr(linkname, DSO__NAME_KALLSYMS) ||
	    access(filename, R_OK)) {
1317 1318 1319 1320 1321 1322
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.
		 */
1323
		__symbol__join_symfs(filename, filename_size, dso->long_name);
1324 1325
	}

1326 1327 1328
	return 0;
}

1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
static const char *annotate__norm_arch(const char *arch_name)
{
	struct utsname uts;

	if (!arch_name) { /* Assume we are annotating locally. */
		if (uname(&uts) < 0)
			return NULL;
		arch_name = uts.machine;
	}
	return normalize_arch((char *)arch_name);
}

int symbol__disassemble(struct symbol *sym, struct map *map, const char *arch_name, size_t privsize)
1342 1343 1344
{
	struct dso *dso = map->dso;
	char command[PATH_MAX * 2];
1345
	struct arch *arch = NULL;
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
	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;

1359 1360 1361 1362 1363 1364 1365 1366
	arch_name = annotate__norm_arch(arch_name);
	if (!arch_name)
		return -1;

	arch = arch__find(arch_name);
	if (arch == NULL)
		return -ENOTSUP;

1367 1368 1369 1370 1371 1372 1373 1374
	if (arch->init) {
		err = arch->init(arch);
		if (err) {
			pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
			return err;
		}
	}

1375
	pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1376
		 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1377 1378 1379 1380 1381
		 map->unmap_ip(map, sym->end));

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

1382 1383 1384 1385
	if (dso__is_kcore(dso)) {
		kce.kcore_filename = symfs_filename;
		kce.addr = map__rip_2objdump(map, sym->start);
		kce.offs = sym->start;
1386
		kce.len = sym->end - sym->start;
1387 1388 1389 1390 1391
		if (!kcore_extract__create(&kce)) {
			delete_extract = true;
			strlcpy(symfs_filename, kce.extract_filename,
				sizeof(symfs_filename));
		}
1392 1393 1394 1395 1396 1397 1398
	} else if (dso__needs_decompress(dso)) {
		char tmp[PATH_MAX];
		struct kmod_path m;
		int fd;
		bool ret;

		if (kmod_path__parse_ext(&m, symfs_filename))
1399
			goto out;
1400 1401 1402 1403 1404 1405

		snprintf(tmp, PATH_MAX, "/tmp/perf-kmod-XXXXXX");

		fd = mkstemp(tmp);
		if (fd < 0) {
			free(m.ext);
1406
			goto out;
1407 1408 1409 1410
		}

		ret = decompress_to_file(m.ext, symfs_filename, fd);

1411 1412 1413
		if (ret)
			pr_err("Cannot decompress %s %s\n", m.ext, symfs_filename);

1414 1415 1416 1417
		free(m.ext);
		close(fd);

		if (!ret)
1418
			goto out;
1419 1420

		strcpy(symfs_filename, tmp);
1421 1422
	}

1423
	snprintf(command, sizeof(command),
1424
		 "%s %s%s --start-address=0x%016" PRIx64
1425
		 " --stop-address=0x%016" PRIx64
1426
		 " -l -d %s %s -C %s 2>/dev/null|grep -v %s|expand",
1427
		 objdump_path ? objdump_path : "objdump",
1428 1429
		 disassembler_style ? "-M " : "",
		 disassembler_style ? disassembler_style : "",
1430
		 map__rip_2objdump(map, sym->start),
1431
		 map__rip_2objdump(map, sym->end),
1432 1433
		 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
		 symbol_conf.annotate_src ? "-S" : "",
1434
		 symfs_filename, symfs_filename);
1435 1436 1437

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

1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
	err = -1;
	if (pipe(stdout_fd) < 0) {
		pr_err("Failure creating the pipe to run %s\n", command);
		goto out_remove_tmp;
	}

	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");
1462
	if (!file) {
1463
		pr_err("Failure creating FILE stream for %s\n", command);
1464 1465 1466 1467
		/*
		 * If we were using debug info should retry with
		 * original binary.
		 */
1468
		goto out_remove_tmp;
1469
	}
1470

1471 1472
	nline = 0;
	while (!feof(file)) {
1473
		if (symbol__parse_objdump_line(sym, map, arch, file, privsize,
1474
			    &lineno) < 0)
1475
			break;
1476 1477 1478 1479 1480
		nline++;
	}

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

1482 1483 1484 1485 1486 1487 1488
	/*
	 * 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);

1489 1490
	fclose(file);
	err = 0;
1491
out_remove_tmp:
1492 1493
	close(stdout_fd[0]);

1494 1495
	if (dso__needs_decompress(dso))
		unlink(symfs_filename);
1496

1497 1498
	if (delete_extract)
		kcore_extract__delete(&kce);
1499
out:
1500
	return err;
1501 1502 1503 1504

out_close_stdout:
	close(stdout_fd[1]);
	goto out_remove_tmp;
1505 1506 1507 1508 1509 1510 1511
}

static void insert_source_line(struct rb_root *root, struct source_line *src_line)
{
	struct source_line *iter;
	struct rb_node **p = &root->rb_node;
	struct rb_node *parent = NULL;
1512
	int i, ret;
1513 1514 1515 1516 1517

	while (*p != NULL) {
		parent = *p;
		iter = rb_entry(parent, struct source_line, node);

1518 1519
		ret = strcmp(iter->path, src_line->path);
		if (ret == 0) {
1520
			for (i = 0; i < src_line->nr_pcnt; i++)
1521
				iter->samples[i].percent_sum += src_line->samples[i].percent;
1522 1523 1524 1525 1526 1527 1528 1529 1530
			return;
		}

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

1531
	for (i = 0; i < src_line->nr_pcnt; i++)
1532
		src_line->samples[i].percent_sum = src_line->samples[i].percent;
1533 1534 1535 1536 1537

	rb_link_node(&src_line->node, parent, p);
	rb_insert_color(&src_line->node, root);
}

1538 1539 1540 1541 1542
static int cmp_source_line(struct source_line *a, struct source_line *b)
{
	int i;

	for (i = 0; i < a->nr_pcnt; i++) {
1543
		if (a->samples[i].percent_sum == b->samples[i].percent_sum)
1544
			continue;
1545
		return a->samples[i].percent_sum > b->samples[i].percent_sum;
1546 1547 1548 1549 1550
	}

	return 0;
}

1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
{
	struct source_line *iter;
	struct rb_node **p = &root->rb_node;
	struct rb_node *parent = NULL;

	while (*p != NULL) {
		parent = *p;
		iter = rb_entry(parent, struct source_line, node);

1561
		if (cmp_source_line(src_line, iter))
1562 1563 1564 1565 1566 1567 1568 1569 1570
			p = &(*p)->rb_left;
		else
			p = &(*p)->rb_right;
	}

	rb_link_node(&src_line->node, parent, p);
	rb_insert_color(&src_line->node, root);
}

1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
{
	struct source_line *src_line;
	struct rb_node *node;

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

		src_line = rb_entry(node, struct source_line, node);
		next = rb_next(node);
		rb_erase(node, src_root);

		__resort_source_line(dest_root, src_line);
		node = next;
	}
}

1589 1590 1591
static void symbol__free_source_line(struct symbol *sym, int len)
{
	struct annotation *notes = symbol__annotation(sym);
1592
	struct source_line *src_line = notes->src->lines;
1593
	size_t sizeof_src_line;
1594 1595
	int i;

1596
	sizeof_src_line = sizeof(*src_line) +
1597
			  (sizeof(src_line->samples) * (src_line->nr_pcnt - 1));
1598

1599
	for (i = 0; i < len; i++) {
1600
		free_srcline(src_line->path);
1601 1602 1603
		src_line = (void *)src_line + sizeof_src_line;
	}

1604
	zfree(&notes->src->lines);
1605 1606 1607 1608
}

/* Get the filename:line for the colored entries */
static int symbol__get_source_line(struct symbol *sym, struct map *map,
1609
				   struct perf_evsel *evsel,
1610
				   struct rb_root *root, int len)
1611 1612
{
	u64 start;
1613 1614
	int i, k;
	int evidx = evsel->idx;
1615 1616
	struct source_line *src_line;
	struct annotation *notes = symbol__annotation(sym);
1617
	struct sym_hist *h = annotation__histogram(notes, evidx);
1618
	struct rb_root tmp_root = RB_ROOT;
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
	int nr_pcnt = 1;
	u64 h_sum = h->sum;
	size_t sizeof_src_line = sizeof(struct source_line);

	if (perf_evsel__is_group_event(evsel)) {
		for (i = 1; i < evsel->nr_members; i++) {
			h = annotation__histogram(notes, evidx + i);
			h_sum += h->sum;
		}
		nr_pcnt = evsel->nr_members;
1629
		sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->samples);
1630
	}
1631

1632
	if (!h_sum)
1633 1634
		return 0;

1635
	src_line = notes->src->lines = calloc(len, sizeof_src_line);
1636
	if (!notes->src->lines)
1637 1638
		return -1;

1639
	start = map__rip_2objdump(map, sym->start);
1640 1641 1642

	for (i = 0; i < len; i++) {
		u64 offset;
1643
		double percent_max = 0.0;
1644

1645 1646 1647 1648
		src_line->nr_pcnt = nr_pcnt;

		for (k = 0; k < nr_pcnt; k++) {
			h = annotation__histogram(notes, evidx + k);
1649
			src_line->samples[k].percent = 100.0 * h->addr[i] / h->sum;
1650

1651 1652
			if (src_line->samples[k].percent > percent_max)
				percent_max = src_line->samples[k].percent;
1653 1654 1655 1656
		}

		if (percent_max <= 0.5)
			goto next;
1657 1658

		offset = start + i;
1659
		src_line->path = get_srcline(map->dso, offset, NULL, false);
1660
		insert_source_line(&tmp_root, src_line);
1661

1662 1663
	next:
		src_line = (void *)src_line + sizeof_src_line;
1664 1665
	}

1666
	resort_source_line(root, &tmp_root);
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
	return 0;
}

static void print_summary(struct rb_root *root, const char *filename)
{
	struct source_line *src_line;
	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) {
1685
		double percent, percent_max = 0.0;
1686 1687
		const char *color;
		char *path;
1688
		int i;
1689 1690

		src_line = rb_entry(node, struct source_line, node);
1691
		for (i = 0; i < src_line->nr_pcnt; i++) {
1692
			percent = src_line->samples[i].percent_sum;
1693 1694 1695 1696 1697 1698 1699
			color = get_percent_color(percent);
			color_fprintf(stdout, color, " %7.2f", percent);

			if (percent > percent_max)
				percent_max = percent;
		}

1700
		path = src_line->path;
1701
		color = get_percent_color(percent_max);
1702
		color_fprintf(stdout, color, " %s\n", path);
1703 1704 1705 1706 1707

		node = rb_next(node);
	}
}

1708
static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1709 1710
{
	struct annotation *notes = symbol__annotation(sym);
1711
	struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1712
	u64 len = symbol__size(sym), offset;
1713 1714 1715 1716 1717 1718 1719 1720

	for (offset = 0; offset < len; ++offset)
		if (h->addr[offset] != 0)
			printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
			       sym->start + offset, h->addr[offset]);
	printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
}

1721 1722 1723
int symbol__annotate_printf(struct symbol *sym, struct map *map,
			    struct perf_evsel *evsel, bool full_paths,
			    int min_pcnt, int max_lines, int context)
1724 1725
{
	struct dso *dso = map->dso;
1726 1727
	char *filename;
	const char *d_filename;
1728
	const char *evsel_name = perf_evsel__name(evsel);
1729
	struct annotation *notes = symbol__annotation(sym);
1730
	struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1731
	struct disasm_line *pos, *queue = NULL;
1732
	u64 start = map__rip_2objdump(map, sym->start);
1733
	int printed = 2, queue_len = 0;
1734
	int more = 0;
1735
	u64 len;
1736
	int width = 8;
1737
	int graph_dotted_len;
1738

1739 1740 1741 1742
	filename = strdup(dso->long_name);
	if (!filename)
		return -ENOMEM;

1743 1744 1745 1746 1747
	if (full_paths)
		d_filename = filename;
	else
		d_filename = basename(filename);

1748
	len = symbol__size(sym);
1749

1750
	if (perf_evsel__is_group_event(evsel))
1751
		width *= evsel->nr_members;
1752

1753 1754
	graph_dotted_len = printf(" %-*.*s|	Source code & Disassembly of %s for %s (%" PRIu64 " samples)\n",
	       width, width, "Percent", d_filename, evsel_name, h->sum);
1755

1756
	printf("%-*.*s----\n",
1757
	       graph_dotted_len, graph_dotted_len, graph_dotted_line);
1758 1759

	if (verbose)
1760
		symbol__annotate_hits(sym, evsel);
1761

1762
	list_for_each_entry(pos, &notes->src->source, node) {
1763 1764 1765 1766 1767
		if (context && queue == NULL) {
			queue = pos;
			queue_len = 0;
		}

1768
		switch (disasm_line__print(pos, sym, start, evsel, len,
1769 1770
					    min_pcnt, printed, max_lines,
					    queue)) {
1771 1772
		case 0:
			++printed;
1773 1774 1775 1776 1777
			if (context) {
				printed += queue_len;
				queue = NULL;
				queue_len = 0;
			}
1778 1779 1780 1781
			break;
		case 1:
			/* filtered by max_lines */
			++more;
1782
			break;
1783 1784
		case -1:
		default:
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794
			/*
			 * Filtered by min_pcnt or non IP lines when
			 * context != 0
			 */
			if (!context)
				break;
			if (queue_len == context)
				queue = list_entry(queue->node.next, typeof(*queue), node);
			else
				++queue_len;
1795 1796 1797 1798
			break;
		}
	}

1799 1800
	free(filename);

1801 1802
	return more;
}
1803

1804 1805 1806 1807 1808
void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
{
	struct annotation *notes = symbol__annotation(sym);
	struct sym_hist *h = annotation__histogram(notes, evidx);

1809
	memset(h, 0, notes->src->sizeof_sym_hist);
1810 1811
}

1812
void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1813 1814 1815
{
	struct annotation *notes = symbol__annotation(sym);
	struct sym_hist *h = annotation__histogram(notes, evidx);
1816
	int len = symbol__size(sym), offset;
1817 1818

	h->sum = 0;
1819 1820 1821
	for (offset = 0; offset < len; ++offset) {
		h->addr[offset] = h->addr[offset] * 7 / 8;
		h->sum += h->addr[offset];
1822 1823 1824
	}
}

1825
void disasm__purge(struct list_head *head)
1826
{
1827
	struct disasm_line *pos, *n;
1828 1829 1830

	list_for_each_entry_safe(pos, n, head, node) {
		list_del(&pos->node);
1831
		disasm_line__free(pos);
1832 1833 1834
	}
}

1835 1836 1837 1838 1839 1840 1841
static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
{
	size_t printed;

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

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

1844
	if (dl->ops.raw[0] != '\0') {
1845
		printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1846
				   dl->ops.raw);
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
	}

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

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

	list_for_each_entry(pos, head, node)
		printed += disasm_line__fprintf(pos, fp);

	return printed;
}

1863 1864 1865
int symbol__tty_annotate(struct symbol *sym, struct map *map,
			 struct perf_evsel *evsel, bool print_lines,
			 bool full_paths, int min_pcnt, int max_lines)
1866 1867 1868 1869 1870
{
	struct dso *dso = map->dso;
	struct rb_root source_line = RB_ROOT;
	u64 len;

1871
	if (symbol__disassemble(sym, map, perf_evsel__env_arch(evsel), 0) < 0)
1872 1873
		return -1;

1874
	len = symbol__size(sym);
1875 1876

	if (print_lines) {
1877
		srcline_full_filename = full_paths;
1878 1879
		symbol__get_source_line(sym, map, evsel, &source_line, len);
		print_summary(&source_line, dso->long_name);
1880 1881
	}

1882
	symbol__annotate_printf(sym, map, evsel, full_paths,
1883
				min_pcnt, max_lines, 0);
1884 1885 1886
	if (print_lines)
		symbol__free_source_line(sym, len);

1887
	disasm__purge(&symbol__annotation(sym)->src->source);
1888

1889 1890
	return 0;
}
1891

1892 1893
bool ui__has_annotation(void)
{
1894
	return use_browser == 1 && perf_hpp_list.sym;
1895
}