gnh1201/wasm-micro-runtime
1
0
Fork 0
mirror of https://github.com/bytecodealliance/wasm-micro-runtime.git synced 2025-05-11 20:21:11 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

wasm_export.h: mention module byte buffer mutability (#1271)

Browse Source
This commit is contained in:
YAMAMOTO Takashi 2022-07-07 11:06:31 +09:00 committed by GitHub
parent daeb7a4265
commit be8ba9e1fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
core/iwasm/include/wasm_export.h
View File

@ -301,6 +301,12 @@ wasm_runtime_find_module_registered(const char *module_name);
* WASM binary data when interpreter or JIT is enabled, or AOT binary data
* when AOT is enabled. If it is AOT binary data, it must be 4-byte aligned.
*
* Note: In case of AOT XIP modules, the runtime doesn't make modifications
* to the buffer. (Except the "Known issues" mentioned in doc/xip.md.)
* Otherwise, the runtime can make modifications to the buffer for its
* internal purposes. Thus, in general, it isn't safe to create multiple
* modules from a single buffer.
*
* @param buf the byte buffer which contains the WASM/AOT binary data,
* note that the byte buffer must be writable since runtime may
* change its content for footprint and performance purpose, and