]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blob - tools/perf/util/annotate.c
Merge branch 'sched-core-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[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, u64 *nr_samples)
658 {
659 struct source_line *src_line = notes->src->lines;
660 double percent = 0.0;
661 *nr_samples = 0;
662
663 if (src_line) {
664 size_t sizeof_src_line = sizeof(*src_line) +
665 sizeof(src_line->samples) * (src_line->nr_pcnt - 1);
666
667 while (offset < end) {
668 src_line = (void *)notes->src->lines +
669 (sizeof_src_line * offset);
670
671 if (*path == NULL)
672 *path = src_line->path;
673
674 percent += src_line->samples[evidx].percent;
675 *nr_samples += src_line->samples[evidx].nr;
676 offset++;
677 }
678 } else {
679 struct sym_hist *h = annotation__histogram(notes, evidx);
680 unsigned int hits = 0;
681
682 while (offset < end)
683 hits += h->addr[offset++];
684
685 if (h->sum) {
686 *nr_samples = hits;
687 percent = 100.0 * hits / h->sum;
688 }
689 }
690
691 return percent;
692 }
693
694 static int disasm_line__print(struct disasm_line *dl, struct symbol *sym, u64 start,
695 struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
696 int max_lines, struct disasm_line *queue)
697 {
698 static const char *prev_line;
699 static const char *prev_color;
700
701 if (dl->offset != -1) {
702 const char *path = NULL;
703 u64 nr_samples;
704 double percent, max_percent = 0.0;
705 double *ppercents = &percent;
706 u64 *psamples = &nr_samples;
707 int i, nr_percent = 1;
708 const char *color;
709 struct annotation *notes = symbol__annotation(sym);
710 s64 offset = dl->offset;
711 const u64 addr = start + offset;
712 struct disasm_line *next;
713
714 next = disasm__get_next_ip_line(&notes->src->source, dl);
715
716 if (perf_evsel__is_group_event(evsel)) {
717 nr_percent = evsel->nr_members;
718 ppercents = calloc(nr_percent, sizeof(double));
719 psamples = calloc(nr_percent, sizeof(u64));
720 if (ppercents == NULL || psamples == NULL) {
721 return -1;
722 }
723 }
724
725 for (i = 0; i < nr_percent; i++) {
726 percent = disasm__calc_percent(notes,
727 notes->src->lines ? i : evsel->idx + i,
728 offset,
729 next ? next->offset : (s64) len,
730 &path, &nr_samples);
731
732 ppercents[i] = percent;
733 psamples[i] = nr_samples;
734 if (percent > max_percent)
735 max_percent = percent;
736 }
737
738 if (max_percent < min_pcnt)
739 return -1;
740
741 if (max_lines && printed >= max_lines)
742 return 1;
743
744 if (queue != NULL) {
745 list_for_each_entry_from(queue, &notes->src->source, node) {
746 if (queue == dl)
747 break;
748 disasm_line__print(queue, sym, start, evsel, len,
749 0, 0, 1, NULL);
750 }
751 }
752
753 color = get_percent_color(max_percent);
754
755 /*
756 * Also color the filename and line if needed, with
757 * the same color than the percentage. Don't print it
758 * twice for close colored addr with the same filename:line
759 */
760 if (path) {
761 if (!prev_line || strcmp(prev_line, path)
762 || color != prev_color) {
763 color_fprintf(stdout, color, " %s", path);
764 prev_line = path;
765 prev_color = color;
766 }
767 }
768
769 for (i = 0; i < nr_percent; i++) {
770 percent = ppercents[i];
771 nr_samples = psamples[i];
772 color = get_percent_color(percent);
773
774 if (symbol_conf.show_total_period)
775 color_fprintf(stdout, color, " %7" PRIu64,
776 nr_samples);
777 else
778 color_fprintf(stdout, color, " %7.2f", percent);
779 }
780
781 printf(" : ");
782 color_fprintf(stdout, PERF_COLOR_MAGENTA, " %" PRIx64 ":", addr);
783 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", dl->line);
784
785 if (ppercents != &percent)
786 free(ppercents);
787
788 if (psamples != &nr_samples)
789 free(psamples);
790
791 } else if (max_lines && printed >= max_lines)
792 return 1;
793 else {
794 int width = 8;
795
796 if (queue)
797 return -1;
798
799 if (perf_evsel__is_group_event(evsel))
800 width *= evsel->nr_members;
801
802 if (!*dl->line)
803 printf(" %*s:\n", width, " ");
804 else
805 printf(" %*s: %s\n", width, " ", dl->line);
806 }
807
808 return 0;
809 }
810
811 /*
812 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
813 * which looks like following
814 *
815 * 0000000000415500 <_init>:
816 * 415500: sub $0x8,%rsp
817 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
818 * 41550b: test %rax,%rax
819 * 41550e: je 415515 <_init+0x15>
820 * 415510: callq 416e70 <__gmon_start__@plt>
821 * 415515: add $0x8,%rsp
822 * 415519: retq
823 *
824 * it will be parsed and saved into struct disasm_line as
825 * <offset> <name> <ops.raw>
826 *
827 * The offset will be a relative offset from the start of the symbol and -1
828 * means that it's not a disassembly line so should be treated differently.
829 * The ops.raw part will be parsed further according to type of the instruction.
830 */
831 static int symbol__parse_objdump_line(struct symbol *sym, struct map *map,
832 FILE *file, size_t privsize,
833 int *line_nr)
834 {
835 struct annotation *notes = symbol__annotation(sym);
836 struct disasm_line *dl;
837 char *line = NULL, *parsed_line, *tmp, *tmp2, *c;
838 size_t line_len;
839 s64 line_ip, offset = -1;
840 regmatch_t match[2];
841
842 if (getline(&line, &line_len, file) < 0)
843 return -1;
844
845 if (!line)
846 return -1;
847
848 while (line_len != 0 && isspace(line[line_len - 1]))
849 line[--line_len] = '\0';
850
851 c = strchr(line, '\n');
852 if (c)
853 *c = 0;
854
855 line_ip = -1;
856 parsed_line = line;
857
858 /* /filename:linenr ? Save line number and ignore. */
859 if (regexec(&file_lineno, line, 2, match, 0) == 0) {
860 *line_nr = atoi(line + match[1].rm_so);
861 return 0;
862 }
863
864 /*
865 * Strip leading spaces:
866 */
867 tmp = line;
868 while (*tmp) {
869 if (*tmp != ' ')
870 break;
871 tmp++;
872 }
873
874 if (*tmp) {
875 /*
876 * Parse hexa addresses followed by ':'
877 */
878 line_ip = strtoull(tmp, &tmp2, 16);
879 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
880 line_ip = -1;
881 }
882
883 if (line_ip != -1) {
884 u64 start = map__rip_2objdump(map, sym->start),
885 end = map__rip_2objdump(map, sym->end);
886
887 offset = line_ip - start;
888 if ((u64)line_ip < start || (u64)line_ip >= end)
889 offset = -1;
890 else
891 parsed_line = tmp2 + 1;
892 }
893
894 dl = disasm_line__new(offset, parsed_line, privsize, *line_nr);
895 free(line);
896 (*line_nr)++;
897
898 if (dl == NULL)
899 return -1;
900
901 if (dl->ops.target.offset == UINT64_MAX)
902 dl->ops.target.offset = dl->ops.target.addr -
903 map__rip_2objdump(map, sym->start);
904
905 /* kcore has no symbols, so add the call target name */
906 if (dl->ins && ins__is_call(dl->ins) && !dl->ops.target.name) {
907 struct addr_map_symbol target = {
908 .map = map,
909 .addr = dl->ops.target.addr,
910 };
911
912 if (!map_groups__find_ams(&target, NULL) &&
913 target.sym->start == target.al_addr)
914 dl->ops.target.name = strdup(target.sym->name);
915 }
916
917 disasm__add(&notes->src->source, dl);
918
919 return 0;
920 }
921
922 static __attribute__((constructor)) void symbol__init_regexpr(void)
923 {
924 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
925 }
926
927 static void delete_last_nop(struct symbol *sym)
928 {
929 struct annotation *notes = symbol__annotation(sym);
930 struct list_head *list = &notes->src->source;
931 struct disasm_line *dl;
932
933 while (!list_empty(list)) {
934 dl = list_entry(list->prev, struct disasm_line, node);
935
936 if (dl->ins && dl->ins->ops) {
937 if (dl->ins->ops != &nop_ops)
938 return;
939 } else {
940 if (!strstr(dl->line, " nop ") &&
941 !strstr(dl->line, " nopl ") &&
942 !strstr(dl->line, " nopw "))
943 return;
944 }
945
946 list_del(&dl->node);
947 disasm_line__free(dl);
948 }
949 }
950
951 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize)
952 {
953 struct dso *dso = map->dso;
954 char *filename = dso__build_id_filename(dso, NULL, 0);
955 bool free_filename = true;
956 char command[PATH_MAX * 2];
957 FILE *file;
958 int err = 0;
959 char symfs_filename[PATH_MAX];
960 struct kcore_extract kce;
961 bool delete_extract = false;
962 int lineno = 0;
963
964 if (filename)
965 symbol__join_symfs(symfs_filename, filename);
966
967 if (filename == NULL) {
968 if (dso->has_build_id) {
969 pr_err("Can't annotate %s: not enough memory\n",
970 sym->name);
971 return -ENOMEM;
972 }
973 goto fallback;
974 } else if (dso__is_kcore(dso)) {
975 goto fallback;
976 } else if (readlink(symfs_filename, command, sizeof(command)) < 0 ||
977 strstr(command, "[kernel.kallsyms]") ||
978 access(symfs_filename, R_OK)) {
979 free(filename);
980 fallback:
981 /*
982 * If we don't have build-ids or the build-id file isn't in the
983 * cache, or is just a kallsyms file, well, lets hope that this
984 * DSO is the same as when 'perf record' ran.
985 */
986 filename = (char *)dso->long_name;
987 symbol__join_symfs(symfs_filename, filename);
988 free_filename = false;
989 }
990
991 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
992 !dso__is_kcore(dso)) {
993 char bf[BUILD_ID_SIZE * 2 + 16] = " with build id ";
994 char *build_id_msg = NULL;
995
996 if (dso->annotate_warned)
997 goto out_free_filename;
998
999 if (dso->has_build_id) {
1000 build_id__sprintf(dso->build_id,
1001 sizeof(dso->build_id), bf + 15);
1002 build_id_msg = bf;
1003 }
1004 err = -ENOENT;
1005 dso->annotate_warned = 1;
1006 pr_err("Can't annotate %s:\n\n"
1007 "No vmlinux file%s\nwas found in the path.\n\n"
1008 "Please use:\n\n"
1009 " perf buildid-cache -vu vmlinux\n\n"
1010 "or:\n\n"
1011 " --vmlinux vmlinux\n",
1012 sym->name, build_id_msg ?: "");
1013 goto out_free_filename;
1014 }
1015
1016 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1017 filename, sym->name, map->unmap_ip(map, sym->start),
1018 map->unmap_ip(map, sym->end));
1019
1020 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1021 dso, dso->long_name, sym, sym->name);
1022
1023 if (dso__is_kcore(dso)) {
1024 kce.kcore_filename = symfs_filename;
1025 kce.addr = map__rip_2objdump(map, sym->start);
1026 kce.offs = sym->start;
1027 kce.len = sym->end - sym->start;
1028 if (!kcore_extract__create(&kce)) {
1029 delete_extract = true;
1030 strlcpy(symfs_filename, kce.extract_filename,
1031 sizeof(symfs_filename));
1032 if (free_filename) {
1033 free(filename);
1034 free_filename = false;
1035 }
1036 filename = symfs_filename;
1037 }
1038 } else if (dso__needs_decompress(dso)) {
1039 char tmp[PATH_MAX];
1040 struct kmod_path m;
1041 int fd;
1042 bool ret;
1043
1044 if (kmod_path__parse_ext(&m, symfs_filename))
1045 goto out_free_filename;
1046
1047 snprintf(tmp, PATH_MAX, "/tmp/perf-kmod-XXXXXX");
1048
1049 fd = mkstemp(tmp);
1050 if (fd < 0) {
1051 free(m.ext);
1052 goto out_free_filename;
1053 }
1054
1055 ret = decompress_to_file(m.ext, symfs_filename, fd);
1056
1057 free(m.ext);
1058 close(fd);
1059
1060 if (!ret)
1061 goto out_free_filename;
1062
1063 strcpy(symfs_filename, tmp);
1064 }
1065
1066 snprintf(command, sizeof(command),
1067 "%s %s%s --start-address=0x%016" PRIx64
1068 " --stop-address=0x%016" PRIx64
1069 " -l -d %s %s -C %s 2>/dev/null|grep -v %s|expand",
1070 objdump_path ? objdump_path : "objdump",
1071 disassembler_style ? "-M " : "",
1072 disassembler_style ? disassembler_style : "",
1073 map__rip_2objdump(map, sym->start),
1074 map__rip_2objdump(map, sym->end),
1075 symbol_conf.annotate_asm_raw ? "" : "--no-show-raw",
1076 symbol_conf.annotate_src ? "-S" : "",
1077 symfs_filename, filename);
1078
1079 pr_debug("Executing: %s\n", command);
1080
1081 file = popen(command, "r");
1082 if (!file)
1083 goto out_remove_tmp;
1084
1085 while (!feof(file))
1086 if (symbol__parse_objdump_line(sym, map, file, privsize,
1087 &lineno) < 0)
1088 break;
1089
1090 /*
1091 * kallsyms does not have symbol sizes so there may a nop at the end.
1092 * Remove it.
1093 */
1094 if (dso__is_kcore(dso))
1095 delete_last_nop(sym);
1096
1097 pclose(file);
1098
1099 out_remove_tmp:
1100 if (dso__needs_decompress(dso))
1101 unlink(symfs_filename);
1102 out_free_filename:
1103 if (delete_extract)
1104 kcore_extract__delete(&kce);
1105 if (free_filename)
1106 free(filename);
1107 return err;
1108 }
1109
1110 static void insert_source_line(struct rb_root *root, struct source_line *src_line)
1111 {
1112 struct source_line *iter;
1113 struct rb_node **p = &root->rb_node;
1114 struct rb_node *parent = NULL;
1115 int i, ret;
1116
1117 while (*p != NULL) {
1118 parent = *p;
1119 iter = rb_entry(parent, struct source_line, node);
1120
1121 ret = strcmp(iter->path, src_line->path);
1122 if (ret == 0) {
1123 for (i = 0; i < src_line->nr_pcnt; i++)
1124 iter->samples[i].percent_sum += src_line->samples[i].percent;
1125 return;
1126 }
1127
1128 if (ret < 0)
1129 p = &(*p)->rb_left;
1130 else
1131 p = &(*p)->rb_right;
1132 }
1133
1134 for (i = 0; i < src_line->nr_pcnt; i++)
1135 src_line->samples[i].percent_sum = src_line->samples[i].percent;
1136
1137 rb_link_node(&src_line->node, parent, p);
1138 rb_insert_color(&src_line->node, root);
1139 }
1140
1141 static int cmp_source_line(struct source_line *a, struct source_line *b)
1142 {
1143 int i;
1144
1145 for (i = 0; i < a->nr_pcnt; i++) {
1146 if (a->samples[i].percent_sum == b->samples[i].percent_sum)
1147 continue;
1148 return a->samples[i].percent_sum > b->samples[i].percent_sum;
1149 }
1150
1151 return 0;
1152 }
1153
1154 static void __resort_source_line(struct rb_root *root, struct source_line *src_line)
1155 {
1156 struct source_line *iter;
1157 struct rb_node **p = &root->rb_node;
1158 struct rb_node *parent = NULL;
1159
1160 while (*p != NULL) {
1161 parent = *p;
1162 iter = rb_entry(parent, struct source_line, node);
1163
1164 if (cmp_source_line(src_line, iter))
1165 p = &(*p)->rb_left;
1166 else
1167 p = &(*p)->rb_right;
1168 }
1169
1170 rb_link_node(&src_line->node, parent, p);
1171 rb_insert_color(&src_line->node, root);
1172 }
1173
1174 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1175 {
1176 struct source_line *src_line;
1177 struct rb_node *node;
1178
1179 node = rb_first(src_root);
1180 while (node) {
1181 struct rb_node *next;
1182
1183 src_line = rb_entry(node, struct source_line, node);
1184 next = rb_next(node);
1185 rb_erase(node, src_root);
1186
1187 __resort_source_line(dest_root, src_line);
1188 node = next;
1189 }
1190 }
1191
1192 static void symbol__free_source_line(struct symbol *sym, int len)
1193 {
1194 struct annotation *notes = symbol__annotation(sym);
1195 struct source_line *src_line = notes->src->lines;
1196 size_t sizeof_src_line;
1197 int i;
1198
1199 sizeof_src_line = sizeof(*src_line) +
1200 (sizeof(src_line->samples) * (src_line->nr_pcnt - 1));
1201
1202 for (i = 0; i < len; i++) {
1203 free_srcline(src_line->path);
1204 src_line = (void *)src_line + sizeof_src_line;
1205 }
1206
1207 zfree(&notes->src->lines);
1208 }
1209
1210 /* Get the filename:line for the colored entries */
1211 static int symbol__get_source_line(struct symbol *sym, struct map *map,
1212 struct perf_evsel *evsel,
1213 struct rb_root *root, int len)
1214 {
1215 u64 start;
1216 int i, k;
1217 int evidx = evsel->idx;
1218 struct source_line *src_line;
1219 struct annotation *notes = symbol__annotation(sym);
1220 struct sym_hist *h = annotation__histogram(notes, evidx);
1221 struct rb_root tmp_root = RB_ROOT;
1222 int nr_pcnt = 1;
1223 u64 h_sum = h->sum;
1224 size_t sizeof_src_line = sizeof(struct source_line);
1225
1226 if (perf_evsel__is_group_event(evsel)) {
1227 for (i = 1; i < evsel->nr_members; i++) {
1228 h = annotation__histogram(notes, evidx + i);
1229 h_sum += h->sum;
1230 }
1231 nr_pcnt = evsel->nr_members;
1232 sizeof_src_line += (nr_pcnt - 1) * sizeof(src_line->samples);
1233 }
1234
1235 if (!h_sum)
1236 return 0;
1237
1238 src_line = notes->src->lines = calloc(len, sizeof_src_line);
1239 if (!notes->src->lines)
1240 return -1;
1241
1242 start = map__rip_2objdump(map, sym->start);
1243
1244 for (i = 0; i < len; i++) {
1245 u64 offset;
1246 double percent_max = 0.0;
1247
1248 src_line->nr_pcnt = nr_pcnt;
1249
1250 for (k = 0; k < nr_pcnt; k++) {
1251 h = annotation__histogram(notes, evidx + k);
1252 src_line->samples[k].percent = 100.0 * h->addr[i] / h->sum;
1253
1254 if (src_line->samples[k].percent > percent_max)
1255 percent_max = src_line->samples[k].percent;
1256 }
1257
1258 if (percent_max <= 0.5)
1259 goto next;
1260
1261 offset = start + i;
1262 src_line->path = get_srcline(map->dso, offset, NULL, false);
1263 insert_source_line(&tmp_root, src_line);
1264
1265 next:
1266 src_line = (void *)src_line + sizeof_src_line;
1267 }
1268
1269 resort_source_line(root, &tmp_root);
1270 return 0;
1271 }
1272
1273 static void print_summary(struct rb_root *root, const char *filename)
1274 {
1275 struct source_line *src_line;
1276 struct rb_node *node;
1277
1278 printf("\nSorted summary for file %s\n", filename);
1279 printf("----------------------------------------------\n\n");
1280
1281 if (RB_EMPTY_ROOT(root)) {
1282 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1283 return;
1284 }
1285
1286 node = rb_first(root);
1287 while (node) {
1288 double percent, percent_max = 0.0;
1289 const char *color;
1290 char *path;
1291 int i;
1292
1293 src_line = rb_entry(node, struct source_line, node);
1294 for (i = 0; i < src_line->nr_pcnt; i++) {
1295 percent = src_line->samples[i].percent_sum;
1296 color = get_percent_color(percent);
1297 color_fprintf(stdout, color, " %7.2f", percent);
1298
1299 if (percent > percent_max)
1300 percent_max = percent;
1301 }
1302
1303 path = src_line->path;
1304 color = get_percent_color(percent_max);
1305 color_fprintf(stdout, color, " %s\n", path);
1306
1307 node = rb_next(node);
1308 }
1309 }
1310
1311 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
1312 {
1313 struct annotation *notes = symbol__annotation(sym);
1314 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
1315 u64 len = symbol__size(sym), offset;
1316
1317 for (offset = 0; offset < len; ++offset)
1318 if (h->addr[offset] != 0)
1319 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1320 sym->start + offset, h->addr[offset]);
1321 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->sum", h->sum);
1322 }
1323
1324 int symbol__annotate_printf(struct symbol *sym, struct map *map,
1325 struct perf_evsel *evsel, bool full_paths,
1326 int min_pcnt, int max_lines, int context)
1327 {
1328 struct dso *dso = map->dso;
1329 char *filename;
1330 const char *d_filename;
1331 const char *evsel_name = perf_evsel__name(evsel);
1332 struct annotation *notes = symbol__annotation(sym);
1333 struct disasm_line *pos, *queue = NULL;
1334 u64 start = map__rip_2objdump(map, sym->start);
1335 int printed = 2, queue_len = 0;
1336 int more = 0;
1337 u64 len;
1338 int width = 8;
1339 int namelen, evsel_name_len, graph_dotted_len;
1340
1341 filename = strdup(dso->long_name);
1342 if (!filename)
1343 return -ENOMEM;
1344
1345 if (full_paths)
1346 d_filename = filename;
1347 else
1348 d_filename = basename(filename);
1349
1350 len = symbol__size(sym);
1351 namelen = strlen(d_filename);
1352 evsel_name_len = strlen(evsel_name);
1353
1354 if (perf_evsel__is_group_event(evsel))
1355 width *= evsel->nr_members;
1356
1357 printf(" %-*.*s| Source code & Disassembly of %s for %s\n",
1358 width, width, "Percent", d_filename, evsel_name);
1359
1360 graph_dotted_len = width + namelen + evsel_name_len;
1361 printf("-%-*.*s-----------------------------------------\n",
1362 graph_dotted_len, graph_dotted_len, graph_dotted_line);
1363
1364 if (verbose)
1365 symbol__annotate_hits(sym, evsel);
1366
1367 list_for_each_entry(pos, &notes->src->source, node) {
1368 if (context && queue == NULL) {
1369 queue = pos;
1370 queue_len = 0;
1371 }
1372
1373 switch (disasm_line__print(pos, sym, start, evsel, len,
1374 min_pcnt, printed, max_lines,
1375 queue)) {
1376 case 0:
1377 ++printed;
1378 if (context) {
1379 printed += queue_len;
1380 queue = NULL;
1381 queue_len = 0;
1382 }
1383 break;
1384 case 1:
1385 /* filtered by max_lines */
1386 ++more;
1387 break;
1388 case -1:
1389 default:
1390 /*
1391 * Filtered by min_pcnt or non IP lines when
1392 * context != 0
1393 */
1394 if (!context)
1395 break;
1396 if (queue_len == context)
1397 queue = list_entry(queue->node.next, typeof(*queue), node);
1398 else
1399 ++queue_len;
1400 break;
1401 }
1402 }
1403
1404 free(filename);
1405
1406 return more;
1407 }
1408
1409 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1410 {
1411 struct annotation *notes = symbol__annotation(sym);
1412 struct sym_hist *h = annotation__histogram(notes, evidx);
1413
1414 memset(h, 0, notes->src->sizeof_sym_hist);
1415 }
1416
1417 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1418 {
1419 struct annotation *notes = symbol__annotation(sym);
1420 struct sym_hist *h = annotation__histogram(notes, evidx);
1421 int len = symbol__size(sym), offset;
1422
1423 h->sum = 0;
1424 for (offset = 0; offset < len; ++offset) {
1425 h->addr[offset] = h->addr[offset] * 7 / 8;
1426 h->sum += h->addr[offset];
1427 }
1428 }
1429
1430 void disasm__purge(struct list_head *head)
1431 {
1432 struct disasm_line *pos, *n;
1433
1434 list_for_each_entry_safe(pos, n, head, node) {
1435 list_del(&pos->node);
1436 disasm_line__free(pos);
1437 }
1438 }
1439
1440 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1441 {
1442 size_t printed;
1443
1444 if (dl->offset == -1)
1445 return fprintf(fp, "%s\n", dl->line);
1446
1447 printed = fprintf(fp, "%#" PRIx64 " %s", dl->offset, dl->name);
1448
1449 if (dl->ops.raw[0] != '\0') {
1450 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1451 dl->ops.raw);
1452 }
1453
1454 return printed + fprintf(fp, "\n");
1455 }
1456
1457 size_t disasm__fprintf(struct list_head *head, FILE *fp)
1458 {
1459 struct disasm_line *pos;
1460 size_t printed = 0;
1461
1462 list_for_each_entry(pos, head, node)
1463 printed += disasm_line__fprintf(pos, fp);
1464
1465 return printed;
1466 }
1467
1468 int symbol__tty_annotate(struct symbol *sym, struct map *map,
1469 struct perf_evsel *evsel, bool print_lines,
1470 bool full_paths, int min_pcnt, int max_lines)
1471 {
1472 struct dso *dso = map->dso;
1473 struct rb_root source_line = RB_ROOT;
1474 u64 len;
1475
1476 if (symbol__annotate(sym, map, 0) < 0)
1477 return -1;
1478
1479 len = symbol__size(sym);
1480
1481 if (print_lines) {
1482 symbol__get_source_line(sym, map, evsel, &source_line, len);
1483 print_summary(&source_line, dso->long_name);
1484 }
1485
1486 symbol__annotate_printf(sym, map, evsel, full_paths,
1487 min_pcnt, max_lines, 0);
1488 if (print_lines)
1489 symbol__free_source_line(sym, len);
1490
1491 disasm__purge(&symbol__annotation(sym)->src->source);
1492
1493 return 0;
1494 }
1495
1496 int hist_entry__annotate(struct hist_entry *he, size_t privsize)
1497 {
1498 return symbol__annotate(he->ms.sym, he->ms.map, privsize);
1499 }
1500
1501 bool ui__has_annotation(void)
1502 {
1503 return use_browser == 1 && sort__has_sym;
1504 }