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