prereqs.md

Prerequisites

You will need OCaml 5.1 or later, which can be installed using opam:

opam switch create 5.1.0

For profiling with perf (Linux-only), it may be helpful to use a compiler with frame-pointers enabled instead, like this:

opam switch create 5.1.0+fp ocaml-variants.5.1.0+options ocaml-option-fp

This repository uses Git submodules. Make sure they're enabled with:

git submodule update --init --recursive

The dependencies needed for the example program are given in the tutorial.opam file, and can be installed with:

opam install --deps-only -t .

The application also requires a copy of opam-repository (note: if using the Docker build below, this isn't needed as the Docker image already has a copy):

git clone https://github.com/ocaml/opam-repository.git

You should then be able to build the examples with:

dune build

Docker

There is also a Dockerfile, which can be used to create a Docker container with the examples built.

docker build -t icfp .

This is an easy way to use Linux profiling tools on macos or Windows machines. It takes a while to build, so it's a good idea to do that ahead of time.

ThreadSanitizer

For finding races, you might also want a compiler with tsan enabled:

sudo apt install libunwind-dev
opam switch create 5.1.0+tsan

Warning: you will need plenty of memory to compile some packages on this switch, and the build will fail if it runs out of memory.

The Docker image includes commented-out blocks that install a switch with ThreadSanitizer. Please uncomment the two blocks to try this. Note that at time of writing this does not work on M1/M2 macs.

Next

Eio introduction and Lwt comparison