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