tools/perf/util/annotate.c

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