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