1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_ANNOTATE_H
3 #define __PERF_ANNOTATE_H
7 #include <linux/types.h>
11 #include <linux/list.h>
12 #include <linux/rbtree.h>
41 struct ins_operands
*ops
;
49 void (*free
)(struct ins_operands
*ops
);
50 int (*parse
)(struct arch
*arch
, struct ins_operands
*ops
, struct map_symbol
*ms
);
51 int (*scnprintf
)(struct ins
*ins
, char *bf
, size_t size
,
52 struct ins_operands
*ops
);
55 bool ins__is_jump(const struct ins
*ins
);
56 bool ins__is_call(const struct ins
*ins
);
57 bool ins__is_ret(const struct ins
*ins
);
58 bool ins__is_lock(const struct ins
*ins
);
59 int ins__scnprintf(struct ins
*ins
, char *bf
, size_t size
, struct ins_operands
*ops
);
60 bool ins__is_fused(struct arch
*arch
, const char *ins1
, const char *ins2
);
62 #define ANNOTATION__IPC_WIDTH 6
63 #define ANNOTATION__CYCLES_WIDTH 6
64 #define ANNOTATION__MINMAX_CYCLES_WIDTH 19
66 struct annotation_options
{
79 ANNOTATION__OFFSET_JUMP_TARGETS
= 1,
80 ANNOTATION__OFFSET_CALL
,
81 ANNOTATION__MAX_OFFSET_LEVEL
,
84 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
86 extern struct annotation_options annotation__default_options
;
90 struct sym_hist_entry
{
95 struct annotation_data
{
98 struct sym_hist_entry he
;
101 struct annotation_line
{
102 struct list_head node
;
103 struct rb_node rb_node
;
117 struct annotation_data samples
[0];
122 struct ins_operands ops
;
124 /* This needs to be at the end. */
125 struct annotation_line al
;
128 static inline struct disasm_line
*disasm_line(struct annotation_line
*al
)
130 return al
? container_of(al
, struct disasm_line
, al
) : NULL
;
134 * Is this offset in the same function as the line it is used?
135 * asm functions jump to other functions, for instance.
137 static inline bool disasm_line__has_local_offset(const struct disasm_line
*dl
)
139 return dl
->ops
.target
.offset_avail
&& !dl
->ops
.target
.outside
;
143 * Can we draw an arrow from the jump to its target, for instance? I.e.
144 * is the jump and its target in the same function?
146 bool disasm_line__is_valid_local_jump(struct disasm_line
*dl
, struct symbol
*sym
);
148 void disasm_line__free(struct disasm_line
*dl
);
149 struct annotation_line
*
150 annotation_line__next(struct annotation_line
*pos
, struct list_head
*head
);
152 struct annotation_write_ops
{
153 bool first_line
, current_entry
, change_color
;
156 int (*set_color
)(void *obj
, int color
);
157 void (*set_percent_color
)(void *obj
, double percent
, bool current
);
158 int (*set_jumps_percent_color
)(void *obj
, int nr
, bool current
);
159 void (*printf
)(void *obj
, const char *fmt
, ...);
160 void (*write_graph
)(void *obj
, int graph
);
163 double annotation_line__max_percent(struct annotation_line
*al
, struct annotation
*notes
);
164 void annotation_line__write(struct annotation_line
*al
, struct annotation
*notes
,
165 struct annotation_write_ops
*ops
);
167 int __annotation__scnprintf_samples_period(struct annotation
*notes
,
168 char *bf
, size_t size
,
169 struct perf_evsel
*evsel
,
172 static inline int annotation__scnprintf_samples_period(struct annotation
*notes
,
173 char *bf
, size_t size
,
174 struct perf_evsel
*evsel
)
176 return __annotation__scnprintf_samples_period(notes
, bf
, size
, evsel
, true);
179 int disasm_line__scnprintf(struct disasm_line
*dl
, char *bf
, size_t size
, bool raw
);
180 size_t disasm__fprintf(struct list_head
*head
, FILE *fp
);
181 void symbol__calc_percent(struct symbol
*sym
, struct perf_evsel
*evsel
);
186 struct sym_hist_entry addr
[0];
202 /** struct annotated_source - symbols with hits have this attached as in sannotation
204 * @histogram: Array of addr hit histograms per event being monitored
205 * @lines: If 'print_lines' is specified, per source code line percentages
206 * @source: source parsed from a disassembler like objdump -dS
207 * @cyc_hist: Average cycles per basic block
209 * lines is allocated, percentages calculated and all sorted by percentage
210 * when the annotation is about to be presented, so the percentages are for
211 * one of the entries in the histogram array, i.e. for the event/counter being
212 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
215 struct annotated_source
{
216 struct list_head source
;
218 size_t sizeof_sym_hist
;
219 struct cyc_hist
*cycles_hist
;
220 struct sym_hist histograms
[0];
224 pthread_mutex_t lock
;
227 struct annotation_options
*options
;
228 struct annotation_line
**offsets
;
231 int max_jump_sources
;
243 struct annotated_source
*src
;
246 static inline int annotation__cycles_width(struct annotation
*notes
)
248 if (notes
->have_cycles
&& notes
->options
->show_minmax_cycle
)
249 return ANNOTATION__IPC_WIDTH
+ ANNOTATION__MINMAX_CYCLES_WIDTH
;
251 return notes
->have_cycles
? ANNOTATION__IPC_WIDTH
+ ANNOTATION__CYCLES_WIDTH
: 0;
254 static inline int annotation__pcnt_width(struct annotation
*notes
)
256 return (notes
->options
->show_total_period
? 12 : 7) * notes
->nr_events
;
259 static inline bool annotation_line__filter(struct annotation_line
*al
, struct annotation
*notes
)
261 return notes
->options
->hide_src_code
&& al
->offset
== -1;
264 void annotation__set_offsets(struct annotation
*notes
, s64 size
);
265 void annotation__compute_ipc(struct annotation
*notes
, size_t size
);
266 void annotation__mark_jump_targets(struct annotation
*notes
, struct symbol
*sym
);
267 void annotation__update_column_widths(struct annotation
*notes
);
268 void annotation__init_column_widths(struct annotation
*notes
, struct symbol
*sym
);
270 static inline struct sym_hist
*annotation__histogram(struct annotation
*notes
, int idx
)
272 return (((void *)¬es
->src
->histograms
) +
273 (notes
->src
->sizeof_sym_hist
* idx
));
276 static inline struct annotation
*symbol__annotation(struct symbol
*sym
)
278 return (void *)sym
- symbol_conf
.priv_size
;
281 int addr_map_symbol__inc_samples(struct addr_map_symbol
*ams
, struct perf_sample
*sample
,
282 struct perf_evsel
*evsel
);
284 int addr_map_symbol__account_cycles(struct addr_map_symbol
*ams
,
285 struct addr_map_symbol
*start
,
288 int hist_entry__inc_addr_samples(struct hist_entry
*he
, struct perf_sample
*sample
,
289 struct perf_evsel
*evsel
, u64 addr
);
291 int symbol__alloc_hist(struct symbol
*sym
);
292 void symbol__annotate_zero_histograms(struct symbol
*sym
);
294 int symbol__annotate(struct symbol
*sym
, struct map
*map
,
295 struct perf_evsel
*evsel
, size_t privsize
,
296 struct arch
**parch
);
297 int symbol__annotate2(struct symbol
*sym
, struct map
*map
,
298 struct perf_evsel
*evsel
,
299 struct annotation_options
*options
,
300 struct arch
**parch
);
302 enum symbol_disassemble_errno
{
303 SYMBOL_ANNOTATE_ERRNO__SUCCESS
= 0,
306 * Choose an arbitrary negative big number not to clash with standard
307 * errno since SUS requires the errno has distinct positive values.
308 * See 'Issue 6' in the link below.
310 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
312 __SYMBOL_ANNOTATE_ERRNO__START
= -10000,
314 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX
= __SYMBOL_ANNOTATE_ERRNO__START
,
316 __SYMBOL_ANNOTATE_ERRNO__END
,
319 int symbol__strerror_disassemble(struct symbol
*sym
, struct map
*map
,
320 int errnum
, char *buf
, size_t buflen
);
322 int symbol__annotate_printf(struct symbol
*sym
, struct map
*map
,
323 struct perf_evsel
*evsel
, bool full_paths
,
324 int min_pcnt
, int max_lines
, int context
);
325 int symbol__annotate_fprintf2(struct symbol
*sym
, FILE *fp
);
326 void symbol__annotate_zero_histogram(struct symbol
*sym
, int evidx
);
327 void symbol__annotate_decay_histogram(struct symbol
*sym
, int evidx
);
328 void annotated_source__purge(struct annotated_source
*as
);
330 int map_symbol__annotation_dump(struct map_symbol
*ms
, struct perf_evsel
*evsel
);
332 bool ui__has_annotation(void);
334 int symbol__tty_annotate(struct symbol
*sym
, struct map
*map
,
335 struct perf_evsel
*evsel
, bool print_lines
,
336 bool full_paths
, int min_pcnt
, int max_lines
);
338 int symbol__tty_annotate2(struct symbol
*sym
, struct map
*map
,
339 struct perf_evsel
*evsel
, bool print_lines
,
342 #ifdef HAVE_SLANG_SUPPORT
343 int symbol__tui_annotate(struct symbol
*sym
, struct map
*map
,
344 struct perf_evsel
*evsel
,
345 struct hist_browser_timer
*hbt
);
347 static inline int symbol__tui_annotate(struct symbol
*sym __maybe_unused
,
348 struct map
*map __maybe_unused
,
349 struct perf_evsel
*evsel __maybe_unused
,
350 struct hist_browser_timer
*hbt
357 extern const char *disassembler_style
;
359 void annotation_config__init(void);
361 #endif /* __PERF_ANNOTATE_H */