cachepc-linux

Fork of AMDESE/linux with modifications for CachePC side-channel attack
git clone https://git.sinitax.com/sinitax/cachepc-linux
Log | Files | Refs | README | LICENSE | sfeed.txt

event-parse.h (21365B)


      1/* SPDX-License-Identifier: LGPL-2.1 */
      2/*
      3 * Copyright (C) 2009, 2010 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
      4 *
      5 */
      6#ifndef _PARSE_EVENTS_H
      7#define _PARSE_EVENTS_H
      8
      9#include <stdbool.h>
     10#include <stdarg.h>
     11#include <stdio.h>
     12#include <regex.h>
     13#include <string.h>
     14
     15#include "trace-seq.h"
     16
     17#ifndef __maybe_unused
     18#define __maybe_unused __attribute__((unused))
     19#endif
     20
     21#ifndef DEBUG_RECORD
     22#define DEBUG_RECORD 0
     23#endif
     24
     25struct tep_record {
     26	unsigned long long	ts;
     27	unsigned long long	offset;
     28	long long		missed_events;	/* buffer dropped events before */
     29	int			record_size;	/* size of binary record */
     30	int			size;		/* size of data */
     31	void			*data;
     32	int			cpu;
     33	int			ref_count;
     34	int			locked;		/* Do not free, even if ref_count is zero */
     35	void			*priv;
     36#if DEBUG_RECORD
     37	struct tep_record	*prev;
     38	struct tep_record	*next;
     39	long			alloc_addr;
     40#endif
     41};
     42
     43/* ----------------------- tep ----------------------- */
     44
     45struct tep_handle;
     46struct tep_event;
     47
     48typedef int (*tep_event_handler_func)(struct trace_seq *s,
     49				      struct tep_record *record,
     50				      struct tep_event *event,
     51				      void *context);
     52
     53typedef int (*tep_plugin_load_func)(struct tep_handle *tep);
     54typedef int (*tep_plugin_unload_func)(struct tep_handle *tep);
     55
     56struct tep_plugin_option {
     57	struct tep_plugin_option	*next;
     58	void				*handle;
     59	char				*file;
     60	char				*name;
     61	char				*plugin_alias;
     62	char				*description;
     63	const char			*value;
     64	void				*priv;
     65	int				set;
     66};
     67
     68/*
     69 * Plugin hooks that can be called:
     70 *
     71 * TEP_PLUGIN_LOADER:  (required)
     72 *   The function name to initialized the plugin.
     73 *
     74 *   int TEP_PLUGIN_LOADER(struct tep_handle *tep)
     75 *
     76 * TEP_PLUGIN_UNLOADER:  (optional)
     77 *   The function called just before unloading
     78 *
     79 *   int TEP_PLUGIN_UNLOADER(struct tep_handle *tep)
     80 *
     81 * TEP_PLUGIN_OPTIONS:  (optional)
     82 *   Plugin options that can be set before loading
     83 *
     84 *   struct tep_plugin_option TEP_PLUGIN_OPTIONS[] = {
     85 *	{
     86 *		.name = "option-name",
     87 *		.plugin_alias = "override-file-name", (optional)
     88 *		.description = "description of option to show users",
     89 *	},
     90 *	{
     91 *		.name = NULL,
     92 *	},
     93 *   };
     94 *
     95 *   Array must end with .name = NULL;
     96 *
     97 *
     98 *   .plugin_alias is used to give a shorter name to access
     99 *   the vairable. Useful if a plugin handles more than one event.
    100 *
    101 *   If .value is not set, then it is considered a boolean and only
    102 *   .set will be processed. If .value is defined, then it is considered
    103 *   a string option and .set will be ignored.
    104 *
    105 * TEP_PLUGIN_ALIAS: (optional)
    106 *   The name to use for finding options (uses filename if not defined)
    107 */
    108#define TEP_PLUGIN_LOADER tep_plugin_loader
    109#define TEP_PLUGIN_UNLOADER tep_plugin_unloader
    110#define TEP_PLUGIN_OPTIONS tep_plugin_options
    111#define TEP_PLUGIN_ALIAS tep_plugin_alias
    112#define _MAKE_STR(x)	#x
    113#define MAKE_STR(x)	_MAKE_STR(x)
    114#define TEP_PLUGIN_LOADER_NAME MAKE_STR(TEP_PLUGIN_LOADER)
    115#define TEP_PLUGIN_UNLOADER_NAME MAKE_STR(TEP_PLUGIN_UNLOADER)
    116#define TEP_PLUGIN_OPTIONS_NAME MAKE_STR(TEP_PLUGIN_OPTIONS)
    117#define TEP_PLUGIN_ALIAS_NAME MAKE_STR(TEP_PLUGIN_ALIAS)
    118
    119enum tep_format_flags {
    120	TEP_FIELD_IS_ARRAY	= 1,
    121	TEP_FIELD_IS_POINTER	= 2,
    122	TEP_FIELD_IS_SIGNED	= 4,
    123	TEP_FIELD_IS_STRING	= 8,
    124	TEP_FIELD_IS_DYNAMIC	= 16,
    125	TEP_FIELD_IS_LONG	= 32,
    126	TEP_FIELD_IS_FLAG	= 64,
    127	TEP_FIELD_IS_SYMBOLIC	= 128,
    128	TEP_FIELD_IS_RELATIVE	= 256,
    129};
    130
    131struct tep_format_field {
    132	struct tep_format_field	*next;
    133	struct tep_event	*event;
    134	char			*type;
    135	char			*name;
    136	char			*alias;
    137	int			offset;
    138	int			size;
    139	unsigned int		arraylen;
    140	unsigned int		elementsize;
    141	unsigned long		flags;
    142};
    143
    144struct tep_format {
    145	int			nr_common;
    146	int			nr_fields;
    147	struct tep_format_field	*common_fields;
    148	struct tep_format_field	*fields;
    149};
    150
    151struct tep_print_arg_atom {
    152	char			*atom;
    153};
    154
    155struct tep_print_arg_string {
    156	char			*string;
    157	struct tep_format_field *field;
    158};
    159
    160struct tep_print_arg_bitmask {
    161	char			*bitmask;
    162	struct tep_format_field *field;
    163};
    164
    165struct tep_print_arg_field {
    166	char			*name;
    167	struct tep_format_field	*field;
    168};
    169
    170struct tep_print_flag_sym {
    171	struct tep_print_flag_sym	*next;
    172	char				*value;
    173	char				*str;
    174};
    175
    176struct tep_print_arg_typecast {
    177	char 			*type;
    178	struct tep_print_arg	*item;
    179};
    180
    181struct tep_print_arg_flags {
    182	struct tep_print_arg		*field;
    183	char				*delim;
    184	struct tep_print_flag_sym	*flags;
    185};
    186
    187struct tep_print_arg_symbol {
    188	struct tep_print_arg		*field;
    189	struct tep_print_flag_sym	*symbols;
    190};
    191
    192struct tep_print_arg_hex {
    193	struct tep_print_arg	*field;
    194	struct tep_print_arg	*size;
    195};
    196
    197struct tep_print_arg_int_array {
    198	struct tep_print_arg	*field;
    199	struct tep_print_arg	*count;
    200	struct tep_print_arg	*el_size;
    201};
    202
    203struct tep_print_arg_dynarray {
    204	struct tep_format_field	*field;
    205	struct tep_print_arg	*index;
    206};
    207
    208struct tep_print_arg;
    209
    210struct tep_print_arg_op {
    211	char			*op;
    212	int			prio;
    213	struct tep_print_arg	*left;
    214	struct tep_print_arg	*right;
    215};
    216
    217struct tep_function_handler;
    218
    219struct tep_print_arg_func {
    220	struct tep_function_handler	*func;
    221	struct tep_print_arg		*args;
    222};
    223
    224enum tep_print_arg_type {
    225	TEP_PRINT_NULL,
    226	TEP_PRINT_ATOM,
    227	TEP_PRINT_FIELD,
    228	TEP_PRINT_FLAGS,
    229	TEP_PRINT_SYMBOL,
    230	TEP_PRINT_HEX,
    231	TEP_PRINT_INT_ARRAY,
    232	TEP_PRINT_TYPE,
    233	TEP_PRINT_STRING,
    234	TEP_PRINT_BSTRING,
    235	TEP_PRINT_DYNAMIC_ARRAY,
    236	TEP_PRINT_OP,
    237	TEP_PRINT_FUNC,
    238	TEP_PRINT_BITMASK,
    239	TEP_PRINT_DYNAMIC_ARRAY_LEN,
    240	TEP_PRINT_HEX_STR,
    241};
    242
    243struct tep_print_arg {
    244	struct tep_print_arg		*next;
    245	enum tep_print_arg_type		type;
    246	union {
    247		struct tep_print_arg_atom	atom;
    248		struct tep_print_arg_field	field;
    249		struct tep_print_arg_typecast	typecast;
    250		struct tep_print_arg_flags	flags;
    251		struct tep_print_arg_symbol	symbol;
    252		struct tep_print_arg_hex	hex;
    253		struct tep_print_arg_int_array	int_array;
    254		struct tep_print_arg_func	func;
    255		struct tep_print_arg_string	string;
    256		struct tep_print_arg_bitmask	bitmask;
    257		struct tep_print_arg_op		op;
    258		struct tep_print_arg_dynarray	dynarray;
    259	};
    260};
    261
    262struct tep_print_parse;
    263
    264struct tep_print_fmt {
    265	char			*format;
    266	struct tep_print_arg	*args;
    267	struct tep_print_parse	*print_cache;
    268};
    269
    270struct tep_event {
    271	struct tep_handle	*tep;
    272	char			*name;
    273	int			id;
    274	int			flags;
    275	struct tep_format	format;
    276	struct tep_print_fmt	print_fmt;
    277	char			*system;
    278	tep_event_handler_func	handler;
    279	void			*context;
    280};
    281
    282enum {
    283	TEP_EVENT_FL_ISFTRACE	= 0x01,
    284	TEP_EVENT_FL_ISPRINT	= 0x02,
    285	TEP_EVENT_FL_ISBPRINT	= 0x04,
    286	TEP_EVENT_FL_ISFUNCENT	= 0x10,
    287	TEP_EVENT_FL_ISFUNCRET	= 0x20,
    288	TEP_EVENT_FL_NOHANDLE	= 0x40,
    289	TEP_EVENT_FL_PRINTRAW	= 0x80,
    290
    291	TEP_EVENT_FL_FAILED	= 0x80000000
    292};
    293
    294enum tep_event_sort_type {
    295	TEP_EVENT_SORT_ID,
    296	TEP_EVENT_SORT_NAME,
    297	TEP_EVENT_SORT_SYSTEM,
    298};
    299
    300enum tep_event_type {
    301	TEP_EVENT_ERROR,
    302	TEP_EVENT_NONE,
    303	TEP_EVENT_SPACE,
    304	TEP_EVENT_NEWLINE,
    305	TEP_EVENT_OP,
    306	TEP_EVENT_DELIM,
    307	TEP_EVENT_ITEM,
    308	TEP_EVENT_DQUOTE,
    309	TEP_EVENT_SQUOTE,
    310};
    311
    312typedef unsigned long long (*tep_func_handler)(struct trace_seq *s,
    313					       unsigned long long *args);
    314
    315enum tep_func_arg_type {
    316	TEP_FUNC_ARG_VOID,
    317	TEP_FUNC_ARG_INT,
    318	TEP_FUNC_ARG_LONG,
    319	TEP_FUNC_ARG_STRING,
    320	TEP_FUNC_ARG_PTR,
    321	TEP_FUNC_ARG_MAX_TYPES
    322};
    323
    324enum tep_flag {
    325	TEP_NSEC_OUTPUT		= 1,	/* output in NSECS */
    326	TEP_DISABLE_SYS_PLUGINS	= 1 << 1,
    327	TEP_DISABLE_PLUGINS	= 1 << 2,
    328};
    329
    330#define TEP_ERRORS 							      \
    331	_PE(MEM_ALLOC_FAILED,	"failed to allocate memory"),		      \
    332	_PE(PARSE_EVENT_FAILED,	"failed to parse event"),		      \
    333	_PE(READ_ID_FAILED,	"failed to read event id"),		      \
    334	_PE(READ_FORMAT_FAILED,	"failed to read event format"),		      \
    335	_PE(READ_PRINT_FAILED,	"failed to read event print fmt"), 	      \
    336	_PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
    337	_PE(INVALID_ARG_TYPE,	"invalid argument type"),		      \
    338	_PE(INVALID_EXP_TYPE,	"invalid expression type"),		      \
    339	_PE(INVALID_OP_TYPE,	"invalid operator type"),		      \
    340	_PE(INVALID_EVENT_NAME,	"invalid event name"),			      \
    341	_PE(EVENT_NOT_FOUND,	"no event found"),			      \
    342	_PE(SYNTAX_ERROR,	"syntax error"),			      \
    343	_PE(ILLEGAL_RVALUE,	"illegal rvalue"),			      \
    344	_PE(ILLEGAL_LVALUE,	"illegal lvalue for string comparison"),      \
    345	_PE(INVALID_REGEX,	"regex did not compute"),		      \
    346	_PE(ILLEGAL_STRING_CMP,	"illegal comparison for string"), 	      \
    347	_PE(ILLEGAL_INTEGER_CMP,"illegal comparison for integer"), 	      \
    348	_PE(REPARENT_NOT_OP,	"cannot reparent other than OP"),	      \
    349	_PE(REPARENT_FAILED,	"failed to reparent filter OP"),	      \
    350	_PE(BAD_FILTER_ARG,	"bad arg in filter tree"),		      \
    351	_PE(UNEXPECTED_TYPE,	"unexpected type (not a value)"),	      \
    352	_PE(ILLEGAL_TOKEN,	"illegal token"),			      \
    353	_PE(INVALID_PAREN,	"open parenthesis cannot come here"), 	      \
    354	_PE(UNBALANCED_PAREN,	"unbalanced number of parenthesis"),	      \
    355	_PE(UNKNOWN_TOKEN,	"unknown token"),			      \
    356	_PE(FILTER_NOT_FOUND,	"no filter found"),			      \
    357	_PE(NOT_A_NUMBER,	"must have number field"),		      \
    358	_PE(NO_FILTER,		"no filters exists"),			      \
    359	_PE(FILTER_MISS,	"record does not match to filter")
    360
    361#undef _PE
    362#define _PE(__code, __str) TEP_ERRNO__ ## __code
    363enum tep_errno {
    364	TEP_ERRNO__SUCCESS			= 0,
    365	TEP_ERRNO__FILTER_MATCH			= TEP_ERRNO__SUCCESS,
    366
    367	/*
    368	 * Choose an arbitrary negative big number not to clash with standard
    369	 * errno since SUS requires the errno has distinct positive values.
    370	 * See 'Issue 6' in the link below.
    371	 *
    372	 * https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
    373	 */
    374	__TEP_ERRNO__START			= -100000,
    375
    376	TEP_ERRORS,
    377
    378	__TEP_ERRNO__END,
    379};
    380#undef _PE
    381
    382struct tep_plugin_list;
    383
    384#define INVALID_PLUGIN_LIST_OPTION	((char **)((unsigned long)-1))
    385
    386enum tep_plugin_load_priority {
    387	TEP_PLUGIN_FIRST,
    388	TEP_PLUGIN_LAST,
    389};
    390
    391int tep_add_plugin_path(struct tep_handle *tep, char *path,
    392			enum tep_plugin_load_priority prio);
    393struct tep_plugin_list *tep_load_plugins(struct tep_handle *tep);
    394void tep_unload_plugins(struct tep_plugin_list *plugin_list,
    395			struct tep_handle *tep);
    396void tep_load_plugins_hook(struct tep_handle *tep, const char *suffix,
    397			   void (*load_plugin)(struct tep_handle *tep,
    398					       const char *path,
    399					       const char *name,
    400					       void *data),
    401			   void *data);
    402char **tep_plugin_list_options(void);
    403void tep_plugin_free_options_list(char **list);
    404int tep_plugin_add_options(const char *name,
    405			   struct tep_plugin_option *options);
    406int tep_plugin_add_option(const char *name, const char *val);
    407void tep_plugin_remove_options(struct tep_plugin_option *options);
    408void tep_plugin_print_options(struct trace_seq *s);
    409void tep_print_plugins(struct trace_seq *s,
    410			const char *prefix, const char *suffix,
    411			const struct tep_plugin_list *list);
    412
    413/* tep_handle */
    414typedef char *(tep_func_resolver_t)(void *priv,
    415				    unsigned long long *addrp, char **modp);
    416void tep_set_flag(struct tep_handle *tep, int flag);
    417void tep_clear_flag(struct tep_handle *tep, enum tep_flag flag);
    418bool tep_test_flag(struct tep_handle *tep, enum tep_flag flags);
    419
    420static inline int tep_is_bigendian(void)
    421{
    422	unsigned char str[] = { 0x1, 0x2, 0x3, 0x4 };
    423	unsigned int val;
    424
    425	memcpy(&val, str, 4);
    426	return val == 0x01020304;
    427}
    428
    429/* taken from kernel/trace/trace.h */
    430enum trace_flag_type {
    431	TRACE_FLAG_IRQS_OFF		= 0x01,
    432	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
    433	TRACE_FLAG_NEED_RESCHED		= 0x04,
    434	TRACE_FLAG_HARDIRQ		= 0x08,
    435	TRACE_FLAG_SOFTIRQ		= 0x10,
    436};
    437
    438int tep_set_function_resolver(struct tep_handle *tep,
    439			      tep_func_resolver_t *func, void *priv);
    440void tep_reset_function_resolver(struct tep_handle *tep);
    441int tep_register_comm(struct tep_handle *tep, const char *comm, int pid);
    442int tep_override_comm(struct tep_handle *tep, const char *comm, int pid);
    443int tep_register_function(struct tep_handle *tep, char *name,
    444			  unsigned long long addr, char *mod);
    445int tep_register_print_string(struct tep_handle *tep, const char *fmt,
    446			      unsigned long long addr);
    447bool tep_is_pid_registered(struct tep_handle *tep, int pid);
    448
    449struct tep_event *tep_get_event(struct tep_handle *tep, int index);
    450
    451#define TEP_PRINT_INFO		"INFO"
    452#define TEP_PRINT_INFO_RAW	"INFO_RAW"
    453#define TEP_PRINT_COMM		"COMM"
    454#define TEP_PRINT_LATENCY	"LATENCY"
    455#define TEP_PRINT_NAME		"NAME"
    456#define TEP_PRINT_PID		1U
    457#define TEP_PRINT_TIME		2U
    458#define TEP_PRINT_CPU		3U
    459
    460void tep_print_event(struct tep_handle *tep, struct trace_seq *s,
    461		     struct tep_record *record, const char *fmt, ...)
    462	__attribute__ ((format (printf, 4, 5)));
    463
    464int tep_parse_header_page(struct tep_handle *tep, char *buf, unsigned long size,
    465			  int long_size);
    466
    467enum tep_errno tep_parse_event(struct tep_handle *tep, const char *buf,
    468			       unsigned long size, const char *sys);
    469enum tep_errno tep_parse_format(struct tep_handle *tep,
    470				struct tep_event **eventp,
    471				const char *buf,
    472				unsigned long size, const char *sys);
    473
    474void *tep_get_field_raw(struct trace_seq *s, struct tep_event *event,
    475			const char *name, struct tep_record *record,
    476			int *len, int err);
    477
    478int tep_get_field_val(struct trace_seq *s, struct tep_event *event,
    479		      const char *name, struct tep_record *record,
    480		      unsigned long long *val, int err);
    481int tep_get_common_field_val(struct trace_seq *s, struct tep_event *event,
    482			     const char *name, struct tep_record *record,
    483			     unsigned long long *val, int err);
    484int tep_get_any_field_val(struct trace_seq *s, struct tep_event *event,
    485			  const char *name, struct tep_record *record,
    486			  unsigned long long *val, int err);
    487
    488int tep_print_num_field(struct trace_seq *s, const char *fmt,
    489			struct tep_event *event, const char *name,
    490			struct tep_record *record, int err);
    491
    492int tep_print_func_field(struct trace_seq *s, const char *fmt,
    493			 struct tep_event *event, const char *name,
    494			 struct tep_record *record, int err);
    495
    496enum tep_reg_handler {
    497	TEP_REGISTER_SUCCESS = 0,
    498	TEP_REGISTER_SUCCESS_OVERWRITE,
    499};
    500
    501int tep_register_event_handler(struct tep_handle *tep, int id,
    502			       const char *sys_name, const char *event_name,
    503			       tep_event_handler_func func, void *context);
    504int tep_unregister_event_handler(struct tep_handle *tep, int id,
    505				 const char *sys_name, const char *event_name,
    506				 tep_event_handler_func func, void *context);
    507int tep_register_print_function(struct tep_handle *tep,
    508				tep_func_handler func,
    509				enum tep_func_arg_type ret_type,
    510				char *name, ...);
    511int tep_unregister_print_function(struct tep_handle *tep,
    512				  tep_func_handler func, char *name);
    513
    514struct tep_format_field *tep_find_common_field(struct tep_event *event, const char *name);
    515struct tep_format_field *tep_find_field(struct tep_event *event, const char *name);
    516struct tep_format_field *tep_find_any_field(struct tep_event *event, const char *name);
    517
    518const char *tep_find_function(struct tep_handle *tep, unsigned long long addr);
    519unsigned long long
    520tep_find_function_address(struct tep_handle *tep, unsigned long long addr);
    521unsigned long long tep_read_number(struct tep_handle *tep, const void *ptr, int size);
    522int tep_read_number_field(struct tep_format_field *field, const void *data,
    523			  unsigned long long *value);
    524
    525struct tep_event *tep_get_first_event(struct tep_handle *tep);
    526int tep_get_events_count(struct tep_handle *tep);
    527struct tep_event *tep_find_event(struct tep_handle *tep, int id);
    528
    529struct tep_event *
    530tep_find_event_by_name(struct tep_handle *tep, const char *sys, const char *name);
    531struct tep_event *
    532tep_find_event_by_record(struct tep_handle *tep, struct tep_record *record);
    533
    534int tep_data_type(struct tep_handle *tep, struct tep_record *rec);
    535int tep_data_pid(struct tep_handle *tep, struct tep_record *rec);
    536int tep_data_preempt_count(struct tep_handle *tep, struct tep_record *rec);
    537int tep_data_flags(struct tep_handle *tep, struct tep_record *rec);
    538const char *tep_data_comm_from_pid(struct tep_handle *tep, int pid);
    539struct tep_cmdline;
    540struct tep_cmdline *tep_data_pid_from_comm(struct tep_handle *tep, const char *comm,
    541					   struct tep_cmdline *next);
    542int tep_cmdline_pid(struct tep_handle *tep, struct tep_cmdline *cmdline);
    543
    544void tep_print_field(struct trace_seq *s, void *data,
    545		     struct tep_format_field *field);
    546void tep_print_fields(struct trace_seq *s, void *data,
    547		      int size __maybe_unused, struct tep_event *event);
    548int tep_strerror(struct tep_handle *tep, enum tep_errno errnum,
    549		 char *buf, size_t buflen);
    550
    551struct tep_event **tep_list_events(struct tep_handle *tep, enum tep_event_sort_type);
    552struct tep_event **tep_list_events_copy(struct tep_handle *tep,
    553					enum tep_event_sort_type);
    554struct tep_format_field **tep_event_common_fields(struct tep_event *event);
    555struct tep_format_field **tep_event_fields(struct tep_event *event);
    556
    557enum tep_endian {
    558        TEP_LITTLE_ENDIAN = 0,
    559        TEP_BIG_ENDIAN
    560};
    561int tep_get_cpus(struct tep_handle *tep);
    562void tep_set_cpus(struct tep_handle *tep, int cpus);
    563int tep_get_long_size(struct tep_handle *tep);
    564void tep_set_long_size(struct tep_handle *tep, int long_size);
    565int tep_get_page_size(struct tep_handle *tep);
    566void tep_set_page_size(struct tep_handle *tep, int _page_size);
    567bool tep_is_file_bigendian(struct tep_handle *tep);
    568void tep_set_file_bigendian(struct tep_handle *tep, enum tep_endian endian);
    569bool tep_is_local_bigendian(struct tep_handle *tep);
    570void tep_set_local_bigendian(struct tep_handle *tep, enum tep_endian endian);
    571int tep_get_header_page_size(struct tep_handle *tep);
    572int tep_get_header_timestamp_size(struct tep_handle *tep);
    573bool tep_is_old_format(struct tep_handle *tep);
    574void tep_set_test_filters(struct tep_handle *tep, int test_filters);
    575
    576struct tep_handle *tep_alloc(void);
    577void tep_free(struct tep_handle *tep);
    578void tep_ref(struct tep_handle *tep);
    579void tep_unref(struct tep_handle *tep);
    580int tep_get_ref(struct tep_handle *tep);
    581
    582/* for debugging */
    583void tep_print_funcs(struct tep_handle *tep);
    584void tep_print_printk(struct tep_handle *tep);
    585
    586/* ----------------------- filtering ----------------------- */
    587
    588enum tep_filter_boolean_type {
    589	TEP_FILTER_FALSE,
    590	TEP_FILTER_TRUE,
    591};
    592
    593enum tep_filter_op_type {
    594	TEP_FILTER_OP_AND = 1,
    595	TEP_FILTER_OP_OR,
    596	TEP_FILTER_OP_NOT,
    597};
    598
    599enum tep_filter_cmp_type {
    600	TEP_FILTER_CMP_NONE,
    601	TEP_FILTER_CMP_EQ,
    602	TEP_FILTER_CMP_NE,
    603	TEP_FILTER_CMP_GT,
    604	TEP_FILTER_CMP_LT,
    605	TEP_FILTER_CMP_GE,
    606	TEP_FILTER_CMP_LE,
    607	TEP_FILTER_CMP_MATCH,
    608	TEP_FILTER_CMP_NOT_MATCH,
    609	TEP_FILTER_CMP_REGEX,
    610	TEP_FILTER_CMP_NOT_REGEX,
    611};
    612
    613enum tep_filter_exp_type {
    614	TEP_FILTER_EXP_NONE,
    615	TEP_FILTER_EXP_ADD,
    616	TEP_FILTER_EXP_SUB,
    617	TEP_FILTER_EXP_MUL,
    618	TEP_FILTER_EXP_DIV,
    619	TEP_FILTER_EXP_MOD,
    620	TEP_FILTER_EXP_RSHIFT,
    621	TEP_FILTER_EXP_LSHIFT,
    622	TEP_FILTER_EXP_AND,
    623	TEP_FILTER_EXP_OR,
    624	TEP_FILTER_EXP_XOR,
    625	TEP_FILTER_EXP_NOT,
    626};
    627
    628enum tep_filter_arg_type {
    629	TEP_FILTER_ARG_NONE,
    630	TEP_FILTER_ARG_BOOLEAN,
    631	TEP_FILTER_ARG_VALUE,
    632	TEP_FILTER_ARG_FIELD,
    633	TEP_FILTER_ARG_EXP,
    634	TEP_FILTER_ARG_OP,
    635	TEP_FILTER_ARG_NUM,
    636	TEP_FILTER_ARG_STR,
    637};
    638
    639enum tep_filter_value_type {
    640	TEP_FILTER_NUMBER,
    641	TEP_FILTER_STRING,
    642	TEP_FILTER_CHAR
    643};
    644
    645struct tep_filter_arg;
    646
    647struct tep_filter_arg_boolean {
    648	enum tep_filter_boolean_type	value;
    649};
    650
    651struct tep_filter_arg_field {
    652	struct tep_format_field		*field;
    653};
    654
    655struct tep_filter_arg_value {
    656	enum tep_filter_value_type	type;
    657	union {
    658		char			*str;
    659		unsigned long long	val;
    660	};
    661};
    662
    663struct tep_filter_arg_op {
    664	enum tep_filter_op_type		type;
    665	struct tep_filter_arg		*left;
    666	struct tep_filter_arg		*right;
    667};
    668
    669struct tep_filter_arg_exp {
    670	enum tep_filter_exp_type	type;
    671	struct tep_filter_arg		*left;
    672	struct tep_filter_arg		*right;
    673};
    674
    675struct tep_filter_arg_num {
    676	enum tep_filter_cmp_type	type;
    677	struct tep_filter_arg		*left;
    678	struct tep_filter_arg		*right;
    679};
    680
    681struct tep_filter_arg_str {
    682	enum tep_filter_cmp_type	type;
    683	struct tep_format_field		*field;
    684	char				*val;
    685	char				*buffer;
    686	regex_t				reg;
    687};
    688
    689struct tep_filter_arg {
    690	enum tep_filter_arg_type		type;
    691	union {
    692		struct tep_filter_arg_boolean	boolean;
    693		struct tep_filter_arg_field	field;
    694		struct tep_filter_arg_value	value;
    695		struct tep_filter_arg_op	op;
    696		struct tep_filter_arg_exp	exp;
    697		struct tep_filter_arg_num	num;
    698		struct tep_filter_arg_str	str;
    699	};
    700};
    701
    702struct tep_filter_type {
    703	int			event_id;
    704	struct tep_event	*event;
    705	struct tep_filter_arg	*filter;
    706};
    707
    708#define TEP_FILTER_ERROR_BUFSZ  1024
    709
    710struct tep_event_filter {
    711	struct tep_handle	*tep;
    712	int			filters;
    713	struct tep_filter_type	*event_filters;
    714	char			error_buffer[TEP_FILTER_ERROR_BUFSZ];
    715};
    716
    717struct tep_event_filter *tep_filter_alloc(struct tep_handle *tep);
    718
    719/* for backward compatibility */
    720#define FILTER_NONE		TEP_ERRNO__NO_FILTER
    721#define FILTER_NOEXIST		TEP_ERRNO__FILTER_NOT_FOUND
    722#define FILTER_MISS		TEP_ERRNO__FILTER_MISS
    723#define FILTER_MATCH		TEP_ERRNO__FILTER_MATCH
    724
    725enum tep_errno tep_filter_add_filter_str(struct tep_event_filter *filter,
    726					 const char *filter_str);
    727
    728enum tep_errno tep_filter_match(struct tep_event_filter *filter,
    729				struct tep_record *record);
    730
    731int tep_filter_strerror(struct tep_event_filter *filter, enum tep_errno err,
    732			char *buf, size_t buflen);
    733
    734int tep_event_filtered(struct tep_event_filter *filter,
    735		       int event_id);
    736
    737void tep_filter_reset(struct tep_event_filter *filter);
    738
    739void tep_filter_free(struct tep_event_filter *filter);
    740
    741char *tep_filter_make_string(struct tep_event_filter *filter, int event_id);
    742
    743int tep_filter_remove_event(struct tep_event_filter *filter,
    744			    int event_id);
    745
    746int tep_filter_copy(struct tep_event_filter *dest, struct tep_event_filter *source);
    747
    748int tep_filter_compare(struct tep_event_filter *filter1, struct tep_event_filter *filter2);
    749
    750#endif /* _PARSE_EVENTS_H */