tools/perf/util/hist.h

   1 #ifndef __PERF_HIST_H
   2 #define __PERF_HIST_H
   3
   4 #include <linux/types.h>
   5 #include <pthread.h>
   6 #include "callchain.h"
   7 #include "header.h"
   8
   9 extern struct callchain_param callchain_param;
  10
  11 struct hist_entry;
  12 struct addr_location;
  13 struct symbol;
  14
  15 /*
  16  * The kernel collects the number of events it couldn't send in a stretch and
  17  * when possible sends this number in a PERF_RECORD_LOST event. The number of
  18  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
  19  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
  20  * the sum of all struct lost_event.lost fields reported.
  21  *
  22  * The total_period is needed because by default auto-freq is used, so
  23  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
  24  * the total number of low level events, it is necessary to to sum all struct
  25  * sample_event.period and stash the result in total_period.
  26  */
  27 struct events_stats {
  28         u64 total_period;
  29         u64 total_lost;
  30         u64 total_invalid_chains;
  31         u32 nr_events[PERF_RECORD_HEADER_MAX];
  32         u32 nr_lost_warned;
  33         u32 nr_unknown_events;
  34         u32 nr_invalid_chains;
  35         u32 nr_unknown_id;
  36         u32 nr_unprocessable_samples;
  37         u32 nr_unordered_events;
  38 };
  39
  40 enum hist_column {
  41         HISTC_SYMBOL,
  42         HISTC_DSO,
  43         HISTC_THREAD,
  44         HISTC_COMM,
  45         HISTC_PARENT,
  46         HISTC_CPU,
  47         HISTC_MISPREDICT,
  48         HISTC_SYMBOL_FROM,
  49         HISTC_SYMBOL_TO,
  50         HISTC_DSO_FROM,
  51         HISTC_DSO_TO,
  52         HISTC_SRCLINE,
  53         HISTC_LOCAL_WEIGHT,
  54         HISTC_GLOBAL_WEIGHT,
  55         HISTC_MEM_DADDR_SYMBOL,
  56         HISTC_MEM_DADDR_DSO,
  57         HISTC_MEM_LOCKED,
  58         HISTC_MEM_TLB,
  59         HISTC_MEM_LVL,
  60         HISTC_MEM_SNOOP,
  61         HISTC_NR_COLS, /* Last entry */
  62 };
  63
  64 struct thread;
  65 struct dso;
  66
  67 struct hists {
  68         struct rb_root          entries_in_array[2];
  69         struct rb_root          *entries_in;
  70         struct rb_root          entries;
  71         struct rb_root          entries_collapsed;
  72         u64                     nr_entries;
  73         const struct thread     *thread_filter;
  74         const struct dso        *dso_filter;
  75         const char              *uid_filter_str;
  76         const char              *symbol_filter_str;
  77         pthread_mutex_t         lock;
  78         struct events_stats     stats;
  79         u64                     event_stream;
  80         u16                     col_len[HISTC_NR_COLS];
  81 };
  82
  83 struct hist_entry *__hists__add_entry(struct hists *self,
  84                                       struct addr_location *al,
  85                                       struct symbol *parent, u64 period,
  86                                       u64 weight);
  87 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
  88 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
  89 int hist_entry__sort_snprintf(struct hist_entry *self, char *bf, size_t size,
  90                               struct hists *hists);
  91 void hist_entry__free(struct hist_entry *);
  92
  93 struct hist_entry *__hists__add_branch_entry(struct hists *self,
  94                                              struct addr_location *al,
  95                                              struct symbol *sym_parent,
  96                                              struct branch_info *bi,
  97                                              u64 period,
  98                                              u64 weight);
  99
 100 struct hist_entry *__hists__add_mem_entry(struct hists *self,
 101                                           struct addr_location *al,
 102                                           struct symbol *sym_parent,
 103                                           struct mem_info *mi,
 104                                           u64 period,
 105                                           u64 weight);
 106
 107 void hists__output_resort(struct hists *self);
 108 void hists__output_resort_threaded(struct hists *hists);
 109 void hists__collapse_resort(struct hists *self);
 110 void hists__collapse_resort_threaded(struct hists *hists);
 111
 112 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
 113 void hists__decay_entries_threaded(struct hists *hists, bool zap_user,
 114                                    bool zap_kernel);
 115 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
 116
 117 void hists__inc_nr_entries(struct hists *hists, struct hist_entry *h);
 118 void hists__inc_nr_events(struct hists *self, u32 type);
 119 void events_stats__inc(struct events_stats *stats, u32 type);
 120 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
 121
 122 size_t hists__fprintf(struct hists *self, bool show_header, int max_rows,
 123                       int max_cols, FILE *fp);
 124
 125 int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
 126 int hist_entry__annotate(struct hist_entry *self, size_t privsize);
 127
 128 void hists__filter_by_dso(struct hists *hists);
 129 void hists__filter_by_thread(struct hists *hists);
 130 void hists__filter_by_symbol(struct hists *hists);
 131
 132 u16 hists__col_len(struct hists *self, enum hist_column col);
 133 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
 134 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
 135 void hists__reset_col_len(struct hists *hists);
 136 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
 137
 138 void hists__match(struct hists *leader, struct hists *other);
 139 int hists__link(struct hists *leader, struct hists *other);
 140
 141 struct perf_hpp {
 142         char *buf;
 143         size_t size;
 144         const char *sep;
 145         void *ptr;
 146 };
 147
 148 struct perf_hpp_fmt {
 149         int (*header)(struct perf_hpp *hpp);
 150         int (*width)(struct perf_hpp *hpp);
 151         int (*color)(struct perf_hpp *hpp, struct hist_entry *he);
 152         int (*entry)(struct perf_hpp *hpp, struct hist_entry *he);
 153
 154         struct list_head list;
 155 };
 156
 157 extern struct list_head perf_hpp__list;
 158
 159 #define perf_hpp__for_each_format(format) \
 160         list_for_each_entry(format, &perf_hpp__list, list)
 161
 162 extern struct perf_hpp_fmt perf_hpp__format[];
 163
 164 enum {
 165         PERF_HPP__BASELINE,
 166         PERF_HPP__OVERHEAD,
 167         PERF_HPP__OVERHEAD_SYS,
 168         PERF_HPP__OVERHEAD_US,
 169         PERF_HPP__OVERHEAD_GUEST_SYS,
 170         PERF_HPP__OVERHEAD_GUEST_US,
 171         PERF_HPP__SAMPLES,
 172         PERF_HPP__PERIOD,
 173         PERF_HPP__PERIOD_BASELINE,
 174         PERF_HPP__DELTA,
 175         PERF_HPP__RATIO,
 176         PERF_HPP__WEIGHTED_DIFF,
 177         PERF_HPP__FORMULA,
 178
 179         PERF_HPP__MAX_INDEX
 180 };
 181
 182 void perf_hpp__init(void);
 183 void perf_hpp__column_register(struct perf_hpp_fmt *format);
 184 void perf_hpp__column_enable(unsigned col);
 185 int hist_entry__period_snprintf(struct perf_hpp *hpp, struct hist_entry *he,
 186                                 bool color);
 187
 188 struct perf_evlist;
 189
 190 struct hist_browser_timer {
 191         void (*timer)(void *arg);
 192         void *arg;
 193         int refresh;
 194 };
 195
 196 #ifdef SLANG_SUPPORT
 197 #include "../ui/keysyms.h"
 198 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
 199                              struct hist_browser_timer *hbt);
 200
 201 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 202                                   struct hist_browser_timer *hbt,
 203                                   struct perf_session_env *env);
 204 int script_browse(const char *script_opt);
 205 #else
 206 static inline
 207 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
 208                                   const char *help __maybe_unused,
 209                                   struct hist_browser_timer *hbt __maybe_unused,
 210                                   struct perf_session_env *env __maybe_unused)
 211 {
 212         return 0;
 213 }
 214
 215 static inline int hist_entry__tui_annotate(struct hist_entry *self
 216                                            __maybe_unused,
 217                                            struct perf_evsel *evsel
 218                                            __maybe_unused,
 219                                            struct hist_browser_timer *hbt
 220                                            __maybe_unused)
 221 {
 222         return 0;
 223 }
 224
 225 static inline int script_browse(const char *script_opt __maybe_unused)
 226 {
 227         return 0;
 228 }
 229
 230 #define K_LEFT  -1000
 231 #define K_RIGHT -2000
 232 #define K_SWITCH_INPUT_DATA -3000
 233 #endif
 234
 235 #ifdef GTK2_SUPPORT
 236 int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist, const char *help,
 237                                   struct hist_browser_timer *hbt __maybe_unused);
 238 #else
 239 static inline
 240 int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist __maybe_unused,
 241                                   const char *help __maybe_unused,
 242                                   struct hist_browser_timer *hbt __maybe_unused)
 243 {
 244         return 0;
 245 }
 246 #endif
 247
 248 unsigned int hists__sort_list_width(struct hists *self);
 249
 250 double perf_diff__compute_delta(struct hist_entry *he, struct hist_entry *pair);
 251 double perf_diff__compute_ratio(struct hist_entry *he, struct hist_entry *pair);
 252 s64 perf_diff__compute_wdiff(struct hist_entry *he, struct hist_entry *pair);
 253 int perf_diff__formula(struct hist_entry *he, struct hist_entry *pair,
 254                        char *buf, size_t size);
 255 double perf_diff__period_percent(struct hist_entry *he, u64 period);
 256 #endif  /* __PERF_HIST_H */