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 <linux/types.h> 8 #include "symbol.h" 9 #include "hist.h" 10 #include "sort.h" 11 #include <linux/list.h> 12 #include <linux/rbtree.h> 13 #include <pthread.h> 14 15 struct ins_ops; 16 17 struct ins { 18 const char *name; 19 struct ins_ops *ops; 20 }; 21 22 struct ins_operands { 23 char *raw; 24 struct { 25 char *raw; 26 char *name; 27 struct symbol *sym; 28 u64 addr; 29 s64 offset; 30 bool offset_avail; 31 bool outside; 32 } target; 33 union { 34 struct { 35 char *raw; 36 char *name; 37 u64 addr; 38 } source; 39 struct { 40 struct ins ins; 41 struct ins_operands *ops; 42 } locked; 43 }; 44 }; 45 46 struct arch; 47 48 struct ins_ops { 49 void (*free)(struct ins_operands *ops); 50 int (*parse)(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms); 51 int (*scnprintf)(struct ins *ins, char *bf, size_t size, 52 struct ins_operands *ops); 53 }; 54 55 bool ins__is_jump(const struct ins *ins); 56 bool ins__is_call(const struct ins *ins); 57 bool ins__is_ret(const struct ins *ins); 58 bool ins__is_lock(const struct ins *ins); 59 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops); 60 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2); 61 62 #define ANNOTATION__IPC_WIDTH 6 63 #define ANNOTATION__CYCLES_WIDTH 6 64 #define ANNOTATION__MINMAX_CYCLES_WIDTH 19 65 66 struct annotation_options { 67 bool hide_src_code, 68 use_offset, 69 jump_arrows, 70 show_linenr, 71 show_nr_jumps, 72 show_nr_samples, 73 show_total_period, 74 show_minmax_cycle; 75 u8 offset_level; 76 }; 77 78 enum { 79 ANNOTATION__OFFSET_JUMP_TARGETS = 1, 80 ANNOTATION__OFFSET_CALL, 81 ANNOTATION__MAX_OFFSET_LEVEL, 82 }; 83 84 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS 85 86 extern struct annotation_options annotation__default_options; 87 88 struct annotation; 89 90 struct sym_hist_entry { 91 u64 nr_samples; 92 u64 period; 93 }; 94 95 struct annotation_data { 96 double percent; 97 double percent_sum; 98 struct sym_hist_entry he; 99 }; 100 101 struct annotation_line { 102 struct list_head node; 103 struct rb_node rb_node; 104 s64 offset; 105 char *line; 106 int line_nr; 107 int jump_sources; 108 float ipc; 109 u64 cycles; 110 u64 cycles_max; 111 u64 cycles_min; 112 size_t privsize; 113 char *path; 114 u32 idx; 115 int idx_asm; 116 int samples_nr; 117 struct annotation_data samples[0]; 118 }; 119 120 struct disasm_line { 121 struct ins ins; 122 struct ins_operands ops; 123 124 /* This needs to be at the end. */ 125 struct annotation_line al; 126 }; 127 128 static inline struct disasm_line *disasm_line(struct annotation_line *al) 129 { 130 return al ? container_of(al, struct disasm_line, al) : NULL; 131 } 132 133 /* 134 * Is this offset in the same function as the line it is used? 135 * asm functions jump to other functions, for instance. 136 */ 137 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl) 138 { 139 return dl->ops.target.offset_avail && !dl->ops.target.outside; 140 } 141 142 /* 143 * Can we draw an arrow from the jump to its target, for instance? I.e. 144 * is the jump and its target in the same function? 145 */ 146 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym); 147 148 void disasm_line__free(struct disasm_line *dl); 149 struct annotation_line * 150 annotation_line__next(struct annotation_line *pos, struct list_head *head); 151 152 struct annotation_write_ops { 153 bool first_line, current_entry, change_color; 154 int width; 155 void *obj; 156 int (*set_color)(void *obj, int color); 157 void (*set_percent_color)(void *obj, double percent, bool current); 158 int (*set_jumps_percent_color)(void *obj, int nr, bool current); 159 void (*printf)(void *obj, const char *fmt, ...); 160 void (*write_graph)(void *obj, int graph); 161 }; 162 163 double annotation_line__max_percent(struct annotation_line *al, struct annotation *notes); 164 void annotation_line__write(struct annotation_line *al, struct annotation *notes, 165 struct annotation_write_ops *ops); 166 167 int __annotation__scnprintf_samples_period(struct annotation *notes, 168 char *bf, size_t size, 169 struct perf_evsel *evsel, 170 bool show_freq); 171 172 static inline int annotation__scnprintf_samples_period(struct annotation *notes, 173 char *bf, size_t size, 174 struct perf_evsel *evsel) 175 { 176 return __annotation__scnprintf_samples_period(notes, bf, size, evsel, true); 177 } 178 179 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw); 180 size_t disasm__fprintf(struct list_head *head, FILE *fp); 181 void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel); 182 183 struct sym_hist { 184 u64 nr_samples; 185 u64 period; 186 struct sym_hist_entry addr[0]; 187 }; 188 189 struct cyc_hist { 190 u64 start; 191 u64 cycles; 192 u64 cycles_aggr; 193 u64 cycles_max; 194 u64 cycles_min; 195 u32 num; 196 u32 num_aggr; 197 u8 have_start; 198 /* 1 byte padding */ 199 u16 reset; 200 }; 201 202 /** struct annotated_source - symbols with hits have this attached as in sannotation 203 * 204 * @histogram: Array of addr hit histograms per event being monitored 205 * @lines: If 'print_lines' is specified, per source code line percentages 206 * @source: source parsed from a disassembler like objdump -dS 207 * @cyc_hist: Average cycles per basic block 208 * 209 * lines is allocated, percentages calculated and all sorted by percentage 210 * when the annotation is about to be presented, so the percentages are for 211 * one of the entries in the histogram array, i.e. for the event/counter being 212 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate 213 * returns. 214 */ 215 struct annotated_source { 216 struct list_head source; 217 int nr_histograms; 218 size_t sizeof_sym_hist; 219 struct cyc_hist *cycles_hist; 220 struct sym_hist histograms[0]; 221 }; 222 223 struct annotation { 224 pthread_mutex_t lock; 225 u64 max_coverage; 226 u64 start; 227 struct annotation_options *options; 228 struct annotation_line **offsets; 229 int nr_events; 230 int nr_jumps; 231 int max_jump_sources; 232 int nr_entries; 233 int nr_asm_entries; 234 u16 max_line_len; 235 struct { 236 u8 addr; 237 u8 jumps; 238 u8 target; 239 u8 min_addr; 240 u8 max_addr; 241 } widths; 242 bool have_cycles; 243 struct annotated_source *src; 244 }; 245 246 static inline int annotation__cycles_width(struct annotation *notes) 247 { 248 if (notes->have_cycles && notes->options->show_minmax_cycle) 249 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH; 250 251 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0; 252 } 253 254 static inline int annotation__pcnt_width(struct annotation *notes) 255 { 256 return (notes->options->show_total_period ? 12 : 7) * notes->nr_events; 257 } 258 259 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes) 260 { 261 return notes->options->hide_src_code && al->offset == -1; 262 } 263 264 void annotation__set_offsets(struct annotation *notes, s64 size); 265 void annotation__compute_ipc(struct annotation *notes, size_t size); 266 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym); 267 void annotation__update_column_widths(struct annotation *notes); 268 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym); 269 270 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx) 271 { 272 return (((void *)¬es->src->histograms) + 273 (notes->src->sizeof_sym_hist * idx)); 274 } 275 276 static inline struct annotation *symbol__annotation(struct symbol *sym) 277 { 278 return (void *)sym - symbol_conf.priv_size; 279 } 280 281 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample, 282 int evidx); 283 284 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams, 285 struct addr_map_symbol *start, 286 unsigned cycles); 287 288 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample, 289 int evidx, u64 addr); 290 291 int symbol__alloc_hist(struct symbol *sym); 292 void symbol__annotate_zero_histograms(struct symbol *sym); 293 294 int symbol__annotate(struct symbol *sym, struct map *map, 295 struct perf_evsel *evsel, size_t privsize, 296 struct arch **parch); 297 int symbol__annotate2(struct symbol *sym, struct map *map, 298 struct perf_evsel *evsel, 299 struct annotation_options *options, 300 struct arch **parch); 301 302 enum symbol_disassemble_errno { 303 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0, 304 305 /* 306 * Choose an arbitrary negative big number not to clash with standard 307 * errno since SUS requires the errno has distinct positive values. 308 * See 'Issue 6' in the link below. 309 * 310 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html 311 */ 312 __SYMBOL_ANNOTATE_ERRNO__START = -10000, 313 314 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START, 315 316 __SYMBOL_ANNOTATE_ERRNO__END, 317 }; 318 319 int symbol__strerror_disassemble(struct symbol *sym, struct map *map, 320 int errnum, char *buf, size_t buflen); 321 322 int symbol__annotate_printf(struct symbol *sym, struct map *map, 323 struct perf_evsel *evsel, bool full_paths, 324 int min_pcnt, int max_lines, int context); 325 int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp); 326 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx); 327 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx); 328 void annotated_source__purge(struct annotated_source *as); 329 330 int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel); 331 332 bool ui__has_annotation(void); 333 334 int symbol__tty_annotate(struct symbol *sym, struct map *map, 335 struct perf_evsel *evsel, bool print_lines, 336 bool full_paths, int min_pcnt, int max_lines); 337 338 int symbol__tty_annotate2(struct symbol *sym, struct map *map, 339 struct perf_evsel *evsel, bool print_lines, 340 bool full_paths); 341 342 #ifdef HAVE_SLANG_SUPPORT 343 int symbol__tui_annotate(struct symbol *sym, struct map *map, 344 struct perf_evsel *evsel, 345 struct hist_browser_timer *hbt); 346 #else 347 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused, 348 struct map *map __maybe_unused, 349 struct perf_evsel *evsel __maybe_unused, 350 struct hist_browser_timer *hbt 351 __maybe_unused) 352 { 353 return 0; 354 } 355 #endif 356 357 extern const char *disassembler_style; 358 359 void annotation_config__init(void); 360 361 #endif /* __PERF_ANNOTATE_H */ 362