use anyhow::{anyhow, bail, Context as _, Result};
use clap::Parser;
use once_cell::sync::Lazy;
use std::ffi::OsStr;
use std::fs::File;
use std::io::Write;
use std::path::{Component, Path, PathBuf};
use std::thread;
use std::time::Duration;
use wasmtime::{
AsContextMut, Engine, Func, GuestProfiler, Linker, Module, Store, StoreLimits,
StoreLimitsBuilder, Val, ValType,
};
use wasmtime_cli_flags::{CommonOptions, WasiModules};
use wasmtime_wasi::maybe_exit_on_error;
use wasmtime_wasi::sync::{ambient_authority, Dir, TcpListener, WasiCtxBuilder};
#[cfg(any(
feature = "wasi-crypto",
feature = "wasi-nn",
feature = "wasi-threads",
feature = "wasi-http"
))]
use std::sync::Arc;
#[cfg(feature = "wasi-nn")]
use wasmtime_wasi_nn::WasiNnCtx;
#[cfg(feature = "wasi-crypto")]
use wasmtime_wasi_crypto::WasiCryptoCtx;
#[cfg(feature = "wasi-threads")]
use wasmtime_wasi_threads::WasiThreadsCtx;
#[cfg(feature = "wasi-http")]
use wasmtime_wasi_http::WasiHttp;
fn parse_module(s: &OsStr) -> anyhow::Result<PathBuf> {
match s.to_str() {
Some("help") | Some("config") | Some("run") | Some("wast") | Some("compile") => {
bail!("module name cannot be the same as a subcommand")
}
#[cfg(unix)]
Some("-") => Ok(PathBuf::from("/dev/stdin")),
_ => Ok(s.into()),
}
}
fn parse_env_var(s: &str) -> Result<(String, String)> {
let parts: Vec<_> = s.splitn(2, '=').collect();
if parts.len() != 2 {
bail!("must be of the form `key=value`");
}
Ok((parts[0].to_owned(), parts[1].to_owned()))
}
fn parse_map_dirs(s: &str) -> Result<(String, String)> {
let parts: Vec<&str> = s.split("::").collect();
if parts.len() != 2 {
bail!("must contain exactly one double colon ('::')");
}
Ok((parts[0].into(), parts[1].into()))
}
fn parse_dur(s: &str) -> Result<Duration> {
if let Ok(val) = s.parse() {
return Ok(Duration::from_secs(val));
}
let dur = humantime::parse_duration(s)?;
Ok(dur)
}
fn parse_preloads(s: &str) -> Result<(String, PathBuf)> {
let parts: Vec<&str> = s.splitn(2, '=').collect();
if parts.len() != 2 {
bail!("must contain exactly one equals character ('=')");
}
Ok((parts[0].into(), parts[1].into()))
}
fn parse_profile(s: &str) -> Result<Profile> {
let parts = s.split(',').collect::<Vec<_>>();
match &parts[..] {
["perfmap"] => Ok(Profile::Native(wasmtime::ProfilingStrategy::PerfMap)),
["jitdump"] => Ok(Profile::Native(wasmtime::ProfilingStrategy::JitDump)),
["vtune"] => Ok(Profile::Native(wasmtime::ProfilingStrategy::VTune)),
["guest"] => Ok(Profile::Guest {
path: "wasmtime-guest-profile.json".to_string(),
interval: Duration::from_millis(10),
}),
["guest", path] => Ok(Profile::Guest {
path: path.to_string(),
interval: Duration::from_millis(10),
}),
["guest", path, dur] => Ok(Profile::Guest {
path: path.to_string(),
interval: parse_dur(dur)?,
}),
_ => bail!("unknown profiling strategy: {s}"),
}
}
static AFTER_HELP: Lazy<String> = Lazy::new(|| crate::FLAG_EXPLANATIONS.to_string());
#[derive(Parser)]
#[structopt(name = "run", trailing_var_arg = true, after_help = AFTER_HELP.as_str())]
pub struct RunCommand {
#[clap(flatten)]
common: CommonOptions,
#[clap(long = "allow-unknown-exports")]
allow_unknown_exports: bool,
#[clap(long = "trap-unknown-imports")]
trap_unknown_imports: bool,
#[clap(long = "default-values-unknown-imports")]
default_values_unknown_imports: bool,
#[clap(long = "allow-precompiled")]
allow_precompiled: bool,
#[clap(long = "listenfd")]
listenfd: bool,
#[clap(
long = "tcplisten",
number_of_values = 1,
value_name = "SOCKET ADDRESS"
)]
tcplisten: Vec<String>,
#[clap(long = "dir", number_of_values = 1, value_name = "DIRECTORY")]
dirs: Vec<String>,
#[clap(long = "env", number_of_values = 1, value_name = "NAME=VAL", parse(try_from_str = parse_env_var))]
vars: Vec<(String, String)>,
#[clap(long, value_name = "FUNCTION")]
invoke: Option<String>,
#[clap(long = "mapdir", number_of_values = 1, value_name = "GUEST_DIR::HOST_DIR", parse(try_from_str = parse_map_dirs))]
map_dirs: Vec<(String, String)>,
#[clap(
required = true,
value_name = "MODULE",
parse(try_from_os_str = parse_module),
)]
module: PathBuf,
#[clap(
long = "preload",
number_of_values = 1,
value_name = "NAME=MODULE_PATH",
parse(try_from_str = parse_preloads)
)]
preloads: Vec<(String, PathBuf)>,
#[clap(
long = "wasm-timeout",
value_name = "TIME",
parse(try_from_str = parse_dur),
)]
wasm_timeout: Option<Duration>,
#[clap(
long,
value_name = "STRATEGY",
parse(try_from_str = parse_profile),
)]
profile: Option<Profile>,
#[clap(long = "coredump-on-trap", value_name = "PATH")]
coredump_on_trap: Option<String>,
#[clap(value_name = "ARGS")]
module_args: Vec<String>,
#[clap(long, value_name = "BYTES")]
max_memory_size: Option<usize>,
#[clap(long)]
max_table_elements: Option<u32>,
#[clap(long)]
max_instances: Option<usize>,
#[clap(long)]
max_tables: Option<usize>,
#[clap(long)]
max_memories: Option<usize>,
#[clap(long)]
trap_on_grow_failure: bool,
}
enum Profile {
Native(wasmtime::ProfilingStrategy),
Guest { path: String, interval: Duration },
}
impl RunCommand {
pub fn execute(&self) -> Result<()> {
self.common.init_logging();
let mut config = self.common.config(None)?;
if self.wasm_timeout.is_some() {
config.epoch_interruption(true);
}
match self.profile {
Some(Profile::Native(s)) => {
config.profiler(s);
}
Some(Profile::Guest { .. }) => {
config.epoch_interruption(true);
}
None => {}
}
let engine = Engine::new(&config)?;
let preopen_sockets = self.compute_preopen_sockets()?;
if let Some(coredump_path) = self.coredump_on_trap.as_ref() {
if coredump_path.contains("%") {
bail!("the coredump-on-trap path does not support patterns yet.")
}
}
let preopen_dirs = self.compute_preopen_dirs()?;
let argv = self.compute_argv();
let mut linker = Linker::new(&engine);
linker.allow_unknown_exports(self.allow_unknown_exports);
let module = self.load_module(linker.engine(), &self.module)?;
let mut modules = vec![(String::new(), module.clone())];
let host = Host::default();
let mut store = Store::new(&engine, host);
populate_with_wasi(
&mut linker,
&mut store,
module.clone(),
preopen_dirs,
&argv,
&self.vars,
&self.common.wasi_modules.unwrap_or(WasiModules::default()),
self.listenfd,
preopen_sockets,
)?;
let mut limits = StoreLimitsBuilder::new();
if let Some(max) = self.max_memory_size {
limits = limits.memory_size(max);
}
if let Some(max) = self.max_table_elements {
limits = limits.table_elements(max);
}
if let Some(max) = self.max_instances {
limits = limits.instances(max);
}
if let Some(max) = self.max_tables {
limits = limits.tables(max);
}
if let Some(max) = self.max_memories {
limits = limits.memories(max);
}
store.data_mut().limits = limits
.trap_on_grow_failure(self.trap_on_grow_failure)
.build();
store.limiter(|t| &mut t.limits);
if let Some(fuel) = self.common.fuel {
store.add_fuel(fuel)?;
}
for (name, path) in self.preloads.iter() {
let module = self.load_module(&engine, path)?;
modules.push((name.clone(), module.clone()));
linker.module(&mut store, name, &module).context(format!(
"failed to process preload `{}` at `{}`",
name,
path.display()
))?;
}
match self
.load_main_module(&mut store, &mut linker, module, modules, &argv[0])
.with_context(|| format!("failed to run main module `{}`", self.module.display()))
{
Ok(()) => (),
Err(e) => {
return Err(maybe_exit_on_error(e));
}
}
Ok(())
}
fn compute_preopen_dirs(&self) -> Result<Vec<(String, Dir)>> {
let mut preopen_dirs = Vec::new();
for dir in self.dirs.iter() {
preopen_dirs.push((
dir.clone(),
Dir::open_ambient_dir(dir, ambient_authority())
.with_context(|| format!("failed to open directory '{}'", dir))?,
));
}
for (guest, host) in self.map_dirs.iter() {
preopen_dirs.push((
guest.clone(),
Dir::open_ambient_dir(host, ambient_authority())
.with_context(|| format!("failed to open directory '{}'", host))?,
));
}
Ok(preopen_dirs)
}
fn compute_preopen_sockets(&self) -> Result<Vec<TcpListener>> {
let mut listeners = vec![];
for address in &self.tcplisten {
let stdlistener = std::net::TcpListener::bind(address)
.with_context(|| format!("failed to bind to address '{}'", address))?;
let _ = stdlistener.set_nonblocking(true)?;
listeners.push(TcpListener::from_std(stdlistener))
}
Ok(listeners)
}
fn compute_argv(&self) -> Vec<String> {
let mut result = Vec::new();
result.push(
self.module
.components()
.next_back()
.map(Component::as_os_str)
.and_then(OsStr::to_str)
.unwrap_or("")
.to_owned(),
);
for arg in self.module_args.iter() {
result.push(arg.clone());
}
result
}
fn setup_epoch_handler(
&self,
store: &mut Store<Host>,
module_name: &str,
modules: Vec<(String, Module)>,
) -> Box<dyn FnOnce(&mut Store<Host>)> {
if let Some(Profile::Guest { path, interval }) = &self.profile {
let interval = *interval;
store.data_mut().guest_profiler =
Some(Arc::new(GuestProfiler::new(module_name, interval, modules)));
fn sample(mut store: impl AsContextMut<Data = Host>) {
let mut profiler = store
.as_context_mut()
.data_mut()
.guest_profiler
.take()
.unwrap();
Arc::get_mut(&mut profiler)
.expect("profiling doesn't support threads yet")
.sample(&store);
store.as_context_mut().data_mut().guest_profiler = Some(profiler);
}
if let Some(timeout) = self.wasm_timeout {
let mut timeout = (timeout.as_secs_f64() / interval.as_secs_f64()).ceil() as u64;
assert!(timeout > 0);
store.epoch_deadline_callback(move |mut store| {
sample(&mut store);
timeout -= 1;
if timeout == 0 {
bail!("timeout exceeded");
}
Ok(1)
});
} else {
store.epoch_deadline_callback(move |mut store| {
sample(&mut store);
Ok(1)
});
}
store.set_epoch_deadline(1);
let engine = store.engine().clone();
thread::spawn(move || loop {
thread::sleep(interval);
engine.increment_epoch();
});
let path = path.clone();
return Box::new(move |store| {
let profiler = Arc::try_unwrap(store.data_mut().guest_profiler.take().unwrap())
.expect("profiling doesn't support threads yet");
if let Err(e) = std::fs::File::create(&path)
.map_err(anyhow::Error::new)
.and_then(|output| profiler.finish(std::io::BufWriter::new(output)))
{
eprintln!("failed writing profile at {path}: {e:#}");
} else {
eprintln!();
eprintln!("Profile written to: {path}");
eprintln!("View this profile at https://profiler.firefox.com/.");
}
});
}
if let Some(timeout) = self.wasm_timeout {
store.set_epoch_deadline(1);
let engine = store.engine().clone();
thread::spawn(move || {
thread::sleep(timeout);
engine.increment_epoch();
});
}
Box::new(|_store| {})
}
fn load_main_module(
&self,
store: &mut Store<Host>,
linker: &mut Linker<Host>,
module: Module,
modules: Vec<(String, Module)>,
module_name: &str,
) -> Result<()> {
if self.trap_unknown_imports {
linker.define_unknown_imports_as_traps(&module)?;
}
if self.default_values_unknown_imports {
linker.define_unknown_imports_as_default_values(&module)?;
}
linker
.module(&mut *store, "", &module)
.context(format!("failed to instantiate {:?}", self.module))?;
let func = if let Some(name) = &self.invoke {
self.find_export(store, linker, name)?
} else {
linker.get_default(&mut *store, "")?
};
let finish_epoch_handler = self.setup_epoch_handler(store, module_name, modules);
let result = self.invoke_func(store, func);
finish_epoch_handler(store);
result
}
fn find_export(
&self,
store: &mut Store<Host>,
linker: &Linker<Host>,
name: &str,
) -> Result<Func> {
let func = match linker
.get(&mut *store, "", name)
.ok_or_else(|| anyhow!("no export named `{}` found", name))?
.into_func()
{
Some(func) => func,
None => bail!("export of `{}` wasn't a function", name),
};
Ok(func)
}
fn invoke_func(&self, store: &mut Store<Host>, func: Func) -> Result<()> {
let ty = func.ty(&store);
if ty.params().len() > 0 {
eprintln!(
"warning: using `--invoke` with a function that takes arguments \
is experimental and may break in the future"
);
}
let mut args = self.module_args.iter();
let mut values = Vec::new();
for ty in ty.params() {
let val = match args.next() {
Some(s) => s,
None => {
if let Some(name) = &self.invoke {
bail!("not enough arguments for `{}`", name)
} else {
bail!("not enough arguments for command default")
}
}
};
values.push(match ty {
ValType::I32 => Val::I32(val.parse()?),
ValType::I64 => Val::I64(val.parse()?),
ValType::F32 => Val::F32(val.parse()?),
ValType::F64 => Val::F64(val.parse()?),
t => bail!("unsupported argument type {:?}", t),
});
}
let mut results = vec![Val::null(); ty.results().len()];
let invoke_res = func.call(store, &values, &mut results).with_context(|| {
if let Some(name) = &self.invoke {
format!("failed to invoke `{}`", name)
} else {
format!("failed to invoke command default")
}
});
if let Err(err) = invoke_res {
let err = if err.is::<wasmtime::Trap>() {
if let Some(coredump_path) = self.coredump_on_trap.as_ref() {
let source_name = self.module.to_str().unwrap_or_else(|| "unknown");
if let Err(coredump_err) = generate_coredump(&err, &source_name, coredump_path)
{
eprintln!("warning: coredump failed to generate: {}", coredump_err);
err
} else {
err.context(format!("core dumped at {}", coredump_path))
}
} else {
err
}
} else {
err
};
return Err(err);
}
if !results.is_empty() {
eprintln!(
"warning: using `--invoke` with a function that returns values \
is experimental and may break in the future"
);
}
for result in results {
match result {
Val::I32(i) => println!("{}", i),
Val::I64(i) => println!("{}", i),
Val::F32(f) => println!("{}", f32::from_bits(f)),
Val::F64(f) => println!("{}", f64::from_bits(f)),
Val::ExternRef(_) => println!("<externref>"),
Val::FuncRef(_) => println!("<funcref>"),
Val::V128(i) => println!("{}", i),
}
}
Ok(())
}
fn load_module(&self, engine: &Engine, path: &Path) -> Result<Module> {
if self.allow_precompiled {
unsafe { Module::from_trusted_file(engine, path) }
} else {
Module::from_file(engine, path)
.context("if you're trying to run a precompiled module, pass --allow-precompiled")
}
}
}
#[derive(Default, Clone)]
struct Host {
wasi: Option<wasmtime_wasi::WasiCtx>,
#[cfg(feature = "wasi-crypto")]
wasi_crypto: Option<Arc<WasiCryptoCtx>>,
#[cfg(feature = "wasi-nn")]
wasi_nn: Option<Arc<WasiNnCtx>>,
#[cfg(feature = "wasi-threads")]
wasi_threads: Option<Arc<WasiThreadsCtx<Host>>>,
#[cfg(feature = "wasi-http")]
wasi_http: Option<WasiHttp>,
limits: StoreLimits,
guest_profiler: Option<Arc<GuestProfiler>>,
}
fn populate_with_wasi(
linker: &mut Linker<Host>,
store: &mut Store<Host>,
module: Module,
preopen_dirs: Vec<(String, Dir)>,
argv: &[String],
vars: &[(String, String)],
wasi_modules: &WasiModules,
listenfd: bool,
mut tcplisten: Vec<TcpListener>,
) -> Result<()> {
if wasi_modules.wasi_common {
wasmtime_wasi::add_to_linker(linker, |host| host.wasi.as_mut().unwrap())?;
let mut builder = WasiCtxBuilder::new();
builder = builder.inherit_stdio().args(argv)?.envs(vars)?;
let mut num_fd: usize = 3;
if listenfd {
let (n, b) = ctx_set_listenfd(num_fd, builder)?;
num_fd = n;
builder = b;
}
for listener in tcplisten.drain(..) {
builder = builder.preopened_socket(num_fd as _, listener)?;
num_fd += 1;
}
for (name, dir) in preopen_dirs.into_iter() {
builder = builder.preopened_dir(dir, name)?;
}
store.data_mut().wasi = Some(builder.build());
}
if wasi_modules.wasi_crypto {
#[cfg(not(feature = "wasi-crypto"))]
{
bail!("Cannot enable wasi-crypto when the binary is not compiled with this feature.");
}
#[cfg(feature = "wasi-crypto")]
{
wasmtime_wasi_crypto::add_to_linker(linker, |host| {
Arc::get_mut(host.wasi_crypto.as_mut().unwrap())
.expect("wasi-crypto is not implemented with multi-threading support")
})?;
store.data_mut().wasi_crypto = Some(Arc::new(WasiCryptoCtx::new()));
}
}
if wasi_modules.wasi_nn {
#[cfg(not(feature = "wasi-nn"))]
{
bail!("Cannot enable wasi-nn when the binary is not compiled with this feature.");
}
#[cfg(feature = "wasi-nn")]
{
wasmtime_wasi_nn::add_to_linker(linker, |host| {
Arc::get_mut(host.wasi_nn.as_mut().unwrap())
.expect("wasi-nn is not implemented with multi-threading support")
})?;
store.data_mut().wasi_nn = Some(Arc::new(WasiNnCtx::new()?));
}
}
if wasi_modules.wasi_threads {
#[cfg(not(feature = "wasi-threads"))]
{
drop(&module);
bail!("Cannot enable wasi-threads when the binary is not compiled with this feature.");
}
#[cfg(feature = "wasi-threads")]
{
wasmtime_wasi_threads::add_to_linker(linker, store, &module, |host| {
host.wasi_threads.as_ref().unwrap()
})?;
store.data_mut().wasi_threads = Some(Arc::new(WasiThreadsCtx::new(
module,
Arc::new(linker.clone()),
)?));
}
}
if wasi_modules.wasi_http {
#[cfg(not(feature = "wasi-http"))]
{
bail!("Cannot enable wasi-http when the binary is not compiled with this feature.");
}
#[cfg(feature = "wasi-http")]
{
let w_http = WasiHttp::new();
wasmtime_wasi_http::add_to_linker(linker, |host: &mut Host| {
host.wasi_http.as_mut().unwrap()
})?;
store.data_mut().wasi_http = Some(w_http);
}
}
Ok(())
}
#[cfg(not(unix))]
fn ctx_set_listenfd(num_fd: usize, builder: WasiCtxBuilder) -> Result<(usize, WasiCtxBuilder)> {
Ok((num_fd, builder))
}
#[cfg(unix)]
fn ctx_set_listenfd(num_fd: usize, builder: WasiCtxBuilder) -> Result<(usize, WasiCtxBuilder)> {
use listenfd::ListenFd;
let mut builder = builder;
let mut num_fd = num_fd;
for env in ["LISTEN_FDS", "LISTEN_FDNAMES"] {
if let Ok(val) = std::env::var(env) {
builder = builder.env(env, &val)?;
}
}
let mut listenfd = ListenFd::from_env();
for i in 0..listenfd.len() {
if let Some(stdlistener) = listenfd.take_tcp_listener(i)? {
let _ = stdlistener.set_nonblocking(true)?;
let listener = TcpListener::from_std(stdlistener);
builder = builder.preopened_socket((3 + i) as _, listener)?;
num_fd = 3 + i;
}
}
Ok((num_fd, builder))
}
fn generate_coredump(err: &anyhow::Error, source_name: &str, coredump_path: &str) -> Result<()> {
let bt = err
.downcast_ref::<wasmtime::WasmBacktrace>()
.ok_or_else(|| anyhow!("no wasm backtrace found to generate coredump with"))?;
let mut coredump_builder =
wasm_coredump_builder::CoredumpBuilder::new().executable_name(source_name);
{
let mut thread_builder = wasm_coredump_builder::ThreadBuilder::new().thread_name("main");
for frame in bt.frames() {
let coredump_frame = wasm_coredump_builder::FrameBuilder::new()
.codeoffset(frame.func_offset().unwrap_or(0) as u32)
.funcidx(frame.func_index())
.build();
thread_builder.add_frame(coredump_frame);
}
coredump_builder.add_thread(thread_builder.build());
}
let coredump = coredump_builder
.serialize()
.map_err(|err| anyhow!("failed to serialize coredump: {}", err))?;
let mut f = File::create(coredump_path)
.context(format!("failed to create file at `{}`", coredump_path))?;
f.write_all(&coredump)
.with_context(|| format!("failed to write coredump file at `{}`", coredump_path))?;
Ok(())
}