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 "header.h"
   8 #include "color.h"
   9 #include "ui/progress.h"
  10
  11 extern struct callchain_param callchain_param;
  12
  13 struct hist_entry;
  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 };
  25
  26 /*
  27  * The kernel collects the number of events it couldn't send in a stretch and
  28  * when possible sends this number in a PERF_RECORD_LOST event. The number of
  29  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
  30  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
  31  * the sum of all struct lost_event.lost fields reported.
  32  *
  33  * The total_period is needed because by default auto-freq is used, so
  34  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
  35  * the total number of low level events, it is necessary to to sum all struct
  36  * sample_event.period and stash the result in total_period.
  37  */
  38 struct events_stats {
  39         u64 total_period;
  40         u64 total_non_filtered_period;
  41         u64 total_lost;
  42         u64 total_invalid_chains;
  43         u32 nr_events[PERF_RECORD_HEADER_MAX];
  44         u32 nr_non_filtered_samples;
  45         u32 nr_lost_warned;
  46         u32 nr_unknown_events;
  47         u32 nr_invalid_chains;
  48         u32 nr_unknown_id;
  49         u32 nr_unprocessable_samples;
  50 };
  51
  52 enum hist_column {
  53         HISTC_SYMBOL,
  54         HISTC_DSO,
  55         HISTC_THREAD,
  56         HISTC_COMM,
  57         HISTC_PARENT,
  58         HISTC_CPU,
  59         HISTC_SRCLINE,
  60         HISTC_MISPREDICT,
  61         HISTC_IN_TX,
  62         HISTC_ABORT,
  63         HISTC_SYMBOL_FROM,
  64         HISTC_SYMBOL_TO,
  65         HISTC_DSO_FROM,
  66         HISTC_DSO_TO,
  67         HISTC_LOCAL_WEIGHT,
  68         HISTC_GLOBAL_WEIGHT,
  69         HISTC_MEM_DADDR_SYMBOL,
  70         HISTC_MEM_DADDR_DSO,
  71         HISTC_MEM_LOCKED,
  72         HISTC_MEM_TLB,
  73         HISTC_MEM_LVL,
  74         HISTC_MEM_SNOOP,
  75         HISTC_TRANSACTION,
  76         HISTC_NR_COLS, /* Last entry */
  77 };
  78
  79 struct thread;
  80 struct dso;
  81
  82 struct hists {
  83         struct rb_root          entries_in_array[2];
  84         struct rb_root          *entries_in;
  85         struct rb_root          entries;
  86         struct rb_root          entries_collapsed;
  87         u64                     nr_entries;
  88         u64                     nr_non_filtered_entries;
  89         const struct thread     *thread_filter;
  90         const struct dso        *dso_filter;
  91         const char              *uid_filter_str;
  92         const char              *symbol_filter_str;
  93         pthread_mutex_t         lock;
  94         struct events_stats     stats;
  95         u64                     event_stream;
  96         u16                     col_len[HISTC_NR_COLS];
  97 };
  98
  99 struct hist_entry *__hists__add_entry(struct hists *hists,
 100                                       struct addr_location *al,
 101                                       struct symbol *parent,
 102                                       struct branch_info *bi,
 103                                       struct mem_info *mi, u64 period,
 104                                       u64 weight, u64 transaction);
 105 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
 106 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
 107 int hist_entry__transaction_len(void);
 108 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
 109                               struct hists *hists);
 110 void hist_entry__free(struct hist_entry *);
 111
 112 void hists__output_resort(struct hists *hists);
 113 void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
 114
 115 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
 116 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
 117
 118 u64 hists__total_period(struct hists *hists);
 119 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
 120 void hists__inc_nr_events(struct hists *hists, u32 type);
 121 void events_stats__inc(struct events_stats *stats, u32 type);
 122 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
 123
 124 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
 125                       int max_cols, float min_pcnt, FILE *fp);
 126
 127 void hists__filter_by_dso(struct hists *hists);
 128 void hists__filter_by_thread(struct hists *hists);
 129 void hists__filter_by_symbol(struct hists *hists);
 130
 131 u16 hists__col_len(struct hists *hists, enum hist_column col);
 132 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
 133 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
 134 void hists__reset_col_len(struct hists *hists);
 135 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
 136
 137 void hists__match(struct hists *leader, struct hists *other);
 138 int hists__link(struct hists *leader, struct hists *other);
 139
 140 struct perf_hpp {
 141         char *buf;
 142         size_t size;
 143         const char *sep;
 144         void *ptr;
 145 };
 146
 147 struct perf_hpp_fmt {
 148         int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 149                       struct perf_evsel *evsel);
 150         int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 151                      struct perf_evsel *evsel);
 152         int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 153                      struct hist_entry *he);
 154         int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 155                      struct hist_entry *he);
 156
 157         struct list_head list;
 158 };
 159
 160 extern struct list_head perf_hpp__list;
 161
 162 #define perf_hpp__for_each_format(format) \
 163         list_for_each_entry(format, &perf_hpp__list, list)
 164
 165 extern struct perf_hpp_fmt perf_hpp__format[];
 166
 167 enum {
 168         /* Matches perf_hpp__format array. */
 169         PERF_HPP__OVERHEAD,
 170         PERF_HPP__OVERHEAD_SYS,
 171         PERF_HPP__OVERHEAD_US,
 172         PERF_HPP__OVERHEAD_GUEST_SYS,
 173         PERF_HPP__OVERHEAD_GUEST_US,
 174         PERF_HPP__SAMPLES,
 175         PERF_HPP__PERIOD,
 176
 177         PERF_HPP__MAX_INDEX
 178 };
 179
 180 void perf_hpp__init(void);
 181 void perf_hpp__column_register(struct perf_hpp_fmt *format);
 182 void perf_hpp__column_enable(unsigned col);
 183
 184 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
 185 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
 186 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
 187
 188 int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he,
 189                hpp_field_fn get_field, hpp_callback_fn callback,
 190                const char *fmt, hpp_snprint_fn print_fn, bool fmt_percent);
 191
 192 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
 193 {
 194         hpp->buf  += inc;
 195         hpp->size -= inc;
 196 }
 197
 198 static inline size_t perf_hpp__use_color(void)
 199 {
 200         return !symbol_conf.field_sep;
 201 }
 202
 203 static inline size_t perf_hpp__color_overhead(void)
 204 {
 205         return perf_hpp__use_color() ?
 206                (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
 207                : 0;
 208 }
 209
 210 struct perf_evlist;
 211
 212 struct hist_browser_timer {
 213         void (*timer)(void *arg);
 214         void *arg;
 215         int refresh;
 216 };
 217
 218 #ifdef HAVE_SLANG_SUPPORT
 219 #include "../ui/keysyms.h"
 220 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
 221                              struct hist_browser_timer *hbt);
 222
 223 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 224                                   struct hist_browser_timer *hbt,
 225                                   float min_pcnt,
 226                                   struct perf_session_env *env);
 227 int script_browse(const char *script_opt);
 228 #else
 229 static inline
 230 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
 231                                   const char *help __maybe_unused,
 232                                   struct hist_browser_timer *hbt __maybe_unused,
 233                                   float min_pcnt __maybe_unused,
 234                                   struct perf_session_env *env __maybe_unused)
 235 {
 236         return 0;
 237 }
 238
 239 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
 240                                            struct perf_evsel *evsel __maybe_unused,
 241                                            struct hist_browser_timer *hbt __maybe_unused)
 242 {
 243         return 0;
 244 }
 245
 246 static inline int script_browse(const char *script_opt __maybe_unused)
 247 {
 248         return 0;
 249 }
 250
 251 #define K_LEFT  -1000
 252 #define K_RIGHT -2000
 253 #define K_SWITCH_INPUT_DATA -3000
 254 #endif
 255
 256 unsigned int hists__sort_list_width(struct hists *hists);
 257
 258 struct option;
 259 int parse_filter_percentage(const struct option *opt __maybe_unused,
 260                             const char *arg, int unset __maybe_unused);
 261 int perf_hist_config(const char *var, const char *value);
 262
 263 #endif  /* __PERF_HIST_H */