tools/perf/util/annotate.c

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