1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
5 | Copyright (c) Zend Technologies Ltd. (http://www.zend.com) |
6 +----------------------------------------------------------------------+
7 | This source file is subject to version 2.00 of the Zend license, |
8 | that is bundled with this package in the file LICENSE, and is |
9 | available through the world-wide-web at the following url: |
10 | http://www.zend.com/license/2_00.txt. |
11 | If you did not receive a copy of the Zend license and are unable to |
12 | obtain it through the world-wide-web, please send a note to |
13 | license@zend.com so we can mail you a copy immediately. |
14 +----------------------------------------------------------------------+
15 | Authors: Andi Gutmans <andi@php.net> |
16 | Zeev Suraski <zeev@php.net> |
17 +----------------------------------------------------------------------+
18 */
19
20 #ifndef ZEND_H
21 #define ZEND_H
22
23 #define ZEND_VERSION "4.4.0-dev"
24
25 #define ZEND_ENGINE_3
26
27 #include "zend_types.h"
28 #include "zend_map_ptr.h"
29 #include "zend_errors.h"
30 #include "zend_alloc.h"
31 #include "zend_llist.h"
32 #include "zend_string.h"
33 #include "zend_hash.h"
34 #include "zend_ast.h"
35 #include "zend_gc.h"
36 #include "zend_variables.h"
37 #include "zend_iterators.h"
38 #include "zend_stream.h"
39 #include "zend_smart_str_public.h"
40 #include "zend_smart_string_public.h"
41 #include "zend_signal.h"
42 #include "zend_max_execution_timer.h"
43
44 #define zend_sprintf sprintf
45
46 #define HANDLE_BLOCK_INTERRUPTIONS() ZEND_SIGNAL_BLOCK_INTERRUPTIONS()
47 #define HANDLE_UNBLOCK_INTERRUPTIONS() ZEND_SIGNAL_UNBLOCK_INTERRUPTIONS()
48
49 #define INTERNAL_FUNCTION_PARAMETERS zend_execute_data *execute_data, zval *return_value
50 #define INTERNAL_FUNCTION_PARAM_PASSTHRU execute_data, return_value
51
52 #define USED_RET() \
53 (!EX(prev_execute_data) || \
54 !ZEND_USER_CODE(EX(prev_execute_data)->func->common.type) || \
55 (EX(prev_execute_data)->opline->result_type != IS_UNUSED))
56
57 #ifdef ZEND_ENABLE_STATIC_TSRMLS_CACHE
58 #define ZEND_TSRMG TSRMG_STATIC
59 #define ZEND_TSRMG_FAST TSRMG_FAST_STATIC
60 #define ZEND_TSRMLS_CACHE_EXTERN() TSRMLS_CACHE_EXTERN()
61 #define ZEND_TSRMLS_CACHE_DEFINE() TSRMLS_CACHE_DEFINE()
62 #define ZEND_TSRMLS_CACHE_UPDATE() TSRMLS_CACHE_UPDATE()
63 #define ZEND_TSRMLS_CACHE TSRMLS_CACHE
64 #else
65 #define ZEND_TSRMG TSRMG
66 #define ZEND_TSRMG_FAST TSRMG_FAST
67 #define ZEND_TSRMLS_CACHE_EXTERN()
68 #define ZEND_TSRMLS_CACHE_DEFINE()
69 #define ZEND_TSRMLS_CACHE_UPDATE()
70 #define ZEND_TSRMLS_CACHE
71 #endif
72
73 #ifndef ZEND_COMPILE_DL_EXT
74 TSRMLS_MAIN_CACHE_EXTERN()
75 #else
76 ZEND_TSRMLS_CACHE_EXTERN()
77 #endif
78
79 struct _zend_serialize_data;
80 struct _zend_unserialize_data;
81
82 typedef struct _zend_serialize_data zend_serialize_data;
83 typedef struct _zend_unserialize_data zend_unserialize_data;
84
85 typedef struct _zend_class_name {
86 zend_string *name;
87 zend_string *lc_name;
88 } zend_class_name;
89
90 typedef struct _zend_trait_method_reference {
91 zend_string *method_name;
92 zend_string *class_name;
93 } zend_trait_method_reference;
94
95 typedef struct _zend_trait_precedence {
96 zend_trait_method_reference trait_method;
97 uint32_t num_excludes;
98 zend_string *exclude_class_names[1];
99 } zend_trait_precedence;
100
101 typedef struct _zend_trait_alias {
102 zend_trait_method_reference trait_method;
103
104 /**
105 * name for method to be added
106 */
107 zend_string *alias;
108
109 /**
110 * modifiers to be set on trait method
111 */
112 uint32_t modifiers;
113 } zend_trait_alias;
114
115 typedef struct _zend_class_mutable_data {
116 zval *default_properties_table;
117 HashTable *constants_table;
118 uint32_t ce_flags;
119 HashTable *backed_enum_table;
120 } zend_class_mutable_data;
121
122 typedef struct _zend_class_dependency {
123 zend_string *name;
124 zend_class_entry *ce;
125 } zend_class_dependency;
126
127 typedef struct _zend_inheritance_cache_entry zend_inheritance_cache_entry;
128
129 typedef struct _zend_error_info {
130 int type;
131 uint32_t lineno;
132 zend_string *filename;
133 zend_string *message;
134 } zend_error_info;
135
136 struct _zend_inheritance_cache_entry {
137 zend_inheritance_cache_entry *next;
138 zend_class_entry *ce;
139 zend_class_entry *parent;
140 zend_class_dependency *dependencies;
141 uint32_t dependencies_count;
142 uint32_t num_warnings;
143 zend_error_info **warnings;
144 zend_class_entry *traits_and_interfaces[1];
145 };
146
147 struct _zend_class_entry {
148 char type;
149 zend_string *name;
150 /* class_entry or string depending on ZEND_ACC_LINKED */
151 union {
152 zend_class_entry *parent;
153 zend_string *parent_name;
154 };
155 int refcount;
156 uint32_t ce_flags;
157
158 int default_properties_count;
159 int default_static_members_count;
160 zval *default_properties_table;
161 zval *default_static_members_table;
162 ZEND_MAP_PTR_DEF(zval *, static_members_table);
163 HashTable function_table;
164 HashTable properties_info;
165 HashTable constants_table;
166
167 ZEND_MAP_PTR_DEF(zend_class_mutable_data*, mutable_data);
168 zend_inheritance_cache_entry *inheritance_cache;
169
170 struct _zend_property_info **properties_info_table;
171
172 zend_function *constructor;
173 zend_function *destructor;
174 zend_function *clone;
175 zend_function *__get;
176 zend_function *__set;
177 zend_function *__unset;
178 zend_function *__isset;
179 zend_function *__call;
180 zend_function *__callstatic;
181 zend_function *__tostring;
182 zend_function *__debugInfo;
183 zend_function *__serialize;
184 zend_function *__unserialize;
185
186 const zend_object_handlers *default_object_handlers;
187
188 /* allocated only if class implements Iterator or IteratorAggregate interface */
189 zend_class_iterator_funcs *iterator_funcs_ptr;
190 /* allocated only if class implements ArrayAccess interface */
191 zend_class_arrayaccess_funcs *arrayaccess_funcs_ptr;
192
193 /* handlers */
194 union {
195 zend_object* (*create_object)(zend_class_entry *class_type);
196 int (*interface_gets_implemented)(zend_class_entry *iface, zend_class_entry *class_type); /* a class implements this interface */
197 };
198 zend_object_iterator *(*get_iterator)(zend_class_entry *ce, zval *object, int by_ref);
199 zend_function *(*get_static_method)(zend_class_entry *ce, zend_string* method);
200
201 /* serializer callbacks */
202 int (*serialize)(zval *object, unsigned char **buffer, size_t *buf_len, zend_serialize_data *data);
203 int (*unserialize)(zval *object, zend_class_entry *ce, const unsigned char *buf, size_t buf_len, zend_unserialize_data *data);
204
205 uint32_t num_interfaces;
206 uint32_t num_traits;
207 uint32_t num_hooked_props;
208 uint32_t num_hooked_prop_variance_checks;
209
210 /* class_entry or string(s) depending on ZEND_ACC_LINKED */
211 union {
212 zend_class_entry **interfaces;
213 zend_class_name *interface_names;
214 };
215
216 zend_class_name *trait_names;
217 zend_trait_alias **trait_aliases;
218 zend_trait_precedence **trait_precedences;
219 HashTable *attributes;
220
221 uint32_t enum_backing_type;
222 HashTable *backed_enum_table;
223
224 zend_string *doc_comment;
225
226 union {
227 struct {
228 zend_string *filename;
229 uint32_t line_start;
230 uint32_t line_end;
231 } user;
232 struct {
233 const struct _zend_function_entry *builtin_functions;
234 struct _zend_module_entry *module;
235 } internal;
236 } info;
237 };
238
239 typedef union {
240 zend_max_align_t align;
241 uint64_t opaque[5];
242 } zend_random_bytes_insecure_state;
243
244 typedef struct _zend_utility_functions {
245 void (*error_function)(int type, zend_string *error_filename, const uint32_t error_lineno, zend_string *message);
246 size_t (*printf_function)(const char *format, ...) ZEND_ATTRIBUTE_PTR_FORMAT(printf, 1, 2);
247 size_t (*write_function)(const char *str, size_t str_length);
248 FILE *(*fopen_function)(zend_string *filename, zend_string **opened_path);
249 void (*message_handler)(zend_long message, const void *data);
250 zval *(*get_configuration_directive)(zend_string *name);
251 void (*ticks_function)(int ticks);
252 void (*on_timeout)(int seconds);
253 zend_result (*stream_open_function)(zend_file_handle *handle);
254 void (*printf_to_smart_string_function)(smart_string *buf, const char *format, va_list ap);
255 void (*printf_to_smart_str_function)(smart_str *buf, const char *format, va_list ap);
256 char *(*getenv_function)(const char *name, size_t name_len);
257 zend_string *(*resolve_path_function)(zend_string *filename);
258 zend_result (*random_bytes_function)(void *bytes, size_t size, char *errstr, size_t errstr_size);
259 void (*random_bytes_insecure_function)(zend_random_bytes_insecure_state *state, void *bytes, size_t size);
260 } zend_utility_functions;
261
262 typedef struct _zend_utility_values {
263 bool html_errors;
264 } zend_utility_values;
265
266 typedef size_t (*zend_write_func_t)(const char *str, size_t str_length);
267
268 #define zend_bailout() _zend_bailout(__FILE__, __LINE__)
269
270 #define zend_try \
271 { \
272 JMP_BUF *__orig_bailout = EG(bailout); \
273 JMP_BUF __bailout; \
274 \
275 EG(bailout) = &__bailout; \
276 if (SETJMP(__bailout)==0) {
277 #define zend_catch \
278 } else { \
279 EG(bailout) = __orig_bailout;
280 #define zend_end_try() \
281 } \
282 EG(bailout) = __orig_bailout; \
283 }
284 #define zend_first_try EG(bailout)=NULL; zend_try
285
286 BEGIN_EXTERN_C()
287 void zend_startup(zend_utility_functions *utility_functions);
288 void zend_shutdown(void);
289 void zend_register_standard_ini_entries(void);
290 zend_result zend_post_startup(void);
291 void zend_set_utility_values(zend_utility_values *utility_values);
292 void zend_unload_modules(void);
293
294 ZEND_API ZEND_COLD ZEND_NORETURN void _zend_bailout(const char *filename, uint32_t lineno);
295 ZEND_API size_t zend_get_page_size(void);
296
297 ZEND_API size_t zend_vspprintf(char **pbuf, size_t max_len, const char *format, va_list ap);
298 ZEND_API size_t zend_spprintf(char **message, size_t max_len, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 3, 4);
299 ZEND_API zend_string *zend_vstrpprintf(size_t max_len, const char *format, va_list ap);
300 ZEND_API zend_string *zend_strpprintf(size_t max_len, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);
301
302 /* Same as zend_spprintf and zend_strpprintf, without checking of format validity.
303 * For use with custom printf specifiers such as %H. */
304 ZEND_API size_t zend_spprintf_unchecked(char **message, size_t max_len, const char *format, ...);
305 ZEND_API zend_string *zend_strpprintf_unchecked(size_t max_len, const char *format, ...);
306
307 ZEND_API const char *get_zend_version(void);
308 ZEND_API bool zend_make_printable_zval(zval *expr, zval *expr_copy);
309 ZEND_API size_t zend_print_zval(zval *expr, int indent);
310 ZEND_API void zend_print_zval_r(zval *expr, int indent);
311 ZEND_API zend_string *zend_print_zval_r_to_str(zval *expr, int indent);
312 ZEND_API void zend_print_flat_zval_r(zval *expr);
313 void zend_print_flat_zval_r_to_buf(smart_str *str, zval *expr);
314
zend_print_variable(zval * var)315 static zend_always_inline size_t zend_print_variable(zval *var) {
316 return zend_print_zval(var, 0);
317 }
318
319 ZEND_API ZEND_COLD void zend_output_debug_string(bool trigger_break, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);
320
321 ZEND_API void zend_activate(void);
322 ZEND_API void zend_deactivate(void);
323 ZEND_API void zend_call_destructors(void);
324 ZEND_API void zend_activate_modules(void);
325 ZEND_API void zend_deactivate_modules(void);
326 ZEND_API void zend_post_deactivate_modules(void);
327
328 ZEND_API void free_estring(char **str_p);
329
330 END_EXTERN_C()
331
332 /* output support */
333 #define ZEND_WRITE(str, str_len) zend_write((str), (str_len))
334 #define ZEND_WRITE_EX(str, str_len) write_func((str), (str_len))
335 #define ZEND_PUTS(str) zend_write((str), strlen((str)))
336 #define ZEND_PUTS_EX(str) write_func((str), strlen((str)))
337 #define ZEND_PUTC(c) zend_write(&(c), 1)
338
339 BEGIN_EXTERN_C()
340 extern ZEND_API size_t (*zend_printf)(const char *format, ...) ZEND_ATTRIBUTE_PTR_FORMAT(printf, 1, 2);
341 extern ZEND_API zend_write_func_t zend_write;
342 extern ZEND_API FILE *(*zend_fopen)(zend_string *filename, zend_string **opened_path);
343 extern ZEND_API void (*zend_ticks_function)(int ticks);
344
345 /* Called by the VM in certain places like at the loop header, user function
346 * entry, and after internal function calls, if EG(vm_interrupt) has been set.
347 *
348 * If this is used to switch the EG(current_execute_data), such as implementing
349 * a coroutine scheduler, then it needs to check the top frame to see if it's
350 * an internal function. If an internal function is on top, then the frame
351 * shouldn't be switched away.
352 *
353 * Prior to PHP 8.0, this check was not necessary. In PHP 8.0,
354 * zend_call_function started calling zend_interrupt_function, and in 8.4 the
355 * DO_*CALL* opcodes started calling the zend_interrupt_function while the
356 * internal frame is still on top.
357 */
358 extern ZEND_API void (*zend_interrupt_function)(zend_execute_data *execute_data);
359
360 extern ZEND_API void (*zend_error_cb)(int type, zend_string *error_filename, const uint32_t error_lineno, zend_string *message);
361 extern ZEND_API void (*zend_on_timeout)(int seconds);
362 extern ZEND_API zend_result (*zend_stream_open_function)(zend_file_handle *handle);
363 extern void (*zend_printf_to_smart_string)(smart_string *buf, const char *format, va_list ap);
364 extern void (*zend_printf_to_smart_str)(smart_str *buf, const char *format, va_list ap);
365 extern ZEND_API char *(*zend_getenv)(const char *name, size_t name_len);
366 extern ZEND_API zend_string *(*zend_resolve_path)(zend_string *filename);
367 /* Generate 'size' random bytes into 'bytes' with the OS CSPRNG. */
368 extern ZEND_ATTRIBUTE_NONNULL ZEND_API zend_result (*zend_random_bytes)(
369 void *bytes, size_t size, char *errstr, size_t errstr_size);
370 /* Generate 'size' random bytes into 'bytes' with a general purpose PRNG (not
371 * crypto safe). 'state' must be zeroed before the first call and can be reused.
372 */
373 extern ZEND_ATTRIBUTE_NONNULL ZEND_API void (*zend_random_bytes_insecure)(
374 zend_random_bytes_insecure_state *state, void *bytes, size_t size);
375
376 /* These two callbacks are especially for opcache */
377 extern ZEND_API zend_result (*zend_post_startup_cb)(void);
378 extern ZEND_API void (*zend_post_shutdown_cb)(void);
379
380 extern ZEND_API void (*zend_accel_schedule_restart_hook)(int reason);
381
382 ZEND_API ZEND_COLD void zend_error(int type, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);
383 ZEND_API ZEND_COLD ZEND_NORETURN void zend_error_noreturn(int type, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);
384 ZEND_API ZEND_COLD ZEND_NORETURN void zend_error_noreturn_unchecked(int type, const char *format, ...);
385 /* For custom format specifiers like H */
386 ZEND_API ZEND_COLD void zend_error_unchecked(int type, const char *format, ...);
387 /* If filename is NULL the default filename is used. */
388 ZEND_API ZEND_COLD void zend_error_at(int type, zend_string *filename, uint32_t lineno, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 4, 5);
389 ZEND_API ZEND_COLD ZEND_NORETURN void zend_error_at_noreturn(int type, zend_string *filename, uint32_t lineno, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 4, 5);
390 ZEND_API ZEND_COLD void zend_error_zstr(int type, zend_string *message);
391 ZEND_API ZEND_COLD void zend_error_zstr_at(int type, zend_string *filename, uint32_t lineno, zend_string *message);
392
393 ZEND_API ZEND_COLD void zend_throw_error(zend_class_entry *exception_ce, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);
394 ZEND_API ZEND_COLD void zend_type_error(const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2);
395 ZEND_API ZEND_COLD void zend_argument_count_error(const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2);
396 ZEND_API ZEND_COLD void zend_value_error(const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2);
397 /* type should be one of the BP_VAR_* constants, only special messages happen for isset/empty and unset */
398 ZEND_API ZEND_COLD void zend_illegal_container_offset(const zend_string *container, const zval *offset, int type);
399
400 ZEND_COLD void zenderror(const char *error);
401
402 /* For internal C errors */
403 ZEND_API ZEND_COLD ZEND_NORETURN void zend_strerror_noreturn(int type, int errn, const char *message);
404
405 /* The following #define is used for code duality in PHP for Engine 1 & 2 */
406 #define ZEND_STANDARD_CLASS_DEF_PTR zend_standard_class_def
407 extern ZEND_API zend_class_entry *zend_standard_class_def;
408 extern ZEND_API zend_utility_values zend_uv;
409
410 /* If DTrace is available and enabled */
411 extern ZEND_API bool zend_dtrace_enabled;
412 END_EXTERN_C()
413
414 #define ZEND_UV(name) (zend_uv.name)
415
416 BEGIN_EXTERN_C()
417 ZEND_API void zend_message_dispatcher(zend_long message, const void *data);
418
419 ZEND_API zval *zend_get_configuration_directive(zend_string *name);
420 END_EXTERN_C()
421
422 /* Messages for applications of Zend */
423 #define ZMSG_FAILED_INCLUDE_FOPEN 1L
424 #define ZMSG_FAILED_REQUIRE_FOPEN 2L
425 #define ZMSG_FAILED_HIGHLIGHT_FOPEN 3L
426 #define ZMSG_MEMORY_LEAK_DETECTED 4L
427 #define ZMSG_MEMORY_LEAK_REPEATED 5L
428 #define ZMSG_LOG_SCRIPT_NAME 6L
429 #define ZMSG_MEMORY_LEAKS_GRAND_TOTAL 7L
430
431 typedef enum {
432 EH_NORMAL = 0,
433 EH_THROW
434 } zend_error_handling_t;
435
436 typedef struct {
437 zend_error_handling_t handling;
438 zend_class_entry *exception;
439 } zend_error_handling;
440
441 BEGIN_EXTERN_C()
442 ZEND_API void zend_save_error_handling(zend_error_handling *current);
443 ZEND_API void zend_replace_error_handling(zend_error_handling_t error_handling, zend_class_entry *exception_class, zend_error_handling *current);
444 ZEND_API void zend_restore_error_handling(zend_error_handling *saved);
445 ZEND_API void zend_begin_record_errors(void);
446 ZEND_API void zend_emit_recorded_errors(void);
447 ZEND_API void zend_free_recorded_errors(void);
448 END_EXTERN_C()
449
450 #define DEBUG_BACKTRACE_PROVIDE_OBJECT (1<<0)
451 #define DEBUG_BACKTRACE_IGNORE_ARGS (1<<1)
452
453 #include "zend_object_handlers.h"
454 #include "zend_operators.h"
455
456 #endif /* ZEND_H */
457
