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