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