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 "util.h"
  11 #include "ui/ui.h"
  12 #include "sort.h"
  13 #include "build-id.h"
  14 #include "color.h"
  15 #include "cache.h"
  16 #include "symbol.h"
  17 #include "debug.h"
  18 #include "annotate.h"
  19 #include "evsel.h"
  20 #include "block-range.h"
  21 #include <regex.h>
  22 #include <pthread.h>
  23 #include <linux/bitops.h>
  24
  25 const char      *disassembler_style;
  26 const char      *objdump_path;
  27 static regex_t   file_lineno;
  28
  29 static struct ins *ins__find(const char *name);
  30 static int disasm_line__parse(char *line, char **namep, char **rawp);
  31
  32 static void ins__delete(struct ins_operands *ops)
  33 {
  34         if (ops == NULL)
  35                 return;
  36         zfree(&ops->source.raw);
  37         zfree(&ops->source.name);
  38         zfree(&ops->target.raw);
  39         zfree(&ops->target.name);
  40 }
  41
  42 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
  43                               struct ins_operands *ops)
  44 {
  45         return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->raw);
  46 }
  47
  48 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
  49                   struct ins_operands *ops)
  50 {
  51         if (ins->ops->scnprintf)
  52                 return ins->ops->scnprintf(ins, bf, size, ops);
  53
  54         return ins__raw_scnprintf(ins, bf, size, ops);
  55 }
  56
  57 static int call__parse(struct ins_operands *ops, struct map *map)
  58 {
  59         char *endptr, *tok, *name;
  60
  61         ops->target.addr = strtoull(ops->raw, &endptr, 16);
  62
  63         name = strchr(endptr, '<');
  64         if (name == NULL)
  65                 goto indirect_call;
  66
  67         name++;
  68
  69 #ifdef __arm__
  70         if (strchr(name, '+'))
  71                 return -1;
  72 #endif
  73
  74         tok = strchr(name, '>');
  75         if (tok == NULL)
  76                 return -1;
  77
  78         *tok = '\0';
  79         ops->target.name = strdup(name);
  80         *tok = '>';
  81
  82         return ops->target.name == NULL ? -1 : 0;
  83
  84 indirect_call:
  85         tok = strchr(endptr, '*');
  86         if (tok == NULL) {
  87                 struct symbol *sym = map__find_symbol(map, map->map_ip(map, ops->target.addr));
  88                 if (sym != NULL)
  89                         ops->target.name = strdup(sym->name);
  90                 else
  91                         ops->target.addr = 0;
  92                 return 0;
  93         }
  94
  95         ops->target.addr = strtoull(tok + 1, NULL, 16);
  96         return 0;
  97 }
  98
  99 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
 100                            struct ins_operands *ops)
 101 {
 102         if (ops->target.name)
 103                 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
 104
 105         if (ops->target.addr == 0)
 106                 return ins__raw_scnprintf(ins, bf, size, ops);
 107
 108         return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
 109 }
 110
 111 static struct ins_ops call_ops = {
 112         .parse     = call__parse,
 113         .scnprintf = call__scnprintf,
 114 };
 115
 116 bool ins__is_call(const struct ins *ins)
 117 {
 118         return ins->ops == &call_ops;
 119 }
 120
 121 static int jump__parse(struct ins_operands *ops, struct map *map __maybe_unused)
 122 {
 123         const char *s = strchr(ops->raw, '+');
 124
 125         ops->target.addr = strtoull(ops->raw, NULL, 16);
 126
 127         if (s++ != NULL)
 128                 ops->target.offset = strtoull(s, NULL, 16);
 129         else
 130                 ops->target.offset = UINT64_MAX;
 131
 132         return 0;
 133 }
 134
 135 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
 136                            struct ins_operands *ops)
 137 {
 138         return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
 139 }
 140
 141 static struct ins_ops jump_ops = {
 142         .parse     = jump__parse,
 143         .scnprintf = jump__scnprintf,
 144 };
 145
 146 bool ins__is_jump(const struct ins *ins)
 147 {
 148         return ins->ops == &jump_ops;
 149 }
 150
 151 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
 152 {
 153         char *endptr, *name, *t;
 154
 155         if (strstr(raw, "(%rip)") == NULL)
 156                 return 0;
 157
 158         *addrp = strtoull(comment, &endptr, 16);
 159         name = strchr(endptr, '<');
 160         if (name == NULL)
 161                 return -1;
 162
 163         name++;
 164
 165         t = strchr(name, '>');
 166         if (t == NULL)
 167                 return 0;
 168
 169         *t = '\0';
 170         *namep = strdup(name);
 171         *t = '>';
 172
 173         return 0;
 174 }
 175
 176 static int lock__parse(struct ins_operands *ops, struct map *map)
 177 {
 178         char *name;
 179
 180         ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
 181         if (ops->locked.ops == NULL)
 182                 return 0;
 183
 184         if (disasm_line__parse(ops->raw, &name, &ops->locked.ops->raw) < 0)
 185                 goto out_free_ops;
 186
 187         ops->locked.ins = ins__find(name);
 188         free(name);
 189
 190         if (ops->locked.ins == NULL)
 191                 goto out_free_ops;
 192
 193         if (!ops->locked.ins->ops)
 194                 return 0;
 195
 196         if (ops->locked.ins->ops->parse &&
 197             ops->locked.ins->ops->parse(ops->locked.ops, map) < 0)
 198                 goto out_free_ops;
 199
 200         return 0;
 201
 202 out_free_ops:
 203         zfree(&ops->locked.ops);
 204         return 0;
 205 }
 206
 207 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
 208                            struct ins_operands *ops)
 209 {
 210         int printed;
 211
 212         if (ops->locked.ins == NULL)
 213                 return ins__raw_scnprintf(ins, bf, size, ops);
 214
 215         printed = scnprintf(bf, size, "%-6.6s ", ins->name);
 216         return printed + ins__scnprintf(ops->locked.ins, bf + printed,
 217                                         size - printed, ops->locked.ops);
 218 }
 219
 220 static void lock__delete(struct ins_operands *ops)
 221 {
 222         struct ins *ins = ops->locked.ins;
 223
 224         if (ins && ins->ops->free)
 225                 ins->ops->free(ops->locked.ops);
 226         else
 227                 ins__delete(ops->locked.ops);
 228
 229         zfree(&ops->locked.ops);
 230         zfree(&ops->target.raw);
 231         zfree(&ops->target.name);
 232 }
 233
 234 static struct ins_ops lock_ops = {
 235         .free      = lock__delete,
 236         .parse     = lock__parse,
 237         .scnprintf = lock__scnprintf,
 238 };
 239
 240 static int mov__parse(struct ins_operands *ops, struct map *map __maybe_unused)
 241 {
 242         char *s = strchr(ops->raw, ','), *target, *comment, prev;
 243
 244         if (s == NULL)
 245                 return -1;
 246
 247         *s = '\0';
 248         ops->source.raw = strdup(ops->raw);
 249         *s = ',';
 250
 251         if (ops->source.raw == NULL)
 252                 return -1;
 253
 254         target = ++s;
 255 #ifdef __arm__
 256         comment = strchr(s, ';');
 257 #else
 258         comment = strchr(s, '#');
 259 #endif
 260
 261         if (comment != NULL)
 262                 s = comment - 1;
 263         else
 264                 s = strchr(s, '\0') - 1;
 265
 266         while (s > target && isspace(s[0]))
 267                 --s;
 268         s++;
 269         prev = *s;
 270         *s = '\0';
 271
 272         ops->target.raw = strdup(target);
 273         *s = prev;
 274
 275         if (ops->target.raw == NULL)
 276                 goto out_free_source;
 277
 278         if (comment == NULL)
 279                 return 0;
 280
 281         while (comment[0] != '\0' && isspace(comment[0]))
 282                 ++comment;
 283
 284         comment__symbol(ops->source.raw, comment, &ops->source.addr, &ops->source.name);
 285         comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
 286
 287         return 0;
 288
 289 out_free_source:
 290         zfree(&ops->source.raw);
 291         return -1;
 292 }
 293
 294 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
 295                            struct ins_operands *ops)
 296 {
 297         return scnprintf(bf, size, "%-6.6s %s,%s", ins->name,
 298                          ops->source.name ?: ops->source.raw,
 299                          ops->target.name ?: ops->target.raw);
 300 }
 301
 302 static struct ins_ops mov_ops = {
 303         .parse     = mov__parse,
 304         .scnprintf = mov__scnprintf,
 305 };
 306
 307 static int dec__parse(struct ins_operands *ops, struct map *map __maybe_unused)
 308 {
 309         char *target, *comment, *s, prev;
 310
 311         target = s = ops->raw;
 312
 313         while (s[0] != '\0' && !isspace(s[0]))
 314                 ++s;
 315         prev = *s;
 316         *s = '\0';
 317
 318         ops->target.raw = strdup(target);
 319         *s = prev;
 320
 321         if (ops->target.raw == NULL)
 322                 return -1;
 323
 324         comment = strchr(s, '#');
 325         if (comment == NULL)
 326                 return 0;
 327
 328         while (comment[0] != '\0' && isspace(comment[0]))
 329                 ++comment;
 330
 331         comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
 332
 333         return 0;
 334 }
 335
 336 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
 337                            struct ins_operands *ops)
 338 {
 339         return scnprintf(bf, size, "%-6.6s %s", ins->name,
 340                          ops->target.name ?: ops->target.raw);
 341 }
 342
 343 static struct ins_ops dec_ops = {
 344         .parse     = dec__parse,
 345         .scnprintf = dec__scnprintf,
 346 };
 347
 348 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
 349                           struct ins_operands *ops __maybe_unused)
 350 {
 351         return scnprintf(bf, size, "%-6.6s", "nop");
 352 }
 353
 354 static struct ins_ops nop_ops = {
 355         .scnprintf = nop__scnprintf,
 356 };
 357
 358 static struct ins_ops ret_ops = {
 359         .scnprintf = ins__raw_scnprintf,
 360 };
 361
 362 bool ins__is_ret(const struct ins *ins)
 363 {
 364         return ins->ops == &ret_ops;
 365 }
 366
 367 static struct ins instructions[] = {
 368         { .name = "add",   .ops  = &mov_ops, },
 369         { .name = "addl",  .ops  = &mov_ops, },
 370         { .name = "addq",  .ops  = &mov_ops, },
 371         { .name = "addw",  .ops  = &mov_ops, },
 372         { .name = "and",   .ops  = &mov_ops, },
 373 #ifdef __arm__
 374         { .name = "b",     .ops  = &jump_ops, }, // might also be a call
 375         { .name = "bcc",   .ops  = &jump_ops, },
 376         { .name = "bcs",   .ops  = &jump_ops, },
 377         { .name = "beq",   .ops  = &jump_ops, },
 378         { .name = "bge",   .ops  = &jump_ops, },
 379         { .name = "bgt",   .ops  = &jump_ops, },
 380         { .name = "bhi",   .ops  = &jump_ops, },
 381         { .name = "bl",    .ops  = &call_ops, },
 382         { .name = "bls",   .ops  = &jump_ops, },
 383         { .name = "blt",   .ops  = &jump_ops, },
 384         { .name = "blx",   .ops  = &call_ops, },
 385         { .name = "bne",   .ops  = &jump_ops, },
 386 #endif
 387         { .name = "bts",   .ops  = &mov_ops, },
 388         { .name = "call",  .ops  = &call_ops, },
 389         { .name = "callq", .ops  = &call_ops, },
 390         { .name = "cmp",   .ops  = &mov_ops, },
 391         { .name = "cmpb",  .ops  = &mov_ops, },
 392         { .name = "cmpl",  .ops  = &mov_ops, },
 393         { .name = "cmpq",  .ops  = &mov_ops, },
 394         { .name = "cmpw",  .ops  = &mov_ops, },
 395         { .name = "cmpxch", .ops  = &mov_ops, },
 396         { .name = "dec",   .ops  = &dec_ops, },
 397         { .name = "decl",  .ops  = &dec_ops, },
 398         { .name = "imul",  .ops  = &mov_ops, },
 399         { .name = "inc",   .ops  = &dec_ops, },
 400         { .name = "incl",  .ops  = &dec_ops, },
 401         { .name = "ja",    .ops  = &jump_ops, },
 402         { .name = "jae",   .ops  = &jump_ops, },
 403         { .name = "jb",    .ops  = &jump_ops, },
 404         { .name = "jbe",   .ops  = &jump_ops, },
 405         { .name = "jc",    .ops  = &jump_ops, },
 406         { .name = "jcxz",  .ops  = &jump_ops, },
 407         { .name = "je",    .ops  = &jump_ops, },
 408         { .name = "jecxz", .ops  = &jump_ops, },
 409         { .name = "jg",    .ops  = &jump_ops, },
 410         { .name = "jge",   .ops  = &jump_ops, },
 411         { .name = "jl",    .ops  = &jump_ops, },
 412         { .name = "jle",   .ops  = &jump_ops, },
 413         { .name = "jmp",   .ops  = &jump_ops, },
 414         { .name = "jmpq",  .ops  = &jump_ops, },
 415         { .name = "jna",   .ops  = &jump_ops, },
 416         { .name = "jnae",  .ops  = &jump_ops, },
 417         { .name = "jnb",   .ops  = &jump_ops, },
 418         { .name = "jnbe",  .ops  = &jump_ops, },
 419         { .name = "jnc",   .ops  = &jump_ops, },
 420         { .name = "jne",   .ops  = &jump_ops, },
 421         { .name = "jng",   .ops  = &jump_ops, },
 422         { .name = "jnge",  .ops  = &jump_ops, },
 423         { .name = "jnl",   .ops  = &jump_ops, },
 424         { .name = "jnle",  .ops  = &jump_ops, },
 425         { .name = "jno",   .ops  = &jump_ops, },
 426         { .name = "jnp",   .ops  = &jump_ops, },
 427         { .name = "jns",   .ops  = &jump_ops, },
 428         { .name = "jnz",   .ops  = &jump_ops, },
 429         { .name = "jo",    .ops  = &jump_ops, },
 430         { .name = "jp",    .ops  = &jump_ops, },
 431         { .name = "jpe",   .ops  = &jump_ops, },
 432         { .name = "jpo",   .ops  = &jump_ops, },
 433         { .name = "jrcxz", .ops  = &jump_ops, },
 434         { .name = "js",    .ops  = &jump_ops, },
 435         { .name = "jz",    .ops  = &jump_ops, },
 436         { .name = "lea",   .ops  = &mov_ops, },
 437         { .name = "lock",  .ops  = &lock_ops, },
 438         { .name = "mov",   .ops  = &mov_ops, },
 439         { .name = "movb",  .ops  = &mov_ops, },
 440         { .name = "movdqa",.ops  = &mov_ops, },
 441         { .name = "movl",  .ops  = &mov_ops, },
 442         { .name = "movq",  .ops  = &mov_ops, },
 443         { .name = "movslq", .ops  = &mov_ops, },
 444         { .name = "movzbl", .ops  = &mov_ops, },
 445         { .name = "movzwl", .ops  = &mov_ops, },
 446         { .name = "nop",   .ops  = &nop_ops, },
 447         { .name = "nopl",  .ops  = &nop_ops, },
 448         { .name = "nopw",  .ops  = &nop_ops, },
 449         { .name = "or",    .ops  = &mov_ops, },
 450         { .name = "orl",   .ops  = &mov_ops, },
 451         { .name = "test",  .ops  = &mov_ops, },
 452         { .name = "testb", .ops  = &mov_ops, },
 453         { .name = "testl", .ops  = &mov_ops, },
 454         { .name = "xadd",  .ops  = &mov_ops, },
 455         { .name = "xbeginl", .ops  = &jump_ops, },
 456         { .name = "xbeginq", .ops  = &jump_ops, },
 457         { .name = "retq",  .ops  = &ret_ops, },
 458 };
 459
 460 static int ins__key_cmp(const void *name, const void *insp)
 461 {
 462         const struct ins *ins = insp;
 463
 464         return strcmp(name, ins->name);
 465 }
 466
 467 static int ins__cmp(const void *a, const void *b)
 468 {
 469         const struct ins *ia = a;
 470         const struct ins *ib = b;
 471
 472         return strcmp(ia->name, ib->name);
 473 }
 474
 475 static void ins__sort(void)
 476 {
 477         const int nmemb = ARRAY_SIZE(instructions);
 478
 479         qsort(instructions, nmemb, sizeof(struct ins), ins__cmp);
 480 }
 481
 482 static struct ins *ins__find(const char *name)
 483 {
 484         const int nmemb = ARRAY_SIZE(instructions);
 485         static bool sorted;
 486
 487         if (!sorted) {
 488                 ins__sort();
 489                 sorted = true;
 490         }
 491
 492         return bsearch(name, instructions, nmemb, sizeof(struct ins), ins__key_cmp);
 493 }
 494
 495 int symbol__alloc_hist(struct symbol *sym)
 496 {
 497         struct annotation *notes = symbol__annotation(sym);
 498         const size_t size = symbol__size(sym);
 499         size_t sizeof_sym_hist;
 500
 501         /* Check for overflow when calculating sizeof_sym_hist */
 502         if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(u64))
 503                 return -1;
 504
 505         sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(u64));
 506
 507         /* Check for overflow in zalloc argument */
 508         if (sizeof_sym_hist > (SIZE_MAX - sizeof(*notes->src))
 509                                 / symbol_conf.nr_events)
 510                 return -1;
 511
 512         notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
 513         if (notes->src == NULL)
 514                 return -1;
 515         notes->src->sizeof_sym_hist = sizeof_sym_hist;
 516         notes->src->nr_histograms   = symbol_conf.nr_events;
 517         INIT_LIST_HEAD(&notes->src->source);
 518         return 0;
 519 }
 520
 521 /* The cycles histogram is lazily allocated. */
 522 static int symbol__alloc_hist_cycles(struct symbol *sym)
 523 {
 524         struct annotation *notes = symbol__annotation(sym);
 525         const size_t size = symbol__size(sym);
 526
 527         notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
 528         if (notes->src->cycles_hist == NULL)
 529                 return -1;
 530         return 0;
 531 }
 532
 533 void symbol__annotate_zero_histograms(struct symbol *sym)
 534 {
 535         struct annotation *notes = symbol__annotation(sym);
 536
 537         pthread_mutex_lock(&notes->lock);
 538         if (notes->src != NULL) {
 539                 memset(notes->src->histograms, 0,
 540                        notes->src->nr_histograms * notes->src->sizeof_sym_hist);
 541                 if (notes->src->cycles_hist)
 542                         memset(notes->src->cycles_hist, 0,
 543                                 symbol__size(sym) * sizeof(struct cyc_hist));
 544         }
 545         pthread_mutex_unlock(&notes->lock);
 546 }
 547
 548 static int __symbol__account_cycles(struct annotation *notes,
 549                                     u64 start,
 550                                     unsigned offset, unsigned cycles,
 551                                     unsigned have_start)
 552 {
 553         struct cyc_hist *ch;
 554
 555         ch = notes->src->cycles_hist;
 556         /*
 557          * For now we can only account one basic block per
 558          * final jump. But multiple could be overlapping.
 559          * Always account the longest one. So when
 560          * a shorter one has been already seen throw it away.
 561          *
 562          * We separately always account the full cycles.
 563          */
 564         ch[offset].num_aggr++;
 565         ch[offset].cycles_aggr += cycles;
 566
 567         if (!have_start && ch[offset].have_start)
 568                 return 0;
 569         if (ch[offset].num) {
 570                 if (have_start && (!ch[offset].have_start ||
 571                                    ch[offset].start > start)) {
 572                         ch[offset].have_start = 0;
 573                         ch[offset].cycles = 0;
 574                         ch[offset].num = 0;
 575                         if (ch[offset].reset < 0xffff)
 576                                 ch[offset].reset++;
 577                 } else if (have_start &&
 578                            ch[offset].start < start)
 579                         return 0;
 580         }
 581         ch[offset].have_start = have_start;
 582         ch[offset].start = start;
 583         ch[offset].cycles += cycles;
 584         ch[offset].num++;
 585         return 0;
 586 }
 587
 588 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
 589                                       struct annotation *notes, int evidx, u64 addr)
 590 {
 591         unsigned offset;
 592         struct sym_hist *h;
 593
 594         pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
 595
 596         if (addr < sym->start || addr >= sym->end) {
 597                 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
 598                        __func__, __LINE__, sym->name, sym->start, addr, sym->end);
 599                 return -ERANGE;
 600         }
 601
 602         offset = addr - sym->start;
 603         h = annotation__histogram(notes, evidx);
 604         h->sum++;
 605         h->addr[offset]++;
 606
 607         pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
 608                   ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
 609                   addr, addr - sym->start, evidx, h->addr[offset]);
 610         return 0;
 611 }
 612
 613 static struct annotation *symbol__get_annotation(struct symbol *sym, bool cycles)
 614 {
 615         struct annotation *notes = symbol__annotation(sym);
 616
 617         if (notes->src == NULL) {
 618                 if (symbol__alloc_hist(sym) < 0)
 619                         return NULL;
 620         }
 621         if (!notes->src->cycles_hist && cycles) {
 622                 if (symbol__alloc_hist_cycles(sym) < 0)
 623                         return NULL;
 624         }
 625         return notes;
 626 }
 627
 628 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
 629                                     int evidx, u64 addr)
 630 {
 631         struct annotation *notes;
 632
 633         if (sym == NULL)
 634                 return 0;
 635         notes = symbol__get_annotation(sym, false);
 636         if (notes == NULL)
 637                 return -ENOMEM;
 638         return __symbol__inc_addr_samples(sym, map, notes, evidx, addr);
 639 }
 640
 641 static int symbol__account_cycles(u64 addr, u64 start,
 642                                   struct symbol *sym, unsigned cycles)
 643 {
 644         struct annotation *notes;
 645         unsigned offset;
 646
 647         if (sym == NULL)
 648                 return 0;
 649         notes = symbol__get_annotation(sym, true);
 650         if (notes == NULL)
 651                 return -ENOMEM;
 652         if (addr < sym->start || addr >= sym->end)
 653                 return -ERANGE;
 654
 655         if (start) {
 656                 if (start < sym->start || start >= sym->end)
 657                         return -ERANGE;
 658                 if (start >= addr)
 659                         start = 0;
 660         }
 661         offset = addr - sym->start;
 662         return __symbol__account_cycles(notes,
 663                                         start ? start - sym->start : 0,
 664                                         offset, cycles,
 665                                         !!start);
 666 }
 667
 668 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
 669                                     struct addr_map_symbol *start,
 670                                     unsigned cycles)
 671 {
 672         u64 saddr = 0;
 673         int err;
 674
 675         if (!cycles)
 676                 return 0;
 677
 678         /*
 679          * Only set start when IPC can be computed. We can only
 680          * compute it when the basic block is completely in a single
 681          * function.
 682          * Special case the case when the jump is elsewhere, but
 683          * it starts on the function start.
 684          */
 685         if (start &&
 686                 (start->sym == ams->sym ||
 687                  (ams->sym &&
 688                    start->addr == ams->sym->start + ams->map->start)))
 689                 saddr = start->al_addr;
 690         if (saddr == 0)
 691                 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
 692                         ams->addr,
 693                         start ? start->addr : 0,
 694                         ams->sym ? ams->sym->start + ams->map->start : 0,
 695                         saddr);
 696         err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
 697         if (err)
 698                 pr_debug2("account_cycles failed %d\n", err);
 699         return err;
 700 }
 701
 702 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx)
 703 {
 704         return symbol__inc_addr_samples(ams->sym, ams->map, evidx, ams->al_addr);
 705 }
 706
 707 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 ip)
 708 {
 709         return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evidx, ip);
 710 }
 711
 712 static void disasm_line__init_ins(struct disasm_line *dl, struct map *map)
 713 {
 714         dl->ins = ins__find(dl->name);
 715
 716         if (dl->ins == NULL)
 717                 return;
 718
 719         if (!dl->ins->ops)
 720                 return;
 721
 722         if (dl->ins->ops->parse && dl->ins->ops->parse(&dl->ops, map) < 0)
 723                 dl->ins = NULL;
 724 }
 725
 726 static int disasm_line__parse(char *line, char **namep, char **rawp)
 727 {
 728         char *name = line, tmp;
 729
 730         while (isspace(name[0]))
 731                 ++name;
 732
 733         if (name[0] == '\0')
 734                 return -1;
 735
 736         *rawp = name + 1;
 737
 738         while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
 739                 ++*rawp;
 740
 741         tmp = (*rawp)[0];
 742         (*rawp)[0] = '\0';
 743         *namep = strdup(name);
 744
 745         if (*namep == NULL)
 746                 goto out_free_name;
 747
 748         (*rawp)[0] = tmp;
 749
 750         if ((*rawp)[0] != '\0') {
 751                 (*rawp)++;
 752                 while (isspace((*rawp)[0]))
 753                         ++(*rawp);
 754         }
 755
 756         return 0;
 757
 758 out_free_name:
 759         zfree(namep);
 760         return -1;
 761 }
 762
 763 static struct disasm_line *disasm_line__new(s64 offset, char *line,
 764                                             size_t privsize, int line_nr,
 765                                             struct map *map)
 766 {
 767         struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
 768
 769         if (dl != NULL) {
 770                 dl->offset = offset;
 771                 dl->line = strdup(line);
 772                 dl->line_nr = line_nr;
 773                 if (dl->line == NULL)
 774                         goto out_delete;
 775
 776                 if (offset != -1) {
 777                         if (disasm_line__parse(dl->line, &dl->name, &dl->ops.raw) < 0)
 778                                 goto out_free_line;
 779
 780                         disasm_line__init_ins(dl, map);
 781                 }
 782         }
 783
 784         return dl;
 785
 786 out_free_line:
 787         zfree(&dl->line);
 788 out_delete:
 789         free(dl);
 790         return NULL;
 791 }
 792
 793 void disasm_line__free(struct disasm_line *dl)
 794 {
 795         zfree(&dl->line);
 796         zfree(&dl->name);
 797         if (dl->ins && dl->ins->ops->free)
 798                 dl->ins->ops->free(&dl->ops);
 799         else
 800                 ins__delete(&dl->ops);
 801         free(dl);
 802 }
 803
 804 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
 805 {
 806         if (raw || !dl->ins)
 807                 return scnprintf(bf, size, "%-6.6s %s", dl->name, dl->ops.raw);
 808
 809         return ins__scnprintf(dl->ins, bf, size, &dl->ops);
 810 }
 811
 812 static void disasm__add(struct list_head *head, struct disasm_line *line)
 813 {
 814         list_add_tail(&line->node, head);
 815 }
 816
 817 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
 818 {
 819         list_for_each_entry_continue(pos, head, node)
 820                 if (pos->offset >= 0)
 821                         return pos;
 822
 823         return NULL;
 824 }
 825
 826 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
 827                             s64 end, const char **path, u64 *nr_samples)
 828 {
 829         struct source_line *src_line = notes->src->lines;
 830         double percent = 0.0;
 831         *nr_samples = 0;
 832
 833         if (src_line) {
 834                 size_t sizeof_src_line = sizeof(*src_line) +
 835                                 sizeof(src_line->samples) * (src_line->nr_pcnt - 1);
 836
 837                 while (offset < end) {
 838                         src_line = (void *)notes->src->lines +
 839                                         (sizeof_src_line * offset);
 840
 841                         if (*path == NULL)
 842                                 *path = src_line->path;
 843
 844                         percent += src_line->samples[evidx].percent;
 845                         *nr_samples += src_line->samples[evidx].nr;
 846                         offset++;
 847                 }
 848         } else {
 849                 struct sym_hist *h = annotation__histogram(notes, evidx);
 850                 unsigned int hits = 0;
 851
 852                 while (offset < end)
 853                         hits += h->addr[offset++];
 854
 855                 if (h->sum) {
 856                         *nr_samples = hits;
 857                         percent = 100.0 * hits / h->sum;
 858                 }
 859         }
 860
 861         return percent;
 862 }
 863
 864 static const char *annotate__address_color(struct block_range *br)
 865 {
 866         double cov = block_range__coverage(br);
 867
 868         if (cov >= 0) {
 869                 /* mark red for >75% coverage */
 870                 if (cov > 0.75)
 871                         return PERF_COLOR_RED;
 872
 873                 /* mark dull for <1% coverage */
 874                 if (cov < 0.01)
 875                         return PERF_COLOR_NORMAL;
 876         }
 877
 878         return PERF_COLOR_MAGENTA;
 879 }
 880
 881 static const char *annotate__asm_color(struct block_range *br)
 882 {
 883         double cov = block_range__coverage(br);
 884
 885         if (cov >= 0) {
 886                 /* mark dull for <1% coverage */
 887                 if (cov < 0.01)
 888                         return PERF_COLOR_NORMAL;
 889         }
 890
 891         return PERF_COLOR_BLUE;
 892 }
 893
 894 static void annotate__branch_printf(struct block_range *br, u64 addr)
 895 {
 896         bool emit_comment = true;
 897
 898         if (!br)
 899                 return;
 900
 901 #if 1
 902         if (br->is_target && br->start == addr) {
 903                 struct block_range *branch = br;
 904                 double p;
 905
 906                 /*
 907                  * Find matching branch to our target.
 908                  */
 909                 while (!branch->is_branch)
 910                         branch = block_range__next(branch);
 911
 912                 p = 100 *(double)br->entry / branch->coverage;
 913
 914                 if (p > 0.1) {
 915                         if (emit_comment) {
 916                                 emit_comment = false;
 917                                 printf("\t#");
 918                         }
 919
 920                         /*
 921                          * The percentage of coverage joined at this target in relation
 922                          * to the next branch.
 923                          */
 924                         printf(" +%.2f%%", p);
 925                 }
 926         }
 927 #endif
 928         if (br->is_branch && br->end == addr) {
 929                 double p = 100*(double)br->taken / br->coverage;
 930
 931                 if (p > 0.1) {
 932                         if (emit_comment) {
 933                                 emit_comment = false;
 934                                 printf("\t#");
 935                         }
 936
 937                         /*
 938                          * The percentage of coverage leaving at this branch, and
 939                          * its prediction ratio.
 940                          */
 941                         printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred  / br->taken);
 942                 }
 943         }
 944 }
 945
 946
 947 static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
 948                       struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
 949                       int max_lines, struct disasm_line *queue)
 950 {
 951         static const char *prev_line;
 952         static const char *prev_color;
 953
 954         if (dl->offset != -1) {
 955                 const char *path = NULL;
 956                 u64 nr_samples;
 957                 double percent, max_percent = 0.0;
 958                 double *ppercents = &percent;
 959                 u64 *psamples = &nr_samples;
 960                 int i, nr_percent = 1;
 961                 const char *color;
 962                 struct annotation *notes = symbol__annotation(sym);
 963                 s64 offset = dl->offset;
 964                 const u64 addr = start + offset;
 965                 struct disasm_line *next;
 966                 struct block_range *br;
 967
 968                 next = disasm__get_next_ip_line(&notes->src->source, dl);
 969
 970                 if (perf_evsel__is_group_event(evsel)) {
 971                         nr_percent = evsel->nr_members;
 972                         ppercents = calloc(nr_percent, sizeof(double));
 973                         psamples = calloc(nr_percent, sizeof(u64));
 974                         if (ppercents == NULL || psamples == NULL) {
 975                                 return -1;
 976                         }
 977                 }
 978
 979                 for (i = 0; i < nr_percent; i++) {
 980                         percent = disasm__calc_percent(notes,
 981                                         notes->src->lines ? i : evsel->idx + i,
 982                                         offset,
 983                                         next ? next->offset : (s64) len,
 984                                         &path, &nr_samples);
 985
 986                         ppercents[i] = percent;
 987                         psamples[i] = nr_samples;
 988                         if (percent > max_percent)
 989                                 max_percent = percent;
 990                 }
 991
 992                 if (max_percent < min_pcnt)
 993                         return -1;
 994
 995                 if (max_lines && printed >= max_lines)
 996                         return 1;
 997
 998                 if (queue != NULL) {
 999                         list_for_each_entry_from(queue, &notes->src->source, node) {
1000                                 if (queue == dl)
1001                                         break;
1002                                 disasm_line__print(queue, sym, start, evsel, len,
1003                                                     0, 0, 1, NULL);
1004                         }
1005                 }
1006
1007                 color = get_percent_color(max_percent);
1008
1009                 /*
1010                  * Also color the filename and line if needed, with
1011                  * the same color than the percentage. Don't print it
1012                  * twice for close colored addr with the same filename:line
1013                  */
1014                 if (path) {
1015                         if (!prev_line || strcmp(prev_line, path)
1016                                        || color != prev_color) {
1017                                 color_fprintf(stdout, color, " %s", path);
1018                                 prev_line = path;
1019                                 prev_color = color;
1020                         }
1021                 }
1022
1023                 for (i = 0; i < nr_percent; i++) {
1024                         percent = ppercents[i];
1025                         nr_samples = psamples[i];
1026                         color = get_percent_color(percent);
1027
1028                         if (symbol_conf.show_total_period)
1029                                 color_fprintf(stdout, color, " %7" PRIu64,
1030                                               nr_samples);
1031                         else
1032                                 color_fprintf(stdout, color, " %7.2f", percent);
1033                 }
1034
1035                 printf(" :      ");
1036
1037                 br = block_range__find(addr);
1038                 color_fprintf(stdout, annotate__address_color(br), "  %" PRIx64 ":", addr);
1039                 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->line);
1040                 annotate__branch_printf(br, addr);
1041                 printf("\n");
1042
1043                 if (ppercents != &percent)
1044                         free(ppercents);
1045
1046                 if (psamples != &nr_samples)
1047                         free(psamples);
1048
1049         } else if (max_lines && printed >= max_lines)
1050                 return 1;
1051         else {
1052                 int width = 8;
1053
1054                 if (queue)
1055                         return -1;
1056
1057                 if (perf_evsel__is_group_event(evsel))
1058                         width *= evsel->nr_members;
1059
1060                 if (!*dl->line)
1061                         printf(" %*s:\n", width, " ");
1062                 else
1063                         printf(" %*s:   %s\n", width, " ", dl->line);
1064         }
1065
1066         return 0;
1067 }
1068
1069 /*
1070  * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1071  * which looks like following
1072  *
1073  *  0000000000415500 <_init>:
1074  *    415500:       sub    $0x8,%rsp
1075  *    415504:       mov    0x2f5ad5(%rip),%rax        # 70afe0 <_DYNAMIC+0x2f8>
1076  *    41550b:       test   %rax,%rax
1077  *    41550e:       je     415515 <_init+0x15>
1078  *    415510:       callq  416e70 <__gmon_start__@plt>
1079  *    415515:       add    $0x8,%rsp
1080  *    415519:       retq
1081  *
1082  * it will be parsed and saved into struct disasm_line as
1083  *  <offset>       <name>  <ops.raw>
1084  *
1085  * The offset will be a relative offset from the start of the symbol and -1
1086  * means that it's not a disassembly line so should be treated differently.
1087  * The ops.raw part will be parsed further according to type of the instruction.
1088  */
1089 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
1090                                       FILE *file, size_t privsize,
1091                                       int *line_nr)
1092 {
1093         struct annotation *notes = symbol__annotation(sym);
1094         struct disasm_line *dl;
1095         char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
1096         size_t line_len;
1097         s64 line_ip, offset = -1;
1098         regmatch_t match[2];
1099
1100         if (getline(&line, &line_len, file) < 0)
1101                 return -1;
1102
1103         if (!line)
1104                 return -1;
1105
1106         while (line_len != 0 && isspace(line[line_len - 1]))
1107                 line[--line_len] = '\0';
1108
1109         c = strchr(line, '\n');
1110         if (c)
1111                 *c = 0;
1112
1113         line_ip = -1;
1114         parsed_line = line;
1115
1116         /* /filename:linenr ? Save line number and ignore. */
1117         if (regexec(&file_lineno, line, 2, match, 0) == 0) {
1118                 *line_nr = atoi(line + match[1].rm_so);
1119                 return 0;
1120         }
1121
1122         /*
1123          * Strip leading spaces:
1124          */
1125         tmp = line;
1126         while (*tmp) {
1127                 if (*tmp != ' ')
1128                         break;
1129                 tmp++;
1130         }
1131
1132         if (*tmp) {
1133                 /*
1134                  * Parse hexa addresses followed by ':'
1135                  */
1136                 line_ip = strtoull(tmp, &tmp2, 16);
1137                 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1138                         line_ip = -1;
1139         }
1140
1141         if (line_ip != -1) {
1142                 u64 start = map__rip_2objdump(map, sym->start),
1143                     end = map__rip_2objdump(map, sym->end);
1144
1145                 offset = line_ip - start;
1146                 if ((u64)line_ip < start || (u64)line_ip >= end)
1147                         offset = -1;
1148                 else
1149                         parsed_line = tmp2 + 1;
1150         }
1151
1152         dl = disasm_line__new(offset, parsed_line, privsize, *line_nr, map);
1153         free(line);
1154         (*line_nr)++;
1155
1156         if (dl == NULL)
1157                 return -1;
1158
1159         if (dl->ops.target.offset == UINT64_MAX)
1160                 dl->ops.target.offset = dl->ops.target.addr -
1161                                         map__rip_2objdump(map, sym->start);
1162
1163         /* kcore has no symbols, so add the call target name */
1164         if (dl->ins && ins__is_call(dl->ins) && !dl->ops.target.name) {
1165                 struct addr_map_symbol target = {
1166                         .map = map,
1167                         .addr = dl->ops.target.addr,
1168                 };
1169
1170                 if (!map_groups__find_ams(&target) &&
1171                     target.sym->start == target.al_addr)
1172                         dl->ops.target.name = strdup(target.sym->name);
1173         }
1174
1175         disasm__add(&notes->src->source, dl);
1176
1177         return 0;
1178 }
1179
1180 static __attribute__((constructor)) void symbol__init_regexpr(void)
1181 {
1182         regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1183 }
1184
1185 static void delete_last_nop(struct symbol *sym)
1186 {
1187         struct annotation *notes = symbol__annotation(sym);
1188         struct list_head *list = &notes->src->source;
1189         struct disasm_line *dl;
1190
1191         while (!list_empty(list)) {
1192                 dl = list_entry(list->prev, struct disasm_line, node);
1193
1194                 if (dl->ins && dl->ins->ops) {
1195                         if (dl->ins->ops != &nop_ops)
1196                                 return;
1197                 } else {
1198                         if (!strstr(dl->line, " nop ") &&
1199                             !strstr(dl->line, " nopl ") &&
1200                             !strstr(dl->line, " nopw "))
1201                                 return;
1202                 }
1203
1204                 list_del(&dl->node);
1205                 disasm_line__free(dl);
1206         }
1207 }
1208
1209 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1210                               int errnum, char *buf, size_t buflen)
1211 {
1212         struct dso *dso = map->dso;
1213
1214         BUG_ON(buflen == 0);
1215
1216         if (errnum >= 0) {
1217                 str_error_r(errnum, buf, buflen);
1218                 return 0;
1219         }
1220
1221         switch (errnum) {
1222         case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1223                 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1224                 char *build_id_msg = NULL;
1225
1226                 if (dso->has_build_id) {
1227                         build_id__sprintf(dso->build_id,
1228                                           sizeof(dso->build_id), bf + 15);
1229                         build_id_msg = bf;
1230                 }
1231                 scnprintf(buf, buflen,
1232                           "No vmlinux file%s\nwas found in the path.\n\n"
1233                           "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1234                           "Please use:\n\n"
1235                           "  perf buildid-cache -vu vmlinux\n\n"
1236                           "or:\n\n"
1237                           "  --vmlinux vmlinux\n", build_id_msg ?: "");
1238         }
1239                 break;
1240         default:
1241                 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1242                 break;
1243         }
1244
1245         return 0;
1246 }
1247
1248 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1249 {
1250         char linkname[PATH_MAX];
1251         char *build_id_filename;
1252
1253         if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1254             !dso__is_kcore(dso))
1255                 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1256
1257         build_id_filename = dso__build_id_filename(dso, NULL, 0);
1258         if (build_id_filename) {
1259                 __symbol__join_symfs(filename, filename_size, build_id_filename);
1260                 free(build_id_filename);
1261         } else {
1262                 if (dso->has_build_id)
1263                         return ENOMEM;
1264                 goto fallback;
1265         }
1266
1267         if (dso__is_kcore(dso) ||
1268             readlink(filename, linkname, sizeof(linkname)) < 0 ||
1269             strstr(linkname, DSO__NAME_KALLSYMS) ||
1270             access(filename, R_OK)) {
1271 fallback:
1272                 /*
1273                  * If we don't have build-ids or the build-id file isn't in the
1274                  * cache, or is just a kallsyms file, well, lets hope that this
1275                  * DSO is the same as when 'perf record' ran.
1276                  */
1277                 __symbol__join_symfs(filename, filename_size, dso->long_name);
1278         }
1279
1280         return 0;
1281 }
1282
1283 int symbol__disassemble(struct symbol *sym, struct map *map, size_t privsize)
1284 {
1285         struct dso *dso = map->dso;
1286         char command[PATH_MAX * 2];
1287         FILE *file;
1288         char symfs_filename[PATH_MAX];
1289         struct kcore_extract kce;
1290         bool delete_extract = false;
1291         int stdout_fd[2];
1292         int lineno = 0;
1293         int nline;
1294         pid_t pid;
1295         int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1296
1297         if (err)
1298                 return err;
1299
1300         pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1301                  symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1302                  map->unmap_ip(map, sym->end));
1303
1304         pr_debug("annotating [%p] %30s : [%p] %30s\n",
1305                  dso, dso->long_name, sym, sym->name);
1306
1307         if (dso__is_kcore(dso)) {
1308                 kce.kcore_filename = symfs_filename;
1309                 kce.addr = map__rip_2objdump(map, sym->start);
1310                 kce.offs = sym->start;
1311                 kce.len = sym->end - sym->start;
1312                 if (!kcore_extract__create(&kce)) {
1313                         delete_extract = true;
1314                         strlcpy(symfs_filename, kce.extract_filename,
1315                                 sizeof(symfs_filename));
1316                 }
1317         } else if (dso__needs_decompress(dso)) {
1318                 char tmp[PATH_MAX];
1319                 struct kmod_path m;
1320                 int fd;
1321                 bool ret;
1322
1323                 if (kmod_path__parse_ext(&m, symfs_filename))
1324                         goto out;
1325
1326                 snprintf(tmp, PATH_MAX, "/tmp/perf-kmod-XXXXXX");
1327
1328                 fd = mkstemp(tmp);
1329                 if (fd < 0) {
1330                         free(m.ext);
1331                         goto out;
1332                 }
1333
1334                 ret = decompress_to_file(m.ext, symfs_filename, fd);
1335
1336                 if (ret)
1337                         pr_err("Cannot decompress %s %s\n", m.ext, symfs_filename);
1338
1339                 free(m.ext);
1340                 close(fd);
1341
1342                 if (!ret)
1343                         goto out;
1344
1345                 strcpy(symfs_filename, tmp);
1346         }
1347
1348         snprintf(command, sizeof(command),
1349                  "%s %s%s --start-address=0x%016" PRIx64
1350                  " --stop-address=0x%016" PRIx64
1351                  " -l -d %s %s -C %s 2>/dev/null|grep -v %s|expand",
1352                  objdump_path ? objdump_path : "objdump",
1353                  disassembler_style ? "-M " : "",
1354                  disassembler_style ? disassembler_style : "",
1355                  map__rip_2objdump(map, sym->start),
1356                  map__rip_2objdump(map, sym->end),
1357                  symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
1358                  symbol_conf.annotate_src ? "-S" : "",
1359                  symfs_filename, symfs_filename);
1360
1361         pr_debug("Executing: %s\n", command);
1362
1363         err = -1;
1364         if (pipe(stdout_fd) < 0) {
1365                 pr_err("Failure creating the pipe to run %s\n", command);
1366                 goto out_remove_tmp;
1367         }
1368
1369         pid = fork();
1370         if (pid < 0) {
1371                 pr_err("Failure forking to run %s\n", command);
1372                 goto out_close_stdout;
1373         }
1374
1375         if (pid == 0) {
1376                 close(stdout_fd[0]);
1377                 dup2(stdout_fd[1], 1);
1378                 close(stdout_fd[1]);
1379                 execl("/bin/sh", "sh", "-c", command, NULL);
1380                 perror(command);
1381                 exit(-1);
1382         }
1383
1384         close(stdout_fd[1]);
1385
1386         file = fdopen(stdout_fd[0], "r");
1387         if (!file) {
1388                 pr_err("Failure creating FILE stream for %s\n", command);
1389                 /*
1390                  * If we were using debug info should retry with
1391                  * original binary.
1392                  */
1393                 goto out_remove_tmp;
1394         }
1395
1396         nline = 0;
1397         while (!feof(file)) {
1398                 if (symbol__parse_objdump_line(sym, map, file, privsize,
1399                             &lineno) < 0)
1400                         break;
1401                 nline++;
1402         }
1403
1404         if (nline == 0)
1405                 pr_err("No output from %s\n", command);
1406
1407         /*
1408          * kallsyms does not have symbol sizes so there may a nop at the end.
1409          * Remove it.
1410          */
1411         if (dso__is_kcore(dso))
1412                 delete_last_nop(sym);
1413
1414         fclose(file);
1415         err = 0;
1416 out_remove_tmp:
1417         close(stdout_fd[0]);
1418
1419         if (dso__needs_decompress(dso))
1420                 unlink(symfs_filename);
1421
1422         if (delete_extract)
1423                 kcore_extract__delete(&kce);
1424 out:
1425         return err;
1426
1427 out_close_stdout:
1428         close(stdout_fd[1]);
1429         goto out_remove_tmp;
1430 }
1431
1432 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
1433 {
1434         struct source_line *iter;
1435         struct rb_node **p = &root->rb_node;
1436         struct rb_node *parent = NULL;
1437         int i, ret;
1438
1439         while (*p != NULL) {
1440                 parent = *p;
1441                 iter = rb_entry(parent, struct source_line, node);
1442
1443                 ret = strcmp(iter->path, src_line->path);
1444                 if (ret == 0) {
1445                         for (i = 0; i < src_line->nr_pcnt; i++)
1446                                 iter->samples[i].percent_sum += src_line->samples[i].percent;
1447                         return;
1448                 }
1449
1450                 if (ret < 0)
1451                         p = &(*p)->rb_left;
1452                 else
1453                         p = &(*p)->rb_right;
1454         }
1455
1456         for (i = 0; i < src_line->nr_pcnt; i++)
1457                 src_line->samples[i].percent_sum = src_line->samples[i].percent;
1458
1459         rb_link_node(&src_line->node, parent, p);
1460         rb_insert_color(&src_line->node, root);
1461 }
1462
1463 static int cmp_source_line(struct source_line *a, struct source_line *b)
1464 {
1465         int i;
1466
1467         for (i = 0; i < a->nr_pcnt; i++) {
1468                 if (a->samples[i].percent_sum == b->samples[i].percent_sum)
1469                         continue;
1470                 return a->samples[i].percent_sum > b->samples[i].percent_sum;
1471         }
1472
1473         return 0;
1474 }
1475
1476 static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
1477 {
1478         struct source_line *iter;
1479         struct rb_node **p = &root->rb_node;
1480         struct rb_node *parent = NULL;
1481
1482         while (*p != NULL) {
1483                 parent = *p;
1484                 iter = rb_entry(parent, struct source_line, node);
1485
1486                 if (cmp_source_line(src_line, iter))
1487                         p = &(*p)->rb_left;
1488                 else
1489                         p = &(*p)->rb_right;
1490         }
1491
1492         rb_link_node(&src_line->node, parent, p);
1493         rb_insert_color(&src_line->node, root);
1494 }
1495
1496 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1497 {
1498         struct source_line *src_line;
1499         struct rb_node *node;
1500
1501         node = rb_first(src_root);
1502         while (node) {
1503                 struct rb_node *next;
1504
1505                 src_line = rb_entry(node, struct source_line, node);
1506                 next = rb_next(node);
1507                 rb_erase(node, src_root);
1508
1509                 __resort_source_line(dest_root, src_line);
1510                 node = next;
1511         }
1512 }
1513
1514 static void symbol__free_source_line(struct symbol *sym, int len)
1515 {
1516         struct annotation *notes = symbol__annotation(sym);
1517         struct source_line *src_line = notes->src->lines;
1518         size_t sizeof_src_line;
1519         int i;
1520
1521         sizeof_src_line = sizeof(*src_line) +
1522                           (sizeof(src_line->samples) * (src_line->nr_pcnt - 1));
1523
1524         for (i = 0; i < len; i++) {
1525                 free_srcline(src_line->path);
1526                 src_line = (void *)src_line + sizeof_src_line;
1527         }
1528
1529         zfree(&notes->src->lines);
1530 }
1531
1532 /* Get the filename:line for the colored entries */
1533 static int symbol__get_source_line(struct symbol *sym, struct map *map,
1534                                    struct perf_evsel *evsel,
1535                                    struct rb_root *root, int len)
1536 {
1537         u64 start;
1538         int i, k;
1539         int evidx = evsel->idx;
1540         struct source_line *src_line;
1541         struct annotation *notes = symbol__annotation(sym);
1542         struct sym_hist *h = annotation__histogram(notes, evidx);
1543         struct rb_root tmp_root = RB_ROOT;
1544         int nr_pcnt = 1;
1545         u64 h_sum = h->sum;
1546         size_t sizeof_src_line = sizeof(struct source_line);
1547
1548         if (perf_evsel__is_group_event(evsel)) {
1549                 for (i = 1; i < evsel->nr_members; i++) {
1550                         h = annotation__histogram(notes, evidx + i);
1551                         h_sum += h->sum;
1552                 }
1553                 nr_pcnt = evsel->nr_members;
1554                 sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->samples);
1555         }
1556
1557         if (!h_sum)
1558                 return 0;
1559
1560         src_line = notes->src->lines = calloc(len, sizeof_src_line);
1561         if (!notes->src->lines)
1562                 return -1;
1563
1564         start = map__rip_2objdump(map, sym->start);
1565
1566         for (i = 0; i < len; i++) {
1567                 u64 offset;
1568                 double percent_max = 0.0;
1569
1570                 src_line->nr_pcnt = nr_pcnt;
1571
1572                 for (k = 0; k < nr_pcnt; k++) {
1573                         h = annotation__histogram(notes, evidx + k);
1574                         src_line->samples[k].percent = 100.0 * h->addr[i] / h->sum;
1575
1576                         if (src_line->samples[k].percent > percent_max)
1577                                 percent_max = src_line->samples[k].percent;
1578                 }
1579
1580                 if (percent_max <= 0.5)
1581                         goto next;
1582
1583                 offset = start + i;
1584                 src_line->path = get_srcline(map->dso, offset, NULL, false);
1585                 insert_source_line(&tmp_root, src_line);
1586
1587         next:
1588                 src_line = (void *)src_line + sizeof_src_line;
1589         }
1590
1591         resort_source_line(root, &tmp_root);
1592         return 0;
1593 }
1594
1595 static void print_summary(struct rb_root *root, const char *filename)
1596 {
1597         struct source_line *src_line;
1598         struct rb_node *node;
1599
1600         printf("\nSorted summary for file %s\n", filename);
1601         printf("----------------------------------------------\n\n");
1602
1603         if (RB_EMPTY_ROOT(root)) {
1604                 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1605                 return;
1606         }
1607
1608         node = rb_first(root);
1609         while (node) {
1610                 double percent, percent_max = 0.0;
1611                 const char *color;
1612                 char *path;
1613                 int i;
1614
1615                 src_line = rb_entry(node, struct source_line, node);
1616                 for (i = 0; i < src_line->nr_pcnt; i++) {
1617                         percent = src_line->samples[i].percent_sum;
1618                         color = get_percent_color(percent);
1619                         color_fprintf(stdout, color, " %7.2f", percent);
1620
1621                         if (percent > percent_max)
1622                                 percent_max = percent;
1623                 }
1624
1625                 path = src_line->path;
1626                 color = get_percent_color(percent_max);
1627                 color_fprintf(stdout, color, " %s\n", path);
1628
1629                 node = rb_next(node);
1630         }
1631 }
1632
1633 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1634 {
1635         struct annotation *notes = symbol__annotation(sym);
1636         struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1637         u64 len = symbol__size(sym), offset;
1638
1639         for (offset = 0; offset < len; ++offset)
1640                 if (h->addr[offset] != 0)
1641                         printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1642                                sym->start + offset, h->addr[offset]);
1643         printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1644 }
1645
1646 int symbol__annotate_printf(struct symbol *sym, struct map *map,
1647                             struct perf_evsel *evsel, bool full_paths,
1648                             int min_pcnt, int max_lines, int context)
1649 {
1650         struct dso *dso = map->dso;
1651         char *filename;
1652         const char *d_filename;
1653         const char *evsel_name = perf_evsel__name(evsel);
1654         struct annotation *notes = symbol__annotation(sym);
1655         struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1656         struct disasm_line *pos, *queue = NULL;
1657         u64 start = map__rip_2objdump(map, sym->start);
1658         int printed = 2, queue_len = 0;
1659         int more = 0;
1660         u64 len;
1661         int width = 8;
1662         int graph_dotted_len;
1663
1664         filename = strdup(dso->long_name);
1665         if (!filename)
1666                 return -ENOMEM;
1667
1668         if (full_paths)
1669                 d_filename = filename;
1670         else
1671                 d_filename = basename(filename);
1672
1673         len = symbol__size(sym);
1674
1675         if (perf_evsel__is_group_event(evsel))
1676                 width *= evsel->nr_members;
1677
1678         graph_dotted_len = printf(" %-*.*s|     Source code & Disassembly of %s for %s (%" PRIu64 " samples)\n",
1679                width, width, "Percent", d_filename, evsel_name, h->sum);
1680
1681         printf("%-*.*s----\n",
1682                graph_dotted_len, graph_dotted_len, graph_dotted_line);
1683
1684         if (verbose)
1685                 symbol__annotate_hits(sym, evsel);
1686
1687         list_for_each_entry(pos, &notes->src->source, node) {
1688                 if (context && queue == NULL) {
1689                         queue = pos;
1690                         queue_len = 0;
1691                 }
1692
1693                 switch (disasm_line__print(pos, sym, start, evsel, len,
1694                                             min_pcnt, printed, max_lines,
1695                                             queue)) {
1696                 case 0:
1697                         ++printed;
1698                         if (context) {
1699                                 printed += queue_len;
1700                                 queue = NULL;
1701                                 queue_len = 0;
1702                         }
1703                         break;
1704                 case 1:
1705                         /* filtered by max_lines */
1706                         ++more;
1707                         break;
1708                 case -1:
1709                 default:
1710                         /*
1711                          * Filtered by min_pcnt or non IP lines when
1712                          * context != 0
1713                          */
1714                         if (!context)
1715                                 break;
1716                         if (queue_len == context)
1717                                 queue = list_entry(queue->node.next, typeof(*queue), node);
1718                         else
1719                                 ++queue_len;
1720                         break;
1721                 }
1722         }
1723
1724         free(filename);
1725
1726         return more;
1727 }
1728
1729 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1730 {
1731         struct annotation *notes = symbol__annotation(sym);
1732         struct sym_hist *h = annotation__histogram(notes, evidx);
1733
1734         memset(h, 0, notes->src->sizeof_sym_hist);
1735 }
1736
1737 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1738 {
1739         struct annotation *notes = symbol__annotation(sym);
1740         struct sym_hist *h = annotation__histogram(notes, evidx);
1741         int len = symbol__size(sym), offset;
1742
1743         h->sum = 0;
1744         for (offset = 0; offset < len; ++offset) {
1745                 h->addr[offset] = h->addr[offset] * 7 / 8;
1746                 h->sum += h->addr[offset];
1747         }
1748 }
1749
1750 void disasm__purge(struct list_head *head)
1751 {
1752         struct disasm_line *pos, *n;
1753
1754         list_for_each_entry_safe(pos, n, head, node) {
1755                 list_del(&pos->node);
1756                 disasm_line__free(pos);
1757         }
1758 }
1759
1760 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1761 {
1762         size_t printed;
1763
1764         if (dl->offset == -1)
1765                 return fprintf(fp, "%s\n", dl->line);
1766
1767         printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->name);
1768
1769         if (dl->ops.raw[0] != '\0') {
1770                 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1771                                    dl->ops.raw);
1772         }
1773
1774         return printed + fprintf(fp, "\n");
1775 }
1776
1777 size_t disasm__fprintf(struct list_head *head, FILE *fp)
1778 {
1779         struct disasm_line *pos;
1780         size_t printed = 0;
1781
1782         list_for_each_entry(pos, head, node)
1783                 printed += disasm_line__fprintf(pos, fp);
1784
1785         return printed;
1786 }
1787
1788 int symbol__tty_annotate(struct symbol *sym, struct map *map,
1789                          struct perf_evsel *evsel, bool print_lines,
1790                          bool full_paths, int min_pcnt, int max_lines)
1791 {
1792         struct dso *dso = map->dso;
1793         struct rb_root source_line = RB_ROOT;
1794         u64 len;
1795
1796         if (symbol__disassemble(sym, map, 0) < 0)
1797                 return -1;
1798
1799         len = symbol__size(sym);
1800
1801         if (print_lines) {
1802                 srcline_full_filename = full_paths;
1803                 symbol__get_source_line(sym, map, evsel, &source_line, len);
1804                 print_summary(&source_line, dso->long_name);
1805         }
1806
1807         symbol__annotate_printf(sym, map, evsel, full_paths,
1808                                 min_pcnt, max_lines, 0);
1809         if (print_lines)
1810                 symbol__free_source_line(sym, len);
1811
1812         disasm__purge(&symbol__annotation(sym)->src->source);
1813
1814         return 0;
1815 }
1816
1817 bool ui__has_annotation(void)
1818 {
1819         return use_browser == 1 && perf_hpp_list.sym;
1820 }