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

Ralf Jung's avatar
Ralf Jung committed
9
 - Coq 8.6.1
Ralf Jung's avatar
Ralf Jung committed
10
 - Ssreflect 1.6.1
Ralf Jung's avatar
Ralf Jung committed
11
 - A development version of [std++](https://gitlab.mpi-sws.org/robbertkrebbers/coq-stdpp)
Ralf Jung's avatar
Ralf Jung committed
12

Ralf Jung's avatar
Ralf Jung committed
13 14 15
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
16
The easiest way to install the correct versions of the dependencies is through
Ralf Jung's avatar
Ralf Jung committed
17
opam.  You will need the Coq and Iris opam repositories:
18 19

    opam repo add coq-released https://coq.inria.fr/opam/released
Ralf Jung's avatar
Ralf Jung committed
20
    opam repo add iris-dev https://gitlab.mpi-sws.org/FP/opam-dev.git
21

Ralf Jung's avatar
Ralf Jung committed
22
Once you got opam set up, run `make build-dep` to install the right versions
Ralf Jung's avatar
Ralf Jung committed
23
of the dependencies.
Ralf Jung's avatar
Ralf Jung committed
24

Ralf Jung's avatar
Ralf Jung committed
25 26 27 28 29
## Updating

After doing `git pull`, the development may fail to compile because of outdated
dependencies.  To fix that, please run `opam update` followed by
`make build-dep`.
30

Ralf Jung's avatar
Ralf Jung committed
31
## Building Instructions
Ralf Jung's avatar
Ralf Jung committed
32

Ralf Jung's avatar
Ralf Jung committed
33 34
Run `make -jN` to build the full development, where `N` is the number of your
CPU cores.
Ralf Jung's avatar
Ralf Jung committed
35

Ralf Jung's avatar
Ralf Jung committed
36
## Structure
Ralf Jung's avatar
Ralf Jung committed
37

Robbert Krebbers's avatar
Robbert Krebbers committed
38 39 40 41
* 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
42
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
43
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
Ralf Jung's avatar
Ralf Jung committed
44 45 46
    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
47 48 49
* 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
50
  constructions that work for any such language.
Robbert Krebbers's avatar
Robbert Krebbers committed
51 52 53
* 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
54
  [ProofMode.md](ProofMode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
55 56 57 58
* 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.
Ralf Jung's avatar
Ralf Jung committed
59 60
    For more examples of using Iris and heap_lang, have a look at the
    [Iris Examples](https://gitlab.mpi-sws.org/FP/iris-examples).
Robbert Krebbers's avatar
Robbert Krebbers committed
61 62 63
* 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.
64

Ralf Jung's avatar
Ralf Jung committed
65
## Documentation
66 67

A LaTeX version of the core logic definitions and some derived forms is
68
available in [docs/iris.tex](docs/iris.tex).  A compiled PDF version of this
Ralf Jung's avatar
Ralf Jung committed
69
document is [available online](http://plv.mpi-sws.org/iris/appendix-3.0.pdf).
70 71 72 73 74 75 76 77 78

## For Developers: How to update the std++ dependency

* Do the change in std++, push it.
* Wait for CI to publish a new std++ version on the opam archive.
* In Iris, change opam to depend on the new version.
* Run `make build-dep` (in Iris) to install the new version of std++.
* You may have to do `make clean` as Coq will likely complain about .vo file
  mismatches.