monitor: bugfixes in the revocation protocol
[barrelfish] / README
1 ##########################################################################
2 Copyright (c) 2009-2013, 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 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 We are making sure that Barrelfish and its tools can be built using the
79 following:
80
81  * GCC 4.8.2 for x86_64 and x86_32
82    - cross-compiling between i386 and x86_64 works (install gcc-multilib on 64 bit Ubuntu LTS)
83  * GCC 4.7.3 for ARMv5 and ARMv7
84    - gcc-arm-linux-gnueabi and g++-arm-linux-gnueabi on Ubuntu LTS
85  * GNU binutils (2.24 is known to work)
86  * GNU make
87  * GHC v7.6.3 and Parsec 3.1
88    - older versions of the tree supported v6.10 or v6.12.2 with Parsec 2.1 or
89      v7.4 with Parsec 3.1
90    - GHC v6.12.1 has a known bug and is unable to build our tools
91    - earlier versions of GHC are unsupported
92
93 Our build system may not be very portable; if in doubt, try building on the
94 latest Ubuntu LTS system (14.04.1), as this is what we use to run nightly
95 tests.
96
97
98 Building
99 --------------------------------
100
101 1. Assuming you have already unpacked the sources, create a build directory ::
102
103     $ mkdir build && cd build
104
105 1. Run ``hake.sh``, giving it the path to the source directory and target
106 architecture(s) ::
107
108     $ ../hake/hake.sh -s ../ -a x86_64
109
110 This will configure the build directory and use GHC to compile and then run
111 hake, a tool used to generate the ``Makefile``.
112
113 3. Optionally, edit the configuration parameters in ``hake/Config.hs`` and
114 run ``make rehake`` to apply them.
115
116 4. Run make, and wait ::
117
118     $ make
119
120 5. If everything worked, you should now be able to run Barrelfish inside QEMU ::
121
122     $ make sim
123
124
125 Installing and Booting
126 --------------------------------
127
128 Barrelfish requires a Multiboot-compliant bootloader that is capable of loading
129 an ELF64 image. At the time of writing, this doesn't include the default GRUB.
130 Your options are either:
131
132  * use the pre-loader "elver" that can be found in the tools directory
133  * patch GRUB to support a 64-bit kernel image, using this patch_.
134
135 .. _patch: http://savannah.gnu.org/bugs/?17963
136
137 "Installing" Barrelfish currently consists of copying the ELF files for the CPU
138 driver and user programs to a location that the target machine can boot from,
139 and writing a suitable menu.lst file that instructs the bootloader (GRUB) which
140 programs to load and the arguments to pass them.
141
142 If you specify an appropriate INSTALL_PREFIX, ``make install`` will copy the
143 binaries to the right place for you, eg ::
144
145     $ make install INSTALL_PREFIX=/tftpboot/barrelfish
146
147 We usually boot Barrelfish via PXE/TFTP, although loading from a local disk
148 also works. Instructions for setting up GRUB to do this are beyond the scope of
149 this document. Assuming you have such a setup, here is a sample menu.lst file
150 for a basic diskless boot that doesn't do anything useful beyond probing the
151 PCI buses and starting a basic shell ::
152
153     title   Barrelfish
154     root    (nd)
155     kernel /barrelfish/x86_64/sbin/elver
156     module /barrelfish/x86_64/sbin/cpu
157     module /barrelfish/x86_64/sbin/init
158     module /barrelfish/x86_64/sbin/mem_serv
159     module /barrelfish/x86_64/sbin/monitor
160     module /barrelfish/x86_64/sbin/ramfsd boot
161     module /barrelfish/x86_64/sbin/skb boot
162     modulenounzip /barrelfish/skb_ramfs.cpio.gz nospawn
163     module /barrelfish/x86_64/sbin/acpi boot
164     module /barrelfish/x86_64/sbin/pci boot
165     module /barrelfish/x86_64/sbin/spawnd boot
166     module /barrelfish/x86_64/sbin/serial
167     module /barrelfish/x86_64/sbin/fish
168
169 There are many other programs you can load (take a look around the usr tree for
170 examples). To start a program on a core other than the BSP core, pass
171 ``core=N`` as its first argument.
172
173 If things work, you should see output on both the VGA console and COM1.
174
175 Generating Documentation
176 --------------------------------
177
178 Barrelfish documentation can be found on Barrelfish website
179 (http://www.barrelfish.org/). And it can be also generated from the code tree.
180 For documentation generation, you will need ``latex`` packages installed,
181 including support for ``pdflatex``.  Following are the instructions for
182 generating the documentation assuming you have already unpacked the sources ::
183
184     $ mkdir build && cd build
185     $ ../hake/hake.sh -s ../
186     $ make docs
187
188 You will find all the technotes in ``docs/`` directory.
189
190 Known Issues
191 --------------------------------
192
193 There are many. Those you're likely to encounter include:
194
195  * The documentation is incomplete and out of date.
196  * Some drivers and user programs are known not to build, and are
197    not included in the default set of targets (MODULES) in the Makefile.
198
199 Likely FAQs
200 --------------------------------
201
202 Q: How do I run a program?
203 A: Add it to the boot sequence by specifying the module in your menu.lst file.
204    For example, to run the memtest program, add the line:
205        module /PATH/x86_64/sbin/memtest
206    to the end of menu.lst, where PATH is relative either to your TFTP
207    server's root directory (when booting on hardware) or to your build
208    directory (when using a simulator such as QEMU).
209    If memtest runs, you should see it output "memtest passed successfully!".
210
211 Q: Where's the CPU driver?
212 A: It's in the directory named kernel :) But don't worry, it really does run
213    independently on each core.
214
215 Q: Where is the source for the SPLASH2 benchmarks? It seems to be missing.
216 A: The license for these prevents redistribution, so we were forced to ship our
217    changes as a patch. See usr/splash2/README for further instructions.
218
219 Q: Can I use a debugger?
220 A: Maybe. There are two options at the moment:
221     * On a simulator, using whatever debug interfaces it supports.
222       For QEMU, you could try the "debugsim" target.
223     * On hardware, using the kernel-mode remote GDB stubs that operate on the
224       primary serial port and are entered in response to a kernel trap or
225       exception. However, these are not well maintained, and may not be usable
226       beyond reading/writing memory locations and inspecting the stack.
227    When debugging the kernel, beware that it is relocated to an address
228    determined at core boot time. Look for output such as:
229    "Kernel starting at address 0xffffffffc072b000".
230
231 Q: Where can I find more information, including papers and new releases?
232 A: http://www.barrelfish.org/
233    http://wiki.barrelfish.org/
234
235 Q: Can I contribute?
236 A: We'd certainly like to hear from you. Feel free to send pateches (or even
237    git merge requests) to the Barrelfish mailing list.
238
239    To keep track of contributions to Barrelfish, we use a sign-off procedure
240    similar to the Linux kernel:
241
242    The sign-off is a simple line at the end of the explanation for the patch,
243    which certifies that you wrote it or otherwise have the right to pass it on
244    as an open-source patch.  The rules are pretty simple: if you can certify
245    the below:
246
247         Developer's Certificate of Origin 1.1
248
249         By making a contribution to this project, I certify that:
250
251         (a) The contribution was created in whole or in part by me and I
252             have the right to submit it under the open source license
253             indicated in the file; or
254
255         (b) The contribution is based upon previous work that, to the best
256             of my knowledge, is covered under an appropriate open source
257             license and I have the right under that license to submit that
258             work with modifications, whether created in whole or in part
259             by me, under the same open source license (unless I am
260             permitted to submit under a different license), as indicated
261             in the file; or
262
263         (c) The contribution was provided directly to me by some other
264             person who certified (a), (b) or (c) and I have not modified
265             it.
266
267         (d) I understand and agree that this project and the contribution
268             are public and that a record of the contribution (including all
269             personal information I submit with it, including my sign-off) is
270             maintained indefinitely and may be redistributed consistent with
271             this project or the open source license(s) involved.
272
273    then you just add a line saying
274
275         Signed-off-by: Random J Developer <random@developer.example.org>
276
277    Note that git has support for adding such a message in the end of the commit
278    log message.