README.md 6.06 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 12 13
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
[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).
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.7.1 / 8.7.2 / 8.8.0 / 8.8.1 / 8.8.2
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

24 25
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
26 27 28
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).

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

Ralf Jung's avatar
Ralf Jung committed
31 32 33
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:
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/FP/opam-dev.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
### Working *on* Iris
Ralf Jung's avatar
Ralf Jung committed
47

Ralf Jung's avatar
Ralf Jung committed
48 49 50
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
51

Ralf Jung's avatar
Ralf Jung committed
52 53
    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
54

Ralf Jung's avatar
Ralf Jung committed
55 56
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
57

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

Ralf Jung's avatar
Ralf Jung committed
61 62 63 64
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
65
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed
66

Robbert Krebbers's avatar
Robbert Krebbers committed
67 68 69 70
* 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
71
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
72
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
73 74 75
    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
76 77 78
* 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
79
  constructions that work for any such language.
Ralf Jung's avatar
Ralf Jung committed
80 81
* The folder [bi](theories/bi) contains the BI++ laws, as well as derived
  connectives, laws and constructions that are applicable for general BIS.
82 83 84 85
* 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
Robbert Krebbers's avatar
Robbert Krebbers committed
86
  [ProofMode.md](ProofMode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
87 88 89 90
* 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
91 92
    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
93 94 95
* 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.
96

Ralf Jung's avatar
Ralf Jung committed
97
## Case Studies
Ralf Jung's avatar
Ralf Jung committed
98 99 100 101

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
102
* [Iris Examples](https://gitlab.mpi-sws.org/iris/examples) is where we
Ralf Jung's avatar
Ralf Jung committed
103 104 105
  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.
106 107
* [iGPS](https://gitlab.mpi-sws.org/FP/sra-gps/tree/gen_proofmode_WIP) is a
  logic for release-acquire memory.
Ralf Jung's avatar
Ralf Jung committed
108
* [Iris Atomic](https://gitlab.mpi-sws.org/iris/atomic) is an experimental
Ralf Jung's avatar
Ralf Jung committed
109
  formalization of logically atomic triples in Iris.
110 111 112
* [Iron](https://gitlab.mpi-sws.org/iris/iron) is a linear separation logic
  build on top of Iris for precise reasoning about resources (such as making
  sure there are no memory leaks).
113

Ralf Jung's avatar
Ralf Jung committed
114
## Further Resources
115

Ralf Jung's avatar
Ralf Jung committed
116 117 118 119 120
* 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) / MoSeL is documented at [ProofMode.md](ProofMode.md).
* Naming conventions are documented at [Naming.md](Naming.md).
* The generated coqdoc is [available online](https://plv.mpi-sws.org/coqdoc/iris/).
Ralf Jung's avatar
Ralf Jung committed
121 122 123 124 125 126 127 128 129 130
* 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"
  tab).
* If you want to report a bug, please use the
  [issue tracker](https://gitlab.mpi-sws.org/FP/iris-coq/issues), which also
  requires an MPI-SWS GitLab account.
* To contribute to Iris itself, see the [contribution guide](CONTRIBUTING.md).