Skip to content

Refactor AOT loader to support compatible versions #3891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Refactor AOT loader to support compatible versions #3891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion core/iwasm/aot/aot_loader.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4235,6 +4235,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 @@ -4253,7 +4263,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
View file
Open in desktop
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
Loading