Refactor the sockets_utils.h headers (#729)

This commit refactors the helpers for TCP/UDP which predated much of the
work around WASIp2-natively-in-libc. Changes here are:

* Helpers to use `__wasilibc_*` prefix that many other internal
functions in wasi-libc use.
* Helpers directly set `errno` instead of returning a `bool` and
requiring the caller to set `errno`.
* Some helpers were renamed/tweaked to be a bit more idiomatic with C.

Author: alexcrichton

expected/wasm32-wasip2/defined-symbols.txt

@@ -290,16 +290,7 @@ __uselocale
 __utc
 __wasi_init_tp
 __wasi_sockets_services_db
-__wasi_sockets_utils__any_addr
 __wasi_sockets_utils__borrow_network
-__wasi_sockets_utils__get_service_entry_by_name
-__wasi_sockets_utils__get_service_entry_by_port
-__wasi_sockets_utils__map_error
-__wasi_sockets_utils__output_addr_validate
-__wasi_sockets_utils__output_addr_write
-__wasi_sockets_utils__parse_address
-__wasi_sockets_utils__parse_port
-__wasi_sockets_utils__posix_family
 __wasilibc_access
 __wasilibc_add_file
 __wasilibc_add_tcp_socket
@@ -314,12 +305,15 @@ __wasilibc_find_abspath
 __wasilibc_find_relpath
 __wasilibc_find_relpath_alloc
 __wasilibc_get_environ
+__wasilibc_get_service_entry_by_name
+__wasilibc_get_service_entry_by_port
 __wasilibc_iftodt
 __wasilibc_init_stdio
 __wasilibc_initialize_environ
 __wasilibc_link
 __wasilibc_link_newat
 __wasilibc_link_oldat
+__wasilibc_map_socket_error
 __wasilibc_maybe_reinitialize_environ_eagerly
 __wasilibc_nocwd___wasilibc_rmdirat
 __wasilibc_nocwd___wasilibc_unlinkat
@@ -335,6 +329,7 @@ __wasilibc_nocwd_scandirat
 __wasilibc_nocwd_symlinkat
 __wasilibc_nocwd_utimensat
 __wasilibc_open_nomode
+__wasilibc_parse_port
 __wasilibc_poll_add
 __wasilibc_poll_ready
 __wasilibc_populate_preopens
@@ -345,10 +340,15 @@ __wasilibc_rename_newat
 __wasilibc_rename_oldat
 __wasilibc_reset_preopens
 __wasilibc_rmdirat
+__wasilibc_sockaddr_to_wasi
+__wasilibc_sockaddr_validate
 __wasilibc_stat
 __wasilibc_tell
 __wasilibc_unlinkat
+__wasilibc_unspecified_addr
 __wasilibc_utimens
+__wasilibc_wasi_family_to_libc
+__wasilibc_wasi_to_sockaddr
 __wasilibc_write_stream
 __wasm_call_dtors
 __wcscoll_l

expected/wasm32-wasip3/defined-symbols.txt

@@ -289,15 +289,6 @@ __uselocale
 __utc
 __wasi_init_tp
 __wasi_sockets_services_db
-__wasi_sockets_utils__any_addr
-__wasi_sockets_utils__get_service_entry_by_name
-__wasi_sockets_utils__get_service_entry_by_port
-__wasi_sockets_utils__map_error
-__wasi_sockets_utils__output_addr_validate
-__wasi_sockets_utils__output_addr_write
-__wasi_sockets_utils__parse_address
-__wasi_sockets_utils__parse_port
-__wasi_sockets_utils__posix_family
 __wasilibc_access
 __wasilibc_add_file
 __wasilibc_add_tcp_socket
@@ -312,12 +303,15 @@ __wasilibc_find_abspath
 __wasilibc_find_relpath
 __wasilibc_find_relpath_alloc
 __wasilibc_get_environ
+__wasilibc_get_service_entry_by_name
+__wasilibc_get_service_entry_by_port
 __wasilibc_iftodt
 __wasilibc_init_stdio
 __wasilibc_initialize_environ
 __wasilibc_link
 __wasilibc_link_newat
 __wasilibc_link_oldat
+__wasilibc_map_socket_error
 __wasilibc_maybe_reinitialize_environ_eagerly
 __wasilibc_nocwd___wasilibc_rmdirat
 __wasilibc_nocwd___wasilibc_unlinkat
@@ -333,6 +327,7 @@ __wasilibc_nocwd_scandirat
 __wasilibc_nocwd_symlinkat
 __wasilibc_nocwd_utimensat
 __wasilibc_open_nomode
+__wasilibc_parse_port
 __wasilibc_populate_preopens
 __wasilibc_pthread_self
 __wasilibc_random
@@ -341,10 +336,15 @@ __wasilibc_rename_newat
 __wasilibc_rename_oldat
 __wasilibc_reset_preopens
 __wasilibc_rmdirat
+__wasilibc_sockaddr_to_wasi
+__wasilibc_sockaddr_validate
 __wasilibc_stat
 __wasilibc_tell
 __wasilibc_unlinkat
+__wasilibc_unspecified_addr
 __wasilibc_utimens
+__wasilibc_wasi_family_to_libc
+__wasilibc_wasi_to_sockaddr
 __wasilibc_write_stream3
 __wasm_call_dtors
 __wcscoll_l

libc-bottom-half/headers/private/wasi/sockets_utils.h

@@ -55,21 +55,36 @@ typedef enum {
 network_borrow_network_t __wasi_sockets_utils__borrow_network();
 #endif
 
-int __wasi_sockets_utils__map_error(sockets_error_code_t wasi_error);
-bool __wasi_sockets_utils__parse_address(
+int __wasilibc_map_socket_error(sockets_error_code_t wasi_error);
+
+static inline int __wasilibc_socket_error_to_errno(sockets_error_code_t wasi_error) {
+  errno = __wasilibc_map_socket_error(wasi_error);
+  return -1;
+}
+
+// Conversion from a libc-based `sockaddr` + `socklen_t` to a WASI address.
+int __wasilibc_sockaddr_to_wasi(
 	sockets_ip_address_family_t expected_family,
 	const struct sockaddr *address, socklen_t len,
-	sockets_ip_socket_address_t *result, int *error);
-bool __wasi_sockets_utils__output_addr_validate(
+	sockets_ip_socket_address_t *result);
+
+// Conversion from a WASI address to a libc-based `sockaddr`.
+//
+// This is done in two stages. First the user-provided `sockaddr` is validated
+// along with its lenght to ensure it's large enough to hold `expected_family`.
+// Next once the address is available `__wasilibc_wasi_to_sockaddr` is used
+// to write the output value.
+int __wasilibc_sockaddr_validate(
 	sockets_ip_address_family_t expected_family, struct sockaddr *addr,
 	socklen_t *addrlen, output_sockaddr_t *result);
-void __wasi_sockets_utils__output_addr_write(
+void __wasilibc_wasi_to_sockaddr(
 	const sockets_ip_socket_address_t input, output_sockaddr_t *output);
-int __wasi_sockets_utils__posix_family(sockets_ip_address_family_t wasi_family);
-sockets_ip_socket_address_t __wasi_sockets_utils__any_addr(sockets_ip_address_family_t family);
-int __wasi_sockets_utils__parse_port(const char *port);
-const service_entry_t *__wasi_sockets_utils__get_service_entry_by_name(const char *name);
-const service_entry_t *__wasi_sockets_utils__get_service_entry_by_port(const uint16_t port);
+
+int __wasilibc_wasi_family_to_libc(sockets_ip_address_family_t wasi_family);
+void __wasilibc_unspecified_addr(sockets_ip_address_family_t family, sockets_ip_socket_address_t *out);
+int __wasilibc_parse_port(const char *port);
+const service_entry_t *__wasilibc_get_service_entry_by_name(const char *name);
+const service_entry_t *__wasilibc_get_service_entry_by_port(const uint16_t port);
 
 #endif // not(__wasip1__)
 

libc-bottom-half/sources/netdb.c

@@ -26,7 +26,7 @@ static int map_error(ip_name_lookup_error_code_t error) {
     return EAI_FAIL;
 
   default:
-    errno = __wasi_sockets_utils__map_error(error);
+    __wasilibc_socket_error_to_errno(error);
     return EAI_SYSTEM;
   }
 }
@@ -185,10 +185,10 @@ int getaddrinfo(const char *restrict host, const char *restrict serv,
   int port = 0;
   uint16_t protocol = SERVICE_PROTOCOL_TCP;
   if (serv != NULL) {
-    port = __wasi_sockets_utils__parse_port(serv);
+    port = __wasilibc_parse_port(serv);
     if (port < 0) {
       const service_entry_t *service =
-          __wasi_sockets_utils__get_service_entry_by_name(serv);
+          __wasilibc_get_service_entry_by_name(serv);
       if (service) {
         port = service->port;
         protocol = service->protocol;
@@ -271,8 +271,7 @@ const char *hstrerror(int err) {
 }
 
 struct servent *getservbyname(const char *name, const char *proto) {
-  const service_entry_t *entry =
-      __wasi_sockets_utils__get_service_entry_by_name(name);
+  const service_entry_t *entry = __wasilibc_get_service_entry_by_name(name);
   if (!set_global_serv_entry(entry, proto)) {
     return NULL;
   }
@@ -281,7 +280,7 @@ struct servent *getservbyname(const char *name, const char *proto) {
 
 struct servent *getservbyport(int port, const char *proto) {
   const service_entry_t *entry =
-      __wasi_sockets_utils__get_service_entry_by_port(htons(port));
+      __wasilibc_get_service_entry_by_port(htons(port));
   if (!set_global_serv_entry(entry, proto)) {
     return NULL;
   }

libc-bottom-half/sources/socket.c

@@ -15,21 +15,17 @@
 static int tcp_socket(sockets_ip_address_family_t family, bool blocking) {
   sockets_error_code_t error;
   sockets_own_tcp_socket_t socket;
-  if (!sockets_static_tcp_socket_create(family, &socket, &error)) {
-    errno = __wasi_sockets_utils__map_error(error);
-    return -1;
-  }
+  if (!sockets_static_tcp_socket_create(family, &socket, &error))
+    return __wasilibc_socket_error_to_errno(error);
 
   return __wasilibc_add_tcp_socket(socket, family, blocking);
 }
 
 static int udp_socket(sockets_ip_address_family_t family, bool blocking) {
   sockets_error_code_t error;
   sockets_own_udp_socket_t socket;
-  if (!sockets_static_udp_socket_create(family, &socket, &error)) {
-    errno = __wasi_sockets_utils__map_error(error);
-    return -1;
-  }
+  if (!sockets_static_udp_socket_create(family, &socket, &error))
+    return __wasilibc_socket_error_to_errno(error);
 
   return __wasilibc_add_udp_socket(socket, family, blocking);
 }