README.md 6.76 KB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
1
# IRIS COQ DEVELOPMENT [[coqdoc]](https://plv.mpi-sws.org/coqdoc/iris/)
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
which includes [MoSeL](http://iris-project.org/mosel/), a general proof mode
for carrying out separation logic proofs in Coq.
Ralf Jung's avatar
Ralf Jung committed
6

Ralf Jung's avatar
Ralf Jung committed
7
8
9
10
11
For using the Coq library, check out the
[API documentation](https://plv.mpi-sws.org/coqdoc/iris/).

For understanding the theory of Iris, a LaTeX version of the core logic
definitions and some derived forms is available in
Tej Chajed's avatar
Tej Chajed committed
12
[tex/iris.tex](tex/iris.tex).  A compiled PDF version of this document is
13
[available online](http://plv.mpi-sws.org/iris/appendix-3.2.pdf).
14

Ralf Jung's avatar
Ralf Jung committed
15
16
17
## Building Iris

### Prerequisites
Ralf Jung's avatar
Ralf Jung committed
18
19
20

This version is known to compile with:

Ralf Jung's avatar
Ralf Jung committed
21
 - Coq 8.10.2 / 8.11.2 / 8.12.0
Dan Frumin's avatar
Dan Frumin committed
22
 - A development version of [std++](https://gitlab.mpi-sws.org/iris/stdpp)
Ralf Jung's avatar
Ralf Jung committed
23

Ralf Jung's avatar
Ralf Jung committed
24
25
If you need to work with Coq 8.7 or Coq 8.8, please check out the
[iris-3.2 branch](https://gitlab.mpi-sws.org/iris/iris/tree/iris-3.2).
Ralf Jung's avatar
Ralf Jung committed
26
27
For Coq 8.9, you can use the
[iris-3.3 branch](https://gitlab.mpi-sws.org/iris/iris/tree/iris-3.3).
Ralf Jung's avatar
Ralf Jung committed
28

29
### Working *with* Iris
Ralf Jung's avatar
Ralf Jung committed
30

Ralf Jung's avatar
Ralf Jung committed
31
To use Iris in your own proofs, we recommend you install Iris via opam (2.0.0 or
Ralf Jung's avatar
Ralf Jung committed
32
33
newer).  To obtain the latest stable release, you have to add the Coq opam
repository:
34
35

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

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

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

Ralf Jung's avatar
Ralf Jung committed
41
42
43
44
45
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.

46
47
48
49
50
The development version of Iris is regularly subject to breaking changes.  If
you want to be notified of such changes, please let us know your account name on
the [MPI-SWS GitLab](https://gitlab.mpi-sws.org/) so we can add you to the
notification group.

51
### Working *on* Iris
Ralf Jung's avatar
Ralf Jung committed
52

Ralf Jung's avatar
Ralf Jung committed
53
To work on Iris itself, you need to install its build-dependencies.  Again we
Ralf Jung's avatar
Ralf Jung committed
54
recommend you do that with opam (2.0.0 or newer).  This requires the following
Ralf Jung's avatar
Ralf Jung committed
55
two repositories:
Ralf Jung's avatar
Ralf Jung committed
56

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

Ralf Jung's avatar
Ralf Jung committed
60
61
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
62

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

Ralf Jung's avatar
Ralf Jung committed
66
67
68
69
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
70
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed
71

Robbert Krebbers's avatar
Robbert Krebbers committed
72
73
74
75
* 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
76
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
77
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
Ralf Jung's avatar
Ralf Jung committed
78
79
80
    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
81
82
83
* 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
84
  constructions that work for any such language.
Ralf Jung's avatar
Ralf Jung committed
85
86
* The folder [bi](theories/bi) contains the BI++ laws, as well as derived
  connectives, laws and constructions that are applicable for general BIS.
87
88
89
90
* The folder [proofmode](theories/proofmode) contains
  [MoSeL](http://iris-project.org/mosel/), which extends Coq with contexts for
  intuitionistic and spatial BI++ assertions. It also contains tactics for
  interactive proofs. Documentation can be found in
Tej Chajed's avatar
Tej Chajed committed
91
  [proof_mode.md](docs/proof_mode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
92
93
94
95
* 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
96
    For more examples of using Iris and heap_lang, have a look at the
Ralf Jung's avatar
Ralf Jung committed
97
    [Iris Examples](https://gitlab.mpi-sws.org/iris/examples).
Robbert Krebbers's avatar
Robbert Krebbers committed
98
99
100
* 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.
101

Ralf Jung's avatar
Ralf Jung committed
102
## Case Studies
Ralf Jung's avatar
Ralf Jung committed
103
104
105
106

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

Ralf Jung's avatar
Ralf Jung committed
107
* [Iris Examples](https://gitlab.mpi-sws.org/iris/examples) is where we
Ralf Jung's avatar
Ralf Jung committed
108
  collect miscellaneous case studies that do not have their own repository.
Ralf Jung's avatar
Ralf Jung committed
109
* [LambdaRust](https://gitlab.mpi-sws.org/iris/lambda-rust) is a Coq
Ralf Jung's avatar
Ralf Jung committed
110
  formalization of the core Rust type system.
Ralf Jung's avatar
Ralf Jung committed
111
112
* [GPFSL](https://gitlab.mpi-sws.org/iris/gpfsl) is a logic for release-acquire
  and relaxed memory.
Robbert Krebbers's avatar
Robbert Krebbers committed
113
* [Iron](https://gitlab.mpi-sws.org/iris/iron) is a linear separation logic
Ralf Jung's avatar
Ralf Jung committed
114
  built on top of Iris for precise reasoning about resources (such as making
Robbert Krebbers's avatar
Robbert Krebbers committed
115
  sure there are no memory leaks).
116
117
118
* [Actris](https://gitlab.mpi-sws.org/iris/actris) is a separation logic
  built on top of Iris for session-type based reasoning of message-passing
  programs.
119

Ralf Jung's avatar
Ralf Jung committed
120
## Further Resources
121

122
123
Getting along with Iris in Coq:

Ralf Jung's avatar
Ralf Jung committed
124
125
* Iris proof patterns and conventions are documented in the
  [proof guide](docs/proof_guide.md).
126
* The Iris tactics are described in the
Ralf Jung's avatar
Ralf Jung committed
127
128
  [the Iris Proof Mode (IPM) / MoSeL documentation](docs/proof_mode.md) as well as the
  [HeapLang documentation](docs/heap_lang.md).
Ralf Jung's avatar
tweaks    
Ralf Jung committed
129
* The generated coqdoc is [available online](https://plv.mpi-sws.org/coqdoc/iris/).
130
131
132

Contacting the developers:

Ralf Jung's avatar
Ralf Jung committed
133
134
135
136
137
* Discussion about the Iris Coq development happens on the mailing list
  [iris-club@lists.mpi-sws.org](https://lists.mpi-sws.org/listinfo/iris-club)
  and in the [Iris Chat](https://mattermost.mpi-sws.org/iris).  This is also the
  right place to ask questions.  The chat requires an account at the
  [MPI-SWS GitLab](https://gitlab.mpi-sws.org/users/sign_in) (use the "Register"
Ralf Jung's avatar
Ralf Jung committed
138
139
  tab). If you have trouble joining the chat, please contact
  [Ralf](https://gitlab.mpi-sws.org/jung).
Ralf Jung's avatar
Ralf Jung committed
140
* If you want to report a bug, please use the
Ralf Jung's avatar
Ralf Jung committed
141
  [issue tracker](https://gitlab.mpi-sws.org/iris/iris/issues), which also
Ralf Jung's avatar
Ralf Jung committed
142
143
  requires an MPI-SWS GitLab account.
* To contribute to Iris itself, see the [contribution guide](CONTRIBUTING.md).
144
145
146
147

Miscellaneous:

* Information on how to set up your editor for unicode input and output is
Tej Chajed's avatar
Tej Chajed committed
148
  collected in [editor.md](docs/editor.md).
149
* If you are writing a paper that uses Iris in one way or another, you could use
Ralf Jung's avatar
Ralf Jung committed
150
  the [Iris LaTeX macros](tex/iris.sty) for typesetting the various Iris
151
  connectives.