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         ch[offset].have_start = have_start;
 857         ch[offset].start = start;
 858         ch[offset].cycles += cycles;
 859         ch[offset].num++;
 860         return 0;
 861 }
 862
 863 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
 864                                       struct annotated_source *src, int evidx, u64 addr,
 865                                       struct perf_sample *sample)
 866 {
 867         unsigned offset;
 868         struct sym_hist *h;
 869
 870         pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
 871
 872         if ((addr < sym->start || addr >= sym->end) &&
 873             (addr != sym->end || sym->start != sym->end)) {
 874                 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
 875                        __func__, __LINE__, sym->name, sym->start, addr, sym->end);
 876                 return -ERANGE;
 877         }
 878
 879         offset = addr - sym->start;
 880         h = annotated_source__histogram(src, evidx);
 881         if (h == NULL) {
 882                 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
 883                          __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
 884                 return -ENOMEM;
 885         }
 886         h->nr_samples++;
 887         h->addr[offset].nr_samples++;
 888         h->period += sample->period;
 889         h->addr[offset].period += sample->period;
 890
 891         pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
 892                   ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
 893                   sym->start, sym->name, addr, addr - sym->start, evidx,
 894                   h->addr[offset].nr_samples, h->addr[offset].period);
 895         return 0;
 896 }
 897
 898 static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
 899 {
 900         struct annotation *notes = symbol__annotation(sym);
 901
 902         if (notes->src == NULL) {
 903                 notes->src = annotated_source__new();
 904                 if (notes->src == NULL)
 905                         return NULL;
 906                 goto alloc_cycles_hist;
 907         }
 908
 909         if (!notes->src->cycles_hist) {
 910 alloc_cycles_hist:
 911                 symbol__alloc_hist_cycles(sym);
 912         }
 913
 914         return notes->src->cycles_hist;
 915 }
 916
 917 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
 918 {
 919         struct annotation *notes = symbol__annotation(sym);
 920
 921         if (notes->src == NULL) {
 922                 notes->src = annotated_source__new();
 923                 if (notes->src == NULL)
 924                         return NULL;
 925                 goto alloc_histograms;
 926         }
 927
 928         if (notes->src->histograms == NULL) {
 929 alloc_histograms:
 930                 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
 931                                                    nr_hists);
 932         }
 933
 934         return notes->src;
 935 }
 936
 937 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
 938                                     struct evsel *evsel, u64 addr,
 939                                     struct perf_sample *sample)
 940 {
 941         struct annotated_source *src;
 942
 943         if (sym == NULL)
 944                 return 0;
 945         src = symbol__hists(sym, evsel->evlist->core.nr_entries);
 946         return (src) ?  __symbol__inc_addr_samples(sym, map, src, evsel->idx,
 947                                                    addr, sample) : 0;
 948 }
 949
 950 static int symbol__account_cycles(u64 addr, u64 start,
 951                                   struct symbol *sym, unsigned cycles)
 952 {
 953         struct cyc_hist *cycles_hist;
 954         unsigned offset;
 955
 956         if (sym == NULL)
 957                 return 0;
 958         cycles_hist = symbol__cycles_hist(sym);
 959         if (cycles_hist == NULL)
 960                 return -ENOMEM;
 961         if (addr < sym->start || addr >= sym->end)
 962                 return -ERANGE;
 963
 964         if (start) {
 965                 if (start < sym->start || start >= sym->end)
 966                         return -ERANGE;
 967                 if (start >= addr)
 968                         start = 0;
 969         }
 970         offset = addr - sym->start;
 971         return __symbol__account_cycles(cycles_hist,
 972                                         start ? start - sym->start : 0,
 973                                         offset, cycles,
 974                                         !!start);
 975 }
 976
 977 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
 978                                     struct addr_map_symbol *start,
 979                                     unsigned cycles)
 980 {
 981         u64 saddr = 0;
 982         int err;
 983
 984         if (!cycles)
 985                 return 0;
 986
 987         /*
 988          * Only set start when IPC can be computed. We can only
 989          * compute it when the basic block is completely in a single
 990          * function.
 991          * Special case the case when the jump is elsewhere, but
 992          * it starts on the function start.
 993          */
 994         if (start &&
 995                 (start->sym == ams->sym ||
 996                  (ams->sym &&
 997                    start->addr == ams->sym->start + ams->map->start)))
 998                 saddr = start->al_addr;
 999         if (saddr == 0)
1000                 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
1001                         ams->addr,
1002                         start ? start->addr : 0,
1003                         ams->sym ? ams->sym->start + ams->map->start : 0,
1004                         saddr);
1005         err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
1006         if (err)
1007                 pr_debug2("account_cycles failed %d\n", err);
1008         return err;
1009 }
1010
1011 static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1012 {
1013         unsigned n_insn = 0;
1014         u64 offset;
1015
1016         for (offset = start; offset <= end; offset++) {
1017                 if (notes->offsets[offset])
1018                         n_insn++;
1019         }
1020         return n_insn;
1021 }
1022
1023 static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1024 {
1025         unsigned n_insn;
1026         unsigned int cover_insn = 0;
1027         u64 offset;
1028
1029         n_insn = annotation__count_insn(notes, start, end);
1030         if (n_insn && ch->num && ch->cycles) {
1031                 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1032
1033                 /* Hide data when there are too many overlaps. */
1034                 if (ch->reset >= 0x7fff)
1035                         return;
1036
1037                 for (offset = start; offset <= end; offset++) {
1038                         struct annotation_line *al = notes->offsets[offset];
1039
1040                         if (al && al->ipc == 0.0) {
1041                                 al->ipc = ipc;
1042                                 cover_insn++;
1043                         }
1044                 }
1045
1046                 if (cover_insn) {
1047                         notes->hit_cycles += ch->cycles;
1048                         notes->hit_insn += n_insn * ch->num;
1049                         notes->cover_insn += cover_insn;
1050                 }
1051         }
1052 }
1053
1054 void annotation__compute_ipc(struct annotation *notes, size_t size)
1055 {
1056         s64 offset;
1057
1058         if (!notes->src || !notes->src->cycles_hist)
1059                 return;
1060
1061         notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1062         notes->hit_cycles = 0;
1063         notes->hit_insn = 0;
1064         notes->cover_insn = 0;
1065
1066         pthread_mutex_lock(&notes->lock);
1067         for (offset = size - 1; offset >= 0; --offset) {
1068                 struct cyc_hist *ch;
1069
1070                 ch = &notes->src->cycles_hist[offset];
1071                 if (ch && ch->cycles) {
1072                         struct annotation_line *al;
1073
1074                         if (ch->have_start)
1075                                 annotation__count_and_fill(notes, ch->start, offset, ch);
1076                         al = notes->offsets[offset];
1077                         if (al && ch->num_aggr) {
1078                                 al->cycles = ch->cycles_aggr / ch->num_aggr;
1079                                 al->cycles_max = ch->cycles_max;
1080                                 al->cycles_min = ch->cycles_min;
1081                         }
1082                         notes->have_cycles = true;
1083                 }
1084         }
1085         pthread_mutex_unlock(&notes->lock);
1086 }
1087
1088 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1089                                  struct evsel *evsel)
1090 {
1091         return symbol__inc_addr_samples(ams->sym, ams->map, evsel, ams->al_addr, sample);
1092 }
1093
1094 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1095                                  struct evsel *evsel, u64 ip)
1096 {
1097         return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evsel, ip, sample);
1098 }
1099
1100 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1101 {
1102         dl->ins.ops = ins__find(arch, dl->ins.name);
1103
1104         if (!dl->ins.ops)
1105                 return;
1106
1107         if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1108                 dl->ins.ops = NULL;
1109 }
1110
1111 static int disasm_line__parse(char *line, const char **namep, char **rawp)
1112 {
1113         char tmp, *name = skip_spaces(line);
1114
1115         if (name[0] == '\0')
1116                 return -1;
1117
1118         *rawp = name + 1;
1119
1120         while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1121                 ++*rawp;
1122
1123         tmp = (*rawp)[0];
1124         (*rawp)[0] = '\0';
1125         *namep = strdup(name);
1126
1127         if (*namep == NULL)
1128                 goto out;
1129
1130         (*rawp)[0] = tmp;
1131         *rawp = strim(*rawp);
1132
1133         return 0;
1134
1135 out:
1136         return -1;
1137 }
1138
1139 struct annotate_args {
1140         size_t                   privsize;
1141         struct arch             *arch;
1142         struct map_symbol        ms;
1143         struct evsel    *evsel;
1144         struct annotation_options *options;
1145         s64                      offset;
1146         char                    *line;
1147         int                      line_nr;
1148 };
1149
1150 static void annotation_line__delete(struct annotation_line *al)
1151 {
1152         void *ptr = (void *) al - al->privsize;
1153
1154         free_srcline(al->path);
1155         zfree(&al->line);
1156         free(ptr);
1157 }
1158
1159 /*
1160  * Allocating the annotation line data with following
1161  * structure:
1162  *
1163  *    --------------------------------------
1164  *    private space | struct annotation_line
1165  *    --------------------------------------
1166  *
1167  * Size of the private space is stored in 'struct annotation_line'.
1168  *
1169  */
1170 static struct annotation_line *
1171 annotation_line__new(struct annotate_args *args, size_t privsize)
1172 {
1173         struct annotation_line *al;
1174         struct evsel *evsel = args->evsel;
1175         size_t size = privsize + sizeof(*al);
1176         int nr = 1;
1177
1178         if (perf_evsel__is_group_event(evsel))
1179                 nr = evsel->core.nr_members;
1180
1181         size += sizeof(al->data[0]) * nr;
1182
1183         al = zalloc(size);
1184         if (al) {
1185                 al = (void *) al + privsize;
1186                 al->privsize   = privsize;
1187                 al->offset     = args->offset;
1188                 al->line       = strdup(args->line);
1189                 al->line_nr    = args->line_nr;
1190                 al->data_nr    = nr;
1191         }
1192
1193         return al;
1194 }
1195
1196 /*
1197  * Allocating the disasm annotation line data with
1198  * following structure:
1199  *
1200  *    ------------------------------------------------------------
1201  *    privsize space | struct disasm_line | struct annotation_line
1202  *    ------------------------------------------------------------
1203  *
1204  * We have 'struct annotation_line' member as last member
1205  * of 'struct disasm_line' to have an easy access.
1206  *
1207  */
1208 static struct disasm_line *disasm_line__new(struct annotate_args *args)
1209 {
1210         struct disasm_line *dl = NULL;
1211         struct annotation_line *al;
1212         size_t privsize = args->privsize + offsetof(struct disasm_line, al);
1213
1214         al = annotation_line__new(args, privsize);
1215         if (al != NULL) {
1216                 dl = disasm_line(al);
1217
1218                 if (dl->al.line == NULL)
1219                         goto out_delete;
1220
1221                 if (args->offset != -1) {
1222                         if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1223                                 goto out_free_line;
1224
1225                         disasm_line__init_ins(dl, args->arch, &args->ms);
1226                 }
1227         }
1228
1229         return dl;
1230
1231 out_free_line:
1232         zfree(&dl->al.line);
1233 out_delete:
1234         free(dl);
1235         return NULL;
1236 }
1237
1238 void disasm_line__free(struct disasm_line *dl)
1239 {
1240         if (dl->ins.ops && dl->ins.ops->free)
1241                 dl->ins.ops->free(&dl->ops);
1242         else
1243                 ins__delete(&dl->ops);
1244         zfree(&dl->ins.name);
1245         annotation_line__delete(&dl->al);
1246 }
1247
1248 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1249 {
1250         if (raw || !dl->ins.ops)
1251                 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1252
1253         return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1254 }
1255
1256 static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1257 {
1258         list_add_tail(&al->node, head);
1259 }
1260
1261 struct annotation_line *
1262 annotation_line__next(struct annotation_line *pos, struct list_head *head)
1263 {
1264         list_for_each_entry_continue(pos, head, node)
1265                 if (pos->offset >= 0)
1266                         return pos;
1267
1268         return NULL;
1269 }
1270
1271 static const char *annotate__address_color(struct block_range *br)
1272 {
1273         double cov = block_range__coverage(br);
1274
1275         if (cov >= 0) {
1276                 /* mark red for >75% coverage */
1277                 if (cov > 0.75)
1278                         return PERF_COLOR_RED;
1279
1280                 /* mark dull for <1% coverage */
1281                 if (cov < 0.01)
1282                         return PERF_COLOR_NORMAL;
1283         }
1284
1285         return PERF_COLOR_MAGENTA;
1286 }
1287
1288 static const char *annotate__asm_color(struct block_range *br)
1289 {
1290         double cov = block_range__coverage(br);
1291
1292         if (cov >= 0) {
1293                 /* mark dull for <1% coverage */
1294                 if (cov < 0.01)
1295                         return PERF_COLOR_NORMAL;
1296         }
1297
1298         return PERF_COLOR_BLUE;
1299 }
1300
1301 static void annotate__branch_printf(struct block_range *br, u64 addr)
1302 {
1303         bool emit_comment = true;
1304
1305         if (!br)
1306                 return;
1307
1308 #if 1
1309         if (br->is_target && br->start == addr) {
1310                 struct block_range *branch = br;
1311                 double p;
1312
1313                 /*
1314                  * Find matching branch to our target.
1315                  */
1316                 while (!branch->is_branch)
1317                         branch = block_range__next(branch);
1318
1319                 p = 100 *(double)br->entry / branch->coverage;
1320
1321                 if (p > 0.1) {
1322                         if (emit_comment) {
1323                                 emit_comment = false;
1324                                 printf("\t#");
1325                         }
1326
1327                         /*
1328                          * The percentage of coverage joined at this target in relation
1329                          * to the next branch.
1330                          */
1331                         printf(" +%.2f%%", p);
1332                 }
1333         }
1334 #endif
1335         if (br->is_branch && br->end == addr) {
1336                 double p = 100*(double)br->taken / br->coverage;
1337
1338                 if (p > 0.1) {
1339                         if (emit_comment) {
1340                                 emit_comment = false;
1341                                 printf("\t#");
1342                         }
1343
1344                         /*
1345                          * The percentage of coverage leaving at this branch, and
1346                          * its prediction ratio.
1347                          */
1348                         printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred  / br->taken);
1349                 }
1350         }
1351 }
1352
1353 static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1354 {
1355         s64 offset = dl->al.offset;
1356         const u64 addr = start + offset;
1357         struct block_range *br;
1358
1359         br = block_range__find(addr);
1360         color_fprintf(stdout, annotate__address_color(br), "  %*" PRIx64 ":", addr_fmt_width, addr);
1361         color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1362         annotate__branch_printf(br, addr);
1363         return 0;
1364 }
1365
1366 static int
1367 annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1368                        struct evsel *evsel, u64 len, int min_pcnt, int printed,
1369                        int max_lines, struct annotation_line *queue, int addr_fmt_width,
1370                        int percent_type)
1371 {
1372         struct disasm_line *dl = container_of(al, struct disasm_line, al);
1373         static const char *prev_line;
1374         static const char *prev_color;
1375
1376         if (al->offset != -1) {
1377                 double max_percent = 0.0;
1378                 int i, nr_percent = 1;
1379                 const char *color;
1380                 struct annotation *notes = symbol__annotation(sym);
1381
1382                 for (i = 0; i < al->data_nr; i++) {
1383                         double percent;
1384
1385                         percent = annotation_data__percent(&al->data[i],
1386                                                            percent_type);
1387
1388                         if (percent > max_percent)
1389                                 max_percent = percent;
1390                 }
1391
1392                 if (al->data_nr > nr_percent)
1393                         nr_percent = al->data_nr;
1394
1395                 if (max_percent < min_pcnt)
1396                         return -1;
1397
1398                 if (max_lines && printed >= max_lines)
1399                         return 1;
1400
1401                 if (queue != NULL) {
1402                         list_for_each_entry_from(queue, &notes->src->source, node) {
1403                                 if (queue == al)
1404                                         break;
1405                                 annotation_line__print(queue, sym, start, evsel, len,
1406                                                        0, 0, 1, NULL, addr_fmt_width,
1407                                                        percent_type);
1408                         }
1409                 }
1410
1411                 color = get_percent_color(max_percent);
1412
1413                 /*
1414                  * Also color the filename and line if needed, with
1415                  * the same color than the percentage. Don't print it
1416                  * twice for close colored addr with the same filename:line
1417                  */
1418                 if (al->path) {
1419                         if (!prev_line || strcmp(prev_line, al->path)
1420                                        || color != prev_color) {
1421                                 color_fprintf(stdout, color, " %s", al->path);
1422                                 prev_line = al->path;
1423                                 prev_color = color;
1424                         }
1425                 }
1426
1427                 for (i = 0; i < nr_percent; i++) {
1428                         struct annotation_data *data = &al->data[i];
1429                         double percent;
1430
1431                         percent = annotation_data__percent(data, percent_type);
1432                         color = get_percent_color(percent);
1433
1434                         if (symbol_conf.show_total_period)
1435                                 color_fprintf(stdout, color, " %11" PRIu64,
1436                                               data->he.period);
1437                         else if (symbol_conf.show_nr_samples)
1438                                 color_fprintf(stdout, color, " %7" PRIu64,
1439                                               data->he.nr_samples);
1440                         else
1441                                 color_fprintf(stdout, color, " %7.2f", percent);
1442                 }
1443
1444                 printf(" : ");
1445
1446                 disasm_line__print(dl, start, addr_fmt_width);
1447                 printf("\n");
1448         } else if (max_lines && printed >= max_lines)
1449                 return 1;
1450         else {
1451                 int width = symbol_conf.show_total_period ? 12 : 8;
1452
1453                 if (queue)
1454                         return -1;
1455
1456                 if (perf_evsel__is_group_event(evsel))
1457                         width *= evsel->core.nr_members;
1458
1459                 if (!*al->line)
1460                         printf(" %*s:\n", width, " ");
1461                 else
1462                         printf(" %*s:     %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1463         }
1464
1465         return 0;
1466 }
1467
1468 /*
1469  * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1470  * which looks like following
1471  *
1472  *  0000000000415500 <_init>:
1473  *    415500:       sub    $0x8,%rsp
1474  *    415504:       mov    0x2f5ad5(%rip),%rax        # 70afe0 <_DYNAMIC+0x2f8>
1475  *    41550b:       test   %rax,%rax
1476  *    41550e:       je     415515 <_init+0x15>
1477  *    415510:       callq  416e70 <__gmon_start__@plt>
1478  *    415515:       add    $0x8,%rsp
1479  *    415519:       retq
1480  *
1481  * it will be parsed and saved into struct disasm_line as
1482  *  <offset>       <name>  <ops.raw>
1483  *
1484  * The offset will be a relative offset from the start of the symbol and -1
1485  * means that it's not a disassembly line so should be treated differently.
1486  * The ops.raw part will be parsed further according to type of the instruction.
1487  */
1488 static int symbol__parse_objdump_line(struct symbol *sym, FILE *file,
1489                                       struct annotate_args *args,
1490                                       int *line_nr)
1491 {
1492         struct map *map = args->ms.map;
1493         struct annotation *notes = symbol__annotation(sym);
1494         struct disasm_line *dl;
1495         char *line = NULL, *parsed_line, *tmp, *tmp2;
1496         size_t line_len;
1497         s64 line_ip, offset = -1;
1498         regmatch_t match[2];
1499
1500         if (getline(&line, &line_len, file) < 0)
1501                 return -1;
1502
1503         if (!line)
1504                 return -1;
1505
1506         line_ip = -1;
1507         parsed_line = strim(line);
1508
1509         /* /filename:linenr ? Save line number and ignore. */
1510         if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1511                 *line_nr = atoi(parsed_line + match[1].rm_so);
1512                 return 0;
1513         }
1514
1515         tmp = skip_spaces(parsed_line);
1516         if (*tmp) {
1517                 /*
1518                  * Parse hexa addresses followed by ':'
1519                  */
1520                 line_ip = strtoull(tmp, &tmp2, 16);
1521                 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1522                         line_ip = -1;
1523         }
1524
1525         if (line_ip != -1) {
1526                 u64 start = map__rip_2objdump(map, sym->start),
1527                     end = map__rip_2objdump(map, sym->end);
1528
1529                 offset = line_ip - start;
1530                 if ((u64)line_ip < start || (u64)line_ip >= end)
1531                         offset = -1;
1532                 else
1533                         parsed_line = tmp2 + 1;
1534         }
1535
1536         args->offset  = offset;
1537         args->line    = parsed_line;
1538         args->line_nr = *line_nr;
1539         args->ms.sym  = sym;
1540
1541         dl = disasm_line__new(args);
1542         free(line);
1543         (*line_nr)++;
1544
1545         if (dl == NULL)
1546                 return -1;
1547
1548         if (!disasm_line__has_local_offset(dl)) {
1549                 dl->ops.target.offset = dl->ops.target.addr -
1550                                         map__rip_2objdump(map, sym->start);
1551                 dl->ops.target.offset_avail = true;
1552         }
1553
1554         /* kcore has no symbols, so add the call target symbol */
1555         if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1556                 struct addr_map_symbol target = {
1557                         .map = map,
1558                         .addr = dl->ops.target.addr,
1559                 };
1560
1561                 if (!map_groups__find_ams(&target) &&
1562                     target.sym->start == target.al_addr)
1563                         dl->ops.target.sym = target.sym;
1564         }
1565
1566         annotation_line__add(&dl->al, &notes->src->source);
1567
1568         return 0;
1569 }
1570
1571 static __attribute__((constructor)) void symbol__init_regexpr(void)
1572 {
1573         regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1574 }
1575
1576 static void delete_last_nop(struct symbol *sym)
1577 {
1578         struct annotation *notes = symbol__annotation(sym);
1579         struct list_head *list = &notes->src->source;
1580         struct disasm_line *dl;
1581
1582         while (!list_empty(list)) {
1583                 dl = list_entry(list->prev, struct disasm_line, al.node);
1584
1585                 if (dl->ins.ops) {
1586                         if (dl->ins.ops != &nop_ops)
1587                                 return;
1588                 } else {
1589                         if (!strstr(dl->al.line, " nop ") &&
1590                             !strstr(dl->al.line, " nopl ") &&
1591                             !strstr(dl->al.line, " nopw "))
1592                                 return;
1593                 }
1594
1595                 list_del_init(&dl->al.node);
1596                 disasm_line__free(dl);
1597         }
1598 }
1599
1600 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1601                               int errnum, char *buf, size_t buflen)
1602 {
1603         struct dso *dso = map->dso;
1604
1605         BUG_ON(buflen == 0);
1606
1607         if (errnum >= 0) {
1608                 str_error_r(errnum, buf, buflen);
1609                 return 0;
1610         }
1611
1612         switch (errnum) {
1613         case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1614                 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1615                 char *build_id_msg = NULL;
1616
1617                 if (dso->has_build_id) {
1618                         build_id__sprintf(dso->build_id,
1619                                           sizeof(dso->build_id), bf + 15);
1620                         build_id_msg = bf;
1621                 }
1622                 scnprintf(buf, buflen,
1623                           "No vmlinux file%s\nwas found in the path.\n\n"
1624                           "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1625                           "Please use:\n\n"
1626                           "  perf buildid-cache -vu vmlinux\n\n"
1627                           "or:\n\n"
1628                           "  --vmlinux vmlinux\n", build_id_msg ?: "");
1629         }
1630                 break;
1631         case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1632                 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1633                 break;
1634         case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP:
1635                 scnprintf(buf, buflen, "Problems with arch specific instruction name regular expressions.");
1636                 break;
1637         case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING:
1638                 scnprintf(buf, buflen, "Problems while parsing the CPUID in the arch specific initialization.");
1639                 break;
1640         case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE:
1641                 scnprintf(buf, buflen, "Invalid BPF file: %s.", dso->long_name);
1642                 break;
1643         case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF:
1644                 scnprintf(buf, buflen, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1645                           dso->long_name);
1646                 break;
1647         default:
1648                 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1649                 break;
1650         }
1651
1652         return 0;
1653 }
1654
1655 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1656 {
1657         char linkname[PATH_MAX];
1658         char *build_id_filename;
1659         char *build_id_path = NULL;
1660         char *pos;
1661
1662         if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1663             !dso__is_kcore(dso))
1664                 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1665
1666         build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1667         if (build_id_filename) {
1668                 __symbol__join_symfs(filename, filename_size, build_id_filename);
1669                 free(build_id_filename);
1670         } else {
1671                 if (dso->has_build_id)
1672                         return ENOMEM;
1673                 goto fallback;
1674         }
1675
1676         build_id_path = strdup(filename);
1677         if (!build_id_path)
1678                 return ENOMEM;
1679
1680         /*
1681          * old style build-id cache has name of XX/XXXXXXX.. while
1682          * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1683          * extract the build-id part of dirname in the new style only.
1684          */
1685         pos = strrchr(build_id_path, '/');
1686         if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1687                 dirname(build_id_path);
1688
1689         if (dso__is_kcore(dso) ||
1690             readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1691             strstr(linkname, DSO__NAME_KALLSYMS) ||
1692             access(filename, R_OK)) {
1693 fallback:
1694                 /*
1695                  * If we don't have build-ids or the build-id file isn't in the
1696                  * cache, or is just a kallsyms file, well, lets hope that this
1697                  * DSO is the same as when 'perf record' ran.
1698                  */
1699                 __symbol__join_symfs(filename, filename_size, dso->long_name);
1700         }
1701
1702         free(build_id_path);
1703         return 0;
1704 }
1705
1706 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1707 #define PACKAGE "perf"
1708 #include <bfd.h>
1709 #include <dis-asm.h>
1710
1711 static int symbol__disassemble_bpf(struct symbol *sym,
1712                                    struct annotate_args *args)
1713 {
1714         struct annotation *notes = symbol__annotation(sym);
1715         struct annotation_options *opts = args->options;
1716         struct bpf_prog_info_linear *info_linear;
1717         struct bpf_prog_linfo *prog_linfo = NULL;
1718         struct bpf_prog_info_node *info_node;
1719         int len = sym->end - sym->start;
1720         disassembler_ftype disassemble;
1721         struct map *map = args->ms.map;
1722         struct disassemble_info info;
1723         struct dso *dso = map->dso;
1724         int pc = 0, count, sub_id;
1725         struct btf *btf = NULL;
1726         char tpath[PATH_MAX];
1727         size_t buf_size;
1728         int nr_skip = 0;
1729         char *buf;
1730         bfd *bfdf;
1731         int ret;
1732         FILE *s;
1733
1734         if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1735                 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE;
1736
1737         pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1738                   sym->name, sym->start, sym->end - sym->start);
1739
1740         memset(tpath, 0, sizeof(tpath));
1741         perf_exe(tpath, sizeof(tpath));
1742
1743         bfdf = bfd_openr(tpath, NULL);
1744         assert(bfdf);
1745         assert(bfd_check_format(bfdf, bfd_object));
1746
1747         s = open_memstream(&buf, &buf_size);
1748         if (!s) {
1749                 ret = errno;
1750                 goto out;
1751         }
1752         init_disassemble_info(&info, s,
1753                               (fprintf_ftype) fprintf);
1754
1755         info.arch = bfd_get_arch(bfdf);
1756         info.mach = bfd_get_mach(bfdf);
1757
1758         info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1759                                                  dso->bpf_prog.id);
1760         if (!info_node) {
1761                 return SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF;
1762                 goto out;
1763         }
1764         info_linear = info_node->info_linear;
1765         sub_id = dso->bpf_prog.sub_id;
1766
1767         info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1768         info.buffer_length = info_linear->info.jited_prog_len;
1769
1770         if (info_linear->info.nr_line_info)
1771                 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1772
1773         if (info_linear->info.btf_id) {
1774                 struct btf_node *node;
1775
1776                 node = perf_env__find_btf(dso->bpf_prog.env,
1777                                           info_linear->info.btf_id);
1778                 if (node)
1779                         btf = btf__new((__u8 *)(node->data),
1780                                        node->data_size);
1781         }
1782
1783         disassemble_init_for_target(&info);
1784
1785 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1786         disassemble = disassembler(info.arch,
1787                                    bfd_big_endian(bfdf),
1788                                    info.mach,
1789                                    bfdf);
1790 #else
1791         disassemble = disassembler(bfdf);
1792 #endif
1793         assert(disassemble);
1794
1795         fflush(s);
1796         do {
1797                 const struct bpf_line_info *linfo = NULL;
1798                 struct disasm_line *dl;
1799                 size_t prev_buf_size;
1800                 const char *srcline;
1801                 u64 addr;
1802
1803                 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1804                 count = disassemble(pc, &info);
1805
1806                 if (prog_linfo)
1807                         linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1808                                                                 addr, sub_id,
1809                                                                 nr_skip);
1810
1811                 if (linfo && btf) {
1812                         srcline = btf__name_by_offset(btf, linfo->line_off);
1813                         nr_skip++;
1814                 } else
1815                         srcline = NULL;
1816
1817                 fprintf(s, "\n");
1818                 prev_buf_size = buf_size;
1819                 fflush(s);
1820
1821                 if (!opts->hide_src_code && srcline) {
1822                         args->offset = -1;
1823                         args->line = strdup(srcline);
1824                         args->line_nr = 0;
1825                         args->ms.sym  = sym;
1826                         dl = disasm_line__new(args);
1827                         if (dl) {
1828                                 annotation_line__add(&dl->al,
1829                                                      &notes->src->source);
1830                         }
1831                 }
1832
1833                 args->offset = pc;
1834                 args->line = buf + prev_buf_size;
1835                 args->line_nr = 0;
1836                 args->ms.sym  = sym;
1837                 dl = disasm_line__new(args);
1838                 if (dl)
1839                         annotation_line__add(&dl->al, &notes->src->source);
1840
1841                 pc += count;
1842         } while (count > 0 && pc < len);
1843
1844         ret = 0;
1845 out:
1846         free(prog_linfo);
1847         free(btf);
1848         fclose(s);
1849         bfd_close(bfdf);
1850         return ret;
1851 }
1852 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1853 static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1854                                    struct annotate_args *args __maybe_unused)
1855 {
1856         return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1857 }
1858 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1859
1860 static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1861 {
1862         struct annotation_options *opts = args->options;
1863         struct map *map = args->ms.map;
1864         struct dso *dso = map->dso;
1865         char *command;
1866         FILE *file;
1867         char symfs_filename[PATH_MAX];
1868         struct kcore_extract kce;
1869         bool delete_extract = false;
1870         bool decomp = false;
1871         int stdout_fd[2];
1872         int lineno = 0;
1873         int nline;
1874         pid_t pid;
1875         int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1876
1877         if (err)
1878                 return err;
1879
1880         pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1881                  symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1882                  map->unmap_ip(map, sym->end));
1883
1884         pr_debug("annotating [%p] %30s : [%p] %30s\n",
1885                  dso, dso->long_name, sym, sym->name);
1886
1887         if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1888                 return symbol__disassemble_bpf(sym, args);
1889         } else if (dso__is_kcore(dso)) {
1890                 kce.kcore_filename = symfs_filename;
1891                 kce.addr = map__rip_2objdump(map, sym->start);
1892                 kce.offs = sym->start;
1893                 kce.len = sym->end - sym->start;
1894                 if (!kcore_extract__create(&kce)) {
1895                         delete_extract = true;
1896                         strlcpy(symfs_filename, kce.extract_filename,
1897                                 sizeof(symfs_filename));
1898                 }
1899         } else if (dso__needs_decompress(dso)) {
1900                 char tmp[KMOD_DECOMP_LEN];
1901
1902                 if (dso__decompress_kmodule_path(dso, symfs_filename,
1903                                                  tmp, sizeof(tmp)) < 0)
1904                         goto out;
1905
1906                 decomp = true;
1907                 strcpy(symfs_filename, tmp);
1908         }
1909
1910         err = asprintf(&command,
1911                  "%s %s%s --start-address=0x%016" PRIx64
1912                  " --stop-address=0x%016" PRIx64
1913                  " -l -d %s %s -C \"$1\" 2>/dev/null|grep -v \"$1:\"|expand",
1914                  opts->objdump_path ?: "objdump",
1915                  opts->disassembler_style ? "-M " : "",
1916                  opts->disassembler_style ?: "",
1917                  map__rip_2objdump(map, sym->start),
1918                  map__rip_2objdump(map, sym->end),
1919                  opts->show_asm_raw ? "" : "--no-show-raw",
1920                  opts->annotate_src ? "-S" : "");
1921
1922         if (err < 0) {
1923                 pr_err("Failure allocating memory for the command to run\n");
1924                 goto out_remove_tmp;
1925         }
1926
1927         pr_debug("Executing: %s\n", command);
1928
1929         err = -1;
1930         if (pipe(stdout_fd) < 0) {
1931                 pr_err("Failure creating the pipe to run %s\n", command);
1932                 goto out_free_command;
1933         }
1934
1935         pid = fork();
1936         if (pid < 0) {
1937                 pr_err("Failure forking to run %s\n", command);
1938                 goto out_close_stdout;
1939         }
1940
1941         if (pid == 0) {
1942                 close(stdout_fd[0]);
1943                 dup2(stdout_fd[1], 1);
1944                 close(stdout_fd[1]);
1945                 execl("/bin/sh", "sh", "-c", command, "--", symfs_filename,
1946                       NULL);
1947                 perror(command);
1948                 exit(-1);
1949         }
1950
1951         close(stdout_fd[1]);
1952
1953         file = fdopen(stdout_fd[0], "r");
1954         if (!file) {
1955                 pr_err("Failure creating FILE stream for %s\n", command);
1956                 /*
1957                  * If we were using debug info should retry with
1958                  * original binary.
1959                  */
1960                 goto out_free_command;
1961         }
1962
1963         nline = 0;
1964         while (!feof(file)) {
1965                 /*
1966                  * The source code line number (lineno) needs to be kept in
1967                  * across calls to symbol__parse_objdump_line(), so that it
1968                  * can associate it with the instructions till the next one.
1969                  * See disasm_line__new() and struct disasm_line::line_nr.
1970                  */
1971                 if (symbol__parse_objdump_line(sym, file, args, &lineno) < 0)
1972                         break;
1973                 nline++;
1974         }
1975
1976         if (nline == 0)
1977                 pr_err("No output from %s\n", command);
1978
1979         /*
1980          * kallsyms does not have symbol sizes so there may a nop at the end.
1981          * Remove it.
1982          */
1983         if (dso__is_kcore(dso))
1984                 delete_last_nop(sym);
1985
1986         fclose(file);
1987         err = 0;
1988 out_free_command:
1989         free(command);
1990 out_remove_tmp:
1991         close(stdout_fd[0]);
1992
1993         if (decomp)
1994                 unlink(symfs_filename);
1995
1996         if (delete_extract)
1997                 kcore_extract__delete(&kce);
1998 out:
1999         return err;
2000
2001 out_close_stdout:
2002         close(stdout_fd[1]);
2003         goto out_free_command;
2004 }
2005
2006 static void calc_percent(struct sym_hist *sym_hist,
2007                          struct hists *hists,
2008                          struct annotation_data *data,
2009                          s64 offset, s64 end)
2010 {
2011         unsigned int hits = 0;
2012         u64 period = 0;
2013
2014         while (offset < end) {
2015                 hits   += sym_hist->addr[offset].nr_samples;
2016                 period += sym_hist->addr[offset].period;
2017                 ++offset;
2018         }
2019
2020         if (sym_hist->nr_samples) {
2021                 data->he.period     = period;
2022                 data->he.nr_samples = hits;
2023                 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2024         }
2025
2026         if (hists->stats.nr_non_filtered_samples)
2027                 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2028
2029         if (sym_hist->period)
2030                 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2031
2032         if (hists->stats.total_period)
2033                 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2034 }
2035
2036 static void annotation__calc_percent(struct annotation *notes,
2037                                      struct evsel *leader, s64 len)
2038 {
2039         struct annotation_line *al, *next;
2040         struct evsel *evsel;
2041
2042         list_for_each_entry(al, &notes->src->source, node) {
2043                 s64 end;
2044                 int i = 0;
2045
2046                 if (al->offset == -1)
2047                         continue;
2048
2049                 next = annotation_line__next(al, &notes->src->source);
2050                 end  = next ? next->offset : len;
2051
2052                 for_each_group_evsel(evsel, leader) {
2053                         struct hists *hists = evsel__hists(evsel);
2054                         struct annotation_data *data;
2055                         struct sym_hist *sym_hist;
2056
2057                         BUG_ON(i >= al->data_nr);
2058
2059                         sym_hist = annotation__histogram(notes, evsel->idx);
2060                         data = &al->data[i++];
2061
2062                         calc_percent(sym_hist, hists, data, al->offset, end);
2063                 }
2064         }
2065 }
2066
2067 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
2068 {
2069         struct annotation *notes = symbol__annotation(sym);
2070
2071         annotation__calc_percent(notes, evsel, symbol__size(sym));
2072 }
2073
2074 int symbol__annotate(struct symbol *sym, struct map *map,
2075                      struct evsel *evsel, size_t privsize,
2076                      struct annotation_options *options,
2077                      struct arch **parch)
2078 {
2079         struct annotation *notes = symbol__annotation(sym);
2080         struct annotate_args args = {
2081                 .privsize       = privsize,
2082                 .evsel          = evsel,
2083                 .options        = options,
2084         };
2085         struct perf_env *env = perf_evsel__env(evsel);
2086         const char *arch_name = perf_env__arch(env);
2087         struct arch *arch;
2088         int err;
2089
2090         if (!arch_name)
2091                 return errno;
2092
2093         args.arch = arch = arch__find(arch_name);
2094         if (arch == NULL)
2095                 return ENOTSUP;
2096
2097         if (parch)
2098                 *parch = arch;
2099
2100         if (arch->init) {
2101                 err = arch->init(arch, env ? env->cpuid : NULL);
2102                 if (err) {
2103                         pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2104                         return err;
2105                 }
2106         }
2107
2108         args.ms.map = map;
2109         args.ms.sym = sym;
2110         notes->start = map__rip_2objdump(map, sym->start);
2111
2112         return symbol__disassemble(sym, &args);
2113 }
2114
2115 static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2116                                struct annotation_options *opts)
2117 {
2118         struct annotation_line *iter;
2119         struct rb_node **p = &root->rb_node;
2120         struct rb_node *parent = NULL;
2121         int i, ret;
2122
2123         while (*p != NULL) {
2124                 parent = *p;
2125                 iter = rb_entry(parent, struct annotation_line, rb_node);
2126
2127                 ret = strcmp(iter->path, al->path);
2128                 if (ret == 0) {
2129                         for (i = 0; i < al->data_nr; i++) {
2130                                 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2131                                                                                       opts->percent_type);
2132                         }
2133                         return;
2134                 }
2135
2136                 if (ret < 0)
2137                         p = &(*p)->rb_left;
2138                 else
2139                         p = &(*p)->rb_right;
2140         }
2141
2142         for (i = 0; i < al->data_nr; i++) {
2143                 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2144                                                                    opts->percent_type);
2145         }
2146
2147         rb_link_node(&al->rb_node, parent, p);
2148         rb_insert_color(&al->rb_node, root);
2149 }
2150
2151 static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2152 {
2153         int i;
2154
2155         for (i = 0; i < a->data_nr; i++) {
2156                 if (a->data[i].percent_sum == b->data[i].percent_sum)
2157                         continue;
2158                 return a->data[i].percent_sum > b->data[i].percent_sum;
2159         }
2160
2161         return 0;
2162 }
2163
2164 static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2165 {
2166         struct annotation_line *iter;
2167         struct rb_node **p = &root->rb_node;
2168         struct rb_node *parent = NULL;
2169
2170         while (*p != NULL) {
2171                 parent = *p;
2172                 iter = rb_entry(parent, struct annotation_line, rb_node);
2173
2174                 if (cmp_source_line(al, iter))
2175                         p = &(*p)->rb_left;
2176                 else
2177                         p = &(*p)->rb_right;
2178         }
2179
2180         rb_link_node(&al->rb_node, parent, p);
2181         rb_insert_color(&al->rb_node, root);
2182 }
2183
2184 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2185 {
2186         struct annotation_line *al;
2187         struct rb_node *node;
2188
2189         node = rb_first(src_root);
2190         while (node) {
2191                 struct rb_node *next;
2192
2193                 al = rb_entry(node, struct annotation_line, rb_node);
2194                 next = rb_next(node);
2195                 rb_erase(node, src_root);
2196
2197                 __resort_source_line(dest_root, al);
2198                 node = next;
2199         }
2200 }
2201
2202 static void print_summary(struct rb_root *root, const char *filename)
2203 {
2204         struct annotation_line *al;
2205         struct rb_node *node;
2206
2207         printf("\nSorted summary for file %s\n", filename);
2208         printf("----------------------------------------------\n\n");
2209
2210         if (RB_EMPTY_ROOT(root)) {
2211                 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2212                 return;
2213         }
2214
2215         node = rb_first(root);
2216         while (node) {
2217                 double percent, percent_max = 0.0;
2218                 const char *color;
2219                 char *path;
2220                 int i;
2221
2222                 al = rb_entry(node, struct annotation_line, rb_node);
2223                 for (i = 0; i < al->data_nr; i++) {
2224                         percent = al->data[i].percent_sum;
2225                         color = get_percent_color(percent);
2226                         color_fprintf(stdout, color, " %7.2f", percent);
2227
2228                         if (percent > percent_max)
2229                                 percent_max = percent;
2230                 }
2231
2232                 path = al->path;
2233                 color = get_percent_color(percent_max);
2234                 color_fprintf(stdout, color, " %s\n", path);
2235
2236                 node = rb_next(node);
2237         }
2238 }
2239
2240 static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
2241 {
2242         struct annotation *notes = symbol__annotation(sym);
2243         struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2244         u64 len = symbol__size(sym), offset;
2245
2246         for (offset = 0; offset < len; ++offset)
2247                 if (h->addr[offset].nr_samples != 0)
2248                         printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2249                                sym->start + offset, h->addr[offset].nr_samples);
2250         printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2251 }
2252
2253 static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2254 {
2255         char bf[32];
2256         struct annotation_line *line;
2257
2258         list_for_each_entry_reverse(line, lines, node) {
2259                 if (line->offset != -1)
2260                         return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2261         }
2262
2263         return 0;
2264 }
2265
2266 int symbol__annotate_printf(struct symbol *sym, struct map *map,
2267                             struct evsel *evsel,
2268                             struct annotation_options *opts)
2269 {
2270         struct dso *dso = map->dso;
2271         char *filename;
2272         const char *d_filename;
2273         const char *evsel_name = perf_evsel__name(evsel);
2274         struct annotation *notes = symbol__annotation(sym);
2275         struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2276         struct annotation_line *pos, *queue = NULL;
2277         u64 start = map__rip_2objdump(map, sym->start);
2278         int printed = 2, queue_len = 0, addr_fmt_width;
2279         int more = 0;
2280         bool context = opts->context;
2281         u64 len;
2282         int width = symbol_conf.show_total_period ? 12 : 8;
2283         int graph_dotted_len;
2284         char buf[512];
2285
2286         filename = strdup(dso->long_name);
2287         if (!filename)
2288                 return -ENOMEM;
2289
2290         if (opts->full_path)
2291                 d_filename = filename;
2292         else
2293                 d_filename = basename(filename);
2294
2295         len = symbol__size(sym);
2296
2297         if (perf_evsel__is_group_event(evsel)) {
2298                 width *= evsel->core.nr_members;
2299                 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2300                 evsel_name = buf;
2301         }
2302
2303         graph_dotted_len = printf(" %-*.*s|     Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2304                                   "percent: %s)\n",
2305                                   width, width, symbol_conf.show_total_period ? "Period" :
2306                                   symbol_conf.show_nr_samples ? "Samples" : "Percent",
2307                                   d_filename, evsel_name, h->nr_samples,
2308                                   percent_type_str(opts->percent_type));
2309
2310         printf("%-*.*s----\n",
2311                graph_dotted_len, graph_dotted_len, graph_dotted_line);
2312
2313         if (verbose > 0)
2314                 symbol__annotate_hits(sym, evsel);
2315
2316         addr_fmt_width = annotated_source__addr_fmt_width(&notes->src->source, start);
2317
2318         list_for_each_entry(pos, &notes->src->source, node) {
2319                 int err;
2320
2321                 if (context && queue == NULL) {
2322                         queue = pos;
2323                         queue_len = 0;
2324                 }
2325
2326                 err = annotation_line__print(pos, sym, start, evsel, len,
2327                                              opts->min_pcnt, printed, opts->max_lines,
2328                                              queue, addr_fmt_width, opts->percent_type);
2329
2330                 switch (err) {
2331                 case 0:
2332                         ++printed;
2333                         if (context) {
2334                                 printed += queue_len;
2335                                 queue = NULL;
2336                                 queue_len = 0;
2337                         }
2338                         break;
2339                 case 1:
2340                         /* filtered by max_lines */
2341                         ++more;
2342                         break;
2343                 case -1:
2344                 default:
2345                         /*
2346                          * Filtered by min_pcnt or non IP lines when
2347                          * context != 0
2348                          */
2349                         if (!context)
2350                                 break;
2351                         if (queue_len == context)
2352                                 queue = list_entry(queue->node.next, typeof(*queue), node);
2353                         else
2354                                 ++queue_len;
2355                         break;
2356                 }
2357         }
2358
2359         free(filename);
2360
2361         return more;
2362 }
2363
2364 static void FILE__set_percent_color(void *fp __maybe_unused,
2365                                     double percent __maybe_unused,
2366                                     bool current __maybe_unused)
2367 {
2368 }
2369
2370 static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2371                                          int nr __maybe_unused, bool current __maybe_unused)
2372 {
2373         return 0;
2374 }
2375
2376 static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2377 {
2378         return 0;
2379 }
2380
2381 static void FILE__printf(void *fp, const char *fmt, ...)
2382 {
2383         va_list args;
2384
2385         va_start(args, fmt);
2386         vfprintf(fp, fmt, args);
2387         va_end(args);
2388 }
2389
2390 static void FILE__write_graph(void *fp, int graph)
2391 {
2392         const char *s;
2393         switch (graph) {
2394
2395         case DARROW_CHAR: s = "↓"; break;
2396         case UARROW_CHAR: s = "↑"; break;
2397         case LARROW_CHAR: s = "←"; break;
2398         case RARROW_CHAR: s = "→"; break;
2399         default:                s = "?"; break;
2400         }
2401
2402         fputs(s, fp);
2403 }
2404
2405 static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2406                                      struct annotation_options *opts)
2407 {
2408         struct annotation *notes = symbol__annotation(sym);
2409         struct annotation_write_ops wops = {
2410                 .first_line              = true,
2411                 .obj                     = fp,
2412                 .set_color               = FILE__set_color,
2413                 .set_percent_color       = FILE__set_percent_color,
2414                 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2415                 .printf                  = FILE__printf,
2416                 .write_graph             = FILE__write_graph,
2417         };
2418         struct annotation_line *al;
2419
2420         list_for_each_entry(al, &notes->src->source, node) {
2421                 if (annotation_line__filter(al, notes))
2422                         continue;
2423                 annotation_line__write(al, notes, &wops, opts);
2424                 fputc('\n', fp);
2425                 wops.first_line = false;
2426         }
2427
2428         return 0;
2429 }
2430
2431 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
2432                                 struct annotation_options *opts)
2433 {
2434         const char *ev_name = perf_evsel__name(evsel);
2435         char buf[1024];
2436         char *filename;
2437         int err = -1;
2438         FILE *fp;
2439
2440         if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2441                 return -1;
2442
2443         fp = fopen(filename, "w");
2444         if (fp == NULL)
2445                 goto out_free_filename;
2446
2447         if (perf_evsel__is_group_event(evsel)) {
2448                 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2449                 ev_name = buf;
2450         }
2451
2452         fprintf(fp, "%s() %s\nEvent: %s\n\n",
2453                 ms->sym->name, ms->map->dso->long_name, ev_name);
2454         symbol__annotate_fprintf2(ms->sym, fp, opts);
2455
2456         fclose(fp);
2457         err = 0;
2458 out_free_filename:
2459         free(filename);
2460         return err;
2461 }
2462
2463 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2464 {
2465         struct annotation *notes = symbol__annotation(sym);
2466         struct sym_hist *h = annotation__histogram(notes, evidx);
2467
2468         memset(h, 0, notes->src->sizeof_sym_hist);
2469 }
2470
2471 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2472 {
2473         struct annotation *notes = symbol__annotation(sym);
2474         struct sym_hist *h = annotation__histogram(notes, evidx);
2475         int len = symbol__size(sym), offset;
2476
2477         h->nr_samples = 0;
2478         for (offset = 0; offset < len; ++offset) {
2479                 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2480                 h->nr_samples += h->addr[offset].nr_samples;
2481         }
2482 }
2483
2484 void annotated_source__purge(struct annotated_source *as)
2485 {
2486         struct annotation_line *al, *n;
2487
2488         list_for_each_entry_safe(al, n, &as->source, node) {
2489                 list_del_init(&al->node);
2490                 disasm_line__free(disasm_line(al));
2491         }
2492 }
2493
2494 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2495 {
2496         size_t printed;
2497
2498         if (dl->al.offset == -1)
2499                 return fprintf(fp, "%s\n", dl->al.line);
2500
2501         printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2502
2503         if (dl->ops.raw[0] != '\0') {
2504                 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2505                                    dl->ops.raw);
2506         }
2507
2508         return printed + fprintf(fp, "\n");
2509 }
2510
2511 size_t disasm__fprintf(struct list_head *head, FILE *fp)
2512 {
2513         struct disasm_line *pos;
2514         size_t printed = 0;
2515
2516         list_for_each_entry(pos, head, al.node)
2517                 printed += disasm_line__fprintf(pos, fp);
2518
2519         return printed;
2520 }
2521
2522 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2523 {
2524         if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2525             !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2526             dl->ops.target.offset >= (s64)symbol__size(sym))
2527                 return false;
2528
2529         return true;
2530 }
2531
2532 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2533 {
2534         u64 offset, size = symbol__size(sym);
2535
2536         /* PLT symbols contain external offsets */
2537         if (strstr(sym->name, "@plt"))
2538                 return;
2539
2540         for (offset = 0; offset < size; ++offset) {
2541                 struct annotation_line *al = notes->offsets[offset];
2542                 struct disasm_line *dl;
2543
2544                 dl = disasm_line(al);
2545
2546                 if (!disasm_line__is_valid_local_jump(dl, sym))
2547                         continue;
2548
2549                 al = notes->offsets[dl->ops.target.offset];
2550
2551                 /*
2552                  * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2553                  * have to adjust to the previous offset?
2554                  */
2555                 if (al == NULL)
2556                         continue;
2557
2558                 if (++al->jump_sources > notes->max_jump_sources)
2559                         notes->max_jump_sources = al->jump_sources;
2560
2561                 ++notes->nr_jumps;
2562         }
2563 }
2564
2565 void annotation__set_offsets(struct annotation *notes, s64 size)
2566 {
2567         struct annotation_line *al;
2568
2569         notes->max_line_len = 0;
2570
2571         list_for_each_entry(al, &notes->src->source, node) {
2572                 size_t line_len = strlen(al->line);
2573
2574                 if (notes->max_line_len < line_len)
2575                         notes->max_line_len = line_len;
2576                 al->idx = notes->nr_entries++;
2577                 if (al->offset != -1) {
2578                         al->idx_asm = notes->nr_asm_entries++;
2579                         /*
2580                          * FIXME: short term bandaid to cope with assembly
2581                          * routines that comes with labels in the same column
2582                          * as the address in objdump, sigh.
2583                          *
2584                          * E.g. copy_user_generic_unrolled
2585                          */
2586                         if (al->offset < size)
2587                                 notes->offsets[al->offset] = al;
2588                 } else
2589                         al->idx_asm = -1;
2590         }
2591 }
2592
2593 static inline int width_jumps(int n)
2594 {
2595         if (n >= 100)
2596                 return 5;
2597         if (n / 10)
2598                 return 2;
2599         return 1;
2600 }
2601
2602 static int annotation__max_ins_name(struct annotation *notes)
2603 {
2604         int max_name = 0, len;
2605         struct annotation_line *al;
2606
2607         list_for_each_entry(al, &notes->src->source, node) {
2608                 if (al->offset == -1)
2609                         continue;
2610
2611                 len = strlen(disasm_line(al)->ins.name);
2612                 if (max_name < len)
2613                         max_name = len;
2614         }
2615
2616         return max_name;
2617 }
2618
2619 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2620 {
2621         notes->widths.addr = notes->widths.target =
2622                 notes->widths.min_addr = hex_width(symbol__size(sym));
2623         notes->widths.max_addr = hex_width(sym->end);
2624         notes->widths.jumps = width_jumps(notes->max_jump_sources);
2625         notes->widths.max_ins_name = annotation__max_ins_name(notes);
2626 }
2627
2628 void annotation__update_column_widths(struct annotation *notes)
2629 {
2630         if (notes->options->use_offset)
2631                 notes->widths.target = notes->widths.min_addr;
2632         else
2633                 notes->widths.target = notes->widths.max_addr;
2634
2635         notes->widths.addr = notes->widths.target;
2636
2637         if (notes->options->show_nr_jumps)
2638                 notes->widths.addr += notes->widths.jumps + 1;
2639 }
2640
2641 static void annotation__calc_lines(struct annotation *notes, struct map *map,
2642                                    struct rb_root *root,
2643                                    struct annotation_options *opts)
2644 {
2645         struct annotation_line *al;
2646         struct rb_root tmp_root = RB_ROOT;
2647
2648         list_for_each_entry(al, &notes->src->source, node) {
2649                 double percent_max = 0.0;
2650                 int i;
2651
2652                 for (i = 0; i < al->data_nr; i++) {
2653                         double percent;
2654
2655                         percent = annotation_data__percent(&al->data[i],
2656                                                            opts->percent_type);
2657
2658                         if (percent > percent_max)
2659                                 percent_max = percent;
2660                 }
2661
2662                 if (percent_max <= 0.5)
2663                         continue;
2664
2665                 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2666                                        false, true, notes->start + al->offset);
2667                 insert_source_line(&tmp_root, al, opts);
2668         }
2669
2670         resort_source_line(root, &tmp_root);
2671 }
2672
2673 static void symbol__calc_lines(struct symbol *sym, struct map *map,
2674                                struct rb_root *root,
2675                                struct annotation_options *opts)
2676 {
2677         struct annotation *notes = symbol__annotation(sym);
2678
2679         annotation__calc_lines(notes, map, root, opts);
2680 }
2681
2682 int symbol__tty_annotate2(struct symbol *sym, struct map *map,
2683                           struct evsel *evsel,
2684                           struct annotation_options *opts)
2685 {
2686         struct dso *dso = map->dso;
2687         struct rb_root source_line = RB_ROOT;
2688         struct hists *hists = evsel__hists(evsel);
2689         char buf[1024];
2690
2691         if (symbol__annotate2(sym, map, evsel, opts, NULL) < 0)
2692                 return -1;
2693
2694         if (opts->print_lines) {
2695                 srcline_full_filename = opts->full_path;
2696                 symbol__calc_lines(sym, map, &source_line, opts);
2697                 print_summary(&source_line, dso->long_name);
2698         }
2699
2700         hists__scnprintf_title(hists, buf, sizeof(buf));
2701         fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2702                 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2703         symbol__annotate_fprintf2(sym, stdout, opts);
2704
2705         annotated_source__purge(symbol__annotation(sym)->src);
2706
2707         return 0;
2708 }
2709
2710 int symbol__tty_annotate(struct symbol *sym, struct map *map,
2711                          struct evsel *evsel,
2712                          struct annotation_options *opts)
2713 {
2714         struct dso *dso = map->dso;
2715         struct rb_root source_line = RB_ROOT;
2716
2717         if (symbol__annotate(sym, map, evsel, 0, opts, NULL) < 0)
2718                 return -1;
2719
2720         symbol__calc_percent(sym, evsel);
2721
2722         if (opts->print_lines) {
2723                 srcline_full_filename = opts->full_path;
2724                 symbol__calc_lines(sym, map, &source_line, opts);
2725                 print_summary(&source_line, dso->long_name);
2726         }
2727
2728         symbol__annotate_printf(sym, map, evsel, opts);
2729
2730         annotated_source__purge(symbol__annotation(sym)->src);
2731
2732         return 0;
2733 }
2734
2735 bool ui__has_annotation(void)
2736 {
2737         return use_browser == 1 && perf_hpp_list.sym;
2738 }
2739
2740
2741 static double annotation_line__max_percent(struct annotation_line *al,
2742                                            struct annotation *notes,
2743                                            unsigned int percent_type)
2744 {
2745         double percent_max = 0.0;
2746         int i;
2747
2748         for (i = 0; i < notes->nr_events; i++) {
2749                 double percent;
2750
2751                 percent = annotation_data__percent(&al->data[i],
2752                                                    percent_type);
2753
2754                 if (percent > percent_max)
2755                         percent_max = percent;
2756         }
2757
2758         return percent_max;
2759 }
2760
2761 static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2762                                void *obj, char *bf, size_t size,
2763                                void (*obj__printf)(void *obj, const char *fmt, ...),
2764                                void (*obj__write_graph)(void *obj, int graph))
2765 {
2766         if (dl->ins.ops && dl->ins.ops->scnprintf) {
2767                 if (ins__is_jump(&dl->ins)) {
2768                         bool fwd;
2769
2770                         if (dl->ops.target.outside)
2771                                 goto call_like;
2772                         fwd = dl->ops.target.offset > dl->al.offset;
2773                         obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2774                         obj__printf(obj, " ");
2775                 } else if (ins__is_call(&dl->ins)) {
2776 call_like:
2777                         obj__write_graph(obj, RARROW_CHAR);
2778                         obj__printf(obj, " ");
2779                 } else if (ins__is_ret(&dl->ins)) {
2780                         obj__write_graph(obj, LARROW_CHAR);
2781                         obj__printf(obj, " ");
2782                 } else {
2783                         obj__printf(obj, "  ");
2784                 }
2785         } else {
2786                 obj__printf(obj, "  ");
2787         }
2788
2789         disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2790 }
2791
2792 static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2793 {
2794         double ipc = 0.0, coverage = 0.0;
2795
2796         if (notes->hit_cycles)
2797                 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2798
2799         if (notes->total_insn) {
2800                 coverage = notes->cover_insn * 100.0 /
2801                         ((double)notes->total_insn);
2802         }
2803
2804         scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2805                   ipc, coverage);
2806 }
2807
2808 static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2809                                      bool first_line, bool current_entry, bool change_color, int width,
2810                                      void *obj, unsigned int percent_type,
2811                                      int  (*obj__set_color)(void *obj, int color),
2812                                      void (*obj__set_percent_color)(void *obj, double percent, bool current),
2813                                      int  (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2814                                      void (*obj__printf)(void *obj, const char *fmt, ...),
2815                                      void (*obj__write_graph)(void *obj, int graph))
2816
2817 {
2818         double percent_max = annotation_line__max_percent(al, notes, percent_type);
2819         int pcnt_width = annotation__pcnt_width(notes),
2820             cycles_width = annotation__cycles_width(notes);
2821         bool show_title = false;
2822         char bf[256];
2823         int printed;
2824
2825         if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2826                 if (notes->have_cycles) {
2827                         if (al->ipc == 0.0 && al->cycles == 0)
2828                                 show_title = true;
2829                 } else
2830                         show_title = true;
2831         }
2832
2833         if (al->offset != -1 && percent_max != 0.0) {
2834                 int i;
2835
2836                 for (i = 0; i < notes->nr_events; i++) {
2837                         double percent;
2838
2839                         percent = annotation_data__percent(&al->data[i], percent_type);
2840
2841                         obj__set_percent_color(obj, percent, current_entry);
2842                         if (notes->options->show_total_period) {
2843                                 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2844                         } else if (notes->options->show_nr_samples) {
2845                                 obj__printf(obj, "%6" PRIu64 " ",
2846                                                    al->data[i].he.nr_samples);
2847                         } else {
2848                                 obj__printf(obj, "%6.2f ", percent);
2849                         }
2850                 }
2851         } else {
2852                 obj__set_percent_color(obj, 0, current_entry);
2853
2854                 if (!show_title)
2855                         obj__printf(obj, "%-*s", pcnt_width, " ");
2856                 else {
2857                         obj__printf(obj, "%-*s", pcnt_width,
2858                                            notes->options->show_total_period ? "Period" :
2859                                            notes->options->show_nr_samples ? "Samples" : "Percent");
2860                 }
2861         }
2862
2863         if (notes->have_cycles) {
2864                 if (al->ipc)
2865                         obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2866                 else if (!show_title)
2867                         obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2868                 else
2869                         obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2870
2871                 if (!notes->options->show_minmax_cycle) {
2872                         if (al->cycles)
2873                                 obj__printf(obj, "%*" PRIu64 " ",
2874                                            ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2875                         else if (!show_title)
2876                                 obj__printf(obj, "%*s",
2877                                             ANNOTATION__CYCLES_WIDTH, " ");
2878                         else
2879                                 obj__printf(obj, "%*s ",
2880                                             ANNOTATION__CYCLES_WIDTH - 1,
2881                                             "Cycle");
2882                 } else {
2883                         if (al->cycles) {
2884                                 char str[32];
2885
2886                                 scnprintf(str, sizeof(str),
2887                                         "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2888                                         al->cycles, al->cycles_min,
2889                                         al->cycles_max);
2890
2891                                 obj__printf(obj, "%*s ",
2892                                             ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2893                                             str);
2894                         } else if (!show_title)
2895                                 obj__printf(obj, "%*s",
2896                                             ANNOTATION__MINMAX_CYCLES_WIDTH,
2897                                             " ");
2898                         else
2899                                 obj__printf(obj, "%*s ",
2900                                             ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2901                                             "Cycle(min/max)");
2902                 }
2903
2904                 if (show_title && !*al->line) {
2905                         ipc_coverage_string(bf, sizeof(bf), notes);
2906                         obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2907                 }
2908         }
2909
2910         obj__printf(obj, " ");
2911
2912         if (!*al->line)
2913                 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
2914         else if (al->offset == -1) {
2915                 if (al->line_nr && notes->options->show_linenr)
2916                         printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
2917                 else
2918                         printed = scnprintf(bf, sizeof(bf), "%-*s  ", notes->widths.addr, " ");
2919                 obj__printf(obj, bf);
2920                 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
2921         } else {
2922                 u64 addr = al->offset;
2923                 int color = -1;
2924
2925                 if (!notes->options->use_offset)
2926                         addr += notes->start;
2927
2928                 if (!notes->options->use_offset) {
2929                         printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
2930                 } else {
2931                         if (al->jump_sources &&
2932                             notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
2933                                 if (notes->options->show_nr_jumps) {
2934                                         int prev;
2935                                         printed = scnprintf(bf, sizeof(bf), "%*d ",
2936                                                             notes->widths.jumps,
2937                                                             al->jump_sources);
2938                                         prev = obj__set_jumps_percent_color(obj, al->jump_sources,
2939                                                                             current_entry);
2940                                         obj__printf(obj, bf);
2941                                         obj__set_color(obj, prev);
2942                                 }
2943 print_addr:
2944                                 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
2945                                                     notes->widths.target, addr);
2946                         } else if (ins__is_call(&disasm_line(al)->ins) &&
2947                                    notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
2948                                 goto print_addr;
2949                         } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
2950                                 goto print_addr;
2951                         } else {
2952                                 printed = scnprintf(bf, sizeof(bf), "%-*s  ",
2953                                                     notes->widths.addr, " ");
2954                         }
2955                 }
2956
2957                 if (change_color)
2958                         color = obj__set_color(obj, HE_COLORSET_ADDR);
2959                 obj__printf(obj, bf);
2960                 if (change_color)
2961                         obj__set_color(obj, color);
2962
2963                 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
2964
2965                 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
2966         }
2967
2968 }
2969
2970 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
2971                             struct annotation_write_ops *wops,
2972                             struct annotation_options *opts)
2973 {
2974         __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
2975                                  wops->change_color, wops->width, wops->obj,
2976                                  opts->percent_type,
2977                                  wops->set_color, wops->set_percent_color,
2978                                  wops->set_jumps_percent_color, wops->printf,
2979                                  wops->write_graph);
2980 }
2981
2982 int symbol__annotate2(struct symbol *sym, struct map *map, struct evsel *evsel,
2983                       struct annotation_options *options, struct arch **parch)
2984 {
2985         struct annotation *notes = symbol__annotation(sym);
2986         size_t size = symbol__size(sym);
2987         int nr_pcnt = 1, err;
2988
2989         notes->offsets = zalloc(size * sizeof(struct annotation_line *));
2990         if (notes->offsets == NULL)
2991                 return ENOMEM;
2992
2993         if (perf_evsel__is_group_event(evsel))
2994                 nr_pcnt = evsel->core.nr_members;
2995
2996         err = symbol__annotate(sym, map, evsel, 0, options, parch);
2997         if (err)
2998                 goto out_free_offsets;
2999
3000         notes->options = options;
3001
3002         symbol__calc_percent(sym, evsel);
3003
3004         annotation__set_offsets(notes, size);
3005         annotation__mark_jump_targets(notes, sym);
3006         annotation__compute_ipc(notes, size);
3007         annotation__init_column_widths(notes, sym);
3008         notes->nr_events = nr_pcnt;
3009
3010         annotation__update_column_widths(notes);
3011         sym->annotate2 = true;
3012
3013         return 0;
3014
3015 out_free_offsets:
3016         zfree(&notes->offsets);
3017         return err;
3018 }
3019
3020 #define ANNOTATION__CFG(n) \
3021         { .name = #n, .value = &annotation__default_options.n, }
3022
3023 /*
3024  * Keep the entries sorted, they are bsearch'ed
3025  */
3026 static struct annotation_config {
3027         const char *name;
3028         void *value;
3029 } annotation__configs[] = {
3030         ANNOTATION__CFG(hide_src_code),
3031         ANNOTATION__CFG(jump_arrows),
3032         ANNOTATION__CFG(offset_level),
3033         ANNOTATION__CFG(show_linenr),
3034         ANNOTATION__CFG(show_nr_jumps),
3035         ANNOTATION__CFG(show_nr_samples),
3036         ANNOTATION__CFG(show_total_period),
3037         ANNOTATION__CFG(use_offset),
3038 };
3039
3040 #undef ANNOTATION__CFG
3041
3042 static int annotation_config__cmp(const void *name, const void *cfgp)
3043 {
3044         const struct annotation_config *cfg = cfgp;
3045
3046         return strcmp(name, cfg->name);
3047 }
3048
3049 static int annotation__config(const char *var, const char *value,
3050                             void *data __maybe_unused)
3051 {
3052         struct annotation_config *cfg;
3053         const char *name;
3054
3055         if (!strstarts(var, "annotate."))
3056                 return 0;
3057
3058         name = var + 9;
3059         cfg = bsearch(name, annotation__configs, ARRAY_SIZE(annotation__configs),
3060                       sizeof(struct annotation_config), annotation_config__cmp);
3061
3062         if (cfg == NULL)
3063                 pr_debug("%s variable unknown, ignoring...", var);
3064         else if (strcmp(var, "annotate.offset_level") == 0) {
3065                 perf_config_int(cfg->value, name, value);
3066
3067                 if (*(int *)cfg->value > ANNOTATION__MAX_OFFSET_LEVEL)
3068                         *(int *)cfg->value = ANNOTATION__MAX_OFFSET_LEVEL;
3069                 else if (*(int *)cfg->value < ANNOTATION__MIN_OFFSET_LEVEL)
3070                         *(int *)cfg->value = ANNOTATION__MIN_OFFSET_LEVEL;
3071         } else {
3072                 *(bool *)cfg->value = perf_config_bool(name, value);
3073         }
3074         return 0;
3075 }
3076
3077 void annotation_config__init(void)
3078 {
3079         perf_config(annotation__config, NULL);
3080
3081         annotation__default_options.show_total_period = symbol_conf.show_total_period;
3082         annotation__default_options.show_nr_samples   = symbol_conf.show_nr_samples;
3083 }
3084
3085 static unsigned int parse_percent_type(char *str1, char *str2)
3086 {
3087         unsigned int type = (unsigned int) -1;
3088
3089         if (!strcmp("period", str1)) {
3090                 if (!strcmp("local", str2))
3091                         type = PERCENT_PERIOD_LOCAL;
3092                 else if (!strcmp("global", str2))
3093                         type = PERCENT_PERIOD_GLOBAL;
3094         }
3095
3096         if (!strcmp("hits", str1)) {
3097                 if (!strcmp("local", str2))
3098                         type = PERCENT_HITS_LOCAL;
3099                 else if (!strcmp("global", str2))
3100                         type = PERCENT_HITS_GLOBAL;
3101         }
3102
3103         return type;
3104 }
3105
3106 int annotate_parse_percent_type(const struct option *opt, const char *_str,
3107                                 int unset __maybe_unused)
3108 {
3109         struct annotation_options *opts = opt->value;
3110         unsigned int type;
3111         char *str1, *str2;
3112         int err = -1;
3113
3114         str1 = strdup(_str);
3115         if (!str1)
3116                 return -ENOMEM;
3117
3118         str2 = strchr(str1, '-');
3119         if (!str2)
3120                 goto out;
3121
3122         *str2++ = 0;
3123
3124         type = parse_percent_type(str1, str2);
3125         if (type == (unsigned int) -1)
3126                 type = parse_percent_type(str2, str1);
3127         if (type != (unsigned int) -1) {
3128                 opts->percent_type = type;
3129                 err = 0;
3130         }
3131
3132 out:
3133         free(str1);
3134         return err;
3135 }