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