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 <pthread.h> 12#include <asm/bug.h> 13#include "symbol_conf.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; 26 27struct ins { 28 const char *name; 29 struct ins_ops *ops; 30}; 31 32struct ins_operands { 33 char *raw; 34 char *raw_comment; 35 char *raw_func_start; 36 struct { 37 char *raw; 38 char *name; 39 struct symbol *sym; 40 u64 addr; 41 s64 offset; 42 bool offset_avail; 43 bool outside; 44 } target; 45 union { 46 struct { 47 char *raw; 48 char *name; 49 u64 addr; 50 } source; 51 struct { 52 struct ins ins; 53 struct ins_operands *ops; 54 } locked; 55 }; 56}; 57 58struct arch; 59 60struct ins_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); 65}; 66 67bool ins__is_jump(const struct ins *ins); 68bool ins__is_call(const struct ins *ins); 69bool ins__is_ret(const struct ins *ins); 70bool ins__is_lock(const struct ins *ins); 71int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name); 72bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2); 73 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 79 80struct annotation_options { 81 bool hide_src_code, 82 use_offset, 83 jump_arrows, 84 print_lines, 85 full_path, 86 show_linenr, 87 show_nr_jumps, 88 show_minmax_cycle, 89 show_asm_raw, 90 annotate_src; 91 u8 offset_level; 92 int min_pcnt; 93 int max_lines; 94 int context; 95 const char *objdump_path; 96 const char *disassembler_style; 97 const char *prefix; 98 const char *prefix_strip; 99 unsigned int percent_type; 100}; 101 102enum { 103 ANNOTATION__OFFSET_JUMP_TARGETS = 1, 104 ANNOTATION__OFFSET_CALL, 105 ANNOTATION__MAX_OFFSET_LEVEL, 106}; 107 108#define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS 109 110extern struct annotation_options annotation__default_options; 111 112struct annotation; 113 114struct sym_hist_entry { 115 u64 nr_samples; 116 u64 period; 117}; 118 119enum { 120 PERCENT_HITS_LOCAL, 121 PERCENT_HITS_GLOBAL, 122 PERCENT_PERIOD_LOCAL, 123 PERCENT_PERIOD_GLOBAL, 124 PERCENT_MAX, 125}; 126 127struct annotation_data { 128 double percent[PERCENT_MAX]; 129 double percent_sum; 130 struct sym_hist_entry he; 131}; 132 133struct annotation_line { 134 struct list_head node; 135 struct rb_node rb_node; 136 s64 offset; 137 char *line; 138 int line_nr; 139 int jump_sources; 140 float ipc; 141 u64 cycles; 142 u64 cycles_max; 143 u64 cycles_min; 144 char *path; 145 u32 idx; 146 int idx_asm; 147 int data_nr; 148 struct annotation_data data[]; 149}; 150 151struct disasm_line { 152 struct ins ins; 153 struct ins_operands ops; 154 155 /* This needs to be at the end. */ 156 struct annotation_line al; 157}; 158 159static inline double annotation_data__percent(struct annotation_data *data, 160 unsigned int which) 161{ 162 return which < PERCENT_MAX ? data->percent[which] : -1; 163} 164 165static inline const char *percent_type_str(unsigned int type) 166{ 167 static const char *str[PERCENT_MAX] = { 168 "local hits", 169 "global hits", 170 "local period", 171 "global period", 172 }; 173 174 if (WARN_ON(type >= PERCENT_MAX)) 175 return "N/A"; 176 177 return str[type]; 178} 179 180static inline struct disasm_line *disasm_line(struct annotation_line *al) 181{ 182 return al ? container_of(al, struct disasm_line, al) : NULL; 183} 184 185/* 186 * Is this offset in the same function as the line it is used? 187 * asm functions jump to other functions, for instance. 188 */ 189static inline bool disasm_line__has_local_offset(const struct disasm_line *dl) 190{ 191 return dl->ops.target.offset_avail && !dl->ops.target.outside; 192} 193 194/* 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? 197 */ 198bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym); 199 200void disasm_line__free(struct disasm_line *dl); 201struct annotation_line * 202annotation_line__next(struct annotation_line *pos, struct list_head *head); 203 204struct annotation_write_ops { 205 bool first_line, current_entry, change_color; 206 int width; 207 void *obj; 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); 213}; 214 215void annotation_line__write(struct annotation_line *al, struct annotation *notes, 216 struct annotation_write_ops *ops, 217 struct annotation_options *opts); 218 219int __annotation__scnprintf_samples_period(struct annotation *notes, 220 char *bf, size_t size, 221 struct evsel *evsel, 222 bool show_freq); 223 224int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name); 225size_t disasm__fprintf(struct list_head *head, FILE *fp); 226void symbol__calc_percent(struct symbol *sym, struct evsel *evsel); 227 228struct sym_hist { 229 u64 nr_samples; 230 u64 period; 231 struct sym_hist_entry addr[]; 232}; 233 234struct cyc_hist { 235 u64 start; 236 u64 cycles; 237 u64 cycles_aggr; 238 u64 cycles_max; 239 u64 cycles_min; 240 s64 cycles_spark[NUM_SPARKS]; 241 u32 num; 242 u32 num_aggr; 243 u8 have_start; 244 /* 1 byte padding */ 245 u16 reset; 246}; 247 248/** struct annotated_source - symbols with hits have this attached as in sannotation 249 * 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 258 * 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 263 * returns. 264 */ 265struct annotated_source { 266 struct list_head source; 267 int nr_histograms; 268 size_t sizeof_sym_hist; 269 struct cyc_hist *cycles_hist; 270 struct sym_hist *histograms; 271}; 272 273struct annotation { 274 pthread_mutex_t lock; 275 u64 max_coverage; 276 u64 start; 277 u64 hit_cycles; 278 u64 hit_insn; 279 unsigned int total_insn; 280 unsigned int cover_insn; 281 struct annotation_options *options; 282 struct annotation_line **offsets; 283 int nr_events; 284 int max_jump_sources; 285 int nr_entries; 286 int nr_asm_entries; 287 u16 max_line_len; 288 struct { 289 u8 addr; 290 u8 jumps; 291 u8 target; 292 u8 min_addr; 293 u8 max_addr; 294 u8 max_ins_name; 295 } widths; 296 bool have_cycles; 297 struct annotated_source *src; 298}; 299 300static inline int annotation__cycles_width(struct annotation *notes) 301{ 302 if (notes->have_cycles && notes->options->show_minmax_cycle) 303 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH; 304 305 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0; 306} 307 308static inline int annotation__pcnt_width(struct annotation *notes) 309{ 310 return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events; 311} 312 313static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes) 314{ 315 return notes->options->hide_src_code && al->offset == -1; 316} 317 318void annotation__set_offsets(struct annotation *notes, s64 size); 319void annotation__compute_ipc(struct annotation *notes, size_t size); 320void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym); 321void annotation__update_column_widths(struct annotation *notes); 322void annotation__init_column_widths(struct annotation *notes, struct symbol *sym); 323 324static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx) 325{ 326 return ((void *)src->histograms) + (src->sizeof_sym_hist * idx); 327} 328 329static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx) 330{ 331 return annotated_source__histogram(notes->src, idx); 332} 333 334static inline struct annotation *symbol__annotation(struct symbol *sym) 335{ 336 return (void *)sym - symbol_conf.priv_size; 337} 338 339int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample, 340 struct evsel *evsel); 341 342int addr_map_symbol__account_cycles(struct addr_map_symbol *ams, 343 struct addr_map_symbol *start, 344 unsigned cycles); 345 346int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample, 347 struct evsel *evsel, u64 addr); 348 349struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists); 350void symbol__annotate_zero_histograms(struct symbol *sym); 351 352int symbol__annotate(struct map_symbol *ms, 353 struct evsel *evsel, 354 struct annotation_options *options, 355 struct arch **parch); 356int symbol__annotate2(struct map_symbol *ms, 357 struct evsel *evsel, 358 struct annotation_options *options, 359 struct arch **parch); 360 361enum symbol_disassemble_errno { 362 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0, 363 364 /* 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. 368 * 369 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html 370 */ 371 __SYMBOL_ANNOTATE_ERRNO__START = -10000, 372 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, 379 380 __SYMBOL_ANNOTATE_ERRNO__END, 381}; 382 383int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen); 384 385int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel, 386 struct annotation_options *options); 387void symbol__annotate_zero_histogram(struct symbol *sym, int evidx); 388void symbol__annotate_decay_histogram(struct symbol *sym, int evidx); 389void annotated_source__purge(struct annotated_source *as); 390 391int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel, 392 struct annotation_options *opts); 393 394bool ui__has_annotation(void); 395 396int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts); 397 398int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts); 399 400#ifdef HAVE_SLANG_SUPPORT 401int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel, 402 struct hist_browser_timer *hbt, 403 struct annotation_options *opts); 404#else 405static 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) 409{ 410 return 0; 411} 412#endif 413 414void annotation_config__init(struct annotation_options *opt); 415 416int annotate_parse_percent_type(const struct option *opt, const char *_str, 417 int unset); 418 419int annotate_check_args(struct annotation_options *args); 420 421#endif /* __PERF_ANNOTATE_H */ 422