linux/tools/perf/util/annotate.h
<<
>>
Prefs
   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
  14struct ins;
  15
  16struct 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
  37struct 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
  44struct ins {
  45        const char     *name;
  46        struct ins_ops *ops;
  47};
  48
  49bool ins__is_jump(const struct ins *ins);
  50bool ins__is_call(const struct ins *ins);
  51int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
  52
  53struct annotation;
  54
  55struct 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        float               ipc;
  63        u64                 cycles;
  64        struct ins_operands ops;
  65};
  66
  67static inline bool disasm_line__has_offset(const struct disasm_line *dl)
  68{
  69        return dl->ops.target.offset != UINT64_MAX;
  70}
  71
  72void disasm_line__free(struct disasm_line *dl);
  73struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
  74int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
  75size_t disasm__fprintf(struct list_head *head, FILE *fp);
  76double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
  77                            s64 end, const char **path, u64 *nr_samples);
  78
  79struct sym_hist {
  80        u64             sum;
  81        u64             addr[0];
  82};
  83
  84struct cyc_hist {
  85        u64     start;
  86        u64     cycles;
  87        u64     cycles_aggr;
  88        u32     num;
  89        u32     num_aggr;
  90        u8      have_start;
  91        /* 1 byte padding */
  92        u16     reset;
  93};
  94
  95struct source_line_samples {
  96        double          percent;
  97        double          percent_sum;
  98        double          nr;
  99};
 100
 101struct source_line {
 102        struct rb_node  node;
 103        char            *path;
 104        int             nr_pcnt;
 105        struct source_line_samples samples[1];
 106};
 107
 108/** struct annotated_source - symbols with hits have this attached as in sannotation
 109 *
 110 * @histogram: Array of addr hit histograms per event being monitored
 111 * @lines: If 'print_lines' is specified, per source code line percentages
 112 * @source: source parsed from a disassembler like objdump -dS
 113 * @cyc_hist: Average cycles per basic block
 114 *
 115 * lines is allocated, percentages calculated and all sorted by percentage
 116 * when the annotation is about to be presented, so the percentages are for
 117 * one of the entries in the histogram array, i.e. for the event/counter being
 118 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
 119 * returns.
 120 */
 121struct annotated_source {
 122        struct list_head   source;
 123        struct source_line *lines;
 124        int                nr_histograms;
 125        size_t             sizeof_sym_hist;
 126        struct cyc_hist    *cycles_hist;
 127        struct sym_hist    histograms[0];
 128};
 129
 130struct annotation {
 131        pthread_mutex_t         lock;
 132        struct annotated_source *src;
 133};
 134
 135static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
 136{
 137        return (((void *)&notes->src->histograms) +
 138                (notes->src->sizeof_sym_hist * idx));
 139}
 140
 141static inline struct annotation *symbol__annotation(struct symbol *sym)
 142{
 143        return (void *)sym - symbol_conf.priv_size;
 144}
 145
 146int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
 147
 148int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
 149                                    struct addr_map_symbol *start,
 150                                    unsigned cycles);
 151
 152int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
 153
 154int symbol__alloc_hist(struct symbol *sym);
 155void symbol__annotate_zero_histograms(struct symbol *sym);
 156
 157int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
 158
 159int hist_entry__annotate(struct hist_entry *he, size_t privsize);
 160
 161int symbol__annotate_init(struct map *map, struct symbol *sym);
 162int symbol__annotate_printf(struct symbol *sym, struct map *map,
 163                            struct perf_evsel *evsel, bool full_paths,
 164                            int min_pcnt, int max_lines, int context);
 165void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
 166void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
 167void disasm__purge(struct list_head *head);
 168
 169bool ui__has_annotation(void);
 170
 171int symbol__tty_annotate(struct symbol *sym, struct map *map,
 172                         struct perf_evsel *evsel, bool print_lines,
 173                         bool full_paths, int min_pcnt, int max_lines);
 174
 175#ifdef HAVE_SLANG_SUPPORT
 176int symbol__tui_annotate(struct symbol *sym, struct map *map,
 177                         struct perf_evsel *evsel,
 178                         struct hist_browser_timer *hbt);
 179#else
 180static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
 181                                struct map *map __maybe_unused,
 182                                struct perf_evsel *evsel  __maybe_unused,
 183                                struct hist_browser_timer *hbt
 184                                __maybe_unused)
 185{
 186        return 0;
 187}
 188#endif
 189
 190extern const char       *disassembler_style;
 191
 192#endif  /* __PERF_ANNOTATE_H */
 193