1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
// TODO: should be behind a different , tokio specific feature flag.
#[cfg(feature = "sys-thread")]
pub mod tokio;
use std::ops::Deref;
use std::task::{Context, Poll};
use std::{pin::Pin, time::Duration};
use bytes::Bytes;
use futures::future::BoxFuture;
use futures::{Future, TryFutureExt};
use wasmer::{AsStoreMut, AsStoreRef, Memory, MemoryType, Module, Store, StoreMut, StoreRef};
use wasmer_wasix_types::wasi::{Errno, ExitCode};
use crate::os::task::thread::WasiThreadError;
use crate::syscalls::AsyncifyFuture;
use crate::{capture_store_snapshot, StoreSnapshot, WasiEnv, WasiFunctionEnv, WasiThread};
pub use virtual_mio::waker::*;
#[derive(Debug)]
pub enum SpawnMemoryType<'a> {
CreateMemory,
CreateMemoryOfType(MemoryType),
// TODO: is there a way to get rid of the memory reference
ShareMemory(Memory, StoreRef<'a>),
// TODO: is there a way to get rid of the memory reference
// Note: The message sender is triggered once the memory
// has been copied, this makes sure its not modified until
// its been properly copied
CopyMemory(Memory, StoreRef<'a>),
}
pub type WasmResumeTask = dyn FnOnce(WasiFunctionEnv, Store, Bytes) + Send + 'static;
pub type WasmResumeTrigger = dyn FnOnce() -> Pin<Box<dyn Future<Output = Result<Bytes, ExitCode>> + Send + 'static>>
+ Send
+ Sync;
/// The properties passed to the task
#[derive(derive_more::Debug)]
pub struct TaskWasmRunProperties {
pub ctx: WasiFunctionEnv,
pub store: Store,
/// The result of the asynchronous trigger serialized into bytes using the bincode serializer
/// When no trigger is associated with the run operation (i.e. spawning threads) then this will be None.
/// (if the trigger returns an ExitCode then the WASM process will be terminated without resuming)
pub trigger_result: Option<Result<Bytes, ExitCode>>,
/// The instance will be recycled back to this function when the WASM run has finished
#[debug(ignore)]
pub recycle: Option<Box<TaskWasmRecycle>>,
}
/// Callback that will be invoked
pub type TaskWasmRun = dyn FnOnce(TaskWasmRunProperties) + Send + 'static;
/// Callback that will be invoked
pub type TaskExecModule = dyn FnOnce(Module) + Send + 'static;
/// The properties passed to the task
#[derive(Debug)]
pub struct TaskWasmRecycleProperties {
pub env: WasiEnv,
pub memory: Memory,
pub store: Store,
}
/// Callback that will be invoked
pub type TaskWasmRecycle = dyn FnOnce(TaskWasmRecycleProperties) + Send + 'static;
/// Represents a WASM task that will be executed on a dedicated thread
pub struct TaskWasm<'a, 'b> {
pub run: Box<TaskWasmRun>,
pub recycle: Option<Box<TaskWasmRecycle>>,
pub env: WasiEnv,
pub module: Module,
pub globals: Option<&'b StoreSnapshot>,
pub spawn_type: SpawnMemoryType<'a>,
pub trigger: Option<Box<WasmResumeTrigger>>,
pub update_layout: bool,
}
impl<'a, 'b> TaskWasm<'a, 'b> {
pub fn new(run: Box<TaskWasmRun>, env: WasiEnv, module: Module, update_layout: bool) -> Self {
let shared_memory = module.imports().memories().next().map(|a| *a.ty());
Self {
run,
env,
module,
globals: None,
spawn_type: match shared_memory {
Some(ty) => SpawnMemoryType::CreateMemoryOfType(ty),
None => SpawnMemoryType::CreateMemory,
},
trigger: None,
update_layout,
recycle: None,
}
}
pub fn with_memory(mut self, spawn_type: SpawnMemoryType<'a>) -> Self {
self.spawn_type = spawn_type;
self
}
pub fn with_optional_memory(mut self, spawn_type: Option<SpawnMemoryType<'a>>) -> Self {
if let Some(spawn_type) = spawn_type {
self.spawn_type = spawn_type;
}
self
}
pub fn with_globals(mut self, snapshot: &'b StoreSnapshot) -> Self {
self.globals.replace(snapshot);
self
}
pub fn with_trigger(mut self, trigger: Box<WasmResumeTrigger>) -> Self {
self.trigger.replace(trigger);
self
}
pub fn with_recycle(mut self, trigger: Box<TaskWasmRecycle>) -> Self {
self.recycle.replace(trigger);
self
}
}
/// A task executor backed by a thread pool.
///
/// ## Thread Safety
///
/// Due to [#4158], it is possible to pass non-thread safe objects across
/// threads by capturing them in the task passed to
/// [`VirtualTaskManager::task_shared()`] or
/// [`VirtualTaskManager::task_dedicated()`].
///
/// If your task needs access to a [`wasmer::Module`], [`wasmer::Memory`], or
/// [`wasmer::Instance`], it should explicitly transfer the objects using
/// either [`VirtualTaskManager::task_wasm()`] when in syscall context or
/// [`VirtualTaskManager::spawn_with_module()`] for higher level code.
///
/// [#4158]: https://github.com/wasmerio/wasmer/issues/4158
#[allow(unused_variables)]
pub trait VirtualTaskManager: std::fmt::Debug + Send + Sync + 'static {
/// Build a new Webassembly memory.
///
/// May return `None` if the memory can just be auto-constructed.
fn build_memory(
&self,
mut store: &mut StoreMut,
spawn_type: SpawnMemoryType,
) -> Result<Option<Memory>, WasiThreadError> {
match spawn_type {
SpawnMemoryType::CreateMemoryOfType(mut ty) => {
ty.shared = true;
// Note: If memory is shared, maximum needs to be set in the
// browser otherwise creation will fail.
let _ = ty.maximum.get_or_insert(wasmer_types::Pages::max_value());
let mem = Memory::new(&mut store, ty).map_err(|err| {
tracing::error!(
error = &err as &dyn std::error::Error,
memory_type=?ty,
"could not create memory",
);
WasiThreadError::MemoryCreateFailed(err)
})?;
Ok(Some(mem))
}
SpawnMemoryType::ShareMemory(mem, old_store) => {
let mem = mem.share_in_store(&old_store, store).map_err(|err| {
tracing::warn!(
error = &err as &dyn std::error::Error,
"could not clone memory",
);
WasiThreadError::MemoryCreateFailed(err)
})?;
Ok(Some(mem))
}
SpawnMemoryType::CopyMemory(mem, old_store) => {
let mem = mem.copy_to_store(&old_store, store).map_err(|err| {
tracing::warn!(
error = &err as &dyn std::error::Error,
"could not copy memory",
);
WasiThreadError::MemoryCreateFailed(err)
})?;
Ok(Some(mem))
}
SpawnMemoryType::CreateMemory => Ok(None),
}
}
/// Pause the current thread of execution.
///
/// This is typically invoked whenever a WASM thread goes idle. Besides
/// acting as a platform-agnostic [`std::thread::sleep()`], this also gives
/// the runtime a chance to do asynchronous work like pumping an event
/// loop.
fn sleep_now(
&self,
time: Duration,
) -> Pin<Box<dyn Future<Output = ()> + Send + Sync + 'static>>;
/// Run an asynchronous operation on the thread pool.
///
/// This task must not block execution or it could cause deadlocks.
///
/// See the "Thread Safety" documentation on [`VirtualTaskManager`] for
/// limitations on what a `task` can and can't contain.
fn task_shared(
&self,
task: Box<dyn FnOnce() -> BoxFuture<'static, ()> + Send + 'static>,
) -> Result<(), WasiThreadError>;
/// Run a blocking WebAssembly operation on the thread pool.
///
/// This is primarily used inside the context of a syscall and allows
/// the transfer of things like [`wasmer::Module`] across threads.
fn task_wasm(&self, task: TaskWasm) -> Result<(), WasiThreadError>;
/// Run a blocking operation on the thread pool.
///
/// It is okay for this task to block execution and any async futures within
/// its scope.
fn task_dedicated(
&self,
task: Box<dyn FnOnce() + Send + 'static>,
) -> Result<(), WasiThreadError>;
/// Returns the amount of parallelism that is possible on this platform.
fn thread_parallelism(&self) -> Result<usize, WasiThreadError>;
/// Schedule a blocking task to run on the threadpool, explicitly
/// transferring a [`Module`] to the task.
///
/// This should be preferred over [`VirtualTaskManager::task_dedicated()`]
/// where possible because [`wasmer::Module`] is actually `!Send` in the
/// browser and can only be transferred to background threads via
/// an explicit `postMessage()`. See [#4158] for more details.
///
/// This is very similar to [`VirtualTaskManager::task_wasm()`], but
/// intended for use outside of a syscall context. For example, when you are
/// running in the browser and want to run a WebAssembly module in the
/// background.
///
/// [#4158]: https://github.com/wasmerio/wasmer/issues/4158
fn spawn_with_module(
&self,
module: Module,
task: Box<dyn FnOnce(Module) + Send + 'static>,
) -> Result<(), WasiThreadError> {
// Note: Ideally, this function and task_wasm() would be superseded by
// a more general mechanism for transferring non-thread safe values
// to the thread pool.
self.task_dedicated(Box::new(move || task(module)))
}
}
impl<D, T> VirtualTaskManager for D
where
D: Deref<Target = T> + std::fmt::Debug + Send + Sync + 'static,
T: VirtualTaskManager + ?Sized,
{
fn build_memory(
&self,
store: &mut StoreMut,
spawn_type: SpawnMemoryType,
) -> Result<Option<Memory>, WasiThreadError> {
(**self).build_memory(store, spawn_type)
}
fn sleep_now(
&self,
time: Duration,
) -> Pin<Box<dyn Future<Output = ()> + Send + Sync + 'static>> {
(**self).sleep_now(time)
}
fn task_shared(
&self,
task: Box<dyn FnOnce() -> BoxFuture<'static, ()> + Send + 'static>,
) -> Result<(), WasiThreadError> {
(**self).task_shared(task)
}
fn task_wasm(&self, task: TaskWasm) -> Result<(), WasiThreadError> {
(**self).task_wasm(task)
}
fn task_dedicated(
&self,
task: Box<dyn FnOnce() + Send + 'static>,
) -> Result<(), WasiThreadError> {
(**self).task_dedicated(task)
}
fn thread_parallelism(&self) -> Result<usize, WasiThreadError> {
(**self).thread_parallelism()
}
fn spawn_with_module(
&self,
module: Module,
task: Box<dyn FnOnce(Module) + Send + 'static>,
) -> Result<(), WasiThreadError> {
(**self).spawn_with_module(module, task)
}
}
impl dyn VirtualTaskManager {
/// Starts an WebAssembly task will run on a dedicated thread
/// pulled from the worker pool that has a stateful thread local variable
/// After the poller has succeeded
#[doc(hidden)]
pub unsafe fn resume_wasm_after_poller(
&self,
task: Box<WasmResumeTask>,
ctx: WasiFunctionEnv,
mut store: Store,
trigger: Pin<Box<AsyncifyFuture>>,
) -> Result<(), WasiThreadError> {
// This poller will process any signals when the main working function is idle
struct AsyncifyPollerOwned {
thread: WasiThread,
trigger: Pin<Box<AsyncifyFuture>>,
}
impl Future for AsyncifyPollerOwned {
type Output = Result<Bytes, ExitCode>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let work = self.trigger.as_mut();
Poll::Ready(if let Poll::Ready(res) = work.poll(cx) {
Ok(res)
} else if let Some(forced_exit) = self.thread.try_join() {
return Poll::Ready(Err(forced_exit.unwrap_or_else(|err| {
tracing::debug!("exit runtime error - {}", err);
Errno::Child.into()
})));
} else {
return Poll::Pending;
})
}
}
let snapshot = capture_store_snapshot(&mut store.as_store_mut());
let env = ctx.data(&store);
let module = env.inner().module_clone();
let memory = env.inner().memory_clone();
let thread = env.thread.clone();
let env = env.clone();
let thread_inner = thread.clone();
self.task_wasm(
TaskWasm::new(
Box::new(move |props| {
let result = props
.trigger_result
.expect("If there is no result then its likely the trigger did not run");
let result = match result {
Ok(r) => r,
Err(exit_code) => {
thread.set_status_finished(Ok(exit_code));
return;
}
};
task(props.ctx, props.store, result)
}),
env.clone(),
module,
false,
)
.with_memory(SpawnMemoryType::ShareMemory(memory, store.as_store_ref()))
.with_globals(&snapshot)
.with_trigger(Box::new(move || {
Box::pin(async move {
let mut poller = AsyncifyPollerOwned {
thread: thread_inner,
trigger,
};
let res = Pin::new(&mut poller).await;
let res = match res {
Ok(res) => res,
Err(exit_code) => {
env.thread.set_status_finished(Ok(exit_code));
return Err(exit_code);
}
};
tracing::trace!("deep sleep woken - res.len={}", res.len());
Ok(res)
})
})),
)
}
}
/// Generic utility methods for VirtualTaskManager
pub trait VirtualTaskManagerExt {
/// Runs the work in the background via the task managers shared background
/// threads while blocking the current execution until it finishs
fn spawn_and_block_on<A>(
&self,
task: impl Future<Output = A> + Send + 'static,
) -> Result<A, anyhow::Error>
where
A: Send + 'static;
fn spawn_await<O, F>(
&self,
f: F,
) -> Box<dyn Future<Output = Result<O, Box<dyn std::error::Error>>> + Unpin + Send + 'static>
where
O: Send + 'static,
F: FnOnce() -> O + Send + 'static;
}
impl<D, T> VirtualTaskManagerExt for D
where
D: Deref<Target = T>,
T: VirtualTaskManager + ?Sized,
{
/// Runs the work in the background via the task managers shared background
/// threads while blocking the current execution until it finishs
fn spawn_and_block_on<A>(
&self,
task: impl Future<Output = A> + Send + 'static,
) -> Result<A, anyhow::Error>
where
A: Send + 'static,
{
let (tx, rx) = ::tokio::sync::oneshot::channel();
let work = Box::pin(async move {
let ret = task.await;
tx.send(ret).ok();
});
self.task_shared(Box::new(move || work)).unwrap();
rx.blocking_recv()
.map_err(|_| anyhow::anyhow!("task execution failed - result channel dropped"))
}
fn spawn_await<O, F>(
&self,
f: F,
) -> Box<dyn Future<Output = Result<O, Box<dyn std::error::Error>>> + Unpin + Send + 'static>
where
O: Send + 'static,
F: FnOnce() -> O + Send + 'static,
{
let (sender, receiver) = ::tokio::sync::oneshot::channel();
self.task_dedicated(Box::new(move || {
let result = f();
let _ = sender.send(result);
}))
.unwrap();
Box::new(receiver.map_err(|e| Box::new(e).into()))
}
}