README.md 3.06 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 11 12 13 14 15
 - Ssreflect 1.6

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 17

For development, better make sure you have a version of Ssreflect that includes
18
commit ad273277 (no such version has been released so far, you will have to
Ralf Jung's avatar
Ralf Jung committed
19
fetch the development branch yourself).  Iris compiles fine even without this
Ralf Jung's avatar
Ralf Jung committed
20
patch, but proof bullets will only be in 'strict' (enforcing) mode with the
21 22 23 24
fixed version of Ssreflect.  If you are using opam, you can easily get a fixed
version by running

    opam pin add coq-mathcomp-ssreflect https://github.com/math-comp/math-comp.git#ad273277ab38bfe458e9332dea5f3a79e3885567
Ralf Jung's avatar
Ralf Jung committed
25
 
Ralf Jung's avatar
Ralf Jung committed
26
## Building Instructions
Ralf Jung's avatar
Ralf Jung committed
27

Ralf Jung's avatar
Ralf Jung committed
28
Run `make` to build the full development.
Ralf Jung's avatar
Ralf Jung committed
29

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

Robbert Krebbers's avatar
Robbert Krebbers committed
32
* The folder [prelude](prelude) contains an extended "Standard Library" by
Ralf Jung's avatar
Ralf Jung committed
33
  [Robbert Krebbers](http://robbertkrebbers.nl/thesis.html).
Robbert Krebbers's avatar
Robbert Krebbers committed
34 35
* The folder [algebra](algebra) contains the COFE and CMRA constructions as well
  as the solver for recursive domain equations.
36 37 38
* 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.
39 40 41 42
  * The subfolder [lib](base_logic/lib) contains some generally useful
    derived constructions.  Most importantly, it defines composeable
    dynamic resources and ownership of them; the other constructions depend
    on this setup.
43
* The folder [program_logic](program_logic) specializes the base logic to build
44 45 46
  Iris, the program logic.   This includes weakest preconditions that are
  defined for any language satisfying some generic axioms, and some derived
  constructions that work for any such language.
Robbert Krebbers's avatar
Robbert Krebbers committed
47 48 49 50
* 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).
51 52 53 54 55
* 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 is [lib/barrier](heap_lang/lib/barrier), the implementation
    and proof of a barrier as described in <http://doi.acm.org/10.1145/2818638>.
Robbert Krebbers's avatar
Robbert Krebbers committed
56
* The folder [tests](tests) contains modules we use to test our infrastructure.
Ralf Jung's avatar
Ralf Jung committed
57 58
  Users of the Iris Coq library should *not* depend on these modules; they may
  change or disappear without any notice.
59

Ralf Jung's avatar
Ralf Jung committed
60
## Documentation
61 62

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