README.md 4.32 KB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
1 2
# IRIS COQ DEVELOPMENT

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

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

This version is known to compile with:

Ralf Jung's avatar
Ralf Jung committed
9
 - Coq 8.6.1 / 8.7.0 / 8.7.1
Ralf Jung's avatar
Ralf Jung committed
10
 - Ssreflect 1.6.4
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 15
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).

Ralf Jung's avatar
Ralf Jung committed
16 17 18 19
## Installing via opam

To obtain the latest stable release via opam, you have to add the Coq opam
repository:
20 21

    opam repo add coq-released https://coq.inria.fr/opam/released
Ralf Jung's avatar
Ralf Jung committed
22 23 24 25 26

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
27
    opam repo add iris-dev https://gitlab.mpi-sws.org/FP/opam-dev.git
28

Ralf Jung's avatar
Ralf Jung committed
29
## Building from source
Ralf Jung's avatar
Ralf Jung committed
30

Ralf Jung's avatar
Ralf Jung committed
31 32
When building Iris from source, we recommend to use opam for installing Iris's dependencies.
This requires the following two repositories:
Ralf Jung's avatar
Ralf Jung committed
33

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

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

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

Ralf Jung's avatar
Ralf Jung committed
43 44 45 46
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
47
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed
48

Robbert Krebbers's avatar
Robbert Krebbers committed
49 50 51 52
* 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
53
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
54
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
Ralf Jung's avatar
Ralf Jung committed
55 56 57
    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
58 59 60
* 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
61
  constructions that work for any such language.
Robbert Krebbers's avatar
Robbert Krebbers committed
62 63 64
* The folder [proofmode](theories/proofmode) contains the Iris proof mode, which
  extends Coq with contexts for persistent and spatial Iris assertions. It also
  contains tactics for interactive proofs in Iris. Documentation can be found in
Robbert Krebbers's avatar
Robbert Krebbers committed
65
  [ProofMode.md](ProofMode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
66 67 68 69
* 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
70 71
    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
72 73 74
* 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.
75

Ralf Jung's avatar
Ralf Jung committed
76
## Documentation
77 78

A LaTeX version of the core logic definitions and some derived forms is
79
available in [docs/iris.tex](docs/iris.tex).  A compiled PDF version of this
Ralf Jung's avatar
Ralf Jung committed
80 81
document is [available online](http://plv.mpi-sws.org/iris/appendix-3.1.pdf).

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

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

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

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