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