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