[linux-2.6-block.git] / tools / perf / util / evsel.h

/* SPDX-License-Identifier: GPL-2.0 */
#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 <linux/types.h>
#include "xyarray.h"
#include "symbol.h"
#include "cpumap.h"
#include "counts.h"

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;
	int			idx;
	int			cpu;
	pid_t			tid;

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

struct cgroup;

/*
 * The 'struct perf_evsel_config_term' is used to pass event
 * specific configuration data to perf_evsel__config routine.
 * It is allocated within event parsing and attached to
 * perf_evsel::config_terms list head.
*/
enum term_type {
	PERF_EVSEL__CONFIG_TERM_PERIOD,
	PERF_EVSEL__CONFIG_TERM_FREQ,
	PERF_EVSEL__CONFIG_TERM_TIME,
	PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
	PERF_EVSEL__CONFIG_TERM_STACK_USER,
	PERF_EVSEL__CONFIG_TERM_INHERIT,
	PERF_EVSEL__CONFIG_TERM_MAX_STACK,
	PERF_EVSEL__CONFIG_TERM_OVERWRITE,
	PERF_EVSEL__CONFIG_TERM_DRV_CFG,
	PERF_EVSEL__CONFIG_TERM_BRANCH,
};

struct perf_evsel_config_term {
	struct list_head	list;
	enum term_type	type;
	union {
		u64	period;
		u64	freq;
		bool	time;
		char	*callgraph;
		char	*drv_cfg;
		u64	stack_user;
		int	max_stack;
		bool	inherit;
		bool	overwrite;
		char	*branch;
	} val;
	bool weak;
};

struct perf_stat_evsel;

/** struct perf_evsel - event selector
 *
 * @evlist - evlist this evsel is in, if it is in one.
 * @node - To insert it into evlist->entries or in other list_heads, say in
 *         the event parsing routines.
 * @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.
 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
 *          PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
 *          struct sample_event
 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
 *          PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
 *          is used there is an id sample appended to non-sample events
 * @priv:   And what is in its containing unnamed union are tool specific
 */
struct perf_evsel {
	struct list_head	node;
	struct perf_evlist	*evlist;
	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;
	char			*name;
	double			scale;
	const char		*unit;
	struct event_format	*tp_format;
	off_t			id_offset;
	struct perf_stat_evsel  *stats;
	void			*priv;
	u64			db_id;
	struct cgroup		*cgrp;
	void			*handler;
	struct cpu_map		*cpus;
	struct cpu_map		*own_cpus;
	struct thread_map	*threads;
	unsigned int		sample_size;
	int			id_pos;
	int			is_pos;
	bool			uniquified_name;
	bool			snapshot;
	bool 			supported;
	bool 			needs_swap;
	bool			no_aux_samples;
	bool			immediate;
	bool			system_wide;
	bool			tracking;
	bool			per_pkg;
	bool			precise_max;
	bool			ignore_missing_thread;
	bool			forced_leader;
	/* parse modifier helper */
	int			exclude_GH;
	int			nr_members;
	int			sample_read;
	unsigned long		*per_pkg_mask;
	struct perf_evsel	*leader;
	char			*group_name;
	bool			cmdline_group_boundary;
	struct list_head	config_terms;
	int			bpf_fd;
	bool			auto_merge_stats;
	bool			merged_stat;
	const char *		metric_expr;
	const char *		metric_name;
	struct perf_evsel	**metric_events;
	bool			collect_stat;
	bool			weak_group;
	const char		*pmu_name;
};

union u64_swap {
	u64 val64;
	u32 val32[2];
};

struct perf_missing_features {
	bool sample_id_all;
	bool exclude_guest;
	bool mmap2;
	bool cloexec;
	bool clockid;
	bool clockid_wrong;
	bool lbr_flags;
	bool write_backward;
	bool group_read;
};

extern struct perf_missing_features perf_missing_features;

struct cpu_map;
struct target;
struct thread_map;
struct record_opts;

static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
{
	return evsel->cpus;
}

static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
{
	return perf_evsel__cpus(evsel)->nr;
}

void perf_counts_values__scale(struct perf_counts_values *count,
			       bool scale, s8 *pscaled);

void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
				struct perf_counts_values *count);

int perf_evsel__object_config(size_t object_size,
			      int (*init)(struct perf_evsel *evsel),
			      void (*fini)(struct perf_evsel *evsel));

struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);

static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
{
	return perf_evsel__new_idx(attr, 0);
}

struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);

/*
 * Returns pointer with encoded error via <linux/err.h> interface.
 */
static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
{
	return perf_evsel__newtp_idx(sys, name, 0);
}

struct perf_evsel *perf_evsel__new_cycles(bool precise);

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

struct callchain_param;

void perf_evsel__config(struct perf_evsel *evsel,
			struct record_opts *opts,
			struct callchain_param *callchain);
void perf_evsel__config_callchain(struct perf_evsel *evsel,
				  struct record_opts *opts,
				  struct callchain_param *callchain);

int __perf_evsel__sample_size(u64 sample_type);
void perf_evsel__calc_id_pos(struct perf_evsel *evsel);

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_id(struct perf_evsel *evsel, int ncpus, int nthreads);
void perf_evsel__close_fd(struct perf_evsel *evsel);

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

int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter);
int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
				   const char *filter);
int perf_evsel__apply_filter(struct perf_evsel *evsel, const char *filter);
int perf_evsel__enable(struct perf_evsel *evsel);
int perf_evsel__disable(struct perf_evsel *evsel);

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

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;

u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap);

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

#define perf_evsel__cmp(a, b)			\
	((a) &&					\
	 (b) &&					\
	 (a)->attr.type == (b)->attr.type &&	\
	 (a)->attr.config == (b)->attr.config)

int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
		     struct perf_counts_values *count);

int perf_evsel__read_counter(struct perf_evsel *evsel, int cpu, int thread);

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__parse_sample(struct perf_evsel *evsel, union perf_event *event,
			     struct perf_sample *sample);

int perf_evsel__parse_sample_timestamp(struct perf_evsel *evsel,
				       union perf_event *event,
				       u64 *timestamp);

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

static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
{
	return list_entry(evsel->node.prev, 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;
}

bool perf_evsel__is_function_event(struct perf_evsel *evsel);

static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
{
	struct perf_event_attr *attr = &evsel->attr;

	return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
		(attr->type == PERF_TYPE_SOFTWARE);
}

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

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

#define EVSEL__PRINT_IP			(1<<0)
#define EVSEL__PRINT_SYM		(1<<1)
#define EVSEL__PRINT_DSO		(1<<2)
#define EVSEL__PRINT_SYMOFFSET		(1<<3)
#define EVSEL__PRINT_ONELINE		(1<<4)
#define EVSEL__PRINT_SRCLINE		(1<<5)
#define EVSEL__PRINT_UNKNOWN_AS_ADDR	(1<<6)
#define EVSEL__PRINT_CALLCHAIN_ARROW	(1<<7)
#define EVSEL__PRINT_SKIP_IGNORED	(1<<8)

struct callchain_cursor;

int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
			      unsigned int print_opts,
			      struct callchain_cursor *cursor, FILE *fp);

int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
			int left_alignment, unsigned int print_opts,
			struct callchain_cursor *cursor, 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 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))

static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
{
	return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
}

typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);

int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
			     attr__fprintf_f attr__fprintf, void *priv);

struct perf_env *perf_evsel__env(struct perf_evsel *evsel);

#endif /* __PERF_EVSEL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
69aad6f1 ACM	2	#ifndef __PERF_EVSEL_H
	3	#define __PERF_EVSEL_H 1
	4
	5	#include <linux/list.h>
c52b12ed	6	#include <stdbool.h>
07ac002f	7	#include <stddef.h>
d2709c7c	8	#include <linux/perf_event.h>
d944c4ee	9	#include <linux/types.h>
69aad6f1	10	#include "xyarray.h"
759ff497	11	#include "symbol.h"
a22e99cd	12	#include "cpumap.h"
d809560b	13	#include "counts.h"
69aad6f1	14
70db7533 ACM	15	struct perf_evsel;
	16
	17	/*
	18	* Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
	19	* more than one entry in the evlist.
	20	*/
	21	struct perf_sample_id {
	22	struct hlist_node node;
	23	u64 id;
	24	struct perf_evsel *evsel;
3c659eed AH	25	int idx;
	26	int cpu;
	27	pid_t tid;
e4caec0d JO	28
	29	/* Holds total ID period value for PERF_SAMPLE_READ processing. */
	30	u64 period;
70db7533 ACM	31	};
70db7533 ACM	32
3ca32f69	33	struct cgroup;
f14d5707	34
930a2e29 JO	35	/*
	36	* The 'struct perf_evsel_config_term' is used to pass event
	37	* specific configuration data to perf_evsel__config routine.
	38	* It is allocated within event parsing and attached to
	39	* perf_evsel::config_terms list head.
	40	*/
d0565132	41	enum term_type {
ee4c7588	42	PERF_EVSEL__CONFIG_TERM_PERIOD,
09af2a55	43	PERF_EVSEL__CONFIG_TERM_FREQ,
32067712	44	PERF_EVSEL__CONFIG_TERM_TIME,
d457c963 KL	45	PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
d457c963 KL	46	PERF_EVSEL__CONFIG_TERM_STACK_USER,
374ce938	47	PERF_EVSEL__CONFIG_TERM_INHERIT,
792d48b4	48	PERF_EVSEL__CONFIG_TERM_MAX_STACK,
626a6b78	49	PERF_EVSEL__CONFIG_TERM_OVERWRITE,
dd60fba7	50	PERF_EVSEL__CONFIG_TERM_DRV_CFG,
ac12f676	51	PERF_EVSEL__CONFIG_TERM_BRANCH,
930a2e29 JO	52	};
	53
	54	struct perf_evsel_config_term {
	55	struct list_head list;
d0565132	56	enum term_type type;
930a2e29 JO	57	union {
930a2e29 JO	58	u64 period;
09af2a55	59	u64 freq;
32067712	60	bool time;
d457c963	61	char *callgraph;
dd60fba7	62	char *drv_cfg;
d457c963	63	u64 stack_user;
792d48b4	64	int max_stack;
374ce938	65	bool inherit;
626a6b78	66	bool overwrite;
ac12f676	67	char *branch;
930a2e29	68	} val;
c2f1cead	69	bool weak;
930a2e29 JO	70	};
930a2e29 JO	71
e669e833 ACM	72	struct perf_stat_evsel;
e669e833 ACM	73
f0c55bcf SE	74	/** struct perf_evsel - event selector
f0c55bcf SE	75	*
d49e4695 ACM	76	* @evlist - evlist this evsel is in, if it is in one.
	77	* @node - To insert it into evlist->entries or in other list_heads, say in
	78	* the event parsing routines.
f0c55bcf SE	79	* @name - Can be set to retain the original event name passed by the user,
	80	* so that when showing results in tools such as 'perf stat', we
	81	* show the name used, not some alias.
75562573 AH	82	* @id_pos: the position of the event id (PERF_SAMPLE_ID or
	83	* PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
	84	* struct sample_event
	85	* @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
	86	* PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
	87	* is used there is an id sample appended to non-sample events
0db15b1e	88	* @priv: And what is in its containing unnamed union are tool specific
f0c55bcf	89	*/
69aad6f1 ACM	90	struct perf_evsel {
69aad6f1 ACM	91	struct list_head node;
d49e4695	92	struct perf_evlist *evlist;
69aad6f1 ACM	93	struct perf_event_attr attr;
	94	char *filter;
	95	struct xyarray *fd;
a91e5431 ACM	96	struct xyarray *sample_id;
a91e5431 ACM	97	u64 *id;
c52b12ed	98	struct perf_counts *counts;
c7a79c47	99	struct perf_counts *prev_raw_counts;
69aad6f1	100	int idx;
f4d83436	101	u32 ids;
f0c55bcf	102	char *name;
410136f5 SE	103	double scale;
410136f5 SE	104	const char *unit;
fcf65bf1	105	struct event_format *tp_format;
af339981	106	off_t id_offset;
e669e833	107	struct perf_stat_evsel *stats;
616df645 CP	108	void *priv;
616df645 CP	109	u64 db_id;
3ca32f69	110	struct cgroup *cgrp;
744a9719	111	void *handler;
7ae92e74	112	struct cpu_map *cpus;
fce4d296	113	struct cpu_map *own_cpus;
578e91ec	114	struct thread_map *threads;
bde09467	115	unsigned int sample_size;
75562573 AH	116	int id_pos;
75562573 AH	117	int is_pos;
80ee8c58	118	bool uniquified_name;
86066064	119	bool snapshot;
2cee77c4	120	bool supported;
0807d2d8	121	bool needs_swap;
6ff1ce76	122	bool no_aux_samples;
2afd2bcf	123	bool immediate;
bf8e8f4b	124	bool system_wide;
60b0896c	125	bool tracking;
044330c1	126	bool per_pkg;
7f94af7a	127	bool precise_max;
a359c17a	128	bool ignore_missing_thread;
8ef278bb	129	bool forced_leader;
f5b1135b JO	130	/* parse modifier helper */
f5b1135b JO	131	int exclude_GH;
97f63e4a	132	int nr_members;
3c176311	133	int sample_read;
86066064	134	unsigned long *per_pkg_mask;
6a4bb04c JO	135	struct perf_evsel *leader;
6a4bb04c JO	136	char *group_name;
15bfd2cc	137	bool cmdline_group_boundary;
930a2e29	138	struct list_head config_terms;
1f45b1d4	139	int bpf_fd;
63ce8449	140	bool auto_merge_stats;
430daf2d	141	bool merged_stat;
37932c18	142	const char * metric_expr;
96284814	143	const char * metric_name;
37932c18 AK	144	struct perf_evsel **metric_events;
37932c18 AK	145	bool collect_stat;
5a5dfe4b	146	bool weak_group;
8c5421c0	147	const char *pmu_name;
69aad6f1 ACM	148	};
69aad6f1 ACM	149
88080ce7 BP	150	union u64_swap {
	151	u64 val64;
	152	u32 val32[2];
	153	};
	154
9a831b3a ACM	155	struct perf_missing_features {
	156	bool sample_id_all;
	157	bool exclude_guest;
	158	bool mmap2;
	159	bool cloexec;
	160	bool clockid;
	161	bool clockid_wrong;
	162	bool lbr_flags;
	163	bool write_backward;
	164	bool group_read;
	165	};
	166
	167	extern struct perf_missing_features perf_missing_features;
	168
86bd5e86	169	struct cpu_map;
80b2210c	170	struct target;
86bd5e86	171	struct thread_map;
b4006796	172	struct record_opts;
86bd5e86	173
a22e99cd JO	174	static inline struct cpu_map perf_evsel__cpus(struct perf_evsel evsel)
	175	{
	176	return evsel->cpus;
	177	}
	178
	179	static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
	180	{
	181	return perf_evsel__cpus(evsel)->nr;
	182	}
	183
13112bbf JO	184	void perf_counts_values__scale(struct perf_counts_values *count,
	185	bool scale, s8 *pscaled);
	186
a6fa0038	187	void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
857a94a2 JO	188	struct perf_counts_values *count);
857a94a2 JO	189
ce8ccff5 ACM	190	int perf_evsel__object_config(size_t object_size,
	191	int (init)(struct perf_evsel evsel),
	192	void (fini)(struct perf_evsel evsel));
	193
ef503831 ACM	194	struct perf_evsel perf_evsel__new_idx(struct perf_event_attr attr, int idx);
	195
	196	static inline struct perf_evsel perf_evsel__new(struct perf_event_attr attr)
	197	{
	198	return perf_evsel__new_idx(attr, 0);
	199	}
	200
	201	struct perf_evsel perf_evsel__newtp_idx(const char sys, const char *name, int idx);
	202
8dd2a131 JO	203	/*
	204	* Returns pointer with encoded error via <linux/err.h> interface.
	205	*/
ef503831 ACM	206	static inline struct perf_evsel perf_evsel__newtp(const char sys, const char *name)
	207	{
	208	return perf_evsel__newtp_idx(sys, name, 0);
	209	}
201b7334	210
30269dc1	211	struct perf_evsel *perf_evsel__new_cycles(bool precise);
7c48dcfd	212
201b7334 ACM	213	struct event_format event_format__new(const char sys, const char *name);
201b7334 ACM	214
ef1d1af2 ACM	215	void perf_evsel__init(struct perf_evsel *evsel,
	216	struct perf_event_attr *attr, int idx);
	217	void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1 ACM	218	void perf_evsel__delete(struct perf_evsel *evsel);
69aad6f1 ACM	219
e68ae9cf ACM	220	struct callchain_param;
e68ae9cf ACM	221
0f82ebc4	222	void perf_evsel__config(struct perf_evsel *evsel,
e68ae9cf ACM	223	struct record_opts *opts,
e68ae9cf ACM	224	struct callchain_param *callchain);
01e0d50c ACM	225	void perf_evsel__config_callchain(struct perf_evsel *evsel,
	226	struct record_opts *opts,
	227	struct callchain_param *callchain);
0f82ebc4	228
75562573 AH	229	int __perf_evsel__sample_size(u64 sample_type);
	230	void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
	231
0b668bc9 ACM	232	bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
	233
	234	#define PERF_EVSEL__MAX_ALIASES 8
	235
	236	extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
	237	[PERF_EVSEL__MAX_ALIASES];
	238	extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
	239	[PERF_EVSEL__MAX_ALIASES];
8ad7013b ACM	240	extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
	241	[PERF_EVSEL__MAX_ALIASES];
	242	extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
	243	extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9 ACM	244	int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
0b668bc9 ACM	245	char *bf, size_t size);
7289f83c	246	const char perf_evsel__name(struct perf_evsel evsel);
410136f5	247
717e263f NK	248	const char perf_evsel__group_name(struct perf_evsel evsel);
717e263f NK	249	int perf_evsel__group_desc(struct perf_evsel evsel, char buf, size_t size);
c410431c	250
70db7533	251	int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
475fb533	252	void perf_evsel__close_fd(struct perf_evsel *evsel);
69aad6f1	253
7be5ebe8 ACM	254	void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
	255	enum perf_event_sample_format bit);
	256	void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
	257	enum perf_event_sample_format bit);
	258
	259	#define perf_evsel__set_sample_bit(evsel, bit) \
	260	__perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
	261
	262	#define perf_evsel__reset_sample_bit(evsel, bit) \
	263	__perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
	264
75562573 AH	265	void perf_evsel__set_sample_id(struct perf_evsel *evsel,
75562573 AH	266	bool use_sample_identifier);
7a5a5ca5	267
12467ae4	268	int perf_evsel__set_filter(struct perf_evsel evsel, const char filter);
3541c034	269	int perf_evsel__append_tp_filter(struct perf_evsel evsel, const char filter);
1e857484 MP	270	int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
1e857484 MP	271	const char *filter);
475fb533	272	int perf_evsel__apply_filter(struct perf_evsel evsel, const char filter);
5cd95fc3	273	int perf_evsel__enable(struct perf_evsel *evsel);
e98a4cbb	274	int perf_evsel__disable(struct perf_evsel *evsel);
745cefc5	275
f08199d3	276	int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c	277	struct cpu_map *cpus);
f08199d3	278	int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c	279	struct thread_map *threads);
f08199d3	280	int perf_evsel__open(struct perf_evsel evsel, struct cpu_map cpus,
6a4bb04c	281	struct thread_map *threads);
475fb533	282	void perf_evsel__close(struct perf_evsel *evsel);
48290609	283
5555ded4 ACM	284	struct perf_sample;
5555ded4 ACM	285
5d2074ea	286	void perf_evsel__rawptr(struct perf_evsel evsel, struct perf_sample *sample,
5555ded4 ACM	287	const char *name);
	288	u64 perf_evsel__intval(struct perf_evsel evsel, struct perf_sample sample,
	289	const char *name);
	290
5d2074ea ACM	291	static inline char perf_evsel__strval(struct perf_evsel evsel,
	292	struct perf_sample *sample,
	293	const char *name)
	294	{
	295	return perf_evsel__rawptr(evsel, sample, name);
	296	}
	297
efd2b924 ACM	298	struct format_field;
efd2b924 ACM	299
90525176 ACM	300	u64 format_field__intval(struct format_field field, struct perf_sample sample, bool needs_swap);
90525176 ACM	301
efd2b924 ACM	302	struct format_field perf_evsel__field(struct perf_evsel evsel, const char *name);
efd2b924 ACM	303
daec78a0 ACM	304	#define perf_evsel__match(evsel, t, c) \
	305	(evsel->attr.type == PERF_TYPE_##t && \
	306	evsel->attr.config == PERF_COUNT_##c)
	307
863e451f JO	308	static inline bool perf_evsel__match2(struct perf_evsel *e1,
	309	struct perf_evsel *e2)
	310	{
	311	return (e1->attr.type == e2->attr.type) &&
	312	(e1->attr.config == e2->attr.config);
	313	}
	314
4cabc3d1 AK	315	#define perf_evsel__cmp(a, b) \
	316	((a) && \
	317	(b) && \
	318	(a)->attr.type == (b)->attr.type && \
	319	(a)->attr.config == (b)->attr.config)
	320
f99f4719 JO	321	int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
	322	struct perf_counts_values *count);
	323
f7794d52 JO	324	int perf_evsel__read_counter(struct perf_evsel *evsel, int cpu, int thread);
f7794d52 JO	325
c52b12ed ACM	326	int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	327	int cpu, int thread, bool scale);
	328
	329	/**
	330	* perf_evsel__read_on_cpu - Read out the results on a CPU and thread
	331	*
	332	* @evsel - event selector to read value
	333	* @cpu - CPU of interest
	334	* @thread - thread of interest
	335	*/
	336	static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
	337	int cpu, int thread)
	338	{
	339	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
	340	}
	341
	342	/**
	343	* perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
	344	*
	345	* @evsel - event selector to read value
	346	* @cpu - CPU of interest
	347	* @thread - thread of interest
	348	*/
	349	static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
	350	int cpu, int thread)
	351	{
	352	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
	353	}
	354
a3f698fe	355	int perf_evsel__parse_sample(struct perf_evsel evsel, union perf_event event,
0807d2d8	356	struct perf_sample *sample);
0c21f736	357
01468120 JO	358	int perf_evsel__parse_sample_timestamp(struct perf_evsel *evsel,
	359	union perf_event *event,
	360	u64 *timestamp);
	361
0c21f736 ACM	362	static inline struct perf_evsel perf_evsel__next(struct perf_evsel evsel)
	363	{
	364	return list_entry(evsel->node.next, struct perf_evsel, node);
	365	}
07ac002f	366
d87fcb4a ACM	367	static inline struct perf_evsel perf_evsel__prev(struct perf_evsel evsel)
	368	{
	369	return list_entry(evsel->node.prev, struct perf_evsel, node);
	370	}
	371
759ff497 NK	372	/**
	373	* perf_evsel__is_group_leader - Return whether given evsel is a leader event
	374	*
	375	* @evsel - evsel selector to be tested
	376	*
	377	* Return %true if @evsel is a group leader or a stand-alone event
	378	*/
823254ed	379	static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f	380	{
823254ed	381	return evsel->leader == evsel;
07ac002f	382	}
0698aedd	383
759ff497 NK	384	/**
	385	* perf_evsel__is_group_event - Return whether given evsel is a group event
	386	*
	387	* @evsel - evsel selector to be tested
	388	*
	389	* Return %true iff event group view is enabled and @evsel is a actual group
	390	* leader which has other members in the group
	391	*/
	392	static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
	393	{
	394	if (!symbol_conf.event_group)
	395	return false;
	396
	397	return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
	398	}
	399
5496bc0c	400	bool perf_evsel__is_function_event(struct perf_evsel *evsel);
6bedfab6	401
03e0a7df WN	402	static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
	403	{
	404	struct perf_event_attr *attr = &evsel->attr;
	405
	406	return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
	407	(attr->type == PERF_TYPE_SOFTWARE);
	408	}
	409
0698aedd ACM	410	struct perf_attr_details {
	411	bool freq;
	412	bool verbose;
e35ef355	413	bool event_group;
9e3b6ec1	414	bool force;
775d8a1b	415	bool trace_fields;
0698aedd ACM	416	};
	417
	418	int perf_evsel__fprintf(struct perf_evsel *evsel,
	419	struct perf_attr_details details, FILE fp);
c0a54341	420
e20ab86e ACM	421	#define EVSEL__PRINT_IP (1<<0)
	422	#define EVSEL__PRINT_SYM (1<<1)
	423	#define EVSEL__PRINT_DSO (1<<2)
	424	#define EVSEL__PRINT_SYMOFFSET (1<<3)
	425	#define EVSEL__PRINT_ONELINE (1<<4)
	426	#define EVSEL__PRINT_SRCLINE (1<<5)
	427	#define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
69b7e480	428	#define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7)
2d9bbf6e	429	#define EVSEL__PRINT_SKIP_IGNORED (1<<8)
e20ab86e	430
6f736735 ACM	431	struct callchain_cursor;
6f736735 ACM	432
d327e60c ACM	433	int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
d327e60c ACM	434	unsigned int print_opts,
6f736735 ACM	435	struct callchain_cursor cursor, FILE fp);
	436
	437	int sample__fprintf_sym(struct perf_sample sample, struct addr_location al,
	438	int left_alignment, unsigned int print_opts,
	439	struct callchain_cursor cursor, FILE fp);
e20ab86e	440
c0a54341 ACM	441	bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
c0a54341 ACM	442	char *msg, size_t msgsize);
602ad878	443	int perf_evsel__open_strerror(struct perf_evsel evsel, struct target target,
56e52e85	444	int err, char *msg, size_t size);
97f63e4a NK	445
	446	static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
	447	{
	448	return evsel->idx - evsel->leader->idx;
	449	}
717e263f NK	450
	451	#define for_each_group_member(_evsel, _leader) \
	452	for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
	453	(_evsel) && (_evsel)->leader == (_leader); \
	454	(_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
	455
acf2abbd	456	static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
384b6055 KL	457	{
	458	return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
	459	}
2c5e8c52 PZ	460
	461	typedef int (attr__fprintf_f)(FILE , const char , const char , void *);
	462
	463	int perf_event_attr__fprintf(FILE fp, struct perf_event_attr attr,
	464	attr__fprintf_f attr__fprintf, void *priv);
	465
5449f13c	466	struct perf_env perf_evsel__env(struct perf_evsel evsel);
f4e47f9f	467
69aad6f1	468	#endif /* __PERF_EVSEL_H */