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