Gate synchronous future/stream read/write separately

This commit renames the previous `CM_ASYNC_BUILTINS` feature to
`CM_MORE_ASYNC_BUILTINS` and then moves synchronous future/stream
reads/writes behind this feature. This is inspired by
bytecodealliance/wasmtime#13212 and corresponds to
WebAssembly/component-model#641.

Author: alexcrichton

crates/wasmparser/src/features.rs

@@ -259,12 +259,12 @@ define_wasm_features! {
         /// Corresponds to the 🚟 character in
         /// <https://github.com/WebAssembly/component-model/blob/main/design/mvp/Explainer.md>.
         pub cm_async_stackful: CM_ASYNC_STACKFUL(1 << 28) = false;
-        /// Gates some intrinsics being marked with `async` in the component
+        /// Gates some intrinsics and options on intrinsics in the component
         /// model async proposal.
         ///
         /// Corresponds to the 🚝 character in
         /// <https://github.com/WebAssembly/component-model/blob/main/design/mvp/Explainer.md>.
-        pub cm_async_builtins: CM_ASYNC_BUILTINS(1 << 29) = false;
+        pub cm_more_async_builtins: CM_MORE_ASYNC_BUILTINS(1 << 29) = false;
         /// Support for threading in the component model proposal.
         ///
         /// Corresponds to the 🧵 character in

crates/wasmparser/src/validator/component.rs

@@ -1234,7 +1234,7 @@ impl ComponentState {
                 self.future_read(ty, &options, types, offset)
             }
             CanonicalFunction::FutureWrite { ty, options } => {
-                self.future_write(ty, options.into_vec(), types, offset)
+                self.future_write(ty, &options, types, offset)
             }
             CanonicalFunction::FutureCancelRead { ty, async_ } => {
                 self.future_cancel_read(ty, async_, types, offset)
@@ -1386,10 +1386,10 @@ impl ComponentState {
         types: &mut TypeAlloc,
         offset: usize,
     ) -> Result<()> {
-        if !self.features.cm_async_builtins() {
+        if !self.features.cm_more_async_builtins() {
             bail!(
                 offset,
-                "`resource.drop` as `async` requires the component model async builtins feature"
+                "`resource.drop` as `async` requires the component model more async builtins feature"
             )
         }
         self.resource_at(resource, types, offset)?;
@@ -1608,10 +1608,10 @@ impl ComponentState {
                 "`subtask.cancel` requires the component model async feature"
             )
         }
-        if async_ && !self.features.cm_async_builtins() {
+        if async_ && !self.features.cm_more_async_builtins() {
             bail!(
                 offset,
-                "async `subtask.cancel` requires the component model async builtins feature"
+                "async `subtask.cancel` requires the component model more async builtins feature"
             )
         }
 
@@ -1657,8 +1657,14 @@ impl ComponentState {
             bail!(offset, "`stream.read` requires a stream type")
         };
 
-        let ty_id = self
-            .check_options(types, options, offset)?
+        let options = self.check_options(types, options, offset)?;
+        if options.concurrency.is_sync() && !self.features.cm_more_async_builtins() {
+            bail!(
+                offset,
+                "synchronous `stream.read` requires the component model more async builtins feature"
+            );
+        }
+        let ty_id = options
             .require_memory_if(offset, || elem_ty.is_some())?
             .require_realloc_if(offset, || elem_ty.is_some_and(|ty| ty.contains_ptr(types)))?
             .check_lower(offset)?
@@ -1691,8 +1697,14 @@ impl ComponentState {
             bail!(offset, "`stream.write` requires a stream type")
         };
 
-        let ty_id = self
-            .check_options(types, options, offset)?
+        let options = self.check_options(types, options, offset)?;
+        if options.concurrency.is_sync() && !self.features.cm_more_async_builtins() {
+            bail!(
+                offset,
+                "synchronous `stream.write` requires the component model more async builtins feature"
+            );
+        }
+        let ty_id = options
             .require_memory_if(offset, || elem_ty.is_some())?
             .check_lower(offset)?
             .check_core_type(
@@ -1718,10 +1730,10 @@ impl ComponentState {
                 "`stream.cancel-read` requires the component model async feature"
             )
         }
-        if cancellable && !self.features.cm_async_builtins() {
+        if cancellable && !self.features.cm_more_async_builtins() {
             bail!(
                 offset,
-                "async `stream.cancel-read` requires the component model async builtins feature"
+                "async `stream.cancel-read` requires the component model more async builtins feature"
             )
         }
 
@@ -1748,10 +1760,10 @@ impl ComponentState {
                 "`stream.cancel-write` requires the component model async feature"
             )
         }
-        if cancellable && !self.features.cm_async_builtins() {
+        if cancellable && !self.features.cm_more_async_builtins() {
             bail!(
                 offset,
-                "async `stream.cancel-write` requires the component model async builtins feature"
+                "async `stream.cancel-write` requires the component model more async builtins feature"
             )
         }
 
@@ -1848,8 +1860,14 @@ impl ComponentState {
             bail!(offset, "`future.read` requires a future type")
         };
 
-        let ty_id = self
-            .check_options(types, options, offset)?
+        let options = self.check_options(types, options, offset)?;
+        if options.concurrency.is_sync() && !self.features.cm_more_async_builtins() {
+            bail!(
+                offset,
+                "synchronous `future.read` requires the component model more async builtins feature"
+            );
+        }
+        let ty_id = options
             .require_memory_if(offset, || elem_ty.is_some())?
             .require_realloc_if(offset, || elem_ty.is_some_and(|ty| ty.contains_ptr(types)))?
             .check_lower(offset)?
@@ -1866,7 +1884,7 @@ impl ComponentState {
     fn future_write(
         &mut self,
         ty: u32,
-        options: Vec<CanonicalOption>,
+        options: &[CanonicalOption],
         types: &mut TypeAlloc,
         offset: usize,
     ) -> Result<()> {
@@ -1882,8 +1900,14 @@ impl ComponentState {
             bail!(offset, "`future.write` requires a future type")
         };
 
-        let ty_id = self
-            .check_options(types, &options, offset)?
+        let options = self.check_options(types, &options, offset)?;
+        if options.concurrency.is_sync() && !self.features.cm_more_async_builtins() {
+            bail!(
+                offset,
+                "synchronous `future.write` requires the component model more async builtins feature"
+            );
+        }
+        let ty_id = options
             .require_memory_if(offset, || elem_ty.is_some())?
             .check_core_type(
                 types,
@@ -1908,10 +1932,10 @@ impl ComponentState {
                 "`future.cancel-read` requires the component model async feature"
             )
         }
-        if cancellable && !self.features.cm_async_builtins() {
+        if cancellable && !self.features.cm_more_async_builtins() {
             bail!(
                 offset,
-                "async `future.cancel-read` requires the component model async builtins feature"
+                "async `future.cancel-read` requires the component model more async builtins feature"
             )
         }
 
@@ -1938,10 +1962,10 @@ impl ComponentState {
                 "`future.cancel-write` requires the component model async feature"
             )
         }
-        if cancellable && !self.features.cm_async_builtins() {
+        if cancellable && !self.features.cm_more_async_builtins() {
             bail!(
                 offset,
-                "async `future.cancel-write` requires the component model async builtins feature"
+                "async `future.cancel-write` requires the component model more async builtins feature"
             )
         }
 

crates/wit-component/src/dummy.rs

@@ -208,8 +208,6 @@ fn push_imported_future_and_stream_intrinsics(
                 wat.push_str(&format!(
                     r#"
 (import {module:?} {new:?} (func (result i64)))
-(import {module:?} {read:?} (func (param i32 i32) (result i32)))
-(import {module:?} {write:?} (func (param i32 i32) (result i32)))
 (import {module:?} {cancel_read:?} (func (param i32) (result i32)))
 (import {module:?} {cancel_write:?} (func (param i32) (result i32)))
 (import {module:?} {drop_readable:?} (func (param i32)))
@@ -218,6 +216,8 @@ fn push_imported_future_and_stream_intrinsics(
 (import {module:?} {async_write:?} (func (param i32 i32) (result i32)))
 
 ;; deferred behind 🚝
+;;(import {module:?} {read:?} (func (param i32 i32) (result i32)))
+;;(import {module:?} {write:?} (func (param i32 i32) (result i32)))
 ;;(import {module:?} {async_cancel_read:?} (func (param i32) (result i32)))
 ;;(import {module:?} {async_cancel_write:?} (func (param i32) (result i32)))
 "#
@@ -261,8 +261,6 @@ fn push_imported_future_and_stream_intrinsics(
                 wat.push_str(&format!(
                     r#"
 (import {module:?} {new:?} (func (result i64)))
-(import {module:?} {read:?} (func (param i32 i32 i32) (result i32)))
-(import {module:?} {write:?} (func (param i32 i32 i32) (result i32)))
 (import {module:?} {cancel_read:?} (func (param i32) (result i32)))
 (import {module:?} {cancel_write:?} (func (param i32) (result i32)))
 (import {module:?} {drop_readable:?} (func (param i32)))
@@ -271,6 +269,8 @@ fn push_imported_future_and_stream_intrinsics(
 (import {module:?} {async_write:?} (func (param i32 i32 i32) (result i32)))
 
 ;; deferred behind 🚝
+;;(import {module:?} {read:?} (func (param i32 i32 i32) (result i32)))
+;;(import {module:?} {write:?} (func (param i32 i32 i32) (result i32)))
 ;;(import {module:?} {async_cancel_read:?} (func (param i32) (result i32)))
 ;;(import {module:?} {async_cancel_write:?} (func (param i32) (result i32)))
 "#

crates/wit-parser/tests/ui/parse-fail/bad-include1.wit.result

@@ -2,4 +2,4 @@ interface or world `non-existence` does not exist
      --> tests/ui/parse-fail/bad-include1.wit:4:11
       |
     4 |   include non-existence;
-      |           ^------------
+      |           ^------------

tests/cli/component-model/async/async-builtins.wast

@@ -1,4 +1,4 @@
-;; RUN: wast --assert default --snapshot tests/snapshots % -f cm-async,cm-async-builtins
+;; RUN: wast --assert default --snapshot tests/snapshots % -f cm-async,cm-more-async-builtins
 
 ;; stream.cancel-read
 (component
@@ -101,3 +101,13 @@
   )
   "type mismatch for export `future.cancel-write` of module instantiation argument ``"
 )
+
+;; synchronous future/stream read/write
+(component
+  (type $f (future))
+  (type $s (stream))
+  (core func (canon future.read $f))
+  (core func (canon future.write $f))
+  (core func (canon stream.read $s))
+  (core func (canon stream.write $s))
+)

tests/cli/component-model/async/futures.wast

@@ -161,7 +161,7 @@
     (core func $future-cancel-read (canon future.cancel-read $future-type async))
     (core instance $i (instantiate $m (with "" (instance (export "future.cancel-read" (func $future-cancel-read))))))
   )
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 
 ;; future.cancel-read; incorrect type
 (assert_invalid
@@ -195,7 +195,7 @@
     (core func $future-cancel-write (canon future.cancel-write $future-type async))
     (core instance $i (instantiate $m (with "" (instance (export "future.cancel-write" (func $future-cancel-write))))))
   )
-  "requires the component model async builtins feature"
+  "requires the component model more async builtins feature"
 )
 
 ;; future.cancel-write; incorrect type

tests/cli/component-model/async/streams.wast

@@ -152,7 +152,7 @@
     (core func $stream-cancel-read (canon stream.cancel-read $stream-type async))
     (core instance $i (instantiate $m (with "" (instance (export "stream.cancel-read" (func $stream-cancel-read))))))
   )
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 
 ;; stream.drop-readable
 (component
@@ -187,7 +187,7 @@
     (core func $stream-cancel-write (canon stream.cancel-write $stream-type async))
     (core instance $i (instantiate $m (with "" (instance (export "stream.cancel-write" (func $stream-cancel-write))))))
   )
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 
 ;; stream.drop-writable
 (component

tests/cli/component-model/async/task-builtins.wast

@@ -425,14 +425,14 @@
   (canon stream.drop-readable $s (core func))
   (core func (canon stream.drop-writable $s))
   (canon stream.drop-writable $s (core func))
-  (core func (canon future.read $f (memory $m)))
-  (canon future.read $f (memory $m) (core func))
-  (core func (canon future.write $f (memory $m)))
-  (canon future.write $f (memory $m) (core func))
-  (core func (canon stream.read $s (memory $m)))
-  (canon stream.read $s (memory $m) (core func))
-  (core func (canon stream.write $s (memory $m)))
-  (canon stream.write $s (memory $m) (core func))
+  (core func (canon future.read $f (memory $m) async))
+  (canon future.read $f (memory $m) async (core func))
+  (core func (canon future.write $f (memory $m) async))
+  (canon future.write $f (memory $m) async (core func))
+  (core func (canon stream.read $s (memory $m) async))
+  (canon stream.read $s (memory $m) async (core func))
+  (core func (canon stream.write $s (memory $m) async))
+  (canon stream.write $s (memory $m) async (core func))
 
   (core func (canon context.get i32 0))
   (canon context.get i32 0 (core func))

tests/cli/missing-features/component-model/async-builtins.wast

@@ -1,27 +1,27 @@
 ;; RUN: wast % --assert default --snapshot tests/snapshots \
-;;        -f=cm-async,-cm-async-builtins
+;;        -f=cm-async,-cm-more-async-builtins
 
 ;; {future,stream}.cancel-{read,write}
 (assert_invalid
   (component
     (type $t (future))
     (core func (canon future.cancel-read $t async)))
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 (assert_invalid
   (component
     (type $t (future))
     (core func (canon future.cancel-write $t async)))
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 (assert_invalid
   (component
     (type $t (stream))
     (core func (canon stream.cancel-read $t async)))
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 (assert_invalid
   (component
     (type $t (stream))
     (core func (canon stream.cancel-write $t async)))
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 
 (component
   (type $f (future))
@@ -37,8 +37,31 @@
   (component
     (type $t (resource (rep i32)))
     (core func (canon resource.drop $t async)))
-  "requires the component model async builtins feature")
+  "requires the component model more async builtins feature")
 (component
   (type $t (resource (rep i32)))
   (core func (canon resource.drop $t)))
-	
+
+(assert_invalid
+  (component
+    (type $t (stream))
+    (core func (canon stream.write $t)))
+  "requires the component model more async builtins feature")
+
+(assert_invalid
+  (component
+    (type $t (stream))
+    (core func (canon stream.read $t)))
+  "requires the component model more async builtins feature")
+
+(assert_invalid
+  (component
+    (type $t (future))
+    (core func (canon future.write $t)))
+  "requires the component model more async builtins feature")
+
+(assert_invalid
+  (component
+    (type $t (future))
+    (core func (canon future.read $t)))
+  "requires the component model more async builtins feature")

tests/cli/missing-features/component-model/async-stackful.wast

@@ -1,5 +1,5 @@
 ;; RUN: wast % --assert default --snapshot tests/snapshots \
-;;        -f=cm-async,-cm-async-builtins
+;;        -f=cm-async,-cm-more-async-builtins
 
 (assert_invalid
   (component