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