Update Wawaka interpreter for WAMR 2.4.1

- Refactored `CMakeLists.txt` to support WAMR integration and updated
memory configuration.

- Added `wamr` directory with patching scripts and custom build
configurations. Copied the linux-sgx platform cmake build script from
wamr, modified to apply a set of patches which include zero-ing SGX
extended memory on deallocation.

- Introduced `contract_abort_wrapper` and improved exception handling
in `WasmExtensions.cpp`. Removed operations that are now supported
directly by WAMR libc.

- Replaced `RegisterNativeFunctions` with `InitializeNativeSymbols`
for runtime initialization. This incorporates native function
initialization into the single runtime initialization.

- Update `WawakaInterpreter` for wamr 2.4.1. Class variables now
conform to standard usage. Improved initialization and
cleanup (e.g. to release static heap memory). In general, improved
checks on memory usage.

- Removed redundant `__wasm_call_ctors` calls in `Dispatch.cpp`.

- Updated `contract-build.cmake` to export additional symbols for WAMR
compatibility. Specifically, exporting malloc and free symbols enables
wamr to adapt memory usage more easily.

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

Author: cmickeyb

common/interpreter/wawaka_wasm/CMakeLists.txt

@@ -22,132 +22,89 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.10 FATAL_ERROR)
 IF (NOT DEFINED ENV{WASM_SRC})
   MESSAGE(FATAL_ERROR "WASM_SRC environment variable not defined!")
 ENDIF()
-SET(WASM_SRC "$ENV{WASM_SRC}")
+SET (WAMR_ROOT_DIR "$ENV{WASM_SRC}")
 
 # Make sure wasm-micro-runtime submodule has been cloned
-FILE(GLOB WAMR_SUBMOD ${WASM_SRC})
+FILE(GLOB WAMR_SUBMOD ${WAMR_ROOT_DIR})
 LIST(LENGTH WAMR_SUBMOD SUBMOD_CONTENTS)
 IF (SUBMOD_CONTENTS EQUAL 0)
   MESSAGE(FATAL_ERROR "WAMR git submodule has not been cloned. Please run `git submodule update --init` first.")
 ENDIF()
 
-# Reset default linker flags
-SET (CMAKE_SHARED_LIBRARY_LINK_C_FLAGS "")
-SET (CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "")
-
-# Set WAMR_BUILD_TARGET
-IF (NOT DEFINED WAMR_BUILD_TARGET)
-  IF (CMAKE_SIZEOF_VOID_P EQUAL 8)
-    # Build as X86_64 by default in 64-bit platform
-    SET (WAMR_BUILD_TARGET "X86_64")
-  ELSE ()
-    # Build as X86_32 by default in 32-bit platform
-    SET (WAMR_BUILD_TARGET "X86_32")
-  ENDIF ()
-ENDIF ()
-
-IF (NOT CMAKE_BUILD_TYPE)
-  SET(CMAKE_BUILD_TYPE Release)
+# Memory size should be set in Memory.cmake which must be included
+# before this file. There are three values for memory size: SMALL, MEDIUM
+# and LARGE. Each provides defaults for memory allocation. See the note
+# about memory size in Memory.cmake regarding dependencies between
+# memory settings here and in other parts of PDO.
+IF (NOT DEFINED PDO_MEMORY_CONFIG)
+  MESSAGE(FATAL_ERROR "PDO_MEMORY_CONFIG not defined")
 ENDIF()
 
-# Disable AoT by default
+#################################################################
+# WAMR Library
+#
+# The WAMR library is built using a slightly modified version
+# of the build script found in product-mini/platforms/linux-sgx/
+#################################################################
+
+# Set up the WAMR build configuration for use with Wawaka
 SET (WAMR_BUILD_AOT 0)
+SET (WAMR_BUILD_JIT 0)
 SET (WAMR_BUILD_INTERP 1)
+
+# Set the interpreter type
 IF (PDO_INTERPRETER STREQUAL "wawaka-opt")
   SET (WAMR_BUILD_FAST_INTERP 1)
   ADD_DEFINITIONS (-DUSE_WAWAKA_OPT=1)
   MESSAGE(STATUS "Building wawaka in optimized INTERP mode")
 ELSE()
-  # Disable optimized interpreter by default
   SET (WAMR_BUILD_FAST_INTERP 0)
-  MESSAGE(STATUS "Building wawaka in INTERP mode")
+  ADD_DEFINITIONS (-DUSE_WAWAKA_OPT=0)
+  MESSAGE(STATUS "Building wawaka in regular INTERP mode")
 ENDIF()
 
-# Disable JIT by default for all runtime modes.
-SET (WAMR_BUILD_JIT 0)
-
-IF (NOT DEFINED WAMR_BUILD_LIBC_BUILTIN)
-  # Enable libc builtin support by default
-  SET (WAMR_BUILD_LIBC_BUILTIN 1)
-ENDIF ()
+# Build LIBC support but we do not want any of the
+# WASI system calls or pthread support
+SET (WAMR_BUILD_LIBC_BUILTIN 1)
+SET (WAMR_BUILD_LIBC_WASI 0)
+SET (WAMR_BUILD_LIB_PTHREAD 0)
 
-IF (NOT DEFINED WAMR_BUILD_LIBC_WASI)
-  # Disable libc wasi support by default
-  SET (WAMR_BUILD_LIBC_WASI 0)
-ENDIF ()
-
-################################################################################
+# No need for multi-module support
+SET (WAMR_BUILD_MULTI_MODULE 0)
 
-SET(IWASM_STATIC_NAME iwasm)
-SET(WAWAKA_STATIC_NAME wwasm)
-PROJECT(wawaka_wasm C CXX)
+# WASI/clang compiles references so we need
+# to ensure WAMR supports them
+SET (WAMR_BUILD_REF_TYPES 1)
 
-SET (WAMR_BUILD_PLATFORM "linux-sgx")
+# We do not want heap sharing support between modules
+SET (WASM_ENABLE_SHARED_HEAP 0)
 
-SET (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--gc-sections")
-SET (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99 -ffunction-sections -fdata-sections \
-                                     -Wall -Wno-unused-parameter -Wno-pedantic \
-                                     -nostdinc -fvisibility=hidden -fpie" )
+# --------------- Other flags that are not required ---------------
 
-SET (WAMR_ROOT_DIR ${WASM_SRC})
-SET (SHARED_DIR ${WAMR_ROOT_DIR}/core/shared)
-SET (IWASM_DIR ${WAMR_ROOT_DIR}/core/iwasm)
-SET (APP_FRAMEWORK_DIR ${WAMR_ROOT_DIR}/core/app-framework)
+# In theory this should remove the mmap calls, in practice it doesn't
+# appear to work that way.
+# SET(WAMR_DISABLE_STACK_HW_BOUND_CHECK 1)
+# SET(WAMR_DISABLE_HW_BOUND_CHECK 1)
 
-ENABLE_LANGUAGE (ASM)
+# This is used to distinguish between pre-allocated buffers and WAMR
+# managed dynamic allocators in the application. It is not needed.
+# SET (WASM_ENABLE_GLOBAL_HEAP_POOL 0)
 
-#################################################################
-# WAMR Library
-#################################################################
-# include the build config template file
-INCLUDE (${WAMR_ROOT_DIR}/build-scripts/config_common.cmake)
-
-INCLUDE (${SHARED_DIR}/platform/${WAMR_BUILD_PLATFORM}/shared_platform.cmake)
-INCLUDE (${SHARED_DIR}/mem-alloc/mem_alloc.cmake)
-INCLUDE (${SHARED_DIR}/utils/shared_utils.cmake)
-
-# this picks up the libc_erro.h, this appears to be an error in WAMR in that the
-# test for WASI is AFTER the attempt to include a file that is only available when
-# WASI is turned on.
-INCLUDE (${SHARED_DIR}/platform/common/libc-util/platform_common_libc_util.cmake)
-
-IF (WAMR_BUILD_LIBC_BUILTIN EQUAL 1)
-  INCLUDE (${IWASM_DIR}/libraries/libc-builtin/libc_builtin.cmake)
-ENDIF ()
-IF (WAMR_BUILD_LIBC_WASI EQUAL 1)
-  INCLUDE (${IWASM_DIR}/libraries/libc-wasi/libc_wasi.cmake)
-ENDIF ()
-
-INCLUDE (${IWASM_DIR}/common/iwasm_common.cmake)
-
-IF (WAMR_BUILD_INTERP EQUAL 1 OR WAMR_BUILD_JIT EQUAL 1)
-  INCLUDE (${IWASM_DIR}/interpreter/iwasm_interp.cmake)
-ENDIF ()
-
-ADD_LIBRARY (${IWASM_STATIC_NAME}
-             ${PLATFORM_SHARED_SOURCE}
-             ${PLATFORM_COMMON_LIBC_UTIL_SOURCE}
-             ${MEM_ALLOC_SHARED_SOURCE}
-             ${UTILS_SHARED_SOURCE}
-             ${LIBC_BUILTIN_SOURCE}
-             ${LIBC_WASI_SOURCE}
-             ${WAMR_POSIX_SOURCES}
-             ${IWASM_COMMON_SOURCE}
-             ${IWASM_INTERP_SOURCE}
-             ${IWASM_COMPL_SOURCE}
-             # this is necessary because WAMR currently does not have a definition
-             # for os_is_handle_valid in the sgx_platform.c file
-             ${CMAKE_CURRENT_SOURCE_DIR}/wamr_fixes.c
-           )
-
-TARGET_INCLUDE_DIRECTORIES(${IWASM_STATIC_NAME} PUBLIC ${SHARED_DIR}/include)
-TARGET_INCLUDE_DIRECTORIES(${IWASM_STATIC_NAME} PUBLIC ${IWASM_DIR}/include)
+SET(IWASM_STATIC_NAME iwasm)
+INCLUDE (${CMAKE_CURRENT_SOURCE_DIR}/wamr/wamr.cmake)
 
 #################################################################
 # Wawaka Interpreter
 #################################################################
+PROJECT(wawaka_wasm C CXX)
+
+SET(WAWAKA_STATIC_NAME wwasm)
+
+SET (SHARED_DIR ${WAMR_ROOT_DIR}/core/shared)
+SET (IWASM_DIR ${WAMR_ROOT_DIR}/core/iwasm)
+
 FILE(GLOB WWASM_PROJECT_HEADERS *.h)
-FILE(GLOB WWASM_PROJECT_SOURCES *.cpp)
+FILE(GLOB WWASM_PROJECT_SOURCES *.cpp wamr/*.c)
 
 ADD_LIBRARY(${WAWAKA_STATIC_NAME}
              ${WWASM_PROJECT_HEADERS}
@@ -158,32 +115,22 @@ SGX_PREPARE_TRUSTED(${WAWAKA_STATIC_NAME})
 # RUNTIME_MEM_POOL_SIZE: The WASM runtime's global memory pool size
 # HEAP_SIZE: Size of the runtime's heap for dynamic allocations by a WASM module.
 # STACK_SIZE: Size of the runtime's stack for executing a WASM module
-# Layout: RUNTIME_MEM_POOL_SIZE > HEAP_SIZE + STACK_SIZE + padding
-# The numbers below were chosen to set RUNTIME_MEM_POOL_SIZE to be about
-# 1/8 of the size of the enclave heap size defined in the SGX.cmake file.
-IF (NOT DEFINED PDO_MEMORY_CONFIG)
-  MESSAGE(FATAL_ERROR "PDO_MEMORY_CONFIG not defined")
-ENDIF()
+SET (WW_STACK_SIZE ${ENCLAVE_WORKER_STACK})
+SET (WW_HEAP_SIZE ${ENCLAVE_WORKER_HEAP})
 
-IF (${PDO_MEMORY_CONFIG} STREQUAL "SMALL")
-  MATH(EXPR WW_RUNTIME_MEM_POOL_SIZE "4 * 1024 * 1024")
-  MATH(EXPR WW_STACK_SIZE "512 * 1024")
-  MATH(EXPR WW_HEAP_SIZE "3 * 1024 * 1024")
-ELSEIF (${PDO_MEMORY_CONFIG} STREQUAL "MEDIUM")
-  MATH(EXPR WW_RUNTIME_MEM_POOL_SIZE "8 * 1024 * 1024")
-  MATH(EXPR WW_STACK_SIZE "512 * 1024")
-  MATH(EXPR WW_HEAP_SIZE "7 * 1024 * 1024")
-ELSEIF (${PDO_MEMORY_CONFIG} STREQUAL "LARGE")
-  MATH(EXPR WW_RUNTIME_MEM_POOL_SIZE "16 * 1024 * 1024")
-  MATH(EXPR WW_STACK_SIZE "512 * 1024")
-  MATH(EXPR WW_HEAP_SIZE "15 * 1024 * 1024")
-ELSE()
-  MESSAGE(FATAL_ERROR "Invalid memory size; ${PDO_MEMORY_CONFIG}")
+# MEM_POOL_SIZE determined from the stack and heap size plus padding, padding
+# factor is just a multiplier that can be adjusted to increase the padding
+MATH(EXPR WW_RUNTIME_MEM_POOL_SIZE "${WW_STACK_SIZE} + ${WW_HEAP_SIZE}")
+
+# Check that the runtime memory pool size is not larger than the enclave heap size
+IF (WW_RUNTIME_MEM_POOL_SIZE GREATER ENCLAVE_HEAP_SIZE)
+  MESSAGE(FATAL_ERROR "Invalid memory size; RUNTIME_MEM_POOL_SIZE too big for the enclave heap size")
 ENDIF()
 
-TARGET_COMPILE_DEFINITIONS(${WAWAKA_STATIC_NAME} PRIVATE RUNTIME_MEM_POOL_SIZE=${WW_RUNTIME_MEM_POOL_SIZE})
-TARGET_COMPILE_DEFINITIONS(${WAWAKA_STATIC_NAME} PRIVATE HEAP_SIZE=${WW_HEAP_SIZE})
-TARGET_COMPILE_DEFINITIONS(${WAWAKA_STATIC_NAME} PRIVATE STACK_SIZE=${WW_STACK_SIZE})
+TARGET_COMPILE_DEFINITIONS(${WAWAKA_STATIC_NAME} PRIVATE MAXIMUM_SIZE=${CONTRACT_MAXIMUM_SIZE})
+TARGET_COMPILE_DEFINITIONS(${WAWAKA_STATIC_NAME} PRIVATE GLOBAL_HEAP_SIZE=${CONTRACT_GLOBAL_HEAP_SIZE})
+TARGET_COMPILE_DEFINITIONS(${WAWAKA_STATIC_NAME} PRIVATE HEAP_SIZE=${CONTRACT_HEAP_SIZE})
+TARGET_COMPILE_DEFINITIONS(${WAWAKA_STATIC_NAME} PRIVATE STACK_SIZE=${CONTRACT_STACK_SIZE})
 
 TARGET_INCLUDE_DIRECTORIES(${WAWAKA_STATIC_NAME} PRIVATE ${INTERPRETER_INCLUDE_DIRS})
 TARGET_INCLUDE_DIRECTORIES(${WAWAKA_STATIC_NAME} PRIVATE ${IWASM_DIR}/include)

common/interpreter/wawaka_wasm/WasmExtensions.cpp

@@ -37,36 +37,6 @@
 
 namespace pe = pdo::error;
 
-/* ----------------------------------------------------------------- *
- * NAME: memchr
- * ----------------------------------------------------------------- */
-extern "C" int32 memchr_wrapper(
-    wasm_exec_env_t exec_env,
-    int32 src_offset,
-    int32 ch,
-    uint32 src_size)
-{
-    wasm_module_inst_t module_inst = wasm_runtime_get_module_inst(exec_env);
-    try {
-        if (src_size == 0)
-            return 0;
-
-        void *src = get_buffer(module_inst, src_offset, src_size);
-        if (src == NULL)
-            return 0;
-
-        void *ptr = memchr(src, ch, src_size);
-        if (ptr == NULL)
-            return 0;
-
-        return wasm_runtime_addr_native_to_app(module_inst, ptr);
-    }
-    catch (...) {
-        SAFE_LOG(PDO_LOG_ERROR, "unexpected failure in %s", __FUNCTION__);
-        return false;
-    }
-}
-
 /* ----------------------------------------------------------------- *
  * NAME: _contract_log_wrapper
  * ----------------------------------------------------------------- */
@@ -86,6 +56,17 @@ extern "C" bool contract_log_wrapper(
     }
 }
 
+/* ----------------------------------------------------------------- *
+ * NAME: _contract_abort_wrapper
+ * ----------------------------------------------------------------- */
+extern "C" void contract_abort_wrapper(
+    wasm_exec_env_t exec_env,
+    const char* buffer)
+{
+    wasm_module_inst_t module_inst = get_module_inst(exec_env);
+    wasm_runtime_set_exception(module_inst, buffer);
+}
+
 /* ----------------------------------------------------------------- *
  * NAME: simple_hash
  * ----------------------------------------------------------------- */
@@ -137,7 +118,8 @@ extern "C" double strtod_wrapper(
 
 extern "C" void abort_wrapper(wasm_exec_env_t exec_env)
 {
-    abort();
+    wasm_module_inst_t module_inst = get_module_inst(exec_env);
+    wasm_runtime_set_exception(module_inst, "env.abort()");
 }
 
 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -154,20 +136,13 @@ WASM_PASSTHRU_FUNCTION(islower)
 WASM_PASSTHRU_FUNCTION(ispunct)
 WASM_PASSTHRU_FUNCTION(isblank)
 
-#if 0
-WASM_PASSTHRU_FUNCTION(isascii)
-#endif
-
 static NativeSymbol native_symbols[] =
 {
     /* Missing libc functions */
     EXPORT_WASM_API_WITH_SIG2(iscntrl,"(i)i"),
     EXPORT_WASM_API_WITH_SIG2(islower,"(i)i"),
     EXPORT_WASM_API_WITH_SIG2(ispunct,"(i)i"),
     EXPORT_WASM_API_WITH_SIG2(isblank,"(i)i"),
-#if 0
-    EXPORT_WASM_API_WITH_SIG2(isascii,"(i)i"),
-#endif
     EXPORT_WASM_API_WITH_SIG2(abort,"()"),
 
     /* Crypto operations from WasmCryptoExtensions.h */
@@ -204,32 +179,24 @@ static NativeSymbol native_symbols[] =
     EXPORT_WASM_API_WITH_SIG2(key_value_open,"(*~*~)i"),
     EXPORT_WASM_API_WITH_SIG2(key_value_finalize,"(iii)i"),
 
-
     /* Utility functions */
     EXPORT_WASM_API_WITH_SIG2(contract_log, "(i$)i"),
+    EXPORT_WASM_API_WITH_SIG2(contract_abort, "($)"),
     EXPORT_WASM_API_WITH_SIG2(simple_hash, "(*~)i"),
-    EXPORT_WASM_API_WITH_SIG2(memchr, "(iii)i"),
     EXPORT_WASM_API_WITH_SIG2(strtod, "($*)F"),
 };
 
 #ifdef __cplusplus
 }
 #endif
 
-bool RegisterNativeFunctions(void)
+bool InitializeNativeSymbols(RuntimeInitArgs& init_args)
 {
-    try {
-        size_t native_symbols_count = sizeof(native_symbols)/sizeof(NativeSymbol);
-        if (! wasm_runtime_register_natives("env", native_symbols, native_symbols_count))
-        {
-            SAFE_LOG(PDO_LOG_ERROR, "failed to register native functions");
-            return false;
-        }
-    }
-    catch (...) {
-        SAFE_LOG(PDO_LOG_ERROR, "exception throw while registering native functions");
-        return false;
-    }
+    size_t native_symbols_count = sizeof(native_symbols)/sizeof(NativeSymbol);
+
+    init_args.native_module_name = "env";
+    init_args.n_native_symbols = native_symbols_count;
+    init_args.native_symbols = native_symbols;
 
     return true;
 }

common/interpreter/wawaka_wasm/WasmExtensions.h

@@ -232,12 +232,22 @@ bool contract_log(
     const uint32_t loglevel,
     const char *buffer);
 
+void contract_abort(
+    const char* buffer);
+
 int simple_hash(uint8_t *buffer, const size_t buflen);
 
 #ifdef __cplusplus
 }
 #endif
 
+#define CONTRACT_SAFE_ABORT(FMT, ...)           \
+    {                                           \
+        char buf[512];                          \
+        snprintf(buf, 512, FMT, ##__VA_ARGS__); \
+        contract_abort(buf);                    \
+    }
+
 #define CONTRACT_SAFE_LOG(LEVEL, FMT, ...) \
     {                                      \
         char buf[512];                          \