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
 13struct perf_cpu_map;
 14struct perf_stat_config;
 15struct timespec;
 16
 17struct stats {
 18	double n, mean, M2;
 19	u64 max, min;
 20};
 21
 22/* hold aggregated event info */
 23struct 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 */
 35struct 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
 46enum aggr_mode {
 47	AGGR_NONE,
 48	AGGR_GLOBAL,
 49	AGGR_SOCKET,
 50	AGGR_DIE,
 51	AGGR_CLUSTER,
 52	AGGR_CACHE,
 53	AGGR_CORE,
 54	AGGR_THREAD,
 55	AGGR_UNSET,
 56	AGGR_NODE,
 57	AGGR_MAX
 58};
 59
 60struct rusage_stats {
 61	struct stats ru_utime_usec_stat;
 62	struct stats ru_stime_usec_stat;
 63};
 64
 65typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config, struct perf_cpu cpu);
 66
 67struct perf_stat_config {
 68	enum aggr_mode		 aggr_mode;
 69	u32			 aggr_level;
 70	bool			 scale;
 71	bool			 no_inherit;
 72	bool			 identifier;
 73	bool			 csv_output;
 74	bool			 json_output;
 75	bool			 interval_clear;
 76	bool			 metric_only;
 77	bool			 null_run;
 78	bool			 ru_display;
 79	bool			 big_num;
 80	bool			 hybrid_merge;
 81	bool			 walltime_run_table;
 82	bool			 all_kernel;
 83	bool			 all_user;
 84	bool			 percore_show_thread;
 85	bool			 summary;
 86	bool			 no_csv_summary;
 87	bool			 metric_no_group;
 88	bool			 metric_no_merge;
 89	bool			 metric_no_threshold;
 90	bool			 hardware_aware_grouping;
 91	bool			 stop_read_counter;
 92	bool			 iostat_run;
 93	char			 *user_requested_cpu_list;
 94	bool			 system_wide;
 95	FILE			*output;
 96	unsigned int		 interval;
 97	unsigned int		 timeout;
 98	unsigned int		 unit_width;
 99	unsigned int		 metric_only_len;
100	int			 times;
101	int			 run_count;
102	int			 print_free_counters_hint;
103	int			 print_mixed_hw_group_error;
104	const char		*csv_sep;
105	struct stats		*walltime_nsecs_stats;
106	struct rusage		 ru_data;
107	struct rusage_stats		 *ru_stats;
108	struct cpu_aggr_map	*aggr_map;
109	aggr_get_id_t		 aggr_get_id;
110	struct cpu_aggr_map	*cpus_aggr_map;
111	u64			*walltime_run;
112	struct rblist		 metric_events;
113	int			 ctl_fd;
114	int			 ctl_fd_ack;
115	bool			 ctl_fd_close;
116	const char		*cgroup_list;
117	unsigned int		topdown_level;
118};
119
120void perf_stat__set_big_num(int set);
121void perf_stat__set_no_csv_summary(int set);
122
123void update_stats(struct stats *stats, u64 val);
124double avg_stats(struct stats *stats);
125double stddev_stats(struct stats *stats);
126double rel_stddev_stats(double stddev, double avg);
127
128static inline void init_stats(struct stats *stats)
129{
130	stats->n    = 0.0;
131	stats->mean = 0.0;
132	stats->M2   = 0.0;
133	stats->min  = (u64) -1;
134	stats->max  = 0;
135}
136
137static inline void init_rusage_stats(struct rusage_stats *ru_stats) {
138	init_stats(&ru_stats->ru_utime_usec_stat);
139	init_stats(&ru_stats->ru_stime_usec_stat);
140}
141
142static inline void update_rusage_stats(struct rusage_stats *ru_stats, struct rusage* rusage) {
143	const u64 us_to_ns = 1000;
144	const u64 s_to_ns = 1000000000;
145	update_stats(&ru_stats->ru_utime_usec_stat,
146	             (rusage->ru_utime.tv_usec * us_to_ns + rusage->ru_utime.tv_sec * s_to_ns));
147	update_stats(&ru_stats->ru_stime_usec_stat,
148	             (rusage->ru_stime.tv_usec * us_to_ns + rusage->ru_stime.tv_sec * s_to_ns));
149}
150
151struct evsel;
152struct evlist;
153
154extern struct stats walltime_nsecs_stats;
155extern struct rusage_stats ru_stats;
156
157enum metric_threshold_classify {
158	METRIC_THRESHOLD_UNKNOWN,
159	METRIC_THRESHOLD_BAD,
160	METRIC_THRESHOLD_NEARLY_BAD,
161	METRIC_THRESHOLD_LESS_GOOD,
162	METRIC_THRESHOLD_GOOD,
163};
164const char *metric_threshold_classify__color(enum metric_threshold_classify thresh);
165
166typedef void (*print_metric_t)(struct perf_stat_config *config,
167			       void *ctx,
168			       enum metric_threshold_classify thresh,
169			       const char *fmt,
170			       const char *unit,
171			       double val);
172typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
173
174/* Used to print the display name of the Default metricgroup for now. */
175typedef void (*print_metricgroup_header_t)(struct perf_stat_config *config,
176					   void *ctx, const char *metricgroup_name);
177
178void perf_stat__reset_shadow_stats(void);
179struct perf_stat_output_ctx {
180	void *ctx;
181	print_metric_t print_metric;
182	new_line_t new_line;
183	print_metricgroup_header_t print_metricgroup_header;
184	bool force_header;
185};
186
187void perf_stat__print_shadow_stats(struct perf_stat_config *config,
188				   struct evsel *evsel,
189				   double avg, int aggr_idx,
190				   struct perf_stat_output_ctx *out,
191				   struct rblist *metric_events);
192bool perf_stat__skip_metric_event(struct evsel *evsel,
193				  struct rblist *metric_events,
194				  u64 ena, u64 run);
195void *perf_stat__print_shadow_stats_metricgroup(struct perf_stat_config *config,
196						struct evsel *evsel,
197						int aggr_idx,
198						int *num,
199						void *from,
200						struct perf_stat_output_ctx *out,
201						struct rblist *metric_events);
202
203int evlist__alloc_stats(struct perf_stat_config *config,
204			struct evlist *evlist, bool alloc_raw);
205void evlist__free_stats(struct evlist *evlist);
206void evlist__reset_stats(struct evlist *evlist);
207void evlist__reset_prev_raw_counts(struct evlist *evlist);
208void evlist__copy_prev_raw_counts(struct evlist *evlist);
209void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
210
211int evlist__alloc_aggr_stats(struct evlist *evlist, int nr_aggr);
212void evlist__reset_aggr_stats(struct evlist *evlist);
213void evlist__copy_res_stats(struct perf_stat_config *config, struct evlist *evlist);
214
215int perf_stat_process_counter(struct perf_stat_config *config,
216			      struct evsel *counter);
217void perf_stat_merge_counters(struct perf_stat_config *config, struct evlist *evlist);
218void perf_stat_process_percore(struct perf_stat_config *config, struct evlist *evlist);
219
220struct perf_tool;
221union perf_event;
222struct perf_session;
223struct target;
224
225int perf_event__process_stat_event(struct perf_session *session,
226				   union perf_event *event);
227
228size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
229size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
230size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
231
232int create_perf_stat_counter(struct evsel *evsel,
233			     struct perf_stat_config *config,
234			     struct target *target,
235			     int cpu_map_idx);
236void evlist__print_counters(struct evlist *evlist, struct perf_stat_config *config,
237			    struct target *_target, struct timespec *ts, int argc, const char **argv);
238
239struct metric_expr;
240double test_generic_metric(struct metric_expr *mexp, int aggr_idx);
241#endif