tools/perf/util/annotate.c

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