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