decrn / iris-tutorial-notes

Iris Tutorial

The Iris Tutorial is an introduction to the Iris separation logic framework and how to work with its Coq formalization.

The exposition is intended for a broad range of readers from advanced undergraduates to PhD students and researchers. In its current form, the tutorial material is intended as a supplement to the Iris Lecture Notes. No specific background in logic or programming languages is assumed but some familiarity with basic programming languages theory and discrete mathematics will be beneficial, see e.g. TAPL.

The tutorial comes in two versions:

• The folder exercises: a skeleton development with exercises left admitted.
• The folder theories: the full development with solutions.

It is recommended that you go through the tutorial in the order specified in Overview.

Setup

This version is known to compile with

• Coq 8.17.1
• Iris 4.0.0

The recommended way to install the dependencies is through opam.

1. Install opam if not already installed (a version greater than 2.0 is required).
2. Install a new switch and link it to the project.

opam switch create iris_tutorial 4.14.0
opam switch link iris_tutorial .

3. Add the Coq and Iris opam repositories.

opam repo add coq-released https://coq.inria.fr/opam/released
opam repo add iris-dev https://gitlab.mpi-sws.org/iris/opam.git
opam update

4. Install the right version of the dependencies as specified in the iris-tutorial.opam file.

opam install . --deps-only

Editor

Iris makes extensive use of Unicode characters. This guide describes how to set up your favorite editor.

Overview

• base - Introduction to the Iris Proof Mode
  • pure - Distinction between the Coq context and the Iris context
  • persistently - The 3rd context
• lang - Introduction to HeapLang
  • later - Recursive functions
• linked_lists - Linked lists
  • fixpoint - Fixpoints of propositions
• arrays - Arrays in HeapLang
  • merge_sort - Merge sort
• invariants - Invariants
• resource_algebra - Introduction to cameras.
  • counter - The authoritative camera
  • spin_lock - Specification of a spin lock
  • threads - Disjoint concurrency
  • ticket_lock - Specification of a ticket lock
• adequacy - Adequacy

Exercises

To work on the exercises, simply edit the files in the exercises/ folder. Some proofs and definitions are admitted and marked as (* exercise *)---your task is to fill in those definitions and complete the proofs all the way to Qed.

After you are done with a file, run make (with your working directory being the repository root, where the Makefile is located) to compile and check the exercises.

If you are stuck, you can find solutions in the corresponding file in the theories/ folder.

Documentation

This cheatsheet contains a table of the most important tactics for each logical connective. A full description of the Iris Proof Mode tactics can be found in the files proof_mode.md and heap_lang.md.

Generating the exercises

If you want to contribute to the tutorial, note that the files in exercises/ are generated from the corresponding files in theories/. Run make exercises to re-generate those files. This requires gawk to be installed (which should be available on Linux, and on macOS can be installed via brew install gawk).

The syntax for the solution files is as follows:

(* SOLUTION *) Proof.
  solution here.
Qed.

is replaced by

Proof.
  (* exercise *)
Admitted.

and the more powerful

(* BEGIN SOLUTION *)
  solution here.
(* END SOLUTION BEGIN TEMPLATE
  exercise template here.
END TEMPLATE *)

is replaced by

  exercise template here.