README.md 2.63 KB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
1 2
# IRIS COQ DEVELOPMENT

3
This is the Coq development of the [Iris Project](http://iris-project.org).
Ralf Jung's avatar
Ralf Jung committed
4 5

## Prerequisites
Ralf Jung's avatar
Ralf Jung committed
6 7 8

This version is known to compile with:

9
 - Coq 8.5pl3 / 8.6
Ralf Jung's avatar
Ralf Jung committed
10
 - Ssreflect 1.6.1
Ralf Jung's avatar
Ralf Jung committed
11 12 13 14 15

The easiest way to install the correct versions of the dependencies is through
opam.  Once you got opam set up, just run `make build-dep` to install the right
versions of the dependencies.  When the dependencies change, just run `make
build-dep` again.
Ralf Jung's avatar
Ralf Jung committed
16

Ralf Jung's avatar
Ralf Jung committed
17
## Building Instructions
Ralf Jung's avatar
Ralf Jung committed
18

Ralf Jung's avatar
Ralf Jung committed
19
Run `make` to build the full development.
Ralf Jung's avatar
Ralf Jung committed
20

Ralf Jung's avatar
Ralf Jung committed
21
## Structure
Ralf Jung's avatar
Ralf Jung committed
22

Robbert Krebbers's avatar
Robbert Krebbers committed
23 24 25 26 27 28
* The folder [prelude](theories/prelude) contains an extended "Standard Library"
  by [Robbert Krebbers](http://robbertkrebbers.nl/thesis.html).
* The folder [algebra](theories/algebra) contains the COFE and CMRA
  constructions as well as the solver for recursive domain equations.
* The folder [base_logic](theories/base_logic) defines the Iris base logic and
  the primitive connectives.  It also contains derived constructions that are
29
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
30
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
31 32 33
    derived constructions.  Most importantly, it defines composeable
    dynamic resources and ownership of them; the other constructions depend
    on this setup.
Robbert Krebbers's avatar
Robbert Krebbers committed
34 35 36
* The folder [program_logic](theories/program_logic) specializes the base logic
  to build Iris, the program logic.   This includes weakest preconditions that
  are defined for any language satisfying some generic axioms, and some derived
37
  constructions that work for any such language.
Robbert Krebbers's avatar
Robbert Krebbers committed
38 39 40
* The folder [proofmode](theories/proofmode) contains the Iris proof mode, which
  extends Coq with contexts for persistent and spatial Iris assertions. It also
  contains tactics for interactive proofs in Iris. Documentation can be found in
Robbert Krebbers's avatar
Robbert Krebbers committed
41
  [ProofMode.md](ProofMode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
42 43 44 45 46 47 48 49 50 51
* The folder [heap_lang](theories/heap_lang) defines the ML-like concurrent heap
  language
  * The subfolder [lib](theories/heap_lang/lib) contains a few derived
    constructions within this language, e.g., parallel composition.
    Most notable here is [lib/barrier](theories/heap_lang/lib/barrier), the
    implementation and proof of a barrier as described in
    <http://doi.acm.org/10.1145/2818638>.
* The folder [tests](theories/tests) contains modules we use to test our
  infrastructure. Users of the Iris Coq library should *not* depend on these
  modules; they may change or disappear without any notice.
52

Ralf Jung's avatar
Ralf Jung committed
53
## Documentation
54 55

A LaTeX version of the core logic definitions and some derived forms is
56
available in [docs/iris.tex](docs/iris.tex).  A compiled PDF version of this
Ralf Jung's avatar
Ralf Jung committed
57
document is [available online](http://plv.mpi-sws.org/iris/appendix-3.0.pdf).