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

#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>

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

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

const char *event_type(int type);

extern int parse_events_option(const struct option *opt, const char *str,
			       int unset);
extern int parse_events(struct perf_evlist *evlist, const char *str,
			struct parse_events_error *error);
extern int parse_events_terms(struct list_head *terms, const char *str);
extern int parse_filter(const struct option *opt, const char *str, int unset);
extern 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_NR,
};

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

	/* 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_evlist {
	struct list_head	   list;
	int			   idx;
	int			   nr_groups;
	struct parse_events_error *error;
};

struct parse_events_terms {
	struct list_head *terms;
};

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,
			   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);
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,
				char *sys, char *event,
				struct parse_events_error *error,
				struct list_head *head_config);
int parse_events_load_bpf(struct parse_events_evlist *data,
			  struct list_head *list,
			  char *bpf_file_name,
			  bool source);
/* Provide this function for perf test */
struct bpf_object;
int parse_events_load_bpf_obj(struct parse_events_evlist *data,
			      struct list_head *list,
			      struct bpf_object *obj);
int parse_events_add_numeric(struct parse_events_evlist *data,
			     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);
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_evlist *data,
			 struct list_head *list, char *name,
			 struct list_head *head_config);
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_evlist *data,
			       int idx, const char *str);

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

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);
extern int is_valid_tracepoint(const char *event_string);

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

#endif /* __PERF_PARSE_EVENTS_H */
Commit	Line	Data
	1	#ifndef __PERF_PARSE_EVENTS_H
	2	#define __PERF_PARSE_EVENTS_H
	3	/*
	4	* Parse symbolic events/counts passed in as options:
	5	*/
	6
	7	#include <linux/list.h>
	8	#include <stdbool.h>
	9	#include <linux/types.h>
	10	#include <linux/perf_event.h>
	11
	12	struct list_head;
	13	struct perf_evsel;
	14	struct perf_evlist;
	15	struct parse_events_error;
	16
	17	struct option;
	18
	19	struct tracepoint_path {
	20	char *system;
	21	char *name;
	22	struct tracepoint_path *next;
	23	};
	24
	25	extern struct tracepoint_path *tracepoint_id_to_path(u64 config);
	26	extern struct tracepoint_path tracepoint_name_to_path(const char name);
	27	extern bool have_tracepoints(struct list_head *evlist);
	28
	29	const char *event_type(int type);
	30
	31	extern int parse_events_option(const struct option opt, const char str,
	32	int unset);
	33	extern int parse_events(struct perf_evlist evlist, const char str,
	34	struct parse_events_error *error);
	35	extern int parse_events_terms(struct list_head terms, const char str);
	36	extern int parse_filter(const struct option opt, const char str, int unset);
	37	extern int exclude_perf(const struct option opt, const char arg, int unset);
	38
	39	#define EVENTS_HELP_MAX (128*1024)
	40
	41	enum perf_pmu_event_symbol_type {
	42	PMU_EVENT_SYMBOL_ERR, /* not a PMU EVENT */
	43	PMU_EVENT_SYMBOL, /* normal style PMU event */
	44	PMU_EVENT_SYMBOL_PREFIX, /* prefix of pre-suf style event */
	45	PMU_EVENT_SYMBOL_SUFFIX, /* suffix of pre-suf style event */
	46	};
	47
	48	struct perf_pmu_event_symbol {
	49	char *symbol;
	50	enum perf_pmu_event_symbol_type type;
	51	};
	52
	53	enum {
	54	PARSE_EVENTS__TERM_TYPE_NUM,
	55	PARSE_EVENTS__TERM_TYPE_STR,
	56	};
	57
	58	enum {
	59	PARSE_EVENTS__TERM_TYPE_USER,
	60	PARSE_EVENTS__TERM_TYPE_CONFIG,
	61	PARSE_EVENTS__TERM_TYPE_CONFIG1,
	62	PARSE_EVENTS__TERM_TYPE_CONFIG2,
	63	PARSE_EVENTS__TERM_TYPE_NAME,
	64	PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
	65	PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
	66	PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
	67	PARSE_EVENTS__TERM_TYPE_TIME,
	68	PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
	69	PARSE_EVENTS__TERM_TYPE_STACKSIZE,
	70	PARSE_EVENTS__TERM_TYPE_NOINHERIT,
	71	PARSE_EVENTS__TERM_TYPE_INHERIT,
	72	__PARSE_EVENTS__TERM_TYPE_NR,
	73	};
	74
	75	struct parse_events_term {
	76	char *config;
	77	union {
	78	char *str;
	79	u64 num;
	80	} val;
	81	int type_val;
	82	int type_term;
	83	struct list_head list;
	84	bool used;
	85
	86	/* error string indexes for within parsed string */
	87	int err_term;
	88	int err_val;
	89	};
	90
	91	struct parse_events_error {
	92	int idx; /* index in the parsed string */
	93	char str; / string to display at the index */
	94	char help; / optional help string */
	95	};
	96
	97	struct parse_events_evlist {
	98	struct list_head list;
	99	int idx;
	100	int nr_groups;
	101	struct parse_events_error *error;
	102	};
	103
	104	struct parse_events_terms {
	105	struct list_head *terms;
	106	};
	107
	108	int parse_events__is_hardcoded_term(struct parse_events_term *term);
	109	int parse_events_term__num(struct parse_events_term **term,
	110	int type_term, char *config, u64 num,
	111	void loc_term, void loc_val);
	112	int parse_events_term__str(struct parse_events_term **term,
	113	int type_term, char config, char str,
	114	void loc_term, void loc_val);
	115	int parse_events_term__sym_hw(struct parse_events_term **term,
	116	char *config, unsigned idx);
	117	int parse_events_term__clone(struct parse_events_term **new,
	118	struct parse_events_term *term);
	119	void parse_events_terms__delete(struct list_head *terms);
	120	void parse_events_terms__purge(struct list_head *terms);
	121	int parse_events__modifier_event(struct list_head list, char str, bool add);
	122	int parse_events__modifier_group(struct list_head list, char event_mod);
	123	int parse_events_name(struct list_head list, char name);
	124	int parse_events_add_tracepoint(struct list_head list, int idx,
	125	char sys, char event,
	126	struct parse_events_error *error,
	127	struct list_head *head_config);
	128	int parse_events_load_bpf(struct parse_events_evlist *data,
	129	struct list_head *list,
	130	char *bpf_file_name,
	131	bool source);
	132	/* Provide this function for perf test */
	133	struct bpf_object;
	134	int parse_events_load_bpf_obj(struct parse_events_evlist *data,
	135	struct list_head *list,
	136	struct bpf_object *obj);
	137	int parse_events_add_numeric(struct parse_events_evlist *data,
	138	struct list_head *list,
	139	u32 type, u64 config,
	140	struct list_head *head_config);
	141	int parse_events_add_cache(struct list_head list, int idx,
	142	char type, char op_result1, char *op_result2);
	143	int parse_events_add_breakpoint(struct list_head list, int idx,
	144	void ptr, char type, u64 len);
	145	int parse_events_add_pmu(struct parse_events_evlist *data,
	146	struct list_head list, char name,
	147	struct list_head *head_config);
	148	enum perf_pmu_event_symbol_type
	149	perf_pmu__parse_check(const char *name);
	150	void parse_events__set_leader(char name, struct list_head list);
	151	void parse_events_update_lists(struct list_head *list_event,
	152	struct list_head *list_all);
	153	void parse_events_evlist_error(struct parse_events_evlist *data,
	154	int idx, const char *str);
	155
	156	void print_events(const char *event_glob, bool name_only);
	157
	158	struct event_symbol {
	159	const char *symbol;
	160	const char *alias;
	161	};
	162	extern struct event_symbol event_symbols_hw[];
	163	extern struct event_symbol event_symbols_sw[];
	164	void print_symbol_events(const char *event_glob, unsigned type,
	165	struct event_symbol *syms, unsigned max,
	166	bool name_only);
	167	void print_tracepoint_events(const char subsys_glob, const char event_glob,
	168	bool name_only);
	169	int print_hwcache_events(const char *event_glob, bool name_only);
	170	extern int is_valid_tracepoint(const char *event_string);
	171
	172	int valid_event_mount(const char *eventfs);
	173	char parse_events_formats_error_string(char additional_terms);
	174
	175	#endif /* __PERF_PARSE_EVENTS_H */