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

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_PARSE_EVENTS_H
#define __PERF_PARSE_EVENTS_H
/*
 * Parse symbolic events/counts passed in as options:
 */

#include <linux/list.h>
#include <stdbool.h>
#include <linux/types.h>
#include <linux/perf_event.h>
#include <string.h>

struct list_head;
struct perf_evsel;
struct perf_evlist;
struct parse_events_error;

struct option;

struct tracepoint_path {
	char *system;
	char *name;
	struct tracepoint_path *next;
};

struct tracepoint_path *tracepoint_id_to_path(u64 config);
struct tracepoint_path *tracepoint_name_to_path(const char *name);
bool have_tracepoints(struct list_head *evlist);

const char *event_type(int type);

int parse_events_option(const struct option *opt, const char *str, int unset);
int parse_events(struct perf_evlist *evlist, const char *str,
		 struct parse_events_error *error);
int parse_events_terms(struct list_head *terms, const char *str);
int parse_filter(const struct option *opt, const char *str, int unset);
int exclude_perf(const struct option *opt, const char *arg, int unset);

#define EVENTS_HELP_MAX (128*1024)

enum perf_pmu_event_symbol_type {
	PMU_EVENT_SYMBOL_ERR,		/* not a PMU EVENT */
	PMU_EVENT_SYMBOL,		/* normal style PMU event */
	PMU_EVENT_SYMBOL_PREFIX,	/* prefix of pre-suf style event */
	PMU_EVENT_SYMBOL_SUFFIX,	/* suffix of pre-suf style event */
};

struct perf_pmu_event_symbol {
	char	*symbol;
	enum perf_pmu_event_symbol_type	type;
};

enum {
	PARSE_EVENTS__TERM_TYPE_NUM,
	PARSE_EVENTS__TERM_TYPE_STR,
};

enum {
	PARSE_EVENTS__TERM_TYPE_USER,
	PARSE_EVENTS__TERM_TYPE_CONFIG,
	PARSE_EVENTS__TERM_TYPE_CONFIG1,
	PARSE_EVENTS__TERM_TYPE_CONFIG2,
	PARSE_EVENTS__TERM_TYPE_NAME,
	PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
	PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
	PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
	PARSE_EVENTS__TERM_TYPE_TIME,
	PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
	PARSE_EVENTS__TERM_TYPE_STACKSIZE,
	PARSE_EVENTS__TERM_TYPE_NOINHERIT,
	PARSE_EVENTS__TERM_TYPE_INHERIT,
	PARSE_EVENTS__TERM_TYPE_MAX_STACK,
	PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
	PARSE_EVENTS__TERM_TYPE_OVERWRITE,
	PARSE_EVENTS__TERM_TYPE_DRV_CFG,
	__PARSE_EVENTS__TERM_TYPE_NR,
};

struct parse_events_array {
	size_t nr_ranges;
	struct {
		unsigned int start;
		size_t length;
	} *ranges;
};

struct parse_events_term {
	char *config;
	struct parse_events_array array;
	union {
		char *str;
		u64  num;
	} val;
	int type_val;
	int type_term;
	struct list_head list;
	bool used;
	bool no_value;

	/* error string indexes for within parsed string */
	int err_term;
	int err_val;
};

struct parse_events_error {
	int   idx;	/* index in the parsed string */
	char *str;      /* string to display at the index */
	char *help;	/* optional help string */
};

struct parse_events_state {
	struct list_head	   list;
	int			   idx;
	int			   nr_groups;
	struct parse_events_error *error;
	struct perf_evlist	  *evlist;
	struct list_head	  *terms;
};

void parse_events__shrink_config_terms(void);
int parse_events__is_hardcoded_term(struct parse_events_term *term);
int parse_events_term__num(struct parse_events_term **term,
			   int type_term, char *config, u64 num,
			   bool novalue,
			   void *loc_term, void *loc_val);
int parse_events_term__str(struct parse_events_term **term,
			   int type_term, char *config, char *str,
			   void *loc_term, void *loc_val);
int parse_events_term__sym_hw(struct parse_events_term **term,
			      char *config, unsigned idx);
int parse_events_term__clone(struct parse_events_term **new,
			     struct parse_events_term *term);
void parse_events_terms__delete(struct list_head *terms);
void parse_events_terms__purge(struct list_head *terms);
void parse_events__clear_array(struct parse_events_array *a);
int parse_events__modifier_event(struct list_head *list, char *str, bool add);
int parse_events__modifier_group(struct list_head *list, char *event_mod);
int parse_events_name(struct list_head *list, char *name);
int parse_events_add_tracepoint(struct list_head *list, int *idx,
				const char *sys, const char *event,
				struct parse_events_error *error,
				struct list_head *head_config);
int parse_events_load_bpf(struct parse_events_state *parse_state,
			  struct list_head *list,
			  char *bpf_file_name,
			  bool source,
			  struct list_head *head_config);
/* Provide this function for perf test */
struct bpf_object;
int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
			      struct list_head *list,
			      struct bpf_object *obj,
			      struct list_head *head_config);
int parse_events_add_numeric(struct parse_events_state *parse_state,
			     struct list_head *list,
			     u32 type, u64 config,
			     struct list_head *head_config);
int parse_events_add_cache(struct list_head *list, int *idx,
			   char *type, char *op_result1, char *op_result2,
			   struct parse_events_error *error,
			   struct list_head *head_config);
int parse_events_add_breakpoint(struct list_head *list, int *idx,
				void *ptr, char *type, u64 len);
int parse_events_add_pmu(struct parse_events_state *parse_state,
			 struct list_head *list, char *name,
			 struct list_head *head_config);

int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
			       char *str,
			       struct list_head **listp);

int parse_events_copy_term_list(struct list_head *old,
				 struct list_head **new);

enum perf_pmu_event_symbol_type
perf_pmu__parse_check(const char *name);
void parse_events__set_leader(char *name, struct list_head *list);
void parse_events_update_lists(struct list_head *list_event,
			       struct list_head *list_all);
void parse_events_evlist_error(struct parse_events_state *parse_state,
			       int idx, const char *str);

void print_events(const char *event_glob, bool name_only, bool quiet,
		  bool long_desc, bool details_flag);

struct event_symbol {
	const char	*symbol;
	const char	*alias;
};
extern struct event_symbol event_symbols_hw[];
extern struct event_symbol event_symbols_sw[];
void print_symbol_events(const char *event_glob, unsigned type,
				struct event_symbol *syms, unsigned max,
				bool name_only);
void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
			     bool name_only);
int print_hwcache_events(const char *event_glob, bool name_only);
void print_sdt_events(const char *subsys_glob, const char *event_glob,
		      bool name_only);
int is_valid_tracepoint(const char *event_string);

int valid_event_mount(const char *eventfs);
char *parse_events_formats_error_string(char *additional_terms);

#ifdef HAVE_LIBELF_SUPPORT
/*
 * If the probe point starts with '%',
 * or starts with "sdt_" and has a ':' but no '=',
 * then it should be a SDT/cached probe point.
 */
static inline bool is_sdt_event(char *str)
{
	return (str[0] == '%' ||
		(!strncmp(str, "sdt_", 4) &&
		 !!strchr(str, ':') && !strchr(str, '=')));
}
#else
static inline bool is_sdt_event(char *str __maybe_unused)
{
	return false;
}
#endif /* HAVE_LIBELF_SUPPORT */

#endif /* __PERF_PARSE_EVENTS_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
8b40f521 JK	2	#ifndef __PERF_PARSE_EVENTS_H
8b40f521 JK	3	#define __PERF_PARSE_EVENTS_H
5242519b IM	4	/*
	5	* Parse symbolic events/counts passed in as options:
	6	*/
	7
f50246e2	8	#include <linux/list.h>
c651214e	9	#include <stdbool.h>
d944c4ee	10	#include <linux/types.h>
d2709c7c	11	#include <linux/perf_event.h>
af9100ad	12	#include <string.h>
69aad6f1 ACM	13
	14	struct list_head;
	15	struct perf_evsel;
f120f9d5	16	struct perf_evlist;
b39b8393	17	struct parse_events_error;
69aad6f1	18
5beeded1 JB	19	struct option;
5beeded1 JB	20
1ef2ed10 FW	21	struct tracepoint_path {
	22	char *system;
	23	char *name;
	24	struct tracepoint_path *next;
	25	};
	26
3938bad4 ACM	27	struct tracepoint_path *tracepoint_id_to_path(u64 config);
	28	struct tracepoint_path tracepoint_name_to_path(const char name);
	29	bool have_tracepoints(struct list_head *evlist);
1ef2ed10	30
1424dc96	31	const char *event_type(int type);
8ad8db37	32
3938bad4 ACM	33	int parse_events_option(const struct option opt, const char str, int unset);
	34	int parse_events(struct perf_evlist evlist, const char str,
	35	struct parse_events_error *error);
	36	int parse_events_terms(struct list_head terms, const char str);
	37	int parse_filter(const struct option opt, const char str, int unset);
	38	int exclude_perf(const struct option opt, const char arg, int unset);
8ad8db37 IM	39
	40	#define EVENTS_HELP_MAX (128*1024)
	41
dcb4e102 KL	42	enum perf_pmu_event_symbol_type {
	43	PMU_EVENT_SYMBOL_ERR, /* not a PMU EVENT */
	44	PMU_EVENT_SYMBOL, /* normal style PMU event */
	45	PMU_EVENT_SYMBOL_PREFIX, /* prefix of pre-suf style event */
	46	PMU_EVENT_SYMBOL_SUFFIX, /* suffix of pre-suf style event */
	47	};
	48
	49	struct perf_pmu_event_symbol {
	50	char *symbol;
	51	enum perf_pmu_event_symbol_type type;
	52	};
	53
8f707d84	54	enum {
16fa7e82 JO	55	PARSE_EVENTS__TERM_TYPE_NUM,
	56	PARSE_EVENTS__TERM_TYPE_STR,
	57	};
	58
	59	enum {
	60	PARSE_EVENTS__TERM_TYPE_USER,
8f707d84 JO	61	PARSE_EVENTS__TERM_TYPE_CONFIG,
	62	PARSE_EVENTS__TERM_TYPE_CONFIG1,
	63	PARSE_EVENTS__TERM_TYPE_CONFIG2,
6b5fc39b	64	PARSE_EVENTS__TERM_TYPE_NAME,
8f707d84	65	PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
09af2a55	66	PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
8f707d84	67	PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
32067712	68	PARSE_EVENTS__TERM_TYPE_TIME,
d457c963 KL	69	PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
d457c963 KL	70	PARSE_EVENTS__TERM_TYPE_STACKSIZE,
374ce938	71	PARSE_EVENTS__TERM_TYPE_NOINHERIT,
17cb5f84	72	PARSE_EVENTS__TERM_TYPE_INHERIT,
792d48b4	73	PARSE_EVENTS__TERM_TYPE_MAX_STACK,
626a6b78 WN	74	PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
626a6b78 WN	75	PARSE_EVENTS__TERM_TYPE_OVERWRITE,
dd60fba7	76	PARSE_EVENTS__TERM_TYPE_DRV_CFG,
17cb5f84	77	__PARSE_EVENTS__TERM_TYPE_NR,
8f707d84 JO	78	};
8f707d84 JO	79
2d055bf2 WN	80	struct parse_events_array {
	81	size_t nr_ranges;
	82	struct {
	83	unsigned int start;
	84	size_t length;
	85	} *ranges;
	86	};
	87
6cee6cd3	88	struct parse_events_term {
8f707d84	89	char *config;
2d055bf2	90	struct parse_events_array array;
8f707d84 JO	91	union {
8f707d84 JO	92	char *str;
b527bab5	93	u64 num;
8f707d84	94	} val;
16fa7e82 JO	95	int type_val;
16fa7e82 JO	96	int type_term;
8f707d84	97	struct list_head list;
688d4dfc	98	bool used;
99e7138e	99	bool no_value;
cecf3a2e JO	100
	101	/* error string indexes for within parsed string */
	102	int err_term;
	103	int err_val;
8f707d84 JO	104	};
8f707d84 JO	105
b39b8393 JO	106	struct parse_events_error {
	107	int idx; /* index in the parsed string */
	108	char str; / string to display at the index */
	109	char help; / optional help string */
	110	};
	111
5d369a75	112	struct parse_events_state {
b39b8393 JO	113	struct list_head list;
	114	int idx;
	115	int nr_groups;
	116	struct parse_events_error *error;
7630b3e2	117	struct perf_evlist *evlist;
d17d0878	118	struct list_head *terms;
90e2b22d JO	119	};
90e2b22d JO	120
1669e509	121	void parse_events__shrink_config_terms(void);
6cee6cd3	122	int parse_events__is_hardcoded_term(struct parse_events_term *term);
bb78ce7d AH	123	int parse_events_term__num(struct parse_events_term **term,
bb78ce7d AH	124	int type_term, char *config, u64 num,
99e7138e	125	bool novalue,
bb78ce7d AH	126	void loc_term, void loc_val);
	127	int parse_events_term__str(struct parse_events_term **term,
	128	int type_term, char config, char str,
	129	void loc_term, void loc_val);
6cee6cd3	130	int parse_events_term__sym_hw(struct parse_events_term **term,
1d33d6dc	131	char *config, unsigned idx);
6cee6cd3 ACM	132	int parse_events_term__clone(struct parse_events_term **new,
6cee6cd3 ACM	133	struct parse_events_term *term);
2146afc6	134	void parse_events_terms__delete(struct list_head *terms);
fc0a2c1d	135	void parse_events_terms__purge(struct list_head *terms);
2d055bf2	136	void parse_events__clear_array(struct parse_events_array *a);
f5b1135b	137	int parse_events__modifier_event(struct list_head list, char str, bool add);
89efb029	138	int parse_events__modifier_group(struct list_head list, char event_mod);
ac2ba9f3	139	int parse_events_name(struct list_head list, char name);
c5cd8ac0	140	int parse_events_add_tracepoint(struct list_head list, int idx,
8c619d6a	141	const char sys, const char event,
e637d177 HK	142	struct parse_events_error *error,
e637d177 HK	143	struct list_head *head_config);
5d9cdc11	144	int parse_events_load_bpf(struct parse_events_state *parse_state,
84c86ca1	145	struct list_head *list,
d509db04	146	char *bpf_file_name,
a34f3be7 WN	147	bool source,
a34f3be7 WN	148	struct list_head *head_config);
84c86ca1 WN	149	/* Provide this function for perf test */
84c86ca1 WN	150	struct bpf_object;
5d9cdc11	151	int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
84c86ca1	152	struct list_head *list,
95088a59 WN	153	struct bpf_object *obj,
95088a59 WN	154	struct list_head *head_config);
5d9cdc11	155	int parse_events_add_numeric(struct parse_events_state *parse_state,
87d650be	156	struct list_head *list,
b527bab5	157	u32 type, u64 config,
8f707d84	158	struct list_head *head_config);
c5cd8ac0	159	int parse_events_add_cache(struct list_head list, int idx,
43d0b978 WN	160	char type, char op_result1, char *op_result2,
	161	struct parse_events_error *error,
	162	struct list_head *head_config);
c5cd8ac0	163	int parse_events_add_breakpoint(struct list_head list, int idx,
3741eb9f	164	void ptr, char type, u64 len);
5d9cdc11	165	int parse_events_add_pmu(struct parse_events_state *parse_state,
36adec85 JO	166	struct list_head list, char name,
36adec85 JO	167	struct list_head *head_config);
2073ad33	168
5d9cdc11	169	int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
2073ad33 AK	170	char *str,
	171	struct list_head **listp);
	172
8255718f AK	173	int parse_events_copy_term_list(struct list_head *old,
	174	struct list_head **new);
	175
dcb4e102 KL	176	enum perf_pmu_event_symbol_type
dcb4e102 KL	177	perf_pmu__parse_check(const char *name);
63dab225	178	void parse_events__set_leader(char name, struct list_head list);
5d7be90e JO	179	void parse_events_update_lists(struct list_head *list_event,
5d7be90e JO	180	struct list_head *list_all);
5d9cdc11	181	void parse_events_evlist_error(struct parse_events_state *parse_state,
b39b8393	182	int idx, const char *str);
89812fc8	183
c8d6828a	184	void print_events(const char *event_glob, bool name_only, bool quiet,
bf874fcf	185	bool long_desc, bool details_flag);
705750f2 YS	186
	187	struct event_symbol {
	188	const char *symbol;
	189	const char *alias;
	190	};
	191	extern struct event_symbol event_symbols_hw[];
	192	extern struct event_symbol event_symbols_sw[];
	193	void print_symbol_events(const char *event_glob, unsigned type,
	194	struct event_symbol *syms, unsigned max,
	195	bool name_only);
a3277d2d FW	196	void print_tracepoint_events(const char subsys_glob, const char event_glob,
	197	bool name_only);
	198	int print_hwcache_events(const char *event_glob, bool name_only);
40218dae MH	199	void print_sdt_events(const char subsys_glob, const char event_glob,
40218dae MH	200	bool name_only);
3938bad4	201	int is_valid_tracepoint(const char *event_string);
8ad8db37	202
23773ca1	203	int valid_event_mount(const char *eventfs);
ffeb883e	204	char parse_events_formats_error_string(char additional_terms);
5beeded1	205
af9100ad RB	206	#ifdef HAVE_LIBELF_SUPPORT
	207	/*
	208	* If the probe point starts with '%',
	209	* or starts with "sdt_" and has a ':' but no '=',
	210	* then it should be a SDT/cached probe point.
	211	*/
	212	static inline bool is_sdt_event(char *str)
	213	{
	214	return (str[0] == '%' \|\|
	215	(!strncmp(str, "sdt_", 4) &&
	216	!!strchr(str, ':') && !strchr(str, '=')));
	217	}
	218	#else
	219	static inline bool is_sdt_event(char *str __maybe_unused)
	220	{
	221	return false;
	222	}
	223	#endif /* HAVE_LIBELF_SUPPORT */
	224
8b40f521	225	#endif /* __PERF_PARSE_EVENTS_H */