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