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