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