xref: /openbmc/linux/tools/perf/util/stat.h (revision 2fa5ebe3)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_STATS_H
3 #define __PERF_STATS_H
4 
5 #include <linux/types.h>
6 #include <stdio.h>
7 #include <sys/types.h>
8 #include <sys/resource.h>
9 #include "cpumap.h"
10 #include "rblist.h"
11 #include "counts.h"
12 
13 struct perf_cpu_map;
14 struct perf_stat_config;
15 struct timespec;
16 
17 struct stats {
18 	double n, mean, M2;
19 	u64 max, min;
20 };
21 
22 enum perf_stat_evsel_id {
23 	PERF_STAT_EVSEL_ID__NONE = 0,
24 	PERF_STAT_EVSEL_ID__CYCLES_IN_TX,
25 	PERF_STAT_EVSEL_ID__TRANSACTION_START,
26 	PERF_STAT_EVSEL_ID__ELISION_START,
27 	PERF_STAT_EVSEL_ID__CYCLES_IN_TX_CP,
28 	PERF_STAT_EVSEL_ID__TOPDOWN_TOTAL_SLOTS,
29 	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_ISSUED,
30 	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_RETIRED,
31 	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_BUBBLES,
32 	PERF_STAT_EVSEL_ID__TOPDOWN_RECOVERY_BUBBLES,
33 	PERF_STAT_EVSEL_ID__TOPDOWN_RETIRING,
34 	PERF_STAT_EVSEL_ID__TOPDOWN_BAD_SPEC,
35 	PERF_STAT_EVSEL_ID__TOPDOWN_FE_BOUND,
36 	PERF_STAT_EVSEL_ID__TOPDOWN_BE_BOUND,
37 	PERF_STAT_EVSEL_ID__TOPDOWN_HEAVY_OPS,
38 	PERF_STAT_EVSEL_ID__TOPDOWN_BR_MISPREDICT,
39 	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_LAT,
40 	PERF_STAT_EVSEL_ID__TOPDOWN_MEM_BOUND,
41 	PERF_STAT_EVSEL_ID__SMI_NUM,
42 	PERF_STAT_EVSEL_ID__APERF,
43 	PERF_STAT_EVSEL_ID__MAX,
44 };
45 
46 /* hold aggregated event info */
47 struct perf_stat_aggr {
48 	/* aggregated values */
49 	struct perf_counts_values	counts;
50 	/* number of entries (CPUs) aggregated */
51 	int				nr;
52 	/* whether any entry has failed to read/process event */
53 	bool				failed;
54 	/* to mark this data is processed already */
55 	bool				used;
56 };
57 
58 /* per-evsel event stats */
59 struct perf_stat_evsel {
60 	/* used for repeated runs */
61 	struct stats		 res_stats;
62 	/* evsel id for quick check */
63 	enum perf_stat_evsel_id	 id;
64 	/* number of allocated 'aggr' */
65 	int			 nr_aggr;
66 	/* aggregated event values */
67 	struct perf_stat_aggr	*aggr;
68 	/* used for group read */
69 	u64			*group_data;
70 };
71 
72 enum aggr_mode {
73 	AGGR_NONE,
74 	AGGR_GLOBAL,
75 	AGGR_SOCKET,
76 	AGGR_DIE,
77 	AGGR_CORE,
78 	AGGR_THREAD,
79 	AGGR_UNSET,
80 	AGGR_NODE,
81 	AGGR_MAX
82 };
83 
84 enum {
85 	CTX_BIT_USER	= 1 << 0,
86 	CTX_BIT_KERNEL	= 1 << 1,
87 	CTX_BIT_HV	= 1 << 2,
88 	CTX_BIT_HOST	= 1 << 3,
89 	CTX_BIT_IDLE	= 1 << 4,
90 	CTX_BIT_MAX	= 1 << 5,
91 };
92 
93 #define NUM_CTX CTX_BIT_MAX
94 
95 enum stat_type {
96 	STAT_NONE = 0,
97 	STAT_NSECS,
98 	STAT_CYCLES,
99 	STAT_STALLED_CYCLES_FRONT,
100 	STAT_STALLED_CYCLES_BACK,
101 	STAT_BRANCHES,
102 	STAT_CACHEREFS,
103 	STAT_L1_DCACHE,
104 	STAT_L1_ICACHE,
105 	STAT_LL_CACHE,
106 	STAT_ITLB_CACHE,
107 	STAT_DTLB_CACHE,
108 	STAT_CYCLES_IN_TX,
109 	STAT_TRANSACTION,
110 	STAT_ELISION,
111 	STAT_TOPDOWN_TOTAL_SLOTS,
112 	STAT_TOPDOWN_SLOTS_ISSUED,
113 	STAT_TOPDOWN_SLOTS_RETIRED,
114 	STAT_TOPDOWN_FETCH_BUBBLES,
115 	STAT_TOPDOWN_RECOVERY_BUBBLES,
116 	STAT_TOPDOWN_RETIRING,
117 	STAT_TOPDOWN_BAD_SPEC,
118 	STAT_TOPDOWN_FE_BOUND,
119 	STAT_TOPDOWN_BE_BOUND,
120 	STAT_TOPDOWN_HEAVY_OPS,
121 	STAT_TOPDOWN_BR_MISPREDICT,
122 	STAT_TOPDOWN_FETCH_LAT,
123 	STAT_TOPDOWN_MEM_BOUND,
124 	STAT_SMI_NUM,
125 	STAT_APERF,
126 	STAT_MAX
127 };
128 
129 struct runtime_stat {
130 	struct rblist value_list;
131 };
132 
133 struct rusage_stats {
134 	struct stats ru_utime_usec_stat;
135 	struct stats ru_stime_usec_stat;
136 };
137 
138 typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config, struct perf_cpu cpu);
139 
140 struct perf_stat_config {
141 	enum aggr_mode		 aggr_mode;
142 	bool			 scale;
143 	bool			 no_inherit;
144 	bool			 identifier;
145 	bool			 csv_output;
146 	bool			 json_output;
147 	bool			 interval_clear;
148 	bool			 metric_only;
149 	bool			 null_run;
150 	bool			 ru_display;
151 	bool			 big_num;
152 	bool			 no_merge;
153 	bool			 hybrid_merge;
154 	bool			 walltime_run_table;
155 	bool			 all_kernel;
156 	bool			 all_user;
157 	bool			 percore_show_thread;
158 	bool			 summary;
159 	bool			 no_csv_summary;
160 	bool			 metric_no_group;
161 	bool			 metric_no_merge;
162 	bool			 stop_read_counter;
163 	bool			 iostat_run;
164 	char			 *user_requested_cpu_list;
165 	bool			 system_wide;
166 	FILE			*output;
167 	unsigned int		 interval;
168 	unsigned int		 timeout;
169 	unsigned int		 unit_width;
170 	unsigned int		 metric_only_len;
171 	int			 times;
172 	int			 run_count;
173 	int			 print_free_counters_hint;
174 	int			 print_mixed_hw_group_error;
175 	const char		*csv_sep;
176 	struct stats		*walltime_nsecs_stats;
177 	struct rusage		 ru_data;
178 	struct rusage_stats		 *ru_stats;
179 	struct cpu_aggr_map	*aggr_map;
180 	aggr_get_id_t		 aggr_get_id;
181 	struct cpu_aggr_map	*cpus_aggr_map;
182 	u64			*walltime_run;
183 	struct rblist		 metric_events;
184 	int			 ctl_fd;
185 	int			 ctl_fd_ack;
186 	bool			 ctl_fd_close;
187 	const char		*cgroup_list;
188 	unsigned int		topdown_level;
189 };
190 
191 void perf_stat__set_big_num(int set);
192 void perf_stat__set_no_csv_summary(int set);
193 
194 void update_stats(struct stats *stats, u64 val);
195 double avg_stats(struct stats *stats);
196 double stddev_stats(struct stats *stats);
197 double rel_stddev_stats(double stddev, double avg);
198 
199 static inline void init_stats(struct stats *stats)
200 {
201 	stats->n    = 0.0;
202 	stats->mean = 0.0;
203 	stats->M2   = 0.0;
204 	stats->min  = (u64) -1;
205 	stats->max  = 0;
206 }
207 
208 static inline void init_rusage_stats(struct rusage_stats *ru_stats) {
209 	init_stats(&ru_stats->ru_utime_usec_stat);
210 	init_stats(&ru_stats->ru_stime_usec_stat);
211 }
212 
213 static inline void update_rusage_stats(struct rusage_stats *ru_stats, struct rusage* rusage) {
214 	const u64 us_to_ns = 1000;
215 	const u64 s_to_ns = 1000000000;
216 	update_stats(&ru_stats->ru_utime_usec_stat,
217 	             (rusage->ru_utime.tv_usec * us_to_ns + rusage->ru_utime.tv_sec * s_to_ns));
218 	update_stats(&ru_stats->ru_stime_usec_stat,
219 	             (rusage->ru_stime.tv_usec * us_to_ns + rusage->ru_stime.tv_sec * s_to_ns));
220 }
221 
222 struct evsel;
223 struct evlist;
224 
225 bool __perf_stat_evsel__is(struct evsel *evsel, enum perf_stat_evsel_id id);
226 
227 #define perf_stat_evsel__is(evsel, id) \
228 	__perf_stat_evsel__is(evsel, PERF_STAT_EVSEL_ID__ ## id)
229 
230 extern struct runtime_stat rt_stat;
231 extern struct stats walltime_nsecs_stats;
232 extern struct rusage_stats ru_stats;
233 
234 typedef void (*print_metric_t)(struct perf_stat_config *config,
235 			       void *ctx, const char *color, const char *unit,
236 			       const char *fmt, double val);
237 typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
238 
239 void runtime_stat__init(struct runtime_stat *st);
240 void runtime_stat__exit(struct runtime_stat *st);
241 void perf_stat__init_shadow_stats(void);
242 void perf_stat__reset_shadow_stats(void);
243 void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
244 void perf_stat__update_shadow_stats(struct evsel *counter, u64 count,
245 				    int map_idx, struct runtime_stat *st);
246 struct perf_stat_output_ctx {
247 	void *ctx;
248 	print_metric_t print_metric;
249 	new_line_t new_line;
250 	bool force_header;
251 };
252 
253 void perf_stat__print_shadow_stats(struct perf_stat_config *config,
254 				   struct evsel *evsel,
255 				   double avg, int map_idx,
256 				   struct perf_stat_output_ctx *out,
257 				   struct rblist *metric_events,
258 				   struct runtime_stat *st);
259 
260 int evlist__alloc_stats(struct perf_stat_config *config,
261 			struct evlist *evlist, bool alloc_raw);
262 void evlist__free_stats(struct evlist *evlist);
263 void evlist__reset_stats(struct evlist *evlist);
264 void evlist__reset_prev_raw_counts(struct evlist *evlist);
265 void evlist__copy_prev_raw_counts(struct evlist *evlist);
266 void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
267 
268 int evlist__alloc_aggr_stats(struct evlist *evlist, int nr_aggr);
269 void evlist__reset_aggr_stats(struct evlist *evlist);
270 
271 int perf_stat_process_counter(struct perf_stat_config *config,
272 			      struct evsel *counter);
273 void perf_stat_merge_counters(struct perf_stat_config *config, struct evlist *evlist);
274 void perf_stat_process_percore(struct perf_stat_config *config, struct evlist *evlist);
275 void perf_stat_process_shadow_stats(struct perf_stat_config *config, struct evlist *evlist);
276 
277 struct perf_tool;
278 union perf_event;
279 struct perf_session;
280 struct target;
281 
282 int perf_event__process_stat_event(struct perf_session *session,
283 				   union perf_event *event);
284 
285 size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
286 size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
287 size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
288 
289 int create_perf_stat_counter(struct evsel *evsel,
290 			     struct perf_stat_config *config,
291 			     struct target *target,
292 			     int cpu_map_idx);
293 void evlist__print_counters(struct evlist *evlist, struct perf_stat_config *config,
294 			    struct target *_target, struct timespec *ts, int argc, const char **argv);
295 
296 struct metric_expr;
297 double test_generic_metric(struct metric_expr *mexp, int map_idx, struct runtime_stat *st);
298 #endif
299