feat: support WasmEdge (#93)

* feat: support WasmEdge

* tweak ci script

Signed-off-by: spacewander <[email protected]>

Author: spacewander

.github/workflows/test.yml

@@ -8,6 +8,12 @@ on:
 
 jobs:
   test:
+    strategy:
+      fail-fast: false
+      matrix:
+        vm:
+          - wasmedge
+          - wasmtime
     runs-on: "ubuntu-20.04"
     env:
       OPENRESTY_PREFIX: "/usr/local/openresty"
@@ -52,16 +58,18 @@ jobs:
 
       - name: Install
         run: |
+          ./install-wasmedge.sh
+
           wget https://raw.githubusercontent.com/api7/apisix-build-tools/master/build-apisix-base.sh
           chmod +x build-apisix-base.sh
           OR_PREFIX=$OPENRESTY_PREFIX CC="clang -fsanitize=address -fcolor-diagnostics -Qunused-arguments" \
               cc_opt="-Werror -fsanitize=undefined" \
-              ld_opt="-lubsan" \
+              ld_opt="-lubsan -Wl,-rpath,$OPENRESTY_PREFIX/wasmedge/lib" \
               ./build-apisix-base.sh latest
 
       - name: Script
         run: |
           sudo chown -R runner:root ~/.cache
           make build.all.testdata
           export PATH=$OPENRESTY_PREFIX/nginx/sbin:$PATH
-          WASM_VM=wasmtime prove -I. -Itest-nginx/lib -r t/
+          WASM_VM=${{ matrix.vm }} prove -I. -Itest-nginx/lib -r t/

.gitignore

@@ -3,6 +3,7 @@
 wasmtime-*-c-api
 wasmtime-*-c-api.tar.xz
 wasmtime-c-api
+wasmedge/
 *.wasm
 *.wasm.map
 *.wat

Makefile

@@ -20,6 +20,7 @@ RUST_DIR = $(wildcard t/testdata/rust/*)
 install:
 	$(INSTALL) -m 664 lib/resty/*.lua $(OPENRESTY_PREFIX)/lualib/resty/
 	cp -r ./wasmtime-c-api $(OPENRESTY_PREFIX)/
+	cp -r ./wasmedge $(OPENRESTY_PREFIX)/
 
 .PHONY: build.go.testdata
 build.go.testdata:

README.md

@@ -34,18 +34,26 @@ export wasmtime_prefix=/path/to/wasm-nginx-module/wasmtime-c-api
     --with-ld-opt="-Wl,-rpath,${wasmtime_prefix}/lib" \
 ```
 
+* Download WasmEdge with the `./install-wasmedge.sh`.
+Remember to add the `$HOME/.wasmedge/lib` to the library search path when you build Nginx, for instance,
+
+```
+./configure ... \
+    --with-ld-opt="-Wl,-rpath,${HOME}/.wasmedge/lib" \
+```
+
 ## Directives
 
 ### wasm_vm
 
-**syntax:** *wasm_vm wasmtime*
+**syntax:** *wasm_vm wasmtime|wasmedge*
 
 **default:** -
 
 **context:** *http*
 
-Select the Wasm VM. Currently, only wasmtime is supported.
-If the directive is not set, the Wasm VM won't be enabled.
+Select the WASM VM. Currently, only wasmtime and WasmEdge are supported.
+If the directive is not set, the WASM VM won't be enabled.
 
 ## Methods
 

config

@@ -36,6 +36,26 @@ ngx_module_libs=" \
     -L$ngx_addon_dir/wasmtime-c-api/lib -lwasmtime \
 "
 
+if [ -d $ngx_addon_dir/wasmedge ]; then
+    # if wasmedge is installed
+    wasmedge_path=$ngx_addon_dir/wasmedge
+    ngx_module_srcs=" \
+        $ngx_module_srcs \
+        $ngx_addon_dir/src/vm/wasmedge.c \
+    "
+    ngx_module_incs=" \
+        $ngx_module_incs \
+        $wasmedge_path/include \
+    "
+    ngx_module_libs=" \
+        $ngx_module_libs \
+        -L$wasmedge_path/lib -lwasmedge_c \
+    "
+
+    echo "Build with WasmEdge enabled"
+    have=NGX_WASM_HAVE_WASMEDGE . auto/have
+fi
+
 . auto/module
 
 ngx_addon_name=$ngx_module_name

gen_wasm_host_api.py

@@ -103,6 +103,31 @@ def predefined_macro(vm):
     wasm_valkind_t           param_type[MAX_WASM_API_ARG];
 } ngx_wasm_wasmtime_host_api_t;
 
+"""
+    elif vm == "wasmedge":
+        vm_def = """
+#define DEFINE_WASM_API(NAME, ARG_CHECK) \\
+    static WasmEdge_Result wasmedge_##NAME( \\
+        void *Data, \\
+        WasmEdge_MemoryInstanceContext *MemCxt, \\
+        const WasmEdge_Value *In, \\
+        WasmEdge_Value *Out \\
+    ) { \\
+        ARG_CHECK \\
+        Out[0] = WasmEdge_ValueGenI32(res); \\
+        return WasmEdge_Result_Success; \\
+    }
+#define DEFINE_WASM_NAME(NAME, ARG) \\
+    {ngx_string(#NAME), wasmedge_##NAME, ARG},
+
+
+typedef struct {
+    ngx_str_t                name;
+    WasmEdge_HostFunc_t      cb;
+    int8_t                   param_num;
+    enum WasmEdge_ValType    param_type[MAX_WASM_API_ARG];
+} ngx_wasm_wasmedge_host_api_t;
+
 """
 
     for i in range(max_wasm_api_arg + 1):
@@ -118,6 +143,8 @@ def predefined_macro(vm):
             param_s = ""
             if vm == "wasmtime":
                 kind = "WASM_I32"
+            else:
+                kind = "WasmEdge_ValType_I32"
             for j in range(1, i + 1):
                 if j % 5 == 1:
                     param_s += "    "
@@ -133,6 +160,8 @@ def predefined_macro(vm):
             for j in range(i):
                 if vm == "wasmtime":
                     vm_def += "    int32_t p%d = args[%d].of.i32; \\\n" % (j, j)
+                elif vm == "wasmedge":
+                    vm_def += "    int32_t p%d = WasmEdge_ValueGetI32(In[%d]); \\\n" % (j, j)
             param_s = ", ".join('p' + str(j) for j in range(i))
             vm_def += "    int32_t res = NAME(%s);\n" % (param_s)
     return vm_def
@@ -222,3 +251,15 @@ def get_host_apis(src_dir):
             wasm_api_def=wasmtime_def,
             max_wasm_api_arg=max_wasm_api_arg,
         ))
+
+    wasmedge_def = predefined_macro("wasmedge")
+    wasmedge_def += api_def + "\n\nstatic ngx_wasm_wasmedge_host_api_t host_apis[] = {\n"
+    wasmedge_def += name_def
+    with open(os.path.join(src_dir, "ngx_http_wasm_api_wasmedge.h"), 'w') as f:
+        f.write(s.substitute(
+            header=header,
+            vm_header="#include <wasmedge/wasmedge.h>",
+            vm_api_header_name="NGX_HTTP_WASM_API_WASMEDGE_H",
+            wasm_api_def=wasmedge_def,
+            max_wasm_api_arg=max_wasm_api_arg,
+        ))

install-wasmedge.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# Copyright 2022 Shenzhen ZhiLiu Technology Co., Ltd.
+#
+# 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.
+#
+set -euo pipefail -x
+
+if echo "int main(void) {}" | gcc -o /dev/null -v -x c - &> /dev/stdout| grep collect | tr -s " " "\012" | grep musl; then
+    # skip if the libc is musl
+    exit 0
+fi
+
+curl -sSf https://raw.githubusercontent.com/WasmEdge/WasmEdge/master/utils/install.sh | bash -s -- -e none -p ./wasmedge -v 0.10.0-alpha.1