Patch v0.2.3 (#142)

* Refactor: remove prefix in  when not debugging

* Fix: splitting of spec tests in run_spec_tests.py

Only first module was kept.
New script creates module and asserts files for all modules in a source
spec test file.

* Update ignore.txt

* Fix/upload (#139)

* Fix upload for modules without main

* Add INIT mode to disable dbg msg during loading of modules

* Only print Ack after successful module update

* simplify smart lamp example (#72)

* Simplify example code

* Fix: add missing build.sh script to examples

* Update WAT examples

* Fix: update boilerplate code in rust example

* Fix example compilation

---------

Co-authored-by: tolauwae <[email protected]>

* Update README.md (#141)

* Feat/invoke (#140)

* Add argument values to invoke function

* Add  option to cli

* Fix: module needs to be loaded to get parameters for invoked function

Removes the `--file` option
Fix wrong number of arguments check

* Fix: `--paused` option always false

* Fix: wrong magic number in spec tests

Adds `--test` option

* Add `interruptINVOKE`

Move readArgs code from Proxy to util.cpp

* Fix: IDF compilation error on print format

* Fix: out of range fidx in invoke message

* Fix: use LEB128 encoding in invoke debug message

* VM waits when no `main` function is found

* Fix: wrong program state during debug invoke

Invoke from debugger now dumps the stack at the end

* Fix: only first argument is copied to stack in `invoke`

* Fix: trailing comma in stack dump

* Fix: clang format

* Add reset interrupt

* Fix: off-by-one error in dump stack

Missing comma in JSON.

* Fix: splitting of spec tests in run_spec_tests.py

Only first module was kept.
New script creates module and asserts files for all modules in a source
spec test file.

* Fix: wrong arg types in invoke from main

* Fix: print floating points as hexstrings

* Fix: do not use LEB for floats

* Clang format

* Fix: print floats as strings

* Remove upload.h from version control

* Define VERSION in Cmake + bump to 0.2.3

---------

Co-authored-by: Robbert Gurdeep Singh <[email protected]>

Author: tolauwae

CMakeLists.txt

@@ -5,6 +5,9 @@ option(BUILD_ESP "Build for esp" OFF)
 option(BUILD_EMULATOR "Build for emulator" OFF)
 option(BUILD_UNITTEST "Build for testing" OFF)
 
+if (ESP_PLATFORM)
+    set(BUILD_ESP ON)
+endif()
 
 if (NOT BUILD_ESP AND NOT BUILD_EMULATOR AND NOT BUILD_UNITTEST)
     message(WARNING "No build target set. Nothing to do.")
@@ -20,10 +23,13 @@ if (BUILD_ESP)
 
     set(EXTRA_COMPONENT_DIRS "platforms/ESP-IDF")
 
-    include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+    include($ENV{IDF_PATH}/tools/cmake/project.cmake "${PROJECT_BINARY_DIR}/../include")
 endif (BUILD_ESP)
 
-project(WARDuino)
+project(WARDuino VERSION 0.2.3)
+
+set(WARDUINO_VERSION_STRING "${PROJECT_VERSION}")
+configure_file(src/config.h.in include/warduino/config.h)
 
 # Build the emulator version of WARDuino
 if (BUILD_EMULATOR)
@@ -67,7 +73,7 @@ if (BUILD_EMULATOR)
     # 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})
+    target_include_directories(wdcli PRIVATE ${EXTERNAL_LIB_HEADERS} "${PROJECT_BINARY_DIR}/include")
 endif (BUILD_EMULATOR)
 
 if(BUILD_UNITTEST)
@@ -124,7 +130,7 @@ if(BUILD_UNITTEST)
         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})
+        target_include_directories(${TEST_NAME} PRIVATE ${EXTERNAL_LIB_HEADERS} "${PROJECT_BINARY_DIR}/include")
         add_test(${TEST_NAME} ${TEST_NAME})
     endforeach()
 endif(BUILD_UNITTEST)

README.md

@@ -1,19 +1,38 @@
-<h1 align="center">WARDuino</h1>
+<div align="center">
+  <h1>WARDuino</h1>
 
-<p align="center">
-  <a href="https://github.com/TOPLLab/WARDuino/actions/workflows/compile.yml"><img src="https://github.com/TOPLLab/WARDuino/actions/workflows/compile.yml/badge.svg"></a>
-  <a href="https://github.com/TOPLLab/WARDuino/actions/workflows/test.yml"><img src="https://github.com/TOPLLab/WARDuino/actions/workflows/test.yml/badge.svg"></a>
-  <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>
+  <p>
+    <strong>Wasm virtual machine for ESP32 / Arduino</strong>
+  </p>
+
+  <p>
+    <a href="https://github.com/TOPLLab/WARDuino/actions/workflows/compile.yml"><img src="https://github.com/TOPLLab/WARDuino/actions/workflows/compile.yml/badge.svg"></a>
+    <a href="https://github.com/TOPLLab/WARDuino/actions/workflows/test.yml"><img src="https://github.com/TOPLLab/WARDuino/actions/workflows/test.yml/badge.svg"></a>
+    <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>
+
+  <h4>
+    <a href="./README.md#build-and-development-instructions">Installation</a>
+    <span> | </span>
+    <a href="./examples/">Examples</a>
+    <span> | </span>
+    <a href="./README.md#webassembly-specification-tests">Run Specification tests</a>
+    <span> | </span>
+    <a href="./documentation/">Documentation</a>
+  </h4>
+
+</div>
+
+## About
 
 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 both the remote debugging and the out-of-place debugging facilities offered by the virtual machine.
++ The WARDuino virtual machine is a WebAssembly runtime for microcontrollers, which runs both under the Arduino and ESP-IDF toolchains.
++ The WARDuino virtual machine features an extensive debugger with novel techniques such as out-of-place debugging.
++ The virtual machine allows developers to implement their own primitives in C++, which are callable from Wasm.
++ 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>
-</p>
+*Note: WARDuino is not 1.0, since this is an active research project. Expect possible bugs or performance issues.*
 
 ## Build and Development Instructions
 

examples/.gitignore

@@ -1,3 +1,5 @@
 sdkconfig
 *.wasm
 *.wasm.h
+
+!build.sh

examples/assemblyscript/main/CMakeLists.txt

@@ -2,15 +2,19 @@ set(SOURCE_FILES
         ../../../src/Memory/mem.cpp
         ../../../src/Utils/util.cpp
         ../../../src/Utils/util_arduino.cpp
+        ../../../src/Utils/sockets.cpp
         ../../../src/Debug/debugger.cpp
+        ../../../src/Edward/proxy.cpp
+        ../../../src/Edward/proxy_supervisor.cpp
+        ../../../src/Edward/RFC.cpp
         ../../../src/Utils/macros.cpp
         ../../../src/WARDuino/WARDuino.cpp
         ../../../src/Primitives/emulated.cpp
         ../../../src/Interpreter/instructions.cpp
         ../../../src/WARDuino/CallbackHandler.cpp
         )
 
-idf_component_register(SRCS "main.cpp" ${SOURCE_FILES} INCLUDE_DIRS "" REQUIRES driver)
+idf_component_register(SRCS "main.cpp" ${SOURCE_FILES} INCLUDE_DIRS ../../../lib/json/single_include/ REQUIRES driver)
 
 add_definitions(-DESP=1)
 

examples/assemblyscript/main/main.cpp

@@ -22,31 +22,28 @@ extern "C" {
 extern void app_main(void);
 }
 
-WARDuino wac;
 Module* m;
 
 void startDebuggerStd(void* pvParameter) {
     int valread;
     uint8_t buffer[1024] = {0};
-    wac.debugger->socket = fileno(stdout);
+    Channel* duplex = new Duplex(stdin, stdout);
+    WARDuino::instance()->debugger->channel = duplex;
     while (true) {
         taskYIELD();
         vTaskDelay(1000 / portTICK_PERIOD_MS);
 
-        while ((valread = read(fileno(stdin), buffer, 1024)) != -1) {
-            write(fileno(stdout), "got a message ... \n", 19);
-            wac.handleInterrupt(valread - 1, buffer);
-            write(fileno(stdout), buffer, valread);
-            fflush(stdout);
+        while ((valread = duplex->read(buffer, 1024)) != -1) {
+            WARDuino::instance()->handleInterrupt(valread, buffer);
         }
     }
 }
 
 void app_main(void) {
-    m = wac.load_module(src_wasm, src_wasm_len, {});
+    m = WARDuino::instance()->load_module(src_wasm, src_wasm_len, {});
     xTaskCreate(startDebuggerStd, "Debug Thread", 5000, NULL, 1, NULL);
     printf("START\n\n");
-    wac.run_module(m);
+    WARDuino::instance()->run_module(m);
     printf("END\n\n");
-    wac.unload_module(m);
+    WARDuino::instance()->unload_module(m);
 }

examples/assemblyscript/main/smartlamp.ts

@@ -51,7 +51,7 @@ export function main(): void {
     wd.mqtt_init("192.168.0.24", 1883);
     until_connected(
         () => { wd.mqtt_connect(CLIENT_ID); wd.mqtt_loop(); },
-        () => { return wd.mqtt_connected(); },
+        wd.mqtt_connected,
         () => { return true; });
 
     // Subscribe to MQTT topic and turn on LED
@@ -60,11 +60,11 @@ export function main(): void {
 
     // Subscribe to button interrupt
     wd.interrupt_on(BUTTON, wd.CHANGED, toggle_led);
-   
+
     while (true) {
         until_connected(
             () => { wd.mqtt_connect(CLIENT_ID); wd.mqtt_loop(); },
-            () => { return wd.mqtt_connected(); },
+            wd.mqtt_connected,
             () => { return true; });
 
         wd.sleep(5); // Sleep for 5 seconds

examples/rust/main/CMakeLists.txt

@@ -2,15 +2,19 @@ set(SOURCE_FILES
         ../../../src/Memory/mem.cpp
         ../../../src/Utils/util.cpp
         ../../../src/Utils/util_arduino.cpp
+        ../../../src/Utils/sockets.cpp
         ../../../src/Debug/debugger.cpp
+        ../../../src/Edward/proxy.cpp
+        ../../../src/Edward/proxy_supervisor.cpp
+        ../../../src/Edward/RFC.cpp
         ../../../src/Utils/macros.cpp
         ../../../src/WARDuino/WARDuino.cpp
         ../../../src/Primitives/emulated.cpp
         ../../../src/Interpreter/instructions.cpp
         ../../../src/WARDuino/CallbackHandler.cpp
         )
 
-idf_component_register(SRCS "main.cpp" ${SOURCE_FILES} INCLUDE_DIRS "" REQUIRES driver)
+idf_component_register(SRCS "main.cpp" ${SOURCE_FILES} INCLUDE_DIRS ../../../lib/json/single_include/ REQUIRES driver)
 
 add_definitions(-DESP=1)
 

examples/rust/main/main.cpp

@@ -22,31 +22,30 @@ extern "C" {
 extern void app_main(void);
 }
 
-WARDuino wac;
 Module* m;
 
 void startDebuggerStd(void* pvParameter) {
+    Channel* duplex = new Duplex(stdin, stdout);
+    WARDuino::instance()->debugger->setChannel(duplex);
+    duplex->open();
+
     int valread;
     uint8_t buffer[1024] = {0};
-    wac.debugger->socket = fileno(stdout);
     while (true) {
         taskYIELD();
         vTaskDelay(1000 / portTICK_PERIOD_MS);
 
-        while ((valread = read(fileno(stdin), buffer, 1024)) != -1) {
-            write(fileno(stdout), "got a message ... \n", 19);
-            wac.handleInterrupt(valread - 1, buffer);
-            write(fileno(stdout), buffer, valread);
-            fflush(stdout);
+        while ((valread = duplex->read(buffer, 1024)) != -1) {
+            WARDuino::instance()->handleInterrupt(valread - 1, buffer);
         }
     }
 }
 
 void app_main(void) {
-    m = wac.load_module(src_wasm, src_wasm_len, {});
+    m = WARDuino::instance()->load_module(src_wasm, src_wasm_len, {});
     xTaskCreate(startDebuggerStd, "Debug Thread", 5000, NULL, 1, NULL);
     printf("START\n\n");
-    wac.run_module(m);
+    WARDuino::instance()->run_module(m);
     printf("END\n\n");
-    wac.unload_module(m);
+    WARDuino::instance()->unload_module(m);
 }

examples/wat/CMakeLists.txt

@@ -1,5 +1,10 @@
 cmake_minimum_required(VERSION 3.5)
 
+if (NOT EXISTS $ENV{IDF_PATH}/tools/cmake/project.cmake)
+    message(FATAL_ERROR
+        "Cannot find global project.cmake file. Make sure ESP-IDF is installed.")
+endif ()
+
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(blink)
+project(wat)
 

examples/wat/README.md

@@ -1,6 +1,8 @@
-# Blink in WAT
+# Examples in Textual WebAssembly
 
-This example implements the traditional "blinking LED" example for microcontrollers in WebAssembly Text Format (WAT).
+The `main` folder contains example programs written in textual WebAssembly.
+
+## Compiling and Running the Examples
 
 To compile and flash to an ESP32 with the ESP-IDF toolchain simply run the build script:
 
@@ -10,3 +12,17 @@ bash ./build.sh blink
 
 The script takes the name of a wat file from the main folder as argument (without extension).
 
+## Blink example
+
+The `blink.wat` file implements the traditional "blinking LED" example for microcontrollers in WebAssembly Text Format (WAT).
+
+## Factorial example
+
+The `fac.wat` file implements the traditional wasm example. The program prints `5!` to the serial port in an infinite loop.
+
+This is also an interesting example to run with the commandline interface:
+
+```bash
+wdcli fac.wasm --invoke fac 10
+```
+