1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_ANNOTATE_H
3 #define __PERF_ANNOTATE_H
4
5 #include <stdbool.h>
6 #include <stdint.h>
7 #include <stdio.h>
8 #include <linux/types.h>
9 #include <linux/list.h>
10 #include <linux/rbtree.h>
11 #include <asm/bug.h>
12 #include "symbol_conf.h"
13 #include "mutex.h"
14 #include "spark.h"
15
16 struct hist_browser_timer;
17 struct hist_entry;
18 struct ins_ops;
19 struct map;
20 struct map_symbol;
21 struct addr_map_symbol;
22 struct option;
23 struct perf_sample;
24 struct evsel;
25 struct symbol;
26
27 struct ins {
28 const char *name;
29 struct ins_ops *ops;
30 };
31
32 struct ins_operands {
33 char *raw;
34 char *raw_comment;
35 char *raw_func_start;
36 struct {
37 char *raw;
38 char *name;
39 struct symbol *sym;
40 u64 addr;
41 s64 offset;
42 bool offset_avail;
43 bool outside;
44 } target;
45 union {
46 struct {
47 char *raw;
48 char *name;
49 u64 addr;
50 } source;
51 struct {
52 struct ins ins;
53 struct ins_operands *ops;
54 } locked;
55 };
56 };
57
58 struct arch;
59
60 struct ins_ops {
61 void (*free)(struct ins_operands *ops);
62 int (*parse)(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms);
63 int (*scnprintf)(struct ins *ins, char *bf, size_t size,
64 struct ins_operands *ops, int max_ins_name);
65 };
66
67 bool ins__is_jump(const struct ins *ins);
68 bool ins__is_call(const struct ins *ins);
69 bool ins__is_ret(const struct ins *ins);
70 bool ins__is_lock(const struct ins *ins);
71 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name);
72 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2);
73
74 #define ANNOTATION__IPC_WIDTH 6
75 #define ANNOTATION__CYCLES_WIDTH 6
76 #define ANNOTATION__MINMAX_CYCLES_WIDTH 19
77 #define ANNOTATION__AVG_IPC_WIDTH 36
78 #define ANNOTATION_DUMMY_LEN 256
79
80 struct annotation_options {
81 bool hide_src_code,
82 use_offset,
83 jump_arrows,
84 print_lines,
85 full_path,
86 show_linenr,
87 show_fileloc,
88 show_nr_jumps,
89 show_minmax_cycle,
90 show_asm_raw,
91 annotate_src,
92 full_addr;
93 u8 offset_level;
94 int min_pcnt;
95 int max_lines;
96 int context;
97 char *objdump_path;
98 char *disassembler_style;
99 const char *prefix;
100 const char *prefix_strip;
101 unsigned int percent_type;
102 };
103
104 enum {
105 ANNOTATION__OFFSET_JUMP_TARGETS = 1,
106 ANNOTATION__OFFSET_CALL,
107 ANNOTATION__MAX_OFFSET_LEVEL,
108 };
109
110 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
111
112 struct annotation;
113
114 struct sym_hist_entry {
115 u64 nr_samples;
116 u64 period;
117 };
118
119 enum {
120 PERCENT_HITS_LOCAL,
121 PERCENT_HITS_GLOBAL,
122 PERCENT_PERIOD_LOCAL,
123 PERCENT_PERIOD_GLOBAL,
124 PERCENT_MAX,
125 };
126
127 struct annotation_data {
128 double percent[PERCENT_MAX];
129 double percent_sum;
130 struct sym_hist_entry he;
131 };
132
133 struct annotation_line {
134 struct list_head node;
135 struct rb_node rb_node;
136 s64 offset;
137 char *line;
138 int line_nr;
139 char *fileloc;
140 int jump_sources;
141 float ipc;
142 u64 cycles;
143 u64 cycles_max;
144 u64 cycles_min;
145 char *path;
146 u32 idx;
147 int idx_asm;
148 int data_nr;
149 struct annotation_data data[];
150 };
151
152 struct disasm_line {
153 struct ins ins;
154 struct ins_operands ops;
155
156 /* This needs to be at the end. */
157 struct annotation_line al;
158 };
159
annotation_data__percent(struct annotation_data * data,unsigned int which)160 static inline double annotation_data__percent(struct annotation_data *data,
161 unsigned int which)
162 {
163 return which < PERCENT_MAX ? data->percent[which] : -1;
164 }
165
percent_type_str(unsigned int type)166 static inline const char *percent_type_str(unsigned int type)
167 {
168 static const char *str[PERCENT_MAX] = {
169 "local hits",
170 "global hits",
171 "local period",
172 "global period",
173 };
174
175 if (WARN_ON(type >= PERCENT_MAX))
176 return "N/A";
177
178 return str[type];
179 }
180
disasm_line(struct annotation_line * al)181 static inline struct disasm_line *disasm_line(struct annotation_line *al)
182 {
183 return al ? container_of(al, struct disasm_line, al) : NULL;
184 }
185
186 /*
187 * Is this offset in the same function as the line it is used?
188 * asm functions jump to other functions, for instance.
189 */
disasm_line__has_local_offset(const struct disasm_line * dl)190 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
191 {
192 return dl->ops.target.offset_avail && !dl->ops.target.outside;
193 }
194
195 /*
196 * Can we draw an arrow from the jump to its target, for instance? I.e.
197 * is the jump and its target in the same function?
198 */
199 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
200
201 void disasm_line__free(struct disasm_line *dl);
202 struct annotation_line *
203 annotation_line__next(struct annotation_line *pos, struct list_head *head);
204
205 struct annotation_write_ops {
206 bool first_line, current_entry, change_color;
207 int width;
208 void *obj;
209 int (*set_color)(void *obj, int color);
210 void (*set_percent_color)(void *obj, double percent, bool current);
211 int (*set_jumps_percent_color)(void *obj, int nr, bool current);
212 void (*printf)(void *obj, const char *fmt, ...);
213 void (*write_graph)(void *obj, int graph);
214 };
215
216 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
217 struct annotation_write_ops *ops,
218 struct annotation_options *opts);
219
220 int __annotation__scnprintf_samples_period(struct annotation *notes,
221 char *bf, size_t size,
222 struct evsel *evsel,
223 bool show_freq);
224
225 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
226 size_t disasm__fprintf(struct list_head *head, FILE *fp);
227 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);
228
229 struct sym_hist {
230 u64 nr_samples;
231 u64 period;
232 struct sym_hist_entry addr[];
233 };
234
235 struct cyc_hist {
236 u64 start;
237 u64 cycles;
238 u64 cycles_aggr;
239 u64 cycles_max;
240 u64 cycles_min;
241 s64 cycles_spark[NUM_SPARKS];
242 u32 num;
243 u32 num_aggr;
244 u8 have_start;
245 /* 1 byte padding */
246 u16 reset;
247 };
248
249 /** struct annotated_source - symbols with hits have this attached as in sannotation
250 *
251 * @histograms: Array of addr hit histograms per event being monitored
252 * nr_histograms: This may not be the same as evsel->evlist->core.nr_entries if
253 * we have more than a group in a evlist, where we will want
254 * to see each group separately, that is why symbol__annotate2()
255 * sets src->nr_histograms to evsel->nr_members.
256 * @lines: If 'print_lines' is specified, per source code line percentages
257 * @source: source parsed from a disassembler like objdump -dS
258 * @cyc_hist: Average cycles per basic block
259 *
260 * lines is allocated, percentages calculated and all sorted by percentage
261 * when the annotation is about to be presented, so the percentages are for
262 * one of the entries in the histogram array, i.e. for the event/counter being
263 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
264 * returns.
265 */
266 struct annotated_source {
267 struct list_head source;
268 int nr_histograms;
269 size_t sizeof_sym_hist;
270 struct cyc_hist *cycles_hist;
271 struct sym_hist *histograms;
272 };
273
274 struct LOCKABLE annotation {
275 u64 max_coverage;
276 u64 start;
277 u64 hit_cycles;
278 u64 hit_insn;
279 unsigned int total_insn;
280 unsigned int cover_insn;
281 struct annotation_options *options;
282 struct annotation_line **offsets;
283 int nr_events;
284 int max_jump_sources;
285 int nr_entries;
286 int nr_asm_entries;
287 u16 max_line_len;
288 struct {
289 u8 addr;
290 u8 jumps;
291 u8 target;
292 u8 min_addr;
293 u8 max_addr;
294 u8 max_ins_name;
295 } widths;
296 bool have_cycles;
297 struct annotated_source *src;
298 };
299
annotation__init(struct annotation * notes __maybe_unused)300 static inline void annotation__init(struct annotation *notes __maybe_unused)
301 {
302 }
303 void annotation__exit(struct annotation *notes);
304
305 void annotation__lock(struct annotation *notes) EXCLUSIVE_LOCK_FUNCTION(*notes);
306 void annotation__unlock(struct annotation *notes) UNLOCK_FUNCTION(*notes);
307 bool annotation__trylock(struct annotation *notes) EXCLUSIVE_TRYLOCK_FUNCTION(true, *notes);
308
annotation__cycles_width(struct annotation * notes)309 static inline int annotation__cycles_width(struct annotation *notes)
310 {
311 if (notes->have_cycles && notes->options->show_minmax_cycle)
312 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
313
314 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
315 }
316
annotation__pcnt_width(struct annotation * notes)317 static inline int annotation__pcnt_width(struct annotation *notes)
318 {
319 return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events;
320 }
321
annotation_line__filter(struct annotation_line * al,struct annotation * notes)322 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes)
323 {
324 return notes->options->hide_src_code && al->offset == -1;
325 }
326
327 void annotation__set_offsets(struct annotation *notes, s64 size);
328 void annotation__compute_ipc(struct annotation *notes, size_t size);
329 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
330 void annotation__update_column_widths(struct annotation *notes);
331 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);
332 void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms);
333
annotated_source__histogram(struct annotated_source * src,int idx)334 static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
335 {
336 return ((void *)src->histograms) + (src->sizeof_sym_hist * idx);
337 }
338
annotation__histogram(struct annotation * notes,int idx)339 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
340 {
341 return annotated_source__histogram(notes->src, idx);
342 }
343
symbol__annotation(struct symbol * sym)344 static inline struct annotation *symbol__annotation(struct symbol *sym)
345 {
346 return (void *)sym - symbol_conf.priv_size;
347 }
348
349 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
350 struct evsel *evsel);
351
352 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
353 struct addr_map_symbol *start,
354 unsigned cycles);
355
356 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
357 struct evsel *evsel, u64 addr);
358
359 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
360 void symbol__annotate_zero_histograms(struct symbol *sym);
361
362 int symbol__annotate(struct map_symbol *ms,
363 struct evsel *evsel,
364 struct annotation_options *options,
365 struct arch **parch);
366 int symbol__annotate2(struct map_symbol *ms,
367 struct evsel *evsel,
368 struct annotation_options *options,
369 struct arch **parch);
370
371 enum symbol_disassemble_errno {
372 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0,
373
374 /*
375 * Choose an arbitrary negative big number not to clash with standard
376 * errno since SUS requires the errno has distinct positive values.
377 * See 'Issue 6' in the link below.
378 *
379 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
380 */
381 __SYMBOL_ANNOTATE_ERRNO__START = -10000,
382
383 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START,
384 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
385 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING,
386 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP,
387 SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE,
388 SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF,
389
390 __SYMBOL_ANNOTATE_ERRNO__END,
391 };
392
393 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen);
394
395 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
396 struct annotation_options *options);
397 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
398 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
399 void annotated_source__purge(struct annotated_source *as);
400
401 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
402 struct annotation_options *opts);
403
404 bool ui__has_annotation(void);
405
406 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
407
408 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
409
410 #ifdef HAVE_SLANG_SUPPORT
411 int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
412 struct hist_browser_timer *hbt,
413 struct annotation_options *opts);
414 #else
symbol__tui_annotate(struct map_symbol * ms __maybe_unused,struct evsel * evsel __maybe_unused,struct hist_browser_timer * hbt __maybe_unused,struct annotation_options * opts __maybe_unused)415 static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
416 struct evsel *evsel __maybe_unused,
417 struct hist_browser_timer *hbt __maybe_unused,
418 struct annotation_options *opts __maybe_unused)
419 {
420 return 0;
421 }
422 #endif
423
424 void annotation_options__init(struct annotation_options *opt);
425 void annotation_options__exit(struct annotation_options *opt);
426
427 void annotation_config__init(struct annotation_options *opt);
428
429 int annotate_parse_percent_type(const struct option *opt, const char *_str,
430 int unset);
431
432 int annotate_check_args(struct annotation_options *args);
433
434 #endif /* __PERF_ANNOTATE_H */
435