Merge pull request #2260 from pguyot/w14/jit-wasm

JIT: Add support for WASM32

These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).

SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later

Author: bettio

.github/workflows/wasm-build.yaml

@@ -103,11 +103,52 @@ jobs:
             src/platforms/emscripten/build/**/*.beam
         retention-days: 1
 
+  compile_tests_jit:
+
+    runs-on: ubuntu-24.04
+    container: erlang:28
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+
+    - name: Install required packages
+      run: apt update && apt install -y gperf zlib1g-dev cmake ninja-build
+
+    - name: Compile AtomVM and test modules with JIT for wasm32
+      run: |
+        set -e
+        mkdir build
+        cd build
+        cmake .. -G Ninja -DAVM_DISABLE_JIT=OFF -DAVM_JIT_TARGET_ARCH=wasm32 -DAVM_PRECOMPILED_TARGETS=wasm32
+        # test_eavmlib does not work with wasm due to http + ssl test
+        ninja atomvmlib-emscripten erlang_test_modules test_etest test_alisp test_estdlib hello_world test_jit
+
+    - name: Run JIT eunit tests
+      run: |
+        cd build
+        erl -pa tests/libs/jit/beams/ libs/jit/src/beams/ libs/etest/src/beams \
+            -noshell -s tests -s init stop
+
+    - name: Upload JIT test modules
+      uses: actions/upload-artifact@v4
+      with:
+        name: atomvm-and-test-modules-jit
+        path: |
+            build/**/*.avm
+            build/**/*.beam
+        retention-days: 1
+
   wasm_build_and_test_node:
-    needs: compile_tests
+    needs: [compile_tests, compile_tests_jit]
     runs-on: ubuntu-24.04
     container: emscripten/emsdk
 
+    strategy:
+      fail-fast: false
+      matrix:
+        jit: ["", "-DAVM_DISABLE_JIT=OFF"]
+
     steps:
     - name: Checkout repo
       uses: actions/checkout@v4
@@ -122,16 +163,25 @@ jobs:
         set -euo pipefail
         mkdir build
         cd build
-        emcmake cmake ..
+        emcmake cmake .. ${{ matrix.jit }}
         emmake make -j
 
-    - name: Download AtomVM and test modules
+    - name: Download AtomVM and test modules (non-JIT)
+      if: matrix.jit == ''
       uses: actions/download-artifact@v4
       with:
         name: atomvm-and-test-modules
         path: build
 
-    - name: Test
+    - name: Download AtomVM and test modules (JIT)
+      if: matrix.jit != ''
+      uses: actions/download-artifact@v4
+      with:
+        name: atomvm-and-test-modules-jit
+        path: build
+
+    - name: Test (non-JIT)
+      if: matrix.jit == ''
       shell: bash
       working-directory: ./src/platforms/emscripten/build
       run: |
@@ -146,8 +196,21 @@ jobs:
         node src/AtomVM.js ../../../../build/tests/libs/etest/test_etest.avm
         node src/AtomVM.js ../../../../build/tests/erlang_tests/test_crypto.beam
 
+    - name: Test (JIT)
+      if: matrix.jit != ''
+      shell: bash
+      working-directory: ./src/platforms/emscripten/build
+      run: |
+        set -euxo pipefail
+        # Test hello_world with JIT compiler (runtime JIT compilation)
+        node src/AtomVM.js ../../../../build/examples/erlang/hello_world.beam ../../../../build/libs/atomvmlib-emscripten-wasm32.avm
+        # Library tests with JIT compiler (jit-wasm32.avm included in test avms via pack_test)
+        node src/AtomVM.js ../../../../build/tests/libs/alisp/test_alisp.avm
+        node src/AtomVM.js ../../../../build/tests/libs/estdlib/test_estdlib.avm
+        node src/AtomVM.js ../../../../build/tests/libs/etest/test_etest.avm
+
     - name: "Rename and write sha256sum (node)"
-      if: startsWith(github.ref, 'refs/tags/')
+      if: startsWith(github.ref, 'refs/tags/') && matrix.jit == ''
       shell: bash
       working-directory: src/platforms/emscripten/build/src
       run: |
@@ -160,7 +223,7 @@ jobs:
 
     - name: "Release (node)"
       uses: softprops/action-gh-release@v1
-      if: startsWith(github.ref, 'refs/tags/')
+      if: startsWith(github.ref, 'refs/tags/') && matrix.jit == ''
       with:
         draft: true
         fail_on_unmatched_files: true
@@ -181,6 +244,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        jit: ["", "-DAVM_DISABLE_JIT=OFF"]
         language: ["javascript-typescript"]
 
     steps:
@@ -191,6 +255,7 @@ jobs:
       run: sudo apt update -y && sudo apt install -y cmake gperf
 
     - name: "Initialize CodeQL"
+      if: matrix.jit == ''
       uses: github/codeql-action/init@v3
       with:
         languages: ${{matrix.language}}
@@ -204,13 +269,15 @@ jobs:
         set -euo pipefail
         mkdir build
         cd build
-        emcmake cmake .. -DAVM_EMSCRIPTEN_ENV=web
+        emcmake cmake .. -DAVM_EMSCRIPTEN_ENV=web ${{ matrix.jit }}
         emmake make -j
 
     - name: "Perform CodeQL Analysis"
+      if: matrix.jit == ''
       uses: github/codeql-action/analyze@v3
 
     - name: Upload wasm build for web
+      if: matrix.jit == ''
       uses: actions/upload-artifact@v4
       with:
         name: atomvm-js-web

.gitignore

@@ -6,6 +6,7 @@
 *.avm
 *.beam
 *.o
+erl_crash.dump
 build/**
 xcode/**
 examples/**/build

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Added Erlang distribution over serial (uart)
+- Added WASM32 JIT backend for Emscripten platform
 
 ### Fixed
 - Stop using deprecated `term_from_int32` on STM32 platform

CMakeLists.txt

@@ -66,7 +66,17 @@ if (NOT AVM_DISABLE_JIT AND NOT DEFINED AVM_JIT_TARGET_ARCH)
     endif()
 endif()
 
-set(AVM_PRECOMPILED_TARGETS "x86_64;aarch64;arm32;armv6m;armv6m+float32;armv6m+thumb2;riscv32;riscv64" CACHE STRING "Targets to precompile code to if AVM_DISABLE_JIT is OFF or AVM_ENABLE_PRECOMPILED is ON")
+set(AVM_PRECOMPILED_TARGETS "x86_64;aarch64;arm32;armv6m;armv6m+float32;armv6m+thumb2;riscv32;riscv64;wasm32" CACHE STRING "Targets to precompile code to if AVM_DISABLE_JIT is OFF or AVM_ENABLE_PRECOMPILED is ON")
+
+# DWARF is not supported on wasm32
+if (NOT AVM_DISABLE_JIT_DWARF)
+    if (AVM_JIT_TARGET_ARCH STREQUAL "wasm32")
+        message(FATAL_ERROR "DWARF is not supported on wasm32")
+    endif()
+    if ("wasm32" IN_LIST AVM_PRECOMPILED_TARGETS)
+        list(REMOVE_ITEM AVM_PRECOMPILED_TARGETS "wasm32")
+    endif()
+endif()
 
 if((${CMAKE_SYSTEM_NAME} STREQUAL "Darwin") OR
    (${CMAKE_SYSTEM_NAME} STREQUAL "Linux") OR

doc/src/jit.md

@@ -25,6 +25,7 @@ The JIT compiler supports the following target architectures:
 * `armv6m+thumb2` — ARM Cortex-M3+ with Thumb-2 support, ARMv7-M or later (Raspberry Pi Pico 2, STM32 with Cortex-M3/M4/M7/M33)
 * `riscv32` — 32-bit RISC-V
 * `riscv64` — 64-bit RISC-V
+* `wasm32` — WebAssembly (Emscripten)
 
 ### Requirements
 

libs/jit/include/jit.hrl

@@ -30,6 +30,7 @@
 -define(JIT_ARCH_RISCV32, 4).
 -define(JIT_ARCH_RISCV64, 5).
 -define(JIT_ARCH_ARM32, 6).
+-define(JIT_ARCH_WASM32, 7).
 
 -define(JIT_VARIANT_PIC, 1).
 -define(JIT_VARIANT_FLOAT32, 2).

libs/jit/src/CMakeLists.txt

@@ -42,6 +42,8 @@ set(ERLANG_MODULES
     jit_riscv32_asm
     jit_riscv64
     jit_riscv64_asm
+    jit_wasm32
+    jit_wasm32_asm
     jit_x86_64
     jit_x86_64_asm
 )