#![allow(unused, clippy::too_many_arguments, clippy::cognitive_complexity)]
pub mod types {
pub use wasmer_wasix_types::{types::*, wasi};
}
#[cfg(any(
target_os = "freebsd",
target_os = "linux",
target_os = "android",
target_vendor = "apple"
))]
pub mod unix;
#[cfg(target_family = "wasm")]
pub mod wasm;
#[cfg(target_os = "windows")]
pub mod windows;
pub mod journal;
pub mod wasi;
pub mod wasix;
use bytes::{Buf, BufMut};
use futures::{
future::{BoxFuture, LocalBoxFuture},
Future,
};
use tracing::instrument;
pub use wasi::*;
pub use wasix::*;
use wasmer_journal::SnapshotTrigger;
use wasmer_wasix_types::wasix::ThreadStartType;
pub mod legacy;
pub(crate) use std::{
borrow::{Borrow, Cow},
cell::RefCell,
collections::{hash_map::Entry, HashMap, HashSet},
convert::{Infallible, TryInto},
io::{self, Read, Seek, Write},
mem::transmute,
net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr},
num::NonZeroU64,
ops::{Deref, DerefMut},
path::Path,
pin::Pin,
sync::{
atomic::{AtomicBool, AtomicU32, AtomicU64, Ordering},
mpsc, Arc, Condvar, Mutex,
},
task::{Context, Poll},
thread::LocalKey,
time::Duration,
};
use std::{io::IoSlice, marker::PhantomData, mem::MaybeUninit, task::Waker, time::Instant};
pub(crate) use bytes::{Bytes, BytesMut};
pub(crate) use cooked_waker::IntoWaker;
pub use journal::*;
pub(crate) use sha2::Sha256;
pub(crate) use tracing::{debug, error, trace, warn};
#[cfg(any(
target_os = "freebsd",
target_os = "linux",
target_os = "android",
target_vendor = "apple"
))]
pub use unix::*;
#[cfg(target_family = "wasm")]
pub use wasm::*;
pub(crate) use virtual_fs::{
AsyncSeekExt, AsyncWriteExt, DuplexPipe, FileSystem, FsError, VirtualFile,
};
pub(crate) use virtual_net::StreamSecurity;
pub(crate) use wasmer::{
AsStoreMut, AsStoreRef, Extern, Function, FunctionEnv, FunctionEnvMut, Global, Instance,
Memory, Memory32, Memory64, MemoryAccessError, MemoryError, MemorySize, MemoryView, Module,
OnCalledAction, Pages, RuntimeError, Store, TypedFunction, Value, WasmPtr, WasmSlice,
};
pub(crate) use wasmer_wasix_types::{asyncify::__wasi_asyncify_t, wasi::EventUnion};
#[cfg(target_os = "windows")]
pub use windows::*;
pub(crate) use self::types::{
wasi::{
Addressfamily, Advice, Clockid, Dircookie, Dirent, Errno, Event, EventFdReadwrite,
Eventrwflags, Eventtype, ExitCode, Fd as WasiFd, Fdflags, Fdstat, Filesize, Filestat,
Filetype, Fstflags, Linkcount, Longsize, OptionFd, Pid, Prestat, Rights, Snapshot0Clockid,
Sockoption, Sockstatus, Socktype, StackSnapshot, StdioMode as WasiStdioMode,
Streamsecurity, Subscription, SubscriptionFsReadwrite, Tid, Timestamp, TlKey, TlUser,
TlVal, Tty, Whence,
},
*,
};
use self::{
state::{conv_env_vars, WasiInstanceGuardMemory},
utils::WasiDummyWaker,
};
pub(crate) use crate::os::task::{
process::{WasiProcessId, WasiProcessWait},
thread::{WasiThread, WasiThreadId},
};
pub(crate) use crate::{
bin_factory::spawn_exec_module,
import_object_for_all_wasi_versions, mem_error_to_wasi,
net::{
read_ip_port,
socket::{InodeHttpSocketType, InodeSocket, InodeSocketKind},
write_ip_port,
},
runtime::SpawnMemoryType,
state::{
self, iterate_poll_events, InodeGuard, InodeWeakGuard, PollEvent, PollEventBuilder,
WasiFutex, WasiState,
},
utils::{self, map_io_err},
Runtime, VirtualTaskManager, WasiEnv, WasiError, WasiFunctionEnv, WasiInstanceHandles,
WasiVFork,
};
use crate::{
fs::{
fs_error_into_wasi_err, virtual_file_type_to_wasi_file_type, Fd, InodeVal, Kind,
MAX_SYMLINKS,
},
journal::{DynJournal, JournalEffector},
os::task::{
process::{MaybeCheckpointResult, WasiProcessCheckpoint},
thread::{RewindResult, RewindResultType},
},
runtime::task_manager::InlineWaker,
utils::store::StoreSnapshot,
DeepSleepWork, RewindPostProcess, RewindState, RewindStateOption, SpawnError, WasiInodes,
WasiResult, WasiRuntimeError,
};
pub(crate) use crate::{net::net_error_into_wasi_err, utils::WasiParkingLot};
pub(crate) fn to_offset<M: MemorySize>(offset: usize) -> Result<M::Offset, Errno> {
let ret: M::Offset = offset.try_into().map_err(|_| Errno::Inval)?;
Ok(ret)
}
pub(crate) fn from_offset<M: MemorySize>(offset: M::Offset) -> Result<usize, Errno> {
let ret: usize = offset.try_into().map_err(|_| Errno::Inval)?;
Ok(ret)
}
pub(crate) fn write_bytes_inner<T: Write, M: MemorySize>(
mut write_loc: T,
memory: &MemoryView,
iovs_arr_cell: WasmSlice<__wasi_ciovec_t<M>>,
) -> Result<usize, Errno> {
let mut bytes_written = 0usize;
for iov in iovs_arr_cell.iter() {
let iov_inner = iov.read().map_err(mem_error_to_wasi)?;
let bytes = WasmPtr::<u8, M>::new(iov_inner.buf)
.slice(memory, iov_inner.buf_len)
.map_err(mem_error_to_wasi)?;
let bytes = bytes.read_to_vec().map_err(mem_error_to_wasi)?;
write_loc.write_all(&bytes).map_err(map_io_err)?;
bytes_written += from_offset::<M>(iov_inner.buf_len)?;
}
Ok(bytes_written)
}
pub(crate) fn write_bytes<T: Write, M: MemorySize>(
mut write_loc: T,
memory: &MemoryView,
iovs_arr: WasmSlice<__wasi_ciovec_t<M>>,
) -> Result<usize, Errno> {
let result = write_bytes_inner::<_, M>(&mut write_loc, memory, iovs_arr);
write_loc.flush();
result
}
pub(crate) fn copy_from_slice<M: MemorySize>(
mut read_loc: &[u8],
memory: &MemoryView,
iovs_arr: WasmSlice<__wasi_iovec_t<M>>,
) -> Result<usize, Errno> {
let mut bytes_read = 0usize;
let iovs_arr = iovs_arr.access().map_err(mem_error_to_wasi)?;
for iovs in iovs_arr.iter() {
let mut buf = WasmPtr::<u8, M>::new(iovs.buf)
.slice(memory, iovs.buf_len)
.map_err(mem_error_to_wasi)?
.access()
.map_err(mem_error_to_wasi)?;
let to_read = from_offset::<M>(iovs.buf_len)?;
let to_read = to_read.min(read_loc.len());
if to_read == 0 {
break;
}
let (left, right) = read_loc.split_at(to_read);
let amt = buf.copy_from_slice_min(left);
if amt != to_read {
return Ok(bytes_read + amt);
}
read_loc = right;
bytes_read += to_read;
}
Ok(bytes_read)
}
pub(crate) fn read_bytes<T: Read, M: MemorySize>(
mut reader: T,
memory: &MemoryView,
iovs_arr: WasmSlice<__wasi_iovec_t<M>>,
) -> Result<usize, Errno> {
let mut bytes_read = 0usize;
let iovs_arr = iovs_arr.access().map_err(mem_error_to_wasi)?;
for iovs in iovs_arr.iter() {
let mut buf = WasmPtr::<u8, M>::new(iovs.buf)
.slice(memory, iovs.buf_len)
.map_err(mem_error_to_wasi)?
.access()
.map_err(mem_error_to_wasi)?;
let to_read = buf.len();
let has_read = reader.read(buf.as_mut()).map_err(map_io_err)?;
bytes_read += has_read;
if has_read != to_read {
return Ok(bytes_read);
}
}
Ok(bytes_read)
}
#[allow(clippy::await_holding_lock)]
pub unsafe fn stderr_write<'a>(
ctx: &FunctionEnvMut<'_, WasiEnv>,
buf: &[u8],
) -> LocalBoxFuture<'a, Result<(), Errno>> {
let env = ctx.data();
let (memory, state, inodes) = env.get_memory_and_wasi_state_and_inodes(ctx, 0);
let buf = buf.to_vec();
let fd_map = state.fs.fd_map.clone();
Box::pin(async move {
let mut stderr = WasiInodes::stderr_mut(&fd_map).map_err(fs_error_into_wasi_err)?;
stderr.write_all(&buf).await.map_err(map_io_err)
})
}
fn block_on_with_timeout<T, Fut>(
tasks: &Arc<dyn VirtualTaskManager>,
timeout: Option<Duration>,
work: Fut,
) -> WasiResult<T>
where
Fut: Future<Output = WasiResult<T>>,
{
let mut nonblocking = false;
if timeout == Some(Duration::ZERO) {
nonblocking = true;
}
let timeout = async {
if let Some(timeout) = timeout {
if !nonblocking {
tasks.sleep_now(timeout).await
} else {
InfiniteSleep::default().await
}
} else {
InfiniteSleep::default().await
}
};
let work = async move {
tokio::select! {
res = work => res,
_ = timeout => Ok(Err(Errno::Timedout)),
}
};
if nonblocking {
let waker = WasiDummyWaker.into_waker();
let mut cx = Context::from_waker(&waker);
let mut pinned_work = Box::pin(work);
if let Poll::Ready(res) = pinned_work.as_mut().poll(&mut cx) {
return res;
}
return Ok(Err(Errno::Again));
}
InlineWaker::block_on(work)
}
pub(crate) fn __asyncify<T, Fut>(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
timeout: Option<Duration>,
work: Fut,
) -> WasiResult<T>
where
T: 'static,
Fut: std::future::Future<Output = Result<T, Errno>>,
{
let mut env = ctx.data();
if let Some(exit_code) = env.should_exit() {
return Err(WasiError::Exit(exit_code));
}
struct SignalPoller<'a, 'b, Fut, T>
where
Fut: Future<Output = Result<T, Errno>>,
{
ctx: &'a mut FunctionEnvMut<'b, WasiEnv>,
pinned_work: Pin<Box<Fut>>,
}
impl<'a, 'b, Fut, T> Future for SignalPoller<'a, 'b, Fut, T>
where
Fut: Future<Output = Result<T, Errno>>,
{
type Output = Result<Fut::Output, WasiError>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
if let Poll::Ready(res) = Pin::new(&mut self.pinned_work).poll(cx) {
return Poll::Ready(Ok(res));
}
if let Some(signals) = self.ctx.data().thread.pop_signals_or_subscribe(cx.waker()) {
if let Err(err) = WasiEnv::process_signals_internal(self.ctx, signals) {
return Poll::Ready(Err(err));
}
return Poll::Ready(Ok(Err(Errno::Intr)));
}
Poll::Pending
}
}
let mut pinned_work = Box::pin(work);
let tasks = env.tasks().clone();
let poller = SignalPoller { ctx, pinned_work };
block_on_with_timeout(&tasks, timeout, poller)
}
pub type AsyncifyFuture = dyn Future<Output = Bytes> + Send + Sync + 'static;
struct AsyncifyPoller<'a, 'b, 'c, T, Fut>
where
Fut: Future<Output = T> + Send + Sync + 'static,
{
ctx: &'b mut FunctionEnvMut<'c, WasiEnv>,
work: &'a mut Pin<Box<Fut>>,
}
impl<'a, 'b, 'c, T, Fut> Future for AsyncifyPoller<'a, 'b, 'c, T, Fut>
where
Fut: Future<Output = T> + Send + Sync + 'static,
{
type Output = Result<T, WasiError>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
if let Poll::Ready(res) = self.work.as_mut().poll(cx) {
return Poll::Ready(Ok(res));
}
let env = self.ctx.data();
if let Some(forced_exit) = env.thread.try_join() {
return Poll::Ready(Err(WasiError::Exit(forced_exit.unwrap_or_else(|err| {
tracing::debug!("exit runtime error - {}", err);
Errno::Child.into()
}))));
}
if env.thread.has_signals_or_subscribe(cx.waker()) {
let has_exit = {
let signals = env.thread.signals().lock().unwrap();
signals
.0
.iter()
.filter_map(|sig| {
if *sig == Signal::Sigint
|| *sig == Signal::Sigquit
|| *sig == Signal::Sigkill
|| *sig == Signal::Sigabrt
{
Some(env.thread.set_or_get_exit_code_for_signal(*sig))
} else {
None
}
})
.next()
};
return match WasiEnv::process_signals_and_exit(self.ctx) {
Ok(Ok(_)) => {
if let Some(exit_code) = has_exit {
Poll::Ready(Err(WasiError::Exit(exit_code)))
} else {
Poll::Pending
}
}
Ok(Err(err)) => Poll::Ready(Err(WasiError::Exit(ExitCode::from(err)))),
Err(err) => Poll::Ready(Err(err)),
};
}
Poll::Pending
}
}
pub enum AsyncifyAction<'a, R> {
Finish(FunctionEnvMut<'a, WasiEnv>, R),
Unwind,
}
pub(crate) fn maybe_backoff<M: MemorySize>(
mut ctx: FunctionEnvMut<'_, WasiEnv>,
) -> Result<Result<FunctionEnvMut<'_, WasiEnv>, Errno>, WasiError> {
let env = ctx.data();
if env.enable_exponential_cpu_backoff.is_none() {
return Ok(Ok(ctx));
}
if let Some(backoff) = env.process.acquire_cpu_backoff_token(env.tasks()) {
tracing::trace!("exponential CPU backoff {:?}", backoff.backoff_time());
if let AsyncifyAction::Finish(mut ctx, _) =
__asyncify_with_deep_sleep::<M, _, _>(ctx, backoff)?
{
Ok(Ok(ctx))
} else {
Ok(Err(Errno::Success))
}
} else {
Ok(Ok(ctx))
}
}
pub(crate) fn __asyncify_with_deep_sleep<M: MemorySize, T, Fut>(
mut ctx: FunctionEnvMut<'_, WasiEnv>,
work: Fut,
) -> Result<AsyncifyAction<'_, T>, WasiError>
where
T: serde::Serialize + serde::de::DeserializeOwned,
Fut: Future<Output = T> + Send + Sync + 'static,
{
let deep_sleep_time = match ctx.data().enable_journal {
true => Duration::from_micros(100),
false => Duration::from_millis(50),
};
let mut trigger = Box::pin(work);
let tasks = ctx.data().tasks().clone();
let work = async move {
let env = ctx.data();
let tasks_for_deep_sleep = if env.enable_deep_sleep {
Some(env.tasks().clone())
} else {
None
};
let deep_sleep_wait = async {
if let Some(tasks) = tasks_for_deep_sleep {
tasks.sleep_now(deep_sleep_time).await
} else {
InfiniteSleep::default().await
}
};
Ok(tokio::select! {
res = AsyncifyPoller {
ctx: &mut ctx,
work: &mut trigger,
} => {
let result = res?;
AsyncifyAction::Finish(ctx, result)
},
_ = deep_sleep_wait => {
let pid = ctx.data().pid();
let tid = ctx.data().tid();
let thread = ctx.data().thread.clone();
thread.set_deep_sleeping(true);
ctx.data().process.inner.1.notify_one();
tracing::trace!(%pid, %tid, "thread entering deep sleep");
deep_sleep::<M>(ctx, Box::pin(async move {
let result = trigger.await;
tracing::trace!(%pid, %tid, "thread leaving deep sleep");
thread.set_deep_sleeping(false);
bincode::serialize(&result).unwrap().into()
}))?;
AsyncifyAction::Unwind
},
})
};
InlineWaker::block_on(work)
}
pub(crate) fn __asyncify_light<T, Fut>(
env: &WasiEnv,
timeout: Option<Duration>,
work: Fut,
) -> WasiResult<T>
where
T: 'static,
Fut: Future<Output = Result<T, Errno>>,
{
let snapshot_wait = wait_for_snapshot(env);
struct Poller<'a, Fut, T>
where
Fut: Future<Output = Result<T, Errno>>,
{
env: &'a WasiEnv,
pinned_work: Pin<Box<Fut>>,
pinned_snapshot: Pin<Box<dyn Future<Output = ()>>>,
}
impl<'a, Fut, T> Future for Poller<'a, Fut, T>
where
Fut: Future<Output = Result<T, Errno>>,
{
type Output = Result<Fut::Output, WasiError>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
if let Poll::Ready(res) = Pin::new(&mut self.pinned_work).poll(cx) {
return Poll::Ready(Ok(res));
}
if let Poll::Ready(()) = Pin::new(&mut self.pinned_snapshot).poll(cx) {
return Poll::Ready(Ok(Err(Errno::Intr)));
}
if let Some(exit_code) = self.env.should_exit() {
return Poll::Ready(Err(WasiError::Exit(exit_code)));
}
if self.env.thread.has_signals_or_subscribe(cx.waker()) {
return Poll::Ready(Ok(Err(Errno::Intr)));
}
Poll::Pending
}
}
Ok(InlineWaker::block_on(work))
}
#[derive(Default)]
pub struct InfiniteSleep {}
impl std::future::Future for InfiniteSleep {
type Output = ();
fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output> {
Poll::Pending
}
}
pub(crate) fn __sock_asyncify<T, F, Fut>(
env: &WasiEnv,
sock: WasiFd,
rights: Rights,
actor: F,
) -> Result<T, Errno>
where
F: FnOnce(crate::net::socket::InodeSocket, Fd) -> Fut,
Fut: std::future::Future<Output = Result<T, Errno>>,
{
let fd_entry = env.state.fs.get_fd(sock)?;
if !rights.is_empty() && !fd_entry.rights.contains(rights) {
return Err(Errno::Access);
}
let mut work = {
let inode = fd_entry.inode.clone();
let tasks = env.tasks().clone();
let mut guard = inode.write();
match guard.deref_mut() {
Kind::Socket { socket } => {
let socket = socket.clone();
drop(guard);
actor(socket, fd_entry)
}
_ => {
return Err(Errno::Notsock);
}
}
};
InlineWaker::block_on(work)
}
pub(crate) fn __sock_asyncify_mut<T, F, Fut>(
ctx: &'_ mut FunctionEnvMut<'_, WasiEnv>,
sock: WasiFd,
rights: Rights,
actor: F,
) -> Result<T, Errno>
where
F: FnOnce(crate::net::socket::InodeSocket, Fd) -> Fut,
Fut: std::future::Future<Output = Result<T, Errno>>,
{
let env = ctx.data();
let tasks = env.tasks().clone();
let fd_entry = env.state.fs.get_fd(sock)?;
if !rights.is_empty() && !fd_entry.rights.contains(rights) {
return Err(Errno::Access);
}
let inode = fd_entry.inode.clone();
let mut guard = inode.write();
match guard.deref_mut() {
Kind::Socket { socket } => {
let socket = socket.clone();
drop(guard);
let mut work = actor(socket, fd_entry);
InlineWaker::block_on(work)
}
_ => Err(Errno::Notsock),
}
}
pub(crate) fn __sock_actor<T, F>(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
sock: WasiFd,
rights: Rights,
actor: F,
) -> Result<T, Errno>
where
T: 'static,
F: FnOnce(crate::net::socket::InodeSocket, Fd) -> Result<T, Errno>,
{
let env = ctx.data();
let tasks = env.tasks().clone();
let fd_entry = env.state.fs.get_fd(sock)?;
if !rights.is_empty() && !fd_entry.rights.contains(rights) {
return Err(Errno::Access);
}
let inode = fd_entry.inode.clone();
let tasks = env.tasks().clone();
let mut guard = inode.write();
match guard.deref_mut() {
Kind::Socket { socket } => {
let socket = socket.clone();
drop(guard);
actor(socket, fd_entry)
}
_ => Err(Errno::Notsock),
}
}
pub(crate) fn __sock_actor_mut<T, F>(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
sock: WasiFd,
rights: Rights,
actor: F,
) -> Result<T, Errno>
where
T: 'static,
F: FnOnce(crate::net::socket::InodeSocket, Fd) -> Result<T, Errno>,
{
let env = ctx.data();
let tasks = env.tasks().clone();
let fd_entry = env.state.fs.get_fd(sock)?;
if !rights.is_empty() && !fd_entry.rights.contains(rights) {
return Err(Errno::Access);
}
let inode = fd_entry.inode.clone();
let mut guard = inode.write();
match guard.deref_mut() {
Kind::Socket { socket } => {
let socket = socket.clone();
drop(guard);
actor(socket, fd_entry)
}
_ => Err(Errno::Notsock),
}
}
pub(crate) fn __sock_upgrade<'a, F, Fut>(
ctx: &'a mut FunctionEnvMut<'_, WasiEnv>,
sock: WasiFd,
rights: Rights,
actor: F,
) -> Result<(), Errno>
where
F: FnOnce(crate::net::socket::InodeSocket, Fdflags) -> Fut,
Fut: std::future::Future<Output = Result<Option<crate::net::socket::InodeSocket>, Errno>> + 'a,
{
let env = ctx.data();
let fd_entry = env.state.fs.get_fd(sock)?;
if !rights.is_empty() && !fd_entry.rights.contains(rights) {
tracing::warn!(
"wasi[{}:{}]::sock_upgrade(fd={}, rights={:?}) - failed - no access rights to upgrade",
ctx.data().pid(),
ctx.data().tid(),
sock,
rights
);
return Err(Errno::Access);
}
let tasks = env.tasks().clone();
{
let inode = fd_entry.inode;
let mut guard = inode.write();
match guard.deref_mut() {
Kind::Socket { socket } => {
let socket = socket.clone();
drop(guard);
let work = actor(socket, fd_entry.flags);
let res = InlineWaker::block_on(work);
let new_socket = res?;
if let Some(mut new_socket) = new_socket {
let mut guard = inode.write();
match guard.deref_mut() {
Kind::Socket { socket, .. } => {
std::mem::swap(socket, &mut new_socket);
}
_ => {
tracing::warn!(
"wasi[{}:{}]::sock_upgrade(fd={}, rights={:?}) - failed - not a socket",
ctx.data().pid(),
ctx.data().tid(),
sock,
rights
);
return Err(Errno::Notsock);
}
}
}
}
_ => {
tracing::warn!(
"wasi[{}:{}]::sock_upgrade(fd={}, rights={:?}) - failed - not a socket",
ctx.data().pid(),
ctx.data().tid(),
sock,
rights
);
return Err(Errno::Notsock);
}
}
}
Ok(())
}
#[must_use]
pub(crate) fn write_buffer_array<M: MemorySize>(
memory: &MemoryView,
from: &[Vec<u8>],
ptr_buffer: WasmPtr<WasmPtr<u8, M>, M>,
buffer: WasmPtr<u8, M>,
) -> Errno {
let ptrs = wasi_try_mem!(ptr_buffer.slice(memory, wasi_try!(to_offset::<M>(from.len()))));
let mut current_buffer_offset = 0usize;
for ((i, sub_buffer), ptr) in from.iter().enumerate().zip(ptrs.iter()) {
let mut buf_offset = buffer.offset();
buf_offset += wasi_try!(to_offset::<M>(current_buffer_offset));
let new_ptr = WasmPtr::new(buf_offset);
wasi_try_mem!(ptr.write(new_ptr));
let data =
wasi_try_mem!(new_ptr.slice(memory, wasi_try!(to_offset::<M>(sub_buffer.len()))));
wasi_try_mem!(data.write_slice(sub_buffer));
wasi_try_mem!(wasi_try_mem!(
new_ptr.add_offset(wasi_try!(to_offset::<M>(sub_buffer.len())))
)
.write(memory, 0));
current_buffer_offset += sub_buffer.len() + 1;
}
Errno::Success
}
pub(crate) fn get_current_time_in_nanos() -> Result<Timestamp, Errno> {
let now = platform_clock_time_get(Snapshot0Clockid::Monotonic, 1_000_000).unwrap() as u128;
Ok(now as Timestamp)
}
pub(crate) fn get_stack_lower(env: &WasiEnv) -> u64 {
env.layout.stack_lower
}
pub(crate) fn get_stack_upper(env: &WasiEnv) -> u64 {
env.layout.stack_upper
}
pub(crate) unsafe fn get_memory_stack_pointer(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
) -> Result<u64, String> {
let stack_upper = get_stack_upper(ctx.data());
let stack_pointer = if let Some(stack_pointer) = ctx.data().inner().stack_pointer.clone() {
match stack_pointer.get(ctx) {
Value::I32(a) => a as u64,
Value::I64(a) => a as u64,
_ => stack_upper,
}
} else {
return Err("failed to save stack: not exported __stack_pointer global".to_string());
};
Ok(stack_pointer)
}
pub(crate) unsafe fn get_memory_stack_offset(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
) -> Result<u64, String> {
let stack_upper = get_stack_upper(ctx.data());
let stack_pointer = get_memory_stack_pointer(ctx)?;
Ok(stack_upper - stack_pointer)
}
pub(crate) fn set_memory_stack_offset(
env: &WasiEnv,
store: &mut impl AsStoreMut,
offset: u64,
) -> Result<(), String> {
let stack_upper = get_stack_upper(env);
let stack_pointer = stack_upper - offset;
if let Some(stack_pointer_ptr) = env
.try_inner()
.ok_or_else(|| "unable to access the stack pointer of the instance".to_string())?
.stack_pointer
.clone()
{
match stack_pointer_ptr.get(store) {
Value::I32(_) => {
stack_pointer_ptr.set(store, Value::I32(stack_pointer as i32));
}
Value::I64(_) => {
stack_pointer_ptr.set(store, Value::I64(stack_pointer as i64));
}
_ => {
return Err(
"failed to save stack: __stack_pointer global is of an unknown type"
.to_string(),
);
}
}
} else {
return Err("failed to save stack: not exported __stack_pointer global".to_string());
}
Ok(())
}
#[allow(dead_code)]
pub(crate) fn get_memory_stack<M: MemorySize>(
env: &WasiEnv,
store: &mut impl AsStoreMut,
) -> Result<BytesMut, String> {
let stack_base = get_stack_upper(env);
let stack_pointer = if let Some(stack_pointer) = env
.try_inner()
.ok_or_else(|| "unable to access the stack pointer of the instance".to_string())?
.stack_pointer
.clone()
{
match stack_pointer.get(store) {
Value::I32(a) => a as u64,
Value::I64(a) => a as u64,
_ => stack_base,
}
} else {
return Err("failed to save stack: not exported __stack_pointer global".to_string());
};
let memory = env
.try_memory_view(store)
.ok_or_else(|| "unable to access the memory of the instance".to_string())?;
let stack_offset = env.layout.stack_upper - stack_pointer;
let memory_stack_ptr = WasmPtr::<u8, M>::new(
stack_pointer
.try_into()
.map_err(|err| format!("failed to save stack: stack pointer overflow (stack_pointer={}, stack_lower={}, stack_upper={})", stack_offset, env.layout.stack_lower, env.layout.stack_upper))?,
);
memory_stack_ptr
.slice(
&memory,
stack_offset
.try_into()
.map_err(|err| format!("failed to save stack: stack pointer overflow (stack_pointer={}, stack_lower={}, stack_upper={})", stack_offset, env.layout.stack_lower, env.layout.stack_upper))?,
)
.and_then(|memory_stack| memory_stack.read_to_bytes())
.map_err(|err| format!("failed to read stack: {}", err))
}
#[allow(dead_code)]
pub(crate) fn set_memory_stack<M: MemorySize>(
env: &WasiEnv,
store: &mut impl AsStoreMut,
stack: Bytes,
) -> Result<(), String> {
let stack_upper = get_stack_upper(env);
let stack_offset = stack.len() as u64;
let stack_pointer = stack_upper - stack_offset;
let stack_ptr = WasmPtr::<u8, M>::new(
stack_pointer
.try_into()
.map_err(|_| "failed to restore stack: stack pointer overflow".to_string())?,
);
let memory = env
.try_memory_view(store)
.ok_or_else(|| "unable to set the stack pointer of the instance".to_string())?;
stack_ptr
.slice(
&memory,
stack_offset
.try_into()
.map_err(|_| "failed to restore stack: stack pointer overflow".to_string())?,
)
.and_then(|memory_stack| memory_stack.write_slice(&stack[..]))
.map_err(|err| format!("failed to write stack: {}", err))?;
set_memory_stack_offset(env, store, stack_offset)?;
Ok(())
}
#[must_use = "you must return the result immediately so the stack can unwind"]
pub(crate) fn deep_sleep<M: MemorySize>(
mut ctx: FunctionEnvMut<'_, WasiEnv>,
trigger: Pin<Box<AsyncifyFuture>>,
) -> Result<(), WasiError> {
let store_data = crate::utils::store::capture_store_snapshot(&mut ctx.as_store_mut())
.serialize()
.unwrap();
let store_data = Bytes::from(store_data);
let thread_start = ctx.data().thread.thread_start_type();
let tasks = ctx.data().tasks().clone();
let res = unwind::<M, _>(ctx, move |mut ctx, memory_stack, rewind_stack| {
let memory_stack = memory_stack.freeze();
let rewind_stack = rewind_stack.freeze();
let thread_layout = ctx.data().thread.memory_layout().clone();
if ctx.data().enable_journal {
let store_data = crate::utils::store::capture_store_snapshot(&mut ctx.as_store_mut())
.serialize()
.unwrap();
let store_data = Bytes::from(store_data);
tracing::debug!(
"stack snapshot unwind (memory_stack={}, rewind_stack={}, store_data={})",
memory_stack.len(),
rewind_stack.len(),
store_data.len(),
);
#[cfg(feature = "journal")]
{
let tid = ctx.data().thread.tid();
let thread_start = ctx.data().thread.thread_start_type();
if let Err(err) = JournalEffector::save_thread_state::<M>(
&mut ctx,
tid,
memory_stack.clone(),
rewind_stack.clone(),
store_data.clone(),
thread_start,
thread_layout.clone(),
) {
return wasmer_types::OnCalledAction::Trap(err.into());
}
}
let inner = ctx.data().process.inner.clone();
let is_idle = {
let mut guard = inner.0.lock().unwrap();
guard.threads.values().all(WasiThread::is_deep_sleeping)
};
#[cfg(feature = "journal")]
{
if is_idle && ctx.data_mut().has_snapshot_trigger(SnapshotTrigger::Idle) {
let mut guard = inner.0.lock().unwrap();
if let Err(err) = JournalEffector::save_memory_and_snapshot(
&mut ctx,
&mut guard,
SnapshotTrigger::Idle,
) {
return wasmer_types::OnCalledAction::Trap(err.into());
}
}
}
}
OnCalledAction::Trap(Box::new(WasiError::DeepSleep(DeepSleepWork {
trigger,
rewind: RewindState {
memory_stack,
rewind_stack,
store_data,
start: thread_start,
layout: thread_layout,
is_64bit: M::is_64bit(),
},
})))
})?;
match res {
Errno::Success => Ok(()),
err => Err(WasiError::Exit(ExitCode::from(err))),
}
}
#[must_use = "you must return the result immediately so the stack can unwind"]
pub fn unwind<M: MemorySize, F>(
mut ctx: FunctionEnvMut<'_, WasiEnv>,
callback: F,
) -> Result<Errno, WasiError>
where
F: FnOnce(FunctionEnvMut<'_, WasiEnv>, BytesMut, BytesMut) -> OnCalledAction
+ Send
+ Sync
+ 'static,
{
let (env, mut store) = ctx.data_and_store_mut();
let memory_stack = match get_memory_stack::<M>(env, &mut store) {
Ok(a) => a,
Err(err) => {
warn!("unable to get the memory stack - {}", err);
return Err(WasiError::Exit(Errno::Unknown.into()));
}
};
let env = ctx.data();
let memory = unsafe { env.memory_view(&ctx) };
let unwind_pointer = env.layout.stack_lower;
let unwind_data_start =
unwind_pointer + (std::mem::size_of::<__wasi_asyncify_t<M::Offset>>() as u64);
let unwind_data = __wasi_asyncify_t::<M::Offset> {
start: wasi_try_ok!(unwind_data_start.try_into().map_err(|_| Errno::Overflow)),
end: wasi_try_ok!((env.layout.stack_upper - memory_stack.len() as u64)
.try_into()
.map_err(|_| Errno::Overflow)),
};
let unwind_data_ptr: WasmPtr<__wasi_asyncify_t<M::Offset>, M> =
WasmPtr::new(wasi_try_ok!(unwind_pointer
.try_into()
.map_err(|_| Errno::Overflow)));
wasi_try_mem_ok!(unwind_data_ptr.write(&memory, unwind_data));
let asyncify_data = wasi_try_ok!(unwind_pointer.try_into().map_err(|_| Errno::Overflow));
if let Some(asyncify_start_unwind) = wasi_try_ok!(env.try_inner().ok_or(Errno::Fault))
.asyncify_start_unwind
.clone()
{
asyncify_start_unwind.call(&mut ctx, asyncify_data);
} else {
warn!("failed to unwind the stack because the asyncify_start_rewind export is missing");
return Err(WasiError::Exit(Errno::Noexec.into()));
}
let env = ctx.data();
let unwind_stack_begin: u64 = unwind_data.start.into();
let total_stack_space = env.layout.stack_size;
let func = ctx.as_ref();
trace!(
stack_upper = env.layout.stack_upper,
stack_lower = env.layout.stack_lower,
"wasi[{}:{}]::unwinding (used_stack_space={} total_stack_space={})",
ctx.data().pid(),
ctx.data().tid(),
memory_stack.len(),
total_stack_space
);
ctx.as_store_mut().on_called(move |mut store| {
let mut ctx = func.into_mut(&mut store);
let env = ctx.data();
let memory = env
.try_memory_view(&ctx)
.ok_or_else(|| "failed to save stack: stack pointer overflow - unable to access the memory of the instance".to_string())?;
let unwind_data_ptr: WasmPtr<__wasi_asyncify_t<M::Offset>, M> = WasmPtr::new(
unwind_pointer
.try_into()
.map_err(|_| Errno::Overflow)
.unwrap(),
);
let unwind_data_result = unwind_data_ptr.read(&memory).unwrap();
let unwind_stack_finish: u64 = unwind_data_result.start.into();
let unwind_size = unwind_stack_finish - unwind_stack_begin;
trace!(
"wasi[{}:{}]::unwound (memory_stack_size={} unwind_size={})",
ctx.data().pid(),
ctx.data().tid(),
memory_stack.len(),
unwind_size
);
let unwind_stack_ptr = WasmPtr::<u8, M>::new(
unwind_stack_begin
.try_into()
.map_err(|_| "failed to save stack: stack pointer overflow".to_string())?,
);
let unwind_stack = unwind_stack_ptr
.slice(
&memory,
unwind_size
.try_into()
.map_err(|_| "failed to save stack: stack pointer overflow".to_string())?,
)
.and_then(|memory_stack| memory_stack.read_to_bytes())
.map_err(|err| format!("failed to read stack: {}", err))?;
if let Some(asyncify_stop_unwind) = env
.try_inner()
.into_iter()
.filter_map(|i| i.asyncify_stop_unwind.clone())
.next()
{
asyncify_stop_unwind.call(&mut ctx);
} else {
warn!("failed to unwind the stack because the asyncify_start_rewind export is missing");
return Ok(OnCalledAction::Finish);
}
Ok(callback(ctx, memory_stack, unwind_stack))
});
Ok(Errno::Success)
}
#[must_use = "the action must be passed to the call loop"]
pub fn rewind<M: MemorySize, T>(
mut ctx: FunctionEnvMut<WasiEnv>,
memory_stack: Bytes,
rewind_stack: Bytes,
store_data: Bytes,
result: T,
) -> Errno
where
T: serde::Serialize,
{
let rewind_result = bincode::serialize(&result).unwrap().into();
rewind_ext::<M>(
&mut ctx,
Some(memory_stack),
rewind_stack,
store_data,
RewindResultType::RewindWithResult(rewind_result),
)
}
#[instrument(level = "trace", skip_all, fields(rewind_stack_len = rewind_stack.len(), store_data_len = store_data.len()))]
#[must_use = "the action must be passed to the call loop"]
pub fn rewind_ext<M: MemorySize>(
ctx: &mut FunctionEnvMut<WasiEnv>,
memory_stack: Option<Bytes>,
rewind_stack: Bytes,
store_data: Bytes,
rewind_result: RewindResultType,
) -> Errno {
ctx.data_mut().thread.set_rewind(RewindResult {
memory_stack,
rewind_result,
});
let store_snapshot = match StoreSnapshot::deserialize(&store_data[..]) {
Ok(a) => a,
Err(err) => {
warn!("snapshot restore failed - the store snapshot could not be deserialized");
return Errno::Unknown;
}
};
crate::utils::store::restore_store_snapshot(ctx, &store_snapshot);
let env = ctx.data();
let memory = match env.try_memory_view(&ctx) {
Some(v) => v,
None => {
warn!("snapshot restore failed - unable to access the memory of the instance");
return Errno::Unknown;
}
};
let rewind_pointer = env.layout.stack_lower;
let rewind_data_start =
rewind_pointer + (std::mem::size_of::<__wasi_asyncify_t<M::Offset>>() as u64);
let rewind_data_end = rewind_data_start + (rewind_stack.len() as u64);
if rewind_data_end > env.layout.stack_upper {
warn!(
"attempting to rewind a stack bigger than the allocated stack space ({} > {})",
rewind_data_end, env.layout.stack_upper
);
return Errno::Overflow;
}
let rewind_data = __wasi_asyncify_t::<M::Offset> {
start: wasi_try!(rewind_data_end.try_into().map_err(|_| Errno::Overflow)),
end: wasi_try!(env
.layout
.stack_upper
.try_into()
.map_err(|_| Errno::Overflow)),
};
let rewind_data_ptr: WasmPtr<__wasi_asyncify_t<M::Offset>, M> =
WasmPtr::new(wasi_try!(rewind_pointer
.try_into()
.map_err(|_| Errno::Overflow)));
wasi_try_mem!(rewind_data_ptr.write(&memory, rewind_data));
let rewind_stack_ptr = WasmPtr::<u8, M>::new(wasi_try!(rewind_data_start
.try_into()
.map_err(|_| Errno::Overflow)));
wasi_try_mem!(rewind_stack_ptr
.slice(
&memory,
wasi_try!(rewind_stack.len().try_into().map_err(|_| Errno::Overflow))
)
.and_then(|stack| { stack.write_slice(&rewind_stack[..]) }));
let asyncify_data = wasi_try!(rewind_pointer.try_into().map_err(|_| Errno::Overflow));
if let Some(asyncify_start_rewind) = env
.try_inner()
.into_iter()
.filter_map(|a| a.asyncify_start_rewind.clone())
.next()
{
asyncify_start_rewind.call(ctx, asyncify_data);
} else {
warn!("failed to rewind the stack because the asyncify_start_rewind export is missing or inaccessible");
return Errno::Noexec;
}
Errno::Success
}
pub fn rewind_ext2(
ctx: &mut FunctionEnvMut<WasiEnv>,
rewind_state: RewindStateOption,
) -> Result<(), ExitCode> {
if let Some((rewind_state, rewind_result)) = rewind_state {
tracing::trace!("Rewinding");
let errno = if rewind_state.is_64bit {
crate::rewind_ext::<wasmer_types::Memory64>(
ctx,
Some(rewind_state.memory_stack),
rewind_state.rewind_stack,
rewind_state.store_data,
rewind_result,
)
} else {
crate::rewind_ext::<wasmer_types::Memory32>(
ctx,
Some(rewind_state.memory_stack),
rewind_state.rewind_stack,
rewind_state.store_data,
rewind_result,
)
};
if errno != Errno::Success {
let exit_code = ExitCode::from(errno);
ctx.data().blocking_on_exit(Some(exit_code));
return Err(exit_code);
}
}
Ok(())
}
pub fn anyhow_err_to_runtime_err(err: anyhow::Error) -> WasiRuntimeError {
WasiRuntimeError::Runtime(RuntimeError::user(err.into()))
}
pub(crate) unsafe fn handle_rewind<M: MemorySize, T>(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
) -> Option<T>
where
T: serde::de::DeserializeOwned,
{
handle_rewind_ext::<M, T>(ctx, HandleRewindType::ResultDriven).flatten()
}
pub(crate) enum HandleRewindType {
ResultDriven,
ResultLess,
}
pub(crate) unsafe fn handle_rewind_ext_with_default<M: MemorySize, T>(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
type_: HandleRewindType,
) -> Option<T>
where
T: serde::de::DeserializeOwned + Default,
{
let ret = handle_rewind_ext::<M, T>(ctx, type_);
ret.unwrap_or_default()
}
pub(crate) unsafe fn handle_rewind_ext<M: MemorySize, T>(
ctx: &mut FunctionEnvMut<'_, WasiEnv>,
type_: HandleRewindType,
) -> Option<Option<T>>
where
T: serde::de::DeserializeOwned,
{
let env = ctx.data();
if !env.thread.has_rewind_of_type(type_) {
return None;
};
let tid = env.tid();
let pid = env.pid();
if let Some(result) = ctx.data_mut().thread.take_rewind() {
let memory_stack = result.memory_stack;
let env = ctx.data();
if let Some(asyncify_stop_rewind) = env.inner().asyncify_stop_unwind.clone() {
asyncify_stop_rewind.call(ctx);
} else {
warn!("failed to handle rewind because the asyncify_start_rewind export is missing or inaccessible");
return Some(None);
}
let (env, mut store) = ctx.data_and_store_mut();
if let Some(memory_stack) = memory_stack {
set_memory_stack::<M>(env, &mut store, memory_stack);
}
match result.rewind_result {
RewindResultType::RewindRestart => {
debug!(%pid, %tid, "rewind for syscall restart");
None
}
RewindResultType::RewindWithoutResult => {
debug!(%pid, %tid, "rewind with no result");
Some(None)
}
RewindResultType::RewindWithResult(rewind_result) => {
debug!(%pid, %tid, "rewind with result (data={})", rewind_result.len());
let ret = bincode::deserialize(&rewind_result)
.expect("failed to deserialize the rewind result");
Some(Some(ret))
}
}
} else {
debug!(%pid, %tid, "rewind miss");
Some(None)
}
}
pub(crate) fn _prepare_wasi(
wasi_env: &mut WasiEnv,
args: Option<Vec<String>>,
envs: Option<Vec<(String, String)>>,
) {
if let Some(args) = args {
let mut wasi_state = wasi_env.state.fork();
*wasi_state.args.lock().unwrap() = args;
wasi_env.state = Arc::new(wasi_state);
}
if let Some(envs) = envs {
let mut guard = wasi_env.state.envs.lock().unwrap();
let mut existing_envs = guard
.iter()
.map(|b| {
let string = String::from_utf8_lossy(b);
let (key, val) = string.split_once('=').expect("env var is malformed");
(key.to_string(), val.to_string().as_bytes().to_vec())
})
.collect::<Vec<_>>();
for (key, val) in envs {
let val = val.as_bytes().to_vec();
match existing_envs
.iter_mut()
.find(|(existing_key, _)| existing_key == &key)
{
Some((_, existing_val)) => *existing_val = val,
None => existing_envs.push((key, val)),
}
}
let envs = conv_env_vars(existing_envs);
*guard = envs;
drop(guard)
}
let close_fds = {
let preopen_fds = {
let preopen_fds = wasi_env.state.fs.preopen_fds.read().unwrap();
preopen_fds.iter().copied().collect::<HashSet<_>>()
};
let mut fd_map = wasi_env.state.fs.fd_map.read().unwrap();
fd_map
.keys()
.filter_map(|a| match *a {
a if a <= __WASI_STDERR_FILENO => None,
a if preopen_fds.contains(&a) => None,
a => Some(a),
})
.collect::<Vec<_>>()
};
for fd in close_fds {
let _ = wasi_env.state.fs.close_fd(fd);
}
}
pub(crate) fn conv_spawn_err_to_errno(err: &SpawnError) -> Errno {
match err {
SpawnError::AccessDenied => Errno::Access,
SpawnError::Unsupported => Errno::Noexec,
_ if err.is_not_found() => Errno::Noent,
_ => Errno::Inval,
}
}
pub(crate) fn conv_spawn_err_to_exit_code(err: &SpawnError) -> ExitCode {
conv_spawn_err_to_errno(err).into()
}