1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_ANNOTATE_H
3 #define __PERF_ANNOTATE_H
8 #include <linux/types.h>
9 #include <linux/list.h>
10 #include <linux/rbtree.h>
13 #include "symbol_conf.h"
15 struct hist_browser_timer;
20 struct addr_map_symbol;
51 struct ins_operands *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);
65 bool ins__is_jump(const struct ins *ins);
66 bool ins__is_call(const struct ins *ins);
67 bool ins__is_ret(const struct ins *ins);
68 bool ins__is_lock(const struct ins *ins);
69 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name);
70 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2);
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
77 struct annotation_options {
94 const char *objdump_path;
95 const char *disassembler_style;
96 unsigned int percent_type;
100 ANNOTATION__OFFSET_JUMP_TARGETS = 1,
101 ANNOTATION__OFFSET_CALL,
102 ANNOTATION__MAX_OFFSET_LEVEL,
105 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
107 extern struct annotation_options annotation__default_options;
111 struct sym_hist_entry {
119 PERCENT_PERIOD_LOCAL,
120 PERCENT_PERIOD_GLOBAL,
124 struct annotation_data {
125 double percent[PERCENT_MAX];
127 struct sym_hist_entry he;
130 struct annotation_line {
131 struct list_head node;
132 struct rb_node rb_node;
146 struct annotation_data data[0];
151 struct ins_operands ops;
153 /* This needs to be at the end. */
154 struct annotation_line al;
157 static inline double annotation_data__percent(struct annotation_data *data,
160 return which < PERCENT_MAX ? data->percent[which] : -1;
163 static inline const char *percent_type_str(unsigned int type)
165 static const char *str[PERCENT_MAX] = {
172 if (WARN_ON(type >= PERCENT_MAX))
178 static inline struct disasm_line *disasm_line(struct annotation_line *al)
180 return al ? container_of(al, struct disasm_line, al) : NULL;
184 * Is this offset in the same function as the line it is used?
185 * asm functions jump to other functions, for instance.
187 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
189 return dl->ops.target.offset_avail && !dl->ops.target.outside;
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?
196 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
198 void disasm_line__free(struct disasm_line *dl);
199 struct annotation_line *
200 annotation_line__next(struct annotation_line *pos, struct list_head *head);
202 struct annotation_write_ops {
203 bool first_line, current_entry, change_color;
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);
213 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
214 struct annotation_write_ops *ops,
215 struct annotation_options *opts);
217 int __annotation__scnprintf_samples_period(struct annotation *notes,
218 char *bf, size_t size,
219 struct perf_evsel *evsel,
222 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
223 size_t disasm__fprintf(struct list_head *head, FILE *fp);
224 void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel);
229 struct sym_hist_entry addr[0];
245 /** struct annotated_source - symbols with hits have this attached as in sannotation
247 * @histograms: Array of addr hit histograms per event being monitored
248 * nr_histograms: This may not be the same as evsel->evlist->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
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
262 struct annotated_source {
263 struct list_head source;
265 size_t sizeof_sym_hist;
266 struct cyc_hist *cycles_hist;
267 struct sym_hist *histograms;
271 pthread_mutex_t lock;
276 unsigned int total_insn;
277 unsigned int cover_insn;
278 struct annotation_options *options;
279 struct annotation_line **offsets;
282 int max_jump_sources;
295 struct annotated_source *src;
298 static inline int annotation__cycles_width(struct annotation *notes)
300 if (notes->have_cycles && notes->options->show_minmax_cycle)
301 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
303 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
306 static inline int annotation__pcnt_width(struct annotation *notes)
308 return (notes->options->show_total_period ? 12 : 7) * notes->nr_events;
311 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes)
313 return notes->options->hide_src_code && al->offset == -1;
316 void annotation__set_offsets(struct annotation *notes, s64 size);
317 void annotation__compute_ipc(struct annotation *notes, size_t size);
318 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
319 void annotation__update_column_widths(struct annotation *notes);
320 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);
322 static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
324 return ((void *)src->histograms) + (src->sizeof_sym_hist * idx);
327 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
329 return annotated_source__histogram(notes->src, idx);
332 static inline struct annotation *symbol__annotation(struct symbol *sym)
334 return (void *)sym - symbol_conf.priv_size;
337 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
338 struct perf_evsel *evsel);
340 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
341 struct addr_map_symbol *start,
344 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
345 struct perf_evsel *evsel, u64 addr);
347 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
348 void symbol__annotate_zero_histograms(struct symbol *sym);
350 int symbol__annotate(struct symbol *sym, struct map *map,
351 struct perf_evsel *evsel, size_t privsize,
352 struct annotation_options *options,
353 struct arch **parch);
354 int symbol__annotate2(struct symbol *sym, struct map *map,
355 struct perf_evsel *evsel,
356 struct annotation_options *options,
357 struct arch **parch);
359 enum symbol_disassemble_errno {
360 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0,
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.
367 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
369 __SYMBOL_ANNOTATE_ERRNO__START = -10000,
371 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START,
372 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
374 __SYMBOL_ANNOTATE_ERRNO__END,
377 int symbol__strerror_disassemble(struct symbol *sym, struct map *map,
378 int errnum, char *buf, size_t buflen);
380 int symbol__annotate_printf(struct symbol *sym, struct map *map,
381 struct perf_evsel *evsel,
382 struct annotation_options *options);
383 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
384 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
385 void annotated_source__purge(struct annotated_source *as);
387 int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel,
388 struct annotation_options *opts);
390 bool ui__has_annotation(void);
392 int symbol__tty_annotate(struct symbol *sym, struct map *map,
393 struct perf_evsel *evsel, struct annotation_options *opts);
395 int symbol__tty_annotate2(struct symbol *sym, struct map *map,
396 struct perf_evsel *evsel, struct annotation_options *opts);
398 #ifdef HAVE_SLANG_SUPPORT
399 int symbol__tui_annotate(struct symbol *sym, struct map *map,
400 struct perf_evsel *evsel,
401 struct hist_browser_timer *hbt,
402 struct annotation_options *opts);
404 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
405 struct map *map __maybe_unused,
406 struct perf_evsel *evsel __maybe_unused,
407 struct hist_browser_timer *hbt __maybe_unused,
408 struct annotation_options *opts __maybe_unused)
414 void annotation_config__init(void);
416 int annotate_parse_percent_type(const struct option *opt, const char *_str,
418 #endif /* __PERF_ANNOTATE_H */