Skip to main content

wasmtime/runtime/component/
concurrent.rs

1//! Runtime support for the Component Model Async ABI.
2//!
3//! This module and its submodules provide host runtime support for Component
4//! Model Async features such as async-lifted exports, async-lowered imports,
5//! streams, futures, and related intrinsics.  See [the Async
6//! Explainer](https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md)
7//! for a high-level overview.
8//!
9//! At the core of this support is an event loop which schedules and switches
10//! between guest tasks and any host tasks they create.  Each
11//! `Store` will have at most one event loop running at any given
12//! time, and that loop may be suspended and resumed by the host embedder using
13//! e.g. `StoreContextMut::run_concurrent`.  The `StoreContextMut::poll_until`
14//! function contains the loop itself, while the
15//! `StoreOpaque::concurrent_state` field holds its state.
16//!
17//! # Public API Overview
18//!
19//! ## Top-level API (e.g. kicking off host->guest calls and driving the event loop)
20//!
21//! - `[Typed]Func::call_concurrent`: Start a host->guest call to an
22//! async-lifted or sync-lifted import, creating a guest task.
23//!
24//! - `StoreContextMut::run_concurrent`: Run the event loop for the specified
25//! instance, allowing any and all tasks belonging to that instance to make
26//! progress.
27//!
28//! - `StoreContextMut::spawn`: Run a background task as part of the event loop
29//! for the specified instance.
30//!
31//! - `{Future,Stream}Reader::new`: Create a new Component Model `future` or
32//! `stream` which may be passed to the guest.  This takes a
33//! `{Future,Stream}Producer` implementation which will be polled for items when
34//! the consumer requests them.
35//!
36//! - `{Future,Stream}Reader::pipe`: Consume a `future` or `stream` by
37//! connecting it to a `{Future,Stream}Consumer` which will consume any items
38//! produced by the write end.
39//!
40//! ## Host Task API (e.g. implementing concurrent host functions and background tasks)
41//!
42//! - `LinkerInstance::func_wrap_concurrent`: Register a concurrent host
43//! function with the linker.  That function will take an `Accessor` as its
44//! first parameter, which provides access to the store between (but not across)
45//! await points.
46//!
47//! - `Accessor::with`: Access the store and its associated data.
48//!
49//! - `Accessor::spawn`: Run a background task as part of the event loop for the
50//! store.  This is equivalent to `StoreContextMut::spawn` but more convenient to use
51//! in host functions.
52
53use self::error_contexts::GlobalErrorContextRefCount;
54use crate::component::func::{Func, call_post_return};
55use crate::component::{
56    HasData, HasSelf, Instance, Resource, ResourceTable, ResourceTableError, RuntimeInstance,
57};
58use crate::fiber::{self, StoreFiber, StoreFiberYield};
59use crate::hash_set::HashSet;
60#[cfg(feature = "gc")]
61use crate::module::ModuleRegistry;
62use crate::prelude::*;
63use crate::store::{Store, StoreId, StoreInner, StoreOpaque, StoreToken};
64#[cfg(feature = "gc")]
65use crate::vm::GcRootsList;
66use crate::vm::component::{
67    CallContext, ComponentInstance, CurrentScope, HandleCounter, InstanceState, Scope,
68};
69use crate::vm::{
70    AlwaysMut, SendSyncPtr, UncaughtException, VMFuncRef, VMLazyThread, VMMemoryDefinition, VMStore,
71};
72use crate::{AsContext, AsContextMut, Result, StoreContext, StoreContextMut, ValRaw, bail};
73use crate::{Instance as ModuleInstance, bail_bug};
74use alloc::borrow::ToOwned;
75use alloc::collections::btree_map::Entry;
76use alloc::collections::{BTreeMap, BTreeSet, VecDeque};
77use core::any::Any;
78use core::cell::UnsafeCell;
79use core::fmt;
80use core::future;
81use core::future::Future;
82use core::marker::PhantomData;
83use core::mem::{self, ManuallyDrop, MaybeUninit};
84use core::ops::DerefMut;
85use core::pin::{Pin, pin};
86use core::ptr::{self, NonNull};
87use core::task::{Context, Poll, Waker};
88use futures::channel::oneshot;
89use futures::stream::{FuturesUnordered, StreamExt};
90use futures_and_streams::{FlatAbi, ReturnCode, TransmitHandle, TransmitIndex};
91use table::{TableDebug, TableId};
92use wasmtime_environ::component::{
93    CanonicalAbiInfo, CanonicalOptions, CanonicalOptionsDataModel, MAX_FLAT_PARAMS,
94    MAX_FLAT_RESULTS, OptionsIndex, PREPARE_ASYNC_NO_RESULT, PREPARE_ASYNC_WITH_RESULT,
95    RuntimeComponentInstanceIndex, RuntimeTableIndex, StringEncoding,
96    TypeComponentGlobalErrorContextTableIndex, TypeComponentLocalErrorContextTableIndex,
97    TypeFutureTableIndex, TypeStreamTableIndex, TypeTupleIndex,
98};
99use wasmtime_environ::packed_option::ReservedValue;
100use wasmtime_environ::{ModuleInternedTypeIndex, NUM_COMPONENT_CONTEXT_SLOTS, Trap};
101#[cfg(feature = "gc")]
102use wasmtime_unwinder::Unwind;
103
104pub use abort::JoinHandle;
105pub use func::{FuncCallConcurrent, TypedFuncCallConcurrent};
106pub use future_stream_any::{FutureAny, StreamAny};
107pub use futures_and_streams::{
108    Destination, DirectDestination, DirectSource, ErrorContext, FutureConsumer, FutureProducer,
109    FutureReader, GuardedFutureReader, GuardedStreamReader, ReadBuffer, Source, StreamConsumer,
110    StreamProducer, StreamReader, StreamResult, VecBuffer, WriteBuffer,
111};
112pub(crate) use futures_and_streams::{ResourcePair, lower_error_context_to_index};
113#[cfg(feature = "task-group-hook")]
114pub use task_group_hook::TaskGroupHook;
115pub use task_group_hook::TaskGroupId;
116
117mod abort;
118mod error_contexts;
119mod func;
120mod future_stream_any;
121mod futures_and_streams;
122pub(crate) mod table;
123#[cfg(feature = "task-group-hook")]
124mod task_group_hook;
125#[cfg(not(feature = "task-group-hook"))]
126mod task_group_hook_disabled;
127#[cfg(not(feature = "task-group-hook"))]
128use task_group_hook_disabled as task_group_hook;
129pub(crate) mod tls;
130
131/// Constant defined in the Component Model spec to indicate that the async
132/// intrinsic (e.g. `future.write`) has not yet completed.
133const BLOCKED: u32 = 0xffff_ffff;
134
135/// Corresponds to `CallState` in the upstream spec.
136#[derive(Clone, Copy, Eq, PartialEq, Debug)]
137pub enum Status {
138    Starting = 0,
139    Started = 1,
140    Returned = 2,
141    StartCancelled = 3,
142    ReturnCancelled = 4,
143}
144
145impl Status {
146    /// Packs this status and the optional `waitable` provided into a 32-bit
147    /// result that the canonical ABI requires.
148    ///
149    /// The low 4 bits are reserved for the status while the upper 28 bits are
150    /// the waitable, if present.
151    pub fn pack(self, waitable: Option<u32>) -> u32 {
152        assert!(matches!(self, Status::Returned) == waitable.is_none());
153        let waitable = waitable.unwrap_or(0);
154        assert!(waitable < (1 << 28));
155        (waitable << 4) | (self as u32)
156    }
157}
158
159/// Corresponds to `EventCode` in the Component Model spec, plus related payload
160/// data.
161#[derive(Clone, Copy, Debug)]
162enum Event {
163    None,
164    Subtask {
165        status: Status,
166    },
167    StreamRead {
168        code: ReturnCode,
169        pending: Option<(TypeStreamTableIndex, u32)>,
170    },
171    StreamWrite {
172        code: ReturnCode,
173        pending: Option<(TypeStreamTableIndex, u32)>,
174    },
175    FutureRead {
176        code: ReturnCode,
177        pending: Option<(TypeFutureTableIndex, u32)>,
178    },
179    FutureWrite {
180        code: ReturnCode,
181        pending: Option<(TypeFutureTableIndex, u32)>,
182    },
183    Cancelled,
184}
185
186impl Event {
187    /// Lower this event to core Wasm integers for delivery to the guest.
188    ///
189    /// Note that the waitable handle, if any, is assumed to be lowered
190    /// separately.
191    fn parts(self) -> (u32, u32) {
192        const EVENT_NONE: u32 = 0;
193        const EVENT_SUBTASK: u32 = 1;
194        const EVENT_STREAM_READ: u32 = 2;
195        const EVENT_STREAM_WRITE: u32 = 3;
196        const EVENT_FUTURE_READ: u32 = 4;
197        const EVENT_FUTURE_WRITE: u32 = 5;
198        const EVENT_CANCELLED: u32 = 6;
199        match self {
200            Event::None => (EVENT_NONE, 0),
201            Event::Cancelled => (EVENT_CANCELLED, 0),
202            Event::Subtask { status } => (EVENT_SUBTASK, status as u32),
203            Event::StreamRead { code, .. } => (EVENT_STREAM_READ, code.encode()),
204            Event::StreamWrite { code, .. } => (EVENT_STREAM_WRITE, code.encode()),
205            Event::FutureRead { code, .. } => (EVENT_FUTURE_READ, code.encode()),
206            Event::FutureWrite { code, .. } => (EVENT_FUTURE_WRITE, code.encode()),
207        }
208    }
209}
210
211/// Corresponds to `CallbackCode` in the spec.
212mod callback_code {
213    pub const EXIT: u32 = 0;
214    pub const YIELD: u32 = 1;
215    pub const WAIT: u32 = 2;
216}
217
218// Flags passed to the `start-call` intrinsic.
219const START_FLAG_ASYNC_CALLEE: u32 = wasmtime_environ::component::START_FLAG_ASYNC_CALLEE as u32;
220const START_FLAG_ASYNC_CALLER: u32 = wasmtime_environ::component::START_FLAG_ASYNC_CALLER as u32;
221
222/// Provides access to either store data (via the `get` method) or the store
223/// itself (via [`AsContext`]/[`AsContextMut`]), as well as the component
224/// instance to which the current host task belongs.
225///
226/// See [`Accessor::with`] for details.
227pub struct Access<'a, T: 'static, D: HasData + ?Sized = HasSelf<T>> {
228    store: StoreContextMut<'a, T>,
229    get_data: fn(&mut T) -> D::Data<'_>,
230}
231
232impl<'a, T, D> Access<'a, T, D>
233where
234    D: HasData + ?Sized,
235    T: 'static,
236{
237    /// Creates a new [`Access`] from its component parts.
238    pub fn new(store: StoreContextMut<'a, T>, get_data: fn(&mut T) -> D::Data<'_>) -> Self {
239        Self { store, get_data }
240    }
241
242    /// Get mutable access to the store data.
243    pub fn data_mut(&mut self) -> &mut T {
244        self.store.data_mut()
245    }
246
247    /// Get mutable access to the store data.
248    pub fn get(&mut self) -> D::Data<'_> {
249        (self.get_data)(self.data_mut())
250    }
251
252    /// Spawn a background task.
253    ///
254    /// See [`Accessor::spawn`] for details.
255    pub fn spawn(&mut self, task: impl for<'fut> AccessorTask<'fut, T, D>) -> Result<JoinHandle>
256    where
257        T: 'static,
258    {
259        let accessor = Accessor {
260            get_data: self.get_data,
261            token: StoreToken::new(self.store.as_context_mut()),
262        };
263        self.store
264            .as_context_mut()
265            .spawn_with_accessor(accessor, task)
266    }
267
268    /// Returns the getter this accessor is using to project from `T` into
269    /// `D::Data`.
270    pub fn getter(&self) -> fn(&mut T) -> D::Data<'_> {
271        self.get_data
272    }
273}
274
275impl<'a, T, D> AsContext for Access<'a, T, D>
276where
277    D: HasData + ?Sized,
278    T: 'static,
279{
280    type Data = T;
281
282    fn as_context(&self) -> StoreContext<'_, T> {
283        self.store.as_context()
284    }
285}
286
287impl<'a, T, D> AsContextMut for Access<'a, T, D>
288where
289    D: HasData + ?Sized,
290    T: 'static,
291{
292    fn as_context_mut(&mut self) -> StoreContextMut<'_, T> {
293        self.store.as_context_mut()
294    }
295}
296
297/// Provides scoped mutable access to store data in the context of a concurrent
298/// host task future.
299///
300/// This allows multiple host task futures to execute concurrently and access
301/// the store between (but not across) `await` points.
302///
303/// # Rationale
304///
305/// This structure is sort of like `&mut T` plus a projection from `&mut T` to
306/// `D::Data<'_>`. The problem this is solving, however, is that it does not
307/// literally store these values. The basic problem is that when a concurrent
308/// host future is being polled it has access to `&mut T` (and the whole
309/// `Store`) but when it's not being polled it does not have access to these
310/// values. This reflects how the store is only ever polling one future at a
311/// time so the store is effectively being passed between futures.
312///
313/// Rust's `Future` trait, however, has no means of passing a `Store`
314/// temporarily between futures. The [`Context`](core::task::Context) type does
315/// not have the ability to attach arbitrary information to it at this time.
316/// This type, [`Accessor`], is used to bridge this expressivity gap.
317///
318/// The [`Accessor`] type here represents the ability to acquire, temporarily in
319/// a synchronous manner, the current store. The [`Accessor::with`] function
320/// yields an [`Access`] which can be used to access [`StoreContextMut`], `&mut
321/// T`, or `D::Data<'_>`. Note though that [`Accessor::with`] intentionally does
322/// not take an `async` closure as its argument, instead it's a synchronous
323/// closure which must complete during on run of `Future::poll`. This reflects
324/// how the store is temporarily made available while a host future is being
325/// polled.
326///
327/// # Implementation
328///
329/// This type does not actually store `&mut T` nor `StoreContextMut<T>`, and
330/// this type additionally doesn't even have a lifetime parameter. This is
331/// instead a representation of proof of the ability to acquire these while a
332/// future is being polled. Wasmtime will, when it polls a host future,
333/// configure ambient state such that the `Accessor` that a future closes over
334/// will work and be able to access the store.
335///
336/// This has a number of implications for users such as:
337///
338/// * It's intentional that `Accessor` cannot be cloned, it needs to stay within
339///   the lifetime of a single future.
340/// * A future is expected to, however, close over an `Accessor` and keep it
341///   alive probably for the duration of the entire future.
342/// * Different host futures will be given different `Accessor`s, and that's
343///   intentional.
344/// * The `Accessor` type is `Send` and `Sync` irrespective of `T` which
345///   alleviates some otherwise required bounds to be written down.
346///
347/// # Using `Accessor` in `Drop`
348///
349/// The methods on `Accessor` are only expected to work in the context of
350/// `Future::poll` and are not guaranteed to work in `Drop`. This is because a
351/// host future can be dropped at any time throughout the system and Wasmtime
352/// store context is not necessarily available at that time. It's recommended to
353/// not use `Accessor` methods in anything connected to a `Drop` implementation
354/// as they will panic and have unintended results. If you run into this though
355/// feel free to file an issue on the Wasmtime repository.
356pub struct Accessor<T: 'static, D = HasSelf<T>>
357where
358    D: HasData + ?Sized,
359{
360    token: StoreToken<T>,
361    get_data: fn(&mut T) -> D::Data<'_>,
362}
363
364/// A helper trait to take any type of accessor-with-data in functions.
365///
366/// This trait is similar to [`AsContextMut`] except that it's used when
367/// working with an [`Accessor`] instead of a [`StoreContextMut`]. The
368/// [`Accessor`] is the main type used in concurrent settings and is passed to
369/// functions such as [`Func::call_concurrent`].
370///
371/// This trait is implemented for [`Accessor`] and `&T` where `T` implements
372/// this trait. This effectively means that regardless of the `D` in
373/// `Accessor<T, D>` it can still be passed to a function which just needs a
374/// store accessor.
375///
376/// Acquiring an [`Accessor`] can be done through
377/// [`StoreContextMut::run_concurrent`] for example or in a host function
378/// through
379/// [`Linker::func_wrap_concurrent`](crate::component::LinkerInstance::func_wrap_concurrent).
380pub trait AsAccessor {
381    /// The `T` in `Store<T>` that this accessor refers to.
382    type Data: 'static;
383
384    /// The `D` in `Accessor<T, D>`, or the projection out of
385    /// `Self::Data`.
386    type AccessorData: HasData + ?Sized;
387
388    /// Returns the accessor that this is referring to.
389    fn as_accessor(&self) -> &Accessor<Self::Data, Self::AccessorData>;
390}
391
392impl<T: AsAccessor + ?Sized> AsAccessor for &T {
393    type Data = T::Data;
394    type AccessorData = T::AccessorData;
395
396    fn as_accessor(&self) -> &Accessor<Self::Data, Self::AccessorData> {
397        T::as_accessor(self)
398    }
399}
400
401impl<T, D: HasData + ?Sized> AsAccessor for Accessor<T, D> {
402    type Data = T;
403    type AccessorData = D;
404
405    fn as_accessor(&self) -> &Accessor<T, D> {
406        self
407    }
408}
409
410// Note that it is intentional at this time that `Accessor` does not actually
411// store `&mut T` or anything similar. This distinctly enables the `Accessor`
412// structure to be both `Send` and `Sync` regardless of what `T` is (or `D` for
413// that matter). This is used to ergonomically simplify bindings where the
414// majority of the time `Accessor` is closed over in a future which then needs
415// to be `Send` and `Sync`. To avoid needing to write `T: Send` everywhere (as
416// you already have to write `T: 'static`...) it helps to avoid this.
417//
418// Note as well that `Accessor` doesn't actually store its data at all. Instead
419// it's more of a "proof" of what can be accessed from TLS. API design around
420// `Accessor` and functions like `Linker::func_wrap_concurrent` are
421// intentionally made to ensure that `Accessor` is ideally only used in the
422// context that TLS variables are actually set. For example host functions are
423// given `&Accessor`, not `Accessor`, and this prevents them from persisting
424// the value outside of a future. Within the future the TLS variables are all
425// guaranteed to be set while the future is being polled.
426//
427// Finally though this is not an ironclad guarantee, but nor does it need to be.
428// The TLS APIs are designed to panic or otherwise model usage where they're
429// called recursively or similar. It's hoped that code cannot be constructed to
430// actually hit this at runtime but this is not a safety requirement at this
431// time.
432const _: () = {
433    const fn assert<T: Send + Sync>() {}
434    assert::<Accessor<UnsafeCell<u32>>>();
435};
436
437impl<T> Accessor<T> {
438    /// Creates a new `Accessor` backed by the specified functions.
439    ///
440    /// - `get`: used to retrieve the store
441    ///
442    /// - `get_data`: used to "project" from the store's associated data to
443    /// another type (e.g. a field of that data or a wrapper around it).
444    ///
445    /// - `spawn`: used to queue spawned background tasks to be run later
446    pub(crate) fn new(token: StoreToken<T>) -> Self {
447        Self {
448            token,
449            get_data: |x| x,
450        }
451    }
452}
453
454impl<T, D> Accessor<T, D>
455where
456    D: HasData + ?Sized,
457{
458    /// Run the specified closure, passing it mutable access to the store.
459    ///
460    /// This function is one of the main building blocks of the [`Accessor`]
461    /// type. This yields synchronous, blocking, access to the store via an
462    /// [`Access`]. The [`Access`] implements [`AsContextMut`] in addition to
463    /// providing the ability to access `D` via [`Access::get`]. Note that the
464    /// `fun` here is given only temporary access to the store and `T`/`D`
465    /// meaning that the return value `R` here is not allowed to capture borrows
466    /// into the two. If access is needed to data within `T` or `D` outside of
467    /// this closure then it must be `clone`d out, for example.
468    ///
469    /// # Panics
470    ///
471    /// This function will panic if it is call recursively with any other
472    /// accessor already in scope. For example if `with` is called within `fun`,
473    /// then this function will panic. It is up to the embedder to ensure that
474    /// this does not happen.
475    pub fn with<R>(&self, fun: impl FnOnce(Access<'_, T, D>) -> R) -> R {
476        tls::get(|vmstore| {
477            fun(Access {
478                store: self.token.as_context_mut(vmstore),
479                get_data: self.get_data,
480            })
481        })
482    }
483
484    /// Returns the getter this accessor is using to project from `T` into
485    /// `D::Data`.
486    pub fn getter(&self) -> fn(&mut T) -> D::Data<'_> {
487        self.get_data
488    }
489
490    /// Changes this accessor to access `D2` instead of the current type
491    /// parameter `D`.
492    ///
493    /// This changes the underlying data access from `T` to `D2::Data<'_>`.
494    ///
495    /// # Panics
496    ///
497    /// When using this API the returned value is disconnected from `&self` and
498    /// the lifetime binding the `self` argument. An `Accessor` only works
499    /// within the context of the closure or async closure that it was
500    /// originally given to, however. This means that due to the fact that the
501    /// returned value has no lifetime connection it's possible to use the
502    /// accessor outside of `&self`, the original accessor, and panic.
503    ///
504    /// The returned value should only be used within the scope of the original
505    /// `Accessor` that `self` refers to.
506    pub fn with_getter<D2: HasData>(
507        &self,
508        get_data: fn(&mut T) -> D2::Data<'_>,
509    ) -> Accessor<T, D2> {
510        Accessor {
511            token: self.token,
512            get_data,
513        }
514    }
515
516    /// Spawn a background task which will receive an `&Accessor<T, D>` and
517    /// run concurrently with any other tasks in progress for the current
518    /// store.
519    ///
520    /// This is particularly useful for host functions which return a `stream`
521    /// or `future` such that the code to write to the write end of that
522    /// `stream` or `future` must run after the function returns.
523    ///
524    /// The returned [`JoinHandle`] may be used to cancel the task.
525    ///
526    /// # Panics
527    ///
528    /// Panics if called within a closure provided to the [`Accessor::with`]
529    /// function. This can only be called outside an active invocation of
530    /// [`Accessor::with`].
531    pub fn spawn(&self, task: impl for<'fut> AccessorTask<'fut, T, D>) -> Result<JoinHandle>
532    where
533        T: 'static,
534    {
535        let accessor = self.clone_for_spawn();
536        self.with(|mut access| access.as_context_mut().spawn_with_accessor(accessor, task))
537    }
538
539    fn clone_for_spawn(&self) -> Self {
540        Self {
541            token: self.token,
542            get_data: self.get_data,
543        }
544    }
545
546    /// Polls to see if this store contains any "interesting" tasks still within
547    /// it.
548    ///
549    /// Returns `Poll::Ready(())` if there are no more interesting tasks, and
550    /// otherwise returns `Poll::Pending`. If pending is returned then whenever
551    /// the last remaining "interesting" task has exited the provided context's
552    /// waker will be notified. Note that only the waker passed to the last call
553    /// to `poll_no_interesting_tasks` for the store will be notified, so this
554    /// is only appropriate to use once-at-a-time per store.
555    ///
556    /// The component model specification, as of this current date, does not
557    /// have a distinction between "interesting" tasks and not. The current
558    /// intention is that in a future revision of the component model this will
559    /// be distinguished at the component ABI level where tasks will be able to
560    /// flag themselves as "interesting" optionally. Additionally extra work can
561    /// be opted-in to being "interesting".
562    ///
563    /// For now what this means is that all component model tasks within this
564    /// store are considered interesting. This specifically includes the entire
565    /// duration of a task, so even all of the time after a task has returned
566    /// but before it has exited. This means that this function is, today,
567    /// effectively a proxy for "are there any more tasks still running in this
568    /// store". This can be used by embedders to determine whether there's any
569    /// more work going on, even in the background, for a particular guest.
570    /// Hosts can use this as a signal that the guest wants to stay alive a
571    /// little longer, even after a task has returned.
572    ///
573    /// In the future this predicate won't include all tasks in this store. Some
574    /// tasks will be able to flag themselves as not interesting, meaning that
575    /// when this returns ready it'd be possible that there are still tasks
576    /// remaining in the store.
577    ///
578    /// Note that at this time spawned threads within a task are always
579    /// considered uninteresting. If this function returns ready, then spawned
580    /// threads may still be in the store.
581    pub fn poll_no_interesting_tasks(&self, cx: &mut Context<'_>) -> Poll<()> {
582        self.with(|mut access| {
583            let store = access.as_context_mut().0;
584            let state = store.concurrent_state_mut_without_forcing_current_thread();
585            if state.interesting_tasks == 0 {
586                Poll::Ready(())
587            } else {
588                state.interesting_tasks_empty_waker = Some(cx.waker().clone());
589                Poll::Pending
590            }
591        })
592    }
593
594    /// Poll to see if the component instance corresponding to the specified
595    /// function is ready to run a concurrent call without queuing it (i.e. does
596    /// not have backpressure enabled and does not have a sync call in
597    /// progress).
598    ///
599    /// Returns `Poll::Ready(())` if the component instance is ready to run a
600    /// concurrent call, and otherwise returns `Poll::Pending`.  If pending is
601    /// returned then whenever the instance becomes ready for a call the
602    /// provided context's waker will be notified.  Note that only the waker
603    /// passed to the last call to `poll_ready_for_concurrent_call` for the
604    /// store will be notified (regardless of whether the same or different
605    /// `Func` is specified relative to earlier calls), so this is only
606    /// appropriate to use once-at-a-time per store.  Also note that the waker
607    /// may be notified when _any_ instance becomes callable (i.e. not
608    /// necessarily the last one polled), so this function must be called again
609    /// to determine if the instance of interest is ready.
610    pub fn poll_ready_for_concurrent_call(&self, func: Func, cx: &mut Context<'_>) -> Poll<()> {
611        self.with(|mut access| {
612            let store = access.as_context_mut().0;
613            let (_, _, _, raw_options) = func.abi_info(store);
614            let instance = func.instance().runtime_instance(raw_options.instance);
615            let state = store.instance_state(instance).concurrent_state();
616            if state.backpressure == 0 {
617                Poll::Ready(())
618            } else {
619                store
620                    .concurrent_state_mut_without_forcing_current_thread()
621                    .ready_for_concurrent_call_waker = Some(cx.waker().clone());
622                Poll::Pending
623            }
624        })
625    }
626}
627
628/// Represents an async closure which may be provided to `Accessor::spawn`,
629/// `Accessor::forward`, or `StoreContextMut::spawn`.
630// TODO: Replace this with `core::ops::AsyncFnOnce` when we are able to put `Send`
631// bound on the unnamed `Future` directly.
632//
633// As of this writing, it's not possible to specify e.g. `Send` and `Sync`
634// bounds on the `Future` type returned by an `AsyncFnOnce`.  Also, using `F:
635// Future<Output = Result<()>> + Send + Sync, FN: FnOnce(&Accessor<T>) -> F +
636// Send + Sync + 'static` fails with a type mismatch error as we cannot describe
637// that `F` should have `&Accessor<T>`'s unnamed lifetime
638//
639// Instead, this trait is used as a workaround for this limitation, the bound on `Self`
640// implementing `AsyncFnOnce()` is required for Rust to automatically infer that an async
641// closure is to be provided wherever we are accepting `impl for<'fut> AccessorTask<'fut, T, D>`
642// as argument. Otherwise, users will have to fully qualify the closure types before it
643// is accepted as a valid value. This also means that it is not intended for a user
644// to manually implement this trait for any arbitrary type, since they would first
645// have to implement `AsyncFnOnce`, which is unstable.
646//
647// The blanket implementation for this trait will ensure that `Self` is an async closure
648// that returns a `Future` that is `Send`, and lives as long as `&Accessor<T, D>`
649pub trait AccessorTask<'fut, T, D = HasSelf<T>>:
650    AsyncFnOnce(&Accessor<T, D>) -> Result<()> + Send + 'static
651where
652    D: HasData + ?Sized,
653{
654    /// Run the task.
655    fn run(self, accessor: &'fut Accessor<T, D>) -> impl Future<Output = Result<()>> + Send + 'fut;
656}
657
658impl<'fut, F, Fut, T, D> AccessorTask<'fut, T, D> for F
659where
660    T: 'static,
661    F: AsyncFnOnce(&Accessor<T, D>) -> Result<()>,
662    F: FnOnce(&'fut Accessor<T, D>) -> Fut + Send + 'static,
663    Fut: Future<Output = Result<()>> + Send + 'fut,
664    D: HasData,
665{
666    fn run(self, accessor: &'fut Accessor<T, D>) -> impl Future<Output = Result<()>> + Send + 'fut {
667        (self)(accessor)
668    }
669}
670
671/// Represents parameter and result metadata for the caller side of a
672/// guest->guest call orchestrated by a fused adapter.
673enum CallerInfo {
674    /// Metadata for a call to an async-lowered import
675    Async {
676        params: Vec<ValRaw>,
677        has_result: bool,
678    },
679    /// Metadata for a call to an sync-lowered import
680    Sync {
681        params: Vec<ValRaw>,
682        result_count: u32,
683    },
684}
685
686/// Indicates how a guest task is waiting on a waitable set.
687enum WaitMode {
688    /// The guest task is waiting using `task.wait`
689    Fiber(StoreFiber<'static>),
690    /// The guest task is waiting via a callback declared as part of an
691    /// async-lifted export.
692    Callback(Instance),
693}
694
695impl fmt::Debug for WaitMode {
696    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
697        match self {
698            Self::Fiber(_) => f.debug_tuple("Fiber").finish(),
699            Self::Callback(instance) => f.debug_tuple("Callback").field(instance).finish(),
700        }
701    }
702}
703
704/// Represents the reason a fiber is suspending itself.
705#[derive(Debug)]
706enum SuspendReason {
707    /// The fiber is waiting for an event to be delivered to the specified
708    /// waitable set or task.
709    Waiting {
710        set: TableId<WaitableSet>,
711        thread: QualifiedThreadId,
712    },
713    /// The fiber is waiting for a subtask to suspend or exit, e.g. for a
714    /// guest-to-guest call or a `subtask.cancel`.
715    YieldingToSubtask { thread: QualifiedThreadId },
716    /// The fiber has finished handling its most recent work item and is waiting
717    /// for another (or to be dropped if it is no longer needed).
718    NeedWork,
719    /// The fiber is yielding and should be resumed once other tasks have had a
720    /// chance to run.
721    Yielding { thread: QualifiedThreadId },
722    /// The fiber was explicitly suspended with a call to `thread.suspend` or
723    /// `thread.switch-to`.
724    ExplicitlySuspending { thread: QualifiedThreadId },
725}
726
727/// Represents a pending call into guest code for a given guest task.
728enum GuestCallKind {
729    /// Indicates there's an event to deliver to the task, possibly related to a
730    /// waitable set the task has been waiting on or polling.
731    DeliverEvent {
732        /// The instance to which the task belongs.
733        instance: Instance,
734        /// The waitable set the event belongs to, if any.
735        ///
736        /// If this is `None` the event will be waiting in the
737        /// `GuestTask::event` field for the task.
738        set: Option<TableId<WaitableSet>>,
739    },
740    /// Indicates that a new guest task call is pending and may be executed
741    /// using the specified closure.
742    StartImplicit(Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send + Sync>),
743    StartExplicit(Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send + Sync>),
744}
745
746impl fmt::Debug for GuestCallKind {
747    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
748        match self {
749            Self::DeliverEvent { instance, set } => f
750                .debug_struct("DeliverEvent")
751                .field("instance", instance)
752                .field("set", set)
753                .finish(),
754            Self::StartImplicit(_) => f.debug_tuple("StartImplicit").finish(),
755            Self::StartExplicit(_) => f.debug_tuple("StartExplicit").finish(),
756        }
757    }
758}
759
760/// The target of a suspension intrinsic.
761#[derive(Copy, Clone, Debug)]
762pub enum SuspensionTarget {
763    Resume(u32),
764    Promote(u32),
765    None,
766}
767
768/// Behavior for `resume_thread`.
769#[derive(Copy, Clone, Debug)]
770pub enum ResumeThread {
771    Promote,
772    Resume,
773    ResumeLater,
774}
775
776/// Represents a pending call into guest code for a given guest thread.
777#[derive(Debug)]
778struct GuestCall {
779    thread: QualifiedThreadId,
780    kind: GuestCallKind,
781}
782
783impl GuestCall {
784    /// Returns whether or not the call is ready to run.
785    ///
786    /// A call will not be ready to run if either:
787    ///
788    /// - the (sub-)component instance to be called has already been entered and
789    ///   cannot be reentered until an in-progress call completes, and the task
790    ///   requires the exclusive lock
791    ///
792    /// - the call is for a not-yet started task and the (sub-)component
793    ///   instance to be called has backpressure enabled
794    fn is_ready(&self, store: &mut StoreOpaque) -> Result<bool> {
795        let task = store.concurrent_state_mut()?.get_mut(self.thread.task)?;
796        let async_typed = task.async_typed;
797        let async_lifted = task.async_lifted;
798        let has_callback = task.callback.is_some();
799        let instance = task.instance;
800        let state = store.instance_state(instance).concurrent_state();
801
802        let ready = match &self.kind {
803            GuestCallKind::DeliverEvent { .. } => !state.do_not_enter,
804            GuestCallKind::StartImplicit(_) => {
805                if async_typed {
806                    // Sync- and callback-lifted exports need the instance's
807                    // exclusive lock to start, but stackful ones don't.
808                    let needs_exclusive = !async_lifted || has_callback;
809                    !((needs_exclusive && state.do_not_enter) || state.backpressure > 0)
810                } else {
811                    true
812                }
813            }
814            GuestCallKind::StartExplicit(_) => true,
815        };
816        log::trace!(
817            "call {self:?} ready? {ready} (do_not_enter: {}; backpressure: {})",
818            state.do_not_enter,
819            state.backpressure
820        );
821        Ok(ready)
822    }
823}
824
825/// Job to be run on a worker fiber.
826enum WorkerItem {
827    GuestCall(GuestCall),
828    Function(AlwaysMut<Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send>>),
829}
830
831/// Represents a pending work item to be handled by the event loop for a given
832/// component instance.
833enum WorkItem {
834    /// A host task to be pushed to `ConcurrentState::futures`.
835    PushFuture(AlwaysMut<HostTaskFuture>),
836    /// A fiber to resume.
837    ResumeFiber {
838        instance: RuntimeInstance,
839        thread: QualifiedThreadId,
840        fiber: StoreFiber<'static>,
841    },
842    /// A thread to resume.
843    ResumeThread {
844        instance: RuntimeInstance,
845        thread: QualifiedThreadId,
846    },
847    /// A pending call into guest code for a given guest task.
848    GuestCall {
849        instance: RuntimeInstance,
850        call: GuestCall,
851    },
852    /// A job to run on a worker fiber.
853    WorkerFunction(AlwaysMut<Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send>>),
854}
855
856/// A fiber temporarily outside the store's scheduler state.
857///
858/// Construct this before returning a future so cancellation before its first
859/// poll also disposes of the fiber. Successful handoffs take the fiber only
860/// after all fallible destination checks have completed.
861struct ResumingFiber<'a> {
862    store: &'a mut StoreOpaque,
863    fiber: Option<StoreFiber<'static>>,
864}
865
866impl Drop for ResumingFiber<'_> {
867    fn drop(&mut self) {
868        if let Some(mut fiber) = self.fiber.take() {
869            fiber.dispose(self.store);
870        }
871    }
872}
873
874impl fmt::Debug for WorkItem {
875    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
876        match self {
877            Self::PushFuture(_) => f.debug_tuple("PushFuture").finish(),
878            Self::ResumeFiber {
879                instance, thread, ..
880            } => f
881                .debug_struct("ResumeFiber")
882                .field("instance", instance)
883                .field("thread", thread)
884                .finish(),
885            Self::ResumeThread { instance, thread } => f
886                .debug_struct("ResumeThread")
887                .field("instance", instance)
888                .field("thread", thread)
889                .finish(),
890            Self::GuestCall { instance, call } => f
891                .debug_struct("GuestCall")
892                .field("instance", instance)
893                .field("call", call)
894                .finish(),
895            Self::WorkerFunction(_) => f.debug_tuple("WorkerFunction").finish(),
896        }
897    }
898}
899
900/// Whether a suspension intrinsic was cancelled or completed
901#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
902pub(crate) enum WaitResult {
903    Cancelled,
904    Completed,
905}
906
907/// Poll the specified future until it completes on behalf of a guest->host call
908/// using a sync-lowered import.
909///
910/// This is similar to `Instance::first_poll` except it's for sync-lowered
911/// imports, meaning we don't need to handle cancellation and we can block the
912/// caller until the task completes, at which point the caller can handle
913/// lowering the result to the guest's stack and linear memory.
914pub(crate) fn poll_and_block<R: Send + Sync + 'static>(
915    store: &mut dyn VMStore,
916    host_task: EnteredHostTask,
917    future: impl Future<Output = Result<R>> + Send + 'static,
918) -> Result<R> {
919    // Poll the future once before creating a host task. The host task will be
920    // created lazily if it's needed during the poll and otherwise will be
921    // created if the future suspends.  We can use a dummy `Waker` here because
922    // we'll add the future to `ConcurrentState::futures` and poll it
923    // automatically from the event loop if it doesn't complete immediately
924    // here.
925    let mut future = Box::pin(future);
926    let poll = tls::set(store, || {
927        future
928            .as_mut()
929            .poll(&mut Context::from_waker(&Waker::noop()))
930    });
931
932    let caller = match host_task {
933        Some(caller) => caller,
934        None => bail_bug!("host task wasn't created but should have been"),
935    };
936
937    let task = match poll {
938        // It completed immediately, so no persistent host task is needed.
939        Poll::Ready(result) => return result,
940
941        // It did not complete immediately; create the host task and add it to
942        // `ConcurrentState::futures` so it will be polled via the event loop;
943        // then use `GuestThread::sync_call_set` to wait for the task to
944        // complete, suspending the current fiber until it does so.
945        Poll::Pending => {
946            let Some(task) = store.materialize_host_task_id()? else {
947                bail_bug!("current thread is not a host thread")
948            };
949
950            // Wrap the future in a closure which will stash its result in the
951            // host task and resume this fiber when it completes.
952            let future = Box::pin(async move {
953                let result = run_with_host_task_set(task, future).await??;
954                tls::get(move |store| {
955                    let state = store.concurrent_state_mut()?;
956                    let host_state = &mut state.get_mut(task)?.state;
957                    assert!(matches!(host_state, HostTaskState::CalleeStarted));
958                    *host_state = HostTaskState::CalleeFinished(Box::new(result));
959
960                    Waitable::Host(task).set_event(
961                        state,
962                        Some(Event::Subtask {
963                            status: Status::Returned,
964                        }),
965                    )?;
966
967                    Ok(())
968                })
969            }) as HostTaskFuture;
970
971            let caller_instance = store.concurrent_state_mut()?.get_mut(caller.task)?.instance;
972            store.switch_or_trap_if_may_not_suspend(caller_instance)?;
973
974            let state = store.concurrent_state_mut()?;
975            state.push_future(future);
976
977            let set = state.get_mut(caller.thread)?.sync_call_set;
978            Waitable::Host(task).join(state, Some(set))?;
979
980            store.suspend(SuspendReason::Waiting {
981                set,
982                thread: caller,
983            })?;
984
985            // Remove the `task` from the `sync_call_set` to ensure that when
986            // this function returns and the task is deleted that there are no
987            // more lingering references to this host task.
988            Waitable::Host(task).join(store.concurrent_state_mut()?, None)?;
989            task
990        }
991    };
992
993    // Retrieve and return the result.
994    let host_state = &mut store.concurrent_state_mut()?.get_mut(task)?.state;
995    match mem::replace(host_state, HostTaskState::CalleeDone { cancelled: false }) {
996        HostTaskState::CalleeFinished(result) => Ok(match result.downcast() {
997            Ok(result) => *result,
998            Err(_) => bail_bug!("host task finished with wrong type of result"),
999        }),
1000        _ => bail_bug!("unexpected host task state after completion"),
1001    }
1002}
1003
1004/// Execute the specified guest call.
1005fn handle_guest_call(store: &mut dyn VMStore, call: GuestCall) -> Result<()> {
1006    match call.kind {
1007        GuestCallKind::DeliverEvent { instance, set } => {
1008            // This thread's wait on `set`, if any, which started in
1009            // `Instance::wait_with_callback`, ends here.
1010            if let Some(set) = set {
1011                store.concurrent_state_mut()?.get_mut(set)?.stop_waiting()?;
1012            }
1013            let (event, waitable) = match instance.get_event(store, call.thread.task, set, true)? {
1014                Some(pair) => pair,
1015                None => match set {
1016                    // The event which woke this thread up was taken by another
1017                    // thread (e.g. via `waitable-set.poll`) or its waitable was
1018                    // removed from the set before this thread had a chance to
1019                    // run. Regardless, keep waiting.
1020                    Some(set) => {
1021                        log::trace!(
1022                            "event for {:?} on {set:?} no longer present; waiting again",
1023                            call.thread
1024                        );
1025                        return instance.wait_with_callback(
1026                            store.store_opaque_mut(),
1027                            call.thread,
1028                            set,
1029                        );
1030                    }
1031                    // When a thread yields it doesn't wait on a set and the
1032                    // event to be delivered isn't stored anywhere, and this is
1033                    // just handling that case so indicate that the yield is
1034                    // complete.
1035                    None => (Event::None, None),
1036                },
1037            };
1038            let state = store.concurrent_state_mut()?;
1039            // If this thread was woken up by an event in `set` but is instead
1040            // receiving its own task's event (e.g. a cancellation), then the
1041            // set's event is left for another thread waiting on it, so wake
1042            // the next waiter up if there is one.
1043            if let Some(set) = set
1044                && waitable.is_none()
1045                && !state.get_mut(set)?.ready.is_empty()
1046            {
1047                state.wake_waiter(set)?;
1048            }
1049            let task = state.get_mut(call.thread.task)?;
1050            let runtime_instance = task.instance;
1051            let handle = waitable.map(|(_, v)| v).unwrap_or(0);
1052
1053            log::trace!(
1054                "use callback to deliver event {event:?} to {:?} for {waitable:?}",
1055                call.thread,
1056            );
1057
1058            instance.handle_callback_code(store, call.thread, runtime_instance, |store| {
1059                invoke_callback(store, call.thread.task, event, handle)
1060            })?;
1061        }
1062        GuestCallKind::StartImplicit(fun) => {
1063            fun(store)?;
1064        }
1065        GuestCallKind::StartExplicit(fun) => {
1066            fun(store)?;
1067        }
1068    }
1069
1070    Ok(())
1071}
1072
1073/// Invoke the callback of the callback-lifted `task` with `event` and
1074/// `handle`, returning the callback code it produces.
1075fn invoke_callback(
1076    store: &mut dyn VMStore,
1077    task: TableId<GuestTask>,
1078    event: Event,
1079    handle: u32,
1080) -> Result<u32> {
1081    let Some(callback) = store.concurrent_state_mut()?.get_mut(task)?.callback.take() else {
1082        bail_bug!("guest task callback field not present")
1083    };
1084
1085    let code = callback(store, event, handle)?;
1086
1087    store.concurrent_state_mut()?.get_mut(task)?.callback = Some(callback);
1088
1089    Ok(code)
1090}
1091
1092impl<T> Store<T> {
1093    /// Convenience wrapper for [`StoreContextMut::run_concurrent`].
1094    pub async fn run_concurrent<R>(&mut self, fun: impl AsyncFnOnce(&Accessor<T>) -> R) -> Result<R>
1095    where
1096        T: Send + 'static,
1097    {
1098        ensure!(
1099            self.as_context().0.concurrency_support(),
1100            "cannot use `run_concurrent` when Config::concurrency_support disabled",
1101        );
1102        self.as_context_mut().run_concurrent(fun).await
1103    }
1104
1105    #[doc(hidden)]
1106    pub fn assert_concurrent_state_empty(&mut self) {
1107        self.as_context_mut().assert_concurrent_state_empty();
1108    }
1109
1110    #[doc(hidden)]
1111    pub fn concurrent_state_table_size(&mut self) -> usize {
1112        self.as_context_mut().concurrent_state_table_size()
1113    }
1114
1115    /// Convenience wrapper for [`StoreContextMut::spawn`].
1116    pub fn spawn(
1117        &mut self,
1118        task: impl for<'fut> AccessorTask<'fut, T, HasSelf<T>>,
1119    ) -> Result<JoinHandle>
1120    where
1121        T: 'static,
1122    {
1123        self.as_context_mut().spawn(task)
1124    }
1125}
1126
1127impl<T> StoreContextMut<'_, T> {
1128    /// Assert that all the relevant tables and queues in the concurrent state
1129    /// for this store are empty.
1130    ///
1131    /// This is for sanity checking in integration tests
1132    /// (e.g. `component-async-tests`) that the relevant state has been cleared
1133    /// after each test concludes.  This should help us catch leaks, e.g. guest
1134    /// tasks which haven't been deleted despite having completed and having
1135    /// been dropped by their supertasks.
1136    ///
1137    /// Only intended for use in Wasmtime's own testing.
1138    #[doc(hidden)]
1139    pub fn assert_concurrent_state_empty(self) {
1140        let store = self.0;
1141        store
1142            .store_data_mut()
1143            .components
1144            .assert_instance_states_empty();
1145        let state = store.concurrent_state_mut().unwrap();
1146        assert!(
1147            state.table.get_mut().is_empty(),
1148            "non-empty table: {:?}",
1149            state.table.get_mut()
1150        );
1151        assert!(state.switch_item.is_none());
1152        assert!(state.next_switch_item.is_none());
1153        assert!(state.high_priority.is_empty());
1154        assert!(state.low_priority.is_empty());
1155        assert!(state.saved_next_switch_items.is_empty());
1156        assert!(state.unforced_current_thread.is_none());
1157        assert!(state.deferred_host_call_context.is_none());
1158        assert!(state.futures_mut().unwrap().is_empty());
1159        assert!(state.global_error_context_ref_counts.is_empty());
1160    }
1161
1162    /// Helper function to perform tests over the size of the concurrent state
1163    /// table which can be useful for detecting leaks.
1164    ///
1165    /// Only intended for use in Wasmtime's own testing.
1166    #[doc(hidden)]
1167    pub fn concurrent_state_table_size(&mut self) -> usize {
1168        self.0.concurrent_state_mut().unwrap().table.get_mut().len()
1169    }
1170
1171    /// Spawn a background task to run as part of this instance's event loop.
1172    ///
1173    /// The task will receive an `&Accessor<U>` and run concurrently with
1174    /// any other tasks in progress for the instance.
1175    ///
1176    /// Note that the task will only make progress if and when the event loop
1177    /// for this instance is run.
1178    ///
1179    /// The returned [`JoinHandle`] may be used to cancel the task.
1180    pub fn spawn(mut self, task: impl for<'fut> AccessorTask<'fut, T>) -> Result<JoinHandle>
1181    where
1182        T: 'static,
1183    {
1184        let accessor = Accessor::new(StoreToken::new(self.as_context_mut()));
1185        self.spawn_with_accessor(accessor, task)
1186    }
1187
1188    /// Internal implementation of `spawn` functions where a `store` is
1189    /// available along with an `Accessor`.
1190    fn spawn_with_accessor<D>(
1191        self,
1192        accessor: Accessor<T, D>,
1193        task: impl for<'fut> AccessorTask<'fut, T, D>,
1194    ) -> Result<JoinHandle>
1195    where
1196        T: 'static,
1197        D: HasData + ?Sized,
1198    {
1199        // Create an "abortable future" here where internally the future will
1200        // hook calls to poll and possibly spawn more background tasks on each
1201        // iteration.
1202        let (handle, future) = JoinHandle::run(async move { task.run(&accessor).await });
1203        self.0
1204            .concurrent_state_mut()?
1205            .push_future(Box::pin(async move { future.await.unwrap_or(Ok(())) }));
1206        Ok(handle)
1207    }
1208
1209    /// Run the specified closure `fun` to completion as part of this store's
1210    /// event loop.
1211    ///
1212    /// This will run `fun` as part of this store's event loop until it
1213    /// yields a result.  `fun` is provided an [`Accessor`], which provides
1214    /// controlled access to the store and its data.
1215    ///
1216    /// This function can be used to invoke [`Func::call_concurrent`] for
1217    /// example within the async closure provided here.
1218    ///
1219    /// This function will unconditionally return an error if
1220    /// [`Config::concurrency_support`] is disabled.
1221    ///
1222    /// [`Config::concurrency_support`]: crate::Config::concurrency_support
1223    ///
1224    /// # Store-blocking behavior
1225    ///
1226    /// At this time there are certain situations in which the `Future` returned
1227    /// by the `AsyncFnOnce` passed to this function will not be polled for an
1228    /// extended period of time, despite one or more `Waker::wake` events having
1229    /// occurred for the task to which it belongs.  This can manifest as the
1230    /// `Future` seeming to be "blocked" or "locked up", but is actually due to
1231    /// the `Store` being held by e.g. a blocking host function, preventing the
1232    /// `Future` from being polled. A canonical example of this is when the
1233    /// `fun` provided to this function attempts to set a timeout for an
1234    /// invocation of a wasm function. In this situation the async closure is
1235    /// waiting both on (a) the wasm computation to finish, and (b) the timeout
1236    /// to elapse. At this time this setup will not always work and the timeout
1237    /// may not reliably fire.
1238    ///
1239    /// This function will not block the current thread and as such is always
1240    /// suitable to run in an `async` context, but the current implementation of
1241    /// Wasmtime can lead to situations where a certain wasm computation is
1242    /// required to make progress the closure to make progress. This is an
1243    /// artifact of Wasmtime's historical implementation of `async` functions
1244    /// and is the topic of [#11869] and [#11870]. In the timeout example from
1245    /// above it means that Wasmtime can get "wedged" for a bit where (a) must
1246    /// progress for a readiness notification of (b) to get delivered.
1247    ///
1248    /// This effectively means that it's not possible to reliably perform a
1249    /// "select" operation within the `fun` closure, which timeouts for example
1250    /// are based on. Fixing this requires some relatively major refactoring
1251    /// work within Wasmtime itself. This is a known pitfall otherwise and one
1252    /// that is intended to be fixed one day. In the meantime it's recommended
1253    /// to apply timeouts or such to the entire `run_concurrent` call itself
1254    /// rather than internally.
1255    ///
1256    /// [#11869]: https://github.com/bytecodealliance/wasmtime/issues/11869
1257    /// [#11870]: https://github.com/bytecodealliance/wasmtime/issues/11870
1258    ///
1259    /// # Example
1260    ///
1261    /// ```
1262    /// # use {
1263    /// #   wasmtime::{
1264    /// #     error::{Result},
1265    /// #     component::{ Component, Linker, Resource, ResourceTable},
1266    /// #     Config, Engine, Store
1267    /// #   },
1268    /// # };
1269    /// #
1270    /// # struct MyResource(u32);
1271    /// # struct Ctx { table: ResourceTable }
1272    /// #
1273    /// # async fn foo() -> Result<()> {
1274    /// # let mut config = Config::new();
1275    /// # let engine = Engine::new(&config)?;
1276    /// # let mut store = Store::new(&engine, Ctx { table: ResourceTable::new() });
1277    /// # let mut linker = Linker::new(&engine);
1278    /// # let component = Component::new(&engine, "")?;
1279    /// # let instance = linker.instantiate_async(&mut store, &component).await?;
1280    /// # let foo = instance.get_typed_func::<(Resource<MyResource>,), (Resource<MyResource>,)>(&mut store, "foo")?;
1281    /// # let bar = instance.get_typed_func::<(u32,), ()>(&mut store, "bar")?;
1282    /// store.run_concurrent(async |accessor| -> wasmtime::Result<_> {
1283    ///    let resource = accessor.with(|mut access| access.get().table.push(MyResource(42)))?;
1284    ///    let (another_resource,) = foo.call_concurrent(accessor, (resource,)).await?;
1285    ///    let value = accessor.with(|mut access| access.get().table.delete(another_resource))?;
1286    ///    bar.call_concurrent(accessor, (value.0,)).await?;
1287    ///    Ok(())
1288    /// }).await??;
1289    /// # Ok(())
1290    /// # }
1291    /// ```
1292    pub async fn run_concurrent<R>(self, fun: impl AsyncFnOnce(&Accessor<T>) -> R) -> Result<R>
1293    where
1294        T: Send + 'static,
1295    {
1296        ensure!(
1297            self.0.concurrency_support(),
1298            "cannot use `run_concurrent` when Config::concurrency_support disabled",
1299        );
1300        self.do_run_concurrent(fun, false).await
1301    }
1302
1303    pub(super) async fn run_concurrent_trap_on_idle<R>(
1304        self,
1305        fun: impl AsyncFnOnce(&Accessor<T>) -> R,
1306    ) -> Result<R> {
1307        self.do_run_concurrent(fun, true).await
1308    }
1309
1310    async fn do_run_concurrent<R>(
1311        mut self,
1312        fun: impl AsyncFnOnce(&Accessor<T>) -> R,
1313        trap_on_idle: bool,
1314    ) -> Result<R> {
1315        debug_assert!(self.0.concurrency_support());
1316        self.0.check_event_loop_not_running()?;
1317        let token = StoreToken::new(self.as_context_mut());
1318
1319        struct Dropper<'a, T: 'static, V> {
1320            store: StoreContextMut<'a, T>,
1321            value: ManuallyDrop<V>,
1322        }
1323
1324        impl<'a, T, V> Drop for Dropper<'a, T, V> {
1325            fn drop(&mut self) {
1326                self.store
1327                    .0
1328                    .concurrent_state_mut_already_forced_current_thread()
1329                    .event_loop_running = false;
1330
1331                tls::set(self.store.0, || {
1332                    // SAFETY: Here we drop the value without moving it for the
1333                    // first and only time -- per the contract for `Drop::drop`,
1334                    // this code won't run again, and the `value` field will no
1335                    // longer be accessible.
1336                    unsafe { ManuallyDrop::drop(&mut self.value) }
1337                });
1338            }
1339        }
1340
1341        let accessor = &Accessor::new(token);
1342        self.0
1343            .concurrent_state_mut_already_forced_current_thread()
1344            .event_loop_running = true;
1345        let dropper = &mut Dropper {
1346            store: self,
1347            value: ManuallyDrop::new(fun(accessor)),
1348        };
1349        // SAFETY: We never move `dropper` nor its `value` field.
1350        let future = unsafe { Pin::new_unchecked(dropper.value.deref_mut()) };
1351
1352        let result = dropper
1353            .store
1354            .as_context_mut()
1355            .poll_until(future, trap_on_idle)
1356            .await;
1357
1358        if result.is_err() {
1359            dropper.store.0.set_trapped();
1360        }
1361
1362        result
1363    }
1364
1365    /// Run this store's event loop.
1366    ///
1367    /// The returned future will resolve when the specified future completes or,
1368    /// if `trap_on_idle` is true, when the event loop can't make further
1369    /// progress.
1370    async fn poll_until<R>(
1371        mut self,
1372        mut future: Pin<&mut impl Future<Output = R>>,
1373        trap_on_idle: bool,
1374    ) -> Result<R> {
1375        struct Reset<'a, T: 'static> {
1376            store: StoreContextMut<'a, T>,
1377            futures: Option<FuturesUnordered<HostTaskFuture>>,
1378        }
1379
1380        impl<'a, T> Drop for Reset<'a, T> {
1381            fn drop(&mut self) {
1382                if let Some(futures) = self.futures.take() {
1383                    *self
1384                        .store
1385                        .0
1386                        .concurrent_state_mut_already_forced_current_thread()
1387                        .futures
1388                        .get_mut() = Some(futures);
1389                }
1390            }
1391        }
1392
1393        // Keep a continuously busy event loop from holding one executor poll
1394        // indefinitely.  In particular, Tokio's cooperative budget is only
1395        // replenished when the future returns `Pending` to the executor.
1396        const MAX_TURNS_WITHOUT_YIELD: usize = 128;
1397        let mut turns_without_yield = 0;
1398
1399        loop {
1400            // Take `ConcurrentState::futures` out of the store so we can poll
1401            // it while also safely giving any of the futures inside access to
1402            // `self`.
1403            let futures = self.0.concurrent_state_mut()?.futures.get_mut().take();
1404            let mut reset = Reset {
1405                store: self.as_context_mut(),
1406                futures,
1407            };
1408            let mut next = match reset.futures.as_mut() {
1409                Some(f) => pin!(f.next()),
1410                None => bail_bug!("concurrent state missing futures field"),
1411            };
1412
1413            enum PollResult<R> {
1414                Complete(R),
1415                ProcessWork {
1416                    ready: Option<WorkItem>,
1417                    low_priority: bool,
1418                },
1419            }
1420
1421            let result = future::poll_fn(|cx| {
1422                // First, poll the future we were passed as an argument and
1423                // return immediately if it's ready.
1424                if let Poll::Ready(value) = tls::set(reset.store.0, || future.as_mut().poll(cx)) {
1425                    return Poll::Ready(Ok(PollResult::Complete(value)));
1426                }
1427
1428                // If the store has been poisoned by a trap, either before this
1429                // event loop started or while it was running, then refuse to
1430                // make any further progress. Any work items, suspended fibers,
1431                // or pending futures left over from the trap might otherwise
1432                // resume guest code or observe scheduler state which was never
1433                // unwound. Note that this is checked after polling `future`
1434                // above so that it can observe the original error, e.g. a
1435                // trap delivered over a oneshot channel by a work item.
1436                if reset.store.0.trapped() {
1437                    return Poll::Ready(Err(Trap::CannotEnterComponent.into()));
1438                }
1439
1440                // Next, poll `ConcurrentState::futures` (which includes any
1441                // pending host tasks and/or background tasks), returning
1442                // immediately if one of them fails.
1443                let next = match tls::set(reset.store.0, || next.as_mut().poll(cx)) {
1444                    Poll::Ready(Some(output)) => {
1445                        match output {
1446                            Err(e) => return Poll::Ready(Err(e)),
1447                            Ok(()) => {}
1448                        }
1449                        Poll::Ready(true)
1450                    }
1451                    Poll::Ready(None) => Poll::Ready(false),
1452                    Poll::Pending => Poll::Pending,
1453                };
1454
1455                // Next, identify the next work item to process, if any, using
1456                // the following priority order:
1457                //
1458                // - `switch_item`: Represents the guest thread we _must_ switch
1459                // to before any other thread runs per the determinism
1460                // requirements in the Component Model spec.
1461                //
1462                // - `high_priority`: "Urgent" work items, e.g. async calls have
1463                // become freshly unblocked due to backpressure clearing or
1464                // similar, stream or future state updates, etc.
1465                //
1466                // - `low_priority`: Work items such as resuming a fiber after
1467                // it yields, in which case the point is to let other items run
1468                // first.
1469                let state = reset.store.0.concurrent_state_mut()?;
1470                let mut ready = state.switch_item.take();
1471                let mut low_priority = false;
1472                if ready.is_none() {
1473                    ready = state.high_priority.pop_back();
1474                    if ready.is_none() {
1475                        ready = state.low_priority.pop_back();
1476                        low_priority = true;
1477                    }
1478                }
1479                if ready.is_some() {
1480                    return Poll::Ready(Ok(PollResult::ProcessWork {
1481                        ready,
1482                        low_priority,
1483                    }));
1484                }
1485
1486                // Finally, if we have nothing else to do right now, determine what to do
1487                // based on whether there are any pending futures in
1488                // `ConcurrentState::futures`.
1489                return match next {
1490                    Poll::Ready(true) => {
1491                        // In this case, one of the futures in
1492                        // `ConcurrentState::futures` completed
1493                        // successfully, so we return now and continue
1494                        // the outer loop in case there is another one
1495                        // ready to complete.
1496                        Poll::Ready(Ok(PollResult::ProcessWork {
1497                            ready: None,
1498                            low_priority: false,
1499                        }))
1500                    }
1501                    Poll::Ready(false) => {
1502                        // Poll the future we were passed one last time
1503                        // in case one of `ConcurrentState::futures` had
1504                        // the side effect of unblocking it.
1505                        if let Poll::Ready(value) =
1506                            tls::set(reset.store.0, || future.as_mut().poll(cx))
1507                        {
1508                            Poll::Ready(Ok(PollResult::Complete(value)))
1509                        } else {
1510                            // In this case, there are no more pending
1511                            // futures in `ConcurrentState::futures`,
1512                            // there are no remaining work items, _and_
1513                            // the future we were passed as an argument
1514                            // still hasn't completed.
1515                            if trap_on_idle {
1516                                // `trap_on_idle` is true, so we exit
1517                                // immediately.
1518
1519                                // If there are any tasks belonging to
1520                                // an instance which may not suspend, trap with
1521                                // `CannotBlockSyncTask`:
1522                                Poll::Ready(Err(if reset.store.0.any_may_not_suspend()? {
1523                                    Trap::CannotBlockSyncTask.into()
1524                                } else {
1525                                    // Otherwise, trap with `AsyncDeadlock`:
1526                                    Trap::AsyncDeadlock.into()
1527                                }))
1528                            } else {
1529                                // `trap_on_idle` is false, so we assume
1530                                // that future will wake up and give us
1531                                // more work to do when it's ready to.
1532                                Poll::Pending
1533                            }
1534                        }
1535                    }
1536                    // There is at least one pending future in
1537                    // `ConcurrentState::futures` and we have nothing
1538                    // else to do but wait for now, so we return
1539                    // `Pending`.
1540                    Poll::Pending => Poll::Pending,
1541                };
1542            })
1543            .await;
1544
1545            // Put the `ConcurrentState::futures` back into the store before we
1546            // return or handle any work items since one or more of those items
1547            // might append more futures.
1548            drop(reset);
1549
1550            match result? {
1551                // The future we were passed as an argument completed, so we
1552                // return the result.
1553                PollResult::Complete(value) => break Ok(value),
1554                // The future we were passed has not yet completed, so handle
1555                // any work items and then loop again.
1556                PollResult::ProcessWork {
1557                    mut ready,
1558                    low_priority,
1559                } => {
1560                    // If we're about to run a low-priority task, first yield to
1561                    // the executor.  This ensures that it won't be starved of
1562                    // the ability to e.g. update the readiness of sockets,
1563                    // etc. which the guest may be using `thread.yield` along
1564                    // with `waitable-set.poll` to monitor in a CPU-heavy loop.
1565                    //
1566                    // This works for e.g. `thread.yield` and callbacks which
1567                    // return `CALLBACK_CODE_YIELD` because we queue a low
1568                    // priority item to resume the task (i.e. resume the thread
1569                    // or call the callback, respectively) just prior to
1570                    // suspending it.  Indeed, as of this writing those are the
1571                    // _only_ situations we queue low-priority tasks.
1572                    // Therefore, we interpret the guest's request to yield as
1573                    // meaning "yield to other guest tasks _and_/_or_ host
1574                    // operations such as updating socket readiness", the latter
1575                    // being the async runtime's responsibility.
1576                    //
1577                    // In the future, if this ends up causing measurable
1578                    // performance issues, this could be optimized such that we
1579                    // only yield periodically (e.g. for batches of low priority
1580                    // items) and not for each and every individual item.
1581                    //
1582                    // While we're yielded put the item back on the queue so it
1583                    // stays live within the store, and then if/when we come
1584                    // back take it back out. Note that the `await` point here
1585                    // owns the entire `StoreContextMut` so what we push should
1586                    // be what we pop.
1587                    if low_priority {
1588                        if let Some(item) = ready.take() {
1589                            self.0.concurrent_state_mut()?.low_priority.push_back(item);
1590                        }
1591                        self.0.yield_now().await;
1592                        turns_without_yield = 0;
1593                        ready = self.0.concurrent_state_mut()?.low_priority.pop_back();
1594                    }
1595
1596                    if let Some(item) = ready {
1597                        self.as_context_mut().handle_work_item(item).await?;
1598                    }
1599
1600                    turns_without_yield += 1;
1601                    if turns_without_yield == MAX_TURNS_WITHOUT_YIELD {
1602                        turns_without_yield = 0;
1603                        self.0.yield_now().await;
1604                    }
1605                }
1606            }
1607        }
1608    }
1609
1610    /// Handle the specified work item, possibly resuming a fiber if applicable.
1611    fn handle_work_item(self, item: WorkItem) -> impl Future<Output = Result<()>> {
1612        // Construct the guarded future before returning, even when the caller
1613        // never polls this work item. Other variants keep their fibers in the
1614        // store until their first poll.
1615        let item = match item {
1616            WorkItem::ResumeFiber {
1617                instance,
1618                thread,
1619                fiber,
1620            } => {
1621                let future = self.0.resume_fiber(fiber);
1622                log::trace!(
1623                    "handle work item ResumeFiber {{ instance: {instance:?}, thread: {thread:?} }}"
1624                );
1625                return futures::future::Either::Left(future);
1626            }
1627            item => item,
1628        };
1629        futures::future::Either::Right(async move {
1630            log::trace!("handle work item {item:?}");
1631            match item {
1632                WorkItem::PushFuture(future) => {
1633                    self.0
1634                        .concurrent_state_mut()?
1635                        .futures_mut()?
1636                        .push(future.into_inner());
1637                }
1638                WorkItem::ResumeFiber { .. } => unreachable!(),
1639                WorkItem::ResumeThread { thread, .. } => {
1640                    let slot = &mut self.0.concurrent_state_mut()?.get_mut(thread.thread)?.state;
1641                    if !matches!(slot, GuestThreadState::Ready { .. }) {
1642                        bail_bug!("cannot resume non-pending thread {thread:?}");
1643                    }
1644                    let GuestThreadState::Ready { fiber } =
1645                        mem::replace(slot, GuestThreadState::Running)
1646                    else {
1647                        unreachable!()
1648                    };
1649                    self.0.resume_fiber(fiber).await?;
1650                }
1651                WorkItem::GuestCall { call, .. } => {
1652                    if call.is_ready(self.0)? {
1653                        self.0
1654                            .concurrent_state_mut()?
1655                            .get_mut(call.thread.thread)?
1656                            .wake_on_cancel = WakeOnCancel::None;
1657                        self.run_on_worker(WorkerItem::GuestCall(call)).await?;
1658                    } else {
1659                        let state = self.0.concurrent_state_mut()?;
1660                        let task = state.get_mut(call.thread.task)?;
1661                        if !task.starting_sent {
1662                            task.starting_sent = true;
1663                            if let GuestCallKind::StartImplicit(_) = &call.kind {
1664                                Waitable::Guest(call.thread.task).set_event(
1665                                    state,
1666                                    Some(Event::Subtask {
1667                                        status: Status::Starting,
1668                                    }),
1669                                )?;
1670                            }
1671                        }
1672
1673                        let instance = state.get_mut(call.thread.task)?.instance;
1674                        // If this call is for a callback-lifted task waiting on a
1675                        // waitable set, it can't run until `instance` is enterable
1676                        // again. Meanwhile, the set may have an event which another
1677                        // thread waiting on it could take, and that thread may
1678                        // even be the reason `instance` isn't enterable, so wake
1679                        // the next waiter up as well if there's still an event
1680                        // for it. Whichever thread runs first takes the event, and
1681                        // the other goes back to waiting if none is left.
1682                        if let GuestCallKind::DeliverEvent { set: Some(set), .. } = &call.kind {
1683                            let state = self.0.concurrent_state_mut()?;
1684                            if !state.get_mut(*set)?.ready.is_empty() {
1685                                state.wake_waiter(*set)?;
1686                            }
1687                        }
1688                        self.0
1689                            .instance_state(instance)
1690                            .concurrent_state()
1691                            .pending
1692                            .insert(call.thread, call.kind);
1693
1694                        // Switch back to the caller (or canceller) immediately if
1695                        // applicable since we aren't yet able to run the subtask it
1696                        // yielded to.
1697                        self.0.concurrent_state_mut()?.take_next_switch_item()?;
1698                    }
1699                }
1700                WorkItem::WorkerFunction(fun) => {
1701                    self.run_on_worker(WorkerItem::Function(fun)).await?;
1702                }
1703            }
1704
1705            Ok(())
1706        })
1707    }
1708
1709    /// Execute the specified guest call on a worker fiber.
1710    async fn run_on_worker(self, item: WorkerItem) -> Result<()> {
1711        let state = self.0.concurrent_state_mut()?;
1712        if state.worker_item.is_some() {
1713            bail_bug!("worker item already set when taking worker fiber");
1714        }
1715        let worker = if let Some(fiber) = state.worker.take() {
1716            fiber
1717        } else {
1718            // SAFETY: the `make_fiber_unchecked` function is unsafe because the
1719            // returned fiber is unconditionally `Send` as opposed to being
1720            // conditionally send depending on the argument (in this case
1721            // `self.0`). This `async` function, however, is conditionally
1722            // `Send` depending on `self`, in this case `StoreContextMut<T>`,
1723            // which is already going to be conditionally `Send` depending on
1724            // `T`.
1725            //
1726            // The returned fiber is possibly stored within the `Store<T>` as
1727            // well. If `T: Send` then that's fine and everything's dandy. If
1728            // `T: !Send`, however, then the store is already not-`Send` meaning
1729            // that putting more actually-not-`Send` things inside of it isn't
1730            // an issue.
1731            //
1732            // The main issue here is that the returned fiber effectively can't
1733            // get transferred outside the context of the store. That's an
1734            // implementation detail we'll have to rely on, but is currently
1735            // true.
1736            unsafe {
1737                fiber::make_fiber_unchecked(self.0, move |store| {
1738                    loop {
1739                        let Some(item) = store.concurrent_state_mut()?.worker_item.take() else {
1740                            bail_bug!("worker_item not present when resuming fiber")
1741                        };
1742                        match item {
1743                            WorkerItem::GuestCall(call) => handle_guest_call(store, call)?,
1744                            WorkerItem::Function(fun) => fun.into_inner()(store)?,
1745                        }
1746
1747                        store.suspend(SuspendReason::NeedWork)?;
1748                    }
1749                })?
1750            }
1751        };
1752
1753        // No fallible operation between taking the fiber and guarding it in
1754        // resume_fiber; the current thread was forced before the take.
1755        self.0
1756            .concurrent_state_mut_already_forced_current_thread()
1757            .worker_item = Some(item);
1758
1759        self.0.resume_fiber(worker).await
1760    }
1761
1762    /// Wrap the specified host function in a future which will call it, passing
1763    /// it an `&Accessor<T>`.
1764    ///
1765    /// See the `Accessor` documentation for details.
1766    pub(crate) fn wrap_call<F, R>(self, closure: F) -> impl Future<Output = Result<R>> + 'static
1767    where
1768        T: 'static,
1769        F: FnOnce(&Accessor<T>) -> Pin<Box<dyn Future<Output = Result<R>> + Send + '_>>
1770            + Send
1771            + Sync
1772            + 'static,
1773        R: Send + Sync + 'static,
1774    {
1775        let token = StoreToken::new(self);
1776        async move {
1777            let mut accessor = Accessor::new(token);
1778            closure(&mut accessor).await
1779        }
1780    }
1781
1782    pub(crate) async fn start_instance(
1783        &mut self,
1784        instance: ModuleInstance,
1785        callee: Option<RuntimeInstance>,
1786    ) -> Result<ModuleInstance> {
1787        let (tx, rx) = oneshot::channel();
1788        let token = StoreToken::new(self.as_context_mut());
1789        self.0.queue_task(move |store| {
1790            _ = tx.send(
1791                super::instance::start_raw(&mut token.as_context_mut(store), instance, callee)
1792                    .map(|()| instance),
1793            );
1794            Ok(())
1795        })?;
1796        self.as_context_mut()
1797            .run_concurrent_trap_on_idle(async |_| {
1798                rx.await
1799                    .map_err(|_| format_err!("oneshot channel canceled"))
1800            })
1801            .await??
1802    }
1803}
1804
1805/// Return value of [`StoreOpaque::host_task_create`].
1806///
1807/// This is an `Option` to handle the dynamic `store.concurrency_support()`
1808/// property. When present this records the guest thread to restore when the
1809/// host call exits. The corresponding [`HostTask`] will need to be lazily
1810/// created if needed via [`StoreOpaque::materialize_host_task_id`].
1811pub type EnteredHostTask = Option<QualifiedThreadId>;
1812
1813impl StoreOpaque {
1814    pub(crate) fn check_event_loop_not_running(&mut self) -> Result<()> {
1815        if self
1816            .concurrent_state_mut_already_forced_current_thread()
1817            .event_loop_running
1818        {
1819            bail!("Recursive `StoreContextMut::run_concurrent` calls not supported")
1820        }
1821        Ok(())
1822    }
1823
1824    /// Returns the currently-running thread, promoting any deferred lazy guest
1825    /// thread into a fully-materialized `CurrentThread`. Deferred [`HostTask`]s
1826    /// are not materialized.
1827    #[inline]
1828    pub(crate) fn current_thread(&mut self) -> Result<CurrentThread> {
1829        // Without concurrency support there is nothing to force.
1830        if !self.concurrency_support() {
1831            return Ok(CurrentThread::None);
1832        }
1833
1834        // If the JIT-visible current thread isn't a deferred thread then
1835        // `ConcurrentState` is already up to date.
1836        if !self
1837            .vm_store_context_mut()
1838            .current_thread_mut()
1839            .is_deferred()
1840        {
1841            return Ok(self
1842                .concurrent_state_mut_already_forced_current_thread()
1843                .unforced_current_thread);
1844        }
1845
1846        self.force_deferred_current_thread()
1847    }
1848
1849    /// Slow path of [`Self::current_thread`]: promote the deferred lazy
1850    /// thread into a fully-materialized `CurrentThread`.
1851    #[cold]
1852    fn force_deferred_current_thread(&mut self) -> Result<CurrentThread> {
1853        // The component instance whose adapters pushed the deferred frames; all
1854        // frames in a guest-to-guest, sync-to-sync call chain of fused adapters
1855        // live within a single `wasmtime::component::Instance` (because
1856        // cross-`wasmtime::component::Instance` calls don't go through fused
1857        // adapters), and guest code only ever runs as a guest thread, so the
1858        // chain's base thread is already materialized in `ConcurrentState` and
1859        // we can get the `ComponentInstanceId` shared by the whole chain from
1860        // here.
1861        let state = self.concurrent_state_mut_without_forcing_current_thread();
1862        let id = match state.unforced_current_thread.guest_task() {
1863            Some(task) => state.get_mut(task)?.instance.instance,
1864            None => bail_bug!("deferred component-model thread with non-guest base"),
1865        };
1866
1867        // Collect the deferred frames pushed inline by fused adapters, walking
1868        // the `parent` chain from innermost to the base.
1869        let mut frames = Vec::new();
1870        let mut cur = *self.vm_store_context_mut().current_thread_mut();
1871        while let Some(ptr) = cur.as_deferred() {
1872            // SAFETY: `ptr` points at a `VMDeferredThread` living in a fused
1873            // adapter's stack frame that is suspended below us on the stack
1874            // (mid-call, waiting for this nested call to return), so the
1875            // referent is still valid and exclusively ours to read.
1876            let deferred = unsafe { ptr.as_non_null().as_ref() };
1877            frames.push((
1878                deferred.callee_async != 0,
1879                deferred.callee_instance,
1880                deferred.saved_context,
1881            ));
1882            cur = deferred.parent;
1883        }
1884
1885        // Mark the current thread forced *before* replaying so that any
1886        // reentrant `force_current_thread` call short-circuits via the
1887        // non-deferred path above.
1888        *self.vm_store_context_mut().current_thread_mut() = VMLazyThread::forced();
1889
1890        // Save the current context, as we need to overwrite it while replaying
1891        // below.
1892        let current_context = *self.vm_store_context_mut().component_context_mut();
1893
1894        // Replay the deferred `enter_guest_sync_call`s outermost-first so that
1895        // the resulting `ConcurrentState` matches what the non-deferred path
1896        // would have otherwise produced.
1897        for (callee_async, callee_instance, saved_context) in frames.into_iter().rev() {
1898            // Restore the caller's context slots so that we save the correct
1899            // values into the caller's thread, exactly as the non-deferred path
1900            // would have on entry.
1901            *self.vm_store_context_mut().component_context_mut() = saved_context;
1902            let callee = RuntimeInstance {
1903                instance: id,
1904                index: RuntimeComponentInstanceIndex::from_u32(callee_instance),
1905            };
1906            self.enter_guest_sync_call(callee_async, callee)?;
1907        }
1908
1909        // Replaying done; restore the current context.
1910        *self.vm_store_context_mut().component_context_mut() = current_context;
1911
1912        Ok(self
1913            .concurrent_state_mut_without_forcing_current_thread()
1914            .unforced_current_thread)
1915    }
1916
1917    fn current_guest_thread(&mut self) -> Result<QualifiedThreadId> {
1918        match self.current_thread()?.guest() {
1919            Some(id) => Ok(*id),
1920            None => bail_bug!("current thread is not a guest thread"),
1921        }
1922    }
1923
1924    // A result of `None` may indicate that this is either the top-level event
1925    // loop, a deferred host task, or concurrency support is disabled. In all
1926    // cases we don't have an ID for the task.
1927    pub(crate) fn current_materialized_host_task(&mut self) -> Result<Option<TableId<HostTask>>> {
1928        match self.current_thread()? {
1929            CurrentThread::Host(id) => Ok(Some(id)),
1930            CurrentThread::DeferredHost(_) | CurrentThread::None => Ok(None),
1931            _ => bail_bug!("current thread is not a host thread"),
1932        }
1933    }
1934
1935    /// Returns the current host task ID, materializing a deferred host task if
1936    /// one is active. `None` represents a call from the top-level host.
1937    fn materialize_host_task_id(&mut self) -> Result<Option<TableId<HostTask>>> {
1938        Ok(self
1939            .concurrent_state_mut()?
1940            .materialize_current_host_task_id()?)
1941    }
1942
1943    fn enter_sync_call(&mut self, callee: RuntimeInstance) -> Result<()> {
1944        log::trace!("enter sync-typed call {callee:?}");
1945        let state = self.instance_state(callee).concurrent_state();
1946        let old_do_not_suspend = state.do_not_suspend;
1947        state.do_not_suspend = true;
1948
1949        let thread = self.current_guest_thread()?;
1950        let thread = self.concurrent_state_mut()?.get_mut(thread.thread)?;
1951        if thread.old_do_not_suspend.is_some() {
1952            bail_bug!("current thread already has `old_do_not_suspend` value");
1953        }
1954
1955        thread.old_do_not_suspend = Some(old_do_not_suspend);
1956
1957        Ok(())
1958    }
1959
1960    fn exit_sync_call(&mut self, callee: RuntimeInstance) -> Result<()> {
1961        log::trace!("exit sync-typed call {callee:?}");
1962        let thread = self.current_guest_thread()?;
1963        let thread = self.concurrent_state_mut()?.get_mut(thread.thread)?;
1964        let Some(old_do_not_suspend) = thread.old_do_not_suspend.take() else {
1965            bail_bug!("current thread missing `old_do_not_suspend` value");
1966        };
1967        let state = self.instance_state(callee).concurrent_state();
1968        state.do_not_suspend = old_do_not_suspend;
1969        Ok(())
1970    }
1971
1972    /// Push a `GuestTask` onto the task stack for either a sync-to-sync,
1973    /// guest-to-guest call or a sync host-to-guest call.
1974    ///
1975    /// This task will only be used for the purpose of handling calls to
1976    /// intrinsic functions; both parameter lowering and result lifting are
1977    /// assumed to be taken care of elsewhere.
1978    ///
1979    /// NB: for sync-to-sync, guest-to-guest calls we delay task construction in
1980    /// fused adapters, see `StoreOpaque::current_thread`, `VMDeferredThread`,
1981    /// and `lower_fact_enter_sync_call`. Make sure all this stuff stays in
1982    /// sync!
1983    pub(crate) fn enter_guest_sync_call(
1984        &mut self,
1985        callee_async_typed: bool,
1986        callee: RuntimeInstance,
1987    ) -> Result<()> {
1988        log::trace!("enter sync-lifted call {callee:?}");
1989        if !self.concurrency_support() {
1990            return self.enter_call_not_concurrent();
1991        }
1992
1993        // Stash the next switch item (if any) for the duration of this call
1994        // since it's for the caller's caller, not for us.  We'll restore this
1995        // in `exit_guest_sync_call`.
1996        let state = self.concurrent_state_mut()?;
1997        let item = state.next_switch_item.take();
1998        state.saved_next_switch_items.push(item);
1999
2000        let thread = self.current_thread()?;
2001        let caller = if let Some(thread) = thread.guest() {
2002            Caller::Guest { thread: *thread }
2003        } else {
2004            Caller::Host {
2005                tx: None,
2006                caller: self.materialize_host_task_id()?,
2007            }
2008        };
2009
2010        let state = self.concurrent_state_mut()?;
2011        let guest_thread = GuestTask::new(
2012            state,
2013            Box::new(move |_, _| bail_bug!("cannot lower params in sync call")),
2014            LiftResult {
2015                lift: Box::new(move |_, _| bail_bug!("cannot lift result in sync call")),
2016                ty: TypeTupleIndex::reserved_value(),
2017                memory: None,
2018                string_encoding: StringEncoding::Utf8,
2019            },
2020            caller,
2021            None,
2022            callee,
2023            callee_async_typed,
2024            false,
2025        )?;
2026
2027        Instance::from_wasmtime(self, callee.instance).add_guest_thread_to_instance_table(
2028            guest_thread.thread,
2029            self,
2030            callee.index,
2031        )?;
2032        self.set_thread(guest_thread)?;
2033
2034        if !callee_async_typed {
2035            self.enter_sync_call(callee)?;
2036        }
2037
2038        Ok(())
2039    }
2040
2041    /// Pop a `GuestTask` previously pushed using `enter_guest_sync_call`.
2042    ///
2043    /// NB: for sync-to-sync, guest-to-guest calls we delay task construction in
2044    /// fused adapters and then when the call returns we check to see if the
2045    /// task's contruction was forced and if not avoid calling out of the JIT
2046    /// code to this function. See `lower_fact_exit_sync_call`. Make sure all
2047    /// this stuff stays in sync!
2048    pub(crate) fn exit_guest_sync_call(&mut self) -> Result<()> {
2049        if !self.concurrency_support() {
2050            return Ok(self.exit_call_not_concurrent());
2051        }
2052
2053        let thread = match self.current_thread()?.guest() {
2054            Some(t) => *t,
2055            None => bail_bug!("expected task when exiting"),
2056        };
2057        let task = self.concurrent_state_mut()?.get_mut(thread.task)?;
2058        let instance = task.instance;
2059
2060        let caller = match &task.caller {
2061            &Caller::Guest { thread } => thread.into(),
2062            &Caller::Host { caller, .. } => caller
2063                .map(CurrentThread::Host)
2064                .unwrap_or(CurrentThread::None),
2065        };
2066        task.lift_result = None;
2067        task.exited = true;
2068        let async_typed = task.async_typed;
2069
2070        if !async_typed {
2071            self.exit_sync_call(instance)?;
2072        }
2073
2074        self.set_thread(caller)?;
2075
2076        log::trace!("exit sync-lifted call {instance:?}");
2077
2078        if async_typed {
2079            // If we're async-typed, returning control to our caller won't help
2080            // resolve any outstanding sync-typed call which might be in
2081            // progress, so we may need to switch or trap before exiting this
2082            // thread:
2083            self.switch_or_trap_if_may_not_suspend(instance)?;
2084        }
2085
2086        self.cleanup_thread(thread, instance)?;
2087
2088        self.concurrent_state_mut()?
2089            .decrement_task_ref_count(thread.task)?;
2090
2091        let state = self.concurrent_state_mut()?;
2092        let Some(item) = state.saved_next_switch_items.pop() else {
2093            bail_bug!("unable to pop from `saved_next_switch_items`");
2094        };
2095        if let Some(item) = mem::replace(&mut state.next_switch_item, item) {
2096            // Stash it back in the store to ensure it's cleaned up on store
2097            // drop:
2098            state.push_high_priority(item);
2099            bail_bug!("`next_switch_item` unexpectedly already set");
2100        }
2101
2102        Ok(())
2103    }
2104
2105    /// Similar to `enter_guest_sync_call` except for when the guest makes a
2106    /// transition to the host.
2107    ///
2108    /// This initially records a deferred host call. A full [`HostTask`] should
2109    /// be allocated later if needed via
2110    /// [`StoreOpaque::materialize_host_task_id`].
2111    pub(crate) fn host_task_create(&mut self) -> Result<EnteredHostTask> {
2112        if !self.concurrency_support() {
2113            self.enter_call_not_concurrent()?;
2114            return Ok(None);
2115        }
2116        let caller = self.current_guest_thread()?;
2117        log::trace!("new deferred host task with caller {caller:?}");
2118
2119        self.set_thread(CurrentThread::DeferredHost(caller))?;
2120        let state = self.concurrent_state_mut()?;
2121        debug_assert!(state.deferred_host_call_context.is_none());
2122        state.deferred_host_call_context = Some(CallContext::default());
2123        state.debug_assert_deferred_host_invariant();
2124        Ok(Some(caller))
2125    }
2126
2127    /// Dual of `host_task_create` and signifies that the host has finished and
2128    /// will be cleaned up.
2129    ///
2130    /// Note that this isn't invoked when the host is invoked asynchronously and
2131    /// the host isn't complete yet. In that situation the host task persists
2132    /// and will be cleaned up separately in `subtask_drop`
2133    pub(crate) fn host_task_delete(
2134        &mut self,
2135        original_task: EnteredHostTask,
2136        materialized_task: Option<TableId<HostTask>>,
2137    ) -> Result<()> {
2138        match original_task {
2139            Some(caller) => {
2140                self.set_thread(caller)?;
2141                if materialized_task.is_none() {
2142                    let state = self.concurrent_state_mut()?;
2143                    let context = state
2144                        .deferred_host_call_context
2145                        .take()
2146                        .expect("deferred host call context should be present");
2147                    debug_assert!(context.is_empty());
2148                    state.debug_assert_deferred_host_invariant();
2149                }
2150                log::trace!(
2151                    "delete host task with caller {original_task:?} and materialized as {materialized_task:?}"
2152                );
2153                if let Some(task) = materialized_task {
2154                    self.concurrent_state_mut()?.delete_host_task(task)?;
2155                }
2156            }
2157            None => {
2158                debug_assert!(materialized_task.is_none());
2159                self.exit_call_not_concurrent();
2160            }
2161        }
2162        Ok(())
2163    }
2164
2165    /// Helper function to retrieve the `InstanceState` for the
2166    /// specified instance.
2167    fn instance_state(&mut self, instance: RuntimeInstance) -> &mut InstanceState {
2168        self.component_instance_mut(instance.instance)
2169            .instance_state(instance.index)
2170    }
2171
2172    /// Same as `instance_state`, but also returns the store's `HandleCounter`
2173    /// for inserting into the instance's handle tables.
2174    fn instance_state_and_handle_counter(
2175        &mut self,
2176        instance: RuntimeInstance,
2177    ) -> (&mut InstanceState, &mut HandleCounter) {
2178        let (component, counter) = self
2179            .store_data_mut()
2180            .component_instance_and_handle_counter_mut(instance.instance);
2181        (component.instance_state(instance.index), counter)
2182    }
2183
2184    /// Configure the currently running `thread`.
2185    ///
2186    /// This will save off any state necessary for the previous thread, if
2187    /// applicable, and then it'll additionally update state for `thread` if
2188    /// needed too.
2189    pub(crate) fn set_thread(&mut self, thread: impl Into<CurrentThread>) -> Result<CurrentThread> {
2190        let thread = thread.into();
2191        let state = self.concurrent_state_mut()?;
2192        state.debug_assert_deferred_host_invariant();
2193        let old_thread = mem::replace(&mut state.unforced_current_thread, thread);
2194
2195        state.handle_thread_switch(old_thread, thread)?;
2196
2197        // First thing to do after swapping threads is updating the context
2198        // slots for this thread within the store. This restores the behavior of
2199        // `context.{get,set}`. This involves taking the old state out of the
2200        // store, saving it in the thread that's being swapped from, and doing
2201        // the inverse for the new thread. When debug assertions are enabled
2202        // this also leaves behind sentinel values to try to uncover bugs where
2203        // this may be forgotten.
2204        if let Some(old_thread) = old_thread.guest() {
2205            let old_context = *self.vm_store_context_mut().component_context_mut();
2206            self.concurrent_state_mut()?
2207                .get_mut(old_thread.thread)?
2208                .context = old_context;
2209        }
2210        if cfg!(debug_assertions) {
2211            *self.vm_store_context_mut().component_context_mut() =
2212                [u32::MAX; NUM_COMPONENT_CONTEXT_SLOTS];
2213        }
2214        if let Some(thread) = thread.guest() {
2215            let thread = self.concurrent_state_mut()?.get_mut(thread.thread)?;
2216            let context = thread.context;
2217            if cfg!(debug_assertions) {
2218                thread.context = [u32::MAX; NUM_COMPONENT_CONTEXT_SLOTS];
2219            }
2220            *self.vm_store_context_mut().component_context_mut() = context;
2221        }
2222
2223        // Keep the JIT-visible current-thread pointer in sync.
2224        *self.vm_store_context_mut().current_thread_mut() = if thread.is_none() {
2225            VMLazyThread::none()
2226        } else {
2227            VMLazyThread::forced()
2228        };
2229
2230        Ok(old_thread)
2231    }
2232
2233    /// Call `switch_if_may_not_suspend` and trap if it returns `false`.
2234    fn switch_or_trap_if_may_not_suspend(&mut self, instance: RuntimeInstance) -> Result<()> {
2235        if self.switch_if_may_not_suspend(instance)? {
2236            Ok(())
2237        } else {
2238            Err(Trap::CannotBlockSyncTask.into())
2239        }
2240    }
2241
2242    /// Check if the specified instance has a sync-typed call in progress; if so
2243    /// attempt to switch to another ready thread for that instance, and if no
2244    /// such thread exists, return false.
2245    fn switch_if_may_not_suspend(&mut self, instance: RuntimeInstance) -> Result<bool> {
2246        // Call this for the side effect of forcing any deferred task creation,
2247        // which may influence the value of `ConcurrentState::do_not_suspend`
2248        // below:
2249        self.concurrent_state_mut()?;
2250
2251        Ok(!self.concurrency_support()
2252            || !self
2253                .instance_state(instance)
2254                .concurrent_state()
2255                .do_not_suspend
2256            || self
2257                .concurrent_state_mut()?
2258                .promote_instance_local_thread_work_item(instance)?)
2259    }
2260
2261    /// Record that we're about to enter a (sub-)component instance which does
2262    /// not support more than one concurrent, stackful activation, meaning it
2263    /// cannot be entered again until the next call returns.
2264    fn enter_instance(&mut self, instance: RuntimeInstance) {
2265        log::trace!("enter {instance:?}");
2266        self.instance_state(instance)
2267            .concurrent_state()
2268            .do_not_enter = true;
2269    }
2270
2271    /// Record that we've exited a (sub-)component instance previously entered
2272    /// with `Self::enter_instance` and then calls `Self::partition_pending`.
2273    /// See the documentation for the latter for details.
2274    fn exit_instance(&mut self, instance: RuntimeInstance) -> Result<()> {
2275        log::trace!("exit {instance:?}");
2276        self.instance_state(instance)
2277            .concurrent_state()
2278            .do_not_enter = false;
2279        self.partition_pending(instance)
2280    }
2281
2282    /// Iterate over `InstanceState::pending`, moving any ready items into the
2283    /// "high priority" work item queue.
2284    ///
2285    /// Also, notify `ConcurrentState::ready_for_concurrent_call_waker` if
2286    /// present.
2287    ///
2288    /// See `GuestCall::is_ready` for details.
2289    fn partition_pending(&mut self, instance: RuntimeInstance) -> Result<()> {
2290        for (thread, kind) in
2291            mem::take(&mut self.instance_state(instance).concurrent_state().pending).into_iter()
2292        {
2293            let call = GuestCall { thread, kind };
2294            if call.is_ready(self)? {
2295                self.concurrent_state_mut()?
2296                    .push_high_priority(WorkItem::GuestCall { instance, call });
2297            } else {
2298                self.instance_state(instance)
2299                    .concurrent_state()
2300                    .pending
2301                    .insert(call.thread, call.kind);
2302            }
2303        }
2304
2305        if let Some(waker) = self
2306            .concurrent_state_mut()?
2307            .ready_for_concurrent_call_waker
2308            .take()
2309        {
2310            waker.wake();
2311        }
2312
2313        Ok(())
2314    }
2315
2316    /// Implements the `backpressure.{inc,dec}` intrinsics.
2317    pub(crate) fn backpressure_modify(
2318        &mut self,
2319        caller_instance: RuntimeInstance,
2320        modify: impl FnOnce(u16) -> Option<u16>,
2321    ) -> Result<()> {
2322        let state = self.instance_state(caller_instance).concurrent_state();
2323        let old = state.backpressure;
2324        let new = modify(old).ok_or_else(|| Trap::BackpressureOverflow)?;
2325        state.backpressure = new;
2326
2327        if old > 0 && new == 0 {
2328            // Backpressure was previously enabled and is now disabled; move any
2329            // newly-eligible guest calls to the "high priority" queue.
2330            self.partition_pending(caller_instance)?;
2331        }
2332
2333        Ok(())
2334    }
2335
2336    /// Resume the specified fiber, giving it exclusive access to the specified
2337    /// store.
2338    fn resume_fiber(
2339        &mut self,
2340        fiber: StoreFiber<'static>,
2341    ) -> impl Future<Output = Result<()>> + '_ {
2342        let mut resuming = ResumingFiber {
2343            store: self,
2344            fiber: Some(fiber),
2345        };
2346        async move {
2347            let old_thread = resuming.store.current_thread()?;
2348            log::trace!("resume_fiber: save current thread {old_thread:?}");
2349
2350            let fiber = resuming.fiber.take().unwrap();
2351            resuming.fiber = fiber::resolve_or_release(resuming.store, fiber).await?;
2352
2353            resuming.store.set_thread(old_thread)?;
2354
2355            let state = resuming.store.concurrent_state_mut()?;
2356
2357            if let Some(ot) = old_thread.guest() {
2358                state.set_thread_running(ot.thread)?;
2359            }
2360            log::trace!("resume_fiber: restore current thread {old_thread:?}");
2361
2362            if resuming.fiber.is_some() {
2363                log::trace!("resume_fiber: suspend reason {:?}", &state.suspend_reason);
2364                // See the `SuspendReason` documentation for what each case means.
2365                let reason = match state.suspend_reason.take() {
2366                    Some(r) => r,
2367                    None => bail_bug!("suspend reason missing when resuming fiber"),
2368                };
2369                match reason {
2370                    SuspendReason::NeedWork => {
2371                        if state.worker.is_none() {
2372                            state.worker = resuming.fiber.take();
2373                        }
2374                    }
2375                    SuspendReason::Yielding { thread } => {
2376                        let slot = &mut state.get_mut(thread.thread)?.state;
2377                        slot.check_no_fiber()?;
2378                        *slot = GuestThreadState::Ready {
2379                            fiber: resuming.fiber.take().unwrap(),
2380                        };
2381                        let instance = state.get_mut(thread.task)?.instance;
2382                        state.push_low_priority(WorkItem::ResumeThread { instance, thread });
2383                    }
2384                    SuspendReason::ExplicitlySuspending { thread } => {
2385                        let slot = &mut state.get_mut(thread.thread)?.state;
2386                        slot.check_no_fiber()?;
2387                        *slot = GuestThreadState::Suspended(resuming.fiber.take().unwrap());
2388                    }
2389                    SuspendReason::Waiting { set, thread } => {
2390                        match state.get_mut(set)?.waiting.entry(thread) {
2391                            Entry::Vacant(entry) => {
2392                                entry.insert(WaitMode::Fiber(resuming.fiber.take().unwrap()));
2393                            }
2394                            Entry::Occupied(_) => {
2395                                bail_bug!("entry unexpectedly already exists for {thread:?}");
2396                            }
2397                        }
2398                    }
2399                    SuspendReason::YieldingToSubtask { thread } => {
2400                        // In this case, the thread has either invoked or sent a
2401                        // cancel request to a subtask, and is now yielding to that
2402                        // subtask.  According to the CM spec, that subtask may only
2403                        // yield back to the original thread the first time it
2404                        // suspends or exits (or a thread that it has resumed
2405                        // suspends or exits, etc.), which we ensure by setting
2406                        // `ConcurrentState::next_switch_item` here.
2407
2408                        let instance = state.get_mut(thread.task)?.instance;
2409                        if state.next_switch_item.is_some() {
2410                            // This should be unreachable per the save/restore code
2411                            // in `Self::suspend`.
2412                            bail_bug!(
2413                                "`ConcurrentState::next_switch_item` was already `Some(_)` when \
2414                             a thread wanted to wait on a subtask"
2415                            );
2416                        }
2417                        let item = state.next_switch_item.insert(WorkItem::ResumeFiber {
2418                            instance,
2419                            thread,
2420                            fiber: resuming.fiber.take().unwrap(),
2421                        });
2422                        log::trace!("set next switch item to {item:?}");
2423                    }
2424                };
2425            } else {
2426                log::trace!("resume_fiber: fiber has exited");
2427            }
2428
2429            Ok(())
2430        }
2431    }
2432
2433    /// Suspend the current fiber, storing the reason in
2434    /// `ConcurrentState::suspend_reason` to indicate the conditions under which
2435    /// it should be resumed.
2436    ///
2437    /// See the `SuspendReason` documentation for details.
2438    fn suspend(&mut self, reason: SuspendReason) -> Result<()> {
2439        log::trace!("suspend fiber: {reason:?}");
2440
2441        // We'll panic if we call `Self::with_blocking` when the fiber is being
2442        // disposed, so check for that and exit ASAP if appropriate.
2443        if !self.fiber_async_state_mut().can_block() {
2444            return Err(format_err!("future dropped"));
2445        }
2446
2447        let state = self.concurrent_state_mut()?;
2448
2449        // If we're yielding or waiting on behalf of a guest thread, we'll be
2450        // overwriting the current thread, so save it now and restore it once
2451        // we've resumed.
2452        //
2453        // Also, if we're yielding to a subtask, we're about to overwrite
2454        // `ConcurrentState::next_switch_item`, so also save and restore that.
2455        let (save_and_restore_thread, save_and_restore_next_switch_item) = match &reason {
2456            SuspendReason::Yielding { .. }
2457            | SuspendReason::Waiting { .. }
2458            | SuspendReason::ExplicitlySuspending { .. } => {
2459                // If there's a thread waiting for this subtask to suspend, this
2460                // is a good time to switch back to it.
2461                if state.switch_item.is_none() {
2462                    state.take_next_switch_item()?;
2463                }
2464
2465                (true, false)
2466            }
2467            SuspendReason::YieldingToSubtask { .. } => (true, true),
2468            SuspendReason::NeedWork => (false, false),
2469        };
2470
2471        let old_next_switch_item = if save_and_restore_next_switch_item {
2472            Some(state.save_next_switch_item()?)
2473        } else {
2474            None
2475        };
2476
2477        let old_guest_thread = if save_and_restore_thread {
2478            self.current_thread()?
2479        } else {
2480            CurrentThread::None
2481        };
2482
2483        let waiting_set = match &reason {
2484            SuspendReason::Waiting { set, .. } => Some(*set),
2485            _ => None,
2486        };
2487
2488        let suspend_reason = &mut self.concurrent_state_mut()?.suspend_reason;
2489        if suspend_reason.is_some() {
2490            bail_bug!("suspend reason unexpectedly already set for store");
2491        }
2492        *suspend_reason = Some(reason);
2493
2494        // Count this thread as waiting on `waiting_set`, if any, for as long as
2495        // it's suspended.
2496        if let Some(set) = waiting_set {
2497            self.concurrent_state_mut()?.get_mut(set)?.num_waiting += 1;
2498        }
2499
2500        self.with_blocking(|_, cx| cx.suspend(StoreFiberYield::ReleaseStore))?;
2501
2502        if let Some(set) = waiting_set {
2503            self.concurrent_state_mut()?.get_mut(set)?.stop_waiting()?;
2504        }
2505
2506        if save_and_restore_thread {
2507            self.set_thread(old_guest_thread)?;
2508        }
2509
2510        if let Some(item) = old_next_switch_item {
2511            let state = self.concurrent_state_mut()?;
2512            state.restore_next_switch_item(item)?;
2513        }
2514
2515        Ok(())
2516    }
2517
2518    fn wait_for_event(
2519        &mut self,
2520        caller_instance: RuntimeInstance,
2521        waitable: Waitable,
2522    ) -> Result<()> {
2523        let caller = self.current_guest_thread()?;
2524        let state = self.concurrent_state_mut()?;
2525
2526        waitable.trap_if_in_waitable_set(state)?;
2527
2528        let set = state.get_mut(caller.thread)?.sync_call_set;
2529        waitable.join(state, Some(set))?;
2530
2531        self.switch_or_trap_if_may_not_suspend(caller_instance)?;
2532
2533        self.suspend(SuspendReason::Waiting {
2534            set,
2535            thread: caller,
2536        })?;
2537        let state = self.concurrent_state_mut()?;
2538
2539        waitable.join(state, None)
2540    }
2541
2542    /// Cleans up the data structures backing the `guest_thread` specified,
2543    /// removing it from the internal tables of `runtime_instance` as well.
2544    ///
2545    /// This function is used whenever a guest thread has fully exited and
2546    /// completed. This'll clean up the associated `GuestThread` structure and
2547    /// related resources it contains.
2548    ///
2549    /// Other functionality that this implements is:
2550    ///
2551    /// * This will perform conditional cleanup of the `GuestTask` that owns
2552    ///   this thread if `cleanup_task` is `CleanupTask::Yes`.
2553    /// * If there are no more threads in the `GuestTask` that this thread is
2554    ///   associated with, and if the task hasn't produced a result (e.g. it's not
2555    ///   returned or cancelled), then a trap will be raised that a result
2556    ///   wasn't ever produced.
2557    /// * If this task is finished, meaning the top-level thread exited and
2558    ///   additionally it's been returned or cancelled, then this will handle
2559    ///   management of the store's "active interesting tasks" counter.
2560    ///
2561    /// Effectively this is intended to be a "narrow waist" through which many
2562    /// destruction operations are funneled through.
2563    fn cleanup_thread(
2564        &mut self,
2565        guest_thread: QualifiedThreadId,
2566        runtime_instance: RuntimeInstance,
2567    ) -> Result<()> {
2568        let state = self.concurrent_state_mut()?;
2569        // If we never suspended, we never had a chance to deliver a subtask
2570        // status update, if any, to our caller, so we do that here:
2571        state.take_next_switch_item()?;
2572        let thread_data = state.get_mut(guest_thread.thread)?;
2573        let sync_call_set = thread_data.sync_call_set;
2574        if let Some(guest_id) = thread_data.instance_rep {
2575            self.instance_state(runtime_instance)
2576                .thread_handle_table()
2577                .guest_thread_remove(guest_id)?;
2578        }
2579        let state = self.concurrent_state_mut()?;
2580
2581        // Clean up any pending subtasks in the sync_call_set
2582        for waitable in mem::take(&mut state.get_mut(sync_call_set)?.ready) {
2583            if let Some(Event::Subtask {
2584                status: Status::Returned | Status::ReturnCancelled,
2585            }) = waitable.common(state)?.event
2586            {
2587                waitable.delete_from(state)?;
2588            }
2589        }
2590
2591        state.delete(guest_thread.thread)?;
2592        state.delete(sync_call_set)?;
2593        let task = state.get_mut(guest_thread.task)?;
2594        task.threads.remove(&guest_thread.thread);
2595
2596        if task.threads.is_empty() && !task.returned_or_cancelled() {
2597            bail!(Trap::NoAsyncResult);
2598        }
2599
2600        if !task.decremented_interesting_task_count && task.exited && task.returned_or_cancelled() {
2601            task.decremented_interesting_task_count = true;
2602
2603            debug_assert!(state.interesting_tasks > 0);
2604            state.interesting_tasks -= 1;
2605            if state.interesting_tasks == 0
2606                && let Some(waker) = state.interesting_tasks_empty_waker.take()
2607            {
2608                waker.wake();
2609            }
2610        }
2611
2612        state.decrement_task_ref_count(guest_thread.task)?;
2613
2614        Ok(())
2615    }
2616
2617    /// Performs cancellation of the `guest_task` specified with the
2618    /// precondition that the task hasn't lowered its parameters.
2619    ///
2620    /// In this situation the task hasn't ever been started meaning it hasn't
2621    /// actually run any wasm code yet. This requires cleaning up metadata such
2622    /// as thread information attached to the task.
2623    ///
2624    /// This is used for task cancellation via `subtask.cancel`, the intrinsic.
2625    fn cancel_guest_subtask_without_lowered_parameters(
2626        &mut self,
2627        caller_instance: RuntimeInstance,
2628        guest_task: TableId<GuestTask>,
2629    ) -> Result<()> {
2630        let concurrent_state = self.concurrent_state_mut()?;
2631        let task = concurrent_state.get_mut(guest_task)?;
2632        assert!(!task.already_lowered_parameters());
2633        // The task is in a `starting` state, meaning it hasn't run at
2634        // all yet.  Here we update its fields to indicate that it is
2635        // ready to delete immediately once `subtask.drop` is called.
2636        task.lower_params = None;
2637        task.lift_result = None;
2638        task.exited = true;
2639        let instance = task.instance;
2640
2641        // Clean up the thread within this task as it's now never going
2642        // to run.
2643        //
2644        // Note that `next_switch_item`, if any, belongs to the canceller and
2645        // not this thread since this thread never ran, so it's saved and
2646        // restored here to prevent `cleanup_thread` from taking it.
2647        assert_eq!(1, task.threads.len());
2648        let thread = *task.threads.iter().next().unwrap();
2649        let next_switch_item = concurrent_state.save_next_switch_item()?;
2650        self.cleanup_thread(
2651            QualifiedThreadId {
2652                task: guest_task,
2653                thread,
2654            },
2655            caller_instance,
2656        )?;
2657        self.concurrent_state_mut()?
2658            .restore_next_switch_item(next_switch_item)?;
2659
2660        // Not yet started; cancel and remove from pending
2661        let pending = &mut self.instance_state(instance).concurrent_state().pending;
2662        let pending_count = pending.len();
2663        pending.retain(|thread, _| thread.task != guest_task);
2664
2665        if pending.len() == pending_count {
2666            // If it wasn't found in the pending set, it might be waiting in one
2667            // of the task queues or switch items:
2668            let matches = |item: &WorkItem| match item {
2669                WorkItem::ResumeThread { thread, .. }
2670                | WorkItem::GuestCall {
2671                    call: GuestCall { thread, .. },
2672                    ..
2673                } => thread.task == guest_task,
2674                _ => false,
2675            };
2676
2677            let remove = |queue: &mut VecDeque<WorkItem>| {
2678                let count = queue.len();
2679                queue.retain(|item| !matches(item));
2680                count != queue.len()
2681            };
2682
2683            let state = self.concurrent_state_mut()?;
2684            let mut found = remove(&mut state.high_priority);
2685            found |= remove(&mut state.low_priority);
2686
2687            for item in [&mut state.switch_item, &mut state.next_switch_item] {
2688                if matches!(item, Some(item) if matches(item)) {
2689                    found = true;
2690                    *item = None;
2691                }
2692            }
2693
2694            if !found {
2695                bail!(Trap::SubtaskCancelAfterTerminal);
2696            }
2697        }
2698        Ok(())
2699    }
2700
2701    /// Used by `ResourceTables` to record the scope of a borrow to get undone
2702    /// in the future.
2703    pub(crate) fn current_scope(&mut self) -> Result<Option<CurrentScope>> {
2704        if !self.concurrency_support() {
2705            return Ok(self
2706                .current_scope_id_not_concurrent()?
2707                .map(|id| CurrentScope::Id(Scope::Id(id))));
2708        }
2709
2710        Ok(match self.current_thread()? {
2711            CurrentThread::Guest(id) => Some(CurrentScope::Id(Scope::Id(id.task.rep()))),
2712            CurrentThread::Host(id) => Some(CurrentScope::Id(Scope::HostId(id.rep()))),
2713            CurrentThread::DeferredHost(_) => Some(CurrentScope::DeferredHost),
2714            CurrentThread::None => return Ok(None),
2715        })
2716    }
2717
2718    pub(crate) fn queue_task(
2719        &mut self,
2720        task: impl FnOnce(&mut dyn VMStore) -> Result<()> + Send + 'static,
2721    ) -> Result<()> {
2722        self.concurrent_state_mut()?
2723            .push_high_priority(WorkItem::WorkerFunction(AlwaysMut::new(Box::new(task))));
2724        Ok(())
2725    }
2726
2727    /// Used in `poll_until` just prior to trapping due to a "deadlock"
2728    /// condition.
2729    ///
2730    /// This helps us distinguish between a simple deadlock condition (where no
2731    /// work is available for the event loop to do, nor is there any way for new
2732    /// work to be added) and a "cannot block sync task" condition where at
2733    /// least once instance has an outstanding sync-typed task running, in which
2734    /// case we'll trap with a different error message.
2735    fn any_may_not_suspend(&mut self) -> Result<bool> {
2736        // Note that this currently requires a linear search across the whole
2737        // `ConcurrentState::table`.  We _could_ optimize that, but since (1)
2738        // this function is only used when trapping, (2) the only thing you can
2739        // really do with a store that's been poisoned by a trap is drop it, and
2740        // (3) we must do a linear search through the table when dropping a
2741        // store anyway to dispose of fibers, it's reasonable for us to also do
2742        // a linear search here.
2743        Ok(self
2744            .concurrent_state_mut()?
2745            .table
2746            .get_mut()
2747            .iter_mut()
2748            .filter_map(|(_, entry)| {
2749                if let Some(task) = entry.downcast_ref::<GuestTask>() {
2750                    Some(task.instance)
2751                } else {
2752                    None
2753                }
2754            })
2755            .collect::<Vec<_>>()
2756            .into_iter()
2757            .any(|instance| {
2758                self.instance_state(instance)
2759                    .concurrent_state()
2760                    .do_not_suspend
2761            }))
2762    }
2763}
2764
2765impl Instance {
2766    /// Get the next pending event for the specified task and (optional)
2767    /// waitable set, along with the waitable handle if applicable.
2768    fn get_event(
2769        self,
2770        store: &mut StoreOpaque,
2771        guest_task: TableId<GuestTask>,
2772        set: Option<TableId<WaitableSet>>,
2773        cancellable: bool,
2774    ) -> Result<Option<(Event, Option<(Waitable, u32)>)>> {
2775        let state = store.concurrent_state_mut()?;
2776
2777        let task = state.get_mut(guest_task)?;
2778        let event = &mut task.event;
2779        if let Some(ev) = event
2780            && (cancellable || !matches!(ev, Event::Cancelled))
2781        {
2782            log::trace!("deliver event {ev:?} to {guest_task:?}");
2783
2784            if matches!(ev, Event::Cancelled) {
2785                task.cancel_request_delivered = true;
2786            }
2787
2788            let ev = *ev;
2789            *event = None;
2790            return Ok(Some((ev, None)));
2791        }
2792
2793        let set = match set {
2794            Some(set) => set,
2795            None => return Ok(None),
2796        };
2797        let waitable = match state.get_mut(set)?.ready.pop_first() {
2798            Some(v) => v,
2799            None => return Ok(None),
2800        };
2801
2802        let common = waitable.common(state)?;
2803        let handle = match common.handle {
2804            Some(h) => h,
2805            None => bail_bug!("handle not set when delivering event"),
2806        };
2807        let event = match common.event.take() {
2808            Some(e) => e,
2809            None => bail_bug!("event not set when delivering event"),
2810        };
2811
2812        log::trace!(
2813            "deliver event {event:?} to {guest_task:?} for {waitable:?} (handle {handle}); set {set:?}"
2814        );
2815
2816        waitable.on_delivery(store, self, event)?;
2817
2818        Ok(Some((event, Some((waitable, handle)))))
2819    }
2820
2821    /// Run `call` for the callback-lifted `guest_thread` and then handle the
2822    /// `CallbackCode` it returns.
2823    ///
2824    /// `call` runs with `guest_thread` as the current thread and with
2825    /// `runtime_instance` entered; both are restored before the final code is
2826    /// handled.
2827    fn handle_callback_code(
2828        self,
2829        store: &mut dyn VMStore,
2830        guest_thread: QualifiedThreadId,
2831        runtime_instance: RuntimeInstance,
2832        call: impl FnOnce(&mut dyn VMStore) -> Result<u32>,
2833    ) -> Result<()> {
2834        let old_thread = store.set_thread(guest_thread)?;
2835        log::trace!(
2836            "callback-lifted call: replaced {old_thread:?} with {guest_thread:?} as current thread"
2837        );
2838
2839        store.enter_instance(runtime_instance);
2840
2841        let mut code = call(store)?;
2842
2843        // Implement the spec behavior here of effectively ignoring the return
2844        // code if there's a pending cancellation for this task available.
2845        //
2846        // TODO: the spec doesn't validate anything here, but seems like the
2847        // waitable set may want to be validated?
2848        if matches!(
2849            unpack_callback_code(code).0,
2850            callback_code::YIELD | callback_code::WAIT
2851        ) && let Some((event, _)) = self.get_event(store, guest_thread.task, None, true)?
2852        {
2853            let (unpacked, set) = unpack_callback_code(code);
2854            log::trace!(
2855                "{guest_thread:?} returned callback code {unpacked} (set: {set}) with a pending \
2856                 cancellation; delivering it via callback"
2857            );
2858            code = invoke_callback(store, guest_thread.task, event, 0)?;
2859        }
2860
2861        store.exit_instance(runtime_instance)?;
2862
2863        store.set_thread(old_thread)?;
2864        log::trace!("callback-lifted call: restored {old_thread:?} as current thread");
2865
2866        let store = store.store_opaque_mut();
2867        let (code, set) = unpack_callback_code(code);
2868
2869        log::trace!("received callback code from {guest_thread:?}: {code} (set: {set})");
2870
2871        let state = store.concurrent_state_mut()?;
2872
2873        state.take_next_switch_item()?;
2874
2875        let get_set = |store: &mut StoreOpaque, handle| -> Result<_> {
2876            let set = store
2877                .instance_state(runtime_instance)
2878                .handle_table()
2879                .waitable_set_rep(handle)?;
2880
2881            Ok(TableId::<WaitableSet>::new(set))
2882        };
2883
2884        match code {
2885            callback_code::EXIT => {
2886                log::trace!("implicit thread {guest_thread:?} completed");
2887                let task = store.concurrent_state_mut()?.get_mut(guest_thread.task)?;
2888                task.exited = true;
2889                task.callback = None;
2890
2891                // Since we're async-typed, returning control to our caller
2892                // won't help resolve any outstanding sync-typed call which
2893                // might be in progress, so we may need to switch or trap before
2894                // exiting this thread:
2895                store.switch_or_trap_if_may_not_suspend(runtime_instance)?;
2896
2897                store.cleanup_thread(guest_thread, runtime_instance)?;
2898            }
2899            callback_code::YIELD => {
2900                // Set `GuestTask::wake_on_cancel` to allow `subtask.cancel` to
2901                // promote this thread if appropriate.
2902                let old = state
2903                    .get_mut(guest_thread.thread)?
2904                    .wake_on_cancel
2905                    .replace(WakeOnCancel::Yielding);
2906                if !old.is_none() {
2907                    bail_bug!("thread unexpectedly had wake_on_cancel set");
2908                }
2909
2910                // If an `Event::Cancelled` is pending in `GuestTask::event`
2911                // when this call is delivered, we'll deliver that; otherwise,
2912                // we'll deliver `Event::None`.  Note that the `Event::None` is
2913                // deliberately not stored in `GuestTask::event` since that's
2914                // shared by all threads of the task and the `Event::None` is
2915                // only for this thread.
2916                let call = GuestCall {
2917                    thread: guest_thread,
2918                    kind: GuestCallKind::DeliverEvent {
2919                        instance: self,
2920                        set: None,
2921                    },
2922                };
2923                // Push this thread onto the "low priority" queue so it runs
2924                // after any other threads have had a chance to run.
2925                state.push_low_priority(WorkItem::GuestCall {
2926                    instance: runtime_instance,
2927                    call,
2928                });
2929            }
2930            callback_code::WAIT => {
2931                let set = get_set(store, set)?;
2932                self.wait_with_callback(store, guest_thread, set)?;
2933            }
2934            _ => bail!(Trap::UnsupportedCallbackCode),
2935        }
2936
2937        Ok(())
2938    }
2939
2940    /// Start waiting on `set` with `guest_thread`, which uses a callback.
2941    ///
2942    /// The thread will receive an event from `set` via a
2943    /// `GuestCallKind::DeliverEvent` work item, either immediately if one is
2944    /// already available, or once one is published.
2945    fn wait_with_callback(
2946        self,
2947        store: &mut StoreOpaque,
2948        guest_thread: QualifiedThreadId,
2949        set: TableId<WaitableSet>,
2950    ) -> Result<()> {
2951        let state = store.concurrent_state_mut()?;
2952        // This thread's wait ends when that work item is handled in
2953        // `handle_guest_call`.
2954        state.get_mut(set)?.num_waiting += 1;
2955
2956        if state.get_mut(guest_thread.task)?.event.is_some()
2957            || !state.get_mut(set)?.ready.is_empty()
2958        {
2959            // An event is immediately available; deliver it ASAP.
2960            let instance = state.get_mut(guest_thread.task)?.instance;
2961            state.push_high_priority(WorkItem::GuestCall {
2962                instance,
2963                call: GuestCall {
2964                    thread: guest_thread,
2965                    kind: GuestCallKind::DeliverEvent {
2966                        instance: self,
2967                        set: Some(set),
2968                    },
2969                },
2970            });
2971            return Ok(());
2972        }
2973
2974        // No event is immediately available, so this thread is about to block.
2975        // Like any other suspension point (e.g. the callback `EXIT` path), if
2976        // a sync-typed call is in progress for this instance we must first
2977        // switch to another ready thread of that instance, or trap if there is
2978        // none.
2979        let instance = store
2980            .concurrent_state_mut()?
2981            .get_mut(guest_thread.task)?
2982            .instance;
2983        store.switch_or_trap_if_may_not_suspend(instance)?;
2984
2985        // Register to be woken up when an event is published for this waitable
2986        // set.
2987        //
2988        // Here we also set `GuestTask::wake_on_cancel` which allows
2989        // `subtask.cancel` to interrupt the wait.
2990        let state = store.concurrent_state_mut()?;
2991        let old = state
2992            .get_mut(guest_thread.thread)?
2993            .wake_on_cancel
2994            .replace(WakeOnCancel::Waiting(set));
2995        if !old.is_none() {
2996            bail_bug!("thread unexpectedly had wake_on_cancel set");
2997        }
2998        let old = state
2999            .get_mut(set)?
3000            .waiting
3001            .insert(guest_thread, WaitMode::Callback(self));
3002        if !old.is_none() {
3003            bail_bug!("set's waiting set already had this thread registered");
3004        }
3005        Ok(())
3006    }
3007
3008    /// Stage the specified guest call as the work item to run next, to be
3009    /// started as soon as backpressure and/or reentrance rules allow.
3010    ///
3011    /// SAFETY: The raw pointer arguments must be valid references to guest
3012    /// functions (with the appropriate signatures) when the closures staged by
3013    /// this function are called.
3014    unsafe fn stage_call<T: 'static>(
3015        self,
3016        mut store: StoreContextMut<T>,
3017        guest_thread: QualifiedThreadId,
3018        callee: SendSyncPtr<VMFuncRef>,
3019        param_count: usize,
3020        result_count: usize,
3021        async_: bool,
3022        callback: Option<SendSyncPtr<VMFuncRef>>,
3023        post_return: Option<SendSyncPtr<VMFuncRef>>,
3024        host_caller: bool,
3025    ) -> Result<()> {
3026        /// Return a closure which will call the specified function in the scope
3027        /// of the specified task.
3028        ///
3029        /// This will use `GuestTask::lower_params` to lower the parameters, but
3030        /// will not lift the result; instead, it returns a
3031        /// `[MaybeUninit<ValRaw>; MAX_FLAT_PARAMS]` from which the result, if
3032        /// any, may be lifted.  Note that an async-lifted export will have
3033        /// returned its result using the `task.return` intrinsic (or not
3034        /// returned a result at all, in the case of `task.cancel`), in which
3035        /// case the "result" of this call will either be a callback code or
3036        /// nothing.
3037        ///
3038        /// SAFETY: `callee` must be a valid `*mut VMFuncRef` at the time when
3039        /// the returned closure is called.
3040        unsafe fn make_call<T: 'static>(
3041            store: StoreContextMut<T>,
3042            guest_thread: QualifiedThreadId,
3043            callee: SendSyncPtr<VMFuncRef>,
3044            param_count: usize,
3045            result_count: usize,
3046        ) -> impl FnOnce(&mut dyn VMStore) -> Result<[MaybeUninit<ValRaw>; MAX_FLAT_PARAMS]>
3047        + Send
3048        + Sync
3049        + 'static
3050        + use<T> {
3051            let token = StoreToken::new(store);
3052            move |store: &mut dyn VMStore| {
3053                let mut storage = [MaybeUninit::uninit(); MAX_FLAT_PARAMS];
3054
3055                store
3056                    .concurrent_state_mut()?
3057                    .set_thread_running(guest_thread.thread)?;
3058                let task = store.concurrent_state_mut()?.get_mut(guest_thread.task)?;
3059                let lower = match task.lower_params.take() {
3060                    Some(l) => l,
3061                    None => bail_bug!("lower_params missing"),
3062                };
3063
3064                lower(store, &mut storage[..param_count])?;
3065
3066                let mut store = token.as_context_mut(store);
3067
3068                // SAFETY: Per the contract documented in `make_call's`
3069                // documentation, `callee` must be a valid pointer.
3070                unsafe {
3071                    crate::Func::call_unchecked_raw(
3072                        &mut store,
3073                        callee.as_non_null(),
3074                        NonNull::new(
3075                            &mut storage[..param_count.max(result_count)]
3076                                as *mut [MaybeUninit<ValRaw>] as _,
3077                        )
3078                        .unwrap(),
3079                        UncaughtException::Trap,
3080                    )?;
3081                }
3082
3083                Ok(storage)
3084            }
3085        }
3086
3087        // SAFETY: Per the contract described in this function documentation,
3088        // the `callee` pointer which `call` closes over must be valid when
3089        // called by the closure we queue below.
3090        let call = unsafe {
3091            make_call(
3092                store.as_context_mut(),
3093                guest_thread,
3094                callee,
3095                param_count,
3096                result_count,
3097            )
3098        };
3099
3100        let callee_instance = store
3101            .0
3102            .concurrent_state_mut()?
3103            .get_mut(guest_thread.task)?
3104            .instance;
3105
3106        let fun = if callback.is_some() {
3107            assert!(async_);
3108
3109            Box::new(move |store: &mut dyn VMStore| {
3110                self.add_guest_thread_to_instance_table(
3111                    guest_thread.thread,
3112                    store,
3113                    callee_instance.index,
3114                )?;
3115                self.handle_callback_code(store, guest_thread, callee_instance, |store| {
3116                    let storage = call(store)?;
3117
3118                    // SAFETY: `wasmparser` will have validated that the
3119                    // callback function returns a `i32` result.
3120                    Ok(unsafe { storage[0].assume_init() }.get_i32() as u32)
3121                })
3122            }) as Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send + Sync>
3123        } else {
3124            let token = StoreToken::new(store.as_context_mut());
3125            Box::new(move |store: &mut dyn VMStore| {
3126                self.add_guest_thread_to_instance_table(
3127                    guest_thread.thread,
3128                    store,
3129                    callee_instance.index,
3130                )?;
3131                let old_thread = store.set_thread(guest_thread)?;
3132                log::trace!(
3133                    "sync/async-stackful call: replaced {old_thread:?} with {guest_thread:?} as current thread",
3134                );
3135                let flags = self.id().get(store).instance_flags(callee_instance.index);
3136
3137                let callee_async_typed = store
3138                    .concurrent_state_mut()?
3139                    .get_mut(guest_thread.task)?
3140                    .async_typed;
3141
3142                // Unless this is a callback-less (i.e. stackful) async-lifted
3143                // or sync-typed export, we need to record that the instance
3144                // cannot be entered until the call returns.
3145                if !async_ && callee_async_typed {
3146                    store.enter_instance(callee_instance);
3147                }
3148
3149                if !callee_async_typed {
3150                    store.enter_sync_call(callee_instance)?;
3151                }
3152
3153                // SAFETY: See the documentation for `make_call` to review the
3154                // contract we must uphold for `call` here.
3155                //
3156                // Per the contract described in the `stage_call`
3157                // documentation, the `callee` pointer which `call` closes
3158                // over must be valid.
3159                let storage = call(store)?;
3160
3161                if !callee_async_typed {
3162                    store.exit_sync_call(callee_instance)?;
3163                }
3164
3165                if !async_ {
3166                    // This is a sync-lifted export, so now is when we lift the
3167                    // result, optionally call the post-return function, if any,
3168                    // and finally notify any current or future waiters that the
3169                    // subtask has returned.
3170
3171                    if callee_async_typed {
3172                        store.exit_instance(callee_instance)?;
3173                    }
3174
3175                    let lift = {
3176                        let state = store.concurrent_state_mut()?;
3177                        if !state.get_mut(guest_thread.task)?.result.is_none() {
3178                            bail_bug!("task has already produced a result");
3179                        }
3180
3181                        match state.get_mut(guest_thread.task)?.lift_result.take() {
3182                            Some(lift) => lift,
3183                            None => bail_bug!("lift_result field is missing"),
3184                        }
3185                    };
3186
3187                    // SAFETY: `result_count` represents the number of core Wasm
3188                    // results returned, per `wasmparser`.
3189                    let result = (lift.lift)(store, unsafe {
3190                        mem::transmute::<&[MaybeUninit<ValRaw>], &[ValRaw]>(
3191                            &storage[..result_count],
3192                        )
3193                    })?;
3194
3195                    let post_return_arg = match result_count {
3196                        0 => ValRaw::i32(0),
3197                        // SAFETY: `result_count` represents the number of
3198                        // core Wasm results returned, per `wasmparser`.
3199                        1 => unsafe { storage[0].assume_init() },
3200                        _ => unreachable!(),
3201                    };
3202
3203                    unsafe {
3204                        call_post_return(
3205                            token.as_context_mut(store),
3206                            post_return.map(|v| v.as_non_null()),
3207                            post_return_arg,
3208                            flags,
3209                        )?;
3210                    }
3211
3212                    self.task_complete(store, guest_thread.task, result, Status::Returned)?;
3213                }
3214
3215                store.set_thread(old_thread)?;
3216
3217                store
3218                    .concurrent_state_mut()?
3219                    .get_mut(guest_thread.task)?
3220                    .exited = true;
3221
3222                log::trace!(
3223                    "clean up thread; async lifted? {async_} async typed? {callee_async_typed}"
3224                );
3225
3226                if callee_async_typed {
3227                    // If we're async-typed, returning control to our caller
3228                    // won't help resolve any outstanding sync-typed call which
3229                    // might be in progress, so we may need to switch or trap
3230                    // before exiting this thread:
3231                    store.switch_or_trap_if_may_not_suspend(callee_instance)?;
3232                }
3233
3234                // This is a callback-less call, so the implicit thread has now completed
3235                store.cleanup_thread(guest_thread, callee_instance)?;
3236                Ok(())
3237            })
3238        };
3239
3240        store.0.concurrent_state_mut()?.push_work_item(
3241            WorkItem::GuestCall {
3242                instance: callee_instance,
3243                call: GuestCall {
3244                    thread: guest_thread,
3245                    kind: GuestCallKind::StartImplicit(fun),
3246                },
3247            },
3248            if host_caller {
3249                Priority::High
3250            } else {
3251                Priority::Switch
3252            },
3253        )?;
3254
3255        Ok(())
3256    }
3257
3258    /// Prepare (but do not start) a guest->guest call.
3259    ///
3260    /// This is called from fused adapter code generated in
3261    /// `wasmtime_environ::fact::trampoline::Compiler`.  `start` and `return_`
3262    /// are synthesized Wasm functions which move the parameters from the caller
3263    /// to the callee and the result from the callee to the caller,
3264    /// respectively.  The adapter will call `Self::start_call` immediately
3265    /// after calling this function.
3266    ///
3267    /// SAFETY: All the pointer arguments must be valid pointers to guest
3268    /// entities (and with the expected signatures for the function references
3269    /// -- see `wasmtime_environ::fact::trampoline::Compiler` for details).
3270    unsafe fn prepare_call<T: 'static>(
3271        self,
3272        mut store: StoreContextMut<T>,
3273        start: NonNull<VMFuncRef>,
3274        return_: NonNull<VMFuncRef>,
3275        caller_instance: RuntimeComponentInstanceIndex,
3276        callee_instance: RuntimeComponentInstanceIndex,
3277        task_return_type: TypeTupleIndex,
3278        callee_async_typed: bool,
3279        memory: *mut VMMemoryDefinition,
3280        string_encoding: StringEncoding,
3281        caller_info: CallerInfo,
3282    ) -> Result<()> {
3283        enum ResultInfo {
3284            Heap { results: u32 },
3285            Stack { result_count: u32 },
3286        }
3287
3288        let result_info = match &caller_info {
3289            CallerInfo::Async {
3290                has_result: true,
3291                params,
3292            } => ResultInfo::Heap {
3293                // FIXME(#4311): needs to read an i64 for memory64
3294                results: match params.last() {
3295                    Some(r) => r.get_u32(),
3296                    None => bail_bug!("retptr missing"),
3297                },
3298            },
3299            CallerInfo::Async {
3300                has_result: false, ..
3301            } => ResultInfo::Stack { result_count: 0 },
3302            CallerInfo::Sync {
3303                result_count,
3304                params,
3305            } if *result_count > u32::try_from(MAX_FLAT_RESULTS)? => ResultInfo::Heap {
3306                // FIXME(#4311): needs to read an i64 for memory64
3307                results: match params.last() {
3308                    Some(r) => r.get_u32(),
3309                    None => bail_bug!("arg ptr missing"),
3310                },
3311            },
3312            CallerInfo::Sync { result_count, .. } => ResultInfo::Stack {
3313                result_count: *result_count,
3314            },
3315        };
3316
3317        let sync_caller = matches!(caller_info, CallerInfo::Sync { .. });
3318
3319        // Create a new guest task for the call, closing over the `start` and
3320        // `return_` functions to lift the parameters and lower the result,
3321        // respectively.
3322        let start = SendSyncPtr::new(start);
3323        let return_ = SendSyncPtr::new(return_);
3324        let token = StoreToken::new(store.as_context_mut());
3325        let old_thread = store.0.current_guest_thread()?;
3326
3327        let state = store.0.concurrent_state_mut()?;
3328
3329        debug_assert_eq!(
3330            state.get_mut(old_thread.task)?.instance,
3331            self.runtime_instance(caller_instance)
3332        );
3333
3334        let guest_thread = GuestTask::new(
3335            state,
3336            Box::new(move |store, dst| {
3337                let mut store = token.as_context_mut(store);
3338                assert!(dst.len() <= MAX_FLAT_PARAMS);
3339                // The `+ 1` here accounts for the return pointer, if any:
3340                let mut src = [MaybeUninit::uninit(); MAX_FLAT_PARAMS + 1];
3341                let count = match caller_info {
3342                    // Async callers, if they have a result, use the last
3343                    // parameter as a return pointer so chop that off if
3344                    // relevant here.
3345                    CallerInfo::Async { params, has_result } => {
3346                        let params = &params[..params.len() - usize::from(has_result)];
3347                        for (param, src) in params.iter().zip(&mut src) {
3348                            src.write(*param);
3349                        }
3350                        params.len()
3351                    }
3352
3353                    // Sync callers forward everything directly.
3354                    CallerInfo::Sync { params, .. } => {
3355                        for (param, src) in params.iter().zip(&mut src) {
3356                            src.write(*param);
3357                        }
3358                        params.len()
3359                    }
3360                };
3361                // SAFETY: `start` is a valid `*mut VMFuncRef` from
3362                // `wasmtime-cranelift`-generated fused adapter code.  Based on
3363                // how it was constructed (see
3364                // `wasmtime_environ::fact::trampoline::Compiler::compile_async_start_adapter`
3365                // for details) we know it takes count parameters and returns
3366                // `dst.len()` results.
3367                unsafe {
3368                    crate::Func::call_unchecked_raw(
3369                        &mut store,
3370                        start.as_non_null(),
3371                        NonNull::new(
3372                            &mut src[..count.max(dst.len())] as *mut [MaybeUninit<ValRaw>] as _,
3373                        )
3374                        .unwrap(),
3375                        UncaughtException::Trap,
3376                    )?;
3377                }
3378                dst.copy_from_slice(&src[..dst.len()]);
3379                let task = store.0.current_guest_thread()?.task;
3380                let state = store.0.concurrent_state_mut()?;
3381                Waitable::Guest(task).set_event(
3382                    state,
3383                    Some(Event::Subtask {
3384                        status: Status::Started,
3385                    }),
3386                )?;
3387                Ok(())
3388            }),
3389            LiftResult {
3390                lift: Box::new(move |store, src| {
3391                    // SAFETY: See comment in closure passed as `lower_params`
3392                    // parameter above.
3393                    let mut store = token.as_context_mut(store);
3394                    let mut my_src = src.to_owned(); // TODO: use stack to avoid allocation?
3395                    if let ResultInfo::Heap { results } = &result_info {
3396                        my_src.push(ValRaw::u32(*results));
3397                    }
3398
3399                    // SAFETY: `return_` is a valid `*mut VMFuncRef` from
3400                    // `wasmtime-cranelift`-generated fused adapter code.  Based
3401                    // on how it was constructed (see
3402                    // `wasmtime_environ::fact::trampoline::Compiler::compile_async_return_adapter`
3403                    // for details) we know it takes `src.len()` parameters and
3404                    // returns up to 1 result.
3405                    unsafe {
3406                        crate::Func::call_unchecked_raw(
3407                            &mut store,
3408                            return_.as_non_null(),
3409                            my_src.as_mut_slice().into(),
3410                            UncaughtException::Trap,
3411                        )?;
3412                    }
3413
3414                    let thread = store.0.current_guest_thread()?;
3415                    let state = store.0.concurrent_state_mut()?;
3416                    if sync_caller {
3417                        state.get_mut(thread.task)?.sync_result = SyncResult::Produced(
3418                            if let ResultInfo::Stack { result_count } = &result_info {
3419                                match result_count {
3420                                    0 => None,
3421                                    1 => Some(my_src[0]),
3422                                    _ => unreachable!(),
3423                                }
3424                            } else {
3425                                None
3426                            },
3427                        );
3428                    }
3429                    Ok(Box::new(DummyResult) as Box<dyn Any + Send + Sync>)
3430                }),
3431                ty: task_return_type,
3432                memory: NonNull::new(memory).map(SendSyncPtr::new),
3433                string_encoding,
3434            },
3435            Caller::Guest { thread: old_thread },
3436            None,
3437            self.runtime_instance(callee_instance),
3438            callee_async_typed,
3439            // We don't know whether the callee export was lifted sync or async
3440            // yet, but we'll update this in `start_call`:
3441            false,
3442        )?;
3443
3444        // Make the new thread the current one so that `Self::start_call` knows
3445        // which one to start.
3446        store.0.set_thread(guest_thread)?;
3447        log::trace!("pushed {guest_thread:?} as current thread; old thread was {old_thread:?}");
3448
3449        Ok(())
3450    }
3451
3452    /// Call the specified callback function for an async-lifted export.
3453    ///
3454    /// SAFETY: `function` must be a valid reference to a guest function of the
3455    /// correct signature for a callback.
3456    unsafe fn call_callback<T>(
3457        self,
3458        mut store: StoreContextMut<T>,
3459        function: SendSyncPtr<VMFuncRef>,
3460        event: Event,
3461        handle: u32,
3462    ) -> Result<u32> {
3463        let (ordinal, result) = event.parts();
3464        let params = &mut [
3465            ValRaw::u32(ordinal),
3466            ValRaw::u32(handle),
3467            ValRaw::u32(result),
3468        ];
3469        // SAFETY: `func` is a valid `*mut VMFuncRef` from either
3470        // `wasmtime-cranelift`-generated fused adapter code or
3471        // `component::Options`.  Per `wasmparser` callback signature
3472        // validation, we know it takes three parameters and returns one.
3473        unsafe {
3474            crate::Func::call_unchecked_raw(
3475                &mut store,
3476                function.as_non_null(),
3477                params.as_mut_slice().into(),
3478                UncaughtException::Trap,
3479            )?;
3480        }
3481        Ok(params[0].get_u32())
3482    }
3483
3484    /// Start a guest->guest call previously prepared using
3485    /// `Self::prepare_call`.
3486    ///
3487    /// This is called from fused adapter code generated in
3488    /// `wasmtime_environ::fact::trampoline::Compiler`.  The adapter will call
3489    /// this function immediately after calling `Self::prepare_call`.
3490    ///
3491    /// If `flags` contains `START_FLAG_ASYNC_CALLER` then the caller used an
3492    /// async-lowered import and the call's packed status is written to
3493    /// `storage[0]`. Otherwise this blocks until the callee has produced its
3494    /// result, if any, which is written to `storage[0]`.
3495    ///
3496    /// SAFETY: The `*mut VMFuncRef` arguments must be valid pointers to guest
3497    /// functions with the appropriate signatures for the current guest task.
3498    /// If this is a call to an async-lowered import, the actual call may be
3499    /// deferred and run after this function returns, in which case the pointer
3500    /// arguments must also be valid when the call happens.
3501    unsafe fn start_call<T: 'static>(
3502        self,
3503        mut store: StoreContextMut<T>,
3504        callback: *mut VMFuncRef,
3505        post_return: *mut VMFuncRef,
3506        callee: NonNull<VMFuncRef>,
3507        param_count: u32,
3508        result_count: u32,
3509        flags: u32,
3510        storage: &mut [MaybeUninit<ValRaw>],
3511    ) -> Result<()> {
3512        let token = StoreToken::new(store.as_context_mut());
3513        let async_caller = (flags & START_FLAG_ASYNC_CALLER) != 0;
3514        let guest_thread = store.0.current_guest_thread()?;
3515        let state = store.0.concurrent_state_mut()?;
3516
3517        // FIXME(#14950): this in theory should be a `bail_bug!`, but this can
3518        // be hit through `Func::call` for example. This isn't great because it
3519        // means that `Func::call` is sort of fundamentally incompatible with
3520        // component-model-async...
3521        if !state.event_loop_running {
3522            bail!(
3523                "async function started during an original synchronous \
3524                 entrypoint; please use an async-style entrypoint instead"
3525            );
3526        }
3527
3528        let callee = SendSyncPtr::new(callee);
3529        let param_count = usize::try_from(param_count)?;
3530        assert!(param_count <= MAX_FLAT_PARAMS);
3531        let result_count = usize::try_from(result_count)?;
3532        assert!(result_count <= MAX_FLAT_RESULTS);
3533
3534        let task = state.get_mut(guest_thread.task)?;
3535        let callee_async_typed = task.async_typed;
3536        let callee_instance = task.instance;
3537
3538        task.async_lifted = (flags & START_FLAG_ASYNC_CALLEE) != 0;
3539
3540        if let Some(callback) = NonNull::new(callback) {
3541            // We're calling an async-lifted export with a callback, so store
3542            // the callback and related context as part of the task so we can
3543            // call it later when needed.
3544            let callback = SendSyncPtr::new(callback);
3545            task.callback = Some(Box::new(move |store, event, handle| {
3546                let store = token.as_context_mut(store);
3547                unsafe { self.call_callback::<T>(store, callback, event, handle) }
3548            }));
3549        }
3550
3551        let Caller::Guest { thread: caller } = &task.caller else {
3552            // As of this writing, `start_call` is only used for guest->guest
3553            // calls.
3554            bail_bug!("start_call unexpectedly invoked for host->guest call");
3555        };
3556        let caller = *caller;
3557        let caller_instance = state.get_mut(caller.task)?.instance;
3558
3559        // Stage the call as the work item to run next, modulo backpressure, etc.
3560        unsafe {
3561            self.stage_call(
3562                store.as_context_mut(),
3563                guest_thread,
3564                callee,
3565                param_count,
3566                result_count,
3567                (flags & START_FLAG_ASYNC_CALLEE) != 0,
3568                NonNull::new(callback).map(SendSyncPtr::new),
3569                NonNull::new(post_return).map(SendSyncPtr::new),
3570                false,
3571            )?;
3572        }
3573
3574        let old_do_not_suspend = if callee_async_typed {
3575            // If we're starting an async-typed call, it is permitted to suspend
3576            // since that will just return control back to the caller, which may
3577            // be able to avoid blocking if needed.
3578            //
3579            // We'll restore the old value after the call either returns or
3580            // suspends.
3581            let state = store.0.instance_state(callee_instance).concurrent_state();
3582            let old_do_not_suspend = state.do_not_suspend;
3583            state.do_not_suspend = false;
3584            Some(old_do_not_suspend)
3585        } else {
3586            None
3587        };
3588
3589        let state = store.0.concurrent_state_mut()?;
3590
3591        // Use the caller's `GuestThread::sync_call_set` to register interest in
3592        // the subtask...
3593        let guest_waitable = Waitable::Guest(guest_thread.task);
3594        let old_set = guest_waitable.common(state)?.set;
3595        let set = state.get_mut(caller.thread)?.sync_call_set;
3596        guest_waitable.join(state, Some(set))?;
3597
3598        store.0.set_thread(CurrentThread::None)?;
3599
3600        // ... and suspend this fiber temporarily while we wait for it to start.
3601        //
3602        // Note that we _could_ call the callee directly using the current fiber
3603        // rather than suspend this one, but that would make reasoning about the
3604        // event loop more complicated and is probably only worth doing if
3605        // there's a measurable performance benefit.  In addition, it would mean
3606        // blocking the caller if the callee calls a blocking sync-lowered
3607        // import, and as of this writing the spec says we must not do that.
3608        //
3609        // Alternatively, the fused adapter code could be modified to call the
3610        // callee directly without calling a host-provided intrinsic at all (in
3611        // which case it would need to do its own, inline backpressure checks,
3612        // etc.).  Again, we'd want to see a measurable performance benefit
3613        // before committing to such an optimization.  And again, we'd need to
3614        // update the spec to allow that.
3615        let mut yielded = false;
3616        let (status, waitable) = loop {
3617            store.0.suspend(if yielded {
3618                SuspendReason::Waiting {
3619                    set,
3620                    thread: caller,
3621                }
3622            } else {
3623                yielded = true;
3624                SuspendReason::YieldingToSubtask { thread: caller }
3625            })?;
3626
3627            if let Some(old_do_not_suspend) = old_do_not_suspend {
3628                store
3629                    .0
3630                    .instance_state(callee_instance)
3631                    .concurrent_state()
3632                    .do_not_suspend = old_do_not_suspend;
3633            }
3634
3635            let state = store.0.concurrent_state_mut()?;
3636
3637            log::trace!("taking event for {:?}", guest_thread.task);
3638            let event = guest_waitable.take_event(state)?;
3639            let Some(Event::Subtask { status }) = event else {
3640                bail_bug!("subtasks should only get subtask events, got {event:?}")
3641            };
3642
3643            log::trace!("status {status:?} for {:?}", guest_thread.task);
3644
3645            if status == Status::Returned {
3646                // It returned, so we can stop waiting.
3647                break (status, None);
3648            } else if async_caller {
3649                // It hasn't returned yet, but the caller is calling via an
3650                // async-lowered import, so we generate a handle for the task
3651                // waitable and return the status.
3652                let (state, counter) = store.0.instance_state_and_handle_counter(caller_instance);
3653                let handle = state
3654                    .handle_table()
3655                    .subtask_insert_guest(counter, guest_thread.task.rep())?;
3656                store
3657                    .0
3658                    .concurrent_state_mut()?
3659                    .get_mut(guest_thread.task)?
3660                    .common
3661                    .handle = Some(handle);
3662                break (status, Some(handle));
3663            } else {
3664                // The callee hasn't returned yet, and the caller is calling via
3665                // a sync-lowered import, so we loop and keep waiting until the
3666                // callee returns.
3667                store.0.switch_or_trap_if_may_not_suspend(caller_instance)?;
3668            }
3669        };
3670
3671        guest_waitable.join(store.0.concurrent_state_mut()?, old_set)?;
3672
3673        // Reset the current thread to point to the caller as it resumes control.
3674        store.0.set_thread(caller)?;
3675
3676        store
3677            .0
3678            .concurrent_state_mut()?
3679            .set_thread_running(caller.thread)?;
3680
3681        log::trace!("popped current thread {guest_thread:?}; new thread is {caller:?}");
3682
3683        if async_caller {
3684            let Some(slot) = storage.first_mut() else {
3685                bail_bug!("no storage for async call status");
3686            };
3687            *slot = MaybeUninit::new(ValRaw::u32(status.pack(waitable)));
3688        } else {
3689            // The caller used a sync-lowered import, in which case the result,
3690            // if any, has been stashed in `GuestTask::sync_result`.
3691            let state = store.0.concurrent_state_mut()?;
3692            let task = state.get_mut(guest_thread.task)?;
3693            if let Some(Some(result)) = task.sync_result.take()? {
3694                storage[0] = MaybeUninit::new(result);
3695            }
3696        }
3697
3698        if status == Status::Returned {
3699            store
3700                .0
3701                .concurrent_state_mut()?
3702                .decrement_task_ref_count(guest_thread.task)?;
3703        }
3704
3705        Ok(())
3706    }
3707
3708    /// Poll the specified future once on behalf of a guest->host call using an
3709    /// async-lowered import.
3710    ///
3711    /// If it returns `Ready`, return `Ok(None)`.  Otherwise, if it returns
3712    /// `Pending`, add it to the set of futures to be polled as part of this
3713    /// instance's event loop until it completes, and then return
3714    /// `Ok(Some(handle))` where `handle` is the waitable handle to return.
3715    ///
3716    /// Whether the future returns `Ready` immediately or later, the `lower`
3717    /// function will be used to lower the result, if any, into the guest caller's
3718    /// stack and linear memory. The `lower` function is invoked with the
3719    /// `Option<R>` param `None` if the future is cancelled. The
3720    /// `Option<TableId<HostTask>>` is passed as `Some` if the host task was
3721    /// materialized during execution and allows `lower` to delete the task if
3722    /// needed.
3723    pub(crate) fn first_poll<T: 'static, R: Send + 'static>(
3724        self,
3725        mut store: StoreContextMut<'_, T>,
3726        host_task: EnteredHostTask,
3727        result_may_require_realloc: bool,
3728        future: impl Future<Output = Result<R>> + Send + 'static,
3729        lower: impl FnOnce(StoreContextMut<T>, Option<R>, bool, Option<TableId<HostTask>>) -> Result<()>
3730        + Send
3731        + 'static,
3732    ) -> Result<u32> {
3733        let token = StoreToken::new(store.as_context_mut());
3734
3735        // Create an abortable future which hooks calls to poll and manages call
3736        // context state for the future.
3737        let (join_handle, future) = JoinHandle::run(future);
3738        let mut future = Box::pin(future);
3739
3740        // Finally, poll the future.  We can use a dummy `Waker` here because
3741        // we'll add the future to `ConcurrentState::futures` and poll it
3742        // automatically from the event loop if it doesn't complete immediately
3743        // here.
3744        let poll = tls::set(store.0, || {
3745            future
3746                .as_mut()
3747                .poll(&mut Context::from_waker(&Waker::noop()))
3748        });
3749
3750        match poll {
3751            // It finished immediately; lower the result and delete the task.
3752            Poll::Ready(result) => {
3753                let result = result.transpose()?;
3754                // Check if the host task was materialized so that it can be
3755                // deleted in `lower`.
3756                let task = store.0.current_materialized_host_task()?;
3757                lower(store.as_context_mut(), result, true, task)?;
3758                return Ok(Status::Returned.pack(None));
3759            }
3760
3761            // Future isn't ready yet, so fall through.
3762            Poll::Pending => {}
3763        }
3764
3765        // The future will outlive this call frame, so materialize the deferred
3766        // host task and attach its cancellation handle before publishing it to
3767        // the event loop.
3768        let Some(task) = store.0.materialize_host_task_id()? else {
3769            bail_bug!("current thread is not a host thread")
3770        };
3771        {
3772            let state = &mut store.0.concurrent_state_mut()?.get_mut(task)?.state;
3773            assert!(matches!(state, HostTaskState::CalleeStarted));
3774            *state = HostTaskState::CalleeRunning(join_handle);
3775        }
3776
3777        // It hasn't finished yet; add the future to
3778        // `ConcurrentState::futures` so it will be polled by the event
3779        // loop and allocate a waitable handle to return to the guest.
3780
3781        // Wrap the future in a closure responsible for lowering the result into
3782        // the guest's stack and memory, as well as notifying any waiters that
3783        // the task returned.
3784        let future = Box::pin(async move {
3785            let result = match run_with_host_task_set(task, future).await? {
3786                Some(result) => Some(result?),
3787                None => None,
3788            };
3789            let on_complete = move |store: &mut dyn VMStore| {
3790                // Restore the `current_thread` to be the host so `lower` knows
3791                // how to manipulate borrows and knows which scope of borrows
3792                // to check.
3793                let mut store = token.as_context_mut(store);
3794                let old = store.0.set_thread(task)?;
3795
3796                let status = if result.is_some() {
3797                    Status::Returned
3798                } else {
3799                    Status::ReturnCancelled
3800                };
3801
3802                lower(store.as_context_mut(), result, false, Some(task))?;
3803                let state = store.0.concurrent_state_mut()?;
3804                match &mut state.get_mut(task)?.state {
3805                    // Cancellation is only complete once lowering has finished
3806                    // and the terminal event can be published.
3807                    pending @ HostTaskState::CalleeCancelling => {
3808                        *pending = HostTaskState::CalleeDone { cancelled: true };
3809                    }
3810
3811                    // Otherwise transition this task to the done state.
3812                    other => *other = HostTaskState::CalleeDone { cancelled: false },
3813                }
3814                Waitable::Host(task).set_event(state, Some(Event::Subtask { status }))?;
3815
3816                store.0.set_thread(old)?;
3817                Ok(())
3818            };
3819
3820            tls::get(move |store| {
3821                if result_may_require_realloc {
3822                    // Lowering may call the guest's realloc function, so run
3823                    // it on a worker fiber. This is required because the guest
3824                    // might try to suspend the fiber which is unsound when it's
3825                    // not actually on a fiber.
3826                    store
3827                        .concurrent_state_mut()?
3828                        .push_high_priority(WorkItem::WorkerFunction(AlwaysMut::new(Box::new(
3829                            on_complete,
3830                        ))));
3831                    Ok(())
3832                } else {
3833                    // No guest code can be called while lowering this result,
3834                    // so avoid scheduling a worker fiber.
3835                    on_complete(store)
3836                }
3837            })
3838        });
3839
3840        // Make this task visible to the guest and then record what it
3841        // was made visible as.
3842        let caller = match host_task {
3843            Some(caller) => caller,
3844            None => bail_bug!("host task wasn't created but should have been"),
3845        };
3846        let state = store.0.concurrent_state_mut()?;
3847        state.push_future(future);
3848        let instance = state.get_mut(caller.task)?.instance;
3849        let (state, counter) = store.0.instance_state_and_handle_counter(instance);
3850        let handle = state
3851            .handle_table()
3852            .subtask_insert_host(counter, task.rep())?;
3853        store.0.concurrent_state_mut()?.get_mut(task)?.common.handle = Some(handle);
3854        log::trace!("assign {task:?} handle {handle} for {caller:?} instance {instance:?}");
3855
3856        // Restore the currently running thread to this host task's
3857        // caller. Note that the host task isn't deallocated as it's
3858        // within the store and will get deallocated later.
3859        store.0.set_thread(caller)?;
3860        Ok(Status::Started.pack(Some(handle)))
3861    }
3862
3863    /// Implements the `task.return` intrinsic, lifting the result for the
3864    /// current guest task.
3865    pub(crate) fn task_return(
3866        self,
3867        store: &mut dyn VMStore,
3868        ty: TypeTupleIndex,
3869        options: OptionsIndex,
3870        storage: &[ValRaw],
3871    ) -> Result<()> {
3872        let guest_thread = store.current_guest_thread()?;
3873        let state = store.concurrent_state_mut()?;
3874        if !state.get_mut(guest_thread.task)?.async_lifted {
3875            bail!(Trap::TaskReturnOrCancelSyncLifted);
3876        }
3877        let lift = state
3878            .get_mut(guest_thread.task)?
3879            .lift_result
3880            .take()
3881            .ok_or_else(|| Trap::TaskCancelOrReturnTwice)?;
3882        if !state.get_mut(guest_thread.task)?.result.is_none() {
3883            bail_bug!("task result unexpectedly already set");
3884        }
3885
3886        let CanonicalOptions {
3887            string_encoding,
3888            data_model,
3889            ..
3890        } = &self.id().get(store).component().env_component().options[options];
3891
3892        let invalid = ty != lift.ty
3893            || string_encoding != &lift.string_encoding
3894            || match data_model {
3895                CanonicalOptionsDataModel::LinearMemory(opts) => match opts.memory {
3896                    Some(memory) => {
3897                        let expected = lift.memory.map(|v| v.as_ptr()).unwrap_or(ptr::null_mut());
3898                        let actual = self.id().get(store).runtime_memory(memory);
3899                        expected != actual.as_ptr()
3900                    }
3901                    // Memory not specified, meaning it didn't need to be
3902                    // specified per validation, so not invalid.
3903                    None => false,
3904                },
3905                // Always invalid as this isn't supported.
3906                CanonicalOptionsDataModel::Gc { .. } => true,
3907            };
3908
3909        if invalid {
3910            bail!(Trap::TaskReturnInvalid);
3911        }
3912
3913        log::trace!("task.return for {guest_thread:?}");
3914
3915        let result = (lift.lift)(store, storage)?;
3916        self.task_complete(store, guest_thread.task, result, Status::Returned)
3917    }
3918
3919    /// Implements the `task.cancel` intrinsic.
3920    pub(crate) fn task_cancel(self, store: &mut StoreOpaque) -> Result<()> {
3921        let guest_thread = store.current_guest_thread()?;
3922        let state = store.concurrent_state_mut()?;
3923        let task = state.get_mut(guest_thread.task)?;
3924        if !task.async_lifted {
3925            bail!(Trap::TaskReturnOrCancelSyncLifted);
3926        }
3927        if !task.cancel_request_delivered {
3928            bail!(Trap::TaskCancelNotCancelled);
3929        }
3930        _ = task
3931            .lift_result
3932            .take()
3933            .ok_or_else(|| Trap::TaskCancelOrReturnTwice)?;
3934
3935        if !task.result.is_none() {
3936            bail_bug!("task result should not bet set yet");
3937        }
3938
3939        log::trace!("task.cancel for {guest_thread:?}");
3940
3941        self.task_complete(
3942            store,
3943            guest_thread.task,
3944            Box::new(DummyResult),
3945            Status::ReturnCancelled,
3946        )
3947    }
3948
3949    /// Complete the specified guest task (i.e. indicate that it has either
3950    /// returned a (possibly empty) result or cancelled itself).
3951    ///
3952    /// This will return any resource borrows and notify any current or future
3953    /// waiters that the task has completed.
3954    fn task_complete(
3955        self,
3956        store: &mut StoreOpaque,
3957        guest_task: TableId<GuestTask>,
3958        result: Box<dyn Any + Send + Sync>,
3959        status: Status,
3960    ) -> Result<()> {
3961        store
3962            .component_resource_tables(Some(self))?
3963            .validate_scope_exit()?;
3964
3965        let state = store.concurrent_state_mut()?;
3966        let task = state.get_mut(guest_task)?;
3967
3968        // A cancellation request is only delivered to a task which hasn't yet
3969        // resolved, so drop any pending, undelivered `Event::Cancelled` now
3970        // that this task has resolved.
3971        task.event = None;
3972
3973        if let Caller::Host { tx, .. } = &mut task.caller {
3974            if let Some(tx) = tx.take() {
3975                _ = tx.send(result);
3976            }
3977        } else {
3978            task.result = Some(result);
3979            Waitable::Guest(guest_task).set_event(state, Some(Event::Subtask { status }))?;
3980        }
3981
3982        Ok(())
3983    }
3984
3985    /// Implements the `waitable-set.new` intrinsic.
3986    pub(crate) fn waitable_set_new(
3987        self,
3988        store: &mut StoreOpaque,
3989        caller_instance: RuntimeComponentInstanceIndex,
3990    ) -> Result<u32> {
3991        let set = store.concurrent_state_mut()?.push(WaitableSet::default())?;
3992        let (state, counter) =
3993            store.instance_state_and_handle_counter(self.runtime_instance(caller_instance));
3994        let handle = state
3995            .handle_table()
3996            .waitable_set_insert(counter, set.rep())?;
3997        log::trace!("new waitable set {set:?} (handle {handle})");
3998        Ok(handle)
3999    }
4000
4001    /// Implements the `waitable-set.drop` intrinsic.
4002    pub(crate) fn waitable_set_drop(
4003        self,
4004        store: &mut StoreOpaque,
4005        caller_instance: RuntimeComponentInstanceIndex,
4006        set: u32,
4007    ) -> Result<()> {
4008        let rep = store
4009            .instance_state(self.runtime_instance(caller_instance))
4010            .handle_table()
4011            .waitable_set_remove(set)?;
4012
4013        log::trace!("drop waitable set {rep} (handle {set})");
4014
4015        // Note that we're careful to check for waiters _before_ deleting the
4016        // set to avoid dropping any waiters in `WaitMode::Fiber(_)`, which
4017        // would panic.  See `drop-waitable-set-with-waiters.wast` for details.
4018        let set = store
4019            .concurrent_state_mut()?
4020            .get_mut(TableId::<WaitableSet>::new(rep))?;
4021        if set.num_waiting > 0 {
4022            bail!(Trap::WaitableSetDropHasWaiters);
4023        }
4024
4025        store
4026            .concurrent_state_mut()?
4027            .delete(TableId::<WaitableSet>::new(rep))?;
4028
4029        Ok(())
4030    }
4031
4032    /// Implements the `waitable.join` intrinsic.
4033    pub(crate) fn waitable_join(
4034        self,
4035        store: &mut StoreOpaque,
4036        caller_instance: RuntimeComponentInstanceIndex,
4037        waitable_handle: u32,
4038        set_handle: u32,
4039    ) -> Result<()> {
4040        let mut instance = self.id().get_mut(store);
4041        let waitable =
4042            Waitable::from_instance(instance.as_mut(), caller_instance, waitable_handle)?;
4043
4044        let set = if set_handle == 0 {
4045            None
4046        } else {
4047            let set = instance.instance_states().0[caller_instance]
4048                .handle_table()
4049                .waitable_set_rep(set_handle)?;
4050
4051            Some(TableId::<WaitableSet>::new(set))
4052        };
4053
4054        waitable.trap_if_has_sync_waiter(store.concurrent_state_mut()?)?;
4055
4056        log::trace!(
4057            "waitable {waitable:?} (handle {waitable_handle}) join set {set:?} (handle {set_handle})",
4058        );
4059
4060        waitable.join(store.concurrent_state_mut()?, set)
4061    }
4062
4063    /// Implements the `subtask.drop` intrinsic.
4064    pub(crate) fn subtask_drop(
4065        self,
4066        store: &mut StoreOpaque,
4067        caller_instance: RuntimeComponentInstanceIndex,
4068        task_id: u32,
4069    ) -> Result<()> {
4070        self.waitable_join(store, caller_instance, task_id, 0)?;
4071
4072        let (rep, is_host) = store
4073            .instance_state(self.runtime_instance(caller_instance))
4074            .handle_table()
4075            .subtask_remove(task_id)?;
4076
4077        let concurrent_state = store.concurrent_state_mut()?;
4078        let waitable = if is_host {
4079            let id = TableId::<HostTask>::new(rep);
4080            let task = concurrent_state.get_mut(id)?;
4081            match &task.state {
4082                HostTaskState::CalleeRunning(_) | HostTaskState::CalleeCancelling => {
4083                    bail!(Trap::SubtaskDropNotResolved)
4084                }
4085                HostTaskState::CalleeDone { .. } => {}
4086                HostTaskState::CalleeStarted | HostTaskState::CalleeFinished(_) => {
4087                    bail_bug!("invalid state for callee in `subtask.drop`")
4088                }
4089            }
4090
4091            Waitable::Host(id)
4092        } else {
4093            let id = TableId::<GuestTask>::new(rep);
4094            let task = concurrent_state.get_mut(id)?;
4095            if task.lift_result.is_some() {
4096                bail!(Trap::SubtaskDropNotResolved);
4097            }
4098            Waitable::Guest(id)
4099        };
4100
4101        waitable.common(concurrent_state)?.handle = None;
4102
4103        // If this subtask has an event that means that the terminal status of
4104        // this subtask wasn't yet received so it can't be dropped yet.
4105        if waitable.take_event(concurrent_state)?.is_some() {
4106            bail!(Trap::SubtaskDropNotResolved);
4107        }
4108
4109        waitable.delete_from(concurrent_state)?;
4110
4111        log::trace!("subtask_drop {waitable:?} (handle {task_id})");
4112        Ok(())
4113    }
4114
4115    /// Implements the `waitable-set.wait` intrinsic.
4116    pub(crate) fn waitable_set_wait(
4117        self,
4118        store: &mut StoreOpaque,
4119        options: OptionsIndex,
4120        set: u32,
4121        payload: u32,
4122    ) -> Result<u32> {
4123        let &CanonicalOptions {
4124            instance: caller_instance,
4125            ..
4126        } = &self.id().get(store).component().env_component().options[options];
4127        let caller = self.runtime_instance(caller_instance);
4128        let rep = store
4129            .instance_state(self.runtime_instance(caller_instance))
4130            .handle_table()
4131            .waitable_set_rep(set)?;
4132
4133        self.waitable_check(
4134            store,
4135            caller,
4136            WaitableCheck::Wait,
4137            WaitableCheckParams {
4138                set: TableId::new(rep),
4139                options,
4140                payload,
4141            },
4142        )
4143    }
4144
4145    /// Implements the `waitable-set.poll` intrinsic.
4146    pub(crate) fn waitable_set_poll(
4147        self,
4148        store: &mut StoreOpaque,
4149        options: OptionsIndex,
4150        set: u32,
4151        payload: u32,
4152    ) -> Result<u32> {
4153        let &CanonicalOptions {
4154            instance: caller_instance,
4155            ..
4156        } = &self.id().get(store).component().env_component().options[options];
4157        let caller = self.runtime_instance(caller_instance);
4158        let rep = store
4159            .instance_state(caller)
4160            .handle_table()
4161            .waitable_set_rep(set)?;
4162
4163        self.waitable_check(
4164            store,
4165            caller,
4166            WaitableCheck::Poll,
4167            WaitableCheckParams {
4168                set: TableId::new(rep),
4169                options,
4170                payload,
4171            },
4172        )
4173    }
4174
4175    /// Implements the `thread.index` intrinsic.
4176    pub(crate) fn thread_index(&self, store: &mut dyn VMStore) -> Result<u32> {
4177        let thread_id = store.current_guest_thread()?.thread;
4178        match store
4179            .concurrent_state_mut()?
4180            .get_mut(thread_id)?
4181            .instance_rep
4182        {
4183            Some(r) => Ok(r),
4184            None => bail_bug!("thread should have instance_rep by now"),
4185        }
4186    }
4187
4188    /// Implements the `thread.new-indirect` intrinsic.
4189    pub(crate) fn thread_new_indirect<T: 'static>(
4190        self,
4191        mut store: StoreContextMut<T>,
4192        runtime_instance: RuntimeComponentInstanceIndex,
4193        start_func_ty: ModuleInternedTypeIndex,
4194        start_func_table_idx: RuntimeTableIndex,
4195        start_func_idx: u32,
4196        context: i32,
4197    ) -> Result<u32> {
4198        log::trace!("creating new thread");
4199
4200        let (instance, registry) = self.id().get_mut_and_registry(store.0);
4201        let Some(start_func_ty) = instance.component().signatures().shared_type(start_func_ty)
4202        else {
4203            bail_bug!("thread.new-indirect start function type should be registered");
4204        };
4205        let callee = instance
4206            .index_runtime_func_table(registry, start_func_table_idx, start_func_idx as u64)?
4207            .ok_or_else(|| Trap::ThreadNewIndirectUninitialized)?;
4208        if callee.type_index(store.0) != start_func_ty {
4209            bail!(Trap::ThreadNewIndirectInvalidType);
4210        }
4211
4212        let token = StoreToken::new(store.as_context_mut());
4213        let start_func = Box::new(
4214            move |store: &mut dyn VMStore, guest_thread: QualifiedThreadId| -> Result<()> {
4215                let old_thread = store.set_thread(guest_thread)?;
4216                log::trace!(
4217                    "thread start: replaced {old_thread:?} with {guest_thread:?} as current thread"
4218                );
4219
4220                let mut store = token.as_context_mut(store);
4221                let mut params = [ValRaw::i32(context)];
4222                // Use call_unchecked rather than call or call_async, as we don't want to run the function
4223                // on a separate fiber if we're running in an async store.
4224                unsafe { callee.call_unchecked(store.as_context_mut(), &mut params)? };
4225
4226                store.0.set_thread(old_thread)?;
4227
4228                let runtime_instance = self.runtime_instance(runtime_instance);
4229
4230                // We're not returning to any caller, so we may need to switch
4231                // or trap if the instance has an outstanding sync-typed call:
4232                store
4233                    .0
4234                    .switch_or_trap_if_may_not_suspend(runtime_instance)?;
4235
4236                store.0.cleanup_thread(guest_thread, runtime_instance)?;
4237
4238                log::trace!("explicit thread {guest_thread:?} completed");
4239                let state = store.0.concurrent_state_mut()?;
4240                if let Some(t) = old_thread.guest() {
4241                    state.set_thread_running(t.thread)?;
4242                }
4243                log::trace!("thread start: restored {old_thread:?} as current thread");
4244
4245                Ok(())
4246            },
4247        );
4248
4249        let current_thread = store.0.current_guest_thread()?;
4250        let state = store.0.concurrent_state_mut()?;
4251        let parent_task = current_thread.task;
4252
4253        let new_thread = GuestThread::new_explicit(state, parent_task, start_func)?;
4254        let thread_id = state.push(new_thread)?;
4255        state.get_mut(parent_task)?.threads.insert(thread_id);
4256
4257        log::trace!("new thread with id {thread_id:?} created");
4258
4259        self.add_guest_thread_to_instance_table(thread_id, store.0, runtime_instance)
4260    }
4261
4262    pub(crate) fn resume_thread(
4263        self,
4264        store: &mut StoreOpaque,
4265        runtime_instance: RuntimeComponentInstanceIndex,
4266        thread_idx: u32,
4267        how: ResumeThread,
4268    ) -> Result<bool> {
4269        let thread_id =
4270            GuestThread::from_instance(self.id().get_mut(store), runtime_instance, thread_idx)?;
4271        let state = store.concurrent_state_mut()?;
4272        let guest_thread = QualifiedThreadId::qualify(state, thread_id)?;
4273
4274        if store.current_guest_thread()? == guest_thread {
4275            bail!(Trap::CannotResumeThread);
4276        }
4277
4278        let priority = match how {
4279            ResumeThread::Resume => Priority::Switch,
4280            ResumeThread::ResumeLater => Priority::Low,
4281
4282            // Promotion is a noop unless the thread is ready, so only search
4283            // through pending work items to see if something matches.
4284            ResumeThread::Promote => {
4285                let instance = self.runtime_instance(runtime_instance);
4286                let do_not_enter = store
4287                    .instance_state(instance)
4288                    .concurrent_state()
4289                    .do_not_enter;
4290                return store.concurrent_state_mut()?.promote_work_item_matching(
4291                    |item: &WorkItem| match item {
4292                        WorkItem::ResumeThread { thread, .. }
4293                        | WorkItem::ResumeFiber { thread, .. } => *thread == guest_thread,
4294
4295                        WorkItem::GuestCall {
4296                            call: GuestCall { thread, kind },
4297                            ..
4298                        } => {
4299                            *thread == guest_thread
4300                                && match kind {
4301                                    // Events can only be delivered if this
4302                                    // instance's exclusive lock isn't held, so
4303                                    // gate on that.
4304                                    GuestCallKind::DeliverEvent { .. } => !do_not_enter,
4305
4306                                    // A not-yet-started thread made ready via
4307                                    // `thread.resume-later`.
4308                                    GuestCallKind::StartExplicit(_) => true,
4309
4310                                    // Technically shouldn't be possible since
4311                                    // if this hasn't started nothing could get
4312                                    // its id...
4313                                    GuestCallKind::StartImplicit(_) => false,
4314                                }
4315                        }
4316
4317                        WorkItem::PushFuture(_) | WorkItem::WorkerFunction(_) => false,
4318                    },
4319                );
4320            }
4321        };
4322
4323        let state = store.concurrent_state_mut()?;
4324        let thread = state.get_mut(guest_thread.thread)?;
4325
4326        // When resuming a thread it must be in a suspended state otherwise
4327        // this operation is a trap.
4328        match &thread.state {
4329            GuestThreadState::NotStartedExplicit(_) => {}
4330            GuestThreadState::Suspended(_) => {
4331                log::trace!("resuming thread {thread_id:?} that was suspended");
4332                state.schedule_suspended_thread(
4333                    guest_thread,
4334                    self.runtime_instance(runtime_instance),
4335                    priority,
4336                )?;
4337                return Ok(true);
4338            }
4339            _ => bail!(Trap::CannotResumeThread),
4340        }
4341        match mem::replace(&mut thread.state, GuestThreadState::Running) {
4342            GuestThreadState::NotStartedExplicit(start_func) => {
4343                log::trace!("starting thread {guest_thread:?}");
4344                let guest_call = WorkItem::GuestCall {
4345                    instance: self.runtime_instance(runtime_instance),
4346                    call: GuestCall {
4347                        thread: guest_thread,
4348                        kind: GuestCallKind::StartExplicit(Box::new(move |store| {
4349                            start_func(store, guest_thread)
4350                        })),
4351                    },
4352                };
4353                state.push_work_item(guest_call, priority)?;
4354            }
4355            other => {
4356                thread.state = other;
4357                bail_bug!("thread state checked to be resumable above");
4358            }
4359        }
4360        Ok(true)
4361    }
4362
4363    fn add_guest_thread_to_instance_table(
4364        self,
4365        thread_id: TableId<GuestThread>,
4366        store: &mut StoreOpaque,
4367        runtime_instance: RuntimeComponentInstanceIndex,
4368    ) -> Result<u32> {
4369        let (state, counter) =
4370            store.instance_state_and_handle_counter(self.runtime_instance(runtime_instance));
4371        let guest_id = state
4372            .thread_handle_table()
4373            .guest_thread_insert(counter, thread_id.rep())?;
4374        store
4375            .concurrent_state_mut()?
4376            .get_mut(thread_id)?
4377            .instance_rep = Some(guest_id);
4378        Ok(guest_id)
4379    }
4380
4381    /// Helper function for the `thread.yield`, thread.suspend`,
4382    /// `thread.suspend-then-resume`, `thread.suspend-then-promote`,
4383    /// `thread.yield-then-resume`, and `thread.yield-then-promote` intrinsics.
4384    pub(crate) fn suspension_intrinsic(
4385        self,
4386        store: &mut StoreOpaque,
4387        caller: RuntimeComponentInstanceIndex,
4388        yielding: bool,
4389        to_thread: SuspensionTarget,
4390    ) -> Result<WaitResult> {
4391        let check_suspend = match to_thread {
4392            SuspensionTarget::Promote(thread) => {
4393                !self.resume_thread(store, caller, thread, ResumeThread::Promote)?
4394            }
4395            SuspensionTarget::Resume(thread) => {
4396                if !self.resume_thread(store, caller, thread, ResumeThread::Resume)? {
4397                    bail_bug!(
4398                        "`resume_thread` should only ever return false \
4399                         when `ResumeThread::Promote` is passed to it"
4400                    );
4401                }
4402                false
4403            }
4404            SuspensionTarget::None => true,
4405        };
4406
4407        if check_suspend && !store.switch_if_may_not_suspend(self.runtime_instance(caller))? {
4408            return if yielding {
4409                Ok(WaitResult::Completed)
4410            } else {
4411                Err(Trap::CannotBlockSyncTask.into())
4412            };
4413        }
4414
4415        let guest_thread = store.current_guest_thread()?;
4416
4417        let reason = if yielding {
4418            SuspendReason::Yielding {
4419                thread: guest_thread,
4420            }
4421        } else {
4422            SuspendReason::ExplicitlySuspending {
4423                thread: guest_thread,
4424            }
4425        };
4426
4427        store.suspend(reason)?;
4428
4429        Ok(WaitResult::Completed)
4430    }
4431
4432    /// Helper function for the `waitable-set.wait` and `waitable-set.poll` intrinsics.
4433    fn waitable_check(
4434        self,
4435        store: &mut StoreOpaque,
4436        caller: RuntimeInstance,
4437        check: WaitableCheck,
4438        params: WaitableCheckParams,
4439    ) -> Result<u32> {
4440        let guest_thread = store.current_guest_thread()?;
4441
4442        log::trace!("waitable check for {guest_thread:?}; set {:?}", params.set);
4443
4444        // If we're waiting, and there are no events immediately available,
4445        // suspend the fiber until that changes.
4446        match &check {
4447            WaitableCheck::Wait => {
4448                let set = params.set;
4449
4450                // Note that this is a loop since, by the time this fiber is
4451                // resumed after being woken up, another thread may have already
4452                // taken the event (e.g. via `waitable-set.poll`), in which case
4453                // we keep waiting.
4454                loop {
4455                    let state = store.concurrent_state_mut()?;
4456                    let task = state.get_mut(guest_thread.task)?;
4457                    if !(task.event.is_none() || matches!(task.event, Some(Event::Cancelled)))
4458                        || !state.get_mut(set)?.ready.is_empty()
4459                    {
4460                        break;
4461                    }
4462
4463                    store.switch_or_trap_if_may_not_suspend(caller)?;
4464
4465                    store.suspend(SuspendReason::Waiting {
4466                        set,
4467                        thread: guest_thread,
4468                    })?;
4469                }
4470            }
4471            WaitableCheck::Poll => {}
4472        }
4473
4474        log::trace!(
4475            "waitable check for {guest_thread:?}; set {:?}, part two",
4476            params.set
4477        );
4478
4479        // Deliver any pending events to the guest and return.
4480        let event = self.get_event(store, guest_thread.task, Some(params.set), false)?;
4481
4482        let (ordinal, handle, result) = match &check {
4483            WaitableCheck::Wait => {
4484                let (event, waitable) = match event {
4485                    Some(p) => p,
4486                    None => bail_bug!("event expected to be present"),
4487                };
4488                let handle = waitable.map(|(_, v)| v).unwrap_or(0);
4489                let (ordinal, result) = event.parts();
4490                (ordinal, handle, result)
4491            }
4492            WaitableCheck::Poll => {
4493                if let Some((event, waitable)) = event {
4494                    let handle = waitable.map(|(_, v)| v).unwrap_or(0);
4495                    let (ordinal, result) = event.parts();
4496                    (ordinal, handle, result)
4497                } else {
4498                    log::trace!(
4499                        "no events ready to deliver via waitable-set.poll to {:?}; set {:?}",
4500                        guest_thread.task,
4501                        params.set
4502                    );
4503                    let (ordinal, result) = Event::None.parts();
4504                    (ordinal, 0, result)
4505                }
4506            }
4507        };
4508        let memory = self.options_memory_mut(store, params.options);
4509        let ptr = crate::component::func::validate_inbounds_dynamic(
4510            &CanonicalAbiInfo::POINTER_PAIR,
4511            memory,
4512            &ValRaw::u32(params.payload),
4513        )?;
4514        memory[ptr + 0..][..4].copy_from_slice(&handle.to_le_bytes());
4515        memory[ptr + 4..][..4].copy_from_slice(&result.to_le_bytes());
4516        Ok(ordinal)
4517    }
4518
4519    /// Implements the `subtask.cancel` intrinsic.
4520    pub(crate) fn subtask_cancel(
4521        self,
4522        store: &mut StoreOpaque,
4523        caller_instance: RuntimeComponentInstanceIndex,
4524        async_: bool,
4525        task_id: u32,
4526    ) -> Result<u32> {
4527        let (rep, is_host) = store
4528            .instance_state(self.runtime_instance(caller_instance))
4529            .handle_table()
4530            .subtask_rep(task_id)?;
4531        let waitable = if is_host {
4532            Waitable::Host(TableId::<HostTask>::new(rep))
4533        } else {
4534            Waitable::Guest(TableId::<GuestTask>::new(rep))
4535        };
4536        let concurrent_state = store.concurrent_state_mut()?;
4537
4538        log::trace!("subtask_cancel {waitable:?} (handle {task_id}; async {async_})");
4539
4540        waitable.trap_if_in_waitable_set(concurrent_state)?;
4541
4542        let needs_block;
4543        if let Waitable::Host(host_task) = waitable {
4544            let state = &mut concurrent_state.get_mut(host_task)?.state;
4545            match state {
4546                // If the callee is still running, signal an abort is requested.
4547                //
4548                // After cancelling this falls through to block waiting for the
4549                // host task to actually finish assuming that `async_` is false.
4550                // This blocking behavior resolves the race of `handle.abort()`
4551                // with the task actually getting cancelled or finishing.
4552                HostTaskState::CalleeRunning(handle) => {
4553                    handle.abort();
4554                    *state = HostTaskState::CalleeCancelling;
4555                    needs_block = true;
4556                }
4557
4558                // Cancellation was already requested, so fail as the task can't
4559                // be cancelled twice.
4560                HostTaskState::CalleeCancelling | HostTaskState::CalleeDone { cancelled: true } => {
4561                    bail!(Trap::SubtaskCancelAfterTerminal);
4562                }
4563                HostTaskState::CalleeDone { cancelled: false } => {
4564                    // The callee is already done so there's no need to
4565                    // block further for an event.
4566                    *state = HostTaskState::CalleeDone { cancelled: true };
4567                    needs_block = false;
4568                }
4569
4570                // These states should not be possible for a subtask that's
4571                // visible from the guest, so trap here.
4572                HostTaskState::CalleeStarted | HostTaskState::CalleeFinished(_) => {
4573                    bail_bug!("invalid states for host callee")
4574                }
4575            }
4576        } else {
4577            let guest_task = TableId::<GuestTask>::new(rep);
4578            let task = concurrent_state.get_mut(guest_task)?;
4579
4580            // Cancellation was already requested, so fail as the task can't be
4581            // cancelled twice.
4582            if task.cancel_requested {
4583                bail!(Trap::SubtaskCancelAfterTerminal);
4584            }
4585
4586            if !task.already_lowered_parameters() {
4587                store.cancel_guest_subtask_without_lowered_parameters(
4588                    self.runtime_instance(caller_instance),
4589                    guest_task,
4590                )?;
4591                return Ok(Status::StartCancelled as u32);
4592            } else if !task.returned_or_cancelled() {
4593                // Started, but not yet returned or cancelled; send the
4594                // `CANCELLED` event
4595                //
4596                // Note that this might overwrite an event that was set earlier
4597                // (e.g. `Event::None` if the task is yielding), but that's
4598                // okay -- this should supersede the previous state.
4599                task.cancel_requested = true;
4600                task.event = Some(Event::Cancelled);
4601                let runtime_instance = task.instance;
4602                for thread in task.threads.clone() {
4603                    let thread = QualifiedThreadId {
4604                        task: guest_task,
4605                        thread,
4606                    };
4607                    let concurrent_state = store.concurrent_state_mut()?;
4608                    let thread_mut = concurrent_state.get_mut(thread.thread)?;
4609
4610                    let yield_ = |store: &mut StoreOpaque| {
4611                        // While we're yielding, temporarily set
4612                        // `do_not_suspend` to false on the subtask's instance
4613                        // since we'll be getting control back if it does
4614                        // suspend.
4615                        let state = store.instance_state(runtime_instance).concurrent_state();
4616                        let old_do_not_suspend = state.do_not_suspend;
4617                        state.do_not_suspend = false;
4618
4619                        let caller = store.current_guest_thread()?;
4620
4621                        // Temporarily add the waitable to the caller's
4622                        // `sync_call_set` to ensure that (1) it isn't already
4623                        // part of a different set and (2) it can't be added to
4624                        // a different set while we yield to the subtask.
4625                        let state = store.concurrent_state_mut()?;
4626                        let set = state.get_mut(caller.thread)?.sync_call_set;
4627                        waitable.join(state, Some(set))?;
4628
4629                        store.suspend(SuspendReason::YieldingToSubtask { thread: caller })?;
4630
4631                        let state = store.concurrent_state_mut()?;
4632                        waitable.join(state, None)?;
4633
4634                        store
4635                            .instance_state(runtime_instance)
4636                            .concurrent_state()
4637                            .do_not_suspend = old_do_not_suspend;
4638
4639                        Ok::<(), crate::Error>(())
4640                    };
4641
4642                    match thread_mut.wake_on_cancel.take() {
4643                        WakeOnCancel::Waiting(set) => {
4644                            // The thread is in a cancellable wait, so wake it up:
4645                            let instance = concurrent_state.take_callback_waiter(set, thread)?;
4646                            let item = WorkItem::GuestCall {
4647                                instance: runtime_instance,
4648                                call: GuestCall {
4649                                    thread,
4650                                    kind: GuestCallKind::DeliverEvent {
4651                                        instance,
4652                                        set: Some(set),
4653                                    },
4654                                },
4655                            };
4656                            concurrent_state.set_switch_item(item)?;
4657
4658                            yield_(store)?;
4659
4660                            break;
4661                        }
4662                        WakeOnCancel::Yielding => {
4663                            if concurrent_state.promote_thread_work_item(thread)? {
4664                                yield_(store)?;
4665                                break;
4666                            } else if store
4667                                .instance_state(runtime_instance)
4668                                .concurrent_state()
4669                                .pending
4670                                .contains_key(&thread)
4671                            {
4672                                // The thread's work item was parked in
4673                                // `pending` because its instance can't be
4674                                // entered right now, so the cancellation
4675                                // can't be delivered yet. It'll be delivered
4676                                // via `GuestTask::event` once the instance
4677                                // becomes enterable and the work item runs.
4678                                // Until then the thread is still yielding, so
4679                                // restore `wake_on_cancel` and move on to the
4680                                // next thread.
4681                                store
4682                                    .concurrent_state_mut()?
4683                                    .get_mut(thread.thread)?
4684                                    .wake_on_cancel = WakeOnCancel::Yielding;
4685                            } else {
4686                                bail_bug!("thread with `WakeOnCancel::Yielding` not promotable");
4687                            }
4688                        }
4689                        WakeOnCancel::None => {}
4690                    }
4691                }
4692
4693                // Guest tasks need to block if they have not yet returned or
4694                // cancelled, even as a result of the event delivery above.
4695                needs_block = !store
4696                    .concurrent_state_mut()?
4697                    .get_mut(guest_task)?
4698                    .returned_or_cancelled()
4699            } else {
4700                needs_block = false;
4701            }
4702        };
4703
4704        // If we need to block waiting on the terminal status of this subtask
4705        // then return immediately in `async` mode, or otherwise wait for the
4706        // event to get signaled through the store.
4707        if needs_block {
4708            if async_ {
4709                return Ok(BLOCKED);
4710            }
4711
4712            // For cancelling host tasks save and later restore
4713            // `next_switch_item` so that our caller (or canceller) isn't
4714            // resumed in the meantime. This is our prerogative as a runtime
4715            // where we get to decide whether cancellation of host things blocks
4716            // or doesn't, and here we just need to get the final status from
4717            // the host side so it shouldn't block.
4718            //
4719            // A guest subtask, however, may genuinely block, so skip this in
4720            // that case.
4721            let old_next_switch_item = if is_host {
4722                Some(store.concurrent_state_mut()?.save_next_switch_item()?)
4723            } else {
4724                None
4725            };
4726
4727            // Wait for this waitable to get signaled with its terminal
4728            // status. Once that's done fall through to the shared code.
4729            store.wait_for_event(self.runtime_instance(caller_instance), waitable)?;
4730
4731            if let Some(item) = old_next_switch_item {
4732                let state = store.concurrent_state_mut()?;
4733                state.restore_next_switch_item(item)?;
4734            }
4735
4736            // .. fall through to determine what event's in store for us.
4737        }
4738
4739        let event = waitable.take_event(store.concurrent_state_mut()?)?;
4740        if let Some(Event::Subtask {
4741            status: status @ (Status::Returned | Status::ReturnCancelled),
4742        }) = event
4743        {
4744            Ok(status as u32)
4745        } else {
4746            bail!(Trap::SubtaskCancelAfterTerminal);
4747        }
4748    }
4749}
4750
4751/// Trait representing component model ABI async intrinsics and fused adapter
4752/// helper functions.
4753///
4754/// SAFETY (callers): Most of the methods in this trait accept raw pointers,
4755/// which must be valid for at least the duration of the call (and possibly for
4756/// as long as the relevant guest task exists, in the case of `*mut VMFuncRef`
4757/// pointers used for async calls).
4758pub trait VMComponentAsyncStore {
4759    /// A helper function for fused adapter modules involving calls where the
4760    /// one of the caller or callee is async.
4761    ///
4762    /// This helper is not used when the caller and callee both use the sync
4763    /// ABI, only when at least one is async is this used.
4764    unsafe fn prepare_call(
4765        &mut self,
4766        instance: Instance,
4767        memory: *mut VMMemoryDefinition,
4768        start: NonNull<VMFuncRef>,
4769        return_: NonNull<VMFuncRef>,
4770        caller_instance: RuntimeComponentInstanceIndex,
4771        callee_instance: RuntimeComponentInstanceIndex,
4772        task_return_type: TypeTupleIndex,
4773        callee_async: bool,
4774        string_encoding: StringEncoding,
4775        result_count: u32,
4776        storage: *mut ValRaw,
4777        storage_len: usize,
4778    ) -> Result<()>;
4779
4780    /// A helper function for fused adapter modules to start a call previously
4781    /// set up with `prepare_call`.
4782    unsafe fn start_call(
4783        &mut self,
4784        instance: Instance,
4785        callback: *mut VMFuncRef,
4786        post_return: *mut VMFuncRef,
4787        callee: NonNull<VMFuncRef>,
4788        param_count: u32,
4789        result_count: u32,
4790        flags: u32,
4791        storage: *mut MaybeUninit<ValRaw>,
4792        storage_len: usize,
4793    ) -> Result<()>;
4794
4795    /// The `future.write` intrinsic.
4796    fn future_write(
4797        &mut self,
4798        instance: Instance,
4799        caller: RuntimeComponentInstanceIndex,
4800        ty: TypeFutureTableIndex,
4801        options: OptionsIndex,
4802        future: u32,
4803        address: u32,
4804    ) -> Result<u32>;
4805
4806    /// The `future.read` intrinsic.
4807    fn future_read(
4808        &mut self,
4809        instance: Instance,
4810        caller: RuntimeComponentInstanceIndex,
4811        ty: TypeFutureTableIndex,
4812        options: OptionsIndex,
4813        future: u32,
4814        address: u32,
4815    ) -> Result<u32>;
4816
4817    /// The `future.drop-writable` intrinsic.
4818    fn future_drop_writable(
4819        &mut self,
4820        instance: Instance,
4821        ty: TypeFutureTableIndex,
4822        writer: u32,
4823    ) -> Result<()>;
4824
4825    /// The `stream.write` intrinsic.
4826    fn stream_write(
4827        &mut self,
4828        instance: Instance,
4829        caller: RuntimeComponentInstanceIndex,
4830        ty: TypeStreamTableIndex,
4831        options: OptionsIndex,
4832        stream: u32,
4833        address: u32,
4834        count: u32,
4835    ) -> Result<u32>;
4836
4837    /// The `stream.read` intrinsic.
4838    fn stream_read(
4839        &mut self,
4840        instance: Instance,
4841        caller: RuntimeComponentInstanceIndex,
4842        ty: TypeStreamTableIndex,
4843        options: OptionsIndex,
4844        stream: u32,
4845        address: u32,
4846        count: u32,
4847    ) -> Result<u32>;
4848
4849    /// The "fast-path" implementation of the `stream.write` intrinsic for
4850    /// "flat" (i.e. memcpy-able) payloads.
4851    fn flat_stream_write(
4852        &mut self,
4853        instance: Instance,
4854        caller: RuntimeComponentInstanceIndex,
4855        ty: TypeStreamTableIndex,
4856        options: OptionsIndex,
4857        payload_size: u32,
4858        payload_align: u32,
4859        stream: u32,
4860        address: u32,
4861        count: u32,
4862    ) -> Result<u32>;
4863
4864    /// The "fast-path" implementation of the `stream.read` intrinsic for "flat"
4865    /// (i.e. memcpy-able) payloads.
4866    fn flat_stream_read(
4867        &mut self,
4868        instance: Instance,
4869        caller: RuntimeComponentInstanceIndex,
4870        ty: TypeStreamTableIndex,
4871        options: OptionsIndex,
4872        payload_size: u32,
4873        payload_align: u32,
4874        stream: u32,
4875        address: u32,
4876        count: u32,
4877    ) -> Result<u32>;
4878
4879    /// The `stream.drop-writable` intrinsic.
4880    fn stream_drop_writable(
4881        &mut self,
4882        instance: Instance,
4883        ty: TypeStreamTableIndex,
4884        writer: u32,
4885    ) -> Result<()>;
4886
4887    /// The `error-context.debug-message` intrinsic.
4888    fn error_context_debug_message(
4889        &mut self,
4890        instance: Instance,
4891        ty: TypeComponentLocalErrorContextTableIndex,
4892        options: OptionsIndex,
4893        err_ctx_handle: u32,
4894        debug_msg_address: u32,
4895    ) -> Result<()>;
4896
4897    /// The `thread.new-indirect` intrinsic
4898    fn thread_new_indirect(
4899        &mut self,
4900        instance: Instance,
4901        caller: RuntimeComponentInstanceIndex,
4902        func_ty_idx: ModuleInternedTypeIndex,
4903        start_func_table_idx: RuntimeTableIndex,
4904        start_func_idx: u32,
4905        context: i32,
4906    ) -> Result<u32>;
4907}
4908
4909/// SAFETY: See trait docs.
4910impl<T: 'static> VMComponentAsyncStore for StoreInner<T> {
4911    unsafe fn prepare_call(
4912        &mut self,
4913        instance: Instance,
4914        memory: *mut VMMemoryDefinition,
4915        start: NonNull<VMFuncRef>,
4916        return_: NonNull<VMFuncRef>,
4917        caller_instance: RuntimeComponentInstanceIndex,
4918        callee_instance: RuntimeComponentInstanceIndex,
4919        task_return_type: TypeTupleIndex,
4920        callee_async: bool,
4921        string_encoding: StringEncoding,
4922        result_count_or_max_if_async: u32,
4923        storage: *mut ValRaw,
4924        storage_len: usize,
4925    ) -> Result<()> {
4926        // SAFETY: The `wasmtime_cranelift`-generated code that calls
4927        // this method will have ensured that `storage` is a valid
4928        // pointer containing at least `storage_len` items.
4929        let params = unsafe { core::slice::from_raw_parts(storage, storage_len) }.to_vec();
4930
4931        unsafe {
4932            instance.prepare_call(
4933                StoreContextMut(self),
4934                start,
4935                return_,
4936                caller_instance,
4937                callee_instance,
4938                task_return_type,
4939                callee_async,
4940                memory,
4941                string_encoding,
4942                match result_count_or_max_if_async {
4943                    PREPARE_ASYNC_NO_RESULT => CallerInfo::Async {
4944                        params,
4945                        has_result: false,
4946                    },
4947                    PREPARE_ASYNC_WITH_RESULT => CallerInfo::Async {
4948                        params,
4949                        has_result: true,
4950                    },
4951                    result_count => CallerInfo::Sync {
4952                        params,
4953                        result_count,
4954                    },
4955                },
4956            )
4957        }
4958    }
4959
4960    unsafe fn start_call(
4961        &mut self,
4962        instance: Instance,
4963        callback: *mut VMFuncRef,
4964        post_return: *mut VMFuncRef,
4965        callee: NonNull<VMFuncRef>,
4966        param_count: u32,
4967        result_count: u32,
4968        flags: u32,
4969        storage: *mut MaybeUninit<ValRaw>,
4970        storage_len: usize,
4971    ) -> Result<()> {
4972        unsafe {
4973            instance.start_call(
4974                StoreContextMut(self),
4975                callback,
4976                post_return,
4977                callee,
4978                param_count,
4979                result_count,
4980                flags,
4981                // SAFETY: The `wasmtime_cranelift`-generated code that calls
4982                // this method will have ensured that `storage` is a valid
4983                // pointer containing at least `storage_len` items.
4984                core::slice::from_raw_parts_mut(storage, storage_len),
4985            )
4986        }
4987    }
4988
4989    fn future_write(
4990        &mut self,
4991        instance: Instance,
4992        caller: RuntimeComponentInstanceIndex,
4993        ty: TypeFutureTableIndex,
4994        options: OptionsIndex,
4995        future: u32,
4996        address: u32,
4997    ) -> Result<u32> {
4998        instance
4999            .guest_write(
5000                StoreContextMut(self),
5001                caller,
5002                TransmitIndex::Future(ty),
5003                options,
5004                None,
5005                future,
5006                address,
5007                1,
5008            )
5009            .map(|result| result.encode())
5010    }
5011
5012    fn future_read(
5013        &mut self,
5014        instance: Instance,
5015        caller: RuntimeComponentInstanceIndex,
5016        ty: TypeFutureTableIndex,
5017        options: OptionsIndex,
5018        future: u32,
5019        address: u32,
5020    ) -> Result<u32> {
5021        instance
5022            .guest_read(
5023                StoreContextMut(self),
5024                caller,
5025                TransmitIndex::Future(ty),
5026                options,
5027                None,
5028                future,
5029                address,
5030                1,
5031            )
5032            .map(|result| result.encode())
5033    }
5034
5035    fn stream_write(
5036        &mut self,
5037        instance: Instance,
5038        caller: RuntimeComponentInstanceIndex,
5039        ty: TypeStreamTableIndex,
5040        options: OptionsIndex,
5041        stream: u32,
5042        address: u32,
5043        count: u32,
5044    ) -> Result<u32> {
5045        instance
5046            .guest_write(
5047                StoreContextMut(self),
5048                caller,
5049                TransmitIndex::Stream(ty),
5050                options,
5051                None,
5052                stream,
5053                address,
5054                count,
5055            )
5056            .map(|result| result.encode())
5057    }
5058
5059    fn stream_read(
5060        &mut self,
5061        instance: Instance,
5062        caller: RuntimeComponentInstanceIndex,
5063        ty: TypeStreamTableIndex,
5064        options: OptionsIndex,
5065        stream: u32,
5066        address: u32,
5067        count: u32,
5068    ) -> Result<u32> {
5069        instance
5070            .guest_read(
5071                StoreContextMut(self),
5072                caller,
5073                TransmitIndex::Stream(ty),
5074                options,
5075                None,
5076                stream,
5077                address,
5078                count,
5079            )
5080            .map(|result| result.encode())
5081    }
5082
5083    fn future_drop_writable(
5084        &mut self,
5085        instance: Instance,
5086        ty: TypeFutureTableIndex,
5087        writer: u32,
5088    ) -> Result<()> {
5089        instance.guest_drop_writable(self, TransmitIndex::Future(ty), writer)
5090    }
5091
5092    fn flat_stream_write(
5093        &mut self,
5094        instance: Instance,
5095        caller: RuntimeComponentInstanceIndex,
5096        ty: TypeStreamTableIndex,
5097        options: OptionsIndex,
5098        payload_size: u32,
5099        payload_align: u32,
5100        stream: u32,
5101        address: u32,
5102        count: u32,
5103    ) -> Result<u32> {
5104        instance
5105            .guest_write(
5106                StoreContextMut(self),
5107                caller,
5108                TransmitIndex::Stream(ty),
5109                options,
5110                Some(FlatAbi {
5111                    size: payload_size,
5112                    align: payload_align,
5113                }),
5114                stream,
5115                address,
5116                count,
5117            )
5118            .map(|result| result.encode())
5119    }
5120
5121    fn flat_stream_read(
5122        &mut self,
5123        instance: Instance,
5124        caller: RuntimeComponentInstanceIndex,
5125        ty: TypeStreamTableIndex,
5126        options: OptionsIndex,
5127        payload_size: u32,
5128        payload_align: u32,
5129        stream: u32,
5130        address: u32,
5131        count: u32,
5132    ) -> Result<u32> {
5133        instance
5134            .guest_read(
5135                StoreContextMut(self),
5136                caller,
5137                TransmitIndex::Stream(ty),
5138                options,
5139                Some(FlatAbi {
5140                    size: payload_size,
5141                    align: payload_align,
5142                }),
5143                stream,
5144                address,
5145                count,
5146            )
5147            .map(|result| result.encode())
5148    }
5149
5150    fn stream_drop_writable(
5151        &mut self,
5152        instance: Instance,
5153        ty: TypeStreamTableIndex,
5154        writer: u32,
5155    ) -> Result<()> {
5156        instance.guest_drop_writable(self, TransmitIndex::Stream(ty), writer)
5157    }
5158
5159    fn error_context_debug_message(
5160        &mut self,
5161        instance: Instance,
5162        ty: TypeComponentLocalErrorContextTableIndex,
5163        options: OptionsIndex,
5164        err_ctx_handle: u32,
5165        debug_msg_address: u32,
5166    ) -> Result<()> {
5167        instance.error_context_debug_message(
5168            StoreContextMut(self),
5169            ty,
5170            options,
5171            err_ctx_handle,
5172            debug_msg_address,
5173        )
5174    }
5175
5176    fn thread_new_indirect(
5177        &mut self,
5178        instance: Instance,
5179        caller: RuntimeComponentInstanceIndex,
5180        func_ty_idx: ModuleInternedTypeIndex,
5181        start_func_table_idx: RuntimeTableIndex,
5182        start_func_idx: u32,
5183        context: i32,
5184    ) -> Result<u32> {
5185        instance.thread_new_indirect(
5186            StoreContextMut(self),
5187            caller,
5188            func_ty_idx,
5189            start_func_table_idx,
5190            start_func_idx,
5191            context,
5192        )
5193    }
5194}
5195
5196type HostTaskFuture = Pin<Box<dyn Future<Output = Result<()>> + Send + 'static>>;
5197
5198/// Runs the given future with the current thread set to `task` each time it is
5199/// polled.
5200async fn run_with_host_task_set<F>(task: TableId<HostTask>, future: F) -> Result<F::Output>
5201where
5202    F: Future,
5203{
5204    let mut future = pin!(future);
5205    future::poll_fn(|cx| {
5206        let old_thread = match tls::get(|store| store.set_thread(task)) {
5207            Ok(thread) => thread,
5208            Err(error) => return Poll::Ready(Err(error)),
5209        };
5210        let result = future.as_mut().poll(cx);
5211        match tls::get(|store| store.set_thread(old_thread)) {
5212            Ok(_) => result.map(Ok),
5213            Err(error) => Poll::Ready(Err(error)),
5214        }
5215    })
5216    .await
5217}
5218
5219/// Represents the state of a pending host task.
5220///
5221/// This is used to represent tasks when the guest calls into the host.
5222pub(crate) struct HostTask {
5223    common: WaitableCommon,
5224
5225    /// State of borrows/etc the host needs to track. Used when the guest passes
5226    /// borrows to the host, for example.
5227    call_context: CallContext,
5228
5229    state: HostTaskState,
5230
5231    group: TaskGroupId,
5232}
5233
5234enum HostTaskState {
5235    /// A host task has been created and it's considered "started".
5236    ///
5237    /// The host task has yet to enter `first_poll` or `poll_and_block` which
5238    /// is where this will get updated further.
5239    CalleeStarted,
5240
5241    /// State used for tasks in `first_poll` meaning that the guest did an async
5242    /// lower of a host async function which is blocked. The specified handle is
5243    /// linked to the future in the main `FuturesUnordered` of a store which is
5244    /// used to cancel it if the guest requests cancellation.
5245    CalleeRunning(JoinHandle),
5246
5247    /// Cancellation was requested, but the completion worker has not finished
5248    /// lowering the result and publishing the terminal event. The task must
5249    /// remain in the table until that worker completes.
5250    CalleeCancelling,
5251
5252    /// Terminal state used for tasks in `poll_and_block` to store the result of
5253    /// their computation. Note that this state is not used for tasks in
5254    /// `first_poll`.
5255    CalleeFinished(LiftedResult),
5256
5257    /// Terminal state for host tasks meaning that the task was cancelled or the
5258    /// result was taken.
5259    CalleeDone { cancelled: bool },
5260}
5261
5262impl HostTask {
5263    fn new(
5264        concurrent_state: &mut ConcurrentState,
5265        state: HostTaskState,
5266        caller: QualifiedThreadId,
5267    ) -> Result<Self> {
5268        let group = concurrent_state.get_mut(caller.task)?.group;
5269        concurrent_state.increment_group_ref_count(group)?;
5270
5271        Ok(Self {
5272            common: WaitableCommon::default(),
5273            call_context: CallContext::default(),
5274            state,
5275            group,
5276        })
5277    }
5278}
5279
5280impl TableDebug for HostTask {
5281    fn type_name() -> &'static str {
5282        "HostTask"
5283    }
5284}
5285
5286type CallbackFn = Box<dyn Fn(&mut dyn VMStore, Event, u32) -> Result<u32> + Send + Sync + 'static>;
5287
5288/// Represents the caller of a given guest task.
5289enum Caller {
5290    /// The host called the guest task.
5291    Host {
5292        /// If present, may be used to deliver the result.
5293        tx: Option<oneshot::Sender<LiftedResult>>,
5294        /// The host task which called into the guest, or `None` for a call from
5295        /// the top-level host. The task may belong to an entirely unrelated
5296        /// top-level component instance than the one the host called into.
5297        caller: Option<TableId<HostTask>>,
5298    },
5299    /// Another guest thread called the guest task
5300    Guest {
5301        /// The id of the caller
5302        thread: QualifiedThreadId,
5303    },
5304}
5305
5306/// Represents a closure and related canonical ABI parameters required to
5307/// validate a `task.return` call at runtime and lift the result.
5308struct LiftResult {
5309    lift: RawLift,
5310    ty: TypeTupleIndex,
5311    memory: Option<SendSyncPtr<VMMemoryDefinition>>,
5312    string_encoding: StringEncoding,
5313}
5314
5315/// The table ID for a guest thread, qualified by the task to which it belongs.
5316///
5317/// This exists to minimize table lookups and the necessity to pass stores around mutably
5318/// for the common case of identifying the task to which a thread belongs.
5319#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
5320pub(crate) struct QualifiedThreadId {
5321    task: TableId<GuestTask>,
5322    thread: TableId<GuestThread>,
5323}
5324
5325impl QualifiedThreadId {
5326    fn qualify(
5327        state: &mut ConcurrentState,
5328        thread: TableId<GuestThread>,
5329    ) -> Result<QualifiedThreadId> {
5330        Ok(QualifiedThreadId {
5331            task: state.get_mut(thread)?.parent_task,
5332            thread,
5333        })
5334    }
5335}
5336
5337impl fmt::Debug for QualifiedThreadId {
5338    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
5339        f.debug_tuple("QualifiedThreadId")
5340            .field(&self.task.rep())
5341            .field(&self.thread.rep())
5342            .finish()
5343    }
5344}
5345
5346enum GuestThreadState {
5347    NotStartedImplicit,
5348    NotStartedExplicit(
5349        Box<dyn FnOnce(&mut dyn VMStore, QualifiedThreadId) -> Result<()> + Send + Sync>,
5350    ),
5351    Running,
5352    Suspended(StoreFiber<'static>),
5353    Ready {
5354        fiber: StoreFiber<'static>,
5355    },
5356    Completed,
5357}
5358
5359impl GuestThreadState {
5360    fn check_no_fiber(&self) -> Result<()> {
5361        match self {
5362            Self::Suspended(_) | Self::Ready { .. } => bail_bug!("thread already owns a fiber"),
5363            Self::NotStartedImplicit
5364            | Self::NotStartedExplicit(_)
5365            | Self::Running
5366            | Self::Completed => Ok(()),
5367        }
5368    }
5369}
5370
5371impl fmt::Debug for GuestThreadState {
5372    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
5373        match self {
5374            Self::NotStartedImplicit => f.debug_tuple("NotStartedImplicit").finish(),
5375            Self::NotStartedExplicit(_) => f.debug_tuple("NotStartedExplicit").finish(),
5376            Self::Running => f.debug_tuple("Running").finish(),
5377            Self::Suspended(_) => f.debug_tuple("Suspended").finish(),
5378            Self::Ready { .. } => f.debug_struct("Ready").finish(),
5379            Self::Completed => f.debug_tuple("Completed").finish(),
5380        }
5381    }
5382}
5383
5384#[derive(Copy, Clone, PartialEq, Eq, Debug)]
5385enum WakeOnCancel {
5386    None,
5387    Waiting(TableId<WaitableSet>),
5388    Yielding,
5389}
5390
5391impl WakeOnCancel {
5392    fn is_none(self) -> bool {
5393        matches!(self, WakeOnCancel::None)
5394    }
5395
5396    fn replace(&mut self, other: WakeOnCancel) -> Self {
5397        let old = *self;
5398        *self = other;
5399        old
5400    }
5401
5402    fn take(&mut self) -> Self {
5403        self.replace(WakeOnCancel::None)
5404    }
5405}
5406
5407pub struct GuestThread {
5408    /// Context-local state used to implement the `context.{get,set}`
5409    /// intrinsics.
5410    context: [u32; NUM_COMPONENT_CONTEXT_SLOTS],
5411    /// The owning guest task.
5412    parent_task: TableId<GuestTask>,
5413    /// If non-`None`, indicates that the thread is currently either waiting a
5414    /// waitable set or yielding but may be cancelled and woken immediately.
5415    wake_on_cancel: WakeOnCancel,
5416    /// The execution state of this guest thread
5417    state: GuestThreadState,
5418    /// The index of this thread in the component instance's handle table.
5419    /// This must always be `Some` after initialization.
5420    instance_rep: Option<u32>,
5421    /// Scratch waitable set used to watch subtasks during synchronous calls.
5422    sync_call_set: TableId<WaitableSet>,
5423    /// The old value of `do_not_suspend` prior to the sync-typed task for which
5424    /// this thread was created, if relevant.
5425    old_do_not_suspend: Option<bool>,
5426}
5427
5428impl GuestThread {
5429    /// Retrieve the `GuestThread` corresponding to the specified guest-visible
5430    /// handle.
5431    fn from_instance(
5432        state: Pin<&mut ComponentInstance>,
5433        caller_instance: RuntimeComponentInstanceIndex,
5434        guest_thread: u32,
5435    ) -> Result<TableId<Self>> {
5436        let rep = state.instance_states().0[caller_instance]
5437            .thread_handle_table()
5438            .guest_thread_rep(guest_thread)?;
5439        Ok(TableId::new(rep))
5440    }
5441
5442    fn new_implicit(state: &mut ConcurrentState, parent_task: TableId<GuestTask>) -> Result<Self> {
5443        let sync_call_set = state.push(WaitableSet {
5444            is_sync_call_set: true,
5445            ..WaitableSet::default()
5446        })?;
5447        Ok(Self {
5448            context: [0; NUM_COMPONENT_CONTEXT_SLOTS],
5449            parent_task,
5450            wake_on_cancel: WakeOnCancel::None,
5451            state: GuestThreadState::NotStartedImplicit,
5452            instance_rep: None,
5453            sync_call_set,
5454            old_do_not_suspend: None,
5455        })
5456    }
5457
5458    fn new_explicit(
5459        state: &mut ConcurrentState,
5460        parent_task: TableId<GuestTask>,
5461        start_func: Box<
5462            dyn FnOnce(&mut dyn VMStore, QualifiedThreadId) -> Result<()> + Send + Sync,
5463        >,
5464    ) -> Result<Self> {
5465        state.increment_task_ref_count(parent_task)?;
5466        let sync_call_set = state.push(WaitableSet {
5467            is_sync_call_set: true,
5468            ..WaitableSet::default()
5469        })?;
5470        Ok(Self {
5471            context: [0; NUM_COMPONENT_CONTEXT_SLOTS],
5472            parent_task,
5473            wake_on_cancel: WakeOnCancel::None,
5474            state: GuestThreadState::NotStartedExplicit(start_func),
5475            instance_rep: None,
5476            sync_call_set,
5477            old_do_not_suspend: None,
5478        })
5479    }
5480}
5481
5482impl TableDebug for GuestThread {
5483    fn type_name() -> &'static str {
5484        "GuestThread"
5485    }
5486}
5487
5488enum SyncResult {
5489    NotProduced,
5490    Produced(Option<ValRaw>),
5491    Taken,
5492}
5493
5494impl SyncResult {
5495    fn take(&mut self) -> Result<Option<Option<ValRaw>>> {
5496        Ok(match mem::replace(self, SyncResult::Taken) {
5497            SyncResult::NotProduced => None,
5498            SyncResult::Produced(val) => Some(val),
5499            SyncResult::Taken => {
5500                bail_bug!("attempted to take a synchronous result that was already taken")
5501            }
5502        })
5503    }
5504}
5505
5506/// Represents a pending guest task.
5507pub(crate) struct GuestTask {
5508    /// See `WaitableCommon`
5509    common: WaitableCommon,
5510    /// Closure to lower the parameters passed to this task.
5511    lower_params: Option<RawLower>,
5512    /// See `LiftResult`
5513    lift_result: Option<LiftResult>,
5514    /// A place to stash the type-erased lifted result if it can't be delivered
5515    /// immediately.
5516    result: Option<LiftedResult>,
5517    /// Closure to call the callback function for an async-lifted export, if
5518    /// provided.
5519    callback: Option<CallbackFn>,
5520    /// See `Caller`
5521    caller: Caller,
5522    /// Borrow state for this task.
5523    ///
5524    /// Keeps track of `borrow<T>` received to this task to ensure that
5525    /// everything is dropped by the time it exits.
5526    call_context: CallContext,
5527    /// A place to stash the lowered result for a sync-to-async call until it
5528    /// can be returned to the caller.
5529    sync_result: SyncResult,
5530    /// Whether or not the task has been cancelled (i.e. whether the
5531    /// cancellation request has been delivered to the task, and thus whether
5532    /// the task is permitted to call `task.cancel`).
5533    cancel_request_delivered: bool,
5534    /// Whether or not the caller has requested cancellation of this task via
5535    /// `subtask.cancel` while it was still unresolved. A subsequent
5536    /// `subtask.cancel` of the same task traps. This matches the spec's
5537    /// `Subtask.cancellation_requested`.
5538    cancel_requested: bool,
5539    /// Whether or not we've sent a `Status::Starting` event to any current or
5540    /// future waiters for this waitable.
5541    starting_sent: bool,
5542    /// The runtime instance to which the exported function for this guest task
5543    /// belongs.
5544    ///
5545    /// Note that the task may do a sync->sync call via a fused adapter which
5546    /// results in that task executing code in a different instance, and it may
5547    /// call host functions and intrinsics from that other instance.
5548    instance: RuntimeInstance,
5549    /// If present, a pending `Event::Cancelled` to be delivered to this task.
5550    event: Option<Event>,
5551    /// Whether or not the task has exited.
5552    exited: bool,
5553    /// Threads belonging to this task
5554    threads: HashSet<TableId<GuestThread>>,
5555    /// Indicates whether this task was created for a call to an async-typed
5556    /// export.
5557    async_typed: bool,
5558    /// Indicates whether this task was created for a call to an async-lifted
5559    /// export.
5560    async_lifted: bool,
5561    /// Whether `ConcurrentState::interesting_tasks` has been decremented for
5562    /// this task yet.
5563    decremented_interesting_task_count: bool,
5564    /// The `TaskGroup` to which this task belongs.
5565    group: TaskGroupId,
5566    /// The number of outstanding references to this task.
5567    ///
5568    /// When this goes to zero, the task will be removed from
5569    /// `ConcurrentState::table`.
5570    ref_count: usize,
5571}
5572
5573impl GuestTask {
5574    fn already_lowered_parameters(&self) -> bool {
5575        // We reset `lower_params` after we lower the parameters
5576        self.lower_params.is_none()
5577    }
5578
5579    fn returned_or_cancelled(&self) -> bool {
5580        // We reset `lift_result` after we return or exit
5581        self.lift_result.is_none()
5582    }
5583
5584    fn new(
5585        state: &mut ConcurrentState,
5586        lower_params: RawLower,
5587        lift_result: LiftResult,
5588        caller: Caller,
5589        callback: Option<CallbackFn>,
5590        instance: RuntimeInstance,
5591        async_typed: bool,
5592        async_lifted: bool,
5593    ) -> Result<QualifiedThreadId> {
5594        let group = match caller {
5595            Caller::Guest { thread } => {
5596                let group = state.get_mut(thread.task)?.group;
5597                state.increment_group_ref_count(group)?;
5598                group
5599            }
5600            Caller::Host { .. } => state.make_task_group()?,
5601        };
5602
5603        let task = state.push(Self {
5604            common: WaitableCommon::default(),
5605            lower_params: Some(lower_params),
5606            lift_result: Some(lift_result),
5607            result: None,
5608            callback,
5609            caller,
5610            call_context: CallContext::default(),
5611            sync_result: SyncResult::NotProduced,
5612            cancel_request_delivered: false,
5613            cancel_requested: false,
5614            starting_sent: false,
5615            instance,
5616            event: None,
5617            exited: false,
5618            threads: HashSet::new(),
5619            async_typed,
5620            async_lifted,
5621            decremented_interesting_task_count: false,
5622            group,
5623            // One for the caller and one for the implicit guest thread we're
5624            // about to create:
5625            ref_count: 2,
5626        })?;
5627        let new_thread = GuestThread::new_implicit(state, task)?;
5628        let thread = state.push(new_thread)?;
5629        state.get_mut(task)?.threads.insert(thread);
5630        state.interesting_tasks += 1;
5631        let thread = QualifiedThreadId { task, thread };
5632        log::trace!("new implicit thread {thread:?} for instance {instance:?}");
5633        Ok(thread)
5634    }
5635}
5636
5637impl TableDebug for GuestTask {
5638    fn type_name() -> &'static str {
5639        "GuestTask"
5640    }
5641}
5642
5643/// Represents state common to all kinds of waitables.
5644#[derive(Default)]
5645struct WaitableCommon {
5646    /// The currently pending event for this waitable, if any.
5647    event: Option<Event>,
5648    /// The set to which this waitable belongs, if any.
5649    set: Option<TableId<WaitableSet>>,
5650    /// The handle with which the guest refers to this waitable, if any.
5651    handle: Option<u32>,
5652}
5653
5654/// Represents a Component Model Async `waitable`.
5655#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
5656enum Waitable {
5657    /// A host task
5658    Host(TableId<HostTask>),
5659    /// A guest task
5660    Guest(TableId<GuestTask>),
5661    /// The read or write end of a stream or future
5662    Transmit(TableId<TransmitHandle>),
5663}
5664
5665impl Waitable {
5666    /// Retrieve the `Waitable` corresponding to the specified guest-visible
5667    /// handle.
5668    fn from_instance(
5669        state: Pin<&mut ComponentInstance>,
5670        caller_instance: RuntimeComponentInstanceIndex,
5671        waitable: u32,
5672    ) -> Result<Self> {
5673        use crate::runtime::vm::component::Waitable;
5674
5675        let (waitable, kind) = state.instance_states().0[caller_instance]
5676            .handle_table()
5677            .waitable_rep(waitable)?;
5678
5679        Ok(match kind {
5680            Waitable::Subtask { is_host: true } => Self::Host(TableId::new(waitable)),
5681            Waitable::Subtask { is_host: false } => Self::Guest(TableId::new(waitable)),
5682            Waitable::Stream | Waitable::Future => Self::Transmit(TableId::new(waitable)),
5683        })
5684    }
5685
5686    /// Retrieve the host-visible identifier for this `Waitable`.
5687    fn rep(&self) -> u32 {
5688        match self {
5689            Self::Host(id) => id.rep(),
5690            Self::Guest(id) => id.rep(),
5691            Self::Transmit(id) => id.rep(),
5692        }
5693    }
5694
5695    /// Move this `Waitable` to the specified set (when `set` is `Some(_)`) or
5696    /// remove it from any set it may currently belong to (when `set` is
5697    /// `None`).
5698    fn join(&self, state: &mut ConcurrentState, set: Option<TableId<WaitableSet>>) -> Result<()> {
5699        log::trace!("waitable {self:?} join set {set:?}");
5700
5701        let old = mem::replace(&mut self.common(state)?.set, set);
5702
5703        if let Some(old) = old {
5704            match *self {
5705                Waitable::Host(id) => state.remove_child(id, old),
5706                Waitable::Guest(id) => state.remove_child(id, old),
5707                Waitable::Transmit(id) => state.remove_child(id, old),
5708            }?;
5709
5710            state.get_mut(old)?.ready.remove(self);
5711        }
5712
5713        if let Some(set) = set {
5714            match *self {
5715                Waitable::Host(id) => state.add_child(id, set),
5716                Waitable::Guest(id) => state.add_child(id, set),
5717                Waitable::Transmit(id) => state.add_child(id, set),
5718            }?;
5719
5720            if self.common(state)?.event.is_some() {
5721                self.mark_ready(state)?;
5722            }
5723        }
5724
5725        Ok(())
5726    }
5727
5728    /// Retrieve mutable access to the `WaitableCommon` for this `Waitable`.
5729    fn common<'a>(&self, state: &'a mut ConcurrentState) -> Result<&'a mut WaitableCommon> {
5730        Ok(match self {
5731            Self::Host(id) => &mut state.get_mut(*id)?.common,
5732            Self::Guest(id) => &mut state.get_mut(*id)?.common,
5733            Self::Transmit(id) => &mut state.get_mut(*id)?.common,
5734        })
5735    }
5736
5737    /// Trap if this waitable is currently a member of a waitable set.
5738    ///
5739    /// A synchronous stream/future/subtask operation may end up blocking on
5740    /// this waitable, so it is not allowed to run while the waitable is also
5741    /// being watched by a waitable set.
5742    fn trap_if_in_waitable_set(&self, state: &mut ConcurrentState) -> Result<()> {
5743        if self.common(state)?.set.is_some() {
5744            bail!(Trap::WaitableSyncAndAsync);
5745        }
5746        Ok(())
5747    }
5748
5749    /// Trap if a thread is currently synchronously waiting on this waitable.
5750    ///
5751    /// This corresponds to the spec's `trap_if(w.has_sync_waiter)` and is
5752    /// used to prevent other threads from stealing or otherwise interfering
5753    /// with the event the sync waiter is expecting.
5754    fn trap_if_has_sync_waiter(&self, state: &mut ConcurrentState) -> Result<()> {
5755        if let Some(set) = self.common(state)?.set
5756            && state.get_mut(set)?.is_sync_call_set
5757        {
5758            bail!(Trap::WaitableSyncAndAsync);
5759        }
5760        Ok(())
5761    }
5762
5763    /// Set or clear the pending event for this waitable and either deliver it
5764    /// to the first waiter, if any, or mark it as ready to be delivered to the
5765    /// next waiter that arrives.
5766    fn set_event(&self, state: &mut ConcurrentState, event: Option<Event>) -> Result<()> {
5767        log::trace!("set event for {self:?}: {event:?}");
5768        self.common(state)?.event = event;
5769        self.mark_ready(state)
5770    }
5771
5772    /// Take the pending event from this waitable, leaving `None` in its place.
5773    fn take_event(&self, state: &mut ConcurrentState) -> Result<Option<Event>> {
5774        let common = self.common(state)?;
5775        let event = common.event.take();
5776        if let Some(set) = self.common(state)?.set {
5777            state.get_mut(set)?.ready.remove(self);
5778        }
5779
5780        Ok(event)
5781    }
5782
5783    /// Deliver the current event for this waitable to the first waiter, if any,
5784    /// or else mark it as ready to be delivered to the next waiter that
5785    /// arrives.
5786    fn mark_ready(&self, state: &mut ConcurrentState) -> Result<()> {
5787        if let Some(set) = self.common(state)?.set {
5788            state.get_mut(set)?.ready.insert(*self);
5789            state.wake_waiter(set)?;
5790        }
5791        Ok(())
5792    }
5793
5794    /// Remove this waitable from the store's rep table (or decrement the ref
5795    /// count if it's a guest task).
5796    fn delete_from(&self, state: &mut ConcurrentState) -> Result<()> {
5797        match self {
5798            Self::Host(task) => state.delete_host_task(*task),
5799            Self::Guest(task) => state.decrement_task_ref_count(*task),
5800            Self::Transmit(task) => Ok(state.delete(*task).map(drop)?),
5801        }
5802    }
5803}
5804
5805impl fmt::Debug for Waitable {
5806    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
5807        match self {
5808            Self::Host(id) => write!(f, "{id:?}"),
5809            Self::Guest(id) => write!(f, "{id:?}"),
5810            Self::Transmit(id) => write!(f, "{id:?}"),
5811        }
5812    }
5813}
5814
5815/// Represents a Component Model Async `waitable-set`.
5816#[derive(Default)]
5817struct WaitableSet {
5818    /// Which waitables in this set have pending events, if any.
5819    ready: BTreeSet<Waitable>,
5820    /// Which guest threads are currently waiting on this set, if any.
5821    waiting: BTreeMap<QualifiedThreadId, WaitMode>,
5822    /// How many guest threads are waiting on this set, mirroring the spec's
5823    /// `WaitableSet.num_waiting`.
5824    num_waiting: usize,
5825    /// Whether this set is a synthetic, internal one meant for handling
5826    /// synchronous calls.
5827    is_sync_call_set: bool,
5828}
5829
5830impl WaitableSet {
5831    /// Records that a thread counted in `num_waiting` is no longer waiting.
5832    fn stop_waiting(&mut self) -> Result<()> {
5833        self.num_waiting = match self.num_waiting.checked_sub(1) {
5834            Some(n) => n,
5835            None => bail_bug!("waiter not accounted for in waitable set"),
5836        };
5837        Ok(())
5838    }
5839}
5840
5841impl TableDebug for WaitableSet {
5842    fn type_name() -> &'static str {
5843        "WaitableSet"
5844    }
5845}
5846
5847/// Type-erased closure to lower the parameters for a guest task.
5848type RawLower =
5849    Box<dyn FnOnce(&mut dyn VMStore, &mut [MaybeUninit<ValRaw>]) -> Result<()> + Send + Sync>;
5850
5851/// Type-erased closure to lift the result for a guest task.
5852type RawLift = Box<
5853    dyn FnOnce(&mut dyn VMStore, &[ValRaw]) -> Result<Box<dyn Any + Send + Sync>> + Send + Sync,
5854>;
5855
5856/// Type erased result of a guest task which may be downcast to the expected
5857/// type by a host caller (or simply ignored in the case of a guest caller; see
5858/// `DummyResult`).
5859type LiftedResult = Box<dyn Any + Send + Sync>;
5860
5861/// Used to return a result from a `LiftFn` when the actual result has already
5862/// been lowered to a guest task's stack and linear memory.
5863struct DummyResult;
5864
5865/// Represents the Component Model Async state of a (sub-)component instance.
5866#[derive(Default)]
5867pub struct ConcurrentInstanceState {
5868    /// Whether backpressure is set for this instance (enabled if >0)
5869    backpressure: u16,
5870    /// Whether this instance can be entered
5871    do_not_enter: bool,
5872    /// Whether this instance may suspend (i.e. whether this instance is
5873    /// currently running a sync-typed function).
5874    do_not_suspend: bool,
5875    /// Pending calls for this instance which require `Self::backpressure` to be
5876    /// zero and/or `Self::do_not_enter` to be false before they can proceed.
5877    pending: BTreeMap<QualifiedThreadId, GuestCallKind>,
5878}
5879
5880impl ConcurrentInstanceState {
5881    pub fn pending_is_empty(&self) -> bool {
5882        self.pending.is_empty()
5883    }
5884}
5885
5886#[derive(Debug, Copy, Clone)]
5887pub(crate) enum CurrentThread {
5888    /// The currently running thread is a guest, identified here with its
5889    /// task/thread id combo.
5890    Guest(QualifiedThreadId),
5891    /// The currently running thread is a host task.
5892    Host(TableId<HostTask>),
5893    /// The currently running thread is a host call whose task has not yet been
5894    /// materialized. The contained ID identifies its guest caller.
5895    DeferredHost(QualifiedThreadId),
5896    /// There is no currently running thread because we are in the main event
5897    /// loop or concurrency is disabled.
5898    None,
5899}
5900
5901impl CurrentThread {
5902    fn guest(&self) -> Option<&QualifiedThreadId> {
5903        match self {
5904            Self::Guest(id) => Some(id),
5905            _ => None,
5906        }
5907    }
5908
5909    fn guest_task(&self) -> Option<TableId<GuestTask>> {
5910        match self {
5911            Self::Guest(id) => Some(id.task),
5912            _ => None,
5913        }
5914    }
5915
5916    fn is_none(&self) -> bool {
5917        matches!(self, Self::None)
5918    }
5919}
5920
5921impl From<QualifiedThreadId> for CurrentThread {
5922    fn from(id: QualifiedThreadId) -> Self {
5923        Self::Guest(id)
5924    }
5925}
5926
5927impl From<TableId<HostTask>> for CurrentThread {
5928    fn from(id: TableId<HostTask>) -> Self {
5929        Self::Host(id)
5930    }
5931}
5932
5933enum Priority {
5934    Switch,
5935    High,
5936    Low,
5937}
5938
5939/// Represents the Component Model Async state of a store.
5940pub struct ConcurrentState {
5941    /// The currently running thread, if any.
5942    ///
5943    /// Note that we lazily materialize threads on-demand and this field is not
5944    /// necessarily up-to-date. The `StoreOpaque::current_thread` method should
5945    /// be preferred over directly accessing this field.
5946    unforced_current_thread: CurrentThread,
5947
5948    /// Borrow state for the deferred host call, if any.
5949    ///
5950    /// This is `Some` if and only if [`Self::unforced_current_thread`] is
5951    /// [`CurrentThread::DeferredHost`]. Materializing the host task moves this
5952    /// context into that task.
5953    deferred_host_call_context: Option<CallContext>,
5954
5955    /// The set of pending host and background tasks, if any.
5956    ///
5957    /// See `ComponentInstance::poll_until` for where we temporarily take this
5958    /// out, poll it, then put it back to avoid any mutable aliasing hazards.
5959    futures: AlwaysMut<Option<FuturesUnordered<HostTaskFuture>>>,
5960    /// The table of waitables, waitable sets, etc.
5961    table: AlwaysMut<ResourceTable>,
5962    /// The next item to switch to if any.
5963    ///
5964    /// This takes precedence over items in the `high_priority` queue below and
5965    /// should be used in cases such as subtask calls and thread resume/promote
5966    /// operations where we must switch to a specific thread at the next turn of
5967    /// the event loop regardless of what happens to be present in the
5968    /// `high_priority` queue.
5969    switch_item: Option<WorkItem>,
5970    /// The item to set `switch_item` to when the current thread suspends.
5971    ///
5972    /// This is used when ever an async-lowered import or `subtask.cancel` is
5973    /// called in order to track the thread to switch back to once the current
5974    /// subtask suspends, if any.
5975    next_switch_item: Option<WorkItem>,
5976    /// The "high priority" work queue for this store's event loop.
5977    high_priority: VecDeque<WorkItem>,
5978    /// The "low priority" work queue for this store's event loop.
5979    low_priority: VecDeque<WorkItem>,
5980    /// A place to stash the reason a fiber is suspending so that the code which
5981    /// resumed it will know under what conditions the fiber should be resumed
5982    /// again.
5983    suspend_reason: Option<SuspendReason>,
5984    /// A cached fiber which is waiting for work to do.
5985    ///
5986    /// This helps us avoid creating a new fiber for each `GuestCall` work item.
5987    worker: Option<StoreFiber<'static>>,
5988    /// A place to stash the work item for which we're resuming a worker fiber.
5989    worker_item: Option<WorkerItem>,
5990
5991    /// Reference counts for all component error contexts
5992    ///
5993    /// NOTE: it is possible the global ref count to be *greater* than the sum of
5994    /// (sub)component ref counts as tracked by `error_context_tables`, for
5995    /// example when the host holds one or more references to error contexts.
5996    ///
5997    /// The key of this primary map is often referred to as the "rep" (i.e. host-side
5998    /// component-wide representation) of the index into concurrent state for a given
5999    /// stored `ErrorContext`.
6000    ///
6001    /// Stated another way, `TypeComponentGlobalErrorContextTableIndex` is essentially the same
6002    /// as a `TableId<ErrorContextState>`.
6003    global_error_context_ref_counts:
6004        BTreeMap<TypeComponentGlobalErrorContextTableIndex, GlobalErrorContextRefCount>,
6005
6006    /// The number of "interesting tasks" currently executing in the store.
6007    ///
6008    /// This tracks the concept of a component instance lifetime as defined in
6009    /// https://github.com/WebAssembly/component-model/pull/643. Specifically
6010    /// all tasks currently increment this counter which then gets decremented
6011    /// when they exit. In the future some tasks might not increment this
6012    /// counter, but for now all do.
6013    ///
6014    /// This is used to implement `Accessor::poll_no_interesting_tasks` to
6015    /// inform the embedder when all tasks have completed. This is then
6016    /// used in wasmtime-wasi-http, for example, to know when an instance is
6017    /// idle.
6018    interesting_tasks: usize,
6019
6020    /// Single waker to notify when `interesting_tasks` reaches 0.
6021    ///
6022    /// Used in the implementation of `Accessor::poll_no_interesting_tasks`.
6023    interesting_tasks_empty_waker: Option<Waker>,
6024
6025    /// Single waker to notify when a component instance goes from
6026    /// not-concurrently-callable to concurrently-callable.
6027    ///
6028    /// Used in the implementation of `Accessor::poll_ready_for_concurrent_call`.
6029    ready_for_concurrent_call_waker: Option<Waker>,
6030
6031    /// Whether the `StoreContextMut::poll_until` event loop is running.
6032    event_loop_running: bool,
6033
6034    /// Stack of switch items to push to and pop from when entering and exiting
6035    /// sync-to-sync calls.
6036    saved_next_switch_items: Vec<Option<WorkItem>>,
6037
6038    /// See [TaskGroupHook].
6039    #[cfg(feature = "task-group-hook")]
6040    task_group_hook: Option<Box<dyn TaskGroupHook>>,
6041}
6042
6043impl Default for ConcurrentState {
6044    fn default() -> Self {
6045        Self {
6046            unforced_current_thread: CurrentThread::None,
6047            deferred_host_call_context: None,
6048            table: AlwaysMut::new(ResourceTable::new()),
6049            futures: AlwaysMut::new(Some(FuturesUnordered::new())),
6050            switch_item: None,
6051            next_switch_item: None,
6052            high_priority: VecDeque::new(),
6053            low_priority: VecDeque::new(),
6054            suspend_reason: None,
6055            worker: None,
6056            worker_item: None,
6057            global_error_context_ref_counts: BTreeMap::new(),
6058            interesting_tasks: 0,
6059            interesting_tasks_empty_waker: None,
6060            ready_for_concurrent_call_waker: None,
6061            event_loop_running: false,
6062            saved_next_switch_items: Vec::new(),
6063            #[cfg(feature = "task-group-hook")]
6064            task_group_hook: None,
6065        }
6066    }
6067}
6068
6069impl ConcurrentState {
6070    /// Take ownership of any fibers and futures owned by this object.
6071    ///
6072    /// This should be used when disposing of the `Store` containing this object
6073    /// in order to gracefully resolve any and all fibers using
6074    /// `StoreFiber::dispose`.  This is necessary to avoid possible
6075    /// use-after-free bugs due to fibers which may still have access to the
6076    /// `Store`.
6077    ///
6078    /// Additionally, the futures collected with this function should be dropped
6079    /// within a `tls::set` call, which will ensure than any futures closing
6080    /// over an `&Accessor` will have access to the store when dropped, allowing
6081    /// e.g. `WithAccessor[AndValue]` instances to be disposed of without
6082    /// panicking.
6083    ///
6084    /// Note that this will leave the object in an inconsistent and unusable
6085    /// state, so it should only be used just prior to dropping it.
6086    pub(crate) fn take_fibers_and_futures(
6087        &mut self,
6088        fibers: &mut Vec<StoreFiber<'static>>,
6089        futures: &mut Vec<FuturesUnordered<HostTaskFuture>>,
6090    ) {
6091        let ConcurrentState {
6092            table,
6093            worker,
6094            switch_item,
6095            next_switch_item,
6096            high_priority,
6097            low_priority,
6098            saved_next_switch_items,
6099            futures: pending_futures,
6100            worker_item: _,
6101            unforced_current_thread: _,
6102            deferred_host_call_context: _,
6103            suspend_reason: _,
6104            global_error_context_ref_counts: _,
6105            interesting_tasks: _,
6106            interesting_tasks_empty_waker: _,
6107            ready_for_concurrent_call_waker: _,
6108            event_loop_running: _,
6109            #[cfg(feature = "task-group-hook")]
6110                task_group_hook: _,
6111        } = self;
6112
6113        let mut items = Vec::new();
6114        for (_, entry) in table.get_mut().iter_mut() {
6115            if let Some(set) = entry.downcast_mut::<WaitableSet>() {
6116                for mode in mem::take(&mut set.waiting).into_values() {
6117                    match mode {
6118                        WaitMode::Fiber(fiber) => {
6119                            fibers.push(fiber);
6120                        }
6121                        WaitMode::Callback(_) => {}
6122                    }
6123                }
6124            } else if let Some(thread) = entry.downcast_mut::<GuestThread>() {
6125                match mem::replace(&mut thread.state, GuestThreadState::Completed) {
6126                    GuestThreadState::Suspended(fiber) | GuestThreadState::Ready { fiber } => {
6127                        fibers.push(fiber);
6128                    }
6129                    GuestThreadState::NotStartedImplicit
6130                    | GuestThreadState::NotStartedExplicit(_)
6131                    | GuestThreadState::Running
6132                    | GuestThreadState::Completed => {}
6133                }
6134            } else if let Some(item) = entry.downcast_mut::<Option<WorkItem>>() {
6135                if let Some(item) = item.take() {
6136                    items.push(item);
6137                }
6138            }
6139        }
6140
6141        if let Some(fiber) = worker.take() {
6142            fibers.push(fiber);
6143        }
6144
6145        let mut handle_item = |item| match item {
6146            WorkItem::ResumeFiber { fiber, .. } => {
6147                fibers.push(fiber);
6148            }
6149            WorkItem::PushFuture(future) => {
6150                pending_futures
6151                    .get_mut()
6152                    .as_mut()
6153                    .unwrap()
6154                    .push(future.into_inner());
6155            }
6156            WorkItem::ResumeThread { .. }
6157            | WorkItem::GuestCall { .. }
6158            | WorkItem::WorkerFunction(_) => {}
6159        };
6160
6161        for item in items {
6162            handle_item(item);
6163        }
6164        if let Some(item) = switch_item.take() {
6165            handle_item(item);
6166        }
6167        if let Some(item) = next_switch_item.take() {
6168            handle_item(item);
6169        }
6170        for item in mem::take(high_priority) {
6171            handle_item(item);
6172        }
6173        for item in mem::take(low_priority) {
6174            handle_item(item);
6175        }
6176        for item in mem::take(saved_next_switch_items)
6177            .into_iter()
6178            .filter_map(|v| v)
6179        {
6180            handle_item(item);
6181        }
6182
6183        if let Some(them) = pending_futures.get_mut().take() {
6184            futures.push(them);
6185        }
6186    }
6187
6188    #[cfg(feature = "gc")]
6189    pub(crate) fn trace_fiber_roots(
6190        &mut self,
6191        modules: &ModuleRegistry,
6192        unwind: &dyn Unwind,
6193        gc_roots_list: &mut GcRootsList,
6194    ) {
6195        let ConcurrentState {
6196            table,
6197            worker,
6198            switch_item,
6199            next_switch_item,
6200            high_priority,
6201            low_priority,
6202            saved_next_switch_items,
6203
6204            // TODO(cm-gc): This field contains `ValRaw`s, but they are never GC
6205            // references because the component model doesn't support GC yet. We
6206            // will need to trace these somehow when it does.
6207            futures: _,
6208
6209            // These fields do not contain GC references.
6210            worker_item: _,
6211            unforced_current_thread: _,
6212            deferred_host_call_context: _,
6213            suspend_reason: _,
6214            global_error_context_ref_counts: _,
6215            interesting_tasks: _,
6216            interesting_tasks_empty_waker: _,
6217            ready_for_concurrent_call_waker: _,
6218            event_loop_running: _,
6219            #[cfg(feature = "task-group-hook")]
6220                task_group_hook: _,
6221        } = self;
6222
6223        for (_, entry) in table.get_mut().iter_mut() {
6224            if let Some(set) = entry.downcast_mut::<WaitableSet>() {
6225                for mode in set.waiting.values_mut() {
6226                    match mode {
6227                        WaitMode::Fiber(fiber) => {
6228                            fiber.trace_gc_roots(modules, unwind, gc_roots_list);
6229                        }
6230                        WaitMode::Callback(_) => {}
6231                    }
6232                }
6233            } else if let Some(thread) = entry.downcast_mut::<GuestThread>() {
6234                match &mut thread.state {
6235                    GuestThreadState::Suspended(fiber) | GuestThreadState::Ready { fiber } => {
6236                        fiber.trace_gc_roots(modules, unwind, gc_roots_list);
6237                    }
6238                    GuestThreadState::NotStartedImplicit
6239                    | GuestThreadState::NotStartedExplicit(_)
6240                    | GuestThreadState::Running
6241                    | GuestThreadState::Completed => {}
6242                }
6243            } else if let Some(Some(WorkItem::ResumeFiber { fiber, .. })) =
6244                entry.downcast_mut::<Option<WorkItem>>()
6245            {
6246                fiber.trace_gc_roots(modules, unwind, gc_roots_list);
6247            }
6248        }
6249
6250        if let Some(fiber) = worker {
6251            fiber.trace_gc_roots(modules, unwind, gc_roots_list);
6252        }
6253
6254        let mut handle_item = |item: &mut WorkItem| match item {
6255            WorkItem::ResumeFiber { fiber, .. } => {
6256                fiber.trace_gc_roots(modules, unwind, gc_roots_list);
6257            }
6258            WorkItem::PushFuture(_future) => {
6259                // TODO(cm-gc): once futures can contain GC roots, we will need
6260                // to trace them.
6261            }
6262            WorkItem::ResumeThread { .. }
6263            | WorkItem::GuestCall { .. }
6264            | WorkItem::WorkerFunction(_) => {}
6265        };
6266
6267        if let Some(item) = switch_item {
6268            handle_item(item);
6269        }
6270        if let Some(item) = next_switch_item {
6271            handle_item(item);
6272        }
6273        for item in high_priority {
6274            handle_item(item);
6275        }
6276        for item in low_priority {
6277            handle_item(item);
6278        }
6279        for item in saved_next_switch_items
6280            .iter_mut()
6281            .filter_map(|v| v.as_mut())
6282        {
6283            handle_item(item);
6284        }
6285    }
6286
6287    fn schedule_suspended_thread(
6288        &mut self,
6289        thread: QualifiedThreadId,
6290        instance: RuntimeInstance,
6291        priority: Priority,
6292    ) -> Result<()> {
6293        // Validate the destination while the source still owns the fiber.
6294        if matches!(priority, Priority::Switch) && self.switch_item.is_some() {
6295            bail_bug!("switch item already set");
6296        }
6297        let slot = &mut self.get_mut(thread.thread)?.state;
6298        if !matches!(slot, GuestThreadState::Suspended(_)) {
6299            bail!(Trap::CannotResumeThread);
6300        }
6301        let GuestThreadState::Suspended(fiber) = mem::replace(slot, GuestThreadState::Running)
6302        else {
6303            unreachable!()
6304        };
6305        let item = WorkItem::ResumeFiber {
6306            instance,
6307            thread,
6308            fiber,
6309        };
6310        match priority {
6311            Priority::Switch => self.switch_item = Some(item),
6312            Priority::High => self.push_high_priority(item),
6313            Priority::Low => self.push_low_priority(item),
6314        }
6315        Ok(())
6316    }
6317
6318    fn set_thread_running(&mut self, thread: TableId<GuestThread>) -> Result<()> {
6319        let slot = &mut self.get_mut(thread)?.state;
6320        slot.check_no_fiber()?;
6321        *slot = GuestThreadState::Running;
6322        Ok(())
6323    }
6324
6325    fn save_next_switch_item(&mut self) -> Result<TableId<Option<WorkItem>>> {
6326        // push can consume and drop its argument when the table is full.
6327        // Reserve with an empty item before taking the fiber-owning source.
6328        let saved = self.push(None::<WorkItem>)?;
6329        let slot = self.table.get_mut().get_mut(&Resource::from(saved))?;
6330        *slot = self.next_switch_item.take();
6331        Ok(saved)
6332    }
6333
6334    fn restore_next_switch_item(&mut self, saved: TableId<Option<WorkItem>>) -> Result<()> {
6335        if self.next_switch_item.is_some() {
6336            bail_bug!("next switch item already set when restoring");
6337        }
6338        self.next_switch_item = self.delete(saved)?;
6339        Ok(())
6340    }
6341
6342    fn take_callback_waiter(
6343        &mut self,
6344        set: TableId<WaitableSet>,
6345        thread: QualifiedThreadId,
6346    ) -> Result<Instance> {
6347        let waiting = &mut self.get_mut(set)?.waiting;
6348        let instance = match waiting.get(&thread) {
6349            Some(WaitMode::Callback(instance)) => *instance,
6350            other => bail_bug!("expected `Some(WaitMode::Callback(_))`; got `{other:?}`"),
6351        };
6352        waiting.remove(&thread);
6353        Ok(instance)
6354    }
6355
6356    fn push<V: Send + Sync + 'static>(
6357        &mut self,
6358        value: V,
6359    ) -> Result<TableId<V>, ResourceTableError> {
6360        self.table.get_mut().push(value).map(TableId::from)
6361    }
6362
6363    fn get_mut<V: 'static>(&mut self, id: TableId<V>) -> Result<&mut V, ResourceTableError> {
6364        self.table.get_mut().get_mut(&Resource::from(id))
6365    }
6366
6367    pub fn add_child<T: 'static, U: 'static>(
6368        &mut self,
6369        child: TableId<T>,
6370        parent: TableId<U>,
6371    ) -> Result<(), ResourceTableError> {
6372        self.table
6373            .get_mut()
6374            .add_child(Resource::from(child), Resource::from(parent))
6375    }
6376
6377    pub fn remove_child<T: 'static, U: 'static>(
6378        &mut self,
6379        child: TableId<T>,
6380        parent: TableId<U>,
6381    ) -> Result<(), ResourceTableError> {
6382        self.table
6383            .get_mut()
6384            .remove_child(Resource::from(child), Resource::from(parent))
6385    }
6386
6387    fn delete<V: 'static>(&mut self, id: TableId<V>) -> Result<V, ResourceTableError> {
6388        self.table.get_mut().delete(Resource::from(id))
6389    }
6390
6391    fn push_future(&mut self, future: HostTaskFuture) {
6392        // Note that we can't directly push to `ConcurrentState::futures` here
6393        // since this may be called from a future that's being polled inside
6394        // `Self::poll_until`, which temporarily removes the `FuturesUnordered`
6395        // so it has exclusive access while polling it.  Therefore, we push a
6396        // work item to the "high priority" queue, which will actually push to
6397        // `ConcurrentState::futures` later.
6398        self.push_high_priority(WorkItem::PushFuture(AlwaysMut::new(future)));
6399    }
6400
6401    fn set_switch_item(&mut self, item: WorkItem) -> Result<()> {
6402        if self.switch_item.is_some() {
6403            // Preserve ownership on this internal-error path. The caller
6404            // must stop scheduling after the error; teardown disposes the item.
6405            self.push_high_priority(item);
6406            bail_bug!("switch item already set");
6407        }
6408
6409        self.switch_item = Some(item);
6410        log::trace!("set switch item: {:?}", self.switch_item.as_ref().unwrap());
6411
6412        Ok(())
6413    }
6414
6415    fn take_next_switch_item(&mut self) -> Result<()> {
6416        if let Some(item) = self.next_switch_item.take() {
6417            self.set_switch_item(item)?;
6418        }
6419        Ok(())
6420    }
6421
6422    /// Wake the first thread waiting on `set`, if any, so that it may receive
6423    /// one of the set's pending events.
6424    fn wake_waiter(&mut self, set: TableId<WaitableSet>) -> Result<()> {
6425        // Finish every fallible lookup and check before taking the waiter out
6426        // of the set, so that an error leaves its fiber owned by the set.
6427        let Some((&thread, _)) = self.get_mut(set)?.waiting.first_key_value() else {
6428            return Ok(());
6429        };
6430        let wake_on_cancel = self.get_mut(thread.thread)?.wake_on_cancel;
6431        if wake_on_cancel != WakeOnCancel::None && wake_on_cancel != WakeOnCancel::Waiting(set) {
6432            bail_bug!("thread {thread:?} has unexpected wake_on_cancel value {wake_on_cancel:?}");
6433        }
6434        let instance = self.get_mut(thread.task)?.instance;
6435        self.get_mut(thread.thread)?.wake_on_cancel.take();
6436        let (_, mode) = self.get_mut(set)?.waiting.pop_first().unwrap();
6437
6438        let item = match mode {
6439            WaitMode::Fiber(fiber) => WorkItem::ResumeFiber {
6440                instance,
6441                thread,
6442                fiber,
6443            },
6444            WaitMode::Callback(callback_instance) => WorkItem::GuestCall {
6445                instance,
6446                call: GuestCall {
6447                    thread,
6448                    kind: GuestCallKind::DeliverEvent {
6449                        instance: callback_instance,
6450                        set: Some(set),
6451                    },
6452                },
6453            },
6454        };
6455        self.push_high_priority(item);
6456        Ok(())
6457    }
6458
6459    fn push_high_priority(&mut self, item: WorkItem) {
6460        self.high_priority.push_front(item);
6461        log::trace!(
6462            "push high priority: {:?}",
6463            self.high_priority.front().unwrap()
6464        );
6465    }
6466
6467    fn push_low_priority(&mut self, item: WorkItem) {
6468        self.low_priority.push_front(item);
6469        log::trace!(
6470            "push low priority: {:?}",
6471            self.low_priority.front().unwrap()
6472        );
6473    }
6474
6475    fn push_work_item(&mut self, item: WorkItem, priority: Priority) -> Result<()> {
6476        match priority {
6477            Priority::Switch => self.set_switch_item(item)?,
6478            Priority::High => self.push_high_priority(item),
6479            Priority::Low => self.push_low_priority(item),
6480        }
6481
6482        Ok(())
6483    }
6484
6485    fn promote_instance_local_thread_work_item(
6486        &mut self,
6487        current_instance: RuntimeInstance,
6488    ) -> Result<bool> {
6489        log::trace!("promote thread work items for {current_instance:?}");
6490
6491        self.promote_work_item_matching(|item: &WorkItem| {
6492            let result = match item {
6493                WorkItem::ResumeThread { instance, .. }
6494                | WorkItem::ResumeFiber { instance, .. }
6495                | WorkItem::GuestCall { instance, .. } => *instance == current_instance,
6496                _ => false,
6497            };
6498
6499            log::trace!("candidate {item:?}: {result}");
6500            result
6501        })
6502    }
6503
6504    fn promote_thread_work_item(&mut self, thread: QualifiedThreadId) -> Result<bool> {
6505        self.promote_work_item_matching(|item: &WorkItem| match item {
6506            WorkItem::ResumeThread {
6507                thread: item_thread,
6508                ..
6509            }
6510            | WorkItem::GuestCall {
6511                call:
6512                    GuestCall {
6513                        thread: item_thread,
6514                        ..
6515                    },
6516                ..
6517            } => *item_thread == thread,
6518            _ => false,
6519        })
6520    }
6521
6522    fn promote_work_item_matching<F>(&mut self, mut predicate: F) -> Result<bool>
6523    where
6524        F: FnMut(&WorkItem) -> bool,
6525    {
6526        // Scan from the back to preserve the ordering of items
6527        // are popped from the back of the `VecDeque`s by `poll_until` and
6528        // pushed to the front by `push_{high,low}_priority`.
6529
6530        // Inspect items while they are still owned by the store. A predicate
6531        // (including tracing) may panic; it must not drop an extracted queue.
6532        if self.switch_item.is_none() {
6533            if let Some(index) = self.high_priority.iter().rposition(&mut predicate) {
6534                self.switch_item = self.high_priority.remove(index);
6535            }
6536        }
6537        if self.switch_item.is_none() {
6538            if let Some(index) = self.low_priority.iter().rposition(predicate) {
6539                self.switch_item = self.low_priority.remove(index);
6540            }
6541        }
6542        Ok(self.switch_item.is_some())
6543    }
6544
6545    /// Used by `ResourceTables` to acquire the current `CallContext` for the
6546    /// specified task.
6547    pub fn call_context(&mut self, task: Scope) -> Result<&mut CallContext> {
6548        match task {
6549            Scope::HostId(task) => {
6550                let task: TableId<HostTask> = TableId::new(task);
6551                Ok(&mut self.get_mut(task)?.call_context)
6552            }
6553            Scope::Id(task) => {
6554                let task: TableId<GuestTask> = TableId::new(task);
6555                Ok(&mut self.get_mut(task)?.call_context)
6556            }
6557        }
6558    }
6559
6560    pub(crate) fn deferred_host_call_context(&mut self) -> Option<&mut CallContext> {
6561        self.deferred_host_call_context.as_mut()
6562    }
6563
6564    fn futures_mut(&mut self) -> Result<&mut FuturesUnordered<HostTaskFuture>> {
6565        match self.futures.get_mut().as_mut() {
6566            Some(f) => Ok(f),
6567            None => bail_bug!("futures field of concurrent state is currently taken"),
6568        }
6569    }
6570
6571    pub(crate) fn table(&mut self) -> &mut ResourceTable {
6572        self.table.get_mut()
6573    }
6574
6575    fn debug_assert_deferred_host_invariant(&self) {
6576        debug_assert_eq!(
6577            self.deferred_host_call_context.is_some(),
6578            matches!(self.unforced_current_thread, CurrentThread::DeferredHost(_)),
6579            "a deferred host thread and call context must exist together",
6580        );
6581    }
6582
6583    fn materialize_host_task(&mut self) -> Result<CurrentThread> {
6584        self.debug_assert_deferred_host_invariant();
6585        let caller = match self.unforced_current_thread {
6586            CurrentThread::DeferredHost(caller) => caller,
6587            thread => return Ok(thread),
6588        };
6589
6590        // Push first so allocation failure leaves the deferred state intact.
6591        let task = HostTask::new(self, HostTaskState::CalleeStarted, caller)?;
6592        let task = self.push(task)?;
6593        let call_context = self
6594            .deferred_host_call_context
6595            .take()
6596            .expect("deferred host call context should be present");
6597        self.get_mut(task)
6598            .expect("newly inserted host task should be present")
6599            .call_context = call_context;
6600        self.unforced_current_thread = CurrentThread::Host(task);
6601        self.debug_assert_deferred_host_invariant();
6602        log::trace!("new host task materialized {task:?}");
6603        Ok(CurrentThread::Host(task))
6604    }
6605
6606    fn materialize_current_host_task_id(&mut self) -> Result<Option<TableId<HostTask>>> {
6607        match self.materialize_host_task()? {
6608            CurrentThread::Host(id) => Ok(Some(id)),
6609            CurrentThread::None => Ok(None),
6610            CurrentThread::Guest(_) => {
6611                bail_bug!("tried to materialize a host task id from a guest thread")
6612            }
6613            CurrentThread::DeferredHost(_) => {
6614                bail_bug!(
6615                    "current thread is a deferred host thread which should have been materialized"
6616                )
6617            }
6618        }
6619    }
6620
6621    pub(crate) fn materialize_current_scope(&mut self) -> Result<Scope> {
6622        match self.materialize_host_task()? {
6623            CurrentThread::Host(id) => Ok(Scope::HostId(id.rep())),
6624            _ => bail_bug!("current scope is not a deferred host scope"),
6625        }
6626    }
6627
6628    fn increment_task_ref_count(&mut self, task: TableId<GuestTask>) -> Result<()> {
6629        let count = &mut self.get_mut(task)?.ref_count;
6630        *count += 1;
6631        log::trace!("increment {task:?} to {count}");
6632        Ok(())
6633    }
6634
6635    fn decrement_task_ref_count(&mut self, task: TableId<GuestTask>) -> Result<()> {
6636        let count = &mut self.get_mut(task)?.ref_count;
6637        if *count == 0 {
6638            bail_bug!("can't decrement task ref count that's already zero");
6639        }
6640        *count -= 1;
6641        log::trace!("decrement {task:?} to {count}");
6642        if *count == 0 {
6643            let task = self.delete(task)?;
6644
6645            self.decrement_group_ref_count(task.group)?;
6646
6647            // When a guest task is created it increments the
6648            // `ConcurrentState::interesting_tasks` counter, and that needs
6649            // to be paired with a decrement. There are a few situations in
6650            // which the decrement needs to happen which don't all funnel
6651            // through here, so in lieu of that at least try to catch issues
6652            // where we forgot to do a decrement.
6653            debug_assert!(task.decremented_interesting_task_count);
6654        }
6655        Ok(())
6656    }
6657
6658    fn delete_host_task(&mut self, task: TableId<HostTask>) -> Result<()> {
6659        log::trace!("delete host task {task:?}");
6660        let task = self.delete(task)?;
6661
6662        self.decrement_group_ref_count(task.group)
6663    }
6664}
6665
6666/// Provide a type hint to compiler about the shape of a parameter lower
6667/// closure.
6668fn for_any_lower<
6669    F: FnOnce(&mut dyn VMStore, &mut [MaybeUninit<ValRaw>]) -> Result<()> + Send + Sync,
6670>(
6671    fun: F,
6672) -> F {
6673    fun
6674}
6675
6676/// Provide a type hint to compiler about the shape of a result lift closure.
6677fn for_any_lift<
6678    F: FnOnce(&mut dyn VMStore, &[ValRaw]) -> Result<Box<dyn Any + Send + Sync>> + Send + Sync,
6679>(
6680    fun: F,
6681) -> F {
6682    fun
6683}
6684
6685fn check_ambient_store(id: StoreId) {
6686    let message = "\
6687        `Future`s which depend on asynchronous component tasks, streams, or \
6688        futures to complete may only be polled from the event loop of the \
6689        store to which they belong.  Please use \
6690        `StoreContextMut::{run_concurrent,spawn}` to poll or await them.\
6691    ";
6692    tls::try_get(|store| {
6693        let matched = match store {
6694            tls::TryGet::Some(store) => store.id() == id,
6695            tls::TryGet::Taken | tls::TryGet::None => false,
6696        };
6697
6698        if !matched {
6699            panic!("{message}")
6700        }
6701    });
6702}
6703
6704fn unpack_callback_code(code: u32) -> (u32, u32) {
6705    (code & 0xF, code >> 4)
6706}
6707
6708/// Helper struct for packaging parameters to be passed to
6709/// `ComponentInstance::waitable_check` for calls to `waitable-set.wait` or
6710/// `waitable-set.poll`.
6711struct WaitableCheckParams {
6712    set: TableId<WaitableSet>,
6713    options: OptionsIndex,
6714    payload: u32,
6715}
6716
6717/// Indicates whether `ComponentInstance::waitable_check` is being called for
6718/// `waitable-set.wait` or `waitable-set.poll`.
6719enum WaitableCheck {
6720    Wait,
6721    Poll,
6722}
6723
6724/// Represents a guest task called from the host, prepared using `prepare_call`.
6725pub(crate) struct PreparedCall<R> {
6726    /// The guest export to be called
6727    handle: Func,
6728    /// The guest thread created by `prepare_call`
6729    thread: QualifiedThreadId,
6730    /// The number of lowered core Wasm parameters to pass to the call.
6731    param_count: usize,
6732    /// The `oneshot::Receiver` to which the result of the call will be
6733    /// delivered when it is available.
6734    rx: oneshot::Receiver<LiftedResult>,
6735    _phantom: PhantomData<R>,
6736}
6737
6738impl<R> PreparedCall<R> {
6739    /// Acquire a reference to the `TaskId` for this `PreparedCall`.
6740    ///
6741    /// Note that this increments the reference count for the task, and
6742    /// `TaskId::host_future_dropped` decrements it.  Hence,
6743    /// `TaskId::host_future_dropped` _must_ be called before the `TaskId` is
6744    /// dropped to avoid leaking the task.
6745    pub(crate) fn acquire_task_id(&self, store: &mut StoreOpaque) -> Result<TaskId> {
6746        store
6747            .concurrent_state_mut()?
6748            .increment_task_ref_count(self.thread.task)?;
6749
6750        Ok(TaskId {
6751            task: self.thread.task,
6752        })
6753    }
6754}
6755
6756/// Represents a task created by `prepare_call`.
6757pub(crate) struct TaskId {
6758    task: TableId<GuestTask>,
6759}
6760
6761impl TaskId {
6762    /// The host future for an async task was dropped.
6763    ///
6764    /// If the parameters have not been lowered yet, it is no longer valid to
6765    /// do so, as the lowering closure would see a dangling pointer. In this
6766    /// case the closure is replaced with one that fails, so the call fails if
6767    /// it's ever started. This can't fail, since the task can't be deleted
6768    /// while its host future is live.
6769    ///
6770    /// Otherwise, there may be running threads, or ones that are suspended and
6771    /// can be resumed by other tasks for this component, so we mark the future
6772    /// as dropped and delete the task when all threads are done.
6773    pub(crate) fn host_future_dropped(&self, store: &mut StoreOpaque) -> Result<()> {
6774        let task = store.concurrent_state_mut()?.get_mut(self.task)?;
6775        if !task.already_lowered_parameters() {
6776            // TODO: avoid leaking the task and trapping in this case, e.g. by
6777            // allowing the replacement callback to return a value that tells
6778            // the event loop "nevermind, the host gave up on this call; just
6779            // skip it, clean up the task, and carry on with other work".
6780            task.lower_params = Some(Box::new(|store, _| {
6781                store.set_trapped();
6782                bail!("the host future for this call was dropped before it started")
6783            }));
6784        } else {
6785            // TODO: we're temporarily ignoring any error here to avoid a
6786            // panic-on-unwrap in `call_async_concurrent`.  Instead, we should
6787            // determine a safe way to defer the decrement (and any error it
6788            // might produce) outside of a `drop` call.
6789            _ = store
6790                .concurrent_state_mut()?
6791                .decrement_task_ref_count(self.task);
6792        }
6793
6794        Ok(())
6795    }
6796}
6797
6798/// Prepare a call to the specified exported Wasm function, providing functions
6799/// for lowering the parameters and lifting the result.
6800///
6801/// To enqueue the returned `PreparedCall` in the `ComponentInstance`'s event
6802/// loop, use `stage_call`.
6803pub(crate) fn prepare_call<T, R>(
6804    mut store: StoreContextMut<T>,
6805    handle: Func,
6806    param_count: usize,
6807    lower_params: impl FnOnce(StoreContextMut<T>, &mut [MaybeUninit<ValRaw>]) -> Result<()>
6808    + Send
6809    + Sync
6810    + 'static,
6811    lift_result: impl FnOnce(&mut StoreOpaque, &[ValRaw]) -> Result<Box<dyn Any + Send + Sync>>
6812    + Send
6813    + Sync
6814    + 'static,
6815) -> Result<PreparedCall<R>> {
6816    if !store.0.may_enter() {
6817        bail!(Trap::CannotEnterComponent);
6818    }
6819
6820    let (options, _flags, ty, raw_options) = handle.abi_info(store.0);
6821
6822    let instance = handle.instance().id().get(store.0);
6823    let options = &instance.component().env_component().options[options];
6824    let ty = &instance.component().types()[ty];
6825    let async_typed = ty.async_;
6826    let async_lifted = raw_options.async_;
6827    let task_return_type = ty.results;
6828    let component_instance = raw_options.instance;
6829    let callback = options.callback.map(|i| instance.runtime_callback(i));
6830    let memory = options
6831        .memory()
6832        .map(|i| instance.runtime_memory(i))
6833        .map(SendSyncPtr::new);
6834    let string_encoding = options.string_encoding;
6835    let token = StoreToken::new(store.as_context_mut());
6836    let caller = store.0.materialize_host_task_id()?;
6837    let state = store.0.concurrent_state_mut()?;
6838
6839    let (tx, rx) = oneshot::channel();
6840
6841    let instance = handle.instance().runtime_instance(component_instance);
6842    let thread = GuestTask::new(
6843        state,
6844        Box::new(for_any_lower(move |store, params| {
6845            lower_params(token.as_context_mut(store), params)
6846        })),
6847        LiftResult {
6848            lift: Box::new(for_any_lift(move |store, result| {
6849                lift_result(store, result)
6850            })),
6851            ty: task_return_type,
6852            memory,
6853            string_encoding,
6854        },
6855        Caller::Host {
6856            tx: Some(tx),
6857            caller,
6858        },
6859        callback.map(|callback| {
6860            let callback = SendSyncPtr::new(callback);
6861            let instance = handle.instance();
6862            Box::new(move |store: &mut dyn VMStore, event, handle| {
6863                let store = token.as_context_mut(store);
6864                // SAFETY: Per the contract of `prepare_call`, the callback
6865                // will remain valid at least as long is this task exists.
6866                unsafe { instance.call_callback(store, callback, event, handle) }
6867            }) as CallbackFn
6868        }),
6869        instance,
6870        async_typed,
6871        async_lifted,
6872    )?;
6873
6874    Ok(PreparedCall {
6875        handle,
6876        thread,
6877        param_count,
6878        rx,
6879        _phantom: PhantomData,
6880    })
6881}
6882
6883pub(crate) struct StagedCall<R> {
6884    store: StoreId,
6885    rx: oneshot::Receiver<LiftedResult>,
6886    _marker: PhantomData<fn() -> R>,
6887    /// The task group to which the underlying task belongs.
6888    ///
6889    /// Note that this must be treated as opaque and not used to look up the
6890    /// corresponding `TaskGroup` since we decrement the task refcount in
6891    /// `StagedCall::new` which may cause the group to be disposed.  This field
6892    /// is only present to enable `[Typed]FuncCallConcurrent::group`, allowing
6893    /// the embedder to correlate the task group with `TaskGroupHook` events.
6894    group: TaskGroupId,
6895}
6896
6897impl<R> StagedCall<R> {
6898    /// Queue a call previously prepared using `prepare_call` to be run as part of
6899    /// the associated `ComponentInstance`'s event loop.
6900    ///
6901    /// Note that this has the side-effect of disposing the specified
6902    /// `PrepareCall` and decrementing the task reference count since
6903    /// `StagedCall` has no further need to access the task directly.
6904    ///
6905    /// The returned future will resolve to the result once it is available, but
6906    /// must only be polled via the instance's event loop. See
6907    /// `StoreContextMut::run_concurrent` for details.
6908    pub(crate) fn new<T: 'static>(
6909        mut store: StoreContextMut<T>,
6910        prepared: PreparedCall<R>,
6911    ) -> Result<StagedCall<R>> {
6912        let PreparedCall {
6913            handle,
6914            thread,
6915            param_count,
6916            rx,
6917            ..
6918        } = prepared;
6919
6920        stage_call0(store.as_context_mut(), handle, thread, param_count)?;
6921
6922        let state = store.0.concurrent_state_mut()?;
6923        let group = state.get_mut(thread.task)?.group;
6924        state.decrement_task_ref_count(thread.task)?;
6925
6926        Ok(StagedCall {
6927            store: store.0.id(),
6928            rx,
6929            _marker: PhantomData,
6930            group,
6931        })
6932    }
6933}
6934
6935impl<R> Future for StagedCall<R>
6936where
6937    R: 'static,
6938{
6939    type Output = Result<R>;
6940
6941    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
6942        check_ambient_store(self.store);
6943        Pin::new(&mut self.rx).poll(cx).map(|result| match result {
6944            Ok(r) => match r.downcast() {
6945                Ok(r) => Ok(*r),
6946                Err(_) => bail_bug!("wrong type of value produced"),
6947            },
6948            Err(oneshot::Canceled) => bail_bug!("channel erroneously dropped"),
6949        })
6950    }
6951}
6952
6953/// Queue a call previously prepared using `prepare_call` to be run as part of
6954/// the associated `ComponentInstance`'s event loop.
6955fn stage_call0<T: 'static>(
6956    store: StoreContextMut<T>,
6957    handle: Func,
6958    guest_thread: QualifiedThreadId,
6959    param_count: usize,
6960) -> Result<()> {
6961    let (_options, _, _ty, raw_options) = handle.abi_info(store.0);
6962    let is_concurrent = raw_options.async_;
6963    let callback = raw_options.callback;
6964    let instance = handle.instance();
6965    let callee = handle.lifted_core_func(store.0);
6966    let post_return = raw_options
6967        .post_return
6968        .map(|i| instance.id().get(store.0).runtime_post_return(i));
6969    let callback = callback.map(|i| {
6970        let instance = instance.id().get(store.0);
6971        SendSyncPtr::new(instance.runtime_callback(i))
6972    });
6973
6974    log::trace!("queueing call {guest_thread:?}");
6975
6976    // SAFETY: `callee`, `callback`, and `post_return` are valid pointers
6977    // (with signatures appropriate for this call) and will remain valid as
6978    // long as this instance is valid.
6979    unsafe {
6980        instance.stage_call(
6981            store,
6982            guest_thread,
6983            SendSyncPtr::new(callee),
6984            param_count,
6985            1,
6986            is_concurrent,
6987            callback,
6988            post_return.map(SendSyncPtr::new),
6989            true,
6990        )
6991    }
6992}
6993
6994#[cfg(all(test, feature = "cranelift", feature = "wat"))]
6995mod tests {
6996    use super::*;
6997    use crate::component::{Component, Linker};
6998    use crate::store::AsStoreOpaque;
6999    use crate::{Config, Engine};
7000
7001    fn host_subtask(
7002        state: HostTaskState,
7003        event: Option<Event>,
7004    ) -> Result<(Store<()>, Instance, TableId<HostTask>, u32)> {
7005        let mut config = Config::new();
7006        config.wasm_component_model_async(true);
7007        let engine = Engine::new(&config)?;
7008        let component = Component::new(&engine, "(component)")?;
7009        let mut store = Store::new(&engine, ());
7010        let instance = Linker::new(&engine).instantiate(&mut store, &component)?;
7011        let store_opaque = store.as_store_opaque();
7012        let concurrent_state = store_opaque.concurrent_state_mut()?;
7013        // These tests create an isolated host task without a guest caller, so
7014        // give it its own task group instead of inheriting the caller's group.
7015        let group = concurrent_state.make_task_group()?;
7016        let task = concurrent_state.push(HostTask {
7017            common: WaitableCommon::default(),
7018            call_context: CallContext::default(),
7019            state,
7020            group,
7021        })?;
7022        let (state, counter) = store_opaque.instance_state_and_handle_counter(
7023            instance.runtime_instance(RuntimeComponentInstanceIndex::from_u32(0)),
7024        );
7025        let handle = state
7026            .handle_table()
7027            .subtask_insert_host(counter, task.rep())?;
7028        let common = &mut store_opaque.concurrent_state_mut()?.get_mut(task)?.common;
7029        common.handle = Some(handle);
7030        common.event = event;
7031        Ok((store, instance, task, handle))
7032    }
7033
7034    #[test]
7035    fn host_subtask_drop_during_cancellation() -> Result<()> {
7036        for abort_completed in [false, true] {
7037            let (handle, future) = JoinHandle::run(future::pending::<()>());
7038            let mut future = pin!(future);
7039            let (mut store, instance, task, handle) =
7040                host_subtask(HostTaskState::CalleeRunning(handle), None)?;
7041            let store = store.as_store_opaque();
7042            let caller = RuntimeComponentInstanceIndex::from_u32(0);
7043            assert_eq!(
7044                instance.subtask_cancel(store, caller, true, handle)?,
7045                BLOCKED
7046            );
7047            if abort_completed {
7048                // Even after the abort resolves, the completion worker still
7049                // needs the task entry to lower the result and publish an event.
7050                assert!(matches!(
7051                    future
7052                        .as_mut()
7053                        .poll(&mut Context::from_waker(Waker::noop())),
7054                    Poll::Ready(None),
7055                ));
7056            }
7057            for async_ in [false, true] {
7058                let err = instance
7059                    .subtask_cancel(store, caller, async_, handle)
7060                    .unwrap_err();
7061                assert_eq!(err.downcast::<Trap>()?, Trap::SubtaskCancelAfterTerminal);
7062            }
7063            let err = instance.subtask_drop(store, caller, handle).unwrap_err();
7064            assert_eq!(err.downcast::<Trap>()?, Trap::SubtaskDropNotResolved);
7065            assert!(store.concurrent_state_mut()?.get_mut(task).is_ok());
7066        }
7067        Ok(())
7068    }
7069
7070    #[test]
7071    fn host_subtask_cancel_after_completion() -> Result<()> {
7072        for async_ in [false, true] {
7073            let (mut store, instance, task, handle) = host_subtask(
7074                HostTaskState::CalleeDone { cancelled: false },
7075                Some(Event::Subtask {
7076                    status: Status::Returned,
7077                }),
7078            )?;
7079            let store = store.as_store_opaque();
7080            let caller = RuntimeComponentInstanceIndex::from_u32(0);
7081            assert_eq!(
7082                instance.subtask_cancel(store, caller, async_, handle)?,
7083                Status::Returned as u32,
7084            );
7085            let err = instance
7086                .subtask_cancel(store, caller, async_, handle)
7087                .unwrap_err();
7088            assert_eq!(err.downcast::<Trap>()?, Trap::SubtaskCancelAfterTerminal);
7089            instance.subtask_drop(store, caller, handle)?;
7090            assert!(store.concurrent_state_mut()?.get_mut(task).is_err());
7091        }
7092        Ok(())
7093    }
7094
7095    #[test]
7096    fn host_subtask_drop_requires_terminal_event_delivery() -> Result<()> {
7097        for (cancelled, status) in [
7098            (false, Status::Returned),
7099            (true, Status::Returned),
7100            (true, Status::ReturnCancelled),
7101        ] {
7102            for delivered in [false, true] {
7103                let event = if delivered {
7104                    None
7105                } else {
7106                    Some(Event::Subtask { status })
7107                };
7108                let (mut store, instance, task, handle) =
7109                    host_subtask(HostTaskState::CalleeDone { cancelled }, event)?;
7110                let store = store.as_store_opaque();
7111                let result = instance.subtask_drop(
7112                    store,
7113                    RuntimeComponentInstanceIndex::from_u32(0),
7114                    handle,
7115                );
7116                if delivered {
7117                    result?;
7118                    assert!(store.concurrent_state_mut()?.get_mut(task).is_err());
7119                } else {
7120                    let err = result.unwrap_err();
7121                    assert_eq!(err.downcast::<Trap>()?, Trap::SubtaskDropNotResolved);
7122                    assert!(store.concurrent_state_mut()?.get_mut(task).is_ok());
7123                }
7124            }
7125        }
7126        Ok(())
7127    }
7128}