Fix compilation problem with wasm plugin + Update the use of proxy-wasm library (#12222)

* Fix compilation problem with wasm plugin

* Fix format error

* Fix format error

* Fix format error in cmake files

* Fix engine requirement problem

* Remove wamr fro fedora build for now

* Fix fedora compile requirements

* Turn off wamr engine support for experimental plugin

* Fix typo

* Fix another missing line

* Enable wamr

* Disable wamr because the fedora has an older version

* wasmtime and wamr cannot be used together

Author: shukitchan

CMakePresets.json

@@ -47,6 +47,7 @@
         "CMAKE_COMPILE_WARNING_AS_ERROR": "OFF",
         "CMAKE_INSTALL_PREFIX": "/opt/ats",
         "BUILD_EXPERIMENTAL_PLUGINS": "ON",
+        "ENABLE_WASM_WAMR": "OFF",
         "ENABLE_VERIFY_PLUGINS": "OFF"
       }
     },
@@ -58,6 +59,7 @@
         "ENABLE_AUTEST": "ON",
         "CMAKE_INSTALL_PREFIX": "/tmp/ts-autest",
         "BUILD_EXPERIMENTAL_PLUGINS": "ON",
+        "ENABLE_WASM_WAMR": "OFF",
         "ENABLE_EXAMPLE": "ON"
       }
     },
@@ -106,6 +108,7 @@
         "CMAKE_COMPILE_WARNING_AS_ERROR": "ON",
         "ENABLE_CCACHE": "ON",
         "BUILD_EXPERIMENTAL_PLUGINS": "ON",
+        "ENABLE_WASM_WAMR": "OFF",
         "ENABLE_EXAMPLE": "ON",
         "CMAKE_INSTALL_PREFIX": "/tmp/ats"
       }
@@ -210,7 +213,8 @@
       "binaryDir": "${sourceDir}/build-${presetName}",
       "cacheVariables": {
         "CMAKE_INSTALL_PREFIX": "/tmp/ats",
-        "BUILD_EXPERIMENTAL_PLUGINS": "ON"
+        "BUILD_EXPERIMENTAL_PLUGINS": "ON",
+        "ENABLE_WASM_WAMR": "OFF"
       }
     },
     {
@@ -391,6 +395,7 @@
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Debug",
         "BUILD_EXPERIMENTAL_PLUGINS": "ON",
+        "ENABLE_WASM_WAMR": "OFF",
         "ENABLE_EXAMPLE": "ON",
         "ENABLE_CCACHE": "OFF"
       }

cmake/ExperimentalPlugins.cmake

@@ -115,13 +115,31 @@ auto_option(
 )
 auto_option(URL_SIG FEATURE_VAR BUILD_URL_SIG DEFAULT ${_DEFAULT})
 auto_option(
-  WASM
+  WASM_WAMR
   FEATURE_VAR
-  BUILD_WASM
+  BUILD_WASM_WAMR
   PACKAGE_DEPENDS
   wamr
   DEFAULT
   ${_DEFAULT}
 )
+auto_option(
+  WASM_WASMTIME
+  FEATURE_VAR
+  BUILD_WASM_WASMTIME
+  PACKAGE_DEPENDS
+  wasmtime
+  DEFAULT
+  ${_DEFAULT}
+)
+auto_option(
+  WASM_WASMEDGE
+  FEATURE_VAR
+  BUILD_WASM_WASMEDGE
+  PACKAGE_DEPENDS
+  wasmedge
+  DEFAULT
+  ${_DEFAULT}
+)
 
 unset(_DEFAULT)

cmake/Findwamr.cmake

@@ -29,7 +29,7 @@
 #
 
 find_library(iwasm_LIBRARY NAMES iwasm)
-find_path(wamr_INCLUDE_DIR NAMES wasm_export.h)
+find_path(wamr_INCLUDE_DIR NAMES wasm_c_api.h)
 
 include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(wamr REQUIRED_VARS iwasm_LIBRARY wamr_INCLUDE_DIR)

cmake/Findwasmedge.cmake

@@ -0,0 +1,47 @@
+#######################
+#
+#  Licensed to the Apache Software Foundation (ASF) under one or more contributor license
+#  agreements.  See the NOTICE file distributed with this work for additional information regarding
+#  copyright ownership.  The ASF licenses this file to you 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.
+#
+#######################
+
+# Findwasmedge.cmake
+#
+# This will define the following variables
+#
+#     wasmedge_FOUND
+#     wasmedge_LIBRARY
+#     wasmedge_INCLUDE_DIR
+#
+# and the following imported targets
+#
+#     wasmedge::wasmedge
+#
+
+find_library(lwasmedge_LIBRARY NAMES wasmedge)
+find_path(wasmedge_INCLUDE_DIR NAMES wasmedge/wasmedge.h)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(wasmedge REQUIRED_VARS lwasmedge_LIBRARY wasmedge_INCLUDE_DIR)
+
+if(wasmedge_FOUND)
+  mark_as_advanced(wasmedge_FOUND wasmedge_LIBRARY)
+  set(wasmedge_INCLUDE_DIRS ${wasmedge_INCLUDE_DIR})
+  set(wasmedge_LIBRARY ${lwasmedge_LIBRARY})
+endif()
+
+if(wasmedge_FOUND AND NOT TARGET wasmedge::wasmedge)
+  add_library(wasmedge::wasmedge INTERFACE IMPORTED)
+  target_include_directories(wasmedge::wasmedge INTERFACE ${wasmedge_INCLUDE_DIRS})
+  target_link_libraries(wasmedge::wasmedge INTERFACE ${wasmedge_LIBRARY})
+endif()

cmake/Findwasmtime.cmake

@@ -0,0 +1,47 @@
+#######################
+#
+#  Licensed to the Apache Software Foundation (ASF) under one or more contributor license
+#  agreements.  See the NOTICE file distributed with this work for additional information regarding
+#  copyright ownership.  The ASF licenses this file to you 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.
+#
+#######################
+
+# Findwasmtime.cmake
+#
+# This will define the following variables
+#
+#     wasmtime_FOUND
+#     wasmtime_LIBRARY
+#     wasmtime_INCLUDE_DIR
+#
+# and the following imported targets
+#
+#     wasmtime::wasmtime
+#
+
+find_library(lwasmtime_LIBRARY NAMES wasmtime)
+find_path(wasmtime_INCLUDE_DIR NAMES crates/c-api/include/wasm.h)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(wasmtime REQUIRED_VARS lwasmtime_LIBRARY wasmtime_INCLUDE_DIR)
+
+if(wasmtime_FOUND)
+  mark_as_advanced(wasmtime_FOUND wasmtime_LIBRARY)
+  set(wasmtime_INCLUDE_DIRS ${wasmtime_INCLUDE_DIR})
+  set(wasmtime_LIBRARY ${lwasmtime_LIBRARY})
+endif()
+
+if(wasmtime_FOUND AND NOT TARGET wasmtime::wasmtime)
+  add_library(wasmtime::wasmtime INTERFACE IMPORTED)
+  target_include_directories(wasmtime::wasmtime INTERFACE ${wasmtime_INCLUDE_DIRS})
+  target_link_libraries(wasmtime::wasmtime INTERFACE ${wasmtime_LIBRARY})
+endif()

doc/admin-guide/plugins/wasm.en.rst

@@ -39,11 +39,11 @@ How it Works
 
 The plugin uses the library and header files from the Proxy-Wasm project.
 
-* https://github.com/proxy-wasm/proxy-wasm-cpp-host/tree/b7e690703c7f26707438a2f1ebd7c197bc8f0296
+* https://github.com/proxy-wasm/proxy-wasm-cpp-host/tree/c4d7bb0fda912e24c64daf2aa749ec54cec99412
 * https://github.com/proxy-wasm/proxy-wasm-cpp-sdk/tree/fd0be8405db25de0264bdb78fae3a82668c03782
 
-Proxy-Wasm in turn uses an underlying WebAssembly runtime to execute the WebAssembly module. (Currently only WAMR and
-WasmEdge are supported)
+Proxy-Wasm in turn uses an underlying WebAssembly runtime to execute the WebAssembly module. (Currently only WAMR,
+Wasmtime and WasmEdge are supported)
 
 The plugin creates a root context when ATS starts and a new context will be created out of the root context for each
 transaction. ATS plugin events will trigger the corresponding functions in the WebAssembly module to be executed through
@@ -61,9 +61,9 @@ Compiling the Plugin
 
 ::
 
-  wget https://github.com/bytecodealliance/wasm-micro-runtime/archive/refs/tags/WAMR-1.2.1.tar.gz
-  tar zxvf WAMR-1.2.1.tar.gz
-  cd wasm-micro-runtime-WAMR-1.2.1
+  wget https://github.com/bytecodealliance/wasm-micro-runtime/archive/refs/tags/WAMR-2.1.1.tar.gz
+  tar zxvf WAMR-2.1.1.tar.gz
+  cd wasm-micro-runtime-WAMR-2.1.1
   cp core/iwasm/include/* /usr/local/include/
   cd product-mini/platforms/linux
   mkdir build
@@ -78,16 +78,13 @@ Compiling the Plugin
 
   git clone https://github.com/bytecodealliance/wasmtime.git
   cd wasmtime/
-  git checkout release-9.0.0
+  git checkout release-24.0.0
   git submodule update --init
   cargo build
   cargo build --release --manifest-path crates/c-api/Cargo.toml
   sudo cp target/release/libwasmtime.so /usr/local/lib
-  wget https://github.com/WebAssembly/wasm-c-api/archive/c9d31284651b975f05ac27cee0bab1377560b87e.tar.gz
-  tar zxvf c9d31284651b975f05ac27cee0bab1377560b87e.tar.gz
-  cd wasm-c-api-c9d31284651b975f05ac27cee0bab1377560b87e/
-  sudo mkdir /usr/local/include/include/
-  sudo cp include/wasm.h /usr/local/include/include/
+  sudo mkdir -p /usr/local/include/crates/c-api/include/
+  sudo cp crates/c-api/include/wasm.h /usr/local/include/crates/c-api/include/
 
 **Install WasmEdge**
 

plugins/experimental/CMakeLists.txt

@@ -116,6 +116,9 @@ endif()
 if(BUILD_URL_SIG)
   add_subdirectory(url_sig)
 endif()
-if(BUILD_WASM)
+if(BUILD_WASM_WAMR
+   OR BUILD_WASM_WASMTIME
+   OR BUILD_WASM_WASMEDGE
+)
   add_subdirectory(wasm)
 endif()

plugins/experimental/wasm/CMakeLists.txt

@@ -18,5 +18,26 @@
 add_subdirectory(lib)
 
 add_atsplugin(wasm ats_context.cc ats_wasm.cc wasm_main.cc)
-target_link_libraries(wasm PRIVATE wasmlib wamr::wamr)
+
+set(WASM_RUNTIME wasmlib)
+if(wamr_FOUND)
+  list(APPEND WASM_RUNTIME wamr::wamr)
+elseif(wasmtime_FOUND)
+  list(APPEND WASM_RUNTIME wasmtime::wasmtime)
+endif()
+if(wasmedge_FOUND)
+  list(APPEND WASM_RUNTIME wasmedge::wasmedge)
+endif()
+
+target_link_libraries(wasm PRIVATE ${WASM_RUNTIME})
+
+if(wamr_FOUND)
+  target_compile_options(wasm PRIVATE -DWAMR)
+elseif(wasmtime_FOUND)
+  target_compile_options(wasm PRIVATE -DWASMTIME)
+endif()
+if(wasmedge_FOUND)
+  target_compile_options(wasm PRIVATE -DWASMEDGE)
+endif()
+
 verify_global_plugin(wasm)

plugins/experimental/wasm/lib/CMakeLists.txt

@@ -29,13 +29,23 @@ set(CC_FILES
 )
 if(wamr_FOUND)
   list(APPEND CC_FILES src/wamr/wamr.cc)
+elseif(wasmtime_FOUND)
+  list(APPEND CC_FILES src/wasmtime/wasmtime.cc)
+endif()
+if(wasmedge_FOUND)
+  list(APPEND CC_FILES src/wasmedge/wasmedge.cc)
 endif()
 
 add_library(wasmlib STATIC ${CC_FILES})
 target_compile_options(wasmlib PUBLIC -Wno-unused-parameter)
 if(wamr_FOUND)
   target_compile_options(wasmlib PRIVATE -Wno-missing-field-initializers)
   target_link_libraries(wasmlib PUBLIC wamr::wamr)
+elseif(wasmtime_FOUND)
+  target_link_libraries(wasmlib PUBLIC wasmtime::wasmtime)
+endif()
+if(wasmedge_FOUND)
+  target_link_libraries(wasmlib PUBLIC wasmedge::wasmedge)
 endif()
 
 target_include_directories(wasmlib PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}")

plugins/experimental/wasm/lib/README.proxy-wasm-cpp-host.md

@@ -1 +1,5 @@
 # WebAssembly for Proxies (C++ host implementation)
+
+## How to Contribute
+
+See [CONTRIBUTING](CONTRIBUTING.md).