1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 2.00 of the Zend license,     |
8    | that is bundled with this package in the file LICENSE, and is        |
9    | available through the world-wide-web at the following url:           |
10    | http://www.zend.com/license/2_00.txt.                                |
11    | If you did not receive a copy of the Zend license and are unable to  |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@zend.com so we can mail you a copy immediately.              |
14    +----------------------------------------------------------------------+
15    | Authors: Bob Weinand <bwoebi@php.net>                                |
16    |          Dmitry Stogov <dmitry@php.net>                              |
17    |          Nikita Popov <nikic@php.net>                                |
18    +----------------------------------------------------------------------+
19 */
20 
21 #ifndef ZEND_AST_H
22 #define ZEND_AST_H
23 
24 #include "zend.h"
25 
26 #ifndef ZEND_AST_SPEC
27 # define ZEND_AST_SPEC 1
28 #endif
29 
30 #define ZEND_AST_SPECIAL_SHIFT      6
31 #define ZEND_AST_IS_LIST_SHIFT      7
32 #define ZEND_AST_NUM_CHILDREN_SHIFT 8
33 
34 enum _zend_ast_kind {
35 	/* special nodes */
36 	ZEND_AST_ZVAL = 1 << ZEND_AST_SPECIAL_SHIFT,
37 	ZEND_AST_CONSTANT,
38 	ZEND_AST_ZNODE,
39 
40 	/* declaration nodes */
41 	ZEND_AST_FUNC_DECL,
42 	ZEND_AST_CLOSURE,
43 	ZEND_AST_METHOD,
44 	ZEND_AST_CLASS,
45 	ZEND_AST_ARROW_FUNC,
46 
47 	/* list nodes */
48 	ZEND_AST_ARG_LIST = 1 << ZEND_AST_IS_LIST_SHIFT,
49 	ZEND_AST_ARRAY,
50 	ZEND_AST_ENCAPS_LIST,
51 	ZEND_AST_EXPR_LIST,
52 	ZEND_AST_STMT_LIST,
53 	ZEND_AST_IF,
54 	ZEND_AST_SWITCH_LIST,
55 	ZEND_AST_CATCH_LIST,
56 	ZEND_AST_PARAM_LIST,
57 	ZEND_AST_CLOSURE_USES,
58 	ZEND_AST_PROP_DECL,
59 	ZEND_AST_CONST_DECL,
60 	ZEND_AST_CLASS_CONST_DECL,
61 	ZEND_AST_NAME_LIST,
62 	ZEND_AST_TRAIT_ADAPTATIONS,
63 	ZEND_AST_USE,
64 	ZEND_AST_TYPE_UNION,
65 	ZEND_AST_TYPE_INTERSECTION,
66 	ZEND_AST_ATTRIBUTE_LIST,
67 	ZEND_AST_ATTRIBUTE_GROUP,
68 	ZEND_AST_MATCH_ARM_LIST,
69 
70 	/* 0 child nodes */
71 	ZEND_AST_MAGIC_CONST = 0 << ZEND_AST_NUM_CHILDREN_SHIFT,
72 	ZEND_AST_TYPE,
73 	ZEND_AST_CONSTANT_CLASS,
74 	ZEND_AST_CALLABLE_CONVERT,
75 
76 	/* 1 child node */
77 	ZEND_AST_VAR = 1 << ZEND_AST_NUM_CHILDREN_SHIFT,
78 	ZEND_AST_CONST,
79 	ZEND_AST_UNPACK,
80 	ZEND_AST_UNARY_PLUS,
81 	ZEND_AST_UNARY_MINUS,
82 	ZEND_AST_CAST,
83 	ZEND_AST_EMPTY,
84 	ZEND_AST_ISSET,
85 	ZEND_AST_SILENCE,
86 	ZEND_AST_SHELL_EXEC,
87 	ZEND_AST_CLONE,
88 	ZEND_AST_EXIT,
89 	ZEND_AST_PRINT,
90 	ZEND_AST_INCLUDE_OR_EVAL,
91 	ZEND_AST_UNARY_OP,
92 	ZEND_AST_PRE_INC,
93 	ZEND_AST_PRE_DEC,
94 	ZEND_AST_POST_INC,
95 	ZEND_AST_POST_DEC,
96 	ZEND_AST_YIELD_FROM,
97 	ZEND_AST_CLASS_NAME,
98 
99 	ZEND_AST_GLOBAL,
100 	ZEND_AST_UNSET,
101 	ZEND_AST_RETURN,
102 	ZEND_AST_LABEL,
103 	ZEND_AST_REF,
104 	ZEND_AST_HALT_COMPILER,
105 	ZEND_AST_ECHO,
106 	ZEND_AST_THROW,
107 	ZEND_AST_GOTO,
108 	ZEND_AST_BREAK,
109 	ZEND_AST_CONTINUE,
110 
111 	/* 2 child nodes */
112 	ZEND_AST_DIM = 2 << ZEND_AST_NUM_CHILDREN_SHIFT,
113 	ZEND_AST_PROP,
114 	ZEND_AST_NULLSAFE_PROP,
115 	ZEND_AST_STATIC_PROP,
116 	ZEND_AST_CALL,
117 	ZEND_AST_CLASS_CONST,
118 	ZEND_AST_ASSIGN,
119 	ZEND_AST_ASSIGN_REF,
120 	ZEND_AST_ASSIGN_OP,
121 	ZEND_AST_BINARY_OP,
122 	ZEND_AST_GREATER,
123 	ZEND_AST_GREATER_EQUAL,
124 	ZEND_AST_AND,
125 	ZEND_AST_OR,
126 	ZEND_AST_ARRAY_ELEM,
127 	ZEND_AST_NEW,
128 	ZEND_AST_INSTANCEOF,
129 	ZEND_AST_YIELD,
130 	ZEND_AST_COALESCE,
131 	ZEND_AST_ASSIGN_COALESCE,
132 
133 	ZEND_AST_STATIC,
134 	ZEND_AST_WHILE,
135 	ZEND_AST_DO_WHILE,
136 	ZEND_AST_IF_ELEM,
137 	ZEND_AST_SWITCH,
138 	ZEND_AST_SWITCH_CASE,
139 	ZEND_AST_DECLARE,
140 	ZEND_AST_USE_TRAIT,
141 	ZEND_AST_TRAIT_PRECEDENCE,
142 	ZEND_AST_METHOD_REFERENCE,
143 	ZEND_AST_NAMESPACE,
144 	ZEND_AST_USE_ELEM,
145 	ZEND_AST_TRAIT_ALIAS,
146 	ZEND_AST_GROUP_USE,
147 	ZEND_AST_CLASS_CONST_GROUP,
148 	ZEND_AST_ATTRIBUTE,
149 	ZEND_AST_MATCH,
150 	ZEND_AST_MATCH_ARM,
151 	ZEND_AST_NAMED_ARG,
152 
153 	/* 3 child nodes */
154 	ZEND_AST_METHOD_CALL = 3 << ZEND_AST_NUM_CHILDREN_SHIFT,
155 	ZEND_AST_NULLSAFE_METHOD_CALL,
156 	ZEND_AST_STATIC_CALL,
157 	ZEND_AST_CONDITIONAL,
158 
159 	ZEND_AST_TRY,
160 	ZEND_AST_CATCH,
161 	ZEND_AST_PROP_GROUP,
162 	ZEND_AST_PROP_ELEM,
163 	ZEND_AST_CONST_ELEM,
164 
165 	// Pseudo node for initializing enums
166 	ZEND_AST_CONST_ENUM_INIT,
167 
168 	/* 4 child nodes */
169 	ZEND_AST_FOR = 4 << ZEND_AST_NUM_CHILDREN_SHIFT,
170 	ZEND_AST_FOREACH,
171 	ZEND_AST_ENUM_CASE,
172 
173 	/* 5 child nodes */
174 	ZEND_AST_PARAM = 5 << ZEND_AST_NUM_CHILDREN_SHIFT,
175 };
176 
177 typedef uint16_t zend_ast_kind;
178 typedef uint16_t zend_ast_attr;
179 
180 struct _zend_ast {
181 	zend_ast_kind kind; /* Type of the node (ZEND_AST_* enum constant) */
182 	zend_ast_attr attr; /* Additional attribute, use depending on node type */
183 	uint32_t lineno;    /* Line number */
184 	zend_ast *child[1]; /* Array of children (using struct hack) */
185 };
186 
187 /* Same as zend_ast, but with children count, which is updated dynamically */
188 typedef struct _zend_ast_list {
189 	zend_ast_kind kind;
190 	zend_ast_attr attr;
191 	uint32_t lineno;
192 	uint32_t children;
193 	zend_ast *child[1];
194 } zend_ast_list;
195 
196 /* Lineno is stored in val.u2.lineno */
197 typedef struct _zend_ast_zval {
198 	zend_ast_kind kind;
199 	zend_ast_attr attr;
200 	zval val;
201 } zend_ast_zval;
202 
203 /* Separate structure for function and class declaration, as they need extra information. */
204 typedef struct _zend_ast_decl {
205 	zend_ast_kind kind;
206 	zend_ast_attr attr; /* Unused - for structure compatibility */
207 	uint32_t start_lineno;
208 	uint32_t end_lineno;
209 	uint32_t flags;
210 	unsigned char *lex_pos;
211 	zend_string *doc_comment;
212 	zend_string *name;
213 	zend_ast *child[5];
214 } zend_ast_decl;
215 
216 typedef void (*zend_ast_process_t)(zend_ast *ast);
217 extern ZEND_API zend_ast_process_t zend_ast_process;
218 
219 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_with_lineno(zval *zv, uint32_t lineno);
220 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_ex(zval *zv, zend_ast_attr attr);
221 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval(zval *zv);
222 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_from_str(zend_string *str);
223 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_from_long(zend_long lval);
224 
225 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_constant(zend_string *name, zend_ast_attr attr);
226 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_class_const_or_name(zend_ast *class_name, zend_ast *name);
227 
228 #if ZEND_AST_SPEC
229 # define ZEND_AST_SPEC_CALL(name, ...) \
230 	ZEND_EXPAND_VA(ZEND_AST_SPEC_CALL_(name, __VA_ARGS__, _5, _4, _3, _2, _1, _0)(__VA_ARGS__))
231 # define ZEND_AST_SPEC_CALL_(name, _, _5, _4, _3, _2, _1, suffix, ...) \
232 	name ## suffix
233 # define ZEND_AST_SPEC_CALL_EX(name, ...) \
234 	ZEND_EXPAND_VA(ZEND_AST_SPEC_CALL_EX_(name, __VA_ARGS__, _5, _4, _3, _2, _1, _0)(__VA_ARGS__))
235 # define ZEND_AST_SPEC_CALL_EX_(name, _, _6, _5, _4, _3, _2, _1, suffix, ...) \
236 	name ## suffix
237 
238 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_0(zend_ast_kind kind);
239 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_1(zend_ast_kind kind, zend_ast *child);
240 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_2(zend_ast_kind kind, zend_ast *child1, zend_ast *child2);
241 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_3(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3);
242 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_4(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4);
243 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_5(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4, zend_ast *child5);
244 
zend_ast_create_ex_0(zend_ast_kind kind,zend_ast_attr attr)245 static zend_always_inline zend_ast * zend_ast_create_ex_0(zend_ast_kind kind, zend_ast_attr attr) {
246 	zend_ast *ast = zend_ast_create_0(kind);
247 	ast->attr = attr;
248 	return ast;
249 }
zend_ast_create_ex_1(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child)250 static zend_always_inline zend_ast * zend_ast_create_ex_1(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child) {
251 	zend_ast *ast = zend_ast_create_1(kind, child);
252 	ast->attr = attr;
253 	return ast;
254 }
zend_ast_create_ex_2(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2)255 static zend_always_inline zend_ast * zend_ast_create_ex_2(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2) {
256 	zend_ast *ast = zend_ast_create_2(kind, child1, child2);
257 	ast->attr = attr;
258 	return ast;
259 }
zend_ast_create_ex_3(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2,zend_ast * child3)260 static zend_always_inline zend_ast * zend_ast_create_ex_3(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3) {
261 	zend_ast *ast = zend_ast_create_3(kind, child1, child2, child3);
262 	ast->attr = attr;
263 	return ast;
264 }
zend_ast_create_ex_4(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2,zend_ast * child3,zend_ast * child4)265 static zend_always_inline zend_ast * zend_ast_create_ex_4(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4) {
266 	zend_ast *ast = zend_ast_create_4(kind, child1, child2, child3, child4);
267 	ast->attr = attr;
268 	return ast;
269 }
zend_ast_create_ex_5(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2,zend_ast * child3,zend_ast * child4,zend_ast * child5)270 static zend_always_inline zend_ast * zend_ast_create_ex_5(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4, zend_ast *child5) {
271 	zend_ast *ast = zend_ast_create_5(kind, child1, child2, child3, child4, child5);
272 	ast->attr = attr;
273 	return ast;
274 }
275 
276 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_0(zend_ast_kind kind);
277 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_1(zend_ast_kind kind, zend_ast *child);
278 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_2(zend_ast_kind kind, zend_ast *child1, zend_ast *child2);
279 
280 # define zend_ast_create(...) \
281 	ZEND_AST_SPEC_CALL(zend_ast_create, __VA_ARGS__)
282 # define zend_ast_create_ex(...) \
283 	ZEND_AST_SPEC_CALL_EX(zend_ast_create_ex, __VA_ARGS__)
284 # define zend_ast_create_list(init_children, ...) \
285 	ZEND_AST_SPEC_CALL(zend_ast_create_list, __VA_ARGS__)
286 
287 #else
288 ZEND_API zend_ast *zend_ast_create(zend_ast_kind kind, ...);
289 ZEND_API zend_ast *zend_ast_create_ex(zend_ast_kind kind, zend_ast_attr attr, ...);
290 ZEND_API zend_ast *zend_ast_create_list(uint32_t init_children, zend_ast_kind kind, ...);
291 #endif
292 
293 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_list_add(zend_ast *list, zend_ast *op);
294 
295 ZEND_API zend_ast *zend_ast_create_decl(
296 	zend_ast_kind kind, uint32_t flags, uint32_t start_lineno, zend_string *doc_comment,
297 	zend_string *name, zend_ast *child0, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4
298 );
299 
300 ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate(zval *result, zend_ast *ast, zend_class_entry *scope);
301 ZEND_API zend_string *zend_ast_export(const char *prefix, zend_ast *ast, const char *suffix);
302 
303 ZEND_API zend_ast_ref * ZEND_FASTCALL zend_ast_copy(zend_ast *ast);
304 ZEND_API void ZEND_FASTCALL zend_ast_destroy(zend_ast *ast);
305 ZEND_API void ZEND_FASTCALL zend_ast_ref_destroy(zend_ast_ref *ast);
306 
307 typedef void (*zend_ast_apply_func)(zend_ast **ast_ptr, void *context);
308 ZEND_API void zend_ast_apply(zend_ast *ast, zend_ast_apply_func fn, void *context);
309 
zend_ast_size(uint32_t children)310 static zend_always_inline size_t zend_ast_size(uint32_t children) {
311 	return sizeof(zend_ast) - sizeof(zend_ast *) + sizeof(zend_ast *) * children;
312 }
313 
zend_ast_is_special(zend_ast * ast)314 static zend_always_inline bool zend_ast_is_special(zend_ast *ast) {
315 	return (ast->kind >> ZEND_AST_SPECIAL_SHIFT) & 1;
316 }
317 
zend_ast_is_list(zend_ast * ast)318 static zend_always_inline bool zend_ast_is_list(zend_ast *ast) {
319 	return (ast->kind >> ZEND_AST_IS_LIST_SHIFT) & 1;
320 }
zend_ast_get_list(zend_ast * ast)321 static zend_always_inline zend_ast_list *zend_ast_get_list(zend_ast *ast) {
322 	ZEND_ASSERT(zend_ast_is_list(ast));
323 	return (zend_ast_list *) ast;
324 }
325 
zend_ast_get_zval(zend_ast * ast)326 static zend_always_inline zval *zend_ast_get_zval(zend_ast *ast) {
327 	ZEND_ASSERT(ast->kind == ZEND_AST_ZVAL);
328 	return &((zend_ast_zval *) ast)->val;
329 }
zend_ast_get_str(zend_ast * ast)330 static zend_always_inline zend_string *zend_ast_get_str(zend_ast *ast) {
331 	zval *zv = zend_ast_get_zval(ast);
332 	ZEND_ASSERT(Z_TYPE_P(zv) == IS_STRING);
333 	return Z_STR_P(zv);
334 }
335 
zend_ast_get_constant_name(zend_ast * ast)336 static zend_always_inline zend_string *zend_ast_get_constant_name(zend_ast *ast) {
337 	ZEND_ASSERT(ast->kind == ZEND_AST_CONSTANT);
338 	ZEND_ASSERT(Z_TYPE(((zend_ast_zval *) ast)->val) == IS_STRING);
339 	return Z_STR(((zend_ast_zval *) ast)->val);
340 }
341 
zend_ast_get_num_children(zend_ast * ast)342 static zend_always_inline uint32_t zend_ast_get_num_children(zend_ast *ast) {
343 	ZEND_ASSERT(!zend_ast_is_list(ast));
344 	return ast->kind >> ZEND_AST_NUM_CHILDREN_SHIFT;
345 }
zend_ast_get_lineno(zend_ast * ast)346 static zend_always_inline uint32_t zend_ast_get_lineno(zend_ast *ast) {
347 	if (ast->kind == ZEND_AST_ZVAL) {
348 		zval *zv = zend_ast_get_zval(ast);
349 		return Z_LINENO_P(zv);
350 	} else {
351 		return ast->lineno;
352 	}
353 }
354 
zend_ast_create_binary_op(uint32_t opcode,zend_ast * op0,zend_ast * op1)355 static zend_always_inline zend_ast *zend_ast_create_binary_op(uint32_t opcode, zend_ast *op0, zend_ast *op1) {
356 	return zend_ast_create_ex(ZEND_AST_BINARY_OP, opcode, op0, op1);
357 }
zend_ast_create_assign_op(uint32_t opcode,zend_ast * op0,zend_ast * op1)358 static zend_always_inline zend_ast *zend_ast_create_assign_op(uint32_t opcode, zend_ast *op0, zend_ast *op1) {
359 	return zend_ast_create_ex(ZEND_AST_ASSIGN_OP, opcode, op0, op1);
360 }
zend_ast_create_cast(uint32_t type,zend_ast * op0)361 static zend_always_inline zend_ast *zend_ast_create_cast(uint32_t type, zend_ast *op0) {
362 	return zend_ast_create_ex(ZEND_AST_CAST, type, op0);
363 }
zend_ast_list_rtrim(zend_ast * ast)364 static zend_always_inline zend_ast *zend_ast_list_rtrim(zend_ast *ast) {
365 	zend_ast_list *list = zend_ast_get_list(ast);
366 	if (list->children && list->child[list->children - 1] == NULL) {
367 		list->children--;
368 	}
369 	return ast;
370 }
371 
372 zend_ast * ZEND_FASTCALL zend_ast_with_attributes(zend_ast *ast, zend_ast *attr);
373 
374 #endif
375