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