feat(wasip3): implement wasi:sockets (#11291)

* chore(wasip3): update `wasi:sockets` WIT

pull in `wasi:sockets` from
WebAssembly/wasi-sockets#126

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: rearrange Ctx/View

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: name modules after packages

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: move `Network` to `p2`

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* feat(wasip3): implement `wasi:sockets`

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: reuse socket utilities

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* test(wasip3): allow name resolution to fail

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* fix: expect macos-only var to be unused on other OSes

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: whole buffer is written for UDP

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* undo non-blocking write

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* extract buf capacity const, refactor tcp receive

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* introduce container struct for TCP non-inherited opts

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* handle `listen` receiver close

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: clean up

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* adapt to API changes

prtest:full

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: check for listen receiver close each iteration

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* Try to make test less flaky

* Cut down on `#[cfg]` required for wasi:sockets

* Fix test for real this time

---------

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
Co-authored-by: Alex Crichton <alex@alexcrichton.com>

Author: rvolosatovs

ci/vendor-wit.sh

@@ -73,7 +73,7 @@ make_vendor "wasi/src/p3" "
     clocks@13d1c82@wit-0.3.0-draft
     filesystem@e2a2ddc@wit-0.3.0-draft
     random@4e94663@wit-0.3.0-draft
-    sockets@bb247e2@wit-0.3.0-draft
+    sockets@e863ee2@wit-0.3.0-draft
 "
 
 rm -rf $cache_dir

crates/test-programs/src/bin/p3_sockets_ip_name_lookup.rs

@@ -0,0 +1,102 @@
+use futures::join;
+use test_programs::p3::wasi::sockets::ip_name_lookup::{ErrorCode, resolve_addresses};
+use test_programs::p3::wasi::sockets::types::IpAddress;
+
+struct Component;
+
+test_programs::p3::export!(Component);
+
+async fn resolve_one(name: &str) -> Result<IpAddress, ErrorCode> {
+    Ok(resolve_addresses(name.into())
+        .await?
+        .first()
+        .unwrap()
+        .to_owned())
+}
+
+impl test_programs::p3::exports::wasi::cli::run::Guest for Component {
+    async fn run() -> Result<(), ()> {
+        // Valid domains
+        let (res0, res1) = join!(
+            resolve_addresses("localhost".into()),
+            resolve_addresses("example.com".into())
+        );
+        if res0.is_err() && res1.is_err() {
+            panic!("should have been able to resolve at least one domain");
+        }
+
+        // NB: this is an actual real resolution, so it might time out, might cause
+        // issues, etc. This result is ignored to prevent flaky failures in CI.
+        let _ = resolve_addresses("münchen.de".into()).await;
+
+        // Valid IP addresses
+        assert_eq!(
+            resolve_one("0.0.0.0").await.unwrap(),
+            IpAddress::IPV4_UNSPECIFIED
+        );
+        assert_eq!(
+            resolve_one("127.0.0.1").await.unwrap(),
+            IpAddress::IPV4_LOOPBACK
+        );
+        assert_eq!(
+            resolve_one("192.0.2.0").await.unwrap(),
+            IpAddress::Ipv4((192, 0, 2, 0))
+        );
+        assert_eq!(
+            resolve_one("::").await.unwrap(),
+            IpAddress::IPV6_UNSPECIFIED
+        );
+        assert_eq!(resolve_one("::1").await.unwrap(), IpAddress::IPV6_LOOPBACK);
+        assert_eq!(
+            resolve_one("[::]").await.unwrap(),
+            IpAddress::IPV6_UNSPECIFIED
+        );
+        assert_eq!(
+            resolve_one("2001:0db8:0:0:0:0:0:0").await.unwrap(),
+            IpAddress::Ipv6((0x2001, 0x0db8, 0, 0, 0, 0, 0, 0))
+        );
+        assert_eq!(
+            resolve_one("dead:beef::").await.unwrap(),
+            IpAddress::Ipv6((0xdead, 0xbeef, 0, 0, 0, 0, 0, 0))
+        );
+        assert_eq!(
+            resolve_one("dead:beef::0").await.unwrap(),
+            IpAddress::Ipv6((0xdead, 0xbeef, 0, 0, 0, 0, 0, 0))
+        );
+        assert_eq!(
+            resolve_one("DEAD:BEEF::0").await.unwrap(),
+            IpAddress::Ipv6((0xdead, 0xbeef, 0, 0, 0, 0, 0, 0))
+        );
+
+        // Invalid inputs
+        assert_eq!(
+            resolve_addresses("".into()).await.unwrap_err(),
+            ErrorCode::InvalidArgument
+        );
+        assert_eq!(
+            resolve_addresses(" ".into()).await.unwrap_err(),
+            ErrorCode::InvalidArgument
+        );
+        assert_eq!(
+            resolve_addresses("a.b<&>".into()).await.unwrap_err(),
+            ErrorCode::InvalidArgument
+        );
+        assert_eq!(
+            resolve_addresses("127.0.0.1:80".into()).await.unwrap_err(),
+            ErrorCode::InvalidArgument
+        );
+        assert_eq!(
+            resolve_addresses("[::]:80".into()).await.unwrap_err(),
+            ErrorCode::InvalidArgument
+        );
+        assert_eq!(
+            resolve_addresses("http://example.com/".into())
+                .await
+                .unwrap_err(),
+            ErrorCode::InvalidArgument
+        );
+        Ok(())
+    }
+}
+
+fn main() {}

crates/test-programs/src/bin/p3_sockets_tcp_bind.rs

@@ -0,0 +1,202 @@
+use futures::join;
+use test_programs::p3::sockets::attempt_random_port;
+use test_programs::p3::wasi::sockets::types::{
+    ErrorCode, IpAddress, IpAddressFamily, IpSocketAddress, TcpSocket,
+};
+use test_programs::p3::wit_stream;
+use wit_bindgen::yield_blocking;
+
+struct Component;
+
+test_programs::p3::export!(Component);
+
+/// Bind a socket and let the system determine a port.
+fn test_tcp_bind_ephemeral_port(ip: IpAddress) {
+    let bind_addr = IpSocketAddress::new(ip, 0);
+
+    let sock = TcpSocket::new(ip.family());
+    sock.bind(bind_addr).unwrap();
+
+    let bound_addr = sock.local_address().unwrap();
+
+    assert_eq!(bind_addr.ip(), bound_addr.ip());
+    assert_ne!(bind_addr.port(), bound_addr.port());
+}
+
+/// Bind a socket on a specified port.
+fn test_tcp_bind_specific_port(ip: IpAddress) {
+    let sock = TcpSocket::new(ip.family());
+
+    let bind_addr = attempt_random_port(ip, |bind_addr| sock.bind(bind_addr)).unwrap();
+
+    let bound_addr = sock.local_address().unwrap();
+
+    assert_eq!(bind_addr.ip(), bound_addr.ip());
+    assert_eq!(bind_addr.port(), bound_addr.port());
+}
+
+/// Two sockets may not be actively bound to the same address at the same time.
+fn test_tcp_bind_addrinuse(ip: IpAddress) {
+    let bind_addr = IpSocketAddress::new(ip, 0);
+
+    let sock1 = TcpSocket::new(ip.family());
+    sock1.bind(bind_addr).unwrap();
+    sock1.listen().unwrap();
+
+    let bound_addr = sock1.local_address().unwrap();
+
+    let sock2 = TcpSocket::new(ip.family());
+    assert_eq!(sock2.bind(bound_addr), Err(ErrorCode::AddressInUse));
+}
+
+// The WASI runtime should set SO_REUSEADDR for us
+async fn test_tcp_bind_reuseaddr(ip: IpAddress) {
+    let client = TcpSocket::new(ip.family());
+
+    let bind_addr = {
+        let listener1 = TcpSocket::new(ip.family());
+
+        let bind_addr = attempt_random_port(ip, |bind_addr| listener1.bind(bind_addr)).unwrap();
+
+        let mut accept = listener1.listen().unwrap();
+
+        let connect_addr =
+            IpSocketAddress::new(IpAddress::new_loopback(ip.family()), bind_addr.port());
+        join!(
+            async {
+                client.connect(connect_addr).await.unwrap();
+            },
+            async {
+                let sock = accept.next().await.unwrap();
+                let (mut data_tx, data_rx) = wit_stream::new();
+                join!(
+                    async {
+                        sock.send(data_rx).await.unwrap();
+                    },
+                    async {
+                        let remaining = data_tx.write_all(vec![0; 10]).await;
+                        assert!(remaining.is_empty());
+                        drop(data_tx);
+                    }
+                );
+            },
+        );
+
+        bind_addr
+    };
+
+    // If SO_REUSEADDR was configured correctly, the following lines
+    // shouldn't be affected by the TIME_WAIT state of the just closed
+    // `listener1` socket.
+    //
+    // Note though that the way things are modeled in Wasmtime right now is that
+    // the TCP socket is kept alive by a spawned task created in `listen`
+    // meaning that to fully close the socket it requires the spawned task to
+    // shut down. That may require yielding to the host or similar so try a few
+    // times to let the host get around to closing the task while testing each
+    // time to see if we can reuse the address. This loop is bounded because it
+    // should complete "quickly".
+    for _ in 0..10 {
+        let listener2 = TcpSocket::new(ip.family());
+        if listener2.bind(bind_addr).is_ok() {
+            listener2.listen().unwrap();
+            return;
+        }
+        yield_blocking();
+    }
+
+    panic!("looks like REUSEADDR isn't in use?");
+}
+
+// Try binding to an address that is not configured on the system.
+fn test_tcp_bind_addrnotavail(ip: IpAddress) {
+    let bind_addr = IpSocketAddress::new(ip, 0);
+
+    let sock = TcpSocket::new(ip.family());
+
+    assert_eq!(sock.bind(bind_addr), Err(ErrorCode::AddressNotBindable));
+}
+
+/// Bind should validate the address family.
+fn test_tcp_bind_wrong_family(family: IpAddressFamily) {
+    let wrong_ip = match family {
+        IpAddressFamily::Ipv4 => IpAddress::IPV6_LOOPBACK,
+        IpAddressFamily::Ipv6 => IpAddress::IPV4_LOOPBACK,
+    };
+
+    let sock = TcpSocket::new(family);
+    let result = sock.bind(IpSocketAddress::new(wrong_ip, 0));
+
+    assert!(matches!(result, Err(ErrorCode::InvalidArgument)));
+}
+
+/// Bind only works on unicast addresses.
+fn test_tcp_bind_non_unicast() {
+    let ipv4_broadcast = IpSocketAddress::new(IpAddress::IPV4_BROADCAST, 0);
+    let ipv4_multicast = IpSocketAddress::new(IpAddress::Ipv4((224, 254, 0, 0)), 0);
+    let ipv6_multicast = IpSocketAddress::new(IpAddress::Ipv6((0xff00, 0, 0, 0, 0, 0, 0, 0)), 0);
+
+    let sock_v4 = TcpSocket::new(IpAddressFamily::Ipv4);
+    let sock_v6 = TcpSocket::new(IpAddressFamily::Ipv6);
+
+    assert!(matches!(
+        sock_v4.bind(ipv4_broadcast),
+        Err(ErrorCode::InvalidArgument)
+    ));
+    assert!(matches!(
+        sock_v4.bind(ipv4_multicast),
+        Err(ErrorCode::InvalidArgument)
+    ));
+    assert!(matches!(
+        sock_v6.bind(ipv6_multicast),
+        Err(ErrorCode::InvalidArgument)
+    ));
+}
+
+fn test_tcp_bind_dual_stack() {
+    let sock = TcpSocket::new(IpAddressFamily::Ipv6);
+    let addr = IpSocketAddress::new(IpAddress::IPV4_MAPPED_LOOPBACK, 0);
+
+    // Binding an IPv4-mapped-IPv6 address on a ipv6-only socket should fail:
+    assert!(matches!(sock.bind(addr), Err(ErrorCode::InvalidArgument)));
+}
+
+impl test_programs::p3::exports::wasi::cli::run::Guest for Component {
+    async fn run() -> Result<(), ()> {
+        const RESERVED_IPV4_ADDRESS: IpAddress = IpAddress::Ipv4((192, 0, 2, 0)); // Reserved for documentation and examples.
+        const RESERVED_IPV6_ADDRESS: IpAddress =
+            IpAddress::Ipv6((0x2001, 0x0db8, 0, 0, 0, 0, 0, 0)); // Reserved for documentation and examples.
+
+        test_tcp_bind_ephemeral_port(IpAddress::IPV4_LOOPBACK);
+        test_tcp_bind_ephemeral_port(IpAddress::IPV6_LOOPBACK);
+        test_tcp_bind_ephemeral_port(IpAddress::IPV4_UNSPECIFIED);
+        test_tcp_bind_ephemeral_port(IpAddress::IPV6_UNSPECIFIED);
+
+        test_tcp_bind_specific_port(IpAddress::IPV4_LOOPBACK);
+        test_tcp_bind_specific_port(IpAddress::IPV6_LOOPBACK);
+        test_tcp_bind_specific_port(IpAddress::IPV4_UNSPECIFIED);
+        test_tcp_bind_specific_port(IpAddress::IPV6_UNSPECIFIED);
+
+        test_tcp_bind_reuseaddr(IpAddress::IPV4_LOOPBACK).await;
+        test_tcp_bind_reuseaddr(IpAddress::IPV6_LOOPBACK).await;
+
+        test_tcp_bind_addrinuse(IpAddress::IPV4_LOOPBACK);
+        test_tcp_bind_addrinuse(IpAddress::IPV6_LOOPBACK);
+        test_tcp_bind_addrinuse(IpAddress::IPV4_UNSPECIFIED);
+        test_tcp_bind_addrinuse(IpAddress::IPV6_UNSPECIFIED);
+
+        test_tcp_bind_addrnotavail(RESERVED_IPV4_ADDRESS);
+        test_tcp_bind_addrnotavail(RESERVED_IPV6_ADDRESS);
+
+        test_tcp_bind_wrong_family(IpAddressFamily::Ipv4);
+        test_tcp_bind_wrong_family(IpAddressFamily::Ipv6);
+
+        test_tcp_bind_non_unicast();
+
+        test_tcp_bind_dual_stack();
+
+        Ok(())
+    }
+}
+
+fn main() {}