[mirror_ubuntu-hirsute-kernel.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 "xyarray.h"
#include "rblist.h"
#include "perf.h"
#include "event.h"

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

enum perf_stat_evsel_id {
	PERF_STAT_EVSEL_ID__NONE = 0,
	PERF_STAT_EVSEL_ID__CYCLES_IN_TX,
	PERF_STAT_EVSEL_ID__TRANSACTION_START,
	PERF_STAT_EVSEL_ID__ELISION_START,
	PERF_STAT_EVSEL_ID__CYCLES_IN_TX_CP,
	PERF_STAT_EVSEL_ID__TOPDOWN_TOTAL_SLOTS,
	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_ISSUED,
	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_RETIRED,
	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_BUBBLES,
	PERF_STAT_EVSEL_ID__TOPDOWN_RECOVERY_BUBBLES,
	PERF_STAT_EVSEL_ID__SMI_NUM,
	PERF_STAT_EVSEL_ID__APERF,
	PERF_STAT_EVSEL_ID__MAX,
};

struct perf_stat_evsel {
	struct stats		 res_stats[3];
	enum perf_stat_evsel_id	 id;
	u64			*group_data;
};

enum aggr_mode {
	AGGR_NONE,
	AGGR_GLOBAL,
	AGGR_SOCKET,
	AGGR_CORE,
	AGGR_THREAD,
	AGGR_UNSET,
};

enum {
	CTX_BIT_USER	= 1 << 0,
	CTX_BIT_KERNEL	= 1 << 1,
	CTX_BIT_HV	= 1 << 2,
	CTX_BIT_HOST	= 1 << 3,
	CTX_BIT_IDLE	= 1 << 4,
	CTX_BIT_MAX	= 1 << 5,
};

#define NUM_CTX CTX_BIT_MAX

enum stat_type {
	STAT_NONE = 0,
	STAT_NSECS,
	STAT_CYCLES,
	STAT_STALLED_CYCLES_FRONT,
	STAT_STALLED_CYCLES_BACK,
	STAT_BRANCHES,
	STAT_CACHEREFS,
	STAT_L1_DCACHE,
	STAT_L1_ICACHE,
	STAT_LL_CACHE,
	STAT_ITLB_CACHE,
	STAT_DTLB_CACHE,
	STAT_CYCLES_IN_TX,
	STAT_TRANSACTION,
	STAT_ELISION,
	STAT_TOPDOWN_TOTAL_SLOTS,
	STAT_TOPDOWN_SLOTS_ISSUED,
	STAT_TOPDOWN_SLOTS_RETIRED,
	STAT_TOPDOWN_FETCH_BUBBLES,
	STAT_TOPDOWN_RECOVERY_BUBBLES,
	STAT_SMI_NUM,
	STAT_APERF,
	STAT_MAX
};

struct runtime_stat {
	struct rblist value_list;
};

struct perf_stat_config {
	enum aggr_mode		 aggr_mode;
	bool			 scale;
	bool			 no_inherit;
	bool			 identifier;
	bool			 csv_output;
	bool			 interval_clear;
	bool			 metric_only;
	bool			 null_run;
	FILE			*output;
	unsigned int		 interval;
	unsigned int		 timeout;
	unsigned int		 initial_delay;
	unsigned int		 unit_width;
	unsigned int		 metric_only_len;
	int			 times;
	int			 run_count;
	struct runtime_stat	*stats;
	int			 stats_num;
	const char		*csv_sep;
	struct stats		*walltime_nsecs_stats;
};

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;
}

struct perf_evsel;
struct perf_evlist;

struct perf_aggr_thread_value {
	struct perf_evsel *counter;
	int id;
	double uval;
	u64 val;
	u64 run;
	u64 ena;
};

bool __perf_evsel_stat__is(struct perf_evsel *evsel,
			   enum perf_stat_evsel_id id);

#define perf_stat_evsel__is(evsel, id) \
	__perf_evsel_stat__is(evsel, PERF_STAT_EVSEL_ID__ ## id)

extern struct runtime_stat rt_stat;
extern struct stats walltime_nsecs_stats;

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

void runtime_stat__init(struct runtime_stat *st);
void runtime_stat__exit(struct runtime_stat *st);
void perf_stat__init_shadow_stats(void);
void perf_stat__reset_shadow_stats(void);
void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
void perf_stat__update_shadow_stats(struct perf_evsel *counter, u64 count,
				    int cpu, struct runtime_stat *st);
struct perf_stat_output_ctx {
	void *ctx;
	print_metric_t print_metric;
	new_line_t new_line;
	bool force_header;
};

void perf_stat__print_shadow_stats(struct perf_stat_config *config,
				   struct perf_evsel *evsel,
				   double avg, int cpu,
				   struct perf_stat_output_ctx *out,
				   struct rblist *metric_events,
				   struct runtime_stat *st);
void perf_stat__collect_metric_expr(struct perf_evlist *);

int perf_evlist__alloc_stats(struct perf_evlist *evlist, bool alloc_raw);
void perf_evlist__free_stats(struct perf_evlist *evlist);
void perf_evlist__reset_stats(struct perf_evlist *evlist);

int perf_stat_process_counter(struct perf_stat_config *config,
			      struct perf_evsel *counter);
struct perf_tool;
union perf_event;
struct perf_session;
int perf_event__process_stat_event(struct perf_tool *tool,
				   union perf_event *event,
				   struct perf_session *session);

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 perf_evsel *evsel,
			     struct perf_stat_config *config,
			     struct target *target);
int perf_stat_synthesize_config(struct perf_stat_config *config,
				struct perf_tool *tool,
				struct perf_evlist *evlist,
				perf_event__handler_t process,
				bool attrs);
#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>
a8e02324	7	#include "xyarray.h"
e5fcc2ab	8	#include "rblist.h"
728c0ee0	9	#include "perf.h"
0a4e64d3	10	#include "event.h"
0007ecea	11
e55c14af	12	struct stats {
0007ecea	13	double n, mean, M2;
ffe4f3c0	14	u64 max, min;
0007ecea XG	15	};
0007ecea XG	16
e2f56da1 JO	17	enum perf_stat_evsel_id {
e2f56da1 JO	18	PERF_STAT_EVSEL_ID__NONE = 0,
4c358d5c JO	19	PERF_STAT_EVSEL_ID__CYCLES_IN_TX,
	20	PERF_STAT_EVSEL_ID__TRANSACTION_START,
	21	PERF_STAT_EVSEL_ID__ELISION_START,
	22	PERF_STAT_EVSEL_ID__CYCLES_IN_TX_CP,
239bd47f AK	23	PERF_STAT_EVSEL_ID__TOPDOWN_TOTAL_SLOTS,
	24	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_ISSUED,
	25	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_RETIRED,
	26	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_BUBBLES,
	27	PERF_STAT_EVSEL_ID__TOPDOWN_RECOVERY_BUBBLES,
daefd0bc KL	28	PERF_STAT_EVSEL_ID__SMI_NUM,
daefd0bc KL	29	PERF_STAT_EVSEL_ID__APERF,
e2f56da1 JO	30	PERF_STAT_EVSEL_ID__MAX,
	31	};
	32
581cc8a2	33	struct perf_stat_evsel {
f7794d52 JO	34	struct stats res_stats[3];
	35	enum perf_stat_evsel_id id;
	36	u64 *group_data;
e2f56da1 JO	37	};
e2f56da1 JO	38
f87027b9 JO	39	enum aggr_mode {
	40	AGGR_NONE,
	41	AGGR_GLOBAL,
	42	AGGR_SOCKET,
	43	AGGR_CORE,
32b8af82	44	AGGR_THREAD,
208df99e	45	AGGR_UNSET,
f87027b9 JO	46	};
f87027b9 JO	47
e5fcc2ab JY	48	enum {
	49	CTX_BIT_USER = 1 << 0,
	50	CTX_BIT_KERNEL = 1 << 1,
	51	CTX_BIT_HV = 1 << 2,
	52	CTX_BIT_HOST = 1 << 3,
	53	CTX_BIT_IDLE = 1 << 4,
	54	CTX_BIT_MAX = 1 << 5,
	55	};
	56
	57	#define NUM_CTX CTX_BIT_MAX
	58
	59	enum stat_type {
	60	STAT_NONE = 0,
	61	STAT_NSECS,
	62	STAT_CYCLES,
	63	STAT_STALLED_CYCLES_FRONT,
	64	STAT_STALLED_CYCLES_BACK,
	65	STAT_BRANCHES,
	66	STAT_CACHEREFS,
	67	STAT_L1_DCACHE,
	68	STAT_L1_ICACHE,
	69	STAT_LL_CACHE,
	70	STAT_ITLB_CACHE,
	71	STAT_DTLB_CACHE,
	72	STAT_CYCLES_IN_TX,
	73	STAT_TRANSACTION,
	74	STAT_ELISION,
	75	STAT_TOPDOWN_TOTAL_SLOTS,
	76	STAT_TOPDOWN_SLOTS_ISSUED,
	77	STAT_TOPDOWN_SLOTS_RETIRED,
	78	STAT_TOPDOWN_FETCH_BUBBLES,
	79	STAT_TOPDOWN_RECOVERY_BUBBLES,
	80	STAT_SMI_NUM,
	81	STAT_APERF,
	82	STAT_MAX
	83	};
	84
	85	struct runtime_stat {
	86	struct rblist value_list;
	87	};
	88
421a50f3	89	struct perf_stat_config {
728c0ee0 JO	90	enum aggr_mode aggr_mode;
728c0ee0 JO	91	bool scale;
5698f26b	92	bool no_inherit;
7d9ad16a	93	bool identifier;
fa7070a3	94	bool csv_output;
132c6ba3	95	bool interval_clear;
0ce5aa02	96	bool metric_only;
aea0dca1	97	bool null_run;
728c0ee0 JO	98	FILE *output;
	99	unsigned int interval;
	100	unsigned int timeout;
	101	unsigned int initial_delay;
df4f7b4d	102	unsigned int unit_width;
ee1760e2	103	unsigned int metric_only_len;
728c0ee0	104	int times;
d97ae04b	105	int run_count;
728c0ee0 JO	106	struct runtime_stat *stats;
728c0ee0 JO	107	int stats_num;
fa7070a3	108	const char *csv_sep;
26893a60	109	struct stats *walltime_nsecs_stats;
421a50f3 JO	110	};
421a50f3 JO	111
0007ecea XG	112	void update_stats(struct stats *stats, u64 val);
	113	double avg_stats(struct stats *stats);
	114	double stddev_stats(struct stats *stats);
	115	double rel_stddev_stats(double stddev, double avg);
	116
ffe4f3c0 DA	117	static inline void init_stats(struct stats *stats)
	118	{
	119	stats->n = 0.0;
	120	stats->mean = 0.0;
	121	stats->M2 = 0.0;
	122	stats->min = (u64) -1;
	123	stats->max = 0;
	124	}
e2f56da1 JO	125
e2f56da1 JO	126	struct perf_evsel;
24e34f68 JO	127	struct perf_evlist;
24e34f68 JO	128
29734550 JY	129	struct perf_aggr_thread_value {
	130	struct perf_evsel *counter;
	131	int id;
	132	double uval;
	133	u64 val;
	134	u64 run;
	135	u64 ena;
	136	};
	137
e2f56da1 JO	138	bool __perf_evsel_stat__is(struct perf_evsel *evsel,
	139	enum perf_stat_evsel_id id);
	140
	141	#define perf_stat_evsel__is(evsel, id) \
	142	__perf_evsel_stat__is(evsel, PERF_STAT_EVSEL_ID__ ## id)
	143
8efb2df1	144	extern struct runtime_stat rt_stat;
f87027b9 JO	145	extern struct stats walltime_nsecs_stats;
f87027b9 JO	146
6ca9a082 JO	147	typedef void (print_metric_t)(struct perf_stat_config config,
6ca9a082 JO	148	void ctx, const char color, const char *unit,
140aeadc	149	const char *fmt, double val);
6ca9a082	150	typedef void (new_line_t)(struct perf_stat_config config, void *ctx);
140aeadc	151
8efb2df1 JY	152	void runtime_stat__init(struct runtime_stat *st);
8efb2df1 JY	153	void runtime_stat__exit(struct runtime_stat *st);
fb4605ba	154	void perf_stat__init_shadow_stats(void);
f87027b9	155	void perf_stat__reset_shadow_stats(void);
6a1e2c5c	156	void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
54830dd0	157	void perf_stat__update_shadow_stats(struct perf_evsel *counter, u64 count,
1fcd0394	158	int cpu, struct runtime_stat *st);
140aeadc AK	159	struct perf_stat_output_ctx {
	160	void *ctx;
	161	print_metric_t print_metric;
	162	new_line_t new_line;
37932c18	163	bool force_header;
140aeadc AK	164	};
140aeadc AK	165
6ca9a082 JO	166	void perf_stat__print_shadow_stats(struct perf_stat_config *config,
6ca9a082 JO	167	struct perf_evsel *evsel,
140aeadc	168	double avg, int cpu,
b18f3e36	169	struct perf_stat_output_ctx *out,
e0128b30 JY	170	struct rblist *metric_events,
e0128b30 JY	171	struct runtime_stat *st);
37932c18	172	void perf_stat__collect_metric_expr(struct perf_evlist *);
f87027b9	173
24e34f68 JO	174	int perf_evlist__alloc_stats(struct perf_evlist *evlist, bool alloc_raw);
	175	void perf_evlist__free_stats(struct perf_evlist *evlist);
	176	void perf_evlist__reset_stats(struct perf_evlist *evlist);
f80010eb JO	177
	178	int perf_stat_process_counter(struct perf_stat_config *config,
	179	struct perf_evsel *counter);
0ea0e355 JO	180	struct perf_tool;
	181	union perf_event;
	182	struct perf_session;
	183	int perf_event__process_stat_event(struct perf_tool *tool,
	184	union perf_event *event,
	185	struct perf_session *session);
e08a4564 JO	186
	187	size_t perf_event__fprintf_stat(union perf_event event, FILE fp);
	188	size_t perf_event__fprintf_stat_round(union perf_event event, FILE fp);
	189	size_t perf_event__fprintf_stat_config(union perf_event event, FILE fp);
d09cefd2 JO	190
	191	int create_perf_stat_counter(struct perf_evsel *evsel,
	192	struct perf_stat_config *config,
	193	struct target *target);
0a4e64d3 JO	194	int perf_stat_synthesize_config(struct perf_stat_config *config,
	195	struct perf_tool *tool,
	196	struct perf_evlist *evlist,
	197	perf_event__handler_t process,
	198	bool attrs);
0007ecea	199	#endif