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