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 };
  24
  25 enum hist_column {
  26         HISTC_SYMBOL,
  27         HISTC_DSO,
  28         HISTC_THREAD,
  29         HISTC_COMM,
  30         HISTC_PARENT,
  31         HISTC_CPU,
  32         HISTC_SOCKET,
  33         HISTC_SRCLINE,
  34         HISTC_SRCFILE,
  35         HISTC_MISPREDICT,
  36         HISTC_IN_TX,
  37         HISTC_ABORT,
  38         HISTC_SYMBOL_FROM,
  39         HISTC_SYMBOL_TO,
  40         HISTC_DSO_FROM,
  41         HISTC_DSO_TO,
  42         HISTC_LOCAL_WEIGHT,
  43         HISTC_GLOBAL_WEIGHT,
  44         HISTC_MEM_DADDR_SYMBOL,
  45         HISTC_MEM_DADDR_DSO,
  46         HISTC_MEM_LOCKED,
  47         HISTC_MEM_TLB,
  48         HISTC_MEM_LVL,
  49         HISTC_MEM_SNOOP,
  50         HISTC_MEM_DCACHELINE,
  51         HISTC_TRANSACTION,
  52         HISTC_CYCLES,
  53         HISTC_NR_COLS, /* Last entry */
  54 };
  55
  56 struct thread;
  57 struct dso;
  58
  59 struct hists {
  60         struct rb_root          entries_in_array[2];
  61         struct rb_root          *entries_in;
  62         struct rb_root          entries;
  63         struct rb_root          entries_collapsed;
  64         u64                     nr_entries;
  65         u64                     nr_non_filtered_entries;
  66         struct thread           *thread_filter;
  67         const struct dso        *dso_filter;
  68         const char              *uid_filter_str;
  69         const char              *symbol_filter_str;
  70         pthread_mutex_t         lock;
  71         struct events_stats     stats;
  72         u64                     event_stream;
  73         u16                     col_len[HISTC_NR_COLS];
  74 };
  75
  76 struct hist_entry_iter;
  77
  78 struct hist_iter_ops {
  79         int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
  80         int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
  81         int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
  82         int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
  83         int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
  84 };
  85
  86 struct hist_entry_iter {
  87         int total;
  88         int curr;
  89
  90         bool hide_unresolved;
  91
  92         struct perf_evsel *evsel;
  93         struct perf_sample *sample;
  94         struct hist_entry *he;
  95         struct symbol *parent;
  96         void *priv;
  97
  98         const struct hist_iter_ops *ops;
  99         /* user-defined callback function (optional) */
 100         int (*add_entry_cb)(struct hist_entry_iter *iter,
 101                             struct addr_location *al, bool single, void *arg);
 102 };
 103
 104 extern const struct hist_iter_ops hist_iter_normal;
 105 extern const struct hist_iter_ops hist_iter_branch;
 106 extern const struct hist_iter_ops hist_iter_mem;
 107 extern const struct hist_iter_ops hist_iter_cumulative;
 108
 109 struct hist_entry *__hists__add_entry(struct hists *hists,
 110                                       struct addr_location *al,
 111                                       struct symbol *parent,
 112                                       struct branch_info *bi,
 113                                       struct mem_info *mi, u64 period,
 114                                       u64 weight, u64 transaction,
 115                                       bool sample_self);
 116 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
 117                          int max_stack_depth, void *arg);
 118
 119 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
 120 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
 121 int hist_entry__transaction_len(void);
 122 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
 123                               struct hists *hists);
 124 void hist_entry__delete(struct hist_entry *he);
 125
 126 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
 127 void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
 128
 129 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
 130 void hists__delete_entries(struct hists *hists);
 131 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
 132
 133 u64 hists__total_period(struct hists *hists);
 134 void hists__reset_stats(struct hists *hists);
 135 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
 136 void hists__inc_nr_events(struct hists *hists, u32 type);
 137 void hists__inc_nr_samples(struct hists *hists, bool filtered);
 138 void events_stats__inc(struct events_stats *stats, u32 type);
 139 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
 140
 141 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
 142                       int max_cols, float min_pcnt, FILE *fp);
 143 size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
 144
 145 void hists__filter_by_dso(struct hists *hists);
 146 void hists__filter_by_thread(struct hists *hists);
 147 void hists__filter_by_symbol(struct hists *hists);
 148
 149 static inline bool hists__has_filter(struct hists *hists)
 150 {
 151         return hists->thread_filter || hists->dso_filter ||
 152                 hists->symbol_filter_str;
 153 }
 154
 155 u16 hists__col_len(struct hists *hists, enum hist_column col);
 156 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
 157 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
 158 void hists__reset_col_len(struct hists *hists);
 159 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
 160
 161 void hists__match(struct hists *leader, struct hists *other);
 162 int hists__link(struct hists *leader, struct hists *other);
 163
 164 struct hists_evsel {
 165         struct perf_evsel evsel;
 166         struct hists      hists;
 167 };
 168
 169 static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
 170 {
 171         struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
 172         return &hevsel->evsel;
 173 }
 174
 175 static inline struct hists *evsel__hists(struct perf_evsel *evsel)
 176 {
 177         struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
 178         return &hevsel->hists;
 179 }
 180
 181 int hists__init(void);
 182
 183 struct perf_hpp {
 184         char *buf;
 185         size_t size;
 186         const char *sep;
 187         void *ptr;
 188 };
 189
 190 struct perf_hpp_fmt {
 191         const char *name;
 192         int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 193                       struct perf_evsel *evsel);
 194         int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 195                      struct perf_evsel *evsel);
 196         int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 197                      struct hist_entry *he);
 198         int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 199                      struct hist_entry *he);
 200         int64_t (*cmp)(struct perf_hpp_fmt *fmt,
 201                        struct hist_entry *a, struct hist_entry *b);
 202         int64_t (*collapse)(struct perf_hpp_fmt *fmt,
 203                             struct hist_entry *a, struct hist_entry *b);
 204         int64_t (*sort)(struct perf_hpp_fmt *fmt,
 205                         struct hist_entry *a, struct hist_entry *b);
 206
 207         struct list_head list;
 208         struct list_head sort_list;
 209         bool elide;
 210         int len;
 211         int user_len;
 212 };
 213
 214 extern struct list_head perf_hpp__list;
 215 extern struct list_head perf_hpp__sort_list;
 216
 217 #define perf_hpp__for_each_format(format) \
 218         list_for_each_entry(format, &perf_hpp__list, list)
 219
 220 #define perf_hpp__for_each_format_safe(format, tmp)     \
 221         list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)
 222
 223 #define perf_hpp__for_each_sort_list(format) \
 224         list_for_each_entry(format, &perf_hpp__sort_list, sort_list)
 225
 226 #define perf_hpp__for_each_sort_list_safe(format, tmp)  \
 227         list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)
 228
 229 extern struct perf_hpp_fmt perf_hpp__format[];
 230
 231 enum {
 232         /* Matches perf_hpp__format array. */
 233         PERF_HPP__OVERHEAD,
 234         PERF_HPP__OVERHEAD_SYS,
 235         PERF_HPP__OVERHEAD_US,
 236         PERF_HPP__OVERHEAD_GUEST_SYS,
 237         PERF_HPP__OVERHEAD_GUEST_US,
 238         PERF_HPP__OVERHEAD_ACC,
 239         PERF_HPP__SAMPLES,
 240         PERF_HPP__PERIOD,
 241
 242         PERF_HPP__MAX_INDEX
 243 };
 244
 245 void perf_hpp__init(void);
 246 void perf_hpp__column_register(struct perf_hpp_fmt *format);
 247 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
 248 void perf_hpp__column_enable(unsigned col);
 249 void perf_hpp__column_disable(unsigned col);
 250 void perf_hpp__cancel_cumulate(void);
 251
 252 void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
 253 void perf_hpp__setup_output_field(void);
 254 void perf_hpp__reset_output_field(void);
 255 void perf_hpp__append_sort_keys(void);
 256
 257 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
 258 bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
 259
 260 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format)
 261 {
 262         return format->elide;
 263 }
 264
 265 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 266 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 267 void perf_hpp__set_user_width(const char *width_list_str);
 268
 269 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
 270 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
 271 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
 272
 273 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 274              struct hist_entry *he, hpp_field_fn get_field,
 275              const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
 276 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 277                  struct hist_entry *he, hpp_field_fn get_field,
 278                  const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
 279
 280 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
 281 {
 282         hpp->buf  += inc;
 283         hpp->size -= inc;
 284 }
 285
 286 static inline size_t perf_hpp__use_color(void)
 287 {
 288         return !symbol_conf.field_sep;
 289 }
 290
 291 static inline size_t perf_hpp__color_overhead(void)
 292 {
 293         return perf_hpp__use_color() ?
 294                (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
 295                : 0;
 296 }
 297
 298 struct perf_evlist;
 299
 300 struct hist_browser_timer {
 301         void (*timer)(void *arg);
 302         void *arg;
 303         int refresh;
 304 };
 305
 306 #ifdef HAVE_SLANG_SUPPORT
 307 #include "../ui/keysyms.h"
 308 int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
 309                              struct hist_browser_timer *hbt);
 310
 311 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
 312                              struct hist_browser_timer *hbt);
 313
 314 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 315                                   struct hist_browser_timer *hbt,
 316                                   float min_pcnt,
 317                                   struct perf_env *env);
 318 int script_browse(const char *script_opt);
 319 #else
 320 static inline
 321 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
 322                                   const char *help __maybe_unused,
 323                                   struct hist_browser_timer *hbt __maybe_unused,
 324                                   float min_pcnt __maybe_unused,
 325                                   struct perf_env *env __maybe_unused)
 326 {
 327         return 0;
 328 }
 329 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
 330                                            struct perf_evsel *evsel __maybe_unused,
 331                                            struct hist_browser_timer *hbt __maybe_unused)
 332 {
 333         return 0;
 334 }
 335
 336 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
 337                                            struct perf_evsel *evsel __maybe_unused,
 338                                            struct hist_browser_timer *hbt __maybe_unused)
 339 {
 340         return 0;
 341 }
 342
 343 static inline int script_browse(const char *script_opt __maybe_unused)
 344 {
 345         return 0;
 346 }
 347
 348 #define K_LEFT  -1000
 349 #define K_RIGHT -2000
 350 #define K_SWITCH_INPUT_DATA -3000
 351 #endif
 352
 353 unsigned int hists__sort_list_width(struct hists *hists);
 354
 355 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
 356                           struct perf_sample *sample, bool nonany_branch_mode);
 357
 358 struct option;
 359 int parse_filter_percentage(const struct option *opt __maybe_unused,
 360                             const char *arg, int unset __maybe_unused);
 361 int perf_hist_config(const char *var, const char *value);
 362
 363 #endif  /* __PERF_HIST_H */