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