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