view README @ 20963:da7ae6d8838a

x86: MCE fixes

- fill_vmsr_data() leaked a domain reference; since the caller already
obtained one, there's no need to obtain another one here
- intel_UCR_handler() could call put_domain() with a NULL pointer
- mcheck_mca_logout() updated a local data structure that wasn't used
after the update

Signed-off-by: Jan Beulich <>
author Keir Fraser <>
date Wed Feb 10 09:18:11 2010 +0000 (2010-02-10)
parents b928797213ac
children 71af69a9d393
line source
1 #################################
2 __ __ _ _ ___
3 \ \/ /___ _ __ | || | / _ \
4 \ // _ \ '_ \ | || |_| | | |
5 / \ __/ | | | |__ _| |_| |
6 /_/\_\___|_| |_| |_|(_)___/
8 #################################
12 What is Xen?
13 ============
15 Xen is a Virtual Machine Monitor (VMM) originally developed by the
16 Systems Research Group of the University of Cambridge Computer
17 Laboratory, as part of the UK-EPSRC funded XenoServers project. Xen
18 is freely-distributable Open Source software, released under the GNU
19 GPL. Since its initial public release, Xen has grown a large
20 development community, spearheaded by (
22 The 4.0 release offers excellent performance, hardware support and
23 enterprise-grade features such as x86_32-PAE, x86_64, SMP guests and
24 live relocation of VMs. Ports to Linux, NetBSD, FreeBSD and Solaris
25 are available from the community.
27 This file contains some quick-start instructions to install Xen on
28 your system. For full documentation, see the Xen User Manual. If this
29 is a pre-built release then you can find the manual at:
30 dist/install/usr/share/doc/xen/pdf/user.pdf
31 If you have a source release, then 'make -C docs' will build the
32 manual at docs/pdf/user.pdf.
34 Quick-Start Guide
35 =================
37 First, there are a number of prerequisites for building a Xen source
38 release. Make sure you have all the following installed, either by
39 visiting the project webpage or installing a pre-built package
40 provided by your Linux distributor:
41 * GCC v3.4 or later
42 * GNU Make
43 * GNU Binutils
44 * Development install of zlib (e.g., zlib-dev)
45 * Development install of Python v2.3 or later (e.g., python-dev)
46 * Development install of curses (e.g., libncurses-dev)
47 * Development install of openssl (e.g., openssl-dev)
48 * Development install of x11 (e.g. xorg-x11-dev)
49 * bridge-utils package (/sbin/brctl)
50 * iproute package (/sbin/ip)
51 * hotplug or udev
53 [NB. Unless noted otherwise, all the following steps should be
54 performed with root privileges.]
56 1. Download and untar the source tarball file. This will be a
57 file named xen-unstable-src.tgz, or xen-$version-src.tgz.
58 You can also pull the current version from the mercurial
59 repository at
61 # tar xzf xen-unstable-src.tgz
63 Assuming you are using the unstable tree, this will
64 untar into xen-unstable. The rest of the instructions
65 use the unstable tree as an example, substitute the
66 version for unstable.
68 2. cd to xen-unstable (or whatever you sensibly rename it to).
70 On Linux:
72 3. For the very first build, or if you want to destroy existing
73 .configs and build trees, perform the following steps:
75 # make world
76 # make install
78 This will create and install onto the local machine. It will build
79 the xen binary (xen.gz), and a linux kernel and modules that can be
80 used in both dom0 and an unprivileged guest kernel (vmlinuz-2.6.x-xen),
81 the tools and the documentation.
83 You can override the destination for make install by setting DESTDIR
84 to some value.
86 The make command line defaults to building the kernel vmlinuz-2.6.x-xen.
87 You can override this default by specifying KERNELS=kernelname. For
88 example, you can make two kernels - linux-2.6-xen0
89 and linux-2.6-xenU - which are smaller builds containing only selected
90 modules, intended primarily for developers that don't like to wait
91 for a full -xen kernel to build. The -xenU kernel is particularly small,
92 as it does not contain any physical device drivers, and hence is
93 only useful for guest domains.
95 To make these two kernels, simply specify
97 KERNELS="linux-2.6-xen0 linux-2.6-xenU"
99 in the make command line.
101 4. To rebuild an existing tree without modifying the config:
102 # make dist
104 This will build and install xen, kernels, tools, and
105 docs into the local dist/ directory.
107 You can override the destination for make install by setting DISTDIR
108 to some value.
110 make install and make dist differ in that make install does the
111 right things for your local machine (installing the appropriate
112 version of hotplug or udev scripts, for example), but make dist
113 includes all versions of those scripts, so that you can copy the dist
114 directory to another machine and install from that distribution.
116 5. To rebuild a kernel with a modified config:
118 # make linux-2.6-xen-config CONFIGMODE=menuconfig (or xconfig)
119 # make linux-2.6-xen-build
120 # make linux-2.6-xen-install
122 Depending on your config, you may need to use 'mkinitrd' to create
123 an initial ram disk, just like a native system e.g.
124 # depmod 2.6.18-xen
125 # mkinitrd -v -f --with=aacraid --with=sd_mod --with=scsi_mod initrd-2.6.18-xen.img 2.6.18-xen
127 Other systems may requires the use of 'mkinitramfs' to create the
128 ram disk.
129 # depmod 2.6.18-xen
130 # mkinitramfs -o initrd-2.6.18-xen.img 2.6.18-xen
133 Python Runtime Libraries
134 ========================
136 Xend (the Xen daemon) has the following runtime dependencies:
138 * Python 2.3 or later.
139 In many distros, the XML-aspects to the standard library
140 (xml.dom.minidom etc) are broken out into a separate python-xml package.
141 This is also required.
143 URL:
144 Debian: python, python-xml
146 * For optional SSL support, pyOpenSSL:
147 URL:
148 Debian: python-pyopenssl
150 * For optional PAM support, PyPAM:
151 URL:
152 Debian: python-pam
154 * For optional XenAPI support in XM, PyXML:
155 URL:
156 YUM: PyXML
159 Intel(R) Trusted Execution Technology Support
160 =============================================
162 Intel's technology for safer computing, Intel(R) Trusted Execution Technology
163 (Intel(R) TXT), defines platform-level enhancements that provide the building
164 blocks for creating trusted platforms. For more information, see
167 Intel(R) TXT support is provided by the Trusted Boot (tboot) module in
168 conjunction with minimal logic in the Xen hypervisor.
170 Tboot is an open source, pre- kernel/VMM module that uses Intel(R) TXT to
171 perform a measured and verified launch of an OS kernel/VMM.
173 The Trusted Boot module is available from
174 This project hosts the code in a
175 mercurial repo at and contains
176 tarballs of the source. Instructions in the tboot README describe how
177 to modify grub.conf to use tboot to launch Xen.
179 There are optional targets as part of Xen's top-level makefile that will
180 download and build tboot: install-tboot, build-tboot, dist-tboot, clean-tboot.
181 These will download the latest tar file from the SourceForge site using wget,
182 then build/install/dist according to Xen's settings.