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