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 {
96 const char *objdump_path;
97 const char *disassembler_style;
99 const char *prefix_strip;
100 unsigned int percent_type;
104 ANNOTATION__OFFSET_JUMP_TARGETS = 1,
105 ANNOTATION__OFFSET_CALL,
106 ANNOTATION__MAX_OFFSET_LEVEL,
109 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
111 extern struct annotation_options annotation__default_options;
115 struct sym_hist_entry {
123 PERCENT_PERIOD_LOCAL,
124 PERCENT_PERIOD_GLOBAL,
128 struct annotation_data {
129 double percent[PERCENT_MAX];
131 struct sym_hist_entry he;
134 struct annotation_line {
135 struct list_head node;
136 struct rb_node rb_node;
150 struct annotation_data data[];
155 struct ins_operands ops;
157 /* This needs to be at the end. */
158 struct annotation_line al;
161 static inline double annotation_data__percent(struct annotation_data *data,
164 return which < PERCENT_MAX ? data->percent[which] : -1;
167 static inline const char *percent_type_str(unsigned int type)
169 static const char *str[PERCENT_MAX] = {
176 if (WARN_ON(type >= PERCENT_MAX))
182 static inline struct disasm_line *disasm_line(struct annotation_line *al)
184 return al ? container_of(al, struct disasm_line, al) : NULL;
188 * Is this offset in the same function as the line it is used?
189 * asm functions jump to other functions, for instance.
191 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
193 return dl->ops.target.offset_avail && !dl->ops.target.outside;
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?
200 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
202 void disasm_line__free(struct disasm_line *dl);
203 struct annotation_line *
204 annotation_line__next(struct annotation_line *pos, struct list_head *head);
206 struct annotation_write_ops {
207 bool first_line, current_entry, change_color;
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);
217 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
218 struct annotation_write_ops *ops,
219 struct annotation_options *opts);
221 int __annotation__scnprintf_samples_period(struct annotation *notes,
222 char *bf, size_t size,
226 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
227 size_t disasm__fprintf(struct list_head *head, FILE *fp);
228 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);
233 struct sym_hist_entry addr[];
242 s64 cycles_spark[NUM_SPARKS];
250 /** struct annotated_source - symbols with hits have this attached as in sannotation
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
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
267 struct annotated_source {
268 struct list_head source;
270 size_t sizeof_sym_hist;
271 struct cyc_hist *cycles_hist;
272 struct sym_hist *histograms;
276 pthread_mutex_t lock;
281 unsigned int total_insn;
282 unsigned int cover_insn;
283 struct annotation_options *options;
284 struct annotation_line **offsets;
286 int max_jump_sources;
299 struct annotated_source *src;
302 void annotation__init(struct annotation *notes);
303 void annotation__exit(struct annotation *notes);
305 static inline int annotation__cycles_width(struct annotation *notes)
307 if (notes->have_cycles && notes->options->show_minmax_cycle)
308 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
310 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
313 static inline int annotation__pcnt_width(struct annotation *notes)
315 return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events;
318 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes)
320 return notes->options->hide_src_code && al->offset == -1;
323 void annotation__set_offsets(struct annotation *notes, s64 size);
324 void annotation__compute_ipc(struct annotation *notes, size_t size);
325 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
326 void annotation__update_column_widths(struct annotation *notes);
327 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);
329 static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
331 return ((void *)src->histograms) + (src->sizeof_sym_hist * idx);
334 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
336 return annotated_source__histogram(notes->src, idx);
339 static inline struct annotation *symbol__annotation(struct symbol *sym)
341 return (void *)sym - symbol_conf.priv_size;
344 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
345 struct evsel *evsel);
347 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
348 struct addr_map_symbol *start,
351 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
352 struct evsel *evsel, u64 addr);
354 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
355 void symbol__annotate_zero_histograms(struct symbol *sym);
357 int symbol__annotate(struct map_symbol *ms,
359 struct annotation_options *options,
360 struct arch **parch);
361 int symbol__annotate2(struct map_symbol *ms,
363 struct annotation_options *options,
364 struct arch **parch);
366 enum symbol_disassemble_errno {
367 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0,
370 * Choose an arbitrary negative big number not to clash with standard
371 * errno since SUS requires the errno has distinct positive values.
372 * See 'Issue 6' in the link below.
374 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
376 __SYMBOL_ANNOTATE_ERRNO__START = -10000,
378 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START,
379 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
380 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING,
381 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP,
382 SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE,
383 SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF,
385 __SYMBOL_ANNOTATE_ERRNO__END,
388 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen);
390 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
391 struct annotation_options *options);
392 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
393 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
394 void annotated_source__purge(struct annotated_source *as);
396 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
397 struct annotation_options *opts);
399 bool ui__has_annotation(void);
401 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
403 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
405 #ifdef HAVE_SLANG_SUPPORT
406 int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
407 struct hist_browser_timer *hbt,
408 struct annotation_options *opts);
410 static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
411 struct evsel *evsel __maybe_unused,
412 struct hist_browser_timer *hbt __maybe_unused,
413 struct annotation_options *opts __maybe_unused)
419 void annotation_config__init(struct annotation_options *opt);
421 int annotate_parse_percent_type(const struct option *opt, const char *_str,
424 int annotate_check_args(struct annotation_options *args);
426 #endif /* __PERF_ANNOTATE_H */