xref: /openbmc/linux/tools/perf/util/hist.h (revision d0b73b48)
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_NR_COLS, /* Last entry */
53 };
54 
55 struct thread;
56 struct dso;
57 
58 struct hists {
59 	struct rb_root		entries_in_array[2];
60 	struct rb_root		*entries_in;
61 	struct rb_root		entries;
62 	struct rb_root		entries_collapsed;
63 	u64			nr_entries;
64 	const struct thread	*thread_filter;
65 	const struct dso	*dso_filter;
66 	const char		*uid_filter_str;
67 	const char		*symbol_filter_str;
68 	pthread_mutex_t		lock;
69 	struct events_stats	stats;
70 	u64			event_stream;
71 	u16			col_len[HISTC_NR_COLS];
72 };
73 
74 struct hist_entry *__hists__add_entry(struct hists *self,
75 				      struct addr_location *al,
76 				      struct symbol *parent, u64 period);
77 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
78 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
79 int hist_entry__sort_snprintf(struct hist_entry *self, char *bf, size_t size,
80 			      struct hists *hists);
81 void hist_entry__free(struct hist_entry *);
82 
83 struct hist_entry *__hists__add_branch_entry(struct hists *self,
84 					     struct addr_location *al,
85 					     struct symbol *sym_parent,
86 					     struct branch_info *bi,
87 					     u64 period);
88 
89 void hists__output_resort(struct hists *self);
90 void hists__output_resort_threaded(struct hists *hists);
91 void hists__collapse_resort(struct hists *self);
92 void hists__collapse_resort_threaded(struct hists *hists);
93 
94 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
95 void hists__decay_entries_threaded(struct hists *hists, bool zap_user,
96 				   bool zap_kernel);
97 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
98 
99 void hists__inc_nr_events(struct hists *self, u32 type);
100 size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);
101 
102 size_t hists__fprintf(struct hists *self, bool show_header, int max_rows,
103 		      int max_cols, FILE *fp);
104 
105 int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
106 int hist_entry__annotate(struct hist_entry *self, size_t privsize);
107 
108 void hists__filter_by_dso(struct hists *hists);
109 void hists__filter_by_thread(struct hists *hists);
110 void hists__filter_by_symbol(struct hists *hists);
111 
112 u16 hists__col_len(struct hists *self, enum hist_column col);
113 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
114 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
115 void hists__reset_col_len(struct hists *hists);
116 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
117 
118 void hists__match(struct hists *leader, struct hists *other);
119 int hists__link(struct hists *leader, struct hists *other);
120 
121 struct perf_hpp {
122 	char *buf;
123 	size_t size;
124 	const char *sep;
125 	void *ptr;
126 };
127 
128 struct perf_hpp_fmt {
129 	bool cond;
130 	int (*header)(struct perf_hpp *hpp);
131 	int (*width)(struct perf_hpp *hpp);
132 	int (*color)(struct perf_hpp *hpp, struct hist_entry *he);
133 	int (*entry)(struct perf_hpp *hpp, struct hist_entry *he);
134 };
135 
136 extern struct perf_hpp_fmt perf_hpp__format[];
137 
138 enum {
139 	PERF_HPP__BASELINE,
140 	PERF_HPP__OVERHEAD,
141 	PERF_HPP__OVERHEAD_SYS,
142 	PERF_HPP__OVERHEAD_US,
143 	PERF_HPP__OVERHEAD_GUEST_SYS,
144 	PERF_HPP__OVERHEAD_GUEST_US,
145 	PERF_HPP__SAMPLES,
146 	PERF_HPP__PERIOD,
147 	PERF_HPP__PERIOD_BASELINE,
148 	PERF_HPP__DELTA,
149 	PERF_HPP__RATIO,
150 	PERF_HPP__WEIGHTED_DIFF,
151 	PERF_HPP__DISPL,
152 	PERF_HPP__FORMULA,
153 
154 	PERF_HPP__MAX_INDEX
155 };
156 
157 void perf_hpp__init(void);
158 void perf_hpp__column_enable(unsigned col, bool enable);
159 int hist_entry__period_snprintf(struct perf_hpp *hpp, struct hist_entry *he,
160 				bool color);
161 
162 struct perf_evlist;
163 
164 struct hist_browser_timer {
165 	void (*timer)(void *arg);
166 	void *arg;
167 	int refresh;
168 };
169 
170 #ifdef NEWT_SUPPORT
171 #include "../ui/keysyms.h"
172 int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
173 			     struct hist_browser_timer *hbt);
174 
175 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
176 				  struct hist_browser_timer *hbt,
177 				  struct perf_session_env *env);
178 int script_browse(const char *script_opt);
179 #else
180 static inline
181 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
182 				  const char *help __maybe_unused,
183 				  struct hist_browser_timer *hbt __maybe_unused,
184 				  struct perf_session_env *env __maybe_unused)
185 {
186 	return 0;
187 }
188 
189 static inline int hist_entry__tui_annotate(struct hist_entry *self
190 					   __maybe_unused,
191 					   int evidx __maybe_unused,
192 					   struct hist_browser_timer *hbt
193 					   __maybe_unused)
194 {
195 	return 0;
196 }
197 
198 static inline int script_browse(const char *script_opt __maybe_unused)
199 {
200 	return 0;
201 }
202 
203 #define K_LEFT -1
204 #define K_RIGHT -2
205 #endif
206 
207 #ifdef GTK2_SUPPORT
208 int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist, const char *help,
209 				  struct hist_browser_timer *hbt __maybe_unused);
210 #else
211 static inline
212 int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist __maybe_unused,
213 				  const char *help __maybe_unused,
214 				  struct hist_browser_timer *hbt __maybe_unused)
215 {
216 	return 0;
217 }
218 #endif
219 
220 unsigned int hists__sort_list_width(struct hists *self);
221 
222 double perf_diff__compute_delta(struct hist_entry *he);
223 double perf_diff__compute_ratio(struct hist_entry *he);
224 s64 perf_diff__compute_wdiff(struct hist_entry *he);
225 int perf_diff__formula(char *buf, size_t size, struct hist_entry *he);
226 #endif	/* __PERF_HIST_H */
227