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 <asm/bug.h> 12 #include "symbol_conf.h" 13 #include "mutex.h" 14 #include "spark.h" 15 16 struct hist_browser_timer; 17 struct hist_entry; 18 struct ins_ops; 19 struct map; 20 struct map_symbol; 21 struct addr_map_symbol; 22 struct option; 23 struct perf_sample; 24 struct evsel; 25 struct symbol; 26 27 struct ins { 28 const char *name; 29 struct ins_ops *ops; 30 }; 31 32 struct 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 58 struct arch; 59 60 struct 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 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); 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 80 struct annotation_options { 81 bool hide_src_code, 82 use_offset, 83 jump_arrows, 84 print_lines, 85 full_path, 86 show_linenr, 87 show_fileloc, 88 show_nr_jumps, 89 show_minmax_cycle, 90 show_asm_raw, 91 annotate_src, 92 full_addr; 93 u8 offset_level; 94 int min_pcnt; 95 int max_lines; 96 int context; 97 char *objdump_path; 98 char *disassembler_style; 99 const char *prefix; 100 const char *prefix_strip; 101 unsigned int percent_type; 102 }; 103 104 extern struct annotation_options annotate_opts; 105 106 enum { 107 ANNOTATION__OFFSET_JUMP_TARGETS = 1, 108 ANNOTATION__OFFSET_CALL, 109 ANNOTATION__MAX_OFFSET_LEVEL, 110 }; 111 112 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS 113 114 struct annotation; 115 116 struct sym_hist_entry { 117 u64 nr_samples; 118 u64 period; 119 }; 120 121 enum { 122 PERCENT_HITS_LOCAL, 123 PERCENT_HITS_GLOBAL, 124 PERCENT_PERIOD_LOCAL, 125 PERCENT_PERIOD_GLOBAL, 126 PERCENT_MAX, 127 }; 128 129 struct annotation_data { 130 double percent[PERCENT_MAX]; 131 double percent_sum; 132 struct sym_hist_entry he; 133 }; 134 135 struct cycles_info { 136 float ipc; 137 u64 avg; 138 u64 max; 139 u64 min; 140 }; 141 142 struct annotation_line { 143 struct list_head node; 144 struct rb_node rb_node; 145 s64 offset; 146 char *line; 147 int line_nr; 148 char *fileloc; 149 char *path; 150 struct cycles_info *cycles; 151 int jump_sources; 152 u32 idx; 153 int idx_asm; 154 int data_nr; 155 struct annotation_data data[]; 156 }; 157 158 struct disasm_line { 159 struct ins ins; 160 struct ins_operands ops; 161 162 /* This needs to be at the end. */ 163 struct annotation_line al; 164 }; 165 166 static inline double annotation_data__percent(struct annotation_data *data, 167 unsigned int which) 168 { 169 return which < PERCENT_MAX ? data->percent[which] : -1; 170 } 171 172 static inline const char *percent_type_str(unsigned int type) 173 { 174 static const char *str[PERCENT_MAX] = { 175 "local hits", 176 "global hits", 177 "local period", 178 "global period", 179 }; 180 181 if (WARN_ON(type >= PERCENT_MAX)) 182 return "N/A"; 183 184 return str[type]; 185 } 186 187 static inline struct disasm_line *disasm_line(struct annotation_line *al) 188 { 189 return al ? container_of(al, struct disasm_line, al) : NULL; 190 } 191 192 /* 193 * Is this offset in the same function as the line it is used? 194 * asm functions jump to other functions, for instance. 195 */ 196 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl) 197 { 198 return dl->ops.target.offset_avail && !dl->ops.target.outside; 199 } 200 201 /* 202 * Can we draw an arrow from the jump to its target, for instance? I.e. 203 * is the jump and its target in the same function? 204 */ 205 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym); 206 207 void disasm_line__free(struct disasm_line *dl); 208 struct annotation_line * 209 annotation_line__next(struct annotation_line *pos, struct list_head *head); 210 211 struct annotation_write_ops { 212 bool first_line, current_entry, change_color; 213 int width; 214 void *obj; 215 int (*set_color)(void *obj, int color); 216 void (*set_percent_color)(void *obj, double percent, bool current); 217 int (*set_jumps_percent_color)(void *obj, int nr, bool current); 218 void (*printf)(void *obj, const char *fmt, ...); 219 void (*write_graph)(void *obj, int graph); 220 }; 221 222 void annotation_line__write(struct annotation_line *al, struct annotation *notes, 223 struct annotation_write_ops *ops); 224 225 int __annotation__scnprintf_samples_period(struct annotation *notes, 226 char *bf, size_t size, 227 struct evsel *evsel, 228 bool show_freq); 229 230 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name); 231 size_t disasm__fprintf(struct list_head *head, FILE *fp); 232 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel); 233 234 struct sym_hist { 235 u64 nr_samples; 236 u64 period; 237 struct sym_hist_entry addr[]; 238 }; 239 240 struct cyc_hist { 241 u64 start; 242 u64 cycles; 243 u64 cycles_aggr; 244 u64 cycles_max; 245 u64 cycles_min; 246 s64 cycles_spark[NUM_SPARKS]; 247 u32 num; 248 u32 num_aggr; 249 u8 have_start; 250 /* 1 byte padding */ 251 u16 reset; 252 }; 253 254 /** struct annotated_source - symbols with hits have this attached as in sannotation 255 * 256 * @histograms: Array of addr hit histograms per event being monitored 257 * nr_histograms: This may not be the same as evsel->evlist->core.nr_entries if 258 * we have more than a group in a evlist, where we will want 259 * to see each group separately, that is why symbol__annotate2() 260 * sets src->nr_histograms to evsel->nr_members. 261 * @lines: If 'print_lines' is specified, per source code line percentages 262 * @source: source parsed from a disassembler like objdump -dS 263 * @cyc_hist: Average cycles per basic block 264 * 265 * lines is allocated, percentages calculated and all sorted by percentage 266 * when the annotation is about to be presented, so the percentages are for 267 * one of the entries in the histogram array, i.e. for the event/counter being 268 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate 269 * returns. 270 */ 271 struct annotated_source { 272 struct list_head source; 273 int nr_histograms; 274 size_t sizeof_sym_hist; 275 struct cyc_hist *cycles_hist; 276 struct sym_hist *histograms; 277 }; 278 279 struct LOCKABLE annotation { 280 u64 max_coverage; 281 u64 start; 282 u64 hit_cycles; 283 u64 hit_insn; 284 unsigned int total_insn; 285 unsigned int cover_insn; 286 struct annotation_options *options; 287 struct annotation_line **offsets; 288 int nr_events; 289 int max_jump_sources; 290 int nr_entries; 291 int nr_asm_entries; 292 u16 max_line_len; 293 struct { 294 u8 addr; 295 u8 jumps; 296 u8 target; 297 u8 min_addr; 298 u8 max_addr; 299 u8 max_ins_name; 300 } widths; 301 bool have_cycles; 302 struct annotated_source *src; 303 }; 304 305 static inline void annotation__init(struct annotation *notes __maybe_unused) 306 { 307 } 308 void annotation__exit(struct annotation *notes); 309 310 void annotation__lock(struct annotation *notes) EXCLUSIVE_LOCK_FUNCTION(*notes); 311 void annotation__unlock(struct annotation *notes) UNLOCK_FUNCTION(*notes); 312 bool annotation__trylock(struct annotation *notes) EXCLUSIVE_TRYLOCK_FUNCTION(true, *notes); 313 314 static inline int annotation__cycles_width(struct annotation *notes) 315 { 316 if (notes->have_cycles && notes->options->show_minmax_cycle) 317 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH; 318 319 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0; 320 } 321 322 static inline int annotation__pcnt_width(struct annotation *notes) 323 { 324 return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events; 325 } 326 327 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes) 328 { 329 return notes->options->hide_src_code && al->offset == -1; 330 } 331 332 void annotation__set_offsets(struct annotation *notes, s64 size); 333 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym); 334 void annotation__update_column_widths(struct annotation *notes); 335 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym); 336 void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms); 337 338 static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx) 339 { 340 return ((void *)src->histograms) + (src->sizeof_sym_hist * idx); 341 } 342 343 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx) 344 { 345 return annotated_source__histogram(notes->src, idx); 346 } 347 348 static inline struct annotation *symbol__annotation(struct symbol *sym) 349 { 350 return (void *)sym - symbol_conf.priv_size; 351 } 352 353 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample, 354 struct evsel *evsel); 355 356 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams, 357 struct addr_map_symbol *start, 358 unsigned cycles); 359 360 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample, 361 struct evsel *evsel, u64 addr); 362 363 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists); 364 void symbol__annotate_zero_histograms(struct symbol *sym); 365 366 int symbol__annotate(struct map_symbol *ms, 367 struct evsel *evsel, 368 struct arch **parch); 369 int symbol__annotate2(struct map_symbol *ms, 370 struct evsel *evsel, 371 struct arch **parch); 372 373 enum symbol_disassemble_errno { 374 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0, 375 376 /* 377 * Choose an arbitrary negative big number not to clash with standard 378 * errno since SUS requires the errno has distinct positive values. 379 * See 'Issue 6' in the link below. 380 * 381 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html 382 */ 383 __SYMBOL_ANNOTATE_ERRNO__START = -10000, 384 385 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START, 386 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF, 387 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING, 388 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP, 389 SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE, 390 SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF, 391 392 __SYMBOL_ANNOTATE_ERRNO__END, 393 }; 394 395 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen); 396 397 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel); 398 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx); 399 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx); 400 void annotated_source__purge(struct annotated_source *as); 401 402 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel); 403 404 bool ui__has_annotation(void); 405 406 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel); 407 408 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel); 409 410 #ifdef HAVE_SLANG_SUPPORT 411 int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel, 412 struct hist_browser_timer *hbt, 413 struct annotation_options *opts); 414 #else 415 static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused, 416 struct evsel *evsel __maybe_unused, 417 struct hist_browser_timer *hbt __maybe_unused, 418 struct annotation_options *opts __maybe_unused) 419 { 420 return 0; 421 } 422 #endif 423 424 void annotation_options__init(struct annotation_options *opt); 425 void annotation_options__exit(struct annotation_options *opt); 426 427 void annotation_config__init(struct annotation_options *opt); 428 429 int annotate_parse_percent_type(const struct option *opt, const char *_str, 430 int unset); 431 432 int annotate_check_args(struct annotation_options *args); 433 434 #endif /* __PERF_ANNOTATE_H */ 435