wasm-micro-runtime/doc
Wenyong Huang 0ee5ffce85
Refactor APIs and data structures as preliminary work for Memory64 (#3209)
# Change the data type representing linear memory address from u32 to u64

## APIs signature changes
- (Export)wasm_runtime_module_malloc
  - wasm_module_malloc
    - wasm_module_malloc_internal
  - aot_module_malloc
    - aot_module_malloc_internal
- wasm_runtime_module_realloc
  - wasm_module_realloc
    - wasm_module_realloc_internal
  - aot_module_realloc
    - aot_module_realloc_internal
- (Export)wasm_runtime_module_free
  - wasm_module_free
    - wasm_module_free_internal
  - aot_module_malloc
    - aot_module_free_internal
- (Export)wasm_runtime_module_dup_data
  - wasm_module_dup_data
  - aot_module_dup_data
- (Export)wasm_runtime_validate_app_addr
- (Export)wasm_runtime_validate_app_str_addr
- (Export)wasm_runtime_validate_native_addr
- (Export)wasm_runtime_addr_app_to_native
- (Export)wasm_runtime_addr_native_to_app
- (Export)wasm_runtime_get_app_addr_range
- aot_set_aux_stack
- aot_get_aux_stack
- wasm_set_aux_stack
- wasm_get_aux_stack
- aot_check_app_addr_and_convert, wasm_check_app_addr_and_convert
  and jit_check_app_addr_and_convert
- wasm_exec_env_set_aux_stack
- wasm_exec_env_get_aux_stack
- wasm_cluster_create_thread
- wasm_cluster_allocate_aux_stack
- wasm_cluster_free_aux_stack

## Data structure changes
- WASMModule and AOTModule
  - field aux_data_end, aux_heap_base and aux_stack_bottom
- WASMExecEnv
  - field aux_stack_boundary and aux_stack_bottom
- AOTCompData
  - field aux_data_end, aux_heap_base and aux_stack_bottom
- WASMMemoryInstance(AOTMemoryInstance)
  - field memory_data_size and change __padding to is_memory64
- WASMModuleInstMemConsumption
  - field total_size and memories_size
- WASMDebugExecutionMemory
  - field start_offset and current_pos
- WASMCluster
  - field stack_tops

## Components that are affected by the APIs and data structure changes
- libc-builtin
- libc-emcc
- libc-uvwasi
- libc-wasi
- Python and Go Language Embedding
- Interpreter Debug engine
- Multi-thread: lib-pthread, wasi-threads and thread manager
2024-03-12 11:38:50 +08:00
..
pics Update document and fix wasm_runtime_call_wasm_a issue (#1005) 2022-02-14 17:36:38 +08:00
build_wamr.md Add vprintf override for android and esp-idf (#3174) 2024-02-22 17:02:46 +08:00
build_wasm_app.md Fix download link for wasi-sdk (#3077) 2024-01-24 13:42:45 +08:00
devcontainer.md Dockerfile lint errors fix (#1493) 2022-09-22 13:06:11 +08:00
embed_wamr_spawn_api.md embed_wamr.md: Improvements about threads (#2420) 2023-08-04 09:28:30 +08:00
embed_wamr.md Refactor APIs and data structures as preliminary work for Memory64 (#3209) 2024-03-12 11:38:50 +08:00
export_native_api.md Refactor APIs and data structures as preliminary work for Memory64 (#3209) 2024-03-12 11:38:50 +08:00
linux_sgx.md linux-sgx: Implement SGX IPFS as POSIX backend for file interaction (#1489) 2022-09-28 13:09:58 +08:00
memory_tune.md doc/memory_tune.md: "remove malloc" hack is not relevant to wasi-threads (#2603) 2023-09-28 09:27:33 +08:00
memory_usage.md Always allocate linear memory using mmap (#3052) 2024-02-02 22:17:44 +08:00
multi_module.md Update outdated reference link in multi_module.md (#3092) 2024-01-26 16:55:27 +08:00
other_wasm_compilers.md Implement performance profiler and call stack dump, and update toolchain document (#501) 2021-01-18 13:23:10 +08:00
perf_tune.md perf_tune.md: Add refine the calling processes between host and wasm (#3065) 2024-01-23 12:20:28 +08:00
port_wamr.md Enable specifying out-of-source platform configuration cmake file (#1941) 2023-02-07 22:10:59 +08:00
pthread_impls.md Document the summary of two pthread implementations (#2104) 2023-04-04 17:22:54 +08:00
pthread_library.md Document the summary of two pthread implementations (#2104) 2023-04-04 17:22:54 +08:00
ref_types.md Refactor externref related APIs of reference types feature (#971) 2022-01-19 11:25:08 +08:00
release_ack.md Enable multi-module support for wasm-c-api (#426) 2020-10-16 17:43:57 +08:00
roadmap.md Enable multi-module support for wasm-c-api (#426) 2020-10-16 17:43:57 +08:00
semantic_version.md Enable the semantic version mechanism for WAMR (#1374) 2022-08-18 19:01:05 +08:00
socket_api.md Fix typos of CIDR in docs and help text (#2851) 2023-12-04 11:38:54 +08:00
source_debugging_aot.md doc: Separate source_debugging.md into two files (#2932) 2023-12-27 15:51:51 +08:00
source_debugging_interpreter.md doc: Separate source_debugging.md into two files (#2932) 2023-12-27 15:51:51 +08:00
source_debugging.md doc: Separate source_debugging.md into two files (#2932) 2023-12-27 15:51:51 +08:00
wasm_c_api.md doc/wasm_c_api.md: Mention relationship with wasm_export.h (#1159) 2022-05-09 16:39:49 +08:00
xip.md Add "--enable-builtin-intrinsics=<flags>" option to wamrc (#2341) 2023-07-06 18:20:35 +08:00