README.md 2.9 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.6
Ralf Jung's avatar
Ralf Jung committed
10
 - Ssreflect 1.6.1
Ralf Jung's avatar
Ralf Jung committed
11

12
The easiest way to install the correct versions of the dependencies is
13
through opam. Coq packages are available on the coq-released repository,
14 15 16 17 18
set up by the command:

    opam repo add coq-released https://coq.inria.fr/opam/released

Once you got opam set up, just run `make build-dep` to install the right
Ralf Jung's avatar
Ralf Jung committed
19 20
versions of the dependencies.  When the dependencies change, just run `make
build-dep` again.
Ralf Jung's avatar
Ralf Jung committed
21

22 23 24
If you need to work with Coq 8.5, please check out the
[iris-3.0 branch](https://gitlab.mpi-sws.org/FP/iris-coq/tree/iris-3.0).

Ralf Jung's avatar
Ralf Jung committed
25
## Building Instructions
Ralf Jung's avatar
Ralf Jung committed
26

Ralf Jung's avatar
Ralf Jung committed
27
Run `make` to build the full development.
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 35 36
* 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
37
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
38
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
Ralf Jung's avatar
Ralf Jung committed
39 40 41
    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
42 43 44
* 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
Ralf Jung's avatar
Ralf Jung committed
45
  constructions that work for any such language.
Robbert Krebbers's avatar
Robbert Krebbers committed
46 47 48
* 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
49
  [ProofMode.md](ProofMode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
50 51 52 53 54 55 56 57 58 59
* 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.
60

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

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