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 disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw); 155 size_t disasm__fprintf(struct list_head *head, FILE *fp); 156 void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel); 157 158 struct sym_hist { 159 u64 nr_samples; 160 u64 period; 161 struct sym_hist_entry addr[0]; 162 }; 163 164 struct cyc_hist { 165 u64 start; 166 u64 cycles; 167 u64 cycles_aggr; 168 u32 num; 169 u32 num_aggr; 170 u8 have_start; 171 /* 1 byte padding */ 172 u16 reset; 173 }; 174 175 /** struct annotated_source - symbols with hits have this attached as in sannotation 176 * 177 * @histogram: Array of addr hit histograms per event being monitored 178 * @lines: If 'print_lines' is specified, per source code line percentages 179 * @source: source parsed from a disassembler like objdump -dS 180 * @cyc_hist: Average cycles per basic block 181 * 182 * lines is allocated, percentages calculated and all sorted by percentage 183 * when the annotation is about to be presented, so the percentages are for 184 * one of the entries in the histogram array, i.e. for the event/counter being 185 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate 186 * returns. 187 */ 188 struct annotated_source { 189 struct list_head source; 190 int nr_histograms; 191 size_t sizeof_sym_hist; 192 struct cyc_hist *cycles_hist; 193 struct sym_hist histograms[0]; 194 }; 195 196 struct annotation { 197 pthread_mutex_t lock; 198 u64 max_coverage; 199 u64 start; 200 struct annotation_options *options; 201 struct annotation_line **offsets; 202 int nr_events; 203 int nr_jumps; 204 int max_jump_sources; 205 int nr_entries; 206 int nr_asm_entries; 207 u16 max_line_len; 208 struct { 209 u8 addr; 210 u8 jumps; 211 u8 target; 212 u8 min_addr; 213 u8 max_addr; 214 } widths; 215 bool have_cycles; 216 struct annotated_source *src; 217 }; 218 219 static inline int annotation__cycles_width(struct annotation *notes) 220 { 221 return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0; 222 } 223 224 static inline int annotation__pcnt_width(struct annotation *notes) 225 { 226 return (notes->options->show_total_period ? 12 : 7) * notes->nr_events; 227 } 228 229 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes) 230 { 231 return notes->options->hide_src_code && al->offset == -1; 232 } 233 234 void annotation__set_offsets(struct annotation *notes, s64 size); 235 void annotation__compute_ipc(struct annotation *notes, size_t size); 236 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym); 237 void annotation__update_column_widths(struct annotation *notes); 238 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym); 239 240 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx) 241 { 242 return (((void *)¬es->src->histograms) + 243 (notes->src->sizeof_sym_hist * idx)); 244 } 245 246 static inline struct annotation *symbol__annotation(struct symbol *sym) 247 { 248 return (void *)sym - symbol_conf.priv_size; 249 } 250 251 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample, 252 int evidx); 253 254 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams, 255 struct addr_map_symbol *start, 256 unsigned cycles); 257 258 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample, 259 int evidx, u64 addr); 260 261 int symbol__alloc_hist(struct symbol *sym); 262 void symbol__annotate_zero_histograms(struct symbol *sym); 263 264 int symbol__annotate(struct symbol *sym, struct map *map, 265 struct perf_evsel *evsel, size_t privsize, 266 struct arch **parch); 267 int symbol__annotate2(struct symbol *sym, struct map *map, 268 struct perf_evsel *evsel, 269 struct annotation_options *options, 270 struct arch **parch); 271 272 enum symbol_disassemble_errno { 273 SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0, 274 275 /* 276 * Choose an arbitrary negative big number not to clash with standard 277 * errno since SUS requires the errno has distinct positive values. 278 * See 'Issue 6' in the link below. 279 * 280 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html 281 */ 282 __SYMBOL_ANNOTATE_ERRNO__START = -10000, 283 284 SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START, 285 286 __SYMBOL_ANNOTATE_ERRNO__END, 287 }; 288 289 int symbol__strerror_disassemble(struct symbol *sym, struct map *map, 290 int errnum, char *buf, size_t buflen); 291 292 int symbol__annotate_printf(struct symbol *sym, struct map *map, 293 struct perf_evsel *evsel, bool full_paths, 294 int min_pcnt, int max_lines, int context); 295 int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp); 296 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx); 297 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx); 298 void annotated_source__purge(struct annotated_source *as); 299 300 int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel); 301 302 bool ui__has_annotation(void); 303 304 int symbol__tty_annotate(struct symbol *sym, struct map *map, 305 struct perf_evsel *evsel, bool print_lines, 306 bool full_paths, int min_pcnt, int max_lines); 307 308 int symbol__tty_annotate2(struct symbol *sym, struct map *map, 309 struct perf_evsel *evsel, bool print_lines, 310 bool full_paths); 311 312 #ifdef HAVE_SLANG_SUPPORT 313 int symbol__tui_annotate(struct symbol *sym, struct map *map, 314 struct perf_evsel *evsel, 315 struct hist_browser_timer *hbt); 316 #else 317 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused, 318 struct map *map __maybe_unused, 319 struct perf_evsel *evsel __maybe_unused, 320 struct hist_browser_timer *hbt 321 __maybe_unused) 322 { 323 return 0; 324 } 325 #endif 326 327 extern const char *disassembler_style; 328 329 void annotation_config__init(void); 330 331 #endif /* __PERF_ANNOTATE_H */ 332