Merge tag 'locks-v3.16-2' of git://git.samba.org/jlayton/linux
[linux/fpc-iii.git] / tools / perf / util / annotate.c
blob809b4c50beaed3e3a57845919b3a034fe7ab8c9e
1 /*
2 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
4 * Parts came from builtin-annotate.c, see those files for further
5 * copyright notes.
7 * Released under the GPL v2. (and only v2, not any later version)
8 */
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 <pthread.h>
21 #include <linux/bitops.h>
23 const char *disassembler_style;
24 const char *objdump_path;
26 static struct ins *ins__find(const char *name);
27 static int disasm_line__parse(char *line, char **namep, char **rawp);
29 static void ins__delete(struct ins_operands *ops)
31 zfree(&ops->source.raw);
32 zfree(&ops->source.name);
33 zfree(&ops->target.raw);
34 zfree(&ops->target.name);
37 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
38 struct ins_operands *ops)
40 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->raw);
43 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
44 struct ins_operands *ops)
46 if (ins->ops->scnprintf)
47 return ins->ops->scnprintf(ins, bf, size, ops);
49 return ins__raw_scnprintf(ins, bf, size, ops);
52 static int call__parse(struct ins_operands *ops)
54 char *endptr, *tok, *name;
56 ops->target.addr = strtoull(ops->raw, &endptr, 16);
58 name = strchr(endptr, '<');
59 if (name == NULL)
60 goto indirect_call;
62 name++;
64 tok = strchr(name, '>');
65 if (tok == NULL)
66 return -1;
68 *tok = '\0';
69 ops->target.name = strdup(name);
70 *tok = '>';
72 return ops->target.name == NULL ? -1 : 0;
74 indirect_call:
75 tok = strchr(endptr, '(');
76 if (tok != NULL) {
77 ops->target.addr = 0;
78 return 0;
81 tok = strchr(endptr, '*');
82 if (tok == NULL)
83 return -1;
85 ops->target.addr = strtoull(tok + 1, NULL, 16);
86 return 0;
89 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
90 struct ins_operands *ops)
92 if (ops->target.name)
93 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
95 if (ops->target.addr == 0)
96 return ins__raw_scnprintf(ins, bf, size, ops);
98 return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
101 static struct ins_ops call_ops = {
102 .parse = call__parse,
103 .scnprintf = call__scnprintf,
106 bool ins__is_call(const struct ins *ins)
108 return ins->ops == &call_ops;
111 static int jump__parse(struct ins_operands *ops)
113 const char *s = strchr(ops->raw, '+');
115 ops->target.addr = strtoull(ops->raw, NULL, 16);
117 if (s++ != NULL)
118 ops->target.offset = strtoull(s, NULL, 16);
119 else
120 ops->target.offset = UINT64_MAX;
122 return 0;
125 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
126 struct ins_operands *ops)
128 return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
131 static struct ins_ops jump_ops = {
132 .parse = jump__parse,
133 .scnprintf = jump__scnprintf,
136 bool ins__is_jump(const struct ins *ins)
138 return ins->ops == &jump_ops;
141 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
143 char *endptr, *name, *t;
145 if (strstr(raw, "(%rip)") == NULL)
146 return 0;
148 *addrp = strtoull(comment, &endptr, 16);
149 name = strchr(endptr, '<');
150 if (name == NULL)
151 return -1;
153 name++;
155 t = strchr(name, '>');
156 if (t == NULL)
157 return 0;
159 *t = '\0';
160 *namep = strdup(name);
161 *t = '>';
163 return 0;
166 static int lock__parse(struct ins_operands *ops)
168 char *name;
170 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
171 if (ops->locked.ops == NULL)
172 return 0;
174 if (disasm_line__parse(ops->raw, &name, &ops->locked.ops->raw) < 0)
175 goto out_free_ops;
177 ops->locked.ins = ins__find(name);
178 if (ops->locked.ins == NULL)
179 goto out_free_ops;
181 if (!ops->locked.ins->ops)
182 return 0;
184 if (ops->locked.ins->ops->parse)
185 ops->locked.ins->ops->parse(ops->locked.ops);
187 return 0;
189 out_free_ops:
190 zfree(&ops->locked.ops);
191 return 0;
194 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
195 struct ins_operands *ops)
197 int printed;
199 if (ops->locked.ins == NULL)
200 return ins__raw_scnprintf(ins, bf, size, ops);
202 printed = scnprintf(bf, size, "%-6.6s ", ins->name);
203 return printed + ins__scnprintf(ops->locked.ins, bf + printed,
204 size - printed, ops->locked.ops);
207 static void lock__delete(struct ins_operands *ops)
209 zfree(&ops->locked.ops);
210 zfree(&ops->target.raw);
211 zfree(&ops->target.name);
214 static struct ins_ops lock_ops = {
215 .free = lock__delete,
216 .parse = lock__parse,
217 .scnprintf = lock__scnprintf,
220 static int mov__parse(struct ins_operands *ops)
222 char *s = strchr(ops->raw, ','), *target, *comment, prev;
224 if (s == NULL)
225 return -1;
227 *s = '\0';
228 ops->source.raw = strdup(ops->raw);
229 *s = ',';
231 if (ops->source.raw == NULL)
232 return -1;
234 target = ++s;
236 while (s[0] != '\0' && !isspace(s[0]))
237 ++s;
238 prev = *s;
239 *s = '\0';
241 ops->target.raw = strdup(target);
242 *s = prev;
244 if (ops->target.raw == NULL)
245 goto out_free_source;
247 comment = strchr(s, '#');
248 if (comment == NULL)
249 return 0;
251 while (comment[0] != '\0' && isspace(comment[0]))
252 ++comment;
254 comment__symbol(ops->source.raw, comment, &ops->source.addr, &ops->source.name);
255 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
257 return 0;
259 out_free_source:
260 zfree(&ops->source.raw);
261 return -1;
264 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
265 struct ins_operands *ops)
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);
272 static struct ins_ops mov_ops = {
273 .parse = mov__parse,
274 .scnprintf = mov__scnprintf,
277 static int dec__parse(struct ins_operands *ops)
279 char *target, *comment, *s, prev;
281 target = s = ops->raw;
283 while (s[0] != '\0' && !isspace(s[0]))
284 ++s;
285 prev = *s;
286 *s = '\0';
288 ops->target.raw = strdup(target);
289 *s = prev;
291 if (ops->target.raw == NULL)
292 return -1;
294 comment = strchr(s, '#');
295 if (comment == NULL)
296 return 0;
298 while (comment[0] != '\0' && isspace(comment[0]))
299 ++comment;
301 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
303 return 0;
306 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
307 struct ins_operands *ops)
309 return scnprintf(bf, size, "%-6.6s %s", ins->name,
310 ops->target.name ?: ops->target.raw);
313 static struct ins_ops dec_ops = {
314 .parse = dec__parse,
315 .scnprintf = dec__scnprintf,
318 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
319 struct ins_operands *ops __maybe_unused)
321 return scnprintf(bf, size, "%-6.6s", "nop");
324 static struct ins_ops nop_ops = {
325 .scnprintf = nop__scnprintf,
329 * Must be sorted by name!
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, },
409 static int ins__cmp(const void *name, const void *insp)
411 const struct ins *ins = insp;
413 return strcmp(name, ins->name);
416 static struct ins *ins__find(const char *name)
418 const int nmemb = ARRAY_SIZE(instructions);
420 return bsearch(name, instructions, nmemb, sizeof(struct ins), ins__cmp);
423 int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym)
425 struct annotation *notes = symbol__annotation(sym);
426 pthread_mutex_init(&notes->lock, NULL);
427 return 0;
430 int symbol__alloc_hist(struct symbol *sym)
432 struct annotation *notes = symbol__annotation(sym);
433 const size_t size = symbol__size(sym);
434 size_t sizeof_sym_hist;
436 /* Check for overflow when calculating sizeof_sym_hist */
437 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(u64))
438 return -1;
440 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(u64));
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;
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;
456 void symbol__annotate_zero_histograms(struct symbol *sym)
458 struct annotation *notes = symbol__annotation(sym);
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);
467 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
468 struct annotation *notes, int evidx, u64 addr)
470 unsigned offset;
471 struct sym_hist *h;
473 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
475 if (addr < sym->start || addr > sym->end)
476 return -ERANGE;
478 offset = addr - sym->start;
479 h = annotation__histogram(notes, evidx);
480 h->sum++;
481 h->addr[offset]++;
483 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
484 ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
485 addr, addr - sym->start, evidx, h->addr[offset]);
486 return 0;
489 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
490 int evidx, u64 addr)
492 struct annotation *notes;
494 if (sym == NULL)
495 return 0;
497 notes = symbol__annotation(sym);
498 if (notes->src == NULL) {
499 if (symbol__alloc_hist(sym) < 0)
500 return -ENOMEM;
503 return __symbol__inc_addr_samples(sym, map, notes, evidx, addr);
506 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx)
508 return symbol__inc_addr_samples(ams->sym, ams->map, evidx, ams->al_addr);
511 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 ip)
513 return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evidx, ip);
516 static void disasm_line__init_ins(struct disasm_line *dl)
518 dl->ins = ins__find(dl->name);
520 if (dl->ins == NULL)
521 return;
523 if (!dl->ins->ops)
524 return;
526 if (dl->ins->ops->parse)
527 dl->ins->ops->parse(&dl->ops);
530 static int disasm_line__parse(char *line, char **namep, char **rawp)
532 char *name = line, tmp;
534 while (isspace(name[0]))
535 ++name;
537 if (name[0] == '\0')
538 return -1;
540 *rawp = name + 1;
542 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
543 ++*rawp;
545 tmp = (*rawp)[0];
546 (*rawp)[0] = '\0';
547 *namep = strdup(name);
549 if (*namep == NULL)
550 goto out_free_name;
552 (*rawp)[0] = tmp;
554 if ((*rawp)[0] != '\0') {
555 (*rawp)++;
556 while (isspace((*rawp)[0]))
557 ++(*rawp);
560 return 0;
562 out_free_name:
563 zfree(namep);
564 return -1;
567 static struct disasm_line *disasm_line__new(s64 offset, char *line, size_t privsize)
569 struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
571 if (dl != NULL) {
572 dl->offset = offset;
573 dl->line = strdup(line);
574 if (dl->line == NULL)
575 goto out_delete;
577 if (offset != -1) {
578 if (disasm_line__parse(dl->line, &dl->name, &dl->ops.raw) < 0)
579 goto out_free_line;
581 disasm_line__init_ins(dl);
585 return dl;
587 out_free_line:
588 zfree(&dl->line);
589 out_delete:
590 free(dl);
591 return NULL;
594 void disasm_line__free(struct disasm_line *dl)
596 zfree(&dl->line);
597 zfree(&dl->name);
598 if (dl->ins && dl->ins->ops->free)
599 dl->ins->ops->free(&dl->ops);
600 else
601 ins__delete(&dl->ops);
602 free(dl);
605 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
607 if (raw || !dl->ins)
608 return scnprintf(bf, size, "%-6.6s %s", dl->name, dl->ops.raw);
610 return ins__scnprintf(dl->ins, bf, size, &dl->ops);
613 static void disasm__add(struct list_head *head, struct disasm_line *line)
615 list_add_tail(&line->node, head);
618 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
620 list_for_each_entry_continue(pos, head, node)
621 if (pos->offset >= 0)
622 return pos;
624 return NULL;
627 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
628 s64 end, const char **path)
630 struct source_line *src_line = notes->src->lines;
631 double percent = 0.0;
633 if (src_line) {
634 size_t sizeof_src_line = sizeof(*src_line) +
635 sizeof(src_line->p) * (src_line->nr_pcnt - 1);
637 while (offset < end) {
638 src_line = (void *)notes->src->lines +
639 (sizeof_src_line * offset);
641 if (*path == NULL)
642 *path = src_line->path;
644 percent += src_line->p[evidx].percent;
645 offset++;
647 } else {
648 struct sym_hist *h = annotation__histogram(notes, evidx);
649 unsigned int hits = 0;
651 while (offset < end)
652 hits += h->addr[offset++];
654 if (h->sum)
655 percent = 100.0 * hits / h->sum;
658 return percent;
661 static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
662 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
663 int max_lines, struct disasm_line *queue)
665 static const char *prev_line;
666 static const char *prev_color;
668 if (dl->offset != -1) {
669 const char *path = NULL;
670 double percent, max_percent = 0.0;
671 double *ppercents = &percent;
672 int i, nr_percent = 1;
673 const char *color;
674 struct annotation *notes = symbol__annotation(sym);
675 s64 offset = dl->offset;
676 const u64 addr = start + offset;
677 struct disasm_line *next;
679 next = disasm__get_next_ip_line(&notes->src->source, dl);
681 if (perf_evsel__is_group_event(evsel)) {
682 nr_percent = evsel->nr_members;
683 ppercents = calloc(nr_percent, sizeof(double));
684 if (ppercents == NULL)
685 return -1;
688 for (i = 0; i < nr_percent; i++) {
689 percent = disasm__calc_percent(notes,
690 notes->src->lines ? i : evsel->idx + i,
691 offset,
692 next ? next->offset : (s64) len,
693 &path);
695 ppercents[i] = percent;
696 if (percent > max_percent)
697 max_percent = percent;
700 if (max_percent < min_pcnt)
701 return -1;
703 if (max_lines && printed >= max_lines)
704 return 1;
706 if (queue != NULL) {
707 list_for_each_entry_from(queue, &notes->src->source, node) {
708 if (queue == dl)
709 break;
710 disasm_line__print(queue, sym, start, evsel, len,
711 0, 0, 1, NULL);
715 color = get_percent_color(max_percent);
718 * Also color the filename and line if needed, with
719 * the same color than the percentage. Don't print it
720 * twice for close colored addr with the same filename:line
722 if (path) {
723 if (!prev_line || strcmp(prev_line, path)
724 || color != prev_color) {
725 color_fprintf(stdout, color, " %s", path);
726 prev_line = path;
727 prev_color = color;
731 for (i = 0; i < nr_percent; i++) {
732 percent = ppercents[i];
733 color = get_percent_color(percent);
734 color_fprintf(stdout, color, " %7.2f", percent);
737 printf(" : ");
738 color_fprintf(stdout, PERF_COLOR_MAGENTA, " %" PRIx64 ":", addr);
739 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", dl->line);
741 if (ppercents != &percent)
742 free(ppercents);
744 } else if (max_lines && printed >= max_lines)
745 return 1;
746 else {
747 int width = 8;
749 if (queue)
750 return -1;
752 if (perf_evsel__is_group_event(evsel))
753 width *= evsel->nr_members;
755 if (!*dl->line)
756 printf(" %*s:\n", width, " ");
757 else
758 printf(" %*s: %s\n", width, " ", dl->line);
761 return 0;
765 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
766 * which looks like following
768 * 0000000000415500 <_init>:
769 * 415500: sub $0x8,%rsp
770 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
771 * 41550b: test %rax,%rax
772 * 41550e: je 415515 <_init+0x15>
773 * 415510: callq 416e70 <__gmon_start__@plt>
774 * 415515: add $0x8,%rsp
775 * 415519: retq
777 * it will be parsed and saved into struct disasm_line as
778 * <offset> <name> <ops.raw>
780 * The offset will be a relative offset from the start of the symbol and -1
781 * means that it's not a disassembly line so should be treated differently.
782 * The ops.raw part will be parsed further according to type of the instruction.
784 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
785 FILE *file, size_t privsize)
787 struct annotation *notes = symbol__annotation(sym);
788 struct disasm_line *dl;
789 char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
790 size_t line_len;
791 s64 line_ip, offset = -1;
793 if (getline(&line, &line_len, file) < 0)
794 return -1;
796 if (!line)
797 return -1;
799 while (line_len != 0 && isspace(line[line_len - 1]))
800 line[--line_len] = '\0';
802 c = strchr(line, '\n');
803 if (c)
804 *c = 0;
806 line_ip = -1;
807 parsed_line = line;
810 * Strip leading spaces:
812 tmp = line;
813 while (*tmp) {
814 if (*tmp != ' ')
815 break;
816 tmp++;
819 if (*tmp) {
821 * Parse hexa addresses followed by ':'
823 line_ip = strtoull(tmp, &tmp2, 16);
824 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
825 line_ip = -1;
828 if (line_ip != -1) {
829 u64 start = map__rip_2objdump(map, sym->start),
830 end = map__rip_2objdump(map, sym->end);
832 offset = line_ip - start;
833 if ((u64)line_ip < start || (u64)line_ip > end)
834 offset = -1;
835 else
836 parsed_line = tmp2 + 1;
839 dl = disasm_line__new(offset, parsed_line, privsize);
840 free(line);
842 if (dl == NULL)
843 return -1;
845 if (dl->ops.target.offset == UINT64_MAX)
846 dl->ops.target.offset = dl->ops.target.addr -
847 map__rip_2objdump(map, sym->start);
849 /* kcore has no symbols, so add the call target name */
850 if (dl->ins && ins__is_call(dl->ins) && !dl->ops.target.name) {
851 struct addr_map_symbol target = {
852 .map = map,
853 .addr = dl->ops.target.addr,
856 if (!map_groups__find_ams(&target, NULL) &&
857 target.sym->start == target.al_addr)
858 dl->ops.target.name = strdup(target.sym->name);
861 disasm__add(&notes->src->source, dl);
863 return 0;
866 static void delete_last_nop(struct symbol *sym)
868 struct annotation *notes = symbol__annotation(sym);
869 struct list_head *list = &notes->src->source;
870 struct disasm_line *dl;
872 while (!list_empty(list)) {
873 dl = list_entry(list->prev, struct disasm_line, node);
875 if (dl->ins && dl->ins->ops) {
876 if (dl->ins->ops != &nop_ops)
877 return;
878 } else {
879 if (!strstr(dl->line, " nop ") &&
880 !strstr(dl->line, " nopl ") &&
881 !strstr(dl->line, " nopw "))
882 return;
885 list_del(&dl->node);
886 disasm_line__free(dl);
890 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize)
892 struct dso *dso = map->dso;
893 char *filename = dso__build_id_filename(dso, NULL, 0);
894 bool free_filename = true;
895 char command[PATH_MAX * 2];
896 FILE *file;
897 int err = 0;
898 char symfs_filename[PATH_MAX];
899 struct kcore_extract kce;
900 bool delete_extract = false;
902 if (filename) {
903 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
904 symbol_conf.symfs, filename);
907 if (filename == NULL) {
908 if (dso->has_build_id) {
909 pr_err("Can't annotate %s: not enough memory\n",
910 sym->name);
911 return -ENOMEM;
913 goto fallback;
914 } else if (readlink(symfs_filename, command, sizeof(command)) < 0 ||
915 strstr(command, "[kernel.kallsyms]") ||
916 access(symfs_filename, R_OK)) {
917 free(filename);
918 fallback:
920 * If we don't have build-ids or the build-id file isn't in the
921 * cache, or is just a kallsyms file, well, lets hope that this
922 * DSO is the same as when 'perf record' ran.
924 filename = (char *)dso->long_name;
925 snprintf(symfs_filename, sizeof(symfs_filename), "%s%s",
926 symbol_conf.symfs, filename);
927 free_filename = false;
930 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
931 !dso__is_kcore(dso)) {
932 char bf[BUILD_ID_SIZE * 2 + 16] = " with build id ";
933 char *build_id_msg = NULL;
935 if (dso->annotate_warned)
936 goto out_free_filename;
938 if (dso->has_build_id) {
939 build_id__sprintf(dso->build_id,
940 sizeof(dso->build_id), bf + 15);
941 build_id_msg = bf;
943 err = -ENOENT;
944 dso->annotate_warned = 1;
945 pr_err("Can't annotate %s:\n\n"
946 "No vmlinux file%s\nwas found in the path.\n\n"
947 "Please use:\n\n"
948 " perf buildid-cache -vu vmlinux\n\n"
949 "or:\n\n"
950 " --vmlinux vmlinux\n",
951 sym->name, build_id_msg ?: "");
952 goto out_free_filename;
955 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
956 filename, sym->name, map->unmap_ip(map, sym->start),
957 map->unmap_ip(map, sym->end));
959 pr_debug("annotating [%p] %30s : [%p] %30s\n",
960 dso, dso->long_name, sym, sym->name);
962 if (dso__is_kcore(dso)) {
963 kce.kcore_filename = symfs_filename;
964 kce.addr = map__rip_2objdump(map, sym->start);
965 kce.offs = sym->start;
966 kce.len = sym->end + 1 - sym->start;
967 if (!kcore_extract__create(&kce)) {
968 delete_extract = true;
969 strlcpy(symfs_filename, kce.extract_filename,
970 sizeof(symfs_filename));
971 if (free_filename) {
972 free(filename);
973 free_filename = false;
975 filename = symfs_filename;
979 snprintf(command, sizeof(command),
980 "%s %s%s --start-address=0x%016" PRIx64
981 " --stop-address=0x%016" PRIx64
982 " -d %s %s -C %s 2>/dev/null|grep -v %s|expand",
983 objdump_path ? objdump_path : "objdump",
984 disassembler_style ? "-M " : "",
985 disassembler_style ? disassembler_style : "",
986 map__rip_2objdump(map, sym->start),
987 map__rip_2objdump(map, sym->end+1),
988 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
989 symbol_conf.annotate_src ? "-S" : "",
990 symfs_filename, filename);
992 pr_debug("Executing: %s\n", command);
994 file = popen(command, "r");
995 if (!file)
996 goto out_free_filename;
998 while (!feof(file))
999 if (symbol__parse_objdump_line(sym, map, file, privsize) < 0)
1000 break;
1003 * kallsyms does not have symbol sizes so there may a nop at the end.
1004 * Remove it.
1006 if (dso__is_kcore(dso))
1007 delete_last_nop(sym);
1009 pclose(file);
1010 out_free_filename:
1011 if (delete_extract)
1012 kcore_extract__delete(&kce);
1013 if (free_filename)
1014 free(filename);
1015 return err;
1018 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
1020 struct source_line *iter;
1021 struct rb_node **p = &root->rb_node;
1022 struct rb_node *parent = NULL;
1023 int i, ret;
1025 while (*p != NULL) {
1026 parent = *p;
1027 iter = rb_entry(parent, struct source_line, node);
1029 ret = strcmp(iter->path, src_line->path);
1030 if (ret == 0) {
1031 for (i = 0; i < src_line->nr_pcnt; i++)
1032 iter->p[i].percent_sum += src_line->p[i].percent;
1033 return;
1036 if (ret < 0)
1037 p = &(*p)->rb_left;
1038 else
1039 p = &(*p)->rb_right;
1042 for (i = 0; i < src_line->nr_pcnt; i++)
1043 src_line->p[i].percent_sum = src_line->p[i].percent;
1045 rb_link_node(&src_line->node, parent, p);
1046 rb_insert_color(&src_line->node, root);
1049 static int cmp_source_line(struct source_line *a, struct source_line *b)
1051 int i;
1053 for (i = 0; i < a->nr_pcnt; i++) {
1054 if (a->p[i].percent_sum == b->p[i].percent_sum)
1055 continue;
1056 return a->p[i].percent_sum > b->p[i].percent_sum;
1059 return 0;
1062 static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
1064 struct source_line *iter;
1065 struct rb_node **p = &root->rb_node;
1066 struct rb_node *parent = NULL;
1068 while (*p != NULL) {
1069 parent = *p;
1070 iter = rb_entry(parent, struct source_line, node);
1072 if (cmp_source_line(src_line, iter))
1073 p = &(*p)->rb_left;
1074 else
1075 p = &(*p)->rb_right;
1078 rb_link_node(&src_line->node, parent, p);
1079 rb_insert_color(&src_line->node, root);
1082 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1084 struct source_line *src_line;
1085 struct rb_node *node;
1087 node = rb_first(src_root);
1088 while (node) {
1089 struct rb_node *next;
1091 src_line = rb_entry(node, struct source_line, node);
1092 next = rb_next(node);
1093 rb_erase(node, src_root);
1095 __resort_source_line(dest_root, src_line);
1096 node = next;
1100 static void symbol__free_source_line(struct symbol *sym, int len)
1102 struct annotation *notes = symbol__annotation(sym);
1103 struct source_line *src_line = notes->src->lines;
1104 size_t sizeof_src_line;
1105 int i;
1107 sizeof_src_line = sizeof(*src_line) +
1108 (sizeof(src_line->p) * (src_line->nr_pcnt - 1));
1110 for (i = 0; i < len; i++) {
1111 free_srcline(src_line->path);
1112 src_line = (void *)src_line + sizeof_src_line;
1115 zfree(&notes->src->lines);
1118 /* Get the filename:line for the colored entries */
1119 static int symbol__get_source_line(struct symbol *sym, struct map *map,
1120 struct perf_evsel *evsel,
1121 struct rb_root *root, int len)
1123 u64 start;
1124 int i, k;
1125 int evidx = evsel->idx;
1126 struct source_line *src_line;
1127 struct annotation *notes = symbol__annotation(sym);
1128 struct sym_hist *h = annotation__histogram(notes, evidx);
1129 struct rb_root tmp_root = RB_ROOT;
1130 int nr_pcnt = 1;
1131 u64 h_sum = h->sum;
1132 size_t sizeof_src_line = sizeof(struct source_line);
1134 if (perf_evsel__is_group_event(evsel)) {
1135 for (i = 1; i < evsel->nr_members; i++) {
1136 h = annotation__histogram(notes, evidx + i);
1137 h_sum += h->sum;
1139 nr_pcnt = evsel->nr_members;
1140 sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->p);
1143 if (!h_sum)
1144 return 0;
1146 src_line = notes->src->lines = calloc(len, sizeof_src_line);
1147 if (!notes->src->lines)
1148 return -1;
1150 start = map__rip_2objdump(map, sym->start);
1152 for (i = 0; i < len; i++) {
1153 u64 offset;
1154 double percent_max = 0.0;
1156 src_line->nr_pcnt = nr_pcnt;
1158 for (k = 0; k < nr_pcnt; k++) {
1159 h = annotation__histogram(notes, evidx + k);
1160 src_line->p[k].percent = 100.0 * h->addr[i] / h->sum;
1162 if (src_line->p[k].percent > percent_max)
1163 percent_max = src_line->p[k].percent;
1166 if (percent_max <= 0.5)
1167 goto next;
1169 offset = start + i;
1170 src_line->path = get_srcline(map->dso, offset);
1171 insert_source_line(&tmp_root, src_line);
1173 next:
1174 src_line = (void *)src_line + sizeof_src_line;
1177 resort_source_line(root, &tmp_root);
1178 return 0;
1181 static void print_summary(struct rb_root *root, const char *filename)
1183 struct source_line *src_line;
1184 struct rb_node *node;
1186 printf("\nSorted summary for file %s\n", filename);
1187 printf("----------------------------------------------\n\n");
1189 if (RB_EMPTY_ROOT(root)) {
1190 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1191 return;
1194 node = rb_first(root);
1195 while (node) {
1196 double percent, percent_max = 0.0;
1197 const char *color;
1198 char *path;
1199 int i;
1201 src_line = rb_entry(node, struct source_line, node);
1202 for (i = 0; i < src_line->nr_pcnt; i++) {
1203 percent = src_line->p[i].percent_sum;
1204 color = get_percent_color(percent);
1205 color_fprintf(stdout, color, " %7.2f", percent);
1207 if (percent > percent_max)
1208 percent_max = percent;
1211 path = src_line->path;
1212 color = get_percent_color(percent_max);
1213 color_fprintf(stdout, color, " %s\n", path);
1215 node = rb_next(node);
1219 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1221 struct annotation *notes = symbol__annotation(sym);
1222 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1223 u64 len = symbol__size(sym), offset;
1225 for (offset = 0; offset < len; ++offset)
1226 if (h->addr[offset] != 0)
1227 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1228 sym->start + offset, h->addr[offset]);
1229 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1232 int symbol__annotate_printf(struct symbol *sym, struct map *map,
1233 struct perf_evsel *evsel, bool full_paths,
1234 int min_pcnt, int max_lines, int context)
1236 struct dso *dso = map->dso;
1237 char *filename;
1238 const char *d_filename;
1239 const char *evsel_name = perf_evsel__name(evsel);
1240 struct annotation *notes = symbol__annotation(sym);
1241 struct disasm_line *pos, *queue = NULL;
1242 u64 start = map__rip_2objdump(map, sym->start);
1243 int printed = 2, queue_len = 0;
1244 int more = 0;
1245 u64 len;
1246 int width = 8;
1247 int namelen, evsel_name_len, graph_dotted_len;
1249 filename = strdup(dso->long_name);
1250 if (!filename)
1251 return -ENOMEM;
1253 if (full_paths)
1254 d_filename = filename;
1255 else
1256 d_filename = basename(filename);
1258 len = symbol__size(sym);
1259 namelen = strlen(d_filename);
1260 evsel_name_len = strlen(evsel_name);
1262 if (perf_evsel__is_group_event(evsel))
1263 width *= evsel->nr_members;
1265 printf(" %-*.*s| Source code & Disassembly of %s for %s\n",
1266 width, width, "Percent", d_filename, evsel_name);
1268 graph_dotted_len = width + namelen + evsel_name_len;
1269 printf("-%-*.*s-----------------------------------------\n",
1270 graph_dotted_len, graph_dotted_len, graph_dotted_line);
1272 if (verbose)
1273 symbol__annotate_hits(sym, evsel);
1275 list_for_each_entry(pos, &notes->src->source, node) {
1276 if (context && queue == NULL) {
1277 queue = pos;
1278 queue_len = 0;
1281 switch (disasm_line__print(pos, sym, start, evsel, len,
1282 min_pcnt, printed, max_lines,
1283 queue)) {
1284 case 0:
1285 ++printed;
1286 if (context) {
1287 printed += queue_len;
1288 queue = NULL;
1289 queue_len = 0;
1291 break;
1292 case 1:
1293 /* filtered by max_lines */
1294 ++more;
1295 break;
1296 case -1:
1297 default:
1299 * Filtered by min_pcnt or non IP lines when
1300 * context != 0
1302 if (!context)
1303 break;
1304 if (queue_len == context)
1305 queue = list_entry(queue->node.next, typeof(*queue), node);
1306 else
1307 ++queue_len;
1308 break;
1312 free(filename);
1314 return more;
1317 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1319 struct annotation *notes = symbol__annotation(sym);
1320 struct sym_hist *h = annotation__histogram(notes, evidx);
1322 memset(h, 0, notes->src->sizeof_sym_hist);
1325 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1327 struct annotation *notes = symbol__annotation(sym);
1328 struct sym_hist *h = annotation__histogram(notes, evidx);
1329 int len = symbol__size(sym), offset;
1331 h->sum = 0;
1332 for (offset = 0; offset < len; ++offset) {
1333 h->addr[offset] = h->addr[offset] * 7 / 8;
1334 h->sum += h->addr[offset];
1338 void disasm__purge(struct list_head *head)
1340 struct disasm_line *pos, *n;
1342 list_for_each_entry_safe(pos, n, head, node) {
1343 list_del(&pos->node);
1344 disasm_line__free(pos);
1348 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1350 size_t printed;
1352 if (dl->offset == -1)
1353 return fprintf(fp, "%s\n", dl->line);
1355 printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->name);
1357 if (dl->ops.raw[0] != '\0') {
1358 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1359 dl->ops.raw);
1362 return printed + fprintf(fp, "\n");
1365 size_t disasm__fprintf(struct list_head *head, FILE *fp)
1367 struct disasm_line *pos;
1368 size_t printed = 0;
1370 list_for_each_entry(pos, head, node)
1371 printed += disasm_line__fprintf(pos, fp);
1373 return printed;
1376 int symbol__tty_annotate(struct symbol *sym, struct map *map,
1377 struct perf_evsel *evsel, bool print_lines,
1378 bool full_paths, int min_pcnt, int max_lines)
1380 struct dso *dso = map->dso;
1381 struct rb_root source_line = RB_ROOT;
1382 u64 len;
1384 if (symbol__annotate(sym, map, 0) < 0)
1385 return -1;
1387 len = symbol__size(sym);
1389 if (print_lines) {
1390 symbol__get_source_line(sym, map, evsel, &source_line, len);
1391 print_summary(&source_line, dso->long_name);
1394 symbol__annotate_printf(sym, map, evsel, full_paths,
1395 min_pcnt, max_lines, 0);
1396 if (print_lines)
1397 symbol__free_source_line(sym, len);
1399 disasm__purge(&symbol__annotation(sym)->src->source);
1401 return 0;
1404 int hist_entry__annotate(struct hist_entry *he, size_t privsize)
1406 return symbol__annotate(he->ms.sym, he->ms.map, privsize);
1409 bool ui__has_annotation(void)
1411 return use_browser == 1 && sort__has_sym;