Cuda implementation of EVM bytecode executor
- CUDA Toolkit (Version 12.0+, because we use
--std c++20) - A CUDA-capable GPU (CUDA compute capabilily 7+ other older GPUs compability are not tested fully)
- A C++ compiler compatible with the CUDA Toolkit (gcc/g++ version 10+)
- For docker image, you dont need the above but the system with docker installed
There are two methods, one requires installing all prequisited in the system, the second one use docker image:
Note : In Makefile, there is one ENABLE_TRACING flag that is required for now to compare the results against reference REVM and to demonstrate bug detection. It will slowdown the execution.
- Example :
make ENABLE_TRACING=1 interpreter mkdir outfolder if it does not exist
Building on Ubuntu (with sudo):
- Setup required libraries:
sudo apt install libgmp-dev - Setup cJSON:
sudo apt install libcjson-dev make interpreteror for running with cpu :make cpu_interpreter
Building without sudo is also possible with extra configuration and modification on the Makefile or evironment variables, please refer to online tutorials on how to build and use libraries in custom directory
- Build the docker image first:
docker build -f .devcontainer/Dockerfile -t cuevm - Run and mount the current code folder
docker run -it -v $(pwd):/CuEVM cuevm cd CuEVMthenmake interpreteror for running with cpu:make cpu_interpreter
mkdir buildcmake -S . -B build(to build only CPU version : `-DONLY_CPU=ON for debug -DCMAKE_BUILD_TYPE=Debug)cmake --build build
{interpreter} is build/cuevm for CMake build and one of the out/cpu_interpreter or out/interpreter
Please refer to subfolder samples/README.md for testing and demo how to use this CuEVM.
Please refer to scripts/run-ethtest-by-fork.
python scripts/run-ethtest-by-fork.py -i ./tests/GeneralStateTests -t ./tmp --runtest-bin runtest --geth gethvm --cuevm ./build/cuevm --ignore-errors
clear && compute-sanitizer --tool memcheck --leak-check=full {gpu_interpreter} --input [input_json_file] --output [output_json_file]clear && valgrind --leak-check=full --show-leak-kinds=all {cpu_interpreter} --input [input_json_file] --output [output_json_file]clear && valgrind --leak-check=full --show-leak-kinds=all --track-origins=yes ./build/cuevm --input [input_json_file] --output [output_json_file]Or for running with cpu{interpreter} --input [input_json_file] --output [output_json_file]Easy test:{interpreter} --input ./input/evm_arith.json --output ./output/evm_test.json
TODO
TODO docygen+sphinx+breathe+exhale
We use the test files in ethereum/tests/GeneralStateTests to test whether we can get the same results with the go-ethereum. To run the tests,
- build the binary with the debug flag on:
make cpu_debug_interpreter - either download or build the geth binary, in this test the version v1.13.14 is used, later version will probably produce the same result
- get the test json files from ethereum/tests
- extract and keep the tests which targeted at the Shanghai fork
- build the
runtestbinary from cassc/goevmlab which adds support for CuEVM - run
goevmlab/runtestto compare the results betweengethandcuevm
These tests are ignored, they contain some stress tests which could crash the EVM as well as the test script itself:
- stCreateTest
- stQuadraticComplexityTest
- stStaticCall
- stTimeConsuming
The tests results are collected by running the Python script from the ethereum root folder:
python ./run-ethtest-without-stateroot-comparison.py -t /tmp/out --runtest-bin runtest --geth geth --cuevm cuevm --ignore-errorsNote that there can be multiple tests in one input json, the number of tests shown below can be larger than number of input files.
| Test folder | Passed | Failed | Skipped |
|---|---|---|---|
| Cancun | 0 | 0 | 37 |
| Pyspecs | 201 | 2 | 1233 |
| Python | 1 | 0 | 4 |
| Shanghai | 20 | 3 | 0 |
| stArgsZeroOneBalance | 95 | 1 | 0 |
| stAttackTest | 0 | 2 | 0 |
| stBadOpcode | 3542 | 118 | 1 |
| stBugs | 9 | 0 | 0 |
| stCallCodes | 75 | 10 | 1 |
| stCallCreateCallCodeTest | 39 | 9 | 0 |
| stCallDelegateCodesCallCodeHomestead | 51 | 7 | 0 |
| stCallDelegateCodesHomestead | 51 | 7 | 0 |
| stChainId | 2 | 0 | 0 |
| stCodeCopyTest | 1 | 1 | 1 |
| stCodeSizeLimit | 7 | 0 | 0 |
| stCreate2 | 124 | 16 | 3 |
| stDelegatecallTestHomestead | 23 | 6 | 0 |
| stEIP150singleCodeGasPrices | 115 | 5 | 1 |
| stEIP150Specific | 24 | 1 | 0 |
| stEIP158Specific | 6 | 2 | 3 |
| stEIP1559 | 1817 | 2 | 1 |
| stEIP2930 | 15 | 5 | 0 |
| stEIP3607 | 12 | 0 | 2 |
| stExample | 34 | 4 | 0 |
| stExtCodeHash | 23 | 21 | 3 |
| stHomesteadSpecific | 5 | 0 | 0 |
| stInitCodeTest | 20 | 2 | 0 |
| stLogTests | 46 | 0 | 0 |
| stMemExpandingEIP150Calls | 9 | 1 | 0 |
| stMemoryStressTest | 82 | 0 | 0 |
| stMemoryTest | 386 | 7 | 0 |
| stNonZeroCallsTest | 23 | 1 | 12 |
| stPreCompiledContracts | 564 | 1 | 1 |
| stPreCompiledContracts2 | 189 | 17 | 0 |
| stRandom | 305 | 9 | 0 |
| stRandom2 | 221 | 5 | 0 |
| stRecursiveCreate | 2 | 0 | 0 |
| stRefundTest | 10 | 12 | 1 |
| stReturnDataTest | 57 | 10 | 0 |
| stRevertTest | 185 | 10 | 11 |
| stSelfBalance | 26 | 2 | 0 |
| stShift | 42 | 0 | 0 |
| stSLoadTest | 1 | 0 | 0 |
| stSolidityTest | 23 | 0 | 0 |
| stSpecialTest | 20 | 2 | 3 |
| stSStoreTest | 205 | 17 | 1 |
| stStackTests | 185 | 3 | 0 |
| stStaticFlagEnabled | 1 | 12 | 0 |
| stSystemOperationsTest | 71 | 8 | 1 |
| stTransactionTest | 159 | 7 | 2 |
| stTransitionTest | 6 | 0 | 0 |
| stWalletTest | 20 | 26 | 0 |
| stZeroCallsRevert | 16 | 0 | 8 |
| stZeroCallsTest | 24 | 0 | 12 |
| stZeroKnowledge | 681 | 29 | 1 |
| stZeroKnowledge2 | 485 | 10 | 3 |
| VMTests | 567 | 10 | 0 |
The tests results are collected by running the Python script from the ethereum root folder:
python ./run-ethtest-with-stateroot-comparison.py -t /tmp/out --runtest-bin runtest --geth geth --cuevm cuevm --ignore-errors| Test folder | Passed | Failed | Skipped |
|---|---|---|---|
| Cancun | 0 | 0 | 37 |
| Pyspecs | 201 | 2 | 1233 |
| Python | 1 | 0 | 4 |
| Shanghai | 1 | 8 | 0 |
| stArgsZeroOneBalance | 72 | 16 | 0 |
| stAttackTest | 0 | 2 | 0 |
| stBadOpcode | 27 | 119 | 1 |
| stBugs | 1 | 4 | 0 |
| stCallCodes | 3 | 77 | 1 |
| stCallCreateCallCodeTest | 17 | 29 | 0 |
| stCallDelegateCodesCallCodeHomestead | 0 | 58 | 0 |
| stCallDelegateCodesHomestead | 0 | 58 | 0 |
| stChainId | 0 | 2 | 0 |
| stCodeCopyTest | 0 | 2 | 1 |
| stCodeSizeLimit | 4 | 3 | 0 |
| stCreate2 | 13 | 46 | 3 |
| stDelegatecallTestHomestead | 6 | 22 | 0 |
| stEIP150singleCodeGasPrices | 0 | 39 | 1 |
| stEIP150Specific | 1 | 13 | 0 |
| stEIP158Specific | 1 | 7 | 3 |
| stEIP1559 | 1751 | 8 | 1 |
| stEIP2930 | 12 | 6 | 0 |
| stEIP3607 | 12 | 0 | 2 |
| stExample | 29 | 9 | 0 |
| stExtCodeHash | 0 | 36 | 3 |
| stHomesteadSpecific | 3 | 2 | 0 |
| stInitCodeTest | 6 | 12 | 0 |
| stLogTests | 11 | 35 | 0 |
| stMemExpandingEIP150Calls | 1 | 8 | 0 |
| stMemoryStressTest | 78 | 2 | 0 |
| stMemoryTest | 24 | 47 | 0 |
| stNonZeroCallsTest | 6 | 18 | 12 |
| stPreCompiledContracts | 13 | 9 | 1 |
| stPreCompiledContracts2 | 76 | 84 | 0 |
| stRandom | 121 | 193 | 0 |
| stRandom2 | 89 | 137 | 0 |
| stRecursiveCreate | 0 | 2 | 0 |
| stRefundTest | 0 | 22 | 1 |
| stReturnDataTest | 3 | 38 | 0 |
| stRevertTest | 47 | 37 | 11 |
| stSelfBalance | 0 | 6 | 0 |
| stShift | 0 | 42 | 0 |
| stSLoadTest | 0 | 1 | 0 |
| stSolidityTest | 4 | 14 | 0 |
| stSpecialTest | 5 | 10 | 3 |
| stSStoreTest | 0 | 28 | 1 |
| stStackTests | 185 | 3 | 0 |
| stStaticFlagEnabled | 0 | 13 | 0 |
| stSystemOperationsTest | 26 | 43 | 1 |
| stTransactionTest | 110 | 21 | 2 |
| stTransitionTest | 0 | 6 | 0 |
| stWalletTest | 4 | 40 | 0 |
| stZeroCallsRevert | 12 | 4 | 8 |
| stZeroCallsTest | 6 | 18 | 12 |
| stZeroKnowledge | 410 | 33 | 1 |
| stZeroKnowledge2 | 485 | 10 | 3 |
| VMTests | 232 | 58 | 0 |