README.md 2.53 KB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
1 2 3 4 5
# IRIS COQ DEVELOPMENT

This is the Coq development of the [Iris Project](http://plv.mpi-sws.org/iris/).

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

This version is known to compile with:

Robbert Krebbers's avatar
Robbert Krebbers committed
9
 - Coq 8.5pl2
Ralf Jung's avatar
Ralf Jung committed
10 11 12 13 14 15 16 17
 - Ssreflect 1.6

For development, better make sure you have a version of Ssreflect that includes
commit be724937 (no such version has been released so far, you will have to
fetch the development branch yourself). Iris compiles fine even without this
patch, but proof bullets will only be in 'strict' (enforcing) mode with the
fixed version of Ssreflect.
 
Ralf Jung's avatar
Ralf Jung committed
18
## Building Instructions
Ralf Jung's avatar
Ralf Jung committed
19 20 21

Run the following command to build the full development:

Ralf Jung's avatar
Ralf Jung committed
22
    make
Ralf Jung's avatar
Ralf Jung committed
23

Robbert Krebbers's avatar
Robbert Krebbers committed
24
The development can then be installed as the Coq user contribution `iris` by
Robbert Krebbers's avatar
Robbert Krebbers committed
25 26 27
running:

    make install
Ralf Jung's avatar
Ralf Jung committed
28

Ralf Jung's avatar
Ralf Jung committed
29
## Structure
Ralf Jung's avatar
Ralf Jung committed
30

Robbert Krebbers's avatar
Robbert Krebbers committed
31 32 33 34
* The folder [prelude](prelude) contains an extended "Standard Library" by
  Robbert Krebbers <http://robbertkrebbers.nl/thesis.html>.
* The folder [algebra](algebra) contains the COFE and CMRA constructions as well
  as the solver for recursive domain equations.
35 36 37 38 39 40 41
* The folder [base_logic](base_logic) defines the Iris base logic and the
  primitive connectives.  It also contains derived constructions that are
  entirely independent of the choice of resources.
* The folder [program_logic](program_logic) specializes the base logic to build
  Iris, the program logic.  Most crucially, this includes world satisfaction
  and weakest preconditions.  Furthermore, some language-independent derived
  constructions (e.g., STSs) are defined in this folder.
Robbert Krebbers's avatar
Robbert Krebbers committed
42 43 44 45 46 47 48 49 50 51
* The folder [heap_lang](heap_lang) defines the ML-like concurrent heap language
  * The subfolder [lib](heap_lang/lib) contains a few derived constructions
    within this language, e.g., parallel composition.
    Most notable here s [lib/barrier](heap_lang/lib/barrier), the implementation
    and proof of a barrier as described in <http://doi.acm.org/10.1145/2818638>.
* The folder [proofmode](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
  [ProofMode.md](ProofMode.md).
* The folder [tests](tests) contains modules we use to test our infrastructure.
Ralf Jung's avatar
Ralf Jung committed
52 53
  Users of the Iris Coq library should *not* depend on these modules; they may
  change or disappear without any notice.
54

Ralf Jung's avatar
Ralf Jung committed
55
## Documentation
56 57

A LaTeX version of the core logic definitions and some derived forms is
58 59
available in [docs/iris.tex](docs/iris.tex).  A compiled PDF version of this
document is [http://plv.mpi-sws.org/iris/appendix-3.0.pdf](available online).