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