1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
5 | Copyright (c) 1998-2018 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 | Andrei Zmievski <andrei@php.net> |
18 | Dmitry Stogov <dmitry@zend.com> |
19 +----------------------------------------------------------------------+
20 */
21
22 /* $Id$ */
23
24 #ifndef ZEND_API_H
25 #define ZEND_API_H
26
27 #include "zend_modules.h"
28 #include "zend_list.h"
29 #include "zend_operators.h"
30 #include "zend_variables.h"
31 #include "zend_execute.h"
32
33
34 BEGIN_EXTERN_C()
35
36 typedef struct _zend_function_entry {
37 const char *fname;
38 void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
39 const struct _zend_internal_arg_info *arg_info;
40 uint32_t num_args;
41 uint32_t flags;
42 } zend_function_entry;
43
44 typedef struct _zend_fcall_info {
45 size_t size;
46 zval function_name;
47 zval *retval;
48 zval *params;
49 zend_object *object;
50 zend_bool no_separation;
51 uint32_t param_count;
52 } zend_fcall_info;
53
54 typedef struct _zend_fcall_info_cache {
55 zend_bool initialized;
56 zend_function *function_handler;
57 zend_class_entry *calling_scope;
58 zend_class_entry *called_scope;
59 zend_object *object;
60 } zend_fcall_info_cache;
61
62 #define ZEND_NS_NAME(ns, name) ns "\\" name
63
64 #define ZEND_FN(name) zif_##name
65 #define ZEND_MN(name) zim_##name
66 #define ZEND_NAMED_FUNCTION(name) void name(INTERNAL_FUNCTION_PARAMETERS)
67 #define ZEND_FUNCTION(name) ZEND_NAMED_FUNCTION(ZEND_FN(name))
68 #define ZEND_METHOD(classname, name) ZEND_NAMED_FUNCTION(ZEND_MN(classname##_##name))
69
70 #define ZEND_FENTRY(zend_name, name, arg_info, flags) { #zend_name, name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_internal_arg_info)-1), flags },
71
72 #define ZEND_RAW_FENTRY(zend_name, name, arg_info, flags) { zend_name, name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_internal_arg_info)-1), flags },
73 #define ZEND_RAW_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0)
74
75 #define ZEND_NAMED_FE(zend_name, name, arg_info) ZEND_FENTRY(zend_name, name, arg_info, 0)
76 #define ZEND_FE(name, arg_info) ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
77 #define ZEND_DEP_FE(name, arg_info) ZEND_FENTRY(name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
78 #define ZEND_FALIAS(name, alias, arg_info) ZEND_FENTRY(name, ZEND_FN(alias), arg_info, 0)
79 #define ZEND_DEP_FALIAS(name, alias, arg_info) ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
80 #define ZEND_NAMED_ME(zend_name, name, arg_info, flags) ZEND_FENTRY(zend_name, name, arg_info, flags)
81 #define ZEND_ME(classname, name, arg_info, flags) ZEND_FENTRY(name, ZEND_MN(classname##_##name), arg_info, flags)
82 #define ZEND_ABSTRACT_ME(classname, name, arg_info) ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
83 #define ZEND_MALIAS(classname, name, alias, arg_info, flags) \
84 ZEND_FENTRY(name, ZEND_MN(classname##_##alias), arg_info, flags)
85 #define ZEND_ME_MAPPING(name, func_name, arg_types, flags) ZEND_NAMED_ME(name, ZEND_FN(func_name), arg_types, flags)
86
87 #define ZEND_NS_FENTRY(ns, zend_name, name, arg_info, flags) ZEND_RAW_FENTRY(ZEND_NS_NAME(ns, #zend_name), name, arg_info, flags)
88
89 #define ZEND_NS_RAW_FENTRY(ns, zend_name, name, arg_info, flags) ZEND_RAW_FENTRY(ZEND_NS_NAME(ns, zend_name), name, arg_info, flags)
90 #define ZEND_NS_RAW_NAMED_FE(ns, zend_name, name, arg_info) ZEND_NS_RAW_FENTRY(ns, #zend_name, name, arg_info, 0)
91
92 #define ZEND_NS_NAMED_FE(ns, zend_name, name, arg_info) ZEND_NS_FENTRY(ns, zend_name, name, arg_info, 0)
93 #define ZEND_NS_FE(ns, name, arg_info) ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, 0)
94 #define ZEND_NS_DEP_FE(ns, name, arg_info) ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
95 #define ZEND_NS_FALIAS(ns, name, alias, arg_info) ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, 0)
96 #define ZEND_NS_DEP_FALIAS(ns, name, alias, arg_info) ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
97
98 #define ZEND_FE_END { NULL, NULL, NULL, 0, 0 }
99
100 #define ZEND_ARG_INFO(pass_by_ref, name) { #name, NULL, 0, pass_by_ref, 0, 0 },
101 #define ZEND_ARG_PASS_INFO(pass_by_ref) { NULL, NULL, 0, pass_by_ref, 0, 0 },
102 #define ZEND_ARG_OBJ_INFO(pass_by_ref, name, classname, allow_null) { #name, #classname, IS_OBJECT, pass_by_ref, allow_null, 0 },
103 #define ZEND_ARG_ARRAY_INFO(pass_by_ref, name, allow_null) { #name, NULL, IS_ARRAY, pass_by_ref, allow_null, 0 },
104 #define ZEND_ARG_CALLABLE_INFO(pass_by_ref, name, allow_null) { #name, NULL, IS_CALLABLE, pass_by_ref, allow_null, 0 },
105 #define ZEND_ARG_TYPE_INFO(pass_by_ref, name, type_hint, allow_null) { #name, NULL, type_hint, pass_by_ref, allow_null, 0 },
106 #define ZEND_ARG_VARIADIC_INFO(pass_by_ref, name) { #name, NULL, 0, pass_by_ref, 0, 1 },
107
108
109 #define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, type, class_name, allow_null) \
110 static const zend_internal_arg_info name[] = { \
111 { (const char*)(zend_uintptr_t)(required_num_args), class_name, type, return_reference, allow_null, 0 },
112 #define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO(name, type, class_name, allow_null) \
113 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, 0, -1, type, class_name, allow_null)
114
115 #define ZEND_BEGIN_ARG_INFO_EX(name, _unused, return_reference, required_num_args) \
116 static const zend_internal_arg_info name[] = { \
117 { (const char*)(zend_uintptr_t)(required_num_args), NULL, 0, return_reference, 0, 0 },
118 #define ZEND_BEGIN_ARG_INFO(name, _unused) \
119 ZEND_BEGIN_ARG_INFO_EX(name, 0, ZEND_RETURN_VALUE, -1)
120 #define ZEND_END_ARG_INFO() };
121
122 /* Name macros */
123 #define ZEND_MODULE_STARTUP_N(module) zm_startup_##module
124 #define ZEND_MODULE_SHUTDOWN_N(module) zm_shutdown_##module
125 #define ZEND_MODULE_ACTIVATE_N(module) zm_activate_##module
126 #define ZEND_MODULE_DEACTIVATE_N(module) zm_deactivate_##module
127 #define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module) zm_post_zend_deactivate_##module
128 #define ZEND_MODULE_INFO_N(module) zm_info_##module
129 #define ZEND_MODULE_GLOBALS_CTOR_N(module) zm_globals_ctor_##module
130 #define ZEND_MODULE_GLOBALS_DTOR_N(module) zm_globals_dtor_##module
131
132 /* Declaration macros */
133 #define ZEND_MODULE_STARTUP_D(module) int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
134 #define ZEND_MODULE_SHUTDOWN_D(module) int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
135 #define ZEND_MODULE_ACTIVATE_D(module) int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
136 #define ZEND_MODULE_DEACTIVATE_D(module) int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
137 #define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module) int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
138 #define ZEND_MODULE_INFO_D(module) void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
139 #define ZEND_MODULE_GLOBALS_CTOR_D(module) void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals)
140 #define ZEND_MODULE_GLOBALS_DTOR_D(module) void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals)
141
142 #define ZEND_GET_MODULE(name) \
143 BEGIN_EXTERN_C()\
144 ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
145 END_EXTERN_C()
146
147 #define ZEND_BEGIN_MODULE_GLOBALS(module_name) \
148 typedef struct _zend_##module_name##_globals {
149 #define ZEND_END_MODULE_GLOBALS(module_name) \
150 } zend_##module_name##_globals;
151
152 #ifdef ZTS
153
154 #define ZEND_DECLARE_MODULE_GLOBALS(module_name) \
155 ts_rsrc_id module_name##_globals_id;
156 #define ZEND_EXTERN_MODULE_GLOBALS(module_name) \
157 extern ts_rsrc_id module_name##_globals_id;
158 #define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor) \
159 ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
160 #define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) ZEND_TSRMG(module_name##_globals_id, zend_##module_name##_globals *, v)
161 #if ZEND_ENABLE_STATIC_TSRMLS_CACHE
162 #define ZEND_MODULE_GLOBALS_BULK(module_name) TSRMG_BULK_STATIC(module_name##_globals_id, zend_##module_name##_globals *)
163 #else
164 #define ZEND_MODULE_GLOBALS_BULK(module_name) TSRMG_BULK(module_name##_globals_id, zend_##module_name##_globals *)
165 #endif
166
167 #else
168
169 #define ZEND_DECLARE_MODULE_GLOBALS(module_name) \
170 zend_##module_name##_globals module_name##_globals;
171 #define ZEND_EXTERN_MODULE_GLOBALS(module_name) \
172 extern zend_##module_name##_globals module_name##_globals;
173 #define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor) \
174 globals_ctor(&module_name##_globals);
175 #define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) (module_name##_globals.v)
176 #define ZEND_MODULE_GLOBALS_BULK(module_name) (&module_name##_globals)
177
178 #endif
179
180 #define INIT_CLASS_ENTRY(class_container, class_name, functions) \
181 INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
182
183 #define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
184 INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, NULL, NULL, NULL, NULL, NULL)
185
186 #define INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
187 { \
188 zend_string *cl_name; \
189 cl_name = zend_string_init(class_name, class_name_len, 1); \
190 class_container.name = zend_new_interned_string(cl_name); \
191 INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
192 }
193
194 #define INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
195 { \
196 class_container.constructor = NULL; \
197 class_container.destructor = NULL; \
198 class_container.clone = NULL; \
199 class_container.serialize = NULL; \
200 class_container.unserialize = NULL; \
201 class_container.create_object = NULL; \
202 class_container.interface_gets_implemented = NULL; \
203 class_container.get_static_method = NULL; \
204 class_container.__call = handle_fcall; \
205 class_container.__callstatic = NULL; \
206 class_container.__tostring = NULL; \
207 class_container.__get = handle_propget; \
208 class_container.__set = handle_propset; \
209 class_container.__unset = handle_propunset; \
210 class_container.__isset = handle_propisset; \
211 class_container.__debugInfo = NULL; \
212 class_container.serialize_func = NULL; \
213 class_container.unserialize_func = NULL; \
214 class_container.serialize = NULL; \
215 class_container.unserialize = NULL; \
216 class_container.parent = NULL; \
217 class_container.num_interfaces = 0; \
218 class_container.traits = NULL; \
219 class_container.num_traits = 0; \
220 class_container.trait_aliases = NULL; \
221 class_container.trait_precedences = NULL; \
222 class_container.interfaces = NULL; \
223 class_container.get_iterator = NULL; \
224 class_container.iterator_funcs.funcs = NULL; \
225 class_container.info.internal.module = NULL; \
226 class_container.info.internal.builtin_functions = functions; \
227 }
228
229 #define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
230 INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, sizeof(class_name)-1, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
231
232 #define INIT_NS_CLASS_ENTRY(class_container, ns, class_name, functions) \
233 INIT_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions)
234 #define INIT_OVERLOADED_NS_CLASS_ENTRY_EX(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
235 INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, ZEND_NS_NAME(ns, class_name), sizeof(ZEND_NS_NAME(ns, class_name))-1, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset)
236 #define INIT_OVERLOADED_NS_CLASS_ENTRY(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset) \
237 INIT_OVERLOADED_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions, handle_fcall, handle_propget, handle_propset)
238
239 #ifdef ZTS
240 # define CE_STATIC_MEMBERS(ce) (((ce)->type==ZEND_USER_CLASS)?(ce)->static_members_table:CG(static_members_table)[(zend_intptr_t)(ce)->static_members_table])
241 #else
242 # define CE_STATIC_MEMBERS(ce) ((ce)->static_members_table)
243 #endif
244
245 #define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
246
247 ZEND_API int zend_next_free_module(void);
248
249 BEGIN_EXTERN_C()
250 ZEND_API int zend_get_parameters(int ht, int param_count, ...);
251 ZEND_API ZEND_ATTRIBUTE_DEPRECATED int zend_get_parameters_ex(int param_count, ...);
252 ZEND_API int _zend_get_parameters_array_ex(int param_count, zval *argument_array);
253
254 /* internal function to efficiently copy parameters when executing __call() */
255 ZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array);
256
257 #define zend_get_parameters_array(ht, param_count, argument_array) \
258 _zend_get_parameters_array_ex(param_count, argument_array)
259 #define zend_get_parameters_array_ex(param_count, argument_array) \
260 _zend_get_parameters_array_ex(param_count, argument_array)
261 #define zend_parse_parameters_none() \
262 (EXPECTED(ZEND_NUM_ARGS() == 0) ? SUCCESS : zend_parse_parameters(ZEND_NUM_ARGS(), ""))
263
264 /* Parameter parsing API -- andrei */
265
266 #define ZEND_PARSE_PARAMS_QUIET (1<<1)
267 #define ZEND_PARSE_PARAMS_THROW (1<<2)
268 ZEND_API int zend_parse_parameters(int num_args, const char *type_spec, ...);
269 ZEND_API int zend_parse_parameters_ex(int flags, int num_args, const char *type_spec, ...);
270 ZEND_API int zend_parse_parameters_throw(int num_args, const char *type_spec, ...);
271 ZEND_API char *zend_zval_type_name(const zval *arg);
272
273 ZEND_API int zend_parse_method_parameters(int num_args, zval *this_ptr, const char *type_spec, ...);
274 ZEND_API int zend_parse_method_parameters_ex(int flags, int num_args, zval *this_ptr, const char *type_spec, ...);
275
276 ZEND_API int zend_parse_parameter(int flags, int arg_num, zval *arg, const char *spec, ...);
277
278 /* End of parameter parsing API -- andrei */
279
280 ZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type);
281 ZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table);
282 ZEND_API int zend_startup_module(zend_module_entry *module_entry);
283 ZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry);
284 ZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module);
285 ZEND_API int zend_startup_module_ex(zend_module_entry *module);
286 ZEND_API int zend_startup_modules(void);
287 ZEND_API void zend_collect_module_handlers(void);
288 ZEND_API void zend_destroy_modules(void);
289 ZEND_API void zend_check_magic_method_implementation(const zend_class_entry *ce, const zend_function *fptr, int error_type);
290
291 ZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry);
292 ZEND_API zend_class_entry *zend_register_internal_class_ex(zend_class_entry *class_entry, zend_class_entry *parent_ce);
293 ZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry);
294 ZEND_API void zend_class_implements(zend_class_entry *class_entry, int num_interfaces, ...);
295
296 ZEND_API int zend_register_class_alias_ex(const char *name, size_t name_len, zend_class_entry *ce);
297
298 #define zend_register_class_alias(name, ce) \
299 zend_register_class_alias_ex(name, sizeof(name)-1, ce)
300 #define zend_register_ns_class_alias(ns, name, ce) \
301 zend_register_class_alias_ex(ZEND_NS_NAME(ns, name), sizeof(ZEND_NS_NAME(ns, name))-1, ce)
302
303 ZEND_API int zend_disable_function(char *function_name, size_t function_name_length);
304 ZEND_API int zend_disable_class(char *class_name, size_t class_name_length);
305
306 ZEND_API ZEND_COLD void zend_wrong_param_count(void);
307
308 #define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
309 #define IS_CALLABLE_CHECK_NO_ACCESS (1<<1)
310 #define IS_CALLABLE_CHECK_IS_STATIC (1<<2)
311 #define IS_CALLABLE_CHECK_SILENT (1<<3)
312
313 #define IS_CALLABLE_STRICT (IS_CALLABLE_CHECK_IS_STATIC)
314
315 ZEND_API zend_bool zend_is_callable_ex(zval *callable, zend_object *object, uint check_flags, zend_string **callable_name, zend_fcall_info_cache *fcc, char **error);
316 ZEND_API zend_bool zend_is_callable(zval *callable, uint check_flags, zend_string **callable_name);
317 ZEND_API zend_bool zend_make_callable(zval *callable, zend_string **callable_name);
318 ZEND_API const char *zend_get_module_version(const char *module_name);
319 ZEND_API int zend_get_module_started(const char *module_name);
320 ZEND_API int zend_declare_property_ex(zend_class_entry *ce, zend_string *name, zval *property, int access_type, zend_string *doc_comment);
321 ZEND_API int zend_declare_property(zend_class_entry *ce, const char *name, size_t name_length, zval *property, int access_type);
322 ZEND_API int zend_declare_property_null(zend_class_entry *ce, const char *name, size_t name_length, int access_type);
323 ZEND_API int zend_declare_property_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
324 ZEND_API int zend_declare_property_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
325 ZEND_API int zend_declare_property_double(zend_class_entry *ce, const char *name, size_t name_length, double value, int access_type);
326 ZEND_API int zend_declare_property_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value, int access_type);
327 ZEND_API int zend_declare_property_stringl(zend_class_entry *ce, const char *name, size_t name_length, const char *value, size_t value_len, int access_type);
328
329 ZEND_API int zend_declare_class_constant_ex(zend_class_entry *ce, zend_string *name, zval *value, int access_type, zend_string *doc_comment);
330 ZEND_API int zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value);
331 ZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length);
332 ZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value);
333 ZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_bool value);
334 ZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value);
335 ZEND_API int zend_declare_class_constant_stringl(zend_class_entry *ce, const char *name, size_t name_length, const char *value, size_t value_length);
336 ZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value);
337
338 ZEND_API int zend_update_class_constants(zend_class_entry *class_type);
339
340 ZEND_API void zend_update_property_ex(zend_class_entry *scope, zval *object, zend_string *name, zval *value);
341 ZEND_API void zend_update_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zval *value);
342 ZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, const char *name, size_t name_length);
343 ZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
344 ZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
345 ZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, const char *name, size_t name_length, double value);
346 ZEND_API void zend_update_property_str(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_string *value);
347 ZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, const char *name, size_t name_length, const char *value);
348 ZEND_API void zend_update_property_stringl(zend_class_entry *scope, zval *object, const char *name, size_t name_length, const char *value, size_t value_length);
349 ZEND_API void zend_unset_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length);
350
351 ZEND_API int zend_update_static_property(zend_class_entry *scope, const char *name, size_t name_length, zval *value);
352 ZEND_API int zend_update_static_property_null(zend_class_entry *scope, const char *name, size_t name_length);
353 ZEND_API int zend_update_static_property_bool(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
354 ZEND_API int zend_update_static_property_long(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
355 ZEND_API int zend_update_static_property_double(zend_class_entry *scope, const char *name, size_t name_length, double value);
356 ZEND_API int zend_update_static_property_string(zend_class_entry *scope, const char *name, size_t name_length, const char *value);
357 ZEND_API int zend_update_static_property_stringl(zend_class_entry *scope, const char *name, size_t name_length, const char *value, size_t value_length);
358
359 ZEND_API zval *zend_read_property_ex(zend_class_entry *scope, zval *object, zend_string *name, zend_bool silent, zval *rv);
360 ZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_bool silent, zval *rv);
361
362 ZEND_API zval *zend_read_static_property(zend_class_entry *scope, const char *name, size_t name_length, zend_bool silent);
363
364 ZEND_API char *zend_get_type_by_const(int type);
365
366 #define getThis() ((Z_TYPE(EX(This)) == IS_OBJECT) ? &EX(This) : NULL)
367 #define ZEND_IS_METHOD_CALL() (EX(func)->common.scope != NULL)
368
369 #define WRONG_PARAM_COUNT ZEND_WRONG_PARAM_COUNT()
370 #define WRONG_PARAM_COUNT_WITH_RETVAL(ret) ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
371 #define ARG_COUNT(dummy) EX_NUM_ARGS()
372 #define ZEND_NUM_ARGS() EX_NUM_ARGS()
373 #define ZEND_WRONG_PARAM_COUNT() { zend_wrong_param_count(); return; }
374 #define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret) { zend_wrong_param_count(); return ret; }
375
376 #ifndef ZEND_WIN32
377 #define DLEXPORT
378 #endif
379
380 #define array_init(arg) _array_init((arg), 0 ZEND_FILE_LINE_CC)
381 #define array_init_size(arg, size) _array_init((arg), (size) ZEND_FILE_LINE_CC)
382 #define object_init(arg) _object_init((arg) ZEND_FILE_LINE_CC)
383 #define object_init_ex(arg, ce) _object_init_ex((arg), (ce) ZEND_FILE_LINE_CC)
384 #define object_and_properties_init(arg, ce, properties) _object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC)
385 ZEND_API int _array_init(zval *arg, uint32_t size ZEND_FILE_LINE_DC);
386 ZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC);
387 ZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC);
388 ZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC);
389 ZEND_API void object_properties_init(zend_object *object, zend_class_entry *class_type);
390 ZEND_API void object_properties_init_ex(zend_object *object, HashTable *properties);
391 ZEND_API void object_properties_load(zend_object *object, HashTable *properties);
392
393 ZEND_API void zend_merge_properties(zval *obj, HashTable *properties);
394
395 ZEND_API int add_assoc_long_ex(zval *arg, const char *key, size_t key_len, zend_long n);
396 ZEND_API int add_assoc_null_ex(zval *arg, const char *key, size_t key_len);
397 ZEND_API int add_assoc_bool_ex(zval *arg, const char *key, size_t key_len, int b);
398 ZEND_API int add_assoc_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
399 ZEND_API int add_assoc_double_ex(zval *arg, const char *key, size_t key_len, double d);
400 ZEND_API int add_assoc_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
401 ZEND_API int add_assoc_string_ex(zval *arg, const char *key, size_t key_len, char *str);
402 ZEND_API int add_assoc_stringl_ex(zval *arg, const char *key, size_t key_len, char *str, size_t length);
403 ZEND_API int add_assoc_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
404
405 #define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key), __n)
406 #define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
407 #define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key), __b)
408 #define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key), __r)
409 #define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key), __d)
410 #define add_assoc_str(__arg, __key, __str) add_assoc_str_ex(__arg, __key, strlen(__key), __str)
411 #define add_assoc_string(__arg, __key, __str) add_assoc_string_ex(__arg, __key, strlen(__key), __str)
412 #define add_assoc_stringl(__arg, __key, __str, __length) add_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
413 #define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key), __value)
414
415 /* unset() functions are only suported for legacy modules and null() functions should be used */
416 #define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
417 #define add_index_unset(__arg, __key) add_index_null(__arg, __key)
418 #define add_next_index_unset(__arg) add_next_index_null(__arg)
419 #define add_property_unset(__arg, __key) add_property_null(__arg, __key)
420
421 ZEND_API int add_index_long(zval *arg, zend_ulong idx, zend_long n);
422 ZEND_API int add_index_null(zval *arg, zend_ulong idx);
423 ZEND_API int add_index_bool(zval *arg, zend_ulong idx, int b);
424 ZEND_API int add_index_resource(zval *arg, zend_ulong idx, zend_resource *r);
425 ZEND_API int add_index_double(zval *arg, zend_ulong idx, double d);
426 ZEND_API int add_index_str(zval *arg, zend_ulong idx, zend_string *str);
427 ZEND_API int add_index_string(zval *arg, zend_ulong idx, const char *str);
428 ZEND_API int add_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
429 ZEND_API int add_index_zval(zval *arg, zend_ulong index, zval *value);
430
431 ZEND_API int add_next_index_long(zval *arg, zend_long n);
432 ZEND_API int add_next_index_null(zval *arg);
433 ZEND_API int add_next_index_bool(zval *arg, int b);
434 ZEND_API int add_next_index_resource(zval *arg, zend_resource *r);
435 ZEND_API int add_next_index_double(zval *arg, double d);
436 ZEND_API int add_next_index_str(zval *arg, zend_string *str);
437 ZEND_API int add_next_index_string(zval *arg, const char *str);
438 ZEND_API int add_next_index_stringl(zval *arg, const char *str, size_t length);
439 ZEND_API int add_next_index_zval(zval *arg, zval *value);
440
441 ZEND_API zval *add_get_assoc_string_ex(zval *arg, const char *key, uint key_len, const char *str);
442 ZEND_API zval *add_get_assoc_stringl_ex(zval *arg, const char *key, uint key_len, const char *str, size_t length);
443
444 #define add_get_assoc_string(__arg, __key, __str) add_get_assoc_string_ex(__arg, __key, strlen(__key), __str)
445 #define add_get_assoc_stringl(__arg, __key, __str, __length) add_get_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
446
447 ZEND_API zval *add_get_index_long(zval *arg, zend_ulong idx, zend_long l);
448 ZEND_API zval *add_get_index_double(zval *arg, zend_ulong idx, double d);
449 ZEND_API zval *add_get_index_str(zval *arg, zend_ulong index, zend_string *str);
450 ZEND_API zval *add_get_index_string(zval *arg, zend_ulong idx, const char *str);
451 ZEND_API zval *add_get_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
452
453 ZEND_API int array_set_zval_key(HashTable *ht, zval *key, zval *value);
454
455 ZEND_API int add_property_long_ex(zval *arg, const char *key, size_t key_len, zend_long l);
456 ZEND_API int add_property_null_ex(zval *arg, const char *key, size_t key_len);
457 ZEND_API int add_property_bool_ex(zval *arg, const char *key, size_t key_len, zend_long b);
458 ZEND_API int add_property_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
459 ZEND_API int add_property_double_ex(zval *arg, const char *key, size_t key_len, double d);
460 ZEND_API int add_property_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
461 ZEND_API int add_property_string_ex(zval *arg, const char *key, size_t key_len, const char *str);
462 ZEND_API int add_property_stringl_ex(zval *arg, const char *key, size_t key_len, const char *str, size_t length);
463 ZEND_API int add_property_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
464
465 #define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key), __n)
466 #define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key))
467 #define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key), __b)
468 #define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key), __r)
469 #define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key), __d)
470 #define add_property_str(__arg, __key, __str) add_property_str_ex(__arg, __key, strlen(__key), __str)
471 #define add_property_string(__arg, __key, __str) add_property_string_ex(__arg, __key, strlen(__key), __str)
472 #define add_property_stringl(__arg, __key, __str, __length) add_property_stringl_ex(__arg, __key, strlen(__key), __str, __length)
473 #define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key), __value)
474
475
476 ZEND_API int _call_user_function_ex(zval *object, zval *function_name, zval *retval_ptr, uint32_t param_count, zval params[], int no_separation);
477
478 #define call_user_function(function_table, object, function_name, retval_ptr, param_count, params) \
479 _call_user_function_ex(object, function_name, retval_ptr, param_count, params, 1)
480 #define call_user_function_ex(function_table, object, function_name, retval_ptr, param_count, params, no_separation, symbol_table) \
481 _call_user_function_ex(object, function_name, retval_ptr, param_count, params, no_separation)
482
483 ZEND_API extern const zend_fcall_info empty_fcall_info;
484 ZEND_API extern const zend_fcall_info_cache empty_fcall_info_cache;
485
486 /** Build zend_call_info/cache from a zval*
487 *
488 * Caller is responsible to provide a return value (fci->retval), otherwise the we will crash.
489 * In order to pass parameters the following members need to be set:
490 * fci->param_count = 0;
491 * fci->params = NULL;
492 * The callable_name argument may be NULL.
493 * Set check_flags to IS_CALLABLE_STRICT for every new usage!
494 */
495 ZEND_API int zend_fcall_info_init(zval *callable, uint check_flags, zend_fcall_info *fci, zend_fcall_info_cache *fcc, zend_string **callable_name, char **error);
496
497 /** Clear arguments connected with zend_fcall_info *fci
498 * If free_mem is not zero then the params array gets free'd as well
499 */
500 ZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, int free_mem);
501
502 /** Save current arguments from zend_fcall_info *fci
503 * params array will be set to NULL
504 */
505 ZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, int *param_count, zval **params);
506
507 /** Free arguments connected with zend_fcall_info *fci andset back saved ones.
508 */
509 ZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, int param_count, zval *params);
510
511 /** Set or clear the arguments in the zend_call_info struct taking care of
512 * refcount. If args is NULL and arguments are set then those are cleared.
513 */
514 ZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args);
515 ZEND_API int zend_fcall_info_args_ex(zend_fcall_info *fci, zend_function *func, zval *args);
516
517 /** Set arguments in the zend_fcall_info struct taking care of refcount.
518 * If argc is 0 the arguments which are set will be cleared, else pass
519 * a variable amount of zval** arguments.
520 */
521 ZEND_API int zend_fcall_info_argp(zend_fcall_info *fci, int argc, zval *argv);
522
523 /** Set arguments in the zend_fcall_info struct taking care of refcount.
524 * If argc is 0 the arguments which are set will be cleared, else pass
525 * a variable amount of zval** arguments.
526 */
527 ZEND_API int zend_fcall_info_argv(zend_fcall_info *fci, int argc, va_list *argv);
528
529 /** Set arguments in the zend_fcall_info struct taking care of refcount.
530 * If argc is 0 the arguments which are set will be cleared, else pass
531 * a variable amount of zval** arguments.
532 */
533 ZEND_API int zend_fcall_info_argn(zend_fcall_info *fci, int argc, ...);
534
535 /** Call a function using information created by zend_fcall_info_init()/args().
536 * If args is given then those replace the argument info in fci is temporarily.
537 */
538 ZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval *retval, zval *args);
539
540 ZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache);
541
542 ZEND_API int zend_set_hash_symbol(zval *symbol, const char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
543
544 ZEND_API int zend_delete_global_variable(zend_string *name);
545
546 ZEND_API zend_array *zend_rebuild_symbol_table(void);
547 ZEND_API void zend_attach_symbol_table(zend_execute_data *execute_data);
548 ZEND_API void zend_detach_symbol_table(zend_execute_data *execute_data);
549 ZEND_API int zend_set_local_var(zend_string *name, zval *value, int force);
550 ZEND_API int zend_set_local_var_str(const char *name, size_t len, zval *value, int force);
551 ZEND_API int zend_forbid_dynamic_call(const char *func_name);
552
553 ZEND_API zend_string *zend_find_alias_name(zend_class_entry *ce, zend_string *name);
554 ZEND_API zend_string *zend_resolve_method_name(zend_class_entry *ce, zend_function *f);
555
556 ZEND_API const char *zend_get_object_type(const zend_class_entry *ce);
557
558 ZEND_API zend_bool zend_is_iterable(zval *iterable);
559
560 #define add_method(arg, key, method) add_assoc_function((arg), (key), (method))
561
562 ZEND_API ZEND_FUNCTION(display_disabled_function);
563 ZEND_API ZEND_FUNCTION(display_disabled_class);
564 END_EXTERN_C()
565
566 #if ZEND_DEBUG
567 #define CHECK_ZVAL_STRING(str) \
568 if (ZSTR_VAL(str)[ZSTR_LEN(str)] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s)", ZSTR_VAL(str)); }
569 #define CHECK_ZVAL_STRING_REL(str) \
570 if (ZSTR_VAL(str)[ZSTR_LEN(str)] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s) (source: %s:%d)", ZSTR_VAL(str) ZEND_FILE_LINE_RELAY_CC); }
571 #else
572 #define CHECK_ZVAL_STRING(z)
573 #define CHECK_ZVAL_STRING_REL(z)
574 #endif
575
576 #define CHECK_ZVAL_NULL_PATH(p) (Z_STRLEN_P(p) != strlen(Z_STRVAL_P(p)))
577 #define CHECK_NULL_PATH(p, l) (strlen(p) != (size_t)(l))
578
579 #define ZVAL_STRINGL(z, s, l) do { \
580 ZVAL_NEW_STR(z, zend_string_init(s, l, 0)); \
581 } while (0)
582
583 #define ZVAL_STRING(z, s) do { \
584 const char *_s = (s); \
585 ZVAL_STRINGL(z, _s, strlen(_s)); \
586 } while (0)
587
588 #define ZVAL_EMPTY_STRING(z) do { \
589 ZVAL_INTERNED_STR(z, ZSTR_EMPTY_ALLOC()); \
590 } while (0)
591
592 #define ZVAL_PSTRINGL(z, s, l) do { \
593 ZVAL_NEW_STR(z, zend_string_init(s, l, 1)); \
594 } while (0)
595
596 #define ZVAL_PSTRING(z, s) do { \
597 const char *_s = (s); \
598 ZVAL_PSTRINGL(z, _s, strlen(_s)); \
599 } while (0)
600
601 #define ZVAL_EMPTY_PSTRING(z) do { \
602 ZVAL_PSTRINGL(z, "", 0); \
603 } while (0)
604
605 #define ZVAL_ZVAL(z, zv, copy, dtor) do { \
606 zval *__z = (z); \
607 zval *__zv = (zv); \
608 if (EXPECTED(!Z_ISREF_P(__zv))) { \
609 if (copy && !dtor) { \
610 ZVAL_COPY(__z, __zv); \
611 } else { \
612 ZVAL_COPY_VALUE(__z, __zv); \
613 } \
614 } else { \
615 ZVAL_COPY(__z, Z_REFVAL_P(__zv)); \
616 if (dtor || !copy) { \
617 zval_ptr_dtor(__zv); \
618 } \
619 } \
620 } while (0)
621
622 #define RETVAL_BOOL(b) ZVAL_BOOL(return_value, b)
623 #define RETVAL_NULL() ZVAL_NULL(return_value)
624 #define RETVAL_LONG(l) ZVAL_LONG(return_value, l)
625 #define RETVAL_DOUBLE(d) ZVAL_DOUBLE(return_value, d)
626 #define RETVAL_STR(s) ZVAL_STR(return_value, s)
627 #define RETVAL_INTERNED_STR(s) ZVAL_INTERNED_STR(return_value, s)
628 #define RETVAL_NEW_STR(s) ZVAL_NEW_STR(return_value, s)
629 #define RETVAL_STR_COPY(s) ZVAL_STR_COPY(return_value, s)
630 #define RETVAL_STRING(s) ZVAL_STRING(return_value, s)
631 #define RETVAL_STRINGL(s, l) ZVAL_STRINGL(return_value, s, l)
632 #define RETVAL_EMPTY_STRING() ZVAL_EMPTY_STRING(return_value)
633 #define RETVAL_RES(r) ZVAL_RES(return_value, r)
634 #define RETVAL_ARR(r) ZVAL_ARR(return_value, r)
635 #define RETVAL_OBJ(r) ZVAL_OBJ(return_value, r)
636 #define RETVAL_ZVAL(zv, copy, dtor) ZVAL_ZVAL(return_value, zv, copy, dtor)
637 #define RETVAL_FALSE ZVAL_FALSE(return_value)
638 #define RETVAL_TRUE ZVAL_TRUE(return_value)
639
640 #define RETURN_BOOL(b) { RETVAL_BOOL(b); return; }
641 #define RETURN_NULL() { RETVAL_NULL(); return;}
642 #define RETURN_LONG(l) { RETVAL_LONG(l); return; }
643 #define RETURN_DOUBLE(d) { RETVAL_DOUBLE(d); return; }
644 #define RETURN_STR(s) { RETVAL_STR(s); return; }
645 #define RETURN_INTERNED_STR(s) { RETVAL_INTERNED_STR(s); return; }
646 #define RETURN_NEW_STR(s) { RETVAL_NEW_STR(s); return; }
647 #define RETURN_STR_COPY(s) { RETVAL_STR_COPY(s); return; }
648 #define RETURN_STRING(s) { RETVAL_STRING(s); return; }
649 #define RETURN_STRINGL(s, l) { RETVAL_STRINGL(s, l); return; }
650 #define RETURN_EMPTY_STRING() { RETVAL_EMPTY_STRING(); return; }
651 #define RETURN_RES(r) { RETVAL_RES(r); return; }
652 #define RETURN_ARR(r) { RETVAL_ARR(r); return; }
653 #define RETURN_OBJ(r) { RETVAL_OBJ(r); return; }
654 #define RETURN_ZVAL(zv, copy, dtor) { RETVAL_ZVAL(zv, copy, dtor); return; }
655 #define RETURN_FALSE { RETVAL_FALSE; return; }
656 #define RETURN_TRUE { RETVAL_TRUE; return; }
657
658 #define HASH_OF(p) (Z_TYPE_P(p)==IS_ARRAY ? Z_ARRVAL_P(p) : ((Z_TYPE_P(p)==IS_OBJECT ? Z_OBJ_HT_P(p)->get_properties((p)) : NULL)))
659 #define ZVAL_IS_NULL(z) (Z_TYPE_P(z) == IS_NULL)
660
661 /* For compatibility */
662 #define ZEND_MINIT ZEND_MODULE_STARTUP_N
663 #define ZEND_MSHUTDOWN ZEND_MODULE_SHUTDOWN_N
664 #define ZEND_RINIT ZEND_MODULE_ACTIVATE_N
665 #define ZEND_RSHUTDOWN ZEND_MODULE_DEACTIVATE_N
666 #define ZEND_MINFO ZEND_MODULE_INFO_N
667 #define ZEND_GINIT(module) ((void (*)(void*))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
668 #define ZEND_GSHUTDOWN(module) ((void (*)(void*))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
669
670 #define ZEND_MINIT_FUNCTION ZEND_MODULE_STARTUP_D
671 #define ZEND_MSHUTDOWN_FUNCTION ZEND_MODULE_SHUTDOWN_D
672 #define ZEND_RINIT_FUNCTION ZEND_MODULE_ACTIVATE_D
673 #define ZEND_RSHUTDOWN_FUNCTION ZEND_MODULE_DEACTIVATE_D
674 #define ZEND_MINFO_FUNCTION ZEND_MODULE_INFO_D
675 #define ZEND_GINIT_FUNCTION ZEND_MODULE_GLOBALS_CTOR_D
676 #define ZEND_GSHUTDOWN_FUNCTION ZEND_MODULE_GLOBALS_DTOR_D
677
678 /* Fast parameter parsing API */
679
680 /* Fast ZPP is always enabled now; this define is left in for compatibility
681 * with any existing conditional compilation blocks.
682 */
683 #define FAST_ZPP 1
684
685 #define Z_EXPECTED_TYPES(_) \
686 _(Z_EXPECTED_LONG, "integer") \
687 _(Z_EXPECTED_BOOL, "boolean") \
688 _(Z_EXPECTED_STRING, "string") \
689 _(Z_EXPECTED_ARRAY, "array") \
690 _(Z_EXPECTED_FUNC, "valid callback") \
691 _(Z_EXPECTED_RESOURCE, "resource") \
692 _(Z_EXPECTED_PATH, "a valid path") \
693 _(Z_EXPECTED_OBJECT, "object") \
694 _(Z_EXPECTED_DOUBLE, "float")
695
696 #define Z_EXPECTED_TYPE_ENUM(id, str) id,
697 #define Z_EXPECTED_TYPE_STR(id, str) str,
698
699 typedef enum _zend_expected_type {
700 Z_EXPECTED_TYPES(Z_EXPECTED_TYPE_ENUM)
701 Z_EXPECTED_LAST
702 } zend_expected_type;
703
704 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameters_count_error(int num_args, int min_num_args, int max_num_args);
705 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_type_error(int num, zend_expected_type expected_type, zval *arg);
706 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_error(int num, char *name, zval *arg);
707 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_error(int severity, int num, char *error);
708
709 #define ZPP_ERROR_OK 0
710 #define ZPP_ERROR_FAILURE 1
711 #define ZPP_ERROR_WRONG_CALLBACK 2
712 #define ZPP_ERROR_WRONG_CLASS 3
713 #define ZPP_ERROR_WRONG_ARG 4
714 #define ZPP_ERROR_WRONG_COUNT 5
715
716 #define ZEND_PARSE_PARAMETERS_START_EX(flags, min_num_args, max_num_args) do { \
717 const int _flags = (flags); \
718 int _min_num_args = (min_num_args); \
719 int _max_num_args = (max_num_args); \
720 int _num_args = EX_NUM_ARGS(); \
721 int _i; \
722 zval *_real_arg, *_arg = NULL; \
723 zend_expected_type _expected_type = Z_EXPECTED_LONG; \
724 char *_error = NULL; \
725 zend_bool _dummy; \
726 zend_bool _optional = 0; \
727 int error_code = ZPP_ERROR_OK; \
728 ((void)_i); \
729 ((void)_real_arg); \
730 ((void)_arg); \
731 ((void)_expected_type); \
732 ((void)_error); \
733 ((void)_dummy); \
734 ((void)_optional); \
735 \
736 do { \
737 if (UNEXPECTED(_num_args < _min_num_args) || \
738 (UNEXPECTED(_num_args > _max_num_args) && \
739 EXPECTED(_max_num_args >= 0))) { \
740 if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
741 zend_wrong_parameters_count_error(_num_args, _min_num_args, _max_num_args); \
742 } \
743 error_code = ZPP_ERROR_FAILURE; \
744 break; \
745 } \
746 _i = 0; \
747 _real_arg = ZEND_CALL_ARG(execute_data, 0);
748
749 #define ZEND_PARSE_PARAMETERS_START(min_num_args, max_num_args) \
750 ZEND_PARSE_PARAMETERS_START_EX(0, min_num_args, max_num_args)
751
752 #define ZEND_PARSE_PARAMETERS_END_EX(failure) \
753 } while (0); \
754 if (UNEXPECTED(error_code != ZPP_ERROR_OK)) { \
755 if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
756 if (error_code == ZPP_ERROR_WRONG_CALLBACK) { \
757 zend_wrong_callback_error(E_WARNING, _i, _error); \
758 } else if (error_code == ZPP_ERROR_WRONG_CLASS) { \
759 zend_wrong_parameter_class_error(_i, _error, _arg); \
760 } else if (error_code == ZPP_ERROR_WRONG_ARG) { \
761 zend_wrong_parameter_type_error(_i, _expected_type, _arg); \
762 } \
763 } \
764 failure; \
765 } \
766 } while (0)
767
768 #define ZEND_PARSE_PARAMETERS_END() \
769 ZEND_PARSE_PARAMETERS_END_EX(return)
770
771 #define Z_PARAM_PROLOGUE(separate) \
772 ++_i; \
773 ZEND_ASSERT(_i <= _min_num_args || _optional==1); \
774 ZEND_ASSERT(_i > _min_num_args || _optional==0); \
775 if (_optional) { \
776 if (UNEXPECTED(_i >_num_args)) break; \
777 } \
778 _real_arg++; \
779 _arg = _real_arg; \
780 ZVAL_DEREF(_arg); \
781 if (separate) { \
782 SEPARATE_ZVAL_NOREF(_arg); \
783 }
784
785 /* old "|" */
786 #define Z_PARAM_OPTIONAL \
787 _optional = 1;
788
789 /* old "a" */
790 #define Z_PARAM_ARRAY_EX(dest, check_null, separate) \
791 Z_PARAM_PROLOGUE(separate); \
792 if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 0))) { \
793 _expected_type = Z_EXPECTED_ARRAY; \
794 error_code = ZPP_ERROR_WRONG_ARG; \
795 break; \
796 }
797
798 #define Z_PARAM_ARRAY(dest) \
799 Z_PARAM_ARRAY_EX(dest, 0, 0)
800
801 /* old "A" */
802 #define Z_PARAM_ARRAY_OR_OBJECT_EX(dest, check_null, separate) \
803 Z_PARAM_PROLOGUE(separate); \
804 if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 1))) { \
805 _expected_type = Z_EXPECTED_ARRAY; \
806 error_code = ZPP_ERROR_WRONG_ARG; \
807 break; \
808 }
809
810 #define Z_PARAM_ARRAY_OR_OBJECT(dest, check_null, separate) \
811 Z_PARAM_ARRAY_OR_OBJECT_EX(dest, 0, 0)
812
813 /* old "b" */
814 #define Z_PARAM_BOOL_EX(dest, is_null, check_null, separate) \
815 Z_PARAM_PROLOGUE(separate); \
816 if (UNEXPECTED(!zend_parse_arg_bool(_arg, &dest, &is_null, check_null))) { \
817 _expected_type = Z_EXPECTED_BOOL; \
818 error_code = ZPP_ERROR_WRONG_ARG; \
819 break; \
820 }
821
822 #define Z_PARAM_BOOL(dest) \
823 Z_PARAM_BOOL_EX(dest, _dummy, 0, 0)
824
825 /* old "C" */
826 #define Z_PARAM_CLASS_EX(dest, check_null, separate) \
827 Z_PARAM_PROLOGUE(separate); \
828 if (UNEXPECTED(!zend_parse_arg_class(_arg, &dest, _i, check_null))) { \
829 error_code = ZPP_ERROR_FAILURE; \
830 break; \
831 }
832
833 #define Z_PARAM_CLASS(dest) \
834 Z_PARAM_CLASS_EX(dest, 0, 0)
835
836 /* old "d" */
837 #define Z_PARAM_DOUBLE_EX(dest, is_null, check_null, separate) \
838 Z_PARAM_PROLOGUE(separate); \
839 if (UNEXPECTED(!zend_parse_arg_double(_arg, &dest, &is_null, check_null))) { \
840 _expected_type = Z_EXPECTED_DOUBLE; \
841 error_code = ZPP_ERROR_WRONG_ARG; \
842 break; \
843 }
844
845 #define Z_PARAM_DOUBLE(dest) \
846 Z_PARAM_DOUBLE_EX(dest, _dummy, 0, 0)
847
848 /* old "f" */
849 #define Z_PARAM_FUNC_EX(dest_fci, dest_fcc, check_null, separate) \
850 Z_PARAM_PROLOGUE(separate); \
851 if (UNEXPECTED(!zend_parse_arg_func(_arg, &dest_fci, &dest_fcc, check_null, &_error))) { \
852 if (!_error) { \
853 _expected_type = Z_EXPECTED_FUNC; \
854 error_code = ZPP_ERROR_WRONG_ARG; \
855 break; \
856 } else { \
857 error_code = ZPP_ERROR_WRONG_CALLBACK; \
858 break; \
859 } \
860 } else if (UNEXPECTED(_error != NULL)) { \
861 zend_wrong_callback_error(E_DEPRECATED, _i, _error); \
862 }
863
864 #define Z_PARAM_FUNC(dest_fci, dest_fcc) \
865 Z_PARAM_FUNC_EX(dest_fci, dest_fcc, 0, 0)
866
867 /* old "h" */
868 #define Z_PARAM_ARRAY_HT_EX(dest, check_null, separate) \
869 Z_PARAM_PROLOGUE(separate); \
870 if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 0, separate))) { \
871 _expected_type = Z_EXPECTED_ARRAY; \
872 error_code = ZPP_ERROR_WRONG_ARG; \
873 break; \
874 }
875
876 #define Z_PARAM_ARRAY_HT(dest) \
877 Z_PARAM_ARRAY_HT_EX(dest, 0, 0)
878
879 /* old "H" */
880 #define Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, check_null, separate) \
881 Z_PARAM_PROLOGUE(separate); \
882 if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 1, separate))) { \
883 _expected_type = Z_EXPECTED_ARRAY; \
884 error_code = ZPP_ERROR_WRONG_ARG; \
885 break; \
886 }
887
888 #define Z_PARAM_ARRAY_OR_OBJECT_HT(dest) \
889 Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, 0, 0)
890
891 /* old "l" */
892 #define Z_PARAM_LONG_EX(dest, is_null, check_null, separate) \
893 Z_PARAM_PROLOGUE(separate); \
894 if (UNEXPECTED(!zend_parse_arg_long(_arg, &dest, &is_null, check_null, 0))) { \
895 _expected_type = Z_EXPECTED_LONG; \
896 error_code = ZPP_ERROR_WRONG_ARG; \
897 break; \
898 }
899
900 #define Z_PARAM_LONG(dest) \
901 Z_PARAM_LONG_EX(dest, _dummy, 0, 0)
902
903 /* old "L" */
904 #define Z_PARAM_STRICT_LONG_EX(dest, is_null, check_null, separate) \
905 Z_PARAM_PROLOGUE(separate); \
906 if (UNEXPECTED(!zend_parse_arg_long(_arg, &dest, &is_null, check_null, 1))) { \
907 _expected_type = Z_EXPECTED_LONG; \
908 error_code = ZPP_ERROR_WRONG_ARG; \
909 break; \
910 }
911
912 #define Z_PARAM_STRICT_LONG(dest) \
913 Z_PARAM_STRICT_LONG_EX(dest, _dummy, 0, 0)
914
915 /* old "o" */
916 #define Z_PARAM_OBJECT_EX(dest, check_null, separate) \
917 Z_PARAM_PROLOGUE(separate); \
918 if (UNEXPECTED(!zend_parse_arg_object(_arg, &dest, NULL, check_null))) { \
919 _expected_type = Z_EXPECTED_OBJECT; \
920 error_code = ZPP_ERROR_WRONG_ARG; \
921 break; \
922 }
923
924 #define Z_PARAM_OBJECT(dest) \
925 Z_PARAM_OBJECT_EX(dest, 0, 0)
926
927 /* old "O" */
928 #define Z_PARAM_OBJECT_OF_CLASS_EX(dest, _ce, check_null, separate) \
929 Z_PARAM_PROLOGUE(separate); \
930 if (UNEXPECTED(!zend_parse_arg_object(_arg, &dest, _ce, check_null))) { \
931 if (_ce) { \
932 _error = ZSTR_VAL((_ce)->name); \
933 error_code = ZPP_ERROR_WRONG_CLASS; \
934 break; \
935 } else { \
936 _expected_type = Z_EXPECTED_OBJECT; \
937 error_code = ZPP_ERROR_WRONG_ARG; \
938 break; \
939 } \
940 }
941
942 #define Z_PARAM_OBJECT_OF_CLASS(dest, _ce) \
943 Z_PARAM_OBJECT_OF_CLASS_EX(dest, _ce, 0, 0)
944
945 /* old "p" */
946 #define Z_PARAM_PATH_EX(dest, dest_len, check_null, separate) \
947 Z_PARAM_PROLOGUE(separate); \
948 if (UNEXPECTED(!zend_parse_arg_path(_arg, &dest, &dest_len, check_null))) { \
949 _expected_type = Z_EXPECTED_PATH; \
950 error_code = ZPP_ERROR_WRONG_ARG; \
951 break; \
952 }
953
954 #define Z_PARAM_PATH(dest, dest_len) \
955 Z_PARAM_PATH_EX(dest, dest_len, 0, 0)
956
957 /* old "P" */
958 #define Z_PARAM_PATH_STR_EX(dest, check_null, separate) \
959 Z_PARAM_PROLOGUE(separate); \
960 if (UNEXPECTED(!zend_parse_arg_path_str(_arg, &dest, check_null))) { \
961 _expected_type = Z_EXPECTED_PATH; \
962 error_code = ZPP_ERROR_WRONG_ARG; \
963 break; \
964 }
965
966 #define Z_PARAM_PATH_STR(dest) \
967 Z_PARAM_PATH_STR_EX(dest, 0, 0)
968
969 /* old "r" */
970 #define Z_PARAM_RESOURCE_EX(dest, check_null, separate) \
971 Z_PARAM_PROLOGUE(separate); \
972 if (UNEXPECTED(!zend_parse_arg_resource(_arg, &dest, check_null))) { \
973 _expected_type = Z_EXPECTED_RESOURCE; \
974 error_code = ZPP_ERROR_WRONG_ARG; \
975 break; \
976 }
977
978 #define Z_PARAM_RESOURCE(dest) \
979 Z_PARAM_RESOURCE_EX(dest, 0, 0)
980
981 /* old "s" */
982 #define Z_PARAM_STRING_EX(dest, dest_len, check_null, separate) \
983 Z_PARAM_PROLOGUE(separate); \
984 if (UNEXPECTED(!zend_parse_arg_string(_arg, &dest, &dest_len, check_null))) { \
985 _expected_type = Z_EXPECTED_STRING; \
986 error_code = ZPP_ERROR_WRONG_ARG; \
987 break; \
988 }
989
990 #define Z_PARAM_STRING(dest, dest_len) \
991 Z_PARAM_STRING_EX(dest, dest_len, 0, 0)
992
993 /* old "S" */
994 #define Z_PARAM_STR_EX(dest, check_null, separate) \
995 Z_PARAM_PROLOGUE(separate); \
996 if (UNEXPECTED(!zend_parse_arg_str(_arg, &dest, check_null))) { \
997 _expected_type = Z_EXPECTED_STRING; \
998 error_code = ZPP_ERROR_WRONG_ARG; \
999 break; \
1000 }
1001
1002 #define Z_PARAM_STR(dest) \
1003 Z_PARAM_STR_EX(dest, 0, 0)
1004
1005 /* old "z" */
1006 #define Z_PARAM_ZVAL_EX(dest, check_null, separate) \
1007 if (separate) { \
1008 Z_PARAM_PROLOGUE(separate); \
1009 zend_parse_arg_zval_deref(_arg, &dest, check_null); \
1010 } else { \
1011 ++_i; \
1012 ZEND_ASSERT(_i <= _min_num_args || _optional==1); \
1013 ZEND_ASSERT(_i > _min_num_args || _optional==0); \
1014 if (_optional && UNEXPECTED(_i >_num_args)) break; \
1015 _real_arg++; \
1016 zend_parse_arg_zval(_real_arg, &dest, check_null); \
1017 }
1018
1019 #define Z_PARAM_ZVAL(dest) \
1020 Z_PARAM_ZVAL_EX(dest, 0, 0)
1021
1022 /* old "z" (with dereference) */
1023 #define Z_PARAM_ZVAL_DEREF_EX(dest, check_null, separate) \
1024 Z_PARAM_PROLOGUE(separate); \
1025 zend_parse_arg_zval_deref(_arg, &dest, check_null);
1026
1027 #define Z_PARAM_ZVAL_DEREF(dest) \
1028 Z_PARAM_ZVAL_DEREF_EX(dest, 0, 0)
1029
1030 /* old "+" and "*" */
1031 #define Z_PARAM_VARIADIC_EX(spec, dest, dest_num, post_varargs) do { \
1032 int _num_varargs = _num_args - _i - (post_varargs); \
1033 if (EXPECTED(_num_varargs > 0)) { \
1034 dest = _real_arg + 1; \
1035 dest_num = _num_varargs; \
1036 _i += _num_varargs; \
1037 _real_arg += _num_varargs; \
1038 } else { \
1039 dest = NULL; \
1040 dest_num = 0; \
1041 } \
1042 } while (0);
1043
1044 #define Z_PARAM_VARIADIC(spec, dest, dest_num) \
1045 Z_PARAM_VARIADIC_EX(spec, dest, dest_num, 0)
1046
1047 /* End of new parameter parsing API */
1048
1049 /* Inlined implementations shared by new and old parameter parsing APIs */
1050
1051 ZEND_API int ZEND_FASTCALL zend_parse_arg_class(zval *arg, zend_class_entry **pce, int num, int check_null);
1052 ZEND_API int ZEND_FASTCALL zend_parse_arg_bool_slow(zval *arg, zend_bool *dest);
1053 ZEND_API int ZEND_FASTCALL zend_parse_arg_bool_weak(zval *arg, zend_bool *dest);
1054 ZEND_API int ZEND_FASTCALL zend_parse_arg_long_slow(zval *arg, zend_long *dest);
1055 ZEND_API int ZEND_FASTCALL zend_parse_arg_long_weak(zval *arg, zend_long *dest);
1056 ZEND_API int ZEND_FASTCALL zend_parse_arg_long_cap_slow(zval *arg, zend_long *dest);
1057 ZEND_API int ZEND_FASTCALL zend_parse_arg_long_cap_weak(zval *arg, zend_long *dest);
1058 ZEND_API int ZEND_FASTCALL zend_parse_arg_double_slow(zval *arg, double *dest);
1059 ZEND_API int ZEND_FASTCALL zend_parse_arg_double_weak(zval *arg, double *dest);
1060 ZEND_API int ZEND_FASTCALL zend_parse_arg_str_slow(zval *arg, zend_string **dest);
1061 ZEND_API int ZEND_FASTCALL zend_parse_arg_str_weak(zval *arg, zend_string **dest);
1062
zend_parse_arg_bool(zval * arg,zend_bool * dest,zend_bool * is_null,int check_null)1063 static zend_always_inline int zend_parse_arg_bool(zval *arg, zend_bool *dest, zend_bool *is_null, int check_null)
1064 {
1065 if (check_null) {
1066 *is_null = 0;
1067 }
1068 if (EXPECTED(Z_TYPE_P(arg) == IS_TRUE)) {
1069 *dest = 1;
1070 } else if (EXPECTED(Z_TYPE_P(arg) == IS_FALSE)) {
1071 *dest = 0;
1072 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1073 *is_null = 1;
1074 *dest = 0;
1075 } else {
1076 return zend_parse_arg_bool_slow(arg, dest);
1077 }
1078 return 1;
1079 }
1080
zend_parse_arg_long(zval * arg,zend_long * dest,zend_bool * is_null,int check_null,int cap)1081 static zend_always_inline int zend_parse_arg_long(zval *arg, zend_long *dest, zend_bool *is_null, int check_null, int cap)
1082 {
1083 if (check_null) {
1084 *is_null = 0;
1085 }
1086 if (EXPECTED(Z_TYPE_P(arg) == IS_LONG)) {
1087 *dest = Z_LVAL_P(arg);
1088 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1089 *is_null = 1;
1090 *dest = 0;
1091 } else if (cap) {
1092 return zend_parse_arg_long_cap_slow(arg, dest);
1093 } else {
1094 return zend_parse_arg_long_slow(arg, dest);
1095 }
1096 return 1;
1097 }
1098
zend_parse_arg_double(zval * arg,double * dest,zend_bool * is_null,int check_null)1099 static zend_always_inline int zend_parse_arg_double(zval *arg, double *dest, zend_bool *is_null, int check_null)
1100 {
1101 if (check_null) {
1102 *is_null = 0;
1103 }
1104 if (EXPECTED(Z_TYPE_P(arg) == IS_DOUBLE)) {
1105 *dest = Z_DVAL_P(arg);
1106 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1107 *is_null = 1;
1108 *dest = 0.0;
1109 } else {
1110 return zend_parse_arg_double_slow(arg, dest);
1111 }
1112 return 1;
1113 }
1114
zend_parse_arg_str(zval * arg,zend_string ** dest,int check_null)1115 static zend_always_inline int zend_parse_arg_str(zval *arg, zend_string **dest, int check_null)
1116 {
1117 if (EXPECTED(Z_TYPE_P(arg) == IS_STRING)) {
1118 *dest = Z_STR_P(arg);
1119 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1120 *dest = NULL;
1121 } else {
1122 return zend_parse_arg_str_slow(arg, dest);
1123 }
1124 return 1;
1125 }
1126
zend_parse_arg_string(zval * arg,char ** dest,size_t * dest_len,int check_null)1127 static zend_always_inline int zend_parse_arg_string(zval *arg, char **dest, size_t *dest_len, int check_null)
1128 {
1129 zend_string *str;
1130
1131 if (!zend_parse_arg_str(arg, &str, check_null)) {
1132 return 0;
1133 }
1134 if (check_null && UNEXPECTED(!str)) {
1135 *dest = NULL;
1136 *dest_len = 0;
1137 } else {
1138 *dest = ZSTR_VAL(str);
1139 *dest_len = ZSTR_LEN(str);
1140 }
1141 return 1;
1142 }
1143
zend_parse_arg_path_str(zval * arg,zend_string ** dest,int check_null)1144 static zend_always_inline int zend_parse_arg_path_str(zval *arg, zend_string **dest, int check_null)
1145 {
1146 if (!zend_parse_arg_str(arg, dest, check_null) ||
1147 (*dest && UNEXPECTED(CHECK_NULL_PATH(ZSTR_VAL(*dest), ZSTR_LEN(*dest))))) {
1148 return 0;
1149 }
1150 return 1;
1151 }
1152
zend_parse_arg_path(zval * arg,char ** dest,size_t * dest_len,int check_null)1153 static zend_always_inline int zend_parse_arg_path(zval *arg, char **dest, size_t *dest_len, int check_null)
1154 {
1155 zend_string *str;
1156
1157 if (!zend_parse_arg_path_str(arg, &str, check_null)) {
1158 return 0;
1159 }
1160 if (check_null && UNEXPECTED(!str)) {
1161 *dest = NULL;
1162 *dest_len = 0;
1163 } else {
1164 *dest = ZSTR_VAL(str);
1165 *dest_len = ZSTR_LEN(str);
1166 }
1167 return 1;
1168 }
1169
zend_parse_arg_array(zval * arg,zval ** dest,int check_null,int or_object)1170 static zend_always_inline int zend_parse_arg_array(zval *arg, zval **dest, int check_null, int or_object)
1171 {
1172 if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY) ||
1173 (or_object && EXPECTED(Z_TYPE_P(arg) == IS_OBJECT))) {
1174 *dest = arg;
1175 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1176 *dest = NULL;
1177 } else {
1178 return 0;
1179 }
1180 return 1;
1181 }
1182
zend_parse_arg_array_ht(zval * arg,HashTable ** dest,int check_null,int or_object,int separate)1183 static zend_always_inline int zend_parse_arg_array_ht(zval *arg, HashTable **dest, int check_null, int or_object, int separate)
1184 {
1185 if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY)) {
1186 *dest = Z_ARRVAL_P(arg);
1187 } else if (or_object && EXPECTED(Z_TYPE_P(arg) == IS_OBJECT)) {
1188 if (separate
1189 && Z_OBJ_P(arg)->properties
1190 && UNEXPECTED(GC_REFCOUNT(Z_OBJ_P(arg)->properties) > 1)) {
1191 if (EXPECTED(!(GC_FLAGS(Z_OBJ_P(arg)->properties) & IS_ARRAY_IMMUTABLE))) {
1192 GC_REFCOUNT(Z_OBJ_P(arg)->properties)--;
1193 }
1194 Z_OBJ_P(arg)->properties = zend_array_dup(Z_OBJ_P(arg)->properties);
1195 }
1196 *dest = Z_OBJ_HT_P(arg)->get_properties(arg);
1197 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1198 *dest = NULL;
1199 } else {
1200 return 0;
1201 }
1202 return 1;
1203 }
1204
zend_parse_arg_object(zval * arg,zval ** dest,zend_class_entry * ce,int check_null)1205 static zend_always_inline int zend_parse_arg_object(zval *arg, zval **dest, zend_class_entry *ce, int check_null)
1206 {
1207 if (EXPECTED(Z_TYPE_P(arg) == IS_OBJECT) &&
1208 (!ce || EXPECTED(instanceof_function(Z_OBJCE_P(arg), ce) != 0))) {
1209 *dest = arg;
1210 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1211 *dest = NULL;
1212 } else {
1213 return 0;
1214 }
1215 return 1;
1216 }
1217
zend_parse_arg_resource(zval * arg,zval ** dest,int check_null)1218 static zend_always_inline int zend_parse_arg_resource(zval *arg, zval **dest, int check_null)
1219 {
1220 if (EXPECTED(Z_TYPE_P(arg) == IS_RESOURCE)) {
1221 *dest = arg;
1222 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1223 *dest = NULL;
1224 } else {
1225 return 0;
1226 }
1227 return 1;
1228 }
1229
zend_parse_arg_func(zval * arg,zend_fcall_info * dest_fci,zend_fcall_info_cache * dest_fcc,int check_null,char ** error)1230 static zend_always_inline int zend_parse_arg_func(zval *arg, zend_fcall_info *dest_fci, zend_fcall_info_cache *dest_fcc, int check_null, char **error)
1231 {
1232 if (check_null && UNEXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1233 dest_fci->size = 0;
1234 dest_fcc->initialized = 0;
1235 *error = NULL;
1236 } else if (UNEXPECTED(zend_fcall_info_init(arg, 0, dest_fci, dest_fcc, NULL, error) != SUCCESS)) {
1237 return 0;
1238 }
1239 return 1;
1240 }
1241
zend_parse_arg_zval(zval * arg,zval ** dest,int check_null)1242 static zend_always_inline void zend_parse_arg_zval(zval *arg, zval **dest, int check_null)
1243 {
1244 *dest = (check_null &&
1245 (UNEXPECTED(Z_TYPE_P(arg) == IS_NULL) ||
1246 (UNEXPECTED(Z_ISREF_P(arg)) &&
1247 UNEXPECTED(Z_TYPE_P(Z_REFVAL_P(arg)) == IS_NULL)))) ? NULL : arg;
1248 }
1249
zend_parse_arg_zval_deref(zval * arg,zval ** dest,int check_null)1250 static zend_always_inline void zend_parse_arg_zval_deref(zval *arg, zval **dest, int check_null)
1251 {
1252 *dest = (check_null && UNEXPECTED(Z_TYPE_P(arg) == IS_NULL)) ? NULL : arg;
1253 }
1254
1255 END_EXTERN_C()
1256
1257 #endif /* ZEND_API_H */
1258
1259
1260 /*
1261 * Local variables:
1262 * tab-width: 4
1263 * c-basic-offset: 4
1264 * indent-tabs-mode: t
1265 * End:
1266 */
1267
