tools/perf/util/annotate.c

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