[lttng-tools.git] / src / common / 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 <stdio.h>
#include <stdint.h>

#if defined(__cplusplus)
extern "C" {
#endif

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

enum ast_expt_type {
	AST_EXP_UNKNOWN = 0,
	AST_EXP_STRING,
	AST_EXP_CONSTANT,
	AST_EXP_FLOAT_CONSTANT,
	AST_EXP_IDENTIFIER,
	AST_EXP_GLOBAL_IDENTIFIER,
	AST_EXP_NESTED,
};

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 {
			/* Avoid -Wextern-c-compat warning with clang++. */
			char unused;
		} unknown;
		struct {
			struct filter_node *child;
		} root;
		struct {
			enum ast_expt_type type;
			enum ast_link_type post_op;	/* reverse */
			enum ast_link_type pre_op;	/* forward */
			union {
				const char *string;
				uint64_t constant;
				double float_constant;
				const 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_bytecode_alloc *bytecode;
	struct lttng_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);
int filter_parser_ctx_create_from_filter_expression(
		const char *filter_expression, struct filter_parser_ctx **ctxp);

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

#if defined(__cplusplus)
}
#endif

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