Skip to content

Commit dd62b32

Browse files
wenyonghwenyongh
authored
Fix interp hw bound check issues (bytecodealliance#1322)
Fix build script to enable hw bound check for interpreter when AOT is disabled, so as to enable spec cases test for interp with hw bound check. And fix the issues found.
1 parent fd5030e commit dd62b32

File tree

5 files changed

+84
-43
lines changed

5 files changed

+84
-43
lines changed

‎build-scripts/config_common.cmake‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,10 +201,6 @@ endif ()
201201
if (WAMR_DISABLE_HW_BOUND_CHECK EQUAL 1)
202202
add_definitions (-DWASM_DISABLE_HW_BOUND_CHECK=1)
203203
message (" Hardware boundary check disabled")
204-
elseif (NOT WAMR_BUILD_AOT EQUAL 1)
205-
# Enable memory access boundary check with hardware trap
206-
# only when AOT/JIT is enabled
207-
add_definitions (-DWASM_DISABLE_HW_BOUND_CHECK=1)
208204
else ()
209205
add_definitions (-DWASM_DISABLE_HW_BOUND_CHECK=0)
210206
endif ()

‎core/iwasm/common/wasm_runtime_common.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ static void
189189
runtime_signal_destroy()
190190
{
191191
#ifdef BH_PLATFORM_WINDOWS
192-
RemoveVectoredExceptionHandler(aot_exception_handler);
192+
RemoveVectoredExceptionHandler(runtime_exception_handler);
193193
#endif
194194
os_thread_signal_destroy();
195195
}

‎core/iwasm/interpreter/wasm_interp_classic.c‎

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ typedef float64 CellType_F64;
2424

2525
#define BR_TABLE_TMP_BUF_LEN 32
2626

27-
#ifndef OS_ENABLE_HW_BOUND_CHECK
27+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
28+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0
2829
#define CHECK_MEMORY_OVERFLOW(bytes) \
2930
do { \
3031
uint64 offset1 = (uint64)offset + (uint64)addr; \
@@ -57,7 +58,8 @@ typedef float64 CellType_F64;
5758
do { \
5859
maddr = memory->memory_data + (uint32)(start); \
5960
} while (0)
60-
#endif
61+
#endif /* !defined(OS_ENABLE_HW_BOUND_CHECK) \
62+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 */
6163

6264
#define CHECK_ATOMIC_MEMORY_ACCESS() \
6365
do { \
@@ -1020,7 +1022,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
10201022
{
10211023
WASMMemoryInstance *memory = module->default_memory;
10221024
uint8 *global_data = module->global_data;
1023-
#ifndef OS_ENABLE_HW_BOUND_CHECK
1025+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
1026+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
1027+
|| WASM_ENABLE_BULK_MEMORY != 0
10241028
uint32 num_bytes_per_page = memory ? memory->num_bytes_per_page : 0;
10251029
uint32 linear_mem_size =
10261030
memory ? num_bytes_per_page * memory->cur_page_count : 0;
@@ -1887,8 +1891,8 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
18871891
frame_sp -= 2;
18881892
addr = POP_I32();
18891893
CHECK_MEMORY_OVERFLOW(8);
1890-
STORE_U32(maddr, frame_sp[1]);
1891-
STORE_U32(maddr + 4, frame_sp[2]);
1894+
PUT_I64_TO_ADDR((uint32 *)maddr,
1895+
GET_I64_FROM_ADDR(frame_sp + 1));
18921896
(void)flags;
18931897
HANDLE_OP_END();
18941898
}
@@ -1974,7 +1978,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
19741978
PUSH_I32(prev_page_count);
19751979
/* update memory instance ptr and memory size */
19761980
memory = module->default_memory;
1977-
#ifndef OS_ENABLE_HW_BOUND_CHECK
1981+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
1982+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
1983+
|| WASM_ENABLE_BULK_MEMORY != 0
19781984
linear_mem_size =
19791985
num_bytes_per_page * memory->cur_page_count;
19801986
#endif
@@ -3000,21 +3006,23 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
30003006
offset = (uint64)(uint32)POP_I32();
30013007
addr = (uint32)POP_I32();
30023008

3009+
#ifndef OS_ENABLE_HW_BOUND_CHECK
30033010
CHECK_BULK_MEMORY_OVERFLOW(addr, bytes, maddr);
3011+
#else
3012+
if ((uint64)(uint32)addr + bytes
3013+
> (uint64)linear_mem_size)
3014+
goto out_of_bounds;
3015+
maddr = memory->memory_data + (uint32)addr;
3016+
#endif
30043017

30053018
seg_len = (uint64)module->module->data_segments[segment]
30063019
->data_length;
30073020
data = module->module->data_segments[segment]->data;
3008-
#ifndef OS_ENABLE_HW_BOUND_CHECK
30093021
if (offset + bytes > seg_len)
30103022
goto out_of_bounds;
30113023

30123024
bh_memcpy_s(maddr, linear_mem_size - addr,
30133025
data + offset, (uint32)bytes);
3014-
#else
3015-
bh_memcpy_s(maddr, (uint32)bytes, data + offset,
3016-
(uint32)bytes);
3017-
#endif
30183026
break;
30193027
}
30203028
case WASM_OP_DATA_DROP:
@@ -3023,7 +3031,6 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
30233031

30243032
read_leb_uint32(frame_ip, frame_ip_end, segment);
30253033
module->module->data_segments[segment]->data_length = 0;
3026-
30273034
break;
30283035
}
30293036
case WASM_OP_MEMORY_COPY:
@@ -3037,15 +3044,21 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
30373044
src = POP_I32();
30383045
dst = POP_I32();
30393046

3047+
#ifndef OS_ENABLE_HW_BOUND_CHECK
30403048
CHECK_BULK_MEMORY_OVERFLOW(src, len, msrc);
30413049
CHECK_BULK_MEMORY_OVERFLOW(dst, len, mdst);
3050+
#else
3051+
if ((uint64)(uint32)src + len > (uint64)linear_mem_size)
3052+
goto out_of_bounds;
3053+
msrc = memory->memory_data + (uint32)src;
3054+
3055+
if ((uint64)(uint32)dst + len > (uint64)linear_mem_size)
3056+
goto out_of_bounds;
3057+
mdst = memory->memory_data + (uint32)dst;
3058+
#endif
30423059

30433060
/* allowing the destination and source to overlap */
3044-
#ifndef OS_ENABLE_HW_BOUND_CHECK
30453061
bh_memmove_s(mdst, linear_mem_size - dst, msrc, len);
3046-
#else
3047-
bh_memmove_s(mdst, len, msrc, len);
3048-
#endif
30493062
break;
30503063
}
30513064
case WASM_OP_MEMORY_FILL:
@@ -3058,10 +3071,15 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
30583071
fill_val = POP_I32();
30593072
dst = POP_I32();
30603073

3074+
#ifndef OS_ENABLE_HW_BOUND_CHECK
30613075
CHECK_BULK_MEMORY_OVERFLOW(dst, len, mdst);
3076+
#else
3077+
if ((uint64)(uint32)dst + len > (uint64)linear_mem_size)
3078+
goto out_of_bounds;
3079+
mdst = memory->memory_data + (uint32)dst;
3080+
#endif
30623081

30633082
memset(mdst, fill_val, len);
3064-
30653083
break;
30663084
}
30673085
#endif /* WASM_ENABLE_BULK_MEMORY */
@@ -3463,8 +3481,8 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
34633481
CHECK_BULK_MEMORY_OVERFLOW(addr + offset, 8, maddr);
34643482
CHECK_ATOMIC_MEMORY_ACCESS();
34653483
os_mutex_lock(&memory->mem_lock);
3466-
STORE_U32(maddr, frame_sp[1]);
3467-
STORE_U32(maddr + 4, frame_sp[2]);
3484+
PUT_I64_TO_ADDR((uint32 *)maddr,
3485+
GET_I64_FROM_ADDR(frame_sp + 1));
34683486
os_mutex_unlock(&memory->mem_lock);
34693487
}
34703488
break;
@@ -3706,7 +3724,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
37063724

37073725
/* update memory instance ptr and memory size */
37083726
memory = module->default_memory;
3709-
#ifndef OS_ENABLE_HW_BOUND_CHECK
3727+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
3728+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
3729+
|| WASM_ENABLE_BULK_MEMORY != 0
37103730
if (memory)
37113731
linear_mem_size = num_bytes_per_page * memory->cur_page_count;
37123732
#endif
@@ -3786,7 +3806,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
37863806
goto got_exception;
37873807
#endif
37883808

3789-
#ifndef OS_ENABLE_HW_BOUND_CHECK
3809+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
3810+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
3811+
|| WASM_ENABLE_BULK_MEMORY != 0
37903812
out_of_bounds:
37913813
wasm_set_exception(module, "out of bounds memory access");
37923814
#endif

‎core/iwasm/interpreter/wasm_interp_fast.c‎

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ typedef int64 CellType_I64;
1818
typedef float32 CellType_F32;
1919
typedef float64 CellType_F64;
2020

21-
#ifndef OS_ENABLE_HW_BOUND_CHECK
21+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
22+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0
2223
#define CHECK_MEMORY_OVERFLOW(bytes) \
2324
do { \
2425
uint64 offset1 = (uint64)offset + (uint64)addr; \
@@ -51,7 +52,8 @@ typedef float64 CellType_F64;
5152
do { \
5253
maddr = memory->memory_data + (uint32)(start); \
5354
} while (0)
54-
#endif /* end of OS_ENABLE_HW_BOUND_CHECK */
55+
#endif /* !defined(OS_ENABLE_HW_BOUND_CHECK) \
56+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 */
5557

5658
#define CHECK_ATOMIC_MEMORY_ACCESS(align) \
5759
do { \
@@ -1093,7 +1095,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
10931095
WASMInterpFrame *prev_frame)
10941096
{
10951097
WASMMemoryInstance *memory = module->default_memory;
1096-
#ifndef OS_ENABLE_HW_BOUND_CHECK
1098+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
1099+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
1100+
|| WASM_ENABLE_BULK_MEMORY != 0
10971101
uint32 num_bytes_per_page = memory ? memory->num_bytes_per_page : 0;
10981102
uint32 linear_mem_size =
10991103
memory ? num_bytes_per_page * memory->cur_page_count : 0;
@@ -1812,7 +1816,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
18121816
frame_lp[addr_ret] = prev_page_count;
18131817
/* update memory instance ptr and memory size */
18141818
memory = module->default_memory;
1815-
#ifndef OS_ENABLE_HW_BOUND_CHECK
1819+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
1820+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
1821+
|| WASM_ENABLE_BULK_MEMORY != 0
18161822
linear_mem_size =
18171823
num_bytes_per_page * memory->cur_page_count;
18181824
#endif
@@ -2919,21 +2925,23 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
29192925
offset = (uint64)POP_I32();
29202926
addr = POP_I32();
29212927

2928+
#ifndef OS_ENABLE_HW_BOUND_CHECK
29222929
CHECK_BULK_MEMORY_OVERFLOW(addr, bytes, maddr);
2930+
#else
2931+
if ((uint64)(uint32)addr + bytes
2932+
> (uint64)linear_mem_size)
2933+
goto out_of_bounds;
2934+
maddr = memory->memory_data + (uint32)addr;
2935+
#endif
29232936

29242937
seg_len = (uint64)module->module->data_segments[segment]
29252938
->data_length;
29262939
data = module->module->data_segments[segment]->data;
2927-
#ifndef OS_ENABLE_HW_BOUND_CHECK
29282940
if (offset + bytes > seg_len)
29292941
goto out_of_bounds;
29302942

29312943
bh_memcpy_s(maddr, linear_mem_size - addr,
29322944
data + offset, (uint32)bytes);
2933-
#else
2934-
bh_memcpy_s(maddr, (uint32)bytes, data + offset,
2935-
(uint32)bytes);
2936-
#endif
29372945
break;
29382946
}
29392947
case WASM_OP_DATA_DROP:
@@ -2943,7 +2951,6 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
29432951
segment = read_uint32(frame_ip);
29442952

29452953
module->module->data_segments[segment]->data_length = 0;
2946-
29472954
break;
29482955
}
29492956
case WASM_OP_MEMORY_COPY:
@@ -2955,15 +2962,21 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
29552962
src = POP_I32();
29562963
dst = POP_I32();
29572964

2965+
#ifndef OS_ENABLE_HW_BOUND_CHECK
29582966
CHECK_BULK_MEMORY_OVERFLOW(src, len, msrc);
29592967
CHECK_BULK_MEMORY_OVERFLOW(dst, len, mdst);
2968+
#else
2969+
if ((uint64)(uint32)src + len > (uint64)linear_mem_size)
2970+
goto out_of_bounds;
2971+
msrc = memory->memory_data + (uint32)src;
2972+
2973+
if ((uint64)(uint32)dst + len > (uint64)linear_mem_size)
2974+
goto out_of_bounds;
2975+
mdst = memory->memory_data + (uint32)dst;
2976+
#endif
29602977

29612978
/* allowing the destination and source to overlap */
2962-
#ifndef OS_ENABLE_HW_BOUND_CHECK
29632979
bh_memmove_s(mdst, linear_mem_size - dst, msrc, len);
2964-
#else
2965-
bh_memmove_s(mdst, len, msrc, len);
2966-
#endif
29672980
break;
29682981
}
29692982
case WASM_OP_MEMORY_FILL:
@@ -2975,10 +2988,15 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
29752988
fill_val = POP_I32();
29762989
dst = POP_I32();
29772990

2991+
#ifndef OS_ENABLE_HW_BOUND_CHECK
29782992
CHECK_BULK_MEMORY_OVERFLOW(dst, len, mdst);
2993+
#else
2994+
if ((uint64)(uint32)dst + len > (uint64)linear_mem_size)
2995+
goto out_of_bounds;
2996+
mdst = memory->memory_data + (uint32)dst;
2997+
#endif
29792998

29802999
memset(mdst, fill_val, len);
2981-
29823000
break;
29833001
}
29843002
#endif /* WASM_ENABLE_BULK_MEMORY */
@@ -3719,7 +3737,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
37193737

37203738
/* update memory instance ptr and memory size */
37213739
memory = module->default_memory;
3722-
#ifndef OS_ENABLE_HW_BOUND_CHECK
3740+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
3741+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
3742+
|| WASM_ENABLE_BULK_MEMORY != 0
37233743
if (memory)
37243744
linear_mem_size = num_bytes_per_page * memory->cur_page_count;
37253745
#endif
@@ -3788,7 +3808,9 @@ wasm_interp_call_func_bytecode(WASMModuleInstance *module,
37883808
goto got_exception;
37893809
#endif
37903810

3791-
#ifndef OS_ENABLE_HW_BOUND_CHECK
3811+
#if !defined(OS_ENABLE_HW_BOUND_CHECK) \
3812+
|| WASM_CPU_SUPPORTS_UNALIGNED_ADDR_ACCESS == 0 \
3813+
|| WASM_ENABLE_BULK_MEMORY != 0
37923814
out_of_bounds:
37933815
wasm_set_exception(module, "out of bounds memory access");
37943816
#endif

‎doc/memory_tune.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Note:
1111
- **global heap**: the heap to allocate memory for runtime data structures, including wasm module, wasm module instance, exec env, wasm operand stack and so on. It is initialized by `wasm_runtime_init` or `wasm_runtime_full_init`. And for `wasm_runtime_full_init`, developer can specify the memory allocation mode with `RuntimeInitArgs *init_args`: allocate memory from a user defined byte buffer, from user defined allocation function, or from the platform's os_malloc function. Refer to [wasm_export.h](../core/iwasm/include/wasm_export.h#L98-L141) and [Embedding WAMR guideline](./embed_wamr.md#the-runtime-initialization) for more details. And developer can use `wasm_runtime_malloc/wasm_runtime_free` to allocate/free memory from/to the global heap.
1212
- **wasm operand stack**: the stack to store the operands required by wasm bytecodes as WebAssembly is based on a stack machine. If the exec_env is created by developer with `wasm_runtime_create_exec_env`, then its size is specified by `wasm_runtime_create_exec_env`, otherwise if the exec_env is created by runtime internally, e.g. by `wasm_application_execute_main` or `wasm_application_execute_func`, then the size is specified by `wasm_runtime_instantiate`.
1313
- **linear memory**: a contiguous, mutable array of raw bytes. It is created with an initial size but might be grown dynamically. For most compilers, e.g. wasi-sdk, emsdk, rustc or asc, normally it includes three parts, data area, auxiliary stack area and heap area. For wasi-sdk, the initial/max size can be specified with `-Wl,--initial-memory=n1,--max-memory=n2`, for emsdk, the initial/max size can be specified with `-s INITIAL_MEMORY=n1 -s MAXIMUM_MEMORY=n2 -s ALLOW_MEMORY_GROWTH=1` or `-s TOTAL_MEMORY=n`, and for asc, they can be specified with `--initialMemory` and `--maximumMemory` flags.
14+
- If the memory access boundary check with hardware trap feature is enabled, e.g. in Linux/MacOS/Windows x86-64 by default, the linear memory is allocated by `os_mmap` from virtual address space instead of global heap.
1415
- **aux stack**: the auxiliary stack resides in linear memory to store some temporary data when calling wasm functions, for example, calling a wasm function with complex struct arguments. For wasi-sdk, the size can be specified with `-z stack-size=n`, for emsdk, the size can be specified with `-s TOTAL_STACK=n`.
1516
- **app heap and libc heap**: the heap to allocate memory for wasm app, note that app heap is created only when the malloc/free functions (or __new/__release functions for AssemblyScript) are not exported and runtime can not detect the libc heap. To export the malloc/free functions, for wasi-sdk and emsdk, developer can use `-Wl,--export=malloc -Wl,--export=free` options, for asc, developer can use `--exportRuntime` option. For app heap, the size is specified by `wasm_runtime_instantiate`. It is recommended to export the malloc/free functions and disable app heap in single thread mode, and for multi-threading, as the libc heap isn't thread-safe, it is recommended to remove the dlmalloc.o from libc.a for wasi-sdk and use `-s MALLOC="none"` for emsdk, refer to [WAMR pthread library](./pthread_library.md) for more details. And developer can use `wasm_runtime_module_malloc/wasm_runtime_module_free` to allocate/free memory from/to app heap (or libc heap if malloc/free functions are exported).
1617
- **__data_end global and __heap_base global**: two globals exported by wasm application to indicate the end of data area and the base address of libc heap. For WAMR, it is recommended to export them as when there are no possible memory grow operations, runtime will truncate the linear memory into the size indicated by `__heap_base`, so as to reduce the footprint, or at least one page (64KB) is required by linear memory.

0 commit comments

Comments
 (0)