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