WAMR support clone

- Let WAMR support `CompiledBytecode` level of clone
- enable WAMR JIT
- upgrade to a WMAR newer commit

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

Author: lum1n0us

.bazelrc

@@ -56,6 +56,7 @@ build:clang-tsan --linkopt -fsanitize=thread
 build:clang-tidy --aspects @bazel_clang_tidy//clang_tidy:clang_tidy.bzl%clang_tidy_aspect
 build:clang-tidy --@bazel_clang_tidy//:clang_tidy_config=@proxy_wasm_cpp_host//:clang_tidy_config
 build:clang-tidy --output_groups=report
+build:clang-tidy --config=clang
 
 # Use GCC compiler.
 build:gcc --action_env=BAZEL_COMPILER=gcc

.github/workflows/format.yml

@@ -122,7 +122,7 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: Install dependencies (Linux)
-      run: sudo apt update -y && sudo apt install -y clang-tidy-12
+      run: sudo apt update -y && sudo apt install -y clang-tidy-12 lld-12 && sudo ln -sf /usr/bin/lld-12 /usr/bin/lld
 
     - name: Bazel cache
       uses: PiotrSikora/[email protected]

.github/workflows/test.yml

@@ -174,12 +174,14 @@ jobs:
           arch: x86_64
           action: test
           flags: --config=clang
+          cache: true
         - name: 'WAMR on macOS/x86_64'
           engine: 'wamr'
           repo: 'com_github_bytecodealliance_wasm_micro_runtime'
           os: macos-11
           arch: x86_64
           action: test
+          cache: true
         - name: 'WasmEdge on Linux/x86_64'
           engine: 'wasmedge'
           repo: 'com_github_wasmedge_wasmedge'
@@ -245,7 +247,7 @@ jobs:
 
     - name: Install dependencies (Linux)
       if: ${{ matrix.deps != '' && startsWith(matrix.os, 'ubuntu') }}
-      run: sudo apt update -y && sudo apt install -y ${{ matrix.deps }}
+      run: sudo apt update -y && sudo apt install -y clang-tidy-12 lld-12 && sudo ln -sf /usr/bin/lld-12 /usr/bin/lld
 
     - name: Activate Docker/QEMU
       if: startsWith(matrix.run_under, 'docker')
@@ -282,6 +284,16 @@ jobs:
           echo "filegroup(name = \"$i\", srcs = [\"$i.wasm\"])" >> test/test_data/BUILD; \
         done
 
+    - name: Prepare LLVM libraries (WAMR)
+      shell: bash
+      if: ${{ matrix.engine == 'wamr' }}
+      run: >
+        ${{ matrix.run_under }}
+        bazel build
+        --define engine=${{ matrix.engine }}
+        ${{ matrix.flags }}
+        -- //:wamr_lib
+
     - name: Bazel build/test
       shell: bash
       run: >

bazel/external/wamr.BUILD

@@ -12,17 +12,20 @@ filegroup(
 cmake(
     name = "wamr_lib",
     cache_entries = {
-        "WAMR_BUILD_INTERP": "1",
-        "WAMR_BUILD_FAST_INTERP": "1",
-        "WAMR_BUILD_JIT": "0",
-        "WAMR_BUILD_LAZY_JIT": "0",
-        "WAMR_BUILD_AOT": "0",
-        "WAMR_BUILD_SIMD": "0",
-        "WAMR_BUILD_MULTI_MODULE": "1",
+        "LLVM_DIR": "$EXT_BUILD_DEPS/copy_llvm_13_0_1/llvm/lib/cmake/llvm",
+        "WAMR_BUILD_INTERP": "0",
+        "WAMR_BUILD_JIT": "1",
+        "WAMR_BUILD_AOT": "1",
+        "WAMR_BUILD_SIMD": "1",
+        "WAMR_BUILD_MULTI_MODULE": "0",
         "WAMR_BUILD_LIBC_WASI": "0",
         "WAMR_BUILD_TAIL_CALL": "1",
+        "WAMR_DISABLE_HW_BOUND_CHECK": "0",
+        "WAMR_DISABLE_STACK_HW_BOUND_CHECK": "1",
     },
     generate_args = ["-GNinja"],
     lib_source = ":srcs",
+    linkopts = ["-ldl"],
     out_static_libs = ["libvmlib.a"],
+    deps = ["@llvm-13_0_1//:llvm_13_0_1_lib"],
 )

bazel/external/wamr_llvm.BUILD

@@ -0,0 +1,136 @@
+load("@rules_foreign_cc//foreign_cc:defs.bzl", "cmake")
+
+licenses(["notice"])  # Apache 2
+
+package(default_visibility = ["//visibility:public"])
+
+filegroup(
+    name = "srcs",
+    srcs = glob(["**"]),
+)
+
+cmake(
+    name = "llvm_13_0_1_lib",
+    cache_entries = {
+        # Disable both: BUILD and INCLUDE, since some of the INCLUDE
+        # targets build code instead of only generating build files.
+        "LLVM_BUILD_BENCHMARKS": "off",
+        "LLVM_INCLUDE_BENCHMARKS": "off",
+        "LLVM_BUILD_DOCS": "off",
+        "LLVM_INCLUDE_DOCS": "off",
+        "LLVM_BUILD_EXAMPLES": "off",
+        "LLVM_INCLUDE_EXAMPLES": "off",
+        "LLVM_BUILD_RUNTIME": "off",
+        "LLVM_BUILD_RUNTIMES": "off",
+        "LLVM_INCLUDE_RUNTIMES": "off",
+        "LLVM_BUILD_TESTS": "off",
+        "LLVM_INCLUDE_TESTS": "off",
+        "LLVM_BUILD_TOOLS": "off",
+        "LLVM_INCLUDE_TOOLS": "off",
+        "LLVM_BUILD_UTILS": "off",
+        "LLVM_INCLUDE_UTILS": "off",
+        "LLVM_ENABLE_IDE": "off",
+        "LLVM_ENABLE_LIBEDIT": "off",
+        "LLVM_ENABLE_LIBXML2": "off",
+        "LLVM_ENABLE_TERMINFO": "off",
+        "LLVM_ENABLE_ZLIB": "off",
+        "LLVM_TARGETS_TO_BUILD": "X86",
+        "CMAKE_CXX_FLAGS": "-Wno-unused-command-line-argument",
+    },
+    # `lld` doesn't work on MacOS
+    generate_args = select({
+        "@platforms//os:linux": [
+            "-GNinja",
+            "-DLLVM_USE_LINKER=lld",
+        ],
+        "//conditions:default": [
+            "-GNinja",
+        ],
+    }),
+    lib_source = ":srcs",
+    out_data_dirs = [
+        "bin",
+        "include",
+        "lib",
+        "libexec",
+        "share",
+    ],
+    out_static_libs = [
+        # How to get the library list:
+        #  build LLVM with "-DLLVM_INCLUDE_TOOLS=ON"
+        #  cd bin and run "./llvm-config --libnames"
+        "libLLVMWindowsManifest.a",
+        "libLLVMXRay.a",
+        "libLLVMLibDriver.a",
+        "libLLVMDlltoolDriver.a",
+        "libLLVMCoverage.a",
+        "libLLVMLineEditor.a",
+        "libLLVMX86Disassembler.a",
+        "libLLVMX86AsmParser.a",
+        "libLLVMX86CodeGen.a",
+        "libLLVMX86Desc.a",
+        "libLLVMX86Info.a",
+        "libLLVMOrcJIT.a",
+        "libLLVMMCJIT.a",
+        "libLLVMJITLink.a",
+        "libLLVMInterpreter.a",
+        "libLLVMExecutionEngine.a",
+        "libLLVMRuntimeDyld.a",
+        "libLLVMOrcTargetProcess.a",
+        "libLLVMOrcShared.a",
+        "libLLVMDWP.a",
+        "libLLVMSymbolize.a",
+        "libLLVMDebugInfoPDB.a",
+        "libLLVMDebugInfoGSYM.a",
+        "libLLVMOption.a",
+        "libLLVMObjectYAML.a",
+        "libLLVMMCA.a",
+        "libLLVMMCDisassembler.a",
+        "libLLVMLTO.a",
+        "libLLVMPasses.a",
+        "libLLVMCFGuard.a",
+        "libLLVMCoroutines.a",
+        "libLLVMObjCARCOpts.a",
+        "libLLVMipo.a",
+        "libLLVMVectorize.a",
+        "libLLVMLinker.a",
+        "libLLVMInstrumentation.a",
+        "libLLVMFrontendOpenMP.a",
+        "libLLVMFrontendOpenACC.a",
+        "libLLVMExtensions.a",
+        "libLLVMDWARFLinker.a",
+        "libLLVMGlobalISel.a",
+        "libLLVMMIRParser.a",
+        "libLLVMAsmPrinter.a",
+        "libLLVMDebugInfoMSF.a",
+        "libLLVMDebugInfoDWARF.a",
+        "libLLVMSelectionDAG.a",
+        "libLLVMCodeGen.a",
+        "libLLVMIRReader.a",
+        "libLLVMAsmParser.a",
+        "libLLVMInterfaceStub.a",
+        "libLLVMFileCheck.a",
+        "libLLVMFuzzMutate.a",
+        "libLLVMTarget.a",
+        "libLLVMScalarOpts.a",
+        "libLLVMInstCombine.a",
+        "libLLVMAggressiveInstCombine.a",
+        "libLLVMTransformUtils.a",
+        "libLLVMBitWriter.a",
+        "libLLVMAnalysis.a",
+        "libLLVMProfileData.a",
+        "libLLVMObject.a",
+        "libLLVMTextAPI.a",
+        "libLLVMMCParser.a",
+        "libLLVMMC.a",
+        "libLLVMDebugInfoCodeView.a",
+        "libLLVMBitReader.a",
+        "libLLVMCore.a",
+        "libLLVMRemarks.a",
+        "libLLVMBitstreamReader.a",
+        "libLLVMBinaryFormat.a",
+        "libLLVMTableGen.a",
+        "libLLVMSupport.a",
+        "libLLVMDemangle.a",
+    ],
+)

bazel/repositories.bzl

@@ -159,17 +159,25 @@ def proxy_wasm_cpp_host_repositories():
         http_archive,
         name = "com_github_bytecodealliance_wasm_micro_runtime",
         build_file = "@proxy_wasm_cpp_host//bazel/external:wamr.BUILD",
-        # WAMR-05-18-2022
-        sha256 = "350736fffdc49533f5f372221d01e3b570ecd7b85f4429b22f5d89594eb99d9c",
-        strip_prefix = "wasm-micro-runtime-d7a2888b18c478d87ce8094e1419b4e061db289f",
-        url = "https://github.com/bytecodealliance/wasm-micro-runtime/archive/d7a2888b18c478d87ce8094e1419b4e061db289f.tar.gz",
+        sha256 = "401061c7684d0b62e197b919236dd2ec37ef205976d641c2c9fbe8a1f3fd6f33",
+        strip_prefix = "wasm-micro-runtime-30ee992762972e3dbf8c8440b9f352b33b79f38f",
+        url = "https://github.com/bytecodealliance/wasm-micro-runtime/archive/30ee992762972e3dbf8c8440b9f352b33b79f38f.tar.gz",
     )
 
     native.bind(
         name = "wamr",
         actual = "@com_github_bytecodealliance_wasm_micro_runtime//:wamr_lib",
     )
 
+    maybe(
+        http_archive,
+        name = "llvm-13_0_1",
+        build_file = "@proxy_wasm_cpp_host//bazel/external:wamr_llvm.BUILD",
+        sha256 = "ec6b80d82c384acad2dc192903a6cf2cdbaffb889b84bfb98da9d71e630fc834",
+        strip_prefix = "llvm-13.0.1.src",
+        url = "https://github.com/llvm/llvm-project/releases/download/llvmorg-13.0.1/llvm-13.0.1.src.tar.xz",
+    )
+
     # WasmEdge with dependencies.
 
     maybe(

src/wamr/types.h

@@ -21,6 +21,7 @@ using WasmEnginePtr = common::CSmartPtr<wasm_engine_t, wasm_engine_delete>;
 using WasmFuncPtr = common::CSmartPtr<wasm_func_t, wasm_func_delete>;
 using WasmStorePtr = common::CSmartPtr<wasm_store_t, wasm_store_delete>;
 using WasmModulePtr = common::CSmartPtr<wasm_module_t, wasm_module_delete>;
+using WasmSharedModulePtr = common::CSmartPtr<wasm_shared_module_t, wasm_shared_module_delete>;
 using WasmMemoryPtr = common::CSmartPtr<wasm_memory_t, wasm_memory_delete>;
 using WasmTablePtr = common::CSmartPtr<wasm_table_t, wasm_table_delete>;
 using WasmInstancePtr = common::CSmartPtr<wasm_instance_t, wasm_instance_delete>;

src/wamr/wamr.cc

@@ -58,8 +58,8 @@ class Wamr : public WasmVm {
   std::string_view getEngineName() override { return "wamr"; }
   std::string_view getPrecompiledSectionName() override { return ""; }
 
-  Cloneable cloneable() override { return Cloneable::NotCloneable; }
-  std::unique_ptr<WasmVm> clone() override { return nullptr; }
+  Cloneable cloneable() override { return Cloneable::CompiledBytecode; }
+  std::unique_ptr<WasmVm> clone() override;
 
   bool load(std::string_view bytecode, std::string_view precompiled,
             const std::unordered_map<uint32_t, std::string> &function_names) override;
@@ -108,6 +108,7 @@ class Wamr : public WasmVm {
 
   WasmStorePtr store_;
   WasmModulePtr module_;
+  WasmSharedModulePtr shared_module_;
   WasmInstancePtr instance_;
 
   WasmMemoryPtr memory_;
@@ -132,9 +133,41 @@ bool Wamr::load(std::string_view bytecode, std::string_view /*precompiled*/,
     return false;
   }
 
+  shared_module_ = wasm_module_share(module_.get());
+  if (shared_module_ == nullptr) {
+    return false;
+  }
+
   return true;
 }
 
+std::unique_ptr<WasmVm> Wamr::clone() {
+  assert(module_ != nullptr);
+
+  auto vm = std::make_unique<Wamr>();
+  if (vm == nullptr) {
+    return nullptr;
+  }
+
+  vm->store_ = wasm_store_new(engine());
+  if (vm->store_ == nullptr) {
+    return nullptr;
+  }
+
+  vm->module_ = wasm_module_obtain(vm->store_.get(), shared_module_.get());
+  if (vm->module_ == nullptr) {
+    return nullptr;
+  }
+
+  auto *integration_clone = integration()->clone();
+  if (integration_clone == nullptr) {
+    return nullptr;
+  }
+  vm->integration().reset(integration_clone);
+
+  return vm;
+}
+
 static bool equalValTypes(const wasm_valtype_vec_t *left, const wasm_valtype_vec_t *right) {
   if (left->size != right->size) {
     return false;

test/wasm_vm_test.cc

@@ -31,9 +31,9 @@ INSTANTIATE_TEST_SUITE_P(WasmEngines, TestVm, testing::ValuesIn(getWasmEngines()
                          });
 
 TEST_P(TestVm, Basic) {
-  if (engine_ == "wamr" || engine_ == "wasmedge") {
+  if (engine_ == "wasmedge") {
     EXPECT_EQ(vm_->cloneable(), proxy_wasm::Cloneable::NotCloneable);
-  } else if (engine_ == "wasmtime" || engine_ == "v8") {
+  } else if (engine_ == "wasmtime" || engine_ == "v8" || engine_ == "wamr") {
     EXPECT_EQ(vm_->cloneable(), proxy_wasm::Cloneable::CompiledBytecode);
   } else if (engine_ == "wavm") {
     EXPECT_EQ(vm_->cloneable(), proxy_wasm::Cloneable::InstantiatedModule);