Loading...
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#include "hashmap.h"
16#include "disasm.h"
17#include "branch.h"
18
19struct hist_browser_timer;
20struct hist_entry;
21struct map;
22struct map_symbol;
23struct addr_map_symbol;
24struct option;
25struct perf_sample;
26struct evsel;
27struct symbol;
28struct annotated_data_type;
29
30#define ANNOTATION__IPC_WIDTH 6
31#define ANNOTATION__CYCLES_WIDTH 6
32#define ANNOTATION__MINMAX_CYCLES_WIDTH 19
33#define ANNOTATION__AVG_IPC_WIDTH 36
34#define ANNOTATION__BR_CNTR_WIDTH 30
35#define ANNOTATION_DUMMY_LEN 256
36
37enum perf_disassembler {
38 PERF_DISASM_UNKNOWN = 0,
39 PERF_DISASM_LLVM,
40 PERF_DISASM_CAPSTONE,
41 PERF_DISASM_OBJDUMP,
42};
43#define MAX_DISASSEMBLERS (PERF_DISASM_OBJDUMP + 1)
44
45struct annotation_options {
46 bool hide_src_code,
47 use_offset,
48 jump_arrows,
49 print_lines,
50 full_path,
51 show_linenr,
52 show_fileloc,
53 show_nr_jumps,
54 show_minmax_cycle,
55 show_asm_raw,
56 show_br_cntr,
57 annotate_src,
58 full_addr;
59 u8 offset_level;
60 u8 disassemblers[MAX_DISASSEMBLERS];
61 int min_pcnt;
62 int max_lines;
63 int context;
64 char *objdump_path;
65 char *disassembler_style;
66 const char *prefix;
67 const char *prefix_strip;
68 unsigned int percent_type;
69};
70
71extern struct annotation_options annotate_opts;
72
73enum {
74 ANNOTATION__OFFSET_JUMP_TARGETS = 1,
75 ANNOTATION__OFFSET_CALL,
76 ANNOTATION__MAX_OFFSET_LEVEL,
77};
78
79#define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
80
81struct annotation;
82
83struct sym_hist_entry {
84 u64 nr_samples;
85 u64 period;
86};
87
88enum {
89 PERCENT_HITS_LOCAL,
90 PERCENT_HITS_GLOBAL,
91 PERCENT_PERIOD_LOCAL,
92 PERCENT_PERIOD_GLOBAL,
93 PERCENT_MAX,
94};
95
96struct annotation_data {
97 double percent[PERCENT_MAX];
98 double percent_sum;
99 struct sym_hist_entry he;
100};
101
102struct cycles_info {
103 float ipc;
104 u64 avg;
105 u64 max;
106 u64 min;
107};
108
109struct annotation_line {
110 struct list_head node;
111 struct rb_node rb_node;
112 s64 offset;
113 char *line;
114 int line_nr;
115 char *fileloc;
116 char *path;
117 struct cycles_info *cycles;
118 int num_aggr;
119 int br_cntr_nr;
120 u64 *br_cntr;
121 struct evsel *evsel;
122 int jump_sources;
123 u32 idx;
124 int idx_asm;
125 int data_nr;
126 struct annotation_data data[];
127};
128
129struct disasm_line {
130 struct ins ins;
131 struct ins_operands ops;
132 union {
133 u8 bytes[4];
134 u32 raw_insn;
135 } raw;
136 /* This needs to be at the end. */
137 struct annotation_line al;
138};
139
140extern const char * const perf_disassembler__strs[];
141
142void annotation_line__add(struct annotation_line *al, struct list_head *head);
143
144static inline double annotation_data__percent(struct annotation_data *data,
145 unsigned int which)
146{
147 return which < PERCENT_MAX ? data->percent[which] : -1;
148}
149
150static inline const char *percent_type_str(unsigned int type)
151{
152 static const char *str[PERCENT_MAX] = {
153 "local hits",
154 "global hits",
155 "local period",
156 "global period",
157 };
158
159 if (WARN_ON(type >= PERCENT_MAX))
160 return "N/A";
161
162 return str[type];
163}
164
165static inline struct disasm_line *disasm_line(struct annotation_line *al)
166{
167 return al ? container_of(al, struct disasm_line, al) : NULL;
168}
169
170/*
171 * Is this offset in the same function as the line it is used?
172 * asm functions jump to other functions, for instance.
173 */
174static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
175{
176 return dl->ops.target.offset_avail && !dl->ops.target.outside;
177}
178
179/*
180 * Can we draw an arrow from the jump to its target, for instance? I.e.
181 * is the jump and its target in the same function?
182 */
183bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
184
185struct annotation_line *
186annotation_line__next(struct annotation_line *pos, struct list_head *head);
187
188struct annotation_write_ops {
189 bool first_line, current_entry, change_color;
190 int width;
191 void *obj;
192 int (*set_color)(void *obj, int color);
193 void (*set_percent_color)(void *obj, double percent, bool current);
194 int (*set_jumps_percent_color)(void *obj, int nr, bool current);
195 void (*printf)(void *obj, const char *fmt, ...);
196 void (*write_graph)(void *obj, int graph);
197};
198
199void annotation_line__write(struct annotation_line *al, struct annotation *notes,
200 struct annotation_write_ops *ops);
201
202int __annotation__scnprintf_samples_period(struct annotation *notes,
203 char *bf, size_t size,
204 struct evsel *evsel,
205 bool show_freq);
206
207size_t disasm__fprintf(struct list_head *head, FILE *fp);
208void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);
209
210/**
211 * struct sym_hist - symbol histogram information for an event
212 *
213 * @nr_samples: Total number of samples.
214 * @period: Sum of sample periods.
215 */
216struct sym_hist {
217 u64 nr_samples;
218 u64 period;
219};
220
221/**
222 * struct cyc_hist - (CPU) cycle histogram for a basic block
223 *
224 * @start: Start address of current block (if known).
225 * @cycles: Sum of cycles for the longest basic block.
226 * @cycles_aggr: Total cycles for this address.
227 * @cycles_max: Max cycles for this address.
228 * @cycles_min: Min cycles for this address.
229 * @cycles_spark: History of cycles for the longest basic block.
230 * @num: Number of samples for the longest basic block.
231 * @num_aggr: Total number of samples for this address.
232 * @have_start: Whether the current branch info has a start address.
233 * @reset: Number of resets due to a different start address.
234 *
235 * If sample has branch_stack and cycles info, it can construct basic blocks
236 * between two adjacent branches. It'd have start and end addresses but
237 * sometimes the start address may not be available. So the cycles are
238 * accounted at the end address. If multiple basic blocks end at the same
239 * address, it will take the longest one.
240 *
241 * The @start, @cycles, @cycles_spark and @num fields are used for the longest
242 * block only. Other fields are used for all cases.
243 *
244 * See __symbol__account_cycles().
245 */
246struct cyc_hist {
247 u64 start;
248 u64 cycles;
249 u64 cycles_aggr;
250 u64 cycles_max;
251 u64 cycles_min;
252 s64 cycles_spark[NUM_SPARKS];
253 u32 num;
254 u32 num_aggr;
255 u8 have_start;
256 /* 1 byte padding */
257 u16 reset;
258};
259
260/**
261 * struct annotated_source - symbols with hits have this attached as in annotation
262 *
263 * @source: List head for annotated_line (embeded in disasm_line).
264 * @histograms: Array of symbol histograms per event to maintain the total number
265 * of samples and period.
266 * @nr_histograms: This may not be the same as evsel->evlist->core.nr_entries if
267 * we have more than a group in a evlist, where we will want
268 * to see each group separately, that is why symbol__annotate2()
269 * sets src->nr_histograms to evsel->nr_members.
270 * @samples: Hash map of sym_hist_entry. Keyed by event index and offset in symbol.
271 * @nr_events: Number of events in the current output.
272 * @nr_entries: Number of annotated_line in the source list.
273 * @nr_asm_entries: Number of annotated_line with actual asm instruction in the
274 * source list.
275 * @max_jump_sources: Maximum number of jump instructions targeting to the same
276 * instruction.
277 * @widths: Precalculated width of each column in the TUI output.
278 *
279 * disasm_lines are allocated, percentages calculated and all sorted by percentage
280 * when the annotation is about to be presented, so the percentages are for
281 * one of the entries in the histogram array, i.e. for the event/counter being
282 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
283 * returns.
284 */
285struct annotated_source {
286 struct list_head source;
287 struct sym_hist *histograms;
288 struct hashmap *samples;
289 int nr_histograms;
290 int nr_events;
291 int nr_entries;
292 int nr_asm_entries;
293 int max_jump_sources;
294 u64 start;
295 struct {
296 u8 addr;
297 u8 jumps;
298 u8 target;
299 u8 min_addr;
300 u8 max_addr;
301 u8 max_ins_name;
302 u16 max_line_len;
303 } widths;
304};
305
306struct annotation_line *annotated_source__get_line(struct annotated_source *src,
307 s64 offset);
308
309/* A branch counter once saturated */
310#define ANNOTATION__BR_CNTR_SATURATED_FLAG (1ULL << 63)
311
312/**
313 * struct annotated_branch - basic block and IPC information for a symbol.
314 *
315 * @hit_cycles: Total executed cycles.
316 * @hit_insn: Total number of instructions executed.
317 * @total_insn: Number of instructions in the function.
318 * @cover_insn: Number of distinct, actually executed instructions.
319 * @cycles_hist: Array of cyc_hist for each instruction.
320 * @max_coverage: Maximum number of covered basic block (used for block-range).
321 * @br_cntr: Array of the occurrences of events (branch counters) during a block.
322 *
323 * This struct is used by two different codes when the sample has branch stack
324 * and cycles information. annotation__compute_ipc() calculates average IPC
325 * using @hit_insn / @hit_cycles. The actual coverage can be calculated using
326 * @cover_insn / @total_insn. The @cycles_hist can give IPC for each (longest)
327 * basic block ends at the given address.
328 * process_basic_block() calculates coverage of instructions (or basic blocks)
329 * in the function.
330 */
331struct annotated_branch {
332 u64 hit_cycles;
333 u64 hit_insn;
334 unsigned int total_insn;
335 unsigned int cover_insn;
336 struct cyc_hist *cycles_hist;
337 u64 max_coverage;
338 u64 *br_cntr;
339};
340
341struct LOCKABLE annotation {
342 struct annotated_source *src;
343 struct annotated_branch *branch;
344};
345
346static inline void annotation__init(struct annotation *notes __maybe_unused)
347{
348}
349void annotation__exit(struct annotation *notes);
350
351void annotation__lock(struct annotation *notes) EXCLUSIVE_LOCK_FUNCTION(*notes);
352void annotation__unlock(struct annotation *notes) UNLOCK_FUNCTION(*notes);
353bool annotation__trylock(struct annotation *notes) EXCLUSIVE_TRYLOCK_FUNCTION(true, *notes);
354
355static inline int annotation__cycles_width(struct annotation *notes)
356{
357 if (notes->branch && annotate_opts.show_minmax_cycle)
358 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
359
360 return notes->branch ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
361}
362
363static inline int annotation__pcnt_width(struct annotation *notes)
364{
365 return (symbol_conf.show_total_period ? 12 : 8) * notes->src->nr_events;
366}
367
368static inline bool annotation_line__filter(struct annotation_line *al)
369{
370 return annotate_opts.hide_src_code && al->offset == -1;
371}
372
373static inline u8 annotation__br_cntr_width(void)
374{
375 return annotate_opts.show_br_cntr ? ANNOTATION__BR_CNTR_WIDTH : 0;
376}
377
378void annotation__update_column_widths(struct annotation *notes);
379void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms);
380
381static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
382{
383 return &src->histograms[idx];
384}
385
386static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
387{
388 return annotated_source__histogram(notes->src, idx);
389}
390
391static inline struct sym_hist_entry *
392annotated_source__hist_entry(struct annotated_source *src, int idx, u64 offset)
393{
394 struct sym_hist_entry *entry;
395 long key = offset << 16 | idx;
396
397 if (!hashmap__find(src->samples, key, &entry))
398 return NULL;
399 return entry;
400}
401
402static inline struct annotation *symbol__annotation(struct symbol *sym)
403{
404 return (void *)sym - symbol_conf.priv_size;
405}
406
407int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
408 struct evsel *evsel);
409
410struct annotated_branch *annotation__get_branch(struct annotation *notes);
411
412int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
413 struct addr_map_symbol *start,
414 unsigned cycles,
415 struct evsel *evsel,
416 u64 br_cntr);
417
418int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
419 struct evsel *evsel, u64 addr);
420
421struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
422void symbol__annotate_zero_histograms(struct symbol *sym);
423
424int symbol__annotate(struct map_symbol *ms,
425 struct evsel *evsel,
426 struct arch **parch);
427int symbol__annotate2(struct map_symbol *ms,
428 struct evsel *evsel,
429 struct arch **parch);
430
431enum symbol_disassemble_errno {
432 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0,
433
434 /*
435 * Choose an arbitrary negative big number not to clash with standard
436 * errno since SUS requires the errno has distinct positive values.
437 * See 'Issue 6' in the link below.
438 *
439 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
440 */
441 __SYMBOL_ANNOTATE_ERRNO__START = -10000,
442
443 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START,
444 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
445 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING,
446 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP,
447 SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE,
448 SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF,
449
450 __SYMBOL_ANNOTATE_ERRNO__END,
451};
452
453int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen);
454
455int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel);
456void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
457void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
458void annotated_source__purge(struct annotated_source *as);
459
460int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel);
461
462bool ui__has_annotation(void);
463
464int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel);
465
466int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel);
467
468#ifdef HAVE_SLANG_SUPPORT
469int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
470 struct hist_browser_timer *hbt);
471#else
472static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
473 struct evsel *evsel __maybe_unused,
474 struct hist_browser_timer *hbt __maybe_unused)
475{
476 return 0;
477}
478#endif
479
480void annotation_options__init(void);
481void annotation_options__exit(void);
482
483void annotation_config__init(void);
484
485int annotate_parse_percent_type(const struct option *opt, const char *_str,
486 int unset);
487
488int annotate_check_args(void);
489
490/**
491 * struct annotated_op_loc - Location info of instruction operand
492 * @reg1: First register in the operand
493 * @reg2: Second register in the operand
494 * @offset: Memory access offset in the operand
495 * @segment: Segment selector register
496 * @mem_ref: Whether the operand accesses memory
497 * @multi_regs: Whether the second register is used
498 * @imm: Whether the operand is an immediate value (in offset)
499 */
500struct annotated_op_loc {
501 int reg1;
502 int reg2;
503 int offset;
504 u8 segment;
505 bool mem_ref;
506 bool multi_regs;
507 bool imm;
508};
509
510enum annotated_insn_ops {
511 INSN_OP_SOURCE = 0,
512 INSN_OP_TARGET = 1,
513
514 INSN_OP_MAX,
515};
516
517enum annotated_x86_segment {
518 INSN_SEG_NONE = 0,
519
520 INSN_SEG_X86_CS,
521 INSN_SEG_X86_DS,
522 INSN_SEG_X86_ES,
523 INSN_SEG_X86_FS,
524 INSN_SEG_X86_GS,
525 INSN_SEG_X86_SS,
526};
527
528/**
529 * struct annotated_insn_loc - Location info of instruction
530 * @ops: Array of location info for source and target operands
531 */
532struct annotated_insn_loc {
533 struct annotated_op_loc ops[INSN_OP_MAX];
534};
535
536#define for_each_insn_op_loc(insn_loc, i, op_loc) \
537 for (i = INSN_OP_SOURCE, op_loc = &(insn_loc)->ops[i]; \
538 i < INSN_OP_MAX; \
539 i++, op_loc++)
540
541/* Get detailed location info in the instruction */
542int annotate_get_insn_location(struct arch *arch, struct disasm_line *dl,
543 struct annotated_insn_loc *loc);
544
545/* Returns a data type from the sample instruction (if any) */
546struct annotated_data_type *hist_entry__get_data_type(struct hist_entry *he);
547
548struct annotated_item_stat {
549 struct list_head list;
550 char *name;
551 int good;
552 int bad;
553};
554extern struct list_head ann_insn_stat;
555
556/* Calculate PC-relative address */
557u64 annotate_calc_pcrel(struct map_symbol *ms, u64 ip, int offset,
558 struct disasm_line *dl);
559
560/**
561 * struct annotated_basic_block - Basic block of instructions
562 * @list: List node
563 * @begin: start instruction in the block
564 * @end: end instruction in the block
565 */
566struct annotated_basic_block {
567 struct list_head list;
568 struct disasm_line *begin;
569 struct disasm_line *end;
570};
571
572/* Get a list of basic blocks from src to dst addresses */
573int annotate_get_basic_blocks(struct symbol *sym, s64 src, s64 dst,
574 struct list_head *head);
575
576void debuginfo_cache__delete(void);
577
578int annotation_br_cntr_entry(char **str, int br_cntr_nr, u64 *br_cntr,
579 int num_aggr, struct evsel *evsel);
580int annotation_br_cntr_abbr_list(char **str, struct evsel *evsel, bool header);
581#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#include "spark.h"
15
16struct hist_browser_timer;
17struct hist_entry;
18struct ins_ops;
19struct map;
20struct map_symbol;
21struct addr_map_symbol;
22struct option;
23struct perf_sample;
24struct evsel;
25struct symbol;
26
27struct ins {
28 const char *name;
29 struct ins_ops *ops;
30};
31
32struct 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
58struct arch;
59
60struct 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
67bool ins__is_jump(const struct ins *ins);
68bool ins__is_call(const struct ins *ins);
69bool ins__is_ret(const struct ins *ins);
70bool ins__is_lock(const struct ins *ins);
71int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name);
72bool 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
80struct 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 u8 offset_level;
93 int min_pcnt;
94 int max_lines;
95 int context;
96 const char *objdump_path;
97 const char *disassembler_style;
98 const char *prefix;
99 const char *prefix_strip;
100 unsigned int percent_type;
101};
102
103enum {
104 ANNOTATION__OFFSET_JUMP_TARGETS = 1,
105 ANNOTATION__OFFSET_CALL,
106 ANNOTATION__MAX_OFFSET_LEVEL,
107};
108
109#define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
110
111extern struct annotation_options annotation__default_options;
112
113struct annotation;
114
115struct sym_hist_entry {
116 u64 nr_samples;
117 u64 period;
118};
119
120enum {
121 PERCENT_HITS_LOCAL,
122 PERCENT_HITS_GLOBAL,
123 PERCENT_PERIOD_LOCAL,
124 PERCENT_PERIOD_GLOBAL,
125 PERCENT_MAX,
126};
127
128struct annotation_data {
129 double percent[PERCENT_MAX];
130 double percent_sum;
131 struct sym_hist_entry he;
132};
133
134struct annotation_line {
135 struct list_head node;
136 struct rb_node rb_node;
137 s64 offset;
138 char *line;
139 int line_nr;
140 char *fileloc;
141 int jump_sources;
142 float ipc;
143 u64 cycles;
144 u64 cycles_max;
145 u64 cycles_min;
146 char *path;
147 u32 idx;
148 int idx_asm;
149 int data_nr;
150 struct annotation_data data[];
151};
152
153struct disasm_line {
154 struct ins ins;
155 struct ins_operands ops;
156
157 /* This needs to be at the end. */
158 struct annotation_line al;
159};
160
161static inline double annotation_data__percent(struct annotation_data *data,
162 unsigned int which)
163{
164 return which < PERCENT_MAX ? data->percent[which] : -1;
165}
166
167static inline const char *percent_type_str(unsigned int type)
168{
169 static const char *str[PERCENT_MAX] = {
170 "local hits",
171 "global hits",
172 "local period",
173 "global period",
174 };
175
176 if (WARN_ON(type >= PERCENT_MAX))
177 return "N/A";
178
179 return str[type];
180}
181
182static inline struct disasm_line *disasm_line(struct annotation_line *al)
183{
184 return al ? container_of(al, struct disasm_line, al) : NULL;
185}
186
187/*
188 * Is this offset in the same function as the line it is used?
189 * asm functions jump to other functions, for instance.
190 */
191static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
192{
193 return dl->ops.target.offset_avail && !dl->ops.target.outside;
194}
195
196/*
197 * Can we draw an arrow from the jump to its target, for instance? I.e.
198 * is the jump and its target in the same function?
199 */
200bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
201
202void disasm_line__free(struct disasm_line *dl);
203struct annotation_line *
204annotation_line__next(struct annotation_line *pos, struct list_head *head);
205
206struct annotation_write_ops {
207 bool first_line, current_entry, change_color;
208 int width;
209 void *obj;
210 int (*set_color)(void *obj, int color);
211 void (*set_percent_color)(void *obj, double percent, bool current);
212 int (*set_jumps_percent_color)(void *obj, int nr, bool current);
213 void (*printf)(void *obj, const char *fmt, ...);
214 void (*write_graph)(void *obj, int graph);
215};
216
217void annotation_line__write(struct annotation_line *al, struct annotation *notes,
218 struct annotation_write_ops *ops,
219 struct annotation_options *opts);
220
221int __annotation__scnprintf_samples_period(struct annotation *notes,
222 char *bf, size_t size,
223 struct evsel *evsel,
224 bool show_freq);
225
226int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
227size_t disasm__fprintf(struct list_head *head, FILE *fp);
228void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);
229
230struct sym_hist {
231 u64 nr_samples;
232 u64 period;
233 struct sym_hist_entry addr[];
234};
235
236struct cyc_hist {
237 u64 start;
238 u64 cycles;
239 u64 cycles_aggr;
240 u64 cycles_max;
241 u64 cycles_min;
242 s64 cycles_spark[NUM_SPARKS];
243 u32 num;
244 u32 num_aggr;
245 u8 have_start;
246 /* 1 byte padding */
247 u16 reset;
248};
249
250/** struct annotated_source - symbols with hits have this attached as in sannotation
251 *
252 * @histograms: Array of addr hit histograms per event being monitored
253 * nr_histograms: This may not be the same as evsel->evlist->core.nr_entries if
254 * we have more than a group in a evlist, where we will want
255 * to see each group separately, that is why symbol__annotate2()
256 * sets src->nr_histograms to evsel->nr_members.
257 * @lines: If 'print_lines' is specified, per source code line percentages
258 * @source: source parsed from a disassembler like objdump -dS
259 * @cyc_hist: Average cycles per basic block
260 *
261 * lines is allocated, percentages calculated and all sorted by percentage
262 * when the annotation is about to be presented, so the percentages are for
263 * one of the entries in the histogram array, i.e. for the event/counter being
264 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
265 * returns.
266 */
267struct annotated_source {
268 struct list_head source;
269 int nr_histograms;
270 size_t sizeof_sym_hist;
271 struct cyc_hist *cycles_hist;
272 struct sym_hist *histograms;
273};
274
275struct annotation {
276 pthread_mutex_t lock;
277 u64 max_coverage;
278 u64 start;
279 u64 hit_cycles;
280 u64 hit_insn;
281 unsigned int total_insn;
282 unsigned int cover_insn;
283 struct annotation_options *options;
284 struct annotation_line **offsets;
285 int nr_events;
286 int max_jump_sources;
287 int nr_entries;
288 int nr_asm_entries;
289 u16 max_line_len;
290 struct {
291 u8 addr;
292 u8 jumps;
293 u8 target;
294 u8 min_addr;
295 u8 max_addr;
296 u8 max_ins_name;
297 } widths;
298 bool have_cycles;
299 struct annotated_source *src;
300};
301
302static inline int annotation__cycles_width(struct annotation *notes)
303{
304 if (notes->have_cycles && notes->options->show_minmax_cycle)
305 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
306
307 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
308}
309
310static inline int annotation__pcnt_width(struct annotation *notes)
311{
312 return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events;
313}
314
315static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes)
316{
317 return notes->options->hide_src_code && al->offset == -1;
318}
319
320void annotation__set_offsets(struct annotation *notes, s64 size);
321void annotation__compute_ipc(struct annotation *notes, size_t size);
322void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
323void annotation__update_column_widths(struct annotation *notes);
324void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);
325
326static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
327{
328 return ((void *)src->histograms) + (src->sizeof_sym_hist * idx);
329}
330
331static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
332{
333 return annotated_source__histogram(notes->src, idx);
334}
335
336static inline struct annotation *symbol__annotation(struct symbol *sym)
337{
338 return (void *)sym - symbol_conf.priv_size;
339}
340
341int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
342 struct evsel *evsel);
343
344int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
345 struct addr_map_symbol *start,
346 unsigned cycles);
347
348int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
349 struct evsel *evsel, u64 addr);
350
351struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
352void symbol__annotate_zero_histograms(struct symbol *sym);
353
354int symbol__annotate(struct map_symbol *ms,
355 struct evsel *evsel,
356 struct annotation_options *options,
357 struct arch **parch);
358int symbol__annotate2(struct map_symbol *ms,
359 struct evsel *evsel,
360 struct annotation_options *options,
361 struct arch **parch);
362
363enum symbol_disassemble_errno {
364 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0,
365
366 /*
367 * Choose an arbitrary negative big number not to clash with standard
368 * errno since SUS requires the errno has distinct positive values.
369 * See 'Issue 6' in the link below.
370 *
371 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
372 */
373 __SYMBOL_ANNOTATE_ERRNO__START = -10000,
374
375 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START,
376 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
377 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING,
378 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP,
379 SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE,
380 SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF,
381
382 __SYMBOL_ANNOTATE_ERRNO__END,
383};
384
385int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen);
386
387int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
388 struct annotation_options *options);
389void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
390void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
391void annotated_source__purge(struct annotated_source *as);
392
393int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
394 struct annotation_options *opts);
395
396bool ui__has_annotation(void);
397
398int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
399
400int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
401
402#ifdef HAVE_SLANG_SUPPORT
403int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
404 struct hist_browser_timer *hbt,
405 struct annotation_options *opts);
406#else
407static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
408 struct evsel *evsel __maybe_unused,
409 struct hist_browser_timer *hbt __maybe_unused,
410 struct annotation_options *opts __maybe_unused)
411{
412 return 0;
413}
414#endif
415
416void annotation_config__init(struct annotation_options *opt);
417
418int annotate_parse_percent_type(const struct option *opt, const char *_str,
419 int unset);
420
421int annotate_check_args(struct annotation_options *args);
422
423#endif /* __PERF_ANNOTATE_H */