feat: support *_metric ABI(s) (#148)

Author: Sn0rt

.gitignore

@@ -12,3 +12,4 @@ t/servroot
 node_modules/
 t/testdata/rust/*/target
 utils/reindex
+.idea/

gen_wasm_host_api.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # Copyright 2022 Shenzhen ZhiLiu Technology Co., Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,8 +18,8 @@
 import sys
 from string import Template
 
+MAX_WASM_API_ARG = 12
 
-max_wasm_api_arg = 12
 header = """/*
  * Copyright 2022 Shenzhen ZhiLiu Technology Co., Ltd.
  *
@@ -74,10 +74,9 @@
 #endif
 """
 
-
-def predefined_macro(vm):
+def generate_wasm_runtime_struct(vm):
     if vm == "wasmtime":
-        vm_def = """
+        return """
 #define DEFINE_WASM_API(NAME, ARG_CHECK) \\
     static wasm_trap_t* wasmtime_##NAME( \\
         void *env, \\
@@ -105,7 +104,7 @@ def predefined_macro(vm):
 
 """
     elif vm == "wasmedge":
-        vm_def = """
+        return """
 #define DEFINE_WASM_API(NAME, ARG_CHECK) \\
     static WasmEdge_Result wasmedge_##NAME( \\
         void *Data, \\
@@ -130,7 +129,10 @@ def predefined_macro(vm):
 
 """
 
-    for i in range(max_wasm_api_arg + 1):
+def predefined_macro(vm):
+    vm_def = generate_wasm_runtime_struct(vm)
+
+    for i in range(MAX_WASM_API_ARG + 1):
         if i == 0:
             void_def = """
 #define DEFINE_WASM_NAME_ARG_VOID \\
@@ -164,8 +166,29 @@ def predefined_macro(vm):
                     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
 
+    if vm == "wasmtime":
+        vm_def += r'''
+#define DEFINE_WASM_NAME_ARG_I32_I64 \
+    2, { \
+    WASM_I32, WASM_I64, }
+#define DEFINE_WASM_API_ARG_CHECK_I32_I64(NAME) \
+    int32_t p0 = args[0].of.i32; \
+    int64_t p1 = args[1].of.i64; \
+    int32_t res = NAME(p0, p1);
+'''
+    elif vm == "wasmedge":
+        vm_def += r'''
+#define DEFINE_WASM_NAME_ARG_I32_I64 \
+    2, { \
+    WasmEdge_ValType_I32, WasmEdge_ValType_I64, }
+#define DEFINE_WASM_API_ARG_CHECK_I32_I64(NAME) \
+    int32_t p0 = WasmEdge_ValueGetI32(In[0]); \
+    int64_t p1 = WasmEdge_ValueGetI64(In[1]); \
+    int32_t res = NAME(p0, p1);
+'''
+
+    return vm_def
 
 def get_host_apis(src_dir):
     apis = []
@@ -180,24 +203,25 @@ def get_host_apis(src_dir):
                 name = m.group(1)
             elif line[0] == '{' and matching:
                 matching = False
-                n_param = len(api.split(','))
+                api_list = api.split(',')
+                n_param = len(api_list)
                 if "(void)" in api:
                     n_param -= 1
                 apis.append({
                     "name": name,
-                    "n_param": n_param
+                    "n_param": n_param,
+                    "raw_func": api
                 })
                 api = ""
             if matching:
                 api += line.rstrip()
     return apis
 
-
 if __name__ == '__main__':
     host_api_def = ""
     api_def = ""
     name_def = ""
-    for i in range(max_wasm_api_arg + 1):
+    for i in range(MAX_WASM_API_ARG + 1):
         if i == 0:
             host_api_def += "#define DEFINE_WASM_API_ARG_VOID void\n"
         else:
@@ -212,6 +236,9 @@ def get_host_apis(src_dir):
                     param_s += ", "
                 param_s += "int32_t"
             host_api_def += "#define DEFINE_WASM_API_ARG_%s%s\n" % (param_suffix, param_s)
+
+    host_api_def += """#define DEFINE_WASM_API_ARG_I32_I64 \\\n    int32_t, int64_t"""
+
     host_api_def += "\n\n"
 
     src_dir = sys.argv[1]
@@ -222,6 +249,8 @@ def get_host_apis(src_dir):
         n_param = api["n_param"]
         if n_param == 0:
             param_suffix = "VOID"
+        elif n_param == 2 and "int64_t" in api["raw_func"]:
+            param_suffix = "I32_I64"
         else:
             param_suffix = "I32_%d" % n_param
 
@@ -249,7 +278,7 @@ def get_host_apis(src_dir):
             vm_header="#include <wasmtime.h>",
             vm_api_header_name="NGX_HTTP_WASM_API_WASMTIME_H",
             wasm_api_def=wasmtime_def,
-            max_wasm_api_arg=max_wasm_api_arg,
+            max_wasm_api_arg=MAX_WASM_API_ARG,
         ))
 
     wasmedge_def = predefined_macro("wasmedge")
@@ -261,5 +290,5 @@ def get_host_apis(src_dir):
             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,
+            max_wasm_api_arg=MAX_WASM_API_ARG,
         ))

install-wasmedge.sh

@@ -20,4 +20,4 @@ if echo "int main(void) {}" | gcc -o /dev/null -v -x c - &> /dev/stdout| grep co
     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
+curl -sSf https://raw.githubusercontent.com/WasmEdge/WasmEdge/0.10.0/utils/install.sh | bash -s -- -e none -p ./wasmedge -v 0.10.0

proxy_wasm_abi.md

@@ -345,6 +345,40 @@ We only implement `proxy_send_local_response` as an alias because proxy-wasm-go-
 * returns:
   - `i32 (proxy_result_t) call_result`
 
-Dispatch a HTTP call to upstream (`upstream_name_data`, `upstream_name_size`). Once the response is
+Dispatch an HTTP call to upstream (`upstream_name_data`, `upstream_name_size`). Once the response is
 returned to the host, `proxy_on_http_call_response` will be called with a unique call identifier
 (`return_callout_id`).
+
+## metric extensions
+
+### `proxy_define_metric`
+
+* params:
+  - `i32 (proxy_metric_type_t) metric_type`
+  - `i32 (const char*) name_ptr`
+  - `i32 (size_t) name_size`
+  - `i32 (uint32_t*) metric_id`
+* returns:
+  - `i32 (proxy_result_t) call_result`
+
+### `proxy_increment_metric`
+
+* params:
+ - `i32 (uint32_t) metric_id`
+ - `i64 (int64_t) offset`
+* returns:
+  - `i32 (proxy_result_t) call_result`
+
+### `proxy_record_metric`
+
+* Params:
+ - `i32 (uint32_t) metric_id`
+ - `i64 (uint64_t) value`
+* returns:
+  - `i32 (proxy_result_t) call_result`
+
+### `proxy_get_metric`
+
+* Params:
+ - `i32 (uint32_t) metric_id`
+ - `i64 (uint64_t*) result`

src/http/ngx_http_wasm_api.c

@@ -1789,3 +1789,28 @@ proxy_call_foreign_function(int32_t fn_data, int32_t fn_size,
 {
     return PROXY_RESULT_UNIMPLEMENTED;
 }
+
+int32_t
+proxy_define_metric(int32_t type, int32_t name_data, int32_t name_size,
+                    int32_t result)
+{
+    return PROXY_RESULT_OK;
+}
+
+int32_t
+proxy_increment_metric(int32_t metric_id, int64_t offset)
+{
+    return PROXY_RESULT_OK;
+}
+
+int32_t
+proxy_record_metric(int32_t metric_id, int64_t value)
+{
+    return PROXY_RESULT_OK;
+}
+
+int32_t
+proxy_get_metric(int32_t metric_id, int64_t result)
+{
+    return PROXY_RESULT_OK;
+}

src/http/ngx_http_wasm_api_def.h

@@ -52,7 +52,8 @@
 #define DEFINE_WASM_API_ARG_I32_12 \
     int32_t, int32_t, int32_t, int32_t, int32_t, int32_t, int32_t, int32_t, \
     int32_t, int32_t, int32_t, int32_t
-
+#define DEFINE_WASM_API_ARG_I32_I64 \
+    int32_t, int64_t
 
 int32_t proxy_set_effective_context(DEFINE_WASM_API_ARG_I32_1);
 int32_t proxy_get_property(DEFINE_WASM_API_ARG_I32_4);
@@ -91,6 +92,10 @@ int32_t proxy_grpc_close(DEFINE_WASM_API_ARG_I32_1);
 int32_t proxy_get_status(DEFINE_WASM_API_ARG_I32_3);
 int32_t proxy_done(DEFINE_WASM_API_ARG_VOID);
 int32_t proxy_call_foreign_function(DEFINE_WASM_API_ARG_I32_6);
+int32_t proxy_define_metric(DEFINE_WASM_API_ARG_I32_4);
+int32_t proxy_increment_metric(DEFINE_WASM_API_ARG_I32_I64);
+int32_t proxy_record_metric(DEFINE_WASM_API_ARG_I32_I64);
+int32_t proxy_get_metric(DEFINE_WASM_API_ARG_I32_I64);
 
 
 

src/http/ngx_http_wasm_api_wasmedge.h

@@ -219,6 +219,14 @@ typedef struct {
     int32_t p11 = WasmEdge_ValueGetI32(In[11]); \
     int32_t res = NAME(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11);
 
+#define DEFINE_WASM_NAME_ARG_I32_I64 \
+    2, { \
+    WasmEdge_ValType_I32, WasmEdge_ValType_I64, }
+#define DEFINE_WASM_API_ARG_CHECK_I32_I64(NAME) \
+    int32_t p0 = WasmEdge_ValueGetI32(In[0]); \
+    int64_t p1 = WasmEdge_ValueGetI64(In[1]); \
+    int32_t res = NAME(p0, p1);
+
 DEFINE_WASM_API(proxy_set_effective_context,
                 DEFINE_WASM_API_ARG_CHECK_I32_1(proxy_set_effective_context))
 DEFINE_WASM_API(proxy_get_property,
@@ -293,6 +301,14 @@ DEFINE_WASM_API(proxy_done,
                 DEFINE_WASM_API_ARG_CHECK_VOID(proxy_done))
 DEFINE_WASM_API(proxy_call_foreign_function,
                 DEFINE_WASM_API_ARG_CHECK_I32_6(proxy_call_foreign_function))
+DEFINE_WASM_API(proxy_define_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_4(proxy_define_metric))
+DEFINE_WASM_API(proxy_increment_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_I64(proxy_increment_metric))
+DEFINE_WASM_API(proxy_record_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_I64(proxy_record_metric))
+DEFINE_WASM_API(proxy_get_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_I64(proxy_get_metric))
 
 static ngx_wasm_wasmedge_host_api_t host_apis[] = {
     DEFINE_WASM_NAME(proxy_set_effective_context, DEFINE_WASM_NAME_ARG_I32_1)
@@ -332,6 +348,10 @@ static ngx_wasm_wasmedge_host_api_t host_apis[] = {
     DEFINE_WASM_NAME(proxy_get_status, DEFINE_WASM_NAME_ARG_I32_3)
     DEFINE_WASM_NAME(proxy_done, DEFINE_WASM_NAME_ARG_VOID)
     DEFINE_WASM_NAME(proxy_call_foreign_function, DEFINE_WASM_NAME_ARG_I32_6)
+    DEFINE_WASM_NAME(proxy_define_metric, DEFINE_WASM_NAME_ARG_I32_4)
+    DEFINE_WASM_NAME(proxy_increment_metric, DEFINE_WASM_NAME_ARG_I32_I64)
+    DEFINE_WASM_NAME(proxy_record_metric, DEFINE_WASM_NAME_ARG_I32_I64)
+    DEFINE_WASM_NAME(proxy_get_metric, DEFINE_WASM_NAME_ARG_I32_I64)
     { ngx_null_string, NULL, 0, {} }
 };
 

src/http/ngx_http_wasm_api_wasmtime.h

@@ -222,6 +222,14 @@ typedef struct {
     int32_t p11 = args[11].of.i32; \
     int32_t res = NAME(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11);
 
+#define DEFINE_WASM_NAME_ARG_I32_I64 \
+    2, { \
+    WASM_I32, WASM_I64, }
+#define DEFINE_WASM_API_ARG_CHECK_I32_I64(NAME) \
+    int32_t p0 = args[0].of.i32; \
+    int64_t p1 = args[1].of.i64; \
+    int32_t res = NAME(p0, p1);
+
 DEFINE_WASM_API(proxy_set_effective_context,
                 DEFINE_WASM_API_ARG_CHECK_I32_1(proxy_set_effective_context))
 DEFINE_WASM_API(proxy_get_property,
@@ -296,6 +304,14 @@ DEFINE_WASM_API(proxy_done,
                 DEFINE_WASM_API_ARG_CHECK_VOID(proxy_done))
 DEFINE_WASM_API(proxy_call_foreign_function,
                 DEFINE_WASM_API_ARG_CHECK_I32_6(proxy_call_foreign_function))
+DEFINE_WASM_API(proxy_define_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_4(proxy_define_metric))
+DEFINE_WASM_API(proxy_increment_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_I64(proxy_increment_metric))
+DEFINE_WASM_API(proxy_record_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_I64(proxy_record_metric))
+DEFINE_WASM_API(proxy_get_metric,
+                DEFINE_WASM_API_ARG_CHECK_I32_I64(proxy_get_metric))
 
 static ngx_wasm_wasmtime_host_api_t host_apis[] = {
     DEFINE_WASM_NAME(proxy_set_effective_context, DEFINE_WASM_NAME_ARG_I32_1)
@@ -335,6 +351,10 @@ static ngx_wasm_wasmtime_host_api_t host_apis[] = {
     DEFINE_WASM_NAME(proxy_get_status, DEFINE_WASM_NAME_ARG_I32_3)
     DEFINE_WASM_NAME(proxy_done, DEFINE_WASM_NAME_ARG_VOID)
     DEFINE_WASM_NAME(proxy_call_foreign_function, DEFINE_WASM_NAME_ARG_I32_6)
+    DEFINE_WASM_NAME(proxy_define_metric, DEFINE_WASM_NAME_ARG_I32_4)
+    DEFINE_WASM_NAME(proxy_increment_metric, DEFINE_WASM_NAME_ARG_I32_I64)
+    DEFINE_WASM_NAME(proxy_record_metric, DEFINE_WASM_NAME_ARG_I32_I64)
+    DEFINE_WASM_NAME(proxy_get_metric, DEFINE_WASM_NAME_ARG_I32_I64)
     { ngx_null_string, NULL, 0, {} }
 };
 

src/proxy_wasm/proxy_wasm_types.h

@@ -58,6 +58,14 @@ typedef enum {
 } proxy_result_t;
 
 
+typedef enum {
+  Counter = 0,
+  Gauge = 1,
+  Histogram = 2,
+  Max = 2,
+} metric_type_t;
+
+
 typedef enum {
     PROXY_LOG_TRACE,
     PROXY_LOG_DEBUG,

t/metric.t

@@ -0,0 +1,37 @@
+# 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.
+#
+use t::WASM 'no_plan';
+
+run_tests();
+log_level('debug');
+
+
+__DATA__
+
+=== TEST 1: load metric plugin
+---
+--- config
+location /t {
+    content_by_lua_block {
+        local wasm = require("resty.proxy-wasm")
+        local plugin = assert(wasm.load("plugin", "t/testdata/metric/main.go.wasm"))
+        local ctx = assert(wasm.on_configure(plugin, '{}'))
+        assert(wasm.on_http_request_headers(ctx))
+    }
+}
+--- request
+GET /t
+--- error_log
+Record success