wasm: Add WAMR support (envoyproxy#16057)

WebAssembly Micro Runtime (WAMR) is a standalone WebAssembly (WASM) runtime with a small footprint. It includes a few parts as below: The "iwasm" VM core, supporting WebAssembly interpreter, ahead of time compilation (AoT) and Just-in-Time compilation (JIT) The application framework and the supporting API's for the WASM applications The dynamic management of the WASM applications Risk Level: Medium Testing: Runtime unit testing, integration testing and manual testing Signed-off-by: Le Yao <[email protected]>
leyao-daily · Sep 30, 2021 · 7fa47d7 · 7fa47d7
1 parent 075d29c
commit 7fa47d7
Show file tree

Hide file tree

Showing 20 changed files with 192 additions and 45 deletions.
diff --git a/api/envoy/extensions/wasm/v3/wasm.proto b/api/envoy/extensions/wasm/v3/wasm.proto
@@ -62,6 +62,11 @@ message VmConfig {
   //
   // **envoy.wasm.runtime.v8**: `V8 <https://v8.dev/>`_-based WebAssembly runtime.
   //
+  // .. _extension_envoy.wasm.runtime.wamr:
+  //
+  // **envoy.wasm.runtime.wamr**: `WAMR <https://github.com/bytecodealliance/wasm-micro-runtime/>`_-based WebAssembly runtime.
+  // This runtime is not enabled in the official build.
+  //
   // .. _extension_envoy.wasm.runtime.wavm:
   //
   // **envoy.wasm.runtime.wavm**: `WAVM <https://wavm.github.io/>`_-based WebAssembly runtime.

diff --git a/bazel/BUILD b/bazel/BUILD
@@ -401,6 +401,11 @@ config_setting(
     values = {"define": "wasm=v8"},
 )
 
+config_setting(
+    name = "wasm_wamr",
+    values = {"define": "wasm=wamr"},
+)
+
 config_setting(
     name = "wasm_wasmtime",
     values = {"define": "wasm=wasmtime"},

diff --git a/bazel/envoy_build_system.bzl b/bazel/envoy_build_system.bzl
@@ -24,6 +24,7 @@ load(
     _envoy_select_wasm_cpp_tests = "envoy_select_wasm_cpp_tests",
     _envoy_select_wasm_rust_tests = "envoy_select_wasm_rust_tests",
     _envoy_select_wasm_v8 = "envoy_select_wasm_v8",
+    _envoy_select_wasm_wamr = "envoy_select_wasm_wamr",
     _envoy_select_wasm_wasmtime = "envoy_select_wasm_wasmtime",
     _envoy_select_wasm_wavm = "envoy_select_wasm_wavm",
 )
@@ -208,9 +209,10 @@ envoy_select_enable_http3 = _envoy_select_enable_http3
 envoy_select_hot_restart = _envoy_select_hot_restart
 envoy_select_wasm_cpp_tests = _envoy_select_wasm_cpp_tests
 envoy_select_wasm_rust_tests = _envoy_select_wasm_rust_tests
+envoy_select_wasm_v8 = _envoy_select_wasm_v8
+envoy_select_wasm_wamr = _envoy_select_wasm_wamr
 envoy_select_wasm_wavm = _envoy_select_wasm_wavm
 envoy_select_wasm_wasmtime = _envoy_select_wasm_wasmtime
-envoy_select_wasm_v8 = _envoy_select_wasm_v8
 
 # Binary wrappers (from envoy_binary.bzl)
 envoy_cc_binary = _envoy_cc_binary

diff --git a/bazel/envoy_select.bzl b/bazel/envoy_select.bzl
@@ -60,12 +60,20 @@ def envoy_select_wasm_rust_tests(xs):
 # Selects the given values depending on the Wasm runtimes enabled in the current build.
 def envoy_select_wasm_v8(xs):
     return select({
+        "@envoy//bazel:wasm_wamr": [],
         "@envoy//bazel:wasm_wasmtime": [],
         "@envoy//bazel:wasm_wavm": [],
         "@envoy//bazel:wasm_none": [],
         "//conditions:default": xs,
     })
 
+# Selects the given values depending on the Wasm runtimes enabled in the current build.
+def envoy_select_wasm_wamr(xs):
+    return select({
+        "@envoy//bazel:wasm_wamr": xs,
+        "//conditions:default": [],
+    })
+
 # Selects the given values depending on the Wasm runtimes enabled in the current build.
 def envoy_select_wasm_wavm(xs):
     return select({

diff --git a/bazel/external/proxy_wasm_cpp_host.BUILD b/bazel/external/proxy_wasm_cpp_host.BUILD
@@ -56,6 +56,18 @@ cc_library(
     ],
 )
 
+cc_library(
+    name = "wamr_lib",
+    srcs = glob([
+        "src/wamr/*.h",
+        "src/wamr/*.cc",
+    ]),
+    deps = [
+        ":common_lib",
+        "@envoy//bazel/foreign_cc:wamr",
+    ],
+)
+
 cc_library(
     name = "wavm_lib",
     srcs = glob([

diff --git a/bazel/foreign_cc/BUILD b/bazel/foreign_cc/BUILD
@@ -230,70 +230,63 @@ envoy_cmake_external(
     lib_source = "@org_llvm_llvm//:all",
     static_libraries = select({
         "//conditions:default": [
-            # Order from llvm-config --libnames.
+            # Order from llvm-config --libnames asmparser core debuginfodwarf
+            # engine lto mcparser mirparser orcjit passes runtimedyld
+            # support x86asmparser x86desc
+            "libLLVMOrcJIT.a",
+            "libLLVMOrcError.a",
+            "libLLVMJITLink.a",
+            "libLLVMMIRParser.a",
             "libLLVMLTO.a",
             "libLLVMPasses.a",
             "libLLVMObjCARCOpts.a",
-            "libLLVMSymbolize.a",
-            "libLLVMDebugInfoPDB.a",
-            "libLLVMDebugInfoDWARF.a",
-            "libLLVMFuzzMutate.a",
-            "libLLVMTableGen.a",
-            "libLLVMDlltoolDriver.a",
-            "libLLVMLineEditor.a",
-            "libLLVMOrcJIT.a",
-            "libLLVMCoverage.a",
-            "libLLVMMIRParser.a",
-            "libLLVMObjectYAML.a",
-            "libLLVMLibDriver.a",
-            "libLLVMOption.a",
-            "libLLVMWindowsManifest.a",
+            "libLLVMipo.a",
+            "libLLVMInstrumentation.a",
+            "libLLVMVectorize.a",
+            "libLLVMLinker.a",
+            "libLLVMIRReader.a",
             "libLLVMX86Disassembler.a",
             "libLLVMX86AsmParser.a",
             "libLLVMX86CodeGen.a",
+            "libLLVMCFGuard.a",
             "libLLVMGlobalISel.a",
             "libLLVMSelectionDAG.a",
             "libLLVMAsmPrinter.a",
-            "libLLVMDebugInfoCodeView.a",
-            "libLLVMDebugInfoMSF.a",
+            "libLLVMCodeGen.a",
+            "libLLVMScalarOpts.a",
+            "libLLVMInstCombine.a",
+            "libLLVMAggressiveInstCombine.a",
+            "libLLVMTransformUtils.a",
+            "libLLVMBitWriter.a",
             "libLLVMX86Desc.a",
             "libLLVMMCDisassembler.a",
-            "libLLVMX86Info.a",
             "libLLVMX86Utils.a",
+            "libLLVMX86Info.a",
             "libLLVMMCJIT.a",
-            "libLLVMInterpreter.a",
             "libLLVMExecutionEngine.a",
-            "libLLVMRuntimeDyld.a",
-            "libLLVMCodeGen.a",
             "libLLVMTarget.a",
-            "libLLVMCoroutines.a",
-            "libLLVMipo.a",
-            "libLLVMInstrumentation.a",
-            "libLLVMVectorize.a",
-            "libLLVMScalarOpts.a",
-            "libLLVMLinker.a",
-            "libLLVMIRReader.a",
-            "libLLVMAsmParser.a",
-            "libLLVMInstCombine.a",
-            "libLLVMTransformUtils.a",
-            "libLLVMBitWriter.a",
             "libLLVMAnalysis.a",
             "libLLVMProfileData.a",
+            "libLLVMRuntimeDyld.a",
+            "libLLVMDebugInfoDWARF.a",
             "libLLVMObject.a",
+            "libLLVMTextAPI.a",
             "libLLVMMCParser.a",
             "libLLVMMC.a",
+            "libLLVMDebugInfoCodeView.a",
+            "libLLVMDebugInfoMSF.a",
             "libLLVMBitReader.a",
-            "libLLVMBitstreamReader.a",
+            "libLLVMAsmParser.a",
             "libLLVMCore.a",
+            "libLLVMRemarks.a",
+            "libLLVMBitstreamReader.a",
             "libLLVMBinaryFormat.a",
             "libLLVMSupport.a",
             "libLLVMDemangle.a",
-            "libLLVMRemarks.a",
-            "libLLVMCFGuard.a",
-            "libLLVMTextAPI.a",
         ],
     }),
     tags = ["skip_on_windows"],
+    alwayslink = True,
 )
 
 envoy_cmake_external(
@@ -315,6 +308,25 @@ envoy_cmake_external(
     }),
 )
 
+envoy_cmake_external(
+    name = "wamr",
+    cache_entries = {
+        "LLVM_DIR": "$EXT_BUILD_DEPS/copy_llvm/llvm/lib/cmake/llvm",
+        "WAMR_BUILD_INTERP": "1",
+        "WAMR_BUILD_JIT": "0",
+        "WAMR_BUILD_AOT": "0",
+        "WAMR_BUILD_SIMD": "0",
+        "WAMR_BUILD_MULTI_MODULE": "1",
+        "WAMR_BUILD_LIBC_WASI": "0",
+        "WAMR_BUILD_TAIL_CALL": "1",
+    },
+    defines = ["ENVOY_WASM_WAMR"],
+    lib_source = "@com_github_wamr//:all",
+    static_libraries = ["libvmlib.a"],
+    tags = ["skip_on_windows"],
+    deps = [":llvm"],
+)
+
 envoy_cmake_external(
     name = "wavm",
     binaries = ["wavm"],

diff --git a/bazel/repositories.bzl b/bazel/repositories.bzl
@@ -186,6 +186,7 @@ def envoy_dependencies(skip_targets = []):
     _kafka_deps()
 
     _org_llvm_llvm()
+    _com_github_wamr()
     _com_github_wavm_wavm()
     _com_github_wasmtime()
     _com_github_wasm_c_api()
@@ -927,6 +928,16 @@ def _org_llvm_llvm():
         actual = "@envoy//bazel/foreign_cc:llvm",
     )
 
+def _com_github_wamr():
+    external_http_archive(
+        name = "com_github_wamr",
+        build_file_content = BUILD_ALL_CONTENT,
+    )
+    native.bind(
+        name = "wamr",
+        actual = "@envoy//bazel/foreign_cc:wamr",
+    )
+
 def _com_github_wavm_wavm():
     external_http_archive(
         name = "com_github_wavm_wavm",

diff --git a/bazel/repository_locations.bzl b/bazel/repository_locations.bzl
@@ -688,9 +688,25 @@ REPOSITORY_LOCATIONS_SPEC = dict(
         urls = ["https://github.com/llvm/llvm-project/releases/download/llvmorg-{version}/llvm-{version}.src.tar.xz"],
         release_date = "2020-03-23",
         use_category = ["dataplane_ext"],
-        extensions = ["envoy.wasm.runtime.wavm"],
+        extensions = [
+            "envoy.wasm.runtime.wamr",
+            "envoy.wasm.runtime.wavm",
+        ],
         cpe = "cpe:2.3:a:llvm:*:*",
     ),
+    com_github_wamr = dict(
+        project_name = "Webassembly Micro Runtime",
+        project_desc = "A standalone runtime with a small footprint for WebAssembly",
+        project_url = "https://github.com/bytecodealliance/wasm-micro-runtime",
+        version = "a14a4487bb8b493bf6c68d83b03f12028d16f58a",
+        sha256 = "d68668e129f16a9ddd7a1a0da22b17905a25001ae2de398726d37880b61fee9e",
+        strip_prefix = "wasm-micro-runtime-{version}",
+        urls = ["https://github.com/bytecodealliance/wasm-micro-runtime/archive/{version}.tar.gz"],
+        release_date = "2021-05-14",
+        use_category = ["dataplane_ext"],
+        extensions = ["envoy.wasm.runtime.wamr"],
+        cpe = "N/A",
+    ),
     com_github_wavm_wavm = dict(
         project_name = "WAVM",
         project_desc = "WebAssembly Virtual Machine",
@@ -938,6 +954,7 @@ REPOSITORY_LOCATIONS_SPEC = dict(
             "envoy.stat_sinks.wasm",
             "envoy.wasm.runtime.null",
             "envoy.wasm.runtime.v8",
+            "envoy.wasm.runtime.wamr",
             "envoy.wasm.runtime.wavm",
             "envoy.wasm.runtime.wasmtime",
         ],
@@ -948,8 +965,8 @@ REPOSITORY_LOCATIONS_SPEC = dict(
         project_name = "WebAssembly for Proxies (C++ host implementation)",
         project_desc = "WebAssembly for Proxies (C++ host implementation)",
         project_url = "https://github.com/proxy-wasm/proxy-wasm-cpp-host",
-        version = "31c75e0039f2f5c42dc6e12556cb151a38da6d8b",
-        sha256 = "779e7a8e0fd8ed8b3133b464a8e5a9974bdedb345792d3a6148cb5a87e26976b",
+        version = "e641ffa8893477cdb4720f572f50f003cd51a083",
+        sha256 = "20abaa0ff37b3765111fb81774bf4fa4630e23dc9c468b42016c4ebf4f27a38a",
         strip_prefix = "proxy-wasm-cpp-host-{version}",
         urls = ["https://github.com/proxy-wasm/proxy-wasm-cpp-host/archive/{version}.tar.gz"],
         use_category = ["dataplane_ext"],
@@ -961,10 +978,11 @@ REPOSITORY_LOCATIONS_SPEC = dict(
             "envoy.stat_sinks.wasm",
             "envoy.wasm.runtime.null",
             "envoy.wasm.runtime.v8",
+            "envoy.wasm.runtime.wamr",
             "envoy.wasm.runtime.wavm",
             "envoy.wasm.runtime.wasmtime",
         ],
-        release_date = "2021-05-06",
+        release_date = "2021-05-07",
         cpe = "N/A",
     ),
     proxy_wasm_rust_sdk = dict(

diff --git a/ci/do_ci.sh b/ci/do_ci.sh
@@ -334,6 +334,9 @@ elif [[ "$CI_TARGET" == "bazel.compile_time_options" ]]; then
   TEST_TARGETS=("${TEST_TARGETS[@]/#\/\//@envoy\/\/}")
 
   # Building all the dependencies from scratch to link them against libc++.
+  echo "Building and testing with wasm=wamr: ${TEST_TARGETS[*]}"
+  bazel_with_collection test "${BAZEL_BUILD_OPTIONS[@]}" --define wasm=wamr "${COMPILE_TIME_OPTIONS[@]}" -c dbg "${TEST_TARGETS[@]}" --test_tag_filters=-nofips --build_tests_only
+
   echo "Building and testing with wasm=wasmtime: ${TEST_TARGETS[*]}"
   bazel_with_collection test "${BAZEL_BUILD_OPTIONS[@]}" --define wasm=wasmtime "${COMPILE_TIME_OPTIONS[@]}" -c dbg "${TEST_TARGETS[@]}" --test_tag_filters=-nofips --build_tests_only
 

diff --git a/docs/root/configuration/other_features/wasm.rst b/docs/root/configuration/other_features/wasm.rst
@@ -10,11 +10,12 @@ The following runtimes are supported by Envoy:
   :widths: 1, 2
 
   envoy.wasm.runtime.v8, "`V8 <https://v8.dev>`_-based runtime"
+  envoy.wasm.runtime.wamr, "`WAMR <https://github.com/bytecodealliance/wasm-micro-runtime>`_ runtime"
   envoy.wasm.runtime.wasmtime, "`Wasmtime <https://github.com/bytecodealliance/wasmtime>`_ runtime"
   envoy.wasm.runtime.wavm, "`WAVM <https://github.com/WAVM/WAVM>`_ runtime"
   envoy.wasm.runtime.null, "Compiled modules linked into Envoy"
 
-Wasmtime and WAVM runtimes are not included in Envoy release image by default.
+WAMR(WASM-Micro-Runtime), Wasmtime and WAVM runtimes are not included in Envoy release image by default.
 
 Wasm runtime emits the following statistics:
 

diff --git a/generated_api_shadow/envoy/extensions/wasm/v3/wasm.proto b/generated_api_shadow/envoy/extensions/wasm/v3/wasm.proto
diff --git a/source/extensions/extensions_build_config.bzl b/source/extensions/extensions_build_config.bzl
@@ -245,6 +245,7 @@ EXTENSIONS = {
 
     "envoy.wasm.runtime.null":                          "//source/extensions/wasm_runtime/null:config",
     "envoy.wasm.runtime.v8":                            "//source/extensions/wasm_runtime/v8:config",
+    "envoy.wasm.runtime.wamr":                          "//source/extensions/wasm_runtime/wamr:config",
     "envoy.wasm.runtime.wavm":                          "//source/extensions/wasm_runtime/wavm:config",
     "envoy.wasm.runtime.wasmtime":                      "//source/extensions/wasm_runtime/wasmtime:config",
 

diff --git a/source/extensions/extensions_metadata.yaml b/source/extensions/extensions_metadata.yaml
@@ -664,15 +664,20 @@ envoy.wasm.runtime.v8:
   - envoy.wasm.runtime
   security_posture: unknown
   status: alpha
+envoy.wasm.runtime.wamr:
+  categories:
+  - envoy.wasm.runtime
+  security_posture: unknown  # "This may never change from unknown until the threat model at https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/threat_model#core-and-extensions is updated to capture additional Wasm runtimes".
+  status: alpha
 envoy.wasm.runtime.wasmtime:
   categories:
   - envoy.wasm.runtime
-  security_posture: unknown
+  security_posture: unknown  # "This may never change from unknown until the threat model at https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/threat_model#core-and-extensions is updated to capture additional Wasm runtimes".
   status: alpha
 envoy.wasm.runtime.wavm:
   categories:
   - envoy.wasm.runtime
-  security_posture: unknown
+  security_posture: unknown  # "This may never change from unknown until the threat model at https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/threat_model#core-and-extensions is updated to capture additional Wasm runtimes".
   status: alpha
 envoy.watchdog.profile_action:
   categories:

diff --git a/source/extensions/wasm_runtime/wamr/BUILD b/source/extensions/wasm_runtime/wamr/BUILD
@@ -0,0 +1,21 @@
+load(
+    "//bazel:envoy_build_system.bzl",
+    "envoy_cc_extension",
+    "envoy_extension_package",
+)
+load("//bazel:envoy_select.bzl", "envoy_select_wasm_wamr")
+
+licenses(["notice"])  # Apache 2
+
+envoy_extension_package()
+
+envoy_cc_extension(
+    name = "config",
+    srcs = ["config.cc"],
+    deps = [
+        "//include/envoy/registry",
+        "//source/extensions/common/wasm:wasm_runtime_factory_interface",
+    ] + envoy_select_wasm_wamr([
+        "@proxy_wasm_cpp_host//:wamr_lib",
+    ]),
+)