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 "evsel.h"
   8 #include "header.h"
   9 #include "color.h"
  10 #include "ui/progress.h"
  11
  12 struct hist_entry;
  13 struct addr_location;
  14 struct symbol;
  15
  16 enum hist_filter {
  17         HIST_FILTER__DSO,
  18         HIST_FILTER__THREAD,
  19         HIST_FILTER__PARENT,
  20         HIST_FILTER__SYMBOL,
  21         HIST_FILTER__GUEST,
  22         HIST_FILTER__HOST,
  23 };
  24
  25 enum hist_column {
  26         HISTC_SYMBOL,
  27         HISTC_DSO,
  28         HISTC_THREAD,
  29         HISTC_COMM,
  30         HISTC_PARENT,
  31         HISTC_CPU,
  32         HISTC_SRCLINE,
  33         HISTC_SRCFILE,
  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_CYCLES,
  52         HISTC_NR_COLS, /* Last entry */
  53 };
  54
  55 struct thread;
  56 struct dso;
  57
  58 struct hists {
  59         struct rb_root          entries_in_array[2];
  60         struct rb_root          *entries_in;
  61         struct rb_root          entries;
  62         struct rb_root          entries_collapsed;
  63         u64                     nr_entries;
  64         u64                     nr_non_filtered_entries;
  65         struct thread           *thread_filter;
  66         const struct dso        *dso_filter;
  67         const char              *uid_filter_str;
  68         const char              *symbol_filter_str;
  69         pthread_mutex_t         lock;
  70         struct events_stats     stats;
  71         u64                     event_stream;
  72         u16                     col_len[HISTC_NR_COLS];
  73 };
  74
  75 struct hist_entry_iter;
  76
  77 struct hist_iter_ops {
  78         int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
  79         int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
  80         int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
  81         int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
  82         int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
  83 };
  84
  85 struct hist_entry_iter {
  86         int total;
  87         int curr;
  88
  89         bool hide_unresolved;
  90
  91         struct perf_evsel *evsel;
  92         struct perf_sample *sample;
  93         struct hist_entry *he;
  94         struct symbol *parent;
  95         void *priv;
  96
  97         const struct hist_iter_ops *ops;
  98         /* user-defined callback function (optional) */
  99         int (*add_entry_cb)(struct hist_entry_iter *iter,
 100                             struct addr_location *al, bool single, void *arg);
 101 };
 102
 103 extern const struct hist_iter_ops hist_iter_normal;
 104 extern const struct hist_iter_ops hist_iter_branch;
 105 extern const struct hist_iter_ops hist_iter_mem;
 106 extern const struct hist_iter_ops hist_iter_cumulative;
 107
 108 struct hist_entry *__hists__add_entry(struct hists *hists,
 109                                       struct addr_location *al,
 110                                       struct symbol *parent,
 111                                       struct branch_info *bi,
 112                                       struct mem_info *mi, u64 period,
 113                                       u64 weight, u64 transaction,
 114                                       bool sample_self);
 115 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
 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__delete(struct hist_entry *he);
 124
 125 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
 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 hists_evsel {
 164         struct perf_evsel evsel;
 165         struct hists      hists;
 166 };
 167
 168 static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
 169 {
 170         struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
 171         return &hevsel->evsel;
 172 }
 173
 174 static inline struct hists *evsel__hists(struct perf_evsel *evsel)
 175 {
 176         struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
 177         return &hevsel->hists;
 178 }
 179
 180 int hists__init(void);
 181
 182 struct perf_hpp {
 183         char *buf;
 184         size_t size;
 185         const char *sep;
 186         void *ptr;
 187 };
 188
 189 struct perf_hpp_fmt {
 190         const char *name;
 191         int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 192                       struct perf_evsel *evsel);
 193         int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 194                      struct perf_evsel *evsel);
 195         int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 196                      struct hist_entry *he);
 197         int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 198                      struct hist_entry *he);
 199         int64_t (*cmp)(struct perf_hpp_fmt *fmt,
 200                        struct hist_entry *a, struct hist_entry *b);
 201         int64_t (*collapse)(struct perf_hpp_fmt *fmt,
 202                             struct hist_entry *a, struct hist_entry *b);
 203         int64_t (*sort)(struct perf_hpp_fmt *fmt,
 204                         struct hist_entry *a, struct hist_entry *b);
 205
 206         struct list_head list;
 207         struct list_head sort_list;
 208         bool elide;
 209         int len;
 210         int user_len;
 211 };
 212
 213 extern struct list_head perf_hpp__list;
 214 extern struct list_head perf_hpp__sort_list;
 215
 216 #define perf_hpp__for_each_format(format) \
 217         list_for_each_entry(format, &perf_hpp__list, list)
 218
 219 #define perf_hpp__for_each_format_safe(format, tmp)     \
 220         list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)
 221
 222 #define perf_hpp__for_each_sort_list(format) \
 223         list_for_each_entry(format, &perf_hpp__sort_list, sort_list)
 224
 225 #define perf_hpp__for_each_sort_list_safe(format, tmp)  \
 226         list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)
 227
 228 extern struct perf_hpp_fmt perf_hpp__format[];
 229
 230 enum {
 231         /* Matches perf_hpp__format array. */
 232         PERF_HPP__OVERHEAD,
 233         PERF_HPP__OVERHEAD_SYS,
 234         PERF_HPP__OVERHEAD_US,
 235         PERF_HPP__OVERHEAD_GUEST_SYS,
 236         PERF_HPP__OVERHEAD_GUEST_US,
 237         PERF_HPP__OVERHEAD_ACC,
 238         PERF_HPP__SAMPLES,
 239         PERF_HPP__PERIOD,
 240
 241         PERF_HPP__MAX_INDEX
 242 };
 243
 244 void perf_hpp__init(void);
 245 void perf_hpp__column_register(struct perf_hpp_fmt *format);
 246 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
 247 void perf_hpp__column_enable(unsigned col);
 248 void perf_hpp__column_disable(unsigned col);
 249 void perf_hpp__cancel_cumulate(void);
 250
 251 void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
 252 void perf_hpp__setup_output_field(void);
 253 void perf_hpp__reset_output_field(void);
 254 void perf_hpp__append_sort_keys(void);
 255
 256 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
 257 bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
 258
 259 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format)
 260 {
 261         return format->elide;
 262 }
 263
 264 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 265 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 266 void perf_hpp__set_user_width(const char *width_list_str);
 267
 268 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
 269 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
 270 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
 271
 272 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 273              struct hist_entry *he, hpp_field_fn get_field,
 274              const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
 275 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 276                  struct hist_entry *he, hpp_field_fn get_field,
 277                  const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
 278
 279 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
 280 {
 281         hpp->buf  += inc;
 282         hpp->size -= inc;
 283 }
 284
 285 static inline size_t perf_hpp__use_color(void)
 286 {
 287         return !symbol_conf.field_sep;
 288 }
 289
 290 static inline size_t perf_hpp__color_overhead(void)
 291 {
 292         return perf_hpp__use_color() ?
 293                (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
 294                : 0;
 295 }
 296
 297 struct perf_evlist;
 298
 299 struct hist_browser_timer {
 300         void (*timer)(void *arg);
 301         void *arg;
 302         int refresh;
 303 };
 304
 305 #ifdef HAVE_SLANG_SUPPORT
 306 #include "../ui/keysyms.h"
 307 int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
 308                              struct hist_browser_timer *hbt);
 309
 310 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
 311                              struct hist_browser_timer *hbt);
 312
 313 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 314                                   struct hist_browser_timer *hbt,
 315                                   float min_pcnt,
 316                                   struct perf_env *env);
 317 int script_browse(const char *script_opt);
 318 #else
 319 static inline
 320 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
 321                                   const char *help __maybe_unused,
 322                                   struct hist_browser_timer *hbt __maybe_unused,
 323                                   float min_pcnt __maybe_unused,
 324                                   struct perf_env *env __maybe_unused)
 325 {
 326         return 0;
 327 }
 328 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
 329                                            struct perf_evsel *evsel __maybe_unused,
 330                                            struct hist_browser_timer *hbt __maybe_unused)
 331 {
 332         return 0;
 333 }
 334
 335 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
 336                                            struct perf_evsel *evsel __maybe_unused,
 337                                            struct hist_browser_timer *hbt __maybe_unused)
 338 {
 339         return 0;
 340 }
 341
 342 static inline int script_browse(const char *script_opt __maybe_unused)
 343 {
 344         return 0;
 345 }
 346
 347 #define K_LEFT  -1000
 348 #define K_RIGHT -2000
 349 #define K_SWITCH_INPUT_DATA -3000
 350 #endif
 351
 352 unsigned int hists__sort_list_width(struct hists *hists);
 353
 354 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
 355                           struct perf_sample *sample, bool nonany_branch_mode);
 356
 357 struct option;
 358 int parse_filter_percentage(const struct option *opt __maybe_unused,
 359                             const char *arg, int unset __maybe_unused);
 360 int perf_hist_config(const char *var, const char *value);
 361
 362 #endif  /* __PERF_HIST_H */