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