Update to take advantage of wasm-zig pkg and gyro

There's a lot of rough edges to work out such as how to alter/augment
structs defined in wasm-zig with runtime specific functionality.
For now, wrap the wasm.* structs in their own containers in
wasmtime-zig.

Author: kubkon

.github/workflows/ci.yml

@@ -24,50 +24,13 @@ jobs:
         git config --global core.autocrlf false
     - name: Checkout
       uses: actions/checkout@v1
-    - name: Install zig (ubuntu)
+    - name: Test linux
       if: matrix.os == 'ubuntu'
-      run: |
-        sudo snap install zig --classic --beta
-    - name: Install zig (macOS)
-      if: matrix.os == 'macos'
-      run: |
-        brew install zig
-    - name: Install zig (windows)
-      if: matrix.os == 'windows'
-      run: |
-        choco install zig
-    - name: Install libwasmtime (ubuntu)
-      if: matrix.os == 'ubuntu'
-      run: |
-        curl -L https://github.com/bytecodealliance/wasmtime/releases/download/v0.24.0/wasmtime-v0.24.0-x86_64-linux-c-api.tar.xz -o wasmtime.tar.xz
-        tar -C . --strip-components 2 --wildcards -xvf wasmtime.tar.xz */lib/libwasmtime.a
-    - name: Install libwasmtime (macOS)
+      run: ./ci/linux_ci
+    - name: Test macos
       if: matrix.os == 'macos'
-      run: |
-        curl -L https://github.com/bytecodealliance/wasmtime/releases/download/v0.24.0/wasmtime-v0.24.0-x86_64-macos-c-api.tar.xz -o wasmtime.tar.xz
-        tar -C . --strip-components 2 -xvf wasmtime.tar.xz */lib/libwasmtime.a
-    - name: Install libwasmtime (windows)
+      run: ./ci/macos_ci
+    - name: Test windows
+      shell: bash
       if: matrix.os == 'windows'
-      run: |
-        curl -L https://github.com/bytecodealliance/wasmtime/releases/download/v0.24.0/wasmtime-v0.24.0-x86_64-windows-c-api.zip -o wasmtime.zip
-        7z e -i!"*/lib/wasmtime.dll.lib" wasmtime.zip
-        7z e -i!"*/lib/wasmtime.dll" wasmtime.zip
-    - name: zig build
-      run: |
-        zig build
-    - name: zig build test
-      run: |
-        zig build test -Dlibrary-search-path="."
-    - name: zig build run -Dexample=simple
-      run: |
-        zig build run -Dexample=simple -Dlibrary-search-path="."
-    - name: zig build run -Dexample=gcd
-      run: |
-        zig build run -Dexample=gcd -Dlibrary-search-path="."
-    - name: zig build run -Dexample=linking
-      run: |
-        zig build run -Dexample=linking -Dlibrary-search-path="."
-    - name: zig build run -Dexample=memory
-      run: |
-        zig build run -Dexample=memory -Dlibrary-search-path="."
-
+      run: ./ci/win_ci

.gitignore

@@ -1,3 +1,5 @@
 zig-cache
 .DS_Store
 *.swp
+.gyro
+gyro.lock

README.md

@@ -13,6 +13,10 @@ but expected, and things might just not work as expected yet.
 
 ## Building
 
+To build this library, you will need Zig nightly 0.8.0, as well as [`gyro`] package manager.
+
+[`gyro`]: https://github.com/mattnite/gyro
+
 This library consumes the C API of the Wasmtime project which you can download with every release of
 Wasmtime. It relies on version `v0.24.0` of Wasmtime and you need it to build tests and examples.
 You can download the library from [here].
@@ -21,7 +25,7 @@ After you unpack it, if you installed the lib in path that is not your system se
 you can add the installed path to the build command using the following flag
 
 ```
-zig build -Dlibrary-search-path=<path-to-libwasmtime>
+gyro build --search-prefix=<path-to-libwasmtime>
 ```
 
 [here]: https://github.com/bytecodealliance/wasmtime/releases/tag/v0.24.0
@@ -33,18 +37,15 @@ zig build -Dlibrary-search-path=<path-to-libwasmtime>
 The `simple.zig` example is equivalent to [`hello.c`] example in Wasmtime. You can run it with
 
 ```
-zig build example-simple
+gyro build run -Dexample=simple
 ```
 
 Optionally, if you installed `libwasmtime` into some custom path, you can tell zig where to find it
 with
 
 ```
-zig build example-simple -Dlibrary-search-path=<path-to-libwasmtime>
+gyro build run -Dexample=simple --search-prefix=<path-to-libwasmtime>
 ```
 
 [`hello.c`]: https://github.com/bytecodealliance/wasmtime/blob/master/examples/hello.c
 
-**NOTE:** while on Linux and macOS, it is fine to link with `libwasmtime` statically, I've found that
-on Windows it is generally safer to use a dynamic library. Therefore, when installing `libwasmtime` make
-sure you point to the path where `wasmtime.dll.lib` is located.

build.zig

@@ -1,51 +1,44 @@
-const builtin = @import("builtin");
 const std = @import("std");
-const Builder = std.build.Builder;
-const LibExeObjStep = std.build.LibExeObjStep;
-
-fn linkWasmtime(step: *LibExeObjStep, search_path: ?[]const u8) void {
-    if (builtin.os.tag == .windows) {
-        // On Windows, link dynamic library as otherwise lld will have a
-        // hard time satisfying `libwasmtime` deps
-        step.linkSystemLibrary("wasmtime.dll");
-    } else {
-        step.linkSystemLibrary("wasmtime");
-    }
-    if (search_path) |path| {
-        step.addLibPath(path);
-    }
-}
+const builtin = @import("builtin");
+const pkgs = @import("deps.zig").pkgs;
 
-pub fn build(b: *Builder) !void {
+pub fn build(b: *std.build.Builder) !void {
     const mode = b.standardReleaseOptions();
 
-    const lib_path = b.option([]const u8, "library-search-path", "Add additional system library search path.");
-
     const lib = b.addStaticLibrary("wasmtime-zig", "src/main.zig");
     lib.setBuildMode(mode);
+    lib.addPackage(pkgs.wasm);
     lib.install();
 
     var main_tests = b.addTest("src/main.zig");
     main_tests.setBuildMode(mode);
-    linkWasmtime(main_tests, lib_path);
+    main_tests.addPackage(pkgs.wasm);
     main_tests.step.dependOn(b.getInstallStep());
 
     const test_step = b.step("test", "Run library tests");
     test_step.dependOn(&main_tests.step);
 
-    const example = b.option([]const u8, "example", "The example to run from the /example folder");
-    const example_path = blk: {
-        const ex = example orelse "simple";
-
-        const path = try std.fs.path.join(b.allocator, &[_][]const u8{ "example", ex });
-        break :blk try std.mem.concat(b.allocator, u8, &[_][]const u8{ path, ".zig" });
+    const example = b.option([]const u8, "example", "The example to run from the examples/ folder");
+    const example_path = example_path: {
+        const basename = example orelse "simple";
+        const with_ext = try std.fmt.allocPrint(b.allocator, "{s}.zig", .{basename});
+        const full_path = try std.fs.path.join(b.allocator, &[_][]const u8{ "examples", with_ext });
+        break :example_path full_path;
     };
 
     const simple_exe = b.addExecutable(example orelse "simple", example_path);
     simple_exe.setBuildMode(mode);
-    simple_exe.addPackagePath("wasmtime", "src/main.zig");
+    simple_exe.addPackage(.{
+        .name = "wasmtime",
+        .path = "src/main.zig",
+        .dependencies = &.{pkgs.wasm},
+    });
+    if (builtin.os.tag == .windows) {
+        simple_exe.linkSystemLibrary("wasmtime.dll");
+    } else {
+        simple_exe.linkSystemLibrary("wasmtime");
+    }
     simple_exe.linkLibC();
-    linkWasmtime(simple_exe, lib_path);
     simple_exe.step.dependOn(b.getInstallStep());
 
     const run_simple_cmd = simple_exe.run();

ci/linux_ci

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+set -x
+set -e
+
+ZIG="zig-linux-x86_64-0.8.0-dev.2667+44de88498"
+WASMTIME_VERSION="v0.24.0"
+WASMTIME="wasmtime-$WASMTIME_VERSION-x86_64-linux-c-api"
+GYRO_VERSION="0.2.3"
+GYRO="gyro-$GYRO_VERSION-linux-x86_64"
+
+wget -nv "https://ziglang.org/builds/$ZIG.tar.xz"
+tar xf "$ZIG.tar.xz"
+export PATH="$(pwd)/$ZIG:$PATH"
+
+wget -nv "https://github.com/bytecodealliance/wasmtime/releases/download/$WASMTIME_VERSION/$WASMTIME.tar.xz"
+tar xf "$WASMTIME.tar.xz"
+
+wget -nv "https://github.com/mattnite/gyro/releases/download/$GYRO_VERSION/$GYRO.tar.gz"
+tar xf "$GYRO.tar.gz"
+export PATH="$(pwd)/$GYRO/bin:$PATH"
+
+gyro build
+gyro build test
+gyro build run -Dexample=simple --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=gcd --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=linking --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=memory --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=interrupt --search-prefix "$(pwd)/$WASMTIME"
+

ci/macos_ci

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+set -x
+set -e
+
+ZIG="zig-macos-x86_64-0.8.0-dev.2667+44de88498"
+WASMTIME_VERSION="v0.24.0"
+WASMTIME="wasmtime-$WASMTIME_VERSION-x86_64-macos-c-api"
+GYRO_VERSION="0.2.3"
+GYRO="gyro-$GYRO_VERSION-macos-x86_64"
+
+curl -L "https://ziglang.org/builds/$ZIG.tar.xz" -o "$ZIG.tar.xz"
+tar xf "$ZIG.tar.xz"
+export PATH="$(pwd)/$ZIG:$PATH"
+
+curl -L "https://github.com/bytecodealliance/wasmtime/releases/download/$WASMTIME_VERSION/$WASMTIME.tar.xz" -o "$WASMTIME.tar.xz"
+tar xf "$WASMTIME.tar.xz"
+
+curl -L "https://github.com/mattnite/gyro/releases/download/$GYRO_VERSION/$GYRO.tar.gz" -o "$GYRO.tar.gz"
+tar xf "$GYRO.tar.gz"
+export PATH="$(pwd)/$GYRO/bin:$PATH"
+
+gyro build
+gyro build test
+gyro build run -Dexample=simple --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=gcd --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=linking --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=memory --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=interrupt --search-prefix "$(pwd)/$WASMTIME"
+

ci/win_ci

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+set -x
+set -e
+
+ZIG="zig-windows-x86_64-0.8.0-dev.2667+44de88498"
+WASMTIME_VERSION="v0.24.0"
+WASMTIME="wasmtime-$WASMTIME_VERSION-x86_64-windows-c-api"
+GYRO_VERSION="0.2.3"
+GYRO="gyro-$GYRO_VERSION-windows-x86_64"
+
+curl -L "https://ziglang.org/builds/$ZIG.zip" -o "$ZIG.zip"
+7z x "$ZIG.zip"
+export PATH="$(pwd)/$ZIG:$PATH"
+
+curl -L "https://github.com/bytecodealliance/wasmtime/releases/download/$WASMTIME_VERSION/$WASMTIME.zip" -o "$WASMTIME.zip"
+7z x "$WASMTIME.zip"
+
+curl -L "https://github.com/mattnite/gyro/releases/download/$GYRO_VERSION/$GYRO.zip" -o "$GYRO.zip"
+7z x "$GYRO.zip"
+export PATH="$(pwd)/$GYRO/bin:$PATH"
+
+gyro build
+gyro build test
+gyro build run -Dexample=simple --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=gcd --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=linking --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=memory --search-prefix "$(pwd)/$WASMTIME"
+gyro build run -Dexample=interrupt --search-prefix "$(pwd)/$WASMTIME"
+

deps.zig

@@ -0,0 +1,20 @@
+const std = @import("std");
+pub const pkgs = struct {
+    pub const wasm = std.build.Pkg{
+        .name = "wasm",
+        .path = ".gyro/wasm-zig-kubkon-a8f98d100ae0ede37f42d5c084d1401805e1e843/pkg/src/main.zig",
+    };
+
+    pub fn addAllTo(artifact: *std.build.LibExeObjStep) void {
+        @setEvalBranchQuota(1_000_000);
+        inline for (std.meta.declarations(pkgs)) |decl| {
+            if (decl.is_pub and decl.data == .Var) {
+                artifact.addPackage(@field(pkgs, decl.name));
+            }
+        }
+    }
+};
+
+pub const base_dirs = struct {
+    pub const wasm = ".gyro/wasm-zig-kubkon-a8f98d100ae0ede37f42d5c084d1401805e1e843/pkg";
+};

example/gcd.wat renamed to examples/gcd.wat

@@ -6,7 +6,7 @@ const ga = std.heap.c_allocator;
 const Allocator = std.mem.Allocator;
 
 pub fn main() !void {
-    const wasm_path = if (builtin.os.tag == .windows) "example\\gcd.wat" else "example/gcd.wat";
+    const wasm_path = if (builtin.os.tag == .windows) "examples\\gcd.wat" else "examples/gcd.wat";
     const wasm_file = try fs.cwd().openFile(wasm_path, .{});
     const wasm = try wasm_file.readToEndAlloc(ga, std.math.maxInt(u64));
     defer ga.free(wasm);
@@ -23,7 +23,7 @@ pub fn main() !void {
     defer module.deinit();
     std.debug.print("Wasm module compiled...\n", .{});
 
-    var instance = try wasmtime.Instance.init(store, module, &[_]*wasmtime.Func{});
+    var instance = try wasmtime.Instance.init(store, module, &.{});
     defer instance.deinit();
     std.debug.print("Instance initialized...\n", .{});
 

example/gcd.zig renamed to examples/gcd.zig

@@ -5,36 +5,36 @@ const fs = std.fs;
 const ga = std.heap.c_allocator;
 const Allocator = std.mem.Allocator;
 
-fn interrupt(handle: *wasmtime.c.InterruptHandle) void {
+fn interrupt(handle: *wasmtime.InterruptHandle) void {
     // sleep for 2 seconds
     std.time.sleep(std.time.ns_per_s * 2);
     std.debug.print("Sending interrupt...\n", .{});
     handle.interrupt();
 }
 
 pub fn main() !void {
-    const wasm_path = if (builtin.os.tag == .windows) "example\\interrupt.wat" else "example/interrupt.wat";
+    const wasm_path = if (builtin.os.tag == .windows) "examples\\interrupt.wat" else "examples/interrupt.wat";
     const wasm_file = try fs.cwd().openFile(wasm_path, .{});
     const wasm = try wasm_file.readToEndAlloc(ga, std.math.maxInt(u64));
     defer ga.free(wasm);
 
     const config = try wasmtime.Config.init(.{ .interruptable = true });
-    var engine = try wasmtime.Engine.withConfig(config);
+    var engine = try wasmtime.Engine.withConfig(config.inner);
     defer engine.deinit();
     std.debug.print("Engine initialized...\n", .{});
 
     var store = try wasmtime.Store.init(engine);
     std.debug.print("Store initialized...\n", .{});
 
-    var handle = try wasmtime.c.InterruptHandle.init(store);
+    var handle = try wasmtime.InterruptHandle.init(store);
     defer handle.deinit();
     std.debug.print("Interrupt handle created...\n", .{});
 
     var module = try wasmtime.Module.initFromWat(engine, wasm);
     defer module.deinit();
     std.debug.print("Wasm module compiled...\n", .{});
 
-    var instance = try wasmtime.Instance.init(store, module, &[_]*wasmtime.Func{});
+    var instance = try wasmtime.Instance.init(store, module, &.{});
     defer instance.deinit();
     std.debug.print("Instance initialized...\n", .{});