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 <asm/bug.h>
12#include "symbol_conf.h"
13#include "mutex.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;
26struct annotated_data_type;
27
28struct ins {
29 const char *name;
30 struct ins_ops *ops;
31};
32
33struct 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
63struct arch;
64
65bool arch__is(struct arch *arch, const char *name);
66
67struct 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
74bool ins__is_jump(const struct ins *ins);
75bool ins__is_call(const struct ins *ins);
76bool ins__is_ret(const struct ins *ins);
77bool ins__is_lock(const struct ins *ins);
78int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name);
79bool 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
87struct 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
111extern struct annotation_options annotate_opts;
112
113enum {
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
121struct annotation;
122
123struct sym_hist_entry {
124 u64 nr_samples;
125 u64 period;
126};
127
128enum {
129 PERCENT_HITS_LOCAL,
130 PERCENT_HITS_GLOBAL,
131 PERCENT_PERIOD_LOCAL,
132 PERCENT_PERIOD_GLOBAL,
133 PERCENT_MAX,
134};
135
136struct annotation_data {
137 double percent[PERCENT_MAX];
138 double percent_sum;
139 struct sym_hist_entry he;
140};
141
142struct cycles_info {
143 float ipc;
144 u64 avg;
145 u64 max;
146 u64 min;
147};
148
149struct 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
165struct 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
173static 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
179static 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
194static 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 */
203static 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 */
212bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
213
214void disasm_line__free(struct disasm_line *dl);
215struct annotation_line *
216annotation_line__next(struct annotation_line *pos, struct list_head *head);
217
218struct 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
229void annotation_line__write(struct annotation_line *al, struct annotation *notes,
230 struct annotation_write_ops *ops);
231
232int __annotation__scnprintf_samples_period(struct annotation *notes,
233 char *bf, size_t size,
234 struct evsel *evsel,
235 bool show_freq);
236
237int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
238size_t disasm__fprintf(struct list_head *head, FILE *fp);
239void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);
240
241struct sym_hist {
242 u64 nr_samples;
243 u64 period;
244 struct sym_hist_entry addr[];
245};
246
247struct 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 */
278struct 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
289struct 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
298struct 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
314static inline void annotation__init(struct annotation *notes __maybe_unused)
315{
316}
317void annotation__exit(struct annotation *notes);
318
319void annotation__lock(struct annotation *notes) EXCLUSIVE_LOCK_FUNCTION(*notes);
320void annotation__unlock(struct annotation *notes) UNLOCK_FUNCTION(*notes);
321bool annotation__trylock(struct annotation *notes) EXCLUSIVE_TRYLOCK_FUNCTION(true, *notes);
322
323static 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
331static inline int annotation__pcnt_width(struct annotation *notes)
332{
333 return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events;
334}
335
336static inline bool annotation_line__filter(struct annotation_line *al)
337{
338 return annotate_opts.hide_src_code && al->offset == -1;
339}
340
341void annotation__set_offsets(struct annotation *notes, s64 size);
342void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
343void annotation__update_column_widths(struct annotation *notes);
344void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);
345void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms);
346
347static 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
352static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
353{
354 return annotated_source__histogram(notes->src, idx);
355}
356
357static inline struct annotation *symbol__annotation(struct symbol *sym)
358{
359 return (void *)sym - symbol_conf.priv_size;
360}
361
362int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
363 struct evsel *evsel);
364
365struct annotated_branch *annotation__get_branch(struct annotation *notes);
366
367int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
368 struct addr_map_symbol *start,
369 unsigned cycles);
370
371int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
372 struct evsel *evsel, u64 addr);
373
374struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
375void symbol__annotate_zero_histograms(struct symbol *sym);
376
377int symbol__annotate(struct map_symbol *ms,
378 struct evsel *evsel,
379 struct arch **parch);
380int symbol__annotate2(struct map_symbol *ms,
381 struct evsel *evsel,
382 struct arch **parch);
383
384enum 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
406int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen);
407
408int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel);
409void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
410void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
411void annotated_source__purge(struct annotated_source *as);
412
413int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel);
414
415bool ui__has_annotation(void);
416
417int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel);
418
419int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel);
420
421#ifdef HAVE_SLANG_SUPPORT
422int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
423 struct hist_browser_timer *hbt);
424#else
425static 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
433void annotation_options__init(void);
434void annotation_options__exit(void);
435
436void annotation_config__init(void);
437
438int annotate_parse_percent_type(const struct option *opt, const char *_str,
439 int unset);
440
441int 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 */
449struct annotated_op_loc {
450 int reg;
451 int offset;
452 bool mem_ref;
453};
454
455enum 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 */
466struct 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 */
476int 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) */
480struct annotated_data_type *hist_entry__get_data_type(struct hist_entry *he);
481
482struct annotated_item_stat {
483 struct list_head list;
484 char *name;
485 int good;
486 int bad;
487};
488extern struct list_head ann_insn_stat;
489
490#endif /* __PERF_ANNOTATE_H */