README.md 4.57 KB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
1
# IRIS COQ DEVELOPMENT, MOSEL VERSION
Ralf Jung's avatar
Ralf Jung committed
2

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

## Prerequisites
Ralf Jung's avatar
Ralf Jung committed
7
8
9

This version is known to compile with:

Ralf Jung's avatar
Ralf Jung committed
10
 - Coq 8.7.1 / 8.7.2 / 8.8.0
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
## Installing via opam

Ralf Jung's avatar
Ralf Jung committed
15
16
To obtain the latest stable release via opam (1.2.2 or newer), you have to add
the Coq opam repository:
17
18

    opam repo add coq-released https://coq.inria.fr/opam/released
Ralf Jung's avatar
Ralf Jung committed
19
20
21
22
23

Then you can do `opam install coq-iris`.

To obtain a development version, add the Iris opam repository:

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

Ralf Jung's avatar
Ralf Jung committed
26
## Building from source
Ralf Jung's avatar
Ralf Jung committed
27

Ralf Jung's avatar
Ralf Jung committed
28
29
When building Iris from source, we recommend to use opam (1.2.2 or newer) for
installing Iris's dependencies.  This requires the following two repositories:
Ralf Jung's avatar
Ralf Jung committed
30

Ralf Jung's avatar
Ralf Jung committed
31
32
    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
33

Ralf Jung's avatar
Ralf Jung committed
34
35
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
36

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

Ralf Jung's avatar
Ralf Jung committed
40
41
42
43
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
44
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed
45

Robbert Krebbers's avatar
Robbert Krebbers committed
46
47
48
49
* 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
50
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
51
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
Ralf Jung's avatar
Ralf Jung committed
52
53
54
    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
55
56
57
* 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
58
  constructions that work for any such language.
Ralf Jung's avatar
Ralf Jung committed
59
60
61
62
63
* 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
64
  [ProofMode.md](ProofMode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
65
66
67
68
* 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
69
70
    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
71
72
73
* 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.
74

75
76
77
78
79
80
81
82
## Further Documentation

* 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).
* 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)
Ralf Jung's avatar
Ralf Jung committed
83

Ralf Jung's avatar
Ralf Jung committed
84
## Case Studies
Ralf Jung's avatar
Ralf Jung committed
85
86
87
88
89
90
91
92

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
93
94
* [Iris Atomic](https://gitlab.mpi-sws.org/FP/iris-atomic/) is an experimental
  formalization of logically atomic triples in Iris.
95
96
97
98

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

* Do the change in std++, push it.
Ralf Jung's avatar
Ralf Jung committed
99
100
101
* 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.
102
* Run `make build-dep` (in Iris) to install the new version of std++.
Ralf Jung's avatar
Ralf Jung committed
103
  You may have to do `make clean` as Coq will likely complain about .vo file
104
  mismatches.