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 #include "color.h"
   9 #include "ui/progress.h"
  10
  11 extern struct callchain_param callchain_param;
  12
  13 struct hist_entry;
  14 struct addr_location;
  15 struct symbol;
  16
  17 enum hist_filter {
  18         HIST_FILTER__DSO,
  19         HIST_FILTER__THREAD,
  20         HIST_FILTER__PARENT,
  21         HIST_FILTER__SYMBOL,
  22         HIST_FILTER__GUEST,
  23         HIST_FILTER__HOST,
  24 };
  25
  26 enum hist_column {
  27         HISTC_SYMBOL,
  28         HISTC_DSO,
  29         HISTC_THREAD,
  30         HISTC_COMM,
  31         HISTC_PARENT,
  32         HISTC_CPU,
  33         HISTC_SRCLINE,
  34         HISTC_MISPREDICT,
  35         HISTC_IN_TX,
  36         HISTC_ABORT,
  37         HISTC_SYMBOL_FROM,
  38         HISTC_SYMBOL_TO,
  39         HISTC_DSO_FROM,
  40         HISTC_DSO_TO,
  41         HISTC_LOCAL_WEIGHT,
  42         HISTC_GLOBAL_WEIGHT,
  43         HISTC_MEM_DADDR_SYMBOL,
  44         HISTC_MEM_DADDR_DSO,
  45         HISTC_MEM_LOCKED,
  46         HISTC_MEM_TLB,
  47         HISTC_MEM_LVL,
  48         HISTC_MEM_SNOOP,
  49         HISTC_MEM_DCACHELINE,
  50         HISTC_TRANSACTION,
  51         HISTC_NR_COLS, /* Last entry */
  52 };
  53
  54 struct thread;
  55 struct dso;
  56
  57 struct hists {
  58         struct rb_root          entries_in_array[2];
  59         struct rb_root          *entries_in;
  60         struct rb_root          entries;
  61         struct rb_root          entries_collapsed;
  62         u64                     nr_entries;
  63         u64                     nr_non_filtered_entries;
  64         const struct thread     *thread_filter;
  65         const struct dso        *dso_filter;
  66         const char              *uid_filter_str;
  67         const char              *symbol_filter_str;
  68         pthread_mutex_t         lock;
  69         struct events_stats     stats;
  70         u64                     event_stream;
  71         u16                     col_len[HISTC_NR_COLS];
  72 };
  73
  74 struct hist_entry_iter;
  75
  76 struct hist_iter_ops {
  77         int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
  78         int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
  79         int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
  80         int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
  81         int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
  82 };
  83
  84 struct hist_entry_iter {
  85         int total;
  86         int curr;
  87
  88         bool hide_unresolved;
  89
  90         struct perf_evsel *evsel;
  91         struct perf_sample *sample;
  92         struct hist_entry *he;
  93         struct symbol *parent;
  94         void *priv;
  95
  96         const struct hist_iter_ops *ops;
  97         /* user-defined callback function (optional) */
  98         int (*add_entry_cb)(struct hist_entry_iter *iter,
  99                             struct addr_location *al, bool single, void *arg);
 100 };
 101
 102 extern const struct hist_iter_ops hist_iter_normal;
 103 extern const struct hist_iter_ops hist_iter_branch;
 104 extern const struct hist_iter_ops hist_iter_mem;
 105 extern const struct hist_iter_ops hist_iter_cumulative;
 106
 107 struct hist_entry *__hists__add_entry(struct hists *hists,
 108                                       struct addr_location *al,
 109                                       struct symbol *parent,
 110                                       struct branch_info *bi,
 111                                       struct mem_info *mi, u64 period,
 112                                       u64 weight, u64 transaction,
 113                                       bool sample_self);
 114 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
 115                          struct perf_evsel *evsel, struct perf_sample *sample,
 116                          int max_stack_depth, void *arg);
 117
 118 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
 119 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
 120 int hist_entry__transaction_len(void);
 121 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
 122                               struct hists *hists);
 123 void hist_entry__free(struct hist_entry *);
 124
 125 void hists__output_resort(struct hists *hists);
 126 void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
 127
 128 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
 129 void hists__delete_entries(struct hists *hists);
 130 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
 131
 132 u64 hists__total_period(struct hists *hists);
 133 void hists__reset_stats(struct hists *hists);
 134 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
 135 void hists__inc_nr_events(struct hists *hists, u32 type);
 136 void hists__inc_nr_samples(struct hists *hists, bool filtered);
 137 void events_stats__inc(struct events_stats *stats, u32 type);
 138 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
 139
 140 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
 141                       int max_cols, float min_pcnt, FILE *fp);
 142 size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
 143
 144 void hists__filter_by_dso(struct hists *hists);
 145 void hists__filter_by_thread(struct hists *hists);
 146 void hists__filter_by_symbol(struct hists *hists);
 147
 148 static inline bool hists__has_filter(struct hists *hists)
 149 {
 150         return hists->thread_filter || hists->dso_filter ||
 151                 hists->symbol_filter_str;
 152 }
 153
 154 u16 hists__col_len(struct hists *hists, enum hist_column col);
 155 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
 156 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
 157 void hists__reset_col_len(struct hists *hists);
 158 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
 159
 160 void hists__match(struct hists *leader, struct hists *other);
 161 int hists__link(struct hists *leader, struct hists *other);
 162
 163 struct perf_hpp {
 164         char *buf;
 165         size_t size;
 166         const char *sep;
 167         void *ptr;
 168 };
 169
 170 struct perf_hpp_fmt {
 171         const char *name;
 172         int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 173                       struct perf_evsel *evsel);
 174         int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 175                      struct perf_evsel *evsel);
 176         int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 177                      struct hist_entry *he);
 178         int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 179                      struct hist_entry *he);
 180         int64_t (*cmp)(struct hist_entry *a, struct hist_entry *b);
 181         int64_t (*collapse)(struct hist_entry *a, struct hist_entry *b);
 182         int64_t (*sort)(struct hist_entry *a, struct hist_entry *b);
 183
 184         struct list_head list;
 185         struct list_head sort_list;
 186         bool elide;
 187         int len;
 188         int user_len;
 189 };
 190
 191 extern struct list_head perf_hpp__list;
 192 extern struct list_head perf_hpp__sort_list;
 193
 194 #define perf_hpp__for_each_format(format) \
 195         list_for_each_entry(format, &perf_hpp__list, list)
 196
 197 #define perf_hpp__for_each_format_safe(format, tmp)     \
 198         list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)
 199
 200 #define perf_hpp__for_each_sort_list(format) \
 201         list_for_each_entry(format, &perf_hpp__sort_list, sort_list)
 202
 203 #define perf_hpp__for_each_sort_list_safe(format, tmp)  \
 204         list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)
 205
 206 extern struct perf_hpp_fmt perf_hpp__format[];
 207
 208 enum {
 209         /* Matches perf_hpp__format array. */
 210         PERF_HPP__OVERHEAD,
 211         PERF_HPP__OVERHEAD_SYS,
 212         PERF_HPP__OVERHEAD_US,
 213         PERF_HPP__OVERHEAD_GUEST_SYS,
 214         PERF_HPP__OVERHEAD_GUEST_US,
 215         PERF_HPP__OVERHEAD_ACC,
 216         PERF_HPP__SAMPLES,
 217         PERF_HPP__PERIOD,
 218
 219         PERF_HPP__MAX_INDEX
 220 };
 221
 222 void perf_hpp__init(void);
 223 void perf_hpp__column_register(struct perf_hpp_fmt *format);
 224 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
 225 void perf_hpp__column_enable(unsigned col);
 226 void perf_hpp__column_disable(unsigned col);
 227 void perf_hpp__cancel_cumulate(void);
 228
 229 void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
 230 void perf_hpp__setup_output_field(void);
 231 void perf_hpp__reset_output_field(void);
 232 void perf_hpp__append_sort_keys(void);
 233
 234 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
 235 bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
 236
 237 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format)
 238 {
 239         return format->elide;
 240 }
 241
 242 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 243 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 244 void perf_hpp__set_user_width(const char *width_list_str);
 245
 246 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
 247 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
 248 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
 249
 250 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 251              struct hist_entry *he, hpp_field_fn get_field,
 252              const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
 253 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 254                  struct hist_entry *he, hpp_field_fn get_field,
 255                  const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
 256
 257 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
 258 {
 259         hpp->buf  += inc;
 260         hpp->size -= inc;
 261 }
 262
 263 static inline size_t perf_hpp__use_color(void)
 264 {
 265         return !symbol_conf.field_sep;
 266 }
 267
 268 static inline size_t perf_hpp__color_overhead(void)
 269 {
 270         return perf_hpp__use_color() ?
 271                (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
 272                : 0;
 273 }
 274
 275 struct perf_evlist;
 276
 277 struct hist_browser_timer {
 278         void (*timer)(void *arg);
 279         void *arg;
 280         int refresh;
 281 };
 282
 283 #ifdef HAVE_SLANG_SUPPORT
 284 #include "../ui/keysyms.h"
 285 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
 286                              struct hist_browser_timer *hbt);
 287
 288 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 289                                   struct hist_browser_timer *hbt,
 290                                   float min_pcnt,
 291                                   struct perf_session_env *env);
 292 int script_browse(const char *script_opt);
 293 #else
 294 static inline
 295 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
 296                                   const char *help __maybe_unused,
 297                                   struct hist_browser_timer *hbt __maybe_unused,
 298                                   float min_pcnt __maybe_unused,
 299                                   struct perf_session_env *env __maybe_unused)
 300 {
 301         return 0;
 302 }
 303
 304 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
 305                                            struct perf_evsel *evsel __maybe_unused,
 306                                            struct hist_browser_timer *hbt __maybe_unused)
 307 {
 308         return 0;
 309 }
 310
 311 static inline int script_browse(const char *script_opt __maybe_unused)
 312 {
 313         return 0;
 314 }
 315
 316 #define K_LEFT  -1000
 317 #define K_RIGHT -2000
 318 #define K_SWITCH_INPUT_DATA -3000
 319 #endif
 320
 321 unsigned int hists__sort_list_width(struct hists *hists);
 322
 323 struct option;
 324 int parse_filter_percentage(const struct option *opt __maybe_unused,
 325                             const char *arg, int unset __maybe_unused);
 326 int perf_hist_config(const char *var, const char *value);
 327
 328 #endif  /* __PERF_HIST_H */