From be8ba9e1fd88998551a19198361756e73fe2add9 Mon Sep 17 00:00:00 2001 From: YAMAMOTO Takashi Date: Thu, 7 Jul 2022 11:06:31 +0900 Subject: [PATCH] wasm_export.h: mention module byte buffer mutability (#1271) --- core/iwasm/include/wasm_export.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/core/iwasm/include/wasm_export.h b/core/iwasm/include/wasm_export.h index ed7a865b8..2fc31319b 100644 --- a/core/iwasm/include/wasm_export.h +++ b/core/iwasm/include/wasm_export.h @@ -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