wasmtime 0.2.0 → 0.3.0

data/Cargo.toml

@@ -1,14 +1,2 @@
-[package]
-name = "wasmtime-ruby"
-version = "0.1.0"
-authors = ["David Cristofaro <david@dtcristo.com>"]
-edition = "2018"
-publish = false
-
-[lib]
-crate-type = ["cdylib"]
-
-[dependencies]
-lazy_static = "1.4.0"
-rutie = "0.7.0"
-wasmtime = "0.16.0"
+[workspace]
+members = ["ext"]

data/LICENSE

@@ -1,10 +1,11 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
-    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-    1. Definitions.
+   1. Definitions.
 
       "License" shall mean the terms and conditions for use, reproduction,
       and distribution as defined by Sections 1 through 9 of this document.
@@ -63,14 +64,14 @@
       on behalf of whom a Contribution has been received by Licensor and
       subsequently incorporated within the Work.
 
-    2. Grant of Copyright License. Subject to the terms and conditions of
+   2. Grant of Copyright License. Subject to the terms and conditions of
       this License, each Contributor hereby grants to You a perpetual,
       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
       copyright license to reproduce, prepare Derivative Works of,
       publicly display, publicly perform, sublicense, and distribute the
       Work and such Derivative Works in Source or Object form.
 
-    3. Grant of Patent License. Subject to the terms and conditions of
+   3. Grant of Patent License. Subject to the terms and conditions of
       this License, each Contributor hereby grants to You a perpetual,
       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
       (except as stated in this section) patent license to make, have made,
@@ -86,7 +87,7 @@
       granted to You under this License for that Work shall terminate
       as of the date such litigation is filed.
 
-    4. Redistribution. You may reproduce and distribute copies of the
+   4. Redistribution. You may reproduce and distribute copies of the
       Work or Derivative Works thereof in any medium, with or without
       modifications, and in Source or Object form, provided that You
       meet the following conditions:
@@ -127,7 +128,7 @@
       reproduction, and distribution of the Work otherwise complies with
       the conditions stated in this License.
 
-    5. Submission of Contributions. Unless You explicitly state otherwise,
+   5. Submission of Contributions. Unless You explicitly state otherwise,
       any Contribution intentionally submitted for inclusion in the Work
       by You to the Licensor shall be under the terms and conditions of
       this License, without any additional terms or conditions.
@@ -135,12 +136,12 @@
       the terms of any separate license agreement you may have executed
       with Licensor regarding such Contributions.
 
-    6. Trademarks. This License does not grant permission to use the trade
+   6. Trademarks. This License does not grant permission to use the trade
       names, trademarks, service marks, or product names of the Licensor,
       except as required for reasonable and customary use in describing the
       origin of the Work and reproducing the content of the NOTICE file.
 
-    7. Disclaimer of Warranty. Unless required by applicable law or
+   7. Disclaimer of Warranty. Unless required by applicable law or
       agreed to in writing, Licensor provides the Work (and each
       Contributor provides its Contributions) on an "AS IS" BASIS,
       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
@@ -150,7 +151,7 @@
       appropriateness of using or redistributing the Work and assume any
       risks associated with Your exercise of permissions under this License.
 
-    8. Limitation of Liability. In no event and under no legal theory,
+   8. Limitation of Liability. In no event and under no legal theory,
       whether in tort (including negligence), contract, or otherwise,
       unless required by applicable law (such as deliberate and grossly
       negligent acts) or agreed to in writing, shall any Contributor be
@@ -162,7 +163,7 @@
       other commercial damages or losses), even if such Contributor
       has been advised of the possibility of such damages.
 
-    9. Accepting Warranty or Additional Liability. While redistributing
+   9. Accepting Warranty or Additional Liability. While redistributing
       the Work or Derivative Works thereof, You may choose to offer,
       and charge a fee for, acceptance of support, warranty, indemnity,
       or other liability obligations and/or rights consistent with this
@@ -173,9 +174,9 @@
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
 
-    END OF TERMS AND CONDITIONS
+   END OF TERMS AND CONDITIONS
 
-    APPENDIX: How to apply the Apache License to your work.
+   APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
       boilerplate notice, with the fields enclosed by brackets "[]"
@@ -186,19 +187,19 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-    Copyright [yyyy] [name of copyright owner]
+   Copyright [yyyy] [name of copyright owner]
 
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
 
        http://www.apache.org/licenses/LICENSE-2.0
 
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
 
 
 --- LLVM Exceptions to the Apache 2.0 License ----
@@ -216,3 +217,4 @@ conflicts with the conditions of the GPLv2, you may retroactively and
 prospectively choose to deem waived or otherwise exclude such Section(s) of
 the License, but only in their entirety and only with respect to the Combined
 Software.
+

data/README.md

@@ -1,147 +1,76 @@
 <div align="center">
-  <h1>wasmtime-ruby</h1>
+  <h1><code>wasmtime-rb</code></h1>
+
   <p>
-    <strong>
-      Ruby bindings for <a href="https://github.com/bytecodealliance/wasmtime">Wasmtime</a>, a WebAssembly runtime
-    </strong>
+    <strong>Ruby embedding of
+    <a href="https://github.com/bytecodealliance/wasmtime">Wasmtime</a></strong>
   </p>
+
+  <strong>A <a href="https://bytecodealliance.org/">Bytecode Alliance</a> project</strong>
+
   <p>
-    <a href="https://rubygems.org/gems/wasmtime">
-      <img src="https://img.shields.io/gem/v/wasmtime" alt="RubyGems version badge" />
-    </a>
-    <a href="https://github.com/dtcristo/wasmtime-ruby/actions?query=workflow%3ACI">
-      <img src="https://img.shields.io/github/workflow/status/dtcristo/wasmtime-ruby/CI" alt="CI status badge" />
+    <a href="https://github.com/bytecodealliance/wasmtime-rb/actions?query=workflow%3ACI">
+      <img src="https://github.com/bytecodealliance/wasmtime-rb/workflows/CI/badge.svg" alt="CI status"/>
     </a>
   </p>
 </div>
 
-## Introduction
+## Status
 
-This project provides Ruby bindings for [Wasmtime](https://github.com/bytecodealliance/wasmtime),
-a [WebAssembly](https://webassembly.org/) runtime. This allows you to execute
-WASM modules from within Ruby executing at near-native speeds in a safe
-sandboxed environment.
+The Wasmtime Ruby bindings are still under development, [some features](https://github.com/bytecodealliance/wasmtime-rb/issues?q=is%3Aissue+is%3Aopen+label%3A%22missing+feature%22) are still missing.
 
-This is pretty experimental and not production ready right now. There are quite
-a few things that aren't built yet, see [TODO](#todo) section below.
+## Installation
 
-**Note:** [WebAssembly Interface Types](https://github.com/WebAssembly/interface-types/blob/master/proposals/interface-types/Explainer.md)
-support has been [temporarily removed](https://github.com/bytecodealliance/wasmtime/pull/1292)
-from Wasmtime. Only 32 and 64-bit integers and floats are currently supported.
+Install from RubyGems
 
-## Usage
-
-Install the `wasmtime` gem. Pre-compiled binaries are available for
-`x86_64-linux` and `x86_64-darwin-19`. Compiling the native extension requires
-[Rust with rustup](https://rustup.rs/).
-
-```sh
+```shell
 gem install wasmtime
 ```
 
-WASM has two formats `.wasm` (binary) and `.wat` (human-readable text). Both
-formats are supported. With the following `fibonacci.wat` file in your current
-directory.
-
-```wat
-;; fibonacci.wat
-(module
-  (export "fib" (func $fib))
-  (func $fib (param $n i32) (result i32)
-    (if (i32.lt_s (get_local $n) (i32.const 2))
-      (return (i32.const 1))
-    )
-    (return
-      (i32.add
-        (call $fib (i32.sub (get_local $n) (i32.const 2)))
-        (call $fib (i32.sub (get_local $n) (i32.const 1)))
-      )
-    )
-  )
-)
-```
+Or use in your Gemfile:
 
-In a ruby file, `require 'wasmtime/require'` to activate the Wasmtime require
-patch, allowing you to require any `.wasm` or `.wat` module as if it were a
-Ruby file. Doing so will internally create a `Wasmtime::Instance` and define a
-Ruby module with functions for each export.
-
-Finally, invoke the `fib` export like so.
-
-```rb
-require 'wasmtime/require'
-require_relative 'fibonacci'
-
-puts Fibonacci.fib(11) #=> 89
-```
-
-If you don't like all the magic in the example above, you can do the same
-without the require patch. If your project is going to be a dependency of others
-use this approach too.
-
-```rb
-require 'wasmtime'
-
-instance = Wasmtime::Instance.new('fibonacci.wat')
-puts instance.exports['fib'].call(11) #=> 89
+```ruby
+gem "wasmtime", "~> 0.3.0"
 ```
 
-## Benchmarks
-
-None yet. But they will be impressive.
-
-## Examples
-
-More usage examples are provided in `examples/`. To run some of these, you first
-need to compile the test WASM modules.
-
-Install some Rust tools.
-
-- [rustup](https://rustup.rs/) - Rust toolchain manager
-- [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) - WASM module bundler
-
-Install Ruby dependencies.
-
-```sh
-bundle install
-```
-
-Build the WASM modules.
-
-```sh
-bundle exec rake wasm
-```
+## Usage
 
-Run an example.
+Example usage:
 
-```sh
-ruby examples/fibonacci.rb
-```
+```ruby
+require "wasmtime"
 
-## Development
+# Create an engine. Generally, you only need a single engine and can
+# re-use it a throughout your program
+engine = Wasmtime::Engine.new
 
-Compile Rust native extension.
+# Compile a Wasm module from either Wasm or WAT.  The compiled module is
+# specific to the Engine's configuration.
+mod = Wasmtime::Module.new(engine, <<~WAT)
+  (module
+    (func $hello (import "" "hello"))
+    (func (export "run") (call $hello))
+  )
+WAT
 
-```sh
-bundle exec rake compile
-```
+# Create a store. Store can keep state to be re-used in Funcs.
+store = Wasmtime::Store.new(engine, {count: 0})
 
-Run test suite.
+# Define a Wasm function from Ruby code.
+func = Wasmtime::Func.new(store, Wasmtime::FuncType.new([], [])) do |caller|
+  puts "Hello from Func!"
+  puts "Ran #{caller[:count]} time(s)"
+end
 
-```sh
-bundle exec rake spec
-```
+# Build the Wasm instance by providing its imports
+instance = Wasmtime::Instance.new(store, mod, [func])
 
-Format source code.
+# Run the `run` export.
+instance.invoke("run")
 
-```sh
-bundle exec rake format
+# Or: get the `run` export and call it
+instance.export("run").call
 ```
 
-## TODO
-
-- Add support for raw memory access and other types of exports
-- Add support for imports
-- Implement more of the Wasmtime API
-- Add benchmarks for WASM program against ones in pure Ruby and true native
-- Add support for WASM Interface Types when they are supported in Wasmtime
+For more, see [examples](https://github.com/bytecodealliance/wasmtime-rb/tree/main/examples)
+or the [API documentation](https://bytecodealliance.github.io/wasmtime-rb/latest/).

data/ext/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "ext"
+version = "0.1.0"
+edition = "2018"
+authors = ["Ian Ker-Seymer <hello@ianks.com>"]
+license = "Apache-2.0"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+lazy_static = "1.4.0"
+magnus = { git = "https://github.com/matsadler/magnus", features = ["rb-sys-interop"] }
+rb-sys = "~0.9.44"
+wasmtime = "3.0.0"
+anyhow = "*" # Use whatever Wasmtime uses

data/ext/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("ext")

data/ext/src/helpers/mod.rs

@@ -0,0 +1,3 @@
+mod wrapped_struct;
+
+pub use wrapped_struct::WrappedStruct;

data/ext/src/helpers/wrapped_struct.rs

@@ -0,0 +1,84 @@
+use magnus::{error::Error, exception, gc, value::Value, RTypedData, TryConvert, TypedData};
+use std::{marker::PhantomData, ops::Deref};
+
+/// A small wrapper for `RTypedData` that keeps track of the concrete struct
+/// type, and the underlying [`Value`] for GC purposes.
+#[derive(Debug)]
+#[repr(transparent)]
+pub struct WrappedStruct<T: TypedData> {
+    inner: RTypedData,
+    phantom: PhantomData<T>,
+}
+
+impl<T: TypedData> Clone for WrappedStruct<T> {
+    fn clone(&self) -> Self {
+        Self {
+            inner: self.inner,
+            phantom: PhantomData,
+        }
+    }
+}
+impl<T: TypedData> Copy for WrappedStruct<T> {}
+
+impl<T: TypedData> WrappedStruct<T> {
+    /// Gets the underlying struct.
+    pub fn get(&self) -> Result<&T, Error> {
+        self.inner.try_convert()
+    }
+
+    /// Get the Ruby [`Value`] for this struct.
+    pub fn to_value(self) -> Value {
+        self.inner.into()
+    }
+
+    /// Marks the Ruby [`Value`] for GC.
+    pub fn mark(&self) {
+        gc::mark(&self.inner.into());
+    }
+}
+
+impl<T: TypedData> From<WrappedStruct<T>> for Value {
+    fn from(wrapped_struct: WrappedStruct<T>) -> Self {
+        wrapped_struct.to_value()
+    }
+}
+
+impl<T: TypedData> Deref for WrappedStruct<T> {
+    type Target = RTypedData;
+
+    fn deref(&self) -> &Self::Target {
+        &self.inner
+    }
+}
+
+impl<T: TypedData> From<T> for WrappedStruct<T> {
+    fn from(t: T) -> Self {
+        Self {
+            inner: RTypedData::wrap(t),
+            phantom: PhantomData,
+        }
+    }
+}
+
+impl<T> TryConvert for WrappedStruct<T>
+where
+    T: TypedData,
+{
+    fn try_convert(val: Value) -> Result<Self, Error> {
+        let inner = RTypedData::from_value(val).ok_or_else(|| {
+            Error::new(
+                exception::type_error(),
+                format!(
+                    "no implicit conversion of {} into {}",
+                    unsafe { val.classname() },
+                    T::class()
+                ),
+            )
+        })?;
+
+        Ok(Self {
+            inner,
+            phantom: PhantomData,
+        })
+    }
+}

data/ext/src/lib.rs

@@ -0,0 +1,9 @@
+use magnus::Error;
+
+mod helpers;
+mod ruby_api;
+
+#[magnus::init]
+fn init() -> Result<(), Error> {
+    ruby_api::init()
+}

data/ext/src/ruby_api/config.rs

@@ -0,0 +1,68 @@
+use super::root;
+use magnus::{function, method, Error, Module, Object};
+use std::cell::RefCell;
+use wasmtime::Config as ConfigImpl;
+
+/// @yard
+/// Wasmtime {Engine} configuration.
+/// @see https://docs.rs/wasmtime/latest/wasmtime/struct.Config.html Wasmtime's Rust doc
+#[derive(Clone, Debug)]
+#[magnus::wrap(class = "Wasmtime::Config")]
+pub struct Config {
+    inner: RefCell<ConfigImpl>,
+}
+
+impl Config {
+    /// @yard
+    /// @return [Config]
+    pub fn new() -> Self {
+        Self {
+            inner: RefCell::new(ConfigImpl::new()),
+        }
+    }
+
+    pub fn get(&self) -> ConfigImpl {
+        self.inner.borrow().clone()
+    }
+
+    /// @yard
+    /// @def epoch_interruption=(enabled)
+    /// @param enabled [Boolean]
+    pub fn set_epoch_interruption(&self, enabled: bool) {
+        self.inner.borrow_mut().epoch_interruption(enabled);
+    }
+
+    /// @yard
+    /// @def max_wasm_stack=(size)
+    /// @param size [Integer]
+    pub fn set_max_wasm_stack(&self, size: usize) {
+        self.inner.borrow_mut().max_wasm_stack(size);
+    }
+
+    /// @yard
+    /// @def wasm_multi_memory=(enabled)
+    /// @param enabled [Boolean]
+    pub fn set_wasm_multi_memory(&self, enabled: bool) {
+        self.inner.borrow_mut().wasm_multi_memory(enabled);
+    }
+}
+
+pub fn init() -> Result<(), Error> {
+    let class = root().define_class("Config", Default::default())?;
+
+    class.define_singleton_method("new", function!(Config::new, 0))?;
+
+    class.define_method(
+        "epoch_interruption=",
+        method!(Config::set_epoch_interruption, 1),
+    )?;
+
+    class.define_method("max_wasm_stack=", method!(Config::set_max_wasm_stack, 1))?;
+
+    class.define_method(
+        "wasm_multi_memory=",
+        method!(Config::set_wasm_multi_memory, 1),
+    )?;
+
+    Ok(())
+}

data/ext/src/ruby_api/convert.rs

@@ -0,0 +1,92 @@
+use crate::{err, error};
+use magnus::{Error, TypedData, Value};
+use wasmtime::{ExternRef, Val, ValType};
+
+use super::{func::Func, memory::Memory, store::StoreContextValue};
+
+pub trait ToRubyValue {
+    fn to_ruby_value(&self, store: &StoreContextValue) -> Result<Value, Error>;
+}
+
+impl ToRubyValue for Val {
+    fn to_ruby_value(&self, store: &StoreContextValue) -> Result<Value, Error> {
+        match self {
+            Val::I32(i) => Ok(Value::from(*i)),
+            Val::I64(i) => Ok(Value::from(*i)),
+            Val::F32(f) => Ok(Value::from(f32::from_bits(*f))),
+            Val::F64(f) => Ok(Value::from(f64::from_bits(*f))),
+            Val::ExternRef(eref) => match eref {
+                None => Ok(magnus::QNIL.into()),
+                Some(eref) => eref
+                    .data()
+                    .downcast_ref::<OnStackValue>()
+                    .map(|v| v.0)
+                    .ok_or_else(|| error!("failed to extract externref")),
+            },
+            Val::FuncRef(funcref) => match funcref {
+                None => Ok(magnus::QNIL.into()),
+                Some(funcref) => Ok(Func::from_inner(*store, *funcref).into()),
+            },
+            Val::V128(_) => err!("converting from v128 to Ruby unsupported"),
+        }
+    }
+}
+pub trait ToWasmVal {
+    fn to_wasm_val(&self, ty: &ValType) -> Result<Val, Error>;
+}
+
+impl ToWasmVal for Value {
+    fn to_wasm_val(&self, ty: &ValType) -> Result<Val, Error> {
+        match ty {
+            ValType::I32 => Ok(self.try_convert::<i32>()?.into()),
+            ValType::I64 => Ok(self.try_convert::<i64>()?.into()),
+            ValType::F32 => Ok(self.try_convert::<f32>()?.into()),
+            ValType::F64 => Ok(self.try_convert::<f64>()?.into()),
+            ValType::ExternRef => {
+                let extern_ref_value = match self.is_nil() {
+                    true => None,
+                    false => Some(ExternRef::new(OnStackValue::from(*self))),
+                };
+
+                Ok(Val::ExternRef(extern_ref_value))
+            }
+            ValType::FuncRef => Ok(Val::FuncRef(Some(*self.try_convert::<&Func>()?.inner()))),
+            ValType::V128 => err!("converting from Ruby to v128 not supported"),
+        }
+    }
+}
+
+struct OnStackValue(Value);
+impl From<Value> for OnStackValue {
+    fn from(v: Value) -> Self {
+        Self(v)
+    }
+}
+unsafe impl Send for OnStackValue {}
+unsafe impl Sync for OnStackValue {}
+
+pub trait ToExtern {
+    fn to_extern(&self) -> Result<wasmtime::Extern, Error>;
+}
+
+impl ToExtern for Value {
+    fn to_extern(&self) -> Result<wasmtime::Extern, Error> {
+        if self.is_kind_of(Func::class()) {
+            Ok(self.try_convert::<&Func>()?.into())
+        } else if self.is_kind_of(Memory::class()) {
+            Ok(self.try_convert::<&Memory>()?.into())
+        } else {
+            Err(Error::new(
+                magnus::exception::type_error(),
+                format!("unexpected extern: {}", self.inspect()),
+            ))
+        }
+    }
+}
+
+pub trait WrapWasmtimeType<'a, T>
+where
+    T: TypedData,
+{
+    fn wrap_wasmtime_type(&self, store: StoreContextValue<'a>) -> Result<T, Error>;
+}