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

struct perf_cpu_map;
struct perf_stat_config;
struct timespec;

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__TOPDOWN_RETIRING,
	PERF_STAT_EVSEL_ID__TOPDOWN_BAD_SPEC,
	PERF_STAT_EVSEL_ID__TOPDOWN_FE_BOUND,
	PERF_STAT_EVSEL_ID__TOPDOWN_BE_BOUND,
	PERF_STAT_EVSEL_ID__TOPDOWN_HEAVY_OPS,
	PERF_STAT_EVSEL_ID__TOPDOWN_BR_MISPREDICT,
	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_LAT,
	PERF_STAT_EVSEL_ID__TOPDOWN_MEM_BOUND,
	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_DIE,
	AGGR_CORE,
	AGGR_THREAD,
	AGGR_UNSET,
	AGGR_NODE,
};

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_TOPDOWN_RETIRING,
	STAT_TOPDOWN_BAD_SPEC,
	STAT_TOPDOWN_FE_BOUND,
	STAT_TOPDOWN_BE_BOUND,
	STAT_TOPDOWN_HEAVY_OPS,
	STAT_TOPDOWN_BR_MISPREDICT,
	STAT_TOPDOWN_FETCH_LAT,
	STAT_TOPDOWN_MEM_BOUND,
	STAT_SMI_NUM,
	STAT_APERF,
	STAT_MAX
};

struct runtime_stat {
	struct rblist value_list;
};

typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config,
			     struct perf_cpu_map *m, int cpu);

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;
	bool			 ru_display;
	bool			 big_num;
	bool			 no_merge;
	bool			 walltime_run_table;
	bool			 all_kernel;
	bool			 all_user;
	bool			 percore_show_thread;
	bool			 summary;
	bool			 metric_no_group;
	bool			 metric_no_merge;
	bool			 stop_read_counter;
	bool			 quiet;
	FILE			*output;
	unsigned int		 interval;
	unsigned int		 timeout;
	int			 initial_delay;
	unsigned int		 unit_width;
	unsigned int		 metric_only_len;
	int			 times;
	int			 run_count;
	int			 print_free_counters_hint;
	int			 print_mixed_hw_group_error;
	struct runtime_stat	*stats;
	int			 stats_num;
	const char		*csv_sep;
	struct stats		*walltime_nsecs_stats;
	struct rusage		 ru_data;
	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;
};

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

struct evsel;
struct evlist;

struct perf_aggr_thread_value {
	struct evsel *counter;
	struct aggr_cpu_id id;
	double uval;
	u64 val;
	u64 run;
	u64 ena;
};

bool __perf_stat_evsel__is(struct evsel *evsel, enum perf_stat_evsel_id id);

#define perf_stat_evsel__is(evsel, id) \
	__perf_stat_evsel__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 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 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 evlist *);

int evlist__alloc_stats(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 perf_stat_process_counter(struct perf_stat_config *config,
			      struct evsel *counter);
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);
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 cpu, struct runtime_stat *st);
#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"
0007ecea	11
b251892d ACM	12	struct perf_cpu_map;
b251892d ACM	13	struct perf_stat_config;
38b7b678 ACM	14	struct timespec;
38b7b678 ACM	15
e55c14af	16	struct stats {
0007ecea	17	double n, mean, M2;
ffe4f3c0	18	u64 max, min;
0007ecea XG	19	};
0007ecea XG	20
e2f56da1 JO	21	enum perf_stat_evsel_id {
e2f56da1 JO	22	PERF_STAT_EVSEL_ID__NONE = 0,
4c358d5c JO	23	PERF_STAT_EVSEL_ID__CYCLES_IN_TX,
	24	PERF_STAT_EVSEL_ID__TRANSACTION_START,
	25	PERF_STAT_EVSEL_ID__ELISION_START,
	26	PERF_STAT_EVSEL_ID__CYCLES_IN_TX_CP,
239bd47f AK	27	PERF_STAT_EVSEL_ID__TOPDOWN_TOTAL_SLOTS,
	28	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_ISSUED,
	29	PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_RETIRED,
	30	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_BUBBLES,
	31	PERF_STAT_EVSEL_ID__TOPDOWN_RECOVERY_BUBBLES,
55c36a9f AK	32	PERF_STAT_EVSEL_ID__TOPDOWN_RETIRING,
	33	PERF_STAT_EVSEL_ID__TOPDOWN_BAD_SPEC,
	34	PERF_STAT_EVSEL_ID__TOPDOWN_FE_BOUND,
	35	PERF_STAT_EVSEL_ID__TOPDOWN_BE_BOUND,
63e39aa6 KL	36	PERF_STAT_EVSEL_ID__TOPDOWN_HEAVY_OPS,
	37	PERF_STAT_EVSEL_ID__TOPDOWN_BR_MISPREDICT,
	38	PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_LAT,
	39	PERF_STAT_EVSEL_ID__TOPDOWN_MEM_BOUND,
daefd0bc KL	40	PERF_STAT_EVSEL_ID__SMI_NUM,
daefd0bc KL	41	PERF_STAT_EVSEL_ID__APERF,
e2f56da1 JO	42	PERF_STAT_EVSEL_ID__MAX,
	43	};
	44
581cc8a2	45	struct perf_stat_evsel {
f7794d52 JO	46	struct stats res_stats[3];
	47	enum perf_stat_evsel_id id;
	48	u64 *group_data;
e2f56da1 JO	49	};
e2f56da1 JO	50
f87027b9 JO	51	enum aggr_mode {
	52	AGGR_NONE,
	53	AGGR_GLOBAL,
	54	AGGR_SOCKET,
db5742b6	55	AGGR_DIE,
f87027b9	56	AGGR_CORE,
32b8af82	57	AGGR_THREAD,
208df99e	58	AGGR_UNSET,
86895b48	59	AGGR_NODE,
f87027b9 JO	60	};
f87027b9 JO	61
e5fcc2ab JY	62	enum {
	63	CTX_BIT_USER = 1 << 0,
	64	CTX_BIT_KERNEL = 1 << 1,
	65	CTX_BIT_HV = 1 << 2,
	66	CTX_BIT_HOST = 1 << 3,
	67	CTX_BIT_IDLE = 1 << 4,
	68	CTX_BIT_MAX = 1 << 5,
	69	};
	70
	71	#define NUM_CTX CTX_BIT_MAX
	72
	73	enum stat_type {
	74	STAT_NONE = 0,
	75	STAT_NSECS,
	76	STAT_CYCLES,
	77	STAT_STALLED_CYCLES_FRONT,
	78	STAT_STALLED_CYCLES_BACK,
	79	STAT_BRANCHES,
	80	STAT_CACHEREFS,
	81	STAT_L1_DCACHE,
	82	STAT_L1_ICACHE,
	83	STAT_LL_CACHE,
	84	STAT_ITLB_CACHE,
	85	STAT_DTLB_CACHE,
	86	STAT_CYCLES_IN_TX,
	87	STAT_TRANSACTION,
	88	STAT_ELISION,
	89	STAT_TOPDOWN_TOTAL_SLOTS,
	90	STAT_TOPDOWN_SLOTS_ISSUED,
	91	STAT_TOPDOWN_SLOTS_RETIRED,
	92	STAT_TOPDOWN_FETCH_BUBBLES,
	93	STAT_TOPDOWN_RECOVERY_BUBBLES,
55c36a9f AK	94	STAT_TOPDOWN_RETIRING,
	95	STAT_TOPDOWN_BAD_SPEC,
	96	STAT_TOPDOWN_FE_BOUND,
	97	STAT_TOPDOWN_BE_BOUND,
63e39aa6 KL	98	STAT_TOPDOWN_HEAVY_OPS,
	99	STAT_TOPDOWN_BR_MISPREDICT,
	100	STAT_TOPDOWN_FETCH_LAT,
	101	STAT_TOPDOWN_MEM_BOUND,
e5fcc2ab JY	102	STAT_SMI_NUM,
	103	STAT_APERF,
	104	STAT_MAX
	105	};
	106
	107	struct runtime_stat {
	108	struct rblist value_list;
	109	};
	110
2760f5a1	111	typedef struct aggr_cpu_id (aggr_get_id_t)(struct perf_stat_config config,
f854839b	112	struct perf_cpu_map *m, int cpu);
6f6b6594	113
421a50f3	114	struct perf_stat_config {
728c0ee0 JO	115	enum aggr_mode aggr_mode;
728c0ee0 JO	116	bool scale;
5698f26b	117	bool no_inherit;
7d9ad16a	118	bool identifier;
fa7070a3	119	bool csv_output;
132c6ba3	120	bool interval_clear;
0ce5aa02	121	bool metric_only;
aea0dca1	122	bool null_run;
8897a891	123	bool ru_display;
34ff0866	124	bool big_num;
fdee335b	125	bool no_merge;
54ac0b1b	126	bool walltime_run_table;
dd071024 JY	127	bool all_kernel;
dd071024 JY	128	bool all_user;
1af62ce6	129	bool percore_show_thread;
c7e5b328	130	bool summary;
05530a79 IR	131	bool metric_no_group;
05530a79 IR	132	bool metric_no_merge;
ee6a9614	133	bool stop_read_counter;
55a4de94	134	bool quiet;
728c0ee0 JO	135	FILE *output;
	136	unsigned int interval;
	137	unsigned int timeout;
2162b9c6	138	int initial_delay;
df4f7b4d	139	unsigned int unit_width;
ee1760e2	140	unsigned int metric_only_len;
728c0ee0	141	int times;
d97ae04b	142	int run_count;
31084123	143	int print_free_counters_hint;
3b3cd9a4	144	int print_mixed_hw_group_error;
728c0ee0 JO	145	struct runtime_stat *stats;
728c0ee0 JO	146	int stats_num;
fa7070a3	147	const char *csv_sep;
26893a60	148	struct stats *walltime_nsecs_stats;
8897a891	149	struct rusage ru_data;
d526e1a0	150	struct cpu_aggr_map *aggr_map;
6f6b6594	151	aggr_get_id_t aggr_get_id;
d526e1a0	152	struct cpu_aggr_map *cpus_aggr_map;
54ac0b1b	153	u64 *walltime_run;
d0192fdb	154	struct rblist metric_events;
27e9769a AB	155	int ctl_fd;
27e9769a AB	156	int ctl_fd_ack;
a8fcbd26	157	bool ctl_fd_close;
d1c5a0e8	158	const char *cgroup_list;
63e39aa6	159	unsigned int topdown_level;
421a50f3 JO	160	};
421a50f3 JO	161
d778a778 PC	162	void perf_stat__set_big_num(int set);
d778a778 PC	163
0007ecea XG	164	void update_stats(struct stats *stats, u64 val);
	165	double avg_stats(struct stats *stats);
	166	double stddev_stats(struct stats *stats);
	167	double rel_stddev_stats(double stddev, double avg);
	168
ffe4f3c0 DA	169	static inline void init_stats(struct stats *stats)
	170	{
	171	stats->n = 0.0;
	172	stats->mean = 0.0;
	173	stats->M2 = 0.0;
	174	stats->min = (u64) -1;
	175	stats->max = 0;
	176	}
e2f56da1	177
32dcd021	178	struct evsel;
63503dba	179	struct evlist;
24e34f68	180
29734550	181	struct perf_aggr_thread_value {
32dcd021	182	struct evsel *counter;
2760f5a1	183	struct aggr_cpu_id id;
29734550 JY	184	double uval;
	185	u64 val;
	186	u64 run;
	187	u64 ena;
	188	};
	189
90520341	190	bool __perf_stat_evsel__is(struct evsel *evsel, enum perf_stat_evsel_id id);
e2f56da1 JO	191
e2f56da1 JO	192	#define perf_stat_evsel__is(evsel, id) \
90520341	193	__perf_stat_evsel__is(evsel, PERF_STAT_EVSEL_ID__ ## id)
e2f56da1	194
8efb2df1	195	extern struct runtime_stat rt_stat;
f87027b9 JO	196	extern struct stats walltime_nsecs_stats;
f87027b9 JO	197
6ca9a082 JO	198	typedef void (print_metric_t)(struct perf_stat_config config,
6ca9a082 JO	199	void ctx, const char color, const char *unit,
140aeadc	200	const char *fmt, double val);
6ca9a082	201	typedef void (new_line_t)(struct perf_stat_config config, void *ctx);
140aeadc	202
8efb2df1 JY	203	void runtime_stat__init(struct runtime_stat *st);
8efb2df1 JY	204	void runtime_stat__exit(struct runtime_stat *st);
fb4605ba	205	void perf_stat__init_shadow_stats(void);
f87027b9	206	void perf_stat__reset_shadow_stats(void);
6a1e2c5c	207	void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
32dcd021	208	void perf_stat__update_shadow_stats(struct evsel *counter, u64 count,
1fcd0394	209	int cpu, struct runtime_stat *st);
140aeadc AK	210	struct perf_stat_output_ctx {
	211	void *ctx;
	212	print_metric_t print_metric;
	213	new_line_t new_line;
37932c18	214	bool force_header;
140aeadc AK	215	};
140aeadc AK	216
6ca9a082	217	void perf_stat__print_shadow_stats(struct perf_stat_config *config,
32dcd021	218	struct evsel *evsel,
140aeadc	219	double avg, int cpu,
b18f3e36	220	struct perf_stat_output_ctx *out,
e0128b30 JY	221	struct rblist *metric_events,
e0128b30 JY	222	struct runtime_stat *st);
63503dba	223	void perf_stat__collect_metric_expr(struct evlist *);
f87027b9	224
53f5e908 ACM	225	int evlist__alloc_stats(struct evlist *evlist, bool alloc_raw);
	226	void evlist__free_stats(struct evlist *evlist);
	227	void evlist__reset_stats(struct evlist *evlist);
	228	void evlist__reset_prev_raw_counts(struct evlist *evlist);
	229	void evlist__copy_prev_raw_counts(struct evlist *evlist);
	230	void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
f80010eb JO	231
f80010eb JO	232	int perf_stat_process_counter(struct perf_stat_config *config,
32dcd021	233	struct evsel *counter);
0ea0e355 JO	234	struct perf_tool;
	235	union perf_event;
	236	struct perf_session;
aeb00b1a ACM	237	struct target;
aeb00b1a ACM	238
89f1688a JO	239	int perf_event__process_stat_event(struct perf_session *session,
89f1688a JO	240	union perf_event *event);
e08a4564 JO	241
	242	size_t perf_event__fprintf_stat(union perf_event event, FILE fp);
	243	size_t perf_event__fprintf_stat_round(union perf_event event, FILE fp);
	244	size_t perf_event__fprintf_stat_config(union perf_event event, FILE fp);
d09cefd2	245
32dcd021	246	int create_perf_stat_counter(struct evsel *evsel,
d09cefd2	247	struct perf_stat_config *config,
4804e011 AK	248	struct target *target,
4804e011 AK	249	int cpu);
71273724 ACM	250	void evlist__print_counters(struct evlist evlist, struct perf_stat_config config,
71273724 ACM	251	struct target _target, struct timespec ts, int argc, const char **argv);
6d432c4c JO	252
	253	struct metric_expr;
	254	double test_generic_metric(struct metric_expr mexp, int cpu, struct runtime_stat st);
0007ecea	255	#endif