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__reset_stats(struct hists *hists);
 120 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
 121 void hists__inc_nr_events(struct hists *hists, u32 type);
 122 void events_stats__inc(struct events_stats *stats, u32 type);
 123 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
 124
 125 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
 126                       int max_cols, float min_pcnt, FILE *fp);
 127
 128 void hists__filter_by_dso(struct hists *hists);
 129 void hists__filter_by_thread(struct hists *hists);
 130 void hists__filter_by_symbol(struct hists *hists);
 131
 132 static inline bool hists__has_filter(struct hists *hists)
 133 {
 134         return hists->thread_filter || hists->dso_filter ||
 135                 hists->symbol_filter_str;
 136 }
 137
 138 u16 hists__col_len(struct hists *hists, enum hist_column col);
 139 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
 140 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
 141 void hists__reset_col_len(struct hists *hists);
 142 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
 143
 144 void hists__match(struct hists *leader, struct hists *other);
 145 int hists__link(struct hists *leader, struct hists *other);
 146
 147 struct perf_hpp {
 148         char *buf;
 149         size_t size;
 150         const char *sep;
 151         void *ptr;
 152 };
 153
 154 struct perf_hpp_fmt {
 155         int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 156                       struct perf_evsel *evsel);
 157         int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 158                      struct perf_evsel *evsel);
 159         int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 160                      struct hist_entry *he);
 161         int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 162                      struct hist_entry *he);
 163         int64_t (*cmp)(struct hist_entry *a, struct hist_entry *b);
 164         int64_t (*collapse)(struct hist_entry *a, struct hist_entry *b);
 165         int64_t (*sort)(struct hist_entry *a, struct hist_entry *b);
 166
 167         struct list_head list;
 168         struct list_head sort_list;
 169 };
 170
 171 extern struct list_head perf_hpp__list;
 172 extern struct list_head perf_hpp__sort_list;
 173
 174 #define perf_hpp__for_each_format(format) \
 175         list_for_each_entry(format, &perf_hpp__list, list)
 176
 177 #define perf_hpp__for_each_format_safe(format, tmp)     \
 178         list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)
 179
 180 #define perf_hpp__for_each_sort_list(format) \
 181         list_for_each_entry(format, &perf_hpp__sort_list, sort_list)
 182
 183 #define perf_hpp__for_each_sort_list_safe(format, tmp)  \
 184         list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)
 185
 186 extern struct perf_hpp_fmt perf_hpp__format[];
 187
 188 enum {
 189         /* Matches perf_hpp__format array. */
 190         PERF_HPP__OVERHEAD,
 191         PERF_HPP__OVERHEAD_SYS,
 192         PERF_HPP__OVERHEAD_US,
 193         PERF_HPP__OVERHEAD_GUEST_SYS,
 194         PERF_HPP__OVERHEAD_GUEST_US,
 195         PERF_HPP__SAMPLES,
 196         PERF_HPP__PERIOD,
 197
 198         PERF_HPP__MAX_INDEX
 199 };
 200
 201 void perf_hpp__init(void);
 202 void perf_hpp__column_register(struct perf_hpp_fmt *format);
 203 void perf_hpp__column_enable(unsigned col);
 204 void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
 205 void perf_hpp__setup_output_field(void);
 206 void perf_hpp__reset_output_field(void);
 207 void perf_hpp__append_sort_keys(void);
 208
 209 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
 210 bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
 211 bool perf_hpp__should_skip(struct perf_hpp_fmt *format);
 212 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 213
 214 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
 215 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
 216 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
 217
 218 int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he,
 219                hpp_field_fn get_field, const char *fmt,
 220                hpp_snprint_fn print_fn, bool fmt_percent);
 221
 222 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
 223 {
 224         hpp->buf  += inc;
 225         hpp->size -= inc;
 226 }
 227
 228 static inline size_t perf_hpp__use_color(void)
 229 {
 230         return !symbol_conf.field_sep;
 231 }
 232
 233 static inline size_t perf_hpp__color_overhead(void)
 234 {
 235         return perf_hpp__use_color() ?
 236                (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
 237                : 0;
 238 }
 239
 240 struct perf_evlist;
 241
 242 struct hist_browser_timer {
 243         void (*timer)(void *arg);
 244         void *arg;
 245         int refresh;
 246 };
 247
 248 #ifdef HAVE_SLANG_SUPPORT
 249 #include "../ui/keysyms.h"
 250 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
 251                              struct hist_browser_timer *hbt);
 252
 253 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 254                                   struct hist_browser_timer *hbt,
 255                                   float min_pcnt,
 256                                   struct perf_session_env *env);
 257 int script_browse(const char *script_opt);
 258 #else
 259 static inline
 260 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
 261                                   const char *help __maybe_unused,
 262                                   struct hist_browser_timer *hbt __maybe_unused,
 263                                   float min_pcnt __maybe_unused,
 264                                   struct perf_session_env *env __maybe_unused)
 265 {
 266         return 0;
 267 }
 268
 269 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
 270                                            struct perf_evsel *evsel __maybe_unused,
 271                                            struct hist_browser_timer *hbt __maybe_unused)
 272 {
 273         return 0;
 274 }
 275
 276 static inline int script_browse(const char *script_opt __maybe_unused)
 277 {
 278         return 0;
 279 }
 280
 281 #define K_LEFT  -1000
 282 #define K_RIGHT -2000
 283 #define K_SWITCH_INPUT_DATA -3000
 284 #endif
 285
 286 unsigned int hists__sort_list_width(struct hists *hists);
 287
 288 struct option;
 289 int parse_filter_percentage(const struct option *opt __maybe_unused,
 290                             const char *arg, int unset __maybe_unused);
 291 int perf_hist_config(const char *var, const char *value);
 292
 293 #endif  /* __PERF_HIST_H */