|
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [Xen-changelog] [xen-unstable] docs: Remove outdated LaTex documentation.
# HG changeset patch
# User Keir Fraser <keir@xxxxxxx>
# Date 1327506767 0
# Node ID 4271634e4c86568b6bf2241ebf9be4a82ab430bf
# Parent a2a8089b1ffbf5757ca3191cb8f74a5f1ed7fed1
docs: Remove outdated LaTex documentation.
Signed-off-by: Keir Fraser <keir@xxxxxxx>
---
diff -r a2a8089b1ffb -r 4271634e4c86 Makefile
--- a/Makefile Tue Jan 24 16:46:17 2012 +0000
+++ b/Makefile Wed Jan 25 15:52:47 2012 +0000
@@ -104,7 +104,7 @@
.PHONY: install-docs
install-docs:
- sh ./docs/check_pkgs && $(MAKE) -C docs install || true
+ $(MAKE) -C docs install || true
.PHONY: dev-docs
dev-docs:
diff -r a2a8089b1ffb -r 4271634e4c86 docs/INDEX
--- a/docs/INDEX Tue Jan 24 16:46:17 2012 +0000
+++ b/docs/INDEX Wed Jan 25 15:52:47 2012 +0000
@@ -5,7 +5,3 @@
misc Miscellaneous Documentation
misc/hvm-emulated-unplug Xen HVM emulated device unplug protocol
misc/console Xen PV Console notes
-
-# These are not all that useful anymore, hide them from the index
-reference/interface/index NO-INDEX
-reference/user/index NO-INDEX
diff -r a2a8089b1ffb -r 4271634e4c86 docs/Makefile
--- a/docs/Makefile Tue Jan 24 16:46:17 2012 +0000
+++ b/docs/Makefile Wed Jan 25 15:52:47 2012 +0000
@@ -10,12 +10,8 @@
DOC_MAN1SRC := $(wildcard man/*.pod.1)
DOC_MAN1 := $(patsubst man/%.pod.1,man1/%.1,$(DOC_MAN1SRC))
DOC_MAN5 := $(patsubst man/%.pod.5,man5/%.5,$(DOC_MAN5SRC))
-DOC_TEX := src/user.tex src/interface.tex
DOC_MARKDOWN := $(wildcard misc/*.markdown)
-DOC_PS := $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
-DOC_PDF := $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
-DOC_HTML := $(patsubst src/%.tex,html/reference/%/index.html,$(DOC_TEX))
\
- $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) \
+DOC_HTML := $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) \
$(patsubst man/%.pod.1,html/man/%.1.html,$(DOC_MAN1SRC)) \
$(patsubst man/%.pod.5,html/man/%.5.html,$(DOC_MAN5SRC)) \
$(patsubst %.txt,html/%.txt,$(wildcard misc/*.txt)) \
@@ -25,13 +21,11 @@
$(patsubst man/%.pod.1,txt/man/%.1.txt,$(DOC_MAN1SRC)) \
$(patsubst man/%.pod.5,txt/man/%.5.txt,$(DOC_MAN5SRC))
-GFX = $(patsubst %.fig, %.eps, $(wildcard figs/*.fig))
-
.PHONY: all
all: build
.PHONY: build
-build: ps pdf html txt man-pages
+build: html txt man-pages
@if which $(DOT) 1>/dev/null 2>/dev/null ; then \
$(MAKE) -C xen-api build ; else \
echo "Graphviz (dot) not installed; skipping xen-api." ; fi
@@ -40,12 +34,6 @@
.PHONY: dev-docs
dev-docs: python-dev-docs
-.PHONY: ps
-ps: $(DOC_PS)
-
-.PHONY: pdf
-pdf: $(DOC_PDF)
-
.PHONY: html
html: $(DOC_HTML) html/index.html
@@ -82,7 +70,7 @@
$(MAKE) -C xen-api clean
rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~
rm -rf *.ilg *.log *.ind *.toc *.bak core
- rm -rf $(GFX) ps pdf html txt
+ rm -rf html txt
rm -rf api
rm -rf man5
rm -rf man1
@@ -97,39 +85,11 @@
$(MAKE) -C xen-api install
- cp -dR ps $(DESTDIR)$(DOCDIR)
- cp -dR pdf $(DESTDIR)$(DOCDIR)
$(INSTALL_DIR) $(DESTDIR)$(MANDIR)
cp -dR man1 $(DESTDIR)$(MANDIR)
cp -dR man5 $(DESTDIR)$(MANDIR)
[ ! -d html ] || cp -dR html $(DESTDIR)$(DOCDIR)
-pdf/%.pdf: ps/%.ps
- $(INSTALL_DIR) $(@D)
- $(PS2PDF) $< $@.new
- mv $@.new $@
-
-ps/%.ps: %.dvi
- $(INSTALL_DIR) $(@D)
- $(DVIPS) -Ppdf -G0 -o $@.new $<
- mv $@.new $@
-
-%.dvi: src/%.tex $(GFX)
- $(LATEX) $< >/dev/null
- if [ -e $*.toc ] ; then $(LATEX) $< >/dev/null ; fi
-
-%.eps: %.fig
- $(FIG2DEV) -L eps $< $@
-
-html/reference/%/index.html: src/%.tex
- @$(INSTALL_DIR) $(@D)
- @set -e ; if which $(LATEX2HTML) 1>/dev/null 2>/dev/null; then \
- echo "Running latex2html to generate reference/$*/index.html ... "; \
- $(LATEX2HTML) -split 0 -show_section_numbers -toc_depth 3 -nonavigation
\
- -numbered_footnotes -local_icons -noinfo -math -dir $(@D) \
- $< 1>/dev/null 2>/dev/null ; else \
- echo "latex2html not installed; skipping reference/$*."; fi
-
html/index.html: $(DOC_HTML) ./gen-html-index INDEX
perl -w -- ./gen-html-index -i INDEX html $(DOC_HTML)
diff -r a2a8089b1ffb -r 4271634e4c86 docs/check_pkgs
--- a/docs/check_pkgs Tue Jan 24 16:46:17 2012 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,20 +0,0 @@
-
-silent_which ()
-{
- which $1 1>/dev/null 2>/dev/null || {
- echo "================================================="
- echo "================================================="
- echo "= WARNING: Package '$1' is required"
- echo "= to build Xen documentation"
- echo "================================================="
- echo "================================================="
- }
- which $1 1>/dev/null 2>/dev/null
-}
-
-silent_which latex || exit 1
-silent_which dvips || exit 1
-silent_which ps2pdf || exit 1
-silent_which fig2dev || exit 1
-
-exit 0
diff -r a2a8089b1ffb -r 4271634e4c86 docs/src/interface.tex
--- a/docs/src/interface.tex Tue Jan 24 16:46:17 2012 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,2216 +0,0 @@
-\documentclass[11pt,twoside,final,openright,a4paper]{report}
-\usepackage{graphicx,html,setspace,times}
-\usepackage{parskip}
-\setstretch{1.15}
-
-% LIBRARY FUNCTIONS
-
-\newcommand{\hypercall}[1]{\vspace{2mm}{\sf #1}}
-
-\begin{document}
-
-% TITLE PAGE
-\pagestyle{empty}
-\begin{center}
-\vspace*{\fill}
-\includegraphics{figs/xenlogo.eps}
-\vfill
-\vfill
-\vfill
-\begin{tabular}{l}
-{\Huge \bf Interface manual} \\[4mm]
-{\huge Xen v3.0 for x86} \\[80mm]
-
-{\Large Xen is Copyright (c) 2002-2005, The Xen Team} \\[3mm]
-{\Large University of Cambridge, UK} \\[20mm]
-\end{tabular}
-\end{center}
-
-{\bf DISCLAIMER: This documentation is always under active development
-and as such there may be mistakes and omissions --- watch out for
-these and please report any you find to the developer's mailing list.
-The latest version is always available on-line. Contributions of
-material, suggestions and corrections are welcome. }
-
-\vfill
-\cleardoublepage
-
-% TABLE OF CONTENTS
-\pagestyle{plain}
-\pagenumbering{roman}
-{ \parskip 0pt plus 1pt
- \tableofcontents }
-\cleardoublepage
-
-% PREPARE FOR MAIN TEXT
-\pagenumbering{arabic}
-\raggedbottom
-\widowpenalty=10000
-\clubpenalty=10000
-\parindent=0pt
-\parskip=5pt
-\renewcommand{\topfraction}{.8}
-\renewcommand{\bottomfraction}{.8}
-\renewcommand{\textfraction}{.2}
-\renewcommand{\floatpagefraction}{.8}
-\setstretch{1.1}
-
-\chapter{Introduction}
-
-Xen allows the hardware resources of a machine to be virtualized and
-dynamically partitioned, allowing multiple different {\em guest}
-operating system images to be run simultaneously. Virtualizing the
-machine in this manner provides considerable flexibility, for example
-allowing different users to choose their preferred operating system
-(e.g., Linux, NetBSD, or a custom operating system). Furthermore, Xen
-provides secure partitioning between virtual machines (known as
-{\em domains} in Xen terminology), and enables better resource
-accounting and QoS isolation than can be achieved with a conventional
-operating system.
-
-Xen essentially takes a `whole machine' virtualization approach as
-pioneered by IBM VM/370. However, unlike VM/370 or more recent
-efforts such as VMware and Virtual PC, Xen does not attempt to
-completely virtualize the underlying hardware. Instead parts of the
-hosted guest operating systems are modified to work with the VMM; the
-operating system is effectively ported to a new target architecture,
-typically requiring changes in just the machine-dependent code. The
-user-level API is unchanged, and so existing binaries and operating
-system distributions work without modification.
-
-In addition to exporting virtualized instances of CPU, memory, network
-and block devices, Xen exposes a control interface to manage how these
-resources are shared between the running domains. Access to the
-control interface is restricted: it may only be used by one
-specially-privileged VM, known as {\em domain 0}. This domain is a
-required part of any Xen-based server and runs the application software
-that manages the control-plane aspects of the platform. Running the
-control software in {\it domain 0}, distinct from the hypervisor
-itself, allows the Xen framework to separate the notions of
-mechanism and policy within the system.
-
-
-\chapter{Virtual Architecture}
-
-In a Xen/x86 system, only the hypervisor runs with full processor
-privileges ({\it ring 0} in the x86 four-ring model). It has full
-access to the physical memory available in the system and is
-responsible for allocating portions of it to running domains.
-
-On a 32-bit x86 system, guest operating systems may use {\it rings 1},
-{\it 2} and {\it 3} as they see fit. Segmentation is used to prevent
-the guest OS from accessing the portion of the address space that is
-reserved for Xen. We expect most guest operating systems will use
-ring 1 for their own operation and place applications in ring 3.
-
-On 64-bit systems it is not possible to protect the hypervisor from
-untrusted guest code running in rings 1 and 2. Guests are therefore
-restricted to run in ring 3 only. The guest kernel is protected from its
-applications by context switching between the kernel and currently
-running application.
-
-In this chapter we consider the basic virtual architecture provided by
-Xen: CPU state, exception and interrupt handling, and time.
-Other aspects such as memory and device access are discussed in later
-chapters.
-
-
-\section{CPU state}
-
-All privileged state must be handled by Xen. The guest OS has no
-direct access to CR3 and is not permitted to update privileged bits in
-EFLAGS. Guest OSes use \emph{hypercalls} to invoke operations in Xen;
-these are analogous to system calls but occur from ring 1 to ring 0.
-
-A list of all hypercalls is given in Appendix~\ref{a:hypercalls}.
-
-
-\section{Exceptions}
-
-A virtual IDT is provided --- a domain can submit a table of trap
-handlers to Xen via the {\bf set\_trap\_table} hypercall. The
-exception stack frame presented to a virtual trap handler is identical
-to its native equivalent.
-
-
-\section{Interrupts and events}
-
-Interrupts are virtualized by mapping them to \emph{event channels},
-which are delivered asynchronously to the target domain using a callback
-supplied via the {\bf set\_callbacks} hypercall. A guest OS can map
-these events onto its standard interrupt dispatch mechanisms. Xen is
-responsible for determining the target domain that will handle each
-physical interrupt source. For more details on the binding of event
-sources to event channels, see Chapter~\ref{c:devices}.
-
-
-\section{Time}
-
-Guest operating systems need to be aware of the passage of both real
-(or wallclock) time and their own `virtual time' (the time for which
-they have been executing). Furthermore, Xen has a notion of time which
-is used for scheduling. The following notions of time are provided:
-
-\begin{description}
-\item[Cycle counter time.]
-
- This provides a fine-grained time reference. The cycle counter time
- is used to accurately extrapolate the other time references. On SMP
- machines it is currently assumed that the cycle counter time is
- synchronized between CPUs. The current x86-based implementation
- achieves this within inter-CPU communication latencies.
-
-\item[System time.]
-
- This is a 64-bit counter which holds the number of nanoseconds that
- have elapsed since system boot.
-
-\item[Wall clock time.]
-
- This is the time of day in a Unix-style {\bf struct timeval}
- (seconds and microseconds since 1 January 1970, adjusted by leap
- seconds). An NTP client hosted by {\it domain 0} can keep this
- value accurate.
-
-\item[Domain virtual time.]
-
- This progresses at the same pace as system time, but only while a
- domain is executing --- it stops while a domain is de-scheduled.
- Therefore the share of the CPU that a domain receives is indicated
- by the rate at which its virtual time increases.
-
-\end{description}
-
-
-Xen exports timestamps for system time and wall-clock time to guest
-operating systems through a shared page of memory. Xen also provides
-the cycle counter time at the instant the timestamps were calculated,
-and the CPU frequency in Hertz. This allows the guest to extrapolate
-system and wall-clock times accurately based on the current cycle
-counter time.
-
-Since all time stamps need to be updated and read \emph{atomically}
-a version number is also stored in the shared info page, which is
-incremented before and after updating the timestamps. Thus a guest can
-be sure that it read a consistent state by checking the two version
-numbers are equal and even.
-
-Xen includes a periodic ticker which sends a timer event to the
-currently executing domain every 10ms. The Xen scheduler also sends a
-timer event whenever a domain is scheduled; this allows the guest OS
-to adjust for the time that has passed while it has been inactive. In
-addition, Xen allows each domain to request that they receive a timer
-event sent at a specified system time by using the {\bf
- set\_timer\_op} hypercall. Guest OSes may use this timer to
-implement timeout values when they block.
-
-
-\section{Xen CPU Scheduling}
-
-Xen offers a uniform API for CPU schedulers. It is possible to choose
-from a number of schedulers at boot and it should be easy to add more.
-The SEDF and Credit schedulers are part of the normal Xen
-distribution. SEDF will be going away and its use should be
-avoided once the credit scheduler has stabilized and become the default.
-The Credit scheduler provides proportional fair shares of the
-host's CPUs to the running domains. It does this while transparently
-load balancing runnable VCPUs across the whole system.
-
-\paragraph*{Note: SMP host support}
-Xen has always supported SMP host systems. When using the credit scheduler,
-a domain's VCPUs will be dynamically moved across physical CPUs to maximise
-domain and system throughput. VCPUs can also be manually restricted to be
-mapped only on a subset of the host's physical CPUs, using the pinning
-mechanism.
-
-
-%% More information on the characteristics and use of these schedulers
-%% is available in {\bf Sched-HOWTO.txt}.
-
-
-\section{Privileged operations}
-
-Xen exports an extended interface to privileged domains (viz.\ {\it
- Domain 0}). This allows such domains to build and boot other domains
-on the server, and provides control interfaces for managing
-scheduling, memory, networking, and block devices.
-
-\chapter{Memory}
-\label{c:memory}
-
-Xen is responsible for managing the allocation of physical memory to
-domains, and for ensuring safe use of the paging and segmentation
-hardware.
-
-
-\section{Memory Allocation}
-
-As well as allocating a portion of physical memory for its own private
-use, Xen also reserves s small fixed portion of every virtual address
-space. This is located in the top 64MB on 32-bit systems, the top
-168MB on PAE systems, and a larger portion in the middle of the
-address space on 64-bit systems. Unreserved physical memory is
-available for allocation to domains at a page granularity. Xen tracks
-the ownership and use of each page, which allows it to enforce secure
-partitioning between domains.
-
-Each domain has a maximum and current physical memory allocation. A
-guest OS may run a `balloon driver' to dynamically adjust its current
-memory allocation up to its limit.
-
-
-\section{Pseudo-Physical Memory}
-
-Since physical memory is allocated and freed on a page granularity,
-there is no guarantee that a domain will receive a contiguous stretch
-of physical memory. However most operating systems do not have good
-support for operating in a fragmented physical address space. To aid
-porting such operating systems to run on top of Xen, we make a
-distinction between \emph{machine memory} and \emph{pseudo-physical
- memory}.
-
-Put simply, machine memory refers to the entire amount of memory
-installed in the machine, including that reserved by Xen, in use by
-various domains, or currently unallocated. We consider machine memory
-to comprise a set of 4kB \emph{machine page frames} numbered
-consecutively starting from 0. Machine frame numbers mean the same
-within Xen or any domain.
-
-Pseudo-physical memory, on the other hand, is a per-domain
-abstraction. It allows a guest operating system to consider its memory
-allocation to consist of a contiguous range of physical page frames
-starting at physical frame 0, despite the fact that the underlying
-machine page frames may be sparsely allocated and in any order.
-
-To achieve this, Xen maintains a globally readable {\it
- machine-to-physical} table which records the mapping from machine
-page frames to pseudo-physical ones. In addition, each domain is
-supplied with a {\it physical-to-machine} table which performs the
-inverse mapping. Clearly the machine-to-physical table has size
-proportional to the amount of RAM installed in the machine, while each
-physical-to-machine table has size proportional to the memory
-allocation of the given domain.
-
-Architecture dependent code in guest operating systems can then use
-the two tables to provide the abstraction of pseudo-physical memory.
-In general, only certain specialized parts of the operating system
-(such as page table management) needs to understand the difference
-between machine and pseudo-physical addresses.
-
-
-\section{Page Table Updates}
-
-In the default mode of operation, Xen enforces read-only access to
-page tables and requires guest operating systems to explicitly request
-any modifications. Xen validates all such requests and only applies
-updates that it deems safe. This is necessary to prevent domains from
-adding arbitrary mappings to their page tables.
-
-To aid validation, Xen associates a type and reference count with each
-memory page. A page has one of the following mutually-exclusive types
-at any point in time: page directory ({\sf PD}), page table ({\sf
- PT}), local descriptor table ({\sf LDT}), global descriptor table
-({\sf GDT}), or writable ({\sf RW}). Note that a guest OS may always
-create readable mappings of its own memory regardless of its current
-type.
-
-%%% XXX: possibly explain more about ref count 'lifecyle' here?
-This mechanism is used to maintain the invariants required for safety;
-for example, a domain cannot have a writable mapping to any part of a
-page table as this would require the page concerned to simultaneously
-be of types {\sf PT} and {\sf RW}.
-
-\hypercall{mmu\_update(mmu\_update\_t *req, int count, int *success\_count,
domid\_t domid)}
-
-This hypercall is used to make updates to either the domain's
-pagetables or to the machine to physical mapping table. It supports
-submitting a queue of updates, allowing batching for maximal
-performance. Explicitly queuing updates using this interface will
-cause any outstanding writable pagetable state to be flushed from the
-system.
-
-\section{Writable Page Tables}
-
-Xen also provides an alternative mode of operation in which guests
-have the illusion that their page tables are directly writable. Of
-course this is not really the case, since Xen must still validate
-modifications to ensure secure partitioning. To this end, Xen traps
-any write attempt to a memory page of type {\sf PT} (i.e., that is
-currently part of a page table). If such an access occurs, Xen
-temporarily allows write access to that page while at the same time
-\emph{disconnecting} it from the page table that is currently in use.
-This allows the guest to safely make updates to the page because the
-newly-updated entries cannot be used by the MMU until Xen revalidates
-and reconnects the page. Reconnection occurs automatically in a
-number of situations: for example, when the guest modifies a different
-page-table page, when the domain is preempted, or whenever the guest
-uses Xen's explicit page-table update interfaces.
-
-Writable pagetable functionality is enabled when the guest requests
-it, using a {\bf vm\_assist} hypercall. Writable pagetables do {\em
-not} provide full virtualisation of the MMU, so the memory management
-code of the guest still needs to be aware that it is running on Xen.
-Since the guest's page tables are used directly, it must translate
-pseudo-physical addresses to real machine addresses when building page
-table entries. The guest may not attempt to map its own pagetables
-writably, since this would violate the memory type invariants; page
-tables will automatically be made writable by the hypervisor, as
-necessary.
-
-\section{Shadow Page Tables}
-
-Finally, Xen also supports a form of \emph{shadow page tables} in
-which the guest OS uses a independent copy of page tables which are
-unknown to the hardware (i.e.\ which are never pointed to by {\tt
- cr3}). Instead Xen propagates changes made to the guest's tables to
-the real ones, and vice versa. This is useful for logging page writes
-(e.g.\ for live migration or checkpoint). A full version of the shadow
-page tables also allows guest OS porting with less effort.
-
-
-\section{Segment Descriptor Tables}
-
-At start of day a guest is supplied with a default GDT, which does not reside
-within its own memory allocation. If the guest wishes to use other
-than the default `flat' ring-1 and ring-3 segments that this GDT
-provides, it must register a custom GDT and/or LDT with Xen, allocated
-from its own memory.
-
-The following hypercall is used to specify a new GDT:
-
-\begin{quote}
- int {\bf set\_gdt}(unsigned long *{\em frame\_list}, int {\em
- entries})
-
- \emph{frame\_list}: An array of up to 14 machine page frames within
- which the GDT resides. Any frame registered as a GDT frame may only
- be mapped read-only within the guest's address space (e.g., no
- writable mappings, no use as a page-table page, and so on). Only 14
- pages may be specified because pages 15 and 16 are reserved for
- the hypervisor's GDT entries.
-
- \emph{entries}: The number of descriptor-entry slots in the GDT.
-\end{quote}
-
-The LDT is updated via the generic MMU update mechanism (i.e., via the
-{\bf mmu\_update} hypercall.
-
-\section{Start of Day}
-
-The start-of-day environment for guest operating systems is rather
-different to that provided by the underlying hardware. In particular,
-the processor is already executing in protected mode with paging
-enabled.
-
-{\it Domain 0} is created and booted by Xen itself. For all subsequent
-domains, the analogue of the boot-loader is the {\it domain builder},
-user-space software running in {\it domain 0}. The domain builder is
-responsible for building the initial page tables for a domain and
-loading its kernel image at the appropriate virtual address.
-
-\section{VM assists}
-
-Xen provides a number of ``assists'' for guest memory management.
-These are available on an ``opt-in'' basis to provide commonly-used
-extra functionality to a guest.
-
-\hypercall{vm\_assist(unsigned int cmd, unsigned int type)}
-
-The {\bf cmd} parameter describes the action to be taken, whilst the
-{\bf type} parameter describes the kind of assist that is being
-referred to. Available commands are as follows:
-
-\begin{description}
-\item[VMASST\_CMD\_enable] Enable a particular assist type
-\item[VMASST\_CMD\_disable] Disable a particular assist type
-\end{description}
-
-And the available types are:
-
-\begin{description}
-\item[VMASST\_TYPE\_4gb\_segments] Provide emulated support for
- instructions that rely on 4GB segments (such as the techniques used
- by some TLS solutions).
-\item[VMASST\_TYPE\_4gb\_segments\_notify] Provide a callback (via trap number
- 15) to the guest if the above segment fixups are used: allows the guest to
- display a warning message during boot.
-\item[VMASST\_TYPE\_writable\_pagetables] Enable writable pagetable
- mode - described above.
-\end{description}
-
-
-\chapter{Xen Info Pages}
-
-The {\bf Shared info page} is used to share various CPU-related state
-between the guest OS and the hypervisor. This information includes VCPU
-status, time information and event channel (virtual interrupt) state.
-The {\bf Start info page} is used to pass build-time information to
-the guest when it boots and when it is resumed from a suspended state.
-This chapter documents the fields included in the {\bf
-shared\_info\_t} and {\bf start\_info\_t} structures for use by the
-guest OS.
-
-\section{Shared info page}
-
-The {\bf shared\_info\_t} is accessed at run time by both Xen and the
-guest OS. It is used to pass information relating to the
-virtual CPU and virtual machine state between the OS and the
-hypervisor.
-
-The structure is declared in {\bf xen/include/public/xen.h}:
-
-\scriptsize
-\begin{verbatim}
-typedef struct shared_info {
- vcpu_info_t vcpu_info[XEN_LEGACY_MAX_VCPUS];
-
- /*
- * A domain can create "event channels" on which it can send and receive
- * asynchronous event notifications. There are three classes of event that
- * are delivered by this mechanism:
- * 1. Bi-directional inter- and intra-domain connections. Domains must
- * arrange out-of-band to set up a connection (usually by allocating
- * an unbound 'listener' port and advertising that via a storage
service
- * such as xenstore).
- * 2. Physical interrupts. A domain with suitable hardware-access
- * privileges can bind an event-channel port to a physical interrupt
- * source.
- * 3. Virtual interrupts ('events'). A domain can bind an event-channel
- * port to a virtual interrupt source, such as the virtual-timer
- * device or the emergency console.
- *
- * Event channels are addressed by a "port index". Each channel is
- * associated with two bits of information:
- * 1. PENDING -- notifies the domain that there is a pending notification
- * to be processed. This bit is cleared by the guest.
- * 2. MASK -- if this bit is clear then a 0->1 transition of PENDING
- * will cause an asynchronous upcall to be scheduled. This bit is only
- * updated by the guest. It is read-only within Xen. If a channel
- * becomes pending while the channel is masked then the 'edge' is lost
- * (i.e., when the channel is unmasked, the guest must manually handle
- * pending notifications as no upcall will be scheduled by Xen).
- *
- * To expedite scanning of pending notifications, any 0->1 pending
- * transition on an unmasked channel causes a corresponding bit in a
- * per-vcpu selector word to be set. Each bit in the selector covers a
- * 'C long' in the PENDING bitfield array.
- */
- unsigned long evtchn_pending[sizeof(unsigned long) * 8];
- unsigned long evtchn_mask[sizeof(unsigned long) * 8];
-
- /*
- * Wallclock time: updated only by control software. Guests should base
- * their gettimeofday() syscall on this wallclock-base value.
- */
- uint32_t wc_version; /* Version counter: see vcpu_time_info_t. */
- uint32_t wc_sec; /* Secs 00:00:00 UTC, Jan 1, 1970. */
- uint32_t wc_nsec; /* Nsecs 00:00:00 UTC, Jan 1, 1970. */
-
- arch_shared_info_t arch;
-
-} shared_info_t;
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[vcpu\_info] An array of {\bf vcpu\_info\_t} structures, each of
- which holds either runtime information about a virtual CPU, or is
- ``empty'' if the corresponding VCPU does not exist.
-\item[evtchn\_pending] Guest-global array, with one bit per event
- channel. Bits are set if an event is currently pending on that
- channel.
-\item[evtchn\_mask] Guest-global array for masking notifications on
- event channels.
-\item[wc\_version] Version counter for current wallclock time.
-\item[wc\_sec] Whole seconds component of current wallclock time.
-\item[wc\_nsec] Nanoseconds component of current wallclock time.
-\item[arch] Host architecture-dependent portion of the shared info
- structure.
-\end{description}
-
-\subsection{vcpu\_info\_t}
-
-\scriptsize
-\begin{verbatim}
-typedef struct vcpu_info {
- /*
- * 'evtchn_upcall_pending' is written non-zero by Xen to indicate
- * a pending notification for a particular VCPU. It is then cleared
- * by the guest OS /before/ checking for pending work, thus avoiding
- * a set-and-check race. Note that the mask is only accessed by Xen
- * on the CPU that is currently hosting the VCPU. This means that the
- * pending and mask flags can be updated by the guest without special
- * synchronisation (i.e., no need for the x86 LOCK prefix).
- * This may seem suboptimal because if the pending flag is set by
- * a different CPU then an IPI may be scheduled even when the mask
- * is set. However, note:
- * 1. The task of 'interrupt holdoff' is covered by the per-event-
- * channel mask bits. A 'noisy' event that is continually being
- * triggered can be masked at source at this very precise
- * granularity.
- * 2. The main purpose of the per-VCPU mask is therefore to restrict
- * reentrant execution: whether for concurrency control, or to
- * prevent unbounded stack usage. Whatever the purpose, we expect
- * that the mask will be asserted only for short periods at a time,
- * and so the likelihood of a 'spurious' IPI is suitably small.
- * The mask is read before making an event upcall to the guest: a
- * non-zero mask therefore guarantees that the VCPU will not receive
- * an upcall activation. The mask is cleared when the VCPU requests
- * to block: this avoids wakeup-waiting races.
- */
- uint8_t evtchn_upcall_pending;
- uint8_t evtchn_upcall_mask;
- unsigned long evtchn_pending_sel;
- arch_vcpu_info_t arch;
- vcpu_time_info_t time;
-} vcpu_info_t; /* 64 bytes (x86) */
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[evtchn\_upcall\_pending] This is set non-zero by Xen to indicate
- that there are pending events to be received.
-\item[evtchn\_upcall\_mask] This is set non-zero to disable all
- interrupts for this CPU for short periods of time. If individual
- event channels need to be masked, the {\bf evtchn\_mask} in the {\bf
- shared\_info\_t} is used instead.
-\item[evtchn\_pending\_sel] When an event is delivered to this VCPU, a
- bit is set in this selector to indicate which word of the {\bf
- evtchn\_pending} array in the {\bf shared\_info\_t} contains the
- event in question.
-\item[arch] Architecture-specific VCPU info. On x86 this contains the
- virtualized CR2 register (page fault linear address) for this VCPU.
-\item[time] Time values for this VCPU.
-\end{description}
-
-\subsection{vcpu\_time\_info}
-
-\scriptsize
-\begin{verbatim}
-typedef struct vcpu_time_info {
- /*
- * Updates to the following values are preceded and followed by an
- * increment of 'version'. The guest can therefore detect updates by
- * looking for changes to 'version'. If the least-significant bit of
- * the version number is set then an update is in progress and the guest
- * must wait to read a consistent set of values.
- * The correct way to interact with the version number is similar to
- * Linux's seqlock: see the implementations of read_seqbegin/read_seqretry.
- */
- uint32_t version;
- uint32_t pad0;
- uint64_t tsc_timestamp; /* TSC at last update of time vals. */
- uint64_t system_time; /* Time, in nanosecs, since boot. */
- /*
- * Current system time:
- * system_time + ((tsc - tsc_timestamp) << tsc_shift) * tsc_to_system_mul
- * CPU frequency (Hz):
- * ((10^9 << 32) / tsc_to_system_mul) >> tsc_shift
- */
- uint32_t tsc_to_system_mul;
- int8_t tsc_shift;
- int8_t pad1[3];
-} vcpu_time_info_t; /* 32 bytes */
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[version] Used to ensure the guest gets consistent time updates.
-\item[tsc\_timestamp] Cycle counter timestamp of last time value;
- could be used to expolate in between updates, for instance.
-\item[system\_time] Time since boot (nanoseconds).
-\item[tsc\_to\_system\_mul] Cycle counter to nanoseconds multiplier
-(used in extrapolating current time).
-\item[tsc\_shift] Cycle counter to nanoseconds shift (used in
-extrapolating current time).
-\end{description}
-
-\subsection{arch\_shared\_info\_t}
-
-On x86, the {\bf arch\_shared\_info\_t} is defined as follows (from
-xen/public/arch-x86\_32.h):
-
-\scriptsize
-\begin{verbatim}
-typedef struct arch_shared_info {
- unsigned long max_pfn; /* max pfn that appears in table */
- /* Frame containing list of mfns containing list of mfns containing p2m. */
- unsigned long pfn_to_mfn_frame_list_list;
-} arch_shared_info_t;
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[max\_pfn] The maximum PFN listed in the physical-to-machine
- mapping table (P2M table).
-\item[pfn\_to\_mfn\_frame\_list\_list] Machine address of the frame
- that contains the machine addresses of the P2M table frames.
-\end{description}
-
-\section{Start info page}
-
-The start info structure is declared as the following (in {\bf
-xen/include/public/xen.h}):
-
-\scriptsize
-\begin{verbatim}
-#define MAX_GUEST_CMDLINE 1024
-typedef struct start_info {
- /* THE FOLLOWING ARE FILLED IN BOTH ON INITIAL BOOT AND ON RESUME. */
- char magic[32]; /* "Xen-<version>.<subversion>". */
- unsigned long nr_pages; /* Total pages allocated to this domain. */
- unsigned long shared_info; /* MACHINE address of shared info struct. */
- uint32_t flags; /* SIF_xxx flags. */
- unsigned long store_mfn; /* MACHINE page number of shared page. */
- uint32_t store_evtchn; /* Event channel for store communication. */
- unsigned long console_mfn; /* MACHINE address of console page. */
- uint32_t console_evtchn; /* Event channel for console messages. */
- /* THE FOLLOWING ARE ONLY FILLED IN ON INITIAL BOOT (NOT RESUME). */
- unsigned long pt_base; /* VIRTUAL address of page directory. */
- unsigned long nr_pt_frames; /* Number of bootstrap p.t. frames. */
- unsigned long mfn_list; /* VIRTUAL address of page-frame list. */
- unsigned long mod_start; /* VIRTUAL address of pre-loaded module. */
- unsigned long mod_len; /* Size (bytes) of pre-loaded module. */
- int8_t cmd_line[MAX_GUEST_CMDLINE];
-} start_info_t;
-\end{verbatim}
-\normalsize
-
-The fields are in two groups: the first group are always filled in
-when a domain is booted or resumed, the second set are only used at
-boot time.
-
-The always-available group is as follows:
-
-\begin{description}
-\item[magic] A text string identifying the Xen version to the guest.
-\item[nr\_pages] The number of real machine pages available to the
- guest.
-\item[shared\_info] Machine address of the shared info structure,
- allowing the guest to map it during initialisation.
-\item[flags] Flags for describing optional extra settings to the
- guest.
-\item[store\_mfn] Machine address of the Xenstore communications page.
-\item[store\_evtchn] Event channel to communicate with the store.
-\item[console\_mfn] Machine address of the console data page.
-\item[console\_evtchn] Event channel to notify the console backend.
-\end{description}
-
-The boot-only group may only be safely referred to during system boot:
-
-\begin{description}
-\item[pt\_base] Virtual address of the page directory created for us
- by the domain builder.
-\item[nr\_pt\_frames] Number of frames used by the builders' bootstrap
- pagetables.
-\item[mfn\_list] Virtual address of the list of machine frames this
- domain owns.
-\item[mod\_start] Virtual address of any pre-loaded modules
- (e.g. ramdisk)
-\item[mod\_len] Size of pre-loaded module (if any).
-\item[cmd\_line] Kernel command line passed by the domain builder.
-\end{description}
-
-
-% by Mark Williamson <mark.williamson@xxxxxxxxxxxx>
-
-\chapter{Event Channels}
-\label{c:eventchannels}
-
-Event channels are the basic primitive provided by Xen for event
-notifications. An event is the Xen equivalent of a hardware
-interrupt. They essentially store one bit of information, the event
-of interest is signalled by transitioning this bit from 0 to 1.
-
-Notifications are received by a guest via an upcall from Xen,
-indicating when an event arrives (setting the bit). Further
-notifications are masked until the bit is cleared again (therefore,
-guests must check the value of the bit after re-enabling event
-delivery to ensure no missed notifications).
-
-Event notifications can be masked by setting a flag; this is
-equivalent to disabling interrupts and can be used to ensure atomicity
-of certain operations in the guest kernel.
-
-\section{Hypercall interface}
-
-\hypercall{event\_channel\_op(evtchn\_op\_t *op)}
-
-The event channel operation hypercall is used for all operations on
-event channels / ports. Operations are distinguished by the value of
-the {\bf cmd} field of the {\bf op} structure. The possible commands
-are described below:
-
-\begin{description}
-
-\item[EVTCHNOP\_alloc\_unbound]
- Allocate a new event channel port, ready to be connected to by a
- remote domain.
- \begin{itemize}
- \item Specified domain must exist.
- \item A free port must exist in that domain.
- \end{itemize}
- Unprivileged domains may only allocate their own ports, privileged
- domains may also allocate ports in other domains.
-\item[EVTCHNOP\_bind\_interdomain]
- Bind an event channel for interdomain communications.
- \begin{itemize}
- \item Caller domain must have a free port to bind.
- \item Remote domain must exist.
- \item Remote port must be allocated and currently unbound.
- \item Remote port must be expecting the caller domain as the ``remote''.
- \end{itemize}
-\item[EVTCHNOP\_bind\_virq]
- Allocate a port and bind a VIRQ to it.
- \begin{itemize}
- \item Caller domain must have a free port to bind.
- \item VIRQ must be valid.
- \item VCPU must exist.
- \item VIRQ must not currently be bound to an event channel.
- \end{itemize}
-\item[EVTCHNOP\_bind\_ipi]
- Allocate and bind a port for notifying other virtual CPUs.
- \begin{itemize}
- \item Caller domain must have a free port to bind.
- \item VCPU must exist.
- \end{itemize}
-\item[EVTCHNOP\_bind\_pirq]
- Allocate and bind a port to a real IRQ.
- \begin{itemize}
- \item Caller domain must have a free port to bind.
- \item PIRQ must be within the valid range.
- \item Another binding for this PIRQ must not exist for this domain.
- \item Caller must have an available port.
- \end{itemize}
-\item[EVTCHNOP\_close]
- Close an event channel (no more events will be received).
- \begin{itemize}
- \item Port must be valid (currently allocated).
- \end{itemize}
-\item[EVTCHNOP\_send] Send a notification on an event channel attached
- to a port.
- \begin{itemize}
- \item Port must be valid.
- \item Only valid for Interdomain, IPI or Allocated Unbound ports.
- \end{itemize}
-\item[EVTCHNOP\_status] Query the status of a port; what kind of port,
- whether it is bound, what remote domain is expected, what PIRQ or
- VIRQ it is bound to, what VCPU will be notified, etc.
- Unprivileged domains may only query the state of their own ports.
- Privileged domains may query any port.
-\item[EVTCHNOP\_bind\_vcpu] Bind event channel to a particular VCPU -
- receive notification upcalls only on that VCPU.
- \begin{itemize}
- \item VCPU must exist.
- \item Port must be valid.
- \item Event channel must be either: allocated but unbound, bound to
- an interdomain event channel, bound to a PIRQ.
- \end{itemize}
-
-\end{description}
-
-%%
-%% grant_tables.tex
-%%
-%% Made by Mark Williamson
-%% Login <mark@maw48>
-%%
-
-\chapter{Grant tables}
-\label{c:granttables}
-
-Xen's grant tables provide a generic mechanism to memory sharing
-between domains. This shared memory interface underpins the split
-device drivers for block and network IO.
-
-Each domain has its own {\bf grant table}. This is a data structure
-that is shared with Xen; it allows the domain to tell Xen what kind of
-permissions other domains have on its pages. Entries in the grant
-table are identified by {\bf grant references}. A grant reference is
-an integer, which indexes into the grant table. It acts as a
-capability which the grantee can use to perform operations on the
-granter's memory.
-
-This capability-based system allows shared-memory communications
-between unprivileged domains. A grant reference also encapsulates the
-details of a shared page, removing the need for a domain to know the
-real machine address of a page it is sharing. This makes it possible
-to share memory correctly with domains running in fully virtualised
-memory.
-
-\section{Interface}
-
-\subsection{Grant table manipulation}
-
-Creating and destroying grant references is done by direct access to
-the grant table. This removes the need to involve Xen when creating
-grant references, modifying access permissions, etc. The grantee
-domain will invoke hypercalls to use the grant references. Four main
-operations can be accomplished by directly manipulating the table:
-
-\begin{description}
-\item[Grant foreign access] allocate a new entry in the grant table
- and fill out the access permissions accordingly. The access
- permissions will be looked up by Xen when the grantee attempts to
- use the reference to map the granted frame.
-\item[End foreign access] check that the grant reference is not
- currently in use, then remove the mapping permissions for the frame.
- This prevents further mappings from taking place but does not allow
- forced revocations of existing mappings.
-\item[Grant foreign transfer] allocate a new entry in the table
- specifying transfer permissions for the grantee. Xen will look up
- this entry when the grantee attempts to transfer a frame to the
- granter.
-\item[End foreign transfer] remove permissions to prevent a transfer
- occurring in future. If the transfer is already committed,
- modifying the grant table cannot prevent it from completing.
-\end{description}
-
-\subsection{Hypercalls}
-
-Use of grant references is accomplished via a hypercall. The grant
-table op hypercall takes three arguments:
-
-\hypercall{grant\_table\_op(unsigned int cmd, void *uop, unsigned int count)}
-
-{\bf cmd} indicates the grant table operation of interest. {\bf uop}
-is a pointer to a structure (or an array of structures) describing the
-operation to be performed. The {\bf count} field describes how many
-grant table operations are being batched together.
-
-The core logic is situated in {\bf xen/common/grant\_table.c}. The
-grant table operation hypercall can be used to perform the following
-actions:
-
-\begin{description}
-\item[GNTTABOP\_map\_grant\_ref] Given a grant reference from another
- domain, map the referred page into the caller's address space.
-\item[GNTTABOP\_unmap\_grant\_ref] Remove a mapping to a granted frame
- from the caller's address space. This is used to voluntarily
- relinquish a mapping to a granted page.
-\item[GNTTABOP\_setup\_table] Setup grant table for caller domain.
-\item[GNTTABOP\_dump\_table] Debugging operation.
-\item[GNTTABOP\_transfer] Given a transfer reference from another
- domain, transfer ownership of a page frame to that domain.
-\end{description}
-
-%%
-%% xenstore.tex
-%%
-%% Made by Mark Williamson
-%% Login <mark@maw48>
-%%
-
-\chapter{Xenstore}
-
-Xenstore is the mechanism by which control-plane activities occur.
-These activities include:
-
-\begin{itemize}
-\item Setting up shared memory regions and event channels for use with
- the split device drivers.
-\item Notifying the guest of control events (e.g. balloon driver
- requests)
-\item Reporting back status information from the guest
- (e.g. performance-related statistics, etc).
-\end{itemize}
-
-The store is arranged as a hierarchical collection of key-value pairs.
-Each domain has a directory hierarchy containing data related to its
-configuration. Domains are permitted to register for notifications
-about changes in subtrees of the store, and to apply changes to the
-store transactionally.
-
-\section{Guidelines}
-
-A few principles govern the operation of the store:
-
-\begin{itemize}
-\item Domains should only modify the contents of their own
- directories.
-\item The setup protocol for a device channel should simply consist of
- entering the configuration data into the store.
-\item The store should allow device discovery without requiring the
- relevant device drivers to be loaded: a Xen ``bus'' should be
- visible to probing code in the guest.
-\item The store should be usable for inter-tool communications,
- allowing the tools themselves to be decomposed into a number of
- smaller utilities, rather than a single monolithic entity. This
- also facilitates the development of alternate user interfaces to the
- same functionality.
-\end{itemize}
-
-\section{Store layout}
-
-There are three main paths in XenStore:
-
-\begin{description}
-\item[/vm] stores configuration information about domain
-\item[/local/domain] stores information about the domain on the local node
(domid, etc.)
-\item[/tool] stores information for the various tools
-\end{description}
-
-The {\bf /vm} path stores configuration information for a domain.
-This information doesn't change and is indexed by the domain's UUID.
-A {\bf /vm} entry contains the following information:
-
-\begin{description}
-\item[uuid] uuid of the domain (somewhat redundant)
-\item[on\_reboot] the action to take on a domain reboot request (destroy or
restart)
-\item[on\_poweroff] the action to take on a domain halt request (destroy or
restart)
-\item[on\_crash] the action to take on a domain crash (destroy or restart)
-\item[vcpus] the number of allocated vcpus for the domain
-\item[memory] the amount of memory (in megabytes) for the domain Note: appears
to sometimes be empty for domain-0
-\item[vcpu\_avail] the number of active vcpus for the domain (vcpus - number
of disabled vcpus)
-\item[name] the name of the domain
-\end{description}
-
-
-{\bf /vm/$<$uuid$>$/image/}
-
-The image path is only available for Domain-Us and contains:
-\begin{description}
-\item[ostype] identifies the builder type (linux or vmx)
-\item[kernel] path to kernel on domain-0
-\item[cmdline] command line to pass to domain-U kernel
-\item[ramdisk] path to ramdisk on domain-0
-\end{description}
-
-{\bf /local}
-
-The {\tt /local} path currently only contains one directory, {\tt
-/local/domain} that is indexed by domain id. It contains the running
-domain information. The reason to have two storage areas is that
-during migration, the uuid doesn't change but the domain id does. The
-{\tt /local/domain} directory can be created and populated before
-finalizing the migration enabling localhost to localhost migration.
-
-{\bf /local/domain/$<$domid$>$}
-
-This path contains:
-
-\begin{description}
-\item[cpu\_time] xend start time (this is only around for domain-0)
-\item[handle] private handle for xend
-\item[name] see /vm
-\item[on\_reboot] see /vm
-\item[on\_poweroff] see /vm
-\item[on\_crash] see /vm
-\item[vm] the path to the VM directory for the domain
-\item[domid] the domain id (somewhat redundant)
-\item[running] indicates that the domain is currently running
-\item[memory] the current memory in megabytes for the domain (empty for
domain-0?)
-\item[maxmem\_KiB] the maximum memory for the domain (in kilobytes)
-\item[memory\_KiB] the memory allocated to the domain (in kilobytes)
-\item[cpu] the current CPU the domain is pinned to (empty for domain-0?)
-\item[cpu\_weight] the weight assigned to the domain
-\item[vcpu\_avail] a bitmap telling the domain whether it may use a given VCPU
-\item[online\_vcpus] how many vcpus are currently online
-\item[vcpus] the total number of vcpus allocated to the domain
-\item[console/] a directory for console information
- \begin{description}
- \item[ring-ref] the grant table reference of the console ring queue
- \item[port] the event channel being used for the console ring queue (local
port)
- \item[tty] the current tty the console data is being exposed of
- \item[limit] the limit (in bytes) of console data to buffer
- \end{description}
-\item[backend/] a directory containing all backends the domain hosts
- \begin{description}
- \item[vbd/] a directory containing vbd backends
- \begin{description}
- \item[$<$domid$>$/] a directory containing vbd's for domid
- \begin{description}
- \item[$<$virtual-device$>$/] a directory for a particular
- virtual-device on domid
- \begin{description}
- \item[frontend-id] domain id of frontend
- \item[frontend] the path to the frontend domain
- \item[physical-device] backend device number
- \item[sector-size] backend sector size
- \item[info] 0 read/write, 1 read-only (is this right?)
- \item[domain] name of frontend domain
- \item[params] parameters for device
- \item[type] the type of the device
- \item[dev] the virtual device (as given by the user)
- \item[node] output from block creation script
- \end{description}
- \end{description}
- \end{description}
-
- \item[vif/] a directory containing vif backends
- \begin{description}
- \item[$<$domid$>$/] a directory containing vif's for domid
- \begin{description}
- \item[$<$vif number$>$/] a directory for each vif
- \item[frontend-id] the domain id of the frontend
- \item[frontend] the path to the frontend
- \item[mac] the mac address of the vif
- \item[bridge] the bridge the vif is connected to
- \item[handle] the handle of the vif
- \item[script] the script used to create/stop the vif
- \item[domain] the name of the frontend
- \end{description}
- \end{description}
-
- \item[vtpm/] a directory containing vtpm backends
- \begin{description}
- \item[$<$domid$>$/] a directory containing vtpm's for domid
- \begin{description}
- \item[$<$vtpm number$>$/] a directory for each vtpm
- \item[frontend-id] the domain id of the frontend
- \item[frontend] the path to the frontend
- \item[instance] the instance of the virtual TPM that is used
- \item[pref{\textunderscore}instance] the instance number as given in the
VM configuration file;
- may be different from {\bf instance}
- \item[domain] the name of the domain of the frontend
- \end{description}
- \end{description}
-
- \end{description}
-
- \item[device/] a directory containing the frontend devices for the
- domain
- \begin{description}
- \item[vbd/] a directory containing vbd frontend devices for the
- domain
- \begin{description}
- \item[$<$virtual-device$>$/] a directory containing the vbd frontend for
- virtual-device
- \begin{description}
- \item[virtual-device] the device number of the frontend device
- \item[backend-id] the domain id of the backend
- \item[backend] the path of the backend in the store (/local/domain
- path)
- \item[ring-ref] the grant table reference for the block request
- ring queue
- \item[event-channel] the event channel used for the block request
- ring queue
- \end{description}
-
- \item[vif/] a directory containing vif frontend devices for the
- domain
- \begin{description}
- \item[$<$id$>$/] a directory for vif id frontend device for the domain
- \begin{description}
- \item[backend-id] the backend domain id
- \item[mac] the mac address of the vif
- \item[handle] the internal vif handle
- \item[backend] a path to the backend's store entry
- \item[tx-ring-ref] the grant table reference for the transmission
ring queue
- \item[rx-ring-ref] the grant table reference for the receiving ring
queue
- \item[event-channel] the event channel used for the two ring queues
- \end{description}
- \end{description}
-
- \item[vtpm/] a directory containing the vtpm frontend device for the
- domain
- \begin{description}
- \item[$<$id$>$] a directory for vtpm id frontend device for the domain
- \begin{description}
- \item[backend-id] the backend domain id
- \item[backend] a path to the backend's store entry
- \item[ring-ref] the grant table reference for the tx/rx ring
- \item[event-channel] the event channel used for the ring
- \end{description}
- \end{description}
-
- \item[device-misc/] miscellaneous information for devices
- \begin{description}
- \item[vif/] miscellaneous information for vif devices
- \begin{description}
- \item[nextDeviceID] the next device id to use
- \end{description}
- \end{description}
- \end{description}
- \end{description}
-
- \item[security/] access control information for the domain
- \begin{description}
- \item[ssidref] security reference identifier used inside the hypervisor
- \item[access\_control/] security label used by management tools
- \begin{description}
- \item[label] security label name
- \item[policy] security policy name
- \end{description}
- \end{description}
-
- \item[store/] per-domain information for the store
- \begin{description}
- \item[port] the event channel used for the store ring queue
- \item[ring-ref] - the grant table reference used for the store's
- communication channel
- \end{description}
-
- \item[image] - private xend information
-\end{description}
-
-
-\chapter{Devices}
-\label{c:devices}
-
-Virtual devices under Xen are provided by a {\bf split device driver}
-architecture. The illusion of the virtual device is provided by two
-co-operating drivers: the {\bf frontend}, which runs an the
-unprivileged domain and the {\bf backend}, which runs in a domain with
-access to the real device hardware (often called a {\bf driver
-domain}; in practice domain 0 usually fulfills this function).
-
-The frontend driver appears to the unprivileged guest as if it were a
-real device, for instance a block or network device. It receives IO
-requests from its kernel as usual, however since it does not have
-access to the physical hardware of the system it must then issue
-requests to the backend. The backend driver is responsible for
-receiving these IO requests, verifying that they are safe and then
-issuing them to the real device hardware. The backend driver appears
-to its kernel as a normal user of in-kernel IO functionality. When
-the IO completes the backend notifies the frontend that the data is
-ready for use; the frontend is then able to report IO completion to
-its own kernel.
-
-Frontend drivers are designed to be simple; most of the complexity is
-in the backend, which has responsibility for translating device
-addresses, verifying that requests are well-formed and do not violate
-isolation guarantees, etc.
-
-Split drivers exchange requests and responses in shared memory, with
-an event channel for asynchronous notifications of activity. When the
-frontend driver comes up, it uses Xenstore to set up a shared memory
-frame and an interdomain event channel for communications with the
-backend. Once this connection is established, the two can communicate
-directly by placing requests / responses into shared memory and then
-sending notifications on the event channel. This separation of
-notification from data transfer allows message batching, and results
-in very efficient device access.
-
-This chapter focuses on some individual split device interfaces
-available to Xen guests.
-
-
-\section{Network I/O}
-
-Virtual network device services are provided by shared memory
-communication with a backend domain. From the point of view of other
-domains, the backend may be viewed as a virtual ethernet switch
-element with each domain having one or more virtual network interfaces
-connected to it.
-
-From the point of view of the backend domain itself, the network
-backend driver consists of a number of ethernet devices. Each of
-these has a logical direct connection to a virtual network device in
-another domain. This allows the backend domain to route, bridge,
-firewall, etc the traffic to / from the other domains using normal
-operating system mechanisms.
-
-\subsection{Backend Packet Handling}
-
-The backend driver is responsible for a variety of actions relating to
-the transmission and reception of packets from the physical device.
-With regard to transmission, the backend performs these key actions:
-
-\begin{itemize}
-\item {\bf Validation:} To ensure that domains do not attempt to
- generate invalid (e.g. spoofed) traffic, the backend driver may
- validate headers ensuring that source MAC and IP addresses match the
- interface that they have been sent from.
-
- Validation functions can be configured using standard firewall rules
- ({\small{\tt iptables}} in the case of Linux).
-
-\item {\bf Scheduling:} Since a number of domains can share a single
- physical network interface, the backend must mediate access when
- several domains each have packets queued for transmission. This
- general scheduling function subsumes basic shaping or rate-limiting
- schemes.
-
-\item {\bf Logging and Accounting:} The backend domain can be
- configured with classifier rules that control how packets are
- accounted or logged. For example, log messages might be generated
- whenever a domain attempts to send a TCP packet containing a SYN.
-\end{itemize}
-
-On receipt of incoming packets, the backend acts as a simple
-demultiplexer: Packets are passed to the appropriate virtual interface
-after any necessary logging and accounting have been carried out.
-
-\subsection{Data Transfer}
-
-Each virtual interface uses two ``descriptor rings'', one for
-transmit, the other for receive. Each descriptor identifies a block
-of contiguous machine memory allocated to the domain.
-
-The transmit ring carries packets to transmit from the guest to the
-backend domain. The return path of the transmit ring carries messages
-indicating that the contents have been physically transmitted and the
-backend no longer requires the associated pages of memory.
-
-To receive packets, the guest places descriptors of unused pages on
-the receive ring. The backend will return received packets by
-exchanging these pages in the domain's memory with new pages
-containing the received data, and passing back descriptors regarding
-the new packets on the ring. This zero-copy approach allows the
-backend to maintain a pool of free pages to receive packets into, and
-then deliver them to appropriate domains after examining their
-headers.
-
-% Real physical addresses are used throughout, with the domain
-% performing translation from pseudo-physical addresses if that is
-% necessary.
-
-If a domain does not keep its receive ring stocked with empty buffers
-then packets destined to it may be dropped. This provides some
-defence against receive livelock problems because an overloaded domain
-will cease to receive further data. Similarly, on the transmit path,
-it provides the application with feedback on the rate at which packets
-are able to leave the system.
-
-Flow control on rings is achieved by including a pair of producer
-indexes on the shared ring page. Each side will maintain a private
-consumer index indicating the next outstanding message. In this
-manner, the domains cooperate to divide the ring into two message
-lists, one in each direction. Notification is decoupled from the
-immediate placement of new messages on the ring; the event channel
-will be used to generate notification when {\em either} a certain
-number of outstanding messages are queued, {\em or} a specified number
-of nanoseconds have elapsed since the oldest message was placed on the
-ring.
-
-%% Not sure if my version is any better -- here is what was here
-%% before: Synchronization between the backend domain and the guest is
-%% achieved using counters held in shared memory that is accessible to
-%% both. Each ring has associated producer and consumer indices
-%% indicating the area in the ring that holds descriptors that contain
-%% data. After receiving {\it n} packets or {\t nanoseconds} after
-%% receiving the first packet, the hypervisor sends an event to the
-%% domain.
-
-
-\subsection{Network ring interface}
-
-The network device uses two shared memory rings for communication: one
-for transmit, one for receive.
-
-Transmit requests are described by the following structure:
-
-\scriptsize
-\begin{verbatim}
-typedef struct netif_tx_request {
- grant_ref_t gref; /* Reference to buffer page */
- uint16_t offset; /* Offset within buffer page */
- uint16_t flags; /* NETTXF_* */
- uint16_t id; /* Echoed in response message. */
- uint16_t size; /* Packet size in bytes. */
-} netif_tx_request_t;
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[gref] Grant reference for the network buffer
-\item[offset] Offset to data
-\item[flags] Transmit flags (currently only NETTXF\_csum\_blank is
- supported, to indicate that the protocol checksum field is
- incomplete).
-\item[id] Echoed to guest by the backend in the ring-level response so
- that the guest can match it to this request
-\item[size] Buffer size
-\end{description}
-
-Each transmit request is followed by a transmit response at some later
-date. This is part of the shared-memory communication protocol and
-allows the guest to (potentially) retire internal structures related
-to the request. It does not imply a network-level response. This
-structure is as follows:
-
-\scriptsize
-\begin{verbatim}
-typedef struct netif_tx_response {
- uint16_t id;
- int16_t status;
-} netif_tx_response_t;
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[id] Echo of the ID field in the corresponding transmit request.
-\item[status] Success / failure status of the transmit request.
-\end{description}
-
-Receive requests must be queued by the frontend, accompanied by a
-donation of page-frames to the backend. The backend transfers page
-frames full of data back to the guest
-
-\scriptsize
-\begin{verbatim}
-typedef struct {
- uint16_t id; /* Echoed in response message. */
- grant_ref_t gref; /* Reference to incoming granted frame */
-} netif_rx_request_t;
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[id] Echoed by the frontend to identify this request when
- responding.
-\item[gref] Transfer reference - the backend will use this reference
- to transfer a frame of network data to us.
-\end{description}
-
-Receive response descriptors are queued for each received frame. Note
-that these may only be queued in reply to an existing receive request,
-providing an in-built form of traffic throttling.
-
-\scriptsize
-\begin{verbatim}
-typedef struct {
- uint16_t id;
- uint16_t offset; /* Offset in page of start of received packet */
- uint16_t flags; /* NETRXF_* */
- int16_t status; /* -ve: BLKIF_RSP_* ; +ve: Rx'ed pkt size. */
-} netif_rx_response_t;
-\end{verbatim}
-\normalsize
-
-\begin{description}
-\item[id] ID echoed from the original request, used by the guest to
- match this response to the original request.
-\item[offset] Offset to data within the transferred frame.
-\item[flags] Transmit flags (currently only NETRXF\_csum\_valid is
- supported, to indicate that the protocol checksum field has already
- been validated).
-\item[status] Success / error status for this operation.
-\end{description}
-
-Note that the receive protocol includes a mechanism for guests to
-receive incoming memory frames but there is no explicit transfer of
-frames in the other direction. Guests are expected to return memory
-to the hypervisor in order to use the network interface. They {\em
-must} do this or they will exceed their maximum memory reservation and
-will not be able to receive incoming frame transfers. When necessary,
-the backend is able to replenish its pool of free network buffers by
-claiming some of this free memory from the hypervisor.
-
-\section{Block I/O}
-
-All guest OS disk access goes through the virtual block device VBD
-interface. This interface allows domains access to portions of block
-storage devices visible to the the block backend device. The VBD
-interface is a split driver, similar to the network interface
-described above. A single shared memory ring is used between the
-frontend and backend drivers for each virtual device, across which
-IO requests and responses are sent.
-
-Any block device accessible to the backend domain, including
-network-based block (iSCSI, *NBD, etc), loopback and LVM/MD devices,
-can be exported as a VBD. Each VBD is mapped to a device node in the
-guest, specified in the guest's startup configuration.
-
-\subsection{Data Transfer}
-
-The per-(virtual)-device ring between the guest and the block backend
-supports two messages:
-
-\begin{description}
-\item [{\small {\tt READ}}:] Read data from the specified block
- device. The front end identifies the device and location to read
- from and attaches pages for the data to be copied to (typically via
- DMA from the device). The backend acknowledges completed read
- requests as they finish.
-
-\item [{\small {\tt WRITE}}:] Write data to the specified block
- device. This functions essentially as {\small {\tt READ}}, except
- that the data moves to the device instead of from it.
-\end{description}
-
-%% Rather than copying data, the backend simply maps the domain's
-%% buffers in order to enable direct DMA to them. The act of mapping
-%% the buffers also increases the reference counts of the underlying
-%% pages, so that the unprivileged domain cannot try to return them to
-%% the hypervisor, install them as page tables, or any other unsafe
-%% behaviour.
-%%
-%% % block API here
-
-\subsection{Block ring interface}
-
-The block interface is defined by the structures passed over the
-shared memory interface. These structures are either requests (from
-the frontend to the backend) or responses (from the backend to the
-frontend).
-
-The request structure is defined as follows:
-
-\scriptsize
-\begin{verbatim}
-typedef struct blkif_request {
- uint8_t operation; /* BLKIF_OP_??? */
- uint8_t nr_segments; /* number of segments */
- blkif_vdev_t handle; /* only for read/write requests */
- uint64_t id; /* private guest value, echoed in resp */
- blkif_sector_t sector_number;/* start sector idx on disk (r/w only) */
- struct blkif_request_segment {
- grant_ref_t gref; /* reference to I/O buffer frame */
- /* @first_sect: first sector in frame to transfer (inclusive). */
- /* @last_sect: last sector in frame to transfer (inclusive). */
- uint8_t first_sect, last_sect;
- } seg[BLKIF_MAX_SEGMENTS_PER_REQUEST];
-} blkif_request_t;
-\end{verbatim}
-\normalsize
-
-The fields are as follows:
-
-\begin{description}
-\item[operation] operation ID: one of the operations described above
-\item[nr\_segments] number of segments for scatter / gather IO
- described by this request
-\item[handle] identifier for a particular virtual device on this
- interface
-\item[id] this value is echoed in the response message for this IO;
- the guest may use it to identify the original request
-\item[sector\_number] start sector on the virtual device for this
- request
-\item[frame\_and\_sects] This array contains structures encoding
- scatter-gather IO to be performed:
- \begin{description}
- \item[gref] The grant reference for the foreign I/O buffer page.
- \item[first\_sect] First sector to access within the buffer page (0 to 7).
- \item[last\_sect] Last sector to access within the buffer page (0 to 7).
- \end{description}
- Data will be transferred into frames at an offset determined by the
- value of {\tt first\_sect}.
-\end{description}
-
-\section{Virtual TPM}
-
-Virtual TPM (VTPM) support provides TPM functionality to each virtual
-machine that requests this functionality in its configuration file.
-The interface enables domains to access their own private TPM like it
-was a hardware TPM built into the machine.
-
-The virtual TPM interface is implemented as a split driver,
-similar to the network and block interfaces described above.
-The user domain hosting the frontend exports a character device /dev/tpm0
-to user-level applications for communicating with the virtual TPM.
-This is the same device interface that is also offered if a hardware TPM
-is available in the system. The backend provides a single interface
-/dev/vtpm where the virtual TPM is waiting for commands from all domains
-that have located their backend in a given domain.
-
-\subsection{Data Transfer}
-
-A single shared memory ring is used between the frontend and backend
-drivers. TPM requests and responses are sent in pages where a pointer
-to those pages and other information is placed into the ring such that
-the backend can map the pages into its memory space using the grant
-table mechanism.
-
-The backend driver has been implemented to only accept well-formed
-TPM requests. To meet this requirement, the length indicator in the
-TPM request must correctly indicate the length of the request.
-Otherwise an error message is automatically sent back by the device driver.
-
-The virtual TPM implementation listens for TPM request on /dev/vtpm. Since
-it must be able to apply the TPM request packet to the virtual TPM instance
-associated with the virtual machine, a 4-byte virtual TPM instance
-identifier is pretended to each packet by the backend driver (in network
-byte order) for internal routing of the request.
-
-\subsection{Virtual TPM ring interface}
-
-The TPM protocol is a strict request/response protocol and therefore
-only one ring is used to send requests from the frontend to the backend
-and responses on the reverse path.
-
-The request/response structure is defined as follows:
-
-\scriptsize
-\begin{verbatim}
-typedef struct {
- unsigned long addr; /* Machine address of packet. */
- grant_ref_t ref; /* grant table access reference. */
- uint16_t unused; /* unused */
- uint16_t size; /* Packet size in bytes. */
-} tpmif_tx_request_t;
-\end{verbatim}
-\normalsize
-
-The fields are as follows:
-
-\begin{description}
-\item[addr] The machine address of the page associated with the TPM
- request/response; a request/response may span multiple
- pages
-\item[ref] The grant table reference associated with the address.
-\item[size] The size of the remaining packet; up to
- PAGE{\textunderscore}SIZE bytes can be found in the
- page referenced by 'addr'
-\end{description}
-
-The frontend initially allocates several pages whose addresses
-are stored in the ring. Only these pages are used for exchange of
-requests and responses.
-
-
-\chapter{Further Information}
-
-If you have questions that are not answered by this manual, the
-sources of information listed below may be of interest to you. Note
-that bug reports, suggestions and contributions related to the
-software (or the documentation) should be sent to the Xen developers'
-mailing list (address below).
-
-
-\section{Other documentation}
-
-If you are mainly interested in using (rather than developing for)
-Xen, the \emph{Xen Users' Manual} is distributed in the {\tt docs/}
-directory of the Xen source distribution.
-
-% Various HOWTOs are also available in {\tt docs/HOWTOS}.
-
-
-\section{Online references}
-
-The official Xen web site can be found at:
-\begin{quote} {\tt http://www.xensource.com}
-\end{quote}
-
-
-This contains links to the latest versions of all online
-documentation, including the latest version of the FAQ.
-
-Information regarding Xen is also available at the Xen Wiki at
-\begin{quote} {\tt http://wiki.xen.org/wiki/}\end{quote}
-The Xen project uses Bugzilla as its bug tracking system. You'll find
-the Xen Bugzilla at http://bugzilla.xensource.com/bugzilla/.
-
-
-\section{Mailing lists}
-
-There are several mailing lists that are used to discuss Xen related
-topics. The most widely relevant are listed below. An official page of
-mailing lists and subscription information can be found at \begin{quote}
- {\tt http://lists.xensource.com/} \end{quote}
-
-\begin{description}
-\item[xen-devel@xxxxxxxxxxxxxxxxxxx] Used for development
- discussions and bug reports. Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-devel}}
-\item[xen-users@xxxxxxxxxxxxxxxxxxx] Used for installation and usage
- discussions and requests for help. Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-users}}
-\item[xen-announce@xxxxxxxxxxxxxxxxxxx] Used for announcements only.
- Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-announce}}
-\item[xen-changelog@xxxxxxxxxxxxxxxxxxx] Changelog feed
- from the unstable and 2.0 trees - developer oriented. Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-changelog}}
-\end{description}
-
-\appendix
-
-
-\chapter{Xen Hypercalls}
-\label{a:hypercalls}
-
-Hypercalls represent the procedural interface to Xen; this appendix
-categorizes and describes the current set of hypercalls.
-
-\section{Invoking Hypercalls}
-
-Hypercalls are invoked in a manner analogous to system calls in a
-conventional operating system; a software interrupt is issued which
-vectors to an entry point within Xen. On x86/32 machines the
-instruction required is {\tt int \$82}; the (real) IDT is setup so
-that this may only be issued from within ring 1. The particular
-hypercall to be invoked is contained in {\tt EAX} --- a list
-mapping these values to symbolic hypercall names can be found
-in {\tt xen/include/public/xen.h}.
-
-On some occasions a set of hypercalls will be required to carry
-out a higher-level function; a good example is when a guest
-operating wishes to context switch to a new process which
-requires updating various privileged CPU state. As an optimization
-for these cases, there is a generic mechanism to issue a set of
-hypercalls as a batch:
-
-\begin{quote}
-\hypercall{multicall(void *call\_list, int nr\_calls)}
-
-Execute a series of hypervisor calls; {\tt nr\_calls} is the length of
-the array of {\tt multicall\_entry\_t} structures pointed to be {\tt
-call\_list}. Each entry contains the hypercall operation code followed
-by up to 7 word-sized arguments.
-\end{quote}
-
-Note that multicalls are provided purely as an optimization; there is
-no requirement to use them when first porting a guest operating
-system.
-
-
-\section{Virtual CPU Setup}
-
-At start of day, a guest operating system needs to setup the virtual
-CPU it is executing on. This includes installing vectors for the
-virtual IDT so that the guest OS can handle interrupts, page faults,
-etc. However the very first thing a guest OS must setup is a pair
-of hypervisor callbacks: these are the entry points which Xen will
-use when it wishes to notify the guest OS of an occurrence.
-
-\begin{quote}
-\hypercall{set\_callbacks(unsigned long event\_selector, unsigned long
- event\_address, unsigned long failsafe\_selector, unsigned long
- failsafe\_address) }
-
-Register the normal (``event'') and failsafe callbacks for
-event processing. In each case the code segment selector and
-address within that segment are provided. The selectors must
-have RPL 1; in XenLinux we simply use the kernel's CS for both
-{\bf event\_selector} and {\bf failsafe\_selector}.
-
-The value {\bf event\_address} specifies the address of the guest OSes
-event handling and dispatch routine; the {\bf failsafe\_address}
-specifies a separate entry point which is used only if a fault occurs
-when Xen attempts to use the normal callback.
-
-\end{quote}
-
-On x86/64 systems the hypercall takes slightly different
-arguments. This is because callback CS does not need to be specified
-(since teh callbacks are entered via SYSRET), and also because an
-entry address needs to be specified for SYSCALLs from guest user
-space:
-
-\begin{quote}
-\hypercall{set\_callbacks(unsigned long event\_address, unsigned long
- failsafe\_address, unsigned long syscall\_address)}
-\end{quote}
-
-
-After installing the hypervisor callbacks, the guest OS can
-install a `virtual IDT' by using the following hypercall:
-
-\begin{quote}
-\hypercall{set\_trap\_table(trap\_info\_t *table)}
-
-Install one or more entries into the per-domain
-trap handler table (essentially a software version of the IDT).
-Each entry in the array pointed to by {\bf table} includes the
-exception vector number with the corresponding segment selector
-and entry point. Most guest OSes can use the same handlers on
-Xen as when running on the real hardware.
-
-
-\end{quote}
-
-A further hypercall is provided for the management of virtual CPUs:
-
-\begin{quote}
-\hypercall{vcpu\_op(int cmd, int vcpuid, void *extra\_args)}
-
-This hypercall can be used to bootstrap VCPUs, to bring them up and
-down and to test their current status.
-
-\end{quote}
-
-\section{Scheduling and Timer}
-
-Domains are preemptively scheduled by Xen according to the
-parameters installed by domain 0 (see Section~\ref{s:dom0ops}).
-In addition, however, a domain may choose to explicitly
-control certain behavior with the following hypercall:
-
-\begin{quote}
-\hypercall{sched\_op\_new(int cmd, void *extra\_args)}
-
-Request scheduling operation from hypervisor. The following
-sub-commands are available:
-
-\begin{description}
-\item[SCHEDOP\_yield] voluntarily yields the CPU, but leaves the
-caller marked as runnable. No extra arguments are passed to this
-command.
-\item[SCHEDOP\_block] removes the calling domain from the run queue
-and causes it to sleep until an event is delivered to it. No extra
-arguments are passed to this command.
-\item[SCHEDOP\_shutdown] is used to end the calling domain's
-execution. The extra argument is a {\bf sched\_shutdown} structure
-which indicates the reason why the domain suspended (e.g., for reboot,
-halt, power-off).
-\item[SCHEDOP\_poll] allows a VCPU to wait on a set of event channels
-with an optional timeout (all of which are specified in the {\bf
-sched\_poll} extra argument). The semantics are similar to the UNIX
-{\bf poll} system call. The caller must have event-channel upcalls
-masked when executing this command.
-\end{description}
-\end{quote}
-
-{\bf sched\_op\_new} was not available prior to Xen 3.0.2. Older versions
-provide only the following hypercall:
-
-\begin{quote}
-\hypercall{sched\_op(int cmd, unsigned long extra\_arg)}
-
-This hypercall supports the following subset of {\bf sched\_op\_new} commands:
-
-\begin{description}
-\item[SCHEDOP\_yield] (extra argument is 0).
-\item[SCHEDOP\_block] (extra argument is 0).
-\item[SCHEDOP\_shutdown] (extra argument is numeric reason code).
-\end{description}
-\end{quote}
-
-To aid the implementation of a process scheduler within a guest OS,
-Xen provides a virtual programmable timer:
-
-\begin{quote}
-\hypercall{set\_timer\_op(uint64\_t timeout)}
-
-Request a timer event to be sent at the specified system time (time
-in nanoseconds since system boot).
-
-\end{quote}
-
-Note that calling {\bf set\_timer\_op} prior to {\bf sched\_op}
-allows block-with-timeout semantics.
-
-
-\section{Page Table Management}
-
-Since guest operating systems have read-only access to their page
-tables, Xen must be involved when making any changes. The following
-multi-purpose hypercall can be used to modify page-table entries,
-update the machine-to-physical mapping table, flush the TLB, install
-a new page-table base pointer, and more.
-
-\begin{quote}
-\hypercall{mmu\_update(mmu\_update\_t *req, int count, int *success\_count)}
-
-Update the page table for the domain; a set of {\bf count} updates are
-submitted for processing in a batch, with {\bf success\_count} being
-updated to report the number of successful updates.
-
-Each element of {\bf req[]} contains a pointer (address) and value;
-the least significant 2-bits of the pointer are used to distinguish
-the type of update requested as follows:
-\begin{description}
-
-\item[MMU\_NORMAL\_PT\_UPDATE:] update a page directory entry or
-page table entry to the associated value; Xen will check that the
-update is safe, as described in Chapter~\ref{c:memory}.
-
-\item[MMU\_MACHPHYS\_UPDATE:] update an entry in the
- machine-to-physical table. The calling domain must own the machine
- page in question (or be privileged).
-\end{description}
-
-\end{quote}
-
-Explicitly updating batches of page table entries is extremely
-efficient, but can require a number of alterations to the guest
-OS. Using the writable page table mode (Chapter~\ref{c:memory}) is
-recommended for new OS ports.
-
-Regardless of which page table update mode is being used, however,
-there are some occasions (notably handling a demand page fault) where
-a guest OS will wish to modify exactly one PTE rather than a
-batch, and where that PTE is mapped into the current address space.
-This is catered for by the following:
-
-\begin{quote}
-\hypercall{update\_va\_mapping(unsigned long va, uint64\_t val,
- unsigned long flags)}
-
-Update the currently installed PTE that maps virtual address {\bf va}
-to new value {\bf val}. As with {\bf mmu\_update}, Xen checks the
-modification is safe before applying it. The {\bf flags} determine
-which kind of TLB flush, if any, should follow the update.
-
-\end{quote}
-
-Finally, sufficiently privileged domains may occasionally wish to manipulate
-the pages of others:
-
-\begin{quote}
-\hypercall{update\_va\_mapping\_otherdomain(unsigned long va, uint64\_t val,
- unsigned long flags, domid\_t domid)}
-
-Identical to {\bf update\_va\_mapping} save that the pages being
-mapped must belong to the domain {\bf domid}.
-
-\end{quote}
-
-An additional MMU hypercall provides an ``extended command''
-interface. This provides additional functionality beyond the basic
-table updating commands:
-
-\begin{quote}
-
-\hypercall{mmuext\_op(struct mmuext\_op *op, int count, int *success\_count,
domid\_t domid)}
-
-This hypercall is used to perform additional MMU operations. These
-include updating {\tt cr3} (or just re-installing it for a TLB flush),
-requesting various kinds of TLB flush, flushing the cache, installing
-a new LDT, or pinning \& unpinning page-table pages (to ensure their
-reference count doesn't drop to zero which would require a
-revalidation of all entries). Some of the operations available are
-restricted to domains with sufficient system privileges.
-
-It is also possible for privileged domains to reassign page ownership
-via an extended MMU operation, although grant tables are used instead
-of this where possible; see Section~\ref{s:idc}.
-
-\end{quote}
-
-Finally, a hypercall interface is exposed to activate and deactivate
-various optional facilities provided by Xen for memory management.
-
-\begin{quote}
-\hypercall{vm\_assist(unsigned int cmd, unsigned int type)}
-
-Toggle various memory management modes (in particular writable page
-tables).
-
-\end{quote}
-
-\section{Segmentation Support}
-
-Xen allows guest OSes to install a custom GDT if they require it;
-this is context switched transparently whenever a domain is
-[de]scheduled. The following hypercall is effectively a
-`safe' version of {\tt lgdt}:
-
-\begin{quote}
-\hypercall{set\_gdt(unsigned long *frame\_list, int entries)}
-
-Install a global descriptor table for a domain; {\bf frame\_list} is
-an array of up to 16 machine page frames within which the GDT resides,
-with {\bf entries} being the actual number of descriptor-entry
-slots. All page frames must be mapped read-only within the guest's
-address space, and the table must be large enough to contain Xen's
-reserved entries (see {\bf xen/include/public/arch-x86\_32.h}).
-
-\end{quote}
-
-Many guest OSes will also wish to install LDTs; this is achieved by
-using {\bf mmu\_update} with an extended command, passing the
-linear address of the LDT base along with the number of entries. No
-special safety checks are required; Xen needs to perform this task
-simply since {\tt lldt} requires CPL 0.
-
-
-Xen also allows guest operating systems to update just an
-individual segment descriptor in the GDT or LDT:
-
-\begin{quote}
-\hypercall{update\_descriptor(uint64\_t ma, uint64\_t desc)}
-
-Update the GDT/LDT entry at machine address {\bf ma}; the new
-8-byte descriptor is stored in {\bf desc}.
-Xen performs a number of checks to ensure the descriptor is
-valid.
-
-\end{quote}
-
-Guest OSes can use the above in place of context switching entire
-LDTs (or the GDT) when the number of changing descriptors is small.
-
-\section{Context Switching}
-
-When a guest OS wishes to context switch between two processes,
-it can use the page table and segmentation hypercalls described
-above to perform the the bulk of the privileged work. In addition,
-however, it will need to invoke Xen to switch the kernel (ring 1)
-stack pointer:
-
-\begin{quote}
-\hypercall{stack\_switch(unsigned long ss, unsigned long esp)}
-
-Request kernel stack switch from hypervisor; {\bf ss} is the new
-stack segment, which {\bf esp} is the new stack pointer.
-
-\end{quote}
-
-A useful hypercall for context switching allows ``lazy'' save and
-restore of floating point state:
-
-\begin{quote}
-\hypercall{fpu\_taskswitch(int set)}
-
-This call instructs Xen to set the {\tt TS} bit in the {\tt cr0}
-control register; this means that the next attempt to use floating
-point will cause a trap which the guest OS can trap. Typically it will
-then save/restore the FP state, and clear the {\tt TS} bit, using the
-same call.
-\end{quote}
-
-This is provided as an optimization only; guest OSes can also choose
-to save and restore FP state on all context switches for simplicity.
-
-Finally, a hypercall is provided for entering vm86 mode:
-
-\begin{quote}
-\hypercall{switch\_vm86}
-
-This allows the guest to run code in vm86 mode, which is needed for
-some legacy software.
-\end{quote}
-
-\section{Physical Memory Management}
-
-As mentioned previously, each domain has a maximum and current
-memory allocation. The maximum allocation, set at domain creation
-time, cannot be modified. However a domain can choose to reduce
-and subsequently grow its current allocation by using the
-following call:
-
-\begin{quote}
-\hypercall{memory\_op(unsigned int op, void *arg)}
-
-Increase or decrease current memory allocation (as determined by
-the value of {\bf op}). The available operations are:
-
-\begin{description}
-\item[XENMEM\_increase\_reservation] Request an increase in machine
- memory allocation; {\bf arg} must point to a {\bf
- xen\_memory\_reservation} structure.
-\item[XENMEM\_decrease\_reservation] Request a decrease in machine
- memory allocation; {\bf arg} must point to a {\bf
- xen\_memory\_reservation} structure.
-\item[XENMEM\_maximum\_ram\_page] Request the frame number of the
- highest-addressed frame of machine memory in the system. {\bf arg}
- must point to an {\bf unsigned long} where this value will be
- stored.
-\item[XENMEM\_current\_reservation] Returns current memory reservation
- of the specified domain.
-\item[XENMEM\_maximum\_reservation] Returns maximum memory reservation
- of the specified domain.
-\end{description}
-
-\end{quote}
-
-In addition to simply reducing or increasing the current memory
-allocation via a `balloon driver', this call is also useful for
-obtaining contiguous regions of machine memory when required (e.g.
-for certain PCI devices, or if using superpages).
-
-
-\section{Inter-Domain Communication}
-\label{s:idc}
-
-Xen provides a simple asynchronous notification mechanism via
-\emph{event channels}. Each domain has a set of end-points (or
-\emph{ports}) which may be bound to an event source (e.g. a physical
-IRQ, a virtual IRQ, or an port in another domain). When a pair of
-end-points in two different domains are bound together, then a `send'
-operation on one will cause an event to be received by the destination
-domain.
-
-The control and use of event channels involves the following hypercall:
-
-\begin{quote}
-\hypercall{event\_channel\_op(evtchn\_op\_t *op)}
-
-Inter-domain event-channel management; {\bf op} is a discriminated
-union which allows the following 7 operations:
-
-\begin{description}
-
-\item[alloc\_unbound:] allocate a free (unbound) local
- port and prepare for connection from a specified domain.
-\item[bind\_virq:] bind a local port to a virtual
-IRQ; any particular VIRQ can be bound to at most one port per domain.
-\item[bind\_pirq:] bind a local port to a physical IRQ;
-once more, a given pIRQ can be bound to at most one port per
-domain. Furthermore the calling domain must be sufficiently
-privileged.
-\item[bind\_interdomain:] construct an interdomain event
-channel; in general, the target domain must have previously allocated
-an unbound port for this channel, although this can be bypassed by
-privileged domains during domain setup.
-\item[close:] close an interdomain event channel.
-\item[send:] send an event to the remote end of a
-interdomain event channel.
-\item[status:] determine the current status of a local port.
-\end{description}
-
-For more details see
-{\bf xen/include/public/event\_channel.h}.
-
-\end{quote}
-
-Event channels are the fundamental communication primitive between
-Xen domains and seamlessly support SMP. However they provide little
-bandwidth for communication {\sl per se}, and hence are typically
-married with a piece of shared memory to produce effective and
-high-performance inter-domain communication.
-
-Safe sharing of memory pages between guest OSes is carried out by
-granting access on a per page basis to individual domains. This is
-achieved by using the {\tt grant\_table\_op} hypercall.
-
-\begin{quote}
-\hypercall{grant\_table\_op(unsigned int cmd, void *uop, unsigned int count)}
-
-Used to invoke operations on a grant reference, to setup the grant
-table and to dump the tables' contents for debugging.
-
-\end{quote}
-
-\section{IO Configuration}
-
-Domains with physical device access (i.e.\ driver domains) receive
-limited access to certain PCI devices (bus address space and
-interrupts). However many guest operating systems attempt to
-determine the PCI configuration by directly access the PCI BIOS,
-which cannot be allowed for safety.
-
-Instead, Xen provides the following hypercall:
-
-\begin{quote}
-\hypercall{physdev\_op(void *physdev\_op)}
-
-Set and query IRQ configuration details, set the system IOPL, set the
-TSS IO bitmap.
-
-\end{quote}
-
-
-For examples of using {\tt physdev\_op}, see the
-Xen-specific PCI code in the linux sparse tree.
-
-\section{Administrative Operations}
-\label{s:dom0ops}
-
-A large number of control operations are available to a sufficiently
-privileged domain (typically domain 0). These allow the creation and
-management of new domains, for example. A complete list is given
-below: for more details on any or all of these, please see
-{\tt xen/include/public/dom0\_ops.h}
-
-
-\begin{quote}
-\hypercall{dom0\_op(dom0\_op\_t *op)}
-
-Administrative domain operations for domain management. The options are:
-
-\begin{description}
-\item [DOM0\_GETMEMLIST:] get list of pages used by the domain
-
-\item [DOM0\_SCHEDCTL:]
-
-\item [DOM0\_ADJUSTDOM:] adjust scheduling priorities for domain
-
-\item [DOM0\_CREATEDOMAIN:] create a new domain
-
-\item [DOM0\_DESTROYDOMAIN:] deallocate all resources associated
-with a domain
-
-\item [DOM0\_PAUSEDOMAIN:] remove a domain from the scheduler run
-queue.
-
-\item [DOM0\_UNPAUSEDOMAIN:] mark a paused domain as schedulable
- once again.
-
-\item [DOM0\_GETDOMAININFO:] get statistics about the domain
-
-\item [DOM0\_SETDOMAININFO:] set VCPU-related attributes
-
-\item [DOM0\_MSR:] read or write model specific registers
-
-\item [DOM0\_DEBUG:] interactively invoke the debugger
-
-\item [DOM0\_SETTIME:] set system time
-
-\item [DOM0\_GETPAGEFRAMEINFO:]
-
-\item [DOM0\_READCONSOLE:] read console content from hypervisor buffer ring
-
-\item [DOM0\_PINCPUDOMAIN:] pin domain to a particular CPU
-
-\item [DOM0\_TBUFCONTROL:] get and set trace buffer attributes
-
-\item [DOM0\_PHYSINFO:] get information about the host machine
-
-\item [DOM0\_SCHED\_ID:] get the ID of the current Xen scheduler
-
-\item [DOM0\_SHADOW\_CONTROL:] switch between shadow page-table modes
-
-\item [DOM0\_SETDOMAINMAXMEM:] set maximum memory allocation of a domain
-
-\item [DOM0\_GETPAGEFRAMEINFO2:] batched interface for getting
-page frame info
-
-\item [DOM0\_ADD\_MEMTYPE:] set MTRRs
-
-\item [DOM0\_DEL\_MEMTYPE:] remove a memory type range
-
-\item [DOM0\_READ\_MEMTYPE:] read MTRR
-
-\item [DOM0\_PERFCCONTROL:] control Xen's software performance
-counters
-
-\item [DOM0\_MICROCODE:] update CPU microcode
-
-\item [DOM0\_IOPORT\_PERMISSION:] modify domain permissions for an
-IO port range (enable / disable a range for a particular domain)
-
-\item [DOM0\_GETVCPUCONTEXT:] get context from a VCPU
-
-\item [DOM0\_GETVCPUINFO:] get current state for a VCPU
-\item [DOM0\_GETDOMAININFOLIST:] batched interface to get domain
-info
-
-\item [DOM0\_PLATFORM\_QUIRK:] inform Xen of a platform quirk it
-needs to handle (e.g. noirqbalance)
-
-\item [DOM0\_PHYSICAL\_MEMORY\_MAP:] get info about dom0's memory
-map
-
-\item [DOM0\_MAX\_VCPUS:] change max number of VCPUs for a domain
-
-\item [DOM0\_SETDOMAINHANDLE:] set the handle for a domain
-
-\end{description}
-\end{quote}
-
-Most of the above are best understood by looking at the code
-implementing them (in {\tt xen/common/dom0\_ops.c}) and in
-the user-space tools that use them (mostly in {\tt tools/libxc}).
-
-\section{Debugging Hypercalls}
-
-A few additional hypercalls are mainly useful for debugging:
-
-\begin{quote}
-\hypercall{console\_io(int cmd, int count, char *str)}
-
-Use Xen to interact with the console; operations are:
-
-{CONSOLEIO\_write}: Output count characters from buffer str.
-
-{CONSOLEIO\_read}: Input at most count characters into buffer str.
-\end{quote}
-
-A pair of hypercalls allows access to the underlying debug registers:
-\begin{quote}
-\hypercall{set\_debugreg(int reg, unsigned long value)}
-
-Set debug register {\bf reg} to {\bf value}
-
-\hypercall{get\_debugreg(int reg)}
-
-Return the contents of the debug register {\bf reg}
-\end{quote}
-
-And finally:
-\begin{quote}
-\hypercall{xen\_version(int cmd)}
-
-Request Xen version number.
-\end{quote}
-
-This is useful to ensure that user-space tools are in sync
-with the underlying hypervisor.
-
-
-\end{document}
diff -r a2a8089b1ffb -r 4271634e4c86 docs/src/user.tex
--- a/docs/src/user.tex Tue Jan 24 16:46:17 2012 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,3235 +0,0 @@
-\documentclass[11pt,twoside,final,openright]{report}
-\usepackage{a4,graphicx,html,parskip,setspace,times,xspace,url}
-\setstretch{1.15}
-
-\renewcommand{\ttdefault}{pcr}
-
-\def\Xend{{Xend}\xspace}
-\def\xend{{xend}\xspace}
-
-\latexhtml{\renewcommand{\path}[1]{{\small {\tt
#1}}}}{\renewcommand{\path}[1]{{\tt #1}}}
-
-
-\begin{document}
-
-% TITLE PAGE
-\pagestyle{empty}
-\begin{center}
-\vspace*{\fill}
-\includegraphics{figs/xenlogo.eps}
-\vfill
-\vfill
-\vfill
-\begin{tabular}{l}
-{\Huge \bf Users' Manual} \\[4mm]
-{\huge Xen v3.3} \\[80mm]
-\end{tabular}
-\end{center}
-
-{\bf DISCLAIMER: This documentation is always under active development
-and as such there may be mistakes and omissions --- watch out for
-these and please report any you find to the developers' mailing list,
-xen-devel@xxxxxxxxxxxxxxxxxxxx The latest version is always available
-on-line. Contributions of material, suggestions and corrections are
-welcome.}
-
-\vfill
-\clearpage
-
-
-% COPYRIGHT NOTICE
-\pagestyle{empty}
-
-\vspace*{\fill}
-
-Xen is Copyright \copyright 2002-2008, Citrix Systems, Inc., University of
Cambridge, UK, XenSource Inc., IBM Corp., Hewlett-Packard Co., Intel Corp., AMD
Inc., and others. All rights reserved.
-
-Xen is an open-source project. Most portions of Xen are licensed for copying
-under the terms of the GNU General Public License, version 2. Other portions
-are licensed under the terms of the GNU Lesser General Public License, the
-Zope Public License 2.0, or under ``BSD-style'' licenses. Please refer to the
-COPYING file for details.
-
-Xen includes software by Christopher Clark. This software is covered by the
-following licence:
-
-\begin{quote}
-Copyright (c) 2002, Christopher Clark. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-\begin{itemize}
-\item Redistributions of source code must retain the above copyright notice,
-this list of conditions and the following disclaimer.
-
-\item Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
-
-\item Neither the name of the original author; nor the names of any
-contributors may be used to endorse or promote products derived from this
-software without specific prior written permission.
-\end{itemize}
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-\end{quote}
-
-\cleardoublepage
-
-
-% TABLE OF CONTENTS
-\pagestyle{plain}
-\pagenumbering{roman}
-{ \parskip 0pt plus 1pt
- \tableofcontents }
-\cleardoublepage
-
-
-% PREPARE FOR MAIN TEXT
-\pagenumbering{arabic}
-\raggedbottom
-\widowpenalty=10000
-\clubpenalty=10000
-\parindent=0pt
-\parskip=5pt
-\renewcommand{\topfraction}{.8}
-\renewcommand{\bottomfraction}{.8}
-\renewcommand{\textfraction}{.2}
-\renewcommand{\floatpagefraction}{.8}
-\setstretch{1.1}
-
-
-%% Chapter Introduction moved to introduction.tex
-\chapter{Introduction}
-
-
-Xen is an open-source \emph{para-virtualizing} virtual machine monitor
-(VMM), or ``hypervisor'', for a variety of processor architectures including
x86. Xen can securely execute multiple virtual machines on a single physical
system with near native performance. Xen facilitates enterprise-grade
functionality, including:
-
-\begin{itemize}
-\item Virtual machines with performance close to native hardware.
-\item Live migration of running virtual machines between physical hosts.
-\item Up to 32\footnote{IA64 supports up to 64 virtual CPUs per guest virtual
machine} virtual CPUs per guest virtual machine, with VCPU hotplug.
-\item x86/32 with PAE, x86/64, and IA64 platform support.
-\item Intel and AMD Virtualization Technology for unmodified guest operating
systems (including Microsoft Windows).
-\item Excellent hardware support (supports almost all Linux device
- drivers).
-\end{itemize}
-
-
-\section{Usage Scenarios}
-
-Usage scenarios for Xen include:
-
-\begin{description}
-\item [Server Consolidation.] Move multiple servers onto a single
- physical host with performance and fault isolation provided at the
- virtual machine boundaries.
-\item [Hardware Independence.] Allow legacy applications and operating
- systems to exploit new hardware.
-\item [Multiple OS configurations.] Run multiple operating systems
- simultaneously, for development or testing purposes.
-\item [Kernel Development.] Test and debug kernel modifications in a
- sand-boxed virtual machine --- no need for a separate test machine.
-\item [Cluster Computing.] Management at VM granularity provides more
- flexibility than separately managing each physical host, but better
- control and isolation than single-system image solutions,
- particularly by using live migration for load balancing.
-\item [Hardware support for custom OSes.] Allow development of new
- OSes while benefiting from the wide-ranging hardware support of
- existing OSes such as Linux.
-\end{description}
-
-
-\section{Operating System Support}
-
-Para-virtualization permits very high performance virtualization, even
-on architectures like x86 that are traditionally very hard to
-virtualize.
-
-This approach requires operating systems to be \emph{ported} to run on
-Xen. Porting an OS to run on Xen is similar to supporting a new
-hardware platform, however the process is simplified because the
-para-virtual machine architecture is very similar to the underlying
-native hardware. Even though operating system kernels must explicitly
-support Xen, a key feature is that user space applications and
-libraries \emph{do not} require modification.
-
-With hardware CPU virtualization as provided by Intel VT and AMD
-SVM technology, the ability to run an unmodified guest OS kernel
-is available. No porting of the OS is required, although some
-additional driver support is necessary within Xen itself. Unlike
-traditional full virtualization hypervisors, which suffer a tremendous
-performance overhead, the combination of Xen and VT or Xen and
-Pacifica technology complement one another to offer superb performance
-for para-virtualized guest operating systems and full support for
-unmodified guests running natively on the processor.
-
-Paravirtualized Xen support is available for increasingly many
-operating systems: currently, mature Linux support is available and
-included in the standard distribution. Other OS ports, including
-NetBSD, FreeBSD and Solaris are also complete.
-
-
-\section{Hardware Support}
-
-Xen currently runs on the IA64 and x86 architectures. Multiprocessor
-machines are supported, and there is support for HyperThreading (SMT).
-
-The default 32-bit Xen requires processor support for Physical
-Addressing Extensions (PAE), which enables the hypervisor to address
-up to 16GB of physical memory. Xen also supports x86/64 platforms
-such as Intel EM64T and AMD Opteron which can currently address up to
-1TB of physical memory.
-
-Xen offloads most of the hardware support issues to the guest OS
-running in the \emph{Domain~0} management virtual machine. Xen itself
-contains only the code required to detect and start secondary
-processors, set up interrupt routing, and perform PCI bus
-enumeration. Device drivers run within a privileged guest OS rather
-than within Xen itself. This approach provides compatibility with the
-majority of device hardware supported by Linux. The default XenLinux
-build contains support for most server-class network and disk
-hardware, but you can add support for other hardware by configuring
-your XenLinux kernel in the normal way.
-
-
-\section{Structure of a Xen-Based System}
-
-A Xen system has multiple layers, the lowest and most privileged of
-which is Xen itself.
-
-Xen may host multiple \emph{guest} operating systems, each of which is
-executed within a secure virtual machine. In Xen terminology, a
-\emph{domain}. Domains are scheduled by Xen to make effective use of the
-available physical CPUs. Each guest OS manages its own applications.
-This management includes the responsibility of scheduling each
-application within the time allotted to the VM by Xen.
-
-The first domain, \emph{domain~0}, is created automatically when the
-system boots and has special management privileges. Domain~0 builds
-other domains and manages their virtual devices. It also performs
-administrative tasks such as suspending, resuming and migrating other
-virtual machines.
-
-Within domain~0, a process called \emph{xend} runs to manage the system.
-\Xend\ is responsible for managing virtual machines and providing access
-to their consoles. Commands are issued to \xend\ over an HTTP interface,
-via a command-line tool.
-
-
-\section{History}
-
-Xen was originally developed by the Systems Research Group at the
-University of Cambridge Computer Laboratory as part of the XenoServers
-project, funded by the UK-EPSRC\@.
-
-XenoServers aim to provide a ``public infrastructure for global
-distributed computing''. Xen plays a key part in that, allowing one to
-efficiently partition a single machine to enable multiple independent
-clients to run their operating systems and applications in an
-environment. This environment provides protection, resource isolation
-and accounting. The project web page contains further information along
-with pointers to papers and technical reports:
-\path{http://www.cl.cam.ac.uk/xeno}
-
-Xen has grown into a fully-fledged project in its own right, enabling us
-to investigate interesting research issues regarding the best techniques
-for virtualizing resources such as the CPU, memory, disk and network.
-Project contributors now include Citrix, Intel, IBM, HP, AMD, Novell,
-RedHat, Sun, Fujitsu, and Samsung.
-
-Xen was first described in a paper presented at SOSP in
-2003\footnote{\tt
- http://www.cl.cam.ac.uk/netos/papers/2003-xensosp.pdf}, and the first
-public release (1.0) was made that October. Since then, Xen has
-significantly matured and is now used in production scenarios on many
-sites.
-
-\section{What's New}
-
-Xen 3.3.0 offers:
-
-\begin{itemize}
-\item IO Emulation (stub domains) for HVM IO performance and scailability
-\item Replacement of Intel VT vmxassist by new 16b emulation code
-\item Improved VT-d device pass-through e.g. for graphics devices
-\item Enhanced C and P state power management
-\item Exploitation of multi-queue support on modern NICs
-\item Removal of domain lock for improved PV guest scalability
-\item 2MB page support for HVM and PV guests
-\item CPU Portability
-\end{itemize}
-
-Xen 3.3 delivers the capabilities needed by enterprise customers and gives
computing industry leaders a solid, secure platform to build upon for their
virtualization solutions. This latest release establishes Xen as the definitive
open source solution for virtualization.
-
-
-
-\part{Installation}
-
-%% Chapter Basic Installation
-\chapter{Basic Installation}
-
-The Xen distribution includes three main components: Xen itself, ports
-of Linux and NetBSD to run on Xen, and the userspace tools required to
-manage a Xen-based system. This chapter describes how to install the
-Xen~3.3 distribution from source. Alternatively, there may be pre-built
-packages available as part of your operating system distribution.
-
-
-\section{Prerequisites}
-\label{sec:prerequisites}
-
-The following is a full list of prerequisites. Items marked `$\dag$' are
-required by the \xend\ control tools, and hence required if you want to
-run more than one virtual machine; items marked `$*$' are only required
-if you wish to build from source.
-\begin{itemize}
-\item A working Linux distribution using the GRUB bootloader and running
- on a P6-class or newer CPU\@.
-\item [$\dag$] The \path{iproute2} package.
-\item [$\dag$] The Linux bridge-utils\footnote{Available from {\tt
- http://bridge.sourceforge.net}} (e.g., \path{/sbin/brctl})
-\item [$\dag$] The Linux hotplug system\footnote{Available from {\tt
- http://linux-hotplug.sourceforge.net/}} (e.g.,
- \path{/sbin/hotplug} and related scripts). On newer distributions,
- this is included alongside the Linux udev system\footnote{See {\tt
- http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html/}}.
-\item [$*$] Build tools (gcc v3.2.x or v3.3.x, binutils, GNU make).
-\item [$*$] Development installation of zlib (e.g.,\ zlib-dev).
-\item [$*$] Development installation of Python v2.2 or later (e.g.,\
- python-dev).
-\item [$*$] \LaTeX\ and transfig are required to build the
- documentation.
-\end{itemize}
-
-Once you have satisfied these prerequisites, you can now install either
-a binary or source distribution of Xen.
-
-\section{Installing from Binary Tarball}
-
-Pre-built tarballs are available for download from the XenSource downloads
-page:
-\begin{quote} {\tt http://www.xensource.com/downloads/}
-\end{quote}
-
-Once you've downloaded the tarball, simply unpack and install:
-\begin{verbatim}
-# tar zxvf xen-3.0-install.tgz
-# cd xen-3.0-install
-# sh ./install.sh
-\end{verbatim}
-
-Once you've installed the binaries you need to configure your system as
-described in Section~\ref{s:configure}.
-
-\section{Installing from RPMs}
-Pre-built RPMs are available for download from the XenSource downloads
-page:
-\begin{quote} {\tt http://www.xensource.com/downloads/}
-\end{quote}
-
-Once you've downloaded the RPMs, you typically install them via the
-RPM commands:
-
-\verb|# rpm -iv rpmname|
-
-See the instructions and the Release Notes for each RPM set referenced at:
- \begin{quote}
- {\tt http://www.xensource.com/downloads/}.
- \end{quote}
-
-\section{Installing from Source}
-
-This section describes how to obtain, build and install Xen from source.
-
-\subsection{Obtaining the Source}
-
-The Xen source tree is available as either a compressed source tarball
-or as a clone of our master Mercurial repository.
-
-\begin{description}
-\item[Obtaining the Source Tarball]\mbox{} \\
- Stable versions and daily snapshots of the Xen source tree are
- available from the Xen download page:
- \begin{quote} {\tt \tt http://www.xensource.com/downloads/}
- \end{quote}
-\item[Obtaining the source via Mercurial]\mbox{} \\
- The source tree may also be obtained via the public Mercurial
- repository at:
- \begin{quote}{\tt http://xenbits.xensource.com}
- \end{quote} See the instructions and the Getting Started Guide
- referenced at:
- \begin{quote}
- {\tt http://www.xensource.com/downloads/}
- \end{quote}
-\end{description}
-
-% \section{The distribution}
-%
-% The Xen source code repository is structured as follows:
-%
-% \begin{description}
-% \item[\path{tools/}] Xen node controller daemon (Xend), command line
-% tools, control libraries
-% \item[\path{xen/}] The Xen VMM.
-% \item[\path{buildconfigs/}] Build configuration files
-% \item[\path{linux-*-xen-sparse/}] Xen support for Linux.
-% \item[\path{patches/}] Experimental patches for Linux.
-% \item[\path{docs/}] Various documentation files for users and
-% developers.
-% \item[\path{extras/}] Bonus extras.
-% \end{description}
-
-\subsection{Building from Source}
-
-The top-level Xen Makefile includes a target ``world'' that will do the
-following:
-
-\begin{itemize}
-\item Build Xen.
-\item Build the control tools, including \xend.
-\item Download (if necessary) and unpack the Linux 2.6 source code, and
- patch it for use with Xen.
-\item Build a Linux kernel to use in domain~0 and a smaller unprivileged
- kernel, which can be used for unprivileged virtual machines.
-\end{itemize}
-
-After the build has completed you should have a top-level directory
-called \path{dist/} in which all resulting targets will be placed. Of
-particular interest are the two XenLinux kernel images, one with a
-``-xen0'' extension which contains hardware device drivers and drivers
-for Xen's virtual devices, and one with a ``-xenU'' extension that
-just contains the virtual ones. These are found in
-\path{dist/install/boot/} along with the image for Xen itself and the
-configuration files used during the build.
-
-%The NetBSD port can be built using:
-%\begin{quote}
-%\begin{verbatim}
-%# make netbsd20
-%\end{verbatim}\end{quote}
-%NetBSD port is built using a snapshot of the netbsd-2-0 cvs branch.
-%The snapshot is downloaded as part of the build process if it is not
-%yet present in the \path{NETBSD\_SRC\_PATH} search path. The build
-%process also downloads a toolchain which includes all of the tools
-%necessary to build the NetBSD kernel under Linux.
-
-To customize the set of kernels built you need to edit the top-level
-Makefile. Look for the line:
-\begin{quote}
-\begin{verbatim}
-KERNELS ?= linux-2.6-xen0 linux-2.6-xenU
-\end{verbatim}
-\end{quote}
-
-You can edit this line to include any set of operating system kernels
-which have configurations in the top-level \path{buildconfigs/}
-directory.
-
-%% Inspect the Makefile if you want to see what goes on during a
-%% build. Building Xen and the tools is straightforward, but XenLinux
-%% is more complicated. The makefile needs a `pristine' Linux kernel
-%% tree to which it will then add the Xen architecture files. You can
-%% tell the makefile the location of the appropriate Linux compressed
-%% tar file by
-%% setting the LINUX\_SRC environment variable, e.g. \\
-%% \verb!# LINUX_SRC=/tmp/linux-2.6.11.tar.bz2 make world! \\ or by
-%% placing the tar file somewhere in the search path of {\tt
-%% LINUX\_SRC\_PATH} which defaults to `{\tt .:..}'. If the
-%% makefile can't find a suitable kernel tar file it attempts to
-%% download it from kernel.org (this won't work if you're behind a
-%% firewall).
-
-%% After untaring the pristine kernel tree, the makefile uses the {\tt
-%% mkbuildtree} script to add the Xen patches to the kernel.
-
-%% \framebox{\parbox{5in}{
-%% {\bf Distro specific:} \\
-%% {\it Gentoo} --- if not using udev (most installations,
-%% currently), you'll need to enable devfs and devfs mount at boot
-%% time in the xen0 config. }}
-
-\subsection{Custom Kernels}
-
-% If you have an SMP machine you may wish to give the {\tt '-j4'}
-% argument to make to get a parallel build.
-
-If you wish to build a customized XenLinux kernel (e.g.\ to support
-additional devices or enable distribution-required features), you can
-use the standard Linux configuration mechanisms, specifying that the
-architecture being built for is \path{xen}, e.g:
-\begin{quote}
-\begin{verbatim}
-# cd linux-2.6.12-xen0
-# make ARCH=xen xconfig
-# cd ..
-# make
-\end{verbatim}
-\end{quote}
-
-You can also copy an existing Linux configuration (\path{.config}) into
-e.g.\ \path{linux-2.6.12-xen0} and execute:
-\begin{quote}
-\begin{verbatim}
-# make ARCH=xen oldconfig
-\end{verbatim}
-\end{quote}
-
-You may be prompted with some Xen-specific options. We advise accepting
-the defaults for these options.
-
-Note that the only difference between the two types of Linux kernels
-that are built is the configuration file used for each. The ``U''
-suffixed (unprivileged) versions don't contain any of the physical
-hardware device drivers, leading to a 30\% reduction in size; hence you
-may prefer these for your non-privileged domains. The ``0'' suffixed
-privileged versions can be used to boot the system, as well as in driver
-domains and unprivileged domains.
-
-\subsection{Installing Generated Binaries}
-
-The files produced by the build process are stored under the
-\path{dist/install/} directory. To install them in their default
-locations, do:
-\begin{quote}
-\begin{verbatim}
-# make install
-\end{verbatim}
-\end{quote}
-
-Alternatively, users with special installation requirements may wish to
-install them manually by copying the files to their appropriate
-destinations.
-
-%% Files in \path{install/boot/} include:
-%% \begin{itemize}
-%% \item \path{install/boot/xen-3.0.gz} Link to the Xen 'kernel'
-%% \item \path{install/boot/vmlinuz-2.6-xen0} Link to domain 0
-%% XenLinux kernel
-%% \item \path{install/boot/vmlinuz-2.6-xenU} Link to unprivileged
-%% XenLinux kernel
-%% \end{itemize}
-
-The \path{dist/install/boot} directory will also contain the config
-files used for building the XenLinux kernels, and also versions of Xen
-and XenLinux kernels that contain debug symbols such as
-(\path{xen-syms-3.0.0} and \path{vmlinux-syms-2.6.12.6-xen0}) which are
-essential for interpreting crash dumps. Retain these files as the
-developers may wish to see them if you post on the mailing list.
-
-
-\section{Configuration}
-\label{s:configure}
-
-Once you have built and installed the Xen distribution, it is simple to
-prepare the machine for booting and running Xen.
-
-\subsection{GRUB Configuration}
-
-An entry should be added to \path{grub.conf} (often found under
-\path{/boot/} or \path{/boot/grub/}) to allow Xen / XenLinux to boot.
-This file is sometimes called \path{menu.lst}, depending on your
-distribution. The entry should look something like the following:
-
-%% KMSelf Thu Dec 1 19:06:13 PST 2005 262144 is useful for RHEL/RH and
-%% related Dom0s.
-{\small
-\begin{verbatim}
-title Xen 3.0 / XenLinux 2.6
- kernel /boot/xen-3.0.gz dom0_mem=262144
- module /boot/vmlinuz-2.6-xen0 root=/dev/sda4 ro console=tty0
-\end{verbatim}
-}
-
-The kernel line tells GRUB where to find Xen itself and what boot
-parameters should be passed to it (in this case, setting the domain~0
-memory allocation in kilobytes and the settings for the serial port).
-For more details on the various Xen boot parameters see
-Section~\ref{s:xboot}.
-
-The module line of the configuration describes the location of the
-XenLinux kernel that Xen should start and the parameters that should be
-passed to it. These are standard Linux parameters, identifying the root
-device and specifying it be initially mounted read only and instructing
-that console output be sent to the screen. Some distributions such as
-SuSE do not require the \path{ro} parameter.
-
-%% \framebox{\parbox{5in}{
-%% {\bf Distro specific:} \\
-%% {\it SuSE} --- Omit the {\tt ro} option from the XenLinux
-%% kernel command line, since the partition won't be remounted rw
-%% during boot. }}
-
-To use an initrd, add another \path{module} line to the configuration,
-like: {\small
-\begin{verbatim}
- module /boot/my_initrd.gz
-\end{verbatim}
-}
-
-%% KMSelf Thu Dec 1 19:05:30 PST 2005 Other configs as an appendix?
-
-When installing a new kernel, it is recommended that you do not delete
-existing menu options from \path{menu.lst}, as you may wish to boot your
-old Linux kernel in future, particularly if you have problems.
-
-\subsection{Serial Console (optional)}
-
-Serial console access allows you to manage, monitor, and interact with
-your system over a serial console. This can allow access from another
-nearby system via a null-modem (``LapLink'') cable or remotely via a serial
-concentrator.
-
-You system's BIOS, bootloader (GRUB), Xen, Linux, and login access must
-each be individually configured for serial console access. It is
-\emph{not} strictly necessary to have each component fully functional,
-but it can be quite useful.
-
-For general information on serial console configuration under Linux,
-refer to the ``Remote Serial Console HOWTO'' at The Linux Documentation
-Project: \url{http://www.tldp.org}
-
-\subsubsection{Serial Console BIOS configuration}
-
-Enabling system serial console output neither enables nor disables
-serial capabilities in GRUB, Xen, or Linux, but may make remote
-management of your system more convenient by displaying POST and other
-boot messages over serial port and allowing remote BIOS configuration.
-
-Refer to your hardware vendor's documentation for capabilities and
-procedures to enable BIOS serial redirection.
-
-
-\subsubsection{Serial Console GRUB configuration}
-
-Enabling GRUB serial console output neither enables nor disables Xen or
-Linux serial capabilities, but may made remote management of your system
-more convenient by displaying GRUB prompts, menus, and actions over
-serial port and allowing remote GRUB management.
-
-Adding the following two lines to your GRUB configuration file,
-typically either \path{/boot/grub/menu.lst} or \path{/boot/grub/grub.conf}
-depending on your distro, will enable GRUB serial output.
-
-\begin{quote}
-{\small \begin{verbatim}
- serial --unit=0 --speed=115200 --word=8 --parity=no --stop=1
- terminal --timeout=10 serial console
-\end{verbatim}}
-\end{quote}
-
-Note that when both the serial port and the local monitor and keyboard
-are enabled, the text ``\emph{Press any key to continue}'' will appear
-at both. Pressing a key on one device will cause GRUB to display to
-that device. The other device will see no output. If no key is
-pressed before the timeout period expires, the system will boot to the
-default GRUB boot entry.
-
-Please refer to the GRUB documentation for further information.
-
-
-\subsubsection{Serial Console Xen configuration}
-
-Enabling Xen serial console output neither enables nor disables Linux
-kernel output or logging in to Linux over serial port. It does however
-allow you to monitor and log the Xen boot process via serial console and
-can be very useful in debugging.
-
-%% kernel /boot/xen-2.0.gz dom0_mem=131072 console=com1,vga com1=115200,8n1
-%% module /boot/vmlinuz-2.6-xen0 root=/dev/sda4 ro
-
-In order to configure Xen serial console output, it is necessary to
-add a boot option to your GRUB config; e.g.\ replace the previous
-example kernel line with:
-\begin{quote} {\small \begin{verbatim}
- kernel /boot/xen.gz dom0_mem=131072 com1=115200,8n1 console=com1,vga
-\end{verbatim}}
-\end{quote}
-
-This configures Xen to output on COM1 at 115,200 baud, 8 data bits, no
-parity and 1 stop bit. Modify these parameters for your environment.
-See Section~\ref{s:xboot} for an explanation of all boot parameters.
-
-One can also configure XenLinux to share the serial console; to achieve
-this append ``\path{console=ttyS0}'' to your module line.
-
-
-\subsubsection{Serial Console Linux configuration}
-
-Enabling Linux serial console output at boot neither enables nor
-disables logging in to Linux over serial port. It does however allow
-you to monitor and log the Linux boot process via serial console and can be
-very useful in debugging.
-
-To enable Linux output at boot time, add the parameter
-\path{console=ttyS0} (or ttyS1, ttyS2, etc.) to your kernel GRUB line.
-Under Xen, this might be:
-\begin{quote}
-{\footnotesize \begin{verbatim}
- module /vmlinuz-2.6-xen0 ro root=/dev/VolGroup00/LogVol00 \
- console=ttyS0, 115200
-\end{verbatim}}
-\end{quote}
-to enable output over ttyS0 at 115200 baud.
-
-
-
-\subsubsection{Serial Console Login configuration}
-
-Logging in to Linux via serial console, under Xen or otherwise, requires
-specifying a login prompt be started on the serial port. To permit root
-logins over serial console, the serial port must be added to
-\path{/etc/securetty}.
-
-\newpage
-To automatically start a login prompt over the serial port,
-add the line: \begin{quote} {\small {\tt c:2345:respawn:/sbin/mingetty
-ttyS0}} \end{quote} to \path{/etc/inittab}. Run \path{init q} to force
-a reload of your inttab and start getty.
-
-To enable root logins, add \path{ttyS0} to \path{/etc/securetty} if not
-already present.
-
-Your distribution may use an alternate getty; options include getty,
-mgetty and agetty. Consult your distribution's documentation
-for further information.
-
-
-\subsection{TLS Libraries}
-
-Users of the XenLinux 2.6 kernel should disable Thread Local Storage
-(TLS) (e.g.\ by doing a \path{mv /lib/tls /lib/tls.disabled}) before
-attempting to boot a XenLinux kernel\footnote{If you boot without first
- disabling TLS, you will get a warning message during the boot process.
- In this case, simply perform the rename after the machine is up and
- then run \path{/sbin/ldconfig} to make it take effect.}. You can
-always reenable TLS by restoring the directory to its original location
-(i.e.\ \path{mv /lib/tls.disabled /lib/tls}).
-
-The reason for this is that the current TLS implementation uses
-segmentation in a way that is not permissible under Xen. If TLS is not
-disabled, an emulation mode is used within Xen which reduces performance
-substantially. To ensure full performance you should install a
-`Xen-friendly' (nosegneg) version of the library.
-
-
-\section{Booting Xen}
-
-It should now be possible to restart the system and use Xen. Reboot and
-choose the new Xen option when the Grub screen appears.
-
-What follows should look much like a conventional Linux boot. The first
-portion of the output comes from Xen itself, supplying low level
-information about itself and the underlying hardware. The last portion
-of the output comes from XenLinux.
-
-You may see some error messages during the XenLinux boot. These are not
-necessarily anything to worry about---they may result from kernel
-configuration differences between your XenLinux kernel and the one you
-usually use.
-
-When the boot completes, you should be able to log into your system as
-usual. If you are unable to log in, you should still be able to reboot
-with your normal Linux kernel by selecting it at the GRUB prompt.
-
-
-% Booting Xen
-\chapter{Booting a Xen System}
-
-Booting the system into Xen will bring you up into the privileged
-management domain, Domain0. At that point you are ready to create
-guest domains and ``boot'' them using the \texttt{xm create} command.
-
-\section{Booting Domain0}
-
-After installation and configuration is complete, reboot the system
-and and choose the new Xen option when the Grub screen appears.
-
-What follows should look much like a conventional Linux boot. The
-first portion of the output comes from Xen itself, supplying low level
-information about itself and the underlying hardware. The last
-portion of the output comes from XenLinux.
-
-%% KMSelf Wed Nov 30 18:09:37 PST 2005: We should specify what these are.
-
-When the boot completes, you should be able to log into your system as
-usual. If you are unable to log in, you should still be able to
-reboot with your normal Linux kernel by selecting it at the GRUB prompt.
-
-The first step in creating a new domain is to prepare a root
-filesystem for it to boot. Typically, this might be stored in a normal
-partition, an LVM or other volume manager partition, a disk file or on
-an NFS server. A simple way to do this is simply to boot from your
-standard OS install CD and install the distribution into another
-partition on your hard drive.
-
-To start the \xend\ control daemon, type
-\begin{quote}
- \verb!# xend start!
-\end{quote}
-
-If you wish the daemon to start automatically, see the instructions in
-Section~\ref{s:xend}. Once the daemon is running, you can use the
-\path{xm} tool to monitor and maintain the domains running on your
-system. This chapter provides only a brief tutorial. We provide full
-details of the \path{xm} tool in the next chapter.
-
-% \section{From the web interface}
-%
-% Boot the Xen machine and start Xensv (see Chapter~\ref{cha:xensv}
-% for more details) using the command: \\
-% \verb_# xensv start_ \\
-% This will also start Xend (see Chapter~\ref{cha:xend} for more
-% information).
-%
-% The domain management interface will then be available at {\tt
-% http://your\_machine:8080/}. This provides a user friendly wizard
-% for starting domains and functions for managing running domains.
-%
-% \section{From the command line}
-\section{Booting Guest Domains}
-
-\subsection{Creating a Domain Configuration File}
-
-Before you can start an additional domain, you must create a
-configuration file. We provide two example files which you can use as
-a starting point:
-\begin{itemize}
-\item \path{/etc/xen/xmexample1} is a simple template configuration
- file for describing a single VM\@.
-\item \path{/etc/xen/xmexample2} file is a template description that
- is intended to be reused for multiple virtual machines. Setting the
- value of the \path{vmid} variable on the \path{xm} command line
- fills in parts of this template.
-\end{itemize}
-
-There are also a number of other examples which you may find useful.
-Copy one of these files and edit it as appropriate. Typical values
-you may wish to edit include:
-
-\begin{quote}
-\begin{description}
-\item[kernel] Set this to the path of the kernel you compiled for use
- with Xen (e.g.\ \path{kernel = ``/boot/vmlinuz-2.6-xenU''})
-\item[memory] Set this to the size of the domain's memory in megabytes
- (e.g.\ \path{memory = 64})
-\item[disk] Set the first entry in this list to calculate the offset
- of the domain's root partition, based on the domain ID\@. Set the
- second to the location of \path{/usr} if you are sharing it between
- domains (e.g.\ \path{disk = ['phy:your\_hard\_drive\%d,sda1,w' \%
- (base\_partition\_number + vmid),
- 'phy:your\_usr\_partition,sda6,r' ]}
-\item[dhcp] Uncomment the dhcp variable, so that the domain will
- receive its IP address from a DHCP server (e.g.\ \path{dhcp=``dhcp''})
-\end{description}
-\end{quote}
-
-You may also want to edit the {\bf vif} variable in order to choose
-the MAC address of the virtual ethernet interface yourself. For
-example:
-
-\begin{quote}
-\verb_vif = ['mac=00:16:3E:F6:BB:B3']_
-\end{quote}
-If you do not set this variable, \xend\ will automatically generate a
-random MAC address from the range 00:16:3E:xx:xx:xx, assigned by IEEE to
-XenSource as an OUI (organizationally unique identifier). XenSource
-Inc. gives permission for anyone to use addresses randomly allocated
-from this range for use by their Xen domains.
-
-For a list of IEEE OUI assignments, see
-\url{http://standards.ieee.org/regauth/oui/oui.txt}
-
-
-\subsection{Booting the Guest Domain}
-
-The \path{xm} tool provides a variety of commands for managing
-domains. Use the \path{create} command to start new domains. Assuming
-you've created a configuration file \path{myvmconf} based around
-\path{/etc/xen/xmexample2}, to start a domain with virtual machine
-ID~1 you should type:
-
-\begin{quote}
-\begin{verbatim}
-# xm create -c myvmconf vmid=1
-\end{verbatim}
-\end{quote}
-
-The \path{-c} switch causes \path{xm} to turn into the domain's
-console after creation. The \path{vmid=1} sets the \path{vmid}
-variable used in the \path{myvmconf} file.
-
-You should see the console boot messages from the new domain appearing
-in the terminal in which you typed the command, culminating in a login
-prompt.
-
-
-\section{Starting / Stopping Domains Automatically}
-
-It is possible to have certain domains start automatically at boot
-time and to have dom0 wait for all running domains to shutdown before
-it shuts down the system.
-
-To specify a domain is to start at boot-time, place its configuration
-file (or a link to it) under \path{/etc/xen/auto/}.
-
-A Sys-V style init script for Red Hat and LSB-compliant systems is
-provided and will be automatically copied to \path{/etc/init.d/}
-during install. You can then enable it in the appropriate way for
-your distribution.
-
-For instance, on Red Hat:
-
-\begin{quote}
- \verb_# chkconfig --add xendomains_
-\end{quote}
-
-By default, this will start the boot-time domains in runlevels 3, 4
-and 5.
-
-You can also use the \path{service} command to run this script
-manually, e.g:
-
-\begin{quote}
- \verb_# service xendomains start_
-
- Starts all the domains with config files under /etc/xen/auto/.
-\end{quote}
-
-\begin{quote}
- \verb_# service xendomains stop_
-
- Shuts down all running Xen domains.
-\end{quote}
-
-
-
-\part{Configuration and Management}
-
-%% Chapter Domain Management Tools and Daemons
-\chapter{Domain Management Tools}
-
-This chapter summarizes the management software and tools available.
-
-
-\section{\Xend\ }
-\label{s:xend}
-
-
-The \Xend\ node control daemon performs system management functions
-related to virtual machines. It forms a central point of control of
-virtualized resources, and must be running in order to start and manage
-virtual machines. \Xend\ must be run as root because it needs access to
-privileged system management functions.
-
-An initialization script named \texttt{/etc/init.d/xend} is provided to
-start \Xend\ at boot time. Use the tool appropriate (i.e. chkconfig) for
-your Linux distribution to specify the runlevels at which this script
-should be executed, or manually create symbolic links in the correct
-runlevel directories.
-
-\Xend\ can be started on the command line as well, and supports the
-following set of parameters:
-
-\begin{tabular}{ll}
- \verb!# xend start! & start \xend, if not already running \\
- \verb!# xend stop! & stop \xend\ if already running \\
- \verb!# xend restart! & restart \xend\ if running, otherwise start it \\
- % \verb!# xend trace_start! & start \xend, with very detailed debug logging
\\
- \verb!# xend status! & indicates \xend\ status by its return code
-\end{tabular}
-
-A SysV init script called {\tt xend} is provided to start \xend\ at
-boot time. {\tt make install} installs this script in
-\path{/etc/init.d}. To enable it, you have to make symbolic links in
-the appropriate runlevel directories or use the {\tt chkconfig} tool,
-where available. Once \xend\ is running, administration can be done
-using the \texttt{xm} tool.
-
-\subsection{Logging}
-
-As \xend\ runs, events will be logged to \path{/var/log/xen/xend.log} and
-(less frequently) to \path{/var/log/xen/xend-debug.log}. These, along with
-the standard syslog files, are useful when troubleshooting problems.
-
-\subsection{Configuring \Xend\ }
-
-\Xend\ is written in Python. At startup, it reads its configuration
-information from the file \path{/etc/xen/xend-config.sxp}. The Xen
-installation places an example \texttt{xend-config.sxp} file in the
-\texttt{/etc/xen} subdirectory which should work for most installations.
-
-See the example configuration file \texttt{xend-debug.sxp} and the
-section 5 man page \texttt{xend-config.sxp} for a full list of
-parameters and more detailed information. Some of the most important
-parameters are discussed below.
-
-An HTTP interface and a Unix domain socket API are available to
-communicate with \Xend. This allows remote users to pass commands to the
-daemon. By default, \Xend does not start an HTTP server. It does start a
-Unix domain socket management server, as the low level utility
-\texttt{xm} requires it. For support of cross-machine migration, \Xend\
-can start a relocation server. This support is not enabled by default
-for security reasons.
-
-Note: the example \texttt{xend} configuration file modifies the defaults and
-starts up \Xend\ as an HTTP server as well as a relocation server.
-
-From the file:
-
-\begin{verbatim}
-#(xend-http-server no)
-(xend-http-server yes)
-#(xend-unix-server yes)
-#(xend-relocation-server no)
-(xend-relocation-server yes)
-\end{verbatim}
-
-Comment or uncomment lines in that file to disable or enable features
-that you require.
-
-Connections from remote hosts are disabled by default:
-
-\begin{verbatim}
-# Address xend should listen on for HTTP connections, if xend-http-server is
-# set.
-# Specifying 'localhost' prevents remote connections.
-# Specifying the empty string '' (the default) allows all connections.
-#(xend-address '')
-(xend-address localhost)
-\end{verbatim}
-
-It is recommended that if migration support is not needed, the
-\texttt{xend-relocation-server} parameter value be changed to
-``\texttt{no}'' or commented out.
-
-\section{Xm}
-\label{s:xm}
-
-The xm tool is the primary tool for managing Xen from the console. The
-general format of an xm command line is:
-
-\begin{verbatim}
-# xm command [switches] [arguments] [variables]
-\end{verbatim}
-
-The available \emph{switches} and \emph{arguments} are dependent on the
-\emph{command} chosen. The \emph{variables} may be set using
-declarations of the form {\tt variable=value} and command line
-declarations override any of the values in the configuration file being
-used, including the standard variables described above and any custom
-variables (for instance, the \path{xmdefconfig} file uses a {\tt vmid}
-variable).
-
-For online help for the commands available, type:
-
-\begin{quote}
-\begin{verbatim}
-# xm help
-\end{verbatim}
-\end{quote}
-
-This will list the most commonly used commands. The full list can be obtained
-using \verb_xm help --long_. You can also type \path{xm help $<$command$>$}
-for more information on a given command.
-
-\subsection{Basic Management Commands}
-
-One useful command is \verb_# xm list_ which lists all domains running in rows
-of the following format:
-\begin{center} {\tt name domid memory vcpus state cputime}
-\end{center}
-
-The meaning of each field is as follows:
-\begin{quote}
- \begin{description}
- \item[name] The descriptive name of the virtual machine.
- \item[domid] The number of the domain ID this virtual machine is
- running in.
- \item[memory] Memory size in megabytes.
- \item[vcpus] The number of virtual CPUs this domain has.
- \item[state] Domain state consists of 5 fields:
- \begin{description}
- \item[r] running
- \item[b] blocked
- \item[p] paused
- \item[s] shutdown
- \item[c] crashed
- \end{description}
- \item[cputime] How much CPU time (in seconds) the domain has used so
- far.
- \end{description}
-\end{quote}
-
-The \path{xm list} command also supports a long output format when the
-\path{-l} switch is used. This outputs the full details of the
-running domains in \xend's SXP configuration format.
-
-If you want to know how long your domains have been running for, then
-you can use the \verb_# xm uptime_ command.
-
-
-You can get access to the console of a particular domain using
-the \verb_# xm console_ command (e.g.\ \verb_# xm console myVM_).
-
-\subsection{Domain Scheduling Management Commands}
-
-The credit CPU scheduler automatically load balances guest VCPUs
-across all available physical CPUs on an SMP host. The user need
-not manually pin VCPUs to load balance the system. However, she
-can restrict which CPUs a particular VCPU may run on using
-the \path{xm vcpu-pin} command.
-
-Each guest domain is assigned a \path{weight} and a \path{cap}.
-
-A domain with a weight of 512 will get twice as much CPU as a
-domain with a weight of 256 on a contended host. Legal weights
-range from 1 to 65535 and the default is 256.
-
-The cap optionally fixes the maximum amount of CPU a guest will
-be able to consume, even if the host system has idle CPU cycles.
-The cap is expressed in percentage of one physical CPU: 100 is
-1 physical CPU, 50 is half a CPU, 400 is 4 CPUs, etc... The
-default, 0, means there is no upper cap.
-
-When you are running with the credit scheduler, you can check and
-modify your domains' weights and caps using the \path{xm sched-credit}
-command:
-
-\begin{tabular}{ll}
-\verb!xm sched-credit -d <domain>! & lists weight and cap \\
-\verb!xm sched-credit -d <domain> -w <weight>! & sets the weight \\
-\verb!xm sched-credit -d <domain> -c <cap>! & sets the cap
-\end{tabular}
-
-
-
-%% Chapter Domain Configuration
-\chapter{Domain Configuration}
-\label{cha:config}
-
-The following contains the syntax of the domain configuration files
-and description of how to further specify networking, driver domain
-and general scheduling behavior.
-
-
-\section{Configuration Files}
-\label{s:cfiles}
-
-Xen configuration files contain the following standard variables.
-Unless otherwise stated, configuration items should be enclosed in
-quotes: see the configuration scripts in \path{/etc/xen/}
-for concrete examples.
-
-\begin{description}
-\item[kernel] Path to the kernel image.
-\item[ramdisk] Path to a ramdisk image (optional).
- % \item[builder] The name of the domain build function (e.g.
- % {\tt'linux'} or {\tt'netbsd'}.
-\item[memory] Memory size in megabytes.
-\item[vcpus] The number of virtual CPUs.
-\item[console] Port to export the domain console on (default 9600 +
- domain ID).
-\item[vif] Network interface configuration. This may simply contain
-an empty string for each desired interface, or may override various
-settings, e.g.\
-\begin{verbatim}
-vif = [ 'mac=00:16:3E:00:00:11, bridge=xen-br0',
- 'bridge=xen-br1' ]
-\end{verbatim}
- to assign a MAC address and bridge to the first interface and assign
- a different bridge to the second interface, leaving \xend\ to choose
- the MAC address. The settings that may be overridden in this way are
- type, mac, bridge, ip, script, backend, and vifname.
-\item[disk] List of block devices to export to the domain e.g.
- \verb_disk = [ 'phy:hda1,sda1,r' ]_
- exports physical device \path{/dev/hda1} to the domain as
- \path{/dev/sda1} with read-only access. Exporting a disk read-write
- which is currently mounted is dangerous -- if you are \emph{certain}
- you wish to do this, you can specify \path{w!} as the mode.
-\item[dhcp] Set to {\tt `dhcp'} if you want to use DHCP to configure
- networking.
-\item[netmask] Manually configured IP netmask.
-\item[gateway] Manually configured IP gateway.
-\item[hostname] Set the hostname for the virtual machine.
-\item[root] Specify the root device parameter on the kernel command
- line.
-\item[nfs\_server] IP address for the NFS server (if any).
-\item[nfs\_root] Path of the root filesystem on the NFS server (if
- any).
-\item[extra] Extra string to append to the kernel command line (if
- any)
-\end{description}
-
-Additional fields are documented in the example configuration files
-(e.g. to configure virtual TPM functionality).
-
-For additional flexibility, it is also possible to include Python
-scripting commands in configuration files. An example of this is the
-\path{xmexample2} file, which uses Python code to handle the
-\path{vmid} variable.
-
-
-%\part{Advanced Topics}
-
-
-\section{Network Configuration}
-
-For many users, the default installation should work ``out of the
-box''. More complicated network setups, for instance with multiple
-Ethernet interfaces and/or existing bridging setups will require some
-special configuration.
-
-The purpose of this section is to describe the mechanisms provided by
-\xend\ to allow a flexible configuration for Xen's virtual networking.
-
-\subsection{Xen virtual network topology}
-
-Each domain network interface is connected to a virtual network
-interface in dom0 by a point to point link (effectively a ``virtual
-crossover cable''). These devices are named {\tt
- vif$<$domid$>$.$<$vifid$>$} (e.g.\ {\tt vif1.0} for the first
-interface in domain~1, {\tt vif3.1} for the second interface in
-domain~3).
-
-Traffic on these virtual interfaces is handled in domain~0 using
-standard Linux mechanisms for bridging, routing, rate limiting, etc.
-Xend calls on two shell scripts to perform initial configuration of
-the network and configuration of new virtual interfaces. By default,
-these scripts configure a single bridge for all the virtual
-interfaces. Arbitrary routing / bridging configurations can be
-configured by customizing the scripts, as described in the following
-section.
-
-\subsection{Xen networking scripts}
-
-Xen's virtual networking is configured by two shell scripts (by
-default \path{network-bridge} and \path{vif-bridge}). These are called
-automatically by \xend\ when certain events occur, with arguments to
-the scripts providing further contextual information. These scripts
-are found by default in \path{/etc/xen/scripts}. The names and
-locations of the scripts can be configured in
-\path{/etc/xen/xend-config.sxp}.
-
-\begin{description}
-\item[network-bridge:] This script is called whenever \xend\ is started or
- stopped to respectively initialize or tear down the Xen virtual
- network. In the default configuration initialization creates the
- bridge `xen-br0' and moves eth0 onto that bridge, modifying the
- routing accordingly. When \xend\ exits, it deletes the Xen bridge
- and removes eth0, restoring the normal IP and routing configuration.
-
- %% In configurations where the bridge already exists, this script
- %% could be replaced with a link to \path{/bin/true} (for instance).
-
-\item[vif-bridge:] This script is called for every domain virtual
- interface and can configure firewalling rules and add the vif to the
- appropriate bridge. By default, this adds and removes VIFs on the
- default Xen bridge.
-\end{description}
-
-Other example scripts are available (\path{network-route} and
-\path{vif-route}, \path{network-nat} and \path{vif-nat}).
-For more complex network setups (e.g.\ where routing is required or
-integrate with existing bridges) these scripts may be replaced with
-customized variants for your site's preferred configuration.
-
-\section{Driver Domain Configuration}
-\label{s:ddconf}
-
-\subsection{PCI}
-\label{ss:pcidd}
-
-Individual PCI devices can be assigned to a given domain (a PCI driver domain)
-to allow that domain direct access to the PCI hardware.
-
-While PCI Driver Domains can increase the stability and security of a system
-by addressing a number of security concerns, there are some security issues
-that remain that you can read about in Section~\ref{s:ddsecurity}.
-
-\subsubsection{Compile-Time Setup}
-To use this functionality, ensure
-that the PCI Backend is compiled in to a privileged domain (e.g. domain 0)
-and that the domains which will be assigned PCI devices have the PCI Frontend
-compiled in. In XenLinux, the PCI Backend is available under the Xen
-configuration section while the PCI Frontend is under the
-architecture-specific "Bus Options" section. You may compile both the backend
-and the frontend into the same kernel; they will not affect each other.
-
-\subsubsection{PCI Backend Configuration - Binding at Boot}
-The PCI devices you wish to assign to unprivileged domains must be "hidden"
-from your backend domain (usually domain 0) so that it does not load a driver
-for them. Use the \path{pciback.hide} kernel parameter which is specified on
-the kernel command-line and is configurable through GRUB (see
-Section~\ref{s:configure}). Note that devices are not really hidden from the
-backend domain. The PCI Backend appears to the Linux kernel as a regular PCI
-device driver. The PCI Backend ensures that no other device driver loads
-for the devices by binding itself as the device driver for those devices.
-PCI devices are identified by hexadecimal slot/function numbers (on Linux,
-use \path{lspci} to determine slot/function numbers of your devices) and
-can be specified with or without the PCI domain: \\
-\centerline{ {\tt ({\em bus}:{\em slot}.{\em func})} example {\tt (02:1d.3)}}
\\
-\centerline{ {\tt ({\em domain}:{\em bus}:{\em slot}.{\em func})} example
{\tt (0000:02:1d.3)}} \\
-
-An example kernel command-line which hides two PCI devices might be: \\
-\centerline{ {\tt root=/dev/sda4 ro console=tty0
pciback.hide=(02:01.f)(0000:04:1d.0) } } \\
-
-\subsubsection{PCI Backend Configuration - Late Binding}
-PCI devices can also be bound to the PCI Backend after boot through the manual
-binding/unbinding facilities provided by the Linux kernel in sysfs (allowing
-for a Xen user to give PCI devices to driver domains that were not specified
-on the kernel command-line). There are several attributes with the PCI
-Backend's sysfs directory (\path{/sys/bus/pci/drivers/pciback}) that can be
-used to bind/unbind devices:
-
-\begin{description}
-\item[slots] lists all of the PCI slots that the PCI Backend will try to seize
- (or "hide" from Domain 0). A PCI slot must appear in this list before it can
- be bound to the PCI Backend through the \path{bind} attribute.
-\item[new\_slot] write the name of a slot here (in 0000:00:00.0 format) to
- have the PCI Backend seize the device in this slot.
-\item[remove\_slot] write the name of a slot here (same format as
- \path{new\_slot}) to have the PCI Backend no longer try to seize devices in
- this slot. Note that this does not unbind the driver from a device it has
- already seized.
-\item[bind] write the name of a slot here (in 0000:00:00.0 format) to have
- the Linux kernel attempt to bind the device in that slot to the PCI Backend
- driver.
-\item[unbind] write the name of a skit here (same format as \path{bind}) to
have
- the Linux kernel unbind the device from the PCI Backend. DO NOT unbind a
- device while it is currently given to a PCI driver domain!
-\end{description}
-
-Some examples:
-
-Bind a device to the PCI Backend which is not bound to any other driver.
-\begin{verbatim}
-# # Add a new slot to the PCI Backend's list
-# echo -n 0000:01:04.d > /sys/bus/pci/drivers/pciback/new_slot
-# # Now that the backend is watching for the slot, bind to it
-# echo -n 0000:01:04.d > /sys/bus/pci/drivers/pciback/bind
-\end{verbatim}
-
-Unbind a device from its driver and bind to the PCI Backend.
-\begin{verbatim}
-# # Unbind a PCI network card from its network driver
-# echo -n 0000:05:02.0 > /sys/bus/pci/drivers/3c905/unbind
-# # And now bind it to the PCI Backend
-# echo -n 0000:05:02.0 > /sys/bus/pci/drivers/pciback/new_slot
-# echo -n 0000:05:02.0 > /sys/bus/pci/drivers/pciback/bind
-\end{verbatim}
-
-Note that the "-n" option in the example is important as it causes echo to not
-output a new-line.
-
-\subsubsection{PCI Backend Configuration - User-space Quirks}
-Quirky devices (such as the Broadcom Tigon 3) may need write access to their
-configuration space registers. Xen can be instructed to allow specified PCI
-devices write access to specific configuration space registers. The policy may
-be found in:
-
-\centerline{ \path{/etc/xen/xend-pci-quirks.sxp} }
-
-The policy file is heavily commented and is intended to provide enough
-documentation for developers to extend it.
-
-\subsubsection{PCI Backend Configuration - Permissive Flag}
-If the user-space quirks approach doesn't meet your needs you may want to
enable
-the permissive flag for that device. To do so, first get the PCI domain, bus,
-slot, and function information from dom0 via \path{lspci}. Then augment the
-user-space policy for permissive devices. The permissive policy can be found
-in:
-
-\centerline{ \path{/etc/xen/xend-pci-permissive.sxp} }
-
-Currently, the only way to reset the permissive flag is to unbind the device
-from the PCI Backend driver.
-
-\subsubsection{PCI Backend - Checking Status}
-There two important sysfs nodes that provide a mechanism to view specifics on
-quirks and permissive devices:
-\begin{description}
-\item \path{/sys/bus/drivers/pciback/permissive} \\
- Use \path{cat} on this file to view a list of permissive slots.
-\item \path{/sys/bus/drivers/pciback/quirks} \\
- Use \path{cat} on this file view a hierarchical view of devices bound to the
-PCI backend, their PCI vendor/device ID, and any quirks that are associated
with
-that particular slot.
-\end{description}
-
-You may notice that every device bound to the PCI backend has 17 quirks
standard
-"quirks" regardless of \path{xend-pci-quirks.sxp}. These default entries are
-necessary to support interactions between the PCI bus manager and the device
bound
-to it. Even non-quirky devices should have these standard entries.
-
-In this case, preference was given to accuracy over aesthetics by choosing to
-show the standard quirks in the quirks list rather than hide them from the
-inquiring user
-
-\subsubsection{PCI Frontend Configuration}
-To configure a domU to receive a PCI device:
-
-\begin{description}
-\item[Command-line:]
- Use the {\em pci} command-line flag. For multiple devices, use the option
- multiple times. \\
-\centerline{ {\tt xm create netcard-dd pci=01:00.0 pci=02:03.0 }} \\
-
-\item[Flat Format configuration file:]
- Specify all of your PCI devices in a python list named {\em pci}. \\
-\centerline{ {\tt pci=['01:00.0','02:03.0'] }} \\
-
-\item[SXP Format configuration file:]
- Use a single PCI device section for all of your devices (specify the numbers
- in hexadecimal with the preceding '0x'). Note that {\em domain} here refers
- to the PCI domain, not a virtual machine within Xen.
-{\small
-\begin{verbatim}
-(device (pci
- (dev (domain 0x0)(bus 0x3)(slot 0x1a)(func 0x1)
- (dev (domain 0x0)(bus 0x1)(slot 0x5)(func 0x0)
-)
-\end{verbatim}
-}
-\end{description}
-
-%% There are two possible types of privileges: IO privileges and
-%% administration privileges.
-
-\section{Support for virtual Trusted Platform Module (vTPM)}
-\label{ss:vtpm}
-
-Paravirtualized domains can be given access to a virtualized version
-of a TPM. This enables applications in these domains to use the services
-of the TPM device for example through a TSS stack
-\footnote{Trousers TSS stack: http://sourceforge.net/projects/trousers}.
-The Xen source repository provides the necessary software components to
-enable virtual TPM access. Support is provided through several
-different pieces. First, a TPM emulator has been modified to provide TPM's
-functionality for the virtual TPM subsystem. Second, a virtual TPM Manager
-coordinates the virtual TPMs efforts, manages their creation, and provides
-protected key storage using the TPM. Third, a device driver pair providing
-a TPM front- and backend is available for XenLinux to deliver TPM commands
-from the domain to the virtual TPM manager, which dispatches it to a
-software TPM. Since the TPM Manager relies on a HW TPM for protected key
-storage, therefore this subsystem requires a Linux-supported hardware TPM.
-For development purposes, a TPM emulator is available for use on non-TPM
-enabled platforms.
-
-\subsubsection{Compile-Time Setup}
-To enable access to the virtual TPM, the virtual TPM backend driver must
-be compiled for a privileged domain (e.g. domain 0). Using the XenLinux
-configuration, the necessary driver can be selected in the Xen configuration
-section. Unless the driver has been compiled into the kernel, its module
-must be activated using the following command:
-
-\begin{verbatim}
-modprobe tpmbk
-\end{verbatim}
-
-Similarly, the TPM frontend driver must be compiled for the kernel trying
-to use TPM functionality. Its driver can be selected in the kernel
-configuration section Device Driver / Character Devices / TPM Devices.
-Along with that the TPM driver for the built-in TPM must be selected.
-If the virtual TPM driver has been compiled as module, it
-must be activated using the following command:
-
-\begin{verbatim}
-modprobe tpm_xenu
-\end{verbatim}
-
-Furthermore, it is necessary to build the virtual TPM manager and software
-TPM by making changes to entries in Xen build configuration files.
-The following entry in the file Config.mk in the Xen root source
-directory must be made:
-
-\begin{verbatim}
-VTPM_TOOLS ?= y
-\end{verbatim}
-
-After a build of the Xen tree and a reboot of the machine, the TPM backend
-drive must be loaded. Once loaded, the virtual TPM manager daemon
-must be started before TPM-enabled guest domains may be launched.
-To enable being the destination of a virtual TPM Migration, the virtual TPM
-migration daemon must also be loaded.
-
-\begin{verbatim}
-vtpm_managerd
-\end{verbatim}
-\begin{verbatim}
-vtpm_migratord
-\end{verbatim}
-
-Once the VTPM manager is running, the VTPM can be accessed by loading the
-front end driver in a guest domain.
-
-\subsubsection{Development and Testing TPM Emulator}
-For development and testing on non-TPM enabled platforms, a TPM emulator
-can be used in replacement of a platform TPM. First, the entry in the file
-tools/vtpm/Rules.mk must look as follows:
-
-\begin{verbatim}
-BUILD_EMULATOR = y
-\end{verbatim}
-
-Second, the entry in the file tool/vtpm\_manager/Rules.mk must be uncommented
-as follows:
-
-\begin{verbatim}
-# TCS talks to fifo's rather than /dev/tpm. TPM Emulator assumed on fifos
-CFLAGS += -DDUMMY_TPM
-\end{verbatim}
-
-Before starting the virtual TPM Manager, start the emulator by executing
-the following in dom0:
-
-\begin{verbatim}
-tpm_emulator clear
-\end{verbatim}
-
-\subsubsection{vTPM Frontend Configuration}
-To provide TPM functionality to a user domain, a line must be added to
-the virtual TPM configuration file using the following format:
-
-\begin{verbatim}
-vtpm = ['instance=<instance number>, backend=<domain id>']
-\end{verbatim}
-
-The { \it instance number} reflects the preferred virtual TPM instance
-to associate with the domain. If the selected instance is
-already associated with another domain, the system will automatically
-select the next available instance. An instance number greater than
-zero must be provided. It is possible to omit the instance
-parameter from the configuration file.
-
-The {\it domain id} provides the ID of the domain where the
-virtual TPM backend driver and virtual TPM are running in. It should
-currently always be set to '0'.
-
-
-Examples for valid vtpm entries in the configuration file are
-
-\begin{verbatim}
- vtpm = ['instance=1, backend=0']
-\end{verbatim}
-and
-\begin{verbatim}
- vtpm = ['backend=0'].
-\end{verbatim}
-
-\subsubsection{Using the virtual TPM}
-
-Access to TPM functionality is provided by the virtual TPM frontend driver.
-Similar to existing hardware TPM drivers, this driver provides basic TPM
-status information through the {\it sysfs} filesystem. In a Xen user domain
-the sysfs entries can be found in /sys/devices/xen/vtpm-0.
-
-Commands can be sent to the virtual TPM instance using the character
-device /dev/tpm0 (major 10, minor 224).
-
-% Chapter Storage and FileSytem Management
-\chapter{Storage and File System Management}
-
-Storage can be made available to virtual machines in a number of
-different ways. This chapter covers some possible configurations.
-
-The most straightforward method is to export a physical block device (a
-hard drive or partition) from dom0 directly to the guest domain as a
-virtual block device (VBD).
-
-Storage may also be exported from a filesystem image or a partitioned
-filesystem image as a \emph{file-backed VBD}.
-
-Finally, standard network storage protocols such as NBD, iSCSI, NFS,
-etc., can be used to provide storage to virtual machines.
-
-
-\section{Exporting Physical Devices as VBDs}
-\label{s:exporting-physical-devices-as-vbds}
-
-One of the simplest configurations is to directly export individual
-partitions from domain~0 to other domains. To achieve this use the
-\path{phy:} specifier in your domain configuration file. For example a
-line like
-\begin{quote}
- \verb_disk = ['phy:hda3,sda1,w']_
-\end{quote}
-specifies that the partition \path{/dev/hda3} in domain~0 should be
-exported read-write to the new domain as \path{/dev/sda1}; one could
-equally well export it as \path{/dev/hda} or \path{/dev/sdb5} should
-one wish.
-
-In addition to local disks and partitions, it is possible to export
-any device that Linux considers to be ``a disk'' in the same manner.
-For example, if you have iSCSI disks or GNBD volumes imported into
-domain~0 you can export these to other domains using the \path{phy:}
-disk syntax. E.g.:
-\begin{quote}
- \verb_disk = ['phy:vg/lvm1,sda2,w']_
-\end{quote}
-
-\begin{center}
- \framebox{\bf Warning: Block device sharing}
-\end{center}
-\begin{quote}
- Block devices should typically only be shared between domains in a
- read-only fashion otherwise the Linux kernel's file systems will get
- very confused as the file system structure may change underneath
- them (having the same ext3 partition mounted \path{rw} twice is a
- sure fire way to cause irreparable damage)! \Xend\ will attempt to
- prevent you from doing this by checking that the device is not
- mounted read-write in domain~0, and hasn't already been exported
- read-write to another domain. If you want read-write sharing,
- export the directory to other domains via NFS from domain~0 (or use
- a cluster file system such as GFS or ocfs2).
-\end{quote}
-
-
-\section{Using File-backed VBDs}
-
-It is also possible to use a file in Domain~0 as the primary storage
-for a virtual machine. As well as being convenient, this also has the
-advantage that the virtual block device will be \emph{sparse} ---
-space will only really be allocated as parts of the file are used. So
-if a virtual machine uses only half of its disk space then the file
-really takes up half of the size allocated.
-
-For example, to create a 2GB sparse file-backed virtual block device
-(actually only consumes no disk space at all):
-\begin{quote}
- \verb_# dd if=/dev/zero of=vm1disk bs=1k seek=2048k count=0_
-\end{quote}
-
-Make a file system in the disk file:
-\begin{quote}
- \verb_# mkfs -t ext3 vm1disk_
-\end{quote}
-
-(when the tool asks for confirmation, answer `y')
-
-Populate the file system e.g.\ by copying from the current root:
-\begin{quote}
-\begin{verbatim}
-# mount -o loop vm1disk /mnt
-# cp -ax /{root,dev,var,etc,usr,bin,sbin,lib} /mnt
-# mkdir /mnt/{proc,sys,home,tmp}
-\end{verbatim}
-\end{quote}
-
-Tailor the file system by editing \path{/etc/fstab},
-\path{/etc/hostname}, etc.\ Don't forget to edit the files in the
-mounted file system, instead of your domain~0 filesystem, e.g.\ you
-would edit \path{/mnt/etc/fstab} instead of \path{/etc/fstab}. For
-this example put \path{/dev/sda1} to root in fstab.
-
-Now unmount (this is important!):
-\begin{quote}
- \verb_# umount /mnt_
-\end{quote}
-
-In the configuration file set:
-\begin{quote}
- \verb_disk = ['tap:aio:/full/path/to/vm1disk,sda1,w']_
-\end{quote}
-
-As the virtual machine writes to its `disk', the sparse file will be
-filled in and consume more space up to the original 2GB.
-
-{\em{Note:}} Users that have worked with file-backed VBDs on Xen in previous
-versions will be interested to know that this support is now provided through
-the blktap driver instead of the loopback driver. This change results in
-file-based block devices that are higher-performance, more scalable, and which
-provide better safety properties for VBD data. All that is required to update
-your existing file-backed VM configurations is to change VBD configuration
-lines from:
-\begin{quote}
- \verb_disk = ['file:/full/path/to/vm1disk,sda1,w']_
-\end{quote}
-to:
-\begin{quote}
- \verb_disk = ['tap:aio:/full/path/to/vm1disk,sda1,w']_
-\end{quote}
-
-
-\subsection{Loopback-mounted file-backed VBDs (deprecated)}
-
-{\em{{\bf{Note:}} Loopback mounted VBDs have now been replaced with
- blktap-based support for raw image files, as described above. This
- section remains to detail a configuration that was used by older Xen
- versions.}}
-
-Raw image file-backed VBDs may also be attached to VMs using the
-Linux loopback driver. The only required change to the raw file
-instructions above are to specify the configuration entry as:
-\begin{quote}
- \verb_disk = ['file:/full/path/to/vm1disk,sda1,w']_
-\end{quote}
-
-{\bf Note that loopback file-backed VBDs may not be appropriate for backing
- I/O-intensive domains.} This approach is known to experience
-substantial slowdowns under heavy I/O workloads, due to the I/O
-handling by the loopback block device used to support file-backed VBDs
-in dom0. Loopback support remains for old Xen installations, and users
-are strongly encouraged to use the blktap-based file support (using
-``{\tt{tap:aio}}'' as described above).
-
-Additionally, Linux supports a maximum of eight loopback file-backed
-VBDs across all domains by default. This limit can be statically
-increased by using the \emph{max\_loop} module parameter if
-CONFIG\_BLK\_DEV\_LOOP is compiled as a module in the dom0 kernel, or
-by using the \emph{max\_loop=n} boot option if CONFIG\_BLK\_DEV\_LOOP
-is compiled directly into the dom0 kernel. Again, users are encouraged
-to use the blktap-based file support described above which scales to much
-larger number of active VBDs.
-
-
-\section{Using LVM-backed VBDs}
-\label{s:using-lvm-backed-vbds}
-
-A particularly appealing solution is to use LVM volumes as backing for
-domain file-systems since this allows dynamic growing/shrinking of
-volumes as well as snapshot and other features.
-
-To initialize a partition to support LVM volumes:
-\begin{quote}
-\begin{verbatim}
-# pvcreate /dev/sda10
-\end{verbatim}
-\end{quote}
-
-Create a volume group named `vg' on the physical partition:
-\begin{quote}
-\begin{verbatim}
-# vgcreate vg /dev/sda10
-\end{verbatim}
-\end{quote}
-
-Create a logical volume of size 4GB named `myvmdisk1':
-\begin{quote}
-\begin{verbatim}
-# lvcreate -L4096M -n myvmdisk1 vg
-\end{verbatim}
-\end{quote}
-
-You should now see that you have a \path{/dev/vg/myvmdisk1} Make a
-filesystem, mount it and populate it, e.g.:
-\begin{quote}
-\begin{verbatim}
-# mkfs -t ext3 /dev/vg/myvmdisk1
-# mount /dev/vg/myvmdisk1 /mnt
-# cp -ax / /mnt
-# umount /mnt
-\end{verbatim}
-\end{quote}
-
-Now configure your VM with the following disk configuration:
-\begin{quote}
-\begin{verbatim}
- disk = [ 'phy:vg/myvmdisk1,sda1,w' ]
-\end{verbatim}
-\end{quote}
-
-LVM enables you to grow the size of logical volumes, but you'll need
-to resize the corresponding file system to make use of the new space.
-Some file systems (e.g.\ ext3) now support online resize. See the LVM
-manuals for more details.
-
-You can also use LVM for creating copy-on-write (CoW) clones of LVM
-volumes (known as writable persistent snapshots in LVM terminology).
-This facility is new in Linux 2.6.8, so isn't as stable as one might
-hope. In particular, using lots of CoW LVM disks consumes a lot of
-dom0 memory, and error conditions such as running out of disk space
-are not handled well. Hopefully this will improve in future.
-
-To create two copy-on-write clones of the above file system you would
-use the following commands:
-
-\begin{quote}
-\begin{verbatim}
-# lvcreate -s -L1024M -n myclonedisk1 /dev/vg/myvmdisk1
-# lvcreate -s -L1024M -n myclonedisk2 /dev/vg/myvmdisk1
-\end{verbatim}
-\end{quote}
-
-Each of these can grow to have 1GB of differences from the master
-volume. You can grow the amount of space for storing the differences
-using the lvextend command, e.g.:
-\begin{quote}
-\begin{verbatim}
-# lvextend +100M /dev/vg/myclonedisk1
-\end{verbatim}
-\end{quote}
-
-Don't let the `differences volume' ever fill up otherwise LVM gets
-rather confused. It may be possible to automate the growing process by
-using \path{dmsetup wait} to spot the volume getting full and then
-issue an \path{lvextend}.
-
-In principle, it is possible to continue writing to the volume that
-has been cloned (the changes will not be visible to the clones), but
-we wouldn't recommend this: have the cloned volume as a `pristine'
-file system install that isn't mounted directly by any of the virtual
-machines.
-
-
-\section{Using NFS Root}
-
-First, populate a root filesystem in a directory on the server
-machine. This can be on a distinct physical machine, or simply run
-within a virtual machine on the same node.
-
-Now configure the NFS server to export this filesystem over the
-network by adding a line to \path{/etc/exports}, for instance:
-
-\begin{quote}
- \begin{small}
-\begin{verbatim}
-/export/vm1root 192.0.2.4/24 (rw,sync,no_root_squash)
-\end{verbatim}
- \end{small}
-\end{quote}
-
-Finally, configure the domain to use NFS root. In addition to the
-normal variables, you should make sure to set the following values in
-the domain's configuration file:
-
-\begin{quote}
- \begin{small}
-\begin{verbatim}
-root = '/dev/nfs'
-nfs_server = '2.3.4.5' # substitute IP address of server
-nfs_root = '/path/to/root' # path to root FS on the server
-\end{verbatim}
- \end{small}
-\end{quote}
-
-The domain will need network access at boot time, so either statically
-configure an IP address using the config variables \path{ip},
-\path{netmask}, \path{gateway}, \path{hostname}; or enable DHCP
-(\path{dhcp='dhcp'}).
-
-Note that the Linux NFS root implementation is known to have stability
-problems under high load (this is not a Xen-specific problem), so this
-configuration may not be appropriate for critical servers.
-
-
-\chapter{CPU Management}
-
-%% KMS Something sage about CPU / processor management.
-
-Xen allows a domain's virtual CPU(s) to be associated with one or more
-host CPUs. This can be used to allocate real resources among one or
-more guests, or to make optimal use of processor resources when
-utilizing dual-core, hyperthreading, or other advanced CPU technologies.
-
-Xen enumerates physical CPUs in a `depth first' fashion. For a system
-with both hyperthreading and multiple cores, this would be all the
-hyperthreads on a given core, then all the cores on a given socket,
-and then all sockets. I.e. if you had a two socket, dual core,
-hyperthreaded Xeon the CPU order would be:
-
-
-\begin{center}
-\begin{tabular}{l|l|l|l|l|l|l|r}
-\multicolumn{4}{c|}{socket0} & \multicolumn{4}{c}{socket1} \\ \hline
-\multicolumn{2}{c|}{core0} & \multicolumn{2}{c|}{core1} &
-\multicolumn{2}{c|}{core0} & \multicolumn{2}{c}{core1} \\ \hline
-ht0 & ht1 & ht0 & ht1 & ht0 & ht1 & ht0 & ht1 \\
-\#0 & \#1 & \#2 & \#3 & \#4 & \#5 & \#6 & \#7 \\
-\end{tabular}
-\end{center}
-
-
-Having multiple vcpus belonging to the same domain mapped to the same
-physical CPU is very likely to lead to poor performance. It's better to
-use `vcpus-set' to hot-unplug one of the vcpus and ensure the others are
-pinned on different CPUs.
-
-If you are running IO intensive tasks, its typically better to dedicate
-either a hyperthread or whole core to running domain 0, and hence pin
-other domains so that they can't use CPU 0. If your workload is mostly
-compute intensive, you may want to pin vcpus such that all physical CPU
-threads are available for guest domains.
-
-\chapter{Migrating Domains}
-
-\section{Domain Save and Restore}
-
-The administrator of a Xen system may suspend a virtual machine's
-current state into a disk file in domain~0, allowing it to be resumed at
-a later time.
-
-For example you can suspend a domain called ``VM1'' to disk using the
-command:
-\begin{verbatim}
-# xm save VM1 VM1.chk
-\end{verbatim}
-
-This will stop the domain named ``VM1'' and save its current state
-into a file called \path{VM1.chk}.
-
-To resume execution of this domain, use the \path{xm restore} command:
-\begin{verbatim}
-# xm restore VM1.chk
-\end{verbatim}
-
-This will restore the state of the domain and resume its execution.
-The domain will carry on as before and the console may be reconnected
-using the \path{xm console} command, as described earlier.
-
-\section{Migration and Live Migration}
-
-Migration is used to transfer a domain between physical hosts. There
-are two varieties: regular and live migration. The former moves a
-virtual machine from one host to another by pausing it, copying its
-memory contents, and then resuming it on the destination. The latter
-performs the same logical functionality but without needing to pause
-the domain for the duration. In general when performing live migration
-the domain continues its usual activities and---from the user's
-perspective---the migration should be imperceptible.
-
-To perform a live migration, both hosts must be running Xen / \xend\ and
-the destination host must have sufficient resources (e.g.\ memory
-capacity) to accommodate the domain after the move. Furthermore we
-currently require both source and destination machines to be on the same
-L2 subnet.
-
-Currently, there is no support for providing automatic remote access
-to filesystems stored on local disk when a domain is migrated.
-Administrators should choose an appropriate storage solution (i.e.\
-SAN, NAS, etc.) to ensure that domain filesystems are also available
-on their destination node. GNBD is a good method for exporting a
-volume from one machine to another. iSCSI can do a similar job, but is
-more complex to set up.
-
-When a domain migrates, it's MAC and IP address move with it, thus it is
-only possible to migrate VMs within the same layer-2 network and IP
-subnet. If the destination node is on a different subnet, the
-administrator would need to manually configure a suitable etherip or IP
-tunnel in the domain~0 of the remote node.
-
-A domain may be migrated using the \path{xm migrate} command. To live
-migrate a domain to another machine, we would use the command:
-
-\begin{verbatim}
-# xm migrate --live mydomain destination.ournetwork.com
-\end{verbatim}
-
-Without the \path{--live} flag, \xend\ simply stops the domain and
-copies the memory image over to the new node and restarts it. Since
-domains can have large allocations this can be quite time consuming,
-even on a Gigabit network. With the \path{--live} flag \xend\ attempts
-to keep the domain running while the migration is in progress, resulting
-in typical down times of just 60--300ms.
-
-For now it will be necessary to reconnect to the domain's console on the
-new machine using the \path{xm console} command. If a migrated domain
-has any open network connections then they will be preserved, so SSH
-connections do not have this limitation.
-
-
-%% Chapter Securing Xen
-\chapter{Securing Xen}
-
-This chapter describes how to secure a Xen system. It describes a number
-of scenarios and provides a corresponding set of best practices. It
-begins with a section devoted to understanding the security implications
-of a Xen system.
-
-
-\section{Xen Security Considerations}
-
-When deploying a Xen system, one must be sure to secure the management
-domain (Domain-0) as much as possible. If the management domain is
-compromised, all other domains are also vulnerable. The following are a
-set of best practices for Domain-0:
-
-\begin{enumerate}
-\item \textbf{Run the smallest number of necessary services.} The less
- things that are present in a management partition, the better.
- Remember, a service running as root in the management domain has full
- access to all other domains on the system.
-\item \textbf{Use a firewall to restrict the traffic to the management
- domain.} A firewall with default-reject rules will help prevent
- attacks on the management domain.
-\item \textbf{Do not allow users to access Domain-0.} The Linux kernel
- has been known to have local-user root exploits. If you allow normal
- users to access Domain-0 (even as unprivileged users) you run the risk
- of a kernel exploit making all of your domains vulnerable.
-\end{enumerate}
-
-\section{Driver Domain Security Considerations}
-\label{s:ddsecurity}
-
-Driver domains address a range of security problems that exist regarding
-the use of device drivers and hardware. On many operating systems in common
-use today, device drivers run within the kernel with the same privileges as
-the kernel. Few or no mechanisms exist to protect the integrity of the kernel
-from a misbehaving (read "buggy") or malicious device driver. Driver
-domains exist to aid in isolating a device driver within its own virtual
-machine where it cannot affect the stability and integrity of other
-domains. If a driver crashes, the driver domain can be restarted rather than
-have the entire machine crash (and restart) with it. Drivers written by
-unknown or untrusted third-parties can be confined to an isolated space.
-Driver domains thus address a number of security and stability issues with
-device drivers.
-
-However, due to limitations in current hardware, a number of security
-concerns remain that need to be considered when setting up driver domains (it
-should be noted that the following list is not intended to be exhaustive).
-
-\begin{enumerate}
-\item \textbf{Without an IOMMU, a hardware device can DMA to memory regions
- outside of its controlling domain.} Architectures which do not have an
- IOMMU (e.g. most x86-based platforms) to restrict DMA usage by hardware
- are vulnerable. A hardware device which can perform arbitrary memory reads
- and writes can read/write outside of the memory of its controlling domain.
- A malicious or misbehaving domain could use a hardware device it controls
- to send data overwriting memory in another domain or to read arbitrary
- regions of memory in another domain.
-\item \textbf{Shared buses are vulnerable to sniffing.} Devices that share
- a data bus can sniff (and possible spoof) each others' data. Device A that
- is assigned to Domain A could eavesdrop on data being transmitted by
- Domain B to Device B and then relay that data back to Domain A.
-\item \textbf{Devices which share interrupt lines can either prevent the
- reception of that interrupt by the driver domain or can trigger the
- interrupt service routine of that guest needlessly.} A devices which shares
- a level-triggered interrupt (e.g. PCI devices) with another device can
- raise an interrupt and never clear it. This effectively blocks other devices
- which share that interrupt line from notifying their controlling driver
- domains that they need to be serviced. A device which shares an
- any type of interrupt line can trigger its interrupt continually which
- forces execution time to be spent (in multiple guests) in the interrupt
- service routine (potentially denying time to other processes within that
- guest). System architectures which allow each device to have its own
- interrupt line (e.g. PCI's Message Signaled Interrupts) are less
- vulnerable to this denial-of-service problem.
-\item \textbf{Devices may share the use of I/O memory address space.} Xen can
- only restrict access to a device's physical I/O resources at a certain
- granularity. For interrupt lines and I/O port address space, that
- granularity is very fine (per interrupt line and per I/O port). However,
- Xen can only restrict access to I/O memory address space on a page size
- basis. If more than one device shares use of a page in I/O memory address
- space, the domains to which those devices are assigned will be able to
- access the I/O memory address space of each other's devices.
-\end{enumerate}
-
-
-\section{Security Scenarios}
-
-
-\subsection{The Isolated Management Network}
-
-In this scenario, each node has two network cards in the cluster. One
-network card is connected to the outside world and one network card is a
-physically isolated management network specifically for Xen instances to
-use.
-
-As long as all of the management partitions are trusted equally, this is
-the most secure scenario. No additional configuration is needed other
-than forcing Xend to bind to the management interface for relocation.
-
-
-\subsection{A Subnet Behind a Firewall}
-
-In this scenario, each node has only one network card but the entire
-cluster sits behind a firewall. This firewall should do at least the
-following:
-
-\begin{enumerate}
-\item Prevent IP spoofing from outside of the subnet.
-\item Prevent access to the relocation port of any of the nodes in the
- cluster except from within the cluster.
-\end{enumerate}
-
-The following iptables rules can be used on each node to prevent
-migrations to that node from outside the subnet assuming the main
-firewall does not do this for you:
-
-\begin{verbatim}
-# this command disables all access to the Xen relocation
-# port:
-iptables -A INPUT -p tcp --destination-port 8002 -j REJECT
-
-# this command enables Xen relocations only from the specific
-# subnet:
-iptables -I INPUT -p tcp -{}-source 192.0.2.0/24 \
- --destination-port 8002 -j ACCEPT
-\end{verbatim}
-
-\subsection{Nodes on an Untrusted Subnet}
-
-Migration on an untrusted subnet is not safe in current versions of Xen.
-It may be possible to perform migrations through a secure tunnel via an
-VPN or SSH. The only safe option in the absence of a secure tunnel is to
-disable migration completely. The easiest way to do this is with
-iptables:
-
-\begin{verbatim}
-# this command disables all access to the Xen relocation port
-iptables -A INPUT -p tcp -{}-destination-port 8002 -j REJECT
-\end{verbatim}
-
-\part{Reference}
-
-%% Chapter Build and Boot Options
-\chapter{Build and Boot Options}
-
-This chapter describes the build- and boot-time options which may be
-used to tailor your Xen system.
-
-\section{Top-level Configuration Options}
-
-Top-level configuration is achieved by editing one of two
-files: \path{Config.mk} and \path{Makefile}.
-
-The former allows the overall build target architecture to be
-specified. You will typically not need to modify this unless
-you are cross-compiling. Additional configuration options are
-documented in the \path{Config.mk} file.
-
-The top-level \path{Makefile} is chiefly used to customize the set of
-kernels built. Look for the line:
-\begin{quote}
-\begin{verbatim}
-KERNELS ?= linux-2.6-xen0 linux-2.6-xenU
-\end{verbatim}
-\end{quote}
-
-Allowable options here are any kernels which have a corresponding
-build configuration file in the \path{buildconfigs/} directory.
-
-
-
-\section{Xen Build Options}
-
-Xen provides a number of build-time options which should be set as
-environment variables or passed on make's command-line.
-
-\begin{description}
-\item[verbose=y] Enable debugging messages when Xen detects an
- unexpected condition. Also enables console output from all domains.
-\item[debug=y] Enable debug assertions. Implies {\bf verbose=y}.
- (Primarily useful for tracing bugs in Xen).
-\item[debugger=y] Enable the in-Xen debugger. This can be used to
- debug Xen, guest OSes, and applications.
-\item[perfc=y] Enable performance counters for significant events
- within Xen. The counts can be reset or displayed on Xen's console
- via console control keys.
-\end{description}
-
-
-\section{Xen Boot Options}
-\label{s:xboot}
-
-These options are used to configure Xen's behaviour at runtime. They
-should be appended to Xen's command line, either manually or by
-editing \path{grub.conf}.
-
-\begin{description}
-\item [ noreboot ] Don't reboot the machine automatically on errors.
- This is useful to catch debug output if you aren't catching console
- messages via the serial line.
-\item [ nosmp ] Disable SMP support. This option is implied by
- `ignorebiostables'.
-\item [ watchdog ] Enable NMI watchdog which can report certain
- failures.
-\item [ noirqbalance ] Disable software IRQ balancing and affinity.
- This can be used on systems such as Dell 1850/2850 that have
- workarounds in hardware for IRQ-routing issues.
-\item [ badpage=$<$page number$>$,$<$page number$>$, \ldots ] Specify
- a list of pages not to be allocated for use because they contain bad
- bytes. For example, if your memory tester says that byte 0x12345678
- is bad, you would place `badpage=0x12345' on Xen's command line.
-\item [ serial\_tx\_buffer=$<$size$>$ ] Size of serial transmit
- buffers. Default is 16kB.
-\item [ com1=$<$baud$>$,DPS,($<$io\_base$>$$|$pci$|$amt),$<$irq$>$
- com2=$<$baud$>$,DPS,($<$io\_base$>$$|$pci$|$amt),$<$irq$>$] \mbox{}\\
- Xen supports up to two 16550-compatible serial ports. For example:
- `com1=9600, 8n1, 0x408, 5' maps COM1 to a 9600-baud port, 8 data
- bits, no parity, 1 stop bit, I/O port base 0x408, IRQ 5. If some
- configuration options are standard (e.g., I/O base and IRQ), then
- only a prefix of the full configuration string need be specified. If
- the baud rate is pre-configured (e.g., by the bootloader) then you
- can specify `auto' in place of a numeric baud rate.
- For PCI serial devices, such as Intel AMT you can use the {\bf amt}
- option to automatically find the I/O base. For PCI serial devices,
- such as NetMos, you can use {\bf pci} to probe for the I/O base.
- Both options will set the IRQ to zero - meaning they will poll the device.
-\item [ console=$<$specifier list$>$ ] Specify the destination for Xen
- console I/O. This is a comma-separated list of, for example:
- \begin{description}
- \item[ vga ] Use VGA console (until domain 0 boots, unless {\bf
- vga=...keep } is specified).
- \item[ com1 ] Use serial port com1.
- \item[ com2H ] Use serial port com2. Transmitted chars will have the
- MSB set. Received chars must have MSB set.
- \item[ com2L] Use serial port com2. Transmitted chars will have the
- MSB cleared. Received chars must have MSB cleared.
- \end{description}
- The latter two examples allow a single port to be shared by two
- subsystems (e.g.\ console and debugger). Sharing is controlled by
- MSB of each transmitted/received character. [NB. Default for this
- option is `com1,vga']
-\item [ vga=$<$mode$>$(,keep) ] The mode is one of the following options:
- \begin{description}
- \item[ ask ] Display a vga menu allowing manual selection of video
- mode.
- \item[ current ] Use existing vga mode without modification.
- \item[ text-$<$mode$>$ ] Select text-mode resolution, where mode is
- one of 80x25, 80x28, 80x30, 80x34, 80x43, 80x50, 80x60.
- \item[ gfx-$<$mode$>$ ] Select VESA graphics mode
- $<$width$>$x$<$height$>$x$<$depth$>$ (e.g., `vga=gfx-1024x768x32').
- \item[ mode-$<$mode$>$ ] Specify a mode number as discovered by `vga
- ask'. Note that the numbers are displayed in hex and hence must be
- prefixed by `0x' here (e.g., `vga=mode-0x0335').
- \end{description}
-The mode may optionally be followed by `{\bf,keep}' to cause Xen to keep
-writing to the VGA console after domain 0 starts booting (e.g.,
`vga=text-80x50,keep').
-\item [ no-real-mode ] (x86 only) Do not execute real-mode bootstrap
- code when booting Xen. This option should not be used except for
- debugging. It will effectively disable the {\bf vga} option, which
- relies on real mode to set the video mode.
-\item [ edid=no,force ] (x86 only) Either force retrieval of monitor
- EDID information via VESA DDC, or disable it (edid=no). This option
- should not normally be required except for debugging purposes.
-\item [ edd=off,on,skipmbr ] (x86 only) Control retrieval of Extended
- Disc Data (EDD) from the BIOS during boot.
-\item [ console\_to\_ring ] Place guest console output into the
- hypervisor console ring buffer. This is disabled by default.
- When enabled, both hypervisor output and guest console output
- is available from the ring buffer. This can be useful for logging
- and/or remote presentation of console data.
-\item [ sync\_console ] Force synchronous console output. This is
- useful if you system fails unexpectedly before it has sent all
- available output to the console. In most cases Xen will
- automatically enter synchronous mode when an exceptional event
- occurs, but this option provides a manual fallback.
-\item [ conswitch=$<$switch-char$><$auto-switch-char$>$ ] Specify how
- to switch serial-console input between Xen and DOM0. The required
- sequence is CTRL-$<$switch-char$>$ pressed three times. Specifying
- the backtick character disables switching. The
- $<$auto-switch-char$>$ specifies whether Xen should auto-switch
- input to DOM0 when it boots --- if it is `x' then auto-switching is
- disabled. Any other value, or omitting the character, enables
- auto-switching. [NB. Default switch-char is `a'.]
-\item [ loglvl=$<$level$>/<$level$>$ ]
- Specify logging level. Messages of the specified severity level (and
- higher) will be printed to the Xen console. Valid levels are `none',
- `error', `warning', `info', `debug', and `all'. The second level
- specifier is optional: it is used to specify message severities
- which are to be rate limited. Default is `loglvl=warning'.
-\item [ guest\_loglvl=$<$level$>/<$level$>$ ] As for loglvl, but
- applies to messages relating to guests. Default is
- `guest\_loglvl=none/warning'.
-\item [ console\_timestamps ]
- Adds a timestamp prefix to each line of Xen console output.
-\item [ nmi=xxx ]
- Specify what to do with an NMI parity or I/O error. \\
- `nmi=fatal': Xen prints a diagnostic and then hangs. \\
- `nmi=dom0': Inform DOM0 of the NMI. \\
- `nmi=ignore': Ignore the NMI.
-\item [ mem=xxx ] Set the physical RAM address limit. Any RAM
- appearing beyond this physical address in the memory map will be
- ignored. This parameter may be specified with a B, K, M or G suffix,
- representing bytes, kilobytes, megabytes and gigabytes respectively.
- The default unit, if no suffix is specified, is kilobytes.
-\item [ dom0\_mem=$<$specifier list$>$ ] Set the amount of memory to
- be allocated to domain 0. This is a comma-separated list containing
- the following optional components:
- \begin{description}
- \item[ min:$<$min\_amt$>$ ] Minimum amount to allocate to domain 0
- \item[ max:$<$min\_amt$>$ ] Maximum amount to allocate to domain 0
- \item[ $<$amt$>$ ] Precise amount to allocate to domain 0
- \end{description}
- Each numeric parameter may be specified with a B, K, M or
- G suffix, representing bytes, kilobytes, megabytes and gigabytes
- respectively; if no suffix is specified, the parameter defaults to
- kilobytes. Negative values are subtracted from total available
- memory. If $<$amt$>$ is not specified, it defaults to all available
- memory less a small amount (clamped to 128MB) for uses such as DMA
- buffers.
-\item [ dom0\_vcpus\_pin ] Pins domain 0 VCPUs on their respective
- physical CPUS (default=false).
-\item [ tbuf\_size=xxx ] Set the size of the per-cpu trace buffers, in
- pages (default 0).
-\item [ sched=xxx ] Select the CPU scheduler Xen should use. The
- current possibilities are `credit' (default), and `sedf'.
-\item [ apic\_verbosity=debug,verbose ] Print more detailed
- information about local APIC and IOAPIC configuration.
-\item [ lapic ] Force use of local APIC even when left disabled by
- uniprocessor BIOS.
-\item [ nolapic ] Ignore local APIC in a uniprocessor system, even if
- enabled by the BIOS.
-\item [ apic=bigsmp,default,es7000,summit ] Specify NUMA platform.
- This can usually be probed automatically.
-\item [ dma\_bits=xxx ] Specify width of DMA addresses in bits. This
- is used in NUMA systems to prevent this special DMA memory from
- being exhausted in one node when remote nodes have available memory.
-\item [ vcpu\_migration\_delay=$<$minimum\_time$>$] Set minimum time of
- vcpu migration in microseconds (default 0). This parameter avoids agressive
- vcpu migration. For example, the linux kernel uses 0.5ms by default.
-\item [ irq\_vector\_map=xxx ] Enable irq vector non-sharing maps. Setting
'global'
- will ensure that no IRQs will share vectors. Setting 'per-device' will
ensure
- that no IRQs from the same device will share vectors. Setting to 'none' will
- disable it entirely, overriding any defaults the IOMMU code may set.
-\end{description}
-
-In addition, the following options may be specified on the Xen command
-line. Since domain 0 shares responsibility for booting the platform,
-Xen will automatically propagate these options to its command line.
-These options are taken from Linux's command-line syntax with
-unchanged semantics.
-
-\begin{description}
-\item [ acpi=off,force,strict,ht,noirq,\ldots ] Modify how Xen (and
- domain 0) parses the BIOS ACPI tables.
-\item [ acpi\_skip\_timer\_override ] Instruct Xen (and domain~0) to
- ignore timer-interrupt override instructions specified by the BIOS
- ACPI tables.
-\item [ noapic ] Instruct Xen (and domain~0) to ignore any IOAPICs
- that are present in the system, and instead continue to use the
- legacy PIC.
-\end{description}
-
-
-\section{XenLinux Boot Options}
-
-In addition to the standard Linux kernel boot options, we support:
-\begin{description}
-\item[ xencons=xxx ] Specify the device node to which the Xen virtual
- console driver is attached. The following options are supported:
- \begin{center}
- \begin{tabular}{l}
- `xencons=off': disable virtual console \\
- `xencons=tty': attach console to /dev/tty1 (tty0 at boot-time) \\
- `xencons=ttyS': attach console to /dev/ttyS0 \\
- `xencons=xvc': attach console to /dev/xvc0
- \end{tabular}
-\end{center}
-The default is ttyS for dom0 and xvc for all other domains.
-\end{description}
-
-
-%% Chapter Further Support
-\chapter{Further Support}
-
-If you have questions that are not answered by this manual, the
-sources of information listed below may be of interest to you. Note
-that bug reports, suggestions and contributions related to the
-software (or the documentation) should be sent to the Xen developers'
-mailing list (address below).
-
-
-\section{Other Documentation}
-
-For developers interested in porting operating systems to Xen, the
-\emph{Xen Interface Manual} is distributed in the \path{docs/}
-directory of the Xen source distribution.
-
-
-\section{Online References}
-
-The official Xen web site can be found at:
-\begin{quote} {\tt http://www.xen.org}
-\end{quote}
-
-This contains links to the latest versions of all online
-documentation, including the latest version of the FAQ.
-
-Information regarding Xen is also available at the Xen Wiki at
-\begin{quote} {\tt http://wiki.xen.org/wiki/}\end{quote}
-The Xen project uses Bugzilla as its bug tracking system. You'll find
-the Xen Bugzilla at http://bugzilla.xensource.com/bugzilla/.
-
-
-\section{Mailing Lists}
-
-There are several mailing lists that are used to discuss Xen related
-topics. The most widely relevant are listed below. An official page of
-mailing lists and subscription information can be found at \begin{quote}
- {\tt http://lists.xensource.com/} \end{quote}
-
-\begin{description}
-\item[xen-devel@xxxxxxxxxxxxxxxxxxx] Used for development
- discussions and bug reports. Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-devel}}
-\item[xen-users@xxxxxxxxxxxxxxxxxxx] Used for installation and usage
- discussions and requests for help. Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-users}}
-\item[xen-announce@xxxxxxxxxxxxxxxxxxx] Used for announcements only.
- Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-announce}}
-\item[xen-changelog@xxxxxxxxxxxxxxxxxxx] Changelog feed
- from the unstable and 3.x trees - developer oriented. Subscribe at: \\
- {\small {\tt http://lists.xensource.com/xen-changelog}}
-\end{description}
-
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\appendix
-
-\chapter{Unmodified (HVM) guest domains in Xen with Hardware support for
Virtualization}
-
-Xen supports guest domains running unmodified guest operating systems using
-virtualization extensions available on recent processors. Currently processors
-featuring the Intel Virtualization Extension (Intel-VT) or the AMD extension
-(AMD-V) are supported. The technology covering both implementations is
-called HVM (for Hardware Virtual Machine) in Xen. More information about the
-virtualization extensions are available on the respective websites:
- {\small {\tt http://www.intel.com/technology/computing/vptech}}
-
-
- {\small {\tt
http://www.amd.com/us-en/assets/content\_type/white\_papers\_and\_tech\_docs/24593.pdf}}
-
-\section{Building Xen with HVM support}
-
-The following packages need to be installed in order to build Xen with HVM
support. Some Linux distributions do not provide these packages by default.
-
-\begin{tabular}{lp{11.0cm}}
-{\bfseries Package} & {\bfseries Description} \\
-
-dev86 & The dev86 package provides an assembler and linker for real mode 80x86
instructions. You need to have this package installed in order to build the
BIOS code which runs in (virtual) real mode.
-
-If the dev86 package is not available on the x86\_64 distribution, you can
install the i386 version of it. The dev86 rpm package for various distributions
can be found at {\scriptsize {\tt
http://www.rpmfind.net/linux/rpm2html/search.php?query=dev86\&submit=Search}} \\
-
-SDL-devel, SDL & Simple DirectMedia Layer (SDL) is another way of virtualizing
the unmodified guest console. It provides an X window for the guest console.
-
-If the SDL and SDL-devel packages are not installed by default on the build
system, they can be obtained from {\scriptsize {\tt
http://www.rpmfind.net/linux/rpm2html/search.php?query=SDL\&submit=Search}}
-
-
-{\scriptsize {\tt
http://www.rpmfind.net/linux/rpm2html/search.php?query=SDL-devel\&submit=Search}}
\\
-
-\end{tabular}
-
-\section{Configuration file for unmodified HVM guests}
-
-The Xen installation includes a sample configuration file, {\small {\tt
/etc/xen/xmexample.hvm}}. There are comments describing all the options. In
addition to the common options that are the same as those for paravirtualized
guest configurations, HVM guest configurations have the following settings:
-
-\begin{tabular}{lp{11.0cm}}
-
-{\bfseries Parameter} & {\bfseries Description} \\
-
-kernel & The HVM firmware loader, {\small {\tt
/usr/lib/xen/boot/hvmloader}}\\
-
-builder & The domain build function. The HVM domain uses the 'hvm'
builder.\\
-
-acpi & Enable HVM guest ACPI, default=1 (enabled)\\
-
-apic & Enable HVM guest APIC, default=1 (enabled)\\
-
-pae & Enable HVM guest PAE, default=1 (enabled)\\
-
-hap & Enable hardware-assisted paging support, such as AMD-V's nested paging
-or Intel\textregistered VT's extended paging. If available, Xen will
-use hardware-assisted paging instead of shadow paging for this guest's memory
-management.\\
-
-vif & Optionally defines MAC address and/or bridge for the network
interfaces. Random MACs are assigned if not given. {\small {\tt type=ioemu}}
means ioemu is used to virtualize the HVM NIC. If no type is specified, vbd is
used, as with paravirtualized guests.\\
-
-disk & Defines the disk devices you want the domain to have access to, and
what you want them accessible as. If using a physical device as the HVM guest's
disk, each disk entry is of the form
-
-{\small {\tt phy:UNAME,ioemu:DEV,MODE,}}
-
-where UNAME is the host device file, DEV is the device name the domain will
see, and MODE is r for read-only, w for read-write. ioemu means the disk will
use ioemu to virtualize the HVM disk. If not adding ioemu, it uses vbd like
paravirtualized guests.
-
-If using disk image file, its form should be like
-
-{\small {\tt file:FILEPATH,ioemu:DEV,MODE}}
-
-Optical devices can be emulated by appending cdrom to the device type
-
-{\small {\tt ',hdc:cdrom,r'}}
-
-If using more than one disk, there should be a comma between each disk entry.
For example:
-
-{\scriptsize {\tt disk = ['file:/var/images/image1.img,ioemu:hda,w',
'phy:hda1,hdb1,w', 'file:/var/images/install1.iso,hdc:cdrom,r']}}\\
-
-boot & Boot from floppy (a), hard disk (c) or CD-ROM (d). For example, to boot
from CD-ROM and fallback to HD, the entry should be:
-
-boot='dc'\\
-
-device\_model & The device emulation tool for HVM guests. This parameter
should not be changed.\\
-
-sdl & Enable SDL library for graphics, default = 0 (disabled)\\
-
-vnc & Enable VNC library for graphics, default = 1 (enabled)\\
-
-vncconsole & Enable spawning of the vncviewer (only valid when vnc=1),
default = 0 (disabled)
-
-If vnc=1 and vncconsole=0, user can use vncviewer to manually connect HVM from
remote. For example:
-
-{\small {\tt vncviewer domain0\_IP\_address:HVM\_domain\_id}} \\
-
-serial & Enable redirection of HVM serial output to pty device\\
-
-\end{tabular}
-
-\begin{tabular}{lp{10cm}}
-
-usb & Enable USB support without defining a specific USB device.
-This option defaults to 0 (disabled) unless the option usbdevice is
-specified in which case this option then defaults to 1 (enabled).\\
-
-usbdevice & Enable USB support and also enable support for the given
-device. Devices that can be specified are {\small {\tt mouse}} (a PS/2 style
-mouse), {\small {\tt tablet}} (an absolute pointing device) and
-{\small {\tt host:id1:id2}} (a physical USB device on the host machine whose
-ids are {\small {\tt id1}} and {\small {\tt id2}}). The advantage
-of {\small {\tt tablet}} is that Windows guests will automatically recognize
-and support this device so specifying the config line
-
-{\small
-\begin{verbatim}
- usbdevice='tablet'
-\end{verbatim}
-}
-
-will create a mouse that works transparently with Windows guests under VNC.
-Linux doesn't recognize the USB tablet yet so Linux guests under VNC will
-still need the Summagraphics emulation.
-Details about mouse emulation are provided in section \textbf{A.4.3}.\\
-
-localtime & Set the real time clock to local time [default=0, that is, set
to UTC].\\
-
-soundhw & Enable sound card support and specify the hardware to emulate.
Values can be sb16, es1370 or all. Default is none.\\
-
-full-screen & Start in full screen.\\
-
-nographic & Another way to redirect serial output. If enabled, no 'sdl' or
'vnc' can work. Not recommended.\\
-
-\end{tabular}
-
-
-\section{Creating virtual disks from scratch}
-\subsection{Using physical disks}
-If you are using a physical disk or physical disk partition, you need to
install a Linux OS on the disk first. Then the boot loader should be installed
in the correct place. For example {\small {\tt dev/sda}} for booting from the
whole disk, or {\small {\tt /dev/sda1}} for booting from partition 1.
-
-\subsection{Using disk image files}
-You need to create a large empty disk image file first; then, you need to
install a Linux OS onto it. There are two methods you can choose. One is
directly installing it using a HVM guest while booting from the OS installation
CD-ROM. The other is copying an installed OS into it. The boot loader will also
need to be installed.
-
-\subsubsection*{To create the image file:}
-The image size should be big enough to accommodate the entire OS. This example
assumes the size is 1G (which is probably too small for most OSes).
-
-{\small {\tt \# dd if=/dev/zero of=hd.img bs=1M count=0 seek=1024}}
-
-\subsubsection*{To directly install Linux OS into an image file using a HVM
guest:}
-
-Install Xen and create HVM with the original image file with booting from
CD-ROM. Then it is just like a normal Linux OS installation. The HVM
configuration file should have a stanza for the CD-ROM as well as a boot device
specification:
-
-{\small {\tt disk=['file:/var/images/your-hd.img,hda,w', ',hdc:cdrom,r' ]
-boot='d'}}
-
-If this method does not succeed, you can choose the following method of
copying an installed Linux OS into an image file.
-
-\subsubsection*{To copy a installed OS into an image file:}
-Directly installing is an easier way to make partitions and install an OS in a
disk image file. But if you want to create a specific OS in your disk image,
then you will most likely want to use this method.
-
-\begin{enumerate}
-\item {\bfseries Install a normal Linux OS on the host machine}\\
-You can choose any way to install Linux, such as using yum to install Red Hat
Linux or YAST to install Novell SuSE Linux. The rest of this example assumes
the Linux OS is installed in {\small {\tt /var/guestos/}}.
-
-\item {\bfseries Make the partition table}\\
-The image file will be treated as hard disk, so you should make the partition
table in the image file. For example:
-
-{\scriptsize {\tt \# losetup /dev/loop0 hd.img\\
-\# fdisk -b 512 -C 4096 -H 16 -S 32 /dev/loop0\\
-press 'n' to add new partition\\
-press 'p' to choose primary partition\\
-press '1' to set partition number\\
-press "Enter" keys to choose default value of "First Cylinder" parameter.\\
-press "Enter" keys to choose default value of "Last Cylinder" parameter.\\
-press 'w' to write partition table and exit\\
-\# losetup -d /dev/loop0}}
-
-\item {\bfseries Make the file system and install grub}\\
-{\scriptsize {\tt \# ln -s /dev/loop0 /dev/loop\\
-\# losetup /dev/loop0 hd.img\\
-\# losetup -o 16384 /dev/loop1 hd.img\\
-\# mkfs.ext3 /dev/loop1\\
-\# mount /dev/loop1 /mnt\\
-\# mkdir -p /mnt/boot/grub\\
-\# cp /boot/grub/stage* /boot/grub/e2fs\_stage1\_5 /mnt/boot/grub\\
-\# umount /mnt\\
-\# grub\\
-grub> device (hd0) /dev/loop\\
-grub> root (hd0,0)\\
-grub> setup (hd0)\\
-grub> quit\\
-\# rm /dev/loop\\
-\# losetup -d /dev/loop0\\
-\# losetup -d /dev/loop1}}
-
-The {\small {\tt losetup}} option {\small {\tt -o 16384}} skips the partition
table in the image file. It is the number of sectors times 512. We need {\small
{\tt /dev/loop}} because grub is expecting a disk device \emph{name}, where
\emph{name} represents the entire disk and \emph{name1} represents the first
partition.
-
-\item {\bfseries Copy the OS files to the image}\\
-If you have Xen installed, you can easily use {\small {\tt lomount}} instead
of {\small {\tt losetup}} and {\small {\tt mount}} when coping files to some
partitions. {\small {\tt lomount}} just needs the partition information.
-
-{\scriptsize {\tt \# lomount -t ext3 -diskimage hd.img -partition 1
/mnt/guest\\
-\# cp -ax /var/guestos/\{root,dev,var,etc,usr,bin,sbin,lib\} /mnt/guest\\
-\# mkdir /mnt/guest/\{proc,sys,home,tmp\}}}
-
-\item {\bfseries Edit the {\small {\tt /etc/fstab}} of the guest image}\\
-The fstab should look like this:
-
-{\scriptsize {\tt \# vim /mnt/guest/etc/fstab\\
-/dev/hda1 / ext3 defaults 1 1\\
-none /dev/pts devpts gid=5,mode=620 0 0\\
-none /dev/shm tmpfs defaults 0 0\\
-none /proc proc defaults 0 0\\
-none /sys sysfs efaults 0 0}}
-
-\item {\bfseries umount the image file}\\
-{\small {\tt \# umount /mnt/guest}}
-\end{enumerate}
-
-Now, the guest OS image {\small {\tt hd.img}} is ready. You can also reference
{\small {\tt http://free.oszoo.org}} for quickstart images. But make sure to
install the boot loader.
-
-\section{HVM Guests}
-\subsection{Editing the Xen HVM config file}
-Make a copy of the example HVM configuration file {\small {\tt
/etc/xen/xmexample.hvm}} and edit the line that reads
-
-{\small {\tt disk = [ 'file:/var/images/\emph{min-el3-i386.img},hda,w' ]}}
-
-replacing \emph{min-el3-i386.img} with the name of the guest OS image file you
just made.
-
-\subsection{Creating HVM guests}
-Simply follow the usual method of creating the guest, providing the filename
of your HVM configuration file:\\
-
-{\small {\tt \# xend start\\
-\# xm create /etc/xen/hvmguest.hvm}}
-
-In the default configuration, VNC is on and SDL is off. Therefore VNC windows
will open when HVM guests are created. If you want to use SDL to create HVM
guests, set {\small {\tt sdl=1}} in your HVM configuration file. You can also
turn off VNC by setting {\small {\tt vnc=0}}.
-
-\subsection{Mouse issues, especially under VNC}
-Mouse handling when using VNC is a little problematic.
-The problem is that the VNC viewer provides a virtual pointer which is
-located at an absolute location in the VNC window and only absolute
-coordinates are provided.
-The HVM device model converts these absolute mouse coordinates
-into the relative motion deltas that are expected by the PS/2
-mouse driver running in the guest.
-Unfortunately,
-it is impossible to keep these generated mouse deltas
-accurate enough for the guest cursor to exactly match
-the VNC pointer.
-This can lead to situations where the guest's cursor
-is in the center of the screen and there's no way to
-move that cursor to the left
-(it can happen that the VNC pointer is at the left
-edge of the screen and,
-therefore,
-there are no longer any left mouse deltas that
-can be provided by the device model emulation code.)
-
-To deal with these mouse issues there are 4 different
-mouse emulations available from the HVM device model:
-
-\begin{description}
-\item[PS/2 mouse over the PS/2 port.]
-This is the default mouse
-that works perfectly well under SDL.
-Under VNC the guest cursor will get
-out of sync with the VNC pointer.
-When this happens you can re-synchronize
-the guest cursor to the VNC pointer by
-holding down the
-\textbf{left-ctl}
-and
-\textbf{left-alt}
-keys together.
-While these keys are down VNC pointer motions
-will not be reported to the guest so
-that the VNC pointer can be moved
-to a place where it is possible
-to move the guest cursor again.
-
-\item[Summagraphics mouse over the serial port.]
-The device model also provides emulation
-for a Summagraphics tablet,
-an absolute pointer device.
-This emulation is provided over the second
-serial port,
-\textbf{/dev/ttyS1}
-for Linux guests and
-\textbf{COM2}
-for Windows guests.
-Unfortunately,
-neither Linux nor Windows provides
-default support for the Summagraphics
-tablet so the guest will have to be
-manually configured for this mouse.
-
-\textbf{Linux configuration.}
-
-First,
-configure the GPM service to use the Summagraphics tablet.
-This can vary between distributions but,
-typically,
-all that needs to be done is modify the file
-\path{/etc/sysconfig/mouse} to contain the lines:
-
-{\small
-\begin{verbatim}
- MOUSETYPE="summa"
- XMOUSETYPE="SUMMA"
- DEVICE=/dev/ttyS1
-\end{verbatim}
-}
-
-and then restart the GPM daemon.
-
-Next,
-modify the X11 config
-\path{/etc/X11/xorg.conf}
-to support the Summgraphics tablet by replacing
-the input device stanza with the following:
-
-{\small
-\begin{verbatim}
- Section "InputDevice"
- Identifier "Mouse0"
- Driver "summa"
- Option "Device" "/dev/ttyS1"
- Option "InputFashion" "Tablet"
- Option "Mode" "Absolute"
- Option "Name" "EasyPen"
- Option "Compatible" "True"
- Option "Protocol" "Auto"
- Option "SendCoreEvents" "on"
- Option "Vendor" "GENIUS"
- EndSection
-\end{verbatim}
-}
-
-Restart X and the X cursor should now properly
-track the VNC pointer.
-
-
-\textbf{Windows configuration.}
-
-Get the file
-\path{http://www.cad-plan.de/files/download/tw2k.exe}
-and execute that file on the guest,
-answering the questions as follows:
-
-\begin{enumerate}
-\item When the program asks for \textbf{model},
-scroll down and select \textbf{SummaSketch (MM Compatible)}.
-
-\item When the program asks for \textbf{COM Port} specify \textbf{com2}.
-
-\item When the programs asks for a \textbf{Cursor Type} specify
-\textbf{4 button cursor/puck}.
-
-\item The guest system will then reboot and,
-when it comes back up,
-the guest cursor will now properly track
-the VNC pointer.
-\end{enumerate}
-
-\item[PS/2 mouse over USB port.]
-This is just the same PS/2 emulation except it is
-provided over a USB port.
-This emulation is enabled by the configuration flag:
-{\small
-\begin{verbatim}
- usbdevice='mouse'
-\end{verbatim}
-}
-
-\item[USB tablet over USB port.]
-The USB tablet is an absolute pointing device
-that has the advantage that it is automatically
-supported under Windows guests,
-although Linux guests still require some
-manual configuration.
-This mouse emulation is enabled by the
-configuration flag:
-{\small
-\begin{verbatim}
- usbdevice='tablet'
-\end{verbatim}
-}
-
-\textbf{Linux configuration.}
-
-Unfortunately,
-there is no GPM support for the
-USB tablet at this point in time.
-If you intend to use a GPM pointing
-device under VNC you should
-configure the guest for Summagraphics
-emulation.
-
-Support for X11 is available by following
-the instructions at\\
-\verb+http://stz-softwaretechnik.com/~ke/touchscreen/evtouch.html+\\
-with one minor change.
-The
-\path{xorg.conf}
-given in those instructions
-uses the wrong values for the X \& Y minimums and maximums,
-use the following config stanza instead:
-
-{\small
-\begin{verbatim}
- Section "InputDevice"
- Identifier "Tablet"
- Driver "evtouch"
- Option "Device" "/dev/input/event2"
- Option "DeviceName" "touchscreen"
- Option "MinX" "0"
- Option "MinY" "0"
- Option "MaxX" "32256"
- Option "MaxY" "32256"
- Option "ReportingMode" "Raw"
- Option "Emulate3Buttons"
- Option "Emulate3Timeout" "50"
- Option "SendCoreEvents" "On"
- EndSection
-\end{verbatim}
-}
-
-\textbf{Windows configuration.}
-
-Just enabling the USB tablet in the
-guest's configuration file is sufficient,
-Windows will automatically recognize and
-configure device drivers for this
-pointing device.
-
-\end{description}
-
-\subsection{USB Support}
-There is support for an emulated USB mouse,
-an emulated USB tablet
-and physical low speed USB devices
-(support for high speed USB 2.0 devices is
-still under development).
-
-\begin{description}
-\item[USB PS/2 style mouse.]
-Details on the USB mouse emulation are
-given in sections
-\textbf{A.2}
-and
-\textbf{A.4.3}.
-Enabling USB PS/2 style mouse emulation
-is just a matter of adding the line
-
-{\small
-\begin{verbatim}
- usbdevice='mouse'
-\end{verbatim}
-}
-
-to the configuration file.
-\item[USB tablet.]
-Details on the USB tablet emulation are
-given in sections
-\textbf{A.2}
-and
-\textbf{A.4.3}.
-Enabling USB tablet emulation
-is just a matter of adding the line
-
-{\small
-\begin{verbatim}
- usbdevice='tablet'
-\end{verbatim}
-}
-
-to the configuration file.
-\item[USB physical devices.]
-Access to a physical (low speed) USB device
-is enabled by adding a line of the form
-
-{\small
-\begin{verbatim}
- usbdevice='host:vid:pid'
-\end{verbatim}
-}
-
-into the the configuration file.\footnote{
-There is an alternate
-way of specifying a USB device that
-uses the syntax
-\textbf{host:bus.addr}
-but this syntax suffers from
-a major problem that makes
-it effectively useless.
-The problem is that the
-\textbf{addr}
-portion of this address
-changes every time the USB device
-is plugged into the system.
-For this reason this addressing
-scheme is not recommended and
-will not be documented further.
-}
-\textbf{vid}
-and
-\textbf{pid}
-are a
-product id and
-vendor id
-that uniquely identify
-the USB device.
-These ids can be identified
-in two ways:
-
-\begin{enumerate}
-\item Through the control window.
-As described in section
-\textbf{A.4.6}
-the control window
-is activated by pressing
-\textbf{ctl-alt-2}
-in the guest VGA window.
-As long as USB support is
-enabled in the guest by including
-the config file line
-{\small
-\begin{verbatim}
- usb=1
-\end{verbatim}
-}
-then executing the command
-{\small
-\begin{verbatim}
- info usbhost
-\end{verbatim}
-}
-in the control window
-will display a list of all
-usb devices and their ids.
-For example,
-this output:
-{\small
-\begin{verbatim}
- Device 1.3, speed 1.5 Mb/s
- Class 00: USB device 04b3:310b
-\end{verbatim}
-}
-was created from a USB mouse with
-vendor id
-\textbf{04b3}
-and product id
-\textbf{310b}.
-This device could be made available
-to the HVM guest by including the
-config file entry
-{\small
-\begin{verbatim}
- usbdevice='host:04be:310b'
-\end{verbatim}
-}
-
-It is also possible to
-enable access to a USB
-device dynamically through
-the control window.
-The control window command
-{\small
-\begin{verbatim}
- usb_add host:vid:pid
-\end{verbatim}
-}
-will also allow access to a
-USB device with vendor id
-\textbf{vid}
-and product id
-\textbf{pid}.
-\item Through the
-\path{/proc} file system.
-The contents of the pseudo file
-\path{/proc/bus/usb/devices}
-can also be used to identify
-vendor and product ids.
-Looking at this file,
-the line starting with
-\textbf{P:}
-has a field
-\textbf{Vendor}
-giving the vendor id and
-another field
-\textbf{ProdID}
-giving the product id.
-The contents of
-\path{/proc/bus/usb/devices}
-for the example mouse is as
-follows:
-{\small
-\begin{verbatim}
-T: Bus=01 Lev=01 Prnt=01 Port=01 Cnt=02 Dev#= 3 Spd=1.5 MxCh= 0
-D: Ver= 2.00 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1
-P: Vendor=04b3 ProdID=310b Rev= 1.60
-C:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr=100mA
-I: If#= 0 Alt= 0 #EPs= 1 Cls=03(HID ) Sub=01 Prot=02 Driver=(none)
-E: Ad=81(I) Atr=03(Int.) MxPS= 4 Ivl=10ms
-\end{verbatim}
-}
-Note that the
-\textbf{P:}
-line correctly identifies the
-vendor id and product id
-for this mouse as
-\textbf{04b3:310b}.
-\end{enumerate}
-There is one other issue to
-be aware of when accessing a
-physical USB device from the guest.
-The Dom0 kernel must not have
-a device driver loaded for
-the device that the guest wishes
-to access.
-This means that the Dom0
-kernel must not have that
-device driver compiled into
-the kernel or,
-if using modules,
-that driver module must
-not be loaded.
-Note that this is the device
-specific USB driver that must
-not be loaded,
-either the
-\textbf{UHCI}
-or
-\textbf{OHCI}
-USB controller driver must
-still be loaded.
-
-Going back to the USB mouse
-as an example,
-if \textbf{lsmod}
-gives the output:
-
-{\small
-\begin{verbatim}
-Module Size Used by
-usbmouse 4128 0
-usbhid 28996 0
-uhci_hcd 35409 0
-\end{verbatim}
-}
-
-then the USB mouse is being
-used by the Dom0 kernel and is
-not available to the guest.
-Executing the command
-\textbf{rmmod usbhid}\footnote{
-Turns out the
-\textbf{usbhid}
-driver is the significant
-one for the USB mouse,
-the presence or absence of
-the module
-\textbf{usbmouse}
-has no effect on whether or
-not the guest can see a USB mouse.}
-will remove the USB mouse
-driver from the Dom0 kernel
-and the mouse will now be
-accessible by the HVM guest.
-
-Be aware the the Linux USB
-hotplug system will reload
-the drivers if a USB device
-is removed and plugged back
-in.
-This means that just unloading
-the driver module might not
-be sufficient if the USB device
-is removed and added back.
-A more reliable technique is
-to first
-\textbf{rmmod}
-the driver and then rename the
-driver file in the
-\path{/lib/modules}
-directory,
-just to make sure it doesn't get
-reloaded.
-\end{description}
-
-\subsection{Destroy HVM guests}
-HVM guests can be destroyed in the same way as can paravirtualized guests. We
recommend that you shut-down the guest using the guest OS' provided method, for
Linux, type the command
-
-{\small {\tt poweroff}}
-
-in the HVM guest's console, for Windows use Start -> Shutdown first to prevent
-data loss. Depending on the configuration the guest will be automatically
-destroyed, otherwise execute the command
-
-{\small {\tt xm destroy \emph{vmx\_guest\_id} }}
-
-at the Domain0 console.
-
-\subsection{HVM window (X or VNC) Hot Key}
-If you are running in the X environment after creating a HVM guest, an X
window is created. There are several hot keys for control of the HVM guest that
can be used in the window.
-
-{\bfseries Ctrl+Alt+2} switches from guest VGA window to the control window.
Typing {\small {\tt help }} shows the control commands help. For example, 'q'
is the command to destroy the HVM guest.\\
-{\bfseries Ctrl+Alt+1} switches back to HVM guest's VGA.\\
-{\bfseries Ctrl+Alt+3} switches to serial port output. It captures serial
output from the HVM guest. It works only if the HVM guest was configured to use
the serial port. \\
-
-
-%% Chapter Glossary of Terms moved to glossary.tex
-\chapter{Glossary of Terms}
-
-\begin{description}
-
-\item[Domain] A domain is the execution context that contains a
- running {\bf virtual machine}. The relationship between virtual
- machines and domains on Xen is similar to that between programs and
- processes in an operating system: a virtual machine is a persistent
- entity that resides on disk (somewhat like a program). When it is
- loaded for execution, it runs in a domain. Each domain has a {\bf
- domain ID}.
-
-\item[Domain 0] The first domain to be started on a Xen machine.
- Domain 0 is responsible for managing the system.
-
-\item[Domain ID] A unique identifier for a {\bf domain}, analogous to
- a process ID in an operating system.
-
-\item[Full virtualization] An approach to virtualization which
- requires no modifications to the hosted operating system, providing
- the illusion of a complete system of real hardware devices.
-
-\item[Hypervisor] An alternative term for {\bf VMM}, used because it
- means `beyond supervisor', since it is responsible for managing
- multiple `supervisor' kernels.
-
-\item[Live migration] A technique for moving a running virtual machine
- to another physical host, without stopping it or the services
- running on it.
-
-\item[Paravirtualization] An approach to virtualization which requires
- modifications to the operating system in order to run in a virtual
- machine. Xen uses paravirtualization but preserves binary
- compatibility for user space applications.
-
-\item[Shadow pagetables] A technique for hiding the layout of machine
- memory from a virtual machine's operating system. Used in some {\bf
- VMMs} to provide the illusion of contiguous physical memory, in
- Xen this is used during {\bf live migration}.
-
-\item[Virtual Block Device] Persistent storage available to a virtual
- machine, providing the abstraction of an actual block storage device.
- {\bf VBD}s may be actual block devices, filesystem images, or
- remote/network storage.
-
-\item[Virtual Machine] The environment in which a hosted operating
- system runs, providing the abstraction of a dedicated machine. A
- virtual machine may be identical to the underlying hardware (as in
- {\bf full virtualization}, or it may differ, as in {\bf
- paravirtualization}).
-
-\item[VMM] Virtual Machine Monitor - the software that allows multiple
- virtual machines to be multiplexed on a single physical machine.
-
-\item[Xen] Xen is a paravirtualizing virtual machine monitor,
- developed primarily by the Systems Research Group at the University
- of Cambridge Computer Laboratory.
-
-\item[XenLinux] A name for the port of the Linux kernel that
- runs on Xen.
-
-\end{description}
-
-
-\end{document}
-
-
-%% Other stuff without a home
-
-%% Instructions Re Python API
-
-%% Other Control Tasks using Python
-%% ================================
-
-%% A Python module 'Xc' is installed as part of the tools-install
-%% process. This can be imported, and an 'xc object' instantiated, to
-%% provide access to privileged command operations:
-
-%% # import Xc
-%% # xc = Xc.new()
-%% # dir(xc)
-%% # help(xc.domain_create)
-
-%% In this way you can see that the class 'xc' contains useful
-%% documentation for you to consult.
-
-%% A further package of useful routines (xenctl) is also installed:
-
-%% # import xenctl.utils
-%% # help(xenctl.utils)
-
-%% You can use these modules to write your own custom scripts or you
-%% can customise the scripts supplied in the Xen distribution.
-
-
-
-% Explain about AGP GART
-
-
-%% If you're not intending to configure the new domain with an IP
-%% address on your LAN, then you'll probably want to use NAT. The
-%% 'xen_nat_enable' installs a few useful iptables rules into domain0
-%% to enable NAT. [NB: We plan to support RSIP in future]
-
-
-
-%% Installing the file systems from the CD
-%% =======================================
-
-%% If you haven't got an existing Linux installation onto which you
-%% can just drop down the Xen and Xenlinux images, then the file
-%% systems on the CD provide a quick way of doing an install. However,
-%% you would be better off in the long run doing a proper install of
-%% your preferred distro and installing Xen onto that, rather than
-%% just doing the hack described below:
-
-%% Choose one or two partitions, depending on whether you want a
-%% separate /usr or not. Make file systems on it/them e.g.:
-%% mkfs -t ext3 /dev/hda3
-%% [or mkfs -t ext2 /dev/hda3 && tune2fs -j /dev/hda3 if using an old
-%% version of mkfs]
-
-%% Next, mount the file system(s) e.g.:
-%% mkdir /mnt/root && mount /dev/hda3 /mnt/root
-%% [mkdir /mnt/usr && mount /dev/hda4 /mnt/usr]
-
-%% To install the root file system, simply untar /usr/XenDemoCD/root.tar.gz:
-%% cd /mnt/root && tar -zxpf /usr/XenDemoCD/root.tar.gz
-
-%% You'll need to edit /mnt/root/etc/fstab to reflect your file system
-%% configuration. Changing the password file (etc/shadow) is probably a
-%% good idea too.
-
-%% To install the usr file system, copy the file system from CD on
-%% /usr, though leaving out the "XenDemoCD" and "boot" directories:
-%% cd /usr && cp -a X11R6 etc java libexec root src bin dict kerberos
-%% local sbin tmp doc include lib man share /mnt/usr
-
-%% If you intend to boot off these file systems (i.e. use them for
-%% domain 0), then you probably want to copy the /usr/boot
-%% directory on the cd over the top of the current symlink to /boot
-%% on your root filesystem (after deleting the current symlink)
-%% i.e.:
-%% cd /mnt/root ; rm boot ; cp -a /usr/boot .
_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog
|
 |
Lists.xenproject.org is hosted with RackSpace, monitoring our |