⚠️ The Cartesi team keeps working internally on the next version of this repository, following its regular development roadmap. Whenever there's a new version ready or important fix, these are published to the public source tree as new releases.
The Cartesi Machine Emulator is the reference off-chain implementation of the Cartesi Machine Specification. It's written in C/C++ with POSIX dependencies restricted to the terminal, process, and memory-mapping facilites. It is distributed as a library and scriptable in the Lua programming language.
The emulator implements RISC-V's RV64IMASU ISA. The letters after RV specify the extension set. This selection corresponds to a 64-bit machine, Integer arithmetic with Multiplication and division, Atomic operations, as well as the optional Supervisor and User privilege levels. In addition, Cartesi Machines support the Sv48 mode of address translation and memory protection.
Run make help for a list of target options. Here are some of them:
Cleaning targets:
clean - clean the src/ artifacts
depclean - clean + dependencies
distclean - depclean + profile information and downloads
Docker targets:
build-ubuntu-image - Build an ubuntu based docker image
- C++ Compiler with support for C++17 (tested with GCC >= 8+ and Clang >= 8.x).
- GNU Make >= 3.81
- Cryptopp >= 7.0.0
- GRPC 1.38.0
- Lua 5.3.5
- b64 >= 1.2.1
- Boost >= 1.71
- nlohmann JSON >= 3.10
Obs: Please note that Apple Clang Version number does not follow upstream LLVM/Clang.
sudo apt-get install build-essential automake libtool patchelf cmake pkg-config wget git libreadline-dev libboost-coroutine-dev libboost-context-dev libboost-filesystem-dev libboost-log-dev libssl-dev openssl libc-ares-dev zlib1g-dev ca-certificates liblua5.3-dev libb64-dev libcrypto++-dev nlohmann-json3-dev luarocks
sudo luarocks install lpeg
sudo luarocks install dkjson
sudo luarocks install luasocket
sudo luarocks install luasec
sudo luarocks install luaposix
sudo luarocks install md5
sudo port install clang-14 automake boost libtool wget cmake pkgconfig c-ares zlib openssl lua libb64 libcryptopp nlohmann-json lua-luarocks
sudo luarocks install lpeg
sudo luarocks install dkjson
sudo luarocks install luasocket
sudo luarocks install luasec
sudo luarocks install luaposix
sudo luarocks install md5
brew install llvm@12 automake boost libomp wget cmake pkg-config c-ares zlib openssl lua@5.3 libb64 nlohmann-json luarocks
luarocks --lua-dir=$(brew --prefix)/opt/lua@5.3 install lpeg
luarocks --lua-dir=$(brew --prefix)/opt/lua@5.3 install dkjson
luarocks --lua-dir=$(brew --prefix)/opt/lua@5.3 install luasocket
luarocks --lua-dir=$(brew --prefix)/opt/lua@5.3 install luasec
luarocks --lua-dir=$(brew --prefix)/opt/lua@5.3 install luaposix
luarocks --lua-dir=$(brew --prefix)/opt/lua@5.3 install md5
For emulator scripts to work it is expected that lua5.3 binary is available in the system PATH. If operating system/package manager that you are using provides only lua or lua binary named in a different way (e.g. on Homebrew), please create symbolic link or alias lua5.3.
Homebrew does not have a formula for this library on the official repository, at the time of this writing. More information on how to obtain this library can be found on https://www.cryptopp.com
$ make submodules
$ make downloads
$ make dep
$ makeCleaning:
$ make depclean
$ make clean$ make installCopy the tests binaries to a directory called tests and run: (Eg.: )
$ make testThe default search path for binaries is machine-emulator/tests. Alternatively you can specify the binaries path using the TEST_PATH variable as in:
$ make test TEST_PATH=/full/path/to/test/binariesWe use clang-tidy 14 as the linter.
You need to install the package clang-tidy-14 and set it as the default executable with update-alternatives.
$ apt install clang-tidy-14
$ update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-14 120$ make lint -j$(nproc)We use clang-format to format the code base.
You need to install the package clang-format-14 and set is as the default executable with update-alternatives.
$ apt install clang-format-14
$ update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-14 120$ make format$ make check-formatIf you want to run the GCC-based coverage, you should install the lcov package with the following command.
$ sudo apt install lcovIf you want to run the clang-based coverage, you should install the clang package with the following command.
$ sudo apt install clang llvmBefore running the coverage, you should build the emulator with the flag coverage-toolchain=gcc or coverage-toolchain=clang.
Make sure you run make clean to clean up any previous compilation.
For GCC-based coverage run the following command.
$ make coverage-toolchain=gcc -j$(nproc)For clang-based coverage run the following command.
$ make coverage-toolchain=clang -j$(nproc)After building the emulator with coverage enable, you should run the following command.
You need to specify the binaries test path using the TEST_PATH and the CARTESI_TESTS_PATH variables.
You also need to specify the directory containg the ROM, kernel and rootfs with the CARTESI_IMAGES_PATH variable.
For instance:
$ make coverage-toolchain=gcc coverage \
TEST_PATH=$(realpath ../tests/build) \
CARTESI_TESTS_PATH=$(realpath ../tests/build) \
CARTESI_IMAGES_PATH=$(realpath ./src)This command will generate a coverage report in the src directory. For clang coverage, repeat the same command but with the flag coverage-toolchain=clang.
Thank you for your interest in Cartesi! Head over to our Contributing Guidelines for instructions on how to sign our Contributors Agreement and get started with Cartesi!
Please note we have a Code of Conduct, please follow it in all your interactions with the project.
The machine-emulator repository and all contributions are licensed under LGPL 3.0. Please review our COPYING file.