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