Remove need for HostRef<Engine> (#762)

This commit removes the need to use `HostRef<Engine>` in the Rust API.
Usage is retained in the C API in one location, but otherwise `Engine`
can always be used directly.

This is the first step of progress on #708 for the `Engine` type.
Changes here include:

* `Engine` is now `Clone`, and is documented as being cheap. It's not
  intended that cloning an engine creates a deep copy.
* `Engine` is now both `Send` and `Sync`, and asserted to be so.
* Usage of `Engine` in APIs no longer requires or uses `HostRef`.
This commit is contained in:
Alex Crichton
2020-01-06 15:17:03 -06:00
committed by GitHub
parent ad7d48479e
commit b9dc38f4e1
18 changed files with 56 additions and 28 deletions

View File

@@ -1,8 +1,8 @@
use crate::context::Context;
use crate::r#ref::HostRef;
use std::cell::RefCell;
use std::collections::HashMap;
use std::rc::Rc;
use std::sync::Arc;
use wasmtime_environ::{ir, settings};
use wasmtime_jit::{CompilationStrategy, Features};
@@ -92,15 +92,38 @@ impl Default for Config {
// Engine
#[derive(Default)]
/// An `Engine` which is a global context for compilation and management of wasm
/// modules.
///
/// An engine can be safely shared across threads and is a cheap cloneable
/// handle to the actual engine. The engine itself will be deallocate once all
/// references to it have gone away.
///
/// Engines store global configuration preferences such as compilation settings,
/// enabled features, etc. You'll likely only need at most one of these for a
/// program.
///
/// ## Engines and `Clone`
///
/// Using `clone` on an `Engine` is a cheap operation. It will not create an
/// entirely new engine, but rather just a new reference to the existing engine.
///
/// ## Engines and `Default`
///
/// You can create an engine with default settings using `Engine::default()`.
/// This engine will not have any unstable wasm features enabled and will use
/// the default compilation backend configured at this crate's compile time.
#[derive(Default, Clone)]
pub struct Engine {
pub(crate) config: Config,
pub(crate) config: Arc<Config>,
}
impl Engine {
/// Creates a new [`Engine`] with the specified compilation and
/// configuration settings.
pub fn new(config: &Config) -> Engine {
Engine {
config: config.clone(),
config: Arc::new(config.clone()),
}
}
}
@@ -108,23 +131,23 @@ impl Engine {
// Store
pub struct Store {
engine: HostRef<Engine>,
engine: Engine,
context: Context,
global_exports: Rc<RefCell<HashMap<String, Option<wasmtime_runtime::Export>>>>,
signature_cache: HashMap<wasmtime_runtime::VMSharedSignatureIndex, ir::Signature>,
}
impl Store {
pub fn new(engine: &HostRef<Engine>) -> Store {
pub fn new(engine: &Engine) -> Store {
Store {
engine: engine.clone(),
context: Context::new(&engine.borrow().config),
context: Context::new(&engine.config),
global_exports: Rc::new(RefCell::new(HashMap::new())),
signature_cache: HashMap::new(),
}
}
pub fn engine(&self) -> &HostRef<Engine> {
pub fn engine(&self) -> &Engine {
&self.engine
}
@@ -161,3 +184,8 @@ impl Store {
self.signature_cache.get(&type_index)
}
}
fn _assert_send_sync() {
fn _assert<T: Send + Sync>() {}
_assert::<Engine>();
}