Spin-PDR locks (preemption detection and recovery)
[akaros.git] / GETTING_STARTED
1 GETTING_STARTED
2 Barret Rhoden
3
4 Last updated 2013-02-07
5
6
7 1. Overview
8 ---------------------
9 In this document, I outline what steps I go through to set up my development
10 environment.  Some devs use other setups, and they can put sections farther
11 down in this document describing their steps.
12
13 Due to the nature of different workflows and different Linux distros, you'll
14 need to do some configuration of your environment.  Things won't magically work
15 out of the box.
16
17
18 2. Need help?
19 ---------------------
20 First off, if you get stuck, email someone.  You can join our mailing list by
21 sending an email to akaros-request@lists.eecs.berkeley.edu.  Send your messages
22 to akaros@lists.eecs.berkeley.edu.  Or just email me (brho@cs), though the
23 mailing list is a more scalable method in the long run.
24
25 Alternatively, you can poke your head in #akaros on irc.freenode.net.  I'm
26 usually idling in there (alone), and if I'm at my computer, I'll respond.
27
28
29 3. From Download to Hello World
30 ---------------------
31 I'll describe how to get x86 working.  RISCV is similar.
32
33
34 3.1 Cross compiler (and glibc)
35 ----------
36 First step is to build the cross compiler, which lives in
37 tools/compilers/gcc-glibc
38
39 $ cd tools/compilers/gcc-glibc
40
41 In this directory, you first need to set up your Makelocal file.  There is a
42 template to work from.
43
44 $ cp Makelocal.template Makelocal
45
46 You need to set your INSTDIRS to some place where you want the cross compiler
47 installed.  I have a directory named ros-gcc-glibc for this.
48
49 You can also set up MAKE_JOBS, so you don't over or under load your system when
50 building.  I have a 2 core laptop, so I use MAKE_JOBS := 3
51
52 At this point, you can build:
53
54 $ make x86
55
56 This might take a while (10-20 minutes for me on a 2007 era laptop).
57
58 Finally, add the cross compiler's bin directories to your PATH.  This will vary
59 based on where you installed things.  For instance, my path contains:
60
61 /home/brho/classes/ros/ros-gcc-glibc/install-i386-ros-gcc/bin
62
63 Just to double check, you should be able to run i686-ros-gcc from your shell.
64
65 Now, you have a cross compiler ready, and you can start to build Akaros.
66
67
68 3.2 Kernel
69 ----------
70 cd back into the repo root.
71
72 Like the cross compiler, the kernel has its own Makelocal.
73
74 $ cp Makelocal.template Makelocal
75
76 There are a lot of settings in here, which you need to uncomment to turn on.
77
78 Most everyone wants KFS turned on (CONFIG_KFS).  This is the in-memory
79 filesystem that the kernel uses.  The kernel build scripts will look at
80 INITRAMFS_PATHS and take any of those directories and add them to a CPIO
81 archive that will eventually become the root filesystem when Akaros runs.  I
82 set CONFIG_KFS and suggested a INITRAMFS_PATH in the Makelocal.template.
83
84 There are also settings for ext2.  If you turn on ext2 support, you need to
85 point to an img file that has been formatted with ext2 and has files in it.  If
86 you aren't messing with filesystems at all, feel free to ignore this.  It's an
87 in-memory filesystem, like KFS (linked to the end of the kernel), so you won't
88 gain much by using it for now.
89
90 Now you're ready to build the kernel:
91
92 $ make x86
93
94 On future makes, you can just 'make'.  The initial make x86 is to pick a target
95 architecture.
96
97 So the kernel built, but you can't do much with it, and you probably have no
98 programs.
99
100 3.3 Userspace
101 ---------
102 To build userspace and test programs:
103
104 $ make tests
105
106 You now have programs and libraries, and need to put them in KFS.  To do this,
107 I have a script called 'fill_kfs.sh'.  I usually have it in the directory above
108 my repo root.  I put a copy of it in scripts/fill_kfs.sh in the repo.  You will
109 need to edit it for your own setup.  Or you can do everything manually.  Either
110 way, you need to make sure shared libraries are copied into kern/kfs/lib (given
111 kern/kfs as your INITRAMFS_PATH) and you want your programs copied to
112 kern/kfs/bin.
113
114 Now that you've changed the contents of KFS's source, remake the kernel.  You
115 should see something like
116         Building initramfs:
117                 Adding kern/kfs to initramfs...
118 before the kernel links.  If you don't see this, then you probably didn't
119 actually fill KFS properly.
120
121 3.4 Busybox
122 ---------
123 If you don't care about busybox or just want to get started immediately, skip
124 this section.
125
126 Other userspace programs, like busybox need to be compiled with the cross
127 compiler and then have their binaries copied to kern/kfs/bin (I do this
128 manually).
129
130 I'm running busybox 1.17.3, and the config file I use is in tools/patches.
131 Copy that to your busybox directory (once you download and untar it, etc) and
132 name it ".config".  You can get busybox from http://www.busybox.net/downloads/.
133 Eventually I'll upgrade, though it hasn't been a big deal yet.
134
135 $ cp tools/patches/busybox-1.17.3.config BUSYBOXDIR/.config
136
137 $ cd BUSYBOXDIR ; make
138
139 Then I copy the unstripped binary to KFS.
140
141 $ cp busybox_unstripped AKAROS-REPO/kern/kfs/bin/busybox
142
143 Note I change the name to busybox (dropping the unstripped).  I want the
144 unstripped binary for debugging reasons.
145
146 Busybox can do core commands like ls and rm, as well as run a shell (ash), all
147 from within one binary.  It can tell which command it should execute based on
148 the name of the binary (or symlink to it).  I have a bunch of symlinks for
149 whatever 'busybox' programs I want to run inside kern/kfs/bin.
150
151 For instance, from my AKAROS-ROOT:
152 $ ls -l kern/kfs/bin/ | grep busybox
153 lrwxrwxrwx 1 brho brho      7 Aug 24  2010 ash -> busybox
154 -rwxr-xr-x 1 brho brho 337917 Dec 19 17:39 busybox
155 lrwxrwxrwx 1 brho brho      7 Sep 29  2010 cat -> busybox
156 lrwxrwxrwx 1 brho brho      7 Sep  1  2010 cp -> busybox
157 lrwxrwxrwx 1 brho brho      7 Oct 18 13:12 kill -> busybox
158 lrwxrwxrwx 1 brho brho      7 Sep  5  2010 ln -> busybox
159 lrwxrwxrwx 1 brho brho      7 Aug 23  2010 ls -> busybox
160 lrwxrwxrwx 1 brho brho      7 Sep  5  2010 mkdir -> busybox
161 lrwxrwxrwx 1 brho brho      7 Sep  5  2010 rmdir -> busybox
162 lrwxrwxrwx 1 brho brho      7 Apr  9  2012 stty -> busybox
163 lrwxrwxrwx 1 brho brho      7 Apr  9  2012 tty -> busybox
164
165 Note I don't need to update the symlinks (almost ever...).  I just recopy the
166 busybox binary whenever I update it.
167
168 I think some of the other devs build busybox so that it spits out the links
169 into an install directory.  Feel free to do whatever.  I'll probably just add a
170 bunch of symlinks to the repos default KFS contents one of these days.
171 Incidentally, kern/kfs/* is now ignored by git.
172
173 Now that you've changed KFS, don't forget to remake the kernel.
174
175 3.5 Building and Loading a Virtual Machine Image
176 ---------
177 At this point, you probably have a runnable kernel with programs in KFS.  It
178 should be sitting at obj/kernel/kernel.  However, you need a place to run it.
179
180 I run my kernels either in KVM (Qemu) or off a bootable USB stick.
181
182 You'll need an image file that looks like a hard disk to boot qemu off of.  I
183 put one similar to mine at: http://akaros.cs.berkeley.edu/files/hdd64mb.img
184
185 It's 64MB, which isn't that big (occasionally I run into size limits).  If you
186 want to make your own, check out
187 http://www.omninerd.com/articles/Installing_GRUB_on_a_Hard_Disk_Image_File.
188 It's a bit older (Grub v1, and before fdisk changed its alignment, and maybe
189 before the loop module supported partitions).  Alternatively, check out
190 Documentation/howtos/make-bootable-grub-hdd.txt.  That's actually the original
191 document I made back when I first figured it out (and before I made that web
192 article).
193
194 Anyway, I put that img in AKAROS-ROOT/mnt/, and make a folder next to it:
195 AKAROS-ROOT/mnt/hdd.  mnt/hdd is the mount point where I mount hdd.img (Note I
196 don't call it hdd64mb.img on my dev machine).
197
198 Personally, I always have hdd.img mounted.  Some of the other devs have make
199 targets that mount and umount it.  Whenever I reboot my development machine, I
200 run a script (as root) that mounts the image file and sets up a few things for
201 networking.  I put a script I use for this in scripts/kvm-up.sh.  You'll need
202 to edit this to use it, and feel free to comment out the networking stuff.
203 That's for using networking in qemu.
204
205 Now that your image file is mounted at mnt/hdd, you'll want to copy your
206 freshly built kernel to the root of the image.  I have a make target in my
207 makelocal for this, so that whenever I do a make kvm, it builds the kernel and
208 copies it to my hdd.img.
209
210 I added edited versions of my KVM (and USB) make targets to the
211 Makelocal.template.  Uncomment the KVM one (at least).
212
213 Incidentally, I also have the following in my Makelocal, so that make (and make
214 all) also make kvm:
215
216 all: kvm
217
218 Now, make kvm.  You should be able to see the new kernel in mnt/hdd/ (do an ls
219 -l and check the timestamp).
220
221
222 3.6 Running Qemu
223 ---------
224 Here is the command I use to run qemu/kvm.  It's evolved over the years, and it
225 will vary based on your linux distribution.  Don't run it just yet:
226
227 $ qemu-system-i386 -s -enable-kvm -cpu coreduo -smp 8 -m 1024 -nographic -monitor /dev/pts/3 -net nic,model=e1000 -net tap,ifname=tap0,script=no mnt/hdd.img
228
229 The -monitor is the qemu monitor, which is a CLI for qemu.  Pick a
230 tab/terminal/pty in Linux that you will only use for qemu monitoring, and enter
231 'tty'.  Whatever it tells you, put in place of /dev/pts/3.  I've been using the
232 same tab for about 4 years now.  In that tab, enter 'sleep 999999999'.  Qemu
233 will still access it, but you won't have to worry about bash trying to handle
234 your inputs.
235
236 -nographic allows qemu to work in the terminal you run qemu from, instead of
237 spawning off a fake cpu crt/monitor.
238
239 If you don't have networking set up (including the tun/tap stuff from
240 kvm-up.sh), remove the -net commands/options.
241
242 Fell free to pick different values for the number of cpus and RAM (8 and 1024
243 in the example).
244
245 Once you finally run it, you can stop the VM by entering 'q' to the qemu
246 monitor (or just killing the process)..  Other help commands from the monitor
247 include 'info cpus', 'info registers', 'x', and 'help'.
248
249
250 3.7 Running on Hardware
251 ---------
252 I have a few bootable USB sticks with grub set up to run Akaros.  The make usb
253 target (example in Makelocal.template) will copy freshly made kernels to your
254 USB device.  You'll need to adjust those paths according to your distro.  My
255 usb sticks are usually /dev/sdc, for instance (some odd USB device in the last
256 couple of years has taken over /dev/sdb.  Probably something to do with udev
257 changing over the years).
258
259 Anyway, you'll need to mess around a bit to get that working.  Or I can dd one
260 for you (I have 4GB disks in my office that I use).  If you make your own, the
261 critical part is getting grub to pick the right device (from what I remember),
262 and its fairly similar to installing grub on any old hard drive (since it's
263 just a bloc device).  Much easier than a hard disk image file.
264
265
266 3.8 Hello World
267 ---------
268 So now you can run the kernel.  It's time to edit a program (or make your own).
269 In this, I'll go through my workflow for making changes.
270
271 $ vi tests/hello.c
272 (edit, save)
273
274 $ make tests
275 (new version in obj/tests/hello)
276
277 $ ../fill-kfs.sh
278 (updates kfs)
279
280 $ make
281 (rebuilds kernel with the new KFS)
282
283 $ qemu...
284
285 (following commands are in Akaros)
286 Shift-G (to get to the kernel monitor)
287
288 ROS(Core 0)> bb (to run busybox)
289
290 / $ hello
291 (Should print your message)
292
293
294 3.9 Other Dev Workflow stuff
295 ---------
296 One thing to note is that while we use dynamic linking for libc, parlib
297 libraries are statically linked with applications.  In fact, nowadays *all*
298 Akaros programs need to be linked againt parlib (used to be that single-core
299 processes (SCPs) didn't need it).
300
301 The makefiles won't notice if you change a file in parlib and then remake a
302 binary.  So if you edit user/parlib/uthread.c for example, tests/pthread_test
303 won't get rebuilt.  Here's what I do:
304
305 $ vi user/parlib/uthread.c (make awesome change)
306
307 $ touch tests/pthread_test.c ; make tests
308
309 This will force the rebuild of pthread_test.  Older, untouched binaries (e.g.
310 block_test), won't get rebuilt.  I actually want this in some cases (different
311 versions of parlib when I'm running certain tests).  Anyway, just pay attention
312 to what you're building.  There's not much output in the console, so you should
313 be able to see what's going on all the time.  (unlike when building glibc...).
314
315 Oh, and don't forget to:
316
317 $ ../fill-kfs.sh (or whatever you do)
318
319 to make sure you run the new pthread_test. 
320
321 Early on as a dev, there are lots of times where you accidentally don't run the
322 right program (or kernel) and won't understand why your change isn't happening.
323 A few printk("WTF\n")'s later, you realize you didn't have the hdd.img mounted,
324 or you didn't fill KFS, or you didn't relink your binaries, or you forgot to
325 save all files in vi (and not just the current buffer).  But after doing a
326 couple hello worlds, you're set. 
327
328 Alternatively, you could have a make target to run qemu, which also touches all
329 binaries (or otherwise enforces a rebuild), auto-fills KFS, remakes the kernel,
330 and mounts/copies/unmounts your hdd.img.  Kevin's sim repo has stuff like this,
331 so check it out if that's what you're into.  (I think it is at
332 http://akaros.cs.berkeley.edu/ros-sim.tar.gz).  Personally, I'm not that into
333 it, since I like to keep track of what is going on under the hood, esp if I
334 want to do something a little differently (like with testing ext2, having
335 different versions of parlib with some binaries, or being picky about my
336 mount/umounts).
337
338
339 4. RISCV
340 ---------------------
341 TODO.
342
343 For now, you need a 64 bit distro to build the RISCV stuff, so I don't do it
344 very often.  I'll eventually sync up with Andrew and we'll get this part sorted
345 out.
346
347
348 5. Other Developer's Stuff
349 ---------------------