feat: support assemblyscript SDK (#19)

Author: spacewander

.github/workflows/test.yml

@@ -16,6 +16,11 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v2
 
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 10.0.0
+
       - name: Get dependencies
         run: |
           sudo apt install -y cpanminus build-essential libncurses5-dev libreadline-dev libssl-dev perl luarocks

.gitignore

@@ -4,5 +4,8 @@ wasmtime-*-c-api
 wasmtime-*-c-api.tar.xz
 wasmtime-c-api
 *.wasm
+*.wasm.map
+*.wat
 
 t/servroot
+node_modules/

Makefile

@@ -6,10 +6,7 @@ install:
 	$(INSTALL) -m 664 lib/resty/*.lua $(OPENRESTY_PREFIX)/lualib/resty/
 	cp -r ./wasmtime-c-api $(OPENRESTY_PREFIX)/
 
-.PHONY: build.testdata
-build.testdata:
-	@find ./t/testdata -type f -name "main.go" | grep ${name} | xargs -Ip tinygo build -o p.wasm -scheduler=none -target=wasi p
-
 .PHONY: build.all.testdata
 build.all.testdata:
 	@find ./t/testdata -type f -name "main.go" | xargs -Ip tinygo build -o p.wasm -scheduler=none -target=wasi p
+	@cd ./t/testdata/assemblyscript && npm install && npm run asbuild

README.md

@@ -36,12 +36,12 @@ not set, the WASM VM won't be enabled.
 
 ### load
 
-`syntax: plugin, err = proxy_wasm.load(path)`
+`syntax: plugin, err = proxy_wasm.load(name, path)`
 
 Load a `.wasm` file from the filesystem and return a WASM plugin.
 
 ```lua
-local plugin, err = proxy_wasm.load("t/testdata/plugin_lifecycle/main.go.wasm")
+local plugin, err = proxy_wasm.load("plugin","t/testdata/plugin_lifecycle/main.go.wasm")
 ```
 
 ### on_configure
@@ -51,7 +51,7 @@ local plugin, err = proxy_wasm.load("t/testdata/plugin_lifecycle/main.go.wasm")
 Create a plugin ctx with the given plugin and conf.
 
 ```lua
-local plugin, err = proxy_wasm.load("t/testdata/plugin_lifecycle/main.go.wasm")
+local plugin, err = proxy_wasm.load("plugin","t/testdata/plugin_lifecycle/main.go.wasm")
 if not plugin then
     ngx.log(ngx.ERR, "failed to load wasm ", err)
     return
@@ -70,7 +70,7 @@ end
 Run the HTTP request headers filter in the plugin of the given plugin ctx.
 
 ```lua
-local plugin, err = proxy_wasm.load("t/testdata/plugin_lifecycle/main.go.wasm")
+local plugin, err = proxy_wasm.load("plugin","t/testdata/plugin_lifecycle/main.go.wasm")
 if not plugin then
     ngx.log(ngx.ERR, "failed to load wasm ", err)
     return

lib/resty/proxy-wasm.lua

@@ -16,7 +16,7 @@ typedef struct {
     u_char     *data;
 } ngx_str_t;
 typedef long ngx_int_t;
-void *ngx_http_wasm_load_plugin(const char *code, size_t size);
+void *ngx_http_wasm_load_plugin(const char *name, size_t name_len, const char *code, size_t size);
 void ngx_http_wasm_unload_plugin(void *plugin);
 void *ngx_http_wasm_on_configure(void *plugin, const char *conf, size_t size);
 void ngx_http_wasm_delete_plugin_ctx(void *hwp_ctx);
@@ -30,7 +30,7 @@ local _M = {}
 local HTTP_REQUEST_HEADERS = 1
 
 
-function _M.load(path)
+function _M.load(name, path)
     local f, err = io.open(path)
     if not f then
         return nil, err
@@ -42,7 +42,7 @@ function _M.load(path)
         return nil, err
     end
 
-    local plugin = C.ngx_http_wasm_load_plugin(data, #data)
+    local plugin = C.ngx_http_wasm_load_plugin(name, #name, data, #data)
     if plugin == nil then
         return nil, "failed to load wasm plugin"
     end

src/http/ngx_http_wasm_api.c

@@ -79,6 +79,32 @@ ngx_http_wasm_copy_to_wasm(ngx_log_t *log, const u_char *data, int32_t len,
 }
 
 
+int32_t
+proxy_get_property(int32_t path_data, int32_t path_size,
+                   int32_t res_data, int32_t res_size)
+{
+    ngx_log_t          *log;
+    const u_char       *p;
+
+    log = ngx_http_wasm_get_log();
+
+    p = ngx_wasm_vm.get_memory(log, path_data, path_size);
+    if (p == NULL) {
+      return PROXY_RESULT_INVALID_MEMORY_ACCESS;
+    }
+
+    if (ngx_strncmp(p, "plugin_root_id", sizeof("plugin_root_id") - 1) == 0) {
+        ngx_str_t       *name;
+
+        name = ngx_http_wasm_get_plugin_name();
+        return ngx_http_wasm_copy_to_wasm(log, name->data, name->len,
+                                          res_data, res_size);
+    }
+
+    return PROXY_RESULT_OK;
+}
+
+
 int32_t
 proxy_log(int32_t log_level, int32_t addr, int32_t size)
 {

src/http/ngx_http_wasm_api.h

@@ -43,6 +43,16 @@
     int32_t p3 = args[2].of.i32; \
     int32_t res = NAME(p1, p2, p3);
 
+#define DEFINE_WASM_API_ARG_I32_I32_I32_I32 \
+    int32_t, int32_t, int32_t, int32_t
+
+#define DEFINE_WASM_API_ARG_CHECK_I32_I32_I32_I32(NAME) \
+    int32_t p1 = args[0].of.i32; \
+    int32_t p2 = args[1].of.i32; \
+    int32_t p3 = args[2].of.i32; \
+    int32_t p4 = args[3].of.i32; \
+    int32_t res = NAME(p1, p2, p3, p4);
+
 #define DEFINE_WASM_API_ARG_I32_I32_I32_I32_I32 \
     int32_t, int32_t, int32_t, int32_t, int32_t
 
@@ -78,6 +88,8 @@
     1, {WASM_I32}
 #define DEFINE_WASM_NAME_ARG_I32_I32_I32 \
     3, {WASM_I32, WASM_I32, WASM_I32}
+#define DEFINE_WASM_NAME_ARG_I32_I32_I32_I32 \
+    4, {WASM_I32, WASM_I32, WASM_I32, WASM_I32}
 #define DEFINE_WASM_NAME_ARG_I32_I32_I32_I32_I32 \
     5, {WASM_I32, WASM_I32, WASM_I32, WASM_I32, WASM_I32}
 #define DEFINE_WASM_NAME_ARG_I32_I32_I32_I32_I32_I32_I32_I32 \
@@ -98,6 +110,9 @@ DEFINE_WASM_API(proxy_set_effective_context,
 DEFINE_WASM_API(proxy_log,
                 DEFINE_WASM_API_ARG_I32_I32_I32,
                 DEFINE_WASM_API_ARG_CHECK_I32_I32_I32(proxy_log))
+DEFINE_WASM_API(proxy_get_property,
+                DEFINE_WASM_API_ARG_I32_I32_I32_I32,
+                DEFINE_WASM_API_ARG_CHECK_I32_I32_I32_I32(proxy_get_property))
 DEFINE_WASM_API(proxy_get_buffer_bytes,
                 DEFINE_WASM_API_ARG_I32_I32_I32_I32_I32,
                 DEFINE_WASM_API_ARG_CHECK_I32_I32_I32_I32_I32(proxy_get_buffer_bytes))
@@ -110,6 +125,7 @@ DEFINE_WASM_API(proxy_send_http_response,
 static ngx_wasm_host_api_t host_apis[] = {
     DEFINE_WASM_NAME(proxy_set_effective_context, DEFINE_WASM_NAME_ARG_I32)
     DEFINE_WASM_NAME(proxy_log, DEFINE_WASM_NAME_ARG_I32_I32_I32)
+    DEFINE_WASM_NAME(proxy_get_property, DEFINE_WASM_NAME_ARG_I32_I32_I32_I32)
     DEFINE_WASM_NAME(proxy_get_buffer_bytes, DEFINE_WASM_NAME_ARG_I32_I32_I32_I32_I32)
     DEFINE_WASM_NAME_ALIAS(proxy_send_http_response,
                            DEFINE_WASM_NAME_ARG_I32_I32_I32_I32_I32_I32_I32_I32,

src/http/ngx_http_wasm_ctx.h

@@ -7,11 +7,13 @@
 
 
 typedef struct {
-    void        *plugin;
-    uint32_t     cur_ctx_id;
-    ngx_queue_t  occupied;
-    ngx_queue_t  free;
-    unsigned     done:1;
+    void                  *plugin;
+    uint32_t               cur_ctx_id;
+    ngx_str_t              name;
+    ngx_http_wasm_state_t *state;
+    ngx_queue_t            occupied;
+    ngx_queue_t            free;
+    unsigned               done:1;
 } ngx_http_wasm_plugin_t;
 
 

src/http/ngx_http_wasm_module.c

@@ -162,7 +162,8 @@ ngx_http_wasm_init(ngx_conf_t *cf)
 
 
 void *
-ngx_http_wasm_load_plugin(const char *bytecode, size_t size)
+ngx_http_wasm_load_plugin(const char *name, size_t name_len,
+                          const char *bytecode, size_t size)
 {
     void                    *plugin;
     ngx_int_t                rc;
@@ -185,13 +186,22 @@ ngx_http_wasm_load_plugin(const char *bytecode, size_t size)
         goto free_plugin;
     }
 
-    hw_plugin = ngx_calloc(sizeof(ngx_http_wasm_plugin_t), ngx_cycle->log);
+    hw_plugin = ngx_calloc(sizeof(ngx_http_wasm_plugin_t) + name_len +
+                           sizeof(ngx_http_wasm_state_t), ngx_cycle->log);
     if (hw_plugin == NULL) {
         goto free_plugin;
     }
 
     hw_plugin->cur_ctx_id = 0;
     hw_plugin->plugin = plugin;
+
+    hw_plugin->name.len = name_len;
+    hw_plugin->name.data = (u_char *) (hw_plugin + 1);
+    ngx_memcpy(hw_plugin->name.data, name, name_len);
+
+    hw_plugin->state = (ngx_http_wasm_state_t *) (hw_plugin->name.data + name_len + 1);
+    hw_plugin->state->plugin_name = &hw_plugin->name;
+
     ngx_queue_init(&hw_plugin->occupied);
     ngx_queue_init(&hw_plugin->free);
     return hw_plugin;
@@ -327,6 +337,8 @@ ngx_http_wasm_on_configure(ngx_http_wasm_plugin_t *hw_plugin, const char *conf,
         ngx_queue_init(&hwp_ctx->free);
     }
 
+    ngx_http_wasm_set_state(hw_plugin->state);
+
     rc = ngx_wasm_vm.call(plugin, &proxy_on_context_create, false,
                           NGX_WASM_PARAM_I32_I32, ctx_id, 0);
     if (rc != NGX_OK) {
@@ -349,6 +361,7 @@ ngx_http_wasm_on_configure(ngx_http_wasm_plugin_t *hw_plugin, const char *conf,
         goto free_hwp_ctx;
     }
     hwp_ctx->state->r = NULL;
+    hwp_ctx->state->plugin_name = &hwp_ctx->hw_plugin->name;
 
     state_conf = (u_char *) (hwp_ctx->state + 1);
     /* copy conf so we can access it anytime */

src/http/ngx_http_wasm_state.c

@@ -42,3 +42,14 @@ ngx_http_wasm_get_log(void)
 
     return ngx_cycle->log;
 }
+
+
+ngx_str_t *
+ngx_http_wasm_get_plugin_name(void)
+{
+    if (cur_state == NULL) {
+        return NULL;
+    }
+
+    return cur_state->plugin_name;
+}

src/http/ngx_http_wasm_state.h

@@ -7,15 +7,17 @@
 
 
 typedef struct {
-    ngx_str_t           conf;
-    ngx_http_request_t *r;
+    ngx_str_t                 conf;
+    ngx_http_request_t       *r;
+    ngx_str_t                *plugin_name;
 } ngx_http_wasm_state_t;
 
 
 void ngx_http_wasm_set_state(ngx_http_wasm_state_t *state);
 const ngx_str_t *ngx_http_wasm_get_conf(void);
 ngx_http_request_t *ngx_http_wasm_get_req(void);
 ngx_log_t *ngx_http_wasm_get_log(void);
+ngx_str_t *ngx_http_wasm_get_plugin_name(void);
 
 
 #endif // NGX_HTTP_WASM_STATE_H

src/vm/wasmtime.c

@@ -152,13 +152,13 @@ ngx_wasm_wasmtime_load(const char *bytecode, size_t size)
     error = wasmtime_linker_instantiate(linker, context, module, &plugin->instance, &trap);
     if (error != NULL) {
         ngx_wasm_wasmtime_report_error(ngx_cycle->log, "failed to new instance: ", error, NULL);
-        goto free_linker;
+        goto free_plugin;
     }
 
     ok = wasmtime_instance_export_get(context, &plugin->instance, "memory", strlen("memory"), &item);
     if (!ok || item.kind != WASMTIME_EXTERN_MEMORY) {
         ngx_log_error(NGX_LOG_ERR, ngx_cycle->log, 0, "the wasm plugin doesn't export memory");
-        goto free_linker;
+        goto free_plugin;
     }
     plugin->memory = item.of.memory;
 
@@ -172,6 +172,9 @@ ngx_wasm_wasmtime_load(const char *bytecode, size_t size)
 
     return plugin;
 
+free_plugin:
+    ngx_free(plugin);
+
 free_linker:
     wasmtime_linker_delete(linker);
 
@@ -313,7 +316,8 @@ ngx_wasm_wasmtime_malloc(ngx_log_t *log, int32_t size)
     bool                        found;
 
     found = wasmtime_instance_export_get(cur_plugin->context, &cur_plugin->instance,
-                                         "proxy_on_memory_allocate", 24, &func);
+                                         "malloc", 6, &func);
+                                         //"proxy_on_memory_allocate", 24, &func);
     if (!found) {
         found = wasmtime_instance_export_get(cur_plugin->context, &cur_plugin->instance,
                                              "malloc", 6, &func);

t/assemblyscript.t

@@ -0,0 +1,20 @@
+use t::WASM 'no_plan';
+
+run_tests();
+
+__DATA__
+
+=== TEST 1: fault injection
+--- config
+location /t {
+    content_by_lua_block {
+        local wasm = require("resty.proxy-wasm")
+        local plugin = assert(wasm.load("FaultInjection",
+            "t/testdata/assemblyscript/build/untouched.wasm"))
+        local ctx = assert(wasm.on_configure(plugin, 'body'))
+        assert(wasm.on_http_request_headers(ctx))
+    }
+}
+--- error_code: 403
+--- response_body chomp
+body

t/http_lifecycle.t

@@ -9,7 +9,7 @@ __DATA__
 location /t {
     content_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin = assert(wasm.load("t/testdata/http_lifecycle/main.go.wasm"))
+        local plugin = assert(wasm.load("plugin", "t/testdata/http_lifecycle/main.go.wasm"))
         local ctx = assert(wasm.on_configure(plugin, '{"body":512}'))
         assert(wasm.on_http_request_headers(ctx))
         assert(wasm.on_http_request_headers(ctx))
@@ -28,7 +28,7 @@ free http context 2
 location /t {
     content_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin = assert(wasm.load("t/testdata/http_lifecycle/main.go.wasm"))
+        local plugin = assert(wasm.load("plugin", "t/testdata/http_lifecycle/main.go.wasm"))
         do
             local ctx = assert(wasm.on_configure(plugin, '{"body":512}'))
             assert(wasm.on_http_request_headers(ctx))
@@ -48,7 +48,7 @@ free plugin context 1
 --- http_config
     init_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin = assert(wasm.load("t/testdata/http_lifecycle/main.go.wasm"))
+        local plugin = assert(wasm.load("plugin", "t/testdata/http_lifecycle/main.go.wasm"))
         package.loaded.ctx = assert(wasm.on_configure(plugin, '{"body":512}'))
     }
 --- config
@@ -97,7 +97,7 @@ qr/free http context (1|11)$/
 location /t {
     content_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin = assert(wasm.load("t/testdata/http_lifecycle/main.go.wasm"))
+        local plugin = assert(wasm.load("plugin", "t/testdata/http_lifecycle/main.go.wasm"))
         local ctx1 = assert(wasm.on_configure(plugin, '{"body":512}'))
         local ctx2 = assert(wasm.on_configure(plugin, '{"body":256}'))
         assert(wasm.on_http_request_headers(ctx1))
@@ -117,8 +117,8 @@ run http ctx 4 with conf {"body":256},
 location /t {
     content_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin1 = assert(wasm.load("t/testdata/http_lifecycle/main.go.wasm"))
-        local plugin2 = assert(wasm.load("t/testdata/http_lifecycle/main.go.wasm"))
+        local plugin1 = assert(wasm.load("plugin", "t/testdata/http_lifecycle/main.go.wasm"))
+        local plugin2 = assert(wasm.load("plugin", "t/testdata/http_lifecycle/main.go.wasm"))
         local ctx1 = assert(wasm.on_configure(plugin1, '{"body":512}'))
         local ctx2 = assert(wasm.on_configure(plugin2, '{"body":256}'))
         assert(wasm.on_http_request_headers(ctx1))

t/http_send_response.t

@@ -9,7 +9,7 @@ __DATA__
 location /t {
     content_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin = assert(wasm.load("t/testdata/http_send_response/main.go.wasm"))
+        local plugin = assert(wasm.load("plugin", "t/testdata/http_send_response/main.go.wasm"))
         local ctx = assert(wasm.on_configure(plugin, '403_body'))
         assert(wasm.on_http_request_headers(ctx))
     }
@@ -25,7 +25,7 @@ should not pass
 location /t {
     content_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin = assert(wasm.load("t/testdata/http_send_response/main.go.wasm"))
+        local plugin = assert(wasm.load("plugin", "t/testdata/http_send_response/main.go.wasm"))
         local ctx = assert(wasm.on_configure(plugin, '502'))
         assert(wasm.on_http_request_headers(ctx))
     }