xref: /linux/tools/perf/util/stat.h (revision b77e0ce62d63a761ffb7f7245a215a49f5921c2f)
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 };
61 
62 enum {
63 	CTX_BIT_USER	= 1 << 0,
64 	CTX_BIT_KERNEL	= 1 << 1,
65 	CTX_BIT_HV	= 1 << 2,
66 	CTX_BIT_HOST	= 1 << 3,
67 	CTX_BIT_IDLE	= 1 << 4,
68 	CTX_BIT_MAX	= 1 << 5,
69 };
70 
71 #define NUM_CTX CTX_BIT_MAX
72 
73 enum stat_type {
74 	STAT_NONE = 0,
75 	STAT_NSECS,
76 	STAT_CYCLES,
77 	STAT_STALLED_CYCLES_FRONT,
78 	STAT_STALLED_CYCLES_BACK,
79 	STAT_BRANCHES,
80 	STAT_CACHEREFS,
81 	STAT_L1_DCACHE,
82 	STAT_L1_ICACHE,
83 	STAT_LL_CACHE,
84 	STAT_ITLB_CACHE,
85 	STAT_DTLB_CACHE,
86 	STAT_CYCLES_IN_TX,
87 	STAT_TRANSACTION,
88 	STAT_ELISION,
89 	STAT_TOPDOWN_TOTAL_SLOTS,
90 	STAT_TOPDOWN_SLOTS_ISSUED,
91 	STAT_TOPDOWN_SLOTS_RETIRED,
92 	STAT_TOPDOWN_FETCH_BUBBLES,
93 	STAT_TOPDOWN_RECOVERY_BUBBLES,
94 	STAT_TOPDOWN_RETIRING,
95 	STAT_TOPDOWN_BAD_SPEC,
96 	STAT_TOPDOWN_FE_BOUND,
97 	STAT_TOPDOWN_BE_BOUND,
98 	STAT_TOPDOWN_HEAVY_OPS,
99 	STAT_TOPDOWN_BR_MISPREDICT,
100 	STAT_TOPDOWN_FETCH_LAT,
101 	STAT_TOPDOWN_MEM_BOUND,
102 	STAT_SMI_NUM,
103 	STAT_APERF,
104 	STAT_MAX
105 };
106 
107 struct runtime_stat {
108 	struct rblist value_list;
109 };
110 
111 typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config,
112 			     struct perf_cpu_map *m, int cpu);
113 
114 struct perf_stat_config {
115 	enum aggr_mode		 aggr_mode;
116 	bool			 scale;
117 	bool			 no_inherit;
118 	bool			 identifier;
119 	bool			 csv_output;
120 	bool			 interval_clear;
121 	bool			 metric_only;
122 	bool			 null_run;
123 	bool			 ru_display;
124 	bool			 big_num;
125 	bool			 no_merge;
126 	bool			 walltime_run_table;
127 	bool			 all_kernel;
128 	bool			 all_user;
129 	bool			 percore_show_thread;
130 	bool			 summary;
131 	bool			 metric_no_group;
132 	bool			 metric_no_merge;
133 	bool			 stop_read_counter;
134 	bool			 quiet;
135 	FILE			*output;
136 	unsigned int		 interval;
137 	unsigned int		 timeout;
138 	int			 initial_delay;
139 	unsigned int		 unit_width;
140 	unsigned int		 metric_only_len;
141 	int			 times;
142 	int			 run_count;
143 	int			 print_free_counters_hint;
144 	int			 print_mixed_hw_group_error;
145 	struct runtime_stat	*stats;
146 	int			 stats_num;
147 	const char		*csv_sep;
148 	struct stats		*walltime_nsecs_stats;
149 	struct rusage		 ru_data;
150 	struct cpu_aggr_map	*aggr_map;
151 	aggr_get_id_t		 aggr_get_id;
152 	struct cpu_aggr_map	*cpus_aggr_map;
153 	u64			*walltime_run;
154 	struct rblist		 metric_events;
155 	int			 ctl_fd;
156 	int			 ctl_fd_ack;
157 	bool			 ctl_fd_close;
158 	const char		*cgroup_list;
159 	unsigned int		topdown_level;
160 };
161 
162 void perf_stat__set_big_num(int set);
163 
164 void update_stats(struct stats *stats, u64 val);
165 double avg_stats(struct stats *stats);
166 double stddev_stats(struct stats *stats);
167 double rel_stddev_stats(double stddev, double avg);
168 
169 static inline void init_stats(struct stats *stats)
170 {
171 	stats->n    = 0.0;
172 	stats->mean = 0.0;
173 	stats->M2   = 0.0;
174 	stats->min  = (u64) -1;
175 	stats->max  = 0;
176 }
177 
178 struct evsel;
179 struct evlist;
180 
181 struct perf_aggr_thread_value {
182 	struct evsel *counter;
183 	struct aggr_cpu_id id;
184 	double uval;
185 	u64 val;
186 	u64 run;
187 	u64 ena;
188 };
189 
190 bool __perf_evsel_stat__is(struct evsel *evsel,
191 			   enum perf_stat_evsel_id id);
192 
193 #define perf_stat_evsel__is(evsel, id) \
194 	__perf_evsel_stat__is(evsel, PERF_STAT_EVSEL_ID__ ## id)
195 
196 extern struct runtime_stat rt_stat;
197 extern struct stats walltime_nsecs_stats;
198 
199 typedef void (*print_metric_t)(struct perf_stat_config *config,
200 			       void *ctx, const char *color, const char *unit,
201 			       const char *fmt, double val);
202 typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
203 
204 void runtime_stat__init(struct runtime_stat *st);
205 void runtime_stat__exit(struct runtime_stat *st);
206 void perf_stat__init_shadow_stats(void);
207 void perf_stat__reset_shadow_stats(void);
208 void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
209 void perf_stat__update_shadow_stats(struct evsel *counter, u64 count,
210 				    int cpu, struct runtime_stat *st);
211 struct perf_stat_output_ctx {
212 	void *ctx;
213 	print_metric_t print_metric;
214 	new_line_t new_line;
215 	bool force_header;
216 };
217 
218 void perf_stat__print_shadow_stats(struct perf_stat_config *config,
219 				   struct evsel *evsel,
220 				   double avg, int cpu,
221 				   struct perf_stat_output_ctx *out,
222 				   struct rblist *metric_events,
223 				   struct runtime_stat *st);
224 void perf_stat__collect_metric_expr(struct evlist *);
225 
226 int evlist__alloc_stats(struct evlist *evlist, bool alloc_raw);
227 void evlist__free_stats(struct evlist *evlist);
228 void evlist__reset_stats(struct evlist *evlist);
229 void evlist__reset_prev_raw_counts(struct evlist *evlist);
230 void evlist__copy_prev_raw_counts(struct evlist *evlist);
231 void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
232 
233 int perf_stat_process_counter(struct perf_stat_config *config,
234 			      struct evsel *counter);
235 struct perf_tool;
236 union perf_event;
237 struct perf_session;
238 struct target;
239 
240 int perf_event__process_stat_event(struct perf_session *session,
241 				   union perf_event *event);
242 
243 size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
244 size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
245 size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
246 
247 int create_perf_stat_counter(struct evsel *evsel,
248 			     struct perf_stat_config *config,
249 			     struct target *target,
250 			     int cpu);
251 void evlist__print_counters(struct evlist *evlist, struct perf_stat_config *config,
252 			    struct target *_target, struct timespec *ts, int argc, const char **argv);
253 
254 struct metric_expr;
255 double test_generic_metric(struct metric_expr *mexp, int cpu, struct runtime_stat *st);
256 #endif
257