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