Revert weval removal commit

Author: andreiltd

.github/workflows/main.yml

@@ -102,6 +102,7 @@ jobs:
         build-type:
           - 'release'
           - 'debug'
+          - 'weval'
     steps:
       - uses: actions/checkout@v4
         with:
@@ -173,6 +174,7 @@ jobs:
         build-type:
           - 'release'
           - 'debug'
+          - 'weval'
     steps:
       - uses: actions/checkout@v4
 

.gitignore

@@ -10,6 +10,7 @@ examples/hello-world/guest/package-lock.json
 examples/hello-world/guest/hello.component.wasm
 /build-debug
 /build-release
+/build-release-weval
 .vscode
 /package-lock.json
 .idea

CMakeLists.txt

@@ -26,10 +26,14 @@ set(EMBEDDING_DEP "starling-raw.wasm")
 # Define output filenames based on build configuration
 set(OUTPUT_NAME_RELEASE "starlingmonkey_embedding.wasm")
 set(OUTPUT_NAME_DEBUG "starlingmonkey_embedding.debug.wasm")
+set(OUTPUT_NAME_WEVAL "starlingmonkey_embedding_weval.wasm")
 
 # Set the appropriate name based on current configuration
 if(CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
     set(OUTPUT_FILENAME ${OUTPUT_NAME_DEBUG})
+elseif(WEVAL)
+    set(OUTPUT_FILENAME ${OUTPUT_NAME_WEVAL})
+    set(EMBEDDING_DEP "starling-ics.wevalcache")
 else()
     set(OUTPUT_FILENAME ${OUTPUT_NAME_RELEASE})
 endif()

Makefile

@@ -15,6 +15,7 @@ STARLINGMONKEY_DEPS = $(STARLINGMONKEY_SRC)/cmake/* embedding/* $(STARLINGMONKEY
 all: release
 debug: lib/starlingmonkey_embedding.debug.wasm lib/spidermonkey-embedding-splicer.js
 release: lib/starlingmonkey_embedding.wasm lib/spidermonkey-embedding-splicer.js
+release-weval: lib/starlingmonkey_ics.wevalcache lib/spidermonkey-embedding-splicer.js
 
 lib/spidermonkey-embedding-splicer.js: target/wasm32-wasip1/release/splicer_component.wasm crates/spidermonkey-embedding-splicer/wit/spidermonkey-embedding-splicer.wit | obj lib
 	@$(JCO) new target/wasm32-wasip1/release/splicer_component.wasm -o obj/spidermonkey-embedding-splicer.wasm --wasi-reactor
@@ -27,6 +28,13 @@ lib/starlingmonkey_embedding.wasm: $(STARLINGMONKEY_DEPS) | lib
 	cmake -B build-release -DCMAKE_BUILD_TYPE=Release
 	make -j16 -C build-release starlingmonkey_embedding
 
+lib/starlingmonkey_embedding_weval.wasm: $(STARLINGMONKEY_DEPS) | lib
+	cmake -B build-release-weval -DCMAKE_BUILD_TYPE=Release -DUSE_WASM_OPT=OFF -DWEVAL=ON
+	make -j16 -C build-release-weval starlingmonkey_embedding
+
+lib/starlingmonkey_ics.wevalcache: lib/starlingmonkey_embedding_weval.wasm
+	@cp build-release-weval/starling-raw.wasm/starling-ics.wevalcache $@
+
 
 lib/starlingmonkey_embedding.debug.wasm: $(STARLINGMONKEY_DEPS) | lib
 	cmake -B build-debug -DCMAKE_BUILD_TYPE=RelWithDebInfo

README.md

@@ -51,7 +51,21 @@ Establishing this initial prototype as a singular flexible engine foundation tha
 
 ### Weval AOT Compilation
 
-Note: unfortunately Weval AOT Compilation is disabled for the time being, due to incompatibilities with newer versions of the LLVM toolchain used to compile StarlingMonkey. See [this](https://bytecodealliance.zulipchat.com/#narrow/channel/459697-StarlingMonkey/topic/Updating.20Gecko.20version/near/527089464) and the following messages for details.
+[Weval][weval] ahead-of-time (AOT) compilation can be enabled to improve runtime performance by pre-compiling JavaScript inline caches.
+
+To enable AOT compilation, set the `enableAot: true` option or use the `--aot` CLI flag.
+
+AOT compilation can also be configured with the following options:
+
+| Option                 | Type                                | Example         | Description                                                              |
+|------------------------|-------------------------------------|-----------------|--------------------------------------------------------------------------|
+| `aotMinStackSizeBytes` | `number | Number | bigint | BigInt` | `2_007_846_092` | The minimum stack size (via `RUST_MIN_STACK`) to set when running `weval` |
+
+[weval]: https://github.com/bytecodealliance/weval
+
+#### Custom `weval` binary for AOT
+
+To use a custom (pre-downloaded) [`weval`][weval] binary, set the `wevalBin` option to the path to your desired weval binary.
 
 ## Platform APIs
 
@@ -215,6 +229,18 @@ export function componentize(opts: {
    * Path to custom ComponentizeJS engine build to use
    */
   engine?: string;
+  /**
+   * Path to custom weval cache to use
+   */
+  aotCache?: string;
+  /**
+   * Enable AoT using weval
+   */
+  enableAot?: boolean;
+  /**
+   * Use a pre-existing path to the `weval` binary, if present
+   */
+  wevalBin?: string;
   /**
    * Use a pre-existing path to the `wizer` binary, if present
    */
@@ -240,7 +266,7 @@ export function componentize(opts: {
    */
   enableFeatures?: [];
   /**
-   * Pass environment variables to the spawned Wizer Process
+   * Pass environment variables to the spawned Wizer or Weval Process
    * If set to true, all host environment variables are passed
    * To pass only a subset, provide an object with the desired variables
    */
@@ -319,6 +345,14 @@ npm install
 npm run build
 ```
 
+Before being able to use `componentize-js` with AOT support (ex. via `npm link`, from `jco`), you'll need to run:
+
+```console
+npm run build:weval
+```
+
+This will produce `lib/starlingmonkey_embedding_weval.wasm` and `lib/starlingmonkey_ics.wevalcache`.
+
 To clean up a local installation (i.e. remove the installation of StarlingMonkey):
 
 ```console
@@ -333,6 +367,12 @@ To run all tests:
 npm run test
 ```
 
+To run tests with AOT (weval) enabled:
+
+```console
+npm run test:weval
+```
+
 ### Running a specific test
 
 To run a specific test suite, you can pass an argument to [`vitest`][vitest]:

examples/hello-world/guest/componentize.js

@@ -3,10 +3,14 @@ import { resolve } from 'node:path';
 
 import { componentize } from '@bytecodealliance/componentize-js';
 
+// AoT compilation makes use of weval (https://github.com/bytecodealliance/weval)
+const enableAot = process.env.ENABLE_AOT == '1';
+
 const jsSource = await readFile('hello.js', 'utf8');
 
 const { component } = await componentize(jsSource, {
   witPath: resolve('hello.wit'),
+  enableAot,
 });
 
 await writeFile('hello.component.wasm', component);