]> git.ipfire.org Git - thirdparty/linux.git/blame - tools/perf/util/annotate.c
perf annotate: Pass evsel instead of evidx on annotation functions
[thirdparty/linux.git] / tools / perf / util / annotate.c
CommitLineData
78f7defe
ACM
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"
db8fd07a 17#include "evsel.h"
ce6f4fab 18#include <pthread.h>
4383db88 19#include <linux/bitops.h>
78f7defe 20
f69b64f7 21const char *disassembler_style;
7a4ec938 22const char *objdump_path;
f69b64f7 23
7a997fe4
ACM
24static struct ins *ins__find(const char *name);
25static int disasm_line__parse(char *line, char **namep, char **rawp);
26
c46219ac
ACM
27static 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
5417072b
ACM
35static 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
41int 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
c7e6ead7 50static int call__parse(struct ins_operands *ops)
d86b0597 51{
d2232885
ACM
52 char *endptr, *tok, *name;
53
44d1a3ed 54 ops->target.addr = strtoull(ops->raw, &endptr, 16);
d2232885
ACM
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';
44d1a3ed 67 ops->target.name = strdup(name);
d2232885
ACM
68 *tok = '>';
69
44d1a3ed 70 return ops->target.name == NULL ? -1 : 0;
d2232885
ACM
71
72indirect_call:
e8ea1561
ACM
73 tok = strchr(endptr, '(');
74 if (tok != NULL) {
75 ops->target.addr = 0;
76 return 0;
77 }
78
d2232885
ACM
79 tok = strchr(endptr, '*');
80 if (tok == NULL)
81 return -1;
82
44d1a3ed 83 ops->target.addr = strtoull(tok + 1, NULL, 16);
d86b0597
ACM
84 return 0;
85}
86
d2232885 87static int call__scnprintf(struct ins *ins, char *bf, size_t size,
5417072b 88 struct ins_operands *ops)
d2232885 89{
44d1a3ed
ACM
90 if (ops->target.name)
91 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
d2232885 92
e8ea1561
ACM
93 if (ops->target.addr == 0)
94 return ins__raw_scnprintf(ins, bf, size, ops);
95
44d1a3ed 96 return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
d2232885
ACM
97}
98
d86b0597 99static struct ins_ops call_ops = {
d2232885
ACM
100 .parse = call__parse,
101 .scnprintf = call__scnprintf,
d86b0597
ACM
102};
103
104bool ins__is_call(const struct ins *ins)
105{
106 return ins->ops == &call_ops;
107}
108
c7e6ead7 109static int jump__parse(struct ins_operands *ops)
4f9d0325 110{
c7e6ead7 111 const char *s = strchr(ops->raw, '+');
4f9d0325 112
fb29fa58
ACM
113 ops->target.addr = strtoll(ops->raw, NULL, 16);
114
115 if (s++ != NULL)
116 ops->target.offset = strtoll(s, NULL, 16);
117 else
118 ops->target.offset = UINT64_MAX;
4f9d0325 119
4f9d0325
ACM
120 return 0;
121}
122
c7e6ead7 123static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
5417072b 124 struct ins_operands *ops)
28548d78 125{
44d1a3ed 126 return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
28548d78
ACM
127}
128
4f9d0325 129static struct ins_ops jump_ops = {
c7e6ead7
ACM
130 .parse = jump__parse,
131 .scnprintf = jump__scnprintf,
4f9d0325
ACM
132};
133
134bool ins__is_jump(const struct ins *ins)
135{
136 return ins->ops == &jump_ops;
137}
138
6de783b6
ACM
139static 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
7a997fe4
ACM
164static 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
2ba34aaa
NK
175 ops->locked.ins = ins__find(name);
176 if (ops->locked.ins == NULL)
177 goto out_free_ops;
7a997fe4 178
2ba34aaa
NK
179 if (!ops->locked.ins->ops)
180 return 0;
7a997fe4 181
2ba34aaa
NK
182 if (ops->locked.ins->ops->parse)
183 ops->locked.ins->ops->parse(ops->locked.ops);
7a997fe4
ACM
184
185 return 0;
186
187out_free_ops:
188 free(ops->locked.ops);
189 ops->locked.ops = NULL;
190 return 0;
191}
192
193static 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
c46219ac
ACM
206static 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
7a997fe4 213static struct ins_ops lock_ops = {
c46219ac 214 .free = lock__delete,
7a997fe4
ACM
215 .parse = lock__parse,
216 .scnprintf = lock__scnprintf,
217};
218
6de783b6
ACM
219static 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
258out_free_source:
259 free(ops->source.raw);
260 ops->source.raw = NULL;
261 return -1;
262}
263
264static 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
272static struct ins_ops mov_ops = {
273 .parse = mov__parse,
274 .scnprintf = mov__scnprintf,
275};
276
a43712c4
ACM
277static 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
306static 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
313static struct ins_ops dec_ops = {
314 .parse = dec__parse,
315 .scnprintf = dec__scnprintf,
316};
317
1d037ca1
IT
318static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
319 struct ins_operands *ops __maybe_unused)
b9818e93
ACM
320{
321 return scnprintf(bf, size, "%-6.6s", "nop");
322}
323
324static struct ins_ops nop_ops = {
325 .scnprintf = nop__scnprintf,
326};
327
4f9d0325
ACM
328/*
329 * Must be sorted by name!
330 */
331static struct ins instructions[] = {
6de783b6
ACM
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, },
7a997fe4 337 { .name = "bts", .ops = &mov_ops, },
d86b0597
ACM
338 { .name = "call", .ops = &call_ops, },
339 { .name = "callq", .ops = &call_ops, },
6de783b6
ACM
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, },
a43712c4
ACM
346 { .name = "dec", .ops = &dec_ops, },
347 { .name = "decl", .ops = &dec_ops, },
6de783b6 348 { .name = "imul", .ops = &mov_ops, },
a43712c4
ACM
349 { .name = "inc", .ops = &dec_ops, },
350 { .name = "incl", .ops = &dec_ops, },
4f9d0325 351 { .name = "ja", .ops = &jump_ops, },
3f862fd0
ACM
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, },
4f9d0325 357 { .name = "je", .ops = &jump_ops, },
3f862fd0
ACM
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, },
4f9d0325
ACM
363 { .name = "jmp", .ops = &jump_ops, },
364 { .name = "jmpq", .ops = &jump_ops, },
3f862fd0
ACM
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, },
4f9d0325 370 { .name = "jne", .ops = &jump_ops, },
3f862fd0
ACM
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, },
4f9d0325 384 { .name = "js", .ops = &jump_ops, },
3f862fd0 385 { .name = "jz", .ops = &jump_ops, },
6de783b6 386 { .name = "lea", .ops = &mov_ops, },
7a997fe4 387 { .name = "lock", .ops = &lock_ops, },
6de783b6
ACM
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, },
b9818e93
ACM
396 { .name = "nop", .ops = &nop_ops, },
397 { .name = "nopl", .ops = &nop_ops, },
398 { .name = "nopw", .ops = &nop_ops, },
6de783b6
ACM
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, },
7a997fe4 404 { .name = "xadd", .ops = &mov_ops, },
ffadcf09
AK
405 { .name = "xbeginl", .ops = &jump_ops, },
406 { .name = "xbeginq", .ops = &jump_ops, },
4f9d0325
ACM
407};
408
409static 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
416static 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
1d037ca1 423int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym)
78f7defe
ACM
424{
425 struct annotation *notes = symbol__annotation(sym);
ce6f4fab
ACM
426 pthread_mutex_init(&notes->lock, NULL);
427 return 0;
428}
78f7defe 429
d04b35f8 430int symbol__alloc_hist(struct symbol *sym)
ce6f4fab
ACM
431{
432 struct annotation *notes = symbol__annotation(sym);
1b2e2df4 433 const size_t size = symbol__size(sym);
8696329b
CS
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;
ce6f4fab 446
d04b35f8 447 notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
ce6f4fab
ACM
448 if (notes->src == NULL)
449 return -1;
450 notes->src->sizeof_sym_hist = sizeof_sym_hist;
d04b35f8 451 notes->src->nr_histograms = symbol_conf.nr_events;
ce6f4fab
ACM
452 INIT_LIST_HEAD(&notes->src->source);
453 return 0;
78f7defe
ACM
454}
455
36532461
ACM
456void symbol__annotate_zero_histograms(struct symbol *sym)
457{
458 struct annotation *notes = symbol__annotation(sym);
459
ce6f4fab
ACM
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);
36532461
ACM
465}
466
2f525d01
ACM
467int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
468 int evidx, u64 addr)
78f7defe 469{
2f525d01 470 unsigned offset;
78f7defe
ACM
471 struct annotation *notes;
472 struct sym_hist *h;
473
78f7defe 474 notes = symbol__annotation(sym);
ce6f4fab 475 if (notes->src == NULL)
78f7defe
ACM
476 return -ENOMEM;
477
78f7defe
ACM
478 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
479
31d68e7b
ACM
480 if (addr < sym->start || addr > sym->end)
481 return -ERANGE;
78f7defe 482
2f525d01
ACM
483 offset = addr - sym->start;
484 h = annotation__histogram(notes, evidx);
78f7defe
ACM
485 h->sum++;
486 h->addr[offset]++;
487
488 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
2f525d01
ACM
489 ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
490 addr, addr - sym->start, evidx, h->addr[offset]);
78f7defe
ACM
491 return 0;
492}
493
4f9d0325
ACM
494static 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
c7e6ead7
ACM
504 if (dl->ins->ops->parse)
505 dl->ins->ops->parse(&dl->ops);
4f9d0325
ACM
506}
507
7a997fe4
ACM
508static 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
540out_free_name:
541 free(*namep);
542 *namep = NULL;
543 return -1;
544}
545
29ed6e76 546static struct disasm_line *disasm_line__new(s64 offset, char *line, size_t privsize)
78f7defe 547{
5145418b 548 struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
78f7defe 549
29ed6e76
ACM
550 if (dl != NULL) {
551 dl->offset = offset;
552 dl->line = strdup(line);
553 if (dl->line == NULL)
058b4cc9 554 goto out_delete;
5145418b
ACM
555
556 if (offset != -1) {
7a997fe4 557 if (disasm_line__parse(dl->line, &dl->name, &dl->ops.raw) < 0)
5145418b
ACM
558 goto out_free_line;
559
4f9d0325 560 disasm_line__init_ins(dl);
5145418b 561 }
78f7defe
ACM
562 }
563
29ed6e76 564 return dl;
5145418b
ACM
565
566out_free_line:
567 free(dl->line);
058b4cc9 568out_delete:
29ed6e76 569 free(dl);
058b4cc9 570 return NULL;
78f7defe
ACM
571}
572
29ed6e76 573void disasm_line__free(struct disasm_line *dl)
78f7defe 574{
29ed6e76 575 free(dl->line);
5145418b 576 free(dl->name);
c46219ac
ACM
577 if (dl->ins && dl->ins->ops->free)
578 dl->ins->ops->free(&dl->ops);
579 else
580 ins__delete(&dl->ops);
29ed6e76 581 free(dl);
78f7defe
ACM
582}
583
5417072b
ACM
584int 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
29ed6e76 592static void disasm__add(struct list_head *head, struct disasm_line *line)
78f7defe
ACM
593{
594 list_add_tail(&line->node, head);
595}
596
29ed6e76 597struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
78f7defe
ACM
598{
599 list_for_each_entry_continue(pos, head, node)
600 if (pos->offset >= 0)
601 return pos;
602
603 return NULL;
604}
605
29ed6e76 606static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
db8fd07a 607 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
29ed6e76 608 int max_lines, struct disasm_line *queue)
78f7defe
ACM
609{
610 static const char *prev_line;
611 static const char *prev_color;
612
29ed6e76 613 if (dl->offset != -1) {
78f7defe
ACM
614 const char *path = NULL;
615 unsigned int hits = 0;
616 double percent = 0.0;
617 const char *color;
618 struct annotation *notes = symbol__annotation(sym);
ce6f4fab 619 struct source_line *src_line = notes->src->lines;
db8fd07a 620 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
29ed6e76 621 s64 offset = dl->offset;
058b4cc9 622 const u64 addr = start + offset;
29ed6e76 623 struct disasm_line *next;
ce6f4fab 624
29ed6e76 625 next = disasm__get_next_ip_line(&notes->src->source, dl);
78f7defe
ACM
626
627 while (offset < (s64)len &&
628 (next == NULL || offset < next->offset)) {
629 if (src_line) {
630 if (path == NULL)
631 path = src_line[offset].path;
632 percent += src_line[offset].percent;
633 } else
634 hits += h->addr[offset];
635
636 ++offset;
637 }
638
639 if (src_line == NULL && h->sum)
640 percent = 100.0 * hits / h->sum;
641
d040bd36 642 if (percent < min_pcnt)
36532461
ACM
643 return -1;
644
e3087b80 645 if (max_lines && printed >= max_lines)
36532461 646 return 1;
d040bd36 647
d5e3d747
ACM
648 if (queue != NULL) {
649 list_for_each_entry_from(queue, &notes->src->source, node) {
29ed6e76 650 if (queue == dl)
d5e3d747 651 break;
db8fd07a 652 disasm_line__print(queue, sym, start, evsel, len,
d5e3d747
ACM
653 0, 0, 1, NULL);
654 }
655 }
656
78f7defe
ACM
657 color = get_percent_color(percent);
658
659 /*
660 * Also color the filename and line if needed, with
661 * the same color than the percentage. Don't print it
662 * twice for close colored addr with the same filename:line
663 */
664 if (path) {
665 if (!prev_line || strcmp(prev_line, path)
666 || color != prev_color) {
667 color_fprintf(stdout, color, " %s", path);
668 prev_line = path;
669 prev_color = color;
670 }
671 }
672
673 color_fprintf(stdout, color, " %7.2f", percent);
674 printf(" : ");
058b4cc9 675 color_fprintf(stdout, PERF_COLOR_MAGENTA, " %" PRIx64 ":", addr);
29ed6e76 676 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", dl->line);
e3087b80 677 } else if (max_lines && printed >= max_lines)
36532461
ACM
678 return 1;
679 else {
d5e3d747
ACM
680 if (queue)
681 return -1;
682
29ed6e76 683 if (!*dl->line)
78f7defe
ACM
684 printf(" :\n");
685 else
29ed6e76 686 printf(" : %s\n", dl->line);
78f7defe 687 }
36532461
ACM
688
689 return 0;
78f7defe
ACM
690}
691
ce6f4fab
ACM
692static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
693 FILE *file, size_t privsize)
78f7defe 694{
ce6f4fab 695 struct annotation *notes = symbol__annotation(sym);
29ed6e76 696 struct disasm_line *dl;
058b4cc9 697 char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
78f7defe
ACM
698 size_t line_len;
699 s64 line_ip, offset = -1;
700
701 if (getline(&line, &line_len, file) < 0)
702 return -1;
703
704 if (!line)
705 return -1;
706
707 while (line_len != 0 && isspace(line[line_len - 1]))
708 line[--line_len] = '\0';
709
710 c = strchr(line, '\n');
711 if (c)
712 *c = 0;
713
714 line_ip = -1;
a31b7cc0 715 parsed_line = line;
78f7defe
ACM
716
717 /*
718 * Strip leading spaces:
719 */
720 tmp = line;
721 while (*tmp) {
722 if (*tmp != ' ')
723 break;
724 tmp++;
725 }
726
727 if (*tmp) {
728 /*
729 * Parse hexa addresses followed by ':'
730 */
731 line_ip = strtoull(tmp, &tmp2, 16);
732 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
733 line_ip = -1;
734 }
735
736 if (line_ip != -1) {
737 u64 start = map__rip_2objdump(map, sym->start),
738 end = map__rip_2objdump(map, sym->end);
739
740 offset = line_ip - start;
741 if (offset < 0 || (u64)line_ip > end)
742 offset = -1;
058b4cc9
ACM
743 else
744 parsed_line = tmp2 + 1;
a31b7cc0 745 }
78f7defe 746
29ed6e76 747 dl = disasm_line__new(offset, parsed_line, privsize);
058b4cc9
ACM
748 free(line);
749
29ed6e76 750 if (dl == NULL)
78f7defe 751 return -1;
058b4cc9 752
29ed6e76 753 disasm__add(&notes->src->source, dl);
78f7defe
ACM
754
755 return 0;
756}
757
ce6f4fab 758int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize)
78f7defe
ACM
759{
760 struct dso *dso = map->dso;
761 char *filename = dso__build_id_filename(dso, NULL, 0);
762 bool free_filename = true;
763 char command[PATH_MAX * 2];
764 FILE *file;
765 int err = 0;
78f7defe
ACM
766 char symfs_filename[PATH_MAX];
767
768 if (filename) {
769 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
770 symbol_conf.symfs, filename);
771 }
772
773 if (filename == NULL) {
774 if (dso->has_build_id) {
775 pr_err("Can't annotate %s: not enough memory\n",
776 sym->name);
777 return -ENOMEM;
778 }
779 goto fallback;
780 } else if (readlink(symfs_filename, command, sizeof(command)) < 0 ||
781 strstr(command, "[kernel.kallsyms]") ||
782 access(symfs_filename, R_OK)) {
783 free(filename);
784fallback:
785 /*
786 * If we don't have build-ids or the build-id file isn't in the
787 * cache, or is just a kallsyms file, well, lets hope that this
788 * DSO is the same as when 'perf record' ran.
789 */
790 filename = dso->long_name;
791 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
792 symbol_conf.symfs, filename);
793 free_filename = false;
794 }
795
44f24cb3 796 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS) {
170ae6bc
ACM
797 char bf[BUILD_ID_SIZE * 2 + 16] = " with build id ";
798 char *build_id_msg = NULL;
799
78f7defe
ACM
800 if (dso->annotate_warned)
801 goto out_free_filename;
170ae6bc
ACM
802
803 if (dso->has_build_id) {
804 build_id__sprintf(dso->build_id,
805 sizeof(dso->build_id), bf + 15);
806 build_id_msg = bf;
807 }
78f7defe
ACM
808 err = -ENOENT;
809 dso->annotate_warned = 1;
ae55795e
ACM
810 pr_err("Can't annotate %s:\n\n"
811 "No vmlinux file%s\nwas found in the path.\n\n"
812 "Please use:\n\n"
e3a34029 813 " perf buildid-cache -vu vmlinux\n\n"
ae55795e 814 "or:\n\n"
ff2a6617 815 " --vmlinux vmlinux\n",
170ae6bc 816 sym->name, build_id_msg ?: "");
78f7defe
ACM
817 goto out_free_filename;
818 }
819
820 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
821 filename, sym->name, map->unmap_ip(map, sym->start),
822 map->unmap_ip(map, sym->end));
823
78f7defe
ACM
824 pr_debug("annotating [%p] %30s : [%p] %30s\n",
825 dso, dso->long_name, sym, sym->name);
826
827 snprintf(command, sizeof(command),
7a4ec938 828 "%s %s%s --start-address=0x%016" PRIx64
3e6a2a7f
SE
829 " --stop-address=0x%016" PRIx64
830 " -d %s %s -C %s|grep -v %s|expand",
7a4ec938 831 objdump_path ? objdump_path : "objdump",
f69b64f7
AK
832 disassembler_style ? "-M " : "",
833 disassembler_style ? disassembler_style : "",
78f7defe 834 map__rip_2objdump(map, sym->start),
f41612f4 835 map__rip_2objdump(map, sym->end+1),
3e6a2a7f
SE
836 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
837 symbol_conf.annotate_src ? "-S" : "",
78f7defe
ACM
838 symfs_filename, filename);
839
840 pr_debug("Executing: %s\n", command);
841
842 file = popen(command, "r");
843 if (!file)
844 goto out_free_filename;
845
846 while (!feof(file))
ce6f4fab 847 if (symbol__parse_objdump_line(sym, map, file, privsize) < 0)
78f7defe
ACM
848 break;
849
850 pclose(file);
851out_free_filename:
852 if (free_filename)
853 free(filename);
854 return err;
855}
856
857static void insert_source_line(struct rb_root *root, struct source_line *src_line)
858{
859 struct source_line *iter;
860 struct rb_node **p = &root->rb_node;
861 struct rb_node *parent = NULL;
41127965 862 int ret;
78f7defe
ACM
863
864 while (*p != NULL) {
865 parent = *p;
866 iter = rb_entry(parent, struct source_line, node);
867
41127965
NK
868 ret = strcmp(iter->path, src_line->path);
869 if (ret == 0) {
870 iter->percent_sum += src_line->percent;
871 return;
872 }
873
874 if (ret < 0)
875 p = &(*p)->rb_left;
876 else
877 p = &(*p)->rb_right;
878 }
879
880 src_line->percent_sum = src_line->percent;
881
882 rb_link_node(&src_line->node, parent, p);
883 rb_insert_color(&src_line->node, root);
884}
885
886static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
887{
888 struct source_line *iter;
889 struct rb_node **p = &root->rb_node;
890 struct rb_node *parent = NULL;
891
892 while (*p != NULL) {
893 parent = *p;
894 iter = rb_entry(parent, struct source_line, node);
895
896 if (src_line->percent_sum > iter->percent_sum)
78f7defe
ACM
897 p = &(*p)->rb_left;
898 else
899 p = &(*p)->rb_right;
900 }
901
902 rb_link_node(&src_line->node, parent, p);
903 rb_insert_color(&src_line->node, root);
904}
905
41127965
NK
906static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
907{
908 struct source_line *src_line;
909 struct rb_node *node;
910
911 node = rb_first(src_root);
912 while (node) {
913 struct rb_node *next;
914
915 src_line = rb_entry(node, struct source_line, node);
916 next = rb_next(node);
917 rb_erase(node, src_root);
918
919 __resort_source_line(dest_root, src_line);
920 node = next;
921 }
922}
923
78f7defe
ACM
924static void symbol__free_source_line(struct symbol *sym, int len)
925{
926 struct annotation *notes = symbol__annotation(sym);
ce6f4fab 927 struct source_line *src_line = notes->src->lines;
78f7defe
ACM
928 int i;
929
930 for (i = 0; i < len; i++)
931 free(src_line[i].path);
932
933 free(src_line);
ce6f4fab 934 notes->src->lines = NULL;
78f7defe
ACM
935}
936
937/* Get the filename:line for the colored entries */
938static int symbol__get_source_line(struct symbol *sym, struct map *map,
db8fd07a
NK
939 struct perf_evsel *evsel,
940 struct rb_root *root, int len,
78f7defe
ACM
941 const char *filename)
942{
943 u64 start;
944 int i;
945 char cmd[PATH_MAX * 2];
946 struct source_line *src_line;
947 struct annotation *notes = symbol__annotation(sym);
db8fd07a 948 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
41127965 949 struct rb_root tmp_root = RB_ROOT;
78f7defe
ACM
950
951 if (!h->sum)
952 return 0;
953
ce6f4fab
ACM
954 src_line = notes->src->lines = calloc(len, sizeof(struct source_line));
955 if (!notes->src->lines)
78f7defe
ACM
956 return -1;
957
f40a0633 958 start = map__rip_2objdump(map, sym->start);
78f7defe
ACM
959
960 for (i = 0; i < len; i++) {
961 char *path = NULL;
962 size_t line_len;
963 u64 offset;
964 FILE *fp;
965
966 src_line[i].percent = 100.0 * h->addr[i] / h->sum;
967 if (src_line[i].percent <= 0.5)
968 continue;
969
970 offset = start + i;
971 sprintf(cmd, "addr2line -e %s %016" PRIx64, filename, offset);
972 fp = popen(cmd, "r");
973 if (!fp)
974 continue;
975
976 if (getline(&path, &line_len, fp) < 0 || !line_len)
977 goto next;
978
979 src_line[i].path = malloc(sizeof(char) * line_len + 1);
980 if (!src_line[i].path)
981 goto next;
982
983 strcpy(src_line[i].path, path);
41127965 984 insert_source_line(&tmp_root, &src_line[i]);
78f7defe
ACM
985
986 next:
987 pclose(fp);
988 }
989
41127965 990 resort_source_line(root, &tmp_root);
78f7defe
ACM
991 return 0;
992}
993
994static void print_summary(struct rb_root *root, const char *filename)
995{
996 struct source_line *src_line;
997 struct rb_node *node;
998
999 printf("\nSorted summary for file %s\n", filename);
1000 printf("----------------------------------------------\n\n");
1001
1002 if (RB_EMPTY_ROOT(root)) {
1003 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1004 return;
1005 }
1006
1007 node = rb_first(root);
1008 while (node) {
1009 double percent;
1010 const char *color;
1011 char *path;
1012
1013 src_line = rb_entry(node, struct source_line, node);
41127965 1014 percent = src_line->percent_sum;
78f7defe
ACM
1015 color = get_percent_color(percent);
1016 path = src_line->path;
1017
1018 color_fprintf(stdout, color, " %7.2f %s", percent, path);
1019 node = rb_next(node);
1020 }
1021}
1022
db8fd07a 1023static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
78f7defe
ACM
1024{
1025 struct annotation *notes = symbol__annotation(sym);
db8fd07a 1026 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1b2e2df4 1027 u64 len = symbol__size(sym), offset;
78f7defe
ACM
1028
1029 for (offset = 0; offset < len; ++offset)
1030 if (h->addr[offset] != 0)
1031 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1032 sym->start + offset, h->addr[offset]);
1033 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1034}
1035
db8fd07a
NK
1036int symbol__annotate_printf(struct symbol *sym, struct map *map,
1037 struct perf_evsel *evsel, bool full_paths,
1038 int min_pcnt, int max_lines, int context)
78f7defe
ACM
1039{
1040 struct dso *dso = map->dso;
bfd14b9a
DA
1041 char *filename;
1042 const char *d_filename;
ce6f4fab 1043 struct annotation *notes = symbol__annotation(sym);
29ed6e76 1044 struct disasm_line *pos, *queue = NULL;
058b4cc9 1045 u64 start = map__rip_2objdump(map, sym->start);
d5e3d747 1046 int printed = 2, queue_len = 0;
36532461 1047 int more = 0;
78f7defe
ACM
1048 u64 len;
1049
bfd14b9a
DA
1050 filename = strdup(dso->long_name);
1051 if (!filename)
1052 return -ENOMEM;
1053
78f7defe
ACM
1054 if (full_paths)
1055 d_filename = filename;
1056 else
1057 d_filename = basename(filename);
1058
1b2e2df4 1059 len = symbol__size(sym);
78f7defe 1060
78f7defe
ACM
1061 printf(" Percent | Source code & Disassembly of %s\n", d_filename);
1062 printf("------------------------------------------------\n");
1063
1064 if (verbose)
db8fd07a 1065 symbol__annotate_hits(sym, evsel);
78f7defe 1066
ce6f4fab 1067 list_for_each_entry(pos, &notes->src->source, node) {
d5e3d747
ACM
1068 if (context && queue == NULL) {
1069 queue = pos;
1070 queue_len = 0;
1071 }
1072
db8fd07a 1073 switch (disasm_line__print(pos, sym, start, evsel, len,
058b4cc9
ACM
1074 min_pcnt, printed, max_lines,
1075 queue)) {
36532461
ACM
1076 case 0:
1077 ++printed;
d5e3d747
ACM
1078 if (context) {
1079 printed += queue_len;
1080 queue = NULL;
1081 queue_len = 0;
1082 }
36532461
ACM
1083 break;
1084 case 1:
1085 /* filtered by max_lines */
1086 ++more;
d040bd36 1087 break;
36532461
ACM
1088 case -1:
1089 default:
d5e3d747
ACM
1090 /*
1091 * Filtered by min_pcnt or non IP lines when
1092 * context != 0
1093 */
1094 if (!context)
1095 break;
1096 if (queue_len == context)
1097 queue = list_entry(queue->node.next, typeof(*queue), node);
1098 else
1099 ++queue_len;
36532461
ACM
1100 break;
1101 }
1102 }
1103
bfd14b9a
DA
1104 free(filename);
1105
36532461
ACM
1106 return more;
1107}
f1e2701d 1108
36532461
ACM
1109void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1110{
1111 struct annotation *notes = symbol__annotation(sym);
1112 struct sym_hist *h = annotation__histogram(notes, evidx);
1113
ce6f4fab 1114 memset(h, 0, notes->src->sizeof_sym_hist);
36532461
ACM
1115}
1116
ce6f4fab 1117void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
36532461
ACM
1118{
1119 struct annotation *notes = symbol__annotation(sym);
1120 struct sym_hist *h = annotation__histogram(notes, evidx);
1b2e2df4 1121 int len = symbol__size(sym), offset;
36532461
ACM
1122
1123 h->sum = 0;
8b84a568
ACM
1124 for (offset = 0; offset < len; ++offset) {
1125 h->addr[offset] = h->addr[offset] * 7 / 8;
1126 h->sum += h->addr[offset];
f1e2701d
ACM
1127 }
1128}
1129
29ed6e76 1130void disasm__purge(struct list_head *head)
f1e2701d 1131{
29ed6e76 1132 struct disasm_line *pos, *n;
f1e2701d
ACM
1133
1134 list_for_each_entry_safe(pos, n, head, node) {
1135 list_del(&pos->node);
29ed6e76 1136 disasm_line__free(pos);
f1e2701d
ACM
1137 }
1138}
1139
5145418b
ACM
1140static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1141{
1142 size_t printed;
1143
1144 if (dl->offset == -1)
1145 return fprintf(fp, "%s\n", dl->line);
1146
1147 printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->name);
1148
c7e6ead7 1149 if (dl->ops.raw[0] != '\0') {
5145418b 1150 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
c7e6ead7 1151 dl->ops.raw);
5145418b
ACM
1152 }
1153
1154 return printed + fprintf(fp, "\n");
1155}
1156
1157size_t disasm__fprintf(struct list_head *head, FILE *fp)
1158{
1159 struct disasm_line *pos;
1160 size_t printed = 0;
1161
1162 list_for_each_entry(pos, head, node)
1163 printed += disasm_line__fprintf(pos, fp);
1164
1165 return printed;
1166}
1167
db8fd07a
NK
1168int symbol__tty_annotate(struct symbol *sym, struct map *map,
1169 struct perf_evsel *evsel, bool print_lines,
1170 bool full_paths, int min_pcnt, int max_lines)
f1e2701d
ACM
1171{
1172 struct dso *dso = map->dso;
1173 const char *filename = dso->long_name;
1174 struct rb_root source_line = RB_ROOT;
f1e2701d
ACM
1175 u64 len;
1176
ce6f4fab 1177 if (symbol__annotate(sym, map, 0) < 0)
f1e2701d
ACM
1178 return -1;
1179
1b2e2df4 1180 len = symbol__size(sym);
f1e2701d
ACM
1181
1182 if (print_lines) {
db8fd07a 1183 symbol__get_source_line(sym, map, evsel, &source_line,
f1e2701d
ACM
1184 len, filename);
1185 print_summary(&source_line, filename);
78f7defe
ACM
1186 }
1187
db8fd07a 1188 symbol__annotate_printf(sym, map, evsel, full_paths,
d5e3d747 1189 min_pcnt, max_lines, 0);
78f7defe
ACM
1190 if (print_lines)
1191 symbol__free_source_line(sym, len);
1192
29ed6e76 1193 disasm__purge(&symbol__annotation(sym)->src->source);
f1e2701d 1194
78f7defe
ACM
1195 return 0;
1196}