tools/perf/util/annotate.c

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