tweag/asterius
1
1
Fork 0
mirror of https://github.com/tweag/asterius.git synced 2024-09-21 05:48:04 +03:00
Code Issues Projects Releases Wiki Activity
6387dcf397
asterius/docs/building.md

2.1 KiB
Raw Blame History

Building guide

asterius is tested on Linux x64. Windows/macOS x64 may also work.

A pre-built Docker image is provided for your convenience.

Using a pre-built Docker image

We build and test Docker images on CircleCI. They are pushed to terrorjack/asterius, the tags are git revisions. terrorjack/asterius:latest correspond to latest revision on master.

Put input program in a directory (e.g. ~/mirror), then map the directory to a Docker volume:

terrorjack@ubuntu:~$ docker run -it -v ~/mirror:/mirror terrorjack/asterius
root@76bcb511663d:~# cd /mirror
root@76bcb511663d:/mirror# ahc-link --help
...

Building custom ghc

asterius requires a forked ghc which can be found here. We are looking forward to building asterius with vanilla ghc-head in the long run, but at the moment, we use our own ghc fork so it's easy to test radical changes on ghc itself.

The building guide of ghc can be found here.

On Linux/macOS, a prebuilt ghc tarball is provided. It's already included in stack.yaml. Note that the Windows bindist does not provide prof libs/haddock (due to AppVeyor build time restriction).

Extra dependencies

Besides the custom ghc, these dependencies are also required:

  • cmake/make/g++: For building in-tree binaryen
  • autoconf: For booting ghc-prim/base
  • nodejs: For running tests. Ensure the latest version is used, since we rely on some recent V8 experimental features (e.g. BigInt support)
  • stack: Someday cabal may also work, no specific obstacles anyway.

Building asterius

stack build asterius. That's it. Set MAKEFLAGS=-j8 to pass flags to make for parallel building of binaryen.

After the dust settles, run stack exec ahc-boot to perform booting. Set the ASTERIUS_DEBUG environment variable to make ahc-boot print IRs to text files which are useful when debugging compiled code of standard libraries. Be aware that this flag slows down the booting process significantly!