[deliverable/linux.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;
	struct perf_counts	*prev_raw_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__free_counts(struct perf_evsel *evsel);
void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);

void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
				  enum perf_event_sample_format bit);
void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
				    enum perf_event_sample_format bit);

#define perf_evsel__set_sample_bit(evsel, bit) \
	__perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)

#define perf_evsel__reset_sample_bit(evsel, bit) \
	__perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)

void perf_evsel__set_sample_id(struct perf_evsel *evsel);

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_leader(const struct perf_evsel *evsel)
{
	return evsel->leader == evsel;
}

struct perf_attr_details {
	bool freq;
	bool verbose;
};

int perf_evsel__fprintf(struct perf_evsel *evsel,
			struct perf_attr_details *details, FILE *fp);

bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
			  char *msg, size_t msgsize);
int perf_evsel__open_strerror(struct perf_evsel *evsel,
			      struct perf_target *target,
			      int err, char *msg, size_t size);
#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;
c7a79c47	56	struct perf_counts *prev_raw_counts;
69aad6f1	57	int idx;
f4d83436	58	u32 ids;
e248de33	59	struct hists hists;
f0c55bcf	60	char *name;
fcf65bf1	61	struct event_format *tp_format;
a91e5431 ACM	62	union {
	63	void *priv;
	64	off_t id_offset;
	65	};
023695d9	66	struct cgroup_sel *cgrp;
ee29be62 ACM	67	struct {
	68	void *func;
	69	void *data;
	70	} handler;
7ae92e74	71	struct cpu_map *cpus;
bde09467	72	unsigned int sample_size;
2cee77c4	73	bool supported;
0807d2d8	74	bool needs_swap;
f5b1135b JO	75	/* parse modifier helper */
f5b1135b JO	76	int exclude_GH;
6a4bb04c JO	77	struct perf_evsel *leader;
6a4bb04c JO	78	char *group_name;
69aad6f1 ACM	79	};
69aad6f1 ACM	80
86bd5e86 ACM	81	struct cpu_map;
86bd5e86 ACM	82	struct thread_map;
70082dd9	83	struct perf_evlist;
0f82ebc4	84	struct perf_record_opts;
86bd5e86	85
23a2f3ab	86	struct perf_evsel perf_evsel__new(struct perf_event_attr attr, int idx);
efd2b924	87	struct perf_evsel perf_evsel__newtp(const char sys, const char *name, int idx);
201b7334 ACM	88
	89	struct event_format event_format__new(const char sys, const char *name);
	90
ef1d1af2 ACM	91	void perf_evsel__init(struct perf_evsel *evsel,
	92	struct perf_event_attr *attr, int idx);
	93	void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1 ACM	94	void perf_evsel__delete(struct perf_evsel *evsel);
69aad6f1 ACM	95
0f82ebc4	96	void perf_evsel__config(struct perf_evsel *evsel,
cac21425	97	struct perf_record_opts *opts);
0f82ebc4	98
0b668bc9 ACM	99	bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
	100
	101	#define PERF_EVSEL__MAX_ALIASES 8
	102
	103	extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
	104	[PERF_EVSEL__MAX_ALIASES];
	105	extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
	106	[PERF_EVSEL__MAX_ALIASES];
8ad7013b ACM	107	extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
	108	[PERF_EVSEL__MAX_ALIASES];
	109	extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
	110	extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9 ACM	111	int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
0b668bc9 ACM	112	char *bf, size_t size);
7289f83c	113	const char perf_evsel__name(struct perf_evsel evsel);
c410431c	114
69aad6f1	115	int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
70db7533	116	int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed	117	int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
69aad6f1	118	void perf_evsel__free_fd(struct perf_evsel *evsel);
70db7533	119	void perf_evsel__free_id(struct perf_evsel *evsel);
43f8e76e	120	void perf_evsel__free_counts(struct perf_evsel *evsel);
c52b12ed	121	void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1	122
7be5ebe8 ACM	123	void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
	124	enum perf_event_sample_format bit);
	125	void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
	126	enum perf_event_sample_format bit);
	127
	128	#define perf_evsel__set_sample_bit(evsel, bit) \
	129	__perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
	130
	131	#define perf_evsel__reset_sample_bit(evsel, bit) \
	132	__perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
	133
7a5a5ca5 ACM	134	void perf_evsel__set_sample_id(struct perf_evsel *evsel);
7a5a5ca5 ACM	135
745cefc5 ACM	136	int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
	137	const char *filter);
	138
f08199d3	139	int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c	140	struct cpu_map *cpus);
f08199d3	141	int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c	142	struct thread_map *threads);
f08199d3	143	int perf_evsel__open(struct perf_evsel evsel, struct cpu_map cpus,
6a4bb04c	144	struct thread_map *threads);
727ab04e	145	void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609	146
5555ded4 ACM	147	struct perf_sample;
5555ded4 ACM	148
5d2074ea	149	void perf_evsel__rawptr(struct perf_evsel evsel, struct perf_sample *sample,
5555ded4 ACM	150	const char *name);
	151	u64 perf_evsel__intval(struct perf_evsel evsel, struct perf_sample sample,
	152	const char *name);
	153
5d2074ea ACM	154	static inline char perf_evsel__strval(struct perf_evsel evsel,
	155	struct perf_sample *sample,
	156	const char *name)
	157	{
	158	return perf_evsel__rawptr(evsel, sample, name);
	159	}
	160
efd2b924 ACM	161	struct format_field;
	162
	163	struct format_field perf_evsel__field(struct perf_evsel evsel, const char *name);
	164
daec78a0 ACM	165	#define perf_evsel__match(evsel, t, c) \
	166	(evsel->attr.type == PERF_TYPE_##t && \
	167	evsel->attr.config == PERF_COUNT_##c)
	168
863e451f JO	169	static inline bool perf_evsel__match2(struct perf_evsel *e1,
	170	struct perf_evsel *e2)
	171	{
	172	return (e1->attr.type == e2->attr.type) &&
	173	(e1->attr.config == e2->attr.config);
	174	}
	175
c52b12ed ACM	176	int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	177	int cpu, int thread, bool scale);
	178
	179	/**
	180	* perf_evsel__read_on_cpu - Read out the results on a CPU and thread
	181	*
	182	* @evsel - event selector to read value
	183	* @cpu - CPU of interest
	184	* @thread - thread of interest
	185	*/
	186	static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	187	int cpu, int thread)
	188	{
	189	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
	190	}
	191
	192	/**
	193	* perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
	194	*
	195	* @evsel - event selector to read value
	196	* @cpu - CPU of interest
	197	* @thread - thread of interest
	198	*/
	199	static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
	200	int cpu, int thread)
	201	{
	202	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
	203	}
	204
	205	int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
	206	bool scale);
	207
	208	/**
	209	* perf_evsel__read - Read the aggregate results on all CPUs
	210	*
	211	* @evsel - event selector to read value
	212	* @ncpus - Number of cpus affected, from zero
	213	* @nthreads - Number of threads affected, from zero
	214	*/
	215	static inline int perf_evsel__read(struct perf_evsel *evsel,
	216	int ncpus, int nthreads)
	217	{
	218	return __perf_evsel__read(evsel, ncpus, nthreads, false);
	219	}
	220
	221	/**
	222	* perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
	223	*
	224	* @evsel - event selector to read value
	225	* @ncpus - Number of cpus affected, from zero
	226	* @nthreads - Number of threads affected, from zero
	227	*/
	228	static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
	229	int ncpus, int nthreads)
	230	{
	231	return __perf_evsel__read(evsel, ncpus, nthreads, true);
	232	}
	233
4bf9ce1b JO	234	void hists__init(struct hists *hists);
4bf9ce1b JO	235
a3f698fe	236	int perf_evsel__parse_sample(struct perf_evsel evsel, union perf_event event,
0807d2d8	237	struct perf_sample *sample);
0c21f736 ACM	238
	239	static inline struct perf_evsel perf_evsel__next(struct perf_evsel evsel)
	240	{
	241	return list_entry(evsel->node.next, struct perf_evsel, node);
	242	}
07ac002f	243
823254ed	244	static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f	245	{
823254ed	246	return evsel->leader == evsel;
07ac002f	247	}
0698aedd ACM	248
	249	struct perf_attr_details {
	250	bool freq;
	251	bool verbose;
	252	};
	253
	254	int perf_evsel__fprintf(struct perf_evsel *evsel,
	255	struct perf_attr_details details, FILE fp);
c0a54341 ACM	256
	257	bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
	258	char *msg, size_t msgsize);
56e52e85 ACM	259	int perf_evsel__open_strerror(struct perf_evsel *evsel,
	260	struct perf_target *target,
	261	int err, char *msg, size_t size);
69aad6f1	262	#endif /* __PERF_EVSEL_H */