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