Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
4 *
5 * Parts came from builtin-annotate.c, see those files for further
6 * copyright notes.
7 */
8
9#include <errno.h>
10#include <inttypes.h>
11#include <libgen.h>
12#include <stdlib.h>
13#include "util.h" // hex_width()
14#include "ui/ui.h"
15#include "sort.h"
16#include "build-id.h"
17#include "color.h"
18#include "config.h"
19#include "disasm.h"
20#include "dso.h"
21#include "env.h"
22#include "map.h"
23#include "maps.h"
24#include "symbol.h"
25#include "srcline.h"
26#include "units.h"
27#include "debug.h"
28#include "debuginfo.h"
29#include "annotate.h"
30#include "annotate-data.h"
31#include "evsel.h"
32#include "evlist.h"
33#include "bpf-event.h"
34#include "bpf-utils.h"
35#include "block-range.h"
36#include "string2.h"
37#include "dwarf-regs.h"
38#include "util/event.h"
39#include "util/sharded_mutex.h"
40#include "arch/common.h"
41#include "namespaces.h"
42#include "thread.h"
43#include "hashmap.h"
44#include "strbuf.h"
45#include <regex.h>
46#include <linux/bitops.h>
47#include <linux/kernel.h>
48#include <linux/string.h>
49#include <linux/zalloc.h>
50#include <subcmd/parse-options.h>
51#include <subcmd/run-command.h>
52#include <math.h>
53
54/* FIXME: For the HE_COLORSET */
55#include "ui/browser.h"
56
57/*
58 * FIXME: Using the same values as slang.h,
59 * but that header may not be available everywhere
60 */
61#define LARROW_CHAR ((unsigned char)',')
62#define RARROW_CHAR ((unsigned char)'+')
63#define DARROW_CHAR ((unsigned char)'.')
64#define UARROW_CHAR ((unsigned char)'-')
65
66#include <linux/ctype.h>
67
68/* global annotation options */
69struct annotation_options annotate_opts;
70
71/* Data type collection debug statistics */
72struct annotated_data_stat ann_data_stat;
73LIST_HEAD(ann_insn_stat);
74
75/* Pseudo data types */
76struct annotated_data_type stackop_type = {
77 .self = {
78 .type_name = (char *)"(stack operation)",
79 .children = LIST_HEAD_INIT(stackop_type.self.children),
80 },
81};
82
83struct annotated_data_type canary_type = {
84 .self = {
85 .type_name = (char *)"(stack canary)",
86 .children = LIST_HEAD_INIT(canary_type.self.children),
87 },
88};
89
90/* symbol histogram: key = offset << 16 | evsel->core.idx */
91static size_t sym_hist_hash(long key, void *ctx __maybe_unused)
92{
93 return (key >> 16) + (key & 0xffff);
94}
95
96static bool sym_hist_equal(long key1, long key2, void *ctx __maybe_unused)
97{
98 return key1 == key2;
99}
100
101static struct annotated_source *annotated_source__new(void)
102{
103 struct annotated_source *src = zalloc(sizeof(*src));
104
105 if (src != NULL)
106 INIT_LIST_HEAD(&src->source);
107
108 return src;
109}
110
111static __maybe_unused void annotated_source__delete(struct annotated_source *src)
112{
113 struct hashmap_entry *cur;
114 size_t bkt;
115
116 if (src == NULL)
117 return;
118
119 if (src->samples) {
120 hashmap__for_each_entry(src->samples, cur, bkt)
121 zfree(&cur->pvalue);
122 hashmap__free(src->samples);
123 }
124 zfree(&src->histograms);
125 free(src);
126}
127
128static int annotated_source__alloc_histograms(struct annotated_source *src,
129 int nr_hists)
130{
131 src->nr_histograms = nr_hists;
132 src->histograms = calloc(nr_hists, sizeof(*src->histograms));
133
134 if (src->histograms == NULL)
135 return -1;
136
137 src->samples = hashmap__new(sym_hist_hash, sym_hist_equal, NULL);
138 if (src->samples == NULL)
139 zfree(&src->histograms);
140
141 return src->histograms ? 0 : -1;
142}
143
144void symbol__annotate_zero_histograms(struct symbol *sym)
145{
146 struct annotation *notes = symbol__annotation(sym);
147
148 annotation__lock(notes);
149 if (notes->src != NULL) {
150 memset(notes->src->histograms, 0,
151 notes->src->nr_histograms * sizeof(*notes->src->histograms));
152 hashmap__clear(notes->src->samples);
153 }
154 if (notes->branch && notes->branch->cycles_hist) {
155 memset(notes->branch->cycles_hist, 0,
156 symbol__size(sym) * sizeof(struct cyc_hist));
157 }
158 annotation__unlock(notes);
159}
160
161static int __symbol__account_cycles(struct cyc_hist *ch,
162 u64 start,
163 unsigned offset, unsigned cycles,
164 unsigned have_start)
165{
166 /*
167 * For now we can only account one basic block per
168 * final jump. But multiple could be overlapping.
169 * Always account the longest one. So when
170 * a shorter one has been already seen throw it away.
171 *
172 * We separately always account the full cycles.
173 */
174 ch[offset].num_aggr++;
175 ch[offset].cycles_aggr += cycles;
176
177 if (cycles > ch[offset].cycles_max)
178 ch[offset].cycles_max = cycles;
179
180 if (ch[offset].cycles_min) {
181 if (cycles && cycles < ch[offset].cycles_min)
182 ch[offset].cycles_min = cycles;
183 } else
184 ch[offset].cycles_min = cycles;
185
186 if (!have_start && ch[offset].have_start)
187 return 0;
188 if (ch[offset].num) {
189 if (have_start && (!ch[offset].have_start ||
190 ch[offset].start > start)) {
191 ch[offset].have_start = 0;
192 ch[offset].cycles = 0;
193 ch[offset].num = 0;
194 if (ch[offset].reset < 0xffff)
195 ch[offset].reset++;
196 } else if (have_start &&
197 ch[offset].start < start)
198 return 0;
199 }
200
201 if (ch[offset].num < NUM_SPARKS)
202 ch[offset].cycles_spark[ch[offset].num] = cycles;
203
204 ch[offset].have_start = have_start;
205 ch[offset].start = start;
206 ch[offset].cycles += cycles;
207 ch[offset].num++;
208 return 0;
209}
210
211static int __symbol__inc_addr_samples(struct map_symbol *ms,
212 struct annotated_source *src, int evidx, u64 addr,
213 struct perf_sample *sample)
214{
215 struct symbol *sym = ms->sym;
216 long hash_key;
217 u64 offset;
218 struct sym_hist *h;
219 struct sym_hist_entry *entry;
220
221 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map__unmap_ip(ms->map, addr));
222
223 if ((addr < sym->start || addr >= sym->end) &&
224 (addr != sym->end || sym->start != sym->end)) {
225 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
226 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
227 return -ERANGE;
228 }
229
230 offset = addr - sym->start;
231 h = annotated_source__histogram(src, evidx);
232 if (h == NULL) {
233 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
234 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
235 return -ENOMEM;
236 }
237
238 hash_key = offset << 16 | evidx;
239 if (!hashmap__find(src->samples, hash_key, &entry)) {
240 entry = zalloc(sizeof(*entry));
241 if (entry == NULL)
242 return -ENOMEM;
243
244 if (hashmap__add(src->samples, hash_key, entry) < 0)
245 return -ENOMEM;
246 }
247
248 h->nr_samples++;
249 h->period += sample->period;
250 entry->nr_samples++;
251 entry->period += sample->period;
252
253 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
254 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
255 sym->start, sym->name, addr, addr - sym->start, evidx,
256 entry->nr_samples, entry->period);
257 return 0;
258}
259
260struct annotated_branch *annotation__get_branch(struct annotation *notes)
261{
262 if (notes == NULL)
263 return NULL;
264
265 if (notes->branch == NULL)
266 notes->branch = zalloc(sizeof(*notes->branch));
267
268 return notes->branch;
269}
270
271static struct annotated_branch *symbol__find_branch_hist(struct symbol *sym,
272 unsigned int br_cntr_nr)
273{
274 struct annotation *notes = symbol__annotation(sym);
275 struct annotated_branch *branch;
276 const size_t size = symbol__size(sym);
277
278 branch = annotation__get_branch(notes);
279 if (branch == NULL)
280 return NULL;
281
282 if (branch->cycles_hist == NULL) {
283 branch->cycles_hist = calloc(size, sizeof(struct cyc_hist));
284 if (!branch->cycles_hist)
285 return NULL;
286 }
287
288 if (br_cntr_nr && branch->br_cntr == NULL) {
289 branch->br_cntr = calloc(br_cntr_nr * size, sizeof(u64));
290 if (!branch->br_cntr)
291 return NULL;
292 }
293
294 return branch;
295}
296
297struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
298{
299 struct annotation *notes = symbol__annotation(sym);
300
301 if (notes->src == NULL) {
302 notes->src = annotated_source__new();
303 if (notes->src == NULL)
304 return NULL;
305 goto alloc_histograms;
306 }
307
308 if (notes->src->histograms == NULL) {
309alloc_histograms:
310 annotated_source__alloc_histograms(notes->src, nr_hists);
311 }
312
313 return notes->src;
314}
315
316static int symbol__inc_addr_samples(struct map_symbol *ms,
317 struct evsel *evsel, u64 addr,
318 struct perf_sample *sample)
319{
320 struct symbol *sym = ms->sym;
321 struct annotated_source *src;
322
323 if (sym == NULL)
324 return 0;
325 src = symbol__hists(sym, evsel->evlist->core.nr_entries);
326 return src ? __symbol__inc_addr_samples(ms, src, evsel->core.idx, addr, sample) : 0;
327}
328
329static int symbol__account_br_cntr(struct annotated_branch *branch,
330 struct evsel *evsel,
331 unsigned offset,
332 u64 br_cntr)
333{
334 unsigned int br_cntr_nr = evsel__leader(evsel)->br_cntr_nr;
335 unsigned int base = evsel__leader(evsel)->br_cntr_idx;
336 unsigned int off = offset * evsel->evlist->nr_br_cntr;
337 u64 *branch_br_cntr = branch->br_cntr;
338 unsigned int i, mask, width;
339
340 if (!br_cntr || !branch_br_cntr)
341 return 0;
342
343 perf_env__find_br_cntr_info(evsel__env(evsel), NULL, &width);
344 mask = (1L << width) - 1;
345 for (i = 0; i < br_cntr_nr; i++) {
346 u64 cntr = (br_cntr >> i * width) & mask;
347
348 branch_br_cntr[off + i + base] += cntr;
349 if (cntr == mask)
350 branch_br_cntr[off + i + base] |= ANNOTATION__BR_CNTR_SATURATED_FLAG;
351 }
352
353 return 0;
354}
355
356static int symbol__account_cycles(u64 addr, u64 start, struct symbol *sym,
357 unsigned cycles, struct evsel *evsel,
358 u64 br_cntr)
359{
360 struct annotated_branch *branch;
361 unsigned offset;
362 int ret;
363
364 if (sym == NULL)
365 return 0;
366 branch = symbol__find_branch_hist(sym, evsel->evlist->nr_br_cntr);
367 if (!branch)
368 return -ENOMEM;
369 if (addr < sym->start || addr >= sym->end)
370 return -ERANGE;
371
372 if (start) {
373 if (start < sym->start || start >= sym->end)
374 return -ERANGE;
375 if (start >= addr)
376 start = 0;
377 }
378 offset = addr - sym->start;
379 ret = __symbol__account_cycles(branch->cycles_hist,
380 start ? start - sym->start : 0,
381 offset, cycles,
382 !!start);
383
384 if (ret)
385 return ret;
386
387 return symbol__account_br_cntr(branch, evsel, offset, br_cntr);
388}
389
390int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
391 struct addr_map_symbol *start,
392 unsigned cycles,
393 struct evsel *evsel,
394 u64 br_cntr)
395{
396 u64 saddr = 0;
397 int err;
398
399 if (!cycles)
400 return 0;
401
402 /*
403 * Only set start when IPC can be computed. We can only
404 * compute it when the basic block is completely in a single
405 * function.
406 * Special case the case when the jump is elsewhere, but
407 * it starts on the function start.
408 */
409 if (start &&
410 (start->ms.sym == ams->ms.sym ||
411 (ams->ms.sym &&
412 start->addr == ams->ms.sym->start + map__start(ams->ms.map))))
413 saddr = start->al_addr;
414 if (saddr == 0)
415 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
416 ams->addr,
417 start ? start->addr : 0,
418 ams->ms.sym ? ams->ms.sym->start + map__start(ams->ms.map) : 0,
419 saddr);
420 err = symbol__account_cycles(ams->al_addr, saddr, ams->ms.sym, cycles, evsel, br_cntr);
421 if (err)
422 pr_debug2("account_cycles failed %d\n", err);
423 return err;
424}
425
426struct annotation_line *annotated_source__get_line(struct annotated_source *src,
427 s64 offset)
428{
429 struct annotation_line *al;
430
431 list_for_each_entry(al, &src->source, node) {
432 if (al->offset == offset)
433 return al;
434 }
435 return NULL;
436}
437
438static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
439{
440 struct annotation_line *al;
441 unsigned n_insn = 0;
442
443 al = annotated_source__get_line(notes->src, start);
444 if (al == NULL)
445 return 0;
446
447 list_for_each_entry_from(al, ¬es->src->source, node) {
448 if (al->offset == -1)
449 continue;
450 if ((u64)al->offset > end)
451 break;
452 n_insn++;
453 }
454 return n_insn;
455}
456
457static void annotated_branch__delete(struct annotated_branch *branch)
458{
459 if (branch) {
460 zfree(&branch->cycles_hist);
461 free(branch->br_cntr);
462 free(branch);
463 }
464}
465
466static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
467{
468 unsigned n_insn;
469 unsigned int cover_insn = 0;
470
471 n_insn = annotation__count_insn(notes, start, end);
472 if (n_insn && ch->num && ch->cycles) {
473 struct annotation_line *al;
474 struct annotated_branch *branch;
475 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
476
477 /* Hide data when there are too many overlaps. */
478 if (ch->reset >= 0x7fff)
479 return;
480
481 al = annotated_source__get_line(notes->src, start);
482 if (al == NULL)
483 return;
484
485 list_for_each_entry_from(al, ¬es->src->source, node) {
486 if (al->offset == -1)
487 continue;
488 if ((u64)al->offset > end)
489 break;
490 if (al->cycles && al->cycles->ipc == 0.0) {
491 al->cycles->ipc = ipc;
492 cover_insn++;
493 }
494 }
495
496 branch = annotation__get_branch(notes);
497 if (cover_insn && branch) {
498 branch->hit_cycles += ch->cycles;
499 branch->hit_insn += n_insn * ch->num;
500 branch->cover_insn += cover_insn;
501 }
502 }
503}
504
505static int annotation__compute_ipc(struct annotation *notes, size_t size,
506 struct evsel *evsel)
507{
508 unsigned int br_cntr_nr = evsel->evlist->nr_br_cntr;
509 int err = 0;
510 s64 offset;
511
512 if (!notes->branch || !notes->branch->cycles_hist)
513 return 0;
514
515 notes->branch->total_insn = annotation__count_insn(notes, 0, size - 1);
516 notes->branch->hit_cycles = 0;
517 notes->branch->hit_insn = 0;
518 notes->branch->cover_insn = 0;
519
520 annotation__lock(notes);
521 for (offset = size - 1; offset >= 0; --offset) {
522 struct cyc_hist *ch;
523
524 ch = ¬es->branch->cycles_hist[offset];
525 if (ch && ch->cycles) {
526 struct annotation_line *al;
527
528 al = annotated_source__get_line(notes->src, offset);
529 if (al && al->cycles == NULL) {
530 al->cycles = zalloc(sizeof(*al->cycles));
531 if (al->cycles == NULL) {
532 err = ENOMEM;
533 break;
534 }
535 }
536 if (ch->have_start)
537 annotation__count_and_fill(notes, ch->start, offset, ch);
538 if (al && ch->num_aggr) {
539 al->cycles->avg = ch->cycles_aggr / ch->num_aggr;
540 al->cycles->max = ch->cycles_max;
541 al->cycles->min = ch->cycles_min;
542 }
543 if (al && notes->branch->br_cntr) {
544 if (!al->br_cntr) {
545 al->br_cntr = calloc(br_cntr_nr, sizeof(u64));
546 if (!al->br_cntr) {
547 err = ENOMEM;
548 break;
549 }
550 }
551 al->num_aggr = ch->num_aggr;
552 al->br_cntr_nr = br_cntr_nr;
553 al->evsel = evsel;
554 memcpy(al->br_cntr, ¬es->branch->br_cntr[offset * br_cntr_nr],
555 br_cntr_nr * sizeof(u64));
556 }
557 }
558 }
559
560 if (err) {
561 while (++offset < (s64)size) {
562 struct cyc_hist *ch = ¬es->branch->cycles_hist[offset];
563
564 if (ch && ch->cycles) {
565 struct annotation_line *al;
566
567 al = annotated_source__get_line(notes->src, offset);
568 if (al) {
569 zfree(&al->cycles);
570 zfree(&al->br_cntr);
571 }
572 }
573 }
574 }
575
576 annotation__unlock(notes);
577 return 0;
578}
579
580int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
581 struct evsel *evsel)
582{
583 return symbol__inc_addr_samples(&ams->ms, evsel, ams->al_addr, sample);
584}
585
586int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
587 struct evsel *evsel, u64 ip)
588{
589 return symbol__inc_addr_samples(&he->ms, evsel, ip, sample);
590}
591
592
593void annotation__exit(struct annotation *notes)
594{
595 annotated_source__delete(notes->src);
596 annotated_branch__delete(notes->branch);
597}
598
599static struct sharded_mutex *sharded_mutex;
600
601static void annotation__init_sharded_mutex(void)
602{
603 /* As many mutexes as there are CPUs. */
604 sharded_mutex = sharded_mutex__new(cpu__max_present_cpu().cpu);
605}
606
607static size_t annotation__hash(const struct annotation *notes)
608{
609 return (size_t)notes;
610}
611
612static struct mutex *annotation__get_mutex(const struct annotation *notes)
613{
614 static pthread_once_t once = PTHREAD_ONCE_INIT;
615
616 pthread_once(&once, annotation__init_sharded_mutex);
617 if (!sharded_mutex)
618 return NULL;
619
620 return sharded_mutex__get_mutex(sharded_mutex, annotation__hash(notes));
621}
622
623void annotation__lock(struct annotation *notes)
624 NO_THREAD_SAFETY_ANALYSIS
625{
626 struct mutex *mutex = annotation__get_mutex(notes);
627
628 if (mutex)
629 mutex_lock(mutex);
630}
631
632void annotation__unlock(struct annotation *notes)
633 NO_THREAD_SAFETY_ANALYSIS
634{
635 struct mutex *mutex = annotation__get_mutex(notes);
636
637 if (mutex)
638 mutex_unlock(mutex);
639}
640
641bool annotation__trylock(struct annotation *notes)
642{
643 struct mutex *mutex = annotation__get_mutex(notes);
644
645 if (!mutex)
646 return false;
647
648 return mutex_trylock(mutex);
649}
650
651void annotation_line__add(struct annotation_line *al, struct list_head *head)
652{
653 list_add_tail(&al->node, head);
654}
655
656struct annotation_line *
657annotation_line__next(struct annotation_line *pos, struct list_head *head)
658{
659 list_for_each_entry_continue(pos, head, node)
660 if (pos->offset >= 0)
661 return pos;
662
663 return NULL;
664}
665
666static const char *annotate__address_color(struct block_range *br)
667{
668 double cov = block_range__coverage(br);
669
670 if (cov >= 0) {
671 /* mark red for >75% coverage */
672 if (cov > 0.75)
673 return PERF_COLOR_RED;
674
675 /* mark dull for <1% coverage */
676 if (cov < 0.01)
677 return PERF_COLOR_NORMAL;
678 }
679
680 return PERF_COLOR_MAGENTA;
681}
682
683static const char *annotate__asm_color(struct block_range *br)
684{
685 double cov = block_range__coverage(br);
686
687 if (cov >= 0) {
688 /* mark dull for <1% coverage */
689 if (cov < 0.01)
690 return PERF_COLOR_NORMAL;
691 }
692
693 return PERF_COLOR_BLUE;
694}
695
696static void annotate__branch_printf(struct block_range *br, u64 addr)
697{
698 bool emit_comment = true;
699
700 if (!br)
701 return;
702
703#if 1
704 if (br->is_target && br->start == addr) {
705 struct block_range *branch = br;
706 double p;
707
708 /*
709 * Find matching branch to our target.
710 */
711 while (!branch->is_branch)
712 branch = block_range__next(branch);
713
714 p = 100 *(double)br->entry / branch->coverage;
715
716 if (p > 0.1) {
717 if (emit_comment) {
718 emit_comment = false;
719 printf("\t#");
720 }
721
722 /*
723 * The percentage of coverage joined at this target in relation
724 * to the next branch.
725 */
726 printf(" +%.2f%%", p);
727 }
728 }
729#endif
730 if (br->is_branch && br->end == addr) {
731 double p = 100*(double)br->taken / br->coverage;
732
733 if (p > 0.1) {
734 if (emit_comment) {
735 emit_comment = false;
736 printf("\t#");
737 }
738
739 /*
740 * The percentage of coverage leaving at this branch, and
741 * its prediction ratio.
742 */
743 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
744 }
745 }
746}
747
748static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
749{
750 s64 offset = dl->al.offset;
751 const u64 addr = start + offset;
752 struct block_range *br;
753
754 br = block_range__find(addr);
755 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
756 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
757 annotate__branch_printf(br, addr);
758 return 0;
759}
760
761static int
762annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
763 struct evsel *evsel, u64 len, int min_pcnt, int printed,
764 int max_lines, struct annotation_line *queue, int addr_fmt_width,
765 int percent_type)
766{
767 struct disasm_line *dl = container_of(al, struct disasm_line, al);
768 struct annotation *notes = symbol__annotation(sym);
769 static const char *prev_line;
770
771 if (al->offset != -1) {
772 double max_percent = 0.0;
773 int i, nr_percent = 1;
774 const char *color;
775
776 for (i = 0; i < al->data_nr; i++) {
777 double percent;
778
779 percent = annotation_data__percent(&al->data[i],
780 percent_type);
781
782 if (percent > max_percent)
783 max_percent = percent;
784 }
785
786 if (al->data_nr > nr_percent)
787 nr_percent = al->data_nr;
788
789 if (max_percent < min_pcnt)
790 return -1;
791
792 if (max_lines && printed >= max_lines)
793 return 1;
794
795 if (queue != NULL) {
796 list_for_each_entry_from(queue, ¬es->src->source, node) {
797 if (queue == al)
798 break;
799 annotation_line__print(queue, sym, start, evsel, len,
800 0, 0, 1, NULL, addr_fmt_width,
801 percent_type);
802 }
803 }
804
805 color = get_percent_color(max_percent);
806
807 for (i = 0; i < nr_percent; i++) {
808 struct annotation_data *data = &al->data[i];
809 double percent;
810
811 percent = annotation_data__percent(data, percent_type);
812 color = get_percent_color(percent);
813
814 if (symbol_conf.show_total_period)
815 color_fprintf(stdout, color, " %11" PRIu64,
816 data->he.period);
817 else if (symbol_conf.show_nr_samples)
818 color_fprintf(stdout, color, " %7" PRIu64,
819 data->he.nr_samples);
820 else
821 color_fprintf(stdout, color, " %7.2f", percent);
822 }
823
824 printf(" : ");
825
826 disasm_line__print(dl, start, addr_fmt_width);
827
828 /*
829 * Also color the filename and line if needed, with
830 * the same color than the percentage. Don't print it
831 * twice for close colored addr with the same filename:line
832 */
833 if (al->path) {
834 if (!prev_line || strcmp(prev_line, al->path)) {
835 color_fprintf(stdout, color, " // %s", al->path);
836 prev_line = al->path;
837 }
838 }
839
840 printf("\n");
841 } else if (max_lines && printed >= max_lines)
842 return 1;
843 else {
844 int width = annotation__pcnt_width(notes);
845
846 if (queue)
847 return -1;
848
849 if (!*al->line)
850 printf(" %*s:\n", width, " ");
851 else
852 printf(" %*s: %-*d %s\n", width, " ", addr_fmt_width, al->line_nr, al->line);
853 }
854
855 return 0;
856}
857
858static void calc_percent(struct annotation *notes,
859 struct evsel *evsel,
860 struct annotation_data *data,
861 s64 offset, s64 end)
862{
863 struct hists *hists = evsel__hists(evsel);
864 int evidx = evsel->core.idx;
865 struct sym_hist *sym_hist = annotation__histogram(notes, evidx);
866 unsigned int hits = 0;
867 u64 period = 0;
868
869 while (offset < end) {
870 struct sym_hist_entry *entry;
871
872 entry = annotated_source__hist_entry(notes->src, evidx, offset);
873 if (entry) {
874 hits += entry->nr_samples;
875 period += entry->period;
876 }
877 ++offset;
878 }
879
880 if (sym_hist->nr_samples) {
881 data->he.period = period;
882 data->he.nr_samples = hits;
883 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
884 }
885
886 if (hists->stats.nr_non_filtered_samples)
887 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
888
889 if (sym_hist->period)
890 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
891
892 if (hists->stats.total_period)
893 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
894}
895
896static void annotation__calc_percent(struct annotation *notes,
897 struct evsel *leader, s64 len)
898{
899 struct annotation_line *al, *next;
900 struct evsel *evsel;
901
902 list_for_each_entry(al, ¬es->src->source, node) {
903 s64 end;
904 int i = 0;
905
906 if (al->offset == -1)
907 continue;
908
909 next = annotation_line__next(al, ¬es->src->source);
910 end = next ? next->offset : len;
911
912 for_each_group_evsel(evsel, leader) {
913 struct annotation_data *data;
914
915 BUG_ON(i >= al->data_nr);
916
917 if (symbol_conf.skip_empty &&
918 evsel__hists(evsel)->stats.nr_samples == 0)
919 continue;
920
921 data = &al->data[i++];
922
923 calc_percent(notes, evsel, data, al->offset, end);
924 }
925 }
926}
927
928void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
929{
930 struct annotation *notes = symbol__annotation(sym);
931
932 annotation__calc_percent(notes, evsel, symbol__size(sym));
933}
934
935static int evsel__get_arch(struct evsel *evsel, struct arch **parch)
936{
937 struct perf_env *env = evsel__env(evsel);
938 const char *arch_name = perf_env__arch(env);
939 struct arch *arch;
940 int err;
941
942 if (!arch_name) {
943 *parch = NULL;
944 return errno;
945 }
946
947 *parch = arch = arch__find(arch_name);
948 if (arch == NULL) {
949 pr_err("%s: unsupported arch %s\n", __func__, arch_name);
950 return ENOTSUP;
951 }
952
953 if (arch->init) {
954 err = arch->init(arch, env ? env->cpuid : NULL);
955 if (err) {
956 pr_err("%s: failed to initialize %s arch priv area\n",
957 __func__, arch->name);
958 return err;
959 }
960 }
961 return 0;
962}
963
964int symbol__annotate(struct map_symbol *ms, struct evsel *evsel,
965 struct arch **parch)
966{
967 struct symbol *sym = ms->sym;
968 struct annotation *notes = symbol__annotation(sym);
969 struct annotate_args args = {
970 .evsel = evsel,
971 .options = &annotate_opts,
972 };
973 struct arch *arch = NULL;
974 int err, nr;
975
976 err = evsel__get_arch(evsel, &arch);
977 if (err < 0)
978 return err;
979
980 if (parch)
981 *parch = arch;
982
983 if (notes->src && !list_empty(¬es->src->source))
984 return 0;
985
986 args.arch = arch;
987 args.ms = *ms;
988
989 if (notes->src == NULL) {
990 notes->src = annotated_source__new();
991 if (notes->src == NULL)
992 return -1;
993 }
994
995 nr = 0;
996 if (evsel__is_group_event(evsel)) {
997 struct evsel *pos;
998
999 for_each_group_evsel(pos, evsel) {
1000 if (symbol_conf.skip_empty &&
1001 evsel__hists(pos)->stats.nr_samples == 0)
1002 continue;
1003 nr++;
1004 }
1005 }
1006 notes->src->nr_events = nr ? nr : 1;
1007
1008 if (annotate_opts.full_addr)
1009 notes->src->start = map__objdump_2mem(ms->map, ms->sym->start);
1010 else
1011 notes->src->start = map__rip_2objdump(ms->map, ms->sym->start);
1012
1013 return symbol__disassemble(sym, &args);
1014}
1015
1016static void insert_source_line(struct rb_root *root, struct annotation_line *al)
1017{
1018 struct annotation_line *iter;
1019 struct rb_node **p = &root->rb_node;
1020 struct rb_node *parent = NULL;
1021 unsigned int percent_type = annotate_opts.percent_type;
1022 int i, ret;
1023
1024 while (*p != NULL) {
1025 parent = *p;
1026 iter = rb_entry(parent, struct annotation_line, rb_node);
1027
1028 ret = strcmp(iter->path, al->path);
1029 if (ret == 0) {
1030 for (i = 0; i < al->data_nr; i++) {
1031 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
1032 percent_type);
1033 }
1034 return;
1035 }
1036
1037 if (ret < 0)
1038 p = &(*p)->rb_left;
1039 else
1040 p = &(*p)->rb_right;
1041 }
1042
1043 for (i = 0; i < al->data_nr; i++) {
1044 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
1045 percent_type);
1046 }
1047
1048 rb_link_node(&al->rb_node, parent, p);
1049 rb_insert_color(&al->rb_node, root);
1050}
1051
1052static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
1053{
1054 int i;
1055
1056 for (i = 0; i < a->data_nr; i++) {
1057 if (a->data[i].percent_sum == b->data[i].percent_sum)
1058 continue;
1059 return a->data[i].percent_sum > b->data[i].percent_sum;
1060 }
1061
1062 return 0;
1063}
1064
1065static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
1066{
1067 struct annotation_line *iter;
1068 struct rb_node **p = &root->rb_node;
1069 struct rb_node *parent = NULL;
1070
1071 while (*p != NULL) {
1072 parent = *p;
1073 iter = rb_entry(parent, struct annotation_line, rb_node);
1074
1075 if (cmp_source_line(al, iter))
1076 p = &(*p)->rb_left;
1077 else
1078 p = &(*p)->rb_right;
1079 }
1080
1081 rb_link_node(&al->rb_node, parent, p);
1082 rb_insert_color(&al->rb_node, root);
1083}
1084
1085static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
1086{
1087 struct annotation_line *al;
1088 struct rb_node *node;
1089
1090 node = rb_first(src_root);
1091 while (node) {
1092 struct rb_node *next;
1093
1094 al = rb_entry(node, struct annotation_line, rb_node);
1095 next = rb_next(node);
1096 rb_erase(node, src_root);
1097
1098 __resort_source_line(dest_root, al);
1099 node = next;
1100 }
1101}
1102
1103static void print_summary(struct rb_root *root, const char *filename)
1104{
1105 struct annotation_line *al;
1106 struct rb_node *node;
1107
1108 printf("\nSorted summary for file %s\n", filename);
1109 printf("----------------------------------------------\n\n");
1110
1111 if (RB_EMPTY_ROOT(root)) {
1112 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
1113 return;
1114 }
1115
1116 node = rb_first(root);
1117 while (node) {
1118 double percent, percent_max = 0.0;
1119 const char *color;
1120 char *path;
1121 int i;
1122
1123 al = rb_entry(node, struct annotation_line, rb_node);
1124 for (i = 0; i < al->data_nr; i++) {
1125 percent = al->data[i].percent_sum;
1126 color = get_percent_color(percent);
1127 color_fprintf(stdout, color, " %7.2f", percent);
1128
1129 if (percent > percent_max)
1130 percent_max = percent;
1131 }
1132
1133 path = al->path;
1134 color = get_percent_color(percent_max);
1135 color_fprintf(stdout, color, " %s\n", path);
1136
1137 node = rb_next(node);
1138 }
1139}
1140
1141static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
1142{
1143 int evidx = evsel->core.idx;
1144 struct annotation *notes = symbol__annotation(sym);
1145 struct sym_hist *h = annotation__histogram(notes, evidx);
1146 u64 len = symbol__size(sym), offset;
1147
1148 for (offset = 0; offset < len; ++offset) {
1149 struct sym_hist_entry *entry;
1150
1151 entry = annotated_source__hist_entry(notes->src, evidx, offset);
1152 if (entry && entry->nr_samples != 0)
1153 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
1154 sym->start + offset, entry->nr_samples);
1155 }
1156 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
1157}
1158
1159static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
1160{
1161 char bf[32];
1162 struct annotation_line *line;
1163
1164 list_for_each_entry_reverse(line, lines, node) {
1165 if (line->offset != -1)
1166 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
1167 }
1168
1169 return 0;
1170}
1171
1172int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel)
1173{
1174 struct map *map = ms->map;
1175 struct symbol *sym = ms->sym;
1176 struct dso *dso = map__dso(map);
1177 char *filename;
1178 const char *d_filename;
1179 const char *evsel_name = evsel__name(evsel);
1180 struct annotation *notes = symbol__annotation(sym);
1181 struct sym_hist *h = annotation__histogram(notes, evsel->core.idx);
1182 struct annotation_line *pos, *queue = NULL;
1183 struct annotation_options *opts = &annotate_opts;
1184 u64 start = map__rip_2objdump(map, sym->start);
1185 int printed = 2, queue_len = 0, addr_fmt_width;
1186 int more = 0;
1187 bool context = opts->context;
1188 u64 len;
1189 int width = annotation__pcnt_width(notes);
1190 int graph_dotted_len;
1191 char buf[512];
1192
1193 filename = strdup(dso__long_name(dso));
1194 if (!filename)
1195 return -ENOMEM;
1196
1197 if (opts->full_path)
1198 d_filename = filename;
1199 else
1200 d_filename = basename(filename);
1201
1202 len = symbol__size(sym);
1203
1204 if (evsel__is_group_event(evsel)) {
1205 evsel__group_desc(evsel, buf, sizeof(buf));
1206 evsel_name = buf;
1207 }
1208
1209 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
1210 "percent: %s)\n",
1211 width, width, symbol_conf.show_total_period ? "Period" :
1212 symbol_conf.show_nr_samples ? "Samples" : "Percent",
1213 d_filename, evsel_name, h->nr_samples,
1214 percent_type_str(opts->percent_type));
1215
1216 printf("%-*.*s----\n",
1217 graph_dotted_len, graph_dotted_len, graph_dotted_line);
1218
1219 if (verbose > 0)
1220 symbol__annotate_hits(sym, evsel);
1221
1222 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
1223
1224 list_for_each_entry(pos, ¬es->src->source, node) {
1225 int err;
1226
1227 if (context && queue == NULL) {
1228 queue = pos;
1229 queue_len = 0;
1230 }
1231
1232 err = annotation_line__print(pos, sym, start, evsel, len,
1233 opts->min_pcnt, printed, opts->max_lines,
1234 queue, addr_fmt_width, opts->percent_type);
1235
1236 switch (err) {
1237 case 0:
1238 ++printed;
1239 if (context) {
1240 printed += queue_len;
1241 queue = NULL;
1242 queue_len = 0;
1243 }
1244 break;
1245 case 1:
1246 /* filtered by max_lines */
1247 ++more;
1248 break;
1249 case -1:
1250 default:
1251 /*
1252 * Filtered by min_pcnt or non IP lines when
1253 * context != 0
1254 */
1255 if (!context)
1256 break;
1257 if (queue_len == context)
1258 queue = list_entry(queue->node.next, typeof(*queue), node);
1259 else
1260 ++queue_len;
1261 break;
1262 }
1263 }
1264
1265 free(filename);
1266
1267 return more;
1268}
1269
1270static void FILE__set_percent_color(void *fp __maybe_unused,
1271 double percent __maybe_unused,
1272 bool current __maybe_unused)
1273{
1274}
1275
1276static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
1277 int nr __maybe_unused, bool current __maybe_unused)
1278{
1279 return 0;
1280}
1281
1282static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
1283{
1284 return 0;
1285}
1286
1287static void FILE__printf(void *fp, const char *fmt, ...)
1288{
1289 va_list args;
1290
1291 va_start(args, fmt);
1292 vfprintf(fp, fmt, args);
1293 va_end(args);
1294}
1295
1296static void FILE__write_graph(void *fp, int graph)
1297{
1298 const char *s;
1299 switch (graph) {
1300
1301 case DARROW_CHAR: s = "↓"; break;
1302 case UARROW_CHAR: s = "↑"; break;
1303 case LARROW_CHAR: s = "←"; break;
1304 case RARROW_CHAR: s = "→"; break;
1305 default: s = "?"; break;
1306 }
1307
1308 fputs(s, fp);
1309}
1310
1311static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp)
1312{
1313 struct annotation *notes = symbol__annotation(sym);
1314 struct annotation_write_ops wops = {
1315 .first_line = true,
1316 .obj = fp,
1317 .set_color = FILE__set_color,
1318 .set_percent_color = FILE__set_percent_color,
1319 .set_jumps_percent_color = FILE__set_jumps_percent_color,
1320 .printf = FILE__printf,
1321 .write_graph = FILE__write_graph,
1322 };
1323 struct annotation_line *al;
1324
1325 list_for_each_entry(al, ¬es->src->source, node) {
1326 if (annotation_line__filter(al))
1327 continue;
1328 annotation_line__write(al, notes, &wops);
1329 fputc('\n', fp);
1330 wops.first_line = false;
1331 }
1332
1333 return 0;
1334}
1335
1336int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel)
1337{
1338 const char *ev_name = evsel__name(evsel);
1339 char buf[1024];
1340 char *filename;
1341 int err = -1;
1342 FILE *fp;
1343
1344 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
1345 return -1;
1346
1347 fp = fopen(filename, "w");
1348 if (fp == NULL)
1349 goto out_free_filename;
1350
1351 if (evsel__is_group_event(evsel)) {
1352 evsel__group_desc(evsel, buf, sizeof(buf));
1353 ev_name = buf;
1354 }
1355
1356 fprintf(fp, "%s() %s\nEvent: %s\n\n",
1357 ms->sym->name, dso__long_name(map__dso(ms->map)), ev_name);
1358 symbol__annotate_fprintf2(ms->sym, fp);
1359
1360 fclose(fp);
1361 err = 0;
1362out_free_filename:
1363 free(filename);
1364 return err;
1365}
1366
1367void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
1368{
1369 struct annotation *notes = symbol__annotation(sym);
1370 struct sym_hist *h = annotation__histogram(notes, evidx);
1371
1372 memset(h, 0, sizeof(*notes->src->histograms) * notes->src->nr_histograms);
1373}
1374
1375void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
1376{
1377 struct annotation *notes = symbol__annotation(sym);
1378 struct sym_hist *h = annotation__histogram(notes, evidx);
1379 struct annotation_line *al;
1380
1381 h->nr_samples = 0;
1382 list_for_each_entry(al, ¬es->src->source, node) {
1383 struct sym_hist_entry *entry;
1384
1385 if (al->offset == -1)
1386 continue;
1387
1388 entry = annotated_source__hist_entry(notes->src, evidx, al->offset);
1389 if (entry == NULL)
1390 continue;
1391
1392 entry->nr_samples = entry->nr_samples * 7 / 8;
1393 h->nr_samples += entry->nr_samples;
1394 }
1395}
1396
1397void annotated_source__purge(struct annotated_source *as)
1398{
1399 struct annotation_line *al, *n;
1400
1401 list_for_each_entry_safe(al, n, &as->source, node) {
1402 list_del_init(&al->node);
1403 disasm_line__free(disasm_line(al));
1404 }
1405}
1406
1407static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
1408{
1409 size_t printed;
1410
1411 if (dl->al.offset == -1)
1412 return fprintf(fp, "%s\n", dl->al.line);
1413
1414 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
1415
1416 if (dl->ops.raw[0] != '\0') {
1417 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
1418 dl->ops.raw);
1419 }
1420
1421 return printed + fprintf(fp, "\n");
1422}
1423
1424size_t disasm__fprintf(struct list_head *head, FILE *fp)
1425{
1426 struct disasm_line *pos;
1427 size_t printed = 0;
1428
1429 list_for_each_entry(pos, head, al.node)
1430 printed += disasm_line__fprintf(pos, fp);
1431
1432 return printed;
1433}
1434
1435bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
1436{
1437 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
1438 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
1439 dl->ops.target.offset >= (s64)symbol__size(sym))
1440 return false;
1441
1442 return true;
1443}
1444
1445static void
1446annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
1447{
1448 struct annotation_line *al;
1449
1450 /* PLT symbols contain external offsets */
1451 if (strstr(sym->name, "@plt"))
1452 return;
1453
1454 list_for_each_entry(al, ¬es->src->source, node) {
1455 struct disasm_line *dl;
1456 struct annotation_line *target;
1457
1458 dl = disasm_line(al);
1459
1460 if (!disasm_line__is_valid_local_jump(dl, sym))
1461 continue;
1462
1463 target = annotated_source__get_line(notes->src,
1464 dl->ops.target.offset);
1465 /*
1466 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
1467 * have to adjust to the previous offset?
1468 */
1469 if (target == NULL)
1470 continue;
1471
1472 if (++target->jump_sources > notes->src->max_jump_sources)
1473 notes->src->max_jump_sources = target->jump_sources;
1474 }
1475}
1476
1477static void annotation__set_index(struct annotation *notes)
1478{
1479 struct annotation_line *al;
1480 struct annotated_source *src = notes->src;
1481
1482 src->widths.max_line_len = 0;
1483 src->nr_entries = 0;
1484 src->nr_asm_entries = 0;
1485
1486 list_for_each_entry(al, &src->source, node) {
1487 size_t line_len = strlen(al->line);
1488
1489 if (src->widths.max_line_len < line_len)
1490 src->widths.max_line_len = line_len;
1491 al->idx = src->nr_entries++;
1492 if (al->offset != -1)
1493 al->idx_asm = src->nr_asm_entries++;
1494 else
1495 al->idx_asm = -1;
1496 }
1497}
1498
1499static inline int width_jumps(int n)
1500{
1501 if (n >= 100)
1502 return 5;
1503 if (n / 10)
1504 return 2;
1505 return 1;
1506}
1507
1508static int annotation__max_ins_name(struct annotation *notes)
1509{
1510 int max_name = 0, len;
1511 struct annotation_line *al;
1512
1513 list_for_each_entry(al, ¬es->src->source, node) {
1514 if (al->offset == -1)
1515 continue;
1516
1517 len = strlen(disasm_line(al)->ins.name);
1518 if (max_name < len)
1519 max_name = len;
1520 }
1521
1522 return max_name;
1523}
1524
1525static void
1526annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
1527{
1528 notes->src->widths.addr = notes->src->widths.target =
1529 notes->src->widths.min_addr = hex_width(symbol__size(sym));
1530 notes->src->widths.max_addr = hex_width(sym->end);
1531 notes->src->widths.jumps = width_jumps(notes->src->max_jump_sources);
1532 notes->src->widths.max_ins_name = annotation__max_ins_name(notes);
1533}
1534
1535void annotation__update_column_widths(struct annotation *notes)
1536{
1537 if (annotate_opts.use_offset)
1538 notes->src->widths.target = notes->src->widths.min_addr;
1539 else if (annotate_opts.full_addr)
1540 notes->src->widths.target = BITS_PER_LONG / 4;
1541 else
1542 notes->src->widths.target = notes->src->widths.max_addr;
1543
1544 notes->src->widths.addr = notes->src->widths.target;
1545
1546 if (annotate_opts.show_nr_jumps)
1547 notes->src->widths.addr += notes->src->widths.jumps + 1;
1548}
1549
1550void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms)
1551{
1552 annotate_opts.full_addr = !annotate_opts.full_addr;
1553
1554 if (annotate_opts.full_addr)
1555 notes->src->start = map__objdump_2mem(ms->map, ms->sym->start);
1556 else
1557 notes->src->start = map__rip_2objdump(ms->map, ms->sym->start);
1558
1559 annotation__update_column_widths(notes);
1560}
1561
1562static void annotation__calc_lines(struct annotation *notes, struct map_symbol *ms,
1563 struct rb_root *root)
1564{
1565 struct annotation_line *al;
1566 struct rb_root tmp_root = RB_ROOT;
1567
1568 list_for_each_entry(al, ¬es->src->source, node) {
1569 double percent_max = 0.0;
1570 u64 addr;
1571 int i;
1572
1573 for (i = 0; i < al->data_nr; i++) {
1574 double percent;
1575
1576 percent = annotation_data__percent(&al->data[i],
1577 annotate_opts.percent_type);
1578
1579 if (percent > percent_max)
1580 percent_max = percent;
1581 }
1582
1583 if (percent_max <= 0.5)
1584 continue;
1585
1586 addr = map__rip_2objdump(ms->map, ms->sym->start);
1587 al->path = get_srcline(map__dso(ms->map), addr + al->offset, NULL,
1588 false, true, ms->sym->start + al->offset);
1589 insert_source_line(&tmp_root, al);
1590 }
1591
1592 resort_source_line(root, &tmp_root);
1593}
1594
1595static void symbol__calc_lines(struct map_symbol *ms, struct rb_root *root)
1596{
1597 struct annotation *notes = symbol__annotation(ms->sym);
1598
1599 annotation__calc_lines(notes, ms, root);
1600}
1601
1602int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel)
1603{
1604 struct dso *dso = map__dso(ms->map);
1605 struct symbol *sym = ms->sym;
1606 struct rb_root source_line = RB_ROOT;
1607 struct hists *hists = evsel__hists(evsel);
1608 char buf[1024];
1609 int err;
1610
1611 err = symbol__annotate2(ms, evsel, NULL);
1612 if (err) {
1613 char msg[BUFSIZ];
1614
1615 dso__set_annotate_warned(dso);
1616 symbol__strerror_disassemble(ms, err, msg, sizeof(msg));
1617 ui__error("Couldn't annotate %s:\n%s", sym->name, msg);
1618 return -1;
1619 }
1620
1621 if (annotate_opts.print_lines) {
1622 srcline_full_filename = annotate_opts.full_path;
1623 symbol__calc_lines(ms, &source_line);
1624 print_summary(&source_line, dso__long_name(dso));
1625 }
1626
1627 hists__scnprintf_title(hists, buf, sizeof(buf));
1628 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
1629 buf, percent_type_str(annotate_opts.percent_type), sym->name, dso__long_name(dso));
1630 symbol__annotate_fprintf2(sym, stdout);
1631
1632 annotated_source__purge(symbol__annotation(sym)->src);
1633
1634 return 0;
1635}
1636
1637int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel)
1638{
1639 struct dso *dso = map__dso(ms->map);
1640 struct symbol *sym = ms->sym;
1641 struct rb_root source_line = RB_ROOT;
1642 int err;
1643
1644 err = symbol__annotate(ms, evsel, NULL);
1645 if (err) {
1646 char msg[BUFSIZ];
1647
1648 dso__set_annotate_warned(dso);
1649 symbol__strerror_disassemble(ms, err, msg, sizeof(msg));
1650 ui__error("Couldn't annotate %s:\n%s", sym->name, msg);
1651 return -1;
1652 }
1653
1654 symbol__calc_percent(sym, evsel);
1655
1656 if (annotate_opts.print_lines) {
1657 srcline_full_filename = annotate_opts.full_path;
1658 symbol__calc_lines(ms, &source_line);
1659 print_summary(&source_line, dso__long_name(dso));
1660 }
1661
1662 symbol__annotate_printf(ms, evsel);
1663
1664 annotated_source__purge(symbol__annotation(sym)->src);
1665
1666 return 0;
1667}
1668
1669bool ui__has_annotation(void)
1670{
1671 return use_browser == 1 && perf_hpp_list.sym;
1672}
1673
1674
1675static double annotation_line__max_percent(struct annotation_line *al,
1676 unsigned int percent_type)
1677{
1678 double percent_max = 0.0;
1679 int i;
1680
1681 for (i = 0; i < al->data_nr; i++) {
1682 double percent;
1683
1684 percent = annotation_data__percent(&al->data[i],
1685 percent_type);
1686
1687 if (percent > percent_max)
1688 percent_max = percent;
1689 }
1690
1691 return percent_max;
1692}
1693
1694static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
1695 void *obj, char *bf, size_t size,
1696 void (*obj__printf)(void *obj, const char *fmt, ...),
1697 void (*obj__write_graph)(void *obj, int graph))
1698{
1699 if (dl->ins.ops && dl->ins.ops->scnprintf) {
1700 if (ins__is_jump(&dl->ins)) {
1701 bool fwd;
1702
1703 if (dl->ops.target.outside)
1704 goto call_like;
1705 fwd = dl->ops.target.offset > dl->al.offset;
1706 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
1707 obj__printf(obj, " ");
1708 } else if (ins__is_call(&dl->ins)) {
1709call_like:
1710 obj__write_graph(obj, RARROW_CHAR);
1711 obj__printf(obj, " ");
1712 } else if (ins__is_ret(&dl->ins)) {
1713 obj__write_graph(obj, LARROW_CHAR);
1714 obj__printf(obj, " ");
1715 } else {
1716 obj__printf(obj, " ");
1717 }
1718 } else {
1719 obj__printf(obj, " ");
1720 }
1721
1722 disasm_line__scnprintf(dl, bf, size, !annotate_opts.use_offset,
1723 notes->src->widths.max_ins_name);
1724}
1725
1726static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
1727{
1728 double ipc = 0.0, coverage = 0.0;
1729 struct annotated_branch *branch = annotation__get_branch(notes);
1730
1731 if (branch && branch->hit_cycles)
1732 ipc = branch->hit_insn / ((double)branch->hit_cycles);
1733
1734 if (branch && branch->total_insn) {
1735 coverage = branch->cover_insn * 100.0 /
1736 ((double)branch->total_insn);
1737 }
1738
1739 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
1740 ipc, coverage);
1741}
1742
1743int annotation_br_cntr_abbr_list(char **str, struct evsel *evsel, bool header)
1744{
1745 struct evsel *pos;
1746 struct strbuf sb;
1747
1748 if (evsel->evlist->nr_br_cntr <= 0)
1749 return -ENOTSUP;
1750
1751 strbuf_init(&sb, /*hint=*/ 0);
1752
1753 if (header && strbuf_addf(&sb, "# Branch counter abbr list:\n"))
1754 goto err;
1755
1756 evlist__for_each_entry(evsel->evlist, pos) {
1757 if (!(pos->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_COUNTERS))
1758 continue;
1759 if (header && strbuf_addf(&sb, "#"))
1760 goto err;
1761
1762 if (strbuf_addf(&sb, " %s = %s\n", pos->name, pos->abbr_name))
1763 goto err;
1764 }
1765
1766 if (header && strbuf_addf(&sb, "#"))
1767 goto err;
1768 if (strbuf_addf(&sb, " '-' No event occurs\n"))
1769 goto err;
1770
1771 if (header && strbuf_addf(&sb, "#"))
1772 goto err;
1773 if (strbuf_addf(&sb, " '+' Event occurrences may be lost due to branch counter saturated\n"))
1774 goto err;
1775
1776 *str = strbuf_detach(&sb, NULL);
1777
1778 return 0;
1779err:
1780 strbuf_release(&sb);
1781 return -ENOMEM;
1782}
1783
1784/* Assume the branch counter saturated at 3 */
1785#define ANNOTATION_BR_CNTR_SATURATION 3
1786
1787int annotation_br_cntr_entry(char **str, int br_cntr_nr,
1788 u64 *br_cntr, int num_aggr,
1789 struct evsel *evsel)
1790{
1791 struct evsel *pos = evsel ? evlist__first(evsel->evlist) : NULL;
1792 bool saturated = false;
1793 int i, j, avg, used;
1794 struct strbuf sb;
1795
1796 strbuf_init(&sb, /*hint=*/ 0);
1797 for (i = 0; i < br_cntr_nr; i++) {
1798 used = 0;
1799 avg = ceil((double)(br_cntr[i] & ~ANNOTATION__BR_CNTR_SATURATED_FLAG) /
1800 (double)num_aggr);
1801
1802 /*
1803 * A histogram with the abbr name is displayed by default.
1804 * With -v, the exact number of branch counter is displayed.
1805 */
1806 if (verbose) {
1807 evlist__for_each_entry_from(evsel->evlist, pos) {
1808 if ((pos->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_COUNTERS) &&
1809 (pos->br_cntr_idx == i))
1810 break;
1811 }
1812 if (strbuf_addstr(&sb, pos->abbr_name))
1813 goto err;
1814
1815 if (!br_cntr[i]) {
1816 if (strbuf_addstr(&sb, "=-"))
1817 goto err;
1818 } else {
1819 if (strbuf_addf(&sb, "=%d", avg))
1820 goto err;
1821 }
1822 if (br_cntr[i] & ANNOTATION__BR_CNTR_SATURATED_FLAG) {
1823 if (strbuf_addch(&sb, '+'))
1824 goto err;
1825 } else {
1826 if (strbuf_addch(&sb, ' '))
1827 goto err;
1828 }
1829
1830 if ((i < br_cntr_nr - 1) && strbuf_addch(&sb, ','))
1831 goto err;
1832 continue;
1833 }
1834
1835 if (strbuf_addch(&sb, '|'))
1836 goto err;
1837
1838 if (!br_cntr[i]) {
1839 if (strbuf_addch(&sb, '-'))
1840 goto err;
1841 used++;
1842 } else {
1843 evlist__for_each_entry_from(evsel->evlist, pos) {
1844 if ((pos->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_COUNTERS) &&
1845 (pos->br_cntr_idx == i))
1846 break;
1847 }
1848 if (br_cntr[i] & ANNOTATION__BR_CNTR_SATURATED_FLAG)
1849 saturated = true;
1850
1851 for (j = 0; j < avg; j++, used++) {
1852 /* Print + if the number of logged events > 3 */
1853 if (j >= ANNOTATION_BR_CNTR_SATURATION) {
1854 saturated = true;
1855 break;
1856 }
1857 if (strbuf_addstr(&sb, pos->abbr_name))
1858 goto err;
1859 }
1860
1861 if (saturated) {
1862 if (strbuf_addch(&sb, '+'))
1863 goto err;
1864 used++;
1865 }
1866 pos = list_next_entry(pos, core.node);
1867 }
1868
1869 for (j = used; j < ANNOTATION_BR_CNTR_SATURATION + 1; j++) {
1870 if (strbuf_addch(&sb, ' '))
1871 goto err;
1872 }
1873 }
1874
1875 if (!verbose && strbuf_addch(&sb, br_cntr_nr ? '|' : ' '))
1876 goto err;
1877
1878 *str = strbuf_detach(&sb, NULL);
1879
1880 return 0;
1881err:
1882 strbuf_release(&sb);
1883 return -ENOMEM;
1884}
1885
1886static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
1887 bool first_line, bool current_entry, bool change_color, int width,
1888 void *obj, unsigned int percent_type,
1889 int (*obj__set_color)(void *obj, int color),
1890 void (*obj__set_percent_color)(void *obj, double percent, bool current),
1891 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
1892 void (*obj__printf)(void *obj, const char *fmt, ...),
1893 void (*obj__write_graph)(void *obj, int graph))
1894
1895{
1896 double percent_max = annotation_line__max_percent(al, percent_type);
1897 int pcnt_width = annotation__pcnt_width(notes),
1898 cycles_width = annotation__cycles_width(notes);
1899 bool show_title = false;
1900 char bf[256];
1901 int printed;
1902
1903 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
1904 if (notes->branch && al->cycles) {
1905 if (al->cycles->ipc == 0.0 && al->cycles->avg == 0)
1906 show_title = true;
1907 } else
1908 show_title = true;
1909 }
1910
1911 if (al->offset != -1 && percent_max != 0.0) {
1912 int i;
1913
1914 for (i = 0; i < al->data_nr; i++) {
1915 double percent;
1916
1917 percent = annotation_data__percent(&al->data[i], percent_type);
1918
1919 obj__set_percent_color(obj, percent, current_entry);
1920 if (symbol_conf.show_total_period) {
1921 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
1922 } else if (symbol_conf.show_nr_samples) {
1923 obj__printf(obj, "%7" PRIu64 " ",
1924 al->data[i].he.nr_samples);
1925 } else {
1926 obj__printf(obj, "%7.2f ", percent);
1927 }
1928 }
1929 } else {
1930 obj__set_percent_color(obj, 0, current_entry);
1931
1932 if (!show_title)
1933 obj__printf(obj, "%-*s", pcnt_width, " ");
1934 else {
1935 obj__printf(obj, "%-*s", pcnt_width,
1936 symbol_conf.show_total_period ? "Period" :
1937 symbol_conf.show_nr_samples ? "Samples" : "Percent");
1938 }
1939 }
1940
1941 if (notes->branch) {
1942 if (al->cycles && al->cycles->ipc)
1943 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->cycles->ipc);
1944 else if (!show_title)
1945 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
1946 else
1947 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
1948
1949 if (!annotate_opts.show_minmax_cycle) {
1950 if (al->cycles && al->cycles->avg)
1951 obj__printf(obj, "%*" PRIu64 " ",
1952 ANNOTATION__CYCLES_WIDTH - 1, al->cycles->avg);
1953 else if (!show_title)
1954 obj__printf(obj, "%*s",
1955 ANNOTATION__CYCLES_WIDTH, " ");
1956 else
1957 obj__printf(obj, "%*s ",
1958 ANNOTATION__CYCLES_WIDTH - 1,
1959 "Cycle");
1960 } else {
1961 if (al->cycles) {
1962 char str[32];
1963
1964 scnprintf(str, sizeof(str),
1965 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
1966 al->cycles->avg, al->cycles->min,
1967 al->cycles->max);
1968
1969 obj__printf(obj, "%*s ",
1970 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
1971 str);
1972 } else if (!show_title)
1973 obj__printf(obj, "%*s",
1974 ANNOTATION__MINMAX_CYCLES_WIDTH,
1975 " ");
1976 else
1977 obj__printf(obj, "%*s ",
1978 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
1979 "Cycle(min/max)");
1980 }
1981
1982 if (annotate_opts.show_br_cntr) {
1983 if (show_title) {
1984 obj__printf(obj, "%*s ",
1985 ANNOTATION__BR_CNTR_WIDTH,
1986 "Branch Counter");
1987 } else {
1988 char *buf;
1989
1990 if (!annotation_br_cntr_entry(&buf, al->br_cntr_nr, al->br_cntr,
1991 al->num_aggr, al->evsel)) {
1992 obj__printf(obj, "%*s ", ANNOTATION__BR_CNTR_WIDTH, buf);
1993 free(buf);
1994 }
1995 }
1996 }
1997
1998 if (show_title && !*al->line) {
1999 ipc_coverage_string(bf, sizeof(bf), notes);
2000 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2001 }
2002 }
2003
2004 obj__printf(obj, " ");
2005
2006 if (!*al->line)
2007 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
2008 else if (al->offset == -1) {
2009 if (al->line_nr && annotate_opts.show_linenr)
2010 printed = scnprintf(bf, sizeof(bf), "%-*d ",
2011 notes->src->widths.addr + 1, al->line_nr);
2012 else
2013 printed = scnprintf(bf, sizeof(bf), "%-*s ",
2014 notes->src->widths.addr, " ");
2015 obj__printf(obj, bf);
2016 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
2017 } else {
2018 u64 addr = al->offset;
2019 int color = -1;
2020
2021 if (!annotate_opts.use_offset)
2022 addr += notes->src->start;
2023
2024 if (!annotate_opts.use_offset) {
2025 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
2026 } else {
2027 if (al->jump_sources &&
2028 annotate_opts.offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
2029 if (annotate_opts.show_nr_jumps) {
2030 int prev;
2031 printed = scnprintf(bf, sizeof(bf), "%*d ",
2032 notes->src->widths.jumps,
2033 al->jump_sources);
2034 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
2035 current_entry);
2036 obj__printf(obj, bf);
2037 obj__set_color(obj, prev);
2038 }
2039print_addr:
2040 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
2041 notes->src->widths.target, addr);
2042 } else if (ins__is_call(&disasm_line(al)->ins) &&
2043 annotate_opts.offset_level >= ANNOTATION__OFFSET_CALL) {
2044 goto print_addr;
2045 } else if (annotate_opts.offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
2046 goto print_addr;
2047 } else {
2048 printed = scnprintf(bf, sizeof(bf), "%-*s ",
2049 notes->src->widths.addr, " ");
2050 }
2051 }
2052
2053 if (change_color)
2054 color = obj__set_color(obj, HE_COLORSET_ADDR);
2055 obj__printf(obj, bf);
2056 if (change_color)
2057 obj__set_color(obj, color);
2058
2059 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
2060
2061 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
2062 }
2063
2064}
2065
2066void annotation_line__write(struct annotation_line *al, struct annotation *notes,
2067 struct annotation_write_ops *wops)
2068{
2069 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
2070 wops->change_color, wops->width, wops->obj,
2071 annotate_opts.percent_type,
2072 wops->set_color, wops->set_percent_color,
2073 wops->set_jumps_percent_color, wops->printf,
2074 wops->write_graph);
2075}
2076
2077int symbol__annotate2(struct map_symbol *ms, struct evsel *evsel,
2078 struct arch **parch)
2079{
2080 struct symbol *sym = ms->sym;
2081 struct annotation *notes = symbol__annotation(sym);
2082 size_t size = symbol__size(sym);
2083 int err;
2084
2085 err = symbol__annotate(ms, evsel, parch);
2086 if (err)
2087 return err;
2088
2089 symbol__calc_percent(sym, evsel);
2090
2091 annotation__set_index(notes);
2092 annotation__mark_jump_targets(notes, sym);
2093
2094 err = annotation__compute_ipc(notes, size, evsel);
2095 if (err)
2096 return err;
2097
2098 annotation__init_column_widths(notes, sym);
2099 annotation__update_column_widths(notes);
2100 sym->annotate2 = 1;
2101
2102 return 0;
2103}
2104
2105const char * const perf_disassembler__strs[] = {
2106 [PERF_DISASM_UNKNOWN] = "unknown",
2107 [PERF_DISASM_LLVM] = "llvm",
2108 [PERF_DISASM_CAPSTONE] = "capstone",
2109 [PERF_DISASM_OBJDUMP] = "objdump",
2110};
2111
2112
2113static void annotation_options__add_disassembler(struct annotation_options *options,
2114 enum perf_disassembler dis)
2115{
2116 for (u8 i = 0; i < ARRAY_SIZE(options->disassemblers); i++) {
2117 if (options->disassemblers[i] == dis) {
2118 /* Disassembler is already present then don't add again. */
2119 return;
2120 }
2121 if (options->disassemblers[i] == PERF_DISASM_UNKNOWN) {
2122 /* Found a free slot. */
2123 options->disassemblers[i] = dis;
2124 return;
2125 }
2126 }
2127 pr_err("Failed to add disassembler %d\n", dis);
2128}
2129
2130static int annotation_options__add_disassemblers_str(struct annotation_options *options,
2131 const char *str)
2132{
2133 while (str && *str != '\0') {
2134 const char *comma = strchr(str, ',');
2135 int len = comma ? comma - str : (int)strlen(str);
2136 bool match = false;
2137
2138 for (u8 i = 0; i < ARRAY_SIZE(perf_disassembler__strs); i++) {
2139 const char *dis_str = perf_disassembler__strs[i];
2140
2141 if (len == (int)strlen(dis_str) && !strncmp(str, dis_str, len)) {
2142 annotation_options__add_disassembler(options, i);
2143 match = true;
2144 break;
2145 }
2146 }
2147 if (!match) {
2148 pr_err("Invalid disassembler '%.*s'\n", len, str);
2149 return -1;
2150 }
2151 str = comma ? comma + 1 : NULL;
2152 }
2153 return 0;
2154}
2155
2156static int annotation__config(const char *var, const char *value, void *data)
2157{
2158 struct annotation_options *opt = data;
2159
2160 if (!strstarts(var, "annotate."))
2161 return 0;
2162
2163 if (!strcmp(var, "annotate.offset_level")) {
2164 perf_config_u8(&opt->offset_level, "offset_level", value);
2165
2166 if (opt->offset_level > ANNOTATION__MAX_OFFSET_LEVEL)
2167 opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
2168 else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
2169 opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
2170 } else if (!strcmp(var, "annotate.disassemblers")) {
2171 int err = annotation_options__add_disassemblers_str(opt, value);
2172
2173 if (err)
2174 return err;
2175 } else if (!strcmp(var, "annotate.hide_src_code")) {
2176 opt->hide_src_code = perf_config_bool("hide_src_code", value);
2177 } else if (!strcmp(var, "annotate.jump_arrows")) {
2178 opt->jump_arrows = perf_config_bool("jump_arrows", value);
2179 } else if (!strcmp(var, "annotate.show_linenr")) {
2180 opt->show_linenr = perf_config_bool("show_linenr", value);
2181 } else if (!strcmp(var, "annotate.show_nr_jumps")) {
2182 opt->show_nr_jumps = perf_config_bool("show_nr_jumps", value);
2183 } else if (!strcmp(var, "annotate.show_nr_samples")) {
2184 symbol_conf.show_nr_samples = perf_config_bool("show_nr_samples",
2185 value);
2186 } else if (!strcmp(var, "annotate.show_total_period")) {
2187 symbol_conf.show_total_period = perf_config_bool("show_total_period",
2188 value);
2189 } else if (!strcmp(var, "annotate.use_offset")) {
2190 opt->use_offset = perf_config_bool("use_offset", value);
2191 } else if (!strcmp(var, "annotate.disassembler_style")) {
2192 opt->disassembler_style = strdup(value);
2193 if (!opt->disassembler_style) {
2194 pr_err("Not enough memory for annotate.disassembler_style\n");
2195 return -1;
2196 }
2197 } else if (!strcmp(var, "annotate.objdump")) {
2198 opt->objdump_path = strdup(value);
2199 if (!opt->objdump_path) {
2200 pr_err("Not enough memory for annotate.objdump\n");
2201 return -1;
2202 }
2203 } else if (!strcmp(var, "annotate.addr2line")) {
2204 symbol_conf.addr2line_path = strdup(value);
2205 if (!symbol_conf.addr2line_path) {
2206 pr_err("Not enough memory for annotate.addr2line\n");
2207 return -1;
2208 }
2209 } else if (!strcmp(var, "annotate.demangle")) {
2210 symbol_conf.demangle = perf_config_bool("demangle", value);
2211 } else if (!strcmp(var, "annotate.demangle_kernel")) {
2212 symbol_conf.demangle_kernel = perf_config_bool("demangle_kernel", value);
2213 } else {
2214 pr_debug("%s variable unknown, ignoring...", var);
2215 }
2216
2217 return 0;
2218}
2219
2220void annotation_options__init(void)
2221{
2222 struct annotation_options *opt = &annotate_opts;
2223
2224 memset(opt, 0, sizeof(*opt));
2225
2226 /* Default values. */
2227 opt->use_offset = true;
2228 opt->jump_arrows = true;
2229 opt->annotate_src = true;
2230 opt->offset_level = ANNOTATION__OFFSET_JUMP_TARGETS;
2231 opt->percent_type = PERCENT_PERIOD_LOCAL;
2232}
2233
2234void annotation_options__exit(void)
2235{
2236 zfree(&annotate_opts.disassembler_style);
2237 zfree(&annotate_opts.objdump_path);
2238}
2239
2240static void annotation_options__default_init_disassemblers(struct annotation_options *options)
2241{
2242 if (options->disassemblers[0] != PERF_DISASM_UNKNOWN) {
2243 /* Already initialized. */
2244 return;
2245 }
2246#ifdef HAVE_LIBLLVM_SUPPORT
2247 annotation_options__add_disassembler(options, PERF_DISASM_LLVM);
2248#endif
2249#ifdef HAVE_LIBCAPSTONE_SUPPORT
2250 annotation_options__add_disassembler(options, PERF_DISASM_CAPSTONE);
2251#endif
2252 annotation_options__add_disassembler(options, PERF_DISASM_OBJDUMP);
2253}
2254
2255void annotation_config__init(void)
2256{
2257 perf_config(annotation__config, &annotate_opts);
2258 annotation_options__default_init_disassemblers(&annotate_opts);
2259}
2260
2261static unsigned int parse_percent_type(char *str1, char *str2)
2262{
2263 unsigned int type = (unsigned int) -1;
2264
2265 if (!strcmp("period", str1)) {
2266 if (!strcmp("local", str2))
2267 type = PERCENT_PERIOD_LOCAL;
2268 else if (!strcmp("global", str2))
2269 type = PERCENT_PERIOD_GLOBAL;
2270 }
2271
2272 if (!strcmp("hits", str1)) {
2273 if (!strcmp("local", str2))
2274 type = PERCENT_HITS_LOCAL;
2275 else if (!strcmp("global", str2))
2276 type = PERCENT_HITS_GLOBAL;
2277 }
2278
2279 return type;
2280}
2281
2282int annotate_parse_percent_type(const struct option *opt __maybe_unused, const char *_str,
2283 int unset __maybe_unused)
2284{
2285 unsigned int type;
2286 char *str1, *str2;
2287 int err = -1;
2288
2289 str1 = strdup(_str);
2290 if (!str1)
2291 return -ENOMEM;
2292
2293 str2 = strchr(str1, '-');
2294 if (!str2)
2295 goto out;
2296
2297 *str2++ = 0;
2298
2299 type = parse_percent_type(str1, str2);
2300 if (type == (unsigned int) -1)
2301 type = parse_percent_type(str2, str1);
2302 if (type != (unsigned int) -1) {
2303 annotate_opts.percent_type = type;
2304 err = 0;
2305 }
2306
2307out:
2308 free(str1);
2309 return err;
2310}
2311
2312int annotate_check_args(void)
2313{
2314 struct annotation_options *args = &annotate_opts;
2315
2316 if (args->prefix_strip && !args->prefix) {
2317 pr_err("--prefix-strip requires --prefix\n");
2318 return -1;
2319 }
2320 return 0;
2321}
2322
2323/*
2324 * Get register number and access offset from the given instruction.
2325 * It assumes AT&T x86 asm format like OFFSET(REG). Maybe it needs
2326 * to revisit the format when it handles different architecture.
2327 * Fills @reg and @offset when return 0.
2328 */
2329static int extract_reg_offset(struct arch *arch, const char *str,
2330 struct annotated_op_loc *op_loc)
2331{
2332 char *p;
2333 char *regname;
2334
2335 if (arch->objdump.register_char == 0)
2336 return -1;
2337
2338 /*
2339 * It should start from offset, but it's possible to skip 0
2340 * in the asm. So 0(%rax) should be same as (%rax).
2341 *
2342 * However, it also start with a segment select register like
2343 * %gs:0x18(%rbx). In that case it should skip the part.
2344 */
2345 if (*str == arch->objdump.register_char) {
2346 if (arch__is(arch, "x86")) {
2347 /* FIXME: Handle other segment registers */
2348 if (!strncmp(str, "%gs:", 4))
2349 op_loc->segment = INSN_SEG_X86_GS;
2350 }
2351
2352 while (*str && !isdigit(*str) &&
2353 *str != arch->objdump.memory_ref_char)
2354 str++;
2355 }
2356
2357 op_loc->offset = strtol(str, &p, 0);
2358
2359 p = strchr(p, arch->objdump.register_char);
2360 if (p == NULL)
2361 return -1;
2362
2363 regname = strdup(p);
2364 if (regname == NULL)
2365 return -1;
2366
2367 op_loc->reg1 = get_dwarf_regnum(regname, arch->e_machine, arch->e_flags);
2368 free(regname);
2369
2370 /* Get the second register */
2371 if (op_loc->multi_regs) {
2372 p = strchr(p + 1, arch->objdump.register_char);
2373 if (p == NULL)
2374 return -1;
2375
2376 regname = strdup(p);
2377 if (regname == NULL)
2378 return -1;
2379
2380 op_loc->reg2 = get_dwarf_regnum(regname, arch->e_machine, arch->e_flags);
2381 free(regname);
2382 }
2383 return 0;
2384}
2385
2386/**
2387 * annotate_get_insn_location - Get location of instruction
2388 * @arch: the architecture info
2389 * @dl: the target instruction
2390 * @loc: a buffer to save the data
2391 *
2392 * Get detailed location info (register and offset) in the instruction.
2393 * It needs both source and target operand and whether it accesses a
2394 * memory location. The offset field is meaningful only when the
2395 * corresponding mem flag is set. The reg2 field is meaningful only
2396 * when multi_regs flag is set.
2397 *
2398 * Some examples on x86:
2399 *
2400 * mov (%rax), %rcx # src_reg1 = rax, src_mem = 1, src_offset = 0
2401 * # dst_reg1 = rcx, dst_mem = 0
2402 *
2403 * mov 0x18, %r8 # src_reg1 = -1, src_mem = 0
2404 * # dst_reg1 = r8, dst_mem = 0
2405 *
2406 * mov %rsi, 8(%rbx,%rcx,4) # src_reg1 = rsi, src_mem = 0, src_multi_regs = 0
2407 * # dst_reg1 = rbx, dst_reg2 = rcx, dst_mem = 1
2408 * # dst_multi_regs = 1, dst_offset = 8
2409 */
2410int annotate_get_insn_location(struct arch *arch, struct disasm_line *dl,
2411 struct annotated_insn_loc *loc)
2412{
2413 struct ins_operands *ops;
2414 struct annotated_op_loc *op_loc;
2415 int i;
2416
2417 if (ins__is_lock(&dl->ins))
2418 ops = dl->ops.locked.ops;
2419 else
2420 ops = &dl->ops;
2421
2422 if (ops == NULL)
2423 return -1;
2424
2425 memset(loc, 0, sizeof(*loc));
2426
2427 for_each_insn_op_loc(loc, i, op_loc) {
2428 const char *insn_str = ops->source.raw;
2429 bool multi_regs = ops->source.multi_regs;
2430 bool mem_ref = ops->source.mem_ref;
2431
2432 if (i == INSN_OP_TARGET) {
2433 insn_str = ops->target.raw;
2434 multi_regs = ops->target.multi_regs;
2435 mem_ref = ops->target.mem_ref;
2436 }
2437
2438 /* Invalidate the register by default */
2439 op_loc->reg1 = -1;
2440 op_loc->reg2 = -1;
2441
2442 if (insn_str == NULL) {
2443 if (!arch__is(arch, "powerpc"))
2444 continue;
2445 }
2446
2447 /*
2448 * For powerpc, call get_powerpc_regs function which extracts the
2449 * required fields for op_loc, ie reg1, reg2, offset from the
2450 * raw instruction.
2451 */
2452 if (arch__is(arch, "powerpc")) {
2453 op_loc->mem_ref = mem_ref;
2454 op_loc->multi_regs = multi_regs;
2455 get_powerpc_regs(dl->raw.raw_insn, !i, op_loc);
2456 } else if (strchr(insn_str, arch->objdump.memory_ref_char)) {
2457 op_loc->mem_ref = true;
2458 op_loc->multi_regs = multi_regs;
2459 extract_reg_offset(arch, insn_str, op_loc);
2460 } else {
2461 char *s, *p = NULL;
2462
2463 if (arch__is(arch, "x86")) {
2464 /* FIXME: Handle other segment registers */
2465 if (!strncmp(insn_str, "%gs:", 4)) {
2466 op_loc->segment = INSN_SEG_X86_GS;
2467 op_loc->offset = strtol(insn_str + 4,
2468 &p, 0);
2469 if (p && p != insn_str + 4)
2470 op_loc->imm = true;
2471 continue;
2472 }
2473 }
2474
2475 s = strdup(insn_str);
2476 if (s == NULL)
2477 return -1;
2478
2479 if (*s == arch->objdump.register_char)
2480 op_loc->reg1 = get_dwarf_regnum(s, arch->e_machine, arch->e_flags);
2481 else if (*s == arch->objdump.imm_char) {
2482 op_loc->offset = strtol(s + 1, &p, 0);
2483 if (p && p != s + 1)
2484 op_loc->imm = true;
2485 }
2486 free(s);
2487 }
2488 }
2489
2490 return 0;
2491}
2492
2493static struct disasm_line *find_disasm_line(struct symbol *sym, u64 ip,
2494 bool allow_update)
2495{
2496 struct disasm_line *dl;
2497 struct annotation *notes;
2498
2499 notes = symbol__annotation(sym);
2500
2501 list_for_each_entry(dl, ¬es->src->source, al.node) {
2502 if (dl->al.offset == -1)
2503 continue;
2504
2505 if (sym->start + dl->al.offset == ip) {
2506 /*
2507 * llvm-objdump places "lock" in a separate line and
2508 * in that case, we want to get the next line.
2509 */
2510 if (ins__is_lock(&dl->ins) &&
2511 *dl->ops.raw == '\0' && allow_update) {
2512 ip++;
2513 continue;
2514 }
2515 return dl;
2516 }
2517 }
2518 return NULL;
2519}
2520
2521static struct annotated_item_stat *annotate_data_stat(struct list_head *head,
2522 const char *name)
2523{
2524 struct annotated_item_stat *istat;
2525
2526 list_for_each_entry(istat, head, list) {
2527 if (!strcmp(istat->name, name))
2528 return istat;
2529 }
2530
2531 istat = zalloc(sizeof(*istat));
2532 if (istat == NULL)
2533 return NULL;
2534
2535 istat->name = strdup(name);
2536 if ((istat->name == NULL) || (!strlen(istat->name))) {
2537 free(istat);
2538 return NULL;
2539 }
2540
2541 list_add_tail(&istat->list, head);
2542 return istat;
2543}
2544
2545static bool is_stack_operation(struct arch *arch, struct disasm_line *dl)
2546{
2547 if (arch__is(arch, "x86")) {
2548 if (!strncmp(dl->ins.name, "push", 4) ||
2549 !strncmp(dl->ins.name, "pop", 3) ||
2550 !strncmp(dl->ins.name, "call", 4) ||
2551 !strncmp(dl->ins.name, "ret", 3))
2552 return true;
2553 }
2554
2555 return false;
2556}
2557
2558static bool is_stack_canary(struct arch *arch, struct annotated_op_loc *loc)
2559{
2560 /* On x86_64, %gs:40 is used for stack canary */
2561 if (arch__is(arch, "x86")) {
2562 if (loc->segment == INSN_SEG_X86_GS && loc->imm &&
2563 loc->offset == 40)
2564 return true;
2565 }
2566
2567 return false;
2568}
2569
2570static struct disasm_line *
2571annotation__prev_asm_line(struct annotation *notes, struct disasm_line *curr)
2572{
2573 struct list_head *sources = ¬es->src->source;
2574 struct disasm_line *prev;
2575
2576 if (curr == list_first_entry(sources, struct disasm_line, al.node))
2577 return NULL;
2578
2579 prev = list_prev_entry(curr, al.node);
2580 while (prev->al.offset == -1 &&
2581 prev != list_first_entry(sources, struct disasm_line, al.node))
2582 prev = list_prev_entry(prev, al.node);
2583
2584 if (prev->al.offset == -1)
2585 return NULL;
2586
2587 return prev;
2588}
2589
2590static struct disasm_line *
2591annotation__next_asm_line(struct annotation *notes, struct disasm_line *curr)
2592{
2593 struct list_head *sources = ¬es->src->source;
2594 struct disasm_line *next;
2595
2596 if (curr == list_last_entry(sources, struct disasm_line, al.node))
2597 return NULL;
2598
2599 next = list_next_entry(curr, al.node);
2600 while (next->al.offset == -1 &&
2601 next != list_last_entry(sources, struct disasm_line, al.node))
2602 next = list_next_entry(next, al.node);
2603
2604 if (next->al.offset == -1)
2605 return NULL;
2606
2607 return next;
2608}
2609
2610u64 annotate_calc_pcrel(struct map_symbol *ms, u64 ip, int offset,
2611 struct disasm_line *dl)
2612{
2613 struct annotation *notes;
2614 struct disasm_line *next;
2615 u64 addr;
2616
2617 notes = symbol__annotation(ms->sym);
2618 /*
2619 * PC-relative addressing starts from the next instruction address
2620 * But the IP is for the current instruction. Since disasm_line
2621 * doesn't have the instruction size, calculate it using the next
2622 * disasm_line. If it's the last one, we can use symbol's end
2623 * address directly.
2624 */
2625 next = annotation__next_asm_line(notes, dl);
2626 if (next == NULL)
2627 addr = ms->sym->end + offset;
2628 else
2629 addr = ip + (next->al.offset - dl->al.offset) + offset;
2630
2631 return map__rip_2objdump(ms->map, addr);
2632}
2633
2634static struct debuginfo_cache {
2635 struct dso *dso;
2636 struct debuginfo *dbg;
2637} di_cache;
2638
2639void debuginfo_cache__delete(void)
2640{
2641 dso__put(di_cache.dso);
2642 di_cache.dso = NULL;
2643
2644 debuginfo__delete(di_cache.dbg);
2645 di_cache.dbg = NULL;
2646}
2647
2648/**
2649 * hist_entry__get_data_type - find data type for given hist entry
2650 * @he: hist entry
2651 *
2652 * This function first annotates the instruction at @he->ip and extracts
2653 * register and offset info from it. Then it searches the DWARF debug
2654 * info to get a variable and type information using the address, register,
2655 * and offset.
2656 */
2657struct annotated_data_type *hist_entry__get_data_type(struct hist_entry *he)
2658{
2659 struct map_symbol *ms = &he->ms;
2660 struct evsel *evsel = hists_to_evsel(he->hists);
2661 struct arch *arch;
2662 struct disasm_line *dl;
2663 struct annotated_insn_loc loc;
2664 struct annotated_op_loc *op_loc;
2665 struct annotated_data_type *mem_type;
2666 struct annotated_item_stat *istat;
2667 u64 ip = he->ip;
2668 int i;
2669
2670 ann_data_stat.total++;
2671
2672 if (ms->map == NULL || ms->sym == NULL) {
2673 ann_data_stat.no_sym++;
2674 return NULL;
2675 }
2676
2677 if (!symbol_conf.init_annotation) {
2678 ann_data_stat.no_sym++;
2679 return NULL;
2680 }
2681
2682 /*
2683 * di_cache holds a pair of values, but code below assumes
2684 * di_cache.dso can be compared/updated and di_cache.dbg can be
2685 * read/updated independently from each other. That assumption only
2686 * holds in single threaded code.
2687 */
2688 assert(perf_singlethreaded);
2689
2690 if (map__dso(ms->map) != di_cache.dso) {
2691 dso__put(di_cache.dso);
2692 di_cache.dso = dso__get(map__dso(ms->map));
2693
2694 debuginfo__delete(di_cache.dbg);
2695 di_cache.dbg = debuginfo__new(dso__long_name(di_cache.dso));
2696 }
2697
2698 if (di_cache.dbg == NULL) {
2699 ann_data_stat.no_dbginfo++;
2700 return NULL;
2701 }
2702
2703 /* Make sure it has the disasm of the function */
2704 if (symbol__annotate(ms, evsel, &arch) < 0) {
2705 ann_data_stat.no_insn++;
2706 return NULL;
2707 }
2708
2709 /*
2710 * Get a disasm to extract the location from the insn.
2711 * This is too slow...
2712 */
2713 dl = find_disasm_line(ms->sym, ip, /*allow_update=*/true);
2714 if (dl == NULL) {
2715 ann_data_stat.no_insn++;
2716 return NULL;
2717 }
2718
2719retry:
2720 istat = annotate_data_stat(&ann_insn_stat, dl->ins.name);
2721 if (istat == NULL) {
2722 ann_data_stat.no_insn++;
2723 return NULL;
2724 }
2725
2726 if (annotate_get_insn_location(arch, dl, &loc) < 0) {
2727 ann_data_stat.no_insn_ops++;
2728 istat->bad++;
2729 return NULL;
2730 }
2731
2732 if (is_stack_operation(arch, dl)) {
2733 istat->good++;
2734 he->mem_type_off = 0;
2735 return &stackop_type;
2736 }
2737
2738 for_each_insn_op_loc(&loc, i, op_loc) {
2739 struct data_loc_info dloc = {
2740 .arch = arch,
2741 .thread = he->thread,
2742 .ms = ms,
2743 /* Recalculate IP for LOCK prefix or insn fusion */
2744 .ip = ms->sym->start + dl->al.offset,
2745 .cpumode = he->cpumode,
2746 .op = op_loc,
2747 .di = di_cache.dbg,
2748 };
2749
2750 if (!op_loc->mem_ref && op_loc->segment == INSN_SEG_NONE)
2751 continue;
2752
2753 /* Recalculate IP because of LOCK prefix or insn fusion */
2754 ip = ms->sym->start + dl->al.offset;
2755
2756 /* PC-relative addressing */
2757 if (op_loc->reg1 == DWARF_REG_PC) {
2758 dloc.var_addr = annotate_calc_pcrel(ms, dloc.ip,
2759 op_loc->offset, dl);
2760 }
2761
2762 /* This CPU access in kernel - pretend PC-relative addressing */
2763 if (dso__kernel(map__dso(ms->map)) && arch__is(arch, "x86") &&
2764 op_loc->segment == INSN_SEG_X86_GS && op_loc->imm) {
2765 dloc.var_addr = op_loc->offset;
2766 op_loc->reg1 = DWARF_REG_PC;
2767 }
2768
2769 mem_type = find_data_type(&dloc);
2770
2771 if (mem_type == NULL && is_stack_canary(arch, op_loc)) {
2772 istat->good++;
2773 he->mem_type_off = 0;
2774 return &canary_type;
2775 }
2776
2777 if (mem_type)
2778 istat->good++;
2779 else
2780 istat->bad++;
2781
2782 if (symbol_conf.annotate_data_sample) {
2783 annotated_data_type__update_samples(mem_type, evsel,
2784 dloc.type_offset,
2785 he->stat.nr_events,
2786 he->stat.period);
2787 }
2788 he->mem_type_off = dloc.type_offset;
2789 return mem_type;
2790 }
2791
2792 /*
2793 * Some instructions can be fused and the actual memory access came
2794 * from the previous instruction.
2795 */
2796 if (dl->al.offset > 0) {
2797 struct annotation *notes;
2798 struct disasm_line *prev_dl;
2799
2800 notes = symbol__annotation(ms->sym);
2801 prev_dl = annotation__prev_asm_line(notes, dl);
2802
2803 if (prev_dl && ins__is_fused(arch, prev_dl->ins.name, dl->ins.name)) {
2804 dl = prev_dl;
2805 goto retry;
2806 }
2807 }
2808
2809 ann_data_stat.no_mem_ops++;
2810 istat->bad++;
2811 return NULL;
2812}
2813
2814/* Basic block traversal (BFS) data structure */
2815struct basic_block_data {
2816 struct list_head queue;
2817 struct list_head visited;
2818};
2819
2820/*
2821 * During the traversal, it needs to know the parent block where the current
2822 * block block started from. Note that single basic block can be parent of
2823 * two child basic blocks (in case of condition jump).
2824 */
2825struct basic_block_link {
2826 struct list_head node;
2827 struct basic_block_link *parent;
2828 struct annotated_basic_block *bb;
2829};
2830
2831/* Check any of basic block in the list already has the offset */
2832static bool basic_block_has_offset(struct list_head *head, s64 offset)
2833{
2834 struct basic_block_link *link;
2835
2836 list_for_each_entry(link, head, node) {
2837 s64 begin_offset = link->bb->begin->al.offset;
2838 s64 end_offset = link->bb->end->al.offset;
2839
2840 if (begin_offset <= offset && offset <= end_offset)
2841 return true;
2842 }
2843 return false;
2844}
2845
2846static bool is_new_basic_block(struct basic_block_data *bb_data,
2847 struct disasm_line *dl)
2848{
2849 s64 offset = dl->al.offset;
2850
2851 if (basic_block_has_offset(&bb_data->visited, offset))
2852 return false;
2853 if (basic_block_has_offset(&bb_data->queue, offset))
2854 return false;
2855 return true;
2856}
2857
2858/* Add a basic block starting from dl and link it to the parent */
2859static int add_basic_block(struct basic_block_data *bb_data,
2860 struct basic_block_link *parent,
2861 struct disasm_line *dl)
2862{
2863 struct annotated_basic_block *bb;
2864 struct basic_block_link *link;
2865
2866 if (dl == NULL)
2867 return -1;
2868
2869 if (!is_new_basic_block(bb_data, dl))
2870 return 0;
2871
2872 bb = zalloc(sizeof(*bb));
2873 if (bb == NULL)
2874 return -1;
2875
2876 bb->begin = dl;
2877 bb->end = dl;
2878 INIT_LIST_HEAD(&bb->list);
2879
2880 link = malloc(sizeof(*link));
2881 if (link == NULL) {
2882 free(bb);
2883 return -1;
2884 }
2885
2886 link->bb = bb;
2887 link->parent = parent;
2888 list_add_tail(&link->node, &bb_data->queue);
2889 return 0;
2890}
2891
2892/* Returns true when it finds the target in the current basic block */
2893static bool process_basic_block(struct basic_block_data *bb_data,
2894 struct basic_block_link *link,
2895 struct symbol *sym, u64 target)
2896{
2897 struct disasm_line *dl, *next_dl, *last_dl;
2898 struct annotation *notes = symbol__annotation(sym);
2899 bool found = false;
2900
2901 dl = link->bb->begin;
2902 /* Check if it's already visited */
2903 if (basic_block_has_offset(&bb_data->visited, dl->al.offset))
2904 return false;
2905
2906 last_dl = list_last_entry(¬es->src->source,
2907 struct disasm_line, al.node);
2908 if (last_dl->al.offset == -1)
2909 last_dl = annotation__prev_asm_line(notes, last_dl);
2910
2911 if (last_dl == NULL)
2912 return false;
2913
2914 list_for_each_entry_from(dl, ¬es->src->source, al.node) {
2915 /* Skip comment or debug info line */
2916 if (dl->al.offset == -1)
2917 continue;
2918 /* Found the target instruction */
2919 if (sym->start + dl->al.offset == target) {
2920 found = true;
2921 break;
2922 }
2923 /* End of the function, finish the block */
2924 if (dl == last_dl)
2925 break;
2926 /* 'return' instruction finishes the block */
2927 if (ins__is_ret(&dl->ins))
2928 break;
2929 /* normal instructions are part of the basic block */
2930 if (!ins__is_jump(&dl->ins))
2931 continue;
2932 /* jump to a different function, tail call or return */
2933 if (dl->ops.target.outside)
2934 break;
2935 /* jump instruction creates new basic block(s) */
2936 next_dl = find_disasm_line(sym, sym->start + dl->ops.target.offset,
2937 /*allow_update=*/false);
2938 if (next_dl)
2939 add_basic_block(bb_data, link, next_dl);
2940
2941 /*
2942 * FIXME: determine conditional jumps properly.
2943 * Conditional jumps create another basic block with the
2944 * next disasm line.
2945 */
2946 if (!strstr(dl->ins.name, "jmp")) {
2947 next_dl = annotation__next_asm_line(notes, dl);
2948 if (next_dl)
2949 add_basic_block(bb_data, link, next_dl);
2950 }
2951 break;
2952
2953 }
2954 link->bb->end = dl;
2955 return found;
2956}
2957
2958/*
2959 * It founds a target basic block, build a proper linked list of basic blocks
2960 * by following the link recursively.
2961 */
2962static void link_found_basic_blocks(struct basic_block_link *link,
2963 struct list_head *head)
2964{
2965 while (link) {
2966 struct basic_block_link *parent = link->parent;
2967
2968 list_move(&link->bb->list, head);
2969 list_del(&link->node);
2970 free(link);
2971
2972 link = parent;
2973 }
2974}
2975
2976static void delete_basic_blocks(struct basic_block_data *bb_data)
2977{
2978 struct basic_block_link *link, *tmp;
2979
2980 list_for_each_entry_safe(link, tmp, &bb_data->queue, node) {
2981 list_del(&link->node);
2982 zfree(&link->bb);
2983 free(link);
2984 }
2985
2986 list_for_each_entry_safe(link, tmp, &bb_data->visited, node) {
2987 list_del(&link->node);
2988 zfree(&link->bb);
2989 free(link);
2990 }
2991}
2992
2993/**
2994 * annotate_get_basic_blocks - Get basic blocks for given address range
2995 * @sym: symbol to annotate
2996 * @src: source address
2997 * @dst: destination address
2998 * @head: list head to save basic blocks
2999 *
3000 * This function traverses disasm_lines from @src to @dst and save them in a
3001 * list of annotated_basic_block to @head. It uses BFS to find the shortest
3002 * path between two. The basic_block_link is to maintain parent links so
3003 * that it can build a list of blocks from the start.
3004 */
3005int annotate_get_basic_blocks(struct symbol *sym, s64 src, s64 dst,
3006 struct list_head *head)
3007{
3008 struct basic_block_data bb_data = {
3009 .queue = LIST_HEAD_INIT(bb_data.queue),
3010 .visited = LIST_HEAD_INIT(bb_data.visited),
3011 };
3012 struct basic_block_link *link;
3013 struct disasm_line *dl;
3014 int ret = -1;
3015
3016 dl = find_disasm_line(sym, src, /*allow_update=*/false);
3017 if (dl == NULL)
3018 return -1;
3019
3020 if (add_basic_block(&bb_data, /*parent=*/NULL, dl) < 0)
3021 return -1;
3022
3023 /* Find shortest path from src to dst using BFS */
3024 while (!list_empty(&bb_data.queue)) {
3025 link = list_first_entry(&bb_data.queue, struct basic_block_link, node);
3026
3027 if (process_basic_block(&bb_data, link, sym, dst)) {
3028 link_found_basic_blocks(link, head);
3029 ret = 0;
3030 break;
3031 }
3032 list_move(&link->node, &bb_data.visited);
3033 }
3034 delete_basic_blocks(&bb_data);
3035 return ret;
3036}
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
4 *
5 * Parts came from builtin-annotate.c, see those files for further
6 * copyright notes.
7 */
8
9#include <errno.h>
10#include <inttypes.h>
11#include <libgen.h>
12#include <stdlib.h>
13#include <bpf/bpf.h>
14#include <bpf/btf.h>
15#include <bpf/libbpf.h>
16#include <linux/btf.h>
17#include "util.h" // hex_width()
18#include "ui/ui.h"
19#include "sort.h"
20#include "build-id.h"
21#include "color.h"
22#include "config.h"
23#include "dso.h"
24#include "env.h"
25#include "map.h"
26#include "maps.h"
27#include "symbol.h"
28#include "srcline.h"
29#include "units.h"
30#include "debug.h"
31#include "annotate.h"
32#include "evsel.h"
33#include "evlist.h"
34#include "bpf-event.h"
35#include "block-range.h"
36#include "string2.h"
37#include "util/event.h"
38#include "arch/common.h"
39#include <regex.h>
40#include <pthread.h>
41#include <linux/bitops.h>
42#include <linux/kernel.h>
43#include <linux/string.h>
44#include <subcmd/parse-options.h>
45#include <subcmd/run-command.h>
46
47/* FIXME: For the HE_COLORSET */
48#include "ui/browser.h"
49
50/*
51 * FIXME: Using the same values as slang.h,
52 * but that header may not be available everywhere
53 */
54#define LARROW_CHAR ((unsigned char)',')
55#define RARROW_CHAR ((unsigned char)'+')
56#define DARROW_CHAR ((unsigned char)'.')
57#define UARROW_CHAR ((unsigned char)'-')
58
59#include <linux/ctype.h>
60
61struct annotation_options annotation__default_options = {
62 .use_offset = true,
63 .jump_arrows = true,
64 .annotate_src = true,
65 .offset_level = ANNOTATION__OFFSET_JUMP_TARGETS,
66 .percent_type = PERCENT_PERIOD_LOCAL,
67};
68
69static regex_t file_lineno;
70
71static struct ins_ops *ins__find(struct arch *arch, const char *name);
72static void ins__sort(struct arch *arch);
73static int disasm_line__parse(char *line, const char **namep, char **rawp);
74
75struct arch {
76 const char *name;
77 struct ins *instructions;
78 size_t nr_instructions;
79 size_t nr_instructions_allocated;
80 struct ins_ops *(*associate_instruction_ops)(struct arch *arch, const char *name);
81 bool sorted_instructions;
82 bool initialized;
83 void *priv;
84 unsigned int model;
85 unsigned int family;
86 int (*init)(struct arch *arch, char *cpuid);
87 bool (*ins_is_fused)(struct arch *arch, const char *ins1,
88 const char *ins2);
89 struct {
90 char comment_char;
91 char skip_functions_char;
92 } objdump;
93};
94
95static struct ins_ops call_ops;
96static struct ins_ops dec_ops;
97static struct ins_ops jump_ops;
98static struct ins_ops mov_ops;
99static struct ins_ops nop_ops;
100static struct ins_ops lock_ops;
101static struct ins_ops ret_ops;
102
103static int arch__grow_instructions(struct arch *arch)
104{
105 struct ins *new_instructions;
106 size_t new_nr_allocated;
107
108 if (arch->nr_instructions_allocated == 0 && arch->instructions)
109 goto grow_from_non_allocated_table;
110
111 new_nr_allocated = arch->nr_instructions_allocated + 128;
112 new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
113 if (new_instructions == NULL)
114 return -1;
115
116out_update_instructions:
117 arch->instructions = new_instructions;
118 arch->nr_instructions_allocated = new_nr_allocated;
119 return 0;
120
121grow_from_non_allocated_table:
122 new_nr_allocated = arch->nr_instructions + 128;
123 new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
124 if (new_instructions == NULL)
125 return -1;
126
127 memcpy(new_instructions, arch->instructions, arch->nr_instructions);
128 goto out_update_instructions;
129}
130
131static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
132{
133 struct ins *ins;
134
135 if (arch->nr_instructions == arch->nr_instructions_allocated &&
136 arch__grow_instructions(arch))
137 return -1;
138
139 ins = &arch->instructions[arch->nr_instructions];
140 ins->name = strdup(name);
141 if (!ins->name)
142 return -1;
143
144 ins->ops = ops;
145 arch->nr_instructions++;
146
147 ins__sort(arch);
148 return 0;
149}
150
151#include "arch/arc/annotate/instructions.c"
152#include "arch/arm/annotate/instructions.c"
153#include "arch/arm64/annotate/instructions.c"
154#include "arch/csky/annotate/instructions.c"
155#include "arch/x86/annotate/instructions.c"
156#include "arch/powerpc/annotate/instructions.c"
157#include "arch/s390/annotate/instructions.c"
158#include "arch/sparc/annotate/instructions.c"
159
160static struct arch architectures[] = {
161 {
162 .name = "arc",
163 .init = arc__annotate_init,
164 },
165 {
166 .name = "arm",
167 .init = arm__annotate_init,
168 },
169 {
170 .name = "arm64",
171 .init = arm64__annotate_init,
172 },
173 {
174 .name = "csky",
175 .init = csky__annotate_init,
176 },
177 {
178 .name = "x86",
179 .init = x86__annotate_init,
180 .instructions = x86__instructions,
181 .nr_instructions = ARRAY_SIZE(x86__instructions),
182 .ins_is_fused = x86__ins_is_fused,
183 .objdump = {
184 .comment_char = '#',
185 },
186 },
187 {
188 .name = "powerpc",
189 .init = powerpc__annotate_init,
190 },
191 {
192 .name = "s390",
193 .init = s390__annotate_init,
194 .objdump = {
195 .comment_char = '#',
196 },
197 },
198 {
199 .name = "sparc",
200 .init = sparc__annotate_init,
201 .objdump = {
202 .comment_char = '#',
203 },
204 },
205};
206
207static void ins__delete(struct ins_operands *ops)
208{
209 if (ops == NULL)
210 return;
211 zfree(&ops->source.raw);
212 zfree(&ops->source.name);
213 zfree(&ops->target.raw);
214 zfree(&ops->target.name);
215}
216
217static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
218 struct ins_operands *ops, int max_ins_name)
219{
220 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
221}
222
223int ins__scnprintf(struct ins *ins, char *bf, size_t size,
224 struct ins_operands *ops, int max_ins_name)
225{
226 if (ins->ops->scnprintf)
227 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
228
229 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
230}
231
232bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
233{
234 if (!arch || !arch->ins_is_fused)
235 return false;
236
237 return arch->ins_is_fused(arch, ins1, ins2);
238}
239
240static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
241{
242 char *endptr, *tok, *name;
243 struct map *map = ms->map;
244 struct addr_map_symbol target = {
245 .ms = { .map = map, },
246 };
247
248 ops->target.addr = strtoull(ops->raw, &endptr, 16);
249
250 name = strchr(endptr, '<');
251 if (name == NULL)
252 goto indirect_call;
253
254 name++;
255
256 if (arch->objdump.skip_functions_char &&
257 strchr(name, arch->objdump.skip_functions_char))
258 return -1;
259
260 tok = strchr(name, '>');
261 if (tok == NULL)
262 return -1;
263
264 *tok = '\0';
265 ops->target.name = strdup(name);
266 *tok = '>';
267
268 if (ops->target.name == NULL)
269 return -1;
270find_target:
271 target.addr = map__objdump_2mem(map, ops->target.addr);
272
273 if (maps__find_ams(ms->maps, &target) == 0 &&
274 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
275 ops->target.sym = target.ms.sym;
276
277 return 0;
278
279indirect_call:
280 tok = strchr(endptr, '*');
281 if (tok != NULL) {
282 endptr++;
283
284 /* Indirect call can use a non-rip register and offset: callq *0x8(%rbx).
285 * Do not parse such instruction. */
286 if (strstr(endptr, "(%r") == NULL)
287 ops->target.addr = strtoull(endptr, NULL, 16);
288 }
289 goto find_target;
290}
291
292static int call__scnprintf(struct ins *ins, char *bf, size_t size,
293 struct ins_operands *ops, int max_ins_name)
294{
295 if (ops->target.sym)
296 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
297
298 if (ops->target.addr == 0)
299 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
300
301 if (ops->target.name)
302 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
303
304 return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
305}
306
307static struct ins_ops call_ops = {
308 .parse = call__parse,
309 .scnprintf = call__scnprintf,
310};
311
312bool ins__is_call(const struct ins *ins)
313{
314 return ins->ops == &call_ops || ins->ops == &s390_call_ops;
315}
316
317/*
318 * Prevents from matching commas in the comment section, e.g.:
319 * ffff200008446e70: b.cs ffff2000084470f4 <generic_exec_single+0x314> // b.hs, b.nlast
320 */
321static inline const char *validate_comma(const char *c, struct ins_operands *ops)
322{
323 if (ops->raw_comment && c > ops->raw_comment)
324 return NULL;
325
326 return c;
327}
328
329static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
330{
331 struct map *map = ms->map;
332 struct symbol *sym = ms->sym;
333 struct addr_map_symbol target = {
334 .ms = { .map = map, },
335 };
336 const char *c = strchr(ops->raw, ',');
337 u64 start, end;
338
339 ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
340 c = validate_comma(c, ops);
341
342 /*
343 * Examples of lines to parse for the _cpp_lex_token@@Base
344 * function:
345 *
346 * 1159e6c: jne 115aa32 <_cpp_lex_token@@Base+0xf92>
347 * 1159e8b: jne c469be <cpp_named_operator2name@@Base+0xa72>
348 *
349 * The first is a jump to an offset inside the same function,
350 * the second is to another function, i.e. that 0xa72 is an
351 * offset in the cpp_named_operator2name@@base function.
352 */
353 /*
354 * skip over possible up to 2 operands to get to address, e.g.:
355 * tbnz w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
356 */
357 if (c++ != NULL) {
358 ops->target.addr = strtoull(c, NULL, 16);
359 if (!ops->target.addr) {
360 c = strchr(c, ',');
361 c = validate_comma(c, ops);
362 if (c++ != NULL)
363 ops->target.addr = strtoull(c, NULL, 16);
364 }
365 } else {
366 ops->target.addr = strtoull(ops->raw, NULL, 16);
367 }
368
369 target.addr = map__objdump_2mem(map, ops->target.addr);
370 start = map->unmap_ip(map, sym->start),
371 end = map->unmap_ip(map, sym->end);
372
373 ops->target.outside = target.addr < start || target.addr > end;
374
375 /*
376 * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
377
378 cpp_named_operator2name@@Base+0xa72
379
380 * Point to a place that is after the cpp_named_operator2name
381 * boundaries, i.e. in the ELF symbol table for cc1
382 * cpp_named_operator2name is marked as being 32-bytes long, but it in
383 * fact is much larger than that, so we seem to need a symbols__find()
384 * routine that looks for >= current->start and < next_symbol->start,
385 * possibly just for C++ objects?
386 *
387 * For now lets just make some progress by marking jumps to outside the
388 * current function as call like.
389 *
390 * Actual navigation will come next, with further understanding of how
391 * the symbol searching and disassembly should be done.
392 */
393 if (maps__find_ams(ms->maps, &target) == 0 &&
394 map__rip_2objdump(target.ms.map, map->map_ip(target.ms.map, target.addr)) == ops->target.addr)
395 ops->target.sym = target.ms.sym;
396
397 if (!ops->target.outside) {
398 ops->target.offset = target.addr - start;
399 ops->target.offset_avail = true;
400 } else {
401 ops->target.offset_avail = false;
402 }
403
404 return 0;
405}
406
407static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
408 struct ins_operands *ops, int max_ins_name)
409{
410 const char *c;
411
412 if (!ops->target.addr || ops->target.offset < 0)
413 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
414
415 if (ops->target.outside && ops->target.sym != NULL)
416 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
417
418 c = strchr(ops->raw, ',');
419 c = validate_comma(c, ops);
420
421 if (c != NULL) {
422 const char *c2 = strchr(c + 1, ',');
423
424 c2 = validate_comma(c2, ops);
425 /* check for 3-op insn */
426 if (c2 != NULL)
427 c = c2;
428 c++;
429
430 /* mirror arch objdump's space-after-comma style */
431 if (*c == ' ')
432 c++;
433 }
434
435 return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
436 ins->name, c ? c - ops->raw : 0, ops->raw,
437 ops->target.offset);
438}
439
440static struct ins_ops jump_ops = {
441 .parse = jump__parse,
442 .scnprintf = jump__scnprintf,
443};
444
445bool ins__is_jump(const struct ins *ins)
446{
447 return ins->ops == &jump_ops;
448}
449
450static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
451{
452 char *endptr, *name, *t;
453
454 if (strstr(raw, "(%rip)") == NULL)
455 return 0;
456
457 *addrp = strtoull(comment, &endptr, 16);
458 if (endptr == comment)
459 return 0;
460 name = strchr(endptr, '<');
461 if (name == NULL)
462 return -1;
463
464 name++;
465
466 t = strchr(name, '>');
467 if (t == NULL)
468 return 0;
469
470 *t = '\0';
471 *namep = strdup(name);
472 *t = '>';
473
474 return 0;
475}
476
477static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
478{
479 ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
480 if (ops->locked.ops == NULL)
481 return 0;
482
483 if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
484 goto out_free_ops;
485
486 ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
487
488 if (ops->locked.ins.ops == NULL)
489 goto out_free_ops;
490
491 if (ops->locked.ins.ops->parse &&
492 ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
493 goto out_free_ops;
494
495 return 0;
496
497out_free_ops:
498 zfree(&ops->locked.ops);
499 return 0;
500}
501
502static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
503 struct ins_operands *ops, int max_ins_name)
504{
505 int printed;
506
507 if (ops->locked.ins.ops == NULL)
508 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
509
510 printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
511 return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
512 size - printed, ops->locked.ops, max_ins_name);
513}
514
515static void lock__delete(struct ins_operands *ops)
516{
517 struct ins *ins = &ops->locked.ins;
518
519 if (ins->ops && ins->ops->free)
520 ins->ops->free(ops->locked.ops);
521 else
522 ins__delete(ops->locked.ops);
523
524 zfree(&ops->locked.ops);
525 zfree(&ops->target.raw);
526 zfree(&ops->target.name);
527}
528
529static struct ins_ops lock_ops = {
530 .free = lock__delete,
531 .parse = lock__parse,
532 .scnprintf = lock__scnprintf,
533};
534
535static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
536{
537 char *s = strchr(ops->raw, ','), *target, *comment, prev;
538
539 if (s == NULL)
540 return -1;
541
542 *s = '\0';
543 ops->source.raw = strdup(ops->raw);
544 *s = ',';
545
546 if (ops->source.raw == NULL)
547 return -1;
548
549 target = ++s;
550 comment = strchr(s, arch->objdump.comment_char);
551
552 if (comment != NULL)
553 s = comment - 1;
554 else
555 s = strchr(s, '\0') - 1;
556
557 while (s > target && isspace(s[0]))
558 --s;
559 s++;
560 prev = *s;
561 *s = '\0';
562
563 ops->target.raw = strdup(target);
564 *s = prev;
565
566 if (ops->target.raw == NULL)
567 goto out_free_source;
568
569 if (comment == NULL)
570 return 0;
571
572 comment = skip_spaces(comment);
573 comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
574 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
575
576 return 0;
577
578out_free_source:
579 zfree(&ops->source.raw);
580 return -1;
581}
582
583static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
584 struct ins_operands *ops, int max_ins_name)
585{
586 return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
587 ops->source.name ?: ops->source.raw,
588 ops->target.name ?: ops->target.raw);
589}
590
591static struct ins_ops mov_ops = {
592 .parse = mov__parse,
593 .scnprintf = mov__scnprintf,
594};
595
596static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
597{
598 char *target, *comment, *s, prev;
599
600 target = s = ops->raw;
601
602 while (s[0] != '\0' && !isspace(s[0]))
603 ++s;
604 prev = *s;
605 *s = '\0';
606
607 ops->target.raw = strdup(target);
608 *s = prev;
609
610 if (ops->target.raw == NULL)
611 return -1;
612
613 comment = strchr(s, arch->objdump.comment_char);
614 if (comment == NULL)
615 return 0;
616
617 comment = skip_spaces(comment);
618 comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
619
620 return 0;
621}
622
623static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
624 struct ins_operands *ops, int max_ins_name)
625{
626 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
627 ops->target.name ?: ops->target.raw);
628}
629
630static struct ins_ops dec_ops = {
631 .parse = dec__parse,
632 .scnprintf = dec__scnprintf,
633};
634
635static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
636 struct ins_operands *ops __maybe_unused, int max_ins_name)
637{
638 return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
639}
640
641static struct ins_ops nop_ops = {
642 .scnprintf = nop__scnprintf,
643};
644
645static struct ins_ops ret_ops = {
646 .scnprintf = ins__raw_scnprintf,
647};
648
649bool ins__is_ret(const struct ins *ins)
650{
651 return ins->ops == &ret_ops;
652}
653
654bool ins__is_lock(const struct ins *ins)
655{
656 return ins->ops == &lock_ops;
657}
658
659static int ins__key_cmp(const void *name, const void *insp)
660{
661 const struct ins *ins = insp;
662
663 return strcmp(name, ins->name);
664}
665
666static int ins__cmp(const void *a, const void *b)
667{
668 const struct ins *ia = a;
669 const struct ins *ib = b;
670
671 return strcmp(ia->name, ib->name);
672}
673
674static void ins__sort(struct arch *arch)
675{
676 const int nmemb = arch->nr_instructions;
677
678 qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
679}
680
681static struct ins_ops *__ins__find(struct arch *arch, const char *name)
682{
683 struct ins *ins;
684 const int nmemb = arch->nr_instructions;
685
686 if (!arch->sorted_instructions) {
687 ins__sort(arch);
688 arch->sorted_instructions = true;
689 }
690
691 ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
692 return ins ? ins->ops : NULL;
693}
694
695static struct ins_ops *ins__find(struct arch *arch, const char *name)
696{
697 struct ins_ops *ops = __ins__find(arch, name);
698
699 if (!ops && arch->associate_instruction_ops)
700 ops = arch->associate_instruction_ops(arch, name);
701
702 return ops;
703}
704
705static int arch__key_cmp(const void *name, const void *archp)
706{
707 const struct arch *arch = archp;
708
709 return strcmp(name, arch->name);
710}
711
712static int arch__cmp(const void *a, const void *b)
713{
714 const struct arch *aa = a;
715 const struct arch *ab = b;
716
717 return strcmp(aa->name, ab->name);
718}
719
720static void arch__sort(void)
721{
722 const int nmemb = ARRAY_SIZE(architectures);
723
724 qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
725}
726
727static struct arch *arch__find(const char *name)
728{
729 const int nmemb = ARRAY_SIZE(architectures);
730 static bool sorted;
731
732 if (!sorted) {
733 arch__sort();
734 sorted = true;
735 }
736
737 return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
738}
739
740static struct annotated_source *annotated_source__new(void)
741{
742 struct annotated_source *src = zalloc(sizeof(*src));
743
744 if (src != NULL)
745 INIT_LIST_HEAD(&src->source);
746
747 return src;
748}
749
750static __maybe_unused void annotated_source__delete(struct annotated_source *src)
751{
752 if (src == NULL)
753 return;
754 zfree(&src->histograms);
755 zfree(&src->cycles_hist);
756 free(src);
757}
758
759static int annotated_source__alloc_histograms(struct annotated_source *src,
760 size_t size, int nr_hists)
761{
762 size_t sizeof_sym_hist;
763
764 /*
765 * Add buffer of one element for zero length symbol.
766 * When sample is taken from first instruction of
767 * zero length symbol, perf still resolves it and
768 * shows symbol name in perf report and allows to
769 * annotate it.
770 */
771 if (size == 0)
772 size = 1;
773
774 /* Check for overflow when calculating sizeof_sym_hist */
775 if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
776 return -1;
777
778 sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
779
780 /* Check for overflow in zalloc argument */
781 if (sizeof_sym_hist > SIZE_MAX / nr_hists)
782 return -1;
783
784 src->sizeof_sym_hist = sizeof_sym_hist;
785 src->nr_histograms = nr_hists;
786 src->histograms = calloc(nr_hists, sizeof_sym_hist) ;
787 return src->histograms ? 0 : -1;
788}
789
790/* The cycles histogram is lazily allocated. */
791static int symbol__alloc_hist_cycles(struct symbol *sym)
792{
793 struct annotation *notes = symbol__annotation(sym);
794 const size_t size = symbol__size(sym);
795
796 notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
797 if (notes->src->cycles_hist == NULL)
798 return -1;
799 return 0;
800}
801
802void symbol__annotate_zero_histograms(struct symbol *sym)
803{
804 struct annotation *notes = symbol__annotation(sym);
805
806 pthread_mutex_lock(¬es->lock);
807 if (notes->src != NULL) {
808 memset(notes->src->histograms, 0,
809 notes->src->nr_histograms * notes->src->sizeof_sym_hist);
810 if (notes->src->cycles_hist)
811 memset(notes->src->cycles_hist, 0,
812 symbol__size(sym) * sizeof(struct cyc_hist));
813 }
814 pthread_mutex_unlock(¬es->lock);
815}
816
817static int __symbol__account_cycles(struct cyc_hist *ch,
818 u64 start,
819 unsigned offset, unsigned cycles,
820 unsigned have_start)
821{
822 /*
823 * For now we can only account one basic block per
824 * final jump. But multiple could be overlapping.
825 * Always account the longest one. So when
826 * a shorter one has been already seen throw it away.
827 *
828 * We separately always account the full cycles.
829 */
830 ch[offset].num_aggr++;
831 ch[offset].cycles_aggr += cycles;
832
833 if (cycles > ch[offset].cycles_max)
834 ch[offset].cycles_max = cycles;
835
836 if (ch[offset].cycles_min) {
837 if (cycles && cycles < ch[offset].cycles_min)
838 ch[offset].cycles_min = cycles;
839 } else
840 ch[offset].cycles_min = cycles;
841
842 if (!have_start && ch[offset].have_start)
843 return 0;
844 if (ch[offset].num) {
845 if (have_start && (!ch[offset].have_start ||
846 ch[offset].start > start)) {
847 ch[offset].have_start = 0;
848 ch[offset].cycles = 0;
849 ch[offset].num = 0;
850 if (ch[offset].reset < 0xffff)
851 ch[offset].reset++;
852 } else if (have_start &&
853 ch[offset].start < start)
854 return 0;
855 }
856
857 if (ch[offset].num < NUM_SPARKS)
858 ch[offset].cycles_spark[ch[offset].num] = cycles;
859
860 ch[offset].have_start = have_start;
861 ch[offset].start = start;
862 ch[offset].cycles += cycles;
863 ch[offset].num++;
864 return 0;
865}
866
867static int __symbol__inc_addr_samples(struct map_symbol *ms,
868 struct annotated_source *src, int evidx, u64 addr,
869 struct perf_sample *sample)
870{
871 struct symbol *sym = ms->sym;
872 unsigned offset;
873 struct sym_hist *h;
874
875 pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, ms->map->unmap_ip(ms->map, addr));
876
877 if ((addr < sym->start || addr >= sym->end) &&
878 (addr != sym->end || sym->start != sym->end)) {
879 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
880 __func__, __LINE__, sym->name, sym->start, addr, sym->end);
881 return -ERANGE;
882 }
883
884 offset = addr - sym->start;
885 h = annotated_source__histogram(src, evidx);
886 if (h == NULL) {
887 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
888 __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
889 return -ENOMEM;
890 }
891 h->nr_samples++;
892 h->addr[offset].nr_samples++;
893 h->period += sample->period;
894 h->addr[offset].period += sample->period;
895
896 pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
897 ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
898 sym->start, sym->name, addr, addr - sym->start, evidx,
899 h->addr[offset].nr_samples, h->addr[offset].period);
900 return 0;
901}
902
903static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
904{
905 struct annotation *notes = symbol__annotation(sym);
906
907 if (notes->src == NULL) {
908 notes->src = annotated_source__new();
909 if (notes->src == NULL)
910 return NULL;
911 goto alloc_cycles_hist;
912 }
913
914 if (!notes->src->cycles_hist) {
915alloc_cycles_hist:
916 symbol__alloc_hist_cycles(sym);
917 }
918
919 return notes->src->cycles_hist;
920}
921
922struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
923{
924 struct annotation *notes = symbol__annotation(sym);
925
926 if (notes->src == NULL) {
927 notes->src = annotated_source__new();
928 if (notes->src == NULL)
929 return NULL;
930 goto alloc_histograms;
931 }
932
933 if (notes->src->histograms == NULL) {
934alloc_histograms:
935 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
936 nr_hists);
937 }
938
939 return notes->src;
940}
941
942static int symbol__inc_addr_samples(struct map_symbol *ms,
943 struct evsel *evsel, u64 addr,
944 struct perf_sample *sample)
945{
946 struct symbol *sym = ms->sym;
947 struct annotated_source *src;
948
949 if (sym == NULL)
950 return 0;
951 src = symbol__hists(sym, evsel->evlist->core.nr_entries);
952 return src ? __symbol__inc_addr_samples(ms, src, evsel->idx, addr, sample) : 0;
953}
954
955static int symbol__account_cycles(u64 addr, u64 start,
956 struct symbol *sym, unsigned cycles)
957{
958 struct cyc_hist *cycles_hist;
959 unsigned offset;
960
961 if (sym == NULL)
962 return 0;
963 cycles_hist = symbol__cycles_hist(sym);
964 if (cycles_hist == NULL)
965 return -ENOMEM;
966 if (addr < sym->start || addr >= sym->end)
967 return -ERANGE;
968
969 if (start) {
970 if (start < sym->start || start >= sym->end)
971 return -ERANGE;
972 if (start >= addr)
973 start = 0;
974 }
975 offset = addr - sym->start;
976 return __symbol__account_cycles(cycles_hist,
977 start ? start - sym->start : 0,
978 offset, cycles,
979 !!start);
980}
981
982int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
983 struct addr_map_symbol *start,
984 unsigned cycles)
985{
986 u64 saddr = 0;
987 int err;
988
989 if (!cycles)
990 return 0;
991
992 /*
993 * Only set start when IPC can be computed. We can only
994 * compute it when the basic block is completely in a single
995 * function.
996 * Special case the case when the jump is elsewhere, but
997 * it starts on the function start.
998 */
999 if (start &&
1000 (start->ms.sym == ams->ms.sym ||
1001 (ams->ms.sym &&
1002 start->addr == ams->ms.sym->start + ams->ms.map->start)))
1003 saddr = start->al_addr;
1004 if (saddr == 0)
1005 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
1006 ams->addr,
1007 start ? start->addr : 0,
1008 ams->ms.sym ? ams->ms.sym->start + ams->ms.map->start : 0,
1009 saddr);
1010 err = symbol__account_cycles(ams->al_addr, saddr, ams->ms.sym, cycles);
1011 if (err)
1012 pr_debug2("account_cycles failed %d\n", err);
1013 return err;
1014}
1015
1016static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1017{
1018 unsigned n_insn = 0;
1019 u64 offset;
1020
1021 for (offset = start; offset <= end; offset++) {
1022 if (notes->offsets[offset])
1023 n_insn++;
1024 }
1025 return n_insn;
1026}
1027
1028static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1029{
1030 unsigned n_insn;
1031 unsigned int cover_insn = 0;
1032 u64 offset;
1033
1034 n_insn = annotation__count_insn(notes, start, end);
1035 if (n_insn && ch->num && ch->cycles) {
1036 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1037
1038 /* Hide data when there are too many overlaps. */
1039 if (ch->reset >= 0x7fff)
1040 return;
1041
1042 for (offset = start; offset <= end; offset++) {
1043 struct annotation_line *al = notes->offsets[offset];
1044
1045 if (al && al->ipc == 0.0) {
1046 al->ipc = ipc;
1047 cover_insn++;
1048 }
1049 }
1050
1051 if (cover_insn) {
1052 notes->hit_cycles += ch->cycles;
1053 notes->hit_insn += n_insn * ch->num;
1054 notes->cover_insn += cover_insn;
1055 }
1056 }
1057}
1058
1059void annotation__compute_ipc(struct annotation *notes, size_t size)
1060{
1061 s64 offset;
1062
1063 if (!notes->src || !notes->src->cycles_hist)
1064 return;
1065
1066 notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1067 notes->hit_cycles = 0;
1068 notes->hit_insn = 0;
1069 notes->cover_insn = 0;
1070
1071 pthread_mutex_lock(¬es->lock);
1072 for (offset = size - 1; offset >= 0; --offset) {
1073 struct cyc_hist *ch;
1074
1075 ch = ¬es->src->cycles_hist[offset];
1076 if (ch && ch->cycles) {
1077 struct annotation_line *al;
1078
1079 if (ch->have_start)
1080 annotation__count_and_fill(notes, ch->start, offset, ch);
1081 al = notes->offsets[offset];
1082 if (al && ch->num_aggr) {
1083 al->cycles = ch->cycles_aggr / ch->num_aggr;
1084 al->cycles_max = ch->cycles_max;
1085 al->cycles_min = ch->cycles_min;
1086 }
1087 notes->have_cycles = true;
1088 }
1089 }
1090 pthread_mutex_unlock(¬es->lock);
1091}
1092
1093int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1094 struct evsel *evsel)
1095{
1096 return symbol__inc_addr_samples(&ams->ms, evsel, ams->al_addr, sample);
1097}
1098
1099int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1100 struct evsel *evsel, u64 ip)
1101{
1102 return symbol__inc_addr_samples(&he->ms, evsel, ip, sample);
1103}
1104
1105static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1106{
1107 dl->ins.ops = ins__find(arch, dl->ins.name);
1108
1109 if (!dl->ins.ops)
1110 return;
1111
1112 if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1113 dl->ins.ops = NULL;
1114}
1115
1116static int disasm_line__parse(char *line, const char **namep, char **rawp)
1117{
1118 char tmp, *name = skip_spaces(line);
1119
1120 if (name[0] == '\0')
1121 return -1;
1122
1123 *rawp = name + 1;
1124
1125 while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1126 ++*rawp;
1127
1128 tmp = (*rawp)[0];
1129 (*rawp)[0] = '\0';
1130 *namep = strdup(name);
1131
1132 if (*namep == NULL)
1133 goto out;
1134
1135 (*rawp)[0] = tmp;
1136 *rawp = strim(*rawp);
1137
1138 return 0;
1139
1140out:
1141 return -1;
1142}
1143
1144struct annotate_args {
1145 struct arch *arch;
1146 struct map_symbol ms;
1147 struct evsel *evsel;
1148 struct annotation_options *options;
1149 s64 offset;
1150 char *line;
1151 int line_nr;
1152};
1153
1154static void annotation_line__init(struct annotation_line *al,
1155 struct annotate_args *args,
1156 int nr)
1157{
1158 al->offset = args->offset;
1159 al->line = strdup(args->line);
1160 al->line_nr = args->line_nr;
1161 al->data_nr = nr;
1162}
1163
1164static void annotation_line__exit(struct annotation_line *al)
1165{
1166 free_srcline(al->path);
1167 zfree(&al->line);
1168}
1169
1170static size_t disasm_line_size(int nr)
1171{
1172 struct annotation_line *al;
1173
1174 return (sizeof(struct disasm_line) + (sizeof(al->data[0]) * nr));
1175}
1176
1177/*
1178 * Allocating the disasm annotation line data with
1179 * following structure:
1180 *
1181 * -------------------------------------------
1182 * struct disasm_line | struct annotation_line
1183 * -------------------------------------------
1184 *
1185 * We have 'struct annotation_line' member as last member
1186 * of 'struct disasm_line' to have an easy access.
1187 */
1188static struct disasm_line *disasm_line__new(struct annotate_args *args)
1189{
1190 struct disasm_line *dl = NULL;
1191 int nr = 1;
1192
1193 if (evsel__is_group_event(args->evsel))
1194 nr = args->evsel->core.nr_members;
1195
1196 dl = zalloc(disasm_line_size(nr));
1197 if (!dl)
1198 return NULL;
1199
1200 annotation_line__init(&dl->al, args, nr);
1201 if (dl->al.line == NULL)
1202 goto out_delete;
1203
1204 if (args->offset != -1) {
1205 if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1206 goto out_free_line;
1207
1208 disasm_line__init_ins(dl, args->arch, &args->ms);
1209 }
1210
1211 return dl;
1212
1213out_free_line:
1214 zfree(&dl->al.line);
1215out_delete:
1216 free(dl);
1217 return NULL;
1218}
1219
1220void disasm_line__free(struct disasm_line *dl)
1221{
1222 if (dl->ins.ops && dl->ins.ops->free)
1223 dl->ins.ops->free(&dl->ops);
1224 else
1225 ins__delete(&dl->ops);
1226 zfree(&dl->ins.name);
1227 annotation_line__exit(&dl->al);
1228 free(dl);
1229}
1230
1231int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1232{
1233 if (raw || !dl->ins.ops)
1234 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1235
1236 return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1237}
1238
1239static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1240{
1241 list_add_tail(&al->node, head);
1242}
1243
1244struct annotation_line *
1245annotation_line__next(struct annotation_line *pos, struct list_head *head)
1246{
1247 list_for_each_entry_continue(pos, head, node)
1248 if (pos->offset >= 0)
1249 return pos;
1250
1251 return NULL;
1252}
1253
1254static const char *annotate__address_color(struct block_range *br)
1255{
1256 double cov = block_range__coverage(br);
1257
1258 if (cov >= 0) {
1259 /* mark red for >75% coverage */
1260 if (cov > 0.75)
1261 return PERF_COLOR_RED;
1262
1263 /* mark dull for <1% coverage */
1264 if (cov < 0.01)
1265 return PERF_COLOR_NORMAL;
1266 }
1267
1268 return PERF_COLOR_MAGENTA;
1269}
1270
1271static const char *annotate__asm_color(struct block_range *br)
1272{
1273 double cov = block_range__coverage(br);
1274
1275 if (cov >= 0) {
1276 /* mark dull for <1% coverage */
1277 if (cov < 0.01)
1278 return PERF_COLOR_NORMAL;
1279 }
1280
1281 return PERF_COLOR_BLUE;
1282}
1283
1284static void annotate__branch_printf(struct block_range *br, u64 addr)
1285{
1286 bool emit_comment = true;
1287
1288 if (!br)
1289 return;
1290
1291#if 1
1292 if (br->is_target && br->start == addr) {
1293 struct block_range *branch = br;
1294 double p;
1295
1296 /*
1297 * Find matching branch to our target.
1298 */
1299 while (!branch->is_branch)
1300 branch = block_range__next(branch);
1301
1302 p = 100 *(double)br->entry / branch->coverage;
1303
1304 if (p > 0.1) {
1305 if (emit_comment) {
1306 emit_comment = false;
1307 printf("\t#");
1308 }
1309
1310 /*
1311 * The percentage of coverage joined at this target in relation
1312 * to the next branch.
1313 */
1314 printf(" +%.2f%%", p);
1315 }
1316 }
1317#endif
1318 if (br->is_branch && br->end == addr) {
1319 double p = 100*(double)br->taken / br->coverage;
1320
1321 if (p > 0.1) {
1322 if (emit_comment) {
1323 emit_comment = false;
1324 printf("\t#");
1325 }
1326
1327 /*
1328 * The percentage of coverage leaving at this branch, and
1329 * its prediction ratio.
1330 */
1331 printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred / br->taken);
1332 }
1333 }
1334}
1335
1336static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1337{
1338 s64 offset = dl->al.offset;
1339 const u64 addr = start + offset;
1340 struct block_range *br;
1341
1342 br = block_range__find(addr);
1343 color_fprintf(stdout, annotate__address_color(br), " %*" PRIx64 ":", addr_fmt_width, addr);
1344 color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1345 annotate__branch_printf(br, addr);
1346 return 0;
1347}
1348
1349static int
1350annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1351 struct evsel *evsel, u64 len, int min_pcnt, int printed,
1352 int max_lines, struct annotation_line *queue, int addr_fmt_width,
1353 int percent_type)
1354{
1355 struct disasm_line *dl = container_of(al, struct disasm_line, al);
1356 static const char *prev_line;
1357 static const char *prev_color;
1358
1359 if (al->offset != -1) {
1360 double max_percent = 0.0;
1361 int i, nr_percent = 1;
1362 const char *color;
1363 struct annotation *notes = symbol__annotation(sym);
1364
1365 for (i = 0; i < al->data_nr; i++) {
1366 double percent;
1367
1368 percent = annotation_data__percent(&al->data[i],
1369 percent_type);
1370
1371 if (percent > max_percent)
1372 max_percent = percent;
1373 }
1374
1375 if (al->data_nr > nr_percent)
1376 nr_percent = al->data_nr;
1377
1378 if (max_percent < min_pcnt)
1379 return -1;
1380
1381 if (max_lines && printed >= max_lines)
1382 return 1;
1383
1384 if (queue != NULL) {
1385 list_for_each_entry_from(queue, ¬es->src->source, node) {
1386 if (queue == al)
1387 break;
1388 annotation_line__print(queue, sym, start, evsel, len,
1389 0, 0, 1, NULL, addr_fmt_width,
1390 percent_type);
1391 }
1392 }
1393
1394 color = get_percent_color(max_percent);
1395
1396 /*
1397 * Also color the filename and line if needed, with
1398 * the same color than the percentage. Don't print it
1399 * twice for close colored addr with the same filename:line
1400 */
1401 if (al->path) {
1402 if (!prev_line || strcmp(prev_line, al->path)
1403 || color != prev_color) {
1404 color_fprintf(stdout, color, " %s", al->path);
1405 prev_line = al->path;
1406 prev_color = color;
1407 }
1408 }
1409
1410 for (i = 0; i < nr_percent; i++) {
1411 struct annotation_data *data = &al->data[i];
1412 double percent;
1413
1414 percent = annotation_data__percent(data, percent_type);
1415 color = get_percent_color(percent);
1416
1417 if (symbol_conf.show_total_period)
1418 color_fprintf(stdout, color, " %11" PRIu64,
1419 data->he.period);
1420 else if (symbol_conf.show_nr_samples)
1421 color_fprintf(stdout, color, " %7" PRIu64,
1422 data->he.nr_samples);
1423 else
1424 color_fprintf(stdout, color, " %7.2f", percent);
1425 }
1426
1427 printf(" : ");
1428
1429 disasm_line__print(dl, start, addr_fmt_width);
1430 printf("\n");
1431 } else if (max_lines && printed >= max_lines)
1432 return 1;
1433 else {
1434 int width = symbol_conf.show_total_period ? 12 : 8;
1435
1436 if (queue)
1437 return -1;
1438
1439 if (evsel__is_group_event(evsel))
1440 width *= evsel->core.nr_members;
1441
1442 if (!*al->line)
1443 printf(" %*s:\n", width, " ");
1444 else
1445 printf(" %*s: %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1446 }
1447
1448 return 0;
1449}
1450
1451/*
1452 * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1453 * which looks like following
1454 *
1455 * 0000000000415500 <_init>:
1456 * 415500: sub $0x8,%rsp
1457 * 415504: mov 0x2f5ad5(%rip),%rax # 70afe0 <_DYNAMIC+0x2f8>
1458 * 41550b: test %rax,%rax
1459 * 41550e: je 415515 <_init+0x15>
1460 * 415510: callq 416e70 <__gmon_start__@plt>
1461 * 415515: add $0x8,%rsp
1462 * 415519: retq
1463 *
1464 * it will be parsed and saved into struct disasm_line as
1465 * <offset> <name> <ops.raw>
1466 *
1467 * The offset will be a relative offset from the start of the symbol and -1
1468 * means that it's not a disassembly line so should be treated differently.
1469 * The ops.raw part will be parsed further according to type of the instruction.
1470 */
1471static int symbol__parse_objdump_line(struct symbol *sym,
1472 struct annotate_args *args,
1473 char *parsed_line, int *line_nr)
1474{
1475 struct map *map = args->ms.map;
1476 struct annotation *notes = symbol__annotation(sym);
1477 struct disasm_line *dl;
1478 char *tmp;
1479 s64 line_ip, offset = -1;
1480 regmatch_t match[2];
1481
1482 /* /filename:linenr ? Save line number and ignore. */
1483 if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1484 *line_nr = atoi(parsed_line + match[1].rm_so);
1485 return 0;
1486 }
1487
1488 /* Process hex address followed by ':'. */
1489 line_ip = strtoull(parsed_line, &tmp, 16);
1490 if (parsed_line != tmp && tmp[0] == ':' && tmp[1] != '\0') {
1491 u64 start = map__rip_2objdump(map, sym->start),
1492 end = map__rip_2objdump(map, sym->end);
1493
1494 offset = line_ip - start;
1495 if ((u64)line_ip < start || (u64)line_ip >= end)
1496 offset = -1;
1497 else
1498 parsed_line = tmp + 1;
1499 }
1500
1501 args->offset = offset;
1502 args->line = parsed_line;
1503 args->line_nr = *line_nr;
1504 args->ms.sym = sym;
1505
1506 dl = disasm_line__new(args);
1507 (*line_nr)++;
1508
1509 if (dl == NULL)
1510 return -1;
1511
1512 if (!disasm_line__has_local_offset(dl)) {
1513 dl->ops.target.offset = dl->ops.target.addr -
1514 map__rip_2objdump(map, sym->start);
1515 dl->ops.target.offset_avail = true;
1516 }
1517
1518 /* kcore has no symbols, so add the call target symbol */
1519 if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1520 struct addr_map_symbol target = {
1521 .addr = dl->ops.target.addr,
1522 .ms = { .map = map, },
1523 };
1524
1525 if (!maps__find_ams(args->ms.maps, &target) &&
1526 target.ms.sym->start == target.al_addr)
1527 dl->ops.target.sym = target.ms.sym;
1528 }
1529
1530 annotation_line__add(&dl->al, ¬es->src->source);
1531
1532 return 0;
1533}
1534
1535static __attribute__((constructor)) void symbol__init_regexpr(void)
1536{
1537 regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1538}
1539
1540static void delete_last_nop(struct symbol *sym)
1541{
1542 struct annotation *notes = symbol__annotation(sym);
1543 struct list_head *list = ¬es->src->source;
1544 struct disasm_line *dl;
1545
1546 while (!list_empty(list)) {
1547 dl = list_entry(list->prev, struct disasm_line, al.node);
1548
1549 if (dl->ins.ops) {
1550 if (dl->ins.ops != &nop_ops)
1551 return;
1552 } else {
1553 if (!strstr(dl->al.line, " nop ") &&
1554 !strstr(dl->al.line, " nopl ") &&
1555 !strstr(dl->al.line, " nopw "))
1556 return;
1557 }
1558
1559 list_del_init(&dl->al.node);
1560 disasm_line__free(dl);
1561 }
1562}
1563
1564int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen)
1565{
1566 struct dso *dso = ms->map->dso;
1567
1568 BUG_ON(buflen == 0);
1569
1570 if (errnum >= 0) {
1571 str_error_r(errnum, buf, buflen);
1572 return 0;
1573 }
1574
1575 switch (errnum) {
1576 case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1577 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1578 char *build_id_msg = NULL;
1579
1580 if (dso->has_build_id) {
1581 build_id__sprintf(dso->build_id,
1582 sizeof(dso->build_id), bf + 15);
1583 build_id_msg = bf;
1584 }
1585 scnprintf(buf, buflen,
1586 "No vmlinux file%s\nwas found in the path.\n\n"
1587 "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1588 "Please use:\n\n"
1589 " perf buildid-cache -vu vmlinux\n\n"
1590 "or:\n\n"
1591 " --vmlinux vmlinux\n", build_id_msg ?: "");
1592 }
1593 break;
1594 case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1595 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1596 break;
1597 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP:
1598 scnprintf(buf, buflen, "Problems with arch specific instruction name regular expressions.");
1599 break;
1600 case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING:
1601 scnprintf(buf, buflen, "Problems while parsing the CPUID in the arch specific initialization.");
1602 break;
1603 case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE:
1604 scnprintf(buf, buflen, "Invalid BPF file: %s.", dso->long_name);
1605 break;
1606 case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF:
1607 scnprintf(buf, buflen, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1608 dso->long_name);
1609 break;
1610 default:
1611 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1612 break;
1613 }
1614
1615 return 0;
1616}
1617
1618static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1619{
1620 char linkname[PATH_MAX];
1621 char *build_id_filename;
1622 char *build_id_path = NULL;
1623 char *pos;
1624 int len;
1625
1626 if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1627 !dso__is_kcore(dso))
1628 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1629
1630 build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1631 if (build_id_filename) {
1632 __symbol__join_symfs(filename, filename_size, build_id_filename);
1633 free(build_id_filename);
1634 } else {
1635 if (dso->has_build_id)
1636 return ENOMEM;
1637 goto fallback;
1638 }
1639
1640 build_id_path = strdup(filename);
1641 if (!build_id_path)
1642 return ENOMEM;
1643
1644 /*
1645 * old style build-id cache has name of XX/XXXXXXX.. while
1646 * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1647 * extract the build-id part of dirname in the new style only.
1648 */
1649 pos = strrchr(build_id_path, '/');
1650 if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1651 dirname(build_id_path);
1652
1653 if (dso__is_kcore(dso))
1654 goto fallback;
1655
1656 len = readlink(build_id_path, linkname, sizeof(linkname) - 1);
1657 if (len < 0)
1658 goto fallback;
1659
1660 linkname[len] = '\0';
1661 if (strstr(linkname, DSO__NAME_KALLSYMS) ||
1662 access(filename, R_OK)) {
1663fallback:
1664 /*
1665 * If we don't have build-ids or the build-id file isn't in the
1666 * cache, or is just a kallsyms file, well, lets hope that this
1667 * DSO is the same as when 'perf record' ran.
1668 */
1669 __symbol__join_symfs(filename, filename_size, dso->long_name);
1670 }
1671
1672 free(build_id_path);
1673 return 0;
1674}
1675
1676#if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1677#define PACKAGE "perf"
1678#include <bfd.h>
1679#include <dis-asm.h>
1680
1681static int symbol__disassemble_bpf(struct symbol *sym,
1682 struct annotate_args *args)
1683{
1684 struct annotation *notes = symbol__annotation(sym);
1685 struct annotation_options *opts = args->options;
1686 struct bpf_prog_info_linear *info_linear;
1687 struct bpf_prog_linfo *prog_linfo = NULL;
1688 struct bpf_prog_info_node *info_node;
1689 int len = sym->end - sym->start;
1690 disassembler_ftype disassemble;
1691 struct map *map = args->ms.map;
1692 struct disassemble_info info;
1693 struct dso *dso = map->dso;
1694 int pc = 0, count, sub_id;
1695 struct btf *btf = NULL;
1696 char tpath[PATH_MAX];
1697 size_t buf_size;
1698 int nr_skip = 0;
1699 char *buf;
1700 bfd *bfdf;
1701 int ret;
1702 FILE *s;
1703
1704 if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1705 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE;
1706
1707 pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1708 sym->name, sym->start, sym->end - sym->start);
1709
1710 memset(tpath, 0, sizeof(tpath));
1711 perf_exe(tpath, sizeof(tpath));
1712
1713 bfdf = bfd_openr(tpath, NULL);
1714 assert(bfdf);
1715 assert(bfd_check_format(bfdf, bfd_object));
1716
1717 s = open_memstream(&buf, &buf_size);
1718 if (!s) {
1719 ret = errno;
1720 goto out;
1721 }
1722 init_disassemble_info(&info, s,
1723 (fprintf_ftype) fprintf);
1724
1725 info.arch = bfd_get_arch(bfdf);
1726 info.mach = bfd_get_mach(bfdf);
1727
1728 info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1729 dso->bpf_prog.id);
1730 if (!info_node) {
1731 ret = SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF;
1732 goto out;
1733 }
1734 info_linear = info_node->info_linear;
1735 sub_id = dso->bpf_prog.sub_id;
1736
1737 info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1738 info.buffer_length = info_linear->info.jited_prog_len;
1739
1740 if (info_linear->info.nr_line_info)
1741 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1742
1743 if (info_linear->info.btf_id) {
1744 struct btf_node *node;
1745
1746 node = perf_env__find_btf(dso->bpf_prog.env,
1747 info_linear->info.btf_id);
1748 if (node)
1749 btf = btf__new((__u8 *)(node->data),
1750 node->data_size);
1751 }
1752
1753 disassemble_init_for_target(&info);
1754
1755#ifdef DISASM_FOUR_ARGS_SIGNATURE
1756 disassemble = disassembler(info.arch,
1757 bfd_big_endian(bfdf),
1758 info.mach,
1759 bfdf);
1760#else
1761 disassemble = disassembler(bfdf);
1762#endif
1763 assert(disassemble);
1764
1765 fflush(s);
1766 do {
1767 const struct bpf_line_info *linfo = NULL;
1768 struct disasm_line *dl;
1769 size_t prev_buf_size;
1770 const char *srcline;
1771 u64 addr;
1772
1773 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1774 count = disassemble(pc, &info);
1775
1776 if (prog_linfo)
1777 linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1778 addr, sub_id,
1779 nr_skip);
1780
1781 if (linfo && btf) {
1782 srcline = btf__name_by_offset(btf, linfo->line_off);
1783 nr_skip++;
1784 } else
1785 srcline = NULL;
1786
1787 fprintf(s, "\n");
1788 prev_buf_size = buf_size;
1789 fflush(s);
1790
1791 if (!opts->hide_src_code && srcline) {
1792 args->offset = -1;
1793 args->line = strdup(srcline);
1794 args->line_nr = 0;
1795 args->ms.sym = sym;
1796 dl = disasm_line__new(args);
1797 if (dl) {
1798 annotation_line__add(&dl->al,
1799 ¬es->src->source);
1800 }
1801 }
1802
1803 args->offset = pc;
1804 args->line = buf + prev_buf_size;
1805 args->line_nr = 0;
1806 args->ms.sym = sym;
1807 dl = disasm_line__new(args);
1808 if (dl)
1809 annotation_line__add(&dl->al, ¬es->src->source);
1810
1811 pc += count;
1812 } while (count > 0 && pc < len);
1813
1814 ret = 0;
1815out:
1816 free(prog_linfo);
1817 free(btf);
1818 fclose(s);
1819 bfd_close(bfdf);
1820 return ret;
1821}
1822#else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1823static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1824 struct annotate_args *args __maybe_unused)
1825{
1826 return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1827}
1828#endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1829
1830static int
1831symbol__disassemble_bpf_image(struct symbol *sym,
1832 struct annotate_args *args)
1833{
1834 struct annotation *notes = symbol__annotation(sym);
1835 struct disasm_line *dl;
1836
1837 args->offset = -1;
1838 args->line = strdup("to be implemented");
1839 args->line_nr = 0;
1840 dl = disasm_line__new(args);
1841 if (dl)
1842 annotation_line__add(&dl->al, ¬es->src->source);
1843
1844 free(args->line);
1845 return 0;
1846}
1847
1848/*
1849 * Possibly create a new version of line with tabs expanded. Returns the
1850 * existing or new line, storage is updated if a new line is allocated. If
1851 * allocation fails then NULL is returned.
1852 */
1853static char *expand_tabs(char *line, char **storage, size_t *storage_len)
1854{
1855 size_t i, src, dst, len, new_storage_len, num_tabs;
1856 char *new_line;
1857 size_t line_len = strlen(line);
1858
1859 for (num_tabs = 0, i = 0; i < line_len; i++)
1860 if (line[i] == '\t')
1861 num_tabs++;
1862
1863 if (num_tabs == 0)
1864 return line;
1865
1866 /*
1867 * Space for the line and '\0', less the leading and trailing
1868 * spaces. Each tab may introduce 7 additional spaces.
1869 */
1870 new_storage_len = line_len + 1 + (num_tabs * 7);
1871
1872 new_line = malloc(new_storage_len);
1873 if (new_line == NULL) {
1874 pr_err("Failure allocating memory for tab expansion\n");
1875 return NULL;
1876 }
1877
1878 /*
1879 * Copy regions starting at src and expand tabs. If there are two
1880 * adjacent tabs then 'src == i', the memcpy is of size 0 and the spaces
1881 * are inserted.
1882 */
1883 for (i = 0, src = 0, dst = 0; i < line_len && num_tabs; i++) {
1884 if (line[i] == '\t') {
1885 len = i - src;
1886 memcpy(&new_line[dst], &line[src], len);
1887 dst += len;
1888 new_line[dst++] = ' ';
1889 while (dst % 8 != 0)
1890 new_line[dst++] = ' ';
1891 src = i + 1;
1892 num_tabs--;
1893 }
1894 }
1895
1896 /* Expand the last region. */
1897 len = line_len - src;
1898 memcpy(&new_line[dst], &line[src], len);
1899 dst += len;
1900 new_line[dst] = '\0';
1901
1902 free(*storage);
1903 *storage = new_line;
1904 *storage_len = new_storage_len;
1905 return new_line;
1906
1907}
1908
1909static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1910{
1911 struct annotation_options *opts = args->options;
1912 struct map *map = args->ms.map;
1913 struct dso *dso = map->dso;
1914 char *command;
1915 FILE *file;
1916 char symfs_filename[PATH_MAX];
1917 struct kcore_extract kce;
1918 bool delete_extract = false;
1919 bool decomp = false;
1920 int lineno = 0;
1921 int nline;
1922 char *line;
1923 size_t line_len;
1924 const char *objdump_argv[] = {
1925 "/bin/sh",
1926 "-c",
1927 NULL, /* Will be the objdump command to run. */
1928 "--",
1929 NULL, /* Will be the symfs path. */
1930 NULL,
1931 };
1932 struct child_process objdump_process;
1933 int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1934
1935 if (err)
1936 return err;
1937
1938 pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1939 symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1940 map->unmap_ip(map, sym->end));
1941
1942 pr_debug("annotating [%p] %30s : [%p] %30s\n",
1943 dso, dso->long_name, sym, sym->name);
1944
1945 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1946 return symbol__disassemble_bpf(sym, args);
1947 } else if (dso->binary_type == DSO_BINARY_TYPE__BPF_IMAGE) {
1948 return symbol__disassemble_bpf_image(sym, args);
1949 } else if (dso__is_kcore(dso)) {
1950 kce.kcore_filename = symfs_filename;
1951 kce.addr = map__rip_2objdump(map, sym->start);
1952 kce.offs = sym->start;
1953 kce.len = sym->end - sym->start;
1954 if (!kcore_extract__create(&kce)) {
1955 delete_extract = true;
1956 strlcpy(symfs_filename, kce.extract_filename,
1957 sizeof(symfs_filename));
1958 }
1959 } else if (dso__needs_decompress(dso)) {
1960 char tmp[KMOD_DECOMP_LEN];
1961
1962 if (dso__decompress_kmodule_path(dso, symfs_filename,
1963 tmp, sizeof(tmp)) < 0)
1964 return -1;
1965
1966 decomp = true;
1967 strcpy(symfs_filename, tmp);
1968 }
1969
1970 err = asprintf(&command,
1971 "%s %s%s --start-address=0x%016" PRIx64
1972 " --stop-address=0x%016" PRIx64
1973 " -l -d %s %s %s %c%s%c %s%s -C \"$1\"",
1974 opts->objdump_path ?: "objdump",
1975 opts->disassembler_style ? "-M " : "",
1976 opts->disassembler_style ?: "",
1977 map__rip_2objdump(map, sym->start),
1978 map__rip_2objdump(map, sym->end),
1979 opts->show_asm_raw ? "" : "--no-show-raw-insn",
1980 opts->annotate_src ? "-S" : "",
1981 opts->prefix ? "--prefix " : "",
1982 opts->prefix ? '"' : ' ',
1983 opts->prefix ?: "",
1984 opts->prefix ? '"' : ' ',
1985 opts->prefix_strip ? "--prefix-strip=" : "",
1986 opts->prefix_strip ?: "");
1987
1988 if (err < 0) {
1989 pr_err("Failure allocating memory for the command to run\n");
1990 goto out_remove_tmp;
1991 }
1992
1993 pr_debug("Executing: %s\n", command);
1994
1995 objdump_argv[2] = command;
1996 objdump_argv[4] = symfs_filename;
1997
1998 /* Create a pipe to read from for stdout */
1999 memset(&objdump_process, 0, sizeof(objdump_process));
2000 objdump_process.argv = objdump_argv;
2001 objdump_process.out = -1;
2002 if (start_command(&objdump_process)) {
2003 pr_err("Failure starting to run %s\n", command);
2004 err = -1;
2005 goto out_free_command;
2006 }
2007
2008 file = fdopen(objdump_process.out, "r");
2009 if (!file) {
2010 pr_err("Failure creating FILE stream for %s\n", command);
2011 /*
2012 * If we were using debug info should retry with
2013 * original binary.
2014 */
2015 err = -1;
2016 goto out_close_stdout;
2017 }
2018
2019 /* Storage for getline. */
2020 line = NULL;
2021 line_len = 0;
2022
2023 nline = 0;
2024 while (!feof(file)) {
2025 const char *match;
2026 char *expanded_line;
2027
2028 if (getline(&line, &line_len, file) < 0 || !line)
2029 break;
2030
2031 /* Skip lines containing "filename:" */
2032 match = strstr(line, symfs_filename);
2033 if (match && match[strlen(symfs_filename)] == ':')
2034 continue;
2035
2036 expanded_line = strim(line);
2037 expanded_line = expand_tabs(expanded_line, &line, &line_len);
2038 if (!expanded_line)
2039 break;
2040
2041 /*
2042 * The source code line number (lineno) needs to be kept in
2043 * across calls to symbol__parse_objdump_line(), so that it
2044 * can associate it with the instructions till the next one.
2045 * See disasm_line__new() and struct disasm_line::line_nr.
2046 */
2047 if (symbol__parse_objdump_line(sym, args, expanded_line,
2048 &lineno) < 0)
2049 break;
2050 nline++;
2051 }
2052 free(line);
2053
2054 err = finish_command(&objdump_process);
2055 if (err)
2056 pr_err("Error running %s\n", command);
2057
2058 if (nline == 0) {
2059 err = -1;
2060 pr_err("No output from %s\n", command);
2061 }
2062
2063 /*
2064 * kallsyms does not have symbol sizes so there may a nop at the end.
2065 * Remove it.
2066 */
2067 if (dso__is_kcore(dso))
2068 delete_last_nop(sym);
2069
2070 fclose(file);
2071
2072out_close_stdout:
2073 close(objdump_process.out);
2074
2075out_free_command:
2076 free(command);
2077
2078out_remove_tmp:
2079 if (decomp)
2080 unlink(symfs_filename);
2081
2082 if (delete_extract)
2083 kcore_extract__delete(&kce);
2084
2085 return err;
2086}
2087
2088static void calc_percent(struct sym_hist *sym_hist,
2089 struct hists *hists,
2090 struct annotation_data *data,
2091 s64 offset, s64 end)
2092{
2093 unsigned int hits = 0;
2094 u64 period = 0;
2095
2096 while (offset < end) {
2097 hits += sym_hist->addr[offset].nr_samples;
2098 period += sym_hist->addr[offset].period;
2099 ++offset;
2100 }
2101
2102 if (sym_hist->nr_samples) {
2103 data->he.period = period;
2104 data->he.nr_samples = hits;
2105 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2106 }
2107
2108 if (hists->stats.nr_non_filtered_samples)
2109 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2110
2111 if (sym_hist->period)
2112 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2113
2114 if (hists->stats.total_period)
2115 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2116}
2117
2118static void annotation__calc_percent(struct annotation *notes,
2119 struct evsel *leader, s64 len)
2120{
2121 struct annotation_line *al, *next;
2122 struct evsel *evsel;
2123
2124 list_for_each_entry(al, ¬es->src->source, node) {
2125 s64 end;
2126 int i = 0;
2127
2128 if (al->offset == -1)
2129 continue;
2130
2131 next = annotation_line__next(al, ¬es->src->source);
2132 end = next ? next->offset : len;
2133
2134 for_each_group_evsel(evsel, leader) {
2135 struct hists *hists = evsel__hists(evsel);
2136 struct annotation_data *data;
2137 struct sym_hist *sym_hist;
2138
2139 BUG_ON(i >= al->data_nr);
2140
2141 sym_hist = annotation__histogram(notes, evsel->idx);
2142 data = &al->data[i++];
2143
2144 calc_percent(sym_hist, hists, data, al->offset, end);
2145 }
2146 }
2147}
2148
2149void symbol__calc_percent(struct symbol *sym, struct evsel *evsel)
2150{
2151 struct annotation *notes = symbol__annotation(sym);
2152
2153 annotation__calc_percent(notes, evsel, symbol__size(sym));
2154}
2155
2156int symbol__annotate(struct map_symbol *ms, struct evsel *evsel,
2157 struct annotation_options *options, struct arch **parch)
2158{
2159 struct symbol *sym = ms->sym;
2160 struct annotation *notes = symbol__annotation(sym);
2161 struct annotate_args args = {
2162 .evsel = evsel,
2163 .options = options,
2164 };
2165 struct perf_env *env = evsel__env(evsel);
2166 const char *arch_name = perf_env__arch(env);
2167 struct arch *arch;
2168 int err;
2169
2170 if (!arch_name)
2171 return errno;
2172
2173 args.arch = arch = arch__find(arch_name);
2174 if (arch == NULL)
2175 return ENOTSUP;
2176
2177 if (parch)
2178 *parch = arch;
2179
2180 if (arch->init) {
2181 err = arch->init(arch, env ? env->cpuid : NULL);
2182 if (err) {
2183 pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2184 return err;
2185 }
2186 }
2187
2188 args.ms = *ms;
2189 notes->start = map__rip_2objdump(ms->map, sym->start);
2190
2191 return symbol__disassemble(sym, &args);
2192}
2193
2194static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2195 struct annotation_options *opts)
2196{
2197 struct annotation_line *iter;
2198 struct rb_node **p = &root->rb_node;
2199 struct rb_node *parent = NULL;
2200 int i, ret;
2201
2202 while (*p != NULL) {
2203 parent = *p;
2204 iter = rb_entry(parent, struct annotation_line, rb_node);
2205
2206 ret = strcmp(iter->path, al->path);
2207 if (ret == 0) {
2208 for (i = 0; i < al->data_nr; i++) {
2209 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2210 opts->percent_type);
2211 }
2212 return;
2213 }
2214
2215 if (ret < 0)
2216 p = &(*p)->rb_left;
2217 else
2218 p = &(*p)->rb_right;
2219 }
2220
2221 for (i = 0; i < al->data_nr; i++) {
2222 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2223 opts->percent_type);
2224 }
2225
2226 rb_link_node(&al->rb_node, parent, p);
2227 rb_insert_color(&al->rb_node, root);
2228}
2229
2230static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2231{
2232 int i;
2233
2234 for (i = 0; i < a->data_nr; i++) {
2235 if (a->data[i].percent_sum == b->data[i].percent_sum)
2236 continue;
2237 return a->data[i].percent_sum > b->data[i].percent_sum;
2238 }
2239
2240 return 0;
2241}
2242
2243static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2244{
2245 struct annotation_line *iter;
2246 struct rb_node **p = &root->rb_node;
2247 struct rb_node *parent = NULL;
2248
2249 while (*p != NULL) {
2250 parent = *p;
2251 iter = rb_entry(parent, struct annotation_line, rb_node);
2252
2253 if (cmp_source_line(al, iter))
2254 p = &(*p)->rb_left;
2255 else
2256 p = &(*p)->rb_right;
2257 }
2258
2259 rb_link_node(&al->rb_node, parent, p);
2260 rb_insert_color(&al->rb_node, root);
2261}
2262
2263static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2264{
2265 struct annotation_line *al;
2266 struct rb_node *node;
2267
2268 node = rb_first(src_root);
2269 while (node) {
2270 struct rb_node *next;
2271
2272 al = rb_entry(node, struct annotation_line, rb_node);
2273 next = rb_next(node);
2274 rb_erase(node, src_root);
2275
2276 __resort_source_line(dest_root, al);
2277 node = next;
2278 }
2279}
2280
2281static void print_summary(struct rb_root *root, const char *filename)
2282{
2283 struct annotation_line *al;
2284 struct rb_node *node;
2285
2286 printf("\nSorted summary for file %s\n", filename);
2287 printf("----------------------------------------------\n\n");
2288
2289 if (RB_EMPTY_ROOT(root)) {
2290 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2291 return;
2292 }
2293
2294 node = rb_first(root);
2295 while (node) {
2296 double percent, percent_max = 0.0;
2297 const char *color;
2298 char *path;
2299 int i;
2300
2301 al = rb_entry(node, struct annotation_line, rb_node);
2302 for (i = 0; i < al->data_nr; i++) {
2303 percent = al->data[i].percent_sum;
2304 color = get_percent_color(percent);
2305 color_fprintf(stdout, color, " %7.2f", percent);
2306
2307 if (percent > percent_max)
2308 percent_max = percent;
2309 }
2310
2311 path = al->path;
2312 color = get_percent_color(percent_max);
2313 color_fprintf(stdout, color, " %s\n", path);
2314
2315 node = rb_next(node);
2316 }
2317}
2318
2319static void symbol__annotate_hits(struct symbol *sym, struct evsel *evsel)
2320{
2321 struct annotation *notes = symbol__annotation(sym);
2322 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2323 u64 len = symbol__size(sym), offset;
2324
2325 for (offset = 0; offset < len; ++offset)
2326 if (h->addr[offset].nr_samples != 0)
2327 printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2328 sym->start + offset, h->addr[offset].nr_samples);
2329 printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2330}
2331
2332static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2333{
2334 char bf[32];
2335 struct annotation_line *line;
2336
2337 list_for_each_entry_reverse(line, lines, node) {
2338 if (line->offset != -1)
2339 return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2340 }
2341
2342 return 0;
2343}
2344
2345int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
2346 struct annotation_options *opts)
2347{
2348 struct map *map = ms->map;
2349 struct symbol *sym = ms->sym;
2350 struct dso *dso = map->dso;
2351 char *filename;
2352 const char *d_filename;
2353 const char *evsel_name = evsel__name(evsel);
2354 struct annotation *notes = symbol__annotation(sym);
2355 struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2356 struct annotation_line *pos, *queue = NULL;
2357 u64 start = map__rip_2objdump(map, sym->start);
2358 int printed = 2, queue_len = 0, addr_fmt_width;
2359 int more = 0;
2360 bool context = opts->context;
2361 u64 len;
2362 int width = symbol_conf.show_total_period ? 12 : 8;
2363 int graph_dotted_len;
2364 char buf[512];
2365
2366 filename = strdup(dso->long_name);
2367 if (!filename)
2368 return -ENOMEM;
2369
2370 if (opts->full_path)
2371 d_filename = filename;
2372 else
2373 d_filename = basename(filename);
2374
2375 len = symbol__size(sym);
2376
2377 if (evsel__is_group_event(evsel)) {
2378 width *= evsel->core.nr_members;
2379 evsel__group_desc(evsel, buf, sizeof(buf));
2380 evsel_name = buf;
2381 }
2382
2383 graph_dotted_len = printf(" %-*.*s| Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2384 "percent: %s)\n",
2385 width, width, symbol_conf.show_total_period ? "Period" :
2386 symbol_conf.show_nr_samples ? "Samples" : "Percent",
2387 d_filename, evsel_name, h->nr_samples,
2388 percent_type_str(opts->percent_type));
2389
2390 printf("%-*.*s----\n",
2391 graph_dotted_len, graph_dotted_len, graph_dotted_line);
2392
2393 if (verbose > 0)
2394 symbol__annotate_hits(sym, evsel);
2395
2396 addr_fmt_width = annotated_source__addr_fmt_width(¬es->src->source, start);
2397
2398 list_for_each_entry(pos, ¬es->src->source, node) {
2399 int err;
2400
2401 if (context && queue == NULL) {
2402 queue = pos;
2403 queue_len = 0;
2404 }
2405
2406 err = annotation_line__print(pos, sym, start, evsel, len,
2407 opts->min_pcnt, printed, opts->max_lines,
2408 queue, addr_fmt_width, opts->percent_type);
2409
2410 switch (err) {
2411 case 0:
2412 ++printed;
2413 if (context) {
2414 printed += queue_len;
2415 queue = NULL;
2416 queue_len = 0;
2417 }
2418 break;
2419 case 1:
2420 /* filtered by max_lines */
2421 ++more;
2422 break;
2423 case -1:
2424 default:
2425 /*
2426 * Filtered by min_pcnt or non IP lines when
2427 * context != 0
2428 */
2429 if (!context)
2430 break;
2431 if (queue_len == context)
2432 queue = list_entry(queue->node.next, typeof(*queue), node);
2433 else
2434 ++queue_len;
2435 break;
2436 }
2437 }
2438
2439 free(filename);
2440
2441 return more;
2442}
2443
2444static void FILE__set_percent_color(void *fp __maybe_unused,
2445 double percent __maybe_unused,
2446 bool current __maybe_unused)
2447{
2448}
2449
2450static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2451 int nr __maybe_unused, bool current __maybe_unused)
2452{
2453 return 0;
2454}
2455
2456static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2457{
2458 return 0;
2459}
2460
2461static void FILE__printf(void *fp, const char *fmt, ...)
2462{
2463 va_list args;
2464
2465 va_start(args, fmt);
2466 vfprintf(fp, fmt, args);
2467 va_end(args);
2468}
2469
2470static void FILE__write_graph(void *fp, int graph)
2471{
2472 const char *s;
2473 switch (graph) {
2474
2475 case DARROW_CHAR: s = "↓"; break;
2476 case UARROW_CHAR: s = "↑"; break;
2477 case LARROW_CHAR: s = "←"; break;
2478 case RARROW_CHAR: s = "→"; break;
2479 default: s = "?"; break;
2480 }
2481
2482 fputs(s, fp);
2483}
2484
2485static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2486 struct annotation_options *opts)
2487{
2488 struct annotation *notes = symbol__annotation(sym);
2489 struct annotation_write_ops wops = {
2490 .first_line = true,
2491 .obj = fp,
2492 .set_color = FILE__set_color,
2493 .set_percent_color = FILE__set_percent_color,
2494 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2495 .printf = FILE__printf,
2496 .write_graph = FILE__write_graph,
2497 };
2498 struct annotation_line *al;
2499
2500 list_for_each_entry(al, ¬es->src->source, node) {
2501 if (annotation_line__filter(al, notes))
2502 continue;
2503 annotation_line__write(al, notes, &wops, opts);
2504 fputc('\n', fp);
2505 wops.first_line = false;
2506 }
2507
2508 return 0;
2509}
2510
2511int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
2512 struct annotation_options *opts)
2513{
2514 const char *ev_name = evsel__name(evsel);
2515 char buf[1024];
2516 char *filename;
2517 int err = -1;
2518 FILE *fp;
2519
2520 if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2521 return -1;
2522
2523 fp = fopen(filename, "w");
2524 if (fp == NULL)
2525 goto out_free_filename;
2526
2527 if (evsel__is_group_event(evsel)) {
2528 evsel__group_desc(evsel, buf, sizeof(buf));
2529 ev_name = buf;
2530 }
2531
2532 fprintf(fp, "%s() %s\nEvent: %s\n\n",
2533 ms->sym->name, ms->map->dso->long_name, ev_name);
2534 symbol__annotate_fprintf2(ms->sym, fp, opts);
2535
2536 fclose(fp);
2537 err = 0;
2538out_free_filename:
2539 free(filename);
2540 return err;
2541}
2542
2543void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2544{
2545 struct annotation *notes = symbol__annotation(sym);
2546 struct sym_hist *h = annotation__histogram(notes, evidx);
2547
2548 memset(h, 0, notes->src->sizeof_sym_hist);
2549}
2550
2551void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2552{
2553 struct annotation *notes = symbol__annotation(sym);
2554 struct sym_hist *h = annotation__histogram(notes, evidx);
2555 int len = symbol__size(sym), offset;
2556
2557 h->nr_samples = 0;
2558 for (offset = 0; offset < len; ++offset) {
2559 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2560 h->nr_samples += h->addr[offset].nr_samples;
2561 }
2562}
2563
2564void annotated_source__purge(struct annotated_source *as)
2565{
2566 struct annotation_line *al, *n;
2567
2568 list_for_each_entry_safe(al, n, &as->source, node) {
2569 list_del_init(&al->node);
2570 disasm_line__free(disasm_line(al));
2571 }
2572}
2573
2574static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2575{
2576 size_t printed;
2577
2578 if (dl->al.offset == -1)
2579 return fprintf(fp, "%s\n", dl->al.line);
2580
2581 printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2582
2583 if (dl->ops.raw[0] != '\0') {
2584 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2585 dl->ops.raw);
2586 }
2587
2588 return printed + fprintf(fp, "\n");
2589}
2590
2591size_t disasm__fprintf(struct list_head *head, FILE *fp)
2592{
2593 struct disasm_line *pos;
2594 size_t printed = 0;
2595
2596 list_for_each_entry(pos, head, al.node)
2597 printed += disasm_line__fprintf(pos, fp);
2598
2599 return printed;
2600}
2601
2602bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2603{
2604 if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2605 !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2606 dl->ops.target.offset >= (s64)symbol__size(sym))
2607 return false;
2608
2609 return true;
2610}
2611
2612void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2613{
2614 u64 offset, size = symbol__size(sym);
2615
2616 /* PLT symbols contain external offsets */
2617 if (strstr(sym->name, "@plt"))
2618 return;
2619
2620 for (offset = 0; offset < size; ++offset) {
2621 struct annotation_line *al = notes->offsets[offset];
2622 struct disasm_line *dl;
2623
2624 dl = disasm_line(al);
2625
2626 if (!disasm_line__is_valid_local_jump(dl, sym))
2627 continue;
2628
2629 al = notes->offsets[dl->ops.target.offset];
2630
2631 /*
2632 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2633 * have to adjust to the previous offset?
2634 */
2635 if (al == NULL)
2636 continue;
2637
2638 if (++al->jump_sources > notes->max_jump_sources)
2639 notes->max_jump_sources = al->jump_sources;
2640 }
2641}
2642
2643void annotation__set_offsets(struct annotation *notes, s64 size)
2644{
2645 struct annotation_line *al;
2646
2647 notes->max_line_len = 0;
2648 notes->nr_entries = 0;
2649 notes->nr_asm_entries = 0;
2650
2651 list_for_each_entry(al, ¬es->src->source, node) {
2652 size_t line_len = strlen(al->line);
2653
2654 if (notes->max_line_len < line_len)
2655 notes->max_line_len = line_len;
2656 al->idx = notes->nr_entries++;
2657 if (al->offset != -1) {
2658 al->idx_asm = notes->nr_asm_entries++;
2659 /*
2660 * FIXME: short term bandaid to cope with assembly
2661 * routines that comes with labels in the same column
2662 * as the address in objdump, sigh.
2663 *
2664 * E.g. copy_user_generic_unrolled
2665 */
2666 if (al->offset < size)
2667 notes->offsets[al->offset] = al;
2668 } else
2669 al->idx_asm = -1;
2670 }
2671}
2672
2673static inline int width_jumps(int n)
2674{
2675 if (n >= 100)
2676 return 5;
2677 if (n / 10)
2678 return 2;
2679 return 1;
2680}
2681
2682static int annotation__max_ins_name(struct annotation *notes)
2683{
2684 int max_name = 0, len;
2685 struct annotation_line *al;
2686
2687 list_for_each_entry(al, ¬es->src->source, node) {
2688 if (al->offset == -1)
2689 continue;
2690
2691 len = strlen(disasm_line(al)->ins.name);
2692 if (max_name < len)
2693 max_name = len;
2694 }
2695
2696 return max_name;
2697}
2698
2699void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2700{
2701 notes->widths.addr = notes->widths.target =
2702 notes->widths.min_addr = hex_width(symbol__size(sym));
2703 notes->widths.max_addr = hex_width(sym->end);
2704 notes->widths.jumps = width_jumps(notes->max_jump_sources);
2705 notes->widths.max_ins_name = annotation__max_ins_name(notes);
2706}
2707
2708void annotation__update_column_widths(struct annotation *notes)
2709{
2710 if (notes->options->use_offset)
2711 notes->widths.target = notes->widths.min_addr;
2712 else
2713 notes->widths.target = notes->widths.max_addr;
2714
2715 notes->widths.addr = notes->widths.target;
2716
2717 if (notes->options->show_nr_jumps)
2718 notes->widths.addr += notes->widths.jumps + 1;
2719}
2720
2721static void annotation__calc_lines(struct annotation *notes, struct map *map,
2722 struct rb_root *root,
2723 struct annotation_options *opts)
2724{
2725 struct annotation_line *al;
2726 struct rb_root tmp_root = RB_ROOT;
2727
2728 list_for_each_entry(al, ¬es->src->source, node) {
2729 double percent_max = 0.0;
2730 int i;
2731
2732 for (i = 0; i < al->data_nr; i++) {
2733 double percent;
2734
2735 percent = annotation_data__percent(&al->data[i],
2736 opts->percent_type);
2737
2738 if (percent > percent_max)
2739 percent_max = percent;
2740 }
2741
2742 if (percent_max <= 0.5)
2743 continue;
2744
2745 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2746 false, true, notes->start + al->offset);
2747 insert_source_line(&tmp_root, al, opts);
2748 }
2749
2750 resort_source_line(root, &tmp_root);
2751}
2752
2753static void symbol__calc_lines(struct map_symbol *ms, struct rb_root *root,
2754 struct annotation_options *opts)
2755{
2756 struct annotation *notes = symbol__annotation(ms->sym);
2757
2758 annotation__calc_lines(notes, ms->map, root, opts);
2759}
2760
2761int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel,
2762 struct annotation_options *opts)
2763{
2764 struct dso *dso = ms->map->dso;
2765 struct symbol *sym = ms->sym;
2766 struct rb_root source_line = RB_ROOT;
2767 struct hists *hists = evsel__hists(evsel);
2768 char buf[1024];
2769
2770 if (symbol__annotate2(ms, evsel, opts, NULL) < 0)
2771 return -1;
2772
2773 if (opts->print_lines) {
2774 srcline_full_filename = opts->full_path;
2775 symbol__calc_lines(ms, &source_line, opts);
2776 print_summary(&source_line, dso->long_name);
2777 }
2778
2779 hists__scnprintf_title(hists, buf, sizeof(buf));
2780 fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2781 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2782 symbol__annotate_fprintf2(sym, stdout, opts);
2783
2784 annotated_source__purge(symbol__annotation(sym)->src);
2785
2786 return 0;
2787}
2788
2789int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel,
2790 struct annotation_options *opts)
2791{
2792 struct dso *dso = ms->map->dso;
2793 struct symbol *sym = ms->sym;
2794 struct rb_root source_line = RB_ROOT;
2795
2796 if (symbol__annotate(ms, evsel, opts, NULL) < 0)
2797 return -1;
2798
2799 symbol__calc_percent(sym, evsel);
2800
2801 if (opts->print_lines) {
2802 srcline_full_filename = opts->full_path;
2803 symbol__calc_lines(ms, &source_line, opts);
2804 print_summary(&source_line, dso->long_name);
2805 }
2806
2807 symbol__annotate_printf(ms, evsel, opts);
2808
2809 annotated_source__purge(symbol__annotation(sym)->src);
2810
2811 return 0;
2812}
2813
2814bool ui__has_annotation(void)
2815{
2816 return use_browser == 1 && perf_hpp_list.sym;
2817}
2818
2819
2820static double annotation_line__max_percent(struct annotation_line *al,
2821 struct annotation *notes,
2822 unsigned int percent_type)
2823{
2824 double percent_max = 0.0;
2825 int i;
2826
2827 for (i = 0; i < notes->nr_events; i++) {
2828 double percent;
2829
2830 percent = annotation_data__percent(&al->data[i],
2831 percent_type);
2832
2833 if (percent > percent_max)
2834 percent_max = percent;
2835 }
2836
2837 return percent_max;
2838}
2839
2840static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2841 void *obj, char *bf, size_t size,
2842 void (*obj__printf)(void *obj, const char *fmt, ...),
2843 void (*obj__write_graph)(void *obj, int graph))
2844{
2845 if (dl->ins.ops && dl->ins.ops->scnprintf) {
2846 if (ins__is_jump(&dl->ins)) {
2847 bool fwd;
2848
2849 if (dl->ops.target.outside)
2850 goto call_like;
2851 fwd = dl->ops.target.offset > dl->al.offset;
2852 obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2853 obj__printf(obj, " ");
2854 } else if (ins__is_call(&dl->ins)) {
2855call_like:
2856 obj__write_graph(obj, RARROW_CHAR);
2857 obj__printf(obj, " ");
2858 } else if (ins__is_ret(&dl->ins)) {
2859 obj__write_graph(obj, LARROW_CHAR);
2860 obj__printf(obj, " ");
2861 } else {
2862 obj__printf(obj, " ");
2863 }
2864 } else {
2865 obj__printf(obj, " ");
2866 }
2867
2868 disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2869}
2870
2871static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2872{
2873 double ipc = 0.0, coverage = 0.0;
2874
2875 if (notes->hit_cycles)
2876 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2877
2878 if (notes->total_insn) {
2879 coverage = notes->cover_insn * 100.0 /
2880 ((double)notes->total_insn);
2881 }
2882
2883 scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2884 ipc, coverage);
2885}
2886
2887static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2888 bool first_line, bool current_entry, bool change_color, int width,
2889 void *obj, unsigned int percent_type,
2890 int (*obj__set_color)(void *obj, int color),
2891 void (*obj__set_percent_color)(void *obj, double percent, bool current),
2892 int (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2893 void (*obj__printf)(void *obj, const char *fmt, ...),
2894 void (*obj__write_graph)(void *obj, int graph))
2895
2896{
2897 double percent_max = annotation_line__max_percent(al, notes, percent_type);
2898 int pcnt_width = annotation__pcnt_width(notes),
2899 cycles_width = annotation__cycles_width(notes);
2900 bool show_title = false;
2901 char bf[256];
2902 int printed;
2903
2904 if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2905 if (notes->have_cycles) {
2906 if (al->ipc == 0.0 && al->cycles == 0)
2907 show_title = true;
2908 } else
2909 show_title = true;
2910 }
2911
2912 if (al->offset != -1 && percent_max != 0.0) {
2913 int i;
2914
2915 for (i = 0; i < notes->nr_events; i++) {
2916 double percent;
2917
2918 percent = annotation_data__percent(&al->data[i], percent_type);
2919
2920 obj__set_percent_color(obj, percent, current_entry);
2921 if (symbol_conf.show_total_period) {
2922 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2923 } else if (symbol_conf.show_nr_samples) {
2924 obj__printf(obj, "%6" PRIu64 " ",
2925 al->data[i].he.nr_samples);
2926 } else {
2927 obj__printf(obj, "%6.2f ", percent);
2928 }
2929 }
2930 } else {
2931 obj__set_percent_color(obj, 0, current_entry);
2932
2933 if (!show_title)
2934 obj__printf(obj, "%-*s", pcnt_width, " ");
2935 else {
2936 obj__printf(obj, "%-*s", pcnt_width,
2937 symbol_conf.show_total_period ? "Period" :
2938 symbol_conf.show_nr_samples ? "Samples" : "Percent");
2939 }
2940 }
2941
2942 if (notes->have_cycles) {
2943 if (al->ipc)
2944 obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2945 else if (!show_title)
2946 obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2947 else
2948 obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2949
2950 if (!notes->options->show_minmax_cycle) {
2951 if (al->cycles)
2952 obj__printf(obj, "%*" PRIu64 " ",
2953 ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2954 else if (!show_title)
2955 obj__printf(obj, "%*s",
2956 ANNOTATION__CYCLES_WIDTH, " ");
2957 else
2958 obj__printf(obj, "%*s ",
2959 ANNOTATION__CYCLES_WIDTH - 1,
2960 "Cycle");
2961 } else {
2962 if (al->cycles) {
2963 char str[32];
2964
2965 scnprintf(str, sizeof(str),
2966 "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2967 al->cycles, al->cycles_min,
2968 al->cycles_max);
2969
2970 obj__printf(obj, "%*s ",
2971 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2972 str);
2973 } else if (!show_title)
2974 obj__printf(obj, "%*s",
2975 ANNOTATION__MINMAX_CYCLES_WIDTH,
2976 " ");
2977 else
2978 obj__printf(obj, "%*s ",
2979 ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2980 "Cycle(min/max)");
2981 }
2982
2983 if (show_title && !*al->line) {
2984 ipc_coverage_string(bf, sizeof(bf), notes);
2985 obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2986 }
2987 }
2988
2989 obj__printf(obj, " ");
2990
2991 if (!*al->line)
2992 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
2993 else if (al->offset == -1) {
2994 if (al->line_nr && notes->options->show_linenr)
2995 printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
2996 else
2997 printed = scnprintf(bf, sizeof(bf), "%-*s ", notes->widths.addr, " ");
2998 obj__printf(obj, bf);
2999 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
3000 } else {
3001 u64 addr = al->offset;
3002 int color = -1;
3003
3004 if (!notes->options->use_offset)
3005 addr += notes->start;
3006
3007 if (!notes->options->use_offset) {
3008 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
3009 } else {
3010 if (al->jump_sources &&
3011 notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
3012 if (notes->options->show_nr_jumps) {
3013 int prev;
3014 printed = scnprintf(bf, sizeof(bf), "%*d ",
3015 notes->widths.jumps,
3016 al->jump_sources);
3017 prev = obj__set_jumps_percent_color(obj, al->jump_sources,
3018 current_entry);
3019 obj__printf(obj, bf);
3020 obj__set_color(obj, prev);
3021 }
3022print_addr:
3023 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
3024 notes->widths.target, addr);
3025 } else if (ins__is_call(&disasm_line(al)->ins) &&
3026 notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
3027 goto print_addr;
3028 } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
3029 goto print_addr;
3030 } else {
3031 printed = scnprintf(bf, sizeof(bf), "%-*s ",
3032 notes->widths.addr, " ");
3033 }
3034 }
3035
3036 if (change_color)
3037 color = obj__set_color(obj, HE_COLORSET_ADDR);
3038 obj__printf(obj, bf);
3039 if (change_color)
3040 obj__set_color(obj, color);
3041
3042 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
3043
3044 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
3045 }
3046
3047}
3048
3049void annotation_line__write(struct annotation_line *al, struct annotation *notes,
3050 struct annotation_write_ops *wops,
3051 struct annotation_options *opts)
3052{
3053 __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
3054 wops->change_color, wops->width, wops->obj,
3055 opts->percent_type,
3056 wops->set_color, wops->set_percent_color,
3057 wops->set_jumps_percent_color, wops->printf,
3058 wops->write_graph);
3059}
3060
3061int symbol__annotate2(struct map_symbol *ms, struct evsel *evsel,
3062 struct annotation_options *options, struct arch **parch)
3063{
3064 struct symbol *sym = ms->sym;
3065 struct annotation *notes = symbol__annotation(sym);
3066 size_t size = symbol__size(sym);
3067 int nr_pcnt = 1, err;
3068
3069 notes->offsets = zalloc(size * sizeof(struct annotation_line *));
3070 if (notes->offsets == NULL)
3071 return ENOMEM;
3072
3073 if (evsel__is_group_event(evsel))
3074 nr_pcnt = evsel->core.nr_members;
3075
3076 err = symbol__annotate(ms, evsel, options, parch);
3077 if (err)
3078 goto out_free_offsets;
3079
3080 notes->options = options;
3081
3082 symbol__calc_percent(sym, evsel);
3083
3084 annotation__set_offsets(notes, size);
3085 annotation__mark_jump_targets(notes, sym);
3086 annotation__compute_ipc(notes, size);
3087 annotation__init_column_widths(notes, sym);
3088 notes->nr_events = nr_pcnt;
3089
3090 annotation__update_column_widths(notes);
3091 sym->annotate2 = true;
3092
3093 return 0;
3094
3095out_free_offsets:
3096 zfree(¬es->offsets);
3097 return err;
3098}
3099
3100static int annotation__config(const char *var, const char *value, void *data)
3101{
3102 struct annotation_options *opt = data;
3103
3104 if (!strstarts(var, "annotate."))
3105 return 0;
3106
3107 if (!strcmp(var, "annotate.offset_level")) {
3108 perf_config_u8(&opt->offset_level, "offset_level", value);
3109
3110 if (opt->offset_level > ANNOTATION__MAX_OFFSET_LEVEL)
3111 opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
3112 else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
3113 opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
3114 } else if (!strcmp(var, "annotate.hide_src_code")) {
3115 opt->hide_src_code = perf_config_bool("hide_src_code", value);
3116 } else if (!strcmp(var, "annotate.jump_arrows")) {
3117 opt->jump_arrows = perf_config_bool("jump_arrows", value);
3118 } else if (!strcmp(var, "annotate.show_linenr")) {
3119 opt->show_linenr = perf_config_bool("show_linenr", value);
3120 } else if (!strcmp(var, "annotate.show_nr_jumps")) {
3121 opt->show_nr_jumps = perf_config_bool("show_nr_jumps", value);
3122 } else if (!strcmp(var, "annotate.show_nr_samples")) {
3123 symbol_conf.show_nr_samples = perf_config_bool("show_nr_samples",
3124 value);
3125 } else if (!strcmp(var, "annotate.show_total_period")) {
3126 symbol_conf.show_total_period = perf_config_bool("show_total_period",
3127 value);
3128 } else if (!strcmp(var, "annotate.use_offset")) {
3129 opt->use_offset = perf_config_bool("use_offset", value);
3130 } else {
3131 pr_debug("%s variable unknown, ignoring...", var);
3132 }
3133
3134 return 0;
3135}
3136
3137void annotation_config__init(struct annotation_options *opt)
3138{
3139 perf_config(annotation__config, opt);
3140}
3141
3142static unsigned int parse_percent_type(char *str1, char *str2)
3143{
3144 unsigned int type = (unsigned int) -1;
3145
3146 if (!strcmp("period", str1)) {
3147 if (!strcmp("local", str2))
3148 type = PERCENT_PERIOD_LOCAL;
3149 else if (!strcmp("global", str2))
3150 type = PERCENT_PERIOD_GLOBAL;
3151 }
3152
3153 if (!strcmp("hits", str1)) {
3154 if (!strcmp("local", str2))
3155 type = PERCENT_HITS_LOCAL;
3156 else if (!strcmp("global", str2))
3157 type = PERCENT_HITS_GLOBAL;
3158 }
3159
3160 return type;
3161}
3162
3163int annotate_parse_percent_type(const struct option *opt, const char *_str,
3164 int unset __maybe_unused)
3165{
3166 struct annotation_options *opts = opt->value;
3167 unsigned int type;
3168 char *str1, *str2;
3169 int err = -1;
3170
3171 str1 = strdup(_str);
3172 if (!str1)
3173 return -ENOMEM;
3174
3175 str2 = strchr(str1, '-');
3176 if (!str2)
3177 goto out;
3178
3179 *str2++ = 0;
3180
3181 type = parse_percent_type(str1, str2);
3182 if (type == (unsigned int) -1)
3183 type = parse_percent_type(str2, str1);
3184 if (type != (unsigned int) -1) {
3185 opts->percent_type = type;
3186 err = 0;
3187 }
3188
3189out:
3190 free(str1);
3191 return err;
3192}
3193
3194int annotate_check_args(struct annotation_options *args)
3195{
3196 if (args->prefix_strip && !args->prefix) {
3197 pr_err("--prefix-strip requires --prefix\n");
3198 return -1;
3199 }
3200 return 0;
3201}