master branch

Developer's Guide

Working with KLEE source code

This guide is out of date and needs to be rewritten. Any help would be appreciated.


GitHub Environment

KLEE’s codebase is currently hosted on GitHub. For those unfamiliar with GitHub, a good starting point is here.

We are using a fork & pull model in KLEE, based on pull requests. For those of you unfamiliar with the process, you can find more information here.

When submitting patches to KLEE, please open a separate pull request for each independent feature or bug fix. This makes it easier to review and approve patches.

Build System

KLEE uses LLVM’s ability to build third-party projects, which is described here. The build system uses GNU Autoconf and AutoHeader to configure the build, but does not use the rest of GNU Autotools (e.g. automake).

LLVM’s build system supports out-of-source builds and therefore so does KLEE. It is highly recommended you take advantage of this. For example, you could create three builds (Release, Release with debug symbols, Debug) that all use the same source tree. This allows you keep your source tree clean and allows multiple configurations to be tested from a single source tree.

Setting up a debug build of KLEE

Setting up a debug build of KLEE (we’ll assume it is an out-of-source build) is very similar to the build process described in Getting Started, with the exception of steps 6 and 7.

  1. Now we will configure KLEE. Notice that we are forcing the compiler to produce unoptimised code, this isn’t the default behaviour.

    $ mkdir path/to/build-dir  
    $ cd path/to/build-dir  
    $ CXXFLAGS="-g -O0" CFLAGS="-g -O0" path/to/source-dir/configure --with-llvm=path/to/llvm --with-stp=path/to/stp/install --with-uclibc=path/to/klee-uclibc --enable-posix-runtime --with-runtime=Debug+Asserts

    Note if you’re using an out-of-source build of LLVM you will need to use --with-llvmsrc= and --with-llvmobj= configure options instead of --with-llvm=

  2. Now we can build KLEE.

    $ make -j

    Note that we are using the -j option of make to speed up the compilation process.

Note that KLEE depends on LLVM and STP. If you need to debug KLEE’s calls to that code, then you will need to build LLVM/STP with debug support too.

Adding a class

Because KLEE uses LLVM’s build system, adding a class to an existing library in KLEE is very simple. For example, to add a class to libkleaverExpr, the following steps would be followed:

  1. Create the header file (.h) for the class and place it somewhere inside include/ (the location isn’t really important except that #include is relative to the include/ directory).
  2. Create the source file (.cpp) for the class place it in lib/Expr/. You can confirm that the library in which your new class will be included is kleaverExpr by looking at the Makefile in lib/Expr.

That’s it! Now LLVM’s build system will detect the new .cpp file and add it to the library that is generated when you run make.

Building code documentation

KLEE uses Doxygen to generate code documentation. To generate it yourself you can run the following from KLEE’s build directory root.

$ make docs

This will generate documentation in path/to/build-dir/docs/doxygen/ folder.

Regression Testing Framework

KLEE uses LLVM’s testing infrastructure for its regression tests. In KLEE these are…

External tests

llvm-lit is used to test KLEE’s tools by invoking them as shell commands.

KLEE’s tests are currently divided into categories, each of which is a subdirectory in test/ in the source tree (e.g. test/Feature).

llvm-lit is passed one or more paths to test files or directories which it will search recursively for tests. The llvm-lit tool needs to know what test-suite the tests belong to and how to run them. This information is in the lit.site.cfg (generated by the Makefile). This file itself refers to lit.cfg which tells llvm-lit how to run the test suite. At the time of writing the lit.cfg instructs llvm-lit to treat files with the following file extensions as tests:.ll .c .cpp .kquery.

It is desirable to disable some tests (e.g. disable klee-uclibc tests if support was not compiled in) or change which file extensions to look for. This is done by adding a lit.local.cfg file to a directory which can be used to customise how tests in that directory are executed. For example to change the file extensions searched for to .cxx and .txt the following could be used in a lit.local.cfg file:

config.suffixes = ['.cxx', '.txt' ]

To disable execution of tests in a directory based on a condition you can mark them as unsupported by placing the following inside a lit.local.cfg file in that directory (where some_condition is any Python expression):

if some_condition:  config.unsupported = True

All llvm-lit configuration files are Python scripts loaded by llvm-lit so you have the full power of Python at your disposal.

The actions performed in each test are specified by special comments in the file. For example, in test/Feature/ByteSwap.c the first two lines are:

// RUN: %llvmgcc %s -emit-llvm -O0 -c -o %t1.bc
// RUN: %klee --libc=klee --exit-on-error %t1.bc

This first runs llvm-gcc (or clang) on the source file (%s) and generates a temporary file (%t1.bc). Then KLEE is executed on this generated temporary file. If either program returns a non-zero exit code (or crashes) then test is considered to have failed. More information on the available substitution variables (such as %s</tt>) can be found (here)[http://llvm.org/docs/TestingGuide.html#variables-and-substitutions].

To run the entire test suite run:

$ cd path/to/klee/build/test
$ make check

or you can use llvm-lit directly

$ cd path/to/klee/build/test
$ llvm-lit .

If you want to run a subset of the test suite simply pass the filenames of the tests or directories to search for tests to llvm-lit. For example the commands below will execute the Feature/DoubleFree.c and CXX/ArrayNew.cpp test and all tests nested in the regression/ folder.

$ cd path/to/klee/build/test
$ llvm-lit Feature/DoubleFree.c CXX/ArrayNew.cpp  regression/

Sometimes it can be useful to pass extra command line options to klee or kleaver when running tests. This could be used for example to quickly see if changing the default value for a command line option changes the passing/failing of a test. This is not a substitute for writing new tests for klee or kleaver! If you add a new feature that is exposed by a new command line option a new test should be added that tests this behaviour.

Here is an example:

$ cd test/
$ llvm-lit --param klee_opts=-use-forked-solver=0 --param kleaver_opts="-use-forked-solver=0 -use-query-log=all:smt2" .

In this example when running klee in tests an extra option -use-forked-solver=0 is passed to klee and when running kleaver the -use-forked-solver=0 and -use-query-log=all:smt2 options will be passed to kleaver. It is important to realise if the test already invokes klee or kleaver with a particular option you will not be able to override that option because the klee_opts and kleaver_opts are substituted just after the tool name so subsequent options used in the test will override these.

For more information on llvm-lit tests see LLVM’s testing infrastructure documentation and the llvm-lit tool documentation.

Internal tests

These tests are located in unittests/ and can be executed by running:

$ cd path/to/klee/build
$ make unittests

These test use Google’s C++ testing framework and is well documented.


Writing messages to standard error

The kleeCore library (lib/Core) provides several functions that can be used similarly to printf() in C. See lib/Core/Common.h for more information.

Adding a command line option to a tool

KLEE uses LLVM’s CommandLine library for adding options to tools in KLEE, which is well documented here. See lib/core/Executor.cpp for examples.

Run-time libraries

KLEE searches for run-time libraries in install and build paths. These are hard-coded to the binary, so if the filesystem tree changes, KLEE will not find them until recompiled. This behaviour can be overridden by setting KLEE_RUNTIME_LIBRARY_PATH environment variable to the path to the libraries.