README.md 7.41 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
18
19
20
21
22
23
24
25
26
## Side-effects

Importing Iris has some side effects as the library sets some global options.

* First of all, Iris imports std++, so the
  [std++ side-effects](https://gitlab.mpi-sws.org/iris/stdpp/#side-effects)
  apply.
* On top of that, Iris imports ssreflect, which replaces the default `rewrite`
  tactic with the ssreflect version. However, `done` is overwritten to keep
  using the std++ version of the tactic.  We also set `SsrOldRewriteGoalsOrder`
  and re-open `general_if_scope` to un-do some effects of ssreflect.

Ralf Jung's avatar
Ralf Jung committed
27
28
29
## Building Iris

### Prerequisites
Ralf Jung's avatar
Ralf Jung committed
30
31
32

This version is known to compile with:

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

Ralf Jung's avatar
Ralf Jung committed
36
37
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
38
39
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
40

41
### Working *with* Iris
Ralf Jung's avatar
Ralf Jung committed
42

Ralf Jung's avatar
Ralf Jung committed
43
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
44
45
newer).  To obtain the latest stable release, you have to add the Coq opam
repository:
46
47

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

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

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

Ralf Jung's avatar
Ralf Jung committed
53
Either way, you can now do `opam install coq-iris`.  To fetch updates later, run
Yusuke Matsushita's avatar
Yusuke Matsushita committed
54
`opam update && opam upgrade`.  However, notice that we do not guarantee
Ralf Jung's avatar
Ralf Jung committed
55
56
57
backwards-compatibility, so upgrading Iris may break your Iris-using
developments.

58
59
60
61
62
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.

63
### Working *on* Iris
Ralf Jung's avatar
Ralf Jung committed
64

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

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

Ralf Jung's avatar
Ralf Jung committed
72
73
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
74

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

Ralf Jung's avatar
Ralf Jung committed
78
79
80
81
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
82
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed
83

Robbert Krebbers's avatar
Robbert Krebbers committed
84
85
86
87
* 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
88
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
89
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
Yusuke Matsushita's avatar
Yusuke Matsushita committed
90
    derived constructions.  Most importantly, it defines composable
Ralf Jung's avatar
Ralf Jung committed
91
92
    dynamic resources and ownership of them; the other constructions depend
    on this setup.
Robbert Krebbers's avatar
Robbert Krebbers committed
93
94
95
* 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
96
  constructions that work for any such language.
Ralf Jung's avatar
Ralf Jung committed
97
98
* The folder [bi](theories/bi) contains the BI++ laws, as well as derived
  connectives, laws and constructions that are applicable for general BIS.
99
100
101
102
* 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
103
  [proof_mode.md](docs/proof_mode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
104
105
106
107
* 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
108
    For more examples of using Iris and heap_lang, have a look at the
Ralf Jung's avatar
Ralf Jung committed
109
    [Iris Examples](https://gitlab.mpi-sws.org/iris/examples).
Robbert Krebbers's avatar
Robbert Krebbers committed
110
111
112
* 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.
113
114
* The folder [si_logic](theories/si_logic) defines a "plain" step-indexed logic
  and shows that it is an instance of the BI interface.
115

Ralf Jung's avatar
Ralf Jung committed
116
## Case Studies
Ralf Jung's avatar
Ralf Jung committed
117
118
119
120

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
121
* [Iris Examples](https://gitlab.mpi-sws.org/iris/examples) is where we
Ralf Jung's avatar
Ralf Jung committed
122
  collect miscellaneous case studies that do not have their own repository.
Ralf Jung's avatar
Ralf Jung committed
123
* [LambdaRust](https://gitlab.mpi-sws.org/iris/lambda-rust) is a Coq
Ralf Jung's avatar
Ralf Jung committed
124
  formalization of the core Rust type system.
Ralf Jung's avatar
Ralf Jung committed
125
126
* [GPFSL](https://gitlab.mpi-sws.org/iris/gpfsl) is a logic for release-acquire
  and relaxed memory.
Robbert Krebbers's avatar
Robbert Krebbers committed
127
* [Iron](https://gitlab.mpi-sws.org/iris/iron) is a linear separation logic
Ralf Jung's avatar
Ralf Jung committed
128
  built on top of Iris for precise reasoning about resources (such as making
Robbert Krebbers's avatar
Robbert Krebbers committed
129
  sure there are no memory leaks).
130
131
132
* [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.
133

Ralf Jung's avatar
Ralf Jung committed
134
## Further Resources
135

136
137
Getting along with Iris in Coq:

Ralf Jung's avatar
Ralf Jung committed
138
139
* Iris proof patterns and conventions are documented in the
  [proof guide](docs/proof_guide.md).
140
* The Iris tactics are described in the
Ralf Jung's avatar
Ralf Jung committed
141
142
  [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
143
* The generated coqdoc is [available online](https://plv.mpi-sws.org/coqdoc/iris/).
144
145
146

Contacting the developers:

Ralf Jung's avatar
Ralf Jung committed
147
148
149
150
151
* 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
152
153
  tab). If you have trouble joining the chat, please contact
  [Ralf](https://gitlab.mpi-sws.org/jung).
Ralf Jung's avatar
Ralf Jung committed
154
* If you want to report a bug, please use the
Ralf Jung's avatar
Ralf Jung committed
155
  [issue tracker](https://gitlab.mpi-sws.org/iris/iris/issues), which also
Ralf Jung's avatar
Ralf Jung committed
156
157
  requires an MPI-SWS GitLab account.
* To contribute to Iris itself, see the [contribution guide](CONTRIBUTING.md).
158
159
160
161

Miscellaneous:

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