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