[lttng-tools.git] / src / lib / lttng-ctl / filter / filter-ast.h

#ifndef _FILTER_AST_H
#define _FILTER_AST_H

/*
 * filter-ast.h
 *
 * LTTng filter AST
 *
 * Copyright 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

/*
 * Note: filter-ast.h should be included before filter-parser.h.
 */

#include <urcu/list.h>
#include <stdint.h>

#define printf_debug(fmt, args...)					\
	do {								\
		if (filter_parser_debug)				\
			fprintf(stdout, "[debug] " fmt, ## args);	\
	} while (0)

// the parameter name (of the reentrant 'yyparse' function)
// data is a pointer to a 'SParserParam' structure
//#define YYPARSE_PARAM	parser_ctx

#ifndef YY_TYPEDEF_YY_SCANNER_T
#define YY_TYPEDEF_YY_SCANNER_T
typedef void* yyscan_t;
#endif

extern int filter_parser_debug;

struct filter_node;
struct filter_parser;

enum node_type {
	NODE_UNKNOWN = 0,
	NODE_ROOT,

	NODE_EXPRESSION,
	NODE_OP,
	NODE_UNARY_OP,

	NR_NODE_TYPES,
};

enum op_type {
	AST_OP_UNKNOWN = 0,
	AST_OP_MUL,
	AST_OP_DIV,
	AST_OP_MOD,
	AST_OP_PLUS,
	AST_OP_MINUS,
	AST_OP_BIT_RSHIFT,
	AST_OP_BIT_LSHIFT,
	AST_OP_AND,
	AST_OP_OR,
	AST_OP_BIT_AND,
	AST_OP_BIT_OR,
	AST_OP_BIT_XOR,

	AST_OP_EQ,
	AST_OP_NE,
	AST_OP_GT,
	AST_OP_LT,
	AST_OP_GE,
	AST_OP_LE,
};

enum unary_op_type {
	AST_UNARY_UNKNOWN = 0,
	AST_UNARY_PLUS,
	AST_UNARY_MINUS,
	AST_UNARY_NOT,
	AST_UNARY_BIT_NOT,
};

enum ast_link_type {
	AST_LINK_UNKNOWN = 0,
	AST_LINK_DOT,
	AST_LINK_RARROW,
	AST_LINK_BRACKET,
};

struct filter_node {
	/*
	 * Parent node is only set on demand by specific visitor.
	 */
	struct filter_node *parent;
	struct cds_list_head gc;

	enum node_type type;
	union {
		struct {
		} unknown;
		struct {
			struct filter_node *child;
		} root;
		struct {
			enum {
				AST_EXP_UNKNOWN = 0,
				AST_EXP_STRING,
				AST_EXP_CONSTANT,
				AST_EXP_FLOAT_CONSTANT,
				AST_EXP_IDENTIFIER,
				AST_EXP_GLOBAL_IDENTIFIER,
				AST_EXP_NESTED,
			} type;
			enum ast_link_type post_op;	/* reverse */
			enum ast_link_type pre_op;	/* forward */
			union {
				char *string;
				uint64_t constant;
				double float_constant;
				char *identifier;
				/*
				 * child can be nested.
				 */
				struct filter_node *child;
			} u;
			/* prev: backward dot/arrow chain (postfix expression) */
			struct filter_node *prev;
			/* next: forward dot/arrow chain, generated by a visitor. */
			struct filter_node *next;
			/* next_bracket: linked bracket chain (prefix expression) */
			struct filter_node *next_bracket;
		} expression;
		struct {
			enum op_type type;
			struct filter_node *lchild;
			struct filter_node *rchild;
		} op;
		struct {
			enum unary_op_type type;
			struct filter_node *child;
		} unary_op;
	} u;
};

struct filter_ast {
	struct filter_node root;
	struct cds_list_head allocated_nodes;
};

const char *node_type(struct filter_node *node);

struct ir_op;

struct filter_parser_ctx {
	yyscan_t scanner;
	struct filter_ast *ast;
	struct cds_list_head allocated_strings;
	struct ir_op *ir_root;
	struct lttng_filter_bytecode_alloc *bytecode;
	struct lttng_filter_bytecode_alloc *bytecode_reloc;
};

struct filter_parser_ctx *filter_parser_ctx_alloc(FILE *input);
void filter_parser_ctx_free(struct filter_parser_ctx *parser_ctx);
int filter_parser_ctx_append_ast(struct filter_parser_ctx *parser_ctx);

static inline
struct filter_ast *filter_parser_get_ast(struct filter_parser_ctx *parser_ctx)
{
	return parser_ctx->ast;
}

int filter_visitor_print_xml(struct filter_parser_ctx *ctx, FILE *stream,
			int indent);
int filter_visitor_ir_generate(struct filter_parser_ctx *ctx);
void filter_ir_free(struct filter_parser_ctx *ctx);
int filter_visitor_bytecode_generate(struct filter_parser_ctx *ctx);
void filter_bytecode_free(struct filter_parser_ctx *ctx);
int filter_visitor_ir_check_binary_op_nesting(struct filter_parser_ctx *ctx);
int filter_visitor_ir_check_binary_comparator(struct filter_parser_ctx *ctx);
int filter_visitor_ir_validate_string(struct filter_parser_ctx *ctx);
int filter_visitor_ir_normalize_glob_patterns(struct filter_parser_ctx *ctx);
int filter_visitor_ir_validate_globbing(struct filter_parser_ctx *ctx);

#endif /* _FILTER_AST_H */
Commit	Line	Data
953192ba MD	1	#ifndef _FILTER_AST_H
	2	#define _FILTER_AST_H
	3
	4	/*
	5	* filter-ast.h
	6	*
	7	* LTTng filter AST
	8	*
ab5be9fa	9	* Copyright 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
953192ba	10	*
ab5be9fa	11	* SPDX-License-Identifier: LGPL-2.1-only
953192ba	12	*
953192ba MD	13	*/
953192ba MD	14
95b9bd90 MD	15	/*
	16	* Note: filter-ast.h should be included before filter-parser.h.
	17	*/
	18
953192ba MD	19	#include <urcu/list.h>
	20	#include <stdint.h>
	21
	22	#define printf_debug(fmt, args...) \
	23	do { \
	24	if (filter_parser_debug) \
	25	fprintf(stdout, "[debug] " fmt, ## args); \
	26	} while (0)
	27
af71d06b MD	28	// the parameter name (of the reentrant 'yyparse' function)
	29	// data is a pointer to a 'SParserParam' structure
	30	//#define YYPARSE_PARAM parser_ctx
	31
953192ba MD	32	#ifndef YY_TYPEDEF_YY_SCANNER_T
	33	#define YY_TYPEDEF_YY_SCANNER_T
	34	typedef void* yyscan_t;
	35	#endif
	36
	37	extern int filter_parser_debug;
	38
	39	struct filter_node;
	40	struct filter_parser;
	41
	42	enum node_type {
	43	NODE_UNKNOWN = 0,
	44	NODE_ROOT,
	45
	46	NODE_EXPRESSION,
	47	NODE_OP,
	48	NODE_UNARY_OP,
	49
	50	NR_NODE_TYPES,
	51	};
	52
	53	enum op_type {
	54	AST_OP_UNKNOWN = 0,
	55	AST_OP_MUL,
	56	AST_OP_DIV,
	57	AST_OP_MOD,
	58	AST_OP_PLUS,
	59	AST_OP_MINUS,
116d3c01 MD	60	AST_OP_BIT_RSHIFT,
116d3c01 MD	61	AST_OP_BIT_LSHIFT,
953192ba MD	62	AST_OP_AND,
953192ba MD	63	AST_OP_OR,
bff988fa MD	64	AST_OP_BIT_AND,
	65	AST_OP_BIT_OR,
	66	AST_OP_BIT_XOR,
953192ba MD	67
	68	AST_OP_EQ,
	69	AST_OP_NE,
	70	AST_OP_GT,
	71	AST_OP_LT,
	72	AST_OP_GE,
	73	AST_OP_LE,
	74	};
	75
	76	enum unary_op_type {
	77	AST_UNARY_UNKNOWN = 0,
	78	AST_UNARY_PLUS,
	79	AST_UNARY_MINUS,
	80	AST_UNARY_NOT,
bff988fa	81	AST_UNARY_BIT_NOT,
953192ba MD	82	};
	83
	84	enum ast_link_type {
	85	AST_LINK_UNKNOWN = 0,
	86	AST_LINK_DOT,
	87	AST_LINK_RARROW,
661dfdd1	88	AST_LINK_BRACKET,
953192ba MD	89	};
	90
	91	struct filter_node {
	92	/*
	93	* Parent node is only set on demand by specific visitor.
	94	*/
	95	struct filter_node *parent;
	96	struct cds_list_head gc;
	97
	98	enum node_type type;
	99	union {
	100	struct {
	101	} unknown;
	102	struct {
	103	struct filter_node *child;
	104	} root;
	105	struct {
	106	enum {
	107	AST_EXP_UNKNOWN = 0,
	108	AST_EXP_STRING,
	109	AST_EXP_CONSTANT,
e90d8561	110	AST_EXP_FLOAT_CONSTANT,
953192ba	111	AST_EXP_IDENTIFIER,
586dc72f	112	AST_EXP_GLOBAL_IDENTIFIER,
953192ba MD	113	AST_EXP_NESTED,
	114	} type;
	115	enum ast_link_type post_op; /* reverse */
	116	enum ast_link_type pre_op; /* forward */
	117	union {
	118	char *string;
	119	uint64_t constant;
e90d8561	120	double float_constant;
953192ba MD	121	char *identifier;
	122	/*
	123	* child can be nested.
	124	*/
	125	struct filter_node *child;
	126	} u;
bff988fa	127	/* prev: backward dot/arrow chain (postfix expression) */
953192ba	128	struct filter_node *prev;
bff988fa	129	/* next: forward dot/arrow chain, generated by a visitor. */
953192ba	130	struct filter_node *next;
bff988fa MD	131	/* next_bracket: linked bracket chain (prefix expression) */
bff988fa MD	132	struct filter_node *next_bracket;
953192ba MD	133	} expression;
	134	struct {
	135	enum op_type type;
	136	struct filter_node *lchild;
	137	struct filter_node *rchild;
	138	} op;
	139	struct {
	140	enum unary_op_type type;
	141	struct filter_node *child;
	142	} unary_op;
	143	} u;
	144	};
	145
	146	struct filter_ast {
	147	struct filter_node root;
	148	struct cds_list_head allocated_nodes;
	149	};
	150
	151	const char node_type(struct filter_node node);
	152
	153	struct ir_op;
953192ba MD	154
	155	struct filter_parser_ctx {
	156	yyscan_t scanner;
	157	struct filter_ast *ast;
	158	struct cds_list_head allocated_strings;
	159	struct ir_op *ir_root;
53a80697 MD	160	struct lttng_filter_bytecode_alloc *bytecode;
53a80697 MD	161	struct lttng_filter_bytecode_alloc *bytecode_reloc;
953192ba MD	162	};
	163
	164	struct filter_parser_ctx filter_parser_ctx_alloc(FILE input);
	165	void filter_parser_ctx_free(struct filter_parser_ctx *parser_ctx);
	166	int filter_parser_ctx_append_ast(struct filter_parser_ctx *parser_ctx);
	167
	168	static inline
	169	struct filter_ast filter_parser_get_ast(struct filter_parser_ctx parser_ctx)
	170	{
	171	return parser_ctx->ast;
	172	}
	173
953192ba MD	174	int filter_visitor_print_xml(struct filter_parser_ctx ctx, FILE stream,
	175	int indent);
	176	int filter_visitor_ir_generate(struct filter_parser_ctx *ctx);
	177	void filter_ir_free(struct filter_parser_ctx *ctx);
	178	int filter_visitor_bytecode_generate(struct filter_parser_ctx *ctx);
	179	void filter_bytecode_free(struct filter_parser_ctx *ctx);
	180	int filter_visitor_ir_check_binary_op_nesting(struct filter_parser_ctx *ctx);
	181	int filter_visitor_ir_check_binary_comparator(struct filter_parser_ctx *ctx);
dcd5daf2	182	int filter_visitor_ir_validate_string(struct filter_parser_ctx *ctx);
9f449915 PP	183	int filter_visitor_ir_normalize_glob_patterns(struct filter_parser_ctx *ctx);
9f449915 PP	184	int filter_visitor_ir_validate_globbing(struct filter_parser_ctx *ctx);
953192ba MD	185
953192ba MD	186	#endif /* _FILTER_AST_H */