README.md 3 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:

Robbert Krebbers's avatar
Robbert Krebbers committed
9
 - Coq 8.5pl2
Ralf Jung's avatar
Ralf Jung committed
10
 - [Ssreflect 1.6](https://github.com/math-comp/math-comp/releases/tag/mathcomp-1.6)
Ralf Jung's avatar
Ralf Jung committed
11 12

For development, better make sure you have a version of Ssreflect that includes
13
commit ad273277 (no such version has been released so far, you will have to
Ralf Jung's avatar
Ralf Jung committed
14 15
fetch the development branch yourself). Iris compiles fine even without this
patch, but proof bullets will only be in 'strict' (enforcing) mode with the
16 17 18 19
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
20
 
Ralf Jung's avatar
Ralf Jung committed
21
## Building Instructions
Ralf Jung's avatar
Ralf Jung committed
22 23 24

Run the following command to build the full development:

Ralf Jung's avatar
Ralf Jung committed
25
    make
Ralf Jung's avatar
Ralf Jung committed
26

Robbert Krebbers's avatar
Robbert Krebbers committed
27
The development can then be installed as the Coq user contribution `iris` by
Robbert Krebbers's avatar
Robbert Krebbers committed
28 29 30
running:

    make install
Ralf Jung's avatar
Ralf Jung committed
31

Ralf Jung's avatar
Ralf Jung committed
32
## Structure
Ralf Jung's avatar
Ralf Jung committed
33

Robbert Krebbers's avatar
Robbert Krebbers committed
34
* The folder [prelude](prelude) contains an extended "Standard Library" by
Ralf Jung's avatar
Ralf Jung committed
35
  [Robbert Krebbers](http://robbertkrebbers.nl/thesis.html).
Robbert Krebbers's avatar
Robbert Krebbers committed
36 37
* The folder [algebra](algebra) contains the COFE and CMRA constructions as well
  as the solver for recursive domain equations.
38 39 40
* 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.
41 42 43 44
  * 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.
45
* The folder [program_logic](program_logic) specializes the base logic to build
46 47 48
  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
49 50 51 52
* 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).
53 54 55 56 57
* 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
58
* The folder [tests](tests) contains modules we use to test our infrastructure.
Ralf Jung's avatar
Ralf Jung committed
59 60
  Users of the Iris Coq library should *not* depend on these modules; they may
  change or disappear without any notice.
61

Ralf Jung's avatar
Ralf Jung committed
62
## Documentation
63 64

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