Add zend_call_known_function() API family

This adds the following APIs:

void zend_call_known_function(
    zend_function *fn, zend_object *object, zend_class_entry *called_scope,
    zval *retval_ptr, int param_count, zval *params);

void zend_call_known_instance_method(
    zend_function *fn, zend_object *object, zval *retval_ptr, int param_count, zval *params);
void zend_call_known_instance_method_with_0_params(
    zend_function *fn, zend_object *object, zval *retval_ptr);
void zend_call_known_instance_method_with_1_params(
    zend_function *fn, zend_object *object, zval *retval_ptr, zval *param);
void zend_call_known_instance_method_with_2_params(
    zend_function *fn, zend_object *object, zval *retval_ptr, zval *param1, zval *param2);

These are used to perform a call if you already have the
zend_function you want to call. zend_call_known_function()
is the base API, the rest are just really thin wrappers around
it for the common case of instance method calls.

Closes GH-5692.

Author: nikic

Zend/zend_API.h

@@ -563,6 +563,37 @@ ZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *f
 
 ZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache);
 
+/* Call the provided zend_function with the given params.
+ * If retval_ptr is NULL, the return value is discarded.
+ * If object is NULL, this must be a free function or static call.
+ * called_scope must be provided for instance and static method calls. */
+ZEND_API void zend_call_known_function(
+		zend_function *fn, zend_object *object, zend_class_entry *called_scope, zval *retval_ptr,
+		uint32_t param_count, zval *params);
+
+/* Call the provided zend_function instance method on an object. */
+static zend_always_inline void zend_call_known_instance_method(
+		zend_function *fn, zend_object *object, zval *retval_ptr,
+		uint32_t param_count, zval *params)
+{
+	zend_call_known_function(fn, object, object->ce, retval_ptr, param_count, params);
+}
+
+static zend_always_inline void zend_call_known_instance_method_with_0_params(
+		zend_function *fn, zend_object *object, zval *retval_ptr)
+{
+	zend_call_known_instance_method(fn, object, retval_ptr, 0, NULL);
+}
+
+static zend_always_inline void zend_call_known_instance_method_with_1_params(
+		zend_function *fn, zend_object *object, zval *retval_ptr, zval *param)
+{
+	zend_call_known_instance_method(fn, object, retval_ptr, 1, param);
+}
+
+ZEND_API void zend_call_known_instance_method_with_2_params(
+		zend_function *fn, zend_object *object, zval *retval_ptr, zval *param1, zval *param2);
+
 ZEND_API int zend_set_hash_symbol(zval *symbol, const char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
 
 ZEND_API int zend_delete_global_variable(zend_string *name);

Zend/zend_exceptions.c

@@ -922,7 +922,7 @@ ZEND_API ZEND_COLD void zend_exception_error(zend_object *ex, int severity) /* {
 		zend_string *str, *file = NULL;
 		zend_long line = 0;
 
-		zend_call_method_with_0_params(Z_OBJ(exception), ce_exception, &ex->ce->__tostring, "__tostring", &tmp);
+		zend_call_known_instance_method_with_0_params(ex->ce->__tostring, Z_OBJ(exception), &tmp);
 		if (!EG(exception)) {
 			if (Z_TYPE(tmp) != IS_STRING) {
 				zend_error(E_WARNING, "%s::__toString() must return a string", ZSTR_VAL(ce_exception->name));

Zend/zend_execute_API.c

@@ -861,6 +861,51 @@ int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache) /
 }
 /* }}} */
 
+ZEND_API void zend_call_known_function(
+		zend_function *fn, zend_object *object, zend_class_entry *called_scope, zval *retval_ptr,
+		uint32_t param_count, zval *params)
+{
+	zval retval;
+	zend_fcall_info fci;
+	zend_fcall_info_cache fcic;
+
+	ZEND_ASSERT(fn && "zend_function must be passed!");
+
+	fci.size = sizeof(fci);
+	fci.object = object;
+	fci.retval = retval_ptr ? retval_ptr : &retval;
+	fci.param_count = param_count;
+	fci.params = params;
+	fci.no_separation = 1;
+	ZVAL_UNDEF(&fci.function_name); /* Unused */
+
+	fcic.function_handler = fn;
+	fcic.object = object;
+	fcic.called_scope = called_scope;
+
+	int result = zend_call_function(&fci, &fcic);
+	if (UNEXPECTED(result == FAILURE)) {
+		if (!EG(exception)) {
+			zend_error_noreturn(E_CORE_ERROR, "Couldn't execute method %s%s%s",
+				fn->common.scope ? ZSTR_VAL(fn->common.scope->name) : "",
+				fn->common.scope ? "::" : "", ZSTR_VAL(fn->common.function_name));
+		}
+	}
+
+	if (!retval_ptr) {
+		zval_ptr_dtor(&retval);
+	}
+}
+
+ZEND_API void zend_call_known_instance_method_with_2_params(
+		zend_function *fn, zend_object *object, zval *retval_ptr, zval *param1, zval *param2)
+{
+	zval params[2];
+	ZVAL_COPY_VALUE(&params[0], param1);
+	ZVAL_COPY_VALUE(&params[1], param2);
+	zend_call_known_instance_method(fn, object, retval_ptr, 2, params);
+}
+
 ZEND_API zend_class_entry *zend_lookup_class_ex(zend_string *name, zend_string *key, uint32_t flags) /* {{{ */
 {
 	zend_class_entry *ce = NULL;

Zend/zend_interfaces.c

@@ -32,12 +32,10 @@ ZEND_API zend_class_entry *zend_ce_stringable;
 
 /* {{{ zend_call_method
  Only returns the returned zval if retval_ptr != NULL */
-ZEND_API zval* zend_call_method(zend_object *object, zend_class_entry *obj_ce, zend_function **fn_proxy, const char *function_name, size_t function_name_len, zval *retval_ptr, int param_count, zval* arg1, zval* arg2)
+ZEND_API zval* zend_call_method(zend_object *object, zend_class_entry *obj_ce, zend_function **fn_proxy, const char *function_name, size_t function_name_len, zval *retval_ptr, uint32_t param_count, zval* arg1, zval* arg2)
 {
-	int result;
-	zend_fcall_info fci;
-	zend_fcall_info_cache fcic;
-	zval retval;
+	zend_function *fn;
+	zend_class_entry *called_scope;
 	zval params[2];
 
 	if (param_count > 0) {
@@ -47,68 +45,43 @@ ZEND_API zval* zend_call_method(zend_object *object, zend_class_entry *obj_ce, z
 		ZVAL_COPY_VALUE(&params[1], arg2);
 	}
 
-	fci.size = sizeof(fci);
-	fci.object = object;
-	fci.retval = retval_ptr ? retval_ptr : &retval;
-	fci.param_count = param_count;
-	fci.params = params;
-	fci.no_separation = 1;
-	ZVAL_UNDEF(&fci.function_name); /* Unused */
-
 	if (!obj_ce) {
 		obj_ce = object ? object->ce : NULL;
 	}
 	if (!fn_proxy || !*fn_proxy) {
 		if (EXPECTED(obj_ce)) {
-			fcic.function_handler = zend_hash_str_find_ptr(
+			fn = zend_hash_str_find_ptr(
 				&obj_ce->function_table, function_name, function_name_len);
-			if (UNEXPECTED(fcic.function_handler == NULL)) {
+			if (UNEXPECTED(fn == NULL)) {
 				/* error at c-level */
 				zend_error_noreturn(E_CORE_ERROR, "Couldn't find implementation for method %s::%s", ZSTR_VAL(obj_ce->name), function_name);
 			}
 		} else {
-			fcic.function_handler = zend_fetch_function_str(function_name, function_name_len);
-			if (UNEXPECTED(fcic.function_handler == NULL)) {
+			fn = zend_fetch_function_str(function_name, function_name_len);
+			if (UNEXPECTED(fn == NULL)) {
 				/* error at c-level */
 				zend_error_noreturn(E_CORE_ERROR, "Couldn't find implementation for function %s", function_name);
 			}
 		}
 		if (fn_proxy) {
-			*fn_proxy = fcic.function_handler;
+			*fn_proxy = fn;
 		}
 	} else {
-		fcic.function_handler = *fn_proxy;
+		fn = *fn_proxy;
 	}
 
 	if (object) {
-		fcic.called_scope = object->ce;
+		called_scope = object->ce;
 	} else {
-		zend_class_entry *called_scope = zend_get_called_scope(EG(current_execute_data));
-
+		called_scope = zend_get_called_scope(EG(current_execute_data));
 		if (obj_ce &&
 			(!called_scope ||
 			 !instanceof_function(called_scope, obj_ce))) {
-			fcic.called_scope = obj_ce;
-		} else {
-			fcic.called_scope = called_scope;
+			called_scope = obj_ce;
 		}
 	}
-	fcic.object = object;
-	result = zend_call_function(&fci, &fcic);
 
-	if (result == FAILURE) {
-		/* error at c-level */
-		if (!obj_ce) {
-			obj_ce = object ? object->ce : NULL;
-		}
-		if (!EG(exception)) {
-			zend_error_noreturn(E_CORE_ERROR, "Couldn't execute method %s%s%s", obj_ce ? ZSTR_VAL(obj_ce->name) : "", obj_ce ? "::" : "", function_name);
-		}
-	}
-	if (!retval_ptr) {
-		zval_ptr_dtor(&retval);
-		return NULL;
-	}
+	zend_call_known_function(fn, object, called_scope, retval_ptr, param_count, params);
 	return retval_ptr;
 }
 /* }}} */
@@ -390,8 +363,7 @@ ZEND_API int zend_user_serialize(zval *object, unsigned char **buffer, size_t *b
 	zval retval;
 	int result;
 
-	zend_call_method_with_0_params(Z_OBJ_P(object), ce, &ce->serialize_func, "serialize", &retval);
-
+	zend_call_known_instance_method_with_0_params(ce->serialize_func, Z_OBJ_P(object), &retval);
 
 	if (Z_TYPE(retval) == IS_UNDEF || EG(exception)) {
 		result = FAILURE;
@@ -430,9 +402,8 @@ ZEND_API int zend_user_unserialize(zval *object, zend_class_entry *ce, const uns
 	}
 
 	ZVAL_STRINGL(&zdata, (char*)buf, buf_len);
-
-	zend_call_method_with_1_params(Z_OBJ_P(object), ce, &ce->unserialize_func, "unserialize", NULL, &zdata);
-
+	zend_call_known_instance_method_with_1_params(
+		ce->unserialize_func, Z_OBJ_P(object), NULL, &zdata);
 	zval_ptr_dtor(&zdata);
 
 	if (EG(exception)) {

Zend/zend_interfaces.h

@@ -38,7 +38,7 @@ typedef struct _zend_user_iterator {
 	zval                     value;
 } zend_user_iterator;
 
-ZEND_API zval* zend_call_method(zend_object *object, zend_class_entry *obj_ce, zend_function **fn_proxy, const char *function_name, size_t function_name_len, zval *retval, int param_count, zval* arg1, zval* arg2);
+ZEND_API zval* zend_call_method(zend_object *object, zend_class_entry *obj_ce, zend_function **fn_proxy, const char *function_name, size_t function_name_len, zval *retval, uint32_t param_count, zval* arg1, zval* arg2);
 
 #define zend_call_method_with_0_params(obj, obj_ce, fn_proxy, function_name, retval) \
 	zend_call_method(obj, obj_ce, fn_proxy, function_name, sizeof(function_name)-1, retval, 0, NULL, NULL)

Zend/zend_object_handlers.c

@@ -149,7 +149,7 @@ ZEND_API HashTable *zend_std_get_debug_info(zend_object *object, int *is_temp) /
 		return object->handlers->get_properties(object);
 	}
 
-	zend_call_method_with_0_params(object, ce, &ce->__debugInfo, ZEND_DEBUGINFO_FUNC_NAME, &retval);
+	zend_call_known_instance_method_with_0_params(ce->__debugInfo, object, &retval);
 	if (Z_TYPE(retval) == IS_ARRAY) {
 		if (!Z_REFCOUNTED(retval)) {
 			*is_temp = 1;
@@ -177,145 +177,56 @@ ZEND_API HashTable *zend_std_get_debug_info(zend_object *object, int *is_temp) /
 
 static void zend_std_call_getter(zend_object *zobj, zend_string *prop_name, zval *retval) /* {{{ */
 {
-	zend_class_entry *ce = zobj->ce;
 	zend_class_entry *orig_fake_scope = EG(fake_scope);
-	zend_fcall_info fci;
-	zend_fcall_info_cache fcic;
 	zval member;
 
 	EG(fake_scope) = NULL;
 
-	/* __get handler is called with one argument:
-	      property name
-
-	   it should return whether the call was successful or not
-	*/
-
 	ZVAL_STR(&member, prop_name);
-
-	fci.size = sizeof(fci);
-	fci.object = zobj;
-	fci.retval = retval;
-	fci.param_count = 1;
-	fci.params = &member;
-	fci.no_separation = 1;
-	ZVAL_UNDEF(&fci.function_name); /* Unused */
-
-	fcic.function_handler = ce->__get;
-	fcic.called_scope = ce;
-	fcic.object = zobj;
-
-	zend_call_function(&fci, &fcic);
+	zend_call_known_instance_method_with_1_params(zobj->ce->__get, zobj, retval, &member);
 
 	EG(fake_scope) = orig_fake_scope;
 }
 /* }}} */
 
 static void zend_std_call_setter(zend_object *zobj, zend_string *prop_name, zval *value) /* {{{ */
 {
-	zend_class_entry *ce = zobj->ce;
 	zend_class_entry *orig_fake_scope = EG(fake_scope);
-	zend_fcall_info fci;
-	zend_fcall_info_cache fcic;
-	zval args[2], ret;
+	zval args[2];
 
 	EG(fake_scope) = NULL;
 
-	/* __set handler is called with two arguments:
-	     property name
-	     value to be set
-	*/
-
 	ZVAL_STR(&args[0], prop_name);
 	ZVAL_COPY_VALUE(&args[1], value);
-	ZVAL_UNDEF(&ret);
-
-	fci.size = sizeof(fci);
-	fci.object = zobj;
-	fci.retval = &ret;
-	fci.param_count = 2;
-	fci.params = args;
-	fci.no_separation = 1;
-	ZVAL_UNDEF(&fci.function_name); /* Unused */
-
-	fcic.function_handler = ce->__set;
-	fcic.called_scope = ce;
-	fcic.object = zobj;
-
-	zend_call_function(&fci, &fcic);
-	zval_ptr_dtor(&ret);
+	zend_call_known_instance_method(zobj->ce->__set, zobj, NULL, 2, args);
 
 	EG(fake_scope) = orig_fake_scope;
 }
 /* }}} */
 
 static void zend_std_call_unsetter(zend_object *zobj, zend_string *prop_name) /* {{{ */
 {
-	zend_class_entry *ce = zobj->ce;
 	zend_class_entry *orig_fake_scope = EG(fake_scope);
-	zend_fcall_info fci;
-	zend_fcall_info_cache fcic;
-	zval ret, member;
+	zval member;
 
 	EG(fake_scope) = NULL;
 
-	/* __unset handler is called with one argument:
-	      property name
-	*/
-
 	ZVAL_STR(&member, prop_name);
-	ZVAL_UNDEF(&ret);
-
-	fci.size = sizeof(fci);
-	fci.object = zobj;
-	fci.retval = &ret;
-	fci.param_count = 1;
-	fci.params = &member;
-	fci.no_separation = 1;
-	ZVAL_UNDEF(&fci.function_name); /* Unused */
-
-	fcic.function_handler = ce->__unset;
-	fcic.called_scope = ce;
-	fcic.object = zobj;
-
-	zend_call_function(&fci, &fcic);
-	zval_ptr_dtor(&ret);
+	zend_call_known_instance_method_with_1_params(zobj->ce->__unset, zobj, NULL, &member);
 
 	EG(fake_scope) = orig_fake_scope;
 }
 /* }}} */
 
 static void zend_std_call_issetter(zend_object *zobj, zend_string *prop_name, zval *retval) /* {{{ */
 {
-	zend_class_entry *ce = zobj->ce;
 	zend_class_entry *orig_fake_scope = EG(fake_scope);
-	zend_fcall_info fci;
-	zend_fcall_info_cache fcic;
 	zval member;
 
 	EG(fake_scope) = NULL;
 
-	/* __isset handler is called with one argument:
-	      property name
-
-	   it should return whether the property is set or not
-	*/
-
 	ZVAL_STR(&member, prop_name);
-
-	fci.size = sizeof(fci);
-	fci.object = zobj;
-	fci.retval = retval;
-	fci.param_count = 1;
-	fci.params = &member;
-	fci.no_separation = 1;
-	ZVAL_UNDEF(&fci.function_name); /* Unused */
-
-	fcic.function_handler = ce->__isset;
-	fcic.called_scope = ce;
-	fcic.object = zobj;
-
-	zend_call_function(&fci, &fcic);
+	zend_call_known_instance_method_with_1_params(zobj->ce->__isset, zobj, retval, &member);
 
 	EG(fake_scope) = orig_fake_scope;
 }
@@ -1803,7 +1714,7 @@ ZEND_API int zend_std_cast_object_tostring(zend_object *readobj, zval *writeobj,
 				zend_class_entry *fake_scope = EG(fake_scope);
 				EG(fake_scope) = NULL;
 				GC_ADDREF(readobj);
-				zend_call_method_with_0_params(readobj, ce, &ce->__tostring, "__tostring", &retval);
+				zend_call_known_instance_method_with_0_params(ce->__tostring, readobj, &retval);
 				zend_object_release(readobj);
 				EG(fake_scope) = fake_scope;
 				if (EXPECTED(Z_TYPE(retval) == IS_STRING)) {