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_CLUSTER,
52  	AGGR_CACHE,
53  	AGGR_CORE,
54  	AGGR_THREAD,
55  	AGGR_UNSET,
56  	AGGR_NODE,
57  	AGGR_MAX
58  };
59  
60  struct rusage_stats {
61  	struct stats ru_utime_usec_stat;
62  	struct stats ru_stime_usec_stat;
63  };
64  
65  typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config, struct perf_cpu cpu);
66  
67  struct 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  
120  void perf_stat__set_big_num(int set);
121  void perf_stat__set_no_csv_summary(int set);
122  
123  void update_stats(struct stats *stats, u64 val);
124  double avg_stats(struct stats *stats);
125  double stddev_stats(struct stats *stats);
126  double rel_stddev_stats(double stddev, double avg);
127  
init_stats(struct stats * stats)128  static 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  
init_rusage_stats(struct rusage_stats * ru_stats)137  static 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  
update_rusage_stats(struct rusage_stats * ru_stats,struct rusage * rusage)142  static 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  
151  struct evsel;
152  struct evlist;
153  
154  extern struct stats walltime_nsecs_stats;
155  extern struct rusage_stats ru_stats;
156  
157  typedef void (*print_metric_t)(struct perf_stat_config *config,
158  			       void *ctx, const char *color, const char *unit,
159  			       const char *fmt, double val);
160  typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
161  
162  /* Used to print the display name of the Default metricgroup for now. */
163  typedef void (*print_metricgroup_header_t)(struct perf_stat_config *config,
164  					   void *ctx, const char *metricgroup_name);
165  
166  void perf_stat__reset_shadow_stats(void);
167  struct perf_stat_output_ctx {
168  	void *ctx;
169  	print_metric_t print_metric;
170  	new_line_t new_line;
171  	print_metricgroup_header_t print_metricgroup_header;
172  	bool force_header;
173  };
174  
175  void perf_stat__print_shadow_stats(struct perf_stat_config *config,
176  				   struct evsel *evsel,
177  				   double avg, int aggr_idx,
178  				   struct perf_stat_output_ctx *out,
179  				   struct rblist *metric_events);
180  bool perf_stat__skip_metric_event(struct evsel *evsel,
181  				  struct rblist *metric_events,
182  				  u64 ena, u64 run);
183  void *perf_stat__print_shadow_stats_metricgroup(struct perf_stat_config *config,
184  						struct evsel *evsel,
185  						int aggr_idx,
186  						int *num,
187  						void *from,
188  						struct perf_stat_output_ctx *out,
189  						struct rblist *metric_events);
190  
191  int evlist__alloc_stats(struct perf_stat_config *config,
192  			struct evlist *evlist, bool alloc_raw);
193  void evlist__free_stats(struct evlist *evlist);
194  void evlist__reset_stats(struct evlist *evlist);
195  void evlist__reset_prev_raw_counts(struct evlist *evlist);
196  void evlist__copy_prev_raw_counts(struct evlist *evlist);
197  void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
198  
199  int evlist__alloc_aggr_stats(struct evlist *evlist, int nr_aggr);
200  void evlist__reset_aggr_stats(struct evlist *evlist);
201  void evlist__copy_res_stats(struct perf_stat_config *config, struct evlist *evlist);
202  
203  int perf_stat_process_counter(struct perf_stat_config *config,
204  			      struct evsel *counter);
205  void perf_stat_merge_counters(struct perf_stat_config *config, struct evlist *evlist);
206  void perf_stat_process_percore(struct perf_stat_config *config, struct evlist *evlist);
207  
208  struct perf_tool;
209  union perf_event;
210  struct perf_session;
211  struct target;
212  
213  int perf_event__process_stat_event(struct perf_session *session,
214  				   union perf_event *event);
215  
216  size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
217  size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
218  size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
219  
220  int create_perf_stat_counter(struct evsel *evsel,
221  			     struct perf_stat_config *config,
222  			     struct target *target,
223  			     int cpu_map_idx);
224  void evlist__print_counters(struct evlist *evlist, struct perf_stat_config *config,
225  			    struct target *_target, struct timespec *ts, int argc, const char **argv);
226  
227  struct metric_expr;
228  double test_generic_metric(struct metric_expr *mexp, int aggr_idx);
229  #endif
230