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