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_ops;
  15
  16 struct ins {
  17         const char     *name;
  18         struct ins_ops *ops;
  19 };
  20
  21 struct ins_operands {
  22         char    *raw;
  23         struct {
  24                 char    *raw;
  25                 char    *name;
  26                 u64     addr;
  27                 u64     offset;
  28         } target;
  29         union {
  30                 struct {
  31                         char    *raw;
  32                         char    *name;
  33                         u64     addr;
  34                 } source;
  35                 struct {
  36                         struct ins          ins;
  37                         struct ins_operands *ops;
  38                 } locked;
  39         };
  40 };
  41
  42 struct arch;
  43
  44 struct ins_ops {
  45         void (*free)(struct ins_operands *ops);
  46         int (*parse)(struct arch *arch, struct ins_operands *ops, struct map *map);
  47         int (*scnprintf)(struct ins *ins, char *bf, size_t size,
  48                          struct ins_operands *ops);
  49 };
  50
  51 bool ins__is_jump(const struct ins *ins);
  52 bool ins__is_call(const struct ins *ins);
  53 bool ins__is_ret(const struct ins *ins);
  54 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
  55
  56 struct annotation;
  57
  58 struct disasm_line {
  59         struct list_head    node;
  60         s64                 offset;
  61         char                *line;
  62         struct ins          ins;
  63         int                 line_nr;
  64         float               ipc;
  65         u64                 cycles;
  66         struct ins_operands ops;
  67 };
  68
  69 static inline bool disasm_line__has_offset(const struct disasm_line *dl)
  70 {
  71         return dl->ops.target.offset != UINT64_MAX;
  72 }
  73
  74 void disasm_line__free(struct disasm_line *dl);
  75 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
  76 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
  77 size_t disasm__fprintf(struct list_head *head, FILE *fp);
  78 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
  79                             s64 end, const char **path, u64 *nr_samples);
  80
  81 struct sym_hist {
  82         u64             sum;
  83         u64             addr[0];
  84 };
  85
  86 struct cyc_hist {
  87         u64     start;
  88         u64     cycles;
  89         u64     cycles_aggr;
  90         u32     num;
  91         u32     num_aggr;
  92         u8      have_start;
  93         /* 1 byte padding */
  94         u16     reset;
  95 };
  96
  97 struct source_line_samples {
  98         double          percent;
  99         double          percent_sum;
 100         double          nr;
 101 };
 102
 103 struct source_line {
 104         struct rb_node  node;
 105         char            *path;
 106         int             nr_pcnt;
 107         struct source_line_samples samples[1];
 108 };
 109
 110 /** struct annotated_source - symbols with hits have this attached as in sannotation
 111  *
 112  * @histogram: Array of addr hit histograms per event being monitored
 113  * @lines: If 'print_lines' is specified, per source code line percentages
 114  * @source: source parsed from a disassembler like objdump -dS
 115  * @cyc_hist: Average cycles per basic block
 116  *
 117  * lines is allocated, percentages calculated and all sorted by percentage
 118  * when the annotation is about to be presented, so the percentages are for
 119  * one of the entries in the histogram array, i.e. for the event/counter being
 120  * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
 121  * returns.
 122  */
 123 struct annotated_source {
 124         struct list_head   source;
 125         struct source_line *lines;
 126         int                nr_histograms;
 127         size_t             sizeof_sym_hist;
 128         struct cyc_hist    *cycles_hist;
 129         struct sym_hist    histograms[0];
 130 };
 131
 132 struct annotation {
 133         pthread_mutex_t         lock;
 134         u64                     max_coverage;
 135         struct annotated_source *src;
 136 };
 137
 138 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
 139 {
 140         return (((void *)&notes->src->histograms) +
 141                 (notes->src->sizeof_sym_hist * idx));
 142 }
 143
 144 static inline struct annotation *symbol__annotation(struct symbol *sym)
 145 {
 146         return (void *)sym - symbol_conf.priv_size;
 147 }
 148
 149 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
 150
 151 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
 152                                     struct addr_map_symbol *start,
 153                                     unsigned cycles);
 154
 155 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
 156
 157 int symbol__alloc_hist(struct symbol *sym);
 158 void symbol__annotate_zero_histograms(struct symbol *sym);
 159
 160 int symbol__disassemble(struct symbol *sym, struct map *map, const char *arch_name, size_t privsize);
 161
 162 enum symbol_disassemble_errno {
 163         SYMBOL_ANNOTATE_ERRNO__SUCCESS          = 0,
 164
 165         /*
 166          * Choose an arbitrary negative big number not to clash with standard
 167          * errno since SUS requires the errno has distinct positive values.
 168          * See 'Issue 6' in the link below.
 169          *
 170          * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
 171          */
 172         __SYMBOL_ANNOTATE_ERRNO__START          = -10000,
 173
 174         SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX       = __SYMBOL_ANNOTATE_ERRNO__START,
 175
 176         __SYMBOL_ANNOTATE_ERRNO__END,
 177 };
 178
 179 int symbol__strerror_disassemble(struct symbol *sym, struct map *map,
 180                                  int errnum, char *buf, size_t buflen);
 181
 182 int symbol__annotate_printf(struct symbol *sym, struct map *map,
 183                             struct perf_evsel *evsel, bool full_paths,
 184                             int min_pcnt, int max_lines, int context);
 185 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
 186 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
 187 void disasm__purge(struct list_head *head);
 188
 189 bool ui__has_annotation(void);
 190
 191 int symbol__tty_annotate(struct symbol *sym, struct map *map,
 192                          struct perf_evsel *evsel, bool print_lines,
 193                          bool full_paths, int min_pcnt, int max_lines);
 194
 195 #ifdef HAVE_SLANG_SUPPORT
 196 int symbol__tui_annotate(struct symbol *sym, struct map *map,
 197                          struct perf_evsel *evsel,
 198                          struct hist_browser_timer *hbt);
 199 #else
 200 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
 201                                 struct map *map __maybe_unused,
 202                                 struct perf_evsel *evsel  __maybe_unused,
 203                                 struct hist_browser_timer *hbt
 204                                 __maybe_unused)
 205 {
 206         return 0;
 207 }
 208 #endif
 209
 210 extern const char       *disassembler_style;
 211
 212 #endif  /* __PERF_ANNOTATE_H */