Skip to content

runtimeverification/evm-semantics

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2f9c2c9 · Jul 26, 2019
Jul 26, 2019
Jun 6, 2019
Jul 19, 2019
Jul 26, 2019
Jul 26, 2019
May 17, 2018
Jul 22, 2019
Jun 5, 2019
Jul 26, 2019
Jul 26, 2019
Jul 26, 2019
Feb 22, 2019
Jul 26, 2019
Jul 23, 2019
Jul 18, 2019
Jun 24, 2019
May 22, 2019
Jul 23, 2019
Jul 23, 2019
Feb 27, 2018
Feb 9, 2018
Jul 26, 2019
May 8, 2019
Feb 12, 2018
Jul 17, 2019

Repository files navigation

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.

Repository Structure

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...).
  • network.md provides the status codes which are reported to an Ethereum client on execution exceptions.
  • 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.
  • evm-node.md is the protobuf interface that an external Ethereum client can connect to for using KEVM as the execution engine.

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

Installing

To install the kevm-vm binary for use in Firefly and other full-nodes, do:

make install

You can set DESTDIR and INSTALL_PREFIX to change where the installation goes.

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-8 clang++-8 llvm-8 lld-8 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

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: