Merge pull request #24 from peterhuene/use-different-store

Use a different store for the host.

.github/workflows/main.yml

@@ -46,6 +46,17 @@ jobs:
       run: dotnet build -c ${{ matrix.config }} --no-restore
     - name: Test
       run: dotnet test -c ${{ matrix.config }}
+    - name: Benchmark
+      if: matrix.config == 'release'
+      run: dotnet run -c ${{ matrix.config }} --project benchmarks/simple/simple.csproj
+    - name: Run examples
+      run: |
+        cd examples/hello
+        dotnet run
+        cd ../global
+        dotnet run
+        cd ../memory
+        dotnet run
     - name: Create package
       run: |
         cd src

.gitignore

@@ -7,3 +7,5 @@
 
 bin/
 obj/
+
+BenchmarkDotNet.Artifacts/

README.md

@@ -27,7 +27,7 @@
 You can add a package reference with the [.NET Core SDK](https://dotnet.microsoft.com/):
 
 ```text
-$ dotnet add package --version 0.15.0-preview1 wasmtime
+$ dotnet add package --version 0.18.1-preview1 wasmtime
 ```
 
 _Note that the `--version` option is required because the package is currently prerelease._
@@ -54,7 +54,7 @@ $ dotnet new console
 Next, add a reference to the [Wasmtime package](https://www.nuget.org/packages/Wasmtime):
 
 ```
-$ dotnet add package --version 0.15.0-preview1 wasmtime
+$ dotnet add package --version 0.18.1-preview1 wasmtime
 ```
 
 Replace the contents of `Program.cs` with the following code:
@@ -69,14 +69,15 @@ namespace Tutorial
     {
         static void Main(string[] args)
         {
-            using var store = new Store();
+            using var engine = new Engine();
+            using var store = new Store(engine);
 
             using var module = store.LoadModuleText(
               "hello",
               "(module (func $hello (import \"\" \"hello\")) (func (export \"run\") (call $hello)))"
             );
 
-            using var host = new Host(store);
+            using var host = new Host(engine);
 
             host.DefineFunction(
                 "",

benchmarks/simple/Program.cs

@@ -0,0 +1,79 @@
+using System;
+using System.Linq;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Jobs;
+using BenchmarkDotNet.Running;
+using BenchmarkDotNet.Toolchains.InProcess.Emit;
+using Wasmtime;
+
+namespace Simple
+{
+    [Config(typeof(Config))]
+    public class Benchmark
+    {
+        private class Config : ManualConfig
+        {
+            public Config()
+            {
+                AddJob(Job.MediumRun
+                    .WithLaunchCount(1)
+                    .WithToolchain(InProcessEmitToolchain.Instance)
+                    .WithId("InProcess"));
+            }
+        }
+
+        public Benchmark()
+        {
+            _engine = new Engine();
+            _store = new Store(_engine);
+            _module = _store.LoadModuleText("hello", @"
+(module
+  (type $t0 (func))
+  (import """" ""hello"" (func $.hello (type $t0)))
+  (func $run
+    call $.hello
+  )
+  (export ""run"" (func $run))
+)");
+        }
+
+        [Benchmark]
+        public void SayHello()
+        {
+            using var host = new Host(_engine);
+
+            host.DefineFunction("", "hello", () => { });
+
+            // Define a memory to add memory pressure if not disposed in the benchmark test
+            using var memory = host.DefineMemory("", "memory", 3);
+
+            using dynamic instance = host.Instantiate(_module);
+            instance.run();
+        }
+
+        private Engine _engine;
+        private Store _store;
+        private Module _module;
+    }
+
+    class Program
+    {
+        static void Main(string[] args)
+        {
+            var summary = BenchmarkRunner.Run<Benchmark>();
+
+            var report = summary[summary.BenchmarksCases.Where(c => c.Descriptor.Type == typeof(Benchmark)).Single()];
+            if (!(report is null))
+            {
+                if (report.ExecuteResults.All(r => r.ExitCode == 0))
+                {
+                    return;
+                }
+            }
+
+            Console.Error.WriteLine("Benchmark failed.");
+            Environment.Exit(1);
+        }
+    }
+}

benchmarks/simple/simple.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.12.1" />
+    <ProjectReference Include="..\..\src\Wasmtime.csproj" />
+  </ItemGroup>
+
+</Project>

docs/articles/intro.md

@@ -44,7 +44,7 @@ dotnet new console
 To use the .NET embedding of Wasmtime from the project, we need to add a reference to the [Wasmtime NuGet package](https://www.nuget.org/packages/Wasmtime):
 
 ```text
-dotnet add package --version 0.15.0-preview1 wasmtime
+dotnet add package --version 0.18.1-preview1 wasmtime
 ```
 
 _Note that the `--version` option is required because the package is currently prerelease._
@@ -65,9 +65,10 @@ namespace Tutorial
     {
         static void Main(string[] args)
         {
-            using var store = new Store();
+            using var engine = new Engine();
+            using var store = new Store(engine);
             using var module = store.LoadModuleText("hello", "(module (func $hello (import \"\" \"hello\")) (func (export \"run\") (call $hello)))");
-            using var host = new Host(store);
+            using var host = new Host(engine);
 
             host.DefineFunction(
                 "",

examples/global/Program.cs

@@ -7,9 +7,10 @@ class Program
     {
         static void Main(string[] args)
         {
-            using var store = new Store();
+            using var engine = new Engine();
+            using var store = new Store(engine);
             using var module = store.LoadModuleText("global.wat");
-            using var host = new Host(store);
+            using var host = new Host(engine);
 
             var global = host.DefineMutableGlobal("", "global", 1);
 

examples/hello/Program.cs

@@ -7,9 +7,10 @@ class Program
     {
         static void Main(string[] args)
         {
-            using var store = new Store();
+            using var engine = new Engine();
+            using var store = new Store(engine);
             using var module = store.LoadModuleText("hello.wat");
-            using var host = new Host(store);
+            using var host = new Host(engine);
 
             host.DefineFunction(
                 "",

examples/memory/Program.cs

@@ -7,9 +7,10 @@ class Program
     {
         static void Main(string[] args)
         {
-            using var store = new Store();
+            using var engine = new Engine();
+            using var store = new Store(engine);
             using var module = store.LoadModuleText("memory.wat");
-            using var host = new Host(store);
+            using var host = new Host(engine);
 
             host.DefineFunction(
                 "",

src/Engine.cs

@@ -0,0 +1,57 @@
+using System;
+using System.IO;
+using System.Text;
+using System.Collections.Generic;
+
+namespace Wasmtime
+{
+    /// <summary>
+    /// Represents a WebAssembly engine.
+    /// </summary>
+    public class Engine : IDisposable
+    {
+        /// <summary>
+        /// Constructs a new default engine.
+        /// </summary>
+        public Engine()
+        {
+            _handle = Interop.wasm_engine_new();
+        }
+
+        /// <inheritdoc/>
+        public void Dispose()
+        {
+            if (!_handle.IsInvalid)
+            {
+                _handle.Dispose();
+                _handle.SetHandleAsInvalid();
+            }
+        }
+
+        internal Engine(Interop.WasmConfigHandle config)
+        {
+            if (config.IsInvalid)
+            {
+                throw new WasmtimeException("Failed to create Wasmtime engine.");
+            }
+
+            _handle = Interop.wasm_engine_new_with_config(config);
+            config.SetHandleAsInvalid();
+        }
+
+        internal Interop.EngineHandle Handle
+        {
+            get
+            {
+                if (_handle.IsInvalid)
+                {
+                    throw new ObjectDisposedException(typeof(Engine).FullName);
+                }
+
+                return _handle;
+            }
+        }
+
+        private Interop.EngineHandle _handle;
+    }
+}

src/StoreBuilder.cs → src/EngineBuilder.cs

@@ -43,16 +43,16 @@ public enum OptimizationLevel
     }
 
     /// <summary>
-    /// Represents a builder of <see cref="Store"/> instances.
+    /// Represents a builder of <see cref="Engine"/> instances.
     /// </summary>
-    public class StoreBuilder
+    public class EngineBuilder
     {
         /// <summary>
         /// Sets whether or not to enable debug information.
         /// </summary>
         /// <param name="enable">True to enable debug information or false to disable.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithDebugInfo(bool enable)
+        public EngineBuilder WithDebugInfo(bool enable)
         {
             _enableDebugInfo = enable;
             return this;
@@ -63,7 +63,7 @@ public StoreBuilder WithDebugInfo(bool enable)
         /// </summary>
         /// <param name="enable">True to enable WebAssembly threads support or false to disable.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithWasmThreads(bool enable)
+        public EngineBuilder WithWasmThreads(bool enable)
         {
             _enableWasmThreads = enable;
             return this;
@@ -74,7 +74,7 @@ public StoreBuilder WithWasmThreads(bool enable)
         /// </summary>
         /// <param name="enable">True to enable WebAssembly reference types support or false to disable.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithReferenceTypes(bool enable)
+        public EngineBuilder WithReferenceTypes(bool enable)
         {
             _enableReferenceTypes = enable;
             return this;
@@ -85,7 +85,7 @@ public StoreBuilder WithReferenceTypes(bool enable)
         /// </summary>
         /// <param name="enable">True to enable WebAssembly SIMD support or false to disable.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithSIMD(bool enable)
+        public EngineBuilder WithSIMD(bool enable)
         {
             _enableSIMD = enable;
             return this;
@@ -96,7 +96,7 @@ public StoreBuilder WithSIMD(bool enable)
         /// </summary>
         /// <param name="enable">True to enable WebAssembly multi-value support or false to disable.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithMultiValue(bool enable)
+        public EngineBuilder WithMultiValue(bool enable)
         {
             _enableMultiValue = enable;
             return this;
@@ -107,7 +107,7 @@ public StoreBuilder WithMultiValue(bool enable)
         /// </summary>
         /// <param name="enable">True to enable WebAssembly bulk memory support or false to disable.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithBulkMemory(bool enable)
+        public EngineBuilder WithBulkMemory(bool enable)
         {
             _enableBulkMemory = enable;
             return this;
@@ -118,7 +118,7 @@ public StoreBuilder WithBulkMemory(bool enable)
         /// </summary>
         /// <param name="strategy">The compiler strategy to use.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithCompilerStrategy(CompilerStrategy strategy)
+        public EngineBuilder WithCompilerStrategy(CompilerStrategy strategy)
         {
             switch (strategy)
             {
@@ -145,7 +145,7 @@ public StoreBuilder WithCompilerStrategy(CompilerStrategy strategy)
         /// </summary>
         /// <param name="enable">True to enable the Cranelift debug verifier or false to disable.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithCraneliftDebugVerifier(bool enable)
+        public EngineBuilder WithCraneliftDebugVerifier(bool enable)
         {
             _enableCraneliftDebugVerifier = enable;
             return this;
@@ -156,7 +156,7 @@ public StoreBuilder WithCraneliftDebugVerifier(bool enable)
         /// </summary>
         /// <param name="level">The optimization level to use.</param>
         /// <returns>Returns the current builder.</returns>
-        public StoreBuilder WithOptimizationLevel(OptimizationLevel level)
+        public EngineBuilder WithOptimizationLevel(OptimizationLevel level)
         {
             switch (level)
             {
@@ -179,10 +179,10 @@ public StoreBuilder WithOptimizationLevel(OptimizationLevel level)
         }
 
         /// <summary>
-        /// Builds the <see cref="Store" /> instance.
+        /// Builds the <see cref="Engine" /> instance.
         /// </summary>
-        /// <returns>Returns the new <see cref="Store" /> instance.</returns>
-        public Store Build()
+        /// <returns>Returns the new <see cref="Engine" /> instance.</returns>
+        public Engine Build()
         {
             var config = Interop.wasm_config_new();
 
@@ -231,7 +231,7 @@ public Store Build()
                 Interop.wasmtime_config_cranelift_opt_level_set(config, _optLevel.Value);
             }
 
-            return new Store(config);
+            return new Engine(config);
         }
 
         private bool? _enableDebugInfo;