[mirror_ubuntu-jammy-kernel.git] / tools / perf / util / evsel.h

#ifndef __PERF_EVSEL_H
#define __PERF_EVSEL_H 1

#include <linux/list.h>
#include <stdbool.h>
#include <stddef.h>
#include <linux/perf_event.h>
#include "types.h"
#include "xyarray.h"
#include "cgroup.h"
#include "hist.h"
 
struct perf_counts_values {
	union {
		struct {
			u64 val;
			u64 ena;
			u64 run;
		};
		u64 values[3];
	};
};

struct perf_counts {
	s8		   	  scaled;
	struct perf_counts_values aggr;
	struct perf_counts_values cpu[];
};

struct perf_evsel;

/*
 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
 * more than one entry in the evlist.
 */
struct perf_sample_id {
	struct hlist_node 	node;
	u64		 	id;
	struct perf_evsel	*evsel;
};

/** struct perf_evsel - event selector
 *
 * @name - Can be set to retain the original event name passed by the user,
 *         so that when showing results in tools such as 'perf stat', we
 *         show the name used, not some alias.
 */
struct perf_evsel {
	struct list_head	node;
	struct perf_event_attr	attr;
	char			*filter;
	struct xyarray		*fd;
	struct xyarray		*sample_id;
	u64			*id;
	struct perf_counts	*counts;
	int			idx;
	u32			ids;
	struct hists		hists;
	char			*name;
	struct event_format	*tp_format;
	union {
		void		*priv;
		off_t		id_offset;
	};
	struct cgroup_sel	*cgrp;
	struct {
		void		*func;
		void		*data;
	} handler;
	struct cpu_map		*cpus;
	unsigned int		sample_size;
	bool 			supported;
	bool 			needs_swap;
	/* parse modifier helper */
	int			exclude_GH;
	struct perf_evsel	*leader;
	char			*group_name;
};

struct cpu_map;
struct thread_map;
struct perf_evlist;
struct perf_record_opts;

struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name, int idx);

struct event_format *event_format__new(const char *sys, const char *name);

void perf_evsel__init(struct perf_evsel *evsel,
		      struct perf_event_attr *attr, int idx);
void perf_evsel__exit(struct perf_evsel *evsel);
void perf_evsel__delete(struct perf_evsel *evsel);

void perf_evsel__config(struct perf_evsel *evsel,
			struct perf_record_opts *opts);

bool perf_evsel__is_cache_op_valid(u8 type, u8 op);

#define PERF_EVSEL__MAX_ALIASES 8

extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
				       [PERF_EVSEL__MAX_ALIASES];
extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
					  [PERF_EVSEL__MAX_ALIASES];
extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
					      [PERF_EVSEL__MAX_ALIASES];
extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
					    char *bf, size_t size);
const char *perf_evsel__name(struct perf_evsel *evsel);

int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
void perf_evsel__free_fd(struct perf_evsel *evsel);
void perf_evsel__free_id(struct perf_evsel *evsel);
void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);

int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
			   const char *filter);

int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
			     struct cpu_map *cpus);
int perf_evsel__open_per_thread(struct perf_evsel *evsel,
				struct thread_map *threads);
int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
		     struct thread_map *threads);
void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);

struct perf_sample;

void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
			 const char *name);
u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
		       const char *name);

static inline char *perf_evsel__strval(struct perf_evsel *evsel,
				       struct perf_sample *sample,
				       const char *name)
{
	return perf_evsel__rawptr(evsel, sample, name);
}

struct format_field;

struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);

#define perf_evsel__match(evsel, t, c)		\
	(evsel->attr.type == PERF_TYPE_##t &&	\
	 evsel->attr.config == PERF_COUNT_##c)

static inline bool perf_evsel__match2(struct perf_evsel *e1,
				      struct perf_evsel *e2)
{
	return (e1->attr.type == e2->attr.type) &&
	       (e1->attr.config == e2->attr.config);
}

int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
			      int cpu, int thread, bool scale);

/**
 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
 *
 * @evsel - event selector to read value
 * @cpu - CPU of interest
 * @thread - thread of interest
 */
static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
					  int cpu, int thread)
{
	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
}

/**
 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 *
 * @evsel - event selector to read value
 * @cpu - CPU of interest
 * @thread - thread of interest
 */
static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
						 int cpu, int thread)
{
	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
}

int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
		       bool scale);

/**
 * perf_evsel__read - Read the aggregate results on all CPUs
 *
 * @evsel - event selector to read value
 * @ncpus - Number of cpus affected, from zero
 * @nthreads - Number of threads affected, from zero
 */
static inline int perf_evsel__read(struct perf_evsel *evsel,
				    int ncpus, int nthreads)
{
	return __perf_evsel__read(evsel, ncpus, nthreads, false);
}

/**
 * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
 *
 * @evsel - event selector to read value
 * @ncpus - Number of cpus affected, from zero
 * @nthreads - Number of threads affected, from zero
 */
static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
					  int ncpus, int nthreads)
{
	return __perf_evsel__read(evsel, ncpus, nthreads, true);
}

void hists__init(struct hists *hists);

int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
			     struct perf_sample *sample);

static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
{
	return list_entry(evsel->node.next, struct perf_evsel, node);
}

static inline bool perf_evsel__is_group_member(const struct perf_evsel *evsel)
{
	return evsel->leader != NULL;
}
#endif /* __PERF_EVSEL_H */
Commit	Line	Data
69aad6f1 ACM	1	#ifndef __PERF_EVSEL_H
	2	#define __PERF_EVSEL_H 1
	3
	4	#include <linux/list.h>
c52b12ed	5	#include <stdbool.h>
07ac002f	6	#include <stddef.h>
d2709c7c	7	#include <linux/perf_event.h>
69aad6f1 ACM	8	#include "types.h"
69aad6f1 ACM	9	#include "xyarray.h"
023695d9	10	#include "cgroup.h"
e248de33	11	#include "hist.h"
c52b12ed ACM	12
	13	struct perf_counts_values {
	14	union {
	15	struct {
	16	u64 val;
	17	u64 ena;
	18	u64 run;
	19	};
	20	u64 values[3];
	21	};
	22	};
	23
	24	struct perf_counts {
	25	s8 scaled;
	26	struct perf_counts_values aggr;
	27	struct perf_counts_values cpu[];
	28	};
69aad6f1	29
70db7533 ACM	30	struct perf_evsel;
	31
	32	/*
	33	* Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
	34	* more than one entry in the evlist.
	35	*/
	36	struct perf_sample_id {
	37	struct hlist_node node;
	38	u64 id;
	39	struct perf_evsel *evsel;
	40	};
	41
f0c55bcf SE	42	/** struct perf_evsel - event selector
	43	*
	44	* @name - Can be set to retain the original event name passed by the user,
	45	* so that when showing results in tools such as 'perf stat', we
	46	* show the name used, not some alias.
	47	*/
69aad6f1 ACM	48	struct perf_evsel {
	49	struct list_head node;
	50	struct perf_event_attr attr;
	51	char *filter;
	52	struct xyarray *fd;
a91e5431 ACM	53	struct xyarray *sample_id;
a91e5431 ACM	54	u64 *id;
c52b12ed	55	struct perf_counts *counts;
69aad6f1	56	int idx;
f4d83436	57	u32 ids;
e248de33	58	struct hists hists;
f0c55bcf	59	char *name;
fcf65bf1	60	struct event_format *tp_format;
a91e5431 ACM	61	union {
	62	void *priv;
	63	off_t id_offset;
	64	};
023695d9	65	struct cgroup_sel *cgrp;
ee29be62 ACM	66	struct {
	67	void *func;
	68	void *data;
	69	} handler;
7ae92e74	70	struct cpu_map *cpus;
bde09467	71	unsigned int sample_size;
2cee77c4	72	bool supported;
0807d2d8	73	bool needs_swap;
f5b1135b JO	74	/* parse modifier helper */
f5b1135b JO	75	int exclude_GH;
6a4bb04c JO	76	struct perf_evsel *leader;
6a4bb04c JO	77	char *group_name;
69aad6f1 ACM	78	};
69aad6f1 ACM	79
86bd5e86 ACM	80	struct cpu_map;
86bd5e86 ACM	81	struct thread_map;
70082dd9	82	struct perf_evlist;
0f82ebc4	83	struct perf_record_opts;
86bd5e86	84
23a2f3ab	85	struct perf_evsel perf_evsel__new(struct perf_event_attr attr, int idx);
efd2b924	86	struct perf_evsel perf_evsel__newtp(const char sys, const char *name, int idx);
201b7334 ACM	87
	88	struct event_format event_format__new(const char sys, const char *name);
	89
ef1d1af2 ACM	90	void perf_evsel__init(struct perf_evsel *evsel,
	91	struct perf_event_attr *attr, int idx);
	92	void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1 ACM	93	void perf_evsel__delete(struct perf_evsel *evsel);
69aad6f1 ACM	94
0f82ebc4	95	void perf_evsel__config(struct perf_evsel *evsel,
cac21425	96	struct perf_record_opts *opts);
0f82ebc4	97
0b668bc9 ACM	98	bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
	99
	100	#define PERF_EVSEL__MAX_ALIASES 8
	101
	102	extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
	103	[PERF_EVSEL__MAX_ALIASES];
	104	extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
	105	[PERF_EVSEL__MAX_ALIASES];
8ad7013b ACM	106	extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
	107	[PERF_EVSEL__MAX_ALIASES];
	108	extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
	109	extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9 ACM	110	int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
0b668bc9 ACM	111	char *bf, size_t size);
7289f83c	112	const char perf_evsel__name(struct perf_evsel evsel);
c410431c	113
69aad6f1	114	int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
70db7533	115	int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed	116	int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
69aad6f1	117	void perf_evsel__free_fd(struct perf_evsel *evsel);
70db7533	118	void perf_evsel__free_id(struct perf_evsel *evsel);
c52b12ed	119	void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1	120
745cefc5 ACM	121	int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
	122	const char *filter);
	123
f08199d3	124	int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c	125	struct cpu_map *cpus);
f08199d3	126	int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c	127	struct thread_map *threads);
f08199d3	128	int perf_evsel__open(struct perf_evsel evsel, struct cpu_map cpus,
6a4bb04c	129	struct thread_map *threads);
727ab04e	130	void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609	131
5555ded4 ACM	132	struct perf_sample;
5555ded4 ACM	133
5d2074ea	134	void perf_evsel__rawptr(struct perf_evsel evsel, struct perf_sample *sample,
5555ded4 ACM	135	const char *name);
	136	u64 perf_evsel__intval(struct perf_evsel evsel, struct perf_sample sample,
	137	const char *name);
	138
5d2074ea ACM	139	static inline char perf_evsel__strval(struct perf_evsel evsel,
	140	struct perf_sample *sample,
	141	const char *name)
	142	{
	143	return perf_evsel__rawptr(evsel, sample, name);
	144	}
	145
efd2b924 ACM	146	struct format_field;
	147
	148	struct format_field perf_evsel__field(struct perf_evsel evsel, const char *name);
	149
daec78a0 ACM	150	#define perf_evsel__match(evsel, t, c) \
	151	(evsel->attr.type == PERF_TYPE_##t && \
	152	evsel->attr.config == PERF_COUNT_##c)
	153
863e451f JO	154	static inline bool perf_evsel__match2(struct perf_evsel *e1,
	155	struct perf_evsel *e2)
	156	{
	157	return (e1->attr.type == e2->attr.type) &&
	158	(e1->attr.config == e2->attr.config);
	159	}
	160
c52b12ed ACM	161	int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	162	int cpu, int thread, bool scale);
	163
	164	/**
	165	* perf_evsel__read_on_cpu - Read out the results on a CPU and thread
	166	*
	167	* @evsel - event selector to read value
	168	* @cpu - CPU of interest
	169	* @thread - thread of interest
	170	*/
	171	static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	172	int cpu, int thread)
	173	{
	174	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
	175	}
	176
	177	/**
	178	* perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
	179	*
	180	* @evsel - event selector to read value
	181	* @cpu - CPU of interest
	182	* @thread - thread of interest
	183	*/
	184	static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
	185	int cpu, int thread)
	186	{
	187	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
	188	}
	189
	190	int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
	191	bool scale);
	192
	193	/**
	194	* perf_evsel__read - Read the aggregate results on all CPUs
	195	*
	196	* @evsel - event selector to read value
	197	* @ncpus - Number of cpus affected, from zero
	198	* @nthreads - Number of threads affected, from zero
	199	*/
	200	static inline int perf_evsel__read(struct perf_evsel *evsel,
	201	int ncpus, int nthreads)
	202	{
	203	return __perf_evsel__read(evsel, ncpus, nthreads, false);
	204	}
	205
	206	/**
	207	* perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
	208	*
	209	* @evsel - event selector to read value
	210	* @ncpus - Number of cpus affected, from zero
	211	* @nthreads - Number of threads affected, from zero
	212	*/
	213	static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
	214	int ncpus, int nthreads)
	215	{
	216	return __perf_evsel__read(evsel, ncpus, nthreads, true);
	217	}
	218
4bf9ce1b JO	219	void hists__init(struct hists *hists);
4bf9ce1b JO	220
a3f698fe	221	int perf_evsel__parse_sample(struct perf_evsel evsel, union perf_event event,
0807d2d8	222	struct perf_sample *sample);
0c21f736 ACM	223
	224	static inline struct perf_evsel perf_evsel__next(struct perf_evsel evsel)
	225	{
	226	return list_entry(evsel->node.next, struct perf_evsel, node);
	227	}
07ac002f ACM	228
	229	static inline bool perf_evsel__is_group_member(const struct perf_evsel *evsel)
	230	{
	231	return evsel->leader != NULL;
	232	}
69aad6f1	233	#endif /* __PERF_EVSEL_H */