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