Create a Context class to group together various state objects.

This commit is contained in:
Dan Gohman
2019-01-31 14:43:32 -08:00
parent 4675948c2a
commit 8b140cc748
8 changed files with 235 additions and 127 deletions

182
lib/jit/src/context.rs Normal file
View File

@@ -0,0 +1,182 @@
use crate::{
instantiate, ActionError, ActionOutcome, Compiler, Instance, InstanceIndex, Namespace,
RuntimeValue, SetupError,
};
use cranelift_codegen::isa::TargetIsa;
use std::borrow::ToOwned;
use std::boxed::Box;
use std::cell::RefCell;
use std::collections::HashMap;
use std::rc::Rc;
use std::string::{String, ToString};
use std::{fmt, str};
use wasmparser::{validate, OperatorValidatorConfig, ValidatingParserConfig};
/// Indicates an unknown instance was specified.
#[derive(Fail, Debug)]
pub struct UnknownInstance {
instance_name: String,
}
impl fmt::Display for UnknownInstance {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "no instance {} present", self.instance_name)
}
}
/// Error message used by `WastContext`.
#[derive(Fail, Debug)]
pub enum ContextError {
/// An unknown instance name was used.
Instance(UnknownInstance),
/// An error occured while performing an action.
Action(ActionError),
}
impl fmt::Display for ContextError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
ContextError::Instance(ref error) => error.fmt(f),
ContextError::Action(ref error) => error.fmt(f),
}
}
}
/// A convenient context for compiling and executing WebAssembly instances.
pub struct Context {
namespace: Namespace,
compiler: Box<Compiler>,
global_exports: Rc<RefCell<HashMap<String, Option<wasmtime_runtime::Export>>>>,
}
impl Context {
/// Construct a new instance of `Context`.
pub fn new(compiler: Box<Compiler>) -> Self {
Self {
namespace: Namespace::new(),
compiler,
global_exports: Rc::new(RefCell::new(HashMap::new())),
}
}
/// Construct a new instance of `Context` with the given target.
pub fn with_isa(isa: Box<TargetIsa>) -> Self {
Self::new(Box::new(Compiler::new(isa)))
}
fn validate(&mut self, data: &[u8]) -> Result<(), String> {
let config = ValidatingParserConfig {
operator_config: OperatorValidatorConfig {
enable_threads: false,
enable_reference_types: false,
},
mutable_global_imports: true,
};
// TODO: Fix Cranelift to be able to perform validation itself, rather
// than calling into wasmparser ourselves here.
if validate(data, Some(config)) {
Ok(())
} else {
// TODO: Work with wasmparser to get better error messages.
Err("module did not validate".to_owned())
}
}
fn instantiate(&mut self, data: &[u8]) -> Result<Instance, SetupError> {
self.validate(&data).map_err(SetupError::Validate)?;
instantiate(
&mut *self.compiler,
&data,
&mut self.namespace,
Rc::clone(&mut self.global_exports),
)
}
/// Return the instance index for the instance with the given name.
pub fn get_instance_index(
&mut self,
instance_name: &str,
) -> Result<InstanceIndex, UnknownInstance> {
self.namespace
.get_instance_index(instance_name)
.ok_or_else(|| UnknownInstance {
instance_name: instance_name.to_string(),
})
}
/// Instantiate a module instance and register the instance.
pub fn instantiate_module(
&mut self,
instance_name: Option<String>,
data: &[u8],
) -> Result<InstanceIndex, ActionError> {
let instance = self.instantiate(data).map_err(ActionError::Setup)?;
Ok(self.instance(instance_name, instance))
}
/// Install a new `Instance` in this `Namespace`, optionally with the
/// given name, and return its index.
pub fn instance(&mut self, instance_name: Option<String>, instance: Instance) -> InstanceIndex {
self.namespace.instance(instance_name, instance)
}
/// Register an additional name for an existing registered instance.
pub fn alias(&mut self, name: &str, as_name: String) -> Result<(), UnknownInstance> {
let index = self.get_instance_index(&name)?;
self.alias_for_indexed(index, as_name);
Ok(())
}
/// Register an additional name for an existing registered instance.
pub fn alias_for_indexed(&mut self, index: InstanceIndex, as_name: String) {
self.namespace.alias_for_indexed(index, as_name)
}
/// Invoke an exported function from an instance.
pub fn invoke(
&mut self,
instance_name: &str,
field: &str,
args: &[RuntimeValue],
) -> Result<ActionOutcome, ContextError> {
let index = self
.get_instance_index(&instance_name)
.map_err(ContextError::Instance)?;
self.invoke_indexed(index, field, args)
.map_err(ContextError::Action)
}
/// Invoke an exported function from an instance.
pub fn invoke_indexed(
&mut self,
index: InstanceIndex,
field: &str,
args: &[RuntimeValue],
) -> Result<ActionOutcome, ActionError> {
self.namespace
.invoke(&mut *self.compiler, index, field, &args)
}
/// Get the value of an exported global variable from an instance.
pub fn get(&mut self, instance_name: &str, field: &str) -> Result<ActionOutcome, ContextError> {
let index = self
.get_instance_index(&instance_name)
.map_err(ContextError::Instance)?;
self.get_indexed(index, field).map_err(ContextError::Action)
}
/// Get the value of an exported global variable from an instance.
pub fn get_indexed(
&mut self,
index: InstanceIndex,
field: &str,
) -> Result<ActionOutcome, ActionError> {
self.namespace
.get(index, field)
.map(|value| ActionOutcome::Returned {
values: vec![value],
})
}
}

View File

@@ -44,6 +44,7 @@ extern crate failure_derive;
mod action;
mod code_memory;
mod compiler;
mod context;
mod instantiate;
mod link;
mod namespace;
@@ -52,6 +53,7 @@ mod target_tunables;
pub use crate::action::{ActionError, ActionOutcome, RuntimeValue};
pub use crate::compiler::Compiler;
pub use crate::context::{Context, ContextError, UnknownInstance};
pub use crate::instantiate::{instantiate, CompiledModule, SetupError};
pub use crate::link::link_module;
pub use crate::namespace::{InstanceIndex, Namespace};

View File

@@ -39,22 +39,22 @@ impl Namespace {
/// Install a new `Instance` in this `Namespace`, optionally with the
/// given name, and return its index.
pub fn instance(&mut self, instance_name: Option<&str>, instance: Instance) -> InstanceIndex {
pub fn instance(&mut self, instance_name: Option<String>, instance: Instance) -> InstanceIndex {
let index = self.instances.push(instance);
if let Some(instance_name) = instance_name {
self.names.insert(instance_name.into(), index);
self.names.insert(instance_name, index);
}
index
}
/// Get the instance index registered with the given `instance_name`.
pub fn get_instance_index(&mut self, instance_name: &str) -> Option<&mut InstanceIndex> {
self.names.get_mut(instance_name)
pub fn get_instance_index(&mut self, instance_name: &str) -> Option<InstanceIndex> {
self.names.get_mut(instance_name).cloned()
}
/// Register an instance with a given name.
pub fn register(&mut self, name: String, index: InstanceIndex) {
self.names.insert(name, index);
/// Register an additional name for an existing registered instance.
pub fn alias_for_indexed(&mut self, existing_index: InstanceIndex, new_name: String) {
self.names.insert(new_name, existing_index);
}
/// Invoke an exported function from an instance.