Skip to content
K Semantics of the Ethereum Virtual Machine (EVM)
Branch: master
Clone or download
ehildenb and dwightguth Test that `driver.md` fails correctly, modularize in K_RELEASE and KE…
…VM_DIR (#380)

* tests/templates/output-success-llvm: template for llvm backend

* Makefile, tests/failing: tests that testing harness fails correctly

* Dockerfile, Jenkinsfile: setup PATH in Dockerfile

* Jenkinsfile: test that failing tests correctly fail

* Jenkinsfile: run failing tests on llvm and ocaml backends

* kevm: allow specifying KEVM_DIR to override definition directory

* kevm: also allow overiding K_RELEASE

* driver: eliminate source of non-determinism in rules

* driver: prevent narrowing on KItem on <k> cell
Latest commit 8b5d441 Jun 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
deps Update submodule dependencies (#375) Jun 17, 2019
media Updates to kevm script, including updates to KLab invocation, cleanup… Jun 6, 2019
tests Test that `driver.md` fails correctly, modularize in K_RELEASE and KE… Jun 24, 2019
.ci .ci: test which tracks kompiled definitions May 17, 2018
.gitignore Moves dependency submodules into `deps` directory, so that `.build` i… Jun 5, 2019
.gitmodules Moves dependency submodules into `deps` directory, so that `.build` i… Jun 5, 2019
Dockerfile Test that `driver.md` fails correctly, modularize in K_RELEASE and KE… Jun 24, 2019
Jenkinsfile Test that `driver.md` fails correctly, modularize in K_RELEASE and KE… Jun 24, 2019
LICENSE
Makefile Test that `driver.md` fails correctly, modularize in K_RELEASE and KE… Jun 24, 2019
README.md Updates to kevm script, including updates to KLab invocation, cleanup… Jun 6, 2019
data.md edsl.md: add uint16 ABI calldata type (#352) May 22, 2019
driver.md Test that `driver.md` fails correctly, modularize in K_RELEASE and KE… Jun 24, 2019
edsl.md edsl.md: add uint16 ABI calldata type (#352) May 22, 2019
evm-node.md evm-node: avoid mentioning top cell using withConfig rule (#364) Jun 4, 2019
evm.md Add functional attribute to total functions for Haskell backend (#379) Jun 21, 2019
issues.md Update issues.md Feb 27, 2018
kast-json.py kast-json.py: make json parser work with default system python, both … Feb 9, 2018
kevm Test that `driver.md` fails correctly, modularize in K_RELEASE and KE… Jun 24, 2019
kore-json.py Configuration changes (#335) May 8, 2019
krypto.md Makefile, data.md, driver.md, evm.md, krypto.md, proofs/hkg.md, tangl… Feb 12, 2018
network.md network, Makefile: add file for formalizing the EVM-C api, start with… Apr 19, 2018

README.md

KEVM: Semantics of EVM in K

In this repository we provide a model of the EVM in K.

Documentation/Support

These may be useful for learning KEVM and K (newest to oldest):

To get support for KEVM, please join our Riot Room.

Installing/Building

K Backends

There are four backends of K available, the OCAML and (experimental) LLVM backends for concrete execution, and the Java and (experimental) Haskell backends for symbolic reasoning and proofs. This repository generates the build-products for both non-experimental backends in .build/java/ and .build/ocaml/.

System Dependencies

The following are needed for building/running KEVM:

  • git
  • Pandoc >= 1.17 is used to generate the *.k files from the *.md files.
  • GNU Bison, Flex, and Autoconf.
  • GNU libmpfr and libtool.
  • Java 8 JDK (eg. OpenJDK)
  • Opam, important: Ubuntu users prior to 15.04 must build from source, as the Ubuntu install for 14.10 and prior is broken. opam repository also requires rsync.

On Ubuntu >= 18.04 (for example):

sudo apt install                                             \
    autoconf bison flex gcc git libmpfr-dev libsecp256k1-dev \
    libtool libz3-dev make maven opam openjdk-8-jdk pandoc   \
    pkg-config z3 zlib1g-dev

On Ubuntu < 18.04, you'll need to skip libsecp256k1-dev and instead build it from source (via our Makefile):

make libsecp256k1

On ArchLinux:

sudo pacman -S                                              \
    base base-devel boost clang cmake crypto++ curl git gmp \
    jdk-openjdk jemalloc libsecp256k1 lld llvm maven mpfr   \
    opam python rustup stack yaml-cpp z3 zlib

On OSX, using Homebrew, after installing the command line tools package:

brew tap caskroom/cask
brew cask install adoptopenjdk8
brew install automake libtool gmp mpfr pkg-config pandoc maven opam z3 libffi
make libsecp256k1

NOTE: a previous version of these instructions required the user to run brew link flex --force. After fetching this revision, you should first run brew unlink flex, as it is no longer necessary and will cause an error if you have the homebrew version of flex installed instead of the xcode command line tools version.

Building

After installing the above dependencies, make sure the submodules are setup:

git submodule update --init --recursive

If you haven't already setup K's OCaml dependencies more recently than February 1, 2019, then you also need to setup the K OCaml dependencies:

./.build/k/k-distribution/src/main/scripts/bin/k-configure-opam-dev

Finally, you can install repository specific dependencies and build the semantics:

make deps
make build

OPTIONAL: K LLVM/Haskell Backends

The K LLVM/Haskell backends, currently under development, require extra dependencies to work.

System Dependencies

  • Haskell Stack. Note that the version of the stack tool provided by your package manager might not be recent enough. Please follow installation instructions from the Haskell Stack website linked above.

To upgrade stack (if needed):

stack upgrade
export PATH=$HOME/.local/bin:$PATH

The LLVM backend has additional dependencies:

sudo apt install cmake clang-6.0 clang++-6.0 llvm-6.0 lld-6.0 libboost-test-dev libgmp-dev libyaml-cpp-dev libjemalloc-dev curl protobuf-compiler libprotobuf-dev

On Arch, you'll also need crypto++ package.

And you need to setup Rust:

.build/k/llvm-backend/src/main/native/llvm-backend/install-rust

Additionally, you need to setup the remaining LLVM dependencies.

On Ubuntu:

make llvm-deps

On Arch:

make LIBFF_CC=clang LIBFF_CXX=clang++ llvm-deps

Building

After installing the above dependencies, the following command will build the extra backends into K:

  • make haskell-deps: additionally build the Haskell backend into K.
  • make llvm-deps: additionally build the LLVM backend into K.
  • make all-deps: additionally build both the Haskell and LLVM backends into K.

Following this dependency setup, you can also now kompile the LLVM and Haskell backends:

make build-haskell
make build-llvm

This Repository

The following files constitute the KEVM semantics:

  • krypto.md sets up some basic cryptographic primitives.
  • data.md provides the (functional) data of EVM (256 bit words, wordstacks, etc...).
  • evm.md is the main KEVM semantics, containing the configuration and transition rules of EVM.

These additional files extend the semantics to make the repository more useful:

  • driver.md is an execution harness for KEVM, providing a simple language for describing tests/programs.
  • edsl.md defines high-level notations of eDSL, a domain-specific language for EVM specifications, for formal verification of EVM bytecode using K Reachability Logic Prover.

Example Usage

After building the definition, you can run the definition using ./kevm. Read the ./kevm script for examples of the actual invocations of krun that ./kevm makes.

Run the file tests/ethereum-tests/VMTests/vmArithmeticTest/add0.json:

./kevm run tests/ethereum-tests/VMTests/vmArithmeticTest/add0.json

To run proofs, you can similarly use ./kevm. For example, to prove one of the specifications:

./kevm prove tests/specs/ds-token-erc20/transfer-failure-1-a-spec.k -m VERIFICATION

Running Tests

The tests are run using the supplied Makefile. First, run make split-tests to generate some of the tests from the markdown files.

The following subsume all other tests:

  • make test: All of the quick tests.
  • make test-all: All of the quick and slow tests.

These are the individual test-suites (all of these can be suffixed with -all to also run slow tests):

When running tests with the Makefile, you can specify the TEST_CONCRETE_BACKEND (for concrete tests), or TEST_SYMBOLIC_BACKEND (for proofs).

Media

This repository can build two pieces of documentation for you, the Jello Paper and the 2017 Devcon3 presentation.

System Dependencies

If you also want to build the Jello Paper, you'll additionally need:

sudo apt install python-pygments python-sphinx python-recommonmark
git clone 'https://github.com/kframework/k-editor-support'
cd k-editor-support/pygments
easy_install --user .

For the 2017 Devcon3 presentation, you'll need pdflatex, commonly provided with texlive-full.

sudo apt install texlive-full

Building

The Makefile supplies targets for building:

  • All media in this list: make media
  • Jello Paper documentation: make sphinx
  • 2017 Devcon3 presentation: make 2017-devcon3

Resources

For more information about The K Framework, refer to these sources:

You can’t perform that action at this time.