armv7: make compile on Ubuntu 14.04 (GCC 4.8.2)
[barrelfish] / README
1 ##########################################################################
2 Copyright (c) 2009-2016, ETH Zurich.
3 All rights reserved.
4
5 This file is distributed under the terms in the attached LICENSE file.
6 If you do not find this file, copies can be found by writing to:
7 ETH Zurich D-INFK, Universitaetsstrasse 6, CH-8092 Zurich. Attn: Systems Group.
8 ##########################################################################
9
10 Barrelfish Overview
11 --------------------------------
12
13 Barrelfish currently runs on:
14
15  * x86 CPUs in either IA-32 or AMD64 mode. The following are known to work:
16
17    - Intel Xeon Clovertown, Gainestown, Beckton, IvyBridge, Haswell (X5355,
18      E5520, X7560, L5520, L7555, E5-2670v2, E3-1245v3)
19    - AMD Opteron Italy, Santa Rosa, Barcelona, Shanghai, Istanbul, Magny Cours
20      (275, 2220, 8350, 8374, 8380, 8431, 6174)
21    - QEMU simulator (2.0.0)
22
23  * ARM CPUs, specifically ARMv7 and ARMv5. The following platforms are known to work:
24
25    - The integratorcp ARMv5 machine as simulated by QEM
26    - The Texas Instruments OMAP4460 Pandaboard ES SoC
27      (Barrelfish runs on both the A9 and the M3 cores)
28    - The ARM VExpress EMM board as simulated by GEM5
29    - There is also limited support for the Netronome i8000 card, incorporating
30      a single Intel iXP2800 processor
31
32 This README file provides instructions for the x86 architecture. For other
33 architectures, please refer to the architecture-specific technical notes (e.g.,
34 see TN 06 for the SCC, and TN 17 for ARM).
35
36 You can either generate the latest documentation from this source-code
37 (instructions at end of this file), or visit the Barrelfish_ website
38 to download them.
39
40 .. _Barrelfish: http://www.barrelfish.org/
41
42 Supported PC hardware
43 --------------------------------
44
45 Barrelfish supports following PC hardware :
46
47  * x86 CPUs in either IA-32 or AMD64 mode. The following are known to work:
48
49    - Intel Xeon Clovertown, Gainestown, Beckton, Ivy Bridge, Haswell (X5355,
50      E5520, X7560, L5520, L7555, E5-2670v2, E3-1245v3)
51    - AMD Opteron Italy, Santa Rosa, Barcelona, Shanghai, Istanbul, Magny Cours
52      (275, 2220, 8350, 8374, 8380, 8431, 6174)
53       * Note: the Opteron 275 do not work in IA-32 mode.
54
55 The biggest compatibility problems are likely to be in the PCI/ACPI code. We
56 usually discover new quirks (or missing functionality in the ACPI glue code)
57 on each new machine we test. The following systems are known to work:
58
59  * Intel x5000XVN
60  * Tyan n6650W and S4985
61  * Supermicro H8QM3-2
62  * Dell PowerEdge R610 and R905
63  * Sun Fire X2270 and X4440
64  * Intel/Quanta QSSC-S4R
65  * Lenovo X200 and X301 laptops
66  * ASUS Eee PC 1015PEM netbooks
67
68 The e1000n driver should work with most recent Intel gigabit ethernet
69 controllers (see the list in devices/e1000.dev). We've mostly used the
70 82572EI (PCI device ID 0x1082).
71
72 You should also be able to boot Barrelfish on a recent version of QEMU (0.14);
73 note that the e1000 device emulated by QEMU is not supported by our driver.
74
75 Required Tools
76 --------------------------------
77
78 Our toolchain tracks Ubuntu LTS releases, and this is what we use to
79 run our nightly tests.  If you are running Ubuntu LTS (14.04.3 at time
80 of writing), this means the following:
81
82  * GCC 4.8.2 for x86_64 and x86_32
83    - cross-compiling between i386 and x86_64 works (install package
84      gcc-multilib on 64 bit Ubuntu LTS)
85  * GCC 4.7.3 for ARMv5 and ARMv7
86    - Install packages gcc-arm-linux-gnueabi and g++-arm-linux-gnueabi on Ubuntu LTS
87  * GNU binutils (2.24 is known to work)
88  * GNU make
89  * GHC v7.6.3 and Parsec 3.1
90    - older versions of the tree supported v6.10 or v6.12.2 with Parsec
91      2.1 or v7.4 with Parsec 3.1; GHC v6.12.1 has a known bug and is
92      unable to build our tools, but now earlier versions of GHC are
93      unsupported.
94    - On Ubuntu LTS, install the following packages: 
95      libghc-mtl-dev libghc-ghc-mtl-dev cabal-install libghc-src-exts-dev
96      libghc-async-dev libghc-ghc-paths-dev libghc-parsec3-dev
97      libghc-random-dev freebsd-glue libelf-freebsd-dev
98    - Then, run cabal-install bytestring-trie
99
100 Building
101 --------------------------------
102
103 1. Assuming you have already unpacked the sources, create a build directory ::
104
105     $ mkdir build && cd build
106
107 1. Run ``hake.sh``, giving it the path to the source directory and target
108 architecture(s) ::
109
110     $ ../hake/hake.sh -s ../ -a x86_64
111
112 This will configure the build directory and use GHC to compile and then run
113 hake, a tool used to generate the ``Makefile``.
114
115 3. Optionally, edit the configuration parameters in ``hake/Config.hs`` and
116 run ``make rehake`` to apply them.
117
118 4. Run make, and wait ::
119
120     $ make
121
122 5. If everything worked, you should now be able to run Barrelfish inside QEMU ::
123
124     $ make sim
125
126 Installing and Booting
127 --------------------------------
128
129 Barrelfish requires a Multiboot-compliant bootloader that is capable of loading
130 an ELF64 image. At the time of writing, this doesn't include the default GRUB.
131 Your options are either:
132
133  * use the pre-loader "elver" that can be found in the tools directory
134  * patch GRUB to support a 64-bit kernel image, using this patch_.
135
136 .. _patch: http://savannah.gnu.org/bugs/?17963
137
138 "Installing" Barrelfish currently consists of copying the ELF files for the CPU
139 driver and user programs to a location that the target machine can boot from,
140 and writing a suitable menu.lst file that instructs the bootloader (GRUB) which
141 programs to load and the arguments to pass them.
142
143 If you specify an appropriate INSTALL_PREFIX, ``make install`` will copy the
144 binaries to the right place for you, eg ::
145
146     $ make install INSTALL_PREFIX=/tftpboot/barrelfish
147
148 We usually boot Barrelfish via PXE/TFTP, although loading from a local disk
149 also works. Instructions for setting up GRUB to do this are beyond the scope of
150 this document. Assuming you have such a setup, here is a sample menu.lst file
151 for a basic diskless boot that doesn't do anything useful beyond probing the
152 PCI buses and starting a basic shell ::
153
154     title   Barrelfish
155     root    (nd)
156     kernel /barrelfish/x86_64/sbin/elver
157     module /barrelfish/x86_64/sbin/cpu
158     module /barrelfish/x86_64/sbin/init
159     module /barrelfish/x86_64/sbin/mem_serv
160     module /barrelfish/x86_64/sbin/monitor
161     module /barrelfish/x86_64/sbin/ramfsd boot
162     module /barrelfish/x86_64/sbin/skb boot
163     modulenounzip /barrelfish/skb_ramfs.cpio.gz nospawn
164     module /barrelfish/x86_64/sbin/acpi boot
165     module /barrelfish/x86_64/sbin/pci boot
166     module /barrelfish/x86_64/sbin/spawnd boot
167     module /barrelfish/x86_64/sbin/serial
168     module /barrelfish/x86_64/sbin/fish
169
170 There are many other programs you can load (take a look around the usr tree for
171 examples). To start a program on a core other than the BSP core, pass
172 ``core=N`` as its first argument.
173
174 If things work, you should see output on both the VGA console and COM1.
175
176 Generating Documentation
177 --------------------------------
178
179 Barrelfish documentation can be found on Barrelfish website
180 (http://www.barrelfish.org/). And it can be also generated from the code tree.
181 For documentation generation, you will need ``latex`` packages installed,
182 including support for ``pdflatex``.  Following are the instructions for
183 generating the documentation assuming you have already unpacked the sources ::
184
185     $ mkdir build && cd build
186     $ ../hake/hake.sh -s ../
187     $ make docs
188
189 You will find all the technotes in ``docs/`` directory.
190
191 Known Issues
192 --------------------------------
193
194 There are many. Those you're likely to encounter include:
195
196  * The documentation is incomplete and out of date.
197  * Some drivers and user programs are known not to build, and are
198    not included in the default set of targets (MODULES) in the Makefile.
199
200 Likely FAQs
201 --------------------------------
202
203 Q: How do I run a program?
204 A: Add it to the boot sequence by specifying the module in your menu.lst file.
205    For example, to run the memtest program, add the line:
206        module /PATH/x86_64/sbin/memtest
207    to the end of menu.lst, where PATH is relative either to your TFTP
208    server's root directory (when booting on hardware) or to your build
209    directory (when using a simulator such as QEMU).
210    If memtest runs, you should see it output "memtest passed successfully!".
211
212 Q: Where's the CPU driver?
213 A: It's in the directory named kernel :) But don't worry, it really does run
214    independently on each core.
215
216 Q: Where is the source for the SPLASH2 benchmarks? It seems to be missing.
217 A: The license for these prevents redistribution, so we were forced to ship our
218    changes as a patch. See usr/splash2/README for further instructions.
219
220 Q: Can I use a debugger?
221 A: Maybe. There are two options at the moment:
222     * On a simulator, using whatever debug interfaces it supports.
223       For QEMU, you could try the "debugsim" target.
224     * On hardware, using the kernel-mode remote GDB stubs that operate on the
225       primary serial port and are entered in response to a kernel trap or
226       exception. However, these are not well maintained, and may not be usable
227       beyond reading/writing memory locations and inspecting the stack.
228    When debugging the kernel, beware that it is relocated to an address
229    determined at core boot time. Look for output such as:
230    "Kernel starting at address 0xffffffffc072b000".
231
232 Q: Where can I find more information, including papers and new releases?
233 A: http://www.barrelfish.org/
234    http://wiki.barrelfish.org/
235
236 Q: Can I contribute?
237 A: We'd certainly like to hear from you. Feel free to send patches (or even
238    git merge requests) to the Barrelfish mailing list.
239
240    To keep track of contributions to Barrelfish, we use a sign-off procedure
241    similar to the Linux kernel:
242
243    The sign-off is a simple line at the end of the explanation for the patch,
244    which certifies that you wrote it or otherwise have the right to pass it on
245    as an open-source patch.  The rules are pretty simple: if you can certify
246    the below:
247
248         Developer's Certificate of Origin 1.1
249
250         By making a contribution to this project, I certify that:
251
252         (a) The contribution was created in whole or in part by me and I
253             have the right to submit it under the open source license
254             indicated in the file; or
255
256         (b) The contribution is based upon previous work that, to the best
257             of my knowledge, is covered under an appropriate open source
258             license and I have the right under that license to submit that
259             work with modifications, whether created in whole or in part
260             by me, under the same open source license (unless I am
261             permitted to submit under a different license), as indicated
262             in the file; or
263
264         (c) The contribution was provided directly to me by some other
265             person who certified (a), (b) or (c) and I have not modified
266             it.
267
268         (d) I understand and agree that this project and the contribution
269             are public and that a record of the contribution (including all
270             personal information I submit with it, including my sign-off) is
271             maintained indefinitely and may be redistributed consistent with
272             this project or the open source license(s) involved.
273
274    then you just add a line saying
275
276         Signed-off-by: Random J Developer <random@developer.example.org>
277
278    Note that git has support for adding such a message in the end of the commit
279    log message.