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 "build-id.h"
  12 #include "color.h"
  13 #include "cache.h"
  14 #include "symbol.h"
  15 #include "debug.h"
  16 #include "annotate.h"
  17 #include "evsel.h"
  18 #include <pthread.h>
  19 #include <linux/bitops.h>
  20
  21 const char      *disassembler_style;
  22 const char      *objdump_path;
  23
  24 static struct ins *ins__find(const char *name);
  25 static int disasm_line__parse(char *line, char **namep, char **rawp);
  26
  27 static void ins__delete(struct ins_operands *ops)
  28 {
  29         free(ops->source.raw);
  30         free(ops->source.name);
  31         free(ops->target.raw);
  32         free(ops->target.name);
  33 }
  34
  35 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
  36                               struct ins_operands *ops)
  37 {
  38         return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->raw);
  39 }
  40
  41 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
  42                   struct ins_operands *ops)
  43 {
  44         if (ins->ops->scnprintf)
  45                 return ins->ops->scnprintf(ins, bf, size, ops);
  46
  47         return ins__raw_scnprintf(ins, bf, size, ops);
  48 }
  49
  50 static int call__parse(struct ins_operands *ops)
  51 {
  52         char *endptr, *tok, *name;
  53
  54         ops->target.addr = strtoull(ops->raw, &endptr, 16);
  55
  56         name = strchr(endptr, '<');
  57         if (name == NULL)
  58                 goto indirect_call;
  59
  60         name++;
  61
  62         tok = strchr(name, '>');
  63         if (tok == NULL)
  64                 return -1;
  65
  66         *tok = '\0';
  67         ops->target.name = strdup(name);
  68         *tok = '>';
  69
  70         return ops->target.name == NULL ? -1 : 0;
  71
  72 indirect_call:
  73         tok = strchr(endptr, '(');
  74         if (tok != NULL) {
  75                 ops->target.addr = 0;
  76                 return 0;
  77         }
  78
  79         tok = strchr(endptr, '*');
  80         if (tok == NULL)
  81                 return -1;
  82
  83         ops->target.addr = strtoull(tok + 1, NULL, 16);
  84         return 0;
  85 }
  86
  87 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
  88                            struct ins_operands *ops)
  89 {
  90         if (ops->target.name)
  91                 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
  92
  93         if (ops->target.addr == 0)
  94                 return ins__raw_scnprintf(ins, bf, size, ops);
  95
  96         return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
  97 }
  98
  99 static struct ins_ops call_ops = {
 100         .parse     = call__parse,
 101         .scnprintf = call__scnprintf,
 102 };
 103
 104 bool ins__is_call(const struct ins *ins)
 105 {
 106         return ins->ops == &call_ops;
 107 }
 108
 109 static int jump__parse(struct ins_operands *ops)
 110 {
 111         const char *s = strchr(ops->raw, '+');
 112
 113         ops->target.addr = strtoull(ops->raw, NULL, 16);
 114
 115         if (s++ != NULL)
 116                 ops->target.offset = strtoull(s, NULL, 16);
 117         else
 118                 ops->target.offset = UINT64_MAX;
 119
 120         return 0;
 121 }
 122
 123 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
 124                            struct ins_operands *ops)
 125 {
 126         return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
 127 }
 128
 129 static struct ins_ops jump_ops = {
 130         .parse     = jump__parse,
 131         .scnprintf = jump__scnprintf,
 132 };
 133
 134 bool ins__is_jump(const struct ins *ins)
 135 {
 136         return ins->ops == &jump_ops;
 137 }
 138
 139 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
 140 {
 141         char *endptr, *name, *t;
 142
 143         if (strstr(raw, "(%rip)") == NULL)
 144                 return 0;
 145
 146         *addrp = strtoull(comment, &endptr, 16);
 147         name = strchr(endptr, '<');
 148         if (name == NULL)
 149                 return -1;
 150
 151         name++;
 152
 153         t = strchr(name, '>');
 154         if (t == NULL)
 155                 return 0;
 156
 157         *t = '\0';
 158         *namep = strdup(name);
 159         *t = '>';
 160
 161         return 0;
 162 }
 163
 164 static int lock__parse(struct ins_operands *ops)
 165 {
 166         char *name;
 167
 168         ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
 169         if (ops->locked.ops == NULL)
 170                 return 0;
 171
 172         if (disasm_line__parse(ops->raw, &name, &ops->locked.ops->raw) < 0)
 173                 goto out_free_ops;
 174
 175         ops->locked.ins = ins__find(name);
 176         if (ops->locked.ins == NULL)
 177                 goto out_free_ops;
 178
 179         if (!ops->locked.ins->ops)
 180                 return 0;
 181
 182         if (ops->locked.ins->ops->parse)
 183                 ops->locked.ins->ops->parse(ops->locked.ops);
 184
 185         return 0;
 186
 187 out_free_ops:
 188         free(ops->locked.ops);
 189         ops->locked.ops = NULL;
 190         return 0;
 191 }
 192
 193 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
 194                            struct ins_operands *ops)
 195 {
 196         int printed;
 197
 198         if (ops->locked.ins == NULL)
 199                 return ins__raw_scnprintf(ins, bf, size, ops);
 200
 201         printed = scnprintf(bf, size, "%-6.6s ", ins->name);
 202         return printed + ins__scnprintf(ops->locked.ins, bf + printed,
 203                                         size - printed, ops->locked.ops);
 204 }
 205
 206 static void lock__delete(struct ins_operands *ops)
 207 {
 208         free(ops->locked.ops);
 209         free(ops->target.raw);
 210         free(ops->target.name);
 211 }
 212
 213 static struct ins_ops lock_ops = {
 214         .free      = lock__delete,
 215         .parse     = lock__parse,
 216         .scnprintf = lock__scnprintf,
 217 };
 218
 219 static int mov__parse(struct ins_operands *ops)
 220 {
 221         char *s = strchr(ops->raw, ','), *target, *comment, prev;
 222
 223         if (s == NULL)
 224                 return -1;
 225
 226         *s = '\0';
 227         ops->source.raw = strdup(ops->raw);
 228         *s = ',';
 229
 230         if (ops->source.raw == NULL)
 231                 return -1;
 232
 233         target = ++s;
 234
 235         while (s[0] != '\0' && !isspace(s[0]))
 236                 ++s;
 237         prev = *s;
 238         *s = '\0';
 239
 240         ops->target.raw = strdup(target);
 241         *s = prev;
 242
 243         if (ops->target.raw == NULL)
 244                 goto out_free_source;
 245
 246         comment = strchr(s, '#');
 247         if (comment == NULL)
 248                 return 0;
 249
 250         while (comment[0] != '\0' && isspace(comment[0]))
 251                 ++comment;
 252
 253         comment__symbol(ops->source.raw, comment, &ops->source.addr, &ops->source.name);
 254         comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
 255
 256         return 0;
 257
 258 out_free_source:
 259         free(ops->source.raw);
 260         ops->source.raw = NULL;
 261         return -1;
 262 }
 263
 264 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
 265                            struct ins_operands *ops)
 266 {
 267         return scnprintf(bf, size, "%-6.6s %s,%s", ins->name,
 268                          ops->source.name ?: ops->source.raw,
 269                          ops->target.name ?: ops->target.raw);
 270 }
 271
 272 static struct ins_ops mov_ops = {
 273         .parse     = mov__parse,
 274         .scnprintf = mov__scnprintf,
 275 };
 276
 277 static int dec__parse(struct ins_operands *ops)
 278 {
 279         char *target, *comment, *s, prev;
 280
 281         target = s = ops->raw;
 282
 283         while (s[0] != '\0' && !isspace(s[0]))
 284                 ++s;
 285         prev = *s;
 286         *s = '\0';
 287
 288         ops->target.raw = strdup(target);
 289         *s = prev;
 290
 291         if (ops->target.raw == NULL)
 292                 return -1;
 293
 294         comment = strchr(s, '#');
 295         if (comment == NULL)
 296                 return 0;
 297
 298         while (comment[0] != '\0' && isspace(comment[0]))
 299                 ++comment;
 300
 301         comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
 302
 303         return 0;
 304 }
 305
 306 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
 307                            struct ins_operands *ops)
 308 {
 309         return scnprintf(bf, size, "%-6.6s %s", ins->name,
 310                          ops->target.name ?: ops->target.raw);
 311 }
 312
 313 static struct ins_ops dec_ops = {
 314         .parse     = dec__parse,
 315         .scnprintf = dec__scnprintf,
 316 };
 317
 318 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
 319                           struct ins_operands *ops __maybe_unused)
 320 {
 321         return scnprintf(bf, size, "%-6.6s", "nop");
 322 }
 323
 324 static struct ins_ops nop_ops = {
 325         .scnprintf = nop__scnprintf,
 326 };
 327
 328 /*
 329  * Must be sorted by name!
 330  */
 331 static struct ins instructions[] = {
 332         { .name = "add",   .ops  = &mov_ops, },
 333         { .name = "addl",  .ops  = &mov_ops, },
 334         { .name = "addq",  .ops  = &mov_ops, },
 335         { .name = "addw",  .ops  = &mov_ops, },
 336         { .name = "and",   .ops  = &mov_ops, },
 337         { .name = "bts",   .ops  = &mov_ops, },
 338         { .name = "call",  .ops  = &call_ops, },
 339         { .name = "callq", .ops  = &call_ops, },
 340         { .name = "cmp",   .ops  = &mov_ops, },
 341         { .name = "cmpb",  .ops  = &mov_ops, },
 342         { .name = "cmpl",  .ops  = &mov_ops, },
 343         { .name = "cmpq",  .ops  = &mov_ops, },
 344         { .name = "cmpw",  .ops  = &mov_ops, },
 345         { .name = "cmpxch", .ops  = &mov_ops, },
 346         { .name = "dec",   .ops  = &dec_ops, },
 347         { .name = "decl",  .ops  = &dec_ops, },
 348         { .name = "imul",  .ops  = &mov_ops, },
 349         { .name = "inc",   .ops  = &dec_ops, },
 350         { .name = "incl",  .ops  = &dec_ops, },
 351         { .name = "ja",    .ops  = &jump_ops, },
 352         { .name = "jae",   .ops  = &jump_ops, },
 353         { .name = "jb",    .ops  = &jump_ops, },
 354         { .name = "jbe",   .ops  = &jump_ops, },
 355         { .name = "jc",    .ops  = &jump_ops, },
 356         { .name = "jcxz",  .ops  = &jump_ops, },
 357         { .name = "je",    .ops  = &jump_ops, },
 358         { .name = "jecxz", .ops  = &jump_ops, },
 359         { .name = "jg",    .ops  = &jump_ops, },
 360         { .name = "jge",   .ops  = &jump_ops, },
 361         { .name = "jl",    .ops  = &jump_ops, },
 362         { .name = "jle",   .ops  = &jump_ops, },
 363         { .name = "jmp",   .ops  = &jump_ops, },
 364         { .name = "jmpq",  .ops  = &jump_ops, },
 365         { .name = "jna",   .ops  = &jump_ops, },
 366         { .name = "jnae",  .ops  = &jump_ops, },
 367         { .name = "jnb",   .ops  = &jump_ops, },
 368         { .name = "jnbe",  .ops  = &jump_ops, },
 369         { .name = "jnc",   .ops  = &jump_ops, },
 370         { .name = "jne",   .ops  = &jump_ops, },
 371         { .name = "jng",   .ops  = &jump_ops, },
 372         { .name = "jnge",  .ops  = &jump_ops, },
 373         { .name = "jnl",   .ops  = &jump_ops, },
 374         { .name = "jnle",  .ops  = &jump_ops, },
 375         { .name = "jno",   .ops  = &jump_ops, },
 376         { .name = "jnp",   .ops  = &jump_ops, },
 377         { .name = "jns",   .ops  = &jump_ops, },
 378         { .name = "jnz",   .ops  = &jump_ops, },
 379         { .name = "jo",    .ops  = &jump_ops, },
 380         { .name = "jp",    .ops  = &jump_ops, },
 381         { .name = "jpe",   .ops  = &jump_ops, },
 382         { .name = "jpo",   .ops  = &jump_ops, },
 383         { .name = "jrcxz", .ops  = &jump_ops, },
 384         { .name = "js",    .ops  = &jump_ops, },
 385         { .name = "jz",    .ops  = &jump_ops, },
 386         { .name = "lea",   .ops  = &mov_ops, },
 387         { .name = "lock",  .ops  = &lock_ops, },
 388         { .name = "mov",   .ops  = &mov_ops, },
 389         { .name = "movb",  .ops  = &mov_ops, },
 390         { .name = "movdqa",.ops  = &mov_ops, },
 391         { .name = "movl",  .ops  = &mov_ops, },
 392         { .name = "movq",  .ops  = &mov_ops, },
 393         { .name = "movslq", .ops  = &mov_ops, },
 394         { .name = "movzbl", .ops  = &mov_ops, },
 395         { .name = "movzwl", .ops  = &mov_ops, },
 396         { .name = "nop",   .ops  = &nop_ops, },
 397         { .name = "nopl",  .ops  = &nop_ops, },
 398         { .name = "nopw",  .ops  = &nop_ops, },
 399         { .name = "or",    .ops  = &mov_ops, },
 400         { .name = "orl",   .ops  = &mov_ops, },
 401         { .name = "test",  .ops  = &mov_ops, },
 402         { .name = "testb", .ops  = &mov_ops, },
 403         { .name = "testl", .ops  = &mov_ops, },
 404         { .name = "xadd",  .ops  = &mov_ops, },
 405         { .name = "xbeginl", .ops  = &jump_ops, },
 406         { .name = "xbeginq", .ops  = &jump_ops, },
 407 };
 408
 409 static int ins__cmp(const void *name, const void *insp)
 410 {
 411         const struct ins *ins = insp;
 412
 413         return strcmp(name, ins->name);
 414 }
 415
 416 static struct ins *ins__find(const char *name)
 417 {
 418         const int nmemb = ARRAY_SIZE(instructions);
 419
 420         return bsearch(name, instructions, nmemb, sizeof(struct ins), ins__cmp);
 421 }
 422
 423 int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym)
 424 {
 425         struct annotation *notes = symbol__annotation(sym);
 426         pthread_mutex_init(&notes->lock, NULL);
 427         return 0;
 428 }
 429
 430 int symbol__alloc_hist(struct symbol *sym)
 431 {
 432         struct annotation *notes = symbol__annotation(sym);
 433         const size_t size = symbol__size(sym);
 434         size_t sizeof_sym_hist;
 435
 436         /* Check for overflow when calculating sizeof_sym_hist */
 437         if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(u64))
 438                 return -1;
 439
 440         sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(u64));
 441
 442         /* Check for overflow in zalloc argument */
 443         if (sizeof_sym_hist > (SIZE_MAX - sizeof(*notes->src))
 444                                 / symbol_conf.nr_events)
 445                 return -1;
 446
 447         notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
 448         if (notes->src == NULL)
 449                 return -1;
 450         notes->src->sizeof_sym_hist = sizeof_sym_hist;
 451         notes->src->nr_histograms   = symbol_conf.nr_events;
 452         INIT_LIST_HEAD(&notes->src->source);
 453         return 0;
 454 }
 455
 456 void symbol__annotate_zero_histograms(struct symbol *sym)
 457 {
 458         struct annotation *notes = symbol__annotation(sym);
 459
 460         pthread_mutex_lock(&notes->lock);
 461         if (notes->src != NULL)
 462                 memset(notes->src->histograms, 0,
 463                        notes->src->nr_histograms * notes->src->sizeof_sym_hist);
 464         pthread_mutex_unlock(&notes->lock);
 465 }
 466
 467 int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
 468                              int evidx, u64 addr)
 469 {
 470         unsigned offset;
 471         struct annotation *notes;
 472         struct sym_hist *h;
 473
 474         notes = symbol__annotation(sym);
 475         if (notes->src == NULL)
 476                 return -ENOMEM;
 477
 478         pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
 479
 480         if (addr < sym->start || addr > sym->end)
 481                 return -ERANGE;
 482
 483         offset = addr - sym->start;
 484         h = annotation__histogram(notes, evidx);
 485         h->sum++;
 486         h->addr[offset]++;
 487
 488         pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
 489                   ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
 490                   addr, addr - sym->start, evidx, h->addr[offset]);
 491         return 0;
 492 }
 493
 494 static void disasm_line__init_ins(struct disasm_line *dl)
 495 {
 496         dl->ins = ins__find(dl->name);
 497
 498         if (dl->ins == NULL)
 499                 return;
 500
 501         if (!dl->ins->ops)
 502                 return;
 503
 504         if (dl->ins->ops->parse)
 505                 dl->ins->ops->parse(&dl->ops);
 506 }
 507
 508 static int disasm_line__parse(char *line, char **namep, char **rawp)
 509 {
 510         char *name = line, tmp;
 511
 512         while (isspace(name[0]))
 513                 ++name;
 514
 515         if (name[0] == '\0')
 516                 return -1;
 517
 518         *rawp = name + 1;
 519
 520         while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
 521                 ++*rawp;
 522
 523         tmp = (*rawp)[0];
 524         (*rawp)[0] = '\0';
 525         *namep = strdup(name);
 526
 527         if (*namep == NULL)
 528                 goto out_free_name;
 529
 530         (*rawp)[0] = tmp;
 531
 532         if ((*rawp)[0] != '\0') {
 533                 (*rawp)++;
 534                 while (isspace((*rawp)[0]))
 535                         ++(*rawp);
 536         }
 537
 538         return 0;
 539
 540 out_free_name:
 541         free(*namep);
 542         *namep = NULL;
 543         return -1;
 544 }
 545
 546 static struct disasm_line *disasm_line__new(s64 offset, char *line, size_t privsize)
 547 {
 548         struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
 549
 550         if (dl != NULL) {
 551                 dl->offset = offset;
 552                 dl->line = strdup(line);
 553                 if (dl->line == NULL)
 554                         goto out_delete;
 555
 556                 if (offset != -1) {
 557                         if (disasm_line__parse(dl->line, &dl->name, &dl->ops.raw) < 0)
 558                                 goto out_free_line;
 559
 560                         disasm_line__init_ins(dl);
 561                 }
 562         }
 563
 564         return dl;
 565
 566 out_free_line:
 567         free(dl->line);
 568 out_delete:
 569         free(dl);
 570         return NULL;
 571 }
 572
 573 void disasm_line__free(struct disasm_line *dl)
 574 {
 575         free(dl->line);
 576         free(dl->name);
 577         if (dl->ins && dl->ins->ops->free)
 578                 dl->ins->ops->free(&dl->ops);
 579         else
 580                 ins__delete(&dl->ops);
 581         free(dl);
 582 }
 583
 584 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
 585 {
 586         if (raw || !dl->ins)
 587                 return scnprintf(bf, size, "%-6.6s %s", dl->name, dl->ops.raw);
 588
 589         return ins__scnprintf(dl->ins, bf, size, &dl->ops);
 590 }
 591
 592 static void disasm__add(struct list_head *head, struct disasm_line *line)
 593 {
 594         list_add_tail(&line->node, head);
 595 }
 596
 597 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
 598 {
 599         list_for_each_entry_continue(pos, head, node)
 600                 if (pos->offset >= 0)
 601                         return pos;
 602
 603         return NULL;
 604 }
 605
 606 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
 607                             s64 end, const char **path)
 608 {
 609         struct source_line *src_line = notes->src->lines;
 610         double percent = 0.0;
 611
 612         if (src_line) {
 613                 size_t sizeof_src_line = sizeof(*src_line) +
 614                                 sizeof(src_line->p) * (src_line->nr_pcnt - 1);
 615
 616                 while (offset < end) {
 617                         src_line = (void *)notes->src->lines +
 618                                         (sizeof_src_line * offset);
 619
 620                         if (*path == NULL)
 621                                 *path = src_line->path;
 622
 623                         percent += src_line->p[evidx].percent;
 624                         offset++;
 625                 }
 626         } else {
 627                 struct sym_hist *h = annotation__histogram(notes, evidx);
 628                 unsigned int hits = 0;
 629
 630                 while (offset < end)
 631                         hits += h->addr[offset++];
 632
 633                 if (h->sum)
 634                         percent = 100.0 * hits / h->sum;
 635         }
 636
 637         return percent;
 638 }
 639
 640 static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
 641                       struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
 642                       int max_lines, struct disasm_line *queue)
 643 {
 644         static const char *prev_line;
 645         static const char *prev_color;
 646
 647         if (dl->offset != -1) {
 648                 const char *path = NULL;
 649                 double percent, max_percent = 0.0;
 650                 double *ppercents = &percent;
 651                 int i, nr_percent = 1;
 652                 const char *color;
 653                 struct annotation *notes = symbol__annotation(sym);
 654                 s64 offset = dl->offset;
 655                 const u64 addr = start + offset;
 656                 struct disasm_line *next;
 657
 658                 next = disasm__get_next_ip_line(&notes->src->source, dl);
 659
 660                 if (perf_evsel__is_group_event(evsel)) {
 661                         nr_percent = evsel->nr_members;
 662                         ppercents = calloc(nr_percent, sizeof(double));
 663                         if (ppercents == NULL)
 664                                 return -1;
 665                 }
 666
 667                 for (i = 0; i < nr_percent; i++) {
 668                         percent = disasm__calc_percent(notes,
 669                                         notes->src->lines ? i : evsel->idx + i,
 670                                         offset,
 671                                         next ? next->offset : (s64) len,
 672                                         &path);
 673
 674                         ppercents[i] = percent;
 675                         if (percent > max_percent)
 676                                 max_percent = percent;
 677                 }
 678
 679                 if (max_percent < min_pcnt)
 680                         return -1;
 681
 682                 if (max_lines && printed >= max_lines)
 683                         return 1;
 684
 685                 if (queue != NULL) {
 686                         list_for_each_entry_from(queue, &notes->src->source, node) {
 687                                 if (queue == dl)
 688                                         break;
 689                                 disasm_line__print(queue, sym, start, evsel, len,
 690                                                     0, 0, 1, NULL);
 691                         }
 692                 }
 693
 694                 color = get_percent_color(max_percent);
 695
 696                 /*
 697                  * Also color the filename and line if needed, with
 698                  * the same color than the percentage. Don't print it
 699                  * twice for close colored addr with the same filename:line
 700                  */
 701                 if (path) {
 702                         if (!prev_line || strcmp(prev_line, path)
 703                                        || color != prev_color) {
 704                                 color_fprintf(stdout, color, " %s", path);
 705                                 prev_line = path;
 706                                 prev_color = color;
 707                         }
 708                 }
 709
 710                 for (i = 0; i < nr_percent; i++) {
 711                         percent = ppercents[i];
 712                         color = get_percent_color(percent);
 713                         color_fprintf(stdout, color, " %7.2f", percent);
 714                 }
 715
 716                 printf(" :      ");
 717                 color_fprintf(stdout, PERF_COLOR_MAGENTA, "  %" PRIx64 ":", addr);
 718                 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", dl->line);
 719
 720                 if (ppercents != &percent)
 721                         free(ppercents);
 722
 723         } else if (max_lines && printed >= max_lines)
 724                 return 1;
 725         else {
 726                 int width = 8;
 727
 728                 if (queue)
 729                         return -1;
 730
 731                 if (perf_evsel__is_group_event(evsel))
 732                         width *= evsel->nr_members;
 733
 734                 if (!*dl->line)
 735                         printf(" %*s:\n", width, " ");
 736                 else
 737                         printf(" %*s:   %s\n", width, " ", dl->line);
 738         }
 739
 740         return 0;
 741 }
 742
 743 /*
 744  * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
 745  * which looks like following
 746  *
 747  *  0000000000415500 <_init>:
 748  *    415500:       sub    $0x8,%rsp
 749  *    415504:       mov    0x2f5ad5(%rip),%rax        # 70afe0 <_DYNAMIC+0x2f8>
 750  *    41550b:       test   %rax,%rax
 751  *    41550e:       je     415515 <_init+0x15>
 752  *    415510:       callq  416e70 <__gmon_start__@plt>
 753  *    415515:       add    $0x8,%rsp
 754  *    415519:       retq
 755  *
 756  * it will be parsed and saved into struct disasm_line as
 757  *  <offset>       <name>  <ops.raw>
 758  *
 759  * The offset will be a relative offset from the start of the symbol and -1
 760  * means that it's not a disassembly line so should be treated differently.
 761  * The ops.raw part will be parsed further according to type of the instruction.
 762  */
 763 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
 764                                       FILE *file, size_t privsize)
 765 {
 766         struct annotation *notes = symbol__annotation(sym);
 767         struct disasm_line *dl;
 768         char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
 769         size_t line_len;
 770         s64 line_ip, offset = -1;
 771
 772         if (getline(&line, &line_len, file) < 0)
 773                 return -1;
 774
 775         if (!line)
 776                 return -1;
 777
 778         while (line_len != 0 && isspace(line[line_len - 1]))
 779                 line[--line_len] = '\0';
 780
 781         c = strchr(line, '\n');
 782         if (c)
 783                 *c = 0;
 784
 785         line_ip = -1;
 786         parsed_line = line;
 787
 788         /*
 789          * Strip leading spaces:
 790          */
 791         tmp = line;
 792         while (*tmp) {
 793                 if (*tmp != ' ')
 794                         break;
 795                 tmp++;
 796         }
 797
 798         if (*tmp) {
 799                 /*
 800                  * Parse hexa addresses followed by ':'
 801                  */
 802                 line_ip = strtoull(tmp, &tmp2, 16);
 803                 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
 804                         line_ip = -1;
 805         }
 806
 807         if (line_ip != -1) {
 808                 u64 start = map__rip_2objdump(map, sym->start),
 809                     end = map__rip_2objdump(map, sym->end);
 810
 811                 offset = line_ip - start;
 812                 if (offset < 0 || (u64)line_ip > end)
 813                         offset = -1;
 814                 else
 815                         parsed_line = tmp2 + 1;
 816         }
 817
 818         dl = disasm_line__new(offset, parsed_line, privsize);
 819         free(line);
 820
 821         if (dl == NULL)
 822                 return -1;
 823
 824         if (dl->ops.target.offset == UINT64_MAX)
 825                 dl->ops.target.offset = dl->ops.target.addr -
 826                                         map__rip_2objdump(map, sym->start);
 827
 828         disasm__add(&notes->src->source, dl);
 829
 830         return 0;
 831 }
 832
 833 static void delete_last_nop(struct symbol *sym)
 834 {
 835         struct annotation *notes = symbol__annotation(sym);
 836         struct list_head *list = &notes->src->source;
 837         struct disasm_line *dl;
 838
 839         while (!list_empty(list)) {
 840                 dl = list_entry(list->prev, struct disasm_line, node);
 841
 842                 if (dl->ins && dl->ins->ops) {
 843                         if (dl->ins->ops != &nop_ops)
 844                                 return;
 845                 } else {
 846                         if (!strstr(dl->line, " nop ") &&
 847                             !strstr(dl->line, " nopl ") &&
 848                             !strstr(dl->line, " nopw "))
 849                                 return;
 850                 }
 851
 852                 list_del(&dl->node);
 853                 disasm_line__free(dl);
 854         }
 855 }
 856
 857 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize)
 858 {
 859         struct dso *dso = map->dso;
 860         char *filename = dso__build_id_filename(dso, NULL, 0);
 861         bool free_filename = true;
 862         char command[PATH_MAX * 2];
 863         FILE *file;
 864         int err = 0;
 865         char symfs_filename[PATH_MAX];
 866
 867         if (filename) {
 868                 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
 869                          symbol_conf.symfs, filename);
 870         }
 871
 872         if (filename == NULL) {
 873                 if (dso->has_build_id) {
 874                         pr_err("Can't annotate %s: not enough memory\n",
 875                                sym->name);
 876                         return -ENOMEM;
 877                 }
 878                 goto fallback;
 879         } else if (readlink(symfs_filename, command, sizeof(command)) < 0 ||
 880                    strstr(command, "[kernel.kallsyms]") ||
 881                    access(symfs_filename, R_OK)) {
 882                 free(filename);
 883 fallback:
 884                 /*
 885                  * If we don't have build-ids or the build-id file isn't in the
 886                  * cache, or is just a kallsyms file, well, lets hope that this
 887                  * DSO is the same as when 'perf record' ran.
 888                  */
 889                 filename = dso->long_name;
 890                 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
 891                          symbol_conf.symfs, filename);
 892                 free_filename = false;
 893         }
 894
 895         if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
 896             !dso__is_kcore(dso)) {
 897                 char bf[BUILD_ID_SIZE * 2 + 16] = " with build id ";
 898                 char *build_id_msg = NULL;
 899
 900                 if (dso->annotate_warned)
 901                         goto out_free_filename;
 902
 903                 if (dso->has_build_id) {
 904                         build_id__sprintf(dso->build_id,
 905                                           sizeof(dso->build_id), bf + 15);
 906                         build_id_msg = bf;
 907                 }
 908                 err = -ENOENT;
 909                 dso->annotate_warned = 1;
 910                 pr_err("Can't annotate %s:\n\n"
 911                        "No vmlinux file%s\nwas found in the path.\n\n"
 912                        "Please use:\n\n"
 913                        "  perf buildid-cache -vu vmlinux\n\n"
 914                        "or:\n\n"
 915                        "  --vmlinux vmlinux\n",
 916                        sym->name, build_id_msg ?: "");
 917                 goto out_free_filename;
 918         }
 919
 920         pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
 921                  filename, sym->name, map->unmap_ip(map, sym->start),
 922                  map->unmap_ip(map, sym->end));
 923
 924         pr_debug("annotating [%p] %30s : [%p] %30s\n",
 925                  dso, dso->long_name, sym, sym->name);
 926
 927         snprintf(command, sizeof(command),
 928                  "%s %s%s --start-address=0x%016" PRIx64
 929                  " --stop-address=0x%016" PRIx64
 930                  " -d %s %s -C %s 2>/dev/null|grep -v %s|expand",
 931                  objdump_path ? objdump_path : "objdump",
 932                  disassembler_style ? "-M " : "",
 933                  disassembler_style ? disassembler_style : "",
 934                  map__rip_2objdump(map, sym->start),
 935                  map__rip_2objdump(map, sym->end+1),
 936                  symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
 937                  symbol_conf.annotate_src ? "-S" : "",
 938                  symfs_filename, filename);
 939
 940         pr_debug("Executing: %s\n", command);
 941
 942         file = popen(command, "r");
 943         if (!file)
 944                 goto out_free_filename;
 945
 946         while (!feof(file))
 947                 if (symbol__parse_objdump_line(sym, map, file, privsize) < 0)
 948                         break;
 949
 950         /*
 951          * kallsyms does not have symbol sizes so there may a nop at the end.
 952          * Remove it.
 953          */
 954         if (dso__is_kcore(dso))
 955                 delete_last_nop(sym);
 956
 957         pclose(file);
 958 out_free_filename:
 959         if (free_filename)
 960                 free(filename);
 961         return err;
 962 }
 963
 964 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
 965 {
 966         struct source_line *iter;
 967         struct rb_node **p = &root->rb_node;
 968         struct rb_node *parent = NULL;
 969         int i, ret;
 970
 971         while (*p != NULL) {
 972                 parent = *p;
 973                 iter = rb_entry(parent, struct source_line, node);
 974
 975                 ret = strcmp(iter->path, src_line->path);
 976                 if (ret == 0) {
 977                         for (i = 0; i < src_line->nr_pcnt; i++)
 978                                 iter->p[i].percent_sum += src_line->p[i].percent;
 979                         return;
 980                 }
 981
 982                 if (ret < 0)
 983                         p = &(*p)->rb_left;
 984                 else
 985                         p = &(*p)->rb_right;
 986         }
 987
 988         for (i = 0; i < src_line->nr_pcnt; i++)
 989                 src_line->p[i].percent_sum = src_line->p[i].percent;
 990
 991         rb_link_node(&src_line->node, parent, p);
 992         rb_insert_color(&src_line->node, root);
 993 }
 994
 995 static int cmp_source_line(struct source_line *a, struct source_line *b)
 996 {
 997         int i;
 998
 999         for (i = 0; i < a->nr_pcnt; i++) {
1000                 if (a->p[i].percent_sum == b->p[i].percent_sum)
1001                         continue;
1002                 return a->p[i].percent_sum > b->p[i].percent_sum;
1003         }
1004
1005         return 0;
1006 }
1007
1008 static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
1009 {
1010         struct source_line *iter;
1011         struct rb_node **p = &root->rb_node;
1012         struct rb_node *parent = NULL;
1013
1014         while (*p != NULL) {
1015                 parent = *p;
1016                 iter = rb_entry(parent, struct source_line, node);
1017
1018                 if (cmp_source_line(src_line, iter))
1019                         p = &(*p)->rb_left;
1020                 else
1021                         p = &(*p)->rb_right;
1022         }
1023
1024         rb_link_node(&src_line->node, parent, p);
1025         rb_insert_color(&src_line->node, root);
1026 }
1027
1028 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1029 {
1030         struct source_line *src_line;
1031         struct rb_node *node;
1032
1033         node = rb_first(src_root);
1034         while (node) {
1035                 struct rb_node *next;
1036
1037                 src_line = rb_entry(node, struct source_line, node);
1038                 next = rb_next(node);
1039                 rb_erase(node, src_root);
1040
1041                 __resort_source_line(dest_root, src_line);
1042                 node = next;
1043         }
1044 }
1045
1046 static void symbol__free_source_line(struct symbol *sym, int len)
1047 {
1048         struct annotation *notes = symbol__annotation(sym);
1049         struct source_line *src_line = notes->src->lines;
1050         size_t sizeof_src_line;
1051         int i;
1052
1053         sizeof_src_line = sizeof(*src_line) +
1054                           (sizeof(src_line->p) * (src_line->nr_pcnt - 1));
1055
1056         for (i = 0; i < len; i++) {
1057                 free(src_line->path);
1058                 src_line = (void *)src_line + sizeof_src_line;
1059         }
1060
1061         free(notes->src->lines);
1062         notes->src->lines = NULL;
1063 }
1064
1065 /* Get the filename:line for the colored entries */
1066 static int symbol__get_source_line(struct symbol *sym, struct map *map,
1067                                    struct perf_evsel *evsel,
1068                                    struct rb_root *root, int len,
1069                                    const char *filename)
1070 {
1071         u64 start;
1072         int i, k;
1073         int evidx = evsel->idx;
1074         char cmd[PATH_MAX * 2];
1075         struct source_line *src_line;
1076         struct annotation *notes = symbol__annotation(sym);
1077         struct sym_hist *h = annotation__histogram(notes, evidx);
1078         struct rb_root tmp_root = RB_ROOT;
1079         int nr_pcnt = 1;
1080         u64 h_sum = h->sum;
1081         size_t sizeof_src_line = sizeof(struct source_line);
1082
1083         if (perf_evsel__is_group_event(evsel)) {
1084                 for (i = 1; i < evsel->nr_members; i++) {
1085                         h = annotation__histogram(notes, evidx + i);
1086                         h_sum += h->sum;
1087                 }
1088                 nr_pcnt = evsel->nr_members;
1089                 sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->p);
1090         }
1091
1092         if (!h_sum)
1093                 return 0;
1094
1095         src_line = notes->src->lines = calloc(len, sizeof_src_line);
1096         if (!notes->src->lines)
1097                 return -1;
1098
1099         start = map__rip_2objdump(map, sym->start);
1100
1101         for (i = 0; i < len; i++) {
1102                 char *path = NULL;
1103                 size_t line_len;
1104                 u64 offset;
1105                 FILE *fp;
1106                 double percent_max = 0.0;
1107
1108                 src_line->nr_pcnt = nr_pcnt;
1109
1110                 for (k = 0; k < nr_pcnt; k++) {
1111                         h = annotation__histogram(notes, evidx + k);
1112                         src_line->p[k].percent = 100.0 * h->addr[i] / h->sum;
1113
1114                         if (src_line->p[k].percent > percent_max)
1115                                 percent_max = src_line->p[k].percent;
1116                 }
1117
1118                 if (percent_max <= 0.5)
1119                         goto next;
1120
1121                 offset = start + i;
1122                 sprintf(cmd, "addr2line -e %s %016" PRIx64, filename, offset);
1123                 fp = popen(cmd, "r");
1124                 if (!fp)
1125                         goto next;
1126
1127                 if (getline(&path, &line_len, fp) < 0 || !line_len)
1128                         goto next_close;
1129
1130                 src_line->path = malloc(sizeof(char) * line_len + 1);
1131                 if (!src_line->path)
1132                         goto next_close;
1133
1134                 strcpy(src_line->path, path);
1135                 insert_source_line(&tmp_root, src_line);
1136
1137         next_close:
1138                 pclose(fp);
1139         next:
1140                 src_line = (void *)src_line + sizeof_src_line;
1141         }
1142
1143         resort_source_line(root, &tmp_root);
1144         return 0;
1145 }
1146
1147 static void print_summary(struct rb_root *root, const char *filename)
1148 {
1149         struct source_line *src_line;
1150         struct rb_node *node;
1151
1152         printf("\nSorted summary for file %s\n", filename);
1153         printf("----------------------------------------------\n\n");
1154
1155         if (RB_EMPTY_ROOT(root)) {
1156                 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1157                 return;
1158         }
1159
1160         node = rb_first(root);
1161         while (node) {
1162                 double percent, percent_max = 0.0;
1163                 const char *color;
1164                 char *path;
1165                 int i;
1166
1167                 src_line = rb_entry(node, struct source_line, node);
1168                 for (i = 0; i < src_line->nr_pcnt; i++) {
1169                         percent = src_line->p[i].percent_sum;
1170                         color = get_percent_color(percent);
1171                         color_fprintf(stdout, color, " %7.2f", percent);
1172
1173                         if (percent > percent_max)
1174                                 percent_max = percent;
1175                 }
1176
1177                 path = src_line->path;
1178                 color = get_percent_color(percent_max);
1179                 color_fprintf(stdout, color, " %s", path);
1180
1181                 node = rb_next(node);
1182         }
1183 }
1184
1185 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1186 {
1187         struct annotation *notes = symbol__annotation(sym);
1188         struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1189         u64 len = symbol__size(sym), offset;
1190
1191         for (offset = 0; offset < len; ++offset)
1192                 if (h->addr[offset] != 0)
1193                         printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1194                                sym->start + offset, h->addr[offset]);
1195         printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1196 }
1197
1198 int symbol__annotate_printf(struct symbol *sym, struct map *map,
1199                             struct perf_evsel *evsel, bool full_paths,
1200                             int min_pcnt, int max_lines, int context)
1201 {
1202         struct dso *dso = map->dso;
1203         char *filename;
1204         const char *d_filename;
1205         struct annotation *notes = symbol__annotation(sym);
1206         struct disasm_line *pos, *queue = NULL;
1207         u64 start = map__rip_2objdump(map, sym->start);
1208         int printed = 2, queue_len = 0;
1209         int more = 0;
1210         u64 len;
1211         int width = 8;
1212         int namelen;
1213
1214         filename = strdup(dso->long_name);
1215         if (!filename)
1216                 return -ENOMEM;
1217
1218         if (full_paths)
1219                 d_filename = filename;
1220         else
1221                 d_filename = basename(filename);
1222
1223         len = symbol__size(sym);
1224         namelen = strlen(d_filename);
1225
1226         if (perf_evsel__is_group_event(evsel))
1227                 width *= evsel->nr_members;
1228
1229         printf(" %-*.*s|        Source code & Disassembly of %s\n",
1230                width, width, "Percent", d_filename);
1231         printf("-%-*.*s-------------------------------------\n",
1232                width+namelen, width+namelen, graph_dotted_line);
1233
1234         if (verbose)
1235                 symbol__annotate_hits(sym, evsel);
1236
1237         list_for_each_entry(pos, &notes->src->source, node) {
1238                 if (context && queue == NULL) {
1239                         queue = pos;
1240                         queue_len = 0;
1241                 }
1242
1243                 switch (disasm_line__print(pos, sym, start, evsel, len,
1244                                             min_pcnt, printed, max_lines,
1245                                             queue)) {
1246                 case 0:
1247                         ++printed;
1248                         if (context) {
1249                                 printed += queue_len;
1250                                 queue = NULL;
1251                                 queue_len = 0;
1252                         }
1253                         break;
1254                 case 1:
1255                         /* filtered by max_lines */
1256                         ++more;
1257                         break;
1258                 case -1:
1259                 default:
1260                         /*
1261                          * Filtered by min_pcnt or non IP lines when
1262                          * context != 0
1263                          */
1264                         if (!context)
1265                                 break;
1266                         if (queue_len == context)
1267                                 queue = list_entry(queue->node.next, typeof(*queue), node);
1268                         else
1269                                 ++queue_len;
1270                         break;
1271                 }
1272         }
1273
1274         free(filename);
1275
1276         return more;
1277 }
1278
1279 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1280 {
1281         struct annotation *notes = symbol__annotation(sym);
1282         struct sym_hist *h = annotation__histogram(notes, evidx);
1283
1284         memset(h, 0, notes->src->sizeof_sym_hist);
1285 }
1286
1287 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1288 {
1289         struct annotation *notes = symbol__annotation(sym);
1290         struct sym_hist *h = annotation__histogram(notes, evidx);
1291         int len = symbol__size(sym), offset;
1292
1293         h->sum = 0;
1294         for (offset = 0; offset < len; ++offset) {
1295                 h->addr[offset] = h->addr[offset] * 7 / 8;
1296                 h->sum += h->addr[offset];
1297         }
1298 }
1299
1300 void disasm__purge(struct list_head *head)
1301 {
1302         struct disasm_line *pos, *n;
1303
1304         list_for_each_entry_safe(pos, n, head, node) {
1305                 list_del(&pos->node);
1306                 disasm_line__free(pos);
1307         }
1308 }
1309
1310 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1311 {
1312         size_t printed;
1313
1314         if (dl->offset == -1)
1315                 return fprintf(fp, "%s\n", dl->line);
1316
1317         printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->name);
1318
1319         if (dl->ops.raw[0] != '\0') {
1320                 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1321                                    dl->ops.raw);
1322         }
1323
1324         return printed + fprintf(fp, "\n");
1325 }
1326
1327 size_t disasm__fprintf(struct list_head *head, FILE *fp)
1328 {
1329         struct disasm_line *pos;
1330         size_t printed = 0;
1331
1332         list_for_each_entry(pos, head, node)
1333                 printed += disasm_line__fprintf(pos, fp);
1334
1335         return printed;
1336 }
1337
1338 int symbol__tty_annotate(struct symbol *sym, struct map *map,
1339                          struct perf_evsel *evsel, bool print_lines,
1340                          bool full_paths, int min_pcnt, int max_lines)
1341 {
1342         struct dso *dso = map->dso;
1343         const char *filename = dso->long_name;
1344         struct rb_root source_line = RB_ROOT;
1345         u64 len;
1346
1347         if (symbol__annotate(sym, map, 0) < 0)
1348                 return -1;
1349
1350         len = symbol__size(sym);
1351
1352         if (print_lines) {
1353                 symbol__get_source_line(sym, map, evsel, &source_line,
1354                                         len, filename);
1355                 print_summary(&source_line, filename);
1356         }
1357
1358         symbol__annotate_printf(sym, map, evsel, full_paths,
1359                                 min_pcnt, max_lines, 0);
1360         if (print_lines)
1361                 symbol__free_source_line(sym, len);
1362
1363         disasm__purge(&symbol__annotation(sym)->src->source);
1364
1365         return 0;
1366 }