Skip to content
Snippets Groups Projects
README.md 6.43 KiB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
# IRIS COQ DEVELOPMENT [[coqdoc]](https://plv.mpi-sws.org/coqdoc/iris/)
Ralf Jung's avatar
Ralf Jung committed

Ralf Jung's avatar
Ralf Jung committed
This is the Coq development of the [Iris Project](http://iris-project.org),
Ralf Jung's avatar
Ralf Jung committed
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

Ralf Jung's avatar
Ralf Jung committed
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
[tex/iris.tex](tex/iris.tex).  A compiled PDF version of this document is
[available online](http://plv.mpi-sws.org/iris/appendix-3.2.pdf).
Ralf Jung's avatar
Ralf Jung committed
## Building Iris

### Prerequisites
Ralf Jung's avatar
Ralf Jung committed

This version is known to compile with:

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

For a version compatible with Coq 8.6, have a look at the
Ralf Jung's avatar
Ralf Jung committed
[iris-3.1 branch](https://gitlab.mpi-sws.org/iris/iris/tree/iris-3.1).
Ralf Jung's avatar
Ralf Jung committed
If you need to work with Coq 8.5, please check out the
Ralf Jung's avatar
Ralf Jung committed
[iris-3.0 branch](https://gitlab.mpi-sws.org/iris/iris/tree/iris-3.0).
Ralf Jung's avatar
Ralf Jung committed

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

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

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

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

Ralf Jung's avatar
Ralf Jung committed
    opam repo add iris-dev https://gitlab.mpi-sws.org/iris/opam.git
Ralf Jung's avatar
Ralf Jung committed
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.

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

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

Ralf Jung's avatar
Ralf Jung committed
    opam repo add coq-released https://coq.inria.fr/opam/released
Ralf Jung's avatar
Ralf Jung committed
    opam repo add iris-dev https://gitlab.mpi-sws.org/iris/opam.git
Ralf Jung's avatar
Ralf Jung committed
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

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

Ralf Jung's avatar
Ralf Jung committed
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
## Directory Structure
Ralf Jung's avatar
Ralf Jung committed

Robbert Krebbers's avatar
Robbert Krebbers committed
* 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
  entirely independent of the choice of resources.
Robbert Krebbers's avatar
Robbert Krebbers committed
  * The subfolder [lib](theories/base_logic/lib) contains some generally useful
    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
* 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
  constructions that work for any such language.
* The folder [bi](theories/bi) contains the BI++ laws, as well as derived
  connectives, laws and constructions that are applicable for general BIS.
* 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
  [proof_mode.md](docs/proof_mode.md).
Robbert Krebbers's avatar
Robbert Krebbers committed
* 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
    For more examples of using Iris and heap_lang, have a look at the
Ralf Jung's avatar
Ralf Jung committed
    [Iris Examples](https://gitlab.mpi-sws.org/iris/examples).
Robbert Krebbers's avatar
Robbert Krebbers committed
* 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.
## Case Studies
Ralf Jung's avatar
Ralf Jung committed

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
* [Iris Examples](https://gitlab.mpi-sws.org/iris/examples) is where we
Ralf Jung's avatar
Ralf Jung committed
  collect miscellaneous case studies that do not have their own repository.
Ralf Jung's avatar
Ralf Jung committed
* [LambdaRust](https://gitlab.mpi-sws.org/iris/lambda-rust) is a Coq
Ralf Jung's avatar
Ralf Jung committed
  formalization of the core Rust type system.
Ralf Jung's avatar
Ralf Jung committed
* [GPFSL](https://gitlab.mpi-sws.org/iris/gpfsl) is a logic for release-acquire
  and relaxed memory.
* [Iron](https://gitlab.mpi-sws.org/iris/iron) is a linear separation logic
Ralf Jung's avatar
Ralf Jung committed
  built on top of Iris for precise reasoning about resources (such as making
  sure there are no memory leaks).
Ralf Jung's avatar
Ralf Jung committed
## Further Resources
Getting along with Iris in Coq:

Ralf Jung's avatar
Ralf Jung committed
* Iris proof patterns are documented in the [proof guide](docs/proof_guide.md).
* Syntactic conventions are described in the [style guide](docs/style_guide.md).
* The Iris tactics are described in the
Ralf Jung's avatar
Ralf Jung committed
  [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
Ralf Jung committed
* The generated coqdoc is [available online](https://plv.mpi-sws.org/coqdoc/iris/).

Contacting the developers:

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

Miscellaneous:

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