Speed up the spec case test by parallelism (#819)

Port spec-test-script/all.sh to spec-test-script/all.py and enable to run
spec cases with multiple threads parallelly:
- It reduces spec_test.yml from ~14min to ~9min and reduces
  compilation_on_sgx.yml from ~18min to ~12min
- run `./test_wamr.sh` will keep the same experience likes before by default
- run `./test_wamr.sh -P` will enable parallelism mode
- in parallelism mode, all.py will be in a less-output mode. It only outputs
  the last words of failed cases and will not output logs for those passed
This commit is contained in:
liang.he 2021-11-08 12:39:02 +08:00 committed by GitHub
parent 403a7d3f4f
commit 487072a78e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 461 additions and 20 deletions

View File

@ -455,5 +455,5 @@ jobs:
if: ${{ matrix.light == 'green' }}
run: |
source /opt/intel/sgxsdk/environment
./test_wamr.sh -x -p -s spec -t ${{ matrix.running_mode }}
./test_wamr.sh -x -p -s spec -P -t ${{ matrix.running_mode }}
working-directory: ./tests/wamr-test-suites

View File

@ -33,12 +33,12 @@ concurrency:
cancel-in-progress: true
env:
DEFAULT_TEST_OPTIONS: "-s spec"
DEFAULT_TEST_OPTIONS: "-s spec -P"
LLVM_CACHE_SUFFIX: "build-llvm_libraries_ex"
MULTI_MODULES_TEST_OPTIONS: "-s spec -M"
SIMD_TEST_OPTIONS: "-s spec -S"
THREADS_TEST_OPTIONS: "-s spec -p"
X86_32_TARGET_TEST_OPTIONS: "-m x86_32"
MULTI_MODULES_TEST_OPTIONS: "-s spec -M -P"
SIMD_TEST_OPTIONS: "-s spec -S -P"
THREADS_TEST_OPTIONS: "-s spec -p -P"
X86_32_TARGET_TEST_OPTIONS: "-m x86_32 -P"
jobs:
cancel_previous:

View File

@ -0,0 +1,434 @@
#!/usr/bin/env python3
#
# Copyright (C) 2019 Intel Corporation. All rights reserved.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#
import argparse
import hashlib
import multiprocessing as mp
import os
import pathlib
import random
import shlex
import shutil
import string
import subprocess
import sys
import time
"""
The script itself has to be put under the same directory with the "spec".
"""
IWASM_CMD = "../../../product-mini/platforms/linux/build/iwasm"
IWASM_SGX_CMD = "../../../product-mini/platforms/linux-sgx/enclave-sample/iwasm"
SPEC_TEST_DIR = "spec/test/core"
WAST2WASM_CMD = "./wabt/out/gcc/Release/wat2wasm"
WAMRC_CMD = "../../../wamr-compiler/build/wamrc"
class TargetAction(argparse.Action):
TARGET_MAP = {
"ARMV7_VFP": "armv7",
"RISCV64": "riscv64_lp64d",
"RISCV64_LP64": "riscv64_lp64d",
"RISCV64_LP64D": "riscv64_lp64",
"THUMBV7_VFP": "thumbv7",
"X86_32": "i386",
"X86_64": "x86_64",
}
def __call__(self, parser, namespace, values, option_string=None):
setattr(namespace, self.dest, self.TARGET_MAP.get(values, "x86_64"))
def ignore_the_case(
case_name,
target,
aot_flag=False,
sgx_flag=False,
multi_module_flag=False,
reference_type_flag=True,
simd_flag=False,
):
if case_name in ["comments", "inline-module", "names"]:
return True
if not multi_module_flag and case_name in ["imports", "linking"]:
return True
if "i386" == target and case_name in ["float_exprs"]:
return True
if sgx_flag:
if case_name in ["conversions", "f32_bitwise", "f64_bitwise"]:
return True
if aot_flag and case_name in [
"call_indirect",
"call",
"fac",
"skip-stack-guard-page",
]:
return True
return False
def preflight_check(aot_flag):
if not pathlib.Path(SPEC_TEST_DIR).resolve().exists():
print(f"Can not find {SPEC_TEST_DIR}")
return False
if not pathlib.Path(WAST2WASM_CMD).resolve().exists():
print(f"Can not find {WAST2WASM_CMD}")
return False
if aot_flag and not pathlib.Path(WAMRC_CMD).resolve().exists():
print(f"Can not find {WAMRC_CMD}")
return False
return True
def test_case(
case_path,
target,
aot_flag=False,
sgx_flag=False,
multi_module_flag=False,
reference_type_flag=True,
simd_flag=False,
clean_up_flag=True,
verbose_flag=True,
):
case_path = pathlib.Path(case_path).resolve()
case_name = case_path.stem
if ignore_the_case(
case_name,
target,
aot_flag,
sgx_flag,
multi_module_flag,
reference_type_flag,
simd_flag,
):
return True
CMD = ["python2.7", "runtest.py"]
CMD.append("--wast2wasm")
CMD.append(WAST2WASM_CMD)
CMD.append("--interpreter")
CMD.append(IWASM_CMD if not sgx_flag else IWASM_SGX_CMD)
CMD.append("--aot-compiler")
CMD.append(WAMRC_CMD)
if aot_flag:
CMD.append("--aot")
CMD.append("--aot-target")
CMD.append(target)
if reference_type_flag:
CMD.append("--ref_types")
if sgx_flag:
CMD.append("--sgx")
if simd_flag:
CMD.append("--simd")
if not clean_up_flag:
CMD.append("--no_cleanup")
CMD.append(case_path)
print(f"============> run {case_name} ", end="")
with subprocess.Popen(
CMD,
bufsize=1,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
universal_newlines=True,
) as p:
try:
case_last_words = []
while not p.poll():
output = p.stdout.readline()
if not output:
break
if verbose_flag:
print(output, end="")
else:
if len(case_last_words) == 16:
case_last_words.pop(0)
case_last_words.append(output)
p.wait(60)
if p.returncode:
print(f"failed with a non-zero return code {p.returncode}")
if not verbose_flag:
print(
f"\n==================== LAST LOG of {case_name} ====================\n"
)
print("".join(case_last_words))
print("\n==================== LAST LOG END ====================\n")
raise Exception(case_name)
else:
print("successful")
return True
except subprocess.CalledProcessError:
print("failed with CalledProcessError")
raise Exception(case_name)
except subprocess.TimeoutExpired:
print("failed with TimeoutExpired")
raise Exception(case_name)
def test_suite(
target,
aot_flag=False,
sgx_flag=False,
multi_module_flag=False,
reference_type_flag=True,
simd_flag=False,
clean_up_flag=True,
verbose_flag=True,
):
suite_path = pathlib.Path(SPEC_TEST_DIR).resolve()
if not suite_path.exists():
print(f"can not find spec test cases at {suite_path}")
return False
case_list = sorted(suite_path.glob("**/*.wast"))
case_count = len(case_list)
failed_case = 0
successful_case = 0
for case_path in case_list:
try:
test_case(
str(case_path),
target,
aot_flag,
sgx_flag,
multi_module_flag,
reference_type_flag,
simd_flag,
clean_up_flag,
verbose_flag,
)
successful_case += 1
except Exception:
failed_case += 1
break
print(
f"IN ALL {case_count} cases: {successful_case} PASS, {failed_case} FAIL, {case_count - successful_case - failed_case} SKIP"
)
return 0 == failed_case
def test_suite_parallelly(
target,
aot_flag=False,
sgx_flag=False,
multi_module_flag=False,
reference_type_flag=True,
simd_flag=False,
clean_up_flag=False,
verbose_flag=False,
):
suite_path = pathlib.Path(SPEC_TEST_DIR).resolve()
if not suite_path.exists():
print(f"can not find spec test cases at {suite_path}")
return False
case_list = sorted(suite_path.glob("**/*.wast"))
case_count = len(case_list)
failed_case = 0
successful_case = 0
print(f"----- Run the whole spec test suite on {mp.cpu_count()} cores -----")
with mp.Pool() as pool:
results = {}
for case_path in case_list:
results[case_path.stem] = pool.apply_async(
test_case,
[
str(case_path),
target,
aot_flag,
sgx_flag,
multi_module_flag,
reference_type_flag,
simd_flag,
clean_up_flag,
verbose_flag,
],
)
for case_name, result in results.items():
try:
# 5 min / case
result.wait(300)
if not result.successful():
failed_case += 1
else:
successful_case += 1
except mp.TimeoutError:
print(f"{case_name} meets TimeoutError")
failed_case += 1
print(
f"IN ALL {case_count} cases: {successful_case} PASS, {failed_case} FAIL, {case_count - successful_case - failed_case} SKIP"
)
return 0 == failed_case
def main():
parser = argparse.ArgumentParser(description="run the whole spec test suite")
parser.add_argument(
"-M",
action="store_true",
default=False,
dest="multi_module_flag",
help="Running with the Multi-Module feature",
)
parser.add_argument(
"-m",
action=TargetAction,
choices=list(TargetAction.TARGET_MAP.keys()),
type=str,
dest="target",
default="X86_64",
help="Specify Target ",
)
parser.add_argument(
"-r",
action="store_true",
default=False,
dest="reference_type_flag",
help="Running with the Reference-type feature",
)
parser.add_argument(
"-S",
action="store_true",
default=False,
dest="simd_flag",
help="Running with the SIMD feature",
)
parser.add_argument(
"-t",
action="store_true",
default=False,
dest="aot_flag",
help="Running with AOT mode",
)
parser.add_argument(
"-x",
action="store_true",
default=False,
dest="sgx_flag",
help="Running with SGX environment",
)
parser.add_argument(
"--parl",
action="store_true",
default=False,
dest="parl_flag",
help="To run whole test suite parallelly",
)
parser.add_argument(
"--no_clean_up",
action="store_false",
default=True,
dest="clean_up_flag",
help="Does not remove tmpfiles. But it will be enabled while running parallelly",
)
parser.add_argument(
"--quiet",
action="store_false",
default=True,
dest="verbose_flag",
help="Close real time output while running cases, only show last words of failed ones",
)
parser.add_argument(
"cases",
metavar="path_to__case",
type=str,
nargs="*",
help=f"Specify all wanted cases. If not the script will go through all cases under {SPEC_TEST_DIR}",
)
options = parser.parse_args()
print(options)
if not preflight_check(options.aot_flag):
return False
if not options.cases:
if options.parl_flag:
# several cases might share the same workspace/tempfile at the same time
# so, disable it while running parallelly
options.clean_up_flag = False
options.verbose_flag = False
start = time.time_ns()
ret = test_suite_parallelly(
options.target,
options.aot_flag,
options.sgx_flag,
options.multi_module_flag,
options.reference_type_flag,
options.simd_flag,
options.clean_up_flag,
options.verbose_flag,
)
end = time.time_ns()
print(
f"It takes {((end - start) / 1000000):,} ms to run test_suite_parallelly"
)
else:
start = time.time_ns()
ret = test_suite(
options.target,
options.aot_flag,
options.sgx_flag,
options.multi_module_flag,
options.reference_type_flag,
options.simd_flag,
options.clean_up_flag,
options.verbose_flag,
)
end = time.time_ns()
print(f"It takes {((end - start) / 1000000):,} ms to run test_suite")
else:
try:
for case in options.cases:
test_case(
case,
options.target,
options.aot_flag,
options.sgx_flag,
options.multi_module_flag,
options.reference_type_flag,
options.simd_flag,
options.clean_up_flag,
options.verbose_flag,
)
else:
ret = True
except Exception:
ret = False
return ret
if __name__ == "__main__":
sys.exit(0 if main() else 1)

View File

@ -1075,6 +1075,7 @@ if __name__ == "__main__":
if test_aot:
(t3fd, aot_tempfile) = tempfile.mkstemp(suffix=".aot")
ret_code = 0
try:
log("################################################")
log("### Testing %s" % opts.test_file.name)
@ -1262,9 +1263,10 @@ if __name__ == "__main__":
raise Exception("unrecognized form '%s...'" % form[0:40])
except Exception as e:
traceback.print_exc()
raise Exception("catch an exception {}".format(e))
print("THE FINAL EXCEPTION IS {}".format(e))
ret_code = 101
else:
sys.exit(0)
ret_code = 0
finally:
if not opts.no_cleanup:
log("Removing tempfiles")
@ -1285,3 +1287,5 @@ if __name__ == "__main__":
log("### End testing %s" % opts.test_file.name)
else:
log("Leaving tempfiles: %s" % ([wast_tempfile, wasm_tempfile]))
sys.exit(ret_code)

View File

@ -13,14 +13,15 @@ DEBUG set -xEevuo pipefail
function help()
{
echo "test_wamr.sh [options]"
echo "-s {suite_name} test only one suite (spec)"
echo "-c clean previous test results, not start test"
echo "-b use the wabt binary release package instead of compiling from the source code"
echo "-t set compile type of iwasm(classic-interp\fast-interp\jit\aot)"
echo "-m set compile target of iwasm(x86_64\x86_32\armv7_vfp\thumbv7_vfp\riscv64_lp64d\riscv64_lp64)"
echo "-M enable the multi module feature"
echo "-m set compile target of iwasm(x86_64\x86_32\armv7_vfp\thumbv7_vfp\riscv64_lp64d\riscv64_lp64)"
echo "-P run the spec test parallelly"
echo "-p enable multi thread feature"
echo "-S enable SIMD"
echo "-s {suite_name} test only one suite (spec)"
echo "-t set compile type of iwasm(classic-interp\fast-interp\jit\aot)"
echo "-x test SGX"
}
@ -41,8 +42,9 @@ SGX_OPT=""
# as they are finished and merged into spec
ENABLE_REF_TYPES=1
PLATFORM=$(uname -s | tr A-Z a-z)
PARALLELISM=0
while getopts ":s:cabt:m:MCpSxr" opt
while getopts ":s:cabt:m:MCpSxP" opt
do
OPT_PARSED="TRUE"
case $opt in
@ -114,6 +116,9 @@ do
echo "test SGX"
SGX_OPT="--sgx"
;;
P)
PARALLELISM=1
;;
?)
help
exit 1;;
@ -307,12 +312,6 @@ function spec_test()
git fetch simd
git checkout simd/main -- test/core/simd
git checkout simd/main -- interpreter
echo "compile the reference intepreter"
pushd interpreter
make opt -j 4
popd
git apply ../../spec-test-script/simd_ignore_cases.patch
fi
@ -362,7 +361,7 @@ function spec_test()
make -C wabt gcc-release -j 4
fi
ln -sf ${WORK_DIR}/../spec-test-script/all.sh .
ln -sf ${WORK_DIR}/../spec-test-script/all.py .
ln -sf ${WORK_DIR}/../spec-test-script/runtest.py .
local ARGS_FOR_SPEC_TEST=""
@ -398,8 +397,12 @@ function spec_test()
ARGS_FOR_SPEC_TEST+="-t -m ${TARGET} "
fi
if [[ ${PARALLELISM} == 1 ]]; then
ARGS_FOR_SPEC_TEST+="--parl "
fi
cd ${WORK_DIR}
./all.sh ${ARGS_FOR_SPEC_TEST} | tee -a ${REPORT_DIR}/spec_test_report.txt
python3 ./all.py ${ARGS_FOR_SPEC_TEST} | tee -a ${REPORT_DIR}/spec_test_report.txt
[[ ${PIPESTATUS[0]} -ne 0 ]] && exit 1
cd -