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