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

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

static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
{
	return evsel->idx - evsel->leader->idx;
}
#endif /* __PERF_EVSEL_H */
Commit	Line	Data
	1	#ifndef __PERF_EVSEL_H
	2	#define __PERF_EVSEL_H 1
	3
	4	#include <linux/list.h>
	5	#include <stdbool.h>
	6	#include <stddef.h>
	7	#include <linux/perf_event.h>
	8	#include "types.h"
	9	#include "xyarray.h"
	10	#include "cgroup.h"
	11	#include "hist.h"
	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	};
	29
	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
	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	*/
	48	struct perf_evsel {
	49	struct list_head node;
	50	struct perf_event_attr attr;
	51	char *filter;
	52	struct xyarray *fd;
	53	struct xyarray *sample_id;
	54	u64 *id;
	55	struct perf_counts *counts;
	56	struct perf_counts *prev_raw_counts;
	57	int idx;
	58	u32 ids;
	59	struct hists hists;
	60	char *name;
	61	struct event_format *tp_format;
	62	union {
	63	void *priv;
	64	off_t id_offset;
	65	};
	66	struct cgroup_sel *cgrp;
	67	struct {
	68	void *func;
	69	void *data;
	70	} handler;
	71	struct cpu_map *cpus;
	72	unsigned int sample_size;
	73	bool supported;
	74	bool needs_swap;
	75	/* parse modifier helper */
	76	int exclude_GH;
	77	int nr_members;
	78	struct perf_evsel *leader;
	79	char *group_name;
	80	};
	81
	82	#define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
	83
	84	struct cpu_map;
	85	struct thread_map;
	86	struct perf_evlist;
	87	struct perf_record_opts;
	88
	89	struct perf_evsel perf_evsel__new(struct perf_event_attr attr, int idx);
	90	struct perf_evsel perf_evsel__newtp(const char sys, const char *name, int idx);
	91
	92	struct event_format event_format__new(const char sys, const char *name);
	93
	94	void perf_evsel__init(struct perf_evsel *evsel,
	95	struct perf_event_attr *attr, int idx);
	96	void perf_evsel__exit(struct perf_evsel *evsel);
	97	void perf_evsel__delete(struct perf_evsel *evsel);
	98
	99	void perf_evsel__config(struct perf_evsel *evsel,
	100	struct perf_record_opts *opts);
	101
	102	bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
	103
	104	#define PERF_EVSEL__MAX_ALIASES 8
	105
	106	extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
	107	[PERF_EVSEL__MAX_ALIASES];
	108	extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
	109	[PERF_EVSEL__MAX_ALIASES];
	110	extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
	111	[PERF_EVSEL__MAX_ALIASES];
	112	extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
	113	extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
	114	int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
	115	char *bf, size_t size);
	116	const char perf_evsel__name(struct perf_evsel evsel);
	117
	118	int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
	119	int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
	120	int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
	121	void perf_evsel__free_fd(struct perf_evsel *evsel);
	122	void perf_evsel__free_id(struct perf_evsel *evsel);
	123	void perf_evsel__free_counts(struct perf_evsel *evsel);
	124	void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
	125
	126	void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
	127	enum perf_event_sample_format bit);
	128	void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
	129	enum perf_event_sample_format bit);
	130
	131	#define perf_evsel__set_sample_bit(evsel, bit) \
	132	__perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
	133
	134	#define perf_evsel__reset_sample_bit(evsel, bit) \
	135	__perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
	136
	137	void perf_evsel__set_sample_id(struct perf_evsel *evsel);
	138
	139	int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
	140	const char *filter);
	141
	142	int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
	143	struct cpu_map *cpus);
	144	int perf_evsel__open_per_thread(struct perf_evsel *evsel,
	145	struct thread_map *threads);
	146	int perf_evsel__open(struct perf_evsel evsel, struct cpu_map cpus,
	147	struct thread_map *threads);
	148	void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
	149
	150	struct perf_sample;
	151
	152	void perf_evsel__rawptr(struct perf_evsel evsel, struct perf_sample *sample,
	153	const char *name);
	154	u64 perf_evsel__intval(struct perf_evsel evsel, struct perf_sample sample,
	155	const char *name);
	156
	157	static inline char perf_evsel__strval(struct perf_evsel evsel,
	158	struct perf_sample *sample,
	159	const char *name)
	160	{
	161	return perf_evsel__rawptr(evsel, sample, name);
	162	}
	163
	164	struct format_field;
	165
	166	struct format_field perf_evsel__field(struct perf_evsel evsel, const char *name);
	167
	168	#define perf_evsel__match(evsel, t, c) \
	169	(evsel->attr.type == PERF_TYPE_##t && \
	170	evsel->attr.config == PERF_COUNT_##c)
	171
	172	static inline bool perf_evsel__match2(struct perf_evsel *e1,
	173	struct perf_evsel *e2)
	174	{
	175	return (e1->attr.type == e2->attr.type) &&
	176	(e1->attr.config == e2->attr.config);
	177	}
	178
	179	int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	180	int cpu, int thread, bool scale);
	181
	182	/**
	183	* perf_evsel__read_on_cpu - Read out the results on a CPU and thread
	184	*
	185	* @evsel - event selector to read value
	186	* @cpu - CPU of interest
	187	* @thread - thread of interest
	188	*/
	189	static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	190	int cpu, int thread)
	191	{
	192	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
	193	}
	194
	195	/**
	196	* perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
	197	*
	198	* @evsel - event selector to read value
	199	* @cpu - CPU of interest
	200	* @thread - thread of interest
	201	*/
	202	static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
	203	int cpu, int thread)
	204	{
	205	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
	206	}
	207
	208	int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
	209	bool scale);
	210
	211	/**
	212	* perf_evsel__read - Read the aggregate results on all CPUs
	213	*
	214	* @evsel - event selector to read value
	215	* @ncpus - Number of cpus affected, from zero
	216	* @nthreads - Number of threads affected, from zero
	217	*/
	218	static inline int perf_evsel__read(struct perf_evsel *evsel,
	219	int ncpus, int nthreads)
	220	{
	221	return __perf_evsel__read(evsel, ncpus, nthreads, false);
	222	}
	223
	224	/**
	225	* perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
	226	*
	227	* @evsel - event selector to read value
	228	* @ncpus - Number of cpus affected, from zero
	229	* @nthreads - Number of threads affected, from zero
	230	*/
	231	static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
	232	int ncpus, int nthreads)
	233	{
	234	return __perf_evsel__read(evsel, ncpus, nthreads, true);
	235	}
	236
	237	void hists__init(struct hists *hists);
	238
	239	int perf_evsel__parse_sample(struct perf_evsel evsel, union perf_event event,
	240	struct perf_sample *sample);
	241
	242	static inline struct perf_evsel perf_evsel__next(struct perf_evsel evsel)
	243	{
	244	return list_entry(evsel->node.next, struct perf_evsel, node);
	245	}
	246
	247	static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
	248	{
	249	return evsel->leader == evsel;
	250	}
	251
	252	struct perf_attr_details {
	253	bool freq;
	254	bool verbose;
	255	};
	256
	257	int perf_evsel__fprintf(struct perf_evsel *evsel,
	258	struct perf_attr_details details, FILE fp);
	259
	260	bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
	261	char *msg, size_t msgsize);
	262	int perf_evsel__open_strerror(struct perf_evsel *evsel,
	263	struct perf_target *target,
	264	int err, char *msg, size_t size);
	265
	266	static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
	267	{
	268	return evsel->idx - evsel->leader->idx;
	269	}
	270	#endif /* __PERF_EVSEL_H */