tools/perf/util/hist.h

   1 #ifndef __PERF_HIST_H
   2 #define __PERF_HIST_H
   3
   4 #include <linux/types.h>
   5 #include "callchain.h"
   6
   7 extern struct callchain_param callchain_param;
   8
   9 struct hist_entry;
  10 struct addr_location;
  11 struct symbol;
  12 struct rb_root;
  13
  14 struct objdump_line {
  15         struct list_head node;
  16         s64              offset;
  17         char             *line;
  18 };
  19
  20 void objdump_line__free(struct objdump_line *self);
  21 struct objdump_line *objdump__get_next_ip_line(struct list_head *head,
  22                                                struct objdump_line *pos);
  23
  24 struct sym_hist {
  25         u64             sum;
  26         u64             ip[0];
  27 };
  28
  29 struct sym_ext {
  30         struct rb_node  node;
  31         double          percent;
  32         char            *path;
  33 };
  34
  35 struct sym_priv {
  36         struct sym_hist *hist;
  37         struct sym_ext  *ext;
  38 };
  39
  40 /*
  41  * The kernel collects the number of events it couldn't send in a stretch and
  42  * when possible sends this number in a PERF_RECORD_LOST event. The number of
  43  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
  44  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
  45  * the sum of all struct lost_event.lost fields reported.
  46  *
  47  * The total_period is needed because by default auto-freq is used, so
  48  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
  49  * the total number of low level events, it is necessary to to sum all struct
  50  * sample_event.period and stash the result in total_period.
  51  */
  52 struct events_stats {
  53         u64 total_period;
  54         u64 total_lost;
  55         u64 total_invalid_chains;
  56         u32 nr_events[PERF_RECORD_HEADER_MAX];
  57         u32 nr_unknown_events;
  58         u32 nr_invalid_chains;
  59 };
  60
  61 enum hist_column {
  62         HISTC_SYMBOL,
  63         HISTC_DSO,
  64         HISTC_THREAD,
  65         HISTC_COMM,
  66         HISTC_PARENT,
  67         HISTC_CPU,
  68         HISTC_NR_COLS, /* Last entry */
  69 };
  70
  71 struct hists {
  72         struct rb_node          rb_node;
  73         struct rb_root          entries;
  74         u64                     nr_entries;
  75         struct events_stats     stats;
  76         u64                     config;
  77         u64                     event_stream;
  78         u32                     type;
  79         u16                     col_len[HISTC_NR_COLS];
  80         /* Best would be to reuse the session callchain cursor */
  81         struct callchain_cursor callchain_cursor;
  82 };
  83
  84 struct hist_entry *__hists__add_entry(struct hists *self,
  85                                       struct addr_location *al,
  86                                       struct symbol *parent, u64 period);
  87 extern int64_t hist_entry__cmp(struct hist_entry *, struct hist_entry *);
  88 extern int64_t hist_entry__collapse(struct hist_entry *, struct hist_entry *);
  89 int hist_entry__fprintf(struct hist_entry *self, struct hists *hists,
  90                         struct hists *pair_hists, bool show_displacement,
  91                         long displacement, FILE *fp, u64 total);
  92 int hist_entry__snprintf(struct hist_entry *self, char *bf, size_t size,
  93                          struct hists *hists, struct hists *pair_hists,
  94                          bool show_displacement, long displacement,
  95                          bool color, u64 total);
  96 void hist_entry__free(struct hist_entry *);
  97
  98 void hists__output_resort(struct hists *self);
  99 void hists__collapse_resort(struct hists *self);
 100
 101 void hists__inc_nr_events(struct hists *self, u32 type);
 102 size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);
 103
 104 size_t hists__fprintf(struct hists *self, struct hists *pair,
 105                       bool show_displacement, FILE *fp);
 106
 107 int hist_entry__inc_addr_samples(struct hist_entry *self, u64 ip);
 108 int hist_entry__annotate(struct hist_entry *self, struct list_head *head,
 109                          size_t privsize);
 110
 111 void hists__filter_by_dso(struct hists *self, const struct dso *dso);
 112 void hists__filter_by_thread(struct hists *self, const struct thread *thread);
 113
 114 u16 hists__col_len(struct hists *self, enum hist_column col);
 115 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
 116 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
 117
 118 #ifdef NO_NEWT_SUPPORT
 119 static inline int hists__browse(struct hists *self __used,
 120                                 const char *helpline __used,
 121                                 const char *ev_name __used)
 122 {
 123         return 0;
 124 }
 125
 126 static inline int hists__tui_browse_tree(struct rb_root *self __used,
 127                                          const char *help __used)
 128 {
 129         return 0;
 130 }
 131
 132 static inline int hist_entry__tui_annotate(struct hist_entry *self __used)
 133 {
 134         return 0;
 135 }
 136 #define KEY_LEFT -1
 137 #define KEY_RIGHT -2
 138 #else
 139 #include <newt.h>
 140 int hists__browse(struct hists *self, const char *helpline,
 141                   const char *ev_name);
 142 int hist_entry__tui_annotate(struct hist_entry *self);
 143
 144 #define KEY_LEFT NEWT_KEY_LEFT
 145 #define KEY_RIGHT NEWT_KEY_RIGHT
 146
 147 int hists__tui_browse_tree(struct rb_root *self, const char *help);
 148 #endif
 149
 150 unsigned int hists__sort_list_width(struct hists *self);
 151
 152 #endif  /* __PERF_HIST_H */