[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 "../../../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;
	unsigned int		sample_size;
	bool 			supported;
	/* 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);
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,
			struct perf_evsel *first);

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__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);

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

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, bool swapped);

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