For general context of this project, motivation, an overview, and published papers, see our project homepage.

Instructions tested on Debian GNU/Linux 8.2 (“jessie”). May need to be adapted for other systems.

Install dependencies from the Debian repository.

sudo apt-get install git # git
sudo apt-get install libgmp-dev libncurses5-dev # Haskell
sudo apt-get install python-lxml python-psutil python-pycparser # regression tester

You need a recent version of Glasgow Haskell Compiler (7.8.4+), cabal-install, alex, and happy. For instructions, consult file cogent/README for details. Or, if unsure, install Haskell Platform:

wget 'https://haskell.org/platform/download/7.10.2/haskell-platform-7.10.2-a-unknown-linux-deb7.tar.gz'
tar -xzf haskell-platform-7.10.2-a-unknown-linux-deb7.tar.gz
sudo ./install-haskell-platform.sh
sudo apt-get install libgmp-dev libncurses-dev

l4v and isabelle are two submodules in the repository. To get them: git submodule update --init --recursive.

If you already have them on your machine, you can symlink them as l4v and isabelle respectively in the top-level directory of this repository and checkout relevant revisions:

• l4v: ffc7b107e5bd5978295da61f64ea87b9ea3ad4d1
• isabelle: any Isabelle2015 revision

Add isabelle/bin to your PATH: export PATH="$(pwd)/isabelle/bin:$PATH" If you have an existing Isabelle install, you may want to set ISABELLE_IDENTIFIER instead of PATH.

Initialise Isabelle and install components:

isabelle components -I
isabelle components -a

Consult Isabelle manual for more information.

For more customised settings to run proofs and regression tests, modify build-env.sh.

Note: also see Proofs and Regression tests below.

Run build system and regression tests. (ETA: 2–3 CPU hours) This also builds the COGENT compiler and Isabelle theories. If this works, your install is probably ok. Run ./run_tests.

For C-refinement proofs, which are excluded from the regression tests because of their size, follow instructions in Proofs section.

To build the proofs, it is recommended that your machine (or virtual machine) provides 32G of memory and 4–8 CPU threads.

# Build compilation correctness proof for BilbyFS. (ETA: 120 CPU hours)
(cd impl/bilby/cogent;
 make verification;
 patch <../../../BilbyFS_CorresProof.patch;
 isabelle build -d . -d ../../../cogent/isa -d ../../../l4v -b -o process_output_limit=999 BilbyFS_AllRefine)

# View end-to-end theorems. Each theory has a "print_theorems" command for this.
# For BilbyFS:
isabelle jedit -d impl/bilby/cogent -d cogent/isa -d l4v -l BilbyFS_CorresProof impl/bilby/cogent/BilbyFS_AllRefine.thy

The functional correctness proofs for BilbyFS's sync and iget operations are in impl/bilby/proof/. They are built as part of the regression tests, and can be rebuilt with

regression/run_tests.py -x l4v -x isabelle -v sync iget

See impl/bilby/README for more information

• cogent: COGENT compiler
  • isa: Isabelle/HOL semantics for COGENT
  • tests: Compiler test suite
• c-refinement: Isabelle/HOL theories and proof procedures for COGENT-C refinement
  • tests: COGENT test programs for proof procedures
• isa-parser: Haskell library for parsing and pretty-printing Isabelle/HOL
• impl: COGENT programs and libraries
  • libgum: Common COGENT and C libraries
  • bilby: Bilby file system
    • cogent/fs: COGENT code for BilbyFS
• regression: Regression test script