perf tools: Add mem access sampling core support
[linux-3.10.git] / 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_MISPREDICT,
47         HISTC_SYMBOL_FROM,
48         HISTC_SYMBOL_TO,
49         HISTC_DSO_FROM,
50         HISTC_DSO_TO,
51         HISTC_SRCLINE,
52         HISTC_LOCAL_WEIGHT,
53         HISTC_GLOBAL_WEIGHT,
54         HISTC_MEM_DADDR_SYMBOL,
55         HISTC_MEM_DADDR_DSO,
56         HISTC_MEM_LOCKED,
57         HISTC_MEM_TLB,
58         HISTC_MEM_LVL,
59         HISTC_MEM_SNOOP,
60         HISTC_NR_COLS, /* Last entry */
61 };
62
63 struct thread;
64 struct dso;
65
66 struct hists {
67         struct rb_root          entries_in_array[2];
68         struct rb_root          *entries_in;
69         struct rb_root          entries;
70         struct rb_root          entries_collapsed;
71         u64                     nr_entries;
72         const struct thread     *thread_filter;
73         const struct dso        *dso_filter;
74         const char              *uid_filter_str;
75         const char              *symbol_filter_str;
76         pthread_mutex_t         lock;
77         struct events_stats     stats;
78         u64                     event_stream;
79         u16                     col_len[HISTC_NR_COLS];
80 };
81
82 struct hist_entry *__hists__add_entry(struct hists *self,
83                                       struct addr_location *al,
84                                       struct symbol *parent, u64 period,
85                                       u64 weight);
86 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
87 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
88 int hist_entry__sort_snprintf(struct hist_entry *self, char *bf, size_t size,
89                               struct hists *hists);
90 void hist_entry__free(struct hist_entry *);
91
92 struct hist_entry *__hists__add_branch_entry(struct hists *self,
93                                              struct addr_location *al,
94                                              struct symbol *sym_parent,
95                                              struct branch_info *bi,
96                                              u64 period,
97                                              u64 weight);
98
99 struct hist_entry *__hists__add_mem_entry(struct hists *self,
100                                           struct addr_location *al,
101                                           struct symbol *sym_parent,
102                                           struct mem_info *mi,
103                                           u64 period,
104                                           u64 weight);
105
106 void hists__output_resort(struct hists *self);
107 void hists__output_resort_threaded(struct hists *hists);
108 void hists__collapse_resort(struct hists *self);
109 void hists__collapse_resort_threaded(struct hists *hists);
110
111 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
112 void hists__decay_entries_threaded(struct hists *hists, bool zap_user,
113                                    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, 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 *hpp);
149         int (*width)(struct perf_hpp *hpp);
150         int (*color)(struct perf_hpp *hpp, struct hist_entry *he);
151         int (*entry)(struct perf_hpp *hpp, struct hist_entry *he);
152
153         struct list_head list;
154 };
155
156 extern struct list_head perf_hpp__list;
157
158 #define perf_hpp__for_each_format(format) \
159         list_for_each_entry(format, &perf_hpp__list, list)
160
161 extern struct perf_hpp_fmt perf_hpp__format[];
162
163 enum {
164         PERF_HPP__BASELINE,
165         PERF_HPP__OVERHEAD,
166         PERF_HPP__OVERHEAD_SYS,
167         PERF_HPP__OVERHEAD_US,
168         PERF_HPP__OVERHEAD_GUEST_SYS,
169         PERF_HPP__OVERHEAD_GUEST_US,
170         PERF_HPP__SAMPLES,
171         PERF_HPP__PERIOD,
172         PERF_HPP__PERIOD_BASELINE,
173         PERF_HPP__DELTA,
174         PERF_HPP__RATIO,
175         PERF_HPP__WEIGHTED_DIFF,
176         PERF_HPP__FORMULA,
177
178         PERF_HPP__MAX_INDEX
179 };
180
181 void perf_hpp__init(void);
182 void perf_hpp__column_register(struct perf_hpp_fmt *format);
183 void perf_hpp__column_enable(unsigned col);
184 int hist_entry__period_snprintf(struct perf_hpp *hpp, struct hist_entry *he,
185                                 bool color);
186
187 struct perf_evlist;
188
189 struct hist_browser_timer {
190         void (*timer)(void *arg);
191         void *arg;
192         int refresh;
193 };
194
195 #ifdef NEWT_SUPPORT
196 #include "../ui/keysyms.h"
197 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
198                              struct hist_browser_timer *hbt);
199
200 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
201                                   struct hist_browser_timer *hbt,
202                                   struct perf_session_env *env);
203 int script_browse(const char *script_opt);
204 #else
205 static inline
206 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
207                                   const char *help __maybe_unused,
208                                   struct hist_browser_timer *hbt __maybe_unused,
209                                   struct perf_session_env *env __maybe_unused)
210 {
211         return 0;
212 }
213
214 static inline int hist_entry__tui_annotate(struct hist_entry *self
215                                            __maybe_unused,
216                                            struct perf_evsel *evsel
217                                            __maybe_unused,
218                                            struct hist_browser_timer *hbt
219                                            __maybe_unused)
220 {
221         return 0;
222 }
223
224 static inline int script_browse(const char *script_opt __maybe_unused)
225 {
226         return 0;
227 }
228
229 #define K_LEFT  -1000
230 #define K_RIGHT -2000
231 #define K_SWITCH_INPUT_DATA -3000
232 #endif
233
234 #ifdef GTK2_SUPPORT
235 int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist, const char *help,
236                                   struct hist_browser_timer *hbt __maybe_unused);
237 #else
238 static inline
239 int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist __maybe_unused,
240                                   const char *help __maybe_unused,
241                                   struct hist_browser_timer *hbt __maybe_unused)
242 {
243         return 0;
244 }
245 #endif
246
247 unsigned int hists__sort_list_width(struct hists *self);
248
249 double perf_diff__compute_delta(struct hist_entry *he, struct hist_entry *pair);
250 double perf_diff__compute_ratio(struct hist_entry *he, struct hist_entry *pair);
251 s64 perf_diff__compute_wdiff(struct hist_entry *he, struct hist_entry *pair);
252 int perf_diff__formula(struct hist_entry *he, struct hist_entry *pair,
253                        char *buf, size_t size);
254 double perf_diff__period_percent(struct hist_entry *he, u64 period);
255 #endif  /* __PERF_HIST_H */