Skip to content

Latest commit

 

History

History
181 lines (138 loc) · 6.35 KB

setup.md

File metadata and controls

181 lines (138 loc) · 6.35 KB
Raw

Proof and Isabelle Dependencies

Proof Dependencies

Linux Packages - Debian

On Buster or Bullseye, to run all proofs against the ARMv7-A architecture you will need to install the following packages:

sudo apt-get install \
    python3 python3-pip python3-dev \
    gcc-arm-none-eabi build-essential libxml2-utils ccache \
    ncurses-dev librsvg2-bin device-tree-compiler cmake \
    ninja-build curl zlib1g-dev texlive-fonts-recommended \
    texlive-latex-extra texlive-metapost texlive-bibtex-extra \
    rsync

There is no package for the MLton compiler on Buster or Bullseye, so you will need to install it from the MLton website.

The Haskell Stack package is unavailable on Bullseye and out-of-date on Buster, so you will need to install it from the Haskell Stack website.

Linux Packages - Ubuntu

On Ubuntu 18.04, to run all proofs against the ARMv7-A architecture you will need to install the following packages:

sudo apt-get install \
    python3 python3-pip python3-dev \
    gcc-arm-none-eabi build-essential libxml2-utils ccache \
    ncurses-dev librsvg2-bin device-tree-compiler cmake \
    ninja-build curl zlib1g-dev texlive-fonts-recommended \
    texlive-latex-extra texlive-metapost texlive-bibtex-extra \
    mlton-compiler haskell-stack

Python

The build system for the seL4 kernel requires several python packages:

sudo pip3 install --upgrade pip
sudo pip3 install sel4-deps

Haskell Stack

After installing haskell-stack, make sure you've adjusted your PATH to include $HOME/.local/bin, and that you're running an up-to-date version:

stack upgrade --binary-only
which stack # should be $HOME/.local/bin/stack

MacOS

Other than the cross-compiler gcc toolchain, setup on MacOS should be similar to that on Ubuntu. To set up a cross-compiler, try the following:

  • Install XCode from the AppStore and its command line tools. If you are running MacPorts or homebrew, you have these already. Otherwise, after you have XCode installed, run gcc --version in a terminal window. If it reports a version, you're set. Otherwise it should pop up a window and prompt for installation of the command line tools.
  • Install the seL4 Python dependencies, for instance using sudo easy_install sel4-deps. easy_install is part of Python's setuptools.
  • Install the misc/scripts/cpp wrapper for clang, by putting it in ~/bin, or somewhere else in your PATH.

Isabelle Setup

After the repository is set up using repo with seL4/verification-manifest, you should have following directory structure, where l4v is the repository you are currently looking at:

verification/
    HOL4/
    graph-refine/
    isabelle/
    l4v/
    seL4/

To set up Isabelle for use in l4v/, assuming you have no previous installation of Isabelle, run the following commands in the directory verification/l4v/:

mkdir -p ~/.isabelle/etc
cp -i misc/etc/settings ~/.isabelle/etc/settings
./isabelle/bin/isabelle components -a
./isabelle/bin/isabelle jedit -bf
./isabelle/bin/isabelle build -bv HOL

These commands perform the following steps:

  • create an Isabelle user settings directory.
  • install L4.verified Isabelle settings. These settings initialise the Isabelle installation to use the standard Isabelle contrib tools from the Munich Isabelle repository and set up paths such that multiple Isabelle repository installations can be used side by side without interfering with each other.
  • download contrib components from the Isabelle repository. This includes Scala, a Java JDK, PolyML, and multiple external provers. You should download these, even if you have these tools previously installed elsewhere to make sure you have the right versions. Depending on your internet connection, this may take some time.
  • compile and build the Isabelle PIDE jEdit interface.
  • build basic Isabelle images to ensure that the installation works. This may take a few minutes.

Alternatively, it is possible to use the official Isabelle2021 release bundle for your platform from the Isabelle website. In this case, the installation steps above can be skipped, and you would replace the directory verification/isabelle/ with a symbolic link to the Isabelle home directory of the release version. Note that this is not recommended for development, since Google repo will overwrite this link when you synchronise repositories and Isabelle upgrades will have to be performed manually as development progresses.

PIDE Tools

The following tools and tips can make writing proofs easier and more efficient when using the Isabelle PIDE jEdit interface.

WhiteSpace plugin

The WhiteSpace plugin can highlight normally invisible whitespace characters such as tabs and spaces, and can remove trailing whitespace on save. To install and configure the WhiteSpace plug-in for jEdit, follow the instructions below.

  1. Go to Plugins -> Plugin manager -> Install.
  2. Search for WhiteSpace and install the plugin.
  3. Go to Plugins -> Plugin Options -> WhiteSpace -> On save actions.
  4. Check "Remove trailing whitespace" and click Apply.

Key bindings for Navigator

The Isabelle PIDE provides "Back" and "Forward" actions that allow you to easily navigate to previous positions in your edit history. Follow the steps below to bind a key to the "Back" function. We recommend [ctrl]+[`].

  1. Go to Utilities -> Global Options -> jEdit -> Shortcuts.
  2. Select Action Set -> Plugin: Navigator.
  3. Set a shortcut for Back.

Go-to-error macro

Run the following commands in the directory verification/l4v/:

mkdir -p ~/.isabelle/jedit/macros
cp misc/jedit/macros/goto-error.bsh ~/.isabelle/jedit/macros/.

You can add keybindings for this macro in the usual way, by going to Utilities -> Global Options -> jEdit -> Shortcuts.