xref: /openbmc/linux/tools/perf/util/stat.h (revision 55b37d9c)
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 /* hold aggregated event info */
23 struct perf_stat_aggr {
24 	/* aggregated values */
25 	struct perf_counts_values	counts;
26 	/* number of entries (CPUs) aggregated */
27 	int				nr;
28 	/* whether any entry has failed to read/process event */
29 	bool				failed;
30 	/* to mark this data is processed already */
31 	bool				used;
32 };
33 
34 /* per-evsel event stats */
35 struct perf_stat_evsel {
36 	/* used for repeated runs */
37 	struct stats		 res_stats;
38 	/* number of allocated 'aggr' */
39 	int			 nr_aggr;
40 	/* aggregated event values */
41 	struct perf_stat_aggr	*aggr;
42 	/* used for group read */
43 	u64			*group_data;
44 };
45 
46 enum aggr_mode {
47 	AGGR_NONE,
48 	AGGR_GLOBAL,
49 	AGGR_SOCKET,
50 	AGGR_DIE,
51 	AGGR_CORE,
52 	AGGR_THREAD,
53 	AGGR_UNSET,
54 	AGGR_NODE,
55 	AGGR_MAX
56 };
57 
58 struct rusage_stats {
59 	struct stats ru_utime_usec_stat;
60 	struct stats ru_stime_usec_stat;
61 };
62 
63 typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config, struct perf_cpu cpu);
64 
65 struct perf_stat_config {
66 	enum aggr_mode		 aggr_mode;
67 	bool			 scale;
68 	bool			 no_inherit;
69 	bool			 identifier;
70 	bool			 csv_output;
71 	bool			 json_output;
72 	bool			 interval_clear;
73 	bool			 metric_only;
74 	bool			 null_run;
75 	bool			 ru_display;
76 	bool			 big_num;
77 	bool			 no_merge;
78 	bool			 hybrid_merge;
79 	bool			 walltime_run_table;
80 	bool			 all_kernel;
81 	bool			 all_user;
82 	bool			 percore_show_thread;
83 	bool			 summary;
84 	bool			 no_csv_summary;
85 	bool			 metric_no_group;
86 	bool			 metric_no_merge;
87 	bool			 metric_no_threshold;
88 	bool			 stop_read_counter;
89 	bool			 iostat_run;
90 	char			 *user_requested_cpu_list;
91 	bool			 system_wide;
92 	FILE			*output;
93 	unsigned int		 interval;
94 	unsigned int		 timeout;
95 	unsigned int		 unit_width;
96 	unsigned int		 metric_only_len;
97 	int			 times;
98 	int			 run_count;
99 	int			 print_free_counters_hint;
100 	int			 print_mixed_hw_group_error;
101 	const char		*csv_sep;
102 	struct stats		*walltime_nsecs_stats;
103 	struct rusage		 ru_data;
104 	struct rusage_stats		 *ru_stats;
105 	struct cpu_aggr_map	*aggr_map;
106 	aggr_get_id_t		 aggr_get_id;
107 	struct cpu_aggr_map	*cpus_aggr_map;
108 	u64			*walltime_run;
109 	struct rblist		 metric_events;
110 	int			 ctl_fd;
111 	int			 ctl_fd_ack;
112 	bool			 ctl_fd_close;
113 	const char		*cgroup_list;
114 	unsigned int		topdown_level;
115 };
116 
117 void perf_stat__set_big_num(int set);
118 void perf_stat__set_no_csv_summary(int set);
119 
120 void update_stats(struct stats *stats, u64 val);
121 double avg_stats(struct stats *stats);
122 double stddev_stats(struct stats *stats);
123 double rel_stddev_stats(double stddev, double avg);
124 
125 static inline void init_stats(struct stats *stats)
126 {
127 	stats->n    = 0.0;
128 	stats->mean = 0.0;
129 	stats->M2   = 0.0;
130 	stats->min  = (u64) -1;
131 	stats->max  = 0;
132 }
133 
134 static inline void init_rusage_stats(struct rusage_stats *ru_stats) {
135 	init_stats(&ru_stats->ru_utime_usec_stat);
136 	init_stats(&ru_stats->ru_stime_usec_stat);
137 }
138 
139 static inline void update_rusage_stats(struct rusage_stats *ru_stats, struct rusage* rusage) {
140 	const u64 us_to_ns = 1000;
141 	const u64 s_to_ns = 1000000000;
142 	update_stats(&ru_stats->ru_utime_usec_stat,
143 	             (rusage->ru_utime.tv_usec * us_to_ns + rusage->ru_utime.tv_sec * s_to_ns));
144 	update_stats(&ru_stats->ru_stime_usec_stat,
145 	             (rusage->ru_stime.tv_usec * us_to_ns + rusage->ru_stime.tv_sec * s_to_ns));
146 }
147 
148 struct evsel;
149 struct evlist;
150 
151 extern struct stats walltime_nsecs_stats;
152 extern struct rusage_stats ru_stats;
153 
154 typedef void (*print_metric_t)(struct perf_stat_config *config,
155 			       void *ctx, const char *color, const char *unit,
156 			       const char *fmt, double val);
157 typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
158 
159 void perf_stat__reset_shadow_stats(void);
160 struct perf_stat_output_ctx {
161 	void *ctx;
162 	print_metric_t print_metric;
163 	new_line_t new_line;
164 	bool force_header;
165 };
166 
167 void perf_stat__print_shadow_stats(struct perf_stat_config *config,
168 				   struct evsel *evsel,
169 				   double avg, int aggr_idx,
170 				   struct perf_stat_output_ctx *out,
171 				   struct rblist *metric_events);
172 
173 int evlist__alloc_stats(struct perf_stat_config *config,
174 			struct evlist *evlist, bool alloc_raw);
175 void evlist__free_stats(struct evlist *evlist);
176 void evlist__reset_stats(struct evlist *evlist);
177 void evlist__reset_prev_raw_counts(struct evlist *evlist);
178 void evlist__copy_prev_raw_counts(struct evlist *evlist);
179 void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
180 
181 int evlist__alloc_aggr_stats(struct evlist *evlist, int nr_aggr);
182 void evlist__reset_aggr_stats(struct evlist *evlist);
183 
184 int perf_stat_process_counter(struct perf_stat_config *config,
185 			      struct evsel *counter);
186 void perf_stat_merge_counters(struct perf_stat_config *config, struct evlist *evlist);
187 void perf_stat_process_percore(struct perf_stat_config *config, struct evlist *evlist);
188 
189 struct perf_tool;
190 union perf_event;
191 struct perf_session;
192 struct target;
193 
194 int perf_event__process_stat_event(struct perf_session *session,
195 				   union perf_event *event);
196 
197 size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
198 size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
199 size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
200 
201 int create_perf_stat_counter(struct evsel *evsel,
202 			     struct perf_stat_config *config,
203 			     struct target *target,
204 			     int cpu_map_idx);
205 void evlist__print_counters(struct evlist *evlist, struct perf_stat_config *config,
206 			    struct target *_target, struct timespec *ts, int argc, const char **argv);
207 
208 struct metric_expr;
209 double test_generic_metric(struct metric_expr *mexp, int aggr_idx);
210 #endif
211