README.md 5.7 KB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
1
# IRIS COQ DEVELOPMENT
Ralf Jung's avatar
Ralf Jung committed
2

Ralf Jung's avatar
Ralf Jung committed
3
This is the Coq development of the [Iris Project](http://iris-project.org).
Ralf Jung's avatar
Ralf Jung committed
4

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

Ralf Jung's avatar
Ralf Jung committed
9 10 11
## Building Iris

### Prerequisites
Ralf Jung's avatar
Ralf Jung committed
12 13 14

This version is known to compile with:

15
 - Coq 8.7.1 / 8.7.2 / 8.8.0
Ralf Jung's avatar
Ralf Jung committed
16
 - A development version of [std++](https://gitlab.mpi-sws.org/robbertkrebbers/coq-stdpp)
Ralf Jung's avatar
Ralf Jung committed
17

18 19
For a version compatible with Coq 8.6, have a look at the
[iris-3.1 branch](https://gitlab.mpi-sws.org/FP/iris-coq/tree/iris-3.1).
Ralf Jung's avatar
Ralf Jung committed
20 21 22
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).

23
### Working *with* Iris
Ralf Jung's avatar
Ralf Jung committed
24

Ralf Jung's avatar
Ralf Jung committed
25 26 27
To use Iris in your own proofs, we recommend you install Iris via opam (1.2.2 or
newer).  To obtain the latest stable release, you have to add the Coq opam
repository:
28 29

    opam repo add coq-released https://coq.inria.fr/opam/released
Ralf Jung's avatar
Ralf Jung committed
30

Ralf Jung's avatar
Ralf Jung committed
31
To obtain a development version, also add the Iris opam repository:
Ralf Jung's avatar
Ralf Jung committed
32

Ralf Jung's avatar
Ralf Jung committed
33
    opam repo add iris-dev https://gitlab.mpi-sws.org/FP/opam-dev.git
34

Ralf Jung's avatar
Ralf Jung committed
35 36 37 38 39
Either way, you can now do `opam install coq-iris`.  To fetch updates later, run
`opam update && opam upgrade`.  However, notice that we do not guarnatee
backwards-compatibility, so upgrading Iris may break your Iris-using
developments.

40
### Working *on* Iris
Ralf Jung's avatar
Ralf Jung committed
41

Ralf Jung's avatar
Ralf Jung committed
42 43 44
To work on Iris itself, you need to install its build-dependencies.  Again we
recommend you do that with opam (1.2.2 or newer).  This requires the following
two repositories:
Ralf Jung's avatar
Ralf Jung committed
45

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

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

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

Ralf Jung's avatar
Ralf Jung committed
55 56 57 58
To update Iris, do `git pull`.  After an update, the development may fail to
compile because of outdated dependencies.  To fix that, please run `opam update`
followed by `make build-dep`.

Ralf Jung's avatar
Ralf Jung committed
59
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed
60

Robbert Krebbers's avatar
Robbert Krebbers committed
61 62 63 64
* 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
65
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
66
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
67 68 69
    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
70 71 72
* 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
73
  constructions that work for any such language.
Ralf Jung's avatar
Ralf Jung committed
74 75 76 77 78
* The folder [bi](theories/bi) contains the BI++ laws, as well as derived
  connectives, laws and constructions that are applicable for general BIS.
* The folder [proofmode](theories/proofmode) contains MoSeL, which extends Coq
  with contexts for intuitionistic and spatial BI++ assertions. It also contains
  tactics for interactive proofs. Documentation can be found in
Robbert Krebbers's avatar
Robbert Krebbers committed
79
  [ProofMode.md](ProofMode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
80 81 82 83
* 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
84 85
    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
86 87 88
* 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.
89

Ralf Jung's avatar
Ralf Jung committed
90
## Case Studies
Ralf Jung's avatar
Ralf Jung committed
91 92 93 94 95 96 97 98

The following is a (probably incomplete) list of case studies that use Iris, and
that should be compatible with this version:

* [Iris Examples](https://gitlab.mpi-sws.org/FP/iris-examples) is where we
  collect miscellaneous case studies that do not have their own repository.
* [LambdaRust](https://gitlab.mpi-sws.org/FP/LambdaRust-coq/) is a Coq
  formalization of the core Rust type system.
Ralf Jung's avatar
Ralf Jung committed
99 100
* [Iris Atomic](https://gitlab.mpi-sws.org/FP/iris-atomic/) is an experimental
  formalization of logically atomic triples in Iris.
101

Ralf Jung's avatar
Ralf Jung committed
102 103
## Notes for Iris Developers

104 105 106 107 108
* Information on how to set up your editor for unicode input and output is
  collected in [Editor.md](Editor.md).
* The Iris Proof Mode (IPM) is documented at [ProofMode.md](ProofMode.md).
* Naming conventions are documented at [Naming.md](Naming.md).

Ralf Jung's avatar
Ralf Jung committed
109
### How to update the std++ dependency
110 111

* Do the change in std++, push it.
Ralf Jung's avatar
Ralf Jung committed
112 113 114
* Wait for CI to publish a new std++ version on the opam archive, then run
  `opam update iris-dev`.
* In Iris, change the `opam` file to depend on the new version.
115
* Run `make build-dep` (in Iris) to install the new version of std++.
Ralf Jung's avatar
Ralf Jung committed
116
  You may have to do `make clean` as Coq will likely complain about .vo file
117
  mismatches.
Ralf Jung's avatar
Ralf Jung committed
118 119 120 121 122 123 124

### How to write/update test cases

The files in `tests/` are test cases.  Each of the `.v` files comes with a
matching `.ref` file containing the expected output of `coqc`.  Adding `Show.`
in selected places in the proofs makes `coqc` print the current goal state.
This is used to make sure the proof mode prints goals and reduces terms the way
125
we expect it to.  You can run `MAKE_REF=1 make` to re-generate all the `.ref` files;
Ralf Jung's avatar
Ralf Jung committed
126 127
this is useful after adding or removing `Show.` from a test.  If you do this,
make sure to check the diff for any unexpected changes in the output!