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