tools/perf/util/annotate.c

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