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