error_code as reference optional argument

Author: devnexen

Zend/Optimizer/zend_func_infos.h

@@ -373,7 +373,7 @@ static const func_info_t func_infos[] = {
 	F1("session_cache_limiter", MAY_BE_STRING|MAY_BE_FALSE),
 	F1("socket_get_option", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_ANY|MAY_BE_LONG|MAY_BE_FALSE),
 	FN("socket_export_stream", MAY_BE_RESOURCE|MAY_BE_FALSE),
-	F1("socket_addrinfo_lookup", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_OBJECT|MAY_BE_LONG),
+	F1("socket_addrinfo_lookup", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_OBJECT|MAY_BE_FALSE),
 	F1("socket_addrinfo_explain", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_STRING|MAY_BE_ARRAY_OF_LONG|MAY_BE_ARRAY_OF_STRING|MAY_BE_ARRAY_OF_ARRAY),
 	FN("sodium_crypto_kx_client_session_keys", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),
 	FN("sodium_crypto_kx_server_session_keys", MAY_BE_ARRAY|MAY_BE_ARRAY_KEY_LONG|MAY_BE_ARRAY_OF_STRING),

ext/sockets/sockets.c

@@ -2730,17 +2730,18 @@ PHP_FUNCTION(socket_addrinfo_lookup)
 	char *service = NULL;
 	size_t service_len = 0;
 	zend_string *hostname, *key;
-	zval *hint, *zhints = NULL;
+	zval *hint, *zhints = NULL, *error_code = NULL;
 	int ret = 0;
 
 	struct addrinfo hints, *result, *rp;
 	php_addrinfo *res;
 
-	ZEND_PARSE_PARAMETERS_START(1, 3)
+	ZEND_PARSE_PARAMETERS_START(1, 4)
 		Z_PARAM_STR(hostname)
 		Z_PARAM_OPTIONAL
 		Z_PARAM_STRING_OR_NULL(service, service_len)
 		Z_PARAM_ARRAY(zhints)
+		Z_PARAM_ZVAL_OR_NULL(error_code)
 	ZEND_PARSE_PARAMETERS_END();
 
 	memset(&hints, 0, sizeof(hints));
@@ -2827,7 +2828,10 @@ PHP_FUNCTION(socket_addrinfo_lookup)
 	}
 
 	if ((ret = getaddrinfo(ZSTR_VAL(hostname), service, &hints, &result)) != 0) {
-		RETURN_LONG(ret);
+		if (error_code) {
+			ZEND_TRY_ASSIGN_REF_LONG(error_code, ret);
+		}
+		RETURN_FALSE;
 	}
 
 	array_init(return_value);

ext/sockets/sockets.stub.php

@@ -2302,10 +2302,11 @@ function socket_recvmsg(Socket $socket, array &$message, int $flags = 0): int|fa
 function socket_cmsg_space(int $level, int $type, int $num = 0): ?int {}
 
 /**
- * @return array<int, AddressInfo>|int
+ * @return array<int, AddressInfo>|false
+ * @param int $error_code
  * @refcount 1
  */
-function socket_addrinfo_lookup(string $host, ?string $service = null, array $hints = []): array|int {}
+function socket_addrinfo_lookup(string $host, ?string $service = null, array $hints = [], &$error_code = null): array|false {}
 
 function socket_addrinfo_connect(AddressInfo $address): Socket|false {}
 

ext/sockets/sockets_arginfo.h

@@ -4,9 +4,10 @@ GH-20562 - socket_addrinfo_lookup() returns error codes on resolution failures.
 sockets
 --FILE--
 <?php
-var_dump(socket_addrinfo_lookup(".whynot") == EAI_NONAME);
-var_dump(in_array(socket_addrinfo_lookup("2001:db8::1", null, ['ai_family' => AF_INET]), [EAI_FAMILY, EAI_ADDRFAMILY, EAI_NONAME, EAI_NODATA]));
-var_dump(in_array(socket_addrinfo_lookup("example.com", "http", ['ai_socktype' => SOCK_RAW, 'ai_flags' => 2147483647]), [EAI_SOCKTYPE, EAI_SERVICE, EAI_BADFLAGS, EAI_NONAME]));
+$error_code = 0;
+var_dump(socket_addrinfo_lookup(".whynot", null, [], $error_code) === false && $error_code === EAI_NONAME);
+var_dump(socket_addrinfo_lookup("2001:db8::1", null, ['ai_family' => AF_INET], $error_code) === false && in_array($error_code, [EAI_FAMILY, EAI_ADDRFAMILY, EAI_NONAME, EAI_NODATA]));
+var_dump(socket_addrinfo_lookup("example.com", "http", ['ai_socktype' => SOCK_RAW, 'ai_flags' => 2147483647], $error_code) === false && in_array($error_code, [EAI_SOCKTYPE, EAI_SERVICE, EAI_BADFLAGS, EAI_NONAME]));
 ?>
 --EXPECT--
 bool(true)