Support call_user_func with named params

nikic · nikic · commit 0003399b1ab3 · 2020-07-06T15:13:08.000+02:00
Drop the fci_named distinction. It turned out to be too cumbersome
to support. It's better to update affected fci initializations.
diff --git a/Zend/tests/named_params/call_user_func.phpt b/Zend/tests/named_params/call_user_func.phpt
@@ -0,0 +1,21 @@
+--TEST--
+call_user_func() with named parameters
+--FILE--
+<?php
+
+function test($a = 'a', $b = 'b') {
+    var_dump($a, $b);
+}
+
+call_user_func('test', 'A', b: 'B');
+call_user_func('test', b: 'B', a: 'A');
+call_user_func('test', b: 'B');
+
+?>
+--EXPECT--
+string(1) "A"
+string(1) "B"
+string(1) "A"
+string(1) "B"
+string(1) "a"
+string(1) "B"
diff --git a/Zend/tests/named_params/internal_variadics.phpt b/Zend/tests/named_params/internal_variadics.phpt
@@ -15,15 +15,7 @@ try {
     echo $e->getMessage(), "\n";
 }
 
-// TODO: Should this work?
-try {
-    call_user_func('strlen', str: 'foo');
-} catch (ArgumentCountError $e) {
-    echo $e->getMessage(), "\n";
-}
-
 ?>
 --EXPECT--
 array_merge() does not accept unknown named parameters
 array_diff_key() does not accept unknown named parameters
-call_user_func() does not accept unknown named parameters
diff --git a/Zend/zend_API.c b/Zend/zend_API.c
@@ -3357,6 +3357,7 @@ ZEND_API int zend_fcall_info_init(zval *callable, uint32_t check_flags, zend_fca
 	fci->retval = NULL;
 	fci->param_count = 0;
 	fci->params = NULL;
+	fci->named_params = NULL;
 	fci->no_separation = 1;
 
 	return SUCCESS;
diff --git a/Zend/zend_API.h b/Zend/zend_API.h
@@ -48,12 +48,8 @@ typedef struct _zend_fcall_info {
 	zend_object *object;
 	zend_bool no_separation;
 	uint32_t param_count;
-} zend_fcall_info;
-
-typedef struct _zend_fcall_info_named {
-	zend_fcall_info fci;
 	HashTable *named_params;
-} zend_fcall_info_named;
+} zend_fcall_info;
 
 typedef struct _zend_fcall_info_cache {
 	zend_function *function_handler;
diff --git a/Zend/zend_closures.c b/Zend/zend_closures.c
@@ -168,6 +168,7 @@ ZEND_METHOD(Closure, call)
 	fci.size = sizeof(fci);
 	ZVAL_OBJ(&fci.function_name, &closure->std);
 	fci.retval = &closure_result;
+	fci.named_params = NULL;
 	fci.no_separation = 1;
 
 	if (zend_call_function(&fci, &fci_cache) == SUCCESS && Z_TYPE(closure_result) != IS_UNDEF) {
diff --git a/Zend/zend_exceptions.c b/Zend/zend_exceptions.c
@@ -672,6 +672,7 @@ ZEND_METHOD(Exception, __toString)
 		fci.retval = &trace;
 		fci.param_count = 0;
 		fci.params = NULL;
+		fci.named_params = NULL;
 		fci.no_separation = 1;
 
 		zend_call_function(&fci, NULL);
diff --git a/Zend/zend_execute_API.c b/Zend/zend_execute_API.c
@@ -629,6 +629,7 @@ int _call_user_function_ex(zval *object, zval *function_name, zval *retval_ptr,
 	fci.retval = retval_ptr;
 	fci.param_count = param_count;
 	fci.params = params;
+	fci.named_params = NULL;
 	fci.no_separation = (zend_bool) no_separation;
 
 	return zend_call_function(&fci, NULL);
@@ -655,8 +656,7 @@ int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache) /
 		return FAILURE; /* we would result in an instable executor otherwise */
 	}
 
-	ZEND_ASSERT(fci->size == sizeof(zend_fcall_info)
-		|| fci->size == sizeof(zend_fcall_info_named));
+	ZEND_ASSERT(fci->size == sizeof(zend_fcall_info));
 
 	/* Initialize execute_data */
 	if (!EG(current_execute_data)) {
@@ -768,32 +768,29 @@ int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache) /
 		ZVAL_COPY(param, arg);
 	}
 
-	if (fci->size == sizeof(zend_fcall_info_named)) {
-		HashTable *named_params = ((zend_fcall_info_named *) fci)->named_params;
-		if (named_params) {
-			zend_string *name;
-			zval *val;
-			ZEND_HASH_FOREACH_STR_KEY_VAL(named_params, name, val) {
-				ZEND_ASSERT(name && "named_params may only contain named params");
-
-				void *cache_slot = NULL;
-				uint32_t arg_num;
-				zval *target = zend_handle_named_arg(&call, name, &arg_num, &cache_slot);
-				if (!target) {
-					zend_vm_stack_free_args(call);
-					zend_vm_stack_free_call_frame(call);
-					if (EG(current_execute_data) == &dummy_execute_data) {
-						EG(current_execute_data) = dummy_execute_data.prev_execute_data;
-					}
-					return FAILURE;
+	if (fci->named_params) {
+		zend_string *name;
+		zval *val;
+		ZEND_HASH_FOREACH_STR_KEY_VAL(fci->named_params, name, val) {
+			ZEND_ASSERT(name && "named_params may only contain named params");
+
+			void *cache_slot = NULL;
+			uint32_t arg_num;
+			zval *target = zend_handle_named_arg(&call, name, &arg_num, &cache_slot);
+			if (!target) {
+				zend_vm_stack_free_args(call);
+				zend_vm_stack_free_call_frame(call);
+				if (EG(current_execute_data) == &dummy_execute_data) {
+					EG(current_execute_data) = dummy_execute_data.prev_execute_data;
 				}
+				return FAILURE;
+			}
 
-				/* TODO */
-				/*if (ARG_SHOULD_BE_SENT_BY_REF(func, arg_num)) {
-				}*/
-				ZVAL_COPY(target, val);
-			} ZEND_HASH_FOREACH_END();
-		}
+			/* TODO */
+			/*if (ARG_SHOULD_BE_SENT_BY_REF(func, arg_num)) {
+			}*/
+			ZVAL_COPY(target, val);
+		} ZEND_HASH_FOREACH_END();
 	}
 
 	if (UNEXPECTED(func->op_array.fn_flags & ZEND_ACC_CLOSURE)) {
@@ -895,6 +892,7 @@ ZEND_API void zend_call_known_function(
 	fci.retval = retval_ptr ? retval_ptr : &retval;
 	fci.param_count = param_count;
 	fci.params = params;
+	fci.named_params = NULL;
 	fci.no_separation = 1;
 	ZVAL_UNDEF(&fci.function_name); /* Unused */
 
diff --git a/ext/reflection/php_reflection.c b/ext/reflection/php_reflection.c
@@ -1834,6 +1834,7 @@ ZEND_METHOD(ReflectionFunction, invoke)
 	fci.retval = &retval;
 	fci.param_count = num_args;
 	fci.params = params;
+	fci.named_params = NULL;
 	fci.no_separation = 1;
 
 	fcc.function_handler = fptr;
@@ -1897,6 +1898,7 @@ ZEND_METHOD(ReflectionFunction, invokeArgs)
 	fci.retval = &retval;
 	fci.param_count = argc;
 	fci.params = params;
+	fci.named_params = NULL;
 	fci.no_separation = 1;
 
 	fcc.function_handler = fptr;
@@ -3261,6 +3263,7 @@ static void reflection_method_invoke(INTERNAL_FUNCTION_PARAMETERS, int variadic)
 	fci.retval = &retval;
 	fci.param_count = argc;
 	fci.params = params;
+	fci.named_params = NULL;
 	fci.no_separation = 1;
 
 	fcc.function_handler = mptr;
@@ -6516,23 +6519,23 @@ static int call_attribute_constructor(zend_class_entry *ce, zend_object *obj, zv
 
 	{
 		zval retval;
-		zend_fcall_info_named fci_named;
+		zend_fcall_info fci;
 		zend_fcall_info_cache fcic;
 
-		fci_named.fci.size = sizeof(zend_fcall_info_named);
-		fci_named.fci.object = obj;
-		fci_named.fci.retval = &retval;
-		fci_named.fci.param_count = argc;
-		fci_named.fci.params = args;
-		fci_named.fci.no_separation = 1;
-		fci_named.named_params = named_params;
-		ZVAL_UNDEF(&fci_named.fci.function_name); /* Unused */
+		fci.size = sizeof(zend_fcall_info);
+		fci.object = obj;
+		fci.retval = &retval;
+		fci.param_count = argc;
+		fci.params = args;
+		fci.no_separation = 1;
+		fci.named_params = named_params;
+		ZVAL_UNDEF(&fci.function_name); /* Unused */
 
 		fcic.function_handler = ctor;
 		fcic.object = obj;
 		fcic.called_scope = obj->ce;
 
-		zend_call_function(&fci_named.fci, &fcic);
+		zend_call_function(&fci, &fcic);
 	}
 
 	if (EG(exception)) {
diff --git a/ext/standard/basic_functions.c b/ext/standard/basic_functions.c
@@ -1570,7 +1570,7 @@ PHP_FUNCTION(call_user_func)
 
 	ZEND_PARSE_PARAMETERS_START(1, -1)
 		Z_PARAM_FUNC(fci, fci_cache)
-		Z_PARAM_VARIADIC('*', fci.params, fci.param_count)
+		Z_PARAM_VARIADIC_WITH_NAMED(fci.params, fci.param_count, fci.named_params)
 	ZEND_PARSE_PARAMETERS_END();
 
 	fci.retval = &retval;
