update tree to use ghc7.4
[barrelfish] / README
1 ##########################################################################
2 Copyright (c) 2009-2012, 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, Haldeneggsteig 4, CH-8092 Zurich. Attn: Systems Group.
8 ##########################################################################
9
10 "SUPPORTED" HARDWARE
11
12 Barrelfish currently runs on:
13  * x86 CPUs in either IA-32 or AMD64 mode. The following are known to work:
14    * Intel Xeon: Clovertown, Gainestown, Beckton
15      (X5355, E5520, X7560, L5520, L7555)
16    * AMD Opteron: Santa Rosa, Barcelona, Shanghai, Istanbul, Magny Cours
17      (2220, 8350, 8374, 8380, 8431, 6174)
18  * Intel Single-Chip Cloud Computer (SCC), both Copper Ridge and Rocky Lake
19    are known to work.
20
21 The biggest compatibility problems are likely to be in the PCI/ACPI code. We
22 usually discover new quirks (or missing functionality in the ACPI glue code)
23 on each new machine we test. The following systems are known to work:
24  * Intel x5000XVN
25  * Tyan n6650W and S4985
26  * Supermicro H8QM3-2
27  * Dell PowerEdge R610 and R905
28  * Sun Fire X2270 and X4440
29  * Intel/Quanta QSSC-S4R
30  * Lenovo X200 and X301 laptops
31  * ASUS Eee PC 1015PEM netbooks
32
33 In addition, a port to the ARM architectures is in progress. This is 
34 less complete than the x86 and SCC ports, and not described in this 
35 document, but feel free to ask for help on the mailing list.
36
37 The e1000n driver should work with most recent Intel gigabit ethernet
38 controllers (see the list in devices/e1000.dev). We've mostly used the
39 82572EI (PCI device ID 0x1082).
40
41 You should also be able to boot Barrelfish on a recent version of QEMU (0.14);
42 note that the e1000 device emulated by QEMU is not supported by our driver.
43
44
45 REQUIRED TOOLS
46
47 The following are required to build Barrelfish and its tools:
48  * GCC 4.x
49    * 4.4.5, and 4.5.2 are known to work
50    * cross-compiling between i386 and x86_64 works
51      (requires libc6-dev-i386 to build 32 bit on 64 bit machine)
52    * for the ARM port, we recommend the EABI tools available from CodeSourcery:
53      http://www.codesourcery.com/sgpp/lite/arm
54  * GNU binutils (2.19 is known to work)
55  * GNU make
56  * GHC v7.4 and Parsec 3.1
57    * older versions of the tree supported v6.10 or v6.12.2 with Parsec 2.1
58    * GHC v6.12.1 has a known bug and is unable to build our tools
59    * earlier versions of GHC are unsupported
60
61 Our build system may not be very portable; if in doubt, try building on a
62 recent Debian or Ubuntu system, as these are what we use.
63
64
65 BUILDING
66
67 1. Assuming you have already unpacked the sources, create a build directory:
68 $ mkdir build && cd build
69
70 2. Run hake.sh, giving it the path to the source directory and target architecture(s):
71 $ ../hake/hake.sh .. x86_64
72 This will configure the build directory and use GHC to compile and then run
73 hake, a tool used to generate the Makefile.
74
75 3. Optionally, edit the configuration parameters in hake/Config.hs and run
76  'make rehake' to apply them.
77
78 4. Run make, and wait...
79 $ make
80
81 5. If everything worked, you should now be able to run Barrelfish inside QEMU:
82 $ make sim ARCH=x86_64
83
84
85 INSTALLING AND BOOTING
86
87 Barrelfish requires a Multiboot-compliant bootloader that is capable of loading
88 an ELF64 image. At the time of writing, this doesn't include the default GRUB.
89 Your options are either:
90  * use the pre-loader "elver" that can be found in the tools directory
91  * patch GRUB to support a 64-bit kernel image, using the patch found here:
92    http://savannah.gnu.org/bugs/?17963
93
94 "Installing" Barrelfish currently consists of copying the ELF files for the CPU
95 driver and user programs to a location that the target machine can boot from,
96 and writing a suitable menu.lst file that instructs the bootloader (GRUB) which
97 programs to load and the arguments to pass them.
98
99 If you specify an appropriate INSTALL_PREFIX, 'make install' will copy the
100 binaries to the right place for you, eg:
101 $ make install INSTALL_PREFIX=/tftpboot/barrelfish
102
103 We usually boot Barrelfish via PXE/TFTP, although loading from a local disk
104 also works. Instructions for setting up GRUB to do this are beyond the scope of
105 this document. Assuming you have such a setup, here is a sample menu.lst file
106 for a basic diskless boot that doesn't do anything useful beyond probing the
107 PCI buses and starting a basic shell:
108
109 title   Barrelfish
110 root    (nd)
111 kernel /barrelfish/x86_64/sbin/elver
112 module /barrelfish/x86_64/sbin/cpu
113 module /barrelfish/x86_64/sbin/init
114 module /barrelfish/x86_64/sbin/mem_serv
115 module /barrelfish/x86_64/sbin/monitor
116 module /barrelfish/x86_64/sbin/ramfsd boot
117 module /barrelfish/x86_64/sbin/skb boot
118 modulenounzip /barrelfish/skb_ramfs.cpio.gz nospawn
119 module /barrelfish/x86_64/sbin/acpi boot
120 module /barrelfish/x86_64/sbin/pci boot
121 module /barrelfish/x86_64/sbin/spawnd boot
122 module /barrelfish/x86_64/sbin/serial
123 module /barrelfish/x86_64/sbin/fish
124
125 There are many other programs you can load (take a look around the usr tree for
126 examples). To start a program on a core other than the BSP core, pass 'core=N'
127 as its first argument.
128 Note: Chips is no longer supported. The SKB now also serves as a name service.
129
130 If things work, you should see output on both the VGA console and COM1.
131
132
133 KNOWN ISSUES
134
135 There are many. Those you're likely to encounter include:
136  * The documentation is incomplete and out of date.
137  * Some drivers and user programs are known not to build, and are
138    not included in the default set of targets (MODULES) in the Makefile.
139
140
141 LIKELY FAQs
142
143 Q: How do I run a program?
144 A: Add it to the boot sequence by specifying the module in your menu.lst file.
145    For example, to run the memtest program, add the line:
146        module /PATH/x86_64/sbin/memtest
147    to the end of menu.lst, where PATH is relative either to your TFTP
148    server's root directory (when booting on hardware) or to your build
149    directory (when using a simulator such as QEMU).
150    If memtest runs, you should see it output "memtest passed successfully!".
151
152 Q: Where's the CPU driver?
153 A: It's in the directory named kernel :) But don't worry, it really does run
154    independently on each core.
155
156 Q: Where is the source for the SPLASH2 benchmarks? It seems to be missing.
157 A: The license for these prevents redistribution, so we were forced to ship our
158    changes as a patch. See usr/splash2/README for further instructions.
159
160 Q: Can I use a debugger?
161 A: Maybe. There are two options at the moment:
162     * On a simulator, using whatever debug interfaces it supports.
163       For QEMU, you could try the "debugsim" target.
164     * On hardware, using the kernel-mode remote GDB stubs that operate on the
165       primary serial port and are entered in response to a kernel trap or
166       exception. However, these are not well maintained, and may not be usable
167       beyond reading/writing memory locations and inspecting the stack.
168    When debugging the kernel, beware that it is relocated to an address
169    determined at core boot time. Look for output such as:
170    "Kernel starting at address 0xffffffffc072b000".
171
172 Q: Where can I find more information, including papers and new releases?
173 A: http://www.barrelfish.org/
174
175 Q: Can I contribute?
176 A: We'd certainly like to hear from you. Please send us mail.