Add standalone cases (#3536)
This commit is contained in:
Zhang, Yi
@ -0,0 +1,61 @@
|
||||
# Copyright (C) 2019 Intel Corporation. All rights reserved.
|
||||
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
|
||||
cmake_minimum_required(VERSION 3.14)
|
||||
project(wasm-apps)
|
||||
|
||||
set(WAMR_ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../../../../wamr)
|
||||
|
||||
if (APPLE)
|
||||
set (HAVE_FLAG_SEARCH_PATHS_FIRST 0)
|
||||
set (CMAKE_C_LINK_FLAGS "")
|
||||
set (CMAKE_CXX_LINK_FLAGS "")
|
||||
endif ()
|
||||
# have to be debug for peterson lock algorithm
|
||||
set(CMAKE_BUILD_TYPE Debug)
|
||||
set(CMAKE_SYSTEM_PROCESSOR wasm32)
|
||||
set (CMAKE_SYSROOT ${WAMR_ROOT_DIR}/wamr-sdk/app/libc-builtin-sysroot)
|
||||
|
||||
if (NOT DEFINED WASI_SDK_DIR)
|
||||
set (WASI_SDK_DIR "/opt/wasi-sdk")
|
||||
endif ()
|
||||
|
||||
set (CMAKE_C_FLAGS "-nostdlib -pthread -Qunused-arguments")
|
||||
set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -z stack-size=32768")
|
||||
set (CMAKE_C_COMPILER_TARGET "wasm32")
|
||||
set (CMAKE_C_COMPILER "${WASI_SDK_DIR}/bin/clang")
|
||||
|
||||
set (DEFINED_SYMBOLS
|
||||
"${WAMR_ROOT_DIR}/wamr-sdk/app/libc-builtin-sysroot/share/defined-symbols.txt")
|
||||
|
||||
set (CMAKE_EXE_LINKER_FLAGS
|
||||
"-Wl,--shared-memory,--max-memory=131072, \
|
||||
-Wl,--no-entry,--strip-all, \
|
||||
-Wl,--export=__heap_base,--export=__data_end \
|
||||
-Wl,--export=__wasm_call_ctors \
|
||||
-Wl,--export=main -Wl,--export=__main_argc_argv \
|
||||
-Wl,--allow-undefined"
|
||||
#-Wl,--allow-undefined-file=${DEFINED_SYMBOLS}"
|
||||
)
|
||||
|
||||
add_executable(atomic_add_sub.wasm atomic_add_sub.c)
|
||||
target_link_libraries(atomic_add_sub.wasm)
|
||||
|
||||
# use peterson lock to test the atomicity of opcode: fence store xchg
|
||||
add_executable(peterson_native.wasm peterson_native.c)
|
||||
target_link_libraries(peterson_native.wasm)
|
||||
|
||||
add_executable(atomic_fence.wasm atomic_fence.c)
|
||||
target_link_libraries(atomic_fence.wasm)
|
||||
|
||||
add_executable(atomic_store.wasm atomic_store.c)
|
||||
target_link_libraries(atomic_store.wasm)
|
||||
|
||||
add_executable(atomic_xchg.wasm atomic_xchg.c)
|
||||
target_link_libraries(atomic_xchg.wasm)
|
||||
|
||||
add_executable(atomic_logical.wasm atomic_logical.c)
|
||||
target_link_libraries(atomic_logical.wasm)
|
||||
|
||||
add_executable(atomic_wait_notify.wasm atomic_wait_notify.c)
|
||||
target_link_libraries(atomic_wait_notify.wasm)
|
||||
@ -0,0 +1,73 @@
|
||||
# "Unit Test" Testsuite for Threads Opcode
|
||||
|
||||
These tests are meant to **test the atomicity** of threads code. Initially, they were meant to test if the fast JIT implementation is correct, but they can also be used to test other running modes. The semantics correctness (operating with the correct number of bytes in memory and returning the correct value) have already been tested in spec tests (single-thread environment).
|
||||
|
||||
## Test Cases Opcode Coverage
|
||||
|
||||
> **Atomicity** of **all** threads opcodes are **fully tested** with these cases.
|
||||
>
|
||||
> **☑ Only indicates** there is a WASM test case to **test the atomicity directly.** The atomicity of other opcodes **without ☑** is **tested indirectly.** Indirect testing means that it is either implicit with other cases in this directory or tested pragmatically correct (atomicity and semantic correctness together) in pthread or WASI-threads test cases.
|
||||
|
||||
Click the link to see the details of how each opcode is tested.
|
||||
|
||||
- RMW (Read-Modify-Write):
|
||||
- [CMPXCHG opcode](#cmpxchg) ☑
|
||||
- Arithmetic:
|
||||
- [ADD opcode](#arithmetic-add-sub-and-xchg) ☑
|
||||
- [SUB opcode](#arithmetic-add-sub-and-xchg) ☑
|
||||
- [XCHG opcode](#arithmetic-add-sub-and-xchg) ☑
|
||||
- Logical:
|
||||
- [AND opcode](#logical-or-xor-and)
|
||||
- [OR opcode](#logical-or-xor-and)
|
||||
- [XOR opcode](#logical-or-xor-and) ☑
|
||||
|
||||
- [LOAD](#atomic-ldstfence)
|
||||
|
||||
- [STORE](#atomic-ldstfence) ☑
|
||||
|
||||
- [FENCE](#atomic-ldstfence) ☑
|
||||
|
||||
- [WAIT & NOTIFY](#atomic-waitnotify) ☑
|
||||
|
||||
## Details
|
||||
|
||||
### atomic rmw
|
||||
|
||||
#### arithmetic (`add`, `sub`) and xchg
|
||||
|
||||
- `add, sub`: in [atomic_add_sub.c](./atomic_add_sub.c), **__atomic_fetch_add/sub()** to generate wasm opcode atomic.add/sub
|
||||
|
||||
- `xchg`: in x86-64 implementation, wasm code atomic `store` and `xchg` generate same asm instruction xchg, should be enough to only test with store(tested in [atomic_store.c](./atomic_store.c)). But add a `atomic_xchg.c` to use **__atomic_exchange()** to generate wasm opcode xchg and test it anyways(tested in [atomic_xchg.c](./atomic_xchg.c)).
|
||||
|
||||
#### logical `or`, `xor`, `and`
|
||||
|
||||
- logical `or`, `xor`, `and`: those three opcodes are similar, it all generate a loop, inside which uses corresponding asm instruction do logical operation and locked cmpxchg to atomically modify the memory. So in a sense, test it will implicitly test the atomicity of cmpxchg.
|
||||
|
||||
in [atomic_logical.c](./atomic_logical.c), tested `xor` wasm opcode to test the atomicity of the generated loop:
|
||||
|
||||
- make use of operation "n `xor` n -> 0", when n range from 1 to 9999, 4 thread concurrently xor the same variable, the final result should be 0.
|
||||
|
||||
The generated loop of `xor` is atomic -> generated loop of `or`, `and` is also atomic
|
||||
|
||||
#### cmpxchg
|
||||
|
||||
- wasm opcode `cmpxchg` already tested together with other opcodes in multiple wasi-thread cases. Logical opcodes generate asm instruction lock cmpxchg, the atomicity of generated asm code is proven in logical opcode. In [atomic_wait&¬ify.c](./atomic_wait_notify.c), it also tests the opcode `cmpxchg`
|
||||
|
||||
### atomic ld/st/fence
|
||||
|
||||
use peterson lock algorithm, in [atomic_fence.c](./atomic_fence.c) to test the atomicity of `fence`
|
||||
|
||||
> PS: since the interpreter is relatively slow compared to JIT/AOT mode, it's less likely(almost impossible) to trigger processor-level behavior: instructions to be ordered within a single thread
|
||||
|
||||
The prerequisite for peterson lock properly is that load and store have to be `Sequential Consistency`, which can be achieved use:
|
||||
|
||||
1. LOAD (without fence) and STORE + MFENCE -> use it to test `fence` opcode
|
||||
2. LOAD (without fence) and LOCK XCHG -> use it to test atomic `store` opcode
|
||||
3. MFENCE + LOAD and STORE (without fence)
|
||||
4. LOCK XADD ( 0 ) and STORE (without fence)
|
||||
|
||||
### atomic wait¬ify
|
||||
|
||||
Actually in every pthread tests, it will generate `wait` and `notify`, it is also tested in in multiple wasi-thread cases.
|
||||
|
||||
But add a [atomic_wait&¬ify.c](./atomic_wait_notify.c) to test it anyways.
|
||||
@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Amazon.com Inc. or its affiliates. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <pthread.h>
|
||||
|
||||
#define MAX_NUM_THREADS 4
|
||||
#define NUM_ITER 100000
|
||||
|
||||
int g_add_count = 0;
|
||||
int g_sub_count = 0;
|
||||
|
||||
static void *
|
||||
thread(void *arg)
|
||||
{
|
||||
for (int i = 0; i < NUM_ITER; i++) {
|
||||
__atomic_fetch_add(&g_add_count, 1, __ATOMIC_SEQ_CST);
|
||||
__atomic_fetch_sub(&g_sub_count, 1, __ATOMIC_SEQ_CST);
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int
|
||||
main(int argc, char **argv)
|
||||
{
|
||||
pthread_t tids[MAX_NUM_THREADS];
|
||||
|
||||
for (int i = 0; i < MAX_NUM_THREADS; i++) {
|
||||
if (pthread_create(&tids[i], NULL, thread, NULL) != 0) {
|
||||
printf("Thread creation failed\n");
|
||||
}
|
||||
}
|
||||
|
||||
for (int i = 0; i < MAX_NUM_THREADS; i++) {
|
||||
if (pthread_join(tids[i], NULL) != 0) {
|
||||
printf("Thread join failed\n");
|
||||
}
|
||||
}
|
||||
|
||||
printf("Value of counter after add update: %d (expected=%d)\n", g_add_count,
|
||||
MAX_NUM_THREADS * NUM_ITER);
|
||||
if (g_add_count != MAX_NUM_THREADS * NUM_ITER) {
|
||||
__builtin_trap();
|
||||
}
|
||||
|
||||
printf("Value of counter after sub update: %d (expected=%d)\n", g_sub_count,
|
||||
-(MAX_NUM_THREADS * NUM_ITER));
|
||||
if (g_sub_count != -(MAX_NUM_THREADS * NUM_ITER)) {
|
||||
__builtin_trap();
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
@ -0,0 +1,35 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Intel Corporation. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
#include "peterson.h"
|
||||
|
||||
void
|
||||
peterson_lock_acquire(peterson_lock_t *lock, int thread_id)
|
||||
{
|
||||
// this threads wants to enter the cs
|
||||
lock->flag[thread_id] = true;
|
||||
|
||||
// assume the other thread has priority
|
||||
int other_thread = 1 - thread_id;
|
||||
|
||||
lock->turn = other_thread;
|
||||
|
||||
// generate fence in wasm
|
||||
__atomic_thread_fence(__ATOMIC_SEQ_CST);
|
||||
|
||||
while (lock->turn == other_thread && lock->flag[other_thread]) {
|
||||
// Busy wait
|
||||
}
|
||||
}
|
||||
|
||||
int
|
||||
main()
|
||||
{
|
||||
pthread_t thread1, thread2;
|
||||
|
||||
printf("============ test peterson lock using atomic fence ============\n");
|
||||
run_test(&thread1, &thread2, test_peterson_lock_atomicity);
|
||||
|
||||
return 0;
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Intel Corporation. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
#include <stdio.h>
|
||||
#include <pthread.h>
|
||||
|
||||
// x XOR x -> 0
|
||||
// even num of thread -> g_val should end up with its original value
|
||||
#define MAX_NUM_THREADS 4
|
||||
#define NUM_ITER 199999
|
||||
|
||||
int g_val = 5050;
|
||||
|
||||
static void *
|
||||
thread(void *arg)
|
||||
{
|
||||
for (int i = 0; i < NUM_ITER; i++) {
|
||||
__atomic_fetch_xor(&g_val, i, __ATOMIC_SEQ_CST);
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int
|
||||
main(int argc, char **argv)
|
||||
{
|
||||
|
||||
pthread_t tids[MAX_NUM_THREADS];
|
||||
|
||||
for (int i = 0; i < MAX_NUM_THREADS; i++) {
|
||||
if (pthread_create(&tids[i], NULL, thread, NULL) != 0) {
|
||||
printf("Thread creation failed\n");
|
||||
}
|
||||
}
|
||||
|
||||
for (int i = 0; i < MAX_NUM_THREADS; i++) {
|
||||
if (pthread_join(tids[i], NULL) != 0) {
|
||||
printf("Thread join failed\n");
|
||||
}
|
||||
}
|
||||
|
||||
printf("Global value after update: %d (expected=%d)\n", g_val, 5050);
|
||||
if (g_val != 5050) {
|
||||
__builtin_trap();
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Intel Corporation. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
#include "peterson.h"
|
||||
|
||||
void
|
||||
peterson_lock_acquire(peterson_lock_t *lock, int thread_id)
|
||||
{
|
||||
// this threads wants to enter the cs
|
||||
__atomic_store(&lock->flag[thread_id], &(bool){ true }, __ATOMIC_SEQ_CST);
|
||||
|
||||
// assume the other thread has priority
|
||||
int other_thread = 1 - thread_id;
|
||||
|
||||
__atomic_store(&lock->turn, &other_thread, __ATOMIC_SEQ_CST);
|
||||
|
||||
while (lock->turn == other_thread && lock->flag[other_thread]) {
|
||||
// Busy wait
|
||||
}
|
||||
}
|
||||
|
||||
int
|
||||
main()
|
||||
{
|
||||
pthread_t thread1, thread2;
|
||||
|
||||
printf("============ test peterson lock using atomic store ============\n");
|
||||
run_test(&thread1, &thread2, test_peterson_lock_atomicity);
|
||||
|
||||
return 0;
|
||||
}
|
||||
@ -0,0 +1,75 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Intel Corporation. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
#include <stdio.h>
|
||||
#include <pthread.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#define MAX_NUM_THREADS 4
|
||||
#define NUM_ITER 100000
|
||||
|
||||
int g_val;
|
||||
int my_mutex;
|
||||
|
||||
int
|
||||
try_lock()
|
||||
{
|
||||
return __atomic_compare_exchange(&my_mutex, &(int){ 0 }, &(int){ 1 }, false,
|
||||
__ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST);
|
||||
}
|
||||
|
||||
void
|
||||
lock_acquire()
|
||||
{
|
||||
while (!try_lock()) {
|
||||
// expected value (1 => locked)
|
||||
__builtin_wasm_memory_atomic_wait32(&my_mutex, 1, -1);
|
||||
}
|
||||
}
|
||||
void
|
||||
lock_release()
|
||||
{
|
||||
// unlock the mutex
|
||||
__atomic_store(&my_mutex, &(int){ 0 }, __ATOMIC_SEQ_CST);
|
||||
// notify 1 waiter
|
||||
__builtin_wasm_memory_atomic_notify(&my_mutex, 1);
|
||||
}
|
||||
|
||||
static void *
|
||||
thread(void *arg)
|
||||
{
|
||||
for (int i = 0; i < NUM_ITER; i++) {
|
||||
lock_acquire();
|
||||
g_val++;
|
||||
lock_release();
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int
|
||||
main()
|
||||
{
|
||||
pthread_t tids[MAX_NUM_THREADS];
|
||||
|
||||
for (int i = 0; i < MAX_NUM_THREADS; i++) {
|
||||
if (pthread_create(&tids[i], NULL, thread, NULL) != 0) {
|
||||
printf("Thread creation failed\n");
|
||||
}
|
||||
}
|
||||
|
||||
for (int i = 0; i < MAX_NUM_THREADS; i++) {
|
||||
if (pthread_join(tids[i], NULL) != 0) {
|
||||
printf("Thread join failed\n");
|
||||
}
|
||||
}
|
||||
|
||||
printf("Value of counter after add update: %d (expected=%d)\n", g_val,
|
||||
MAX_NUM_THREADS * NUM_ITER);
|
||||
if (g_val != MAX_NUM_THREADS * NUM_ITER) {
|
||||
__builtin_trap();
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
@ -0,0 +1,35 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Intel Corporation. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
#include "peterson.h"
|
||||
|
||||
void
|
||||
peterson_lock_acquire(peterson_lock_t *lock, int thread_id)
|
||||
{
|
||||
bool xchg_ret1;
|
||||
int xchg_ret2;
|
||||
// this threads wants to enter the cs
|
||||
__atomic_exchange(&lock->flag[thread_id], &(bool){ true }, &xchg_ret1,
|
||||
__ATOMIC_SEQ_CST);
|
||||
|
||||
// assume the other thread has priority
|
||||
int other_thread = 1 - thread_id;
|
||||
|
||||
__atomic_exchange(&lock->turn, &other_thread, &xchg_ret2, __ATOMIC_SEQ_CST);
|
||||
|
||||
while (lock->turn == other_thread && lock->flag[other_thread]) {
|
||||
// Busy wait
|
||||
}
|
||||
}
|
||||
|
||||
int
|
||||
main()
|
||||
{
|
||||
pthread_t thread1, thread2;
|
||||
|
||||
printf("============ test peterson lock using atomic xchg ============\n");
|
||||
run_test(&thread1, &thread2, test_peterson_lock_atomicity);
|
||||
|
||||
return 0;
|
||||
}
|
||||
@ -0,0 +1,64 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Intel Corporation. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
#include <stdio.h>
|
||||
#include <pthread.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
// Peterson's algorithm for mutual exclusion
|
||||
#define ITERATIONS 15000000
|
||||
|
||||
typedef struct {
|
||||
bool flag[2];
|
||||
int turn;
|
||||
} peterson_lock_t;
|
||||
|
||||
static int counter = 0;
|
||||
static peterson_lock_t lock;
|
||||
|
||||
void
|
||||
peterson_lock_acquire(peterson_lock_t *lock, int thread_id);
|
||||
|
||||
void
|
||||
peterson_lock_release(peterson_lock_t *lock, int thread_id)
|
||||
{
|
||||
lock->flag[thread_id] = false;
|
||||
}
|
||||
|
||||
void *
|
||||
test_peterson_lock_atomicity(void *arg)
|
||||
{
|
||||
int thread_id = (int)(long)arg;
|
||||
|
||||
for (int i = 0; i < ITERATIONS; ++i) {
|
||||
peterson_lock_acquire(&lock, thread_id);
|
||||
counter++;
|
||||
peterson_lock_release(&lock, thread_id);
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int
|
||||
run_test(pthread_t *thread1_ptr, pthread_t *thread2_ptr,
|
||||
void *(*start_routine)(void *))
|
||||
{
|
||||
lock.flag[0] = false;
|
||||
lock.flag[1] = false;
|
||||
lock.turn = 0;
|
||||
counter = 0;
|
||||
|
||||
pthread_create(thread1_ptr, NULL, start_routine, (void *)0);
|
||||
pthread_create(thread2_ptr, NULL, start_routine, (void *)1);
|
||||
|
||||
pthread_join(*thread1_ptr, NULL);
|
||||
pthread_join(*thread2_ptr, NULL);
|
||||
|
||||
printf("Expected counter value: %d\n", ITERATIONS * 2);
|
||||
printf("Actual counter value: %d\n", counter);
|
||||
if (counter != ITERATIONS * 2)
|
||||
__builtin_trap();
|
||||
|
||||
return 0;
|
||||
}
|
||||
@ -0,0 +1,34 @@
|
||||
/*
|
||||
* Copyright (C) 2023 Intel Corporation. All rights reserved.
|
||||
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
*/
|
||||
#include "peterson.h"
|
||||
|
||||
void
|
||||
peterson_lock_acquire(peterson_lock_t *lock, int thread_id)
|
||||
{
|
||||
// this threads wants to enter the cs
|
||||
lock->flag[thread_id] = true;
|
||||
|
||||
// assume the other thread has priority
|
||||
int other_thread = 1 - thread_id;
|
||||
|
||||
lock->turn = other_thread;
|
||||
|
||||
while (lock->turn == other_thread && lock->flag[other_thread]) {
|
||||
// Busy wait
|
||||
}
|
||||
}
|
||||
|
||||
int
|
||||
main()
|
||||
{
|
||||
pthread_t thread1, thread2;
|
||||
|
||||
printf("============ test naive peterson lock(should trap) ============\n");
|
||||
printf("============ May not be able to observe in interpreter mode "
|
||||
"============\n");
|
||||
run_test(&thread1, &thread2, test_peterson_lock_atomicity);
|
||||
|
||||
return 0;
|
||||
}
|
||||
Reference in New Issue
Block a user