[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"

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;
	FILE			*output;
	unsigned int		 interval;
	unsigned int		 timeout;
	unsigned int		 initial_delay;
	int			 times;
	struct runtime_stat	*stats;
	int			 stats_num;
};

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