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