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.1.29-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 } zend_class_mutable_data; 120 121 typedef struct _zend_class_dependency { 122 zend_string *name; 123 zend_class_entry *ce; 124 } zend_class_dependency; 125 126 typedef struct _zend_inheritance_cache_entry zend_inheritance_cache_entry; 127 128 typedef struct _zend_error_info { 129 int type; 130 uint32_t lineno; 131 zend_string *filename; 132 zend_string *message; 133 } zend_error_info; 134 135 struct _zend_inheritance_cache_entry { 136 zend_inheritance_cache_entry *next; 137 zend_class_entry *ce; 138 zend_class_entry *parent; 139 zend_class_dependency *dependencies; 140 uint32_t dependencies_count; 141 uint32_t num_warnings; 142 zend_error_info **warnings; 143 zend_class_entry *traits_and_interfaces[1]; 144 }; 145 146 struct _zend_class_entry { 147 char type; 148 zend_string *name; 149 /* class_entry or string depending on ZEND_ACC_LINKED */ 150 union { 151 zend_class_entry *parent; 152 zend_string *parent_name; 153 }; 154 int refcount; 155 uint32_t ce_flags; 156 157 int default_properties_count; 158 int default_static_members_count; 159 zval *default_properties_table; 160 zval *default_static_members_table; 161 ZEND_MAP_PTR_DEF(zval *, static_members_table); 162 HashTable function_table; 163 HashTable properties_info; 164 HashTable constants_table; 165 166 ZEND_MAP_PTR_DEF(zend_class_mutable_data*, mutable_data); 167 zend_inheritance_cache_entry *inheritance_cache; 168 169 struct _zend_property_info **properties_info_table; 170 171 zend_function *constructor; 172 zend_function *destructor; 173 zend_function *clone; 174 zend_function *__get; 175 zend_function *__set; 176 zend_function *__unset; 177 zend_function *__isset; 178 zend_function *__call; 179 zend_function *__callstatic; 180 zend_function *__tostring; 181 zend_function *__debugInfo; 182 zend_function *__serialize; 183 zend_function *__unserialize; 184 185 /* allocated only if class implements Iterator or IteratorAggregate interface */ 186 zend_class_iterator_funcs *iterator_funcs_ptr; 187 188 /* handlers */ 189 union { 190 zend_object* (*create_object)(zend_class_entry *class_type); 191 int (*interface_gets_implemented)(zend_class_entry *iface, zend_class_entry *class_type); /* a class implements this interface */ 192 }; 193 zend_object_iterator *(*get_iterator)(zend_class_entry *ce, zval *object, int by_ref); 194 zend_function *(*get_static_method)(zend_class_entry *ce, zend_string* method); 195 196 /* serializer callbacks */ 197 int (*serialize)(zval *object, unsigned char **buffer, size_t *buf_len, zend_serialize_data *data); 198 int (*unserialize)(zval *object, zend_class_entry *ce, const unsigned char *buf, size_t buf_len, zend_unserialize_data *data); 199 200 uint32_t num_interfaces; 201 uint32_t num_traits; 202 203 /* class_entry or string(s) depending on ZEND_ACC_LINKED */ 204 union { 205 zend_class_entry **interfaces; 206 zend_class_name *interface_names; 207 }; 208 209 zend_class_name *trait_names; 210 zend_trait_alias **trait_aliases; 211 zend_trait_precedence **trait_precedences; 212 HashTable *attributes; 213 214 uint32_t enum_backing_type; 215 HashTable *backed_enum_table; 216 217 union { 218 struct { 219 zend_string *filename; 220 uint32_t line_start; 221 uint32_t line_end; 222 zend_string *doc_comment; 223 } user; 224 struct { 225 const struct _zend_function_entry *builtin_functions; 226 struct _zend_module_entry *module; 227 } internal; 228 } info; 229 }; 230 231 typedef struct _zend_utility_functions { 232 void (*error_function)(int type, zend_string *error_filename, const uint32_t error_lineno, zend_string *message); 233 size_t (*printf_function)(const char *format, ...) ZEND_ATTRIBUTE_PTR_FORMAT(printf, 1, 2); 234 size_t (*write_function)(const char *str, size_t str_length); 235 FILE *(*fopen_function)(zend_string *filename, zend_string **opened_path); 236 void (*message_handler)(zend_long message, const void *data); 237 zval *(*get_configuration_directive)(zend_string *name); 238 void (*ticks_function)(int ticks); 239 void (*on_timeout)(int seconds); 240 zend_result (*stream_open_function)(zend_file_handle *handle); 241 void (*printf_to_smart_string_function)(smart_string *buf, const char *format, va_list ap); 242 void (*printf_to_smart_str_function)(smart_str *buf, const char *format, va_list ap); 243 char *(*getenv_function)(const char *name, size_t name_len); 244 zend_string *(*resolve_path_function)(zend_string *filename); 245 } zend_utility_functions; 246 247 typedef struct _zend_utility_values { 248 bool html_errors; 249 } zend_utility_values; 250 251 typedef size_t (*zend_write_func_t)(const char *str, size_t str_length); 252 253 #define zend_bailout() _zend_bailout(__FILE__, __LINE__) 254 255 #define zend_try \ 256 { \ 257 JMP_BUF *__orig_bailout = EG(bailout); \ 258 JMP_BUF __bailout; \ 259 \ 260 EG(bailout) = &__bailout; \ 261 if (SETJMP(__bailout)==0) { 262 #define zend_catch \ 263 } else { \ 264 EG(bailout) = __orig_bailout; 265 #define zend_end_try() \ 266 } \ 267 EG(bailout) = __orig_bailout; \ 268 } 269 #define zend_first_try EG(bailout)=NULL; zend_try 270 271 BEGIN_EXTERN_C() 272 void zend_startup(zend_utility_functions *utility_functions); 273 void zend_shutdown(void); 274 void zend_register_standard_ini_entries(void); 275 zend_result zend_post_startup(void); 276 void zend_set_utility_values(zend_utility_values *utility_values); 277 278 ZEND_API ZEND_COLD ZEND_NORETURN void _zend_bailout(const char *filename, uint32_t lineno); 279 ZEND_API size_t zend_get_page_size(void); 280 281 ZEND_API size_t zend_vspprintf(char **pbuf, size_t max_len, const char *format, va_list ap); 282 ZEND_API size_t zend_spprintf(char **message, size_t max_len, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 3, 4); 283 ZEND_API zend_string *zend_vstrpprintf(size_t max_len, const char *format, va_list ap); 284 ZEND_API zend_string *zend_strpprintf(size_t max_len, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3); 285 286 /* Same as zend_spprintf and zend_strpprintf, without checking of format validity. 287 * For use with custom printf specifiers such as %H. */ 288 ZEND_API size_t zend_spprintf_unchecked(char **message, size_t max_len, const char *format, ...); 289 ZEND_API zend_string *zend_strpprintf_unchecked(size_t max_len, const char *format, ...); 290 291 ZEND_API const char *get_zend_version(void); 292 ZEND_API bool zend_make_printable_zval(zval *expr, zval *expr_copy); 293 ZEND_API size_t zend_print_zval(zval *expr, int indent); 294 ZEND_API void zend_print_zval_r(zval *expr, int indent); 295 ZEND_API zend_string *zend_print_zval_r_to_str(zval *expr, int indent); 296 ZEND_API void zend_print_flat_zval_r(zval *expr); 297 void zend_print_flat_zval_r_to_buf(smart_str *str, zval *expr); 298 299 #define zend_print_variable(var) \ 300 zend_print_zval((var), 0) 301 302 ZEND_API ZEND_COLD void zend_output_debug_string(bool trigger_break, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3); 303 304 ZEND_API void zend_activate(void); 305 ZEND_API void zend_deactivate(void); 306 ZEND_API void zend_call_destructors(void); 307 ZEND_API void zend_activate_modules(void); 308 ZEND_API void zend_deactivate_modules(void); 309 ZEND_API void zend_post_deactivate_modules(void); 310 311 ZEND_API void free_estring(char **str_p); 312 313 END_EXTERN_C() 314 315 /* output support */ 316 #define ZEND_WRITE(str, str_len) zend_write((str), (str_len)) 317 #define ZEND_WRITE_EX(str, str_len) write_func((str), (str_len)) 318 #define ZEND_PUTS(str) zend_write((str), strlen((str))) 319 #define ZEND_PUTS_EX(str) write_func((str), strlen((str))) 320 #define ZEND_PUTC(c) zend_write(&(c), 1) 321 322 BEGIN_EXTERN_C() 323 extern ZEND_API size_t (*zend_printf)(const char *format, ...) ZEND_ATTRIBUTE_PTR_FORMAT(printf, 1, 2); 324 extern ZEND_API zend_write_func_t zend_write; 325 extern ZEND_API FILE *(*zend_fopen)(zend_string *filename, zend_string **opened_path); 326 extern ZEND_API void (*zend_ticks_function)(int ticks); 327 extern ZEND_API void (*zend_interrupt_function)(zend_execute_data *execute_data); 328 extern ZEND_API void (*zend_error_cb)(int type, zend_string *error_filename, const uint32_t error_lineno, zend_string *message); 329 extern ZEND_API void (*zend_on_timeout)(int seconds); 330 extern ZEND_API zend_result (*zend_stream_open_function)(zend_file_handle *handle); 331 extern void (*zend_printf_to_smart_string)(smart_string *buf, const char *format, va_list ap); 332 extern void (*zend_printf_to_smart_str)(smart_str *buf, const char *format, va_list ap); 333 extern ZEND_API char *(*zend_getenv)(const char *name, size_t name_len); 334 extern ZEND_API zend_string *(*zend_resolve_path)(zend_string *filename); 335 336 /* These two callbacks are especially for opcache */ 337 extern ZEND_API zend_result (*zend_post_startup_cb)(void); 338 extern ZEND_API void (*zend_post_shutdown_cb)(void); 339 340 ZEND_API ZEND_COLD void zend_error(int type, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3); 341 ZEND_API ZEND_COLD ZEND_NORETURN void zend_error_noreturn(int type, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3); 342 /* For custom format specifiers like H */ 343 ZEND_API ZEND_COLD void zend_error_unchecked(int type, const char *format, ...); 344 /* If filename is NULL the default filename is used. */ 345 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); 346 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); 347 ZEND_API ZEND_COLD void zend_error_zstr(int type, zend_string *message); 348 ZEND_API ZEND_COLD void zend_error_zstr_at(int type, zend_string *filename, uint32_t lineno, zend_string *message); 349 350 ZEND_API ZEND_COLD void zend_throw_error(zend_class_entry *exception_ce, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3); 351 ZEND_API ZEND_COLD void zend_type_error(const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2); 352 ZEND_API ZEND_COLD void zend_argument_count_error(const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2); 353 ZEND_API ZEND_COLD void zend_value_error(const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2); 354 355 ZEND_COLD void zenderror(const char *error); 356 357 /* For internal C errors */ 358 ZEND_API ZEND_COLD ZEND_NORETURN void zend_strerror_noreturn(int type, int errn, const char *message); 359 360 /* The following #define is used for code duality in PHP for Engine 1 & 2 */ 361 #define ZEND_STANDARD_CLASS_DEF_PTR zend_standard_class_def 362 extern ZEND_API zend_class_entry *zend_standard_class_def; 363 extern ZEND_API zend_utility_values zend_uv; 364 365 /* If DTrace is available and enabled */ 366 extern ZEND_API bool zend_dtrace_enabled; 367 END_EXTERN_C() 368 369 #define ZEND_UV(name) (zend_uv.name) 370 371 BEGIN_EXTERN_C() 372 ZEND_API void zend_message_dispatcher(zend_long message, const void *data); 373 374 ZEND_API zval *zend_get_configuration_directive(zend_string *name); 375 END_EXTERN_C() 376 377 /* Messages for applications of Zend */ 378 #define ZMSG_FAILED_INCLUDE_FOPEN 1L 379 #define ZMSG_FAILED_REQUIRE_FOPEN 2L 380 #define ZMSG_FAILED_HIGHLIGHT_FOPEN 3L 381 #define ZMSG_MEMORY_LEAK_DETECTED 4L 382 #define ZMSG_MEMORY_LEAK_REPEATED 5L 383 #define ZMSG_LOG_SCRIPT_NAME 6L 384 #define ZMSG_MEMORY_LEAKS_GRAND_TOTAL 7L 385 386 typedef enum { 387 EH_NORMAL = 0, 388 EH_THROW 389 } zend_error_handling_t; 390 391 typedef struct { 392 zend_error_handling_t handling; 393 zend_class_entry *exception; 394 } zend_error_handling; 395 396 BEGIN_EXTERN_C() 397 ZEND_API void zend_save_error_handling(zend_error_handling *current); 398 ZEND_API void zend_replace_error_handling(zend_error_handling_t error_handling, zend_class_entry *exception_class, zend_error_handling *current); 399 ZEND_API void zend_restore_error_handling(zend_error_handling *saved); 400 ZEND_API void zend_begin_record_errors(void); 401 ZEND_API void zend_emit_recorded_errors(void); 402 ZEND_API void zend_free_recorded_errors(void); 403 END_EXTERN_C() 404 405 #define DEBUG_BACKTRACE_PROVIDE_OBJECT (1<<0) 406 #define DEBUG_BACKTRACE_IGNORE_ARGS (1<<1) 407 408 #include "zend_object_handlers.h" 409 #include "zend_operators.h" 410 411 #endif /* ZEND_H */ 412
