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"
16 struct hist_browser_timer;
21 struct addr_map_symbol;
53 struct ins_operands *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);
67 bool ins__is_jump(const struct ins *ins);
68 bool ins__is_call(const struct ins *ins);
69 bool ins__is_ret(const struct ins *ins);
70 bool ins__is_lock(const struct ins *ins);
71 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name);
72 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2);
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
80 struct annotation_options {
95 const char *objdump_path;
96 const char *disassembler_style;
98 const char *prefix_strip;
99 unsigned int percent_type;
103 ANNOTATION__OFFSET_JUMP_TARGETS = 1,
104 ANNOTATION__OFFSET_CALL,
105 ANNOTATION__MAX_OFFSET_LEVEL,
108 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
110 extern struct annotation_options annotation__default_options;
114 struct sym_hist_entry {
122 PERCENT_PERIOD_LOCAL,
123 PERCENT_PERIOD_GLOBAL,
127 struct annotation_data {
128 double percent[PERCENT_MAX];
130 struct sym_hist_entry he;
133 struct annotation_line {
134 struct list_head node;
135 struct rb_node rb_node;
148 struct annotation_data data[];
153 struct ins_operands ops;
155 /* This needs to be at the end. */
156 struct annotation_line al;
159 static inline double annotation_data__percent(struct annotation_data *data,
162 return which < PERCENT_MAX ? data->percent[which] : -1;
165 static inline const char *percent_type_str(unsigned int type)
167 static const char *str[PERCENT_MAX] = {
174 if (WARN_ON(type >= PERCENT_MAX))
180 static inline struct disasm_line *disasm_line(struct annotation_line *al)
182 return al ? container_of(al, struct disasm_line, al) : NULL;
186 * Is this offset in the same function as the line it is used?
187 * asm functions jump to other functions, for instance.
189 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
191 return dl->ops.target.offset_avail && !dl->ops.target.outside;
195 * Can we draw an arrow from the jump to its target, for instance? I.e.
196 * is the jump and its target in the same function?
198 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
200 void disasm_line__free(struct disasm_line *dl);
201 struct annotation_line *
202 annotation_line__next(struct annotation_line *pos, struct list_head *head);
204 struct annotation_write_ops {
205 bool first_line, current_entry, change_color;
208 int (*set_color)(void *obj, int color);
209 void (*set_percent_color)(void *obj, double percent, bool current);
210 int (*set_jumps_percent_color)(void *obj, int nr, bool current);
211 void (*printf)(void *obj, const char *fmt, ...);
212 void (*write_graph)(void *obj, int graph);
215 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
216 struct annotation_write_ops *ops,
217 struct annotation_options *opts);
219 int __annotation__scnprintf_samples_period(struct annotation *notes,
220 char *bf, size_t size,
224 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
225 size_t disasm__fprintf(struct list_head *head, FILE *fp);
226 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);
231 struct sym_hist_entry addr[];
240 s64 cycles_spark[NUM_SPARKS];
248 /** struct annotated_source - symbols with hits have this attached as in sannotation
250 * @histograms: Array of addr hit histograms per event being monitored
251 * nr_histograms: This may not be the same as evsel->evlist->core.nr_entries if
252 * we have more than a group in a evlist, where we will want
253 * to see each group separately, that is why symbol__annotate2()
254 * sets src->nr_histograms to evsel->nr_members.
255 * @lines: If 'print_lines' is specified, per source code line percentages
256 * @source: source parsed from a disassembler like objdump -dS
257 * @cyc_hist: Average cycles per basic block
259 * lines is allocated, percentages calculated and all sorted by percentage
260 * when the annotation is about to be presented, so the percentages are for
261 * one of the entries in the histogram array, i.e. for the event/counter being
262 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
265 struct annotated_source {
266 struct list_head source;
268 size_t sizeof_sym_hist;
269 struct cyc_hist *cycles_hist;
270 struct sym_hist *histograms;
274 pthread_mutex_t lock;
279 unsigned int total_insn;
280 unsigned int cover_insn;
281 struct annotation_options *options;
282 struct annotation_line **offsets;
284 int max_jump_sources;
297 struct annotated_source *src;
300 static inline int annotation__cycles_width(struct annotation *notes)
302 if (notes->have_cycles && notes->options->show_minmax_cycle)
303 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
305 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
308 static inline int annotation__pcnt_width(struct annotation *notes)
310 return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events;
313 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes)
315 return notes->options->hide_src_code && al->offset == -1;
318 void annotation__set_offsets(struct annotation *notes, s64 size);
319 void annotation__compute_ipc(struct annotation *notes, size_t size);
320 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
321 void annotation__update_column_widths(struct annotation *notes);
322 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);
324 static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
326 return ((void *)src->histograms) + (src->sizeof_sym_hist * idx);
329 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
331 return annotated_source__histogram(notes->src, idx);
334 static inline struct annotation *symbol__annotation(struct symbol *sym)
336 return (void *)sym - symbol_conf.priv_size;
339 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
340 struct evsel *evsel);
342 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
343 struct addr_map_symbol *start,
346 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
347 struct evsel *evsel, u64 addr);
349 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
350 void symbol__annotate_zero_histograms(struct symbol *sym);
352 int symbol__annotate(struct map_symbol *ms,
354 struct annotation_options *options,
355 struct arch **parch);
356 int symbol__annotate2(struct map_symbol *ms,
358 struct annotation_options *options,
359 struct arch **parch);
361 enum symbol_disassemble_errno {
362 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0,
365 * Choose an arbitrary negative big number not to clash with standard
366 * errno since SUS requires the errno has distinct positive values.
367 * See 'Issue 6' in the link below.
369 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
371 __SYMBOL_ANNOTATE_ERRNO__START = -10000,
373 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START,
374 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
375 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING,
376 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP,
377 SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE,
378 SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF,
380 __SYMBOL_ANNOTATE_ERRNO__END,
383 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen);
385 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
386 struct annotation_options *options);
387 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
388 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
389 void annotated_source__purge(struct annotated_source *as);
391 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
392 struct annotation_options *opts);
394 bool ui__has_annotation(void);
396 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
398 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
400 #ifdef HAVE_SLANG_SUPPORT
401 int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
402 struct hist_browser_timer *hbt,
403 struct annotation_options *opts);
405 static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
406 struct evsel *evsel __maybe_unused,
407 struct hist_browser_timer *hbt __maybe_unused,
408 struct annotation_options *opts __maybe_unused)
414 void annotation_config__init(struct annotation_options *opt);
416 int annotate_parse_percent_type(const struct option *opt, const char *_str,
419 int annotate_check_args(struct annotation_options *args);
421 #endif /* __PERF_ANNOTATE_H */