tools/perf/util/annotate.h

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