[mirror_ubuntu-focal-kernel.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_sel;

/*
 * 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 {
	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,
	PERF_EVSEL__CONFIG_TERM_MAX,
};

struct perf_evsel_config_term {
	struct list_head	list;
	int	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_sel	*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			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;
	/* 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;
};

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

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

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

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