[mirror_ubuntu-artful-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"
#include "symbol.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;

	/* Holds total ID period value for PERF_SAMPLE_READ processing. */
	u64			period;
};

/** 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;
	int			nr_members;
	struct perf_evsel	*leader;
	char			*group_name;
};

#define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)

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);
const char *perf_evsel__group_name(struct perf_evsel *evsel);
int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);

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

/**
 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
 *
 * @evsel - evsel selector to be tested
 *
 * Return %true if @evsel is a group leader or a stand-alone event
 */
static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
{
	return evsel->leader == evsel;
}

/**
 * perf_evsel__is_group_event - Return whether given evsel is a group event
 *
 * @evsel - evsel selector to be tested
 *
 * Return %true iff event group view is enabled and @evsel is a actual group
 * leader which has other members in the group
 */
static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
{
	if (!symbol_conf.event_group)
		return false;

	return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
}

struct perf_attr_details {
	bool freq;
	bool verbose;
	bool event_group;
};

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

static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
{
	return evsel->idx - evsel->leader->idx;
}

#define for_each_group_member(_evsel, _leader) 					\
for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); 	\
     (_evsel) && (_evsel)->leader == (_leader);					\
     (_evsel) = 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>
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"
759ff497	12	#include "symbol.h"
c52b12ed ACM	13
	14	struct perf_counts_values {
	15	union {
	16	struct {
	17	u64 val;
	18	u64 ena;
	19	u64 run;
	20	};
	21	u64 values[3];
	22	};
	23	};
	24
	25	struct perf_counts {
	26	s8 scaled;
	27	struct perf_counts_values aggr;
	28	struct perf_counts_values cpu[];
	29	};
69aad6f1	30
70db7533 ACM	31	struct perf_evsel;
	32
	33	/*
	34	* Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
	35	* more than one entry in the evlist.
	36	*/
	37	struct perf_sample_id {
	38	struct hlist_node node;
	39	u64 id;
	40	struct perf_evsel *evsel;
e4caec0d JO	41
	42	/* Holds total ID period value for PERF_SAMPLE_READ processing. */
	43	u64 period;
70db7533 ACM	44	};
70db7533 ACM	45
f0c55bcf SE	46	/** struct perf_evsel - event selector
	47	*
	48	* @name - Can be set to retain the original event name passed by the user,
	49	* so that when showing results in tools such as 'perf stat', we
	50	* show the name used, not some alias.
	51	*/
69aad6f1 ACM	52	struct perf_evsel {
	53	struct list_head node;
	54	struct perf_event_attr attr;
	55	char *filter;
	56	struct xyarray *fd;
a91e5431 ACM	57	struct xyarray *sample_id;
a91e5431 ACM	58	u64 *id;
c52b12ed	59	struct perf_counts *counts;
c7a79c47	60	struct perf_counts *prev_raw_counts;
69aad6f1	61	int idx;
f4d83436	62	u32 ids;
e248de33	63	struct hists hists;
f0c55bcf	64	char *name;
fcf65bf1	65	struct event_format *tp_format;
a91e5431 ACM	66	union {
	67	void *priv;
	68	off_t id_offset;
	69	};
023695d9	70	struct cgroup_sel *cgrp;
ee29be62 ACM	71	struct {
	72	void *func;
	73	void *data;
	74	} handler;
7ae92e74	75	struct cpu_map *cpus;
bde09467	76	unsigned int sample_size;
2cee77c4	77	bool supported;
0807d2d8	78	bool needs_swap;
f5b1135b JO	79	/* parse modifier helper */
f5b1135b JO	80	int exclude_GH;
97f63e4a	81	int nr_members;
6a4bb04c JO	82	struct perf_evsel *leader;
6a4bb04c JO	83	char *group_name;
69aad6f1 ACM	84	};
69aad6f1 ACM	85
29d720ed NK	86	#define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
29d720ed NK	87
86bd5e86 ACM	88	struct cpu_map;
86bd5e86 ACM	89	struct thread_map;
70082dd9	90	struct perf_evlist;
0f82ebc4	91	struct perf_record_opts;
86bd5e86	92
23a2f3ab	93	struct perf_evsel perf_evsel__new(struct perf_event_attr attr, int idx);
efd2b924	94	struct perf_evsel perf_evsel__newtp(const char sys, const char *name, int idx);
201b7334 ACM	95
	96	struct event_format event_format__new(const char sys, const char *name);
	97
ef1d1af2 ACM	98	void perf_evsel__init(struct perf_evsel *evsel,
	99	struct perf_event_attr *attr, int idx);
	100	void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1 ACM	101	void perf_evsel__delete(struct perf_evsel *evsel);
69aad6f1 ACM	102
0f82ebc4	103	void perf_evsel__config(struct perf_evsel *evsel,
cac21425	104	struct perf_record_opts *opts);
0f82ebc4	105
0b668bc9 ACM	106	bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
	107
	108	#define PERF_EVSEL__MAX_ALIASES 8
	109
	110	extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
	111	[PERF_EVSEL__MAX_ALIASES];
	112	extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
	113	[PERF_EVSEL__MAX_ALIASES];
8ad7013b ACM	114	extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
	115	[PERF_EVSEL__MAX_ALIASES];
	116	extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
	117	extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9 ACM	118	int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
0b668bc9 ACM	119	char *bf, size_t size);
7289f83c	120	const char perf_evsel__name(struct perf_evsel evsel);
717e263f NK	121	const char perf_evsel__group_name(struct perf_evsel evsel);
717e263f NK	122	int perf_evsel__group_desc(struct perf_evsel evsel, char buf, size_t size);
c410431c	123
69aad6f1	124	int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
70db7533	125	int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed	126	int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
a7e191c3	127	void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
69aad6f1	128	void perf_evsel__free_fd(struct perf_evsel *evsel);
70db7533	129	void perf_evsel__free_id(struct perf_evsel *evsel);
43f8e76e	130	void perf_evsel__free_counts(struct perf_evsel *evsel);
c52b12ed	131	void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1	132
7be5ebe8 ACM	133	void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
	134	enum perf_event_sample_format bit);
	135	void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
	136	enum perf_event_sample_format bit);
	137
	138	#define perf_evsel__set_sample_bit(evsel, bit) \
	139	__perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
	140
	141	#define perf_evsel__reset_sample_bit(evsel, bit) \
	142	__perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
	143
7a5a5ca5 ACM	144	void perf_evsel__set_sample_id(struct perf_evsel *evsel);
7a5a5ca5 ACM	145
745cefc5 ACM	146	int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
	147	const char *filter);
	148
f08199d3	149	int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c	150	struct cpu_map *cpus);
f08199d3	151	int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c	152	struct thread_map *threads);
f08199d3	153	int perf_evsel__open(struct perf_evsel evsel, struct cpu_map cpus,
6a4bb04c	154	struct thread_map *threads);
727ab04e	155	void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609	156
5555ded4 ACM	157	struct perf_sample;
5555ded4 ACM	158
5d2074ea	159	void perf_evsel__rawptr(struct perf_evsel evsel, struct perf_sample *sample,
5555ded4 ACM	160	const char *name);
	161	u64 perf_evsel__intval(struct perf_evsel evsel, struct perf_sample sample,
	162	const char *name);
	163
5d2074ea ACM	164	static inline char perf_evsel__strval(struct perf_evsel evsel,
	165	struct perf_sample *sample,
	166	const char *name)
	167	{
	168	return perf_evsel__rawptr(evsel, sample, name);
	169	}
	170
efd2b924 ACM	171	struct format_field;
	172
	173	struct format_field perf_evsel__field(struct perf_evsel evsel, const char *name);
	174
daec78a0 ACM	175	#define perf_evsel__match(evsel, t, c) \
	176	(evsel->attr.type == PERF_TYPE_##t && \
	177	evsel->attr.config == PERF_COUNT_##c)
	178
863e451f JO	179	static inline bool perf_evsel__match2(struct perf_evsel *e1,
	180	struct perf_evsel *e2)
	181	{
	182	return (e1->attr.type == e2->attr.type) &&
	183	(e1->attr.config == e2->attr.config);
	184	}
	185
c52b12ed ACM	186	int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	187	int cpu, int thread, bool scale);
	188
	189	/**
	190	* perf_evsel__read_on_cpu - Read out the results on a CPU and thread
	191	*
	192	* @evsel - event selector to read value
	193	* @cpu - CPU of interest
	194	* @thread - thread of interest
	195	*/
	196	static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	197	int cpu, int thread)
	198	{
	199	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
	200	}
	201
	202	/**
	203	* perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
	204	*
	205	* @evsel - event selector to read value
	206	* @cpu - CPU of interest
	207	* @thread - thread of interest
	208	*/
	209	static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
	210	int cpu, int thread)
	211	{
	212	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
	213	}
	214
	215	int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
	216	bool scale);
	217
	218	/**
	219	* perf_evsel__read - Read the aggregate results on all CPUs
	220	*
	221	* @evsel - event selector to read value
	222	* @ncpus - Number of cpus affected, from zero
	223	* @nthreads - Number of threads affected, from zero
	224	*/
	225	static inline int perf_evsel__read(struct perf_evsel *evsel,
	226	int ncpus, int nthreads)
	227	{
	228	return __perf_evsel__read(evsel, ncpus, nthreads, false);
	229	}
	230
	231	/**
	232	* perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
	233	*
	234	* @evsel - event selector to read value
	235	* @ncpus - Number of cpus affected, from zero
	236	* @nthreads - Number of threads affected, from zero
	237	*/
	238	static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
	239	int ncpus, int nthreads)
	240	{
	241	return __perf_evsel__read(evsel, ncpus, nthreads, true);
	242	}
	243
4bf9ce1b JO	244	void hists__init(struct hists *hists);
4bf9ce1b JO	245
a3f698fe	246	int perf_evsel__parse_sample(struct perf_evsel evsel, union perf_event event,
0807d2d8	247	struct perf_sample *sample);
0c21f736 ACM	248
	249	static inline struct perf_evsel perf_evsel__next(struct perf_evsel evsel)
	250	{
	251	return list_entry(evsel->node.next, struct perf_evsel, node);
	252	}
07ac002f	253
759ff497 NK	254	/**
	255	* perf_evsel__is_group_leader - Return whether given evsel is a leader event
	256	*
	257	* @evsel - evsel selector to be tested
	258	*
	259	* Return %true if @evsel is a group leader or a stand-alone event
	260	*/
823254ed	261	static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f	262	{
823254ed	263	return evsel->leader == evsel;
07ac002f	264	}
0698aedd	265
759ff497 NK	266	/**
	267	* perf_evsel__is_group_event - Return whether given evsel is a group event
	268	*
	269	* @evsel - evsel selector to be tested
	270	*
	271	* Return %true iff event group view is enabled and @evsel is a actual group
	272	* leader which has other members in the group
	273	*/
	274	static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
	275	{
	276	if (!symbol_conf.event_group)
	277	return false;
	278
	279	return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
	280	}
	281
0698aedd ACM	282	struct perf_attr_details {
	283	bool freq;
	284	bool verbose;
e35ef355	285	bool event_group;
0698aedd ACM	286	};
	287
	288	int perf_evsel__fprintf(struct perf_evsel *evsel,
	289	struct perf_attr_details details, FILE fp);
c0a54341 ACM	290
	291	bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
	292	char *msg, size_t msgsize);
56e52e85 ACM	293	int perf_evsel__open_strerror(struct perf_evsel *evsel,
	294	struct perf_target *target,
	295	int err, char *msg, size_t size);
97f63e4a NK	296
	297	static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
	298	{
	299	return evsel->idx - evsel->leader->idx;
	300	}
717e263f NK	301
	302	#define for_each_group_member(_evsel, _leader) \
	303	for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
	304	(_evsel) && (_evsel)->leader == (_leader); \
	305	(_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
	306
69aad6f1	307	#endif /* __PERF_EVSEL_H */