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 #include "hashmap.h" 16 #include "disasm.h" 17 18 struct hist_browser_timer; 19 struct hist_entry; 20 struct map; 21 struct map_symbol; 22 struct addr_map_symbol; 23 struct option; 24 struct perf_sample; 25 struct evsel; 26 struct symbol; 27 struct annotated_data_type; 28 29 #define ANNOTATION__IPC_WIDTH 6 30 #define ANNOTATION__CYCLES_WIDTH 6 31 #define ANNOTATION__MINMAX_CYCLES_WIDTH 19 32 #define ANNOTATION__AVG_IPC_WIDTH 36 33 #define ANNOTATION_DUMMY_LEN 256 34 35 struct annotation_options { 36 bool hide_src_code, 37 use_offset, 38 jump_arrows, 39 print_lines, 40 full_path, 41 show_linenr, 42 show_fileloc, 43 show_nr_jumps, 44 show_minmax_cycle, 45 show_asm_raw, 46 annotate_src, 47 full_addr; 48 u8 offset_level; 49 int min_pcnt; 50 int max_lines; 51 int context; 52 char *objdump_path; 53 char *disassembler_style; 54 const char *prefix; 55 const char *prefix_strip; 56 unsigned int percent_type; 57 }; 58 59 extern struct annotation_options annotate_opts; 60 61 enum { 62 ANNOTATION__OFFSET_JUMP_TARGETS = 1, 63 ANNOTATION__OFFSET_CALL, 64 ANNOTATION__MAX_OFFSET_LEVEL, 65 }; 66 67 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS 68 69 struct annotation; 70 71 struct sym_hist_entry { 72 u64 nr_samples; 73 u64 period; 74 }; 75 76 enum { 77 PERCENT_HITS_LOCAL, 78 PERCENT_HITS_GLOBAL, 79 PERCENT_PERIOD_LOCAL, 80 PERCENT_PERIOD_GLOBAL, 81 PERCENT_MAX, 82 }; 83 84 struct annotation_data { 85 double percent[PERCENT_MAX]; 86 double percent_sum; 87 struct sym_hist_entry he; 88 }; 89 90 struct cycles_info { 91 float ipc; 92 u64 avg; 93 u64 max; 94 u64 min; 95 }; 96 97 struct annotation_line { 98 struct list_head node; 99 struct rb_node rb_node; 100 s64 offset; 101 char *line; 102 int line_nr; 103 char *fileloc; 104 char *path; 105 struct cycles_info *cycles; 106 int jump_sources; 107 u32 idx; 108 int idx_asm; 109 int data_nr; 110 struct annotation_data data[]; 111 }; 112 113 struct disasm_line { 114 struct ins ins; 115 struct ins_operands ops; 116 union { 117 u8 bytes[4]; 118 u32 raw_insn; 119 } raw; 120 /* This needs to be at the end. */ 121 struct annotation_line al; 122 }; 123 124 void annotation_line__add(struct annotation_line *al, struct list_head *head); 125 126 static inline double annotation_data__percent(struct annotation_data *data, 127 unsigned int which) 128 { 129 return which < PERCENT_MAX ? data->percent[which] : -1; 130 } 131 132 static inline const char *percent_type_str(unsigned int type) 133 { 134 static const char *str[PERCENT_MAX] = { 135 "local hits", 136 "global hits", 137 "local period", 138 "global period", 139 }; 140 141 if (WARN_ON(type >= PERCENT_MAX)) 142 return "N/A"; 143 144 return str[type]; 145 } 146 147 static inline struct disasm_line *disasm_line(struct annotation_line *al) 148 { 149 return al ? container_of(al, struct disasm_line, al) : NULL; 150 } 151 152 /* 153 * Is this offset in the same function as the line it is used? 154 * asm functions jump to other functions, for instance. 155 */ 156 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl) 157 { 158 return dl->ops.target.offset_avail && !dl->ops.target.outside; 159 } 160 161 /* 162 * Can we draw an arrow from the jump to its target, for instance? I.e. 163 * is the jump and its target in the same function? 164 */ 165 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym); 166 167 struct annotation_line * 168 annotation_line__next(struct annotation_line *pos, struct list_head *head); 169 170 struct annotation_write_ops { 171 bool first_line, current_entry, change_color; 172 int width; 173 void *obj; 174 int (*set_color)(void *obj, int color); 175 void (*set_percent_color)(void *obj, double percent, bool current); 176 int (*set_jumps_percent_color)(void *obj, int nr, bool current); 177 void (*printf)(void *obj, const char *fmt, ...); 178 void (*write_graph)(void *obj, int graph); 179 }; 180 181 void annotation_line__write(struct annotation_line *al, struct annotation *notes, 182 struct annotation_write_ops *ops); 183 184 int __annotation__scnprintf_samples_period(struct annotation *notes, 185 char *bf, size_t size, 186 struct evsel *evsel, 187 bool show_freq); 188 189 size_t disasm__fprintf(struct list_head *head, FILE *fp); 190 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel); 191 192 /** 193 * struct sym_hist - symbol histogram information for an event 194 * 195 * @nr_samples: Total number of samples. 196 * @period: Sum of sample periods. 197 */ 198 struct sym_hist { 199 u64 nr_samples; 200 u64 period; 201 }; 202 203 /** 204 * struct cyc_hist - (CPU) cycle histogram for a basic block 205 * 206 * @start: Start address of current block (if known). 207 * @cycles: Sum of cycles for the longest basic block. 208 * @cycles_aggr: Total cycles for this address. 209 * @cycles_max: Max cycles for this address. 210 * @cycles_min: Min cycles for this address. 211 * @cycles_spark: History of cycles for the longest basic block. 212 * @num: Number of samples for the longest basic block. 213 * @num_aggr: Total number of samples for this address. 214 * @have_start: Whether the current branch info has a start address. 215 * @reset: Number of resets due to a different start address. 216 * 217 * If sample has branch_stack and cycles info, it can construct basic blocks 218 * between two adjacent branches. It'd have start and end addresses but 219 * sometimes the start address may not be available. So the cycles are 220 * accounted at the end address. If multiple basic blocks end at the same 221 * address, it will take the longest one. 222 * 223 * The @start, @cycles, @cycles_spark and @num fields are used for the longest 224 * block only. Other fields are used for all cases. 225 * 226 * See __symbol__account_cycles(). 227 */ 228 struct cyc_hist { 229 u64 start; 230 u64 cycles; 231 u64 cycles_aggr; 232 u64 cycles_max; 233 u64 cycles_min; 234 s64 cycles_spark[NUM_SPARKS]; 235 u32 num; 236 u32 num_aggr; 237 u8 have_start; 238 /* 1 byte padding */ 239 u16 reset; 240 }; 241 242 /** 243 * struct annotated_source - symbols with hits have this attached as in annotation 244 * 245 * @source: List head for annotated_line (embeded in disasm_line). 246 * @histograms: Array of symbol histograms per event to maintain the total number 247 * of samples and period. 248 * @nr_histograms: This may not be the same as evsel->evlist->core.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 * @samples: Hash map of sym_hist_entry. Keyed by event index and offset in symbol. 253 * @nr_events: Number of events in the current output. 254 * @nr_entries: Number of annotated_line in the source list. 255 * @nr_asm_entries: Number of annotated_line with actual asm instruction in the 256 * source list. 257 * @max_jump_sources: Maximum number of jump instructions targeting to the same 258 * instruction. 259 * @widths: Precalculated width of each column in the TUI output. 260 * 261 * disasm_lines are 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 265 * returns. 266 */ 267 struct annotated_source { 268 struct list_head source; 269 struct sym_hist *histograms; 270 struct hashmap *samples; 271 int nr_histograms; 272 int nr_events; 273 int nr_entries; 274 int nr_asm_entries; 275 int max_jump_sources; 276 u64 start; 277 struct { 278 u8 addr; 279 u8 jumps; 280 u8 target; 281 u8 min_addr; 282 u8 max_addr; 283 u8 max_ins_name; 284 u16 max_line_len; 285 } widths; 286 }; 287 288 struct annotation_line *annotated_source__get_line(struct annotated_source *src, 289 s64 offset); 290 291 /** 292 * struct annotated_branch - basic block and IPC information for a symbol. 293 * 294 * @hit_cycles: Total executed cycles. 295 * @hit_insn: Total number of instructions executed. 296 * @total_insn: Number of instructions in the function. 297 * @cover_insn: Number of distinct, actually executed instructions. 298 * @cycles_hist: Array of cyc_hist for each instruction. 299 * @max_coverage: Maximum number of covered basic block (used for block-range). 300 * 301 * This struct is used by two different codes when the sample has branch stack 302 * and cycles information. annotation__compute_ipc() calculates average IPC 303 * using @hit_insn / @hit_cycles. The actual coverage can be calculated using 304 * @cover_insn / @total_insn. The @cycles_hist can give IPC for each (longest) 305 * basic block ends at the given address. 306 * process_basic_block() calculates coverage of instructions (or basic blocks) 307 * in the function. 308 */ 309 struct annotated_branch { 310 u64 hit_cycles; 311 u64 hit_insn; 312 unsigned int total_insn; 313 unsigned int cover_insn; 314 struct cyc_hist *cycles_hist; 315 u64 max_coverage; 316 }; 317 318 struct LOCKABLE annotation { 319 struct annotated_source *src; 320 struct annotated_branch *branch; 321 }; 322 323 static inline void annotation__init(struct annotation *notes __maybe_unused) 324 { 325 } 326 void annotation__exit(struct annotation *notes); 327 328 void annotation__lock(struct annotation *notes) EXCLUSIVE_LOCK_FUNCTION(*notes); 329 void annotation__unlock(struct annotation *notes) UNLOCK_FUNCTION(*notes); 330 bool annotation__trylock(struct annotation *notes) EXCLUSIVE_TRYLOCK_FUNCTION(true, *notes); 331 332 static inline int annotation__cycles_width(struct annotation *notes) 333 { 334 if (notes->branch && annotate_opts.show_minmax_cycle) 335 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH; 336 337 return notes->branch ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0; 338 } 339 340 static inline int annotation__pcnt_width(struct annotation *notes) 341 { 342 return (symbol_conf.show_total_period ? 12 : 7) * notes->src->nr_events; 343 } 344 345 static inline bool annotation_line__filter(struct annotation_line *al) 346 { 347 return annotate_opts.hide_src_code && al->offset == -1; 348 } 349 350 void annotation__update_column_widths(struct annotation *notes); 351 void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms); 352 353 static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx) 354 { 355 return &src->histograms[idx]; 356 } 357 358 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx) 359 { 360 return annotated_source__histogram(notes->src, idx); 361 } 362 363 static inline struct sym_hist_entry * 364 annotated_source__hist_entry(struct annotated_source *src, int idx, u64 offset) 365 { 366 struct sym_hist_entry *entry; 367 long key = offset << 16 | idx; 368 369 if (!hashmap__find(src->samples, key, &entry)) 370 return NULL; 371 return entry; 372 } 373 374 static inline struct annotation *symbol__annotation(struct symbol *sym) 375 { 376 return (void *)sym - symbol_conf.priv_size; 377 } 378 379 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample, 380 struct evsel *evsel); 381 382 struct annotated_branch *annotation__get_branch(struct annotation *notes); 383 384 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams, 385 struct addr_map_symbol *start, 386 unsigned cycles); 387 388 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample, 389 struct evsel *evsel, u64 addr); 390 391 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists); 392 void symbol__annotate_zero_histograms(struct symbol *sym); 393 394 int symbol__annotate(struct map_symbol *ms, 395 struct evsel *evsel, 396 struct arch **parch); 397 int symbol__annotate2(struct map_symbol *ms, 398 struct evsel *evsel, 399 struct arch **parch); 400 401 enum symbol_disassemble_errno { 402 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0, 403 404 /* 405 * Choose an arbitrary negative big number not to clash with standard 406 * errno since SUS requires the errno has distinct positive values. 407 * See 'Issue 6' in the link below. 408 * 409 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html 410 */ 411 __SYMBOL_ANNOTATE_ERRNO__START = -10000, 412 413 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START, 414 SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF, 415 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING, 416 SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP, 417 SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE, 418 SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF, 419 420 __SYMBOL_ANNOTATE_ERRNO__END, 421 }; 422 423 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen); 424 425 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel); 426 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx); 427 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx); 428 void annotated_source__purge(struct annotated_source *as); 429 430 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel); 431 432 bool ui__has_annotation(void); 433 434 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel); 435 436 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel); 437 438 #ifdef HAVE_SLANG_SUPPORT 439 int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel, 440 struct hist_browser_timer *hbt); 441 #else 442 static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused, 443 struct evsel *evsel __maybe_unused, 444 struct hist_browser_timer *hbt __maybe_unused) 445 { 446 return 0; 447 } 448 #endif 449 450 void annotation_options__init(void); 451 void annotation_options__exit(void); 452 453 void annotation_config__init(void); 454 455 int annotate_parse_percent_type(const struct option *opt, const char *_str, 456 int unset); 457 458 int annotate_check_args(void); 459 460 /** 461 * struct annotated_op_loc - Location info of instruction operand 462 * @reg1: First register in the operand 463 * @reg2: Second register in the operand 464 * @offset: Memory access offset in the operand 465 * @segment: Segment selector register 466 * @mem_ref: Whether the operand accesses memory 467 * @multi_regs: Whether the second register is used 468 * @imm: Whether the operand is an immediate value (in offset) 469 */ 470 struct annotated_op_loc { 471 int reg1; 472 int reg2; 473 int offset; 474 u8 segment; 475 bool mem_ref; 476 bool multi_regs; 477 bool imm; 478 }; 479 480 enum annotated_insn_ops { 481 INSN_OP_SOURCE = 0, 482 INSN_OP_TARGET = 1, 483 484 INSN_OP_MAX, 485 }; 486 487 enum annotated_x86_segment { 488 INSN_SEG_NONE = 0, 489 490 INSN_SEG_X86_CS, 491 INSN_SEG_X86_DS, 492 INSN_SEG_X86_ES, 493 INSN_SEG_X86_FS, 494 INSN_SEG_X86_GS, 495 INSN_SEG_X86_SS, 496 }; 497 498 /** 499 * struct annotated_insn_loc - Location info of instruction 500 * @ops: Array of location info for source and target operands 501 */ 502 struct annotated_insn_loc { 503 struct annotated_op_loc ops[INSN_OP_MAX]; 504 }; 505 506 #define for_each_insn_op_loc(insn_loc, i, op_loc) \ 507 for (i = INSN_OP_SOURCE, op_loc = &(insn_loc)->ops[i]; \ 508 i < INSN_OP_MAX; \ 509 i++, op_loc++) 510 511 /* Get detailed location info in the instruction */ 512 int annotate_get_insn_location(struct arch *arch, struct disasm_line *dl, 513 struct annotated_insn_loc *loc); 514 515 /* Returns a data type from the sample instruction (if any) */ 516 struct annotated_data_type *hist_entry__get_data_type(struct hist_entry *he); 517 518 struct annotated_item_stat { 519 struct list_head list; 520 char *name; 521 int good; 522 int bad; 523 }; 524 extern struct list_head ann_insn_stat; 525 526 /* Calculate PC-relative address */ 527 u64 annotate_calc_pcrel(struct map_symbol *ms, u64 ip, int offset, 528 struct disasm_line *dl); 529 530 /** 531 * struct annotated_basic_block - Basic block of instructions 532 * @list: List node 533 * @begin: start instruction in the block 534 * @end: end instruction in the block 535 */ 536 struct annotated_basic_block { 537 struct list_head list; 538 struct disasm_line *begin; 539 struct disasm_line *end; 540 }; 541 542 /* Get a list of basic blocks from src to dst addresses */ 543 int annotate_get_basic_blocks(struct symbol *sym, s64 src, s64 dst, 544 struct list_head *head); 545 546 #endif /* __PERF_ANNOTATE_H */ 547