Skip to content

Commit

Permalink
Refactor AOT loader to support compatible versions (bytecodealliance#…
Browse files Browse the repository at this point in the history
…3891)

This commit refactors the AOT loader in `aot_loader.c` to support compatible
versions of the AOT_CURRENT_VERSION constant. Previously, the loader only
accepted the exact AOT_CURRENT_VERSION value, but now it also accepts
version 3. This change ensures that the runtime can load modules AoT-compiled
with different versions of wamrc as long as they have compatible
AOT_CURRENT_VERSION values.

Related to bytecodealliance#3880.
  • Loading branch information
lum1n0us authored Nov 1, 2024
1 parent c7b2683 commit e352f0a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
12 changes: 11 additions & 1 deletion core/iwasm/aot/aot_loader.c
Original file line number Diff line number Diff line change
Expand Up @@ -4236,6 +4236,16 @@ create_sections(AOTModule *module, const uint8 *buf, uint32 size,
return false;
}

static bool
aot_compatible_version(uint32 version)
{
/*
* refer to "AoT-compiled module compatibility among WAMR versions" in
* ./doc/biuld_wasm_app.md
*/
return version == 4 || version == 3;
}

static bool
load(const uint8 *buf, uint32 size, AOTModule *module,
bool wasm_binary_freeable, bool no_resolve, char *error_buf,
Expand All @@ -4254,7 +4264,7 @@ load(const uint8 *buf, uint32 size, AOTModule *module,
}

read_uint32(p, p_end, version);
if (version != AOT_CURRENT_VERSION) {
if (!aot_compatible_version(version)) {
set_error_buf(error_buf, error_buf_size, "unknown binary version");
return false;
}
Expand Down
14 changes: 11 additions & 3 deletions doc/build_wasm_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,15 +377,23 @@ Examples: wamrc -o test.aot test.wasm
When making major ABI changes for AoT-compiled modules, we bump
`AOT_CURRENT_VERSION` constant in `core/config.h` header.
The runtime rejects to load a module AoT-compiled with wamrc with
a different `AOT_CURRENT_VERSION`.
a non-compatible`AOT_CURRENT_VERSION`.
We try our best to maintain our runtime ABI for AoT-compiled modules
compatible among WAMR versions with the same `AOT_CURRENT_VERSION`
compatible among WAMR versions with compatible `AOT_CURRENT_VERSION`
so that combinations of older wamrc and newer runtime usually work.
However, there might be minor incompatibilities time to time.
For productions, we recommend to use the exactly same version of
For productions, we recommend to use compatible versions of
wamrc and the runtime.
| WAMR version | AOT_CURRENT_VERSION | Compatible AOT version |
| ------------ | ------------------- | ---------------------- |
| 1.x | 3 | 3 |
| 2.0.0 | 3 | 3 |
| 2.1.x | 3 | 3 |
| 2.2.0 | 3 | 3 |
| next | 4 | 3,4 |
## AoT compilation with 3rd-party toolchains
`wamrc` uses LLVM to compile wasm bytecode to AoT file, this works for most of the architectures, but there may be circumstances where you want to use 3rd-party toolchains to take over some steps of the compilation pipeline, e.g.
Expand Down

0 comments on commit e352f0a

Please sign in to comment.