README.md 7.29 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.1
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

53
54
55
56
57
58
59
60
61
62
63
64
Either way, you can now install Iris:
- `opam install coq-iris` will install the libraries making up the Iris logic,
  but leave it up to you to instantiate the `program_logic.language` interface
  to define a programming language for Iris to reason about.
- `opam install coq-iris-heap-lang` will additionally install HeapLang, the
  default language used by various Iris projects.

To fetch updates later, run `opam update && opam upgrade`.  However, notice that
we do not guarantee backwards-compatibility, so upgrading Iris may break your
Iris-using developments.  If you want to be notified of breaking 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
65
66
notification group.

67
### Working *on* Iris
Ralf Jung's avatar
Ralf Jung committed
68

69
70
See the [contribution guide](CONTRIBUTING.md) for information on how to work on
the Iris development itself.
Ralf Jung's avatar
Ralf Jung committed
71

Ralf Jung's avatar
Ralf Jung committed
72
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed
73

74
75
76
* The folder [prelude](iris/prelude) contains modules imported everywhere in
  Iris.
* The folder [algebra](iris/algebra) contains the COFE and CMRA
Robbert Krebbers's avatar
Robbert Krebbers committed
77
  constructions as well as the solver for recursive domain equations.
78
* The folder [base_logic](iris/base_logic) defines the Iris base logic and
Robbert Krebbers's avatar
Robbert Krebbers committed
79
  the primitive connectives.  It also contains derived constructions that are
80
  entirely independent of the choice of resources.
81
  * The subfolder [lib](iris/base_logic/lib) contains some generally useful
Yusuke Matsushita's avatar
Yusuke Matsushita committed
82
    derived constructions.  Most importantly, it defines composable
Ralf Jung's avatar
Ralf Jung committed
83
84
    dynamic resources and ownership of them; the other constructions depend
    on this setup.
85
* The folder [program_logic](iris/program_logic) specializes the base logic
Robbert Krebbers's avatar
Robbert Krebbers committed
86
87
  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
88
  constructions that work for any such language.
89
* The folder [bi](iris/bi) contains the BI++ laws, as well as derived
Ralf Jung's avatar
Ralf Jung committed
90
  connectives, laws and constructions that are applicable for general BIS.
91
* The folder [proofmode](iris/proofmode) contains
92
93
94
  [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
95
  [proof_mode.md](docs/proof_mode.md).
96
* The folder [heap_lang](iris_heap_lang) defines the ML-like concurrent heap
Robbert Krebbers's avatar
Robbert Krebbers committed
97
  language
98
  * The subfolder [lib](iris_heap_lang/lib) contains a few derived
Robbert Krebbers's avatar
Robbert Krebbers committed
99
    constructions within this language, e.g., parallel composition.
Ralf Jung's avatar
Ralf Jung committed
100
    For more examples of using Iris and heap_lang, have a look at the
Ralf Jung's avatar
Ralf Jung committed
101
    [Iris Examples](https://gitlab.mpi-sws.org/iris/examples).
102
* The folder [tests](tests) contains modules we use to test our
Robbert Krebbers's avatar
Robbert Krebbers committed
103
104
  infrastructure. Users of the Iris Coq library should *not* depend on these
  modules; they may change or disappear without any notice.
105
* The folder [si_logic](iris/si_logic) defines a "plain" step-indexed logic
106
  and shows that it is an instance of the BI interface.
107

Ralf Jung's avatar
Ralf Jung committed
108
## Case Studies
Ralf Jung's avatar
Ralf Jung committed
109
110
111
112

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

Ralf Jung's avatar
Ralf Jung committed
126
## Further Resources
127

128
129
Getting along with Iris in Coq:

Ralf Jung's avatar
Ralf Jung committed
130
131
* Iris proof patterns and conventions are documented in the
  [proof guide](docs/proof_guide.md).
132
133
134
* Various notions of equality and logical entailment in Iris and their Coq
  interface are described in the
  [equality docs](docs/equalities_and_entailments.md).
135
* The Iris tactics are described in the
Ralf Jung's avatar
Ralf Jung committed
136
137
  [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
138
* The generated coqdoc is [available online](https://plv.mpi-sws.org/coqdoc/iris/).
139
140
141

Contacting the developers:

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

Miscellaneous:

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