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