xref: /openbmc/linux/tools/perf/util/stat.h (revision ecd25094)
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 "rblist.h"
10 #include "event.h"
11 
12 struct timespec;
13 
14 struct stats {
15 	double n, mean, M2;
16 	u64 max, min;
17 };
18 
19 enum perf_stat_evsel_id {
20 	PERF_STAT_EVSEL_ID__NONE = 0,
21 	PERF_STAT_EVSEL_ID__CYCLES_IN_TX,
22 	PERF_STAT_EVSEL_ID__TRANSACTION_START,
23 	PERF_STAT_EVSEL_ID__ELISION_START,
24 	PERF_STAT_EVSEL_ID__CYCLES_IN_TX_CP,
25 	PERF_STAT_EVSEL_ID__TOPDOWN_TOTAL_SLOTS,
26 	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_ISSUED,
27 	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_RETIRED,
28 	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_BUBBLES,
29 	PERF_STAT_EVSEL_ID__TOPDOWN_RECOVERY_BUBBLES,
30 	PERF_STAT_EVSEL_ID__SMI_NUM,
31 	PERF_STAT_EVSEL_ID__APERF,
32 	PERF_STAT_EVSEL_ID__MAX,
33 };
34 
35 struct perf_stat_evsel {
36 	struct stats		 res_stats[3];
37 	enum perf_stat_evsel_id	 id;
38 	u64			*group_data;
39 };
40 
41 enum aggr_mode {
42 	AGGR_NONE,
43 	AGGR_GLOBAL,
44 	AGGR_SOCKET,
45 	AGGR_DIE,
46 	AGGR_CORE,
47 	AGGR_THREAD,
48 	AGGR_UNSET,
49 };
50 
51 enum {
52 	CTX_BIT_USER	= 1 << 0,
53 	CTX_BIT_KERNEL	= 1 << 1,
54 	CTX_BIT_HV	= 1 << 2,
55 	CTX_BIT_HOST	= 1 << 3,
56 	CTX_BIT_IDLE	= 1 << 4,
57 	CTX_BIT_MAX	= 1 << 5,
58 };
59 
60 #define NUM_CTX CTX_BIT_MAX
61 
62 enum stat_type {
63 	STAT_NONE = 0,
64 	STAT_NSECS,
65 	STAT_CYCLES,
66 	STAT_STALLED_CYCLES_FRONT,
67 	STAT_STALLED_CYCLES_BACK,
68 	STAT_BRANCHES,
69 	STAT_CACHEREFS,
70 	STAT_L1_DCACHE,
71 	STAT_L1_ICACHE,
72 	STAT_LL_CACHE,
73 	STAT_ITLB_CACHE,
74 	STAT_DTLB_CACHE,
75 	STAT_CYCLES_IN_TX,
76 	STAT_TRANSACTION,
77 	STAT_ELISION,
78 	STAT_TOPDOWN_TOTAL_SLOTS,
79 	STAT_TOPDOWN_SLOTS_ISSUED,
80 	STAT_TOPDOWN_SLOTS_RETIRED,
81 	STAT_TOPDOWN_FETCH_BUBBLES,
82 	STAT_TOPDOWN_RECOVERY_BUBBLES,
83 	STAT_SMI_NUM,
84 	STAT_APERF,
85 	STAT_MAX
86 };
87 
88 struct runtime_stat {
89 	struct rblist value_list;
90 };
91 
92 typedef int (*aggr_get_id_t)(struct perf_stat_config *config,
93 			     struct perf_cpu_map *m, int cpu);
94 
95 struct perf_stat_config {
96 	enum aggr_mode		 aggr_mode;
97 	bool			 scale;
98 	bool			 no_inherit;
99 	bool			 identifier;
100 	bool			 csv_output;
101 	bool			 interval_clear;
102 	bool			 metric_only;
103 	bool			 null_run;
104 	bool			 ru_display;
105 	bool			 big_num;
106 	bool			 no_merge;
107 	bool			 walltime_run_table;
108 	FILE			*output;
109 	unsigned int		 interval;
110 	unsigned int		 timeout;
111 	unsigned int		 initial_delay;
112 	unsigned int		 unit_width;
113 	unsigned int		 metric_only_len;
114 	int			 times;
115 	int			 run_count;
116 	int			 print_free_counters_hint;
117 	int			 print_mixed_hw_group_error;
118 	struct runtime_stat	*stats;
119 	int			 stats_num;
120 	const char		*csv_sep;
121 	struct stats		*walltime_nsecs_stats;
122 	struct rusage		 ru_data;
123 	struct perf_cpu_map		*aggr_map;
124 	aggr_get_id_t		 aggr_get_id;
125 	struct perf_cpu_map		*cpus_aggr_map;
126 	u64			*walltime_run;
127 	struct rblist		 metric_events;
128 };
129 
130 void update_stats(struct stats *stats, u64 val);
131 double avg_stats(struct stats *stats);
132 double stddev_stats(struct stats *stats);
133 double rel_stddev_stats(double stddev, double avg);
134 
135 static inline void init_stats(struct stats *stats)
136 {
137 	stats->n    = 0.0;
138 	stats->mean = 0.0;
139 	stats->M2   = 0.0;
140 	stats->min  = (u64) -1;
141 	stats->max  = 0;
142 }
143 
144 struct evsel;
145 struct evlist;
146 
147 struct perf_aggr_thread_value {
148 	struct evsel *counter;
149 	int id;
150 	double uval;
151 	u64 val;
152 	u64 run;
153 	u64 ena;
154 };
155 
156 bool __perf_evsel_stat__is(struct evsel *evsel,
157 			   enum perf_stat_evsel_id id);
158 
159 #define perf_stat_evsel__is(evsel, id) \
160 	__perf_evsel_stat__is(evsel, PERF_STAT_EVSEL_ID__ ## id)
161 
162 extern struct runtime_stat rt_stat;
163 extern struct stats walltime_nsecs_stats;
164 
165 typedef void (*print_metric_t)(struct perf_stat_config *config,
166 			       void *ctx, const char *color, const char *unit,
167 			       const char *fmt, double val);
168 typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
169 
170 void runtime_stat__init(struct runtime_stat *st);
171 void runtime_stat__exit(struct runtime_stat *st);
172 void perf_stat__init_shadow_stats(void);
173 void perf_stat__reset_shadow_stats(void);
174 void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
175 void perf_stat__update_shadow_stats(struct evsel *counter, u64 count,
176 				    int cpu, struct runtime_stat *st);
177 struct perf_stat_output_ctx {
178 	void *ctx;
179 	print_metric_t print_metric;
180 	new_line_t new_line;
181 	bool force_header;
182 };
183 
184 void perf_stat__print_shadow_stats(struct perf_stat_config *config,
185 				   struct evsel *evsel,
186 				   double avg, int cpu,
187 				   struct perf_stat_output_ctx *out,
188 				   struct rblist *metric_events,
189 				   struct runtime_stat *st);
190 void perf_stat__collect_metric_expr(struct evlist *);
191 
192 int perf_evlist__alloc_stats(struct evlist *evlist, bool alloc_raw);
193 void perf_evlist__free_stats(struct evlist *evlist);
194 void perf_evlist__reset_stats(struct evlist *evlist);
195 
196 int perf_stat_process_counter(struct perf_stat_config *config,
197 			      struct evsel *counter);
198 struct perf_tool;
199 union perf_event;
200 struct perf_session;
201 struct target;
202 
203 int perf_event__process_stat_event(struct perf_session *session,
204 				   union perf_event *event);
205 
206 size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
207 size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
208 size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
209 
210 int create_perf_stat_counter(struct evsel *evsel,
211 			     struct perf_stat_config *config,
212 			     struct target *target);
213 int perf_stat_synthesize_config(struct perf_stat_config *config,
214 				struct perf_tool *tool,
215 				struct evlist *evlist,
216 				perf_event__handler_t process,
217 				bool attrs);
218 void
219 perf_evlist__print_counters(struct evlist *evlist,
220 			    struct perf_stat_config *config,
221 			    struct target *_target,
222 			    struct timespec *ts,
223 			    int argc, const char **argv);
224 #endif
225