Skip to content

A lightweight WebAssembly runtime that is fast, secure, and standards-compliant

Switch to using `wkg` for most WIT vendoring (#12327)

Alex Crichton89adcf35876d
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 75583d9154..730ef0a197 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -508,6 +508,10 @@ jobs:
# Re-vendor all WIT files and ensure that they're all up-to-date by ensuring
# that there's no git changes.
+ - name: Install wkg
+ run: |
+ curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
+ cargo binstall --no-confirm wkg
- name: Re-vendor WIT
run: ./ci/vendor-wit.sh
- run: git diff --exit-code
diff --git a/ci/vendor-wit.sh b/ci/vendor-wit.sh
index 23fa1e4bba..4dd3aa883d 100755
--- a/ci/vendor-wit.sh
+++ b/ci/vendor-wit.sh
@@ -1,96 +1,97 @@
#!/usr/bin/env bash
-# Script to re-vendor the WIT files that Wasmtime uses as defined by a
-# particular tag in upstream repositories.
+# Script to re-vendor the WIT files that Wasmtime uses using wkg to fetch
+# packages from the OCI registry.
#
# This script is executed on CI to ensure that everything is up-to-date.
set -ex
-# The make_vendor function takes a base path (e.g., "wasi") and a list
-# of packages in the format "name@tag". It constructs the full destination
-# path, downloads the tarballs from GitHub, extracts the relevant files, and
-# removes any unwanted directories.
-make_vendor() {
- local name=$1
- local packages=$2
- local path="crates/$name/wit/deps"
-
- rm -rf $path
- mkdir -p $path
-
- for package in $packages; do
- IFS='@' read -r repo tag subdir <<< "$package"
- mkdir -p "$path/$repo"
- cached_extracted_dir="$cache_dir/$repo-$tag"
-
- if [[ ! -d $cached_extracted_dir ]]; then
- mkdir -p $cached_extracted_dir
- curl --retry 5 --retry-all-errors -sLO https://github.com/WebAssembly/wasi-$repo/archive/$tag.tar.gz
- tar xzf $tag.tar.gz --strip-components=1 -C $cached_extracted_dir
- rm $tag.tar.gz
- rm -rf $cached_extracted_dir/${subdir:-"wit"}/deps*
- fi
-
- cp -r $cached_extracted_dir/${subdir:-"wit"}/* $path/$repo
- done
-}
-
+# Temporary directory for downloads
cache_dir=$(mktemp -d)
+trap "rm -rf $cache_dir" EXIT
+
+# Helper to download the `WebAssembly/$repo` dir at the `$tag` (or rev)
+# specified. The `wit/*.wit` files are placed in `$path`.
+get_github() {
+ local repo=$1
+ local tag=$2
+ local path=$3
+
+ rm -rf "$path"
+ mkdir -p "$path"
+
+ cached_extracted_dir="$cache_dir/$repo-$tag"
+
+ if [[ ! -d $cached_extracted_dir ]]; then
+ mkdir -p $cached_extracted_dir
+ curl --retry 5 --retry-all-errors -sLO https://github.com/WebAssembly/$repo/archive/$tag.tar.gz
+ tar xzf $tag.tar.gz --strip-components=1 -C $cached_extracted_dir
+ rm $tag.tar.gz
+ rm -rf $cached_extracted_dir/wit/deps*
+ fi
+
+ cp -r $cached_extracted_dir/wit/* $path
+}
-make_vendor "wasi-io" "
-"
-
-make_vendor "wasi/src/p2" "
-"
-
-make_vendor "wasi-http" "
-"
-
-make_vendor "wasi-tls" "
-"
-
-make_vendor "wasi-config" "[email protected]"
-
-make_vendor "wasi-keyvalue" "keyvalue@219ea36"
-
-make_vendor "wasi/src/p3" "
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
-"
-
-make_vendor "wasi-http/src/p3" "
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
- [email protected]@wit-0.3.0-draft
-"
-
-rm -rf $cache_dir
-
-# Separately (for now), vendor the `wasi-nn` WIT files since their retrieval is
-# slightly different than above.
+p2=0.2.6
+p3=0.3.0-rc-2025-09-16
+
+rm -rf crates/wasi-io/wit/deps
+mkdir -p crates/wasi-io/wit/deps
+wkg get --format wit --overwrite "wasi:io@$p2" -o "crates/wasi-io/wit/deps/io.wit"
+
+rm -rf crates/wasi/src/p2/wit/deps
+mkdir -p crates/wasi/src/p2/wit/deps
+wkg get --format wit --overwrite "wasi:io@$p2" -o "crates/wasi/src/p2/wit/deps/io.wit"
+wkg get --format wit --overwrite "wasi:clocks@$p2" -o "crates/wasi/src/p2/wit/deps/clocks.wit"
+wkg get --format wit --overwrite "wasi:cli@$p2" -o "crates/wasi/src/p2/wit/deps/cli.wit"
+wkg get --format wit --overwrite "wasi:filesystem@$p2" -o "crates/wasi/src/p2/wit/deps/filesystem.wit"
+wkg get --format wit --overwrite "wasi:random@$p2" -o "crates/wasi/src/p2/wit/deps/random.wit"
+wkg get --format wit --overwrite "wasi:sockets@$p2" -o "crates/wasi/src/p2/wit/deps/sockets.wit"
+
+rm -rf crates/wasi-http/wit/deps
+mkdir -p crates/wasi-http/wit/deps
+wkg get --format wit --overwrite "wasi:io@$p2" -o "crates/wasi-http/wit/deps/io.wit"
+wkg get --format wit --overwrite "wasi:clocks@$p2" -o "crates/wasi-http/wit/deps/clocks.wit"
+wkg get --format wit --overwrite "wasi:cli@$p2" -o "crates/wasi-http/wit/deps/cli.wit"
+wkg get --format wit --overwrite "wasi:filesystem@$p2" -o "crates/wasi-http/wit/deps/filesystem.wit"
+wkg get --format wit --overwrite "wasi:random@$p2" -o "crates/wasi-http/wit/deps/random.wit"
+wkg get --format wit --overwrite "wasi:sockets@$p2" -o "crates/wasi-http/wit/deps/sockets.wit"
+wkg get --format wit --overwrite "wasi:http@$p2" -o "crates/wasi-http/wit/deps/http.wit"
+
+
+rm -rf crates/wasi-tls/wit/deps
+mkdir -p crates/wasi-tls/wit/deps
+wkg get --format wit --overwrite "wasi:io@$p2" -o "crates/wasi-tls/wit/deps/io.wit"
+get_github wasi-tls v0.2.0-draft+505fc98 crates/wasi-tls/wit/deps/tls
+
+rm -rf crates/wasi-config/wit/deps
+mkdir -p crates/wasi-config/wit/deps
+get_github wasi-config v0.2.0-rc.1 crates/wasi-config/wit/deps/config
+
+rm -rf crates/wasi-keyvalue/wit/deps
+mkdir -p crates/wasi-keyvalue/wit/deps
+get_github wasi-keyvalue 219ea36 crates/wasi-keyvalue/wit/deps/keyvalue
+
+rm -rf crates/wasi/src/p3/wit/deps
+mkdir -p crates/wasi/src/p3/wit/deps
+wkg get --format wit --overwrite "wasi:clocks@$p3" -o "crates/wasi/src/p3/wit/deps/clocks.wit"
+wkg get --format wit --overwrite "wasi:cli@$p3" -o "crates/wasi/src/p3/wit/deps/cli.wit"
+wkg get --format wit --overwrite "wasi:filesystem@$p3" -o "crates/wasi/src/p3/wit/deps/filesystem.wit"
+wkg get --format wit --overwrite "wasi:random@$p3" -o "crates/wasi/src/p3/wit/deps/random.wit"
+wkg get --format wit --overwrite "wasi:sockets@$p3" -o "crates/wasi/src/p3/wit/deps/sockets.wit"
+
+rm -rf crates/wasi-http/src/p3/wit/deps
+mkdir -p crates/wasi-http/src/p3/wit/deps
+wkg get --format wit --overwrite "wasi:clocks@$p3" -o "crates/wasi-http/src/p3/wit/deps/clocks.wit"
+wkg get --format wit --overwrite "wasi:cli@$p3" -o "crates/wasi-http/src/p3/wit/deps/cli.wit"
+wkg get --format wit --overwrite "wasi:filesystem@$p3" -o "crates/wasi-http/src/p3/wit/deps/filesystem.wit"
+wkg get --format wit --overwrite "wasi:random@$p3" -o "crates/wasi-http/src/p3/wit/deps/random.wit"
+wkg get --format wit --overwrite "wasi:sockets@$p3" -o "crates/wasi-http/src/p3/wit/deps/sockets.wit"
+wkg get --format wit --overwrite "wasi:http@$p3" -o "crates/wasi-http/src/p3/wit/deps/http.wit"
+
+# wasi-nn is fetched separately since it's not in the standard WASI registry
repo=https://raw.githubusercontent.com/WebAssembly/wasi-nn
revision=0.2.0-rc-2024-10-28
-curl --retry 5 --retry-all-errors -L $repo/$revision/wasi-nn.witx -o crates/wasi-nn/witx/wasi-nn.witx
-curl --retry 5 --retry-all-errors -L $repo/$revision/wit/wasi-nn.wit -o crates/wasi-nn/wit/wasi-nn.wit
+curl --retry 5 --retry-all-errors -L "$repo/$revision/wasi-nn.witx" -o crates/wasi-nn/witx/wasi-nn.witx
+curl --retry 5 --retry-all-errors -L "$repo/$revision/wit/wasi-nn.wit" -o crates/wasi-nn/wit/wasi-nn.wit
diff --git a/crates/wasi-http/src/p3/wit/deps/cli.wit b/crates/wasi-http/src/p3/wit/deps/cli.wit
new file mode 100644
index 0000000000..5bee32e5a5
--- /dev/null
+++ b/crates/wasi-http/src/p3/wit/deps/cli.wit
@@ -0,0 +1,256 @@
+package wasi:[email protected];
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface environment {
+ /// Get the POSIX-style environment variables.
+ ///
+ /// Each environment variable is provided as a pair of string variable names
+ /// and string value.
+ ///
+ /// Morally, these are a value import, but until value imports are available
+ /// in the component model, this import function should return the same
+ /// values each time it is called.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-environment: func() -> list<tuple<string, string>>;
+
+ /// Get the POSIX-style arguments to the program.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-arguments: func() -> list<string>;
+
+ /// Return a path that programs should use as their initial current working
+ /// directory, interpreting `.` as shorthand for this.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-initial-cwd: func() -> option<string>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface exit {
+ /// Exit the current instance and any linked instances.
+ @since(version = 0.3.0-rc-2025-09-16)
+ exit: func(status: result);
+
+ /// Exit the current instance and any linked instances, reporting the
+ /// specified status code to the host.
+ ///
+ /// The meaning of the code depends on the context, with 0 usually meaning
+ /// "success", and other values indicating various types of failure.
+ ///
+ /// This function does not return; the effect is analogous to a trap, but
+ /// without the connotation that something bad has happened.
+ @unstable(feature = cli-exit-with-code)
+ exit-with-code: func(status-code: u8);
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface run {
+ /// Run the program.
+ @since(version = 0.3.0-rc-2025-09-16)
+ run: async func() -> result;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum error-code {
+ /// Input/output error
+ io,
+ /// Invalid or incomplete multibyte or wide character
+ illegal-byte-sequence,
+ /// Broken pipe
+ pipe,
+ }
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface stdin {
+ use types.{error-code};
+
+ /// Return a stream for reading from stdin.
+ ///
+ /// This function returns a stream which provides data read from stdin,
+ /// and a future to signal read results.
+ ///
+ /// If the stream's readable end is dropped the future will resolve to success.
+ ///
+ /// If the stream's writable end is dropped the future will either resolve to
+ /// success if stdin was closed by the writer or to an error-code if reading
+ /// failed for some other reason.
+ ///
+ /// Multiple streams may be active at the same time. The behavior of concurrent
+ /// reads is implementation-specific.
+ @since(version = 0.3.0-rc-2025-09-16)
+ read-via-stream: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface stdout {
+ use types.{error-code};
+
+ /// Write the given stream to stdout.
+ ///
+ /// If the stream's writable end is dropped this function will either return
+ /// success once the entire contents of the stream have been written or an
+ /// error-code representing a failure.
+ ///
+ /// Otherwise if there is an error the readable end of the stream will be
+ /// dropped and this function will return an error-code.
+ @since(version = 0.3.0-rc-2025-09-16)
+ write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface stderr {
+ use types.{error-code};
+
+ /// Write the given stream to stderr.
+ ///
+ /// If the stream's writable end is dropped this function will either return
+ /// success once the entire contents of the stream have been written or an
+ /// error-code representing a failure.
+ ///
+ /// Otherwise if there is an error the readable end of the stream will be
+ /// dropped and this function will return an error-code.
+ @since(version = 0.3.0-rc-2025-09-16)
+ write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
+}
+
+/// Terminal input.
+///
+/// In the future, this may include functions for disabling echoing,
+/// disabling input buffering so that keyboard events are sent through
+/// immediately, querying supported features, and so on.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-input {
+ /// The input side of a terminal.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource terminal-input;
+}
+
+/// Terminal output.
+///
+/// In the future, this may include functions for querying the terminal
+/// size, being notified of terminal size changes, querying supported
+/// features, and so on.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-output {
+ /// The output side of a terminal.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource terminal-output;
+}
+
+/// An interface providing an optional `terminal-input` for stdin as a
+/// link-time authority.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-stdin {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use terminal-input.{terminal-input};
+
+ /// If stdin is connected to a terminal, return a `terminal-input` handle
+ /// allowing further interaction with it.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-terminal-stdin: func() -> option<terminal-input>;
+}
+
+/// An interface providing an optional `terminal-output` for stdout as a
+/// link-time authority.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-stdout {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use terminal-output.{terminal-output};
+
+ /// If stdout is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-terminal-stdout: func() -> option<terminal-output>;
+}
+
+/// An interface providing an optional `terminal-output` for stderr as a
+/// link-time authority.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-stderr {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use terminal-output.{terminal-output};
+
+ /// If stderr is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-terminal-stderr: func() -> option<terminal-output>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import environment;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import exit;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stderr;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-input;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-output;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stderr;
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+}
+@since(version = 0.3.0-rc-2025-09-16)
+world command {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import environment;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import exit;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stderr;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-input;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-output;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stderr;
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ export run;
+}
diff --git a/crates/wasi-http/src/p3/wit/deps/cli/command.wit b/crates/wasi-http/src/p3/wit/deps/cli/command.wit
deleted file mode 100644
index f2f613e552..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/cli/command.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world command {
- @since(version = 0.3.0-rc-2025-09-16)
- include imports;
-
- @since(version = 0.3.0-rc-2025-09-16)
- export run;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/cli/environment.wit b/crates/wasi-http/src/p3/wit/deps/cli/environment.wit
deleted file mode 100644
index 3763f2f6ce..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/cli/environment.wit
+++ /dev/null
@@ -1,22 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface environment {
- /// Get the POSIX-style environment variables.
- ///
- /// Each environment variable is provided as a pair of string variable names
- /// and string value.
- ///
- /// Morally, these are a value import, but until value imports are available
- /// in the component model, this import function should return the same
- /// values each time it is called.
- @since(version = 0.3.0-rc-2025-09-16)
- get-environment: func() -> list<tuple<string, string>>;
-
- /// Get the POSIX-style arguments to the program.
- @since(version = 0.3.0-rc-2025-09-16)
- get-arguments: func() -> list<string>;
-
- /// Return a path that programs should use as their initial current working
- /// directory, interpreting `.` as shorthand for this.
- @since(version = 0.3.0-rc-2025-09-16)
- get-initial-cwd: func() -> option<string>;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/cli/exit.wit b/crates/wasi-http/src/p3/wit/deps/cli/exit.wit
deleted file mode 100644
index 1efba7d683..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/cli/exit.wit
+++ /dev/null
@@ -1,17 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface exit {
- /// Exit the current instance and any linked instances.
- @since(version = 0.3.0-rc-2025-09-16)
- exit: func(status: result);
-
- /// Exit the current instance and any linked instances, reporting the
- /// specified status code to the host.
- ///
- /// The meaning of the code depends on the context, with 0 usually meaning
- /// "success", and other values indicating various types of failure.
- ///
- /// This function does not return; the effect is analogous to a trap, but
- /// without the connotation that something bad has happened.
- @unstable(feature = cli-exit-with-code)
- exit-with-code: func(status-code: u8);
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/cli/imports.wit b/crates/wasi-http/src/p3/wit/deps/cli/imports.wit
deleted file mode 100644
index 660a2dd95a..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/cli/imports.wit
+++ /dev/null
@@ -1,34 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:clocks/[email protected];
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:filesystem/[email protected];
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:sockets/[email protected];
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:random/[email protected];
-
- @since(version = 0.3.0-rc-2025-09-16)
- import environment;
- @since(version = 0.3.0-rc-2025-09-16)
- import exit;
- @since(version = 0.3.0-rc-2025-09-16)
- import stdin;
- @since(version = 0.3.0-rc-2025-09-16)
- import stdout;
- @since(version = 0.3.0-rc-2025-09-16)
- import stderr;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-input;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-output;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-stdin;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-stdout;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-stderr;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/cli/run.wit b/crates/wasi-http/src/p3/wit/deps/cli/run.wit
deleted file mode 100644
index 631441a3f2..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/cli/run.wit
+++ /dev/null
@@ -1,6 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface run {
- /// Run the program.
- @since(version = 0.3.0-rc-2025-09-16)
- run: async func() -> result;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/cli/stdio.wit b/crates/wasi-http/src/p3/wit/deps/cli/stdio.wit
deleted file mode 100644
index 51e5ae4b40..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/cli/stdio.wit
+++ /dev/null
@@ -1,65 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- @since(version = 0.3.0-rc-2025-09-16)
- enum error-code {
- /// Input/output error
- io,
- /// Invalid or incomplete multibyte or wide character
- illegal-byte-sequence,
- /// Broken pipe
- pipe,
- }
-}
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface stdin {
- use types.{error-code};
-
- /// Return a stream for reading from stdin.
- ///
- /// This function returns a stream which provides data read from stdin,
- /// and a future to signal read results.
- ///
- /// If the stream's readable end is dropped the future will resolve to success.
- ///
- /// If the stream's writable end is dropped the future will either resolve to
- /// success if stdin was closed by the writer or to an error-code if reading
- /// failed for some other reason.
- ///
- /// Multiple streams may be active at the same time. The behavior of concurrent
- /// reads is implementation-specific.
- @since(version = 0.3.0-rc-2025-09-16)
- read-via-stream: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
-}
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface stdout {
- use types.{error-code};
-
- /// Write the given stream to stdout.
- ///
- /// If the stream's writable end is dropped this function will either return
- /// success once the entire contents of the stream have been written or an
- /// error-code representing a failure.
- ///
- /// Otherwise if there is an error the readable end of the stream will be
- /// dropped and this function will return an error-code.
- @since(version = 0.3.0-rc-2025-09-16)
- write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
-}
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface stderr {
- use types.{error-code};
-
- /// Write the given stream to stderr.
- ///
- /// If the stream's writable end is dropped this function will either return
- /// success once the entire contents of the stream have been written or an
- /// error-code representing a failure.
- ///
- /// Otherwise if there is an error the readable end of the stream will be
- /// dropped and this function will return an error-code.
- @since(version = 0.3.0-rc-2025-09-16)
- write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/cli/terminal.wit b/crates/wasi-http/src/p3/wit/deps/cli/terminal.wit
deleted file mode 100644
index 74c17694a4..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/cli/terminal.wit
+++ /dev/null
@@ -1,62 +0,0 @@
-/// Terminal input.
-///
-/// In the future, this may include functions for disabling echoing,
-/// disabling input buffering so that keyboard events are sent through
-/// immediately, querying supported features, and so on.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-input {
- /// The input side of a terminal.
- @since(version = 0.3.0-rc-2025-09-16)
- resource terminal-input;
-}
-
-/// Terminal output.
-///
-/// In the future, this may include functions for querying the terminal
-/// size, being notified of terminal size changes, querying supported
-/// features, and so on.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-output {
- /// The output side of a terminal.
- @since(version = 0.3.0-rc-2025-09-16)
- resource terminal-output;
-}
-
-/// An interface providing an optional `terminal-input` for stdin as a
-/// link-time authority.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-stdin {
- @since(version = 0.3.0-rc-2025-09-16)
- use terminal-input.{terminal-input};
-
- /// If stdin is connected to a terminal, return a `terminal-input` handle
- /// allowing further interaction with it.
- @since(version = 0.3.0-rc-2025-09-16)
- get-terminal-stdin: func() -> option<terminal-input>;
-}
-
-/// An interface providing an optional `terminal-output` for stdout as a
-/// link-time authority.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-stdout {
- @since(version = 0.3.0-rc-2025-09-16)
- use terminal-output.{terminal-output};
-
- /// If stdout is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.3.0-rc-2025-09-16)
- get-terminal-stdout: func() -> option<terminal-output>;
-}
-
-/// An interface providing an optional `terminal-output` for stderr as a
-/// link-time authority.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-stderr {
- @since(version = 0.3.0-rc-2025-09-16)
- use terminal-output.{terminal-output};
-
- /// If stderr is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.3.0-rc-2025-09-16)
- get-terminal-stderr: func() -> option<terminal-output>;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/clocks.wit b/crates/wasi-http/src/p3/wit/deps/clocks.wit
new file mode 100644
index 0000000000..8e631f9a5d
--- /dev/null
+++ b/crates/wasi-http/src/p3/wit/deps/clocks.wit
@@ -0,0 +1,163 @@
+package wasi:[email protected];
+
+/// This interface common types used throughout wasi:clocks.
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ /// A duration of time, in nanoseconds.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type duration = u64;
+}
+
+/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
+/// time.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A monotonic clock is a clock which has an unspecified initial value, and
+/// successive reads of the clock will produce non-decreasing values.
+@since(version = 0.3.0-rc-2025-09-16)
+interface monotonic-clock {
+ use types.{duration};
+
+ /// An instant in time, in nanoseconds. An instant is relative to an
+ /// unspecified initial value, and can only be compared to instances from
+ /// the same monotonic-clock.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type instant = u64;
+
+ /// Read the current value of the clock.
+ ///
+ /// The clock is monotonic, therefore calling this function repeatedly will
+ /// produce a sequence of non-decreasing values.
+ ///
+ /// For completeness, this function traps if it's not possible to represent
+ /// the value of the clock in an `instant`. Consequently, implementations
+ /// should ensure that the starting time is low enough to avoid the
+ /// possibility of overflow in practice.
+ @since(version = 0.3.0-rc-2025-09-16)
+ now: func() -> instant;
+
+ /// Query the resolution of the clock. Returns the duration of time
+ /// corresponding to a clock tick.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-resolution: func() -> duration;
+
+ /// Wait until the specified instant has occurred.
+ @since(version = 0.3.0-rc-2025-09-16)
+ wait-until: async func(when: instant);
+
+ /// Wait for the specified duration to elapse.
+ @since(version = 0.3.0-rc-2025-09-16)
+ wait-for: async func(how-long: duration);
+}
+
+/// WASI Wall Clock is a clock API intended to let users query the current
+/// time. The name "wall" makes an analogy to a "clock on the wall", which
+/// is not necessarily monotonic as it may be reset.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A wall clock is a clock which measures the date and time according to
+/// some external reference.
+///
+/// External references may be reset, so this clock is not necessarily
+/// monotonic, making it unsuitable for measuring elapsed time.
+///
+/// It is intended for reporting the current date and time for humans.
+@since(version = 0.3.0-rc-2025-09-16)
+interface wall-clock {
+ /// A time and date in seconds plus nanoseconds.
+ @since(version = 0.3.0-rc-2025-09-16)
+ record datetime {
+ seconds: u64,
+ nanoseconds: u32,
+ }
+
+ /// Read the current value of the clock.
+ ///
+ /// This clock is not monotonic, therefore calling this function repeatedly
+ /// will not necessarily produce a sequence of non-decreasing values.
+ ///
+ /// The returned timestamps represent the number of seconds since
+ /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
+ /// also known as [Unix Time].
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ ///
+ /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
+ /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
+ @since(version = 0.3.0-rc-2025-09-16)
+ now: func() -> datetime;
+
+ /// Query the resolution of the clock.
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-resolution: func() -> datetime;
+}
+
+@unstable(feature = clocks-timezone)
+interface timezone {
+ @unstable(feature = clocks-timezone)
+ use wall-clock.{datetime};
+
+ /// Information useful for displaying the timezone of a specific `datetime`.
+ ///
+ /// This information may vary within a single `timezone` to reflect daylight
+ /// saving time adjustments.
+ @unstable(feature = clocks-timezone)
+ record timezone-display {
+ /// The number of seconds difference between UTC time and the local
+ /// time of the timezone.
+ ///
+ /// The returned value will always be less than 86400 which is the
+ /// number of seconds in a day (24*60*60).
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return 0.
+ utc-offset: s32,
+ /// The abbreviated name of the timezone to display to a user. The name
+ /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
+ /// reference local standards for the name of the time zone.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should be the string `UTC`.
+ ///
+ /// In time zones that do not have an applicable name, a formatted
+ /// representation of the UTC offset may be returned, such as `-04:00`.
+ name: string,
+ /// Whether daylight saving time is active.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return false.
+ in-daylight-saving-time: bool,
+ }
+
+ /// Return information needed to display the given `datetime`. This includes
+ /// the UTC offset, the time zone name, and a flag indicating whether
+ /// daylight saving time is active.
+ ///
+ /// If the timezone cannot be determined for the given `datetime`, return a
+ /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
+ /// saving time.
+ @unstable(feature = clocks-timezone)
+ display: func(when: datetime) -> timezone-display;
+
+ /// The same as `display`, but only return the UTC offset.
+ @unstable(feature = clocks-timezone)
+ utc-offset: func(when: datetime) -> s32;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import monotonic-clock;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wall-clock;
+ @unstable(feature = clocks-timezone)
+ import timezone;
+}
diff --git a/crates/wasi-http/src/p3/wit/deps/clocks/monotonic-clock.wit b/crates/wasi-http/src/p3/wit/deps/clocks/monotonic-clock.wit
deleted file mode 100644
index a91d495c6c..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/clocks/monotonic-clock.wit
+++ /dev/null
@@ -1,48 +0,0 @@
-package wasi:[email protected];
-/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
-/// time.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A monotonic clock is a clock which has an unspecified initial value, and
-/// successive reads of the clock will produce non-decreasing values.
-@since(version = 0.3.0-rc-2025-09-16)
-interface monotonic-clock {
- use types.{duration};
-
- /// An instant in time, in nanoseconds. An instant is relative to an
- /// unspecified initial value, and can only be compared to instances from
- /// the same monotonic-clock.
- @since(version = 0.3.0-rc-2025-09-16)
- type instant = u64;
-
- /// Read the current value of the clock.
- ///
- /// The clock is monotonic, therefore calling this function repeatedly will
- /// produce a sequence of non-decreasing values.
- ///
- /// For completeness, this function traps if it's not possible to represent
- /// the value of the clock in an `instant`. Consequently, implementations
- /// should ensure that the starting time is low enough to avoid the
- /// possibility of overflow in practice.
- @since(version = 0.3.0-rc-2025-09-16)
- now: func() -> instant;
-
- /// Query the resolution of the clock. Returns the duration of time
- /// corresponding to a clock tick.
- @since(version = 0.3.0-rc-2025-09-16)
- get-resolution: func() -> duration;
-
- /// Wait until the specified instant has occurred.
- @since(version = 0.3.0-rc-2025-09-16)
- wait-until: async func(
- when: instant,
- );
-
- /// Wait for the specified duration to elapse.
- @since(version = 0.3.0-rc-2025-09-16)
- wait-for: async func(
- how-long: duration,
- );
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/clocks/timezone.wit b/crates/wasi-http/src/p3/wit/deps/clocks/timezone.wit
deleted file mode 100644
index ab8f5c0801..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/clocks/timezone.wit
+++ /dev/null
@@ -1,55 +0,0 @@
-package wasi:[email protected];
-
-@unstable(feature = clocks-timezone)
-interface timezone {
- @unstable(feature = clocks-timezone)
- use wall-clock.{datetime};
-
- /// Return information needed to display the given `datetime`. This includes
- /// the UTC offset, the time zone name, and a flag indicating whether
- /// daylight saving time is active.
- ///
- /// If the timezone cannot be determined for the given `datetime`, return a
- /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
- /// saving time.
- @unstable(feature = clocks-timezone)
- display: func(when: datetime) -> timezone-display;
-
- /// The same as `display`, but only return the UTC offset.
- @unstable(feature = clocks-timezone)
- utc-offset: func(when: datetime) -> s32;
-
- /// Information useful for displaying the timezone of a specific `datetime`.
- ///
- /// This information may vary within a single `timezone` to reflect daylight
- /// saving time adjustments.
- @unstable(feature = clocks-timezone)
- record timezone-display {
- /// The number of seconds difference between UTC time and the local
- /// time of the timezone.
- ///
- /// The returned value will always be less than 86400 which is the
- /// number of seconds in a day (24*60*60).
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return 0.
- utc-offset: s32,
-
- /// The abbreviated name of the timezone to display to a user. The name
- /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
- /// reference local standards for the name of the time zone.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should be the string `UTC`.
- ///
- /// In time zones that do not have an applicable name, a formatted
- /// representation of the UTC offset may be returned, such as `-04:00`.
- name: string,
-
- /// Whether daylight saving time is active.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return false.
- in-daylight-saving-time: bool,
- }
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/clocks/types.wit b/crates/wasi-http/src/p3/wit/deps/clocks/types.wit
deleted file mode 100644
index aff7c2a22a..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/clocks/types.wit
+++ /dev/null
@@ -1,8 +0,0 @@
-package wasi:[email protected];
-/// This interface common types used throughout wasi:clocks.
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- /// A duration of time, in nanoseconds.
- @since(version = 0.3.0-rc-2025-09-16)
- type duration = u64;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/clocks/wall-clock.wit b/crates/wasi-http/src/p3/wit/deps/clocks/wall-clock.wit
deleted file mode 100644
index ea940500fa..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/clocks/wall-clock.wit
+++ /dev/null
@@ -1,46 +0,0 @@
-package wasi:[email protected];
-/// WASI Wall Clock is a clock API intended to let users query the current
-/// time. The name "wall" makes an analogy to a "clock on the wall", which
-/// is not necessarily monotonic as it may be reset.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A wall clock is a clock which measures the date and time according to
-/// some external reference.
-///
-/// External references may be reset, so this clock is not necessarily
-/// monotonic, making it unsuitable for measuring elapsed time.
-///
-/// It is intended for reporting the current date and time for humans.
-@since(version = 0.3.0-rc-2025-09-16)
-interface wall-clock {
- /// A time and date in seconds plus nanoseconds.
- @since(version = 0.3.0-rc-2025-09-16)
- record datetime {
- seconds: u64,
- nanoseconds: u32,
- }
-
- /// Read the current value of the clock.
- ///
- /// This clock is not monotonic, therefore calling this function repeatedly
- /// will not necessarily produce a sequence of non-decreasing values.
- ///
- /// The returned timestamps represent the number of seconds since
- /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
- /// also known as [Unix Time].
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- ///
- /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
- /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
- @since(version = 0.3.0-rc-2025-09-16)
- now: func() -> datetime;
-
- /// Query the resolution of the clock.
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- @since(version = 0.3.0-rc-2025-09-16)
- get-resolution: func() -> datetime;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/clocks/world.wit b/crates/wasi-http/src/p3/wit/deps/clocks/world.wit
deleted file mode 100644
index a6b885f070..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/clocks/world.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import monotonic-clock;
- @since(version = 0.3.0-rc-2025-09-16)
- import wall-clock;
- @unstable(feature = clocks-timezone)
- import timezone;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/filesystem.wit b/crates/wasi-http/src/p3/wit/deps/filesystem.wit
new file mode 100644
index 0000000000..94c87628d0
--- /dev/null
+++ b/crates/wasi-http/src/p3/wit/deps/filesystem.wit
@@ -0,0 +1,551 @@
+package wasi:[email protected];
+
+/// WASI filesystem is a filesystem API primarily intended to let users run WASI
+/// programs that access their files on their existing filesystems, without
+/// significant overhead.
+///
+/// It is intended to be roughly portable between Unix-family platforms and
+/// Windows, though it does not hide many of the major differences.
+///
+/// Paths are passed as interface-type `string`s, meaning they must consist of
+/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
+/// paths which are not accessible by this API.
+///
+/// The directory separator in WASI is always the forward-slash (`/`).
+///
+/// All paths in WASI are relative paths, and are interpreted relative to a
+/// `descriptor` referring to a base directory. If a `path` argument to any WASI
+/// function starts with `/`, or if any step of resolving a `path`, including
+/// `..` and symbolic link steps, reaches a directory outside of the base
+/// directory, or reaches a symlink to an absolute or rooted path in the
+/// underlying filesystem, the function fails with `error-code::not-permitted`.
+///
+/// For more information about WASI path resolution and sandboxing, see
+/// [WASI filesystem path resolution].
+///
+/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use wasi:clocks/[email protected].{datetime};
+
+ /// File size or length of a region within a file.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type filesize = u64;
+
+ /// The type of a filesystem object referenced by a descriptor.
+ ///
+ /// Note: This was called `filetype` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum descriptor-type {
+ /// The type of the descriptor or file is unknown or is different from
+ /// any of the other types specified.
+ unknown,
+ /// The descriptor refers to a block device inode.
+ block-device,
+ /// The descriptor refers to a character device inode.
+ character-device,
+ /// The descriptor refers to a directory inode.
+ directory,
+ /// The descriptor refers to a named pipe.
+ fifo,
+ /// The file refers to a symbolic link inode.
+ symbolic-link,
+ /// The descriptor refers to a regular file inode.
+ regular-file,
+ /// The descriptor refers to a socket.
+ socket,
+ }
+
+ /// Descriptor flags.
+ ///
+ /// Note: This was called `fdflags` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ flags descriptor-flags {
+ /// Read mode: Data can be read.
+ read,
+ /// Write mode: Data can be written to.
+ write,
+ /// Request that writes be performed according to synchronized I/O file
+ /// integrity completion. The data stored in the file and the file's
+ /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ file-integrity-sync,
+ /// Request that writes be performed according to synchronized I/O data
+ /// integrity completion. Only the data stored in the file is
+ /// synchronized. This is similar to `O_DSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ data-integrity-sync,
+ /// Requests that reads be performed at the same level of integrity
+ /// requested for writes. This is similar to `O_RSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ requested-write-sync,
+ /// Mutating directories mode: Directory contents may be mutated.
+ ///
+ /// When this flag is unset on a descriptor, operations using the
+ /// descriptor which would create, rename, delete, modify the data or
+ /// metadata of filesystem objects, or obtain another handle which
+ /// would permit any of those, shall fail with `error-code::read-only` if
+ /// they would otherwise succeed.
+ ///
+ /// This may only be set on directories.
+ mutate-directory,
+ }
+
+ /// Flags determining the method of how paths are resolved.
+ @since(version = 0.3.0-rc-2025-09-16)
+ flags path-flags {
+ /// As long as the resolved path corresponds to a symbolic link, it is
+ /// expanded.
+ symlink-follow,
+ }
+
+ /// Open flags used by `open-at`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ flags open-flags {
+ /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
+ create,
+ /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
+ directory,
+ /// Fail if file already exists, similar to `O_EXCL` in POSIX.
+ exclusive,
+ /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
+ truncate,
+ }
+
+ /// Number of hard links to an inode.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type link-count = u64;
+
+ /// File attributes.
+ ///
+ /// Note: This was called `filestat` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ record descriptor-stat {
+ /// File type.
+ %type: descriptor-type,
+ /// Number of hard links to the file.
+ link-count: link-count,
+ /// For regular files, the file size in bytes. For symbolic links, the
+ /// length in bytes of the pathname contained in the symbolic link.
+ size: filesize,
+ /// Last data access timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain an access
+ /// timestamp for this file.
+ data-access-timestamp: option<datetime>,
+ /// Last data modification timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// modification timestamp for this file.
+ data-modification-timestamp: option<datetime>,
+ /// Last file status-change timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// status-change timestamp for this file.
+ status-change-timestamp: option<datetime>,
+ }
+
+ /// When setting a timestamp, this gives the value to set it to.
+ @since(version = 0.3.0-rc-2025-09-16)
+ variant new-timestamp {
+ /// Leave the timestamp set to its previous value.
+ no-change,
+ /// Set the timestamp to the current time of the system clock associated
+ /// with the filesystem.
+ now,
+ /// Set the timestamp to the given value.
+ timestamp(datetime),
+ }
+
+ /// A directory entry.
+ record directory-entry {
+ /// The type of the file referred to by this directory entry.
+ %type: descriptor-type,
+ /// The name of the object.
+ name: string,
+ }
+
+ /// Error codes returned by functions, similar to `errno` in POSIX.
+ /// Not all of these error codes are returned by the functions provided by this
+ /// API; some are used in higher-level library layers, and others are provided
+ /// merely for alignment with POSIX.
+ enum error-code {
+ /// Permission denied, similar to `EACCES` in POSIX.
+ access,
+ /// Connection already in progress, similar to `EALREADY` in POSIX.
+ already,
+ /// Bad descriptor, similar to `EBADF` in POSIX.
+ bad-descriptor,
+ /// Device or resource busy, similar to `EBUSY` in POSIX.
+ busy,
+ /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
+ deadlock,
+ /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
+ quota,
+ /// File exists, similar to `EEXIST` in POSIX.
+ exist,
+ /// File too large, similar to `EFBIG` in POSIX.
+ file-too-large,
+ /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
+ illegal-byte-sequence,
+ /// Operation in progress, similar to `EINPROGRESS` in POSIX.
+ in-progress,
+ /// Interrupted function, similar to `EINTR` in POSIX.
+ interrupted,
+ /// Invalid argument, similar to `EINVAL` in POSIX.
+ invalid,
+ /// I/O error, similar to `EIO` in POSIX.
+ io,
+ /// Is a directory, similar to `EISDIR` in POSIX.
+ is-directory,
+ /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
+ loop,
+ /// Too many links, similar to `EMLINK` in POSIX.
+ too-many-links,
+ /// Message too large, similar to `EMSGSIZE` in POSIX.
+ message-size,
+ /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
+ name-too-long,
+ /// No such device, similar to `ENODEV` in POSIX.
+ no-device,
+ /// No such file or directory, similar to `ENOENT` in POSIX.
+ no-entry,
+ /// No locks available, similar to `ENOLCK` in POSIX.
+ no-lock,
+ /// Not enough space, similar to `ENOMEM` in POSIX.
+ insufficient-memory,
+ /// No space left on device, similar to `ENOSPC` in POSIX.
+ insufficient-space,
+ /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
+ not-directory,
+ /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
+ not-empty,
+ /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
+ not-recoverable,
+ /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
+ unsupported,
+ /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
+ no-tty,
+ /// No such device or address, similar to `ENXIO` in POSIX.
+ no-such-device,
+ /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
+ overflow,
+ /// Operation not permitted, similar to `EPERM` in POSIX.
+ not-permitted,
+ /// Broken pipe, similar to `EPIPE` in POSIX.
+ pipe,
+ /// Read-only file system, similar to `EROFS` in POSIX.
+ read-only,
+ /// Invalid seek, similar to `ESPIPE` in POSIX.
+ invalid-seek,
+ /// Text file busy, similar to `ETXTBSY` in POSIX.
+ text-file-busy,
+ /// Cross-device link, similar to `EXDEV` in POSIX.
+ cross-device,
+ }
+
+ /// File or memory access pattern advisory information.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum advice {
+ /// The application has no advice to give on its behavior with respect
+ /// to the specified data.
+ normal,
+ /// The application expects to access the specified data sequentially
+ /// from lower offsets to higher offsets.
+ sequential,
+ /// The application expects to access the specified data in a random
+ /// order.
+ random,
+ /// The application expects to access the specified data in the near
+ /// future.
+ will-need,
+ /// The application expects that it will not access the specified data
+ /// in the near future.
+ dont-need,
+ /// The application expects to access the specified data once and then
+ /// not reuse it thereafter.
+ no-reuse,
+ }
+
+ /// A 128-bit hash value, split into parts because wasm doesn't have a
+ /// 128-bit integer type.
+ @since(version = 0.3.0-rc-2025-09-16)
+ record metadata-hash-value {
+ /// 64 bits of a 128-bit hash value.
+ lower: u64,
+ /// Another 64 bits of a 128-bit hash value.
+ upper: u64,
+ }
+
+ /// A descriptor is a reference to a filesystem object, which may be a file,
+ /// directory, named pipe, special file, or other object on which filesystem
+ /// calls may be made.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource descriptor {
+ /// Return a stream for reading from a file.
+ ///
+ /// Multiple read, write, and append streams may be active on the same open
+ /// file and they do not interfere with each other.
+ ///
+ /// This function returns a `stream` which provides the data received from the
+ /// file, and a `future` providing additional error information in case an
+ /// error is encountered.
+ ///
+ /// If no error is encountered, `stream.read` on the `stream` will return
+ /// `read-status::closed` with no `error-context` and the future resolves to
+ /// the value `ok`. If an error is encountered, `stream.read` on the
+ /// `stream` returns `read-status::closed` with an `error-context` and the future
+ /// resolves to `err` with an `error-code`.
+ ///
+ /// Note: This is similar to `pread` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ read-via-stream: func(offset: filesize) -> tuple<stream<u8>, future<result<_, error-code>>>;
+ /// Return a stream for writing to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be written.
+ ///
+ /// It is valid to write past the end of a file; the file is extended to the
+ /// extent of the write, with bytes between the previous end and the start of
+ /// the write set to zero.
+ ///
+ /// This function returns once either full contents of the stream are
+ /// written or an error is encountered.
+ ///
+ /// Note: This is similar to `pwrite` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ write-via-stream: async func(data: stream<u8>, offset: filesize) -> result<_, error-code>;
+ /// Return a stream for appending to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be appended.
+ ///
+ /// This function returns once either full contents of the stream are
+ /// written or an error is encountered.
+ ///
+ /// Note: This is similar to `write` with `O_APPEND` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ append-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
+ /// Provide file advisory information on a descriptor.
+ ///
+ /// This is similar to `posix_fadvise` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ advise: async func(offset: filesize, length: filesize, advice: advice) -> result<_, error-code>;
+ /// Synchronize the data of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fdatasync` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ sync-data: async func() -> result<_, error-code>;
+ /// Get flags associated with a descriptor.
+ ///
+ /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_flags` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-flags: async func() -> result<descriptor-flags, error-code>;
+ /// Get the dynamic type of a descriptor.
+ ///
+ /// Note: This returns the same value as the `type` field of the `fd-stat`
+ /// returned by `stat`, `stat-at` and similar.
+ ///
+ /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
+ /// by `fstat` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_filetype` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-type: async func() -> result<descriptor-type, error-code>;
+ /// Adjust the size of an open file. If this increases the file's size, the
+ /// extra bytes are filled with zeros.
+ ///
+ /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-size: async func(size: filesize) -> result<_, error-code>;
+ /// Adjust the timestamps of an open file or directory.
+ ///
+ /// Note: This is similar to `futimens` in POSIX.
+ ///
+ /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-times: async func(data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Read directory entries from a directory.
+ ///
+ /// On filesystems where directories contain entries referring to themselves
+ /// and their parents, often named `.` and `..` respectively, these entries
+ /// are omitted.
+ ///
+ /// This always returns a new stream which starts at the beginning of the
+ /// directory. Multiple streams may be active on the same directory, and they
+ /// do not interfere with each other.
+ ///
+ /// This function returns a future, which will resolve to an error code if
+ /// reading full contents of the directory fails.
+ @since(version = 0.3.0-rc-2025-09-16)
+ read-directory: async func() -> tuple<stream<directory-entry>, future<result<_, error-code>>>;
+ /// Synchronize the data and metadata of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fsync` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ sync: async func() -> result<_, error-code>;
+ /// Create a directory.
+ ///
+ /// Note: This is similar to `mkdirat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ create-directory-at: async func(path: string) -> result<_, error-code>;
+ /// Return the attributes of an open file or directory.
+ ///
+ /// Note: This is similar to `fstat` in POSIX, except that it does not return
+ /// device and inode information. For testing whether two descriptors refer to
+ /// the same underlying filesystem object, use `is-same-object`. To obtain
+ /// additional data that can be used do determine whether a file has been
+ /// modified, use `metadata-hash`.
+ ///
+ /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ stat: async func() -> result<descriptor-stat, error-code>;
+ /// Return the attributes of a file or directory.
+ ///
+ /// Note: This is similar to `fstatat` in POSIX, except that it does not
+ /// return device and inode information. See the `stat` description for a
+ /// discussion of alternatives.
+ ///
+ /// Note: This was called `path_filestat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ stat-at: async func(path-flags: path-flags, path: string) -> result<descriptor-stat, error-code>;
+ /// Adjust the timestamps of a file or directory.
+ ///
+ /// Note: This is similar to `utimensat` in POSIX.
+ ///
+ /// Note: This was called `path_filestat_set_times` in earlier versions of
+ /// WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-times-at: async func(path-flags: path-flags, path: string, data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Create a hard link.
+ ///
+ /// Fails with `error-code::no-entry` if the old path does not exist,
+ /// with `error-code::exist` if the new path already exists, and
+ /// `error-code::not-permitted` if the old path is not a file.
+ ///
+ /// Note: This is similar to `linkat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ link-at: async func(old-path-flags: path-flags, old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Open a file or directory.
+ ///
+ /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
+ /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
+ /// `open-at` fails with `error-code::read-only`.
+ ///
+ /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
+ /// contains `truncate` or `create`, and the base descriptor doesn't have
+ /// `descriptor-flags::mutate-directory` set, `open-at` fails with
+ /// `error-code::read-only`.
+ ///
+ /// Note: This is similar to `openat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ open-at: async func(path-flags: path-flags, path: string, open-flags: open-flags, %flags: descriptor-flags) -> result<descriptor, error-code>;
+ /// Read the contents of a symbolic link.
+ ///
+ /// If the contents contain an absolute or rooted path in the underlying
+ /// filesystem, this function fails with `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `readlinkat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ readlink-at: async func(path: string) -> result<string, error-code>;
+ /// Remove a directory.
+ ///
+ /// Return `error-code::not-empty` if the directory is not empty.
+ ///
+ /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ remove-directory-at: async func(path: string) -> result<_, error-code>;
+ /// Rename a filesystem object.
+ ///
+ /// Note: This is similar to `renameat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ rename-at: async func(old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Create a symbolic link (also known as a "symlink").
+ ///
+ /// If `old-path` starts with `/`, the function fails with
+ /// `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `symlinkat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ symlink-at: async func(old-path: string, new-path: string) -> result<_, error-code>;
+ /// Unlink a filesystem object that is not a directory.
+ ///
+ /// Return `error-code::is-directory` if the path refers to a directory.
+ /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ unlink-file-at: async func(path: string) -> result<_, error-code>;
+ /// Test whether two descriptors refer to the same filesystem object.
+ ///
+ /// In POSIX, this corresponds to testing whether the two descriptors have the
+ /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
+ /// wasi-filesystem does not expose device and inode numbers, so this function
+ /// may be used instead.
+ @since(version = 0.3.0-rc-2025-09-16)
+ is-same-object: async func(other: borrow<descriptor>) -> bool;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a descriptor.
+ ///
+ /// This returns a hash of the last-modification timestamp and file size, and
+ /// may also include the inode number, device number, birth timestamp, and
+ /// other metadata fields that may change when the file is modified or
+ /// replaced. It may also include a secret value chosen by the
+ /// implementation and not otherwise exposed.
+ ///
+ /// Implementations are encouraged to provide the following properties:
+ ///
+ /// - If the file is not modified or replaced, the computed hash value should
+ /// usually not change.
+ /// - If the object is modified or replaced, the computed hash value should
+ /// usually change.
+ /// - The inputs to the hash should not be easily computable from the
+ /// computed hash.
+ ///
+ /// However, none of these is required.
+ @since(version = 0.3.0-rc-2025-09-16)
+ metadata-hash: async func() -> result<metadata-hash-value, error-code>;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a directory descriptor and a relative path.
+ ///
+ /// This performs the same hash computation as `metadata-hash`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ metadata-hash-at: async func(path-flags: path-flags, path: string) -> result<metadata-hash-value, error-code>;
+ }
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface preopens {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use types.{descriptor};
+
+ /// Return the set of preopened directories, and their paths.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-directories: func() -> list<tuple<descriptor, string>>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wasi:clocks/[email protected];
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import preopens;
+}
diff --git a/crates/wasi-http/src/p3/wit/deps/filesystem/preopens.wit b/crates/wasi-http/src/p3/wit/deps/filesystem/preopens.wit
deleted file mode 100644
index 9036e90e88..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/filesystem/preopens.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface preopens {
- @since(version = 0.3.0-rc-2025-09-16)
- use types.{descriptor};
-
- /// Return the set of preopened directories, and their paths.
- @since(version = 0.3.0-rc-2025-09-16)
- get-directories: func() -> list<tuple<descriptor, string>>;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/filesystem/types.wit b/crates/wasi-http/src/p3/wit/deps/filesystem/types.wit
deleted file mode 100644
index 41d91beee5..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/filesystem/types.wit
+++ /dev/null
@@ -1,636 +0,0 @@
-package wasi:[email protected];
-/// WASI filesystem is a filesystem API primarily intended to let users run WASI
-/// programs that access their files on their existing filesystems, without
-/// significant overhead.
-///
-/// It is intended to be roughly portable between Unix-family platforms and
-/// Windows, though it does not hide many of the major differences.
-///
-/// Paths are passed as interface-type `string`s, meaning they must consist of
-/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
-/// paths which are not accessible by this API.
-///
-/// The directory separator in WASI is always the forward-slash (`/`).
-///
-/// All paths in WASI are relative paths, and are interpreted relative to a
-/// `descriptor` referring to a base directory. If a `path` argument to any WASI
-/// function starts with `/`, or if any step of resolving a `path`, including
-/// `..` and symbolic link steps, reaches a directory outside of the base
-/// directory, or reaches a symlink to an absolute or rooted path in the
-/// underlying filesystem, the function fails with `error-code::not-permitted`.
-///
-/// For more information about WASI path resolution and sandboxing, see
-/// [WASI filesystem path resolution].
-///
-/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- @since(version = 0.3.0-rc-2025-09-16)
- use wasi:clocks/[email protected].{datetime};
-
- /// File size or length of a region within a file.
- @since(version = 0.3.0-rc-2025-09-16)
- type filesize = u64;
-
- /// The type of a filesystem object referenced by a descriptor.
- ///
- /// Note: This was called `filetype` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- enum descriptor-type {
- /// The type of the descriptor or file is unknown or is different from
- /// any of the other types specified.
- unknown,
- /// The descriptor refers to a block device inode.
- block-device,
- /// The descriptor refers to a character device inode.
- character-device,
- /// The descriptor refers to a directory inode.
- directory,
- /// The descriptor refers to a named pipe.
- fifo,
- /// The file refers to a symbolic link inode.
- symbolic-link,
- /// The descriptor refers to a regular file inode.
- regular-file,
- /// The descriptor refers to a socket.
- socket,
- }
-
- /// Descriptor flags.
- ///
- /// Note: This was called `fdflags` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- flags descriptor-flags {
- /// Read mode: Data can be read.
- read,
- /// Write mode: Data can be written to.
- write,
- /// Request that writes be performed according to synchronized I/O file
- /// integrity completion. The data stored in the file and the file's
- /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- file-integrity-sync,
- /// Request that writes be performed according to synchronized I/O data
- /// integrity completion. Only the data stored in the file is
- /// synchronized. This is similar to `O_DSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- data-integrity-sync,
- /// Requests that reads be performed at the same level of integrity
- /// requested for writes. This is similar to `O_RSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- requested-write-sync,
- /// Mutating directories mode: Directory contents may be mutated.
- ///
- /// When this flag is unset on a descriptor, operations using the
- /// descriptor which would create, rename, delete, modify the data or
- /// metadata of filesystem objects, or obtain another handle which
- /// would permit any of those, shall fail with `error-code::read-only` if
- /// they would otherwise succeed.
- ///
- /// This may only be set on directories.
- mutate-directory,
- }
-
- /// File attributes.
- ///
- /// Note: This was called `filestat` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- record descriptor-stat {
- /// File type.
- %type: descriptor-type,
- /// Number of hard links to the file.
- link-count: link-count,
- /// For regular files, the file size in bytes. For symbolic links, the
- /// length in bytes of the pathname contained in the symbolic link.
- size: filesize,
- /// Last data access timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain an access
- /// timestamp for this file.
- data-access-timestamp: option<datetime>,
- /// Last data modification timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// modification timestamp for this file.
- data-modification-timestamp: option<datetime>,
- /// Last file status-change timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// status-change timestamp for this file.
- status-change-timestamp: option<datetime>,
- }
-
- /// Flags determining the method of how paths are resolved.
- @since(version = 0.3.0-rc-2025-09-16)
- flags path-flags {
- /// As long as the resolved path corresponds to a symbolic link, it is
- /// expanded.
- symlink-follow,
- }
-
- /// Open flags used by `open-at`.
- @since(version = 0.3.0-rc-2025-09-16)
- flags open-flags {
- /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
- create,
- /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
- directory,
- /// Fail if file already exists, similar to `O_EXCL` in POSIX.
- exclusive,
- /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
- truncate,
- }
-
- /// Number of hard links to an inode.
- @since(version = 0.3.0-rc-2025-09-16)
- type link-count = u64;
-
- /// When setting a timestamp, this gives the value to set it to.
- @since(version = 0.3.0-rc-2025-09-16)
- variant new-timestamp {
- /// Leave the timestamp set to its previous value.
- no-change,
- /// Set the timestamp to the current time of the system clock associated
- /// with the filesystem.
- now,
- /// Set the timestamp to the given value.
- timestamp(datetime),
- }
-
- /// A directory entry.
- record directory-entry {
- /// The type of the file referred to by this directory entry.
- %type: descriptor-type,
-
- /// The name of the object.
- name: string,
- }
-
- /// Error codes returned by functions, similar to `errno` in POSIX.
- /// Not all of these error codes are returned by the functions provided by this
- /// API; some are used in higher-level library layers, and others are provided
- /// merely for alignment with POSIX.
- enum error-code {
- /// Permission denied, similar to `EACCES` in POSIX.
- access,
- /// Connection already in progress, similar to `EALREADY` in POSIX.
- already,
- /// Bad descriptor, similar to `EBADF` in POSIX.
- bad-descriptor,
- /// Device or resource busy, similar to `EBUSY` in POSIX.
- busy,
- /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
- deadlock,
- /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
- quota,
- /// File exists, similar to `EEXIST` in POSIX.
- exist,
- /// File too large, similar to `EFBIG` in POSIX.
- file-too-large,
- /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
- illegal-byte-sequence,
- /// Operation in progress, similar to `EINPROGRESS` in POSIX.
- in-progress,
- /// Interrupted function, similar to `EINTR` in POSIX.
- interrupted,
- /// Invalid argument, similar to `EINVAL` in POSIX.
- invalid,
- /// I/O error, similar to `EIO` in POSIX.
- io,
- /// Is a directory, similar to `EISDIR` in POSIX.
- is-directory,
- /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
- loop,
- /// Too many links, similar to `EMLINK` in POSIX.
- too-many-links,
- /// Message too large, similar to `EMSGSIZE` in POSIX.
- message-size,
- /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
- name-too-long,
- /// No such device, similar to `ENODEV` in POSIX.
- no-device,
- /// No such file or directory, similar to `ENOENT` in POSIX.
- no-entry,
- /// No locks available, similar to `ENOLCK` in POSIX.
- no-lock,
- /// Not enough space, similar to `ENOMEM` in POSIX.
- insufficient-memory,
- /// No space left on device, similar to `ENOSPC` in POSIX.
- insufficient-space,
- /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
- not-directory,
- /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
- not-empty,
- /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
- not-recoverable,
- /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
- unsupported,
- /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
- no-tty,
- /// No such device or address, similar to `ENXIO` in POSIX.
- no-such-device,
- /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
- overflow,
- /// Operation not permitted, similar to `EPERM` in POSIX.
- not-permitted,
- /// Broken pipe, similar to `EPIPE` in POSIX.
- pipe,
- /// Read-only file system, similar to `EROFS` in POSIX.
- read-only,
- /// Invalid seek, similar to `ESPIPE` in POSIX.
- invalid-seek,
- /// Text file busy, similar to `ETXTBSY` in POSIX.
- text-file-busy,
- /// Cross-device link, similar to `EXDEV` in POSIX.
- cross-device,
- }
-
- /// File or memory access pattern advisory information.
- @since(version = 0.3.0-rc-2025-09-16)
- enum advice {
- /// The application has no advice to give on its behavior with respect
- /// to the specified data.
- normal,
- /// The application expects to access the specified data sequentially
- /// from lower offsets to higher offsets.
- sequential,
- /// The application expects to access the specified data in a random
- /// order.
- random,
- /// The application expects to access the specified data in the near
- /// future.
- will-need,
- /// The application expects that it will not access the specified data
- /// in the near future.
- dont-need,
- /// The application expects to access the specified data once and then
- /// not reuse it thereafter.
- no-reuse,
- }
-
- /// A 128-bit hash value, split into parts because wasm doesn't have a
- /// 128-bit integer type.
- @since(version = 0.3.0-rc-2025-09-16)
- record metadata-hash-value {
- /// 64 bits of a 128-bit hash value.
- lower: u64,
- /// Another 64 bits of a 128-bit hash value.
- upper: u64,
- }
-
- /// A descriptor is a reference to a filesystem object, which may be a file,
- /// directory, named pipe, special file, or other object on which filesystem
- /// calls may be made.
- @since(version = 0.3.0-rc-2025-09-16)
- resource descriptor {
- /// Return a stream for reading from a file.
- ///
- /// Multiple read, write, and append streams may be active on the same open
- /// file and they do not interfere with each other.
- ///
- /// This function returns a `stream` which provides the data received from the
- /// file, and a `future` providing additional error information in case an
- /// error is encountered.
- ///
- /// If no error is encountered, `stream.read` on the `stream` will return
- /// `read-status::closed` with no `error-context` and the future resolves to
- /// the value `ok`. If an error is encountered, `stream.read` on the
- /// `stream` returns `read-status::closed` with an `error-context` and the future
- /// resolves to `err` with an `error-code`.
- ///
- /// Note: This is similar to `pread` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- read-via-stream: func(
- /// The offset within the file at which to start reading.
- offset: filesize,
- ) -> tuple<stream<u8>, future<result<_, error-code>>>;
-
- /// Return a stream for writing to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be written.
- ///
- /// It is valid to write past the end of a file; the file is extended to the
- /// extent of the write, with bytes between the previous end and the start of
- /// the write set to zero.
- ///
- /// This function returns once either full contents of the stream are
- /// written or an error is encountered.
- ///
- /// Note: This is similar to `pwrite` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- write-via-stream: async func(
- /// Data to write
- data: stream<u8>,
- /// The offset within the file at which to start writing.
- offset: filesize,
- ) -> result<_, error-code>;
-
- /// Return a stream for appending to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be appended.
- ///
- /// This function returns once either full contents of the stream are
- /// written or an error is encountered.
- ///
- /// Note: This is similar to `write` with `O_APPEND` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- append-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
-
- /// Provide file advisory information on a descriptor.
- ///
- /// This is similar to `posix_fadvise` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- advise: async func(
- /// The offset within the file to which the advisory applies.
- offset: filesize,
- /// The length of the region to which the advisory applies.
- length: filesize,
- /// The advice.
- advice: advice
- ) -> result<_, error-code>;
-
- /// Synchronize the data of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fdatasync` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- sync-data: async func() -> result<_, error-code>;
-
- /// Get flags associated with a descriptor.
- ///
- /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_flags` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- get-flags: async func() -> result<descriptor-flags, error-code>;
-
- /// Get the dynamic type of a descriptor.
- ///
- /// Note: This returns the same value as the `type` field of the `fd-stat`
- /// returned by `stat`, `stat-at` and similar.
- ///
- /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
- /// by `fstat` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_filetype` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- get-type: async func() -> result<descriptor-type, error-code>;
-
- /// Adjust the size of an open file. If this increases the file's size, the
- /// extra bytes are filled with zeros.
- ///
- /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- set-size: async func(size: filesize) -> result<_, error-code>;
-
- /// Adjust the timestamps of an open file or directory.
- ///
- /// Note: This is similar to `futimens` in POSIX.
- ///
- /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- set-times: async func(
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Read directory entries from a directory.
- ///
- /// On filesystems where directories contain entries referring to themselves
- /// and their parents, often named `.` and `..` respectively, these entries
- /// are omitted.
- ///
- /// This always returns a new stream which starts at the beginning of the
- /// directory. Multiple streams may be active on the same directory, and they
- /// do not interfere with each other.
- ///
- /// This function returns a future, which will resolve to an error code if
- /// reading full contents of the directory fails.
- @since(version = 0.3.0-rc-2025-09-16)
- read-directory: async func() -> tuple<stream<directory-entry>, future<result<_, error-code>>>;
-
- /// Synchronize the data and metadata of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fsync` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- sync: async func() -> result<_, error-code>;
-
- /// Create a directory.
- ///
- /// Note: This is similar to `mkdirat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- create-directory-at: async func(
- /// The relative path at which to create the directory.
- path: string,
- ) -> result<_, error-code>;
-
- /// Return the attributes of an open file or directory.
- ///
- /// Note: This is similar to `fstat` in POSIX, except that it does not return
- /// device and inode information. For testing whether two descriptors refer to
- /// the same underlying filesystem object, use `is-same-object`. To obtain
- /// additional data that can be used do determine whether a file has been
- /// modified, use `metadata-hash`.
- ///
- /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- stat: async func() -> result<descriptor-stat, error-code>;
-
- /// Return the attributes of a file or directory.
- ///
- /// Note: This is similar to `fstatat` in POSIX, except that it does not
- /// return device and inode information. See the `stat` description for a
- /// discussion of alternatives.
- ///
- /// Note: This was called `path_filestat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- stat-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<descriptor-stat, error-code>;
-
- /// Adjust the timestamps of a file or directory.
- ///
- /// Note: This is similar to `utimensat` in POSIX.
- ///
- /// Note: This was called `path_filestat_set_times` in earlier versions of
- /// WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- set-times-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to operate on.
- path: string,
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Create a hard link.
- ///
- /// Fails with `error-code::no-entry` if the old path does not exist,
- /// with `error-code::exist` if the new path already exists, and
- /// `error-code::not-permitted` if the old path is not a file.
- ///
- /// Note: This is similar to `linkat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- link-at: async func(
- /// Flags determining the method of how the path is resolved.
- old-path-flags: path-flags,
- /// The relative source path from which to link.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path at which to create the hard link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Open a file or directory.
- ///
- /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
- /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
- /// `open-at` fails with `error-code::read-only`.
- ///
- /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
- /// contains `truncate` or `create`, and the base descriptor doesn't have
- /// `descriptor-flags::mutate-directory` set, `open-at` fails with
- /// `error-code::read-only`.
- ///
- /// Note: This is similar to `openat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- open-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the object to open.
- path: string,
- /// The method by which to open the file.
- open-flags: open-flags,
- /// Flags to use for the resulting descriptor.
- %flags: descriptor-flags,
- ) -> result<descriptor, error-code>;
-
- /// Read the contents of a symbolic link.
- ///
- /// If the contents contain an absolute or rooted path in the underlying
- /// filesystem, this function fails with `error-code::not-permitted`.
- ///
- /// Note: This is similar to `readlinkat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- readlink-at: async func(
- /// The relative path of the symbolic link from which to read.
- path: string,
- ) -> result<string, error-code>;
-
- /// Remove a directory.
- ///
- /// Return `error-code::not-empty` if the directory is not empty.
- ///
- /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- remove-directory-at: async func(
- /// The relative path to a directory to remove.
- path: string,
- ) -> result<_, error-code>;
-
- /// Rename a filesystem object.
- ///
- /// Note: This is similar to `renameat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- rename-at: async func(
- /// The relative source path of the file or directory to rename.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path to which to rename the file or directory.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Create a symbolic link (also known as a "symlink").
- ///
- /// If `old-path` starts with `/`, the function fails with
- /// `error-code::not-permitted`.
- ///
- /// Note: This is similar to `symlinkat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- symlink-at: async func(
- /// The contents of the symbolic link.
- old-path: string,
- /// The relative destination path at which to create the symbolic link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Unlink a filesystem object that is not a directory.
- ///
- /// Return `error-code::is-directory` if the path refers to a directory.
- /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- unlink-file-at: async func(
- /// The relative path to a file to unlink.
- path: string,
- ) -> result<_, error-code>;
-
- /// Test whether two descriptors refer to the same filesystem object.
- ///
- /// In POSIX, this corresponds to testing whether the two descriptors have the
- /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
- /// wasi-filesystem does not expose device and inode numbers, so this function
- /// may be used instead.
- @since(version = 0.3.0-rc-2025-09-16)
- is-same-object: async func(other: borrow<descriptor>) -> bool;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a descriptor.
- ///
- /// This returns a hash of the last-modification timestamp and file size, and
- /// may also include the inode number, device number, birth timestamp, and
- /// other metadata fields that may change when the file is modified or
- /// replaced. It may also include a secret value chosen by the
- /// implementation and not otherwise exposed.
- ///
- /// Implementations are encouraged to provide the following properties:
- ///
- /// - If the file is not modified or replaced, the computed hash value should
- /// usually not change.
- /// - If the object is modified or replaced, the computed hash value should
- /// usually change.
- /// - The inputs to the hash should not be easily computable from the
- /// computed hash.
- ///
- /// However, none of these is required.
- @since(version = 0.3.0-rc-2025-09-16)
- metadata-hash: async func() -> result<metadata-hash-value, error-code>;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a directory descriptor and a relative path.
- ///
- /// This performs the same hash computation as `metadata-hash`.
- @since(version = 0.3.0-rc-2025-09-16)
- metadata-hash-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<metadata-hash-value, error-code>;
- }
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/filesystem/world.wit b/crates/wasi-http/src/p3/wit/deps/filesystem/world.wit
deleted file mode 100644
index 87fc727165..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/filesystem/world.wit
+++ /dev/null
@@ -1,9 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import types;
- @since(version = 0.3.0-rc-2025-09-16)
- import preopens;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/http/types.wit b/crates/wasi-http/src/p3/wit/deps/http.wit
similarity index 84%
rename from crates/wasi-http/src/p3/wit/deps/http/types.wit
rename to crates/wasi-http/src/p3/wit/deps/http.wit
index 8269eea202..b20ad64bbb 100644
--- a/crates/wasi-http/src/p3/wit/deps/http/types.wit
+++ b/crates/wasi-http/src/p3/wit/deps/http.wit
@@ -1,3 +1,5 @@
+package wasi:[email protected];
+
/// This interface defines all of the types and methods for implementing HTTP
/// Requests and Responses, as well as their headers, trailers, and bodies.
interface types {
@@ -14,14 +16,32 @@ interface types {
options,
trace,
patch,
- other(string)
+ other(string),
}
/// This type corresponds to HTTP standard Related Schemes.
variant scheme {
HTTP,
HTTPS,
- other(string)
+ other(string),
+ }
+
+ /// Defines the case payload type for `DNS-error` above:
+ record DNS-error-payload {
+ rcode: option<string>,
+ info-code: option<u16>,
+ }
+
+ /// Defines the case payload type for `TLS-alert-received` above:
+ record TLS-alert-received-payload {
+ alert-id: option<u8>,
+ alert-message: option<string>,
+ }
+
+ /// Defines the case payload type for `HTTP-response-{header,trailer}-size` above:
+ record field-size-payload {
+ field-name: option<string>,
+ field-size: option<u32>,
}
/// These cases are inspired by the IANA HTTP Proxy Error Types:
@@ -70,25 +90,7 @@ interface types {
/// unstructured description of the error. Users should not depend on the
/// string for diagnosing errors, as it's not required to be consistent
/// between implementations.
- internal-error(option<string>)
- }
-
- /// Defines the case payload type for `DNS-error` above:
- record DNS-error-payload {
- rcode: option<string>,
- info-code: option<u16>
- }
-
- /// Defines the case payload type for `TLS-alert-received` above:
- record TLS-alert-received-payload {
- alert-id: option<u8>,
- alert-message: option<string>
- }
-
- /// Defines the case payload type for `HTTP-response-{header,trailer}-size` above:
- record field-size-payload {
- field-name: option<string>,
- field-size: option<u32>
+ internal-error(option<string>),
}
/// This type enumerates the different kinds of errors that may occur when
@@ -98,11 +100,9 @@ interface types {
/// syntactically invalid when used with an operation that sets headers in a
/// `fields`.
invalid-syntax,
-
/// This error indicates that a forbidden `field-name` was used when trying
/// to set a header in a `fields`.
forbidden,
-
/// This error indicates that the operation on the `fields` was not
/// permitted because the fields are immutable.
immutable,
@@ -113,7 +113,6 @@ interface types {
variant request-options-error {
/// Indicates the specified field is not supported by this implementation.
not-supported,
-
/// Indicates that the operation on the `request-options` was not permitted
/// because it is immutable.
immutable,
@@ -146,12 +145,10 @@ interface types {
/// resource should use that original casing when serializing the fields for
/// transport or when returning them from a method.
resource fields {
-
/// Construct an empty HTTP Fields.
///
/// The resulting `fields` is mutable.
constructor();
-
/// Construct an HTTP Fields.
///
/// The resulting `fields` is mutable.
@@ -167,32 +164,25 @@ interface types {
///
/// An error result will be returned if any header or value was
/// syntactically invalid, or if a header was forbidden.
- from-list: static func(
- entries: list<tuple<field-name,field-value>>
- ) -> result<fields, header-error>;
-
+ from-list: static func(entries: list<tuple<field-name, field-value>>) -> result<fields, header-error>;
/// Get all of the values corresponding to a name. If the name is not present
/// in this `fields`, an empty list is returned. However, if the name is
/// present but empty, this is represented by a list with one or more
/// empty field-values present.
get: func(name: field-name) -> list<field-value>;
-
/// Returns `true` when the name is present in this `fields`. If the name is
/// syntactically invalid, `false` is returned.
has: func(name: field-name) -> bool;
-
/// Set all of the values for a name. Clears any existing values for that
/// name, if they have been set.
///
/// Fails with `header-error.immutable` if the `fields` are immutable.
set: func(name: field-name, value: list<field-value>) -> result<_, header-error>;
-
/// Delete all values for a name. Does nothing if no values for the name
/// exist.
///
/// Fails with `header-error.immutable` if the `fields` are immutable.
delete: func(name: field-name) -> result<_, header-error>;
-
/// Delete all values for a name. Does nothing if no values for the name
/// exist.
///
@@ -200,13 +190,11 @@ interface types {
///
/// Fails with `header-error.immutable` if the `fields` are immutable.
get-and-delete: func(name: field-name) -> result<list<field-value>, header-error>;
-
/// Append a value for a name. Does not change or delete any existing
/// values for that name.
///
/// Fails with `header-error.immutable` if the `fields` are immutable.
append: func(name: field-name, value: field-value) -> result<_, header-error>;
-
/// Retrieve the full set of names and values in the Fields. Like the
/// constructor, the list represents each name-value pair.
///
@@ -216,8 +204,7 @@ interface types {
///
/// The names and values are always returned in the original casing and in
/// the order in which they will be serialized for transport.
- copy-all: func() -> list<tuple<field-name,field-value>>;
-
+ copy-all: func() -> list<tuple<field-name, field-value>>;
/// Make a deep copy of the Fields. Equivalent in behavior to calling the
/// `fields` constructor on the return value of `copy-all`. The resulting
/// `fields` is mutable.
@@ -232,7 +219,6 @@ interface types {
/// Represents an HTTP Request.
resource request {
-
/// Construct a new `request` with a default `method` of `GET`, and
/// `none` values for `path-with-query`, `scheme`, and `authority`.
///
@@ -254,19 +240,12 @@ interface types {
/// to reject invalid constructions of `request`.
///
/// The returned future resolves to result of transmission of this request.
- new: static func(
- headers: headers,
- contents: option<stream<u8>>,
- trailers: future<result<option<trailers>, error-code>>,
- options: option<request-options>
- ) -> tuple<request, future<result<_, error-code>>>;
-
+ new: static func(headers: headers, contents: option<stream<u8>>, trailers: future<result<option<trailers>, error-code>>, options: option<request-options>) -> tuple<request, future<result<_, error-code>>>;
/// Get the Method for the Request.
get-method: func() -> method;
/// Set the Method for the Request. Fails if the string present in a
/// `method.other` argument is not a syntactically valid method.
set-method: func(method: method) -> result;
-
/// Get the combination of the HTTP Path and Query for the Request. When
/// `none`, this represents an empty Path and empty Query.
get-path-with-query: func() -> option<string>;
@@ -274,7 +253,6 @@ interface types {
/// `none`, this represents an empty Path and empty Query. Fails is the
/// string given is not a syntactically valid path and query uri component.
set-path-with-query: func(path-with-query: option<string>) -> result;
-
/// Get the HTTP Related Scheme for the Request. When `none`, the
/// implementation may choose an appropriate default scheme.
get-scheme: func() -> option<scheme>;
@@ -282,7 +260,6 @@ interface types {
/// implementation may choose an appropriate default scheme. Fails if the
/// string given is not a syntactically valid uri scheme.
set-scheme: func(scheme: option<scheme>) -> result;
-
/// Get the authority of the Request's target URI. A value of `none` may be used
/// with Related Schemes which do not require an authority. The HTTP and
/// HTTPS schemes always require an authority.
@@ -292,7 +269,6 @@ interface types {
/// HTTPS schemes always require an authority. Fails if the string given is
/// not a syntactically valid URI authority.
set-authority: func(authority: option<string>) -> result;
-
/// Get the `request-options` to be associated with this request
///
/// The returned `request-options` resource is immutable: `set-*` operations
@@ -302,13 +278,11 @@ interface types {
/// the parent `request` is dropped, or its ownership is transferred to
/// another component by e.g. `handler.handle`.
get-options: func() -> option<request-options>;
-
/// Get the headers associated with the Request.
///
/// The returned `headers` resource is immutable: `set`, `append`, and
/// `delete` operations will fail with `header-error.immutable`.
get-headers: func() -> headers;
-
/// Get body of the Request.
///
/// Stream returned by this method represents the contents of the body.
@@ -333,32 +307,25 @@ interface types {
resource request-options {
/// Construct a default `request-options` value.
constructor();
-
/// The timeout for the initial connect to the HTTP Server.
get-connect-timeout: func() -> option<duration>;
-
/// Set the timeout for the initial connect to the HTTP Server. An error
/// return value indicates that this timeout is not supported or that this
/// handle is immutable.
set-connect-timeout: func(duration: option<duration>) -> result<_, request-options-error>;
-
/// The timeout for receiving the first byte of the Response body.
get-first-byte-timeout: func() -> option<duration>;
-
/// Set the timeout for receiving the first byte of the Response body. An
/// error return value indicates that this timeout is not supported or that
/// this handle is immutable.
set-first-byte-timeout: func(duration: option<duration>) -> result<_, request-options-error>;
-
/// The timeout for receiving subsequent chunks of bytes in the Response
/// body stream.
get-between-bytes-timeout: func() -> option<duration>;
-
/// Set the timeout for receiving subsequent chunks of bytes in the Response
/// body stream. An error return value indicates that this timeout is not
/// supported or that this handle is immutable.
set-between-bytes-timeout: func(duration: option<duration>) -> result<_, request-options-error>;
-
/// Make a deep copy of the `request-options`.
/// The resulting `request-options` is mutable.
clone: func() -> request-options;
@@ -369,7 +336,6 @@ interface types {
/// Represents an HTTP Response.
resource response {
-
/// Construct a new `response`, with a default `status-code` of `200`.
/// If a different `status-code` is needed, it must be set via the
/// `set-status-code` method.
@@ -383,25 +349,17 @@ interface types {
/// will be closed immediately.
///
/// The returned future resolves to result of transmission of this response.
- new: static func(
- headers: headers,
- contents: option<stream<u8>>,
- trailers: future<result<option<trailers>, error-code>>,
- ) -> tuple<response, future<result<_, error-code>>>;
-
+ new: static func(headers: headers, contents: option<stream<u8>>, trailers: future<result<option<trailers>, error-code>>) -> tuple<response, future<result<_, error-code>>>;
/// Get the HTTP Status Code for the Response.
get-status-code: func() -> status-code;
-
/// Set the HTTP Status Code for the Response. Fails if the status-code
/// given is not a valid http status code.
set-status-code: func(status-code: status-code) -> result;
-
/// Get the headers associated with the Response.
///
/// The returned `headers` resource is immutable: `set`, `append`, and
/// `delete` operations will fail with `header-error.immutable`.
get-headers: func() -> headers;
-
/// Get body of the Response.
///
/// Stream returned by this method represents the contents of the body.
@@ -417,3 +375,56 @@ interface types {
consume-body: static func(this: response, res: future<result<_, error-code>>) -> tuple<stream<u8>, future<result<option<trailers>, error-code>>>;
}
}
+
+/// This interface defines a handler of HTTP Requests. It may be imported by
+/// components which wish to send HTTP Requests and also exported by components
+/// which can respond to HTTP Requests. In addition, it may be used to pass
+/// a request from one component to another without any use of a network.
+interface handler {
+ use types.{request, response, error-code};
+
+ /// When exported, this function may be called with either an incoming
+ /// request read from the network or a request synthesized or forwarded by
+ /// another component.
+ ///
+ /// When imported, this function may be used to either send an outgoing
+ /// request over the network or pass it to another component.
+ handle: async func(request: request) -> result<response, error-code>;
+}
+
+/// The `wasi:http/imports` world imports all the APIs for HTTP proxies.
+/// It is intended to be `include`d in other worlds.
+world imports {
+ import wasi:random/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ import types;
+ import handler;
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+}
+/// The `wasi:http/proxy` world captures a widely-implementable intersection of
+/// hosts that includes HTTP forward and reverse proxies. Components targeting
+/// this world may concurrently stream in and out any number of incoming and
+/// outgoing HTTP requests.
+world proxy {
+ import wasi:random/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:cli/[email protected];
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ import types;
+ import handler;
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+
+ export handler;
+}
diff --git a/crates/wasi-http/src/p3/wit/deps/http/handler.wit b/crates/wasi-http/src/p3/wit/deps/http/handler.wit
deleted file mode 100644
index e4446cbecf..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/http/handler.wit
+++ /dev/null
@@ -1,17 +0,0 @@
-/// This interface defines a handler of HTTP Requests. It may be imported by
-/// components which wish to send HTTP Requests and also exported by components
-/// which can respond to HTTP Requests. In addition, it may be used to pass
-/// a request from one component to another without any use of a network.
-interface handler {
- use types.{request, response, error-code};
-
- /// When exported, this function may be called with either an incoming
- /// request read from the network or a request synthesized or forwarded by
- /// another component.
- ///
- /// When imported, this function may be used to either send an outgoing
- /// request over the network or pass it to another component.
- handle: async func(
- request: request,
- ) -> result<response, error-code>;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/http/proxy.wit b/crates/wasi-http/src/p3/wit/deps/http/proxy.wit
deleted file mode 100644
index 223083ea28..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/http/proxy.wit
+++ /dev/null
@@ -1,44 +0,0 @@
-package wasi:[email protected];
-
-/// The `wasi:http/imports` world imports all the APIs for HTTP proxies.
-/// It is intended to be `include`d in other worlds.
-world imports {
- /// HTTP proxies have access to time and randomness.
- include wasi:clocks/[email protected];
- import wasi:random/[email protected];
-
- /// Proxies have standard output and error streams which are expected to
- /// terminate in a developer-facing console provided by the host.
- import wasi:cli/[email protected];
- import wasi:cli/[email protected];
-
- /// TODO: this is a temporary workaround until component tooling is able to
- /// gracefully handle the absence of stdin. Hosts must return an eof stream
- /// for this import, which is what wasi-libc + tooling will do automatically
- /// when this import is properly removed.
- import wasi:cli/[email protected];
-
- /// This is the default handler to use when user code simply wants to make an
- /// HTTP request (e.g., via `fetch()`).
- ///
- /// This may also be used to pass synthesized or forwarded requests to another
- /// component.
- import handler;
-}
-
-/// The `wasi:http/proxy` world captures a widely-implementable intersection of
-/// hosts that includes HTTP forward and reverse proxies. Components targeting
-/// this world may concurrently stream in and out any number of incoming and
-/// outgoing HTTP requests.
-world proxy {
- include imports;
-
- /// The host delivers incoming HTTP requests to a component by calling the
- /// `handle` function of this exported interface. A host may arbitrarily reuse
- /// or not reuse component instance when delivering incoming HTTP requests and
- /// thus a component must be able to handle 0..N calls to `handle`.
- ///
- /// This may also be used to receive synthesized or forwarded requests from
- /// another component.
- export handler;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/random.wit b/crates/wasi-http/src/p3/wit/deps/random.wit
new file mode 100644
index 0000000000..8dfc39b11b
--- /dev/null
+++ b/crates/wasi-http/src/p3/wit/deps/random.wit
@@ -0,0 +1,92 @@
+package wasi:[email protected];
+
+/// The insecure-seed interface for seeding hash-map DoS resistance.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.3.0-rc-2025-09-16)
+interface insecure-seed {
+ /// Return a 128-bit value that may contain a pseudo-random value.
+ ///
+ /// The returned value is not required to be computed from a CSPRNG, and may
+ /// even be entirely deterministic. Host implementations are encouraged to
+ /// provide pseudo-random values to any program exposed to
+ /// attacker-controlled content, to enable DoS protection built into many
+ /// languages' hash-map implementations.
+ ///
+ /// This function is intended to only be called once, by a source language
+ /// to initialize Denial Of Service (DoS) protection in its hash-map
+ /// implementation.
+ ///
+ /// # Expected future evolution
+ ///
+ /// This will likely be changed to a value import, to prevent it from being
+ /// called multiple times and potentially used for purposes other than DoS
+ /// protection.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-insecure-seed: func() -> tuple<u64, u64>;
+}
+
+/// The insecure interface for insecure pseudo-random numbers.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.3.0-rc-2025-09-16)
+interface insecure {
+ /// Return `len` insecure pseudo-random bytes.
+ ///
+ /// This function is not cryptographically secure. Do not use it for
+ /// anything related to security.
+ ///
+ /// There are no requirements on the values of the returned bytes, however
+ /// implementations are encouraged to return evenly distributed values with
+ /// a long period.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-insecure-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return an insecure pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of pseudo-random data as
+ /// `get-insecure-random-bytes`, represented as a `u64`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-insecure-random-u64: func() -> u64;
+}
+
+/// WASI Random is a random data API.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.3.0-rc-2025-09-16)
+interface random {
+ /// Return `len` cryptographically-secure random or pseudo-random bytes.
+ ///
+ /// This function must produce data at least as cryptographically secure and
+ /// fast as an adequately seeded cryptographically-secure pseudo-random
+ /// number generator (CSPRNG). It must not block, from the perspective of
+ /// the calling program, under any circumstances, including on the first
+ /// request and on requests for numbers of bytes. The returned data must
+ /// always be unpredictable.
+ ///
+ /// This function must always return fresh data. Deterministic environments
+ /// must omit this function, rather than implementing it with deterministic
+ /// data.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return a cryptographically-secure random or pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of data as `get-random-bytes`,
+ /// represented as a `u64`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-random-u64: func() -> u64;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import random;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import insecure;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import insecure-seed;
+}
diff --git a/crates/wasi-http/src/p3/wit/deps/random/insecure-seed.wit b/crates/wasi-http/src/p3/wit/deps/random/insecure-seed.wit
deleted file mode 100644
index 302151ba65..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/random/insecure-seed.wit
+++ /dev/null
@@ -1,27 +0,0 @@
-package wasi:[email protected];
-/// The insecure-seed interface for seeding hash-map DoS resistance.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.3.0-rc-2025-09-16)
-interface insecure-seed {
- /// Return a 128-bit value that may contain a pseudo-random value.
- ///
- /// The returned value is not required to be computed from a CSPRNG, and may
- /// even be entirely deterministic. Host implementations are encouraged to
- /// provide pseudo-random values to any program exposed to
- /// attacker-controlled content, to enable DoS protection built into many
- /// languages' hash-map implementations.
- ///
- /// This function is intended to only be called once, by a source language
- /// to initialize Denial Of Service (DoS) protection in its hash-map
- /// implementation.
- ///
- /// # Expected future evolution
- ///
- /// This will likely be changed to a value import, to prevent it from being
- /// called multiple times and potentially used for purposes other than DoS
- /// protection.
- @since(version = 0.3.0-rc-2025-09-16)
- get-insecure-seed: func() -> tuple<u64, u64>;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/random/insecure.wit b/crates/wasi-http/src/p3/wit/deps/random/insecure.wit
deleted file mode 100644
index 39146e3910..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/random/insecure.wit
+++ /dev/null
@@ -1,25 +0,0 @@
-package wasi:[email protected];
-/// The insecure interface for insecure pseudo-random numbers.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.3.0-rc-2025-09-16)
-interface insecure {
- /// Return `len` insecure pseudo-random bytes.
- ///
- /// This function is not cryptographically secure. Do not use it for
- /// anything related to security.
- ///
- /// There are no requirements on the values of the returned bytes, however
- /// implementations are encouraged to return evenly distributed values with
- /// a long period.
- @since(version = 0.3.0-rc-2025-09-16)
- get-insecure-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return an insecure pseudo-random `u64` value.
- ///
- /// This function returns the same type of pseudo-random data as
- /// `get-insecure-random-bytes`, represented as a `u64`.
- @since(version = 0.3.0-rc-2025-09-16)
- get-insecure-random-u64: func() -> u64;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/random/random.wit b/crates/wasi-http/src/p3/wit/deps/random/random.wit
deleted file mode 100644
index fa1f111dc7..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/random/random.wit
+++ /dev/null
@@ -1,29 +0,0 @@
-package wasi:[email protected];
-/// WASI Random is a random data API.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.3.0-rc-2025-09-16)
-interface random {
- /// Return `len` cryptographically-secure random or pseudo-random bytes.
- ///
- /// This function must produce data at least as cryptographically secure and
- /// fast as an adequately seeded cryptographically-secure pseudo-random
- /// number generator (CSPRNG). It must not block, from the perspective of
- /// the calling program, under any circumstances, including on the first
- /// request and on requests for numbers of bytes. The returned data must
- /// always be unpredictable.
- ///
- /// This function must always return fresh data. Deterministic environments
- /// must omit this function, rather than implementing it with deterministic
- /// data.
- @since(version = 0.3.0-rc-2025-09-16)
- get-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return a cryptographically-secure random or pseudo-random `u64` value.
- ///
- /// This function returns the same type of data as `get-random-bytes`,
- /// represented as a `u64`.
- @since(version = 0.3.0-rc-2025-09-16)
- get-random-u64: func() -> u64;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/random/world.wit b/crates/wasi-http/src/p3/wit/deps/random/world.wit
deleted file mode 100644
index 08c5ed88b7..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/random/world.wit
+++ /dev/null
@@ -1,13 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import random;
-
- @since(version = 0.3.0-rc-2025-09-16)
- import insecure;
-
- @since(version = 0.3.0-rc-2025-09-16)
- import insecure-seed;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/sockets.wit b/crates/wasi-http/src/p3/wit/deps/sockets.wit
new file mode 100644
index 0000000000..f3a7e86e2e
--- /dev/null
+++ b/crates/wasi-http/src/p3/wit/deps/sockets.wit
@@ -0,0 +1,754 @@
+package wasi:[email protected];
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use wasi:clocks/[email protected].{duration};
+
+ /// Error codes.
+ ///
+ /// In theory, every API can return any error code.
+ /// In practice, API's typically only return the errors documented per API
+ /// combined with a couple of errors that are always possible:
+ /// - `unknown`
+ /// - `access-denied`
+ /// - `not-supported`
+ /// - `out-of-memory`
+ ///
+ /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum error-code {
+ /// Unknown error
+ unknown,
+ /// Access denied.
+ ///
+ /// POSIX equivalent: EACCES, EPERM
+ access-denied,
+ /// The operation is not supported.
+ ///
+ /// POSIX equivalent: EOPNOTSUPP
+ not-supported,
+ /// One of the arguments is invalid.
+ ///
+ /// POSIX equivalent: EINVAL
+ invalid-argument,
+ /// Not enough memory to complete the operation.
+ ///
+ /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
+ out-of-memory,
+ /// The operation timed out before it could finish completely.
+ timeout,
+ /// The operation is not valid in the socket's current state.
+ invalid-state,
+ /// A bind operation failed because the provided address is not an address that the `network` can bind to.
+ address-not-bindable,
+ /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
+ address-in-use,
+ /// The remote address is not reachable
+ remote-unreachable,
+ /// The TCP connection was forcefully rejected
+ connection-refused,
+ /// The TCP connection was reset.
+ connection-reset,
+ /// A TCP connection was aborted.
+ connection-aborted,
+ /// The size of a datagram sent to a UDP socket exceeded the maximum
+ /// supported size.
+ datagram-too-large,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum ip-address-family {
+ /// Similar to `AF_INET` in POSIX.
+ ipv4,
+ /// Similar to `AF_INET6` in POSIX.
+ ipv6,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ type ipv4-address = tuple<u8, u8, u8, u8>;
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ variant ip-address {
+ ipv4(ipv4-address),
+ ipv6(ipv6-address),
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ record ipv4-socket-address {
+ /// sin_port
+ port: u16,
+ /// sin_addr
+ address: ipv4-address,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ record ipv6-socket-address {
+ /// sin6_port
+ port: u16,
+ /// sin6_flowinfo
+ flow-info: u32,
+ /// sin6_addr
+ address: ipv6-address,
+ /// sin6_scope_id
+ scope-id: u32,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ variant ip-socket-address {
+ ipv4(ipv4-socket-address),
+ ipv6(ipv6-socket-address),
+ }
+
+ /// A TCP socket resource.
+ ///
+ /// The socket can be in one of the following states:
+ /// - `unbound`
+ /// - `bound` (See note below)
+ /// - `listening`
+ /// - `connecting`
+ /// - `connected`
+ /// - `closed`
+ /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics-0.3.0-draft.md>
+ /// for more information.
+ ///
+ /// Note: Except where explicitly mentioned, whenever this documentation uses
+ /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
+ /// (i.e. `bound`, `listening`, `connecting` or `connected`)
+ ///
+ /// In addition to the general error codes documented on the
+ /// `types::error-code` type, TCP socket methods may always return
+ /// `error(invalid-state)` when in the `closed` state.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource tcp-socket {
+ /// Create a new TCP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// Unlike POSIX, WASI sockets have no notion of a socket-level
+ /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
+ /// async support.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ create: static func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
+ /// Bind the socket to the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
+ ///
+ /// Bind can be attempted multiple times on the same socket, even with
+ /// different arguments on each iteration. But never concurrently and
+ /// only as long as the previous bind failed. Once a bind succeeds, the
+ /// binding can't be changed anymore.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
+ /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
+ ///
+ /// # Implementors note
+ /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
+ /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
+ /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
+ /// and SO_REUSEADDR performs something different entirely.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.3.0-rc-2025-09-16)
+ bind: func(local-address: ip-socket-address) -> result<_, error-code>;
+ /// Connect to a remote endpoint.
+ ///
+ /// On success, the socket is transitioned into the `connected` state and this function returns a connection resource.
+ ///
+ /// After a failed connection attempt, the socket will be in the `closed`
+ /// state and the only valid action left is to `drop` the socket. A single
+ /// socket can not be used to connect more than once.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
+ /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
+ /// - `invalid-state`: The socket is already in the `connecting` state. (EALREADY)
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
+ /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
+ /// - `timeout`: Connection timed out. (ETIMEDOUT)
+ /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.3.0-rc-2025-09-16)
+ connect: async func(remote-address: ip-socket-address) -> result<_, error-code>;
+ /// Start listening and return a stream of new inbound connections.
+ ///
+ /// Transitions the socket into the `listening` state. This can be called
+ /// at most once per socket.
+ ///
+ /// If the socket is not already explicitly bound, this function will
+ /// implicitly bind the socket to a random free port.
+ ///
+ /// Normally, the returned sockets are bound, in the `connected` state
+ /// and immediately ready for I/O. Though, depending on exact timing and
+ /// circumstances, a newly accepted connection may already be `closed`
+ /// by the time the server attempts to perform its first I/O on it. This
+ /// is true regardless of whether the WASI implementation uses
+ /// "synthesized" sockets or not (see Implementors Notes below).
+ ///
+ /// The following properties are inherited from the listener socket:
+ /// - `address-family`
+ /// - `keep-alive-enabled`
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// - `hop-limit`
+ /// - `receive-buffer-size`
+ /// - `send-buffer-size`
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
+ /// - `invalid-state`: The socket is already in the `listening` state.
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
+ ///
+ /// # Implementors note
+ /// This method returns a single perpetual stream that should only close
+ /// on fatal errors (if any). Yet, the POSIX' `accept` function may also
+ /// return transient errors (e.g. ECONNABORTED). The exact details differ
+ /// per operation system. For example, the Linux manual mentions:
+ ///
+ /// > Linux accept() passes already-pending network errors on the new
+ /// > socket as an error code from accept(). This behavior differs from
+ /// > other BSD socket implementations. For reliable operation the
+ /// > application should detect the network errors defined for the
+ /// > protocol after accept() and treat them like EAGAIN by retrying.
+ /// > In the case of TCP/IP, these are ENETDOWN, EPROTO, ENOPROTOOPT,
+ /// > EHOSTDOWN, ENONET, EHOSTUNREACH, EOPNOTSUPP, and ENETUNREACH.
+ /// Source: https://man7.org/linux/man-pages/man2/accept.2.html
+ ///
+ /// WASI implementations have two options to handle this:
+ /// - Optionally log it and then skip over non-fatal errors returned by
+ /// `accept`. Guest code never gets to see these failures. Or:
+ /// - Synthesize a `tcp-socket` resource that exposes the error when
+ /// attempting to send or receive on it. Guest code then sees these
+ /// failures as regular I/O errors.
+ ///
+ /// In either case, the stream returned by this `listen` method remains
+ /// operational.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
+ /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ listen: func() -> result<stream<tcp-socket>, error-code>;
+ /// Transmit data to peer.
+ ///
+ /// The caller should close the stream when it has no more data to send
+ /// to the peer. Under normal circumstances this will cause a FIN packet
+ /// to be sent out. Closing the stream is equivalent to calling
+ /// `shutdown(SHUT_WR)` in POSIX.
+ ///
+ /// This function may be called at most once and returns once the full
+ /// contents of the stream are transmitted or an error is encountered.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/send.html>
+ /// - <https://man7.org/linux/man-pages/man2/send.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ send: async func(data: stream<u8>) -> result<_, error-code>;
+ /// Read data from peer.
+ ///
+ /// This function returns a `stream` which provides the data received from the
+ /// socket, and a `future` providing additional error information in case the
+ /// socket is closed abnormally.
+ ///
+ /// If the socket is closed normally, `stream.read` on the `stream` will return
+ /// `read-status::closed` with no `error-context` and the future resolves to
+ /// the value `ok`. If the socket is closed abnormally, `stream.read` on the
+ /// `stream` returns `read-status::closed` with an `error-context` and the future
+ /// resolves to `err` with an `error-code`.
+ ///
+ /// `receive` is meant to be called only once per socket. If it is called more
+ /// than once, the subsequent calls return a new `stream` that fails as if it
+ /// were closed abnormally.
+ ///
+ /// If the caller is not expecting to receive any data from the peer,
+ /// they may drop the stream. Any data still in the receive queue
+ /// will be discarded. This is equivalent to calling `shutdown(SHUT_RD)`
+ /// in POSIX.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html>
+ /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ receive: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
+ /// Get the bound local address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the remote address.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether the socket is in the `listening` state.
+ ///
+ /// Equivalent to the SO_ACCEPTCONN socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-is-listening: func() -> bool;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// This is the value passed to the constructor.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-address-family: func() -> ip-address-family;
+ /// Hints the desired listen queue size. Implementations are free to ignore this.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
+ /// - `invalid-argument`: (set) The provided value was 0.
+ /// - `invalid-state`: (set) The socket is in the `connecting` or `connected` state.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
+ /// Enables or disables keepalive.
+ ///
+ /// The keepalive behavior can be adjusted using:
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
+ ///
+ /// Equivalent to the SO_KEEPALIVE socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-enabled: func() -> result<bool, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
+ /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-idle-time: func() -> result<duration, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
+ /// The time between keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPINTVL socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-interval: func() -> result<duration, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
+ /// The maximum amount of keepalive packets TCP should send before aborting the connection.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPCNT socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-count: func() -> result<u32, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-count: func(value: u32) -> result<_, error-code>;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ }
+
+ /// A UDP socket handle.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource udp-socket {
+ /// Create a new UDP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// Unlike POSIX, WASI sockets have no notion of a socket-level
+ /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
+ /// async support.
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ create: static func(address-family: ip-address-family) -> result<udp-socket, error-code>;
+ /// Bind the socket to the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the port is zero, the socket will be bound to a random free port.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.3.0-rc-2025-09-16)
+ bind: func(local-address: ip-socket-address) -> result<_, error-code>;
+ /// Associate this socket with a specific peer address.
+ ///
+ /// On success, the `remote-address` of the socket is updated.
+ /// The `local-address` may be updated as well, based on the best network
+ /// path to `remote-address`. If the socket was not already explicitly
+ /// bound, this function will implicitly bind the socket to a random
+ /// free port.
+ ///
+ /// When a UDP socket is "connected", the `send` and `receive` methods
+ /// are limited to communicating with that peer only:
+ /// - `send` can only be used to send to this destination.
+ /// - `receive` will only return datagrams sent from the provided `remote-address`.
+ ///
+ /// The name "connect" was kept to align with the existing POSIX
+ /// terminology. Other than that, this function only changes the local
+ /// socket configuration and does not generate any network traffic.
+ /// The peer is not aware of this "connection".
+ ///
+ /// This method may be called multiple times on the same socket to change
+ /// its association, but only the most recent one will be effective.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ ///
+ /// # Implementors note
+ /// If the socket is already connected, some platforms (e.g. Linux)
+ /// require a disconnect before connecting to a different peer address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.3.0-rc-2025-09-16)
+ connect: func(remote-address: ip-socket-address) -> result<_, error-code>;
+ /// Dissociate this socket from its peer address.
+ ///
+ /// After calling this method, `send` & `receive` are free to communicate
+ /// with any address again.
+ ///
+ /// The POSIX equivalent of this is calling `connect` with an `AF_UNSPEC` address.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not connected.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.3.0-rc-2025-09-16)
+ disconnect: func() -> result<_, error-code>;
+ /// Send a message on the socket to a particular peer.
+ ///
+ /// If the socket is connected, the peer address may be left empty. In
+ /// that case this is equivalent to `send` in POSIX. Otherwise it is
+ /// equivalent to `sendto`.
+ ///
+ /// Additionally, if the socket is connected, a `remote-address` argument
+ /// _may_ be provided but then it must be identical to the address
+ /// passed to `connect`.
+ ///
+ /// Implementations may trap if the `data` length exceeds 64 KiB.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `connect`. (EISCONN)
+ /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/send.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ send: async func(data: list<u8>, remote-address: option<ip-socket-address>) -> result<_, error-code>;
+ /// Receive a message on the socket.
+ ///
+ /// On success, the return value contains a tuple of the received data
+ /// and the address of the sender. Theoretical maximum length of the
+ /// data is 64 KiB. Though in practice, it will typically be less than
+ /// 1500 bytes.
+ ///
+ /// If the socket is connected, the sender address is guaranteed to
+ /// match the remote address passed to `connect`.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket has not been bound yet.
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/mswsock/nc-mswsock-lpfn_wsarecvmsg>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ receive: async func() -> result<tuple<list<u8>, ip-socket-address>, error-code>;
+ /// Get the current bound address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the address the socket is currently "connected" to.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not "connected" to a specific remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// This is the value passed to the constructor.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-address-family: func() -> ip-address-family;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-unicast-hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ }
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface ip-name-lookup {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use types.{ip-address};
+
+ /// Lookup error codes.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum error-code {
+ /// Unknown error
+ unknown,
+ /// Access denied.
+ ///
+ /// POSIX equivalent: EACCES, EPERM
+ access-denied,
+ /// `name` is a syntactically invalid domain name or IP address.
+ ///
+ /// POSIX equivalent: EINVAL
+ invalid-argument,
+ /// Name does not exist or has no suitable associated IP addresses.
+ ///
+ /// POSIX equivalent: EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY
+ name-unresolvable,
+ /// A temporary failure in name resolution occurred.
+ ///
+ /// POSIX equivalent: EAI_AGAIN
+ temporary-resolver-failure,
+ /// A permanent failure in name resolution occurred.
+ ///
+ /// POSIX equivalent: EAI_FAIL
+ permanent-resolver-failure,
+ }
+
+ /// Resolve an internet host name to a list of IP addresses.
+ ///
+ /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
+ /// If the input is an IP address string, the address is parsed and returned
+ /// as-is without making any external requests.
+ ///
+ /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
+ ///
+ /// The results are returned in connection order preference.
+ ///
+ /// This function never succeeds with 0 results. It either fails or succeeds
+ /// with at least one address. Additionally, this function never returns
+ /// IPv4-mapped IPv6 addresses.
+ ///
+ /// The returned future will resolve to an error code in case of failure.
+ /// It will resolve to success once the returned stream is exhausted.
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
+ /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
+ @since(version = 0.3.0-rc-2025-09-16)
+ resolve-addresses: async func(name: string) -> result<list<ip-address>, error-code>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wasi:clocks/[email protected];
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wasi:clocks/[email protected];
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import ip-name-lookup;
+}
diff --git a/crates/wasi-http/src/p3/wit/deps/sockets/ip-name-lookup.wit b/crates/wasi-http/src/p3/wit/deps/sockets/ip-name-lookup.wit
deleted file mode 100644
index 6a652ff232..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/sockets/ip-name-lookup.wit
+++ /dev/null
@@ -1,62 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface ip-name-lookup {
- @since(version = 0.3.0-rc-2025-09-16)
- use types.{ip-address};
-
- /// Lookup error codes.
- @since(version = 0.3.0-rc-2025-09-16)
- enum error-code {
- /// Unknown error
- unknown,
-
- /// Access denied.
- ///
- /// POSIX equivalent: EACCES, EPERM
- access-denied,
-
- /// `name` is a syntactically invalid domain name or IP address.
- ///
- /// POSIX equivalent: EINVAL
- invalid-argument,
-
- /// Name does not exist or has no suitable associated IP addresses.
- ///
- /// POSIX equivalent: EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY
- name-unresolvable,
-
- /// A temporary failure in name resolution occurred.
- ///
- /// POSIX equivalent: EAI_AGAIN
- temporary-resolver-failure,
-
- /// A permanent failure in name resolution occurred.
- ///
- /// POSIX equivalent: EAI_FAIL
- permanent-resolver-failure,
- }
-
- /// Resolve an internet host name to a list of IP addresses.
- ///
- /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
- /// If the input is an IP address string, the address is parsed and returned
- /// as-is without making any external requests.
- ///
- /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
- ///
- /// The results are returned in connection order preference.
- ///
- /// This function never succeeds with 0 results. It either fails or succeeds
- /// with at least one address. Additionally, this function never returns
- /// IPv4-mapped IPv6 addresses.
- ///
- /// The returned future will resolve to an error code in case of failure.
- /// It will resolve to success once the returned stream is exhausted.
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
- /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
- @since(version = 0.3.0-rc-2025-09-16)
- resolve-addresses: async func(name: string) -> result<list<ip-address>, error-code>;
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/sockets/types.wit b/crates/wasi-http/src/p3/wit/deps/sockets/types.wit
deleted file mode 100644
index 2ed1912e48..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/sockets/types.wit
+++ /dev/null
@@ -1,725 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- @since(version = 0.3.0-rc-2025-09-16)
- use wasi:clocks/[email protected].{duration};
-
- /// Error codes.
- ///
- /// In theory, every API can return any error code.
- /// In practice, API's typically only return the errors documented per API
- /// combined with a couple of errors that are always possible:
- /// - `unknown`
- /// - `access-denied`
- /// - `not-supported`
- /// - `out-of-memory`
- ///
- /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
- @since(version = 0.3.0-rc-2025-09-16)
- enum error-code {
- /// Unknown error
- unknown,
-
- /// Access denied.
- ///
- /// POSIX equivalent: EACCES, EPERM
- access-denied,
-
- /// The operation is not supported.
- ///
- /// POSIX equivalent: EOPNOTSUPP
- not-supported,
-
- /// One of the arguments is invalid.
- ///
- /// POSIX equivalent: EINVAL
- invalid-argument,
-
- /// Not enough memory to complete the operation.
- ///
- /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
- out-of-memory,
-
- /// The operation timed out before it could finish completely.
- timeout,
-
- /// The operation is not valid in the socket's current state.
- invalid-state,
-
- /// A bind operation failed because the provided address is not an address that the `network` can bind to.
- address-not-bindable,
-
- /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
- address-in-use,
-
- /// The remote address is not reachable
- remote-unreachable,
-
-
- /// The TCP connection was forcefully rejected
- connection-refused,
-
- /// The TCP connection was reset.
- connection-reset,
-
- /// A TCP connection was aborted.
- connection-aborted,
-
-
- /// The size of a datagram sent to a UDP socket exceeded the maximum
- /// supported size.
- datagram-too-large,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- enum ip-address-family {
- /// Similar to `AF_INET` in POSIX.
- ipv4,
-
- /// Similar to `AF_INET6` in POSIX.
- ipv6,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- type ipv4-address = tuple<u8, u8, u8, u8>;
- @since(version = 0.3.0-rc-2025-09-16)
- type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
-
- @since(version = 0.3.0-rc-2025-09-16)
- variant ip-address {
- ipv4(ipv4-address),
- ipv6(ipv6-address),
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- record ipv4-socket-address {
- /// sin_port
- port: u16,
- /// sin_addr
- address: ipv4-address,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- record ipv6-socket-address {
- /// sin6_port
- port: u16,
- /// sin6_flowinfo
- flow-info: u32,
- /// sin6_addr
- address: ipv6-address,
- /// sin6_scope_id
- scope-id: u32,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- variant ip-socket-address {
- ipv4(ipv4-socket-address),
- ipv6(ipv6-socket-address),
- }
-
- /// A TCP socket resource.
- ///
- /// The socket can be in one of the following states:
- /// - `unbound`
- /// - `bound` (See note below)
- /// - `listening`
- /// - `connecting`
- /// - `connected`
- /// - `closed`
- /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics-0.3.0-draft.md>
- /// for more information.
- ///
- /// Note: Except where explicitly mentioned, whenever this documentation uses
- /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
- /// (i.e. `bound`, `listening`, `connecting` or `connected`)
- ///
- /// In addition to the general error codes documented on the
- /// `types::error-code` type, TCP socket methods may always return
- /// `error(invalid-state)` when in the `closed` state.
- @since(version = 0.3.0-rc-2025-09-16)
- resource tcp-socket {
-
- /// Create a new TCP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// Unlike POSIX, WASI sockets have no notion of a socket-level
- /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
- /// async support.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- create: static func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
-
- /// Bind the socket to the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
- ///
- /// Bind can be attempted multiple times on the same socket, even with
- /// different arguments on each iteration. But never concurrently and
- /// only as long as the previous bind failed. Once a bind succeeds, the
- /// binding can't be changed anymore.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
- /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
- ///
- /// # Implementors note
- /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
- /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
- /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
- /// and SO_REUSEADDR performs something different entirely.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.3.0-rc-2025-09-16)
- bind: func(local-address: ip-socket-address) -> result<_, error-code>;
-
- /// Connect to a remote endpoint.
- ///
- /// On success, the socket is transitioned into the `connected` state and this function returns a connection resource.
- ///
- /// After a failed connection attempt, the socket will be in the `closed`
- /// state and the only valid action left is to `drop` the socket. A single
- /// socket can not be used to connect more than once.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
- /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
- /// - `invalid-state`: The socket is already in the `connecting` state. (EALREADY)
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
- /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
- /// - `timeout`: Connection timed out. (ETIMEDOUT)
- /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.3.0-rc-2025-09-16)
- connect: async func(remote-address: ip-socket-address) -> result<_, error-code>;
-
- /// Start listening and return a stream of new inbound connections.
- ///
- /// Transitions the socket into the `listening` state. This can be called
- /// at most once per socket.
- ///
- /// If the socket is not already explicitly bound, this function will
- /// implicitly bind the socket to a random free port.
- ///
- /// Normally, the returned sockets are bound, in the `connected` state
- /// and immediately ready for I/O. Though, depending on exact timing and
- /// circumstances, a newly accepted connection may already be `closed`
- /// by the time the server attempts to perform its first I/O on it. This
- /// is true regardless of whether the WASI implementation uses
- /// "synthesized" sockets or not (see Implementors Notes below).
- ///
- /// The following properties are inherited from the listener socket:
- /// - `address-family`
- /// - `keep-alive-enabled`
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// - `hop-limit`
- /// - `receive-buffer-size`
- /// - `send-buffer-size`
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
- /// - `invalid-state`: The socket is already in the `listening` state.
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
- ///
- /// # Implementors note
- /// This method returns a single perpetual stream that should only close
- /// on fatal errors (if any). Yet, the POSIX' `accept` function may also
- /// return transient errors (e.g. ECONNABORTED). The exact details differ
- /// per operation system. For example, the Linux manual mentions:
- ///
- /// > Linux accept() passes already-pending network errors on the new
- /// > socket as an error code from accept(). This behavior differs from
- /// > other BSD socket implementations. For reliable operation the
- /// > application should detect the network errors defined for the
- /// > protocol after accept() and treat them like EAGAIN by retrying.
- /// > In the case of TCP/IP, these are ENETDOWN, EPROTO, ENOPROTOOPT,
- /// > EHOSTDOWN, ENONET, EHOSTUNREACH, EOPNOTSUPP, and ENETUNREACH.
- /// Source: https://man7.org/linux/man-pages/man2/accept.2.html
- ///
- /// WASI implementations have two options to handle this:
- /// - Optionally log it and then skip over non-fatal errors returned by
- /// `accept`. Guest code never gets to see these failures. Or:
- /// - Synthesize a `tcp-socket` resource that exposes the error when
- /// attempting to send or receive on it. Guest code then sees these
- /// failures as regular I/O errors.
- ///
- /// In either case, the stream returned by this `listen` method remains
- /// operational.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
- /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
- /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- listen: func() -> result<stream<tcp-socket>, error-code>;
-
- /// Transmit data to peer.
- ///
- /// The caller should close the stream when it has no more data to send
- /// to the peer. Under normal circumstances this will cause a FIN packet
- /// to be sent out. Closing the stream is equivalent to calling
- /// `shutdown(SHUT_WR)` in POSIX.
- ///
- /// This function may be called at most once and returns once the full
- /// contents of the stream are transmitted or an error is encountered.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/send.html>
- /// - <https://man7.org/linux/man-pages/man2/send.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- send: async func(data: stream<u8>) -> result<_, error-code>;
-
- /// Read data from peer.
- ///
- /// This function returns a `stream` which provides the data received from the
- /// socket, and a `future` providing additional error information in case the
- /// socket is closed abnormally.
- ///
- /// If the socket is closed normally, `stream.read` on the `stream` will return
- /// `read-status::closed` with no `error-context` and the future resolves to
- /// the value `ok`. If the socket is closed abnormally, `stream.read` on the
- /// `stream` returns `read-status::closed` with an `error-context` and the future
- /// resolves to `err` with an `error-code`.
- ///
- /// `receive` is meant to be called only once per socket. If it is called more
- /// than once, the subsequent calls return a new `stream` that fails as if it
- /// were closed abnormally.
- ///
- /// If the caller is not expecting to receive any data from the peer,
- /// they may drop the stream. Any data still in the receive queue
- /// will be discarded. This is equivalent to calling `shutdown(SHUT_RD)`
- /// in POSIX.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html>
- /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- receive: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
-
- /// Get the bound local address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.3.0-rc-2025-09-16)
- get-local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the remote address.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.3.0-rc-2025-09-16)
- get-remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether the socket is in the `listening` state.
- ///
- /// Equivalent to the SO_ACCEPTCONN socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-is-listening: func() -> bool;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// This is the value passed to the constructor.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-address-family: func() -> ip-address-family;
-
- /// Hints the desired listen queue size. Implementations are free to ignore this.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- ///
- /// # Typical errors
- /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
- /// - `invalid-argument`: (set) The provided value was 0.
- /// - `invalid-state`: (set) The socket is in the `connecting` or `connected` state.
- @since(version = 0.3.0-rc-2025-09-16)
- set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
-
- /// Enables or disables keepalive.
- ///
- /// The keepalive behavior can be adjusted using:
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
- ///
- /// Equivalent to the SO_KEEPALIVE socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-enabled: func() -> result<bool, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
-
- /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-idle-time: func() -> result<duration, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
-
- /// The time between keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPINTVL socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-interval: func() -> result<duration, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
-
- /// The maximum amount of keepalive packets TCP should send before aborting the connection.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPCNT socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-count: func() -> result<u32, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-count: func(value: u32) -> result<_, error-code>;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.3.0-rc-2025-09-16)
- get-hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- get-send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
- }
-
- /// A UDP socket handle.
- @since(version = 0.3.0-rc-2025-09-16)
- resource udp-socket {
-
- /// Create a new UDP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// Unlike POSIX, WASI sockets have no notion of a socket-level
- /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
- /// async support.
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- create: static func(address-family: ip-address-family) -> result<udp-socket, error-code>;
-
- /// Bind the socket to the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the port is zero, the socket will be bound to a random free port.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.3.0-rc-2025-09-16)
- bind: func(local-address: ip-socket-address) -> result<_, error-code>;
-
- /// Associate this socket with a specific peer address.
- ///
- /// On success, the `remote-address` of the socket is updated.
- /// The `local-address` may be updated as well, based on the best network
- /// path to `remote-address`. If the socket was not already explicitly
- /// bound, this function will implicitly bind the socket to a random
- /// free port.
- ///
- /// When a UDP socket is "connected", the `send` and `receive` methods
- /// are limited to communicating with that peer only:
- /// - `send` can only be used to send to this destination.
- /// - `receive` will only return datagrams sent from the provided `remote-address`.
- ///
- /// The name "connect" was kept to align with the existing POSIX
- /// terminology. Other than that, this function only changes the local
- /// socket configuration and does not generate any network traffic.
- /// The peer is not aware of this "connection".
- ///
- /// This method may be called multiple times on the same socket to change
- /// its association, but only the most recent one will be effective.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- ///
- /// # Implementors note
- /// If the socket is already connected, some platforms (e.g. Linux)
- /// require a disconnect before connecting to a different peer address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.3.0-rc-2025-09-16)
- connect: func(remote-address: ip-socket-address) -> result<_, error-code>;
-
- /// Dissociate this socket from its peer address.
- ///
- /// After calling this method, `send` & `receive` are free to communicate
- /// with any address again.
- ///
- /// The POSIX equivalent of this is calling `connect` with an `AF_UNSPEC` address.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not connected.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.3.0-rc-2025-09-16)
- disconnect: func() -> result<_, error-code>;
-
- /// Send a message on the socket to a particular peer.
- ///
- /// If the socket is connected, the peer address may be left empty. In
- /// that case this is equivalent to `send` in POSIX. Otherwise it is
- /// equivalent to `sendto`.
- ///
- /// Additionally, if the socket is connected, a `remote-address` argument
- /// _may_ be provided but then it must be identical to the address
- /// passed to `connect`.
- ///
- /// Implementations may trap if the `data` length exceeds 64 KiB.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `connect`. (EISCONN)
- /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/send.2.html>
- /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- send: async func(data: list<u8>, remote-address: option<ip-socket-address>) -> result<_, error-code>;
-
- /// Receive a message on the socket.
- ///
- /// On success, the return value contains a tuple of the received data
- /// and the address of the sender. Theoretical maximum length of the
- /// data is 64 KiB. Though in practice, it will typically be less than
- /// 1500 bytes.
- ///
- /// If the socket is connected, the sender address is guaranteed to
- /// match the remote address passed to `connect`.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket has not been bound yet.
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
- /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/mswsock/nc-mswsock-lpfn_wsarecvmsg>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- receive: async func() -> result<tuple<list<u8>, ip-socket-address>, error-code>;
-
- /// Get the current bound address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.3.0-rc-2025-09-16)
- get-local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the address the socket is currently "connected" to.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not "connected" to a specific remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.3.0-rc-2025-09-16)
- get-remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// This is the value passed to the constructor.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-address-family: func() -> ip-address-family;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.3.0-rc-2025-09-16)
- get-unicast-hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- get-send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
- }
-}
diff --git a/crates/wasi-http/src/p3/wit/deps/sockets/world.wit b/crates/wasi-http/src/p3/wit/deps/sockets/world.wit
deleted file mode 100644
index 44cc427ed1..0000000000
--- a/crates/wasi-http/src/p3/wit/deps/sockets/world.wit
+++ /dev/null
@@ -1,9 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import types;
- @since(version = 0.3.0-rc-2025-09-16)
- import ip-name-lookup;
-}
diff --git a/crates/wasi-http/wit/deps/cli.wit b/crates/wasi-http/wit/deps/cli.wit
new file mode 100644
index 0000000000..d7a3ca4d2c
--- /dev/null
+++ b/crates/wasi-http/wit/deps/cli.wit
@@ -0,0 +1,261 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface environment {
+ /// Get the POSIX-style environment variables.
+ ///
+ /// Each environment variable is provided as a pair of string variable names
+ /// and string value.
+ ///
+ /// Morally, these are a value import, but until value imports are available
+ /// in the component model, this import function should return the same
+ /// values each time it is called.
+ @since(version = 0.2.0)
+ get-environment: func() -> list<tuple<string, string>>;
+
+ /// Get the POSIX-style arguments to the program.
+ @since(version = 0.2.0)
+ get-arguments: func() -> list<string>;
+
+ /// Return a path that programs should use as their initial current working
+ /// directory, interpreting `.` as shorthand for this.
+ @since(version = 0.2.0)
+ initial-cwd: func() -> option<string>;
+}
+
+@since(version = 0.2.0)
+interface exit {
+ /// Exit the current instance and any linked instances.
+ @since(version = 0.2.0)
+ exit: func(status: result);
+
+ /// Exit the current instance and any linked instances, reporting the
+ /// specified status code to the host.
+ ///
+ /// The meaning of the code depends on the context, with 0 usually meaning
+ /// "success", and other values indicating various types of failure.
+ ///
+ /// This function does not return; the effect is analogous to a trap, but
+ /// without the connotation that something bad has happened.
+ @unstable(feature = cli-exit-with-code)
+ exit-with-code: func(status-code: u8);
+}
+
+@since(version = 0.2.0)
+interface run {
+ /// Run the program.
+ @since(version = 0.2.0)
+ run: func() -> result;
+}
+
+@since(version = 0.2.0)
+interface stdin {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{input-stream};
+
+ @since(version = 0.2.0)
+ get-stdin: func() -> input-stream;
+}
+
+@since(version = 0.2.0)
+interface stdout {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{output-stream};
+
+ @since(version = 0.2.0)
+ get-stdout: func() -> output-stream;
+}
+
+@since(version = 0.2.0)
+interface stderr {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{output-stream};
+
+ @since(version = 0.2.0)
+ get-stderr: func() -> output-stream;
+}
+
+/// Terminal input.
+///
+/// In the future, this may include functions for disabling echoing,
+/// disabling input buffering so that keyboard events are sent through
+/// immediately, querying supported features, and so on.
+@since(version = 0.2.0)
+interface terminal-input {
+ /// The input side of a terminal.
+ @since(version = 0.2.0)
+ resource terminal-input;
+}
+
+/// Terminal output.
+///
+/// In the future, this may include functions for querying the terminal
+/// size, being notified of terminal size changes, querying supported
+/// features, and so on.
+@since(version = 0.2.0)
+interface terminal-output {
+ /// The output side of a terminal.
+ @since(version = 0.2.0)
+ resource terminal-output;
+}
+
+/// An interface providing an optional `terminal-input` for stdin as a
+/// link-time authority.
+@since(version = 0.2.0)
+interface terminal-stdin {
+ @since(version = 0.2.0)
+ use terminal-input.{terminal-input};
+
+ /// If stdin is connected to a terminal, return a `terminal-input` handle
+ /// allowing further interaction with it.
+ @since(version = 0.2.0)
+ get-terminal-stdin: func() -> option<terminal-input>;
+}
+
+/// An interface providing an optional `terminal-output` for stdout as a
+/// link-time authority.
+@since(version = 0.2.0)
+interface terminal-stdout {
+ @since(version = 0.2.0)
+ use terminal-output.{terminal-output};
+
+ /// If stdout is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.2.0)
+ get-terminal-stdout: func() -> option<terminal-output>;
+}
+
+/// An interface providing an optional `terminal-output` for stderr as a
+/// link-time authority.
+@since(version = 0.2.0)
+interface terminal-stderr {
+ @since(version = 0.2.0)
+ use terminal-output.{terminal-output};
+
+ /// If stderr is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.2.0)
+ get-terminal-stderr: func() -> option<terminal-output>;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import environment;
+ @since(version = 0.2.0)
+ import exit;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import stdin;
+ @since(version = 0.2.0)
+ import stdout;
+ @since(version = 0.2.0)
+ import stderr;
+ @since(version = 0.2.0)
+ import terminal-input;
+ @since(version = 0.2.0)
+ import terminal-output;
+ @since(version = 0.2.0)
+ import terminal-stdin;
+ @since(version = 0.2.0)
+ import terminal-stdout;
+ @since(version = 0.2.0)
+ import terminal-stderr;
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+}
+@since(version = 0.2.0)
+world command {
+ @since(version = 0.2.0)
+ import environment;
+ @since(version = 0.2.0)
+ import exit;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import stdin;
+ @since(version = 0.2.0)
+ import stdout;
+ @since(version = 0.2.0)
+ import stderr;
+ @since(version = 0.2.0)
+ import terminal-input;
+ @since(version = 0.2.0)
+ import terminal-output;
+ @since(version = 0.2.0)
+ import terminal-stdin;
+ @since(version = 0.2.0)
+ import terminal-stdout;
+ @since(version = 0.2.0)
+ import terminal-stderr;
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+
+ @since(version = 0.2.0)
+ export run;
+}
diff --git a/crates/wasi-http/wit/deps/cli/command.wit b/crates/wasi-http/wit/deps/cli/command.wit
deleted file mode 100644
index 6d3cc83f5f..0000000000
--- a/crates/wasi-http/wit/deps/cli/command.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world command {
- @since(version = 0.2.0)
- include imports;
-
- @since(version = 0.2.0)
- export run;
-}
diff --git a/crates/wasi-http/wit/deps/cli/environment.wit b/crates/wasi-http/wit/deps/cli/environment.wit
deleted file mode 100644
index 2f449bd7c1..0000000000
--- a/crates/wasi-http/wit/deps/cli/environment.wit
+++ /dev/null
@@ -1,22 +0,0 @@
-@since(version = 0.2.0)
-interface environment {
- /// Get the POSIX-style environment variables.
- ///
- /// Each environment variable is provided as a pair of string variable names
- /// and string value.
- ///
- /// Morally, these are a value import, but until value imports are available
- /// in the component model, this import function should return the same
- /// values each time it is called.
- @since(version = 0.2.0)
- get-environment: func() -> list<tuple<string, string>>;
-
- /// Get the POSIX-style arguments to the program.
- @since(version = 0.2.0)
- get-arguments: func() -> list<string>;
-
- /// Return a path that programs should use as their initial current working
- /// directory, interpreting `.` as shorthand for this.
- @since(version = 0.2.0)
- initial-cwd: func() -> option<string>;
-}
diff --git a/crates/wasi-http/wit/deps/cli/exit.wit b/crates/wasi-http/wit/deps/cli/exit.wit
deleted file mode 100644
index 427935c8d0..0000000000
--- a/crates/wasi-http/wit/deps/cli/exit.wit
+++ /dev/null
@@ -1,17 +0,0 @@
-@since(version = 0.2.0)
-interface exit {
- /// Exit the current instance and any linked instances.
- @since(version = 0.2.0)
- exit: func(status: result);
-
- /// Exit the current instance and any linked instances, reporting the
- /// specified status code to the host.
- ///
- /// The meaning of the code depends on the context, with 0 usually meaning
- /// "success", and other values indicating various types of failure.
- ///
- /// This function does not return; the effect is analogous to a trap, but
- /// without the connotation that something bad has happened.
- @unstable(feature = cli-exit-with-code)
- exit-with-code: func(status-code: u8);
-}
diff --git a/crates/wasi-http/wit/deps/cli/imports.wit b/crates/wasi-http/wit/deps/cli/imports.wit
deleted file mode 100644
index d9fd017109..0000000000
--- a/crates/wasi-http/wit/deps/cli/imports.wit
+++ /dev/null
@@ -1,36 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- include wasi:clocks/[email protected];
- @since(version = 0.2.0)
- include wasi:filesystem/[email protected];
- @since(version = 0.2.0)
- include wasi:sockets/[email protected];
- @since(version = 0.2.0)
- include wasi:random/[email protected];
- @since(version = 0.2.0)
- include wasi:io/[email protected];
-
- @since(version = 0.2.0)
- import environment;
- @since(version = 0.2.0)
- import exit;
- @since(version = 0.2.0)
- import stdin;
- @since(version = 0.2.0)
- import stdout;
- @since(version = 0.2.0)
- import stderr;
- @since(version = 0.2.0)
- import terminal-input;
- @since(version = 0.2.0)
- import terminal-output;
- @since(version = 0.2.0)
- import terminal-stdin;
- @since(version = 0.2.0)
- import terminal-stdout;
- @since(version = 0.2.0)
- import terminal-stderr;
-}
diff --git a/crates/wasi-http/wit/deps/cli/run.wit b/crates/wasi-http/wit/deps/cli/run.wit
deleted file mode 100644
index 655346efb6..0000000000
--- a/crates/wasi-http/wit/deps/cli/run.wit
+++ /dev/null
@@ -1,6 +0,0 @@
-@since(version = 0.2.0)
-interface run {
- /// Run the program.
- @since(version = 0.2.0)
- run: func() -> result;
-}
diff --git a/crates/wasi-http/wit/deps/cli/stdio.wit b/crates/wasi-http/wit/deps/cli/stdio.wit
deleted file mode 100644
index cb8aea2d90..0000000000
--- a/crates/wasi-http/wit/deps/cli/stdio.wit
+++ /dev/null
@@ -1,26 +0,0 @@
-@since(version = 0.2.0)
-interface stdin {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{input-stream};
-
- @since(version = 0.2.0)
- get-stdin: func() -> input-stream;
-}
-
-@since(version = 0.2.0)
-interface stdout {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{output-stream};
-
- @since(version = 0.2.0)
- get-stdout: func() -> output-stream;
-}
-
-@since(version = 0.2.0)
-interface stderr {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{output-stream};
-
- @since(version = 0.2.0)
- get-stderr: func() -> output-stream;
-}
diff --git a/crates/wasi-http/wit/deps/cli/terminal.wit b/crates/wasi-http/wit/deps/cli/terminal.wit
deleted file mode 100644
index d305498c64..0000000000
--- a/crates/wasi-http/wit/deps/cli/terminal.wit
+++ /dev/null
@@ -1,62 +0,0 @@
-/// Terminal input.
-///
-/// In the future, this may include functions for disabling echoing,
-/// disabling input buffering so that keyboard events are sent through
-/// immediately, querying supported features, and so on.
-@since(version = 0.2.0)
-interface terminal-input {
- /// The input side of a terminal.
- @since(version = 0.2.0)
- resource terminal-input;
-}
-
-/// Terminal output.
-///
-/// In the future, this may include functions for querying the terminal
-/// size, being notified of terminal size changes, querying supported
-/// features, and so on.
-@since(version = 0.2.0)
-interface terminal-output {
- /// The output side of a terminal.
- @since(version = 0.2.0)
- resource terminal-output;
-}
-
-/// An interface providing an optional `terminal-input` for stdin as a
-/// link-time authority.
-@since(version = 0.2.0)
-interface terminal-stdin {
- @since(version = 0.2.0)
- use terminal-input.{terminal-input};
-
- /// If stdin is connected to a terminal, return a `terminal-input` handle
- /// allowing further interaction with it.
- @since(version = 0.2.0)
- get-terminal-stdin: func() -> option<terminal-input>;
-}
-
-/// An interface providing an optional `terminal-output` for stdout as a
-/// link-time authority.
-@since(version = 0.2.0)
-interface terminal-stdout {
- @since(version = 0.2.0)
- use terminal-output.{terminal-output};
-
- /// If stdout is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.2.0)
- get-terminal-stdout: func() -> option<terminal-output>;
-}
-
-/// An interface providing an optional `terminal-output` for stderr as a
-/// link-time authority.
-@since(version = 0.2.0)
-interface terminal-stderr {
- @since(version = 0.2.0)
- use terminal-output.{terminal-output};
-
- /// If stderr is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.2.0)
- get-terminal-stderr: func() -> option<terminal-output>;
-}
diff --git a/crates/wasi-http/wit/deps/clocks.wit b/crates/wasi-http/wit/deps/clocks.wit
new file mode 100644
index 0000000000..d638f1a40f
--- /dev/null
+++ b/crates/wasi-http/wit/deps/clocks.wit
@@ -0,0 +1,157 @@
+package wasi:[email protected];
+
+/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
+/// time.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A monotonic clock is a clock which has an unspecified initial value, and
+/// successive reads of the clock will produce non-decreasing values.
+@since(version = 0.2.0)
+interface monotonic-clock {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+
+ /// An instant in time, in nanoseconds. An instant is relative to an
+ /// unspecified initial value, and can only be compared to instances from
+ /// the same monotonic-clock.
+ @since(version = 0.2.0)
+ type instant = u64;
+
+ /// A duration of time, in nanoseconds.
+ @since(version = 0.2.0)
+ type duration = u64;
+
+ /// Read the current value of the clock.
+ ///
+ /// The clock is monotonic, therefore calling this function repeatedly will
+ /// produce a sequence of non-decreasing values.
+ @since(version = 0.2.0)
+ now: func() -> instant;
+
+ /// Query the resolution of the clock. Returns the duration of time
+ /// corresponding to a clock tick.
+ @since(version = 0.2.0)
+ resolution: func() -> duration;
+
+ /// Create a `pollable` which will resolve once the specified instant
+ /// has occurred.
+ @since(version = 0.2.0)
+ subscribe-instant: func(when: instant) -> pollable;
+
+ /// Create a `pollable` that will resolve after the specified duration has
+ /// elapsed from the time this function is invoked.
+ @since(version = 0.2.0)
+ subscribe-duration: func(when: duration) -> pollable;
+}
+
+/// WASI Wall Clock is a clock API intended to let users query the current
+/// time. The name "wall" makes an analogy to a "clock on the wall", which
+/// is not necessarily monotonic as it may be reset.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A wall clock is a clock which measures the date and time according to
+/// some external reference.
+///
+/// External references may be reset, so this clock is not necessarily
+/// monotonic, making it unsuitable for measuring elapsed time.
+///
+/// It is intended for reporting the current date and time for humans.
+@since(version = 0.2.0)
+interface wall-clock {
+ /// A time and date in seconds plus nanoseconds.
+ @since(version = 0.2.0)
+ record datetime {
+ seconds: u64,
+ nanoseconds: u32,
+ }
+
+ /// Read the current value of the clock.
+ ///
+ /// This clock is not monotonic, therefore calling this function repeatedly
+ /// will not necessarily produce a sequence of non-decreasing values.
+ ///
+ /// The returned timestamps represent the number of seconds since
+ /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
+ /// also known as [Unix Time].
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ ///
+ /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
+ /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
+ @since(version = 0.2.0)
+ now: func() -> datetime;
+
+ /// Query the resolution of the clock.
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ @since(version = 0.2.0)
+ resolution: func() -> datetime;
+}
+
+@unstable(feature = clocks-timezone)
+interface timezone {
+ @unstable(feature = clocks-timezone)
+ use wall-clock.{datetime};
+
+ /// Information useful for displaying the timezone of a specific `datetime`.
+ ///
+ /// This information may vary within a single `timezone` to reflect daylight
+ /// saving time adjustments.
+ @unstable(feature = clocks-timezone)
+ record timezone-display {
+ /// The number of seconds difference between UTC time and the local
+ /// time of the timezone.
+ ///
+ /// The returned value will always be less than 86400 which is the
+ /// number of seconds in a day (24*60*60).
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return 0.
+ utc-offset: s32,
+ /// The abbreviated name of the timezone to display to a user. The name
+ /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
+ /// reference local standards for the name of the time zone.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should be the string `UTC`.
+ ///
+ /// In time zones that do not have an applicable name, a formatted
+ /// representation of the UTC offset may be returned, such as `-04:00`.
+ name: string,
+ /// Whether daylight saving time is active.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return false.
+ in-daylight-saving-time: bool,
+ }
+
+ /// Return information needed to display the given `datetime`. This includes
+ /// the UTC offset, the time zone name, and a flag indicating whether
+ /// daylight saving time is active.
+ ///
+ /// If the timezone cannot be determined for the given `datetime`, return a
+ /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
+ /// saving time.
+ @unstable(feature = clocks-timezone)
+ display: func(when: datetime) -> timezone-display;
+
+ /// The same as `display`, but only return the UTC offset.
+ @unstable(feature = clocks-timezone)
+ utc-offset: func(when: datetime) -> s32;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import monotonic-clock;
+ @since(version = 0.2.0)
+ import wall-clock;
+ @unstable(feature = clocks-timezone)
+ import timezone;
+}
diff --git a/crates/wasi-http/wit/deps/clocks/monotonic-clock.wit b/crates/wasi-http/wit/deps/clocks/monotonic-clock.wit
deleted file mode 100644
index f3bc839127..0000000000
--- a/crates/wasi-http/wit/deps/clocks/monotonic-clock.wit
+++ /dev/null
@@ -1,50 +0,0 @@
-package wasi:[email protected];
-/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
-/// time.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A monotonic clock is a clock which has an unspecified initial value, and
-/// successive reads of the clock will produce non-decreasing values.
-@since(version = 0.2.0)
-interface monotonic-clock {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
-
- /// An instant in time, in nanoseconds. An instant is relative to an
- /// unspecified initial value, and can only be compared to instances from
- /// the same monotonic-clock.
- @since(version = 0.2.0)
- type instant = u64;
-
- /// A duration of time, in nanoseconds.
- @since(version = 0.2.0)
- type duration = u64;
-
- /// Read the current value of the clock.
- ///
- /// The clock is monotonic, therefore calling this function repeatedly will
- /// produce a sequence of non-decreasing values.
- @since(version = 0.2.0)
- now: func() -> instant;
-
- /// Query the resolution of the clock. Returns the duration of time
- /// corresponding to a clock tick.
- @since(version = 0.2.0)
- resolution: func() -> duration;
-
- /// Create a `pollable` which will resolve once the specified instant
- /// has occurred.
- @since(version = 0.2.0)
- subscribe-instant: func(
- when: instant,
- ) -> pollable;
-
- /// Create a `pollable` that will resolve after the specified duration has
- /// elapsed from the time this function is invoked.
- @since(version = 0.2.0)
- subscribe-duration: func(
- when: duration,
- ) -> pollable;
-}
diff --git a/crates/wasi-http/wit/deps/clocks/timezone.wit b/crates/wasi-http/wit/deps/clocks/timezone.wit
deleted file mode 100644
index ca98ad1528..0000000000
--- a/crates/wasi-http/wit/deps/clocks/timezone.wit
+++ /dev/null
@@ -1,55 +0,0 @@
-package wasi:[email protected];
-
-@unstable(feature = clocks-timezone)
-interface timezone {
- @unstable(feature = clocks-timezone)
- use wall-clock.{datetime};
-
- /// Return information needed to display the given `datetime`. This includes
- /// the UTC offset, the time zone name, and a flag indicating whether
- /// daylight saving time is active.
- ///
- /// If the timezone cannot be determined for the given `datetime`, return a
- /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
- /// saving time.
- @unstable(feature = clocks-timezone)
- display: func(when: datetime) -> timezone-display;
-
- /// The same as `display`, but only return the UTC offset.
- @unstable(feature = clocks-timezone)
- utc-offset: func(when: datetime) -> s32;
-
- /// Information useful for displaying the timezone of a specific `datetime`.
- ///
- /// This information may vary within a single `timezone` to reflect daylight
- /// saving time adjustments.
- @unstable(feature = clocks-timezone)
- record timezone-display {
- /// The number of seconds difference between UTC time and the local
- /// time of the timezone.
- ///
- /// The returned value will always be less than 86400 which is the
- /// number of seconds in a day (24*60*60).
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return 0.
- utc-offset: s32,
-
- /// The abbreviated name of the timezone to display to a user. The name
- /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
- /// reference local standards for the name of the time zone.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should be the string `UTC`.
- ///
- /// In time zones that do not have an applicable name, a formatted
- /// representation of the UTC offset may be returned, such as `-04:00`.
- name: string,
-
- /// Whether daylight saving time is active.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return false.
- in-daylight-saving-time: bool,
- }
-}
diff --git a/crates/wasi-http/wit/deps/clocks/wall-clock.wit b/crates/wasi-http/wit/deps/clocks/wall-clock.wit
deleted file mode 100644
index 76636a0c9b..0000000000
--- a/crates/wasi-http/wit/deps/clocks/wall-clock.wit
+++ /dev/null
@@ -1,46 +0,0 @@
-package wasi:[email protected];
-/// WASI Wall Clock is a clock API intended to let users query the current
-/// time. The name "wall" makes an analogy to a "clock on the wall", which
-/// is not necessarily monotonic as it may be reset.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A wall clock is a clock which measures the date and time according to
-/// some external reference.
-///
-/// External references may be reset, so this clock is not necessarily
-/// monotonic, making it unsuitable for measuring elapsed time.
-///
-/// It is intended for reporting the current date and time for humans.
-@since(version = 0.2.0)
-interface wall-clock {
- /// A time and date in seconds plus nanoseconds.
- @since(version = 0.2.0)
- record datetime {
- seconds: u64,
- nanoseconds: u32,
- }
-
- /// Read the current value of the clock.
- ///
- /// This clock is not monotonic, therefore calling this function repeatedly
- /// will not necessarily produce a sequence of non-decreasing values.
- ///
- /// The returned timestamps represent the number of seconds since
- /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
- /// also known as [Unix Time].
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- ///
- /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
- /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
- @since(version = 0.2.0)
- now: func() -> datetime;
-
- /// Query the resolution of the clock.
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- @since(version = 0.2.0)
- resolution: func() -> datetime;
-}
diff --git a/crates/wasi-http/wit/deps/clocks/world.wit b/crates/wasi-http/wit/deps/clocks/world.wit
deleted file mode 100644
index 5c53c51a15..0000000000
--- a/crates/wasi-http/wit/deps/clocks/world.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import monotonic-clock;
- @since(version = 0.2.0)
- import wall-clock;
- @unstable(feature = clocks-timezone)
- import timezone;
-}
diff --git a/crates/wasi-http/wit/deps/filesystem.wit b/crates/wasi-http/wit/deps/filesystem.wit
new file mode 100644
index 0000000000..9f4a8288b4
--- /dev/null
+++ b/crates/wasi-http/wit/deps/filesystem.wit
@@ -0,0 +1,587 @@
+package wasi:[email protected];
+
+/// WASI filesystem is a filesystem API primarily intended to let users run WASI
+/// programs that access their files on their existing filesystems, without
+/// significant overhead.
+///
+/// It is intended to be roughly portable between Unix-family platforms and
+/// Windows, though it does not hide many of the major differences.
+///
+/// Paths are passed as interface-type `string`s, meaning they must consist of
+/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
+/// paths which are not accessible by this API.
+///
+/// The directory separator in WASI is always the forward-slash (`/`).
+///
+/// All paths in WASI are relative paths, and are interpreted relative to a
+/// `descriptor` referring to a base directory. If a `path` argument to any WASI
+/// function starts with `/`, or if any step of resolving a `path`, including
+/// `..` and symbolic link steps, reaches a directory outside of the base
+/// directory, or reaches a symlink to an absolute or rooted path in the
+/// underlying filesystem, the function fails with `error-code::not-permitted`.
+///
+/// For more information about WASI path resolution and sandboxing, see
+/// [WASI filesystem path resolution].
+///
+/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
+@since(version = 0.2.0)
+interface types {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{input-stream, output-stream, error};
+ @since(version = 0.2.0)
+ use wasi:clocks/[email protected].{datetime};
+
+ /// File size or length of a region within a file.
+ @since(version = 0.2.0)
+ type filesize = u64;
+
+ /// The type of a filesystem object referenced by a descriptor.
+ ///
+ /// Note: This was called `filetype` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ enum descriptor-type {
+ /// The type of the descriptor or file is unknown or is different from
+ /// any of the other types specified.
+ unknown,
+ /// The descriptor refers to a block device inode.
+ block-device,
+ /// The descriptor refers to a character device inode.
+ character-device,
+ /// The descriptor refers to a directory inode.
+ directory,
+ /// The descriptor refers to a named pipe.
+ fifo,
+ /// The file refers to a symbolic link inode.
+ symbolic-link,
+ /// The descriptor refers to a regular file inode.
+ regular-file,
+ /// The descriptor refers to a socket.
+ socket,
+ }
+
+ /// Descriptor flags.
+ ///
+ /// Note: This was called `fdflags` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ flags descriptor-flags {
+ /// Read mode: Data can be read.
+ read,
+ /// Write mode: Data can be written to.
+ write,
+ /// Request that writes be performed according to synchronized I/O file
+ /// integrity completion. The data stored in the file and the file's
+ /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ file-integrity-sync,
+ /// Request that writes be performed according to synchronized I/O data
+ /// integrity completion. Only the data stored in the file is
+ /// synchronized. This is similar to `O_DSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ data-integrity-sync,
+ /// Requests that reads be performed at the same level of integrity
+ /// requested for writes. This is similar to `O_RSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ requested-write-sync,
+ /// Mutating directories mode: Directory contents may be mutated.
+ ///
+ /// When this flag is unset on a descriptor, operations using the
+ /// descriptor which would create, rename, delete, modify the data or
+ /// metadata of filesystem objects, or obtain another handle which
+ /// would permit any of those, shall fail with `error-code::read-only` if
+ /// they would otherwise succeed.
+ ///
+ /// This may only be set on directories.
+ mutate-directory,
+ }
+
+ /// Flags determining the method of how paths are resolved.
+ @since(version = 0.2.0)
+ flags path-flags {
+ /// As long as the resolved path corresponds to a symbolic link, it is
+ /// expanded.
+ symlink-follow,
+ }
+
+ /// Open flags used by `open-at`.
+ @since(version = 0.2.0)
+ flags open-flags {
+ /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
+ create,
+ /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
+ directory,
+ /// Fail if file already exists, similar to `O_EXCL` in POSIX.
+ exclusive,
+ /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
+ truncate,
+ }
+
+ /// Number of hard links to an inode.
+ @since(version = 0.2.0)
+ type link-count = u64;
+
+ /// File attributes.
+ ///
+ /// Note: This was called `filestat` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ record descriptor-stat {
+ /// File type.
+ %type: descriptor-type,
+ /// Number of hard links to the file.
+ link-count: link-count,
+ /// For regular files, the file size in bytes. For symbolic links, the
+ /// length in bytes of the pathname contained in the symbolic link.
+ size: filesize,
+ /// Last data access timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain an access
+ /// timestamp for this file.
+ data-access-timestamp: option<datetime>,
+ /// Last data modification timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// modification timestamp for this file.
+ data-modification-timestamp: option<datetime>,
+ /// Last file status-change timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// status-change timestamp for this file.
+ status-change-timestamp: option<datetime>,
+ }
+
+ /// When setting a timestamp, this gives the value to set it to.
+ @since(version = 0.2.0)
+ variant new-timestamp {
+ /// Leave the timestamp set to its previous value.
+ no-change,
+ /// Set the timestamp to the current time of the system clock associated
+ /// with the filesystem.
+ now,
+ /// Set the timestamp to the given value.
+ timestamp(datetime),
+ }
+
+ /// A directory entry.
+ record directory-entry {
+ /// The type of the file referred to by this directory entry.
+ %type: descriptor-type,
+ /// The name of the object.
+ name: string,
+ }
+
+ /// Error codes returned by functions, similar to `errno` in POSIX.
+ /// Not all of these error codes are returned by the functions provided by this
+ /// API; some are used in higher-level library layers, and others are provided
+ /// merely for alignment with POSIX.
+ enum error-code {
+ /// Permission denied, similar to `EACCES` in POSIX.
+ access,
+ /// Resource unavailable, or operation would block, similar to `EAGAIN` and `EWOULDBLOCK` in POSIX.
+ would-block,
+ /// Connection already in progress, similar to `EALREADY` in POSIX.
+ already,
+ /// Bad descriptor, similar to `EBADF` in POSIX.
+ bad-descriptor,
+ /// Device or resource busy, similar to `EBUSY` in POSIX.
+ busy,
+ /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
+ deadlock,
+ /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
+ quota,
+ /// File exists, similar to `EEXIST` in POSIX.
+ exist,
+ /// File too large, similar to `EFBIG` in POSIX.
+ file-too-large,
+ /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
+ illegal-byte-sequence,
+ /// Operation in progress, similar to `EINPROGRESS` in POSIX.
+ in-progress,
+ /// Interrupted function, similar to `EINTR` in POSIX.
+ interrupted,
+ /// Invalid argument, similar to `EINVAL` in POSIX.
+ invalid,
+ /// I/O error, similar to `EIO` in POSIX.
+ io,
+ /// Is a directory, similar to `EISDIR` in POSIX.
+ is-directory,
+ /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
+ loop,
+ /// Too many links, similar to `EMLINK` in POSIX.
+ too-many-links,
+ /// Message too large, similar to `EMSGSIZE` in POSIX.
+ message-size,
+ /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
+ name-too-long,
+ /// No such device, similar to `ENODEV` in POSIX.
+ no-device,
+ /// No such file or directory, similar to `ENOENT` in POSIX.
+ no-entry,
+ /// No locks available, similar to `ENOLCK` in POSIX.
+ no-lock,
+ /// Not enough space, similar to `ENOMEM` in POSIX.
+ insufficient-memory,
+ /// No space left on device, similar to `ENOSPC` in POSIX.
+ insufficient-space,
+ /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
+ not-directory,
+ /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
+ not-empty,
+ /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
+ not-recoverable,
+ /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
+ unsupported,
+ /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
+ no-tty,
+ /// No such device or address, similar to `ENXIO` in POSIX.
+ no-such-device,
+ /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
+ overflow,
+ /// Operation not permitted, similar to `EPERM` in POSIX.
+ not-permitted,
+ /// Broken pipe, similar to `EPIPE` in POSIX.
+ pipe,
+ /// Read-only file system, similar to `EROFS` in POSIX.
+ read-only,
+ /// Invalid seek, similar to `ESPIPE` in POSIX.
+ invalid-seek,
+ /// Text file busy, similar to `ETXTBSY` in POSIX.
+ text-file-busy,
+ /// Cross-device link, similar to `EXDEV` in POSIX.
+ cross-device,
+ }
+
+ /// File or memory access pattern advisory information.
+ @since(version = 0.2.0)
+ enum advice {
+ /// The application has no advice to give on its behavior with respect
+ /// to the specified data.
+ normal,
+ /// The application expects to access the specified data sequentially
+ /// from lower offsets to higher offsets.
+ sequential,
+ /// The application expects to access the specified data in a random
+ /// order.
+ random,
+ /// The application expects to access the specified data in the near
+ /// future.
+ will-need,
+ /// The application expects that it will not access the specified data
+ /// in the near future.
+ dont-need,
+ /// The application expects to access the specified data once and then
+ /// not reuse it thereafter.
+ no-reuse,
+ }
+
+ /// A 128-bit hash value, split into parts because wasm doesn't have a
+ /// 128-bit integer type.
+ @since(version = 0.2.0)
+ record metadata-hash-value {
+ /// 64 bits of a 128-bit hash value.
+ lower: u64,
+ /// Another 64 bits of a 128-bit hash value.
+ upper: u64,
+ }
+
+ /// A descriptor is a reference to a filesystem object, which may be a file,
+ /// directory, named pipe, special file, or other object on which filesystem
+ /// calls may be made.
+ @since(version = 0.2.0)
+ resource descriptor {
+ /// Return a stream for reading from a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be read.
+ ///
+ /// Multiple read, write, and append streams may be active on the same open
+ /// file and they do not interfere with each other.
+ ///
+ /// Note: This allows using `read-stream`, which is similar to `read` in POSIX.
+ @since(version = 0.2.0)
+ read-via-stream: func(offset: filesize) -> result<input-stream, error-code>;
+ /// Return a stream for writing to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be written.
+ ///
+ /// Note: This allows using `write-stream`, which is similar to `write` in
+ /// POSIX.
+ @since(version = 0.2.0)
+ write-via-stream: func(offset: filesize) -> result<output-stream, error-code>;
+ /// Return a stream for appending to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be appended.
+ ///
+ /// Note: This allows using `write-stream`, which is similar to `write` with
+ /// `O_APPEND` in POSIX.
+ @since(version = 0.2.0)
+ append-via-stream: func() -> result<output-stream, error-code>;
+ /// Provide file advisory information on a descriptor.
+ ///
+ /// This is similar to `posix_fadvise` in POSIX.
+ @since(version = 0.2.0)
+ advise: func(offset: filesize, length: filesize, advice: advice) -> result<_, error-code>;
+ /// Synchronize the data of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fdatasync` in POSIX.
+ @since(version = 0.2.0)
+ sync-data: func() -> result<_, error-code>;
+ /// Get flags associated with a descriptor.
+ ///
+ /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_flags` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ get-flags: func() -> result<descriptor-flags, error-code>;
+ /// Get the dynamic type of a descriptor.
+ ///
+ /// Note: This returns the same value as the `type` field of the `fd-stat`
+ /// returned by `stat`, `stat-at` and similar.
+ ///
+ /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
+ /// by `fstat` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_filetype` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ get-type: func() -> result<descriptor-type, error-code>;
+ /// Adjust the size of an open file. If this increases the file's size, the
+ /// extra bytes are filled with zeros.
+ ///
+ /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ set-size: func(size: filesize) -> result<_, error-code>;
+ /// Adjust the timestamps of an open file or directory.
+ ///
+ /// Note: This is similar to `futimens` in POSIX.
+ ///
+ /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ set-times: func(data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Read from a descriptor, without using and updating the descriptor's offset.
+ ///
+ /// This function returns a list of bytes containing the data that was
+ /// read, along with a bool which, when true, indicates that the end of the
+ /// file was reached. The returned list will contain up to `length` bytes; it
+ /// may return fewer than requested, if the end of the file is reached or
+ /// if the I/O operation is interrupted.
+ ///
+ /// In the future, this may change to return a `stream<u8, error-code>`.
+ ///
+ /// Note: This is similar to `pread` in POSIX.
+ @since(version = 0.2.0)
+ read: func(length: filesize, offset: filesize) -> result<tuple<list<u8>, bool>, error-code>;
+ /// Write to a descriptor, without using and updating the descriptor's offset.
+ ///
+ /// It is valid to write past the end of a file; the file is extended to the
+ /// extent of the write, with bytes between the previous end and the start of
+ /// the write set to zero.
+ ///
+ /// In the future, this may change to take a `stream<u8, error-code>`.
+ ///
+ /// Note: This is similar to `pwrite` in POSIX.
+ @since(version = 0.2.0)
+ write: func(buffer: list<u8>, offset: filesize) -> result<filesize, error-code>;
+ /// Read directory entries from a directory.
+ ///
+ /// On filesystems where directories contain entries referring to themselves
+ /// and their parents, often named `.` and `..` respectively, these entries
+ /// are omitted.
+ ///
+ /// This always returns a new stream which starts at the beginning of the
+ /// directory. Multiple streams may be active on the same directory, and they
+ /// do not interfere with each other.
+ @since(version = 0.2.0)
+ read-directory: func() -> result<directory-entry-stream, error-code>;
+ /// Synchronize the data and metadata of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fsync` in POSIX.
+ @since(version = 0.2.0)
+ sync: func() -> result<_, error-code>;
+ /// Create a directory.
+ ///
+ /// Note: This is similar to `mkdirat` in POSIX.
+ @since(version = 0.2.0)
+ create-directory-at: func(path: string) -> result<_, error-code>;
+ /// Return the attributes of an open file or directory.
+ ///
+ /// Note: This is similar to `fstat` in POSIX, except that it does not return
+ /// device and inode information. For testing whether two descriptors refer to
+ /// the same underlying filesystem object, use `is-same-object`. To obtain
+ /// additional data that can be used do determine whether a file has been
+ /// modified, use `metadata-hash`.
+ ///
+ /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ stat: func() -> result<descriptor-stat, error-code>;
+ /// Return the attributes of a file or directory.
+ ///
+ /// Note: This is similar to `fstatat` in POSIX, except that it does not
+ /// return device and inode information. See the `stat` description for a
+ /// discussion of alternatives.
+ ///
+ /// Note: This was called `path_filestat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ stat-at: func(path-flags: path-flags, path: string) -> result<descriptor-stat, error-code>;
+ /// Adjust the timestamps of a file or directory.
+ ///
+ /// Note: This is similar to `utimensat` in POSIX.
+ ///
+ /// Note: This was called `path_filestat_set_times` in earlier versions of
+ /// WASI.
+ @since(version = 0.2.0)
+ set-times-at: func(path-flags: path-flags, path: string, data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Create a hard link.
+ ///
+ /// Fails with `error-code::no-entry` if the old path does not exist,
+ /// with `error-code::exist` if the new path already exists, and
+ /// `error-code::not-permitted` if the old path is not a file.
+ ///
+ /// Note: This is similar to `linkat` in POSIX.
+ @since(version = 0.2.0)
+ link-at: func(old-path-flags: path-flags, old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Open a file or directory.
+ ///
+ /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
+ /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
+ /// `open-at` fails with `error-code::read-only`.
+ ///
+ /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
+ /// contains `truncate` or `create`, and the base descriptor doesn't have
+ /// `descriptor-flags::mutate-directory` set, `open-at` fails with
+ /// `error-code::read-only`.
+ ///
+ /// Note: This is similar to `openat` in POSIX.
+ @since(version = 0.2.0)
+ open-at: func(path-flags: path-flags, path: string, open-flags: open-flags, %flags: descriptor-flags) -> result<descriptor, error-code>;
+ /// Read the contents of a symbolic link.
+ ///
+ /// If the contents contain an absolute or rooted path in the underlying
+ /// filesystem, this function fails with `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `readlinkat` in POSIX.
+ @since(version = 0.2.0)
+ readlink-at: func(path: string) -> result<string, error-code>;
+ /// Remove a directory.
+ ///
+ /// Return `error-code::not-empty` if the directory is not empty.
+ ///
+ /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
+ @since(version = 0.2.0)
+ remove-directory-at: func(path: string) -> result<_, error-code>;
+ /// Rename a filesystem object.
+ ///
+ /// Note: This is similar to `renameat` in POSIX.
+ @since(version = 0.2.0)
+ rename-at: func(old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Create a symbolic link (also known as a "symlink").
+ ///
+ /// If `old-path` starts with `/`, the function fails with
+ /// `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `symlinkat` in POSIX.
+ @since(version = 0.2.0)
+ symlink-at: func(old-path: string, new-path: string) -> result<_, error-code>;
+ /// Unlink a filesystem object that is not a directory.
+ ///
+ /// Return `error-code::is-directory` if the path refers to a directory.
+ /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
+ @since(version = 0.2.0)
+ unlink-file-at: func(path: string) -> result<_, error-code>;
+ /// Test whether two descriptors refer to the same filesystem object.
+ ///
+ /// In POSIX, this corresponds to testing whether the two descriptors have the
+ /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
+ /// wasi-filesystem does not expose device and inode numbers, so this function
+ /// may be used instead.
+ @since(version = 0.2.0)
+ is-same-object: func(other: borrow<descriptor>) -> bool;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a descriptor.
+ ///
+ /// This returns a hash of the last-modification timestamp and file size, and
+ /// may also include the inode number, device number, birth timestamp, and
+ /// other metadata fields that may change when the file is modified or
+ /// replaced. It may also include a secret value chosen by the
+ /// implementation and not otherwise exposed.
+ ///
+ /// Implementations are encouraged to provide the following properties:
+ ///
+ /// - If the file is not modified or replaced, the computed hash value should
+ /// usually not change.
+ /// - If the object is modified or replaced, the computed hash value should
+ /// usually change.
+ /// - The inputs to the hash should not be easily computable from the
+ /// computed hash.
+ ///
+ /// However, none of these is required.
+ @since(version = 0.2.0)
+ metadata-hash: func() -> result<metadata-hash-value, error-code>;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a directory descriptor and a relative path.
+ ///
+ /// This performs the same hash computation as `metadata-hash`.
+ @since(version = 0.2.0)
+ metadata-hash-at: func(path-flags: path-flags, path: string) -> result<metadata-hash-value, error-code>;
+ }
+
+ /// A stream of directory entries.
+ @since(version = 0.2.0)
+ resource directory-entry-stream {
+ /// Read a single directory entry from a `directory-entry-stream`.
+ @since(version = 0.2.0)
+ read-directory-entry: func() -> result<option<directory-entry>, error-code>;
+ }
+
+ /// Attempts to extract a filesystem-related `error-code` from the stream
+ /// `error` provided.
+ ///
+ /// Stream operations which return `stream-error::last-operation-failed`
+ /// have a payload with more information about the operation that failed.
+ /// This payload can be passed through to this function to see if there's
+ /// filesystem-related information about the error to return.
+ ///
+ /// Note that this function is fallible because not all stream-related
+ /// errors are filesystem-related errors.
+ @since(version = 0.2.0)
+ filesystem-error-code: func(err: borrow<error>) -> option<error-code>;
+}
+
+@since(version = 0.2.0)
+interface preopens {
+ @since(version = 0.2.0)
+ use types.{descriptor};
+
+ /// Return the set of preopened directories, and their paths.
+ @since(version = 0.2.0)
+ get-directories: func() -> list<tuple<descriptor, string>>;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import types;
+ @since(version = 0.2.0)
+ import preopens;
+}
diff --git a/crates/wasi-http/wit/deps/filesystem/preopens.wit b/crates/wasi-http/wit/deps/filesystem/preopens.wit
deleted file mode 100644
index f228479403..0000000000
--- a/crates/wasi-http/wit/deps/filesystem/preopens.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-interface preopens {
- @since(version = 0.2.0)
- use types.{descriptor};
-
- /// Return the set of preopened directories, and their paths.
- @since(version = 0.2.0)
- get-directories: func() -> list<tuple<descriptor, string>>;
-}
diff --git a/crates/wasi-http/wit/deps/filesystem/types.wit b/crates/wasi-http/wit/deps/filesystem/types.wit
deleted file mode 100644
index 75c19044c7..0000000000
--- a/crates/wasi-http/wit/deps/filesystem/types.wit
+++ /dev/null
@@ -1,676 +0,0 @@
-package wasi:[email protected];
-/// WASI filesystem is a filesystem API primarily intended to let users run WASI
-/// programs that access their files on their existing filesystems, without
-/// significant overhead.
-///
-/// It is intended to be roughly portable between Unix-family platforms and
-/// Windows, though it does not hide many of the major differences.
-///
-/// Paths are passed as interface-type `string`s, meaning they must consist of
-/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
-/// paths which are not accessible by this API.
-///
-/// The directory separator in WASI is always the forward-slash (`/`).
-///
-/// All paths in WASI are relative paths, and are interpreted relative to a
-/// `descriptor` referring to a base directory. If a `path` argument to any WASI
-/// function starts with `/`, or if any step of resolving a `path`, including
-/// `..` and symbolic link steps, reaches a directory outside of the base
-/// directory, or reaches a symlink to an absolute or rooted path in the
-/// underlying filesystem, the function fails with `error-code::not-permitted`.
-///
-/// For more information about WASI path resolution and sandboxing, see
-/// [WASI filesystem path resolution].
-///
-/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
-@since(version = 0.2.0)
-interface types {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{input-stream, output-stream, error};
- @since(version = 0.2.0)
- use wasi:clocks/[email protected].{datetime};
-
- /// File size or length of a region within a file.
- @since(version = 0.2.0)
- type filesize = u64;
-
- /// The type of a filesystem object referenced by a descriptor.
- ///
- /// Note: This was called `filetype` in earlier versions of WASI.
- @since(version = 0.2.0)
- enum descriptor-type {
- /// The type of the descriptor or file is unknown or is different from
- /// any of the other types specified.
- unknown,
- /// The descriptor refers to a block device inode.
- block-device,
- /// The descriptor refers to a character device inode.
- character-device,
- /// The descriptor refers to a directory inode.
- directory,
- /// The descriptor refers to a named pipe.
- fifo,
- /// The file refers to a symbolic link inode.
- symbolic-link,
- /// The descriptor refers to a regular file inode.
- regular-file,
- /// The descriptor refers to a socket.
- socket,
- }
-
- /// Descriptor flags.
- ///
- /// Note: This was called `fdflags` in earlier versions of WASI.
- @since(version = 0.2.0)
- flags descriptor-flags {
- /// Read mode: Data can be read.
- read,
- /// Write mode: Data can be written to.
- write,
- /// Request that writes be performed according to synchronized I/O file
- /// integrity completion. The data stored in the file and the file's
- /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- file-integrity-sync,
- /// Request that writes be performed according to synchronized I/O data
- /// integrity completion. Only the data stored in the file is
- /// synchronized. This is similar to `O_DSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- data-integrity-sync,
- /// Requests that reads be performed at the same level of integrity
- /// requested for writes. This is similar to `O_RSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- requested-write-sync,
- /// Mutating directories mode: Directory contents may be mutated.
- ///
- /// When this flag is unset on a descriptor, operations using the
- /// descriptor which would create, rename, delete, modify the data or
- /// metadata of filesystem objects, or obtain another handle which
- /// would permit any of those, shall fail with `error-code::read-only` if
- /// they would otherwise succeed.
- ///
- /// This may only be set on directories.
- mutate-directory,
- }
-
- /// File attributes.
- ///
- /// Note: This was called `filestat` in earlier versions of WASI.
- @since(version = 0.2.0)
- record descriptor-stat {
- /// File type.
- %type: descriptor-type,
- /// Number of hard links to the file.
- link-count: link-count,
- /// For regular files, the file size in bytes. For symbolic links, the
- /// length in bytes of the pathname contained in the symbolic link.
- size: filesize,
- /// Last data access timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain an access
- /// timestamp for this file.
- data-access-timestamp: option<datetime>,
- /// Last data modification timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// modification timestamp for this file.
- data-modification-timestamp: option<datetime>,
- /// Last file status-change timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// status-change timestamp for this file.
- status-change-timestamp: option<datetime>,
- }
-
- /// Flags determining the method of how paths are resolved.
- @since(version = 0.2.0)
- flags path-flags {
- /// As long as the resolved path corresponds to a symbolic link, it is
- /// expanded.
- symlink-follow,
- }
-
- /// Open flags used by `open-at`.
- @since(version = 0.2.0)
- flags open-flags {
- /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
- create,
- /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
- directory,
- /// Fail if file already exists, similar to `O_EXCL` in POSIX.
- exclusive,
- /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
- truncate,
- }
-
- /// Number of hard links to an inode.
- @since(version = 0.2.0)
- type link-count = u64;
-
- /// When setting a timestamp, this gives the value to set it to.
- @since(version = 0.2.0)
- variant new-timestamp {
- /// Leave the timestamp set to its previous value.
- no-change,
- /// Set the timestamp to the current time of the system clock associated
- /// with the filesystem.
- now,
- /// Set the timestamp to the given value.
- timestamp(datetime),
- }
-
- /// A directory entry.
- record directory-entry {
- /// The type of the file referred to by this directory entry.
- %type: descriptor-type,
-
- /// The name of the object.
- name: string,
- }
-
- /// Error codes returned by functions, similar to `errno` in POSIX.
- /// Not all of these error codes are returned by the functions provided by this
- /// API; some are used in higher-level library layers, and others are provided
- /// merely for alignment with POSIX.
- enum error-code {
- /// Permission denied, similar to `EACCES` in POSIX.
- access,
- /// Resource unavailable, or operation would block, similar to `EAGAIN` and `EWOULDBLOCK` in POSIX.
- would-block,
- /// Connection already in progress, similar to `EALREADY` in POSIX.
- already,
- /// Bad descriptor, similar to `EBADF` in POSIX.
- bad-descriptor,
- /// Device or resource busy, similar to `EBUSY` in POSIX.
- busy,
- /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
- deadlock,
- /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
- quota,
- /// File exists, similar to `EEXIST` in POSIX.
- exist,
- /// File too large, similar to `EFBIG` in POSIX.
- file-too-large,
- /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
- illegal-byte-sequence,
- /// Operation in progress, similar to `EINPROGRESS` in POSIX.
- in-progress,
- /// Interrupted function, similar to `EINTR` in POSIX.
- interrupted,
- /// Invalid argument, similar to `EINVAL` in POSIX.
- invalid,
- /// I/O error, similar to `EIO` in POSIX.
- io,
- /// Is a directory, similar to `EISDIR` in POSIX.
- is-directory,
- /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
- loop,
- /// Too many links, similar to `EMLINK` in POSIX.
- too-many-links,
- /// Message too large, similar to `EMSGSIZE` in POSIX.
- message-size,
- /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
- name-too-long,
- /// No such device, similar to `ENODEV` in POSIX.
- no-device,
- /// No such file or directory, similar to `ENOENT` in POSIX.
- no-entry,
- /// No locks available, similar to `ENOLCK` in POSIX.
- no-lock,
- /// Not enough space, similar to `ENOMEM` in POSIX.
- insufficient-memory,
- /// No space left on device, similar to `ENOSPC` in POSIX.
- insufficient-space,
- /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
- not-directory,
- /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
- not-empty,
- /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
- not-recoverable,
- /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
- unsupported,
- /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
- no-tty,
- /// No such device or address, similar to `ENXIO` in POSIX.
- no-such-device,
- /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
- overflow,
- /// Operation not permitted, similar to `EPERM` in POSIX.
- not-permitted,
- /// Broken pipe, similar to `EPIPE` in POSIX.
- pipe,
- /// Read-only file system, similar to `EROFS` in POSIX.
- read-only,
- /// Invalid seek, similar to `ESPIPE` in POSIX.
- invalid-seek,
- /// Text file busy, similar to `ETXTBSY` in POSIX.
- text-file-busy,
- /// Cross-device link, similar to `EXDEV` in POSIX.
- cross-device,
- }
-
- /// File or memory access pattern advisory information.
- @since(version = 0.2.0)
- enum advice {
- /// The application has no advice to give on its behavior with respect
- /// to the specified data.
- normal,
- /// The application expects to access the specified data sequentially
- /// from lower offsets to higher offsets.
- sequential,
- /// The application expects to access the specified data in a random
- /// order.
- random,
- /// The application expects to access the specified data in the near
- /// future.
- will-need,
- /// The application expects that it will not access the specified data
- /// in the near future.
- dont-need,
- /// The application expects to access the specified data once and then
- /// not reuse it thereafter.
- no-reuse,
- }
-
- /// A 128-bit hash value, split into parts because wasm doesn't have a
- /// 128-bit integer type.
- @since(version = 0.2.0)
- record metadata-hash-value {
- /// 64 bits of a 128-bit hash value.
- lower: u64,
- /// Another 64 bits of a 128-bit hash value.
- upper: u64,
- }
-
- /// A descriptor is a reference to a filesystem object, which may be a file,
- /// directory, named pipe, special file, or other object on which filesystem
- /// calls may be made.
- @since(version = 0.2.0)
- resource descriptor {
- /// Return a stream for reading from a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be read.
- ///
- /// Multiple read, write, and append streams may be active on the same open
- /// file and they do not interfere with each other.
- ///
- /// Note: This allows using `read-stream`, which is similar to `read` in POSIX.
- @since(version = 0.2.0)
- read-via-stream: func(
- /// The offset within the file at which to start reading.
- offset: filesize,
- ) -> result<input-stream, error-code>;
-
- /// Return a stream for writing to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be written.
- ///
- /// Note: This allows using `write-stream`, which is similar to `write` in
- /// POSIX.
- @since(version = 0.2.0)
- write-via-stream: func(
- /// The offset within the file at which to start writing.
- offset: filesize,
- ) -> result<output-stream, error-code>;
-
- /// Return a stream for appending to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be appended.
- ///
- /// Note: This allows using `write-stream`, which is similar to `write` with
- /// `O_APPEND` in POSIX.
- @since(version = 0.2.0)
- append-via-stream: func() -> result<output-stream, error-code>;
-
- /// Provide file advisory information on a descriptor.
- ///
- /// This is similar to `posix_fadvise` in POSIX.
- @since(version = 0.2.0)
- advise: func(
- /// The offset within the file to which the advisory applies.
- offset: filesize,
- /// The length of the region to which the advisory applies.
- length: filesize,
- /// The advice.
- advice: advice
- ) -> result<_, error-code>;
-
- /// Synchronize the data of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fdatasync` in POSIX.
- @since(version = 0.2.0)
- sync-data: func() -> result<_, error-code>;
-
- /// Get flags associated with a descriptor.
- ///
- /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_flags` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- get-flags: func() -> result<descriptor-flags, error-code>;
-
- /// Get the dynamic type of a descriptor.
- ///
- /// Note: This returns the same value as the `type` field of the `fd-stat`
- /// returned by `stat`, `stat-at` and similar.
- ///
- /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
- /// by `fstat` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_filetype` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- get-type: func() -> result<descriptor-type, error-code>;
-
- /// Adjust the size of an open file. If this increases the file's size, the
- /// extra bytes are filled with zeros.
- ///
- /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
- @since(version = 0.2.0)
- set-size: func(size: filesize) -> result<_, error-code>;
-
- /// Adjust the timestamps of an open file or directory.
- ///
- /// Note: This is similar to `futimens` in POSIX.
- ///
- /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
- @since(version = 0.2.0)
- set-times: func(
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Read from a descriptor, without using and updating the descriptor's offset.
- ///
- /// This function returns a list of bytes containing the data that was
- /// read, along with a bool which, when true, indicates that the end of the
- /// file was reached. The returned list will contain up to `length` bytes; it
- /// may return fewer than requested, if the end of the file is reached or
- /// if the I/O operation is interrupted.
- ///
- /// In the future, this may change to return a `stream<u8, error-code>`.
- ///
- /// Note: This is similar to `pread` in POSIX.
- @since(version = 0.2.0)
- read: func(
- /// The maximum number of bytes to read.
- length: filesize,
- /// The offset within the file at which to read.
- offset: filesize,
- ) -> result<tuple<list<u8>, bool>, error-code>;
-
- /// Write to a descriptor, without using and updating the descriptor's offset.
- ///
- /// It is valid to write past the end of a file; the file is extended to the
- /// extent of the write, with bytes between the previous end and the start of
- /// the write set to zero.
- ///
- /// In the future, this may change to take a `stream<u8, error-code>`.
- ///
- /// Note: This is similar to `pwrite` in POSIX.
- @since(version = 0.2.0)
- write: func(
- /// Data to write
- buffer: list<u8>,
- /// The offset within the file at which to write.
- offset: filesize,
- ) -> result<filesize, error-code>;
-
- /// Read directory entries from a directory.
- ///
- /// On filesystems where directories contain entries referring to themselves
- /// and their parents, often named `.` and `..` respectively, these entries
- /// are omitted.
- ///
- /// This always returns a new stream which starts at the beginning of the
- /// directory. Multiple streams may be active on the same directory, and they
- /// do not interfere with each other.
- @since(version = 0.2.0)
- read-directory: func() -> result<directory-entry-stream, error-code>;
-
- /// Synchronize the data and metadata of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fsync` in POSIX.
- @since(version = 0.2.0)
- sync: func() -> result<_, error-code>;
-
- /// Create a directory.
- ///
- /// Note: This is similar to `mkdirat` in POSIX.
- @since(version = 0.2.0)
- create-directory-at: func(
- /// The relative path at which to create the directory.
- path: string,
- ) -> result<_, error-code>;
-
- /// Return the attributes of an open file or directory.
- ///
- /// Note: This is similar to `fstat` in POSIX, except that it does not return
- /// device and inode information. For testing whether two descriptors refer to
- /// the same underlying filesystem object, use `is-same-object`. To obtain
- /// additional data that can be used do determine whether a file has been
- /// modified, use `metadata-hash`.
- ///
- /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- stat: func() -> result<descriptor-stat, error-code>;
-
- /// Return the attributes of a file or directory.
- ///
- /// Note: This is similar to `fstatat` in POSIX, except that it does not
- /// return device and inode information. See the `stat` description for a
- /// discussion of alternatives.
- ///
- /// Note: This was called `path_filestat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- stat-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<descriptor-stat, error-code>;
-
- /// Adjust the timestamps of a file or directory.
- ///
- /// Note: This is similar to `utimensat` in POSIX.
- ///
- /// Note: This was called `path_filestat_set_times` in earlier versions of
- /// WASI.
- @since(version = 0.2.0)
- set-times-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to operate on.
- path: string,
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Create a hard link.
- ///
- /// Fails with `error-code::no-entry` if the old path does not exist,
- /// with `error-code::exist` if the new path already exists, and
- /// `error-code::not-permitted` if the old path is not a file.
- ///
- /// Note: This is similar to `linkat` in POSIX.
- @since(version = 0.2.0)
- link-at: func(
- /// Flags determining the method of how the path is resolved.
- old-path-flags: path-flags,
- /// The relative source path from which to link.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path at which to create the hard link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Open a file or directory.
- ///
- /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
- /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
- /// `open-at` fails with `error-code::read-only`.
- ///
- /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
- /// contains `truncate` or `create`, and the base descriptor doesn't have
- /// `descriptor-flags::mutate-directory` set, `open-at` fails with
- /// `error-code::read-only`.
- ///
- /// Note: This is similar to `openat` in POSIX.
- @since(version = 0.2.0)
- open-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the object to open.
- path: string,
- /// The method by which to open the file.
- open-flags: open-flags,
- /// Flags to use for the resulting descriptor.
- %flags: descriptor-flags,
- ) -> result<descriptor, error-code>;
-
- /// Read the contents of a symbolic link.
- ///
- /// If the contents contain an absolute or rooted path in the underlying
- /// filesystem, this function fails with `error-code::not-permitted`.
- ///
- /// Note: This is similar to `readlinkat` in POSIX.
- @since(version = 0.2.0)
- readlink-at: func(
- /// The relative path of the symbolic link from which to read.
- path: string,
- ) -> result<string, error-code>;
-
- /// Remove a directory.
- ///
- /// Return `error-code::not-empty` if the directory is not empty.
- ///
- /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
- @since(version = 0.2.0)
- remove-directory-at: func(
- /// The relative path to a directory to remove.
- path: string,
- ) -> result<_, error-code>;
-
- /// Rename a filesystem object.
- ///
- /// Note: This is similar to `renameat` in POSIX.
- @since(version = 0.2.0)
- rename-at: func(
- /// The relative source path of the file or directory to rename.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path to which to rename the file or directory.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Create a symbolic link (also known as a "symlink").
- ///
- /// If `old-path` starts with `/`, the function fails with
- /// `error-code::not-permitted`.
- ///
- /// Note: This is similar to `symlinkat` in POSIX.
- @since(version = 0.2.0)
- symlink-at: func(
- /// The contents of the symbolic link.
- old-path: string,
- /// The relative destination path at which to create the symbolic link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Unlink a filesystem object that is not a directory.
- ///
- /// Return `error-code::is-directory` if the path refers to a directory.
- /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
- @since(version = 0.2.0)
- unlink-file-at: func(
- /// The relative path to a file to unlink.
- path: string,
- ) -> result<_, error-code>;
-
- /// Test whether two descriptors refer to the same filesystem object.
- ///
- /// In POSIX, this corresponds to testing whether the two descriptors have the
- /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
- /// wasi-filesystem does not expose device and inode numbers, so this function
- /// may be used instead.
- @since(version = 0.2.0)
- is-same-object: func(other: borrow<descriptor>) -> bool;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a descriptor.
- ///
- /// This returns a hash of the last-modification timestamp and file size, and
- /// may also include the inode number, device number, birth timestamp, and
- /// other metadata fields that may change when the file is modified or
- /// replaced. It may also include a secret value chosen by the
- /// implementation and not otherwise exposed.
- ///
- /// Implementations are encouraged to provide the following properties:
- ///
- /// - If the file is not modified or replaced, the computed hash value should
- /// usually not change.
- /// - If the object is modified or replaced, the computed hash value should
- /// usually change.
- /// - The inputs to the hash should not be easily computable from the
- /// computed hash.
- ///
- /// However, none of these is required.
- @since(version = 0.2.0)
- metadata-hash: func() -> result<metadata-hash-value, error-code>;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a directory descriptor and a relative path.
- ///
- /// This performs the same hash computation as `metadata-hash`.
- @since(version = 0.2.0)
- metadata-hash-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<metadata-hash-value, error-code>;
- }
-
- /// A stream of directory entries.
- @since(version = 0.2.0)
- resource directory-entry-stream {
- /// Read a single directory entry from a `directory-entry-stream`.
- @since(version = 0.2.0)
- read-directory-entry: func() -> result<option<directory-entry>, error-code>;
- }
-
- /// Attempts to extract a filesystem-related `error-code` from the stream
- /// `error` provided.
- ///
- /// Stream operations which return `stream-error::last-operation-failed`
- /// have a payload with more information about the operation that failed.
- /// This payload can be passed through to this function to see if there's
- /// filesystem-related information about the error to return.
- ///
- /// Note that this function is fallible because not all stream-related
- /// errors are filesystem-related errors.
- @since(version = 0.2.0)
- filesystem-error-code: func(err: borrow<error>) -> option<error-code>;
-}
diff --git a/crates/wasi-http/wit/deps/filesystem/world.wit b/crates/wasi-http/wit/deps/filesystem/world.wit
deleted file mode 100644
index 65597f9f29..0000000000
--- a/crates/wasi-http/wit/deps/filesystem/world.wit
+++ /dev/null
@@ -1,9 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import types;
- @since(version = 0.2.0)
- import preopens;
-}
diff --git a/crates/wasi-http/wit/deps/http/types.wit b/crates/wasi-http/wit/deps/http.wit
similarity index 86%
rename from crates/wasi-http/wit/deps/http/types.wit
rename to crates/wasi-http/wit/deps/http.wit
index c9f3cc4b9a..eb1b25f024 100644
--- a/crates/wasi-http/wit/deps/http/types.wit
+++ b/crates/wasi-http/wit/deps/http.wit
@@ -1,3 +1,5 @@
+package wasi:[email protected];
+
/// This interface defines all of the types and methods for implementing
/// HTTP Requests and Responses, both incoming and outgoing, as well as
/// their headers, trailers, and bodies.
@@ -24,7 +26,7 @@ interface types {
options,
trace,
patch,
- other(string)
+ other(string),
}
/// This type corresponds to HTTP standard Related Schemes.
@@ -32,7 +34,28 @@ interface types {
variant scheme {
HTTP,
HTTPS,
- other(string)
+ other(string),
+ }
+
+ /// Defines the case payload type for `DNS-error` above:
+ @since(version = 0.2.0)
+ record DNS-error-payload {
+ rcode: option<string>,
+ info-code: option<u16>,
+ }
+
+ /// Defines the case payload type for `TLS-alert-received` above:
+ @since(version = 0.2.0)
+ record TLS-alert-received-payload {
+ alert-id: option<u8>,
+ alert-message: option<string>,
+ }
+
+ /// Defines the case payload type for `HTTP-response-{header,trailer}-size` above:
+ @since(version = 0.2.0)
+ record field-size-payload {
+ field-name: option<string>,
+ field-size: option<u32>,
}
/// These cases are inspired by the IANA HTTP Proxy Error Types:
@@ -82,44 +105,9 @@ interface types {
/// unstructured description of the error. Users should not depend on the
/// string for diagnosing errors, as it's not required to be consistent
/// between implementations.
- internal-error(option<string>)
+ internal-error(option<string>),
}
- /// Defines the case payload type for `DNS-error` above:
- @since(version = 0.2.0)
- record DNS-error-payload {
- rcode: option<string>,
- info-code: option<u16>
- }
-
- /// Defines the case payload type for `TLS-alert-received` above:
- @since(version = 0.2.0)
- record TLS-alert-received-payload {
- alert-id: option<u8>,
- alert-message: option<string>
- }
-
- /// Defines the case payload type for `HTTP-response-{header,trailer}-size` above:
- @since(version = 0.2.0)
- record field-size-payload {
- field-name: option<string>,
- field-size: option<u32>
- }
-
- /// Attempts to extract a http-related `error` from the wasi:io `error`
- /// provided.
- ///
- /// Stream operations which return
- /// `wasi:io/stream/stream-error::last-operation-failed` have a payload of
- /// type `wasi:io/error/error` with more information about the operation
- /// that failed. This payload can be passed through to this function to see
- /// if there's http-related information about the error to return.
- ///
- /// Note that this function is fallible because not all io-errors are
- /// http-related errors.
- @since(version = 0.2.0)
- http-error-code: func(err: borrow<io-error>) -> option<error-code>;
-
/// This type enumerates the different kinds of errors that may occur when
/// setting or appending to a `fields` resource.
@since(version = 0.2.0)
@@ -128,35 +116,33 @@ interface types {
/// syntactically invalid when used with an operation that sets headers in a
/// `fields`.
invalid-syntax,
-
/// This error indicates that a forbidden `field-name` was used when trying
/// to set a header in a `fields`.
forbidden,
-
/// This error indicates that the operation on the `fields` was not
/// permitted because the fields are immutable.
immutable,
}
- /// Field names are always strings.
- ///
- /// Field names should always be treated as case insensitive by the `fields`
- /// resource for the purposes of equality checking.
- @since(version = 0.2.1)
- type field-name = field-key;
-
/// Field keys are always strings.
///
/// Field keys should always be treated as case insensitive by the `fields`
/// resource for the purposes of equality checking.
- ///
+ ///
/// # Deprecation
- ///
+ ///
/// This type has been deprecated in favor of the `field-name` type.
@since(version = 0.2.0)
@deprecated(version = 0.2.2)
type field-key = string;
+ /// Field names are always strings.
+ ///
+ /// Field names should always be treated as case insensitive by the `fields`
+ /// resource for the purposes of equality checking.
+ @since(version = 0.2.1)
+ type field-name = field-key;
+
/// Field values should always be ASCII strings. However, in
/// reality, HTTP implementations often have to interpret malformed values,
/// so they are provided as a list of bytes.
@@ -175,13 +161,11 @@ interface types {
/// operations will fail with `header-error.immutable`.
@since(version = 0.2.0)
resource fields {
-
/// Construct an empty HTTP Fields.
///
/// The resulting `fields` is mutable.
@since(version = 0.2.0)
constructor();
-
/// Construct an HTTP Fields.
///
/// The resulting `fields` is mutable.
@@ -196,22 +180,17 @@ interface types {
/// An error result will be returned if any `field-name` or `field-value` is
/// syntactically invalid, or if a field is forbidden.
@since(version = 0.2.0)
- from-list: static func(
- entries: list<tuple<field-name,field-value>>
- ) -> result<fields, header-error>;
-
+ from-list: static func(entries: list<tuple<field-name, field-value>>) -> result<fields, header-error>;
/// Get all of the values corresponding to a name. If the name is not present
/// in this `fields` or is syntactically invalid, an empty list is returned.
/// However, if the name is present but empty, this is represented by a list
/// with one or more empty field-values present.
@since(version = 0.2.0)
get: func(name: field-name) -> list<field-value>;
-
/// Returns `true` when the name is present in this `fields`. If the name is
/// syntactically invalid, `false` is returned.
@since(version = 0.2.0)
has: func(name: field-name) -> bool;
-
/// Set all of the values for a name. Clears any existing values for that
/// name, if they have been set.
///
@@ -221,7 +200,6 @@ interface types {
/// the `field-value`s are syntactically invalid.
@since(version = 0.2.0)
set: func(name: field-name, value: list<field-value>) -> result<_, header-error>;
-
/// Delete all values for a name. Does nothing if no values for the name
/// exist.
///
@@ -231,7 +209,6 @@ interface types {
/// syntactically invalid.
@since(version = 0.2.0)
delete: func(name: field-name) -> result<_, header-error>;
-
/// Append a value for a name. Does not change or delete any existing
/// values for that name.
///
@@ -241,7 +218,6 @@ interface types {
/// `field-value` are syntactically invalid.
@since(version = 0.2.0)
append: func(name: field-name, value: field-value) -> result<_, header-error>;
-
/// Retrieve the full set of names and values in the Fields. Like the
/// constructor, the list represents each name-value pair.
///
@@ -252,8 +228,7 @@ interface types {
/// The names and values are always returned in the original casing and in
/// the order in which they will be serialized for transport.
@since(version = 0.2.0)
- entries: func() -> list<tuple<field-name,field-value>>;
-
+ entries: func() -> list<tuple<field-name, field-value>>;
/// Make a deep copy of the Fields. Equivalent in behavior to calling the
/// `fields` constructor on the return value of `entries`. The resulting
/// `fields` is mutable.
@@ -272,23 +247,18 @@ interface types {
/// Represents an incoming HTTP Request.
@since(version = 0.2.0)
resource incoming-request {
-
/// Returns the method of the incoming request.
@since(version = 0.2.0)
method: func() -> method;
-
/// Returns the path with query parameters from the request, as a string.
@since(version = 0.2.0)
path-with-query: func() -> option<string>;
-
/// Returns the protocol scheme from the request.
@since(version = 0.2.0)
scheme: func() -> option<scheme>;
-
/// Returns the authority of the Request's target URI, if present.
@since(version = 0.2.0)
authority: func() -> option<string>;
-
/// Get the `headers` associated with the request.
///
/// The returned `headers` resource is immutable: `set`, `append`, and
@@ -299,7 +269,6 @@ interface types {
/// `incoming-request` before all children are dropped will trap.
@since(version = 0.2.0)
headers: func() -> headers;
-
/// Gives the `incoming-body` associated with this request. Will only
/// return success at most once, and subsequent calls will return error.
@since(version = 0.2.0)
@@ -309,7 +278,6 @@ interface types {
/// Represents an outgoing HTTP Request.
@since(version = 0.2.0)
resource outgoing-request {
-
/// Construct a new `outgoing-request` with a default `method` of `GET`, and
/// `none` values for `path-with-query`, `scheme`, and `authority`.
///
@@ -321,10 +289,7 @@ interface types {
/// It is the obligation of the `outgoing-handler.handle` implementation
/// to reject invalid constructions of `outgoing-request`.
@since(version = 0.2.0)
- constructor(
- headers: headers
- );
-
+ constructor(headers: headers);
/// Returns the resource corresponding to the outgoing Body for this
/// Request.
///
@@ -333,7 +298,6 @@ interface types {
/// calls will return error.
@since(version = 0.2.0)
body: func() -> result<outgoing-body>;
-
/// Get the Method for the Request.
@since(version = 0.2.0)
method: func() -> method;
@@ -341,7 +305,6 @@ interface types {
/// `method.other` argument is not a syntactically valid method.
@since(version = 0.2.0)
set-method: func(method: method) -> result;
-
/// Get the combination of the HTTP Path and Query for the Request.
/// When `none`, this represents an empty Path and empty Query.
@since(version = 0.2.0)
@@ -351,7 +314,6 @@ interface types {
/// string given is not a syntactically valid path and query uri component.
@since(version = 0.2.0)
set-path-with-query: func(path-with-query: option<string>) -> result;
-
/// Get the HTTP Related Scheme for the Request. When `none`, the
/// implementation may choose an appropriate default scheme.
@since(version = 0.2.0)
@@ -361,7 +323,6 @@ interface types {
/// string given is not a syntactically valid uri scheme.
@since(version = 0.2.0)
set-scheme: func(scheme: option<scheme>) -> result;
-
/// Get the authority of the Request's target URI. A value of `none` may be used
/// with Related Schemes which do not require an authority. The HTTP and
/// HTTPS schemes always require an authority.
@@ -373,7 +334,6 @@ interface types {
/// not a syntactically valid URI authority.
@since(version = 0.2.0)
set-authority: func(authority: option<string>) -> result;
-
/// Get the headers associated with the Request.
///
/// The returned `headers` resource is immutable: `set`, `append`, and
@@ -397,30 +357,24 @@ interface types {
/// Construct a default `request-options` value.
@since(version = 0.2.0)
constructor();
-
/// The timeout for the initial connect to the HTTP Server.
@since(version = 0.2.0)
connect-timeout: func() -> option<duration>;
-
/// Set the timeout for the initial connect to the HTTP Server. An error
/// return value indicates that this timeout is not supported.
@since(version = 0.2.0)
set-connect-timeout: func(duration: option<duration>) -> result;
-
/// The timeout for receiving the first byte of the Response body.
@since(version = 0.2.0)
first-byte-timeout: func() -> option<duration>;
-
/// Set the timeout for receiving the first byte of the Response body. An
/// error return value indicates that this timeout is not supported.
@since(version = 0.2.0)
set-first-byte-timeout: func(duration: option<duration>) -> result;
-
/// The timeout for receiving subsequent chunks of bytes in the Response
/// body stream.
@since(version = 0.2.0)
between-bytes-timeout: func() -> option<duration>;
-
/// Set the timeout for receiving subsequent chunks of bytes in the Response
/// body stream. An error return value indicates that this timeout is not
/// supported.
@@ -446,11 +400,7 @@ interface types {
/// range [100-199], or an `internal-error` if the implementation does not
/// support informational responses.
@unstable(feature = informational-outbound-responses)
- send-informational: func(
- status: u16,
- headers: headers
- ) -> result<_, error-code>;
-
+ send-informational: func(status: u16, headers: headers) -> result<_, error-code>;
/// Set the value of the `response-outparam` to either send a response,
/// or indicate an error.
///
@@ -461,10 +411,7 @@ interface types {
/// The user may provide an `error` to `response` to allow the
/// implementation determine how to respond with an HTTP error response.
@since(version = 0.2.0)
- set: static func(
- param: response-outparam,
- response: result<outgoing-response, error-code>,
- );
+ set: static func(param: response-outparam, response: result<outgoing-response, error-code>);
}
/// This type corresponds to the HTTP standard Status Code.
@@ -474,11 +421,9 @@ interface types {
/// Represents an incoming HTTP Response.
@since(version = 0.2.0)
resource incoming-response {
-
/// Returns the status code from the incoming response.
@since(version = 0.2.0)
status: func() -> status-code;
-
/// Returns the headers from the incoming response.
///
/// The returned `headers` resource is immutable: `set`, `append`, and
@@ -488,7 +433,6 @@ interface types {
/// `incoming-response` is dropped.
@since(version = 0.2.0)
headers: func() -> headers;
-
/// Returns the incoming body. May be called at most once. Returns error
/// if called additional times.
@since(version = 0.2.0)
@@ -505,7 +449,6 @@ interface types {
/// the body contents or waiting on trailers at any given time.
@since(version = 0.2.0)
resource incoming-body {
-
/// Returns the contents of the body, as a stream of bytes.
///
/// Returns success on first call: the stream representing the contents
@@ -523,7 +466,6 @@ interface types {
/// the user does not read the entire body.
@since(version = 0.2.0)
%stream: func() -> result<input-stream>;
-
/// Takes ownership of `incoming-body`, and returns a `future-trailers`.
/// This function will trap if the `input-stream` child is still alive.
@since(version = 0.2.0)
@@ -537,13 +479,11 @@ interface types {
/// complete Request or Response body has been received.
@since(version = 0.2.0)
resource future-trailers {
-
/// Returns a pollable which becomes ready when either the trailers have
/// been received, or an error has occurred. When this pollable is ready,
/// the `get` method will return `some`.
@since(version = 0.2.0)
subscribe: func() -> pollable;
-
/// Returns the contents of the trailers, or an error which occurred,
/// once the future is ready.
///
@@ -570,7 +510,6 @@ interface types {
/// Represents an outgoing HTTP Response.
@since(version = 0.2.0)
resource outgoing-response {
-
/// Construct an `outgoing-response`, with a default `status-code` of `200`.
/// If a different `status-code` is needed, it must be set via the
/// `set-status-code` method.
@@ -578,16 +517,13 @@ interface types {
/// * `headers` is the HTTP Headers for the Response.
@since(version = 0.2.0)
constructor(headers: headers);
-
/// Get the HTTP Status Code for the Response.
@since(version = 0.2.0)
status-code: func() -> status-code;
-
/// Set the HTTP Status Code for the Response. Fails if the status-code
/// given is not a valid http status code.
@since(version = 0.2.0)
set-status-code: func(status-code: status-code) -> result;
-
/// Get the headers associated with the Request.
///
/// The returned `headers` resource is immutable: `set`, `append`, and
@@ -598,7 +534,6 @@ interface types {
/// another component by e.g. `outgoing-handler.handle`.
@since(version = 0.2.0)
headers: func() -> headers;
-
/// Returns the resource corresponding to the outgoing Body for this Response.
///
/// Returns success on the first call: the `outgoing-body` resource for
@@ -626,7 +561,6 @@ interface types {
/// Request, or sending a late status code for the Response.
@since(version = 0.2.0)
resource outgoing-body {
-
/// Returns a stream for writing the body contents.
///
/// The returned `output-stream` is a child resource: it must be dropped
@@ -638,7 +572,6 @@ interface types {
/// will return error.
@since(version = 0.2.0)
write: func() -> result<output-stream>;
-
/// Finalize an outgoing body, optionally providing trailers. This must be
/// called to signal that the response is complete. If the `outgoing-body`
/// is dropped without calling `outgoing-body.finalize`, the implementation
@@ -649,10 +582,7 @@ interface types {
/// to the body (via `write`) does not match the value given in the
/// Content-Length.
@since(version = 0.2.0)
- finish: static func(
- this: outgoing-body,
- trailers: option<trailers>
- ) -> result<_, error-code>;
+ finish: static func(this: outgoing-body, trailers: option<trailers>) -> result<_, error-code>;
}
/// Represents a future which may eventually return an incoming HTTP
@@ -667,7 +597,6 @@ interface types {
/// the `get` method will return `some`.
@since(version = 0.2.0)
subscribe: func() -> pollable;
-
/// Returns the incoming HTTP Response, or an error, once one is ready.
///
/// The outer `option` represents future readiness. Users can wait on this
@@ -685,4 +614,120 @@ interface types {
@since(version = 0.2.0)
get: func() -> option<result<result<incoming-response, error-code>>>;
}
+
+ /// Attempts to extract a http-related `error` from the wasi:io `error`
+ /// provided.
+ ///
+ /// Stream operations which return
+ /// `wasi:io/stream/stream-error::last-operation-failed` have a payload of
+ /// type `wasi:io/error/error` with more information about the operation
+ /// that failed. This payload can be passed through to this function to see
+ /// if there's http-related information about the error to return.
+ ///
+ /// Note that this function is fallible because not all io-errors are
+ /// http-related errors.
+ @since(version = 0.2.0)
+ http-error-code: func(err: borrow<io-error>) -> option<error-code>;
+}
+
+/// This interface defines a handler of incoming HTTP Requests. It should
+/// be exported by components which can respond to HTTP Requests.
+@since(version = 0.2.0)
+interface incoming-handler {
+ @since(version = 0.2.0)
+ use types.{incoming-request, response-outparam};
+
+ /// This function is invoked with an incoming HTTP Request, and a resource
+ /// `response-outparam` which provides the capability to reply with an HTTP
+ /// Response. The response is sent by calling the `response-outparam.set`
+ /// method, which allows execution to continue after the response has been
+ /// sent. This enables both streaming to the response body, and performing other
+ /// work.
+ ///
+ /// The implementor of this function must write a response to the
+ /// `response-outparam` before returning, or else the caller will respond
+ /// with an error on its behalf.
+ @since(version = 0.2.0)
+ handle: func(request: incoming-request, response-out: response-outparam);
+}
+
+/// This interface defines a handler of outgoing HTTP Requests. It should be
+/// imported by components which wish to make HTTP Requests.
+@since(version = 0.2.0)
+interface outgoing-handler {
+ @since(version = 0.2.0)
+ use types.{outgoing-request, request-options, future-incoming-response, error-code};
+
+ /// This function is invoked with an outgoing HTTP Request, and it returns
+ /// a resource `future-incoming-response` which represents an HTTP Response
+ /// which may arrive in the future.
+ ///
+ /// The `options` argument accepts optional parameters for the HTTP
+ /// protocol's transport layer.
+ ///
+ /// This function may return an error if the `outgoing-request` is invalid
+ /// or not allowed to be made. Otherwise, protocol errors are reported
+ /// through the `future-incoming-response`.
+ @since(version = 0.2.0)
+ handle: func(request: outgoing-request, options: option<request-options>) -> result<future-incoming-response, error-code>;
+}
+
+/// The `wasi:http/imports` world imports all the APIs for HTTP proxies.
+/// It is intended to be `include`d in other worlds.
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:cli/[email protected];
+ @since(version = 0.2.0)
+ import wasi:cli/[email protected];
+ @since(version = 0.2.0)
+ import wasi:cli/[email protected];
+ @since(version = 0.2.0)
+ import types;
+ @since(version = 0.2.0)
+ import outgoing-handler;
+}
+/// The `wasi:http/proxy` world captures a widely-implementable intersection of
+/// hosts that includes HTTP forward and reverse proxies. Components targeting
+/// this world may concurrently stream in and out any number of incoming and
+/// outgoing HTTP requests.
+@since(version = 0.2.0)
+world proxy {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:cli/[email protected];
+ @since(version = 0.2.0)
+ import wasi:cli/[email protected];
+ @since(version = 0.2.0)
+ import wasi:cli/[email protected];
+ @since(version = 0.2.0)
+ import types;
+ @since(version = 0.2.0)
+ import outgoing-handler;
+
+ @since(version = 0.2.0)
+ export incoming-handler;
}
diff --git a/crates/wasi-http/wit/deps/http/handler.wit b/crates/wasi-http/wit/deps/http/handler.wit
deleted file mode 100644
index 6a6c62966f..0000000000
--- a/crates/wasi-http/wit/deps/http/handler.wit
+++ /dev/null
@@ -1,49 +0,0 @@
-/// This interface defines a handler of incoming HTTP Requests. It should
-/// be exported by components which can respond to HTTP Requests.
-@since(version = 0.2.0)
-interface incoming-handler {
- @since(version = 0.2.0)
- use types.{incoming-request, response-outparam};
-
- /// This function is invoked with an incoming HTTP Request, and a resource
- /// `response-outparam` which provides the capability to reply with an HTTP
- /// Response. The response is sent by calling the `response-outparam.set`
- /// method, which allows execution to continue after the response has been
- /// sent. This enables both streaming to the response body, and performing other
- /// work.
- ///
- /// The implementor of this function must write a response to the
- /// `response-outparam` before returning, or else the caller will respond
- /// with an error on its behalf.
- @since(version = 0.2.0)
- handle: func(
- request: incoming-request,
- response-out: response-outparam
- );
-}
-
-/// This interface defines a handler of outgoing HTTP Requests. It should be
-/// imported by components which wish to make HTTP Requests.
-@since(version = 0.2.0)
-interface outgoing-handler {
- @since(version = 0.2.0)
- use types.{
- outgoing-request, request-options, future-incoming-response, error-code
- };
-
- /// This function is invoked with an outgoing HTTP Request, and it returns
- /// a resource `future-incoming-response` which represents an HTTP Response
- /// which may arrive in the future.
- ///
- /// The `options` argument accepts optional parameters for the HTTP
- /// protocol's transport layer.
- ///
- /// This function may return an error if the `outgoing-request` is invalid
- /// or not allowed to be made. Otherwise, protocol errors are reported
- /// through the `future-incoming-response`.
- @since(version = 0.2.0)
- handle: func(
- request: outgoing-request,
- options: option<request-options>
- ) -> result<future-incoming-response, error-code>;
-}
diff --git a/crates/wasi-http/wit/deps/http/proxy.wit b/crates/wasi-http/wit/deps/http/proxy.wit
deleted file mode 100644
index 5bd9f99894..0000000000
--- a/crates/wasi-http/wit/deps/http/proxy.wit
+++ /dev/null
@@ -1,50 +0,0 @@
-package wasi:[email protected];
-
-/// The `wasi:http/imports` world imports all the APIs for HTTP proxies.
-/// It is intended to be `include`d in other worlds.
-@since(version = 0.2.0)
-world imports {
- /// HTTP proxies have access to time and randomness.
- @since(version = 0.2.0)
- import wasi:clocks/[email protected];
- @since(version = 0.2.0)
- import wasi:clocks/[email protected];
- @since(version = 0.2.0)
- import wasi:random/[email protected];
-
- /// Proxies have standard output and error streams which are expected to
- /// terminate in a developer-facing console provided by the host.
- @since(version = 0.2.0)
- import wasi:cli/[email protected];
- @since(version = 0.2.0)
- import wasi:cli/[email protected];
-
- /// TODO: this is a temporary workaround until component tooling is able to
- /// gracefully handle the absence of stdin. Hosts must return an eof stream
- /// for this import, which is what wasi-libc + tooling will do automatically
- /// when this import is properly removed.
- @since(version = 0.2.0)
- import wasi:cli/[email protected];
-
- /// This is the default handler to use when user code simply wants to make an
- /// HTTP request (e.g., via `fetch()`).
- @since(version = 0.2.0)
- import outgoing-handler;
-}
-
-/// The `wasi:http/proxy` world captures a widely-implementable intersection of
-/// hosts that includes HTTP forward and reverse proxies. Components targeting
-/// this world may concurrently stream in and out any number of incoming and
-/// outgoing HTTP requests.
-@since(version = 0.2.0)
-world proxy {
- @since(version = 0.2.0)
- include imports;
-
- /// The host delivers incoming HTTP requests to a component by calling the
- /// `handle` function of this exported interface. A host may arbitrarily reuse
- /// or not reuse component instance when delivering incoming HTTP requests and
- /// thus a component must be able to handle 0..N calls to `handle`.
- @since(version = 0.2.0)
- export incoming-handler;
-}
diff --git a/crates/wasi-http/wit/deps/io.wit b/crates/wasi-http/wit/deps/io.wit
new file mode 100644
index 0000000000..08ad78e6b7
--- /dev/null
+++ b/crates/wasi-http/wit/deps/io.wit
@@ -0,0 +1,331 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface error {
+ /// A resource which represents some error information.
+ ///
+ /// The only method provided by this resource is `to-debug-string`,
+ /// which provides some human-readable information about the error.
+ ///
+ /// In the `wasi:io` package, this resource is returned through the
+ /// `wasi:io/streams/stream-error` type.
+ ///
+ /// To provide more specific error information, other interfaces may
+ /// offer functions to "downcast" this error into more specific types. For example,
+ /// errors returned from streams derived from filesystem types can be described using
+ /// the filesystem's own error-code type. This is done using the function
+ /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
+ /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
+ ///
+ /// The set of functions which can "downcast" an `error` into a more
+ /// concrete type is open.
+ @since(version = 0.2.0)
+ resource error {
+ /// Returns a string that is suitable to assist humans in debugging
+ /// this error.
+ ///
+ /// WARNING: The returned string should not be consumed mechanically!
+ /// It may change across platforms, hosts, or other implementation
+ /// details. Parsing this string is a major platform-compatibility
+ /// hazard.
+ @since(version = 0.2.0)
+ to-debug-string: func() -> string;
+ }
+}
+
+/// A poll API intended to let users wait for I/O events on multiple handles
+/// at once.
+@since(version = 0.2.0)
+interface poll {
+ /// `pollable` represents a single I/O event which may be ready, or not.
+ @since(version = 0.2.0)
+ resource pollable {
+ /// Return the readiness of a pollable. This function never blocks.
+ ///
+ /// Returns `true` when the pollable is ready, and `false` otherwise.
+ @since(version = 0.2.0)
+ ready: func() -> bool;
+ /// `block` returns immediately if the pollable is ready, and otherwise
+ /// blocks until ready.
+ ///
+ /// This function is equivalent to calling `poll.poll` on a list
+ /// containing only this pollable.
+ @since(version = 0.2.0)
+ block: func();
+ }
+
+ /// Poll for completion on a set of pollables.
+ ///
+ /// This function takes a list of pollables, which identify I/O sources of
+ /// interest, and waits until one or more of the events is ready for I/O.
+ ///
+ /// The result `list<u32>` contains one or more indices of handles in the
+ /// argument list that is ready for I/O.
+ ///
+ /// This function traps if either:
+ /// - the list is empty, or:
+ /// - the list contains more elements than can be indexed with a `u32` value.
+ ///
+ /// A timeout can be implemented by adding a pollable from the
+ /// wasi-clocks API to the list.
+ ///
+ /// This function does not return a `result`; polling in itself does not
+ /// do any I/O so it doesn't fail. If any of the I/O sources identified by
+ /// the pollables has an error, it is indicated by marking the source as
+ /// being ready for I/O.
+ @since(version = 0.2.0)
+ poll: func(in: list<borrow<pollable>>) -> list<u32>;
+}
+
+/// WASI I/O is an I/O abstraction API which is currently focused on providing
+/// stream types.
+///
+/// In the future, the component model is expected to add built-in stream types;
+/// when it does, they are expected to subsume this API.
+@since(version = 0.2.0)
+interface streams {
+ @since(version = 0.2.0)
+ use error.{error};
+ @since(version = 0.2.0)
+ use poll.{pollable};
+
+ /// An error for input-stream and output-stream operations.
+ @since(version = 0.2.0)
+ variant stream-error {
+ /// The last operation (a write or flush) failed before completion.
+ ///
+ /// More information is available in the `error` payload.
+ ///
+ /// After this, the stream will be closed. All future operations return
+ /// `stream-error::closed`.
+ last-operation-failed(error),
+ /// The stream is closed: no more input will be accepted by the
+ /// stream. A closed output-stream will return this error on all
+ /// future operations.
+ closed,
+ }
+
+ /// An input bytestream.
+ ///
+ /// `input-stream`s are *non-blocking* to the extent practical on underlying
+ /// platforms. I/O operations always return promptly; if fewer bytes are
+ /// promptly available than requested, they return the number of bytes promptly
+ /// available, which could even be zero. To wait for data to be available,
+ /// use the `subscribe` function to obtain a `pollable` which can be polled
+ /// for using `wasi:io/poll`.
+ @since(version = 0.2.0)
+ resource input-stream {
+ /// Perform a non-blocking read from the stream.
+ ///
+ /// When the source of a `read` is binary data, the bytes from the source
+ /// are returned verbatim. When the source of a `read` is known to the
+ /// implementation to be text, bytes containing the UTF-8 encoding of the
+ /// text are returned.
+ ///
+ /// This function returns a list of bytes containing the read data,
+ /// when successful. The returned list will contain up to `len` bytes;
+ /// it may return fewer than requested, but not more. The list is
+ /// empty when no bytes are available for reading at this time. The
+ /// pollable given by `subscribe` will be ready when more bytes are
+ /// available.
+ ///
+ /// This function fails with a `stream-error` when the operation
+ /// encounters an error, giving `last-operation-failed`, or when the
+ /// stream is closed, giving `closed`.
+ ///
+ /// When the caller gives a `len` of 0, it represents a request to
+ /// read 0 bytes. If the stream is still open, this call should
+ /// succeed and return an empty list, or otherwise fail with `closed`.
+ ///
+ /// The `len` parameter is a `u64`, which could represent a list of u8 which
+ /// is not possible to allocate in wasm32, or not desirable to allocate as
+ /// as a return value by the callee. The callee may return a list of bytes
+ /// less than `len` in size while more bytes are available for reading.
+ @since(version = 0.2.0)
+ read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Read bytes from a stream, after blocking until at least one byte can
+ /// be read. Except for blocking, behavior is identical to `read`.
+ @since(version = 0.2.0)
+ blocking-read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Skip bytes from a stream. Returns number of bytes skipped.
+ ///
+ /// Behaves identical to `read`, except instead of returning a list
+ /// of bytes, returns the number of bytes consumed from the stream.
+ @since(version = 0.2.0)
+ skip: func(len: u64) -> result<u64, stream-error>;
+ /// Skip bytes from a stream, after blocking until at least one byte
+ /// can be skipped. Except for blocking behavior, identical to `skip`.
+ @since(version = 0.2.0)
+ blocking-skip: func(len: u64) -> result<u64, stream-error>;
+ /// Create a `pollable` which will resolve once either the specified stream
+ /// has bytes available to read or the other end of the stream has been
+ /// closed.
+ /// The created `pollable` is a child resource of the `input-stream`.
+ /// Implementations may trap if the `input-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ /// An output bytestream.
+ ///
+ /// `output-stream`s are *non-blocking* to the extent practical on
+ /// underlying platforms. Except where specified otherwise, I/O operations also
+ /// always return promptly, after the number of bytes that can be written
+ /// promptly, which could even be zero. To wait for the stream to be ready to
+ /// accept data, the `subscribe` function to obtain a `pollable` which can be
+ /// polled for using `wasi:io/poll`.
+ ///
+ /// Dropping an `output-stream` while there's still an active write in
+ /// progress may result in the data being lost. Before dropping the stream,
+ /// be sure to fully flush your writes.
+ @since(version = 0.2.0)
+ resource output-stream {
+ /// Check readiness for writing. This function never blocks.
+ ///
+ /// Returns the number of bytes permitted for the next call to `write`,
+ /// or an error. Calling `write` with more bytes than this function has
+ /// permitted will trap.
+ ///
+ /// When this function returns 0 bytes, the `subscribe` pollable will
+ /// become ready when this function will report at least 1 byte, or an
+ /// error.
+ @since(version = 0.2.0)
+ check-write: func() -> result<u64, stream-error>;
+ /// Perform a write. This function never blocks.
+ ///
+ /// When the destination of a `write` is binary data, the bytes from
+ /// `contents` are written verbatim. When the destination of a `write` is
+ /// known to the implementation to be text, the bytes of `contents` are
+ /// transcoded from UTF-8 into the encoding of the destination and then
+ /// written.
+ ///
+ /// Precondition: check-write gave permit of Ok(n) and contents has a
+ /// length of less than or equal to n. Otherwise, this function will trap.
+ ///
+ /// returns Err(closed) without writing if the stream has closed since
+ /// the last call to check-write provided a permit.
+ @since(version = 0.2.0)
+ write: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 bytes, and then flush the stream. Block
+ /// until all of these operations are complete, or an error occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write`, and `flush`, and is implemented with the
+ /// following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while !contents.is_empty() {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, contents.len());
+ /// let (chunk, rest) = contents.split_at(len);
+ /// this.write(chunk ); // eliding error handling
+ /// contents = rest;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-and-flush: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Request to flush buffered output. This function never blocks.
+ ///
+ /// This tells the output-stream that the caller intends any buffered
+ /// output to be flushed. the output which is expected to be flushed
+ /// is all that has been passed to `write` prior to this call.
+ ///
+ /// Upon calling this function, the `output-stream` will not accept any
+ /// writes (`check-write` will return `ok(0)`) until the flush has
+ /// completed. The `subscribe` pollable will become ready when the
+ /// flush has completed and the stream can accept more writes.
+ @since(version = 0.2.0)
+ flush: func() -> result<_, stream-error>;
+ /// Request to flush buffered output, and block until flush completes
+ /// and stream is ready for writing again.
+ @since(version = 0.2.0)
+ blocking-flush: func() -> result<_, stream-error>;
+ /// Create a `pollable` which will resolve once the output-stream
+ /// is ready for more writing, or an error has occurred. When this
+ /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
+ /// error.
+ ///
+ /// If the stream is closed, this pollable is always ready immediately.
+ ///
+ /// The created `pollable` is a child resource of the `output-stream`.
+ /// Implementations may trap if the `output-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ /// Write zeroes to a stream.
+ ///
+ /// This should be used precisely like `write` with the exact same
+ /// preconditions (must use check-write first), but instead of
+ /// passing a list of bytes, you simply pass the number of zero-bytes
+ /// that should be written.
+ @since(version = 0.2.0)
+ write-zeroes: func(len: u64) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 zeroes, and then flush the stream.
+ /// Block until all of these operations are complete, or an error
+ /// occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
+ /// the following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while num_zeroes != 0 {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, num_zeroes);
+ /// this.write-zeroes(len); // eliding error handling
+ /// num_zeroes -= len;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-zeroes-and-flush: func(len: u64) -> result<_, stream-error>;
+ /// Read from one stream and write to another.
+ ///
+ /// The behavior of splice is equivalent to:
+ /// 1. calling `check-write` on the `output-stream`
+ /// 2. calling `read` on the `input-stream` with the smaller of the
+ /// `check-write` permitted length and the `len` provided to `splice`
+ /// 3. calling `write` on the `output-stream` with that read data.
+ ///
+ /// Any error reported by the call to `check-write`, `read`, or
+ /// `write` ends the splice and reports that error.
+ ///
+ /// This function returns the number of bytes transferred; it may be less
+ /// than `len`.
+ @since(version = 0.2.0)
+ splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ /// Read from one stream and write to another, with blocking.
+ ///
+ /// This is similar to `splice`, except that it blocks until the
+ /// `output-stream` is ready for writing, and the `input-stream`
+ /// is ready for reading, before performing the `splice`.
+ @since(version = 0.2.0)
+ blocking-splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ }
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import error;
+ @since(version = 0.2.0)
+ import poll;
+ @since(version = 0.2.0)
+ import streams;
+}
diff --git a/crates/wasi-http/wit/deps/io/error.wit b/crates/wasi-http/wit/deps/io/error.wit
deleted file mode 100644
index 784f74a53e..0000000000
--- a/crates/wasi-http/wit/deps/io/error.wit
+++ /dev/null
@@ -1,34 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-interface error {
- /// A resource which represents some error information.
- ///
- /// The only method provided by this resource is `to-debug-string`,
- /// which provides some human-readable information about the error.
- ///
- /// In the `wasi:io` package, this resource is returned through the
- /// `wasi:io/streams/stream-error` type.
- ///
- /// To provide more specific error information, other interfaces may
- /// offer functions to "downcast" this error into more specific types. For example,
- /// errors returned from streams derived from filesystem types can be described using
- /// the filesystem's own error-code type. This is done using the function
- /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
- /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
- ///
- /// The set of functions which can "downcast" an `error` into a more
- /// concrete type is open.
- @since(version = 0.2.0)
- resource error {
- /// Returns a string that is suitable to assist humans in debugging
- /// this error.
- ///
- /// WARNING: The returned string should not be consumed mechanically!
- /// It may change across platforms, hosts, or other implementation
- /// details. Parsing this string is a major platform-compatibility
- /// hazard.
- @since(version = 0.2.0)
- to-debug-string: func() -> string;
- }
-}
diff --git a/crates/wasi-http/wit/deps/io/poll.wit b/crates/wasi-http/wit/deps/io/poll.wit
deleted file mode 100644
index 7f711836c3..0000000000
--- a/crates/wasi-http/wit/deps/io/poll.wit
+++ /dev/null
@@ -1,47 +0,0 @@
-package wasi:[email protected];
-
-/// A poll API intended to let users wait for I/O events on multiple handles
-/// at once.
-@since(version = 0.2.0)
-interface poll {
- /// `pollable` represents a single I/O event which may be ready, or not.
- @since(version = 0.2.0)
- resource pollable {
-
- /// Return the readiness of a pollable. This function never blocks.
- ///
- /// Returns `true` when the pollable is ready, and `false` otherwise.
- @since(version = 0.2.0)
- ready: func() -> bool;
-
- /// `block` returns immediately if the pollable is ready, and otherwise
- /// blocks until ready.
- ///
- /// This function is equivalent to calling `poll.poll` on a list
- /// containing only this pollable.
- @since(version = 0.2.0)
- block: func();
- }
-
- /// Poll for completion on a set of pollables.
- ///
- /// This function takes a list of pollables, which identify I/O sources of
- /// interest, and waits until one or more of the events is ready for I/O.
- ///
- /// The result `list<u32>` contains one or more indices of handles in the
- /// argument list that is ready for I/O.
- ///
- /// This function traps if either:
- /// - the list is empty, or:
- /// - the list contains more elements than can be indexed with a `u32` value.
- ///
- /// A timeout can be implemented by adding a pollable from the
- /// wasi-clocks API to the list.
- ///
- /// This function does not return a `result`; polling in itself does not
- /// do any I/O so it doesn't fail. If any of the I/O sources identified by
- /// the pollables has an error, it is indicated by marking the source as
- /// being ready for I/O.
- @since(version = 0.2.0)
- poll: func(in: list<borrow<pollable>>) -> list<u32>;
-}
diff --git a/crates/wasi-http/wit/deps/io/streams.wit b/crates/wasi-http/wit/deps/io/streams.wit
deleted file mode 100644
index c5da38c862..0000000000
--- a/crates/wasi-http/wit/deps/io/streams.wit
+++ /dev/null
@@ -1,290 +0,0 @@
-package wasi:[email protected];
-
-/// WASI I/O is an I/O abstraction API which is currently focused on providing
-/// stream types.
-///
-/// In the future, the component model is expected to add built-in stream types;
-/// when it does, they are expected to subsume this API.
-@since(version = 0.2.0)
-interface streams {
- @since(version = 0.2.0)
- use error.{error};
- @since(version = 0.2.0)
- use poll.{pollable};
-
- /// An error for input-stream and output-stream operations.
- @since(version = 0.2.0)
- variant stream-error {
- /// The last operation (a write or flush) failed before completion.
- ///
- /// More information is available in the `error` payload.
- ///
- /// After this, the stream will be closed. All future operations return
- /// `stream-error::closed`.
- last-operation-failed(error),
- /// The stream is closed: no more input will be accepted by the
- /// stream. A closed output-stream will return this error on all
- /// future operations.
- closed
- }
-
- /// An input bytestream.
- ///
- /// `input-stream`s are *non-blocking* to the extent practical on underlying
- /// platforms. I/O operations always return promptly; if fewer bytes are
- /// promptly available than requested, they return the number of bytes promptly
- /// available, which could even be zero. To wait for data to be available,
- /// use the `subscribe` function to obtain a `pollable` which can be polled
- /// for using `wasi:io/poll`.
- @since(version = 0.2.0)
- resource input-stream {
- /// Perform a non-blocking read from the stream.
- ///
- /// When the source of a `read` is binary data, the bytes from the source
- /// are returned verbatim. When the source of a `read` is known to the
- /// implementation to be text, bytes containing the UTF-8 encoding of the
- /// text are returned.
- ///
- /// This function returns a list of bytes containing the read data,
- /// when successful. The returned list will contain up to `len` bytes;
- /// it may return fewer than requested, but not more. The list is
- /// empty when no bytes are available for reading at this time. The
- /// pollable given by `subscribe` will be ready when more bytes are
- /// available.
- ///
- /// This function fails with a `stream-error` when the operation
- /// encounters an error, giving `last-operation-failed`, or when the
- /// stream is closed, giving `closed`.
- ///
- /// When the caller gives a `len` of 0, it represents a request to
- /// read 0 bytes. If the stream is still open, this call should
- /// succeed and return an empty list, or otherwise fail with `closed`.
- ///
- /// The `len` parameter is a `u64`, which could represent a list of u8 which
- /// is not possible to allocate in wasm32, or not desirable to allocate as
- /// as a return value by the callee. The callee may return a list of bytes
- /// less than `len` in size while more bytes are available for reading.
- @since(version = 0.2.0)
- read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Read bytes from a stream, after blocking until at least one byte can
- /// be read. Except for blocking, behavior is identical to `read`.
- @since(version = 0.2.0)
- blocking-read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Skip bytes from a stream. Returns number of bytes skipped.
- ///
- /// Behaves identical to `read`, except instead of returning a list
- /// of bytes, returns the number of bytes consumed from the stream.
- @since(version = 0.2.0)
- skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Skip bytes from a stream, after blocking until at least one byte
- /// can be skipped. Except for blocking behavior, identical to `skip`.
- @since(version = 0.2.0)
- blocking-skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Create a `pollable` which will resolve once either the specified stream
- /// has bytes available to read or the other end of the stream has been
- /// closed.
- /// The created `pollable` is a child resource of the `input-stream`.
- /// Implementations may trap if the `input-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
-
- /// An output bytestream.
- ///
- /// `output-stream`s are *non-blocking* to the extent practical on
- /// underlying platforms. Except where specified otherwise, I/O operations also
- /// always return promptly, after the number of bytes that can be written
- /// promptly, which could even be zero. To wait for the stream to be ready to
- /// accept data, the `subscribe` function to obtain a `pollable` which can be
- /// polled for using `wasi:io/poll`.
- ///
- /// Dropping an `output-stream` while there's still an active write in
- /// progress may result in the data being lost. Before dropping the stream,
- /// be sure to fully flush your writes.
- @since(version = 0.2.0)
- resource output-stream {
- /// Check readiness for writing. This function never blocks.
- ///
- /// Returns the number of bytes permitted for the next call to `write`,
- /// or an error. Calling `write` with more bytes than this function has
- /// permitted will trap.
- ///
- /// When this function returns 0 bytes, the `subscribe` pollable will
- /// become ready when this function will report at least 1 byte, or an
- /// error.
- @since(version = 0.2.0)
- check-write: func() -> result<u64, stream-error>;
-
- /// Perform a write. This function never blocks.
- ///
- /// When the destination of a `write` is binary data, the bytes from
- /// `contents` are written verbatim. When the destination of a `write` is
- /// known to the implementation to be text, the bytes of `contents` are
- /// transcoded from UTF-8 into the encoding of the destination and then
- /// written.
- ///
- /// Precondition: check-write gave permit of Ok(n) and contents has a
- /// length of less than or equal to n. Otherwise, this function will trap.
- ///
- /// returns Err(closed) without writing if the stream has closed since
- /// the last call to check-write provided a permit.
- @since(version = 0.2.0)
- write: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 bytes, and then flush the stream. Block
- /// until all of these operations are complete, or an error occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write`, and `flush`, and is implemented with the
- /// following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while !contents.is_empty() {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, contents.len());
- /// let (chunk, rest) = contents.split_at(len);
- /// this.write(chunk ); // eliding error handling
- /// contents = rest;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-and-flush: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Request to flush buffered output. This function never blocks.
- ///
- /// This tells the output-stream that the caller intends any buffered
- /// output to be flushed. the output which is expected to be flushed
- /// is all that has been passed to `write` prior to this call.
- ///
- /// Upon calling this function, the `output-stream` will not accept any
- /// writes (`check-write` will return `ok(0)`) until the flush has
- /// completed. The `subscribe` pollable will become ready when the
- /// flush has completed and the stream can accept more writes.
- @since(version = 0.2.0)
- flush: func() -> result<_, stream-error>;
-
- /// Request to flush buffered output, and block until flush completes
- /// and stream is ready for writing again.
- @since(version = 0.2.0)
- blocking-flush: func() -> result<_, stream-error>;
-
- /// Create a `pollable` which will resolve once the output-stream
- /// is ready for more writing, or an error has occurred. When this
- /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
- /// error.
- ///
- /// If the stream is closed, this pollable is always ready immediately.
- ///
- /// The created `pollable` is a child resource of the `output-stream`.
- /// Implementations may trap if the `output-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
-
- /// Write zeroes to a stream.
- ///
- /// This should be used precisely like `write` with the exact same
- /// preconditions (must use check-write first), but instead of
- /// passing a list of bytes, you simply pass the number of zero-bytes
- /// that should be written.
- @since(version = 0.2.0)
- write-zeroes: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 zeroes, and then flush the stream.
- /// Block until all of these operations are complete, or an error
- /// occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
- /// the following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while num_zeroes != 0 {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, num_zeroes);
- /// this.write-zeroes(len); // eliding error handling
- /// num_zeroes -= len;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-zeroes-and-flush: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Read from one stream and write to another.
- ///
- /// The behavior of splice is equivalent to:
- /// 1. calling `check-write` on the `output-stream`
- /// 2. calling `read` on the `input-stream` with the smaller of the
- /// `check-write` permitted length and the `len` provided to `splice`
- /// 3. calling `write` on the `output-stream` with that read data.
- ///
- /// Any error reported by the call to `check-write`, `read`, or
- /// `write` ends the splice and reports that error.
- ///
- /// This function returns the number of bytes transferred; it may be less
- /// than `len`.
- @since(version = 0.2.0)
- splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Read from one stream and write to another, with blocking.
- ///
- /// This is similar to `splice`, except that it blocks until the
- /// `output-stream` is ready for writing, and the `input-stream`
- /// is ready for reading, before performing the `splice`.
- @since(version = 0.2.0)
- blocking-splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
- }
-}
diff --git a/crates/wasi-http/wit/deps/io/world.wit b/crates/wasi-http/wit/deps/io/world.wit
deleted file mode 100644
index 84c85c08ed..0000000000
--- a/crates/wasi-http/wit/deps/io/world.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import streams;
-
- @since(version = 0.2.0)
- import poll;
-}
diff --git a/crates/wasi-http/wit/deps/random.wit b/crates/wasi-http/wit/deps/random.wit
new file mode 100644
index 0000000000..73edf5b60e
--- /dev/null
+++ b/crates/wasi-http/wit/deps/random.wit
@@ -0,0 +1,92 @@
+package wasi:[email protected];
+
+/// The insecure-seed interface for seeding hash-map DoS resistance.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.2.0)
+interface insecure-seed {
+ /// Return a 128-bit value that may contain a pseudo-random value.
+ ///
+ /// The returned value is not required to be computed from a CSPRNG, and may
+ /// even be entirely deterministic. Host implementations are encouraged to
+ /// provide pseudo-random values to any program exposed to
+ /// attacker-controlled content, to enable DoS protection built into many
+ /// languages' hash-map implementations.
+ ///
+ /// This function is intended to only be called once, by a source language
+ /// to initialize Denial Of Service (DoS) protection in its hash-map
+ /// implementation.
+ ///
+ /// # Expected future evolution
+ ///
+ /// This will likely be changed to a value import, to prevent it from being
+ /// called multiple times and potentially used for purposes other than DoS
+ /// protection.
+ @since(version = 0.2.0)
+ insecure-seed: func() -> tuple<u64, u64>;
+}
+
+/// The insecure interface for insecure pseudo-random numbers.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.2.0)
+interface insecure {
+ /// Return `len` insecure pseudo-random bytes.
+ ///
+ /// This function is not cryptographically secure. Do not use it for
+ /// anything related to security.
+ ///
+ /// There are no requirements on the values of the returned bytes, however
+ /// implementations are encouraged to return evenly distributed values with
+ /// a long period.
+ @since(version = 0.2.0)
+ get-insecure-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return an insecure pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of pseudo-random data as
+ /// `get-insecure-random-bytes`, represented as a `u64`.
+ @since(version = 0.2.0)
+ get-insecure-random-u64: func() -> u64;
+}
+
+/// WASI Random is a random data API.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.2.0)
+interface random {
+ /// Return `len` cryptographically-secure random or pseudo-random bytes.
+ ///
+ /// This function must produce data at least as cryptographically secure and
+ /// fast as an adequately seeded cryptographically-secure pseudo-random
+ /// number generator (CSPRNG). It must not block, from the perspective of
+ /// the calling program, under any circumstances, including on the first
+ /// request and on requests for numbers of bytes. The returned data must
+ /// always be unpredictable.
+ ///
+ /// This function must always return fresh data. Deterministic environments
+ /// must omit this function, rather than implementing it with deterministic
+ /// data.
+ @since(version = 0.2.0)
+ get-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return a cryptographically-secure random or pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of data as `get-random-bytes`,
+ /// represented as a `u64`.
+ @since(version = 0.2.0)
+ get-random-u64: func() -> u64;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import random;
+ @since(version = 0.2.0)
+ import insecure;
+ @since(version = 0.2.0)
+ import insecure-seed;
+}
diff --git a/crates/wasi-http/wit/deps/random/insecure-seed.wit b/crates/wasi-http/wit/deps/random/insecure-seed.wit
deleted file mode 100644
index d3dc03a6c0..0000000000
--- a/crates/wasi-http/wit/deps/random/insecure-seed.wit
+++ /dev/null
@@ -1,27 +0,0 @@
-package wasi:[email protected];
-/// The insecure-seed interface for seeding hash-map DoS resistance.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.2.0)
-interface insecure-seed {
- /// Return a 128-bit value that may contain a pseudo-random value.
- ///
- /// The returned value is not required to be computed from a CSPRNG, and may
- /// even be entirely deterministic. Host implementations are encouraged to
- /// provide pseudo-random values to any program exposed to
- /// attacker-controlled content, to enable DoS protection built into many
- /// languages' hash-map implementations.
- ///
- /// This function is intended to only be called once, by a source language
- /// to initialize Denial Of Service (DoS) protection in its hash-map
- /// implementation.
- ///
- /// # Expected future evolution
- ///
- /// This will likely be changed to a value import, to prevent it from being
- /// called multiple times and potentially used for purposes other than DoS
- /// protection.
- @since(version = 0.2.0)
- insecure-seed: func() -> tuple<u64, u64>;
-}
diff --git a/crates/wasi-http/wit/deps/random/insecure.wit b/crates/wasi-http/wit/deps/random/insecure.wit
deleted file mode 100644
index d4d0284801..0000000000
--- a/crates/wasi-http/wit/deps/random/insecure.wit
+++ /dev/null
@@ -1,25 +0,0 @@
-package wasi:[email protected];
-/// The insecure interface for insecure pseudo-random numbers.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.2.0)
-interface insecure {
- /// Return `len` insecure pseudo-random bytes.
- ///
- /// This function is not cryptographically secure. Do not use it for
- /// anything related to security.
- ///
- /// There are no requirements on the values of the returned bytes, however
- /// implementations are encouraged to return evenly distributed values with
- /// a long period.
- @since(version = 0.2.0)
- get-insecure-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return an insecure pseudo-random `u64` value.
- ///
- /// This function returns the same type of pseudo-random data as
- /// `get-insecure-random-bytes`, represented as a `u64`.
- @since(version = 0.2.0)
- get-insecure-random-u64: func() -> u64;
-}
diff --git a/crates/wasi-http/wit/deps/random/random.wit b/crates/wasi-http/wit/deps/random/random.wit
deleted file mode 100644
index a0ff95646a..0000000000
--- a/crates/wasi-http/wit/deps/random/random.wit
+++ /dev/null
@@ -1,29 +0,0 @@
-package wasi:[email protected];
-/// WASI Random is a random data API.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.2.0)
-interface random {
- /// Return `len` cryptographically-secure random or pseudo-random bytes.
- ///
- /// This function must produce data at least as cryptographically secure and
- /// fast as an adequately seeded cryptographically-secure pseudo-random
- /// number generator (CSPRNG). It must not block, from the perspective of
- /// the calling program, under any circumstances, including on the first
- /// request and on requests for numbers of bytes. The returned data must
- /// always be unpredictable.
- ///
- /// This function must always return fresh data. Deterministic environments
- /// must omit this function, rather than implementing it with deterministic
- /// data.
- @since(version = 0.2.0)
- get-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return a cryptographically-secure random or pseudo-random `u64` value.
- ///
- /// This function returns the same type of data as `get-random-bytes`,
- /// represented as a `u64`.
- @since(version = 0.2.0)
- get-random-u64: func() -> u64;
-}
diff --git a/crates/wasi-http/wit/deps/random/world.wit b/crates/wasi-http/wit/deps/random/world.wit
deleted file mode 100644
index 099f47b36e..0000000000
--- a/crates/wasi-http/wit/deps/random/world.wit
+++ /dev/null
@@ -1,13 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import random;
-
- @since(version = 0.2.0)
- import insecure;
-
- @since(version = 0.2.0)
- import insecure-seed;
-}
diff --git a/crates/wasi-http/wit/deps/sockets.wit b/crates/wasi-http/wit/deps/sockets.wit
new file mode 100644
index 0000000000..db6d1a23b4
--- /dev/null
+++ b/crates/wasi-http/wit/deps/sockets.wit
@@ -0,0 +1,949 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface network {
+ @unstable(feature = network-error-code)
+ use wasi:io/[email protected].{error};
+
+ /// An opaque resource that represents access to (a subset of) the network.
+ /// This enables context-based security for networking.
+ /// There is no need for this to map 1:1 to a physical network interface.
+ @since(version = 0.2.0)
+ resource network;
+
+ /// Error codes.
+ ///
+ /// In theory, every API can return any error code.
+ /// In practice, API's typically only return the errors documented per API
+ /// combined with a couple of errors that are always possible:
+ /// - `unknown`
+ /// - `access-denied`
+ /// - `not-supported`
+ /// - `out-of-memory`
+ /// - `concurrency-conflict`
+ ///
+ /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
+ @since(version = 0.2.0)
+ enum error-code {
+ /// Unknown error
+ unknown,
+ /// Access denied.
+ ///
+ /// POSIX equivalent: EACCES, EPERM
+ access-denied,
+ /// The operation is not supported.
+ ///
+ /// POSIX equivalent: EOPNOTSUPP
+ not-supported,
+ /// One of the arguments is invalid.
+ ///
+ /// POSIX equivalent: EINVAL
+ invalid-argument,
+ /// Not enough memory to complete the operation.
+ ///
+ /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
+ out-of-memory,
+ /// The operation timed out before it could finish completely.
+ timeout,
+ /// This operation is incompatible with another asynchronous operation that is already in progress.
+ ///
+ /// POSIX equivalent: EALREADY
+ concurrency-conflict,
+ /// Trying to finish an asynchronous operation that:
+ /// - has not been started yet, or:
+ /// - was already finished by a previous `finish-*` call.
+ ///
+ /// Note: this is scheduled to be removed when `future`s are natively supported.
+ not-in-progress,
+ /// The operation has been aborted because it could not be completed immediately.
+ ///
+ /// Note: this is scheduled to be removed when `future`s are natively supported.
+ would-block,
+ /// The operation is not valid in the socket's current state.
+ invalid-state,
+ /// A new socket resource could not be created because of a system limit.
+ new-socket-limit,
+ /// A bind operation failed because the provided address is not an address that the `network` can bind to.
+ address-not-bindable,
+ /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
+ address-in-use,
+ /// The remote address is not reachable
+ remote-unreachable,
+ /// The TCP connection was forcefully rejected
+ connection-refused,
+ /// The TCP connection was reset.
+ connection-reset,
+ /// A TCP connection was aborted.
+ connection-aborted,
+ /// The size of a datagram sent to a UDP socket exceeded the maximum
+ /// supported size.
+ datagram-too-large,
+ /// Name does not exist or has no suitable associated IP addresses.
+ name-unresolvable,
+ /// A temporary failure in name resolution occurred.
+ temporary-resolver-failure,
+ /// A permanent failure in name resolution occurred.
+ permanent-resolver-failure,
+ }
+
+ @since(version = 0.2.0)
+ enum ip-address-family {
+ /// Similar to `AF_INET` in POSIX.
+ ipv4,
+ /// Similar to `AF_INET6` in POSIX.
+ ipv6,
+ }
+
+ @since(version = 0.2.0)
+ type ipv4-address = tuple<u8, u8, u8, u8>;
+
+ @since(version = 0.2.0)
+ type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
+
+ @since(version = 0.2.0)
+ variant ip-address {
+ ipv4(ipv4-address),
+ ipv6(ipv6-address),
+ }
+
+ @since(version = 0.2.0)
+ record ipv4-socket-address {
+ /// sin_port
+ port: u16,
+ /// sin_addr
+ address: ipv4-address,
+ }
+
+ @since(version = 0.2.0)
+ record ipv6-socket-address {
+ /// sin6_port
+ port: u16,
+ /// sin6_flowinfo
+ flow-info: u32,
+ /// sin6_addr
+ address: ipv6-address,
+ /// sin6_scope_id
+ scope-id: u32,
+ }
+
+ @since(version = 0.2.0)
+ variant ip-socket-address {
+ ipv4(ipv4-socket-address),
+ ipv6(ipv6-socket-address),
+ }
+
+ /// Attempts to extract a network-related `error-code` from the stream
+ /// `error` provided.
+ ///
+ /// Stream operations which return `stream-error::last-operation-failed`
+ /// have a payload with more information about the operation that failed.
+ /// This payload can be passed through to this function to see if there's
+ /// network-related information about the error to return.
+ ///
+ /// Note that this function is fallible because not all stream-related
+ /// errors are network-related errors.
+ @unstable(feature = network-error-code)
+ network-error-code: func(err: borrow<error>) -> option<error-code>;
+}
+
+/// This interface provides a value-export of the default network handle..
+@since(version = 0.2.0)
+interface instance-network {
+ @since(version = 0.2.0)
+ use network.{network};
+
+ /// Get a handle to the default network.
+ @since(version = 0.2.0)
+ instance-network: func() -> network;
+}
+
+@since(version = 0.2.0)
+interface ip-name-lookup {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-address};
+
+ @since(version = 0.2.0)
+ resource resolve-address-stream {
+ /// Returns the next address from the resolver.
+ ///
+ /// This function should be called multiple times. On each call, it will
+ /// return the next address in connection order preference. If all
+ /// addresses have been exhausted, this function returns `none`.
+ ///
+ /// This function never returns IPv4-mapped IPv6 addresses.
+ ///
+ /// # Typical errors
+ /// - `name-unresolvable`: Name does not exist or has no suitable associated IP addresses. (EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY)
+ /// - `temporary-resolver-failure`: A temporary failure in name resolution occurred. (EAI_AGAIN)
+ /// - `permanent-resolver-failure`: A permanent failure in name resolution occurred. (EAI_FAIL)
+ /// - `would-block`: A result is not available yet. (EWOULDBLOCK, EAGAIN)
+ @since(version = 0.2.0)
+ resolve-next-address: func() -> result<option<ip-address>, error-code>;
+ /// Create a `pollable` which will resolve once the stream is ready for I/O.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ /// Resolve an internet host name to a list of IP addresses.
+ ///
+ /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
+ /// If the input is an IP address string, the address is parsed and returned
+ /// as-is without making any external requests.
+ ///
+ /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
+ ///
+ /// This function never blocks. It either immediately fails or immediately
+ /// returns successfully with a `resolve-address-stream` that can be used
+ /// to (asynchronously) fetch the results.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: `name` is a syntactically invalid domain name or IP address.
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
+ /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
+ @since(version = 0.2.0)
+ resolve-addresses: func(network: borrow<network>, name: string) -> result<resolve-address-stream, error-code>;
+}
+
+@since(version = 0.2.0)
+interface tcp {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{input-stream, output-stream};
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+ @since(version = 0.2.0)
+ use wasi:clocks/[email protected].{duration};
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-socket-address, ip-address-family};
+
+ @since(version = 0.2.0)
+ enum shutdown-type {
+ /// Similar to `SHUT_RD` in POSIX.
+ receive,
+ /// Similar to `SHUT_WR` in POSIX.
+ send,
+ /// Similar to `SHUT_RDWR` in POSIX.
+ both,
+ }
+
+ /// A TCP socket resource.
+ ///
+ /// The socket can be in one of the following states:
+ /// - `unbound`
+ /// - `bind-in-progress`
+ /// - `bound` (See note below)
+ /// - `listen-in-progress`
+ /// - `listening`
+ /// - `connect-in-progress`
+ /// - `connected`
+ /// - `closed`
+ /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md>
+ /// for more information.
+ ///
+ /// Note: Except where explicitly mentioned, whenever this documentation uses
+ /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
+ /// (i.e. `bound`, `listen-in-progress`, `listening`, `connect-in-progress` or `connected`)
+ ///
+ /// In addition to the general error codes documented on the
+ /// `network::error-code` type, TCP socket methods may always return
+ /// `error(invalid-state)` when in the `closed` state.
+ @since(version = 0.2.0)
+ resource tcp-socket {
+ /// Bind the socket to a specific network on the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
+ ///
+ /// Bind can be attempted multiple times on the same socket, even with
+ /// different arguments on each iteration. But never concurrently and
+ /// only as long as the previous bind failed. Once a bind succeeds, the
+ /// binding can't be changed anymore.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
+ /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
+ /// - `not-in-progress`: A `bind` operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
+ /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
+ /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
+ /// and SO_REUSEADDR performs something different entirely.
+ ///
+ /// Unlike in POSIX, in WASI the bind operation is async. This enables
+ /// interactive WASI hosts to inject permission prompts. Runtimes that
+ /// don't want to make use of this ability can simply call the native
+ /// `bind` as part of either `start-bind` or `finish-bind`.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.2.0)
+ start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-bind: func() -> result<_, error-code>;
+ /// Connect to a remote endpoint.
+ ///
+ /// On success:
+ /// - the socket is transitioned into the `connected` state.
+ /// - a pair of streams is returned that can be used to read & write to the connection
+ ///
+ /// After a failed connection attempt, the socket will be in the `closed`
+ /// state and the only valid action left is to `drop` the socket. A single
+ /// socket can not be used to connect more than once.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
+ /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
+ /// - `invalid-argument`: The socket is already attached to a different network. The `network` passed to `connect` must be identical to the one passed to `bind`.
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
+ /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
+ /// - `timeout`: Connection timed out. (ETIMEDOUT)
+ /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ /// - `not-in-progress`: A connect operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// The POSIX equivalent of `start-connect` is the regular `connect` syscall.
+ /// Because all WASI sockets are non-blocking this is expected to return
+ /// EINPROGRESS, which should be translated to `ok()` in WASI.
+ ///
+ /// The POSIX equivalent of `finish-connect` is a `poll` for event `POLLOUT`
+ /// with a timeout of 0 on the socket descriptor. Followed by a check for
+ /// the `SO_ERROR` socket option, in case the poll signaled readiness.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.2.0)
+ start-connect: func(network: borrow<network>, remote-address: ip-socket-address) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-connect: func() -> result<tuple<input-stream, output-stream>, error-code>;
+ /// Start listening for new connections.
+ ///
+ /// Transitions the socket into the `listening` state.
+ ///
+ /// Unlike POSIX, the socket must already be explicitly bound.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address. (EDESTADDRREQ)
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
+ /// - `invalid-state`: The socket is already in the `listening` state.
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
+ /// - `not-in-progress`: A listen operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// Unlike in POSIX, in WASI the listen operation is async. This enables
+ /// interactive WASI hosts to inject permission prompts. Runtimes that
+ /// don't want to make use of this ability can simply call the native
+ /// `listen` as part of either `start-listen` or `finish-listen`.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
+ /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
+ @since(version = 0.2.0)
+ start-listen: func() -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-listen: func() -> result<_, error-code>;
+ /// Accept a new client socket.
+ ///
+ /// The returned socket is bound and in the `connected` state. The following properties are inherited from the listener socket:
+ /// - `address-family`
+ /// - `keep-alive-enabled`
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// - `hop-limit`
+ /// - `receive-buffer-size`
+ /// - `send-buffer-size`
+ ///
+ /// On success, this function returns the newly accepted client socket along with
+ /// a pair of streams that can be used to read & write to the connection.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: Socket is not in the `listening` state. (EINVAL)
+ /// - `would-block`: No pending connections at the moment. (EWOULDBLOCK, EAGAIN)
+ /// - `connection-aborted`: An incoming connection was pending, but was terminated by the client before this listener could accept it. (ECONNABORTED)
+ /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
+ /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
+ @since(version = 0.2.0)
+ accept: func() -> result<tuple<tcp-socket, input-stream, output-stream>, error-code>;
+ /// Get the bound local address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.2.0)
+ local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the remote address.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.2.0)
+ remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether the socket is in the `listening` state.
+ ///
+ /// Equivalent to the SO_ACCEPTCONN socket option.
+ @since(version = 0.2.0)
+ is-listening: func() -> bool;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.2.0)
+ address-family: func() -> ip-address-family;
+ /// Hints the desired listen queue size. Implementations are free to ignore this.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
+ /// - `invalid-argument`: (set) The provided value was 0.
+ /// - `invalid-state`: (set) The socket is in the `connect-in-progress` or `connected` state.
+ @since(version = 0.2.0)
+ set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
+ /// Enables or disables keepalive.
+ ///
+ /// The keepalive behavior can be adjusted using:
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
+ ///
+ /// Equivalent to the SO_KEEPALIVE socket option.
+ @since(version = 0.2.0)
+ keep-alive-enabled: func() -> result<bool, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
+ /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ keep-alive-idle-time: func() -> result<duration, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
+ /// The time between keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPINTVL socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ keep-alive-interval: func() -> result<duration, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
+ /// The maximum amount of keepalive packets TCP should send before aborting the connection.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPCNT socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ keep-alive-count: func() -> result<u32, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-count: func(value: u32) -> result<_, error-code>;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.2.0)
+ hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.2.0)
+ set-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ /// Create a `pollable` which can be used to poll for, or block on,
+ /// completion of any of the asynchronous operations of this socket.
+ ///
+ /// When `finish-bind`, `finish-listen`, `finish-connect` or `accept`
+ /// return `error(would-block)`, this pollable can be used to wait for
+ /// their success or failure, after which the method can be retried.
+ ///
+ /// The pollable is not limited to the async operation that happens to be
+ /// in progress at the time of calling `subscribe` (if any). Theoretically,
+ /// `subscribe` only has to be called once per socket and can then be
+ /// (re)used for the remainder of the socket's lifetime.
+ ///
+ /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md#pollable-readiness>
+ /// for more information.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ /// Initiate a graceful shutdown.
+ ///
+ /// - `receive`: The socket is not expecting to receive any data from
+ /// the peer. The `input-stream` associated with this socket will be
+ /// closed. Any data still in the receive queue at time of calling
+ /// this method will be discarded.
+ /// - `send`: The socket has no more data to send to the peer. The `output-stream`
+ /// associated with this socket will be closed and a FIN packet will be sent.
+ /// - `both`: Same effect as `receive` & `send` combined.
+ ///
+ /// This function is idempotent; shutting down a direction more than once
+ /// has no effect and returns `ok`.
+ ///
+ /// The shutdown function does not close (drop) the socket.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/shutdown.html>
+ /// - <https://man7.org/linux/man-pages/man2/shutdown.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-shutdown>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=shutdown&sektion=2>
+ @since(version = 0.2.0)
+ shutdown: func(shutdown-type: shutdown-type) -> result<_, error-code>;
+ }
+}
+
+@since(version = 0.2.0)
+interface tcp-create-socket {
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-address-family};
+ @since(version = 0.2.0)
+ use tcp.{tcp-socket};
+
+ /// Create a new TCP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// This function does not require a network capability handle. This is considered to be safe because
+ /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind`/`connect`
+ /// is called, the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
+ ///
+ /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
+ /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.2.0)
+ create-tcp-socket: func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
+}
+
+@since(version = 0.2.0)
+interface udp {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-socket-address, ip-address-family};
+
+ /// A received datagram.
+ @since(version = 0.2.0)
+ record incoming-datagram {
+ /// The payload.
+ ///
+ /// Theoretical max size: ~64 KiB. In practice, typically less than 1500 bytes.
+ data: list<u8>,
+ /// The source address.
+ ///
+ /// This field is guaranteed to match the remote address the stream was initialized with, if any.
+ ///
+ /// Equivalent to the `src_addr` out parameter of `recvfrom`.
+ remote-address: ip-socket-address,
+ }
+
+ /// A datagram to be sent out.
+ @since(version = 0.2.0)
+ record outgoing-datagram {
+ /// The payload.
+ data: list<u8>,
+ /// The destination address.
+ ///
+ /// The requirements on this field depend on how the stream was initialized:
+ /// - with a remote address: this field must be None or match the stream's remote address exactly.
+ /// - without a remote address: this field is required.
+ ///
+ /// If this value is None, the send operation is equivalent to `send` in POSIX. Otherwise it is equivalent to `sendto`.
+ remote-address: option<ip-socket-address>,
+ }
+
+ /// A UDP socket handle.
+ @since(version = 0.2.0)
+ resource udp-socket {
+ /// Bind the socket to a specific network on the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the port is zero, the socket will be bound to a random free port.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
+ /// - `not-in-progress`: A `bind` operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// Unlike in POSIX, in WASI the bind operation is async. This enables
+ /// interactive WASI hosts to inject permission prompts. Runtimes that
+ /// don't want to make use of this ability can simply call the native
+ /// `bind` as part of either `start-bind` or `finish-bind`.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.2.0)
+ start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-bind: func() -> result<_, error-code>;
+ /// Set up inbound & outbound communication channels, optionally to a specific peer.
+ ///
+ /// This function only changes the local socket configuration and does not generate any network traffic.
+ /// On success, the `remote-address` of the socket is updated. The `local-address` may be updated as well,
+ /// based on the best network path to `remote-address`.
+ ///
+ /// When a `remote-address` is provided, the returned streams are limited to communicating with that specific peer:
+ /// - `send` can only be used to send to this destination.
+ /// - `receive` will only return datagrams sent from the provided `remote-address`.
+ ///
+ /// This method may be called multiple times on the same socket to change its association, but
+ /// only the most recently returned pair of streams will be operational. Implementations may trap if
+ /// the streams returned by a previous invocation haven't been dropped yet before calling `stream` again.
+ ///
+ /// The POSIX equivalent in pseudo-code is:
+ /// ```text
+ /// if (was previously connected) {
+ /// connect(s, AF_UNSPEC)
+ /// }
+ /// if (remote_address is Some) {
+ /// connect(s, remote_address)
+ /// }
+ /// ```
+ ///
+ /// Unlike in POSIX, the socket must already be explicitly bound.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-state`: The socket is not bound.
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.2.0)
+ %stream: func(remote-address: option<ip-socket-address>) -> result<tuple<incoming-datagram-stream, outgoing-datagram-stream>, error-code>;
+ /// Get the current bound address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.2.0)
+ local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the address the socket is currently streaming to.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not streaming to a specific remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.2.0)
+ remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.2.0)
+ address-family: func() -> ip-address-family;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.2.0)
+ unicast-hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.2.0)
+ set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ /// Create a `pollable` which will resolve once the socket is ready for I/O.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ @since(version = 0.2.0)
+ resource incoming-datagram-stream {
+ /// Receive messages on the socket.
+ ///
+ /// This function attempts to receive up to `max-results` datagrams on the socket without blocking.
+ /// The returned list may contain fewer elements than requested, but never more.
+ ///
+ /// This function returns successfully with an empty list when either:
+ /// - `max-results` is 0, or:
+ /// - `max-results` is greater than 0, but no results are immediately available.
+ /// This function never returns `error(would-block)`.
+ ///
+ /// # Typical errors
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
+ /// - <https://learn.microsoft.com/en-us/previous-versions/windows/desktop/legacy/ms741687(v=vs.85)>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
+ @since(version = 0.2.0)
+ receive: func(max-results: u64) -> result<list<incoming-datagram>, error-code>;
+ /// Create a `pollable` which will resolve once the stream is ready to receive again.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ @since(version = 0.2.0)
+ resource outgoing-datagram-stream {
+ /// Check readiness for sending. This function never blocks.
+ ///
+ /// Returns the number of datagrams permitted for the next call to `send`,
+ /// or an error. Calling `send` with more datagrams than this function has
+ /// permitted will trap.
+ ///
+ /// When this function returns ok(0), the `subscribe` pollable will
+ /// become ready when this function will report at least ok(1), or an
+ /// error.
+ ///
+ /// Never returns `would-block`.
+ check-send: func() -> result<u64, error-code>;
+ /// Send messages on the socket.
+ ///
+ /// This function attempts to send all provided `datagrams` on the socket without blocking and
+ /// returns how many messages were actually sent (or queued for sending). This function never
+ /// returns `error(would-block)`. If none of the datagrams were able to be sent, `ok(0)` is returned.
+ ///
+ /// This function semantically behaves the same as iterating the `datagrams` list and sequentially
+ /// sending each individual datagram until either the end of the list has been reached or the first error occurred.
+ /// If at least one datagram has been sent successfully, this function never returns an error.
+ ///
+ /// If the input list is empty, the function returns `ok(0)`.
+ ///
+ /// Each call to `send` must be permitted by a preceding `check-send`. Implementations must trap if
+ /// either `check-send` was not called or `datagrams` contains more items than `check-send` permitted.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `stream`. (EISCONN)
+ /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/send.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
+ @since(version = 0.2.0)
+ send: func(datagrams: list<outgoing-datagram>) -> result<u64, error-code>;
+ /// Create a `pollable` which will resolve once the stream is ready to send again.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+}
+
+@since(version = 0.2.0)
+interface udp-create-socket {
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-address-family};
+ @since(version = 0.2.0)
+ use udp.{udp-socket};
+
+ /// Create a new UDP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// This function does not require a network capability handle. This is considered to be safe because
+ /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind` is called,
+ /// the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
+ ///
+ /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
+ /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.2.0)
+ create-udp-socket: func(address-family: ip-address-family) -> result<udp-socket, error-code>;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import network;
+ @since(version = 0.2.0)
+ import instance-network;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import udp;
+ @since(version = 0.2.0)
+ import udp-create-socket;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import tcp;
+ @since(version = 0.2.0)
+ import tcp-create-socket;
+ @since(version = 0.2.0)
+ import ip-name-lookup;
+}
diff --git a/crates/wasi-http/wit/deps/sockets/instance-network.wit b/crates/wasi-http/wit/deps/sockets/instance-network.wit
deleted file mode 100644
index 5f6e6c1cc9..0000000000
--- a/crates/wasi-http/wit/deps/sockets/instance-network.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-
-/// This interface provides a value-export of the default network handle..
-@since(version = 0.2.0)
-interface instance-network {
- @since(version = 0.2.0)
- use network.{network};
-
- /// Get a handle to the default network.
- @since(version = 0.2.0)
- instance-network: func() -> network;
-}
diff --git a/crates/wasi-http/wit/deps/sockets/ip-name-lookup.wit b/crates/wasi-http/wit/deps/sockets/ip-name-lookup.wit
deleted file mode 100644
index ee6419e7da..0000000000
--- a/crates/wasi-http/wit/deps/sockets/ip-name-lookup.wit
+++ /dev/null
@@ -1,56 +0,0 @@
-@since(version = 0.2.0)
-interface ip-name-lookup {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
- @since(version = 0.2.0)
- use network.{network, error-code, ip-address};
-
- /// Resolve an internet host name to a list of IP addresses.
- ///
- /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
- /// If the input is an IP address string, the address is parsed and returned
- /// as-is without making any external requests.
- ///
- /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
- ///
- /// This function never blocks. It either immediately fails or immediately
- /// returns successfully with a `resolve-address-stream` that can be used
- /// to (asynchronously) fetch the results.
- ///
- /// # Typical errors
- /// - `invalid-argument`: `name` is a syntactically invalid domain name or IP address.
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
- /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
- @since(version = 0.2.0)
- resolve-addresses: func(network: borrow<network>, name: string) -> result<resolve-address-stream, error-code>;
-
- @since(version = 0.2.0)
- resource resolve-address-stream {
- /// Returns the next address from the resolver.
- ///
- /// This function should be called multiple times. On each call, it will
- /// return the next address in connection order preference. If all
- /// addresses have been exhausted, this function returns `none`.
- ///
- /// This function never returns IPv4-mapped IPv6 addresses.
- ///
- /// # Typical errors
- /// - `name-unresolvable`: Name does not exist or has no suitable associated IP addresses. (EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY)
- /// - `temporary-resolver-failure`: A temporary failure in name resolution occurred. (EAI_AGAIN)
- /// - `permanent-resolver-failure`: A permanent failure in name resolution occurred. (EAI_FAIL)
- /// - `would-block`: A result is not available yet. (EWOULDBLOCK, EAGAIN)
- @since(version = 0.2.0)
- resolve-next-address: func() -> result<option<ip-address>, error-code>;
-
- /// Create a `pollable` which will resolve once the stream is ready for I/O.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-}
diff --git a/crates/wasi-http/wit/deps/sockets/network.wit b/crates/wasi-http/wit/deps/sockets/network.wit
deleted file mode 100644
index 6ca98b63bc..0000000000
--- a/crates/wasi-http/wit/deps/sockets/network.wit
+++ /dev/null
@@ -1,169 +0,0 @@
-@since(version = 0.2.0)
-interface network {
- @unstable(feature = network-error-code)
- use wasi:io/[email protected].{error};
-
- /// An opaque resource that represents access to (a subset of) the network.
- /// This enables context-based security for networking.
- /// There is no need for this to map 1:1 to a physical network interface.
- @since(version = 0.2.0)
- resource network;
-
- /// Error codes.
- ///
- /// In theory, every API can return any error code.
- /// In practice, API's typically only return the errors documented per API
- /// combined with a couple of errors that are always possible:
- /// - `unknown`
- /// - `access-denied`
- /// - `not-supported`
- /// - `out-of-memory`
- /// - `concurrency-conflict`
- ///
- /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
- @since(version = 0.2.0)
- enum error-code {
- /// Unknown error
- unknown,
-
- /// Access denied.
- ///
- /// POSIX equivalent: EACCES, EPERM
- access-denied,
-
- /// The operation is not supported.
- ///
- /// POSIX equivalent: EOPNOTSUPP
- not-supported,
-
- /// One of the arguments is invalid.
- ///
- /// POSIX equivalent: EINVAL
- invalid-argument,
-
- /// Not enough memory to complete the operation.
- ///
- /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
- out-of-memory,
-
- /// The operation timed out before it could finish completely.
- timeout,
-
- /// This operation is incompatible with another asynchronous operation that is already in progress.
- ///
- /// POSIX equivalent: EALREADY
- concurrency-conflict,
-
- /// Trying to finish an asynchronous operation that:
- /// - has not been started yet, or:
- /// - was already finished by a previous `finish-*` call.
- ///
- /// Note: this is scheduled to be removed when `future`s are natively supported.
- not-in-progress,
-
- /// The operation has been aborted because it could not be completed immediately.
- ///
- /// Note: this is scheduled to be removed when `future`s are natively supported.
- would-block,
-
-
- /// The operation is not valid in the socket's current state.
- invalid-state,
-
- /// A new socket resource could not be created because of a system limit.
- new-socket-limit,
-
- /// A bind operation failed because the provided address is not an address that the `network` can bind to.
- address-not-bindable,
-
- /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
- address-in-use,
-
- /// The remote address is not reachable
- remote-unreachable,
-
-
- /// The TCP connection was forcefully rejected
- connection-refused,
-
- /// The TCP connection was reset.
- connection-reset,
-
- /// A TCP connection was aborted.
- connection-aborted,
-
-
- /// The size of a datagram sent to a UDP socket exceeded the maximum
- /// supported size.
- datagram-too-large,
-
-
- /// Name does not exist or has no suitable associated IP addresses.
- name-unresolvable,
-
- /// A temporary failure in name resolution occurred.
- temporary-resolver-failure,
-
- /// A permanent failure in name resolution occurred.
- permanent-resolver-failure,
- }
-
- /// Attempts to extract a network-related `error-code` from the stream
- /// `error` provided.
- ///
- /// Stream operations which return `stream-error::last-operation-failed`
- /// have a payload with more information about the operation that failed.
- /// This payload can be passed through to this function to see if there's
- /// network-related information about the error to return.
- ///
- /// Note that this function is fallible because not all stream-related
- /// errors are network-related errors.
- @unstable(feature = network-error-code)
- network-error-code: func(err: borrow<error>) -> option<error-code>;
-
- @since(version = 0.2.0)
- enum ip-address-family {
- /// Similar to `AF_INET` in POSIX.
- ipv4,
-
- /// Similar to `AF_INET6` in POSIX.
- ipv6,
- }
-
- @since(version = 0.2.0)
- type ipv4-address = tuple<u8, u8, u8, u8>;
- @since(version = 0.2.0)
- type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
-
- @since(version = 0.2.0)
- variant ip-address {
- ipv4(ipv4-address),
- ipv6(ipv6-address),
- }
-
- @since(version = 0.2.0)
- record ipv4-socket-address {
- /// sin_port
- port: u16,
- /// sin_addr
- address: ipv4-address,
- }
-
- @since(version = 0.2.0)
- record ipv6-socket-address {
- /// sin6_port
- port: u16,
- /// sin6_flowinfo
- flow-info: u32,
- /// sin6_addr
- address: ipv6-address,
- /// sin6_scope_id
- scope-id: u32,
- }
-
- @since(version = 0.2.0)
- variant ip-socket-address {
- ipv4(ipv4-socket-address),
- ipv6(ipv6-socket-address),
- }
-}
diff --git a/crates/wasi-http/wit/deps/sockets/tcp-create-socket.wit b/crates/wasi-http/wit/deps/sockets/tcp-create-socket.wit
deleted file mode 100644
index eedbd30768..0000000000
--- a/crates/wasi-http/wit/deps/sockets/tcp-create-socket.wit
+++ /dev/null
@@ -1,30 +0,0 @@
-@since(version = 0.2.0)
-interface tcp-create-socket {
- @since(version = 0.2.0)
- use network.{network, error-code, ip-address-family};
- @since(version = 0.2.0)
- use tcp.{tcp-socket};
-
- /// Create a new TCP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// This function does not require a network capability handle. This is considered to be safe because
- /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind`/`connect`
- /// is called, the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
- ///
- /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
- ///
- /// # Typical errors
- /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
- /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.2.0)
- create-tcp-socket: func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
-}
diff --git a/crates/wasi-http/wit/deps/sockets/tcp.wit b/crates/wasi-http/wit/deps/sockets/tcp.wit
deleted file mode 100644
index beefd7b465..0000000000
--- a/crates/wasi-http/wit/deps/sockets/tcp.wit
+++ /dev/null
@@ -1,387 +0,0 @@
-@since(version = 0.2.0)
-interface tcp {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{input-stream, output-stream};
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
- @since(version = 0.2.0)
- use wasi:clocks/[email protected].{duration};
- @since(version = 0.2.0)
- use network.{network, error-code, ip-socket-address, ip-address-family};
-
- @since(version = 0.2.0)
- enum shutdown-type {
- /// Similar to `SHUT_RD` in POSIX.
- receive,
-
- /// Similar to `SHUT_WR` in POSIX.
- send,
-
- /// Similar to `SHUT_RDWR` in POSIX.
- both,
- }
-
- /// A TCP socket resource.
- ///
- /// The socket can be in one of the following states:
- /// - `unbound`
- /// - `bind-in-progress`
- /// - `bound` (See note below)
- /// - `listen-in-progress`
- /// - `listening`
- /// - `connect-in-progress`
- /// - `connected`
- /// - `closed`
- /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md>
- /// for more information.
- ///
- /// Note: Except where explicitly mentioned, whenever this documentation uses
- /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
- /// (i.e. `bound`, `listen-in-progress`, `listening`, `connect-in-progress` or `connected`)
- ///
- /// In addition to the general error codes documented on the
- /// `network::error-code` type, TCP socket methods may always return
- /// `error(invalid-state)` when in the `closed` state.
- @since(version = 0.2.0)
- resource tcp-socket {
- /// Bind the socket to a specific network on the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
- ///
- /// Bind can be attempted multiple times on the same socket, even with
- /// different arguments on each iteration. But never concurrently and
- /// only as long as the previous bind failed. Once a bind succeeds, the
- /// binding can't be changed anymore.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
- /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
- /// - `not-in-progress`: A `bind` operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
- /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
- /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
- /// and SO_REUSEADDR performs something different entirely.
- ///
- /// Unlike in POSIX, in WASI the bind operation is async. This enables
- /// interactive WASI hosts to inject permission prompts. Runtimes that
- /// don't want to make use of this ability can simply call the native
- /// `bind` as part of either `start-bind` or `finish-bind`.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.2.0)
- start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-bind: func() -> result<_, error-code>;
-
- /// Connect to a remote endpoint.
- ///
- /// On success:
- /// - the socket is transitioned into the `connected` state.
- /// - a pair of streams is returned that can be used to read & write to the connection
- ///
- /// After a failed connection attempt, the socket will be in the `closed`
- /// state and the only valid action left is to `drop` the socket. A single
- /// socket can not be used to connect more than once.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
- /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
- /// - `invalid-argument`: The socket is already attached to a different network. The `network` passed to `connect` must be identical to the one passed to `bind`.
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
- /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
- /// - `timeout`: Connection timed out. (ETIMEDOUT)
- /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- /// - `not-in-progress`: A connect operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// The POSIX equivalent of `start-connect` is the regular `connect` syscall.
- /// Because all WASI sockets are non-blocking this is expected to return
- /// EINPROGRESS, which should be translated to `ok()` in WASI.
- ///
- /// The POSIX equivalent of `finish-connect` is a `poll` for event `POLLOUT`
- /// with a timeout of 0 on the socket descriptor. Followed by a check for
- /// the `SO_ERROR` socket option, in case the poll signaled readiness.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.2.0)
- start-connect: func(network: borrow<network>, remote-address: ip-socket-address) -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-connect: func() -> result<tuple<input-stream, output-stream>, error-code>;
-
- /// Start listening for new connections.
- ///
- /// Transitions the socket into the `listening` state.
- ///
- /// Unlike POSIX, the socket must already be explicitly bound.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address. (EDESTADDRREQ)
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
- /// - `invalid-state`: The socket is already in the `listening` state.
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
- /// - `not-in-progress`: A listen operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// Unlike in POSIX, in WASI the listen operation is async. This enables
- /// interactive WASI hosts to inject permission prompts. Runtimes that
- /// don't want to make use of this ability can simply call the native
- /// `listen` as part of either `start-listen` or `finish-listen`.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
- /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
- @since(version = 0.2.0)
- start-listen: func() -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-listen: func() -> result<_, error-code>;
-
- /// Accept a new client socket.
- ///
- /// The returned socket is bound and in the `connected` state. The following properties are inherited from the listener socket:
- /// - `address-family`
- /// - `keep-alive-enabled`
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// - `hop-limit`
- /// - `receive-buffer-size`
- /// - `send-buffer-size`
- ///
- /// On success, this function returns the newly accepted client socket along with
- /// a pair of streams that can be used to read & write to the connection.
- ///
- /// # Typical errors
- /// - `invalid-state`: Socket is not in the `listening` state. (EINVAL)
- /// - `would-block`: No pending connections at the moment. (EWOULDBLOCK, EAGAIN)
- /// - `connection-aborted`: An incoming connection was pending, but was terminated by the client before this listener could accept it. (ECONNABORTED)
- /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
- /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
- @since(version = 0.2.0)
- accept: func() -> result<tuple<tcp-socket, input-stream, output-stream>, error-code>;
-
- /// Get the bound local address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.2.0)
- local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the remote address.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.2.0)
- remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether the socket is in the `listening` state.
- ///
- /// Equivalent to the SO_ACCEPTCONN socket option.
- @since(version = 0.2.0)
- is-listening: func() -> bool;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.2.0)
- address-family: func() -> ip-address-family;
-
- /// Hints the desired listen queue size. Implementations are free to ignore this.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- ///
- /// # Typical errors
- /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
- /// - `invalid-argument`: (set) The provided value was 0.
- /// - `invalid-state`: (set) The socket is in the `connect-in-progress` or `connected` state.
- @since(version = 0.2.0)
- set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
-
- /// Enables or disables keepalive.
- ///
- /// The keepalive behavior can be adjusted using:
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
- ///
- /// Equivalent to the SO_KEEPALIVE socket option.
- @since(version = 0.2.0)
- keep-alive-enabled: func() -> result<bool, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
-
- /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- keep-alive-idle-time: func() -> result<duration, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
-
- /// The time between keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPINTVL socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- keep-alive-interval: func() -> result<duration, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
-
- /// The maximum amount of keepalive packets TCP should send before aborting the connection.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPCNT socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- keep-alive-count: func() -> result<u32, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-count: func(value: u32) -> result<_, error-code>;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.2.0)
- hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.2.0)
- set-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.2.0)
- send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
-
- /// Create a `pollable` which can be used to poll for, or block on,
- /// completion of any of the asynchronous operations of this socket.
- ///
- /// When `finish-bind`, `finish-listen`, `finish-connect` or `accept`
- /// return `error(would-block)`, this pollable can be used to wait for
- /// their success or failure, after which the method can be retried.
- ///
- /// The pollable is not limited to the async operation that happens to be
- /// in progress at the time of calling `subscribe` (if any). Theoretically,
- /// `subscribe` only has to be called once per socket and can then be
- /// (re)used for the remainder of the socket's lifetime.
- ///
- /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md#pollable-readiness>
- /// for more information.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
-
- /// Initiate a graceful shutdown.
- ///
- /// - `receive`: The socket is not expecting to receive any data from
- /// the peer. The `input-stream` associated with this socket will be
- /// closed. Any data still in the receive queue at time of calling
- /// this method will be discarded.
- /// - `send`: The socket has no more data to send to the peer. The `output-stream`
- /// associated with this socket will be closed and a FIN packet will be sent.
- /// - `both`: Same effect as `receive` & `send` combined.
- ///
- /// This function is idempotent; shutting down a direction more than once
- /// has no effect and returns `ok`.
- ///
- /// The shutdown function does not close (drop) the socket.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/shutdown.html>
- /// - <https://man7.org/linux/man-pages/man2/shutdown.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-shutdown>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=shutdown&sektion=2>
- @since(version = 0.2.0)
- shutdown: func(shutdown-type: shutdown-type) -> result<_, error-code>;
- }
-}
diff --git a/crates/wasi-http/wit/deps/sockets/udp-create-socket.wit b/crates/wasi-http/wit/deps/sockets/udp-create-socket.wit
deleted file mode 100644
index e8eeacbfef..0000000000
--- a/crates/wasi-http/wit/deps/sockets/udp-create-socket.wit
+++ /dev/null
@@ -1,30 +0,0 @@
-@since(version = 0.2.0)
-interface udp-create-socket {
- @since(version = 0.2.0)
- use network.{network, error-code, ip-address-family};
- @since(version = 0.2.0)
- use udp.{udp-socket};
-
- /// Create a new UDP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// This function does not require a network capability handle. This is considered to be safe because
- /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind` is called,
- /// the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
- ///
- /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
- ///
- /// # Typical errors
- /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
- /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.2.0)
- create-udp-socket: func(address-family: ip-address-family) -> result<udp-socket, error-code>;
-}
diff --git a/crates/wasi-http/wit/deps/sockets/udp.wit b/crates/wasi-http/wit/deps/sockets/udp.wit
deleted file mode 100644
index 9dbe6932dd..0000000000
--- a/crates/wasi-http/wit/deps/sockets/udp.wit
+++ /dev/null
@@ -1,288 +0,0 @@
-@since(version = 0.2.0)
-interface udp {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
- @since(version = 0.2.0)
- use network.{network, error-code, ip-socket-address, ip-address-family};
-
- /// A received datagram.
- @since(version = 0.2.0)
- record incoming-datagram {
- /// The payload.
- ///
- /// Theoretical max size: ~64 KiB. In practice, typically less than 1500 bytes.
- data: list<u8>,
-
- /// The source address.
- ///
- /// This field is guaranteed to match the remote address the stream was initialized with, if any.
- ///
- /// Equivalent to the `src_addr` out parameter of `recvfrom`.
- remote-address: ip-socket-address,
- }
-
- /// A datagram to be sent out.
- @since(version = 0.2.0)
- record outgoing-datagram {
- /// The payload.
- data: list<u8>,
-
- /// The destination address.
- ///
- /// The requirements on this field depend on how the stream was initialized:
- /// - with a remote address: this field must be None or match the stream's remote address exactly.
- /// - without a remote address: this field is required.
- ///
- /// If this value is None, the send operation is equivalent to `send` in POSIX. Otherwise it is equivalent to `sendto`.
- remote-address: option<ip-socket-address>,
- }
-
- /// A UDP socket handle.
- @since(version = 0.2.0)
- resource udp-socket {
- /// Bind the socket to a specific network on the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the port is zero, the socket will be bound to a random free port.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
- /// - `not-in-progress`: A `bind` operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// Unlike in POSIX, in WASI the bind operation is async. This enables
- /// interactive WASI hosts to inject permission prompts. Runtimes that
- /// don't want to make use of this ability can simply call the native
- /// `bind` as part of either `start-bind` or `finish-bind`.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.2.0)
- start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-bind: func() -> result<_, error-code>;
-
- /// Set up inbound & outbound communication channels, optionally to a specific peer.
- ///
- /// This function only changes the local socket configuration and does not generate any network traffic.
- /// On success, the `remote-address` of the socket is updated. The `local-address` may be updated as well,
- /// based on the best network path to `remote-address`.
- ///
- /// When a `remote-address` is provided, the returned streams are limited to communicating with that specific peer:
- /// - `send` can only be used to send to this destination.
- /// - `receive` will only return datagrams sent from the provided `remote-address`.
- ///
- /// This method may be called multiple times on the same socket to change its association, but
- /// only the most recently returned pair of streams will be operational. Implementations may trap if
- /// the streams returned by a previous invocation haven't been dropped yet before calling `stream` again.
- ///
- /// The POSIX equivalent in pseudo-code is:
- /// ```text
- /// if (was previously connected) {
- /// connect(s, AF_UNSPEC)
- /// }
- /// if (remote_address is Some) {
- /// connect(s, remote_address)
- /// }
- /// ```
- ///
- /// Unlike in POSIX, the socket must already be explicitly bound.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-state`: The socket is not bound.
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.2.0)
- %stream: func(remote-address: option<ip-socket-address>) -> result<tuple<incoming-datagram-stream, outgoing-datagram-stream>, error-code>;
-
- /// Get the current bound address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.2.0)
- local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the address the socket is currently streaming to.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not streaming to a specific remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.2.0)
- remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.2.0)
- address-family: func() -> ip-address-family;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.2.0)
- unicast-hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.2.0)
- set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.2.0)
- send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
-
- /// Create a `pollable` which will resolve once the socket is ready for I/O.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
- @since(version = 0.2.0)
- resource incoming-datagram-stream {
- /// Receive messages on the socket.
- ///
- /// This function attempts to receive up to `max-results` datagrams on the socket without blocking.
- /// The returned list may contain fewer elements than requested, but never more.
- ///
- /// This function returns successfully with an empty list when either:
- /// - `max-results` is 0, or:
- /// - `max-results` is greater than 0, but no results are immediately available.
- /// This function never returns `error(would-block)`.
- ///
- /// # Typical errors
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
- /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
- /// - <https://learn.microsoft.com/en-us/previous-versions/windows/desktop/legacy/ms741687(v=vs.85)>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
- @since(version = 0.2.0)
- receive: func(max-results: u64) -> result<list<incoming-datagram>, error-code>;
-
- /// Create a `pollable` which will resolve once the stream is ready to receive again.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
- @since(version = 0.2.0)
- resource outgoing-datagram-stream {
- /// Check readiness for sending. This function never blocks.
- ///
- /// Returns the number of datagrams permitted for the next call to `send`,
- /// or an error. Calling `send` with more datagrams than this function has
- /// permitted will trap.
- ///
- /// When this function returns ok(0), the `subscribe` pollable will
- /// become ready when this function will report at least ok(1), or an
- /// error.
- ///
- /// Never returns `would-block`.
- check-send: func() -> result<u64, error-code>;
-
- /// Send messages on the socket.
- ///
- /// This function attempts to send all provided `datagrams` on the socket without blocking and
- /// returns how many messages were actually sent (or queued for sending). This function never
- /// returns `error(would-block)`. If none of the datagrams were able to be sent, `ok(0)` is returned.
- ///
- /// This function semantically behaves the same as iterating the `datagrams` list and sequentially
- /// sending each individual datagram until either the end of the list has been reached or the first error occurred.
- /// If at least one datagram has been sent successfully, this function never returns an error.
- ///
- /// If the input list is empty, the function returns `ok(0)`.
- ///
- /// Each call to `send` must be permitted by a preceding `check-send`. Implementations must trap if
- /// either `check-send` was not called or `datagrams` contains more items than `check-send` permitted.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `stream`. (EISCONN)
- /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/send.2.html>
- /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
- @since(version = 0.2.0)
- send: func(datagrams: list<outgoing-datagram>) -> result<u64, error-code>;
-
- /// Create a `pollable` which will resolve once the stream is ready to send again.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-}
diff --git a/crates/wasi-http/wit/deps/sockets/world.wit b/crates/wasi-http/wit/deps/sockets/world.wit
deleted file mode 100644
index e86f02cec6..0000000000
--- a/crates/wasi-http/wit/deps/sockets/world.wit
+++ /dev/null
@@ -1,19 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import instance-network;
- @since(version = 0.2.0)
- import network;
- @since(version = 0.2.0)
- import udp;
- @since(version = 0.2.0)
- import udp-create-socket;
- @since(version = 0.2.0)
- import tcp;
- @since(version = 0.2.0)
- import tcp-create-socket;
- @since(version = 0.2.0)
- import ip-name-lookup;
-}
diff --git a/crates/wasi-io/wit/deps/io.wit b/crates/wasi-io/wit/deps/io.wit
new file mode 100644
index 0000000000..08ad78e6b7
--- /dev/null
+++ b/crates/wasi-io/wit/deps/io.wit
@@ -0,0 +1,331 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface error {
+ /// A resource which represents some error information.
+ ///
+ /// The only method provided by this resource is `to-debug-string`,
+ /// which provides some human-readable information about the error.
+ ///
+ /// In the `wasi:io` package, this resource is returned through the
+ /// `wasi:io/streams/stream-error` type.
+ ///
+ /// To provide more specific error information, other interfaces may
+ /// offer functions to "downcast" this error into more specific types. For example,
+ /// errors returned from streams derived from filesystem types can be described using
+ /// the filesystem's own error-code type. This is done using the function
+ /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
+ /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
+ ///
+ /// The set of functions which can "downcast" an `error` into a more
+ /// concrete type is open.
+ @since(version = 0.2.0)
+ resource error {
+ /// Returns a string that is suitable to assist humans in debugging
+ /// this error.
+ ///
+ /// WARNING: The returned string should not be consumed mechanically!
+ /// It may change across platforms, hosts, or other implementation
+ /// details. Parsing this string is a major platform-compatibility
+ /// hazard.
+ @since(version = 0.2.0)
+ to-debug-string: func() -> string;
+ }
+}
+
+/// A poll API intended to let users wait for I/O events on multiple handles
+/// at once.
+@since(version = 0.2.0)
+interface poll {
+ /// `pollable` represents a single I/O event which may be ready, or not.
+ @since(version = 0.2.0)
+ resource pollable {
+ /// Return the readiness of a pollable. This function never blocks.
+ ///
+ /// Returns `true` when the pollable is ready, and `false` otherwise.
+ @since(version = 0.2.0)
+ ready: func() -> bool;
+ /// `block` returns immediately if the pollable is ready, and otherwise
+ /// blocks until ready.
+ ///
+ /// This function is equivalent to calling `poll.poll` on a list
+ /// containing only this pollable.
+ @since(version = 0.2.0)
+ block: func();
+ }
+
+ /// Poll for completion on a set of pollables.
+ ///
+ /// This function takes a list of pollables, which identify I/O sources of
+ /// interest, and waits until one or more of the events is ready for I/O.
+ ///
+ /// The result `list<u32>` contains one or more indices of handles in the
+ /// argument list that is ready for I/O.
+ ///
+ /// This function traps if either:
+ /// - the list is empty, or:
+ /// - the list contains more elements than can be indexed with a `u32` value.
+ ///
+ /// A timeout can be implemented by adding a pollable from the
+ /// wasi-clocks API to the list.
+ ///
+ /// This function does not return a `result`; polling in itself does not
+ /// do any I/O so it doesn't fail. If any of the I/O sources identified by
+ /// the pollables has an error, it is indicated by marking the source as
+ /// being ready for I/O.
+ @since(version = 0.2.0)
+ poll: func(in: list<borrow<pollable>>) -> list<u32>;
+}
+
+/// WASI I/O is an I/O abstraction API which is currently focused on providing
+/// stream types.
+///
+/// In the future, the component model is expected to add built-in stream types;
+/// when it does, they are expected to subsume this API.
+@since(version = 0.2.0)
+interface streams {
+ @since(version = 0.2.0)
+ use error.{error};
+ @since(version = 0.2.0)
+ use poll.{pollable};
+
+ /// An error for input-stream and output-stream operations.
+ @since(version = 0.2.0)
+ variant stream-error {
+ /// The last operation (a write or flush) failed before completion.
+ ///
+ /// More information is available in the `error` payload.
+ ///
+ /// After this, the stream will be closed. All future operations return
+ /// `stream-error::closed`.
+ last-operation-failed(error),
+ /// The stream is closed: no more input will be accepted by the
+ /// stream. A closed output-stream will return this error on all
+ /// future operations.
+ closed,
+ }
+
+ /// An input bytestream.
+ ///
+ /// `input-stream`s are *non-blocking* to the extent practical on underlying
+ /// platforms. I/O operations always return promptly; if fewer bytes are
+ /// promptly available than requested, they return the number of bytes promptly
+ /// available, which could even be zero. To wait for data to be available,
+ /// use the `subscribe` function to obtain a `pollable` which can be polled
+ /// for using `wasi:io/poll`.
+ @since(version = 0.2.0)
+ resource input-stream {
+ /// Perform a non-blocking read from the stream.
+ ///
+ /// When the source of a `read` is binary data, the bytes from the source
+ /// are returned verbatim. When the source of a `read` is known to the
+ /// implementation to be text, bytes containing the UTF-8 encoding of the
+ /// text are returned.
+ ///
+ /// This function returns a list of bytes containing the read data,
+ /// when successful. The returned list will contain up to `len` bytes;
+ /// it may return fewer than requested, but not more. The list is
+ /// empty when no bytes are available for reading at this time. The
+ /// pollable given by `subscribe` will be ready when more bytes are
+ /// available.
+ ///
+ /// This function fails with a `stream-error` when the operation
+ /// encounters an error, giving `last-operation-failed`, or when the
+ /// stream is closed, giving `closed`.
+ ///
+ /// When the caller gives a `len` of 0, it represents a request to
+ /// read 0 bytes. If the stream is still open, this call should
+ /// succeed and return an empty list, or otherwise fail with `closed`.
+ ///
+ /// The `len` parameter is a `u64`, which could represent a list of u8 which
+ /// is not possible to allocate in wasm32, or not desirable to allocate as
+ /// as a return value by the callee. The callee may return a list of bytes
+ /// less than `len` in size while more bytes are available for reading.
+ @since(version = 0.2.0)
+ read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Read bytes from a stream, after blocking until at least one byte can
+ /// be read. Except for blocking, behavior is identical to `read`.
+ @since(version = 0.2.0)
+ blocking-read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Skip bytes from a stream. Returns number of bytes skipped.
+ ///
+ /// Behaves identical to `read`, except instead of returning a list
+ /// of bytes, returns the number of bytes consumed from the stream.
+ @since(version = 0.2.0)
+ skip: func(len: u64) -> result<u64, stream-error>;
+ /// Skip bytes from a stream, after blocking until at least one byte
+ /// can be skipped. Except for blocking behavior, identical to `skip`.
+ @since(version = 0.2.0)
+ blocking-skip: func(len: u64) -> result<u64, stream-error>;
+ /// Create a `pollable` which will resolve once either the specified stream
+ /// has bytes available to read or the other end of the stream has been
+ /// closed.
+ /// The created `pollable` is a child resource of the `input-stream`.
+ /// Implementations may trap if the `input-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ /// An output bytestream.
+ ///
+ /// `output-stream`s are *non-blocking* to the extent practical on
+ /// underlying platforms. Except where specified otherwise, I/O operations also
+ /// always return promptly, after the number of bytes that can be written
+ /// promptly, which could even be zero. To wait for the stream to be ready to
+ /// accept data, the `subscribe` function to obtain a `pollable` which can be
+ /// polled for using `wasi:io/poll`.
+ ///
+ /// Dropping an `output-stream` while there's still an active write in
+ /// progress may result in the data being lost. Before dropping the stream,
+ /// be sure to fully flush your writes.
+ @since(version = 0.2.0)
+ resource output-stream {
+ /// Check readiness for writing. This function never blocks.
+ ///
+ /// Returns the number of bytes permitted for the next call to `write`,
+ /// or an error. Calling `write` with more bytes than this function has
+ /// permitted will trap.
+ ///
+ /// When this function returns 0 bytes, the `subscribe` pollable will
+ /// become ready when this function will report at least 1 byte, or an
+ /// error.
+ @since(version = 0.2.0)
+ check-write: func() -> result<u64, stream-error>;
+ /// Perform a write. This function never blocks.
+ ///
+ /// When the destination of a `write` is binary data, the bytes from
+ /// `contents` are written verbatim. When the destination of a `write` is
+ /// known to the implementation to be text, the bytes of `contents` are
+ /// transcoded from UTF-8 into the encoding of the destination and then
+ /// written.
+ ///
+ /// Precondition: check-write gave permit of Ok(n) and contents has a
+ /// length of less than or equal to n. Otherwise, this function will trap.
+ ///
+ /// returns Err(closed) without writing if the stream has closed since
+ /// the last call to check-write provided a permit.
+ @since(version = 0.2.0)
+ write: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 bytes, and then flush the stream. Block
+ /// until all of these operations are complete, or an error occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write`, and `flush`, and is implemented with the
+ /// following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while !contents.is_empty() {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, contents.len());
+ /// let (chunk, rest) = contents.split_at(len);
+ /// this.write(chunk ); // eliding error handling
+ /// contents = rest;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-and-flush: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Request to flush buffered output. This function never blocks.
+ ///
+ /// This tells the output-stream that the caller intends any buffered
+ /// output to be flushed. the output which is expected to be flushed
+ /// is all that has been passed to `write` prior to this call.
+ ///
+ /// Upon calling this function, the `output-stream` will not accept any
+ /// writes (`check-write` will return `ok(0)`) until the flush has
+ /// completed. The `subscribe` pollable will become ready when the
+ /// flush has completed and the stream can accept more writes.
+ @since(version = 0.2.0)
+ flush: func() -> result<_, stream-error>;
+ /// Request to flush buffered output, and block until flush completes
+ /// and stream is ready for writing again.
+ @since(version = 0.2.0)
+ blocking-flush: func() -> result<_, stream-error>;
+ /// Create a `pollable` which will resolve once the output-stream
+ /// is ready for more writing, or an error has occurred. When this
+ /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
+ /// error.
+ ///
+ /// If the stream is closed, this pollable is always ready immediately.
+ ///
+ /// The created `pollable` is a child resource of the `output-stream`.
+ /// Implementations may trap if the `output-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ /// Write zeroes to a stream.
+ ///
+ /// This should be used precisely like `write` with the exact same
+ /// preconditions (must use check-write first), but instead of
+ /// passing a list of bytes, you simply pass the number of zero-bytes
+ /// that should be written.
+ @since(version = 0.2.0)
+ write-zeroes: func(len: u64) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 zeroes, and then flush the stream.
+ /// Block until all of these operations are complete, or an error
+ /// occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
+ /// the following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while num_zeroes != 0 {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, num_zeroes);
+ /// this.write-zeroes(len); // eliding error handling
+ /// num_zeroes -= len;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-zeroes-and-flush: func(len: u64) -> result<_, stream-error>;
+ /// Read from one stream and write to another.
+ ///
+ /// The behavior of splice is equivalent to:
+ /// 1. calling `check-write` on the `output-stream`
+ /// 2. calling `read` on the `input-stream` with the smaller of the
+ /// `check-write` permitted length and the `len` provided to `splice`
+ /// 3. calling `write` on the `output-stream` with that read data.
+ ///
+ /// Any error reported by the call to `check-write`, `read`, or
+ /// `write` ends the splice and reports that error.
+ ///
+ /// This function returns the number of bytes transferred; it may be less
+ /// than `len`.
+ @since(version = 0.2.0)
+ splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ /// Read from one stream and write to another, with blocking.
+ ///
+ /// This is similar to `splice`, except that it blocks until the
+ /// `output-stream` is ready for writing, and the `input-stream`
+ /// is ready for reading, before performing the `splice`.
+ @since(version = 0.2.0)
+ blocking-splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ }
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import error;
+ @since(version = 0.2.0)
+ import poll;
+ @since(version = 0.2.0)
+ import streams;
+}
diff --git a/crates/wasi-io/wit/deps/io/error.wit b/crates/wasi-io/wit/deps/io/error.wit
deleted file mode 100644
index 784f74a53e..0000000000
--- a/crates/wasi-io/wit/deps/io/error.wit
+++ /dev/null
@@ -1,34 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-interface error {
- /// A resource which represents some error information.
- ///
- /// The only method provided by this resource is `to-debug-string`,
- /// which provides some human-readable information about the error.
- ///
- /// In the `wasi:io` package, this resource is returned through the
- /// `wasi:io/streams/stream-error` type.
- ///
- /// To provide more specific error information, other interfaces may
- /// offer functions to "downcast" this error into more specific types. For example,
- /// errors returned from streams derived from filesystem types can be described using
- /// the filesystem's own error-code type. This is done using the function
- /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
- /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
- ///
- /// The set of functions which can "downcast" an `error` into a more
- /// concrete type is open.
- @since(version = 0.2.0)
- resource error {
- /// Returns a string that is suitable to assist humans in debugging
- /// this error.
- ///
- /// WARNING: The returned string should not be consumed mechanically!
- /// It may change across platforms, hosts, or other implementation
- /// details. Parsing this string is a major platform-compatibility
- /// hazard.
- @since(version = 0.2.0)
- to-debug-string: func() -> string;
- }
-}
diff --git a/crates/wasi-io/wit/deps/io/poll.wit b/crates/wasi-io/wit/deps/io/poll.wit
deleted file mode 100644
index 7f711836c3..0000000000
--- a/crates/wasi-io/wit/deps/io/poll.wit
+++ /dev/null
@@ -1,47 +0,0 @@
-package wasi:[email protected];
-
-/// A poll API intended to let users wait for I/O events on multiple handles
-/// at once.
-@since(version = 0.2.0)
-interface poll {
- /// `pollable` represents a single I/O event which may be ready, or not.
- @since(version = 0.2.0)
- resource pollable {
-
- /// Return the readiness of a pollable. This function never blocks.
- ///
- /// Returns `true` when the pollable is ready, and `false` otherwise.
- @since(version = 0.2.0)
- ready: func() -> bool;
-
- /// `block` returns immediately if the pollable is ready, and otherwise
- /// blocks until ready.
- ///
- /// This function is equivalent to calling `poll.poll` on a list
- /// containing only this pollable.
- @since(version = 0.2.0)
- block: func();
- }
-
- /// Poll for completion on a set of pollables.
- ///
- /// This function takes a list of pollables, which identify I/O sources of
- /// interest, and waits until one or more of the events is ready for I/O.
- ///
- /// The result `list<u32>` contains one or more indices of handles in the
- /// argument list that is ready for I/O.
- ///
- /// This function traps if either:
- /// - the list is empty, or:
- /// - the list contains more elements than can be indexed with a `u32` value.
- ///
- /// A timeout can be implemented by adding a pollable from the
- /// wasi-clocks API to the list.
- ///
- /// This function does not return a `result`; polling in itself does not
- /// do any I/O so it doesn't fail. If any of the I/O sources identified by
- /// the pollables has an error, it is indicated by marking the source as
- /// being ready for I/O.
- @since(version = 0.2.0)
- poll: func(in: list<borrow<pollable>>) -> list<u32>;
-}
diff --git a/crates/wasi-io/wit/deps/io/streams.wit b/crates/wasi-io/wit/deps/io/streams.wit
deleted file mode 100644
index c5da38c862..0000000000
--- a/crates/wasi-io/wit/deps/io/streams.wit
+++ /dev/null
@@ -1,290 +0,0 @@
-package wasi:[email protected];
-
-/// WASI I/O is an I/O abstraction API which is currently focused on providing
-/// stream types.
-///
-/// In the future, the component model is expected to add built-in stream types;
-/// when it does, they are expected to subsume this API.
-@since(version = 0.2.0)
-interface streams {
- @since(version = 0.2.0)
- use error.{error};
- @since(version = 0.2.0)
- use poll.{pollable};
-
- /// An error for input-stream and output-stream operations.
- @since(version = 0.2.0)
- variant stream-error {
- /// The last operation (a write or flush) failed before completion.
- ///
- /// More information is available in the `error` payload.
- ///
- /// After this, the stream will be closed. All future operations return
- /// `stream-error::closed`.
- last-operation-failed(error),
- /// The stream is closed: no more input will be accepted by the
- /// stream. A closed output-stream will return this error on all
- /// future operations.
- closed
- }
-
- /// An input bytestream.
- ///
- /// `input-stream`s are *non-blocking* to the extent practical on underlying
- /// platforms. I/O operations always return promptly; if fewer bytes are
- /// promptly available than requested, they return the number of bytes promptly
- /// available, which could even be zero. To wait for data to be available,
- /// use the `subscribe` function to obtain a `pollable` which can be polled
- /// for using `wasi:io/poll`.
- @since(version = 0.2.0)
- resource input-stream {
- /// Perform a non-blocking read from the stream.
- ///
- /// When the source of a `read` is binary data, the bytes from the source
- /// are returned verbatim. When the source of a `read` is known to the
- /// implementation to be text, bytes containing the UTF-8 encoding of the
- /// text are returned.
- ///
- /// This function returns a list of bytes containing the read data,
- /// when successful. The returned list will contain up to `len` bytes;
- /// it may return fewer than requested, but not more. The list is
- /// empty when no bytes are available for reading at this time. The
- /// pollable given by `subscribe` will be ready when more bytes are
- /// available.
- ///
- /// This function fails with a `stream-error` when the operation
- /// encounters an error, giving `last-operation-failed`, or when the
- /// stream is closed, giving `closed`.
- ///
- /// When the caller gives a `len` of 0, it represents a request to
- /// read 0 bytes. If the stream is still open, this call should
- /// succeed and return an empty list, or otherwise fail with `closed`.
- ///
- /// The `len` parameter is a `u64`, which could represent a list of u8 which
- /// is not possible to allocate in wasm32, or not desirable to allocate as
- /// as a return value by the callee. The callee may return a list of bytes
- /// less than `len` in size while more bytes are available for reading.
- @since(version = 0.2.0)
- read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Read bytes from a stream, after blocking until at least one byte can
- /// be read. Except for blocking, behavior is identical to `read`.
- @since(version = 0.2.0)
- blocking-read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Skip bytes from a stream. Returns number of bytes skipped.
- ///
- /// Behaves identical to `read`, except instead of returning a list
- /// of bytes, returns the number of bytes consumed from the stream.
- @since(version = 0.2.0)
- skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Skip bytes from a stream, after blocking until at least one byte
- /// can be skipped. Except for blocking behavior, identical to `skip`.
- @since(version = 0.2.0)
- blocking-skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Create a `pollable` which will resolve once either the specified stream
- /// has bytes available to read or the other end of the stream has been
- /// closed.
- /// The created `pollable` is a child resource of the `input-stream`.
- /// Implementations may trap if the `input-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
-
- /// An output bytestream.
- ///
- /// `output-stream`s are *non-blocking* to the extent practical on
- /// underlying platforms. Except where specified otherwise, I/O operations also
- /// always return promptly, after the number of bytes that can be written
- /// promptly, which could even be zero. To wait for the stream to be ready to
- /// accept data, the `subscribe` function to obtain a `pollable` which can be
- /// polled for using `wasi:io/poll`.
- ///
- /// Dropping an `output-stream` while there's still an active write in
- /// progress may result in the data being lost. Before dropping the stream,
- /// be sure to fully flush your writes.
- @since(version = 0.2.0)
- resource output-stream {
- /// Check readiness for writing. This function never blocks.
- ///
- /// Returns the number of bytes permitted for the next call to `write`,
- /// or an error. Calling `write` with more bytes than this function has
- /// permitted will trap.
- ///
- /// When this function returns 0 bytes, the `subscribe` pollable will
- /// become ready when this function will report at least 1 byte, or an
- /// error.
- @since(version = 0.2.0)
- check-write: func() -> result<u64, stream-error>;
-
- /// Perform a write. This function never blocks.
- ///
- /// When the destination of a `write` is binary data, the bytes from
- /// `contents` are written verbatim. When the destination of a `write` is
- /// known to the implementation to be text, the bytes of `contents` are
- /// transcoded from UTF-8 into the encoding of the destination and then
- /// written.
- ///
- /// Precondition: check-write gave permit of Ok(n) and contents has a
- /// length of less than or equal to n. Otherwise, this function will trap.
- ///
- /// returns Err(closed) without writing if the stream has closed since
- /// the last call to check-write provided a permit.
- @since(version = 0.2.0)
- write: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 bytes, and then flush the stream. Block
- /// until all of these operations are complete, or an error occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write`, and `flush`, and is implemented with the
- /// following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while !contents.is_empty() {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, contents.len());
- /// let (chunk, rest) = contents.split_at(len);
- /// this.write(chunk ); // eliding error handling
- /// contents = rest;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-and-flush: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Request to flush buffered output. This function never blocks.
- ///
- /// This tells the output-stream that the caller intends any buffered
- /// output to be flushed. the output which is expected to be flushed
- /// is all that has been passed to `write` prior to this call.
- ///
- /// Upon calling this function, the `output-stream` will not accept any
- /// writes (`check-write` will return `ok(0)`) until the flush has
- /// completed. The `subscribe` pollable will become ready when the
- /// flush has completed and the stream can accept more writes.
- @since(version = 0.2.0)
- flush: func() -> result<_, stream-error>;
-
- /// Request to flush buffered output, and block until flush completes
- /// and stream is ready for writing again.
- @since(version = 0.2.0)
- blocking-flush: func() -> result<_, stream-error>;
-
- /// Create a `pollable` which will resolve once the output-stream
- /// is ready for more writing, or an error has occurred. When this
- /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
- /// error.
- ///
- /// If the stream is closed, this pollable is always ready immediately.
- ///
- /// The created `pollable` is a child resource of the `output-stream`.
- /// Implementations may trap if the `output-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
-
- /// Write zeroes to a stream.
- ///
- /// This should be used precisely like `write` with the exact same
- /// preconditions (must use check-write first), but instead of
- /// passing a list of bytes, you simply pass the number of zero-bytes
- /// that should be written.
- @since(version = 0.2.0)
- write-zeroes: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 zeroes, and then flush the stream.
- /// Block until all of these operations are complete, or an error
- /// occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
- /// the following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while num_zeroes != 0 {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, num_zeroes);
- /// this.write-zeroes(len); // eliding error handling
- /// num_zeroes -= len;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-zeroes-and-flush: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Read from one stream and write to another.
- ///
- /// The behavior of splice is equivalent to:
- /// 1. calling `check-write` on the `output-stream`
- /// 2. calling `read` on the `input-stream` with the smaller of the
- /// `check-write` permitted length and the `len` provided to `splice`
- /// 3. calling `write` on the `output-stream` with that read data.
- ///
- /// Any error reported by the call to `check-write`, `read`, or
- /// `write` ends the splice and reports that error.
- ///
- /// This function returns the number of bytes transferred; it may be less
- /// than `len`.
- @since(version = 0.2.0)
- splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Read from one stream and write to another, with blocking.
- ///
- /// This is similar to `splice`, except that it blocks until the
- /// `output-stream` is ready for writing, and the `input-stream`
- /// is ready for reading, before performing the `splice`.
- @since(version = 0.2.0)
- blocking-splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
- }
-}
diff --git a/crates/wasi-io/wit/deps/io/world.wit b/crates/wasi-io/wit/deps/io/world.wit
deleted file mode 100644
index 84c85c08ed..0000000000
--- a/crates/wasi-io/wit/deps/io/world.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import streams;
-
- @since(version = 0.2.0)
- import poll;
-}
diff --git a/crates/wasi-tls/wit/deps/io.wit b/crates/wasi-tls/wit/deps/io.wit
new file mode 100644
index 0000000000..08ad78e6b7
--- /dev/null
+++ b/crates/wasi-tls/wit/deps/io.wit
@@ -0,0 +1,331 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface error {
+ /// A resource which represents some error information.
+ ///
+ /// The only method provided by this resource is `to-debug-string`,
+ /// which provides some human-readable information about the error.
+ ///
+ /// In the `wasi:io` package, this resource is returned through the
+ /// `wasi:io/streams/stream-error` type.
+ ///
+ /// To provide more specific error information, other interfaces may
+ /// offer functions to "downcast" this error into more specific types. For example,
+ /// errors returned from streams derived from filesystem types can be described using
+ /// the filesystem's own error-code type. This is done using the function
+ /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
+ /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
+ ///
+ /// The set of functions which can "downcast" an `error` into a more
+ /// concrete type is open.
+ @since(version = 0.2.0)
+ resource error {
+ /// Returns a string that is suitable to assist humans in debugging
+ /// this error.
+ ///
+ /// WARNING: The returned string should not be consumed mechanically!
+ /// It may change across platforms, hosts, or other implementation
+ /// details. Parsing this string is a major platform-compatibility
+ /// hazard.
+ @since(version = 0.2.0)
+ to-debug-string: func() -> string;
+ }
+}
+
+/// A poll API intended to let users wait for I/O events on multiple handles
+/// at once.
+@since(version = 0.2.0)
+interface poll {
+ /// `pollable` represents a single I/O event which may be ready, or not.
+ @since(version = 0.2.0)
+ resource pollable {
+ /// Return the readiness of a pollable. This function never blocks.
+ ///
+ /// Returns `true` when the pollable is ready, and `false` otherwise.
+ @since(version = 0.2.0)
+ ready: func() -> bool;
+ /// `block` returns immediately if the pollable is ready, and otherwise
+ /// blocks until ready.
+ ///
+ /// This function is equivalent to calling `poll.poll` on a list
+ /// containing only this pollable.
+ @since(version = 0.2.0)
+ block: func();
+ }
+
+ /// Poll for completion on a set of pollables.
+ ///
+ /// This function takes a list of pollables, which identify I/O sources of
+ /// interest, and waits until one or more of the events is ready for I/O.
+ ///
+ /// The result `list<u32>` contains one or more indices of handles in the
+ /// argument list that is ready for I/O.
+ ///
+ /// This function traps if either:
+ /// - the list is empty, or:
+ /// - the list contains more elements than can be indexed with a `u32` value.
+ ///
+ /// A timeout can be implemented by adding a pollable from the
+ /// wasi-clocks API to the list.
+ ///
+ /// This function does not return a `result`; polling in itself does not
+ /// do any I/O so it doesn't fail. If any of the I/O sources identified by
+ /// the pollables has an error, it is indicated by marking the source as
+ /// being ready for I/O.
+ @since(version = 0.2.0)
+ poll: func(in: list<borrow<pollable>>) -> list<u32>;
+}
+
+/// WASI I/O is an I/O abstraction API which is currently focused on providing
+/// stream types.
+///
+/// In the future, the component model is expected to add built-in stream types;
+/// when it does, they are expected to subsume this API.
+@since(version = 0.2.0)
+interface streams {
+ @since(version = 0.2.0)
+ use error.{error};
+ @since(version = 0.2.0)
+ use poll.{pollable};
+
+ /// An error for input-stream and output-stream operations.
+ @since(version = 0.2.0)
+ variant stream-error {
+ /// The last operation (a write or flush) failed before completion.
+ ///
+ /// More information is available in the `error` payload.
+ ///
+ /// After this, the stream will be closed. All future operations return
+ /// `stream-error::closed`.
+ last-operation-failed(error),
+ /// The stream is closed: no more input will be accepted by the
+ /// stream. A closed output-stream will return this error on all
+ /// future operations.
+ closed,
+ }
+
+ /// An input bytestream.
+ ///
+ /// `input-stream`s are *non-blocking* to the extent practical on underlying
+ /// platforms. I/O operations always return promptly; if fewer bytes are
+ /// promptly available than requested, they return the number of bytes promptly
+ /// available, which could even be zero. To wait for data to be available,
+ /// use the `subscribe` function to obtain a `pollable` which can be polled
+ /// for using `wasi:io/poll`.
+ @since(version = 0.2.0)
+ resource input-stream {
+ /// Perform a non-blocking read from the stream.
+ ///
+ /// When the source of a `read` is binary data, the bytes from the source
+ /// are returned verbatim. When the source of a `read` is known to the
+ /// implementation to be text, bytes containing the UTF-8 encoding of the
+ /// text are returned.
+ ///
+ /// This function returns a list of bytes containing the read data,
+ /// when successful. The returned list will contain up to `len` bytes;
+ /// it may return fewer than requested, but not more. The list is
+ /// empty when no bytes are available for reading at this time. The
+ /// pollable given by `subscribe` will be ready when more bytes are
+ /// available.
+ ///
+ /// This function fails with a `stream-error` when the operation
+ /// encounters an error, giving `last-operation-failed`, or when the
+ /// stream is closed, giving `closed`.
+ ///
+ /// When the caller gives a `len` of 0, it represents a request to
+ /// read 0 bytes. If the stream is still open, this call should
+ /// succeed and return an empty list, or otherwise fail with `closed`.
+ ///
+ /// The `len` parameter is a `u64`, which could represent a list of u8 which
+ /// is not possible to allocate in wasm32, or not desirable to allocate as
+ /// as a return value by the callee. The callee may return a list of bytes
+ /// less than `len` in size while more bytes are available for reading.
+ @since(version = 0.2.0)
+ read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Read bytes from a stream, after blocking until at least one byte can
+ /// be read. Except for blocking, behavior is identical to `read`.
+ @since(version = 0.2.0)
+ blocking-read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Skip bytes from a stream. Returns number of bytes skipped.
+ ///
+ /// Behaves identical to `read`, except instead of returning a list
+ /// of bytes, returns the number of bytes consumed from the stream.
+ @since(version = 0.2.0)
+ skip: func(len: u64) -> result<u64, stream-error>;
+ /// Skip bytes from a stream, after blocking until at least one byte
+ /// can be skipped. Except for blocking behavior, identical to `skip`.
+ @since(version = 0.2.0)
+ blocking-skip: func(len: u64) -> result<u64, stream-error>;
+ /// Create a `pollable` which will resolve once either the specified stream
+ /// has bytes available to read or the other end of the stream has been
+ /// closed.
+ /// The created `pollable` is a child resource of the `input-stream`.
+ /// Implementations may trap if the `input-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ /// An output bytestream.
+ ///
+ /// `output-stream`s are *non-blocking* to the extent practical on
+ /// underlying platforms. Except where specified otherwise, I/O operations also
+ /// always return promptly, after the number of bytes that can be written
+ /// promptly, which could even be zero. To wait for the stream to be ready to
+ /// accept data, the `subscribe` function to obtain a `pollable` which can be
+ /// polled for using `wasi:io/poll`.
+ ///
+ /// Dropping an `output-stream` while there's still an active write in
+ /// progress may result in the data being lost. Before dropping the stream,
+ /// be sure to fully flush your writes.
+ @since(version = 0.2.0)
+ resource output-stream {
+ /// Check readiness for writing. This function never blocks.
+ ///
+ /// Returns the number of bytes permitted for the next call to `write`,
+ /// or an error. Calling `write` with more bytes than this function has
+ /// permitted will trap.
+ ///
+ /// When this function returns 0 bytes, the `subscribe` pollable will
+ /// become ready when this function will report at least 1 byte, or an
+ /// error.
+ @since(version = 0.2.0)
+ check-write: func() -> result<u64, stream-error>;
+ /// Perform a write. This function never blocks.
+ ///
+ /// When the destination of a `write` is binary data, the bytes from
+ /// `contents` are written verbatim. When the destination of a `write` is
+ /// known to the implementation to be text, the bytes of `contents` are
+ /// transcoded from UTF-8 into the encoding of the destination and then
+ /// written.
+ ///
+ /// Precondition: check-write gave permit of Ok(n) and contents has a
+ /// length of less than or equal to n. Otherwise, this function will trap.
+ ///
+ /// returns Err(closed) without writing if the stream has closed since
+ /// the last call to check-write provided a permit.
+ @since(version = 0.2.0)
+ write: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 bytes, and then flush the stream. Block
+ /// until all of these operations are complete, or an error occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write`, and `flush`, and is implemented with the
+ /// following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while !contents.is_empty() {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, contents.len());
+ /// let (chunk, rest) = contents.split_at(len);
+ /// this.write(chunk ); // eliding error handling
+ /// contents = rest;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-and-flush: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Request to flush buffered output. This function never blocks.
+ ///
+ /// This tells the output-stream that the caller intends any buffered
+ /// output to be flushed. the output which is expected to be flushed
+ /// is all that has been passed to `write` prior to this call.
+ ///
+ /// Upon calling this function, the `output-stream` will not accept any
+ /// writes (`check-write` will return `ok(0)`) until the flush has
+ /// completed. The `subscribe` pollable will become ready when the
+ /// flush has completed and the stream can accept more writes.
+ @since(version = 0.2.0)
+ flush: func() -> result<_, stream-error>;
+ /// Request to flush buffered output, and block until flush completes
+ /// and stream is ready for writing again.
+ @since(version = 0.2.0)
+ blocking-flush: func() -> result<_, stream-error>;
+ /// Create a `pollable` which will resolve once the output-stream
+ /// is ready for more writing, or an error has occurred. When this
+ /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
+ /// error.
+ ///
+ /// If the stream is closed, this pollable is always ready immediately.
+ ///
+ /// The created `pollable` is a child resource of the `output-stream`.
+ /// Implementations may trap if the `output-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ /// Write zeroes to a stream.
+ ///
+ /// This should be used precisely like `write` with the exact same
+ /// preconditions (must use check-write first), but instead of
+ /// passing a list of bytes, you simply pass the number of zero-bytes
+ /// that should be written.
+ @since(version = 0.2.0)
+ write-zeroes: func(len: u64) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 zeroes, and then flush the stream.
+ /// Block until all of these operations are complete, or an error
+ /// occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
+ /// the following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while num_zeroes != 0 {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, num_zeroes);
+ /// this.write-zeroes(len); // eliding error handling
+ /// num_zeroes -= len;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-zeroes-and-flush: func(len: u64) -> result<_, stream-error>;
+ /// Read from one stream and write to another.
+ ///
+ /// The behavior of splice is equivalent to:
+ /// 1. calling `check-write` on the `output-stream`
+ /// 2. calling `read` on the `input-stream` with the smaller of the
+ /// `check-write` permitted length and the `len` provided to `splice`
+ /// 3. calling `write` on the `output-stream` with that read data.
+ ///
+ /// Any error reported by the call to `check-write`, `read`, or
+ /// `write` ends the splice and reports that error.
+ ///
+ /// This function returns the number of bytes transferred; it may be less
+ /// than `len`.
+ @since(version = 0.2.0)
+ splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ /// Read from one stream and write to another, with blocking.
+ ///
+ /// This is similar to `splice`, except that it blocks until the
+ /// `output-stream` is ready for writing, and the `input-stream`
+ /// is ready for reading, before performing the `splice`.
+ @since(version = 0.2.0)
+ blocking-splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ }
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import error;
+ @since(version = 0.2.0)
+ import poll;
+ @since(version = 0.2.0)
+ import streams;
+}
diff --git a/crates/wasi-tls/wit/deps/io/error.wit b/crates/wasi-tls/wit/deps/io/error.wit
deleted file mode 100644
index 784f74a53e..0000000000
--- a/crates/wasi-tls/wit/deps/io/error.wit
+++ /dev/null
@@ -1,34 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-interface error {
- /// A resource which represents some error information.
- ///
- /// The only method provided by this resource is `to-debug-string`,
- /// which provides some human-readable information about the error.
- ///
- /// In the `wasi:io` package, this resource is returned through the
- /// `wasi:io/streams/stream-error` type.
- ///
- /// To provide more specific error information, other interfaces may
- /// offer functions to "downcast" this error into more specific types. For example,
- /// errors returned from streams derived from filesystem types can be described using
- /// the filesystem's own error-code type. This is done using the function
- /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
- /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
- ///
- /// The set of functions which can "downcast" an `error` into a more
- /// concrete type is open.
- @since(version = 0.2.0)
- resource error {
- /// Returns a string that is suitable to assist humans in debugging
- /// this error.
- ///
- /// WARNING: The returned string should not be consumed mechanically!
- /// It may change across platforms, hosts, or other implementation
- /// details. Parsing this string is a major platform-compatibility
- /// hazard.
- @since(version = 0.2.0)
- to-debug-string: func() -> string;
- }
-}
diff --git a/crates/wasi-tls/wit/deps/io/poll.wit b/crates/wasi-tls/wit/deps/io/poll.wit
deleted file mode 100644
index 7f711836c3..0000000000
--- a/crates/wasi-tls/wit/deps/io/poll.wit
+++ /dev/null
@@ -1,47 +0,0 @@
-package wasi:[email protected];
-
-/// A poll API intended to let users wait for I/O events on multiple handles
-/// at once.
-@since(version = 0.2.0)
-interface poll {
- /// `pollable` represents a single I/O event which may be ready, or not.
- @since(version = 0.2.0)
- resource pollable {
-
- /// Return the readiness of a pollable. This function never blocks.
- ///
- /// Returns `true` when the pollable is ready, and `false` otherwise.
- @since(version = 0.2.0)
- ready: func() -> bool;
-
- /// `block` returns immediately if the pollable is ready, and otherwise
- /// blocks until ready.
- ///
- /// This function is equivalent to calling `poll.poll` on a list
- /// containing only this pollable.
- @since(version = 0.2.0)
- block: func();
- }
-
- /// Poll for completion on a set of pollables.
- ///
- /// This function takes a list of pollables, which identify I/O sources of
- /// interest, and waits until one or more of the events is ready for I/O.
- ///
- /// The result `list<u32>` contains one or more indices of handles in the
- /// argument list that is ready for I/O.
- ///
- /// This function traps if either:
- /// - the list is empty, or:
- /// - the list contains more elements than can be indexed with a `u32` value.
- ///
- /// A timeout can be implemented by adding a pollable from the
- /// wasi-clocks API to the list.
- ///
- /// This function does not return a `result`; polling in itself does not
- /// do any I/O so it doesn't fail. If any of the I/O sources identified by
- /// the pollables has an error, it is indicated by marking the source as
- /// being ready for I/O.
- @since(version = 0.2.0)
- poll: func(in: list<borrow<pollable>>) -> list<u32>;
-}
diff --git a/crates/wasi-tls/wit/deps/io/streams.wit b/crates/wasi-tls/wit/deps/io/streams.wit
deleted file mode 100644
index c5da38c862..0000000000
--- a/crates/wasi-tls/wit/deps/io/streams.wit
+++ /dev/null
@@ -1,290 +0,0 @@
-package wasi:[email protected];
-
-/// WASI I/O is an I/O abstraction API which is currently focused on providing
-/// stream types.
-///
-/// In the future, the component model is expected to add built-in stream types;
-/// when it does, they are expected to subsume this API.
-@since(version = 0.2.0)
-interface streams {
- @since(version = 0.2.0)
- use error.{error};
- @since(version = 0.2.0)
- use poll.{pollable};
-
- /// An error for input-stream and output-stream operations.
- @since(version = 0.2.0)
- variant stream-error {
- /// The last operation (a write or flush) failed before completion.
- ///
- /// More information is available in the `error` payload.
- ///
- /// After this, the stream will be closed. All future operations return
- /// `stream-error::closed`.
- last-operation-failed(error),
- /// The stream is closed: no more input will be accepted by the
- /// stream. A closed output-stream will return this error on all
- /// future operations.
- closed
- }
-
- /// An input bytestream.
- ///
- /// `input-stream`s are *non-blocking* to the extent practical on underlying
- /// platforms. I/O operations always return promptly; if fewer bytes are
- /// promptly available than requested, they return the number of bytes promptly
- /// available, which could even be zero. To wait for data to be available,
- /// use the `subscribe` function to obtain a `pollable` which can be polled
- /// for using `wasi:io/poll`.
- @since(version = 0.2.0)
- resource input-stream {
- /// Perform a non-blocking read from the stream.
- ///
- /// When the source of a `read` is binary data, the bytes from the source
- /// are returned verbatim. When the source of a `read` is known to the
- /// implementation to be text, bytes containing the UTF-8 encoding of the
- /// text are returned.
- ///
- /// This function returns a list of bytes containing the read data,
- /// when successful. The returned list will contain up to `len` bytes;
- /// it may return fewer than requested, but not more. The list is
- /// empty when no bytes are available for reading at this time. The
- /// pollable given by `subscribe` will be ready when more bytes are
- /// available.
- ///
- /// This function fails with a `stream-error` when the operation
- /// encounters an error, giving `last-operation-failed`, or when the
- /// stream is closed, giving `closed`.
- ///
- /// When the caller gives a `len` of 0, it represents a request to
- /// read 0 bytes. If the stream is still open, this call should
- /// succeed and return an empty list, or otherwise fail with `closed`.
- ///
- /// The `len` parameter is a `u64`, which could represent a list of u8 which
- /// is not possible to allocate in wasm32, or not desirable to allocate as
- /// as a return value by the callee. The callee may return a list of bytes
- /// less than `len` in size while more bytes are available for reading.
- @since(version = 0.2.0)
- read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Read bytes from a stream, after blocking until at least one byte can
- /// be read. Except for blocking, behavior is identical to `read`.
- @since(version = 0.2.0)
- blocking-read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Skip bytes from a stream. Returns number of bytes skipped.
- ///
- /// Behaves identical to `read`, except instead of returning a list
- /// of bytes, returns the number of bytes consumed from the stream.
- @since(version = 0.2.0)
- skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Skip bytes from a stream, after blocking until at least one byte
- /// can be skipped. Except for blocking behavior, identical to `skip`.
- @since(version = 0.2.0)
- blocking-skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Create a `pollable` which will resolve once either the specified stream
- /// has bytes available to read or the other end of the stream has been
- /// closed.
- /// The created `pollable` is a child resource of the `input-stream`.
- /// Implementations may trap if the `input-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
-
- /// An output bytestream.
- ///
- /// `output-stream`s are *non-blocking* to the extent practical on
- /// underlying platforms. Except where specified otherwise, I/O operations also
- /// always return promptly, after the number of bytes that can be written
- /// promptly, which could even be zero. To wait for the stream to be ready to
- /// accept data, the `subscribe` function to obtain a `pollable` which can be
- /// polled for using `wasi:io/poll`.
- ///
- /// Dropping an `output-stream` while there's still an active write in
- /// progress may result in the data being lost. Before dropping the stream,
- /// be sure to fully flush your writes.
- @since(version = 0.2.0)
- resource output-stream {
- /// Check readiness for writing. This function never blocks.
- ///
- /// Returns the number of bytes permitted for the next call to `write`,
- /// or an error. Calling `write` with more bytes than this function has
- /// permitted will trap.
- ///
- /// When this function returns 0 bytes, the `subscribe` pollable will
- /// become ready when this function will report at least 1 byte, or an
- /// error.
- @since(version = 0.2.0)
- check-write: func() -> result<u64, stream-error>;
-
- /// Perform a write. This function never blocks.
- ///
- /// When the destination of a `write` is binary data, the bytes from
- /// `contents` are written verbatim. When the destination of a `write` is
- /// known to the implementation to be text, the bytes of `contents` are
- /// transcoded from UTF-8 into the encoding of the destination and then
- /// written.
- ///
- /// Precondition: check-write gave permit of Ok(n) and contents has a
- /// length of less than or equal to n. Otherwise, this function will trap.
- ///
- /// returns Err(closed) without writing if the stream has closed since
- /// the last call to check-write provided a permit.
- @since(version = 0.2.0)
- write: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 bytes, and then flush the stream. Block
- /// until all of these operations are complete, or an error occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write`, and `flush`, and is implemented with the
- /// following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while !contents.is_empty() {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, contents.len());
- /// let (chunk, rest) = contents.split_at(len);
- /// this.write(chunk ); // eliding error handling
- /// contents = rest;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-and-flush: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Request to flush buffered output. This function never blocks.
- ///
- /// This tells the output-stream that the caller intends any buffered
- /// output to be flushed. the output which is expected to be flushed
- /// is all that has been passed to `write` prior to this call.
- ///
- /// Upon calling this function, the `output-stream` will not accept any
- /// writes (`check-write` will return `ok(0)`) until the flush has
- /// completed. The `subscribe` pollable will become ready when the
- /// flush has completed and the stream can accept more writes.
- @since(version = 0.2.0)
- flush: func() -> result<_, stream-error>;
-
- /// Request to flush buffered output, and block until flush completes
- /// and stream is ready for writing again.
- @since(version = 0.2.0)
- blocking-flush: func() -> result<_, stream-error>;
-
- /// Create a `pollable` which will resolve once the output-stream
- /// is ready for more writing, or an error has occurred. When this
- /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
- /// error.
- ///
- /// If the stream is closed, this pollable is always ready immediately.
- ///
- /// The created `pollable` is a child resource of the `output-stream`.
- /// Implementations may trap if the `output-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
-
- /// Write zeroes to a stream.
- ///
- /// This should be used precisely like `write` with the exact same
- /// preconditions (must use check-write first), but instead of
- /// passing a list of bytes, you simply pass the number of zero-bytes
- /// that should be written.
- @since(version = 0.2.0)
- write-zeroes: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 zeroes, and then flush the stream.
- /// Block until all of these operations are complete, or an error
- /// occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
- /// the following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while num_zeroes != 0 {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, num_zeroes);
- /// this.write-zeroes(len); // eliding error handling
- /// num_zeroes -= len;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-zeroes-and-flush: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Read from one stream and write to another.
- ///
- /// The behavior of splice is equivalent to:
- /// 1. calling `check-write` on the `output-stream`
- /// 2. calling `read` on the `input-stream` with the smaller of the
- /// `check-write` permitted length and the `len` provided to `splice`
- /// 3. calling `write` on the `output-stream` with that read data.
- ///
- /// Any error reported by the call to `check-write`, `read`, or
- /// `write` ends the splice and reports that error.
- ///
- /// This function returns the number of bytes transferred; it may be less
- /// than `len`.
- @since(version = 0.2.0)
- splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Read from one stream and write to another, with blocking.
- ///
- /// This is similar to `splice`, except that it blocks until the
- /// `output-stream` is ready for writing, and the `input-stream`
- /// is ready for reading, before performing the `splice`.
- @since(version = 0.2.0)
- blocking-splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
- }
-}
diff --git a/crates/wasi-tls/wit/deps/io/world.wit b/crates/wasi-tls/wit/deps/io/world.wit
deleted file mode 100644
index 84c85c08ed..0000000000
--- a/crates/wasi-tls/wit/deps/io/world.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import streams;
-
- @since(version = 0.2.0)
- import poll;
-}
diff --git a/crates/wasi/src/p2/wit/deps/cli.wit b/crates/wasi/src/p2/wit/deps/cli.wit
new file mode 100644
index 0000000000..d7a3ca4d2c
--- /dev/null
+++ b/crates/wasi/src/p2/wit/deps/cli.wit
@@ -0,0 +1,261 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface environment {
+ /// Get the POSIX-style environment variables.
+ ///
+ /// Each environment variable is provided as a pair of string variable names
+ /// and string value.
+ ///
+ /// Morally, these are a value import, but until value imports are available
+ /// in the component model, this import function should return the same
+ /// values each time it is called.
+ @since(version = 0.2.0)
+ get-environment: func() -> list<tuple<string, string>>;
+
+ /// Get the POSIX-style arguments to the program.
+ @since(version = 0.2.0)
+ get-arguments: func() -> list<string>;
+
+ /// Return a path that programs should use as their initial current working
+ /// directory, interpreting `.` as shorthand for this.
+ @since(version = 0.2.0)
+ initial-cwd: func() -> option<string>;
+}
+
+@since(version = 0.2.0)
+interface exit {
+ /// Exit the current instance and any linked instances.
+ @since(version = 0.2.0)
+ exit: func(status: result);
+
+ /// Exit the current instance and any linked instances, reporting the
+ /// specified status code to the host.
+ ///
+ /// The meaning of the code depends on the context, with 0 usually meaning
+ /// "success", and other values indicating various types of failure.
+ ///
+ /// This function does not return; the effect is analogous to a trap, but
+ /// without the connotation that something bad has happened.
+ @unstable(feature = cli-exit-with-code)
+ exit-with-code: func(status-code: u8);
+}
+
+@since(version = 0.2.0)
+interface run {
+ /// Run the program.
+ @since(version = 0.2.0)
+ run: func() -> result;
+}
+
+@since(version = 0.2.0)
+interface stdin {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{input-stream};
+
+ @since(version = 0.2.0)
+ get-stdin: func() -> input-stream;
+}
+
+@since(version = 0.2.0)
+interface stdout {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{output-stream};
+
+ @since(version = 0.2.0)
+ get-stdout: func() -> output-stream;
+}
+
+@since(version = 0.2.0)
+interface stderr {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{output-stream};
+
+ @since(version = 0.2.0)
+ get-stderr: func() -> output-stream;
+}
+
+/// Terminal input.
+///
+/// In the future, this may include functions for disabling echoing,
+/// disabling input buffering so that keyboard events are sent through
+/// immediately, querying supported features, and so on.
+@since(version = 0.2.0)
+interface terminal-input {
+ /// The input side of a terminal.
+ @since(version = 0.2.0)
+ resource terminal-input;
+}
+
+/// Terminal output.
+///
+/// In the future, this may include functions for querying the terminal
+/// size, being notified of terminal size changes, querying supported
+/// features, and so on.
+@since(version = 0.2.0)
+interface terminal-output {
+ /// The output side of a terminal.
+ @since(version = 0.2.0)
+ resource terminal-output;
+}
+
+/// An interface providing an optional `terminal-input` for stdin as a
+/// link-time authority.
+@since(version = 0.2.0)
+interface terminal-stdin {
+ @since(version = 0.2.0)
+ use terminal-input.{terminal-input};
+
+ /// If stdin is connected to a terminal, return a `terminal-input` handle
+ /// allowing further interaction with it.
+ @since(version = 0.2.0)
+ get-terminal-stdin: func() -> option<terminal-input>;
+}
+
+/// An interface providing an optional `terminal-output` for stdout as a
+/// link-time authority.
+@since(version = 0.2.0)
+interface terminal-stdout {
+ @since(version = 0.2.0)
+ use terminal-output.{terminal-output};
+
+ /// If stdout is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.2.0)
+ get-terminal-stdout: func() -> option<terminal-output>;
+}
+
+/// An interface providing an optional `terminal-output` for stderr as a
+/// link-time authority.
+@since(version = 0.2.0)
+interface terminal-stderr {
+ @since(version = 0.2.0)
+ use terminal-output.{terminal-output};
+
+ /// If stderr is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.2.0)
+ get-terminal-stderr: func() -> option<terminal-output>;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import environment;
+ @since(version = 0.2.0)
+ import exit;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import stdin;
+ @since(version = 0.2.0)
+ import stdout;
+ @since(version = 0.2.0)
+ import stderr;
+ @since(version = 0.2.0)
+ import terminal-input;
+ @since(version = 0.2.0)
+ import terminal-output;
+ @since(version = 0.2.0)
+ import terminal-stdin;
+ @since(version = 0.2.0)
+ import terminal-stdout;
+ @since(version = 0.2.0)
+ import terminal-stderr;
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+}
+@since(version = 0.2.0)
+world command {
+ @since(version = 0.2.0)
+ import environment;
+ @since(version = 0.2.0)
+ import exit;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import stdin;
+ @since(version = 0.2.0)
+ import stdout;
+ @since(version = 0.2.0)
+ import stderr;
+ @since(version = 0.2.0)
+ import terminal-input;
+ @since(version = 0.2.0)
+ import terminal-output;
+ @since(version = 0.2.0)
+ import terminal-stdin;
+ @since(version = 0.2.0)
+ import terminal-stdout;
+ @since(version = 0.2.0)
+ import terminal-stderr;
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:filesystem/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:sockets/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+ @since(version = 0.2.0)
+ import wasi:random/[email protected];
+
+ @since(version = 0.2.0)
+ export run;
+}
diff --git a/crates/wasi/src/p2/wit/deps/cli/command.wit b/crates/wasi/src/p2/wit/deps/cli/command.wit
deleted file mode 100644
index 6d3cc83f5f..0000000000
--- a/crates/wasi/src/p2/wit/deps/cli/command.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world command {
- @since(version = 0.2.0)
- include imports;
-
- @since(version = 0.2.0)
- export run;
-}
diff --git a/crates/wasi/src/p2/wit/deps/cli/environment.wit b/crates/wasi/src/p2/wit/deps/cli/environment.wit
deleted file mode 100644
index 2f449bd7c1..0000000000
--- a/crates/wasi/src/p2/wit/deps/cli/environment.wit
+++ /dev/null
@@ -1,22 +0,0 @@
-@since(version = 0.2.0)
-interface environment {
- /// Get the POSIX-style environment variables.
- ///
- /// Each environment variable is provided as a pair of string variable names
- /// and string value.
- ///
- /// Morally, these are a value import, but until value imports are available
- /// in the component model, this import function should return the same
- /// values each time it is called.
- @since(version = 0.2.0)
- get-environment: func() -> list<tuple<string, string>>;
-
- /// Get the POSIX-style arguments to the program.
- @since(version = 0.2.0)
- get-arguments: func() -> list<string>;
-
- /// Return a path that programs should use as their initial current working
- /// directory, interpreting `.` as shorthand for this.
- @since(version = 0.2.0)
- initial-cwd: func() -> option<string>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/cli/exit.wit b/crates/wasi/src/p2/wit/deps/cli/exit.wit
deleted file mode 100644
index 427935c8d0..0000000000
--- a/crates/wasi/src/p2/wit/deps/cli/exit.wit
+++ /dev/null
@@ -1,17 +0,0 @@
-@since(version = 0.2.0)
-interface exit {
- /// Exit the current instance and any linked instances.
- @since(version = 0.2.0)
- exit: func(status: result);
-
- /// Exit the current instance and any linked instances, reporting the
- /// specified status code to the host.
- ///
- /// The meaning of the code depends on the context, with 0 usually meaning
- /// "success", and other values indicating various types of failure.
- ///
- /// This function does not return; the effect is analogous to a trap, but
- /// without the connotation that something bad has happened.
- @unstable(feature = cli-exit-with-code)
- exit-with-code: func(status-code: u8);
-}
diff --git a/crates/wasi/src/p2/wit/deps/cli/imports.wit b/crates/wasi/src/p2/wit/deps/cli/imports.wit
deleted file mode 100644
index d9fd017109..0000000000
--- a/crates/wasi/src/p2/wit/deps/cli/imports.wit
+++ /dev/null
@@ -1,36 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- include wasi:clocks/[email protected];
- @since(version = 0.2.0)
- include wasi:filesystem/[email protected];
- @since(version = 0.2.0)
- include wasi:sockets/[email protected];
- @since(version = 0.2.0)
- include wasi:random/[email protected];
- @since(version = 0.2.0)
- include wasi:io/[email protected];
-
- @since(version = 0.2.0)
- import environment;
- @since(version = 0.2.0)
- import exit;
- @since(version = 0.2.0)
- import stdin;
- @since(version = 0.2.0)
- import stdout;
- @since(version = 0.2.0)
- import stderr;
- @since(version = 0.2.0)
- import terminal-input;
- @since(version = 0.2.0)
- import terminal-output;
- @since(version = 0.2.0)
- import terminal-stdin;
- @since(version = 0.2.0)
- import terminal-stdout;
- @since(version = 0.2.0)
- import terminal-stderr;
-}
diff --git a/crates/wasi/src/p2/wit/deps/cli/run.wit b/crates/wasi/src/p2/wit/deps/cli/run.wit
deleted file mode 100644
index 655346efb6..0000000000
--- a/crates/wasi/src/p2/wit/deps/cli/run.wit
+++ /dev/null
@@ -1,6 +0,0 @@
-@since(version = 0.2.0)
-interface run {
- /// Run the program.
- @since(version = 0.2.0)
- run: func() -> result;
-}
diff --git a/crates/wasi/src/p2/wit/deps/cli/stdio.wit b/crates/wasi/src/p2/wit/deps/cli/stdio.wit
deleted file mode 100644
index cb8aea2d90..0000000000
--- a/crates/wasi/src/p2/wit/deps/cli/stdio.wit
+++ /dev/null
@@ -1,26 +0,0 @@
-@since(version = 0.2.0)
-interface stdin {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{input-stream};
-
- @since(version = 0.2.0)
- get-stdin: func() -> input-stream;
-}
-
-@since(version = 0.2.0)
-interface stdout {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{output-stream};
-
- @since(version = 0.2.0)
- get-stdout: func() -> output-stream;
-}
-
-@since(version = 0.2.0)
-interface stderr {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{output-stream};
-
- @since(version = 0.2.0)
- get-stderr: func() -> output-stream;
-}
diff --git a/crates/wasi/src/p2/wit/deps/cli/terminal.wit b/crates/wasi/src/p2/wit/deps/cli/terminal.wit
deleted file mode 100644
index d305498c64..0000000000
--- a/crates/wasi/src/p2/wit/deps/cli/terminal.wit
+++ /dev/null
@@ -1,62 +0,0 @@
-/// Terminal input.
-///
-/// In the future, this may include functions for disabling echoing,
-/// disabling input buffering so that keyboard events are sent through
-/// immediately, querying supported features, and so on.
-@since(version = 0.2.0)
-interface terminal-input {
- /// The input side of a terminal.
- @since(version = 0.2.0)
- resource terminal-input;
-}
-
-/// Terminal output.
-///
-/// In the future, this may include functions for querying the terminal
-/// size, being notified of terminal size changes, querying supported
-/// features, and so on.
-@since(version = 0.2.0)
-interface terminal-output {
- /// The output side of a terminal.
- @since(version = 0.2.0)
- resource terminal-output;
-}
-
-/// An interface providing an optional `terminal-input` for stdin as a
-/// link-time authority.
-@since(version = 0.2.0)
-interface terminal-stdin {
- @since(version = 0.2.0)
- use terminal-input.{terminal-input};
-
- /// If stdin is connected to a terminal, return a `terminal-input` handle
- /// allowing further interaction with it.
- @since(version = 0.2.0)
- get-terminal-stdin: func() -> option<terminal-input>;
-}
-
-/// An interface providing an optional `terminal-output` for stdout as a
-/// link-time authority.
-@since(version = 0.2.0)
-interface terminal-stdout {
- @since(version = 0.2.0)
- use terminal-output.{terminal-output};
-
- /// If stdout is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.2.0)
- get-terminal-stdout: func() -> option<terminal-output>;
-}
-
-/// An interface providing an optional `terminal-output` for stderr as a
-/// link-time authority.
-@since(version = 0.2.0)
-interface terminal-stderr {
- @since(version = 0.2.0)
- use terminal-output.{terminal-output};
-
- /// If stderr is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.2.0)
- get-terminal-stderr: func() -> option<terminal-output>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/clocks.wit b/crates/wasi/src/p2/wit/deps/clocks.wit
new file mode 100644
index 0000000000..d638f1a40f
--- /dev/null
+++ b/crates/wasi/src/p2/wit/deps/clocks.wit
@@ -0,0 +1,157 @@
+package wasi:[email protected];
+
+/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
+/// time.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A monotonic clock is a clock which has an unspecified initial value, and
+/// successive reads of the clock will produce non-decreasing values.
+@since(version = 0.2.0)
+interface monotonic-clock {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+
+ /// An instant in time, in nanoseconds. An instant is relative to an
+ /// unspecified initial value, and can only be compared to instances from
+ /// the same monotonic-clock.
+ @since(version = 0.2.0)
+ type instant = u64;
+
+ /// A duration of time, in nanoseconds.
+ @since(version = 0.2.0)
+ type duration = u64;
+
+ /// Read the current value of the clock.
+ ///
+ /// The clock is monotonic, therefore calling this function repeatedly will
+ /// produce a sequence of non-decreasing values.
+ @since(version = 0.2.0)
+ now: func() -> instant;
+
+ /// Query the resolution of the clock. Returns the duration of time
+ /// corresponding to a clock tick.
+ @since(version = 0.2.0)
+ resolution: func() -> duration;
+
+ /// Create a `pollable` which will resolve once the specified instant
+ /// has occurred.
+ @since(version = 0.2.0)
+ subscribe-instant: func(when: instant) -> pollable;
+
+ /// Create a `pollable` that will resolve after the specified duration has
+ /// elapsed from the time this function is invoked.
+ @since(version = 0.2.0)
+ subscribe-duration: func(when: duration) -> pollable;
+}
+
+/// WASI Wall Clock is a clock API intended to let users query the current
+/// time. The name "wall" makes an analogy to a "clock on the wall", which
+/// is not necessarily monotonic as it may be reset.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A wall clock is a clock which measures the date and time according to
+/// some external reference.
+///
+/// External references may be reset, so this clock is not necessarily
+/// monotonic, making it unsuitable for measuring elapsed time.
+///
+/// It is intended for reporting the current date and time for humans.
+@since(version = 0.2.0)
+interface wall-clock {
+ /// A time and date in seconds plus nanoseconds.
+ @since(version = 0.2.0)
+ record datetime {
+ seconds: u64,
+ nanoseconds: u32,
+ }
+
+ /// Read the current value of the clock.
+ ///
+ /// This clock is not monotonic, therefore calling this function repeatedly
+ /// will not necessarily produce a sequence of non-decreasing values.
+ ///
+ /// The returned timestamps represent the number of seconds since
+ /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
+ /// also known as [Unix Time].
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ ///
+ /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
+ /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
+ @since(version = 0.2.0)
+ now: func() -> datetime;
+
+ /// Query the resolution of the clock.
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ @since(version = 0.2.0)
+ resolution: func() -> datetime;
+}
+
+@unstable(feature = clocks-timezone)
+interface timezone {
+ @unstable(feature = clocks-timezone)
+ use wall-clock.{datetime};
+
+ /// Information useful for displaying the timezone of a specific `datetime`.
+ ///
+ /// This information may vary within a single `timezone` to reflect daylight
+ /// saving time adjustments.
+ @unstable(feature = clocks-timezone)
+ record timezone-display {
+ /// The number of seconds difference between UTC time and the local
+ /// time of the timezone.
+ ///
+ /// The returned value will always be less than 86400 which is the
+ /// number of seconds in a day (24*60*60).
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return 0.
+ utc-offset: s32,
+ /// The abbreviated name of the timezone to display to a user. The name
+ /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
+ /// reference local standards for the name of the time zone.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should be the string `UTC`.
+ ///
+ /// In time zones that do not have an applicable name, a formatted
+ /// representation of the UTC offset may be returned, such as `-04:00`.
+ name: string,
+ /// Whether daylight saving time is active.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return false.
+ in-daylight-saving-time: bool,
+ }
+
+ /// Return information needed to display the given `datetime`. This includes
+ /// the UTC offset, the time zone name, and a flag indicating whether
+ /// daylight saving time is active.
+ ///
+ /// If the timezone cannot be determined for the given `datetime`, return a
+ /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
+ /// saving time.
+ @unstable(feature = clocks-timezone)
+ display: func(when: datetime) -> timezone-display;
+
+ /// The same as `display`, but only return the UTC offset.
+ @unstable(feature = clocks-timezone)
+ utc-offset: func(when: datetime) -> s32;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import monotonic-clock;
+ @since(version = 0.2.0)
+ import wall-clock;
+ @unstable(feature = clocks-timezone)
+ import timezone;
+}
diff --git a/crates/wasi/src/p2/wit/deps/clocks/monotonic-clock.wit b/crates/wasi/src/p2/wit/deps/clocks/monotonic-clock.wit
deleted file mode 100644
index f3bc839127..0000000000
--- a/crates/wasi/src/p2/wit/deps/clocks/monotonic-clock.wit
+++ /dev/null
@@ -1,50 +0,0 @@
-package wasi:[email protected];
-/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
-/// time.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A monotonic clock is a clock which has an unspecified initial value, and
-/// successive reads of the clock will produce non-decreasing values.
-@since(version = 0.2.0)
-interface monotonic-clock {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
-
- /// An instant in time, in nanoseconds. An instant is relative to an
- /// unspecified initial value, and can only be compared to instances from
- /// the same monotonic-clock.
- @since(version = 0.2.0)
- type instant = u64;
-
- /// A duration of time, in nanoseconds.
- @since(version = 0.2.0)
- type duration = u64;
-
- /// Read the current value of the clock.
- ///
- /// The clock is monotonic, therefore calling this function repeatedly will
- /// produce a sequence of non-decreasing values.
- @since(version = 0.2.0)
- now: func() -> instant;
-
- /// Query the resolution of the clock. Returns the duration of time
- /// corresponding to a clock tick.
- @since(version = 0.2.0)
- resolution: func() -> duration;
-
- /// Create a `pollable` which will resolve once the specified instant
- /// has occurred.
- @since(version = 0.2.0)
- subscribe-instant: func(
- when: instant,
- ) -> pollable;
-
- /// Create a `pollable` that will resolve after the specified duration has
- /// elapsed from the time this function is invoked.
- @since(version = 0.2.0)
- subscribe-duration: func(
- when: duration,
- ) -> pollable;
-}
diff --git a/crates/wasi/src/p2/wit/deps/clocks/timezone.wit b/crates/wasi/src/p2/wit/deps/clocks/timezone.wit
deleted file mode 100644
index ca98ad1528..0000000000
--- a/crates/wasi/src/p2/wit/deps/clocks/timezone.wit
+++ /dev/null
@@ -1,55 +0,0 @@
-package wasi:[email protected];
-
-@unstable(feature = clocks-timezone)
-interface timezone {
- @unstable(feature = clocks-timezone)
- use wall-clock.{datetime};
-
- /// Return information needed to display the given `datetime`. This includes
- /// the UTC offset, the time zone name, and a flag indicating whether
- /// daylight saving time is active.
- ///
- /// If the timezone cannot be determined for the given `datetime`, return a
- /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
- /// saving time.
- @unstable(feature = clocks-timezone)
- display: func(when: datetime) -> timezone-display;
-
- /// The same as `display`, but only return the UTC offset.
- @unstable(feature = clocks-timezone)
- utc-offset: func(when: datetime) -> s32;
-
- /// Information useful for displaying the timezone of a specific `datetime`.
- ///
- /// This information may vary within a single `timezone` to reflect daylight
- /// saving time adjustments.
- @unstable(feature = clocks-timezone)
- record timezone-display {
- /// The number of seconds difference between UTC time and the local
- /// time of the timezone.
- ///
- /// The returned value will always be less than 86400 which is the
- /// number of seconds in a day (24*60*60).
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return 0.
- utc-offset: s32,
-
- /// The abbreviated name of the timezone to display to a user. The name
- /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
- /// reference local standards for the name of the time zone.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should be the string `UTC`.
- ///
- /// In time zones that do not have an applicable name, a formatted
- /// representation of the UTC offset may be returned, such as `-04:00`.
- name: string,
-
- /// Whether daylight saving time is active.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return false.
- in-daylight-saving-time: bool,
- }
-}
diff --git a/crates/wasi/src/p2/wit/deps/clocks/wall-clock.wit b/crates/wasi/src/p2/wit/deps/clocks/wall-clock.wit
deleted file mode 100644
index 76636a0c9b..0000000000
--- a/crates/wasi/src/p2/wit/deps/clocks/wall-clock.wit
+++ /dev/null
@@ -1,46 +0,0 @@
-package wasi:[email protected];
-/// WASI Wall Clock is a clock API intended to let users query the current
-/// time. The name "wall" makes an analogy to a "clock on the wall", which
-/// is not necessarily monotonic as it may be reset.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A wall clock is a clock which measures the date and time according to
-/// some external reference.
-///
-/// External references may be reset, so this clock is not necessarily
-/// monotonic, making it unsuitable for measuring elapsed time.
-///
-/// It is intended for reporting the current date and time for humans.
-@since(version = 0.2.0)
-interface wall-clock {
- /// A time and date in seconds plus nanoseconds.
- @since(version = 0.2.0)
- record datetime {
- seconds: u64,
- nanoseconds: u32,
- }
-
- /// Read the current value of the clock.
- ///
- /// This clock is not monotonic, therefore calling this function repeatedly
- /// will not necessarily produce a sequence of non-decreasing values.
- ///
- /// The returned timestamps represent the number of seconds since
- /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
- /// also known as [Unix Time].
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- ///
- /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
- /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
- @since(version = 0.2.0)
- now: func() -> datetime;
-
- /// Query the resolution of the clock.
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- @since(version = 0.2.0)
- resolution: func() -> datetime;
-}
diff --git a/crates/wasi/src/p2/wit/deps/clocks/world.wit b/crates/wasi/src/p2/wit/deps/clocks/world.wit
deleted file mode 100644
index 5c53c51a15..0000000000
--- a/crates/wasi/src/p2/wit/deps/clocks/world.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import monotonic-clock;
- @since(version = 0.2.0)
- import wall-clock;
- @unstable(feature = clocks-timezone)
- import timezone;
-}
diff --git a/crates/wasi/src/p2/wit/deps/filesystem.wit b/crates/wasi/src/p2/wit/deps/filesystem.wit
new file mode 100644
index 0000000000..9f4a8288b4
--- /dev/null
+++ b/crates/wasi/src/p2/wit/deps/filesystem.wit
@@ -0,0 +1,587 @@
+package wasi:[email protected];
+
+/// WASI filesystem is a filesystem API primarily intended to let users run WASI
+/// programs that access their files on their existing filesystems, without
+/// significant overhead.
+///
+/// It is intended to be roughly portable between Unix-family platforms and
+/// Windows, though it does not hide many of the major differences.
+///
+/// Paths are passed as interface-type `string`s, meaning they must consist of
+/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
+/// paths which are not accessible by this API.
+///
+/// The directory separator in WASI is always the forward-slash (`/`).
+///
+/// All paths in WASI are relative paths, and are interpreted relative to a
+/// `descriptor` referring to a base directory. If a `path` argument to any WASI
+/// function starts with `/`, or if any step of resolving a `path`, including
+/// `..` and symbolic link steps, reaches a directory outside of the base
+/// directory, or reaches a symlink to an absolute or rooted path in the
+/// underlying filesystem, the function fails with `error-code::not-permitted`.
+///
+/// For more information about WASI path resolution and sandboxing, see
+/// [WASI filesystem path resolution].
+///
+/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
+@since(version = 0.2.0)
+interface types {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{input-stream, output-stream, error};
+ @since(version = 0.2.0)
+ use wasi:clocks/[email protected].{datetime};
+
+ /// File size or length of a region within a file.
+ @since(version = 0.2.0)
+ type filesize = u64;
+
+ /// The type of a filesystem object referenced by a descriptor.
+ ///
+ /// Note: This was called `filetype` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ enum descriptor-type {
+ /// The type of the descriptor or file is unknown or is different from
+ /// any of the other types specified.
+ unknown,
+ /// The descriptor refers to a block device inode.
+ block-device,
+ /// The descriptor refers to a character device inode.
+ character-device,
+ /// The descriptor refers to a directory inode.
+ directory,
+ /// The descriptor refers to a named pipe.
+ fifo,
+ /// The file refers to a symbolic link inode.
+ symbolic-link,
+ /// The descriptor refers to a regular file inode.
+ regular-file,
+ /// The descriptor refers to a socket.
+ socket,
+ }
+
+ /// Descriptor flags.
+ ///
+ /// Note: This was called `fdflags` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ flags descriptor-flags {
+ /// Read mode: Data can be read.
+ read,
+ /// Write mode: Data can be written to.
+ write,
+ /// Request that writes be performed according to synchronized I/O file
+ /// integrity completion. The data stored in the file and the file's
+ /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ file-integrity-sync,
+ /// Request that writes be performed according to synchronized I/O data
+ /// integrity completion. Only the data stored in the file is
+ /// synchronized. This is similar to `O_DSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ data-integrity-sync,
+ /// Requests that reads be performed at the same level of integrity
+ /// requested for writes. This is similar to `O_RSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ requested-write-sync,
+ /// Mutating directories mode: Directory contents may be mutated.
+ ///
+ /// When this flag is unset on a descriptor, operations using the
+ /// descriptor which would create, rename, delete, modify the data or
+ /// metadata of filesystem objects, or obtain another handle which
+ /// would permit any of those, shall fail with `error-code::read-only` if
+ /// they would otherwise succeed.
+ ///
+ /// This may only be set on directories.
+ mutate-directory,
+ }
+
+ /// Flags determining the method of how paths are resolved.
+ @since(version = 0.2.0)
+ flags path-flags {
+ /// As long as the resolved path corresponds to a symbolic link, it is
+ /// expanded.
+ symlink-follow,
+ }
+
+ /// Open flags used by `open-at`.
+ @since(version = 0.2.0)
+ flags open-flags {
+ /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
+ create,
+ /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
+ directory,
+ /// Fail if file already exists, similar to `O_EXCL` in POSIX.
+ exclusive,
+ /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
+ truncate,
+ }
+
+ /// Number of hard links to an inode.
+ @since(version = 0.2.0)
+ type link-count = u64;
+
+ /// File attributes.
+ ///
+ /// Note: This was called `filestat` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ record descriptor-stat {
+ /// File type.
+ %type: descriptor-type,
+ /// Number of hard links to the file.
+ link-count: link-count,
+ /// For regular files, the file size in bytes. For symbolic links, the
+ /// length in bytes of the pathname contained in the symbolic link.
+ size: filesize,
+ /// Last data access timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain an access
+ /// timestamp for this file.
+ data-access-timestamp: option<datetime>,
+ /// Last data modification timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// modification timestamp for this file.
+ data-modification-timestamp: option<datetime>,
+ /// Last file status-change timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// status-change timestamp for this file.
+ status-change-timestamp: option<datetime>,
+ }
+
+ /// When setting a timestamp, this gives the value to set it to.
+ @since(version = 0.2.0)
+ variant new-timestamp {
+ /// Leave the timestamp set to its previous value.
+ no-change,
+ /// Set the timestamp to the current time of the system clock associated
+ /// with the filesystem.
+ now,
+ /// Set the timestamp to the given value.
+ timestamp(datetime),
+ }
+
+ /// A directory entry.
+ record directory-entry {
+ /// The type of the file referred to by this directory entry.
+ %type: descriptor-type,
+ /// The name of the object.
+ name: string,
+ }
+
+ /// Error codes returned by functions, similar to `errno` in POSIX.
+ /// Not all of these error codes are returned by the functions provided by this
+ /// API; some are used in higher-level library layers, and others are provided
+ /// merely for alignment with POSIX.
+ enum error-code {
+ /// Permission denied, similar to `EACCES` in POSIX.
+ access,
+ /// Resource unavailable, or operation would block, similar to `EAGAIN` and `EWOULDBLOCK` in POSIX.
+ would-block,
+ /// Connection already in progress, similar to `EALREADY` in POSIX.
+ already,
+ /// Bad descriptor, similar to `EBADF` in POSIX.
+ bad-descriptor,
+ /// Device or resource busy, similar to `EBUSY` in POSIX.
+ busy,
+ /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
+ deadlock,
+ /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
+ quota,
+ /// File exists, similar to `EEXIST` in POSIX.
+ exist,
+ /// File too large, similar to `EFBIG` in POSIX.
+ file-too-large,
+ /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
+ illegal-byte-sequence,
+ /// Operation in progress, similar to `EINPROGRESS` in POSIX.
+ in-progress,
+ /// Interrupted function, similar to `EINTR` in POSIX.
+ interrupted,
+ /// Invalid argument, similar to `EINVAL` in POSIX.
+ invalid,
+ /// I/O error, similar to `EIO` in POSIX.
+ io,
+ /// Is a directory, similar to `EISDIR` in POSIX.
+ is-directory,
+ /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
+ loop,
+ /// Too many links, similar to `EMLINK` in POSIX.
+ too-many-links,
+ /// Message too large, similar to `EMSGSIZE` in POSIX.
+ message-size,
+ /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
+ name-too-long,
+ /// No such device, similar to `ENODEV` in POSIX.
+ no-device,
+ /// No such file or directory, similar to `ENOENT` in POSIX.
+ no-entry,
+ /// No locks available, similar to `ENOLCK` in POSIX.
+ no-lock,
+ /// Not enough space, similar to `ENOMEM` in POSIX.
+ insufficient-memory,
+ /// No space left on device, similar to `ENOSPC` in POSIX.
+ insufficient-space,
+ /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
+ not-directory,
+ /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
+ not-empty,
+ /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
+ not-recoverable,
+ /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
+ unsupported,
+ /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
+ no-tty,
+ /// No such device or address, similar to `ENXIO` in POSIX.
+ no-such-device,
+ /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
+ overflow,
+ /// Operation not permitted, similar to `EPERM` in POSIX.
+ not-permitted,
+ /// Broken pipe, similar to `EPIPE` in POSIX.
+ pipe,
+ /// Read-only file system, similar to `EROFS` in POSIX.
+ read-only,
+ /// Invalid seek, similar to `ESPIPE` in POSIX.
+ invalid-seek,
+ /// Text file busy, similar to `ETXTBSY` in POSIX.
+ text-file-busy,
+ /// Cross-device link, similar to `EXDEV` in POSIX.
+ cross-device,
+ }
+
+ /// File or memory access pattern advisory information.
+ @since(version = 0.2.0)
+ enum advice {
+ /// The application has no advice to give on its behavior with respect
+ /// to the specified data.
+ normal,
+ /// The application expects to access the specified data sequentially
+ /// from lower offsets to higher offsets.
+ sequential,
+ /// The application expects to access the specified data in a random
+ /// order.
+ random,
+ /// The application expects to access the specified data in the near
+ /// future.
+ will-need,
+ /// The application expects that it will not access the specified data
+ /// in the near future.
+ dont-need,
+ /// The application expects to access the specified data once and then
+ /// not reuse it thereafter.
+ no-reuse,
+ }
+
+ /// A 128-bit hash value, split into parts because wasm doesn't have a
+ /// 128-bit integer type.
+ @since(version = 0.2.0)
+ record metadata-hash-value {
+ /// 64 bits of a 128-bit hash value.
+ lower: u64,
+ /// Another 64 bits of a 128-bit hash value.
+ upper: u64,
+ }
+
+ /// A descriptor is a reference to a filesystem object, which may be a file,
+ /// directory, named pipe, special file, or other object on which filesystem
+ /// calls may be made.
+ @since(version = 0.2.0)
+ resource descriptor {
+ /// Return a stream for reading from a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be read.
+ ///
+ /// Multiple read, write, and append streams may be active on the same open
+ /// file and they do not interfere with each other.
+ ///
+ /// Note: This allows using `read-stream`, which is similar to `read` in POSIX.
+ @since(version = 0.2.0)
+ read-via-stream: func(offset: filesize) -> result<input-stream, error-code>;
+ /// Return a stream for writing to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be written.
+ ///
+ /// Note: This allows using `write-stream`, which is similar to `write` in
+ /// POSIX.
+ @since(version = 0.2.0)
+ write-via-stream: func(offset: filesize) -> result<output-stream, error-code>;
+ /// Return a stream for appending to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be appended.
+ ///
+ /// Note: This allows using `write-stream`, which is similar to `write` with
+ /// `O_APPEND` in POSIX.
+ @since(version = 0.2.0)
+ append-via-stream: func() -> result<output-stream, error-code>;
+ /// Provide file advisory information on a descriptor.
+ ///
+ /// This is similar to `posix_fadvise` in POSIX.
+ @since(version = 0.2.0)
+ advise: func(offset: filesize, length: filesize, advice: advice) -> result<_, error-code>;
+ /// Synchronize the data of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fdatasync` in POSIX.
+ @since(version = 0.2.0)
+ sync-data: func() -> result<_, error-code>;
+ /// Get flags associated with a descriptor.
+ ///
+ /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_flags` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ get-flags: func() -> result<descriptor-flags, error-code>;
+ /// Get the dynamic type of a descriptor.
+ ///
+ /// Note: This returns the same value as the `type` field of the `fd-stat`
+ /// returned by `stat`, `stat-at` and similar.
+ ///
+ /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
+ /// by `fstat` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_filetype` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ get-type: func() -> result<descriptor-type, error-code>;
+ /// Adjust the size of an open file. If this increases the file's size, the
+ /// extra bytes are filled with zeros.
+ ///
+ /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ set-size: func(size: filesize) -> result<_, error-code>;
+ /// Adjust the timestamps of an open file or directory.
+ ///
+ /// Note: This is similar to `futimens` in POSIX.
+ ///
+ /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ set-times: func(data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Read from a descriptor, without using and updating the descriptor's offset.
+ ///
+ /// This function returns a list of bytes containing the data that was
+ /// read, along with a bool which, when true, indicates that the end of the
+ /// file was reached. The returned list will contain up to `length` bytes; it
+ /// may return fewer than requested, if the end of the file is reached or
+ /// if the I/O operation is interrupted.
+ ///
+ /// In the future, this may change to return a `stream<u8, error-code>`.
+ ///
+ /// Note: This is similar to `pread` in POSIX.
+ @since(version = 0.2.0)
+ read: func(length: filesize, offset: filesize) -> result<tuple<list<u8>, bool>, error-code>;
+ /// Write to a descriptor, without using and updating the descriptor's offset.
+ ///
+ /// It is valid to write past the end of a file; the file is extended to the
+ /// extent of the write, with bytes between the previous end and the start of
+ /// the write set to zero.
+ ///
+ /// In the future, this may change to take a `stream<u8, error-code>`.
+ ///
+ /// Note: This is similar to `pwrite` in POSIX.
+ @since(version = 0.2.0)
+ write: func(buffer: list<u8>, offset: filesize) -> result<filesize, error-code>;
+ /// Read directory entries from a directory.
+ ///
+ /// On filesystems where directories contain entries referring to themselves
+ /// and their parents, often named `.` and `..` respectively, these entries
+ /// are omitted.
+ ///
+ /// This always returns a new stream which starts at the beginning of the
+ /// directory. Multiple streams may be active on the same directory, and they
+ /// do not interfere with each other.
+ @since(version = 0.2.0)
+ read-directory: func() -> result<directory-entry-stream, error-code>;
+ /// Synchronize the data and metadata of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fsync` in POSIX.
+ @since(version = 0.2.0)
+ sync: func() -> result<_, error-code>;
+ /// Create a directory.
+ ///
+ /// Note: This is similar to `mkdirat` in POSIX.
+ @since(version = 0.2.0)
+ create-directory-at: func(path: string) -> result<_, error-code>;
+ /// Return the attributes of an open file or directory.
+ ///
+ /// Note: This is similar to `fstat` in POSIX, except that it does not return
+ /// device and inode information. For testing whether two descriptors refer to
+ /// the same underlying filesystem object, use `is-same-object`. To obtain
+ /// additional data that can be used do determine whether a file has been
+ /// modified, use `metadata-hash`.
+ ///
+ /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ stat: func() -> result<descriptor-stat, error-code>;
+ /// Return the attributes of a file or directory.
+ ///
+ /// Note: This is similar to `fstatat` in POSIX, except that it does not
+ /// return device and inode information. See the `stat` description for a
+ /// discussion of alternatives.
+ ///
+ /// Note: This was called `path_filestat_get` in earlier versions of WASI.
+ @since(version = 0.2.0)
+ stat-at: func(path-flags: path-flags, path: string) -> result<descriptor-stat, error-code>;
+ /// Adjust the timestamps of a file or directory.
+ ///
+ /// Note: This is similar to `utimensat` in POSIX.
+ ///
+ /// Note: This was called `path_filestat_set_times` in earlier versions of
+ /// WASI.
+ @since(version = 0.2.0)
+ set-times-at: func(path-flags: path-flags, path: string, data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Create a hard link.
+ ///
+ /// Fails with `error-code::no-entry` if the old path does not exist,
+ /// with `error-code::exist` if the new path already exists, and
+ /// `error-code::not-permitted` if the old path is not a file.
+ ///
+ /// Note: This is similar to `linkat` in POSIX.
+ @since(version = 0.2.0)
+ link-at: func(old-path-flags: path-flags, old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Open a file or directory.
+ ///
+ /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
+ /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
+ /// `open-at` fails with `error-code::read-only`.
+ ///
+ /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
+ /// contains `truncate` or `create`, and the base descriptor doesn't have
+ /// `descriptor-flags::mutate-directory` set, `open-at` fails with
+ /// `error-code::read-only`.
+ ///
+ /// Note: This is similar to `openat` in POSIX.
+ @since(version = 0.2.0)
+ open-at: func(path-flags: path-flags, path: string, open-flags: open-flags, %flags: descriptor-flags) -> result<descriptor, error-code>;
+ /// Read the contents of a symbolic link.
+ ///
+ /// If the contents contain an absolute or rooted path in the underlying
+ /// filesystem, this function fails with `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `readlinkat` in POSIX.
+ @since(version = 0.2.0)
+ readlink-at: func(path: string) -> result<string, error-code>;
+ /// Remove a directory.
+ ///
+ /// Return `error-code::not-empty` if the directory is not empty.
+ ///
+ /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
+ @since(version = 0.2.0)
+ remove-directory-at: func(path: string) -> result<_, error-code>;
+ /// Rename a filesystem object.
+ ///
+ /// Note: This is similar to `renameat` in POSIX.
+ @since(version = 0.2.0)
+ rename-at: func(old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Create a symbolic link (also known as a "symlink").
+ ///
+ /// If `old-path` starts with `/`, the function fails with
+ /// `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `symlinkat` in POSIX.
+ @since(version = 0.2.0)
+ symlink-at: func(old-path: string, new-path: string) -> result<_, error-code>;
+ /// Unlink a filesystem object that is not a directory.
+ ///
+ /// Return `error-code::is-directory` if the path refers to a directory.
+ /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
+ @since(version = 0.2.0)
+ unlink-file-at: func(path: string) -> result<_, error-code>;
+ /// Test whether two descriptors refer to the same filesystem object.
+ ///
+ /// In POSIX, this corresponds to testing whether the two descriptors have the
+ /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
+ /// wasi-filesystem does not expose device and inode numbers, so this function
+ /// may be used instead.
+ @since(version = 0.2.0)
+ is-same-object: func(other: borrow<descriptor>) -> bool;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a descriptor.
+ ///
+ /// This returns a hash of the last-modification timestamp and file size, and
+ /// may also include the inode number, device number, birth timestamp, and
+ /// other metadata fields that may change when the file is modified or
+ /// replaced. It may also include a secret value chosen by the
+ /// implementation and not otherwise exposed.
+ ///
+ /// Implementations are encouraged to provide the following properties:
+ ///
+ /// - If the file is not modified or replaced, the computed hash value should
+ /// usually not change.
+ /// - If the object is modified or replaced, the computed hash value should
+ /// usually change.
+ /// - The inputs to the hash should not be easily computable from the
+ /// computed hash.
+ ///
+ /// However, none of these is required.
+ @since(version = 0.2.0)
+ metadata-hash: func() -> result<metadata-hash-value, error-code>;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a directory descriptor and a relative path.
+ ///
+ /// This performs the same hash computation as `metadata-hash`.
+ @since(version = 0.2.0)
+ metadata-hash-at: func(path-flags: path-flags, path: string) -> result<metadata-hash-value, error-code>;
+ }
+
+ /// A stream of directory entries.
+ @since(version = 0.2.0)
+ resource directory-entry-stream {
+ /// Read a single directory entry from a `directory-entry-stream`.
+ @since(version = 0.2.0)
+ read-directory-entry: func() -> result<option<directory-entry>, error-code>;
+ }
+
+ /// Attempts to extract a filesystem-related `error-code` from the stream
+ /// `error` provided.
+ ///
+ /// Stream operations which return `stream-error::last-operation-failed`
+ /// have a payload with more information about the operation that failed.
+ /// This payload can be passed through to this function to see if there's
+ /// filesystem-related information about the error to return.
+ ///
+ /// Note that this function is fallible because not all stream-related
+ /// errors are filesystem-related errors.
+ @since(version = 0.2.0)
+ filesystem-error-code: func(err: borrow<error>) -> option<error-code>;
+}
+
+@since(version = 0.2.0)
+interface preopens {
+ @since(version = 0.2.0)
+ use types.{descriptor};
+
+ /// Return the set of preopened directories, and their paths.
+ @since(version = 0.2.0)
+ get-directories: func() -> list<tuple<descriptor, string>>;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import types;
+ @since(version = 0.2.0)
+ import preopens;
+}
diff --git a/crates/wasi/src/p2/wit/deps/filesystem/preopens.wit b/crates/wasi/src/p2/wit/deps/filesystem/preopens.wit
deleted file mode 100644
index f228479403..0000000000
--- a/crates/wasi/src/p2/wit/deps/filesystem/preopens.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-interface preopens {
- @since(version = 0.2.0)
- use types.{descriptor};
-
- /// Return the set of preopened directories, and their paths.
- @since(version = 0.2.0)
- get-directories: func() -> list<tuple<descriptor, string>>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/filesystem/types.wit b/crates/wasi/src/p2/wit/deps/filesystem/types.wit
deleted file mode 100644
index 75c19044c7..0000000000
--- a/crates/wasi/src/p2/wit/deps/filesystem/types.wit
+++ /dev/null
@@ -1,676 +0,0 @@
-package wasi:[email protected];
-/// WASI filesystem is a filesystem API primarily intended to let users run WASI
-/// programs that access their files on their existing filesystems, without
-/// significant overhead.
-///
-/// It is intended to be roughly portable between Unix-family platforms and
-/// Windows, though it does not hide many of the major differences.
-///
-/// Paths are passed as interface-type `string`s, meaning they must consist of
-/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
-/// paths which are not accessible by this API.
-///
-/// The directory separator in WASI is always the forward-slash (`/`).
-///
-/// All paths in WASI are relative paths, and are interpreted relative to a
-/// `descriptor` referring to a base directory. If a `path` argument to any WASI
-/// function starts with `/`, or if any step of resolving a `path`, including
-/// `..` and symbolic link steps, reaches a directory outside of the base
-/// directory, or reaches a symlink to an absolute or rooted path in the
-/// underlying filesystem, the function fails with `error-code::not-permitted`.
-///
-/// For more information about WASI path resolution and sandboxing, see
-/// [WASI filesystem path resolution].
-///
-/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
-@since(version = 0.2.0)
-interface types {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{input-stream, output-stream, error};
- @since(version = 0.2.0)
- use wasi:clocks/[email protected].{datetime};
-
- /// File size or length of a region within a file.
- @since(version = 0.2.0)
- type filesize = u64;
-
- /// The type of a filesystem object referenced by a descriptor.
- ///
- /// Note: This was called `filetype` in earlier versions of WASI.
- @since(version = 0.2.0)
- enum descriptor-type {
- /// The type of the descriptor or file is unknown or is different from
- /// any of the other types specified.
- unknown,
- /// The descriptor refers to a block device inode.
- block-device,
- /// The descriptor refers to a character device inode.
- character-device,
- /// The descriptor refers to a directory inode.
- directory,
- /// The descriptor refers to a named pipe.
- fifo,
- /// The file refers to a symbolic link inode.
- symbolic-link,
- /// The descriptor refers to a regular file inode.
- regular-file,
- /// The descriptor refers to a socket.
- socket,
- }
-
- /// Descriptor flags.
- ///
- /// Note: This was called `fdflags` in earlier versions of WASI.
- @since(version = 0.2.0)
- flags descriptor-flags {
- /// Read mode: Data can be read.
- read,
- /// Write mode: Data can be written to.
- write,
- /// Request that writes be performed according to synchronized I/O file
- /// integrity completion. The data stored in the file and the file's
- /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- file-integrity-sync,
- /// Request that writes be performed according to synchronized I/O data
- /// integrity completion. Only the data stored in the file is
- /// synchronized. This is similar to `O_DSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- data-integrity-sync,
- /// Requests that reads be performed at the same level of integrity
- /// requested for writes. This is similar to `O_RSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- requested-write-sync,
- /// Mutating directories mode: Directory contents may be mutated.
- ///
- /// When this flag is unset on a descriptor, operations using the
- /// descriptor which would create, rename, delete, modify the data or
- /// metadata of filesystem objects, or obtain another handle which
- /// would permit any of those, shall fail with `error-code::read-only` if
- /// they would otherwise succeed.
- ///
- /// This may only be set on directories.
- mutate-directory,
- }
-
- /// File attributes.
- ///
- /// Note: This was called `filestat` in earlier versions of WASI.
- @since(version = 0.2.0)
- record descriptor-stat {
- /// File type.
- %type: descriptor-type,
- /// Number of hard links to the file.
- link-count: link-count,
- /// For regular files, the file size in bytes. For symbolic links, the
- /// length in bytes of the pathname contained in the symbolic link.
- size: filesize,
- /// Last data access timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain an access
- /// timestamp for this file.
- data-access-timestamp: option<datetime>,
- /// Last data modification timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// modification timestamp for this file.
- data-modification-timestamp: option<datetime>,
- /// Last file status-change timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// status-change timestamp for this file.
- status-change-timestamp: option<datetime>,
- }
-
- /// Flags determining the method of how paths are resolved.
- @since(version = 0.2.0)
- flags path-flags {
- /// As long as the resolved path corresponds to a symbolic link, it is
- /// expanded.
- symlink-follow,
- }
-
- /// Open flags used by `open-at`.
- @since(version = 0.2.0)
- flags open-flags {
- /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
- create,
- /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
- directory,
- /// Fail if file already exists, similar to `O_EXCL` in POSIX.
- exclusive,
- /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
- truncate,
- }
-
- /// Number of hard links to an inode.
- @since(version = 0.2.0)
- type link-count = u64;
-
- /// When setting a timestamp, this gives the value to set it to.
- @since(version = 0.2.0)
- variant new-timestamp {
- /// Leave the timestamp set to its previous value.
- no-change,
- /// Set the timestamp to the current time of the system clock associated
- /// with the filesystem.
- now,
- /// Set the timestamp to the given value.
- timestamp(datetime),
- }
-
- /// A directory entry.
- record directory-entry {
- /// The type of the file referred to by this directory entry.
- %type: descriptor-type,
-
- /// The name of the object.
- name: string,
- }
-
- /// Error codes returned by functions, similar to `errno` in POSIX.
- /// Not all of these error codes are returned by the functions provided by this
- /// API; some are used in higher-level library layers, and others are provided
- /// merely for alignment with POSIX.
- enum error-code {
- /// Permission denied, similar to `EACCES` in POSIX.
- access,
- /// Resource unavailable, or operation would block, similar to `EAGAIN` and `EWOULDBLOCK` in POSIX.
- would-block,
- /// Connection already in progress, similar to `EALREADY` in POSIX.
- already,
- /// Bad descriptor, similar to `EBADF` in POSIX.
- bad-descriptor,
- /// Device or resource busy, similar to `EBUSY` in POSIX.
- busy,
- /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
- deadlock,
- /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
- quota,
- /// File exists, similar to `EEXIST` in POSIX.
- exist,
- /// File too large, similar to `EFBIG` in POSIX.
- file-too-large,
- /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
- illegal-byte-sequence,
- /// Operation in progress, similar to `EINPROGRESS` in POSIX.
- in-progress,
- /// Interrupted function, similar to `EINTR` in POSIX.
- interrupted,
- /// Invalid argument, similar to `EINVAL` in POSIX.
- invalid,
- /// I/O error, similar to `EIO` in POSIX.
- io,
- /// Is a directory, similar to `EISDIR` in POSIX.
- is-directory,
- /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
- loop,
- /// Too many links, similar to `EMLINK` in POSIX.
- too-many-links,
- /// Message too large, similar to `EMSGSIZE` in POSIX.
- message-size,
- /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
- name-too-long,
- /// No such device, similar to `ENODEV` in POSIX.
- no-device,
- /// No such file or directory, similar to `ENOENT` in POSIX.
- no-entry,
- /// No locks available, similar to `ENOLCK` in POSIX.
- no-lock,
- /// Not enough space, similar to `ENOMEM` in POSIX.
- insufficient-memory,
- /// No space left on device, similar to `ENOSPC` in POSIX.
- insufficient-space,
- /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
- not-directory,
- /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
- not-empty,
- /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
- not-recoverable,
- /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
- unsupported,
- /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
- no-tty,
- /// No such device or address, similar to `ENXIO` in POSIX.
- no-such-device,
- /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
- overflow,
- /// Operation not permitted, similar to `EPERM` in POSIX.
- not-permitted,
- /// Broken pipe, similar to `EPIPE` in POSIX.
- pipe,
- /// Read-only file system, similar to `EROFS` in POSIX.
- read-only,
- /// Invalid seek, similar to `ESPIPE` in POSIX.
- invalid-seek,
- /// Text file busy, similar to `ETXTBSY` in POSIX.
- text-file-busy,
- /// Cross-device link, similar to `EXDEV` in POSIX.
- cross-device,
- }
-
- /// File or memory access pattern advisory information.
- @since(version = 0.2.0)
- enum advice {
- /// The application has no advice to give on its behavior with respect
- /// to the specified data.
- normal,
- /// The application expects to access the specified data sequentially
- /// from lower offsets to higher offsets.
- sequential,
- /// The application expects to access the specified data in a random
- /// order.
- random,
- /// The application expects to access the specified data in the near
- /// future.
- will-need,
- /// The application expects that it will not access the specified data
- /// in the near future.
- dont-need,
- /// The application expects to access the specified data once and then
- /// not reuse it thereafter.
- no-reuse,
- }
-
- /// A 128-bit hash value, split into parts because wasm doesn't have a
- /// 128-bit integer type.
- @since(version = 0.2.0)
- record metadata-hash-value {
- /// 64 bits of a 128-bit hash value.
- lower: u64,
- /// Another 64 bits of a 128-bit hash value.
- upper: u64,
- }
-
- /// A descriptor is a reference to a filesystem object, which may be a file,
- /// directory, named pipe, special file, or other object on which filesystem
- /// calls may be made.
- @since(version = 0.2.0)
- resource descriptor {
- /// Return a stream for reading from a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be read.
- ///
- /// Multiple read, write, and append streams may be active on the same open
- /// file and they do not interfere with each other.
- ///
- /// Note: This allows using `read-stream`, which is similar to `read` in POSIX.
- @since(version = 0.2.0)
- read-via-stream: func(
- /// The offset within the file at which to start reading.
- offset: filesize,
- ) -> result<input-stream, error-code>;
-
- /// Return a stream for writing to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be written.
- ///
- /// Note: This allows using `write-stream`, which is similar to `write` in
- /// POSIX.
- @since(version = 0.2.0)
- write-via-stream: func(
- /// The offset within the file at which to start writing.
- offset: filesize,
- ) -> result<output-stream, error-code>;
-
- /// Return a stream for appending to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be appended.
- ///
- /// Note: This allows using `write-stream`, which is similar to `write` with
- /// `O_APPEND` in POSIX.
- @since(version = 0.2.0)
- append-via-stream: func() -> result<output-stream, error-code>;
-
- /// Provide file advisory information on a descriptor.
- ///
- /// This is similar to `posix_fadvise` in POSIX.
- @since(version = 0.2.0)
- advise: func(
- /// The offset within the file to which the advisory applies.
- offset: filesize,
- /// The length of the region to which the advisory applies.
- length: filesize,
- /// The advice.
- advice: advice
- ) -> result<_, error-code>;
-
- /// Synchronize the data of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fdatasync` in POSIX.
- @since(version = 0.2.0)
- sync-data: func() -> result<_, error-code>;
-
- /// Get flags associated with a descriptor.
- ///
- /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_flags` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- get-flags: func() -> result<descriptor-flags, error-code>;
-
- /// Get the dynamic type of a descriptor.
- ///
- /// Note: This returns the same value as the `type` field of the `fd-stat`
- /// returned by `stat`, `stat-at` and similar.
- ///
- /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
- /// by `fstat` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_filetype` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- get-type: func() -> result<descriptor-type, error-code>;
-
- /// Adjust the size of an open file. If this increases the file's size, the
- /// extra bytes are filled with zeros.
- ///
- /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
- @since(version = 0.2.0)
- set-size: func(size: filesize) -> result<_, error-code>;
-
- /// Adjust the timestamps of an open file or directory.
- ///
- /// Note: This is similar to `futimens` in POSIX.
- ///
- /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
- @since(version = 0.2.0)
- set-times: func(
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Read from a descriptor, without using and updating the descriptor's offset.
- ///
- /// This function returns a list of bytes containing the data that was
- /// read, along with a bool which, when true, indicates that the end of the
- /// file was reached. The returned list will contain up to `length` bytes; it
- /// may return fewer than requested, if the end of the file is reached or
- /// if the I/O operation is interrupted.
- ///
- /// In the future, this may change to return a `stream<u8, error-code>`.
- ///
- /// Note: This is similar to `pread` in POSIX.
- @since(version = 0.2.0)
- read: func(
- /// The maximum number of bytes to read.
- length: filesize,
- /// The offset within the file at which to read.
- offset: filesize,
- ) -> result<tuple<list<u8>, bool>, error-code>;
-
- /// Write to a descriptor, without using and updating the descriptor's offset.
- ///
- /// It is valid to write past the end of a file; the file is extended to the
- /// extent of the write, with bytes between the previous end and the start of
- /// the write set to zero.
- ///
- /// In the future, this may change to take a `stream<u8, error-code>`.
- ///
- /// Note: This is similar to `pwrite` in POSIX.
- @since(version = 0.2.0)
- write: func(
- /// Data to write
- buffer: list<u8>,
- /// The offset within the file at which to write.
- offset: filesize,
- ) -> result<filesize, error-code>;
-
- /// Read directory entries from a directory.
- ///
- /// On filesystems where directories contain entries referring to themselves
- /// and their parents, often named `.` and `..` respectively, these entries
- /// are omitted.
- ///
- /// This always returns a new stream which starts at the beginning of the
- /// directory. Multiple streams may be active on the same directory, and they
- /// do not interfere with each other.
- @since(version = 0.2.0)
- read-directory: func() -> result<directory-entry-stream, error-code>;
-
- /// Synchronize the data and metadata of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fsync` in POSIX.
- @since(version = 0.2.0)
- sync: func() -> result<_, error-code>;
-
- /// Create a directory.
- ///
- /// Note: This is similar to `mkdirat` in POSIX.
- @since(version = 0.2.0)
- create-directory-at: func(
- /// The relative path at which to create the directory.
- path: string,
- ) -> result<_, error-code>;
-
- /// Return the attributes of an open file or directory.
- ///
- /// Note: This is similar to `fstat` in POSIX, except that it does not return
- /// device and inode information. For testing whether two descriptors refer to
- /// the same underlying filesystem object, use `is-same-object`. To obtain
- /// additional data that can be used do determine whether a file has been
- /// modified, use `metadata-hash`.
- ///
- /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- stat: func() -> result<descriptor-stat, error-code>;
-
- /// Return the attributes of a file or directory.
- ///
- /// Note: This is similar to `fstatat` in POSIX, except that it does not
- /// return device and inode information. See the `stat` description for a
- /// discussion of alternatives.
- ///
- /// Note: This was called `path_filestat_get` in earlier versions of WASI.
- @since(version = 0.2.0)
- stat-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<descriptor-stat, error-code>;
-
- /// Adjust the timestamps of a file or directory.
- ///
- /// Note: This is similar to `utimensat` in POSIX.
- ///
- /// Note: This was called `path_filestat_set_times` in earlier versions of
- /// WASI.
- @since(version = 0.2.0)
- set-times-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to operate on.
- path: string,
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Create a hard link.
- ///
- /// Fails with `error-code::no-entry` if the old path does not exist,
- /// with `error-code::exist` if the new path already exists, and
- /// `error-code::not-permitted` if the old path is not a file.
- ///
- /// Note: This is similar to `linkat` in POSIX.
- @since(version = 0.2.0)
- link-at: func(
- /// Flags determining the method of how the path is resolved.
- old-path-flags: path-flags,
- /// The relative source path from which to link.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path at which to create the hard link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Open a file or directory.
- ///
- /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
- /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
- /// `open-at` fails with `error-code::read-only`.
- ///
- /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
- /// contains `truncate` or `create`, and the base descriptor doesn't have
- /// `descriptor-flags::mutate-directory` set, `open-at` fails with
- /// `error-code::read-only`.
- ///
- /// Note: This is similar to `openat` in POSIX.
- @since(version = 0.2.0)
- open-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the object to open.
- path: string,
- /// The method by which to open the file.
- open-flags: open-flags,
- /// Flags to use for the resulting descriptor.
- %flags: descriptor-flags,
- ) -> result<descriptor, error-code>;
-
- /// Read the contents of a symbolic link.
- ///
- /// If the contents contain an absolute or rooted path in the underlying
- /// filesystem, this function fails with `error-code::not-permitted`.
- ///
- /// Note: This is similar to `readlinkat` in POSIX.
- @since(version = 0.2.0)
- readlink-at: func(
- /// The relative path of the symbolic link from which to read.
- path: string,
- ) -> result<string, error-code>;
-
- /// Remove a directory.
- ///
- /// Return `error-code::not-empty` if the directory is not empty.
- ///
- /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
- @since(version = 0.2.0)
- remove-directory-at: func(
- /// The relative path to a directory to remove.
- path: string,
- ) -> result<_, error-code>;
-
- /// Rename a filesystem object.
- ///
- /// Note: This is similar to `renameat` in POSIX.
- @since(version = 0.2.0)
- rename-at: func(
- /// The relative source path of the file or directory to rename.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path to which to rename the file or directory.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Create a symbolic link (also known as a "symlink").
- ///
- /// If `old-path` starts with `/`, the function fails with
- /// `error-code::not-permitted`.
- ///
- /// Note: This is similar to `symlinkat` in POSIX.
- @since(version = 0.2.0)
- symlink-at: func(
- /// The contents of the symbolic link.
- old-path: string,
- /// The relative destination path at which to create the symbolic link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Unlink a filesystem object that is not a directory.
- ///
- /// Return `error-code::is-directory` if the path refers to a directory.
- /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
- @since(version = 0.2.0)
- unlink-file-at: func(
- /// The relative path to a file to unlink.
- path: string,
- ) -> result<_, error-code>;
-
- /// Test whether two descriptors refer to the same filesystem object.
- ///
- /// In POSIX, this corresponds to testing whether the two descriptors have the
- /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
- /// wasi-filesystem does not expose device and inode numbers, so this function
- /// may be used instead.
- @since(version = 0.2.0)
- is-same-object: func(other: borrow<descriptor>) -> bool;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a descriptor.
- ///
- /// This returns a hash of the last-modification timestamp and file size, and
- /// may also include the inode number, device number, birth timestamp, and
- /// other metadata fields that may change when the file is modified or
- /// replaced. It may also include a secret value chosen by the
- /// implementation and not otherwise exposed.
- ///
- /// Implementations are encouraged to provide the following properties:
- ///
- /// - If the file is not modified or replaced, the computed hash value should
- /// usually not change.
- /// - If the object is modified or replaced, the computed hash value should
- /// usually change.
- /// - The inputs to the hash should not be easily computable from the
- /// computed hash.
- ///
- /// However, none of these is required.
- @since(version = 0.2.0)
- metadata-hash: func() -> result<metadata-hash-value, error-code>;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a directory descriptor and a relative path.
- ///
- /// This performs the same hash computation as `metadata-hash`.
- @since(version = 0.2.0)
- metadata-hash-at: func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<metadata-hash-value, error-code>;
- }
-
- /// A stream of directory entries.
- @since(version = 0.2.0)
- resource directory-entry-stream {
- /// Read a single directory entry from a `directory-entry-stream`.
- @since(version = 0.2.0)
- read-directory-entry: func() -> result<option<directory-entry>, error-code>;
- }
-
- /// Attempts to extract a filesystem-related `error-code` from the stream
- /// `error` provided.
- ///
- /// Stream operations which return `stream-error::last-operation-failed`
- /// have a payload with more information about the operation that failed.
- /// This payload can be passed through to this function to see if there's
- /// filesystem-related information about the error to return.
- ///
- /// Note that this function is fallible because not all stream-related
- /// errors are filesystem-related errors.
- @since(version = 0.2.0)
- filesystem-error-code: func(err: borrow<error>) -> option<error-code>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/filesystem/world.wit b/crates/wasi/src/p2/wit/deps/filesystem/world.wit
deleted file mode 100644
index 65597f9f29..0000000000
--- a/crates/wasi/src/p2/wit/deps/filesystem/world.wit
+++ /dev/null
@@ -1,9 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import types;
- @since(version = 0.2.0)
- import preopens;
-}
diff --git a/crates/wasi/src/p2/wit/deps/io.wit b/crates/wasi/src/p2/wit/deps/io.wit
new file mode 100644
index 0000000000..08ad78e6b7
--- /dev/null
+++ b/crates/wasi/src/p2/wit/deps/io.wit
@@ -0,0 +1,331 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface error {
+ /// A resource which represents some error information.
+ ///
+ /// The only method provided by this resource is `to-debug-string`,
+ /// which provides some human-readable information about the error.
+ ///
+ /// In the `wasi:io` package, this resource is returned through the
+ /// `wasi:io/streams/stream-error` type.
+ ///
+ /// To provide more specific error information, other interfaces may
+ /// offer functions to "downcast" this error into more specific types. For example,
+ /// errors returned from streams derived from filesystem types can be described using
+ /// the filesystem's own error-code type. This is done using the function
+ /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
+ /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
+ ///
+ /// The set of functions which can "downcast" an `error` into a more
+ /// concrete type is open.
+ @since(version = 0.2.0)
+ resource error {
+ /// Returns a string that is suitable to assist humans in debugging
+ /// this error.
+ ///
+ /// WARNING: The returned string should not be consumed mechanically!
+ /// It may change across platforms, hosts, or other implementation
+ /// details. Parsing this string is a major platform-compatibility
+ /// hazard.
+ @since(version = 0.2.0)
+ to-debug-string: func() -> string;
+ }
+}
+
+/// A poll API intended to let users wait for I/O events on multiple handles
+/// at once.
+@since(version = 0.2.0)
+interface poll {
+ /// `pollable` represents a single I/O event which may be ready, or not.
+ @since(version = 0.2.0)
+ resource pollable {
+ /// Return the readiness of a pollable. This function never blocks.
+ ///
+ /// Returns `true` when the pollable is ready, and `false` otherwise.
+ @since(version = 0.2.0)
+ ready: func() -> bool;
+ /// `block` returns immediately if the pollable is ready, and otherwise
+ /// blocks until ready.
+ ///
+ /// This function is equivalent to calling `poll.poll` on a list
+ /// containing only this pollable.
+ @since(version = 0.2.0)
+ block: func();
+ }
+
+ /// Poll for completion on a set of pollables.
+ ///
+ /// This function takes a list of pollables, which identify I/O sources of
+ /// interest, and waits until one or more of the events is ready for I/O.
+ ///
+ /// The result `list<u32>` contains one or more indices of handles in the
+ /// argument list that is ready for I/O.
+ ///
+ /// This function traps if either:
+ /// - the list is empty, or:
+ /// - the list contains more elements than can be indexed with a `u32` value.
+ ///
+ /// A timeout can be implemented by adding a pollable from the
+ /// wasi-clocks API to the list.
+ ///
+ /// This function does not return a `result`; polling in itself does not
+ /// do any I/O so it doesn't fail. If any of the I/O sources identified by
+ /// the pollables has an error, it is indicated by marking the source as
+ /// being ready for I/O.
+ @since(version = 0.2.0)
+ poll: func(in: list<borrow<pollable>>) -> list<u32>;
+}
+
+/// WASI I/O is an I/O abstraction API which is currently focused on providing
+/// stream types.
+///
+/// In the future, the component model is expected to add built-in stream types;
+/// when it does, they are expected to subsume this API.
+@since(version = 0.2.0)
+interface streams {
+ @since(version = 0.2.0)
+ use error.{error};
+ @since(version = 0.2.0)
+ use poll.{pollable};
+
+ /// An error for input-stream and output-stream operations.
+ @since(version = 0.2.0)
+ variant stream-error {
+ /// The last operation (a write or flush) failed before completion.
+ ///
+ /// More information is available in the `error` payload.
+ ///
+ /// After this, the stream will be closed. All future operations return
+ /// `stream-error::closed`.
+ last-operation-failed(error),
+ /// The stream is closed: no more input will be accepted by the
+ /// stream. A closed output-stream will return this error on all
+ /// future operations.
+ closed,
+ }
+
+ /// An input bytestream.
+ ///
+ /// `input-stream`s are *non-blocking* to the extent practical on underlying
+ /// platforms. I/O operations always return promptly; if fewer bytes are
+ /// promptly available than requested, they return the number of bytes promptly
+ /// available, which could even be zero. To wait for data to be available,
+ /// use the `subscribe` function to obtain a `pollable` which can be polled
+ /// for using `wasi:io/poll`.
+ @since(version = 0.2.0)
+ resource input-stream {
+ /// Perform a non-blocking read from the stream.
+ ///
+ /// When the source of a `read` is binary data, the bytes from the source
+ /// are returned verbatim. When the source of a `read` is known to the
+ /// implementation to be text, bytes containing the UTF-8 encoding of the
+ /// text are returned.
+ ///
+ /// This function returns a list of bytes containing the read data,
+ /// when successful. The returned list will contain up to `len` bytes;
+ /// it may return fewer than requested, but not more. The list is
+ /// empty when no bytes are available for reading at this time. The
+ /// pollable given by `subscribe` will be ready when more bytes are
+ /// available.
+ ///
+ /// This function fails with a `stream-error` when the operation
+ /// encounters an error, giving `last-operation-failed`, or when the
+ /// stream is closed, giving `closed`.
+ ///
+ /// When the caller gives a `len` of 0, it represents a request to
+ /// read 0 bytes. If the stream is still open, this call should
+ /// succeed and return an empty list, or otherwise fail with `closed`.
+ ///
+ /// The `len` parameter is a `u64`, which could represent a list of u8 which
+ /// is not possible to allocate in wasm32, or not desirable to allocate as
+ /// as a return value by the callee. The callee may return a list of bytes
+ /// less than `len` in size while more bytes are available for reading.
+ @since(version = 0.2.0)
+ read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Read bytes from a stream, after blocking until at least one byte can
+ /// be read. Except for blocking, behavior is identical to `read`.
+ @since(version = 0.2.0)
+ blocking-read: func(len: u64) -> result<list<u8>, stream-error>;
+ /// Skip bytes from a stream. Returns number of bytes skipped.
+ ///
+ /// Behaves identical to `read`, except instead of returning a list
+ /// of bytes, returns the number of bytes consumed from the stream.
+ @since(version = 0.2.0)
+ skip: func(len: u64) -> result<u64, stream-error>;
+ /// Skip bytes from a stream, after blocking until at least one byte
+ /// can be skipped. Except for blocking behavior, identical to `skip`.
+ @since(version = 0.2.0)
+ blocking-skip: func(len: u64) -> result<u64, stream-error>;
+ /// Create a `pollable` which will resolve once either the specified stream
+ /// has bytes available to read or the other end of the stream has been
+ /// closed.
+ /// The created `pollable` is a child resource of the `input-stream`.
+ /// Implementations may trap if the `input-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ /// An output bytestream.
+ ///
+ /// `output-stream`s are *non-blocking* to the extent practical on
+ /// underlying platforms. Except where specified otherwise, I/O operations also
+ /// always return promptly, after the number of bytes that can be written
+ /// promptly, which could even be zero. To wait for the stream to be ready to
+ /// accept data, the `subscribe` function to obtain a `pollable` which can be
+ /// polled for using `wasi:io/poll`.
+ ///
+ /// Dropping an `output-stream` while there's still an active write in
+ /// progress may result in the data being lost. Before dropping the stream,
+ /// be sure to fully flush your writes.
+ @since(version = 0.2.0)
+ resource output-stream {
+ /// Check readiness for writing. This function never blocks.
+ ///
+ /// Returns the number of bytes permitted for the next call to `write`,
+ /// or an error. Calling `write` with more bytes than this function has
+ /// permitted will trap.
+ ///
+ /// When this function returns 0 bytes, the `subscribe` pollable will
+ /// become ready when this function will report at least 1 byte, or an
+ /// error.
+ @since(version = 0.2.0)
+ check-write: func() -> result<u64, stream-error>;
+ /// Perform a write. This function never blocks.
+ ///
+ /// When the destination of a `write` is binary data, the bytes from
+ /// `contents` are written verbatim. When the destination of a `write` is
+ /// known to the implementation to be text, the bytes of `contents` are
+ /// transcoded from UTF-8 into the encoding of the destination and then
+ /// written.
+ ///
+ /// Precondition: check-write gave permit of Ok(n) and contents has a
+ /// length of less than or equal to n. Otherwise, this function will trap.
+ ///
+ /// returns Err(closed) without writing if the stream has closed since
+ /// the last call to check-write provided a permit.
+ @since(version = 0.2.0)
+ write: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 bytes, and then flush the stream. Block
+ /// until all of these operations are complete, or an error occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write`, and `flush`, and is implemented with the
+ /// following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while !contents.is_empty() {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, contents.len());
+ /// let (chunk, rest) = contents.split_at(len);
+ /// this.write(chunk ); // eliding error handling
+ /// contents = rest;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-and-flush: func(contents: list<u8>) -> result<_, stream-error>;
+ /// Request to flush buffered output. This function never blocks.
+ ///
+ /// This tells the output-stream that the caller intends any buffered
+ /// output to be flushed. the output which is expected to be flushed
+ /// is all that has been passed to `write` prior to this call.
+ ///
+ /// Upon calling this function, the `output-stream` will not accept any
+ /// writes (`check-write` will return `ok(0)`) until the flush has
+ /// completed. The `subscribe` pollable will become ready when the
+ /// flush has completed and the stream can accept more writes.
+ @since(version = 0.2.0)
+ flush: func() -> result<_, stream-error>;
+ /// Request to flush buffered output, and block until flush completes
+ /// and stream is ready for writing again.
+ @since(version = 0.2.0)
+ blocking-flush: func() -> result<_, stream-error>;
+ /// Create a `pollable` which will resolve once the output-stream
+ /// is ready for more writing, or an error has occurred. When this
+ /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
+ /// error.
+ ///
+ /// If the stream is closed, this pollable is always ready immediately.
+ ///
+ /// The created `pollable` is a child resource of the `output-stream`.
+ /// Implementations may trap if the `output-stream` is dropped before
+ /// all derived `pollable`s created with this function are dropped.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ /// Write zeroes to a stream.
+ ///
+ /// This should be used precisely like `write` with the exact same
+ /// preconditions (must use check-write first), but instead of
+ /// passing a list of bytes, you simply pass the number of zero-bytes
+ /// that should be written.
+ @since(version = 0.2.0)
+ write-zeroes: func(len: u64) -> result<_, stream-error>;
+ /// Perform a write of up to 4096 zeroes, and then flush the stream.
+ /// Block until all of these operations are complete, or an error
+ /// occurs.
+ ///
+ /// This is a convenience wrapper around the use of `check-write`,
+ /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
+ /// the following pseudo-code:
+ ///
+ /// ```text
+ /// let pollable = this.subscribe();
+ /// while num_zeroes != 0 {
+ /// // Wait for the stream to become writable
+ /// pollable.block();
+ /// let Ok(n) = this.check-write(); // eliding error handling
+ /// let len = min(n, num_zeroes);
+ /// this.write-zeroes(len); // eliding error handling
+ /// num_zeroes -= len;
+ /// }
+ /// this.flush();
+ /// // Wait for completion of `flush`
+ /// pollable.block();
+ /// // Check for any errors that arose during `flush`
+ /// let _ = this.check-write(); // eliding error handling
+ /// ```
+ @since(version = 0.2.0)
+ blocking-write-zeroes-and-flush: func(len: u64) -> result<_, stream-error>;
+ /// Read from one stream and write to another.
+ ///
+ /// The behavior of splice is equivalent to:
+ /// 1. calling `check-write` on the `output-stream`
+ /// 2. calling `read` on the `input-stream` with the smaller of the
+ /// `check-write` permitted length and the `len` provided to `splice`
+ /// 3. calling `write` on the `output-stream` with that read data.
+ ///
+ /// Any error reported by the call to `check-write`, `read`, or
+ /// `write` ends the splice and reports that error.
+ ///
+ /// This function returns the number of bytes transferred; it may be less
+ /// than `len`.
+ @since(version = 0.2.0)
+ splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ /// Read from one stream and write to another, with blocking.
+ ///
+ /// This is similar to `splice`, except that it blocks until the
+ /// `output-stream` is ready for writing, and the `input-stream`
+ /// is ready for reading, before performing the `splice`.
+ @since(version = 0.2.0)
+ blocking-splice: func(src: borrow<input-stream>, len: u64) -> result<u64, stream-error>;
+ }
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import error;
+ @since(version = 0.2.0)
+ import poll;
+ @since(version = 0.2.0)
+ import streams;
+}
diff --git a/crates/wasi/src/p2/wit/deps/io/error.wit b/crates/wasi/src/p2/wit/deps/io/error.wit
deleted file mode 100644
index 784f74a53e..0000000000
--- a/crates/wasi/src/p2/wit/deps/io/error.wit
+++ /dev/null
@@ -1,34 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-interface error {
- /// A resource which represents some error information.
- ///
- /// The only method provided by this resource is `to-debug-string`,
- /// which provides some human-readable information about the error.
- ///
- /// In the `wasi:io` package, this resource is returned through the
- /// `wasi:io/streams/stream-error` type.
- ///
- /// To provide more specific error information, other interfaces may
- /// offer functions to "downcast" this error into more specific types. For example,
- /// errors returned from streams derived from filesystem types can be described using
- /// the filesystem's own error-code type. This is done using the function
- /// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
- /// parameter and returns an `option<wasi:filesystem/types/error-code>`.
- ///
- /// The set of functions which can "downcast" an `error` into a more
- /// concrete type is open.
- @since(version = 0.2.0)
- resource error {
- /// Returns a string that is suitable to assist humans in debugging
- /// this error.
- ///
- /// WARNING: The returned string should not be consumed mechanically!
- /// It may change across platforms, hosts, or other implementation
- /// details. Parsing this string is a major platform-compatibility
- /// hazard.
- @since(version = 0.2.0)
- to-debug-string: func() -> string;
- }
-}
diff --git a/crates/wasi/src/p2/wit/deps/io/poll.wit b/crates/wasi/src/p2/wit/deps/io/poll.wit
deleted file mode 100644
index 7f711836c3..0000000000
--- a/crates/wasi/src/p2/wit/deps/io/poll.wit
+++ /dev/null
@@ -1,47 +0,0 @@
-package wasi:[email protected];
-
-/// A poll API intended to let users wait for I/O events on multiple handles
-/// at once.
-@since(version = 0.2.0)
-interface poll {
- /// `pollable` represents a single I/O event which may be ready, or not.
- @since(version = 0.2.0)
- resource pollable {
-
- /// Return the readiness of a pollable. This function never blocks.
- ///
- /// Returns `true` when the pollable is ready, and `false` otherwise.
- @since(version = 0.2.0)
- ready: func() -> bool;
-
- /// `block` returns immediately if the pollable is ready, and otherwise
- /// blocks until ready.
- ///
- /// This function is equivalent to calling `poll.poll` on a list
- /// containing only this pollable.
- @since(version = 0.2.0)
- block: func();
- }
-
- /// Poll for completion on a set of pollables.
- ///
- /// This function takes a list of pollables, which identify I/O sources of
- /// interest, and waits until one or more of the events is ready for I/O.
- ///
- /// The result `list<u32>` contains one or more indices of handles in the
- /// argument list that is ready for I/O.
- ///
- /// This function traps if either:
- /// - the list is empty, or:
- /// - the list contains more elements than can be indexed with a `u32` value.
- ///
- /// A timeout can be implemented by adding a pollable from the
- /// wasi-clocks API to the list.
- ///
- /// This function does not return a `result`; polling in itself does not
- /// do any I/O so it doesn't fail. If any of the I/O sources identified by
- /// the pollables has an error, it is indicated by marking the source as
- /// being ready for I/O.
- @since(version = 0.2.0)
- poll: func(in: list<borrow<pollable>>) -> list<u32>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/io/streams.wit b/crates/wasi/src/p2/wit/deps/io/streams.wit
deleted file mode 100644
index c5da38c862..0000000000
--- a/crates/wasi/src/p2/wit/deps/io/streams.wit
+++ /dev/null
@@ -1,290 +0,0 @@
-package wasi:[email protected];
-
-/// WASI I/O is an I/O abstraction API which is currently focused on providing
-/// stream types.
-///
-/// In the future, the component model is expected to add built-in stream types;
-/// when it does, they are expected to subsume this API.
-@since(version = 0.2.0)
-interface streams {
- @since(version = 0.2.0)
- use error.{error};
- @since(version = 0.2.0)
- use poll.{pollable};
-
- /// An error for input-stream and output-stream operations.
- @since(version = 0.2.0)
- variant stream-error {
- /// The last operation (a write or flush) failed before completion.
- ///
- /// More information is available in the `error` payload.
- ///
- /// After this, the stream will be closed. All future operations return
- /// `stream-error::closed`.
- last-operation-failed(error),
- /// The stream is closed: no more input will be accepted by the
- /// stream. A closed output-stream will return this error on all
- /// future operations.
- closed
- }
-
- /// An input bytestream.
- ///
- /// `input-stream`s are *non-blocking* to the extent practical on underlying
- /// platforms. I/O operations always return promptly; if fewer bytes are
- /// promptly available than requested, they return the number of bytes promptly
- /// available, which could even be zero. To wait for data to be available,
- /// use the `subscribe` function to obtain a `pollable` which can be polled
- /// for using `wasi:io/poll`.
- @since(version = 0.2.0)
- resource input-stream {
- /// Perform a non-blocking read from the stream.
- ///
- /// When the source of a `read` is binary data, the bytes from the source
- /// are returned verbatim. When the source of a `read` is known to the
- /// implementation to be text, bytes containing the UTF-8 encoding of the
- /// text are returned.
- ///
- /// This function returns a list of bytes containing the read data,
- /// when successful. The returned list will contain up to `len` bytes;
- /// it may return fewer than requested, but not more. The list is
- /// empty when no bytes are available for reading at this time. The
- /// pollable given by `subscribe` will be ready when more bytes are
- /// available.
- ///
- /// This function fails with a `stream-error` when the operation
- /// encounters an error, giving `last-operation-failed`, or when the
- /// stream is closed, giving `closed`.
- ///
- /// When the caller gives a `len` of 0, it represents a request to
- /// read 0 bytes. If the stream is still open, this call should
- /// succeed and return an empty list, or otherwise fail with `closed`.
- ///
- /// The `len` parameter is a `u64`, which could represent a list of u8 which
- /// is not possible to allocate in wasm32, or not desirable to allocate as
- /// as a return value by the callee. The callee may return a list of bytes
- /// less than `len` in size while more bytes are available for reading.
- @since(version = 0.2.0)
- read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Read bytes from a stream, after blocking until at least one byte can
- /// be read. Except for blocking, behavior is identical to `read`.
- @since(version = 0.2.0)
- blocking-read: func(
- /// The maximum number of bytes to read
- len: u64
- ) -> result<list<u8>, stream-error>;
-
- /// Skip bytes from a stream. Returns number of bytes skipped.
- ///
- /// Behaves identical to `read`, except instead of returning a list
- /// of bytes, returns the number of bytes consumed from the stream.
- @since(version = 0.2.0)
- skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Skip bytes from a stream, after blocking until at least one byte
- /// can be skipped. Except for blocking behavior, identical to `skip`.
- @since(version = 0.2.0)
- blocking-skip: func(
- /// The maximum number of bytes to skip.
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Create a `pollable` which will resolve once either the specified stream
- /// has bytes available to read or the other end of the stream has been
- /// closed.
- /// The created `pollable` is a child resource of the `input-stream`.
- /// Implementations may trap if the `input-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
-
- /// An output bytestream.
- ///
- /// `output-stream`s are *non-blocking* to the extent practical on
- /// underlying platforms. Except where specified otherwise, I/O operations also
- /// always return promptly, after the number of bytes that can be written
- /// promptly, which could even be zero. To wait for the stream to be ready to
- /// accept data, the `subscribe` function to obtain a `pollable` which can be
- /// polled for using `wasi:io/poll`.
- ///
- /// Dropping an `output-stream` while there's still an active write in
- /// progress may result in the data being lost. Before dropping the stream,
- /// be sure to fully flush your writes.
- @since(version = 0.2.0)
- resource output-stream {
- /// Check readiness for writing. This function never blocks.
- ///
- /// Returns the number of bytes permitted for the next call to `write`,
- /// or an error. Calling `write` with more bytes than this function has
- /// permitted will trap.
- ///
- /// When this function returns 0 bytes, the `subscribe` pollable will
- /// become ready when this function will report at least 1 byte, or an
- /// error.
- @since(version = 0.2.0)
- check-write: func() -> result<u64, stream-error>;
-
- /// Perform a write. This function never blocks.
- ///
- /// When the destination of a `write` is binary data, the bytes from
- /// `contents` are written verbatim. When the destination of a `write` is
- /// known to the implementation to be text, the bytes of `contents` are
- /// transcoded from UTF-8 into the encoding of the destination and then
- /// written.
- ///
- /// Precondition: check-write gave permit of Ok(n) and contents has a
- /// length of less than or equal to n. Otherwise, this function will trap.
- ///
- /// returns Err(closed) without writing if the stream has closed since
- /// the last call to check-write provided a permit.
- @since(version = 0.2.0)
- write: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 bytes, and then flush the stream. Block
- /// until all of these operations are complete, or an error occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write`, and `flush`, and is implemented with the
- /// following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while !contents.is_empty() {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, contents.len());
- /// let (chunk, rest) = contents.split_at(len);
- /// this.write(chunk ); // eliding error handling
- /// contents = rest;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-and-flush: func(
- contents: list<u8>
- ) -> result<_, stream-error>;
-
- /// Request to flush buffered output. This function never blocks.
- ///
- /// This tells the output-stream that the caller intends any buffered
- /// output to be flushed. the output which is expected to be flushed
- /// is all that has been passed to `write` prior to this call.
- ///
- /// Upon calling this function, the `output-stream` will not accept any
- /// writes (`check-write` will return `ok(0)`) until the flush has
- /// completed. The `subscribe` pollable will become ready when the
- /// flush has completed and the stream can accept more writes.
- @since(version = 0.2.0)
- flush: func() -> result<_, stream-error>;
-
- /// Request to flush buffered output, and block until flush completes
- /// and stream is ready for writing again.
- @since(version = 0.2.0)
- blocking-flush: func() -> result<_, stream-error>;
-
- /// Create a `pollable` which will resolve once the output-stream
- /// is ready for more writing, or an error has occurred. When this
- /// pollable is ready, `check-write` will return `ok(n)` with n>0, or an
- /// error.
- ///
- /// If the stream is closed, this pollable is always ready immediately.
- ///
- /// The created `pollable` is a child resource of the `output-stream`.
- /// Implementations may trap if the `output-stream` is dropped before
- /// all derived `pollable`s created with this function are dropped.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
-
- /// Write zeroes to a stream.
- ///
- /// This should be used precisely like `write` with the exact same
- /// preconditions (must use check-write first), but instead of
- /// passing a list of bytes, you simply pass the number of zero-bytes
- /// that should be written.
- @since(version = 0.2.0)
- write-zeroes: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Perform a write of up to 4096 zeroes, and then flush the stream.
- /// Block until all of these operations are complete, or an error
- /// occurs.
- ///
- /// This is a convenience wrapper around the use of `check-write`,
- /// `subscribe`, `write-zeroes`, and `flush`, and is implemented with
- /// the following pseudo-code:
- ///
- /// ```text
- /// let pollable = this.subscribe();
- /// while num_zeroes != 0 {
- /// // Wait for the stream to become writable
- /// pollable.block();
- /// let Ok(n) = this.check-write(); // eliding error handling
- /// let len = min(n, num_zeroes);
- /// this.write-zeroes(len); // eliding error handling
- /// num_zeroes -= len;
- /// }
- /// this.flush();
- /// // Wait for completion of `flush`
- /// pollable.block();
- /// // Check for any errors that arose during `flush`
- /// let _ = this.check-write(); // eliding error handling
- /// ```
- @since(version = 0.2.0)
- blocking-write-zeroes-and-flush: func(
- /// The number of zero-bytes to write
- len: u64
- ) -> result<_, stream-error>;
-
- /// Read from one stream and write to another.
- ///
- /// The behavior of splice is equivalent to:
- /// 1. calling `check-write` on the `output-stream`
- /// 2. calling `read` on the `input-stream` with the smaller of the
- /// `check-write` permitted length and the `len` provided to `splice`
- /// 3. calling `write` on the `output-stream` with that read data.
- ///
- /// Any error reported by the call to `check-write`, `read`, or
- /// `write` ends the splice and reports that error.
- ///
- /// This function returns the number of bytes transferred; it may be less
- /// than `len`.
- @since(version = 0.2.0)
- splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
-
- /// Read from one stream and write to another, with blocking.
- ///
- /// This is similar to `splice`, except that it blocks until the
- /// `output-stream` is ready for writing, and the `input-stream`
- /// is ready for reading, before performing the `splice`.
- @since(version = 0.2.0)
- blocking-splice: func(
- /// The stream to read from
- src: borrow<input-stream>,
- /// The number of bytes to splice
- len: u64,
- ) -> result<u64, stream-error>;
- }
-}
diff --git a/crates/wasi/src/p2/wit/deps/io/world.wit b/crates/wasi/src/p2/wit/deps/io/world.wit
deleted file mode 100644
index 84c85c08ed..0000000000
--- a/crates/wasi/src/p2/wit/deps/io/world.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import streams;
-
- @since(version = 0.2.0)
- import poll;
-}
diff --git a/crates/wasi/src/p2/wit/deps/random.wit b/crates/wasi/src/p2/wit/deps/random.wit
new file mode 100644
index 0000000000..73edf5b60e
--- /dev/null
+++ b/crates/wasi/src/p2/wit/deps/random.wit
@@ -0,0 +1,92 @@
+package wasi:[email protected];
+
+/// The insecure-seed interface for seeding hash-map DoS resistance.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.2.0)
+interface insecure-seed {
+ /// Return a 128-bit value that may contain a pseudo-random value.
+ ///
+ /// The returned value is not required to be computed from a CSPRNG, and may
+ /// even be entirely deterministic. Host implementations are encouraged to
+ /// provide pseudo-random values to any program exposed to
+ /// attacker-controlled content, to enable DoS protection built into many
+ /// languages' hash-map implementations.
+ ///
+ /// This function is intended to only be called once, by a source language
+ /// to initialize Denial Of Service (DoS) protection in its hash-map
+ /// implementation.
+ ///
+ /// # Expected future evolution
+ ///
+ /// This will likely be changed to a value import, to prevent it from being
+ /// called multiple times and potentially used for purposes other than DoS
+ /// protection.
+ @since(version = 0.2.0)
+ insecure-seed: func() -> tuple<u64, u64>;
+}
+
+/// The insecure interface for insecure pseudo-random numbers.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.2.0)
+interface insecure {
+ /// Return `len` insecure pseudo-random bytes.
+ ///
+ /// This function is not cryptographically secure. Do not use it for
+ /// anything related to security.
+ ///
+ /// There are no requirements on the values of the returned bytes, however
+ /// implementations are encouraged to return evenly distributed values with
+ /// a long period.
+ @since(version = 0.2.0)
+ get-insecure-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return an insecure pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of pseudo-random data as
+ /// `get-insecure-random-bytes`, represented as a `u64`.
+ @since(version = 0.2.0)
+ get-insecure-random-u64: func() -> u64;
+}
+
+/// WASI Random is a random data API.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.2.0)
+interface random {
+ /// Return `len` cryptographically-secure random or pseudo-random bytes.
+ ///
+ /// This function must produce data at least as cryptographically secure and
+ /// fast as an adequately seeded cryptographically-secure pseudo-random
+ /// number generator (CSPRNG). It must not block, from the perspective of
+ /// the calling program, under any circumstances, including on the first
+ /// request and on requests for numbers of bytes. The returned data must
+ /// always be unpredictable.
+ ///
+ /// This function must always return fresh data. Deterministic environments
+ /// must omit this function, rather than implementing it with deterministic
+ /// data.
+ @since(version = 0.2.0)
+ get-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return a cryptographically-secure random or pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of data as `get-random-bytes`,
+ /// represented as a `u64`.
+ @since(version = 0.2.0)
+ get-random-u64: func() -> u64;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import random;
+ @since(version = 0.2.0)
+ import insecure;
+ @since(version = 0.2.0)
+ import insecure-seed;
+}
diff --git a/crates/wasi/src/p2/wit/deps/random/insecure-seed.wit b/crates/wasi/src/p2/wit/deps/random/insecure-seed.wit
deleted file mode 100644
index d3dc03a6c0..0000000000
--- a/crates/wasi/src/p2/wit/deps/random/insecure-seed.wit
+++ /dev/null
@@ -1,27 +0,0 @@
-package wasi:[email protected];
-/// The insecure-seed interface for seeding hash-map DoS resistance.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.2.0)
-interface insecure-seed {
- /// Return a 128-bit value that may contain a pseudo-random value.
- ///
- /// The returned value is not required to be computed from a CSPRNG, and may
- /// even be entirely deterministic. Host implementations are encouraged to
- /// provide pseudo-random values to any program exposed to
- /// attacker-controlled content, to enable DoS protection built into many
- /// languages' hash-map implementations.
- ///
- /// This function is intended to only be called once, by a source language
- /// to initialize Denial Of Service (DoS) protection in its hash-map
- /// implementation.
- ///
- /// # Expected future evolution
- ///
- /// This will likely be changed to a value import, to prevent it from being
- /// called multiple times and potentially used for purposes other than DoS
- /// protection.
- @since(version = 0.2.0)
- insecure-seed: func() -> tuple<u64, u64>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/random/insecure.wit b/crates/wasi/src/p2/wit/deps/random/insecure.wit
deleted file mode 100644
index d4d0284801..0000000000
--- a/crates/wasi/src/p2/wit/deps/random/insecure.wit
+++ /dev/null
@@ -1,25 +0,0 @@
-package wasi:[email protected];
-/// The insecure interface for insecure pseudo-random numbers.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.2.0)
-interface insecure {
- /// Return `len` insecure pseudo-random bytes.
- ///
- /// This function is not cryptographically secure. Do not use it for
- /// anything related to security.
- ///
- /// There are no requirements on the values of the returned bytes, however
- /// implementations are encouraged to return evenly distributed values with
- /// a long period.
- @since(version = 0.2.0)
- get-insecure-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return an insecure pseudo-random `u64` value.
- ///
- /// This function returns the same type of pseudo-random data as
- /// `get-insecure-random-bytes`, represented as a `u64`.
- @since(version = 0.2.0)
- get-insecure-random-u64: func() -> u64;
-}
diff --git a/crates/wasi/src/p2/wit/deps/random/random.wit b/crates/wasi/src/p2/wit/deps/random/random.wit
deleted file mode 100644
index a0ff95646a..0000000000
--- a/crates/wasi/src/p2/wit/deps/random/random.wit
+++ /dev/null
@@ -1,29 +0,0 @@
-package wasi:[email protected];
-/// WASI Random is a random data API.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.2.0)
-interface random {
- /// Return `len` cryptographically-secure random or pseudo-random bytes.
- ///
- /// This function must produce data at least as cryptographically secure and
- /// fast as an adequately seeded cryptographically-secure pseudo-random
- /// number generator (CSPRNG). It must not block, from the perspective of
- /// the calling program, under any circumstances, including on the first
- /// request and on requests for numbers of bytes. The returned data must
- /// always be unpredictable.
- ///
- /// This function must always return fresh data. Deterministic environments
- /// must omit this function, rather than implementing it with deterministic
- /// data.
- @since(version = 0.2.0)
- get-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return a cryptographically-secure random or pseudo-random `u64` value.
- ///
- /// This function returns the same type of data as `get-random-bytes`,
- /// represented as a `u64`.
- @since(version = 0.2.0)
- get-random-u64: func() -> u64;
-}
diff --git a/crates/wasi/src/p2/wit/deps/random/world.wit b/crates/wasi/src/p2/wit/deps/random/world.wit
deleted file mode 100644
index 099f47b36e..0000000000
--- a/crates/wasi/src/p2/wit/deps/random/world.wit
+++ /dev/null
@@ -1,13 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import random;
-
- @since(version = 0.2.0)
- import insecure;
-
- @since(version = 0.2.0)
- import insecure-seed;
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets.wit b/crates/wasi/src/p2/wit/deps/sockets.wit
new file mode 100644
index 0000000000..db6d1a23b4
--- /dev/null
+++ b/crates/wasi/src/p2/wit/deps/sockets.wit
@@ -0,0 +1,949 @@
+package wasi:[email protected];
+
+@since(version = 0.2.0)
+interface network {
+ @unstable(feature = network-error-code)
+ use wasi:io/[email protected].{error};
+
+ /// An opaque resource that represents access to (a subset of) the network.
+ /// This enables context-based security for networking.
+ /// There is no need for this to map 1:1 to a physical network interface.
+ @since(version = 0.2.0)
+ resource network;
+
+ /// Error codes.
+ ///
+ /// In theory, every API can return any error code.
+ /// In practice, API's typically only return the errors documented per API
+ /// combined with a couple of errors that are always possible:
+ /// - `unknown`
+ /// - `access-denied`
+ /// - `not-supported`
+ /// - `out-of-memory`
+ /// - `concurrency-conflict`
+ ///
+ /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
+ @since(version = 0.2.0)
+ enum error-code {
+ /// Unknown error
+ unknown,
+ /// Access denied.
+ ///
+ /// POSIX equivalent: EACCES, EPERM
+ access-denied,
+ /// The operation is not supported.
+ ///
+ /// POSIX equivalent: EOPNOTSUPP
+ not-supported,
+ /// One of the arguments is invalid.
+ ///
+ /// POSIX equivalent: EINVAL
+ invalid-argument,
+ /// Not enough memory to complete the operation.
+ ///
+ /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
+ out-of-memory,
+ /// The operation timed out before it could finish completely.
+ timeout,
+ /// This operation is incompatible with another asynchronous operation that is already in progress.
+ ///
+ /// POSIX equivalent: EALREADY
+ concurrency-conflict,
+ /// Trying to finish an asynchronous operation that:
+ /// - has not been started yet, or:
+ /// - was already finished by a previous `finish-*` call.
+ ///
+ /// Note: this is scheduled to be removed when `future`s are natively supported.
+ not-in-progress,
+ /// The operation has been aborted because it could not be completed immediately.
+ ///
+ /// Note: this is scheduled to be removed when `future`s are natively supported.
+ would-block,
+ /// The operation is not valid in the socket's current state.
+ invalid-state,
+ /// A new socket resource could not be created because of a system limit.
+ new-socket-limit,
+ /// A bind operation failed because the provided address is not an address that the `network` can bind to.
+ address-not-bindable,
+ /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
+ address-in-use,
+ /// The remote address is not reachable
+ remote-unreachable,
+ /// The TCP connection was forcefully rejected
+ connection-refused,
+ /// The TCP connection was reset.
+ connection-reset,
+ /// A TCP connection was aborted.
+ connection-aborted,
+ /// The size of a datagram sent to a UDP socket exceeded the maximum
+ /// supported size.
+ datagram-too-large,
+ /// Name does not exist or has no suitable associated IP addresses.
+ name-unresolvable,
+ /// A temporary failure in name resolution occurred.
+ temporary-resolver-failure,
+ /// A permanent failure in name resolution occurred.
+ permanent-resolver-failure,
+ }
+
+ @since(version = 0.2.0)
+ enum ip-address-family {
+ /// Similar to `AF_INET` in POSIX.
+ ipv4,
+ /// Similar to `AF_INET6` in POSIX.
+ ipv6,
+ }
+
+ @since(version = 0.2.0)
+ type ipv4-address = tuple<u8, u8, u8, u8>;
+
+ @since(version = 0.2.0)
+ type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
+
+ @since(version = 0.2.0)
+ variant ip-address {
+ ipv4(ipv4-address),
+ ipv6(ipv6-address),
+ }
+
+ @since(version = 0.2.0)
+ record ipv4-socket-address {
+ /// sin_port
+ port: u16,
+ /// sin_addr
+ address: ipv4-address,
+ }
+
+ @since(version = 0.2.0)
+ record ipv6-socket-address {
+ /// sin6_port
+ port: u16,
+ /// sin6_flowinfo
+ flow-info: u32,
+ /// sin6_addr
+ address: ipv6-address,
+ /// sin6_scope_id
+ scope-id: u32,
+ }
+
+ @since(version = 0.2.0)
+ variant ip-socket-address {
+ ipv4(ipv4-socket-address),
+ ipv6(ipv6-socket-address),
+ }
+
+ /// Attempts to extract a network-related `error-code` from the stream
+ /// `error` provided.
+ ///
+ /// Stream operations which return `stream-error::last-operation-failed`
+ /// have a payload with more information about the operation that failed.
+ /// This payload can be passed through to this function to see if there's
+ /// network-related information about the error to return.
+ ///
+ /// Note that this function is fallible because not all stream-related
+ /// errors are network-related errors.
+ @unstable(feature = network-error-code)
+ network-error-code: func(err: borrow<error>) -> option<error-code>;
+}
+
+/// This interface provides a value-export of the default network handle..
+@since(version = 0.2.0)
+interface instance-network {
+ @since(version = 0.2.0)
+ use network.{network};
+
+ /// Get a handle to the default network.
+ @since(version = 0.2.0)
+ instance-network: func() -> network;
+}
+
+@since(version = 0.2.0)
+interface ip-name-lookup {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-address};
+
+ @since(version = 0.2.0)
+ resource resolve-address-stream {
+ /// Returns the next address from the resolver.
+ ///
+ /// This function should be called multiple times. On each call, it will
+ /// return the next address in connection order preference. If all
+ /// addresses have been exhausted, this function returns `none`.
+ ///
+ /// This function never returns IPv4-mapped IPv6 addresses.
+ ///
+ /// # Typical errors
+ /// - `name-unresolvable`: Name does not exist or has no suitable associated IP addresses. (EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY)
+ /// - `temporary-resolver-failure`: A temporary failure in name resolution occurred. (EAI_AGAIN)
+ /// - `permanent-resolver-failure`: A permanent failure in name resolution occurred. (EAI_FAIL)
+ /// - `would-block`: A result is not available yet. (EWOULDBLOCK, EAGAIN)
+ @since(version = 0.2.0)
+ resolve-next-address: func() -> result<option<ip-address>, error-code>;
+ /// Create a `pollable` which will resolve once the stream is ready for I/O.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ /// Resolve an internet host name to a list of IP addresses.
+ ///
+ /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
+ /// If the input is an IP address string, the address is parsed and returned
+ /// as-is without making any external requests.
+ ///
+ /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
+ ///
+ /// This function never blocks. It either immediately fails or immediately
+ /// returns successfully with a `resolve-address-stream` that can be used
+ /// to (asynchronously) fetch the results.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: `name` is a syntactically invalid domain name or IP address.
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
+ /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
+ @since(version = 0.2.0)
+ resolve-addresses: func(network: borrow<network>, name: string) -> result<resolve-address-stream, error-code>;
+}
+
+@since(version = 0.2.0)
+interface tcp {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{input-stream, output-stream};
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+ @since(version = 0.2.0)
+ use wasi:clocks/[email protected].{duration};
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-socket-address, ip-address-family};
+
+ @since(version = 0.2.0)
+ enum shutdown-type {
+ /// Similar to `SHUT_RD` in POSIX.
+ receive,
+ /// Similar to `SHUT_WR` in POSIX.
+ send,
+ /// Similar to `SHUT_RDWR` in POSIX.
+ both,
+ }
+
+ /// A TCP socket resource.
+ ///
+ /// The socket can be in one of the following states:
+ /// - `unbound`
+ /// - `bind-in-progress`
+ /// - `bound` (See note below)
+ /// - `listen-in-progress`
+ /// - `listening`
+ /// - `connect-in-progress`
+ /// - `connected`
+ /// - `closed`
+ /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md>
+ /// for more information.
+ ///
+ /// Note: Except where explicitly mentioned, whenever this documentation uses
+ /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
+ /// (i.e. `bound`, `listen-in-progress`, `listening`, `connect-in-progress` or `connected`)
+ ///
+ /// In addition to the general error codes documented on the
+ /// `network::error-code` type, TCP socket methods may always return
+ /// `error(invalid-state)` when in the `closed` state.
+ @since(version = 0.2.0)
+ resource tcp-socket {
+ /// Bind the socket to a specific network on the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
+ ///
+ /// Bind can be attempted multiple times on the same socket, even with
+ /// different arguments on each iteration. But never concurrently and
+ /// only as long as the previous bind failed. Once a bind succeeds, the
+ /// binding can't be changed anymore.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
+ /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
+ /// - `not-in-progress`: A `bind` operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
+ /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
+ /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
+ /// and SO_REUSEADDR performs something different entirely.
+ ///
+ /// Unlike in POSIX, in WASI the bind operation is async. This enables
+ /// interactive WASI hosts to inject permission prompts. Runtimes that
+ /// don't want to make use of this ability can simply call the native
+ /// `bind` as part of either `start-bind` or `finish-bind`.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.2.0)
+ start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-bind: func() -> result<_, error-code>;
+ /// Connect to a remote endpoint.
+ ///
+ /// On success:
+ /// - the socket is transitioned into the `connected` state.
+ /// - a pair of streams is returned that can be used to read & write to the connection
+ ///
+ /// After a failed connection attempt, the socket will be in the `closed`
+ /// state and the only valid action left is to `drop` the socket. A single
+ /// socket can not be used to connect more than once.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
+ /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
+ /// - `invalid-argument`: The socket is already attached to a different network. The `network` passed to `connect` must be identical to the one passed to `bind`.
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
+ /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
+ /// - `timeout`: Connection timed out. (ETIMEDOUT)
+ /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ /// - `not-in-progress`: A connect operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// The POSIX equivalent of `start-connect` is the regular `connect` syscall.
+ /// Because all WASI sockets are non-blocking this is expected to return
+ /// EINPROGRESS, which should be translated to `ok()` in WASI.
+ ///
+ /// The POSIX equivalent of `finish-connect` is a `poll` for event `POLLOUT`
+ /// with a timeout of 0 on the socket descriptor. Followed by a check for
+ /// the `SO_ERROR` socket option, in case the poll signaled readiness.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.2.0)
+ start-connect: func(network: borrow<network>, remote-address: ip-socket-address) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-connect: func() -> result<tuple<input-stream, output-stream>, error-code>;
+ /// Start listening for new connections.
+ ///
+ /// Transitions the socket into the `listening` state.
+ ///
+ /// Unlike POSIX, the socket must already be explicitly bound.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address. (EDESTADDRREQ)
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
+ /// - `invalid-state`: The socket is already in the `listening` state.
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
+ /// - `not-in-progress`: A listen operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// Unlike in POSIX, in WASI the listen operation is async. This enables
+ /// interactive WASI hosts to inject permission prompts. Runtimes that
+ /// don't want to make use of this ability can simply call the native
+ /// `listen` as part of either `start-listen` or `finish-listen`.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
+ /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
+ @since(version = 0.2.0)
+ start-listen: func() -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-listen: func() -> result<_, error-code>;
+ /// Accept a new client socket.
+ ///
+ /// The returned socket is bound and in the `connected` state. The following properties are inherited from the listener socket:
+ /// - `address-family`
+ /// - `keep-alive-enabled`
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// - `hop-limit`
+ /// - `receive-buffer-size`
+ /// - `send-buffer-size`
+ ///
+ /// On success, this function returns the newly accepted client socket along with
+ /// a pair of streams that can be used to read & write to the connection.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: Socket is not in the `listening` state. (EINVAL)
+ /// - `would-block`: No pending connections at the moment. (EWOULDBLOCK, EAGAIN)
+ /// - `connection-aborted`: An incoming connection was pending, but was terminated by the client before this listener could accept it. (ECONNABORTED)
+ /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
+ /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
+ @since(version = 0.2.0)
+ accept: func() -> result<tuple<tcp-socket, input-stream, output-stream>, error-code>;
+ /// Get the bound local address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.2.0)
+ local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the remote address.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.2.0)
+ remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether the socket is in the `listening` state.
+ ///
+ /// Equivalent to the SO_ACCEPTCONN socket option.
+ @since(version = 0.2.0)
+ is-listening: func() -> bool;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.2.0)
+ address-family: func() -> ip-address-family;
+ /// Hints the desired listen queue size. Implementations are free to ignore this.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
+ /// - `invalid-argument`: (set) The provided value was 0.
+ /// - `invalid-state`: (set) The socket is in the `connect-in-progress` or `connected` state.
+ @since(version = 0.2.0)
+ set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
+ /// Enables or disables keepalive.
+ ///
+ /// The keepalive behavior can be adjusted using:
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
+ ///
+ /// Equivalent to the SO_KEEPALIVE socket option.
+ @since(version = 0.2.0)
+ keep-alive-enabled: func() -> result<bool, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
+ /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ keep-alive-idle-time: func() -> result<duration, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
+ /// The time between keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPINTVL socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ keep-alive-interval: func() -> result<duration, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
+ /// The maximum amount of keepalive packets TCP should send before aborting the connection.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPCNT socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ keep-alive-count: func() -> result<u32, error-code>;
+ @since(version = 0.2.0)
+ set-keep-alive-count: func(value: u32) -> result<_, error-code>;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.2.0)
+ hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.2.0)
+ set-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ /// Create a `pollable` which can be used to poll for, or block on,
+ /// completion of any of the asynchronous operations of this socket.
+ ///
+ /// When `finish-bind`, `finish-listen`, `finish-connect` or `accept`
+ /// return `error(would-block)`, this pollable can be used to wait for
+ /// their success or failure, after which the method can be retried.
+ ///
+ /// The pollable is not limited to the async operation that happens to be
+ /// in progress at the time of calling `subscribe` (if any). Theoretically,
+ /// `subscribe` only has to be called once per socket and can then be
+ /// (re)used for the remainder of the socket's lifetime.
+ ///
+ /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md#pollable-readiness>
+ /// for more information.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ /// Initiate a graceful shutdown.
+ ///
+ /// - `receive`: The socket is not expecting to receive any data from
+ /// the peer. The `input-stream` associated with this socket will be
+ /// closed. Any data still in the receive queue at time of calling
+ /// this method will be discarded.
+ /// - `send`: The socket has no more data to send to the peer. The `output-stream`
+ /// associated with this socket will be closed and a FIN packet will be sent.
+ /// - `both`: Same effect as `receive` & `send` combined.
+ ///
+ /// This function is idempotent; shutting down a direction more than once
+ /// has no effect and returns `ok`.
+ ///
+ /// The shutdown function does not close (drop) the socket.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/shutdown.html>
+ /// - <https://man7.org/linux/man-pages/man2/shutdown.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-shutdown>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=shutdown&sektion=2>
+ @since(version = 0.2.0)
+ shutdown: func(shutdown-type: shutdown-type) -> result<_, error-code>;
+ }
+}
+
+@since(version = 0.2.0)
+interface tcp-create-socket {
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-address-family};
+ @since(version = 0.2.0)
+ use tcp.{tcp-socket};
+
+ /// Create a new TCP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// This function does not require a network capability handle. This is considered to be safe because
+ /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind`/`connect`
+ /// is called, the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
+ ///
+ /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
+ /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.2.0)
+ create-tcp-socket: func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
+}
+
+@since(version = 0.2.0)
+interface udp {
+ @since(version = 0.2.0)
+ use wasi:io/[email protected].{pollable};
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-socket-address, ip-address-family};
+
+ /// A received datagram.
+ @since(version = 0.2.0)
+ record incoming-datagram {
+ /// The payload.
+ ///
+ /// Theoretical max size: ~64 KiB. In practice, typically less than 1500 bytes.
+ data: list<u8>,
+ /// The source address.
+ ///
+ /// This field is guaranteed to match the remote address the stream was initialized with, if any.
+ ///
+ /// Equivalent to the `src_addr` out parameter of `recvfrom`.
+ remote-address: ip-socket-address,
+ }
+
+ /// A datagram to be sent out.
+ @since(version = 0.2.0)
+ record outgoing-datagram {
+ /// The payload.
+ data: list<u8>,
+ /// The destination address.
+ ///
+ /// The requirements on this field depend on how the stream was initialized:
+ /// - with a remote address: this field must be None or match the stream's remote address exactly.
+ /// - without a remote address: this field is required.
+ ///
+ /// If this value is None, the send operation is equivalent to `send` in POSIX. Otherwise it is equivalent to `sendto`.
+ remote-address: option<ip-socket-address>,
+ }
+
+ /// A UDP socket handle.
+ @since(version = 0.2.0)
+ resource udp-socket {
+ /// Bind the socket to a specific network on the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the port is zero, the socket will be bound to a random free port.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
+ /// - `not-in-progress`: A `bind` operation is not in progress.
+ /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+ ///
+ /// # Implementors note
+ /// Unlike in POSIX, in WASI the bind operation is async. This enables
+ /// interactive WASI hosts to inject permission prompts. Runtimes that
+ /// don't want to make use of this ability can simply call the native
+ /// `bind` as part of either `start-bind` or `finish-bind`.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.2.0)
+ start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ finish-bind: func() -> result<_, error-code>;
+ /// Set up inbound & outbound communication channels, optionally to a specific peer.
+ ///
+ /// This function only changes the local socket configuration and does not generate any network traffic.
+ /// On success, the `remote-address` of the socket is updated. The `local-address` may be updated as well,
+ /// based on the best network path to `remote-address`.
+ ///
+ /// When a `remote-address` is provided, the returned streams are limited to communicating with that specific peer:
+ /// - `send` can only be used to send to this destination.
+ /// - `receive` will only return datagrams sent from the provided `remote-address`.
+ ///
+ /// This method may be called multiple times on the same socket to change its association, but
+ /// only the most recently returned pair of streams will be operational. Implementations may trap if
+ /// the streams returned by a previous invocation haven't been dropped yet before calling `stream` again.
+ ///
+ /// The POSIX equivalent in pseudo-code is:
+ /// ```text
+ /// if (was previously connected) {
+ /// connect(s, AF_UNSPEC)
+ /// }
+ /// if (remote_address is Some) {
+ /// connect(s, remote_address)
+ /// }
+ /// ```
+ ///
+ /// Unlike in POSIX, the socket must already be explicitly bound.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-state`: The socket is not bound.
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.2.0)
+ %stream: func(remote-address: option<ip-socket-address>) -> result<tuple<incoming-datagram-stream, outgoing-datagram-stream>, error-code>;
+ /// Get the current bound address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.2.0)
+ local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the address the socket is currently streaming to.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not streaming to a specific remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.2.0)
+ remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.2.0)
+ address-family: func() -> ip-address-family;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.2.0)
+ unicast-hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.2.0)
+ set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.2.0)
+ receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.2.0)
+ send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.2.0)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ /// Create a `pollable` which will resolve once the socket is ready for I/O.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ @since(version = 0.2.0)
+ resource incoming-datagram-stream {
+ /// Receive messages on the socket.
+ ///
+ /// This function attempts to receive up to `max-results` datagrams on the socket without blocking.
+ /// The returned list may contain fewer elements than requested, but never more.
+ ///
+ /// This function returns successfully with an empty list when either:
+ /// - `max-results` is 0, or:
+ /// - `max-results` is greater than 0, but no results are immediately available.
+ /// This function never returns `error(would-block)`.
+ ///
+ /// # Typical errors
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
+ /// - <https://learn.microsoft.com/en-us/previous-versions/windows/desktop/legacy/ms741687(v=vs.85)>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
+ @since(version = 0.2.0)
+ receive: func(max-results: u64) -> result<list<incoming-datagram>, error-code>;
+ /// Create a `pollable` which will resolve once the stream is ready to receive again.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+
+ @since(version = 0.2.0)
+ resource outgoing-datagram-stream {
+ /// Check readiness for sending. This function never blocks.
+ ///
+ /// Returns the number of datagrams permitted for the next call to `send`,
+ /// or an error. Calling `send` with more datagrams than this function has
+ /// permitted will trap.
+ ///
+ /// When this function returns ok(0), the `subscribe` pollable will
+ /// become ready when this function will report at least ok(1), or an
+ /// error.
+ ///
+ /// Never returns `would-block`.
+ check-send: func() -> result<u64, error-code>;
+ /// Send messages on the socket.
+ ///
+ /// This function attempts to send all provided `datagrams` on the socket without blocking and
+ /// returns how many messages were actually sent (or queued for sending). This function never
+ /// returns `error(would-block)`. If none of the datagrams were able to be sent, `ok(0)` is returned.
+ ///
+ /// This function semantically behaves the same as iterating the `datagrams` list and sequentially
+ /// sending each individual datagram until either the end of the list has been reached or the first error occurred.
+ /// If at least one datagram has been sent successfully, this function never returns an error.
+ ///
+ /// If the input list is empty, the function returns `ok(0)`.
+ ///
+ /// Each call to `send` must be permitted by a preceding `check-send`. Implementations must trap if
+ /// either `check-send` was not called or `datagrams` contains more items than `check-send` permitted.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `stream`. (EISCONN)
+ /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/send.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
+ @since(version = 0.2.0)
+ send: func(datagrams: list<outgoing-datagram>) -> result<u64, error-code>;
+ /// Create a `pollable` which will resolve once the stream is ready to send again.
+ ///
+ /// Note: this function is here for WASI 0.2 only.
+ /// It's planned to be removed when `future` is natively supported in Preview3.
+ @since(version = 0.2.0)
+ subscribe: func() -> pollable;
+ }
+}
+
+@since(version = 0.2.0)
+interface udp-create-socket {
+ @since(version = 0.2.0)
+ use network.{network, error-code, ip-address-family};
+ @since(version = 0.2.0)
+ use udp.{udp-socket};
+
+ /// Create a new UDP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// This function does not require a network capability handle. This is considered to be safe because
+ /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind` is called,
+ /// the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
+ ///
+ /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
+ /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.2.0)
+ create-udp-socket: func(address-family: ip-address-family) -> result<udp-socket, error-code>;
+}
+
+@since(version = 0.2.0)
+world imports {
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import network;
+ @since(version = 0.2.0)
+ import instance-network;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import udp;
+ @since(version = 0.2.0)
+ import udp-create-socket;
+ @since(version = 0.2.0)
+ import wasi:io/[email protected];
+ @since(version = 0.2.0)
+ import wasi:clocks/[email protected];
+ @since(version = 0.2.0)
+ import tcp;
+ @since(version = 0.2.0)
+ import tcp-create-socket;
+ @since(version = 0.2.0)
+ import ip-name-lookup;
+}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/instance-network.wit b/crates/wasi/src/p2/wit/deps/sockets/instance-network.wit
deleted file mode 100644
index 5f6e6c1cc9..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/instance-network.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-
-/// This interface provides a value-export of the default network handle..
-@since(version = 0.2.0)
-interface instance-network {
- @since(version = 0.2.0)
- use network.{network};
-
- /// Get a handle to the default network.
- @since(version = 0.2.0)
- instance-network: func() -> network;
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/ip-name-lookup.wit b/crates/wasi/src/p2/wit/deps/sockets/ip-name-lookup.wit
deleted file mode 100644
index ee6419e7da..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/ip-name-lookup.wit
+++ /dev/null
@@ -1,56 +0,0 @@
-@since(version = 0.2.0)
-interface ip-name-lookup {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
- @since(version = 0.2.0)
- use network.{network, error-code, ip-address};
-
- /// Resolve an internet host name to a list of IP addresses.
- ///
- /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
- /// If the input is an IP address string, the address is parsed and returned
- /// as-is without making any external requests.
- ///
- /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
- ///
- /// This function never blocks. It either immediately fails or immediately
- /// returns successfully with a `resolve-address-stream` that can be used
- /// to (asynchronously) fetch the results.
- ///
- /// # Typical errors
- /// - `invalid-argument`: `name` is a syntactically invalid domain name or IP address.
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
- /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
- @since(version = 0.2.0)
- resolve-addresses: func(network: borrow<network>, name: string) -> result<resolve-address-stream, error-code>;
-
- @since(version = 0.2.0)
- resource resolve-address-stream {
- /// Returns the next address from the resolver.
- ///
- /// This function should be called multiple times. On each call, it will
- /// return the next address in connection order preference. If all
- /// addresses have been exhausted, this function returns `none`.
- ///
- /// This function never returns IPv4-mapped IPv6 addresses.
- ///
- /// # Typical errors
- /// - `name-unresolvable`: Name does not exist or has no suitable associated IP addresses. (EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY)
- /// - `temporary-resolver-failure`: A temporary failure in name resolution occurred. (EAI_AGAIN)
- /// - `permanent-resolver-failure`: A permanent failure in name resolution occurred. (EAI_FAIL)
- /// - `would-block`: A result is not available yet. (EWOULDBLOCK, EAGAIN)
- @since(version = 0.2.0)
- resolve-next-address: func() -> result<option<ip-address>, error-code>;
-
- /// Create a `pollable` which will resolve once the stream is ready for I/O.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/network.wit b/crates/wasi/src/p2/wit/deps/sockets/network.wit
deleted file mode 100644
index 6ca98b63bc..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/network.wit
+++ /dev/null
@@ -1,169 +0,0 @@
-@since(version = 0.2.0)
-interface network {
- @unstable(feature = network-error-code)
- use wasi:io/[email protected].{error};
-
- /// An opaque resource that represents access to (a subset of) the network.
- /// This enables context-based security for networking.
- /// There is no need for this to map 1:1 to a physical network interface.
- @since(version = 0.2.0)
- resource network;
-
- /// Error codes.
- ///
- /// In theory, every API can return any error code.
- /// In practice, API's typically only return the errors documented per API
- /// combined with a couple of errors that are always possible:
- /// - `unknown`
- /// - `access-denied`
- /// - `not-supported`
- /// - `out-of-memory`
- /// - `concurrency-conflict`
- ///
- /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
- @since(version = 0.2.0)
- enum error-code {
- /// Unknown error
- unknown,
-
- /// Access denied.
- ///
- /// POSIX equivalent: EACCES, EPERM
- access-denied,
-
- /// The operation is not supported.
- ///
- /// POSIX equivalent: EOPNOTSUPP
- not-supported,
-
- /// One of the arguments is invalid.
- ///
- /// POSIX equivalent: EINVAL
- invalid-argument,
-
- /// Not enough memory to complete the operation.
- ///
- /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
- out-of-memory,
-
- /// The operation timed out before it could finish completely.
- timeout,
-
- /// This operation is incompatible with another asynchronous operation that is already in progress.
- ///
- /// POSIX equivalent: EALREADY
- concurrency-conflict,
-
- /// Trying to finish an asynchronous operation that:
- /// - has not been started yet, or:
- /// - was already finished by a previous `finish-*` call.
- ///
- /// Note: this is scheduled to be removed when `future`s are natively supported.
- not-in-progress,
-
- /// The operation has been aborted because it could not be completed immediately.
- ///
- /// Note: this is scheduled to be removed when `future`s are natively supported.
- would-block,
-
-
- /// The operation is not valid in the socket's current state.
- invalid-state,
-
- /// A new socket resource could not be created because of a system limit.
- new-socket-limit,
-
- /// A bind operation failed because the provided address is not an address that the `network` can bind to.
- address-not-bindable,
-
- /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
- address-in-use,
-
- /// The remote address is not reachable
- remote-unreachable,
-
-
- /// The TCP connection was forcefully rejected
- connection-refused,
-
- /// The TCP connection was reset.
- connection-reset,
-
- /// A TCP connection was aborted.
- connection-aborted,
-
-
- /// The size of a datagram sent to a UDP socket exceeded the maximum
- /// supported size.
- datagram-too-large,
-
-
- /// Name does not exist or has no suitable associated IP addresses.
- name-unresolvable,
-
- /// A temporary failure in name resolution occurred.
- temporary-resolver-failure,
-
- /// A permanent failure in name resolution occurred.
- permanent-resolver-failure,
- }
-
- /// Attempts to extract a network-related `error-code` from the stream
- /// `error` provided.
- ///
- /// Stream operations which return `stream-error::last-operation-failed`
- /// have a payload with more information about the operation that failed.
- /// This payload can be passed through to this function to see if there's
- /// network-related information about the error to return.
- ///
- /// Note that this function is fallible because not all stream-related
- /// errors are network-related errors.
- @unstable(feature = network-error-code)
- network-error-code: func(err: borrow<error>) -> option<error-code>;
-
- @since(version = 0.2.0)
- enum ip-address-family {
- /// Similar to `AF_INET` in POSIX.
- ipv4,
-
- /// Similar to `AF_INET6` in POSIX.
- ipv6,
- }
-
- @since(version = 0.2.0)
- type ipv4-address = tuple<u8, u8, u8, u8>;
- @since(version = 0.2.0)
- type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
-
- @since(version = 0.2.0)
- variant ip-address {
- ipv4(ipv4-address),
- ipv6(ipv6-address),
- }
-
- @since(version = 0.2.0)
- record ipv4-socket-address {
- /// sin_port
- port: u16,
- /// sin_addr
- address: ipv4-address,
- }
-
- @since(version = 0.2.0)
- record ipv6-socket-address {
- /// sin6_port
- port: u16,
- /// sin6_flowinfo
- flow-info: u32,
- /// sin6_addr
- address: ipv6-address,
- /// sin6_scope_id
- scope-id: u32,
- }
-
- @since(version = 0.2.0)
- variant ip-socket-address {
- ipv4(ipv4-socket-address),
- ipv6(ipv6-socket-address),
- }
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/tcp-create-socket.wit b/crates/wasi/src/p2/wit/deps/sockets/tcp-create-socket.wit
deleted file mode 100644
index eedbd30768..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/tcp-create-socket.wit
+++ /dev/null
@@ -1,30 +0,0 @@
-@since(version = 0.2.0)
-interface tcp-create-socket {
- @since(version = 0.2.0)
- use network.{network, error-code, ip-address-family};
- @since(version = 0.2.0)
- use tcp.{tcp-socket};
-
- /// Create a new TCP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// This function does not require a network capability handle. This is considered to be safe because
- /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind`/`connect`
- /// is called, the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
- ///
- /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
- ///
- /// # Typical errors
- /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
- /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.2.0)
- create-tcp-socket: func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/tcp.wit b/crates/wasi/src/p2/wit/deps/sockets/tcp.wit
deleted file mode 100644
index beefd7b465..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/tcp.wit
+++ /dev/null
@@ -1,387 +0,0 @@
-@since(version = 0.2.0)
-interface tcp {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{input-stream, output-stream};
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
- @since(version = 0.2.0)
- use wasi:clocks/[email protected].{duration};
- @since(version = 0.2.0)
- use network.{network, error-code, ip-socket-address, ip-address-family};
-
- @since(version = 0.2.0)
- enum shutdown-type {
- /// Similar to `SHUT_RD` in POSIX.
- receive,
-
- /// Similar to `SHUT_WR` in POSIX.
- send,
-
- /// Similar to `SHUT_RDWR` in POSIX.
- both,
- }
-
- /// A TCP socket resource.
- ///
- /// The socket can be in one of the following states:
- /// - `unbound`
- /// - `bind-in-progress`
- /// - `bound` (See note below)
- /// - `listen-in-progress`
- /// - `listening`
- /// - `connect-in-progress`
- /// - `connected`
- /// - `closed`
- /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md>
- /// for more information.
- ///
- /// Note: Except where explicitly mentioned, whenever this documentation uses
- /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
- /// (i.e. `bound`, `listen-in-progress`, `listening`, `connect-in-progress` or `connected`)
- ///
- /// In addition to the general error codes documented on the
- /// `network::error-code` type, TCP socket methods may always return
- /// `error(invalid-state)` when in the `closed` state.
- @since(version = 0.2.0)
- resource tcp-socket {
- /// Bind the socket to a specific network on the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
- ///
- /// Bind can be attempted multiple times on the same socket, even with
- /// different arguments on each iteration. But never concurrently and
- /// only as long as the previous bind failed. Once a bind succeeds, the
- /// binding can't be changed anymore.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
- /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
- /// - `not-in-progress`: A `bind` operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
- /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
- /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
- /// and SO_REUSEADDR performs something different entirely.
- ///
- /// Unlike in POSIX, in WASI the bind operation is async. This enables
- /// interactive WASI hosts to inject permission prompts. Runtimes that
- /// don't want to make use of this ability can simply call the native
- /// `bind` as part of either `start-bind` or `finish-bind`.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.2.0)
- start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-bind: func() -> result<_, error-code>;
-
- /// Connect to a remote endpoint.
- ///
- /// On success:
- /// - the socket is transitioned into the `connected` state.
- /// - a pair of streams is returned that can be used to read & write to the connection
- ///
- /// After a failed connection attempt, the socket will be in the `closed`
- /// state and the only valid action left is to `drop` the socket. A single
- /// socket can not be used to connect more than once.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
- /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
- /// - `invalid-argument`: The socket is already attached to a different network. The `network` passed to `connect` must be identical to the one passed to `bind`.
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
- /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
- /// - `timeout`: Connection timed out. (ETIMEDOUT)
- /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- /// - `not-in-progress`: A connect operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// The POSIX equivalent of `start-connect` is the regular `connect` syscall.
- /// Because all WASI sockets are non-blocking this is expected to return
- /// EINPROGRESS, which should be translated to `ok()` in WASI.
- ///
- /// The POSIX equivalent of `finish-connect` is a `poll` for event `POLLOUT`
- /// with a timeout of 0 on the socket descriptor. Followed by a check for
- /// the `SO_ERROR` socket option, in case the poll signaled readiness.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.2.0)
- start-connect: func(network: borrow<network>, remote-address: ip-socket-address) -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-connect: func() -> result<tuple<input-stream, output-stream>, error-code>;
-
- /// Start listening for new connections.
- ///
- /// Transitions the socket into the `listening` state.
- ///
- /// Unlike POSIX, the socket must already be explicitly bound.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address. (EDESTADDRREQ)
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
- /// - `invalid-state`: The socket is already in the `listening` state.
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
- /// - `not-in-progress`: A listen operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// Unlike in POSIX, in WASI the listen operation is async. This enables
- /// interactive WASI hosts to inject permission prompts. Runtimes that
- /// don't want to make use of this ability can simply call the native
- /// `listen` as part of either `start-listen` or `finish-listen`.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
- /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
- @since(version = 0.2.0)
- start-listen: func() -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-listen: func() -> result<_, error-code>;
-
- /// Accept a new client socket.
- ///
- /// The returned socket is bound and in the `connected` state. The following properties are inherited from the listener socket:
- /// - `address-family`
- /// - `keep-alive-enabled`
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// - `hop-limit`
- /// - `receive-buffer-size`
- /// - `send-buffer-size`
- ///
- /// On success, this function returns the newly accepted client socket along with
- /// a pair of streams that can be used to read & write to the connection.
- ///
- /// # Typical errors
- /// - `invalid-state`: Socket is not in the `listening` state. (EINVAL)
- /// - `would-block`: No pending connections at the moment. (EWOULDBLOCK, EAGAIN)
- /// - `connection-aborted`: An incoming connection was pending, but was terminated by the client before this listener could accept it. (ECONNABORTED)
- /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
- /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
- @since(version = 0.2.0)
- accept: func() -> result<tuple<tcp-socket, input-stream, output-stream>, error-code>;
-
- /// Get the bound local address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.2.0)
- local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the remote address.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.2.0)
- remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether the socket is in the `listening` state.
- ///
- /// Equivalent to the SO_ACCEPTCONN socket option.
- @since(version = 0.2.0)
- is-listening: func() -> bool;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.2.0)
- address-family: func() -> ip-address-family;
-
- /// Hints the desired listen queue size. Implementations are free to ignore this.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- ///
- /// # Typical errors
- /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
- /// - `invalid-argument`: (set) The provided value was 0.
- /// - `invalid-state`: (set) The socket is in the `connect-in-progress` or `connected` state.
- @since(version = 0.2.0)
- set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
-
- /// Enables or disables keepalive.
- ///
- /// The keepalive behavior can be adjusted using:
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
- ///
- /// Equivalent to the SO_KEEPALIVE socket option.
- @since(version = 0.2.0)
- keep-alive-enabled: func() -> result<bool, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
-
- /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- keep-alive-idle-time: func() -> result<duration, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
-
- /// The time between keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPINTVL socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- keep-alive-interval: func() -> result<duration, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
-
- /// The maximum amount of keepalive packets TCP should send before aborting the connection.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPCNT socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- keep-alive-count: func() -> result<u32, error-code>;
- @since(version = 0.2.0)
- set-keep-alive-count: func(value: u32) -> result<_, error-code>;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.2.0)
- hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.2.0)
- set-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.2.0)
- send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
-
- /// Create a `pollable` which can be used to poll for, or block on,
- /// completion of any of the asynchronous operations of this socket.
- ///
- /// When `finish-bind`, `finish-listen`, `finish-connect` or `accept`
- /// return `error(would-block)`, this pollable can be used to wait for
- /// their success or failure, after which the method can be retried.
- ///
- /// The pollable is not limited to the async operation that happens to be
- /// in progress at the time of calling `subscribe` (if any). Theoretically,
- /// `subscribe` only has to be called once per socket and can then be
- /// (re)used for the remainder of the socket's lifetime.
- ///
- /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md#pollable-readiness>
- /// for more information.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
-
- /// Initiate a graceful shutdown.
- ///
- /// - `receive`: The socket is not expecting to receive any data from
- /// the peer. The `input-stream` associated with this socket will be
- /// closed. Any data still in the receive queue at time of calling
- /// this method will be discarded.
- /// - `send`: The socket has no more data to send to the peer. The `output-stream`
- /// associated with this socket will be closed and a FIN packet will be sent.
- /// - `both`: Same effect as `receive` & `send` combined.
- ///
- /// This function is idempotent; shutting down a direction more than once
- /// has no effect and returns `ok`.
- ///
- /// The shutdown function does not close (drop) the socket.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/shutdown.html>
- /// - <https://man7.org/linux/man-pages/man2/shutdown.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-shutdown>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=shutdown&sektion=2>
- @since(version = 0.2.0)
- shutdown: func(shutdown-type: shutdown-type) -> result<_, error-code>;
- }
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/udp-create-socket.wit b/crates/wasi/src/p2/wit/deps/sockets/udp-create-socket.wit
deleted file mode 100644
index e8eeacbfef..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/udp-create-socket.wit
+++ /dev/null
@@ -1,30 +0,0 @@
-@since(version = 0.2.0)
-interface udp-create-socket {
- @since(version = 0.2.0)
- use network.{network, error-code, ip-address-family};
- @since(version = 0.2.0)
- use udp.{udp-socket};
-
- /// Create a new UDP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// This function does not require a network capability handle. This is considered to be safe because
- /// at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind` is called,
- /// the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
- ///
- /// All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.
- ///
- /// # Typical errors
- /// - `not-supported`: The specified `address-family` is not supported. (EAFNOSUPPORT)
- /// - `new-socket-limit`: The new socket resource could not be created because of a system limit. (EMFILE, ENFILE)
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.2.0)
- create-udp-socket: func(address-family: ip-address-family) -> result<udp-socket, error-code>;
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/udp.wit b/crates/wasi/src/p2/wit/deps/sockets/udp.wit
deleted file mode 100644
index 9dbe6932dd..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/udp.wit
+++ /dev/null
@@ -1,288 +0,0 @@
-@since(version = 0.2.0)
-interface udp {
- @since(version = 0.2.0)
- use wasi:io/[email protected].{pollable};
- @since(version = 0.2.0)
- use network.{network, error-code, ip-socket-address, ip-address-family};
-
- /// A received datagram.
- @since(version = 0.2.0)
- record incoming-datagram {
- /// The payload.
- ///
- /// Theoretical max size: ~64 KiB. In practice, typically less than 1500 bytes.
- data: list<u8>,
-
- /// The source address.
- ///
- /// This field is guaranteed to match the remote address the stream was initialized with, if any.
- ///
- /// Equivalent to the `src_addr` out parameter of `recvfrom`.
- remote-address: ip-socket-address,
- }
-
- /// A datagram to be sent out.
- @since(version = 0.2.0)
- record outgoing-datagram {
- /// The payload.
- data: list<u8>,
-
- /// The destination address.
- ///
- /// The requirements on this field depend on how the stream was initialized:
- /// - with a remote address: this field must be None or match the stream's remote address exactly.
- /// - without a remote address: this field is required.
- ///
- /// If this value is None, the send operation is equivalent to `send` in POSIX. Otherwise it is equivalent to `sendto`.
- remote-address: option<ip-socket-address>,
- }
-
- /// A UDP socket handle.
- @since(version = 0.2.0)
- resource udp-socket {
- /// Bind the socket to a specific network on the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the port is zero, the socket will be bound to a random free port.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
- /// - `not-in-progress`: A `bind` operation is not in progress.
- /// - `would-block`: Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
- ///
- /// # Implementors note
- /// Unlike in POSIX, in WASI the bind operation is async. This enables
- /// interactive WASI hosts to inject permission prompts. Runtimes that
- /// don't want to make use of this ability can simply call the native
- /// `bind` as part of either `start-bind` or `finish-bind`.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.2.0)
- start-bind: func(network: borrow<network>, local-address: ip-socket-address) -> result<_, error-code>;
- @since(version = 0.2.0)
- finish-bind: func() -> result<_, error-code>;
-
- /// Set up inbound & outbound communication channels, optionally to a specific peer.
- ///
- /// This function only changes the local socket configuration and does not generate any network traffic.
- /// On success, the `remote-address` of the socket is updated. The `local-address` may be updated as well,
- /// based on the best network path to `remote-address`.
- ///
- /// When a `remote-address` is provided, the returned streams are limited to communicating with that specific peer:
- /// - `send` can only be used to send to this destination.
- /// - `receive` will only return datagrams sent from the provided `remote-address`.
- ///
- /// This method may be called multiple times on the same socket to change its association, but
- /// only the most recently returned pair of streams will be operational. Implementations may trap if
- /// the streams returned by a previous invocation haven't been dropped yet before calling `stream` again.
- ///
- /// The POSIX equivalent in pseudo-code is:
- /// ```text
- /// if (was previously connected) {
- /// connect(s, AF_UNSPEC)
- /// }
- /// if (remote_address is Some) {
- /// connect(s, remote_address)
- /// }
- /// ```
- ///
- /// Unlike in POSIX, the socket must already be explicitly bound.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-state`: The socket is not bound.
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.2.0)
- %stream: func(remote-address: option<ip-socket-address>) -> result<tuple<incoming-datagram-stream, outgoing-datagram-stream>, error-code>;
-
- /// Get the current bound address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.2.0)
- local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the address the socket is currently streaming to.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not streaming to a specific remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.2.0)
- remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.2.0)
- address-family: func() -> ip-address-family;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.2.0)
- unicast-hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.2.0)
- set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.2.0)
- receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.2.0)
- send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.2.0)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
-
- /// Create a `pollable` which will resolve once the socket is ready for I/O.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
- @since(version = 0.2.0)
- resource incoming-datagram-stream {
- /// Receive messages on the socket.
- ///
- /// This function attempts to receive up to `max-results` datagrams on the socket without blocking.
- /// The returned list may contain fewer elements than requested, but never more.
- ///
- /// This function returns successfully with an empty list when either:
- /// - `max-results` is 0, or:
- /// - `max-results` is greater than 0, but no results are immediately available.
- /// This function never returns `error(would-block)`.
- ///
- /// # Typical errors
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
- /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
- /// - <https://learn.microsoft.com/en-us/previous-versions/windows/desktop/legacy/ms741687(v=vs.85)>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
- @since(version = 0.2.0)
- receive: func(max-results: u64) -> result<list<incoming-datagram>, error-code>;
-
- /// Create a `pollable` which will resolve once the stream is ready to receive again.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-
- @since(version = 0.2.0)
- resource outgoing-datagram-stream {
- /// Check readiness for sending. This function never blocks.
- ///
- /// Returns the number of datagrams permitted for the next call to `send`,
- /// or an error. Calling `send` with more datagrams than this function has
- /// permitted will trap.
- ///
- /// When this function returns ok(0), the `subscribe` pollable will
- /// become ready when this function will report at least ok(1), or an
- /// error.
- ///
- /// Never returns `would-block`.
- check-send: func() -> result<u64, error-code>;
-
- /// Send messages on the socket.
- ///
- /// This function attempts to send all provided `datagrams` on the socket without blocking and
- /// returns how many messages were actually sent (or queued for sending). This function never
- /// returns `error(would-block)`. If none of the datagrams were able to be sent, `ok(0)` is returned.
- ///
- /// This function semantically behaves the same as iterating the `datagrams` list and sequentially
- /// sending each individual datagram until either the end of the list has been reached or the first error occurred.
- /// If at least one datagram has been sent successfully, this function never returns an error.
- ///
- /// If the input list is empty, the function returns `ok(0)`.
- ///
- /// Each call to `send` must be permitted by a preceding `check-send`. Implementations must trap if
- /// either `check-send` was not called or `datagrams` contains more items than `check-send` permitted.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `stream`. (EISCONN)
- /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/send.2.html>
- /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
- @since(version = 0.2.0)
- send: func(datagrams: list<outgoing-datagram>) -> result<u64, error-code>;
-
- /// Create a `pollable` which will resolve once the stream is ready to send again.
- ///
- /// Note: this function is here for WASI 0.2 only.
- /// It's planned to be removed when `future` is natively supported in Preview3.
- @since(version = 0.2.0)
- subscribe: func() -> pollable;
- }
-}
diff --git a/crates/wasi/src/p2/wit/deps/sockets/world.wit b/crates/wasi/src/p2/wit/deps/sockets/world.wit
deleted file mode 100644
index e86f02cec6..0000000000
--- a/crates/wasi/src/p2/wit/deps/sockets/world.wit
+++ /dev/null
@@ -1,19 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.2.0)
-world imports {
- @since(version = 0.2.0)
- import instance-network;
- @since(version = 0.2.0)
- import network;
- @since(version = 0.2.0)
- import udp;
- @since(version = 0.2.0)
- import udp-create-socket;
- @since(version = 0.2.0)
- import tcp;
- @since(version = 0.2.0)
- import tcp-create-socket;
- @since(version = 0.2.0)
- import ip-name-lookup;
-}
diff --git a/crates/wasi/src/p3/wit/deps/cli.wit b/crates/wasi/src/p3/wit/deps/cli.wit
new file mode 100644
index 0000000000..5bee32e5a5
--- /dev/null
+++ b/crates/wasi/src/p3/wit/deps/cli.wit
@@ -0,0 +1,256 @@
+package wasi:[email protected];
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface environment {
+ /// Get the POSIX-style environment variables.
+ ///
+ /// Each environment variable is provided as a pair of string variable names
+ /// and string value.
+ ///
+ /// Morally, these are a value import, but until value imports are available
+ /// in the component model, this import function should return the same
+ /// values each time it is called.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-environment: func() -> list<tuple<string, string>>;
+
+ /// Get the POSIX-style arguments to the program.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-arguments: func() -> list<string>;
+
+ /// Return a path that programs should use as their initial current working
+ /// directory, interpreting `.` as shorthand for this.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-initial-cwd: func() -> option<string>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface exit {
+ /// Exit the current instance and any linked instances.
+ @since(version = 0.3.0-rc-2025-09-16)
+ exit: func(status: result);
+
+ /// Exit the current instance and any linked instances, reporting the
+ /// specified status code to the host.
+ ///
+ /// The meaning of the code depends on the context, with 0 usually meaning
+ /// "success", and other values indicating various types of failure.
+ ///
+ /// This function does not return; the effect is analogous to a trap, but
+ /// without the connotation that something bad has happened.
+ @unstable(feature = cli-exit-with-code)
+ exit-with-code: func(status-code: u8);
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface run {
+ /// Run the program.
+ @since(version = 0.3.0-rc-2025-09-16)
+ run: async func() -> result;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum error-code {
+ /// Input/output error
+ io,
+ /// Invalid or incomplete multibyte or wide character
+ illegal-byte-sequence,
+ /// Broken pipe
+ pipe,
+ }
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface stdin {
+ use types.{error-code};
+
+ /// Return a stream for reading from stdin.
+ ///
+ /// This function returns a stream which provides data read from stdin,
+ /// and a future to signal read results.
+ ///
+ /// If the stream's readable end is dropped the future will resolve to success.
+ ///
+ /// If the stream's writable end is dropped the future will either resolve to
+ /// success if stdin was closed by the writer or to an error-code if reading
+ /// failed for some other reason.
+ ///
+ /// Multiple streams may be active at the same time. The behavior of concurrent
+ /// reads is implementation-specific.
+ @since(version = 0.3.0-rc-2025-09-16)
+ read-via-stream: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface stdout {
+ use types.{error-code};
+
+ /// Write the given stream to stdout.
+ ///
+ /// If the stream's writable end is dropped this function will either return
+ /// success once the entire contents of the stream have been written or an
+ /// error-code representing a failure.
+ ///
+ /// Otherwise if there is an error the readable end of the stream will be
+ /// dropped and this function will return an error-code.
+ @since(version = 0.3.0-rc-2025-09-16)
+ write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface stderr {
+ use types.{error-code};
+
+ /// Write the given stream to stderr.
+ ///
+ /// If the stream's writable end is dropped this function will either return
+ /// success once the entire contents of the stream have been written or an
+ /// error-code representing a failure.
+ ///
+ /// Otherwise if there is an error the readable end of the stream will be
+ /// dropped and this function will return an error-code.
+ @since(version = 0.3.0-rc-2025-09-16)
+ write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
+}
+
+/// Terminal input.
+///
+/// In the future, this may include functions for disabling echoing,
+/// disabling input buffering so that keyboard events are sent through
+/// immediately, querying supported features, and so on.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-input {
+ /// The input side of a terminal.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource terminal-input;
+}
+
+/// Terminal output.
+///
+/// In the future, this may include functions for querying the terminal
+/// size, being notified of terminal size changes, querying supported
+/// features, and so on.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-output {
+ /// The output side of a terminal.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource terminal-output;
+}
+
+/// An interface providing an optional `terminal-input` for stdin as a
+/// link-time authority.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-stdin {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use terminal-input.{terminal-input};
+
+ /// If stdin is connected to a terminal, return a `terminal-input` handle
+ /// allowing further interaction with it.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-terminal-stdin: func() -> option<terminal-input>;
+}
+
+/// An interface providing an optional `terminal-output` for stdout as a
+/// link-time authority.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-stdout {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use terminal-output.{terminal-output};
+
+ /// If stdout is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-terminal-stdout: func() -> option<terminal-output>;
+}
+
+/// An interface providing an optional `terminal-output` for stderr as a
+/// link-time authority.
+@since(version = 0.3.0-rc-2025-09-16)
+interface terminal-stderr {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use terminal-output.{terminal-output};
+
+ /// If stderr is connected to a terminal, return a `terminal-output` handle
+ /// allowing further interaction with it.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-terminal-stderr: func() -> option<terminal-output>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import environment;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import exit;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stderr;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-input;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-output;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stderr;
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+}
+@since(version = 0.3.0-rc-2025-09-16)
+world command {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import environment;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import exit;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import stderr;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-input;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-output;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdin;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stdout;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import terminal-stderr;
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ import wasi:clocks/[email protected];
+ @unstable(feature = clocks-timezone)
+ import wasi:clocks/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:filesystem/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:sockets/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+ import wasi:random/[email protected];
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ export run;
+}
diff --git a/crates/wasi/src/p3/wit/deps/cli/command.wit b/crates/wasi/src/p3/wit/deps/cli/command.wit
deleted file mode 100644
index f2f613e552..0000000000
--- a/crates/wasi/src/p3/wit/deps/cli/command.wit
+++ /dev/null
@@ -1,10 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world command {
- @since(version = 0.3.0-rc-2025-09-16)
- include imports;
-
- @since(version = 0.3.0-rc-2025-09-16)
- export run;
-}
diff --git a/crates/wasi/src/p3/wit/deps/cli/environment.wit b/crates/wasi/src/p3/wit/deps/cli/environment.wit
deleted file mode 100644
index 3763f2f6ce..0000000000
--- a/crates/wasi/src/p3/wit/deps/cli/environment.wit
+++ /dev/null
@@ -1,22 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface environment {
- /// Get the POSIX-style environment variables.
- ///
- /// Each environment variable is provided as a pair of string variable names
- /// and string value.
- ///
- /// Morally, these are a value import, but until value imports are available
- /// in the component model, this import function should return the same
- /// values each time it is called.
- @since(version = 0.3.0-rc-2025-09-16)
- get-environment: func() -> list<tuple<string, string>>;
-
- /// Get the POSIX-style arguments to the program.
- @since(version = 0.3.0-rc-2025-09-16)
- get-arguments: func() -> list<string>;
-
- /// Return a path that programs should use as their initial current working
- /// directory, interpreting `.` as shorthand for this.
- @since(version = 0.3.0-rc-2025-09-16)
- get-initial-cwd: func() -> option<string>;
-}
diff --git a/crates/wasi/src/p3/wit/deps/cli/exit.wit b/crates/wasi/src/p3/wit/deps/cli/exit.wit
deleted file mode 100644
index 1efba7d683..0000000000
--- a/crates/wasi/src/p3/wit/deps/cli/exit.wit
+++ /dev/null
@@ -1,17 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface exit {
- /// Exit the current instance and any linked instances.
- @since(version = 0.3.0-rc-2025-09-16)
- exit: func(status: result);
-
- /// Exit the current instance and any linked instances, reporting the
- /// specified status code to the host.
- ///
- /// The meaning of the code depends on the context, with 0 usually meaning
- /// "success", and other values indicating various types of failure.
- ///
- /// This function does not return; the effect is analogous to a trap, but
- /// without the connotation that something bad has happened.
- @unstable(feature = cli-exit-with-code)
- exit-with-code: func(status-code: u8);
-}
diff --git a/crates/wasi/src/p3/wit/deps/cli/imports.wit b/crates/wasi/src/p3/wit/deps/cli/imports.wit
deleted file mode 100644
index 660a2dd95a..0000000000
--- a/crates/wasi/src/p3/wit/deps/cli/imports.wit
+++ /dev/null
@@ -1,34 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:clocks/[email protected];
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:filesystem/[email protected];
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:sockets/[email protected];
- @since(version = 0.3.0-rc-2025-09-16)
- include wasi:random/[email protected];
-
- @since(version = 0.3.0-rc-2025-09-16)
- import environment;
- @since(version = 0.3.0-rc-2025-09-16)
- import exit;
- @since(version = 0.3.0-rc-2025-09-16)
- import stdin;
- @since(version = 0.3.0-rc-2025-09-16)
- import stdout;
- @since(version = 0.3.0-rc-2025-09-16)
- import stderr;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-input;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-output;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-stdin;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-stdout;
- @since(version = 0.3.0-rc-2025-09-16)
- import terminal-stderr;
-}
diff --git a/crates/wasi/src/p3/wit/deps/cli/run.wit b/crates/wasi/src/p3/wit/deps/cli/run.wit
deleted file mode 100644
index 631441a3f2..0000000000
--- a/crates/wasi/src/p3/wit/deps/cli/run.wit
+++ /dev/null
@@ -1,6 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface run {
- /// Run the program.
- @since(version = 0.3.0-rc-2025-09-16)
- run: async func() -> result;
-}
diff --git a/crates/wasi/src/p3/wit/deps/cli/stdio.wit b/crates/wasi/src/p3/wit/deps/cli/stdio.wit
deleted file mode 100644
index 51e5ae4b40..0000000000
--- a/crates/wasi/src/p3/wit/deps/cli/stdio.wit
+++ /dev/null
@@ -1,65 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- @since(version = 0.3.0-rc-2025-09-16)
- enum error-code {
- /// Input/output error
- io,
- /// Invalid or incomplete multibyte or wide character
- illegal-byte-sequence,
- /// Broken pipe
- pipe,
- }
-}
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface stdin {
- use types.{error-code};
-
- /// Return a stream for reading from stdin.
- ///
- /// This function returns a stream which provides data read from stdin,
- /// and a future to signal read results.
- ///
- /// If the stream's readable end is dropped the future will resolve to success.
- ///
- /// If the stream's writable end is dropped the future will either resolve to
- /// success if stdin was closed by the writer or to an error-code if reading
- /// failed for some other reason.
- ///
- /// Multiple streams may be active at the same time. The behavior of concurrent
- /// reads is implementation-specific.
- @since(version = 0.3.0-rc-2025-09-16)
- read-via-stream: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
-}
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface stdout {
- use types.{error-code};
-
- /// Write the given stream to stdout.
- ///
- /// If the stream's writable end is dropped this function will either return
- /// success once the entire contents of the stream have been written or an
- /// error-code representing a failure.
- ///
- /// Otherwise if there is an error the readable end of the stream will be
- /// dropped and this function will return an error-code.
- @since(version = 0.3.0-rc-2025-09-16)
- write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
-}
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface stderr {
- use types.{error-code};
-
- /// Write the given stream to stderr.
- ///
- /// If the stream's writable end is dropped this function will either return
- /// success once the entire contents of the stream have been written or an
- /// error-code representing a failure.
- ///
- /// Otherwise if there is an error the readable end of the stream will be
- /// dropped and this function will return an error-code.
- @since(version = 0.3.0-rc-2025-09-16)
- write-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
-}
diff --git a/crates/wasi/src/p3/wit/deps/cli/terminal.wit b/crates/wasi/src/p3/wit/deps/cli/terminal.wit
deleted file mode 100644
index 74c17694a4..0000000000
--- a/crates/wasi/src/p3/wit/deps/cli/terminal.wit
+++ /dev/null
@@ -1,62 +0,0 @@
-/// Terminal input.
-///
-/// In the future, this may include functions for disabling echoing,
-/// disabling input buffering so that keyboard events are sent through
-/// immediately, querying supported features, and so on.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-input {
- /// The input side of a terminal.
- @since(version = 0.3.0-rc-2025-09-16)
- resource terminal-input;
-}
-
-/// Terminal output.
-///
-/// In the future, this may include functions for querying the terminal
-/// size, being notified of terminal size changes, querying supported
-/// features, and so on.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-output {
- /// The output side of a terminal.
- @since(version = 0.3.0-rc-2025-09-16)
- resource terminal-output;
-}
-
-/// An interface providing an optional `terminal-input` for stdin as a
-/// link-time authority.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-stdin {
- @since(version = 0.3.0-rc-2025-09-16)
- use terminal-input.{terminal-input};
-
- /// If stdin is connected to a terminal, return a `terminal-input` handle
- /// allowing further interaction with it.
- @since(version = 0.3.0-rc-2025-09-16)
- get-terminal-stdin: func() -> option<terminal-input>;
-}
-
-/// An interface providing an optional `terminal-output` for stdout as a
-/// link-time authority.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-stdout {
- @since(version = 0.3.0-rc-2025-09-16)
- use terminal-output.{terminal-output};
-
- /// If stdout is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.3.0-rc-2025-09-16)
- get-terminal-stdout: func() -> option<terminal-output>;
-}
-
-/// An interface providing an optional `terminal-output` for stderr as a
-/// link-time authority.
-@since(version = 0.3.0-rc-2025-09-16)
-interface terminal-stderr {
- @since(version = 0.3.0-rc-2025-09-16)
- use terminal-output.{terminal-output};
-
- /// If stderr is connected to a terminal, return a `terminal-output` handle
- /// allowing further interaction with it.
- @since(version = 0.3.0-rc-2025-09-16)
- get-terminal-stderr: func() -> option<terminal-output>;
-}
diff --git a/crates/wasi/src/p3/wit/deps/clocks.wit b/crates/wasi/src/p3/wit/deps/clocks.wit
new file mode 100644
index 0000000000..8e631f9a5d
--- /dev/null
+++ b/crates/wasi/src/p3/wit/deps/clocks.wit
@@ -0,0 +1,163 @@
+package wasi:[email protected];
+
+/// This interface common types used throughout wasi:clocks.
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ /// A duration of time, in nanoseconds.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type duration = u64;
+}
+
+/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
+/// time.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A monotonic clock is a clock which has an unspecified initial value, and
+/// successive reads of the clock will produce non-decreasing values.
+@since(version = 0.3.0-rc-2025-09-16)
+interface monotonic-clock {
+ use types.{duration};
+
+ /// An instant in time, in nanoseconds. An instant is relative to an
+ /// unspecified initial value, and can only be compared to instances from
+ /// the same monotonic-clock.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type instant = u64;
+
+ /// Read the current value of the clock.
+ ///
+ /// The clock is monotonic, therefore calling this function repeatedly will
+ /// produce a sequence of non-decreasing values.
+ ///
+ /// For completeness, this function traps if it's not possible to represent
+ /// the value of the clock in an `instant`. Consequently, implementations
+ /// should ensure that the starting time is low enough to avoid the
+ /// possibility of overflow in practice.
+ @since(version = 0.3.0-rc-2025-09-16)
+ now: func() -> instant;
+
+ /// Query the resolution of the clock. Returns the duration of time
+ /// corresponding to a clock tick.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-resolution: func() -> duration;
+
+ /// Wait until the specified instant has occurred.
+ @since(version = 0.3.0-rc-2025-09-16)
+ wait-until: async func(when: instant);
+
+ /// Wait for the specified duration to elapse.
+ @since(version = 0.3.0-rc-2025-09-16)
+ wait-for: async func(how-long: duration);
+}
+
+/// WASI Wall Clock is a clock API intended to let users query the current
+/// time. The name "wall" makes an analogy to a "clock on the wall", which
+/// is not necessarily monotonic as it may be reset.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+///
+/// A wall clock is a clock which measures the date and time according to
+/// some external reference.
+///
+/// External references may be reset, so this clock is not necessarily
+/// monotonic, making it unsuitable for measuring elapsed time.
+///
+/// It is intended for reporting the current date and time for humans.
+@since(version = 0.3.0-rc-2025-09-16)
+interface wall-clock {
+ /// A time and date in seconds plus nanoseconds.
+ @since(version = 0.3.0-rc-2025-09-16)
+ record datetime {
+ seconds: u64,
+ nanoseconds: u32,
+ }
+
+ /// Read the current value of the clock.
+ ///
+ /// This clock is not monotonic, therefore calling this function repeatedly
+ /// will not necessarily produce a sequence of non-decreasing values.
+ ///
+ /// The returned timestamps represent the number of seconds since
+ /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
+ /// also known as [Unix Time].
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ ///
+ /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
+ /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
+ @since(version = 0.3.0-rc-2025-09-16)
+ now: func() -> datetime;
+
+ /// Query the resolution of the clock.
+ ///
+ /// The nanoseconds field of the output is always less than 1000000000.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-resolution: func() -> datetime;
+}
+
+@unstable(feature = clocks-timezone)
+interface timezone {
+ @unstable(feature = clocks-timezone)
+ use wall-clock.{datetime};
+
+ /// Information useful for displaying the timezone of a specific `datetime`.
+ ///
+ /// This information may vary within a single `timezone` to reflect daylight
+ /// saving time adjustments.
+ @unstable(feature = clocks-timezone)
+ record timezone-display {
+ /// The number of seconds difference between UTC time and the local
+ /// time of the timezone.
+ ///
+ /// The returned value will always be less than 86400 which is the
+ /// number of seconds in a day (24*60*60).
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return 0.
+ utc-offset: s32,
+ /// The abbreviated name of the timezone to display to a user. The name
+ /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
+ /// reference local standards for the name of the time zone.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should be the string `UTC`.
+ ///
+ /// In time zones that do not have an applicable name, a formatted
+ /// representation of the UTC offset may be returned, such as `-04:00`.
+ name: string,
+ /// Whether daylight saving time is active.
+ ///
+ /// In implementations that do not expose an actual time zone, this
+ /// should return false.
+ in-daylight-saving-time: bool,
+ }
+
+ /// Return information needed to display the given `datetime`. This includes
+ /// the UTC offset, the time zone name, and a flag indicating whether
+ /// daylight saving time is active.
+ ///
+ /// If the timezone cannot be determined for the given `datetime`, return a
+ /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
+ /// saving time.
+ @unstable(feature = clocks-timezone)
+ display: func(when: datetime) -> timezone-display;
+
+ /// The same as `display`, but only return the UTC offset.
+ @unstable(feature = clocks-timezone)
+ utc-offset: func(when: datetime) -> s32;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import monotonic-clock;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wall-clock;
+ @unstable(feature = clocks-timezone)
+ import timezone;
+}
diff --git a/crates/wasi/src/p3/wit/deps/clocks/monotonic-clock.wit b/crates/wasi/src/p3/wit/deps/clocks/monotonic-clock.wit
deleted file mode 100644
index a91d495c6c..0000000000
--- a/crates/wasi/src/p3/wit/deps/clocks/monotonic-clock.wit
+++ /dev/null
@@ -1,48 +0,0 @@
-package wasi:[email protected];
-/// WASI Monotonic Clock is a clock API intended to let users measure elapsed
-/// time.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A monotonic clock is a clock which has an unspecified initial value, and
-/// successive reads of the clock will produce non-decreasing values.
-@since(version = 0.3.0-rc-2025-09-16)
-interface monotonic-clock {
- use types.{duration};
-
- /// An instant in time, in nanoseconds. An instant is relative to an
- /// unspecified initial value, and can only be compared to instances from
- /// the same monotonic-clock.
- @since(version = 0.3.0-rc-2025-09-16)
- type instant = u64;
-
- /// Read the current value of the clock.
- ///
- /// The clock is monotonic, therefore calling this function repeatedly will
- /// produce a sequence of non-decreasing values.
- ///
- /// For completeness, this function traps if it's not possible to represent
- /// the value of the clock in an `instant`. Consequently, implementations
- /// should ensure that the starting time is low enough to avoid the
- /// possibility of overflow in practice.
- @since(version = 0.3.0-rc-2025-09-16)
- now: func() -> instant;
-
- /// Query the resolution of the clock. Returns the duration of time
- /// corresponding to a clock tick.
- @since(version = 0.3.0-rc-2025-09-16)
- get-resolution: func() -> duration;
-
- /// Wait until the specified instant has occurred.
- @since(version = 0.3.0-rc-2025-09-16)
- wait-until: async func(
- when: instant,
- );
-
- /// Wait for the specified duration to elapse.
- @since(version = 0.3.0-rc-2025-09-16)
- wait-for: async func(
- how-long: duration,
- );
-}
diff --git a/crates/wasi/src/p3/wit/deps/clocks/timezone.wit b/crates/wasi/src/p3/wit/deps/clocks/timezone.wit
deleted file mode 100644
index ab8f5c0801..0000000000
--- a/crates/wasi/src/p3/wit/deps/clocks/timezone.wit
+++ /dev/null
@@ -1,55 +0,0 @@
-package wasi:[email protected];
-
-@unstable(feature = clocks-timezone)
-interface timezone {
- @unstable(feature = clocks-timezone)
- use wall-clock.{datetime};
-
- /// Return information needed to display the given `datetime`. This includes
- /// the UTC offset, the time zone name, and a flag indicating whether
- /// daylight saving time is active.
- ///
- /// If the timezone cannot be determined for the given `datetime`, return a
- /// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
- /// saving time.
- @unstable(feature = clocks-timezone)
- display: func(when: datetime) -> timezone-display;
-
- /// The same as `display`, but only return the UTC offset.
- @unstable(feature = clocks-timezone)
- utc-offset: func(when: datetime) -> s32;
-
- /// Information useful for displaying the timezone of a specific `datetime`.
- ///
- /// This information may vary within a single `timezone` to reflect daylight
- /// saving time adjustments.
- @unstable(feature = clocks-timezone)
- record timezone-display {
- /// The number of seconds difference between UTC time and the local
- /// time of the timezone.
- ///
- /// The returned value will always be less than 86400 which is the
- /// number of seconds in a day (24*60*60).
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return 0.
- utc-offset: s32,
-
- /// The abbreviated name of the timezone to display to a user. The name
- /// `UTC` indicates Coordinated Universal Time. Otherwise, this should
- /// reference local standards for the name of the time zone.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should be the string `UTC`.
- ///
- /// In time zones that do not have an applicable name, a formatted
- /// representation of the UTC offset may be returned, such as `-04:00`.
- name: string,
-
- /// Whether daylight saving time is active.
- ///
- /// In implementations that do not expose an actual time zone, this
- /// should return false.
- in-daylight-saving-time: bool,
- }
-}
diff --git a/crates/wasi/src/p3/wit/deps/clocks/types.wit b/crates/wasi/src/p3/wit/deps/clocks/types.wit
deleted file mode 100644
index aff7c2a22a..0000000000
--- a/crates/wasi/src/p3/wit/deps/clocks/types.wit
+++ /dev/null
@@ -1,8 +0,0 @@
-package wasi:[email protected];
-/// This interface common types used throughout wasi:clocks.
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- /// A duration of time, in nanoseconds.
- @since(version = 0.3.0-rc-2025-09-16)
- type duration = u64;
-}
diff --git a/crates/wasi/src/p3/wit/deps/clocks/wall-clock.wit b/crates/wasi/src/p3/wit/deps/clocks/wall-clock.wit
deleted file mode 100644
index ea940500fa..0000000000
--- a/crates/wasi/src/p3/wit/deps/clocks/wall-clock.wit
+++ /dev/null
@@ -1,46 +0,0 @@
-package wasi:[email protected];
-/// WASI Wall Clock is a clock API intended to let users query the current
-/// time. The name "wall" makes an analogy to a "clock on the wall", which
-/// is not necessarily monotonic as it may be reset.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-///
-/// A wall clock is a clock which measures the date and time according to
-/// some external reference.
-///
-/// External references may be reset, so this clock is not necessarily
-/// monotonic, making it unsuitable for measuring elapsed time.
-///
-/// It is intended for reporting the current date and time for humans.
-@since(version = 0.3.0-rc-2025-09-16)
-interface wall-clock {
- /// A time and date in seconds plus nanoseconds.
- @since(version = 0.3.0-rc-2025-09-16)
- record datetime {
- seconds: u64,
- nanoseconds: u32,
- }
-
- /// Read the current value of the clock.
- ///
- /// This clock is not monotonic, therefore calling this function repeatedly
- /// will not necessarily produce a sequence of non-decreasing values.
- ///
- /// The returned timestamps represent the number of seconds since
- /// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch],
- /// also known as [Unix Time].
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- ///
- /// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16
- /// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time
- @since(version = 0.3.0-rc-2025-09-16)
- now: func() -> datetime;
-
- /// Query the resolution of the clock.
- ///
- /// The nanoseconds field of the output is always less than 1000000000.
- @since(version = 0.3.0-rc-2025-09-16)
- get-resolution: func() -> datetime;
-}
diff --git a/crates/wasi/src/p3/wit/deps/clocks/world.wit b/crates/wasi/src/p3/wit/deps/clocks/world.wit
deleted file mode 100644
index a6b885f070..0000000000
--- a/crates/wasi/src/p3/wit/deps/clocks/world.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import monotonic-clock;
- @since(version = 0.3.0-rc-2025-09-16)
- import wall-clock;
- @unstable(feature = clocks-timezone)
- import timezone;
-}
diff --git a/crates/wasi/src/p3/wit/deps/filesystem.wit b/crates/wasi/src/p3/wit/deps/filesystem.wit
new file mode 100644
index 0000000000..94c87628d0
--- /dev/null
+++ b/crates/wasi/src/p3/wit/deps/filesystem.wit
@@ -0,0 +1,551 @@
+package wasi:[email protected];
+
+/// WASI filesystem is a filesystem API primarily intended to let users run WASI
+/// programs that access their files on their existing filesystems, without
+/// significant overhead.
+///
+/// It is intended to be roughly portable between Unix-family platforms and
+/// Windows, though it does not hide many of the major differences.
+///
+/// Paths are passed as interface-type `string`s, meaning they must consist of
+/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
+/// paths which are not accessible by this API.
+///
+/// The directory separator in WASI is always the forward-slash (`/`).
+///
+/// All paths in WASI are relative paths, and are interpreted relative to a
+/// `descriptor` referring to a base directory. If a `path` argument to any WASI
+/// function starts with `/`, or if any step of resolving a `path`, including
+/// `..` and symbolic link steps, reaches a directory outside of the base
+/// directory, or reaches a symlink to an absolute or rooted path in the
+/// underlying filesystem, the function fails with `error-code::not-permitted`.
+///
+/// For more information about WASI path resolution and sandboxing, see
+/// [WASI filesystem path resolution].
+///
+/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use wasi:clocks/[email protected].{datetime};
+
+ /// File size or length of a region within a file.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type filesize = u64;
+
+ /// The type of a filesystem object referenced by a descriptor.
+ ///
+ /// Note: This was called `filetype` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum descriptor-type {
+ /// The type of the descriptor or file is unknown or is different from
+ /// any of the other types specified.
+ unknown,
+ /// The descriptor refers to a block device inode.
+ block-device,
+ /// The descriptor refers to a character device inode.
+ character-device,
+ /// The descriptor refers to a directory inode.
+ directory,
+ /// The descriptor refers to a named pipe.
+ fifo,
+ /// The file refers to a symbolic link inode.
+ symbolic-link,
+ /// The descriptor refers to a regular file inode.
+ regular-file,
+ /// The descriptor refers to a socket.
+ socket,
+ }
+
+ /// Descriptor flags.
+ ///
+ /// Note: This was called `fdflags` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ flags descriptor-flags {
+ /// Read mode: Data can be read.
+ read,
+ /// Write mode: Data can be written to.
+ write,
+ /// Request that writes be performed according to synchronized I/O file
+ /// integrity completion. The data stored in the file and the file's
+ /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ file-integrity-sync,
+ /// Request that writes be performed according to synchronized I/O data
+ /// integrity completion. Only the data stored in the file is
+ /// synchronized. This is similar to `O_DSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ data-integrity-sync,
+ /// Requests that reads be performed at the same level of integrity
+ /// requested for writes. This is similar to `O_RSYNC` in POSIX.
+ ///
+ /// The precise semantics of this operation have not yet been defined for
+ /// WASI. At this time, it should be interpreted as a request, and not a
+ /// requirement.
+ requested-write-sync,
+ /// Mutating directories mode: Directory contents may be mutated.
+ ///
+ /// When this flag is unset on a descriptor, operations using the
+ /// descriptor which would create, rename, delete, modify the data or
+ /// metadata of filesystem objects, or obtain another handle which
+ /// would permit any of those, shall fail with `error-code::read-only` if
+ /// they would otherwise succeed.
+ ///
+ /// This may only be set on directories.
+ mutate-directory,
+ }
+
+ /// Flags determining the method of how paths are resolved.
+ @since(version = 0.3.0-rc-2025-09-16)
+ flags path-flags {
+ /// As long as the resolved path corresponds to a symbolic link, it is
+ /// expanded.
+ symlink-follow,
+ }
+
+ /// Open flags used by `open-at`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ flags open-flags {
+ /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
+ create,
+ /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
+ directory,
+ /// Fail if file already exists, similar to `O_EXCL` in POSIX.
+ exclusive,
+ /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
+ truncate,
+ }
+
+ /// Number of hard links to an inode.
+ @since(version = 0.3.0-rc-2025-09-16)
+ type link-count = u64;
+
+ /// File attributes.
+ ///
+ /// Note: This was called `filestat` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ record descriptor-stat {
+ /// File type.
+ %type: descriptor-type,
+ /// Number of hard links to the file.
+ link-count: link-count,
+ /// For regular files, the file size in bytes. For symbolic links, the
+ /// length in bytes of the pathname contained in the symbolic link.
+ size: filesize,
+ /// Last data access timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain an access
+ /// timestamp for this file.
+ data-access-timestamp: option<datetime>,
+ /// Last data modification timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// modification timestamp for this file.
+ data-modification-timestamp: option<datetime>,
+ /// Last file status-change timestamp.
+ ///
+ /// If the `option` is none, the platform doesn't maintain a
+ /// status-change timestamp for this file.
+ status-change-timestamp: option<datetime>,
+ }
+
+ /// When setting a timestamp, this gives the value to set it to.
+ @since(version = 0.3.0-rc-2025-09-16)
+ variant new-timestamp {
+ /// Leave the timestamp set to its previous value.
+ no-change,
+ /// Set the timestamp to the current time of the system clock associated
+ /// with the filesystem.
+ now,
+ /// Set the timestamp to the given value.
+ timestamp(datetime),
+ }
+
+ /// A directory entry.
+ record directory-entry {
+ /// The type of the file referred to by this directory entry.
+ %type: descriptor-type,
+ /// The name of the object.
+ name: string,
+ }
+
+ /// Error codes returned by functions, similar to `errno` in POSIX.
+ /// Not all of these error codes are returned by the functions provided by this
+ /// API; some are used in higher-level library layers, and others are provided
+ /// merely for alignment with POSIX.
+ enum error-code {
+ /// Permission denied, similar to `EACCES` in POSIX.
+ access,
+ /// Connection already in progress, similar to `EALREADY` in POSIX.
+ already,
+ /// Bad descriptor, similar to `EBADF` in POSIX.
+ bad-descriptor,
+ /// Device or resource busy, similar to `EBUSY` in POSIX.
+ busy,
+ /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
+ deadlock,
+ /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
+ quota,
+ /// File exists, similar to `EEXIST` in POSIX.
+ exist,
+ /// File too large, similar to `EFBIG` in POSIX.
+ file-too-large,
+ /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
+ illegal-byte-sequence,
+ /// Operation in progress, similar to `EINPROGRESS` in POSIX.
+ in-progress,
+ /// Interrupted function, similar to `EINTR` in POSIX.
+ interrupted,
+ /// Invalid argument, similar to `EINVAL` in POSIX.
+ invalid,
+ /// I/O error, similar to `EIO` in POSIX.
+ io,
+ /// Is a directory, similar to `EISDIR` in POSIX.
+ is-directory,
+ /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
+ loop,
+ /// Too many links, similar to `EMLINK` in POSIX.
+ too-many-links,
+ /// Message too large, similar to `EMSGSIZE` in POSIX.
+ message-size,
+ /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
+ name-too-long,
+ /// No such device, similar to `ENODEV` in POSIX.
+ no-device,
+ /// No such file or directory, similar to `ENOENT` in POSIX.
+ no-entry,
+ /// No locks available, similar to `ENOLCK` in POSIX.
+ no-lock,
+ /// Not enough space, similar to `ENOMEM` in POSIX.
+ insufficient-memory,
+ /// No space left on device, similar to `ENOSPC` in POSIX.
+ insufficient-space,
+ /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
+ not-directory,
+ /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
+ not-empty,
+ /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
+ not-recoverable,
+ /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
+ unsupported,
+ /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
+ no-tty,
+ /// No such device or address, similar to `ENXIO` in POSIX.
+ no-such-device,
+ /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
+ overflow,
+ /// Operation not permitted, similar to `EPERM` in POSIX.
+ not-permitted,
+ /// Broken pipe, similar to `EPIPE` in POSIX.
+ pipe,
+ /// Read-only file system, similar to `EROFS` in POSIX.
+ read-only,
+ /// Invalid seek, similar to `ESPIPE` in POSIX.
+ invalid-seek,
+ /// Text file busy, similar to `ETXTBSY` in POSIX.
+ text-file-busy,
+ /// Cross-device link, similar to `EXDEV` in POSIX.
+ cross-device,
+ }
+
+ /// File or memory access pattern advisory information.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum advice {
+ /// The application has no advice to give on its behavior with respect
+ /// to the specified data.
+ normal,
+ /// The application expects to access the specified data sequentially
+ /// from lower offsets to higher offsets.
+ sequential,
+ /// The application expects to access the specified data in a random
+ /// order.
+ random,
+ /// The application expects to access the specified data in the near
+ /// future.
+ will-need,
+ /// The application expects that it will not access the specified data
+ /// in the near future.
+ dont-need,
+ /// The application expects to access the specified data once and then
+ /// not reuse it thereafter.
+ no-reuse,
+ }
+
+ /// A 128-bit hash value, split into parts because wasm doesn't have a
+ /// 128-bit integer type.
+ @since(version = 0.3.0-rc-2025-09-16)
+ record metadata-hash-value {
+ /// 64 bits of a 128-bit hash value.
+ lower: u64,
+ /// Another 64 bits of a 128-bit hash value.
+ upper: u64,
+ }
+
+ /// A descriptor is a reference to a filesystem object, which may be a file,
+ /// directory, named pipe, special file, or other object on which filesystem
+ /// calls may be made.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource descriptor {
+ /// Return a stream for reading from a file.
+ ///
+ /// Multiple read, write, and append streams may be active on the same open
+ /// file and they do not interfere with each other.
+ ///
+ /// This function returns a `stream` which provides the data received from the
+ /// file, and a `future` providing additional error information in case an
+ /// error is encountered.
+ ///
+ /// If no error is encountered, `stream.read` on the `stream` will return
+ /// `read-status::closed` with no `error-context` and the future resolves to
+ /// the value `ok`. If an error is encountered, `stream.read` on the
+ /// `stream` returns `read-status::closed` with an `error-context` and the future
+ /// resolves to `err` with an `error-code`.
+ ///
+ /// Note: This is similar to `pread` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ read-via-stream: func(offset: filesize) -> tuple<stream<u8>, future<result<_, error-code>>>;
+ /// Return a stream for writing to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be written.
+ ///
+ /// It is valid to write past the end of a file; the file is extended to the
+ /// extent of the write, with bytes between the previous end and the start of
+ /// the write set to zero.
+ ///
+ /// This function returns once either full contents of the stream are
+ /// written or an error is encountered.
+ ///
+ /// Note: This is similar to `pwrite` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ write-via-stream: async func(data: stream<u8>, offset: filesize) -> result<_, error-code>;
+ /// Return a stream for appending to a file, if available.
+ ///
+ /// May fail with an error-code describing why the file cannot be appended.
+ ///
+ /// This function returns once either full contents of the stream are
+ /// written or an error is encountered.
+ ///
+ /// Note: This is similar to `write` with `O_APPEND` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ append-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
+ /// Provide file advisory information on a descriptor.
+ ///
+ /// This is similar to `posix_fadvise` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ advise: async func(offset: filesize, length: filesize, advice: advice) -> result<_, error-code>;
+ /// Synchronize the data of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fdatasync` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ sync-data: async func() -> result<_, error-code>;
+ /// Get flags associated with a descriptor.
+ ///
+ /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_flags` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-flags: async func() -> result<descriptor-flags, error-code>;
+ /// Get the dynamic type of a descriptor.
+ ///
+ /// Note: This returns the same value as the `type` field of the `fd-stat`
+ /// returned by `stat`, `stat-at` and similar.
+ ///
+ /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
+ /// by `fstat` in POSIX.
+ ///
+ /// Note: This returns the value that was the `fs_filetype` value returned
+ /// from `fdstat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-type: async func() -> result<descriptor-type, error-code>;
+ /// Adjust the size of an open file. If this increases the file's size, the
+ /// extra bytes are filled with zeros.
+ ///
+ /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-size: async func(size: filesize) -> result<_, error-code>;
+ /// Adjust the timestamps of an open file or directory.
+ ///
+ /// Note: This is similar to `futimens` in POSIX.
+ ///
+ /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-times: async func(data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Read directory entries from a directory.
+ ///
+ /// On filesystems where directories contain entries referring to themselves
+ /// and their parents, often named `.` and `..` respectively, these entries
+ /// are omitted.
+ ///
+ /// This always returns a new stream which starts at the beginning of the
+ /// directory. Multiple streams may be active on the same directory, and they
+ /// do not interfere with each other.
+ ///
+ /// This function returns a future, which will resolve to an error code if
+ /// reading full contents of the directory fails.
+ @since(version = 0.3.0-rc-2025-09-16)
+ read-directory: async func() -> tuple<stream<directory-entry>, future<result<_, error-code>>>;
+ /// Synchronize the data and metadata of a file to disk.
+ ///
+ /// This function succeeds with no effect if the file descriptor is not
+ /// opened for writing.
+ ///
+ /// Note: This is similar to `fsync` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ sync: async func() -> result<_, error-code>;
+ /// Create a directory.
+ ///
+ /// Note: This is similar to `mkdirat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ create-directory-at: async func(path: string) -> result<_, error-code>;
+ /// Return the attributes of an open file or directory.
+ ///
+ /// Note: This is similar to `fstat` in POSIX, except that it does not return
+ /// device and inode information. For testing whether two descriptors refer to
+ /// the same underlying filesystem object, use `is-same-object`. To obtain
+ /// additional data that can be used do determine whether a file has been
+ /// modified, use `metadata-hash`.
+ ///
+ /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ stat: async func() -> result<descriptor-stat, error-code>;
+ /// Return the attributes of a file or directory.
+ ///
+ /// Note: This is similar to `fstatat` in POSIX, except that it does not
+ /// return device and inode information. See the `stat` description for a
+ /// discussion of alternatives.
+ ///
+ /// Note: This was called `path_filestat_get` in earlier versions of WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ stat-at: async func(path-flags: path-flags, path: string) -> result<descriptor-stat, error-code>;
+ /// Adjust the timestamps of a file or directory.
+ ///
+ /// Note: This is similar to `utimensat` in POSIX.
+ ///
+ /// Note: This was called `path_filestat_set_times` in earlier versions of
+ /// WASI.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-times-at: async func(path-flags: path-flags, path: string, data-access-timestamp: new-timestamp, data-modification-timestamp: new-timestamp) -> result<_, error-code>;
+ /// Create a hard link.
+ ///
+ /// Fails with `error-code::no-entry` if the old path does not exist,
+ /// with `error-code::exist` if the new path already exists, and
+ /// `error-code::not-permitted` if the old path is not a file.
+ ///
+ /// Note: This is similar to `linkat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ link-at: async func(old-path-flags: path-flags, old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Open a file or directory.
+ ///
+ /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
+ /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
+ /// `open-at` fails with `error-code::read-only`.
+ ///
+ /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
+ /// contains `truncate` or `create`, and the base descriptor doesn't have
+ /// `descriptor-flags::mutate-directory` set, `open-at` fails with
+ /// `error-code::read-only`.
+ ///
+ /// Note: This is similar to `openat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ open-at: async func(path-flags: path-flags, path: string, open-flags: open-flags, %flags: descriptor-flags) -> result<descriptor, error-code>;
+ /// Read the contents of a symbolic link.
+ ///
+ /// If the contents contain an absolute or rooted path in the underlying
+ /// filesystem, this function fails with `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `readlinkat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ readlink-at: async func(path: string) -> result<string, error-code>;
+ /// Remove a directory.
+ ///
+ /// Return `error-code::not-empty` if the directory is not empty.
+ ///
+ /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ remove-directory-at: async func(path: string) -> result<_, error-code>;
+ /// Rename a filesystem object.
+ ///
+ /// Note: This is similar to `renameat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ rename-at: async func(old-path: string, new-descriptor: borrow<descriptor>, new-path: string) -> result<_, error-code>;
+ /// Create a symbolic link (also known as a "symlink").
+ ///
+ /// If `old-path` starts with `/`, the function fails with
+ /// `error-code::not-permitted`.
+ ///
+ /// Note: This is similar to `symlinkat` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ symlink-at: async func(old-path: string, new-path: string) -> result<_, error-code>;
+ /// Unlink a filesystem object that is not a directory.
+ ///
+ /// Return `error-code::is-directory` if the path refers to a directory.
+ /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
+ @since(version = 0.3.0-rc-2025-09-16)
+ unlink-file-at: async func(path: string) -> result<_, error-code>;
+ /// Test whether two descriptors refer to the same filesystem object.
+ ///
+ /// In POSIX, this corresponds to testing whether the two descriptors have the
+ /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
+ /// wasi-filesystem does not expose device and inode numbers, so this function
+ /// may be used instead.
+ @since(version = 0.3.0-rc-2025-09-16)
+ is-same-object: async func(other: borrow<descriptor>) -> bool;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a descriptor.
+ ///
+ /// This returns a hash of the last-modification timestamp and file size, and
+ /// may also include the inode number, device number, birth timestamp, and
+ /// other metadata fields that may change when the file is modified or
+ /// replaced. It may also include a secret value chosen by the
+ /// implementation and not otherwise exposed.
+ ///
+ /// Implementations are encouraged to provide the following properties:
+ ///
+ /// - If the file is not modified or replaced, the computed hash value should
+ /// usually not change.
+ /// - If the object is modified or replaced, the computed hash value should
+ /// usually change.
+ /// - The inputs to the hash should not be easily computable from the
+ /// computed hash.
+ ///
+ /// However, none of these is required.
+ @since(version = 0.3.0-rc-2025-09-16)
+ metadata-hash: async func() -> result<metadata-hash-value, error-code>;
+ /// Return a hash of the metadata associated with a filesystem object referred
+ /// to by a directory descriptor and a relative path.
+ ///
+ /// This performs the same hash computation as `metadata-hash`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ metadata-hash-at: async func(path-flags: path-flags, path: string) -> result<metadata-hash-value, error-code>;
+ }
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface preopens {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use types.{descriptor};
+
+ /// Return the set of preopened directories, and their paths.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-directories: func() -> list<tuple<descriptor, string>>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wasi:clocks/[email protected];
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import preopens;
+}
diff --git a/crates/wasi/src/p3/wit/deps/filesystem/preopens.wit b/crates/wasi/src/p3/wit/deps/filesystem/preopens.wit
deleted file mode 100644
index 9036e90e88..0000000000
--- a/crates/wasi/src/p3/wit/deps/filesystem/preopens.wit
+++ /dev/null
@@ -1,11 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-interface preopens {
- @since(version = 0.3.0-rc-2025-09-16)
- use types.{descriptor};
-
- /// Return the set of preopened directories, and their paths.
- @since(version = 0.3.0-rc-2025-09-16)
- get-directories: func() -> list<tuple<descriptor, string>>;
-}
diff --git a/crates/wasi/src/p3/wit/deps/filesystem/types.wit b/crates/wasi/src/p3/wit/deps/filesystem/types.wit
deleted file mode 100644
index 41d91beee5..0000000000
--- a/crates/wasi/src/p3/wit/deps/filesystem/types.wit
+++ /dev/null
@@ -1,636 +0,0 @@
-package wasi:[email protected];
-/// WASI filesystem is a filesystem API primarily intended to let users run WASI
-/// programs that access their files on their existing filesystems, without
-/// significant overhead.
-///
-/// It is intended to be roughly portable between Unix-family platforms and
-/// Windows, though it does not hide many of the major differences.
-///
-/// Paths are passed as interface-type `string`s, meaning they must consist of
-/// a sequence of Unicode Scalar Values (USVs). Some filesystems may contain
-/// paths which are not accessible by this API.
-///
-/// The directory separator in WASI is always the forward-slash (`/`).
-///
-/// All paths in WASI are relative paths, and are interpreted relative to a
-/// `descriptor` referring to a base directory. If a `path` argument to any WASI
-/// function starts with `/`, or if any step of resolving a `path`, including
-/// `..` and symbolic link steps, reaches a directory outside of the base
-/// directory, or reaches a symlink to an absolute or rooted path in the
-/// underlying filesystem, the function fails with `error-code::not-permitted`.
-///
-/// For more information about WASI path resolution and sandboxing, see
-/// [WASI filesystem path resolution].
-///
-/// [WASI filesystem path resolution]: https://github.com/WebAssembly/wasi-filesystem/blob/main/path-resolution.md
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- @since(version = 0.3.0-rc-2025-09-16)
- use wasi:clocks/[email protected].{datetime};
-
- /// File size or length of a region within a file.
- @since(version = 0.3.0-rc-2025-09-16)
- type filesize = u64;
-
- /// The type of a filesystem object referenced by a descriptor.
- ///
- /// Note: This was called `filetype` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- enum descriptor-type {
- /// The type of the descriptor or file is unknown or is different from
- /// any of the other types specified.
- unknown,
- /// The descriptor refers to a block device inode.
- block-device,
- /// The descriptor refers to a character device inode.
- character-device,
- /// The descriptor refers to a directory inode.
- directory,
- /// The descriptor refers to a named pipe.
- fifo,
- /// The file refers to a symbolic link inode.
- symbolic-link,
- /// The descriptor refers to a regular file inode.
- regular-file,
- /// The descriptor refers to a socket.
- socket,
- }
-
- /// Descriptor flags.
- ///
- /// Note: This was called `fdflags` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- flags descriptor-flags {
- /// Read mode: Data can be read.
- read,
- /// Write mode: Data can be written to.
- write,
- /// Request that writes be performed according to synchronized I/O file
- /// integrity completion. The data stored in the file and the file's
- /// metadata are synchronized. This is similar to `O_SYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- file-integrity-sync,
- /// Request that writes be performed according to synchronized I/O data
- /// integrity completion. Only the data stored in the file is
- /// synchronized. This is similar to `O_DSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- data-integrity-sync,
- /// Requests that reads be performed at the same level of integrity
- /// requested for writes. This is similar to `O_RSYNC` in POSIX.
- ///
- /// The precise semantics of this operation have not yet been defined for
- /// WASI. At this time, it should be interpreted as a request, and not a
- /// requirement.
- requested-write-sync,
- /// Mutating directories mode: Directory contents may be mutated.
- ///
- /// When this flag is unset on a descriptor, operations using the
- /// descriptor which would create, rename, delete, modify the data or
- /// metadata of filesystem objects, or obtain another handle which
- /// would permit any of those, shall fail with `error-code::read-only` if
- /// they would otherwise succeed.
- ///
- /// This may only be set on directories.
- mutate-directory,
- }
-
- /// File attributes.
- ///
- /// Note: This was called `filestat` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- record descriptor-stat {
- /// File type.
- %type: descriptor-type,
- /// Number of hard links to the file.
- link-count: link-count,
- /// For regular files, the file size in bytes. For symbolic links, the
- /// length in bytes of the pathname contained in the symbolic link.
- size: filesize,
- /// Last data access timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain an access
- /// timestamp for this file.
- data-access-timestamp: option<datetime>,
- /// Last data modification timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// modification timestamp for this file.
- data-modification-timestamp: option<datetime>,
- /// Last file status-change timestamp.
- ///
- /// If the `option` is none, the platform doesn't maintain a
- /// status-change timestamp for this file.
- status-change-timestamp: option<datetime>,
- }
-
- /// Flags determining the method of how paths are resolved.
- @since(version = 0.3.0-rc-2025-09-16)
- flags path-flags {
- /// As long as the resolved path corresponds to a symbolic link, it is
- /// expanded.
- symlink-follow,
- }
-
- /// Open flags used by `open-at`.
- @since(version = 0.3.0-rc-2025-09-16)
- flags open-flags {
- /// Create file if it does not exist, similar to `O_CREAT` in POSIX.
- create,
- /// Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
- directory,
- /// Fail if file already exists, similar to `O_EXCL` in POSIX.
- exclusive,
- /// Truncate file to size 0, similar to `O_TRUNC` in POSIX.
- truncate,
- }
-
- /// Number of hard links to an inode.
- @since(version = 0.3.0-rc-2025-09-16)
- type link-count = u64;
-
- /// When setting a timestamp, this gives the value to set it to.
- @since(version = 0.3.0-rc-2025-09-16)
- variant new-timestamp {
- /// Leave the timestamp set to its previous value.
- no-change,
- /// Set the timestamp to the current time of the system clock associated
- /// with the filesystem.
- now,
- /// Set the timestamp to the given value.
- timestamp(datetime),
- }
-
- /// A directory entry.
- record directory-entry {
- /// The type of the file referred to by this directory entry.
- %type: descriptor-type,
-
- /// The name of the object.
- name: string,
- }
-
- /// Error codes returned by functions, similar to `errno` in POSIX.
- /// Not all of these error codes are returned by the functions provided by this
- /// API; some are used in higher-level library layers, and others are provided
- /// merely for alignment with POSIX.
- enum error-code {
- /// Permission denied, similar to `EACCES` in POSIX.
- access,
- /// Connection already in progress, similar to `EALREADY` in POSIX.
- already,
- /// Bad descriptor, similar to `EBADF` in POSIX.
- bad-descriptor,
- /// Device or resource busy, similar to `EBUSY` in POSIX.
- busy,
- /// Resource deadlock would occur, similar to `EDEADLK` in POSIX.
- deadlock,
- /// Storage quota exceeded, similar to `EDQUOT` in POSIX.
- quota,
- /// File exists, similar to `EEXIST` in POSIX.
- exist,
- /// File too large, similar to `EFBIG` in POSIX.
- file-too-large,
- /// Illegal byte sequence, similar to `EILSEQ` in POSIX.
- illegal-byte-sequence,
- /// Operation in progress, similar to `EINPROGRESS` in POSIX.
- in-progress,
- /// Interrupted function, similar to `EINTR` in POSIX.
- interrupted,
- /// Invalid argument, similar to `EINVAL` in POSIX.
- invalid,
- /// I/O error, similar to `EIO` in POSIX.
- io,
- /// Is a directory, similar to `EISDIR` in POSIX.
- is-directory,
- /// Too many levels of symbolic links, similar to `ELOOP` in POSIX.
- loop,
- /// Too many links, similar to `EMLINK` in POSIX.
- too-many-links,
- /// Message too large, similar to `EMSGSIZE` in POSIX.
- message-size,
- /// Filename too long, similar to `ENAMETOOLONG` in POSIX.
- name-too-long,
- /// No such device, similar to `ENODEV` in POSIX.
- no-device,
- /// No such file or directory, similar to `ENOENT` in POSIX.
- no-entry,
- /// No locks available, similar to `ENOLCK` in POSIX.
- no-lock,
- /// Not enough space, similar to `ENOMEM` in POSIX.
- insufficient-memory,
- /// No space left on device, similar to `ENOSPC` in POSIX.
- insufficient-space,
- /// Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
- not-directory,
- /// Directory not empty, similar to `ENOTEMPTY` in POSIX.
- not-empty,
- /// State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
- not-recoverable,
- /// Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
- unsupported,
- /// Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
- no-tty,
- /// No such device or address, similar to `ENXIO` in POSIX.
- no-such-device,
- /// Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
- overflow,
- /// Operation not permitted, similar to `EPERM` in POSIX.
- not-permitted,
- /// Broken pipe, similar to `EPIPE` in POSIX.
- pipe,
- /// Read-only file system, similar to `EROFS` in POSIX.
- read-only,
- /// Invalid seek, similar to `ESPIPE` in POSIX.
- invalid-seek,
- /// Text file busy, similar to `ETXTBSY` in POSIX.
- text-file-busy,
- /// Cross-device link, similar to `EXDEV` in POSIX.
- cross-device,
- }
-
- /// File or memory access pattern advisory information.
- @since(version = 0.3.0-rc-2025-09-16)
- enum advice {
- /// The application has no advice to give on its behavior with respect
- /// to the specified data.
- normal,
- /// The application expects to access the specified data sequentially
- /// from lower offsets to higher offsets.
- sequential,
- /// The application expects to access the specified data in a random
- /// order.
- random,
- /// The application expects to access the specified data in the near
- /// future.
- will-need,
- /// The application expects that it will not access the specified data
- /// in the near future.
- dont-need,
- /// The application expects to access the specified data once and then
- /// not reuse it thereafter.
- no-reuse,
- }
-
- /// A 128-bit hash value, split into parts because wasm doesn't have a
- /// 128-bit integer type.
- @since(version = 0.3.0-rc-2025-09-16)
- record metadata-hash-value {
- /// 64 bits of a 128-bit hash value.
- lower: u64,
- /// Another 64 bits of a 128-bit hash value.
- upper: u64,
- }
-
- /// A descriptor is a reference to a filesystem object, which may be a file,
- /// directory, named pipe, special file, or other object on which filesystem
- /// calls may be made.
- @since(version = 0.3.0-rc-2025-09-16)
- resource descriptor {
- /// Return a stream for reading from a file.
- ///
- /// Multiple read, write, and append streams may be active on the same open
- /// file and they do not interfere with each other.
- ///
- /// This function returns a `stream` which provides the data received from the
- /// file, and a `future` providing additional error information in case an
- /// error is encountered.
- ///
- /// If no error is encountered, `stream.read` on the `stream` will return
- /// `read-status::closed` with no `error-context` and the future resolves to
- /// the value `ok`. If an error is encountered, `stream.read` on the
- /// `stream` returns `read-status::closed` with an `error-context` and the future
- /// resolves to `err` with an `error-code`.
- ///
- /// Note: This is similar to `pread` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- read-via-stream: func(
- /// The offset within the file at which to start reading.
- offset: filesize,
- ) -> tuple<stream<u8>, future<result<_, error-code>>>;
-
- /// Return a stream for writing to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be written.
- ///
- /// It is valid to write past the end of a file; the file is extended to the
- /// extent of the write, with bytes between the previous end and the start of
- /// the write set to zero.
- ///
- /// This function returns once either full contents of the stream are
- /// written or an error is encountered.
- ///
- /// Note: This is similar to `pwrite` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- write-via-stream: async func(
- /// Data to write
- data: stream<u8>,
- /// The offset within the file at which to start writing.
- offset: filesize,
- ) -> result<_, error-code>;
-
- /// Return a stream for appending to a file, if available.
- ///
- /// May fail with an error-code describing why the file cannot be appended.
- ///
- /// This function returns once either full contents of the stream are
- /// written or an error is encountered.
- ///
- /// Note: This is similar to `write` with `O_APPEND` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- append-via-stream: async func(data: stream<u8>) -> result<_, error-code>;
-
- /// Provide file advisory information on a descriptor.
- ///
- /// This is similar to `posix_fadvise` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- advise: async func(
- /// The offset within the file to which the advisory applies.
- offset: filesize,
- /// The length of the region to which the advisory applies.
- length: filesize,
- /// The advice.
- advice: advice
- ) -> result<_, error-code>;
-
- /// Synchronize the data of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fdatasync` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- sync-data: async func() -> result<_, error-code>;
-
- /// Get flags associated with a descriptor.
- ///
- /// Note: This returns similar flags to `fcntl(fd, F_GETFL)` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_flags` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- get-flags: async func() -> result<descriptor-flags, error-code>;
-
- /// Get the dynamic type of a descriptor.
- ///
- /// Note: This returns the same value as the `type` field of the `fd-stat`
- /// returned by `stat`, `stat-at` and similar.
- ///
- /// Note: This returns similar flags to the `st_mode & S_IFMT` value provided
- /// by `fstat` in POSIX.
- ///
- /// Note: This returns the value that was the `fs_filetype` value returned
- /// from `fdstat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- get-type: async func() -> result<descriptor-type, error-code>;
-
- /// Adjust the size of an open file. If this increases the file's size, the
- /// extra bytes are filled with zeros.
- ///
- /// Note: This was called `fd_filestat_set_size` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- set-size: async func(size: filesize) -> result<_, error-code>;
-
- /// Adjust the timestamps of an open file or directory.
- ///
- /// Note: This is similar to `futimens` in POSIX.
- ///
- /// Note: This was called `fd_filestat_set_times` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- set-times: async func(
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Read directory entries from a directory.
- ///
- /// On filesystems where directories contain entries referring to themselves
- /// and their parents, often named `.` and `..` respectively, these entries
- /// are omitted.
- ///
- /// This always returns a new stream which starts at the beginning of the
- /// directory. Multiple streams may be active on the same directory, and they
- /// do not interfere with each other.
- ///
- /// This function returns a future, which will resolve to an error code if
- /// reading full contents of the directory fails.
- @since(version = 0.3.0-rc-2025-09-16)
- read-directory: async func() -> tuple<stream<directory-entry>, future<result<_, error-code>>>;
-
- /// Synchronize the data and metadata of a file to disk.
- ///
- /// This function succeeds with no effect if the file descriptor is not
- /// opened for writing.
- ///
- /// Note: This is similar to `fsync` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- sync: async func() -> result<_, error-code>;
-
- /// Create a directory.
- ///
- /// Note: This is similar to `mkdirat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- create-directory-at: async func(
- /// The relative path at which to create the directory.
- path: string,
- ) -> result<_, error-code>;
-
- /// Return the attributes of an open file or directory.
- ///
- /// Note: This is similar to `fstat` in POSIX, except that it does not return
- /// device and inode information. For testing whether two descriptors refer to
- /// the same underlying filesystem object, use `is-same-object`. To obtain
- /// additional data that can be used do determine whether a file has been
- /// modified, use `metadata-hash`.
- ///
- /// Note: This was called `fd_filestat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- stat: async func() -> result<descriptor-stat, error-code>;
-
- /// Return the attributes of a file or directory.
- ///
- /// Note: This is similar to `fstatat` in POSIX, except that it does not
- /// return device and inode information. See the `stat` description for a
- /// discussion of alternatives.
- ///
- /// Note: This was called `path_filestat_get` in earlier versions of WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- stat-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<descriptor-stat, error-code>;
-
- /// Adjust the timestamps of a file or directory.
- ///
- /// Note: This is similar to `utimensat` in POSIX.
- ///
- /// Note: This was called `path_filestat_set_times` in earlier versions of
- /// WASI.
- @since(version = 0.3.0-rc-2025-09-16)
- set-times-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to operate on.
- path: string,
- /// The desired values of the data access timestamp.
- data-access-timestamp: new-timestamp,
- /// The desired values of the data modification timestamp.
- data-modification-timestamp: new-timestamp,
- ) -> result<_, error-code>;
-
- /// Create a hard link.
- ///
- /// Fails with `error-code::no-entry` if the old path does not exist,
- /// with `error-code::exist` if the new path already exists, and
- /// `error-code::not-permitted` if the old path is not a file.
- ///
- /// Note: This is similar to `linkat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- link-at: async func(
- /// Flags determining the method of how the path is resolved.
- old-path-flags: path-flags,
- /// The relative source path from which to link.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path at which to create the hard link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Open a file or directory.
- ///
- /// If `flags` contains `descriptor-flags::mutate-directory`, and the base
- /// descriptor doesn't have `descriptor-flags::mutate-directory` set,
- /// `open-at` fails with `error-code::read-only`.
- ///
- /// If `flags` contains `write` or `mutate-directory`, or `open-flags`
- /// contains `truncate` or `create`, and the base descriptor doesn't have
- /// `descriptor-flags::mutate-directory` set, `open-at` fails with
- /// `error-code::read-only`.
- ///
- /// Note: This is similar to `openat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- open-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the object to open.
- path: string,
- /// The method by which to open the file.
- open-flags: open-flags,
- /// Flags to use for the resulting descriptor.
- %flags: descriptor-flags,
- ) -> result<descriptor, error-code>;
-
- /// Read the contents of a symbolic link.
- ///
- /// If the contents contain an absolute or rooted path in the underlying
- /// filesystem, this function fails with `error-code::not-permitted`.
- ///
- /// Note: This is similar to `readlinkat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- readlink-at: async func(
- /// The relative path of the symbolic link from which to read.
- path: string,
- ) -> result<string, error-code>;
-
- /// Remove a directory.
- ///
- /// Return `error-code::not-empty` if the directory is not empty.
- ///
- /// Note: This is similar to `unlinkat(fd, path, AT_REMOVEDIR)` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- remove-directory-at: async func(
- /// The relative path to a directory to remove.
- path: string,
- ) -> result<_, error-code>;
-
- /// Rename a filesystem object.
- ///
- /// Note: This is similar to `renameat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- rename-at: async func(
- /// The relative source path of the file or directory to rename.
- old-path: string,
- /// The base directory for `new-path`.
- new-descriptor: borrow<descriptor>,
- /// The relative destination path to which to rename the file or directory.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Create a symbolic link (also known as a "symlink").
- ///
- /// If `old-path` starts with `/`, the function fails with
- /// `error-code::not-permitted`.
- ///
- /// Note: This is similar to `symlinkat` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- symlink-at: async func(
- /// The contents of the symbolic link.
- old-path: string,
- /// The relative destination path at which to create the symbolic link.
- new-path: string,
- ) -> result<_, error-code>;
-
- /// Unlink a filesystem object that is not a directory.
- ///
- /// Return `error-code::is-directory` if the path refers to a directory.
- /// Note: This is similar to `unlinkat(fd, path, 0)` in POSIX.
- @since(version = 0.3.0-rc-2025-09-16)
- unlink-file-at: async func(
- /// The relative path to a file to unlink.
- path: string,
- ) -> result<_, error-code>;
-
- /// Test whether two descriptors refer to the same filesystem object.
- ///
- /// In POSIX, this corresponds to testing whether the two descriptors have the
- /// same device (`st_dev`) and inode (`st_ino` or `d_ino`) numbers.
- /// wasi-filesystem does not expose device and inode numbers, so this function
- /// may be used instead.
- @since(version = 0.3.0-rc-2025-09-16)
- is-same-object: async func(other: borrow<descriptor>) -> bool;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a descriptor.
- ///
- /// This returns a hash of the last-modification timestamp and file size, and
- /// may also include the inode number, device number, birth timestamp, and
- /// other metadata fields that may change when the file is modified or
- /// replaced. It may also include a secret value chosen by the
- /// implementation and not otherwise exposed.
- ///
- /// Implementations are encouraged to provide the following properties:
- ///
- /// - If the file is not modified or replaced, the computed hash value should
- /// usually not change.
- /// - If the object is modified or replaced, the computed hash value should
- /// usually change.
- /// - The inputs to the hash should not be easily computable from the
- /// computed hash.
- ///
- /// However, none of these is required.
- @since(version = 0.3.0-rc-2025-09-16)
- metadata-hash: async func() -> result<metadata-hash-value, error-code>;
-
- /// Return a hash of the metadata associated with a filesystem object referred
- /// to by a directory descriptor and a relative path.
- ///
- /// This performs the same hash computation as `metadata-hash`.
- @since(version = 0.3.0-rc-2025-09-16)
- metadata-hash-at: async func(
- /// Flags determining the method of how the path is resolved.
- path-flags: path-flags,
- /// The relative path of the file or directory to inspect.
- path: string,
- ) -> result<metadata-hash-value, error-code>;
- }
-}
diff --git a/crates/wasi/src/p3/wit/deps/filesystem/world.wit b/crates/wasi/src/p3/wit/deps/filesystem/world.wit
deleted file mode 100644
index 87fc727165..0000000000
--- a/crates/wasi/src/p3/wit/deps/filesystem/world.wit
+++ /dev/null
@@ -1,9 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import types;
- @since(version = 0.3.0-rc-2025-09-16)
- import preopens;
-}
diff --git a/crates/wasi/src/p3/wit/deps/random.wit b/crates/wasi/src/p3/wit/deps/random.wit
new file mode 100644
index 0000000000..8dfc39b11b
--- /dev/null
+++ b/crates/wasi/src/p3/wit/deps/random.wit
@@ -0,0 +1,92 @@
+package wasi:[email protected];
+
+/// The insecure-seed interface for seeding hash-map DoS resistance.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.3.0-rc-2025-09-16)
+interface insecure-seed {
+ /// Return a 128-bit value that may contain a pseudo-random value.
+ ///
+ /// The returned value is not required to be computed from a CSPRNG, and may
+ /// even be entirely deterministic. Host implementations are encouraged to
+ /// provide pseudo-random values to any program exposed to
+ /// attacker-controlled content, to enable DoS protection built into many
+ /// languages' hash-map implementations.
+ ///
+ /// This function is intended to only be called once, by a source language
+ /// to initialize Denial Of Service (DoS) protection in its hash-map
+ /// implementation.
+ ///
+ /// # Expected future evolution
+ ///
+ /// This will likely be changed to a value import, to prevent it from being
+ /// called multiple times and potentially used for purposes other than DoS
+ /// protection.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-insecure-seed: func() -> tuple<u64, u64>;
+}
+
+/// The insecure interface for insecure pseudo-random numbers.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.3.0-rc-2025-09-16)
+interface insecure {
+ /// Return `len` insecure pseudo-random bytes.
+ ///
+ /// This function is not cryptographically secure. Do not use it for
+ /// anything related to security.
+ ///
+ /// There are no requirements on the values of the returned bytes, however
+ /// implementations are encouraged to return evenly distributed values with
+ /// a long period.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-insecure-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return an insecure pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of pseudo-random data as
+ /// `get-insecure-random-bytes`, represented as a `u64`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-insecure-random-u64: func() -> u64;
+}
+
+/// WASI Random is a random data API.
+///
+/// It is intended to be portable at least between Unix-family platforms and
+/// Windows.
+@since(version = 0.3.0-rc-2025-09-16)
+interface random {
+ /// Return `len` cryptographically-secure random or pseudo-random bytes.
+ ///
+ /// This function must produce data at least as cryptographically secure and
+ /// fast as an adequately seeded cryptographically-secure pseudo-random
+ /// number generator (CSPRNG). It must not block, from the perspective of
+ /// the calling program, under any circumstances, including on the first
+ /// request and on requests for numbers of bytes. The returned data must
+ /// always be unpredictable.
+ ///
+ /// This function must always return fresh data. Deterministic environments
+ /// must omit this function, rather than implementing it with deterministic
+ /// data.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-random-bytes: func(len: u64) -> list<u8>;
+
+ /// Return a cryptographically-secure random or pseudo-random `u64` value.
+ ///
+ /// This function returns the same type of data as `get-random-bytes`,
+ /// represented as a `u64`.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-random-u64: func() -> u64;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import random;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import insecure;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import insecure-seed;
+}
diff --git a/crates/wasi/src/p3/wit/deps/random/insecure-seed.wit b/crates/wasi/src/p3/wit/deps/random/insecure-seed.wit
deleted file mode 100644
index 302151ba65..0000000000
--- a/crates/wasi/src/p3/wit/deps/random/insecure-seed.wit
+++ /dev/null
@@ -1,27 +0,0 @@
-package wasi:[email protected];
-/// The insecure-seed interface for seeding hash-map DoS resistance.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.3.0-rc-2025-09-16)
-interface insecure-seed {
- /// Return a 128-bit value that may contain a pseudo-random value.
- ///
- /// The returned value is not required to be computed from a CSPRNG, and may
- /// even be entirely deterministic. Host implementations are encouraged to
- /// provide pseudo-random values to any program exposed to
- /// attacker-controlled content, to enable DoS protection built into many
- /// languages' hash-map implementations.
- ///
- /// This function is intended to only be called once, by a source language
- /// to initialize Denial Of Service (DoS) protection in its hash-map
- /// implementation.
- ///
- /// # Expected future evolution
- ///
- /// This will likely be changed to a value import, to prevent it from being
- /// called multiple times and potentially used for purposes other than DoS
- /// protection.
- @since(version = 0.3.0-rc-2025-09-16)
- get-insecure-seed: func() -> tuple<u64, u64>;
-}
diff --git a/crates/wasi/src/p3/wit/deps/random/insecure.wit b/crates/wasi/src/p3/wit/deps/random/insecure.wit
deleted file mode 100644
index 39146e3910..0000000000
--- a/crates/wasi/src/p3/wit/deps/random/insecure.wit
+++ /dev/null
@@ -1,25 +0,0 @@
-package wasi:[email protected];
-/// The insecure interface for insecure pseudo-random numbers.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.3.0-rc-2025-09-16)
-interface insecure {
- /// Return `len` insecure pseudo-random bytes.
- ///
- /// This function is not cryptographically secure. Do not use it for
- /// anything related to security.
- ///
- /// There are no requirements on the values of the returned bytes, however
- /// implementations are encouraged to return evenly distributed values with
- /// a long period.
- @since(version = 0.3.0-rc-2025-09-16)
- get-insecure-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return an insecure pseudo-random `u64` value.
- ///
- /// This function returns the same type of pseudo-random data as
- /// `get-insecure-random-bytes`, represented as a `u64`.
- @since(version = 0.3.0-rc-2025-09-16)
- get-insecure-random-u64: func() -> u64;
-}
diff --git a/crates/wasi/src/p3/wit/deps/random/random.wit b/crates/wasi/src/p3/wit/deps/random/random.wit
deleted file mode 100644
index fa1f111dc7..0000000000
--- a/crates/wasi/src/p3/wit/deps/random/random.wit
+++ /dev/null
@@ -1,29 +0,0 @@
-package wasi:[email protected];
-/// WASI Random is a random data API.
-///
-/// It is intended to be portable at least between Unix-family platforms and
-/// Windows.
-@since(version = 0.3.0-rc-2025-09-16)
-interface random {
- /// Return `len` cryptographically-secure random or pseudo-random bytes.
- ///
- /// This function must produce data at least as cryptographically secure and
- /// fast as an adequately seeded cryptographically-secure pseudo-random
- /// number generator (CSPRNG). It must not block, from the perspective of
- /// the calling program, under any circumstances, including on the first
- /// request and on requests for numbers of bytes. The returned data must
- /// always be unpredictable.
- ///
- /// This function must always return fresh data. Deterministic environments
- /// must omit this function, rather than implementing it with deterministic
- /// data.
- @since(version = 0.3.0-rc-2025-09-16)
- get-random-bytes: func(len: u64) -> list<u8>;
-
- /// Return a cryptographically-secure random or pseudo-random `u64` value.
- ///
- /// This function returns the same type of data as `get-random-bytes`,
- /// represented as a `u64`.
- @since(version = 0.3.0-rc-2025-09-16)
- get-random-u64: func() -> u64;
-}
diff --git a/crates/wasi/src/p3/wit/deps/random/world.wit b/crates/wasi/src/p3/wit/deps/random/world.wit
deleted file mode 100644
index 08c5ed88b7..0000000000
--- a/crates/wasi/src/p3/wit/deps/random/world.wit
+++ /dev/null
@@ -1,13 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import random;
-
- @since(version = 0.3.0-rc-2025-09-16)
- import insecure;
-
- @since(version = 0.3.0-rc-2025-09-16)
- import insecure-seed;
-}
diff --git a/crates/wasi/src/p3/wit/deps/sockets.wit b/crates/wasi/src/p3/wit/deps/sockets.wit
new file mode 100644
index 0000000000..f3a7e86e2e
--- /dev/null
+++ b/crates/wasi/src/p3/wit/deps/sockets.wit
@@ -0,0 +1,754 @@
+package wasi:[email protected];
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface types {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use wasi:clocks/[email protected].{duration};
+
+ /// Error codes.
+ ///
+ /// In theory, every API can return any error code.
+ /// In practice, API's typically only return the errors documented per API
+ /// combined with a couple of errors that are always possible:
+ /// - `unknown`
+ /// - `access-denied`
+ /// - `not-supported`
+ /// - `out-of-memory`
+ ///
+ /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum error-code {
+ /// Unknown error
+ unknown,
+ /// Access denied.
+ ///
+ /// POSIX equivalent: EACCES, EPERM
+ access-denied,
+ /// The operation is not supported.
+ ///
+ /// POSIX equivalent: EOPNOTSUPP
+ not-supported,
+ /// One of the arguments is invalid.
+ ///
+ /// POSIX equivalent: EINVAL
+ invalid-argument,
+ /// Not enough memory to complete the operation.
+ ///
+ /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
+ out-of-memory,
+ /// The operation timed out before it could finish completely.
+ timeout,
+ /// The operation is not valid in the socket's current state.
+ invalid-state,
+ /// A bind operation failed because the provided address is not an address that the `network` can bind to.
+ address-not-bindable,
+ /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
+ address-in-use,
+ /// The remote address is not reachable
+ remote-unreachable,
+ /// The TCP connection was forcefully rejected
+ connection-refused,
+ /// The TCP connection was reset.
+ connection-reset,
+ /// A TCP connection was aborted.
+ connection-aborted,
+ /// The size of a datagram sent to a UDP socket exceeded the maximum
+ /// supported size.
+ datagram-too-large,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum ip-address-family {
+ /// Similar to `AF_INET` in POSIX.
+ ipv4,
+ /// Similar to `AF_INET6` in POSIX.
+ ipv6,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ type ipv4-address = tuple<u8, u8, u8, u8>;
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ variant ip-address {
+ ipv4(ipv4-address),
+ ipv6(ipv6-address),
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ record ipv4-socket-address {
+ /// sin_port
+ port: u16,
+ /// sin_addr
+ address: ipv4-address,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ record ipv6-socket-address {
+ /// sin6_port
+ port: u16,
+ /// sin6_flowinfo
+ flow-info: u32,
+ /// sin6_addr
+ address: ipv6-address,
+ /// sin6_scope_id
+ scope-id: u32,
+ }
+
+ @since(version = 0.3.0-rc-2025-09-16)
+ variant ip-socket-address {
+ ipv4(ipv4-socket-address),
+ ipv6(ipv6-socket-address),
+ }
+
+ /// A TCP socket resource.
+ ///
+ /// The socket can be in one of the following states:
+ /// - `unbound`
+ /// - `bound` (See note below)
+ /// - `listening`
+ /// - `connecting`
+ /// - `connected`
+ /// - `closed`
+ /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics-0.3.0-draft.md>
+ /// for more information.
+ ///
+ /// Note: Except where explicitly mentioned, whenever this documentation uses
+ /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
+ /// (i.e. `bound`, `listening`, `connecting` or `connected`)
+ ///
+ /// In addition to the general error codes documented on the
+ /// `types::error-code` type, TCP socket methods may always return
+ /// `error(invalid-state)` when in the `closed` state.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource tcp-socket {
+ /// Create a new TCP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// Unlike POSIX, WASI sockets have no notion of a socket-level
+ /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
+ /// async support.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ create: static func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
+ /// Bind the socket to the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
+ ///
+ /// Bind can be attempted multiple times on the same socket, even with
+ /// different arguments on each iteration. But never concurrently and
+ /// only as long as the previous bind failed. Once a bind succeeds, the
+ /// binding can't be changed anymore.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
+ /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
+ ///
+ /// # Implementors note
+ /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
+ /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
+ /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
+ /// and SO_REUSEADDR performs something different entirely.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.3.0-rc-2025-09-16)
+ bind: func(local-address: ip-socket-address) -> result<_, error-code>;
+ /// Connect to a remote endpoint.
+ ///
+ /// On success, the socket is transitioned into the `connected` state and this function returns a connection resource.
+ ///
+ /// After a failed connection attempt, the socket will be in the `closed`
+ /// state and the only valid action left is to `drop` the socket. A single
+ /// socket can not be used to connect more than once.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
+ /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
+ /// - `invalid-state`: The socket is already in the `connecting` state. (EALREADY)
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
+ /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
+ /// - `timeout`: Connection timed out. (ETIMEDOUT)
+ /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.3.0-rc-2025-09-16)
+ connect: async func(remote-address: ip-socket-address) -> result<_, error-code>;
+ /// Start listening and return a stream of new inbound connections.
+ ///
+ /// Transitions the socket into the `listening` state. This can be called
+ /// at most once per socket.
+ ///
+ /// If the socket is not already explicitly bound, this function will
+ /// implicitly bind the socket to a random free port.
+ ///
+ /// Normally, the returned sockets are bound, in the `connected` state
+ /// and immediately ready for I/O. Though, depending on exact timing and
+ /// circumstances, a newly accepted connection may already be `closed`
+ /// by the time the server attempts to perform its first I/O on it. This
+ /// is true regardless of whether the WASI implementation uses
+ /// "synthesized" sockets or not (see Implementors Notes below).
+ ///
+ /// The following properties are inherited from the listener socket:
+ /// - `address-family`
+ /// - `keep-alive-enabled`
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// - `hop-limit`
+ /// - `receive-buffer-size`
+ /// - `send-buffer-size`
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
+ /// - `invalid-state`: The socket is already in the `listening` state.
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
+ ///
+ /// # Implementors note
+ /// This method returns a single perpetual stream that should only close
+ /// on fatal errors (if any). Yet, the POSIX' `accept` function may also
+ /// return transient errors (e.g. ECONNABORTED). The exact details differ
+ /// per operation system. For example, the Linux manual mentions:
+ ///
+ /// > Linux accept() passes already-pending network errors on the new
+ /// > socket as an error code from accept(). This behavior differs from
+ /// > other BSD socket implementations. For reliable operation the
+ /// > application should detect the network errors defined for the
+ /// > protocol after accept() and treat them like EAGAIN by retrying.
+ /// > In the case of TCP/IP, these are ENETDOWN, EPROTO, ENOPROTOOPT,
+ /// > EHOSTDOWN, ENONET, EHOSTUNREACH, EOPNOTSUPP, and ENETUNREACH.
+ /// Source: https://man7.org/linux/man-pages/man2/accept.2.html
+ ///
+ /// WASI implementations have two options to handle this:
+ /// - Optionally log it and then skip over non-fatal errors returned by
+ /// `accept`. Guest code never gets to see these failures. Or:
+ /// - Synthesize a `tcp-socket` resource that exposes the error when
+ /// attempting to send or receive on it. Guest code then sees these
+ /// failures as regular I/O errors.
+ ///
+ /// In either case, the stream returned by this `listen` method remains
+ /// operational.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
+ /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ listen: func() -> result<stream<tcp-socket>, error-code>;
+ /// Transmit data to peer.
+ ///
+ /// The caller should close the stream when it has no more data to send
+ /// to the peer. Under normal circumstances this will cause a FIN packet
+ /// to be sent out. Closing the stream is equivalent to calling
+ /// `shutdown(SHUT_WR)` in POSIX.
+ ///
+ /// This function may be called at most once and returns once the full
+ /// contents of the stream are transmitted or an error is encountered.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/send.html>
+ /// - <https://man7.org/linux/man-pages/man2/send.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ send: async func(data: stream<u8>) -> result<_, error-code>;
+ /// Read data from peer.
+ ///
+ /// This function returns a `stream` which provides the data received from the
+ /// socket, and a `future` providing additional error information in case the
+ /// socket is closed abnormally.
+ ///
+ /// If the socket is closed normally, `stream.read` on the `stream` will return
+ /// `read-status::closed` with no `error-context` and the future resolves to
+ /// the value `ok`. If the socket is closed abnormally, `stream.read` on the
+ /// `stream` returns `read-status::closed` with an `error-context` and the future
+ /// resolves to `err` with an `error-code`.
+ ///
+ /// `receive` is meant to be called only once per socket. If it is called more
+ /// than once, the subsequent calls return a new `stream` that fails as if it
+ /// were closed abnormally.
+ ///
+ /// If the caller is not expecting to receive any data from the peer,
+ /// they may drop the stream. Any data still in the receive queue
+ /// will be discarded. This is equivalent to calling `shutdown(SHUT_RD)`
+ /// in POSIX.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
+ /// - `connection-reset`: The connection was reset. (ECONNRESET)
+ /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html>
+ /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ receive: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
+ /// Get the bound local address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the remote address.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether the socket is in the `listening` state.
+ ///
+ /// Equivalent to the SO_ACCEPTCONN socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-is-listening: func() -> bool;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// This is the value passed to the constructor.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-address-family: func() -> ip-address-family;
+ /// Hints the desired listen queue size. Implementations are free to ignore this.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ ///
+ /// # Typical errors
+ /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
+ /// - `invalid-argument`: (set) The provided value was 0.
+ /// - `invalid-state`: (set) The socket is in the `connecting` or `connected` state.
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
+ /// Enables or disables keepalive.
+ ///
+ /// The keepalive behavior can be adjusted using:
+ /// - `keep-alive-idle-time`
+ /// - `keep-alive-interval`
+ /// - `keep-alive-count`
+ /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
+ ///
+ /// Equivalent to the SO_KEEPALIVE socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-enabled: func() -> result<bool, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
+ /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-idle-time: func() -> result<duration, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
+ /// The time between keepalive packets.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPINTVL socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-interval: func() -> result<duration, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
+ /// The maximum amount of keepalive packets TCP should send before aborting the connection.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the TCP_KEEPCNT socket option.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-keep-alive-count: func() -> result<u32, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-keep-alive-count: func(value: u32) -> result<_, error-code>;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ }
+
+ /// A UDP socket handle.
+ @since(version = 0.3.0-rc-2025-09-16)
+ resource udp-socket {
+ /// Create a new UDP socket.
+ ///
+ /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
+ /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
+ ///
+ /// Unlike POSIX, WASI sockets have no notion of a socket-level
+ /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
+ /// async support.
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
+ /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ create: static func(address-family: ip-address-family) -> result<udp-socket, error-code>;
+ /// Bind the socket to the provided IP address and port.
+ ///
+ /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+ /// network interface(s) to bind to.
+ /// If the port is zero, the socket will be bound to a random free port.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
+ /// - `invalid-state`: The socket is already bound. (EINVAL)
+ /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+ /// - `address-in-use`: Address is already in use. (EADDRINUSE)
+ /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+ /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+ @since(version = 0.3.0-rc-2025-09-16)
+ bind: func(local-address: ip-socket-address) -> result<_, error-code>;
+ /// Associate this socket with a specific peer address.
+ ///
+ /// On success, the `remote-address` of the socket is updated.
+ /// The `local-address` may be updated as well, based on the best network
+ /// path to `remote-address`. If the socket was not already explicitly
+ /// bound, this function will implicitly bind the socket to a random
+ /// free port.
+ ///
+ /// When a UDP socket is "connected", the `send` and `receive` methods
+ /// are limited to communicating with that peer only:
+ /// - `send` can only be used to send to this destination.
+ /// - `receive` will only return datagrams sent from the provided `remote-address`.
+ ///
+ /// The name "connect" was kept to align with the existing POSIX
+ /// terminology. Other than that, this function only changes the local
+ /// socket configuration and does not generate any network traffic.
+ /// The peer is not aware of this "connection".
+ ///
+ /// This method may be called multiple times on the same socket to change
+ /// its association, but only the most recent one will be effective.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
+ ///
+ /// # Implementors note
+ /// If the socket is already connected, some platforms (e.g. Linux)
+ /// require a disconnect before connecting to a different peer address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.3.0-rc-2025-09-16)
+ connect: func(remote-address: ip-socket-address) -> result<_, error-code>;
+ /// Dissociate this socket from its peer address.
+ ///
+ /// After calling this method, `send` & `receive` are free to communicate
+ /// with any address again.
+ ///
+ /// The POSIX equivalent of this is calling `connect` with an `AF_UNSPEC` address.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not connected.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+ /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+ /// - <https://man.freebsd.org/cgi/man.cgi?connect>
+ @since(version = 0.3.0-rc-2025-09-16)
+ disconnect: func() -> result<_, error-code>;
+ /// Send a message on the socket to a particular peer.
+ ///
+ /// If the socket is connected, the peer address may be left empty. In
+ /// that case this is equivalent to `send` in POSIX. Otherwise it is
+ /// equivalent to `sendto`.
+ ///
+ /// Additionally, if the socket is connected, a `remote-address` argument
+ /// _may_ be provided but then it must be identical to the address
+ /// passed to `connect`.
+ ///
+ /// Implementations may trap if the `data` length exceeds 64 KiB.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+ /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+ /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `connect`. (EISCONN)
+ /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/send.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ send: async func(data: list<u8>, remote-address: option<ip-socket-address>) -> result<_, error-code>;
+ /// Receive a message on the socket.
+ ///
+ /// On success, the return value contains a tuple of the received data
+ /// and the address of the sender. Theoretical maximum length of the
+ /// data is 64 KiB. Though in practice, it will typically be less than
+ /// 1500 bytes.
+ ///
+ /// If the socket is connected, the sender address is guaranteed to
+ /// match the remote address passed to `connect`.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket has not been bound yet.
+ /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
+ /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
+ /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
+ /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/mswsock/nc-mswsock-lpfn_wsarecvmsg>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
+ @since(version = 0.3.0-rc-2025-09-16)
+ receive: async func() -> result<tuple<list<u8>, ip-socket-address>, error-code>;
+ /// Get the current bound address.
+ ///
+ /// POSIX mentions:
+ /// > If the socket has not been bound to a local name, the value
+ /// > stored in the object pointed to by `address` is unspecified.
+ ///
+ /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not bound to any local address.
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+ /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+ /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-local-address: func() -> result<ip-socket-address, error-code>;
+ /// Get the address the socket is currently "connected" to.
+ ///
+ /// # Typical errors
+ /// - `invalid-state`: The socket is not "connected" to a specific remote address. (ENOTCONN)
+ ///
+ /// # References
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+ /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-remote-address: func() -> result<ip-socket-address, error-code>;
+ /// Whether this is a IPv4 or IPv6 socket.
+ ///
+ /// This is the value passed to the constructor.
+ ///
+ /// Equivalent to the SO_DOMAIN socket option.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-address-family: func() -> ip-address-family;
+ /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-unicast-hop-limit: func() -> result<u8, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
+ /// The kernel buffer space reserved for sends/receives on this socket.
+ ///
+ /// If the provided value is 0, an `invalid-argument` error is returned.
+ /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
+ /// I.e. after setting a value, reading the same setting back may return a different value.
+ ///
+ /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+ ///
+ /// # Typical errors
+ /// - `invalid-argument`: (set) The provided value was 0.
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-receive-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ get-send-buffer-size: func() -> result<u64, error-code>;
+ @since(version = 0.3.0-rc-2025-09-16)
+ set-send-buffer-size: func(value: u64) -> result<_, error-code>;
+ }
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+interface ip-name-lookup {
+ @since(version = 0.3.0-rc-2025-09-16)
+ use types.{ip-address};
+
+ /// Lookup error codes.
+ @since(version = 0.3.0-rc-2025-09-16)
+ enum error-code {
+ /// Unknown error
+ unknown,
+ /// Access denied.
+ ///
+ /// POSIX equivalent: EACCES, EPERM
+ access-denied,
+ /// `name` is a syntactically invalid domain name or IP address.
+ ///
+ /// POSIX equivalent: EINVAL
+ invalid-argument,
+ /// Name does not exist or has no suitable associated IP addresses.
+ ///
+ /// POSIX equivalent: EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY
+ name-unresolvable,
+ /// A temporary failure in name resolution occurred.
+ ///
+ /// POSIX equivalent: EAI_AGAIN
+ temporary-resolver-failure,
+ /// A permanent failure in name resolution occurred.
+ ///
+ /// POSIX equivalent: EAI_FAIL
+ permanent-resolver-failure,
+ }
+
+ /// Resolve an internet host name to a list of IP addresses.
+ ///
+ /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
+ /// If the input is an IP address string, the address is parsed and returned
+ /// as-is without making any external requests.
+ ///
+ /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
+ ///
+ /// The results are returned in connection order preference.
+ ///
+ /// This function never succeeds with 0 results. It either fails or succeeds
+ /// with at least one address. Additionally, this function never returns
+ /// IPv4-mapped IPv6 addresses.
+ ///
+ /// The returned future will resolve to an error code in case of failure.
+ /// It will resolve to success once the returned stream is exhausted.
+ ///
+ /// # References:
+ /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
+ /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
+ /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
+ /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
+ @since(version = 0.3.0-rc-2025-09-16)
+ resolve-addresses: async func(name: string) -> result<list<ip-address>, error-code>;
+}
+
+@since(version = 0.3.0-rc-2025-09-16)
+world imports {
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wasi:clocks/[email protected];
+ @since(version = 0.3.0-rc-2025-09-16)
+ import wasi:clocks/[email protected];
+ @since(version = 0.3.0-rc-2025-09-16)
+ import types;
+ @since(version = 0.3.0-rc-2025-09-16)
+ import ip-name-lookup;
+}
diff --git a/crates/wasi/src/p3/wit/deps/sockets/ip-name-lookup.wit b/crates/wasi/src/p3/wit/deps/sockets/ip-name-lookup.wit
deleted file mode 100644
index 6a652ff232..0000000000
--- a/crates/wasi/src/p3/wit/deps/sockets/ip-name-lookup.wit
+++ /dev/null
@@ -1,62 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface ip-name-lookup {
- @since(version = 0.3.0-rc-2025-09-16)
- use types.{ip-address};
-
- /// Lookup error codes.
- @since(version = 0.3.0-rc-2025-09-16)
- enum error-code {
- /// Unknown error
- unknown,
-
- /// Access denied.
- ///
- /// POSIX equivalent: EACCES, EPERM
- access-denied,
-
- /// `name` is a syntactically invalid domain name or IP address.
- ///
- /// POSIX equivalent: EINVAL
- invalid-argument,
-
- /// Name does not exist or has no suitable associated IP addresses.
- ///
- /// POSIX equivalent: EAI_NONAME, EAI_NODATA, EAI_ADDRFAMILY
- name-unresolvable,
-
- /// A temporary failure in name resolution occurred.
- ///
- /// POSIX equivalent: EAI_AGAIN
- temporary-resolver-failure,
-
- /// A permanent failure in name resolution occurred.
- ///
- /// POSIX equivalent: EAI_FAIL
- permanent-resolver-failure,
- }
-
- /// Resolve an internet host name to a list of IP addresses.
- ///
- /// Unicode domain names are automatically converted to ASCII using IDNA encoding.
- /// If the input is an IP address string, the address is parsed and returned
- /// as-is without making any external requests.
- ///
- /// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
- ///
- /// The results are returned in connection order preference.
- ///
- /// This function never succeeds with 0 results. It either fails or succeeds
- /// with at least one address. Additionally, this function never returns
- /// IPv4-mapped IPv6 addresses.
- ///
- /// The returned future will resolve to an error code in case of failure.
- /// It will resolve to success once the returned stream is exhausted.
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
- /// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
- @since(version = 0.3.0-rc-2025-09-16)
- resolve-addresses: async func(name: string) -> result<list<ip-address>, error-code>;
-}
diff --git a/crates/wasi/src/p3/wit/deps/sockets/types.wit b/crates/wasi/src/p3/wit/deps/sockets/types.wit
deleted file mode 100644
index 2ed1912e48..0000000000
--- a/crates/wasi/src/p3/wit/deps/sockets/types.wit
+++ /dev/null
@@ -1,725 +0,0 @@
-@since(version = 0.3.0-rc-2025-09-16)
-interface types {
- @since(version = 0.3.0-rc-2025-09-16)
- use wasi:clocks/[email protected].{duration};
-
- /// Error codes.
- ///
- /// In theory, every API can return any error code.
- /// In practice, API's typically only return the errors documented per API
- /// combined with a couple of errors that are always possible:
- /// - `unknown`
- /// - `access-denied`
- /// - `not-supported`
- /// - `out-of-memory`
- ///
- /// See each individual API for what the POSIX equivalents are. They sometimes differ per API.
- @since(version = 0.3.0-rc-2025-09-16)
- enum error-code {
- /// Unknown error
- unknown,
-
- /// Access denied.
- ///
- /// POSIX equivalent: EACCES, EPERM
- access-denied,
-
- /// The operation is not supported.
- ///
- /// POSIX equivalent: EOPNOTSUPP
- not-supported,
-
- /// One of the arguments is invalid.
- ///
- /// POSIX equivalent: EINVAL
- invalid-argument,
-
- /// Not enough memory to complete the operation.
- ///
- /// POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
- out-of-memory,
-
- /// The operation timed out before it could finish completely.
- timeout,
-
- /// The operation is not valid in the socket's current state.
- invalid-state,
-
- /// A bind operation failed because the provided address is not an address that the `network` can bind to.
- address-not-bindable,
-
- /// A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
- address-in-use,
-
- /// The remote address is not reachable
- remote-unreachable,
-
-
- /// The TCP connection was forcefully rejected
- connection-refused,
-
- /// The TCP connection was reset.
- connection-reset,
-
- /// A TCP connection was aborted.
- connection-aborted,
-
-
- /// The size of a datagram sent to a UDP socket exceeded the maximum
- /// supported size.
- datagram-too-large,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- enum ip-address-family {
- /// Similar to `AF_INET` in POSIX.
- ipv4,
-
- /// Similar to `AF_INET6` in POSIX.
- ipv6,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- type ipv4-address = tuple<u8, u8, u8, u8>;
- @since(version = 0.3.0-rc-2025-09-16)
- type ipv6-address = tuple<u16, u16, u16, u16, u16, u16, u16, u16>;
-
- @since(version = 0.3.0-rc-2025-09-16)
- variant ip-address {
- ipv4(ipv4-address),
- ipv6(ipv6-address),
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- record ipv4-socket-address {
- /// sin_port
- port: u16,
- /// sin_addr
- address: ipv4-address,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- record ipv6-socket-address {
- /// sin6_port
- port: u16,
- /// sin6_flowinfo
- flow-info: u32,
- /// sin6_addr
- address: ipv6-address,
- /// sin6_scope_id
- scope-id: u32,
- }
-
- @since(version = 0.3.0-rc-2025-09-16)
- variant ip-socket-address {
- ipv4(ipv4-socket-address),
- ipv6(ipv6-socket-address),
- }
-
- /// A TCP socket resource.
- ///
- /// The socket can be in one of the following states:
- /// - `unbound`
- /// - `bound` (See note below)
- /// - `listening`
- /// - `connecting`
- /// - `connected`
- /// - `closed`
- /// See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics-0.3.0-draft.md>
- /// for more information.
- ///
- /// Note: Except where explicitly mentioned, whenever this documentation uses
- /// the term "bound" without backticks it actually means: in the `bound` state *or higher*.
- /// (i.e. `bound`, `listening`, `connecting` or `connected`)
- ///
- /// In addition to the general error codes documented on the
- /// `types::error-code` type, TCP socket methods may always return
- /// `error(invalid-state)` when in the `closed` state.
- @since(version = 0.3.0-rc-2025-09-16)
- resource tcp-socket {
-
- /// Create a new TCP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_STREAM, IPPROTO_TCP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// Unlike POSIX, WASI sockets have no notion of a socket-level
- /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
- /// async support.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- create: static func(address-family: ip-address-family) -> result<tcp-socket, error-code>;
-
- /// Bind the socket to the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the TCP/UDP port is zero, the socket will be bound to a random free port.
- ///
- /// Bind can be attempted multiple times on the same socket, even with
- /// different arguments on each iteration. But never concurrently and
- /// only as long as the previous bind failed. Once a bind succeeds, the
- /// binding can't be changed anymore.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-argument`: `local-address` is not a unicast address. (EINVAL)
- /// - `invalid-argument`: `local-address` is an IPv4-mapped IPv6 address. (EINVAL)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
- ///
- /// # Implementors note
- /// When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
- /// state of a recently closed socket on the same local address. In practice this means that the SO_REUSEADDR
- /// socket option should be set implicitly on all platforms, except on Windows where this is the default behavior
- /// and SO_REUSEADDR performs something different entirely.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.3.0-rc-2025-09-16)
- bind: func(local-address: ip-socket-address) -> result<_, error-code>;
-
- /// Connect to a remote endpoint.
- ///
- /// On success, the socket is transitioned into the `connected` state and this function returns a connection resource.
- ///
- /// After a failed connection attempt, the socket will be in the `closed`
- /// state and the only valid action left is to `drop` the socket. A single
- /// socket can not be used to connect more than once.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: `remote-address` is not a unicast address. (EINVAL, ENETUNREACH on Linux, EAFNOSUPPORT on MacOS)
- /// - `invalid-argument`: `remote-address` is an IPv4-mapped IPv6 address. (EINVAL, EADDRNOTAVAIL on Illumos)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EADDRNOTAVAIL on Windows)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EADDRNOTAVAIL on Windows)
- /// - `invalid-state`: The socket is already in the `connecting` state. (EALREADY)
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN)
- /// - `invalid-state`: The socket is already in the `listening` state. (EOPNOTSUPP, EINVAL on Windows)
- /// - `timeout`: Connection timed out. (ETIMEDOUT)
- /// - `connection-refused`: The connection was forcefully rejected. (ECONNREFUSED)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `connection-aborted`: The connection was aborted. (ECONNABORTED)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.3.0-rc-2025-09-16)
- connect: async func(remote-address: ip-socket-address) -> result<_, error-code>;
-
- /// Start listening and return a stream of new inbound connections.
- ///
- /// Transitions the socket into the `listening` state. This can be called
- /// at most once per socket.
- ///
- /// If the socket is not already explicitly bound, this function will
- /// implicitly bind the socket to a random free port.
- ///
- /// Normally, the returned sockets are bound, in the `connected` state
- /// and immediately ready for I/O. Though, depending on exact timing and
- /// circumstances, a newly accepted connection may already be `closed`
- /// by the time the server attempts to perform its first I/O on it. This
- /// is true regardless of whether the WASI implementation uses
- /// "synthesized" sockets or not (see Implementors Notes below).
- ///
- /// The following properties are inherited from the listener socket:
- /// - `address-family`
- /// - `keep-alive-enabled`
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// - `hop-limit`
- /// - `receive-buffer-size`
- /// - `send-buffer-size`
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is already in the `connected` state. (EISCONN, EINVAL on BSD)
- /// - `invalid-state`: The socket is already in the `listening` state.
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE)
- ///
- /// # Implementors note
- /// This method returns a single perpetual stream that should only close
- /// on fatal errors (if any). Yet, the POSIX' `accept` function may also
- /// return transient errors (e.g. ECONNABORTED). The exact details differ
- /// per operation system. For example, the Linux manual mentions:
- ///
- /// > Linux accept() passes already-pending network errors on the new
- /// > socket as an error code from accept(). This behavior differs from
- /// > other BSD socket implementations. For reliable operation the
- /// > application should detect the network errors defined for the
- /// > protocol after accept() and treat them like EAGAIN by retrying.
- /// > In the case of TCP/IP, these are ENETDOWN, EPROTO, ENOPROTOOPT,
- /// > EHOSTDOWN, ENONET, EHOSTUNREACH, EOPNOTSUPP, and ENETUNREACH.
- /// Source: https://man7.org/linux/man-pages/man2/accept.2.html
- ///
- /// WASI implementations have two options to handle this:
- /// - Optionally log it and then skip over non-fatal errors returned by
- /// `accept`. Guest code never gets to see these failures. Or:
- /// - Synthesize a `tcp-socket` resource that exposes the error when
- /// attempting to send or receive on it. Guest code then sees these
- /// failures as regular I/O errors.
- ///
- /// In either case, the stream returned by this `listen` method remains
- /// operational.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>
- /// - <https://man7.org/linux/man-pages/man2/listen.2.html>
- /// - <https://man7.org/linux/man-pages/man2/accept.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- listen: func() -> result<stream<tcp-socket>, error-code>;
-
- /// Transmit data to peer.
- ///
- /// The caller should close the stream when it has no more data to send
- /// to the peer. Under normal circumstances this will cause a FIN packet
- /// to be sent out. Closing the stream is equivalent to calling
- /// `shutdown(SHUT_WR)` in POSIX.
- ///
- /// This function may be called at most once and returns once the full
- /// contents of the stream are transmitted or an error is encountered.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/send.html>
- /// - <https://man7.org/linux/man-pages/man2/send.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- send: async func(data: stream<u8>) -> result<_, error-code>;
-
- /// Read data from peer.
- ///
- /// This function returns a `stream` which provides the data received from the
- /// socket, and a `future` providing additional error information in case the
- /// socket is closed abnormally.
- ///
- /// If the socket is closed normally, `stream.read` on the `stream` will return
- /// `read-status::closed` with no `error-context` and the future resolves to
- /// the value `ok`. If the socket is closed abnormally, `stream.read` on the
- /// `stream` returns `read-status::closed` with an `error-context` and the future
- /// resolves to `err` with an `error-code`.
- ///
- /// `receive` is meant to be called only once per socket. If it is called more
- /// than once, the subsequent calls return a new `stream` that fails as if it
- /// were closed abnormally.
- ///
- /// If the caller is not expecting to receive any data from the peer,
- /// they may drop the stream. Any data still in the receive queue
- /// will be discarded. This is equivalent to calling `shutdown(SHUT_RD)`
- /// in POSIX.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not in the `connected` state. (ENOTCONN)
- /// - `connection-reset`: The connection was reset. (ECONNRESET)
- /// - `remote-unreachable`: The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html>
- /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- receive: func() -> tuple<stream<u8>, future<result<_, error-code>>>;
-
- /// Get the bound local address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.3.0-rc-2025-09-16)
- get-local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the remote address.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not connected to a remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.3.0-rc-2025-09-16)
- get-remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether the socket is in the `listening` state.
- ///
- /// Equivalent to the SO_ACCEPTCONN socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-is-listening: func() -> bool;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// This is the value passed to the constructor.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-address-family: func() -> ip-address-family;
-
- /// Hints the desired listen queue size. Implementations are free to ignore this.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- ///
- /// # Typical errors
- /// - `not-supported`: (set) The platform does not support changing the backlog size after the initial listen.
- /// - `invalid-argument`: (set) The provided value was 0.
- /// - `invalid-state`: (set) The socket is in the `connecting` or `connected` state.
- @since(version = 0.3.0-rc-2025-09-16)
- set-listen-backlog-size: func(value: u64) -> result<_, error-code>;
-
- /// Enables or disables keepalive.
- ///
- /// The keepalive behavior can be adjusted using:
- /// - `keep-alive-idle-time`
- /// - `keep-alive-interval`
- /// - `keep-alive-count`
- /// These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
- ///
- /// Equivalent to the SO_KEEPALIVE socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-enabled: func() -> result<bool, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
-
- /// Amount of time the connection has to be idle before TCP starts sending keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-idle-time: func() -> result<duration, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
-
- /// The time between keepalive packets.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPINTVL socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-interval: func() -> result<duration, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
-
- /// The maximum amount of keepalive packets TCP should send before aborting the connection.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the TCP_KEEPCNT socket option.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-keep-alive-count: func() -> result<u32, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-keep-alive-count: func(value: u32) -> result<_, error-code>;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.3.0-rc-2025-09-16)
- get-hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- get-send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
- }
-
- /// A UDP socket handle.
- @since(version = 0.3.0-rc-2025-09-16)
- resource udp-socket {
-
- /// Create a new UDP socket.
- ///
- /// Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
- /// On IPv6 sockets, IPV6_V6ONLY is enabled by default and can't be configured otherwise.
- ///
- /// Unlike POSIX, WASI sockets have no notion of a socket-level
- /// `O_NONBLOCK` flag. Instead they fully rely on the Component Model's
- /// async support.
- ///
- /// # References:
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>
- /// - <https://man7.org/linux/man-pages/man2/socket.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketw>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- create: static func(address-family: ip-address-family) -> result<udp-socket, error-code>;
-
- /// Bind the socket to the provided IP address and port.
- ///
- /// If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
- /// network interface(s) to bind to.
- /// If the port is zero, the socket will be bound to a random free port.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `local-address` has the wrong address family. (EAFNOSUPPORT, EFAULT on Windows)
- /// - `invalid-state`: The socket is already bound. (EINVAL)
- /// - `address-in-use`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
- /// - `address-in-use`: Address is already in use. (EADDRINUSE)
- /// - `address-not-bindable`: `local-address` is not an address that can be bound to. (EADDRNOTAVAIL)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
- /// - <https://man7.org/linux/man-pages/man2/bind.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
- @since(version = 0.3.0-rc-2025-09-16)
- bind: func(local-address: ip-socket-address) -> result<_, error-code>;
-
- /// Associate this socket with a specific peer address.
- ///
- /// On success, the `remote-address` of the socket is updated.
- /// The `local-address` may be updated as well, based on the best network
- /// path to `remote-address`. If the socket was not already explicitly
- /// bound, this function will implicitly bind the socket to a random
- /// free port.
- ///
- /// When a UDP socket is "connected", the `send` and `receive` methods
- /// are limited to communicating with that peer only:
- /// - `send` can only be used to send to this destination.
- /// - `receive` will only return datagrams sent from the provided `remote-address`.
- ///
- /// The name "connect" was kept to align with the existing POSIX
- /// terminology. Other than that, this function only changes the local
- /// socket configuration and does not generate any network traffic.
- /// The peer is not aware of this "connection".
- ///
- /// This method may be called multiple times on the same socket to change
- /// its association, but only the most recent one will be effective.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `address-in-use`: Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
- ///
- /// # Implementors note
- /// If the socket is already connected, some platforms (e.g. Linux)
- /// require a disconnect before connecting to a different peer address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.3.0-rc-2025-09-16)
- connect: func(remote-address: ip-socket-address) -> result<_, error-code>;
-
- /// Dissociate this socket from its peer address.
- ///
- /// After calling this method, `send` & `receive` are free to communicate
- /// with any address again.
- ///
- /// The POSIX equivalent of this is calling `connect` with an `AF_UNSPEC` address.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not connected.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
- /// - <https://man7.org/linux/man-pages/man2/connect.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
- /// - <https://man.freebsd.org/cgi/man.cgi?connect>
- @since(version = 0.3.0-rc-2025-09-16)
- disconnect: func() -> result<_, error-code>;
-
- /// Send a message on the socket to a particular peer.
- ///
- /// If the socket is connected, the peer address may be left empty. In
- /// that case this is equivalent to `send` in POSIX. Otherwise it is
- /// equivalent to `sendto`.
- ///
- /// Additionally, if the socket is connected, a `remote-address` argument
- /// _may_ be provided but then it must be identical to the address
- /// passed to `connect`.
- ///
- /// Implementations may trap if the `data` length exceeds 64 KiB.
- ///
- /// # Typical errors
- /// - `invalid-argument`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
- /// - `invalid-argument`: The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
- /// - `invalid-argument`: The socket is in "connected" mode and `remote-address` is `some` value that does not match the address passed to `connect`. (EISCONN)
- /// - `invalid-argument`: The socket is not "connected" and no value for `remote-address` was provided. (EDESTADDRREQ)
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- /// - `datagram-too-large`: The datagram is too large. (EMSGSIZE)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/send.2.html>
- /// - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- send: async func(data: list<u8>, remote-address: option<ip-socket-address>) -> result<_, error-code>;
-
- /// Receive a message on the socket.
- ///
- /// On success, the return value contains a tuple of the received data
- /// and the address of the sender. Theoretical maximum length of the
- /// data is 64 KiB. Though in practice, it will typically be less than
- /// 1500 bytes.
- ///
- /// If the socket is connected, the sender address is guaranteed to
- /// match the remote address passed to `connect`.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket has not been bound yet.
- /// - `remote-unreachable`: The remote address is not reachable. (ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
- /// - `connection-refused`: The connection was refused. (ECONNREFUSED)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
- /// - <https://man7.org/linux/man-pages/man2/recv.2.html>
- /// - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/mswsock/nc-mswsock-lpfn_wsarecvmsg>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
- @since(version = 0.3.0-rc-2025-09-16)
- receive: async func() -> result<tuple<list<u8>, ip-socket-address>, error-code>;
-
- /// Get the current bound address.
- ///
- /// POSIX mentions:
- /// > If the socket has not been bound to a local name, the value
- /// > stored in the object pointed to by `address` is unspecified.
- ///
- /// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not bound to any local address.
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
- /// - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
- /// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
- @since(version = 0.3.0-rc-2025-09-16)
- get-local-address: func() -> result<ip-socket-address, error-code>;
-
- /// Get the address the socket is currently "connected" to.
- ///
- /// # Typical errors
- /// - `invalid-state`: The socket is not "connected" to a specific remote address. (ENOTCONN)
- ///
- /// # References
- /// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
- /// - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
- /// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
- /// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
- @since(version = 0.3.0-rc-2025-09-16)
- get-remote-address: func() -> result<ip-socket-address, error-code>;
-
- /// Whether this is a IPv4 or IPv6 socket.
- ///
- /// This is the value passed to the constructor.
- ///
- /// Equivalent to the SO_DOMAIN socket option.
- @since(version = 0.3.0-rc-2025-09-16)
- get-address-family: func() -> ip-address-family;
-
- /// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The TTL value must be 1 or higher.
- @since(version = 0.3.0-rc-2025-09-16)
- get-unicast-hop-limit: func() -> result<u8, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
-
- /// The kernel buffer space reserved for sends/receives on this socket.
- ///
- /// If the provided value is 0, an `invalid-argument` error is returned.
- /// Any other value will never cause an error, but it might be silently clamped and/or rounded.
- /// I.e. after setting a value, reading the same setting back may return a different value.
- ///
- /// Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
- ///
- /// # Typical errors
- /// - `invalid-argument`: (set) The provided value was 0.
- @since(version = 0.3.0-rc-2025-09-16)
- get-receive-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- get-send-buffer-size: func() -> result<u64, error-code>;
- @since(version = 0.3.0-rc-2025-09-16)
- set-send-buffer-size: func(value: u64) -> result<_, error-code>;
- }
-}
diff --git a/crates/wasi/src/p3/wit/deps/sockets/world.wit b/crates/wasi/src/p3/wit/deps/sockets/world.wit
deleted file mode 100644
index 44cc427ed1..0000000000
--- a/crates/wasi/src/p3/wit/deps/sockets/world.wit
+++ /dev/null
@@ -1,9 +0,0 @@
-package wasi:[email protected];
-
-@since(version = 0.3.0-rc-2025-09-16)
-world imports {
- @since(version = 0.3.0-rc-2025-09-16)
- import types;
- @since(version = 0.3.0-rc-2025-09-16)
- import ip-name-lookup;
-}