blob: 7e78e6c270783475acb6dc897109254d6d266b35 [file] [log] [blame]
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -02001#ifndef __PERF_ANNOTATE_H
2#define __PERF_ANNOTATE_H
3
4#include <stdbool.h>
Arnaldo Carvalho de Melofb29fa52012-04-25 14:16:03 -03005#include <stdint.h>
Borislav Petkovd944c4e2014-04-25 21:31:02 +02006#include <linux/types.h>
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -02007#include "symbol.h"
Namhyung Kim9783adf2012-11-02 14:50:05 +09008#include "hist.h"
Namhyung Kim2b676bf2013-02-07 18:02:08 +09009#include "sort.h"
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020010#include <linux/list.h>
11#include <linux/rbtree.h>
Irina Tirdea27683dc2012-09-08 03:43:19 +030012#include <pthread.h>
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020013
Arnaldo Carvalho de Melo28548d72012-04-19 10:16:27 -030014struct ins;
15
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030016struct ins_operands {
17 char *raw;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030018 struct {
Arnaldo Carvalho de Melo6de783b2012-05-11 16:48:49 -030019 char *raw;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030020 char *name;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030021 u64 addr;
Arnaldo Carvalho de Melo6de783b2012-05-11 16:48:49 -030022 u64 offset;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030023 } target;
Arnaldo Carvalho de Melo7a997fe2012-05-12 13:15:34 -030024 union {
25 struct {
26 char *raw;
27 char *name;
28 u64 addr;
29 } source;
30 struct {
31 struct ins *ins;
32 struct ins_operands *ops;
33 } locked;
34 };
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030035};
36
Arnaldo Carvalho de Melo4f9d0322012-04-18 13:58:34 -030037struct ins_ops {
Arnaldo Carvalho de Meloc46219ac2012-05-12 13:26:20 -030038 void (*free)(struct ins_operands *ops);
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030039 int (*parse)(struct ins_operands *ops);
Arnaldo Carvalho de Melo28548d72012-04-19 10:16:27 -030040 int (*scnprintf)(struct ins *ins, char *bf, size_t size,
Arnaldo Carvalho de Melo54170722012-05-07 18:54:16 -030041 struct ins_operands *ops);
Arnaldo Carvalho de Melo4f9d0322012-04-18 13:58:34 -030042};
43
44struct ins {
45 const char *name;
46 struct ins_ops *ops;
47};
48
49bool ins__is_jump(const struct ins *ins);
Arnaldo Carvalho de Melod86b0592012-04-18 16:07:38 -030050bool ins__is_call(const struct ins *ins);
Arnaldo Carvalho de Melo54170722012-05-07 18:54:16 -030051int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
Arnaldo Carvalho de Melo4f9d0322012-04-18 13:58:34 -030052
Namhyung Kime64aa752013-03-05 14:53:30 +090053struct annotation;
54
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -030055struct disasm_line {
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030056 struct list_head node;
57 s64 offset;
58 char *line;
59 char *name;
60 struct ins *ins;
Andi Kleene5924882014-11-12 18:05:26 -080061 int line_nr;
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030062 struct ins_operands ops;
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020063};
64
Arnaldo Carvalho de Melofb29fa52012-04-25 14:16:03 -030065static inline bool disasm_line__has_offset(const struct disasm_line *dl)
66{
67 return dl->ops.target.offset != UINT64_MAX;
68}
69
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -030070void disasm_line__free(struct disasm_line *dl);
71struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
Arnaldo Carvalho de Melo54170722012-05-07 18:54:16 -030072int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
Arnaldo Carvalho de Melo51454182012-04-15 15:52:18 -030073size_t disasm__fprintf(struct list_head *head, FILE *fp);
Namhyung Kime64aa752013-03-05 14:53:30 +090074double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
Martin Liška0c4a5bc2015-06-19 16:10:43 -030075 s64 end, const char **path, u64 *nr_samples);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020076
77struct sym_hist {
78 u64 sum;
79 u64 addr[0];
80};
81
Arnaldo Carvalho de Melo276af922015-06-19 16:36:12 -030082struct source_line_samples {
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020083 double percent;
Namhyung Kim41127962012-11-09 14:58:49 +090084 double percent_sum;
Arnaldo Carvalho de Melo276af922015-06-19 16:36:12 -030085 double nr;
Namhyung Kimc5a83682013-03-05 14:53:27 +090086};
87
88struct source_line {
89 struct rb_node node;
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020090 char *path;
Namhyung Kim1491c222013-03-05 14:53:28 +090091 int nr_pcnt;
Arnaldo Carvalho de Melo276af922015-06-19 16:36:12 -030092 struct source_line_samples samples[1];
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020093};
94
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -020095/** struct annotated_source - symbols with hits have this attached as in sannotation
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -020096 *
97 * @histogram: Array of addr hit histograms per event being monitored
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -020098 * @lines: If 'print_lines' is specified, per source code line percentages
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -030099 * @source: source parsed from a disassembler like objdump -dS
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200100 *
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200101 * lines is allocated, percentages calculated and all sorted by percentage
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200102 * when the annotation is about to be presented, so the percentages are for
103 * one of the entries in the histogram array, i.e. for the event/counter being
104 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
105 * returns.
106 */
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200107struct annotated_source {
108 struct list_head source;
109 struct source_line *lines;
Arnaldo Carvalho de Melo36532462011-02-06 14:54:44 -0200110 int nr_histograms;
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200111 int sizeof_sym_hist;
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200112 struct sym_hist histograms[0];
113};
114
115struct annotation {
116 pthread_mutex_t lock;
117 struct annotated_source *src;
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200118};
119
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200120static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
121{
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200122 return (((void *)&notes->src->histograms) +
123 (notes->src->sizeof_sym_hist * idx));
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200124}
125
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200126static inline struct annotation *symbol__annotation(struct symbol *sym)
127{
Namhyung Kim813ccd12015-01-14 20:18:05 +0900128 return (void *)sym - symbol_conf.priv_size;
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200129}
130
Arnaldo Carvalho de Melo0f4e7a22013-12-18 16:48:29 -0300131int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
132
Arnaldo Carvalho de Melof626adf2013-12-18 17:10:15 -0300133int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
134
Arnaldo Carvalho de Melod04b35f2011-11-11 22:17:32 -0200135int symbol__alloc_hist(struct symbol *sym);
Arnaldo Carvalho de Melo36532462011-02-06 14:54:44 -0200136void symbol__annotate_zero_histograms(struct symbol *sym);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200137
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200138int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
Arnaldo Carvalho de Melof626adf2013-12-18 17:10:15 -0300139
140int hist_entry__annotate(struct hist_entry *he, size_t privsize);
141
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300142int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900143int symbol__annotate_printf(struct symbol *sym, struct map *map,
144 struct perf_evsel *evsel, bool full_paths,
145 int min_pcnt, int max_lines, int context);
Arnaldo Carvalho de Melo36532462011-02-06 14:54:44 -0200146void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200147void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -0300148void disasm__purge(struct list_head *head);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200149
Namhyung Kim48c65bd2014-02-20 10:32:53 +0900150bool ui__has_annotation(void);
151
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900152int symbol__tty_annotate(struct symbol *sym, struct map *map,
153 struct perf_evsel *evsel, bool print_lines,
154 bool full_paths, int min_pcnt, int max_lines);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200155
Ingo Molnar89fe8082013-09-30 12:07:11 +0200156#ifdef HAVE_SLANG_SUPPORT
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900157int symbol__tui_annotate(struct symbol *sym, struct map *map,
158 struct perf_evsel *evsel,
Namhyung Kim9783adf2012-11-02 14:50:05 +0900159 struct hist_browser_timer *hbt);
Namhyung Kim1254b512012-09-28 18:32:02 +0900160#else
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300161static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900162 struct map *map __maybe_unused,
163 struct perf_evsel *evsel __maybe_unused,
164 struct hist_browser_timer *hbt
165 __maybe_unused)
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200166{
167 return 0;
168}
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200169#endif
170
Andi Kleenf69b64f2011-09-15 14:31:41 -0700171extern const char *disassembler_style;
172
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200173#endif /* __PERF_ANNOTATE_H */