tools/perf/util/annotate.h

   1 #ifndef __PERF_ANNOTATE_H
   2 #define __PERF_ANNOTATE_H
   3
   4 #include <stdbool.h>
   5 #include <stdint.h>
   6 #include <linux/types.h>
   7 #include "symbol.h"
   8 #include "hist.h"
   9 #include "sort.h"
  10 #include <linux/list.h>
  11 #include <linux/rbtree.h>
  12 #include <pthread.h>
  13
  14 struct ins;
  15
  16 struct ins_operands {
  17         char    *raw;
  18         struct {
  19                 char    *raw;
  20                 char    *name;
  21                 u64     addr;
  22                 u64     offset;
  23         } target;
  24         union {
  25                 struct {
  26                         char    *raw;
  27                         char    *name;
  28                         u64     addr;
  29                 } source;
  30                 struct {
  31                         struct ins *ins;
  32                         struct ins_operands *ops;
  33                 } locked;
  34         };
  35 };
  36
  37 struct ins_ops {
  38         void (*free)(struct ins_operands *ops);
  39         int (*parse)(struct ins_operands *ops);
  40         int (*scnprintf)(struct ins *ins, char *bf, size_t size,
  41                          struct ins_operands *ops);
  42 };
  43
  44 struct ins {
  45         const char     *name;
  46         struct ins_ops *ops;
  47 };
  48
  49 bool ins__is_jump(const struct ins *ins);
  50 bool ins__is_call(const struct ins *ins);
  51 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
  52
  53 struct annotation;
  54
  55 struct disasm_line {
  56         struct list_head    node;
  57         s64                 offset;
  58         char                *line;
  59         char                *name;
  60         struct ins          *ins;
  61         int                 line_nr;
  62         struct ins_operands ops;
  63 };
  64
  65 static inline bool disasm_line__has_offset(const struct disasm_line *dl)
  66 {
  67         return dl->ops.target.offset != UINT64_MAX;
  68 }
  69
  70 void disasm_line__free(struct disasm_line *dl);
  71 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
  72 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
  73 size_t disasm__fprintf(struct list_head *head, FILE *fp);
  74 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
  75                             s64 end, const char **path, u64 *nr_samples);
  76
  77 struct sym_hist {
  78         u64             sum;
  79         u64             addr[0];
  80 };
  81
  82 struct source_line_samples {
  83         double          percent;
  84         double          percent_sum;
  85         double          nr;
  86 };
  87
  88 struct source_line {
  89         struct rb_node  node;
  90         char            *path;
  91         int             nr_pcnt;
  92         struct source_line_samples samples[1];
  93 };
  94
  95 /** struct annotated_source - symbols with hits have this attached as in sannotation
  96  *
  97  * @histogram: Array of addr hit histograms per event being monitored
  98  * @lines: If 'print_lines' is specified, per source code line percentages
  99  * @source: source parsed from a disassembler like objdump -dS
 100  *
 101  * lines is allocated, percentages calculated and all sorted by percentage
 102  * when the annotation is about to be presented, so the percentages are for
 103  * one of the entries in the histogram array, i.e. for the event/counter being
 104  * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
 105  * returns.
 106  */
 107 struct annotated_source {
 108         struct list_head   source;
 109         struct source_line *lines;
 110         int                nr_histograms;
 111         int                sizeof_sym_hist;
 112         struct sym_hist    histograms[0];
 113 };
 114
 115 struct annotation {
 116         pthread_mutex_t         lock;
 117         struct annotated_source *src;
 118 };
 119
 120 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
 121 {
 122         return (((void *)&notes->src->histograms) +
 123                 (notes->src->sizeof_sym_hist * idx));
 124 }
 125
 126 static inline struct annotation *symbol__annotation(struct symbol *sym)
 127 {
 128         return (void *)sym - symbol_conf.priv_size;
 129 }
 130
 131 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
 132
 133 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
 134
 135 int symbol__alloc_hist(struct symbol *sym);
 136 void symbol__annotate_zero_histograms(struct symbol *sym);
 137
 138 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
 139
 140 int hist_entry__annotate(struct hist_entry *he, size_t privsize);
 141
 142 int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
 143 int symbol__annotate_printf(struct symbol *sym, struct map *map,
 144                             struct perf_evsel *evsel, bool full_paths,
 145                             int min_pcnt, int max_lines, int context);
 146 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
 147 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
 148 void disasm__purge(struct list_head *head);
 149
 150 bool ui__has_annotation(void);
 151
 152 int symbol__tty_annotate(struct symbol *sym, struct map *map,
 153                          struct perf_evsel *evsel, bool print_lines,
 154                          bool full_paths, int min_pcnt, int max_lines);
 155
 156 #ifdef HAVE_SLANG_SUPPORT
 157 int symbol__tui_annotate(struct symbol *sym, struct map *map,
 158                          struct perf_evsel *evsel,
 159                          struct hist_browser_timer *hbt);
 160 #else
 161 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
 162                                 struct map *map __maybe_unused,
 163                                 struct perf_evsel *evsel  __maybe_unused,
 164                                 struct hist_browser_timer *hbt
 165                                 __maybe_unused)
 166 {
 167         return 0;
 168 }
 169 #endif
 170
 171 extern const char       *disassembler_style;
 172
 173 #endif  /* __PERF_ANNOTATE_H */