[linux-block.git] / tools / perf / util / stat.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_STATS_H
#define __PERF_STATS_H

#include <linux/types.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/resource.h>
#include "cpumap.h"
#include "rblist.h"
#include "counts.h"

struct perf_cpu_map;
struct perf_stat_config;
struct timespec;

struct stats {
	double n, mean, M2;
	u64 max, min;
};

/* hold aggregated event info */
struct perf_stat_aggr {
	/* aggregated values */
	struct perf_counts_values	counts;
	/* number of entries (CPUs) aggregated */
	int				nr;
	/* whether any entry has failed to read/process event */
	bool				failed;
	/* to mark this data is processed already */
	bool				used;
};

/* per-evsel event stats */
struct perf_stat_evsel {
	/* used for repeated runs */
	struct stats		 res_stats;
	/* number of allocated 'aggr' */
	int			 nr_aggr;
	/* aggregated event values */
	struct perf_stat_aggr	*aggr;
	/* used for group read */
	u64			*group_data;
};

enum aggr_mode {
	AGGR_NONE,
	AGGR_GLOBAL,
	AGGR_SOCKET,
	AGGR_DIE,
	AGGR_CLUSTER,
	AGGR_CACHE,
	AGGR_CORE,
	AGGR_THREAD,
	AGGR_UNSET,
	AGGR_NODE,
	AGGR_MAX
};

struct rusage_stats {
	struct stats ru_utime_usec_stat;
	struct stats ru_stime_usec_stat;
};

typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config, struct perf_cpu cpu);

struct perf_stat_config {
	enum aggr_mode		 aggr_mode;
	u32			 aggr_level;
	bool			 scale;
	bool			 no_inherit;
	bool			 identifier;
	bool			 csv_output;
	bool			 json_output;
	bool			 interval_clear;
	bool			 metric_only;
	bool			 null_run;
	bool			 ru_display;
	bool			 big_num;
	bool			 hybrid_merge;
	bool			 walltime_run_table;
	bool			 all_kernel;
	bool			 all_user;
	bool			 percore_show_thread;
	bool			 summary;
	bool			 no_csv_summary;
	bool			 metric_no_group;
	bool			 metric_no_merge;
	bool			 metric_no_threshold;
	bool			 hardware_aware_grouping;
	bool			 stop_read_counter;
	bool			 iostat_run;
	char			 *user_requested_cpu_list;
	bool			 system_wide;
	FILE			*output;
	unsigned int		 interval;
	unsigned int		 timeout;
	unsigned int		 unit_width;
	unsigned int		 metric_only_len;
	int			 times;
	int			 run_count;
	int			 print_free_counters_hint;
	const char		*csv_sep;
	struct stats		*walltime_nsecs_stats;
	struct rusage		 ru_data;
	struct rusage_stats		 *ru_stats;
	struct cpu_aggr_map	*aggr_map;
	aggr_get_id_t		 aggr_get_id;
	struct cpu_aggr_map	*cpus_aggr_map;
	u64			*walltime_run;
	struct rblist		 metric_events;
	int			 ctl_fd;
	int			 ctl_fd_ack;
	bool			 ctl_fd_close;
	const char		*cgroup_list;
	unsigned int		topdown_level;
};

extern struct perf_stat_config stat_config;

void perf_stat__set_big_num(int set);

void update_stats(struct stats *stats, u64 val);
double avg_stats(struct stats *stats);
double stddev_stats(struct stats *stats);
double rel_stddev_stats(double stddev, double avg);

static inline void init_stats(struct stats *stats)
{
	stats->n    = 0.0;
	stats->mean = 0.0;
	stats->M2   = 0.0;
	stats->min  = (u64) -1;
	stats->max  = 0;
}

static inline void init_rusage_stats(struct rusage_stats *ru_stats) {
	init_stats(&ru_stats->ru_utime_usec_stat);
	init_stats(&ru_stats->ru_stime_usec_stat);
}

static inline void update_rusage_stats(struct rusage_stats *ru_stats, struct rusage* rusage) {
	const u64 us_to_ns = 1000;
	const u64 s_to_ns = 1000000000;
	update_stats(&ru_stats->ru_utime_usec_stat,
	             (rusage->ru_utime.tv_usec * us_to_ns + rusage->ru_utime.tv_sec * s_to_ns));
	update_stats(&ru_stats->ru_stime_usec_stat,
	             (rusage->ru_stime.tv_usec * us_to_ns + rusage->ru_stime.tv_sec * s_to_ns));
}

struct evsel;
struct evlist;

extern struct stats walltime_nsecs_stats;
extern struct rusage_stats ru_stats;

enum metric_threshold_classify {
	METRIC_THRESHOLD_UNKNOWN,
	METRIC_THRESHOLD_BAD,
	METRIC_THRESHOLD_NEARLY_BAD,
	METRIC_THRESHOLD_LESS_GOOD,
	METRIC_THRESHOLD_GOOD,
};
const char *metric_threshold_classify__color(enum metric_threshold_classify thresh);

typedef void (*print_metric_t)(struct perf_stat_config *config,
			       void *ctx,
			       enum metric_threshold_classify thresh,
			       const char *fmt,
			       const char *unit,
			       double val);
typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);

/* Used to print the display name of the Default metricgroup for now. */
typedef void (*print_metricgroup_header_t)(struct perf_stat_config *config,
					   void *ctx, const char *metricgroup_name);

void perf_stat__reset_shadow_stats(void);
struct perf_stat_output_ctx {
	void *ctx;
	print_metric_t print_metric;
	new_line_t new_line;
	print_metricgroup_header_t print_metricgroup_header;
	bool force_header;
};

void perf_stat__print_shadow_stats(struct perf_stat_config *config,
				   struct evsel *evsel,
				   double avg, int aggr_idx,
				   struct perf_stat_output_ctx *out,
				   struct rblist *metric_events);
bool perf_stat__skip_metric_event(struct evsel *evsel,
				  struct rblist *metric_events,
				  u64 ena, u64 run);
void *perf_stat__print_shadow_stats_metricgroup(struct perf_stat_config *config,
						struct evsel *evsel,
						int aggr_idx,
						int *num,
						void *from,
						struct perf_stat_output_ctx *out,
						struct rblist *metric_events);

int evlist__alloc_stats(struct perf_stat_config *config,
			struct evlist *evlist, bool alloc_raw);
void evlist__free_stats(struct evlist *evlist);
void evlist__reset_stats(struct evlist *evlist);
void evlist__reset_prev_raw_counts(struct evlist *evlist);
void evlist__copy_prev_raw_counts(struct evlist *evlist);
void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);

int evlist__alloc_aggr_stats(struct evlist *evlist, int nr_aggr);
void evlist__reset_aggr_stats(struct evlist *evlist);
void evlist__copy_res_stats(struct perf_stat_config *config, struct evlist *evlist);

int perf_stat_process_counter(struct perf_stat_config *config,
			      struct evsel *counter);
void perf_stat_merge_counters(struct perf_stat_config *config, struct evlist *evlist);
void perf_stat_process_percore(struct perf_stat_config *config, struct evlist *evlist);

struct perf_tool;
union perf_event;
struct perf_session;
struct target;

int perf_event__process_stat_event(struct perf_session *session,
				   union perf_event *event);

size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);

int create_perf_stat_counter(struct evsel *evsel,
			     struct perf_stat_config *config,
			     struct target *target,
			     int cpu_map_idx);
void evlist__print_counters(struct evlist *evlist, struct perf_stat_config *config,
			    struct target *_target, struct timespec *ts, int argc, const char **argv);

struct metric_expr;
double test_generic_metric(struct metric_expr *mexp, int aggr_idx);
#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
0007ecea XG	2	#ifndef __PERF_STATS_H
	3	#define __PERF_STATS_H
	4
d944c4ee	5	#include <linux/types.h>
f87027b9	6	#include <stdio.h>
8897a891	7	#include <sys/types.h>
8897a891	8	#include <sys/resource.h>
2760f5a1	9	#include "cpumap.h"
e5fcc2ab	10	#include "rblist.h"
ca68b374	11	#include "counts.h"
0007ecea	12
b251892d ACM	13	struct perf_cpu_map;
b251892d ACM	14	struct perf_stat_config;
38b7b678 ACM	15	struct timespec;
38b7b678 ACM	16
e55c14af	17	struct stats {
0007ecea	18	double n, mean, M2;
ffe4f3c0	19	u64 max, min;
0007ecea XG	20	};
0007ecea XG	21
ca68b374 NK	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;
1d6d2bea NK	30	/* to mark this data is processed already */
1d6d2bea NK	31	bool used;
ca68b374 NK	32	};
	33
	34	/* per-evsel event stats */
581cc8a2	35	struct perf_stat_evsel {
ca68b374	36	/* used for repeated runs */
66b76e30	37	struct stats res_stats;
ca68b374 NK	38	/* number of allocated 'aggr' */
	39	int nr_aggr;
	40	/* aggregated event values */
	41	struct perf_stat_aggr *aggr;
	42	/* used for group read */
f7794d52	43	u64 *group_data;
e2f56da1 JO	44	};
e2f56da1 JO	45
f87027b9 JO	46	enum aggr_mode {
	47	AGGR_NONE,
	48	AGGR_GLOBAL,
	49	AGGR_SOCKET,
db5742b6	50	AGGR_DIE,
cbc917a1	51	AGGR_CLUSTER,
995ed074	52	AGGR_CACHE,
f87027b9	53	AGGR_CORE,
32b8af82	54	AGGR_THREAD,
208df99e	55	AGGR_UNSET,
86895b48	56	AGGR_NODE,
df936cad	57	AGGR_MAX
f87027b9 JO	58	};
f87027b9 JO	59
c735b0a5 FF	60	struct rusage_stats {
	61	struct stats ru_utime_usec_stat;
	62	struct stats ru_stime_usec_stat;
	63	};
	64
6d18804b	65	typedef struct aggr_cpu_id (aggr_get_id_t)(struct perf_stat_config config, struct perf_cpu cpu);
6f6b6594	66
421a50f3	67	struct perf_stat_config {
728c0ee0	68	enum aggr_mode aggr_mode;
995ed074	69	u32 aggr_level;
728c0ee0	70	bool scale;
5698f26b	71	bool no_inherit;
7d9ad16a	72	bool identifier;
fa7070a3	73	bool csv_output;
df936cad	74	bool json_output;
132c6ba3	75	bool interval_clear;
0ce5aa02	76	bool metric_only;
aea0dca1	77	bool null_run;
8897a891	78	bool ru_display;
34ff0866	79	bool big_num;
2c8e6451	80	bool hybrid_merge;
54ac0b1b	81	bool walltime_run_table;
dd071024 JY	82	bool all_kernel;
dd071024 JY	83	bool all_user;
1af62ce6	84	bool percore_show_thread;
c7e5b328	85	bool summary;
0bdad978	86	bool no_csv_summary;
05530a79 IR	87	bool metric_no_group;
05530a79 IR	88	bool metric_no_merge;
1fd09e29	89	bool metric_no_threshold;
03f23570	90	bool hardware_aware_grouping;
ee6a9614	91	bool stop_read_counter;
f07952b1	92	bool iostat_run;
1725e9cd IR	93	char *user_requested_cpu_list;
1725e9cd IR	94	bool system_wide;
728c0ee0 JO	95	FILE *output;
	96	unsigned int interval;
	97	unsigned int timeout;
df4f7b4d	98	unsigned int unit_width;
ee1760e2	99	unsigned int metric_only_len;
728c0ee0	100	int times;
d97ae04b	101	int run_count;
31084123	102	int print_free_counters_hint;
fa7070a3	103	const char *csv_sep;
26893a60	104	struct stats *walltime_nsecs_stats;
8897a891	105	struct rusage ru_data;
c735b0a5	106	struct rusage_stats *ru_stats;
d526e1a0	107	struct cpu_aggr_map *aggr_map;
6f6b6594	108	aggr_get_id_t aggr_get_id;
d526e1a0	109	struct cpu_aggr_map *cpus_aggr_map;
54ac0b1b	110	u64 *walltime_run;
d0192fdb	111	struct rblist metric_events;
27e9769a AB	112	int ctl_fd;
27e9769a AB	113	int ctl_fd_ack;
a8fcbd26	114	bool ctl_fd_close;
d1c5a0e8	115	const char *cgroup_list;
63e39aa6	116	unsigned int topdown_level;
421a50f3 JO	117	};
421a50f3 JO	118
9557d156 IR	119	extern struct perf_stat_config stat_config;
9557d156 IR	120
d778a778 PC	121	void perf_stat__set_big_num(int set);
d778a778 PC	122
0007ecea XG	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
ffe4f3c0 DA	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	}
e2f56da1	136
c735b0a5 FF	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
	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
32dcd021	151	struct evsel;
63503dba	152	struct evlist;
24e34f68	153
f87027b9	154	extern struct stats walltime_nsecs_stats;
c735b0a5	155	extern struct rusage_stats ru_stats;
f87027b9	156
37b77ae9 IR	157	enum 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	};
	164	const char *metric_threshold_classify__color(enum metric_threshold_classify thresh);
	165
6ca9a082	166	typedef void (print_metric_t)(struct perf_stat_config config,
37b77ae9 IR	167	void *ctx,
37b77ae9 IR	168	enum metric_threshold_classify thresh,
9809b2b1 IR	169	const char *fmt,
	170	const char *unit,
	171	double val);
6ca9a082	172	typedef void (new_line_t)(struct perf_stat_config config, void *ctx);
140aeadc	173
6a80d794 KL	174	/* Used to print the display name of the Default metricgroup for now. */
	175	typedef void (print_metricgroup_header_t)(struct perf_stat_config config,
	176	void ctx, const char metricgroup_name);
	177
f87027b9	178	void perf_stat__reset_shadow_stats(void);
140aeadc AK	179	struct perf_stat_output_ctx {
	180	void *ctx;
	181	print_metric_t print_metric;
	182	new_line_t new_line;
6a80d794	183	print_metricgroup_header_t print_metricgroup_header;
37932c18	184	bool force_header;
140aeadc AK	185	};
140aeadc AK	186
6ca9a082	187	void perf_stat__print_shadow_stats(struct perf_stat_config *config,
32dcd021	188	struct evsel *evsel,
8945bef3	189	double avg, int aggr_idx,
b18f3e36	190	struct perf_stat_output_ctx *out,
cc26ffaa	191	struct rblist *metric_events);
6a80d794 KL	192	bool perf_stat__skip_metric_event(struct evsel *evsel,
	193	struct rblist *metric_events,
	194	u64 ena, u64 run);
	195	void 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);
f87027b9	202
1f297a6e NK	203	int evlist__alloc_stats(struct perf_stat_config *config,
1f297a6e NK	204	struct evlist *evlist, bool alloc_raw);
53f5e908 ACM	205	void evlist__free_stats(struct evlist *evlist);
	206	void evlist__reset_stats(struct evlist *evlist);
	207	void evlist__reset_prev_raw_counts(struct evlist *evlist);
	208	void evlist__copy_prev_raw_counts(struct evlist *evlist);
	209	void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
f80010eb	210
ae7e6492	211	int evlist__alloc_aggr_stats(struct evlist *evlist, int nr_aggr);
8f97963e	212	void evlist__reset_aggr_stats(struct evlist *evlist);
dada1a1f	213	void evlist__copy_res_stats(struct perf_stat_config config, struct evlist evlist);
ae7e6492	214
f80010eb	215	int perf_stat_process_counter(struct perf_stat_config *config,
32dcd021	216	struct evsel *counter);
942c5593	217	void perf_stat_merge_counters(struct perf_stat_config config, struct evlist evlist);
1d6d2bea	218	void perf_stat_process_percore(struct perf_stat_config config, struct evlist evlist);
942c5593	219
0ea0e355 JO	220	struct perf_tool;
	221	union perf_event;
	222	struct perf_session;
aeb00b1a ACM	223	struct target;
aeb00b1a ACM	224
89f1688a JO	225	int perf_event__process_stat_event(struct perf_session *session,
89f1688a JO	226	union perf_event *event);
e08a4564 JO	227
	228	size_t perf_event__fprintf_stat(union perf_event event, FILE fp);
	229	size_t perf_event__fprintf_stat_round(union perf_event event, FILE fp);
	230	size_t perf_event__fprintf_stat_config(union perf_event event, FILE fp);
d09cefd2	231
32dcd021	232	int create_perf_stat_counter(struct evsel *evsel,
d09cefd2	233	struct perf_stat_config *config,
4804e011	234	struct target *target,
6f844b1f	235	int cpu_map_idx);
71273724 ACM	236	void evlist__print_counters(struct evlist evlist, struct perf_stat_config config,
71273724 ACM	237	struct target _target, struct timespec ts, int argc, const char **argv);
6d432c4c JO	238
6d432c4c JO	239	struct metric_expr;
8945bef3	240	double test_generic_metric(struct metric_expr *mexp, int aggr_idx);
0007ecea	241	#endif