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