tools/perf/util/hist.h

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