lguest: Add puppies which where previously missing.
[sfrench/cifs-2.6.git] / Documentation / lguest / lguest.txt
1       __
2  (___()'`;  Rusty's Remarkably Unreliable Guide to Lguest
3  /,    /`      - or, A Young Coder's Illustrated Hypervisor
4  \\"--\\    http://lguest.ozlabs.org
5
6 Lguest is designed to be a minimal hypervisor for the Linux kernel, for
7 Linux developers and users to experiment with virtualization with the
8 minimum of complexity.  Nonetheless, it should have sufficient
9 features to make it useful for specific tasks, and, of course, you are
10 encouraged to fork and enhance it (see drivers/lguest/README).
11
12 Features:
13
14 - Kernel module which runs in a normal kernel.
15 - Simple I/O model for communication.
16 - Simple program to create new guests.
17 - Logo contains cute puppies: http://lguest.ozlabs.org
18
19 Developer features:
20
21 - Fun to hack on.
22 - No ABI: being tied to a specific kernel anyway, you can change anything.
23 - Many opportunities for improvement or feature implementation.
24
25 Running Lguest:
26
27 - The easiest way to run lguest is to use same kernel as guest and host.
28   You can configure them differently, but usually it's easiest not to.
29
30   You will need to configure your kernel with the following options:
31
32   "General setup":
33      "Prompt for development and/or incomplete code/drivers" = Y
34         (CONFIG_EXPERIMENTAL=y)
35
36   "Processor type and features":
37      "Paravirtualized guest support" = Y
38         "Lguest guest support" = Y
39      "High Memory Support" = off/4GB
40      "Alignment value to which kernel should be aligned" = 0x100000
41         (CONFIG_PARAVIRT=y, CONFIG_LGUEST_GUEST=y, CONFIG_HIGHMEM64G=n and
42          CONFIG_PHYSICAL_ALIGN=0x100000)
43
44   "Device Drivers":
45      "Network device support"
46         "Universal TUN/TAP device driver support" = M/Y
47            (CONFIG_TUN=m)
48      "Virtualization"
49         "Linux hypervisor example code" = M/Y
50            (CONFIG_LGUEST=m)
51
52 - A tool called "lguest" is available in this directory: type "make"
53   to build it.  If you didn't build your kernel in-tree, use "make
54   O=<builddir>".
55
56 - Create or find a root disk image.  There are several useful ones
57   around, such as the xm-test tiny root image at
58           http://xm-test.xensource.com/ramdisks/initrd-1.1-i386.img
59
60   For more serious work, I usually use a distribution ISO image and
61   install it under qemu, then make multiple copies:
62
63           dd if=/dev/zero of=rootfile bs=1M count=2048
64           qemu -cdrom image.iso -hda rootfile -net user -net nic -boot d
65
66   Make sure that you install a getty on /dev/hvc0 if you want to log in on the
67   console!
68
69 - "modprobe lg" if you built it as a module.
70
71 - Run an lguest as root:
72
73       Documentation/lguest/lguest 64 vmlinux --tunnet=192.168.19.1 --block=rootfile root=/dev/vda
74
75    Explanation:
76     64: the amount of memory to use, in MB.
77
78     vmlinux: the kernel image found in the top of your build directory.  You
79        can also use a standard bzImage.
80
81     --tunnet=192.168.19.1: configures a "tap" device for networking with this
82        IP address.
83
84     --block=rootfile: a file or block device which becomes /dev/vda
85        inside the guest.
86
87     root=/dev/vda: this (and anything else on the command line) are
88        kernel boot parameters.
89
90 - Configuring networking.  I usually have the host masquerade, using
91   "iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE" and "echo 1 >
92   /proc/sys/net/ipv4/ip_forward".  In this example, I would configure
93   eth0 inside the guest at 192.168.19.2.
94
95   Another method is to bridge the tap device to an external interface
96   using --tunnet=bridge:<bridgename>, and perhaps run dhcp on the guest
97   to obtain an IP address.  The bridge needs to be configured first:
98   this option simply adds the tap interface to it.
99
100   A simple example on my system:
101
102     ifconfig eth0 0.0.0.0
103     brctl addbr lg0
104     ifconfig lg0 up
105     brctl addif lg0 eth0
106     dhclient lg0
107
108   Then use --tunnet=bridge:lg0 when launching the guest.
109
110   See http://linux-net.osdl.org/index.php/Bridge for general information
111   on how to get bridging working.
112
113 There is a helpful mailing list at http://ozlabs.org/mailman/listinfo/lguest
114
115 Good luck!
116 Rusty Russell rusty@rustcorp.com.au.