wasmtime/src/commands/run.rs

//! The module that implements the `wasmtime run` command.

use crate::{init_file_per_thread_logger, pick_compilation_strategy, CommonOptions};
use anyhow::{bail, Context as _, Result};
use std::{
    collections::HashMap,
    ffi::{OsStr, OsString},
    fmt::Write,
    fs::File,
    path::{Component, Path, PathBuf},
};
use structopt::{clap::AppSettings, StructOpt};
use wasi_common::preopen_dir;
use wasmtime::{Config, Engine, HostRef, Instance, Module, Store};
use wasmtime_environ::cache_init;
use wasmtime_interface_types::ModuleData;
use wasmtime_wasi::{
    create_wasi_instance, old::snapshot_0::create_wasi_instance as create_wasi_instance_snapshot_0,
};
#[cfg(feature = "wasi-c")]
use wasmtime_wasi_c::instantiate_wasi_c;
#[cfg(feature = "wasi-c")]
use wasmtime_wasi_c::instantiate_wasi_c;

fn parse_module(s: &OsStr) -> Result<PathBuf, OsString> {
    // Do not accept wasmtime subcommand names as the module name
    match s.to_str() {
        Some("help") | Some("config") | Some("run") | Some("wasm2obj") | Some("wast") => {
            Err("module name cannot be the same as a subcommand".into())
        }
        _ => 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()))
}

/// Runs a WebAssembly module
#[derive(StructOpt)]
#[structopt(name = "run", setting = AppSettings::TrailingVarArg)]
pub struct RunCommand {
    #[structopt(flatten)]
    common: CommonOptions,

    /// Grant access to the given host directory
    #[structopt(long = "dir", number_of_values = 1, value_name = "DIRECTORY")]
    dirs: Vec<String>,

    /// Pass an environment variable to the program
    #[structopt(long = "env", number_of_values = 1, value_name = "NAME=VAL", parse(try_from_str = parse_env_var))]
    vars: Vec<(String, String)>,

    /// The name of the function to run
    #[structopt(long, value_name = "FUNCTION")]
    invoke: Option<String>,

    /// Grant access to a guest directory mapped as a host directory
    #[structopt(long = "mapdir", number_of_values = 1, value_name = "GUEST_DIR::HOST_DIR", parse(try_from_str = parse_map_dirs))]
    map_dirs: Vec<(String, String)>,

    /// The path of the WebAssembly module to run
    #[structopt(
        index = 1,
        required = true,
        value_name = "WASM_MODULE",
        parse(try_from_os_str = parse_module),
    )]
    module: PathBuf,

    /// Load the given WebAssembly module before the main module
    #[structopt(
        long = "preload",
        number_of_values = 1,
        value_name = "MODULE_PATH",
        parse(from_os_str)
    )]
    preloads: Vec<PathBuf>,

    /// Enable the wasi-c implementation of `wasi_unstable`
    #[structopt(long = "wasi-c")]
    enable_wasi_c: bool,

    // NOTE: this must come last for trailing varargs
    /// The arguments to pass to the module
    #[structopt(value_name = "ARGS")]
    module_args: Vec<String>,
}

impl RunCommand {
    /// Executes the command.
    pub fn execute(&self) -> Result<()> {
        let log_config = if self.common.debug {
            pretty_env_logger::init();
            None
        } else {
            let prefix = "wasmtime.dbg.";
            init_file_per_thread_logger(prefix);
            Some(prefix)
        };

        let errors = cache_init(
            !self.common.disable_cache,
            self.common.config.as_ref(),
            log_config,
        );

        if !errors.is_empty() {
            let mut message = String::new();
            writeln!(message, "Cache initialization failed. Errors:")?;
            for e in errors {
                writeln!(message, "  -> {}", e)?;
            }
            bail!(message);
        }

        let mut config = Config::new();
        config
            .cranelift_debug_verifier(cfg!(debug_assertions))
            .debug_info(self.common.debug_info)
            .wasm_simd(self.common.enable_simd)
            .strategy(pick_compilation_strategy(
                self.common.cranelift,
                self.common.lightbeam,
            )?)?;

        if self.common.optimize {
            config.cranelift_opt_level(wasmtime::OptLevel::Speed);
        }

        let engine = Engine::new(&config);
        let store = Store::new(&engine);
        let mut module_registry = HashMap::new();

        // Make wasi available by default.
        let preopen_dirs = self.compute_preopen_dirs()?;
        let argv = self.compute_argv();

        let wasi_unstable = HostRef::new(if self.enable_wasi_c {
            #[cfg(feature = "wasi-c")]
            {
                let global_exports = store.global_exports().clone();
                let handle = instantiate_wasi_c(global_exports, &preopen_dirs, &argv, &self.vars)?;
                Instance::from_handle(&store, handle)
            }
            #[cfg(not(feature = "wasi-c"))]
            {
                bail!("wasi-c feature not enabled at build time")
            }
        } else {
            create_wasi_instance_snapshot_0(&store, &preopen_dirs, &argv, &self.vars)?
        });

        let wasi_snapshot_preview1 = HostRef::new(create_wasi_instance(
            &store,
            &preopen_dirs,
            &argv,
            &self.vars,
        )?);

        module_registry.insert("wasi_unstable".to_owned(), wasi_unstable);
        module_registry.insert("wasi_snapshot_preview1".to_owned(), wasi_snapshot_preview1);

        // Load the preload wasm modules.
        for preload in self.preloads.iter() {
            Self::instantiate_module(&store, &module_registry, preload)
                .with_context(|| format!("failed to process preload at `{}`", preload.display()))?;
        }

        // Load the main wasm module.
        self.handle_module(&store, &module_registry)
            .with_context(|| format!("failed to run main module `{}`", self.module.display()))?;

        Ok(())
    }

    fn compute_preopen_dirs(&self) -> Result<Vec<(String, File)>> {
        let mut preopen_dirs = Vec::new();

        for dir in self.dirs.iter() {
            preopen_dirs.push((
                dir.clone(),
                preopen_dir(dir).with_context(|| format!("failed to open directory '{}'", dir))?,
            ));
        }

        for (guest, host) in self.map_dirs.iter() {
            preopen_dirs.push((
                guest.clone(),
                preopen_dir(host)
                    .with_context(|| format!("failed to open directory '{}'", host))?,
            ));
        }

        Ok(preopen_dirs)
    }

    fn compute_argv(&self) -> Vec<String> {
        let mut result = Vec::new();

        // Add argv[0], which is the program name. Only include the base name of the
        // main wasm module, to avoid leaking path information.
        result.push(
            self.module
                .components()
                .next_back()
                .map(Component::as_os_str)
                .and_then(OsStr::to_str)
                .unwrap_or("")
                .to_owned(),
        );

        // Add the remaining arguments.
        for arg in self.module_args.iter() {
            result.push(arg.clone());
        }

        result
    }

    fn instantiate_module(
        store: &Store,
        module_registry: &HashMap<String, HostRef<Instance>>,
        path: &Path,
    ) -> Result<(HostRef<Instance>, Module, Vec<u8>)> {
        // Read the wasm module binary either as `*.wat` or a raw binary
        let data = wat::parse_file(path)?;

        let module = Module::new(store, &data)?;

        // Resolve import using module_registry.
        let imports = module
            .imports()
            .iter()
            .map(|i| {
                let module_name = i.module();
                if let Some(instance) = module_registry.get(module_name) {
                    let field_name = i.name();
                    if let Some(export) = instance.borrow().find_export_by_name(field_name) {
                        Ok(export.clone())
                    } else {
                        bail!(
                            "Import {} was not found in module {}",
                            field_name,
                            module_name
                        )
                    }
                } else {
                    bail!("Import module {} was not found", module_name)
                }
            })
            .collect::<Result<Vec<_>, _>>()?;

        let instance = HostRef::new(
            Instance::new(store, &module, &imports)
                .context(format!("failed to instantiate {:?}", path))?,
        );

        Ok((instance, module, data))
    }

    fn handle_module(
        &self,
        store: &Store,
        module_registry: &HashMap<String, HostRef<Instance>>,
    ) -> Result<()> {
        let (instance, module, data) =
            Self::instantiate_module(store, module_registry, &self.module)?;

        // If a function to invoke was given, invoke it.
        if let Some(name) = self.invoke.as_ref() {
            let data = ModuleData::new(&data)?;
            self.invoke_export(instance, &data, name)?;
        } else if module
            .exports()
            .iter()
            .any(|export| export.name().is_empty())
        {
            // Launch the default command export.
            let data = ModuleData::new(&data)?;
            self.invoke_export(instance, &data, "")?;
        } else {
            // If the module doesn't have a default command export, launch the
            // _start function if one is present, as a compatibility measure.
            let data = ModuleData::new(&data)?;
            self.invoke_export(instance, &data, "_start")?;
        }

        Ok(())
    }

    fn invoke_export(
        &self,
        instance: HostRef<Instance>,
        data: &ModuleData,
        name: &str,
    ) -> Result<()> {
        use wasm_webidl_bindings::ast;
        use wasmtime_interface_types::Value;

        let mut handle = instance.borrow().handle().clone();

        // Use the binding information in `ModuleData` to figure out what arguments
        // need to be passed to the function that we're invoking. Currently we take
        // the CLI parameters and attempt to parse them into function arguments for
        // the function we'll invoke.
        let binding = data.binding_for_export(&mut handle, name)?;
        if !binding.param_types()?.is_empty() {
            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 binding.param_types()? {
            let val = match args.next() {
                Some(s) => s,
                None => bail!("not enough arguments for `{}`", name),
            };
            values.push(match ty {
                // TODO: integer parsing here should handle hexadecimal notation
                // like `0x0...`, but the Rust standard library currently only
                // parses base-10 representations.
                ast::WebidlScalarType::Long => Value::I32(val.parse()?),
                ast::WebidlScalarType::LongLong => Value::I64(val.parse()?),
                ast::WebidlScalarType::UnsignedLong => Value::U32(val.parse()?),
                ast::WebidlScalarType::UnsignedLongLong => Value::U64(val.parse()?),

                ast::WebidlScalarType::Float | ast::WebidlScalarType::UnrestrictedFloat => {
                    Value::F32(val.parse()?)
                }
                ast::WebidlScalarType::Double | ast::WebidlScalarType::UnrestrictedDouble => {
                    Value::F64(val.parse()?)
                }
                ast::WebidlScalarType::DomString => Value::String(val.to_string()),
                t => bail!("unsupported argument type {:?}", t),
            });
        }

        // Invoke the function and then afterwards print all the results that came
        // out, if there are any.
        let results = data
            .invoke_export(&instance, name, &values)
            .with_context(|| format!("failed to invoke `{}`", name))?;
        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 {
            println!("{}", result);
        }

        Ok(())
    }
}