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 | Andrei Zmievski <andrei@php.net> |
18 | Dmitry Stogov <dmitry@php.net> |
19 +----------------------------------------------------------------------+
20 */
21
22 #ifndef ZEND_API_H
23 #define ZEND_API_H
24
25 #include "zend_modules.h"
26 #include "zend_list.h"
27 #include "zend_operators.h"
28 #include "zend_variables.h"
29 #include "zend_execute.h"
30 #include "zend_type_info.h"
31 #include "zend_frameless_function.h"
32
33 BEGIN_EXTERN_C()
34
35 typedef struct _zend_function_entry {
36 const char *fname;
37 zif_handler handler;
38 const struct _zend_internal_arg_info *arg_info;
39 uint32_t num_args;
40 uint32_t flags;
41 const zend_frameless_function_info *frameless_function_infos;
42 const char *doc_comment;
43 } zend_function_entry;
44
45 typedef struct _zend_fcall_info {
46 size_t size;
47 zval function_name;
48 zval *retval;
49 zval *params;
50 zend_object *object;
51 uint32_t param_count;
52 /* This hashtable can also contain positional arguments (with integer keys),
53 * which will be appended to the normal params[]. This makes it easier to
54 * integrate APIs like call_user_func_array(). The usual restriction that
55 * there may not be position arguments after named arguments applies. */
56 HashTable *named_params;
57 } zend_fcall_info;
58
59 typedef struct _zend_fcall_info_cache {
60 zend_function *function_handler;
61 zend_class_entry *calling_scope;
62 zend_class_entry *called_scope;
63 zend_object *object; /* Instance of object for method calls */
64 zend_object *closure; /* Closure reference, only if the callable *is* the object */
65 } zend_fcall_info_cache;
66
67 #define ZEND_NS_NAME(ns, name) ns "\\" name
68
69 /* ZEND_FN/ZEND_MN are inlined below to prevent pre-scan macro expansion,
70 * which causes issues if the function name is also a macro name. */
71 #define ZEND_FN(name) zif_##name
72 #define ZEND_MN(name) zim_##name
73
74 #define ZEND_NAMED_FUNCTION(name) void ZEND_FASTCALL name(INTERNAL_FUNCTION_PARAMETERS)
75 #define ZEND_FUNCTION(name) ZEND_NAMED_FUNCTION(zif_##name)
76 #define ZEND_METHOD(classname, name) ZEND_NAMED_FUNCTION(zim_##classname##_##name)
77
78 #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, NULL, NULL },
79
80 #define ZEND_RAW_FENTRY(zend_name, name, arg_info, flags, frameless_function_infos, doc_comment) { zend_name, name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_internal_arg_info)-1), flags, frameless_function_infos, doc_comment },
81
82 /* Same as ZEND_NAMED_FE */
83 #define ZEND_RAW_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0, NULL, NULL)
84
85 #define ZEND_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0, NULL, NULL)
86 #define ZEND_FE(name, arg_info) ZEND_RAW_FENTRY(#name, zif_##name, arg_info, 0, NULL, NULL)
87 #define ZEND_DEP_FE(name, arg_info) ZEND_RAW_FENTRY(#name, zif_##name, arg_info, ZEND_ACC_DEPRECATED, NULL, NULL)
88 #define ZEND_FALIAS(name, alias, arg_info) ZEND_RAW_FENTRY(#name, zif_##alias, arg_info, 0, NULL, NULL)
89 #define ZEND_DEP_FALIAS(name, alias, arg_info) ZEND_RAW_FENTRY(#name, zif_##alias, arg_info, ZEND_ACC_DEPRECATED, NULL, NULL)
90 #define ZEND_NAMED_ME(zend_name, name, arg_info, flags) ZEND_FENTRY(zend_name, name, arg_info, flags)
91 #define ZEND_ME(classname, name, arg_info, flags) ZEND_RAW_FENTRY(#name, zim_##classname##_##name, arg_info, flags, NULL, NULL)
92 #define ZEND_DEP_ME(classname, name, arg_info, flags) ZEND_RAW_FENTRY(#name, zim_##classname##_##name, arg_info, flags | ZEND_ACC_DEPRECATED, NULL, NULL)
93 #define ZEND_ABSTRACT_ME(classname, name, arg_info) ZEND_RAW_FENTRY(#name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT, NULL, NULL)
94 #define ZEND_ABSTRACT_ME_WITH_FLAGS(classname, name, arg_info, flags) ZEND_RAW_FENTRY(#name, NULL, arg_info, flags, NULL, NULL)
95 #define ZEND_MALIAS(classname, name, alias, arg_info, flags) ZEND_RAW_FENTRY(#name, zim_##classname##_##alias, arg_info, flags, NULL, NULL)
96 #define ZEND_ME_MAPPING(name, func_name, arg_info, flags) ZEND_RAW_FENTRY(#name, zif_##func_name, arg_info, flags, NULL, NULL)
97 #define ZEND_FRAMELESS_FE(name, arg_info, flags, frameless_function_infos, doc_comment) \
98 { #name, zif_##name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_internal_arg_info)-1), flags, frameless_function_infos, doc_comment },
99
100 #define ZEND_NS_FENTRY(ns, zend_name, name, arg_info, flags) ZEND_RAW_FENTRY(ZEND_NS_NAME(ns, #zend_name), name, arg_info, flags, NULL, NULL)
101
102 #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, NULL, NULL)
103 /**
104 * Note that if you are asserting that a function is compile-time evaluable, you are asserting that
105 *
106 * 1. The function will always have the same result for the same arguments
107 * 2. The function does not depend on global state such as ini settings or locale (e.g. mb_strtolower), number_format(), etc.
108 * 3. The function does not have side effects. It is okay if they throw
109 * or warn on invalid arguments, as we detect this and will discard the evaluation result.
110 * 4. The function will not take an unreasonable amount of time or memory to compute on code that may be seen in practice.
111 * (e.g. str_repeat is special cased to check the length instead of using this)
112 */
113 #define ZEND_SUPPORTS_COMPILE_TIME_EVAL_FE(name, arg_info) ZEND_RAW_FENTRY(#name, zif_##name, arg_info, ZEND_ACC_COMPILE_TIME_EVAL, NULL, NULL)
114
115 /* Same as ZEND_NS_NAMED_FE */
116 #define ZEND_NS_RAW_NAMED_FE(ns, zend_name, name, arg_info) ZEND_NS_RAW_FENTRY(ns, #zend_name, name, arg_info, 0)
117
118 #define ZEND_NS_NAMED_FE(ns, zend_name, name, arg_info) ZEND_NS_RAW_FENTRY(ns, #zend_name, name, arg_info, 0)
119 #define ZEND_NS_FE(ns, name, arg_info) ZEND_NS_RAW_FENTRY(ns, #name, zif_##name, arg_info, 0)
120 #define ZEND_NS_DEP_FE(ns, name, arg_info) ZEND_NS_RAW_FENTRY(ns, #name, zif_##name, arg_info, ZEND_ACC_DEPRECATED)
121 #define ZEND_NS_FALIAS(ns, name, alias, arg_info) ZEND_NS_RAW_FENTRY(ns, #name, zif_##alias, arg_info, 0)
122 #define ZEND_NS_DEP_FALIAS(ns, name, alias, arg_info) ZEND_NS_RAW_FENTRY(ns, #name, zif_##alias, arg_info, ZEND_ACC_DEPRECATED)
123
124 #define ZEND_FE_END { NULL, NULL, NULL, 0, 0, NULL, NULL }
125
126 #define _ZEND_ARG_INFO_FLAGS(pass_by_ref, is_variadic, is_tentative) \
127 (((pass_by_ref) << _ZEND_SEND_MODE_SHIFT) | ((is_variadic) ? _ZEND_IS_VARIADIC_BIT : 0) | ((is_tentative) ? _ZEND_IS_TENTATIVE_BIT : 0))
128
129 /* Arginfo structures without type information */
130 #define ZEND_ARG_INFO(pass_by_ref, name) \
131 { #name, ZEND_TYPE_INIT_NONE(_ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), NULL },
132 #define ZEND_ARG_INFO_WITH_DEFAULT_VALUE(pass_by_ref, name, default_value) \
133 { #name, ZEND_TYPE_INIT_NONE(_ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), default_value },
134 #define ZEND_ARG_VARIADIC_INFO(pass_by_ref, name) \
135 { #name, ZEND_TYPE_INIT_NONE(_ZEND_ARG_INFO_FLAGS(pass_by_ref, 1, 0)), NULL },
136
137 /* Arginfo structures with simple type information */
138 #define ZEND_ARG_TYPE_INFO(pass_by_ref, name, type_hint, allow_null) \
139 { #name, ZEND_TYPE_INIT_CODE(type_hint, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), NULL },
140 #define ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(pass_by_ref, name, type_hint, allow_null, default_value) \
141 { #name, ZEND_TYPE_INIT_CODE(type_hint, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), default_value },
142 #define ZEND_ARG_VARIADIC_TYPE_INFO(pass_by_ref, name, type_hint, allow_null) \
143 { #name, ZEND_TYPE_INIT_CODE(type_hint, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 1, 0)), NULL },
144
145 /* Arginfo structures with complex type information */
146 #define ZEND_ARG_TYPE_MASK(pass_by_ref, name, type_mask, default_value) \
147 { #name, ZEND_TYPE_INIT_MASK(type_mask | _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), default_value },
148 #define ZEND_ARG_OBJ_TYPE_MASK(pass_by_ref, name, class_name, type_mask, default_value) \
149 { #name, ZEND_TYPE_INIT_CLASS_CONST_MASK(#class_name, type_mask | _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), default_value },
150 #define ZEND_ARG_VARIADIC_OBJ_TYPE_MASK(pass_by_ref, name, class_name, type_mask) \
151 { #name, ZEND_TYPE_INIT_CLASS_CONST_MASK(#class_name, type_mask | _ZEND_ARG_INFO_FLAGS(pass_by_ref, 1, 0)), NULL },
152
153 /* Arginfo structures with object type information */
154 #define ZEND_ARG_OBJ_INFO(pass_by_ref, name, class_name, allow_null) \
155 { #name, ZEND_TYPE_INIT_CLASS_CONST(#class_name, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), NULL },
156 #define ZEND_ARG_OBJ_INFO_WITH_DEFAULT_VALUE(pass_by_ref, name, class_name, allow_null, default_value) \
157 { #name, ZEND_TYPE_INIT_CLASS_CONST(#class_name, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), default_value },
158 #define ZEND_ARG_VARIADIC_OBJ_INFO(pass_by_ref, name, class_name, allow_null) \
159 { #name, ZEND_TYPE_INIT_CLASS_CONST(#class_name, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 1, 0)), NULL },
160
161 /* Legacy arginfo structures */
162 #define ZEND_ARG_ARRAY_INFO(pass_by_ref, name, allow_null) \
163 { #name, ZEND_TYPE_INIT_CODE(IS_ARRAY, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), NULL },
164 #define ZEND_ARG_CALLABLE_INFO(pass_by_ref, name, allow_null) \
165 { #name, ZEND_TYPE_INIT_CODE(IS_CALLABLE, allow_null, _ZEND_ARG_INFO_FLAGS(pass_by_ref, 0, 0)), NULL },
166
167 #define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX2(name, return_reference, required_num_args, class_name, allow_null, is_tentative_return_type) \
168 static const zend_internal_arg_info name[] = { \
169 { (const char*)(uintptr_t)(required_num_args), \
170 ZEND_TYPE_INIT_CLASS_CONST(#class_name, allow_null, _ZEND_ARG_INFO_FLAGS(return_reference, 0, is_tentative_return_type)), NULL },
171
172 #define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(name, return_reference, required_num_args, class_name, allow_null) \
173 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX2(name, return_reference, required_num_args, class_name, allow_null, 0)
174
175 #define ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_OBJ_INFO_EX(name, return_reference, required_num_args, class_name, allow_null) \
176 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX2(name, return_reference, required_num_args, class_name, allow_null, 1)
177
178 #define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO(name, class_name, allow_null) \
179 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX2(name, 0, -1, class_name, allow_null, 0)
180
181 #define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX2(name, return_reference, required_num_args, type, is_tentative_return_type) \
182 static const zend_internal_arg_info name[] = { \
183 { (const char*)(uintptr_t)(required_num_args), ZEND_TYPE_INIT_MASK(type | _ZEND_ARG_INFO_FLAGS(return_reference, 0, is_tentative_return_type)), NULL },
184
185 #define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(name, return_reference, required_num_args, type) \
186 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX2(name, return_reference, required_num_args, type, 0)
187
188 #define ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_MASK_EX(name, return_reference, required_num_args, type) \
189 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX2(name, return_reference, required_num_args, type, 1)
190
191 #define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX2(name, return_reference, required_num_args, class_name, type, is_tentative_return_type) \
192 static const zend_internal_arg_info name[] = { \
193 { (const char*)(uintptr_t)(required_num_args), ZEND_TYPE_INIT_CLASS_CONST_MASK(#class_name, type | _ZEND_ARG_INFO_FLAGS(return_reference, 0, is_tentative_return_type)), NULL },
194
195 #define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(name, return_reference, required_num_args, class_name, type) \
196 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX2(name, return_reference, required_num_args, class_name, type, 0)
197
198 #define ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_OBJ_TYPE_MASK_EX(name, return_reference, required_num_args, class_name, type) \
199 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX2(name, return_reference, required_num_args, class_name, type, 1)
200
201 #define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX2(name, return_reference, required_num_args, type, allow_null, is_tentative_return_type) \
202 static const zend_internal_arg_info name[] = { \
203 { (const char*)(uintptr_t)(required_num_args), ZEND_TYPE_INIT_CODE(type, allow_null, _ZEND_ARG_INFO_FLAGS(return_reference, 0, is_tentative_return_type)), NULL },
204
205 #define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, type, allow_null) \
206 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX2(name, return_reference, required_num_args, type, allow_null, 0)
207
208 #define ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, type, allow_null) \
209 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX2(name, return_reference, required_num_args, type, allow_null, 1)
210
211 #define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO(name, type, allow_null) \
212 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX2(name, 0, -1, type, allow_null, 0)
213
214 #define ZEND_BEGIN_ARG_INFO_EX(name, _unused, return_reference, required_num_args) \
215 static const zend_internal_arg_info name[] = { \
216 { (const char*)(uintptr_t)(required_num_args), ZEND_TYPE_INIT_NONE(_ZEND_ARG_INFO_FLAGS(return_reference, 0, 0)), NULL },
217 #define ZEND_BEGIN_ARG_INFO(name, _unused) \
218 ZEND_BEGIN_ARG_INFO_EX(name, {}, ZEND_RETURN_VALUE, -1)
219 #define ZEND_END_ARG_INFO() };
220
221 /* Name macros */
222 #define ZEND_MODULE_STARTUP_N(module) zm_startup_##module
223 #define ZEND_MODULE_SHUTDOWN_N(module) zm_shutdown_##module
224 #define ZEND_MODULE_ACTIVATE_N(module) zm_activate_##module
225 #define ZEND_MODULE_DEACTIVATE_N(module) zm_deactivate_##module
226 #define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module) zm_post_zend_deactivate_##module
227 #define ZEND_MODULE_INFO_N(module) zm_info_##module
228 #define ZEND_MODULE_GLOBALS_CTOR_N(module) zm_globals_ctor_##module
229 #define ZEND_MODULE_GLOBALS_DTOR_N(module) zm_globals_dtor_##module
230
231 /* Declaration macros */
232 #define ZEND_MODULE_STARTUP_D(module) zend_result ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
233 #define ZEND_MODULE_SHUTDOWN_D(module) zend_result ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
234 #define ZEND_MODULE_ACTIVATE_D(module) zend_result ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
235 #define ZEND_MODULE_DEACTIVATE_D(module) zend_result ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
236 #define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module) zend_result ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
237 #define ZEND_MODULE_INFO_D(module) ZEND_COLD void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
238 #define ZEND_MODULE_GLOBALS_CTOR_D(module) void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals)
239 #define ZEND_MODULE_GLOBALS_DTOR_D(module) void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals)
240
241 #define ZEND_GET_MODULE(name) \
242 BEGIN_EXTERN_C()\
243 ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
244 END_EXTERN_C()
245
246 #define ZEND_BEGIN_MODULE_GLOBALS(module_name) \
247 typedef struct _zend_##module_name##_globals {
248 #define ZEND_END_MODULE_GLOBALS(module_name) \
249 } zend_##module_name##_globals;
250
251 #ifdef ZTS
252
253 #define ZEND_DECLARE_MODULE_GLOBALS(module_name) \
254 ts_rsrc_id module_name##_globals_id;
255 #define ZEND_EXTERN_MODULE_GLOBALS(module_name) \
256 extern ts_rsrc_id module_name##_globals_id;
257 #define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor) \
258 ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
259 #define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) ZEND_TSRMG(module_name##_globals_id, zend_##module_name##_globals *, v)
260 #ifdef ZEND_ENABLE_STATIC_TSRMLS_CACHE
261 #define ZEND_MODULE_GLOBALS_BULK(module_name) TSRMG_BULK_STATIC(module_name##_globals_id, zend_##module_name##_globals *)
262 #else
263 #define ZEND_MODULE_GLOBALS_BULK(module_name) TSRMG_BULK(module_name##_globals_id, zend_##module_name##_globals *)
264 #endif
265
266 #else
267
268 #define ZEND_DECLARE_MODULE_GLOBALS(module_name) \
269 zend_##module_name##_globals module_name##_globals;
270 #define ZEND_EXTERN_MODULE_GLOBALS(module_name) \
271 extern zend_##module_name##_globals module_name##_globals;
272 #define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor) \
273 globals_ctor(&module_name##_globals);
274 #define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) (module_name##_globals.v)
275 #define ZEND_MODULE_GLOBALS_BULK(module_name) (&module_name##_globals)
276
277 #endif
278
279 #define INIT_CLASS_ENTRY(class_container, class_name, functions) \
280 INIT_CLASS_ENTRY_EX(class_container, class_name, strlen(class_name), functions)
281
282 #define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
283 { \
284 memset(&class_container, 0, sizeof(zend_class_entry)); \
285 class_container.name = zend_string_init_interned(class_name, class_name_len, 1); \
286 class_container.default_object_handlers = &std_object_handlers; \
287 class_container.info.internal.builtin_functions = functions; \
288 }
289
290 #define INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions) \
291 { \
292 class_container.default_object_handlers = &std_object_handlers; \
293 class_container.constructor = NULL; \
294 class_container.destructor = NULL; \
295 class_container.clone = NULL; \
296 class_container.serialize = NULL; \
297 class_container.unserialize = NULL; \
298 class_container.create_object = NULL; \
299 class_container.get_static_method = NULL; \
300 class_container.__call = NULL; \
301 class_container.__callstatic = NULL; \
302 class_container.__tostring = NULL; \
303 class_container.__get = NULL; \
304 class_container.__set = NULL; \
305 class_container.__unset = NULL; \
306 class_container.__isset = NULL; \
307 class_container.__debugInfo = NULL; \
308 class_container.__serialize = NULL; \
309 class_container.__unserialize = NULL; \
310 class_container.parent = NULL; \
311 class_container.num_interfaces = 0; \
312 class_container.trait_names = NULL; \
313 class_container.num_traits = 0; \
314 class_container.trait_aliases = NULL; \
315 class_container.trait_precedences = NULL; \
316 class_container.interfaces = NULL; \
317 class_container.get_iterator = NULL; \
318 class_container.iterator_funcs_ptr = NULL; \
319 class_container.arrayaccess_funcs_ptr = NULL; \
320 class_container.info.internal.module = NULL; \
321 class_container.info.internal.builtin_functions = functions; \
322 }
323
324
325 #define INIT_NS_CLASS_ENTRY(class_container, ns, class_name, functions) \
326 INIT_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions)
327
328 #define CE_STATIC_MEMBERS(ce) \
329 ((zval*)ZEND_MAP_PTR_GET((ce)->static_members_table))
330
331 #define CE_CONSTANTS_TABLE(ce) \
332 zend_class_constants_table(ce)
333
334 #define CE_DEFAULT_PROPERTIES_TABLE(ce) \
335 zend_class_default_properties_table(ce)
336
337 #define CE_BACKED_ENUM_TABLE(ce) \
338 zend_class_backed_enum_table(ce)
339
340 #define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
341 #define ZEND_FCC_INITIALIZED(fcc) ((fcc).function_handler != NULL)
342
343 ZEND_API int zend_next_free_module(void);
344
345 BEGIN_EXTERN_C()
346 ZEND_API zend_result zend_get_parameters_array_ex(uint32_t param_count, zval *argument_array);
347
348 /* internal function to efficiently copy parameters when executing __call() */
349 ZEND_API zend_result zend_copy_parameters_array(uint32_t param_count, zval *argument_array);
350
351 #define zend_get_parameters_array(ht, param_count, argument_array) \
352 zend_get_parameters_array_ex(param_count, argument_array)
353 #define zend_parse_parameters_none() \
354 (EXPECTED(ZEND_NUM_ARGS() == 0) ? SUCCESS : (zend_wrong_parameters_none_error(), FAILURE))
355 #define zend_parse_parameters_none_throw() \
356 zend_parse_parameters_none()
357
358 /* Parameter parsing API -- andrei */
359
360 #define ZEND_PARSE_PARAMS_THROW 0 /* No longer used, zpp always uses exceptions */
361 #define ZEND_PARSE_PARAMS_QUIET (1<<1)
362 ZEND_API zend_result zend_parse_parameters(uint32_t num_args, const char *type_spec, ...);
363 ZEND_API zend_result zend_parse_parameters_ex(int flags, uint32_t num_args, const char *type_spec, ...);
364 /* NOTE: This must have at least one value in __VA_ARGS__ for the expression to be valid */
365 #define zend_parse_parameters_throw(num_args, ...) \
366 zend_parse_parameters(num_args, __VA_ARGS__)
367 ZEND_API const char *zend_zval_type_name(const zval *arg);
368 ZEND_API const char *zend_zval_value_name(const zval *arg);
369 ZEND_API zend_string *zend_zval_get_legacy_type(const zval *arg);
370
371 ZEND_API zend_result zend_parse_method_parameters(uint32_t num_args, zval *this_ptr, const char *type_spec, ...);
372 ZEND_API zend_result zend_parse_method_parameters_ex(int flags, uint32_t num_args, zval *this_ptr, const char *type_spec, ...);
373
374 ZEND_API zend_result zend_parse_parameter(int flags, uint32_t arg_num, zval *arg, const char *spec, ...);
375
376 /* End of parameter parsing API -- andrei */
377
378 ZEND_API zend_result zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type);
379 ZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table);
380 ZEND_API zend_result zend_startup_module(zend_module_entry *module_entry);
381 ZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry);
382 ZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module, int module_type);
383 ZEND_API zend_result zend_startup_module_ex(zend_module_entry *module);
384 ZEND_API void zend_startup_modules(void);
385 ZEND_API void zend_collect_module_handlers(void);
386 ZEND_API void zend_destroy_modules(void);
387 ZEND_API void zend_check_magic_method_implementation(
388 const zend_class_entry *ce, const zend_function *fptr, zend_string *lcname, int error_type);
389 ZEND_API void zend_add_magic_method(zend_class_entry *ce, zend_function *fptr, zend_string *lcname);
390
391 ZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry);
392 ZEND_API zend_class_entry *zend_register_internal_class_ex(zend_class_entry *class_entry, zend_class_entry *parent_ce);
393 ZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry);
394 ZEND_API void zend_class_implements(zend_class_entry *class_entry, int num_interfaces, ...);
395
396 ZEND_API zend_result zend_register_class_alias_ex(const char *name, size_t name_len, zend_class_entry *ce, bool persistent);
397
zend_register_class_alias(const char * name,zend_class_entry * ce)398 static zend_always_inline zend_result zend_register_class_alias(const char *name, zend_class_entry *ce) {
399 return zend_register_class_alias_ex(name, strlen(name), ce, 1);
400 }
401 #define zend_register_ns_class_alias(ns, name, ce) \
402 zend_register_class_alias_ex(ZEND_NS_NAME(ns, name), sizeof(ZEND_NS_NAME(ns, name))-1, ce, 1)
403
404 ZEND_API void zend_disable_functions(const char *function_list);
405 ZEND_API zend_result zend_disable_class(const char *class_name, size_t class_name_length);
406
407 ZEND_API ZEND_COLD void zend_wrong_param_count(void);
408 ZEND_API ZEND_COLD void zend_wrong_property_read(zval *object, zval *property);
409
410 #define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
411 #define IS_CALLABLE_SUPPRESS_DEPRECATIONS (1<<1)
412
413 ZEND_API void zend_release_fcall_info_cache(zend_fcall_info_cache *fcc);
414 ZEND_API zend_string *zend_get_callable_name_ex(zval *callable, zend_object *object);
415 ZEND_API zend_string *zend_get_callable_name(zval *callable);
416 ZEND_API bool zend_is_callable_at_frame(
417 zval *callable, zend_object *object, zend_execute_data *frame,
418 uint32_t check_flags, zend_fcall_info_cache *fcc, char **error);
419 ZEND_API bool zend_is_callable_ex(zval *callable, zend_object *object, uint32_t check_flags, zend_string **callable_name, zend_fcall_info_cache *fcc, char **error);
420 ZEND_API bool zend_is_callable(zval *callable, uint32_t check_flags, zend_string **callable_name);
421 ZEND_API bool zend_make_callable(zval *callable, zend_string **callable_name);
422 ZEND_API const char *zend_get_module_version(const char *module_name);
423 ZEND_API zend_result zend_get_module_started(const char *module_name);
424
425 ZEND_API zend_property_info *zend_declare_typed_property(zend_class_entry *ce, zend_string *name, zval *property, int access_type, zend_string *doc_comment, zend_type type);
426
427 ZEND_API void zend_declare_property_ex(zend_class_entry *ce, zend_string *name, zval *property, int access_type, zend_string *doc_comment);
428 ZEND_API void zend_declare_property(zend_class_entry *ce, const char *name, size_t name_length, zval *property, int access_type);
429 ZEND_API void zend_declare_property_null(zend_class_entry *ce, const char *name, size_t name_length, int access_type);
430 ZEND_API void zend_declare_property_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
431 ZEND_API void zend_declare_property_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
432 ZEND_API void zend_declare_property_double(zend_class_entry *ce, const char *name, size_t name_length, double value, int access_type);
433 ZEND_API void zend_declare_property_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value, int access_type);
434 ZEND_API void 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);
435
436 ZEND_API zend_class_constant *zend_declare_typed_class_constant(zend_class_entry *ce, zend_string *name, zval *value, int access_type, zend_string *doc_comment, zend_type type);
437 ZEND_API zend_class_constant *zend_declare_class_constant_ex(zend_class_entry *ce, zend_string *name, zval *value, int access_type, zend_string *doc_comment);
438 ZEND_API void zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value);
439 ZEND_API void zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length);
440 ZEND_API void zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value);
441 ZEND_API void zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, bool value);
442 ZEND_API void zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value);
443 ZEND_API void zend_declare_class_constant_stringl(zend_class_entry *ce, const char *name, size_t name_length, const char *value, size_t value_length);
444 ZEND_API void zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value);
445
446 ZEND_API zend_result zend_update_class_constant(zend_class_constant *c, const zend_string *name, zend_class_entry *scope);
447 ZEND_API zend_result zend_update_class_constants(zend_class_entry *class_type);
448 ZEND_API HashTable *zend_separate_class_constants_table(zend_class_entry *class_type);
449
zend_class_constants_table(zend_class_entry * ce)450 static zend_always_inline HashTable *zend_class_constants_table(zend_class_entry *ce) {
451 if ((ce->ce_flags & ZEND_ACC_HAS_AST_CONSTANTS) && ZEND_MAP_PTR(ce->mutable_data)) {
452 zend_class_mutable_data *mutable_data =
453 (zend_class_mutable_data*)ZEND_MAP_PTR_GET_IMM(ce->mutable_data);
454 if (mutable_data && mutable_data->constants_table) {
455 return mutable_data->constants_table;
456 } else {
457 return zend_separate_class_constants_table(ce);
458 }
459 } else {
460 return &ce->constants_table;
461 }
462 }
463
zend_class_default_properties_table(zend_class_entry * ce)464 static zend_always_inline zval *zend_class_default_properties_table(zend_class_entry *ce) {
465 if ((ce->ce_flags & ZEND_ACC_HAS_AST_PROPERTIES) && ZEND_MAP_PTR(ce->mutable_data)) {
466 zend_class_mutable_data *mutable_data =
467 (zend_class_mutable_data*)ZEND_MAP_PTR_GET_IMM(ce->mutable_data);
468 return mutable_data->default_properties_table;
469 } else {
470 return ce->default_properties_table;
471 }
472 }
473
zend_class_set_backed_enum_table(zend_class_entry * ce,HashTable * backed_enum_table)474 static zend_always_inline void zend_class_set_backed_enum_table(zend_class_entry *ce, HashTable *backed_enum_table)
475 {
476 if (ZEND_MAP_PTR(ce->mutable_data) && ce->type == ZEND_USER_CLASS) {
477 zend_class_mutable_data *mutable_data = (zend_class_mutable_data*)ZEND_MAP_PTR_GET_IMM(ce->mutable_data);
478 mutable_data->backed_enum_table = backed_enum_table;
479 } else {
480 ce->backed_enum_table = backed_enum_table;
481 }
482 }
483
zend_class_backed_enum_table(zend_class_entry * ce)484 static zend_always_inline HashTable *zend_class_backed_enum_table(zend_class_entry *ce)
485 {
486 if (ZEND_MAP_PTR(ce->mutable_data) && ce->type == ZEND_USER_CLASS) {
487 zend_class_mutable_data *mutable_data = (zend_class_mutable_data*)ZEND_MAP_PTR_GET_IMM(ce->mutable_data);
488 return mutable_data->backed_enum_table;
489 } else {
490 return ce->backed_enum_table;
491 }
492 }
493
494 ZEND_API void zend_update_property_ex(zend_class_entry *scope, zend_object *object, zend_string *name, zval *value);
495 ZEND_API void zend_update_property(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, zval *value);
496 ZEND_API void zend_update_property_null(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length);
497 ZEND_API void zend_update_property_bool(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, zend_long value);
498 ZEND_API void zend_update_property_long(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, zend_long value);
499 ZEND_API void zend_update_property_double(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, double value);
500 ZEND_API void zend_update_property_str(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, zend_string *value);
501 ZEND_API void zend_update_property_string(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, const char *value);
502 ZEND_API void zend_update_property_stringl(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, const char *value, size_t value_length);
503 ZEND_API void zend_unset_property(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length);
504
505 ZEND_API zend_result zend_update_static_property_ex(zend_class_entry *scope, zend_string *name, zval *value);
506 ZEND_API zend_result zend_update_static_property(zend_class_entry *scope, const char *name, size_t name_length, zval *value);
507 ZEND_API zend_result zend_update_static_property_null(zend_class_entry *scope, const char *name, size_t name_length);
508 ZEND_API zend_result zend_update_static_property_bool(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
509 ZEND_API zend_result zend_update_static_property_long(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
510 ZEND_API zend_result zend_update_static_property_double(zend_class_entry *scope, const char *name, size_t name_length, double value);
511 ZEND_API zend_result zend_update_static_property_string(zend_class_entry *scope, const char *name, size_t name_length, const char *value);
512 ZEND_API zend_result zend_update_static_property_stringl(zend_class_entry *scope, const char *name, size_t name_length, const char *value, size_t value_length);
513
514 ZEND_API zval *zend_read_property_ex(zend_class_entry *scope, zend_object *object, zend_string *name, bool silent, zval *rv);
515 ZEND_API zval *zend_read_property(zend_class_entry *scope, zend_object *object, const char *name, size_t name_length, bool silent, zval *rv);
516
517 ZEND_API zval *zend_read_static_property_ex(zend_class_entry *scope, zend_string *name, bool silent);
518 ZEND_API zval *zend_read_static_property(zend_class_entry *scope, const char *name, size_t name_length, bool silent);
519
520 ZEND_API const char *zend_get_type_by_const(int type);
521
522 #define ZEND_THIS (&EX(This))
523
524 #define getThis() ((Z_TYPE_P(ZEND_THIS) == IS_OBJECT) ? ZEND_THIS : NULL)
525 #define ZEND_IS_METHOD_CALL() (EX(func)->common.scope != NULL)
526
527 #define WRONG_PARAM_COUNT ZEND_WRONG_PARAM_COUNT()
528 #define ZEND_NUM_ARGS() EX_NUM_ARGS()
529 #define ZEND_WRONG_PARAM_COUNT() { zend_wrong_param_count(); return; }
530
531 #ifndef ZEND_WIN32
532 #define DLEXPORT
533 #endif
534
535 #define array_init(arg) ZVAL_ARR((arg), zend_new_array(0))
536 #define array_init_size(arg, size) ZVAL_ARR((arg), zend_new_array(size))
537 ZEND_API void object_init(zval *arg);
538 ZEND_API zend_result object_init_ex(zval *arg, zend_class_entry *ce);
539 ZEND_API zend_result object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties);
540 ZEND_API void object_properties_init(zend_object *object, zend_class_entry *class_type);
541 ZEND_API void object_properties_init_ex(zend_object *object, HashTable *properties);
542 ZEND_API void object_properties_load(zend_object *object, HashTable *properties);
543
544 ZEND_API void zend_merge_properties(zval *obj, HashTable *properties);
545
546 ZEND_API void add_assoc_long_ex(zval *arg, const char *key, size_t key_len, zend_long n);
547 ZEND_API void add_assoc_null_ex(zval *arg, const char *key, size_t key_len);
548 ZEND_API void add_assoc_bool_ex(zval *arg, const char *key, size_t key_len, bool b);
549 ZEND_API void add_assoc_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
550 ZEND_API void add_assoc_double_ex(zval *arg, const char *key, size_t key_len, double d);
551 ZEND_API void add_assoc_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
552 ZEND_API void add_assoc_string_ex(zval *arg, const char *key, size_t key_len, const char *str);
553 ZEND_API void add_assoc_stringl_ex(zval *arg, const char *key, size_t key_len, const char *str, size_t length);
554 ZEND_API void add_assoc_array_ex(zval *arg, const char *key, size_t key_len, zend_array *arr);
555 ZEND_API void add_assoc_object_ex(zval *arg, const char *key, size_t key_len, zend_object *obj);
556 ZEND_API void add_assoc_reference_ex(zval *arg, const char *key, size_t key_len, zend_reference *ref);
557 ZEND_API void add_assoc_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
558
add_assoc_long(zval * arg,const char * key,zend_long n)559 static zend_always_inline void add_assoc_long(zval *arg, const char *key, zend_long n) {
560 add_assoc_long_ex(arg, key, strlen(key), n);
561 }
add_assoc_null(zval * arg,const char * key)562 static zend_always_inline void add_assoc_null(zval *arg, const char *key) {
563 add_assoc_null_ex(arg, key, strlen(key));
564 }
add_assoc_bool(zval * arg,const char * key,bool b)565 static zend_always_inline void add_assoc_bool(zval *arg, const char *key, bool b) {
566 add_assoc_bool_ex(arg, key, strlen(key), b);
567 }
add_assoc_resource(zval * arg,const char * key,zend_resource * r)568 static zend_always_inline void add_assoc_resource(zval *arg, const char *key, zend_resource *r) {
569 add_assoc_resource_ex(arg, key, strlen(key), r);
570 }
add_assoc_double(zval * arg,const char * key,double d)571 static zend_always_inline void add_assoc_double(zval *arg, const char *key, double d) {
572 add_assoc_double_ex(arg, key, strlen(key), d);
573 }
add_assoc_str(zval * arg,const char * key,zend_string * str)574 static zend_always_inline void add_assoc_str(zval *arg, const char *key, zend_string *str) {
575 add_assoc_str_ex(arg, key, strlen(key), str);
576 }
add_assoc_string(zval * arg,const char * key,const char * str)577 static zend_always_inline void add_assoc_string(zval *arg, const char *key, const char *str) {
578 add_assoc_string_ex(arg, key, strlen(key), str);
579 }
add_assoc_stringl(zval * arg,const char * key,const char * str,size_t length)580 static zend_always_inline void add_assoc_stringl(zval *arg, const char *key, const char *str, size_t length) {
581 add_assoc_stringl_ex(arg, key, strlen(key), str, length);
582 }
add_assoc_array(zval * arg,const char * key,zend_array * arr)583 static zend_always_inline void add_assoc_array(zval *arg, const char *key, zend_array *arr) {
584 add_assoc_array_ex(arg, key, strlen(key), arr);
585 }
add_assoc_object(zval * arg,const char * key,zend_object * obj)586 static zend_always_inline void add_assoc_object(zval *arg, const char *key, zend_object *obj) {
587 add_assoc_object_ex(arg, key, strlen(key), obj);
588 }
add_assoc_reference(zval * arg,const char * key,zend_reference * ref)589 static zend_always_inline void add_assoc_reference(zval *arg, const char *key, zend_reference *ref) {
590 add_assoc_reference_ex(arg, key, strlen(key), ref);
591 }
add_assoc_zval(zval * arg,const char * key,zval * value)592 static zend_always_inline void add_assoc_zval(zval *arg, const char *key, zval *value) {
593 add_assoc_zval_ex(arg, key, strlen(key), value);
594 }
595
596 ZEND_API void add_index_long(zval *arg, zend_ulong index, zend_long n);
597 ZEND_API void add_index_null(zval *arg, zend_ulong index);
598 ZEND_API void add_index_bool(zval *arg, zend_ulong index, bool b);
599 ZEND_API void add_index_resource(zval *arg, zend_ulong index, zend_resource *r);
600 ZEND_API void add_index_double(zval *arg, zend_ulong index, double d);
601 ZEND_API void add_index_str(zval *arg, zend_ulong index, zend_string *str);
602 ZEND_API void add_index_string(zval *arg, zend_ulong index, const char *str);
603 ZEND_API void add_index_stringl(zval *arg, zend_ulong index, const char *str, size_t length);
604 ZEND_API void add_index_array(zval *arg, zend_ulong index, zend_array *arr);
605 ZEND_API void add_index_object(zval *arg, zend_ulong index, zend_object *obj);
606 ZEND_API void add_index_reference(zval *arg, zend_ulong index, zend_reference *ref);
607
add_index_zval(zval * arg,zend_ulong index,zval * value)608 static zend_always_inline zend_result add_index_zval(zval *arg, zend_ulong index, zval *value)
609 {
610 return zend_hash_index_update(Z_ARRVAL_P(arg), index, value) ? SUCCESS : FAILURE;
611 }
612
613 ZEND_API zend_result add_next_index_long(zval *arg, zend_long n);
614 ZEND_API zend_result add_next_index_null(zval *arg);
615 ZEND_API zend_result add_next_index_bool(zval *arg, bool b);
616 ZEND_API zend_result add_next_index_resource(zval *arg, zend_resource *r);
617 ZEND_API zend_result add_next_index_double(zval *arg, double d);
618 ZEND_API zend_result add_next_index_str(zval *arg, zend_string *str);
619 ZEND_API zend_result add_next_index_string(zval *arg, const char *str);
620 ZEND_API zend_result add_next_index_stringl(zval *arg, const char *str, size_t length);
621 ZEND_API zend_result add_next_index_array(zval *arg, zend_array *arr);
622 ZEND_API zend_result add_next_index_object(zval *arg, zend_object *obj);
623 ZEND_API zend_result add_next_index_reference(zval *arg, zend_reference *ref);
624
add_next_index_zval(zval * arg,zval * value)625 static zend_always_inline zend_result add_next_index_zval(zval *arg, zval *value)
626 {
627 return zend_hash_next_index_insert(Z_ARRVAL_P(arg), value) ? SUCCESS : FAILURE;
628 }
629
630 ZEND_API zend_result array_set_zval_key(HashTable *ht, zval *key, zval *value);
631
632 ZEND_API void add_property_long_ex(zval *arg, const char *key, size_t key_len, zend_long l);
633 ZEND_API void add_property_null_ex(zval *arg, const char *key, size_t key_len);
634 ZEND_API void add_property_bool_ex(zval *arg, const char *key, size_t key_len, zend_long b);
635 ZEND_API void add_property_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
636 ZEND_API void add_property_double_ex(zval *arg, const char *key, size_t key_len, double d);
637 ZEND_API void add_property_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
638 ZEND_API void add_property_string_ex(zval *arg, const char *key, size_t key_len, const char *str);
639 ZEND_API void add_property_stringl_ex(zval *arg, const char *key, size_t key_len, const char *str, size_t length);
640 ZEND_API void add_property_array_ex(zval *arg, const char *key, size_t key_len, zend_array *arr);
641 ZEND_API void add_property_object_ex(zval *arg, const char *key, size_t key_len, zend_object *obj);
642 ZEND_API void add_property_reference_ex(zval *arg, const char *key, size_t key_len, zend_reference *ref);
643 ZEND_API void add_property_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
644
add_property_long(zval * arg,const char * key,zend_long n)645 static zend_always_inline void add_property_long(zval *arg, const char *key, zend_long n) {
646 add_property_long_ex(arg, key, strlen(key), n);
647 }
add_property_null(zval * arg,const char * key)648 static zend_always_inline void add_property_null(zval *arg, const char *key) {
649 add_property_null_ex(arg, key, strlen(key));
650 }
add_property_bool(zval * arg,const char * key,bool b)651 static zend_always_inline void add_property_bool(zval *arg, const char *key, bool b) {
652 add_property_bool_ex(arg, key, strlen(key), b);
653 }
add_property_resource(zval * arg,const char * key,zend_resource * r)654 static zend_always_inline void add_property_resource(zval *arg, const char *key, zend_resource *r) {
655 add_property_resource_ex(arg, key, strlen(key), r);
656 }
add_property_double(zval * arg,const char * key,double d)657 static zend_always_inline void add_property_double(zval *arg, const char *key, double d) {
658 add_property_double_ex(arg, key, strlen(key), d);
659 }
add_property_str(zval * arg,const char * key,zend_string * str)660 static zend_always_inline void add_property_str(zval *arg, const char *key, zend_string *str) {
661 add_property_str_ex(arg, key, strlen(key), str);
662 }
add_property_string(zval * arg,const char * key,const char * str)663 static zend_always_inline void add_property_string(zval *arg, const char *key, const char *str) {
664 add_property_string_ex(arg, key, strlen(key), str);
665 }
add_property_stringl(zval * arg,const char * key,const char * str,size_t length)666 static zend_always_inline void add_property_stringl(zval *arg, const char *key, const char *str, size_t length) {
667 add_property_stringl_ex(arg, key, strlen(key), str, length);
668 }
add_property_array(zval * arg,const char * key,zend_array * arr)669 static zend_always_inline void add_property_array(zval *arg, const char *key, zend_array *arr) {
670 add_property_array_ex(arg, key, strlen(key), arr);
671 }
add_property_object(zval * arg,const char * key,zend_object * obj)672 static zend_always_inline void add_property_object(zval *arg, const char *key, zend_object *obj) {
673 add_property_object_ex(arg, key, strlen(key), obj);
674 }
add_property_reference(zval * arg,const char * key,zend_reference * ref)675 static zend_always_inline void add_property_reference(zval *arg, const char *key, zend_reference *ref) {
676 add_property_reference_ex(arg, key, strlen(key), ref);
677 }
add_property_zval(zval * arg,const char * key,zval * value)678 static zend_always_inline void add_property_zval(zval *arg, const char *key, zval *value) {
679 add_property_zval_ex(arg, key, strlen(key), value);
680 }
681
682 ZEND_API zend_result _call_user_function_impl(zval *object, zval *function_name, zval *retval_ptr, uint32_t param_count, zval params[], HashTable *named_params);
683
684 #define call_user_function(function_table, object, function_name, retval_ptr, param_count, params) \
685 _call_user_function_impl(object, function_name, retval_ptr, param_count, params, NULL)
686
687 #define call_user_function_named(function_table, object, function_name, retval_ptr, param_count, params, named_params) \
688 _call_user_function_impl(object, function_name, retval_ptr, param_count, params, named_params)
689
690 ZEND_API extern const zend_fcall_info empty_fcall_info;
691 ZEND_API extern const zend_fcall_info_cache empty_fcall_info_cache;
692
693 /** Build zend_call_info/cache from a zval*
694 *
695 * Caller is responsible to provide a return value (fci->retval), otherwise the we will crash.
696 * In order to pass parameters the following members need to be set:
697 * fci->param_count = 0;
698 * fci->params = NULL;
699 * The callable_name argument may be NULL.
700 */
701 ZEND_API zend_result zend_fcall_info_init(zval *callable, uint32_t check_flags, zend_fcall_info *fci, zend_fcall_info_cache *fcc, zend_string **callable_name, char **error);
702
703 /** Clear arguments connected with zend_fcall_info *fci
704 * If free_mem is not zero then the params array gets free'd as well
705 */
706 ZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, bool free_mem);
707
708 /** Save current arguments from zend_fcall_info *fci
709 * params array will be set to NULL
710 */
711 ZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, uint32_t *param_count, zval **params);
712
713 /** Free arguments connected with zend_fcall_info *fci and set back saved ones.
714 */
715 ZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, uint32_t param_count, zval *params);
716
717 /** Set or clear the arguments in the zend_call_info struct taking care of
718 * refcount. If args is NULL and arguments are set then those are cleared.
719 */
720 ZEND_API zend_result zend_fcall_info_args(zend_fcall_info *fci, zval *args);
721 ZEND_API zend_result zend_fcall_info_args_ex(zend_fcall_info *fci, zend_function *func, zval *args);
722
723 /** Set arguments in the zend_fcall_info struct taking care of refcount.
724 * If argc is 0 the arguments which are set will be cleared, else pass
725 * a variable amount of zval** arguments.
726 */
727 ZEND_API void zend_fcall_info_argp(zend_fcall_info *fci, uint32_t argc, zval *argv);
728
729 /** Set arguments in the zend_fcall_info struct taking care of refcount.
730 * If argc is 0 the arguments which are set will be cleared, else pass
731 * a variable amount of zval** arguments.
732 */
733 ZEND_API void zend_fcall_info_argv(zend_fcall_info *fci, uint32_t argc, va_list *argv);
734
735 /** Set arguments in the zend_fcall_info struct taking care of refcount.
736 * If argc is 0 the arguments which are set will be cleared, else pass
737 * a variable amount of zval** arguments.
738 */
739 ZEND_API void zend_fcall_info_argn(zend_fcall_info *fci, uint32_t argc, ...);
740
741 /** Call a function using information created by zend_fcall_info_init()/args().
742 * If args is given then those replace the argument info in fci is temporarily.
743 */
744 ZEND_API zend_result zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval *retval, zval *args);
745
746 /* Zend FCC API to store and handle PHP userland functions */
zend_fcc_equals(const zend_fcall_info_cache * a,const zend_fcall_info_cache * b)747 static zend_always_inline bool zend_fcc_equals(const zend_fcall_info_cache* a, const zend_fcall_info_cache* b)
748 {
749 if (UNEXPECTED((a->function_handler->common.fn_flags & ZEND_ACC_CALL_VIA_TRAMPOLINE) &&
750 (b->function_handler->common.fn_flags & ZEND_ACC_CALL_VIA_TRAMPOLINE))) {
751 return a->object == b->object
752 && a->calling_scope == b->calling_scope
753 && a->closure == b->closure
754 && zend_string_equals(a->function_handler->common.function_name, b->function_handler->common.function_name)
755 ;
756 }
757 return a->function_handler == b->function_handler
758 && a->object == b->object
759 && a->calling_scope == b->calling_scope
760 && a->closure == b->closure
761 ;
762 }
763
zend_fcc_addref(zend_fcall_info_cache * fcc)764 static zend_always_inline void zend_fcc_addref(zend_fcall_info_cache *fcc)
765 {
766 ZEND_ASSERT(ZEND_FCC_INITIALIZED(*fcc) && "FCC Not initialized, possibly refetch trampoline freed by ZPP?");
767 /* If the cached trampoline is set, free it */
768 if (UNEXPECTED(fcc->function_handler == &EG(trampoline))) {
769 zend_function *copy = (zend_function*)emalloc(sizeof(zend_function));
770
771 memcpy(copy, fcc->function_handler, sizeof(zend_function));
772 fcc->function_handler->common.function_name = NULL;
773 fcc->function_handler = copy;
774 }
775 if (fcc->object) {
776 GC_ADDREF(fcc->object);
777 }
778 if (fcc->closure) {
779 GC_ADDREF(fcc->closure);
780 }
781 }
782
zend_fcc_dup(zend_fcall_info_cache * dest,const zend_fcall_info_cache * src)783 static zend_always_inline void zend_fcc_dup(/* restrict */ zend_fcall_info_cache *dest, const zend_fcall_info_cache *src)
784 {
785 memcpy(dest, src, sizeof(zend_fcall_info_cache));
786 zend_fcc_addref(dest);
787 }
788
zend_fcc_dtor(zend_fcall_info_cache * fcc)789 static zend_always_inline void zend_fcc_dtor(zend_fcall_info_cache *fcc)
790 {
791 ZEND_ASSERT(fcc->function_handler);
792 if (fcc->object) {
793 OBJ_RELEASE(fcc->object);
794 }
795 /* Need to free potential trampoline (__call/__callStatic) copied function handler before releasing the closure */
796 zend_release_fcall_info_cache(fcc);
797 if (fcc->closure) {
798 OBJ_RELEASE(fcc->closure);
799 }
800 memcpy(fcc, &empty_fcall_info_cache, sizeof(zend_fcall_info_cache));
801 }
802
803 ZEND_API void zend_get_callable_zval_from_fcc(const zend_fcall_info_cache *fcc, zval *callable);
804
805 /* Moved out of zend_gc.h because zend_fcall_info_cache is an unknown type in that header */
zend_get_gc_buffer_add_fcc(zend_get_gc_buffer * gc_buffer,zend_fcall_info_cache * fcc)806 static zend_always_inline void zend_get_gc_buffer_add_fcc(zend_get_gc_buffer *gc_buffer, zend_fcall_info_cache *fcc)
807 {
808 ZEND_ASSERT(ZEND_FCC_INITIALIZED(*fcc));
809 if (fcc->object) {
810 zend_get_gc_buffer_add_obj(gc_buffer, fcc->object);
811 }
812 if (fcc->closure) {
813 zend_get_gc_buffer_add_obj(gc_buffer, fcc->closure);
814 }
815 }
816
817 /* Can only return FAILURE if EG(active) is false during late engine shutdown.
818 * If the call or call setup throws, EG(exception) will be set and the retval
819 * will be UNDEF. Otherwise, the retval will be a non-UNDEF value. */
820 ZEND_API zend_result zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache);
821
822 /* Call the FCI/FCC pair while setting the call return value to the passed zval*. */
zend_call_function_with_return_value(zend_fcall_info * fci,zend_fcall_info_cache * fci_cache,zval * retval)823 static zend_always_inline zend_result zend_call_function_with_return_value(
824 zend_fcall_info *fci, zend_fcall_info_cache *fci_cache, zval *retval)
825 {
826 ZEND_ASSERT(retval && "Use zend_call_function() directly if not providing a retval");
827 fci->retval = retval;
828 return zend_call_function(fci, fci_cache);
829 }
830
831 /* Call the provided zend_function with the given params.
832 * If retval_ptr is NULL, the return value is discarded.
833 * If object is NULL, this must be a free function or static call.
834 * called_scope must be provided for instance and static method calls. */
835 ZEND_API void zend_call_known_function(
836 zend_function *fn, zend_object *object, zend_class_entry *called_scope, zval *retval_ptr,
837 uint32_t param_count, zval *params, HashTable *named_params);
838
zend_call_known_fcc(zend_fcall_info_cache * fcc,zval * retval_ptr,uint32_t param_count,zval * params,HashTable * named_params)839 static zend_always_inline void zend_call_known_fcc(
840 zend_fcall_info_cache *fcc, zval *retval_ptr, uint32_t param_count, zval *params, HashTable *named_params)
841 {
842 zend_function *func = fcc->function_handler;
843 /* Need to copy trampolines as they get released after they are called */
844 if (UNEXPECTED(func->common.fn_flags & ZEND_ACC_CALL_VIA_TRAMPOLINE)) {
845 func = (zend_function*) emalloc(sizeof(zend_function));
846 memcpy(func, fcc->function_handler, sizeof(zend_function));
847 zend_string_addref(func->op_array.function_name);
848 }
849 zend_call_known_function(func, fcc->object, fcc->called_scope, retval_ptr, param_count, params, named_params);
850 }
851
852 /* Call the provided zend_function instance method on an object. */
zend_call_known_instance_method(zend_function * fn,zend_object * object,zval * retval_ptr,uint32_t param_count,zval * params)853 static zend_always_inline void zend_call_known_instance_method(
854 zend_function *fn, zend_object *object, zval *retval_ptr,
855 uint32_t param_count, zval *params)
856 {
857 zend_call_known_function(fn, object, object->ce, retval_ptr, param_count, params, NULL);
858 }
859
zend_call_known_instance_method_with_0_params(zend_function * fn,zend_object * object,zval * retval_ptr)860 static zend_always_inline void zend_call_known_instance_method_with_0_params(
861 zend_function *fn, zend_object *object, zval *retval_ptr)
862 {
863 zend_call_known_instance_method(fn, object, retval_ptr, 0, NULL);
864 }
865
zend_call_known_instance_method_with_1_params(zend_function * fn,zend_object * object,zval * retval_ptr,zval * param)866 static zend_always_inline void zend_call_known_instance_method_with_1_params(
867 zend_function *fn, zend_object *object, zval *retval_ptr, zval *param)
868 {
869 zend_call_known_instance_method(fn, object, retval_ptr, 1, param);
870 }
871
872 ZEND_API void zend_call_known_instance_method_with_2_params(
873 zend_function *fn, zend_object *object, zval *retval_ptr, zval *param1, zval *param2);
874
875 /* Call method if it exists. Return FAILURE if method does not exist or call failed.
876 * If FAILURE is returned, retval will be UNDEF. As such, destroying retval unconditionally
877 * is legal. */
878 ZEND_API zend_result zend_call_method_if_exists(
879 zend_object *object, zend_string *method_name, zval *retval,
880 uint32_t param_count, zval *params);
881
882 ZEND_API zend_result zend_set_hash_symbol(zval *symbol, const char *name, size_t name_length, bool is_ref, int num_symbol_tables, ...);
883
884 ZEND_API zend_result zend_delete_global_variable(zend_string *name);
885
886 ZEND_API zend_array *zend_rebuild_symbol_table(void);
887 ZEND_API void zend_attach_symbol_table(zend_execute_data *execute_data);
888 ZEND_API void zend_detach_symbol_table(zend_execute_data *execute_data);
889 ZEND_API zend_result zend_set_local_var(zend_string *name, zval *value, bool force);
890 ZEND_API zend_result zend_set_local_var_str(const char *name, size_t len, zval *value, bool force);
891
zend_forbid_dynamic_call(void)892 static zend_always_inline zend_result zend_forbid_dynamic_call(void)
893 {
894 zend_execute_data *ex = EG(current_execute_data);
895 ZEND_ASSERT(ex != NULL && ex->func != NULL);
896
897 if (ZEND_CALL_INFO(ex) & ZEND_CALL_DYNAMIC) {
898 zend_string *function_or_method_name = get_active_function_or_method_name();
899 zend_throw_error(NULL, "Cannot call %.*s() dynamically",
900 (int) ZSTR_LEN(function_or_method_name), ZSTR_VAL(function_or_method_name));
901 zend_string_release(function_or_method_name);
902 return FAILURE;
903 }
904
905 return SUCCESS;
906 }
907
908 ZEND_API ZEND_COLD const char *zend_get_object_type_case(const zend_class_entry *ce, bool upper_case);
909
zend_get_object_type(const zend_class_entry * ce)910 static zend_always_inline const char *zend_get_object_type(const zend_class_entry *ce)
911 {
912 return zend_get_object_type_case(ce, false);
913 }
914
zend_get_object_type_uc(const zend_class_entry * ce)915 static zend_always_inline const char *zend_get_object_type_uc(const zend_class_entry *ce)
916 {
917 return zend_get_object_type_case(ce, true);
918 }
919
920 ZEND_API bool zend_is_iterable(const zval *iterable);
921
922 ZEND_API bool zend_is_countable(const zval *countable);
923
924 ZEND_API zend_result zend_get_default_from_internal_arg_info(
925 zval *default_value_zval, zend_internal_arg_info *arg_info);
926
END_EXTERN_C()927 END_EXTERN_C()
928
929 #if ZEND_DEBUG
930 #define CHECK_ZVAL_STRING(str) \
931 ZEND_ASSERT(ZSTR_VAL(str)[ZSTR_LEN(str)] == '\0' && "String is not null-terminated");
932 #else
933 #define CHECK_ZVAL_STRING(z)
934 #endif
935
936 static zend_always_inline bool zend_str_has_nul_byte(const zend_string *str)
937 {
938 return ZSTR_LEN(str) != strlen(ZSTR_VAL(str));
939 }
zend_char_has_nul_byte(const char * s,size_t known_length)940 static zend_always_inline bool zend_char_has_nul_byte(const char *s, size_t known_length)
941 {
942 return known_length != strlen(s);
943 }
944
945 /* Compatibility with PHP 8.1 and below */
946 #define CHECK_ZVAL_NULL_PATH(p) zend_str_has_nul_byte(Z_STR_P(p))
947 #define CHECK_NULL_PATH(p, l) zend_char_has_nul_byte(p, l)
948
949 #define ZVAL_STRINGL(z, s, l) do { \
950 ZVAL_NEW_STR(z, zend_string_init(s, l, 0)); \
951 } while (0)
952
953 #define ZVAL_STRING(z, s) do { \
954 const char *_s = (s); \
955 ZVAL_STRINGL(z, _s, strlen(_s)); \
956 } while (0)
957
958 #define ZVAL_EMPTY_STRING(z) do { \
959 ZVAL_INTERNED_STR(z, ZSTR_EMPTY_ALLOC()); \
960 } while (0)
961
962 #define ZVAL_PSTRINGL(z, s, l) do { \
963 ZVAL_NEW_STR(z, zend_string_init(s, l, 1)); \
964 } while (0)
965
966 #define ZVAL_PSTRING(z, s) do { \
967 const char *_s = (s); \
968 ZVAL_PSTRINGL(z, _s, strlen(_s)); \
969 } while (0)
970
971 #define ZVAL_EMPTY_PSTRING(z) do { \
972 ZVAL_PSTRINGL(z, "", 0); \
973 } while (0)
974
975 #define ZVAL_CHAR(z, c) do { \
976 char _c = (c); \
977 ZVAL_INTERNED_STR(z, ZSTR_CHAR((zend_uchar) _c)); \
978 } while (0)
979
980 #define ZVAL_STRINGL_FAST(z, s, l) do { \
981 ZVAL_STR(z, zend_string_init_fast(s, l)); \
982 } while (0)
983
984 #define ZVAL_STRING_FAST(z, s) do { \
985 const char *_s = (s); \
986 ZVAL_STRINGL_FAST(z, _s, strlen(_s)); \
987 } while (0)
988
989 #define ZVAL_ZVAL(z, zv, copy, dtor) do { \
990 zval *__z = (z); \
991 zval *__zv = (zv); \
992 if (EXPECTED(!Z_ISREF_P(__zv))) { \
993 if (copy && !dtor) { \
994 ZVAL_COPY(__z, __zv); \
995 } else { \
996 ZVAL_COPY_VALUE(__z, __zv); \
997 } \
998 } else { \
999 ZVAL_COPY(__z, Z_REFVAL_P(__zv)); \
1000 if (dtor || !copy) { \
1001 zval_ptr_dtor(__zv); \
1002 } \
1003 } \
1004 } while (0)
1005
1006 #define RETVAL_BOOL(b) ZVAL_BOOL(return_value, b)
1007 #define RETVAL_NULL() ZVAL_NULL(return_value)
1008 #define RETVAL_LONG(l) ZVAL_LONG(return_value, l)
1009 #define RETVAL_DOUBLE(d) ZVAL_DOUBLE(return_value, d)
1010 #define RETVAL_STR(s) ZVAL_STR(return_value, s)
1011 #define RETVAL_INTERNED_STR(s) ZVAL_INTERNED_STR(return_value, s)
1012 #define RETVAL_NEW_STR(s) ZVAL_NEW_STR(return_value, s)
1013 #define RETVAL_STR_COPY(s) ZVAL_STR_COPY(return_value, s)
1014 #define RETVAL_STRING(s) ZVAL_STRING(return_value, s)
1015 #define RETVAL_STRINGL(s, l) ZVAL_STRINGL(return_value, s, l)
1016 #define RETVAL_STRING_FAST(s) ZVAL_STRING_FAST(return_value, s)
1017 #define RETVAL_STRINGL_FAST(s, l) ZVAL_STRINGL_FAST(return_value, s, l)
1018 #define RETVAL_EMPTY_STRING() ZVAL_EMPTY_STRING(return_value)
1019 #define RETVAL_CHAR(c) ZVAL_CHAR(return_value, c)
1020 #define RETVAL_RES(r) ZVAL_RES(return_value, r)
1021 #define RETVAL_ARR(r) ZVAL_ARR(return_value, r)
1022 #define RETVAL_EMPTY_ARRAY() ZVAL_EMPTY_ARRAY(return_value)
1023 #define RETVAL_OBJ(r) ZVAL_OBJ(return_value, r)
1024 #define RETVAL_OBJ_COPY(r) ZVAL_OBJ_COPY(return_value, r)
1025 #define RETVAL_COPY(zv) ZVAL_COPY(return_value, zv)
1026 #define RETVAL_COPY_VALUE(zv) ZVAL_COPY_VALUE(return_value, zv)
1027 #define RETVAL_COPY_DEREF(zv) ZVAL_COPY_DEREF(return_value, zv)
1028 #define RETVAL_ZVAL(zv, copy, dtor) ZVAL_ZVAL(return_value, zv, copy, dtor)
1029 #define RETVAL_FALSE ZVAL_FALSE(return_value)
1030 #define RETVAL_TRUE ZVAL_TRUE(return_value)
1031
1032 #define RETURN_BOOL(b) do { RETVAL_BOOL(b); return; } while (0)
1033 #define RETURN_NULL() do { RETVAL_NULL(); return;} while (0)
1034 #define RETURN_LONG(l) do { RETVAL_LONG(l); return; } while (0)
1035 #define RETURN_DOUBLE(d) do { RETVAL_DOUBLE(d); return; } while (0)
1036 #define RETURN_STR(s) do { RETVAL_STR(s); return; } while (0)
1037 #define RETURN_INTERNED_STR(s) do { RETVAL_INTERNED_STR(s); return; } while (0)
1038 #define RETURN_NEW_STR(s) do { RETVAL_NEW_STR(s); return; } while (0)
1039 #define RETURN_STR_COPY(s) do { RETVAL_STR_COPY(s); return; } while (0)
1040 #define RETURN_STRING(s) do { RETVAL_STRING(s); return; } while (0)
1041 #define RETURN_STRINGL(s, l) do { RETVAL_STRINGL(s, l); return; } while (0)
1042 #define RETURN_STRING_FAST(s) do { RETVAL_STRING_FAST(s); return; } while (0)
1043 #define RETURN_STRINGL_FAST(s, l) do { RETVAL_STRINGL_FAST(s, l); return; } while (0)
1044 #define RETURN_EMPTY_STRING() do { RETVAL_EMPTY_STRING(); return; } while (0)
1045 #define RETURN_CHAR(c) do { RETVAL_CHAR(c); return; } while (0)
1046 #define RETURN_RES(r) do { RETVAL_RES(r); return; } while (0)
1047 #define RETURN_ARR(r) do { RETVAL_ARR(r); return; } while (0)
1048 #define RETURN_EMPTY_ARRAY() do { RETVAL_EMPTY_ARRAY(); return; } while (0)
1049 #define RETURN_OBJ(r) do { RETVAL_OBJ(r); return; } while (0)
1050 #define RETURN_OBJ_COPY(r) do { RETVAL_OBJ_COPY(r); return; } while (0)
1051 #define RETURN_COPY(zv) do { RETVAL_COPY(zv); return; } while (0)
1052 #define RETURN_COPY_VALUE(zv) do { RETVAL_COPY_VALUE(zv); return; } while (0)
1053 #define RETURN_COPY_DEREF(zv) do { RETVAL_COPY_DEREF(zv); return; } while (0)
1054 #define RETURN_ZVAL(zv, copy, dtor) do { RETVAL_ZVAL(zv, copy, dtor); return; } while (0)
1055 #define RETURN_FALSE do { RETVAL_FALSE; return; } while (0)
1056 #define RETURN_TRUE do { RETVAL_TRUE; return; } while (0)
1057 #define RETURN_THROWS() do { ZEND_ASSERT(EG(exception)); (void) return_value; return; } while (0)
1058
1059 #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(Z_OBJ_P(p)) : NULL)))
1060 #define ZVAL_IS_NULL(z) (Z_TYPE_P(z) == IS_NULL)
1061
1062 /* For compatibility */
1063 #define ZEND_MINIT ZEND_MODULE_STARTUP_N
1064 #define ZEND_MSHUTDOWN ZEND_MODULE_SHUTDOWN_N
1065 #define ZEND_RINIT ZEND_MODULE_ACTIVATE_N
1066 #define ZEND_RSHUTDOWN ZEND_MODULE_DEACTIVATE_N
1067 #define ZEND_MINFO ZEND_MODULE_INFO_N
1068 #define ZEND_GINIT(module) ((void (*)(void*))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
1069 #define ZEND_GSHUTDOWN(module) ((void (*)(void*))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
1070
1071 #define ZEND_MINIT_FUNCTION ZEND_MODULE_STARTUP_D
1072 #define ZEND_MSHUTDOWN_FUNCTION ZEND_MODULE_SHUTDOWN_D
1073 #define ZEND_RINIT_FUNCTION ZEND_MODULE_ACTIVATE_D
1074 #define ZEND_RSHUTDOWN_FUNCTION ZEND_MODULE_DEACTIVATE_D
1075 #define ZEND_MINFO_FUNCTION ZEND_MODULE_INFO_D
1076 #define ZEND_GINIT_FUNCTION ZEND_MODULE_GLOBALS_CTOR_D
1077 #define ZEND_GSHUTDOWN_FUNCTION ZEND_MODULE_GLOBALS_DTOR_D
1078
1079 /* May modify arg in-place. Will free arg in failure case (and take ownership in success case).
1080 * Prefer using the ZEND_TRY_ASSIGN_* macros over these APIs. */
1081 ZEND_API zend_result zend_try_assign_typed_ref_ex(zend_reference *ref, zval *zv, bool strict);
1082 ZEND_API zend_result zend_try_assign_typed_ref(zend_reference *ref, zval *zv);
1083
1084 ZEND_API zend_result zend_try_assign_typed_ref_null(zend_reference *ref);
1085 ZEND_API zend_result zend_try_assign_typed_ref_bool(zend_reference *ref, bool val);
1086 ZEND_API zend_result zend_try_assign_typed_ref_long(zend_reference *ref, zend_long lval);
1087 ZEND_API zend_result zend_try_assign_typed_ref_double(zend_reference *ref, double dval);
1088 ZEND_API zend_result zend_try_assign_typed_ref_empty_string(zend_reference *ref);
1089 ZEND_API zend_result zend_try_assign_typed_ref_str(zend_reference *ref, zend_string *str);
1090 ZEND_API zend_result zend_try_assign_typed_ref_string(zend_reference *ref, const char *string);
1091 ZEND_API zend_result zend_try_assign_typed_ref_stringl(zend_reference *ref, const char *string, size_t len);
1092 ZEND_API zend_result zend_try_assign_typed_ref_arr(zend_reference *ref, zend_array *arr);
1093 ZEND_API zend_result zend_try_assign_typed_ref_res(zend_reference *ref, zend_resource *res);
1094 ZEND_API zend_result zend_try_assign_typed_ref_zval(zend_reference *ref, zval *zv);
1095 ZEND_API zend_result zend_try_assign_typed_ref_zval_ex(zend_reference *ref, zval *zv, bool strict);
1096
1097 #define _ZEND_TRY_ASSIGN_NULL(zv, is_ref) do { \
1098 zval *_zv = zv; \
1099 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1100 zend_reference *ref = Z_REF_P(_zv); \
1101 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1102 zend_try_assign_typed_ref_null(ref); \
1103 break; \
1104 } \
1105 _zv = &ref->val; \
1106 } \
1107 zval_ptr_dtor(_zv); \
1108 ZVAL_NULL(_zv); \
1109 } while (0)
1110
1111 #define ZEND_TRY_ASSIGN_NULL(zv) \
1112 _ZEND_TRY_ASSIGN_NULL(zv, 0)
1113
1114 #define ZEND_TRY_ASSIGN_REF_NULL(zv) do { \
1115 ZEND_ASSERT(Z_ISREF_P(zv)); \
1116 _ZEND_TRY_ASSIGN_NULL(zv, 1); \
1117 } while (0)
1118
1119 #define _ZEND_TRY_ASSIGN_FALSE(zv, is_ref) do { \
1120 zval *_zv = zv; \
1121 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1122 zend_reference *ref = Z_REF_P(_zv); \
1123 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1124 zend_try_assign_typed_ref_bool(ref, 0); \
1125 break; \
1126 } \
1127 _zv = &ref->val; \
1128 } \
1129 zval_ptr_dtor(_zv); \
1130 ZVAL_FALSE(_zv); \
1131 } while (0)
1132
1133 #define ZEND_TRY_ASSIGN_FALSE(zv) \
1134 _ZEND_TRY_ASSIGN_FALSE(zv, 0)
1135
1136 #define ZEND_TRY_ASSIGN_REF_FALSE(zv) do { \
1137 ZEND_ASSERT(Z_ISREF_P(zv)); \
1138 _ZEND_TRY_ASSIGN_FALSE(zv, 1); \
1139 } while (0)
1140
1141 #define _ZEND_TRY_ASSIGN_TRUE(zv, is_ref) do { \
1142 zval *_zv = zv; \
1143 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1144 zend_reference *ref = Z_REF_P(_zv); \
1145 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1146 zend_try_assign_typed_ref_bool(ref, 1); \
1147 break; \
1148 } \
1149 _zv = &ref->val; \
1150 } \
1151 zval_ptr_dtor(_zv); \
1152 ZVAL_TRUE(_zv); \
1153 } while (0)
1154
1155 #define ZEND_TRY_ASSIGN_TRUE(zv) \
1156 _ZEND_TRY_ASSIGN_TRUE(zv, 0)
1157
1158 #define ZEND_TRY_ASSIGN_REF_TRUE(zv) do { \
1159 ZEND_ASSERT(Z_ISREF_P(zv)); \
1160 _ZEND_TRY_ASSIGN_TRUE(zv, 1); \
1161 } while (0)
1162
1163 #define _ZEND_TRY_ASSIGN_BOOL(zv, bval, is_ref) do { \
1164 zval *_zv = zv; \
1165 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1166 zend_reference *ref = Z_REF_P(_zv); \
1167 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1168 zend_try_assign_typed_ref_bool(ref, 1); \
1169 break; \
1170 } \
1171 _zv = &ref->val; \
1172 } \
1173 zval_ptr_dtor(_zv); \
1174 ZVAL_BOOL(_zv, bval); \
1175 } while (0)
1176
1177 #define ZEND_TRY_ASSIGN_BOOL(zv, bval) \
1178 _ZEND_TRY_ASSIGN_BOOL(zv, bval, 0)
1179
1180 #define ZEND_TRY_ASSIGN_REF_BOOL(zv, bval) do { \
1181 ZEND_ASSERT(Z_ISREF_P(zv)); \
1182 _ZEND_TRY_ASSIGN_BOOL(zv, bval, 1); \
1183 } while (0)
1184
1185 #define _ZEND_TRY_ASSIGN_LONG(zv, lval, is_ref) do { \
1186 zval *_zv = zv; \
1187 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1188 zend_reference *ref = Z_REF_P(_zv); \
1189 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1190 zend_try_assign_typed_ref_long(ref, lval); \
1191 break; \
1192 } \
1193 _zv = &ref->val; \
1194 } \
1195 zval_ptr_dtor(_zv); \
1196 ZVAL_LONG(_zv, lval); \
1197 } while (0)
1198
1199 #define ZEND_TRY_ASSIGN_LONG(zv, lval) \
1200 _ZEND_TRY_ASSIGN_LONG(zv, lval, 0)
1201
1202 #define ZEND_TRY_ASSIGN_REF_LONG(zv, lval) do { \
1203 ZEND_ASSERT(Z_ISREF_P(zv)); \
1204 _ZEND_TRY_ASSIGN_LONG(zv, lval, 1); \
1205 } while (0)
1206
1207 #define _ZEND_TRY_ASSIGN_DOUBLE(zv, dval, is_ref) do { \
1208 zval *_zv = zv; \
1209 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1210 zend_reference *ref = Z_REF_P(_zv); \
1211 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1212 zend_try_assign_typed_ref_double(ref, dval); \
1213 break; \
1214 } \
1215 _zv = &ref->val; \
1216 } \
1217 zval_ptr_dtor(_zv); \
1218 ZVAL_DOUBLE(_zv, dval); \
1219 } while (0)
1220
1221 #define ZEND_TRY_ASSIGN_DOUBLE(zv, dval) \
1222 _ZEND_TRY_ASSIGN_DOUBLE(zv, dval, 0)
1223
1224 #define ZEND_TRY_ASSIGN_REF_DOUBLE(zv, dval) do { \
1225 ZEND_ASSERT(Z_ISREF_P(zv)); \
1226 _ZEND_TRY_ASSIGN_DOUBLE(zv, dval, 1); \
1227 } while (0)
1228
1229 #define _ZEND_TRY_ASSIGN_EMPTY_STRING(zv, is_ref) do { \
1230 zval *_zv = zv; \
1231 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1232 zend_reference *ref = Z_REF_P(_zv); \
1233 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1234 zend_try_assign_typed_ref_empty_string(ref); \
1235 break; \
1236 } \
1237 _zv = &ref->val; \
1238 } \
1239 zval_ptr_dtor(_zv); \
1240 ZVAL_EMPTY_STRING(_zv); \
1241 } while (0)
1242
1243 #define ZEND_TRY_ASSIGN_EMPTY_STRING(zv) \
1244 _ZEND_TRY_ASSIGN_EMPTY_STRING(zv, 0)
1245
1246 #define ZEND_TRY_ASSIGN_REF_EMPTY_STRING(zv) do { \
1247 ZEND_ASSERT(Z_ISREF_P(zv)); \
1248 _ZEND_TRY_ASSIGN_EMPTY_STRING(zv, 1); \
1249 } while (0)
1250
1251 #define _ZEND_TRY_ASSIGN_STR(zv, str, is_ref) do { \
1252 zval *_zv = zv; \
1253 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1254 zend_reference *ref = Z_REF_P(_zv); \
1255 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1256 zend_try_assign_typed_ref_str(ref, str); \
1257 break; \
1258 } \
1259 _zv = &ref->val; \
1260 } \
1261 zval_ptr_dtor(_zv); \
1262 ZVAL_STR(_zv, str); \
1263 } while (0)
1264
1265 #define ZEND_TRY_ASSIGN_STR(zv, str) \
1266 _ZEND_TRY_ASSIGN_STR(zv, str, 0)
1267
1268 #define ZEND_TRY_ASSIGN_REF_STR(zv, str) do { \
1269 ZEND_ASSERT(Z_ISREF_P(zv)); \
1270 _ZEND_TRY_ASSIGN_STR(zv, str, 1); \
1271 } while (0)
1272
1273 #define _ZEND_TRY_ASSIGN_NEW_STR(zv, str, is_str) do { \
1274 zval *_zv = zv; \
1275 if (is_str || UNEXPECTED(Z_ISREF_P(_zv))) { \
1276 zend_reference *ref = Z_REF_P(_zv); \
1277 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1278 zend_try_assign_typed_ref_str(ref, str); \
1279 break; \
1280 } \
1281 _zv = &ref->val; \
1282 } \
1283 zval_ptr_dtor(_zv); \
1284 ZVAL_NEW_STR(_zv, str); \
1285 } while (0)
1286
1287 #define ZEND_TRY_ASSIGN_NEW_STR(zv, str) \
1288 _ZEND_TRY_ASSIGN_NEW_STR(zv, str, 0)
1289
1290 #define ZEND_TRY_ASSIGN_REF_NEW_STR(zv, str) do { \
1291 ZEND_ASSERT(Z_ISREF_P(zv)); \
1292 _ZEND_TRY_ASSIGN_NEW_STR(zv, str, 1); \
1293 } while (0)
1294
1295 #define _ZEND_TRY_ASSIGN_STRING(zv, string, is_ref) do { \
1296 zval *_zv = zv; \
1297 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1298 zend_reference *ref = Z_REF_P(_zv); \
1299 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1300 zend_try_assign_typed_ref_string(ref, string); \
1301 break; \
1302 } \
1303 _zv = &ref->val; \
1304 } \
1305 zval_ptr_dtor(_zv); \
1306 ZVAL_STRING(_zv, string); \
1307 } while (0)
1308
1309 #define ZEND_TRY_ASSIGN_STRING(zv, string) \
1310 _ZEND_TRY_ASSIGN_STRING(zv, string, 0)
1311
1312 #define ZEND_TRY_ASSIGN_REF_STRING(zv, string) do { \
1313 ZEND_ASSERT(Z_ISREF_P(zv)); \
1314 _ZEND_TRY_ASSIGN_STRING(zv, string, 1); \
1315 } while (0)
1316
1317 #define _ZEND_TRY_ASSIGN_STRINGL(zv, string, len, is_ref) do { \
1318 zval *_zv = zv; \
1319 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1320 zend_reference *ref = Z_REF_P(_zv); \
1321 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1322 zend_try_assign_typed_ref_stringl(ref, string, len); \
1323 break; \
1324 } \
1325 _zv = &ref->val; \
1326 } \
1327 zval_ptr_dtor(_zv); \
1328 ZVAL_STRINGL(_zv, string, len); \
1329 } while (0)
1330
1331 #define ZEND_TRY_ASSIGN_STRINGL(zv, string, len) \
1332 _ZEND_TRY_ASSIGN_STRINGL(zv, string, len, 0)
1333
1334 #define ZEND_TRY_ASSIGN_REF_STRINGL(zv, string, len) do { \
1335 ZEND_ASSERT(Z_ISREF_P(zv)); \
1336 _ZEND_TRY_ASSIGN_STRINGL(zv, string, len, 1); \
1337 } while (0)
1338
1339 #define _ZEND_TRY_ASSIGN_ARR(zv, arr, is_ref) do { \
1340 zval *_zv = zv; \
1341 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1342 zend_reference *ref = Z_REF_P(_zv); \
1343 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1344 zend_try_assign_typed_ref_arr(ref, arr); \
1345 break; \
1346 } \
1347 _zv = &ref->val; \
1348 } \
1349 zval_ptr_dtor(_zv); \
1350 ZVAL_ARR(_zv, arr); \
1351 } while (0)
1352
1353 #define ZEND_TRY_ASSIGN_ARR(zv, arr) \
1354 _ZEND_TRY_ASSIGN_ARR(zv, arr, 0)
1355
1356 #define ZEND_TRY_ASSIGN_REF_ARR(zv, arr) do { \
1357 ZEND_ASSERT(Z_ISREF_P(zv)); \
1358 _ZEND_TRY_ASSIGN_ARR(zv, arr, 1); \
1359 } while (0)
1360
1361 #define _ZEND_TRY_ASSIGN_RES(zv, res, is_ref) do { \
1362 zval *_zv = zv; \
1363 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1364 zend_reference *ref = Z_REF_P(_zv); \
1365 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1366 zend_try_assign_typed_ref_res(ref, res); \
1367 break; \
1368 } \
1369 _zv = &ref->val; \
1370 } \
1371 zval_ptr_dtor(_zv); \
1372 ZVAL_RES(_zv, res); \
1373 } while (0)
1374
1375 #define ZEND_TRY_ASSIGN_RES(zv, res) \
1376 _ZEND_TRY_ASSIGN_RES(zv, res, 0)
1377
1378 #define ZEND_TRY_ASSIGN_REF_RES(zv, res) do { \
1379 ZEND_ASSERT(Z_ISREF_P(zv)); \
1380 _ZEND_TRY_ASSIGN_RES(zv, res, 1); \
1381 } while (0)
1382
1383 #define _ZEND_TRY_ASSIGN_TMP(zv, other_zv, is_ref) do { \
1384 zval *_zv = zv; \
1385 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1386 zend_reference *ref = Z_REF_P(_zv); \
1387 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1388 zend_try_assign_typed_ref(ref, other_zv); \
1389 break; \
1390 } \
1391 _zv = &ref->val; \
1392 } \
1393 zval_ptr_dtor(_zv); \
1394 ZVAL_COPY_VALUE(_zv, other_zv); \
1395 } while (0)
1396
1397 #define ZEND_TRY_ASSIGN_TMP(zv, other_zv) \
1398 _ZEND_TRY_ASSIGN_TMP(zv, other_zv, 0)
1399
1400 #define ZEND_TRY_ASSIGN_REF_TMP(zv, other_zv) do { \
1401 ZEND_ASSERT(Z_ISREF_P(zv)); \
1402 _ZEND_TRY_ASSIGN_TMP(zv, other_zv, 1); \
1403 } while (0)
1404
1405 #define _ZEND_TRY_ASSIGN_VALUE(zv, other_zv, is_ref) do { \
1406 zval *_zv = zv; \
1407 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1408 zend_reference *ref = Z_REF_P(_zv); \
1409 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1410 zend_try_assign_typed_ref_zval(ref, other_zv); \
1411 break; \
1412 } \
1413 _zv = &ref->val; \
1414 } \
1415 zval_ptr_dtor(_zv); \
1416 ZVAL_COPY_VALUE(_zv, other_zv); \
1417 } while (0)
1418
1419 #define ZEND_TRY_ASSIGN_VALUE(zv, other_zv) \
1420 _ZEND_TRY_ASSIGN_VALUE(zv, other_zv, 0)
1421
1422 #define ZEND_TRY_ASSIGN_REF_VALUE(zv, other_zv) do { \
1423 ZEND_ASSERT(Z_ISREF_P(zv)); \
1424 _ZEND_TRY_ASSIGN_VALUE(zv, other_zv, 1); \
1425 } while (0)
1426
1427 #define ZEND_TRY_ASSIGN_COPY(zv, other_zv) do { \
1428 Z_TRY_ADDREF_P(other_zv); \
1429 ZEND_TRY_ASSIGN_VALUE(zv, other_zv); \
1430 } while (0)
1431
1432 #define ZEND_TRY_ASSIGN_REF_COPY(zv, other_zv) do { \
1433 Z_TRY_ADDREF_P(other_zv); \
1434 ZEND_TRY_ASSIGN_REF_VALUE(zv, other_zv); \
1435 } while (0)
1436
1437 #define _ZEND_TRY_ASSIGN_VALUE_EX(zv, other_zv, strict, is_ref) do { \
1438 zval *_zv = zv; \
1439 if (is_ref || UNEXPECTED(Z_ISREF_P(_zv))) { \
1440 zend_reference *ref = Z_REF_P(_zv); \
1441 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) { \
1442 zend_try_assign_typed_ref_zval_ex(ref, other_zv, strict); \
1443 break; \
1444 } \
1445 _zv = &ref->val; \
1446 } \
1447 zval_ptr_dtor(_zv); \
1448 ZVAL_COPY_VALUE(_zv, other_zv); \
1449 } while (0)
1450
1451 #define ZEND_TRY_ASSIGN_VALUE_EX(zv, other_zv, strict) \
1452 _ZEND_TRY_ASSIGN_VALUE_EX(zv, other_zv, strict, 0)
1453
1454 #define ZEND_TRY_ASSIGN_REF_VALUE_EX(zv, other_zv, strict) do { \
1455 ZEND_ASSERT(Z_ISREF_P(zv)); \
1456 _ZEND_TRY_ASSIGN_VALUE_EX(zv, other_zv, strict, 1); \
1457 } while (0)
1458
1459 #define ZEND_TRY_ASSIGN_COPY_EX(zv, other_zv, strict) do { \
1460 Z_TRY_ADDREF_P(other_zv); \
1461 ZEND_TRY_ASSIGN_VALUE_EX(zv, other_zv, strict); \
1462 } while (0)
1463
1464 #define ZEND_TRY_ASSIGN_REF_COPY_EX(zv, other_zv, strict) do { \
1465 Z_TRY_ADDREF_P(other_zv); \
1466 ZEND_TRY_ASSIGN_REF_VALUE_EX(zv, other_zv, strict); \
1467 } while (0)
1468
1469 /* Initializes a reference to an empty array and returns dereferenced zval,
1470 * or NULL if the initialization failed. */
zend_try_array_init_size(zval * zv,uint32_t size)1471 static zend_always_inline zval *zend_try_array_init_size(zval *zv, uint32_t size)
1472 {
1473 zend_array *arr = zend_new_array(size);
1474
1475 if (EXPECTED(Z_ISREF_P(zv))) {
1476 zend_reference *ref = Z_REF_P(zv);
1477 if (UNEXPECTED(ZEND_REF_HAS_TYPE_SOURCES(ref))) {
1478 if (zend_try_assign_typed_ref_arr(ref, arr) == FAILURE) {
1479 return NULL;
1480 }
1481 return &ref->val;
1482 }
1483 zv = &ref->val;
1484 }
1485 zval_ptr_dtor(zv);
1486 ZVAL_ARR(zv, arr);
1487 return zv;
1488 }
1489
zend_try_array_init(zval * zv)1490 static zend_always_inline zval *zend_try_array_init(zval *zv)
1491 {
1492 return zend_try_array_init_size(zv, 0);
1493 }
1494
1495 /* Fast parameter parsing API */
1496
1497 /* Fast ZPP is always enabled now; this define is left in for compatibility
1498 * with any existing conditional compilation blocks.
1499 */
1500 #define FAST_ZPP 1
1501
1502 #define Z_EXPECTED_TYPES(_) \
1503 _(Z_EXPECTED_LONG, "of type int") \
1504 _(Z_EXPECTED_LONG_OR_NULL, "of type ?int") \
1505 _(Z_EXPECTED_BOOL, "of type bool") \
1506 _(Z_EXPECTED_BOOL_OR_NULL, "of type ?bool") \
1507 _(Z_EXPECTED_STRING, "of type string") \
1508 _(Z_EXPECTED_STRING_OR_NULL, "of type ?string") \
1509 _(Z_EXPECTED_ARRAY, "of type array") \
1510 _(Z_EXPECTED_ARRAY_OR_NULL, "of type ?array") \
1511 _(Z_EXPECTED_ARRAY_OR_LONG, "of type array|int") \
1512 _(Z_EXPECTED_ARRAY_OR_LONG_OR_NULL, "of type array|int|null") \
1513 _(Z_EXPECTED_ITERABLE, "of type Traversable|array") \
1514 _(Z_EXPECTED_ITERABLE_OR_NULL, "of type Traversable|array|null") \
1515 _(Z_EXPECTED_FUNC, "a valid callback") \
1516 _(Z_EXPECTED_FUNC_OR_NULL, "a valid callback or null") \
1517 _(Z_EXPECTED_RESOURCE, "of type resource") \
1518 _(Z_EXPECTED_RESOURCE_OR_NULL, "of type resource or null") \
1519 _(Z_EXPECTED_PATH, "of type string") \
1520 _(Z_EXPECTED_PATH_OR_NULL, "of type ?string") \
1521 _(Z_EXPECTED_OBJECT, "of type object") \
1522 _(Z_EXPECTED_OBJECT_OR_NULL, "of type ?object") \
1523 _(Z_EXPECTED_DOUBLE, "of type float") \
1524 _(Z_EXPECTED_DOUBLE_OR_NULL, "of type ?float") \
1525 _(Z_EXPECTED_NUMBER, "of type int|float") \
1526 _(Z_EXPECTED_NUMBER_OR_NULL, "of type int|float|null") \
1527 _(Z_EXPECTED_NUMBER_OR_STRING, "of type string|int|float") \
1528 _(Z_EXPECTED_NUMBER_OR_STRING_OR_NULL, "of type string|int|float|null") \
1529 _(Z_EXPECTED_ARRAY_OR_STRING, "of type array|string") \
1530 _(Z_EXPECTED_ARRAY_OR_STRING_OR_NULL, "of type array|string|null") \
1531 _(Z_EXPECTED_STRING_OR_LONG, "of type string|int") \
1532 _(Z_EXPECTED_STRING_OR_LONG_OR_NULL, "of type string|int|null") \
1533 _(Z_EXPECTED_OBJECT_OR_CLASS_NAME, "an object or a valid class name") \
1534 _(Z_EXPECTED_OBJECT_OR_CLASS_NAME_OR_NULL, "an object, a valid class name, or null") \
1535 _(Z_EXPECTED_OBJECT_OR_STRING, "of type object|string") \
1536 _(Z_EXPECTED_OBJECT_OR_STRING_OR_NULL, "of type object|string|null") \
1537
1538 #define Z_EXPECTED_TYPE
1539
1540 #define Z_EXPECTED_TYPE_ENUM(id, str) id,
1541 #define Z_EXPECTED_TYPE_STR(id, str) str,
1542
1543 typedef enum _zend_expected_type {
1544 Z_EXPECTED_TYPES(Z_EXPECTED_TYPE_ENUM)
1545 Z_EXPECTED_LAST
1546 } zend_expected_type;
1547
1548 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameters_none_error(void);
1549 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameters_count_error(uint32_t min_num_args, uint32_t max_num_args);
1550 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_error(int error_code, uint32_t num, char *name, zend_expected_type expected_type, zval *arg);
1551 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_type_error(uint32_t num, zend_expected_type expected_type, zval *arg);
1552 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_error(uint32_t num, const char *name, zval *arg);
1553 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_or_null_error(uint32_t num, const char *name, zval *arg);
1554 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_or_long_error(uint32_t num, const char *name, zval *arg);
1555 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_or_long_or_null_error(uint32_t num, const char *name, zval *arg);
1556 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_or_string_error(uint32_t num, const char *name, zval *arg);
1557 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_or_string_or_null_error(uint32_t num, const char *name, zval *arg);
1558 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_error(uint32_t num, char *error);
1559 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_or_null_error(uint32_t num, char *error);
1560 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_unexpected_extra_named_error(void);
1561 ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(zend_class_entry *error_ce, uint32_t arg_num, const char *format, va_list va);
1562 ZEND_API ZEND_COLD void zend_argument_error(zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...);
1563 ZEND_API ZEND_COLD void zend_argument_type_error(uint32_t arg_num, const char *format, ...);
1564 ZEND_API ZEND_COLD void zend_argument_value_error(uint32_t arg_num, const char *format, ...);
1565
1566 #define ZPP_ERROR_OK 0
1567 #define ZPP_ERROR_FAILURE 1
1568 #define ZPP_ERROR_WRONG_CALLBACK 2
1569 #define ZPP_ERROR_WRONG_CLASS 3
1570 #define ZPP_ERROR_WRONG_CLASS_OR_NULL 4
1571 #define ZPP_ERROR_WRONG_CLASS_OR_STRING 5
1572 #define ZPP_ERROR_WRONG_CLASS_OR_STRING_OR_NULL 6
1573 #define ZPP_ERROR_WRONG_CLASS_OR_LONG 7
1574 #define ZPP_ERROR_WRONG_CLASS_OR_LONG_OR_NULL 8
1575 #define ZPP_ERROR_WRONG_ARG 9
1576 #define ZPP_ERROR_WRONG_COUNT 10
1577 #define ZPP_ERROR_UNEXPECTED_EXTRA_NAMED 11
1578 #define ZPP_ERROR_WRONG_CALLBACK_OR_NULL 12
1579
1580 #define ZEND_PARSE_PARAMETERS_START_EX(flags, min_num_args, max_num_args) do { \
1581 const int _flags = (flags); \
1582 uint32_t _min_num_args = (min_num_args); \
1583 uint32_t _max_num_args = (uint32_t) (max_num_args); \
1584 uint32_t _num_args = EX_NUM_ARGS(); \
1585 uint32_t _i = 0; \
1586 zval *_real_arg, *_arg = NULL; \
1587 zend_expected_type _expected_type = Z_EXPECTED_LONG; \
1588 char *_error = NULL; \
1589 bool _dummy = 0; \
1590 bool _optional = 0; \
1591 int _error_code = ZPP_ERROR_OK; \
1592 ((void)_i); \
1593 ((void)_real_arg); \
1594 ((void)_arg); \
1595 ((void)_expected_type); \
1596 ((void)_error); \
1597 ((void)_optional); \
1598 ((void)_dummy); \
1599 \
1600 do { \
1601 if (UNEXPECTED(_num_args < _min_num_args) || \
1602 UNEXPECTED(_num_args > _max_num_args)) { \
1603 if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
1604 zend_wrong_parameters_count_error(_min_num_args, _max_num_args); \
1605 } \
1606 _error_code = ZPP_ERROR_FAILURE; \
1607 break; \
1608 } \
1609 _real_arg = ZEND_CALL_ARG(execute_data, 0);
1610
1611 #define ZEND_PARSE_PARAMETERS_START(min_num_args, max_num_args) \
1612 ZEND_PARSE_PARAMETERS_START_EX(0, min_num_args, max_num_args)
1613
1614 #define ZEND_PARSE_PARAMETERS_NONE() do { \
1615 if (UNEXPECTED(ZEND_NUM_ARGS() != 0)) { \
1616 zend_wrong_parameters_none_error(); \
1617 return; \
1618 } \
1619 } while (0)
1620
1621 #define ZEND_PARSE_PARAMETERS_END_EX(failure) \
1622 ZEND_ASSERT(_i == _max_num_args || _max_num_args == (uint32_t) -1); \
1623 } while (0); \
1624 if (UNEXPECTED(_error_code != ZPP_ERROR_OK)) { \
1625 if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
1626 zend_wrong_parameter_error(_error_code, _i, _error, _expected_type, _arg); \
1627 } \
1628 failure; \
1629 } \
1630 } while (0)
1631
1632 #define ZEND_PARSE_PARAMETERS_END() \
1633 ZEND_PARSE_PARAMETERS_END_EX(return)
1634
1635 #define Z_PARAM_PROLOGUE(deref, separate) \
1636 ++_i; \
1637 ZEND_ASSERT(_i <= _min_num_args || _optional==1); \
1638 ZEND_ASSERT(_i > _min_num_args || _optional==0); \
1639 if (_optional) { \
1640 if (UNEXPECTED(_i >_num_args)) break; \
1641 } \
1642 _real_arg++; \
1643 _arg = _real_arg; \
1644 if (deref) { \
1645 if (EXPECTED(Z_ISREF_P(_arg))) { \
1646 _arg = Z_REFVAL_P(_arg); \
1647 } \
1648 } \
1649 if (separate) { \
1650 SEPARATE_ZVAL_NOREF(_arg); \
1651 }
1652
1653 /* get the zval* for a previously parsed argument */
1654 #define Z_PARAM_GET_PREV_ZVAL(dest) \
1655 zend_parse_arg_zval_deref(_arg, &dest, 0);
1656
1657 /* old "|" */
1658 #define Z_PARAM_OPTIONAL \
1659 _optional = 1;
1660
1661 /* old "a" */
1662 #define Z_PARAM_ARRAY_EX2(dest, check_null, deref, separate) \
1663 Z_PARAM_PROLOGUE(deref, separate); \
1664 if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 0))) { \
1665 _expected_type = check_null ? Z_EXPECTED_ARRAY_OR_NULL : Z_EXPECTED_ARRAY; \
1666 _error_code = ZPP_ERROR_WRONG_ARG; \
1667 break; \
1668 }
1669
1670 #define Z_PARAM_ARRAY_EX(dest, check_null, separate) \
1671 Z_PARAM_ARRAY_EX2(dest, check_null, separate, separate)
1672
1673 #define Z_PARAM_ARRAY(dest) \
1674 Z_PARAM_ARRAY_EX(dest, 0, 0)
1675
1676 #define Z_PARAM_ARRAY_OR_NULL(dest) \
1677 Z_PARAM_ARRAY_EX(dest, 1, 0)
1678
1679 /* old "A" */
1680 #define Z_PARAM_ARRAY_OR_OBJECT_EX2(dest, check_null, deref, separate) \
1681 Z_PARAM_PROLOGUE(deref, separate); \
1682 if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 1))) { \
1683 _expected_type = check_null ? Z_EXPECTED_ARRAY_OR_NULL : Z_EXPECTED_ARRAY; \
1684 _error_code = ZPP_ERROR_WRONG_ARG; \
1685 break; \
1686 }
1687
1688 #define Z_PARAM_ARRAY_OR_OBJECT_EX(dest, check_null, separate) \
1689 Z_PARAM_ARRAY_OR_OBJECT_EX2(dest, check_null, separate, separate)
1690
1691 #define Z_PARAM_ARRAY_OR_OBJECT(dest) \
1692 Z_PARAM_ARRAY_OR_OBJECT_EX(dest, 0, 0)
1693
1694 #define Z_PARAM_ITERABLE_EX(dest, check_null) \
1695 Z_PARAM_PROLOGUE(0, 0); \
1696 if (UNEXPECTED(!zend_parse_arg_iterable(_arg, &dest, check_null))) { \
1697 _expected_type = check_null ? Z_EXPECTED_ITERABLE_OR_NULL : Z_EXPECTED_ITERABLE; \
1698 _error_code = ZPP_ERROR_WRONG_ARG; \
1699 break; \
1700 }
1701
1702 #define Z_PARAM_ITERABLE(dest) \
1703 Z_PARAM_ITERABLE_EX(dest, 0)
1704
1705 #define Z_PARAM_ITERABLE_OR_NULL(dest) \
1706 Z_PARAM_ITERABLE_EX(dest, 1)
1707
1708 /* old "b" */
1709 #define Z_PARAM_BOOL_EX(dest, is_null, check_null, deref) \
1710 Z_PARAM_PROLOGUE(deref, 0); \
1711 if (UNEXPECTED(!zend_parse_arg_bool(_arg, &dest, &is_null, check_null, _i))) { \
1712 _expected_type = check_null ? Z_EXPECTED_BOOL_OR_NULL : Z_EXPECTED_BOOL; \
1713 _error_code = ZPP_ERROR_WRONG_ARG; \
1714 break; \
1715 }
1716
1717 #define Z_PARAM_BOOL(dest) \
1718 Z_PARAM_BOOL_EX(dest, _dummy, 0, 0)
1719
1720 #define Z_PARAM_BOOL_OR_NULL(dest, is_null) \
1721 Z_PARAM_BOOL_EX(dest, is_null, 1, 0)
1722
1723 /* old "C" */
1724 #define Z_PARAM_CLASS_EX(dest, check_null, deref) \
1725 Z_PARAM_PROLOGUE(deref, 0); \
1726 if (UNEXPECTED(!zend_parse_arg_class(_arg, &dest, _i, check_null))) { \
1727 _error_code = ZPP_ERROR_FAILURE; \
1728 break; \
1729 }
1730
1731 #define Z_PARAM_CLASS(dest) \
1732 Z_PARAM_CLASS_EX(dest, 0, 0)
1733
1734 #define Z_PARAM_CLASS_OR_NULL(dest) \
1735 Z_PARAM_CLASS_EX(dest, 1, 0)
1736
1737 #define Z_PARAM_OBJ_OR_CLASS_NAME_EX(dest, allow_null) \
1738 Z_PARAM_PROLOGUE(0, 0); \
1739 if (UNEXPECTED(!zend_parse_arg_obj_or_class_name(_arg, &dest, allow_null))) { \
1740 _expected_type = allow_null ? Z_EXPECTED_OBJECT_OR_CLASS_NAME_OR_NULL : Z_EXPECTED_OBJECT_OR_CLASS_NAME; \
1741 _error_code = ZPP_ERROR_WRONG_ARG; \
1742 break; \
1743 }
1744
1745 #define Z_PARAM_OBJ_OR_CLASS_NAME(dest) \
1746 Z_PARAM_OBJ_OR_CLASS_NAME_EX(dest, 0);
1747
1748 #define Z_PARAM_OBJ_OR_CLASS_NAME_OR_NULL(dest) \
1749 Z_PARAM_OBJ_OR_CLASS_NAME_EX(dest, 1);
1750
1751 #define Z_PARAM_OBJ_OR_STR_EX(destination_object, destination_string, allow_null) \
1752 Z_PARAM_PROLOGUE(0, 0); \
1753 if (UNEXPECTED(!zend_parse_arg_obj_or_str(_arg, &destination_object, NULL, &destination_string, allow_null, _i))) { \
1754 _expected_type = allow_null ? Z_EXPECTED_OBJECT_OR_STRING_OR_NULL : Z_EXPECTED_OBJECT_OR_STRING; \
1755 _error_code = ZPP_ERROR_WRONG_ARG; \
1756 break; \
1757 }
1758
1759 #define Z_PARAM_OBJ_OR_STR(destination_object, destination_string) \
1760 Z_PARAM_OBJ_OR_STR_EX(destination_object, destination_string, 0);
1761
1762 #define Z_PARAM_OBJ_OR_STR_OR_NULL(destination_object, destination_string) \
1763 Z_PARAM_OBJ_OR_STR_EX(destination_object, destination_string, 1);
1764
1765 #define Z_PARAM_OBJ_OF_CLASS_OR_STR_EX(destination_object, base_ce, destination_string, allow_null) \
1766 Z_PARAM_PROLOGUE(0, 0); \
1767 if (UNEXPECTED(!zend_parse_arg_obj_or_str(_arg, &destination_object, base_ce, &destination_string, allow_null, _i))) { \
1768 if (base_ce) { \
1769 _error = ZSTR_VAL((base_ce)->name); \
1770 _error_code = allow_null ? ZPP_ERROR_WRONG_CLASS_OR_STRING_OR_NULL : ZPP_ERROR_WRONG_CLASS_OR_STRING; \
1771 break; \
1772 } else { \
1773 _expected_type = allow_null ? Z_EXPECTED_OBJECT_OR_STRING_OR_NULL : Z_EXPECTED_OBJECT_OR_STRING; \
1774 _error_code = ZPP_ERROR_WRONG_ARG; \
1775 break; \
1776 } \
1777 }
1778
1779 #define Z_PARAM_OBJ_OF_CLASS_OR_STR(destination_object, base_ce, destination_string) \
1780 Z_PARAM_OBJ_OF_CLASS_OR_STR_EX(destination_object, base_ce, destination_string, 0);
1781
1782 #define Z_PARAM_OBJ_OF_CLASS_OR_STR_OR_NULL(destination_object, base_ce, destination_string) \
1783 Z_PARAM_OBJ_OF_CLASS_OR_STR_EX(destination_object, base_ce, destination_string, 1);
1784
1785 /* old "d" */
1786 #define Z_PARAM_DOUBLE_EX(dest, is_null, check_null, deref) \
1787 Z_PARAM_PROLOGUE(deref, 0); \
1788 if (UNEXPECTED(!zend_parse_arg_double(_arg, &dest, &is_null, check_null, _i))) { \
1789 _expected_type = check_null ? Z_EXPECTED_DOUBLE_OR_NULL : Z_EXPECTED_DOUBLE; \
1790 _error_code = ZPP_ERROR_WRONG_ARG; \
1791 break; \
1792 }
1793
1794 #define Z_PARAM_DOUBLE(dest) \
1795 Z_PARAM_DOUBLE_EX(dest, _dummy, 0, 0)
1796
1797 #define Z_PARAM_DOUBLE_OR_NULL(dest, is_null) \
1798 Z_PARAM_DOUBLE_EX(dest, is_null, 1, 0)
1799
1800 /* old "f" */
1801 #define Z_PARAM_FUNC_EX2(dest_fci, dest_fcc, check_null, deref, free_trampoline) \
1802 Z_PARAM_PROLOGUE(deref, 0); \
1803 if (UNEXPECTED(!zend_parse_arg_func(_arg, &dest_fci, &dest_fcc, check_null, &_error, free_trampoline))) { \
1804 if (!_error) { \
1805 _expected_type = check_null ? Z_EXPECTED_FUNC_OR_NULL : Z_EXPECTED_FUNC; \
1806 _error_code = ZPP_ERROR_WRONG_ARG; \
1807 } else { \
1808 _error_code = check_null ? ZPP_ERROR_WRONG_CALLBACK_OR_NULL : ZPP_ERROR_WRONG_CALLBACK; \
1809 } \
1810 break; \
1811 } \
1812
1813 #define Z_PARAM_FUNC_EX(dest_fci, dest_fcc, check_null, deref) Z_PARAM_FUNC_EX2(dest_fci, dest_fcc, check_null, deref, true)
1814
1815 #define Z_PARAM_FUNC(dest_fci, dest_fcc) \
1816 Z_PARAM_FUNC_EX2(dest_fci, dest_fcc, 0, 0, true)
1817
1818 #define Z_PARAM_FUNC_NO_TRAMPOLINE_FREE(dest_fci, dest_fcc) \
1819 Z_PARAM_FUNC_EX2(dest_fci, dest_fcc, 0, 0, false)
1820
1821 #define Z_PARAM_FUNC_OR_NULL(dest_fci, dest_fcc) \
1822 Z_PARAM_FUNC_EX2(dest_fci, dest_fcc, 1, 0, true)
1823
1824 #define Z_PARAM_FUNC_NO_TRAMPOLINE_FREE_OR_NULL(dest_fci, dest_fcc) \
1825 Z_PARAM_FUNC_EX2(dest_fci, dest_fcc, 1, 0, false)
1826
1827 #define Z_PARAM_FUNC_OR_NULL_WITH_ZVAL(dest_fci, dest_fcc, dest_zp) \
1828 Z_PARAM_FUNC_EX2(dest_fci, dest_fcc, 1, 0, true) \
1829 Z_PARAM_GET_PREV_ZVAL(dest_zp)
1830
1831 /* old "h" */
1832 #define Z_PARAM_ARRAY_HT_EX2(dest, check_null, deref, separate) \
1833 Z_PARAM_PROLOGUE(deref, separate); \
1834 if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 0, separate))) { \
1835 _expected_type = check_null ? Z_EXPECTED_ARRAY_OR_NULL : Z_EXPECTED_ARRAY; \
1836 _error_code = ZPP_ERROR_WRONG_ARG; \
1837 break; \
1838 }
1839
1840 #define Z_PARAM_ARRAY_HT_EX(dest, check_null, separate) \
1841 Z_PARAM_ARRAY_HT_EX2(dest, check_null, separate, separate)
1842
1843 #define Z_PARAM_ARRAY_HT(dest) \
1844 Z_PARAM_ARRAY_HT_EX(dest, 0, 0)
1845
1846 #define Z_PARAM_ARRAY_HT_OR_NULL(dest) \
1847 Z_PARAM_ARRAY_HT_EX(dest, 1, 0)
1848
1849 #define Z_PARAM_ARRAY_HT_OR_LONG_EX(dest_ht, dest_long, is_null, allow_null) \
1850 Z_PARAM_PROLOGUE(0, 0); \
1851 if (UNEXPECTED(!zend_parse_arg_array_ht_or_long(_arg, &dest_ht, &dest_long, &is_null, allow_null, _i))) { \
1852 _expected_type = allow_null ? Z_EXPECTED_ARRAY_OR_LONG_OR_NULL : Z_EXPECTED_ARRAY_OR_LONG; \
1853 _error_code = ZPP_ERROR_WRONG_ARG; \
1854 break; \
1855 }
1856
1857 #define Z_PARAM_ARRAY_HT_OR_LONG(dest_ht, dest_long) \
1858 Z_PARAM_ARRAY_HT_OR_LONG_EX(dest_ht, dest_long, _dummy, 0)
1859
1860 #define Z_PARAM_ARRAY_HT_OR_LONG_OR_NULL(dest_ht, dest_long, is_null) \
1861 Z_PARAM_ARRAY_HT_OR_LONG_EX(dest_ht, dest_long, is_null, 1)
1862
1863 /* old "H" */
1864 #define Z_PARAM_ARRAY_OR_OBJECT_HT_EX2(dest, check_null, deref, separate) \
1865 Z_PARAM_PROLOGUE(deref, separate); \
1866 if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 1, separate))) { \
1867 _expected_type = check_null ? Z_EXPECTED_ARRAY_OR_NULL : Z_EXPECTED_ARRAY; \
1868 _error_code = ZPP_ERROR_WRONG_ARG; \
1869 break; \
1870 }
1871
1872 #define Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, check_null, separate) \
1873 Z_PARAM_ARRAY_OR_OBJECT_HT_EX2(dest, check_null, separate, separate)
1874
1875 #define Z_PARAM_ARRAY_OR_OBJECT_HT(dest) \
1876 Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, 0, 0)
1877
1878 /* old "l" */
1879 #define Z_PARAM_LONG_EX(dest, is_null, check_null, deref) \
1880 Z_PARAM_PROLOGUE(deref, 0); \
1881 if (UNEXPECTED(!zend_parse_arg_long(_arg, &dest, &is_null, check_null, _i))) { \
1882 _expected_type = check_null ? Z_EXPECTED_LONG_OR_NULL : Z_EXPECTED_LONG; \
1883 _error_code = ZPP_ERROR_WRONG_ARG; \
1884 break; \
1885 }
1886
1887 #define Z_PARAM_LONG(dest) \
1888 Z_PARAM_LONG_EX(dest, _dummy, 0, 0)
1889
1890 #define Z_PARAM_LONG_OR_NULL(dest, is_null) \
1891 Z_PARAM_LONG_EX(dest, is_null, 1, 0)
1892
1893 /* old "n" */
1894 #define Z_PARAM_NUMBER_EX(dest, check_null) \
1895 Z_PARAM_PROLOGUE(0, 0); \
1896 if (UNEXPECTED(!zend_parse_arg_number(_arg, &dest, check_null, _i))) { \
1897 _expected_type = check_null ? Z_EXPECTED_NUMBER_OR_NULL : Z_EXPECTED_NUMBER; \
1898 _error_code = ZPP_ERROR_WRONG_ARG; \
1899 break; \
1900 }
1901
1902 #define Z_PARAM_NUMBER_OR_NULL(dest) \
1903 Z_PARAM_NUMBER_EX(dest, 1)
1904
1905 #define Z_PARAM_NUMBER(dest) \
1906 Z_PARAM_NUMBER_EX(dest, 0)
1907
1908 #define Z_PARAM_NUMBER_OR_STR_EX(dest, check_null) \
1909 Z_PARAM_PROLOGUE(0, 0); \
1910 if (UNEXPECTED(!zend_parse_arg_number_or_str(_arg, &dest, check_null, _i))) { \
1911 _expected_type = check_null ? Z_EXPECTED_NUMBER_OR_STRING_OR_NULL : Z_EXPECTED_NUMBER_OR_STRING; \
1912 _error_code = ZPP_ERROR_WRONG_ARG; \
1913 break; \
1914 }
1915
1916 #define Z_PARAM_NUMBER_OR_STR(dest) \
1917 Z_PARAM_NUMBER_OR_STR_EX(dest, false)
1918
1919 #define Z_PARAM_NUMBER_OR_STR_OR_NULL(dest) \
1920 Z_PARAM_NUMBER_OR_STR_EX(dest, true)
1921
1922 /* old "o" */
1923 #define Z_PARAM_OBJECT_EX(dest, check_null, deref) \
1924 Z_PARAM_PROLOGUE(deref, 0); \
1925 if (UNEXPECTED(!zend_parse_arg_object(_arg, &dest, NULL, check_null))) { \
1926 _expected_type = check_null ? Z_EXPECTED_OBJECT_OR_NULL : Z_EXPECTED_OBJECT; \
1927 _error_code = ZPP_ERROR_WRONG_ARG; \
1928 break; \
1929 }
1930
1931 #define Z_PARAM_OBJECT(dest) \
1932 Z_PARAM_OBJECT_EX(dest, 0, 0)
1933
1934 #define Z_PARAM_OBJECT_OR_NULL(dest) \
1935 Z_PARAM_OBJECT_EX(dest, 1, 0)
1936
1937 /* The same as Z_PARAM_OBJECT_EX except that dest is a zend_object rather than a zval */
1938 #define Z_PARAM_OBJ_EX(dest, check_null, deref) \
1939 Z_PARAM_PROLOGUE(deref, 0); \
1940 if (UNEXPECTED(!zend_parse_arg_obj(_arg, &dest, NULL, check_null))) { \
1941 _expected_type = check_null ? Z_EXPECTED_OBJECT_OR_NULL : Z_EXPECTED_OBJECT; \
1942 _error_code = ZPP_ERROR_WRONG_ARG; \
1943 break; \
1944 }
1945
1946 #define Z_PARAM_OBJ(dest) \
1947 Z_PARAM_OBJ_EX(dest, 0, 0)
1948
1949 #define Z_PARAM_OBJ_OR_NULL(dest) \
1950 Z_PARAM_OBJ_EX(dest, 1, 0)
1951
1952 /* old "O" */
1953 #define Z_PARAM_OBJECT_OF_CLASS_EX(dest, _ce, check_null, deref) \
1954 Z_PARAM_PROLOGUE(deref, 0); \
1955 if (UNEXPECTED(!zend_parse_arg_object(_arg, &dest, _ce, check_null))) { \
1956 if (_ce) { \
1957 _error = ZSTR_VAL((_ce)->name); \
1958 _error_code = check_null ? ZPP_ERROR_WRONG_CLASS_OR_NULL : ZPP_ERROR_WRONG_CLASS; \
1959 break; \
1960 } else { \
1961 _expected_type = check_null ? Z_EXPECTED_OBJECT_OR_NULL : Z_EXPECTED_OBJECT; \
1962 _error_code = ZPP_ERROR_WRONG_ARG; \
1963 break; \
1964 } \
1965 }
1966
1967 #define Z_PARAM_OBJECT_OF_CLASS(dest, _ce) \
1968 Z_PARAM_OBJECT_OF_CLASS_EX(dest, _ce, 0, 0)
1969
1970 #define Z_PARAM_OBJECT_OF_CLASS_OR_NULL(dest, _ce) \
1971 Z_PARAM_OBJECT_OF_CLASS_EX(dest, _ce, 1, 0)
1972
1973 /* The same as Z_PARAM_OBJECT_OF_CLASS_EX except that dest is a zend_object rather than a zval */
1974 #define Z_PARAM_OBJ_OF_CLASS_EX(dest, _ce, check_null, deref) \
1975 Z_PARAM_PROLOGUE(deref, 0); \
1976 if (UNEXPECTED(!zend_parse_arg_obj(_arg, &dest, _ce, check_null))) { \
1977 if (_ce) { \
1978 _error = ZSTR_VAL((_ce)->name); \
1979 _error_code = check_null ? ZPP_ERROR_WRONG_CLASS_OR_NULL : ZPP_ERROR_WRONG_CLASS; \
1980 break; \
1981 } else { \
1982 _expected_type = check_null ? Z_EXPECTED_OBJECT_OR_NULL : Z_EXPECTED_OBJECT; \
1983 _error_code = ZPP_ERROR_WRONG_ARG; \
1984 break; \
1985 } \
1986 }
1987
1988 #define Z_PARAM_OBJ_OF_CLASS(dest, _ce) \
1989 Z_PARAM_OBJ_OF_CLASS_EX(dest, _ce, 0, 0)
1990
1991 #define Z_PARAM_OBJ_OF_CLASS_OR_NULL(dest, _ce) \
1992 Z_PARAM_OBJ_OF_CLASS_EX(dest, _ce, 1, 0)
1993
1994 #define Z_PARAM_OBJ_OF_CLASS_OR_LONG_EX(dest_obj, _ce, dest_long, is_null, allow_null) \
1995 Z_PARAM_PROLOGUE(0, 0); \
1996 if (UNEXPECTED(!zend_parse_arg_obj_or_long(_arg, &dest_obj, _ce, &dest_long, &is_null, allow_null, _i))) { \
1997 _error = ZSTR_VAL((_ce)->name); \
1998 _error_code = allow_null ? ZPP_ERROR_WRONG_CLASS_OR_LONG_OR_NULL : ZPP_ERROR_WRONG_CLASS_OR_LONG; \
1999 break; \
2000 }
2001
2002 #define Z_PARAM_OBJ_OF_CLASS_OR_LONG(dest_obj, _ce, dest_long) \
2003 Z_PARAM_OBJ_OF_CLASS_OR_LONG_EX(dest_obj, _ce, dest_long, _dummy, 0)
2004
2005 #define Z_PARAM_OBJ_OF_CLASS_OR_LONG_OR_NULL(dest_obj, _ce, dest_long, is_null) \
2006 Z_PARAM_OBJ_OF_CLASS_OR_LONG_EX(dest_obj, _ce, dest_long, is_null, 1)
2007
2008 /* old "p" */
2009 #define Z_PARAM_PATH_EX(dest, dest_len, check_null, deref) \
2010 Z_PARAM_PROLOGUE(deref, 0); \
2011 if (UNEXPECTED(!zend_parse_arg_path(_arg, &dest, &dest_len, check_null, _i))) { \
2012 _expected_type = check_null ? Z_EXPECTED_PATH_OR_NULL : Z_EXPECTED_PATH; \
2013 _error_code = ZPP_ERROR_WRONG_ARG; \
2014 break; \
2015 }
2016
2017 #define Z_PARAM_PATH(dest, dest_len) \
2018 Z_PARAM_PATH_EX(dest, dest_len, 0, 0)
2019
2020 #define Z_PARAM_PATH_OR_NULL(dest, dest_len) \
2021 Z_PARAM_PATH_EX(dest, dest_len, 1, 0)
2022
2023 /* old "P" */
2024 #define Z_PARAM_PATH_STR_EX(dest, check_null, deref) \
2025 Z_PARAM_PROLOGUE(deref, 0); \
2026 if (UNEXPECTED(!zend_parse_arg_path_str(_arg, &dest, check_null, _i))) { \
2027 _expected_type = check_null ? Z_EXPECTED_PATH_OR_NULL : Z_EXPECTED_PATH; \
2028 _error_code = ZPP_ERROR_WRONG_ARG; \
2029 break; \
2030 }
2031
2032 #define Z_PARAM_PATH_STR(dest) \
2033 Z_PARAM_PATH_STR_EX(dest, 0, 0)
2034
2035 #define Z_PARAM_PATH_STR_OR_NULL(dest) \
2036 Z_PARAM_PATH_STR_EX(dest, 1, 0)
2037
2038 /* old "r" */
2039 #define Z_PARAM_RESOURCE_EX(dest, check_null, deref) \
2040 Z_PARAM_PROLOGUE(deref, 0); \
2041 if (UNEXPECTED(!zend_parse_arg_resource(_arg, &dest, check_null))) { \
2042 _expected_type = check_null ? Z_EXPECTED_RESOURCE_OR_NULL : Z_EXPECTED_RESOURCE; \
2043 _error_code = ZPP_ERROR_WRONG_ARG; \
2044 break; \
2045 }
2046
2047 #define Z_PARAM_RESOURCE(dest) \
2048 Z_PARAM_RESOURCE_EX(dest, 0, 0)
2049
2050 #define Z_PARAM_RESOURCE_OR_NULL(dest) \
2051 Z_PARAM_RESOURCE_EX(dest, 1, 0)
2052
2053 /* old "s" */
2054 #define Z_PARAM_STRING_EX(dest, dest_len, check_null, deref) \
2055 Z_PARAM_PROLOGUE(deref, 0); \
2056 if (UNEXPECTED(!zend_parse_arg_string(_arg, &dest, &dest_len, check_null, _i))) { \
2057 _expected_type = check_null ? Z_EXPECTED_STRING_OR_NULL : Z_EXPECTED_STRING; \
2058 _error_code = ZPP_ERROR_WRONG_ARG; \
2059 break; \
2060 }
2061
2062 #define Z_PARAM_STRING(dest, dest_len) \
2063 Z_PARAM_STRING_EX(dest, dest_len, 0, 0)
2064
2065 #define Z_PARAM_STRING_OR_NULL(dest, dest_len) \
2066 Z_PARAM_STRING_EX(dest, dest_len, 1, 0)
2067
2068 /* old "S" */
2069 #define Z_PARAM_STR_EX(dest, check_null, deref) \
2070 Z_PARAM_PROLOGUE(deref, 0); \
2071 if (UNEXPECTED(!zend_parse_arg_str(_arg, &dest, check_null, _i))) { \
2072 _expected_type = check_null ? Z_EXPECTED_STRING_OR_NULL : Z_EXPECTED_STRING; \
2073 _error_code = ZPP_ERROR_WRONG_ARG; \
2074 break; \
2075 }
2076
2077 #define Z_PARAM_STR(dest) \
2078 Z_PARAM_STR_EX(dest, 0, 0)
2079
2080 #define Z_PARAM_STR_OR_NULL(dest) \
2081 Z_PARAM_STR_EX(dest, 1, 0)
2082
2083 /* old "z" */
2084 #define Z_PARAM_ZVAL_EX2(dest, check_null, deref, separate) \
2085 Z_PARAM_PROLOGUE(deref, separate); \
2086 zend_parse_arg_zval_deref(_arg, &dest, check_null);
2087
2088 #define Z_PARAM_ZVAL_EX(dest, check_null, separate) \
2089 Z_PARAM_ZVAL_EX2(dest, check_null, separate, separate)
2090
2091 #define Z_PARAM_ZVAL(dest) \
2092 Z_PARAM_ZVAL_EX(dest, 0, 0)
2093
2094 #define Z_PARAM_ZVAL_OR_NULL(dest) \
2095 Z_PARAM_ZVAL_EX(dest, 1, 0)
2096
2097 /* old "+" and "*" */
2098 #define Z_PARAM_VARIADIC_EX(spec, dest, dest_num, post_varargs) do { \
2099 uint32_t _num_varargs = _num_args - _i - (post_varargs); \
2100 if (EXPECTED(_num_varargs > 0)) { \
2101 dest = _real_arg + 1; \
2102 dest_num = _num_varargs; \
2103 _i += _num_varargs; \
2104 _real_arg += _num_varargs; \
2105 } else { \
2106 dest = NULL; \
2107 dest_num = 0; \
2108 } \
2109 if (UNEXPECTED(ZEND_CALL_INFO(execute_data) & ZEND_CALL_HAS_EXTRA_NAMED_PARAMS)) { \
2110 _error_code = ZPP_ERROR_UNEXPECTED_EXTRA_NAMED; \
2111 break; \
2112 } \
2113 } while (0);
2114
2115 #define Z_PARAM_VARIADIC(spec, dest, dest_num) \
2116 Z_PARAM_VARIADIC_EX(spec, dest, dest_num, 0)
2117
2118 #define Z_PARAM_VARIADIC_WITH_NAMED(dest, dest_num, dest_named) do { \
2119 uint32_t _num_varargs = _num_args - _i; \
2120 if (EXPECTED(_num_varargs > 0)) { \
2121 dest = _real_arg + 1; \
2122 dest_num = _num_varargs; \
2123 } else { \
2124 dest = NULL; \
2125 dest_num = 0; \
2126 } \
2127 if (ZEND_CALL_INFO(execute_data) & ZEND_CALL_HAS_EXTRA_NAMED_PARAMS) { \
2128 dest_named = execute_data->extra_named_params; \
2129 } else { \
2130 dest_named = NULL; \
2131 } \
2132 } while (0);
2133
2134 #define Z_PARAM_ARRAY_HT_OR_STR_EX(dest_ht, dest_str, allow_null) \
2135 Z_PARAM_PROLOGUE(0, 0); \
2136 if (UNEXPECTED(!zend_parse_arg_array_ht_or_str(_arg, &dest_ht, &dest_str, allow_null, _i))) { \
2137 _expected_type = allow_null ? Z_EXPECTED_ARRAY_OR_STRING_OR_NULL : Z_EXPECTED_ARRAY_OR_STRING; \
2138 _error_code = ZPP_ERROR_WRONG_ARG; \
2139 break; \
2140 }
2141
2142 #define Z_PARAM_ARRAY_HT_OR_STR(dest_ht, dest_str) \
2143 Z_PARAM_ARRAY_HT_OR_STR_EX(dest_ht, dest_str, 0);
2144
2145 #define Z_PARAM_ARRAY_HT_OR_STR_OR_NULL(dest_ht, dest_str) \
2146 Z_PARAM_ARRAY_HT_OR_STR_EX(dest_ht, dest_str, 1);
2147
2148 #define Z_PARAM_STR_OR_LONG_EX(dest_str, dest_long, is_null, allow_null) \
2149 Z_PARAM_PROLOGUE(0, 0); \
2150 if (UNEXPECTED(!zend_parse_arg_str_or_long(_arg, &dest_str, &dest_long, &is_null, allow_null, _i))) { \
2151 _expected_type = allow_null ? Z_EXPECTED_STRING_OR_LONG_OR_NULL : Z_EXPECTED_STRING_OR_LONG; \
2152 _error_code = ZPP_ERROR_WRONG_ARG; \
2153 break; \
2154 }
2155
2156 #define Z_PARAM_STR_OR_LONG(dest_str, dest_long) \
2157 Z_PARAM_STR_OR_LONG_EX(dest_str, dest_long, _dummy, 0);
2158
2159 #define Z_PARAM_STR_OR_LONG_OR_NULL(dest_str, dest_long, is_null) \
2160 Z_PARAM_STR_OR_LONG_EX(dest_str, dest_long, is_null, 1);
2161
2162 /* End of new parameter parsing API */
2163
2164 /* Inlined implementations shared by new and old parameter parsing APIs */
2165
2166 ZEND_API bool ZEND_FASTCALL zend_parse_arg_class(zval *arg, zend_class_entry **pce, uint32_t num, bool check_null);
2167 ZEND_API bool ZEND_FASTCALL zend_parse_arg_bool_slow(const zval *arg, bool *dest, uint32_t arg_num);
2168 ZEND_API bool ZEND_FASTCALL zend_parse_arg_bool_weak(const zval *arg, bool *dest, uint32_t arg_num);
2169 ZEND_API bool ZEND_FASTCALL zend_parse_arg_long_slow(const zval *arg, zend_long *dest, uint32_t arg_num);
2170 ZEND_API bool ZEND_FASTCALL zend_parse_arg_long_weak(const zval *arg, zend_long *dest, uint32_t arg_num);
2171 ZEND_API bool ZEND_FASTCALL zend_parse_arg_double_slow(const zval *arg, double *dest, uint32_t arg_num);
2172 ZEND_API bool ZEND_FASTCALL zend_parse_arg_double_weak(const zval *arg, double *dest, uint32_t arg_num);
2173 ZEND_API bool ZEND_FASTCALL zend_parse_arg_str_slow(zval *arg, zend_string **dest, uint32_t arg_num);
2174 ZEND_API bool ZEND_FASTCALL zend_parse_arg_str_weak(zval *arg, zend_string **dest, uint32_t arg_num);
2175 ZEND_API bool ZEND_FASTCALL zend_parse_arg_number_slow(zval *arg, zval **dest, uint32_t arg_num);
2176 ZEND_API bool ZEND_FASTCALL zend_parse_arg_number_or_str_slow(zval *arg, zval **dest, uint32_t arg_num);
2177 ZEND_API bool ZEND_FASTCALL zend_parse_arg_str_or_long_slow(zval *arg, zend_string **dest_str, zend_long *dest_long, uint32_t arg_num);
2178
2179 ZEND_API bool ZEND_FASTCALL zend_flf_parse_arg_bool_slow(const zval *arg, bool *dest, uint32_t arg_num);
2180 ZEND_API bool ZEND_FASTCALL zend_flf_parse_arg_str_slow(zval *arg, zend_string **dest, uint32_t arg_num);
2181 ZEND_API bool ZEND_FASTCALL zend_flf_parse_arg_long_slow(const zval *arg, zend_long *dest, uint32_t arg_num);
2182
zend_parse_arg_bool_ex(const zval * arg,bool * dest,bool * is_null,bool check_null,uint32_t arg_num,bool frameless)2183 static zend_always_inline bool zend_parse_arg_bool_ex(const zval *arg, bool *dest, bool *is_null, bool check_null, uint32_t arg_num, bool frameless)
2184 {
2185 if (check_null) {
2186 *is_null = 0;
2187 }
2188 if (EXPECTED(Z_TYPE_P(arg) == IS_TRUE)) {
2189 *dest = 1;
2190 } else if (EXPECTED(Z_TYPE_P(arg) == IS_FALSE)) {
2191 *dest = 0;
2192 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
2193 *is_null = 1;
2194 *dest = 0;
2195 } else {
2196 if (frameless) {
2197 return zend_flf_parse_arg_bool_slow(arg, dest, arg_num);
2198 } else {
2199 return zend_parse_arg_bool_slow(arg, dest, arg_num);
2200 }
2201 }
2202 return 1;
2203 }
2204
zend_parse_arg_bool(const zval * arg,bool * dest,bool * is_null,bool check_null,uint32_t arg_num)2205 static zend_always_inline bool zend_parse_arg_bool(const zval *arg, bool *dest, bool *is_null, bool check_null, uint32_t arg_num)
2206 {
2207 return zend_parse_arg_bool_ex(arg, dest, is_null, check_null, arg_num, /* frameless */ false);
2208 }
2209
zend_parse_arg_long_ex(zval * arg,zend_long * dest,bool * is_null,bool check_null,uint32_t arg_num,bool frameless)2210 static zend_always_inline bool zend_parse_arg_long_ex(zval *arg, zend_long *dest, bool *is_null, bool check_null, uint32_t arg_num, bool frameless)
2211 {
2212 if (check_null) {
2213 *is_null = 0;
2214 }
2215 if (EXPECTED(Z_TYPE_P(arg) == IS_LONG)) {
2216 *dest = Z_LVAL_P(arg);
2217 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
2218 *is_null = 1;
2219 *dest = 0;
2220 } else {
2221 if (frameless) {
2222 return zend_flf_parse_arg_long_slow(arg, dest, arg_num);
2223 } else {
2224 return zend_parse_arg_long_slow(arg, dest, arg_num);
2225 }
2226 }
2227 return 1;
2228 }
2229
zend_parse_arg_long(zval * arg,zend_long * dest,bool * is_null,bool check_null,uint32_t arg_num)2230 static zend_always_inline bool zend_parse_arg_long(zval *arg, zend_long *dest, bool *is_null, bool check_null, uint32_t arg_num)
2231 {
2232 return zend_parse_arg_long_ex(arg, dest, is_null, check_null, arg_num, /* frameless */ false);
2233 }
2234
zend_parse_arg_double(const zval * arg,double * dest,bool * is_null,bool check_null,uint32_t arg_num)2235 static zend_always_inline bool zend_parse_arg_double(const zval *arg, double *dest, bool *is_null, bool check_null, uint32_t arg_num)
2236 {
2237 if (check_null) {
2238 *is_null = 0;
2239 }
2240 if (EXPECTED(Z_TYPE_P(arg) == IS_DOUBLE)) {
2241 *dest = Z_DVAL_P(arg);
2242 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
2243 *is_null = 1;
2244 *dest = 0.0;
2245 } else {
2246 return zend_parse_arg_double_slow(arg, dest, arg_num);
2247 }
2248 return 1;
2249 }
2250
zend_parse_arg_number(zval * arg,zval ** dest,bool check_null,uint32_t arg_num)2251 static zend_always_inline bool zend_parse_arg_number(zval *arg, zval **dest, bool check_null, uint32_t arg_num)
2252 {
2253 if (EXPECTED(Z_TYPE_P(arg) == IS_LONG || Z_TYPE_P(arg) == IS_DOUBLE)) {
2254 *dest = arg;
2255 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2256 *dest = NULL;
2257 } else {
2258 return zend_parse_arg_number_slow(arg, dest, arg_num);
2259 }
2260 return 1;
2261 }
2262
zend_parse_arg_number_or_str(zval * arg,zval ** dest,bool check_null,uint32_t arg_num)2263 static zend_always_inline bool zend_parse_arg_number_or_str(zval *arg, zval **dest, bool check_null, uint32_t arg_num)
2264 {
2265 if (EXPECTED(Z_TYPE_P(arg) == IS_LONG || Z_TYPE_P(arg) == IS_DOUBLE || Z_TYPE_P(arg) == IS_STRING)) {
2266 *dest = arg;
2267 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2268 *dest = NULL;
2269 } else {
2270 return zend_parse_arg_number_or_str_slow(arg, dest, arg_num);
2271 }
2272 return true;
2273 }
2274
zend_parse_arg_str_ex(zval * arg,zend_string ** dest,bool check_null,uint32_t arg_num,bool frameless)2275 static zend_always_inline bool zend_parse_arg_str_ex(zval *arg, zend_string **dest, bool check_null, uint32_t arg_num, bool frameless)
2276 {
2277 if (EXPECTED(Z_TYPE_P(arg) == IS_STRING)) {
2278 *dest = Z_STR_P(arg);
2279 } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
2280 *dest = NULL;
2281 } else {
2282 if (frameless) {
2283 return zend_flf_parse_arg_str_slow(arg, dest, arg_num);
2284 } else {
2285 return zend_parse_arg_str_slow(arg, dest, arg_num);
2286 }
2287 }
2288 return 1;
2289 }
2290
zend_parse_arg_str(zval * arg,zend_string ** dest,bool check_null,uint32_t arg_num)2291 static zend_always_inline bool zend_parse_arg_str(zval *arg, zend_string **dest, bool check_null, uint32_t arg_num)
2292 {
2293 return zend_parse_arg_str_ex(arg, dest, check_null, arg_num, /* frameless */ false);
2294 }
2295
zend_parse_arg_string(zval * arg,char ** dest,size_t * dest_len,bool check_null,uint32_t arg_num)2296 static zend_always_inline bool zend_parse_arg_string(zval *arg, char **dest, size_t *dest_len, bool check_null, uint32_t arg_num)
2297 {
2298 zend_string *str;
2299
2300 if (!zend_parse_arg_str(arg, &str, check_null, arg_num)) {
2301 return 0;
2302 }
2303 if (check_null && UNEXPECTED(!str)) {
2304 *dest = NULL;
2305 *dest_len = 0;
2306 } else {
2307 *dest = ZSTR_VAL(str);
2308 *dest_len = ZSTR_LEN(str);
2309 }
2310 return 1;
2311 }
2312
zend_parse_arg_path_str(zval * arg,zend_string ** dest,bool check_null,uint32_t arg_num)2313 static zend_always_inline bool zend_parse_arg_path_str(zval *arg, zend_string **dest, bool check_null, uint32_t arg_num)
2314 {
2315 if (!zend_parse_arg_str(arg, dest, check_null, arg_num) ||
2316 (*dest && UNEXPECTED(CHECK_NULL_PATH(ZSTR_VAL(*dest), ZSTR_LEN(*dest))))) {
2317 return 0;
2318 }
2319 return 1;
2320 }
2321
zend_parse_arg_path(zval * arg,char ** dest,size_t * dest_len,bool check_null,uint32_t arg_num)2322 static zend_always_inline bool zend_parse_arg_path(zval *arg, char **dest, size_t *dest_len, bool check_null, uint32_t arg_num)
2323 {
2324 zend_string *str;
2325
2326 if (!zend_parse_arg_path_str(arg, &str, check_null, arg_num)) {
2327 return 0;
2328 }
2329 if (check_null && UNEXPECTED(!str)) {
2330 *dest = NULL;
2331 *dest_len = 0;
2332 } else {
2333 *dest = ZSTR_VAL(str);
2334 *dest_len = ZSTR_LEN(str);
2335 }
2336 return 1;
2337 }
2338
zend_parse_arg_iterable(zval * arg,zval ** dest,bool check_null)2339 static zend_always_inline bool zend_parse_arg_iterable(zval *arg, zval **dest, bool check_null)
2340 {
2341 if (EXPECTED(zend_is_iterable(arg))) {
2342 *dest = arg;
2343 return 1;
2344 }
2345
2346 if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2347 *dest = NULL;
2348 return 1;
2349 }
2350
2351 return 0;
2352 }
2353
zend_parse_arg_array(zval * arg,zval ** dest,bool check_null,bool or_object)2354 static zend_always_inline bool zend_parse_arg_array(zval *arg, zval **dest, bool check_null, bool or_object)
2355 {
2356 if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY) ||
2357 (or_object && EXPECTED(Z_TYPE_P(arg) == IS_OBJECT))) {
2358 *dest = arg;
2359 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2360 *dest = NULL;
2361 } else {
2362 return 0;
2363 }
2364 return 1;
2365 }
2366
zend_parse_arg_array_ht(const zval * arg,HashTable ** dest,bool check_null,bool or_object,bool separate)2367 static zend_always_inline bool zend_parse_arg_array_ht(const zval *arg, HashTable **dest, bool check_null, bool or_object, bool separate)
2368 {
2369 if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY)) {
2370 *dest = Z_ARRVAL_P(arg);
2371 } else if (or_object && EXPECTED(Z_TYPE_P(arg) == IS_OBJECT)) {
2372 zend_object *zobj = Z_OBJ_P(arg);
2373 if (separate
2374 && zobj->properties
2375 && UNEXPECTED(GC_REFCOUNT(zobj->properties) > 1)) {
2376 if (EXPECTED(!(GC_FLAGS(zobj->properties) & IS_ARRAY_IMMUTABLE))) {
2377 GC_DELREF(zobj->properties);
2378 }
2379 zobj->properties = zend_array_dup(zobj->properties);
2380 }
2381 *dest = zobj->handlers->get_properties(zobj);
2382 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2383 *dest = NULL;
2384 } else {
2385 return 0;
2386 }
2387 return 1;
2388 }
2389
zend_parse_arg_array_ht_or_long(zval * arg,HashTable ** dest_ht,zend_long * dest_long,bool * is_null,bool allow_null,uint32_t arg_num)2390 static zend_always_inline bool zend_parse_arg_array_ht_or_long(
2391 zval *arg, HashTable **dest_ht, zend_long *dest_long, bool *is_null, bool allow_null, uint32_t arg_num
2392 ) {
2393 if (allow_null) {
2394 *is_null = 0;
2395 }
2396
2397 if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY)) {
2398 *dest_ht = Z_ARRVAL_P(arg);
2399 } else if (EXPECTED(Z_TYPE_P(arg) == IS_LONG)) {
2400 *dest_ht = NULL;
2401 *dest_long = Z_LVAL_P(arg);
2402 } else if (allow_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2403 *dest_ht = NULL;
2404 *is_null = 1;
2405 } else {
2406 *dest_ht = NULL;
2407 return zend_parse_arg_long_slow(arg, dest_long, arg_num);
2408 }
2409
2410 return 1;
2411 }
2412
zend_parse_arg_object(zval * arg,zval ** dest,zend_class_entry * ce,bool check_null)2413 static zend_always_inline bool zend_parse_arg_object(zval *arg, zval **dest, zend_class_entry *ce, bool check_null)
2414 {
2415 if (EXPECTED(Z_TYPE_P(arg) == IS_OBJECT) &&
2416 (!ce || EXPECTED(instanceof_function(Z_OBJCE_P(arg), ce) != 0))) {
2417 *dest = arg;
2418 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2419 *dest = NULL;
2420 } else {
2421 return 0;
2422 }
2423 return 1;
2424 }
2425
zend_parse_arg_obj(const zval * arg,zend_object ** dest,zend_class_entry * ce,bool check_null)2426 static zend_always_inline bool zend_parse_arg_obj(const zval *arg, zend_object **dest, zend_class_entry *ce, bool check_null)
2427 {
2428 if (EXPECTED(Z_TYPE_P(arg) == IS_OBJECT) &&
2429 (!ce || EXPECTED(instanceof_function(Z_OBJCE_P(arg), ce) != 0))) {
2430 *dest = Z_OBJ_P(arg);
2431 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2432 *dest = NULL;
2433 } else {
2434 return 0;
2435 }
2436 return 1;
2437 }
2438
zend_parse_arg_obj_or_long(zval * arg,zend_object ** dest_obj,zend_class_entry * ce,zend_long * dest_long,bool * is_null,bool allow_null,uint32_t arg_num)2439 static zend_always_inline bool zend_parse_arg_obj_or_long(
2440 zval *arg, zend_object **dest_obj, zend_class_entry *ce, zend_long *dest_long, bool *is_null, bool allow_null, uint32_t arg_num
2441 ) {
2442 if (allow_null) {
2443 *is_null = 0;
2444 }
2445
2446 if (EXPECTED(Z_TYPE_P(arg) == IS_OBJECT) && EXPECTED(instanceof_function(Z_OBJCE_P(arg), ce) != 0)) {
2447 *dest_obj = Z_OBJ_P(arg);
2448 } else if (EXPECTED(Z_TYPE_P(arg) == IS_LONG)) {
2449 *dest_obj = NULL;
2450 *dest_long = Z_LVAL_P(arg);
2451 } else if (allow_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2452 *dest_obj = NULL;
2453 *is_null = 1;
2454 } else {
2455 *dest_obj = NULL;
2456 return zend_parse_arg_long_slow(arg, dest_long, arg_num);
2457 }
2458
2459 return 1;
2460 }
2461
zend_parse_arg_resource(zval * arg,zval ** dest,bool check_null)2462 static zend_always_inline bool zend_parse_arg_resource(zval *arg, zval **dest, bool check_null)
2463 {
2464 if (EXPECTED(Z_TYPE_P(arg) == IS_RESOURCE)) {
2465 *dest = arg;
2466 } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2467 *dest = NULL;
2468 } else {
2469 return 0;
2470 }
2471 return 1;
2472 }
2473
zend_parse_arg_func(zval * arg,zend_fcall_info * dest_fci,zend_fcall_info_cache * dest_fcc,bool check_null,char ** error,bool free_trampoline)2474 static zend_always_inline bool zend_parse_arg_func(zval *arg, zend_fcall_info *dest_fci, zend_fcall_info_cache *dest_fcc, bool check_null, char **error, bool free_trampoline)
2475 {
2476 if (check_null && UNEXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2477 dest_fci->size = 0;
2478 dest_fcc->function_handler = NULL;
2479 *error = NULL;
2480 } else if (UNEXPECTED(zend_fcall_info_init(arg, 0, dest_fci, dest_fcc, NULL, error) != SUCCESS)) {
2481 return 0;
2482 }
2483 if (free_trampoline) {
2484 /* Release call trampolines: The function may not get called, in which case
2485 * the trampoline will leak. Force it to be refetched during
2486 * zend_call_function instead. */
2487 zend_release_fcall_info_cache(dest_fcc);
2488 }
2489 return 1;
2490 }
2491
zend_parse_arg_zval(zval * arg,zval ** dest,bool check_null)2492 static zend_always_inline void zend_parse_arg_zval(zval *arg, zval **dest, bool check_null)
2493 {
2494 *dest = (check_null &&
2495 (UNEXPECTED(Z_TYPE_P(arg) == IS_NULL) ||
2496 (UNEXPECTED(Z_ISREF_P(arg)) &&
2497 UNEXPECTED(Z_TYPE_P(Z_REFVAL_P(arg)) == IS_NULL)))) ? NULL : arg;
2498 }
2499
zend_parse_arg_zval_deref(zval * arg,zval ** dest,bool check_null)2500 static zend_always_inline void zend_parse_arg_zval_deref(zval *arg, zval **dest, bool check_null)
2501 {
2502 *dest = (check_null && UNEXPECTED(Z_TYPE_P(arg) == IS_NULL)) ? NULL : arg;
2503 }
2504
zend_parse_arg_array_ht_or_str(zval * arg,HashTable ** dest_ht,zend_string ** dest_str,bool allow_null,uint32_t arg_num)2505 static zend_always_inline bool zend_parse_arg_array_ht_or_str(
2506 zval *arg, HashTable **dest_ht, zend_string **dest_str, bool allow_null, uint32_t arg_num)
2507 {
2508 if (EXPECTED(Z_TYPE_P(arg) == IS_STRING)) {
2509 *dest_ht = NULL;
2510 *dest_str = Z_STR_P(arg);
2511 } else if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY)) {
2512 *dest_ht = Z_ARRVAL_P(arg);
2513 *dest_str = NULL;
2514 } else if (allow_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2515 *dest_ht = NULL;
2516 *dest_str = NULL;
2517 } else {
2518 *dest_ht = NULL;
2519 return zend_parse_arg_str_slow(arg, dest_str, arg_num);
2520 }
2521 return 1;
2522 }
2523
zend_parse_arg_str_or_long(zval * arg,zend_string ** dest_str,zend_long * dest_long,bool * is_null,bool allow_null,uint32_t arg_num)2524 static zend_always_inline bool zend_parse_arg_str_or_long(zval *arg, zend_string **dest_str, zend_long *dest_long,
2525 bool *is_null, bool allow_null, uint32_t arg_num)
2526 {
2527 if (allow_null) {
2528 *is_null = 0;
2529 }
2530 if (EXPECTED(Z_TYPE_P(arg) == IS_STRING)) {
2531 *dest_str = Z_STR_P(arg);
2532 } else if (EXPECTED(Z_TYPE_P(arg) == IS_LONG)) {
2533 *dest_str = NULL;
2534 *dest_long = Z_LVAL_P(arg);
2535 } else if (allow_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2536 *dest_str = NULL;
2537 *is_null = 1;
2538 } else {
2539 return zend_parse_arg_str_or_long_slow(arg, dest_str, dest_long, arg_num);
2540 }
2541 return 1;
2542 }
2543
zend_parse_arg_obj_or_class_name(zval * arg,zend_class_entry ** destination,bool allow_null)2544 static zend_always_inline bool zend_parse_arg_obj_or_class_name(
2545 zval *arg, zend_class_entry **destination, bool allow_null
2546 ) {
2547 if (EXPECTED(Z_TYPE_P(arg) == IS_STRING)) {
2548 *destination = zend_lookup_class(Z_STR_P(arg));
2549
2550 return *destination != NULL;
2551 } else if (EXPECTED(Z_TYPE_P(arg) == IS_OBJECT)) {
2552 *destination = Z_OBJ_P(arg)->ce;
2553 } else if (allow_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
2554 *destination = NULL;
2555 } else {
2556 return 0;
2557 }
2558
2559 return 1;
2560 }
2561
zend_parse_arg_obj_or_str(zval * arg,zend_object ** destination_object,zend_class_entry * base_ce,zend_string ** destination_string,bool allow_null,uint32_t arg_num)2562 static zend_always_inline bool zend_parse_arg_obj_or_str(
2563 zval *arg, zend_object **destination_object, zend_class_entry *base_ce, zend_string **destination_string, bool allow_null, uint32_t arg_num
2564 ) {
2565 if (EXPECTED(Z_TYPE_P(arg) == IS_OBJECT)) {
2566 if (!base_ce || EXPECTED(instanceof_function(Z_OBJCE_P(arg), base_ce))) {
2567 *destination_object = Z_OBJ_P(arg);
2568 *destination_string = NULL;
2569 return 1;
2570 }
2571 }
2572
2573 *destination_object = NULL;
2574 return zend_parse_arg_str(arg, destination_string, allow_null, arg_num);
2575 }
2576
2577 END_EXTERN_C()
2578
2579 #endif /* ZEND_API_H */
2580