use std::{
collections::HashMap,
path::{Path, PathBuf},
sync::Arc,
};
use anyhow::{Context, Error};
use futures::future::BoxFuture;
use tokio::runtime::Handle;
use virtual_fs::{FileSystem, FsError, OverlayFileSystem, RootFileSystemBuilder, TmpFileSystem};
use wasmer::Imports;
use webc::metadata::annotations::Wasi as WasiAnnotation;
use crate::{
bin_factory::BinaryPackage,
capabilities::Capabilities,
journal::{DynJournal, SnapshotTrigger},
WasiEnvBuilder,
};
pub const MAPPED_CURRENT_DIR_DEFAULT_PATH: &str = "/home";
#[derive(Debug, Clone)]
pub struct MappedCommand {
pub alias: String,
pub target: String,
}
#[derive(Debug, Default, Clone)]
pub(crate) struct CommonWasiOptions {
pub(crate) entry_function: Option<String>,
pub(crate) args: Vec<String>,
pub(crate) env: HashMap<String, String>,
pub(crate) forward_host_env: bool,
pub(crate) mapped_host_commands: Vec<MappedCommand>,
pub(crate) mounts: Vec<MountedDirectory>,
pub(crate) is_home_mapped: bool,
pub(crate) is_tmp_mapped: bool,
pub(crate) injected_packages: Vec<BinaryPackage>,
pub(crate) capabilities: Capabilities,
pub(crate) journals: Vec<Arc<DynJournal>>,
pub(crate) snapshot_on: Vec<SnapshotTrigger>,
pub(crate) snapshot_interval: Option<std::time::Duration>,
pub(crate) current_dir: Option<PathBuf>,
pub(crate) additional_imports: Imports,
}
impl CommonWasiOptions {
pub(crate) fn prepare_webc_env(
&self,
builder: &mut WasiEnvBuilder,
container_fs: Option<Arc<dyn FileSystem + Send + Sync>>,
wasi: &WasiAnnotation,
root_fs: Option<TmpFileSystem>,
) -> Result<(), anyhow::Error> {
if let Some(ref entry_function) = self.entry_function {
builder.set_entry_function(entry_function);
}
let root_fs = root_fs.unwrap_or_else(|| {
RootFileSystemBuilder::default()
.with_tmp(!self.is_tmp_mapped)
.build()
});
let fs = prepare_filesystem(root_fs, &self.mounts, container_fs)?;
builder.add_preopen_dir("/")?;
if self.mounts.iter().all(|m| m.guest != ".") {
let path = builder.get_current_dir().unwrap_or(PathBuf::from("/"));
builder.add_map_dir(".", path)?;
}
builder.set_fs(Box::new(fs));
for pkg in &self.injected_packages {
builder.add_webc(pkg.clone());
}
let mapped_cmds = self
.mapped_host_commands
.iter()
.map(|c| (c.alias.as_str(), c.target.as_str()));
builder.add_mapped_commands(mapped_cmds);
self.populate_env(wasi, builder);
self.populate_args(wasi, builder);
*builder.capabilities_mut() = self.capabilities.clone();
builder.add_imports(&self.additional_imports);
Ok(())
}
fn populate_env(&self, wasi: &WasiAnnotation, builder: &mut WasiEnvBuilder) {
for item in wasi.env.as_deref().unwrap_or_default() {
match item.split_once('=') {
Some((k, v)) => {
builder.add_env(k, v);
}
None => {
builder.add_env(item, String::new());
}
}
}
if self.forward_host_env {
builder.add_envs(std::env::vars());
}
builder.add_envs(self.env.clone());
}
fn populate_args(&self, wasi: &WasiAnnotation, builder: &mut WasiEnvBuilder) {
if let Some(main_args) = &wasi.main_args {
builder.add_args(main_args);
}
builder.add_args(&self.args);
}
}
fn build_directory_mappings(
root_fs: &mut TmpFileSystem,
mounted_dirs: &[MountedDirectory],
) -> Result<(), anyhow::Error> {
for dir in mounted_dirs {
let MountedDirectory {
guest: guest_path,
fs,
} = dir;
let mut guest_path = PathBuf::from(guest_path);
tracing::debug!(
guest=%guest_path.display(),
"Mounting",
);
if guest_path.is_relative() {
guest_path = apply_relative_path_mounting_hack(&guest_path);
}
let guest_path = root_fs
.canonicalize_unchecked(&guest_path)
.with_context(|| {
format!(
"Unable to canonicalize guest path '{}'",
guest_path.display()
)
})?;
if guest_path == Path::new("/") {
root_fs
.mount_directory_entries(&guest_path, fs, "/".as_ref())
.context("Unable to mount to root")?;
} else {
if let Some(parent) = guest_path.parent() {
create_dir_all(&*root_fs, parent).with_context(|| {
format!("Unable to create the \"{}\" directory", parent.display())
})?;
}
TmpFileSystem::mount(root_fs, guest_path.clone(), fs, "/".into())
.with_context(|| format!("Unable to mount \"{}\"", guest_path.display()))?;
}
}
Ok(())
}
fn prepare_filesystem(
mut root_fs: TmpFileSystem,
mounted_dirs: &[MountedDirectory],
container_fs: Option<Arc<dyn FileSystem + Send + Sync>>,
) -> Result<Box<dyn FileSystem + Send + Sync>, Error> {
if !mounted_dirs.is_empty() {
build_directory_mappings(&mut root_fs, mounted_dirs)?;
}
let fs = if let Some(container) = container_fs {
let container = RelativeOrAbsolutePathHack(container);
let fs = OverlayFileSystem::new(root_fs, [container]);
Box::new(fs) as Box<dyn FileSystem + Send + Sync>
} else {
let fs = RelativeOrAbsolutePathHack(root_fs);
Box::new(fs) as Box<dyn FileSystem + Send + Sync>
};
Ok(fs)
}
fn apply_relative_path_mounting_hack(original: &Path) -> PathBuf {
debug_assert!(original.is_relative());
let root = Path::new("/");
let mapped_path = if original == Path::new(".") {
root.to_path_buf()
} else {
root.join(original)
};
tracing::debug!(
original_path=%original.display(),
remapped_path=%mapped_path.display(),
"Remapping a relative path"
);
mapped_path
}
fn create_dir_all(fs: &dyn FileSystem, path: &Path) -> Result<(), Error> {
if fs.metadata(path).is_ok() {
return Ok(());
}
if let Some(parent) = path.parent() {
create_dir_all(fs, parent)?;
}
fs.create_dir(path)?;
Ok(())
}
#[derive(Debug, Clone)]
pub struct MountedDirectory {
pub guest: String,
pub fs: Arc<dyn FileSystem + Send + Sync>,
}
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct MappedDirectory {
pub host: std::path::PathBuf,
pub guest: String,
}
impl From<MappedDirectory> for MountedDirectory {
fn from(value: MappedDirectory) -> Self {
cfg_if::cfg_if! {
if #[cfg(feature = "host-fs")] {
let MappedDirectory { host, guest } = value;
let fs: Arc<dyn FileSystem + Send + Sync> =
Arc::new(virtual_fs::host_fs::FileSystem::new(Handle::current(), host).unwrap());
MountedDirectory { guest, fs }
} else {
unreachable!("The `host-fs` feature needs to be enabled to map {value:?}")
}
}
}
}
#[derive(Debug)]
struct RelativeOrAbsolutePathHack<F>(F);
impl<F: FileSystem> RelativeOrAbsolutePathHack<F> {
fn execute<Func, Ret>(&self, path: &Path, operation: Func) -> Result<Ret, FsError>
where
Func: Fn(&F, &Path) -> Result<Ret, FsError>,
{
let result = operation(&self.0, path);
if result.is_err() && !path.is_absolute() {
let path = Path::new("/").join(path);
operation(&self.0, &path)
} else {
result
}
}
}
impl<F: FileSystem> virtual_fs::FileSystem for RelativeOrAbsolutePathHack<F> {
fn readlink(&self, path: &Path) -> virtual_fs::Result<PathBuf> {
self.execute(path, |fs, p| fs.readlink(p))
}
fn read_dir(&self, path: &Path) -> virtual_fs::Result<virtual_fs::ReadDir> {
self.execute(path, |fs, p| fs.read_dir(p))
}
fn create_dir(&self, path: &Path) -> virtual_fs::Result<()> {
self.execute(path, |fs, p| fs.create_dir(p))
}
fn remove_dir(&self, path: &Path) -> virtual_fs::Result<()> {
self.execute(path, |fs, p| fs.remove_dir(p))
}
fn rename<'a>(&'a self, from: &Path, to: &Path) -> BoxFuture<'a, virtual_fs::Result<()>> {
let from = from.to_owned();
let to = to.to_owned();
Box::pin(async move { self.0.rename(&from, &to).await })
}
fn metadata(&self, path: &Path) -> virtual_fs::Result<virtual_fs::Metadata> {
self.execute(path, |fs, p| fs.metadata(p))
}
fn symlink_metadata(&self, path: &Path) -> virtual_fs::Result<virtual_fs::Metadata> {
self.execute(path, |fs, p| fs.symlink_metadata(p))
}
fn remove_file(&self, path: &Path) -> virtual_fs::Result<()> {
self.execute(path, |fs, p| fs.remove_file(p))
}
fn new_open_options(&self) -> virtual_fs::OpenOptions {
virtual_fs::OpenOptions::new(self)
}
fn mount(
&self,
name: String,
path: &Path,
fs: Box<dyn FileSystem + Send + Sync>,
) -> virtual_fs::Result<()> {
let name_ref = &name;
let f_ref = &Arc::new(fs);
self.execute(path, move |f, p| {
f.mount(name_ref.clone(), p, Box::new(f_ref.clone()))
})
}
}
impl<F: FileSystem> virtual_fs::FileOpener for RelativeOrAbsolutePathHack<F> {
fn open(
&self,
path: &Path,
conf: &virtual_fs::OpenOptionsConfig,
) -> virtual_fs::Result<Box<dyn virtual_fs::VirtualFile + Send + Sync + 'static>> {
self.execute(path, |fs, p| {
fs.new_open_options().options(conf.clone()).open(p)
})
}
}
#[cfg(test)]
mod tests {
use std::time::SystemTime;
use tempfile::TempDir;
use virtual_fs::{DirEntry, FileType, Metadata, WebcVolumeFileSystem};
use wasmer_package::utils::from_bytes;
use super::*;
const PYTHON: &[u8] = include_bytes!("../../../c-api/examples/assets/python-0.1.0.wasmer");
#[tokio::test]
async fn mix_args_from_the_webc_and_user() {
let args = CommonWasiOptions {
args: vec!["extra".to_string(), "args".to_string()],
..Default::default()
};
let mut builder = WasiEnvBuilder::new("program-name");
let fs = Arc::new(virtual_fs::EmptyFileSystem::default());
let mut annotations = WasiAnnotation::new("some-atom");
annotations.main_args = Some(vec![
"hard".to_string(),
"coded".to_string(),
"args".to_string(),
]);
args.prepare_webc_env(&mut builder, Some(fs), &annotations, None)
.unwrap();
assert_eq!(
builder.get_args(),
[
"program-name",
"hard",
"coded",
"args",
"extra",
"args",
]
);
}
#[tokio::test]
async fn mix_env_vars_from_the_webc_and_user() {
let args = CommonWasiOptions {
env: vec![("EXTRA".to_string(), "envs".to_string())]
.into_iter()
.collect(),
..Default::default()
};
let mut builder = WasiEnvBuilder::new("python");
let fs = Arc::new(virtual_fs::EmptyFileSystem::default());
let mut annotations = WasiAnnotation::new("python");
annotations.env = Some(vec!["HARD_CODED=env-vars".to_string()]);
args.prepare_webc_env(&mut builder, Some(fs), &annotations, None)
.unwrap();
assert_eq!(
builder.get_env(),
[
("HARD_CODED".to_string(), b"env-vars".to_vec()),
("EXTRA".to_string(), b"envs".to_vec()),
]
);
}
#[tokio::test]
#[cfg_attr(not(feature = "host-fs"), ignore)]
async fn python_use_case() {
let temp = TempDir::new().unwrap();
let sub_dir = temp.path().join("path").join("to");
std::fs::create_dir_all(&sub_dir).unwrap();
std::fs::write(sub_dir.join("file.txt"), b"Hello, World!").unwrap();
let mapping = [MountedDirectory::from(MappedDirectory {
guest: "/home".to_string(),
host: sub_dir,
})];
let container = from_bytes(PYTHON).unwrap();
let webc_fs = WebcVolumeFileSystem::mount_all(&container);
let root_fs = RootFileSystemBuilder::default().build();
let fs = prepare_filesystem(root_fs, &mapping, Some(Arc::new(webc_fs))).unwrap();
assert!(fs.metadata("/home/file.txt".as_ref()).unwrap().is_file());
assert!(fs.metadata("lib".as_ref()).unwrap().is_dir());
assert!(fs
.metadata("lib/python3.6/collections/__init__.py".as_ref())
.unwrap()
.is_file());
assert!(fs
.metadata("lib/python3.6/encodings/__init__.py".as_ref())
.unwrap()
.is_file());
}
fn unix_timestamp_nanos(instant: SystemTime) -> Option<u64> {
let duration = instant.duration_since(SystemTime::UNIX_EPOCH).ok()?;
Some(duration.as_nanos() as u64)
}
#[tokio::test]
#[cfg_attr(not(feature = "host-fs"), ignore)]
async fn convert_mapped_directory_to_mounted_directory() {
let temp = TempDir::new().unwrap();
let dir = MappedDirectory {
guest: "/mnt/dir".to_string(),
host: temp.path().to_path_buf(),
};
let contents = "Hello, World!";
let file_txt = temp.path().join("file.txt");
std::fs::write(&file_txt, contents).unwrap();
let metadata = std::fs::metadata(&file_txt).unwrap();
let got = MountedDirectory::from(dir);
let directory_contents: Vec<_> = got
.fs
.read_dir("/".as_ref())
.unwrap()
.map(|entry| entry.unwrap())
.collect();
assert_eq!(
directory_contents,
vec![DirEntry {
path: PathBuf::from("/file.txt"),
metadata: Ok(Metadata {
ft: FileType::new_file(),
accessed: metadata
.accessed()
.ok()
.and_then(unix_timestamp_nanos)
.unwrap_or(0),
created: metadata
.created()
.ok()
.and_then(unix_timestamp_nanos)
.unwrap_or(0),
modified: metadata
.modified()
.ok()
.and_then(unix_timestamp_nanos)
.unwrap_or(0),
len: contents.len() as u64,
})
}]
);
}
}