commit	8a35eea7a1f65b9ba9006567c2703aab20dfaf43	[log] [tgz]
author	Zilin Chen <Zilin.Chen@data61.csiro.au>	Fri Oct 16 18:58:33 2020 +1100
committer	Zilin Chen <Zilin.Chen@data61.csiro.au>	Fri Oct 16 18:58:33 2020 +1100
tree	8bf69a6f20f484f9ab51022d3316fb946b3abb34
parent	467b5dd3d8154baaa2ba188fa7382b79cdb70b6e [diff]

tree: 8bf69a6f20f484f9ab51022d3316fb946b3abb34

README.md

Cogent: Code and Proof Co-Generation

Project homepage

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

Online documentation

https://cogent.readthedocs.io

Installation

Instructions tested on Debian GNU/Linux 9.8 (“stretch”) and Ubuntu 18.04 (“bionic”). Similar distributions may also work.

Install dependencies from the Debian repository.

sudo apt-get install git # git
sudo apt-get install python-lxml python-psutil python-pycparser # regression tester

To install the Cogent compiler, consult file cogent/README.md for details.

The Cogent framework depends on Isabelle-2019. If you already have them on your machine, you can use your local copy. Otherwise you can either obtain it from their website or from the isabelle submodule, via git submodule update --init --recursive -- isabelle.

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.

Compiler

See cogent/README.md for more information.

File systems

See impl/fs/ext2/README and impl/fs/bilby/README for more information on how to build the kernel modules.

Proofs

Firstly, download the AutoCorres release from http://ts.data61.csiro.au/projects/TS/autocorres/, move the extracted folder to this directory, and rename the folder to autocorres.

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 ext2. (ETA: 120 CPU hours)
(cd impl/fs/ext2/cogent;
 make verification;
 export L4V_ARCH="ARM";
 isabelle build -d plat/verification -d ../../../../cogent/isa -d ../../../../autocorres -b Ext2_AllRefine)

# Build compilation correctness proof for BilbyFs. (ETA: 120 CPU hours)
(cd impl/fs/bilby/cogent;
 make verification;
 patch -d plat/verification < ../../../../BilbyFs_CorresProof.patch;
 export L4V_ARCH="ARM";
 isabelle build -d plat/verification -d ../../../../cogent/isa -d ../../../../autocorres -b -o process_output_limit=999 BilbyFs_AllRefine)

# View end-to-end theorems. Each theory has a "print_theorems" command for this.
# For ext2:
L4V_ARCH="ARM" isabelle jedit -d impl/ext2/cogent/plat/verification -d cogent/isa -d autocorres -l Ext2_CorresProof impl/fs/ext2/cogent/plat/verification/Ext2_AllRefine.thy
# For BilbyFs:
L4V_ARCH="ARM" isabelle jedit -d impl/fs/bilby/cogent/plat/verification -d cogent/isa -d autocorres -l BilbyFs_CorresProof impl/fs/bilby/cogent/plat/verification/BilbyFs_AllRefine.thy

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

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

Regression tests (for developers; ETA: 2–3 CPU hours)

For testing the compiler, refer to travis.yml for commands.

Run ./run_tests to test systems implementations and parts of their Isabelle proofs.

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

The Gencot Tool

Gencot is a tool for translating C code to Cogent. It's developed by our collaborators. The repository is hosted on Github. See the README file and the documentation for more details.