xref: /PHP-5.4/Zend/zend_compile.h (revision 32314f6b)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) 1998-2014 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 
27 #ifdef HAVE_STDARG_H
28 # include <stdarg.h>
29 #endif
30 
31 #include "zend_llist.h"
32 
33 #define DEBUG_ZEND 0
34 
35 #define FREE_PNODE(znode)	zval_dtor(&znode->u.constant);
36 
37 #define SET_UNUSED(op)  op ## _type = IS_UNUSED
38 
39 #define INC_BPC(op_array)	if (op_array->fn_flags & ZEND_ACC_INTERACTIVE) { (CG(context).backpatch_count++); }
40 #define DEC_BPC(op_array)	if (op_array->fn_flags & ZEND_ACC_INTERACTIVE) { (CG(context).backpatch_count--); }
41 #define HANDLE_INTERACTIVE()  if (CG(active_op_array)->fn_flags & ZEND_ACC_INTERACTIVE) { execute_new_code(TSRMLS_C); }
42 #define DO_TICKS()            if (Z_LVAL(CG(declarables).ticks)) { zend_do_ticks(TSRMLS_C); }
43 
44 #define RESET_DOC_COMMENT()        \
45     {                              \
46         if (CG(doc_comment)) {     \
47           efree(CG(doc_comment));  \
48           CG(doc_comment) = NULL;  \
49         }                          \
50         CG(doc_comment_len) = 0;   \
51     }
52 
53 typedef struct _zend_op_array zend_op_array;
54 typedef struct _zend_op zend_op;
55 
56 typedef struct _zend_compiler_context {
57 	zend_uint  opcodes_size;
58 	int        vars_size;
59 	int        literals_size;
60 	int        current_brk_cont;
61 	int        backpatch_count;
62 	HashTable *labels;
63 } zend_compiler_context;
64 
65 typedef struct _zend_literal {
66 	zval       constant;
67 	zend_ulong hash_value;
68 	zend_uint  cache_slot;
69 } zend_literal;
70 
71 #define Z_HASH_P(zv) \
72 	(((zend_literal*)(zv))->hash_value)
73 
74 typedef union _znode_op {
75 	zend_uint      constant;
76 	zend_uint      var;
77 	zend_uint      num;
78 	zend_ulong     hash;
79 	zend_uint      opline_num; /*  Needs to be signed */
80 	zend_op       *jmp_addr;
81 	zval          *zv;
82 	zend_literal  *literal;
83   void          *ptr;        /* Used for passing pointers from the compile to execution phase, currently used for traits */
84 } znode_op;
85 
86 typedef struct _znode { /* used only during compilation */
87 	int op_type;
88 	union {
89 		znode_op op;
90 		zval constant; /* replaced by literal/zv */
91 		zend_op_array *op_array;
92 	} u;
93 	zend_uint EA;      /* extended attributes */
94 } znode;
95 
96 typedef struct _zend_execute_data zend_execute_data;
97 
98 #define ZEND_OPCODE_HANDLER_ARGS zend_execute_data *execute_data TSRMLS_DC
99 #define ZEND_OPCODE_HANDLER_ARGS_PASSTHRU execute_data TSRMLS_CC
100 
101 typedef int (*user_opcode_handler_t) (ZEND_OPCODE_HANDLER_ARGS);
102 typedef int (ZEND_FASTCALL *opcode_handler_t) (ZEND_OPCODE_HANDLER_ARGS);
103 
104 extern ZEND_API opcode_handler_t *zend_opcode_handlers;
105 
106 struct _zend_op {
107 	opcode_handler_t handler;
108 	znode_op op1;
109 	znode_op op2;
110 	znode_op result;
111 	ulong extended_value;
112 	uint lineno;
113 	zend_uchar opcode;
114 	zend_uchar op1_type;
115 	zend_uchar op2_type;
116 	zend_uchar result_type;
117 };
118 
119 
120 typedef struct _zend_brk_cont_element {
121 	int start;
122 	int cont;
123 	int brk;
124 	int parent;
125 } zend_brk_cont_element;
126 
127 typedef struct _zend_label {
128 	int brk_cont;
129 	zend_uint opline_num;
130 } zend_label;
131 
132 typedef struct _zend_try_catch_element {
133 	zend_uint try_op;
134 	zend_uint catch_op;  /* ketchup! */
135 } zend_try_catch_element;
136 
137 #if SIZEOF_LONG == 8
138 #define THIS_HASHVAL 210728972157UL
139 #else
140 #define THIS_HASHVAL 275574653UL
141 #endif
142 
143 /* method flags (types) */
144 #define ZEND_ACC_STATIC			0x01
145 #define ZEND_ACC_ABSTRACT		0x02
146 #define ZEND_ACC_FINAL			0x04
147 #define ZEND_ACC_IMPLEMENTED_ABSTRACT		0x08
148 
149 /* class flags (types) */
150 /* 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). */
151 /* ZEND_ACC_EXPLICIT_ABSTRACT_CLASS denotes that a class was explicitly defined as abstract by using the keyword. */
152 #define ZEND_ACC_IMPLICIT_ABSTRACT_CLASS	0x10
153 #define ZEND_ACC_EXPLICIT_ABSTRACT_CLASS	0x20
154 #define ZEND_ACC_FINAL_CLASS	            0x40
155 #define ZEND_ACC_INTERFACE		            0x80
156 #define ZEND_ACC_TRAIT						0x120
157 
158 /* op_array flags */
159 #define ZEND_ACC_INTERACTIVE				0x10
160 
161 /* method flags (visibility) */
162 /* The order of those must be kept - public < protected < private */
163 #define ZEND_ACC_PUBLIC		0x100
164 #define ZEND_ACC_PROTECTED	0x200
165 #define ZEND_ACC_PRIVATE	0x400
166 #define ZEND_ACC_PPP_MASK  (ZEND_ACC_PUBLIC | ZEND_ACC_PROTECTED | ZEND_ACC_PRIVATE)
167 
168 #define ZEND_ACC_CHANGED	0x800
169 #define ZEND_ACC_IMPLICIT_PUBLIC	0x1000
170 
171 /* method flags (special method detection) */
172 #define ZEND_ACC_CTOR		0x2000
173 #define ZEND_ACC_DTOR		0x4000
174 #define ZEND_ACC_CLONE		0x8000
175 
176 /* method flag (bc only), any method that has this flag can be used statically and non statically. */
177 #define ZEND_ACC_ALLOW_STATIC	0x10000
178 
179 /* shadow of parent's private method/property */
180 #define ZEND_ACC_SHADOW 0x20000
181 
182 /* deprecation flag */
183 #define ZEND_ACC_DEPRECATED 0x40000
184 
185 /* class implement interface(s) flag */
186 #define ZEND_ACC_IMPLEMENT_INTERFACES 0x80000
187 #define ZEND_ACC_IMPLEMENT_TRAITS	  0x400000
188 
189 /* class constants updated */
190 #define ZEND_ACC_CONSTANTS_UPDATED	  0x100000
191 
192 /* user class has methods with static variables */
193 #define ZEND_HAS_STATIC_IN_METHODS    0x800000
194 
195 
196 #define ZEND_ACC_CLOSURE              0x100000
197 
198 /* function flag for internal user call handlers __call, __callstatic */
199 #define ZEND_ACC_CALL_VIA_HANDLER     0x200000
200 
201 /* disable inline caching */
202 #define ZEND_ACC_NEVER_CACHE          0x400000
203 
204 #define ZEND_ACC_PASS_REST_BY_REFERENCE 0x1000000
205 #define ZEND_ACC_PASS_REST_PREFER_REF	0x2000000
206 
207 #define ZEND_ACC_RETURN_REFERENCE		0x4000000
208 #define ZEND_ACC_DONE_PASS_TWO			0x8000000
209 
210 char *zend_visibility_string(zend_uint fn_flags);
211 
212 
213 typedef struct _zend_property_info {
214 	zend_uint flags;
215 	const char *name;
216 	int name_length;
217 	ulong h;
218 	int offset;
219 	const char *doc_comment;
220 	int doc_comment_len;
221 	zend_class_entry *ce;
222 } zend_property_info;
223 
224 
225 typedef struct _zend_arg_info {
226 	const char *name;
227 	zend_uint name_len;
228 	const char *class_name;
229 	zend_uint class_name_len;
230 	zend_uchar type_hint;
231 	zend_bool allow_null;
232 	zend_bool pass_by_reference;
233 } zend_arg_info;
234 
235 /* the following structure repeats the layout of zend_arg_info,
236  * but its fields have different meaning. It's used as the first element of
237  * arg_info array to define properties of internal functions.
238  */
239 typedef struct _zend_internal_function_info {
240 	const char *_name;
241 	zend_uint _name_len;
242 	const char *_class_name;
243 	zend_uint required_num_args;
244 	zend_uchar _type_hint;
245 	zend_bool return_reference;
246 	zend_bool pass_rest_by_reference;
247 } zend_internal_function_info;
248 
249 typedef struct _zend_compiled_variable {
250 	const char *name;
251 	int name_len;
252 	ulong hash_value;
253 } zend_compiled_variable;
254 
255 struct _zend_op_array {
256 	/* Common elements */
257 	zend_uchar type;
258 	const char *function_name;
259 	zend_class_entry *scope;
260 	zend_uint fn_flags;
261 	union _zend_function *prototype;
262 	zend_uint num_args;
263 	zend_uint required_num_args;
264 	zend_arg_info *arg_info;
265 	/* END of common elements */
266 
267 	zend_uint *refcount;
268 
269 	zend_op *opcodes;
270 	zend_uint last;
271 
272 	zend_compiled_variable *vars;
273 	int last_var;
274 
275 	zend_uint T;
276 
277 	zend_brk_cont_element *brk_cont_array;
278 	int last_brk_cont;
279 
280 	zend_try_catch_element *try_catch_array;
281 	int last_try_catch;
282 
283 	/* static variables support */
284 	HashTable *static_variables;
285 
286 	zend_uint this_var;
287 
288 	const char *filename;
289 	zend_uint line_start;
290 	zend_uint line_end;
291 	const char *doc_comment;
292 	zend_uint doc_comment_len;
293 	zend_uint early_binding; /* the linked list of delayed declarations */
294 
295 	zend_literal *literals;
296 	int last_literal;
297 
298 	void **run_time_cache;
299 	int  last_cache_slot;
300 
301 	void *reserved[ZEND_MAX_RESERVED_RESOURCES];
302 };
303 
304 
305 #define ZEND_RETURN_VALUE				0
306 #define ZEND_RETURN_REFERENCE			1
307 
308 typedef struct _zend_internal_function {
309 	/* Common elements */
310 	zend_uchar type;
311 	const char * function_name;
312 	zend_class_entry *scope;
313 	zend_uint fn_flags;
314 	union _zend_function *prototype;
315 	zend_uint num_args;
316 	zend_uint required_num_args;
317 	zend_arg_info *arg_info;
318 	/* END of common elements */
319 
320 	void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
321 	struct _zend_module_entry *module;
322 } zend_internal_function;
323 
324 #define ZEND_FN_SCOPE_NAME(function)  ((function) && (function)->common.scope ? (function)->common.scope->name : "")
325 
326 typedef union _zend_function {
327 	zend_uchar type;	/* MUST be the first element of this struct! */
328 
329 	struct {
330 		zend_uchar type;  /* never used */
331 		const char *function_name;
332 		zend_class_entry *scope;
333 		zend_uint fn_flags;
334 		union _zend_function *prototype;
335 		zend_uint num_args;
336 		zend_uint required_num_args;
337 		zend_arg_info *arg_info;
338 	} common;
339 
340 	zend_op_array op_array;
341 	zend_internal_function internal_function;
342 } zend_function;
343 
344 
345 typedef struct _zend_function_state {
346 	zend_function *function;
347 	void **arguments;
348 } zend_function_state;
349 
350 
351 typedef struct _zend_switch_entry {
352 	znode cond;
353 	int default_case;
354 	int control_var;
355 } zend_switch_entry;
356 
357 
358 typedef struct _list_llist_element {
359 	znode var;
360 	zend_llist dimensions;
361 	znode value;
362 } list_llist_element;
363 
364 union _temp_variable;
365 
366 struct _zend_execute_data {
367 	struct _zend_op *opline;
368 	zend_function_state function_state;
369 	zend_function *fbc; /* Function Being Called */
370 	zend_class_entry *called_scope;
371 	zend_op_array *op_array;
372 	zval *object;
373 	union _temp_variable *Ts;
374 	zval ***CVs;
375 	HashTable *symbol_table;
376 	struct _zend_execute_data *prev_execute_data;
377 	zval *old_error_reporting;
378 	zend_bool nested;
379 	zval **original_return_value;
380 	zend_class_entry *current_scope;
381 	zend_class_entry *current_called_scope;
382 	zval *current_this;
383 	zval *current_object;
384 };
385 
386 #define EX(element) execute_data.element
387 
388 
389 #define IS_CONST	(1<<0)
390 #define IS_TMP_VAR	(1<<1)
391 #define IS_VAR		(1<<2)
392 #define IS_UNUSED	(1<<3)	/* Unused variable */
393 #define IS_CV		(1<<4)	/* Compiled variable */
394 
395 #define EXT_TYPE_UNUSED	(1<<5)
396 
397 #include "zend_globals.h"
398 
399 BEGIN_EXTERN_C()
400 
401 void init_compiler(TSRMLS_D);
402 void shutdown_compiler(TSRMLS_D);
403 void zend_init_compiler_data_structures(TSRMLS_D);
404 void zend_init_compiler_context(TSRMLS_D);
405 
406 extern ZEND_API zend_op_array *(*zend_compile_file)(zend_file_handle *file_handle, int type TSRMLS_DC);
407 extern ZEND_API zend_op_array *(*zend_compile_string)(zval *source_string, char *filename TSRMLS_DC);
408 
409 ZEND_API int lex_scan(zval *zendlval TSRMLS_DC);
410 void startup_scanner(TSRMLS_D);
411 void shutdown_scanner(TSRMLS_D);
412 
413 ZEND_API char *zend_set_compiled_filename(const char *new_compiled_filename TSRMLS_DC);
414 ZEND_API void zend_restore_compiled_filename(char *original_compiled_filename TSRMLS_DC);
415 ZEND_API char *zend_get_compiled_filename(TSRMLS_D);
416 ZEND_API int zend_get_compiled_lineno(TSRMLS_D);
417 ZEND_API size_t zend_get_scanned_file_offset(TSRMLS_D);
418 
419 void zend_resolve_non_class_name(znode *element_name, zend_bool check_namespace TSRMLS_DC);
420 void zend_resolve_class_name(znode *class_name, ulong fetch_type, int check_ns_name TSRMLS_DC);
421 ZEND_API const char* zend_get_compiled_variable_name(const zend_op_array *op_array, zend_uint var, int* name_len);
422 
423 #ifdef ZTS
424 const char *zend_get_zendtext(TSRMLS_D);
425 int zend_get_zendleng(TSRMLS_D);
426 #endif
427 
428 
429 /* parser-driven code generators */
430 void zend_do_binary_op(zend_uchar op, znode *result, const znode *op1, const znode *op2 TSRMLS_DC);
431 void zend_do_unary_op(zend_uchar op, znode *result, const znode *op1 TSRMLS_DC);
432 void zend_do_binary_assign_op(zend_uchar op, znode *result, const znode *op1, const znode *op2 TSRMLS_DC);
433 void zend_do_assign(znode *result, znode *variable, znode *value TSRMLS_DC);
434 void zend_do_assign_ref(znode *result, const znode *lvar, const znode *rvar TSRMLS_DC);
435 void fetch_simple_variable(znode *result, znode *varname, int bp TSRMLS_DC);
436 void fetch_simple_variable_ex(znode *result, znode *varname, int bp, zend_uchar op TSRMLS_DC);
437 void zend_do_indirect_references(znode *result, const znode *num_references, znode *variable TSRMLS_DC);
438 void zend_do_fetch_static_variable(znode *varname, const znode *static_assignment, int fetch_type TSRMLS_DC);
439 void zend_do_fetch_global_variable(znode *varname, const znode *static_assignment, int fetch_type TSRMLS_DC);
440 
441 void fetch_array_begin(znode *result, znode *varname, znode *first_dim TSRMLS_DC);
442 void fetch_array_dim(znode *result, const znode *parent, const znode *dim TSRMLS_DC);
443 void fetch_string_offset(znode *result, const znode *parent, const znode *offset TSRMLS_DC);
444 void zend_do_fetch_static_member(znode *result, znode *class_znode TSRMLS_DC);
445 void zend_do_print(znode *result, const znode *arg TSRMLS_DC);
446 void zend_do_echo(const znode *arg TSRMLS_DC);
447 typedef int (*unary_op_type)(zval *, zval * TSRMLS_DC);
448 typedef int (*binary_op_type)(zval *, zval *, zval * TSRMLS_DC);
449 ZEND_API unary_op_type get_unary_op(int opcode);
450 ZEND_API binary_op_type get_binary_op(int opcode);
451 
452 void zend_do_while_cond(const znode *expr, znode *close_bracket_token TSRMLS_DC);
453 void zend_do_while_end(const znode *while_token, const znode *close_bracket_token TSRMLS_DC);
454 void zend_do_do_while_begin(TSRMLS_D);
455 void zend_do_do_while_end(const znode *do_token, const znode *expr_open_bracket, const znode *expr TSRMLS_DC);
456 
457 
458 void zend_do_if_cond(const znode *cond, znode *closing_bracket_token TSRMLS_DC);
459 void zend_do_if_after_statement(const znode *closing_bracket_token, unsigned char initialize TSRMLS_DC);
460 void zend_do_if_end(TSRMLS_D);
461 
462 void zend_do_for_cond(const znode *expr, znode *second_semicolon_token TSRMLS_DC);
463 void zend_do_for_before_statement(const znode *cond_start, const znode *second_semicolon_token TSRMLS_DC);
464 void zend_do_for_end(const znode *second_semicolon_token TSRMLS_DC);
465 
466 void zend_do_pre_incdec(znode *result, const znode *op1, zend_uchar op TSRMLS_DC);
467 void zend_do_post_incdec(znode *result, const znode *op1, zend_uchar op TSRMLS_DC);
468 
469 void zend_do_begin_variable_parse(TSRMLS_D);
470 void zend_do_end_variable_parse(znode *variable, int type, int arg_offset TSRMLS_DC);
471 
472 void zend_check_writable_variable(const znode *variable);
473 
474 void zend_do_free(znode *op1 TSRMLS_DC);
475 
476 void zend_do_add_string(znode *result, const znode *op1, znode *op2 TSRMLS_DC);
477 void zend_do_add_variable(znode *result, const znode *op1, const znode *op2 TSRMLS_DC);
478 
479 int zend_do_verify_access_types(const znode *current_access_type, const znode *new_modifier);
480 void zend_do_begin_function_declaration(znode *function_token, znode *function_name, int is_method, int return_reference, znode *fn_flags_znode TSRMLS_DC);
481 void zend_do_end_function_declaration(const znode *function_token TSRMLS_DC);
482 void zend_do_receive_arg(zend_uchar op, znode *varname, const znode *offset, const znode *initialization, znode *class_type, zend_bool pass_by_reference TSRMLS_DC);
483 int zend_do_begin_function_call(znode *function_name, zend_bool check_namespace TSRMLS_DC);
484 void zend_do_begin_method_call(znode *left_bracket TSRMLS_DC);
485 void zend_do_clone(znode *result, const znode *expr TSRMLS_DC);
486 void zend_do_begin_dynamic_function_call(znode *function_name, int prefix_len TSRMLS_DC);
487 void zend_do_fetch_class(znode *result, znode *class_name TSRMLS_DC);
488 void zend_do_build_full_name(znode *result, znode *prefix, znode *name, int is_class_member TSRMLS_DC);
489 int zend_do_begin_class_member_function_call(znode *class_name, znode *method_name TSRMLS_DC);
490 void zend_do_end_function_call(znode *function_name, znode *result, const znode *argument_list, int is_method, int is_dynamic_fcall TSRMLS_DC);
491 void zend_do_return(znode *expr, int do_end_vparse TSRMLS_DC);
492 void zend_do_handle_exception(TSRMLS_D);
493 
494 void zend_do_begin_lambda_function_declaration(znode *result, znode *function_token, int return_reference, int is_static TSRMLS_DC);
495 void zend_do_fetch_lexical_variable(znode *varname, zend_bool is_ref TSRMLS_DC);
496 
497 void zend_do_try(znode *try_token TSRMLS_DC);
498 void zend_do_begin_catch(znode *try_token, znode *catch_class, znode *catch_var, znode *first_catch TSRMLS_DC);
499 void zend_do_end_catch(const znode *try_token TSRMLS_DC);
500 void zend_do_throw(const znode *expr TSRMLS_DC);
501 
502 ZEND_API int do_bind_function(const zend_op_array *op_array, zend_op *opline, HashTable *function_table, zend_bool compile_time);
503 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 TSRMLS_DC);
504 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 TSRMLS_DC);
505 ZEND_API void zend_do_inherit_interfaces(zend_class_entry *ce, const zend_class_entry *iface TSRMLS_DC);
506 ZEND_API void zend_do_implement_interface(zend_class_entry *ce, zend_class_entry *iface TSRMLS_DC);
507 void zend_do_implements_interface(znode *interface_znode TSRMLS_DC);
508 
509 /* Trait related functions */
510 void zend_do_use_trait(znode *trait_znode TSRMLS_DC);
511 void zend_prepare_reference(znode *result, znode *class_name, znode *method_name TSRMLS_DC);
512 void zend_add_trait_precedence(znode *method_reference, znode *trait_list TSRMLS_DC);
513 void zend_add_trait_alias(znode *method_reference, znode *modifiers, znode *alias TSRMLS_DC);
514 
515 ZEND_API void zend_do_implement_trait(zend_class_entry *ce, zend_class_entry *trait TSRMLS_DC);
516 ZEND_API void zend_do_bind_traits(zend_class_entry *ce TSRMLS_DC);
517 
518 ZEND_API void zend_do_inheritance(zend_class_entry *ce, zend_class_entry *parent_ce TSRMLS_DC);
519 void zend_do_early_binding(TSRMLS_D);
520 ZEND_API void zend_do_delayed_early_binding(const zend_op_array *op_array TSRMLS_DC);
521 
522 void zend_do_pass_param(znode *param, zend_uchar op, int offset TSRMLS_DC);
523 
524 
525 void zend_do_boolean_or_begin(znode *expr1, znode *op_token TSRMLS_DC);
526 void zend_do_boolean_or_end(znode *result, const znode *expr1, const znode *expr2, znode *op_token TSRMLS_DC);
527 void zend_do_boolean_and_begin(znode *expr1, znode *op_token TSRMLS_DC);
528 void zend_do_boolean_and_end(znode *result, const znode *expr1, const znode *expr2, const znode *op_token TSRMLS_DC);
529 
530 void zend_do_brk_cont(zend_uchar op, const znode *expr TSRMLS_DC);
531 
532 void zend_do_switch_cond(const znode *cond TSRMLS_DC);
533 void zend_do_switch_end(const znode *case_list TSRMLS_DC);
534 void zend_do_case_before_statement(const znode *case_list, znode *case_token, const znode *case_expr TSRMLS_DC);
535 void zend_do_case_after_statement(znode *result, const znode *case_token TSRMLS_DC);
536 void zend_do_default_before_statement(const znode *case_list, znode *default_token TSRMLS_DC);
537 
538 void zend_do_begin_class_declaration(const znode *class_token, znode *class_name, const znode *parent_class_name TSRMLS_DC);
539 void zend_do_end_class_declaration(const znode *class_token, const znode *parent_token TSRMLS_DC);
540 void zend_do_declare_property(const znode *var_name, const znode *value, zend_uint access_type TSRMLS_DC);
541 void zend_do_declare_class_constant(znode *var_name, const znode *value TSRMLS_DC);
542 
543 void zend_do_fetch_property(znode *result, znode *object, const znode *property TSRMLS_DC);
544 
545 void zend_do_halt_compiler_register(TSRMLS_D);
546 
547 void zend_do_push_object(const znode *object TSRMLS_DC);
548 void zend_do_pop_object(znode *object TSRMLS_DC);
549 
550 
551 void zend_do_begin_new_object(znode *new_token, znode *class_type TSRMLS_DC);
552 void zend_do_end_new_object(znode *result, const znode *new_token, const znode *argument_list TSRMLS_DC);
553 
554 void zend_do_fetch_constant(znode *result, znode *constant_container, znode *constant_name, int mode, zend_bool check_namespace TSRMLS_DC);
555 
556 void zend_do_shell_exec(znode *result, const znode *cmd TSRMLS_DC);
557 
558 void zend_do_init_array(znode *result, const znode *expr, const znode *offset, zend_bool is_ref TSRMLS_DC);
559 void zend_do_add_array_element(znode *result, const znode *expr, const znode *offset, zend_bool is_ref TSRMLS_DC);
560 void zend_do_add_static_array_element(znode *result, znode *offset, const znode *expr);
561 void zend_do_list_init(TSRMLS_D);
562 void zend_do_list_end(znode *result, znode *expr TSRMLS_DC);
563 void zend_do_add_list_element(const znode *element TSRMLS_DC);
564 void zend_do_new_list_begin(TSRMLS_D);
565 void zend_do_new_list_end(TSRMLS_D);
566 
567 /* Functions for a null terminated pointer list, used for traits parsing and compilation */
568 void zend_init_list(void *result, void *item TSRMLS_DC);
569 void zend_add_to_list(void *result, void *item TSRMLS_DC);
570 
571 
572 void zend_do_cast(znode *result, const znode *expr, int type TSRMLS_DC);
573 void zend_do_include_or_eval(int type, znode *result, const znode *op1 TSRMLS_DC);
574 
575 void zend_do_unset(const znode *variable TSRMLS_DC);
576 void zend_do_isset_or_isempty(int type, znode *result, znode *variable TSRMLS_DC);
577 
578 void zend_do_instanceof(znode *result, const znode *expr, const znode *class_znode, int type TSRMLS_DC);
579 
580 void zend_do_foreach_begin(znode *foreach_token, znode *open_brackets_token, znode *array, znode *as_token, int variable TSRMLS_DC);
581 void zend_do_foreach_cont(znode *foreach_token, const znode *open_brackets_token, const znode *as_token, znode *value, znode *key TSRMLS_DC);
582 void zend_do_foreach_end(const znode *foreach_token, const znode *as_token TSRMLS_DC);
583 
584 void zend_do_declare_begin(TSRMLS_D);
585 void zend_do_declare_stmt(znode *var, znode *val TSRMLS_DC);
586 void zend_do_declare_end(const znode *declare_token TSRMLS_DC);
587 
588 void zend_do_exit(znode *result, const znode *message TSRMLS_DC);
589 
590 void zend_do_begin_silence(znode *strudel_token TSRMLS_DC);
591 void zend_do_end_silence(const znode *strudel_token TSRMLS_DC);
592 
593 void zend_do_jmp_set(const znode *value, znode *jmp_token, znode *colon_token TSRMLS_DC);
594 void zend_do_jmp_set_else(znode *result, const znode *false_value, const znode *jmp_token, const znode *colon_token TSRMLS_DC);
595 
596 void zend_do_begin_qm_op(const znode *cond, znode *qm_token TSRMLS_DC);
597 void zend_do_qm_true(const znode *true_value, znode *qm_token, znode *colon_token TSRMLS_DC);
598 void zend_do_qm_false(znode *result, const znode *false_value, const znode *qm_token, const znode *colon_token TSRMLS_DC);
599 
600 void zend_do_extended_info(TSRMLS_D);
601 void zend_do_extended_fcall_begin(TSRMLS_D);
602 void zend_do_extended_fcall_end(TSRMLS_D);
603 
604 void zend_do_ticks(TSRMLS_D);
605 
606 void zend_do_abstract_method(const znode *function_name, znode *modifiers, const znode *body TSRMLS_DC);
607 
608 void zend_do_declare_constant(znode *name, znode *value TSRMLS_DC);
609 void zend_do_build_namespace_name(znode *result, znode *prefix, znode *name TSRMLS_DC);
610 void zend_do_begin_namespace(const znode *name, zend_bool with_brackets TSRMLS_DC);
611 void zend_do_end_namespace(TSRMLS_D);
612 void zend_verify_namespace(TSRMLS_D);
613 void zend_do_use(znode *name, znode *new_name, int is_global TSRMLS_DC);
614 void zend_do_end_compilation(TSRMLS_D);
615 
616 void zend_do_label(znode *label TSRMLS_DC);
617 void zend_do_goto(const znode *label TSRMLS_DC);
618 void zend_resolve_goto_label(zend_op_array *op_array, zend_op *opline, int pass2 TSRMLS_DC);
619 void zend_release_labels(int temporary TSRMLS_DC);
620 
621 ZEND_API void function_add_ref(zend_function *function);
622 
623 #define INITIAL_OP_ARRAY_SIZE 64
624 #define INITIAL_INTERACTIVE_OP_ARRAY_SIZE 8192
625 
626 
627 /* helper functions in zend_language_scanner.l */
628 ZEND_API zend_op_array *compile_file(zend_file_handle *file_handle, int type TSRMLS_DC);
629 ZEND_API zend_op_array *compile_string(zval *source_string, char *filename TSRMLS_DC);
630 ZEND_API zend_op_array *compile_filename(int type, zval *filename TSRMLS_DC);
631 ZEND_API int zend_execute_scripts(int type TSRMLS_DC, zval **retval, int file_count, ...);
632 ZEND_API int open_file_for_scanning(zend_file_handle *file_handle TSRMLS_DC);
633 ZEND_API void init_op_array(zend_op_array *op_array, zend_uchar type, int initial_ops_size TSRMLS_DC);
634 ZEND_API void destroy_op_array(zend_op_array *op_array TSRMLS_DC);
635 ZEND_API void zend_destroy_file_handle(zend_file_handle *file_handle TSRMLS_DC);
636 ZEND_API int zend_cleanup_class_data(zend_class_entry **pce TSRMLS_DC);
637 ZEND_API int zend_cleanup_user_class_data(zend_class_entry **pce TSRMLS_DC);
638 ZEND_API void zend_cleanup_internal_class_data(zend_class_entry *ce TSRMLS_DC);
639 ZEND_API void zend_cleanup_internal_classes(TSRMLS_D);
640 ZEND_API int zend_cleanup_function_data(zend_function *function TSRMLS_DC);
641 ZEND_API int zend_cleanup_function_data_full(zend_function *function TSRMLS_DC);
642 ZEND_API int clean_non_persistent_function_full(zend_function *function TSRMLS_DC);
643 ZEND_API int clean_non_persistent_class_full(zend_class_entry **ce TSRMLS_DC);
644 
645 ZEND_API void destroy_zend_function(zend_function *function TSRMLS_DC);
646 ZEND_API void zend_function_dtor(zend_function *function);
647 ZEND_API void destroy_zend_class(zend_class_entry **pce);
648 void zend_class_add_ref(zend_class_entry **ce);
649 
650 ZEND_API void zend_mangle_property_name(char **dest, int *dest_length, const char *src1, int src1_length, const char *src2, int src2_length, int internal);
651 ZEND_API int zend_unmangle_property_name(const char *mangled_property, int mangled_property_len, const char **class_name, const char **prop_name);
652 
653 #define ZEND_FUNCTION_DTOR (void (*)(void *)) zend_function_dtor
654 #define ZEND_CLASS_DTOR (void (*)(void *)) destroy_zend_class
655 
656 zend_op *get_next_op(zend_op_array *op_array TSRMLS_DC);
657 void init_op(zend_op *op TSRMLS_DC);
658 int get_next_op_number(zend_op_array *op_array);
659 int print_class(zend_class_entry *class_entry TSRMLS_DC);
660 void print_op_array(zend_op_array *op_array, int optimizations);
661 ZEND_API int pass_two(zend_op_array *op_array TSRMLS_DC);
662 zend_brk_cont_element *get_next_brk_cont_element(zend_op_array *op_array);
663 void zend_do_first_catch(znode *open_parentheses TSRMLS_DC);
664 void zend_initialize_try_catch_element(const znode *try_token TSRMLS_DC);
665 void zend_do_mark_last_catch(const znode *first_catch, const znode *last_additional_catch TSRMLS_DC);
666 ZEND_API zend_bool zend_is_compiling(TSRMLS_D);
667 ZEND_API char *zend_make_compiled_string_description(const char *name TSRMLS_DC);
668 ZEND_API void zend_initialize_class_data(zend_class_entry *ce, zend_bool nullify_handlers TSRMLS_DC);
669 int zend_get_class_fetch_type(const char *class_name, uint class_name_len);
670 
671 typedef zend_bool (*zend_auto_global_callback)(const char *name, uint name_len TSRMLS_DC);
672 typedef struct _zend_auto_global {
673 	const char *name;
674 	uint name_len;
675 	zend_auto_global_callback auto_global_callback;
676 	zend_bool jit;
677 	zend_bool armed;
678 } zend_auto_global;
679 
680 ZEND_API int zend_register_auto_global(const char *name, uint name_len, zend_bool jit, zend_auto_global_callback auto_global_callback TSRMLS_DC);
681 ZEND_API void zend_activate_auto_globals(TSRMLS_D);
682 ZEND_API zend_bool zend_is_auto_global(const char *name, uint name_len TSRMLS_DC);
683 ZEND_API zend_bool zend_is_auto_global_quick(const char *name, uint name_len, ulong hashval TSRMLS_DC);
684 ZEND_API size_t zend_dirname(char *path, size_t len);
685 
686 int zendlex(znode *zendlval TSRMLS_DC);
687 
688 int zend_add_literal(zend_op_array *op_array, const zval *zv TSRMLS_DC);
689 
690 /* BEGIN: OPCODES */
691 
692 #include "zend_vm_opcodes.h"
693 
694 #define ZEND_OP_DATA				137
695 
696 /* END: OPCODES */
697 
698 /* class fetches */
699 #define ZEND_FETCH_CLASS_DEFAULT	0
700 #define ZEND_FETCH_CLASS_SELF		1
701 #define ZEND_FETCH_CLASS_PARENT		2
702 #define ZEND_FETCH_CLASS_MAIN		3
703 #define ZEND_FETCH_CLASS_GLOBAL		4
704 #define ZEND_FETCH_CLASS_AUTO		5
705 #define ZEND_FETCH_CLASS_INTERFACE	6
706 #define ZEND_FETCH_CLASS_STATIC		7
707 #define ZEND_FETCH_CLASS_TRAIT		14
708 #define ZEND_FETCH_CLASS_MASK        0x0f
709 #define ZEND_FETCH_CLASS_NO_AUTOLOAD 0x80
710 #define ZEND_FETCH_CLASS_SILENT      0x0100
711 
712 /* variable parsing type (compile-time) */
713 #define ZEND_PARSED_MEMBER				(1<<0)
714 #define ZEND_PARSED_METHOD_CALL			(1<<1)
715 #define ZEND_PARSED_STATIC_MEMBER		(1<<2)
716 #define ZEND_PARSED_FUNCTION_CALL		(1<<3)
717 #define ZEND_PARSED_VARIABLE			(1<<4)
718 #define ZEND_PARSED_REFERENCE_VARIABLE	(1<<5)
719 #define ZEND_PARSED_NEW					(1<<6)
720 
721 
722 /* unset types */
723 #define ZEND_UNSET_REG 0
724 
725 /* var status for backpatching */
726 #define BP_VAR_R			0
727 #define BP_VAR_W			1
728 #define BP_VAR_RW			2
729 #define BP_VAR_IS			3
730 #define BP_VAR_NA			4	/* if not applicable */
731 #define BP_VAR_FUNC_ARG		5
732 #define BP_VAR_UNSET		6
733 
734 
735 #define ZEND_INTERNAL_FUNCTION				1
736 #define ZEND_USER_FUNCTION					2
737 #define ZEND_OVERLOADED_FUNCTION			3
738 #define	ZEND_EVAL_CODE						4
739 #define ZEND_OVERLOADED_FUNCTION_TEMPORARY	5
740 
741 #define ZEND_INTERNAL_CLASS         1
742 #define ZEND_USER_CLASS             2
743 
744 #define ZEND_EVAL				(1<<0)
745 #define ZEND_INCLUDE			(1<<1)
746 #define ZEND_INCLUDE_ONCE		(1<<2)
747 #define ZEND_REQUIRE			(1<<3)
748 #define ZEND_REQUIRE_ONCE		(1<<4)
749 
750 #define ZEND_CT	(1<<0)
751 #define ZEND_RT (1<<1)
752 
753 /* global/local fetches */
754 #define ZEND_FETCH_GLOBAL			0x00000000
755 #define ZEND_FETCH_LOCAL			0x10000000
756 #define ZEND_FETCH_STATIC			0x20000000
757 #define ZEND_FETCH_STATIC_MEMBER	0x30000000
758 #define ZEND_FETCH_GLOBAL_LOCK		0x40000000
759 #define ZEND_FETCH_LEXICAL			0x50000000
760 
761 #define ZEND_FETCH_TYPE_MASK		0x70000000
762 
763 #define ZEND_FETCH_STANDARD		    0x00000000
764 #define ZEND_FETCH_ADD_LOCK		    0x08000000
765 #define ZEND_FETCH_MAKE_REF		    0x04000000
766 
767 #define ZEND_ISSET				    0x02000000
768 #define ZEND_ISEMPTY			    0x01000000
769 #define ZEND_ISSET_ISEMPTY_MASK	    (ZEND_ISSET | ZEND_ISEMPTY)
770 #define ZEND_QUICK_SET			    0x00800000
771 
772 #define ZEND_FETCH_ARG_MASK         0x000fffff
773 
774 #define ZEND_FE_FETCH_BYREF	1
775 #define ZEND_FE_FETCH_WITH_KEY	2
776 
777 #define ZEND_FE_RESET_VARIABLE 		(1<<0)
778 #define ZEND_FE_RESET_REFERENCE		(1<<1)
779 #define EXT_TYPE_FREE_ON_RETURN		(1<<2)
780 
781 #define ZEND_MEMBER_FUNC_CALL	1<<0
782 
783 #define ZEND_ARG_SEND_BY_REF (1<<0)
784 #define ZEND_ARG_COMPILE_TIME_BOUND (1<<1)
785 #define ZEND_ARG_SEND_FUNCTION (1<<2)
786 #define ZEND_ARG_SEND_SILENT   (1<<3)
787 
788 #define ZEND_SEND_BY_VAL     0
789 #define ZEND_SEND_BY_REF     1
790 #define ZEND_SEND_PREFER_REF 2
791 
792 #define CHECK_ARG_SEND_TYPE(zf, arg_num, m1, m2)											\
793 	((zf) &&																				\
794 	  ((((zend_function*)(zf))->common.arg_info && 											\
795 	    arg_num <= ((zend_function*)(zf))->common.num_args) ?								\
796 	   (((zend_function *)(zf))->common.arg_info[arg_num-1].pass_by_reference & (m1)) :		\
797        (((zend_function *)(zf))->common.fn_flags & (m2))))
798 
799 #define ARG_MUST_BE_SENT_BY_REF(zf, arg_num) \
800 	CHECK_ARG_SEND_TYPE(zf, arg_num, ZEND_SEND_BY_REF, ZEND_ACC_PASS_REST_BY_REFERENCE)
801 
802 #define ARG_SHOULD_BE_SENT_BY_REF(zf, arg_num) \
803 	CHECK_ARG_SEND_TYPE(zf, arg_num, ZEND_SEND_BY_REF|ZEND_SEND_PREFER_REF, ZEND_ACC_PASS_REST_BY_REFERENCE|ZEND_ACC_PASS_REST_PREFER_REF)
804 
805 #define ARG_MAY_BE_SENT_BY_REF(zf, arg_num) \
806 	CHECK_ARG_SEND_TYPE(zf, arg_num, ZEND_SEND_PREFER_REF, ZEND_ACC_PASS_REST_PREFER_REF)
807 
808 #define ZEND_RETURN_VAL 0
809 #define ZEND_RETURN_REF 1
810 
811 
812 #define ZEND_RETURNS_FUNCTION 1<<0
813 #define ZEND_RETURNS_NEW      1<<1
814 
815 END_EXTERN_C()
816 
817 #define ZEND_CLONE_FUNC_NAME		"__clone"
818 #define ZEND_CONSTRUCTOR_FUNC_NAME	"__construct"
819 #define ZEND_DESTRUCTOR_FUNC_NAME	"__destruct"
820 #define ZEND_GET_FUNC_NAME          "__get"
821 #define ZEND_SET_FUNC_NAME          "__set"
822 #define ZEND_UNSET_FUNC_NAME        "__unset"
823 #define ZEND_ISSET_FUNC_NAME        "__isset"
824 #define ZEND_CALL_FUNC_NAME         "__call"
825 #define ZEND_CALLSTATIC_FUNC_NAME   "__callstatic"
826 #define ZEND_TOSTRING_FUNC_NAME     "__tostring"
827 #define ZEND_AUTOLOAD_FUNC_NAME     "__autoload"
828 
829 /* The following constants may be combined in CG(compiler_options)
830  * to change the default compiler behavior */
831 
832 /* generate extended debug information */
833 #define ZEND_COMPILE_EXTENDED_INFO				(1<<0)
834 
835 /* call op_array handler of extendions */
836 #define ZEND_COMPILE_HANDLE_OP_ARRAY            (1<<1)
837 
838 /* generate ZEND_DO_FCALL_BY_NAME for internal functions instead of ZEND_DO_FCALL */
839 #define ZEND_COMPILE_IGNORE_INTERNAL_FUNCTIONS	(1<<2)
840 
841 /* don't perform early binding for classes inherited form internal ones;
842  * in namespaces assume that internal class that doesn't exist at compile-time
843  * may apper in run-time */
844 #define ZEND_COMPILE_IGNORE_INTERNAL_CLASSES	(1<<3)
845 
846 /* generate ZEND_DECLARE_INHERITED_CLASS_DELAYED opcode to delay early binding */
847 #define ZEND_COMPILE_DELAYED_BINDING			(1<<4)
848 
849 /* disable constant substitution at compile-time */
850 #define ZEND_COMPILE_NO_CONSTANT_SUBSTITUTION	(1<<5)
851 
852 /* The default value for CG(compiler_options) */
853 #define ZEND_COMPILE_DEFAULT					ZEND_COMPILE_HANDLE_OP_ARRAY
854 
855 /* The default value for CG(compiler_options) during eval() */
856 #define ZEND_COMPILE_DEFAULT_FOR_EVAL			0
857 
858 #endif /* ZEND_COMPILE_H */
859 
860 /*
861  * Local variables:
862  * tab-width: 4
863  * c-basic-offset: 4
864  * indent-tabs-mode: t
865  * End:
866  */
867