ia64/xen-unstable

changeset 1476:dee503a6c122

bitkeeper revision 1.965 (40cde552wh00ygWiaGqPPXzvspDJsg)

Update README and README.CD
author iap10@labyrinth.cl.cam.ac.uk
date Mon Jun 14 17:50:10 2004 +0000 (2004-06-14)
parents cda612df4651
children b442c789c93e
files README README.CD
line diff
     1.1 --- a/README	Mon Jun 14 15:57:31 2004 +0000
     1.2 +++ b/README	Mon Jun 14 17:50:10 2004 +0000
     1.3 @@ -8,7 +8,7 @@
     1.4  #############################
     1.5  
     1.6  University of Cambridge Computer Laboratory
     1.7 -30 Jan 2004
     1.8 +15 Jun 2004
     1.9  
    1.10  http://www.cl.cam.ac.uk/netos/xen
    1.11  
    1.12 @@ -32,9 +32,9 @@ Xen has since grown into a project in it
    1.13  investigate interesting research issues regarding the best techniques
    1.14  for virtualizing resources such as the CPU, memory, disk and network.
    1.15  The project has been bolstered by support from Intel Research
    1.16 -Cambridge, who are now working closely with us. We're also in receipt
    1.17 -of support from Microsoft Research Cambridge to port Windows XP to 
    1.18 -run on Xen.
    1.19 +Cambridge, and HP Labs, who are now working closely with us. We're
    1.20 +also in receipt of support from Microsoft Research Cambridge to port
    1.21 +Windows XP to run on Xen.
    1.22  
    1.23  Xen enables multiple operating system images to execute concurrently 
    1.24  on the same hardware with very low performance overhead --- much lower
    1.25 @@ -54,14 +54,14 @@ tricky to handle. A good description of 
    1.26  and performance is contained in our October 2003 SOSP paper, available
    1.27  at http://www.cl.cam.ac.uk/netos/papers/2003-xensosp.pdf
    1.28  
    1.29 -We have worked on porting 3 different operating systems to run
    1.30 -on Xen: Linux 2.4, Windows XP, and NetBSD.
    1.31 +We have worked on porting 4 different operating systems to run
    1.32 +on Xen: Linux 2.4/2.6, Windows XP, NetBSD and FreeBSD.
    1.33  
    1.34 -The Linux 2.4 port (currently Linux 2.4.22) works very well -- we
    1.35 +The Linux 2.4 port (currently Linux 2.4.26) works very well -- we
    1.36  regularly use it to host complex applications such as PostgreSQL,
    1.37  Apache, BK servers etc. It runs every user-space applications we've
    1.38  tried.  We refer to our version of Linux ported to run on Xen as
    1.39 -"XenoLinux", although really it's just standard Linux ported to a new
    1.40 +"XenLinux", although really it's just standard Linux ported to a new
    1.41  virtual CPU architecture that we call xen-x86.
    1.42  
    1.43  NetBSD has been ported to Xen by Christian Limpach, and will hopefully
    1.44 @@ -80,7 +80,7 @@ binary releases to a larger user communi
    1.45  issues with product activation in this environment which need to be 
    1.46  thought through.
    1.47  
    1.48 -So, for the moment, you only get to run multiple copies of Linux on
    1.49 +So, for the moment, you only get to run Linux 2.4/2.6 and NetBSD on
    1.50  Xen, but we hope this will change before too long.  Even running
    1.51  multiple copies of the same OS can be very useful, as it provides a
    1.52  means of containing faults to one OS image, and also for providing
    1.53 @@ -111,7 +111,7 @@ Xen requires a "P6" or newer processor (
    1.54  Pentium II, Pentium III, Pentium IV, Xeon, AMD Athlon, AMD Duron).
    1.55  Multiprocessor machines are supported, and we also have basic support
    1.56  for HyperThreading (SMT), although this remains a topic for ongoing
    1.57 -research. We're also looking at an AMD x86_64 port (though it should
    1.58 +research. We're also working on an AMD x86_64 port (though Xen should
    1.59  run on Opterons in 32-bit mode just fine).
    1.60  
    1.61  Xen can currently use up to 4GB of memory. It's possible for x86
    1.62 @@ -121,36 +121,58 @@ currently don't support. Adding 3-level 
    1.63  difficult, but we'd also need to add support to all the guest
    1.64  OSs. Volunteers welcome!
    1.65  
    1.66 -We currently support a relatively modern set of network cards: Intel
    1.67 -e1000, Broadcom BCM 57xx (tg3), 3COM 3c905 (3c59x). Adding support for
    1.68 -other NICs that support hardware DMA scatter/gather from half-word
    1.69 -aligned addresses is relatively straightforward, by porting the
    1.70 -equivalent Linux driver. Drivers for a number of other older cards
    1.71 -have recently been added [pcnet32, e100, tulip], but these are not 
    1.72 -recommended since they require extra packet copies.
    1.73 +In contrast to previous Xen versions, in Xen 2.0 device drivers run
    1.74 +within a privileged guest OS rather than within Xen itself. This means
    1.75 +that we should be compatible with the full set of device hardware
    1.76 +supported by Linux.  The default XenLinux build contains support for
    1.77 +relatively modern server-class network and disk hardware, but you can
    1.78 +add suppport for other hardware by configuring your XenLinux kernel in
    1.79 +the normal way (e.g. "make xconfig").
    1.80  
    1.81  
    1.82 -Building Xen and XenoLinux
    1.83 -==========================
    1.84 +Building Xen and XenLinux
    1.85 +=========================
    1.86  
    1.87 -The public master BK repository for the 1.2 release lives at: 
    1.88 -bk://xen.bkbits.net/xeno-1.2.bk
    1.89 +The public master BK repository for the 2.0 release lives at: 
    1.90 +bk://xen.bkbits.net/xeno-2.0.bk
    1.91  
    1.92  To fetch a local copy, install the BitKeeper tools, then run: 
    1.93 -'bk clone bk://xen.bkbits.net/xeno-1.2.bk'
    1.94 +'bk clone bk://xen.bkbits.net/xeno-2.0.bk'
    1.95  
    1.96 -To see how to build Xen, Xenolinux, and all the control tools, inspect
    1.97 -the tools/misc/xen-clone script in the BK repository (also available
    1.98 -via http://www.cl.cam.ac.uk/netos/xen/readmes/xen-clone). This script
    1.99 -can be used to clone the repository and perform a full build.
   1.100 +You can do a complete build of Xen, the control tools, and the
   1.101 +XenLinux kernel images with "make world". This can take 10 minutes
   1.102 +even on a fast machine. If you're on an SMP machine you may wish to
   1.103 +give the '-j4' argument to make to get a parallel build. You should
   1.104 +end up with all the binaries and images being placed in the ./install
   1.105 +directory tree.  You can then install everything to the standard
   1.106 +system directories (e.g. /boot, /usr/bin, /usr/lib/python/ etc) by
   1.107 +taping "make install".
   1.108 +
   1.109  
   1.110 -The build procedure for xenolinux is slightly complicated as its done
   1.111 -by running the 'mkbuildtree' script over a pristine Linux tree to turn
   1.112 -it into a xenolinux tree by adding the 'xen' architecture.
   1.113 +Inspect the Makefule if you want to see what goes on during a
   1.114 +build. Building Xen and the tools is straightforward, but XenLinux is
   1.115 +more complicated. The makefile needs a 'pristine' linux kernel tree
   1.116 +which it will then add the Xen architecture files to. You can tell the
   1.117 +makefile the location of the appropriate linux compressed tar file by
   1.118 +setting the LINUX_SRC environment variable
   1.119 +(e.g. "LINUX_SRC=/tmp/linux-2.4.26.tar.gz make world") or by placing
   1.120 +the tar file somewhere in the search path of LINUX_SRC_PATH which
   1.121 +defaults to ".:..". If the makefile can't find a suitable kernel tar
   1.122 +file it attempts to download it from kernel.org, but this won't work
   1.123 +if you're behind a firewall.
   1.124  
   1.125 -There's also a recent pre-built source tree on the project downloads
   1.126 -page: http://www.cl.cam.ac.uk/netos/xen/downloads/xeno-1.2.tar.gz
   1.127 +After untaring the pristine kernel tree, the makefile uses the
   1.128 +'mkbuildtree' script to add the Xen patches the kernel. "make world"
   1.129 +then build two different XenLinux images, one with a "-xen0" extension
   1.130 +which contains hardware device drivers and is intended to be used in
   1.131 +the first virtual machine ("domain 0"), and one with a "-xenU"
   1.132 +extension that just contains virtual-device drivers. The latter can be
   1.133 +used for all non hardware privileged domains, and is substantially
   1.134 +smaller than the other kernel with its selection of hardware drivers.
   1.135  
   1.136 +If you don't want to use bitkeeper to download the source, you can
   1.137 +download prebuilt binaries and src tar balls from the project
   1.138 +downloads page:  http://www.cl.cam.ac.uk/netos/xen/downloads/
   1.139  
   1.140  Using the domain control tools
   1.141  ==============================
     2.1 --- a/README.CD	Mon Jun 14 15:57:31 2004 +0000
     2.2 +++ b/README.CD	Mon Jun 14 17:50:10 2004 +0000
     2.3 @@ -19,26 +19,30 @@ Executive Summary
     2.4  =================
     2.5  
     2.6  This CD is a standalone demo of the Xen Virtual Machine Monitor (VMM)
     2.7 -and Linux-2.4 OS port (XenoLinux). It runs entirely off the CD,
     2.8 +and Linux-2.4 OS port (Xenlinux). It runs entirely off the CD,
     2.9  without requiring hard disk installation. This is achieved using a RAM
    2.10  disk to store mutable file system data while using the CD for
    2.11 -everything else. The CD can also be used for installing Xen/XenoLinux
    2.12 +everything else. The CD can also be used for installing Xen/Xenlinux
    2.13  to disk, and includes a source code snapshot along with all of the
    2.14  tools required to build it.
    2.15  
    2.16  Booting the CD
    2.17  ==============
    2.18  
    2.19 -The Xen VMM is currently fairly h/w specific, but porting new device
    2.20 -drivers is relatively straightforward thanks to Xen's Linux driver
    2.21 -compatibility layer. The current snapshot supports the following
    2.22 -hardware:
    2.23 +It should be possible to get Xen working with any relatively modern
    2.24 +hardware supported by standard Linux. However, the version of XenLinux
    2.25 +built for the DemoCD is fairly h/w specific. If you need other
    2.26 +hardware, you'll have to configure and build your own xenlinux kernel.
    2.27 +Xen does require an 'i686'-class CPU or newer, so won't work on 486's
    2.28 +or plain Pentiums.
    2.29 +
    2.30 +We have compiled in drivers for the following hardware:
    2.31  
    2.32  CPU:  Pentium Pro/II/III/IV/Xeon, Athlon (i.e. P6 or newer) SMP supported
    2.33  IDE:  Intel PIIX chipset, others will be PIO only (slow)
    2.34  SCSI: Adaptec / Dell PERC Raid (aacraid), fusion MPT, megaraid, Adaptec aic7xxx
    2.35  Net:  Recommended: Intel e1000, Broadcom BCM57xx (tg3), 3c905 (3c59x)
    2.36 -      Working, but require extra copies : pcnet32, Intel e100, tulip
    2.37 +      Also supported: pcnet32, Intel e100, tulip
    2.38  
    2.39  Because of the demo CD's use of RAM disks, make sure you have plenty
    2.40  of RAM (256MB+).
    2.41 @@ -47,9 +51,9 @@ To try out the Demo, boot from CD (you m
    2.42  configuration to do this), then select one of the four boot options 
    2.43  from the Grub menu:
    2.44  
    2.45 - Xen / linux-2.4.24
    2.46 - Xen / linux-2.4.24 using cmdline IP configuration
    2.47 - Xen / linux-2.4.24 in "safe mode"
    2.48 + Xen / linux-2.4.26
    2.49 + Xen / linux-2.4.26 using cmdline IP configuration
    2.50 + Xen / linux-2.4.26 in "safe mode"
    2.51   linux-2.4.22
    2.52  
    2.53  The last option is a plain linux kernel that runs on the bare machine,
    2.54 @@ -62,7 +66,7 @@ If you are going for a command line IP c
    2.55  the grub menu, then edit the "ip=" parameters to reflect your setup
    2.56  e.g. "ip=<ipaddr>::<gateway>:<netmask>::eth0:off". It shouldn't be
    2.57  necessary to set either the nfs server or hostname
    2.58 -parameters. Alternatively, once XenoLinux has booted you can login and
    2.59 +parameters. Alternatively, once Xenlinux has booted you can login and
    2.60  setup networking with 'dhclient' or 'ifconfig' and 'route' in the
    2.61  normal way. 
    2.62  
    2.63 @@ -74,7 +78,7 @@ and the configuration files on the CD al
    2.64  sequentially for subsequent domains unless told otherwise.
    2.65  
    2.66  After selecting the kernel to boot, stand back and watch Xen boot,
    2.67 -closely followed by "domain 0" running the XenoLinux kernel. The boot
    2.68 +closely followed by "domain 0" running the Xenlinux kernel. The boot
    2.69  messages can also sent to the serial line by specifying the baud rate
    2.70  on the Xen cmdline (e.g., 'com1=9600,8n1'); this can be very useful
    2.71  for debugging should anything important scroll off the screen. Xen's
    2.72 @@ -93,7 +97,7 @@ the usual tools and commands should work
    2.73  because of the poor random access performance of CD drives, the
    2.74  machine will feel very slugish, and you may run out of memory if you
    2.75  make significant modifications to the ramfs filesystem -- for the full
    2.76 -experience, install a Xen and XenoLinux image on you hard drive :-)
    2.77 +experience, install a Xen and Xenlinux image on you hard drive :-)
    2.78  
    2.79  You can configure networking, either with 'dhclient' or manually via
    2.80  'ifconfig' and 'route', remembering to edit /etc/resolv.conf if you
    2.81 @@ -105,8 +109,8 @@ contains a load of standard software. Yo
    2.82  Apache, PostgreSQL, Mozilla etc in the normal way, but because
    2.83  everything is running off CD the performance will be very sluggish and
    2.84  you may run out of memory for the 'tmpfs' file system.  You may wish
    2.85 -to go ahead and install Xen/XenoLinux on your hard drive, either
    2.86 -dropping Xen and the XenoLinux kernel down onto a pre-existing Linux
    2.87 +to go ahead and install Xen/Xenlinux on your hard drive, either
    2.88 +dropping Xen and the Xenlinux kernel down onto a pre-existing Linux
    2.89  distribution, or using the file systems from the CD (which are based
    2.90  on RH9). See the installation instructions later in this document.
    2.91  
    2.92 @@ -114,8 +118,8 @@ If your video card requires 'agpgart' th
    2.93  work with Xen, and you'll only be able to configure a VGA X
    2.94  server. We're working on a fix for this for the next release.
    2.95  
    2.96 -If you want to browse the Xen / XenoLinux source, it's all located
    2.97 -under /usr/local/src/xeno-1.2, complete with BitKeeper
    2.98 +If you want to browse the Xen / Xenlinux source, it's all located
    2.99 +under /usr/local/src/xeno-1.3, complete with BitKeeper
   2.100  repository. We've also included source code and configuration
   2.101  information for the various benchmarks we used in the SOSP paper.
   2.102  
   2.103 @@ -123,22 +127,14 @@ information for the various benchmarks w
   2.104  Starting other domains
   2.105  ======================
   2.106  
   2.107 -Xen's privileged control interfaces can be accessed using a C library
   2.108 -(libxc.so) or an easier-to-use Python wrapper module (Xc). Example
   2.109 -script templates are provided in tools/examples/.
   2.110 -
   2.111 -Abyway, the first thing to do is to set up a window in which you will
   2.112 -receive console output from other domains. Console output will arrive
   2.113 -as UDP packets destined for 169.254.1.0. The DemoCD's startup scripts
   2.114 -automatically bring up 169.254.1.0 as an alias called eth0:xen (see
   2.115 -/etc/sysconfig/network-scripts/ifcfg-eth0 )
   2.116 +The first thing you need to do is to start the "xend" control daemon
   2.117 +with "xend start". You may wish to add an appropriate link to xend in
   2.118 +you /etc/rcX.d directory e.g. "ln -sf ../init.d/xend S97xend"
   2.119  
   2.120  If you're not intending to configure the new domain with an IP address
   2.121  on your LAN, then you'll probably want to use NAT. The
   2.122  'xen_nat_enable' installs a few useful iptables rules into domain0 to
   2.123 -enable NAT. [ NB: The intention is that in future Xen will do NAT
   2.124 -itsel (actually RSIP), but this is part of a larger work package that
   2.125 -isn't ready to release.]
   2.126 +enable NAT. [NB: We plan to support RSIP in future]
   2.127  
   2.128  Xen has a management interface that can be manipulated from domain0 to
   2.129  create new domains, control their CPU, network and memory resource
   2.130 @@ -194,7 +190,7 @@ have e.g.:
   2.131    [root@xendemo]# xc_dom_create.py -D ip=commando-1.xeno,169.254.2.3 -Dmem=100
   2.132    Parsing config file 'defaults'
   2.133  
   2.134 -  VM image           : "/boot/xenolinux.gz"
   2.135 +  VM image           : "/boot/xenlinux.gz"
   2.136    VM ramdisk         : "/boot/initrd.gz"
   2.137    VM memory (MB)     : "100"
   2.138    VM IP address(es)  : "128.232.38.51:169.254.2.3"
   2.139 @@ -330,7 +326,7 @@ About The Xen Demo CD
   2.140  The purpose of the Demo CD is to distribute a snapshot of Xen's
   2.141  source, and simultaneously provide a convenient means for enabling
   2.142  people to get experience playing with Xen without needing to install
   2.143 -it on their hard drive. If you decide to install Xen/XenoLinux you can
   2.144 +it on their hard drive. If you decide to install Xen/Xenlinux you can
   2.145  do so simply by following the installation instructions below -- which
   2.146  essentially involves copying the contents of the CD on to a suitably
   2.147  formated disk partition, and then installing or updating the Grub
   2.148 @@ -345,11 +341,11 @@ persistent across reboots!
   2.149  
   2.150  Because of the use of a RAM-based file system for root, you'll need
   2.151  plenty of memory to run this CD -- something like 96MB per VM. This is
   2.152 -not a restriction of Xen : once you've installed Xen, XenoLinux and
   2.153 +not a restriction of Xen : once you've installed Xen, Xenlinux and
   2.154  the file system images on your hard drive you'll find you can boot VMs
   2.155  in just a few MBs.
   2.156  
   2.157 -The CD contains a snapshot of the Xen and XenoLinux code base that we
   2.158 +The CD contains a snapshot of the Xen and Xenlinux code base that we
   2.159  believe to be pretty stable, but lacks some of the features that are
   2.160  currently still work in progress e.g. OS suspend/resume to disk, and
   2.161  various memory management enhancements to provide fast inter-OS
   2.162 @@ -364,9 +360,9 @@ xen-devel@lists.sourceforge.net mailing 
   2.163  Installing from the CD
   2.164  ======================
   2.165  
   2.166 -If you're installing Xen/XenoLinux onto an existing linux file system
   2.167 -distribution, just copy the Xen VMM (/boot/image.gz) and XenoLinux
   2.168 -kernels (/boot/xenolinux.gz), then modify the Grub config
   2.169 +If you're installing Xen/Xenlinux onto an existing linux file system
   2.170 +distribution, just copy the Xen VMM (/boot/image.gz) and Xenlinux
   2.171 +kernels (/boot/xenlinux.gz), then modify the Grub config
   2.172  (/boot/grub/menu.lst or /boot/grub/grub.conf) on the target system.
   2.173  It should work on pretty much any distribution.
   2.174  
   2.175 @@ -384,9 +380,9 @@ config file.
   2.176  
   2.177  A typical Grub menu option might look like:
   2.178  
   2.179 -title Xen / XenoLinux 2.4.22
   2.180 +title Xen / Xenlinux 2.4.22
   2.181          kernel /boot/image.gz dom0_mem=131072 com1=115200,8n1 noht
   2.182 -        module /boot/xenolinux.gz root=/dev/sda4 ro console=tty0
   2.183 +        module /boot/xenlinux.gz root=/dev/sda4 ro console=tty0
   2.184  
   2.185  The first line specifies which Xen image to use, and what command line
   2.186  arguments to pass to Xen. In this case we set the maximum amount of
   2.187 @@ -396,7 +392,7 @@ support (noht). If you have multiple net
   2.188  ifname=ethXX to select which one to use. If your network card is
   2.189  unsupported, use ifname=dummy
   2.190  
   2.191 -The second line specifies which xenolinux image to use, and the
   2.192 +The second line specifies which xenlinux image to use, and the
   2.193  standard linux command line arguments to pass to the kernel. In this
   2.194  case, we're configuring the root partition and stating that it should
   2.195  initially be mounted read-only (normal practice).
   2.196 @@ -469,7 +465,7 @@ Installing the file systems from the CD
   2.197  =======================================
   2.198  
   2.199  If you haven't got an existing Linux installation onto which you can
   2.200 -just drop down the Xen and XenoLinux images, then the file systems on
   2.201 +just drop down the Xen and Xenlinux images, then the file systems on
   2.202  the CD provide a quick way of doing an install. However, you're
   2.203  probably better off in the long run doing a proper Redhat, Fedora,
   2.204  Debian etc install rather than just doing the hack described below:
   2.205 @@ -515,7 +511,7 @@ keyboard to get a list of supported comm
   2.206  
   2.207  If you have a crash you'll likely get a crash dump containing an EIP
   2.208  (PC) which, along with an 'objdump -d image', can be useful in
   2.209 -figuring out what's happened.  Debug a XenoLinux image just as you
   2.210 +figuring out what's happened.  Debug a Xenlinux image just as you
   2.211  would any other Linux kernel.
   2.212  
   2.213  We supply a handy debug terminal program which you can find in
   2.214 @@ -527,10 +523,10 @@ then we supply a dumb TCP terminal clien
   2.215   'tools/xenctl/lib/console_client.py <server host> <server port>'
   2.216  
   2.217  
   2.218 -Installing Xen / XenoLinux on a RedHat distribution
   2.219 +Installing Xen / Xenlinux on a RedHat distribution
   2.220  ===================================================
   2.221  
   2.222 -When using Xen / Xenolinux on a standard Linux distribution there are
   2.223 +When using Xen / Xenlinux on a standard Linux distribution there are
   2.224  a couple of things to watch out for:
   2.225  
   2.226  The first Linux VM that is started when Xen boots start (Domain 0) is
   2.227 @@ -544,7 +540,7 @@ remove ttyN from /etc/inittab for domain
   2.228  /etc/rc.sysinit script #'ing the lines out of /etc/inittab won't work
   2.229  as it ignores the '#' and tries to access them anyway.
   2.230  
   2.231 -Every Xenolinux instance owns a bidirectional 'virtual console'.
   2.232 +Every Xenlinux instance owns a bidirectional 'virtual console'.
   2.233  The device node to which this console is attached can be configured
   2.234  by specifying 'xencons=' on the OS command line:
   2.235   'xencons=off'  --> disable virtual console
   2.236 @@ -570,7 +566,7 @@ 0, and run level 4 for domains>0. This e
   2.237  scripts to be run in depending on the run level number passed on the
   2.238  kernel command line.
   2.239  
   2.240 -Xenolinux kernels can be built to use runtime loadable modules just
   2.241 +Xenlinux kernels can be built to use runtime loadable modules just
   2.242  like normal linux kernels. Modules should be installed under
   2.243  /lib/modules in the normal way.
   2.244  
   2.245 @@ -625,7 +621,7 @@ should have written a little statically 
   2.246  Description of how the XenDemoCD boots
   2.247  ======================================
   2.248  
   2.249 -1. Grub is used to load Xen, a XenoLinux kernel, and an initrd (initial
   2.250 +1. Grub is used to load Xen, a Xenlinux kernel, and an initrd (initial
   2.251  ram disk). [The source of the version of Grub used is in /usr/local/src]
   2.252  
   2.253  2. the init=/linuxrc command line causes linux to execute /linuxrc in