Merge pull request #129 from TOPLLab/develop

Version 0.2.2

Author: tolauwae

.github/workflows/compile.yml

@@ -5,9 +5,6 @@ concurrency:
     group: ${{ github.workflow }}-${{ github.ref }}
     cancel-in-progress: true  # Cancel in-flight jobs for the same branch or PR
 
-env:
-    BENCHMARKS_CACHE: "build-benchmarks"
-
 jobs:
     formatting-check:
         name: Formatting Check
@@ -29,7 +26,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                os: [ubuntu-18.04, ubuntu-20.04, macos-latest]
+                os: [ubuntu-20.04, ubuntu-22.04, macos-latest]
         steps:
             - name: Checkout
               uses: actions/checkout@v2
@@ -45,7 +42,7 @@ jobs:
 
     compile-with-arduino:
         name: (Arduino) Compile on ${{matrix.board.platform-name}}
-        needs: formatting-check
+        needs: [formatting-check]
         runs-on: ubuntu-latest
         env:
             SKETCHES_REPORTS_PATH: sketches-reports
@@ -56,6 +53,7 @@ jobs:
                 - name: HTTPClient
                 - name: PubSubClient
                 - name: Adafruit NeoPixel
+                - source-url: https://github.com/me-no-dev/AsyncTCP.git
         strategy:
             fail-fast: false
             matrix:
@@ -72,7 +70,11 @@ jobs:
                       sketches: |
                         - platforms/Arduino
         steps:
-            - uses: actions/checkout@v2
+            - name: Checkout
+              uses: actions/checkout@v2
+              with:
+                  submodules: 'recursive'
+
             - name: Compile sketches
               uses: arduino/compile-sketches@v1
               with:
@@ -84,6 +86,7 @@ jobs:
                       ${{ env.LIBRARIES }}
                   enable-deltas-report: true
                   sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
+
             - name: Upload sketches report to workflow artifact
               uses: actions/upload-artifact@v2
               with:
@@ -107,9 +110,10 @@ jobs:
                   submodules: 'recursive'
 
             - name: Build WARDuino for ESP-IDF
-              uses: espressif/esp-idf-ci-action@main
+              uses: espressif/esp-idf-ci-action@v1
               with:
                   esp_idf_version: latest
                   target: esp32
+                  command: idf.py build -DBUILD_ESP=ON
                   path: .
 

.gitignore

@@ -1,5 +1,6 @@
 .idea/
 .vscode/
+.ccls
 
 *.bin
 *.ipch
@@ -28,3 +29,7 @@ _deps
 .AppleDouble
 .LSOverride
 
+*.old
+
+core
+venv

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "tests/sexpr-parser"]
 	path = tests/integration/sexpr-parser
 	url = [email protected]:benthepoet/c-sexpr-parser.git
+[submodule "lib/json"]
+	path = lib/json
+	url = https://github.com/nlohmann/json

CMakeLists.txt

@@ -3,8 +3,10 @@
 cmake_minimum_required(VERSION 3.15)
 option(BUILD_ESP "Build for esp" OFF)
 option(BUILD_EMULATOR "Build for emulator" OFF)
+option(BUILD_UNITTEST "Build for testing" OFF)
 
-if (NOT BUILD_ESP AND NOT BUILD_EMULATOR)
+
+if (NOT BUILD_ESP AND NOT BUILD_EMULATOR AND NOT BUILD_UNITTEST)
     message(WARNING "No build target set. Nothing to do.")
 endif ()
 
@@ -13,7 +15,7 @@ if (BUILD_ESP)
     if (NOT EXISTS $ENV{IDF_PATH}/tools/cmake/project.cmake)
         message(FATAL_ERROR "Can't find $IDF_PATH/tools/cmake/project.cmake. Make sure ESP-IDF is installed and $IDF_PATH is set.")
     endif ()
-    
+
     message(VERBOSE "Using ESP-IDF toolchain")
 
     set(EXTRA_COMPONENT_DIRS "platforms/ESP-IDF")
@@ -25,23 +27,29 @@ project(WARDuino)
 
 # Build the emulator version of WARDuino
 if (BUILD_EMULATOR)
+    set(EXTERNAL_LIB_HEADERS lib/json/single_include)
+
     find_package(Threads REQUIRED)
+
     set(SOURCE_FILES
+            src/WARDuino/WARDuino.cpp
+            src/WARDuino/CallbackHandler.cpp
+            src/Primitives/emulated.cpp
+            src/Interpreter/instructions.cpp
             src/Memory/mem.cpp
             src/Utils/util.cpp
             src/Utils/util_arduino.cpp
-            src/Debug/debugger.cpp
             src/Utils/macros.cpp
-            src/WARDuino/WARDuino.cpp
-            src/WARDuino/CallbackHandler.cpp
-            src/Primitives/primitives.cpp
-            src/Interpreter/instructions.cpp
-            )
+            src/Utils/sockets.cpp
+            src/Debug/debugger.cpp
+            src/Edward/proxy.cpp
+            src/Edward/proxy_supervisor.cpp
+            src/Edward/RFC.cpp)
+
     set(TEST_FRAMEWORK
-        tests/integration/wasm_tests.cpp
-        tests/integration/assertion.cpp
-        tests/integration/sexpr-parser/src/sexpr.c
-        )
+            tests/integration/wasm_tests.cpp
+            tests/integration/assertion.cpp
+            tests/integration/sexpr-parser/src/sexpr.c)
 
     add_definitions(-DINFO=0)
     add_definitions(-DDEBUG=0)
@@ -52,11 +60,71 @@ if (BUILD_EMULATOR)
     set(CMAKE_CXX_STANDARD 11)
 
     # Set default compile flags for GCC
-    if(CMAKE_COMPILER_IS_GNUCXX)
+    if (CMAKE_COMPILER_IS_GNUCXX)
         add_compile_options(-g -v -Wall -Wextra -Wunused)
-    endif(CMAKE_COMPILER_IS_GNUCXX)
+    endif (CMAKE_COMPILER_IS_GNUCXX)
 
     # WARDuino CLI
     add_executable(wdcli platforms/CLI-Emulator/main.cpp ${SOURCE_FILES} ${TEST_FRAMEWORK})
     target_link_libraries(wdcli PRIVATE Threads::Threads)
+    target_include_directories(wdcli PRIVATE ${EXTERNAL_LIB_HEADERS})
 endif (BUILD_EMULATOR)
+
+if(BUILD_UNITTEST)
+    enable_testing()
+
+    message(VERBOSE "Building for unit tests ")
+
+    set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # for tooling support
+    set(EXTERNAL_LIB_HEADERS lib/json/single_include)
+
+    set(SOURCE_FILES
+            src/WARDuino/WARDuino.cpp
+            src/WARDuino/CallbackHandler.cpp
+            src/Primitives/emulated.cpp
+            src/Interpreter/instructions.cpp
+            src/Memory/mem.cpp
+            src/Utils/util.cpp
+            src/Utils/util_arduino.cpp
+            src/Utils/macros.cpp
+            src/Utils/sockets.cpp
+            src/Debug/debugger.cpp
+            src/Edward/proxy.cpp
+            src/Edward/proxy_supervisor.cpp
+            src/Edward/RFC.cpp)
+
+    # Use C++11
+    set(CMAKE_CXX_STANDARD 11)
+
+    # Set default compile flags for GCC
+    if (CMAKE_COMPILER_IS_GNUCXX)
+        add_compile_options(-g -v -Wall -Wextra -Wunused)
+    endif (CMAKE_COMPILER_IS_GNUCXX)
+
+
+    include(FetchContent)
+    FetchContent_Declare(
+      googletest
+      GIT_REPOSITORY https://github.com/google/googletest.git
+      GIT_TAG release-1.12.1
+    )
+
+    # For Windows: Prevent overriding the parent project's compiler/linker settings
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    FetchContent_MakeAvailable(googletest)
+
+    set(PATH_TO_UNIT_TEST ${PROJECT_SOURCE_DIR}/tests/vm_unit_tests)
+
+    file(GLOB TEST_SRC_FILES ${PATH_TO_UNIT_TEST}/*.cpp)
+
+    message(DEBUG "Unit test source codes: " ${TEST_SRC_FILES})
+
+    foreach(TEST_FILE ${TEST_SRC_FILES})
+        get_filename_component(TEST_NAME ${TEST_FILE} NAME_WE)
+        message(DEBUG "Add executable for " ${TEST_FILE})
+        add_executable(${TEST_NAME} ${TEST_FILE} ${SOURCE_FILES})
+        target_link_libraries(${TEST_NAME} gtest_main)
+        target_include_directories(${TEST_NAME} PRIVATE ${EXTERNAL_LIB_HEADERS})
+        add_test(${TEST_NAME} ${TEST_NAME})
+    endforeach()
+endif(BUILD_UNITTEST)

README.md

@@ -6,10 +6,10 @@
   <a href="https://github.com/TOPLLab/WARDuino/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MPL_2.0-blue.svg"></a>
 </p>
 
-This project is released under the Mozilla Public License 2.0, and is being developed as part of an active research project at the University of Ghent's [TOPL](https://github.com/TOPLLab) lab.
+This project is released under the Mozilla Public License 2.0, and is being developed as part of an active research project at the University of Ghent's [TOPL Lab](https://github.com/TOPLLab).
 
 The WARDuino virtual machine is a WebAssembly runtime for microcontrollers, which runs both under the Arduino and ESP-IDF toolchains.
-The WARDuino project also includes a [VS Code extension](https://github.com/TOPLLab/WARDuino-VSCode) to use the remote debugging facilities offered by the virtual machine.
+The WARDuino project also includes a [VS Code extension](https://github.com/TOPLLab/WARDuino-VSCode) to use both the remote debugging and the out-of-place debugging facilities offered by the virtual machine.
 
 <p align="center">
   <a href="./README.md#build-and-development-instructions">Installation</a> | <a href="./examples/">Examples</a> | <a href="./README.md#webassembly-specification-tests">Run Specification tests</a> | <a href="./documentation/">Documentation</a>
@@ -22,7 +22,7 @@ Supported platforms: Linux (Ubuntu), macOS, ESP-IDF, Arduino
 The project uses CMake. Quick install looks like this:
 
 ```bash
-git clone [email protected]:TOPLLab/WARDuino.git
+git clone --recursive [email protected]:TOPLLab/WARDuino.git
 cd WARDuino
 mkdir build-emu
 cd build-emu
@@ -36,6 +36,8 @@ The WARDuino VM can be compiled with both the Arduino and ESP-IDF toolchains, an
 
 ### Build for ESP-IDF
 
+> warning: primitive support for IDF is under construction
+
 Before you can compile and flash with ESP-IDF, you must install and enable [the toolchain](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html).
 You also need to disable the watchdog timer:
 
@@ -62,22 +64,35 @@ Or simply run `idf.py flash`.
 ### Build for Arduino
 
 First, install the [arduino-cli](https://arduino.github.io/arduino-cli/0.21/installation/).
+You will also need python3 with the pyserial pacakge.
 
 Second, create the config file:
 
 ```bash
 arduino-cli config init
 ```
 
-If you need additional boards, such as the esp32 boards, you can add them in the generated config file. More information [here](https://arduino.github.io/arduino-cli/0.21/getting-started/).
+If you need additional boards, such as the esp32 boards, you can add them in the generated config file. More information on how to install the esp32 boards can be found <a href="./documentation/InstallArduinoESP32.md">here</a>.
+(_note: WARDuino requires at least version 2.0.2 of the esp32 board manager when using esp32 devices)_
 
 Thirdly, make sure you install the `PubSubClient` and `Adafruit NeoPixel` library. (used for MQTT and pixel primitives)
 
 ```bash
-arduino-cli lib install "PubSubClient"
-arduino-cli lib install "Adafruit NeoPixel"
+arduino-cli lib install "PubSubClient" # for MQTT
+arduino-cli lib install "Adafruit NeoPixel" # for some primitives
 ```
 
+To build for Arduino with WIFI support you need to also install the following third-party libraries.
+(Wou might need to set `enable_unsafe_install` to `true` in your arduino config ) <!-- Todo remove one day  ---!>
+
+```bash
+arduino-cli lib install FreeRTOS
+arduino-cli lib install --git-url https://github.com/me-no-dev/AsyncTCP.git
+```
+
+If you haven't done so already, clone (or symlink) this repository to `~/Arduino/libraries` to make WARDuino availible to Arduino.
+
+
 After this initial installation steps you can start using WARDuino with the Arduino toolchain.
 You can upload the example file as follows, starting from the project root:
 

benchmarks/.gitignore

@@ -3,3 +3,6 @@ bin/
 
 output
 *.csv
+
+*.json
+*.data

benchmarks/all_bench.sh

@@ -18,14 +18,18 @@ to_csv() {
   sed -i -n '0~2{N;s/\n/,/p}' $1
 }
 
-sleep 5
-./espruino_bench.sh $tmpdir/espruino
-to_csv $tmpdir/espruino
+#sleep 5
+#./espruino_bench.sh $tmpdir/espruino
+#to_csv $tmpdir/espruino
 
 sleep 5
 ./warduino_bench.sh $tmpdir/warduino
 to_csv $tmpdir/warduino
 
+sleep 5
+./edward_bench.sh $tmpdir/edward
+to_csv $tmpdir/edward
+
 sleep 5
 ./wasm3_bench.sh $tmpdir/wasm3
 to_csv $tmpdir/wasm3
@@ -38,6 +42,8 @@ echo "# Espruino"
 cat $tmpdir/espruino
 echo "# Warduino"
 cat $tmpdir/warduino
+echo "# Edward"
+cat $tmpdir/edward
 echo "# Wasm3"
 cat $tmpdir/wasm3
 echo "# Native"

benchmarks/benchmarks.cpp

@@ -2,7 +2,8 @@
 
 #include <iostream>
 
-#include "../debug.h"
+#include "../src/Debug/debugger.h"
+#include "../src/Utils/macros.h"
 #include "../src/WARDuino.h"
 #include "timer.h"
 
@@ -48,7 +49,7 @@ int run_benchmarks(size_t num_benchmarks, string benchmarks[],
     char path[MAX_PATH];
     unsigned char bytes[MAX_BYTE_CODE_SIZE];
     unsigned int bytes_length;
-    auto *w = new WARDuino();
+    auto *w = WARDuino::instance();
     size_t correct = 0;
     for (size_t i = 0; i < num_benchmarks; i++) {
         string name = benchmarks[i];