1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
5 | Copyright (c) 1998-2018 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: Andi Gutmans <andi@zend.com> |
16 | Zeev Suraski <zeev@zend.com> |
17 +----------------------------------------------------------------------+
18 */
19
20 /* $Id$ */
21
22 #ifndef ZEND_COMPILE_H
23 #define ZEND_COMPILE_H
24
25 #include "zend.h"
26 #include "zend_ast.h"
27
28 #ifdef HAVE_STDARG_H
29 # include <stdarg.h>
30 #endif
31
32 #include "zend_llist.h"
33
34 #define SET_UNUSED(op) op ## _type = IS_UNUSED
35
36 #define MAKE_NOP(opline) do { \
37 (opline)->op1.num = 0; \
38 (opline)->op2.num = 0; \
39 (opline)->result.num = 0; \
40 (opline)->opcode = ZEND_NOP; \
41 (opline)->op1_type = IS_UNUSED; \
42 (opline)->op2_type = IS_UNUSED; \
43 (opline)->result_type = IS_UNUSED; \
44 } while (0)
45
46 #define RESET_DOC_COMMENT() do { \
47 if (CG(doc_comment)) { \
48 zend_string_release(CG(doc_comment)); \
49 CG(doc_comment) = NULL; \
50 } \
51 } while (0)
52
53 typedef struct _zend_op_array zend_op_array;
54 typedef struct _zend_op zend_op;
55
56 /* On 64-bit systems less optimal, but more compact VM code leads to better
57 * performance. So on 32-bit systems we use absolute addresses for jump
58 * targets and constants, but on 64-bit systems realtive 32-bit offsets */
59 #if SIZEOF_SIZE_T == 4
60 # define ZEND_USE_ABS_JMP_ADDR 1
61 # define ZEND_USE_ABS_CONST_ADDR 1
62 # define ZEND_EX_USE_LITERALS 0
63 # define ZEND_EX_USE_RUN_TIME_CACHE 1
64 #else
65 # define ZEND_USE_ABS_JMP_ADDR 0
66 # define ZEND_USE_ABS_CONST_ADDR 0
67 # define ZEND_EX_USE_LITERALS 1
68 # define ZEND_EX_USE_RUN_TIME_CACHE 1
69 #endif
70
71 typedef union _znode_op {
72 uint32_t constant;
73 uint32_t var;
74 uint32_t num;
75 uint32_t opline_num; /* Needs to be signed */
76 #if ZEND_USE_ABS_JMP_ADDR
77 zend_op *jmp_addr;
78 #else
79 uint32_t jmp_offset;
80 #endif
81 #if ZEND_USE_ABS_CONST_ADDR
82 zval *zv;
83 #endif
84 } znode_op;
85
86 typedef struct _znode { /* used only during compilation */
87 zend_uchar op_type;
88 zend_uchar flag;
89 union {
90 znode_op op;
91 zval constant; /* replaced by literal/zv */
92 } u;
93 } znode;
94
95 /* Temporarily defined here, to avoid header ordering issues */
96 typedef struct _zend_ast_znode {
97 zend_ast_kind kind;
98 zend_ast_attr attr;
99 uint32_t lineno;
100 znode node;
101 } zend_ast_znode;
102 ZEND_API zend_ast *zend_ast_create_znode(znode *node);
103
zend_ast_get_znode(zend_ast * ast)104 static zend_always_inline znode *zend_ast_get_znode(zend_ast *ast) {
105 return &((zend_ast_znode *) ast)->node;
106 }
107
108 typedef struct _zend_declarables {
109 zend_long ticks;
110 } zend_declarables;
111
112 /* Compilation context that is different for each file, but shared between op arrays. */
113 typedef struct _zend_file_context {
114 zend_declarables declarables;
115 znode implementing_class;
116
117 zend_string *current_namespace;
118 zend_bool in_namespace;
119 zend_bool has_bracketed_namespaces;
120
121 HashTable *imports;
122 HashTable *imports_function;
123 HashTable *imports_const;
124 } zend_file_context;
125
126 typedef union _zend_parser_stack_elem {
127 zend_ast *ast;
128 zend_string *str;
129 zend_ulong num;
130 } zend_parser_stack_elem;
131
132 void zend_compile_top_stmt(zend_ast *ast);
133 void zend_compile_stmt(zend_ast *ast);
134 void zend_compile_expr(znode *node, zend_ast *ast);
135 void zend_compile_var(znode *node, zend_ast *ast, uint32_t type);
136 void zend_eval_const_expr(zend_ast **ast_ptr);
137 void zend_const_expr_to_zval(zval *result, zend_ast *ast);
138
139 typedef int (*user_opcode_handler_t) (zend_execute_data *execute_data);
140
141 struct _zend_op {
142 const void *handler;
143 znode_op op1;
144 znode_op op2;
145 znode_op result;
146 uint32_t extended_value;
147 uint32_t lineno;
148 zend_uchar opcode;
149 zend_uchar op1_type;
150 zend_uchar op2_type;
151 zend_uchar result_type;
152 };
153
154
155 typedef struct _zend_brk_cont_element {
156 int start;
157 int cont;
158 int brk;
159 int parent;
160 } zend_brk_cont_element;
161
162 typedef struct _zend_label {
163 int brk_cont;
164 uint32_t opline_num;
165 } zend_label;
166
167 typedef struct _zend_try_catch_element {
168 uint32_t try_op;
169 uint32_t catch_op; /* ketchup! */
170 uint32_t finally_op;
171 uint32_t finally_end;
172 } zend_try_catch_element;
173
174 #define ZEND_LIVE_TMPVAR 0
175 #define ZEND_LIVE_LOOP 1
176 #define ZEND_LIVE_SILENCE 2
177 #define ZEND_LIVE_ROPE 3
178 #define ZEND_LIVE_MASK 3
179
180 typedef struct _zend_live_range {
181 uint32_t var; /* low bits are used for variable type (ZEND_LIVE_* macros) */
182 uint32_t start;
183 uint32_t end;
184 } zend_live_range;
185
186 /* Compilation context that is different for each op array. */
187 typedef struct _zend_oparray_context {
188 uint32_t opcodes_size;
189 int vars_size;
190 int literals_size;
191 int backpatch_count;
192 int in_finally;
193 uint32_t fast_call_var;
194 uint32_t try_catch_offset;
195 int current_brk_cont;
196 int last_brk_cont;
197 zend_brk_cont_element *brk_cont_array;
198 HashTable *labels;
199 } zend_oparray_context;
200
201 /* method flags (types) */
202 #define ZEND_ACC_STATIC 0x01
203 #define ZEND_ACC_ABSTRACT 0x02
204 #define ZEND_ACC_FINAL 0x04
205 #define ZEND_ACC_IMPLEMENTED_ABSTRACT 0x08
206
207 /* class flags (types) */
208 /* ZEND_ACC_IMPLICIT_ABSTRACT_CLASS is used for abstract classes (since it is set by any abstract method even interfaces MAY have it set, too). */
209 /* ZEND_ACC_EXPLICIT_ABSTRACT_CLASS denotes that a class was explicitly defined as abstract by using the keyword. */
210 #define ZEND_ACC_IMPLICIT_ABSTRACT_CLASS 0x10
211 #define ZEND_ACC_EXPLICIT_ABSTRACT_CLASS 0x20
212 #define ZEND_ACC_INTERFACE 0x40
213 #define ZEND_ACC_TRAIT 0x80
214 #define ZEND_ACC_ANON_CLASS 0x100
215 #define ZEND_ACC_ANON_BOUND 0x200
216 #define ZEND_ACC_INHERITED 0x400
217
218 /* method flags (visibility) */
219 /* The order of those must be kept - public < protected < private */
220 #define ZEND_ACC_PUBLIC 0x100
221 #define ZEND_ACC_PROTECTED 0x200
222 #define ZEND_ACC_PRIVATE 0x400
223 #define ZEND_ACC_PPP_MASK (ZEND_ACC_PUBLIC | ZEND_ACC_PROTECTED | ZEND_ACC_PRIVATE)
224
225 #define ZEND_ACC_CHANGED 0x800
226 #define ZEND_ACC_IMPLICIT_PUBLIC 0x1000
227
228 /* method flags (special method detection) */
229 #define ZEND_ACC_CTOR 0x2000
230 #define ZEND_ACC_DTOR 0x4000
231 #define ZEND_ACC_CLONE 0x8000
232
233 /* method flag used by Closure::__invoke() */
234 #define ZEND_ACC_USER_ARG_INFO 0x80
235
236 /* method flag (bc only), any method that has this flag can be used statically and non statically. */
237 #define ZEND_ACC_ALLOW_STATIC 0x10000
238
239 /* shadow of parent's private method/property */
240 #define ZEND_ACC_SHADOW 0x20000
241
242 /* deprecation flag */
243 #define ZEND_ACC_DEPRECATED 0x40000
244
245 /* class implement interface(s) flag */
246 #define ZEND_ACC_IMPLEMENT_INTERFACES 0x80000
247 #define ZEND_ACC_IMPLEMENT_TRAITS 0x400000
248
249 /* class constants updated */
250 #define ZEND_ACC_CONSTANTS_UPDATED 0x100000
251
252 /* user class has methods with static variables */
253 #define ZEND_HAS_STATIC_IN_METHODS 0x800000
254
255
256 #define ZEND_ACC_CLOSURE 0x100000
257 #define ZEND_ACC_GENERATOR 0x800000
258
259 #define ZEND_ACC_NO_RT_ARENA 0x80000
260
261 /* call through user function trampoline. e.g. __call, __callstatic */
262 #define ZEND_ACC_CALL_VIA_TRAMPOLINE 0x200000
263
264 /* call through internal function handler. e.g. Closure::invoke() */
265 #define ZEND_ACC_CALL_VIA_HANDLER ZEND_ACC_CALL_VIA_TRAMPOLINE
266
267 /* disable inline caching */
268 #define ZEND_ACC_NEVER_CACHE 0x400000
269
270 #define ZEND_ACC_VARIADIC 0x1000000
271
272 #define ZEND_ACC_RETURN_REFERENCE 0x4000000
273 #define ZEND_ACC_DONE_PASS_TWO 0x8000000
274
275 /* class has magic methods __get/__set/__unset/__isset that use guards */
276 #define ZEND_ACC_USE_GUARDS 0x1000000
277
278 /* function has typed arguments */
279 #define ZEND_ACC_HAS_TYPE_HINTS 0x10000000
280
281 /* op_array has finally blocks */
282 #define ZEND_ACC_HAS_FINALLY_BLOCK 0x20000000
283
284 /* internal function is allocated at arena */
285 #define ZEND_ACC_ARENA_ALLOCATED 0x20000000
286
287 /* Function has a return type (or class has such non-private function) */
288 #define ZEND_ACC_HAS_RETURN_TYPE 0x40000000
289
290 /* op_array uses strict mode types */
291 #define ZEND_ACC_STRICT_TYPES 0x80000000
292
293 char *zend_visibility_string(uint32_t fn_flags);
294
295 typedef struct _zend_property_info {
296 uint32_t offset; /* property offset for object properties or
297 property index for static properties */
298 uint32_t flags;
299 zend_string *name;
300 zend_string *doc_comment;
301 zend_class_entry *ce;
302 } zend_property_info;
303
304 #define OBJ_PROP(obj, offset) \
305 ((zval*)((char*)(obj) + offset))
306 #define OBJ_PROP_NUM(obj, num) \
307 (&(obj)->properties_table[(num)])
308 #define OBJ_PROP_TO_OFFSET(num) \
309 ((uint32_t)(zend_uintptr_t)OBJ_PROP_NUM(((zend_object*)NULL), num))
310 #define OBJ_PROP_TO_NUM(offset) \
311 ((offset - OBJ_PROP_TO_OFFSET(0)) / sizeof(zval))
312
313 typedef struct _zend_class_constant {
314 zval value; /* access flags are stored in reserved: zval.u2.access_flags */
315 zend_string *doc_comment;
316 zend_class_entry *ce;
317 } zend_class_constant;
318
319 /* arg_info for internal functions */
320 typedef struct _zend_internal_arg_info {
321 const char *name;
322 const char *class_name;
323 zend_uchar type_hint;
324 zend_uchar pass_by_reference;
325 zend_bool allow_null;
326 zend_bool is_variadic;
327 } zend_internal_arg_info;
328
329 /* arg_info for user functions */
330 typedef struct _zend_arg_info {
331 zend_string *name;
332 zend_string *class_name;
333 zend_uchar type_hint;
334 zend_uchar pass_by_reference;
335 zend_bool allow_null;
336 zend_bool is_variadic;
337 } zend_arg_info;
338
339 /* the following structure repeats the layout of zend_internal_arg_info,
340 * but its fields have different meaning. It's used as the first element of
341 * arg_info array to define properties of internal functions.
342 * It's also used for the return type.
343 */
344 typedef struct _zend_internal_function_info {
345 zend_uintptr_t required_num_args;
346 const char *class_name;
347 zend_uchar type_hint;
348 zend_bool return_reference;
349 zend_bool allow_null;
350 zend_bool _is_variadic;
351 } zend_internal_function_info;
352
353 struct _zend_op_array {
354 /* Common elements */
355 zend_uchar type;
356 zend_uchar arg_flags[3]; /* bitset of arg_info.pass_by_reference */
357 uint32_t fn_flags;
358 zend_string *function_name;
359 zend_class_entry *scope;
360 zend_function *prototype;
361 uint32_t num_args;
362 uint32_t required_num_args;
363 zend_arg_info *arg_info;
364 /* END of common elements */
365
366 uint32_t *refcount;
367
368 uint32_t last;
369 zend_op *opcodes;
370
371 int last_var;
372 uint32_t T;
373 zend_string **vars;
374
375 int last_live_range;
376 int last_try_catch;
377 zend_live_range *live_range;
378 zend_try_catch_element *try_catch_array;
379
380 /* static variables support */
381 HashTable *static_variables;
382
383 zend_string *filename;
384 uint32_t line_start;
385 uint32_t line_end;
386 zend_string *doc_comment;
387 uint32_t early_binding; /* the linked list of delayed declarations */
388
389 int last_literal;
390 zval *literals;
391
392 int cache_size;
393 void **run_time_cache;
394
395 void *reserved[ZEND_MAX_RESERVED_RESOURCES];
396 };
397
398
399 #define ZEND_RETURN_VALUE 0
400 #define ZEND_RETURN_REFERENCE 1
401
402 typedef struct _zend_internal_function {
403 /* Common elements */
404 zend_uchar type;
405 zend_uchar arg_flags[3]; /* bitset of arg_info.pass_by_reference */
406 uint32_t fn_flags;
407 zend_string* function_name;
408 zend_class_entry *scope;
409 zend_function *prototype;
410 uint32_t num_args;
411 uint32_t required_num_args;
412 zend_internal_arg_info *arg_info;
413 /* END of common elements */
414
415 void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
416 struct _zend_module_entry *module;
417 void *reserved[ZEND_MAX_RESERVED_RESOURCES];
418 } zend_internal_function;
419
420 #define ZEND_FN_SCOPE_NAME(function) ((function) && (function)->common.scope ? ZSTR_VAL((function)->common.scope->name) : "")
421
422 union _zend_function {
423 zend_uchar type; /* MUST be the first element of this struct! */
424 uint32_t quick_arg_flags;
425
426 struct {
427 zend_uchar type; /* never used */
428 zend_uchar arg_flags[3]; /* bitset of arg_info.pass_by_reference */
429 uint32_t fn_flags;
430 zend_string *function_name;
431 zend_class_entry *scope;
432 union _zend_function *prototype;
433 uint32_t num_args;
434 uint32_t required_num_args;
435 zend_arg_info *arg_info;
436 } common;
437
438 zend_op_array op_array;
439 zend_internal_function internal_function;
440 };
441
442 typedef enum _zend_call_kind {
443 ZEND_CALL_NESTED_FUNCTION, /* stackless VM call to function */
444 ZEND_CALL_NESTED_CODE, /* stackless VM call to include/require/eval */
445 ZEND_CALL_TOP_FUNCTION, /* direct VM call to function from external C code */
446 ZEND_CALL_TOP_CODE /* direct VM call to "main" code from external C code */
447 } zend_call_kind;
448
449 struct _zend_execute_data {
450 const zend_op *opline; /* executed opline */
451 zend_execute_data *call; /* current call */
452 zval *return_value;
453 zend_function *func; /* executed function */
454 zval This; /* this + call_info + num_args */
455 zend_execute_data *prev_execute_data;
456 zend_array *symbol_table;
457 #if ZEND_EX_USE_RUN_TIME_CACHE
458 void **run_time_cache; /* cache op_array->run_time_cache */
459 #endif
460 #if ZEND_EX_USE_LITERALS
461 zval *literals; /* cache op_array->literals */
462 #endif
463 };
464
465 #define ZEND_CALL_FUNCTION (0 << 0)
466 #define ZEND_CALL_CODE (1 << 0)
467 #define ZEND_CALL_NESTED (0 << 1)
468 #define ZEND_CALL_TOP (1 << 1)
469 #define ZEND_CALL_FREE_EXTRA_ARGS (1 << 2) /* equal to IS_TYPE_REFCOUNTED */
470 #define ZEND_CALL_CTOR (1 << 3)
471 #define ZEND_CALL_HAS_SYMBOL_TABLE (1 << 4)
472 #define ZEND_CALL_CLOSURE (1 << 5)
473 #define ZEND_CALL_RELEASE_THIS (1 << 6)
474 #define ZEND_CALL_ALLOCATED (1 << 7)
475 #define ZEND_CALL_GENERATOR (1 << 8)
476 #define ZEND_CALL_DYNAMIC (1 << 9)
477
478 #define ZEND_CALL_INFO_SHIFT 16
479
480 #define ZEND_CALL_INFO(call) \
481 (Z_TYPE_INFO((call)->This) >> ZEND_CALL_INFO_SHIFT)
482
483 #define ZEND_CALL_KIND_EX(call_info) \
484 (call_info & (ZEND_CALL_CODE | ZEND_CALL_TOP))
485
486 #define ZEND_CALL_KIND(call) \
487 ZEND_CALL_KIND_EX(ZEND_CALL_INFO(call))
488
489 #define ZEND_SET_CALL_INFO(call, object, info) do { \
490 Z_TYPE_INFO((call)->This) = ((object) ? IS_OBJECT_EX : IS_UNDEF) | ((info) << ZEND_CALL_INFO_SHIFT); \
491 } while (0)
492
493 #define ZEND_ADD_CALL_FLAG_EX(call_info, flag) do { \
494 call_info |= ((flag) << ZEND_CALL_INFO_SHIFT); \
495 } while (0)
496
497 #define ZEND_ADD_CALL_FLAG(call, flag) do { \
498 ZEND_ADD_CALL_FLAG_EX(Z_TYPE_INFO((call)->This), flag); \
499 } while (0)
500
501 #define ZEND_CALL_NUM_ARGS(call) \
502 (call)->This.u2.num_args
503
504 #define ZEND_CALL_FRAME_SLOT \
505 ((int)((ZEND_MM_ALIGNED_SIZE(sizeof(zend_execute_data)) + ZEND_MM_ALIGNED_SIZE(sizeof(zval)) - 1) / ZEND_MM_ALIGNED_SIZE(sizeof(zval))))
506
507 #define ZEND_CALL_VAR(call, n) \
508 ((zval*)(((char*)(call)) + ((int)(n))))
509
510 #define ZEND_CALL_VAR_NUM(call, n) \
511 (((zval*)(call)) + (ZEND_CALL_FRAME_SLOT + ((int)(n))))
512
513 #define ZEND_CALL_ARG(call, n) \
514 ZEND_CALL_VAR_NUM(call, ((int)(n)) - 1)
515
516 #define EX(element) ((execute_data)->element)
517
518 #define EX_CALL_INFO() ZEND_CALL_INFO(execute_data)
519 #define EX_CALL_KIND() ZEND_CALL_KIND(execute_data)
520 #define EX_NUM_ARGS() ZEND_CALL_NUM_ARGS(execute_data)
521
522 #define ZEND_CALL_USES_STRICT_TYPES(call) \
523 (((call)->func->common.fn_flags & ZEND_ACC_STRICT_TYPES) != 0)
524
525 #define EX_USES_STRICT_TYPES() \
526 ZEND_CALL_USES_STRICT_TYPES(execute_data)
527
528 #define ZEND_ARG_USES_STRICT_TYPES() \
529 (EG(current_execute_data)->prev_execute_data && \
530 EG(current_execute_data)->prev_execute_data->func && \
531 ZEND_CALL_USES_STRICT_TYPES(EG(current_execute_data)->prev_execute_data))
532
533 #define ZEND_RET_USES_STRICT_TYPES() \
534 ZEND_CALL_USES_STRICT_TYPES(EG(current_execute_data))
535
536 #define EX_VAR(n) ZEND_CALL_VAR(execute_data, n)
537 #define EX_VAR_NUM(n) ZEND_CALL_VAR_NUM(execute_data, n)
538
539 #define EX_VAR_TO_NUM(n) ((uint32_t)(ZEND_CALL_VAR(NULL, n) - ZEND_CALL_VAR_NUM(NULL, 0)))
540
541 #define ZEND_OPLINE_TO_OFFSET(opline, target) \
542 ((char*)(target) - (char*)(opline))
543
544 #define ZEND_OPLINE_NUM_TO_OFFSET(op_array, opline, opline_num) \
545 ((char*)&(op_array)->opcodes[opline_num] - (char*)(opline))
546
547 #define ZEND_OFFSET_TO_OPLINE(base, offset) \
548 ((zend_op*)(((char*)(base)) + (int)offset))
549
550 #define ZEND_OFFSET_TO_OPLINE_NUM(op_array, base, offset) \
551 (ZEND_OFFSET_TO_OPLINE(base, offset) - op_array->opcodes)
552
553 #if ZEND_USE_ABS_JMP_ADDR
554
555 /* run-time jump target */
556 # define OP_JMP_ADDR(opline, node) \
557 (node).jmp_addr
558
559 # define ZEND_SET_OP_JMP_ADDR(opline, node, val) do { \
560 (node).jmp_addr = (val); \
561 } while (0)
562
563 /* convert jump target from compile-time to run-time */
564 # define ZEND_PASS_TWO_UPDATE_JMP_TARGET(op_array, opline, node) do { \
565 (node).jmp_addr = (op_array)->opcodes + (node).opline_num; \
566 } while (0)
567
568 /* convert jump target back from run-time to compile-time */
569 # define ZEND_PASS_TWO_UNDO_JMP_TARGET(op_array, opline, node) do { \
570 (node).opline_num = (node).jmp_addr - (op_array)->opcodes; \
571 } while (0)
572
573 #else
574
575 /* run-time jump target */
576 # define OP_JMP_ADDR(opline, node) \
577 ZEND_OFFSET_TO_OPLINE(opline, (node).jmp_offset)
578
579 # define ZEND_SET_OP_JMP_ADDR(opline, node, val) do { \
580 (node).jmp_offset = ZEND_OPLINE_TO_OFFSET(opline, val); \
581 } while (0)
582
583 /* convert jump target from compile-time to run-time */
584 # define ZEND_PASS_TWO_UPDATE_JMP_TARGET(op_array, opline, node) do { \
585 (node).jmp_offset = ZEND_OPLINE_NUM_TO_OFFSET(op_array, opline, (node).opline_num); \
586 } while (0)
587
588 /* convert jump target back from run-time to compile-time */
589 # define ZEND_PASS_TWO_UNDO_JMP_TARGET(op_array, opline, node) do { \
590 (node).opline_num = ZEND_OFFSET_TO_OPLINE_NUM(op_array, opline, (node).jmp_offset); \
591 } while (0)
592
593 #endif
594
595 /* constant-time constant */
596 # define CT_CONSTANT_EX(op_array, num) \
597 ((op_array)->literals + (num))
598
599 # define CT_CONSTANT(node) \
600 CT_CONSTANT_EX(CG(active_op_array), (node).constant)
601
602 #if ZEND_USE_ABS_CONST_ADDR
603
604 /* run-time constant */
605 # define RT_CONSTANT_EX(base, node) \
606 (node).zv
607
608 /* convert constant from compile-time to run-time */
609 # define ZEND_PASS_TWO_UPDATE_CONSTANT(op_array, node) do { \
610 (node).zv = CT_CONSTANT_EX(op_array, (node).constant); \
611 } while (0)
612
613 /* convert constant back from run-time to compile-time */
614 # define ZEND_PASS_TWO_UNDO_CONSTANT(op_array, node) do { \
615 (node).constant = (node).zv - (op_array)->literals; \
616 } while (0)
617
618 #else
619
620 /* run-time constant */
621 # define RT_CONSTANT_EX(base, node) \
622 ((zval*)(((char*)(base)) + (node).constant))
623
624 /* convert constant from compile-time to run-time */
625 # define ZEND_PASS_TWO_UPDATE_CONSTANT(op_array, node) do { \
626 (node).constant *= sizeof(zval); \
627 } while (0)
628
629 /* convert constant back from run-time to compile-time (do nothing) */
630 # define ZEND_PASS_TWO_UNDO_CONSTANT(op_array, node) do { \
631 (node).constant /= sizeof(zval); \
632 } while (0)
633
634 #endif
635
636 #if ZEND_EX_USE_LITERALS
637
638 # define EX_LITERALS() \
639 EX(literals)
640
641 # define EX_LOAD_LITERALS(op_array) do { \
642 EX(literals) = (op_array)->literals; \
643 } while (0)
644
645 #else
646
647 # define EX_LITERALS() \
648 EX(func)->op_array.literals
649
650 # define EX_LOAD_LITERALS(op_array) do { \
651 } while (0)
652
653 #endif
654
655 /* run-time constant */
656 #define RT_CONSTANT(op_array, node) \
657 RT_CONSTANT_EX((op_array)->literals, node)
658
659 /* constant in currently executed function */
660 #define EX_CONSTANT(node) \
661 RT_CONSTANT_EX(EX_LITERALS(), node)
662
663 #if ZEND_EX_USE_RUN_TIME_CACHE
664
665 # define EX_RUN_TIME_CACHE() \
666 EX(run_time_cache)
667
668 # define EX_LOAD_RUN_TIME_CACHE(op_array) do { \
669 EX(run_time_cache) = (op_array)->run_time_cache; \
670 } while (0)
671
672 #else
673
674 # define EX_RUN_TIME_CACHE() \
675 EX(func)->op_array.run_time_cache
676
677 # define EX_LOAD_RUN_TIME_CACHE(op_array) do { \
678 } while (0)
679
680 #endif
681
682 #define IS_CONST (1<<0)
683 #define IS_TMP_VAR (1<<1)
684 #define IS_VAR (1<<2)
685 #define IS_UNUSED (1<<3) /* Unused variable */
686 #define IS_CV (1<<4) /* Compiled variable */
687
688 #include "zend_globals.h"
689
690 BEGIN_EXTERN_C()
691
692 void init_compiler(void);
693 void shutdown_compiler(void);
694 void zend_init_compiler_data_structures(void);
695
696 void zend_oparray_context_begin(zend_oparray_context *prev_context);
697 void zend_oparray_context_end(zend_oparray_context *prev_context);
698 void zend_file_context_begin(zend_file_context *prev_context);
699 void zend_file_context_end(zend_file_context *prev_context);
700
701 extern ZEND_API zend_op_array *(*zend_compile_file)(zend_file_handle *file_handle, int type);
702 extern ZEND_API zend_op_array *(*zend_compile_string)(zval *source_string, char *filename);
703
704 ZEND_API int lex_scan(zval *zendlval);
705 void startup_scanner(void);
706 void shutdown_scanner(void);
707
708 ZEND_API zend_string *zend_set_compiled_filename(zend_string *new_compiled_filename);
709 ZEND_API void zend_restore_compiled_filename(zend_string *original_compiled_filename);
710 ZEND_API zend_string *zend_get_compiled_filename(void);
711 ZEND_API int zend_get_compiled_lineno(void);
712 ZEND_API size_t zend_get_scanned_file_offset(void);
713
714 ZEND_API zend_string *zend_get_compiled_variable_name(const zend_op_array *op_array, uint32_t var);
715
716 #ifdef ZTS
717 const char *zend_get_zendtext(void);
718 int zend_get_zendleng(void);
719 #endif
720
721 typedef int (ZEND_FASTCALL *unary_op_type)(zval *, zval *);
722 typedef int (ZEND_FASTCALL *binary_op_type)(zval *, zval *, zval *);
723
724 ZEND_API unary_op_type get_unary_op(int opcode);
725 ZEND_API binary_op_type get_binary_op(int opcode);
726
727 void zend_stop_lexing(void);
728 void zend_emit_final_return(int return_one);
729
730 /* Used during AST construction */
731 zend_ast *zend_ast_append_str(zend_ast *left, zend_ast *right);
732 zend_ast *zend_negate_num_string(zend_ast *ast);
733 uint32_t zend_add_class_modifier(uint32_t flags, uint32_t new_flag);
734 uint32_t zend_add_member_modifier(uint32_t flags, uint32_t new_flag);
735 void zend_handle_encoding_declaration(zend_ast *ast);
736
737 /* parser-driven code generators */
738 void zend_do_free(znode *op1);
739
740 ZEND_API int do_bind_function(const zend_op_array *op_array, const zend_op *opline, HashTable *function_table, zend_bool compile_time);
741 ZEND_API zend_class_entry *do_bind_class(const zend_op_array *op_array, const zend_op *opline, HashTable *class_table, zend_bool compile_time);
742 ZEND_API zend_class_entry *do_bind_inherited_class(const zend_op_array *op_array, const zend_op *opline, HashTable *class_table, zend_class_entry *parent_ce, zend_bool compile_time);
743 ZEND_API void zend_do_delayed_early_binding(const zend_op_array *op_array);
744
745 void zend_do_extended_info(void);
746 void zend_do_extended_fcall_begin(void);
747 void zend_do_extended_fcall_end(void);
748
749 void zend_verify_namespace(void);
750
751 void zend_resolve_goto_label(zend_op_array *op_array, zend_op *opline);
752
753 ZEND_API void function_add_ref(zend_function *function);
754
755 #define INITIAL_OP_ARRAY_SIZE 64
756
757
758 /* helper functions in zend_language_scanner.l */
759 ZEND_API zend_op_array *compile_file(zend_file_handle *file_handle, int type);
760 ZEND_API zend_op_array *compile_string(zval *source_string, char *filename);
761 ZEND_API zend_op_array *compile_filename(int type, zval *filename);
762 ZEND_API void zend_try_exception_handler();
763 ZEND_API int zend_execute_scripts(int type, zval *retval, int file_count, ...);
764 ZEND_API int open_file_for_scanning(zend_file_handle *file_handle);
765 ZEND_API void init_op_array(zend_op_array *op_array, zend_uchar type, int initial_ops_size);
766 ZEND_API void destroy_op_array(zend_op_array *op_array);
767 ZEND_API void zend_destroy_file_handle(zend_file_handle *file_handle);
768 ZEND_API void zend_cleanup_user_class_data(zend_class_entry *ce);
769 ZEND_API void zend_cleanup_internal_class_data(zend_class_entry *ce);
770 ZEND_API void zend_cleanup_internal_classes(void);
771 ZEND_API void zend_cleanup_op_array_data(zend_op_array *op_array);
772 ZEND_API int clean_non_persistent_function_full(zval *zv);
773 ZEND_API int clean_non_persistent_class_full(zval *zv);
774
775 ZEND_API void destroy_zend_function(zend_function *function);
776 ZEND_API void zend_function_dtor(zval *zv);
777 ZEND_API void destroy_zend_class(zval *zv);
778 void zend_class_add_ref(zval *zv);
779
780 ZEND_API zend_string *zend_mangle_property_name(const char *src1, size_t src1_length, const char *src2, size_t src2_length, int internal);
781 #define zend_unmangle_property_name(mangled_property, class_name, prop_name) \
782 zend_unmangle_property_name_ex(mangled_property, class_name, prop_name, NULL)
783 ZEND_API int zend_unmangle_property_name_ex(const zend_string *name, const char **class_name, const char **prop_name, size_t *prop_len);
784
785 #define ZEND_FUNCTION_DTOR zend_function_dtor
786 #define ZEND_CLASS_DTOR destroy_zend_class
787
788 zend_op *get_next_op(zend_op_array *op_array);
789 void init_op(zend_op *op);
790 uint32_t get_next_op_number(zend_op_array *op_array);
791 ZEND_API int pass_two(zend_op_array *op_array);
792 zend_brk_cont_element *get_next_brk_cont_element(void);
793 ZEND_API zend_bool zend_is_compiling(void);
794 ZEND_API char *zend_make_compiled_string_description(const char *name);
795 ZEND_API void zend_initialize_class_data(zend_class_entry *ce, zend_bool nullify_handlers);
796 uint32_t zend_get_class_fetch_type(zend_string *name);
797 ZEND_API zend_uchar zend_get_call_op(const zend_op *init_op, zend_function *fbc);
798 ZEND_API int zend_is_smart_branch(zend_op *opline);
799
800 typedef zend_bool (*zend_auto_global_callback)(zend_string *name);
801 typedef struct _zend_auto_global {
802 zend_string *name;
803 zend_auto_global_callback auto_global_callback;
804 zend_bool jit;
805 zend_bool armed;
806 } zend_auto_global;
807
808 ZEND_API int zend_register_auto_global(zend_string *name, zend_bool jit, zend_auto_global_callback auto_global_callback);
809 ZEND_API void zend_activate_auto_globals(void);
810 ZEND_API zend_bool zend_is_auto_global(zend_string *name);
811 ZEND_API zend_bool zend_is_auto_global_str(char *name, size_t len);
812 ZEND_API size_t zend_dirname(char *path, size_t len);
813 ZEND_API void zend_set_function_arg_flags(zend_function *func);
814
815 int zendlex(zend_parser_stack_elem *elem);
816
817 int zend_add_literal(zend_op_array *op_array, zval *zv);
818
819 ZEND_API void zend_assert_valid_class_name(const zend_string *const_name);
820
821 /* BEGIN: OPCODES */
822
823 #include "zend_vm_opcodes.h"
824
825 /* END: OPCODES */
826
827 /* class fetches */
828 #define ZEND_FETCH_CLASS_DEFAULT 0
829 #define ZEND_FETCH_CLASS_SELF 1
830 #define ZEND_FETCH_CLASS_PARENT 2
831 #define ZEND_FETCH_CLASS_STATIC 3
832 #define ZEND_FETCH_CLASS_AUTO 4
833 #define ZEND_FETCH_CLASS_INTERFACE 5
834 #define ZEND_FETCH_CLASS_TRAIT 6
835 #define ZEND_FETCH_CLASS_MASK 0x0f
836 #define ZEND_FETCH_CLASS_NO_AUTOLOAD 0x80
837 #define ZEND_FETCH_CLASS_SILENT 0x0100
838 #define ZEND_FETCH_CLASS_EXCEPTION 0x0200
839
840 #define ZEND_PARAM_REF (1<<0)
841 #define ZEND_PARAM_VARIADIC (1<<1)
842
843 #define ZEND_NAME_FQ 0
844 #define ZEND_NAME_NOT_FQ 1
845 #define ZEND_NAME_RELATIVE 2
846
847 #define ZEND_TYPE_NULLABLE (1<<8)
848
849 #define ZEND_ARRAY_SYNTAX_LIST 1 /* list() */
850 #define ZEND_ARRAY_SYNTAX_LONG 2 /* array() */
851 #define ZEND_ARRAY_SYNTAX_SHORT 3 /* [] */
852
853 /* var status for backpatching */
854 #define BP_VAR_R 0
855 #define BP_VAR_W 1
856 #define BP_VAR_RW 2
857 #define BP_VAR_IS 3
858 #define BP_VAR_FUNC_ARG 4
859 #define BP_VAR_UNSET 5
860
861 /* Bottom 3 bits are the type, top bits are arg num for BP_VAR_FUNC_ARG */
862 #define BP_VAR_SHIFT 3
863 #define BP_VAR_MASK 7
864
865
866 #define ZEND_INTERNAL_FUNCTION 1
867 #define ZEND_USER_FUNCTION 2
868 #define ZEND_OVERLOADED_FUNCTION 3
869 #define ZEND_EVAL_CODE 4
870 #define ZEND_OVERLOADED_FUNCTION_TEMPORARY 5
871
872 /* A quick check (type == ZEND_USER_FUNCTION || type == ZEND_EVAL_CODE) */
873 #define ZEND_USER_CODE(type) ((type & 1) == 0)
874
875 #define ZEND_INTERNAL_CLASS 1
876 #define ZEND_USER_CLASS 2
877
878 #define ZEND_EVAL (1<<0)
879 #define ZEND_INCLUDE (1<<1)
880 #define ZEND_INCLUDE_ONCE (1<<2)
881 #define ZEND_REQUIRE (1<<3)
882 #define ZEND_REQUIRE_ONCE (1<<4)
883
884 #define ZEND_CT (1<<0)
885 #define ZEND_RT (1<<1)
886
887 /* global/local fetches */
888 #define ZEND_FETCH_GLOBAL 0x00000000
889 #define ZEND_FETCH_LOCAL 0x10000000
890 #define ZEND_FETCH_GLOBAL_LOCK 0x40000000
891
892 #define ZEND_FETCH_TYPE_MASK 0x70000000
893
894 #define ZEND_FETCH_STANDARD 0x00000000
895
896 #define ZEND_ISSET 0x02000000
897 #define ZEND_ISEMPTY 0x01000000
898 #define ZEND_ISSET_ISEMPTY_MASK (ZEND_ISSET | ZEND_ISEMPTY)
899 #define ZEND_QUICK_SET 0x00800000
900
901 #define ZEND_FETCH_ARG_MASK 0x000fffff
902
903 #define ZEND_FREE_ON_RETURN (1<<0)
904
905 #define ZEND_SEND_BY_VAL 0
906 #define ZEND_SEND_BY_REF 1
907 #define ZEND_SEND_PREFER_REF 2
908
909 #define ZEND_DIM_IS 1
910
zend_check_arg_send_type(const zend_function * zf,uint32_t arg_num,uint32_t mask)911 static zend_always_inline int zend_check_arg_send_type(const zend_function *zf, uint32_t arg_num, uint32_t mask)
912 {
913 arg_num--;
914 if (UNEXPECTED(arg_num >= zf->common.num_args)) {
915 if (EXPECTED((zf->common.fn_flags & ZEND_ACC_VARIADIC) == 0)) {
916 return 0;
917 }
918 arg_num = zf->common.num_args;
919 }
920 return UNEXPECTED((zf->common.arg_info[arg_num].pass_by_reference & mask) != 0);
921 }
922
923 #define ARG_MUST_BE_SENT_BY_REF(zf, arg_num) \
924 zend_check_arg_send_type(zf, arg_num, ZEND_SEND_BY_REF)
925
926 #define ARG_SHOULD_BE_SENT_BY_REF(zf, arg_num) \
927 zend_check_arg_send_type(zf, arg_num, ZEND_SEND_BY_REF|ZEND_SEND_PREFER_REF)
928
929 #define ARG_MAY_BE_SENT_BY_REF(zf, arg_num) \
930 zend_check_arg_send_type(zf, arg_num, ZEND_SEND_PREFER_REF)
931
932 /* Quick API to check firat 12 arguments */
933 #define MAX_ARG_FLAG_NUM 12
934
935 #ifdef WORDS_BIGENDIAN
936 # define ZEND_SET_ARG_FLAG(zf, arg_num, mask) do { \
937 (zf)->quick_arg_flags |= ((mask) << ((arg_num) - 1) * 2); \
938 } while (0)
939 # define ZEND_CHECK_ARG_FLAG(zf, arg_num, mask) \
940 (((zf)->quick_arg_flags >> (((arg_num) - 1) * 2)) & (mask))
941 #else
942 # define ZEND_SET_ARG_FLAG(zf, arg_num, mask) do { \
943 (zf)->quick_arg_flags |= (((mask) << 6) << (arg_num) * 2); \
944 } while (0)
945 # define ZEND_CHECK_ARG_FLAG(zf, arg_num, mask) \
946 (((zf)->quick_arg_flags >> (((arg_num) + 3) * 2)) & (mask))
947 #endif
948
949 #define QUICK_ARG_MUST_BE_SENT_BY_REF(zf, arg_num) \
950 ZEND_CHECK_ARG_FLAG(zf, arg_num, ZEND_SEND_BY_REF)
951
952 #define QUICK_ARG_SHOULD_BE_SENT_BY_REF(zf, arg_num) \
953 ZEND_CHECK_ARG_FLAG(zf, arg_num, ZEND_SEND_BY_REF|ZEND_SEND_PREFER_REF)
954
955 #define QUICK_ARG_MAY_BE_SENT_BY_REF(zf, arg_num) \
956 ZEND_CHECK_ARG_FLAG(zf, arg_num, ZEND_SEND_PREFER_REF)
957
958 #define ZEND_RETURN_VAL 0
959 #define ZEND_RETURN_REF 1
960
961
962 #define ZEND_RETURNS_FUNCTION 1<<0
963 #define ZEND_RETURNS_VALUE 1<<1
964
965 #define ZEND_ARRAY_ELEMENT_REF (1<<0)
966 #define ZEND_ARRAY_NOT_PACKED (1<<1)
967 #define ZEND_ARRAY_SIZE_SHIFT 2
968
969 /* Pseudo-opcodes that are used only temporarily during compilation */
970 #define ZEND_GOTO 253
971 #define ZEND_BRK 254
972 #define ZEND_CONT 255
973
974
975 END_EXTERN_C()
976
977 #define ZEND_CLONE_FUNC_NAME "__clone"
978 #define ZEND_CONSTRUCTOR_FUNC_NAME "__construct"
979 #define ZEND_DESTRUCTOR_FUNC_NAME "__destruct"
980 #define ZEND_GET_FUNC_NAME "__get"
981 #define ZEND_SET_FUNC_NAME "__set"
982 #define ZEND_UNSET_FUNC_NAME "__unset"
983 #define ZEND_ISSET_FUNC_NAME "__isset"
984 #define ZEND_CALL_FUNC_NAME "__call"
985 #define ZEND_CALLSTATIC_FUNC_NAME "__callstatic"
986 #define ZEND_TOSTRING_FUNC_NAME "__tostring"
987 #define ZEND_AUTOLOAD_FUNC_NAME "__autoload"
988 #define ZEND_INVOKE_FUNC_NAME "__invoke"
989 #define ZEND_DEBUGINFO_FUNC_NAME "__debuginfo"
990
991 /* The following constants may be combined in CG(compiler_options)
992 * to change the default compiler behavior */
993
994 /* generate extended debug information */
995 #define ZEND_COMPILE_EXTENDED_INFO (1<<0)
996
997 /* call op_array handler of extendions */
998 #define ZEND_COMPILE_HANDLE_OP_ARRAY (1<<1)
999
1000 /* generate ZEND_INIT_FCALL_BY_NAME for internal functions instead of ZEND_INIT_FCALL */
1001 #define ZEND_COMPILE_IGNORE_INTERNAL_FUNCTIONS (1<<2)
1002
1003 /* don't perform early binding for classes inherited form internal ones;
1004 * in namespaces assume that internal class that doesn't exist at compile-time
1005 * may apper in run-time */
1006 #define ZEND_COMPILE_IGNORE_INTERNAL_CLASSES (1<<3)
1007
1008 /* generate ZEND_DECLARE_INHERITED_CLASS_DELAYED opcode to delay early binding */
1009 #define ZEND_COMPILE_DELAYED_BINDING (1<<4)
1010
1011 /* disable constant substitution at compile-time */
1012 #define ZEND_COMPILE_NO_CONSTANT_SUBSTITUTION (1<<5)
1013
1014 /* disable usage of builtin instruction for strlen() */
1015 #define ZEND_COMPILE_NO_BUILTIN_STRLEN (1<<6)
1016
1017 /* disable substitution of persistent constants at compile-time */
1018 #define ZEND_COMPILE_NO_PERSISTENT_CONSTANT_SUBSTITUTION (1<<7)
1019
1020 /* generate ZEND_INIT_FCALL_BY_NAME for userland functions instead of ZEND_INIT_FCALL */
1021 #define ZEND_COMPILE_IGNORE_USER_FUNCTIONS (1<<8)
1022
1023 /* force IS_OBJ_USE_GUARDS for all classes */
1024 #define ZEND_COMPILE_GUARDS (1<<9)
1025
1026 /* disable builtin special case function calls */
1027 #define ZEND_COMPILE_NO_BUILTINS (1<<10)
1028
1029 /* The default value for CG(compiler_options) */
1030 #define ZEND_COMPILE_DEFAULT ZEND_COMPILE_HANDLE_OP_ARRAY
1031
1032 /* The default value for CG(compiler_options) during eval() */
1033 #define ZEND_COMPILE_DEFAULT_FOR_EVAL 0
1034
1035 ZEND_API zend_bool zend_binary_op_produces_numeric_string_error(uint32_t opcode, zval *op1, zval *op2);
1036
1037 #endif /* ZEND_COMPILE_H */
1038
1039 /*
1040 * Local variables:
1041 * tab-width: 4
1042 * c-basic-offset: 4
1043 * indent-tabs-mode: t
1044 * End:
1045 */
1046
