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
7 * Released under the GPL v2. (and only v2, not any later version)
22 #include <linux/bitops.h>
24 const char *disassembler_style;
25 const char *objdump_path;
26 static regex_t file_lineno;
28 static struct ins *ins__find(const char *name);
29 static int disasm_line__parse(char *line, char **namep, char **rawp);
31 static void ins__delete(struct ins_operands *ops)
35 zfree(&ops->source.raw);
36 zfree(&ops->source.name);
37 zfree(&ops->target.raw);
38 zfree(&ops->target.name);
41 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
42 struct ins_operands *ops)
44 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->raw);
47 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
48 struct ins_operands *ops)
50 if (ins->ops->scnprintf)
51 return ins->ops->scnprintf(ins, bf, size, ops);
53 return ins__raw_scnprintf(ins, bf, size, ops);
56 static int call__parse(struct ins_operands *ops)
58 char *endptr, *tok, *name;
60 ops->target.addr = strtoull(ops->raw, &endptr, 16);
62 name = strchr(endptr, '<');
69 if (strchr(name, '+'))
73 tok = strchr(name, '>');
78 ops->target.name = strdup(name);
81 return ops->target.name == NULL ? -1 : 0;
84 tok = strchr(endptr, '(');
90 tok = strchr(endptr, '*');
94 ops->target.addr = strtoull(tok + 1, NULL, 16);
98 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
99 struct ins_operands *ops)
101 if (ops->target.name)
102 return scnprintf(bf, size, "%-6.6s %s", ins->name, ops->target.name);
104 if (ops->target.addr == 0)
105 return ins__raw_scnprintf(ins, bf, size, ops);
107 return scnprintf(bf, size, "%-6.6s *%" PRIx64, ins->name, ops->target.addr);
110 static struct ins_ops call_ops = {
111 .parse = call__parse,
112 .scnprintf = call__scnprintf,
115 bool ins__is_call(const struct ins *ins)
117 return ins->ops == &call_ops;
120 static int jump__parse(struct ins_operands *ops)
122 const char *s = strchr(ops->raw, '+');
124 ops->target.addr = strtoull(ops->raw, NULL, 16);
127 ops->target.offset = strtoull(s, NULL, 16);
129 ops->target.offset = UINT64_MAX;
134 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
135 struct ins_operands *ops)
137 return scnprintf(bf, size, "%-6.6s %" PRIx64, ins->name, ops->target.offset);
140 static struct ins_ops jump_ops = {
141 .parse = jump__parse,
142 .scnprintf = jump__scnprintf,
145 bool ins__is_jump(const struct ins *ins)
147 return ins->ops == &jump_ops;
150 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
152 char *endptr, *name, *t;
154 if (strstr(raw, "(%rip)") == NULL)
157 *addrp = strtoull(comment, &endptr, 16);
158 name = strchr(endptr, '<');
164 t = strchr(name, '>');
169 *namep = strdup(name);
175 static int lock__parse(struct ins_operands *ops)
179 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
180 if (ops->locked.ops == NULL)
183 if (disasm_line__parse(ops->raw, &name, &ops->locked.ops->raw) < 0)
186 ops->locked.ins = ins__find(name);
189 if (ops->locked.ins == NULL)
192 if (!ops->locked.ins->ops)
195 if (ops->locked.ins->ops->parse &&
196 ops->locked.ins->ops->parse(ops->locked.ops) < 0)
202 zfree(&ops->locked.ops);
206 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
207 struct ins_operands *ops)
211 if (ops->locked.ins == NULL)
212 return ins__raw_scnprintf(ins, bf, size, ops);
214 printed = scnprintf(bf, size, "%-6.6s ", ins->name);
215 return printed + ins__scnprintf(ops->locked.ins, bf + printed,
216 size - printed, ops->locked.ops);
219 static void lock__delete(struct ins_operands *ops)
221 struct ins *ins = ops->locked.ins;
223 if (ins && ins->ops->free)
224 ins->ops->free(ops->locked.ops);
226 ins__delete(ops->locked.ops);
228 zfree(&ops->locked.ops);
229 zfree(&ops->target.raw);
230 zfree(&ops->target.name);
233 static struct ins_ops lock_ops = {
234 .free = lock__delete,
235 .parse = lock__parse,
236 .scnprintf = lock__scnprintf,
239 static int mov__parse(struct ins_operands *ops)
241 char *s = strchr(ops->raw, ','), *target, *comment, prev;
247 ops->source.raw = strdup(ops->raw);
250 if (ops->source.raw == NULL)
255 comment = strchr(s, ';');
257 comment = strchr(s, '#');
263 s = strchr(s, '\0') - 1;
265 while (s > target && isspace(s[0]))
271 ops->target.raw = strdup(target);
274 if (ops->target.raw == NULL)
275 goto out_free_source;
280 while (comment[0] != '\0' && isspace(comment[0]))
283 comment__symbol(ops->source.raw, comment, &ops->source.addr, &ops->source.name);
284 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
289 zfree(&ops->source.raw);
293 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
294 struct ins_operands *ops)
296 return scnprintf(bf, size, "%-6.6s %s,%s", ins->name,
297 ops->source.name ?: ops->source.raw,
298 ops->target.name ?: ops->target.raw);
301 static struct ins_ops mov_ops = {
303 .scnprintf = mov__scnprintf,
306 static int dec__parse(struct ins_operands *ops)
308 char *target, *comment, *s, prev;
310 target = s = ops->raw;
312 while (s[0] != '\0' && !isspace(s[0]))
317 ops->target.raw = strdup(target);
320 if (ops->target.raw == NULL)
323 comment = strchr(s, '#');
327 while (comment[0] != '\0' && isspace(comment[0]))
330 comment__symbol(ops->target.raw, comment, &ops->target.addr, &ops->target.name);
335 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
336 struct ins_operands *ops)
338 return scnprintf(bf, size, "%-6.6s %s", ins->name,
339 ops->target.name ?: ops->target.raw);
342 static struct ins_ops dec_ops = {
344 .scnprintf = dec__scnprintf,
347 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
348 struct ins_operands *ops __maybe_unused)
350 return scnprintf(bf, size, "%-6.6s", "nop");
353 static struct ins_ops nop_ops = {
354 .scnprintf = nop__scnprintf,
358 * Must be sorted by name!
360 static struct ins instructions[] = {
361 { .name = "add", .ops = &mov_ops, },
362 { .name = "addl", .ops = &mov_ops, },
363 { .name = "addq", .ops = &mov_ops, },
364 { .name = "addw", .ops = &mov_ops, },
365 { .name = "and", .ops = &mov_ops, },
367 { .name = "b", .ops = &jump_ops, }, // might also be a call
368 { .name = "bcc", .ops = &jump_ops, },
369 { .name = "bcs", .ops = &jump_ops, },
370 { .name = "beq", .ops = &jump_ops, },
371 { .name = "bge", .ops = &jump_ops, },
372 { .name = "bgt", .ops = &jump_ops, },
373 { .name = "bhi", .ops = &jump_ops, },
374 { .name = "bl", .ops = &call_ops, },
375 { .name = "blt", .ops = &jump_ops, },
376 { .name = "bls", .ops = &jump_ops, },
377 { .name = "blx", .ops = &call_ops, },
378 { .name = "bne", .ops = &jump_ops, },
380 { .name = "bts", .ops = &mov_ops, },
381 { .name = "call", .ops = &call_ops, },
382 { .name = "callq", .ops = &call_ops, },
383 { .name = "cmp", .ops = &mov_ops, },
384 { .name = "cmpb", .ops = &mov_ops, },
385 { .name = "cmpl", .ops = &mov_ops, },
386 { .name = "cmpq", .ops = &mov_ops, },
387 { .name = "cmpw", .ops = &mov_ops, },
388 { .name = "cmpxch", .ops = &mov_ops, },
389 { .name = "dec", .ops = &dec_ops, },
390 { .name = "decl", .ops = &dec_ops, },
391 { .name = "imul", .ops = &mov_ops, },
392 { .name = "inc", .ops = &dec_ops, },
393 { .name = "incl", .ops = &dec_ops, },
394 { .name = "ja", .ops = &jump_ops, },
395 { .name = "jae", .ops = &jump_ops, },
396 { .name = "jb", .ops = &jump_ops, },
397 { .name = "jbe", .ops = &jump_ops, },
398 { .name = "jc", .ops = &jump_ops, },
399 { .name = "jcxz", .ops = &jump_ops, },
400 { .name = "je", .ops = &jump_ops, },
401 { .name = "jecxz", .ops = &jump_ops, },
402 { .name = "jg", .ops = &jump_ops, },
403 { .name = "jge", .ops = &jump_ops, },
404 { .name = "jl", .ops = &jump_ops, },
405 { .name = "jle", .ops = &jump_ops, },
406 { .name = "jmp", .ops = &jump_ops, },
407 { .name = "jmpq", .ops = &jump_ops, },
408 { .name = "jna", .ops = &jump_ops, },
409 { .name = "jnae", .ops = &jump_ops, },
410 { .name = "jnb", .ops = &jump_ops, },
411 { .name = "jnbe", .ops = &jump_ops, },
412 { .name = "jnc", .ops = &jump_ops, },
413 { .name = "jne", .ops = &jump_ops, },
414 { .name = "jng", .ops = &jump_ops, },
415 { .name = "jnge", .ops = &jump_ops, },
416 { .name = "jnl", .ops = &jump_ops, },
417 { .name = "jnle", .ops = &jump_ops, },
418 { .name = "jno", .ops = &jump_ops, },
419 { .name = "jnp", .ops = &jump_ops, },
420 { .name = "jns", .ops = &jump_ops, },
421 { .name = "jnz", .ops = &jump_ops, },
422 { .name = "jo", .ops = &jump_ops, },
423 { .name = "jp", .ops = &jump_ops, },
424 { .name = "jpe", .ops = &jump_ops, },
425 { .name = "jpo", .ops = &jump_ops, },
426 { .name = "jrcxz", .ops = &jump_ops, },
427 { .name = "js", .ops = &jump_ops, },
428 { .name = "jz", .ops = &jump_ops, },
429 { .name = "lea", .ops = &mov_ops, },
430 { .name = "lock", .ops = &lock_ops, },
431 { .name = "mov", .ops = &mov_ops, },
432 { .name = "movb", .ops = &mov_ops, },
433 { .name = "movdqa",.ops = &mov_ops, },
434 { .name = "movl", .ops = &mov_ops, },
435 { .name = "movq", .ops = &mov_ops, },
436 { .name = "movslq", .ops = &mov_ops, },
437 { .name = "movzbl", .ops = &mov_ops, },
438 { .name = "movzwl", .ops = &mov_ops, },
439 { .name = "nop", .ops = &nop_ops, },
440 { .name = "nopl", .ops = &nop_ops, },
441 { .name = "nopw", .ops = &nop_ops, },
442 { .name = "or", .ops = &mov_ops, },
443 { .name = "orl", .ops = &mov_ops, },
444 { .name = "test", .ops = &mov_ops, },
445 { .name = "testb", .ops = &mov_ops, },
446 { .name = "testl", .ops = &mov_ops, },
447 { .name = "xadd", .ops = &mov_ops, },
448 { .name = "xbeginl", .ops = &jump_ops, },
449 { .name = "xbeginq", .ops = &jump_ops, },
452 static int ins__cmp(const void *name, const void *insp)
454 const struct ins *ins = insp;
456 return strcmp(name, ins->name);
459 static struct ins *ins__find(const char *name)
461 const int nmemb = ARRAY_SIZE(instructions);
463 return bsearch(name, instructions, nmemb, sizeof(struct ins), ins__cmp);
466 int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym)
468 struct annotation *notes = symbol__annotation(sym);
469 pthread_mutex_init(¬es->lock, NULL);
473 int symbol__alloc_hist(struct symbol *sym)
475 struct annotation *notes = symbol__annotation(sym);
476 const size_t size = symbol__size(sym);
477 size_t sizeof_sym_hist;
479 /* Check for overflow when calculating sizeof_sym_hist */
480 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(u64))
483 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(u64));
485 /* Check for overflow in zalloc argument */
486 if (sizeof_sym_hist > (SIZE_MAX - sizeof(*notes->src))
487 / symbol_conf.nr_events)
490 notes->src = zalloc(sizeof(*notes->src) + symbol_conf.nr_events * sizeof_sym_hist);
491 if (notes->src == NULL)
493 notes->src->sizeof_sym_hist = sizeof_sym_hist;
494 notes->src->nr_histograms = symbol_conf.nr_events;
495 INIT_LIST_HEAD(¬es->src->source);
499 /* The cycles histogram is lazily allocated. */
500 static int symbol__alloc_hist_cycles(struct symbol *sym)
502 struct annotation *notes = symbol__annotation(sym);
503 const size_t size = symbol__size(sym);
505 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
506 if (notes->src->cycles_hist == NULL)
511 void symbol__annotate_zero_histograms(struct symbol *sym)
513 struct annotation *notes = symbol__annotation(sym);
515 pthread_mutex_lock(¬es->lock);
516 if (notes->src != NULL) {
517 memset(notes->src->histograms, 0,
518 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
519 if (notes->src->cycles_hist)
520 memset(notes->src->cycles_hist, 0,
521 symbol__size(sym) * sizeof(struct cyc_hist));
523 pthread_mutex_unlock(¬es->lock);
526 static int __symbol__account_cycles(struct annotation *notes,
528 unsigned offset, unsigned cycles,
533 ch = notes->src->cycles_hist;
535 * For now we can only account one basic block per
536 * final jump. But multiple could be overlapping.
537 * Always account the longest one. So when
538 * a shorter one has been already seen throw it away.
540 * We separately always account the full cycles.
542 ch[offset].num_aggr++;
543 ch[offset].cycles_aggr += cycles;
545 if (!have_start && ch[offset].have_start)
547 if (ch[offset].num) {
548 if (have_start && (!ch[offset].have_start ||
549 ch[offset].start > start)) {
550 ch[offset].have_start = 0;
551 ch[offset].cycles = 0;
553 if (ch[offset].reset < 0xffff)
555 } else if (have_start &&
556 ch[offset].start < start)
559 ch[offset].have_start = have_start;
560 ch[offset].start = start;
561 ch[offset].cycles += cycles;
566 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
567 struct annotation *notes, int evidx, u64 addr)
572 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
574 if (addr < sym->start || addr >= sym->end) {
575 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
576 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
580 offset = addr - sym->start;
581 h = annotation__histogram(notes, evidx);
585 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
586 ", evidx=%d] => %" PRIu64 "\n", sym->start, sym->name,
587 addr, addr - sym->start, evidx, h->addr[offset]);
591 static struct annotation *symbol__get_annotation(struct symbol *sym, bool cycles)
593 struct annotation *notes = symbol__annotation(sym);
595 if (notes->src == NULL) {
596 if (symbol__alloc_hist(sym) < 0)
599 if (!notes->src->cycles_hist && cycles) {
600 if (symbol__alloc_hist_cycles(sym) < 0)
606 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
609 struct annotation *notes;
613 notes = symbol__get_annotation(sym, false);
616 return __symbol__inc_addr_samples(sym, map, notes, evidx, addr);
619 static int symbol__account_cycles(u64 addr, u64 start,
620 struct symbol *sym, unsigned cycles)
622 struct annotation *notes;
627 notes = symbol__get_annotation(sym, true);
630 if (addr < sym->start || addr >= sym->end)
634 if (start < sym->start || start >= sym->end)
639 offset = addr - sym->start;
640 return __symbol__account_cycles(notes,
641 start ? start - sym->start : 0,
646 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
647 struct addr_map_symbol *start,
657 * Only set start when IPC can be computed. We can only
658 * compute it when the basic block is completely in a single
660 * Special case the case when the jump is elsewhere, but
661 * it starts on the function start.
664 (start->sym == ams->sym ||
666 start->addr == ams->sym->start + ams->map->start)))
667 saddr = start->al_addr;
669 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
671 start ? start->addr : 0,
672 ams->sym ? ams->sym->start + ams->map->start : 0,
674 err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
676 pr_debug2("account_cycles failed %d\n", err);
680 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx)
682 return symbol__inc_addr_samples(ams->sym, ams->map, evidx, ams->al_addr);
685 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 ip)
687 return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evidx, ip);
690 static void disasm_line__init_ins(struct disasm_line *dl)
692 dl->ins = ins__find(dl->name);
700 if (dl->ins->ops->parse && dl->ins->ops->parse(&dl->ops) < 0)
704 static int disasm_line__parse(char *line, char **namep, char **rawp)
706 char *name = line, tmp;
708 while (isspace(name[0]))
716 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
721 *namep = strdup(name);
728 if ((*rawp)[0] != '\0') {
730 while (isspace((*rawp)[0]))
741 static struct disasm_line *disasm_line__new(s64 offset, char *line,
742 size_t privsize, int line_nr)
744 struct disasm_line *dl = zalloc(sizeof(*dl) + privsize);
748 dl->line = strdup(line);
749 dl->line_nr = line_nr;
750 if (dl->line == NULL)
754 if (disasm_line__parse(dl->line, &dl->name, &dl->ops.raw) < 0)
757 disasm_line__init_ins(dl);
770 void disasm_line__free(struct disasm_line *dl)
774 if (dl->ins && dl->ins->ops->free)
775 dl->ins->ops->free(&dl->ops);
777 ins__delete(&dl->ops);
781 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw)
784 return scnprintf(bf, size, "%-6.6s %s", dl->name, dl->ops.raw);
786 return ins__scnprintf(dl->ins, bf, size, &dl->ops);
789 static void disasm__add(struct list_head *head, struct disasm_line *line)
791 list_add_tail(&line->node, head);
794 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos)
796 list_for_each_entry_continue(pos, head, node)
797 if (pos->offset >= 0)
803 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
804 s64 end, const char **path, u64 *nr_samples)
806 struct source_line *src_line = notes->src->lines;
807 double percent = 0.0;
811 size_t sizeof_src_line = sizeof(*src_line) +
812 sizeof(src_line->samples) * (src_line->nr_pcnt - 1);
814 while (offset < end) {
815 src_line = (void *)notes->src->lines +
816 (sizeof_src_line * offset);
819 *path = src_line->path;
821 percent += src_line->samples[evidx].percent;
822 *nr_samples += src_line->samples[evidx].nr;
826 struct sym_hist *h = annotation__histogram(notes, evidx);
827 unsigned int hits = 0;
830 hits += h->addr[offset++];
834 percent = 100.0 * hits / h->sum;
841 static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
842 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
843 int max_lines, struct disasm_line *queue)
845 static const char *prev_line;
846 static const char *prev_color;
848 if (dl->offset != -1) {
849 const char *path = NULL;
851 double percent, max_percent = 0.0;
852 double *ppercents = &percent;
853 u64 *psamples = &nr_samples;
854 int i, nr_percent = 1;
856 struct annotation *notes = symbol__annotation(sym);
857 s64 offset = dl->offset;
858 const u64 addr = start + offset;
859 struct disasm_line *next;
861 next = disasm__get_next_ip_line(¬es->src->source, dl);
863 if (perf_evsel__is_group_event(evsel)) {
864 nr_percent = evsel->nr_members;
865 ppercents = calloc(nr_percent, sizeof(double));
866 psamples = calloc(nr_percent, sizeof(u64));
867 if (ppercents == NULL || psamples == NULL) {
872 for (i = 0; i < nr_percent; i++) {
873 percent = disasm__calc_percent(notes,
874 notes->src->lines ? i : evsel->idx + i,
876 next ? next->offset : (s64) len,
879 ppercents[i] = percent;
880 psamples[i] = nr_samples;
881 if (percent > max_percent)
882 max_percent = percent;
885 if (max_percent < min_pcnt)
888 if (max_lines && printed >= max_lines)
892 list_for_each_entry_from(queue, ¬es->src->source, node) {
895 disasm_line__print(queue, sym, start, evsel, len,
900 color = get_percent_color(max_percent);
903 * Also color the filename and line if needed, with
904 * the same color than the percentage. Don't print it
905 * twice for close colored addr with the same filename:line
908 if (!prev_line || strcmp(prev_line, path)
909 || color != prev_color) {
910 color_fprintf(stdout, color, " %s", path);
916 for (i = 0; i < nr_percent; i++) {
917 percent = ppercents[i];
918 nr_samples = psamples[i];
919 color = get_percent_color(percent);
921 if (symbol_conf.show_total_period)
922 color_fprintf(stdout, color, " %7" PRIu64,
925 color_fprintf(stdout, color, " %7.2f", percent);
929 color_fprintf(stdout, PERF_COLOR_MAGENTA, " %" PRIx64 ":", addr);
930 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", dl->line);
932 if (ppercents != &percent)
935 if (psamples != &nr_samples)
938 } else if (max_lines && printed >= max_lines)
946 if (perf_evsel__is_group_event(evsel))
947 width *= evsel->nr_members;
950 printf(" %*s:\n", width, " ");
952 printf(" %*s: %s\n", width, " ", dl->line);
959 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
960 * which looks like following
962 * 0000000000415500 <_init>:
963 * 415500: sub $0x8,%rsp
964 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
965 * 41550b: test %rax,%rax
966 * 41550e: je 415515 <_init+0x15>
967 * 415510: callq 416e70 <__gmon_start__@plt>
968 * 415515: add $0x8,%rsp
971 * it will be parsed and saved into struct disasm_line as
972 * <offset> <name> <ops.raw>
974 * The offset will be a relative offset from the start of the symbol and -1
975 * means that it's not a disassembly line so should be treated differently.
976 * The ops.raw part will be parsed further according to type of the instruction.
978 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
979 FILE *file, size_t privsize,
982 struct annotation *notes = symbol__annotation(sym);
983 struct disasm_line *dl;
984 char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
986 s64 line_ip, offset = -1;
989 if (getline(&line, &line_len, file) < 0)
995 while (line_len != 0 && isspace(line[line_len - 1]))
996 line[--line_len] = '\0';
998 c = strchr(line, '\n');
1005 /* /filename:linenr ? Save line number and ignore. */
1006 if (regexec(&file_lineno, line, 2, match, 0) == 0) {
1007 *line_nr = atoi(line + match[1].rm_so);
1012 * Strip leading spaces:
1023 * Parse hexa addresses followed by ':'
1025 line_ip = strtoull(tmp, &tmp2, 16);
1026 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1030 if (line_ip != -1) {
1031 u64 start = map__rip_2objdump(map, sym->start),
1032 end = map__rip_2objdump(map, sym->end);
1034 offset = line_ip - start;
1035 if ((u64)line_ip < start || (u64)line_ip >= end)
1038 parsed_line = tmp2 + 1;
1041 dl = disasm_line__new(offset, parsed_line, privsize, *line_nr);
1048 if (dl->ops.target.offset == UINT64_MAX)
1049 dl->ops.target.offset = dl->ops.target.addr -
1050 map__rip_2objdump(map, sym->start);
1052 /* kcore has no symbols, so add the call target name */
1053 if (dl->ins && ins__is_call(dl->ins) && !dl->ops.target.name) {
1054 struct addr_map_symbol target = {
1056 .addr = dl->ops.target.addr,
1059 if (!map_groups__find_ams(&target, NULL) &&
1060 target.sym->start == target.al_addr)
1061 dl->ops.target.name = strdup(target.sym->name);
1064 disasm__add(¬es->src->source, dl);
1069 static __attribute__((constructor)) void symbol__init_regexpr(void)
1071 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1074 static void delete_last_nop(struct symbol *sym)
1076 struct annotation *notes = symbol__annotation(sym);
1077 struct list_head *list = ¬es->src->source;
1078 struct disasm_line *dl;
1080 while (!list_empty(list)) {
1081 dl = list_entry(list->prev, struct disasm_line, node);
1083 if (dl->ins && dl->ins->ops) {
1084 if (dl->ins->ops != &nop_ops)
1087 if (!strstr(dl->line, " nop ") &&
1088 !strstr(dl->line, " nopl ") &&
1089 !strstr(dl->line, " nopw "))
1093 list_del(&dl->node);
1094 disasm_line__free(dl);
1098 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize)
1100 struct dso *dso = map->dso;
1101 char *filename = dso__build_id_filename(dso, NULL, 0);
1102 bool free_filename = true;
1103 char command[PATH_MAX * 2];
1106 char symfs_filename[PATH_MAX];
1107 struct kcore_extract kce;
1108 bool delete_extract = false;
1113 symbol__join_symfs(symfs_filename, filename);
1115 if (filename == NULL) {
1116 if (dso->has_build_id) {
1117 pr_err("Can't annotate %s: not enough memory\n",
1122 } else if (dso__is_kcore(dso)) {
1124 } else if (readlink(symfs_filename, command, sizeof(command)) < 0 ||
1125 strstr(command, "[kernel.kallsyms]") ||
1126 access(symfs_filename, R_OK)) {
1130 * If we don't have build-ids or the build-id file isn't in the
1131 * cache, or is just a kallsyms file, well, lets hope that this
1132 * DSO is the same as when 'perf record' ran.
1134 filename = (char *)dso->long_name;
1135 symbol__join_symfs(symfs_filename, filename);
1136 free_filename = false;
1139 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1140 !dso__is_kcore(dso)) {
1141 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1142 char *build_id_msg = NULL;
1144 if (dso->annotate_warned)
1145 goto out_free_filename;
1147 if (dso->has_build_id) {
1148 build_id__sprintf(dso->build_id,
1149 sizeof(dso->build_id), bf + 15);
1153 dso->annotate_warned = 1;
1154 pr_err("Can't annotate %s:\n\n"
1155 "No vmlinux file%s\nwas found in the path.\n\n"
1156 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1158 " perf buildid-cache -vu vmlinux\n\n"
1160 " --vmlinux vmlinux\n",
1161 sym->name, build_id_msg ?: "");
1162 goto out_free_filename;
1165 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1166 filename, sym->name, map->unmap_ip(map, sym->start),
1167 map->unmap_ip(map, sym->end));
1169 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1170 dso, dso->long_name, sym, sym->name);
1172 if (dso__is_kcore(dso)) {
1173 kce.kcore_filename = symfs_filename;
1174 kce.addr = map__rip_2objdump(map, sym->start);
1175 kce.offs = sym->start;
1176 kce.len = sym->end - sym->start;
1177 if (!kcore_extract__create(&kce)) {
1178 delete_extract = true;
1179 strlcpy(symfs_filename, kce.extract_filename,
1180 sizeof(symfs_filename));
1181 if (free_filename) {
1183 free_filename = false;
1185 filename = symfs_filename;
1187 } else if (dso__needs_decompress(dso)) {
1193 if (kmod_path__parse_ext(&m, symfs_filename))
1194 goto out_free_filename;
1196 snprintf(tmp, PATH_MAX, "/tmp/perf-kmod-XXXXXX");
1201 goto out_free_filename;
1204 ret = decompress_to_file(m.ext, symfs_filename, fd);
1207 pr_err("Cannot decompress %s %s\n", m.ext, symfs_filename);
1213 goto out_free_filename;
1215 strcpy(symfs_filename, tmp);
1218 snprintf(command, sizeof(command),
1219 "%s %s%s --start-address=0x%016" PRIx64
1220 " --stop-address=0x%016" PRIx64
1221 " -l -d %s %s -C %s 2>/dev/null|grep -v %s|expand",
1222 objdump_path ? objdump_path : "objdump",
1223 disassembler_style ? "-M " : "",
1224 disassembler_style ? disassembler_style : "",
1225 map__rip_2objdump(map, sym->start),
1226 map__rip_2objdump(map, sym->end),
1227 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
1228 symbol_conf.annotate_src ? "-S" : "",
1229 symfs_filename, filename);
1231 pr_debug("Executing: %s\n", command);
1233 file = popen(command, "r");
1235 pr_err("Failure running %s\n", command);
1237 * If we were using debug info should retry with
1240 goto out_remove_tmp;
1244 while (!feof(file)) {
1245 if (symbol__parse_objdump_line(sym, map, file, privsize,
1252 pr_err("No output from %s\n", command);
1255 * kallsyms does not have symbol sizes so there may a nop at the end.
1258 if (dso__is_kcore(dso))
1259 delete_last_nop(sym);
1264 if (dso__needs_decompress(dso))
1265 unlink(symfs_filename);
1268 kcore_extract__delete(&kce);
1274 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
1276 struct source_line *iter;
1277 struct rb_node **p = &root->rb_node;
1278 struct rb_node *parent = NULL;
1281 while (*p != NULL) {
1283 iter = rb_entry(parent, struct source_line, node);
1285 ret = strcmp(iter->path, src_line->path);
1287 for (i = 0; i < src_line->nr_pcnt; i++)
1288 iter->samples[i].percent_sum += src_line->samples[i].percent;
1295 p = &(*p)->rb_right;
1298 for (i = 0; i < src_line->nr_pcnt; i++)
1299 src_line->samples[i].percent_sum = src_line->samples[i].percent;
1301 rb_link_node(&src_line->node, parent, p);
1302 rb_insert_color(&src_line->node, root);
1305 static int cmp_source_line(struct source_line *a, struct source_line *b)
1309 for (i = 0; i < a->nr_pcnt; i++) {
1310 if (a->samples[i].percent_sum == b->samples[i].percent_sum)
1312 return a->samples[i].percent_sum > b->samples[i].percent_sum;
1318 static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
1320 struct source_line *iter;
1321 struct rb_node **p = &root->rb_node;
1322 struct rb_node *parent = NULL;
1324 while (*p != NULL) {
1326 iter = rb_entry(parent, struct source_line, node);
1328 if (cmp_source_line(src_line, iter))
1331 p = &(*p)->rb_right;
1334 rb_link_node(&src_line->node, parent, p);
1335 rb_insert_color(&src_line->node, root);
1338 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1340 struct source_line *src_line;
1341 struct rb_node *node;
1343 node = rb_first(src_root);
1345 struct rb_node *next;
1347 src_line = rb_entry(node, struct source_line, node);
1348 next = rb_next(node);
1349 rb_erase(node, src_root);
1351 __resort_source_line(dest_root, src_line);
1356 static void symbol__free_source_line(struct symbol *sym, int len)
1358 struct annotation *notes = symbol__annotation(sym);
1359 struct source_line *src_line = notes->src->lines;
1360 size_t sizeof_src_line;
1363 sizeof_src_line = sizeof(*src_line) +
1364 (sizeof(src_line->samples) * (src_line->nr_pcnt - 1));
1366 for (i = 0; i < len; i++) {
1367 free_srcline(src_line->path);
1368 src_line = (void *)src_line + sizeof_src_line;
1371 zfree(¬es->src->lines);
1374 /* Get the filename:line for the colored entries */
1375 static int symbol__get_source_line(struct symbol *sym, struct map *map,
1376 struct perf_evsel *evsel,
1377 struct rb_root *root, int len)
1381 int evidx = evsel->idx;
1382 struct source_line *src_line;
1383 struct annotation *notes = symbol__annotation(sym);
1384 struct sym_hist *h = annotation__histogram(notes, evidx);
1385 struct rb_root tmp_root = RB_ROOT;
1388 size_t sizeof_src_line = sizeof(struct source_line);
1390 if (perf_evsel__is_group_event(evsel)) {
1391 for (i = 1; i < evsel->nr_members; i++) {
1392 h = annotation__histogram(notes, evidx + i);
1395 nr_pcnt = evsel->nr_members;
1396 sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->samples);
1402 src_line = notes->src->lines = calloc(len, sizeof_src_line);
1403 if (!notes->src->lines)
1406 start = map__rip_2objdump(map, sym->start);
1408 for (i = 0; i < len; i++) {
1410 double percent_max = 0.0;
1412 src_line->nr_pcnt = nr_pcnt;
1414 for (k = 0; k < nr_pcnt; k++) {
1415 h = annotation__histogram(notes, evidx + k);
1416 src_line->samples[k].percent = 100.0 * h->addr[i] / h->sum;
1418 if (src_line->samples[k].percent > percent_max)
1419 percent_max = src_line->samples[k].percent;
1422 if (percent_max <= 0.5)
1426 src_line->path = get_srcline(map->dso, offset, NULL, false);
1427 insert_source_line(&tmp_root, src_line);
1430 src_line = (void *)src_line + sizeof_src_line;
1433 resort_source_line(root, &tmp_root);
1437 static void print_summary(struct rb_root *root, const char *filename)
1439 struct source_line *src_line;
1440 struct rb_node *node;
1442 printf("\nSorted summary for file %s\n", filename);
1443 printf("----------------------------------------------\n\n");
1445 if (RB_EMPTY_ROOT(root)) {
1446 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1450 node = rb_first(root);
1452 double percent, percent_max = 0.0;
1457 src_line = rb_entry(node, struct source_line, node);
1458 for (i = 0; i < src_line->nr_pcnt; i++) {
1459 percent = src_line->samples[i].percent_sum;
1460 color = get_percent_color(percent);
1461 color_fprintf(stdout, color, " %7.2f", percent);
1463 if (percent > percent_max)
1464 percent_max = percent;
1467 path = src_line->path;
1468 color = get_percent_color(percent_max);
1469 color_fprintf(stdout, color, " %s\n", path);
1471 node = rb_next(node);
1475 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1477 struct annotation *notes = symbol__annotation(sym);
1478 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1479 u64 len = symbol__size(sym), offset;
1481 for (offset = 0; offset < len; ++offset)
1482 if (h->addr[offset] != 0)
1483 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1484 sym->start + offset, h->addr[offset]);
1485 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1488 int symbol__annotate_printf(struct symbol *sym, struct map *map,
1489 struct perf_evsel *evsel, bool full_paths,
1490 int min_pcnt, int max_lines, int context)
1492 struct dso *dso = map->dso;
1494 const char *d_filename;
1495 const char *evsel_name = perf_evsel__name(evsel);
1496 struct annotation *notes = symbol__annotation(sym);
1497 struct disasm_line *pos, *queue = NULL;
1498 u64 start = map__rip_2objdump(map, sym->start);
1499 int printed = 2, queue_len = 0;
1503 int namelen, evsel_name_len, graph_dotted_len;
1505 filename = strdup(dso->long_name);
1510 d_filename = filename;
1512 d_filename = basename(filename);
1514 len = symbol__size(sym);
1515 namelen = strlen(d_filename);
1516 evsel_name_len = strlen(evsel_name);
1518 if (perf_evsel__is_group_event(evsel))
1519 width *= evsel->nr_members;
1521 printf(" %-*.*s| Source code & Disassembly of %s for %s\n",
1522 width, width, "Percent", d_filename, evsel_name);
1524 graph_dotted_len = width + namelen + evsel_name_len;
1525 printf("-%-*.*s-----------------------------------------\n",
1526 graph_dotted_len, graph_dotted_len, graph_dotted_line);
1529 symbol__annotate_hits(sym, evsel);
1531 list_for_each_entry(pos, ¬es->src->source, node) {
1532 if (context && queue == NULL) {
1537 switch (disasm_line__print(pos, sym, start, evsel, len,
1538 min_pcnt, printed, max_lines,
1543 printed += queue_len;
1549 /* filtered by max_lines */
1555 * Filtered by min_pcnt or non IP lines when
1560 if (queue_len == context)
1561 queue = list_entry(queue->node.next, typeof(*queue), node);
1573 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1575 struct annotation *notes = symbol__annotation(sym);
1576 struct sym_hist *h = annotation__histogram(notes, evidx);
1578 memset(h, 0, notes->src->sizeof_sym_hist);
1581 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1583 struct annotation *notes = symbol__annotation(sym);
1584 struct sym_hist *h = annotation__histogram(notes, evidx);
1585 int len = symbol__size(sym), offset;
1588 for (offset = 0; offset < len; ++offset) {
1589 h->addr[offset] = h->addr[offset] * 7 / 8;
1590 h->sum += h->addr[offset];
1594 void disasm__purge(struct list_head *head)
1596 struct disasm_line *pos, *n;
1598 list_for_each_entry_safe(pos, n, head, node) {
1599 list_del(&pos->node);
1600 disasm_line__free(pos);
1604 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1608 if (dl->offset == -1)
1609 return fprintf(fp, "%s\n", dl->line);
1611 printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->name);
1613 if (dl->ops.raw[0] != '\0') {
1614 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1618 return printed + fprintf(fp, "\n");
1621 size_t disasm__fprintf(struct list_head *head, FILE *fp)
1623 struct disasm_line *pos;
1626 list_for_each_entry(pos, head, node)
1627 printed += disasm_line__fprintf(pos, fp);
1632 int symbol__tty_annotate(struct symbol *sym, struct map *map,
1633 struct perf_evsel *evsel, bool print_lines,
1634 bool full_paths, int min_pcnt, int max_lines)
1636 struct dso *dso = map->dso;
1637 struct rb_root source_line = RB_ROOT;
1640 if (symbol__annotate(sym, map, 0) < 0)
1643 len = symbol__size(sym);
1646 srcline_full_filename = full_paths;
1647 symbol__get_source_line(sym, map, evsel, &source_line, len);
1648 print_summary(&source_line, dso->long_name);
1651 symbol__annotate_printf(sym, map, evsel, full_paths,
1652 min_pcnt, max_lines, 0);
1654 symbol__free_source_line(sym, len);
1656 disasm__purge(&symbol__annotation(sym)->src->source);
1661 int hist_entry__annotate(struct hist_entry *he, size_t privsize)
1663 return symbol__annotate(he->ms.sym, he->ms.map, privsize);
1666 bool ui__has_annotation(void)
1668 return use_browser == 1 && perf_hpp_list.sym;