tools/perf/util/annotate.c

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