Component model threading intrinsic updates (#2430)

* v2 component model threading

* fmt

Author: TartanLlama

crates/wasm-encoder/src/component/builder.rs

@@ -708,10 +708,17 @@ impl ComponentBuilder {
         self.core_funcs.add(Some("thread.new-indirect"))
     }
 
-    /// Declares a new `thread.switch-to` intrinsic.
-    pub fn thread_switch_to(&mut self, cancellable: bool) -> u32 {
-        self.canonical_functions().thread_switch_to(cancellable);
-        self.core_funcs.add(Some("thread.switch-to"))
+    /// Declares a new `thread.suspend-to-suspended` intrinsic.
+    pub fn thread_suspend_to_suspended(&mut self, cancellable: bool) -> u32 {
+        self.canonical_functions()
+            .thread_suspend_to_suspended(cancellable);
+        self.core_funcs.add(Some("thread.suspend-to-suspended"))
+    }
+
+    /// Declares a new `thread.suspend-to` intrinsic.
+    pub fn thread_suspend_to(&mut self, cancellable: bool) -> u32 {
+        self.canonical_functions().thread_suspend_to(cancellable);
+        self.core_funcs.add(Some("thread.suspend-to"))
     }
 
     /// Declares a new `thread.suspend` intrinsic.
@@ -720,16 +727,17 @@ impl ComponentBuilder {
         self.core_funcs.add(Some("thread.suspend"))
     }
 
-    /// Declares a new `thread.resume-later` intrinsic.
-    pub fn thread_resume_later(&mut self) -> u32 {
-        self.canonical_functions().thread_resume_later();
-        self.core_funcs.add(Some("thread.resume-later"))
+    /// Declares a new `thread.unsuspend` intrinsic.
+    pub fn thread_unsuspend(&mut self) -> u32 {
+        self.canonical_functions().thread_unsuspend();
+        self.core_funcs.add(Some("thread.unsuspend"))
     }
 
-    /// Declares a new `thread.yield-to` intrinsic.
-    pub fn thread_yield_to(&mut self, cancellable: bool) -> u32 {
-        self.canonical_functions().thread_yield_to(cancellable);
-        self.core_funcs.add(Some("thread.yield-to"))
+    /// Declares a new `thread.yield-to-suspended` intrinsic.
+    pub fn thread_yield_to_suspended(&mut self, cancellable: bool) -> u32 {
+        self.canonical_functions()
+            .thread_yield_to_suspended(cancellable);
+        self.core_funcs.add(Some("thread.yield-to-suspended"))
     }
 
     /// Adds a new custom section to this component.

crates/wasm-encoder/src/component/canonicals.rs

@@ -522,9 +522,9 @@ impl CanonicalFunctionSection {
         self
     }
 
-    /// Declare a new `thread.switch-to` intrinsic, used to switch execution to
-    /// another thread.
-    pub fn thread_switch_to(&mut self, cancellable: bool) -> &mut Self {
+    /// Declare a new `thread.suspend-to-suspended` intrinsic, used to switch execution to
+    /// another suspended thread.
+    pub fn thread_suspend_to_suspended(&mut self, cancellable: bool) -> &mut Self {
         self.bytes.push(0x28);
         self.bytes.push(if cancellable { 1 } else { 0 });
         self.num_added += 1;
@@ -540,17 +540,26 @@ impl CanonicalFunctionSection {
         self
     }
 
-    /// Declare a new `thread.resume-later` intrinsic, used to resume execution
+    /// Declare a new `thread.suspend-to` intrinsic, used to suspend the current
+    /// thread and switch to another thread that might not be suspended.
+    pub fn thread_suspend_to(&mut self, cancellable: bool) -> &mut Self {
+        self.bytes.push(0x2c);
+        self.bytes.push(if cancellable { 1 } else { 0 });
+        self.num_added += 1;
+        self
+    }
+
+    /// Declare a new `thread.unsuspend` intrinsic, used to resume execution
     /// of the given thread.
-    pub fn thread_resume_later(&mut self) -> &mut Self {
+    pub fn thread_unsuspend(&mut self) -> &mut Self {
         self.bytes.push(0x2a);
         self.num_added += 1;
         self
     }
 
-    /// Declare a new `thread.yield-to` intrinsic, used to yield execution to
-    /// a given thread.
-    pub fn thread_yield_to(&mut self, cancellable: bool) -> &mut Self {
+    /// Declare a new `thread.yield-to-suspended` intrinsic, used to yield execution to
+    /// a given suspended thread.
+    pub fn thread_yield_to_suspended(&mut self, cancellable: bool) -> &mut Self {
         self.bytes.push(0x2b);
         self.bytes.push(if cancellable { 1 } else { 0 });
         self.num_added += 1;

crates/wasm-encoder/src/reencode/component.rs

@@ -1118,17 +1118,20 @@ pub mod component_utils {
                 let table_index = reencoder.table_index(table_index)?;
                 section.thread_new_indirect(func_ty, table_index);
             }
-            wasmparser::CanonicalFunction::ThreadSwitchTo { cancellable } => {
-                section.thread_switch_to(cancellable);
+            wasmparser::CanonicalFunction::ThreadSuspendToSuspended { cancellable } => {
+                section.thread_suspend_to_suspended(cancellable);
             }
             wasmparser::CanonicalFunction::ThreadSuspend { cancellable } => {
                 section.thread_suspend(cancellable);
             }
-            wasmparser::CanonicalFunction::ThreadResumeLater => {
-                section.thread_resume_later();
+            wasmparser::CanonicalFunction::ThreadSuspendTo { cancellable } => {
+                section.thread_suspend_to(cancellable);
             }
-            wasmparser::CanonicalFunction::ThreadYieldTo { cancellable } => {
-                section.thread_yield_to(cancellable);
+            wasmparser::CanonicalFunction::ThreadUnsuspend => {
+                section.thread_unsuspend();
+            }
+            wasmparser::CanonicalFunction::ThreadYieldToSuspended { cancellable } => {
+                section.thread_yield_to_suspended(cancellable);
             }
         }
         Ok(())

crates/wasmparser/src/readers/component/canonicals.rs

@@ -274,8 +274,8 @@ pub enum CanonicalFunction {
         /// The index of the table to use.
         table_index: u32,
     },
-    /// A function to suspend the current thread and switch to the given thread.
-    ThreadSwitchTo {
+    /// A function to suspend the current thread and switch to the given suspended thread.
+    ThreadSuspendToSuspended {
         /// Whether or not the thread can be cancelled while awaiting resumption.
         cancellable: bool,
     },
@@ -284,10 +284,15 @@ pub enum CanonicalFunction {
         /// Whether or not the thread can be cancelled while suspended.
         cancellable: bool,
     },
+    /// A function to suspend the current thread and switch to another thread.
+    ThreadSuspendTo {
+        /// Whether or not the thread can be cancelled while suspended.
+        cancellable: bool,
+    },
     /// A function to schedule the given thread to be resumed later.
-    ThreadResumeLater,
-    /// A function to suspend the current thread and switch to the given thread.
-    ThreadYieldTo {
+    ThreadUnsuspend,
+    /// A function to yield to the given suspended thread.
+    ThreadYieldToSuspended {
         /// Whether or not the thread can be cancelled while yielding.
         cancellable: bool,
     },
@@ -406,14 +411,17 @@ impl<'a> FromReader<'a> for CanonicalFunction {
                 func_ty_index: reader.read()?,
                 table_index: reader.read()?,
             },
-            0x28 => CanonicalFunction::ThreadSwitchTo {
+            0x28 => CanonicalFunction::ThreadSuspendToSuspended {
                 cancellable: reader.read()?,
             },
             0x29 => CanonicalFunction::ThreadSuspend {
                 cancellable: reader.read()?,
             },
-            0x2a => CanonicalFunction::ThreadResumeLater,
-            0x2b => CanonicalFunction::ThreadYieldTo {
+            0x2a => CanonicalFunction::ThreadUnsuspend,
+            0x2b => CanonicalFunction::ThreadYieldToSuspended {
+                cancellable: reader.read()?,
+            },
+            0x2c => CanonicalFunction::ThreadSuspendTo {
                 cancellable: reader.read()?,
             },
             0x06 => CanonicalFunction::SubtaskCancel {

crates/wasmparser/src/validator/component.rs

@@ -1262,16 +1262,19 @@ impl ComponentState {
                 func_ty_index,
                 table_index,
             } => self.thread_new_indirect(func_ty_index, table_index, types, offset),
-            CanonicalFunction::ThreadSwitchTo { cancellable } => {
-                self.thread_switch_to(cancellable, types, offset)
+            CanonicalFunction::ThreadSuspendToSuspended { cancellable } => {
+                self.thread_suspend_to_suspended(cancellable, types, offset)
             }
             CanonicalFunction::ThreadSuspend { cancellable } => {
                 self.thread_suspend(cancellable, types, offset)
             }
-            CanonicalFunction::ThreadResumeLater => self.thread_resume_later(types, offset),
+            CanonicalFunction::ThreadSuspendTo { cancellable } => {
+                self.thread_suspend_to(cancellable, types, offset)
+            }
+            CanonicalFunction::ThreadUnsuspend => self.thread_unsuspend(types, offset),
 
-            CanonicalFunction::ThreadYieldTo { cancellable } => {
-                self.thread_yield_to(cancellable, types, offset)
+            CanonicalFunction::ThreadYieldToSuspended { cancellable } => {
+                self.thread_yield_to_suspended(cancellable, types, offset)
             }
         }
     }
@@ -2176,7 +2179,7 @@ impl ComponentState {
         Ok(())
     }
 
-    fn thread_switch_to(
+    fn thread_suspend_to_suspended(
         &mut self,
         _cancellable: bool,
         types: &mut TypeAlloc,
@@ -2185,7 +2188,7 @@ impl ComponentState {
         if !self.features.cm_threading() {
             bail!(
                 offset,
-                "`thread.switch_to` requires the component model threading feature"
+                "`thread.suspend_to_suspended` requires the component model threading feature"
             )
         }
 
@@ -2211,19 +2214,36 @@ impl ComponentState {
         Ok(())
     }
 
-    fn thread_resume_later(&mut self, types: &mut TypeAlloc, offset: usize) -> Result<()> {
+    fn thread_suspend_to(
+        &mut self,
+        _cancellable: bool,
+        types: &mut TypeAlloc,
+        offset: usize,
+    ) -> Result<()> {
+        if !self.features.cm_threading() {
+            bail!(
+                offset,
+                "`thread.suspend_to` requires the component model threading feature"
+            )
+        }
+        self.core_funcs
+            .push(types.intern_func_type(FuncType::new([ValType::I32], [ValType::I32]), offset));
+        Ok(())
+    }
+
+    fn thread_unsuspend(&mut self, types: &mut TypeAlloc, offset: usize) -> Result<()> {
         if !self.features.cm_threading() {
             bail!(
                 offset,
-                "`thread.resume_later` requires the component model threading feature"
+                "`thread.unsuspend` requires the component model threading feature"
             )
         }
         self.core_funcs
             .push(types.intern_func_type(FuncType::new([ValType::I32], []), offset));
         Ok(())
     }
 
-    fn thread_yield_to(
+    fn thread_yield_to_suspended(
         &mut self,
         _cancellable: bool,
         types: &mut TypeAlloc,
@@ -2232,7 +2252,7 @@ impl ComponentState {
         if !self.features.cm_threading() {
             bail!(
                 offset,
-                "`thread.yield_to` requires the component model threading feature"
+                "`thread.yield_to_suspended` requires the component model threading feature"
             )
         }
         self.core_funcs

crates/wasmprinter/src/component.rs

@@ -1163,8 +1163,8 @@ impl Printer<'_, '_> {
                         me.end_group()
                     })?;
                 }
-                CanonicalFunction::ThreadSwitchTo { cancellable } => {
-                    self.print_intrinsic(state, "canon thread.switch-to", &|me, _| {
+                CanonicalFunction::ThreadSuspendToSuspended { cancellable } => {
+                    self.print_intrinsic(state, "canon thread.suspend-to-suspended", &|me, _| {
                         if cancellable {
                             me.result.write_str(" cancellable")?;
                         }
@@ -1179,11 +1179,19 @@ impl Printer<'_, '_> {
                         Ok(())
                     })?;
                 }
-                CanonicalFunction::ThreadResumeLater => {
-                    self.print_intrinsic(state, "canon thread.resume-later", &|_, _| Ok(()))?;
+                CanonicalFunction::ThreadSuspendTo { cancellable } => {
+                    self.print_intrinsic(state, "canon thread.suspend-to", &|me, _| {
+                        if cancellable {
+                            me.result.write_str(" cancellable")?;
+                        }
+                        Ok(())
+                    })?;
+                }
+                CanonicalFunction::ThreadUnsuspend => {
+                    self.print_intrinsic(state, "canon thread.unsuspend", &|_, _| Ok(()))?;
                 }
-                CanonicalFunction::ThreadYieldTo { cancellable } => {
-                    self.print_intrinsic(state, "canon thread.yield-to", &|me, _| {
+                CanonicalFunction::ThreadYieldToSuspended { cancellable } => {
+                    self.print_intrinsic(state, "canon thread.yield-to-suspended", &|me, _| {
                         if cancellable {
                             me.result.write_str(" cancellable")?;
                         }

crates/wast/src/component/binary.rs

@@ -517,21 +517,25 @@ impl<'a> Encoder<'a> {
                     self.funcs
                         .thread_new_indirect(info.ty.into(), info.table.idx.into());
                 }
-                CoreFuncKind::ThreadSwitchTo(info) => {
+                CoreFuncKind::ThreadSuspendToSuspended(info) => {
                     self.core_func_names.push(name);
-                    self.funcs.thread_switch_to(info.cancellable);
+                    self.funcs.thread_suspend_to_suspended(info.cancellable);
                 }
                 CoreFuncKind::ThreadSuspend(info) => {
                     self.core_func_names.push(name);
                     self.funcs.thread_suspend(info.cancellable);
                 }
-                CoreFuncKind::ThreadResumeLater => {
+                CoreFuncKind::ThreadSuspendTo(info) => {
                     self.core_func_names.push(name);
-                    self.funcs.thread_resume_later();
+                    self.funcs.thread_suspend_to(info.cancellable);
                 }
-                CoreFuncKind::ThreadYieldTo(info) => {
+                CoreFuncKind::ThreadUnsuspend => {
                     self.core_func_names.push(name);
-                    self.funcs.thread_yield_to(info.cancellable);
+                    self.funcs.thread_unsuspend();
+                }
+                CoreFuncKind::ThreadYieldToSuspended(info) => {
+                    self.core_func_names.push(name);
+                    self.funcs.thread_yield_to_suspended(info.cancellable);
                 }
             },
         }