bb2e3f998983f2a4be826e3379cef926283ae605
[linux-3.10.git] / tools / perf / util / annotate.h
1 #ifndef __PERF_ANNOTATE_H
2 #define __PERF_ANNOTATE_H
3
4 #include <stdbool.h>
5 #include <stdint.h>
6 #include "types.h"
7 #include "symbol.h"
8 #include "hist.h"
9 #include "sort.h"
10 #include <linux/list.h>
11 #include <linux/rbtree.h>
12 #include <pthread.h>
13
14 struct ins;
15
16 struct ins_operands {
17         char    *raw;
18         struct {
19                 char    *raw;
20                 char    *name;
21                 u64     addr;
22                 u64     offset;
23         } target;
24         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         };
35 };
36
37 struct ins_ops {
38         void (*free)(struct ins_operands *ops);
39         int (*parse)(struct ins_operands *ops);
40         int (*scnprintf)(struct ins *ins, char *bf, size_t size,
41                          struct ins_operands *ops);
42 };
43
44 struct ins {
45         const char     *name;
46         struct ins_ops *ops;
47 };
48
49 bool ins__is_jump(const struct ins *ins);
50 bool ins__is_call(const struct ins *ins);
51 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
52
53 struct disasm_line {
54         struct list_head    node;
55         s64                 offset;
56         char                *line;
57         char                *name;
58         struct ins          *ins;
59         struct ins_operands ops;
60 };
61
62 static inline bool disasm_line__has_offset(const struct disasm_line *dl)
63 {
64         return dl->ops.target.offset != UINT64_MAX;
65 }
66
67 void disasm_line__free(struct disasm_line *dl);
68 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
69 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
70 size_t disasm__fprintf(struct list_head *head, FILE *fp);
71
72 struct sym_hist {
73         u64             sum;
74         u64             addr[0];
75 };
76
77 struct source_line_percent {
78         double          percent;
79         double          percent_sum;
80 };
81
82 struct source_line {
83         struct rb_node  node;
84         char            *path;
85         struct source_line_percent p[1];
86 };
87
88 /** struct annotated_source - symbols with hits have this attached as in sannotation
89  *
90  * @histogram: Array of addr hit histograms per event being monitored
91  * @lines: If 'print_lines' is specified, per source code line percentages
92  * @source: source parsed from a disassembler like objdump -dS
93  *
94  * lines is allocated, percentages calculated and all sorted by percentage
95  * when the annotation is about to be presented, so the percentages are for
96  * one of the entries in the histogram array, i.e. for the event/counter being
97  * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
98  * returns.
99  */
100 struct annotated_source {
101         struct list_head   source;
102         struct source_line *lines;
103         int                nr_histograms;
104         int                sizeof_sym_hist;
105         struct sym_hist    histograms[0];
106 };
107
108 struct annotation {
109         pthread_mutex_t         lock;
110         struct annotated_source *src;
111 };
112
113 struct sannotation {
114         struct annotation annotation;
115         struct symbol     symbol;
116 };
117
118 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
119 {
120         return (((void *)&notes->src->histograms) +
121                 (notes->src->sizeof_sym_hist * idx));
122 }
123
124 static inline struct annotation *symbol__annotation(struct symbol *sym)
125 {
126         struct sannotation *a = container_of(sym, struct sannotation, symbol);
127         return &a->annotation;
128 }
129
130 int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
131                              int evidx, u64 addr);
132 int symbol__alloc_hist(struct symbol *sym);
133 void symbol__annotate_zero_histograms(struct symbol *sym);
134
135 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
136 int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
137 int symbol__annotate_printf(struct symbol *sym, struct map *map,
138                             struct perf_evsel *evsel, bool full_paths,
139                             int min_pcnt, int max_lines, int context);
140 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
141 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
142 void disasm__purge(struct list_head *head);
143
144 int symbol__tty_annotate(struct symbol *sym, struct map *map,
145                          struct perf_evsel *evsel, bool print_lines,
146                          bool full_paths, int min_pcnt, int max_lines);
147
148 #ifdef NEWT_SUPPORT
149 int symbol__tui_annotate(struct symbol *sym, struct map *map,
150                          struct perf_evsel *evsel,
151                          struct hist_browser_timer *hbt);
152 #else
153 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
154                                 struct map *map __maybe_unused,
155                                 struct perf_evsel *evsel  __maybe_unused,
156                                 struct hist_browser_timer *hbt
157                                 __maybe_unused)
158 {
159         return 0;
160 }
161 #endif
162
163 #ifdef GTK2_SUPPORT
164 int symbol__gtk_annotate(struct symbol *sym, struct map *map,
165                          struct perf_evsel *evsel,
166                          struct hist_browser_timer *hbt);
167
168 static inline int hist_entry__gtk_annotate(struct hist_entry *he,
169                                            struct perf_evsel *evsel,
170                                            struct hist_browser_timer *hbt)
171 {
172         return symbol__gtk_annotate(he->ms.sym, he->ms.map, evsel, hbt);
173 }
174
175 void perf_gtk__show_annotations(void);
176 #else
177 static inline int hist_entry__gtk_annotate(struct hist_entry *he __maybe_unused,
178                                 struct perf_evsel *evsel __maybe_unused,
179                                 struct hist_browser_timer *hbt __maybe_unused)
180 {
181         return 0;
182 }
183
184 static inline void perf_gtk__show_annotations(void) {}
185 #endif
186
187 extern const char       *disassembler_style;
188
189 #endif  /* __PERF_ANNOTATE_H */