Hadrian: support dynamically linking ghc
[ghc.git] / hadrian / doc / cross-compile.md
1 ## Build a cross-compiling GHC
2
3 In this example, our host machine is "Ubuntu 16.04.2 LTS, Linux ubuntu 4.4.0-79-generic 86_64".
4
5 We need to download necessary tools, including:
6
7 - [LLVM-4.0 source](http://releases.llvm.org/4.0.0/llvm-4.0.0.src.tar.xz), you need to build it yourself. Remember to choose release channel and use gold linker (`cmake -DCMAKE_BUILD_TYPE=Release -DLLVM_USE_LINKER=gold ..`)
8 - `sudo apt-get install gcc-arm-linux-gnueabihf` to install the GCC cross-compiler
9 - Download and install [Haskell Platform 8.0.2](https://haskell.org/platform/download/8.0.2/haskell-platform-8.0.2-unknown-posix--full-x86_64.tar.gz). Install it according to [instructions here](https://www.haskell.org/platform/linux.html#linux-generic)
10
11 After all the dependencies are in place:
12
13 - `git clone https://github.com/ghc/ghc`
14 - `cd ghc`
15 - `git clone https://github.com/snowleopard/hadrian`
16 - `git submodule update --init`
17 - `./configure --target=arm-linux-gnueabihf`
18 - `cd hadrian`
19 - Modify `src/UserSettings.hs`, set `stage1Only` to `True`.
20 - Build the compiler by e.g. `./build.sh --flavour=quickest --integer-simple -V -j`
21
22 After that, you should have built `inplace/bin/ghc-stage1` cross compiler. We will go to the next section to validate this.
23
24 **NOTE**: Use of `-c` to configure the target is currently not supported. Please manually run `./configure` like above.
25
26 ## Test run
27
28 Write a simple hello world haskell program:
29
30 ```haskell
31 module Main where
32 main = putStrLn "Hello, world!"
33 ```
34 Compile it with cross-compiling GHC: `<ghc-folder>/inplace/bin/ghc-stage1 -static Main`. Note that we created a static version of it which packs together all depending libraries.
35
36 - Install QEMU: `sudo apt-get install qemu-system-arm`
37 - Download `vmlinuz` (kernel) and `initrd.gz` (initial ramdisk), e.g. from [this mirror](https://mirrors.tuna.tsinghua.edu.cn/ubuntu-ports/dists/xenial/main/installer-armhf/current/images/generic-lpae/cdrom/).
38 - Add the ARM Linux executable `Main` to the initial ramdisk so we can load it directly into memory. No need for real installation
39   + `gunzip initrd.gz` to get `initrd`
40   + `mkdir tmp2; cd tmp2; sudo cpio -id < ../initrd` to get a file system
41   + `cp /PATH/TO/Main usr/bin`
42   + `find . | cpio --create --format='newc' > /tmp/newinitrd` to pack back the `initrd`
43   + `gzip /tmp/newinitrd`
44   + Move `newinitrd` to where `vmlinuz` is, rename it to `newinitrd.img`
45   + Run the following configured QEMU:
46
47 ```bash
48 #!/bin/sh
49 qemu-system-arm \
50     -kernel vmlinuz \
51     -initrd newinitrd.img \
52     -append "root=/dev/vda2 rootfstype=ext4" \
53     -no-reboot \
54     -nographic \
55     -m 1024 \
56     -M virt
57 ```
58
59 This will lead you to a installer interface. But we don't need to do that, so we can save ourself from the hassle of setting up networks etc. We just keep `Go Back`, until see a line `Execute a shell`, and select it. Now you get a shell, go find `/usr/bin/Main` and run it!