tools/perf/util/annotate.h

   1 #ifndef __PERF_ANNOTATE_H
   2 #define __PERF_ANNOTATE_H
   3
   4 #include <stdbool.h>
   5 #include "types.h"
   6 #include "symbol.h"
   7 #include <linux/list.h>
   8 #include <linux/rbtree.h>
   9
  10 struct objdump_line {
  11         struct list_head node;
  12         s64              offset;
  13         char             *line;
  14 };
  15
  16 void objdump_line__free(struct objdump_line *self);
  17 struct objdump_line *objdump__get_next_ip_line(struct list_head *head,
  18                                                struct objdump_line *pos);
  19
  20 struct sym_hist {
  21         u64             sum;
  22         u64             addr[0];
  23 };
  24
  25 struct source_line {
  26         struct rb_node  node;
  27         double          percent;
  28         char            *path;
  29 };
  30
  31 /** struct annotation - symbols with hits have this attached as in sannotation
  32  *
  33  * @histogram: Array of addr hit histograms per event being monitored
  34  * @src_line: If 'print_lines' is specified, per source code line percentages
  35  *
  36  * src_line is allocated, percentages calculated and all sorted by percentage
  37  * when the annotation is about to be presented, so the percentages are for
  38  * one of the entries in the histogram array, i.e. for the event/counter being
  39  * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
  40  * returns.
  41  */
  42 struct annotation {
  43         struct source_line *src_line;
  44         struct sym_hist    *histograms;
  45         int                nr_histograms;
  46         int                sizeof_sym_hist;
  47 };
  48
  49 struct sannotation {
  50         struct annotation annotation;
  51         struct symbol     symbol;
  52 };
  53
  54 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
  55 {
  56         return ((void *)notes->histograms) + (notes->sizeof_sym_hist * idx);
  57 }
  58
  59 static inline struct annotation *symbol__annotation(struct symbol *sym)
  60 {
  61         struct sannotation *a = container_of(sym, struct sannotation, symbol);
  62         return &a->annotation;
  63 }
  64
  65 int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
  66                              int evidx, u64 addr);
  67 int symbol__alloc_hist(struct symbol *sym, int nevents);
  68 void symbol__annotate_zero_histograms(struct symbol *sym);
  69
  70 int symbol__annotate(struct symbol *sym, struct map *map,
  71                      struct list_head *head, size_t privsize);
  72 int symbol__annotate_printf(struct symbol *sym, struct map *map,
  73                             struct list_head *head, int evidx, bool full_paths,
  74                             int min_pcnt, int max_lines);
  75 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
  76 void symbol__annotate_decay_histogram(struct symbol *sym,
  77                                       struct list_head *head, int evidx);
  78 void objdump_line_list__purge(struct list_head *head);
  79
  80 int symbol__tty_annotate(struct symbol *sym, struct map *map, int evidx,
  81                          bool print_lines, bool full_paths, int min_pcnt,
  82                          int max_lines);
  83
  84 #ifdef NO_NEWT_SUPPORT
  85 static inline int symbol__tui_annotate(struct symbol *sym __used,
  86                                        struct map *map __used, int evidx __used)
  87 {
  88         return 0;
  89 }
  90 #else
  91 int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx);
  92 #endif
  93
  94 #endif  /* __PERF_ANNOTATE_H */