1use crate::bail_bug;
54use crate::component::func::{self, Func, call_post_return};
55use crate::component::{
56 HasData, HasSelf, Instance, Resource, ResourceTable, ResourceTableError, RuntimeInstance,
57};
58use crate::fiber::{self, StoreFiber, StoreFiberYield};
59use crate::prelude::*;
60use crate::store::{Store, StoreId, StoreInner, StoreOpaque, StoreToken};
61use crate::vm::component::{CallContext, ComponentInstance, InstanceState};
62use crate::vm::{AlwaysMut, SendSyncPtr, VMFuncRef, VMMemoryDefinition, VMStore};
63use crate::{
64 AsContext, AsContextMut, FuncType, Result, StoreContext, StoreContextMut, ValRaw, ValType, bail,
65};
66use error_contexts::GlobalErrorContextRefCount;
67use futures::channel::oneshot;
68use futures::future::{self, FutureExt};
69use futures::stream::{FuturesUnordered, StreamExt};
70use futures_and_streams::{FlatAbi, ReturnCode, TransmitHandle, TransmitIndex};
71use std::any::Any;
72use std::borrow::ToOwned;
73use std::boxed::Box;
74use std::cell::UnsafeCell;
75use std::collections::{BTreeMap, BTreeSet, HashSet, VecDeque};
76use std::fmt;
77use std::future::Future;
78use std::marker::PhantomData;
79use std::mem::{self, ManuallyDrop, MaybeUninit};
80use std::ops::DerefMut;
81use std::pin::{Pin, pin};
82use std::ptr::{self, NonNull};
83use std::task::{Context, Poll, Waker};
84use std::vec::Vec;
85use table::{TableDebug, TableId};
86use wasmtime_environ::Trap;
87use wasmtime_environ::component::{
88 CanonicalAbiInfo, CanonicalOptions, CanonicalOptionsDataModel, MAX_FLAT_PARAMS,
89 MAX_FLAT_RESULTS, OptionsIndex, PREPARE_ASYNC_NO_RESULT, PREPARE_ASYNC_WITH_RESULT,
90 RuntimeComponentInstanceIndex, RuntimeTableIndex, StringEncoding,
91 TypeComponentGlobalErrorContextTableIndex, TypeComponentLocalErrorContextTableIndex,
92 TypeFuncIndex, TypeFutureTableIndex, TypeStreamTableIndex, TypeTupleIndex,
93};
94use wasmtime_environ::packed_option::ReservedValue;
95
96pub use abort::JoinHandle;
97pub use future_stream_any::{FutureAny, StreamAny};
98pub use futures_and_streams::{
99 Destination, DirectDestination, DirectSource, ErrorContext, FutureConsumer, FutureProducer,
100 FutureReader, GuardedFutureReader, GuardedStreamReader, ReadBuffer, Source, StreamConsumer,
101 StreamProducer, StreamReader, StreamResult, VecBuffer, WriteBuffer,
102};
103pub(crate) use futures_and_streams::{ResourcePair, lower_error_context_to_index};
104
105mod abort;
106mod error_contexts;
107mod future_stream_any;
108mod futures_and_streams;
109pub(crate) mod table;
110pub(crate) mod tls;
111
112const BLOCKED: u32 = 0xffff_ffff;
115
116#[derive(Clone, Copy, Eq, PartialEq, Debug)]
118pub enum Status {
119 Starting = 0,
120 Started = 1,
121 Returned = 2,
122 StartCancelled = 3,
123 ReturnCancelled = 4,
124}
125
126impl Status {
127 pub fn pack(self, waitable: Option<u32>) -> u32 {
133 assert!(matches!(self, Status::Returned) == waitable.is_none());
134 let waitable = waitable.unwrap_or(0);
135 assert!(waitable < (1 << 28));
136 (waitable << 4) | (self as u32)
137 }
138}
139
140#[derive(Clone, Copy, Debug)]
143enum Event {
144 None,
145 Cancelled,
146 Subtask {
147 status: Status,
148 },
149 StreamRead {
150 code: ReturnCode,
151 pending: Option<(TypeStreamTableIndex, u32)>,
152 },
153 StreamWrite {
154 code: ReturnCode,
155 pending: Option<(TypeStreamTableIndex, u32)>,
156 },
157 FutureRead {
158 code: ReturnCode,
159 pending: Option<(TypeFutureTableIndex, u32)>,
160 },
161 FutureWrite {
162 code: ReturnCode,
163 pending: Option<(TypeFutureTableIndex, u32)>,
164 },
165}
166
167impl Event {
168 fn parts(self) -> (u32, u32) {
173 const EVENT_NONE: u32 = 0;
174 const EVENT_SUBTASK: u32 = 1;
175 const EVENT_STREAM_READ: u32 = 2;
176 const EVENT_STREAM_WRITE: u32 = 3;
177 const EVENT_FUTURE_READ: u32 = 4;
178 const EVENT_FUTURE_WRITE: u32 = 5;
179 const EVENT_CANCELLED: u32 = 6;
180 match self {
181 Event::None => (EVENT_NONE, 0),
182 Event::Cancelled => (EVENT_CANCELLED, 0),
183 Event::Subtask { status } => (EVENT_SUBTASK, status as u32),
184 Event::StreamRead { code, .. } => (EVENT_STREAM_READ, code.encode()),
185 Event::StreamWrite { code, .. } => (EVENT_STREAM_WRITE, code.encode()),
186 Event::FutureRead { code, .. } => (EVENT_FUTURE_READ, code.encode()),
187 Event::FutureWrite { code, .. } => (EVENT_FUTURE_WRITE, code.encode()),
188 }
189 }
190}
191
192mod callback_code {
194 pub const EXIT: u32 = 0;
195 pub const YIELD: u32 = 1;
196 pub const WAIT: u32 = 2;
197}
198
199const START_FLAG_ASYNC_CALLEE: u32 = wasmtime_environ::component::START_FLAG_ASYNC_CALLEE as u32;
203
204pub struct Access<'a, T: 'static, D: HasData + ?Sized = HasSelf<T>> {
210 store: StoreContextMut<'a, T>,
211 get_data: fn(&mut T) -> D::Data<'_>,
212}
213
214impl<'a, T, D> Access<'a, T, D>
215where
216 D: HasData + ?Sized,
217 T: 'static,
218{
219 pub fn new(store: StoreContextMut<'a, T>, get_data: fn(&mut T) -> D::Data<'_>) -> Self {
221 Self { store, get_data }
222 }
223
224 pub fn data_mut(&mut self) -> &mut T {
226 self.store.data_mut()
227 }
228
229 pub fn get(&mut self) -> D::Data<'_> {
231 (self.get_data)(self.data_mut())
232 }
233
234 pub fn spawn(&mut self, task: impl AccessorTask<T, D>) -> JoinHandle
238 where
239 T: 'static,
240 {
241 let accessor = Accessor {
242 get_data: self.get_data,
243 token: StoreToken::new(self.store.as_context_mut()),
244 };
245 self.store
246 .as_context_mut()
247 .spawn_with_accessor(accessor, task)
248 }
249
250 pub fn getter(&self) -> fn(&mut T) -> D::Data<'_> {
253 self.get_data
254 }
255}
256
257impl<'a, T, D> AsContext for Access<'a, T, D>
258where
259 D: HasData + ?Sized,
260 T: 'static,
261{
262 type Data = T;
263
264 fn as_context(&self) -> StoreContext<'_, T> {
265 self.store.as_context()
266 }
267}
268
269impl<'a, T, D> AsContextMut for Access<'a, T, D>
270where
271 D: HasData + ?Sized,
272 T: 'static,
273{
274 fn as_context_mut(&mut self) -> StoreContextMut<'_, T> {
275 self.store.as_context_mut()
276 }
277}
278
279pub struct Accessor<T: 'static, D = HasSelf<T>>
339where
340 D: HasData + ?Sized,
341{
342 token: StoreToken<T>,
343 get_data: fn(&mut T) -> D::Data<'_>,
344}
345
346pub trait AsAccessor {
363 type Data: 'static;
365
366 type AccessorData: HasData + ?Sized;
369
370 fn as_accessor(&self) -> &Accessor<Self::Data, Self::AccessorData>;
372}
373
374impl<T: AsAccessor + ?Sized> AsAccessor for &T {
375 type Data = T::Data;
376 type AccessorData = T::AccessorData;
377
378 fn as_accessor(&self) -> &Accessor<Self::Data, Self::AccessorData> {
379 T::as_accessor(self)
380 }
381}
382
383impl<T, D: HasData + ?Sized> AsAccessor for Accessor<T, D> {
384 type Data = T;
385 type AccessorData = D;
386
387 fn as_accessor(&self) -> &Accessor<T, D> {
388 self
389 }
390}
391
392const _: () = {
415 const fn assert<T: Send + Sync>() {}
416 assert::<Accessor<UnsafeCell<u32>>>();
417};
418
419impl<T> Accessor<T> {
420 pub(crate) fn new(token: StoreToken<T>) -> Self {
429 Self {
430 token,
431 get_data: |x| x,
432 }
433 }
434}
435
436impl<T, D> Accessor<T, D>
437where
438 D: HasData + ?Sized,
439{
440 pub fn with<R>(&self, fun: impl FnOnce(Access<'_, T, D>) -> R) -> R {
458 tls::get(|vmstore| {
459 fun(Access {
460 store: self.token.as_context_mut(vmstore),
461 get_data: self.get_data,
462 })
463 })
464 }
465
466 pub fn getter(&self) -> fn(&mut T) -> D::Data<'_> {
469 self.get_data
470 }
471
472 pub fn with_getter<D2: HasData>(
489 &self,
490 get_data: fn(&mut T) -> D2::Data<'_>,
491 ) -> Accessor<T, D2> {
492 Accessor {
493 token: self.token,
494 get_data,
495 }
496 }
497
498 pub fn spawn(&self, task: impl AccessorTask<T, D>) -> JoinHandle
514 where
515 T: 'static,
516 {
517 let accessor = self.clone_for_spawn();
518 self.with(|mut access| access.as_context_mut().spawn_with_accessor(accessor, task))
519 }
520
521 fn clone_for_spawn(&self) -> Self {
522 Self {
523 token: self.token,
524 get_data: self.get_data,
525 }
526 }
527}
528
529pub trait AccessorTask<T, D = HasSelf<T>>: Send + 'static
541where
542 D: HasData + ?Sized,
543{
544 fn run(self, accessor: &Accessor<T, D>) -> impl Future<Output = Result<()>> + Send;
546}
547
548enum CallerInfo {
551 Async {
553 params: Vec<ValRaw>,
554 has_result: bool,
555 },
556 Sync {
558 params: Vec<ValRaw>,
559 result_count: u32,
560 },
561}
562
563enum WaitMode {
565 Fiber(StoreFiber<'static>),
567 Callback(Instance),
570}
571
572#[derive(Debug)]
574enum SuspendReason {
575 Waiting {
578 set: TableId<WaitableSet>,
579 thread: QualifiedThreadId,
580 skip_may_block_check: bool,
581 },
582 NeedWork,
585 Yielding {
588 thread: QualifiedThreadId,
589 skip_may_block_check: bool,
590 },
591 ExplicitlySuspending {
593 thread: QualifiedThreadId,
594 skip_may_block_check: bool,
595 },
596}
597
598enum GuestCallKind {
600 DeliverEvent {
603 instance: Instance,
605 set: Option<TableId<WaitableSet>>,
610 },
611 StartImplicit(Box<dyn FnOnce(&mut dyn VMStore) -> Result<Option<GuestCall>> + Send + Sync>),
617 StartExplicit(Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send + Sync>),
618}
619
620impl fmt::Debug for GuestCallKind {
621 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
622 match self {
623 Self::DeliverEvent { instance, set } => f
624 .debug_struct("DeliverEvent")
625 .field("instance", instance)
626 .field("set", set)
627 .finish(),
628 Self::StartImplicit(_) => f.debug_tuple("StartImplicit").finish(),
629 Self::StartExplicit(_) => f.debug_tuple("StartExplicit").finish(),
630 }
631 }
632}
633
634#[derive(Copy, Clone, Debug)]
636pub enum SuspensionTarget {
637 SomeSuspended(u32),
638 Some(u32),
639 None,
640}
641
642impl SuspensionTarget {
643 fn is_none(&self) -> bool {
644 matches!(self, SuspensionTarget::None)
645 }
646 fn is_some(&self) -> bool {
647 !self.is_none()
648 }
649}
650
651#[derive(Debug)]
653struct GuestCall {
654 thread: QualifiedThreadId,
655 kind: GuestCallKind,
656}
657
658impl GuestCall {
659 fn is_ready(&self, store: &mut StoreOpaque) -> Result<bool> {
669 let instance = store
670 .concurrent_state_mut()
671 .get_mut(self.thread.task)?
672 .instance;
673 let state = store.instance_state(instance).concurrent_state();
674
675 let ready = match &self.kind {
676 GuestCallKind::DeliverEvent { .. } => !state.do_not_enter,
677 GuestCallKind::StartImplicit(_) => !(state.do_not_enter || state.backpressure > 0),
678 GuestCallKind::StartExplicit(_) => true,
679 };
680 log::trace!(
681 "call {self:?} ready? {ready} (do_not_enter: {}; backpressure: {})",
682 state.do_not_enter,
683 state.backpressure
684 );
685 Ok(ready)
686 }
687}
688
689enum WorkerItem {
691 GuestCall(GuestCall),
692 Function(AlwaysMut<Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send>>),
693}
694
695enum WorkItem {
698 PushFuture(AlwaysMut<HostTaskFuture>),
700 ResumeFiber(StoreFiber<'static>),
702 ResumeThread(RuntimeComponentInstanceIndex, QualifiedThreadId),
704 GuestCall(RuntimeComponentInstanceIndex, GuestCall),
706 WorkerFunction(AlwaysMut<Box<dyn FnOnce(&mut dyn VMStore) -> Result<()> + Send>>),
708}
709
710impl fmt::Debug for WorkItem {
711 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
712 match self {
713 Self::PushFuture(_) => f.debug_tuple("PushFuture").finish(),
714 Self::ResumeFiber(_) => f.debug_tuple("ResumeFiber").finish(),
715 Self::ResumeThread(instance, thread) => f
716 .debug_tuple("ResumeThread")
717 .field(instance)
718 .field(thread)
719 .finish(),
720 Self::GuestCall(instance, call) => f
721 .debug_tuple("GuestCall")
722 .field(instance)
723 .field(call)
724 .finish(),
725 Self::WorkerFunction(_) => f.debug_tuple("WorkerFunction").finish(),
726 }
727 }
728}
729
730#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
732pub(crate) enum WaitResult {
733 Cancelled,
734 Completed,
735}
736
737pub(crate) fn poll_and_block<R: Send + Sync + 'static>(
745 store: &mut dyn VMStore,
746 future: impl Future<Output = Result<R>> + Send + 'static,
747) -> Result<R> {
748 let state = store.concurrent_state_mut();
749 let task = state.current_host_thread()?;
750
751 let mut future = Box::pin(async move {
755 let result = future.await?;
756 tls::get(move |store| {
757 let state = store.concurrent_state_mut();
758 let host_state = &mut state.get_mut(task)?.state;
759 assert!(matches!(host_state, HostTaskState::CalleeStarted));
760 *host_state = HostTaskState::CalleeFinished(Box::new(result));
761
762 Waitable::Host(task).set_event(
763 state,
764 Some(Event::Subtask {
765 status: Status::Returned,
766 }),
767 )?;
768
769 Ok(())
770 })
771 }) as HostTaskFuture;
772
773 let poll = tls::set(store, || {
777 future
778 .as_mut()
779 .poll(&mut Context::from_waker(&Waker::noop()))
780 });
781
782 match poll {
783 Poll::Ready(result) => result?,
785
786 Poll::Pending => {
791 let state = store.concurrent_state_mut();
792 state.push_future(future);
793
794 let caller = state.get_mut(task)?.caller;
795 let set = state.get_mut(caller.thread)?.sync_call_set;
796 Waitable::Host(task).join(state, Some(set))?;
797
798 store.suspend(SuspendReason::Waiting {
799 set,
800 thread: caller,
801 skip_may_block_check: false,
802 })?;
803
804 Waitable::Host(task).join(store.concurrent_state_mut(), None)?;
808 }
809 }
810
811 let host_state = &mut store.concurrent_state_mut().get_mut(task)?.state;
813 match mem::replace(host_state, HostTaskState::CalleeDone) {
814 HostTaskState::CalleeFinished(result) => Ok(match result.downcast() {
815 Ok(result) => *result,
816 Err(_) => bail_bug!("host task finished with wrong type of result"),
817 }),
818 _ => bail_bug!("unexpected host task state after completion"),
819 }
820}
821
822fn handle_guest_call(store: &mut dyn VMStore, call: GuestCall) -> Result<()> {
824 let mut next = Some(call);
825 while let Some(call) = next.take() {
826 match call.kind {
827 GuestCallKind::DeliverEvent { instance, set } => {
828 let (event, waitable) =
829 match instance.get_event(store, call.thread.task, set, true)? {
830 Some(pair) => pair,
831 None => bail_bug!("delivering non-present event"),
832 };
833 let state = store.concurrent_state_mut();
834 let task = state.get_mut(call.thread.task)?;
835 let runtime_instance = task.instance;
836 let handle = waitable.map(|(_, v)| v).unwrap_or(0);
837
838 log::trace!(
839 "use callback to deliver event {event:?} to {:?} for {waitable:?}",
840 call.thread,
841 );
842
843 let old_thread = store.set_thread(call.thread)?;
844 log::trace!(
845 "GuestCallKind::DeliverEvent: replaced {old_thread:?} with {:?} as current thread",
846 call.thread
847 );
848
849 store.enter_instance(runtime_instance);
850
851 let Some(callback) = store
852 .concurrent_state_mut()
853 .get_mut(call.thread.task)?
854 .callback
855 .take()
856 else {
857 bail_bug!("guest task callback field not present")
858 };
859
860 let code = callback(store, event, handle)?;
861
862 store
863 .concurrent_state_mut()
864 .get_mut(call.thread.task)?
865 .callback = Some(callback);
866
867 store.exit_instance(runtime_instance)?;
868
869 store.set_thread(old_thread)?;
870
871 next = instance.handle_callback_code(
872 store,
873 call.thread,
874 runtime_instance.index,
875 code,
876 )?;
877
878 log::trace!(
879 "GuestCallKind::DeliverEvent: restored {old_thread:?} as current thread"
880 );
881 }
882 GuestCallKind::StartImplicit(fun) => {
883 next = fun(store)?;
884 }
885 GuestCallKind::StartExplicit(fun) => {
886 fun(store)?;
887 }
888 }
889 }
890
891 Ok(())
892}
893
894impl<T> Store<T> {
895 pub async fn run_concurrent<R>(&mut self, fun: impl AsyncFnOnce(&Accessor<T>) -> R) -> Result<R>
897 where
898 T: Send + 'static,
899 {
900 ensure!(
901 self.as_context().0.concurrency_support(),
902 "cannot use `run_concurrent` when Config::concurrency_support disabled",
903 );
904 self.as_context_mut().run_concurrent(fun).await
905 }
906
907 #[doc(hidden)]
908 pub fn assert_concurrent_state_empty(&mut self) {
909 self.as_context_mut().assert_concurrent_state_empty();
910 }
911
912 #[doc(hidden)]
913 pub fn concurrent_state_table_size(&mut self) -> usize {
914 self.as_context_mut().concurrent_state_table_size()
915 }
916
917 pub fn spawn(&mut self, task: impl AccessorTask<T, HasSelf<T>>) -> JoinHandle
919 where
920 T: 'static,
921 {
922 self.as_context_mut().spawn(task)
923 }
924}
925
926impl<T> StoreContextMut<'_, T> {
927 #[doc(hidden)]
938 pub fn assert_concurrent_state_empty(self) {
939 let store = self.0;
940 store
941 .store_data_mut()
942 .components
943 .assert_instance_states_empty();
944 let state = store.concurrent_state_mut();
945 assert!(
946 state.table.get_mut().is_empty(),
947 "non-empty table: {:?}",
948 state.table.get_mut()
949 );
950 assert!(state.high_priority.is_empty());
951 assert!(state.low_priority.is_empty());
952 assert!(state.current_thread.is_none());
953 assert!(state.futures_mut().unwrap().is_empty());
954 assert!(state.global_error_context_ref_counts.is_empty());
955 }
956
957 #[doc(hidden)]
962 pub fn concurrent_state_table_size(&mut self) -> usize {
963 self.0
964 .concurrent_state_mut()
965 .table
966 .get_mut()
967 .iter_mut()
968 .count()
969 }
970
971 pub fn spawn(mut self, task: impl AccessorTask<T>) -> JoinHandle
981 where
982 T: 'static,
983 {
984 let accessor = Accessor::new(StoreToken::new(self.as_context_mut()));
985 self.spawn_with_accessor(accessor, task)
986 }
987
988 fn spawn_with_accessor<D>(
991 self,
992 accessor: Accessor<T, D>,
993 task: impl AccessorTask<T, D>,
994 ) -> JoinHandle
995 where
996 T: 'static,
997 D: HasData + ?Sized,
998 {
999 let (handle, future) = JoinHandle::run(async move { task.run(&accessor).await });
1003 self.0
1004 .concurrent_state_mut()
1005 .push_future(Box::pin(async move { future.await.unwrap_or(Ok(())) }));
1006 handle
1007 }
1008
1009 pub async fn run_concurrent<R>(self, fun: impl AsyncFnOnce(&Accessor<T>) -> R) -> Result<R>
1093 where
1094 T: Send + 'static,
1095 {
1096 ensure!(
1097 self.0.concurrency_support(),
1098 "cannot use `run_concurrent` when Config::concurrency_support disabled",
1099 );
1100 self.do_run_concurrent(fun, false).await
1101 }
1102
1103 pub(super) async fn run_concurrent_trap_on_idle<R>(
1104 self,
1105 fun: impl AsyncFnOnce(&Accessor<T>) -> R,
1106 ) -> Result<R>
1107 where
1108 T: Send + 'static,
1109 {
1110 self.do_run_concurrent(fun, true).await
1111 }
1112
1113 async fn do_run_concurrent<R>(
1114 mut self,
1115 fun: impl AsyncFnOnce(&Accessor<T>) -> R,
1116 trap_on_idle: bool,
1117 ) -> Result<R>
1118 where
1119 T: Send + 'static,
1120 {
1121 debug_assert!(self.0.concurrency_support());
1122 check_recursive_run();
1123 let token = StoreToken::new(self.as_context_mut());
1124
1125 struct Dropper<'a, T: 'static, V> {
1126 store: StoreContextMut<'a, T>,
1127 value: ManuallyDrop<V>,
1128 }
1129
1130 impl<'a, T, V> Drop for Dropper<'a, T, V> {
1131 fn drop(&mut self) {
1132 tls::set(self.store.0, || {
1133 unsafe { ManuallyDrop::drop(&mut self.value) }
1138 });
1139 }
1140 }
1141
1142 let accessor = &Accessor::new(token);
1143 let dropper = &mut Dropper {
1144 store: self,
1145 value: ManuallyDrop::new(fun(accessor)),
1146 };
1147 let future = unsafe { Pin::new_unchecked(dropper.value.deref_mut()) };
1149
1150 dropper
1151 .store
1152 .as_context_mut()
1153 .poll_until(future, trap_on_idle)
1154 .await
1155 }
1156
1157 async fn poll_until<R>(
1163 mut self,
1164 mut future: Pin<&mut impl Future<Output = R>>,
1165 trap_on_idle: bool,
1166 ) -> Result<R>
1167 where
1168 T: Send + 'static,
1169 {
1170 struct Reset<'a, T: 'static> {
1171 store: StoreContextMut<'a, T>,
1172 futures: Option<FuturesUnordered<HostTaskFuture>>,
1173 }
1174
1175 impl<'a, T> Drop for Reset<'a, T> {
1176 fn drop(&mut self) {
1177 if let Some(futures) = self.futures.take() {
1178 *self.store.0.concurrent_state_mut().futures.get_mut() = Some(futures);
1179 }
1180 }
1181 }
1182
1183 loop {
1184 let futures = self.0.concurrent_state_mut().futures.get_mut().take();
1188 let mut reset = Reset {
1189 store: self.as_context_mut(),
1190 futures,
1191 };
1192 let mut next = match reset.futures.as_mut() {
1193 Some(f) => pin!(f.next()),
1194 None => bail_bug!("concurrent state missing futures field"),
1195 };
1196
1197 enum PollResult<R> {
1198 Complete(R),
1199 ProcessWork(Vec<WorkItem>),
1200 }
1201 let result = future::poll_fn(|cx| {
1202 if let Poll::Ready(value) = tls::set(reset.store.0, || future.as_mut().poll(cx)) {
1205 return Poll::Ready(Ok(PollResult::Complete(value)));
1206 }
1207
1208 let next = match tls::set(reset.store.0, || next.as_mut().poll(cx)) {
1212 Poll::Ready(Some(output)) => {
1213 match output {
1214 Err(e) => return Poll::Ready(Err(e)),
1215 Ok(()) => {}
1216 }
1217 Poll::Ready(true)
1218 }
1219 Poll::Ready(None) => Poll::Ready(false),
1220 Poll::Pending => Poll::Pending,
1221 };
1222
1223 let state = reset.store.0.concurrent_state_mut();
1227 let ready = state.collect_work_items_to_run();
1228 if !ready.is_empty() {
1229 return Poll::Ready(Ok(PollResult::ProcessWork(ready)));
1230 }
1231
1232 return match next {
1236 Poll::Ready(true) => {
1237 Poll::Ready(Ok(PollResult::ProcessWork(Vec::new())))
1243 }
1244 Poll::Ready(false) => {
1245 if let Poll::Ready(value) =
1249 tls::set(reset.store.0, || future.as_mut().poll(cx))
1250 {
1251 Poll::Ready(Ok(PollResult::Complete(value)))
1252 } else {
1253 if trap_on_idle {
1259 Poll::Ready(Err(Trap::AsyncDeadlock.into()))
1262 } else {
1263 Poll::Pending
1267 }
1268 }
1269 }
1270 Poll::Pending => Poll::Pending,
1275 };
1276 })
1277 .await;
1278
1279 drop(reset);
1283
1284 match result? {
1285 PollResult::Complete(value) => break Ok(value),
1288 PollResult::ProcessWork(ready) => {
1291 struct Dispose<'a, T: 'static, I: Iterator<Item = WorkItem>> {
1292 store: StoreContextMut<'a, T>,
1293 ready: I,
1294 }
1295
1296 impl<'a, T, I: Iterator<Item = WorkItem>> Drop for Dispose<'a, T, I> {
1297 fn drop(&mut self) {
1298 while let Some(item) = self.ready.next() {
1299 match item {
1300 WorkItem::ResumeFiber(mut fiber) => fiber.dispose(self.store.0),
1301 WorkItem::PushFuture(future) => {
1302 tls::set(self.store.0, move || drop(future))
1303 }
1304 _ => {}
1305 }
1306 }
1307 }
1308 }
1309
1310 let mut dispose = Dispose {
1311 store: self.as_context_mut(),
1312 ready: ready.into_iter(),
1313 };
1314
1315 while let Some(item) = dispose.ready.next() {
1316 dispose
1317 .store
1318 .as_context_mut()
1319 .handle_work_item(item)
1320 .await?;
1321 }
1322 }
1323 }
1324 }
1325 }
1326
1327 async fn handle_work_item(self, item: WorkItem) -> Result<()>
1329 where
1330 T: Send,
1331 {
1332 log::trace!("handle work item {item:?}");
1333 match item {
1334 WorkItem::PushFuture(future) => {
1335 self.0
1336 .concurrent_state_mut()
1337 .futures_mut()?
1338 .push(future.into_inner());
1339 }
1340 WorkItem::ResumeFiber(fiber) => {
1341 self.0.resume_fiber(fiber).await?;
1342 }
1343 WorkItem::ResumeThread(_, thread) => {
1344 if let GuestThreadState::Ready(fiber) = mem::replace(
1345 &mut self.0.concurrent_state_mut().get_mut(thread.thread)?.state,
1346 GuestThreadState::Running,
1347 ) {
1348 self.0.resume_fiber(fiber).await?;
1349 } else {
1350 bail_bug!("cannot resume non-pending thread {thread:?}");
1351 }
1352 }
1353 WorkItem::GuestCall(_, call) => {
1354 if call.is_ready(self.0)? {
1355 self.run_on_worker(WorkerItem::GuestCall(call)).await?;
1356 } else {
1357 let state = self.0.concurrent_state_mut();
1358 let task = state.get_mut(call.thread.task)?;
1359 if !task.starting_sent {
1360 task.starting_sent = true;
1361 if let GuestCallKind::StartImplicit(_) = &call.kind {
1362 Waitable::Guest(call.thread.task).set_event(
1363 state,
1364 Some(Event::Subtask {
1365 status: Status::Starting,
1366 }),
1367 )?;
1368 }
1369 }
1370
1371 let instance = state.get_mut(call.thread.task)?.instance;
1372 self.0
1373 .instance_state(instance)
1374 .concurrent_state()
1375 .pending
1376 .insert(call.thread, call.kind);
1377 }
1378 }
1379 WorkItem::WorkerFunction(fun) => {
1380 self.run_on_worker(WorkerItem::Function(fun)).await?;
1381 }
1382 }
1383
1384 Ok(())
1385 }
1386
1387 async fn run_on_worker(self, item: WorkerItem) -> Result<()>
1389 where
1390 T: Send,
1391 {
1392 let worker = if let Some(fiber) = self.0.concurrent_state_mut().worker.take() {
1393 fiber
1394 } else {
1395 fiber::make_fiber(self.0, move |store| {
1396 loop {
1397 let Some(item) = store.concurrent_state_mut().worker_item.take() else {
1398 bail_bug!("worker_item not present when resuming fiber")
1399 };
1400 match item {
1401 WorkerItem::GuestCall(call) => handle_guest_call(store, call)?,
1402 WorkerItem::Function(fun) => fun.into_inner()(store)?,
1403 }
1404
1405 store.suspend(SuspendReason::NeedWork)?;
1406 }
1407 })?
1408 };
1409
1410 let worker_item = &mut self.0.concurrent_state_mut().worker_item;
1411 assert!(worker_item.is_none());
1412 *worker_item = Some(item);
1413
1414 self.0.resume_fiber(worker).await
1415 }
1416
1417 pub(crate) fn wrap_call<F, R>(self, closure: F) -> impl Future<Output = Result<R>> + 'static
1422 where
1423 T: 'static,
1424 F: FnOnce(&Accessor<T>) -> Pin<Box<dyn Future<Output = Result<R>> + Send + '_>>
1425 + Send
1426 + Sync
1427 + 'static,
1428 R: Send + Sync + 'static,
1429 {
1430 let token = StoreToken::new(self);
1431 async move {
1432 let mut accessor = Accessor::new(token);
1433 closure(&mut accessor).await
1434 }
1435 }
1436}
1437
1438impl StoreOpaque {
1439 pub(crate) fn enter_guest_sync_call(
1446 &mut self,
1447 guest_caller: Option<RuntimeInstance>,
1448 callee_async: bool,
1449 callee: RuntimeInstance,
1450 ) -> Result<()> {
1451 log::trace!("enter sync call {callee:?}");
1452 if !self.concurrency_support() {
1453 return Ok(self.enter_call_not_concurrent());
1454 }
1455
1456 let state = self.concurrent_state_mut();
1457 let thread = state.current_thread;
1458 let instance = if let Some(thread) = thread.guest() {
1459 Some(state.get_mut(thread.task)?.instance)
1460 } else {
1461 None
1462 };
1463 if guest_caller.is_some() {
1464 debug_assert_eq!(instance, guest_caller);
1465 }
1466 let task = GuestTask::new(
1467 Box::new(move |_, _| bail_bug!("cannot lower params in sync call")),
1468 LiftResult {
1469 lift: Box::new(move |_, _| bail_bug!("cannot lift result in sync call")),
1470 ty: TypeTupleIndex::reserved_value(),
1471 memory: None,
1472 string_encoding: StringEncoding::Utf8,
1473 },
1474 if let Some(thread) = thread.guest() {
1475 Caller::Guest { thread: *thread }
1476 } else {
1477 Caller::Host {
1478 tx: None,
1479 host_future_present: false,
1480 caller: thread,
1481 }
1482 },
1483 None,
1484 callee,
1485 callee_async,
1486 )?;
1487
1488 let guest_task = state.push(task)?;
1489 let new_thread = GuestThread::new_implicit(state, guest_task)?;
1490 let guest_thread = state.push(new_thread)?;
1491 Instance::from_wasmtime(self, callee.instance).add_guest_thread_to_instance_table(
1492 guest_thread,
1493 self,
1494 callee.index,
1495 )?;
1496
1497 let state = self.concurrent_state_mut();
1498 state.get_mut(guest_task)?.threads.insert(guest_thread);
1499
1500 self.set_thread(QualifiedThreadId {
1501 task: guest_task,
1502 thread: guest_thread,
1503 })?;
1504
1505 Ok(())
1506 }
1507
1508 pub(crate) fn exit_guest_sync_call(&mut self) -> Result<()> {
1510 if !self.concurrency_support() {
1511 return Ok(self.exit_call_not_concurrent());
1512 }
1513 let thread = match self.set_thread(CurrentThread::None)?.guest() {
1514 Some(t) => *t,
1515 None => bail_bug!("expected task when exiting"),
1516 };
1517 let instance = self.concurrent_state_mut().get_mut(thread.task)?.instance;
1518 log::trace!("exit sync call {instance:?}");
1519 Instance::from_wasmtime(self, instance.instance).cleanup_thread(
1520 self,
1521 thread,
1522 instance.index,
1523 )?;
1524
1525 let state = self.concurrent_state_mut();
1526 let task = state.get_mut(thread.task)?;
1527 let caller = match &task.caller {
1528 &Caller::Guest { thread } => thread.into(),
1529 &Caller::Host { caller, .. } => caller,
1530 };
1531 self.set_thread(caller)?;
1532
1533 let state = self.concurrent_state_mut();
1534 let task = state.get_mut(thread.task)?;
1535 if task.ready_to_delete() {
1536 state.delete(thread.task)?.dispose(state)?;
1537 }
1538
1539 Ok(())
1540 }
1541
1542 pub(crate) fn host_task_create(&mut self) -> Result<Option<TableId<HostTask>>> {
1550 if !self.concurrency_support() {
1551 self.enter_call_not_concurrent();
1552 return Ok(None);
1553 }
1554 let state = self.concurrent_state_mut();
1555 let caller = state.current_guest_thread()?;
1556 let task = state.push(HostTask::new(caller, HostTaskState::CalleeStarted))?;
1557 log::trace!("new host task {task:?}");
1558 self.set_thread(task)?;
1559 Ok(Some(task))
1560 }
1561
1562 pub fn host_task_reenter_caller(&mut self) -> Result<()> {
1568 if !self.concurrency_support() {
1569 return Ok(());
1570 }
1571 let task = self.concurrent_state_mut().current_host_thread()?;
1572 let caller = self.concurrent_state_mut().get_mut(task)?.caller;
1573 self.set_thread(caller)?;
1574 Ok(())
1575 }
1576
1577 pub(crate) fn host_task_delete(&mut self, task: Option<TableId<HostTask>>) -> Result<()> {
1584 match task {
1585 Some(task) => {
1586 log::trace!("delete host task {task:?}");
1587 self.concurrent_state_mut().delete(task)?;
1588 }
1589 None => {
1590 self.exit_call_not_concurrent();
1591 }
1592 }
1593 Ok(())
1594 }
1595
1596 pub(crate) fn may_enter(&mut self, instance: RuntimeInstance) -> Result<bool> {
1604 if self.trapped() {
1605 return Ok(false);
1606 }
1607 if !self.concurrency_support() {
1608 return Ok(true);
1609 }
1610 let state = self.concurrent_state_mut();
1611 let mut cur = state.current_thread;
1612 loop {
1613 match cur {
1614 CurrentThread::None => break Ok(true),
1615 CurrentThread::Guest(thread) => {
1616 let task = state.get_mut(thread.task)?;
1617
1618 if task.instance.instance == instance.instance {
1625 break Ok(false);
1626 }
1627 cur = match task.caller {
1628 Caller::Host { caller, .. } => caller,
1629 Caller::Guest { thread } => thread.into(),
1630 };
1631 }
1632 CurrentThread::Host(id) => {
1633 cur = state.get_mut(id)?.caller.into();
1634 }
1635 }
1636 }
1637 }
1638
1639 fn instance_state(&mut self, instance: RuntimeInstance) -> &mut InstanceState {
1642 self.component_instance_mut(instance.instance)
1643 .instance_state(instance.index)
1644 }
1645
1646 fn set_thread(&mut self, thread: impl Into<CurrentThread>) -> Result<CurrentThread> {
1647 let state = self.concurrent_state_mut();
1652 let old_thread = mem::replace(&mut state.current_thread, thread.into());
1653 if let Some(old_thread) = old_thread.guest() {
1654 let instance = state.get_mut(old_thread.task)?.instance.instance;
1655 self.component_instance_mut(instance)
1656 .set_task_may_block(false)
1657 }
1658
1659 if self.concurrent_state_mut().current_thread.guest().is_some() {
1662 self.set_task_may_block()?;
1663 }
1664
1665 Ok(old_thread)
1666 }
1667
1668 fn set_task_may_block(&mut self) -> Result<()> {
1671 let state = self.concurrent_state_mut();
1672 let guest_thread = state.current_guest_thread()?;
1673 let instance = state.get_mut(guest_thread.task)?.instance.instance;
1674 let may_block = self.concurrent_state_mut().may_block(guest_thread.task)?;
1675 self.component_instance_mut(instance)
1676 .set_task_may_block(may_block);
1677 Ok(())
1678 }
1679
1680 pub(crate) fn check_blocking(&mut self) -> Result<()> {
1681 if !self.concurrency_support() {
1682 return Ok(());
1683 }
1684 let state = self.concurrent_state_mut();
1685 let task = state.current_guest_thread()?.task;
1686 let instance = state.get_mut(task)?.instance.instance;
1687 let task_may_block = self.component_instance(instance).get_task_may_block();
1688
1689 if task_may_block {
1690 Ok(())
1691 } else {
1692 Err(Trap::CannotBlockSyncTask.into())
1693 }
1694 }
1695
1696 fn enter_instance(&mut self, instance: RuntimeInstance) {
1700 log::trace!("enter {instance:?}");
1701 self.instance_state(instance)
1702 .concurrent_state()
1703 .do_not_enter = true;
1704 }
1705
1706 fn exit_instance(&mut self, instance: RuntimeInstance) -> Result<()> {
1710 log::trace!("exit {instance:?}");
1711 self.instance_state(instance)
1712 .concurrent_state()
1713 .do_not_enter = false;
1714 self.partition_pending(instance)
1715 }
1716
1717 fn partition_pending(&mut self, instance: RuntimeInstance) -> Result<()> {
1722 for (thread, kind) in
1723 mem::take(&mut self.instance_state(instance).concurrent_state().pending).into_iter()
1724 {
1725 let call = GuestCall { thread, kind };
1726 if call.is_ready(self)? {
1727 self.concurrent_state_mut()
1728 .push_high_priority(WorkItem::GuestCall(instance.index, call));
1729 } else {
1730 self.instance_state(instance)
1731 .concurrent_state()
1732 .pending
1733 .insert(call.thread, call.kind);
1734 }
1735 }
1736
1737 Ok(())
1738 }
1739
1740 pub(crate) fn backpressure_modify(
1742 &mut self,
1743 caller_instance: RuntimeInstance,
1744 modify: impl FnOnce(u16) -> Option<u16>,
1745 ) -> Result<()> {
1746 let state = self.instance_state(caller_instance).concurrent_state();
1747 let old = state.backpressure;
1748 let new = modify(old).ok_or_else(|| Trap::BackpressureOverflow)?;
1749 state.backpressure = new;
1750
1751 if old > 0 && new == 0 {
1752 self.partition_pending(caller_instance)?;
1755 }
1756
1757 Ok(())
1758 }
1759
1760 async fn resume_fiber(&mut self, fiber: StoreFiber<'static>) -> Result<()> {
1763 let old_thread = self.concurrent_state_mut().current_thread;
1764 log::trace!("resume_fiber: save current thread {old_thread:?}");
1765
1766 let fiber = fiber::resolve_or_release(self, fiber).await?;
1767
1768 self.set_thread(old_thread)?;
1769
1770 let state = self.concurrent_state_mut();
1771
1772 if let Some(ot) = old_thread.guest() {
1773 state.get_mut(ot.thread)?.state = GuestThreadState::Running;
1774 }
1775 log::trace!("resume_fiber: restore current thread {old_thread:?}");
1776
1777 if let Some(mut fiber) = fiber {
1778 log::trace!("resume_fiber: suspend reason {:?}", &state.suspend_reason);
1779 let reason = match state.suspend_reason.take() {
1781 Some(r) => r,
1782 None => bail_bug!("suspend reason missing when resuming fiber"),
1783 };
1784 match reason {
1785 SuspendReason::NeedWork => {
1786 if state.worker.is_none() {
1787 state.worker = Some(fiber);
1788 } else {
1789 fiber.dispose(self);
1790 }
1791 }
1792 SuspendReason::Yielding { thread, .. } => {
1793 state.get_mut(thread.thread)?.state = GuestThreadState::Ready(fiber);
1794 let instance = state.get_mut(thread.task)?.instance.index;
1795 state.push_low_priority(WorkItem::ResumeThread(instance, thread));
1796 }
1797 SuspendReason::ExplicitlySuspending { thread, .. } => {
1798 state.get_mut(thread.thread)?.state = GuestThreadState::Suspended(fiber);
1799 }
1800 SuspendReason::Waiting { set, thread, .. } => {
1801 let old = state
1802 .get_mut(set)?
1803 .waiting
1804 .insert(thread, WaitMode::Fiber(fiber));
1805 assert!(old.is_none());
1806 }
1807 };
1808 } else {
1809 log::trace!("resume_fiber: fiber has exited");
1810 }
1811
1812 Ok(())
1813 }
1814
1815 fn suspend(&mut self, reason: SuspendReason) -> Result<()> {
1821 log::trace!("suspend fiber: {reason:?}");
1822
1823 let task = match &reason {
1827 SuspendReason::Yielding { thread, .. }
1828 | SuspendReason::Waiting { thread, .. }
1829 | SuspendReason::ExplicitlySuspending { thread, .. } => Some(thread.task),
1830 SuspendReason::NeedWork => None,
1831 };
1832
1833 let old_guest_thread = if task.is_some() {
1834 self.concurrent_state_mut().current_thread
1835 } else {
1836 CurrentThread::None
1837 };
1838
1839 debug_assert!(
1845 matches!(
1846 reason,
1847 SuspendReason::ExplicitlySuspending {
1848 skip_may_block_check: true,
1849 ..
1850 } | SuspendReason::Waiting {
1851 skip_may_block_check: true,
1852 ..
1853 } | SuspendReason::Yielding {
1854 skip_may_block_check: true,
1855 ..
1856 }
1857 ) || old_guest_thread
1858 .guest()
1859 .map(|thread| self.concurrent_state_mut().may_block(thread.task))
1860 .transpose()?
1861 .unwrap_or(true)
1862 );
1863
1864 let suspend_reason = &mut self.concurrent_state_mut().suspend_reason;
1865 assert!(suspend_reason.is_none());
1866 *suspend_reason = Some(reason);
1867
1868 self.with_blocking(|_, cx| cx.suspend(StoreFiberYield::ReleaseStore))?;
1869
1870 if task.is_some() {
1871 self.set_thread(old_guest_thread)?;
1872 }
1873
1874 Ok(())
1875 }
1876
1877 fn wait_for_event(&mut self, waitable: Waitable) -> Result<()> {
1878 let state = self.concurrent_state_mut();
1879 let caller = state.current_guest_thread()?;
1880 let old_set = waitable.common(state)?.set;
1881 let set = state.get_mut(caller.thread)?.sync_call_set;
1882 waitable.join(state, Some(set))?;
1883 self.suspend(SuspendReason::Waiting {
1884 set,
1885 thread: caller,
1886 skip_may_block_check: false,
1887 })?;
1888 let state = self.concurrent_state_mut();
1889 waitable.join(state, old_set)
1890 }
1891}
1892
1893impl Instance {
1894 fn get_event(
1897 self,
1898 store: &mut StoreOpaque,
1899 guest_task: TableId<GuestTask>,
1900 set: Option<TableId<WaitableSet>>,
1901 cancellable: bool,
1902 ) -> Result<Option<(Event, Option<(Waitable, u32)>)>> {
1903 let state = store.concurrent_state_mut();
1904
1905 let event = &mut state.get_mut(guest_task)?.event;
1906 if let Some(ev) = event
1907 && (cancellable || !matches!(ev, Event::Cancelled))
1908 {
1909 log::trace!("deliver event {ev:?} to {guest_task:?}");
1910 let ev = *ev;
1911 *event = None;
1912 return Ok(Some((ev, None)));
1913 }
1914
1915 let set = match set {
1916 Some(set) => set,
1917 None => return Ok(None),
1918 };
1919 let waitable = match state.get_mut(set)?.ready.pop_first() {
1920 Some(v) => v,
1921 None => return Ok(None),
1922 };
1923
1924 let common = waitable.common(state)?;
1925 let handle = match common.handle {
1926 Some(h) => h,
1927 None => bail_bug!("handle not set when delivering event"),
1928 };
1929 let event = match common.event.take() {
1930 Some(e) => e,
1931 None => bail_bug!("event not set when delivering event"),
1932 };
1933
1934 log::trace!(
1935 "deliver event {event:?} to {guest_task:?} for {waitable:?} (handle {handle}); set {set:?}"
1936 );
1937
1938 waitable.on_delivery(store, self, event)?;
1939
1940 Ok(Some((event, Some((waitable, handle)))))
1941 }
1942
1943 fn handle_callback_code(
1949 self,
1950 store: &mut StoreOpaque,
1951 guest_thread: QualifiedThreadId,
1952 runtime_instance: RuntimeComponentInstanceIndex,
1953 code: u32,
1954 ) -> Result<Option<GuestCall>> {
1955 let (code, set) = unpack_callback_code(code);
1956
1957 log::trace!("received callback code from {guest_thread:?}: {code} (set: {set})");
1958
1959 let state = store.concurrent_state_mut();
1960
1961 let get_set = |store: &mut StoreOpaque, handle| -> Result<_> {
1962 let set = store
1963 .instance_state(RuntimeInstance {
1964 instance: self.id().instance(),
1965 index: runtime_instance,
1966 })
1967 .handle_table()
1968 .waitable_set_rep(handle)?;
1969
1970 Ok(TableId::<WaitableSet>::new(set))
1971 };
1972
1973 Ok(match code {
1974 callback_code::EXIT => {
1975 log::trace!("implicit thread {guest_thread:?} completed");
1976 self.cleanup_thread(store, guest_thread, runtime_instance)?;
1977 let task = store.concurrent_state_mut().get_mut(guest_thread.task)?;
1978 if task.threads.is_empty() && !task.returned_or_cancelled() {
1979 bail!(Trap::NoAsyncResult);
1980 }
1981 if let Caller::Guest { .. } = task.caller {
1982 task.exited = true;
1983 task.callback = None;
1984 }
1985 if task.ready_to_delete() {
1986 Waitable::Guest(guest_thread.task).delete_from(store.concurrent_state_mut())?;
1987 }
1988 None
1989 }
1990 callback_code::YIELD => {
1991 let task = state.get_mut(guest_thread.task)?;
1992 if let Some(event) = task.event {
1997 assert!(matches!(event, Event::None | Event::Cancelled));
1998 } else {
1999 task.event = Some(Event::None);
2000 }
2001 let call = GuestCall {
2002 thread: guest_thread,
2003 kind: GuestCallKind::DeliverEvent {
2004 instance: self,
2005 set: None,
2006 },
2007 };
2008 if state.may_block(guest_thread.task)? {
2009 state.push_low_priority(WorkItem::GuestCall(runtime_instance, call));
2012 None
2013 } else {
2014 Some(call)
2018 }
2019 }
2020 callback_code::WAIT => {
2021 state.check_blocking_for(guest_thread.task)?;
2024
2025 let set = get_set(store, set)?;
2026 let state = store.concurrent_state_mut();
2027
2028 if state.get_mut(guest_thread.task)?.event.is_some()
2029 || !state.get_mut(set)?.ready.is_empty()
2030 {
2031 state.push_high_priority(WorkItem::GuestCall(
2033 runtime_instance,
2034 GuestCall {
2035 thread: guest_thread,
2036 kind: GuestCallKind::DeliverEvent {
2037 instance: self,
2038 set: Some(set),
2039 },
2040 },
2041 ));
2042 } else {
2043 let old = state
2051 .get_mut(guest_thread.thread)?
2052 .wake_on_cancel
2053 .replace(set);
2054 if !old.is_none() {
2055 bail_bug!("thread unexpectedly had wake_on_cancel set");
2056 }
2057 let old = state
2058 .get_mut(set)?
2059 .waiting
2060 .insert(guest_thread, WaitMode::Callback(self));
2061 if !old.is_none() {
2062 bail_bug!("set's waiting set already had this thread registered");
2063 }
2064 }
2065 None
2066 }
2067 _ => bail!(Trap::UnsupportedCallbackCode),
2068 })
2069 }
2070
2071 fn cleanup_thread(
2072 self,
2073 store: &mut StoreOpaque,
2074 guest_thread: QualifiedThreadId,
2075 runtime_instance: RuntimeComponentInstanceIndex,
2076 ) -> Result<()> {
2077 let state = store.concurrent_state_mut();
2078 let thread_data = state.get_mut(guest_thread.thread)?;
2079 let guest_id = match thread_data.instance_rep {
2080 Some(id) => id,
2081 None => bail_bug!("thread must have instance_rep set by now"),
2082 };
2083 let sync_call_set = thread_data.sync_call_set;
2084
2085 for waitable in mem::take(&mut state.get_mut(sync_call_set)?.ready) {
2087 if let Some(Event::Subtask {
2088 status: Status::Returned | Status::ReturnCancelled,
2089 }) = waitable.common(state)?.event
2090 {
2091 waitable.delete_from(state)?;
2092 }
2093 }
2094
2095 store
2096 .instance_state(RuntimeInstance {
2097 instance: self.id().instance(),
2098 index: runtime_instance,
2099 })
2100 .thread_handle_table()
2101 .guest_thread_remove(guest_id)?;
2102
2103 store.concurrent_state_mut().delete(guest_thread.thread)?;
2104 store.concurrent_state_mut().delete(sync_call_set)?;
2105 let task = store.concurrent_state_mut().get_mut(guest_thread.task)?;
2106 task.threads.remove(&guest_thread.thread);
2107 Ok(())
2108 }
2109
2110 unsafe fn queue_call<T: 'static>(
2117 self,
2118 mut store: StoreContextMut<T>,
2119 guest_thread: QualifiedThreadId,
2120 callee: SendSyncPtr<VMFuncRef>,
2121 param_count: usize,
2122 result_count: usize,
2123 async_: bool,
2124 callback: Option<SendSyncPtr<VMFuncRef>>,
2125 post_return: Option<SendSyncPtr<VMFuncRef>>,
2126 ) -> Result<()> {
2127 unsafe fn make_call<T: 'static>(
2142 store: StoreContextMut<T>,
2143 guest_thread: QualifiedThreadId,
2144 callee: SendSyncPtr<VMFuncRef>,
2145 param_count: usize,
2146 result_count: usize,
2147 ) -> impl FnOnce(&mut dyn VMStore) -> Result<[MaybeUninit<ValRaw>; MAX_FLAT_PARAMS]>
2148 + Send
2149 + Sync
2150 + 'static
2151 + use<T> {
2152 let token = StoreToken::new(store);
2153 move |store: &mut dyn VMStore| {
2154 let mut storage = [MaybeUninit::uninit(); MAX_FLAT_PARAMS];
2155
2156 store
2157 .concurrent_state_mut()
2158 .get_mut(guest_thread.thread)?
2159 .state = GuestThreadState::Running;
2160 let task = store.concurrent_state_mut().get_mut(guest_thread.task)?;
2161 let lower = match task.lower_params.take() {
2162 Some(l) => l,
2163 None => bail_bug!("lower_params missing"),
2164 };
2165
2166 lower(store, &mut storage[..param_count])?;
2167
2168 let mut store = token.as_context_mut(store);
2169
2170 unsafe {
2173 crate::Func::call_unchecked_raw(
2174 &mut store,
2175 callee.as_non_null(),
2176 NonNull::new(
2177 &mut storage[..param_count.max(result_count)]
2178 as *mut [MaybeUninit<ValRaw>] as _,
2179 )
2180 .unwrap(),
2181 )?;
2182 }
2183
2184 Ok(storage)
2185 }
2186 }
2187
2188 let call = unsafe {
2192 make_call(
2193 store.as_context_mut(),
2194 guest_thread,
2195 callee,
2196 param_count,
2197 result_count,
2198 )
2199 };
2200
2201 let callee_instance = store
2202 .0
2203 .concurrent_state_mut()
2204 .get_mut(guest_thread.task)?
2205 .instance;
2206
2207 let fun = if callback.is_some() {
2208 assert!(async_);
2209
2210 Box::new(move |store: &mut dyn VMStore| {
2211 self.add_guest_thread_to_instance_table(
2212 guest_thread.thread,
2213 store,
2214 callee_instance.index,
2215 )?;
2216 let old_thread = store.set_thread(guest_thread)?;
2217 log::trace!(
2218 "stackless call: replaced {old_thread:?} with {guest_thread:?} as current thread"
2219 );
2220
2221 store.enter_instance(callee_instance);
2222
2223 let storage = call(store)?;
2230
2231 store.exit_instance(callee_instance)?;
2232
2233 store.set_thread(old_thread)?;
2234 let state = store.concurrent_state_mut();
2235 if let Some(t) = old_thread.guest() {
2236 state.get_mut(t.thread)?.state = GuestThreadState::Running;
2237 }
2238 log::trace!("stackless call: restored {old_thread:?} as current thread");
2239
2240 let code = unsafe { storage[0].assume_init() }.get_i32() as u32;
2243
2244 self.handle_callback_code(store, guest_thread, callee_instance.index, code)
2245 })
2246 as Box<dyn FnOnce(&mut dyn VMStore) -> Result<Option<GuestCall>> + Send + Sync>
2247 } else {
2248 let token = StoreToken::new(store.as_context_mut());
2249 Box::new(move |store: &mut dyn VMStore| {
2250 self.add_guest_thread_to_instance_table(
2251 guest_thread.thread,
2252 store,
2253 callee_instance.index,
2254 )?;
2255 let old_thread = store.set_thread(guest_thread)?;
2256 log::trace!(
2257 "sync/async-stackful call: replaced {old_thread:?} with {guest_thread:?} as current thread",
2258 );
2259 let flags = self.id().get(store).instance_flags(callee_instance.index);
2260
2261 if !async_ {
2265 store.enter_instance(callee_instance);
2266 }
2267
2268 let storage = call(store)?;
2275
2276 if async_ {
2277 let task = store.concurrent_state_mut().get_mut(guest_thread.task)?;
2278 if task.threads.len() == 1 && !task.returned_or_cancelled() {
2279 bail!(Trap::NoAsyncResult);
2280 }
2281 } else {
2282 let lift = {
2288 store.exit_instance(callee_instance)?;
2289
2290 let state = store.concurrent_state_mut();
2291 if !state.get_mut(guest_thread.task)?.result.is_none() {
2292 bail_bug!("task has not yet produced a result");
2293 }
2294
2295 match state.get_mut(guest_thread.task)?.lift_result.take() {
2296 Some(lift) => lift,
2297 None => bail_bug!("lift_result field is missing"),
2298 }
2299 };
2300
2301 let result = (lift.lift)(store, unsafe {
2304 mem::transmute::<&[MaybeUninit<ValRaw>], &[ValRaw]>(
2305 &storage[..result_count],
2306 )
2307 })?;
2308
2309 let post_return_arg = match result_count {
2310 0 => ValRaw::i32(0),
2311 1 => unsafe { storage[0].assume_init() },
2314 _ => unreachable!(),
2315 };
2316
2317 unsafe {
2318 call_post_return(
2319 token.as_context_mut(store),
2320 post_return.map(|v| v.as_non_null()),
2321 post_return_arg,
2322 flags,
2323 )?;
2324 }
2325
2326 self.task_complete(store, guest_thread.task, result, Status::Returned)?;
2327 }
2328
2329 self.cleanup_thread(store, guest_thread, callee_instance.index)?;
2331
2332 store.set_thread(old_thread)?;
2333
2334 let state = store.concurrent_state_mut();
2335 let task = state.get_mut(guest_thread.task)?;
2336
2337 match &task.caller {
2338 Caller::Host { .. } => {
2339 if task.ready_to_delete() {
2340 Waitable::Guest(guest_thread.task).delete_from(state)?;
2341 }
2342 }
2343 Caller::Guest { .. } => {
2344 task.exited = true;
2345 }
2346 }
2347
2348 Ok(None)
2349 })
2350 };
2351
2352 store
2353 .0
2354 .concurrent_state_mut()
2355 .push_high_priority(WorkItem::GuestCall(
2356 callee_instance.index,
2357 GuestCall {
2358 thread: guest_thread,
2359 kind: GuestCallKind::StartImplicit(fun),
2360 },
2361 ));
2362
2363 Ok(())
2364 }
2365
2366 unsafe fn prepare_call<T: 'static>(
2379 self,
2380 mut store: StoreContextMut<T>,
2381 start: NonNull<VMFuncRef>,
2382 return_: NonNull<VMFuncRef>,
2383 caller_instance: RuntimeComponentInstanceIndex,
2384 callee_instance: RuntimeComponentInstanceIndex,
2385 task_return_type: TypeTupleIndex,
2386 callee_async: bool,
2387 memory: *mut VMMemoryDefinition,
2388 string_encoding: StringEncoding,
2389 caller_info: CallerInfo,
2390 ) -> Result<()> {
2391 if let (CallerInfo::Sync { .. }, true) = (&caller_info, callee_async) {
2392 store.0.check_blocking()?;
2396 }
2397
2398 enum ResultInfo {
2399 Heap { results: u32 },
2400 Stack { result_count: u32 },
2401 }
2402
2403 let result_info = match &caller_info {
2404 CallerInfo::Async {
2405 has_result: true,
2406 params,
2407 } => ResultInfo::Heap {
2408 results: match params.last() {
2409 Some(r) => r.get_u32(),
2410 None => bail_bug!("retptr missing"),
2411 },
2412 },
2413 CallerInfo::Async {
2414 has_result: false, ..
2415 } => ResultInfo::Stack { result_count: 0 },
2416 CallerInfo::Sync {
2417 result_count,
2418 params,
2419 } if *result_count > u32::try_from(MAX_FLAT_RESULTS)? => ResultInfo::Heap {
2420 results: match params.last() {
2421 Some(r) => r.get_u32(),
2422 None => bail_bug!("arg ptr missing"),
2423 },
2424 },
2425 CallerInfo::Sync { result_count, .. } => ResultInfo::Stack {
2426 result_count: *result_count,
2427 },
2428 };
2429
2430 let sync_caller = matches!(caller_info, CallerInfo::Sync { .. });
2431
2432 let start = SendSyncPtr::new(start);
2436 let return_ = SendSyncPtr::new(return_);
2437 let token = StoreToken::new(store.as_context_mut());
2438 let state = store.0.concurrent_state_mut();
2439 let old_thread = state.current_guest_thread()?;
2440
2441 debug_assert_eq!(
2442 state.get_mut(old_thread.task)?.instance,
2443 RuntimeInstance {
2444 instance: self.id().instance(),
2445 index: caller_instance,
2446 }
2447 );
2448
2449 let new_task = GuestTask::new(
2450 Box::new(move |store, dst| {
2451 let mut store = token.as_context_mut(store);
2452 assert!(dst.len() <= MAX_FLAT_PARAMS);
2453 let mut src = [MaybeUninit::uninit(); MAX_FLAT_PARAMS + 1];
2455 let count = match caller_info {
2456 CallerInfo::Async { params, has_result } => {
2460 let params = ¶ms[..params.len() - usize::from(has_result)];
2461 for (param, src) in params.iter().zip(&mut src) {
2462 src.write(*param);
2463 }
2464 params.len()
2465 }
2466
2467 CallerInfo::Sync { params, .. } => {
2469 for (param, src) in params.iter().zip(&mut src) {
2470 src.write(*param);
2471 }
2472 params.len()
2473 }
2474 };
2475 unsafe {
2482 crate::Func::call_unchecked_raw(
2483 &mut store,
2484 start.as_non_null(),
2485 NonNull::new(
2486 &mut src[..count.max(dst.len())] as *mut [MaybeUninit<ValRaw>] as _,
2487 )
2488 .unwrap(),
2489 )?;
2490 }
2491 dst.copy_from_slice(&src[..dst.len()]);
2492 let state = store.0.concurrent_state_mut();
2493 Waitable::Guest(state.current_guest_thread()?.task).set_event(
2494 state,
2495 Some(Event::Subtask {
2496 status: Status::Started,
2497 }),
2498 )?;
2499 Ok(())
2500 }),
2501 LiftResult {
2502 lift: Box::new(move |store, src| {
2503 let mut store = token.as_context_mut(store);
2506 let mut my_src = src.to_owned(); if let ResultInfo::Heap { results } = &result_info {
2508 my_src.push(ValRaw::u32(*results));
2509 }
2510
2511 let prev = store.0.set_thread(old_thread)?;
2517
2518 unsafe {
2525 crate::Func::call_unchecked_raw(
2526 &mut store,
2527 return_.as_non_null(),
2528 my_src.as_mut_slice().into(),
2529 )?;
2530 }
2531
2532 store.0.set_thread(prev)?;
2535
2536 let state = store.0.concurrent_state_mut();
2537 let thread = state.current_guest_thread()?;
2538 if sync_caller {
2539 state.get_mut(thread.task)?.sync_result = SyncResult::Produced(
2540 if let ResultInfo::Stack { result_count } = &result_info {
2541 match result_count {
2542 0 => None,
2543 1 => Some(my_src[0]),
2544 _ => unreachable!(),
2545 }
2546 } else {
2547 None
2548 },
2549 );
2550 }
2551 Ok(Box::new(DummyResult) as Box<dyn Any + Send + Sync>)
2552 }),
2553 ty: task_return_type,
2554 memory: NonNull::new(memory).map(SendSyncPtr::new),
2555 string_encoding,
2556 },
2557 Caller::Guest { thread: old_thread },
2558 None,
2559 RuntimeInstance {
2560 instance: self.id().instance(),
2561 index: callee_instance,
2562 },
2563 callee_async,
2564 )?;
2565
2566 let guest_task = state.push(new_task)?;
2567 let new_thread = GuestThread::new_implicit(state, guest_task)?;
2568 let guest_thread = state.push(new_thread)?;
2569 state.get_mut(guest_task)?.threads.insert(guest_thread);
2570
2571 store.0.set_thread(QualifiedThreadId {
2574 task: guest_task,
2575 thread: guest_thread,
2576 })?;
2577 log::trace!(
2578 "pushed {guest_task:?}:{guest_thread:?} as current thread; old thread was {old_thread:?}"
2579 );
2580
2581 Ok(())
2582 }
2583
2584 unsafe fn call_callback<T>(
2589 self,
2590 mut store: StoreContextMut<T>,
2591 function: SendSyncPtr<VMFuncRef>,
2592 event: Event,
2593 handle: u32,
2594 ) -> Result<u32> {
2595 let (ordinal, result) = event.parts();
2596 let params = &mut [
2597 ValRaw::u32(ordinal),
2598 ValRaw::u32(handle),
2599 ValRaw::u32(result),
2600 ];
2601 unsafe {
2606 crate::Func::call_unchecked_raw(
2607 &mut store,
2608 function.as_non_null(),
2609 params.as_mut_slice().into(),
2610 )?;
2611 }
2612 Ok(params[0].get_u32())
2613 }
2614
2615 unsafe fn start_call<T: 'static>(
2628 self,
2629 mut store: StoreContextMut<T>,
2630 callback: *mut VMFuncRef,
2631 post_return: *mut VMFuncRef,
2632 callee: NonNull<VMFuncRef>,
2633 param_count: u32,
2634 result_count: u32,
2635 flags: u32,
2636 storage: Option<&mut [MaybeUninit<ValRaw>]>,
2637 ) -> Result<u32> {
2638 let token = StoreToken::new(store.as_context_mut());
2639 let async_caller = storage.is_none();
2640 let state = store.0.concurrent_state_mut();
2641 let guest_thread = state.current_guest_thread()?;
2642 let callee_async = state.get_mut(guest_thread.task)?.async_function;
2643 let callee = SendSyncPtr::new(callee);
2644 let param_count = usize::try_from(param_count)?;
2645 assert!(param_count <= MAX_FLAT_PARAMS);
2646 let result_count = usize::try_from(result_count)?;
2647 assert!(result_count <= MAX_FLAT_RESULTS);
2648
2649 let task = state.get_mut(guest_thread.task)?;
2650 if let Some(callback) = NonNull::new(callback) {
2651 let callback = SendSyncPtr::new(callback);
2655 task.callback = Some(Box::new(move |store, event, handle| {
2656 let store = token.as_context_mut(store);
2657 unsafe { self.call_callback::<T>(store, callback, event, handle) }
2658 }));
2659 }
2660
2661 let Caller::Guest { thread: caller } = &task.caller else {
2662 bail_bug!("start_call unexpectedly invoked for host->guest call");
2665 };
2666 let caller = *caller;
2667 let caller_instance = state.get_mut(caller.task)?.instance;
2668
2669 unsafe {
2671 self.queue_call(
2672 store.as_context_mut(),
2673 guest_thread,
2674 callee,
2675 param_count,
2676 result_count,
2677 (flags & START_FLAG_ASYNC_CALLEE) != 0,
2678 NonNull::new(callback).map(SendSyncPtr::new),
2679 NonNull::new(post_return).map(SendSyncPtr::new),
2680 )?;
2681 }
2682
2683 let state = store.0.concurrent_state_mut();
2684
2685 let guest_waitable = Waitable::Guest(guest_thread.task);
2688 let old_set = guest_waitable.common(state)?.set;
2689 let set = state.get_mut(caller.thread)?.sync_call_set;
2690 guest_waitable.join(state, Some(set))?;
2691
2692 let (status, waitable) = loop {
2708 store.0.suspend(SuspendReason::Waiting {
2709 set,
2710 thread: caller,
2711 skip_may_block_check: async_caller || !callee_async,
2719 })?;
2720
2721 let state = store.0.concurrent_state_mut();
2722
2723 log::trace!("taking event for {:?}", guest_thread.task);
2724 let event = guest_waitable.take_event(state)?;
2725 let Some(Event::Subtask { status }) = event else {
2726 bail_bug!("subtasks should only get subtask events, got {event:?}")
2727 };
2728
2729 log::trace!("status {status:?} for {:?}", guest_thread.task);
2730
2731 if status == Status::Returned {
2732 break (status, None);
2734 } else if async_caller {
2735 let handle = store
2739 .0
2740 .instance_state(caller_instance)
2741 .handle_table()
2742 .subtask_insert_guest(guest_thread.task.rep())?;
2743 store
2744 .0
2745 .concurrent_state_mut()
2746 .get_mut(guest_thread.task)?
2747 .common
2748 .handle = Some(handle);
2749 break (status, Some(handle));
2750 } else {
2751 }
2755 };
2756
2757 guest_waitable.join(store.0.concurrent_state_mut(), old_set)?;
2758
2759 store.0.set_thread(caller)?;
2761 store.0.concurrent_state_mut().get_mut(caller.thread)?.state = GuestThreadState::Running;
2762 log::trace!("popped current thread {guest_thread:?}; new thread is {caller:?}");
2763
2764 if let Some(storage) = storage {
2765 let state = store.0.concurrent_state_mut();
2769 let task = state.get_mut(guest_thread.task)?;
2770 if let Some(result) = task.sync_result.take()? {
2771 if let Some(result) = result {
2772 storage[0] = MaybeUninit::new(result);
2773 }
2774
2775 if task.exited && task.ready_to_delete() {
2776 Waitable::Guest(guest_thread.task).delete_from(state)?;
2777 }
2778 }
2779 }
2780
2781 Ok(status.pack(waitable))
2782 }
2783
2784 pub(crate) fn first_poll<T: 'static, R: Send + 'static>(
2797 self,
2798 mut store: StoreContextMut<'_, T>,
2799 future: impl Future<Output = Result<R>> + Send + 'static,
2800 lower: impl FnOnce(StoreContextMut<T>, Option<R>) -> Result<()> + Send + 'static,
2801 ) -> Result<Option<u32>> {
2802 let token = StoreToken::new(store.as_context_mut());
2803 let state = store.0.concurrent_state_mut();
2804 let task = state.current_host_thread()?;
2805
2806 let (join_handle, future) = JoinHandle::run(future);
2809 {
2810 let state = &mut state.get_mut(task)?.state;
2811 assert!(matches!(state, HostTaskState::CalleeStarted));
2812 *state = HostTaskState::CalleeRunning(join_handle);
2813 }
2814
2815 let mut future = Box::pin(future);
2816
2817 let poll = tls::set(store.0, || {
2822 future
2823 .as_mut()
2824 .poll(&mut Context::from_waker(&Waker::noop()))
2825 });
2826
2827 match poll {
2828 Poll::Ready(result) => {
2830 let result = result.transpose()?;
2831 lower(store.as_context_mut(), result)?;
2832 return Ok(None);
2833 }
2834
2835 Poll::Pending => {}
2837 }
2838
2839 let future = Box::pin(async move {
2847 let result = match future.await {
2848 Some(result) => Some(result?),
2849 None => None,
2850 };
2851 let on_complete = move |store: &mut dyn VMStore| {
2852 let mut store = token.as_context_mut(store);
2856 let old = store.0.set_thread(task)?;
2857
2858 let status = if result.is_some() {
2859 Status::Returned
2860 } else {
2861 Status::ReturnCancelled
2862 };
2863
2864 lower(store.as_context_mut(), result)?;
2865 let state = store.0.concurrent_state_mut();
2866 state.get_mut(task)?.state = HostTaskState::CalleeDone;
2867 Waitable::Host(task).set_event(state, Some(Event::Subtask { status }))?;
2868
2869 store.0.set_thread(old)?;
2870 Ok(())
2871 };
2872
2873 tls::get(move |store| {
2878 store
2879 .concurrent_state_mut()
2880 .push_high_priority(WorkItem::WorkerFunction(AlwaysMut::new(Box::new(
2881 on_complete,
2882 ))));
2883 Ok(())
2884 })
2885 });
2886
2887 let state = store.0.concurrent_state_mut();
2890 state.push_future(future);
2891 let caller = state.get_mut(task)?.caller;
2892 let instance = state.get_mut(caller.task)?.instance;
2893 let handle = store
2894 .0
2895 .instance_state(instance)
2896 .handle_table()
2897 .subtask_insert_host(task.rep())?;
2898 store.0.concurrent_state_mut().get_mut(task)?.common.handle = Some(handle);
2899 log::trace!("assign {task:?} handle {handle} for {caller:?} instance {instance:?}");
2900
2901 store.0.set_thread(caller)?;
2905 Ok(Some(handle))
2906 }
2907
2908 pub(crate) fn task_return(
2911 self,
2912 store: &mut dyn VMStore,
2913 ty: TypeTupleIndex,
2914 options: OptionsIndex,
2915 storage: &[ValRaw],
2916 ) -> Result<()> {
2917 let state = store.concurrent_state_mut();
2918 let guest_thread = state.current_guest_thread()?;
2919 let lift = state
2920 .get_mut(guest_thread.task)?
2921 .lift_result
2922 .take()
2923 .ok_or_else(|| Trap::TaskCancelOrReturnTwice)?;
2924 if !state.get_mut(guest_thread.task)?.result.is_none() {
2925 bail_bug!("task result unexpectedly already set");
2926 }
2927
2928 let CanonicalOptions {
2929 string_encoding,
2930 data_model,
2931 ..
2932 } = &self.id().get(store).component().env_component().options[options];
2933
2934 let invalid = ty != lift.ty
2935 || string_encoding != &lift.string_encoding
2936 || match data_model {
2937 CanonicalOptionsDataModel::LinearMemory(opts) => match opts.memory {
2938 Some(memory) => {
2939 let expected = lift.memory.map(|v| v.as_ptr()).unwrap_or(ptr::null_mut());
2940 let actual = self.id().get(store).runtime_memory(memory);
2941 expected != actual.as_ptr()
2942 }
2943 None => false,
2946 },
2947 CanonicalOptionsDataModel::Gc { .. } => true,
2949 };
2950
2951 if invalid {
2952 bail!(Trap::TaskReturnInvalid);
2953 }
2954
2955 log::trace!("task.return for {guest_thread:?}");
2956
2957 let result = (lift.lift)(store, storage)?;
2958 self.task_complete(store, guest_thread.task, result, Status::Returned)
2959 }
2960
2961 pub(crate) fn task_cancel(self, store: &mut StoreOpaque) -> Result<()> {
2963 let state = store.concurrent_state_mut();
2964 let guest_thread = state.current_guest_thread()?;
2965 let task = state.get_mut(guest_thread.task)?;
2966 if !task.cancel_sent {
2967 bail!(Trap::TaskCancelNotCancelled);
2968 }
2969 _ = task
2970 .lift_result
2971 .take()
2972 .ok_or_else(|| Trap::TaskCancelOrReturnTwice)?;
2973
2974 if !task.result.is_none() {
2975 bail_bug!("task result should not bet set yet");
2976 }
2977
2978 log::trace!("task.cancel for {guest_thread:?}");
2979
2980 self.task_complete(
2981 store,
2982 guest_thread.task,
2983 Box::new(DummyResult),
2984 Status::ReturnCancelled,
2985 )
2986 }
2987
2988 fn task_complete(
2994 self,
2995 store: &mut StoreOpaque,
2996 guest_task: TableId<GuestTask>,
2997 result: Box<dyn Any + Send + Sync>,
2998 status: Status,
2999 ) -> Result<()> {
3000 store
3001 .component_resource_tables(Some(self))
3002 .validate_scope_exit()?;
3003
3004 let state = store.concurrent_state_mut();
3005 let task = state.get_mut(guest_task)?;
3006
3007 if let Caller::Host { tx, .. } = &mut task.caller {
3008 if let Some(tx) = tx.take() {
3009 _ = tx.send(result);
3010 }
3011 } else {
3012 task.result = Some(result);
3013 Waitable::Guest(guest_task).set_event(state, Some(Event::Subtask { status }))?;
3014 }
3015
3016 Ok(())
3017 }
3018
3019 pub(crate) fn waitable_set_new(
3021 self,
3022 store: &mut StoreOpaque,
3023 caller_instance: RuntimeComponentInstanceIndex,
3024 ) -> Result<u32> {
3025 let set = store.concurrent_state_mut().push(WaitableSet::default())?;
3026 let handle = store
3027 .instance_state(RuntimeInstance {
3028 instance: self.id().instance(),
3029 index: caller_instance,
3030 })
3031 .handle_table()
3032 .waitable_set_insert(set.rep())?;
3033 log::trace!("new waitable set {set:?} (handle {handle})");
3034 Ok(handle)
3035 }
3036
3037 pub(crate) fn waitable_set_drop(
3039 self,
3040 store: &mut StoreOpaque,
3041 caller_instance: RuntimeComponentInstanceIndex,
3042 set: u32,
3043 ) -> Result<()> {
3044 let rep = store
3045 .instance_state(RuntimeInstance {
3046 instance: self.id().instance(),
3047 index: caller_instance,
3048 })
3049 .handle_table()
3050 .waitable_set_remove(set)?;
3051
3052 log::trace!("drop waitable set {rep} (handle {set})");
3053
3054 let set = store
3055 .concurrent_state_mut()
3056 .delete(TableId::<WaitableSet>::new(rep))?;
3057
3058 if !set.waiting.is_empty() {
3059 bail!(Trap::WaitableSetDropHasWaiters);
3060 }
3061
3062 Ok(())
3063 }
3064
3065 pub(crate) fn waitable_join(
3067 self,
3068 store: &mut StoreOpaque,
3069 caller_instance: RuntimeComponentInstanceIndex,
3070 waitable_handle: u32,
3071 set_handle: u32,
3072 ) -> Result<()> {
3073 let mut instance = self.id().get_mut(store);
3074 let waitable =
3075 Waitable::from_instance(instance.as_mut(), caller_instance, waitable_handle)?;
3076
3077 let set = if set_handle == 0 {
3078 None
3079 } else {
3080 let set = instance.instance_states().0[caller_instance]
3081 .handle_table()
3082 .waitable_set_rep(set_handle)?;
3083
3084 Some(TableId::<WaitableSet>::new(set))
3085 };
3086
3087 log::trace!(
3088 "waitable {waitable:?} (handle {waitable_handle}) join set {set:?} (handle {set_handle})",
3089 );
3090
3091 waitable.join(store.concurrent_state_mut(), set)
3092 }
3093
3094 pub(crate) fn subtask_drop(
3096 self,
3097 store: &mut StoreOpaque,
3098 caller_instance: RuntimeComponentInstanceIndex,
3099 task_id: u32,
3100 ) -> Result<()> {
3101 self.waitable_join(store, caller_instance, task_id, 0)?;
3102
3103 let (rep, is_host) = store
3104 .instance_state(RuntimeInstance {
3105 instance: self.id().instance(),
3106 index: caller_instance,
3107 })
3108 .handle_table()
3109 .subtask_remove(task_id)?;
3110
3111 let concurrent_state = store.concurrent_state_mut();
3112 let (waitable, expected_caller, delete) = if is_host {
3113 let id = TableId::<HostTask>::new(rep);
3114 let task = concurrent_state.get_mut(id)?;
3115 match &task.state {
3116 HostTaskState::CalleeRunning(_) => bail!(Trap::SubtaskDropNotResolved),
3117 HostTaskState::CalleeDone => {}
3118 HostTaskState::CalleeStarted | HostTaskState::CalleeFinished(_) => {
3119 bail_bug!("invalid state for callee in `subtask.drop`")
3120 }
3121 }
3122 (Waitable::Host(id), task.caller, true)
3123 } else {
3124 let id = TableId::<GuestTask>::new(rep);
3125 let task = concurrent_state.get_mut(id)?;
3126 if task.lift_result.is_some() {
3127 bail!(Trap::SubtaskDropNotResolved);
3128 }
3129 if let Caller::Guest { thread } = task.caller {
3130 (
3131 Waitable::Guest(id),
3132 thread,
3133 concurrent_state.get_mut(id)?.exited,
3134 )
3135 } else {
3136 bail_bug!("expected guest caller for `subtask.drop`")
3137 }
3138 };
3139
3140 waitable.common(concurrent_state)?.handle = None;
3141
3142 if waitable.take_event(concurrent_state)?.is_some() {
3145 bail!(Trap::SubtaskDropNotResolved);
3146 }
3147
3148 if delete {
3149 waitable.delete_from(concurrent_state)?;
3150 }
3151
3152 debug_assert_eq!(expected_caller, concurrent_state.current_guest_thread()?);
3156 log::trace!("subtask_drop {waitable:?} (handle {task_id})");
3157 Ok(())
3158 }
3159
3160 pub(crate) fn waitable_set_wait(
3162 self,
3163 store: &mut StoreOpaque,
3164 options: OptionsIndex,
3165 set: u32,
3166 payload: u32,
3167 ) -> Result<u32> {
3168 if !self.options(store, options).async_ {
3169 store.check_blocking()?;
3173 }
3174
3175 let &CanonicalOptions {
3176 cancellable,
3177 instance: caller_instance,
3178 ..
3179 } = &self.id().get(store).component().env_component().options[options];
3180 let rep = store
3181 .instance_state(RuntimeInstance {
3182 instance: self.id().instance(),
3183 index: caller_instance,
3184 })
3185 .handle_table()
3186 .waitable_set_rep(set)?;
3187
3188 self.waitable_check(
3189 store,
3190 cancellable,
3191 WaitableCheck::Wait,
3192 WaitableCheckParams {
3193 set: TableId::new(rep),
3194 options,
3195 payload,
3196 },
3197 )
3198 }
3199
3200 pub(crate) fn waitable_set_poll(
3202 self,
3203 store: &mut StoreOpaque,
3204 options: OptionsIndex,
3205 set: u32,
3206 payload: u32,
3207 ) -> Result<u32> {
3208 let &CanonicalOptions {
3209 cancellable,
3210 instance: caller_instance,
3211 ..
3212 } = &self.id().get(store).component().env_component().options[options];
3213 let rep = store
3214 .instance_state(RuntimeInstance {
3215 instance: self.id().instance(),
3216 index: caller_instance,
3217 })
3218 .handle_table()
3219 .waitable_set_rep(set)?;
3220
3221 self.waitable_check(
3222 store,
3223 cancellable,
3224 WaitableCheck::Poll,
3225 WaitableCheckParams {
3226 set: TableId::new(rep),
3227 options,
3228 payload,
3229 },
3230 )
3231 }
3232
3233 pub(crate) fn thread_index(&self, store: &mut dyn VMStore) -> Result<u32> {
3235 let thread_id = store.concurrent_state_mut().current_guest_thread()?.thread;
3236 match store
3237 .concurrent_state_mut()
3238 .get_mut(thread_id)?
3239 .instance_rep
3240 {
3241 Some(r) => Ok(r),
3242 None => bail_bug!("thread should have instance_rep by now"),
3243 }
3244 }
3245
3246 pub(crate) fn thread_new_indirect<T: 'static>(
3248 self,
3249 mut store: StoreContextMut<T>,
3250 runtime_instance: RuntimeComponentInstanceIndex,
3251 _func_ty_idx: TypeFuncIndex, start_func_table_idx: RuntimeTableIndex,
3253 start_func_idx: u32,
3254 context: i32,
3255 ) -> Result<u32> {
3256 log::trace!("creating new thread");
3257
3258 let start_func_ty = FuncType::new(store.engine(), [ValType::I32], []);
3259 let (instance, registry) = self.id().get_mut_and_registry(store.0);
3260 let callee = instance
3261 .index_runtime_func_table(registry, start_func_table_idx, start_func_idx as u64)?
3262 .ok_or_else(|| Trap::ThreadNewIndirectUninitialized)?;
3263 if callee.type_index(store.0) != start_func_ty.type_index() {
3264 bail!(Trap::ThreadNewIndirectInvalidType);
3265 }
3266
3267 let token = StoreToken::new(store.as_context_mut());
3268 let start_func = Box::new(
3269 move |store: &mut dyn VMStore, guest_thread: QualifiedThreadId| -> Result<()> {
3270 let old_thread = store.set_thread(guest_thread)?;
3271 log::trace!(
3272 "thread start: replaced {old_thread:?} with {guest_thread:?} as current thread"
3273 );
3274
3275 let mut store = token.as_context_mut(store);
3276 let mut params = [ValRaw::i32(context)];
3277 unsafe { callee.call_unchecked(store.as_context_mut(), &mut params)? };
3280
3281 self.cleanup_thread(store.0, guest_thread, runtime_instance)?;
3282 log::trace!("explicit thread {guest_thread:?} completed");
3283 let state = store.0.concurrent_state_mut();
3284 let task = state.get_mut(guest_thread.task)?;
3285 if task.threads.is_empty() && !task.returned_or_cancelled() {
3286 bail!(Trap::NoAsyncResult);
3287 }
3288 store.0.set_thread(old_thread)?;
3289 let state = store.0.concurrent_state_mut();
3290 if let Some(t) = old_thread.guest() {
3291 state.get_mut(t.thread)?.state = GuestThreadState::Running;
3292 }
3293 if state.get_mut(guest_thread.task)?.ready_to_delete() {
3294 Waitable::Guest(guest_thread.task).delete_from(state)?;
3295 }
3296 log::trace!("thread start: restored {old_thread:?} as current thread");
3297
3298 Ok(())
3299 },
3300 );
3301
3302 let state = store.0.concurrent_state_mut();
3303 let current_thread = state.current_guest_thread()?;
3304 let parent_task = current_thread.task;
3305
3306 let new_thread = GuestThread::new_explicit(state, parent_task, start_func)?;
3307 let thread_id = state.push(new_thread)?;
3308 state.get_mut(parent_task)?.threads.insert(thread_id);
3309
3310 log::trace!("new thread with id {thread_id:?} created");
3311
3312 self.add_guest_thread_to_instance_table(thread_id, store.0, runtime_instance)
3313 }
3314
3315 pub(crate) fn resume_thread(
3316 self,
3317 store: &mut StoreOpaque,
3318 runtime_instance: RuntimeComponentInstanceIndex,
3319 thread_idx: u32,
3320 high_priority: bool,
3321 allow_ready: bool,
3322 ) -> Result<()> {
3323 let thread_id =
3324 GuestThread::from_instance(self.id().get_mut(store), runtime_instance, thread_idx)?;
3325 let state = store.concurrent_state_mut();
3326 let guest_thread = QualifiedThreadId::qualify(state, thread_id)?;
3327 let thread = state.get_mut(guest_thread.thread)?;
3328
3329 match mem::replace(&mut thread.state, GuestThreadState::Running) {
3330 GuestThreadState::NotStartedExplicit(start_func) => {
3331 log::trace!("starting thread {guest_thread:?}");
3332 let guest_call = WorkItem::GuestCall(
3333 runtime_instance,
3334 GuestCall {
3335 thread: guest_thread,
3336 kind: GuestCallKind::StartExplicit(Box::new(move |store| {
3337 start_func(store, guest_thread)
3338 })),
3339 },
3340 );
3341 store
3342 .concurrent_state_mut()
3343 .push_work_item(guest_call, high_priority);
3344 }
3345 GuestThreadState::Suspended(fiber) => {
3346 log::trace!("resuming thread {thread_id:?} that was suspended");
3347 store
3348 .concurrent_state_mut()
3349 .push_work_item(WorkItem::ResumeFiber(fiber), high_priority);
3350 }
3351 GuestThreadState::Ready(fiber) if allow_ready => {
3352 log::trace!("resuming thread {thread_id:?} that was ready");
3353 thread.state = GuestThreadState::Ready(fiber);
3354 store
3355 .concurrent_state_mut()
3356 .promote_thread_work_item(guest_thread);
3357 }
3358 other => {
3359 thread.state = other;
3360 bail!(Trap::CannotResumeThread);
3361 }
3362 }
3363 Ok(())
3364 }
3365
3366 fn add_guest_thread_to_instance_table(
3367 self,
3368 thread_id: TableId<GuestThread>,
3369 store: &mut StoreOpaque,
3370 runtime_instance: RuntimeComponentInstanceIndex,
3371 ) -> Result<u32> {
3372 let guest_id = store
3373 .instance_state(RuntimeInstance {
3374 instance: self.id().instance(),
3375 index: runtime_instance,
3376 })
3377 .thread_handle_table()
3378 .guest_thread_insert(thread_id.rep())?;
3379 store
3380 .concurrent_state_mut()
3381 .get_mut(thread_id)?
3382 .instance_rep = Some(guest_id);
3383 Ok(guest_id)
3384 }
3385
3386 pub(crate) fn suspension_intrinsic(
3389 self,
3390 store: &mut StoreOpaque,
3391 caller: RuntimeComponentInstanceIndex,
3392 cancellable: bool,
3393 yielding: bool,
3394 to_thread: SuspensionTarget,
3395 ) -> Result<WaitResult> {
3396 let guest_thread = store.concurrent_state_mut().current_guest_thread()?;
3397 if to_thread.is_none() {
3398 let state = store.concurrent_state_mut();
3399 if yielding {
3400 if !state.may_block(guest_thread.task)? {
3402 if !state.promote_instance_local_thread_work_item(caller) {
3405 return Ok(WaitResult::Completed);
3407 }
3408 }
3409 } else {
3410 store.check_blocking()?;
3414 }
3415 }
3416
3417 if cancellable && store.concurrent_state_mut().take_pending_cancellation()? {
3419 return Ok(WaitResult::Cancelled);
3420 }
3421
3422 match to_thread {
3423 SuspensionTarget::SomeSuspended(thread) => {
3424 self.resume_thread(store, caller, thread, true, false)?
3425 }
3426 SuspensionTarget::Some(thread) => {
3427 self.resume_thread(store, caller, thread, true, true)?
3428 }
3429 SuspensionTarget::None => { }
3430 }
3431
3432 let reason = if yielding {
3433 SuspendReason::Yielding {
3434 thread: guest_thread,
3435 skip_may_block_check: to_thread.is_some(),
3439 }
3440 } else {
3441 SuspendReason::ExplicitlySuspending {
3442 thread: guest_thread,
3443 skip_may_block_check: to_thread.is_some(),
3447 }
3448 };
3449
3450 store.suspend(reason)?;
3451
3452 if cancellable && store.concurrent_state_mut().take_pending_cancellation()? {
3453 Ok(WaitResult::Cancelled)
3454 } else {
3455 Ok(WaitResult::Completed)
3456 }
3457 }
3458
3459 fn waitable_check(
3461 self,
3462 store: &mut StoreOpaque,
3463 cancellable: bool,
3464 check: WaitableCheck,
3465 params: WaitableCheckParams,
3466 ) -> Result<u32> {
3467 let guest_thread = store.concurrent_state_mut().current_guest_thread()?;
3468
3469 log::trace!("waitable check for {guest_thread:?}; set {:?}", params.set);
3470
3471 let state = store.concurrent_state_mut();
3472 let task = state.get_mut(guest_thread.task)?;
3473
3474 match &check {
3477 WaitableCheck::Wait => {
3478 let set = params.set;
3479
3480 if (task.event.is_none()
3481 || (matches!(task.event, Some(Event::Cancelled)) && !cancellable))
3482 && state.get_mut(set)?.ready.is_empty()
3483 {
3484 if cancellable {
3485 let old = state
3486 .get_mut(guest_thread.thread)?
3487 .wake_on_cancel
3488 .replace(set);
3489 if !old.is_none() {
3490 bail_bug!("thread unexpectedly in a prior wake_on_cancel set");
3491 }
3492 }
3493
3494 store.suspend(SuspendReason::Waiting {
3495 set,
3496 thread: guest_thread,
3497 skip_may_block_check: false,
3498 })?;
3499 }
3500 }
3501 WaitableCheck::Poll => {}
3502 }
3503
3504 log::trace!(
3505 "waitable check for {guest_thread:?}; set {:?}, part two",
3506 params.set
3507 );
3508
3509 let event = self.get_event(store, guest_thread.task, Some(params.set), cancellable)?;
3511
3512 let (ordinal, handle, result) = match &check {
3513 WaitableCheck::Wait => {
3514 let (event, waitable) = match event {
3515 Some(p) => p,
3516 None => bail_bug!("event expected to be present"),
3517 };
3518 let handle = waitable.map(|(_, v)| v).unwrap_or(0);
3519 let (ordinal, result) = event.parts();
3520 (ordinal, handle, result)
3521 }
3522 WaitableCheck::Poll => {
3523 if let Some((event, waitable)) = event {
3524 let handle = waitable.map(|(_, v)| v).unwrap_or(0);
3525 let (ordinal, result) = event.parts();
3526 (ordinal, handle, result)
3527 } else {
3528 log::trace!(
3529 "no events ready to deliver via waitable-set.poll to {:?}; set {:?}",
3530 guest_thread.task,
3531 params.set
3532 );
3533 let (ordinal, result) = Event::None.parts();
3534 (ordinal, 0, result)
3535 }
3536 }
3537 };
3538 let memory = self.options_memory_mut(store, params.options);
3539 let ptr = func::validate_inbounds_dynamic(
3540 &CanonicalAbiInfo::POINTER_PAIR,
3541 memory,
3542 &ValRaw::u32(params.payload),
3543 )?;
3544 memory[ptr + 0..][..4].copy_from_slice(&handle.to_le_bytes());
3545 memory[ptr + 4..][..4].copy_from_slice(&result.to_le_bytes());
3546 Ok(ordinal)
3547 }
3548
3549 pub(crate) fn subtask_cancel(
3551 self,
3552 store: &mut StoreOpaque,
3553 caller_instance: RuntimeComponentInstanceIndex,
3554 async_: bool,
3555 task_id: u32,
3556 ) -> Result<u32> {
3557 if !async_ {
3558 store.check_blocking()?;
3562 }
3563
3564 let (rep, is_host) = store
3565 .instance_state(RuntimeInstance {
3566 instance: self.id().instance(),
3567 index: caller_instance,
3568 })
3569 .handle_table()
3570 .subtask_rep(task_id)?;
3571 let (waitable, expected_caller) = if is_host {
3572 let id = TableId::<HostTask>::new(rep);
3573 (
3574 Waitable::Host(id),
3575 store.concurrent_state_mut().get_mut(id)?.caller,
3576 )
3577 } else {
3578 let id = TableId::<GuestTask>::new(rep);
3579 if let Caller::Guest { thread } = store.concurrent_state_mut().get_mut(id)?.caller {
3580 (Waitable::Guest(id), thread)
3581 } else {
3582 bail_bug!("expected guest caller for `subtask.cancel`")
3583 }
3584 };
3585 let concurrent_state = store.concurrent_state_mut();
3589 debug_assert_eq!(expected_caller, concurrent_state.current_guest_thread()?);
3590
3591 log::trace!("subtask_cancel {waitable:?} (handle {task_id})");
3592
3593 let needs_block;
3594 if let Waitable::Host(host_task) = waitable {
3595 let state = &mut concurrent_state.get_mut(host_task)?.state;
3596 match mem::replace(state, HostTaskState::CalleeDone) {
3597 HostTaskState::CalleeRunning(handle) => handle.abort(),
3600
3601 HostTaskState::CalleeDone => {
3604 bail!(Trap::SubtaskCancelAfterTerminal);
3605 }
3606
3607 HostTaskState::CalleeStarted | HostTaskState::CalleeFinished(_) => {
3610 bail_bug!("invalid states for host callee")
3611 }
3612 }
3613
3614 needs_block = true;
3619 } else {
3620 let caller = concurrent_state.current_guest_thread()?;
3621 let guest_task = TableId::<GuestTask>::new(rep);
3622 let task = concurrent_state.get_mut(guest_task)?;
3623 if !task.already_lowered_parameters() {
3624 task.lower_params = None;
3628 task.lift_result = None;
3629 task.exited = true;
3630
3631 let instance = task.instance;
3632
3633 assert_eq!(1, task.threads.len());
3634 let thread = mem::take(&mut task.threads).into_iter().next().unwrap();
3635 let concurrent_state = store.concurrent_state_mut();
3636 concurrent_state.delete(thread)?;
3637 assert!(concurrent_state.get_mut(guest_task)?.ready_to_delete());
3638
3639 let pending = &mut store.instance_state(instance).concurrent_state().pending;
3641 let pending_count = pending.len();
3642 pending.retain(|thread, _| thread.task != guest_task);
3643 if pending.len() == pending_count {
3645 bail!(Trap::SubtaskCancelAfterTerminal);
3646 }
3647 return Ok(Status::StartCancelled as u32);
3648 } else if !task.returned_or_cancelled() {
3649 task.cancel_sent = true;
3652 task.event = Some(Event::Cancelled);
3657 let runtime_instance = task.instance.index;
3658 for thread in task.threads.clone() {
3659 let thread = QualifiedThreadId {
3660 task: guest_task,
3661 thread,
3662 };
3663 if let Some(set) = concurrent_state
3664 .get_mut(thread.thread)?
3665 .wake_on_cancel
3666 .take()
3667 {
3668 let item = match concurrent_state.get_mut(set)?.waiting.remove(&thread) {
3669 Some(WaitMode::Fiber(fiber)) => WorkItem::ResumeFiber(fiber),
3670 Some(WaitMode::Callback(instance)) => WorkItem::GuestCall(
3671 runtime_instance,
3672 GuestCall {
3673 thread,
3674 kind: GuestCallKind::DeliverEvent {
3675 instance,
3676 set: None,
3677 },
3678 },
3679 ),
3680 None => bail_bug!("thread not present in wake_on_cancel set"),
3681 };
3682 concurrent_state.push_high_priority(item);
3683
3684 store.suspend(SuspendReason::Yielding {
3685 thread: caller,
3686 skip_may_block_check: false,
3689 })?;
3690 break;
3691 }
3692 }
3693
3694 needs_block = !store
3697 .concurrent_state_mut()
3698 .get_mut(guest_task)?
3699 .returned_or_cancelled()
3700 } else {
3701 needs_block = false;
3702 }
3703 };
3704
3705 if needs_block {
3709 if async_ {
3710 return Ok(BLOCKED);
3711 }
3712
3713 store.wait_for_event(waitable)?;
3717
3718 }
3720
3721 let event = waitable.take_event(store.concurrent_state_mut())?;
3722 if let Some(Event::Subtask {
3723 status: status @ (Status::Returned | Status::ReturnCancelled),
3724 }) = event
3725 {
3726 Ok(status as u32)
3727 } else {
3728 bail!(Trap::SubtaskCancelAfterTerminal);
3729 }
3730 }
3731
3732 pub(crate) fn context_get(self, store: &mut StoreOpaque, slot: u32) -> Result<u32> {
3733 store.concurrent_state_mut().context_get(slot)
3734 }
3735
3736 pub(crate) fn context_set(self, store: &mut StoreOpaque, slot: u32, value: u32) -> Result<()> {
3737 store.concurrent_state_mut().context_set(slot, value)
3738 }
3739}
3740
3741pub trait VMComponentAsyncStore {
3749 unsafe fn prepare_call(
3755 &mut self,
3756 instance: Instance,
3757 memory: *mut VMMemoryDefinition,
3758 start: NonNull<VMFuncRef>,
3759 return_: NonNull<VMFuncRef>,
3760 caller_instance: RuntimeComponentInstanceIndex,
3761 callee_instance: RuntimeComponentInstanceIndex,
3762 task_return_type: TypeTupleIndex,
3763 callee_async: bool,
3764 string_encoding: StringEncoding,
3765 result_count: u32,
3766 storage: *mut ValRaw,
3767 storage_len: usize,
3768 ) -> Result<()>;
3769
3770 unsafe fn sync_start(
3773 &mut self,
3774 instance: Instance,
3775 callback: *mut VMFuncRef,
3776 callee: NonNull<VMFuncRef>,
3777 param_count: u32,
3778 storage: *mut MaybeUninit<ValRaw>,
3779 storage_len: usize,
3780 ) -> Result<()>;
3781
3782 unsafe fn async_start(
3785 &mut self,
3786 instance: Instance,
3787 callback: *mut VMFuncRef,
3788 post_return: *mut VMFuncRef,
3789 callee: NonNull<VMFuncRef>,
3790 param_count: u32,
3791 result_count: u32,
3792 flags: u32,
3793 ) -> Result<u32>;
3794
3795 fn future_write(
3797 &mut self,
3798 instance: Instance,
3799 caller: RuntimeComponentInstanceIndex,
3800 ty: TypeFutureTableIndex,
3801 options: OptionsIndex,
3802 future: u32,
3803 address: u32,
3804 ) -> Result<u32>;
3805
3806 fn future_read(
3808 &mut self,
3809 instance: Instance,
3810 caller: RuntimeComponentInstanceIndex,
3811 ty: TypeFutureTableIndex,
3812 options: OptionsIndex,
3813 future: u32,
3814 address: u32,
3815 ) -> Result<u32>;
3816
3817 fn future_drop_writable(
3819 &mut self,
3820 instance: Instance,
3821 ty: TypeFutureTableIndex,
3822 writer: u32,
3823 ) -> Result<()>;
3824
3825 fn stream_write(
3827 &mut self,
3828 instance: Instance,
3829 caller: RuntimeComponentInstanceIndex,
3830 ty: TypeStreamTableIndex,
3831 options: OptionsIndex,
3832 stream: u32,
3833 address: u32,
3834 count: u32,
3835 ) -> Result<u32>;
3836
3837 fn stream_read(
3839 &mut self,
3840 instance: Instance,
3841 caller: RuntimeComponentInstanceIndex,
3842 ty: TypeStreamTableIndex,
3843 options: OptionsIndex,
3844 stream: u32,
3845 address: u32,
3846 count: u32,
3847 ) -> Result<u32>;
3848
3849 fn flat_stream_write(
3852 &mut self,
3853 instance: Instance,
3854 caller: RuntimeComponentInstanceIndex,
3855 ty: TypeStreamTableIndex,
3856 options: OptionsIndex,
3857 payload_size: u32,
3858 payload_align: u32,
3859 stream: u32,
3860 address: u32,
3861 count: u32,
3862 ) -> Result<u32>;
3863
3864 fn flat_stream_read(
3867 &mut self,
3868 instance: Instance,
3869 caller: RuntimeComponentInstanceIndex,
3870 ty: TypeStreamTableIndex,
3871 options: OptionsIndex,
3872 payload_size: u32,
3873 payload_align: u32,
3874 stream: u32,
3875 address: u32,
3876 count: u32,
3877 ) -> Result<u32>;
3878
3879 fn stream_drop_writable(
3881 &mut self,
3882 instance: Instance,
3883 ty: TypeStreamTableIndex,
3884 writer: u32,
3885 ) -> Result<()>;
3886
3887 fn error_context_debug_message(
3889 &mut self,
3890 instance: Instance,
3891 ty: TypeComponentLocalErrorContextTableIndex,
3892 options: OptionsIndex,
3893 err_ctx_handle: u32,
3894 debug_msg_address: u32,
3895 ) -> Result<()>;
3896
3897 fn thread_new_indirect(
3899 &mut self,
3900 instance: Instance,
3901 caller: RuntimeComponentInstanceIndex,
3902 func_ty_idx: TypeFuncIndex,
3903 start_func_table_idx: RuntimeTableIndex,
3904 start_func_idx: u32,
3905 context: i32,
3906 ) -> Result<u32>;
3907}
3908
3909impl<T: 'static> VMComponentAsyncStore for StoreInner<T> {
3911 unsafe fn prepare_call(
3912 &mut self,
3913 instance: Instance,
3914 memory: *mut VMMemoryDefinition,
3915 start: NonNull<VMFuncRef>,
3916 return_: NonNull<VMFuncRef>,
3917 caller_instance: RuntimeComponentInstanceIndex,
3918 callee_instance: RuntimeComponentInstanceIndex,
3919 task_return_type: TypeTupleIndex,
3920 callee_async: bool,
3921 string_encoding: StringEncoding,
3922 result_count_or_max_if_async: u32,
3923 storage: *mut ValRaw,
3924 storage_len: usize,
3925 ) -> Result<()> {
3926 let params = unsafe { std::slice::from_raw_parts(storage, storage_len) }.to_vec();
3930
3931 unsafe {
3932 instance.prepare_call(
3933 StoreContextMut(self),
3934 start,
3935 return_,
3936 caller_instance,
3937 callee_instance,
3938 task_return_type,
3939 callee_async,
3940 memory,
3941 string_encoding,
3942 match result_count_or_max_if_async {
3943 PREPARE_ASYNC_NO_RESULT => CallerInfo::Async {
3944 params,
3945 has_result: false,
3946 },
3947 PREPARE_ASYNC_WITH_RESULT => CallerInfo::Async {
3948 params,
3949 has_result: true,
3950 },
3951 result_count => CallerInfo::Sync {
3952 params,
3953 result_count,
3954 },
3955 },
3956 )
3957 }
3958 }
3959
3960 unsafe fn sync_start(
3961 &mut self,
3962 instance: Instance,
3963 callback: *mut VMFuncRef,
3964 callee: NonNull<VMFuncRef>,
3965 param_count: u32,
3966 storage: *mut MaybeUninit<ValRaw>,
3967 storage_len: usize,
3968 ) -> Result<()> {
3969 unsafe {
3970 instance
3971 .start_call(
3972 StoreContextMut(self),
3973 callback,
3974 ptr::null_mut(),
3975 callee,
3976 param_count,
3977 1,
3978 START_FLAG_ASYNC_CALLEE,
3979 Some(std::slice::from_raw_parts_mut(storage, storage_len)),
3983 )
3984 .map(drop)
3985 }
3986 }
3987
3988 unsafe fn async_start(
3989 &mut self,
3990 instance: Instance,
3991 callback: *mut VMFuncRef,
3992 post_return: *mut VMFuncRef,
3993 callee: NonNull<VMFuncRef>,
3994 param_count: u32,
3995 result_count: u32,
3996 flags: u32,
3997 ) -> Result<u32> {
3998 unsafe {
3999 instance.start_call(
4000 StoreContextMut(self),
4001 callback,
4002 post_return,
4003 callee,
4004 param_count,
4005 result_count,
4006 flags,
4007 None,
4008 )
4009 }
4010 }
4011
4012 fn future_write(
4013 &mut self,
4014 instance: Instance,
4015 caller: RuntimeComponentInstanceIndex,
4016 ty: TypeFutureTableIndex,
4017 options: OptionsIndex,
4018 future: u32,
4019 address: u32,
4020 ) -> Result<u32> {
4021 instance
4022 .guest_write(
4023 StoreContextMut(self),
4024 caller,
4025 TransmitIndex::Future(ty),
4026 options,
4027 None,
4028 future,
4029 address,
4030 1,
4031 )
4032 .map(|result| result.encode())
4033 }
4034
4035 fn future_read(
4036 &mut self,
4037 instance: Instance,
4038 caller: RuntimeComponentInstanceIndex,
4039 ty: TypeFutureTableIndex,
4040 options: OptionsIndex,
4041 future: u32,
4042 address: u32,
4043 ) -> Result<u32> {
4044 instance
4045 .guest_read(
4046 StoreContextMut(self),
4047 caller,
4048 TransmitIndex::Future(ty),
4049 options,
4050 None,
4051 future,
4052 address,
4053 1,
4054 )
4055 .map(|result| result.encode())
4056 }
4057
4058 fn stream_write(
4059 &mut self,
4060 instance: Instance,
4061 caller: RuntimeComponentInstanceIndex,
4062 ty: TypeStreamTableIndex,
4063 options: OptionsIndex,
4064 stream: u32,
4065 address: u32,
4066 count: u32,
4067 ) -> Result<u32> {
4068 instance
4069 .guest_write(
4070 StoreContextMut(self),
4071 caller,
4072 TransmitIndex::Stream(ty),
4073 options,
4074 None,
4075 stream,
4076 address,
4077 count,
4078 )
4079 .map(|result| result.encode())
4080 }
4081
4082 fn stream_read(
4083 &mut self,
4084 instance: Instance,
4085 caller: RuntimeComponentInstanceIndex,
4086 ty: TypeStreamTableIndex,
4087 options: OptionsIndex,
4088 stream: u32,
4089 address: u32,
4090 count: u32,
4091 ) -> Result<u32> {
4092 instance
4093 .guest_read(
4094 StoreContextMut(self),
4095 caller,
4096 TransmitIndex::Stream(ty),
4097 options,
4098 None,
4099 stream,
4100 address,
4101 count,
4102 )
4103 .map(|result| result.encode())
4104 }
4105
4106 fn future_drop_writable(
4107 &mut self,
4108 instance: Instance,
4109 ty: TypeFutureTableIndex,
4110 writer: u32,
4111 ) -> Result<()> {
4112 instance.guest_drop_writable(self, TransmitIndex::Future(ty), writer)
4113 }
4114
4115 fn flat_stream_write(
4116 &mut self,
4117 instance: Instance,
4118 caller: RuntimeComponentInstanceIndex,
4119 ty: TypeStreamTableIndex,
4120 options: OptionsIndex,
4121 payload_size: u32,
4122 payload_align: u32,
4123 stream: u32,
4124 address: u32,
4125 count: u32,
4126 ) -> Result<u32> {
4127 instance
4128 .guest_write(
4129 StoreContextMut(self),
4130 caller,
4131 TransmitIndex::Stream(ty),
4132 options,
4133 Some(FlatAbi {
4134 size: payload_size,
4135 align: payload_align,
4136 }),
4137 stream,
4138 address,
4139 count,
4140 )
4141 .map(|result| result.encode())
4142 }
4143
4144 fn flat_stream_read(
4145 &mut self,
4146 instance: Instance,
4147 caller: RuntimeComponentInstanceIndex,
4148 ty: TypeStreamTableIndex,
4149 options: OptionsIndex,
4150 payload_size: u32,
4151 payload_align: u32,
4152 stream: u32,
4153 address: u32,
4154 count: u32,
4155 ) -> Result<u32> {
4156 instance
4157 .guest_read(
4158 StoreContextMut(self),
4159 caller,
4160 TransmitIndex::Stream(ty),
4161 options,
4162 Some(FlatAbi {
4163 size: payload_size,
4164 align: payload_align,
4165 }),
4166 stream,
4167 address,
4168 count,
4169 )
4170 .map(|result| result.encode())
4171 }
4172
4173 fn stream_drop_writable(
4174 &mut self,
4175 instance: Instance,
4176 ty: TypeStreamTableIndex,
4177 writer: u32,
4178 ) -> Result<()> {
4179 instance.guest_drop_writable(self, TransmitIndex::Stream(ty), writer)
4180 }
4181
4182 fn error_context_debug_message(
4183 &mut self,
4184 instance: Instance,
4185 ty: TypeComponentLocalErrorContextTableIndex,
4186 options: OptionsIndex,
4187 err_ctx_handle: u32,
4188 debug_msg_address: u32,
4189 ) -> Result<()> {
4190 instance.error_context_debug_message(
4191 StoreContextMut(self),
4192 ty,
4193 options,
4194 err_ctx_handle,
4195 debug_msg_address,
4196 )
4197 }
4198
4199 fn thread_new_indirect(
4200 &mut self,
4201 instance: Instance,
4202 caller: RuntimeComponentInstanceIndex,
4203 func_ty_idx: TypeFuncIndex,
4204 start_func_table_idx: RuntimeTableIndex,
4205 start_func_idx: u32,
4206 context: i32,
4207 ) -> Result<u32> {
4208 instance.thread_new_indirect(
4209 StoreContextMut(self),
4210 caller,
4211 func_ty_idx,
4212 start_func_table_idx,
4213 start_func_idx,
4214 context,
4215 )
4216 }
4217}
4218
4219type HostTaskFuture = Pin<Box<dyn Future<Output = Result<()>> + Send + 'static>>;
4220
4221pub(crate) struct HostTask {
4225 common: WaitableCommon,
4226
4227 caller: QualifiedThreadId,
4229
4230 call_context: CallContext,
4233
4234 state: HostTaskState,
4235}
4236
4237enum HostTaskState {
4238 CalleeStarted,
4243
4244 CalleeRunning(JoinHandle),
4249
4250 CalleeFinished(LiftedResult),
4254
4255 CalleeDone,
4258}
4259
4260impl HostTask {
4261 fn new(caller: QualifiedThreadId, state: HostTaskState) -> Self {
4262 Self {
4263 common: WaitableCommon::default(),
4264 call_context: CallContext::default(),
4265 caller,
4266 state,
4267 }
4268 }
4269}
4270
4271impl TableDebug for HostTask {
4272 fn type_name() -> &'static str {
4273 "HostTask"
4274 }
4275}
4276
4277type CallbackFn = Box<dyn Fn(&mut dyn VMStore, Event, u32) -> Result<u32> + Send + Sync + 'static>;
4278
4279enum Caller {
4281 Host {
4283 tx: Option<oneshot::Sender<LiftedResult>>,
4285 host_future_present: bool,
4288 caller: CurrentThread,
4292 },
4293 Guest {
4295 thread: QualifiedThreadId,
4297 },
4298}
4299
4300struct LiftResult {
4303 lift: RawLift,
4304 ty: TypeTupleIndex,
4305 memory: Option<SendSyncPtr<VMMemoryDefinition>>,
4306 string_encoding: StringEncoding,
4307}
4308
4309#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
4314pub(crate) struct QualifiedThreadId {
4315 task: TableId<GuestTask>,
4316 thread: TableId<GuestThread>,
4317}
4318
4319impl QualifiedThreadId {
4320 fn qualify(
4321 state: &mut ConcurrentState,
4322 thread: TableId<GuestThread>,
4323 ) -> Result<QualifiedThreadId> {
4324 Ok(QualifiedThreadId {
4325 task: state.get_mut(thread)?.parent_task,
4326 thread,
4327 })
4328 }
4329}
4330
4331impl fmt::Debug for QualifiedThreadId {
4332 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4333 f.debug_tuple("QualifiedThreadId")
4334 .field(&self.task.rep())
4335 .field(&self.thread.rep())
4336 .finish()
4337 }
4338}
4339
4340enum GuestThreadState {
4341 NotStartedImplicit,
4342 NotStartedExplicit(
4343 Box<dyn FnOnce(&mut dyn VMStore, QualifiedThreadId) -> Result<()> + Send + Sync>,
4344 ),
4345 Running,
4346 Suspended(StoreFiber<'static>),
4347 Ready(StoreFiber<'static>),
4348 Completed,
4349}
4350pub struct GuestThread {
4351 context: [u32; 2],
4354 parent_task: TableId<GuestTask>,
4356 wake_on_cancel: Option<TableId<WaitableSet>>,
4359 state: GuestThreadState,
4361 instance_rep: Option<u32>,
4364 sync_call_set: TableId<WaitableSet>,
4366}
4367
4368impl GuestThread {
4369 fn from_instance(
4372 state: Pin<&mut ComponentInstance>,
4373 caller_instance: RuntimeComponentInstanceIndex,
4374 guest_thread: u32,
4375 ) -> Result<TableId<Self>> {
4376 let rep = state.instance_states().0[caller_instance]
4377 .thread_handle_table()
4378 .guest_thread_rep(guest_thread)?;
4379 Ok(TableId::new(rep))
4380 }
4381
4382 fn new_implicit(state: &mut ConcurrentState, parent_task: TableId<GuestTask>) -> Result<Self> {
4383 let sync_call_set = state.push(WaitableSet::default())?;
4384 Ok(Self {
4385 context: [0; 2],
4386 parent_task,
4387 wake_on_cancel: None,
4388 state: GuestThreadState::NotStartedImplicit,
4389 instance_rep: None,
4390 sync_call_set,
4391 })
4392 }
4393
4394 fn new_explicit(
4395 state: &mut ConcurrentState,
4396 parent_task: TableId<GuestTask>,
4397 start_func: Box<
4398 dyn FnOnce(&mut dyn VMStore, QualifiedThreadId) -> Result<()> + Send + Sync,
4399 >,
4400 ) -> Result<Self> {
4401 let sync_call_set = state.push(WaitableSet::default())?;
4402 Ok(Self {
4403 context: [0; 2],
4404 parent_task,
4405 wake_on_cancel: None,
4406 state: GuestThreadState::NotStartedExplicit(start_func),
4407 instance_rep: None,
4408 sync_call_set,
4409 })
4410 }
4411}
4412
4413impl TableDebug for GuestThread {
4414 fn type_name() -> &'static str {
4415 "GuestThread"
4416 }
4417}
4418
4419enum SyncResult {
4420 NotProduced,
4421 Produced(Option<ValRaw>),
4422 Taken,
4423}
4424
4425impl SyncResult {
4426 fn take(&mut self) -> Result<Option<Option<ValRaw>>> {
4427 Ok(match mem::replace(self, SyncResult::Taken) {
4428 SyncResult::NotProduced => None,
4429 SyncResult::Produced(val) => Some(val),
4430 SyncResult::Taken => {
4431 bail_bug!("attempted to take a synchronous result that was already taken")
4432 }
4433 })
4434 }
4435}
4436
4437#[derive(Debug)]
4438enum HostFutureState {
4439 NotApplicable,
4440 Live,
4441 Dropped,
4442}
4443
4444pub(crate) struct GuestTask {
4446 common: WaitableCommon,
4448 lower_params: Option<RawLower>,
4450 lift_result: Option<LiftResult>,
4452 result: Option<LiftedResult>,
4455 callback: Option<CallbackFn>,
4458 caller: Caller,
4460 call_context: CallContext,
4465 sync_result: SyncResult,
4468 cancel_sent: bool,
4471 starting_sent: bool,
4474 instance: RuntimeInstance,
4481 event: Option<Event>,
4484 exited: bool,
4486 threads: HashSet<TableId<GuestThread>>,
4488 host_future_state: HostFutureState,
4491 async_function: bool,
4494}
4495
4496impl GuestTask {
4497 fn already_lowered_parameters(&self) -> bool {
4498 self.lower_params.is_none()
4500 }
4501
4502 fn returned_or_cancelled(&self) -> bool {
4503 self.lift_result.is_none()
4505 }
4506
4507 fn ready_to_delete(&self) -> bool {
4508 let threads_completed = self.threads.is_empty();
4509 let has_sync_result = matches!(self.sync_result, SyncResult::Produced(_));
4510 let pending_completion_event = matches!(
4511 self.common.event,
4512 Some(Event::Subtask {
4513 status: Status::Returned | Status::ReturnCancelled
4514 })
4515 );
4516 let ready = threads_completed
4517 && !has_sync_result
4518 && !pending_completion_event
4519 && !matches!(self.host_future_state, HostFutureState::Live);
4520 log::trace!(
4521 "ready to delete? {ready} (threads_completed: {}, has_sync_result: {}, pending_completion_event: {}, host_future_state: {:?})",
4522 threads_completed,
4523 has_sync_result,
4524 pending_completion_event,
4525 self.host_future_state
4526 );
4527 ready
4528 }
4529
4530 fn new(
4531 lower_params: RawLower,
4532 lift_result: LiftResult,
4533 caller: Caller,
4534 callback: Option<CallbackFn>,
4535 instance: RuntimeInstance,
4536 async_function: bool,
4537 ) -> Result<Self> {
4538 let host_future_state = match &caller {
4539 Caller::Guest { .. } => HostFutureState::NotApplicable,
4540 Caller::Host {
4541 host_future_present,
4542 ..
4543 } => {
4544 if *host_future_present {
4545 HostFutureState::Live
4546 } else {
4547 HostFutureState::NotApplicable
4548 }
4549 }
4550 };
4551 Ok(Self {
4552 common: WaitableCommon::default(),
4553 lower_params: Some(lower_params),
4554 lift_result: Some(lift_result),
4555 result: None,
4556 callback,
4557 caller,
4558 call_context: CallContext::default(),
4559 sync_result: SyncResult::NotProduced,
4560 cancel_sent: false,
4561 starting_sent: false,
4562 instance,
4563 event: None,
4564 exited: false,
4565 threads: HashSet::new(),
4566 host_future_state,
4567 async_function,
4568 })
4569 }
4570
4571 fn dispose(self, _state: &mut ConcurrentState) -> Result<()> {
4573 assert!(self.threads.is_empty());
4574 Ok(())
4575 }
4576}
4577
4578impl TableDebug for GuestTask {
4579 fn type_name() -> &'static str {
4580 "GuestTask"
4581 }
4582}
4583
4584#[derive(Default)]
4586struct WaitableCommon {
4587 event: Option<Event>,
4589 set: Option<TableId<WaitableSet>>,
4591 handle: Option<u32>,
4593}
4594
4595#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
4597enum Waitable {
4598 Host(TableId<HostTask>),
4600 Guest(TableId<GuestTask>),
4602 Transmit(TableId<TransmitHandle>),
4604}
4605
4606impl Waitable {
4607 fn from_instance(
4610 state: Pin<&mut ComponentInstance>,
4611 caller_instance: RuntimeComponentInstanceIndex,
4612 waitable: u32,
4613 ) -> Result<Self> {
4614 use crate::runtime::vm::component::Waitable;
4615
4616 let (waitable, kind) = state.instance_states().0[caller_instance]
4617 .handle_table()
4618 .waitable_rep(waitable)?;
4619
4620 Ok(match kind {
4621 Waitable::Subtask { is_host: true } => Self::Host(TableId::new(waitable)),
4622 Waitable::Subtask { is_host: false } => Self::Guest(TableId::new(waitable)),
4623 Waitable::Stream | Waitable::Future => Self::Transmit(TableId::new(waitable)),
4624 })
4625 }
4626
4627 fn rep(&self) -> u32 {
4629 match self {
4630 Self::Host(id) => id.rep(),
4631 Self::Guest(id) => id.rep(),
4632 Self::Transmit(id) => id.rep(),
4633 }
4634 }
4635
4636 fn join(&self, state: &mut ConcurrentState, set: Option<TableId<WaitableSet>>) -> Result<()> {
4640 log::trace!("waitable {self:?} join set {set:?}",);
4641
4642 let old = mem::replace(&mut self.common(state)?.set, set);
4643
4644 if let Some(old) = old {
4645 match *self {
4646 Waitable::Host(id) => state.remove_child(id, old),
4647 Waitable::Guest(id) => state.remove_child(id, old),
4648 Waitable::Transmit(id) => state.remove_child(id, old),
4649 }?;
4650
4651 state.get_mut(old)?.ready.remove(self);
4652 }
4653
4654 if let Some(set) = set {
4655 match *self {
4656 Waitable::Host(id) => state.add_child(id, set),
4657 Waitable::Guest(id) => state.add_child(id, set),
4658 Waitable::Transmit(id) => state.add_child(id, set),
4659 }?;
4660
4661 if self.common(state)?.event.is_some() {
4662 self.mark_ready(state)?;
4663 }
4664 }
4665
4666 Ok(())
4667 }
4668
4669 fn common<'a>(&self, state: &'a mut ConcurrentState) -> Result<&'a mut WaitableCommon> {
4671 Ok(match self {
4672 Self::Host(id) => &mut state.get_mut(*id)?.common,
4673 Self::Guest(id) => &mut state.get_mut(*id)?.common,
4674 Self::Transmit(id) => &mut state.get_mut(*id)?.common,
4675 })
4676 }
4677
4678 fn set_event(&self, state: &mut ConcurrentState, event: Option<Event>) -> Result<()> {
4682 log::trace!("set event for {self:?}: {event:?}");
4683 self.common(state)?.event = event;
4684 self.mark_ready(state)
4685 }
4686
4687 fn take_event(&self, state: &mut ConcurrentState) -> Result<Option<Event>> {
4689 let common = self.common(state)?;
4690 let event = common.event.take();
4691 if let Some(set) = self.common(state)?.set {
4692 state.get_mut(set)?.ready.remove(self);
4693 }
4694
4695 Ok(event)
4696 }
4697
4698 fn mark_ready(&self, state: &mut ConcurrentState) -> Result<()> {
4702 if let Some(set) = self.common(state)?.set {
4703 state.get_mut(set)?.ready.insert(*self);
4704 if let Some((thread, mode)) = state.get_mut(set)?.waiting.pop_first() {
4705 let wake_on_cancel = state.get_mut(thread.thread)?.wake_on_cancel.take();
4706 assert!(wake_on_cancel.is_none() || wake_on_cancel == Some(set));
4707
4708 let item = match mode {
4709 WaitMode::Fiber(fiber) => WorkItem::ResumeFiber(fiber),
4710 WaitMode::Callback(instance) => WorkItem::GuestCall(
4711 state.get_mut(thread.task)?.instance.index,
4712 GuestCall {
4713 thread,
4714 kind: GuestCallKind::DeliverEvent {
4715 instance,
4716 set: Some(set),
4717 },
4718 },
4719 ),
4720 };
4721 state.push_high_priority(item);
4722 }
4723 }
4724 Ok(())
4725 }
4726
4727 fn delete_from(&self, state: &mut ConcurrentState) -> Result<()> {
4729 match self {
4730 Self::Host(task) => {
4731 log::trace!("delete host task {task:?}");
4732 state.delete(*task)?;
4733 }
4734 Self::Guest(task) => {
4735 log::trace!("delete guest task {task:?}");
4736 state.delete(*task)?.dispose(state)?;
4737 }
4738 Self::Transmit(task) => {
4739 state.delete(*task)?;
4740 }
4741 }
4742
4743 Ok(())
4744 }
4745}
4746
4747impl fmt::Debug for Waitable {
4748 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
4749 match self {
4750 Self::Host(id) => write!(f, "{id:?}"),
4751 Self::Guest(id) => write!(f, "{id:?}"),
4752 Self::Transmit(id) => write!(f, "{id:?}"),
4753 }
4754 }
4755}
4756
4757#[derive(Default)]
4759struct WaitableSet {
4760 ready: BTreeSet<Waitable>,
4762 waiting: BTreeMap<QualifiedThreadId, WaitMode>,
4764}
4765
4766impl TableDebug for WaitableSet {
4767 fn type_name() -> &'static str {
4768 "WaitableSet"
4769 }
4770}
4771
4772type RawLower =
4774 Box<dyn FnOnce(&mut dyn VMStore, &mut [MaybeUninit<ValRaw>]) -> Result<()> + Send + Sync>;
4775
4776type RawLift = Box<
4778 dyn FnOnce(&mut dyn VMStore, &[ValRaw]) -> Result<Box<dyn Any + Send + Sync>> + Send + Sync,
4779>;
4780
4781type LiftedResult = Box<dyn Any + Send + Sync>;
4785
4786struct DummyResult;
4789
4790#[derive(Default)]
4792pub struct ConcurrentInstanceState {
4793 backpressure: u16,
4795 do_not_enter: bool,
4797 pending: BTreeMap<QualifiedThreadId, GuestCallKind>,
4800}
4801
4802impl ConcurrentInstanceState {
4803 pub fn pending_is_empty(&self) -> bool {
4804 self.pending.is_empty()
4805 }
4806}
4807
4808#[derive(Debug, Copy, Clone)]
4809pub(crate) enum CurrentThread {
4810 Guest(QualifiedThreadId),
4811 Host(TableId<HostTask>),
4812 None,
4813}
4814
4815impl CurrentThread {
4816 fn guest(&self) -> Option<&QualifiedThreadId> {
4817 match self {
4818 Self::Guest(id) => Some(id),
4819 _ => None,
4820 }
4821 }
4822
4823 fn host(&self) -> Option<TableId<HostTask>> {
4824 match self {
4825 Self::Host(id) => Some(*id),
4826 _ => None,
4827 }
4828 }
4829
4830 fn is_none(&self) -> bool {
4831 matches!(self, Self::None)
4832 }
4833}
4834
4835impl From<QualifiedThreadId> for CurrentThread {
4836 fn from(id: QualifiedThreadId) -> Self {
4837 Self::Guest(id)
4838 }
4839}
4840
4841impl From<TableId<HostTask>> for CurrentThread {
4842 fn from(id: TableId<HostTask>) -> Self {
4843 Self::Host(id)
4844 }
4845}
4846
4847pub struct ConcurrentState {
4849 current_thread: CurrentThread,
4851
4852 futures: AlwaysMut<Option<FuturesUnordered<HostTaskFuture>>>,
4857 table: AlwaysMut<ResourceTable>,
4859 high_priority: Vec<WorkItem>,
4861 low_priority: VecDeque<WorkItem>,
4863 suspend_reason: Option<SuspendReason>,
4867 worker: Option<StoreFiber<'static>>,
4871 worker_item: Option<WorkerItem>,
4873
4874 global_error_context_ref_counts:
4887 BTreeMap<TypeComponentGlobalErrorContextTableIndex, GlobalErrorContextRefCount>,
4888}
4889
4890impl Default for ConcurrentState {
4891 fn default() -> Self {
4892 Self {
4893 current_thread: CurrentThread::None,
4894 table: AlwaysMut::new(ResourceTable::new()),
4895 futures: AlwaysMut::new(Some(FuturesUnordered::new())),
4896 high_priority: Vec::new(),
4897 low_priority: VecDeque::new(),
4898 suspend_reason: None,
4899 worker: None,
4900 worker_item: None,
4901 global_error_context_ref_counts: BTreeMap::new(),
4902 }
4903 }
4904}
4905
4906impl ConcurrentState {
4907 pub(crate) fn take_fibers_and_futures(
4924 &mut self,
4925 fibers: &mut Vec<StoreFiber<'static>>,
4926 futures: &mut Vec<FuturesUnordered<HostTaskFuture>>,
4927 ) {
4928 for entry in self.table.get_mut().iter_mut() {
4929 if let Some(set) = entry.downcast_mut::<WaitableSet>() {
4930 for mode in mem::take(&mut set.waiting).into_values() {
4931 if let WaitMode::Fiber(fiber) = mode {
4932 fibers.push(fiber);
4933 }
4934 }
4935 } else if let Some(thread) = entry.downcast_mut::<GuestThread>() {
4936 if let GuestThreadState::Suspended(fiber) | GuestThreadState::Ready(fiber) =
4937 mem::replace(&mut thread.state, GuestThreadState::Completed)
4938 {
4939 fibers.push(fiber);
4940 }
4941 }
4942 }
4943
4944 if let Some(fiber) = self.worker.take() {
4945 fibers.push(fiber);
4946 }
4947
4948 let mut handle_item = |item| match item {
4949 WorkItem::ResumeFiber(fiber) => {
4950 fibers.push(fiber);
4951 }
4952 WorkItem::PushFuture(future) => {
4953 self.futures
4954 .get_mut()
4955 .as_mut()
4956 .unwrap()
4957 .push(future.into_inner());
4958 }
4959 WorkItem::ResumeThread(..) | WorkItem::GuestCall(..) | WorkItem::WorkerFunction(..) => {
4960 }
4961 };
4962
4963 for item in mem::take(&mut self.high_priority) {
4964 handle_item(item);
4965 }
4966 for item in mem::take(&mut self.low_priority) {
4967 handle_item(item);
4968 }
4969
4970 if let Some(them) = self.futures.get_mut().take() {
4971 futures.push(them);
4972 }
4973 }
4974
4975 fn collect_work_items_to_run(&mut self) -> Vec<WorkItem> {
4979 let mut ready = mem::take(&mut self.high_priority);
4980 if ready.is_empty() {
4981 if let Some(item) = self.low_priority.pop_back() {
4982 ready.push(item);
4983 }
4984 }
4985 ready
4986 }
4987
4988 fn push<V: Send + Sync + 'static>(
4989 &mut self,
4990 value: V,
4991 ) -> Result<TableId<V>, ResourceTableError> {
4992 self.table.get_mut().push(value).map(TableId::from)
4993 }
4994
4995 fn get_mut<V: 'static>(&mut self, id: TableId<V>) -> Result<&mut V, ResourceTableError> {
4996 self.table.get_mut().get_mut(&Resource::from(id))
4997 }
4998
4999 pub fn add_child<T: 'static, U: 'static>(
5000 &mut self,
5001 child: TableId<T>,
5002 parent: TableId<U>,
5003 ) -> Result<(), ResourceTableError> {
5004 self.table
5005 .get_mut()
5006 .add_child(Resource::from(child), Resource::from(parent))
5007 }
5008
5009 pub fn remove_child<T: 'static, U: 'static>(
5010 &mut self,
5011 child: TableId<T>,
5012 parent: TableId<U>,
5013 ) -> Result<(), ResourceTableError> {
5014 self.table
5015 .get_mut()
5016 .remove_child(Resource::from(child), Resource::from(parent))
5017 }
5018
5019 fn delete<V: 'static>(&mut self, id: TableId<V>) -> Result<V, ResourceTableError> {
5020 self.table.get_mut().delete(Resource::from(id))
5021 }
5022
5023 fn push_future(&mut self, future: HostTaskFuture) {
5024 self.push_high_priority(WorkItem::PushFuture(AlwaysMut::new(future)));
5031 }
5032
5033 fn push_high_priority(&mut self, item: WorkItem) {
5034 log::trace!("push high priority: {item:?}");
5035 self.high_priority.push(item);
5036 }
5037
5038 fn push_low_priority(&mut self, item: WorkItem) {
5039 log::trace!("push low priority: {item:?}");
5040 self.low_priority.push_front(item);
5041 }
5042
5043 fn push_work_item(&mut self, item: WorkItem, high_priority: bool) {
5044 if high_priority {
5045 self.push_high_priority(item);
5046 } else {
5047 self.push_low_priority(item);
5048 }
5049 }
5050
5051 fn promote_instance_local_thread_work_item(
5052 &mut self,
5053 current_instance: RuntimeComponentInstanceIndex,
5054 ) -> bool {
5055 self.promote_work_items_matching(|item: &WorkItem| match item {
5056 WorkItem::ResumeThread(instance, _) | WorkItem::GuestCall(instance, _) => {
5057 *instance == current_instance
5058 }
5059 _ => false,
5060 })
5061 }
5062
5063 fn promote_thread_work_item(&mut self, thread: QualifiedThreadId) -> bool {
5064 self.promote_work_items_matching(|item: &WorkItem| match item {
5065 WorkItem::ResumeThread(_, t) | WorkItem::GuestCall(_, GuestCall { thread: t, .. }) => {
5066 *t == thread
5067 }
5068 _ => false,
5069 })
5070 }
5071
5072 fn promote_work_items_matching<F>(&mut self, mut predicate: F) -> bool
5073 where
5074 F: FnMut(&WorkItem) -> bool,
5075 {
5076 if self.high_priority.iter().any(&mut predicate) {
5080 true
5081 }
5082 else if let Some(idx) = self.low_priority.iter().position(&mut predicate) {
5085 let item = self.low_priority.remove(idx).unwrap();
5086 self.push_high_priority(item);
5087 true
5088 } else {
5089 false
5090 }
5091 }
5092
5093 pub(crate) fn context_get(&mut self, slot: u32) -> Result<u32> {
5095 let thread = self.current_guest_thread()?;
5096 let val = self.get_mut(thread.thread)?.context[usize::try_from(slot)?];
5097 log::trace!("context_get {thread:?} slot {slot} val {val:#x}");
5098 Ok(val)
5099 }
5100
5101 pub(crate) fn context_set(&mut self, slot: u32, val: u32) -> Result<()> {
5103 let thread = self.current_guest_thread()?;
5104 log::trace!("context_set {thread:?} slot {slot} val {val:#x}");
5105 self.get_mut(thread.thread)?.context[usize::try_from(slot)?] = val;
5106 Ok(())
5107 }
5108
5109 fn take_pending_cancellation(&mut self) -> Result<bool> {
5112 let thread = self.current_guest_thread()?;
5113 if let Some(event) = self.get_mut(thread.task)?.event.take() {
5114 assert!(matches!(event, Event::Cancelled));
5115 Ok(true)
5116 } else {
5117 Ok(false)
5118 }
5119 }
5120
5121 fn check_blocking_for(&mut self, task: TableId<GuestTask>) -> Result<()> {
5122 if self.may_block(task)? {
5123 Ok(())
5124 } else {
5125 Err(Trap::CannotBlockSyncTask.into())
5126 }
5127 }
5128
5129 fn may_block(&mut self, task: TableId<GuestTask>) -> Result<bool> {
5130 let task = self.get_mut(task)?;
5131 Ok(task.async_function || task.returned_or_cancelled())
5132 }
5133
5134 pub fn call_context(&mut self, task: u32) -> &mut CallContext {
5140 let (task, is_host) = (task >> 1, task & 1 == 1);
5141 if is_host {
5142 let task: TableId<HostTask> = TableId::new(task);
5143 &mut self.get_mut(task).unwrap().call_context
5144 } else {
5145 let task: TableId<GuestTask> = TableId::new(task);
5146 &mut self.get_mut(task).unwrap().call_context
5147 }
5148 }
5149
5150 pub fn current_call_context_scope_id(&self) -> u32 {
5153 let (bits, is_host) = match self.current_thread {
5154 CurrentThread::Guest(id) => (id.task.rep(), false),
5155 CurrentThread::Host(id) => (id.rep(), true),
5156 CurrentThread::None => unreachable!(),
5157 };
5158 assert_eq!((bits << 1) >> 1, bits);
5159 (bits << 1) | u32::from(is_host)
5160 }
5161
5162 fn current_guest_thread(&self) -> Result<QualifiedThreadId> {
5163 match self.current_thread.guest() {
5164 Some(id) => Ok(*id),
5165 None => bail_bug!("current thread is not a guest thread"),
5166 }
5167 }
5168
5169 fn current_host_thread(&self) -> Result<TableId<HostTask>> {
5170 match self.current_thread.host() {
5171 Some(id) => Ok(id),
5172 None => bail_bug!("current thread is not a host thread"),
5173 }
5174 }
5175
5176 fn futures_mut(&mut self) -> Result<&mut FuturesUnordered<HostTaskFuture>> {
5177 match self.futures.get_mut().as_mut() {
5178 Some(f) => Ok(f),
5179 None => bail_bug!("futures field of concurrent state is currently taken"),
5180 }
5181 }
5182
5183 pub(crate) fn table(&mut self) -> &mut ResourceTable {
5184 self.table.get_mut()
5185 }
5186}
5187
5188fn for_any_lower<
5191 F: FnOnce(&mut dyn VMStore, &mut [MaybeUninit<ValRaw>]) -> Result<()> + Send + Sync,
5192>(
5193 fun: F,
5194) -> F {
5195 fun
5196}
5197
5198fn for_any_lift<
5200 F: FnOnce(&mut dyn VMStore, &[ValRaw]) -> Result<Box<dyn Any + Send + Sync>> + Send + Sync,
5201>(
5202 fun: F,
5203) -> F {
5204 fun
5205}
5206
5207fn checked<F: Future + Send + 'static>(
5212 id: StoreId,
5213 fut: F,
5214) -> impl Future<Output = F::Output> + Send + 'static {
5215 async move {
5216 let mut fut = pin!(fut);
5217 future::poll_fn(move |cx| {
5218 let message = "\
5219 `Future`s which depend on asynchronous component tasks, streams, or \
5220 futures to complete may only be polled from the event loop of the \
5221 store to which they belong. Please use \
5222 `StoreContextMut::{run_concurrent,spawn}` to poll or await them.\
5223 ";
5224 tls::try_get(|store| {
5225 let matched = match store {
5226 tls::TryGet::Some(store) => store.id() == id,
5227 tls::TryGet::Taken | tls::TryGet::None => false,
5228 };
5229
5230 if !matched {
5231 panic!("{message}")
5232 }
5233 });
5234 fut.as_mut().poll(cx)
5235 })
5236 .await
5237 }
5238}
5239
5240fn check_recursive_run() {
5243 tls::try_get(|store| {
5244 if !matches!(store, tls::TryGet::None) {
5245 panic!("Recursive `StoreContextMut::run_concurrent` calls not supported")
5246 }
5247 });
5248}
5249
5250fn unpack_callback_code(code: u32) -> (u32, u32) {
5251 (code & 0xF, code >> 4)
5252}
5253
5254struct WaitableCheckParams {
5258 set: TableId<WaitableSet>,
5259 options: OptionsIndex,
5260 payload: u32,
5261}
5262
5263enum WaitableCheck {
5266 Wait,
5267 Poll,
5268}
5269
5270pub(crate) struct PreparedCall<R> {
5272 handle: Func,
5274 thread: QualifiedThreadId,
5276 param_count: usize,
5278 rx: oneshot::Receiver<LiftedResult>,
5281 _phantom: PhantomData<R>,
5282}
5283
5284impl<R> PreparedCall<R> {
5285 pub(crate) fn task_id(&self) -> TaskId {
5287 TaskId {
5288 task: self.thread.task,
5289 }
5290 }
5291}
5292
5293pub(crate) struct TaskId {
5295 task: TableId<GuestTask>,
5296}
5297
5298impl TaskId {
5299 pub(crate) fn host_future_dropped<T>(&self, store: StoreContextMut<T>) -> Result<()> {
5305 let task = store.0.concurrent_state_mut().get_mut(self.task)?;
5306 if !task.already_lowered_parameters() {
5307 Waitable::Guest(self.task).delete_from(store.0.concurrent_state_mut())?
5308 } else {
5309 task.host_future_state = HostFutureState::Dropped;
5310 if task.ready_to_delete() {
5311 Waitable::Guest(self.task).delete_from(store.0.concurrent_state_mut())?
5312 }
5313 }
5314 Ok(())
5315 }
5316}
5317
5318pub(crate) fn prepare_call<T, R>(
5324 mut store: StoreContextMut<T>,
5325 handle: Func,
5326 param_count: usize,
5327 host_future_present: bool,
5328 lower_params: impl FnOnce(Func, StoreContextMut<T>, &mut [MaybeUninit<ValRaw>]) -> Result<()>
5329 + Send
5330 + Sync
5331 + 'static,
5332 lift_result: impl FnOnce(Func, &mut StoreOpaque, &[ValRaw]) -> Result<Box<dyn Any + Send + Sync>>
5333 + Send
5334 + Sync
5335 + 'static,
5336) -> Result<PreparedCall<R>> {
5337 let (options, _flags, ty, raw_options) = handle.abi_info(store.0);
5338
5339 let instance = handle.instance().id().get(store.0);
5340 let options = &instance.component().env_component().options[options];
5341 let ty = &instance.component().types()[ty];
5342 let async_function = ty.async_;
5343 let task_return_type = ty.results;
5344 let component_instance = raw_options.instance;
5345 let callback = options.callback.map(|i| instance.runtime_callback(i));
5346 let memory = options
5347 .memory()
5348 .map(|i| instance.runtime_memory(i))
5349 .map(SendSyncPtr::new);
5350 let string_encoding = options.string_encoding;
5351 let token = StoreToken::new(store.as_context_mut());
5352 let state = store.0.concurrent_state_mut();
5353
5354 let (tx, rx) = oneshot::channel();
5355
5356 let instance = RuntimeInstance {
5357 instance: handle.instance().id().instance(),
5358 index: component_instance,
5359 };
5360 let caller = state.current_thread;
5361 let task = GuestTask::new(
5362 Box::new(for_any_lower(move |store, params| {
5363 lower_params(handle, token.as_context_mut(store), params)
5364 })),
5365 LiftResult {
5366 lift: Box::new(for_any_lift(move |store, result| {
5367 lift_result(handle, store, result)
5368 })),
5369 ty: task_return_type,
5370 memory,
5371 string_encoding,
5372 },
5373 Caller::Host {
5374 tx: Some(tx),
5375 host_future_present,
5376 caller,
5377 },
5378 callback.map(|callback| {
5379 let callback = SendSyncPtr::new(callback);
5380 let instance = handle.instance();
5381 Box::new(move |store: &mut dyn VMStore, event, handle| {
5382 let store = token.as_context_mut(store);
5383 unsafe { instance.call_callback(store, callback, event, handle) }
5386 }) as CallbackFn
5387 }),
5388 instance,
5389 async_function,
5390 )?;
5391
5392 let task = state.push(task)?;
5393 let new_thread = GuestThread::new_implicit(state, task)?;
5394 let thread = state.push(new_thread)?;
5395 state.get_mut(task)?.threads.insert(thread);
5396
5397 if !store.0.may_enter(instance)? {
5398 bail!(Trap::CannotEnterComponent);
5399 }
5400
5401 Ok(PreparedCall {
5402 handle,
5403 thread: QualifiedThreadId { task, thread },
5404 param_count,
5405 rx,
5406 _phantom: PhantomData,
5407 })
5408}
5409
5410pub(crate) fn queue_call<T: 'static, R: Send + 'static>(
5417 mut store: StoreContextMut<T>,
5418 prepared: PreparedCall<R>,
5419) -> Result<impl Future<Output = Result<R>> + Send + 'static + use<T, R>> {
5420 let PreparedCall {
5421 handle,
5422 thread,
5423 param_count,
5424 rx,
5425 ..
5426 } = prepared;
5427
5428 queue_call0(store.as_context_mut(), handle, thread, param_count)?;
5429
5430 Ok(checked(
5431 store.0.id(),
5432 rx.map(move |result| match result {
5433 Ok(r) => match r.downcast() {
5434 Ok(r) => Ok(*r),
5435 Err(_) => bail_bug!("wrong type of value produced"),
5436 },
5437 Err(e) => Err(e.into()),
5438 }),
5439 ))
5440}
5441
5442fn queue_call0<T: 'static>(
5445 store: StoreContextMut<T>,
5446 handle: Func,
5447 guest_thread: QualifiedThreadId,
5448 param_count: usize,
5449) -> Result<()> {
5450 let (_options, _, _ty, raw_options) = handle.abi_info(store.0);
5451 let is_concurrent = raw_options.async_;
5452 let callback = raw_options.callback;
5453 let instance = handle.instance();
5454 let callee = handle.lifted_core_func(store.0);
5455 let post_return = handle.post_return_core_func(store.0);
5456 let callback = callback.map(|i| {
5457 let instance = instance.id().get(store.0);
5458 SendSyncPtr::new(instance.runtime_callback(i))
5459 });
5460
5461 log::trace!("queueing call {guest_thread:?}");
5462
5463 unsafe {
5467 instance.queue_call(
5468 store,
5469 guest_thread,
5470 SendSyncPtr::new(callee),
5471 param_count,
5472 1,
5473 is_concurrent,
5474 callback,
5475 post_return.map(SendSyncPtr::new),
5476 )
5477 }
5478}