gnh1201/wasm-micro-runtime
1
0
Fork 0
mirror of https://github.com/bytecodealliance/wasm-micro-runtime.git synced 2025-05-12 12:41:25 +00:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

wasm_export.h: Add a few comments about heap and threads (#1147)

Browse Source
This commit is contained in:
YAMAMOTO Takashi 2022-05-06 19:30:48 +09:00 committed by GitHub
parent 03f2153270
commit 6fb402aeec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -637,6 +637,12 @@ wasm_runtime_get_custom_data(wasm_module_inst_t module_inst);
/** /**
* Allocate memory from the heap of WASM module instance * Allocate memory from the heap of WASM module instance
* *
* Note: wasm_runtime_module_malloc can call heap functions inside
* the module instance and thus cause a memory growth.
* This API needs to be used very carefully when you have a native
* pointers to the module instance memory obtained with
* wasm_runtime_addr_app_to_native or similar APIs.
*
* @param module_inst the WASM module instance which contains heap * @param module_inst the WASM module instance which contains heap
* @param size the size bytes to allocate * @param size the size bytes to allocate
* @param p_native_addr return native address of the allocated memory * @param p_native_addr return native address of the allocated memory
@ -699,6 +705,10 @@ wasm_runtime_validate_app_addr(wasm_module_inst_t module_inst,
* space or memory space. Moreover, it checks whether it is the offset of a * space or memory space. Moreover, it checks whether it is the offset of a
* string that is end with '\0'. * string that is end with '\0'.
* *
* Note: The validation result, especially the NUL termination check,
* is not reliable for a module instance with multiple threads because
* other threads can modify the heap behind us.
*
* @param module_inst the WASM module instance * @param module_inst the WASM module instance
* @param app_str_offset the app address of the string to validate, which is a * @param app_str_offset the app address of the string to validate, which is a
* relative address * relative address
@ -729,6 +739,10 @@ wasm_runtime_validate_native_addr(wasm_module_inst_t module_inst,
/** /**
* Convert app address(relative address) to native address(absolute address) * Convert app address(relative address) to native address(absolute address)
* *
* Note that native addresses to module instance memory can be invalidated
* on a memory growth. (Except shared memory, whose native addresses are
* stable.)
*
* @param module_inst the WASM module instance * @param module_inst the WASM module instance
* @param app_offset the app adress * @param app_offset the app adress
* *